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