2 * ip/ip6_neighbor.c: IP6 neighbor handling
4 * Copyright (c) 2010 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:
9 * http://www.apache.org/licenses/LICENSE-2.0
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.
18 #include <vnet/ip6-nd/ip6_ra.h>
20 #include <vnet/ip/ip.h>
21 #include <vnet/ip-neighbor/ip_neighbor_dp.h>
23 #include <vnet/fib/ip6_fib.h>
24 #include <vnet/ip/ip6_link.h>
28 * @brief IPv6 Router Advertisements.
30 * The files contains the API and CLI code for managing IPv6 RAs
34 /* Router solicitation packet format for ethernet. */
35 typedef CLIB_PACKED (struct
38 icmp6_neighbor_discovery_header_t neighbor;
39 icmp6_neighbor_discovery_ethernet_link_layer_address_option_t
41 }) icmp6_router_solicitation_header_t;
43 /* router advertisement packet format for ethernet. */
44 typedef CLIB_PACKED (struct
47 icmp6_router_advertisement_header_t router;
48 icmp6_neighbor_discovery_ethernet_link_layer_address_option_t
50 icmp6_neighbor_discovery_mtu_option_t mtu_option;
51 icmp6_neighbor_discovery_prefix_information_option_t
53 }) icmp6_router_advertisement_packet_t;
56 #define DEF_MAX_RADV_INTERVAL 200
57 #define DEF_MIN_RADV_INTERVAL .75 * DEF_MAX_RADV_INTERVAL
58 #define DEF_CURR_HOP_LIMIT 64
59 #define DEF_DEF_RTR_LIFETIME 3 * DEF_MAX_RADV_INTERVAL
60 #define MAX_DEF_RTR_LIFETIME 9000
62 #define MAX_INITIAL_RTR_ADVERT_INTERVAL 16 /* seconds */
63 #define MAX_INITIAL_RTR_ADVERTISEMENTS 3 /*transmissions */
64 #define MIN_DELAY_BETWEEN_RAS 3 /* seconds */
65 #define MAX_DELAY_BETWEEN_RAS 1800 /* seconds */
66 #define MAX_RA_DELAY_TIME .5 /* seconds */
68 /* advertised prefix option */
71 /* basic advertised information */
75 int adv_autonomous_flag;
76 u32 adv_valid_lifetime_in_secs;
77 u32 adv_pref_lifetime_in_secs;
79 /* advertised values are computed from these times if decrementing */
80 f64 valid_lifetime_expires;
81 f64 pref_lifetime_expires;
83 /* local information */
85 int deprecated_prefix_flag;
86 int decrement_lifetime_flag;
88 #define MIN_ADV_VALID_LIFETIME 7203 /* seconds */
89 #define DEF_ADV_VALID_LIFETIME 2592000
90 #define DEF_ADV_PREF_LIFETIME 604800
92 /* extensions are added here, mobile, DNS etc.. */
95 typedef struct ip6_ra_t_
97 /* advertised config information, zero means unspecified */
101 u16 adv_router_lifetime_in_sec;
102 u32 adv_neighbor_reachable_time_in_msec;
103 u32 adv_time_in_msec_between_retransmitted_neighbor_solicitations;
108 /* local information */
110 int send_radv; /* radv on/off on this interface - set by config */
111 int cease_radv; /* we are ceasing to send - set byf config */
113 int adv_link_layer_address;
115 int failed_device_check;
119 ip6_radv_prefix_t *adv_prefixes_pool;
121 /* Hash table mapping address to index in interface advertised prefix pool. */
122 mhash_t address_to_prefix_index;
124 f64 max_radv_interval;
125 f64 min_radv_interval;
126 f64 min_delay_between_radv;
127 f64 max_delay_between_radv;
128 f64 max_rtr_default_lifetime;
131 f64 last_multicast_time;
132 f64 next_multicast_time;
135 u32 initial_adverts_count;
136 f64 initial_adverts_interval;
137 u32 initial_adverts_sent;
140 u32 n_advertisements_sent;
141 u32 n_solicitations_rcvd;
142 u32 n_solicitations_dropped;
144 /* router solicitations sending state */
145 u8 keep_sending_rs; /* when true then next fields are valid */
146 icmp6_send_router_solicitation_params_t params;
151 vlib_buffer_t *buffer;
157 static ip6_link_delegate_id_t ip6_ra_delegate_id;
158 static ip6_ra_t *ip6_ra_pool;
161 /* vector of registered RA report listeners */
162 static ip6_ra_report_notify_t *ip6_ra_listeners;
164 static int ip6_ra_publish (ip6_ra_report_t * r);
167 ip6_ra_report_register (ip6_ra_report_notify_t fn)
169 ip6_ra_report_notify_t *listener;
170 vec_foreach (listener, ip6_ra_listeners)
176 vec_add1 (ip6_ra_listeners, fn);
180 ip6_ra_report_unregister (ip6_ra_report_notify_t fn)
184 vec_foreach_index (ii, ip6_ra_listeners)
186 if (ip6_ra_listeners[ii] == fn)
188 vec_del1 (ip6_ra_listeners, ii);
194 static inline ip6_ra_t *
195 ip6_ra_get_itf (u32 sw_if_index)
199 rai = ip6_link_delegate_get (sw_if_index, ip6_ra_delegate_id);
201 if (INDEX_INVALID != rai)
202 return (pool_elt_at_index (ip6_ra_pool, rai));
207 /* for "syslogging" - use elog for now */
208 #define foreach_log_level \
210 _ (INFO, "INFORMATION") \
211 _ (NOTICE, "NOTICE") \
212 _ (WARNING, "WARNING") \
214 _ (CRIT, "CRITICAL") \
216 _ (EMERG, "EMERGENCY")
220 #define _(f,s) LOG_##f,
225 static char *log_level_strings[] = {
231 static int logmask = 1 << LOG_DEBUG;
234 ip6_neighbor_syslog (vlib_main_t * vm, int priority, char *fmt, ...)
236 /* just use elog for now */
240 if ((priority > LOG_EMERG) || !(logmask & (1 << priority)))
246 what = va_format (0, fmt, &va);
248 ELOG_TYPE_DECLARE (e) =
250 .format = "ip6 nd: (%s): %s",.format_args = "T4T4",};
255 ed = ELOG_DATA (vlib_get_elog_main (), e);
257 elog_string (vlib_get_elog_main (), log_level_strings[priority]);
258 ed->s[1] = elog_string (vlib_get_elog_main (), (char *) what);
264 /* ipv6 neighbor discovery - router advertisements */
267 ICMP6_ROUTER_SOLICITATION_NEXT_DROP,
268 ICMP6_ROUTER_SOLICITATION_NEXT_REPLY_RW,
269 ICMP6_ROUTER_SOLICITATION_NEXT_REPLY_TX,
270 ICMP6_ROUTER_SOLICITATION_N_NEXT,
271 } icmp6_router_solicitation_or_advertisement_next_t;
274 * Note: Both periodic RAs and solicited RS come through here.
276 static_always_inline uword
277 icmp6_router_solicitation (vlib_main_t * vm,
278 vlib_node_runtime_t * node, vlib_frame_t * frame)
280 vnet_main_t *vnm = vnet_get_main ();
281 ip6_main_t *im = &ip6_main;
282 uword n_packets = frame->n_vectors;
284 u32 n_left_from, n_left_to_next, next_index;
285 u32 n_advertisements_sent = 0;
288 icmp6_neighbor_discovery_option_type_t option_type;
290 vlib_node_runtime_t *error_node =
291 vlib_node_get_runtime (vm, ip6_icmp_input_node.index);
293 from = vlib_frame_vector_args (frame);
294 n_left_from = n_packets;
295 next_index = node->cached_next_index;
297 if (node->flags & VLIB_NODE_FLAG_TRACE)
298 vlib_trace_frame_buffers_only (vm, node, from, frame->n_vectors,
300 sizeof (icmp6_input_trace_t));
302 /* source may append his LL address */
303 option_type = ICMP6_NEIGHBOR_DISCOVERY_OPTION_source_link_layer_address;
305 while (n_left_from > 0)
307 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
309 while (n_left_from > 0 && n_left_to_next > 0)
313 ip6_ra_t *radv_info = NULL;
315 icmp6_neighbor_discovery_header_t *h0;
316 icmp6_neighbor_discovery_ethernet_link_layer_address_option_t *o0;
318 u32 bi0, options_len0, sw_if_index0, next0, error0;
319 u32 is_solicitation = 1, is_dropped = 0;
320 u32 is_unspecified, is_link_local;
322 bi0 = to_next[0] = from[0];
329 p0 = vlib_get_buffer (vm, bi0);
330 ip0 = vlib_buffer_get_current (p0);
331 h0 = ip6_next_header (ip0);
333 clib_net_to_host_u16 (ip0->payload_length) - sizeof (h0[0]);
334 is_unspecified = ip6_address_is_unspecified (&ip0->src_address);
336 ip6_address_is_link_local_unicast (&ip0->src_address);
338 error0 = ICMP6_ERROR_NONE;
339 sw_if_index0 = vnet_buffer (p0)->sw_if_index[VLIB_RX];
341 /* check if solicitation (not from nd_timer node) */
342 if (ip6_address_is_unspecified (&ip0->dst_address))
345 /* Check that source address is unspecified, link-local or else on-link. */
346 if (!is_unspecified && !is_link_local)
348 u32 src_adj_index0 = ip6_src_lookup_for_packet (im, p0, ip0);
350 if (ADJ_INDEX_INVALID != src_adj_index0)
352 ip_adjacency_t *adj0 = adj_get (src_adj_index0);
354 error0 = (adj0->rewrite_header.sw_if_index != sw_if_index0
356 ICMP6_ERROR_ROUTER_SOLICITATION_SOURCE_NOT_ON_LINK
361 error0 = ICMP6_ERROR_ROUTER_SOLICITATION_SOURCE_NOT_ON_LINK;
365 /* check for source LL option and process */
366 o0 = (void *) (h0 + 1);
367 o0 = ((options_len0 == 8
368 && o0->header.type == option_type
369 && o0->header.n_data_u64s == 1) ? o0 : 0);
371 /* if src address unspecified IGNORE any options */
372 if (PREDICT_TRUE (error0 == ICMP6_ERROR_NONE && o0 != 0 &&
373 !is_unspecified && !is_link_local))
376 ip_neighbor_learn_t learn = {
377 .sw_if_index = sw_if_index0,
379 .ip.ip6 = ip0->src_address,
384 memcpy (&learn.mac, o0->ethernet_address, sizeof (learn.mac));
385 ip_neighbor_learn_dp (&learn);
388 /* default is to drop */
389 next0 = ICMP6_ROUTER_SOLICITATION_NEXT_DROP;
391 if (error0 == ICMP6_ERROR_NONE)
393 vnet_sw_interface_t *sw_if0;
394 ethernet_interface_t *eth_if0;
397 sw_if0 = vnet_get_sup_sw_interface (vnm, sw_if_index0);
398 ASSERT (sw_if0->type == VNET_SW_INTERFACE_TYPE_HARDWARE);
400 ethernet_get_interface (ðernet_main, sw_if0->hw_if_index);
402 /* only support ethernet interface type for now */
404 (!eth_if0) ? ICMP6_ERROR_ROUTER_SOLICITATION_UNSUPPORTED_INTF
407 if (error0 == ICMP6_ERROR_NONE)
409 /* adjust the sizeof the buffer to just include the ipv6 header */
410 p0->current_length -=
412 sizeof (icmp6_neighbor_discovery_header_t));
414 radv_info = ip6_ra_get_itf (sw_if_index0);
416 error0 = ((!radv_info) ?
417 ICMP6_ERROR_ROUTER_SOLICITATION_RADV_NOT_CONFIG :
419 error0 = radv_info->send_radv == 0 ?
420 ICMP6_ERROR_ROUTER_SOLICITATION_RADV_NOT_CONFIG :
422 if (error0 == ICMP6_ERROR_NONE)
424 f64 now = vlib_time_now (vm);
426 /* for solicited adverts - need to rate limit */
429 if (0 != radv_info->last_radv_time &&
430 (now - radv_info->last_radv_time) <
431 MIN_DELAY_BETWEEN_RAS)
434 radv_info->last_radv_time = now;
438 icmp6_router_advertisement_header_t rh;
440 rh.icmp.type = ICMP6_router_advertisement;
442 rh.icmp.checksum = 0;
444 rh.current_hop_limit = radv_info->curr_hop_limit;
445 rh.router_lifetime_in_sec =
447 (radv_info->adv_router_lifetime_in_sec);
449 time_in_msec_between_retransmitted_neighbor_solicitations
451 clib_host_to_net_u32 (radv_info->
452 adv_time_in_msec_between_retransmitted_neighbor_solicitations);
453 rh.neighbor_reachable_time_in_msec =
454 clib_host_to_net_u32 (radv_info->
455 adv_neighbor_reachable_time_in_msec);
458 (radv_info->adv_managed_flag) ?
459 ICMP6_ROUTER_DISCOVERY_FLAG_ADDRESS_CONFIG_VIA_DHCP :
462 ((radv_info->adv_other_flag) ?
463 ICMP6_ROUTER_DISCOVERY_FLAG_OTHER_CONFIG_VIA_DHCP :
468 sizeof (icmp6_router_advertisement_header_t);
470 if (vlib_buffer_add_data
471 (vm, &bi0, (void *) &rh,
472 sizeof (icmp6_router_advertisement_header_t)))
474 /* buffer allocation failed, drop the pkt */
475 error0 = ICMP6_ERROR_ALLOC_FAILURE;
479 if (radv_info->adv_link_layer_address)
481 icmp6_neighbor_discovery_ethernet_link_layer_address_option_t
485 ICMP6_NEIGHBOR_DISCOVERY_OPTION_source_link_layer_address;
486 h.header.n_data_u64s = 1;
488 /* copy ll address */
489 clib_memcpy (&h.ethernet_address[0],
490 ð_if0->address, 6);
492 if (vlib_buffer_add_data
493 (vm, &bi0, (void *) &h,
495 (icmp6_neighbor_discovery_ethernet_link_layer_address_option_t)))
497 error0 = ICMP6_ERROR_ALLOC_FAILURE;
503 (icmp6_neighbor_discovery_ethernet_link_layer_address_option_t);
507 if (radv_info->adv_link_mtu)
509 icmp6_neighbor_discovery_mtu_option_t h;
513 clib_host_to_net_u32 (radv_info->adv_link_mtu);
514 h.header.type = ICMP6_NEIGHBOR_DISCOVERY_OPTION_mtu;
515 h.header.n_data_u64s = 1;
518 sizeof (icmp6_neighbor_discovery_mtu_option_t);
520 if (vlib_buffer_add_data
521 (vm, &bi0, (void *) &h,
523 (icmp6_neighbor_discovery_mtu_option_t)))
525 error0 = ICMP6_ERROR_ALLOC_FAILURE;
530 /* add advertised prefix options */
531 ip6_radv_prefix_t *pr_info;
534 pool_foreach (pr_info, radv_info->adv_prefixes_pool)
536 if(pr_info->enabled &&
537 (!pr_info->decrement_lifetime_flag
538 || (pr_info->pref_lifetime_expires >0)))
540 /* advertise this prefix */
541 icmp6_neighbor_discovery_prefix_information_option_t h;
543 h.header.type = ICMP6_NEIGHBOR_DISCOVERY_OPTION_prefix_information;
544 h.header.n_data_u64s = (sizeof(icmp6_neighbor_discovery_prefix_information_option_t) >> 3);
546 h.dst_address_length = pr_info->prefix_len;
548 h.flags = (pr_info->adv_on_link_flag) ? ICMP6_NEIGHBOR_DISCOVERY_PREFIX_INFORMATION_FLAG_ON_LINK : 0;
549 h.flags |= (pr_info->adv_autonomous_flag) ? ICMP6_NEIGHBOR_DISCOVERY_PREFIX_INFORMATION_AUTO : 0;
551 if(radv_info->cease_radv && pr_info->deprecated_prefix_flag)
553 h.valid_time = clib_host_to_net_u32(MIN_ADV_VALID_LIFETIME);
554 h.preferred_time = 0;
558 if(pr_info->decrement_lifetime_flag)
560 pr_info->adv_valid_lifetime_in_secs = ((pr_info->valid_lifetime_expires > now)) ?
561 (pr_info->valid_lifetime_expires - now) : 0;
563 pr_info->adv_pref_lifetime_in_secs = ((pr_info->pref_lifetime_expires > now)) ?
564 (pr_info->pref_lifetime_expires - now) : 0;
567 h.valid_time = clib_host_to_net_u32(pr_info->adv_valid_lifetime_in_secs);
568 h.preferred_time = clib_host_to_net_u32(pr_info->adv_pref_lifetime_in_secs) ;
572 /* Handy for debugging, but too noisy... */
573 if (0 && CLIB_DEBUG > 0)
575 ("send RA for prefix %U/%d "
576 "sw_if_index %d valid %u preferred %u",
577 format_ip6_address, &pr_info->prefix,
578 pr_info->prefix_len, sw_if_index0,
579 clib_net_to_host_u32 (h.valid_time),
580 clib_net_to_host_u32 (h.preferred_time));
582 if (h.valid_time == 0)
583 clib_warning ("BUG: send RA with valid_time 0");
585 clib_memcpy(&h.dst_address, &pr_info->prefix, sizeof(ip6_address_t));
587 payload_length += sizeof( icmp6_neighbor_discovery_prefix_information_option_t);
589 if (vlib_buffer_add_data
590 (vm, &bi0, (void *)&h,
591 sizeof(icmp6_neighbor_discovery_prefix_information_option_t)))
593 error0 = ICMP6_ERROR_ALLOC_FAILURE;
601 /* add additional options before here */
603 /* finish building the router advertisement... */
604 if (!is_unspecified && radv_info->send_unicast)
606 ip0->dst_address = ip0->src_address;
610 /* target address is all-nodes mcast addr */
611 ip6_set_reserved_multicast_address
613 IP6_MULTICAST_SCOPE_link_local,
614 IP6_MULTICAST_GROUP_ID_all_hosts);
617 /* source address MUST be the link-local address */
618 ip6_address_copy (&ip0->src_address,
619 ip6_get_link_local_address
620 (radv_info->sw_if_index));
622 ip0->hop_limit = 255;
623 ip0->payload_length =
624 clib_host_to_net_u16 (payload_length);
626 icmp6_router_advertisement_header_t *rh0 =
627 (icmp6_router_advertisement_header_t *) (ip0 + 1);
629 ip6_tcp_udp_icmp_compute_checksum (vm, p0, ip0,
631 ASSERT (bogus_length == 0);
633 /* setup output if and adjacency */
634 vnet_buffer (p0)->sw_if_index[VLIB_RX] =
635 vnet_main.local_interface_sw_if_index;
639 ethernet_header_t *eth0;
640 /* Reuse current MAC header, copy SMAC to DMAC and
641 * interface MAC to SMAC */
642 vlib_buffer_reset (p0);
643 eth0 = vlib_buffer_get_current (p0);
644 clib_memcpy (eth0->dst_address, eth0->src_address,
646 clib_memcpy (eth0->src_address, ð_if0->address,
650 ICMP6_ROUTER_SOLICITATION_NEXT_REPLY_TX;
651 vnet_buffer (p0)->sw_if_index[VLIB_TX] =
656 adj_index0 = ip6_link_get_mcast_adj (sw_if_index0);
657 if (adj_index0 == INDEX_INVALID)
658 error0 = ICMP6_ERROR_DST_LOOKUP_MISS;
663 ICMP6_ROUTER_SOLICITATION_NEXT_REPLY_RW;
664 vnet_buffer (p0)->ip.adj_index[VLIB_TX] =
668 p0->flags |= VNET_BUFFER_F_LOCALLY_ORIGINATED;
670 radv_info->n_solicitations_dropped += is_dropped;
671 radv_info->n_solicitations_rcvd += is_solicitation;
673 if ((error0 == ICMP6_ERROR_NONE) && !is_dropped)
675 radv_info->n_advertisements_sent++;
676 n_advertisements_sent++;
683 p0->error = error_node->errors[error0];
685 if (error0 != ICMP6_ERROR_NONE)
686 vlib_error_count (vm, error_node->node_index, error0, 1);
688 vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
689 to_next, n_left_to_next,
694 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
697 /* Account for router advertisements sent. */
698 vlib_error_count (vm, error_node->node_index,
699 ICMP6_ERROR_ROUTER_ADVERTISEMENTS_TX,
700 n_advertisements_sent);
702 return frame->n_vectors;
706 VLIB_REGISTER_NODE (ip6_icmp_router_solicitation_node,static) =
708 .function = icmp6_router_solicitation,
709 .name = "icmp6-router-solicitation",
711 .vector_size = sizeof (u32),
713 .format_trace = format_icmp6_input_trace,
715 .n_next_nodes = ICMP6_ROUTER_SOLICITATION_N_NEXT,
717 [ICMP6_ROUTER_SOLICITATION_NEXT_DROP] = "ip6-drop",
718 [ICMP6_ROUTER_SOLICITATION_NEXT_REPLY_RW] = "ip6-rewrite-mcast",
719 [ICMP6_ROUTER_SOLICITATION_NEXT_REPLY_TX] = "interface-output",
724 /* validate advertised info for consistancy (see RFC-4861 section 6.2.7) - log any inconsistencies, packet will always be dropped */
725 static_always_inline uword
726 icmp6_router_advertisement (vlib_main_t * vm,
727 vlib_node_runtime_t * node, vlib_frame_t * frame)
729 vnet_main_t *vnm = vnet_get_main ();
730 uword n_packets = frame->n_vectors;
732 u32 n_left_from, n_left_to_next, next_index;
733 u32 n_advertisements_rcvd = 0;
735 vlib_node_runtime_t *error_node =
736 vlib_node_get_runtime (vm, ip6_icmp_input_node.index);
738 from = vlib_frame_vector_args (frame);
739 n_left_from = n_packets;
740 next_index = node->cached_next_index;
742 if (node->flags & VLIB_NODE_FLAG_TRACE)
743 vlib_trace_frame_buffers_only (vm, node, from, frame->n_vectors,
745 sizeof (icmp6_input_trace_t));
747 while (n_left_from > 0)
749 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
751 while (n_left_from > 0 && n_left_to_next > 0)
755 ip6_ra_t *radv_info = 0;
756 icmp6_router_advertisement_header_t *h0;
757 u32 bi0, options_len0, sw_if_index0, next0, error0;
759 bi0 = to_next[0] = from[0];
766 p0 = vlib_get_buffer (vm, bi0);
767 ip0 = vlib_buffer_get_current (p0);
768 h0 = ip6_next_header (ip0);
770 clib_net_to_host_u16 (ip0->payload_length) - sizeof (h0[0]);
772 error0 = ICMP6_ERROR_NONE;
773 sw_if_index0 = vnet_buffer (p0)->sw_if_index[VLIB_RX];
775 /* Check that source address is link-local */
776 error0 = (!ip6_address_is_link_local_unicast (&ip0->src_address)) ?
777 ICMP6_ERROR_ROUTER_ADVERTISEMENT_SOURCE_NOT_LINK_LOCAL : error0;
779 /* default is to drop */
780 next0 = ICMP6_ROUTER_SOLICITATION_NEXT_DROP;
782 n_advertisements_rcvd++;
784 if (error0 == ICMP6_ERROR_NONE)
786 vnet_sw_interface_t *sw_if0;
787 ethernet_interface_t *eth_if0;
789 sw_if0 = vnet_get_sup_sw_interface (vnm, sw_if_index0);
790 ASSERT (sw_if0->type == VNET_SW_INTERFACE_TYPE_HARDWARE);
792 ethernet_get_interface (ðernet_main, sw_if0->hw_if_index);
794 /* only support ethernet interface type for now */
796 (!eth_if0) ? ICMP6_ERROR_ROUTER_SOLICITATION_UNSUPPORTED_INTF
799 if (error0 == ICMP6_ERROR_NONE)
801 /* look up the radv_t information for this interface */
802 radv_info = ip6_ra_get_itf (sw_if_index0);
804 error0 = ((!radv_info) ?
805 ICMP6_ERROR_ROUTER_SOLICITATION_RADV_NOT_CONFIG :
808 if (error0 == ICMP6_ERROR_NONE)
810 radv_info->keep_sending_rs = 0;
814 r.sw_if_index = sw_if_index0;
815 memcpy (&r.router_address, &ip0->src_address, 16);
816 r.current_hop_limit = h0->current_hop_limit;
818 r.router_lifetime_in_sec =
819 clib_net_to_host_u16 (h0->router_lifetime_in_sec);
820 r.neighbor_reachable_time_in_msec =
822 (h0->neighbor_reachable_time_in_msec);
823 r.time_in_msec_between_retransmitted_neighbor_solicitations = clib_net_to_host_u32 (h0->time_in_msec_between_retransmitted_neighbor_solicitations);
826 /* validate advertised information */
827 if ((h0->current_hop_limit && radv_info->curr_hop_limit)
828 && (h0->current_hop_limit !=
829 radv_info->curr_hop_limit))
831 ip6_neighbor_syslog (vm, LOG_WARNING,
832 "our AdvCurHopLimit on %U doesn't agree with %U",
833 format_vnet_sw_if_index_name,
840 ICMP6_ROUTER_DISCOVERY_FLAG_ADDRESS_CONFIG_VIA_DHCP)
841 != radv_info->adv_managed_flag)
843 ip6_neighbor_syslog (vm, LOG_WARNING,
844 "our AdvManagedFlag on %U doesn't agree with %U",
845 format_vnet_sw_if_index_name,
852 ICMP6_ROUTER_DISCOVERY_FLAG_OTHER_CONFIG_VIA_DHCP)
853 != radv_info->adv_other_flag)
855 ip6_neighbor_syslog (vm, LOG_WARNING,
856 "our AdvOtherConfigFlag on %U doesn't agree with %U",
857 format_vnet_sw_if_index_name,
864 time_in_msec_between_retransmitted_neighbor_solicitations
866 adv_time_in_msec_between_retransmitted_neighbor_solicitations)
868 time_in_msec_between_retransmitted_neighbor_solicitations
870 clib_host_to_net_u32 (radv_info->
871 adv_time_in_msec_between_retransmitted_neighbor_solicitations)))
873 ip6_neighbor_syslog (vm, LOG_WARNING,
874 "our AdvRetransTimer on %U doesn't agree with %U",
875 format_vnet_sw_if_index_name,
881 if ((h0->neighbor_reachable_time_in_msec &&
882 radv_info->adv_neighbor_reachable_time_in_msec) &&
883 (h0->neighbor_reachable_time_in_msec !=
885 (radv_info->adv_neighbor_reachable_time_in_msec)))
887 ip6_neighbor_syslog (vm, LOG_WARNING,
888 "our AdvReachableTime on %U doesn't agree with %U",
889 format_vnet_sw_if_index_name,
895 /* check for MTU or prefix options or .. */
896 u8 *opt_hdr = (u8 *) (h0 + 1);
897 while (options_len0 > 0)
899 icmp6_neighbor_discovery_option_header_t *o0 =
900 (icmp6_neighbor_discovery_option_header_t *)
902 int opt_len = o0->n_data_u64s << 3;
903 icmp6_neighbor_discovery_option_type_t option_type =
906 if (options_len0 < 2)
908 ip6_neighbor_syslog (vm, LOG_ERR,
909 "malformed RA packet on %U from %U",
910 format_vnet_sw_if_index_name,
919 ip6_neighbor_syslog (vm, LOG_ERR,
920 " zero length option in RA on %U from %U",
921 format_vnet_sw_if_index_name,
927 else if (opt_len > options_len0)
929 ip6_neighbor_syslog (vm, LOG_ERR,
930 "option length in RA packet greater than total length on %U from %U",
931 format_vnet_sw_if_index_name,
938 options_len0 -= opt_len;
943 case ICMP6_NEIGHBOR_DISCOVERY_OPTION_source_link_layer_address:
945 icmp6_neighbor_discovery_ethernet_link_layer_address_option_t
947 (icmp6_neighbor_discovery_ethernet_link_layer_address_option_t
950 if (opt_len < sizeof (*h))
953 memcpy (r.slla, h->ethernet_address, 6);
957 case ICMP6_NEIGHBOR_DISCOVERY_OPTION_mtu:
959 icmp6_neighbor_discovery_mtu_option_t *h =
960 (icmp6_neighbor_discovery_mtu_option_t
963 if (opt_len < sizeof (*h))
966 r.mtu = clib_net_to_host_u32 (h->mtu);
968 if ((h->mtu && radv_info->adv_link_mtu) &&
971 (radv_info->adv_link_mtu)))
973 ip6_neighbor_syslog (vm, LOG_WARNING,
974 "our AdvLinkMTU on %U doesn't agree with %U",
975 format_vnet_sw_if_index_name,
983 case ICMP6_NEIGHBOR_DISCOVERY_OPTION_prefix_information:
985 icmp6_neighbor_discovery_prefix_information_option_t
987 (icmp6_neighbor_discovery_prefix_information_option_t
990 /* validate advertised prefix options */
991 ip6_radv_prefix_t *pr_info;
992 u32 preferred, valid;
994 if (opt_len < sizeof (*h))
997 vec_validate (r.prefixes,
998 vec_len (r.prefixes));
999 ra_report_prefix_info_t *prefix =
1000 vec_elt_at_index (r.prefixes,
1001 vec_len (r.prefixes) - 1);
1004 clib_net_to_host_u32 (h->preferred_time);
1005 valid = clib_net_to_host_u32 (h->valid_time);
1007 prefix->preferred_time = preferred;
1008 prefix->valid_time = valid;
1009 prefix->flags = h->flags & 0xc0;
1010 prefix->prefix.fp_len = h->dst_address_length;
1011 prefix->prefix.fp_addr.ip6 = h->dst_address;
1012 prefix->prefix.fp_proto = FIB_PROTOCOL_IP6;
1014 /* look for matching prefix - if we our advertising it, it better be consistant */
1016 pool_foreach (pr_info, radv_info->adv_prefixes_pool)
1020 ip6_address_mask_from_width(&mask, pr_info->prefix_len);
1022 if(pr_info->enabled &&
1023 (pr_info->prefix_len == h->dst_address_length) &&
1024 ip6_address_is_equal_masked (&pr_info->prefix, &h->dst_address, &mask))
1027 if(!pr_info->decrement_lifetime_flag &&
1028 valid != pr_info->adv_valid_lifetime_in_secs)
1030 ip6_neighbor_syslog(vm, LOG_WARNING,
1031 "our ADV validlifetime on %U for %U does not agree with %U",
1032 format_vnet_sw_if_index_name, vnm, sw_if_index0,format_ip6_address, &pr_info->prefix,
1033 format_ip6_address, &h->dst_address);
1035 if(!pr_info->decrement_lifetime_flag &&
1036 preferred != pr_info->adv_pref_lifetime_in_secs)
1038 ip6_neighbor_syslog(vm, LOG_WARNING,
1039 "our ADV preferredlifetime on %U for %U does not agree with %U",
1040 format_vnet_sw_if_index_name, vnm, sw_if_index0,format_ip6_address, &pr_info->prefix,
1041 format_ip6_address, &h->dst_address);
1054 ip6_ra_publish (&r);
1059 p0->error = error_node->errors[error0];
1061 if (error0 != ICMP6_ERROR_NONE)
1062 vlib_error_count (vm, error_node->node_index, error0, 1);
1064 vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
1065 to_next, n_left_to_next,
1069 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
1072 /* Account for router advertisements received. */
1073 vlib_error_count (vm, error_node->node_index,
1074 ICMP6_ERROR_ROUTER_ADVERTISEMENTS_RX,
1075 n_advertisements_rcvd);
1077 return frame->n_vectors;
1081 VLIB_REGISTER_NODE (ip6_icmp_router_advertisement_node,static) =
1083 .function = icmp6_router_advertisement,
1084 .name = "icmp6-router-advertisement",
1086 .vector_size = sizeof (u32),
1088 .format_trace = format_icmp6_input_trace,
1098 random_f64_from_to (f64 from, f64 to)
1100 static u32 seed = 0;
1101 static u8 seed_set = 0;
1104 seed = random_default_seed ();
1107 return random_f64 (&seed) * (to - from) + from;
1111 get_mac_address (u32 sw_if_index, u8 * address)
1113 vnet_main_t *vnm = vnet_get_main ();
1114 vnet_hw_interface_t *hw_if = vnet_get_sup_hw_interface (vnm, sw_if_index);
1115 if (!hw_if->hw_address)
1117 clib_memcpy (address, hw_if->hw_address, 6);
1121 static inline vlib_buffer_t *
1122 create_buffer_for_rs (vlib_main_t * vm, ip6_ra_t * radv_info)
1126 icmp6_router_solicitation_header_t *rh;
1131 sw_if_index = radv_info->sw_if_index;
1133 if (vlib_buffer_alloc (vm, &bi0, 1) != 1)
1135 clib_warning ("buffer allocation failure");
1139 p0 = vlib_get_buffer (vm, bi0);
1140 p0->flags |= VNET_BUFFER_F_LOCALLY_ORIGINATED;
1142 vnet_buffer (p0)->sw_if_index[VLIB_RX] = sw_if_index;
1143 vnet_buffer (p0)->sw_if_index[VLIB_TX] = sw_if_index;
1145 vnet_buffer (p0)->ip.adj_index[VLIB_TX] =
1146 ip6_link_get_mcast_adj (sw_if_index);
1148 rh = vlib_buffer_get_current (p0);
1149 p0->current_length = sizeof (*rh);
1151 rh->neighbor.icmp.type = ICMP6_router_solicitation;
1152 rh->neighbor.icmp.code = 0;
1153 rh->neighbor.icmp.checksum = 0;
1154 rh->neighbor.reserved_must_be_zero = 0;
1156 rh->link_layer_option.header.type =
1157 ICMP6_NEIGHBOR_DISCOVERY_OPTION_source_link_layer_address;
1158 if (0 != get_mac_address (sw_if_index,
1159 rh->link_layer_option.ethernet_address))
1161 clib_warning ("interface with sw_if_index %u has no mac address",
1163 vlib_buffer_free (vm, &bi0, 1);
1166 rh->link_layer_option.header.n_data_u64s = 1;
1168 payload_length = sizeof (rh->neighbor) + sizeof (u64);
1170 rh->ip.ip_version_traffic_class_and_flow_label =
1171 clib_host_to_net_u32 (0x6 << 28);
1172 rh->ip.payload_length = clib_host_to_net_u16 (payload_length);
1173 rh->ip.protocol = IP_PROTOCOL_ICMP6;
1174 rh->ip.hop_limit = 255;
1175 ip6_address_copy (&rh->ip.src_address,
1176 ip6_get_link_local_address (radv_info->sw_if_index));
1177 /* set address ff02::2 */
1178 rh->ip.dst_address.as_u64[0] = clib_host_to_net_u64 (0xff02ULL << 48);
1179 rh->ip.dst_address.as_u64[1] = clib_host_to_net_u64 (2);
1181 rh->neighbor.icmp.checksum = ip6_tcp_udp_icmp_compute_checksum (vm, p0,
1189 stop_sending_rs (vlib_main_t * vm, ip6_ra_t * ra)
1193 ra->keep_sending_rs = 0;
1196 bi0 = vlib_get_buffer_index (vm, ra->buffer);
1197 vlib_buffer_free (vm, &bi0, 1);
1203 check_send_rs (vlib_main_t * vm, ip6_ra_t * radv_info, f64 current_time,
1213 icmp6_send_router_solicitation_params_t *params;
1215 if (!radv_info->keep_sending_rs)
1218 params = &radv_info->params;
1220 if (radv_info->due_time > current_time)
1222 *due_time = radv_info->due_time;
1226 p0 = radv_info->buffer;
1228 next_index = ip6_rewrite_mcast_node.index;
1230 c0 = vlib_buffer_copy (vm, p0);
1232 return radv_info->keep_sending_rs;
1234 ci0 = vlib_get_buffer_index (vm, c0);
1236 f = vlib_get_frame_to_node (vm, next_index);
1237 to_next = vlib_frame_vector_args (f);
1240 vlib_put_frame_to_node (vm, next_index, f);
1242 if (params->mrc != 0 && --radv_info->n_left == 0)
1243 stop_sending_rs (vm, radv_info);
1246 radv_info->sleep_interval =
1247 (2 + random_f64_from_to (-0.1, 0.1)) * radv_info->sleep_interval;
1248 if (radv_info->sleep_interval > params->mrt)
1249 radv_info->sleep_interval =
1250 (1 + random_f64_from_to (-0.1, 0.1)) * params->mrt;
1252 radv_info->due_time = current_time + radv_info->sleep_interval;
1254 if (params->mrd != 0
1255 && current_time > radv_info->start_time + params->mrd)
1256 stop_sending_rs (vm, radv_info);
1258 *due_time = radv_info->due_time;
1261 return radv_info->keep_sending_rs;
1265 send_rs_process (vlib_main_t * vm, vlib_node_runtime_t * rt,
1268 uword *event_data = NULL;
1269 f64 sleep_time = 1e9;
1270 ip6_ra_t *radv_info;
1277 vlib_process_wait_for_event_or_clock (vm, sleep_time);
1278 vlib_process_get_events (vm, &event_data);
1279 vec_reset_length (event_data);
1281 current_time = vlib_time_now (vm);
1284 due_time = current_time + 1e9;
1286 pool_foreach (radv_info, ip6_ra_pool)
1288 if (check_send_rs (vm, radv_info, current_time, &dt)
1293 current_time = vlib_time_now (vm);
1295 while (due_time < current_time);
1297 sleep_time = due_time - current_time;
1304 VLIB_REGISTER_NODE (ip6_rs_process_node) = {
1305 .function = send_rs_process,
1306 .type = VLIB_NODE_TYPE_PROCESS,
1307 .name = "ip6-rs-process",
1312 icmp6_send_router_solicitation (vlib_main_t * vm, u32 sw_if_index, u8 stop,
1313 const icmp6_send_router_solicitation_params_t
1318 ASSERT (~0 != sw_if_index);
1320 ra = ip6_ra_get_itf (sw_if_index);
1325 stop_sending_rs (vm, ra);
1329 ra->keep_sending_rs = 1;
1330 ra->params = *params;
1331 ra->n_left = params->mrc;
1332 ra->start_time = vlib_time_now (vm);
1333 ra->sleep_interval = (1 + random_f64_from_to (-0.1, 0.1)) * params->irt;
1334 ra->due_time = 0; /* send first packet ASAP */
1335 ra->buffer = create_buffer_for_rs (vm, ra);
1337 ra->keep_sending_rs = 0;
1339 vlib_process_signal_event (vm, ip6_rs_process_node.index, 1, 0);
1343 static const ethernet_interface_t *
1344 ip6_ra_get_eth_itf (u32 sw_if_index)
1346 const vnet_sw_interface_t *sw;
1348 /* lookup radv container - ethernet interfaces only */
1349 sw = vnet_get_sup_sw_interface (vnet_get_main (), sw_if_index);
1350 if (sw->type == VNET_SW_INTERFACE_TYPE_HARDWARE)
1351 return (ethernet_get_interface (ðernet_main, sw->hw_if_index));
1357 * @brief called when IP6 is enabled on an interface
1358 *create and initialize router advertisement parameters with default
1359 * values for this intfc
1362 ip6_ra_link_enable (u32 sw_if_index)
1364 const ethernet_interface_t *eth;
1365 ip6_ra_t *radv_info;
1367 eth = ip6_ra_get_eth_itf (sw_if_index);
1372 ASSERT (INDEX_INVALID == ip6_link_delegate_get (sw_if_index,
1373 ip6_ra_delegate_id));
1375 pool_get_zero (ip6_ra_pool, radv_info);
1377 radv_info->seed = (u32) clib_cpu_time_now ();
1378 random_u32 (&radv_info->seed);
1380 radv_info->sw_if_index = sw_if_index;
1381 radv_info->max_radv_interval = DEF_MAX_RADV_INTERVAL;
1382 radv_info->min_radv_interval = DEF_MIN_RADV_INTERVAL;
1383 radv_info->curr_hop_limit = DEF_CURR_HOP_LIMIT;
1384 radv_info->adv_router_lifetime_in_sec = DEF_DEF_RTR_LIFETIME;
1386 /* send ll address source address option */
1387 radv_info->adv_link_layer_address = 1;
1389 radv_info->min_delay_between_radv = MIN_DELAY_BETWEEN_RAS;
1390 radv_info->max_delay_between_radv = MAX_DELAY_BETWEEN_RAS;
1391 radv_info->max_rtr_default_lifetime = MAX_DEF_RTR_LIFETIME;
1393 radv_info->initial_adverts_count = MAX_INITIAL_RTR_ADVERTISEMENTS;
1394 radv_info->initial_adverts_sent = radv_info->initial_adverts_count - 1;
1395 radv_info->initial_adverts_interval = MAX_INITIAL_RTR_ADVERT_INTERVAL;
1397 /* deafult is to send */
1398 radv_info->send_radv = 1;
1400 /* fill in delegate for this interface that will be needed later */
1401 radv_info->adv_link_mtu =
1402 vnet_sw_interface_get_mtu (vnet_get_main (), sw_if_index, VNET_MTU_IP6);
1404 mhash_init (&radv_info->address_to_prefix_index, sizeof (uword),
1405 sizeof (ip6_address_t));
1407 ip6_link_delegate_update (sw_if_index, ip6_ra_delegate_id,
1408 radv_info - ip6_ra_pool);
1412 ip6_ra_delegate_disable (index_t rai)
1414 ip6_radv_prefix_t *p;
1415 ip6_ra_t *radv_info;
1417 radv_info = pool_elt_at_index (ip6_ra_pool, rai);
1419 /* clean up prefix and MDP pools */
1421 pool_flush(p, radv_info->adv_prefixes_pool,
1423 mhash_unset (&radv_info->address_to_prefix_index, &p->prefix, 0);
1427 pool_free (radv_info->adv_prefixes_pool);
1429 mhash_free (&radv_info->address_to_prefix_index);
1431 pool_put (ip6_ra_pool, radv_info);
1435 ip6_ra_update_secondary_radv_info (ip6_address_t * address, u8 prefix_len,
1436 u32 primary_sw_if_index,
1437 u32 valid_time, u32 preferred_time)
1439 vlib_main_t *vm = vlib_get_main ();
1440 static u32 *radv_indices;
1441 ip6_ra_t *radv_info;
1444 ip6_address_mask_from_width (&mask, prefix_len);
1446 vec_reset_length (radv_indices);
1448 pool_foreach (radv_info, ip6_ra_pool)
1450 vec_add1 (radv_indices, radv_info - ip6_ra_pool);
1455 * If we have another customer for this prefix,
1456 * tell the RA code about it...
1458 for (i = 0; i < vec_len (radv_indices); i++)
1460 ip6_radv_prefix_t *this_prefix;
1461 radv_info = pool_elt_at_index (ip6_ra_pool, radv_indices[i]);
1463 /* We already took care of these timers... */
1464 if (radv_info->sw_if_index == primary_sw_if_index)
1468 pool_foreach (this_prefix, radv_info->adv_prefixes_pool)
1470 if (this_prefix->prefix_len == prefix_len
1471 && ip6_address_is_equal_masked (&this_prefix->prefix, address,
1474 int rv = ip6_ra_prefix (vm,
1475 radv_info->sw_if_index,
1478 0 /* use_default */,
1481 0 /* no_advertise */,
1483 0 /* no_autoconfig */,
1487 clib_warning ("ip6_neighbor_ra_prefix returned %d", rv);
1494 /* send a RA or update the timer info etc.. */
1496 ip6_ra_process_timer_event (vlib_main_t * vm,
1497 vlib_node_runtime_t * node, vlib_frame_t * frame)
1499 vnet_main_t *vnm = vnet_get_main ();
1500 ip6_ra_t *radv_info;
1501 vlib_frame_t *f = 0;
1502 u32 n_this_frame = 0;
1503 u32 n_left_to_next = 0;
1506 icmp6_router_solicitation_header_t *h0;
1508 f64 now = vlib_time_now (vm);
1510 /* Interface ip6 radv info list */
1512 pool_foreach (radv_info, ip6_ra_pool)
1514 if( !vnet_sw_interface_is_admin_up (vnm, radv_info->sw_if_index))
1516 radv_info->initial_adverts_sent = radv_info->initial_adverts_count-1;
1517 radv_info->next_multicast_time = now;
1518 radv_info->last_multicast_time = now;
1519 radv_info->last_radv_time = 0;
1523 /* is it time to send a multicast RA on this interface? */
1524 if(radv_info->send_radv && (now >= radv_info->next_multicast_time))
1529 f64 rfn = (radv_info->max_radv_interval - radv_info->min_radv_interval) *
1530 random_f64 (&radv_info->seed) + radv_info->min_radv_interval;
1532 /* multicast send - compute next multicast send time */
1533 if( radv_info->initial_adverts_sent > 0)
1535 radv_info->initial_adverts_sent--;
1536 if(rfn > radv_info->initial_adverts_interval)
1537 rfn = radv_info->initial_adverts_interval;
1539 /* check to see if we are ceasing to send */
1540 if( radv_info->initial_adverts_sent == 0)
1541 if(radv_info->cease_radv)
1542 radv_info->send_radv = 0;
1545 radv_info->next_multicast_time = rfn + now;
1546 radv_info->last_multicast_time = now;
1548 /* send advert now - build a "solicted" router advert with unspecified source address */
1549 n_allocated = vlib_buffer_alloc (vm, &bo0, n_to_alloc);
1551 if (PREDICT_FALSE(n_allocated == 0))
1553 clib_warning ("buffer allocation failure");
1556 b0 = vlib_get_buffer (vm, bo0);
1557 b0->current_length = sizeof( icmp6_router_solicitation_header_t);
1558 b0->error = ICMP6_ERROR_NONE;
1559 vnet_buffer (b0)->sw_if_index[VLIB_RX] = radv_info->sw_if_index;
1561 h0 = vlib_buffer_get_current (b0);
1563 clib_memset (h0, 0, sizeof (icmp6_router_solicitation_header_t));
1565 h0->ip.ip_version_traffic_class_and_flow_label = clib_host_to_net_u32 (0x6 << 28);
1566 h0->ip.payload_length = clib_host_to_net_u16 (sizeof (icmp6_router_solicitation_header_t)
1567 - STRUCT_OFFSET_OF (icmp6_router_solicitation_header_t, neighbor));
1568 h0->ip.protocol = IP_PROTOCOL_ICMP6;
1569 h0->ip.hop_limit = 255;
1571 /* set src/dst address as "unspecified" this marks this packet as internally generated rather than recieved */
1572 h0->ip.src_address.as_u64[0] = 0;
1573 h0->ip.src_address.as_u64[1] = 0;
1575 h0->ip.dst_address.as_u64[0] = 0;
1576 h0->ip.dst_address.as_u64[1] = 0;
1578 h0->neighbor.icmp.type = ICMP6_router_solicitation;
1580 if (PREDICT_FALSE(f == 0))
1582 f = vlib_get_frame_to_node (vm, ip6_icmp_router_solicitation_node.index);
1583 to_next = vlib_frame_vector_args (f);
1584 n_left_to_next = VLIB_FRAME_SIZE;
1593 if (PREDICT_FALSE(n_left_to_next == 0))
1595 f->n_vectors = n_this_frame;
1596 vlib_put_frame_to_node (vm, ip6_icmp_router_solicitation_node.index, f);
1605 ASSERT (n_this_frame);
1606 f->n_vectors = n_this_frame;
1607 vlib_put_frame_to_node (vm, ip6_icmp_router_solicitation_node.index, f);
1613 ip6_ra_handle_report (ip6_ra_report_t * rap)
1617 vec_foreach_index (ii, ip6_ra_listeners) ip6_ra_listeners[ii] (rap);
1618 vec_free (rap->prefixes);
1619 clib_mem_free (rap);
1623 ip6_ra_event_process (vlib_main_t * vm,
1624 vlib_node_runtime_t * node, vlib_frame_t * frame)
1628 uword *event_data = 0;
1631 /* init code here */
1635 vlib_process_wait_for_event_or_clock (vm, 1. /* seconds */ );
1637 event_type = vlib_process_get_events (vm, &event_data);
1639 if (event_type == ~0)
1641 /* No events found: timer expired. */
1642 /* process interface list and send RAs as appropriate, update timer info */
1643 ip6_ra_process_timer_event (vm, node, frame);
1647 for (i = 0; i < vec_len (event_data); i++)
1649 r = (void *) (event_data[i]);
1650 ip6_ra_handle_report (r);
1652 vec_reset_length (event_data);
1655 return frame->n_vectors;
1659 VLIB_REGISTER_NODE (ip6_ra_process_node) =
1661 .function = ip6_ra_event_process,
1662 .name = "ip6-ra-process",
1663 .type = VLIB_NODE_TYPE_PROCESS,
1668 ip6_ra_signal_report (ip6_ra_report_t * r)
1670 vlib_main_t *vm = vlib_get_main ();
1673 if (!vec_len (ip6_ra_listeners))
1676 q = clib_mem_alloc (sizeof (*q));
1679 vlib_process_signal_event (vm, ip6_ra_process_node.index, 0, (uword) q);
1683 ip6_ra_publish (ip6_ra_report_t * r)
1685 void vl_api_rpc_call_main_thread (void *fp, u8 * data, u32 data_length);
1686 vl_api_rpc_call_main_thread (ip6_ra_signal_report, (u8 *) r, sizeof *r);
1690 /* API support functions */
1692 ip6_ra_config (vlib_main_t * vm, u32 sw_if_index,
1693 u8 suppress, u8 managed, u8 other,
1694 u8 ll_option, u8 send_unicast, u8 cease,
1695 u8 use_lifetime, u32 lifetime,
1696 u32 initial_count, u32 initial_interval,
1697 u32 max_interval, u32 min_interval, u8 is_no)
1699 ip6_ra_t *radv_info;
1701 /* look up the radv_t information for this interface */
1702 radv_info = ip6_ra_get_itf (sw_if_index);
1705 return (VNET_API_ERROR_IP6_NOT_ENABLED);
1707 if ((max_interval != 0) && (min_interval == 0))
1708 min_interval = .75 * max_interval;
1712 0) ? ((is_no) ? DEF_MAX_RADV_INTERVAL : max_interval) :
1713 radv_info->max_radv_interval;
1716 0) ? ((is_no) ? DEF_MIN_RADV_INTERVAL : min_interval) :
1717 radv_info->min_radv_interval;
1720 0) ? ((is_no) ? DEF_DEF_RTR_LIFETIME : lifetime) :
1721 radv_info->adv_router_lifetime_in_sec;
1725 if (lifetime > MAX_DEF_RTR_LIFETIME)
1726 lifetime = MAX_DEF_RTR_LIFETIME;
1728 if (lifetime <= max_interval)
1729 return VNET_API_ERROR_INVALID_VALUE;
1732 if (min_interval != 0)
1734 if ((min_interval > .75 * max_interval) || (min_interval < 3))
1735 return VNET_API_ERROR_INVALID_VALUE;
1738 if ((initial_count > MAX_INITIAL_RTR_ADVERTISEMENTS) ||
1739 (initial_interval > MAX_INITIAL_RTR_ADVERT_INTERVAL))
1740 return VNET_API_ERROR_INVALID_VALUE;
1743 if "flag" is set and is_no is true then restore default value else set value corresponding to "flag"
1744 if "flag" is clear don't change corresponding value
1746 radv_info->send_radv =
1747 (suppress != 0) ? ((is_no != 0) ? 1 : 0) : radv_info->send_radv;
1748 radv_info->adv_managed_flag =
1749 (managed != 0) ? ((is_no) ? 0 : 1) : radv_info->adv_managed_flag;
1750 radv_info->adv_other_flag =
1751 (other != 0) ? ((is_no) ? 0 : 1) : radv_info->adv_other_flag;
1752 radv_info->adv_link_layer_address =
1753 (ll_option != 0) ? ((is_no) ? 1 : 0) : radv_info->adv_link_layer_address;
1754 radv_info->send_unicast =
1755 (send_unicast != 0) ? ((is_no) ? 0 : 1) : radv_info->send_unicast;
1756 radv_info->cease_radv =
1757 (cease != 0) ? ((is_no) ? 0 : 1) : radv_info->cease_radv;
1759 radv_info->min_radv_interval = min_interval;
1760 radv_info->max_radv_interval = max_interval;
1761 radv_info->adv_router_lifetime_in_sec = lifetime;
1763 radv_info->initial_adverts_count =
1765 0) ? ((is_no) ? MAX_INITIAL_RTR_ADVERTISEMENTS : initial_count) :
1766 radv_info->initial_adverts_count;
1767 radv_info->initial_adverts_interval =
1768 (initial_interval !=
1769 0) ? ((is_no) ? MAX_INITIAL_RTR_ADVERT_INTERVAL : initial_interval) :
1770 radv_info->initial_adverts_interval;
1773 if ((cease != 0) && (is_no))
1774 radv_info->send_radv = 1;
1776 radv_info->initial_adverts_sent = radv_info->initial_adverts_count - 1;
1777 radv_info->next_multicast_time = vlib_time_now (vm);
1778 radv_info->last_multicast_time = vlib_time_now (vm);
1779 radv_info->last_radv_time = 0;
1786 ip6_ra_prefix (vlib_main_t * vm, u32 sw_if_index,
1787 ip6_address_t * prefix_addr, u8 prefix_len,
1788 u8 use_default, u32 val_lifetime, u32 pref_lifetime,
1789 u8 no_advertise, u8 off_link, u8 no_autoconfig,
1790 u8 no_onlink, u8 is_no)
1792 ip6_ra_t *radv_info;
1794 /* look up the radv_t information for this interface */
1795 radv_info = ip6_ra_get_itf (sw_if_index);
1798 return (VNET_API_ERROR_IP6_NOT_ENABLED);
1800 f64 now = vlib_time_now (vm);
1802 /* prefix info add, delete or update */
1803 ip6_radv_prefix_t *prefix;
1805 /* lookup prefix info for this address on this interface */
1806 uword *p = mhash_get (&radv_info->address_to_prefix_index, prefix_addr);
1808 prefix = p ? pool_elt_at_index (radv_info->adv_prefixes_pool, p[0]) : 0;
1814 return VNET_API_ERROR_INVALID_VALUE; /* invalid prefix */
1816 if (prefix->prefix_len != prefix_len)
1817 return VNET_API_ERROR_INVALID_VALUE_2;
1819 /* FIXME - Should the DP do this or the CP ? */
1820 /* do specific delete processing here before returning */
1821 /* try to remove from routing table */
1823 mhash_unset (&radv_info->address_to_prefix_index, prefix_addr,
1825 pool_put (radv_info->adv_prefixes_pool, prefix);
1827 radv_info->initial_adverts_sent = radv_info->initial_adverts_count - 1;
1828 radv_info->next_multicast_time = vlib_time_now (vm);
1829 radv_info->last_multicast_time = vlib_time_now (vm);
1830 radv_info->last_radv_time = 0;
1834 /* adding or changing */
1839 pool_get_zero (radv_info->adv_prefixes_pool, prefix);
1840 pi = prefix - radv_info->adv_prefixes_pool;
1841 mhash_set (&radv_info->address_to_prefix_index, prefix_addr, pi,
1844 clib_memset (prefix, 0x0, sizeof (ip6_radv_prefix_t));
1846 prefix->prefix_len = prefix_len;
1847 clib_memcpy (&prefix->prefix, prefix_addr, sizeof (ip6_address_t));
1849 /* initialize default values */
1850 prefix->adv_on_link_flag = 1; /* L bit set */
1851 prefix->adv_autonomous_flag = 1; /* A bit set */
1852 prefix->adv_valid_lifetime_in_secs = DEF_ADV_VALID_LIFETIME;
1853 prefix->adv_pref_lifetime_in_secs = DEF_ADV_PREF_LIFETIME;
1854 prefix->enabled = 1;
1855 prefix->decrement_lifetime_flag = 1;
1856 prefix->deprecated_prefix_flag = 1;
1860 /* FIXME - Should the DP do this or the CP ? */
1861 /* insert prefix into routing table as a connected prefix */
1870 if (prefix->prefix_len != prefix_len)
1871 return VNET_API_ERROR_INVALID_VALUE_2;
1875 /* FIXME - Should the DP do this or the CP ? */
1876 /* remove from routing table if already there */
1880 if ((val_lifetime == ~0) || (pref_lifetime == ~0))
1882 prefix->adv_valid_lifetime_in_secs = ~0;
1883 prefix->adv_pref_lifetime_in_secs = ~0;
1884 prefix->decrement_lifetime_flag = 0;
1888 prefix->adv_valid_lifetime_in_secs = val_lifetime;;
1889 prefix->adv_pref_lifetime_in_secs = pref_lifetime;
1892 /* copy remaining */
1893 prefix->enabled = !(no_advertise != 0);
1894 prefix->adv_on_link_flag = !((off_link != 0) || (no_onlink != 0));
1895 prefix->adv_autonomous_flag = !(no_autoconfig != 0);
1899 /* fill in the expiration times */
1900 prefix->valid_lifetime_expires = now + prefix->adv_valid_lifetime_in_secs;
1901 prefix->pref_lifetime_expires = now + prefix->adv_pref_lifetime_in_secs;
1903 radv_info->initial_adverts_sent = radv_info->initial_adverts_count - 1;
1904 radv_info->next_multicast_time = vlib_time_now (vm);
1905 radv_info->last_multicast_time = vlib_time_now (vm);
1906 radv_info->last_radv_time = 0;
1912 ip6_ra_cmd (vlib_main_t * vm,
1913 unformat_input_t * main_input, vlib_cli_command_t * cmd)
1915 vnet_main_t *vnm = vnet_get_main ();
1916 clib_error_t *error = 0;
1918 u8 suppress = 0, managed = 0, other = 0;
1919 u8 suppress_ll_option = 0, send_unicast = 0, cease = 0;
1920 u8 use_lifetime = 0;
1921 u32 sw_if_index, ra_lifetime = 0, ra_initial_count =
1922 0, ra_initial_interval = 0;
1923 u32 ra_max_interval = 0, ra_min_interval = 0;
1925 unformat_input_t _line_input, *line_input = &_line_input;
1927 int add_radv_info = 1;
1928 ip6_address_t ip6_addr;
1932 /* Get a line of input. */
1933 if (!unformat_user (main_input, unformat_line_input, line_input))
1936 /* get basic radv info for this interface */
1937 if (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1940 if (unformat_user (line_input,
1941 unformat_vnet_sw_interface, vnm, &sw_if_index))
1943 if (!ip6_ra_get_eth_itf (sw_if_index))
1946 clib_error_return (0, "Interface must be of ethernet type");
1950 if (!ip6_link_is_enabled (sw_if_index))
1952 error = clib_error_return (0, "IP6 nt enabler interface %U'",
1953 format_unformat_error, line_input);
1959 error = clib_error_return (0, "invalid interface name %U'",
1960 format_unformat_error, line_input);
1965 /* get the rest of the command */
1966 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1968 if (unformat (line_input, "no"))
1970 else if (unformat (line_input, "prefix %U/%d",
1971 unformat_ip6_address, &ip6_addr, &addr_len))
1975 else if (unformat (line_input, "ra-managed-config-flag"))
1979 else if (unformat (line_input, "ra-other-config-flag"))
1983 else if (unformat (line_input, "ra-suppress") ||
1984 unformat (line_input, "ra-surpress"))
1988 else if (unformat (line_input, "ra-suppress-link-layer") ||
1989 unformat (line_input, "ra-surpress-link-layer"))
1991 suppress_ll_option = 1;
1993 else if (unformat (line_input, "ra-send-unicast"))
1997 else if (unformat (line_input, "ra-lifetime"))
1999 if (!unformat (line_input, "%d", &ra_lifetime))
2001 error = unformat_parse_error (line_input);
2006 else if (unformat (line_input, "ra-initial"))
2009 (line_input, "%d %d", &ra_initial_count, &ra_initial_interval))
2011 error = unformat_parse_error (line_input);
2015 else if (unformat (line_input, "ra-interval"))
2017 if (!unformat (line_input, "%d", &ra_max_interval))
2019 error = unformat_parse_error (line_input);
2023 if (!unformat (line_input, "%d", &ra_min_interval))
2024 ra_min_interval = 0;
2026 else if (unformat (line_input, "ra-cease"))
2032 error = unformat_parse_error (line_input);
2039 ip6_ra_config (vm, sw_if_index,
2040 suppress, managed, other,
2041 suppress_ll_option, send_unicast, cease,
2042 use_lifetime, ra_lifetime,
2043 ra_initial_count, ra_initial_interval,
2044 ra_max_interval, ra_min_interval, is_no);
2048 u32 valid_lifetime_in_secs = 0;
2049 u32 pref_lifetime_in_secs = 0;
2050 u8 use_prefix_default_values = 0;
2051 u8 no_advertise = 0;
2053 u8 no_autoconfig = 0;
2056 /* get the rest of the command */
2057 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
2059 if (unformat (line_input, "default"))
2061 use_prefix_default_values = 1;
2064 else if (unformat (line_input, "infinite"))
2066 valid_lifetime_in_secs = ~0;
2067 pref_lifetime_in_secs = ~0;
2070 else if (unformat (line_input, "%d %d", &valid_lifetime_in_secs,
2071 &pref_lifetime_in_secs))
2078 /* get the rest of the command */
2079 while (!use_prefix_default_values &&
2080 unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
2082 if (unformat (line_input, "no-advertise"))
2084 else if (unformat (line_input, "off-link"))
2086 else if (unformat (line_input, "no-autoconfig"))
2088 else if (unformat (line_input, "no-onlink"))
2092 error = unformat_parse_error (line_input);
2097 ip6_ra_prefix (vm, sw_if_index,
2098 &ip6_addr, addr_len,
2099 use_prefix_default_values,
2100 valid_lifetime_in_secs,
2101 pref_lifetime_in_secs,
2102 no_advertise, off_link, no_autoconfig, no_onlink, is_no);
2106 unformat_free (line_input);
2112 format_ip6_ra (u8 * s, va_list * args)
2114 index_t rai = va_arg (*args, index_t);
2115 u32 indent = va_arg (*args, u32);
2116 ip6_radv_prefix_t *p;
2117 ip6_ra_t *radv_info;
2119 radv_info = pool_elt_at_index (ip6_ra_pool, rai);
2121 s = format (s, "%UAdvertised Prefixes:\n", format_white_space, indent);
2126 pool_foreach (p, radv_info->adv_prefixes_pool)
2128 s = format (s, "%Uprefix %U, length %d\n",
2129 format_white_space, indent+2,
2130 format_ip6_address, &p->prefix, p->prefix_len);
2134 s = format (s, "%UMTU is %d\n",
2135 format_white_space, indent, radv_info->adv_link_mtu);
2136 s = format (s, "%UICMP error messages are unlimited\n",
2137 format_white_space, indent);
2138 s = format (s, "%UICMP redirects are disabled\n",
2139 format_white_space, indent);
2140 s = format (s, "%UICMP unreachables are not sent\n",
2141 format_white_space, indent);
2142 s = format (s, "%UND DAD is disabled\n", format_white_space, indent);
2143 //s = format (s, "%UND reachable time is %d milliseconds\n",);
2144 s = format (s, "%UND advertised reachable time is %d\n",
2145 format_white_space, indent,
2146 radv_info->adv_neighbor_reachable_time_in_msec);
2148 "%UND advertised retransmit interval is %d (msec)\n",
2149 format_white_space, indent,
2151 adv_time_in_msec_between_retransmitted_neighbor_solicitations);
2154 "%UND router advertisements are sent every %0.1f seconds (min interval is %0.1f)\n",
2155 format_white_space, indent, radv_info->max_radv_interval,
2156 radv_info->min_radv_interval);
2158 format (s, "%UND router advertisements live for %d seconds\n",
2159 format_white_space, indent,
2160 radv_info->adv_router_lifetime_in_sec);
2162 format (s, "%UHosts %s stateless autoconfig for addresses\n",
2163 format_white_space, indent,
2164 (radv_info->adv_managed_flag) ? "use" : " don't use");
2166 format (s, "%UND router advertisements sent %d\n", format_white_space,
2167 indent, radv_info->n_advertisements_sent);
2169 format (s, "%UND router solicitations received %d\n", format_white_space,
2170 indent, radv_info->n_solicitations_rcvd);
2172 format (s, "%UND router solicitations dropped %d\n", format_white_space,
2173 indent, radv_info->n_solicitations_dropped);
2180 * This command is used to configure the neighbor discovery
2181 * parameters on a given interface. Use the '<em>show ip6 interface</em>'
2182 * command to display some of the current neighbor discovery parameters
2183 * on a given interface. This command has three formats:
2186 * <b>Format 1 - Router Advertisement Options:</b> (Only one can be entered in a single command)
2188 * '<em><b>ip6 nd <interface> [no] [ra-managed-config-flag] | [ra-other-config-flag] | [ra-suppress] | [ra-suppress-link-layer] | [ra-send-unicast] | [ra-lifetime <lifetime>] | [ra-initial <cnt> <interval>] | [ra-interval <max-interval> [<min-interval>]] | [ra-cease]</b></em>'
2192 * <em>[no] ra-managed-config-flag</em> - Advertises in ICMPv6
2193 * router-advertisement messages to use stateful address
2194 * auto-configuration to obtain address information (sets the M-bit).
2195 * Default is the M-bit is not set and the '<em>no</em>' option
2196 * returns it to this default state.
2198 * <em>[no] ra-other-config-flag</em> - Indicates in ICMPv6
2199 * router-advertisement messages that hosts use stateful auto
2200 * configuration to obtain nonaddress related information (sets
2201 * the O-bit). Default is the O-bit is not set and the '<em>no</em>'
2202 * option returns it to this default state.
2204 * <em>[no] ra-suppress</em> - Disables sending ICMPv6 router-advertisement
2205 * messages. The '<em>no</em>' option implies to enable sending ICMPv6
2206 * router-advertisement messages.
2208 * <em>[no] ra-suppress-link-layer</em> - Indicates not to include the
2209 * optional source link-layer address in the ICMPv6 router-advertisement
2210 * messages. Default is to include the optional source link-layer address
2211 * and the '<em>no</em>' option returns it to this default state.
2213 * <em>[no] ra-send-unicast</em> - Use the source address of the
2214 * router-solicitation message if availiable. The default is to use
2215 * multicast address of all nodes, and the '<em>no</em>' option returns
2216 * it to this default state.
2218 * <em>[no] ra-lifetime <lifetime></em> - Advertises the lifetime of a
2219 * default router in ICMPv6 router-advertisement messages. The range is
2220 * from 0 to 9000 seconds. '<em><lifetime></em>' must be greater than
2221 * '<em><max-interval></em>'. The default value is 600 seconds and the
2222 * '<em>no</em>' option returns it to this default value.
2224 * <em>[no] ra-initial <cnt> <interval></em> - Number of initial ICMPv6
2225 * router-advertisement messages sent and the interval between each
2226 * message. Range for count is 1 - 3 and default is 3. Range for interval
2227 * is 1 to 16 seconds, and default is 16 seconds. The '<em>no</em>' option
2228 * returns both to their default value.
2230 * <em>[no] ra-interval <max-interval> [<min-interval>]</em> - Configures the
2231 * interval between sending ICMPv6 router-advertisement messages. The
2232 * range for max-interval is from 4 to 200 seconds. min-interval can not
2233 * be more than 75% of max-interval. If not set, min-interval will be
2234 * set to 75% of max-interval. The range for min-interval is from 3 to
2235 * 150 seconds. The '<em>no</em>' option returns both to their default
2238 * <em>[no] ra-cease</em> - Cease sending ICMPv6 router-advertisement messages.
2239 * The '<em>no</em>' options implies to start (or restart) sending
2240 * ICMPv6 router-advertisement messages.
2243 * <b>Format 2 - Prefix Options:</b>
2245 * '<em><b>ip6 nd <interface> [no] prefix <ip6-address>/<width> [<valid-lifetime> <pref-lifetime> | infinite] [no-advertise] [off-link] [no-autoconfig] [no-onlink]</b></em>'
2249 * <em>no</em> - All additional flags are ignored and the prefix is deleted.
2251 * <em><valid-lifetime> <pref-lifetime></em> - '<em><valid-lifetime></em>' is the
2252 * length of time in seconds during what the prefix is valid for the purpose of
2253 * on-link determination. Range is 7203 to 2592000 seconds and default is 2592000
2254 * seconds (30 days). '<em><pref-lifetime></em>' is the prefered-lifetime and is the
2255 * length of time in seconds during what addresses generated from the prefix remain
2256 * preferred. Range is 0 to 604800 seconds and default is 604800 seconds (7 days).
2258 * <em>infinite</em> - Both '<em><valid-lifetime></em>' and '<em><<pref-lifetime></em>'
2259 * are inifinte, no timeout.
2261 * <em>no-advertise</em> - Do not send full router address in prefix
2262 * advertisement. Default is to advertise (i.e. - This flag is off by default).
2264 * <em>off-link</em> - Prefix is off-link, clear L-bit in packet. Default is on-link
2265 * (i.e. - This flag is off and L-bit in packet is set by default and this prefix can
2266 * be used for on-link determination). '<em>no-onlink</em>' also controls the L-bit.
2268 * <em>no-autoconfig</em> - Do not use prefix for autoconfiguration, clear A-bit in packet.
2269 * Default is autoconfig (i.e. - This flag is off and A-bit in packet is set by default.
2271 * <em>no-onlink</em> - Do not use prefix for onlink determination, clear L-bit in packet.
2272 * Default is on-link (i.e. - This flag is off and L-bit in packet is set by default and
2273 * this prefix can be used for on-link determination). '<em>off-link</em>' also controls
2277 * <b>Format 3: - Default of Prefix:</b>
2279 * '<em><b>ip6 nd <interface> [no] prefix <ip6-address>/<width> default</b></em>'
2281 * When a new prefix is added (or existing one is being overwritten) <em>default</em>
2282 * uses default values for the prefix. If <em>no</em> is used, the <em>default</em>
2283 * is ignored and the prefix is deleted.
2287 * Example of how set a router advertisement option:
2288 * @cliexcmd{ip6 nd GigabitEthernet2/0/0 ra-interval 100 20}
2289 * Example of how to add a prefix:
2290 * @cliexcmd{ip6 nd GigabitEthernet2/0/0 prefix fe80::fe:28ff:fe9c:75b3/64 infinite no-advertise}
2291 * Example of how to delete a prefix:
2292 * @cliexcmd{ip6 nd GigabitEthernet2/0/0 no prefix fe80::fe:28ff:fe9c:75b3/64}
2295 VLIB_CLI_COMMAND (ip6_nd_command, static) =
2298 .short_help = "ip6 nd <interface> ...",
2299 .function = ip6_ra_cmd,
2304 * VFT for registering as a delegate to an IP6 link
2306 const static ip6_link_delegate_vft_t ip6_ra_delegate_vft = {
2307 .ildv_disable = ip6_ra_delegate_disable,
2308 .ildv_enable = ip6_ra_link_enable,
2309 .ildv_format = format_ip6_ra,
2312 static clib_error_t *
2313 ip6_ra_init (vlib_main_t * vm)
2315 vlib_call_init_function (vm, icmp6_init);
2317 icmp6_register_type (vm, ICMP6_router_solicitation,
2318 ip6_icmp_router_solicitation_node.index);
2319 icmp6_register_type (vm, ICMP6_router_advertisement,
2320 ip6_icmp_router_advertisement_node.index);
2322 ip6_ra_delegate_id = ip6_link_delegate_register (&ip6_ra_delegate_vft);
2328 VLIB_INIT_FUNCTION (ip6_ra_init) =
2330 .runs_after = VLIB_INITS("icmp6_init"),
2335 * fd.io coding-style-patch-verification: ON
2338 * eval: (c-set-style "gnu")