src/vnet/ipip/ipip.h

   1 /*
   2  * ipip.h: types/functions for ipip.
   3  *
   4  * Copyright (c) 2018 Cisco and/or its affiliates.
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at:
   8  *
   9  *     http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or aipiped to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  */
  17
  18 #ifndef included_ipip_h
  19 #define included_ipip_h
  20
  21 #include <vnet/adj/adj_types.h>
  22 #include <vnet/ip/ip6_packet.h>
  23 #include <vnet/ip/format.h>
  24 #include <vnet/ip/ip.h>
  25 #include <vnet/vnet.h>
  26
  27 extern vnet_hw_interface_class_t ipip_hw_interface_class;
  28
  29 #define foreach_ipip_error                      \
  30   /* Must be first. */                          \
  31   _(DECAP_PKTS, "packets decapsulated")         \
  32   _(BAD_PROTOCOL, "bad protocol")               \
  33   _(NO_TUNNEL, "no tunnel")
  34
  35 typedef enum
  36 {
  37 #define _(sym, str) IPIP_ERROR_##sym,
  38   foreach_ipip_error
  39 #undef _
  40     IPIP_N_ERROR,
  41 } ipip_error_t;
  42
  43 /**
  44  * @brief IPIP Tunnel key
  45  */
  46 typedef enum
  47 {
  48   IPIP_TRANSPORT_IP4,
  49   IPIP_TRANSPORT_IP6,
  50 } ipip_transport_t;
  51
  52 typedef struct
  53 {
  54   ipip_transport_t transport;
  55   u32 fib_index;
  56   ip46_address_t src;
  57   ip46_address_t dst;
  58 } __attribute__ ((packed)) ipip_tunnel_key_t;
  59
  60 typedef enum
  61 {
  62   IPIP_MODE_P2P = 0,
  63   IPIP_MODE_6RD,
  64 } ipip_mode_t;
  65
  66 /**
  67  * @brief A representation of a IPIP tunnel
  68  */
  69 typedef struct
  70 {
  71   /* Required for pool_get_aligned */
  72   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
  73
  74   ipip_mode_t mode;
  75   ipip_transport_t transport;
  76   ipip_tunnel_key_t *key;
  77   ip46_address_t tunnel_src;
  78   ip46_address_t tunnel_dst;
  79   u32 fib_index;
  80   u32 hw_if_index;
  81   u32 sw_if_index;
  82   u32 dev_instance;             /* Real device instance in tunnel vector */
  83   u32 user_instance;            /* Instance name being shown to user */
  84
  85   union
  86   {
  87     struct
  88     {
  89       fib_node_t node;
  90       fib_node_index_t fib_entry_index;
  91       u32 sibling_index;
  92     } p2p;
  93     struct
  94     {
  95       ip6_address_t ip6_prefix;
  96       ip4_address_t ip4_prefix;
  97       u8 ip6_prefix_len;
  98       u8 ip4_prefix_len;
  99       u8 shift;
 100       bool security_check;
 101     } sixrd;
 102   };
 103 } ipip_tunnel_t;
 104
 105 typedef struct
 106 {
 107   ipip_tunnel_t *tunnels;
 108   uword *tunnel_by_key;
 109   u32 *tunnel_index_by_sw_if_index;
 110   fib_node_type_t fib_node_type;
 111
 112   /* convenience */
 113   vlib_main_t *vlib_main;
 114   vnet_main_t *vnet_main;
 115
 116   /* Record used instances */
 117   uword *instance_used;
 118
 119   bool ip4_protocol_registered;
 120   bool ip6_protocol_registered;
 121 } ipip_main_t;
 122
 123 extern ipip_main_t ipip_main;
 124 extern vlib_node_registration_t ipip4_input_node;
 125 extern vlib_node_registration_t ipip6_input_node;
 126
 127 /*
 128  * sixrd_get_addr_net
 129  */
 130 static_always_inline u32
 131 sixrd_get_addr_net (const ipip_tunnel_t * t, u64 dal)
 132 {
 133   /* 1:1 mode */
 134   if (t->sixrd.ip4_prefix_len == 32)
 135     return (t->sixrd.ip4_prefix.as_u32);
 136
 137   dal = clib_net_to_host_u64 (dal);
 138
 139   /* Grab 32 - ip4_prefix_len bits out of IPv6 address from offset
 140    * ip6_prefix_len */
 141   u32 mask = ~(~0ULL << (32 - t->sixrd.ip4_prefix_len));
 142   u32 ip4 =
 143     clib_net_to_host_u32 (t->sixrd.
 144                           ip4_prefix.as_u32) | ((u32) (dal >> t->sixrd.
 145                                                        shift) & mask);
 146   return clib_host_to_net_u32 (ip4);
 147 }
 148
 149 int ipip_add_tunnel (ipip_transport_t transport, u32 instance,
 150                      ip46_address_t * src, ip46_address_t * dst,
 151                      u32 fib_index, u32 * sw_if_indexp);
 152 int ipip_del_tunnel (u32 sw_if_index);
 153 int sixrd_add_tunnel (ip6_address_t * ip6_prefix, u8 ip6_prefix_len,
 154                       ip4_address_t * ip4_prefix, u8 ip4_prefix_len,
 155                       ip4_address_t * ip4_src, bool security_check,
 156                       u32 fib_index, u32 * sw_if_index);
 157 int sixrd_del_tunnel (u32 sw_if_index);
 158 void ipip_tunnel_db_add (ipip_tunnel_t * t, ipip_tunnel_key_t * key);
 159 void ipip_tunnel_db_remove (ipip_tunnel_t * t);
 160 ipip_tunnel_t *ipip_tunnel_db_find (ipip_tunnel_key_t * key);
 161 ipip_tunnel_t *ipip_tunnel_db_find_by_sw_if_index (u32 sw_if_index);
 162
 163 #endif
 164
 165 /*
 166  * fd.io coding-style-patch-verification: ON
 167  *
 168  * Local Variables:
 169  * eval: (c-set-style "gnu")
 170  * End:
 171  */