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