src/vnet/ip6-nd/ip6_ra.c

   1 /*
   2  * ip/ip6_neighbor.c: IP6 neighbor handling
   3  *
   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:
   8  *
   9  *     http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  */
  17
  18 #include <vnet/ip6-nd/ip6_ra.h>
  19
  20 #include <vnet/ip/ip.h>
  21 #include <vnet/ip-neighbor/ip_neighbor_dp.h>
  22
  23 #include <vnet/fib/ip6_fib.h>
  24 #include <vnet/ip/ip6_link.h>
  25
  26 /**
  27  * @file
  28  * @brief IPv6 Router Advertisements.
  29  *
  30  * The files contains the API and CLI code for managing IPv6 RAs
  31  */
  32
  33 /* *INDENT-OFF* */
  34 /* Router solicitation packet format for ethernet. */
  35 typedef CLIB_PACKED (struct
  36 {
  37     ip6_header_t ip;
  38     icmp6_neighbor_discovery_header_t neighbor;
  39     icmp6_neighbor_discovery_ethernet_link_layer_address_option_t
  40     link_layer_option;
  41 }) icmp6_router_solicitation_header_t;
  42
  43 /* router advertisement packet format for ethernet. */
  44 typedef CLIB_PACKED (struct
  45 {
  46   ip6_header_t ip;
  47   icmp6_router_advertisement_header_t router;
  48   icmp6_neighbor_discovery_ethernet_link_layer_address_option_t
  49   link_layer_option;
  50   icmp6_neighbor_discovery_mtu_option_t mtu_option;
  51   icmp6_neighbor_discovery_prefix_information_option_t
  52   prefix[0];
  53 }) icmp6_router_advertisement_packet_t;
  54 /* *INDENT-ON* */
  55
  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
  61
  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 */
  67
  68 /* advertised prefix option */
  69 typedef struct
  70 {
  71   /* basic advertised information */
  72   ip6_address_t prefix;
  73   u8 prefix_len;
  74   int adv_on_link_flag;
  75   int adv_autonomous_flag;
  76   u32 adv_valid_lifetime_in_secs;
  77   u32 adv_pref_lifetime_in_secs;
  78
  79   /* advertised values are computed from these times if decrementing */
  80   f64 valid_lifetime_expires;
  81   f64 pref_lifetime_expires;
  82
  83   /* local information */
  84   int enabled;
  85   int deprecated_prefix_flag;
  86   int decrement_lifetime_flag;
  87
  88 #define MIN_ADV_VALID_LIFETIME 7203     /* seconds */
  89 #define DEF_ADV_VALID_LIFETIME  2592000
  90 #define DEF_ADV_PREF_LIFETIME 604800
  91
  92   /* extensions are added here, mobile, DNS etc.. */
  93 } ip6_radv_prefix_t;
  94
  95 typedef struct ip6_ra_t_
  96 {
  97   /* advertised config information, zero means unspecified  */
  98   u8 curr_hop_limit;
  99   int adv_managed_flag;
 100   int adv_other_flag;
 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;
 104
 105   /* mtu option */
 106   u32 adv_link_mtu;
 107
 108   /* local information */
 109   u32 sw_if_index;
 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 */
 112   int send_unicast;
 113   int adv_link_layer_address;
 114   int prefix_option;
 115   int failed_device_check;
 116   int ref_count;
 117
 118   /* prefix option */
 119   ip6_radv_prefix_t *adv_prefixes_pool;
 120
 121   /* Hash table mapping address to index in interface advertised  prefix pool. */
 122   mhash_t address_to_prefix_index;
 123
 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;
 129
 130   f64 last_radv_time;
 131   f64 last_multicast_time;
 132   f64 next_multicast_time;
 133
 134
 135   u32 initial_adverts_count;
 136   f64 initial_adverts_interval;
 137   u32 initial_adverts_sent;
 138
 139   /* stats */
 140   u32 n_advertisements_sent;
 141   u32 n_solicitations_rcvd;
 142   u32 n_solicitations_dropped;
 143
 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;
 147   f64 sleep_interval;
 148   f64 due_time;
 149   u32 n_left;
 150   f64 start_time;
 151   vlib_buffer_t *buffer;
 152
 153   u32 seed;
 154
 155 } ip6_ra_t;
 156
 157 static ip6_link_delegate_id_t ip6_ra_delegate_id;
 158 static ip6_ra_t *ip6_ra_pool;
 159
 160
 161 /* vector of registered RA report listeners */
 162 static ip6_ra_report_notify_t *ip6_ra_listeners;
 163
 164 static int ip6_ra_publish (ip6_ra_report_t * r);
 165
 166 void
 167 ip6_ra_report_register (ip6_ra_report_notify_t fn)
 168 {
 169   ip6_ra_report_notify_t *listener;
 170   vec_foreach (listener, ip6_ra_listeners)
 171   {
 172     if (*listener == fn)
 173       return;
 174   }
 175
 176   vec_add1 (ip6_ra_listeners, fn);
 177 }
 178
 179 void
 180 ip6_ra_report_unregister (ip6_ra_report_notify_t fn)
 181 {
 182   u32 ii;
 183
 184   vec_foreach_index (ii, ip6_ra_listeners)
 185   {
 186     if (ip6_ra_listeners[ii] == fn)
 187       {
 188         vec_del1 (ip6_ra_listeners, ii);
 189         break;
 190       }
 191   }
 192 }
 193
 194 static inline ip6_ra_t *
 195 ip6_ra_get_itf (u32 sw_if_index)
 196 {
 197   index_t rai;
 198
 199   rai = ip6_link_delegate_get (sw_if_index, ip6_ra_delegate_id);
 200
 201   if (INDEX_INVALID != rai)
 202     return (pool_elt_at_index (ip6_ra_pool, rai));
 203
 204   return (NULL);
 205 }
 206
 207 /* for "syslogging" - use elog for now */
 208 #define foreach_log_level            \
 209   _ (DEBUG, "DEBUG")                 \
 210   _ (INFO, "INFORMATION")            \
 211   _ (NOTICE, "NOTICE")               \
 212   _ (WARNING, "WARNING")             \
 213   _ (ERR, "ERROR")                   \
 214   _ (CRIT, "CRITICAL")               \
 215   _ (ALERT, "ALERT")                 \
 216   _ (EMERG,  "EMERGENCY")
 217
 218 typedef enum
 219 {
 220 #define _(f,s) LOG_##f,
 221   foreach_log_level
 222 #undef _
 223 } log_level_t;
 224
 225 static char *log_level_strings[] = {
 226 #define _(f,s) s,
 227   foreach_log_level
 228 #undef _
 229 };
 230
 231 static int logmask = 1 << LOG_DEBUG;
 232
 233 static void
 234 ip6_neighbor_syslog (vlib_main_t * vm, int priority, char *fmt, ...)
 235 {
 236   /* just use elog for now */
 237   u8 *what;
 238   va_list va;
 239
 240   if ((priority > LOG_EMERG) || !(logmask & (1 << priority)))
 241     return;
 242
 243   va_start (va, fmt);
 244   if (fmt)
 245     {
 246       what = va_format (0, fmt, &va);
 247
 248       ELOG_TYPE_DECLARE (e) =
 249       {
 250       .format = "ip6 nd:  (%s): %s",.format_args = "T4T4",};
 251       struct
 252       {
 253         u32 s[2];
 254       } *ed;
 255       ed = ELOG_DATA (vlib_get_elog_main (), e);
 256       ed->s[0] =
 257         elog_string (vlib_get_elog_main (), log_level_strings[priority]);
 258       ed->s[1] = elog_string (vlib_get_elog_main (), (char *) what);
 259     }
 260   va_end (va);
 261   return;
 262 }
 263
 264 /* ipv6 neighbor discovery - router advertisements */
 265 typedef enum
 266 {
 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;
 272
 273 /*
 274  * Note: Both periodic RAs and solicited RS come through here.
 275  */
 276 static_always_inline uword
 277 icmp6_router_solicitation (vlib_main_t * vm,
 278                            vlib_node_runtime_t * node, vlib_frame_t * frame)
 279 {
 280   vnet_main_t *vnm = vnet_get_main ();
 281   ip6_main_t *im = &ip6_main;
 282   uword n_packets = frame->n_vectors;
 283   u32 *from, *to_next;
 284   u32 n_left_from, n_left_to_next, next_index;
 285   u32 n_advertisements_sent = 0;
 286   int bogus_length;
 287
 288   icmp6_neighbor_discovery_option_type_t option_type;
 289
 290   vlib_node_runtime_t *error_node =
 291     vlib_node_get_runtime (vm, ip6_icmp_input_node.index);
 292
 293   from = vlib_frame_vector_args (frame);
 294   n_left_from = n_packets;
 295   next_index = node->cached_next_index;
 296
 297   if (node->flags & VLIB_NODE_FLAG_TRACE)
 298     vlib_trace_frame_buffers_only (vm, node, from, frame->n_vectors,
 299                                    /* stride */ 1,
 300                                    sizeof (icmp6_input_trace_t));
 301
 302   /* source may append his LL address */
 303   option_type = ICMP6_NEIGHBOR_DISCOVERY_OPTION_source_link_layer_address;
 304
 305   while (n_left_from > 0)
 306     {
 307       vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
 308
 309       while (n_left_from > 0 && n_left_to_next > 0)
 310         {
 311           vlib_buffer_t *p0;
 312           ip6_header_t *ip0;
 313           ip6_ra_t *radv_info = NULL;
 314
 315           icmp6_neighbor_discovery_header_t *h0;
 316           icmp6_neighbor_discovery_ethernet_link_layer_address_option_t *o0;
 317
 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;
 321
 322           bi0 = to_next[0] = from[0];
 323
 324           from += 1;
 325           to_next += 1;
 326           n_left_from -= 1;
 327           n_left_to_next -= 1;
 328
 329           p0 = vlib_get_buffer (vm, bi0);
 330           ip0 = vlib_buffer_get_current (p0);
 331           h0 = ip6_next_header (ip0);
 332           options_len0 =
 333             clib_net_to_host_u16 (ip0->payload_length) - sizeof (h0[0]);
 334           is_unspecified = ip6_address_is_unspecified (&ip0->src_address);
 335           is_link_local =
 336             ip6_address_is_link_local_unicast (&ip0->src_address);
 337
 338           error0 = ICMP6_ERROR_NONE;
 339           sw_if_index0 = vnet_buffer (p0)->sw_if_index[VLIB_RX];
 340
 341           /* check if solicitation  (not from nd_timer node) */
 342           if (ip6_address_is_unspecified (&ip0->dst_address))
 343             is_solicitation = 0;
 344
 345           /* Check that source address is unspecified, link-local or else on-link. */
 346           if (!is_unspecified && !is_link_local)
 347             {
 348               u32 src_adj_index0 = ip6_src_lookup_for_packet (im, p0, ip0);
 349
 350               if (ADJ_INDEX_INVALID != src_adj_index0)
 351                 {
 352                   ip_adjacency_t *adj0 = adj_get (src_adj_index0);
 353
 354                   error0 = (adj0->rewrite_header.sw_if_index != sw_if_index0
 355                             ?
 356                             ICMP6_ERROR_ROUTER_SOLICITATION_SOURCE_NOT_ON_LINK
 357                             : error0);
 358                 }
 359               else
 360                 {
 361                   error0 = ICMP6_ERROR_ROUTER_SOLICITATION_SOURCE_NOT_ON_LINK;
 362                 }
 363             }
 364
 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);
 370
 371           /* if src address unspecified IGNORE any options */
 372           if (PREDICT_TRUE (error0 == ICMP6_ERROR_NONE && o0 != 0 &&
 373                             !is_unspecified && !is_link_local))
 374             {
 375               /* *INDENT-OFF* */
 376               ip_neighbor_learn_t learn = {
 377                 .sw_if_index = sw_if_index0,
 378                 .ip = {
 379                   .ip.ip6 = ip0->src_address,
 380                   .version = AF_IP6,
 381                 },
 382               };
 383               /* *INDENT-ON* */
 384               memcpy (&learn.mac, o0->ethernet_address, sizeof (learn.mac));
 385               ip_neighbor_learn_dp (&learn);
 386             }
 387
 388           /* default is to drop */
 389           next0 = ICMP6_ROUTER_SOLICITATION_NEXT_DROP;
 390
 391           if (error0 == ICMP6_ERROR_NONE)
 392             {
 393               vnet_sw_interface_t *sw_if0;
 394               ethernet_interface_t *eth_if0;
 395               u32 adj_index0;
 396
 397               sw_if0 = vnet_get_sup_sw_interface (vnm, sw_if_index0);
 398               ASSERT (sw_if0->type == VNET_SW_INTERFACE_TYPE_HARDWARE);
 399               eth_if0 =
 400                 ethernet_get_interface (&ethernet_main, sw_if0->hw_if_index);
 401
 402               /* only support ethernet interface type for now */
 403               error0 =
 404                 (!eth_if0) ? ICMP6_ERROR_ROUTER_SOLICITATION_UNSUPPORTED_INTF
 405                 : error0;
 406
 407               if (error0 == ICMP6_ERROR_NONE)
 408                 {
 409                   /* adjust the sizeof the buffer to just include the ipv6 header */
 410                   p0->current_length -=
 411                     (options_len0 +
 412                      sizeof (icmp6_neighbor_discovery_header_t));
 413
 414                   radv_info = ip6_ra_get_itf (sw_if_index0);
 415
 416                   error0 = ((!radv_info || 0 == radv_info->send_radv) ?
 417                               ICMP6_ERROR_ROUTER_SOLICITATION_RADV_NOT_CONFIG :
 418                               error0);
 419                   if (error0 == ICMP6_ERROR_NONE)
 420                     {
 421                       f64 now = vlib_time_now (vm);
 422
 423                       /* for solicited adverts - need to rate limit */
 424                       if (is_solicitation)
 425                         {
 426                           if (0 != radv_info->last_radv_time &&
 427                               (now - radv_info->last_radv_time) <
 428                               MIN_DELAY_BETWEEN_RAS)
 429                             is_dropped = 1;
 430                           else
 431                             radv_info->last_radv_time = now;
 432                         }
 433
 434                       /* send now  */
 435                       icmp6_router_advertisement_header_t rh;
 436
 437                       rh.icmp.type = ICMP6_router_advertisement;
 438                       rh.icmp.code = 0;
 439                       rh.icmp.checksum = 0;
 440
 441                       rh.current_hop_limit = radv_info->curr_hop_limit;
 442                       rh.router_lifetime_in_sec =
 443                         clib_host_to_net_u16
 444                         (radv_info->adv_router_lifetime_in_sec);
 445                       rh.
 446                         time_in_msec_between_retransmitted_neighbor_solicitations
 447                         =
 448                         clib_host_to_net_u32 (radv_info->
 449                                               adv_time_in_msec_between_retransmitted_neighbor_solicitations);
 450                       rh.neighbor_reachable_time_in_msec =
 451                         clib_host_to_net_u32 (radv_info->
 452                                               adv_neighbor_reachable_time_in_msec);
 453
 454                       rh.flags =
 455                         (radv_info->adv_managed_flag) ?
 456                         ICMP6_ROUTER_DISCOVERY_FLAG_ADDRESS_CONFIG_VIA_DHCP :
 457                         0;
 458                       rh.flags |=
 459                         ((radv_info->adv_other_flag) ?
 460                          ICMP6_ROUTER_DISCOVERY_FLAG_OTHER_CONFIG_VIA_DHCP :
 461                          0);
 462
 463
 464                       u16 payload_length =
 465                         sizeof (icmp6_router_advertisement_header_t);
 466
 467                       if (vlib_buffer_add_data
 468                           (vm, &bi0, (void *) &rh,
 469                            sizeof (icmp6_router_advertisement_header_t)))
 470                         {
 471                           /* buffer allocation failed, drop the pkt */
 472                           error0 = ICMP6_ERROR_ALLOC_FAILURE;
 473                           goto drop0;
 474                         }
 475
 476                       if (radv_info->adv_link_layer_address)
 477                         {
 478                           icmp6_neighbor_discovery_ethernet_link_layer_address_option_t
 479                             h;
 480
 481                           h.header.type =
 482                             ICMP6_NEIGHBOR_DISCOVERY_OPTION_source_link_layer_address;
 483                           h.header.n_data_u64s = 1;
 484
 485                           /* copy ll address */
 486                           clib_memcpy (&h.ethernet_address[0],
 487                                        &eth_if0->address, 6);
 488
 489                           if (vlib_buffer_add_data
 490                               (vm, &bi0, (void *) &h,
 491                                sizeof
 492                                (icmp6_neighbor_discovery_ethernet_link_layer_address_option_t)))
 493                             {
 494                               error0 = ICMP6_ERROR_ALLOC_FAILURE;
 495                               goto drop0;
 496                             }
 497
 498                           payload_length +=
 499                             sizeof
 500                             (icmp6_neighbor_discovery_ethernet_link_layer_address_option_t);
 501                         }
 502
 503                       /* add MTU option */
 504                       if (radv_info->adv_link_mtu)
 505                         {
 506                           icmp6_neighbor_discovery_mtu_option_t h;
 507
 508                           h.unused = 0;
 509                           h.mtu =
 510                             clib_host_to_net_u32 (radv_info->adv_link_mtu);
 511                           h.header.type = ICMP6_NEIGHBOR_DISCOVERY_OPTION_mtu;
 512                           h.header.n_data_u64s = 1;
 513
 514                           payload_length +=
 515                             sizeof (icmp6_neighbor_discovery_mtu_option_t);
 516
 517                           if (vlib_buffer_add_data
 518                               (vm, &bi0, (void *) &h,
 519                                sizeof
 520                                (icmp6_neighbor_discovery_mtu_option_t)))
 521                             {
 522                               error0 = ICMP6_ERROR_ALLOC_FAILURE;
 523                               goto drop0;
 524                             }
 525                         }
 526
 527                       /* add advertised prefix options  */
 528                       ip6_radv_prefix_t *pr_info;
 529
 530                       /* *INDENT-OFF* */
 531                       pool_foreach (pr_info, radv_info->adv_prefixes_pool)
 532                        {
 533                         if(pr_info->enabled &&
 534                            (!pr_info->decrement_lifetime_flag
 535                             || (pr_info->pref_lifetime_expires >0)))
 536                           {
 537                             /* advertise this prefix */
 538                             icmp6_neighbor_discovery_prefix_information_option_t h;
 539
 540                             h.header.type = ICMP6_NEIGHBOR_DISCOVERY_OPTION_prefix_information;
 541                             h.header.n_data_u64s  =  (sizeof(icmp6_neighbor_discovery_prefix_information_option_t) >> 3);
 542
 543                             h.dst_address_length  = pr_info->prefix_len;
 544
 545                             h.flags  = (pr_info->adv_on_link_flag) ? ICMP6_NEIGHBOR_DISCOVERY_PREFIX_INFORMATION_FLAG_ON_LINK : 0;
 546                             h.flags |= (pr_info->adv_autonomous_flag) ?  ICMP6_NEIGHBOR_DISCOVERY_PREFIX_INFORMATION_AUTO :  0;
 547
 548                             if(radv_info->cease_radv && pr_info->deprecated_prefix_flag)
 549                               {
 550                                 h.valid_time = clib_host_to_net_u32(MIN_ADV_VALID_LIFETIME);
 551                                 h.preferred_time  = 0;
 552                               }
 553                             else
 554                               {
 555                                 if(pr_info->decrement_lifetime_flag)
 556                                   {
 557                                     pr_info->adv_valid_lifetime_in_secs = ((pr_info->valid_lifetime_expires  > now)) ?
 558                                       (pr_info->valid_lifetime_expires  - now) : 0;
 559
 560                                     pr_info->adv_pref_lifetime_in_secs = ((pr_info->pref_lifetime_expires  > now)) ?
 561                                       (pr_info->pref_lifetime_expires  - now) : 0;
 562                                   }
 563
 564                                 h.valid_time = clib_host_to_net_u32(pr_info->adv_valid_lifetime_in_secs);
 565                                 h.preferred_time  = clib_host_to_net_u32(pr_info->adv_pref_lifetime_in_secs) ;
 566                               }
 567                             h.unused  = 0;
 568
 569                             /* Handy for debugging, but too noisy... */
 570                             if (0 && CLIB_DEBUG > 0)
 571                               clib_warning
 572                                 ("send RA for prefix %U/%d "
 573                                  "sw_if_index %d valid %u preferred %u",
 574                                  format_ip6_address, &pr_info->prefix,
 575                                  pr_info->prefix_len, sw_if_index0,
 576                                  clib_net_to_host_u32 (h.valid_time),
 577                                  clib_net_to_host_u32 (h.preferred_time));
 578
 579                             if (h.valid_time == 0)
 580                               clib_warning ("BUG: send RA with valid_time 0");
 581
 582                             clib_memcpy(&h.dst_address, &pr_info->prefix,  sizeof(ip6_address_t));
 583
 584                             payload_length += sizeof( icmp6_neighbor_discovery_prefix_information_option_t);
 585
 586                             if (vlib_buffer_add_data
 587                                 (vm, &bi0, (void *)&h,
 588                                  sizeof(icmp6_neighbor_discovery_prefix_information_option_t)))
 589                               {
 590                                 error0 = ICMP6_ERROR_ALLOC_FAILURE;
 591                                 goto drop0;
 592                               }
 593
 594                           }
 595                       }
 596                       /* *INDENT-ON* */
 597
 598                       /* add additional options before here */
 599
 600                       /* finish building the router advertisement... */
 601                       if (!is_unspecified && radv_info->send_unicast)
 602                         {
 603                           ip0->dst_address = ip0->src_address;
 604                         }
 605                       else
 606                         {
 607                           /* target address is all-nodes mcast addr */
 608                           ip6_set_reserved_multicast_address
 609                             (&ip0->dst_address,
 610                              IP6_MULTICAST_SCOPE_link_local,
 611                              IP6_MULTICAST_GROUP_ID_all_hosts);
 612                         }
 613
 614                       /* source address MUST be the link-local address */
 615                       ip6_address_copy (&ip0->src_address,
 616                                         ip6_get_link_local_address
 617                                         (radv_info->sw_if_index));
 618
 619                       ip0->hop_limit = 255;
 620                       ip0->payload_length =
 621                         clib_host_to_net_u16 (payload_length);
 622
 623                       icmp6_router_advertisement_header_t *rh0 =
 624                         (icmp6_router_advertisement_header_t *) (ip0 + 1);
 625                       rh0->icmp.checksum =
 626                         ip6_tcp_udp_icmp_compute_checksum (vm, p0, ip0,
 627                                                            &bogus_length);
 628                       ASSERT (bogus_length == 0);
 629
 630                       /* setup output if and adjacency */
 631                       vnet_buffer (p0)->sw_if_index[VLIB_RX] =
 632                         vnet_main.local_interface_sw_if_index;
 633
 634                       if (is_solicitation)
 635                         {
 636                           ethernet_header_t *eth0;
 637                           /* Reuse current MAC header, copy SMAC to DMAC and
 638                            * interface MAC to SMAC */
 639                           vlib_buffer_reset (p0);
 640                           vlib_buffer_advance (
 641                             p0, vnet_buffer (p0)->l2_hdr_offset);
 642                           eth0 = vlib_buffer_get_current (p0);
 643                           clib_memcpy (eth0->dst_address, eth0->src_address,
 644                                        6);
 645                           clib_memcpy (eth0->src_address, &eth_if0->address,
 646                                        6);
 647                           next0 =
 648                             is_dropped ? next0 :
 649                             ICMP6_ROUTER_SOLICITATION_NEXT_REPLY_TX;
 650                           vnet_buffer (p0)->sw_if_index[VLIB_TX] =
 651                             sw_if_index0;
 652                         }
 653                       else
 654                         {
 655                           adj_index0 = ip6_link_get_mcast_adj (sw_if_index0);
 656                           if (adj_index0 == INDEX_INVALID)
 657                             error0 = ICMP6_ERROR_DST_LOOKUP_MISS;
 658                           else
 659                             {
 660                               next0 =
 661                                 is_dropped ? next0 :
 662                                 ICMP6_ROUTER_SOLICITATION_NEXT_REPLY_RW;
 663                               vnet_buffer (p0)->ip.adj_index[VLIB_TX] =
 664                                 adj_index0;
 665                             }
 666                         }
 667                       p0->flags |= VNET_BUFFER_F_LOCALLY_ORIGINATED;
 668
 669                       radv_info->n_solicitations_dropped += is_dropped;
 670                       radv_info->n_solicitations_rcvd += is_solicitation;
 671
 672                       if ((error0 == ICMP6_ERROR_NONE) && !is_dropped)
 673                         {
 674                           radv_info->n_advertisements_sent++;
 675                           n_advertisements_sent++;
 676                         }
 677                     }
 678                 }
 679             }
 680
 681         drop0:
 682           p0->error = error_node->errors[error0];
 683
 684           if (error0 != ICMP6_ERROR_NONE)
 685             vlib_error_count (vm, error_node->node_index, error0, 1);
 686
 687           vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
 688                                            to_next, n_left_to_next,
 689                                            bi0, next0);
 690
 691         }
 692
 693       vlib_put_next_frame (vm, node, next_index, n_left_to_next);
 694     }
 695
 696   /* Account for router advertisements sent. */
 697   vlib_error_count (vm, error_node->node_index,
 698                     ICMP6_ERROR_ROUTER_ADVERTISEMENTS_TX,
 699                     n_advertisements_sent);
 700
 701   return frame->n_vectors;
 702 }
 703
 704 /* *INDENT-OFF* */
 705 VLIB_REGISTER_NODE (ip6_icmp_router_solicitation_node,static) =
 706 {
 707   .function = icmp6_router_solicitation,
 708   .name = "icmp6-router-solicitation",
 709
 710   .vector_size = sizeof (u32),
 711
 712   .format_trace = format_icmp6_input_trace,
 713
 714   .n_next_nodes = ICMP6_ROUTER_SOLICITATION_N_NEXT,
 715   .next_nodes = {
 716     [ICMP6_ROUTER_SOLICITATION_NEXT_DROP] = "ip6-drop",
 717     [ICMP6_ROUTER_SOLICITATION_NEXT_REPLY_RW] = "ip6-rewrite-mcast",
 718     [ICMP6_ROUTER_SOLICITATION_NEXT_REPLY_TX] = "interface-output",
 719   },
 720 };
 721 /* *INDENT-ON* */
 722
 723  /* validate advertised info for consistancy (see RFC-4861 section 6.2.7) - log any inconsistencies, packet will always  be dropped  */
 724 static_always_inline uword
 725 icmp6_router_advertisement (vlib_main_t * vm,
 726                             vlib_node_runtime_t * node, vlib_frame_t * frame)
 727 {
 728   vnet_main_t *vnm = vnet_get_main ();
 729   uword n_packets = frame->n_vectors;
 730   u32 *from, *to_next;
 731   u32 n_left_from, n_left_to_next, next_index;
 732   u32 n_advertisements_rcvd = 0;
 733
 734   vlib_node_runtime_t *error_node =
 735     vlib_node_get_runtime (vm, ip6_icmp_input_node.index);
 736
 737   from = vlib_frame_vector_args (frame);
 738   n_left_from = n_packets;
 739   next_index = node->cached_next_index;
 740
 741   if (node->flags & VLIB_NODE_FLAG_TRACE)
 742     vlib_trace_frame_buffers_only (vm, node, from, frame->n_vectors,
 743                                    /* stride */ 1,
 744                                    sizeof (icmp6_input_trace_t));
 745
 746   while (n_left_from > 0)
 747     {
 748       vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
 749
 750       while (n_left_from > 0 && n_left_to_next > 0)
 751         {
 752           vlib_buffer_t *p0;
 753           ip6_header_t *ip0;
 754           ip6_ra_t *radv_info = 0;
 755           icmp6_router_advertisement_header_t *h0;
 756           u32 bi0, options_len0, sw_if_index0, next0, error0;
 757
 758           bi0 = to_next[0] = from[0];
 759
 760           from += 1;
 761           to_next += 1;
 762           n_left_from -= 1;
 763           n_left_to_next -= 1;
 764
 765           p0 = vlib_get_buffer (vm, bi0);
 766           ip0 = vlib_buffer_get_current (p0);
 767           h0 = ip6_next_header (ip0);
 768           options_len0 =
 769             clib_net_to_host_u16 (ip0->payload_length) - sizeof (h0[0]);
 770
 771           error0 = ICMP6_ERROR_NONE;
 772           sw_if_index0 = vnet_buffer (p0)->sw_if_index[VLIB_RX];
 773
 774           /* Check that source address is link-local */
 775           error0 = (!ip6_address_is_link_local_unicast (&ip0->src_address)) ?
 776             ICMP6_ERROR_ROUTER_ADVERTISEMENT_SOURCE_NOT_LINK_LOCAL : error0;
 777
 778           /* default is to drop */
 779           next0 = ICMP6_ROUTER_SOLICITATION_NEXT_DROP;
 780
 781           n_advertisements_rcvd++;
 782
 783           if (error0 == ICMP6_ERROR_NONE)
 784             {
 785               vnet_sw_interface_t *sw_if0;
 786               ethernet_interface_t *eth_if0;
 787
 788               sw_if0 = vnet_get_sup_sw_interface (vnm, sw_if_index0);
 789               ASSERT (sw_if0->type == VNET_SW_INTERFACE_TYPE_HARDWARE);
 790               eth_if0 =
 791                 ethernet_get_interface (&ethernet_main, sw_if0->hw_if_index);
 792
 793               /* only support ethernet interface type for now */
 794               error0 =
 795                 (!eth_if0) ? ICMP6_ERROR_ROUTER_SOLICITATION_UNSUPPORTED_INTF
 796                 : error0;
 797
 798               if (error0 == ICMP6_ERROR_NONE)
 799                 {
 800                   /* look up the radv_t information for this interface */
 801                   radv_info = ip6_ra_get_itf (sw_if_index0);
 802
 803                   error0 = ((!radv_info) ?
 804                             ICMP6_ERROR_ROUTER_SOLICITATION_RADV_NOT_CONFIG :
 805                             error0);
 806
 807                   if (error0 == ICMP6_ERROR_NONE)
 808                     {
 809                       radv_info->keep_sending_rs = 0;
 810
 811                       ip6_ra_report_t r;
 812
 813                       r.sw_if_index = sw_if_index0;
 814                       memcpy (&r.router_address, &ip0->src_address, 16);
 815                       r.current_hop_limit = h0->current_hop_limit;
 816                       r.flags = h0->flags;
 817                       r.router_lifetime_in_sec =
 818                         clib_net_to_host_u16 (h0->router_lifetime_in_sec);
 819                       r.neighbor_reachable_time_in_msec =
 820                         clib_net_to_host_u32
 821                         (h0->neighbor_reachable_time_in_msec);
 822                       r.time_in_msec_between_retransmitted_neighbor_solicitations = clib_net_to_host_u32 (h0->time_in_msec_between_retransmitted_neighbor_solicitations);
 823                       r.prefixes = 0;
 824
 825                       /* validate advertised information */
 826                       if ((h0->current_hop_limit && radv_info->curr_hop_limit)
 827                           && (h0->current_hop_limit !=
 828                               radv_info->curr_hop_limit))
 829                         {
 830                           ip6_neighbor_syslog (vm, LOG_WARNING,
 831                                                "our AdvCurHopLimit on %U doesn't agree with %U",
 832                                                format_vnet_sw_if_index_name,
 833                                                vnm, sw_if_index0,
 834                                                format_ip6_address,
 835                                                &ip0->src_address);
 836                         }
 837
 838                       if ((h0->flags &
 839                            ICMP6_ROUTER_DISCOVERY_FLAG_ADDRESS_CONFIG_VIA_DHCP)
 840                           != radv_info->adv_managed_flag)
 841                         {
 842                           ip6_neighbor_syslog (vm, LOG_WARNING,
 843                                                "our AdvManagedFlag on %U doesn't agree with %U",
 844                                                format_vnet_sw_if_index_name,
 845                                                vnm, sw_if_index0,
 846                                                format_ip6_address,
 847                                                &ip0->src_address);
 848                         }
 849
 850                       if ((h0->flags &
 851                            ICMP6_ROUTER_DISCOVERY_FLAG_OTHER_CONFIG_VIA_DHCP)
 852                           != radv_info->adv_other_flag)
 853                         {
 854                           ip6_neighbor_syslog (vm, LOG_WARNING,
 855                                                "our AdvOtherConfigFlag on %U doesn't agree with %U",
 856                                                format_vnet_sw_if_index_name,
 857                                                vnm, sw_if_index0,
 858                                                format_ip6_address,
 859                                                &ip0->src_address);
 860                         }
 861
 862                       if ((h0->
 863                            time_in_msec_between_retransmitted_neighbor_solicitations
 864                            && radv_info->
 865                            adv_time_in_msec_between_retransmitted_neighbor_solicitations)
 866                           && (h0->
 867                               time_in_msec_between_retransmitted_neighbor_solicitations
 868                               !=
 869                               clib_host_to_net_u32 (radv_info->
 870                                                     adv_time_in_msec_between_retransmitted_neighbor_solicitations)))
 871                         {
 872                           ip6_neighbor_syslog (vm, LOG_WARNING,
 873                                                "our AdvRetransTimer on %U doesn't agree with %U",
 874                                                format_vnet_sw_if_index_name,
 875                                                vnm, sw_if_index0,
 876                                                format_ip6_address,
 877                                                &ip0->src_address);
 878                         }
 879
 880                       if ((h0->neighbor_reachable_time_in_msec &&
 881                            radv_info->adv_neighbor_reachable_time_in_msec) &&
 882                           (h0->neighbor_reachable_time_in_msec !=
 883                            clib_host_to_net_u32
 884                            (radv_info->adv_neighbor_reachable_time_in_msec)))
 885                         {
 886                           ip6_neighbor_syslog (vm, LOG_WARNING,
 887                                                "our AdvReachableTime on %U doesn't agree with %U",
 888                                                format_vnet_sw_if_index_name,
 889                                                vnm, sw_if_index0,
 890                                                format_ip6_address,
 891                                                &ip0->src_address);
 892                         }
 893
 894                       /* check for MTU or prefix options or .. */
 895                       u8 *opt_hdr = (u8 *) (h0 + 1);
 896                       while (options_len0 > 0)
 897                         {
 898                           icmp6_neighbor_discovery_option_header_t *o0 =
 899                             (icmp6_neighbor_discovery_option_header_t *)
 900                             opt_hdr;
 901                           int opt_len = o0->n_data_u64s << 3;
 902                           icmp6_neighbor_discovery_option_type_t option_type =
 903                             o0->type;
 904
 905                           if (options_len0 < 2)
 906                             {
 907                               ip6_neighbor_syslog (vm, LOG_ERR,
 908                                                    "malformed RA packet on %U from %U",
 909                                                    format_vnet_sw_if_index_name,
 910                                                    vnm, sw_if_index0,
 911                                                    format_ip6_address,
 912                                                    &ip0->src_address);
 913                               break;
 914                             }
 915
 916                           if (opt_len == 0)
 917                             {
 918                               ip6_neighbor_syslog (vm, LOG_ERR,
 919                                                    " zero length option in RA on %U from %U",
 920                                                    format_vnet_sw_if_index_name,
 921                                                    vnm, sw_if_index0,
 922                                                    format_ip6_address,
 923                                                    &ip0->src_address);
 924                               break;
 925                             }
 926                           else if (opt_len > options_len0)
 927                             {
 928                               ip6_neighbor_syslog (vm, LOG_ERR,
 929                                                    "option length in RA packet  greater than total length on %U from %U",
 930                                                    format_vnet_sw_if_index_name,
 931                                                    vnm, sw_if_index0,
 932                                                    format_ip6_address,
 933                                                    &ip0->src_address);
 934                               break;
 935                             }
 936
 937                           options_len0 -= opt_len;
 938                           opt_hdr += opt_len;
 939
 940                           switch (option_type)
 941                             {
 942                             case ICMP6_NEIGHBOR_DISCOVERY_OPTION_source_link_layer_address:
 943                               {
 944                                 icmp6_neighbor_discovery_ethernet_link_layer_address_option_t
 945                                   * h =
 946                                   (icmp6_neighbor_discovery_ethernet_link_layer_address_option_t
 947                                    *) (o0);
 948
 949                                 if (opt_len < sizeof (*h))
 950                                   break;
 951
 952                                 memcpy (r.slla, h->ethernet_address, 6);
 953                               }
 954                               break;
 955
 956                             case ICMP6_NEIGHBOR_DISCOVERY_OPTION_mtu:
 957                               {
 958                                 icmp6_neighbor_discovery_mtu_option_t *h =
 959                                   (icmp6_neighbor_discovery_mtu_option_t
 960                                    *) (o0);
 961
 962                                 if (opt_len < sizeof (*h))
 963                                   break;
 964
 965                                 r.mtu = clib_net_to_host_u32 (h->mtu);
 966
 967                                 if ((h->mtu && radv_info->adv_link_mtu) &&
 968                                     (h->mtu !=
 969                                      clib_host_to_net_u32
 970                                      (radv_info->adv_link_mtu)))
 971                                   {
 972                                     ip6_neighbor_syslog (vm, LOG_WARNING,
 973                                                          "our AdvLinkMTU on %U doesn't agree with %U",
 974                                                          format_vnet_sw_if_index_name,
 975                                                          vnm, sw_if_index0,
 976                                                          format_ip6_address,
 977                                                          &ip0->src_address);
 978                                   }
 979                               }
 980                               break;
 981
 982                             case ICMP6_NEIGHBOR_DISCOVERY_OPTION_prefix_information:
 983                               {
 984                                 icmp6_neighbor_discovery_prefix_information_option_t
 985                                   * h =
 986                                   (icmp6_neighbor_discovery_prefix_information_option_t
 987                                    *) (o0);
 988
 989                                 /* validate advertised prefix options  */
 990                                 ip6_radv_prefix_t *pr_info;
 991                                 u32 preferred, valid;
 992
 993                                 if (opt_len < sizeof (*h))
 994                                   break;
 995
 996                                 vec_validate (r.prefixes,
 997                                               vec_len (r.prefixes));
 998                                 ra_report_prefix_info_t *prefix =
 999                                   vec_elt_at_index (r.prefixes,
1000                                                     vec_len (r.prefixes) - 1);
1001
1002                                 preferred =
1003                                   clib_net_to_host_u32 (h->preferred_time);
1004                                 valid = clib_net_to_host_u32 (h->valid_time);
1005
1006                                 prefix->preferred_time = preferred;
1007                                 prefix->valid_time = valid;
1008                                 prefix->flags = h->flags & 0xc0;
1009                                 prefix->prefix.fp_len = h->dst_address_length;
1010                                 prefix->prefix.fp_addr.ip6 = h->dst_address;
1011                                 prefix->prefix.fp_proto = FIB_PROTOCOL_IP6;
1012
1013                                 /* look for matching prefix - if we our advertising it, it better be consistant */
1014                                 /* *INDENT-OFF* */
1015                                 pool_foreach (pr_info, radv_info->adv_prefixes_pool)
1016                                  {
1017
1018                                   ip6_address_t mask;
1019                                   ip6_address_mask_from_width(&mask, pr_info->prefix_len);
1020
1021                                   if(pr_info->enabled &&
1022                                      (pr_info->prefix_len == h->dst_address_length) &&
1023                                      ip6_address_is_equal_masked (&pr_info->prefix,  &h->dst_address, &mask))
1024                                     {
1025                                       /* found it */
1026                                       if(!pr_info->decrement_lifetime_flag &&
1027                                          valid != pr_info->adv_valid_lifetime_in_secs)
1028                                         {
1029                                           ip6_neighbor_syslog(vm,  LOG_WARNING,
1030                                                               "our ADV validlifetime on  %U for %U does not  agree with %U",
1031                                                               format_vnet_sw_if_index_name, vnm, sw_if_index0,format_ip6_address, &pr_info->prefix,
1032                                                               format_ip6_address, &h->dst_address);
1033                                         }
1034                                       if(!pr_info->decrement_lifetime_flag &&
1035                                          preferred != pr_info->adv_pref_lifetime_in_secs)
1036                                         {
1037                                           ip6_neighbor_syslog(vm,  LOG_WARNING,
1038                                                               "our ADV preferredlifetime on  %U for %U does not  agree with %U",
1039                                                               format_vnet_sw_if_index_name, vnm, sw_if_index0,format_ip6_address, &pr_info->prefix,
1040                                                               format_ip6_address, &h->dst_address);
1041                                         }
1042                                     }
1043                                   break;
1044                                 }
1045                                 /* *INDENT-ON* */
1046                                 break;
1047                               }
1048                             default:
1049                               /* skip this one */
1050                               break;
1051                             }
1052                         }
1053                       ip6_ra_publish (&r);
1054                     }
1055                 }
1056             }
1057
1058           p0->error = error_node->errors[error0];
1059
1060           if (error0 != ICMP6_ERROR_NONE)
1061             vlib_error_count (vm, error_node->node_index, error0, 1);
1062
1063           vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
1064                                            to_next, n_left_to_next,
1065                                            bi0, next0);
1066         }
1067
1068       vlib_put_next_frame (vm, node, next_index, n_left_to_next);
1069     }
1070
1071   /* Account for router advertisements received. */
1072   vlib_error_count (vm, error_node->node_index,
1073                     ICMP6_ERROR_ROUTER_ADVERTISEMENTS_RX,
1074                     n_advertisements_rcvd);
1075
1076   return frame->n_vectors;
1077 }
1078
1079 /* *INDENT-OFF* */
1080 VLIB_REGISTER_NODE (ip6_icmp_router_advertisement_node,static) =
1081 {
1082   .function = icmp6_router_advertisement,
1083   .name = "icmp6-router-advertisement",
1084
1085   .vector_size = sizeof (u32),
1086
1087   .format_trace = format_icmp6_input_trace,
1088
1089   .n_next_nodes = 1,
1090   .next_nodes = {
1091     [0] = "ip6-drop",
1092   },
1093 };
1094 /* *INDENT-ON* */
1095
1096 static inline f64
1097 random_f64_from_to (f64 from, f64 to)
1098 {
1099   static u32 seed = 0;
1100   static u8 seed_set = 0;
1101   if (!seed_set)
1102     {
1103       seed = random_default_seed ();
1104       seed_set = 1;
1105     }
1106   return random_f64 (&seed) * (to - from) + from;
1107 }
1108
1109 static inline u8
1110 get_mac_address (u32 sw_if_index, u8 * address)
1111 {
1112   vnet_main_t *vnm = vnet_get_main ();
1113   vnet_hw_interface_t *hw_if = vnet_get_sup_hw_interface (vnm, sw_if_index);
1114   if (!hw_if->hw_address)
1115     return 1;
1116   clib_memcpy (address, hw_if->hw_address, 6);
1117   return 0;
1118 }
1119
1120 static inline vlib_buffer_t *
1121 create_buffer_for_rs (vlib_main_t * vm, ip6_ra_t * radv_info)
1122 {
1123   u32 bi0;
1124   vlib_buffer_t *p0;
1125   icmp6_router_solicitation_header_t *rh;
1126   u16 payload_length;
1127   int bogus_length;
1128   u32 sw_if_index;
1129
1130   sw_if_index = radv_info->sw_if_index;
1131
1132   if (vlib_buffer_alloc (vm, &bi0, 1) != 1)
1133     {
1134       clib_warning ("buffer allocation failure");
1135       return 0;
1136     }
1137
1138   p0 = vlib_get_buffer (vm, bi0);
1139   p0->flags |= VNET_BUFFER_F_LOCALLY_ORIGINATED;
1140
1141   vnet_buffer (p0)->sw_if_index[VLIB_RX] = sw_if_index;
1142   vnet_buffer (p0)->sw_if_index[VLIB_TX] = sw_if_index;
1143
1144   vnet_buffer (p0)->ip.adj_index[VLIB_TX] =
1145     ip6_link_get_mcast_adj (sw_if_index);
1146
1147   rh = vlib_buffer_get_current (p0);
1148   p0->current_length = sizeof (*rh);
1149
1150   rh->neighbor.icmp.type = ICMP6_router_solicitation;
1151   rh->neighbor.icmp.code = 0;
1152   rh->neighbor.icmp.checksum = 0;
1153   rh->neighbor.reserved_must_be_zero = 0;
1154
1155   rh->link_layer_option.header.type =
1156     ICMP6_NEIGHBOR_DISCOVERY_OPTION_source_link_layer_address;
1157   if (0 != get_mac_address (sw_if_index,
1158                             rh->link_layer_option.ethernet_address))
1159     {
1160       clib_warning ("interface with sw_if_index %u has no mac address",
1161                     sw_if_index);
1162       vlib_buffer_free (vm, &bi0, 1);
1163       return 0;
1164     }
1165   rh->link_layer_option.header.n_data_u64s = 1;
1166
1167   payload_length = sizeof (rh->neighbor) + sizeof (u64);
1168
1169   rh->ip.ip_version_traffic_class_and_flow_label =
1170     clib_host_to_net_u32 (0x6 << 28);
1171   rh->ip.payload_length = clib_host_to_net_u16 (payload_length);
1172   rh->ip.protocol = IP_PROTOCOL_ICMP6;
1173   rh->ip.hop_limit = 255;
1174   ip6_address_copy (&rh->ip.src_address,
1175                     ip6_get_link_local_address (radv_info->sw_if_index));
1176   /* set address ff02::2 */
1177   rh->ip.dst_address.as_u64[0] = clib_host_to_net_u64 (0xff02ULL << 48);
1178   rh->ip.dst_address.as_u64[1] = clib_host_to_net_u64 (2);
1179
1180   rh->neighbor.icmp.checksum = ip6_tcp_udp_icmp_compute_checksum (vm, p0,
1181                                                                   &rh->ip,
1182                                                                   &bogus_length);
1183
1184   return p0;
1185 }
1186
1187 static inline void
1188 stop_sending_rs (vlib_main_t * vm, ip6_ra_t * ra)
1189 {
1190   u32 bi0;
1191
1192   ra->keep_sending_rs = 0;
1193   if (ra->buffer)
1194     {
1195       bi0 = vlib_get_buffer_index (vm, ra->buffer);
1196       vlib_buffer_free (vm, &bi0, 1);
1197       ra->buffer = 0;
1198     }
1199 }
1200
1201 static inline bool
1202 check_send_rs (vlib_main_t * vm, ip6_ra_t * radv_info, f64 current_time,
1203                f64 * due_time)
1204 {
1205   vlib_buffer_t *p0;
1206   vlib_frame_t *f;
1207   u32 *to_next;
1208   u32 next_index;
1209   vlib_buffer_t *c0;
1210   u32 ci0;
1211
1212   icmp6_send_router_solicitation_params_t *params;
1213
1214   if (!radv_info->keep_sending_rs)
1215     return false;
1216
1217   params = &radv_info->params;
1218
1219   if (radv_info->due_time > current_time)
1220     {
1221       *due_time = radv_info->due_time;
1222       return true;
1223     }
1224
1225   p0 = radv_info->buffer;
1226
1227   next_index = ip6_rewrite_mcast_node.index;
1228
1229   c0 = vlib_buffer_copy (vm, p0);
1230   if (c0 == NULL)
1231     return radv_info->keep_sending_rs;
1232
1233   ci0 = vlib_get_buffer_index (vm, c0);
1234
1235   f = vlib_get_frame_to_node (vm, next_index);
1236   to_next = vlib_frame_vector_args (f);
1237   to_next[0] = ci0;
1238   f->n_vectors = 1;
1239   vlib_put_frame_to_node (vm, next_index, f);
1240
1241   if (params->mrc != 0 && --radv_info->n_left == 0)
1242     stop_sending_rs (vm, radv_info);
1243   else
1244     {
1245       radv_info->sleep_interval =
1246         (2 + random_f64_from_to (-0.1, 0.1)) * radv_info->sleep_interval;
1247       if (radv_info->sleep_interval > params->mrt)
1248         radv_info->sleep_interval =
1249           (1 + random_f64_from_to (-0.1, 0.1)) * params->mrt;
1250
1251       radv_info->due_time = current_time + radv_info->sleep_interval;
1252
1253       if (params->mrd != 0
1254           && current_time > radv_info->start_time + params->mrd)
1255         stop_sending_rs (vm, radv_info);
1256       else
1257         *due_time = radv_info->due_time;
1258     }
1259
1260   return radv_info->keep_sending_rs;
1261 }
1262
1263 static uword
1264 send_rs_process (vlib_main_t * vm, vlib_node_runtime_t * rt,
1265                  vlib_frame_t * f0)
1266 {
1267   uword *event_data = NULL;
1268   f64 sleep_time = 1e9;
1269   ip6_ra_t *radv_info;
1270   f64 current_time;
1271   f64 due_time;
1272   f64 dt = 0;
1273
1274   while (true)
1275     {
1276       vlib_process_wait_for_event_or_clock (vm, sleep_time);
1277       vlib_process_get_events (vm, &event_data);
1278       vec_reset_length (event_data);
1279
1280       current_time = vlib_time_now (vm);
1281       do
1282         {
1283           due_time = current_time + 1e9;
1284         /* *INDENT-OFF* */
1285         pool_foreach (radv_info, ip6_ra_pool)
1286          {
1287             if (check_send_rs (vm, radv_info, current_time, &dt)
1288                 && (dt < due_time))
1289               due_time = dt;
1290         }
1291         /* *INDENT-ON* */
1292           current_time = vlib_time_now (vm);
1293         }
1294       while (due_time < current_time);
1295
1296       sleep_time = due_time - current_time;
1297     }
1298
1299   return 0;
1300 }
1301
1302 /* *INDENT-OFF* */
1303 VLIB_REGISTER_NODE (ip6_rs_process_node) = {
1304     .function = send_rs_process,
1305     .type = VLIB_NODE_TYPE_PROCESS,
1306     .name = "ip6-rs-process",
1307 };
1308 /* *INDENT-ON* */
1309
1310 void
1311 icmp6_send_router_solicitation (vlib_main_t * vm, u32 sw_if_index, u8 stop,
1312                                 const icmp6_send_router_solicitation_params_t
1313                                 * params)
1314 {
1315   ip6_ra_t *ra;
1316
1317   ASSERT (~0 != sw_if_index);
1318
1319   ra = ip6_ra_get_itf (sw_if_index);
1320
1321   if (!ra)
1322     return;
1323
1324   stop_sending_rs (vm, ra);
1325
1326   if (!stop)
1327     {
1328       ra->keep_sending_rs = 1;
1329       ra->params = *params;
1330       ra->n_left = params->mrc;
1331       ra->start_time = vlib_time_now (vm);
1332       ra->sleep_interval = (1 + random_f64_from_to (-0.1, 0.1)) * params->irt;
1333       ra->due_time = 0;         /* send first packet ASAP */
1334       ra->buffer = create_buffer_for_rs (vm, ra);
1335       if (!ra->buffer)
1336         ra->keep_sending_rs = 0;
1337       else
1338         vlib_process_signal_event (vm, ip6_rs_process_node.index, 1, 0);
1339     }
1340 }
1341
1342 static const ethernet_interface_t *
1343 ip6_ra_get_eth_itf (u32 sw_if_index)
1344 {
1345   const vnet_sw_interface_t *sw;
1346
1347   /* lookup radv container  - ethernet interfaces only */
1348   sw = vnet_get_sup_sw_interface (vnet_get_main (), sw_if_index);
1349   if (sw->type == VNET_SW_INTERFACE_TYPE_HARDWARE)
1350     return (ethernet_get_interface (&ethernet_main, sw->hw_if_index));
1351
1352   return (NULL);
1353 }
1354
1355 /**
1356  * @brief called when IP6 is enabled on an interface
1357  *create and initialize router advertisement parameters with default
1358  * values for this intfc
1359  */
1360 static void
1361 ip6_ra_link_enable (u32 sw_if_index)
1362 {
1363   const ethernet_interface_t *eth;
1364   ip6_ra_t *radv_info;
1365
1366   eth = ip6_ra_get_eth_itf (sw_if_index);
1367
1368   if (NULL == eth)
1369     return;
1370
1371   ASSERT (INDEX_INVALID == ip6_link_delegate_get (sw_if_index,
1372                                                   ip6_ra_delegate_id));
1373
1374   pool_get_zero (ip6_ra_pool, radv_info);
1375
1376   radv_info->seed = (u32) clib_cpu_time_now ();
1377   random_u32 (&radv_info->seed);
1378
1379   radv_info->sw_if_index = sw_if_index;
1380   radv_info->max_radv_interval = DEF_MAX_RADV_INTERVAL;
1381   radv_info->min_radv_interval = DEF_MIN_RADV_INTERVAL;
1382   radv_info->curr_hop_limit = DEF_CURR_HOP_LIMIT;
1383   radv_info->adv_router_lifetime_in_sec = DEF_DEF_RTR_LIFETIME;
1384
1385   /* send ll address source address option */
1386   radv_info->adv_link_layer_address = 1;
1387
1388   radv_info->min_delay_between_radv = MIN_DELAY_BETWEEN_RAS;
1389   radv_info->max_delay_between_radv = MAX_DELAY_BETWEEN_RAS;
1390   radv_info->max_rtr_default_lifetime = MAX_DEF_RTR_LIFETIME;
1391
1392   radv_info->initial_adverts_count = MAX_INITIAL_RTR_ADVERTISEMENTS;
1393   radv_info->initial_adverts_sent = radv_info->initial_adverts_count - 1;
1394   radv_info->initial_adverts_interval = MAX_INITIAL_RTR_ADVERT_INTERVAL;
1395
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);
1399
1400   mhash_init (&radv_info->address_to_prefix_index, sizeof (uword),
1401               sizeof (ip6_address_t));
1402
1403   ip6_link_delegate_update (sw_if_index, ip6_ra_delegate_id,
1404                             radv_info - ip6_ra_pool);
1405 }
1406
1407 static void
1408 ip6_ra_delegate_disable (index_t rai)
1409 {
1410   ip6_radv_prefix_t *p;
1411   ip6_ra_t *radv_info;
1412
1413   radv_info = pool_elt_at_index (ip6_ra_pool, rai);
1414
1415   /* clean up prefix and MDP pools */
1416   /* *INDENT-OFF* */
1417   pool_flush(p, radv_info->adv_prefixes_pool,
1418   ({
1419     mhash_unset (&radv_info->address_to_prefix_index, &p->prefix, 0);
1420   }));
1421   /* *INDENT-ON* */
1422
1423   pool_free (radv_info->adv_prefixes_pool);
1424
1425   mhash_free (&radv_info->address_to_prefix_index);
1426
1427   pool_put (ip6_ra_pool, radv_info);
1428 }
1429
1430 void
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)
1434 {
1435   vlib_main_t *vm = vlib_get_main ();
1436   static u32 *radv_indices;
1437   ip6_ra_t *radv_info;
1438   int i;
1439   ip6_address_t mask;
1440   ip6_address_mask_from_width (&mask, prefix_len);
1441
1442   vec_reset_length (radv_indices);
1443   /* *INDENT-OFF* */
1444   pool_foreach (radv_info, ip6_ra_pool)
1445    {
1446     vec_add1 (radv_indices, radv_info - ip6_ra_pool);
1447   }
1448   /* *INDENT-ON* */
1449
1450   /*
1451    * If we have another customer for this prefix,
1452    * tell the RA code about it...
1453    */
1454   for (i = 0; i < vec_len (radv_indices); i++)
1455     {
1456       ip6_radv_prefix_t *this_prefix;
1457       radv_info = pool_elt_at_index (ip6_ra_pool, radv_indices[i]);
1458
1459       /* We already took care of these timers... */
1460       if (radv_info->sw_if_index == primary_sw_if_index)
1461         continue;
1462
1463       /* *INDENT-OFF* */
1464       pool_foreach (this_prefix, radv_info->adv_prefixes_pool)
1465        {
1466         if (this_prefix->prefix_len == prefix_len
1467             && ip6_address_is_equal_masked (&this_prefix->prefix, address,
1468                                             &mask))
1469           {
1470             int rv = ip6_ra_prefix (vm,
1471                                     radv_info->sw_if_index,
1472                                     address,
1473                                     prefix_len,
1474                                     0 /* use_default */,
1475                                     valid_time,
1476                                     preferred_time,
1477                                     0 /* no_advertise */,
1478                                     0 /* off_link */,
1479                                     0 /* no_autoconfig */,
1480                                     0 /* no_onlink */,
1481                                     0 /* is_no */);
1482             if (rv != 0)
1483               clib_warning ("ip6_neighbor_ra_prefix returned %d", rv);
1484           }
1485       }
1486       /* *INDENT-ON*/
1487     }
1488 }
1489
1490 /* send a RA or update the timer info etc.. */
1491 static uword
1492 ip6_ra_process_timer_event (vlib_main_t * vm,
1493                             vlib_node_runtime_t * node, vlib_frame_t * frame)
1494 {
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;
1500   u32 *to_next = 0;
1501   u32 bo0;
1502   icmp6_router_solicitation_header_t *h0;
1503   vlib_buffer_t *b0;
1504   f64 now = vlib_time_now (vm);
1505
1506   /* Interface ip6 radv info list */
1507   /* *INDENT-OFF* */
1508   pool_foreach (radv_info, ip6_ra_pool)
1509    {
1510     if( !vnet_sw_interface_is_admin_up (vnm, radv_info->sw_if_index))
1511       {
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;
1516         continue;
1517       }
1518
1519     /* is it time to send a multicast  RA on this interface? */
1520     if(radv_info->send_radv && (now >=  radv_info->next_multicast_time))
1521       {
1522         u32 n_to_alloc = 1;
1523         u32 n_allocated;
1524
1525         f64 rfn = (radv_info->max_radv_interval - radv_info->min_radv_interval) *
1526           random_f64 (&radv_info->seed) + radv_info->min_radv_interval;
1527
1528         /* multicast send - compute next multicast send time */
1529         if( radv_info->initial_adverts_sent > 0)
1530           {
1531             radv_info->initial_adverts_sent--;
1532             if(rfn > radv_info->initial_adverts_interval)
1533               rfn =  radv_info->initial_adverts_interval;
1534
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;
1539           }
1540
1541         radv_info->next_multicast_time =  rfn + now;
1542         radv_info->last_multicast_time = now;
1543
1544         /* send advert now - build a "solicted" router advert with unspecified source address */
1545         n_allocated = vlib_buffer_alloc (vm, &bo0, n_to_alloc);
1546
1547         if (PREDICT_FALSE(n_allocated == 0))
1548           {
1549             clib_warning ("buffer allocation failure");
1550             continue;
1551           }
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;
1556
1557         h0 =  vlib_buffer_get_current (b0);
1558
1559         clib_memset (h0, 0, sizeof (icmp6_router_solicitation_header_t));
1560
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;
1566
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;
1570
1571         h0->ip.dst_address.as_u64[0] = 0;
1572         h0->ip.dst_address.as_u64[1] = 0;
1573
1574         h0->neighbor.icmp.type = ICMP6_router_solicitation;
1575
1576         if (PREDICT_FALSE(f == 0))
1577           {
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;
1581             n_this_frame = 0;
1582           }
1583
1584         n_this_frame++;
1585         n_left_to_next--;
1586         to_next[0] = bo0;
1587         to_next += 1;
1588
1589         if (PREDICT_FALSE(n_left_to_next == 0))
1590           {
1591             f->n_vectors = n_this_frame;
1592             vlib_put_frame_to_node (vm, ip6_icmp_router_solicitation_node.index, f);
1593             f = 0;
1594           }
1595       }
1596   }
1597   /* *INDENT-ON* */
1598
1599   if (f)
1600     {
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);
1604     }
1605   return 0;
1606 }
1607
1608 static void
1609 ip6_ra_handle_report (ip6_ra_report_t * rap)
1610 {
1611   u32 ii;
1612
1613   vec_foreach_index (ii, ip6_ra_listeners) ip6_ra_listeners[ii] (rap);
1614   vec_free (rap->prefixes);
1615   clib_mem_free (rap);
1616 }
1617
1618 static uword
1619 ip6_ra_event_process (vlib_main_t * vm,
1620                       vlib_node_runtime_t * node, vlib_frame_t * frame)
1621 {
1622   ip6_ra_report_t *r;
1623   uword event_type;
1624   uword *event_data = 0;
1625   int i;
1626
1627   /* init code here */
1628
1629   while (1)
1630     {
1631       vlib_process_wait_for_event_or_clock (vm, 1. /* seconds */ );
1632
1633       event_type = vlib_process_get_events (vm, &event_data);
1634
1635       if (event_type == ~0)
1636         {
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);
1640         }
1641       else
1642         {
1643           for (i = 0; i < vec_len (event_data); i++)
1644             {
1645               r = (void *) (event_data[i]);
1646               ip6_ra_handle_report (r);
1647             }
1648           vec_reset_length (event_data);
1649         }
1650     }
1651   return frame->n_vectors;
1652 }
1653
1654 /* *INDENT-OFF* */
1655 VLIB_REGISTER_NODE (ip6_ra_process_node) =
1656 {
1657  .function = ip6_ra_event_process,
1658  .name = "ip6-ra-process",
1659  .type = VLIB_NODE_TYPE_PROCESS,
1660 };
1661 /* *INDENT-ON* */
1662
1663 static void
1664 ip6_ra_signal_report (ip6_ra_report_t * r)
1665 {
1666   vlib_main_t *vm = vlib_get_main ();
1667   ip6_ra_report_t *q;
1668
1669   if (!vec_len (ip6_ra_listeners))
1670     return;
1671
1672   q = clib_mem_alloc (sizeof (*q));
1673   *q = *r;
1674
1675   vlib_process_signal_event (vm, ip6_ra_process_node.index, 0, (uword) q);
1676 }
1677
1678 static int
1679 ip6_ra_publish (ip6_ra_report_t * r)
1680 {
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);
1683   return 0;
1684 }
1685
1686 /* API support functions */
1687 int
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)
1694 {
1695   ip6_ra_t *radv_info;
1696
1697   /* look up the radv_t  information for this interface */
1698   radv_info = ip6_ra_get_itf (sw_if_index);
1699
1700   if (!radv_info)
1701     return (VNET_API_ERROR_IP6_NOT_ENABLED);
1702
1703   /* Start off believing that we're going to send radv's */
1704   radv_info->send_radv = 1;
1705
1706   if ((max_interval != 0) && (min_interval == 0))
1707     min_interval = .75 * max_interval;
1708
1709   max_interval =
1710     (max_interval !=
1711      0) ? ((is_no) ? DEF_MAX_RADV_INTERVAL : max_interval) :
1712     radv_info->max_radv_interval;
1713   min_interval =
1714     (min_interval !=
1715      0) ? ((is_no) ? DEF_MIN_RADV_INTERVAL : min_interval) :
1716     radv_info->min_radv_interval;
1717   lifetime =
1718     (use_lifetime !=
1719      0) ? ((is_no) ? DEF_DEF_RTR_LIFETIME : lifetime) :
1720     radv_info->adv_router_lifetime_in_sec;
1721
1722   if (lifetime)
1723     {
1724       if (lifetime > MAX_DEF_RTR_LIFETIME)
1725         lifetime = MAX_DEF_RTR_LIFETIME;
1726
1727       if (lifetime <= max_interval)
1728         return VNET_API_ERROR_INVALID_VALUE;
1729     }
1730
1731   if (min_interval != 0)
1732     {
1733       if ((min_interval > .75 * max_interval) || (min_interval < 3))
1734         return VNET_API_ERROR_INVALID_VALUE;
1735     }
1736
1737   if ((initial_count > MAX_INITIAL_RTR_ADVERTISEMENTS) ||
1738       (initial_interval > MAX_INITIAL_RTR_ADVERT_INTERVAL))
1739     return VNET_API_ERROR_INVALID_VALUE;
1740
1741   /*
1742      if "flag" is set and is_no is true then restore default value else set value corresponding to "flag"
1743      if "flag" is clear  don't change corresponding value
1744    */
1745   radv_info->send_radv =
1746     (suppress != 0) ? ((is_no != 0) ? 1 : 0) : radv_info->send_radv;
1747   radv_info->adv_managed_flag =
1748     (managed != 0) ? ((is_no) ? 0 : 1) : radv_info->adv_managed_flag;
1749   radv_info->adv_other_flag =
1750     (other != 0) ? ((is_no) ? 0 : 1) : radv_info->adv_other_flag;
1751   radv_info->adv_link_layer_address =
1752     (ll_option != 0) ? ((is_no) ? 1 : 0) : radv_info->adv_link_layer_address;
1753   radv_info->send_unicast =
1754     (send_unicast != 0) ? ((is_no) ? 0 : 1) : radv_info->send_unicast;
1755   radv_info->cease_radv =
1756     (cease != 0) ? ((is_no) ? 0 : 1) : radv_info->cease_radv;
1757
1758   radv_info->min_radv_interval = min_interval;
1759   radv_info->max_radv_interval = max_interval;
1760   radv_info->adv_router_lifetime_in_sec = lifetime;
1761
1762   radv_info->initial_adverts_count =
1763     (initial_count !=
1764      0) ? ((is_no) ? MAX_INITIAL_RTR_ADVERTISEMENTS : initial_count) :
1765     radv_info->initial_adverts_count;
1766   radv_info->initial_adverts_interval =
1767     (initial_interval !=
1768      0) ? ((is_no) ? MAX_INITIAL_RTR_ADVERT_INTERVAL : initial_interval) :
1769     radv_info->initial_adverts_interval;
1770
1771   /* restart */
1772   if ((cease != 0) && (is_no))
1773     radv_info->send_radv = 1;
1774
1775   radv_info->initial_adverts_sent = radv_info->initial_adverts_count - 1;
1776   radv_info->next_multicast_time = vlib_time_now (vm);
1777   radv_info->last_multicast_time = vlib_time_now (vm);
1778   radv_info->last_radv_time = 0;
1779
1780   return (0);
1781 }
1782
1783
1784 int
1785 ip6_ra_prefix (vlib_main_t * vm, u32 sw_if_index,
1786                ip6_address_t * prefix_addr, u8 prefix_len,
1787                u8 use_default, u32 val_lifetime, u32 pref_lifetime,
1788                u8 no_advertise, u8 off_link, u8 no_autoconfig,
1789                u8 no_onlink, u8 is_no)
1790 {
1791   ip6_ra_t *radv_info;
1792
1793   /* look up the radv_t  information for this interface */
1794   radv_info = ip6_ra_get_itf (sw_if_index);
1795
1796   if (!radv_info)
1797     return (VNET_API_ERROR_IP6_NOT_ENABLED);
1798
1799   f64 now = vlib_time_now (vm);
1800
1801   /* prefix info add, delete or update */
1802   ip6_radv_prefix_t *prefix;
1803
1804   /* lookup  prefix info for this  address on this interface */
1805   uword *p = mhash_get (&radv_info->address_to_prefix_index, prefix_addr);
1806
1807   prefix = p ? pool_elt_at_index (radv_info->adv_prefixes_pool, p[0]) : 0;
1808
1809   if (is_no)
1810     {
1811       /* delete */
1812       if (!prefix)
1813         return VNET_API_ERROR_INVALID_VALUE;    /* invalid prefix */
1814
1815       if (prefix->prefix_len != prefix_len)
1816         return VNET_API_ERROR_INVALID_VALUE_2;
1817
1818       /* FIXME - Should the DP do this or the CP ? */
1819       /* do specific delete processing here before returning */
1820       /* try to remove from routing table */
1821
1822       mhash_unset (&radv_info->address_to_prefix_index, prefix_addr,
1823                    /* old_value */ 0);
1824       pool_put (radv_info->adv_prefixes_pool, prefix);
1825
1826       radv_info->initial_adverts_sent = radv_info->initial_adverts_count - 1;
1827       radv_info->next_multicast_time = vlib_time_now (vm);
1828       radv_info->last_multicast_time = vlib_time_now (vm);
1829       radv_info->last_radv_time = 0;
1830       return (0);
1831     }
1832
1833   /* adding or changing */
1834   if (!prefix)
1835     {
1836       /* add */
1837       u32 pi;
1838       pool_get_zero (radv_info->adv_prefixes_pool, prefix);
1839       pi = prefix - radv_info->adv_prefixes_pool;
1840       mhash_set (&radv_info->address_to_prefix_index, prefix_addr, pi,
1841                  /* old_value */ 0);
1842
1843       clib_memset (prefix, 0x0, sizeof (ip6_radv_prefix_t));
1844
1845       prefix->prefix_len = prefix_len;
1846       clib_memcpy (&prefix->prefix, prefix_addr, sizeof (ip6_address_t));
1847
1848       /* initialize default values */
1849       prefix->adv_on_link_flag = 1;     /* L bit set */
1850       prefix->adv_autonomous_flag = 1;  /* A bit set */
1851       prefix->adv_valid_lifetime_in_secs = DEF_ADV_VALID_LIFETIME;
1852       prefix->adv_pref_lifetime_in_secs = DEF_ADV_PREF_LIFETIME;
1853       prefix->enabled = 1;
1854       prefix->decrement_lifetime_flag = 1;
1855       prefix->deprecated_prefix_flag = 1;
1856
1857       if (off_link == 0)
1858         {
1859           /* FIXME - Should the DP do this or the CP ? */
1860           /* insert prefix into routing table as a connected prefix */
1861         }
1862
1863       if (use_default)
1864         goto restart;
1865     }
1866   else
1867     {
1868
1869       if (prefix->prefix_len != prefix_len)
1870         return VNET_API_ERROR_INVALID_VALUE_2;
1871
1872       if (off_link != 0)
1873         {
1874           /* FIXME - Should the DP do this or the CP ? */
1875           /* remove from routing table if already there */
1876         }
1877     }
1878
1879   if ((val_lifetime == ~0) || (pref_lifetime == ~0))
1880     {
1881       prefix->adv_valid_lifetime_in_secs = ~0;
1882       prefix->adv_pref_lifetime_in_secs = ~0;
1883       prefix->decrement_lifetime_flag = 0;
1884     }
1885   else
1886     {
1887       prefix->adv_valid_lifetime_in_secs = val_lifetime;;
1888       prefix->adv_pref_lifetime_in_secs = pref_lifetime;
1889     }
1890
1891   /* copy  remaining */
1892   prefix->enabled = !(no_advertise != 0);
1893   prefix->adv_on_link_flag = !((off_link != 0) || (no_onlink != 0));
1894   prefix->adv_autonomous_flag = !(no_autoconfig != 0);
1895
1896 restart:
1897   /* restart */
1898   /* fill in the expiration times  */
1899   prefix->valid_lifetime_expires = now + prefix->adv_valid_lifetime_in_secs;
1900   prefix->pref_lifetime_expires = now + prefix->adv_pref_lifetime_in_secs;
1901
1902   radv_info->initial_adverts_sent = radv_info->initial_adverts_count - 1;
1903   radv_info->next_multicast_time = vlib_time_now (vm);
1904   radv_info->last_multicast_time = vlib_time_now (vm);
1905   radv_info->last_radv_time = 0;
1906
1907   return (0);
1908 }
1909
1910 clib_error_t *
1911 ip6_ra_cmd (vlib_main_t * vm,
1912             unformat_input_t * main_input, vlib_cli_command_t * cmd)
1913 {
1914   vnet_main_t *vnm = vnet_get_main ();
1915   clib_error_t *error = 0;
1916   u8 is_no = 0;
1917   u8 suppress = 0, managed = 0, other = 0;
1918   u8 suppress_ll_option = 0, send_unicast = 0, cease = 0;
1919   u8 use_lifetime = 0;
1920   u32 sw_if_index, ra_lifetime = 0, ra_initial_count =
1921     0, ra_initial_interval = 0;
1922   u32 ra_max_interval = 0, ra_min_interval = 0;
1923
1924   unformat_input_t _line_input, *line_input = &_line_input;
1925
1926   int add_radv_info = 1;
1927   ip6_address_t ip6_addr;
1928   u32 addr_len;
1929
1930
1931   /* Get a line of input. */
1932   if (!unformat_user (main_input, unformat_line_input, line_input))
1933     return 0;
1934
1935   /* get basic radv info for this interface */
1936   if (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1937     {
1938
1939       if (unformat_user (line_input,
1940                          unformat_vnet_sw_interface, vnm, &sw_if_index))
1941         {
1942           if (!ip6_ra_get_eth_itf (sw_if_index))
1943             {
1944               error =
1945                 clib_error_return (0, "Interface must be of ethernet type");
1946               goto done;
1947             }
1948
1949           if (!ip6_link_is_enabled (sw_if_index))
1950             {
1951               error = clib_error_return (0, "IP6 nt enabler interface %U'",
1952                                          format_unformat_error, line_input);
1953               goto done;
1954             }
1955         }
1956       else
1957         {
1958           error = clib_error_return (0, "invalid interface name %U'",
1959                                      format_unformat_error, line_input);
1960           goto done;
1961         }
1962     }
1963
1964   /* get the rest of the command */
1965   while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1966     {
1967       if (unformat (line_input, "no"))
1968         is_no = 1;
1969       else if (unformat (line_input, "prefix %U/%d",
1970                          unformat_ip6_address, &ip6_addr, &addr_len))
1971         {
1972           add_radv_info = 0;
1973         }
1974       else if (unformat (line_input, "ra-managed-config-flag"))
1975         {
1976           managed = 1;
1977         }
1978       else if (unformat (line_input, "ra-other-config-flag"))
1979         {
1980           other = 1;
1981         }
1982       else if (unformat (line_input, "ra-suppress") ||
1983                unformat (line_input, "ra-surpress"))
1984         {
1985           suppress = 1;
1986         }
1987       else if (unformat (line_input, "ra-suppress-link-layer") ||
1988                unformat (line_input, "ra-surpress-link-layer"))
1989         {
1990           suppress_ll_option = 1;
1991         }
1992       else if (unformat (line_input, "ra-send-unicast"))
1993         {
1994           send_unicast = 1;
1995         }
1996       else if (unformat (line_input, "ra-lifetime"))
1997         {
1998           if (!unformat (line_input, "%d", &ra_lifetime))
1999             {
2000               error = unformat_parse_error (line_input);
2001               goto done;
2002             }
2003           use_lifetime = 1;
2004         }
2005       else if (unformat (line_input, "ra-initial"))
2006         {
2007           if (!unformat
2008               (line_input, "%d %d", &ra_initial_count, &ra_initial_interval))
2009             {
2010               error = unformat_parse_error (line_input);
2011               goto done;
2012             }
2013         }
2014       else if (unformat (line_input, "ra-interval"))
2015         {
2016           if (!unformat (line_input, "%d", &ra_max_interval))
2017             {
2018               error = unformat_parse_error (line_input);
2019               goto done;
2020             }
2021
2022           if (!unformat (line_input, "%d", &ra_min_interval))
2023             ra_min_interval = 0;
2024         }
2025       else if (unformat (line_input, "ra-cease"))
2026         {
2027           cease = 1;
2028         }
2029       else
2030         {
2031           break;
2032         }
2033     }
2034
2035   if (add_radv_info)
2036     {
2037       ip6_ra_config (vm, sw_if_index,
2038                      suppress, managed, other,
2039                      suppress_ll_option, send_unicast, cease,
2040                      use_lifetime, ra_lifetime,
2041                      ra_initial_count, ra_initial_interval,
2042                      ra_max_interval, ra_min_interval, is_no);
2043     }
2044   else
2045     {
2046       u32 valid_lifetime_in_secs = 0;
2047       u32 pref_lifetime_in_secs = 0;
2048       u8 use_prefix_default_values = 0;
2049       u8 no_advertise = 0;
2050       u8 off_link = 0;
2051       u8 no_autoconfig = 0;
2052       u8 no_onlink = 0;
2053
2054       /* get the rest of the command */
2055       while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
2056         {
2057           if (unformat (line_input, "default"))
2058             {
2059               use_prefix_default_values = 1;
2060               break;
2061             }
2062           else if (unformat (line_input, "infinite"))
2063             {
2064               valid_lifetime_in_secs = ~0;
2065               pref_lifetime_in_secs = ~0;
2066               break;
2067             }
2068           else if (unformat (line_input, "%d %d", &valid_lifetime_in_secs,
2069                              &pref_lifetime_in_secs))
2070             break;
2071           else
2072             break;
2073         }
2074
2075
2076       /* get the rest of the command */
2077       while (!use_prefix_default_values &&
2078              unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
2079         {
2080           if (unformat (line_input, "no-advertise"))
2081             no_advertise = 1;
2082           else if (unformat (line_input, "off-link"))
2083             off_link = 1;
2084           else if (unformat (line_input, "no-autoconfig"))
2085             no_autoconfig = 1;
2086           else if (unformat (line_input, "no-onlink"))
2087             no_onlink = 1;
2088           else
2089             {
2090               error = unformat_parse_error (line_input);
2091               goto done;
2092             }
2093         }
2094
2095       ip6_ra_prefix (vm, sw_if_index,
2096                      &ip6_addr, addr_len,
2097                      use_prefix_default_values,
2098                      valid_lifetime_in_secs,
2099                      pref_lifetime_in_secs,
2100                      no_advertise, off_link, no_autoconfig, no_onlink, is_no);
2101     }
2102
2103 done:
2104   unformat_free (line_input);
2105
2106   return error;
2107 }
2108
2109 static u8 *
2110 format_ip6_ra (u8 * s, va_list * args)
2111 {
2112   index_t rai = va_arg (*args, index_t);
2113   u32 indent = va_arg (*args, u32);
2114   ip6_radv_prefix_t *p;
2115   ip6_ra_t *radv_info;
2116
2117   radv_info = pool_elt_at_index (ip6_ra_pool, rai);
2118
2119   s = format (s, "%UAdvertised Prefixes:\n", format_white_space, indent);
2120
2121   indent += 2;
2122
2123   /* *INDENT-OFF* */
2124   pool_foreach (p, radv_info->adv_prefixes_pool)
2125    {
2126     s = format (s, "%Uprefix %U, length %d\n",
2127                 format_white_space, indent+2,
2128                 format_ip6_address, &p->prefix, p->prefix_len);
2129   }
2130   /* *INDENT-ON* */
2131
2132   s = format (s, "%UMTU is %d\n",
2133               format_white_space, indent, radv_info->adv_link_mtu);
2134   s = format (s, "%UICMP error messages are unlimited\n",
2135               format_white_space, indent);
2136   s = format (s, "%UICMP redirects are disabled\n",
2137               format_white_space, indent);
2138   s = format (s, "%UICMP unreachables are not sent\n",
2139               format_white_space, indent);
2140   s = format (s, "%UND DAD is disabled\n", format_white_space, indent);
2141   //s = format (s, "%UND reachable time is %d milliseconds\n",);
2142   s = format (s, "%UND advertised reachable time is %d\n",
2143               format_white_space, indent,
2144               radv_info->adv_neighbor_reachable_time_in_msec);
2145   s = format (s,
2146               "%UND advertised retransmit interval is %d (msec)\n",
2147               format_white_space, indent,
2148               radv_info->
2149               adv_time_in_msec_between_retransmitted_neighbor_solicitations);
2150   s =
2151     format (s,
2152             "%UND router advertisements are sent every %0.1f seconds (min interval is %0.1f)\n",
2153             format_white_space, indent, radv_info->max_radv_interval,
2154             radv_info->min_radv_interval);
2155   s =
2156     format (s, "%UND router advertisements live for %d seconds\n",
2157             format_white_space, indent,
2158             radv_info->adv_router_lifetime_in_sec);
2159   s =
2160     format (s, "%UHosts %s stateless autoconfig for addresses\n",
2161             format_white_space, indent,
2162             (radv_info->adv_managed_flag) ? "use" : " don't use");
2163   s =
2164     format (s, "%UND router advertisements sent %d\n", format_white_space,
2165             indent, radv_info->n_advertisements_sent);
2166   s =
2167     format (s, "%UND router solicitations received %d\n", format_white_space,
2168             indent, radv_info->n_solicitations_rcvd);
2169   s =
2170     format (s, "%UND router solicitations dropped %d\n", format_white_space,
2171             indent, radv_info->n_solicitations_dropped);
2172
2173   return (s);
2174 }
2175
2176 /*?
2177  * This command is used to configure the neighbor discovery
2178  * parameters on a given interface. Use the '<em>show ip6 interface</em>'
2179  * command to display some of the current neighbor discovery parameters
2180  * on a given interface. This command has three formats:
2181  *
2182  *
2183  * <b>Format 1 - Router Advertisement Options:</b> (Only one can be entered in
2184  * a single command)
2185  *
2186  * @clistart
2187  * ip6 nd <interface> [no] [ra-managed-config-flag] |
2188  *   [ra-other-config-flag] | [ra-suppress] | [ra-suppress-link-layer] |
2189  *   [ra-send-unicast] | [ra-lifetime <lifetime>] |
2190  *   [ra-initial <cnt> <interval>] |
2191  *   [ra-interval <max-interval> [<min-interval>]] | [ra-cease]
2192  * @cliend
2193  *
2194  * Where:
2195  *
2196  * <em>[no] ra-managed-config-flag</em> - Advertises in ICMPv6
2197  * router-advertisement messages to use stateful address
2198  * auto-configuration to obtain address information (sets the M-bit).
2199  * Default is the M-bit is not set and the '<em>no</em>' option
2200  * returns it to this default state.
2201  *
2202  * <em>[no] ra-other-config-flag</em> - Indicates in ICMPv6
2203  * router-advertisement messages that hosts use stateful auto
2204  * configuration to obtain nonaddress related information (sets
2205  * the O-bit). Default is the O-bit is not set and the '<em>no</em>'
2206  * option returns it to this default state.
2207  *
2208  * <em>[no] ra-suppress</em> - Disables sending ICMPv6 router-advertisement
2209  * messages. The '<em>no</em>' option implies to enable sending ICMPv6
2210  * router-advertisement messages.
2211  *
2212  * <em>[no] ra-suppress-link-layer</em> - Indicates not to include the
2213  * optional source link-layer address in the ICMPv6 router-advertisement
2214  * messages. Default is to include the optional source link-layer address
2215  * and the '<em>no</em>' option returns it to this default state.
2216  *
2217  * <em>[no] ra-send-unicast</em> - Use the source address of the
2218  * router-solicitation message if available. The default is to use
2219  * multicast address of all nodes, and the '<em>no</em>' option returns
2220  * it to this default state.
2221  *
2222  * <em>[no] ra-lifetime <lifetime></em> - Advertises the lifetime of a
2223  * default router in ICMPv6 router-advertisement messages. The range is
2224  * from 0 to 9000 seconds. '<em><lifetime></em>' must be greater than
2225  * '<em><max-interval></em>'. The default value is 600 seconds and the
2226  * '<em>no</em>' option returns it to this default value.
2227  *
2228  * <em>[no] ra-initial <cnt> <interval></em> - Number of initial ICMPv6
2229  * router-advertisement messages sent and the interval between each
2230  * message. Range for count is 1 - 3 and default is 3. Range for interval
2231  * is 1 to 16 seconds, and default is 16 seconds. The '<em>no</em>' option
2232  * returns both to their default value.
2233  *
2234  * <em>[no] ra-interval <max-interval> [<min-interval>]</em> - Configures the
2235  * interval between sending ICMPv6 router-advertisement messages. The
2236  * range for max-interval is from 4 to 200 seconds. min-interval can not
2237  * be more than 75% of max-interval. If not set, min-interval will be
2238  * set to 75% of max-interval. The range for min-interval is from 3 to
2239  * 150 seconds.  The '<em>no</em>' option returns both to their default
2240  * value.
2241  *
2242  * <em>[no] ra-cease</em> - Cease sending ICMPv6 router-advertisement messages.
2243  * The '<em>no</em>' options implies to start (or restart) sending
2244  * ICMPv6 router-advertisement messages.
2245  *
2246  *
2247  * <b>Format 2 - Prefix Options:</b>
2248  *
2249  * @clistart
2250  * ip6 nd <interface> [no] prefix <ip6-address>/<width>
2251  *   [<valid-lifetime> <pref-lifetime> | infinite] [no-advertise] [off-link]
2252  *   [no-autoconfig] [no-onlink]
2253  * @cliend
2254  *
2255  * Where:
2256  *
2257  * <em>no</em> - All additional flags are ignored and the prefix is deleted.
2258  *
2259  * <em><valid-lifetime> <pref-lifetime></em> - '<em><valid-lifetime></em>' is
2260  * the length of time in seconds during what the prefix is valid for the
2261  * purpose of on-link determination. Range is 7203 to 2592000 seconds and
2262  * default is 2592000 seconds (30 days). '<em><pref-lifetime></em>' is the
2263  * preferred-lifetime and is the length of time in seconds during what
2264  * addresses generated from the prefix remain preferred. Range is 0 to 604800
2265  * seconds and default is 604800 seconds (7 days).
2266  *
2267  * <em>infinite</em> - Both '<em><valid-lifetime></em>' and
2268  * '<em><pref-lifetime></em>' are infinite, no timeout.
2269  *
2270  * <em>no-advertise</em> - Do not send full router address in prefix
2271  * advertisement. Default is to advertise (i.e. - This flag is off by default).
2272  *
2273  * <em>off-link</em> - Prefix is off-link, clear L-bit in packet. Default is
2274  * on-link (i.e. - This flag is off and L-bit in packet is set by default
2275  * and this prefix can be used for on-link determination). '<em>no-onlink</em>'
2276  * also controls the L-bit.
2277  *
2278  * <em>no-autoconfig</em> - Do not use prefix for autoconfiguration, clear
2279  * A-bit in packet. Default is autoconfig (i.e. - This flag is off and A-bit
2280  * in packet is set by default.
2281  *
2282  * <em>no-onlink</em> - Do not use prefix for onlink determination, clear L-bit
2283  * in packet. Default is on-link (i.e. - This flag is off and L-bit in packet
2284  * is set by default and this prefix can be used for on-link determination).
2285  * '<em>off-link</em>' also controls the L-bit.
2286  *
2287  *
2288  * <b>Format 3: - Default of Prefix:</b>
2289  *
2290  * @cliexcmd{ip6 nd <interface> [no] prefix <ip6-address>/<width> default}
2291  *
2292  * When a new prefix is added (or existing one is being overwritten)
2293  * <em>default</em> uses default values for the prefix. If <em>no</em> is
2294  * used, the <em>default</em> is ignored and the prefix is deleted.
2295  *
2296  *
2297  * @cliexpar
2298  * Example of how set a router advertisement option:
2299  * @cliexcmd{ip6 nd GigabitEthernet2/0/0 ra-interval 100 20}
2300  * Example of how to add a prefix:
2301  * @cliexcmd{ip6 nd GigabitEthernet2/0/0 prefix fe80::fe:28ff:fe9c:75b3/64
2302  * infinite no-advertise}
2303  * Example of how to delete a prefix:
2304  * @cliexcmd{ip6 nd GigabitEthernet2/0/0 no prefix fe80::fe:28ff:fe9c:75b3/64}
2305 ?*/
2306 /* *INDENT-OFF* */
2307 VLIB_CLI_COMMAND (ip6_nd_command, static) =
2308 {
2309   .path = "ip6 nd",
2310   .short_help = "ip6 nd <interface> ...",
2311   .function = ip6_ra_cmd,
2312 };
2313 /* *INDENT-ON* */
2314
2315 /**
2316  * VFT for registering as a delegate to an IP6 link
2317  */
2318 const static ip6_link_delegate_vft_t ip6_ra_delegate_vft = {
2319   .ildv_disable = ip6_ra_delegate_disable,
2320   .ildv_enable = ip6_ra_link_enable,
2321   .ildv_format = format_ip6_ra,
2322 };
2323
2324 static clib_error_t *
2325 ip6_ra_init (vlib_main_t * vm)
2326 {
2327   vlib_call_init_function (vm, icmp6_init);
2328
2329   icmp6_register_type (vm, ICMP6_router_solicitation,
2330                        ip6_icmp_router_solicitation_node.index);
2331   icmp6_register_type (vm, ICMP6_router_advertisement,
2332                        ip6_icmp_router_advertisement_node.index);
2333
2334   ip6_ra_delegate_id = ip6_link_delegate_register (&ip6_ra_delegate_vft);
2335
2336   return (NULL);
2337 }
2338
2339 /* *INDENT-OFF* */
2340 VLIB_INIT_FUNCTION (ip6_ra_init) =
2341 {
2342   .runs_after = VLIB_INITS("icmp6_init"),
2343 };
2344 /* *INDENT-ON* */
2345
2346 /*
2347  * fd.io coding-style-patch-verification: ON
2348  *
2349  * Local Variables:
2350  * eval: (c-set-style "gnu")
2351  * End:
2352  */