FD.io VPP  v17.04-9-g99c0734
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 <vnet/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 #define dhcp_proxy_error(n,s) DHCP_PROXY_ERROR_##n,
34 #undef dhcp_proxy_error
37 
38 typedef enum {
39 #define dhcpv6_proxy_error(n,s) DHCPV6_PROXY_ERROR_##n,
41 #undef dhcpv6_proxy_error
44 
45 
46 /**
47  * @brief The Virtual Sub-net Selection information for a given RX FIB
48  */
49 typedef struct dhcp_vss_t_ {
50  /**
51  * @brief ?? RFC doesn't say
52  */
54  /**
55  * @brief VPN-ID
56  */
58 } dhcp_vss_t;
59 
60 /**
61  * @brief A representation of a single DHCP Server within a given VRF config
62  */
63 typedef struct dhcp_server_t_
64 {
65  /**
66  * @brief The address of the DHCP server to which to relay the client's
67  * messages
68  */
69  ip46_address_t dhcp_server;
70 
71  /**
72  * @brief The FIB index (not the external Table-ID) in which the server
73  * is reachable.
74  */
77 
78 /**
79  * @brief A DHCP proxy represenation fpr per-client VRF config
80  */
81 typedef struct dhcp_proxy_t_ {
82  /**
83  * @brief The set of DHCP servers to which messages are relayed.
84  * If multiple servers are configured then discover/solict messages
85  * are relayed to each. A cookie is maintained for the relay, and only
86  * one message is replayed to the client, based on the presence of the
87  * cookie.
88  * The expectation is there are only 1 or 2 servers, hence no fancy DB.
89  */
91 
92  /**
93  * @brief Hash table of pending requets key'd on the clients MAC address
94  */
96 
97  /**
98  * @brief A lock for the pending request DB.
99  */
100  int lock;
101 
102  /**
103  * @brief The source address to use in relayed messaes
104  */
105  ip46_address_t dhcp_src_address;
106 
107  /**
108  * @brief The FIB index (not the external Table-ID) in which the client
109  * is resides.
110  */
112 } dhcp_proxy_t;
113 
114 #define DHCP_N_PROTOS (FIB_PROTOCOL_IP6 + 1)
115 
116 /**
117  * @brief Collection of global DHCP proxy data
118  */
119 typedef struct {
120  /* Pool of DHCP servers */
121  dhcp_proxy_t *dhcp_servers[DHCP_N_PROTOS];
122 
123  /* Pool of selected DHCP server. Zero is the default server */
124  u32 * dhcp_server_index_by_rx_fib_index[DHCP_N_PROTOS];
125 
126  /* to drop pkts in server-to-client direction */
128 
130 
131  /* hash lookup specific vrf_id -> option 82 vss suboption */
132  u32 *vss_index_by_rx_fib_index[DHCP_N_PROTOS];
134 
136 
137 /**
138  * @brief Send the details of a proxy session to the API client during a dump
139  */
141  void *opaque,
142  u32 context,
143  dhcp_proxy_t *proxy);
144 
145 /**
146  * @brief Show (on CLI) a VSS config during a show walk
147  */
149  u32 rx_table_id,
150  void *ctx);
151 
152 /**
153  * @brief Configure/set a new VSS info
154  */
156  u32 vrf_id,
157  u32 oui,
158  u32 fib_id,
159  int is_del);
160 
161 /**
162  * @brief Dump the proxy configs to the API
163  */
165  void *opaque,
166  u32 context);
167 
168 /**
169  * @brief Add a new DHCP proxy server configuration.
170  * @return 1 is the config is new,
171  * 0 otherwise (implying a modify of an existing)
172  */
174  ip46_address_t *addr,
175  ip46_address_t *src_address,
176  u32 rx_fib_iindex,
177  u32 server_table_id);
178 
179 /**
180  * @brief Delete a DHCP proxy config
181  * @return 1 if the proxy is deleted, 0 otherwise
182  */
184  u32 rx_fib_index,
185  ip46_address_t *addr,
186  u32 server_table_id);
187 
188 u32
190  u32 fib_index);
191 
192 /**
193  * @brief Callback function invoked for each DHCP proxy entry
194  * return 0 to break the walk, non-zero otherwise.
195  */
196 typedef int (*dhcp_proxy_walk_fn_t)(dhcp_proxy_t *server,
197  void *ctx);
198 
199 /**
200  * @brief Walk/Visit each DHCP proxy server
201  */
204  void *ctx);
205 
206 /**
207  * @brief Callback function invoked for each DHCP VSS entry
208  * return 0 to break the walk, non-zero otherwise.
209  */
210 typedef int (*dhcp_vss_walk_fn_t)(dhcp_vss_t *server,
211  u32 rx_table_id,
212  void *ctx);
213 
214 /**
215  * @brief Walk/Visit each DHCP proxy VSS
216  */
217 void dhcp_vss_walk(fib_protocol_t proto,
219  void *ctx);
220 
221 /**
222  * @brief Lock a proxy object to prevent simultaneous access of its
223  * pending store
224  */
225 void dhcp_proxy_lock (dhcp_proxy_t *server);
226 
227 /**
228  * @brief Lock a proxy object to prevent simultaneous access of its
229  * pending store
230  */
231 void dhcp_proxy_unlock (dhcp_proxy_t *server);
232 
233 /**
234  * @brief Get the VSS data for the FIB index
235  */
236 static inline dhcp_vss_t *
238  u32 rx_fib_index,
239  fib_protocol_t proto)
240 {
241  dhcp_vss_t *v = NULL;
242 
243  if (vec_len(dm->vss_index_by_rx_fib_index[proto]) > rx_fib_index &&
244  dm->vss_index_by_rx_fib_index[proto][rx_fib_index] != ~0)
245  {
246  v = pool_elt_at_index (
247  dm->vss[proto],
248  dm->vss_index_by_rx_fib_index[proto][rx_fib_index]);
249  }
250 
251  return (v);
252 }
253 
254 /**
255  * @brief Get the DHCP proxy server data for the FIB index
256  */
257 static inline dhcp_proxy_t *
259  u32 rx_fib_index,
260  fib_protocol_t proto)
261 {
262  dhcp_proxy_t *s = NULL;
263 
264  if (vec_len(dm->dhcp_server_index_by_rx_fib_index[proto]) > rx_fib_index &&
265  dm->dhcp_server_index_by_rx_fib_index[proto][rx_fib_index] != ~0)
266  {
267  s = pool_elt_at_index (
268  dm->dhcp_servers[proto],
269  dm->dhcp_server_index_by_rx_fib_index[proto][rx_fib_index]);
270  }
271 
272  return (s);
273 }
274 
275 int dhcp6_proxy_set_server (ip46_address_t *addr,
276  ip46_address_t *src_addr,
277  u32 rx_table_id,
278  u32 server_table_id,
279  int is_del);
280 int dhcp4_proxy_set_server (ip46_address_t *addr,
281  ip46_address_t *src_addr,
282  u32 rx_table_id,
283  u32 server_table_id,
284  int is_del);
285 
286 #endif /* included_dhcp_proxy_h */
#define DHCP_N_PROTOS
Definition: dhcp_proxy.h:114
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
void dhcp_proxy_dump(fib_protocol_t proto, void *opaque, u32 context)
Dump the proxy configs to the API.
Definition: dhcp_proxy.c:261
struct dhcp_proxy_t_ dhcp_proxy_t
A DHCP proxy represenation 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:90
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:274
#define NULL
Definition: clib.h:55
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:105
The Virtual Sub-net Selection information for a given RX FIB.
Definition: dhcp_proxy.h:49
u32 * dhcp_server_index_by_rx_fib_index[DHCP_N_PROTOS]
Definition: dhcp_proxy.h:124
u32 rx_fib_index
The FIB index (not the external Table-ID) in which the client is resides.
Definition: dhcp_proxy.h:111
u32 oui
?? RFC doesn&#39;t say
Definition: dhcp_proxy.h:53
void dhcp_proxy_lock(dhcp_proxy_t *server)
Lock a proxy object to prevent simultaneous access of its pending store.
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:258
u32 * vss_index_by_rx_fib_index[DHCP_N_PROTOS]
Definition: dhcp_proxy.h:132
dhcp_proxy_error_t
Definition: dhcp_proxy.h:31
dhcp_proxy_t * dhcp_servers[DHCP_N_PROTOS]
Definition: dhcp_proxy.h:121
int dhcp_proxy_set_vss(fib_protocol_t proto, u32 vrf_id, u32 oui, u32 fib_id, int is_del)
Configure/set a new VSS info.
Definition: dhcp_proxy.c:288
dhcpv6_proxy_error_t
Definition: dhcp_proxy.h:38
u32 server_fib_index
The FIB index (not the external Table-ID) in which the server is reachable.
Definition: dhcp_proxy.h:75
Collection of global DHCP proxy data.
Definition: dhcp_proxy.h:119
#define pool_elt_at_index(p, i)
Returns pointer to element at given index.
Definition: pool.h:397
#define v
Definition: acl.c:246
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:210
u32 fib_id
VPN-ID.
Definition: dhcp_proxy.h:57
int lock
A lock for the pending request DB.
Definition: dhcp_proxy.h:100
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:92
A representation of a single DHCP Server within a given VRF config.
Definition: dhcp_proxy.h:63
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:196
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:152
ip46_address_t dhcp_server
The address of the DHCP server to which to relay the client&#39;s messages.
Definition: dhcp_proxy.h:69
unsigned int u32
Definition: types.h:88
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)
uword * dhcp_pending
Hash table of pending requets key&#39;d on the clients MAC address.
Definition: dhcp_proxy.h:95
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:70
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:192
u64 uword
Definition: types.h:112
A DHCP proxy represenation fpr per-client VRF config.
Definition: dhcp_proxy.h:81
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:122
#define vec_len(v)
Number of elements in vector (rvalue-only, NULL tolerant)
dhcp_vss_t * vss[DHCP_N_PROTOS]
Definition: dhcp_proxy.h:129
u32 dhcp_proxy_rx_table_get_table_id(fib_protocol_t proto, u32 fib_index)
Definition: dhcp_proxy.c:48
void dhcp_proxy_unlock(dhcp_proxy_t *server)
Lock a proxy object to prevent simultaneous access of its pending store.
vhost_vring_addr_t addr
Definition: vhost-user.h:84