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