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 <vnet/dhcp/client.h>
17 #include <vnet/dhcp/dhcp_proxy.h>
18 #include <vnet/fib/fib_table.h>
20 dhcp_client_main_t dhcp_client_main;
21 static u8 *format_dhcp_client_state (u8 * s, va_list * va);
22 static vlib_node_registration_t dhcp_client_process_node;
24 #define foreach_dhcp_sent_packet_stat \
25 _(DISCOVER, "DHCP discover packets sent") \
26 _(OFFER, "DHCP offer packets sent") \
27 _(REQUEST, "DHCP request packets sent") \
28 _(ACK, "DHCP ack packets sent")
30 #define foreach_dhcp_error_counter \
31 _(NOT_FOR_US, "DHCP packets for other hosts, dropped") \
32 _(NAK, "DHCP nak packets received") \
33 _(NON_OFFER_DISCOVER, "DHCP non-offer packets in discover state") \
34 _(ODDBALL, "DHCP non-ack, non-offer packets received") \
35 _(BOUND, "DHCP bind success")
39 #define _(sym,str) DHCP_STAT_##sym,
40 foreach_dhcp_sent_packet_stat foreach_dhcp_error_counter
46 static char *dhcp_client_process_stat_strings[] = {
47 #define _(sym,string) string,
48 foreach_dhcp_sent_packet_stat foreach_dhcp_error_counter
50 "DHCP unknown packets sent",
55 dhcp_client_acquire_address (dhcp_client_main_t * dcm, dhcp_client_t * c)
58 * Install any/all info gleaned from dhcp, right here
60 ip4_add_del_interface_address (dcm->vlib_main, c->sw_if_index,
61 (void *) &c->leased_address,
62 c->subnet_mask_width, 0 /*is_del */ );
66 dhcp_client_release_address (dhcp_client_main_t * dcm, dhcp_client_t * c)
69 * Remove any/all info gleaned from dhcp, right here. Caller(s)
70 * have not wiped out the info yet.
73 ip4_add_del_interface_address (dcm->vlib_main, c->sw_if_index,
74 (void *) &c->leased_address,
75 c->subnet_mask_width, 1 /*is_del */ );
79 set_l2_rewrite (dhcp_client_main_t * dcm, dhcp_client_t * c)
81 /* Acquire the L2 rewrite string for the indicated sw_if_index */
82 c->l2_rewrite = vnet_build_rewrite_for_sw_interface (dcm->vnet_main,
88 void vl_api_rpc_call_main_thread (void *fp, u8 * data, u32 data_length);
91 dhcp_client_proc_callback (uword * client_index)
93 vlib_main_t *vm = vlib_get_main ();
94 ASSERT (vlib_get_thread_index () == 0);
95 vlib_process_signal_event (vm, dhcp_client_process_node.index,
96 EVENT_DHCP_CLIENT_WAKEUP, *client_index);
100 dhcp_client_addr_callback (dhcp_client_t * c)
102 dhcp_client_main_t *dcm = &dhcp_client_main;
104 /* disable the feature */
105 vnet_feature_enable_disable ("ip4-unicast",
106 "ip4-dhcp-client-detect",
107 c->sw_if_index, 0 /* disable */ , 0, 0);
108 c->client_detect_feature_enabled = 0;
110 /* if renewing the lease, the address and route have already been added */
111 if (c->state == DHCP_BOUND)
114 /* add the address to the interface */
115 dhcp_client_acquire_address (dcm, c);
118 * Configure default IP route:
120 if (c->router_address.as_u32)
122 fib_prefix_t all_0s = {
124 .fp_addr.ip4.as_u32 = 0x0,
125 .fp_proto = FIB_PROTOCOL_IP4,
127 ip46_address_t nh = {
128 .ip4 = c->router_address,
132 fib_table_entry_path_add (
133 fib_table_get_index_for_sw_if_index (
141 ~0, 1, NULL, // no label stack
142 FIB_ROUTE_PATH_FLAG_NONE);
147 * Call the user's event callback to report DHCP information
149 if (c->event_callback)
150 c->event_callback (c->client_index, c);
154 * dhcp_client_for_us - server-to-client callback.
155 * Called from proxy_node.c:dhcp_proxy_to_client_input().
156 * This function first decides that the packet in question is
157 * actually for the dhcp client code in case we're also acting as
158 * a dhcp proxy. Ay caramba, what a folly!
161 dhcp_client_for_us (u32 bi, vlib_buffer_t * b,
163 udp_header_t * udp, dhcp_header_t * dhcp)
165 dhcp_client_main_t *dcm = &dhcp_client_main;
166 vlib_main_t *vm = dcm->vlib_main;
169 f64 now = vlib_time_now (dcm->vlib_main);
170 u8 dhcp_message_type = 0;
174 * Doing dhcp client on this interface?
175 * Presumably we will always receive dhcp clnt for-us pkts on
176 * the interface that's asking for an address.
178 p = hash_get (dcm->client_by_sw_if_index,
179 vnet_buffer (b)->sw_if_index[VLIB_RX]);
183 c = pool_elt_at_index (dcm->clients, p[0]);
185 /* Mixing dhcp relay and dhcp proxy? DGMS... */
186 if (c->state == DHCP_BOUND && c->retry_count == 0)
189 /* Packet not for us? Turf it... */
190 if (memcmp (dhcp->client_hardware_address, c->client_hardware_address,
191 sizeof (c->client_hardware_address)))
193 vlib_node_increment_counter (vm, dhcp_client_process_node.index,
194 DHCP_STAT_NOT_FOR_US, 1);
198 /* parse through the packet, learn what we can */
199 if (dhcp->your_ip_address.as_u32)
200 c->leased_address.as_u32 = dhcp->your_ip_address.as_u32;
202 c->dhcp_server.as_u32 = dhcp->server_ip_address.as_u32;
204 o = (dhcp_option_t *) dhcp->options;
206 while (o->option != 0xFF /* end of options */ &&
207 (u8 *) o < (b->data + b->current_data + b->current_length))
211 case 53: /* dhcp message type */
212 dhcp_message_type = o->data[0];
215 case 51: /* lease time */
217 u32 lease_time_in_seconds =
218 clib_host_to_net_u32 (o->data_as_u32[0]);
219 // for debug: lease_time_in_seconds = 20; /*$$$$*/
220 c->lease_expires = now + (f64) lease_time_in_seconds;
221 c->lease_lifetime = lease_time_in_seconds;
222 /* Set a sensible default, in case we don't get opt 58 */
223 c->lease_renewal_interval = lease_time_in_seconds / 2;
227 case 58: /* lease renew time in seconds */
229 u32 lease_renew_time_in_seconds =
230 clib_host_to_net_u32 (o->data_as_u32[0]);
231 c->lease_renewal_interval = lease_renew_time_in_seconds;
235 case 54: /* dhcp server address */
236 c->dhcp_server.as_u32 = o->data_as_u32[0];
239 case 1: /* subnet mask */
241 u32 subnet_mask = clib_host_to_net_u32 (o->data_as_u32[0]);
242 c->subnet_mask_width = count_set_bits (subnet_mask);
245 case 3: /* router address */
247 u32 router_address = o->data_as_u32[0];
248 c->router_address.as_u32 = router_address;
251 case 6: /* domain server address */
253 vec_free (c->domain_server_address);
254 vec_validate (c->domain_server_address,
255 o->length / sizeof (ip4_address_t) - 1);
256 clib_memcpy (c->domain_server_address, o->data, o->length);
259 case 12: /* hostname */
261 /* Replace the existing hostname if necessary */
262 vec_free (c->hostname);
263 vec_validate (c->hostname, o->length - 1);
264 clib_memcpy (c->hostname, o->data, o->length);
268 /* $$$$ Your message in this space, parse more options */
273 o = (dhcp_option_t *) (((uword) o) + (o->length + 2));
279 if (dhcp_message_type != DHCP_PACKET_OFFER)
281 vlib_node_increment_counter (vm, dhcp_client_process_node.index,
282 DHCP_STAT_NON_OFFER_DISCOVER, 1);
283 c->next_transmit = now + 5.0;
287 /* Received an offer, go send a request */
288 c->state = DHCP_REQUEST;
290 c->next_transmit = 0; /* send right now... */
291 /* Poke the client process, which will send the request */
292 uword client_id = c - dcm->clients;
293 vl_api_rpc_call_main_thread (dhcp_client_proc_callback,
294 (u8 *) & client_id, sizeof (uword));
299 if (dhcp_message_type == DHCP_PACKET_NAK)
301 vlib_node_increment_counter (vm, dhcp_client_process_node.index,
303 /* Probably never happens in bound state, but anyhow... */
304 if (c->state == DHCP_BOUND)
306 ip4_add_del_interface_address (dcm->vlib_main, c->sw_if_index,
307 (void *) &c->leased_address,
308 c->subnet_mask_width,
310 vnet_feature_enable_disable ("ip4-unicast",
311 "ip4-dhcp-client-detect",
312 c->sw_if_index, 1 /* enable */ ,
314 c->client_detect_feature_enabled = 1;
316 /* Wipe out any memory of the address we had... */
317 c->state = DHCP_DISCOVER;
318 c->next_transmit = now;
320 c->leased_address.as_u32 = 0;
321 c->subnet_mask_width = 0;
322 c->router_address.as_u32 = 0;
323 c->lease_renewal_interval = 0;
324 c->dhcp_server.as_u32 = 0;
325 vec_free (c->domain_server_address);
329 if (dhcp_message_type != DHCP_PACKET_ACK &&
330 dhcp_message_type != DHCP_PACKET_OFFER)
332 vlib_node_increment_counter (vm, dhcp_client_process_node.index,
333 DHCP_STAT_NON_OFFER_DISCOVER, 1);
334 clib_warning ("sw_if_index %d state %U message type %d",
335 c->sw_if_index, format_dhcp_client_state,
336 c->state, dhcp_message_type);
337 c->next_transmit = now + 5.0;
340 /* OK, we own the address (etc), add to the routing table(s) */
341 vl_api_rpc_call_main_thread (dhcp_client_addr_callback,
342 (u8 *) c, sizeof (*c));
344 c->state = DHCP_BOUND;
346 c->next_transmit = now + (f64) c->lease_renewal_interval;
347 c->lease_expires = now + (f64) c->lease_lifetime;
348 vlib_node_increment_counter (vm, dhcp_client_process_node.index,
353 clib_warning ("client %d bogus state %d", c - dcm->clients, c->state);
357 /* drop the pkt, return 1 */
358 vlib_buffer_free (vm, &bi, 1);
363 send_dhcp_pkt (dhcp_client_main_t * dcm, dhcp_client_t * c,
364 dhcp_packet_type_t type, int is_broadcast)
366 vlib_main_t *vm = dcm->vlib_main;
367 vnet_main_t *vnm = dcm->vnet_main;
368 vnet_hw_interface_t *hw = vnet_get_sup_hw_interface (vnm, c->sw_if_index);
369 vnet_sw_interface_t *sup_sw
370 = vnet_get_sup_sw_interface (vnm, c->sw_if_index);
371 vnet_sw_interface_t *sw = vnet_get_sw_interface (vnm, c->sw_if_index);
380 u16 udp_length, ip_length;
383 /* Interface(s) down? */
384 if ((hw->flags & VNET_HW_INTERFACE_FLAG_LINK_UP) == 0)
386 if ((sup_sw->flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) == 0)
388 if ((sw->flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) == 0)
391 if (vlib_buffer_alloc (vm, &bi, 1) != 1)
393 clib_warning ("buffer allocation failure");
394 c->next_transmit = 0;
398 /* Build a dhcpv4 pkt from whole cloth */
399 b = vlib_get_buffer (vm, bi);
401 ASSERT (b->current_data == 0);
403 vnet_buffer (b)->sw_if_index[VLIB_RX] = c->sw_if_index;
406 f = vlib_get_frame_to_node (vm, hw->output_node_index);
407 vnet_buffer (b)->sw_if_index[VLIB_TX] = c->sw_if_index;
408 clib_memcpy (b->data, c->l2_rewrite, vec_len (c->l2_rewrite));
410 (((u8 *) vlib_buffer_get_current (b)) + vec_len (c->l2_rewrite));
414 f = vlib_get_frame_to_node (vm, ip4_lookup_node.index);
415 vnet_buffer (b)->sw_if_index[VLIB_TX] = ~0; /* use interface VRF */
416 ip = vlib_buffer_get_current (b);
419 /* Enqueue the packet right now */
420 to_next = vlib_frame_vector_args (f);
425 vlib_put_frame_to_node (vm, hw->output_node_index, f);
427 vlib_put_frame_to_node (vm, ip4_lookup_node.index, f);
429 udp = (udp_header_t *) (ip + 1);
430 dhcp = (dhcp_header_t *) (udp + 1);
432 /* $$$ optimize, maybe */
433 clib_memset (ip, 0, sizeof (*ip) + sizeof (*udp) + sizeof (*dhcp));
435 ip->ip_version_and_header_length = 0x45;
437 ip->protocol = IP_PROTOCOL_UDP;
441 /* src = 0.0.0.0, dst = 255.255.255.255 */
442 ip->dst_address.as_u32 = ~0;
446 /* Renewing an active lease, plain old ip4 src/dst */
447 ip->src_address.as_u32 = c->leased_address.as_u32;
448 ip->dst_address.as_u32 = c->dhcp_server.as_u32;
451 udp->src_port = clib_host_to_net_u16 (UDP_DST_PORT_dhcp_to_client);
452 udp->dst_port = clib_host_to_net_u16 (UDP_DST_PORT_dhcp_to_server);
454 /* Send the interface MAC address */
455 clib_memcpy (dhcp->client_hardware_address, c->l2_rewrite + 6, 6);
457 /* And remember it for rx-packet-for-us checking */
458 clib_memcpy (c->client_hardware_address, dhcp->client_hardware_address,
459 sizeof (c->client_hardware_address));
461 /* Lease renewal, set up client_ip_address */
462 if (is_broadcast == 0)
463 dhcp->client_ip_address.as_u32 = c->leased_address.as_u32;
465 dhcp->opcode = 1; /* request, all we send */
466 dhcp->hardware_type = 1; /* ethernet */
467 dhcp->hardware_address_length = 6;
468 dhcp->transaction_identifier = c->transaction_id;
470 clib_host_to_net_u16 (is_broadcast && c->set_broadcast_flag ?
471 DHCP_FLAG_BROADCAST : 0);
472 dhcp->magic_cookie.as_u32 = DHCP_MAGIC;
474 o = (dhcp_option_t *) dhcp->options;
476 /* Send option 53, the DHCP message type */
477 o->option = DHCP_PACKET_OPTION_MSG_TYPE;
480 o = (dhcp_option_t *) (((uword) o) + (o->length + 2));
482 /* Send option 57, max msg length */
483 if (0 /* not needed, apparently */ )
488 u16 *o2 = (u16 *) o->data;
489 *o2 = clib_host_to_net_u16 (1152);
490 o = (dhcp_option_t *) (((uword) o) + (o->length + 2));
495 * If server ip address is available with non-zero value,
496 * option 54 (DHCP Server Identifier) is sent.
498 if (c->dhcp_server.as_u32)
502 clib_memcpy (o->data, &c->dhcp_server.as_u32, 4);
503 o = (dhcp_option_t *) (((uword) o) + (o->length + 2));
506 /* send option 50, requested IP address */
507 if (c->leased_address.as_u32)
511 clib_memcpy (o->data, &c->leased_address.as_u32, 4);
512 o = (dhcp_option_t *) (((uword) o) + (o->length + 2));
515 /* send option 12, host name */
516 if (vec_len (c->hostname))
519 o->length = vec_len (c->hostname);
520 clib_memcpy (o->data, c->hostname, vec_len (c->hostname));
521 o = (dhcp_option_t *) (((uword) o) + (o->length + 2));
524 /* send option 61, client_id */
525 if (vec_len (c->client_identifier))
528 o->length = vec_len (c->client_identifier);
529 clib_memcpy (o->data, c->client_identifier,
530 vec_len (c->client_identifier));
531 o = (dhcp_option_t *) (((uword) o) + (o->length + 2));
534 /* $$ maybe send the client s/w version if anyone cares */
537 * send option 55, parameter request list
538 * The current list - see below, matches the Linux dhcp client's list
539 * Any specific dhcp server config and/or dhcp server may or may
540 * not yield specific options.
543 o->length = vec_len (c->option_55_data);
544 clib_memcpy (o->data, c->option_55_data, vec_len (c->option_55_data));
545 o = (dhcp_option_t *) (((uword) o) + (o->length + 2));
552 b->current_length = ((u8 *) o) - b->data;
554 /* fix ip length, checksum and udp length */
555 ip_length = vlib_buffer_length_in_chain (vm, b);
557 ip_length -= vec_len (c->l2_rewrite);
559 ip->length = clib_host_to_net_u16 (ip_length);
560 ip->checksum = ip4_header_checksum (ip);
562 udp_length = ip_length - (sizeof (*ip));
563 udp->length = clib_host_to_net_u16 (udp_length);
567 #define _(a,b) case DHCP_PACKET_##a: {counter_index = DHCP_STAT_##a; break;}
568 foreach_dhcp_sent_packet_stat
571 counter_index = DHCP_STAT_UNKNOWN;
575 vlib_node_increment_counter (vm, dhcp_client_process_node.index,
580 dhcp_discover_state (dhcp_client_main_t * dcm, dhcp_client_t * c, f64 now)
583 * State machine "DISCOVER" state. Send a dhcp discover packet,
584 * eventually back off the retry rate.
587 if (c->client_detect_feature_enabled == 0)
589 vnet_feature_enable_disable ("ip4-unicast",
590 "ip4-dhcp-client-detect",
591 c->sw_if_index, 1 /* enable */ , 0, 0);
592 c->client_detect_feature_enabled = 1;
595 send_dhcp_pkt (dcm, c, DHCP_PACKET_DISCOVER, 1 /* is_broadcast */ );
598 if (c->retry_count > 10)
599 c->next_transmit = now + 5.0;
601 c->next_transmit = now + 1.0;
606 dhcp_request_state (dhcp_client_main_t * dcm, dhcp_client_t * c, f64 now)
609 * State machine "REQUEST" state. Send a dhcp request packet,
610 * eventually drop back to the discover state.
612 send_dhcp_pkt (dcm, c, DHCP_PACKET_REQUEST, 1 /* is_broadcast */ );
615 if (c->retry_count > 7 /* lucky you */ )
617 c->state = DHCP_DISCOVER;
618 c->next_transmit = now;
622 c->next_transmit = now + 1.0;
627 dhcp_bound_state (dhcp_client_main_t * dcm, dhcp_client_t * c, f64 now)
630 * State machine "BOUND" state. Send a dhcp request packet to renew
632 * Eventually, when the lease expires, forget the dhcp data
633 * and go back to the stone age.
637 * We disable the client detect feature when we bind a
638 * DHCP address. Turn it back on again on first renew attempt.
639 * Otherwise, if the DHCP server replies we'll never see it.
641 if (c->client_detect_feature_enabled == 0)
643 vnet_feature_enable_disable ("ip4-unicast",
644 "ip4-dhcp-client-detect",
645 c->sw_if_index, 1 /* enable */ , 0, 0);
646 c->client_detect_feature_enabled = 1;
649 send_dhcp_pkt (dcm, c, DHCP_PACKET_REQUEST, 0 /* is_broadcast */ );
652 if (c->retry_count > 10)
653 c->next_transmit = now + 5.0;
655 c->next_transmit = now + 1.0;
657 if (now > c->lease_expires)
659 /* Remove the default route */
660 if (c->router_address.as_u32)
662 fib_prefix_t all_0s = {
664 .fp_addr.ip4.as_u32 = 0x0,
665 .fp_proto = FIB_PROTOCOL_IP4,
667 ip46_address_t nh = {
668 .ip4 = c->router_address,
671 fib_table_entry_path_remove (fib_table_get_index_for_sw_if_index
672 (FIB_PROTOCOL_IP4, c->sw_if_index),
673 &all_0s, FIB_SOURCE_DHCP,
674 DPO_PROTO_IP4, &nh, c->sw_if_index, ~0,
675 1, FIB_ROUTE_PATH_FLAG_NONE);
677 /* Remove the interface address */
678 dhcp_client_release_address (dcm, c);
679 c->state = DHCP_DISCOVER;
680 c->next_transmit = now;
682 /* Wipe out any memory of the address we had... */
683 c->leased_address.as_u32 = 0;
684 c->subnet_mask_width = 0;
685 c->router_address.as_u32 = 0;
686 c->lease_renewal_interval = 0;
687 c->dhcp_server.as_u32 = 0;
694 dhcp_client_sm (f64 now, f64 timeout, uword pool_index)
696 dhcp_client_main_t *dcm = &dhcp_client_main;
699 /* deleted, pooched, yadda yadda yadda */
700 if (pool_is_free_index (dcm->clients, pool_index))
703 c = pool_elt_at_index (dcm->clients, pool_index);
705 /* Time for us to do something with this client? */
706 if (now < c->next_transmit)
712 case DHCP_DISCOVER: /* send a discover */
713 if (dhcp_discover_state (dcm, c, now))
717 case DHCP_REQUEST: /* send a request */
718 if (dhcp_request_state (dcm, c, now))
722 case DHCP_BOUND: /* bound, renew needed? */
723 if (dhcp_bound_state (dcm, c, now))
728 clib_warning ("dhcp client %d bogus state %d",
729 c - dcm->clients, c->state);
733 if (c->next_transmit < now + timeout)
734 return c->next_transmit - now;
740 dhcp_client_process (vlib_main_t * vm,
741 vlib_node_runtime_t * rt, vlib_frame_t * f)
746 uword *event_data = 0;
747 dhcp_client_main_t *dcm = &dhcp_client_main;
753 vlib_process_wait_for_event_or_clock (vm, timeout);
755 event_type = vlib_process_get_events (vm, &event_data);
757 now = vlib_time_now (vm);
761 case EVENT_DHCP_CLIENT_WAKEUP:
762 for (i = 0; i < vec_len (event_data); i++)
763 timeout = dhcp_client_sm (now, timeout, event_data[i]);
768 pool_foreach (c, dcm->clients,
770 timeout = dhcp_client_sm (now, timeout,
771 (uword) (c - dcm->clients));
774 if (pool_elts (dcm->clients) == 0)
779 vec_reset_length (event_data);
787 VLIB_REGISTER_NODE (dhcp_client_process_node,static) = {
788 .function = dhcp_client_process,
789 .type = VLIB_NODE_TYPE_PROCESS,
790 .name = "dhcp-client-process",
791 .process_log2_n_stack_bytes = 16,
792 .n_errors = ARRAY_LEN(dhcp_client_process_stat_strings),
793 .error_strings = dhcp_client_process_stat_strings,
798 format_dhcp_client_state (u8 * s, va_list * va)
800 dhcp_client_state_t state = va_arg (*va, dhcp_client_state_t);
801 char *str = "BOGUS!";
809 foreach_dhcp_client_state;
815 s = format (s, "%s", str);
820 format_dhcp_client (u8 * s, va_list * va)
822 dhcp_client_main_t *dcm = va_arg (*va, dhcp_client_main_t *);
823 dhcp_client_t *c = va_arg (*va, dhcp_client_t *);
824 int verbose = va_arg (*va, int);
827 s = format (s, "[%d] %U state %U ", c - dcm->clients,
828 format_vnet_sw_if_index_name, dcm->vnet_main, c->sw_if_index,
829 format_dhcp_client_state, c->state);
831 if (c->leased_address.as_u32)
833 s = format (s, "addr %U/%d gw %U\n",
834 format_ip4_address, &c->leased_address,
835 c->subnet_mask_width, format_ip4_address,
838 vec_foreach (addr, c->domain_server_address)
839 s = format (s, "dns %U ", format_ip4_address, addr);
843 s = format (s, "no address\n");
848 s = format (s, "retry count %d, next xmt %.2f",
849 c->retry_count, c->next_transmit);
854 static clib_error_t *
855 show_dhcp_client_command_fn (vlib_main_t * vm,
856 unformat_input_t * input,
857 vlib_cli_command_t * cmd)
859 dhcp_client_main_t *dcm = &dhcp_client_main;
862 u32 sw_if_index = ~0;
865 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
867 if (unformat (input, "intfc %U",
868 unformat_vnet_sw_interface, dcm->vnet_main, &sw_if_index))
870 else if (unformat (input, "verbose"))
876 if (sw_if_index != ~0)
878 p = hash_get (dcm->client_by_sw_if_index, sw_if_index);
880 return clib_error_return (0, "dhcp client not configured");
881 c = pool_elt_at_index (dcm->clients, p[0]);
882 vlib_cli_output (vm, "%U", format_dhcp_client, dcm, c, verbose);
887 pool_foreach (c, dcm->clients,
889 vlib_cli_output (vm, "%U",
890 format_dhcp_client, dcm,
899 VLIB_CLI_COMMAND (show_dhcp_client_command, static) = {
900 .path = "show dhcp client",
901 .short_help = "show dhcp client [intfc <intfc>][verbose]",
902 .function = show_dhcp_client_command_fn,
908 dhcp_client_add_del (dhcp_client_add_del_args_t * a)
910 dhcp_client_main_t *dcm = &dhcp_client_main;
911 vlib_main_t *vm = dcm->vlib_main;
914 fib_prefix_t all_0s = {
916 .fp_addr.ip4.as_u32 = 0x0,
917 .fp_proto = FIB_PROTOCOL_IP4,
920 p = hash_get (dcm->client_by_sw_if_index, a->sw_if_index);
922 if ((p && a->is_add) || (!p && a->is_add == 0))
923 return VNET_API_ERROR_INVALID_VALUE;
927 dhcp_maybe_register_udp_ports (DHCP_PORT_REG_CLIENT);
928 pool_get (dcm->clients, c);
929 clib_memset (c, 0, sizeof (*c));
930 c->state = DHCP_DISCOVER;
931 c->sw_if_index = a->sw_if_index;
932 c->client_index = a->client_index;
934 c->event_callback = a->event_callback;
935 c->option_55_data = a->option_55_data;
936 c->hostname = a->hostname;
937 c->client_identifier = a->client_identifier;
938 c->set_broadcast_flag = a->set_broadcast_flag;
941 c->transaction_id = random_u32 (&dcm->seed);
943 while (c->transaction_id == 0);
944 set_l2_rewrite (dcm, c);
945 hash_set (dcm->client_by_sw_if_index, a->sw_if_index, c - dcm->clients);
948 * In order to accept any OFFER, whether broadcasted or unicasted, we
949 * need to configure the dhcp-client-detect feature as an input feature
950 * so the DHCP OFFER is sent to the ip4-local node. Without this a
951 * broadcasted OFFER hits the 255.255.255.255/32 address and a unicast
952 * hits 0.0.0.0/0 both of which default to drop and the latter may forward
953 * of box - not what we want. Nor to we want to change these route for
954 * all interfaces in this table
956 vnet_feature_enable_disable ("ip4-unicast",
957 "ip4-dhcp-client-detect",
958 c->sw_if_index, 1 /* enable */ , 0, 0);
959 c->client_detect_feature_enabled = 1;
961 vlib_process_signal_event (vm, dhcp_client_process_node.index,
962 EVENT_DHCP_CLIENT_WAKEUP, c - dcm->clients);
966 c = pool_elt_at_index (dcm->clients, p[0]);
968 if (c->router_address.as_u32)
970 ip46_address_t nh = {
971 .ip4 = c->router_address,
974 fib_table_entry_path_remove (fib_table_get_index_for_sw_if_index
975 (FIB_PROTOCOL_IP4, c->sw_if_index),
976 &all_0s, FIB_SOURCE_DHCP,
977 DPO_PROTO_IP4, &nh, c->sw_if_index, ~0,
978 1, FIB_ROUTE_PATH_FLAG_NONE);
980 dhcp_client_release_address (dcm, c);
982 vec_free (c->domain_server_address);
983 vec_free (c->option_55_data);
984 vec_free (c->hostname);
985 vec_free (c->client_identifier);
986 vec_free (c->l2_rewrite);
987 hash_unset (dcm->client_by_sw_if_index, c->sw_if_index);
988 pool_put (dcm->clients, c);
994 dhcp_client_config (u32 is_add,
1000 dhcp_event_cb_t event_callback,
1001 u8 set_broadcast_flag, u32 pid)
1003 dhcp_client_add_del_args_t _a, *a = &_a;
1006 clib_memset (a, 0, sizeof (*a));
1008 a->sw_if_index = sw_if_index;
1009 a->client_index = client_index;
1011 a->event_callback = event_callback;
1012 a->set_broadcast_flag = set_broadcast_flag;
1013 vec_validate (a->hostname, strlen ((char *) hostname) - 1);
1014 strncpy ((char *) a->hostname, (char *) hostname, vec_len (a->hostname));
1015 vec_validate (a->client_identifier, strlen ((char *) client_id) - 1);
1016 strncpy ((char *) a->client_identifier, (char *) client_id,
1017 vec_len (a->client_identifier));
1020 * Option 55 request list. These data precisely match
1021 * the Ubuntu dhcp client. YMMV.
1025 vec_add1 (a->option_55_data, 1);
1026 /* Broadcast address */
1027 vec_add1 (a->option_55_data, 28);
1029 vec_add1 (a->option_55_data, 2);
1031 vec_add1 (a->option_55_data, 3);
1033 vec_add1 (a->option_55_data, 15);
1035 vec_add1 (a->option_55_data, 6);
1037 vec_add1 (a->option_55_data, 119);
1039 vec_add1 (a->option_55_data, 12);
1040 /* NetBIOS name server */
1041 vec_add1 (a->option_55_data, 44);
1043 vec_add1 (a->option_55_data, 47);
1045 vec_add1 (a->option_55_data, 26);
1046 /* Classless static route */
1047 vec_add1 (a->option_55_data, 121);
1049 vec_add1 (a->option_55_data, 42);
1051 rv = dhcp_client_add_del (a);
1058 case VNET_API_ERROR_INVALID_VALUE:
1060 vec_free (a->hostname);
1061 vec_free (a->client_identifier);
1062 vec_free (a->option_55_data);
1065 clib_warning ("dhcp client already enabled on intf_idx %d",
1068 clib_warning ("dhcp client not enabled on on intf_idx %d",
1073 clib_warning ("dhcp_client_add_del returned %d", rv);
1080 dhcp_client_walk (dhcp_client_walk_cb_t cb, void *ctx)
1082 dhcp_client_main_t *dcm = &dhcp_client_main;
1086 pool_foreach (c, dcm->clients,
1095 static clib_error_t *
1096 dhcp_client_set_command_fn (vlib_main_t * vm,
1097 unformat_input_t * input,
1098 vlib_cli_command_t * cmd)
1101 dhcp_client_main_t *dcm = &dhcp_client_main;
1104 u8 sw_if_index_set = 0;
1105 u8 set_broadcast_flag = 1;
1107 dhcp_client_add_del_args_t _a, *a = &_a;
1110 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1112 if (unformat (input, "intfc %U",
1113 unformat_vnet_sw_interface, dcm->vnet_main, &sw_if_index))
1114 sw_if_index_set = 1;
1115 else if (unformat (input, "hostname %v", &hostname))
1117 else if (unformat (input, "del"))
1119 else if (unformat (input, "broadcast", &set_broadcast_flag))
1125 if (sw_if_index_set == 0)
1126 return clib_error_return (0, "interface not specified");
1128 clib_memset (a, 0, sizeof (*a));
1130 a->sw_if_index = sw_if_index;
1131 a->hostname = hostname;
1132 a->client_identifier = format (0, "vpe 1.0%c", 0);
1133 a->set_broadcast_flag = set_broadcast_flag;
1136 * Option 55 request list. These data precisely match
1137 * the Ubuntu dhcp client. YMMV.
1141 vec_add1 (a->option_55_data, 1);
1142 /* Broadcast address */
1143 vec_add1 (a->option_55_data, 28);
1145 vec_add1 (a->option_55_data, 2);
1147 vec_add1 (a->option_55_data, 3);
1149 vec_add1 (a->option_55_data, 15);
1151 vec_add1 (a->option_55_data, 6);
1153 vec_add1 (a->option_55_data, 119);
1155 vec_add1 (a->option_55_data, 12);
1156 /* NetBIOS name server */
1157 vec_add1 (a->option_55_data, 44);
1159 vec_add1 (a->option_55_data, 47);
1161 vec_add1 (a->option_55_data, 26);
1162 /* Classless static route */
1163 vec_add1 (a->option_55_data, 121);
1165 vec_add1 (a->option_55_data, 42);
1167 rv = dhcp_client_add_del (a);
1174 case VNET_API_ERROR_INVALID_VALUE:
1176 vec_free (a->hostname);
1177 vec_free (a->client_identifier);
1178 vec_free (a->option_55_data);
1180 return clib_error_return (0, "dhcp client already enabled on %U",
1181 format_vnet_sw_if_index_name,
1182 dcm->vnet_main, sw_if_index);
1184 return clib_error_return (0, "dhcp client not enabled on %U",
1185 format_vnet_sw_if_index_name,
1186 dcm->vnet_main, sw_if_index);
1190 vlib_cli_output (vm, "dhcp_client_add_del returned %d", rv);
1197 VLIB_CLI_COMMAND (dhcp_client_set_command, static) = {
1198 .path = "set dhcp client",
1199 .short_help = "set dhcp client [del] intfc <interface> [hostname <name>]",
1200 .function = dhcp_client_set_command_fn,
1204 static clib_error_t *
1205 dhcp_client_init (vlib_main_t * vm)
1207 dhcp_client_main_t *dcm = &dhcp_client_main;
1209 dcm->vlib_main = vm;
1210 dcm->vnet_main = vnet_get_main ();
1211 dcm->seed = 0xdeaddabe;
1215 VLIB_INIT_FUNCTION (dhcp_client_init);
1218 * fd.io coding-style-patch-verification: ON
1221 * eval: (c-set-style "gnu")