blob: ffe0b83d7f45fd3d98821ad96cdd38908ab11f9d [file] [log] [blame]
Alexander Popovsky (apopovsk)4a7e58b2016-10-05 22:31:23 -07001/*
2 * Copyright (c) 2016 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
6 *
7 * http://www.apache.org/licenses/LICENSE-2.0
8 *
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
14 */
15
16/**
17 * @file
18 * @brief Local TCP/IP stack punt infrastructure.
19 *
Ole Troanf7a55ad2017-05-16 14:59:29 +020020 * Provides a set of VPP nodes together with the relevant APIs and CLI
Alexander Popovsky (apopovsk)4a7e58b2016-10-05 22:31:23 -070021 * commands in order to adjust and dispatch packets from the VPP data plane
22 * to the local TCP/IP stack
23 */
Ole Troanf7a55ad2017-05-16 14:59:29 +020024
25#include <vnet/ip/ip.h>
Alexander Popovsky (apopovsk)4a7e58b2016-10-05 22:31:23 -070026#include <vlib/vlib.h>
Dave Barach68b0fb02017-02-28 15:15:56 -050027#include <vnet/udp/udp.h>
Pierre Pfister7fe51f32017-09-20 08:48:36 +020028#include <vnet/tcp/tcp.h>
Alexander Popovsky (apopovsk)4a7e58b2016-10-05 22:31:23 -070029#include <vnet/ip/punt.h>
Ole Troanf7a55ad2017-05-16 14:59:29 +020030#include <vlib/unix/unix.h>
Alexander Popovsky (apopovsk)4a7e58b2016-10-05 22:31:23 -070031
Ole Troanf7a55ad2017-05-16 14:59:29 +020032#include <stdio.h>
33#include <unistd.h>
34#include <sys/socket.h>
Marco Varlese22349832017-09-08 10:40:34 +020035#include <sys/uio.h>
Ole Troanf7a55ad2017-05-16 14:59:29 +020036#include <stdlib.h>
Ole Troanf7a55ad2017-05-16 14:59:29 +020037
Ole Troanf7a55ad2017-05-16 14:59:29 +020038punt_main_t punt_main;
39
40char *
41vnet_punt_get_server_pathname (void)
42{
43 punt_main_t *pm = &punt_main;
44 return pm->sun_path;
45}
Alexander Popovsky (apopovsk)4a7e58b2016-10-05 22:31:23 -070046
Ole Troanf7a55ad2017-05-16 14:59:29 +020047static void
Neale Ranns50f0ac02019-05-15 02:13:37 -070048punt_client_l4_db_add (ip_address_family_t af, u16 port, u32 index)
Ole Troanf7a55ad2017-05-16 14:59:29 +020049{
50 punt_main_t *pm = &punt_main;
Ole Troanf7a55ad2017-05-16 14:59:29 +020051
Neale Ranns50f0ac02019-05-15 02:13:37 -070052 pm->db.clients_by_l4_port = hash_set (pm->db.clients_by_l4_port,
53 punt_client_l4_mk_key (af, port),
54 index);
Ole Troanf7a55ad2017-05-16 14:59:29 +020055}
56
Neale Ranns50f0ac02019-05-15 02:13:37 -070057static u32
58punt_client_l4_db_remove (ip_address_family_t af, u16 port)
Ole Troanf7a55ad2017-05-16 14:59:29 +020059{
Neale Ranns50f0ac02019-05-15 02:13:37 -070060 punt_main_t *pm = &punt_main;
61 u32 key, index = ~0;
62 uword *p;
63
64 key = punt_client_l4_mk_key (af, port);
65 p = hash_get (pm->db.clients_by_l4_port, key);
66
67 if (p)
68 index = p[0];
69
70 hash_unset (pm->db.clients_by_l4_port, key);
71
72 return (index);
73}
74
75static void
Neale Rannsb538dd82019-05-21 06:54:54 -070076punt_client_ip_proto_db_add (ip_address_family_t af,
77 ip_protocol_t proto, u32 index)
78{
79 punt_main_t *pm = &punt_main;
80
81 pm->db.clients_by_ip_proto = hash_set (pm->db.clients_by_ip_proto,
82 punt_client_ip_proto_mk_key (af,
83 proto),
84 index);
85}
86
87static u32
88punt_client_ip_proto_db_remove (ip_address_family_t af, ip_protocol_t proto)
89{
90 punt_main_t *pm = &punt_main;
91 u32 key, index = ~0;
92 uword *p;
93
94 key = punt_client_ip_proto_mk_key (af, proto);
95 p = hash_get (pm->db.clients_by_ip_proto, key);
96
97 if (p)
98 index = p[0];
99
100 hash_unset (pm->db.clients_by_ip_proto, key);
101
102 return (index);
103}
104
105static void
Neale Ranns50f0ac02019-05-15 02:13:37 -0700106punt_client_exception_db_add (vlib_punt_reason_t reason, u32 pci)
107{
108 punt_main_t *pm = &punt_main;
109
110 vec_validate_init_empty (pm->db.clients_by_exception, reason, ~0);
111
112 pm->db.clients_by_exception[reason] = pci;
113}
114
115static u32
116punt_client_exception_db_remove (vlib_punt_reason_t reason)
117{
118 punt_main_t *pm = &punt_main;
119 u32 pci = ~0;
120
121 if (punt_client_exception_get (reason))
122 {
123 pci = pm->db.clients_by_exception[reason];
124 pm->db.clients_by_exception[reason] = ~0;
125 }
126
127 return pci;
128}
Ole Troanf7a55ad2017-05-16 14:59:29 +0200129
130static clib_error_t *
Damjan Marion56dd5432017-09-08 19:52:02 +0200131punt_socket_read_ready (clib_file_t * uf)
Ole Troanf7a55ad2017-05-16 14:59:29 +0200132{
133 vlib_main_t *vm = vlib_get_main ();
134 punt_main_t *pm = &punt_main;
135
136 /** Schedule the rx node */
137 vlib_node_set_interrupt_pending (vm, punt_socket_rx_node.index);
138 vec_add1 (pm->ready_fds, uf->file_descriptor);
139
140 return 0;
141}
142
Neale Ranns50f0ac02019-05-15 02:13:37 -0700143static clib_error_t *
144punt_socket_register_l4 (vlib_main_t * vm,
145 ip_address_family_t af,
146 u8 protocol, u16 port, char *client_pathname)
Ole Troanf7a55ad2017-05-16 14:59:29 +0200147{
148 punt_main_t *pm = &punt_main;
Neale Ranns50f0ac02019-05-15 02:13:37 -0700149 punt_client_t *c;
Ole Troanf7a55ad2017-05-16 14:59:29 +0200150
151 /* For now we only support UDP punt */
152 if (protocol != IP_PROTOCOL_UDP)
153 return clib_error_return (0,
154 "only UDP protocol (%d) is supported, got %d",
155 IP_PROTOCOL_UDP, protocol);
156
157 if (port == (u16) ~ 0)
158 return clib_error_return (0, "UDP port number required");
159
Neale Ranns50f0ac02019-05-15 02:13:37 -0700160 c = punt_client_l4_get (af, port);
Ole Troanf7a55ad2017-05-16 14:59:29 +0200161
Neale Ranns50f0ac02019-05-15 02:13:37 -0700162 if (NULL == c)
163 {
164 pool_get_zero (pm->punt_client_pool, c);
165 punt_client_l4_db_add (af, port, c - pm->punt_client_pool);
166 }
Ole Troanf7a55ad2017-05-16 14:59:29 +0200167
Neale Ranns50f0ac02019-05-15 02:13:37 -0700168 memcpy (c->caddr.sun_path, client_pathname, sizeof (c->caddr.sun_path));
169 c->caddr.sun_family = AF_UNIX;
170 c->reg.type = PUNT_TYPE_L4;
171 c->reg.punt.l4.port = port;
172 c->reg.punt.l4.protocol = protocol;
173 c->reg.punt.l4.af = af;
174
175 u32 node_index = (af == AF_IP4 ?
176 udp4_punt_socket_node.index :
177 udp6_punt_socket_node.index);
178
179 udp_register_dst_port (vm, port, node_index, af == AF_IP4);
180
181 return (NULL);
182}
183
184static clib_error_t *
Neale Rannsb538dd82019-05-21 06:54:54 -0700185punt_socket_register_ip_proto (vlib_main_t * vm,
186 ip_address_family_t af,
187 ip_protocol_t proto, char *client_pathname)
188{
189 punt_main_t *pm = &punt_main;
190 punt_client_t *c;
191
192 c = punt_client_ip_proto_get (af, proto);
193
194 if (NULL == c)
195 {
196 pool_get_zero (pm->punt_client_pool, c);
197 punt_client_ip_proto_db_add (af, proto, c - pm->punt_client_pool);
198 }
199
200 memcpy (c->caddr.sun_path, client_pathname, sizeof (c->caddr.sun_path));
201 c->caddr.sun_family = AF_UNIX;
202 c->reg.type = PUNT_TYPE_IP_PROTO;
203 c->reg.punt.ip_proto.protocol = proto;
204 c->reg.punt.ip_proto.af = af;
205
206 if (af == AF_IP4)
207 ip4_register_protocol (proto, ip4_proto_punt_socket_node.index);
208 else
209 ip6_register_protocol (proto, ip6_proto_punt_socket_node.index);
210
211 return (NULL);
212}
213
214static clib_error_t *
Neale Ranns50f0ac02019-05-15 02:13:37 -0700215punt_socket_register_exception (vlib_main_t * vm,
216 vlib_punt_reason_t reason,
217 char *client_pathname)
218{
219 punt_main_t *pm = &punt_main;
220 punt_client_t *pc;
221
222 pc = punt_client_exception_get (reason);
223
224 if (NULL == pc)
225 {
226 pool_get_zero (pm->punt_client_pool, pc);
227 punt_client_exception_db_add (reason, pc - pm->punt_client_pool);
228 }
229
230 memcpy (pc->caddr.sun_path, client_pathname, sizeof (pc->caddr.sun_path));
231 pc->caddr.sun_family = AF_UNIX;
232 pc->reg.type = PUNT_TYPE_EXCEPTION;
233 pc->reg.punt.exception.reason = reason;
234
235 vlib_punt_register (pm->hdl,
236 pc->reg.punt.exception.reason, "exception-punt-socket");
237
238 return (NULL);
239}
240
241static clib_error_t *
242punt_socket_unregister_l4 (ip_address_family_t af,
243 ip_protocol_t protocol, u16 port)
244{
245 u32 pci;
246
247 udp_unregister_dst_port (vlib_get_main (), port, af == AF_IP4);
248
249 pci = punt_client_l4_db_remove (af, port);
250
251 if (~0 != pci)
252 pool_put_index (punt_main.punt_client_pool, pci);
253
254 return (NULL);
255}
256
257static clib_error_t *
Neale Rannsb538dd82019-05-21 06:54:54 -0700258punt_socket_unregister_ip_proto (ip_address_family_t af, ip_protocol_t proto)
259{
260 u32 pci;
261
262 if (af == AF_IP4)
263 ip4_unregister_protocol (proto);
264 else
265 ip6_unregister_protocol (proto);
266
267 pci = punt_client_ip_proto_db_remove (af, proto);
268
269 if (~0 != pci)
270 pool_put_index (punt_main.punt_client_pool, pci);
271
272 return (NULL);
273}
274
275static clib_error_t *
Neale Ranns50f0ac02019-05-15 02:13:37 -0700276punt_socket_unregister_exception (vlib_punt_reason_t reason)
277{
278 u32 pci;
279
280 pci = punt_client_exception_db_remove (reason);
281
282 if (~0 != pci)
283 pool_put_index (punt_main.punt_client_pool, pci);
284
285 return (NULL);
Ole Troanf7a55ad2017-05-16 14:59:29 +0200286}
287
288clib_error_t *
Neale Ranns50f0ac02019-05-15 02:13:37 -0700289vnet_punt_socket_add (vlib_main_t * vm, u32 header_version,
290 const punt_reg_t * pr, char *client_pathname)
Ole Troanf7a55ad2017-05-16 14:59:29 +0200291{
292 punt_main_t *pm = &punt_main;
293
294 if (!pm->is_configured)
295 return clib_error_return (0, "socket is not configured");
296
Neale Ranns50f0ac02019-05-15 02:13:37 -0700297 if (header_version != PUNT_PACKETDESC_VERSION)
298 return clib_error_return (0, "Invalid packet descriptor version");
299
Neale Rannsb538dd82019-05-21 06:54:54 -0700300 if (strncmp (client_pathname, vnet_punt_get_server_pathname (),
301 UNIX_PATH_MAX) == 0)
302 return clib_error_return (0,
303 "Punt socket: Invalid client path: %s",
304 client_pathname);
305
Neale Ranns50f0ac02019-05-15 02:13:37 -0700306 /* Register client */
307 switch (pr->type)
308 {
309 case PUNT_TYPE_L4:
310 return (punt_socket_register_l4 (vm,
311 pr->punt.l4.af,
312 pr->punt.l4.protocol,
313 pr->punt.l4.port, client_pathname));
Neale Rannsb538dd82019-05-21 06:54:54 -0700314 case PUNT_TYPE_IP_PROTO:
315 return (punt_socket_register_ip_proto (vm,
316 pr->punt.ip_proto.af,
317 pr->punt.ip_proto.protocol,
318 client_pathname));
Neale Ranns50f0ac02019-05-15 02:13:37 -0700319 case PUNT_TYPE_EXCEPTION:
320 return (punt_socket_register_exception (vm,
321 pr->punt.exception.reason,
322 client_pathname));
323 }
324
325 return 0;
326}
327
328clib_error_t *
329vnet_punt_socket_del (vlib_main_t * vm, const punt_reg_t * pr)
330{
331 punt_main_t *pm = &punt_main;
332
333 if (!pm->is_configured)
334 return clib_error_return (0, "socket is not configured");
335
336 switch (pr->type)
337 {
338 case PUNT_TYPE_L4:
339 return (punt_socket_unregister_l4 (pr->punt.l4.af,
340 pr->punt.l4.protocol,
341 pr->punt.l4.port));
Neale Rannsb538dd82019-05-21 06:54:54 -0700342 case PUNT_TYPE_IP_PROTO:
343 return (punt_socket_unregister_ip_proto (pr->punt.ip_proto.af,
344 pr->punt.ip_proto.protocol));
Neale Ranns50f0ac02019-05-15 02:13:37 -0700345 case PUNT_TYPE_EXCEPTION:
346 return (punt_socket_unregister_exception (pr->punt.exception.reason));
347 }
Ole Troanf7a55ad2017-05-16 14:59:29 +0200348
349 return 0;
350}
351
Alexander Popovsky (apopovsk)4a7e58b2016-10-05 22:31:23 -0700352/**
Paul Vinciguerra32c4d382019-10-23 16:07:32 -0400353 * @brief Request IP L4 traffic punt to the local TCP/IP stack.
Alexander Popovsky (apopovsk)4a7e58b2016-10-05 22:31:23 -0700354 *
355 * @em Note
Paul Vinciguerra32c4d382019-10-23 16:07:32 -0400356 * - UDP is the only protocol supported in the current implementation
Alexander Popovsky (apopovsk)4a7e58b2016-10-05 22:31:23 -0700357 *
358 * @param vm vlib_main_t corresponding to the current thread
Neale Ranns50f0ac02019-05-15 02:13:37 -0700359 * @param af IP address family.
Alexander Popovsky (apopovsk)4a7e58b2016-10-05 22:31:23 -0700360 * @param protocol 8-bits L4 protocol value
Pierre Pfister7fe51f32017-09-20 08:48:36 +0200361 * UDP is 17
362 * TCP is 1
363 * @param port 16-bits L4 (TCP/IP) port number when applicable (UDP only)
Alexander Popovsky (apopovsk)4a7e58b2016-10-05 22:31:23 -0700364 *
365 * @returns 0 on success, non-zero value otherwise
366 */
Neale Ranns50f0ac02019-05-15 02:13:37 -0700367static clib_error_t *
368punt_l4_add_del (vlib_main_t * vm,
369 ip_address_family_t af,
370 ip_protocol_t protocol, u16 port, bool is_add)
Alexander Popovsky (apopovsk)4a7e58b2016-10-05 22:31:23 -0700371{
Florin Coras3ffe6ca2019-06-26 16:27:13 -0700372 /* For now we only support TCP and UDP punt */
373 if (protocol != IP_PROTOCOL_UDP && protocol != IP_PROTOCOL_TCP)
Alexander Popovsky (apopovsk)740bcdb2016-11-15 15:36:23 -0800374 return clib_error_return (0,
Florin Coras3ffe6ca2019-06-26 16:27:13 -0700375 "only UDP (%d) and TCP (%d) protocols are supported, got %d",
376 IP_PROTOCOL_UDP, IP_PROTOCOL_TCP, protocol);
Alexander Popovsky (apopovsk)4a7e58b2016-10-05 22:31:23 -0700377
Alexander Popovsky (apopovsk)740bcdb2016-11-15 15:36:23 -0800378 if (port == (u16) ~ 0)
Alexander Popovsky (apopovsk)4a7e58b2016-10-05 22:31:23 -0700379 {
Neale Ranns50f0ac02019-05-15 02:13:37 -0700380 if (protocol == IP_PROTOCOL_UDP)
381 udp_punt_unknown (vm, af == AF_IP4, is_add);
382 else if (protocol == IP_PROTOCOL_TCP)
383 tcp_punt_unknown (vm, af == AF_IP4, is_add);
Alexander Popovsky (apopovsk)740bcdb2016-11-15 15:36:23 -0800384
385 return 0;
386 }
387
388 else if (is_add)
389 {
Florin Coras3ffe6ca2019-06-26 16:27:13 -0700390 if (protocol == IP_PROTOCOL_TCP)
391 return clib_error_return (0, "punt TCP ports is not supported yet");
Pierre Pfister7fe51f32017-09-20 08:48:36 +0200392
Neale Ranns50f0ac02019-05-15 02:13:37 -0700393 udp_register_dst_port (vm, port, udp4_punt_node.index, af == AF_IP4);
Alexander Popovsky (apopovsk)740bcdb2016-11-15 15:36:23 -0800394
395 return 0;
Alexander Popovsky (apopovsk)4a7e58b2016-10-05 22:31:23 -0700396 }
397 else
Pavel Kotucek41b923a2018-12-05 17:16:23 +0100398 {
Florin Coras3ffe6ca2019-06-26 16:27:13 -0700399 if (protocol == IP_PROTOCOL_TCP)
400 return clib_error_return (0, "punt TCP ports is not supported yet");
Pavel Kotucek41b923a2018-12-05 17:16:23 +0100401
Neale Ranns50f0ac02019-05-15 02:13:37 -0700402 udp_unregister_dst_port (vm, port, af == AF_IP4);
Pavel Kotucek41b923a2018-12-05 17:16:23 +0100403
404 return 0;
405 }
Alexander Popovsky (apopovsk)4a7e58b2016-10-05 22:31:23 -0700406}
Neale Ranns50f0ac02019-05-15 02:13:37 -0700407
Neale Ranns50f0ac02019-05-15 02:13:37 -0700408clib_error_t *
409vnet_punt_add_del (vlib_main_t * vm, const punt_reg_t * pr, bool is_add)
410{
411 switch (pr->type)
412 {
413 case PUNT_TYPE_L4:
414 return (punt_l4_add_del (vm, pr->punt.l4.af, pr->punt.l4.protocol,
415 pr->punt.l4.port, is_add));
416 case PUNT_TYPE_EXCEPTION:
Neale Rannsb538dd82019-05-21 06:54:54 -0700417 case PUNT_TYPE_IP_PROTO:
418 break;
Neale Ranns50f0ac02019-05-15 02:13:37 -0700419 }
420
421 return (clib_error_return (0, "Unsupported punt type: %d", pr->type));
422}
Alexander Popovsky (apopovsk)4a7e58b2016-10-05 22:31:23 -0700423
424static clib_error_t *
Pierre Pfister7fe51f32017-09-20 08:48:36 +0200425punt_cli (vlib_main_t * vm,
BenoƮt Ganne9ae3c6a2020-07-27 18:27:57 +0200426 unformat_input_t * input__, vlib_cli_command_t * cmd)
Alexander Popovsky (apopovsk)4a7e58b2016-10-05 22:31:23 -0700427{
BenoƮt Ganne9ae3c6a2020-07-27 18:27:57 +0200428 unformat_input_t line_input, *input = &line_input;
Swarup Nayak1b708842017-12-13 13:27:23 +0530429 clib_error_t *error = NULL;
Neale Ranns50f0ac02019-05-15 02:13:37 -0700430 bool is_add = true;
Neale Ranns68577d22019-06-04 13:31:23 +0000431 /* *INDENT-OFF* */
Neale Ranns50f0ac02019-05-15 02:13:37 -0700432 punt_reg_t pr = {
433 .punt = {
Neale Ranns68577d22019-06-04 13:31:23 +0000434 .l4 = {
435 .af = AF_IP4,
436 .port = ~0,
Paul Vinciguerra32c4d382019-10-23 16:07:32 -0400437 .protocol = IP_PROTOCOL_UDP,
Neale Ranns68577d22019-06-04 13:31:23 +0000438 },
439 },
Neale Ranns50f0ac02019-05-15 02:13:37 -0700440 .type = PUNT_TYPE_L4,
441 };
Neale Ranns68577d22019-06-04 13:31:23 +0000442 u32 port;
443 /* *INDENT-ON* */
Alexander Popovsky (apopovsk)4a7e58b2016-10-05 22:31:23 -0700444
BenoƮt Ganne9ae3c6a2020-07-27 18:27:57 +0200445 if (!unformat_user (input__, unformat_line_input, input))
446 return 0;
447
Alexander Popovsky (apopovsk)4a7e58b2016-10-05 22:31:23 -0700448 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
449 {
450 if (unformat (input, "del"))
Ole Troanf7a55ad2017-05-16 14:59:29 +0200451 is_add = false;
Paul Vinciguerra32c4d382019-10-23 16:07:32 -0400452 else if (unformat (input, "ipv4"))
453 pr.punt.l4.af = AF_IP4;
Neale Ranns50f0ac02019-05-15 02:13:37 -0700454 else if (unformat (input, "ipv6"))
455 pr.punt.l4.af = AF_IP6;
456 else if (unformat (input, "ip6"))
457 pr.punt.l4.af = AF_IP6;
Neale Ranns68577d22019-06-04 13:31:23 +0000458 else if (unformat (input, "%d", &port))
459 pr.punt.l4.port = port;
Paul Vinciguerra32c4d382019-10-23 16:07:32 -0400460 else if (unformat (input, "all"))
461 pr.punt.l4.port = ~0;
Pierre Pfister7fe51f32017-09-20 08:48:36 +0200462 else if (unformat (input, "udp"))
Neale Ranns50f0ac02019-05-15 02:13:37 -0700463 pr.punt.l4.protocol = IP_PROTOCOL_UDP;
Pierre Pfister7fe51f32017-09-20 08:48:36 +0200464 else if (unformat (input, "tcp"))
Neale Ranns50f0ac02019-05-15 02:13:37 -0700465 pr.punt.l4.protocol = IP_PROTOCOL_TCP;
Swarup Nayak1b708842017-12-13 13:27:23 +0530466 else
467 {
468 error = clib_error_return (0, "parse error: '%U'",
469 format_unformat_error, input);
470 goto done;
471 }
Alexander Popovsky (apopovsk)4a7e58b2016-10-05 22:31:23 -0700472 }
Pavel Kotuceke88865d2018-11-28 07:42:11 +0100473
474 /* punt both IPv6 and IPv4 when used in CLI */
Neale Ranns50f0ac02019-05-15 02:13:37 -0700475 error = vnet_punt_add_del (vm, &pr, is_add);
Pavel Kotuceke88865d2018-11-28 07:42:11 +0100476 if (error)
477 {
478 clib_error_report (error);
Pavel Kotuceke88865d2018-11-28 07:42:11 +0100479 }
480
Swarup Nayak1b708842017-12-13 13:27:23 +0530481done:
BenoƮt Ganne9ae3c6a2020-07-27 18:27:57 +0200482 unformat_free (input);
Swarup Nayak1b708842017-12-13 13:27:23 +0530483 return error;
Alexander Popovsky (apopovsk)4a7e58b2016-10-05 22:31:23 -0700484}
485
486/*?
487 * The set of '<em>set punt</em>' commands allows specific IP traffic to
488 * be punted to the host TCP/IP stack
489 *
490 * @em Note
491 * - UDP is the only protocol supported in the current implementation
Alexander Popovsky (apopovsk)4a7e58b2016-10-05 22:31:23 -0700492 * - All TCP traffic is currently punted to the host by default
493 *
494 * @cliexpar
495 * @parblock
496 * Example of how to request NTP traffic to be punted
497 * @cliexcmd{set punt udp 125}
498 *
Alexander Popovsky (apopovsk)740bcdb2016-11-15 15:36:23 -0800499 * Example of how to request all 'unknown' UDP traffic to be punted
500 * @cliexcmd{set punt udp all}
501 *
502 * Example of how to stop all 'unknown' UDP traffic to be punted
503 * @cliexcmd{set punt udp del all}
Alexander Popovsky (apopovsk)4a7e58b2016-10-05 22:31:23 -0700504 * @endparblock
505?*/
506/* *INDENT-OFF* */
Pierre Pfister7fe51f32017-09-20 08:48:36 +0200507VLIB_CLI_COMMAND (punt_command, static) = {
508 .path = "set punt",
Paul Vinciguerra32c4d382019-10-23 16:07:32 -0400509 .short_help = "set punt [IPV4|ip6|ipv6] [UDP|tcp] [del] [ALL|<port-num>]",
Pierre Pfister7fe51f32017-09-20 08:48:36 +0200510 .function = punt_cli,
Alexander Popovsky (apopovsk)4a7e58b2016-10-05 22:31:23 -0700511};
512/* *INDENT-ON* */
513
Pavel Kotuceke88865d2018-11-28 07:42:11 +0100514static clib_error_t *
515punt_socket_register_cmd (vlib_main_t * vm,
BenoƮt Ganne9ae3c6a2020-07-27 18:27:57 +0200516 unformat_input_t * input__,
517 vlib_cli_command_t * cmd)
Pavel Kotuceke88865d2018-11-28 07:42:11 +0100518{
BenoƮt Ganne9ae3c6a2020-07-27 18:27:57 +0200519 unformat_input_t line_input, *input = &line_input;
Pavel Kotuceke88865d2018-11-28 07:42:11 +0100520 u8 *socket_name = 0;
521 clib_error_t *error = NULL;
Neale Ranns50f0ac02019-05-15 02:13:37 -0700522 /* *INDENT-OFF* */
523 punt_reg_t pr = {
524 .punt = {
525 .l4 = {
526 .af = AF_IP4,
527 .port = ~0,
Paul Vinciguerra32c4d382019-10-23 16:07:32 -0400528 .protocol = IP_PROTOCOL_UDP,
Neale Ranns50f0ac02019-05-15 02:13:37 -0700529 },
530 },
531 .type = PUNT_TYPE_L4,
532 };
533 /* *INDENT-ON* */
Pavel Kotuceke88865d2018-11-28 07:42:11 +0100534
BenoƮt Ganne9ae3c6a2020-07-27 18:27:57 +0200535 if (!unformat_user (input__, unformat_line_input, input))
536 return 0;
537
Pavel Kotuceke88865d2018-11-28 07:42:11 +0100538 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
539 {
540 if (unformat (input, "ipv4"))
Paul Vinciguerra32c4d382019-10-23 16:07:32 -0400541 pr.punt.l4.af = AF_IP4;
Pavel Kotuceke88865d2018-11-28 07:42:11 +0100542 else if (unformat (input, "ipv6"))
Neale Ranns50f0ac02019-05-15 02:13:37 -0700543 pr.punt.l4.af = AF_IP6;
Pavel Kotuceke88865d2018-11-28 07:42:11 +0100544 else if (unformat (input, "udp"))
Neale Ranns50f0ac02019-05-15 02:13:37 -0700545 pr.punt.l4.protocol = IP_PROTOCOL_UDP;
Pavel Kotuceke88865d2018-11-28 07:42:11 +0100546 else if (unformat (input, "tcp"))
Neale Ranns50f0ac02019-05-15 02:13:37 -0700547 pr.punt.l4.protocol = IP_PROTOCOL_TCP;
548 else if (unformat (input, "%d", &pr.punt.l4.port))
Pavel Kotuceke88865d2018-11-28 07:42:11 +0100549 ;
Paul Vinciguerra32c4d382019-10-23 16:07:32 -0400550 else if (unformat (input, "all"))
551 pr.punt.l4.port = ~0;
Pavel Kotuceke88865d2018-11-28 07:42:11 +0100552 else if (unformat (input, "socket %s", &socket_name))
553 ;
554 else
555 {
556 error = clib_error_return (0, "parse error: '%U'",
557 format_unformat_error, input);
558 goto done;
559 }
560 }
561
Neale Ranns4f3c1042019-06-11 01:39:08 -0700562 if (!socket_name)
563 error = clib_error_return (0, "socket name not specified");
564 else
565 error = vnet_punt_socket_add (vm, 1, &pr, (char *) socket_name);
Neale Ranns50f0ac02019-05-15 02:13:37 -0700566
Pavel Kotuceke88865d2018-11-28 07:42:11 +0100567done:
BenoƮt Ganne9ae3c6a2020-07-27 18:27:57 +0200568 unformat_free (input);
Pavel Kotuceke88865d2018-11-28 07:42:11 +0100569 return error;
570}
571
572/*?
573 *
574 * @cliexpar
Paul Vinciguerra32c4d382019-10-23 16:07:32 -0400575 * @cliexcmd{punt socket register socket punt_l4_foo.sock}
576
Pavel Kotuceke88865d2018-11-28 07:42:11 +0100577 ?*/
578/* *INDENT-OFF* */
579VLIB_CLI_COMMAND (punt_socket_register_command, static) =
580{
581 .path = "punt socket register",
582 .function = punt_socket_register_cmd,
Paul Vinciguerra32c4d382019-10-23 16:07:32 -0400583 .short_help = "punt socket register [IPV4|ipv6] [UDP|tcp] [ALL|<port-num>] socket <socket>",
Pavel Kotuceke88865d2018-11-28 07:42:11 +0100584 .is_mp_safe = 1,
585};
586/* *INDENT-ON* */
587
588static clib_error_t *
589punt_socket_deregister_cmd (vlib_main_t * vm,
BenoƮt Ganne9ae3c6a2020-07-27 18:27:57 +0200590 unformat_input_t * input__,
Pavel Kotuceke88865d2018-11-28 07:42:11 +0100591 vlib_cli_command_t * cmd)
592{
BenoƮt Ganne9ae3c6a2020-07-27 18:27:57 +0200593 unformat_input_t line_input, *input = &line_input;
Pavel Kotuceke88865d2018-11-28 07:42:11 +0100594 clib_error_t *error = NULL;
Neale Ranns50f0ac02019-05-15 02:13:37 -0700595 /* *INDENT-OFF* */
596 punt_reg_t pr = {
597 .punt = {
598 .l4 = {
599 .af = AF_IP4,
600 .port = ~0,
Paul Vinciguerra32c4d382019-10-23 16:07:32 -0400601 .protocol = IP_PROTOCOL_UDP,
Neale Ranns50f0ac02019-05-15 02:13:37 -0700602 },
603 },
604 .type = PUNT_TYPE_L4,
605 };
606 /* *INDENT-ON* */
Pavel Kotuceke88865d2018-11-28 07:42:11 +0100607
BenoƮt Ganne9ae3c6a2020-07-27 18:27:57 +0200608 if (!unformat_user (input__, unformat_line_input, input))
609 return 0;
610
Pavel Kotuceke88865d2018-11-28 07:42:11 +0100611 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
612 {
613 if (unformat (input, "ipv4"))
Paul Vinciguerra32c4d382019-10-23 16:07:32 -0400614 pr.punt.l4.af = AF_IP4;
Pavel Kotuceke88865d2018-11-28 07:42:11 +0100615 else if (unformat (input, "ipv6"))
Neale Ranns50f0ac02019-05-15 02:13:37 -0700616 pr.punt.l4.af = AF_IP6;
Pavel Kotuceke88865d2018-11-28 07:42:11 +0100617 else if (unformat (input, "udp"))
Neale Ranns50f0ac02019-05-15 02:13:37 -0700618 pr.punt.l4.protocol = IP_PROTOCOL_UDP;
Pavel Kotuceke88865d2018-11-28 07:42:11 +0100619 else if (unformat (input, "tcp"))
Neale Ranns50f0ac02019-05-15 02:13:37 -0700620 pr.punt.l4.protocol = IP_PROTOCOL_TCP;
621 else if (unformat (input, "%d", &pr.punt.l4.port))
Pavel Kotuceke88865d2018-11-28 07:42:11 +0100622 ;
Paul Vinciguerra32c4d382019-10-23 16:07:32 -0400623 else if (unformat (input, "all"))
624 pr.punt.l4.port = ~0;
Pavel Kotuceke88865d2018-11-28 07:42:11 +0100625 else
626 {
627 error = clib_error_return (0, "parse error: '%U'",
628 format_unformat_error, input);
629 goto done;
630 }
631 }
632
Neale Ranns50f0ac02019-05-15 02:13:37 -0700633 error = vnet_punt_socket_del (vm, &pr);
Pavel Kotuceke88865d2018-11-28 07:42:11 +0100634done:
BenoƮt Ganne9ae3c6a2020-07-27 18:27:57 +0200635 unformat_free (input);
Pavel Kotuceke88865d2018-11-28 07:42:11 +0100636 return error;
637}
638
639/*?
640 *
641 * @cliexpar
642 * @cliexcmd{punt socket register}
643 ?*/
644/* *INDENT-OFF* */
645VLIB_CLI_COMMAND (punt_socket_deregister_command, static) =
646{
647 .path = "punt socket deregister",
648 .function = punt_socket_deregister_cmd,
Paul Vinciguerra32c4d382019-10-23 16:07:32 -0400649 .short_help = "punt socket deregister [IPV4|ipv6] [UDP|tcp] [ALL|<port-num>]",
Pavel Kotuceke88865d2018-11-28 07:42:11 +0100650 .is_mp_safe = 1,
651};
652/* *INDENT-ON* */
653
Neale Ranns50f0ac02019-05-15 02:13:37 -0700654void
655punt_client_walk (punt_type_t pt, punt_client_walk_cb_t cb, void *ctx)
Pavel Kotuceke88865d2018-11-28 07:42:11 +0100656{
657 punt_main_t *pm = &punt_main;
Pavel Kotuceke88865d2018-11-28 07:42:11 +0100658
Neale Ranns50f0ac02019-05-15 02:13:37 -0700659 switch (pt)
660 {
661 case PUNT_TYPE_L4:
Pavel Kotuceke88865d2018-11-28 07:42:11 +0100662 {
Neale Rannsb538dd82019-05-21 06:54:54 -0700663 u32 pci, key;
Neale Ranns50f0ac02019-05-15 02:13:37 -0700664
665 /* *INDENT-OFF* */
Neale Rannsb538dd82019-05-21 06:54:54 -0700666 hash_foreach(key, pci, pm->db.clients_by_l4_port,
667 ({
668 cb (pool_elt_at_index(pm->punt_client_pool, pci), ctx);
669 }));
670 /* *INDENT-ON* */
671 break;
672 }
673 case PUNT_TYPE_IP_PROTO:
674 {
675 u32 pci, key;
676
677 /* *INDENT-OFF* */
678 hash_foreach(key, pci, pm->db.clients_by_ip_proto,
Neale Ranns50f0ac02019-05-15 02:13:37 -0700679 ({
680 cb (pool_elt_at_index(pm->punt_client_pool, pci), ctx);
681 }));
682 /* *INDENT-ON* */
683 break;
Pavel Kotuceke88865d2018-11-28 07:42:11 +0100684 }
Neale Ranns50f0ac02019-05-15 02:13:37 -0700685 case PUNT_TYPE_EXCEPTION:
686 {
687 u32 *pci;
688
689 vec_foreach (pci, pm->db.clients_by_exception)
690 {
691 if (~0 != *pci)
692 cb (pool_elt_at_index (pm->punt_client_pool, *pci), ctx);
693 }
694
695 break;
696 }
697 }
Pavel Kotuceke88865d2018-11-28 07:42:11 +0100698}
699
Neale Ranns50f0ac02019-05-15 02:13:37 -0700700static u8 *
701format_punt_client (u8 * s, va_list * args)
Pavel Kotuceke88865d2018-11-28 07:42:11 +0100702{
Neale Ranns50f0ac02019-05-15 02:13:37 -0700703 punt_client_t *pc = va_arg (*args, punt_client_t *);
Pavel Kotuceke88865d2018-11-28 07:42:11 +0100704
Neale Ranns50f0ac02019-05-15 02:13:37 -0700705 s = format (s, " punt ");
706
707 switch (pc->reg.type)
708 {
709 case PUNT_TYPE_L4:
710 s = format (s, "%U %U port %d",
711 format_ip_address_family, pc->reg.punt.l4.af,
712 format_ip_protocol, pc->reg.punt.l4.protocol,
713 pc->reg.punt.l4.port);
714 break;
Neale Rannsb538dd82019-05-21 06:54:54 -0700715 case PUNT_TYPE_IP_PROTO:
716 s = format (s, "%U %U",
717 format_ip_address_family, pc->reg.punt.ip_proto.af,
718 format_ip_protocol, pc->reg.punt.ip_proto.protocol);
719 break;
Neale Ranns50f0ac02019-05-15 02:13:37 -0700720 case PUNT_TYPE_EXCEPTION:
721 s = format (s, " %U", format_vlib_punt_reason,
722 pc->reg.punt.exception.reason);
723 break;
724 }
725
726 s = format (s, " to socket %s \n", pc->caddr.sun_path);
Pavel Kotuceke88865d2018-11-28 07:42:11 +0100727
728 return (s);
729}
730
Neale Ranns50f0ac02019-05-15 02:13:37 -0700731static walk_rc_t
732punt_client_show_one (const punt_client_t * pc, void *ctx)
733{
734 vlib_cli_output (ctx, "%U", format_punt_client, pc);
735
736 return (WALK_CONTINUE);
737}
738
Pavel Kotuceke88865d2018-11-28 07:42:11 +0100739static clib_error_t *
740punt_socket_show_cmd (vlib_main_t * vm,
BenoƮt Ganne9ae3c6a2020-07-27 18:27:57 +0200741 unformat_input_t * input__, vlib_cli_command_t * cmd)
Pavel Kotuceke88865d2018-11-28 07:42:11 +0100742{
BenoƮt Ganne9ae3c6a2020-07-27 18:27:57 +0200743 unformat_input_t line_input, *input = &line_input;
Pavel Kotuceke88865d2018-11-28 07:42:11 +0100744 clib_error_t *error = NULL;
Neale Ranns50f0ac02019-05-15 02:13:37 -0700745 punt_type_t pt;
746
747 pt = PUNT_TYPE_L4;
Pavel Kotuceke88865d2018-11-28 07:42:11 +0100748
BenoƮt Ganne9ae3c6a2020-07-27 18:27:57 +0200749 if (!unformat_user (input__, unformat_line_input, input))
750 return 0;
751
Pavel Kotuceke88865d2018-11-28 07:42:11 +0100752 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
753 {
Neale Ranns50f0ac02019-05-15 02:13:37 -0700754 if (unformat (input, "exception"))
755 pt = PUNT_TYPE_EXCEPTION;
756 else if (unformat (input, "l4"))
757 pt = PUNT_TYPE_L4;
Neale Rannsb538dd82019-05-21 06:54:54 -0700758 else if (unformat (input, "ip"))
759 pt = PUNT_TYPE_IP_PROTO;
Pavel Kotuceke88865d2018-11-28 07:42:11 +0100760 else
761 {
762 error = clib_error_return (0, "parse error: '%U'",
763 format_unformat_error, input);
764 goto done;
765 }
766 }
767
Neale Ranns50f0ac02019-05-15 02:13:37 -0700768 punt_client_walk (pt, punt_client_show_one, vm);
Pavel Kotuceke88865d2018-11-28 07:42:11 +0100769
770done:
BenoƮt Ganne9ae3c6a2020-07-27 18:27:57 +0200771 unformat_free (input);
Pavel Kotuceke88865d2018-11-28 07:42:11 +0100772 return (error);
773}
774
775/*?
776 *
777 * @cliexpar
778 * @cliexcmd{show punt socket ipv4}
779 ?*/
780/* *INDENT-OFF* */
781VLIB_CLI_COMMAND (show_punt_socket_registration_command, static) =
782{
783 .path = "show punt socket registrations",
784 .function = punt_socket_show_cmd,
Neale Ranns50f0ac02019-05-15 02:13:37 -0700785 .short_help = "show punt socket registrations [l4|exception]",
Pavel Kotuceke88865d2018-11-28 07:42:11 +0100786 .is_mp_safe = 1,
787};
788/* *INDENT-ON* */
789
Ole Troanf7a55ad2017-05-16 14:59:29 +0200790clib_error_t *
Neale Ranns76b56492018-09-28 15:16:14 +0000791ip_punt_init (vlib_main_t * vm)
Ole Troanf7a55ad2017-05-16 14:59:29 +0200792{
Neale Ranns50f0ac02019-05-15 02:13:37 -0700793 clib_error_t *error = NULL;
Ole Troanf7a55ad2017-05-16 14:59:29 +0200794 punt_main_t *pm = &punt_main;
Neale Ranns39040a62019-07-10 01:47:15 -0700795 vlib_thread_main_t *tm = vlib_get_thread_main ();
Ole Troanf7a55ad2017-05-16 14:59:29 +0200796
Ole Troanf7a55ad2017-05-16 14:59:29 +0200797 pm->is_configured = false;
Neale Ranns50f0ac02019-05-15 02:13:37 -0700798 pm->interface_output_node =
799 vlib_get_node_by_name (vm, (u8 *) "interface-output");
800
801 if ((error = vlib_call_init_function (vm, punt_init)))
802 return error;
803
804 pm->hdl = vlib_punt_client_register ("ip-punt");
805
Neale Ranns39040a62019-07-10 01:47:15 -0700806 vec_validate_aligned (pm->thread_data, tm->n_vlib_mains,
807 CLIB_CACHE_LINE_BYTES);
808
Neale Ranns50f0ac02019-05-15 02:13:37 -0700809 return (error);
Ole Troanf7a55ad2017-05-16 14:59:29 +0200810}
811
Neale Ranns76b56492018-09-28 15:16:14 +0000812VLIB_INIT_FUNCTION (ip_punt_init);
Ole Troanf7a55ad2017-05-16 14:59:29 +0200813
814static clib_error_t *
815punt_config (vlib_main_t * vm, unformat_input_t * input)
816{
817 punt_main_t *pm = &punt_main;
818 char *socket_path = 0;
819
820 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
821 {
822 if (unformat (input, "socket %s", &socket_path))
Pavel Kotuceke88865d2018-11-28 07:42:11 +0100823 strncpy (pm->sun_path, socket_path, UNIX_PATH_MAX - 1);
Ole Troanf7a55ad2017-05-16 14:59:29 +0200824 else
825 return clib_error_return (0, "unknown input `%U'",
826 format_unformat_error, input);
827 }
828
829 if (socket_path == 0)
830 return 0;
831
832 /* UNIX domain socket */
833 struct sockaddr_un addr;
834 if ((pm->socket_fd = socket (AF_UNIX, SOCK_DGRAM | SOCK_NONBLOCK, 0)) == -1)
835 {
836 return clib_error_return (0, "socket error");
837 }
838
Dave Barachb7b92992018-10-17 10:38:51 -0400839 clib_memset (&addr, 0, sizeof (addr));
Ole Troanf7a55ad2017-05-16 14:59:29 +0200840 addr.sun_family = AF_UNIX;
841 if (*socket_path == '\0')
842 {
843 *addr.sun_path = '\0';
844 strncpy (addr.sun_path + 1, socket_path + 1,
845 sizeof (addr.sun_path) - 2);
846 }
847 else
848 {
849 strncpy (addr.sun_path, socket_path, sizeof (addr.sun_path) - 1);
850 unlink (socket_path);
851 }
852
853 if (bind (pm->socket_fd, (struct sockaddr *) &addr, sizeof (addr)) == -1)
854 {
855 return clib_error_return (0, "bind error");
856 }
857
Neale Ranns50f0ac02019-05-15 02:13:37 -0700858 int n_bytes = 0x10000;
859
860 if (setsockopt
861 (pm->socket_fd, SOL_SOCKET, SO_SNDBUF, &n_bytes,
862 sizeof (n_bytes)) == -1)
863 {
864 return clib_error_return (0, "setsockopt error");
865 }
866
Ole Troanf7a55ad2017-05-16 14:59:29 +0200867 /* Register socket */
Damjan Marion56dd5432017-09-08 19:52:02 +0200868 clib_file_main_t *fm = &file_main;
869 clib_file_t template = { 0 };
Ole Troanf7a55ad2017-05-16 14:59:29 +0200870 template.read_function = punt_socket_read_ready;
871 template.file_descriptor = pm->socket_fd;
Damjan Marionceab7882018-01-19 20:56:12 +0100872 template.description = format (0, "%s", socket_path);
Damjan Marion56dd5432017-09-08 19:52:02 +0200873 pm->clib_file_index = clib_file_add (fm, &template);
Ole Troanf7a55ad2017-05-16 14:59:29 +0200874
875 pm->is_configured = true;
876
877 return 0;
878}
879
880VLIB_CONFIG_FUNCTION (punt_config, "punt");
881
Alexander Popovsky (apopovsk)4a7e58b2016-10-05 22:31:23 -0700882/*
883 * fd.io coding-style-patch-verification: ON
884 *
885 * Local Variables:
886 * eval: (c-set-style "gnu")
887 * End:
888 */