2 * ipip.h: types/functions for ipip.
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:
9 * http://www.apache.org/licenses/LICENSE-2.0
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.
18 #ifndef included_ipip_h
19 #define included_ipip_h
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>
27 extern vnet_hw_interface_class_t ipip_hw_interface_class;
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")
38 #define _(sym, str) IPIP_ERROR_##sym,
45 * @brief IPIP Tunnel key
57 ipip_transport_t transport;
59 } __attribute__ ((packed)) ipip_tunnel_key_t;
68 * @brief A representation of a IPIP tunnel
72 /* Required for pool_get_aligned */
73 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
76 ipip_transport_t transport;
77 ipip_tunnel_key_t *key;
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 */
89 ip6_address_t ip6_prefix;
90 ip4_address_t ip4_prefix;
101 ipip_tunnel_t *tunnels;
102 uword *tunnel_by_key;
103 u32 *tunnel_index_by_sw_if_index;
106 vlib_main_t *vlib_main;
107 vnet_main_t *vnet_main;
109 /* Record used instances */
110 uword *instance_used;
112 bool ip4_protocol_registered;
113 bool ip6_protocol_registered;
118 extern ipip_main_t ipip_main;
119 extern vlib_node_registration_t ipip4_input_node;
120 extern vlib_node_registration_t ipip6_input_node;
125 static_always_inline u32
126 sixrd_get_addr_net (const ipip_tunnel_t * t, u64 dal)
129 if (t->sixrd.ip4_prefix_len == 32)
130 return (t->sixrd.ip4_prefix.as_u32);
132 dal = clib_net_to_host_u64 (dal);
134 /* Grab 32 - ip4_prefix_len bits out of IPv6 address from offset
136 u32 mask = ~(~0ULL << (32 - t->sixrd.ip4_prefix_len));
138 clib_net_to_host_u32 (t->sixrd.
139 ip4_prefix.as_u32) | ((u32) (dal >> t->sixrd.
141 return clib_host_to_net_u32 (ip4);
144 int ipip_add_tunnel (ipip_transport_t transport, u32 instance,
145 ip46_address_t * src, ip46_address_t * dst,
146 u32 fib_index, u8 tc_tos, u32 * sw_if_indexp);
147 int ipip_del_tunnel (u32 sw_if_index);
148 int sixrd_add_tunnel (ip6_address_t * ip6_prefix, u8 ip6_prefix_len,
149 ip4_address_t * ip4_prefix, u8 ip4_prefix_len,
150 ip4_address_t * ip4_src, bool security_check,
151 u32 ip4_fib_index, u32 ip6_fib_index,
153 int sixrd_del_tunnel (u32 sw_if_index);
154 void ipip_tunnel_db_add (ipip_tunnel_t * t, ipip_tunnel_key_t * key);
155 void ipip_tunnel_db_remove (ipip_tunnel_t * t);
156 ipip_tunnel_t *ipip_tunnel_db_find (ipip_tunnel_key_t * key);
157 ipip_tunnel_t *ipip_tunnel_db_find_by_sw_if_index (u32 sw_if_index);
162 * fd.io coding-style-patch-verification: ON
165 * eval: (c-set-style "gnu")