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