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 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     /*
 147      * MPLS:
 148      * data copied from the MPLS header that was popped from the packet
 149      * during the look-up.
 150      */
 151     struct
 152     {
 153       u8 ttl;
 154       u8 exp;
 155       u8 first;
 156     } mpls;
 157
 158     /* Multicast replication */
 159     struct
 160     {
 161       u32 pad[3];
 162       u32 mcast_group_index;
 163       u32 mcast_current_index;
 164       u32 original_free_list_index;
 165     } mcast;
 166
 167     /* ip4-in-ip6 softwire termination, only valid there */
 168     struct
 169     {
 170       u8 swt_disable;
 171       u32 mapping_index;
 172     } swt;
 173
 174     /* l2 bridging path, only valid there */
 175     struct
 176     {
 177       u32 feature_bitmap;
 178       u16 bd_index;             // bridge-domain index
 179       u8 l2_len;                // ethernet header length
 180       u8 shg;                   // split-horizon group
 181     } l2;
 182
 183     /* l2tpv3 softwire encap, only valid there */
 184     struct
 185     {
 186       u32 pad[4];               /* do not overlay w/ ip.adj_index[0,1] */
 187       u8 next_index;
 188       u32 session_index;
 189     } l2t;
 190
 191     struct
 192     {
 193       u32 src, dst;
 194     } gre;
 195
 196     /* L2 classify */
 197     struct
 198     {
 199       u64 pad;
 200       u32 table_index;
 201       u32 opaque_index;
 202       u64 hash;
 203     } l2_classify;
 204
 205     /* IO - worker thread handoff */
 206     struct
 207     {
 208       u32 next_index;
 209     } handoff;
 210
 211     /* vnet policer */
 212     struct
 213     {
 214       u32 pad[8 - VLIB_N_RX_TX - 1];    /* to end of opaque */
 215       u32 index;
 216     } policer;
 217
 218     /* interface output features */
 219     struct
 220     {
 221       u32 flags;
 222       u32 sad_index;
 223     } ipsec;
 224
 225     /* vcgn udp inside input, only valid there */
 226     struct
 227     {
 228       /* This part forms context of the packet. The structure should be
 229        * exactly same as spp_ctx_t. Also this should be the first
 230        * element of this vcgn_uii structure.
 231        */
 232       /****** BEGIN spp_ctx_t section ***********************/
 233       union
 234       {                         /* Roddick specific */
 235         u32 roddick_info;
 236         struct _tx_pkt_info
 237         {                       /* Used by PI to PI communication for TX */
 238           u32 uidb_index:16;    /* uidb_index to transmit */
 239           u32 packet_type:2;    /* 1-IPv4, 2-Ipv6, - 0,3 - Unused */
 240           u32 ipv4_defrag:1;    /* 0 - Normal, 1 - update first
 241                                  * segment size
 242                                  * (set by 6rd defrag node)
 243                                  */
 244
 245           u32 dst_ip_port_idx:4;        /* Index to dst_ip_port_table */
 246           u32 from_node:4;
 247           u32 calc_chksum:1;
 248           u32 reserved:4;
 249         } tx;
 250         struct _rx_pkt_info
 251         {                       /* Used by PD / PI communication */
 252           u32 uidb_index:16;    /* uidb_index received in packet */
 253           u32 packet_type:2;    /* 1-IPv4, 2-Ipv6, - 0,3 - Unused */
 254           u32 icmp_type:1;      /* 0-ICMP query type, 1-ICMP error type */
 255           u32 protocol_type:2;  /* 1-TCP, 2-UDP, 3-ICMP, 0 - Unused */
 256           u32 ipv4_defrag:1;    /* 0 - Normal, 1 - update first
 257                                  * segment size
 258                                  * (set by 6rd defrag node)
 259                                  */
 260
 261           u32 direction:1;      /* 0-Outside, 1-Inside */
 262           u32 frag:1;           /*IP fragment-1, Otherwise-0 */
 263           u32 option:1;         /* 0-No IP option (v4) present, non-fragHdr
 264                                  * option hdr present (v6)
 265                                  */
 266           u32 df_bit:1;         /* IPv4 DF bit copied here */
 267           u32 reserved1:6;
 268         } rx;
 269       } ru;
 270       /****** END  spp_ctx_t section ***********************/
 271
 272       union
 273       {
 274         struct
 275         {
 276           u32 ipv4;
 277           u16 port;
 278           u16 vrf;              //bit0-13:i/f, bit14-15:protocol
 279         } k;
 280
 281         u64 key64;
 282       } key;
 283
 284       u32 bucket;
 285
 286       u16 ovrf;                 /* Exit interface */
 287       u8 frag_pkt;
 288       u8 vcgn_unused1;
 289     } vcgn_uii;
 290
 291     /* MAP */
 292     struct
 293     {
 294       u16 mtu;
 295     } map;
 296
 297     /* MAP-T */
 298     struct
 299     {
 300       u32 map_domain_index;
 301       struct
 302       {
 303         u32 saddr, daddr;
 304         u16 frag_offset;        //Fragmentation header offset
 305         u16 l4_offset;          //L4 header overall offset
 306         u8 l4_protocol;         //The final protocol number
 307       } v6;                     //Used by ip6_map_t only
 308       u16 checksum_offset;      //L4 checksum overall offset
 309       u16 mtu;                  //Exit MTU
 310     } map_t;
 311
 312     /* IP Fragmentation */
 313     struct
 314     {
 315       u16 header_offset;
 316       u16 mtu;
 317       u8 next_index;
 318       u8 flags;                 //See ip_frag.h
 319     } ip_frag;
 320
 321     /* COP - configurable junk filter(s) */
 322     struct
 323     {
 324       /* Current configuration index. */
 325       u32 current_config_index;
 326     } cop;
 327
 328     /* LISP */
 329     struct
 330     {
 331       /* overlay address family */
 332       u16 overlay_afi;
 333     } lisp;
 334
 335     /* Driver rx feature */
 336     struct
 337     {
 338       u32 saved_next_index;             /**< saved by drivers for short-cut */
 339       u16 buffer_advance;
 340     } device_input_feat;
 341
 342     u32 unused[6];
 343   };
 344 } vnet_buffer_opaque_t;
 345
 346 /*
 347  * The opaque field of the vlib_buffer_t is intepreted as a
 348  * vnet_buffer_opaque_t. Hence it should be big enough to accommodate one.
 349  */
 350 STATIC_ASSERT (sizeof (vnet_buffer_opaque_t) <= STRUCT_SIZE_OF (vlib_buffer_t,
 351                                                                 opaque),
 352                "VNET buffer meta-data too large for vlib_buffer");
 353
 354 #define vnet_buffer(b) ((vnet_buffer_opaque_t *) (b)->opaque)
 355
 356 /* Full cache line (64 bytes) of additional space */
 357 typedef struct
 358 {
 359   union
 360   {
 361   };
 362 } vnet_buffer_opaque2_t;
 363
 364
 365
 366 #endif /* included_vnet_buffer_h */
 367
 368 /*
 369  * fd.io coding-style-patch-verification: ON
 370  *
 371  * Local Variables:
 372  * eval: (c-set-style "gnu")
 373  * End:
 374  */