vnet/vnet/buffer.h

   1 /*
   2  * Copyright (c) 2015 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  * vnet/buffer.h: vnet buffer flags
  17  *
  18  * Copyright (c) 2008 Eliot Dresselhaus
  19  *
  20  * Permission is hereby granted, free of charge, to any person obtaining
  21  * a copy of this software and associated documentation files (the
  22  * "Software"), to deal in the Software without restriction, including
  23  * without limitation the rights to use, copy, modify, merge, publish,
  24  * distribute, sublicense, and/or sell copies of the Software, and to
  25  * permit persons to whom the Software is furnished to do so, subject to
  26  * the following conditions:
  27  *
  28  * The above copyright notice and this permission notice shall be
  29  * included in all copies or substantial portions of the Software.
  30  *
  31  *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  32  *  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  33  *  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  34  *  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  35  *  LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  36  *  OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  37  *  WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  38  */
  39
  40 #ifndef included_vnet_buffer_h
  41 #define included_vnet_buffer_h
  42
  43 #include <vlib/vlib.h>
  44
  45 /* VLIB buffer flags for ip4/ip6 packets.  Set by input interfaces for ip4/ip6
  46    tcp/udp packets with hardware computed checksums. */
  47 #define LOG2_IP_BUFFER_L4_CHECKSUM_COMPUTED LOG2_VLIB_BUFFER_FLAG_USER(1)
  48 #define LOG2_IP_BUFFER_L4_CHECKSUM_CORRECT  LOG2_VLIB_BUFFER_FLAG_USER(2)
  49 #define IP_BUFFER_L4_CHECKSUM_COMPUTED (1 << LOG2_IP_BUFFER_L4_CHECKSUM_COMPUTED)
  50 #define IP_BUFFER_L4_CHECKSUM_CORRECT  (1 << LOG2_IP_BUFFER_L4_CHECKSUM_CORRECT)
  51
  52 /* VLAN header flags.
  53  * These bits are zeroed in vlib_buffer_init_for_free_list()
  54  * meaning wherever the buffer comes from they have a reasonable
  55  * value (eg, if ip4/ip6 generates the packet.)
  56  */
  57 #define LOG2_ETH_BUFFER_VLAN_2_DEEP LOG2_VLIB_BUFFER_FLAG_USER(3)
  58 #define LOG2_ETH_BUFFER_VLAN_1_DEEP LOG2_VLIB_BUFFER_FLAG_USER(4)
  59 #define ETH_BUFFER_VLAN_2_DEEP (1 << LOG2_ETH_BUFFER_VLAN_2_DEEP)
  60 #define ETH_BUFFER_VLAN_1_DEEP (1 << LOG2_ETH_BUFFER_VLAN_1_DEEP)
  61 #define ETH_BUFFER_VLAN_BITS (ETH_BUFFER_VLAN_1_DEEP | \
  62                               ETH_BUFFER_VLAN_2_DEEP)
  63
  64 #define LOG2_VNET_BUFFER_RTE_MBUF_VALID LOG2_VLIB_BUFFER_FLAG_USER(5)
  65 #define VNET_BUFFER_RTE_MBUF_VALID (1 << LOG2_VNET_BUFFER_RTE_MBUF_VALID)
  66
  67 #define LOG2_BUFFER_HANDOFF_NEXT_VALID LOG2_VLIB_BUFFER_FLAG_USER(6)
  68 #define BUFFER_HANDOFF_NEXT_VALID (1 << LOG2_BUFFER_HANDOFF_NEXT_VALID)
  69
  70 #define LOG2_VNET_BUFFER_RTE_MBUF_IS_VALID LOG2_VLIB_BUFFER_FLAG_USER(7)
  71 #define VNET_BUFFER_RTE_MBUF_IS_VALID (1 << LOG2_VNET_BUFFER_RTE_MBUF_IS_VALID)
  72
  73 #define foreach_buffer_opaque_union_subtype     \
  74 _(ethernet)                                     \
  75 _(ip)                                           \
  76 _(mcast)                                        \
  77 _(swt)                                          \
  78 _(l2)                                           \
  79 _(l2t)                                          \
  80 _(gre)                                          \
  81 _(l2_classify)                                  \
  82 _(handoff)                                      \
  83 _(policer)                                      \
  84 _(ipsec)                                        \
  85 _(map)                                          \
  86 _(map_t)                                        \
  87 _(ip_frag)
  88
  89 /*
  90  * vnet stack buffer opaque array overlay structure.
  91  * The vnet_buffer_opaque_t *must* be the same size as the
  92  * vlib_buffer_t "opaque" structure member, 32 bytes.
  93  *
  94  * When adding a union type, please add a stanza to
  95  * foreach_buffer_opaque_union_subtype (directly above).
  96  * Code in vnet_interface_init(...) verifies the size
  97  * of the union, and will announce any deviations in an
  98  * impossible-to-miss manner.
  99  */
 100 typedef struct
 101 {
 102   u32 sw_if_index[VLIB_N_RX_TX];
 103
 104   union
 105   {
 106     /* Ethernet. */
 107     struct
 108     {
 109       /* Saved value of current header by ethernet-input. */
 110       i32 start_of_ethernet_header;
 111     } ethernet;
 112
 113     /* IP4/6 buffer opaque. */
 114     struct
 115     {
 116       /* Adjacency from destination IP address lookup [VLIB_TX].
 117          Adjacency from source IP address lookup [VLIB_RX].
 118          This gets set to ~0 until source lookup is performed. */
 119       u32 adj_index[VLIB_N_RX_TX];
 120
 121       union
 122       {
 123         struct
 124         {
 125           /* Flow hash value for this packet computed from IP src/dst address
 126              protocol and ports. */
 127           u32 flow_hash;
 128
 129           /* next protocol */
 130           u32 save_protocol;
 131
 132           /* Rewrite length */
 133           u32 save_rewrite_length;
 134         };
 135
 136         /* ICMP */
 137         struct
 138         {
 139           u8 type;
 140           u8 code;
 141           u32 data;
 142         } icmp;
 143       };
 144     } ip;
 145
 146     /* Multicast replication */
 147     struct
 148     {
 149       u32 pad[3];
 150       u32 mcast_group_index;
 151       u32 mcast_current_index;
 152       u32 original_free_list_index;
 153     } mcast;
 154
 155     /* ip4-in-ip6 softwire termination, only valid there */
 156     struct
 157     {
 158       u8 swt_disable;
 159       u32 mapping_index;
 160     } swt;
 161
 162     /* l2 bridging path, only valid there */
 163     struct
 164     {
 165       u32 feature_bitmap;
 166       u16 bd_index;             // bridge-domain index
 167       u8 l2_len;                // ethernet header length
 168       u8 shg;                   // split-horizon group
 169     } l2;
 170
 171     /* l2tpv3 softwire encap, only valid there */
 172     struct
 173     {
 174       u32 pad[4];               /* do not overlay w/ ip.adj_index[0,1] */
 175       u8 next_index;
 176       u32 session_index;
 177     } l2t;
 178
 179     struct
 180     {
 181       u32 src, dst;
 182     } gre;
 183
 184     /* L2 classify */
 185     struct
 186     {
 187       u64 pad;
 188       u32 table_index;
 189       u32 opaque_index;
 190       u64 hash;
 191     } l2_classify;
 192
 193     /* IO - worker thread handoff */
 194     struct
 195     {
 196       u32 next_index;
 197     } handoff;
 198
 199     /* vnet policer */
 200     struct
 201     {
 202       u32 pad[8 - VLIB_N_RX_TX - 1];    /* to end of opaque */
 203       u32 index;
 204     } policer;
 205
 206     /* interface output features */
 207     struct
 208     {
 209       u32 flags;
 210       u32 sad_index;
 211     } ipsec;
 212
 213     /* vcgn udp inside input, only valid there */
 214     struct
 215     {
 216       /* This part forms context of the packet. The structure should be
 217        * exactly same as spp_ctx_t. Also this should be the first
 218        * element of this vcgn_uii structure.
 219        */
 220       /****** BEGIN spp_ctx_t section ***********************/
 221       union
 222       {                         /* Roddick specific */
 223         u32 roddick_info;
 224         struct _tx_pkt_info
 225         {                       /* Used by PI to PI communication for TX */
 226           u32 uidb_index:16;    /* uidb_index to transmit */
 227           u32 packet_type:2;    /* 1-IPv4, 2-Ipv6, - 0,3 - Unused */
 228           u32 ipv4_defrag:1;    /* 0 - Normal, 1 - update first
 229                                  * segment size
 230                                  * (set by 6rd defrag node)
 231                                  */
 232
 233           u32 dst_ip_port_idx:4;        /* Index to dst_ip_port_table */
 234           u32 from_node:4;
 235           u32 calc_chksum:1;
 236           u32 reserved:4;
 237         } tx;
 238         struct _rx_pkt_info
 239         {                       /* Used by PD / PI communication */
 240           u32 uidb_index:16;    /* uidb_index received in packet */
 241           u32 packet_type:2;    /* 1-IPv4, 2-Ipv6, - 0,3 - Unused */
 242           u32 icmp_type:1;      /* 0-ICMP query type, 1-ICMP error type */
 243           u32 protocol_type:2;  /* 1-TCP, 2-UDP, 3-ICMP, 0 - Unused */
 244           u32 ipv4_defrag:1;    /* 0 - Normal, 1 - update first
 245                                  * segment size
 246                                  * (set by 6rd defrag node)
 247                                  */
 248
 249           u32 direction:1;      /* 0-Outside, 1-Inside */
 250           u32 frag:1;           /*IP fragment-1, Otherwise-0 */
 251           u32 option:1;         /* 0-No IP option (v4) present, non-fragHdr
 252                                  * option hdr present (v6)
 253                                  */
 254           u32 df_bit:1;         /* IPv4 DF bit copied here */
 255           u32 reserved1:6;
 256         } rx;
 257       } ru;
 258       /****** END  spp_ctx_t section ***********************/
 259
 260       union
 261       {
 262         struct
 263         {
 264           u32 ipv4;
 265           u16 port;
 266           u16 vrf;              //bit0-13:i/f, bit14-15:protocol
 267         } k;
 268
 269         u64 key64;
 270       } key;
 271
 272       u32 bucket;
 273
 274       u16 ovrf;                 /* Exit interface */
 275       u8 frag_pkt;
 276       u8 vcgn_unused1;
 277     } vcgn_uii;
 278
 279     /* MAP */
 280     struct
 281     {
 282       u16 mtu;
 283     } map;
 284
 285     /* MAP-T */
 286     struct
 287     {
 288       u32 map_domain_index;
 289       struct
 290       {
 291         u32 saddr, daddr;
 292         u16 frag_offset;        //Fragmentation header offset
 293         u16 l4_offset;          //L4 header overall offset
 294         u8 l4_protocol;         //The final protocol number
 295       } v6;                     //Used by ip6_map_t only
 296       u16 checksum_offset;      //L4 checksum overall offset
 297       u16 mtu;                  //Exit MTU
 298     } map_t;
 299
 300     /* IP Fragmentation */
 301     struct
 302     {
 303       u16 header_offset;
 304       u16 mtu;
 305       u8 next_index;
 306       u8 flags;                 //See ip_frag.h
 307     } ip_frag;
 308
 309     /* COP - configurable junk filter(s) */
 310     struct
 311     {
 312       /* Current configuration index. */
 313       u32 current_config_index;
 314     } cop;
 315
 316     /* LISP */
 317     struct
 318     {
 319       /* overlay address family */
 320       u16 overlay_afi;
 321     } lisp;
 322
 323     /* Driver rx feature */
 324     struct
 325     {
 326       u32 saved_next_index;             /**< saved by drivers for short-cut */
 327       u16 buffer_advance;
 328     } device_input_feat;
 329
 330     u32 unused[6];
 331   };
 332 } vnet_buffer_opaque_t;
 333
 334 #define vnet_buffer(b) ((vnet_buffer_opaque_t *) (b)->opaque)
 335
 336 /* Full cache line (64 bytes) of additional space */
 337 typedef struct
 338 {
 339   union
 340   {
 341   };
 342 } vnet_buffer_opaque2_t;
 343
 344
 345
 346 #endif /* included_vnet_buffer_h */
 347
 348 /*
 349  * fd.io coding-style-patch-verification: ON
 350  *
 351  * Local Variables:
 352  * eval: (c-set-style "gnu")
 353  * End:
 354  */