FD.io VPP  v19.04.2-12-g66b1689
Vector Packet Processing
ipip.h
Go to the documentation of this file.
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 
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,
40 #undef _
42 } ipip_error_t;
43 
44 /**
45  * @brief IPIP Tunnel key
46  */
47 typedef enum
48 {
52 
53 typedef struct
54 {
55  ip46_address_t src;
56  ip46_address_t dst;
57  ipip_transport_t transport;
59 } __attribute__ ((packed)) ipip_tunnel_key_t;
60 
61 typedef enum
62 {
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;
78  ip46_address_t tunnel_src;
79  ip46_address_t tunnel_dst;
83  u32 dev_instance; /* Real device instance in tunnel vector */
84  u32 user_instance; /* Instance name being shown to user */
86 
87  struct
88  {
96  } sixrd;
98 
99 typedef struct
100 {
104 
105  /* convenience */
108 
109  /* Record used instances */
111 
114 } ipip_main_t;
115 
116 extern ipip_main_t ipip_main;
119 
120 /*
121  * sixrd_get_addr_net
122  */
125 {
126  /* 1:1 mode */
127  if (t->sixrd.ip4_prefix_len == 32)
128  return (t->sixrd.ip4_prefix.as_u32);
129 
130  dal = clib_net_to_host_u64 (dal);
131 
132  /* Grab 32 - ip4_prefix_len bits out of IPv6 address from offset
133  * ip6_prefix_len */
134  u32 mask = ~(~0ULL << (32 - t->sixrd.ip4_prefix_len));
135  u32 ip4 =
136  clib_net_to_host_u32 (t->sixrd.
137  ip4_prefix.as_u32) | ((u32) (dal >> t->sixrd.
138  shift) & mask);
139  return clib_host_to_net_u32 (ip4);
140 }
141 
142 int ipip_add_tunnel (ipip_transport_t transport, u32 instance,
143  ip46_address_t * src, ip46_address_t * dst,
144  u32 fib_index, u8 tc_tos, u32 * sw_if_indexp);
145 int ipip_del_tunnel (u32 sw_if_index);
146 int sixrd_add_tunnel (ip6_address_t * ip6_prefix, u8 ip6_prefix_len,
147  ip4_address_t * ip4_prefix, u8 ip4_prefix_len,
148  ip4_address_t * ip4_src, bool security_check,
149  u32 ip4_fib_index, u32 ip6_fib_index,
150  u32 * sw_if_index);
151 int sixrd_del_tunnel (u32 sw_if_index);
156 
157 #endif
158 
159 /*
160  * fd.io coding-style-patch-verification: ON
161  *
162  * Local Variables:
163  * eval: (c-set-style "gnu")
164  * End:
165  */
int sixrd_add_tunnel(ip6_address_t *ip6_prefix, u8 ip6_prefix_len, ip4_address_t *ip4_prefix, u8 ip4_prefix_len, ip4_address_t *ip4_src, bool security_check, u32 ip4_fib_index, u32 ip6_fib_index, u32 *sw_if_index)
Definition: sixrd.c:272
#define CLIB_CACHE_LINE_ALIGN_MARK(mark)
Definition: cache.h:60
ipip_mode_t
Definition: ipip.h:61
A representation of a IPIP tunnel.
Definition: ipip.h:70
ip46_address_t tunnel_src
Definition: ipip.h:78
unsigned long u64
Definition: types.h:89
vnet_hw_interface_class_t ipip_hw_interface_class
u8 tc_tos
Definition: ipip.h:85
ip4_address_t ip4_prefix
Definition: ipip.h:90
u32 hw_if_index
Definition: ipip.h:81
bool ip4_protocol_registered
Definition: ipip.h:112
unsigned char u8
Definition: types.h:56
static_always_inline u32 sixrd_get_addr_net(const ipip_tunnel_t *t, u64 dal)
Definition: ipip.h:124
#define static_always_inline
Definition: clib.h:99
ip46_address_t src
Definition: ipip.h:55
u32 user_instance
Definition: ipip.h:84
ipip_tunnel_t * ipip_tunnel_db_find_by_sw_if_index(u32 sw_if_index)
Definition: ipip.c:335
ip46_address_t dst
Definition: ipip.h:56
u32 * tunnel_index_by_sw_if_index
Definition: ipip.h:103
unsigned int u32
Definition: types.h:88
ipip_error_t
Definition: ipip.h:36
ipip_transport_t transport
Definition: ipip.h:57
#define foreach_ipip_error
Definition: ipip.h:29
ipip_tunnel_t * ipip_tunnel_db_find(ipip_tunnel_key_t *key)
Definition: ipip.c:323
u32 ip6_fib_index
Definition: ipip.h:95
ip6_address_t ip6_prefix
Definition: ipip.h:89
ipip_tunnel_t * tunnels
Definition: ipip.h:101
int sixrd_del_tunnel(u32 sw_if_index)
Definition: sixrd.c:377
u8 shift
Definition: ipip.h:93
int ipip_add_tunnel(ipip_transport_t transport, u32 instance, ip46_address_t *src, ip46_address_t *dst, u32 fib_index, u8 tc_tos, u32 *sw_if_indexp)
Definition: ipip.c:367
struct ipip_tunnel_t::@245 sixrd
ipip_tunnel_key_t * key
Definition: ipip.h:77
ipip_transport_t
IPIP Tunnel key.
Definition: ipip.h:47
u32 fib_index
Definition: ipip.h:58
vlib_node_registration_t ipip4_input_node
(constructor) VLIB_REGISTER_NODE (ipip4_input_node)
Definition: node.c:238
u32 fib_index
Definition: ipip.h:80
u8 ip6_prefix_len
Definition: ipip.h:91
ipip_transport_t transport
Definition: ipip.h:76
bool security_check
Definition: ipip.h:94
uword * tunnel_by_key
Definition: ipip.h:102
u8 ip4_prefix_len
Definition: ipip.h:92
u32 sw_if_index
Definition: ipip.h:82
struct _vlib_node_registration vlib_node_registration_t
vlib_node_registration_t ipip6_input_node
(constructor) VLIB_REGISTER_NODE (ipip6_input_node)
Definition: node.c:254
int ipip_del_tunnel(u32 sw_if_index)
Definition: ipip.c:459
vnet_main_t * vnet_main
Definition: ipip.h:107
struct _vnet_hw_interface_class vnet_hw_interface_class_t
bool ip6_protocol_registered
Definition: ipip.h:113
u64 uword
Definition: types.h:112
ipip_mode_t mode
Definition: ipip.h:75
void ipip_tunnel_db_add(ipip_tunnel_t *t, ipip_tunnel_key_t *key)
Definition: ipip.c:347
u32 dev_instance
Definition: ipip.h:83
ip46_address_t tunnel_dst
Definition: ipip.h:79
vlib_main_t * vlib_main
Definition: ipip.h:106
ipip_main_t ipip_main
Definition: ipip.c:29
uword * instance_used
Definition: ipip.h:110
void ipip_tunnel_db_remove(ipip_tunnel_t *t)
Definition: ipip.c:357