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 #define foreach_vnet_buffer_field \
  46   _( 1, L4_CHECKSUM_COMPUTED)                           \
  47   _( 2, L4_CHECKSUM_CORRECT)                            \
  48   _( 3, VLAN_2_DEEP)                                    \
  49   _( 4, VLAN_1_DEEP)                                    \
  50   _( 8, SPAN_CLONE)                                     \
  51   _( 6, HANDOFF_NEXT_VALID)                             \
  52   _( 7, LOCALLY_ORIGINATED)                             \
  53   _( 8, IS_IP4)                                         \
  54   _( 9, IS_IP6)                                         \
  55   _(10, OFFLOAD_IP_CKSUM)                               \
  56   _(11, OFFLOAD_TCP_CKSUM)                              \
  57   _(12, OFFLOAD_UDP_CKSUM)                              \
  58   _(13, IS_NATED)
  59
  60 #define VNET_BUFFER_FLAGS_VLAN_BITS \
  61   (VNET_BUFFER_F_VLAN_1_DEEP | VNET_BUFFER_F_VLAN_2_DEEP)
  62
  63 enum
  64 {
  65 #define _(bit, name) VNET_BUFFER_F_##name  = (1 << LOG2_VLIB_BUFFER_FLAG_USER(bit)),
  66   foreach_vnet_buffer_field
  67 #undef _
  68 };
  69
  70 enum
  71 {
  72 #define _(bit, name) VNET_BUFFER_F_LOG2_##name  = LOG2_VLIB_BUFFER_FLAG_USER(bit),
  73   foreach_vnet_buffer_field
  74 #undef _
  75 };
  76
  77
  78 #define foreach_buffer_opaque_union_subtype     \
  79 _(ip)                                           \
  80 _(swt)                                          \
  81 _(l2)                                           \
  82 _(l2t)                                          \
  83 _(gre)                                          \
  84 _(l2_classify)                                  \
  85 _(handoff)                                      \
  86 _(policer)                                      \
  87 _(ipsec)                                        \
  88 _(map)                                          \
  89 _(map_t)                                        \
  90 _(ip_frag)                                      \
  91 _(tcp)
  92
  93 /*
  94  * vnet stack buffer opaque array overlay structure.
  95  * The vnet_buffer_opaque_t *must* be the same size as the
  96  * vlib_buffer_t "opaque" structure member, 32 bytes.
  97  *
  98  * When adding a union type, please add a stanza to
  99  * foreach_buffer_opaque_union_subtype (directly above).
 100  * Code in vnet_interface_init(...) verifies the size
 101  * of the union, and will announce any deviations in an
 102  * impossible-to-miss manner.
 103  */
 104 typedef struct
 105 {
 106   u32 sw_if_index[VLIB_N_RX_TX];
 107   i16 l2_hdr_offset;
 108   i16 l3_hdr_offset;
 109   i16 l4_hdr_offset;
 110
 111   union
 112   {
 113     /* IP4/6 buffer opaque. */
 114     struct
 115     {
 116       /* Adjacency from destination IP address lookup [VLIB_TX].
 117          Adjacency from source IP address lookup [VLIB_RX].
 118          This gets set to ~0 until source lookup is performed. */
 119       u32 adj_index[VLIB_N_RX_TX];
 120
 121       union
 122       {
 123         struct
 124         {
 125           /* Flow hash value for this packet computed from IP src/dst address
 126              protocol and ports. */
 127           u32 flow_hash;
 128
 129           union
 130           {
 131             /* next protocol */
 132             u32 save_protocol;
 133
 134             /* Hint for transport protocols */
 135             u32 fib_index;
 136           };
 137
 138           /* Rewrite length */
 139           u32 save_rewrite_length;
 140
 141           /* MFIB RPF ID */
 142           u32 rpf_id;
 143         };
 144
 145         /* ICMP */
 146         struct
 147         {
 148           u8 type;
 149           u8 code;
 150           u32 data;
 151         } icmp;
 152       };
 153
 154     } ip;
 155
 156     /*
 157      * MPLS:
 158      * data copied from the MPLS header that was popped from the packet
 159      * during the look-up.
 160      */
 161     struct
 162     {
 163       u8 ttl;
 164       u8 exp;
 165       u8 first;
 166     } mpls;
 167
 168     /* ip4-in-ip6 softwire termination, only valid there */
 169     struct
 170     {
 171       u8 swt_disable;
 172       u32 mapping_index;
 173     } swt;
 174
 175     /* l2 bridging path, only valid there */
 176     struct opaque_l2
 177     {
 178       u32 feature_bitmap;
 179       u16 bd_index;             /* bridge-domain index */
 180       u8 l2_len;                /* ethernet header length */
 181       u8 shg;                   /* split-horizon group */
 182       u16 l2fib_sn;             /* l2fib bd/int seq_num */
 183       u8 bd_age;                /* aging enabled */
 184     } l2;
 185
 186     /* l2tpv3 softwire encap, only valid there */
 187     struct
 188     {
 189       u32 pad[4];               /* do not overlay w/ ip.adj_index[0,1] */
 190       u8 next_index;
 191       u32 session_index;
 192     } l2t;
 193
 194     struct
 195     {
 196       u32 src, dst;
 197     } gre;
 198
 199     /* L2 classify */
 200     struct
 201     {
 202       struct opaque_l2 pad;
 203       union
 204       {
 205         u32 table_index;
 206         u32 opaque_index;
 207       };
 208       u64 hash;
 209     } l2_classify;
 210
 211     /* IO - worker thread handoff */
 212     struct
 213     {
 214       u32 next_index;
 215     } handoff;
 216
 217     /* vnet policer */
 218     struct
 219     {
 220       u32 pad[8 - VLIB_N_RX_TX - 1];    /* to end of opaque */
 221       u32 index;
 222     } policer;
 223
 224     /* interface output features */
 225     struct
 226     {
 227       u32 flags;
 228       u32 sad_index;
 229     } ipsec;
 230
 231     /* MAP */
 232     struct
 233     {
 234       u16 mtu;
 235     } map;
 236
 237     /* MAP-T */
 238     struct
 239     {
 240       u32 map_domain_index;
 241       struct
 242       {
 243         u32 saddr, daddr;
 244         u16 frag_offset;        //Fragmentation header offset
 245         u16 l4_offset;          //L4 header overall offset
 246         u8 l4_protocol;         //The final protocol number
 247       } v6;                     //Used by ip6_map_t only
 248       u16 checksum_offset;      //L4 checksum overall offset
 249       u16 mtu;                  //Exit MTU
 250     } map_t;
 251
 252     /* IP Fragmentation */
 253     struct
 254     {
 255       u16 header_offset;
 256       u16 mtu;
 257       u8 next_index;
 258       u8 flags;                 //See ip_frag.h
 259     } ip_frag;
 260
 261     /* COP - configurable junk filter(s) */
 262     struct
 263     {
 264       /* Current configuration index. */
 265       u32 current_config_index;
 266     } cop;
 267
 268     /* LISP */
 269     struct
 270     {
 271       /* overlay address family */
 272       u16 overlay_afi;
 273     } lisp;
 274
 275     /* Driver rx feature */
 276     struct
 277     {
 278       u32 saved_next_index;             /**< saved by drivers for short-cut */
 279       u16 buffer_advance;
 280     } device_input_feat;
 281
 282     /* TCP */
 283     struct
 284     {
 285       u32 connection_index;
 286       u32 seq_number;
 287       u32 seq_end;
 288       u32 ack_number;
 289       u16 hdr_offset;           /**< offset relative to ip hdr */
 290       u16 data_offset;          /**< offset relative to ip hdr */
 291       u16 data_len;             /**< data len */
 292       u8 flags;
 293     } tcp;
 294
 295     /* SNAT */
 296     struct
 297     {
 298       u32 flags;
 299     } snat;
 300
 301     u32 unused[6];
 302   };
 303 } vnet_buffer_opaque_t;
 304
 305 /*
 306  * The opaque field of the vlib_buffer_t is intepreted as a
 307  * vnet_buffer_opaque_t. Hence it should be big enough to accommodate one.
 308  */
 309 STATIC_ASSERT (sizeof (vnet_buffer_opaque_t) <=
 310                STRUCT_SIZE_OF (vlib_buffer_t, opaque),
 311                "VNET buffer meta-data too large for vlib_buffer");
 312
 313 #define vnet_buffer(b) ((vnet_buffer_opaque_t *) (b)->opaque)
 314
 315 /* Full cache line (64 bytes) of additional space */
 316 typedef struct
 317 {
 318   union
 319   {
 320 #if VLIB_BUFFER_TRACE_TRAJECTORY > 0
 321     /* buffer trajectory tracing */
 322     struct
 323     {
 324       u16 *trajectory_trace;
 325     };
 326 #endif
 327     u32 unused[12];
 328   };
 329 } vnet_buffer_opaque2_t;
 330
 331 #define vnet_buffer2(b) ((vnet_buffer_opaque2_t *) (b)->opaque2)
 332
 333 /*
 334  * The opaque2 field of the vlib_buffer_t is intepreted as a
 335  * vnet_buffer_opaque2_t. Hence it should be big enough to accommodate one.
 336  */
 337 STATIC_ASSERT (sizeof (vnet_buffer_opaque2_t) <=
 338                STRUCT_SIZE_OF (vlib_buffer_t, opaque2),
 339                "VNET buffer opaque2 meta-data too large for vlib_buffer");
 340
 341
 342 #endif /* included_vnet_buffer_h */
 343
 344 /*
 345  * fd.io coding-style-patch-verification: ON
 346  *
 347  * Local Variables:
 348  * eval: (c-set-style "gnu")
 349  * End:
 350  */