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