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 typedef struct
  38 {
  39   dhcp_client_state_t state;
  40
  41   /* the interface in question */
  42   u32 sw_if_index;
  43
  44   /* State machine retry counter */
  45   u32 retry_count;
  46
  47   /* Send next pkt at this time */
  48   f64 next_transmit;
  49   f64 lease_expires;
  50
  51   /* DHCP transaction ID, a random number */
  52   u32 transaction_id;
  53
  54   /* leased address, other learned info DHCP */
  55   ip4_address_t leased_address; /* from your_ip_address field */
  56   ip4_address_t dhcp_server;
  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) */
  63   u8 *option_55_data;
  64
  65   u8 *l2_rewrite;
  66
  67   /* hostname and software client identifiers */
  68   u8 *hostname;
  69   u8 *client_identifier;        /* software version, e.g. vpe 1.0 */
  70
  71   /* Information used for event callback */
  72   u32 client_index;
  73   u32 pid;
  74
  75   /* Set the broadcast Flag in the Discover/Request messages */
  76   u8 set_broadcast_flag;
  77   /* Interface MAC address, so we can do an rx-packet-for-us check */
  78   u8 client_hardware_address[6];
  79   u8 pad1;
  80
  81   void *event_callback;
  82 } dhcp_client_t;
  83
  84 typedef struct
  85 {
  86   /* DHCP client pool */
  87   dhcp_client_t *clients;
  88   uword *client_by_sw_if_index;
  89   u32 seed;
  90
  91   /* convenience */
  92   vlib_main_t *vlib_main;
  93   vnet_main_t *vnet_main;
  94 } dhcp_client_main_t;
  95
  96 typedef struct
  97 {
  98   int is_add;
  99   u32 sw_if_index;
 100   u8 set_broadcast_flag;
 101
 102   /* vectors, consumed by dhcp client code */
 103   u8 *hostname;
 104   u8 *client_identifier;
 105
 106   /* Bytes containing requested option numbers */
 107   u8 *option_55_data;
 108
 109   /* Information used for event callback */
 110   u32 client_index;
 111   u32 pid;
 112   void *event_callback;
 113 } dhcp_client_add_del_args_t;
 114
 115 extern dhcp_client_main_t dhcp_client_main;
 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
 124 int dhcp_client_config (vlib_main_t * vm,
 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  */