2 *------------------------------------------------------------------
3 * dhcp_api.c - dhcp api
5 * Copyright (c) 2016 Cisco and/or its affiliates.
6 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at:
10 * http://www.apache.org/licenses/LICENSE-2.0
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
17 *------------------------------------------------------------------
20 #include <vnet/vnet.h>
21 #include <vlibmemory/api.h>
23 #include <vnet/interface.h>
24 #include <vnet/api_errno.h>
25 #include <vnet/dhcp/dhcp_proxy.h>
26 #include <vnet/dhcp/client.h>
27 #include <vnet/dhcp/dhcp6_pd_client_dp.h>
28 #include <vnet/dhcp/dhcp6_ia_na_client_dp.h>
29 #include <vnet/dhcp/dhcp6_client_common_dp.h>
30 #include <vnet/fib/fib_table.h>
31 #include <vnet/ip/ip_types_api.h>
33 #include <vnet/vnet_msg_enum.h>
35 #define vl_typedefs /* define message structures */
36 #include <vnet/vnet_all_api_h.h>
39 #define vl_endianfun /* define message structures */
40 #include <vnet/vnet_all_api_h.h>
43 /* instantiate all the print functions we know about */
44 #define vl_print(handle, ...) vlib_cli_output (handle, __VA_ARGS__)
46 #include <vnet/vnet_all_api_h.h>
49 #include <vlibapi/api_helper_macros.h>
51 #define foreach_vpe_api_msg \
52 _(DHCP_PROXY_CONFIG,dhcp_proxy_config) \
53 _(DHCP_PROXY_DUMP,dhcp_proxy_dump) \
54 _(DHCP_PROXY_SET_VSS,dhcp_proxy_set_vss) \
55 _(DHCP_CLIENT_CONFIG, dhcp_client_config) \
56 _(DHCP_CLIENT_DUMP, dhcp_client_dump) \
57 _(WANT_DHCP6_PD_REPLY_EVENTS, want_dhcp6_pd_reply_events) \
58 _(DHCP6_PD_SEND_CLIENT_MESSAGE, dhcp6_pd_send_client_message) \
59 _(WANT_DHCP6_REPLY_EVENTS, want_dhcp6_reply_events) \
60 _(DHCP6_SEND_CLIENT_MESSAGE, dhcp6_send_client_message) \
61 _(DHCP6_CLIENTS_ENABLE_DISABLE, dhcp6_clients_enable_disable) \
62 _(DHCP6_DUID_LL_SET, dhcp6_duid_ll_set)
66 vl_api_dhcp_proxy_set_vss_t_handler (vl_api_dhcp_proxy_set_vss_t * mp)
68 vl_api_dhcp_proxy_set_vss_reply_t *rmp;
72 mp->vpn_ascii_id[sizeof (mp->vpn_ascii_id) - 1] = 0;
73 vpn_ascii_id = format (0, "%s", mp->vpn_ascii_id);
75 dhcp_proxy_set_vss ((mp->is_ipv6 ? FIB_PROTOCOL_IP6 : FIB_PROTOCOL_IP4),
76 ntohl (mp->tbl_id), ntohl (mp->vss_type),
77 vpn_ascii_id, ntohl (mp->oui), ntohl (mp->vpn_index),
80 REPLY_MACRO (VL_API_DHCP_PROXY_SET_VSS_REPLY);
84 static void vl_api_dhcp_proxy_config_t_handler
85 (vl_api_dhcp_proxy_config_t * mp)
87 vl_api_dhcp_proxy_set_vss_reply_t *rmp;
88 ip46_address_t src, server;
91 if (mp->dhcp_src_address.af != mp->dhcp_server.af)
93 rv = VNET_API_ERROR_INVALID_ARGUMENT;
97 ip_address_decode (&mp->dhcp_src_address, &src);
98 ip_address_decode (&mp->dhcp_server, &server);
100 if (mp->dhcp_src_address.af == ADDRESS_IP4)
102 rv = dhcp4_proxy_set_server (&server,
104 (u32) ntohl (mp->rx_vrf_id),
105 (u32) ntohl (mp->server_vrf_id),
106 (int) (mp->is_add == 0));
110 rv = dhcp6_proxy_set_server (&server,
112 (u32) ntohl (mp->rx_vrf_id),
113 (u32) ntohl (mp->server_vrf_id),
114 (int) (mp->is_add == 0));
118 REPLY_MACRO (VL_API_DHCP_PROXY_CONFIG_REPLY);
122 vl_api_dhcp_proxy_dump_t_handler (vl_api_dhcp_proxy_dump_t * mp)
124 vl_api_registration_t *reg;
126 reg = vl_api_client_index_to_registration (mp->client_index);
130 dhcp_proxy_dump ((mp->is_ip6 == 1 ?
131 FIB_PROTOCOL_IP6 : FIB_PROTOCOL_IP4), reg, mp->context);
135 dhcp_send_details (fib_protocol_t proto,
136 void *opaque, u32 context, dhcp_proxy_t * proxy)
138 vl_api_dhcp_proxy_details_t *mp;
139 vl_api_registration_t *reg = opaque;
140 vl_api_dhcp_server_t *v_server;
141 dhcp_server_t *server;
147 count = vec_len (proxy->dhcp_servers);
148 n = sizeof (*mp) + (count * sizeof (vl_api_dhcp_server_t));
149 mp = vl_msg_api_alloc (n);
152 clib_memset (mp, 0, n);
153 mp->_vl_msg_id = ntohs (VL_API_DHCP_PROXY_DETAILS);
154 mp->context = context;
157 mp->is_ipv6 = (proto == FIB_PROTOCOL_IP6);
159 htonl (dhcp_proxy_rx_table_get_table_id (proto, proxy->rx_fib_index));
161 vss = dhcp_get_vss_info (&dhcp_proxy_main, proxy->rx_fib_index, proto);
165 mp->vss_type = ntohl (vss->vss_type);
166 if (vss->vss_type == VSS_TYPE_ASCII)
168 u32 id_len = vec_len (vss->vpn_ascii_id);
169 clib_memcpy (mp->vss_vpn_ascii_id, vss->vpn_ascii_id, id_len);
171 else if (vss->vss_type == VSS_TYPE_VPN_ID)
173 u32 oui = ((u32) vss->vpn_id[0] << 16) + ((u32) vss->vpn_id[1] << 8)
174 + ((u32) vss->vpn_id[2]);
175 u32 fib_id = ((u32) vss->vpn_id[3] << 24) +
176 ((u32) vss->vpn_id[4] << 16) + ((u32) vss->vpn_id[5] << 8) +
177 ((u32) vss->vpn_id[6]);
178 mp->vss_oui = htonl (oui);
179 mp->vss_fib_id = htonl (fib_id);
183 mp->vss_type = VSS_TYPE_INVALID;
185 vec_foreach_index (count, proxy->dhcp_servers)
187 server = &proxy->dhcp_servers[count];
188 v_server = &mp->servers[count];
190 s_fib = fib_table_get (server->server_fib_index, proto);
192 v_server->server_vrf_id = htonl (s_fib->ft_table_id);
196 memcpy (&v_server->dhcp_server.un, &server->dhcp_server.ip6, 16);
200 /* put the address in the first bytes */
201 memcpy (&v_server->dhcp_server.un, &server->dhcp_server.ip4, 4);
207 memcpy (&mp->dhcp_src_address.un, &proxy->dhcp_src_address.ip6, 16);
211 /* put the address in the first bytes */
212 memcpy (&mp->dhcp_src_address.un, &proxy->dhcp_src_address.ip4, 4);
214 vl_api_send_msg (reg, (u8 *) mp);
218 dhcp_client_lease_encode (vl_api_dhcp_lease_t * lease,
219 const dhcp_client_t * client)
224 lease->is_ipv6 = 0; // only support IPv6 clients
225 lease->sw_if_index = ntohl (client->sw_if_index);
226 lease->state = ntohl (client->state);
227 len = clib_min (sizeof (lease->hostname) - 1, vec_len (client->hostname));
228 clib_memcpy (&lease->hostname, client->hostname, len);
229 lease->hostname[len] = 0;
231 lease->mask_width = client->subnet_mask_width;
232 clib_memcpy (&lease->host_address.un, (u8 *) & client->leased_address,
233 sizeof (ip4_address_t));
234 clib_memcpy (&lease->router_address.un, (u8 *) & client->router_address,
235 sizeof (ip4_address_t));
237 lease->count = vec_len (client->domain_server_address);
238 for (i = 0; i < lease->count; i++)
239 clib_memcpy (&lease->domain_server[i].address,
240 (u8 *) & client->domain_server_address[i],
241 sizeof (ip4_address_t));
243 clib_memcpy (&lease->host_mac[0], client->client_hardware_address, 6);
247 dhcp_client_data_encode (vl_api_dhcp_client_t * vclient,
248 const dhcp_client_t * client)
252 vclient->sw_if_index = ntohl (client->sw_if_index);
253 len = clib_min (sizeof (vclient->hostname) - 1, vec_len (client->hostname));
254 clib_memcpy (&vclient->hostname, client->hostname, len);
255 vclient->hostname[len] = 0;
257 len = clib_min (sizeof (vclient->id) - 1,
258 vec_len (client->client_identifier));
259 clib_memcpy (&vclient->id, client->client_identifier, len);
260 vclient->id[len] = 0;
262 if (NULL != client->event_callback)
263 vclient->want_dhcp_event = 1;
265 vclient->want_dhcp_event = 0;
266 vclient->set_broadcast_flag = client->set_broadcast_flag;
267 vclient->dscp = ip_dscp_encode (client->dscp);
268 vclient->pid = client->pid;
272 dhcp_compl_event_callback (u32 client_index, const dhcp_client_t * client)
274 vl_api_registration_t *reg;
275 vl_api_dhcp_compl_event_t *mp;
277 reg = vl_api_client_index_to_registration (client_index);
281 mp = vl_msg_api_alloc (sizeof (*mp));
282 mp->client_index = client_index;
283 mp->pid = client->pid;
284 dhcp_client_lease_encode (&mp->lease, client);
286 mp->_vl_msg_id = ntohs (VL_API_DHCP_COMPL_EVENT);
288 vl_api_send_msg (reg, (u8 *) mp);
291 static void vl_api_dhcp_client_config_t_handler
292 (vl_api_dhcp_client_config_t * mp)
294 vlib_main_t *vm = vlib_get_main ();
295 vl_api_dhcp_client_config_reply_t *rmp;
300 VALIDATE_SW_IF_INDEX (&(mp->client));
302 sw_if_index = ntohl (mp->client.sw_if_index);
303 dscp = ip_dscp_decode (mp->client.dscp);
305 rv = dhcp_client_config (mp->is_add,
311 (mp->client.want_dhcp_event ?
312 dhcp_compl_event_callback :
314 mp->client.set_broadcast_flag,
315 dscp, mp->client.pid);
317 BAD_SW_IF_INDEX_LABEL;
318 REPLY_MACRO (VL_API_DHCP_CLIENT_CONFIG_REPLY);
321 typedef struct dhcp_client_send_walk_ctx_t_
323 vl_api_registration_t *reg;
325 } dhcp_client_send_walk_ctx_t;
328 send_dhcp_client_entry (const dhcp_client_t * client, void *arg)
330 dhcp_client_send_walk_ctx_t *ctx;
331 vl_api_dhcp_client_details_t *mp;
335 mp = vl_msg_api_alloc (sizeof (*mp));
336 clib_memset (mp, 0, sizeof (*mp));
338 mp->_vl_msg_id = ntohs (VL_API_DHCP_CLIENT_DETAILS);
339 mp->context = ctx->context;
341 dhcp_client_data_encode (&mp->client, client);
342 dhcp_client_lease_encode (&mp->lease, client);
344 vl_api_send_msg (ctx->reg, (u8 *) mp);
350 vl_api_dhcp_client_dump_t_handler (vl_api_dhcp_client_dump_t * mp)
352 vl_api_registration_t *reg;
354 reg = vl_api_client_index_to_registration (mp->client_index);
358 dhcp_client_send_walk_ctx_t ctx = {
360 .context = mp->context,
362 dhcp_client_walk (send_dhcp_client_entry, &ctx);
367 * Add vpe's API message handlers to the table.
368 * vlib has already mapped shared memory and
369 * added the client registration handlers.
370 * See .../vlib-api/vlibmemory/memclnt_vlib.c:memclnt_process()
372 #define vl_msg_name_crc_list
373 #include <vnet/vnet_all_api_h.h>
374 #undef vl_msg_name_crc_list
377 setup_message_id_table (api_main_t * am)
379 #define _(id,n,crc) vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id);
380 foreach_vl_msg_name_crc_dhcp;
384 static clib_error_t *
385 dhcp_api_hookup (vlib_main_t * vm)
387 api_main_t *am = &api_main;
390 vl_msg_api_set_handlers(VL_API_##N, #n, \
391 vl_api_##n##_t_handler, \
393 vl_api_##n##_t_endian, \
394 vl_api_##n##_t_print, \
395 sizeof(vl_api_##n##_t), 1);
400 * Set up the (msg_name, crc, message-id) table
402 setup_message_id_table (am);
404 dhcp6_pd_set_publisher_node (dhcp6_pd_reply_process_node.index,
405 DHCP6_PD_DP_REPLY_REPORT);
406 dhcp6_set_publisher_node (dhcp6_reply_process_node.index,
407 DHCP6_DP_REPLY_REPORT);
412 VLIB_API_INIT_FUNCTION (dhcp_api_hookup);
415 * fd.io coding-style-patch-verification: ON
418 * eval: (c-set-style "gnu")