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_LOCALLY_ORIGINATED LOG2_VLIB_BUFFER_FLAG_USER(7)
  71 #define VNET_BUFFER_LOCALLY_ORIGINATED (1 << LOG2_VNET_BUFFER_LOCALLY_ORIGINATED)
  72
  73 #define LOG2_VNET_BUFFER_SPAN_CLONE LOG2_VLIB_BUFFER_FLAG_USER(8)
  74 #define VNET_BUFFER_SPAN_CLONE (1 << LOG2_VNET_BUFFER_SPAN_CLONE)
  75
  76 #define foreach_buffer_opaque_union_subtype     \
  77 _(ethernet)                                     \
  78 _(ip)                                           \
  79 _(mcast)                                        \
  80 _(swt)                                          \
  81 _(l2)                                           \
  82 _(l2t)                                          \
  83 _(gre)                                          \
  84 _(l2_classify)                                  \
  85 _(handoff)                                      \
  86 _(policer)                                      \
  87 _(ipsec)                                        \
  88 _(map)                                          \
  89 _(map_t)                                        \
  90 _(ip_frag)
  91
  92 /*
  93  * vnet stack buffer opaque array overlay structure.
  94  * The vnet_buffer_opaque_t *must* be the same size as the
  95  * vlib_buffer_t "opaque" structure member, 32 bytes.
  96  *
  97  * When adding a union type, please add a stanza to
  98  * foreach_buffer_opaque_union_subtype (directly above).
  99  * Code in vnet_interface_init(...) verifies the size
 100  * of the union, and will announce any deviations in an
 101  * impossible-to-miss manner.
 102  */
 103 typedef struct
 104 {
 105   u32 sw_if_index[VLIB_N_RX_TX];
 106
 107   union
 108   {
 109     /* Ethernet. */
 110     struct
 111     {
 112       /* Saved value of current header by ethernet-input. */
 113       i32 start_of_ethernet_header;
 114     } ethernet;
 115
 116     /* IP4/6 buffer opaque. */
 117     struct
 118     {
 119       /* Adjacency from destination IP address lookup [VLIB_TX].
 120          Adjacency from source IP address lookup [VLIB_RX].
 121          This gets set to ~0 until source lookup is performed. */
 122       u32 adj_index[VLIB_N_RX_TX];
 123
 124       union
 125       {
 126         struct
 127         {
 128           /* Flow hash value for this packet computed from IP src/dst address
 129              protocol and ports. */
 130           u32 flow_hash;
 131
 132           /* next protocol */
 133           u32 save_protocol;
 134
 135           /* Rewrite length */
 136           u32 save_rewrite_length;
 137         };
 138
 139         /* ICMP */
 140         struct
 141         {
 142           u8 type;
 143           u8 code;
 144           u32 data;
 145         } icmp;
 146       };
 147     } ip;
 148
 149     /*
 150      * MPLS:
 151      * data copied from the MPLS header that was popped from the packet
 152      * during the look-up.
 153      */
 154     struct
 155     {
 156       u8 ttl;
 157       u8 exp;
 158       u8 first;
 159     } mpls;
 160
 161     /* Multicast replication */
 162     struct
 163     {
 164       u32 pad[3];
 165       u32 mcast_group_index;
 166       u32 mcast_current_index;
 167       u32 original_free_list_index;
 168     } mcast;
 169
 170     /* ip4-in-ip6 softwire termination, only valid there */
 171     struct
 172     {
 173       u8 swt_disable;
 174       u32 mapping_index;
 175     } swt;
 176
 177     /* l2 bridging path, only valid there */
 178     struct
 179     {
 180       u32 feature_bitmap;
 181       u16 bd_index;             // bridge-domain index
 182       u8 l2_len;                // ethernet header length
 183       u8 shg;                   // split-horizon group
 184     } l2;
 185
 186     /* l2tpv3 softwire encap, only valid there */
 187     struct
 188     {
 189       u32 pad[4];               /* do not overlay w/ ip.adj_index[0,1] */
 190       u8 next_index;
 191       u32 session_index;
 192     } l2t;
 193
 194     struct
 195     {
 196       u32 src, dst;
 197     } gre;
 198
 199     /* L2 classify */
 200     struct
 201     {
 202       u64 pad;
 203       u32 table_index;
 204       u32 opaque_index;
 205       u64 hash;
 206     } l2_classify;
 207
 208     /* IO - worker thread handoff */
 209     struct
 210     {
 211       u32 next_index;
 212     } handoff;
 213
 214     /* vnet policer */
 215     struct
 216     {
 217       u32 pad[8 - VLIB_N_RX_TX - 1];    /* to end of opaque */
 218       u32 index;
 219     } policer;
 220
 221     /* interface output features */
 222     struct
 223     {
 224       u32 flags;
 225       u32 sad_index;
 226     } ipsec;
 227
 228     /* vcgn udp inside input, only valid there */
 229     struct
 230     {
 231       /* This part forms context of the packet. The structure should be
 232        * exactly same as spp_ctx_t. Also this should be the first
 233        * element of this vcgn_uii structure.
 234        */
 235       /****** BEGIN spp_ctx_t section ***********************/
 236       union
 237       {                         /* Roddick specific */
 238         u32 roddick_info;
 239         struct _tx_pkt_info
 240         {                       /* Used by PI to PI communication for TX */
 241           u32 uidb_index:16;    /* uidb_index to transmit */
 242           u32 packet_type:2;    /* 1-IPv4, 2-Ipv6, - 0,3 - Unused */
 243           u32 ipv4_defrag:1;    /* 0 - Normal, 1 - update first
 244                                  * segment size
 245                                  * (set by 6rd defrag node)
 246                                  */
 247
 248           u32 dst_ip_port_idx:4;        /* Index to dst_ip_port_table */
 249           u32 from_node:4;
 250           u32 calc_chksum:1;
 251           u32 reserved:4;
 252         } tx;
 253         struct _rx_pkt_info
 254         {                       /* Used by PD / PI communication */
 255           u32 uidb_index:16;    /* uidb_index received in packet */
 256           u32 packet_type:2;    /* 1-IPv4, 2-Ipv6, - 0,3 - Unused */
 257           u32 icmp_type:1;      /* 0-ICMP query type, 1-ICMP error type */
 258           u32 protocol_type:2;  /* 1-TCP, 2-UDP, 3-ICMP, 0 - Unused */
 259           u32 ipv4_defrag:1;    /* 0 - Normal, 1 - update first
 260                                  * segment size
 261                                  * (set by 6rd defrag node)
 262                                  */
 263
 264           u32 direction:1;      /* 0-Outside, 1-Inside */
 265           u32 frag:1;           /*IP fragment-1, Otherwise-0 */
 266           u32 option:1;         /* 0-No IP option (v4) present, non-fragHdr
 267                                  * option hdr present (v6)
 268                                  */
 269           u32 df_bit:1;         /* IPv4 DF bit copied here */
 270           u32 reserved1:6;
 271         } rx;
 272       } ru;
 273       /****** END  spp_ctx_t section ***********************/
 274
 275       union
 276       {
 277         struct
 278         {
 279           u32 ipv4;
 280           u16 port;
 281           u16 vrf;              //bit0-13:i/f, bit14-15:protocol
 282         } k;
 283
 284         u64 key64;
 285       } key;
 286
 287       u32 bucket;
 288
 289       u16 ovrf;                 /* Exit interface */
 290       u8 frag_pkt;
 291       u8 vcgn_unused1;
 292     } vcgn_uii;
 293
 294     /* MAP */
 295     struct
 296     {
 297       u16 mtu;
 298     } map;
 299
 300     /* MAP-T */
 301     struct
 302     {
 303       u32 map_domain_index;
 304       struct
 305       {
 306         u32 saddr, daddr;
 307         u16 frag_offset;        //Fragmentation header offset
 308         u16 l4_offset;          //L4 header overall offset
 309         u8 l4_protocol;         //The final protocol number
 310       } v6;                     //Used by ip6_map_t only
 311       u16 checksum_offset;      //L4 checksum overall offset
 312       u16 mtu;                  //Exit MTU
 313     } map_t;
 314
 315     /* IP Fragmentation */
 316     struct
 317     {
 318       u16 header_offset;
 319       u16 mtu;
 320       u8 next_index;
 321       u8 flags;                 //See ip_frag.h
 322     } ip_frag;
 323
 324     /* COP - configurable junk filter(s) */
 325     struct
 326     {
 327       /* Current configuration index. */
 328       u32 current_config_index;
 329     } cop;
 330
 331     /* LISP */
 332     struct
 333     {
 334       /* overlay address family */
 335       u16 overlay_afi;
 336     } lisp;
 337
 338     /* Driver rx feature */
 339     struct
 340     {
 341       u32 saved_next_index;             /**< saved by drivers for short-cut */
 342       u16 buffer_advance;
 343     } device_input_feat;
 344
 345     u32 unused[6];
 346   };
 347 } vnet_buffer_opaque_t;
 348
 349 /*
 350  * The opaque field of the vlib_buffer_t is intepreted as a
 351  * vnet_buffer_opaque_t. Hence it should be big enough to accommodate one.
 352  */
 353 STATIC_ASSERT (sizeof (vnet_buffer_opaque_t) <= STRUCT_SIZE_OF (vlib_buffer_t,
 354                                                                 opaque),
 355                "VNET buffer meta-data too large for vlib_buffer");
 356
 357 #define vnet_buffer(b) ((vnet_buffer_opaque_t *) (b)->opaque)
 358
 359 /* Full cache line (64 bytes) of additional space */
 360 typedef struct
 361 {
 362   union
 363   {
 364   };
 365 } vnet_buffer_opaque2_t;
 366
 367
 368
 369 #endif /* included_vnet_buffer_h */
 370
 371 /*
 372  * fd.io coding-style-patch-verification: ON
 373  *
 374  * Local Variables:
 375  * eval: (c-set-style "gnu")
 376  * End:
 377  */