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