FD.io VPP  v20.05.1-6-gf53edbc3b
Vector Packet Processing
dhcp_proxy.h
Go to the documentation of this file.
1 /*
2  * dhcp_proxy.h: DHCP v4 & v6 proxy common functions/types
3  *
4  * Copyright (c) 2013 Cisco and/or its affiliates.
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at:
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  */
17 
18 #ifndef included_dhcp_proxy_h
19 #define included_dhcp_proxy_h
20 
21 #include <vnet/vnet.h>
22 #include <dhcp/dhcp4_packet.h>
23 #include <vnet/ethernet/ethernet.h>
24 #include <vnet/ip/ip.h>
25 #include <vnet/ip/ip4.h>
26 #include <vnet/ip/ip4_packet.h>
27 #include <vnet/pg/pg.h>
28 #include <vnet/ip/format.h>
29 #include <vnet/udp/udp.h>
30 
31 typedef enum
32 {
33 #define dhcp_proxy_error(n,s) DHCP_PROXY_ERROR_##n,
35 #undef dhcp_proxy_error
38 
39 typedef enum
40 {
41 #define dhcpv6_proxy_error(n,s) DHCPV6_PROXY_ERROR_##n,
43 #undef dhcpv6_proxy_error
46 
47 /* flags to indicate which DHCP ports should be or have been registered */
48 typedef enum
49 {
53 
54 /**
55  * @brief The Virtual Sub-net Selection information for a given RX FIB
56  */
57 typedef struct dhcp_vss_t_
58 {
59  /**
60  * @brief VSS type as defined in RFC 6607:
61  * 0 for NVT ASCII VPN Identifier
62  * 1 for RFC 2685 VPN-ID of 7 octects - 3 bytes OUI & 4 bytes VPN index
63  * 255 for global default VPN
64  */
66 #define VSS_TYPE_ASCII 0
67 #define VSS_TYPE_VPN_ID 1
68 #define VSS_TYPE_INVALID 123
69 #define VSS_TYPE_DEFAULT 255
70  /**
71  * @brief Type 1 VPN-ID
72  */
73  u8 vpn_id[7];
74  /**
75  * @brief Type 0 ASCII VPN Identifier
76  */
78 } dhcp_vss_t;
79 
80 /**
81  * @brief A representation of a single DHCP Server within a given VRF config
82  */
83 typedef struct dhcp_server_t_
84 {
85  /**
86  * @brief The address of the DHCP server to which to relay the client's
87  * messages
88  */
89  ip46_address_t dhcp_server;
90 
91  /**
92  * @brief The FIB index (not the external Table-ID) in which the server
93  * is reachable.
94  */
97 
98 /**
99  * @brief A DHCP proxy representation fpr per-client VRF config
100  */
101 typedef struct dhcp_proxy_t_
102 {
103  /**
104  * @brief The set of DHCP servers to which messages are relayed.
105  * If multiple servers are configured then discover/solict messages
106  * are relayed to each. A cookie is maintained for the relay, and only
107  * one message is replayed to the client, based on the presence of the
108  * cookie.
109  * The expectation is there are only 1 or 2 servers, hence no fancy DB.
110  */
112 
113  /**
114  * @brief Hash table of pending requets key'd on the clients MAC address
115  */
117 
118  /**
119  * @brief A lock for the pending request DB.
120  */
121  int lock;
122 
123  /**
124  * @brief The source address to use in relayed messaes
125  */
126  ip46_address_t dhcp_src_address;
127 
128  /**
129  * @brief The FIB index (not the external Table-ID) in which the client
130  * is resides.
131  */
133 } dhcp_proxy_t;
134 
135 #define DHCP_N_PROTOS (FIB_PROTOCOL_IP6 + 1)
136 
137 /**
138  * @brief Collection of global DHCP proxy data
139  */
140 typedef struct
141 {
142  /* Pool of DHCP servers */
143  dhcp_proxy_t *dhcp_servers[DHCP_N_PROTOS];
144 
145  /* Pool of selected DHCP server. Zero is the default server */
146  u32 *dhcp_server_index_by_rx_fib_index[DHCP_N_PROTOS];
147 
148  /* to drop pkts in server-to-client direction */
150 
152 
153  /* hash lookup specific vrf_id -> option 82 vss suboption */
154  u32 *vss_index_by_rx_fib_index[DHCP_N_PROTOS];
155 
156  /* flags to indicate which udp ports have been registered */
158 
159  /* convenience */
161 
163 
165 
166 /**
167  * @brief Register the dhcp client and/or server ports, if not already done
168  */
170 
171 /**
172  * @brief Send the details of a proxy session to the API client during a dump
173  */
175  void *opaque, u32 context, dhcp_proxy_t * proxy);
176 
177 /**
178  * @brief Show (on CLI) a VSS config during a show walk
179  */
180 int dhcp_vss_show_walk (dhcp_vss_t * vss, u32 rx_table_id, void *ctx);
181 
182 /**
183  * @brief Configure/set a new VSS info
184  */
186  u32 tbl_id,
187  u8 vss_type,
188  u8 * vpn_ascii_id, u32 oui, u32 vpn_index, u8 is_del);
189 
190 /**
191  * @brief Dump the proxy configs to the API
192  */
193 void dhcp_proxy_dump (fib_protocol_t proto, void *opaque, u32 context);
194 
195 /**
196  * @brief Add a new DHCP proxy server configuration.
197  * @return 1 is the config is new,
198  * 0 otherwise (implying a modify of an existing)
199  */
201  ip46_address_t * addr,
202  ip46_address_t * src_address,
203  u32 rx_fib_iindex, u32 server_table_id);
204 
205 /**
206  * @brief Delete a DHCP proxy config
207  * @return 1 if the proxy is deleted, 0 otherwise
208  */
210  u32 rx_fib_index,
211  ip46_address_t * addr, u32 server_table_id);
212 
214 
215 /**
216  * @brief Callback function invoked for each DHCP proxy entry
217  * return 0 to break the walk, non-zero otherwise.
218  */
219 typedef int (*dhcp_proxy_walk_fn_t) (dhcp_proxy_t * server, void *ctx);
220 
221 /**
222  * @brief Walk/Visit each DHCP proxy server
223  */
225  dhcp_proxy_walk_fn_t fn, void *ctx);
226 
227 /**
228  * @brief Callback function invoked for each DHCP VSS entry
229  * return 0 to break the walk, non-zero otherwise.
230  */
231 typedef int (*dhcp_vss_walk_fn_t) (dhcp_vss_t * server,
232  u32 rx_table_id, void *ctx);
233 
234 /**
235  * @brief Walk/Visit each DHCP proxy VSS
236  */
238 
239 /**
240  * @brief Lock a proxy object to prevent simultaneous access of its
241  * pending store
242  */
243 void dhcp_proxy_lock (dhcp_proxy_t * server);
244 
245 /**
246  * @brief Lock a proxy object to prevent simultaneous access of its
247  * pending store
248  */
249 void dhcp_proxy_unlock (dhcp_proxy_t * server);
250 
251 /**
252  * @brief Get the VSS data for the FIB index
253  */
254 static inline dhcp_vss_t *
256  u32 rx_fib_index, fib_protocol_t proto)
257 {
258  dhcp_vss_t *v = NULL;
259 
260  if (vec_len (dm->vss_index_by_rx_fib_index[proto]) > rx_fib_index &&
261  dm->vss_index_by_rx_fib_index[proto][rx_fib_index] != ~0)
262  {
263  v = pool_elt_at_index (dm->vss[proto],
264  dm->vss_index_by_rx_fib_index[proto]
265  [rx_fib_index]);
266  }
267 
268  return (v);
269 }
270 
271 /**
272  * @brief Get the DHCP proxy server data for the FIB index
273  */
274 static inline dhcp_proxy_t *
276  u32 rx_fib_index, fib_protocol_t proto)
277 {
278  dhcp_proxy_t *s = NULL;
279 
280  if (vec_len (dm->dhcp_server_index_by_rx_fib_index[proto]) > rx_fib_index &&
281  dm->dhcp_server_index_by_rx_fib_index[proto][rx_fib_index] != ~0)
282  {
283  s = pool_elt_at_index (dm->dhcp_servers[proto],
285  [rx_fib_index]);
286  }
287 
288  return (s);
289 }
290 
291 int dhcp6_proxy_set_server (ip46_address_t * addr,
292  ip46_address_t * src_addr,
293  u32 rx_table_id, u32 server_table_id, int is_del);
294 int dhcp4_proxy_set_server (ip46_address_t * addr,
295  ip46_address_t * src_addr,
296  u32 rx_table_id, u32 server_table_id, int is_del);
297 
298 #endif /* included_dhcp_proxy_h */
299 
300 /*
301  * fd.io coding-style-patch-verification: ON
302  *
303  * Local Variables:
304  * eval: (c-set-style "gnu")
305  * End:
306  */
#define DHCP_N_PROTOS
Definition: dhcp_proxy.h:135
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:255
void dhcp_maybe_register_udp_ports(dhcp_port_reg_flags_t ports)
Register the dhcp client and/or server ports, if not already done.
vss_type
Definition: dhcp.api:22
void dhcp_proxy_dump(fib_protocol_t proto, void *opaque, u32 context)
Dump the proxy configs to the API.
Definition: dhcp_proxy.c:248
struct dhcp_proxy_t_ dhcp_proxy_t
A DHCP proxy representation fpr per-client VRF config.
struct dhcp_server_t_ dhcp_server_t
A representation of a single DHCP Server within a given VRF config.
dhcp_server_t * dhcp_servers
The set of DHCP servers to which messages are relayed.
Definition: dhcp_proxy.h:111
int dhcp_vss_show_walk(dhcp_vss_t *vss, u32 rx_table_id, void *ctx)
Show (on CLI) a VSS config during a show walk.
Definition: dhcp_proxy.c:259
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_src_address
The source address to use in relayed messaes.
Definition: dhcp_proxy.h:126
The Virtual Sub-net Selection information for a given RX FIB.
Definition: dhcp_proxy.h:57
u32 * dhcp_server_index_by_rx_fib_index[DHCP_N_PROTOS]
Definition: dhcp_proxy.h:146
u32 rx_fib_index
The FIB index (not the external Table-ID) in which the client is resides.
Definition: dhcp_proxy.h:132
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:65
vhost_vring_addr_t addr
Definition: vhost_user.h:254
void dhcp_proxy_lock(dhcp_proxy_t *server)
Lock a proxy object to prevent simultaneous access of its pending store.
unsigned char u8
Definition: types.h:56
enum fib_protocol_t_ fib_protocol_t
Protocol Type.
static dhcp_proxy_t * dhcp_get_proxy(dhcp_proxy_main_t *dm, u32 rx_fib_index, fib_protocol_t proto)
Get the DHCP proxy server data for the FIB index.
Definition: dhcp_proxy.h:275
u32 * vss_index_by_rx_fib_index[DHCP_N_PROTOS]
Definition: dhcp_proxy.h:154
unsigned int u32
Definition: types.h:88
dhcp_proxy_error_t
Definition: dhcp_proxy.h:31
dhcp_proxy_t * dhcp_servers[DHCP_N_PROTOS]
Definition: dhcp_proxy.h:143
dhcpv6_proxy_error_t
Definition: dhcp_proxy.h:39
u32 server_fib_index
The FIB index (not the external Table-ID) in which the server is reachable.
Definition: dhcp_proxy.h:95
dhcp_port_reg_flags_t
Definition: dhcp_proxy.h:48
Collection of global DHCP proxy data.
Definition: dhcp_proxy.h:140
#define pool_elt_at_index(p, i)
Returns pointer to element at given index.
Definition: pool.h:534
vl_api_ip_proto_t proto
Definition: acl_types.api:50
long ctx[MAX_CONNS]
Definition: main.c:144
int(* dhcp_vss_walk_fn_t)(dhcp_vss_t *server, u32 rx_table_id, void *ctx)
Callback function invoked for each DHCP VSS entry return 0 to break the walk, non-zero otherwise...
Definition: dhcp_proxy.h:231
vlib_main_t * vlib_main
Definition: dhcp_proxy.h:160
vl_api_address_union_t src_address
Definition: ip_types.api:99
int lock
A lock for the pending request DB.
Definition: dhcp_proxy.h:121
u8 * vpn_ascii_id
Type 0 ASCII VPN Identifier.
Definition: dhcp_proxy.h:77
void dhcp_vss_walk(fib_protocol_t proto, dhcp_vss_walk_fn_t fn, void *ctx)
Walk/Visit each DHCP proxy VSS.
Definition: dhcp_proxy.c:87
A representation of a single DHCP Server within a given VRF config.
Definition: dhcp_proxy.h:83
struct dhcp_vss_t_ dhcp_vss_t
The Virtual Sub-net Selection information for a given RX FIB.
int(* dhcp_proxy_walk_fn_t)(dhcp_proxy_t *server, void *ctx)
Callback function invoked for each DHCP proxy entry return 0 to break the walk, non-zero otherwise...
Definition: dhcp_proxy.h:219
int dhcp_proxy_server_del(fib_protocol_t proto, u32 rx_fib_index, ip46_address_t *addr, u32 server_table_id)
Delete a DHCP proxy config.
Definition: dhcp_proxy.c:144
ip46_address_t dhcp_server
The address of the DHCP server to which to relay the client&#39;s messages.
Definition: dhcp_proxy.h:89
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)
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
uword * dhcp_pending
Hash table of pending requets key&#39;d on the clients MAC address.
Definition: dhcp_proxy.h:116
void dhcp_proxy_walk(fib_protocol_t proto, dhcp_proxy_walk_fn_t fn, void *ctx)
Walk/Visit each DHCP proxy server.
Definition: dhcp_proxy.c:67
dhcp_proxy_main_t dhcp_proxy_main
Shard 4/6 instance of DHCP main.
Definition: dhcp_proxy.c:25
int dhcp_proxy_server_add(fib_protocol_t proto, ip46_address_t *addr, ip46_address_t *src_address, u32 rx_fib_iindex, u32 server_table_id)
Add a new DHCP proxy server configuration.
Definition: dhcp_proxy.c:184
A DHCP proxy representation fpr per-client VRF config.
Definition: dhcp_proxy.h:101
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:176
#define vec_len(v)
Number of elements in vector (rvalue-only, NULL tolerant)
u8 vpn_id[7]
Type 1 VPN-ID.
Definition: dhcp_proxy.h:73
u64 uword
Definition: types.h:112
dhcp_vss_t * vss[DHCP_N_PROTOS]
Definition: dhcp_proxy.h:151
u32 dhcp_proxy_rx_table_get_table_id(fib_protocol_t proto, u32 fib_index)
Definition: dhcp_proxy.c:46
void dhcp_proxy_unlock(dhcp_proxy_t *server)
Lock a proxy object to prevent simultaneous access of its pending store.