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, "offload", 0)                                               \
  60   _ (11, IS_NATED, "natted", 1)                                               \
  61   _ (12, L2_HDR_OFFSET_VALID, "l2_hdr_offset_valid", 0)                       \
  62   _ (13, L3_HDR_OFFSET_VALID, "l3_hdr_offset_valid", 0)                       \
  63   _ (14, L4_HDR_OFFSET_VALID, "l4_hdr_offset_valid", 0)                       \
  64   _ (15, FLOW_REPORT, "flow-report", 1)                                       \
  65   _ (16, IS_DVR, "dvr", 1)                                                    \
  66   _ (17, QOS_DATA_VALID, "qos-data-valid", 0)                                 \
  67   _ (18, GSO, "gso", 0)                                                       \
  68   _ (19, AVAIL1, "avail1", 1)                                                 \
  69   _ (20, AVAIL2, "avail2", 1)                                                 \
  70   _ (21, AVAIL3, "avail3", 1)                                                 \
  71   _ (22, AVAIL4, "avail4", 1)                                                 \
  72   _ (23, AVAIL5, "avail5", 1)                                                 \
  73   _ (24, AVAIL6, "avail6", 1)                                                 \
  74   _ (25, AVAIL7, "avail7", 1)                                                 \
  75   _ (26, AVAIL8, "avail8", 1)                                                 \
  76   _ (27, AVAIL9, "avail9", 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 | VNET_BUFFER_F_AVAIL8 | VNET_BUFFER_F_AVAIL9)
  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   /* offload flags */
 142   u8 oflags;
 143
 144   union
 145   {
 146     /* IP4/6 buffer opaque. */
 147     struct
 148     {
 149       /* Adjacency from destination IP address lookup [VLIB_TX].
 150          Adjacency from source IP address lookup [VLIB_RX].
 151          This gets set to ~0 until source lookup is performed. */
 152       u32 adj_index[VLIB_N_RX_TX];
 153
 154       union
 155       {
 156         struct
 157         {
 158           /* Flow hash value for this packet computed from IP src/dst address
 159              protocol and ports. */
 160           u32 flow_hash;
 161
 162           union
 163           {
 164             /* next protocol */
 165             u32 save_protocol;
 166
 167             /* Hint for transport protocols */
 168             u32 fib_index;
 169           };
 170
 171           /* Rewrite length */
 172           u8 save_rewrite_length;
 173
 174           /* MFIB RPF ID */
 175           u32 rpf_id;
 176         };
 177
 178         /* ICMP */
 179         struct
 180         {
 181           u8 type;
 182           u8 code;
 183           u32 data;
 184         } icmp;
 185
 186         /* reassembly */
 187         union
 188         {
 189           /* group input/output to simplify the code, this way
 190            * we can handoff while keeping input variables intact */
 191           struct
 192           {
 193             /* input variables */
 194             struct
 195             {
 196               u32 next_index;   /* index of next node - used by custom apps */
 197               u32 error_next_index;     /* index of next node if error - used by custom apps */
 198             };
 199             /* handoff variables */
 200             struct
 201             {
 202               u16 owner_thread_index;
 203             };
 204           };
 205           /* output variables */
 206           struct
 207           {
 208             union
 209             {
 210               /* shallow virtual reassembly output variables */
 211               struct
 212               {
 213                 u16 l4_src_port;        /* tcp/udp/icmp src port */
 214                 u16 l4_dst_port;        /* tcp/udp/icmp dst port */
 215                 u32 tcp_ack_number;
 216                 u8 save_rewrite_length;
 217                 u8 ip_proto;    /* protocol in ip header */
 218                 u8 icmp_type_or_tcp_flags;
 219                 u8 is_non_first_fragment;
 220                 u32 tcp_seq_number;
 221               };
 222               /* full reassembly output variables */
 223               struct
 224               {
 225                 u16 estimated_mtu;      /* estimated MTU calculated during reassembly */
 226               };
 227             };
 228           };
 229           /* internal variables used during reassembly */
 230           struct
 231           {
 232             u16 fragment_first;
 233             u16 fragment_last;
 234             u16 range_first;
 235             u16 range_last;
 236             u32 next_range_bi;
 237             u16 ip6_frag_hdr_offset;
 238           };
 239         } reass;
 240       };
 241     } ip;
 242
 243     /*
 244      * MPLS:
 245      * data copied from the MPLS header that was popped from the packet
 246      * during the look-up.
 247      */
 248     struct
 249     {
 250       /* do not overlay w/ ip.adj_index[0,1] nor flow hash */
 251       u32 pad[VLIB_N_RX_TX + 1];
 252       u8 ttl;
 253       u8 exp;
 254       u8 first;
 255       u8 pyld_proto:3;          /* dpo_proto_t */
 256       u8 rsvd:5;
 257       /* Rewrite length */
 258       u8 save_rewrite_length;
 259       /* Save the mpls header length including all label stack */
 260       u8 mpls_hdr_length;
 261       /*
 262        * BIER - the number of bytes in the header.
 263        *  the len field in the header is not authoritative. It's the
 264        * value in the table that counts.
 265        */
 266       struct
 267       {
 268         u8 n_bytes;
 269       } bier;
 270     } mpls;
 271
 272     /* l2 bridging path, only valid there */
 273     struct opaque_l2
 274     {
 275       u32 feature_bitmap;
 276       u16 bd_index;             /* bridge-domain index */
 277       u16 l2fib_sn;             /* l2fib bd/int seq_num */
 278       u8 l2_len;                /* ethernet header length */
 279       u8 shg;                   /* split-horizon group */
 280       u8 bd_age;                /* aging enabled */
 281     } l2;
 282
 283     /* l2tpv3 softwire encap, only valid there */
 284     struct
 285     {
 286       u32 pad[4];               /* do not overlay w/ ip.adj_index[0,1] */
 287       u8 next_index;
 288       u32 session_index;
 289     } l2t;
 290
 291     /* L2 classify */
 292     struct
 293     {
 294       struct opaque_l2 pad;
 295       union
 296       {
 297         u32 table_index;
 298         u32 opaque_index;
 299       };
 300       u64 hash;
 301     } l2_classify;
 302
 303     /* vnet policer */
 304     struct
 305     {
 306       u32 pad[8 - VLIB_N_RX_TX - 1];    /* to end of opaque */
 307       u32 index;
 308     } policer;
 309
 310     /* interface output features */
 311     struct
 312     {
 313       /* don't overlap the adjcencies nor flow-hash */
 314       u32 __pad[3];
 315       u32 sad_index;
 316       u32 protect_index;
 317       u16 thread_index;
 318     } ipsec;
 319
 320     /* MAP */
 321     struct
 322     {
 323       u16 mtu;
 324     } map;
 325
 326     /* MAP-T */
 327     struct
 328     {
 329       u32 map_domain_index;
 330       struct
 331       {
 332         u32 saddr, daddr;
 333         u16 frag_offset;        //Fragmentation header offset
 334         u16 l4_offset;          //L4 header overall offset
 335         u8 l4_protocol;         //The final protocol number
 336       } v6;                     //Used by ip6_map_t only
 337       u16 checksum_offset;      //L4 checksum overall offset
 338       u16 mtu;                  //Exit MTU
 339     } map_t;
 340
 341     /* IP Fragmentation */
 342     struct
 343     {
 344       u32 pad[2];               /* do not overlay w/ ip.adj_index[0,1] */
 345       u16 mtu;
 346       u8 next_index;
 347       u8 flags;                 //See ip_frag.h
 348     } ip_frag;
 349
 350     /* COP - configurable junk filter(s) */
 351     struct
 352     {
 353       /* Current configuration index. */
 354       u32 current_config_index;
 355     } cop;
 356
 357     /* LISP */
 358     struct
 359     {
 360       /* overlay address family */
 361       u16 overlay_afi;
 362     } lisp;
 363
 364     /* TCP */
 365     struct
 366     {
 367       u32 connection_index;
 368       union
 369       {
 370         u32 seq_number;
 371         u32 next_node_opaque;
 372       };
 373       u32 seq_end;
 374       u32 ack_number;
 375       u16 hdr_offset;           /**< offset relative to ip hdr */
 376       u16 data_offset;          /**< offset relative to ip hdr */
 377       u16 data_len;             /**< data len */
 378       u8 flags;
 379     } tcp;
 380
 381     /* SNAT */
 382     struct
 383     {
 384       u32 flags;
 385       u32 required_thread_index;
 386     } snat;
 387
 388     u32 unused[6];
 389   };
 390 } vnet_buffer_opaque_t;
 391
 392 #define VNET_REWRITE_TOTAL_BYTES (VLIB_BUFFER_PRE_DATA_SIZE)
 393
 394 STATIC_ASSERT (STRUCT_SIZE_OF (vnet_buffer_opaque_t, ip.save_rewrite_length)
 395                == STRUCT_SIZE_OF (vnet_buffer_opaque_t,
 396                                   ip.reass.save_rewrite_length)
 397                && STRUCT_SIZE_OF (vnet_buffer_opaque_t,
 398                                   ip.reass.save_rewrite_length) ==
 399                STRUCT_SIZE_OF (vnet_buffer_opaque_t, mpls.save_rewrite_length)
 400                && STRUCT_SIZE_OF (vnet_buffer_opaque_t,
 401                                   mpls.save_rewrite_length) == 1
 402                && VNET_REWRITE_TOTAL_BYTES < UINT8_MAX,
 403                "save_rewrite_length member must be able to hold the max value of rewrite length");
 404
 405 STATIC_ASSERT (STRUCT_OFFSET_OF (vnet_buffer_opaque_t, ip.save_rewrite_length)
 406                == STRUCT_OFFSET_OF (vnet_buffer_opaque_t,
 407                                     ip.reass.save_rewrite_length)
 408                && STRUCT_OFFSET_OF (vnet_buffer_opaque_t,
 409                                     mpls.save_rewrite_length) ==
 410                STRUCT_OFFSET_OF (vnet_buffer_opaque_t,
 411                                  ip.reass.save_rewrite_length),
 412                "save_rewrite_length must be aligned so that reass doesn't overwrite it");
 413
 414 /*
 415  * The opaque field of the vlib_buffer_t is interpreted as a
 416  * vnet_buffer_opaque_t. Hence it should be big enough to accommodate one.
 417  */
 418 STATIC_ASSERT (sizeof (vnet_buffer_opaque_t) <=
 419                STRUCT_SIZE_OF (vlib_buffer_t, opaque),
 420                "VNET buffer meta-data too large for vlib_buffer");
 421
 422 #define vnet_buffer(b) ((vnet_buffer_opaque_t *) (b)->opaque)
 423
 424 #define foreach_vnet_buffer_offload_flag                                      \
 425   _ (0, IP_CKSUM, "offload-ip-cksum", 1)                                      \
 426   _ (1, TCP_CKSUM, "offload-tcp-cksum", 1)                                    \
 427   _ (2, UDP_CKSUM, "offload-udp-cksum", 1)                                    \
 428   _ (3, OUTER_IP_CKSUM, "offload-outer-ip-cksum", 1)                          \
 429   _ (4, OUTER_TCP_CKSUM, "offload-outer-tcp-cksum", 1)                        \
 430   _ (5, OUTER_UDP_CKSUM, "offload-outer-udp-cksum", 1)
 431
 432 enum
 433 {
 434 #define _(bit, name, s, v) VNET_BUFFER_OFFLOAD_F_##name = (1 << bit),
 435   foreach_vnet_buffer_offload_flag
 436 #undef _
 437 };
 438
 439 /* Full cache line (64 bytes) of additional space */
 440 typedef struct
 441 {
 442   /**
 443    * QoS marking data that needs to persist from the recording nodes
 444    * (nominally in the ingress path) to the marking node (in the
 445    * egress path)
 446    */
 447   struct
 448   {
 449     u8 bits;
 450     u8 source;
 451   } qos;
 452
 453   u8 loop_counter;
 454   u8 __unused[1];
 455
 456   /* Group Based Policy */
 457   struct
 458   {
 459     u8 __unused;
 460     u8 flags;
 461     u16 sclass;
 462   } gbp;
 463
 464   /**
 465    * The L4 payload size set on input on GSO enabled interfaces
 466    * when we receive a GSO packet (a chain of buffers with the first one
 467    * having GSO bit set), and needs to persist all the way to the interface-output,
 468    * in case the egress interface is not GSO-enabled - then we need to perform
 469    * the segmentation, and use this value to cut the payload appropriately.
 470    */
 471   struct
 472   {
 473     u16 gso_size;
 474     /* size of L4 prototol header */
 475     u16 gso_l4_hdr_sz;
 476   };
 477
 478   struct
 479   {
 480     u32 arc_next;
 481     union
 482     {
 483       u32 cached_session_index;
 484       u32 cached_dst_nat_session_index;
 485     };
 486   } nat;
 487
 488   union
 489   {
 490     struct
 491     {
 492       u64 pad[1];
 493       u64 pg_replay_timestamp;
 494     };
 495     u32 unused[8];
 496   };
 497 } vnet_buffer_opaque2_t;
 498
 499 #define vnet_buffer2(b) ((vnet_buffer_opaque2_t *) (b)->opaque2)
 500
 501 /*
 502  * The opaque2 field of the vlib_buffer_t is interpreted as a
 503  * vnet_buffer_opaque2_t. Hence it should be big enough to accommodate one.
 504  */
 505 STATIC_ASSERT (sizeof (vnet_buffer_opaque2_t) <=
 506                STRUCT_SIZE_OF (vlib_buffer_t, opaque2),
 507                "VNET buffer opaque2 meta-data too large for vlib_buffer");
 508
 509 #define gso_mtu_sz(b) (vnet_buffer2(b)->gso_size + \
 510                        vnet_buffer2(b)->gso_l4_hdr_sz + \
 511                        vnet_buffer(b)->l4_hdr_offset - \
 512                        vnet_buffer (b)->l3_hdr_offset)
 513
 514
 515 format_function_t format_vnet_buffer;
 516 format_function_t format_vnet_buffer_offload;
 517 format_function_t format_vnet_buffer_flags;
 518 format_function_t format_vnet_buffer_opaque;
 519 format_function_t format_vnet_buffer_opaque2;
 520
 521 static_always_inline void
 522 vnet_buffer_offload_flags_set (vlib_buffer_t *b, u32 oflags)
 523 {
 524   if (b->flags & VNET_BUFFER_F_OFFLOAD)
 525     {
 526       /* add a flag to existing offload */
 527       vnet_buffer (b)->oflags |= oflags;
 528     }
 529   else
 530     {
 531       /* no offload yet: reset offload flags to new value */
 532       vnet_buffer (b)->oflags = oflags;
 533       b->flags |= VNET_BUFFER_F_OFFLOAD;
 534     }
 535 }
 536
 537 static_always_inline void
 538 vnet_buffer_offload_flags_clear (vlib_buffer_t *b, u32 oflags)
 539 {
 540   vnet_buffer (b)->oflags &= ~oflags;
 541   if (0 == vnet_buffer (b)->oflags)
 542     b->flags &= ~VNET_BUFFER_F_OFFLOAD;
 543 }
 544
 545 #endif /* included_vnet_buffer_h */
 546
 547 /*
 548  * fd.io coding-style-patch-verification: ON
 549  *
 550  * Local Variables:
 551  * eval: (c-set-style "gnu")
 552  * End:
 553  */