src/vnet/ip/ip_frag.h

   1 /*---------------------------------------------------------------------------
   2  * Copyright (c) 2009-2014 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 /*
  17  * IPv4 and IPv6 Fragmentation Nodes
  18  *
  19  * A packet sent to those nodes require the following
  20  * buffer attributes to be set:
  21  * ip_frag.header_offset :
  22  *     Where to find the IPv4 (or IPv6) header in the packet. Previous
  23  *     bytes are left untouched and copied in every fragment. The fragments
  24  *     are then appended. This option is used for fragmented packets
  25  *     that are encapsulated.
  26  * ip_frag.mtu :
  27  *     Maximum size of IP packets, header included, but ignoring
  28  *     the 'ip_frag.header_offset' copied bytes.
  29  * ip_frag.next_index :
  30  *     One of ip_frag_next_t, indicating to which exit node the fragments
  31  *     should be sent to.
  32  *
  33  */
  34
  35 #ifndef IP_FRAG_H
  36 #define IP_FRAG_H
  37
  38 #include <vnet/vnet.h>
  39
  40 #define IP_FRAG_FLAG_IP4_HEADER 0x01    //Encapsulating IPv4 header
  41 #define IP_FRAG_FLAG_IP6_HEADER 0x02    //Encapsulating IPv6 header
  42
  43 #define IP4_FRAG_NODE_NAME "ip4-frag"
  44 #define IP6_FRAG_NODE_NAME "ip6-frag"
  45
  46 extern vlib_node_registration_t ip4_frag_node;
  47 extern vlib_node_registration_t ip6_frag_node;
  48
  49 typedef enum
  50 {
  51   IP4_FRAG_NEXT_IP4_REWRITE,
  52   IP4_FRAG_NEXT_IP4_LOOKUP,
  53   IP4_FRAG_NEXT_IP6_LOOKUP,
  54   IP4_FRAG_NEXT_ICMP_ERROR,
  55   IP4_FRAG_NEXT_DROP,
  56   IP4_FRAG_N_NEXT
  57 } ip4_frag_next_t;
  58
  59 typedef enum
  60 {
  61   IP6_FRAG_NEXT_IP4_LOOKUP,
  62   IP6_FRAG_NEXT_IP6_LOOKUP,
  63   IP6_FRAG_NEXT_IP6_REWRITE,
  64   IP6_FRAG_NEXT_DROP,
  65   IP6_FRAG_N_NEXT
  66 } ip6_frag_next_t;
  67
  68 #define foreach_ip_frag_error                           \
  69   /* Must be first. */                                  \
  70  _(NONE, "packet fragmented")                           \
  71  _(SMALL_PACKET, "packet smaller than MTU")             \
  72  _(FRAGMENT_SENT, "number of sent fragments")           \
  73  _(CANT_FRAGMENT_HEADER, "can't fragment header")       \
  74  _(DONT_FRAGMENT_SET, "can't fragment this packet")     \
  75  _(MALFORMED, "malformed packet")                       \
  76  _(MEMORY, "could not allocate buffer")                 \
  77  _(UNKNOWN, "unknown error")
  78
  79 typedef enum
  80 {
  81 #define _(sym,str) IP_FRAG_ERROR_##sym,
  82   foreach_ip_frag_error
  83 #undef _
  84     IP_FRAG_N_ERROR,
  85 } ip_frag_error_t;
  86
  87 void ip_frag_set_vnet_buffer (vlib_buffer_t * b, u16 mtu,
  88                               u8 next_index, u8 flags);
  89 void
  90 ip4_frag_do_fragment (vlib_main_t * vm, u32 pi, u32 ** buffer,
  91                       ip_frag_error_t * error);
  92 void
  93 ip6_frag_do_fragment (vlib_main_t * vm, u32 pi, u32 ** buffer,
  94                       ip_frag_error_t * error);
  95 #endif /* ifndef IP_FRAG_H */
  96
  97 /*
  98  * fd.io coding-style-patch-verification: ON
  99  *
 100  * Local Variables:
 101  * eval: (c-set-style "gnu")
 102  * End:
 103  */