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