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