src/vnet/ip/ip_flow_hash.h

   1 /*
   2  * Copyright (c) 2019 Cisco and/or its affiliates.
   3  * Licensed under the Apache License, Version 2.0 (the "License");
   4  * you may not use this file except in compliance with the License.
   5  * You may obtain a copy of the License at:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   9  * Unless required by applicable law or agreed to in writing, software
  10  * distributed under the License is distributed on an "AS IS" BASIS,
  11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12  * See the License for the specific language governing permissions and
  13  * limitations under the License.
  14  */
  15
  16 #ifndef __IP_FLOW_HASH_H__
  17 #define __IP_FLOW_HASH_H__
  18
  19 #include <vnet/ip/ip_types.h>
  20
  21 /** Default: 5-tuple + flowlabel without the "reverse" bit */
  22 #define IP_FLOW_HASH_DEFAULT (0x9F)
  23
  24 #define foreach_flow_hash_bit_v1                                              \
  25   _ (src, IP_FLOW_HASH_SRC_ADDR)                                              \
  26   _ (dst, IP_FLOW_HASH_DST_ADDR)                                              \
  27   _ (sport, IP_FLOW_HASH_SRC_PORT)                                            \
  28   _ (dport, IP_FLOW_HASH_DST_PORT)                                            \
  29   _ (proto, IP_FLOW_HASH_PROTO)                                               \
  30   _ (reverse, IP_FLOW_HASH_REVERSE_SRC_DST)                                   \
  31   _ (symmetric, IP_FLOW_HASH_SYMMETRIC)
  32
  33 #define foreach_flow_hash_bit                                                 \
  34   _ (src, 0, IP_FLOW_HASH_SRC_ADDR)                                           \
  35   _ (dst, 1, IP_FLOW_HASH_DST_ADDR)                                           \
  36   _ (sport, 2, IP_FLOW_HASH_SRC_PORT)                                         \
  37   _ (dport, 3, IP_FLOW_HASH_DST_PORT)                                         \
  38   _ (proto, 4, IP_FLOW_HASH_PROTO)                                            \
  39   _ (reverse, 5, IP_FLOW_HASH_REVERSE_SRC_DST)                                \
  40   _ (symmetric, 6, IP_FLOW_HASH_SYMMETRIC)                                    \
  41   _ (flowlabel, 7, IP_FLOW_HASH_FL)
  42
  43 /**
  44  * A flow hash configuration is a mask of the flow hash options
  45  */
  46 typedef enum flow_hash_config_t_
  47 {
  48 #define _(a, b, c) c = (1 << b),
  49   foreach_flow_hash_bit
  50 #undef _
  51 } flow_hash_config_t;
  52
  53 /* Router ID mixed into the flow hash to prevent network polarisation */
  54 extern u32 ip_flow_hash_router_id;
  55
  56 int ip_flow_hash_set (ip_address_family_t af, u32 table_id,
  57                       flow_hash_config_t flow_hash_config);
  58 void ip_flow_hash_router_id_set (u32 router_id);
  59
  60 #endif /* __IP_TYPES_H__ */
  61
  62 /*
  63  * fd.io coding-style-patch-verification: ON
  64  *
  65  * Local Variables:
  66  * eval: (c-set-style "gnu")
  67  * End:
  68  */