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