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       /* do not overlay w/ ip.adj_index[0,1] nor flow hash */
 185       u32 pad[VLIB_N_RX_TX + 1];
 186       u8 ttl;
 187       u8 exp;
 188       u8 first;
 189       /*
 190        * BIER - the nubmer of bytes in the header.
 191        *  the len field inthe header is not authoritative. It's the
 192        * value in the table that counts.
 193        */
 194       struct
 195       {
 196         u8 n_bytes;
 197       } bier;
 198     } mpls;
 199
 200     /* ip4-in-ip6 softwire termination, only valid there */
 201     struct
 202     {
 203       u8 swt_disable;
 204       u32 mapping_index;
 205     } swt;
 206
 207     /* l2 bridging path, only valid there */
 208     struct opaque_l2
 209     {
 210       u32 feature_bitmap;
 211       u16 bd_index;             /* bridge-domain index */
 212       u8 l2_len;                /* ethernet header length */
 213       u8 shg;                   /* split-horizon group */
 214       u16 l2fib_sn;             /* l2fib bd/int seq_num */
 215       u8 bd_age;                /* aging enabled */
 216     } l2;
 217
 218     /* l2tpv3 softwire encap, only valid there */
 219     struct
 220     {
 221       u32 pad[4];               /* do not overlay w/ ip.adj_index[0,1] */
 222       u8 next_index;
 223       u32 session_index;
 224     } l2t;
 225
 226     struct
 227     {
 228       u32 src, dst;
 229     } gre;
 230
 231     /* L2 classify */
 232     struct
 233     {
 234       struct opaque_l2 pad;
 235       union
 236       {
 237         u32 table_index;
 238         u32 opaque_index;
 239       };
 240       u64 hash;
 241     } l2_classify;
 242
 243     /* IO - worker thread handoff */
 244     struct
 245     {
 246       u32 next_index;
 247     } handoff;
 248
 249     /* vnet policer */
 250     struct
 251     {
 252       u32 pad[8 - VLIB_N_RX_TX - 1];    /* to end of opaque */
 253       u32 index;
 254     } policer;
 255
 256     /* interface output features */
 257     struct
 258     {
 259       u32 flags;
 260       u32 sad_index;
 261     } ipsec;
 262
 263     /* MAP */
 264     struct
 265     {
 266       u16 mtu;
 267     } map;
 268
 269     /* MAP-T */
 270     struct
 271     {
 272       u32 map_domain_index;
 273       struct
 274       {
 275         u32 saddr, daddr;
 276         u16 frag_offset;        //Fragmentation header offset
 277         u16 l4_offset;          //L4 header overall offset
 278         u8 l4_protocol;         //The final protocol number
 279       } v6;                     //Used by ip6_map_t only
 280       u16 checksum_offset;      //L4 checksum overall offset
 281       u16 mtu;                  //Exit MTU
 282     } map_t;
 283
 284     /* IP Fragmentation */
 285     struct
 286     {
 287       u32 pad[2];               /* do not overlay w/ ip.adj_index[0,1] */
 288       u16 header_offset;
 289       u16 mtu;
 290       u8 next_index;
 291       u8 flags;                 //See ip_frag.h
 292     } ip_frag;
 293
 294     /* COP - configurable junk filter(s) */
 295     struct
 296     {
 297       /* Current configuration index. */
 298       u32 current_config_index;
 299     } cop;
 300
 301     /* LISP */
 302     struct
 303     {
 304       /* overlay address family */
 305       u16 overlay_afi;
 306     } lisp;
 307
 308     /* Driver rx feature */
 309     struct
 310     {
 311       u32 saved_next_index;             /**< saved by drivers for short-cut */
 312       u16 buffer_advance;
 313     } device_input_feat;
 314
 315     /* TCP */
 316     struct
 317     {
 318       u32 connection_index;
 319       u32 seq_number;
 320       u32 seq_end;
 321       u32 ack_number;
 322       u16 hdr_offset;           /**< offset relative to ip hdr */
 323       u16 data_offset;          /**< offset relative to ip hdr */
 324       u16 data_len;             /**< data len */
 325       u8 flags;
 326     } tcp;
 327
 328     /* SCTP */
 329     struct
 330     {
 331       u32 connection_index;
 332       u16 sid; /**< Stream ID */
 333       u16 ssn; /**< Stream Sequence Number */
 334       u32 tsn; /**< Transmission Sequence Number */
 335       u16 hdr_offset;           /**< offset relative to ip hdr */
 336       u16 data_offset;          /**< offset relative to ip hdr */
 337       u16 data_len;             /**< data len */
 338       u8 subconn_idx; /**< index of the sub_connection being used */
 339       u8 flags;
 340     } sctp;
 341
 342     /* SNAT */
 343     struct
 344     {
 345       u32 flags;
 346     } snat;
 347
 348     u32 unused[6];
 349   };
 350 } vnet_buffer_opaque_t;
 351
 352 /*
 353  * The opaque field of the vlib_buffer_t is intepreted as a
 354  * vnet_buffer_opaque_t. Hence it should be big enough to accommodate one.
 355  */
 356 STATIC_ASSERT (sizeof (vnet_buffer_opaque_t) <=
 357                STRUCT_SIZE_OF (vlib_buffer_t, opaque),
 358                "VNET buffer meta-data too large for vlib_buffer");
 359
 360 #define vnet_buffer(b) ((vnet_buffer_opaque_t *) (b)->opaque)
 361
 362 /* Full cache line (64 bytes) of additional space */
 363 typedef struct
 364 {
 365   union
 366   {
 367 #if VLIB_BUFFER_TRACE_TRAJECTORY > 0
 368     /* buffer trajectory tracing */
 369     struct
 370     {
 371       u16 *trajectory_trace;
 372     };
 373 #endif
 374     u32 unused[12];
 375   };
 376 } vnet_buffer_opaque2_t;
 377
 378 #define vnet_buffer2(b) ((vnet_buffer_opaque2_t *) (b)->opaque2)
 379
 380 /*
 381  * The opaque2 field of the vlib_buffer_t is intepreted as a
 382  * vnet_buffer_opaque2_t. Hence it should be big enough to accommodate one.
 383  */
 384 STATIC_ASSERT (sizeof (vnet_buffer_opaque2_t) <=
 385                STRUCT_SIZE_OF (vlib_buffer_t, opaque2),
 386                "VNET buffer opaque2 meta-data too large for vlib_buffer");
 387
 388 format_function_t format_vnet_buffer;
 389
 390 #endif /* included_vnet_buffer_h */
 391
 392 /*
 393  * fd.io coding-style-patch-verification: ON
 394  *
 395  * Local Variables:
 396  * eval: (c-set-style "gnu")
 397  * End:
 398  */