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