src/vnet/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 <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,
  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   u32 lease_renewal_interval;   /* option 51 */
  68   u32 lease_lifetime;           /* option 59 */
  69
  70   /* Requested data (option 55) */
  71   u8 *option_55_data;
  72
  73   u8 *l2_rewrite;
  74
  75   /* hostname and software client identifiers */
  76   u8 *hostname;
  77   u8 *client_identifier;        /* software version, e.g. vpe 1.0 */
  78
  79   /* Information used for event callback */
  80   u32 client_index;
  81   u32 pid;
  82
  83   /* Set the broadcast Flag in the Discover/Request messages */
  84   u8 set_broadcast_flag;
  85   /* Interface MAC address, so we can do an rx-packet-for-us check */
  86   u8 client_hardware_address[6];
  87   u8 client_detect_feature_enabled;
  88
  89   dhcp_event_cb_t event_callback;
  90 } dhcp_client_t;
  91
  92 typedef struct
  93 {
  94   /* DHCP client pool */
  95   dhcp_client_t *clients;
  96   uword *client_by_sw_if_index;
  97   u32 seed;
  98
  99   /* convenience */
 100   vlib_main_t *vlib_main;
 101   vnet_main_t *vnet_main;
 102 } dhcp_client_main_t;
 103
 104 typedef struct
 105 {
 106   int is_add;
 107   u32 sw_if_index;
 108   u8 set_broadcast_flag;
 109
 110   /* vectors, consumed by dhcp client code */
 111   u8 *hostname;
 112   u8 *client_identifier;
 113
 114   /* Bytes containing requested option numbers */
 115   u8 *option_55_data;
 116
 117   /* Information used for event callback */
 118   u32 client_index;
 119   u32 pid;
 120   dhcp_event_cb_t event_callback;
 121 } dhcp_client_add_del_args_t;
 122
 123 extern dhcp_client_main_t dhcp_client_main;
 124
 125 #define EVENT_DHCP_CLIENT_WAKEUP        1
 126
 127 int dhcp_client_for_us (u32 bi0,
 128                         vlib_buffer_t * b0,
 129                         ip4_header_t * ip0,
 130                         udp_header_t * u0, dhcp_header_t * dh0);
 131
 132 /**
 133  * Add/Delete DHCP clients
 134  */
 135 extern int dhcp_client_config (u32 is_add,
 136                                u32 client_index,
 137                                vlib_main_t * vm,
 138                                u32 sw_if_index,
 139                                u8 * hostname,
 140                                u8 * client_id,
 141                                dhcp_event_cb_t event_callback,
 142                                u8 set_broadcast_flag, u32 pid);
 143
 144 /**
 145  * callback function for clients walking the DHCP client configurations
 146  *
 147  * @param client The client being visitsed
 148  * @param data   The data passed during the call to 'walk'
 149  * @return !0 to continue walking 0 to stop.
 150  */
 151 typedef int (*dhcp_client_walk_cb_t) (const dhcp_client_t * client,
 152                                       void *data);
 153
 154 /**
 155  * Walk (visit each) DHCP client configuration
 156  *
 157  * @param cb The callback function invoked as each client is visited
 158  * @param ctx Context data passed back to the client in the invocation of
 159  *             the callback.
 160  */
 161 extern void dhcp_client_walk (dhcp_client_walk_cb_t cb, void *ctx);
 162
 163 #endif /* included_dhcp_client_h */
 164
 165 /*
 166  * fd.io coding-style-patch-verification: ON
 167  *
 168  * Local Variables:
 169  * eval: (c-set-style "gnu")
 170  * End:
 171  */