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         } tcp;
 123
 124         /* ICMP */
 125         struct {
 126           u8 type;
 127           u8 code;
 128           u32 data;
 129         } icmp;
 130       };
 131     } ip;
 132
 133     /* Multicast replication */
 134     struct {
 135       u32 pad[3];
 136       u32 mcast_group_index;
 137       u32 mcast_current_index;
 138       u32 original_free_list_index;
 139     } mcast;
 140
 141     /* ipv6 shallow-pkt-inspection load-balancer, only valid there */
 142     struct {
 143       u8 lb_disable;
 144       u8 user_to_network;
 145       u8 was_injected;
 146       u32 bucket_id;
 147     } lb;
 148     /* ipv4 DPI load-balancer, only valid there */
 149     struct {
 150       u8 lb_disable;
 151       u8 user_to_network;
 152       u32 session_index;
 153     } dlb;
 154
 155     /* ip4-in-ip6 softwire termination, only valid there */
 156     struct {
 157       u8 swt_disable;
 158       u32 mapping_index;
 159     } swt;
 160
 161     /* l2 bridging path, only valid there */
 162     struct {
 163       u32 feature_bitmap;
 164       u16 bd_index;       // bridge-domain index
 165       u8  l2_len;         // ethernet header length
 166       u8  shg;            // split-horizon group
 167     } l2;
 168
 169     /* l2tpv3 softwire encap, only valid there */
 170     struct {
 171       u32 pad[4];               /* do not overlay w/ ip.adj_index[0,1] */
 172       u8 next_index;
 173       u32 session_index;
 174     } l2t;
 175
 176     /* hgshm, valid if packet sent through iface */
 177     struct {
 178       u32 pad[8 -VLIB_N_RX_TX -1];  /* to end of opaque */
 179       u32 user_index;          /* client id borrowing buffer */
 180     } hgshm;
 181
 182     struct {
 183       u32 src, dst;
 184     } gre;
 185
 186     /* L2 classify */
 187     struct {
 188       u64 pad;
 189       u32 opaque_index;
 190       u32 table_index;
 191       u64 hash;
 192     } l2_classify;
 193
 194     /* IO - worker thread handoff */
 195     struct {
 196       u32 next_index;
 197     } io_handoff;
 198
 199     /* vnet policer */
 200     struct {
 201       u32 pad[8 -VLIB_N_RX_TX -1];  /* to end of opaque */
 202       u32 index;
 203     } policer;
 204
 205     /* interface output features */
 206     struct {
 207       u32 ipsec_spd_index;
 208       u32 ipsec_sad_index;
 209       u32 unused[3];
 210       u32 bitmap;
 211     } output_features;
 212
 213     /* vcgn udp inside input, only valid there */
 214     struct {
 215       /* This part forms context of the packet. The structure should be
 216        * exactly same as spp_ctx_t. Also this should be the first
 217        * element of this vcgn_uii structure.
 218        */
 219       /****** BEGIN spp_ctx_t section ***********************/
 220       union { /* Roddick specific */
 221         u32 roddick_info;
 222         struct _tx_pkt_info  { /* Used by PI to PI communication for TX */
 223           u32 uidb_index:16;       /* uidb_index to transmit */
 224           u32  packet_type:2;   /* 1-IPv4, 2-Ipv6, - 0,3 - Unused */
 225           u32  ipv4_defrag:1;   /* 0 - Normal, 1 - update first
 226                                  * segment size
 227                                  * (set by 6rd defrag node)
 228                                  */
 229
 230           u32  dst_ip_port_idx:4;/* Index to dst_ip_port_table */
 231           u32  from_node:4;
 232           u32  calc_chksum:1;
 233           u32  reserved:4;
 234         } tx;
 235         struct _rx_pkt_info { /* Used by PD / PI communication */
 236           u32 uidb_index:16;    /* uidb_index received in packet */
 237           u32  packet_type:2;   /* 1-IPv4, 2-Ipv6, - 0,3 - Unused */
 238           u32  icmp_type:1;     /* 0-ICMP query type, 1-ICMP error type */
 239           u32  protocol_type:2; /* 1-TCP, 2-UDP, 3-ICMP, 0 - Unused */
 240           u32  ipv4_defrag:1;    /* 0 - Normal, 1 - update first
 241                                   * segment size
 242                                   * (set by 6rd defrag node)
 243                                   */
 244
 245           u32  direction:1;     /* 0-Outside, 1-Inside */
 246           u32  frag:1;          /*IP fragment-1, Otherwise-0*/
 247           u32  option:1;        /* 0-No IP option (v4) present, non-fragHdr
 248                                  * option hdr present (v6)
 249                                  */
 250           u32  df_bit:1;        /* IPv4 DF bit copied here */
 251           u32  reserved1:6;
 252         } rx;
 253       } ru;
 254       /****** END  spp_ctx_t section ***********************/
 255
 256       union {
 257         struct {
 258           u32 ipv4;
 259           u16 port;
 260           u16 vrf;  //bit0-13:i/f, bit14-15:protocol
 261         } k;
 262
 263         u64 key64;
 264       } key;
 265
 266       u32 bucket;
 267
 268       u16 ovrf; /* Exit interface */
 269       u8 frag_pkt;
 270       u8 vcgn_unused1;
 271     } vcgn_uii;
 272
 273     /* MAP */
 274     struct {
 275       u16 mtu;
 276     } map;
 277
 278     /* MAP-T */
 279     struct {
 280       u32 map_domain_index;
 281       struct {
 282         u32 saddr, daddr;
 283         u16 frag_offset;      //Fragmentation header offset
 284         u16 l4_offset;        //L4 header overall offset
 285         u8  l4_protocol;      //The final protocol number
 286       } v6; //Used by ip6_map_t only
 287       u16 checksum_offset;    //L4 checksum overall offset
 288       u16 mtu;                //Exit MTU
 289     } map_t;
 290
 291     /* IP Fragmentation */
 292     struct {
 293       u16 header_offset;
 294       u16 mtu;
 295       u8 next_index;
 296       u8 flags;          //See ip_frag.h
 297     } ip_frag;
 298
 299     u32 unused[6];
 300   };
 301 } vnet_buffer_opaque_t;
 302
 303 #define vnet_buffer(b) ((vnet_buffer_opaque_t *) (b)->opaque)
 304
 305 /* Full cache line (64 bytes) of additional space */
 306 typedef struct {
 307   union {
 308   };
 309 } vnet_buffer_opaque2_t;
 310
 311
 312
 313 #endif /* included_vnet_buffer_h */