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>
32 #include <vnet/vnet_msg_enum.h>
34 #define vl_typedefs /* define message structures */
35 #include <vnet/vnet_all_api_h.h>
38 #define vl_endianfun /* define message structures */
39 #include <vnet/vnet_all_api_h.h>
42 /* instantiate all the print functions we know about */
43 #define vl_print(handle, ...) vlib_cli_output (handle, __VA_ARGS__)
45 #include <vnet/vnet_all_api_h.h>
48 #include <vlibapi/api_helper_macros.h>
50 #define foreach_vpe_api_msg \
51 _(DHCP_PROXY_CONFIG,dhcp_proxy_config) \
52 _(DHCP_PROXY_DUMP,dhcp_proxy_dump) \
53 _(DHCP_PROXY_SET_VSS,dhcp_proxy_set_vss) \
54 _(DHCP_CLIENT_CONFIG, dhcp_client_config) \
55 _(DHCP_CLIENT_DUMP, dhcp_client_dump) \
56 _(WANT_DHCP6_PD_REPLY_EVENTS, want_dhcp6_pd_reply_events) \
57 _(DHCP6_PD_SEND_CLIENT_MESSAGE, dhcp6_pd_send_client_message) \
58 _(WANT_DHCP6_REPLY_EVENTS, want_dhcp6_reply_events) \
59 _(DHCP6_SEND_CLIENT_MESSAGE, dhcp6_send_client_message) \
60 _(DHCP6_CLIENTS_ENABLE_DISABLE, dhcp6_clients_enable_disable) \
61 _(DHCP6_DUID_LL_SET, dhcp6_duid_ll_set)
65 vl_api_dhcp_proxy_set_vss_t_handler (vl_api_dhcp_proxy_set_vss_t * mp)
67 vl_api_dhcp_proxy_set_vss_reply_t *rmp;
71 mp->vpn_ascii_id[sizeof (mp->vpn_ascii_id) - 1] = 0;
72 vpn_ascii_id = format (0, "%s", mp->vpn_ascii_id);
74 dhcp_proxy_set_vss ((mp->is_ipv6 ? FIB_PROTOCOL_IP6 : FIB_PROTOCOL_IP4),
75 ntohl (mp->tbl_id), mp->vss_type, vpn_ascii_id,
76 ntohl (mp->oui), ntohl (mp->vpn_index),
79 REPLY_MACRO (VL_API_DHCP_PROXY_SET_VSS_REPLY);
83 static void vl_api_dhcp_proxy_config_t_handler
84 (vl_api_dhcp_proxy_config_t * mp)
86 vl_api_dhcp_proxy_set_vss_reply_t *rmp;
87 ip46_address_t src, server;
92 clib_memcpy (&src.ip6, mp->dhcp_src_address, sizeof (src.ip6));
93 clib_memcpy (&server.ip6, mp->dhcp_server, sizeof (server.ip6));
95 rv = dhcp6_proxy_set_server (&server,
97 (u32) ntohl (mp->rx_vrf_id),
98 (u32) ntohl (mp->server_vrf_id),
99 (int) (mp->is_add == 0));
103 ip46_address_reset (&src);
104 ip46_address_reset (&server);
106 clib_memcpy (&src.ip4, mp->dhcp_src_address, sizeof (src.ip4));
107 clib_memcpy (&server.ip4, mp->dhcp_server, sizeof (server.ip4));
109 rv = dhcp4_proxy_set_server (&server,
111 (u32) ntohl (mp->rx_vrf_id),
112 (u32) ntohl (mp->server_vrf_id),
113 (int) (mp->is_add == 0));
117 REPLY_MACRO (VL_API_DHCP_PROXY_CONFIG_REPLY);
121 vl_api_dhcp_proxy_dump_t_handler (vl_api_dhcp_proxy_dump_t * mp)
123 vl_api_registration_t *reg;
125 reg = vl_api_client_index_to_registration (mp->client_index);
129 dhcp_proxy_dump ((mp->is_ip6 == 1 ?
130 FIB_PROTOCOL_IP6 : FIB_PROTOCOL_IP4), reg, mp->context);
134 dhcp_send_details (fib_protocol_t proto,
135 void *opaque, u32 context, dhcp_proxy_t * proxy)
137 vl_api_dhcp_proxy_details_t *mp;
138 vl_api_registration_t *reg = opaque;
139 vl_api_dhcp_server_t *v_server;
140 dhcp_server_t *server;
146 count = vec_len (proxy->dhcp_servers);
147 n = sizeof (*mp) + (count * sizeof (vl_api_dhcp_server_t));
148 mp = vl_msg_api_alloc (n);
152 mp->_vl_msg_id = ntohs (VL_API_DHCP_PROXY_DETAILS);
153 mp->context = context;
156 mp->is_ipv6 = (proto == FIB_PROTOCOL_IP6);
158 htonl (dhcp_proxy_rx_table_get_table_id (proto, proxy->rx_fib_index));
160 vss = dhcp_get_vss_info (&dhcp_proxy_main, proxy->rx_fib_index, proto);
164 mp->vss_type = vss->vss_type;
165 if (vss->vss_type == VSS_TYPE_ASCII)
167 u32 id_len = vec_len (vss->vpn_ascii_id);
168 clib_memcpy (mp->vss_vpn_ascii_id, vss->vpn_ascii_id, id_len);
170 else if (vss->vss_type == VSS_TYPE_VPN_ID)
172 u32 oui = ((u32) vss->vpn_id[0] << 16) + ((u32) vss->vpn_id[1] << 8)
173 + ((u32) vss->vpn_id[2]);
174 u32 fib_id = ((u32) vss->vpn_id[3] << 24) +
175 ((u32) vss->vpn_id[4] << 16) + ((u32) vss->vpn_id[5] << 8) +
176 ((u32) vss->vpn_id[6]);
177 mp->vss_oui = htonl (oui);
178 mp->vss_fib_id = htonl (fib_id);
182 mp->vss_type = VSS_TYPE_INVALID;
184 vec_foreach_index (count, proxy->dhcp_servers)
186 server = &proxy->dhcp_servers[count];
187 v_server = &mp->servers[count];
189 s_fib = fib_table_get (server->server_fib_index, proto);
191 v_server->server_vrf_id = htonl (s_fib->ft_table_id);
195 memcpy (v_server->dhcp_server, &server->dhcp_server.ip6, 16);
199 /* put the address in the first bytes */
200 memcpy (v_server->dhcp_server, &server->dhcp_server.ip4, 4);
206 memcpy (mp->dhcp_src_address, &proxy->dhcp_src_address.ip6, 16);
210 /* put the address in the first bytes */
211 memcpy (mp->dhcp_src_address, &proxy->dhcp_src_address.ip4, 4);
213 vl_api_send_msg (reg, (u8 *) mp);
217 dhcp_client_lease_encode (vl_api_dhcp_lease_t * lease,
218 const dhcp_client_t * client)
222 lease->is_ipv6 = 0; // only support IPv6 clients
223 lease->sw_if_index = ntohl (client->sw_if_index);
224 lease->state = client->state;
225 len = clib_min (sizeof (lease->hostname) - 1, vec_len (client->hostname));
226 clib_memcpy (&lease->hostname, client->hostname, len);
227 lease->hostname[len] = 0;
229 lease->mask_width = client->subnet_mask_width;
230 clib_memcpy (&lease->host_address[0], (u8 *) & client->leased_address, 4);
231 clib_memcpy (&lease->router_address[0], (u8 *) & client->router_address, 4);
233 if (NULL != client->l2_rewrite)
234 clib_memcpy (&lease->host_mac[0], client->l2_rewrite + 6, 6);
238 dhcp_client_data_encode (vl_api_dhcp_client_t * vclient,
239 const dhcp_client_t * client)
243 vclient->sw_if_index = ntohl (client->sw_if_index);
244 len = clib_min (sizeof (vclient->hostname) - 1, vec_len (client->hostname));
245 clib_memcpy (&vclient->hostname, client->hostname, len);
246 vclient->hostname[len] = 0;
248 len = clib_min (sizeof (vclient->id) - 1,
249 vec_len (client->client_identifier));
250 clib_memcpy (&vclient->id, client->client_identifier, len);
251 vclient->id[len] = 0;
253 if (NULL != client->event_callback)
254 vclient->want_dhcp_event = 1;
256 vclient->want_dhcp_event = 0;
257 vclient->set_broadcast_flag = client->set_broadcast_flag;
258 vclient->pid = client->pid;
262 dhcp_compl_event_callback (u32 client_index, const dhcp_client_t * client)
264 vl_api_registration_t *reg;
265 vl_api_dhcp_compl_event_t *mp;
267 reg = vl_api_client_index_to_registration (client_index);
271 mp = vl_msg_api_alloc (sizeof (*mp));
272 mp->client_index = client_index;
273 mp->pid = client->pid;
274 dhcp_client_lease_encode (&mp->lease, client);
276 mp->_vl_msg_id = ntohs (VL_API_DHCP_COMPL_EVENT);
278 vl_api_send_msg (reg, (u8 *) mp);
281 static void vl_api_dhcp_client_config_t_handler
282 (vl_api_dhcp_client_config_t * mp)
284 vlib_main_t *vm = vlib_get_main ();
285 vl_api_dhcp_client_config_reply_t *rmp;
289 sw_if_index = ntohl (mp->client.sw_if_index);
290 if (!vnet_sw_if_index_is_api_valid (sw_if_index))
292 rv = VNET_API_ERROR_INVALID_SW_IF_INDEX;
293 goto bad_sw_if_index;
296 rv = dhcp_client_config (mp->is_add,
302 (mp->client.want_dhcp_event ?
303 dhcp_compl_event_callback :
305 mp->client.set_broadcast_flag, mp->client.pid);
307 BAD_SW_IF_INDEX_LABEL;
309 REPLY_MACRO (VL_API_DHCP_CLIENT_CONFIG_REPLY);
312 typedef struct dhcp_client_send_walk_ctx_t_
314 vl_api_registration_t *reg;
316 } dhcp_client_send_walk_ctx_t;
319 send_dhcp_client_entry (const dhcp_client_t * client, void *arg)
321 dhcp_client_send_walk_ctx_t *ctx;
322 vl_api_dhcp_client_details_t *mp;
326 mp = vl_msg_api_alloc (sizeof (*mp));
327 memset (mp, 0, sizeof (*mp));
329 mp->_vl_msg_id = ntohs (VL_API_DHCP_CLIENT_DETAILS);
330 mp->context = ctx->context;
332 dhcp_client_data_encode (&mp->client, client);
333 dhcp_client_lease_encode (&mp->lease, client);
335 vl_api_send_msg (ctx->reg, (u8 *) mp);
341 vl_api_dhcp_client_dump_t_handler (vl_api_dhcp_client_dump_t * mp)
343 vl_api_registration_t *reg;
345 reg = vl_api_client_index_to_registration (mp->client_index);
349 dhcp_client_send_walk_ctx_t ctx = {
351 .context = mp->context,
353 dhcp_client_walk (send_dhcp_client_entry, &ctx);
358 * Add vpe's API message handlers to the table.
359 * vlib has alread mapped shared memory and
360 * added the client registration handlers.
361 * See .../vlib-api/vlibmemory/memclnt_vlib.c:memclnt_process()
363 #define vl_msg_name_crc_list
364 #include <vnet/vnet_all_api_h.h>
365 #undef vl_msg_name_crc_list
368 setup_message_id_table (api_main_t * am)
370 #define _(id,n,crc) vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id);
371 foreach_vl_msg_name_crc_dhcp;
375 static clib_error_t *
376 dhcp_api_hookup (vlib_main_t * vm)
378 api_main_t *am = &api_main;
381 vl_msg_api_set_handlers(VL_API_##N, #n, \
382 vl_api_##n##_t_handler, \
384 vl_api_##n##_t_endian, \
385 vl_api_##n##_t_print, \
386 sizeof(vl_api_##n##_t), 1);
391 * Set up the (msg_name, crc, message-id) table
393 setup_message_id_table (am);
395 dhcp6_pd_set_publisher_node (dhcp6_pd_reply_process_node.index,
396 DHCP6_PD_DP_REPLY_REPORT);
397 dhcp6_set_publisher_node (dhcp6_reply_process_node.index,
398 DHCP6_DP_REPLY_REPORT);
403 VLIB_API_INIT_FUNCTION (dhcp_api_hookup);
406 * fd.io coding-style-patch-verification: ON
409 * eval: (c-set-style "gnu")