FD.io VPP  v18.07-34-g55fbdb9
Vector Packet Processing
ipip_api.c
Go to the documentation of this file.
1 /*
2  * ipip_api.c - ipip api
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 agreed 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 #include <vlibmemory/api.h>
19 #include <vnet/api_errno.h>
20 #include <vnet/fib/fib_table.h>
21 #include <vnet/interface.h>
22 #include <vnet/ipip/ipip.h>
23 #include <vnet/vnet.h>
24 #include <vnet/vnet_msg_enum.h>
25 
26 #define vl_typedefs /* define message structures */
27 #include <vnet/vnet_all_api_h.h>
28 #undef vl_typedefs
29 
30 #define vl_endianfun /* define message structures */
31 #include <vnet/vnet_all_api_h.h>
32 #undef vl_endianfun
33 
34 /* instantiate all the print functions we know about */
35 #define vl_print(handle, ...) vlib_cli_output(handle, __VA_ARGS__)
36 #define vl_printfun
37 #include <vnet/vnet_all_api_h.h>
38 #undef vl_printfun
39 
41 
42 #define foreach_vpe_api_msg \
43  _(IPIP_ADD_TUNNEL, ipip_add_tunnel) \
44  _(IPIP_DEL_TUNNEL, ipip_del_tunnel) \
45  _(IPIP_6RD_ADD_TUNNEL, ipip_6rd_add_tunnel) \
46  _(IPIP_6RD_DEL_TUNNEL, ipip_6rd_del_tunnel) \
47  _(IPIP_TUNNEL_DUMP, ipip_tunnel_dump)
48 
49 static void
51 {
53  int rv = 0;
54  u32 fib_index, sw_if_index = ~0;
55  ip46_address_t src = ip46_address_initializer, dst =
57 
58  /* ip addresses sent in network byte order */
59  if (mp->is_ipv6)
60  {
61  clib_memcpy (&src.ip6, mp->src_address, 16);
62  clib_memcpy (&dst.ip6, mp->dst_address, 16);
63  }
64  else
65  {
66  clib_memcpy (&src.ip4, mp->src_address, 4);
67  clib_memcpy (&dst.ip4, mp->dst_address, 4);
68  }
69 
70  fib_index =
71  fib_table_find (fib_ip_proto (mp->is_ipv6), ntohl (mp->table_id));
72 
73  if (~0 == fib_index)
74  {
75  rv = VNET_API_ERROR_NO_SUCH_FIB;
76  }
77  else
78  {
79  rv = ipip_add_tunnel ((mp->is_ipv6 ?
82  ntohl (mp->instance), &src, &dst,
83  fib_index, mp->tc_tos, &sw_if_index);
84  }
85 
86  /* *INDENT-OFF* */
87  REPLY_MACRO2(VL_API_IPIP_ADD_TUNNEL_REPLY,
88  ({
89  rmp->sw_if_index = ntohl(sw_if_index);
90  }));
91  /* *INDENT-ON* */
92 }
93 
94 static void
96 {
97  vl_api_ipip_del_tunnel_reply_t *rmp;
98 
99  int rv = ipip_del_tunnel (ntohl (mp->sw_if_index));
100 
101  REPLY_MACRO (VL_API_IPIP_DEL_TUNNEL_REPLY);
102 }
103 
104 static void
106  vl_api_registration_t * reg, u32 context)
107 {
109  bool is_ipv6 = t->transport == IPIP_TRANSPORT_IP6 ? true : false;
110  fib_table_t *ft;
111 
112  rmp = vl_msg_api_alloc (sizeof (*rmp));
113  memset (rmp, 0, sizeof (*rmp));
114  rmp->_vl_msg_id = htons (VL_API_IPIP_TUNNEL_DETAILS);
115  if (is_ipv6)
116  {
117  clib_memcpy (rmp->src_address, &t->tunnel_src.ip6.as_u8, 16);
118  clib_memcpy (rmp->dst_address, &t->tunnel_dst.ip6.as_u8, 16);
120  rmp->fib_index = htonl (ft->ft_table_id);
121  }
122  else
123  {
124  clib_memcpy (rmp->src_address, &t->tunnel_src.ip4.as_u8, 4);
125  clib_memcpy (rmp->dst_address, &t->tunnel_dst.ip4.as_u8, 4);
127  rmp->fib_index = htonl (ft->ft_table_id);
128  }
129  rmp->instance = htonl (t->user_instance);
130  rmp->sw_if_index = htonl (t->sw_if_index);
131  rmp->context = context;
132  rmp->is_ipv6 = is_ipv6;
133 
134  vl_api_send_msg (reg, (u8 *) rmp);
135 }
136 
137 static void
139 {
141  ipip_main_t *gm = &ipip_main;
142  ipip_tunnel_t *t;
143  u32 sw_if_index;
144 
146  if (!reg)
147  return;
148 
149  sw_if_index = ntohl (mp->sw_if_index);
150 
151  if (sw_if_index == ~0)
152  {
153  /* *INDENT-OFF* */
154  pool_foreach(t, gm->tunnels,
155  ({ send_ipip_tunnel_details(t, reg, mp->context); }));
156  /* *INDENT-ON* */
157  }
158  else
159  {
160  t = ipip_tunnel_db_find_by_sw_if_index (sw_if_index);
161  if (t)
162  send_ipip_tunnel_details (t, reg, mp->context);
163  }
164 }
165 
166 static void
168 {
170  u32 sixrd_tunnel_index, ip4_fib_index, ip6_fib_index;
171  int rv;
172 
173  ip4_fib_index = fib_table_find (FIB_PROTOCOL_IP4, ntohl (mp->ip4_table_id));
174  ip6_fib_index = fib_table_find (FIB_PROTOCOL_IP6, ntohl (mp->ip6_table_id));
175 
176  if (~0 == ip4_fib_index || ~0 == ip6_fib_index)
177 
178  {
179  rv = VNET_API_ERROR_NO_SUCH_FIB;
180  }
181  else
182  {
183  rv = sixrd_add_tunnel ((ip6_address_t *) & mp->ip6_prefix,
184  mp->ip6_prefix_len,
185  (ip4_address_t *) & mp->ip4_prefix,
186  mp->ip4_prefix_len,
187  (ip4_address_t *) & mp->ip4_src,
188  mp->security_check,
189  ip4_fib_index, ip6_fib_index,
190  &sixrd_tunnel_index);
191  }
192 
193  /* *INDENT-OFF* */
194  REPLY_MACRO2 (VL_API_IPIP_6RD_ADD_TUNNEL_REPLY,
195  ({
196  rmp->sw_if_index = htonl (sixrd_tunnel_index);
197  }));
198  /* *INDENT-ON* */
199 }
200 
201 static void
203 {
204  vl_api_ipip_6rd_del_tunnel_reply_t *rmp;
205 
206  int rv = sixrd_del_tunnel (ntohl (mp->sw_if_index));
207 
208  REPLY_MACRO (VL_API_IPIP_6RD_DEL_TUNNEL_REPLY);
209 }
210 
211 /*
212  * ipip_api_hookup
213  * Add vpe's API message handlers to the table.
214  * vlib has alread mapped shared memory and
215  * added the client registration handlers.
216  * See .../vlib-api/vlibmemory/memclnt_vlib.c:memclnt_process()
217  */
218 #define vl_msg_name_crc_list
219 #include <vnet/vnet_all_api_h.h>
220 #undef vl_msg_name_crc_list
221 
222 static void
224 {
225 #define _(id, n, crc) vl_msg_api_add_msg_name_crc(am, #n "_" #crc, id);
226  foreach_vl_msg_name_crc_ipip;
227 #undef _
228 }
229 
230 static clib_error_t *
232 {
233  api_main_t *am = &api_main;
234 
235 #define _(N, n) \
236  vl_msg_api_set_handlers(VL_API_##N, #n, vl_api_##n##_t_handler, \
237  vl_noop_handler, vl_api_##n##_t_endian, \
238  vl_api_##n##_t_print, sizeof(vl_api_##n##_t), 1);
240 #undef _
241 
242  /*
243  * Set up the (msg_name, crc, message-id) table
244  */
246 
247  return 0;
248 }
249 
251 
252 /*
253  * fd.io coding-style-patch-verification: ON
254  *
255  * Local Variables:
256  * eval: (c-set-style "gnu")
257  * End:
258  */
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:282
Create an IPv4 over IPv6 automatic tunnel (6RD)
Definition: ipip.api:89
A representation of a IPIP tunnel.
Definition: ipip.h:69
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:463
ip46_address_t tunnel_src
Definition: ipip.h:77
#define REPLY_MACRO2(t, body)
static void vl_api_send_msg(vl_api_registration_t *rp, u8 *elem)
Definition: api.h:34
static void vl_api_ipip_6rd_add_tunnel_t_handler(vl_api_ipip_6rd_add_tunnel_t *mp)
Definition: ipip_api.c:167
static void vl_api_ipip_6rd_del_tunnel_t_handler(vl_api_ipip_6rd_del_tunnel_t *mp)
Definition: ipip_api.c:202
void * vl_msg_api_alloc(int nbytes)
unsigned char u8
Definition: types.h:56
Delete an IP{v4,v6} over IP{v4,v6} tunnel.
Definition: ipip.api:79
static clib_error_t * ipip_api_hookup(vlib_main_t *vm)
Definition: ipip_api.c:231
#define pool_foreach(VAR, POOL, BODY)
Iterate through pool.
Definition: pool.h:443
u32 user_instance
Definition: ipip.h:83
Create an IP{v4,v6} over IP{v4,v6} tunnel.
Definition: ipip.api:56
unsigned int u32
Definition: types.h:88
u32 fib_table_find(fib_protocol_t proto, u32 table_id)
Get the index of the FIB for a Table-ID.
Definition: fib_table.c:1056
static void send_ipip_tunnel_details(ipip_tunnel_t *t, vl_api_registration_t *reg, u32 context)
Definition: ipip_api.c:105
List all IPIP tunnels.
Definition: ipip.api:125
static void vl_api_ipip_tunnel_dump_t_handler(vl_api_ipip_tunnel_dump_t *mp)
Definition: ipip_api.c:138
ipip_tunnel_t * ipip_tunnel_db_find_by_sw_if_index(u32 sw_if_index)
Definition: ipip.c:355
ipip_tunnel_t * tunnels
Definition: ipip.h:109
#define REPLY_MACRO(t)
int sixrd_del_tunnel(u32 sw_if_index)
Definition: sixrd.c:387
#define ip46_address_initializer
Definition: ip6_packet.h:89
API main structure, used by both vpp and binary API clients.
Definition: api_common.h:201
An API client registration, only in vpp/vlib.
Definition: api_common.h:44
ipip_main_t ipip_main
Definition: ipip.c:28
#define foreach_vpe_api_msg
Definition: ipip_api.c:42
u32 ft_table_id
Table ID (hash key) for this FIB.
Definition: fib_table.h:89
vlib_main_t * vm
Definition: buffer.c:294
#define clib_memcpy(a, b, c)
Definition: string.h:75
static void vl_api_ipip_del_tunnel_t_handler(vl_api_ipip_del_tunnel_t *mp)
Definition: ipip_api.c:95
static vl_api_registration_t * vl_api_client_index_to_registration(u32 index)
Definition: api.h:56
u32 fib_index
Definition: ipip.h:79
ipip_transport_t transport
Definition: ipip.h:75
static void vl_api_ipip_add_tunnel_t_handler(vl_api_ipip_add_tunnel_t *mp)
Definition: ipip_api.c:50
u32 sw_if_index
Definition: ipip.h:81
static fib_protocol_t fib_ip_proto(bool is_ip6)
Convert from boolean is_ip6 to FIB protocol.
Definition: fib_types.h:80
static void setup_message_id_table(api_main_t *am)
Definition: ipip_api.c:223
fib_table_t * fib_table_get(fib_node_index_t index, fib_protocol_t proto)
Get a pointer to a FIB table.
Definition: fib_table.c:27
int ipip_del_tunnel(u32 sw_if_index)
Definition: ipip.c:562
VLIB_API_INIT_FUNCTION(ipip_api_hookup)
ip46_address_t tunnel_dst
Definition: ipip.h:78
api_main_t api_main
Definition: api_shared.c:35
Delete an IPv4 over IPv6 automatic tunnel (6RD)
Definition: ipip.api:115
A protocol Independent FIB table.
Definition: fib_table.h:69