FD.io VPP  v18.04-17-g3a0d853
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 #include <vnet/ip/ip.h>
23 #include <vnet/dhcp/dhcp4_packet.h>
24 
25 #define foreach_dhcp_client_state \
26 _(DHCP_DISCOVER) \
27 _(DHCP_REQUEST) \
28 _(DHCP_BOUND)
29 
30 typedef enum
31 {
32 #define _(a) a,
34 #undef _
36 
37 typedef struct
38 {
40 
41  /* the interface in question */
43 
44  /* State machine retry counter */
46 
47  /* Send next pkt at this time */
50 
51  /* DHCP transaction ID, a random number */
53 
54  /* leased address, other learned info DHCP */
55  ip4_address_t leased_address; /* from your_ip_address field */
57  u32 subnet_mask_width; /* option 1 */
58  ip4_address_t router_address; /* option 3 */
59  u32 lease_renewal_interval; /* option 51 */
60  u32 lease_lifetime; /* option 59 */
61 
62  /* Requested data (option 55) */
64 
66 
67  /* hostname and software client identifiers */
69  u8 *client_identifier; /* software version, e.g. vpe 1.0 */
70 
71  /* Information used for event callback */
74 
75  /* Set the broadcast Flag in the Discover/Request messages */
77  /* Interface MAC address, so we can do an rx-packet-for-us check */
78  u8 client_hardware_address[6];
80 
83 
84 typedef struct
85 {
86  /* DHCP client pool */
90 
91  /* convenience */
95 
96 typedef struct
97 {
98  int is_add;
101 
102  /* vectors, consumed by dhcp client code */
105 
106  /* Bytes containing requested option numbers */
108 
109  /* Information used for event callback */
114 
116 
117 #define EVENT_DHCP_CLIENT_WAKEUP 1
118 
119 int dhcp_client_for_us (u32 bi0,
120  vlib_buffer_t * b0,
121  ip4_header_t * ip0,
122  udp_header_t * u0, dhcp_header_t * dh0);
123 
125  u32 sw_if_index,
126  u8 * hostname,
127  u8 * client_id,
128  u32 is_add,
129  u32 client_index,
130  void *event_callback, u8 set_broadcast_flag, u32 pid);
131 
132 #endif /* included_dhcp_client_h */
133 
134 /*
135  * fd.io coding-style-patch-verification: ON
136  *
137  * Local Variables:
138  * eval: (c-set-style "gnu")
139  * End:
140  */
dhcp_client_main_t dhcp_client_main
Definition: client.c:20
u32 retry_count
Definition: client.h:45
f64 next_transmit
Definition: client.h:48
u32 transaction_id
Definition: client.h:52
u8 * hostname
Definition: client.h:68
dhcp_client_t * clients
Definition: client.h:87
u32 lease_lifetime
Definition: client.h:60
u8 * l2_rewrite
Definition: client.h:65
#define foreach_dhcp_client_state
Definition: client.h:25
u32 client_index
Definition: client.h:72
u8 set_broadcast_flag
Definition: client.h:76
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, u8 set_broadcast_flag, u32 pid)
Definition: client.c:964
dhcp_client_state_t
Definition: client.h:30
vlib_main_t * vlib_main
Definition: client.h:92
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:165
u32 subnet_mask_width
Definition: client.h:57
vlib_main_t * vm
Definition: buffer.c:294
dhcp_client_state_t state
Definition: client.h:39
u8 * option_55_data
Definition: client.h:63
unsigned int u32
Definition: types.h:88
u32 lease_renewal_interval
Definition: client.h:59
u32 sw_if_index
Definition: client.h:42
u64 uword
Definition: types.h:112
f64 lease_expires
Definition: client.h:49
double f64
Definition: types.h:142
unsigned char u8
Definition: types.h:56
ip4_address_t dhcp_server
Definition: client.h:56
uword * client_by_sw_if_index
Definition: client.h:88
void * event_callback
Definition: client.h:81
ip4_address_t router_address
Definition: client.h:58
vnet_main_t * vnet_main
Definition: client.h:93
ip4_address_t leased_address
Definition: client.h:55
u8 * client_identifier
Definition: client.h:69