2 * Copyright (c) 2015 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
15 #include <vlib/vlib.h>
16 #include <vlibmemory/api.h>
17 #include <dhcp/client.h>
18 #include <dhcp/dhcp_proxy.h>
19 #include <vnet/fib/fib_table.h>
20 #include <vnet/qos/qos_types.h>
22 vlib_log_class_t dhcp_logger;
24 dhcp_client_main_t dhcp_client_main;
25 static vlib_node_registration_t dhcp_client_process_node;
27 #define DHCP_DBG(...) \
28 vlib_log_debug (dhcp_logger, __VA_ARGS__);
30 #define DHCP_INFO(...) \
31 vlib_log_notice (dhcp_logger, __VA_ARGS__);
33 #define foreach_dhcp_sent_packet_stat \
34 _(DISCOVER, "DHCP discover packets sent") \
35 _(OFFER, "DHCP offer packets sent") \
36 _(REQUEST, "DHCP request packets sent") \
37 _(ACK, "DHCP ack packets sent")
39 #define foreach_dhcp_error_counter \
40 _(NOT_FOR_US, "DHCP packets for other hosts, dropped") \
41 _(NAK, "DHCP nak packets received") \
42 _(NON_OFFER_DISCOVER, "DHCP non-offer packets in discover state") \
43 _(ODDBALL, "DHCP non-ack, non-offer packets received") \
44 _(BOUND, "DHCP bind success")
48 #define _(sym,str) DHCP_STAT_##sym,
49 foreach_dhcp_sent_packet_stat foreach_dhcp_error_counter
55 static char *dhcp_client_process_stat_strings[] = {
56 #define _(sym,string) string,
57 foreach_dhcp_sent_packet_stat foreach_dhcp_error_counter
59 "DHCP unknown packets sent",
63 format_dhcp_client_state (u8 * s, va_list * va)
65 dhcp_client_state_t state = va_arg (*va, dhcp_client_state_t);
74 foreach_dhcp_client_state;
80 s = format (s, "%s", str);
85 format_dhcp_client (u8 * s, va_list * va)
87 dhcp_client_main_t *dcm = va_arg (*va, dhcp_client_main_t *);
88 dhcp_client_t *c = va_arg (*va, dhcp_client_t *);
89 int verbose = va_arg (*va, int);
92 s = format (s, "[%d] %U state %U installed %d", c - dcm->clients,
93 format_vnet_sw_if_index_name, dcm->vnet_main, c->sw_if_index,
94 format_dhcp_client_state, c->state, c->addresses_installed);
97 s = format (s, " dscp %d", c->dscp);
99 if (c->installed.leased_address.as_u32)
101 s = format (s, " addr %U/%d gw %U server %U",
102 format_ip4_address, &c->installed.leased_address,
103 c->installed.subnet_mask_width,
104 format_ip4_address, &c->installed.router_address,
105 format_ip4_address, &c->installed.dhcp_server);
107 vec_foreach (addr, c->domain_server_address)
108 s = format (s, " dns %U", format_ip4_address, addr);
112 s = format (s, " no address");
119 "\n lease: lifetime:%d renewal-interval:%d expires:%.2f (now:%.2f)",
120 c->lease_lifetime, c->lease_renewal_interval,
121 c->lease_expires, vlib_time_now (dcm->vlib_main));
123 format (s, "\n retry-count:%d, next-xmt:%.2f", c->retry_count,
126 format (s, "\n adjacencies:[unicast:%d broadcast:%d]", c->ai_ucast,
133 dhcp_client_acquire_address (dhcp_client_main_t * dcm, dhcp_client_t * c)
136 * Install any/all info gleaned from dhcp, right here
138 if (!c->addresses_installed)
140 ip4_add_del_interface_address (dcm->vlib_main, c->sw_if_index,
141 (void *) &c->learned.leased_address,
142 c->learned.subnet_mask_width,
144 if (c->learned.router_address.as_u32)
146 fib_prefix_t all_0s = {
148 .fp_proto = FIB_PROTOCOL_IP4,
150 ip46_address_t nh = {
151 .ip4 = c->learned.router_address,
155 fib_table_entry_path_add (
156 fib_table_get_index_for_sw_if_index (
164 ~0, 1, NULL, // no label stack
165 FIB_ROUTE_PATH_FLAG_NONE);
168 if (c->learned.dhcp_server.as_u32)
170 ip46_address_t dst = {
171 .ip4 = c->learned.dhcp_server,
173 c->ai_ucast = adj_nbr_add_or_lock (FIB_PROTOCOL_IP4,
178 clib_memcpy (&c->installed, &c->learned, sizeof (c->installed));
179 c->addresses_installed = 1;
183 dhcp_client_release_address (dhcp_client_main_t * dcm, dhcp_client_t * c)
186 * Remove any/all info gleaned from dhcp, right here. Caller(s)
187 * have not wiped out the info yet.
189 if (c->addresses_installed)
191 ip4_add_del_interface_address (dcm->vlib_main, c->sw_if_index,
192 (void *) &c->installed.leased_address,
193 c->installed.subnet_mask_width,
196 /* Remove the default route */
197 if (c->installed.router_address.as_u32)
199 fib_prefix_t all_0s = {
201 .fp_proto = FIB_PROTOCOL_IP4,
203 ip46_address_t nh = {
204 .ip4 = c->installed.router_address,
207 fib_table_entry_path_remove (fib_table_get_index_for_sw_if_index
208 (FIB_PROTOCOL_IP4, c->sw_if_index),
209 &all_0s, FIB_SOURCE_DHCP,
210 DPO_PROTO_IP4, &nh, c->sw_if_index, ~0,
211 1, FIB_ROUTE_PATH_FLAG_NONE);
213 adj_unlock (c->ai_ucast);
214 c->ai_ucast = ADJ_INDEX_INVALID;
216 clib_memset (&c->installed, 0, sizeof (c->installed));
217 c->addresses_installed = 0;
221 dhcp_client_proc_callback (uword * client_index)
223 vlib_main_t *vm = vlib_get_main ();
224 ASSERT (vlib_get_thread_index () == 0);
225 vlib_process_signal_event (vm, dhcp_client_process_node.index,
226 EVENT_DHCP_CLIENT_WAKEUP, *client_index);
230 dhcp_client_addr_callback (u32 * cindex)
232 dhcp_client_main_t *dcm = &dhcp_client_main;
235 c = pool_elt_at_index (dcm->clients, *cindex);
237 /* disable the feature */
238 vnet_feature_enable_disable ("ip4-unicast",
239 "ip4-dhcp-client-detect",
240 c->sw_if_index, 0 /* disable */ , 0, 0);
241 c->client_detect_feature_enabled = 0;
243 /* add the address to the interface if they've changed since the last time */
244 if (0 != clib_memcmp (&c->installed, &c->learned, sizeof (c->learned)))
246 dhcp_client_release_address (dcm, c);
247 dhcp_client_acquire_address (dcm, c);
251 * Call the user's event callback to report DHCP information
253 if (c->event_callback)
254 c->event_callback (c->client_index, c);
256 DHCP_INFO ("update: %U", format_dhcp_client, dcm, c);
260 dhcp_client_reset (dhcp_client_main_t * dcm, dhcp_client_t * c)
262 if (c->client_detect_feature_enabled == 1)
264 vnet_feature_enable_disable ("ip4-unicast",
265 "ip4-dhcp-client-detect",
266 c->sw_if_index, 0, 0, 0);
267 c->client_detect_feature_enabled = 0;
270 dhcp_client_release_address (dcm, c);
271 clib_memset (&c->learned, 0, sizeof (c->installed));
272 c->state = DHCP_DISCOVER;
273 c->next_transmit = vlib_time_now (dcm->vlib_main);
275 c->lease_renewal_interval = 0;
276 vec_free (c->domain_server_address);
280 * dhcp_client_for_us - server-to-client callback.
281 * Called from proxy_node.c:dhcp_proxy_to_client_input().
282 * This function first decides that the packet in question is
283 * actually for the dhcp client code in case we're also acting as
284 * a dhcp proxy. Ay caramba, what a folly!
287 dhcp_client_for_us (u32 bi, vlib_buffer_t * b,
289 udp_header_t * udp, dhcp_header_t * dhcp)
291 dhcp_client_main_t *dcm = &dhcp_client_main;
292 vlib_main_t *vm = dcm->vlib_main;
295 f64 now = vlib_time_now (dcm->vlib_main);
296 u8 dhcp_message_type = 0;
300 * Doing dhcp client on this interface?
301 * Presumably we will always receive dhcp clnt for-us pkts on
302 * the interface that's asking for an address.
304 p = hash_get (dcm->client_by_sw_if_index,
305 vnet_buffer (b)->sw_if_index[VLIB_RX]);
309 c = pool_elt_at_index (dcm->clients, p[0]);
311 /* Mixing dhcp relay and dhcp proxy? DGMS... */
312 if (c->state == DHCP_BOUND && c->retry_count == 0)
315 /* Packet not for us? Turf it... */
316 if (memcmp (dhcp->client_hardware_address, c->client_hardware_address,
317 sizeof (c->client_hardware_address)))
319 vlib_node_increment_counter (vm, dhcp_client_process_node.index,
320 DHCP_STAT_NOT_FOR_US, 1);
324 /* parse through the packet, learn what we can */
325 if (dhcp->your_ip_address.as_u32)
326 c->learned.leased_address.as_u32 = dhcp->your_ip_address.as_u32;
328 c->learned.dhcp_server.as_u32 = dhcp->server_ip_address.as_u32;
330 o = (dhcp_option_t *) dhcp->options;
332 while (o->option != 0xFF /* end of options */ &&
333 (u8 *) o < (b->data + b->current_data + b->current_length))
337 case 53: /* dhcp message type */
338 dhcp_message_type = o->data[0];
341 case 51: /* lease time */
343 u32 lease_time_in_seconds =
344 clib_host_to_net_u32 (o->data_as_u32[0]);
345 // for debug: lease_time_in_seconds = 20; /*$$$$*/
346 c->lease_expires = now + (f64) lease_time_in_seconds;
347 c->lease_lifetime = lease_time_in_seconds;
348 /* Set a sensible default, in case we don't get opt 58 */
349 c->lease_renewal_interval = lease_time_in_seconds / 2;
353 case 58: /* lease renew time in seconds */
355 u32 lease_renew_time_in_seconds =
356 clib_host_to_net_u32 (o->data_as_u32[0]);
357 c->lease_renewal_interval = lease_renew_time_in_seconds;
361 case 54: /* dhcp server address */
362 c->learned.dhcp_server.as_u32 = o->data_as_u32[0];
365 case 1: /* subnet mask */
367 u32 subnet_mask = clib_host_to_net_u32 (o->data_as_u32[0]);
368 c->learned.subnet_mask_width = count_set_bits (subnet_mask);
371 case 3: /* router address */
373 u32 router_address = o->data_as_u32[0];
374 c->learned.router_address.as_u32 = router_address;
377 case 6: /* domain server address */
379 vec_free (c->domain_server_address);
380 vec_validate (c->domain_server_address,
381 o->length / sizeof (ip4_address_t) - 1);
382 clib_memcpy (c->domain_server_address, o->data, o->length);
385 case 12: /* hostname */
387 /* Replace the existing hostname if necessary */
388 vec_free (c->hostname);
389 vec_validate (c->hostname, o->length - 1);
390 clib_memcpy (c->hostname, o->data, o->length);
394 /* $$$$ Your message in this space, parse more options */
399 o = (dhcp_option_t *) (((uword) o) + (o->length + 2));
405 if (dhcp_message_type != DHCP_PACKET_OFFER)
407 vlib_node_increment_counter (vm, dhcp_client_process_node.index,
408 DHCP_STAT_NON_OFFER_DISCOVER, 1);
409 c->next_transmit = now + 5.0;
413 /* Received an offer, go send a request */
414 c->state = DHCP_REQUEST;
416 c->next_transmit = 0; /* send right now... */
417 /* Poke the client process, which will send the request */
418 uword client_id = c - dcm->clients;
419 vl_api_rpc_call_main_thread (dhcp_client_proc_callback,
420 (u8 *) & client_id, sizeof (uword));
425 if (dhcp_message_type == DHCP_PACKET_NAK)
427 vlib_node_increment_counter (vm, dhcp_client_process_node.index,
429 /* Probably never happens in bound state, but anyhow...
430 Wipe out any memory of the address we had... */
431 dhcp_client_reset (dcm, c);
435 if (dhcp_message_type != DHCP_PACKET_ACK &&
436 dhcp_message_type != DHCP_PACKET_OFFER)
438 vlib_node_increment_counter (vm, dhcp_client_process_node.index,
439 DHCP_STAT_NON_OFFER_DISCOVER, 1);
440 clib_warning ("sw_if_index %d state %U message type %d",
441 c->sw_if_index, format_dhcp_client_state,
442 c->state, dhcp_message_type);
443 c->next_transmit = now + 5.0;
446 /* OK, we own the address (etc), add to the routing table(s) */
448 /* Send the index over to the main thread, where it can retrieve
449 * the original client */
450 u32 cindex = c - dcm->clients;
451 vl_api_force_rpc_call_main_thread (dhcp_client_addr_callback,
452 (u8 *) & cindex, sizeof (u32));
455 c->state = DHCP_BOUND;
457 c->next_transmit = now + (f64) c->lease_renewal_interval;
458 c->lease_expires = now + (f64) c->lease_lifetime;
459 vlib_node_increment_counter (vm, dhcp_client_process_node.index,
464 clib_warning ("client %d bogus state %d", c - dcm->clients, c->state);
468 /* return 1 so the call disposes of this packet */
473 send_dhcp_pkt (dhcp_client_main_t * dcm, dhcp_client_t * c,
474 dhcp_packet_type_t type, int is_broadcast)
476 vlib_main_t *vm = dcm->vlib_main;
477 vnet_main_t *vnm = dcm->vnet_main;
478 vnet_hw_interface_t *hw = vnet_get_sup_hw_interface (vnm, c->sw_if_index);
479 vnet_sw_interface_t *sup_sw
480 = vnet_get_sup_sw_interface (vnm, c->sw_if_index);
481 vnet_sw_interface_t *sw = vnet_get_sw_interface (vnm, c->sw_if_index);
490 u16 udp_length, ip_length;
491 u32 counter_index, node_index;
493 DHCP_INFO ("send: type:%U bcast:%d %U",
494 format_dhcp_packet_type, type,
495 is_broadcast, format_dhcp_client, dcm, c);
497 /* Interface(s) down? */
498 if ((hw->flags & VNET_HW_INTERFACE_FLAG_LINK_UP) == 0)
500 if ((sup_sw->flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) == 0)
502 if ((sw->flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) == 0)
505 if (vlib_buffer_alloc (vm, &bi, 1) != 1)
507 clib_warning ("buffer allocation failure");
508 c->next_transmit = 0;
512 /* Build a dhcpv4 pkt from whole cloth */
513 b = vlib_get_buffer (vm, bi);
514 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b);
516 ASSERT (b->current_data == 0);
518 vnet_buffer (b)->sw_if_index[VLIB_RX] = c->sw_if_index;
519 b->flags |= VNET_BUFFER_F_LOCALLY_ORIGINATED;
521 if (ADJ_INDEX_INVALID == c->ai_ucast)
526 node_index = ip4_rewrite_node.index;
527 vnet_buffer (b)->ip.adj_index[VLIB_TX] = c->ai_bcast;
531 ip_adjacency_t *adj = adj_get (c->ai_ucast);
533 if (IP_LOOKUP_NEXT_ARP == adj->lookup_next_index)
534 node_index = ip4_arp_node.index;
536 node_index = ip4_rewrite_node.index;
537 vnet_buffer (b)->ip.adj_index[VLIB_TX] = c->ai_ucast;
540 /* Enqueue the packet right now */
541 f = vlib_get_frame_to_node (vm, node_index);
542 to_next = vlib_frame_vector_args (f);
545 vlib_put_frame_to_node (vm, node_index, f);
547 /* build the headers */
548 ip = vlib_buffer_get_current (b);
549 udp = (udp_header_t *) (ip + 1);
550 dhcp = (dhcp_header_t *) (udp + 1);
552 /* $$$ optimize, maybe */
553 clib_memset (ip, 0, sizeof (*ip) + sizeof (*udp) + sizeof (*dhcp));
555 ip->ip_version_and_header_length = 0x45;
557 ip->protocol = IP_PROTOCOL_UDP;
564 * Setup the buffer's QoS settings so any QoS marker on the egress
565 * interface, that might set VLAN CoS bits, based on this DSCP setting
567 vnet_buffer2 (b)->qos.source = QOS_SOURCE_IP;
568 vnet_buffer2 (b)->qos.bits = ip->tos;
569 b->flags |= VNET_BUFFER_F_QOS_DATA_VALID;
574 /* src = 0.0.0.0, dst = 255.255.255.255 */
575 ip->dst_address.as_u32 = ~0;
579 /* Renewing an active lease, plain old ip4 src/dst */
580 ip->src_address.as_u32 = c->learned.leased_address.as_u32;
581 ip->dst_address.as_u32 = c->learned.dhcp_server.as_u32;
584 udp->src_port = clib_host_to_net_u16 (UDP_DST_PORT_dhcp_to_client);
585 udp->dst_port = clib_host_to_net_u16 (UDP_DST_PORT_dhcp_to_server);
587 /* Send the interface MAC address */
588 clib_memcpy (dhcp->client_hardware_address,
589 vnet_sw_interface_get_hw_address (vnm, c->sw_if_index), 6);
591 /* And remember it for rx-packet-for-us checking */
592 clib_memcpy (c->client_hardware_address, dhcp->client_hardware_address,
593 sizeof (c->client_hardware_address));
595 /* Lease renewal, set up client_ip_address */
596 if (is_broadcast == 0)
597 dhcp->client_ip_address.as_u32 = c->learned.leased_address.as_u32;
599 dhcp->opcode = 1; /* request, all we send */
600 dhcp->hardware_type = 1; /* ethernet */
601 dhcp->hardware_address_length = 6;
602 dhcp->transaction_identifier = c->transaction_id;
604 clib_host_to_net_u16 (is_broadcast && c->set_broadcast_flag ?
605 DHCP_FLAG_BROADCAST : 0);
606 dhcp->magic_cookie.as_u32 = DHCP_MAGIC;
608 o = (dhcp_option_t *) dhcp->options;
610 /* Send option 53, the DHCP message type */
611 o->option = DHCP_PACKET_OPTION_MSG_TYPE;
614 o = (dhcp_option_t *) (((uword) o) + (o->length + 2));
616 /* Send option 57, max msg length */
617 if (0 /* not needed, apparently */ )
622 u16 *o2 = (u16 *) o->data;
623 *o2 = clib_host_to_net_u16 (1152);
624 o = (dhcp_option_t *) (((uword) o) + (o->length + 2));
629 * If server ip address is available with non-zero value,
630 * option 54 (DHCP Server Identifier) is sent.
632 if (c->learned.dhcp_server.as_u32)
636 clib_memcpy (o->data, &c->learned.dhcp_server.as_u32, 4);
637 o = (dhcp_option_t *) (((uword) o) + (o->length + 2));
640 /* send option 50, requested IP address */
641 if (c->learned.leased_address.as_u32)
645 clib_memcpy (o->data, &c->learned.leased_address.as_u32, 4);
646 o = (dhcp_option_t *) (((uword) o) + (o->length + 2));
649 /* send option 12, host name */
650 if (vec_len (c->hostname))
653 o->length = vec_len (c->hostname);
654 clib_memcpy (o->data, c->hostname, vec_len (c->hostname));
655 o = (dhcp_option_t *) (((uword) o) + (o->length + 2));
658 /* send option 61, client_id */
659 if (vec_len (c->client_identifier))
662 o->length = vec_len (c->client_identifier) + 1;
663 /* Set type to zero, apparently some dhcp servers care */
665 clib_memcpy (o->data + 1, c->client_identifier,
666 vec_len (c->client_identifier));
667 o = (dhcp_option_t *) (((uword) o) + (o->length + 2));
670 /* $$ maybe send the client s/w version if anyone cares */
673 * send option 55, parameter request list
674 * The current list - see below, matches the Linux dhcp client's list
675 * Any specific dhcp server config and/or dhcp server may or may
676 * not yield specific options.
679 o->length = vec_len (c->option_55_data);
680 clib_memcpy (o->data, c->option_55_data, vec_len (c->option_55_data));
681 o = (dhcp_option_t *) (((uword) o) + (o->length + 2));
688 b->current_length = ((u8 *) o) - b->data;
690 /* fix ip length, checksum and udp length */
691 ip_length = vlib_buffer_length_in_chain (vm, b);
693 ip->length = clib_host_to_net_u16 (ip_length);
694 ip->checksum = ip4_header_checksum (ip);
696 udp_length = ip_length - (sizeof (*ip));
697 udp->length = clib_host_to_net_u16 (udp_length);
701 #define _(a,b) case DHCP_PACKET_##a: {counter_index = DHCP_STAT_##a; break;}
702 foreach_dhcp_sent_packet_stat
705 counter_index = DHCP_STAT_UNKNOWN;
709 vlib_node_increment_counter (vm, dhcp_client_process_node.index,
714 dhcp_discover_state (dhcp_client_main_t * dcm, dhcp_client_t * c, f64 now)
717 * State machine "DISCOVER" state. Send a dhcp discover packet,
718 * eventually back off the retry rate.
720 DHCP_INFO ("enter discover: %U", format_dhcp_client, dcm, c);
723 * In order to accept any OFFER, whether broadcasted or unicasted, we
724 * need to configure the dhcp-client-detect feature as an input feature
725 * so the DHCP OFFER is sent to the ip4-local node. Without this a
726 * broadcasted OFFER hits the 255.255.255.255/32 address and a unicast
727 * hits 0.0.0.0/0 both of which default to drop and the latter may forward
728 * of box - not what we want. Nor to we want to change these route for
729 * all interfaces in this table
731 if (c->client_detect_feature_enabled == 0)
733 vnet_feature_enable_disable ("ip4-unicast",
734 "ip4-dhcp-client-detect",
735 c->sw_if_index, 1 /* enable */ , 0, 0);
736 c->client_detect_feature_enabled = 1;
739 send_dhcp_pkt (dcm, c, DHCP_PACKET_DISCOVER, 1 /* is_broadcast */ );
742 if (c->retry_count > 10)
743 c->next_transmit = now + 5.0;
745 c->next_transmit = now + 1.0;
750 dhcp_request_state (dhcp_client_main_t * dcm, dhcp_client_t * c, f64 now)
753 * State machine "REQUEST" state. Send a dhcp request packet,
754 * eventually drop back to the discover state.
756 DHCP_INFO ("enter request: %U", format_dhcp_client, dcm, c);
758 send_dhcp_pkt (dcm, c, DHCP_PACKET_REQUEST, 1 /* is_broadcast */ );
761 if (c->retry_count > 7 /* lucky you */ )
763 c->state = DHCP_DISCOVER;
764 c->next_transmit = now;
768 c->next_transmit = now + 1.0;
773 dhcp_bound_state (dhcp_client_main_t * dcm, dhcp_client_t * c, f64 now)
776 * We disable the client detect feature when we bind a
777 * DHCP address. Turn it back on again on first renew attempt.
778 * Otherwise, if the DHCP server replies we'll never see it.
780 if (c->client_detect_feature_enabled == 0)
782 vnet_feature_enable_disable ("ip4-unicast",
783 "ip4-dhcp-client-detect",
784 c->sw_if_index, 1 /* enable */ , 0, 0);
785 c->client_detect_feature_enabled = 1;
789 * State machine "BOUND" state. Send a dhcp request packet to renew
791 * Eventually, when the lease expires, forget the dhcp data
792 * and go back to the stone age.
794 if (now > c->lease_expires)
796 DHCP_INFO ("lease expired: %U", format_dhcp_client, dcm, c);
798 /* reset all data for the client. do not send any more messages
799 * since the objects to do so have been lost */
800 dhcp_client_reset (dcm, c);
804 DHCP_INFO ("enter bound: %U", format_dhcp_client, dcm, c);
805 send_dhcp_pkt (dcm, c, DHCP_PACKET_REQUEST, 0 /* is_broadcast */ );
808 if (c->retry_count > 10)
809 c->next_transmit = now + 5.0;
811 c->next_transmit = now + 1.0;
817 dhcp_client_sm (f64 now, f64 timeout, uword pool_index)
819 dhcp_client_main_t *dcm = &dhcp_client_main;
822 /* deleted, pooched, yadda yadda yadda */
823 if (pool_is_free_index (dcm->clients, pool_index))
826 c = pool_elt_at_index (dcm->clients, pool_index);
828 /* Time for us to do something with this client? */
829 if (now < c->next_transmit)
835 case DHCP_DISCOVER: /* send a discover */
836 if (dhcp_discover_state (dcm, c, now))
840 case DHCP_REQUEST: /* send a request */
841 if (dhcp_request_state (dcm, c, now))
845 case DHCP_BOUND: /* bound, renew needed? */
846 if (dhcp_bound_state (dcm, c, now))
851 clib_warning ("dhcp client %d bogus state %d",
852 c - dcm->clients, c->state);
856 if (c->next_transmit < now + timeout)
857 return c->next_transmit - now;
863 dhcp_client_process (vlib_main_t * vm,
864 vlib_node_runtime_t * rt, vlib_frame_t * f)
869 uword *event_data = 0;
870 dhcp_client_main_t *dcm = &dhcp_client_main;
876 vlib_process_wait_for_event_or_clock (vm, timeout);
878 event_type = vlib_process_get_events (vm, &event_data);
880 now = vlib_time_now (vm);
884 case EVENT_DHCP_CLIENT_WAKEUP:
885 for (i = 0; i < vec_len (event_data); i++)
886 timeout = dhcp_client_sm (now, timeout, event_data[i]);
891 DHCP_INFO ("timeout");
892 pool_foreach (c, dcm->clients,
894 timeout = dhcp_client_sm (now, timeout,
895 (uword) (c - dcm->clients));
898 if (pool_elts (dcm->clients) == 0)
903 vec_reset_length (event_data);
911 VLIB_REGISTER_NODE (dhcp_client_process_node,static) = {
912 .function = dhcp_client_process,
913 .type = VLIB_NODE_TYPE_PROCESS,
914 .name = "dhcp-client-process",
915 .process_log2_n_stack_bytes = 16,
916 .n_errors = ARRAY_LEN(dhcp_client_process_stat_strings),
917 .error_strings = dhcp_client_process_stat_strings,
921 static clib_error_t *
922 show_dhcp_client_command_fn (vlib_main_t * vm,
923 unformat_input_t * input,
924 vlib_cli_command_t * cmd)
926 dhcp_client_main_t *dcm = &dhcp_client_main;
929 u32 sw_if_index = ~0;
932 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
934 if (unformat (input, "intfc %U",
935 unformat_vnet_sw_interface, dcm->vnet_main, &sw_if_index))
937 else if (unformat (input, "verbose"))
943 if (sw_if_index != ~0)
945 p = hash_get (dcm->client_by_sw_if_index, sw_if_index);
947 return clib_error_return (0, "dhcp client not configured");
948 c = pool_elt_at_index (dcm->clients, p[0]);
949 vlib_cli_output (vm, "%U", format_dhcp_client, dcm, c, verbose);
954 pool_foreach (c, dcm->clients,
956 vlib_cli_output (vm, "%U",
957 format_dhcp_client, dcm,
966 VLIB_CLI_COMMAND (show_dhcp_client_command, static) = {
967 .path = "show dhcp client",
968 .short_help = "show dhcp client [intfc <intfc>][verbose]",
969 .function = show_dhcp_client_command_fn,
975 dhcp_client_add_del (dhcp_client_add_del_args_t * a)
977 dhcp_client_main_t *dcm = &dhcp_client_main;
978 vlib_main_t *vm = dcm->vlib_main;
982 p = hash_get (dcm->client_by_sw_if_index, a->sw_if_index);
984 if ((p && a->is_add) || (!p && a->is_add == 0))
985 return VNET_API_ERROR_INVALID_VALUE;
989 dhcp_maybe_register_udp_ports (DHCP_PORT_REG_CLIENT);
990 pool_get (dcm->clients, c);
991 clib_memset (c, 0, sizeof (*c));
992 c->state = DHCP_DISCOVER;
993 c->sw_if_index = a->sw_if_index;
994 c->client_index = a->client_index;
996 c->event_callback = a->event_callback;
997 c->option_55_data = a->option_55_data;
998 c->hostname = a->hostname;
999 c->client_identifier = a->client_identifier;
1000 c->set_broadcast_flag = a->set_broadcast_flag;
1002 c->ai_ucast = ADJ_INDEX_INVALID;
1003 c->ai_bcast = adj_nbr_add_or_lock (FIB_PROTOCOL_IP4,
1005 &ADJ_BCAST_ADDR, c->sw_if_index);
1009 c->transaction_id = random_u32 (&dcm->seed);
1011 while (c->transaction_id == 0);
1013 hash_set (dcm->client_by_sw_if_index, a->sw_if_index, c - dcm->clients);
1015 vlib_process_signal_event (vm, dhcp_client_process_node.index,
1016 EVENT_DHCP_CLIENT_WAKEUP, c - dcm->clients);
1018 DHCP_INFO ("create: %U", format_dhcp_client, dcm, c);
1022 c = pool_elt_at_index (dcm->clients, p[0]);
1024 dhcp_client_reset (dcm, c);
1026 adj_unlock (c->ai_bcast);
1028 vec_free (c->domain_server_address);
1029 vec_free (c->option_55_data);
1030 vec_free (c->hostname);
1031 vec_free (c->client_identifier);
1032 hash_unset (dcm->client_by_sw_if_index, c->sw_if_index);
1033 pool_put (dcm->clients, c);
1039 dhcp_client_config (u32 is_add,
1045 dhcp_event_cb_t event_callback,
1046 u8 set_broadcast_flag, ip_dscp_t dscp, u32 pid)
1048 dhcp_client_add_del_args_t _a, *a = &_a;
1051 clib_memset (a, 0, sizeof (*a));
1053 a->sw_if_index = sw_if_index;
1054 a->client_index = client_index;
1056 a->event_callback = event_callback;
1057 a->set_broadcast_flag = set_broadcast_flag;
1059 vec_validate (a->hostname, strlen ((char *) hostname) - 1);
1060 strncpy ((char *) a->hostname, (char *) hostname, vec_len (a->hostname));
1061 vec_validate (a->client_identifier, strlen ((char *) client_id) - 1);
1062 strncpy ((char *) a->client_identifier, (char *) client_id,
1063 vec_len (a->client_identifier));
1066 * Option 55 request list. These data precisely match
1067 * the Ubuntu dhcp client. YMMV.
1071 vec_add1 (a->option_55_data, 1);
1072 /* Broadcast address */
1073 vec_add1 (a->option_55_data, 28);
1075 vec_add1 (a->option_55_data, 2);
1077 vec_add1 (a->option_55_data, 3);
1079 vec_add1 (a->option_55_data, 15);
1081 vec_add1 (a->option_55_data, 6);
1083 vec_add1 (a->option_55_data, 119);
1085 vec_add1 (a->option_55_data, 12);
1086 /* NetBIOS name server */
1087 vec_add1 (a->option_55_data, 44);
1089 vec_add1 (a->option_55_data, 47);
1091 vec_add1 (a->option_55_data, 26);
1092 /* Classless static route */
1093 vec_add1 (a->option_55_data, 121);
1095 vec_add1 (a->option_55_data, 42);
1097 rv = dhcp_client_add_del (a);
1104 case VNET_API_ERROR_INVALID_VALUE:
1106 vec_free (a->hostname);
1107 vec_free (a->client_identifier);
1108 vec_free (a->option_55_data);
1111 clib_warning ("dhcp client already enabled on intf_idx %d",
1114 clib_warning ("dhcp client not enabled on on intf_idx %d",
1119 clib_warning ("dhcp_client_add_del returned %d", rv);
1126 dhcp_client_walk (dhcp_client_walk_cb_t cb, void *ctx)
1128 dhcp_client_main_t *dcm = &dhcp_client_main;
1132 pool_foreach (c, dcm->clients,
1141 static clib_error_t *
1142 dhcp_client_set_command_fn (vlib_main_t * vm,
1143 unformat_input_t * input,
1144 vlib_cli_command_t * cmd)
1147 dhcp_client_main_t *dcm = &dhcp_client_main;
1150 u8 sw_if_index_set = 0;
1151 u8 set_broadcast_flag = 1;
1153 dhcp_client_add_del_args_t _a, *a = &_a;
1156 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1158 if (unformat (input, "intfc %U",
1159 unformat_vnet_sw_interface, dcm->vnet_main, &sw_if_index))
1160 sw_if_index_set = 1;
1161 else if (unformat (input, "hostname %v", &hostname))
1163 else if (unformat (input, "del"))
1165 else if (unformat (input, "broadcast", &set_broadcast_flag))
1171 if (sw_if_index_set == 0)
1172 return clib_error_return (0, "interface not specified");
1174 clib_memset (a, 0, sizeof (*a));
1176 a->sw_if_index = sw_if_index;
1177 a->hostname = hostname;
1178 a->client_identifier = format (0, "vpp 1.1%c", 0);
1179 a->set_broadcast_flag = set_broadcast_flag;
1182 * Option 55 request list. These data precisely match
1183 * the Ubuntu dhcp client. YMMV.
1187 vec_add1 (a->option_55_data, 1);
1188 /* Broadcast address */
1189 vec_add1 (a->option_55_data, 28);
1191 vec_add1 (a->option_55_data, 2);
1193 vec_add1 (a->option_55_data, 3);
1195 vec_add1 (a->option_55_data, 15);
1197 vec_add1 (a->option_55_data, 6);
1199 vec_add1 (a->option_55_data, 119);
1201 vec_add1 (a->option_55_data, 12);
1202 /* NetBIOS name server */
1203 vec_add1 (a->option_55_data, 44);
1205 vec_add1 (a->option_55_data, 47);
1207 vec_add1 (a->option_55_data, 26);
1208 /* Classless static route */
1209 vec_add1 (a->option_55_data, 121);
1211 vec_add1 (a->option_55_data, 42);
1213 rv = dhcp_client_add_del (a);
1220 case VNET_API_ERROR_INVALID_VALUE:
1222 vec_free (a->hostname);
1223 vec_free (a->client_identifier);
1224 vec_free (a->option_55_data);
1226 return clib_error_return (0, "dhcp client already enabled on %U",
1227 format_vnet_sw_if_index_name,
1228 dcm->vnet_main, sw_if_index);
1230 return clib_error_return (0, "dhcp client not enabled on %U",
1231 format_vnet_sw_if_index_name,
1232 dcm->vnet_main, sw_if_index);
1236 vlib_cli_output (vm, "dhcp_client_add_del returned %d", rv);
1243 VLIB_CLI_COMMAND (dhcp_client_set_command, static) = {
1244 .path = "set dhcp client",
1245 .short_help = "set dhcp client [del] intfc <interface> [hostname <name>]",
1246 .function = dhcp_client_set_command_fn,
1250 static clib_error_t *
1251 dhcp_client_init (vlib_main_t * vm)
1253 dhcp_client_main_t *dcm = &dhcp_client_main;
1255 dcm->vlib_main = vm;
1256 dcm->vnet_main = vnet_get_main ();
1257 dcm->seed = (u32) clib_cpu_time_now ();
1259 dhcp_logger = vlib_log_register_class ("dhcp", "client");
1264 VLIB_INIT_FUNCTION (dhcp_client_init);
1267 * fd.io coding-style-patch-verification: ON
1270 * eval: (c-set-style "gnu")