FD.io VPP  v18.01.2-1-g9b554f3
Vector Packet Processing
dhcp_api.c
Go to the documentation of this file.
1 /*
2  *------------------------------------------------------------------
3  * dhcp_api.c - dhcp api
4  *
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:
9  *
10  * http://www.apache.org/licenses/LICENSE-2.0
11  *
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  *------------------------------------------------------------------
18  */
19 
20 #include <vnet/vnet.h>
21 #include <vlibmemory/api.h>
22 
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/fib/fib_table.h>
28 
29 #include <vnet/vnet_msg_enum.h>
30 
31 #define vl_typedefs /* define message structures */
32 #include <vnet/vnet_all_api_h.h>
33 #undef vl_typedefs
34 
35 #define vl_endianfun /* define message structures */
36 #include <vnet/vnet_all_api_h.h>
37 #undef vl_endianfun
38 
39 /* instantiate all the print functions we know about */
40 #define vl_print(handle, ...) vlib_cli_output (handle, __VA_ARGS__)
41 #define vl_printfun
42 #include <vnet/vnet_all_api_h.h>
43 #undef vl_printfun
44 
46 
47 #define foreach_vpe_api_msg \
48 _(DHCP_PROXY_CONFIG,dhcp_proxy_config) \
49 _(DHCP_PROXY_DUMP,dhcp_proxy_dump) \
50 _(DHCP_PROXY_SET_VSS,dhcp_proxy_set_vss) \
51 _(DHCP_CLIENT_CONFIG, dhcp_client_config)
52 
53 
54 static void
56 {
57  vl_api_dhcp_proxy_set_vss_reply_t *rmp;
58  u8 *vpn_ascii_id;
59  int rv;
60 
61  mp->vpn_ascii_id[sizeof (mp->vpn_ascii_id) - 1] = 0;
62  vpn_ascii_id = format (0, "%s", mp->vpn_ascii_id);
63  rv =
65  ntohl (mp->tbl_id), mp->vss_type, vpn_ascii_id,
66  ntohl (mp->oui), ntohl (mp->vpn_index),
67  mp->is_add == 0);
68 
69  REPLY_MACRO (VL_API_DHCP_PROXY_SET_VSS_REPLY);
70 }
71 
72 
75 {
76  vl_api_dhcp_proxy_set_vss_reply_t *rmp;
77  ip46_address_t src, server;
78  int rv = -1;
79 
80  if (mp->is_ipv6)
81  {
82  clib_memcpy (&src.ip6, mp->dhcp_src_address, sizeof (src.ip6));
83  clib_memcpy (&server.ip6, mp->dhcp_server, sizeof (server.ip6));
84 
85  rv = dhcp6_proxy_set_server (&server,
86  &src,
87  (u32) ntohl (mp->rx_vrf_id),
88  (u32) ntohl (mp->server_vrf_id),
89  (int) (mp->is_add == 0));
90  }
91  else
92  {
93  ip46_address_reset (&src);
94  ip46_address_reset (&server);
95 
96  clib_memcpy (&src.ip4, mp->dhcp_src_address, sizeof (src.ip4));
97  clib_memcpy (&server.ip4, mp->dhcp_server, sizeof (server.ip4));
98 
99  rv = dhcp4_proxy_set_server (&server,
100  &src,
101  (u32) ntohl (mp->rx_vrf_id),
102  (u32) ntohl (mp->server_vrf_id),
103  (int) (mp->is_add == 0));
104  }
105 
106 
107  REPLY_MACRO (VL_API_DHCP_PROXY_CONFIG_REPLY);
108 }
109 
110 static void
112 {
114 
116  if (q == 0)
117  return;
118 
119  dhcp_proxy_dump ((mp->is_ip6 == 1 ?
121 }
122 
123 void
125  void *opaque, u32 context, dhcp_proxy_t * proxy)
126 {
128  unix_shared_memory_queue_t *q = opaque;
129  vl_api_dhcp_server_t *v_server;
130  dhcp_server_t *server;
131  fib_table_t *s_fib;
132  dhcp_vss_t *vss;
133  u32 count;
134  size_t n;
135 
136  count = vec_len (proxy->dhcp_servers);
137  n = sizeof (*mp) + (count * sizeof (vl_api_dhcp_server_t));
138  mp = vl_msg_api_alloc (n);
139  if (!mp)
140  return;
141  memset (mp, 0, n);
142  mp->_vl_msg_id = ntohs (VL_API_DHCP_PROXY_DETAILS);
143  mp->context = context;
144  mp->count = count;
145 
146  mp->is_ipv6 = (proto == FIB_PROTOCOL_IP6);
147  mp->rx_vrf_id =
148  htonl (dhcp_proxy_rx_table_get_table_id (proto, proxy->rx_fib_index));
149 
150  vss = dhcp_get_vss_info (&dhcp_proxy_main, proxy->rx_fib_index, proto);
151 
152  if (vss)
153  {
154  mp->vss_type = vss->vss_type;
155  if (vss->vss_type == VSS_TYPE_ASCII)
156  {
157  u32 id_len = vec_len (vss->vpn_ascii_id);
158  clib_memcpy (mp->vss_vpn_ascii_id, vss->vpn_ascii_id, id_len);
159  }
160  else if (vss->vss_type == VSS_TYPE_VPN_ID)
161  {
162  u32 oui = ((u32) vss->vpn_id[0] << 16) + ((u32) vss->vpn_id[1] << 8)
163  + ((u32) vss->vpn_id[2]);
164  u32 fib_id = ((u32) vss->vpn_id[3] << 24) +
165  ((u32) vss->vpn_id[4] << 16) + ((u32) vss->vpn_id[5] << 8) +
166  ((u32) vss->vpn_id[6]);
167  mp->vss_oui = htonl (oui);
168  mp->vss_fib_id = htonl (fib_id);
169  }
170  }
171  else
173 
174  vec_foreach_index (count, proxy->dhcp_servers)
175  {
176  server = &proxy->dhcp_servers[count];
177  v_server = &mp->servers[count];
178 
179  s_fib = fib_table_get (server->server_fib_index, proto);
180 
181  v_server->server_vrf_id = htonl (s_fib->ft_table_id);
182 
183  if (mp->is_ipv6)
184  {
185  memcpy (v_server->dhcp_server, &server->dhcp_server.ip6, 16);
186  }
187  else
188  {
189  /* put the address in the first bytes */
190  memcpy (v_server->dhcp_server, &server->dhcp_server.ip4, 4);
191  }
192  }
193 
194  if (mp->is_ipv6)
195  {
196  memcpy (mp->dhcp_src_address, &proxy->dhcp_src_address.ip6, 16);
197  }
198  else
199  {
200  /* put the address in the first bytes */
201  memcpy (mp->dhcp_src_address, &proxy->dhcp_src_address.ip4, 4);
202  }
203  vl_msg_api_send_shmem (q, (u8 *) & mp);
204 }
205 
206 void
207 dhcp_compl_event_callback (u32 client_index, u32 pid, u8 * hostname,
208  u8 mask_width, u8 is_ipv6, u8 * host_address,
209  u8 * router_address, u8 * host_mac)
210 {
213  u32 len;
214 
215  q = vl_api_client_index_to_input_queue (client_index);
216  if (!q)
217  return;
218 
219  mp = vl_msg_api_alloc (sizeof (*mp));
220  mp->client_index = client_index;
221  mp->pid = pid;
222  mp->is_ipv6 = is_ipv6;
223  len = (vec_len (hostname) < 63) ? vec_len (hostname) : 63;
224  clib_memcpy (&mp->hostname, hostname, len);
225  mp->hostname[len] = 0;
226  mp->mask_width = mask_width;
227  clib_memcpy (&mp->host_address[0], host_address, 16);
228  clib_memcpy (&mp->router_address[0], router_address, 16);
229 
230  if (NULL != host_mac)
231  clib_memcpy (&mp->host_mac[0], host_mac, 6);
232 
233  mp->_vl_msg_id = ntohs (VL_API_DHCP_COMPL_EVENT);
234 
235  vl_msg_api_send_shmem (q, (u8 *) & mp);
236 }
237 
240 {
242  vl_api_dhcp_client_config_reply_t *rmp;
243  int rv = 0;
244 
246 
247  rv = dhcp_client_config (vm, ntohl (mp->sw_if_index),
248  mp->hostname, mp->client_id,
249  mp->is_add, mp->client_index,
251  NULL, mp->pid);
252 
254 
255  REPLY_MACRO (VL_API_DHCP_CLIENT_CONFIG_REPLY);
256 }
257 
258 /*
259  * dhcp_api_hookup
260  * Add vpe's API message handlers to the table.
261  * vlib has alread mapped shared memory and
262  * added the client registration handlers.
263  * See .../vlib-api/vlibmemory/memclnt_vlib.c:memclnt_process()
264  */
265 #define vl_msg_name_crc_list
266 #include <vnet/vnet_all_api_h.h>
267 #undef vl_msg_name_crc_list
268 
269 static void
271 {
272 #define _(id,n,crc) vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id);
273  foreach_vl_msg_name_crc_dhcp;
274 #undef _
275 }
276 
277 static clib_error_t *
279 {
280  api_main_t *am = &api_main;
281 
282 #define _(N,n) \
283  vl_msg_api_set_handlers(VL_API_##N, #n, \
284  vl_api_##n##_t_handler, \
285  vl_noop_handler, \
286  vl_api_##n##_t_endian, \
287  vl_api_##n##_t_print, \
288  sizeof(vl_api_##n##_t), 1);
290 #undef _
291 
292  /*
293  * Set up the (msg_name, crc, message-id) table
294  */
296 
297  return 0;
298 }
299 
301 
302 /*
303  * fd.io coding-style-patch-verification: ON
304  *
305  * Local Variables:
306  * eval: (c-set-style "gnu")
307  * End:
308  */
DHCP Proxy set / unset vss request.
Definition: dhcp.api:52
int dhcp_client_config(vlib_main_t *vm, u32 sw_if_index, u8 *hostname, u8 *client_id, u32 is_add, u32 client_index, void *event_callback, u32 pid)
Definition: client.c:966
#define vec_foreach_index(var, v)
Iterate over vector indices.
static dhcp_vss_t * dhcp_get_vss_info(dhcp_proxy_main_t *dm, u32 rx_fib_index, fib_protocol_t proto)
Get the VSS data for the FIB index.
Definition: dhcp_proxy.h:237
static clib_error_t * dhcp_api_hookup(vlib_main_t *vm)
Definition: dhcp_api.c:278
#define VSS_TYPE_INVALID
Definition: dhcp_proxy.h:62
dhcp_server_t * dhcp_servers
The set of DHCP servers to which messages are relayed.
Definition: dhcp_proxy.h:105
#define NULL
Definition: clib.h:55
dhcp_proxy_main_t dhcp_proxy_main
Shard 4/6 instance of DHCP main.
Definition: dhcp_proxy.c:25
int dhcp6_proxy_set_server(ip46_address_t *addr, ip46_address_t *src_addr, u32 rx_table_id, u32 server_table_id, int is_del)
ip46_address_t dhcp_src_address
The source address to use in relayed messaes.
Definition: dhcp_proxy.h:120
The Virtual Sub-net Selection information for a given RX FIB.
Definition: dhcp_proxy.h:51
void dhcp_send_details(fib_protocol_t proto, void *opaque, u32 context, dhcp_proxy_t *proxy)
Send the details of a proxy session to the API client during a dump.
Definition: dhcp_api.c:124
u32 rx_fib_index
The FIB index (not the external Table-ID) in which the client is resides.
Definition: dhcp_proxy.h:126
u8 * format(u8 *s, const char *fmt,...)
Definition: format.c:419
u8 vss_type
VSS type as defined in RFC 6607: 0 for NVT ASCII VPN Identifier 1 for RFC 2685 VPN-ID of 7 octects - ...
Definition: dhcp_proxy.h:59
enum fib_protocol_t_ fib_protocol_t
Protocol Type.
void dhcp_proxy_dump(fib_protocol_t proto, void *opaque, u32 context)
Dump the proxy configs to the API.
Definition: dhcp_proxy.c:248
vl_api_dhcp_server_t servers[count]
Definition: dhcp.api:140
static void vl_api_dhcp_proxy_config_t_handler(vl_api_dhcp_proxy_config_t *mp)
Definition: dhcp_api.c:74
#define foreach_vpe_api_msg
Definition: dhcp_api.c:47
#define VSS_TYPE_ASCII
Definition: dhcp_proxy.h:60
void * vl_msg_api_alloc(int nbytes)
u32 server_fib_index
The FIB index (not the external Table-ID) in which the server is reachable.
Definition: dhcp_proxy.h:89
#define REPLY_MACRO(t)
static void vl_api_dhcp_proxy_dump_t_handler(vl_api_dhcp_proxy_dump_t *mp)
Definition: dhcp_api.c:111
int dhcp_proxy_set_vss(fib_protocol_t proto, u32 tbl_id, u8 vss_type, u8 *vpn_ascii_id, u32 oui, u32 vpn_index, u8 is_del)
Configure/set a new VSS info.
Definition: dhcp_proxy.c:309
API main structure, used by both vpp and binary API clients.
Definition: api_common.h:198
#define BAD_SW_IF_INDEX_LABEL
api_main_t api_main
Definition: api_shared.c:35
u8 * vpn_ascii_id
Type 0 ASCII VPN Identifier.
Definition: dhcp_proxy.h:71
u32 ft_table_id
Table ID (hash key) for this FIB.
Definition: fib_table.h:50
vlib_main_t * vm
Definition: buffer.c:283
uint32_t mask_width(const boost::asio::ip::address &addr)
Get the prefix mask length of a host route from the boost address.
Definition: prefix.cpp:229
#define clib_memcpy(a, b, c)
Definition: string.h:75
unix_shared_memory_queue_t * vl_api_client_index_to_input_queue(u32 index)
void dhcp_compl_event_callback(u32 client_index, u32 pid, u8 *hostname, u8 mask_width, u8 is_ipv6, u8 *host_address, u8 *router_address, u8 *host_mac)
Definition: dhcp_api.c:207
A representation of a single DHCP Server within a given VRF config.
Definition: dhcp_proxy.h:77
int dhcp4_proxy_set_server(ip46_address_t *addr, ip46_address_t *src_addr, u32 rx_table_id, u32 server_table_id, int is_del)
ip46_address_t dhcp_server
The address of the DHCP server to which to relay the client&#39;s messages.
Definition: dhcp_proxy.h:83
void vl_msg_api_send_shmem(unix_shared_memory_queue_t *q, u8 *elem)
unsigned int u32
Definition: types.h:88
VLIB_API_INIT_FUNCTION(dhcp_api_hookup)
size_t count
Definition: vapi.c:42
static vlib_main_t * vlib_get_main(void)
Definition: global_funcs.h:23
u8 dhcp_server[16]
Definition: dhcp.api:123
Tell client about a DHCP completion event.
Definition: dhcp.api:129
#define ip46_address_reset(ip46)
Definition: ip6_packet.h:79
A DHCP proxy represenation fpr per-client VRF config.
Definition: dhcp_proxy.h:95
#define vec_len(v)
Number of elements in vector (rvalue-only, NULL tolerant)
unsigned char u8
Definition: types.h:56
u8 vpn_id[7]
Type 1 VPN-ID.
Definition: dhcp_proxy.h:67
static void setup_message_id_table(api_main_t *am)
Definition: dhcp_api.c:270
#define VSS_TYPE_VPN_ID
Definition: dhcp_proxy.h:61
static void vl_api_dhcp_client_config_t_handler(vl_api_dhcp_client_config_t *mp)
Definition: dhcp_api.c:239
fib_table_t * fib_table_get(fib_node_index_t index, fib_protocol_t proto)
Get a pointer to a FIB table.
Definition: fib_table.c:27
static void vl_api_dhcp_proxy_set_vss_t_handler(vl_api_dhcp_proxy_set_vss_t *mp)
Definition: dhcp_api.c:55
Dump DHCP proxy table.
Definition: dhcp.api:113
u32 dhcp_proxy_rx_table_get_table_id(fib_protocol_t proto, u32 fib_index)
Definition: dhcp_proxy.c:46
Tell client about a DHCP completion event.
Definition: dhcp.api:97
DHCP Client config add / del request.
Definition: dhcp.api:76
DHCP Proxy config add / del request.
Definition: dhcp.api:29
#define VALIDATE_SW_IF_INDEX(mp)
A protocol Independent FIB table.
Definition: fib_table.h:35
struct _unix_shared_memory_queue unix_shared_memory_queue_t