VPP-598: tcp stack initial commit
[vpp.git] / src / vnet / udp / udp_local.c
1 /*
2  * node.c: udp packet processing
3  *
4  * Copyright (c) 2013 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 <vlib/vlib.h>
19 #include <vnet/pg/pg.h>
20 #include <vnet/udp/udp.h>
21 #include <vnet/udp/udp_packet.h>
22 #include <vppinfra/sparse_vec.h>
23
24 udp_main_t udp_main;
25
26 #define foreach_udp_input_next                  \
27   _ (PUNT, "error-punt")                        \
28   _ (DROP, "error-drop")                        \
29   _ (ICMP4_ERROR, "ip4-icmp-error")             \
30   _ (ICMP6_ERROR, "ip6-icmp-error")
31
32 typedef enum
33 {
34 #define _(s,n) UDP_INPUT_NEXT_##s,
35   foreach_udp_input_next
36 #undef _
37     UDP_INPUT_N_NEXT,
38 } udp_input_next_t;
39
40 typedef struct
41 {
42   u16 src_port;
43   u16 dst_port;
44   u8 bound;
45 } udp_rx_trace_t;
46
47 u8 *
48 format_udp_rx_trace (u8 * s, va_list * args)
49 {
50   CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
51   CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
52   udp_rx_trace_t *t = va_arg (*args, udp_rx_trace_t *);
53
54   s = format (s, "UDP: src-port %d dst-port %d%s",
55               clib_net_to_host_u16 (t->src_port),
56               clib_net_to_host_u16 (t->dst_port),
57               t->bound ? "" : " (no listener)");
58   return s;
59 }
60
61 typedef struct
62 {
63   /* Sparse vector mapping udp dst_port in network byte order
64      to next index. */
65   u16 *next_by_dst_port;
66   u8 punt_unknown;
67 } udp_input_runtime_t;
68
69 vlib_node_registration_t udp4_input_node;
70 vlib_node_registration_t udp6_input_node;
71
72 always_inline uword
73 udp46_input_inline (vlib_main_t * vm,
74                     vlib_node_runtime_t * node,
75                     vlib_frame_t * from_frame, int is_ip4)
76 {
77   udp_input_runtime_t *rt = is_ip4 ?
78     (void *) vlib_node_get_runtime_data (vm, udp4_input_node.index)
79     : (void *) vlib_node_get_runtime_data (vm, udp6_input_node.index);
80   __attribute__ ((unused)) u32 n_left_from, next_index, *from, *to_next;
81   word n_no_listener = 0;
82   u8 punt_unknown = rt->punt_unknown;
83
84   from = vlib_frame_vector_args (from_frame);
85   n_left_from = from_frame->n_vectors;
86
87   next_index = node->cached_next_index;
88
89   while (n_left_from > 0)
90     {
91       u32 n_left_to_next;
92
93       vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
94
95       while (n_left_from >= 4 && n_left_to_next >= 2)
96         {
97           u32 bi0, bi1;
98           vlib_buffer_t *b0, *b1;
99           udp_header_t *h0 = 0, *h1 = 0;
100           u32 i0, i1, dst_port0, dst_port1;
101           u32 advance0, advance1;
102           u32 error0, next0, error1, next1;
103
104           /* Prefetch next iteration. */
105           {
106             vlib_buffer_t *p2, *p3;
107
108             p2 = vlib_get_buffer (vm, from[2]);
109             p3 = vlib_get_buffer (vm, from[3]);
110
111             vlib_prefetch_buffer_header (p2, LOAD);
112             vlib_prefetch_buffer_header (p3, LOAD);
113
114             CLIB_PREFETCH (p2->data, sizeof (h0[0]), LOAD);
115             CLIB_PREFETCH (p3->data, sizeof (h1[0]), LOAD);
116           }
117
118           bi0 = from[0];
119           bi1 = from[1];
120           to_next[0] = bi0;
121           to_next[1] = bi1;
122           from += 2;
123           to_next += 2;
124           n_left_to_next -= 2;
125           n_left_from -= 2;
126
127           b0 = vlib_get_buffer (vm, bi0);
128           b1 = vlib_get_buffer (vm, bi1);
129
130           /* ip4/6_local hands us the ip header, not the udp header */
131           if (is_ip4)
132             {
133               advance0 = sizeof (ip4_header_t);
134               advance1 = sizeof (ip4_header_t);
135             }
136           else
137             {
138               advance0 = sizeof (ip6_header_t);
139               advance1 = sizeof (ip6_header_t);
140             }
141
142           if (PREDICT_FALSE (b0->current_length < advance0 + sizeof (*h0)))
143             {
144               error0 = UDP_ERROR_LENGTH_ERROR;
145               next0 = UDP_INPUT_NEXT_DROP;
146             }
147           else
148             {
149               vlib_buffer_advance (b0, advance0);
150               h0 = vlib_buffer_get_current (b0);
151               error0 = next0 = 0;
152               if (PREDICT_FALSE (clib_net_to_host_u16 (h0->length) >
153                                  vlib_buffer_length_in_chain (vm, b0)))
154                 {
155                   error0 = UDP_ERROR_LENGTH_ERROR;
156                   next0 = UDP_INPUT_NEXT_DROP;
157                 }
158             }
159
160           if (PREDICT_FALSE (b1->current_length < advance1 + sizeof (*h1)))
161             {
162               error1 = UDP_ERROR_LENGTH_ERROR;
163               next1 = UDP_INPUT_NEXT_DROP;
164             }
165           else
166             {
167               vlib_buffer_advance (b1, advance1);
168               h1 = vlib_buffer_get_current (b1);
169               error1 = next1 = 0;
170               if (PREDICT_FALSE (clib_net_to_host_u16 (h1->length) >
171                                  vlib_buffer_length_in_chain (vm, b1)))
172                 {
173                   error1 = UDP_ERROR_LENGTH_ERROR;
174                   next1 = UDP_INPUT_NEXT_DROP;
175                 }
176             }
177
178           /* Index sparse array with network byte order. */
179           dst_port0 = (error0 == 0) ? h0->dst_port : 0;
180           dst_port1 = (error1 == 0) ? h1->dst_port : 0;
181           sparse_vec_index2 (rt->next_by_dst_port, dst_port0, dst_port1,
182                              &i0, &i1);
183           next0 = (error0 == 0) ? vec_elt (rt->next_by_dst_port, i0) : next0;
184           next1 = (error1 == 0) ? vec_elt (rt->next_by_dst_port, i1) : next1;
185
186           if (PREDICT_FALSE (i0 == SPARSE_VEC_INVALID_INDEX))
187             {
188               // move the pointer back so icmp-error can find the
189               // ip packet header
190               vlib_buffer_advance (b0, -(word) advance0);
191
192               if (PREDICT_FALSE (punt_unknown))
193                 {
194                   b0->error = node->errors[UDP_ERROR_PUNT];
195                   next0 = UDP_INPUT_NEXT_PUNT;
196                 }
197               else if (is_ip4)
198                 {
199                   icmp4_error_set_vnet_buffer (b0,
200                                                ICMP4_destination_unreachable,
201                                                ICMP4_destination_unreachable_port_unreachable,
202                                                0);
203                   next0 = UDP_INPUT_NEXT_ICMP4_ERROR;
204                   n_no_listener++;
205                 }
206               else
207                 {
208                   icmp6_error_set_vnet_buffer (b0,
209                                                ICMP6_destination_unreachable,
210                                                ICMP6_destination_unreachable_port_unreachable,
211                                                0);
212                   next0 = UDP_INPUT_NEXT_ICMP6_ERROR;
213                   n_no_listener++;
214                 }
215             }
216           else
217             {
218               b0->error = node->errors[UDP_ERROR_NONE];
219               // advance to the payload
220               vlib_buffer_advance (b0, sizeof (*h0));
221             }
222
223           if (PREDICT_FALSE (i1 == SPARSE_VEC_INVALID_INDEX))
224             {
225               // move the pointer back so icmp-error can find the
226               // ip packet header
227               vlib_buffer_advance (b1, -(word) advance1);
228
229               if (PREDICT_FALSE (punt_unknown))
230                 {
231                   b1->error = node->errors[UDP_ERROR_PUNT];
232                   next1 = UDP_INPUT_NEXT_PUNT;
233                 }
234               else if (is_ip4)
235                 {
236                   icmp4_error_set_vnet_buffer (b1,
237                                                ICMP4_destination_unreachable,
238                                                ICMP4_destination_unreachable_port_unreachable,
239                                                0);
240                   next1 = UDP_INPUT_NEXT_ICMP4_ERROR;
241                   n_no_listener++;
242                 }
243               else
244                 {
245                   icmp6_error_set_vnet_buffer (b1,
246                                                ICMP6_destination_unreachable,
247                                                ICMP6_destination_unreachable_port_unreachable,
248                                                0);
249                   next1 = UDP_INPUT_NEXT_ICMP6_ERROR;
250                   n_no_listener++;
251                 }
252             }
253           else
254             {
255               b1->error = node->errors[UDP_ERROR_NONE];
256               // advance to the payload
257               vlib_buffer_advance (b1, sizeof (*h1));
258             }
259
260           if (PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
261             {
262               udp_rx_trace_t *tr = vlib_add_trace (vm, node,
263                                                    b0, sizeof (*tr));
264               if (b0->error != node->errors[UDP_ERROR_LENGTH_ERROR])
265                 {
266                   tr->src_port = h0 ? h0->src_port : 0;
267                   tr->dst_port = h0 ? h0->dst_port : 0;
268                   tr->bound = (next0 != UDP_INPUT_NEXT_ICMP4_ERROR &&
269                                next0 != UDP_INPUT_NEXT_ICMP6_ERROR);
270                 }
271             }
272           if (PREDICT_FALSE (b1->flags & VLIB_BUFFER_IS_TRACED))
273             {
274               udp_rx_trace_t *tr = vlib_add_trace (vm, node,
275                                                    b1, sizeof (*tr));
276               if (b1->error != node->errors[UDP_ERROR_LENGTH_ERROR])
277                 {
278                   tr->src_port = h1 ? h1->src_port : 0;
279                   tr->dst_port = h1 ? h1->dst_port : 0;
280                   tr->bound = (next1 != UDP_INPUT_NEXT_ICMP4_ERROR &&
281                                next1 != UDP_INPUT_NEXT_ICMP6_ERROR);
282                 }
283             }
284
285           vlib_validate_buffer_enqueue_x2 (vm, node, next_index,
286                                            to_next, n_left_to_next,
287                                            bi0, bi1, next0, next1);
288         }
289
290       while (n_left_from > 0 && n_left_to_next > 0)
291         {
292           u32 bi0;
293           vlib_buffer_t *b0;
294           udp_header_t *h0 = 0;
295           u32 i0, next0;
296           u32 advance0;
297
298           bi0 = from[0];
299           to_next[0] = bi0;
300           from += 1;
301           to_next += 1;
302           n_left_from -= 1;
303           n_left_to_next -= 1;
304
305           b0 = vlib_get_buffer (vm, bi0);
306
307           /* ip4/6_local hands us the ip header, not the udp header */
308           if (is_ip4)
309             advance0 = sizeof (ip4_header_t);
310           else
311             advance0 = sizeof (ip6_header_t);
312
313           if (PREDICT_FALSE (b0->current_length < advance0 + sizeof (*h0)))
314             {
315               b0->error = node->errors[UDP_ERROR_LENGTH_ERROR];
316               next0 = UDP_INPUT_NEXT_DROP;
317               goto trace_x1;
318             }
319
320           vlib_buffer_advance (b0, advance0);
321
322           h0 = vlib_buffer_get_current (b0);
323
324           if (PREDICT_TRUE (clib_net_to_host_u16 (h0->length) <=
325                             vlib_buffer_length_in_chain (vm, b0)))
326             {
327               i0 = sparse_vec_index (rt->next_by_dst_port, h0->dst_port);
328               next0 = vec_elt (rt->next_by_dst_port, i0);
329
330               if (PREDICT_FALSE (i0 == SPARSE_VEC_INVALID_INDEX))
331                 {
332                   // move the pointer back so icmp-error can find the
333                   // ip packet header
334                   vlib_buffer_advance (b0, -(word) advance0);
335
336                   if (PREDICT_FALSE (punt_unknown))
337                     {
338                       b0->error = node->errors[UDP_ERROR_PUNT];
339                       next0 = UDP_INPUT_NEXT_PUNT;
340                     }
341                   else if (is_ip4)
342                     {
343                       icmp4_error_set_vnet_buffer (b0,
344                                                    ICMP4_destination_unreachable,
345                                                    ICMP4_destination_unreachable_port_unreachable,
346                                                    0);
347                       next0 = UDP_INPUT_NEXT_ICMP4_ERROR;
348                       n_no_listener++;
349                     }
350                   else
351                     {
352                       icmp6_error_set_vnet_buffer (b0,
353                                                    ICMP6_destination_unreachable,
354                                                    ICMP6_destination_unreachable_port_unreachable,
355                                                    0);
356                       next0 = UDP_INPUT_NEXT_ICMP6_ERROR;
357                       n_no_listener++;
358                     }
359                 }
360               else
361                 {
362                   b0->error = node->errors[UDP_ERROR_NONE];
363                   // advance to the payload
364                   vlib_buffer_advance (b0, sizeof (*h0));
365                 }
366             }
367           else
368             {
369               b0->error = node->errors[UDP_ERROR_LENGTH_ERROR];
370               next0 = UDP_INPUT_NEXT_DROP;
371             }
372
373         trace_x1:
374           if (PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
375             {
376               udp_rx_trace_t *tr = vlib_add_trace (vm, node,
377                                                    b0, sizeof (*tr));
378               if (b0->error != node->errors[UDP_ERROR_LENGTH_ERROR])
379                 {
380                   tr->src_port = h0->src_port;
381                   tr->dst_port = h0->dst_port;
382                   tr->bound = (next0 != UDP_INPUT_NEXT_ICMP4_ERROR &&
383                                next0 != UDP_INPUT_NEXT_ICMP6_ERROR);
384                 }
385             }
386
387           vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
388                                            to_next, n_left_to_next,
389                                            bi0, next0);
390         }
391
392       vlib_put_next_frame (vm, node, next_index, n_left_to_next);
393     }
394   vlib_error_count (vm, node->node_index, UDP_ERROR_NO_LISTENER,
395                     n_no_listener);
396   return from_frame->n_vectors;
397 }
398
399 static char *udp_error_strings[] = {
400 #define udp_error(n,s) s,
401 #include "udp_error.def"
402 #undef udp_error
403 };
404
405 static uword
406 udp4_input (vlib_main_t * vm,
407             vlib_node_runtime_t * node, vlib_frame_t * from_frame)
408 {
409   return udp46_input_inline (vm, node, from_frame, 1 /* is_ip4 */ );
410 }
411
412 static uword
413 udp6_input (vlib_main_t * vm,
414             vlib_node_runtime_t * node, vlib_frame_t * from_frame)
415 {
416   return udp46_input_inline (vm, node, from_frame, 0 /* is_ip4 */ );
417 }
418
419
420 /* *INDENT-OFF* */
421 VLIB_REGISTER_NODE (udp4_input_node) = {
422   .function = udp4_input,
423   .name = "ip4-udp-lookup",
424   /* Takes a vector of packets. */
425   .vector_size = sizeof (u32),
426
427   .runtime_data_bytes = sizeof (udp_input_runtime_t),
428
429   .n_errors = UDP_N_ERROR,
430   .error_strings = udp_error_strings,
431
432   .n_next_nodes = UDP_INPUT_N_NEXT,
433   .next_nodes = {
434 #define _(s,n) [UDP_INPUT_NEXT_##s] = n,
435     foreach_udp_input_next
436 #undef _
437   },
438
439   .format_buffer = format_udp_header,
440   .format_trace = format_udp_rx_trace,
441   .unformat_buffer = unformat_udp_header,
442 };
443 /* *INDENT-ON* */
444
445 VLIB_NODE_FUNCTION_MULTIARCH (udp4_input_node, udp4_input);
446
447 /* *INDENT-OFF* */
448 VLIB_REGISTER_NODE (udp6_input_node) = {
449   .function = udp6_input,
450   .name = "ip6-udp-lookup",
451   /* Takes a vector of packets. */
452   .vector_size = sizeof (u32),
453
454   .runtime_data_bytes = sizeof (udp_input_runtime_t),
455
456   .n_errors = UDP_N_ERROR,
457   .error_strings = udp_error_strings,
458
459   .n_next_nodes = UDP_INPUT_N_NEXT,
460   .next_nodes = {
461 #define _(s,n) [UDP_INPUT_NEXT_##s] = n,
462     foreach_udp_input_next
463 #undef _
464   },
465
466   .format_buffer = format_udp_header,
467   .format_trace = format_udp_rx_trace,
468   .unformat_buffer = unformat_udp_header,
469 };
470 /* *INDENT-ON* */
471
472 VLIB_NODE_FUNCTION_MULTIARCH (udp6_input_node, udp6_input);
473
474 static void
475 add_dst_port (udp_main_t * um,
476               udp_dst_port_t dst_port, char *dst_port_name, u8 is_ip4)
477 {
478   udp_dst_port_info_t *pi;
479   u32 i;
480
481   vec_add2 (um->dst_port_infos[is_ip4], pi, 1);
482   i = pi - um->dst_port_infos[is_ip4];
483
484   pi->name = dst_port_name;
485   pi->dst_port = dst_port;
486   pi->next_index = pi->node_index = ~0;
487
488   hash_set (um->dst_port_info_by_dst_port[is_ip4], dst_port, i);
489
490   if (pi->name)
491     hash_set_mem (um->dst_port_info_by_name[is_ip4], pi->name, i);
492 }
493
494 void
495 udp_register_dst_port (vlib_main_t * vm,
496                        udp_dst_port_t dst_port, u32 node_index, u8 is_ip4)
497 {
498   udp_main_t *um = &udp_main;
499   udp_dst_port_info_t *pi;
500   udp_input_runtime_t *rt;
501   u16 *n;
502
503   {
504     clib_error_t *error = vlib_call_init_function (vm, udp_local_init);
505     if (error)
506       clib_error_report (error);
507   }
508
509   pi = udp_get_dst_port_info (um, dst_port, is_ip4);
510   if (!pi)
511     {
512       add_dst_port (um, dst_port, 0, is_ip4);
513       pi = udp_get_dst_port_info (um, dst_port, is_ip4);
514       ASSERT (pi);
515     }
516
517   pi->node_index = node_index;
518   pi->next_index = vlib_node_add_next (vm,
519                                        is_ip4 ? udp4_input_node.index
520                                        : udp6_input_node.index, node_index);
521
522   /* Setup udp protocol -> next index sparse vector mapping. */
523   rt = vlib_node_get_runtime_data
524     (vm, is_ip4 ? udp4_input_node.index : udp6_input_node.index);
525   n = sparse_vec_validate (rt->next_by_dst_port,
526                            clib_host_to_net_u16 (dst_port));
527   n[0] = pi->next_index;
528 }
529
530 void
531 udp_unregister_dst_port (vlib_main_t * vm, udp_dst_port_t dst_port, u8 is_ip4)
532 {
533   udp_main_t *um = &udp_main;
534   udp_dst_port_info_t *pi;
535   udp_input_runtime_t *rt;
536   u16 *n;
537
538   pi = udp_get_dst_port_info (um, dst_port, is_ip4);
539   /* Not registered? Fagedaboudit */
540   if (!pi)
541     return;
542
543   /* Kill the mapping. Don't bother killing the pi, it may be back. */
544   rt = vlib_node_get_runtime_data
545     (vm, is_ip4 ? udp4_input_node.index : udp6_input_node.index);
546   n = sparse_vec_validate (rt->next_by_dst_port,
547                            clib_host_to_net_u16 (dst_port));
548   n[0] = SPARSE_VEC_INVALID_INDEX;
549 }
550
551 void
552 udp_punt_unknown (vlib_main_t * vm, u8 is_ip4, u8 is_add)
553 {
554   udp_input_runtime_t *rt;
555
556   {
557     clib_error_t *error = vlib_call_init_function (vm, udp_local_init);
558     if (error)
559       clib_error_report (error);
560   }
561
562   rt = vlib_node_get_runtime_data
563     (vm, is_ip4 ? udp4_input_node.index : udp6_input_node.index);
564
565   rt->punt_unknown = is_add;
566 }
567
568 /* Parse a UDP header. */
569 uword
570 unformat_udp_header (unformat_input_t * input, va_list * args)
571 {
572   u8 **result = va_arg (*args, u8 **);
573   udp_header_t *udp;
574   __attribute__ ((unused)) int old_length;
575   u16 src_port, dst_port;
576
577   /* Allocate space for IP header. */
578   {
579     void *p;
580
581     old_length = vec_len (*result);
582     vec_add2 (*result, p, sizeof (ip4_header_t));
583     udp = p;
584   }
585
586   memset (udp, 0, sizeof (udp[0]));
587   if (unformat (input, "src-port %d dst-port %d", &src_port, &dst_port))
588     {
589       udp->src_port = clib_host_to_net_u16 (src_port);
590       udp->dst_port = clib_host_to_net_u16 (dst_port);
591       return 1;
592     }
593   return 0;
594 }
595
596 static void
597 udp_setup_node (vlib_main_t * vm, u32 node_index)
598 {
599   vlib_node_t *n = vlib_get_node (vm, node_index);
600   pg_node_t *pn = pg_get_node (node_index);
601
602   n->format_buffer = format_udp_header;
603   n->unformat_buffer = unformat_udp_header;
604   pn->unformat_edit = unformat_pg_udp_header;
605 }
606
607 clib_error_t *
608 udp_local_init (vlib_main_t * vm)
609 {
610   udp_input_runtime_t *rt;
611   udp_main_t *um = &udp_main;
612   int i;
613
614   {
615     clib_error_t *error;
616     error = vlib_call_init_function (vm, udp_init);
617     if (error)
618       clib_error_report (error);
619   }
620
621
622   for (i = 0; i < 2; i++)
623     {
624       um->dst_port_info_by_name[i] = hash_create_string (0, sizeof (uword));
625       um->dst_port_info_by_dst_port[i] = hash_create (0, sizeof (uword));
626     }
627
628   udp_setup_node (vm, udp4_input_node.index);
629   udp_setup_node (vm, udp6_input_node.index);
630
631   rt = vlib_node_get_runtime_data (vm, udp4_input_node.index);
632
633   rt->next_by_dst_port = sparse_vec_new
634     ( /* elt bytes */ sizeof (rt->next_by_dst_port[0]),
635      /* bits in index */ BITS (((udp_header_t *) 0)->dst_port));
636
637   rt->punt_unknown = 0;
638
639 #define _(n,s) add_dst_port (um, UDP_DST_PORT_##s, #s, 1 /* is_ip4 */);
640   foreach_udp4_dst_port
641 #undef _
642     rt = vlib_node_get_runtime_data (vm, udp6_input_node.index);
643
644   rt->next_by_dst_port = sparse_vec_new
645     ( /* elt bytes */ sizeof (rt->next_by_dst_port[0]),
646      /* bits in index */ BITS (((udp_header_t *) 0)->dst_port));
647
648   rt->punt_unknown = 0;
649
650 #define _(n,s) add_dst_port (um, UDP_DST_PORT_##s, #s, 0 /* is_ip4 */);
651   foreach_udp6_dst_port
652 #undef _
653     ip4_register_protocol (IP_PROTOCOL_UDP, udp4_input_node.index);
654   /* Note: ip6 differs from ip4, UDP is hotwired to ip6-udp-lookup */
655   return 0;
656 }
657
658 VLIB_INIT_FUNCTION (udp_local_init);
659
660 /*
661  * fd.io coding-style-patch-verification: ON
662  *
663  * Local Variables:
664  * eval: (c-set-style "gnu")
665  * End:
666  */