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