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