src/plugins/dhcp/client.h

   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 <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,
  33   foreach_dhcp_client_state
  34 #undef _
  35 } dhcp_client_state_t;
  36
  37 struct dhcp_client_t_;
  38
  39 /**
  40  * Callback function for DHCP complete events
  41  */
  42 typedef void (*dhcp_event_cb_t) (u32 client_index,
  43                                  const struct dhcp_client_t_ * client);
  44
  45 typedef struct dhcp_client_t_
  46 {
  47   dhcp_client_state_t state;
  48
  49   /* the interface in question */
  50   u32 sw_if_index;
  51
  52   /* State machine retry counter */
  53   u32 retry_count;
  54
  55   /* Send next pkt at this time */
  56   f64 next_transmit;
  57   f64 lease_expires;
  58
  59   /* DHCP transaction ID, a random number */
  60   u32 transaction_id;
  61
  62   /* leased address, other learned info DHCP */
  63   ip4_address_t leased_address; /* from your_ip_address field */
  64   ip4_address_t dhcp_server;
  65   u32 subnet_mask_width;        /* option 1 */
  66   ip4_address_t router_address; /* option 3 */
  67   ip4_address_t *domain_server_address; /* option 6 */
  68   u32 lease_renewal_interval;   /* option 51 */
  69   u32 lease_lifetime;           /* option 59 */
  70
  71   /* Requested data (option 55) */
  72   u8 *option_55_data;
  73
  74   /* hostname and software client identifiers */
  75   u8 *hostname;
  76   u8 *client_identifier;        /* software version, e.g. vpe 1.0 */
  77
  78   /* Information used for event callback */
  79   u32 client_index;
  80   u32 pid;
  81
  82   /* Set the broadcast Flag in the Discover/Request messages */
  83   u8 set_broadcast_flag;
  84   /* Interface MAC address, so we can do an rx-packet-for-us check */
  85   u8 client_hardware_address[6];
  86   u8 client_detect_feature_enabled;
  87
  88   /* the unicast adjacency for the DHCP server */
  89   adj_index_t ai_ucast;
  90   /* the broadcast adjacency on the link */
  91   adj_index_t ai_bcast;
  92   /* IP DSCP to set in sent packets */
  93   ip_dscp_t dscp;
  94
  95   dhcp_event_cb_t event_callback;
  96 } dhcp_client_t;
  97
  98 typedef struct
  99 {
 100   /* DHCP client pool */
 101   dhcp_client_t *clients;
 102   uword *client_by_sw_if_index;
 103   u32 seed;
 104
 105   /* convenience */
 106   vlib_main_t *vlib_main;
 107   vnet_main_t *vnet_main;
 108 } dhcp_client_main_t;
 109
 110 typedef struct
 111 {
 112   int is_add;
 113   u32 sw_if_index;
 114   u8 set_broadcast_flag;
 115
 116   /* vectors, consumed by dhcp client code */
 117   u8 *hostname;
 118   u8 *client_identifier;
 119
 120   /* Bytes containing requested option numbers */
 121   u8 *option_55_data;
 122
 123   /* Information used for event callback */
 124   u32 client_index;
 125   u32 pid;
 126   ip_dscp_t dscp;
 127   dhcp_event_cb_t event_callback;
 128 } dhcp_client_add_del_args_t;
 129
 130 extern dhcp_client_main_t dhcp_client_main;
 131
 132 #define EVENT_DHCP_CLIENT_WAKEUP        1
 133
 134 int dhcp_client_for_us (u32 bi0,
 135                         vlib_buffer_t * b0,
 136                         ip4_header_t * ip0,
 137                         udp_header_t * u0, dhcp_header_t * dh0);
 138
 139 /**
 140  * Add/Delete DHCP clients
 141  */
 142 extern int dhcp_client_config (u32 is_add,
 143                                u32 client_index,
 144                                vlib_main_t * vm,
 145                                u32 sw_if_index,
 146                                u8 * hostname,
 147                                u8 * client_id,
 148                                dhcp_event_cb_t event_callback,
 149                                u8 set_broadcast_flag,
 150                                ip_dscp_t dscp, u32 pid);
 151
 152 /**
 153  * callback function for clients walking the DHCP client configurations
 154  *
 155  * @param client The client being visitsed
 156  * @param data   The data passed during the call to 'walk'
 157  * @return !0 to continue walking 0 to stop.
 158  */
 159 typedef int (*dhcp_client_walk_cb_t) (const dhcp_client_t * client,
 160                                       void *data);
 161
 162 /**
 163  * Walk (visit each) DHCP client configuration
 164  *
 165  * @param cb The callback function invoked as each client is visited
 166  * @param ctx Context data passed back to the client in the invocation of
 167  *             the callback.
 168  */
 169 extern void dhcp_client_walk (dhcp_client_walk_cb_t cb, void *ctx);
 170
 171 #endif /* included_dhcp_client_h */
 172
 173 /*
 174  * fd.io coding-style-patch-verification: ON
 175  *
 176  * Local Variables:
 177  * eval: (c-set-style "gnu")
 178  * End:
 179  */