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