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 <vnet/dhcp/client.h>
18 #include <vnet/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,
125 s = format (s, "\n broadcast adjacency:%d", c->ai_bcast);
131 dhcp_client_acquire_address (dhcp_client_main_t * dcm, dhcp_client_t * c)
134 * Install any/all info gleaned from dhcp, right here
136 if (!c->addresses_installed)
138 ip4_add_del_interface_address (dcm->vlib_main, c->sw_if_index,
139 (void *) &c->learned.leased_address,
140 c->learned.subnet_mask_width,
142 if (c->learned.router_address.as_u32)
144 fib_prefix_t all_0s = {
146 .fp_proto = FIB_PROTOCOL_IP4,
148 ip46_address_t nh = {
149 .ip4 = c->learned.router_address,
153 fib_table_entry_path_add (
154 fib_table_get_index_for_sw_if_index (
162 ~0, 1, NULL, // no label stack
163 FIB_ROUTE_PATH_FLAG_NONE);
167 clib_memcpy (&c->installed, &c->learned, sizeof (c->installed));
168 c->addresses_installed = 1;
172 dhcp_client_release_address (dhcp_client_main_t * dcm, dhcp_client_t * c)
175 * Remove any/all info gleaned from dhcp, right here. Caller(s)
176 * have not wiped out the info yet.
178 if (c->addresses_installed)
180 ip4_add_del_interface_address (dcm->vlib_main, c->sw_if_index,
181 (void *) &c->installed.leased_address,
182 c->installed.subnet_mask_width,
185 /* Remove the default route */
186 if (c->installed.router_address.as_u32)
188 fib_prefix_t all_0s = {
190 .fp_proto = FIB_PROTOCOL_IP4,
192 ip46_address_t nh = {
193 .ip4 = c->installed.router_address,
196 fib_table_entry_path_remove (fib_table_get_index_for_sw_if_index
197 (FIB_PROTOCOL_IP4, c->sw_if_index),
198 &all_0s, FIB_SOURCE_DHCP,
199 DPO_PROTO_IP4, &nh, c->sw_if_index, ~0,
200 1, FIB_ROUTE_PATH_FLAG_NONE);
203 clib_memset (&c->installed, 0, sizeof (c->installed));
204 c->addresses_installed = 0;
208 dhcp_client_proc_callback (uword * client_index)
210 vlib_main_t *vm = vlib_get_main ();
211 ASSERT (vlib_get_thread_index () == 0);
212 vlib_process_signal_event (vm, dhcp_client_process_node.index,
213 EVENT_DHCP_CLIENT_WAKEUP, *client_index);
217 dhcp_client_addr_callback (u32 * cindex)
219 dhcp_client_main_t *dcm = &dhcp_client_main;
222 c = pool_elt_at_index (dcm->clients, *cindex);
224 /* disable the feature */
225 vnet_feature_enable_disable ("ip4-unicast",
226 "ip4-dhcp-client-detect",
227 c->sw_if_index, 0 /* disable */ , 0, 0);
228 c->client_detect_feature_enabled = 0;
230 /* add the address to the interface if they've changed since the last time */
231 if (0 != clib_memcmp (&c->installed, &c->learned, sizeof (c->learned)))
233 dhcp_client_release_address (dcm, c);
234 dhcp_client_acquire_address (dcm, c);
238 * Call the user's event callback to report DHCP information
240 if (c->event_callback)
241 c->event_callback (c->client_index, c);
243 DHCP_INFO ("update: %U", format_dhcp_client, dcm, c, 1 /* verbose */ );
247 dhcp_client_reset (dhcp_client_main_t * dcm, dhcp_client_t * c)
249 if (c->client_detect_feature_enabled == 1)
251 vnet_feature_enable_disable ("ip4-unicast",
252 "ip4-dhcp-client-detect",
253 c->sw_if_index, 0, 0, 0);
254 c->client_detect_feature_enabled = 0;
257 dhcp_client_release_address (dcm, c);
258 clib_memset (&c->learned, 0, sizeof (c->installed));
259 c->state = DHCP_DISCOVER;
260 c->next_transmit = vlib_time_now (dcm->vlib_main);
262 c->lease_renewal_interval = 0;
263 vec_free (c->domain_server_address);
267 * dhcp_client_for_us - server-to-client callback.
268 * Called from proxy_node.c:dhcp_proxy_to_client_input().
269 * This function first decides that the packet in question is
270 * actually for the dhcp client code in case we're also acting as
271 * a dhcp proxy. Ay caramba, what a folly!
274 dhcp_client_for_us (u32 bi, vlib_buffer_t * b,
276 udp_header_t * udp, dhcp_header_t * dhcp)
278 dhcp_client_main_t *dcm = &dhcp_client_main;
279 vlib_main_t *vm = dcm->vlib_main;
282 f64 now = vlib_time_now (dcm->vlib_main);
283 u8 dhcp_message_type = 0;
287 * Doing dhcp client on this interface?
288 * Presumably we will always receive dhcp clnt for-us pkts on
289 * the interface that's asking for an address.
291 p = hash_get (dcm->client_by_sw_if_index,
292 vnet_buffer (b)->sw_if_index[VLIB_RX]);
296 c = pool_elt_at_index (dcm->clients, p[0]);
298 /* Mixing dhcp relay and dhcp proxy? DGMS... */
299 if (c->state == DHCP_BOUND && c->retry_count == 0)
302 /* Packet not for us? Turf it... */
303 if (memcmp (dhcp->client_hardware_address, c->client_hardware_address,
304 sizeof (c->client_hardware_address)))
306 vlib_node_increment_counter (vm, dhcp_client_process_node.index,
307 DHCP_STAT_NOT_FOR_US, 1);
311 /* parse through the packet, learn what we can */
312 if (dhcp->your_ip_address.as_u32)
313 c->learned.leased_address.as_u32 = dhcp->your_ip_address.as_u32;
315 c->learned.dhcp_server.as_u32 = dhcp->server_ip_address.as_u32;
317 o = (dhcp_option_t *) dhcp->options;
319 while (o->option != 0xFF /* end of options */ &&
320 (u8 *) o < (b->data + b->current_data + b->current_length))
324 case 53: /* dhcp message type */
325 dhcp_message_type = o->data[0];
328 case 51: /* lease time */
330 u32 lease_time_in_seconds =
331 clib_host_to_net_u32 (o->data_as_u32[0]);
332 // for debug: lease_time_in_seconds = 20; /*$$$$*/
333 c->lease_expires = now + (f64) lease_time_in_seconds;
334 c->lease_lifetime = lease_time_in_seconds;
335 /* Set a sensible default, in case we don't get opt 58 */
336 c->lease_renewal_interval = lease_time_in_seconds / 2;
340 case 58: /* lease renew time in seconds */
342 u32 lease_renew_time_in_seconds =
343 clib_host_to_net_u32 (o->data_as_u32[0]);
344 c->lease_renewal_interval = lease_renew_time_in_seconds;
348 case 54: /* dhcp server address */
349 c->learned.dhcp_server.as_u32 = o->data_as_u32[0];
352 case 1: /* subnet mask */
354 u32 subnet_mask = clib_host_to_net_u32 (o->data_as_u32[0]);
355 c->learned.subnet_mask_width = count_set_bits (subnet_mask);
358 case 3: /* router address */
360 u32 router_address = o->data_as_u32[0];
361 c->learned.router_address.as_u32 = router_address;
364 case 6: /* domain server address */
366 vec_free (c->domain_server_address);
367 vec_validate (c->domain_server_address,
368 o->length / sizeof (ip4_address_t) - 1);
369 clib_memcpy (c->domain_server_address, o->data, o->length);
372 case 12: /* hostname */
374 /* Replace the existing hostname if necessary */
375 vec_free (c->hostname);
376 vec_validate (c->hostname, o->length - 1);
377 clib_memcpy (c->hostname, o->data, o->length);
381 /* $$$$ Your message in this space, parse more options */
386 o = (dhcp_option_t *) (((uword) o) + (o->length + 2));
392 if (dhcp_message_type != DHCP_PACKET_OFFER)
394 vlib_node_increment_counter (vm, dhcp_client_process_node.index,
395 DHCP_STAT_NON_OFFER_DISCOVER, 1);
396 c->next_transmit = now + 5.0;
400 /* Received an offer, go send a request */
401 c->state = DHCP_REQUEST;
403 c->next_transmit = 0; /* send right now... */
404 /* Poke the client process, which will send the request */
405 uword client_id = c - dcm->clients;
406 vl_api_rpc_call_main_thread (dhcp_client_proc_callback,
407 (u8 *) & client_id, sizeof (uword));
412 if (dhcp_message_type == DHCP_PACKET_NAK)
414 vlib_node_increment_counter (vm, dhcp_client_process_node.index,
416 /* Probably never happens in bound state, but anyhow...
417 Wipe out any memory of the address we had... */
418 dhcp_client_reset (dcm, c);
422 if (dhcp_message_type != DHCP_PACKET_ACK &&
423 dhcp_message_type != DHCP_PACKET_OFFER)
425 vlib_node_increment_counter (vm, dhcp_client_process_node.index,
426 DHCP_STAT_NON_OFFER_DISCOVER, 1);
427 clib_warning ("sw_if_index %d state %U message type %d",
428 c->sw_if_index, format_dhcp_client_state,
429 c->state, dhcp_message_type);
430 c->next_transmit = now + 5.0;
433 /* OK, we own the address (etc), add to the routing table(s) */
435 /* Send the index over to the main thread, where it can retrieve
436 * the original client */
437 u32 cindex = c - dcm->clients;
438 vl_api_force_rpc_call_main_thread (dhcp_client_addr_callback,
439 (u8 *) & cindex, sizeof (u32));
442 c->state = DHCP_BOUND;
444 c->next_transmit = now + (f64) c->lease_renewal_interval;
445 c->lease_expires = now + (f64) c->lease_lifetime;
446 vlib_node_increment_counter (vm, dhcp_client_process_node.index,
451 clib_warning ("client %d bogus state %d", c - dcm->clients, c->state);
455 /* return 1 so the call disposes of this packet */
460 send_dhcp_pkt (dhcp_client_main_t * dcm, dhcp_client_t * c,
461 dhcp_packet_type_t type, int is_broadcast)
463 vlib_main_t *vm = dcm->vlib_main;
464 vnet_main_t *vnm = dcm->vnet_main;
465 vnet_hw_interface_t *hw = vnet_get_sup_hw_interface (vnm, c->sw_if_index);
466 vnet_sw_interface_t *sup_sw
467 = vnet_get_sup_sw_interface (vnm, c->sw_if_index);
468 vnet_sw_interface_t *sw = vnet_get_sw_interface (vnm, c->sw_if_index);
477 u16 udp_length, ip_length;
478 u32 counter_index, node_index;
480 DHCP_INFO ("send: type:%U bcast:%d %U",
481 format_dhcp_packet_type, type,
482 is_broadcast, format_dhcp_client, dcm, c, 1 /* verbose */ );
484 /* Interface(s) down? */
485 if ((hw->flags & VNET_HW_INTERFACE_FLAG_LINK_UP) == 0)
487 if ((sup_sw->flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) == 0)
489 if ((sw->flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) == 0)
492 if (vlib_buffer_alloc (vm, &bi, 1) != 1)
494 clib_warning ("buffer allocation failure");
495 c->next_transmit = 0;
499 /* Build a dhcpv4 pkt from whole cloth */
500 b = vlib_get_buffer (vm, bi);
501 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b);
503 ASSERT (b->current_data == 0);
505 vnet_buffer (b)->sw_if_index[VLIB_RX] = c->sw_if_index;
506 b->flags |= VNET_BUFFER_F_LOCALLY_ORIGINATED;
510 node_index = ip4_rewrite_node.index;
511 vnet_buffer (b)->ip.adj_index[VLIB_TX] = c->ai_bcast;
514 node_index = dcm->ip4_lookup_node_index;
516 /* Enqueue the packet right now */
517 f = vlib_get_frame_to_node (vm, node_index);
518 to_next = vlib_frame_vector_args (f);
521 vlib_put_frame_to_node (vm, node_index, f);
523 /* build the headers */
524 ip = vlib_buffer_get_current (b);
525 udp = (udp_header_t *) (ip + 1);
526 dhcp = (dhcp_header_t *) (udp + 1);
528 /* $$$ optimize, maybe */
529 clib_memset (ip, 0, sizeof (*ip) + sizeof (*udp) + sizeof (*dhcp));
531 ip->ip_version_and_header_length = 0x45;
533 ip->protocol = IP_PROTOCOL_UDP;
540 * Setup the buffer's QoS settings so any QoS marker on the egress
541 * interface, that might set VLAN CoS bits, based on this DSCP setting
543 vnet_buffer2 (b)->qos.source = QOS_SOURCE_IP;
544 vnet_buffer2 (b)->qos.bits = ip->tos;
545 b->flags |= VNET_BUFFER_F_QOS_DATA_VALID;
550 /* src = 0.0.0.0, dst = 255.255.255.255 */
551 ip->dst_address.as_u32 = ~0;
555 /* Renewing an active lease, plain old ip4 src/dst */
556 ip->src_address.as_u32 = c->learned.leased_address.as_u32;
557 ip->dst_address.as_u32 = c->learned.dhcp_server.as_u32;
560 udp->src_port = clib_host_to_net_u16 (UDP_DST_PORT_dhcp_to_client);
561 udp->dst_port = clib_host_to_net_u16 (UDP_DST_PORT_dhcp_to_server);
563 /* Send the interface MAC address */
564 clib_memcpy (dhcp->client_hardware_address,
565 vnet_sw_interface_get_hw_address (vnm, c->sw_if_index), 6);
567 /* And remember it for rx-packet-for-us checking */
568 clib_memcpy (c->client_hardware_address, dhcp->client_hardware_address,
569 sizeof (c->client_hardware_address));
571 /* Lease renewal, set up client_ip_address */
572 if (is_broadcast == 0)
573 dhcp->client_ip_address.as_u32 = c->learned.leased_address.as_u32;
575 dhcp->opcode = 1; /* request, all we send */
576 dhcp->hardware_type = 1; /* ethernet */
577 dhcp->hardware_address_length = 6;
578 dhcp->transaction_identifier = c->transaction_id;
580 clib_host_to_net_u16 (is_broadcast && c->set_broadcast_flag ?
581 DHCP_FLAG_BROADCAST : 0);
582 dhcp->magic_cookie.as_u32 = DHCP_MAGIC;
584 o = (dhcp_option_t *) dhcp->options;
586 /* Send option 53, the DHCP message type */
587 o->option = DHCP_PACKET_OPTION_MSG_TYPE;
590 o = (dhcp_option_t *) (((uword) o) + (o->length + 2));
592 /* Send option 57, max msg length */
593 if (0 /* not needed, apparently */ )
598 u16 *o2 = (u16 *) o->data;
599 *o2 = clib_host_to_net_u16 (1152);
600 o = (dhcp_option_t *) (((uword) o) + (o->length + 2));
605 * If server ip address is available with non-zero value,
606 * option 54 (DHCP Server Identifier) is sent.
608 if (c->learned.dhcp_server.as_u32)
612 clib_memcpy (o->data, &c->learned.dhcp_server.as_u32, 4);
613 o = (dhcp_option_t *) (((uword) o) + (o->length + 2));
616 /* send option 50, requested IP address */
617 if (c->learned.leased_address.as_u32)
621 clib_memcpy (o->data, &c->learned.leased_address.as_u32, 4);
622 o = (dhcp_option_t *) (((uword) o) + (o->length + 2));
625 /* send option 12, host name */
626 if (vec_len (c->hostname))
629 o->length = vec_len (c->hostname);
630 clib_memcpy (o->data, c->hostname, vec_len (c->hostname));
631 o = (dhcp_option_t *) (((uword) o) + (o->length + 2));
634 /* send option 61, client_id */
635 if (vec_len (c->client_identifier))
638 o->length = vec_len (c->client_identifier) + 1;
639 /* Set type to zero, apparently some dhcp servers care */
641 clib_memcpy (o->data + 1, c->client_identifier,
642 vec_len (c->client_identifier));
643 o = (dhcp_option_t *) (((uword) o) + (o->length + 2));
646 /* $$ maybe send the client s/w version if anyone cares */
649 * send option 55, parameter request list
650 * The current list - see below, matches the Linux dhcp client's list
651 * Any specific dhcp server config and/or dhcp server may or may
652 * not yield specific options.
655 o->length = vec_len (c->option_55_data);
656 clib_memcpy (o->data, c->option_55_data, vec_len (c->option_55_data));
657 o = (dhcp_option_t *) (((uword) o) + (o->length + 2));
664 b->current_length = ((u8 *) o) - b->data;
666 /* fix ip length, checksum and udp length */
667 ip_length = vlib_buffer_length_in_chain (vm, b);
669 ip->length = clib_host_to_net_u16 (ip_length);
670 ip->checksum = ip4_header_checksum (ip);
672 udp_length = ip_length - (sizeof (*ip));
673 udp->length = clib_host_to_net_u16 (udp_length);
677 #define _(a,b) case DHCP_PACKET_##a: {counter_index = DHCP_STAT_##a; break;}
678 foreach_dhcp_sent_packet_stat
681 counter_index = DHCP_STAT_UNKNOWN;
685 vlib_node_increment_counter (vm, dhcp_client_process_node.index,
690 dhcp_discover_state (dhcp_client_main_t * dcm, dhcp_client_t * c, f64 now)
693 * State machine "DISCOVER" state. Send a dhcp discover packet,
694 * eventually back off the retry rate.
697 * In order to accept any OFFER, whether broadcasted or unicasted, we
698 * need to configure the dhcp-client-detect feature as an input feature
699 * so the DHCP OFFER is sent to the ip4-local node. Without this a
700 * broadcasted OFFER hits the 255.255.255.255/32 address and a unicast
701 * hits 0.0.0.0/0 both of which default to drop and the latter may forward
702 * of box - not what we want. Nor to we want to change these route for
703 * all interfaces in this table
705 if (c->client_detect_feature_enabled == 0)
707 vnet_feature_enable_disable ("ip4-unicast",
708 "ip4-dhcp-client-detect",
709 c->sw_if_index, 1 /* enable */ , 0, 0);
710 c->client_detect_feature_enabled = 1;
713 send_dhcp_pkt (dcm, c, DHCP_PACKET_DISCOVER, 1 /* is_broadcast */ );
716 if (c->retry_count > 10)
717 c->next_transmit = now + 5.0;
719 c->next_transmit = now + 1.0;
724 dhcp_request_state (dhcp_client_main_t * dcm, dhcp_client_t * c, f64 now)
727 * State machine "REQUEST" state. Send a dhcp request packet,
728 * eventually drop back to the discover state.
730 DHCP_INFO ("enter request: %U", format_dhcp_client, dcm, c,
733 send_dhcp_pkt (dcm, c, DHCP_PACKET_REQUEST, 1 /* is_broadcast */ );
736 if (c->retry_count > 7 /* lucky you */ )
738 c->state = DHCP_DISCOVER;
739 c->next_transmit = now;
743 c->next_transmit = now + 1.0;
748 dhcp_bound_state (dhcp_client_main_t * dcm, dhcp_client_t * c, f64 now)
751 * We disable the client detect feature when we bind a
752 * DHCP address. Turn it back on again on first renew attempt.
753 * Otherwise, if the DHCP server replies we'll never see it.
755 if (c->client_detect_feature_enabled == 0)
757 vnet_feature_enable_disable ("ip4-unicast",
758 "ip4-dhcp-client-detect",
759 c->sw_if_index, 1 /* enable */ , 0, 0);
760 c->client_detect_feature_enabled = 1;
764 * State machine "BOUND" state. Send a dhcp request packet to renew
766 * Eventually, when the lease expires, forget the dhcp data
767 * and go back to the stone age.
769 if (now > c->lease_expires)
771 DHCP_INFO ("lease expired: %U", format_dhcp_client, dcm, c,
774 /* reset all data for the client. do not send any more messages
775 * since the objects to do so have been lost */
776 dhcp_client_reset (dcm, c);
780 DHCP_INFO ("enter bound: %U", format_dhcp_client, dcm, c, 1 /* verbose */ );
781 send_dhcp_pkt (dcm, c, DHCP_PACKET_REQUEST, 0 /* is_broadcast */ );
784 if (c->retry_count > 10)
785 c->next_transmit = now + 5.0;
787 c->next_transmit = now + 1.0;
793 dhcp_client_sm (f64 now, f64 timeout, uword pool_index)
795 dhcp_client_main_t *dcm = &dhcp_client_main;
798 /* deleted, pooched, yadda yadda yadda */
799 if (pool_is_free_index (dcm->clients, pool_index))
802 c = pool_elt_at_index (dcm->clients, pool_index);
804 /* Time for us to do something with this client? */
805 if (now < c->next_transmit)
806 return c->next_transmit;
808 DHCP_INFO ("sm active session %d", c - dcm->clients);
813 case DHCP_DISCOVER: /* send a discover */
814 if (dhcp_discover_state (dcm, c, now))
818 case DHCP_REQUEST: /* send a request */
819 if (dhcp_request_state (dcm, c, now))
823 case DHCP_BOUND: /* bound, renew needed? */
824 if (dhcp_bound_state (dcm, c, now))
829 clib_warning ("dhcp client %d bogus state %d",
830 c - dcm->clients, c->state);
834 return c->next_transmit;
838 dhcp_client_process (vlib_main_t * vm,
839 vlib_node_runtime_t * rt, vlib_frame_t * f)
841 f64 timeout = 1000.0;
842 f64 next_expire_time, this_next_expire_time;
845 uword *event_data = 0;
846 dhcp_client_main_t *dcm = &dhcp_client_main;
852 vlib_process_wait_for_event_or_clock (vm, timeout);
854 event_type = vlib_process_get_events (vm, &event_data);
856 now = vlib_time_now (vm);
860 case EVENT_DHCP_CLIENT_WAKEUP:
861 for (i = 0; i < vec_len (event_data); i++)
862 (void) dhcp_client_sm (now, timeout, event_data[i]);
866 if (pool_elts (dcm->clients))
869 next_expire_time = 1e70;
870 pool_foreach (c, dcm->clients,
872 this_next_expire_time = dhcp_client_sm
873 (now, timeout, (uword) (c - dcm->clients));
874 next_expire_time = this_next_expire_time < next_expire_time ?
875 this_next_expire_time : next_expire_time;
877 if (next_expire_time > now)
878 timeout = next_expire_time - now;
881 clib_warning ("BUG");
891 vec_reset_length (event_data);
899 VLIB_REGISTER_NODE (dhcp_client_process_node,static) = {
900 .function = dhcp_client_process,
901 .type = VLIB_NODE_TYPE_PROCESS,
902 .name = "dhcp-client-process",
903 .process_log2_n_stack_bytes = 16,
904 .n_errors = ARRAY_LEN(dhcp_client_process_stat_strings),
905 .error_strings = dhcp_client_process_stat_strings,
909 static clib_error_t *
910 show_dhcp_client_command_fn (vlib_main_t * vm,
911 unformat_input_t * input,
912 vlib_cli_command_t * cmd)
914 dhcp_client_main_t *dcm = &dhcp_client_main;
917 u32 sw_if_index = ~0;
920 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
922 if (unformat (input, "intfc %U",
923 unformat_vnet_sw_interface, dcm->vnet_main, &sw_if_index))
925 else if (unformat (input, "verbose"))
931 if (sw_if_index != ~0)
933 p = hash_get (dcm->client_by_sw_if_index, sw_if_index);
935 return clib_error_return (0, "dhcp client not configured");
936 c = pool_elt_at_index (dcm->clients, p[0]);
937 vlib_cli_output (vm, "%U", format_dhcp_client, dcm, c, verbose);
942 pool_foreach (c, dcm->clients,
944 vlib_cli_output (vm, "%U",
945 format_dhcp_client, dcm,
954 VLIB_CLI_COMMAND (show_dhcp_client_command, static) = {
955 .path = "show dhcp client",
956 .short_help = "show dhcp client [intfc <intfc>][verbose]",
957 .function = show_dhcp_client_command_fn,
963 dhcp_client_add_del (dhcp_client_add_del_args_t * a)
965 dhcp_client_main_t *dcm = &dhcp_client_main;
966 vlib_main_t *vm = dcm->vlib_main;
970 p = hash_get (dcm->client_by_sw_if_index, a->sw_if_index);
972 if ((p && a->is_add) || (!p && a->is_add == 0))
973 return VNET_API_ERROR_INVALID_VALUE;
977 dhcp_maybe_register_udp_ports (DHCP_PORT_REG_CLIENT);
978 pool_get (dcm->clients, c);
979 clib_memset (c, 0, sizeof (*c));
980 c->state = DHCP_DISCOVER;
981 c->sw_if_index = a->sw_if_index;
982 c->client_index = a->client_index;
984 c->event_callback = a->event_callback;
985 c->option_55_data = a->option_55_data;
986 c->hostname = a->hostname;
987 c->client_identifier = a->client_identifier;
988 c->set_broadcast_flag = a->set_broadcast_flag;
990 c->ai_bcast = adj_nbr_add_or_lock (FIB_PROTOCOL_IP4,
992 &ADJ_BCAST_ADDR, c->sw_if_index);
996 c->transaction_id = random_u32 (&dcm->seed);
998 while (c->transaction_id == 0);
1000 hash_set (dcm->client_by_sw_if_index, a->sw_if_index, c - dcm->clients);
1002 vlib_process_signal_event (vm, dhcp_client_process_node.index,
1003 EVENT_DHCP_CLIENT_WAKEUP, c - dcm->clients);
1005 DHCP_INFO ("create: %U", format_dhcp_client, dcm, c, 1 /* verbose */ );
1009 c = pool_elt_at_index (dcm->clients, p[0]);
1011 dhcp_client_reset (dcm, c);
1013 adj_unlock (c->ai_bcast);
1015 vec_free (c->domain_server_address);
1016 vec_free (c->option_55_data);
1017 vec_free (c->hostname);
1018 vec_free (c->client_identifier);
1019 hash_unset (dcm->client_by_sw_if_index, c->sw_if_index);
1020 pool_put (dcm->clients, c);
1026 dhcp_client_config (u32 is_add,
1032 dhcp_event_cb_t event_callback,
1033 u8 set_broadcast_flag, ip_dscp_t dscp, u32 pid)
1035 dhcp_client_add_del_args_t _a, *a = &_a;
1038 clib_memset (a, 0, sizeof (*a));
1040 a->sw_if_index = sw_if_index;
1041 a->client_index = client_index;
1043 a->event_callback = event_callback;
1044 a->set_broadcast_flag = set_broadcast_flag;
1046 vec_validate (a->hostname, strlen ((char *) hostname) - 1);
1047 strncpy ((char *) a->hostname, (char *) hostname, vec_len (a->hostname));
1048 vec_validate (a->client_identifier, strlen ((char *) client_id) - 1);
1049 strncpy ((char *) a->client_identifier, (char *) client_id,
1050 vec_len (a->client_identifier));
1053 * Option 55 request list. These data precisely match
1054 * the Ubuntu dhcp client. YMMV.
1058 vec_add1 (a->option_55_data, 1);
1059 /* Broadcast address */
1060 vec_add1 (a->option_55_data, 28);
1062 vec_add1 (a->option_55_data, 2);
1064 vec_add1 (a->option_55_data, 3);
1066 vec_add1 (a->option_55_data, 15);
1068 vec_add1 (a->option_55_data, 6);
1070 vec_add1 (a->option_55_data, 119);
1072 vec_add1 (a->option_55_data, 12);
1073 /* NetBIOS name server */
1074 vec_add1 (a->option_55_data, 44);
1076 vec_add1 (a->option_55_data, 47);
1078 vec_add1 (a->option_55_data, 26);
1079 /* Classless static route */
1080 vec_add1 (a->option_55_data, 121);
1082 vec_add1 (a->option_55_data, 42);
1084 rv = dhcp_client_add_del (a);
1091 case VNET_API_ERROR_INVALID_VALUE:
1093 vec_free (a->hostname);
1094 vec_free (a->client_identifier);
1095 vec_free (a->option_55_data);
1098 DHCP_INFO ("dhcp client already enabled on intf_idx %d", sw_if_index);
1100 DHCP_INFO ("not enabled on on intf_idx %d", sw_if_index);
1104 DHCP_INFO ("dhcp_client_add_del returned %d", rv);
1111 dhcp_client_walk (dhcp_client_walk_cb_t cb, void *ctx)
1113 dhcp_client_main_t *dcm = &dhcp_client_main;
1117 pool_foreach (c, dcm->clients,
1126 static clib_error_t *
1127 dhcp_client_set_command_fn (vlib_main_t * vm,
1128 unformat_input_t * input,
1129 vlib_cli_command_t * cmd)
1132 dhcp_client_main_t *dcm = &dhcp_client_main;
1135 u8 sw_if_index_set = 0;
1136 u8 set_broadcast_flag = 1;
1138 dhcp_client_add_del_args_t _a, *a = &_a;
1141 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1143 if (unformat (input, "intfc %U",
1144 unformat_vnet_sw_interface, dcm->vnet_main, &sw_if_index))
1145 sw_if_index_set = 1;
1146 else if (unformat (input, "hostname %v", &hostname))
1148 else if (unformat (input, "del"))
1150 else if (unformat (input, "broadcast", &set_broadcast_flag))
1156 if (sw_if_index_set == 0)
1157 return clib_error_return (0, "interface not specified");
1159 clib_memset (a, 0, sizeof (*a));
1161 a->sw_if_index = sw_if_index;
1162 a->hostname = hostname;
1163 a->client_identifier = format (0, "vpp 1.1%c", 0);
1164 a->set_broadcast_flag = set_broadcast_flag;
1167 * Option 55 request list. These data precisely match
1168 * the Ubuntu dhcp client. YMMV.
1172 vec_add1 (a->option_55_data, 1);
1173 /* Broadcast address */
1174 vec_add1 (a->option_55_data, 28);
1176 vec_add1 (a->option_55_data, 2);
1178 vec_add1 (a->option_55_data, 3);
1180 vec_add1 (a->option_55_data, 15);
1182 vec_add1 (a->option_55_data, 6);
1184 vec_add1 (a->option_55_data, 119);
1186 vec_add1 (a->option_55_data, 12);
1187 /* NetBIOS name server */
1188 vec_add1 (a->option_55_data, 44);
1190 vec_add1 (a->option_55_data, 47);
1192 vec_add1 (a->option_55_data, 26);
1193 /* Classless static route */
1194 vec_add1 (a->option_55_data, 121);
1196 vec_add1 (a->option_55_data, 42);
1198 rv = dhcp_client_add_del (a);
1205 case VNET_API_ERROR_INVALID_VALUE:
1207 vec_free (a->hostname);
1208 vec_free (a->client_identifier);
1209 vec_free (a->option_55_data);
1211 return clib_error_return (0, "dhcp client already enabled on %U",
1212 format_vnet_sw_if_index_name,
1213 dcm->vnet_main, sw_if_index);
1215 return clib_error_return (0, "dhcp client not enabled on %U",
1216 format_vnet_sw_if_index_name,
1217 dcm->vnet_main, sw_if_index);
1221 vlib_cli_output (vm, "dhcp_client_add_del returned %d", rv);
1228 VLIB_CLI_COMMAND (dhcp_client_set_command, static) = {
1229 .path = "set dhcp client",
1230 .short_help = "set dhcp client [del] intfc <interface> [hostname <name>]",
1231 .function = dhcp_client_set_command_fn,
1235 static clib_error_t *
1236 dhcp_client_init (vlib_main_t * vm)
1238 dhcp_client_main_t *dcm = &dhcp_client_main;
1239 vlib_node_t *ip4_lookup_node;
1241 ip4_lookup_node = vlib_get_node_by_name (vm, (u8 *) "ip4-lookup");
1243 /* Should never happen... */
1244 if (ip4_lookup_node == 0)
1245 return clib_error_return (0, "ip4-lookup node not found");
1247 dcm->ip4_lookup_node_index = ip4_lookup_node->index;
1248 dcm->vlib_main = vm;
1249 dcm->vnet_main = vnet_get_main ();
1250 dcm->seed = (u32) clib_cpu_time_now ();
1252 dhcp_logger = vlib_log_register_class ("dhcp", "client");
1253 DHCP_INFO ("plugin initialized");
1258 VLIB_INIT_FUNCTION (dhcp_client_init);
1261 * fd.io coding-style-patch-verification: ON
1264 * eval: (c-set-style "gnu")