FD.io VPP  v17.01.1-3-gc6833f8
Vector Packet Processing
client.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2015 Cisco and/or its affiliates.
3  * Licensed under the Apache License, Version 2.0 (the "License");
4  * you may not use this file except in compliance with the License.
5  * You may obtain a copy of the License at:
6  *
7  * http://www.apache.org/licenses/LICENSE-2.0
8  *
9  * Unless required by applicable law or agreed to in writing, software
10  * distributed under the License is distributed on an "AS IS" BASIS,
11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12  * See the License for the specific language governing permissions and
13  * limitations under the License.
14  */
15 /*
16  * client.h: dhcp client
17  */
18 
19 #ifndef included_dhcp_client_h
20 #define included_dhcp_client_h
21 
22 #define foreach_dhcp_client_state \
23 _(DHCP_DISCOVER) \
24 _(DHCP_REQUEST) \
25 _(DHCP_BOUND)
26 
27 typedef enum {
28 #define _(a) a,
30 #undef _
32 
33 typedef struct {
35 
36  /* the interface in question */
38 
39  /* State machine retry counter */
41 
42  /* Send next pkt at this time */
45 
46  /* DHCP transaction ID, a random number */
48 
49  /* leased address, other learned info DHCP */
50  ip4_address_t leased_address; /* from your_ip_address field */
52  u32 subnet_mask_width; /* option 1 */
53  ip4_address_t router_address; /* option 3 */
54  u32 lease_renewal_interval; /* option 51 */
55  u32 lease_lifetime; /* option 59 */
56 
57  /* Requested data (option 55) */
59 
61 
62  /* hostname and software client identifiers */
64  u8 * client_identifier; /* software version, e.g. vpe 1.0*/
65 
66  /* Information used for event callback */
71 
72 typedef struct {
73  /* DHCP client pool */
77 
78  /* convenience */
82 
83 typedef struct {
84  int is_add;
86 
87  /* vectors, consumed by dhcp client code */
90 
91  /* Bytes containing requested option numbers */
93 
94  /* Information used for event callback */
99 
101 
102 #define EVENT_DHCP_CLIENT_WAKEUP 1
103 
104 int dhcp_client_for_us (u32 bi0,
105  vlib_buffer_t * b0,
106  ip4_header_t * ip0,
107  udp_header_t * u0,
108  dhcp_header_t * dh0);
109 
111  u32 sw_if_index,
112  u8 * hostname,
113  u32 is_add,
114  u32 client_index,
115  void *event_callback,
116  u32 pid);
117 
118 #endif /* included_dhcp_client_h */
dhcp_client_main_t dhcp_client_main
Definition: client.h:100
u32 retry_count
Definition: client.h:40
f64 next_transmit
Definition: client.h:43
u32 transaction_id
Definition: client.h:47
u8 * hostname
Definition: client.h:63
dhcp_client_t * clients
Definition: client.h:74
u32 lease_lifetime
Definition: client.h:55
u8 * l2_rewrite
Definition: client.h:60
#define foreach_dhcp_client_state
Definition: client.h:22
u32 client_index
Definition: client.h:67
dhcp_client_state_t
Definition: client.h:27
vlib_main_t * vlib_main
Definition: client.h:79
int dhcp_client_for_us(u32 bi0, vlib_buffer_t *b0, ip4_header_t *ip0, udp_header_t *u0, dhcp_header_t *dh0)
Definition: client.c:65
u32 subnet_mask_width
Definition: client.h:52
dhcp_client_state_t state
Definition: client.h:34
u8 * option_55_data
Definition: client.h:58
unsigned int u32
Definition: types.h:88
u32 lease_renewal_interval
Definition: client.h:54
u32 sw_if_index
Definition: client.h:37
int dhcp_client_config(vlib_main_t *vm, u32 sw_if_index, u8 *hostname, u32 is_add, u32 client_index, void *event_callback, u32 pid)
Definition: client.c:836
u64 uword
Definition: types.h:112
f64 lease_expires
Definition: client.h:44
double f64
Definition: types.h:142
unsigned char u8
Definition: types.h:56
ip4_address_t dhcp_server
Definition: client.h:51
uword * client_by_sw_if_index
Definition: client.h:75
void * event_callback
Definition: client.h:69
ip4_address_t router_address
Definition: client.h:53
vnet_main_t * vnet_main
Definition: client.h:80
ip4_address_t leased_address
Definition: client.h:50
u8 * client_identifier
Definition: client.h:64