blob: d15e686b6366107b928287be30cd9585e9bcf912 [file] [log] [blame]
Ed Warnickecb9cada2015-12-08 15:45:58 -07001/*
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
27typedef enum {
28#define _(a) a,
29 foreach_dhcp_client_state
30#undef _
31} dhcp_client_state_t;
32
33typedef struct {
34 dhcp_client_state_t state;
35
36 /* the interface in question */
37 u32 sw_if_index;
38
39 /* State machine retry counter */
40 u32 retry_count;
41
42 /* Send next pkt at this time */
43 f64 next_transmit;
44 f64 lease_expires;
45
46 /* DHCP transaction ID, a random number */
47 u32 transaction_id;
48
49 /* leased address, other learned info DHCP */
50 ip4_address_t leased_address; /* from your_ip_address field */
51 ip4_address_t dhcp_server;
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) */
58 u8 * option_55_data;
59
60 u8 * l2_rewrite;
61
62 /* hostname and software client identifiers */
63 u8 * hostname;
64 u8 * client_identifier; /* software version, e.g. vpe 1.0*/
65
66 /* Information used for event callback */
67 u32 client_index;
68 u32 pid;
69 void * event_callback;
70} dhcp_client_t;
71
72typedef struct {
73 /* DHCP client pool */
74 dhcp_client_t * clients;
75 uword * client_by_sw_if_index;
76 u32 seed;
77
78 /* convenience */
79 vlib_main_t * vlib_main;
80 vnet_main_t * vnet_main;
81} dhcp_client_main_t;
82
83typedef struct {
84 int is_add;
85 u32 sw_if_index;
86
87 /* vectors, consumed by dhcp client code */
88 u8 * hostname;
89 u8 * client_identifier;
90
91 /* Bytes containing requested option numbers */
92 u8 * option_55_data;
93
94 /* Information used for event callback */
95 u32 client_index;
96 u32 pid;
97 void * event_callback;
98} dhcp_client_add_del_args_t;
99
100dhcp_client_main_t dhcp_client_main;
101
102#define EVENT_DHCP_CLIENT_WAKEUP 1
103
104int 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
110int dhcp_client_config (vlib_main_t * vm,
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 */