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