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/tunnel/tunnel.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   _(FRAGMENTED_PACKET, "fragmented outer packet")
  35
  36 typedef enum
  37 {
  38 #define _(sym, str) IPIP_ERROR_##sym,
  39   foreach_ipip_error
  40 #undef _
  41     IPIP_N_ERROR,
  42 } ipip_error_t;
  43
  44 /**
  45  * @brief IPIP Tunnel key
  46  */
  47 typedef enum
  48 {
  49   IPIP_TRANSPORT_IP4,
  50   IPIP_TRANSPORT_IP6,
  51 } ipip_transport_t;
  52
  53 typedef struct
  54 {
  55   ip46_address_t src;
  56   ip46_address_t dst;
  57   ipip_transport_t transport;
  58   u32 fib_index;
  59 } __attribute__ ((packed)) ipip_tunnel_key_t;
  60
  61 typedef enum
  62 {
  63   IPIP_MODE_P2P = 0,
  64   IPIP_MODE_6RD,
  65 } ipip_mode_t;
  66
  67 /**
  68  * @brief A representation of a IPIP tunnel
  69  */
  70 typedef struct
  71 {
  72   /* Required for pool_get_aligned */
  73   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
  74
  75   ipip_mode_t mode;
  76   ipip_transport_t transport;
  77   ipip_tunnel_key_t *key;
  78   ip46_address_t tunnel_src;
  79   ip46_address_t tunnel_dst;
  80   u32 fib_index;
  81   u32 hw_if_index;
  82   u32 sw_if_index;
  83   u32 dev_instance;             /* Real device instance in tunnel vector */
  84   u32 user_instance;            /* Instance name being shown to user */
  85   tunnel_encap_decap_flags_t flags;
  86   ip_dscp_t dscp;
  87
  88   struct
  89   {
  90     ip6_address_t ip6_prefix;
  91     ip4_address_t ip4_prefix;
  92     u8 ip6_prefix_len;
  93     u8 ip4_prefix_len;
  94     u8 shift;
  95     bool security_check;
  96     u32 ip6_fib_index;
  97   } sixrd;
  98 } ipip_tunnel_t;
  99
 100 typedef struct
 101 {
 102   ipip_tunnel_t *tunnels;
 103   uword *tunnel_by_key;
 104   u32 *tunnel_index_by_sw_if_index;
 105
 106   /* convenience */
 107   vlib_main_t *vlib_main;
 108   vnet_main_t *vnet_main;
 109
 110   /* Record used instances */
 111   uword *instance_used;
 112
 113   bool ip4_protocol_registered;
 114   bool ip6_protocol_registered;
 115
 116   u16 msg_id_base;
 117 } ipip_main_t;
 118
 119 extern ipip_main_t ipip_main;
 120 extern vlib_node_registration_t ipip4_input_node;
 121 extern vlib_node_registration_t ipip6_input_node;
 122
 123 /*
 124  * sixrd_get_addr_net
 125  */
 126 static_always_inline u32
 127 sixrd_get_addr_net (const ipip_tunnel_t * t, u64 dal)
 128 {
 129   /* 1:1 mode */
 130   if (t->sixrd.ip4_prefix_len == 32)
 131     return (t->sixrd.ip4_prefix.as_u32);
 132
 133   dal = clib_net_to_host_u64 (dal);
 134
 135   /* Grab 32 - ip4_prefix_len bits out of IPv6 address from offset
 136    * ip6_prefix_len */
 137   u32 mask = ~(~0ULL << (32 - t->sixrd.ip4_prefix_len));
 138   u32 ip4 =
 139     clib_net_to_host_u32 (t->sixrd.
 140                           ip4_prefix.as_u32) | ((u32) (dal >> t->sixrd.
 141                                                        shift) & mask);
 142   return clib_host_to_net_u32 (ip4);
 143 }
 144
 145 int ipip_add_tunnel (ipip_transport_t transport, u32 instance,
 146                      ip46_address_t * src, ip46_address_t * dst,
 147                      u32 fib_index, tunnel_encap_decap_flags_t flags,
 148                      ip_dscp_t dscp, u32 * sw_if_indexp);
 149 int ipip_del_tunnel (u32 sw_if_index);
 150 int sixrd_add_tunnel (ip6_address_t * ip6_prefix, u8 ip6_prefix_len,
 151                       ip4_address_t * ip4_prefix, u8 ip4_prefix_len,
 152                       ip4_address_t * ip4_src, bool security_check,
 153                       u32 ip4_fib_index, u32 ip6_fib_index,
 154                       u32 * sw_if_index);
 155 int sixrd_del_tunnel (u32 sw_if_index);
 156 void ipip_tunnel_db_add (ipip_tunnel_t * t, ipip_tunnel_key_t * key);
 157 void ipip_tunnel_db_remove (ipip_tunnel_t * t);
 158 ipip_tunnel_t *ipip_tunnel_db_find (ipip_tunnel_key_t * key);
 159 ipip_tunnel_t *ipip_tunnel_db_find_by_sw_if_index (u32 sw_if_index);
 160
 161 #endif
 162
 163 /*
 164  * fd.io coding-style-patch-verification: ON
 165  *
 166  * Local Variables:
 167  * eval: (c-set-style "gnu")
 168  * End:
 169  */