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