src/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_HANDOFF_NEXT_VALID LOG2_VLIB_BUFFER_FLAG_USER(6)
  65 #define BUFFER_HANDOFF_NEXT_VALID (1 << LOG2_BUFFER_HANDOFF_NEXT_VALID)
  66
  67 #define LOG2_VNET_BUFFER_LOCALLY_ORIGINATED LOG2_VLIB_BUFFER_FLAG_USER(7)
  68 #define VNET_BUFFER_LOCALLY_ORIGINATED (1 << LOG2_VNET_BUFFER_LOCALLY_ORIGINATED)
  69
  70 #define LOG2_VNET_BUFFER_SPAN_CLONE LOG2_VLIB_BUFFER_FLAG_USER(8)
  71 #define VNET_BUFFER_SPAN_CLONE (1 << LOG2_VNET_BUFFER_SPAN_CLONE)
  72
  73 #define foreach_buffer_opaque_union_subtype     \
  74 _(ip)                                           \
  75 _(swt)                                          \
  76 _(l2)                                           \
  77 _(l2t)                                          \
  78 _(gre)                                          \
  79 _(l2_classify)                                  \
  80 _(handoff)                                      \
  81 _(policer)                                      \
  82 _(ipsec)                                        \
  83 _(map)                                          \
  84 _(map_t)                                        \
  85 _(ip_frag)                                      \
  86 _(tcp)
  87
  88 /*
  89  * vnet stack buffer opaque array overlay structure.
  90  * The vnet_buffer_opaque_t *must* be the same size as the
  91  * vlib_buffer_t "opaque" structure member, 32 bytes.
  92  *
  93  * When adding a union type, please add a stanza to
  94  * foreach_buffer_opaque_union_subtype (directly above).
  95  * Code in vnet_interface_init(...) verifies the size
  96  * of the union, and will announce any deviations in an
  97  * impossible-to-miss manner.
  98  */
  99 typedef struct
 100 {
 101   u32 sw_if_index[VLIB_N_RX_TX];
 102   i16 l2_hdr_offset;
 103   i16 l3_hdr_offset;
 104   i16 l4_hdr_offset;
 105
 106   union
 107   {
 108     /* IP4/6 buffer opaque. */
 109     struct
 110     {
 111       /* Adjacency from destination IP address lookup [VLIB_TX].
 112          Adjacency from source IP address lookup [VLIB_RX].
 113          This gets set to ~0 until source lookup is performed. */
 114       u32 adj_index[VLIB_N_RX_TX];
 115
 116       union
 117       {
 118         struct
 119         {
 120           /* Flow hash value for this packet computed from IP src/dst address
 121              protocol and ports. */
 122           u32 flow_hash;
 123
 124           /* next protocol */
 125           u32 save_protocol;
 126
 127           /* Rewrite length */
 128           u32 save_rewrite_length;
 129
 130           /* MFIB RPF ID */
 131           u32 rpf_id;
 132         };
 133
 134         /* ICMP */
 135         struct
 136         {
 137           u8 type;
 138           u8 code;
 139           u32 data;
 140         } icmp;
 141       };
 142
 143     } ip;
 144
 145     /*
 146      * MPLS:
 147      * data copied from the MPLS header that was popped from the packet
 148      * during the look-up.
 149      */
 150     struct
 151     {
 152       u8 ttl;
 153       u8 exp;
 154       u8 first;
 155     } mpls;
 156
 157     /* ip4-in-ip6 softwire termination, only valid there */
 158     struct
 159     {
 160       u8 swt_disable;
 161       u32 mapping_index;
 162     } swt;
 163
 164     /* l2 bridging path, only valid there */
 165     struct opaque_l2
 166     {
 167       u32 feature_bitmap;
 168       u16 bd_index;             /* bridge-domain index */
 169       u8 l2_len;                /* ethernet header length */
 170       u8 shg;                   /* split-horizon group */
 171       u16 l2fib_sn;             /* l2fib bd/int seq_num */
 172     } l2;
 173
 174     /* l2tpv3 softwire encap, only valid there */
 175     struct
 176     {
 177       u32 pad[4];               /* do not overlay w/ ip.adj_index[0,1] */
 178       u8 next_index;
 179       u32 session_index;
 180     } l2t;
 181
 182     struct
 183     {
 184       u32 src, dst;
 185     } gre;
 186
 187     /* L2 classify */
 188     struct
 189     {
 190       struct opaque_l2 pad;
 191       union
 192       {
 193         u32 table_index;
 194         u32 opaque_index;
 195       };
 196       u64 hash;
 197     } l2_classify;
 198
 199     /* IO - worker thread handoff */
 200     struct
 201     {
 202       u32 next_index;
 203     } handoff;
 204
 205     /* vnet policer */
 206     struct
 207     {
 208       u32 pad[8 - VLIB_N_RX_TX - 1];    /* to end of opaque */
 209       u32 index;
 210     } policer;
 211
 212     /* interface output features */
 213     struct
 214     {
 215       u32 flags;
 216       u32 sad_index;
 217     } ipsec;
 218
 219     /* MAP */
 220     struct
 221     {
 222       u16 mtu;
 223     } map;
 224
 225     /* MAP-T */
 226     struct
 227     {
 228       u32 map_domain_index;
 229       struct
 230       {
 231         u32 saddr, daddr;
 232         u16 frag_offset;        //Fragmentation header offset
 233         u16 l4_offset;          //L4 header overall offset
 234         u8 l4_protocol;         //The final protocol number
 235       } v6;                     //Used by ip6_map_t only
 236       u16 checksum_offset;      //L4 checksum overall offset
 237       u16 mtu;                  //Exit MTU
 238     } map_t;
 239
 240     /* IP Fragmentation */
 241     struct
 242     {
 243       u16 header_offset;
 244       u16 mtu;
 245       u8 next_index;
 246       u8 flags;                 //See ip_frag.h
 247     } ip_frag;
 248
 249     /* COP - configurable junk filter(s) */
 250     struct
 251     {
 252       /* Current configuration index. */
 253       u32 current_config_index;
 254     } cop;
 255
 256     /* LISP */
 257     struct
 258     {
 259       /* overlay address family */
 260       u16 overlay_afi;
 261     } lisp;
 262
 263     /* Driver rx feature */
 264     struct
 265     {
 266       u32 saved_next_index;             /**< saved by drivers for short-cut */
 267       u16 buffer_advance;
 268     } device_input_feat;
 269
 270     /* TCP */
 271     struct
 272     {
 273       u32 connection_index;
 274       u32 seq_number;
 275       u32 seq_end;
 276       u32 ack_number;
 277       u16 hdr_offset;           /**< offset relative to ip hdr */
 278       u16 data_offset;          /**< offset relative to ip hdr */
 279       u16 data_len;             /**< data len */
 280       u8 flags;
 281     } tcp;
 282
 283     u32 unused[6];
 284   };
 285 } vnet_buffer_opaque_t;
 286
 287 /*
 288  * The opaque field of the vlib_buffer_t is intepreted as a
 289  * vnet_buffer_opaque_t. Hence it should be big enough to accommodate one.
 290  */
 291 STATIC_ASSERT (sizeof (vnet_buffer_opaque_t) <=
 292                STRUCT_SIZE_OF (vlib_buffer_t, opaque),
 293                "VNET buffer meta-data too large for vlib_buffer");
 294
 295 #define vnet_buffer(b) ((vnet_buffer_opaque_t *) (b)->opaque)
 296
 297 /* Full cache line (64 bytes) of additional space */
 298 typedef struct
 299 {
 300   union
 301   {
 302   };
 303 } vnet_buffer_opaque2_t;
 304
 305
 306
 307 #endif /* included_vnet_buffer_h */
 308
 309 /*
 310  * fd.io coding-style-patch-verification: ON
 311  *
 312  * Local Variables:
 313  * eval: (c-set-style "gnu")
 314  * End:
 315  */