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