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;
273 static_always_inline uword
274 icmp6_router_solicitation (vlib_main_t * vm,
275 vlib_node_runtime_t * node, vlib_frame_t * frame)
277 vnet_main_t *vnm = vnet_get_main ();
278 ip6_main_t *im = &ip6_main;
279 uword n_packets = frame->n_vectors;
281 u32 n_left_from, n_left_to_next, next_index;
282 u32 n_advertisements_sent = 0;
285 icmp6_neighbor_discovery_option_type_t option_type;
287 vlib_node_runtime_t *error_node =
288 vlib_node_get_runtime (vm, ip6_icmp_input_node.index);
290 from = vlib_frame_vector_args (frame);
291 n_left_from = n_packets;
292 next_index = node->cached_next_index;
294 if (node->flags & VLIB_NODE_FLAG_TRACE)
295 vlib_trace_frame_buffers_only (vm, node, from, frame->n_vectors,
297 sizeof (icmp6_input_trace_t));
299 /* source may append his LL address */
300 option_type = ICMP6_NEIGHBOR_DISCOVERY_OPTION_source_link_layer_address;
302 while (n_left_from > 0)
304 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
306 while (n_left_from > 0 && n_left_to_next > 0)
310 ip6_ra_t *radv_info = NULL;
312 icmp6_neighbor_discovery_header_t *h0;
313 icmp6_neighbor_discovery_ethernet_link_layer_address_option_t *o0;
315 u32 bi0, options_len0, sw_if_index0, next0, error0;
316 u32 is_solicitation = 1, is_dropped = 0;
317 u32 is_unspecified, is_link_local;
319 bi0 = to_next[0] = from[0];
326 p0 = vlib_get_buffer (vm, bi0);
327 ip0 = vlib_buffer_get_current (p0);
328 h0 = ip6_next_header (ip0);
330 clib_net_to_host_u16 (ip0->payload_length) - sizeof (h0[0]);
331 is_unspecified = ip6_address_is_unspecified (&ip0->src_address);
333 ip6_address_is_link_local_unicast (&ip0->src_address);
335 error0 = ICMP6_ERROR_NONE;
336 sw_if_index0 = vnet_buffer (p0)->sw_if_index[VLIB_RX];
338 /* check if solicitation (not from nd_timer node) */
339 if (ip6_address_is_unspecified (&ip0->dst_address))
342 /* Check that source address is unspecified, link-local or else on-link. */
343 if (!is_unspecified && !is_link_local)
345 u32 src_adj_index0 = ip6_src_lookup_for_packet (im, p0, ip0);
347 if (ADJ_INDEX_INVALID != src_adj_index0)
349 ip_adjacency_t *adj0 = adj_get (src_adj_index0);
351 error0 = (adj0->rewrite_header.sw_if_index != sw_if_index0
353 ICMP6_ERROR_ROUTER_SOLICITATION_SOURCE_NOT_ON_LINK
358 error0 = ICMP6_ERROR_ROUTER_SOLICITATION_SOURCE_NOT_ON_LINK;
362 /* check for source LL option and process */
363 o0 = (void *) (h0 + 1);
364 o0 = ((options_len0 == 8
365 && o0->header.type == option_type
366 && o0->header.n_data_u64s == 1) ? o0 : 0);
368 /* if src address unspecified IGNORE any options */
369 if (PREDICT_TRUE (error0 == ICMP6_ERROR_NONE && o0 != 0 &&
370 !is_unspecified && !is_link_local))
373 ip_neighbor_learn_t learn = {
374 .sw_if_index = sw_if_index0,
376 .ip.ip6 = ip0->src_address,
381 memcpy (&learn.mac, o0->ethernet_address, sizeof (learn.mac));
382 ip_neighbor_learn_dp (&learn);
385 /* default is to drop */
386 next0 = ICMP6_ROUTER_SOLICITATION_NEXT_DROP;
388 if (error0 == ICMP6_ERROR_NONE)
390 vnet_sw_interface_t *sw_if0;
391 ethernet_interface_t *eth_if0;
394 sw_if0 = vnet_get_sup_sw_interface (vnm, sw_if_index0);
395 ASSERT (sw_if0->type == VNET_SW_INTERFACE_TYPE_HARDWARE);
397 ethernet_get_interface (ðernet_main, sw_if0->hw_if_index);
399 /* only support ethernet interface type for now */
401 (!eth_if0) ? ICMP6_ERROR_ROUTER_SOLICITATION_UNSUPPORTED_INTF
404 if (error0 == ICMP6_ERROR_NONE)
406 /* adjust the sizeof the buffer to just include the ipv6 header */
407 p0->current_length -=
409 sizeof (icmp6_neighbor_discovery_header_t));
411 radv_info = ip6_ra_get_itf (sw_if_index0);
413 error0 = ((!radv_info) ?
414 ICMP6_ERROR_ROUTER_SOLICITATION_RADV_NOT_CONFIG :
417 if (error0 == ICMP6_ERROR_NONE)
419 f64 now = vlib_time_now (vm);
421 /* for solicited adverts - need to rate limit */
424 if (0 != radv_info->last_radv_time &&
425 (now - radv_info->last_radv_time) <
426 MIN_DELAY_BETWEEN_RAS)
429 radv_info->last_radv_time = now;
433 icmp6_router_advertisement_header_t rh;
435 rh.icmp.type = ICMP6_router_advertisement;
437 rh.icmp.checksum = 0;
439 rh.current_hop_limit = radv_info->curr_hop_limit;
440 rh.router_lifetime_in_sec =
442 (radv_info->adv_router_lifetime_in_sec);
444 time_in_msec_between_retransmitted_neighbor_solicitations
446 clib_host_to_net_u32 (radv_info->
447 adv_time_in_msec_between_retransmitted_neighbor_solicitations);
448 rh.neighbor_reachable_time_in_msec =
449 clib_host_to_net_u32 (radv_info->
450 adv_neighbor_reachable_time_in_msec);
453 (radv_info->adv_managed_flag) ?
454 ICMP6_ROUTER_DISCOVERY_FLAG_ADDRESS_CONFIG_VIA_DHCP :
457 ((radv_info->adv_other_flag) ?
458 ICMP6_ROUTER_DISCOVERY_FLAG_OTHER_CONFIG_VIA_DHCP :
463 sizeof (icmp6_router_advertisement_header_t);
465 if (vlib_buffer_add_data
466 (vm, &bi0, (void *) &rh,
467 sizeof (icmp6_router_advertisement_header_t)))
469 /* buffer allocation failed, drop the pkt */
470 error0 = ICMP6_ERROR_ALLOC_FAILURE;
474 if (radv_info->adv_link_layer_address)
476 icmp6_neighbor_discovery_ethernet_link_layer_address_option_t
480 ICMP6_NEIGHBOR_DISCOVERY_OPTION_source_link_layer_address;
481 h.header.n_data_u64s = 1;
483 /* copy ll address */
484 clib_memcpy (&h.ethernet_address[0],
485 ð_if0->address, 6);
487 if (vlib_buffer_add_data
488 (vm, &bi0, (void *) &h,
490 (icmp6_neighbor_discovery_ethernet_link_layer_address_option_t)))
492 error0 = ICMP6_ERROR_ALLOC_FAILURE;
498 (icmp6_neighbor_discovery_ethernet_link_layer_address_option_t);
502 if (radv_info->adv_link_mtu)
504 icmp6_neighbor_discovery_mtu_option_t h;
508 clib_host_to_net_u32 (radv_info->adv_link_mtu);
509 h.header.type = ICMP6_NEIGHBOR_DISCOVERY_OPTION_mtu;
510 h.header.n_data_u64s = 1;
513 sizeof (icmp6_neighbor_discovery_mtu_option_t);
515 if (vlib_buffer_add_data
516 (vm, &bi0, (void *) &h,
518 (icmp6_neighbor_discovery_mtu_option_t)))
520 error0 = ICMP6_ERROR_ALLOC_FAILURE;
525 /* add advertised prefix options */
526 ip6_radv_prefix_t *pr_info;
529 pool_foreach (pr_info, radv_info->adv_prefixes_pool)
531 if(pr_info->enabled &&
532 (!pr_info->decrement_lifetime_flag
533 || (pr_info->pref_lifetime_expires >0)))
535 /* advertise this prefix */
536 icmp6_neighbor_discovery_prefix_information_option_t h;
538 h.header.type = ICMP6_NEIGHBOR_DISCOVERY_OPTION_prefix_information;
539 h.header.n_data_u64s = (sizeof(icmp6_neighbor_discovery_prefix_information_option_t) >> 3);
541 h.dst_address_length = pr_info->prefix_len;
543 h.flags = (pr_info->adv_on_link_flag) ? ICMP6_NEIGHBOR_DISCOVERY_PREFIX_INFORMATION_FLAG_ON_LINK : 0;
544 h.flags |= (pr_info->adv_autonomous_flag) ? ICMP6_NEIGHBOR_DISCOVERY_PREFIX_INFORMATION_AUTO : 0;
546 if(radv_info->cease_radv && pr_info->deprecated_prefix_flag)
548 h.valid_time = clib_host_to_net_u32(MIN_ADV_VALID_LIFETIME);
549 h.preferred_time = 0;
553 if(pr_info->decrement_lifetime_flag)
555 pr_info->adv_valid_lifetime_in_secs = ((pr_info->valid_lifetime_expires > now)) ?
556 (pr_info->valid_lifetime_expires - now) : 0;
558 pr_info->adv_pref_lifetime_in_secs = ((pr_info->pref_lifetime_expires > now)) ?
559 (pr_info->pref_lifetime_expires - now) : 0;
562 h.valid_time = clib_host_to_net_u32(pr_info->adv_valid_lifetime_in_secs);
563 h.preferred_time = clib_host_to_net_u32(pr_info->adv_pref_lifetime_in_secs) ;
567 /* Handy for debugging, but too noisy... */
568 if (0 && CLIB_DEBUG > 0)
570 ("send RA for prefix %U/%d "
571 "sw_if_index %d valid %u preferred %u",
572 format_ip6_address, &pr_info->prefix,
573 pr_info->prefix_len, sw_if_index0,
574 clib_net_to_host_u32 (h.valid_time),
575 clib_net_to_host_u32 (h.preferred_time));
577 if (h.valid_time == 0)
578 clib_warning ("BUG: send RA with valid_time 0");
580 clib_memcpy(&h.dst_address, &pr_info->prefix, sizeof(ip6_address_t));
582 payload_length += sizeof( icmp6_neighbor_discovery_prefix_information_option_t);
584 if (vlib_buffer_add_data
585 (vm, &bi0, (void *)&h,
586 sizeof(icmp6_neighbor_discovery_prefix_information_option_t)))
588 error0 = ICMP6_ERROR_ALLOC_FAILURE;
596 /* add additional options before here */
598 /* finish building the router advertisement... */
599 if (!is_unspecified && radv_info->send_unicast)
601 ip0->dst_address = ip0->src_address;
605 /* target address is all-nodes mcast addr */
606 ip6_set_reserved_multicast_address
608 IP6_MULTICAST_SCOPE_link_local,
609 IP6_MULTICAST_GROUP_ID_all_hosts);
612 /* source address MUST be the link-local address */
613 ip6_address_copy (&ip0->src_address,
614 ip6_get_link_local_address
615 (radv_info->sw_if_index));
617 ip0->hop_limit = 255;
618 ip0->payload_length =
619 clib_host_to_net_u16 (payload_length);
621 icmp6_router_advertisement_header_t *rh0 =
622 (icmp6_router_advertisement_header_t *) (ip0 + 1);
624 ip6_tcp_udp_icmp_compute_checksum (vm, p0, ip0,
626 ASSERT (bogus_length == 0);
628 /* setup output if and adjacency */
629 vnet_buffer (p0)->sw_if_index[VLIB_RX] =
630 vnet_main.local_interface_sw_if_index;
634 ethernet_header_t *eth0;
635 /* Reuse current MAC header, copy SMAC to DMAC and
636 * interface MAC to SMAC */
637 vlib_buffer_reset (p0);
638 eth0 = vlib_buffer_get_current (p0);
639 clib_memcpy (eth0->dst_address, eth0->src_address,
641 clib_memcpy (eth0->src_address, ð_if0->address,
645 ICMP6_ROUTER_SOLICITATION_NEXT_REPLY_TX;
646 vnet_buffer (p0)->sw_if_index[VLIB_TX] =
651 adj_index0 = ip6_link_get_mcast_adj (sw_if_index0);
652 if (adj_index0 == INDEX_INVALID)
653 error0 = ICMP6_ERROR_DST_LOOKUP_MISS;
658 ICMP6_ROUTER_SOLICITATION_NEXT_REPLY_RW;
659 vnet_buffer (p0)->ip.adj_index[VLIB_TX] =
663 p0->flags |= VNET_BUFFER_F_LOCALLY_ORIGINATED;
665 radv_info->n_solicitations_dropped += is_dropped;
666 radv_info->n_solicitations_rcvd += is_solicitation;
668 if ((error0 == ICMP6_ERROR_NONE) && !is_dropped)
670 radv_info->n_advertisements_sent++;
671 n_advertisements_sent++;
678 p0->error = error_node->errors[error0];
680 if (error0 != ICMP6_ERROR_NONE)
681 vlib_error_count (vm, error_node->node_index, error0, 1);
683 vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
684 to_next, n_left_to_next,
689 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
692 /* Account for router advertisements sent. */
693 vlib_error_count (vm, error_node->node_index,
694 ICMP6_ERROR_ROUTER_ADVERTISEMENTS_TX,
695 n_advertisements_sent);
697 return frame->n_vectors;
701 VLIB_REGISTER_NODE (ip6_icmp_router_solicitation_node,static) =
703 .function = icmp6_router_solicitation,
704 .name = "icmp6-router-solicitation",
706 .vector_size = sizeof (u32),
708 .format_trace = format_icmp6_input_trace,
710 .n_next_nodes = ICMP6_ROUTER_SOLICITATION_N_NEXT,
712 [ICMP6_ROUTER_SOLICITATION_NEXT_DROP] = "ip6-drop",
713 [ICMP6_ROUTER_SOLICITATION_NEXT_REPLY_RW] = "ip6-rewrite-mcast",
714 [ICMP6_ROUTER_SOLICITATION_NEXT_REPLY_TX] = "interface-output",
719 /* validate advertised info for consistancy (see RFC-4861 section 6.2.7) - log any inconsistencies, packet will always be dropped */
720 static_always_inline uword
721 icmp6_router_advertisement (vlib_main_t * vm,
722 vlib_node_runtime_t * node, vlib_frame_t * frame)
724 vnet_main_t *vnm = vnet_get_main ();
725 uword n_packets = frame->n_vectors;
727 u32 n_left_from, n_left_to_next, next_index;
728 u32 n_advertisements_rcvd = 0;
730 vlib_node_runtime_t *error_node =
731 vlib_node_get_runtime (vm, ip6_icmp_input_node.index);
733 from = vlib_frame_vector_args (frame);
734 n_left_from = n_packets;
735 next_index = node->cached_next_index;
737 if (node->flags & VLIB_NODE_FLAG_TRACE)
738 vlib_trace_frame_buffers_only (vm, node, from, frame->n_vectors,
740 sizeof (icmp6_input_trace_t));
742 while (n_left_from > 0)
744 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
746 while (n_left_from > 0 && n_left_to_next > 0)
750 ip6_ra_t *radv_info = 0;
751 icmp6_router_advertisement_header_t *h0;
752 u32 bi0, options_len0, sw_if_index0, next0, error0;
754 bi0 = to_next[0] = from[0];
761 p0 = vlib_get_buffer (vm, bi0);
762 ip0 = vlib_buffer_get_current (p0);
763 h0 = ip6_next_header (ip0);
765 clib_net_to_host_u16 (ip0->payload_length) - sizeof (h0[0]);
767 error0 = ICMP6_ERROR_NONE;
768 sw_if_index0 = vnet_buffer (p0)->sw_if_index[VLIB_RX];
770 /* Check that source address is link-local */
771 error0 = (!ip6_address_is_link_local_unicast (&ip0->src_address)) ?
772 ICMP6_ERROR_ROUTER_ADVERTISEMENT_SOURCE_NOT_LINK_LOCAL : error0;
774 /* default is to drop */
775 next0 = ICMP6_ROUTER_SOLICITATION_NEXT_DROP;
777 n_advertisements_rcvd++;
779 if (error0 == ICMP6_ERROR_NONE)
781 vnet_sw_interface_t *sw_if0;
782 ethernet_interface_t *eth_if0;
784 sw_if0 = vnet_get_sup_sw_interface (vnm, sw_if_index0);
785 ASSERT (sw_if0->type == VNET_SW_INTERFACE_TYPE_HARDWARE);
787 ethernet_get_interface (ðernet_main, sw_if0->hw_if_index);
789 /* only support ethernet interface type for now */
791 (!eth_if0) ? ICMP6_ERROR_ROUTER_SOLICITATION_UNSUPPORTED_INTF
794 if (error0 == ICMP6_ERROR_NONE)
796 /* look up the radv_t information for this interface */
797 radv_info = ip6_ra_get_itf (sw_if_index0);
799 error0 = ((!radv_info) ?
800 ICMP6_ERROR_ROUTER_SOLICITATION_RADV_NOT_CONFIG :
803 if (error0 == ICMP6_ERROR_NONE)
805 radv_info->keep_sending_rs = 0;
809 r.sw_if_index = sw_if_index0;
810 memcpy (&r.router_address, &ip0->src_address, 16);
811 r.current_hop_limit = h0->current_hop_limit;
813 r.router_lifetime_in_sec =
814 clib_net_to_host_u16 (h0->router_lifetime_in_sec);
815 r.neighbor_reachable_time_in_msec =
817 (h0->neighbor_reachable_time_in_msec);
818 r.time_in_msec_between_retransmitted_neighbor_solicitations = clib_net_to_host_u32 (h0->time_in_msec_between_retransmitted_neighbor_solicitations);
821 /* validate advertised information */
822 if ((h0->current_hop_limit && radv_info->curr_hop_limit)
823 && (h0->current_hop_limit !=
824 radv_info->curr_hop_limit))
826 ip6_neighbor_syslog (vm, LOG_WARNING,
827 "our AdvCurHopLimit on %U doesn't agree with %U",
828 format_vnet_sw_if_index_name,
835 ICMP6_ROUTER_DISCOVERY_FLAG_ADDRESS_CONFIG_VIA_DHCP)
836 != radv_info->adv_managed_flag)
838 ip6_neighbor_syslog (vm, LOG_WARNING,
839 "our AdvManagedFlag on %U doesn't agree with %U",
840 format_vnet_sw_if_index_name,
847 ICMP6_ROUTER_DISCOVERY_FLAG_OTHER_CONFIG_VIA_DHCP)
848 != radv_info->adv_other_flag)
850 ip6_neighbor_syslog (vm, LOG_WARNING,
851 "our AdvOtherConfigFlag on %U doesn't agree with %U",
852 format_vnet_sw_if_index_name,
859 time_in_msec_between_retransmitted_neighbor_solicitations
861 adv_time_in_msec_between_retransmitted_neighbor_solicitations)
863 time_in_msec_between_retransmitted_neighbor_solicitations
865 clib_host_to_net_u32 (radv_info->
866 adv_time_in_msec_between_retransmitted_neighbor_solicitations)))
868 ip6_neighbor_syslog (vm, LOG_WARNING,
869 "our AdvRetransTimer on %U doesn't agree with %U",
870 format_vnet_sw_if_index_name,
876 if ((h0->neighbor_reachable_time_in_msec &&
877 radv_info->adv_neighbor_reachable_time_in_msec) &&
878 (h0->neighbor_reachable_time_in_msec !=
880 (radv_info->adv_neighbor_reachable_time_in_msec)))
882 ip6_neighbor_syslog (vm, LOG_WARNING,
883 "our AdvReachableTime on %U doesn't agree with %U",
884 format_vnet_sw_if_index_name,
890 /* check for MTU or prefix options or .. */
891 u8 *opt_hdr = (u8 *) (h0 + 1);
892 while (options_len0 > 0)
894 icmp6_neighbor_discovery_option_header_t *o0 =
895 (icmp6_neighbor_discovery_option_header_t *)
897 int opt_len = o0->n_data_u64s << 3;
898 icmp6_neighbor_discovery_option_type_t option_type =
901 if (options_len0 < 2)
903 ip6_neighbor_syslog (vm, LOG_ERR,
904 "malformed RA packet on %U from %U",
905 format_vnet_sw_if_index_name,
914 ip6_neighbor_syslog (vm, LOG_ERR,
915 " zero length option in RA on %U from %U",
916 format_vnet_sw_if_index_name,
922 else if (opt_len > options_len0)
924 ip6_neighbor_syslog (vm, LOG_ERR,
925 "option length in RA packet greater than total length on %U from %U",
926 format_vnet_sw_if_index_name,
933 options_len0 -= opt_len;
938 case ICMP6_NEIGHBOR_DISCOVERY_OPTION_source_link_layer_address:
940 icmp6_neighbor_discovery_ethernet_link_layer_address_option_t
942 (icmp6_neighbor_discovery_ethernet_link_layer_address_option_t
945 if (opt_len < sizeof (*h))
948 memcpy (r.slla, h->ethernet_address, 6);
952 case ICMP6_NEIGHBOR_DISCOVERY_OPTION_mtu:
954 icmp6_neighbor_discovery_mtu_option_t *h =
955 (icmp6_neighbor_discovery_mtu_option_t
958 if (opt_len < sizeof (*h))
961 r.mtu = clib_net_to_host_u32 (h->mtu);
963 if ((h->mtu && radv_info->adv_link_mtu) &&
966 (radv_info->adv_link_mtu)))
968 ip6_neighbor_syslog (vm, LOG_WARNING,
969 "our AdvLinkMTU on %U doesn't agree with %U",
970 format_vnet_sw_if_index_name,
978 case ICMP6_NEIGHBOR_DISCOVERY_OPTION_prefix_information:
980 icmp6_neighbor_discovery_prefix_information_option_t
982 (icmp6_neighbor_discovery_prefix_information_option_t
985 /* validate advertised prefix options */
986 ip6_radv_prefix_t *pr_info;
987 u32 preferred, valid;
989 if (opt_len < sizeof (*h))
992 vec_validate (r.prefixes,
993 vec_len (r.prefixes));
994 ra_report_prefix_info_t *prefix =
995 vec_elt_at_index (r.prefixes,
996 vec_len (r.prefixes) - 1);
999 clib_net_to_host_u32 (h->preferred_time);
1000 valid = clib_net_to_host_u32 (h->valid_time);
1002 prefix->preferred_time = preferred;
1003 prefix->valid_time = valid;
1004 prefix->flags = h->flags & 0xc0;
1005 prefix->prefix.fp_len = h->dst_address_length;
1006 prefix->prefix.fp_addr.ip6 = h->dst_address;
1007 prefix->prefix.fp_proto = FIB_PROTOCOL_IP6;
1009 /* look for matching prefix - if we our advertising it, it better be consistant */
1011 pool_foreach (pr_info, radv_info->adv_prefixes_pool)
1015 ip6_address_mask_from_width(&mask, pr_info->prefix_len);
1017 if(pr_info->enabled &&
1018 (pr_info->prefix_len == h->dst_address_length) &&
1019 ip6_address_is_equal_masked (&pr_info->prefix, &h->dst_address, &mask))
1022 if(!pr_info->decrement_lifetime_flag &&
1023 valid != pr_info->adv_valid_lifetime_in_secs)
1025 ip6_neighbor_syslog(vm, LOG_WARNING,
1026 "our ADV validlifetime on %U for %U does not agree with %U",
1027 format_vnet_sw_if_index_name, vnm, sw_if_index0,format_ip6_address, &pr_info->prefix,
1028 format_ip6_address, &h->dst_address);
1030 if(!pr_info->decrement_lifetime_flag &&
1031 preferred != pr_info->adv_pref_lifetime_in_secs)
1033 ip6_neighbor_syslog(vm, LOG_WARNING,
1034 "our ADV preferredlifetime on %U for %U does not agree with %U",
1035 format_vnet_sw_if_index_name, vnm, sw_if_index0,format_ip6_address, &pr_info->prefix,
1036 format_ip6_address, &h->dst_address);
1049 ip6_ra_publish (&r);
1054 p0->error = error_node->errors[error0];
1056 if (error0 != ICMP6_ERROR_NONE)
1057 vlib_error_count (vm, error_node->node_index, error0, 1);
1059 vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
1060 to_next, n_left_to_next,
1064 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
1067 /* Account for router advertisements received. */
1068 vlib_error_count (vm, error_node->node_index,
1069 ICMP6_ERROR_ROUTER_ADVERTISEMENTS_RX,
1070 n_advertisements_rcvd);
1072 return frame->n_vectors;
1076 VLIB_REGISTER_NODE (ip6_icmp_router_advertisement_node,static) =
1078 .function = icmp6_router_advertisement,
1079 .name = "icmp6-router-advertisement",
1081 .vector_size = sizeof (u32),
1083 .format_trace = format_icmp6_input_trace,
1093 random_f64_from_to (f64 from, f64 to)
1095 static u32 seed = 0;
1096 static u8 seed_set = 0;
1099 seed = random_default_seed ();
1102 return random_f64 (&seed) * (to - from) + from;
1106 get_mac_address (u32 sw_if_index, u8 * address)
1108 vnet_main_t *vnm = vnet_get_main ();
1109 vnet_hw_interface_t *hw_if = vnet_get_sup_hw_interface (vnm, sw_if_index);
1110 if (!hw_if->hw_address)
1112 clib_memcpy (address, hw_if->hw_address, 6);
1116 static inline vlib_buffer_t *
1117 create_buffer_for_rs (vlib_main_t * vm, ip6_ra_t * radv_info)
1121 icmp6_router_solicitation_header_t *rh;
1126 sw_if_index = radv_info->sw_if_index;
1128 if (vlib_buffer_alloc (vm, &bi0, 1) != 1)
1130 clib_warning ("buffer allocation failure");
1134 p0 = vlib_get_buffer (vm, bi0);
1135 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (p0);
1136 p0->flags |= VNET_BUFFER_F_LOCALLY_ORIGINATED;
1138 vnet_buffer (p0)->sw_if_index[VLIB_RX] = sw_if_index;
1139 vnet_buffer (p0)->sw_if_index[VLIB_TX] = sw_if_index;
1141 vnet_buffer (p0)->ip.adj_index[VLIB_TX] =
1142 ip6_link_get_mcast_adj (sw_if_index);
1144 rh = vlib_buffer_get_current (p0);
1145 p0->current_length = sizeof (*rh);
1147 rh->neighbor.icmp.type = ICMP6_router_solicitation;
1148 rh->neighbor.icmp.code = 0;
1149 rh->neighbor.icmp.checksum = 0;
1150 rh->neighbor.reserved_must_be_zero = 0;
1152 rh->link_layer_option.header.type =
1153 ICMP6_NEIGHBOR_DISCOVERY_OPTION_source_link_layer_address;
1154 if (0 != get_mac_address (sw_if_index,
1155 rh->link_layer_option.ethernet_address))
1157 clib_warning ("interface with sw_if_index %u has no mac address",
1159 vlib_buffer_free (vm, &bi0, 1);
1162 rh->link_layer_option.header.n_data_u64s = 1;
1164 payload_length = sizeof (rh->neighbor) + sizeof (u64);
1166 rh->ip.ip_version_traffic_class_and_flow_label =
1167 clib_host_to_net_u32 (0x6 << 28);
1168 rh->ip.payload_length = clib_host_to_net_u16 (payload_length);
1169 rh->ip.protocol = IP_PROTOCOL_ICMP6;
1170 rh->ip.hop_limit = 255;
1171 ip6_address_copy (&rh->ip.src_address,
1172 ip6_get_link_local_address (radv_info->sw_if_index));
1173 /* set address ff02::2 */
1174 rh->ip.dst_address.as_u64[0] = clib_host_to_net_u64 (0xff02ULL << 48);
1175 rh->ip.dst_address.as_u64[1] = clib_host_to_net_u64 (2);
1177 rh->neighbor.icmp.checksum = ip6_tcp_udp_icmp_compute_checksum (vm, p0,
1185 stop_sending_rs (vlib_main_t * vm, ip6_ra_t * ra)
1189 ra->keep_sending_rs = 0;
1192 bi0 = vlib_get_buffer_index (vm, ra->buffer);
1193 vlib_buffer_free (vm, &bi0, 1);
1199 check_send_rs (vlib_main_t * vm, ip6_ra_t * radv_info, f64 current_time,
1209 icmp6_send_router_solicitation_params_t *params;
1211 if (!radv_info->keep_sending_rs)
1214 params = &radv_info->params;
1216 if (radv_info->due_time > current_time)
1218 *due_time = radv_info->due_time;
1222 p0 = radv_info->buffer;
1224 next_index = ip6_rewrite_mcast_node.index;
1226 c0 = vlib_buffer_copy (vm, p0);
1228 return radv_info->keep_sending_rs;
1230 ci0 = vlib_get_buffer_index (vm, c0);
1232 f = vlib_get_frame_to_node (vm, next_index);
1233 to_next = vlib_frame_vector_args (f);
1236 vlib_put_frame_to_node (vm, next_index, f);
1238 if (params->mrc != 0 && --radv_info->n_left == 0)
1239 stop_sending_rs (vm, radv_info);
1242 radv_info->sleep_interval =
1243 (2 + random_f64_from_to (-0.1, 0.1)) * radv_info->sleep_interval;
1244 if (radv_info->sleep_interval > params->mrt)
1245 radv_info->sleep_interval =
1246 (1 + random_f64_from_to (-0.1, 0.1)) * params->mrt;
1248 radv_info->due_time = current_time + radv_info->sleep_interval;
1250 if (params->mrd != 0
1251 && current_time > radv_info->start_time + params->mrd)
1252 stop_sending_rs (vm, radv_info);
1254 *due_time = radv_info->due_time;
1257 return radv_info->keep_sending_rs;
1261 send_rs_process (vlib_main_t * vm, vlib_node_runtime_t * rt,
1264 uword *event_data = NULL;
1265 f64 sleep_time = 1e9;
1266 ip6_ra_t *radv_info;
1273 vlib_process_wait_for_event_or_clock (vm, sleep_time);
1274 vlib_process_get_events (vm, &event_data);
1275 vec_reset_length (event_data);
1277 current_time = vlib_time_now (vm);
1280 due_time = current_time + 1e9;
1282 pool_foreach (radv_info, ip6_ra_pool)
1284 if (check_send_rs (vm, radv_info, current_time, &dt)
1289 current_time = vlib_time_now (vm);
1291 while (due_time < current_time);
1293 sleep_time = due_time - current_time;
1300 VLIB_REGISTER_NODE (ip6_rs_process_node) = {
1301 .function = send_rs_process,
1302 .type = VLIB_NODE_TYPE_PROCESS,
1303 .name = "ip6-rs-process",
1308 icmp6_send_router_solicitation (vlib_main_t * vm, u32 sw_if_index, u8 stop,
1309 const icmp6_send_router_solicitation_params_t
1314 ASSERT (~0 != sw_if_index);
1316 ra = ip6_ra_get_itf (sw_if_index);
1321 stop_sending_rs (vm, ra);
1325 ra->keep_sending_rs = 1;
1326 ra->params = *params;
1327 ra->n_left = params->mrc;
1328 ra->start_time = vlib_time_now (vm);
1329 ra->sleep_interval = (1 + random_f64_from_to (-0.1, 0.1)) * params->irt;
1330 ra->due_time = 0; /* send first packet ASAP */
1331 ra->buffer = create_buffer_for_rs (vm, ra);
1333 ra->keep_sending_rs = 0;
1335 vlib_process_signal_event (vm, ip6_rs_process_node.index, 1, 0);
1339 static const ethernet_interface_t *
1340 ip6_ra_get_eth_itf (u32 sw_if_index)
1342 const vnet_sw_interface_t *sw;
1344 /* lookup radv container - ethernet interfaces only */
1345 sw = vnet_get_sup_sw_interface (vnet_get_main (), sw_if_index);
1346 if (sw->type == VNET_SW_INTERFACE_TYPE_HARDWARE)
1347 return (ethernet_get_interface (ðernet_main, sw->hw_if_index));
1353 * @brief called when IP6 is enabled on an interface
1354 *create and initialize router advertisement parameters with default
1355 * values for this intfc
1358 ip6_ra_link_enable (u32 sw_if_index)
1360 const ethernet_interface_t *eth;
1361 ip6_ra_t *radv_info;
1363 eth = ip6_ra_get_eth_itf (sw_if_index);
1368 ASSERT (INDEX_INVALID == ip6_link_delegate_get (sw_if_index,
1369 ip6_ra_delegate_id));
1371 pool_get_zero (ip6_ra_pool, radv_info);
1373 radv_info->seed = (u32) clib_cpu_time_now ();
1374 random_u32 (&radv_info->seed);
1376 radv_info->sw_if_index = sw_if_index;
1377 radv_info->max_radv_interval = DEF_MAX_RADV_INTERVAL;
1378 radv_info->min_radv_interval = DEF_MIN_RADV_INTERVAL;
1379 radv_info->curr_hop_limit = DEF_CURR_HOP_LIMIT;
1380 radv_info->adv_router_lifetime_in_sec = DEF_DEF_RTR_LIFETIME;
1382 /* send ll address source address option */
1383 radv_info->adv_link_layer_address = 1;
1385 radv_info->min_delay_between_radv = MIN_DELAY_BETWEEN_RAS;
1386 radv_info->max_delay_between_radv = MAX_DELAY_BETWEEN_RAS;
1387 radv_info->max_rtr_default_lifetime = MAX_DEF_RTR_LIFETIME;
1389 radv_info->initial_adverts_count = MAX_INITIAL_RTR_ADVERTISEMENTS;
1390 radv_info->initial_adverts_sent = radv_info->initial_adverts_count - 1;
1391 radv_info->initial_adverts_interval = MAX_INITIAL_RTR_ADVERT_INTERVAL;
1393 /* deafult is to send */
1394 radv_info->send_radv = 1;
1396 /* fill in delegate for this interface that will be needed later */
1397 radv_info->adv_link_mtu =
1398 vnet_sw_interface_get_mtu (vnet_get_main (), sw_if_index, VNET_MTU_IP6);
1400 mhash_init (&radv_info->address_to_prefix_index, sizeof (uword),
1401 sizeof (ip6_address_t));
1403 ip6_link_delegate_update (sw_if_index, ip6_ra_delegate_id,
1404 radv_info - ip6_ra_pool);
1408 ip6_ra_delegate_disable (index_t rai)
1410 ip6_radv_prefix_t *p;
1411 ip6_ra_t *radv_info;
1413 radv_info = pool_elt_at_index (ip6_ra_pool, rai);
1415 /* clean up prefix and MDP pools */
1417 pool_flush(p, radv_info->adv_prefixes_pool,
1419 mhash_unset (&radv_info->address_to_prefix_index, &p->prefix, 0);
1423 pool_free (radv_info->adv_prefixes_pool);
1425 mhash_free (&radv_info->address_to_prefix_index);
1427 pool_put (ip6_ra_pool, radv_info);
1431 ip6_ra_update_secondary_radv_info (ip6_address_t * address, u8 prefix_len,
1432 u32 primary_sw_if_index,
1433 u32 valid_time, u32 preferred_time)
1435 vlib_main_t *vm = vlib_get_main ();
1436 static u32 *radv_indices;
1437 ip6_ra_t *radv_info;
1440 ip6_address_mask_from_width (&mask, prefix_len);
1442 vec_reset_length (radv_indices);
1444 pool_foreach (radv_info, ip6_ra_pool)
1446 vec_add1 (radv_indices, radv_info - ip6_ra_pool);
1451 * If we have another customer for this prefix,
1452 * tell the RA code about it...
1454 for (i = 0; i < vec_len (radv_indices); i++)
1456 ip6_radv_prefix_t *this_prefix;
1457 radv_info = pool_elt_at_index (ip6_ra_pool, radv_indices[i]);
1459 /* We already took care of these timers... */
1460 if (radv_info->sw_if_index == primary_sw_if_index)
1464 pool_foreach (this_prefix, radv_info->adv_prefixes_pool)
1466 if (this_prefix->prefix_len == prefix_len
1467 && ip6_address_is_equal_masked (&this_prefix->prefix, address,
1470 int rv = ip6_ra_prefix (vm,
1471 radv_info->sw_if_index,
1474 0 /* use_default */,
1477 0 /* no_advertise */,
1479 0 /* no_autoconfig */,
1483 clib_warning ("ip6_neighbor_ra_prefix returned %d", rv);
1490 /* send a RA or update the timer info etc.. */
1492 ip6_ra_process_timer_event (vlib_main_t * vm,
1493 vlib_node_runtime_t * node, vlib_frame_t * frame)
1495 vnet_main_t *vnm = vnet_get_main ();
1496 ip6_ra_t *radv_info;
1497 vlib_frame_t *f = 0;
1498 u32 n_this_frame = 0;
1499 u32 n_left_to_next = 0;
1502 icmp6_router_solicitation_header_t *h0;
1504 f64 now = vlib_time_now (vm);
1506 /* Interface ip6 radv info list */
1508 pool_foreach (radv_info, ip6_ra_pool)
1510 if( !vnet_sw_interface_is_admin_up (vnm, radv_info->sw_if_index))
1512 radv_info->initial_adverts_sent = radv_info->initial_adverts_count-1;
1513 radv_info->next_multicast_time = now;
1514 radv_info->last_multicast_time = now;
1515 radv_info->last_radv_time = 0;
1519 /* is it time to send a multicast RA on this interface? */
1520 if(radv_info->send_radv && (now >= radv_info->next_multicast_time))
1525 f64 rfn = (radv_info->max_radv_interval - radv_info->min_radv_interval) *
1526 random_f64 (&radv_info->seed) + radv_info->min_radv_interval;
1528 /* multicast send - compute next multicast send time */
1529 if( radv_info->initial_adverts_sent > 0)
1531 radv_info->initial_adverts_sent--;
1532 if(rfn > radv_info->initial_adverts_interval)
1533 rfn = radv_info->initial_adverts_interval;
1535 /* check to see if we are ceasing to send */
1536 if( radv_info->initial_adverts_sent == 0)
1537 if(radv_info->cease_radv)
1538 radv_info->send_radv = 0;
1541 radv_info->next_multicast_time = rfn + now;
1542 radv_info->last_multicast_time = now;
1544 /* send advert now - build a "solicted" router advert with unspecified source address */
1545 n_allocated = vlib_buffer_alloc (vm, &bo0, n_to_alloc);
1547 if (PREDICT_FALSE(n_allocated == 0))
1549 clib_warning ("buffer allocation failure");
1552 b0 = vlib_get_buffer (vm, bo0);
1553 b0->current_length = sizeof( icmp6_router_solicitation_header_t);
1554 b0->error = ICMP6_ERROR_NONE;
1555 vnet_buffer (b0)->sw_if_index[VLIB_RX] = radv_info->sw_if_index;
1557 h0 = vlib_buffer_get_current (b0);
1559 clib_memset (h0, 0, sizeof (icmp6_router_solicitation_header_t));
1561 h0->ip.ip_version_traffic_class_and_flow_label = clib_host_to_net_u32 (0x6 << 28);
1562 h0->ip.payload_length = clib_host_to_net_u16 (sizeof (icmp6_router_solicitation_header_t)
1563 - STRUCT_OFFSET_OF (icmp6_router_solicitation_header_t, neighbor));
1564 h0->ip.protocol = IP_PROTOCOL_ICMP6;
1565 h0->ip.hop_limit = 255;
1567 /* set src/dst address as "unspecified" this marks this packet as internally generated rather than recieved */
1568 h0->ip.src_address.as_u64[0] = 0;
1569 h0->ip.src_address.as_u64[1] = 0;
1571 h0->ip.dst_address.as_u64[0] = 0;
1572 h0->ip.dst_address.as_u64[1] = 0;
1574 h0->neighbor.icmp.type = ICMP6_router_solicitation;
1576 if (PREDICT_FALSE(f == 0))
1578 f = vlib_get_frame_to_node (vm, ip6_icmp_router_solicitation_node.index);
1579 to_next = vlib_frame_vector_args (f);
1580 n_left_to_next = VLIB_FRAME_SIZE;
1589 if (PREDICT_FALSE(n_left_to_next == 0))
1591 f->n_vectors = n_this_frame;
1592 vlib_put_frame_to_node (vm, ip6_icmp_router_solicitation_node.index, f);
1601 ASSERT (n_this_frame);
1602 f->n_vectors = n_this_frame;
1603 vlib_put_frame_to_node (vm, ip6_icmp_router_solicitation_node.index, f);
1609 ip6_ra_handle_report (ip6_ra_report_t * rap)
1613 vec_foreach_index (ii, ip6_ra_listeners) ip6_ra_listeners[ii] (rap);
1614 vec_free (rap->prefixes);
1615 clib_mem_free (rap);
1619 ip6_ra_event_process (vlib_main_t * vm,
1620 vlib_node_runtime_t * node, vlib_frame_t * frame)
1624 uword *event_data = 0;
1627 /* init code here */
1631 vlib_process_wait_for_event_or_clock (vm, 1. /* seconds */ );
1633 event_type = vlib_process_get_events (vm, &event_data);
1635 if (event_type == ~0)
1637 /* No events found: timer expired. */
1638 /* process interface list and send RAs as appropriate, update timer info */
1639 ip6_ra_process_timer_event (vm, node, frame);
1643 for (i = 0; i < vec_len (event_data); i++)
1645 r = (void *) (event_data[i]);
1646 ip6_ra_handle_report (r);
1648 vec_reset_length (event_data);
1651 return frame->n_vectors;
1655 VLIB_REGISTER_NODE (ip6_ra_process_node) =
1657 .function = ip6_ra_event_process,
1658 .name = "ip6-ra-process",
1659 .type = VLIB_NODE_TYPE_PROCESS,
1664 ip6_ra_signal_report (ip6_ra_report_t * r)
1666 vlib_main_t *vm = vlib_get_main ();
1669 if (!vec_len (ip6_ra_listeners))
1672 q = clib_mem_alloc (sizeof (*q));
1675 vlib_process_signal_event (vm, ip6_ra_process_node.index, 0, (uword) q);
1679 ip6_ra_publish (ip6_ra_report_t * r)
1681 void vl_api_rpc_call_main_thread (void *fp, u8 * data, u32 data_length);
1682 vl_api_rpc_call_main_thread (ip6_ra_signal_report, (u8 *) r, sizeof *r);
1686 /* API support functions */
1688 ip6_ra_config (vlib_main_t * vm, u32 sw_if_index,
1689 u8 suppress, u8 managed, u8 other,
1690 u8 ll_option, u8 send_unicast, u8 cease,
1691 u8 use_lifetime, u32 lifetime,
1692 u32 initial_count, u32 initial_interval,
1693 u32 max_interval, u32 min_interval, u8 is_no)
1695 ip6_ra_t *radv_info;
1697 /* look up the radv_t information for this interface */
1698 radv_info = ip6_ra_get_itf (sw_if_index);
1701 return (VNET_API_ERROR_IP6_NOT_ENABLED);
1703 if ((max_interval != 0) && (min_interval == 0))
1704 min_interval = .75 * max_interval;
1708 0) ? ((is_no) ? DEF_MAX_RADV_INTERVAL : max_interval) :
1709 radv_info->max_radv_interval;
1712 0) ? ((is_no) ? DEF_MIN_RADV_INTERVAL : min_interval) :
1713 radv_info->min_radv_interval;
1716 0) ? ((is_no) ? DEF_DEF_RTR_LIFETIME : lifetime) :
1717 radv_info->adv_router_lifetime_in_sec;
1721 if (lifetime > MAX_DEF_RTR_LIFETIME)
1722 lifetime = MAX_DEF_RTR_LIFETIME;
1724 if (lifetime <= max_interval)
1725 return VNET_API_ERROR_INVALID_VALUE;
1728 if (min_interval != 0)
1730 if ((min_interval > .75 * max_interval) || (min_interval < 3))
1731 return VNET_API_ERROR_INVALID_VALUE;
1734 if ((initial_count > MAX_INITIAL_RTR_ADVERTISEMENTS) ||
1735 (initial_interval > MAX_INITIAL_RTR_ADVERT_INTERVAL))
1736 return VNET_API_ERROR_INVALID_VALUE;
1739 if "flag" is set and is_no is true then restore default value else set value corresponding to "flag"
1740 if "flag" is clear don't change corresponding value
1742 radv_info->send_radv =
1743 (suppress != 0) ? ((is_no != 0) ? 1 : 0) : radv_info->send_radv;
1744 radv_info->adv_managed_flag =
1745 (managed != 0) ? ((is_no) ? 0 : 1) : radv_info->adv_managed_flag;
1746 radv_info->adv_other_flag =
1747 (other != 0) ? ((is_no) ? 0 : 1) : radv_info->adv_other_flag;
1748 radv_info->adv_link_layer_address =
1749 (ll_option != 0) ? ((is_no) ? 1 : 0) : radv_info->adv_link_layer_address;
1750 radv_info->send_unicast =
1751 (send_unicast != 0) ? ((is_no) ? 0 : 1) : radv_info->send_unicast;
1752 radv_info->cease_radv =
1753 (cease != 0) ? ((is_no) ? 0 : 1) : radv_info->cease_radv;
1755 radv_info->min_radv_interval = min_interval;
1756 radv_info->max_radv_interval = max_interval;
1757 radv_info->adv_router_lifetime_in_sec = lifetime;
1759 radv_info->initial_adverts_count =
1761 0) ? ((is_no) ? MAX_INITIAL_RTR_ADVERTISEMENTS : initial_count) :
1762 radv_info->initial_adverts_count;
1763 radv_info->initial_adverts_interval =
1764 (initial_interval !=
1765 0) ? ((is_no) ? MAX_INITIAL_RTR_ADVERT_INTERVAL : initial_interval) :
1766 radv_info->initial_adverts_interval;
1769 if ((cease != 0) && (is_no))
1770 radv_info->send_radv = 1;
1772 radv_info->initial_adverts_sent = radv_info->initial_adverts_count - 1;
1773 radv_info->next_multicast_time = vlib_time_now (vm);
1774 radv_info->last_multicast_time = vlib_time_now (vm);
1775 radv_info->last_radv_time = 0;
1782 ip6_ra_prefix (vlib_main_t * vm, u32 sw_if_index,
1783 ip6_address_t * prefix_addr, u8 prefix_len,
1784 u8 use_default, u32 val_lifetime, u32 pref_lifetime,
1785 u8 no_advertise, u8 off_link, u8 no_autoconfig,
1786 u8 no_onlink, u8 is_no)
1788 ip6_ra_t *radv_info;
1790 /* look up the radv_t information for this interface */
1791 radv_info = ip6_ra_get_itf (sw_if_index);
1794 return (VNET_API_ERROR_IP6_NOT_ENABLED);
1796 f64 now = vlib_time_now (vm);
1798 /* prefix info add, delete or update */
1799 ip6_radv_prefix_t *prefix;
1801 /* lookup prefix info for this address on this interface */
1802 uword *p = mhash_get (&radv_info->address_to_prefix_index, prefix_addr);
1804 prefix = p ? pool_elt_at_index (radv_info->adv_prefixes_pool, p[0]) : 0;
1810 return VNET_API_ERROR_INVALID_VALUE; /* invalid prefix */
1812 if (prefix->prefix_len != prefix_len)
1813 return VNET_API_ERROR_INVALID_VALUE_2;
1815 /* FIXME - Should the DP do this or the CP ? */
1816 /* do specific delete processing here before returning */
1817 /* try to remove from routing table */
1819 mhash_unset (&radv_info->address_to_prefix_index, prefix_addr,
1821 pool_put (radv_info->adv_prefixes_pool, prefix);
1823 radv_info->initial_adverts_sent = radv_info->initial_adverts_count - 1;
1824 radv_info->next_multicast_time = vlib_time_now (vm);
1825 radv_info->last_multicast_time = vlib_time_now (vm);
1826 radv_info->last_radv_time = 0;
1830 /* adding or changing */
1835 pool_get_zero (radv_info->adv_prefixes_pool, prefix);
1836 pi = prefix - radv_info->adv_prefixes_pool;
1837 mhash_set (&radv_info->address_to_prefix_index, prefix_addr, pi,
1840 clib_memset (prefix, 0x0, sizeof (ip6_radv_prefix_t));
1842 prefix->prefix_len = prefix_len;
1843 clib_memcpy (&prefix->prefix, prefix_addr, sizeof (ip6_address_t));
1845 /* initialize default values */
1846 prefix->adv_on_link_flag = 1; /* L bit set */
1847 prefix->adv_autonomous_flag = 1; /* A bit set */
1848 prefix->adv_valid_lifetime_in_secs = DEF_ADV_VALID_LIFETIME;
1849 prefix->adv_pref_lifetime_in_secs = DEF_ADV_PREF_LIFETIME;
1850 prefix->enabled = 1;
1851 prefix->decrement_lifetime_flag = 1;
1852 prefix->deprecated_prefix_flag = 1;
1856 /* FIXME - Should the DP do this or the CP ? */
1857 /* insert prefix into routing table as a connected prefix */
1866 if (prefix->prefix_len != prefix_len)
1867 return VNET_API_ERROR_INVALID_VALUE_2;
1871 /* FIXME - Should the DP do this or the CP ? */
1872 /* remove from routing table if already there */
1876 if ((val_lifetime == ~0) || (pref_lifetime == ~0))
1878 prefix->adv_valid_lifetime_in_secs = ~0;
1879 prefix->adv_pref_lifetime_in_secs = ~0;
1880 prefix->decrement_lifetime_flag = 0;
1884 prefix->adv_valid_lifetime_in_secs = val_lifetime;;
1885 prefix->adv_pref_lifetime_in_secs = pref_lifetime;
1888 /* copy remaining */
1889 prefix->enabled = !(no_advertise != 0);
1890 prefix->adv_on_link_flag = !((off_link != 0) || (no_onlink != 0));
1891 prefix->adv_autonomous_flag = !(no_autoconfig != 0);
1895 /* fill in the expiration times */
1896 prefix->valid_lifetime_expires = now + prefix->adv_valid_lifetime_in_secs;
1897 prefix->pref_lifetime_expires = now + prefix->adv_pref_lifetime_in_secs;
1899 radv_info->initial_adverts_sent = radv_info->initial_adverts_count - 1;
1900 radv_info->next_multicast_time = vlib_time_now (vm);
1901 radv_info->last_multicast_time = vlib_time_now (vm);
1902 radv_info->last_radv_time = 0;
1908 ip6_ra_cmd (vlib_main_t * vm,
1909 unformat_input_t * main_input, vlib_cli_command_t * cmd)
1911 vnet_main_t *vnm = vnet_get_main ();
1912 clib_error_t *error = 0;
1914 u8 suppress = 0, managed = 0, other = 0;
1915 u8 suppress_ll_option = 0, send_unicast = 0, cease = 0;
1916 u8 use_lifetime = 0;
1917 u32 sw_if_index, ra_lifetime = 0, ra_initial_count =
1918 0, ra_initial_interval = 0;
1919 u32 ra_max_interval = 0, ra_min_interval = 0;
1921 unformat_input_t _line_input, *line_input = &_line_input;
1923 int add_radv_info = 1;
1924 ip6_address_t ip6_addr;
1928 /* Get a line of input. */
1929 if (!unformat_user (main_input, unformat_line_input, line_input))
1932 /* get basic radv info for this interface */
1933 if (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1936 if (unformat_user (line_input,
1937 unformat_vnet_sw_interface, vnm, &sw_if_index))
1939 if (!ip6_ra_get_eth_itf (sw_if_index))
1942 clib_error_return (0, "Interface must be of ethernet type");
1946 if (!ip6_link_is_enabled (sw_if_index))
1948 error = clib_error_return (0, "IP6 nt enabler interface %U'",
1949 format_unformat_error, line_input);
1955 error = clib_error_return (0, "invalid interface name %U'",
1956 format_unformat_error, line_input);
1961 /* get the rest of the command */
1962 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1964 if (unformat (line_input, "no"))
1966 else if (unformat (line_input, "prefix %U/%d",
1967 unformat_ip6_address, &ip6_addr, &addr_len))
1971 else if (unformat (line_input, "ra-managed-config-flag"))
1975 else if (unformat (line_input, "ra-other-config-flag"))
1979 else if (unformat (line_input, "ra-suppress") ||
1980 unformat (line_input, "ra-surpress"))
1984 else if (unformat (line_input, "ra-suppress-link-layer") ||
1985 unformat (line_input, "ra-surpress-link-layer"))
1987 suppress_ll_option = 1;
1989 else if (unformat (line_input, "ra-send-unicast"))
1993 else if (unformat (line_input, "ra-lifetime"))
1995 if (!unformat (line_input, "%d", &ra_lifetime))
1997 error = unformat_parse_error (line_input);
2002 else if (unformat (line_input, "ra-initial"))
2005 (line_input, "%d %d", &ra_initial_count, &ra_initial_interval))
2007 error = unformat_parse_error (line_input);
2011 else if (unformat (line_input, "ra-interval"))
2013 if (!unformat (line_input, "%d", &ra_max_interval))
2015 error = unformat_parse_error (line_input);
2019 if (!unformat (line_input, "%d", &ra_min_interval))
2020 ra_min_interval = 0;
2022 else if (unformat (line_input, "ra-cease"))
2028 error = unformat_parse_error (line_input);
2035 ip6_ra_config (vm, sw_if_index,
2036 suppress, managed, other,
2037 suppress_ll_option, send_unicast, cease,
2038 use_lifetime, ra_lifetime,
2039 ra_initial_count, ra_initial_interval,
2040 ra_max_interval, ra_min_interval, is_no);
2044 u32 valid_lifetime_in_secs = 0;
2045 u32 pref_lifetime_in_secs = 0;
2046 u8 use_prefix_default_values = 0;
2047 u8 no_advertise = 0;
2049 u8 no_autoconfig = 0;
2052 /* get the rest of the command */
2053 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
2055 if (unformat (line_input, "default"))
2057 use_prefix_default_values = 1;
2060 else if (unformat (line_input, "infinite"))
2062 valid_lifetime_in_secs = ~0;
2063 pref_lifetime_in_secs = ~0;
2066 else if (unformat (line_input, "%d %d", &valid_lifetime_in_secs,
2067 &pref_lifetime_in_secs))
2074 /* get the rest of the command */
2075 while (!use_prefix_default_values &&
2076 unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
2078 if (unformat (line_input, "no-advertise"))
2080 else if (unformat (line_input, "off-link"))
2082 else if (unformat (line_input, "no-autoconfig"))
2084 else if (unformat (line_input, "no-onlink"))
2088 error = unformat_parse_error (line_input);
2093 ip6_ra_prefix (vm, sw_if_index,
2094 &ip6_addr, addr_len,
2095 use_prefix_default_values,
2096 valid_lifetime_in_secs,
2097 pref_lifetime_in_secs,
2098 no_advertise, off_link, no_autoconfig, no_onlink, is_no);
2102 unformat_free (line_input);
2108 format_ip6_ra (u8 * s, va_list * args)
2110 index_t rai = va_arg (*args, index_t);
2111 u32 indent = va_arg (*args, u32);
2112 ip6_radv_prefix_t *p;
2113 ip6_ra_t *radv_info;
2115 radv_info = pool_elt_at_index (ip6_ra_pool, rai);
2117 s = format (s, "%UAdvertised Prefixes:\n", format_white_space, indent);
2122 pool_foreach (p, radv_info->adv_prefixes_pool)
2124 s = format (s, "%Uprefix %U, length %d\n",
2125 format_white_space, indent+2,
2126 format_ip6_address, &p->prefix, p->prefix_len);
2130 s = format (s, "%UMTU is %d\n",
2131 format_white_space, indent, radv_info->adv_link_mtu);
2132 s = format (s, "%UICMP error messages are unlimited\n",
2133 format_white_space, indent);
2134 s = format (s, "%UICMP redirects are disabled\n",
2135 format_white_space, indent);
2136 s = format (s, "%UICMP unreachables are not sent\n",
2137 format_white_space, indent);
2138 s = format (s, "%UND DAD is disabled\n", format_white_space, indent);
2139 //s = format (s, "%UND reachable time is %d milliseconds\n",);
2140 s = format (s, "%UND advertised reachable time is %d\n",
2141 format_white_space, indent,
2142 radv_info->adv_neighbor_reachable_time_in_msec);
2144 "%UND advertised retransmit interval is %d (msec)\n",
2145 format_white_space, indent,
2147 adv_time_in_msec_between_retransmitted_neighbor_solicitations);
2150 "%UND router advertisements are sent every %0.1f seconds (min interval is %0.1f)\n",
2151 format_white_space, indent, radv_info->max_radv_interval,
2152 radv_info->min_radv_interval);
2154 format (s, "%UND router advertisements live for %d seconds\n",
2155 format_white_space, indent,
2156 radv_info->adv_router_lifetime_in_sec);
2158 format (s, "%UHosts %s stateless autoconfig for addresses\n",
2159 format_white_space, indent,
2160 (radv_info->adv_managed_flag) ? "use" : " don't use");
2162 format (s, "%UND router advertisements sent %d\n", format_white_space,
2163 indent, radv_info->n_advertisements_sent);
2165 format (s, "%UND router solicitations received %d\n", format_white_space,
2166 indent, radv_info->n_solicitations_rcvd);
2168 format (s, "%UND router solicitations dropped %d\n", format_white_space,
2169 indent, radv_info->n_solicitations_dropped);
2176 * This command is used to configure the neighbor discovery
2177 * parameters on a given interface. Use the '<em>show ip6 interface</em>'
2178 * command to display some of the current neighbor discovery parameters
2179 * on a given interface. This command has three formats:
2182 * <b>Format 1 - Router Advertisement Options:</b> (Only one can be entered in a single command)
2184 * '<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>'
2188 * <em>[no] ra-managed-config-flag</em> - Advertises in ICMPv6
2189 * router-advertisement messages to use stateful address
2190 * auto-configuration to obtain address information (sets the M-bit).
2191 * Default is the M-bit is not set and the '<em>no</em>' option
2192 * returns it to this default state.
2194 * <em>[no] ra-other-config-flag</em> - Indicates in ICMPv6
2195 * router-advertisement messages that hosts use stateful auto
2196 * configuration to obtain nonaddress related information (sets
2197 * the O-bit). Default is the O-bit is not set and the '<em>no</em>'
2198 * option returns it to this default state.
2200 * <em>[no] ra-suppress</em> - Disables sending ICMPv6 router-advertisement
2201 * messages. The '<em>no</em>' option implies to enable sending ICMPv6
2202 * router-advertisement messages.
2204 * <em>[no] ra-suppress-link-layer</em> - Indicates not to include the
2205 * optional source link-layer address in the ICMPv6 router-advertisement
2206 * messages. Default is to include the optional source link-layer address
2207 * and the '<em>no</em>' option returns it to this default state.
2209 * <em>[no] ra-send-unicast</em> - Use the source address of the
2210 * router-solicitation message if availiable. The default is to use
2211 * multicast address of all nodes, and the '<em>no</em>' option returns
2212 * it to this default state.
2214 * <em>[no] ra-lifetime <lifetime></em> - Advertises the lifetime of a
2215 * default router in ICMPv6 router-advertisement messages. The range is
2216 * from 0 to 9000 seconds. '<em><lifetime></em>' must be greater than
2217 * '<em><max-interval></em>'. The default value is 600 seconds and the
2218 * '<em>no</em>' option returns it to this default value.
2220 * <em>[no] ra-initial <cnt> <interval></em> - Number of initial ICMPv6
2221 * router-advertisement messages sent and the interval between each
2222 * message. Range for count is 1 - 3 and default is 3. Range for interval
2223 * is 1 to 16 seconds, and default is 16 seconds. The '<em>no</em>' option
2224 * returns both to their default value.
2226 * <em>[no] ra-interval <max-interval> [<min-interval>]</em> - Configures the
2227 * interval between sending ICMPv6 router-advertisement messages. The
2228 * range for max-interval is from 4 to 200 seconds. min-interval can not
2229 * be more than 75% of max-interval. If not set, min-interval will be
2230 * set to 75% of max-interval. The range for min-interval is from 3 to
2231 * 150 seconds. The '<em>no</em>' option returns both to their default
2234 * <em>[no] ra-cease</em> - Cease sending ICMPv6 router-advertisement messages.
2235 * The '<em>no</em>' options implies to start (or restart) sending
2236 * ICMPv6 router-advertisement messages.
2239 * <b>Format 2 - Prefix Options:</b>
2241 * '<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>'
2245 * <em>no</em> - All additional flags are ignored and the prefix is deleted.
2247 * <em><valid-lifetime> <pref-lifetime></em> - '<em><valid-lifetime></em>' is the
2248 * length of time in seconds during what the prefix is valid for the purpose of
2249 * on-link determination. Range is 7203 to 2592000 seconds and default is 2592000
2250 * seconds (30 days). '<em><pref-lifetime></em>' is the prefered-lifetime and is the
2251 * length of time in seconds during what addresses generated from the prefix remain
2252 * preferred. Range is 0 to 604800 seconds and default is 604800 seconds (7 days).
2254 * <em>infinite</em> - Both '<em><valid-lifetime></em>' and '<em><<pref-lifetime></em>'
2255 * are inifinte, no timeout.
2257 * <em>no-advertise</em> - Do not send full router address in prefix
2258 * advertisement. Default is to advertise (i.e. - This flag is off by default).
2260 * <em>off-link</em> - Prefix is off-link, clear L-bit in packet. Default is on-link
2261 * (i.e. - This flag is off and L-bit in packet is set by default and this prefix can
2262 * be used for on-link determination). '<em>no-onlink</em>' also controls the L-bit.
2264 * <em>no-autoconfig</em> - Do not use prefix for autoconfiguration, clear A-bit in packet.
2265 * Default is autoconfig (i.e. - This flag is off and A-bit in packet is set by default.
2267 * <em>no-onlink</em> - Do not use prefix for onlink determination, clear L-bit in packet.
2268 * Default is on-link (i.e. - This flag is off and L-bit in packet is set by default and
2269 * this prefix can be used for on-link determination). '<em>off-link</em>' also controls
2273 * <b>Format 3: - Default of Prefix:</b>
2275 * '<em><b>ip6 nd <interface> [no] prefix <ip6-address>/<width> default</b></em>'
2277 * When a new prefix is added (or existing one is being overwritten) <em>default</em>
2278 * uses default values for the prefix. If <em>no</em> is used, the <em>default</em>
2279 * is ignored and the prefix is deleted.
2283 * Example of how set a router advertisement option:
2284 * @cliexcmd{ip6 nd GigabitEthernet2/0/0 ra-interval 100 20}
2285 * Example of how to add a prefix:
2286 * @cliexcmd{ip6 nd GigabitEthernet2/0/0 prefix fe80::fe:28ff:fe9c:75b3/64 infinite no-advertise}
2287 * Example of how to delete a prefix:
2288 * @cliexcmd{ip6 nd GigabitEthernet2/0/0 no prefix fe80::fe:28ff:fe9c:75b3/64}
2291 VLIB_CLI_COMMAND (ip6_nd_command, static) =
2294 .short_help = "ip6 nd <interface> ...",
2295 .function = ip6_ra_cmd,
2300 * VFT for registering as a delegate to an IP6 link
2302 const static ip6_link_delegate_vft_t ip6_ra_delegate_vft = {
2303 .ildv_disable = ip6_ra_delegate_disable,
2304 .ildv_enable = ip6_ra_link_enable,
2305 .ildv_format = format_ip6_ra,
2308 static clib_error_t *
2309 ip6_ra_init (vlib_main_t * vm)
2311 vlib_call_init_function (vm, icmp6_init);
2313 icmp6_register_type (vm, ICMP6_router_solicitation,
2314 ip6_icmp_router_solicitation_node.index);
2315 icmp6_register_type (vm, ICMP6_router_advertisement,
2316 ip6_icmp_router_advertisement_node.index);
2318 ip6_ra_delegate_id = ip6_link_delegate_register (&ip6_ra_delegate_vft);
2324 VLIB_INIT_FUNCTION (ip6_ra_init) =
2326 .runs_after = VLIB_INITS("icmp6_init"),
2331 * fd.io coding-style-patch-verification: ON
2334 * eval: (c-set-style "gnu")