c11 safe string handling support
[vpp.git] / src / vnet / ip / icmp6.c
1 /*
2  * Copyright (c) 2015 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  * ip/icmp6.c: ip6 icmp
17  *
18  * Copyright (c) 2008 Eliot Dresselhaus
19  *
20  * Permission is hereby granted, free of charge, to any person obtaining
21  * a copy of this software and associated documentation files (the
22  * "Software"), to deal in the Software without restriction, including
23  * without limitation the rights to use, copy, modify, merge, publish,
24  * distribute, sublicense, and/or sell copies of the Software, and to
25  * permit persons to whom the Software is furnished to do so, subject to
26  * the following conditions:
27  *
28  * The above copyright notice and this permission notice shall be
29  * included in all copies or substantial portions of the Software.
30  *
31  *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
32  *  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
33  *  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
34  *  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
35  *  LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
36  *  OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
37  *  WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
38  */
39
40 #include <vlib/vlib.h>
41 #include <vnet/ip/ip.h>
42 #include <vnet/pg/pg.h>
43
44 static u8 *
45 format_ip6_icmp_type_and_code (u8 * s, va_list * args)
46 {
47   icmp6_type_t type = va_arg (*args, int);
48   u8 code = va_arg (*args, int);
49   char *t = 0;
50
51 #define _(n,f) case n: t = #f; break;
52
53   switch (type)
54     {
55       foreach_icmp6_type;
56
57     default:
58       break;
59     }
60
61 #undef _
62
63   if (!t)
64     return format (s, "unknown 0x%x", type);
65
66   s = format (s, "%s", t);
67
68   t = 0;
69   switch ((type << 8) | code)
70     {
71 #define _(a,n,f) case (ICMP6_##a << 8) | (n): t = #f; break;
72
73       foreach_icmp6_code;
74
75 #undef _
76     }
77
78   if (t)
79     s = format (s, " %s", t);
80
81   return s;
82 }
83
84 static u8 *
85 format_icmp6_header (u8 * s, va_list * args)
86 {
87   icmp46_header_t *icmp = va_arg (*args, icmp46_header_t *);
88   u32 max_header_bytes = va_arg (*args, u32);
89
90   /* Nothing to do. */
91   if (max_header_bytes < sizeof (icmp[0]))
92     return format (s, "ICMP header truncated");
93
94   s = format (s, "ICMP %U checksum 0x%x",
95               format_ip6_icmp_type_and_code, icmp->type, icmp->code,
96               clib_net_to_host_u16 (icmp->checksum));
97
98   if (max_header_bytes >=
99       sizeof (icmp6_neighbor_solicitation_or_advertisement_header_t) &&
100       (icmp->type == ICMP6_neighbor_solicitation ||
101        icmp->type == ICMP6_neighbor_advertisement))
102     {
103       icmp6_neighbor_solicitation_or_advertisement_header_t *icmp6_nd =
104         (icmp6_neighbor_solicitation_or_advertisement_header_t *) icmp;
105       s = format (s, "\n    target address %U",
106                   format_ip6_address, &icmp6_nd->target_address);
107     }
108
109   return s;
110 }
111
112 u8 *
113 format_icmp6_input_trace (u8 * s, va_list * va)
114 {
115   CLIB_UNUSED (vlib_main_t * vm) = va_arg (*va, vlib_main_t *);
116   CLIB_UNUSED (vlib_node_t * node) = va_arg (*va, vlib_node_t *);
117   icmp6_input_trace_t *t = va_arg (*va, icmp6_input_trace_t *);
118
119   s = format (s, "%U",
120               format_ip6_header, t->packet_data, sizeof (t->packet_data));
121
122   return s;
123 }
124
125 static char *icmp_error_strings[] = {
126 #define _(f,s) s,
127   foreach_icmp6_error
128 #undef _
129 };
130
131 typedef enum
132 {
133   ICMP_INPUT_NEXT_DROP,
134   ICMP_INPUT_N_NEXT,
135 } icmp_input_next_t;
136
137 typedef struct
138 {
139   uword *type_and_code_by_name;
140
141   uword *type_by_name;
142
143   /* Vector dispatch table indexed by [icmp type]. */
144   u8 input_next_index_by_type[256];
145
146   /* Max valid code indexed by icmp type. */
147   u8 max_valid_code_by_type[256];
148
149   /* hop_limit must be >= this value for this icmp type. */
150   u8 min_valid_hop_limit_by_type[256];
151
152   u8 min_valid_length_by_type[256];
153 } icmp6_main_t;
154
155 icmp6_main_t icmp6_main;
156
157 static uword
158 ip6_icmp_input (vlib_main_t * vm,
159                 vlib_node_runtime_t * node, vlib_frame_t * frame)
160 {
161   icmp6_main_t *im = &icmp6_main;
162   u32 *from, *to_next;
163   u32 n_left_from, n_left_to_next, next_index;
164
165   from = vlib_frame_vector_args (frame);
166   n_left_from = frame->n_vectors;
167   next_index = node->cached_next_index;
168
169   if (node->flags & VLIB_NODE_FLAG_TRACE)
170     vlib_trace_frame_buffers_only (vm, node, from, frame->n_vectors,
171                                    /* stride */ 1,
172                                    sizeof (icmp6_input_trace_t));
173
174   while (n_left_from > 0)
175     {
176       vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
177
178       while (n_left_from > 0 && n_left_to_next > 0)
179         {
180           vlib_buffer_t *b0;
181           ip6_header_t *ip0;
182           icmp46_header_t *icmp0;
183           icmp6_type_t type0;
184           u32 bi0, next0, error0, len0;
185
186           bi0 = to_next[0] = from[0];
187
188           from += 1;
189           n_left_from -= 1;
190           to_next += 1;
191           n_left_to_next -= 1;
192
193           b0 = vlib_get_buffer (vm, bi0);
194           ip0 = vlib_buffer_get_current (b0);
195           icmp0 = ip6_next_header (ip0);
196           type0 = icmp0->type;
197
198           error0 = ICMP6_ERROR_NONE;
199
200           next0 = im->input_next_index_by_type[type0];
201           error0 =
202             next0 == ICMP_INPUT_NEXT_DROP ? ICMP6_ERROR_UNKNOWN_TYPE : error0;
203
204           /* Check code is valid for type. */
205           error0 =
206             icmp0->code >
207             im->max_valid_code_by_type[type0] ?
208             ICMP6_ERROR_INVALID_CODE_FOR_TYPE : error0;
209
210           /* Checksum is already validated by ip6_local node so we don't need to check that. */
211
212           /* Check that hop limit == 255 for certain types. */
213           error0 =
214             ip0->hop_limit <
215             im->min_valid_hop_limit_by_type[type0] ?
216             ICMP6_ERROR_INVALID_HOP_LIMIT_FOR_TYPE : error0;
217
218           len0 = clib_net_to_host_u16 (ip0->payload_length);
219           error0 =
220             len0 <
221             im->min_valid_length_by_type[type0] ?
222             ICMP6_ERROR_LENGTH_TOO_SMALL_FOR_TYPE : error0;
223
224           b0->error = node->errors[error0];
225
226           next0 = error0 != ICMP6_ERROR_NONE ? ICMP_INPUT_NEXT_DROP : next0;
227
228           vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
229                                            to_next, n_left_to_next,
230                                            bi0, next0);
231         }
232
233       vlib_put_next_frame (vm, node, next_index, n_left_to_next);
234     }
235
236   return frame->n_vectors;
237 }
238
239 /* *INDENT-OFF* */
240 VLIB_REGISTER_NODE (ip6_icmp_input_node) = {
241   .function = ip6_icmp_input,
242   .name = "ip6-icmp-input",
243
244   .vector_size = sizeof (u32),
245
246   .format_trace = format_icmp6_input_trace,
247
248   .n_errors = ARRAY_LEN (icmp_error_strings),
249   .error_strings = icmp_error_strings,
250
251   .n_next_nodes = 1,
252   .next_nodes = {
253     [ICMP_INPUT_NEXT_DROP] = "ip6-drop",
254   },
255 };
256 /* *INDENT-ON* */
257
258 typedef enum
259 {
260   ICMP6_ECHO_REQUEST_NEXT_LOOKUP,
261   ICMP6_ECHO_REQUEST_NEXT_OUTPUT,
262   ICMP6_ECHO_REQUEST_N_NEXT,
263 } icmp6_echo_request_next_t;
264
265 static uword
266 ip6_icmp_echo_request (vlib_main_t * vm,
267                        vlib_node_runtime_t * node, vlib_frame_t * frame)
268 {
269   u32 *from, *to_next;
270   u32 n_left_from, n_left_to_next, next_index;
271   ip6_main_t *im = &ip6_main;
272
273   from = vlib_frame_vector_args (frame);
274   n_left_from = frame->n_vectors;
275   next_index = node->cached_next_index;
276
277   if (node->flags & VLIB_NODE_FLAG_TRACE)
278     vlib_trace_frame_buffers_only (vm, node, from, frame->n_vectors,
279                                    /* stride */ 1,
280                                    sizeof (icmp6_input_trace_t));
281
282   while (n_left_from > 0)
283     {
284       vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
285
286       while (n_left_from > 2 && n_left_to_next > 2)
287         {
288           vlib_buffer_t *p0, *p1;
289           ip6_header_t *ip0, *ip1;
290           icmp46_header_t *icmp0, *icmp1;
291           ip6_address_t tmp0, tmp1;
292           ip_csum_t sum0, sum1;
293           u32 bi0, bi1;
294           u32 fib_index0, fib_index1;
295           u32 next0 = ICMP6_ECHO_REQUEST_NEXT_LOOKUP;
296           u32 next1 = ICMP6_ECHO_REQUEST_NEXT_LOOKUP;
297
298           bi0 = to_next[0] = from[0];
299           bi1 = to_next[1] = from[1];
300
301           from += 2;
302           n_left_from -= 2;
303           to_next += 2;
304           n_left_to_next -= 2;
305
306           p0 = vlib_get_buffer (vm, bi0);
307           p1 = vlib_get_buffer (vm, bi1);
308           ip0 = vlib_buffer_get_current (p0);
309           ip1 = vlib_buffer_get_current (p1);
310           icmp0 = ip6_next_header (ip0);
311           icmp1 = ip6_next_header (ip1);
312
313           /* Check icmp type to echo reply and update icmp checksum. */
314           sum0 = icmp0->checksum;
315           sum1 = icmp1->checksum;
316
317           ASSERT (icmp0->type == ICMP6_echo_request);
318           ASSERT (icmp1->type == ICMP6_echo_request);
319           sum0 = ip_csum_update (sum0, ICMP6_echo_request, ICMP6_echo_reply,
320                                  icmp46_header_t, type);
321           sum1 = ip_csum_update (sum1, ICMP6_echo_request, ICMP6_echo_reply,
322                                  icmp46_header_t, type);
323
324           icmp0->checksum = ip_csum_fold (sum0);
325           icmp1->checksum = ip_csum_fold (sum1);
326
327           icmp0->type = ICMP6_echo_reply;
328           icmp1->type = ICMP6_echo_reply;
329
330           /* Swap source and destination address. */
331           tmp0 = ip0->src_address;
332           tmp1 = ip1->src_address;
333
334           ip0->src_address = ip0->dst_address;
335           ip1->src_address = ip1->dst_address;
336
337           ip0->dst_address = tmp0;
338           ip1->dst_address = tmp1;
339
340           /* New hop count. */
341           ip0->hop_limit = im->host_config.ttl;
342           ip1->hop_limit = im->host_config.ttl;
343
344           /* Determine the correct lookup fib indices... */
345           fib_index0 = vec_elt (im->fib_index_by_sw_if_index,
346                                 vnet_buffer (p0)->sw_if_index[VLIB_RX]);
347           vnet_buffer (p0)->sw_if_index[VLIB_TX] = fib_index0;
348           /* Determine the correct lookup fib indices... */
349           fib_index1 = vec_elt (im->fib_index_by_sw_if_index,
350                                 vnet_buffer (p1)->sw_if_index[VLIB_RX]);
351           vnet_buffer (p1)->sw_if_index[VLIB_TX] = fib_index1;
352
353           /* verify speculative enqueues, maybe switch current next frame */
354           /* if next0==next1==next_index then nothing special needs to be done */
355           vlib_validate_buffer_enqueue_x2 (vm, node, next_index,
356                                            to_next, n_left_to_next,
357                                            bi0, bi1, next0, next1);
358         }
359
360       while (n_left_from > 0 && n_left_to_next > 0)
361         {
362           vlib_buffer_t *p0;
363           ip6_header_t *ip0;
364           icmp46_header_t *icmp0;
365           u32 bi0;
366           ip6_address_t tmp0;
367           ip_csum_t sum0;
368           u32 fib_index0;
369           u32 next0 = ICMP6_ECHO_REQUEST_NEXT_LOOKUP;
370
371           bi0 = to_next[0] = from[0];
372
373           from += 1;
374           n_left_from -= 1;
375           to_next += 1;
376           n_left_to_next -= 1;
377
378           p0 = vlib_get_buffer (vm, bi0);
379           ip0 = vlib_buffer_get_current (p0);
380           icmp0 = ip6_next_header (ip0);
381
382           /* Check icmp type to echo reply and update icmp checksum. */
383           sum0 = icmp0->checksum;
384
385           ASSERT (icmp0->type == ICMP6_echo_request);
386           sum0 = ip_csum_update (sum0, ICMP6_echo_request, ICMP6_echo_reply,
387                                  icmp46_header_t, type);
388
389           icmp0->checksum = ip_csum_fold (sum0);
390
391           icmp0->type = ICMP6_echo_reply;
392
393           /* Swap source and destination address. */
394           tmp0 = ip0->src_address;
395           ip0->src_address = ip0->dst_address;
396           ip0->dst_address = tmp0;
397
398           ip0->hop_limit = im->host_config.ttl;
399
400           /* if the packet is link local, we'll bounce through the link-local
401            * table with the RX interface correctly set */
402           fib_index0 = vec_elt (im->fib_index_by_sw_if_index,
403                                 vnet_buffer (p0)->sw_if_index[VLIB_RX]);
404           vnet_buffer (p0)->sw_if_index[VLIB_TX] = fib_index0;
405
406           /* Verify speculative enqueue, maybe switch current next frame */
407           vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
408                                            to_next, n_left_to_next,
409                                            bi0, next0);
410         }
411
412       vlib_put_next_frame (vm, node, next_index, n_left_to_next);
413     }
414
415   vlib_error_count (vm, ip6_icmp_input_node.index,
416                     ICMP6_ERROR_ECHO_REPLIES_SENT, frame->n_vectors);
417
418   return frame->n_vectors;
419 }
420
421 /* *INDENT-OFF* */
422 VLIB_REGISTER_NODE (ip6_icmp_echo_request_node,static) = {
423   .function = ip6_icmp_echo_request,
424   .name = "ip6-icmp-echo-request",
425
426   .vector_size = sizeof (u32),
427
428   .format_trace = format_icmp6_input_trace,
429
430   .n_next_nodes = ICMP6_ECHO_REQUEST_N_NEXT,
431   .next_nodes = {
432     [ICMP6_ECHO_REQUEST_NEXT_LOOKUP] = "ip6-lookup",
433     [ICMP6_ECHO_REQUEST_NEXT_OUTPUT] = "interface-output",
434   },
435 };
436 /* *INDENT-ON* */
437
438 typedef enum
439 {
440   IP6_ICMP_ERROR_NEXT_DROP,
441   IP6_ICMP_ERROR_NEXT_LOOKUP,
442   IP6_ICMP_ERROR_N_NEXT,
443 } ip6_icmp_error_next_t;
444
445 void
446 icmp6_error_set_vnet_buffer (vlib_buffer_t * b, u8 type, u8 code, u32 data)
447 {
448   vnet_buffer (b)->ip.icmp.type = type;
449   vnet_buffer (b)->ip.icmp.code = code;
450   vnet_buffer (b)->ip.icmp.data = data;
451 }
452
453 static u8
454 icmp6_icmp_type_to_error (u8 type)
455 {
456   switch (type)
457     {
458     case ICMP6_destination_unreachable:
459       return ICMP6_ERROR_DEST_UNREACH_SENT;
460     case ICMP6_packet_too_big:
461       return ICMP6_ERROR_PACKET_TOO_BIG_SENT;
462     case ICMP6_time_exceeded:
463       return ICMP6_ERROR_TTL_EXPIRE_SENT;
464     case ICMP6_parameter_problem:
465       return ICMP6_ERROR_PARAM_PROBLEM_SENT;
466     default:
467       return ICMP6_ERROR_DROP;
468     }
469 }
470
471 static uword
472 ip6_icmp_error (vlib_main_t * vm,
473                 vlib_node_runtime_t * node, vlib_frame_t * frame)
474 {
475   u32 *from, *to_next;
476   uword n_left_from, n_left_to_next;
477   ip6_icmp_error_next_t next_index;
478   ip6_main_t *im = &ip6_main;
479   ip_lookup_main_t *lm = &im->lookup_main;
480
481   from = vlib_frame_vector_args (frame);
482   n_left_from = frame->n_vectors;
483   next_index = node->cached_next_index;
484
485   if (node->flags & VLIB_NODE_FLAG_TRACE)
486     vlib_trace_frame_buffers_only (vm, node, from, frame->n_vectors,
487                                    /* stride */ 1,
488                                    sizeof (icmp6_input_trace_t));
489
490   while (n_left_from > 0)
491     {
492       vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
493
494       while (n_left_from > 0 && n_left_to_next > 0)
495         {
496           u32 pi0 = from[0];
497           u32 next0 = IP6_ICMP_ERROR_NEXT_LOOKUP;
498           u8 error0 = ICMP6_ERROR_NONE;
499           vlib_buffer_t *p0;
500           ip6_header_t *ip0, *out_ip0;
501           icmp46_header_t *icmp0;
502           u32 sw_if_index0, if_add_index0;
503           int bogus_length;
504
505           /* Speculatively enqueue p0 to the current next frame */
506           to_next[0] = pi0;
507           from += 1;
508           to_next += 1;
509           n_left_from -= 1;
510           n_left_to_next -= 1;
511
512           p0 = vlib_get_buffer (vm, pi0);
513           ip0 = vlib_buffer_get_current (p0);
514           sw_if_index0 = vnet_buffer (p0)->sw_if_index[VLIB_RX];
515
516           /* RFC4443 says to keep as much of the original packet as possible
517            * within the minimum MTU. We cheat "a little" here by keeping whatever fits
518            * in the first buffer, to be more efficient */
519           if (PREDICT_FALSE (p0->total_length_not_including_first_buffer))
520             {                   /* clear current_length of all other buffers in chain */
521               vlib_buffer_t *b = p0;
522               p0->total_length_not_including_first_buffer = 0;
523               while (b->flags & VLIB_BUFFER_NEXT_PRESENT)
524                 {
525                   b = vlib_get_buffer (vm, b->next_buffer);
526                   b->current_length = 0;
527                   // XXX: Buffer leak???
528                 }
529             }
530
531           /* Add IP header and ICMPv6 header including a 4 byte data field */
532           int headroom = sizeof (ip6_header_t) + sizeof (icmp46_header_t) + 4;
533
534           /* Verify that we're not falling off the edge */
535           if (p0->current_data - headroom < -VLIB_BUFFER_PRE_DATA_SIZE)
536             {
537               next0 = IP6_ICMP_ERROR_NEXT_DROP;
538               error0 = ICMP6_ERROR_DROP;
539               goto error;
540             }
541
542           vlib_buffer_advance (p0, -headroom);
543           vnet_buffer (p0)->sw_if_index[VLIB_TX] = ~0;
544           p0->flags |= VNET_BUFFER_F_LOCALLY_ORIGINATED;
545           p0->current_length =
546             p0->current_length > 1280 ? 1280 : p0->current_length;
547
548           out_ip0 = vlib_buffer_get_current (p0);
549           icmp0 = (icmp46_header_t *) & out_ip0[1];
550
551           /* Fill ip header fields */
552           out_ip0->ip_version_traffic_class_and_flow_label =
553             clib_host_to_net_u32 (0x6 << 28);
554
555           out_ip0->payload_length =
556             clib_host_to_net_u16 (p0->current_length - sizeof (ip6_header_t));
557           out_ip0->protocol = IP_PROTOCOL_ICMP6;
558           out_ip0->hop_limit = 0xff;
559           out_ip0->dst_address = ip0->src_address;
560           if_add_index0 =
561             lm->if_address_pool_index_by_sw_if_index[sw_if_index0];
562           if (PREDICT_TRUE (if_add_index0 != ~0))
563             {
564               ip_interface_address_t *if_add =
565                 pool_elt_at_index (lm->if_address_pool, if_add_index0);
566               ip6_address_t *if_ip =
567                 ip_interface_address_get_address (lm, if_add);
568               out_ip0->src_address = *if_ip;
569             }
570           else                  /* interface has no IP6 address - should not happen */
571             {
572               next0 = IP6_ICMP_ERROR_NEXT_DROP;
573               error0 = ICMP6_ERROR_DROP;
574               goto error;
575             }
576
577           /* Fill icmp header fields */
578           icmp0->type = vnet_buffer (p0)->ip.icmp.type;
579           icmp0->code = vnet_buffer (p0)->ip.icmp.code;
580           *((u32 *) (icmp0 + 1)) =
581             clib_host_to_net_u32 (vnet_buffer (p0)->ip.icmp.data);
582           icmp0->checksum = 0;
583           icmp0->checksum =
584             ip6_tcp_udp_icmp_compute_checksum (vm, p0, out_ip0,
585                                                &bogus_length);
586
587           /* Update error status */
588           if (error0 == ICMP6_ERROR_NONE)
589             error0 = icmp6_icmp_type_to_error (icmp0->type);
590
591         error:
592           vlib_error_count (vm, node->node_index, error0, 1);
593
594           /* Verify speculative enqueue, maybe switch current next frame */
595           vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
596                                            to_next, n_left_to_next,
597                                            pi0, next0);
598         }
599       vlib_put_next_frame (vm, node, next_index, n_left_to_next);
600     }
601
602   return frame->n_vectors;
603 }
604
605 /* *INDENT-OFF* */
606 VLIB_REGISTER_NODE (ip6_icmp_error_node) = {
607   .function = ip6_icmp_error,
608   .name = "ip6-icmp-error",
609   .vector_size = sizeof (u32),
610
611   .n_errors = ARRAY_LEN (icmp_error_strings),
612   .error_strings = icmp_error_strings,
613
614   .n_next_nodes = IP6_ICMP_ERROR_N_NEXT,
615   .next_nodes = {
616     [IP6_ICMP_ERROR_NEXT_DROP] = "error-drop",
617     [IP6_ICMP_ERROR_NEXT_LOOKUP] = "ip6-lookup",
618   },
619
620   .format_trace = format_icmp6_input_trace,
621 };
622 /* *INDENT-ON* */
623
624
625 static uword
626 unformat_icmp_type_and_code (unformat_input_t * input, va_list * args)
627 {
628   icmp46_header_t *h = va_arg (*args, icmp46_header_t *);
629   icmp6_main_t *cm = &icmp6_main;
630   u32 i;
631
632   if (unformat_user (input, unformat_vlib_number_by_name,
633                      cm->type_and_code_by_name, &i))
634     {
635       h->type = (i >> 8) & 0xff;
636       h->code = (i >> 0) & 0xff;
637     }
638   else if (unformat_user (input, unformat_vlib_number_by_name,
639                           cm->type_by_name, &i))
640     {
641       h->type = i;
642       h->code = 0;
643     }
644   else
645     return 0;
646
647   return 1;
648 }
649
650 static void
651 icmp6_pg_edit_function (pg_main_t * pg,
652                         pg_stream_t * s,
653                         pg_edit_group_t * g, u32 * packets, u32 n_packets)
654 {
655   vlib_main_t *vm = vlib_get_main ();
656   u32 ip_offset, icmp_offset;
657   int bogus_length;
658
659   icmp_offset = g->start_byte_offset;
660   ip_offset = (g - 1)->start_byte_offset;
661
662   while (n_packets >= 1)
663     {
664       vlib_buffer_t *p0;
665       ip6_header_t *ip0;
666       icmp46_header_t *icmp0;
667
668       p0 = vlib_get_buffer (vm, packets[0]);
669       n_packets -= 1;
670       packets += 1;
671
672       ASSERT (p0->current_data == 0);
673       ip0 = (void *) (p0->data + ip_offset);
674       icmp0 = (void *) (p0->data + icmp_offset);
675
676       icmp0->checksum = ip6_tcp_udp_icmp_compute_checksum (vm, p0, ip0,
677                                                            &bogus_length);
678       ASSERT (bogus_length == 0);
679     }
680 }
681
682 typedef struct
683 {
684   pg_edit_t type, code;
685   pg_edit_t checksum;
686 } pg_icmp46_header_t;
687
688 always_inline void
689 pg_icmp_header_init (pg_icmp46_header_t * p)
690 {
691   /* Initialize fields that are not bit fields in the IP header. */
692 #define _(f) pg_edit_init (&p->f, icmp46_header_t, f);
693   _(type);
694   _(code);
695   _(checksum);
696 #undef _
697 }
698
699 static uword
700 unformat_pg_icmp_header (unformat_input_t * input, va_list * args)
701 {
702   pg_stream_t *s = va_arg (*args, pg_stream_t *);
703   pg_icmp46_header_t *p;
704   u32 group_index;
705
706   p = pg_create_edit_group (s, sizeof (p[0]), sizeof (icmp46_header_t),
707                             &group_index);
708   pg_icmp_header_init (p);
709
710   p->checksum.type = PG_EDIT_UNSPECIFIED;
711
712   {
713     icmp46_header_t tmp;
714
715     if (!unformat (input, "ICMP %U", unformat_icmp_type_and_code, &tmp))
716       goto error;
717
718     pg_edit_set_fixed (&p->type, tmp.type);
719     pg_edit_set_fixed (&p->code, tmp.code);
720   }
721
722   /* Parse options. */
723   while (1)
724     {
725       if (unformat (input, "checksum %U",
726                     unformat_pg_edit, unformat_pg_number, &p->checksum))
727         ;
728
729       /* Can't parse input: try next protocol level. */
730       else
731         break;
732     }
733
734   if (!unformat_user (input, unformat_pg_payload, s))
735     goto error;
736
737   if (p->checksum.type == PG_EDIT_UNSPECIFIED)
738     {
739       pg_edit_group_t *g = pg_stream_get_group (s, group_index);
740       g->edit_function = icmp6_pg_edit_function;
741       g->edit_function_opaque = 0;
742     }
743
744   return 1;
745
746 error:
747   /* Free up any edits we may have added. */
748   pg_free_edit_group (s);
749   return 0;
750 }
751
752 void
753 icmp6_register_type (vlib_main_t * vm, icmp6_type_t type, u32 node_index)
754 {
755   icmp6_main_t *im = &icmp6_main;
756
757   ASSERT ((int) type < ARRAY_LEN (im->input_next_index_by_type));
758   im->input_next_index_by_type[type]
759     = vlib_node_add_next (vm, ip6_icmp_input_node.index, node_index);
760 }
761
762 static clib_error_t *
763 icmp6_init (vlib_main_t * vm)
764 {
765   ip_main_t *im = &ip_main;
766   ip_protocol_info_t *pi;
767   icmp6_main_t *cm = &icmp6_main;
768   clib_error_t *error;
769
770   error = vlib_call_init_function (vm, ip_main_init);
771
772   if (error)
773     return error;
774
775   pi = ip_get_protocol_info (im, IP_PROTOCOL_ICMP6);
776   pi->format_header = format_icmp6_header;
777   pi->unformat_pg_edit = unformat_pg_icmp_header;
778
779   cm->type_by_name = hash_create_string (0, sizeof (uword));
780 #define _(n,t) hash_set_mem (cm->type_by_name, #t, (n));
781   foreach_icmp6_type;
782 #undef _
783
784   cm->type_and_code_by_name = hash_create_string (0, sizeof (uword));
785 #define _(a,n,t) hash_set_mem (cm->type_by_name, #t, (n) | (ICMP6_##a << 8));
786   foreach_icmp6_code;
787 #undef _
788
789   clib_memset (cm->input_next_index_by_type,
790                ICMP_INPUT_NEXT_DROP, sizeof (cm->input_next_index_by_type));
791   clib_memset (cm->max_valid_code_by_type, 0,
792                sizeof (cm->max_valid_code_by_type));
793
794 #define _(a,n,t) cm->max_valid_code_by_type[ICMP6_##a] = clib_max (cm->max_valid_code_by_type[ICMP6_##a], n);
795   foreach_icmp6_code;
796 #undef _
797
798   clib_memset (cm->min_valid_hop_limit_by_type, 0,
799                sizeof (cm->min_valid_hop_limit_by_type));
800   cm->min_valid_hop_limit_by_type[ICMP6_router_solicitation] = 255;
801   cm->min_valid_hop_limit_by_type[ICMP6_router_advertisement] = 255;
802   cm->min_valid_hop_limit_by_type[ICMP6_neighbor_solicitation] = 255;
803   cm->min_valid_hop_limit_by_type[ICMP6_neighbor_advertisement] = 255;
804   cm->min_valid_hop_limit_by_type[ICMP6_redirect] = 255;
805
806   clib_memset (cm->min_valid_length_by_type, sizeof (icmp46_header_t),
807                sizeof (cm->min_valid_length_by_type));
808   cm->min_valid_length_by_type[ICMP6_router_solicitation] =
809     sizeof (icmp6_neighbor_discovery_header_t);
810   cm->min_valid_length_by_type[ICMP6_router_advertisement] =
811     sizeof (icmp6_router_advertisement_header_t);
812   cm->min_valid_length_by_type[ICMP6_neighbor_solicitation] =
813     sizeof (icmp6_neighbor_solicitation_or_advertisement_header_t);
814   cm->min_valid_length_by_type[ICMP6_neighbor_advertisement] =
815     sizeof (icmp6_neighbor_solicitation_or_advertisement_header_t);
816   cm->min_valid_length_by_type[ICMP6_redirect] =
817     sizeof (icmp6_redirect_header_t);
818
819   icmp6_register_type (vm, ICMP6_echo_request,
820                        ip6_icmp_echo_request_node.index);
821
822   return vlib_call_init_function (vm, ip6_neighbor_init);
823 }
824
825 VLIB_INIT_FUNCTION (icmp6_init);
826
827 /*
828  * fd.io coding-style-patch-verification: ON
829  *
830  * Local Variables:
831  * eval: (c-set-style "gnu")
832  * End:
833  */