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 /* VLIB buffer flags for ip4/ip6 packets.  Set by input interfaces for ip4/ip6
  46    tcp/udp packets with hardware computed checksums. */
  47 #define LOG2_IP_BUFFER_L4_CHECKSUM_COMPUTED LOG2_VLIB_BUFFER_FLAG_USER(1)
  48 #define LOG2_IP_BUFFER_L4_CHECKSUM_CORRECT  LOG2_VLIB_BUFFER_FLAG_USER(2)
  49 #define IP_BUFFER_L4_CHECKSUM_COMPUTED (1 << LOG2_IP_BUFFER_L4_CHECKSUM_COMPUTED)
  50 #define IP_BUFFER_L4_CHECKSUM_CORRECT  (1 << LOG2_IP_BUFFER_L4_CHECKSUM_CORRECT)
  51
  52 /* VLAN header flags.
  53  * These bits are zeroed in vlib_buffer_init_for_free_list()
  54  * meaning wherever the buffer comes from they have a reasonable
  55  * value (eg, if ip4/ip6 generates the packet.)
  56  */
  57 #define LOG2_ETH_BUFFER_VLAN_2_DEEP LOG2_VLIB_BUFFER_FLAG_USER(3)
  58 #define LOG2_ETH_BUFFER_VLAN_1_DEEP LOG2_VLIB_BUFFER_FLAG_USER(4)
  59 #define ETH_BUFFER_VLAN_2_DEEP (1 << LOG2_ETH_BUFFER_VLAN_2_DEEP)
  60 #define ETH_BUFFER_VLAN_1_DEEP (1 << LOG2_ETH_BUFFER_VLAN_1_DEEP)
  61 #define ETH_BUFFER_VLAN_BITS (ETH_BUFFER_VLAN_1_DEEP | \
  62                               ETH_BUFFER_VLAN_2_DEEP)
  63
  64 #define LOG2_BUFFER_HANDOFF_NEXT_VALID LOG2_VLIB_BUFFER_FLAG_USER(6)
  65 #define BUFFER_HANDOFF_NEXT_VALID (1 << LOG2_BUFFER_HANDOFF_NEXT_VALID)
  66
  67 #define LOG2_VNET_BUFFER_LOCALLY_ORIGINATED LOG2_VLIB_BUFFER_FLAG_USER(7)
  68 #define VNET_BUFFER_LOCALLY_ORIGINATED (1 << LOG2_VNET_BUFFER_LOCALLY_ORIGINATED)
  69
  70 #define LOG2_VNET_BUFFER_SPAN_CLONE LOG2_VLIB_BUFFER_FLAG_USER(8)
  71 #define VNET_BUFFER_SPAN_CLONE (1 << LOG2_VNET_BUFFER_SPAN_CLONE)
  72
  73 #define foreach_buffer_opaque_union_subtype     \
  74 _(ethernet)                                     \
  75 _(ip)                                           \
  76 _(mcast)                                        \
  77 _(swt)                                          \
  78 _(l2)                                           \
  79 _(l2t)                                          \
  80 _(gre)                                          \
  81 _(l2_classify)                                  \
  82 _(handoff)                                      \
  83 _(policer)                                      \
  84 _(ipsec)                                        \
  85 _(map)                                          \
  86 _(map_t)                                        \
  87 _(ip_frag)
  88
  89 /*
  90  * vnet stack buffer opaque array overlay structure.
  91  * The vnet_buffer_opaque_t *must* be the same size as the
  92  * vlib_buffer_t "opaque" structure member, 32 bytes.
  93  *
  94  * When adding a union type, please add a stanza to
  95  * foreach_buffer_opaque_union_subtype (directly above).
  96  * Code in vnet_interface_init(...) verifies the size
  97  * of the union, and will announce any deviations in an
  98  * impossible-to-miss manner.
  99  */
 100 typedef struct
 101 {
 102   u32 sw_if_index[VLIB_N_RX_TX];
 103
 104   union
 105   {
 106     /* Ethernet. */
 107     struct
 108     {
 109       /* Saved value of current header by ethernet-input. */
 110       i32 start_of_ethernet_header;
 111     } ethernet;
 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           /* next protocol */
 130           u32 save_protocol;
 131
 132           /* Rewrite length */
 133           u32 save_rewrite_length;
 134         };
 135
 136         /* ICMP */
 137         struct
 138         {
 139           u8 type;
 140           u8 code;
 141           u32 data;
 142         } icmp;
 143
 144         /* IP header offset from vlib_buffer.data - saved by ip*_local nodes */
 145         i32 start_of_ip_header;
 146       };
 147
 148     } ip;
 149
 150     /*
 151      * MPLS:
 152      * data copied from the MPLS header that was popped from the packet
 153      * during the look-up.
 154      */
 155     struct
 156     {
 157       u8 ttl;
 158       u8 exp;
 159       u8 first;
 160     } mpls;
 161
 162     /* Multicast replication */
 163     struct
 164     {
 165       u32 pad[3];
 166       u32 mcast_group_index;
 167       u32 mcast_current_index;
 168       u32 original_free_list_index;
 169     } mcast;
 170
 171     /* ip4-in-ip6 softwire termination, only valid there */
 172     struct
 173     {
 174       u8 swt_disable;
 175       u32 mapping_index;
 176     } swt;
 177
 178     /* l2 bridging path, only valid there */
 179     struct
 180     {
 181       u32 feature_bitmap;
 182       u16 bd_index;             // bridge-domain index
 183       u8 l2_len;                // ethernet header length
 184       u8 shg;                   // split-horizon group
 185     } l2;
 186
 187     /* l2tpv3 softwire encap, only valid there */
 188     struct
 189     {
 190       u32 pad[4];               /* do not overlay w/ ip.adj_index[0,1] */
 191       u8 next_index;
 192       u32 session_index;
 193     } l2t;
 194
 195     struct
 196     {
 197       u32 src, dst;
 198     } gre;
 199
 200     /* L2 classify */
 201     struct
 202     {
 203       u64 pad;
 204       u32 table_index;
 205       u32 opaque_index;
 206       u64 hash;
 207     } l2_classify;
 208
 209     /* IO - worker thread handoff */
 210     struct
 211     {
 212       u32 next_index;
 213     } handoff;
 214
 215     /* vnet policer */
 216     struct
 217     {
 218       u32 pad[8 - VLIB_N_RX_TX - 1];    /* to end of opaque */
 219       u32 index;
 220     } policer;
 221
 222     /* interface output features */
 223     struct
 224     {
 225       u32 flags;
 226       u32 sad_index;
 227     } ipsec;
 228
 229     /* MAP */
 230     struct
 231     {
 232       u16 mtu;
 233     } map;
 234
 235     /* MAP-T */
 236     struct
 237     {
 238       u32 map_domain_index;
 239       struct
 240       {
 241         u32 saddr, daddr;
 242         u16 frag_offset;        //Fragmentation header offset
 243         u16 l4_offset;          //L4 header overall offset
 244         u8 l4_protocol;         //The final protocol number
 245       } v6;                     //Used by ip6_map_t only
 246       u16 checksum_offset;      //L4 checksum overall offset
 247       u16 mtu;                  //Exit MTU
 248     } map_t;
 249
 250     /* IP Fragmentation */
 251     struct
 252     {
 253       u16 header_offset;
 254       u16 mtu;
 255       u8 next_index;
 256       u8 flags;                 //See ip_frag.h
 257     } ip_frag;
 258
 259     /* COP - configurable junk filter(s) */
 260     struct
 261     {
 262       /* Current configuration index. */
 263       u32 current_config_index;
 264     } cop;
 265
 266     /* LISP */
 267     struct
 268     {
 269       /* overlay address family */
 270       u16 overlay_afi;
 271     } lisp;
 272
 273     /* Driver rx feature */
 274     struct
 275     {
 276       u32 saved_next_index;             /**< saved by drivers for short-cut */
 277       u16 buffer_advance;
 278     } device_input_feat;
 279
 280     /* TCP */
 281     struct
 282     {
 283       u32 connection_index;
 284       u32 seq_number;
 285       u32 seq_end;
 286       u32 ack_number;
 287       u8 flags;
 288     } tcp;
 289
 290     u32 unused[6];
 291   };
 292 } vnet_buffer_opaque_t;
 293
 294 /*
 295  * The opaque field of the vlib_buffer_t is intepreted as a
 296  * vnet_buffer_opaque_t. Hence it should be big enough to accommodate one.
 297  */
 298 STATIC_ASSERT (sizeof (vnet_buffer_opaque_t) <= STRUCT_SIZE_OF (vlib_buffer_t,
 299                                                                 opaque),
 300                "VNET buffer meta-data too large for vlib_buffer");
 301
 302 #define vnet_buffer(b) ((vnet_buffer_opaque_t *) (b)->opaque)
 303
 304 /* Full cache line (64 bytes) of additional space */
 305 typedef struct
 306 {
 307   union
 308   {
 309   };
 310 } vnet_buffer_opaque2_t;
 311
 312
 313
 314 #endif /* included_vnet_buffer_h */
 315
 316 /*
 317  * fd.io coding-style-patch-verification: ON
 318  *
 319  * Local Variables:
 320  * eval: (c-set-style "gnu")
 321  * End:
 322  */