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