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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
18 * @brief Local TCP/IP stack punt infrastructure.
20 * Provides a set of VPP nodes together with the relevant APIs and CLI
21 * commands in order to adjust and dispatch packets from the VPP data plane
22 * to the local TCP/IP stack
25 #include <vnet/ip/ip.h>
26 #include <vlib/vlib.h>
27 #include <vnet/pg/pg.h>
28 #include <vnet/udp/udp.h>
29 #include <vnet/tcp/tcp.h>
30 #include <vnet/ip/punt.h>
31 #include <vlib/unix/unix.h>
35 #include <sys/socket.h>
41 #define punt_error(n,s) PUNT_ERROR_##n,
42 #include <vnet/ip/punt_error.def>
47 #define foreach_punt_next \
48 _ (PUNT4, "ip4-punt") \
53 #define _(s,n) PUNT_NEXT_##s,
59 enum punt_socket_rx_next_e
61 PUNT_SOCKET_RX_NEXT_INTERFACE_OUTPUT,
62 PUNT_SOCKET_RX_NEXT_IP4_LOOKUP,
63 PUNT_SOCKET_RX_NEXT_IP6_LOOKUP,
67 #define punt_next_punt(is_ip4) (is_ip4 ? PUNT_NEXT_PUNT4 : PUNT_NEXT_PUNT6)
69 /** @brief IPv4/IPv6 UDP punt node main loop.
71 This is the main loop inline function for IPv4/IPv6 UDP punt
74 @param vm vlib_main_t corresponding to the current thread
75 @param node vlib_node_runtime_t
76 @param frame vlib_frame_t whose contents should be dispatched
77 @param is_ipv4 indicates if called for IPv4 or IPv6 node
80 udp46_punt_inline (vlib_main_t * vm,
81 vlib_node_runtime_t * node,
82 vlib_frame_t * from_frame, int is_ip4)
84 u32 n_left_from, *from, *to_next;
87 from = vlib_frame_vector_args (from_frame);
88 n_left_from = from_frame->n_vectors;
90 /* udp[46]_lookup hands us the data payload, not the IP header */
92 advance = -(sizeof (ip4_header_t) + sizeof (udp_header_t));
94 advance = -(sizeof (ip6_header_t) + sizeof (udp_header_t));
96 while (n_left_from > 0)
100 vlib_get_next_frame (vm, node, punt_next_punt (is_ip4), to_next,
103 while (n_left_from > 0 && n_left_to_next > 0)
115 b0 = vlib_get_buffer (vm, bi0);
116 vlib_buffer_advance (b0, advance);
117 b0->error = node->errors[PUNT_ERROR_UDP_PORT];
120 vlib_put_next_frame (vm, node, punt_next_punt (is_ip4), n_left_to_next);
123 return from_frame->n_vectors;
126 static char *punt_error_strings[] = {
127 #define punt_error(n,s) s,
128 #include "punt_error.def"
132 /** @brief IPv4 UDP punt node.
135 This is the IPv4 UDP punt transition node. It is registered as a next
136 node for the "ip4-udp-lookup" handling UDP port(s) requested for punt.
137 The buffer's current data pointer is adjusted to the original packet
138 IPv4 header. All buffers are dispatched to "error-punt".
140 @param vm vlib_main_t corresponding to the current thread
141 @param node vlib_node_runtime_t
142 @param frame vlib_frame_t whose contents should be dispatched
144 @par Graph mechanics: next index usage
147 - <code>vnet_buffer(b)->current_data</code>
148 - <code>vnet_buffer(b)->current_len</code>
151 - Dispatches the packet to the "error-punt" node
153 VLIB_NODE_FN (udp4_punt_node) (vlib_main_t * vm,
154 vlib_node_runtime_t * node,
155 vlib_frame_t * from_frame)
157 return udp46_punt_inline (vm, node, from_frame, 1 /* is_ip4 */ );
160 /** @brief IPv6 UDP punt node.
163 This is the IPv6 UDP punt transition node. It is registered as a next
164 node for the "ip6-udp-lookup" handling UDP port(s) requested for punt.
165 The buffer's current data pointer is adjusted to the original packet
166 IPv6 header. All buffers are dispatched to "error-punt".
168 @param vm vlib_main_t corresponding to the current thread
169 @param node vlib_node_runtime_t
170 @param frame vlib_frame_t whose contents should be dispatched
172 @par Graph mechanics: next index usage
175 - <code>vnet_buffer(b)->current_data</code>
176 - <code>vnet_buffer(b)->current_len</code>
179 - Dispatches the packet to the "error-punt" node
181 VLIB_NODE_FN (udp6_punt_node) (vlib_main_t * vm,
182 vlib_node_runtime_t * node,
183 vlib_frame_t * from_frame)
185 return udp46_punt_inline (vm, node, from_frame, 0 /* is_ip4 */ );
189 VLIB_REGISTER_NODE (udp4_punt_node) = {
190 .name = "ip4-udp-punt",
191 /* Takes a vector of packets. */
192 .vector_size = sizeof (u32),
194 .n_errors = PUNT_N_ERROR,
195 .error_strings = punt_error_strings,
197 .n_next_nodes = PUNT_N_NEXT,
199 #define _(s,n) [PUNT_NEXT_##s] = n,
205 VLIB_REGISTER_NODE (udp6_punt_node) = {
206 .name = "ip6-udp-punt",
207 /* Takes a vector of packets. */
208 .vector_size = sizeof (u32),
210 .n_errors = PUNT_N_ERROR,
211 .error_strings = punt_error_strings,
213 .n_next_nodes = PUNT_N_NEXT,
215 #define _(s,n) [PUNT_NEXT_##s] = n,
224 punt_client_t client;
229 format_udp_punt_trace (u8 * s, va_list * args)
231 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
232 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
233 udp_punt_trace_t *t = va_arg (*args, udp_punt_trace_t *);
234 u32 indent = format_get_indent (s);
235 s = format (s, "to: %s", t->client.caddr.sun_path);
238 s = format (s, "\n%U(buffer is part of chain)", format_white_space,
245 punt_socket_inline (vlib_main_t * vm,
246 vlib_node_runtime_t * node,
247 vlib_frame_t * frame,
248 punt_type_t pt, ip_address_family_t af)
250 u32 *buffers = vlib_frame_vector_args (frame);
251 uword n_packets = frame->n_vectors;
252 struct iovec *iovecs = 0;
253 punt_main_t *pm = &punt_main;
256 u32 node_index = AF_IP4 == af ? udp4_punt_socket_node.index :
257 udp6_punt_socket_node.index;
259 for (i = 0; i < n_packets; i++)
264 punt_packetdesc_t packetdesc;
267 b = vlib_get_buffer (vm, buffers[i]);
269 if (PUNT_TYPE_L4 == pt)
271 /* Reverse UDP Punt advance */
275 vlib_buffer_advance (b, -(sizeof (ip4_header_t) +
276 sizeof (udp_header_t)));
277 ip4_header_t *ip = vlib_buffer_get_current (b);
278 udp = (udp_header_t *) (ip + 1);
282 vlib_buffer_advance (b, -(sizeof (ip6_header_t) +
283 sizeof (udp_header_t)));
284 ip6_header_t *ip = vlib_buffer_get_current (b);
285 udp = (udp_header_t *) (ip + 1);
289 * Find registerered client
290 * If no registered client, drop packet and count
292 c = punt_client_l4_get (af, clib_net_to_host_u16 (udp->dst_port));
294 else if (PUNT_TYPE_IP_PROTO == pt)
296 /* Reverse UDP Punt advance */
301 ip4_header_t *ip = vlib_buffer_get_current (b);
302 proto = ip->protocol;
306 ip6_header_t *ip = vlib_buffer_get_current (b);
307 proto = ip->protocol;
310 c = punt_client_ip_proto_get (af, proto);
312 else if (PUNT_TYPE_EXCEPTION == pt)
314 c = punt_client_exception_get (b->punt_reason);
319 if (PREDICT_FALSE (NULL == c))
321 vlib_node_increment_counter (vm, node_index,
322 PUNT_ERROR_SOCKET_TX_ERROR, 1);
326 struct sockaddr_un *caddr = &c->caddr;
328 if (PREDICT_FALSE (b->flags & VLIB_BUFFER_IS_TRACED))
331 t = vlib_add_trace (vm, node, b, sizeof (t[0]));
332 clib_memcpy_fast (&t->client, c, sizeof (t->client));
335 /* Re-set iovecs if present. */
337 _vec_len (iovecs) = 0;
339 /* Add packet descriptor */
340 packetdesc.sw_if_index = vnet_buffer (b)->sw_if_index[VLIB_RX];
341 packetdesc.action = 0;
342 vec_add2 (iovecs, iov, 1);
343 iov->iov_base = &packetdesc;
344 iov->iov_len = sizeof (packetdesc);
346 /** VLIB buffer chain -> Unix iovec(s). */
347 vlib_buffer_advance (b, -(sizeof (ethernet_header_t)));
348 vec_add2 (iovecs, iov, 1);
349 iov->iov_base = b->data + b->current_data;
350 iov->iov_len = l = b->current_length;
352 if (PREDICT_FALSE (b->flags & VLIB_BUFFER_NEXT_PRESENT))
356 b = vlib_get_buffer (vm, b->next_buffer);
357 if (PREDICT_FALSE (b->flags & VLIB_BUFFER_IS_TRACED))
360 t = vlib_add_trace (vm, node, b, sizeof (t[0]));
361 clib_memcpy_fast (&t->client, c, sizeof (t->client));
365 vec_add2 (iovecs, iov, 1);
367 iov->iov_base = b->data + b->current_data;
368 iov->iov_len = b->current_length;
369 l += b->current_length;
371 while (b->flags & VLIB_BUFFER_NEXT_PRESENT);
374 struct msghdr msg = {
376 .msg_namelen = sizeof (*caddr),
378 .msg_iovlen = vec_len (iovecs),
381 if (sendmsg (pm->socket_fd, &msg, 0) < (ssize_t) l)
382 vlib_node_increment_counter (vm, node_index,
383 PUNT_ERROR_SOCKET_TX_ERROR, 1);
385 vlib_node_increment_counter (vm, node_index, PUNT_ERROR_SOCKET_TX, 1);
389 vlib_buffer_free (vm, buffers, n_packets);
395 udp4_punt_socket (vlib_main_t * vm,
396 vlib_node_runtime_t * node, vlib_frame_t * from_frame)
398 return punt_socket_inline (vm, node, from_frame, PUNT_TYPE_L4, AF_IP4);
402 udp6_punt_socket (vlib_main_t * vm,
403 vlib_node_runtime_t * node, vlib_frame_t * from_frame)
405 return punt_socket_inline (vm, node, from_frame, PUNT_TYPE_L4, AF_IP6);
409 ip4_proto_punt_socket (vlib_main_t * vm,
410 vlib_node_runtime_t * node, vlib_frame_t * from_frame)
412 return punt_socket_inline (vm, node, from_frame,
413 PUNT_TYPE_IP_PROTO, AF_IP4);
417 ip6_proto_punt_socket (vlib_main_t * vm,
418 vlib_node_runtime_t * node, vlib_frame_t * from_frame)
420 return punt_socket_inline (vm, node, from_frame,
421 PUNT_TYPE_IP_PROTO, AF_IP6);
425 exception_punt_socket (vlib_main_t * vm,
426 vlib_node_runtime_t * node, vlib_frame_t * from_frame)
428 return punt_socket_inline (vm, node, from_frame,
429 PUNT_TYPE_EXCEPTION, AF_IP4);
434 VLIB_REGISTER_NODE (udp4_punt_socket_node) = {
435 .function = udp4_punt_socket,
436 .name = "ip4-udp-punt-socket",
437 .format_trace = format_udp_punt_trace,
438 .flags = VLIB_NODE_FLAG_IS_DROP,
439 /* Takes a vector of packets. */
440 .vector_size = sizeof (u32),
441 .n_errors = PUNT_N_ERROR,
442 .error_strings = punt_error_strings,
444 VLIB_REGISTER_NODE (udp6_punt_socket_node) = {
445 .function = udp6_punt_socket,
446 .name = "ip6-udp-punt-socket",
447 .format_trace = format_udp_punt_trace,
448 .flags = VLIB_NODE_FLAG_IS_DROP,
449 .vector_size = sizeof (u32),
450 .n_errors = PUNT_N_ERROR,
451 .error_strings = punt_error_strings,
453 VLIB_REGISTER_NODE (ip4_proto_punt_socket_node) = {
454 .function = ip4_proto_punt_socket,
455 .name = "ip4-proto-punt-socket",
456 .format_trace = format_udp_punt_trace,
457 .flags = VLIB_NODE_FLAG_IS_DROP,
458 /* Takes a vector of packets. */
459 .vector_size = sizeof (u32),
460 .n_errors = PUNT_N_ERROR,
461 .error_strings = punt_error_strings,
463 VLIB_REGISTER_NODE (ip6_proto_punt_socket_node) = {
464 .function = ip6_proto_punt_socket,
465 .name = "ip6-proto-punt-socket",
466 .format_trace = format_udp_punt_trace,
467 .flags = VLIB_NODE_FLAG_IS_DROP,
468 .vector_size = sizeof (u32),
469 .n_errors = PUNT_N_ERROR,
470 .error_strings = punt_error_strings,
472 VLIB_REGISTER_NODE (exception_punt_socket_node) = {
473 .function = exception_punt_socket,
474 .name = "exception-punt-socket",
475 .format_trace = format_udp_punt_trace,
476 .flags = VLIB_NODE_FLAG_IS_DROP,
477 .vector_size = sizeof (u32),
478 .n_errors = PUNT_N_ERROR,
479 .error_strings = punt_error_strings,
485 enum punt_action_e action;
490 format_punt_trace (u8 * s, va_list * va)
492 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*va, vlib_main_t *);
493 CLIB_UNUSED (vlib_node_t * node) = va_arg (*va, vlib_node_t *);
494 vnet_main_t *vnm = vnet_get_main ();
495 punt_trace_t *t = va_arg (*va, punt_trace_t *);
496 s = format (s, "%U Action: %d", format_vnet_sw_if_index_name,
497 vnm, t->sw_if_index, t->action);
502 punt_socket_rx_fd (vlib_main_t * vm, vlib_node_runtime_t * node, u32 fd)
504 const uword buffer_size = vlib_buffer_get_default_data_size (vm);
505 u32 n_trace = vlib_get_trace_count (vm, node);
506 u32 next = node->cached_next_index;
507 u32 n_left_to_next, next_index;
509 u32 error = PUNT_ERROR_NONE;
510 vlib_get_next_frame (vm, node, next, to_next, n_left_to_next);
512 /* $$$$ Only dealing with one buffer at the time for now */
516 punt_packetdesc_t packetdesc;
520 if (vlib_buffer_alloc (vm, &bi, 1) != 1)
522 error = PUNT_ERROR_NOBUFFER;
526 b = vlib_get_buffer (vm, bi);
527 io[0].iov_base = &packetdesc;
528 io[0].iov_len = sizeof (packetdesc);
529 io[1].iov_base = b->data;
530 io[1].iov_len = buffer_size;
532 size = readv (fd, io, 2);
533 /* We need at least the packet descriptor plus a header */
534 if (size <= (int) (sizeof (packetdesc) + sizeof (ip4_header_t)))
536 vlib_buffer_free (vm, &bi, 1);
537 error = PUNT_ERROR_READV;
541 b->flags = VNET_BUFFER_F_LOCALLY_ORIGINATED;
542 b->current_length = size - sizeof (packetdesc);
544 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b);
546 switch (packetdesc.action)
549 vnet_buffer (b)->sw_if_index[VLIB_TX] = packetdesc.sw_if_index;
550 next_index = PUNT_SOCKET_RX_NEXT_INTERFACE_OUTPUT;
553 case PUNT_IP4_ROUTED:
554 vnet_buffer (b)->sw_if_index[VLIB_RX] = packetdesc.sw_if_index;
555 vnet_buffer (b)->sw_if_index[VLIB_TX] = ~0;
556 next_index = PUNT_SOCKET_RX_NEXT_IP4_LOOKUP;
559 case PUNT_IP6_ROUTED:
560 vnet_buffer (b)->sw_if_index[VLIB_RX] = packetdesc.sw_if_index;
561 vnet_buffer (b)->sw_if_index[VLIB_TX] = ~0;
562 next_index = PUNT_SOCKET_RX_NEXT_IP6_LOOKUP;
566 error = PUNT_ERROR_ACTION;
567 vlib_buffer_free (vm, &bi, 1);
571 if (PREDICT_FALSE (n_trace > 0))
574 vlib_trace_buffer (vm, node, next_index, b, 1 /* follow_chain */ );
575 vlib_set_trace_count (vm, node, --n_trace);
576 t = vlib_add_trace (vm, node, b, sizeof (*t));
577 t->sw_if_index = packetdesc.sw_if_index;
578 t->action = packetdesc.action;
585 vlib_validate_buffer_enqueue_x1 (vm, node, next, to_next, n_left_to_next,
587 vlib_put_next_frame (vm, node, next, n_left_to_next);
591 vlib_node_increment_counter (vm, punt_socket_rx_node.index, error, 1);
596 punt_socket_rx (vlib_main_t * vm,
597 vlib_node_runtime_t * node, vlib_frame_t * frame)
599 punt_main_t *pm = &punt_main;
603 for (i = 0; i < vec_len (pm->ready_fds); i++)
605 total_count += punt_socket_rx_fd (vm, node, pm->ready_fds[i]);
606 vec_del1 (pm->ready_fds, i);
612 VLIB_REGISTER_NODE (punt_socket_rx_node) =
614 .function = punt_socket_rx,
615 .name = "punt-socket-rx",
616 .type = VLIB_NODE_TYPE_INPUT,
617 .state = VLIB_NODE_STATE_INTERRUPT,
619 .n_errors = PUNT_N_ERROR,
620 .error_strings = punt_error_strings,
621 .n_next_nodes = PUNT_SOCKET_RX_N_NEXT,
623 [PUNT_SOCKET_RX_NEXT_INTERFACE_OUTPUT] = "interface-output",
624 [PUNT_SOCKET_RX_NEXT_IP4_LOOKUP] = "ip4-lookup",
625 [PUNT_SOCKET_RX_NEXT_IP6_LOOKUP] = "ip6-lookup",
627 .format_trace = format_punt_trace,
632 * fd.io coding-style-patch-verification: ON
635 * eval: (c-set-style "gnu")