src/vnet/flow/flow.h

   1 /*
   2  * Copyright (c) 2016 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 included_vnet_flow_flow_h
  17 #define included_vnet_flow_flow_h
  18
  19 #include <vppinfra/clib.h>
  20 #include <vppinfra/pcap.h>
  21 #include <vnet/l3_types.h>
  22 #include <vnet/ip/ip4_packet.h>
  23 #include <vnet/ip/ip6_packet.h>
  24 #include <vnet/ethernet/packet.h>
  25
  26 #define foreach_flow_type \
  27   /* l2 flow*/ \
  28   _(ETHERNET, ethernet, "ethernet") \
  29   /* l3 IP flow */ \
  30   _(IP4, ip4, "ipv4") \
  31   _(IP6, ip6, "ipv6") \
  32   /* IP tunnel flow */ \
  33   _(IP4_L2TPV3OIP, ip4_l2tpv3oip, "ipv4-l2tpv3oip") \
  34   _(IP4_IPSEC_ESP, ip4_ipsec_esp, "ipv4-ipsec-esp") \
  35   _(IP4_IPSEC_AH, ip4_ipsec_ah, "ipv4-ipsec-ah") \
  36   /* l4 flow*/ \
  37   _(IP4_N_TUPLE, ip4_n_tuple, "ipv4-n-tuple") \
  38   _(IP6_N_TUPLE, ip6_n_tuple, "ipv6-n-tuple") \
  39   _(IP4_N_TUPLE_TAGGED, ip4_n_tuple_tagged, "ipv4-n-tuple-tagged") \
  40   _(IP6_N_TUPLE_TAGGED, ip6_n_tuple_tagged, "ipv6-n-tuple-tagged") \
  41   /* L4 tunnel flow*/ \
  42   _(IP4_VXLAN, ip4_vxlan, "ipv4-vxlan") \
  43   _(IP6_VXLAN, ip6_vxlan, "ipv6-vxlan") \
  44   _(IP4_GTPC, ip4_gtpc, "ipv4-gtpc") \
  45   _(IP4_GTPU, ip4_gtpu, "ipv4-gtpu")
  46
  47 #define foreach_flow_entry_ethernet \
  48   _fe(ethernet_header_t, eth_hdr)
  49
  50 #define foreach_flow_entry_ip4 \
  51   _fe(ip4_address_and_mask_t, src_addr) \
  52   _fe(ip4_address_and_mask_t, dst_addr) \
  53   _fe(ip_prot_and_mask_t, protocol)
  54
  55 #define foreach_flow_entry_ip6 \
  56   _fe(ip6_address_and_mask_t, src_addr) \
  57   _fe(ip6_address_and_mask_t, dst_addr) \
  58   _fe(ip_prot_and_mask_t, protocol)
  59
  60 #define foreach_flow_entry_ip4_l2tpv3oip \
  61   foreach_flow_entry_ip4 \
  62   _fe(u32, session_id)
  63
  64 #define foreach_flow_entry_ip4_ipsec_esp \
  65   foreach_flow_entry_ip4 \
  66   _fe(u32, spi)
  67
  68 #define foreach_flow_entry_ip4_ipsec_ah \
  69   foreach_flow_entry_ip4 \
  70   _fe(u32, spi)
  71
  72 #define foreach_flow_entry_ip4_n_tuple \
  73   foreach_flow_entry_ip4 \
  74   _fe(ip_port_and_mask_t, src_port) \
  75   _fe(ip_port_and_mask_t, dst_port)
  76
  77 #define foreach_flow_entry_ip6_n_tuple \
  78   foreach_flow_entry_ip6 \
  79   _fe(ip_port_and_mask_t, src_port) \
  80   _fe(ip_port_and_mask_t, dst_port)
  81
  82 #define foreach_flow_entry_ip4_n_tuple_tagged \
  83   foreach_flow_entry_ip4 \
  84   _fe(ip_port_and_mask_t, src_port) \
  85   _fe(ip_port_and_mask_t, dst_port)
  86
  87 #define foreach_flow_entry_ip6_n_tuple_tagged \
  88   foreach_flow_entry_ip6 \
  89   _fe(ip_port_and_mask_t, src_port) \
  90   _fe(ip_port_and_mask_t, dst_port)
  91
  92 #define foreach_flow_entry_ip4_vxlan                                          \
  93   foreach_flow_entry_ip4_n_tuple _fe (u32, vni)
  94
  95 #define foreach_flow_entry_ip6_vxlan                                          \
  96   foreach_flow_entry_ip6_n_tuple _fe (u32, vni)
  97
  98 #define foreach_flow_entry_ip4_gtpc \
  99   foreach_flow_entry_ip4_n_tuple \
 100   _fe(u32, teid)
 101
 102 #define foreach_flow_entry_ip4_gtpu \
 103   foreach_flow_entry_ip4_n_tuple \
 104   _fe(u32, teid)
 105
 106 #define foreach_flow_action \
 107   _(0, COUNT, "count") \
 108   _(1, MARK, "mark") \
 109   _(2, BUFFER_ADVANCE, "buffer-advance") \
 110   _(3, REDIRECT_TO_NODE, "redirect-to-node") \
 111   _(4, REDIRECT_TO_QUEUE, "redirect-to-queue") \
 112   _(5, RSS, "rss") \
 113   _(6, DROP, "drop")
 114
 115 typedef enum
 116 {
 117 #define _(v,n,s)  VNET_FLOW_ACTION_##n = (1 << v),
 118   foreach_flow_action
 119 #undef _
 120 } vnet_flow_action_t;
 121
 122 #define foreach_flow_error \
 123   _( -1, NOT_SUPPORTED, "not supported")                        \
 124   _( -2, ALREADY_DONE, "already done")                          \
 125   _( -3, ALREADY_EXISTS, "already exists")                      \
 126   _( -4, NO_SUCH_ENTRY, "no such entry")                        \
 127   _( -5, NO_SUCH_INTERFACE, "no such interface")                \
 128   _( -6, INTERNAL, "internal error")
 129
 130 #define foreach_flow_rss_types                                                \
 131   _ (0, FRAG_IPV4, "ipv4-frag")                                               \
 132   _ (1, IPV4_TCP, "ipv4-tcp")                                                 \
 133   _ (2, IPV4_UDP, "ipv4-udp")                                                 \
 134   _ (3, IPV4_SCTP, "ipv4-sctp")                                               \
 135   _ (4, IPV4_OTHER, "ipv4-other")                                             \
 136   _ (5, IPV4, "ipv4")                                                         \
 137   _ (6, IPV6_TCP_EX, "ipv6-tcp-ex")                                           \
 138   _ (7, IPV6_UDP_EX, "ipv6-udp-ex")                                           \
 139   _ (8, FRAG_IPV6, "ipv6-frag")                                               \
 140   _ (9, IPV6_TCP, "ipv6-tcp")                                                 \
 141   _ (10, IPV6_UDP, "ipv6-udp")                                                \
 142   _ (11, IPV6_SCTP, "ipv6-sctp")                                              \
 143   _ (12, IPV6_OTHER, "ipv6-other")                                            \
 144   _ (13, IPV6_EX, "ipv6-ex")                                                  \
 145   _ (14, IPV6, "ipv6")                                                        \
 146   _ (15, L2_PAYLOAD, "l2-payload")                                            \
 147   _ (16, PORT, "port")                                                        \
 148   _ (17, VXLAN, "vxlan")                                                      \
 149   _ (18, GENEVE, "geneve")                                                    \
 150   _ (19, NVGRE, "nvgre")                                                      \
 151   _ (20, GTPU, "gtpu")                                                        \
 152   _ (21, ESP, "esp")                                                          \
 153   _ (60, L4_DST_ONLY, "l4-dst-only")                                          \
 154   _ (61, L4_SRC_ONLY, "l4-src-only")                                          \
 155   _ (62, L3_DST_ONLY, "l3-dst-only")                                          \
 156   _ (63, L3_SRC_ONLY, "l3-src-only")
 157
 158 typedef enum
 159 {
 160 #define _(v, n, s) VNET_FLOW_RSS_TYPES_##n = v,
 161   foreach_flow_rss_types
 162 #undef _
 163 } vnet_flow_rss_types_t;
 164
 165 #define foreach_rss_function           \
 166   _(DEFAULT, "default")                \
 167   _(TOEPLITZ, "toeplitz")              \
 168   _(SIMPLE_XOR, "simple_xor")          \
 169   _(SYMMETRIC_TOEPLITZ, "symmetric_toeplitz")
 170
 171 typedef enum
 172 {
 173   VNET_FLOW_NO_ERROR = 0,
 174 #define _(v,n,s)  VNET_FLOW_ERROR_##n = v,
 175   foreach_flow_error
 176 #undef _
 177 } vnet_flow_error_t;
 178
 179 typedef struct
 180 {
 181   u16 port, mask;
 182 } ip_port_and_mask_t;
 183
 184 typedef struct
 185 {
 186   ip_protocol_t prot;
 187   /* ip protocol mask should be either 0 or 0xFF */
 188   /* other values are meanless */
 189   u8 mask;
 190 } ip_prot_and_mask_t;
 191
 192 typedef enum
 193 {
 194   VNET_FLOW_TYPE_UNKNOWN,
 195 #define _(a,b,c) VNET_FLOW_TYPE_##a,
 196   foreach_flow_type
 197 #undef _
 198     VNET_FLOW_N_TYPES,
 199 } vnet_flow_type_t;
 200
 201 typedef enum
 202 {
 203 #define _(a,b) VNET_RSS_FUNC_##a,
 204   foreach_rss_function
 205 #undef _
 206     VNET_RSS_N_TYPES,
 207 } vnet_rss_function_t;
 208
 209 /*
 210  * Create typedef struct vnet_flow_XXX_t
 211  */
 212 #define _fe(a, b) a b;
 213 #define _(a,b,c) \
 214 typedef struct { \
 215 int foo; \
 216 foreach_flow_entry_##b \
 217 } vnet_flow_##b##_t;
 218 foreach_flow_type;
 219 #undef _
 220 #undef _fe
 221
 222 /* main flow struct */
 223 typedef struct
 224 {
 225   /* flow type */
 226   vnet_flow_type_t type;
 227
 228   /* flow index */
 229   u32 index;
 230
 231   /* bitmap of flow actions (VNET_FLOW_ACTION_*) */
 232   u32 actions;
 233
 234   /* flow id for VNET_FLOW_ACTION_MARK */
 235   u32 mark_flow_id;
 236
 237   /* node index and next index for VNET_FLOW_ACTION_REDIRECT_TO_NODE */
 238   u32 redirect_node_index;
 239   u32 redirect_device_input_next_index;
 240
 241   /* queue for VNET_FLOW_ACTION_REDIRECT_TO_QUEUE */
 242   u32 redirect_queue;
 243
 244   /* buffer offset for VNET_FLOW_ACTION_BUFFER_ADVANCE */
 245   i32 buffer_advance;
 246
 247   /* RSS types, including IPv4/IPv6/TCP/UDP... */
 248   u64 rss_types;
 249
 250   /* RSS functions, including IPv4/IPv6/TCP/UDP... */
 251   vnet_rss_function_t rss_fun;
 252
 253   union
 254   {
 255 #define _(a,b,c) vnet_flow_##b##_t b;
 256     foreach_flow_type
 257 #undef _
 258   };
 259
 260   /* per-interface private data */
 261   uword *private_data;
 262 } vnet_flow_t;
 263
 264 int vnet_flow_get_range (vnet_main_t * vnm, char *owner, u32 count,
 265                          u32 * start);
 266 int vnet_flow_add (vnet_main_t * vnm, vnet_flow_t * flow, u32 * flow_index);
 267 int vnet_flow_enable (vnet_main_t * vnm, u32 flow_index, u32 hw_if_index);
 268 int vnet_flow_disable (vnet_main_t * vnm, u32 flow_index, u32 hw_if_index);
 269 int vnet_flow_del (vnet_main_t * vnm, u32 flow_index);
 270 vnet_flow_t *vnet_get_flow (u32 flow_index);
 271
 272 typedef struct
 273 {
 274   u32 start;
 275   u32 count;
 276   u8 *owner;
 277 } vnet_flow_range_t;
 278
 279 typedef struct
 280 {
 281   /* pool of device flow entries */
 282   vnet_flow_t *global_flow_pool;
 283
 284   /* flow ids allocated */
 285   u32 flows_used;
 286
 287   /* vector of flow ranges */
 288   vnet_flow_range_t *ranges;
 289
 290   u16 msg_id_base;
 291 } vnet_flow_main_t;
 292
 293 extern vnet_flow_main_t flow_main;
 294
 295 format_function_t format_flow_actions;
 296 format_function_t format_flow_enabled_hw;
 297
 298 #endif /* included_vnet_flow_flow_h */
 299
 300 /*
 301  * fd.io coding-style-patch-verification: ON
 302  *
 303  * Local Variables:
 304  * eval: (c-set-style "gnu")
 305  * End:
 306  */