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/udp/udp.h>
28 #include <vnet/tcp/tcp.h>
29 #include <vnet/ip/punt.h>
30 #include <vlib/unix/unix.h>
34 #include <sys/socket.h>
40 #define punt_error(n,s) PUNT_ERROR_##n,
41 #include <vnet/ip/punt_error.def>
46 #define foreach_punt_next \
47 _ (PUNT4, "ip4-punt") \
52 #define _(s,n) PUNT_NEXT_##s,
58 enum punt_socket_rx_next_e
60 PUNT_SOCKET_RX_NEXT_INTERFACE_OUTPUT,
61 PUNT_SOCKET_RX_NEXT_IP4_LOOKUP,
62 PUNT_SOCKET_RX_NEXT_IP6_LOOKUP,
66 #define punt_next_punt(is_ip4) (is_ip4 ? PUNT_NEXT_PUNT4 : PUNT_NEXT_PUNT6)
68 /** @brief IPv4/IPv6 UDP punt node main loop.
70 This is the main loop inline function for IPv4/IPv6 UDP punt
73 @param vm vlib_main_t corresponding to the current thread
74 @param node vlib_node_runtime_t
75 @param frame vlib_frame_t whose contents should be dispatched
76 @param is_ipv4 indicates if called for IPv4 or IPv6 node
79 udp46_punt_inline (vlib_main_t * vm,
80 vlib_node_runtime_t * node,
81 vlib_frame_t * from_frame, int is_ip4)
83 u32 n_left_from, *from, *to_next;
86 from = vlib_frame_vector_args (from_frame);
87 n_left_from = from_frame->n_vectors;
89 /* udp[46]_lookup hands us the data payload, not the IP header */
91 advance = -(sizeof (ip4_header_t) + sizeof (udp_header_t));
93 advance = -(sizeof (ip6_header_t) + sizeof (udp_header_t));
95 while (n_left_from > 0)
99 vlib_get_next_frame (vm, node, punt_next_punt (is_ip4), to_next,
102 while (n_left_from > 0 && n_left_to_next > 0)
114 b0 = vlib_get_buffer (vm, bi0);
115 vlib_buffer_advance (b0, advance);
116 b0->error = node->errors[PUNT_ERROR_UDP_PORT];
119 vlib_put_next_frame (vm, node, punt_next_punt (is_ip4), n_left_to_next);
122 return from_frame->n_vectors;
125 static char *punt_error_strings[] = {
126 #define punt_error(n,s) s,
127 #include "punt_error.def"
131 /** @brief IPv4 UDP punt node.
134 This is the IPv4 UDP punt transition node. It is registered as a next
135 node for the "ip4-udp-lookup" handling UDP port(s) requested for punt.
136 The buffer's current data pointer is adjusted to the original packet
137 IPv4 header. All buffers are dispatched to "error-punt".
139 @param vm vlib_main_t corresponding to the current thread
140 @param node vlib_node_runtime_t
141 @param frame vlib_frame_t whose contents should be dispatched
143 @par Graph mechanics: next index usage
146 - <code>vnet_buffer(b)->current_data</code>
147 - <code>vnet_buffer(b)->current_len</code>
150 - Dispatches the packet to the "error-punt" node
152 VLIB_NODE_FN (udp4_punt_node) (vlib_main_t * vm,
153 vlib_node_runtime_t * node,
154 vlib_frame_t * from_frame)
156 return udp46_punt_inline (vm, node, from_frame, 1 /* is_ip4 */ );
159 /** @brief IPv6 UDP punt node.
162 This is the IPv6 UDP punt transition node. It is registered as a next
163 node for the "ip6-udp-lookup" handling UDP port(s) requested for punt.
164 The buffer's current data pointer is adjusted to the original packet
165 IPv6 header. All buffers are dispatched to "error-punt".
167 @param vm vlib_main_t corresponding to the current thread
168 @param node vlib_node_runtime_t
169 @param frame vlib_frame_t whose contents should be dispatched
171 @par Graph mechanics: next index usage
174 - <code>vnet_buffer(b)->current_data</code>
175 - <code>vnet_buffer(b)->current_len</code>
178 - Dispatches the packet to the "error-punt" node
180 VLIB_NODE_FN (udp6_punt_node) (vlib_main_t * vm,
181 vlib_node_runtime_t * node,
182 vlib_frame_t * from_frame)
184 return udp46_punt_inline (vm, node, from_frame, 0 /* is_ip4 */ );
188 VLIB_REGISTER_NODE (udp4_punt_node) = {
189 .name = "ip4-udp-punt",
190 /* Takes a vector of packets. */
191 .vector_size = sizeof (u32),
193 .n_errors = PUNT_N_ERROR,
194 .error_strings = punt_error_strings,
196 .n_next_nodes = PUNT_N_NEXT,
198 #define _(s,n) [PUNT_NEXT_##s] = n,
204 VLIB_REGISTER_NODE (udp6_punt_node) = {
205 .name = "ip6-udp-punt",
206 /* Takes a vector of packets. */
207 .vector_size = sizeof (u32),
209 .n_errors = PUNT_N_ERROR,
210 .error_strings = punt_error_strings,
212 .n_next_nodes = PUNT_N_NEXT,
214 #define _(s,n) [PUNT_NEXT_##s] = n,
223 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,
241 s = format (s, "\n%U%U", format_white_space, indent,
242 format_hex_bytes, t->packet_data, sizeof (t->packet_data));
248 punt_socket_inline (vlib_main_t * vm,
249 vlib_node_runtime_t * node,
250 vlib_frame_t * frame,
251 punt_type_t pt, ip_address_family_t af)
253 u32 *buffers = vlib_frame_vector_args (frame);
254 u32 thread_index = vm->thread_index;
255 uword n_packets = frame->n_vectors;
256 punt_main_t *pm = &punt_main;
259 punt_thread_data_t *ptd = &pm->thread_data[thread_index];
260 u32 node_index = (AF_IP4 == af ?
261 udp4_punt_socket_node.index :
262 udp6_punt_socket_node.index);
264 for (i = 0; i < n_packets; i++)
269 punt_packetdesc_t packetdesc;
272 b = vlib_get_buffer (vm, buffers[i]);
274 if (PUNT_TYPE_L4 == pt)
276 /* Reverse UDP Punt advance */
280 vlib_buffer_advance (b, -(sizeof (ip4_header_t) +
281 sizeof (udp_header_t)));
282 ip4_header_t *ip = vlib_buffer_get_current (b);
283 udp = (udp_header_t *) (ip + 1);
287 vlib_buffer_advance (b, -(sizeof (ip6_header_t) +
288 sizeof (udp_header_t)));
289 ip6_header_t *ip = vlib_buffer_get_current (b);
290 udp = (udp_header_t *) (ip + 1);
294 * Find registerered client
295 * If no registered client, drop packet and count
297 c = punt_client_l4_get (af, clib_net_to_host_u16 (udp->dst_port));
299 else if (PUNT_TYPE_IP_PROTO == pt)
301 /* Reverse UDP Punt advance */
306 ip4_header_t *ip = vlib_buffer_get_current (b);
307 proto = ip->protocol;
311 ip6_header_t *ip = vlib_buffer_get_current (b);
312 proto = ip->protocol;
315 c = punt_client_ip_proto_get (af, proto);
317 else if (PUNT_TYPE_EXCEPTION == pt)
319 c = punt_client_exception_get (b->punt_reason);
324 if (PREDICT_FALSE (NULL == c))
326 vlib_node_increment_counter (vm, node_index,
327 PUNT_ERROR_SOCKET_TX_ERROR, 1);
331 struct sockaddr_un *caddr = &c->caddr;
334 vec_reset_length (ptd->iovecs);
336 /* Add packet descriptor */
337 packetdesc.sw_if_index = vnet_buffer (b)->sw_if_index[VLIB_RX];
338 packetdesc.action = 0;
339 vec_add2 (ptd->iovecs, iov, 1);
340 iov->iov_base = &packetdesc;
341 iov->iov_len = sizeof (packetdesc);
343 /** VLIB buffer chain -> Unix iovec(s). */
344 vlib_buffer_advance (b, -(sizeof (ethernet_header_t)));
345 vec_add2 (ptd->iovecs, iov, 1);
346 iov->iov_base = b->data + b->current_data;
347 iov->iov_len = l = b->current_length;
349 if (PREDICT_FALSE (b->flags & VLIB_BUFFER_IS_TRACED))
352 t = vlib_add_trace (vm, node, b, sizeof (t[0]));
353 clib_memcpy_fast (&t->client, c, sizeof (t->client));
354 clib_memcpy_fast (t->packet_data,
355 vlib_buffer_get_current (b),
356 sizeof (t->packet_data));
359 if (PREDICT_FALSE (b->flags & VLIB_BUFFER_NEXT_PRESENT))
363 b = vlib_get_buffer (vm, b->next_buffer);
364 if (PREDICT_FALSE (b->flags & VLIB_BUFFER_IS_TRACED))
367 t = vlib_add_trace (vm, node, b, sizeof (t[0]));
368 clib_memcpy_fast (&t->client, c, sizeof (t->client));
372 vec_add2 (ptd->iovecs, iov, 1);
374 iov->iov_base = b->data + b->current_data;
375 iov->iov_len = b->current_length;
376 l += b->current_length;
378 while (b->flags & VLIB_BUFFER_NEXT_PRESENT);
381 struct msghdr msg = {
383 .msg_namelen = sizeof (*caddr),
384 .msg_iov = ptd->iovecs,
385 .msg_iovlen = vec_len (ptd->iovecs),
388 if (sendmsg (pm->socket_fd, &msg, 0) < (ssize_t) l)
389 vlib_node_increment_counter (vm, node_index,
390 PUNT_ERROR_SOCKET_TX_ERROR, 1);
392 vlib_node_increment_counter (vm, node_index, PUNT_ERROR_SOCKET_TX, 1);
396 vlib_buffer_free (vm, buffers, n_packets);
402 udp4_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_IP4);
409 udp6_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, PUNT_TYPE_L4, AF_IP6);
416 ip4_proto_punt_socket (vlib_main_t * vm,
417 vlib_node_runtime_t * node, vlib_frame_t * from_frame)
419 return punt_socket_inline (vm, node, from_frame,
420 PUNT_TYPE_IP_PROTO, AF_IP4);
424 ip6_proto_punt_socket (vlib_main_t * vm,
425 vlib_node_runtime_t * node, vlib_frame_t * from_frame)
427 return punt_socket_inline (vm, node, from_frame,
428 PUNT_TYPE_IP_PROTO, AF_IP6);
432 exception_punt_socket (vlib_main_t * vm,
433 vlib_node_runtime_t * node, vlib_frame_t * from_frame)
435 return punt_socket_inline (vm, node, from_frame,
436 PUNT_TYPE_EXCEPTION, AF_IP4);
441 VLIB_REGISTER_NODE (udp4_punt_socket_node) = {
442 .function = udp4_punt_socket,
443 .name = "ip4-udp-punt-socket",
444 .format_trace = format_udp_punt_trace,
445 .flags = VLIB_NODE_FLAG_IS_DROP,
446 /* Takes a vector of packets. */
447 .vector_size = sizeof (u32),
448 .n_errors = PUNT_N_ERROR,
449 .error_strings = punt_error_strings,
451 VLIB_REGISTER_NODE (udp6_punt_socket_node) = {
452 .function = udp6_punt_socket,
453 .name = "ip6-udp-punt-socket",
454 .format_trace = format_udp_punt_trace,
455 .flags = VLIB_NODE_FLAG_IS_DROP,
456 .vector_size = sizeof (u32),
457 .n_errors = PUNT_N_ERROR,
458 .error_strings = punt_error_strings,
460 VLIB_REGISTER_NODE (ip4_proto_punt_socket_node) = {
461 .function = ip4_proto_punt_socket,
462 .name = "ip4-proto-punt-socket",
463 .format_trace = format_udp_punt_trace,
464 .flags = VLIB_NODE_FLAG_IS_DROP,
465 /* Takes a vector of packets. */
466 .vector_size = sizeof (u32),
467 .n_errors = PUNT_N_ERROR,
468 .error_strings = punt_error_strings,
470 VLIB_REGISTER_NODE (ip6_proto_punt_socket_node) = {
471 .function = ip6_proto_punt_socket,
472 .name = "ip6-proto-punt-socket",
473 .format_trace = format_udp_punt_trace,
474 .flags = VLIB_NODE_FLAG_IS_DROP,
475 .vector_size = sizeof (u32),
476 .n_errors = PUNT_N_ERROR,
477 .error_strings = punt_error_strings,
479 VLIB_REGISTER_NODE (exception_punt_socket_node) = {
480 .function = exception_punt_socket,
481 .name = "exception-punt-socket",
482 .format_trace = format_udp_punt_trace,
483 .flags = VLIB_NODE_FLAG_IS_DROP,
484 .vector_size = sizeof (u32),
485 .n_errors = PUNT_N_ERROR,
486 .error_strings = punt_error_strings,
492 enum punt_action_e action;
497 format_punt_trace (u8 * s, va_list * va)
499 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*va, vlib_main_t *);
500 CLIB_UNUSED (vlib_node_t * node) = va_arg (*va, vlib_node_t *);
501 vnet_main_t *vnm = vnet_get_main ();
502 punt_trace_t *t = va_arg (*va, punt_trace_t *);
503 s = format (s, "%U Action: %d", format_vnet_sw_if_index_name,
504 vnm, t->sw_if_index, t->action);
509 punt_socket_rx_fd (vlib_main_t * vm, vlib_node_runtime_t * node, u32 fd)
511 const uword buffer_size = vlib_buffer_get_default_data_size (vm);
512 u32 n_trace = vlib_get_trace_count (vm, node);
513 u32 next = node->cached_next_index;
514 u32 n_left_to_next, next_index;
516 u32 error = PUNT_ERROR_NONE;
517 vlib_get_next_frame (vm, node, next, to_next, n_left_to_next);
519 /* $$$$ Only dealing with one buffer at the time for now */
523 punt_packetdesc_t packetdesc;
527 if (vlib_buffer_alloc (vm, &bi, 1) != 1)
529 error = PUNT_ERROR_NOBUFFER;
533 b = vlib_get_buffer (vm, bi);
534 io[0].iov_base = &packetdesc;
535 io[0].iov_len = sizeof (packetdesc);
536 io[1].iov_base = b->data;
537 io[1].iov_len = buffer_size;
539 size = readv (fd, io, 2);
540 /* We need at least the packet descriptor plus a header */
541 if (size <= (int) (sizeof (packetdesc) + sizeof (ip4_header_t)))
543 vlib_buffer_free (vm, &bi, 1);
544 error = PUNT_ERROR_READV;
548 b->flags = VNET_BUFFER_F_LOCALLY_ORIGINATED;
549 b->current_length = size - sizeof (packetdesc);
551 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b);
553 switch (packetdesc.action)
556 vnet_buffer (b)->sw_if_index[VLIB_TX] = packetdesc.sw_if_index;
557 next_index = PUNT_SOCKET_RX_NEXT_INTERFACE_OUTPUT;
560 case PUNT_IP4_ROUTED:
561 vnet_buffer (b)->sw_if_index[VLIB_RX] = packetdesc.sw_if_index;
562 vnet_buffer (b)->sw_if_index[VLIB_TX] = ~0;
563 next_index = PUNT_SOCKET_RX_NEXT_IP4_LOOKUP;
566 case PUNT_IP6_ROUTED:
567 vnet_buffer (b)->sw_if_index[VLIB_RX] = packetdesc.sw_if_index;
568 vnet_buffer (b)->sw_if_index[VLIB_TX] = ~0;
569 next_index = PUNT_SOCKET_RX_NEXT_IP6_LOOKUP;
573 error = PUNT_ERROR_ACTION;
574 vlib_buffer_free (vm, &bi, 1);
578 if (PREDICT_FALSE (n_trace > 0))
581 vlib_trace_buffer (vm, node, next_index, b, 1 /* follow_chain */ );
582 vlib_set_trace_count (vm, node, --n_trace);
583 t = vlib_add_trace (vm, node, b, sizeof (*t));
584 t->sw_if_index = packetdesc.sw_if_index;
585 t->action = packetdesc.action;
592 vlib_validate_buffer_enqueue_x1 (vm, node, next, to_next, n_left_to_next,
594 vlib_put_next_frame (vm, node, next, n_left_to_next);
598 vlib_put_next_frame (vm, node, next, n_left_to_next);
599 vlib_node_increment_counter (vm, punt_socket_rx_node.index, error, 1);
604 punt_socket_rx (vlib_main_t * vm,
605 vlib_node_runtime_t * node, vlib_frame_t * frame)
607 punt_main_t *pm = &punt_main;
611 for (i = 0; i < vec_len (pm->ready_fds); i++)
613 total_count += punt_socket_rx_fd (vm, node, pm->ready_fds[i]);
614 vec_del1 (pm->ready_fds, i);
620 VLIB_REGISTER_NODE (punt_socket_rx_node) =
622 .function = punt_socket_rx,
623 .name = "punt-socket-rx",
624 .flags = VLIB_NODE_FLAG_TRACE_SUPPORTED,
625 .type = VLIB_NODE_TYPE_INPUT,
626 .state = VLIB_NODE_STATE_INTERRUPT,
628 .n_errors = PUNT_N_ERROR,
629 .error_strings = punt_error_strings,
630 .n_next_nodes = PUNT_SOCKET_RX_N_NEXT,
632 [PUNT_SOCKET_RX_NEXT_INTERFACE_OUTPUT] = "interface-output",
633 [PUNT_SOCKET_RX_NEXT_IP4_LOOKUP] = "ip4-lookup",
634 [PUNT_SOCKET_RX_NEXT_IP6_LOOKUP] = "ip6-lookup",
636 .format_trace = format_punt_trace,
641 * fd.io coding-style-patch-verification: ON
644 * eval: (c-set-style "gnu")