aboutsummaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorNeale Ranns <neale.ranns@cisco.com>2018-05-16 04:12:18 -0700
committerNeale Ranns <nranns@cisco.com>2018-06-07 03:11:10 -0400
commitdaff1784037376f4a5caec2f5975f9b5fc23d5a4 (patch)
tree186701f7fcd64d691de5b5d11b477a5d8b7840a2 /src
parent0e969ac8431c80ff4bca5f6985876b1c584eefcd (diff)
DHCP Client Dump
- use types on the DHCP API so that the same data is sent in comfing messages and in dumps - add the DHCP client dump API - update VOM to refelct API changes - rename VOM class dhcp_config* dhcp_client* - the VOM dhcp_client class maintains the lease data (which it reads on a dump) for clients to read Change-Id: I2a43463937cbd80c01d45798e74b21288d8b8ead Signed-off-by: Neale Ranns <neale.ranns@cisco.com>
Diffstat (limited to 'src')
-rw-r--r--src/vat/api_format.c19
-rw-r--r--src/vnet/dhcp/client.c34
-rw-r--r--src/vnet/dhcp/client.h51
-rw-r--r--src/vnet/dhcp/dhcp.api71
-rw-r--r--src/vnet/dhcp/dhcp_api.c135
-rw-r--r--src/vpp/api/custom_dump.c8
6 files changed, 245 insertions, 73 deletions
diff --git a/src/vat/api_format.c b/src/vat/api_format.c
index dfb0284955e..f17802d778f 100644
--- a/src/vat/api_format.c
+++ b/src/vat/api_format.c
@@ -2669,10 +2669,11 @@ vl_api_dhcp_compl_event_t_handler (vl_api_dhcp_compl_event_t * mp)
{
errmsg ("DHCP compl event: pid %d %s hostname %s host_addr %U "
"router_addr %U host_mac %U",
- ntohl (mp->pid), mp->is_ipv6 ? "ipv6" : "ipv4", mp->hostname,
- format_ip4_address, &mp->host_address,
- format_ip4_address, &mp->router_address,
- format_ethernet_address, mp->host_mac);
+ ntohl (mp->pid), mp->lease.is_ipv6 ? "ipv6" : "ipv4",
+ mp->lease.hostname,
+ format_ip4_address, &mp->lease.host_address,
+ format_ip4_address, &mp->lease.router_address,
+ format_ethernet_address, mp->lease.host_mac);
}
static void vl_api_dhcp_compl_event_t_handler_json
@@ -10125,12 +10126,12 @@ api_dhcp_client_config (vat_main_t * vam)
/* Construct the API message */
M (DHCP_CLIENT_CONFIG, mp);
- mp->sw_if_index = htonl (sw_if_index);
- clib_memcpy (mp->hostname, hostname, vec_len (hostname));
- vec_free (hostname);
mp->is_add = is_add;
- mp->want_dhcp_event = disable_event ? 0 : 1;
- mp->pid = htonl (getpid ());
+ mp->client.sw_if_index = htonl (sw_if_index);
+ clib_memcpy (mp->client.hostname, hostname, vec_len (hostname));
+ vec_free (hostname);
+ mp->client.want_dhcp_event = disable_event ? 0 : 1;
+ mp->client.pid = htonl (getpid ());
/* send it... */
S (mp);
diff --git a/src/vnet/dhcp/client.c b/src/vnet/dhcp/client.c
index 11e47f9ad7a..98f212334f6 100644
--- a/src/vnet/dhcp/client.c
+++ b/src/vnet/dhcp/client.c
@@ -100,7 +100,6 @@ static void
dhcp_client_addr_callback (dhcp_client_t * c)
{
dhcp_client_main_t *dcm = &dhcp_client_main;
- void (*fp) (u32, u32, u8 *, u8, u8, u8 *, u8 *, u8 *) = c->event_callback;
/* disable the feature */
vnet_feature_enable_disable ("ip4-unicast",
@@ -147,12 +146,8 @@ dhcp_client_addr_callback (dhcp_client_t * c)
/*
* Call the user's event callback to report DHCP information
*/
- if (fp)
- (*fp) (c->client_index, /* clinet index */
- c->pid, c->hostname, c->subnet_mask_width, 0, /* is_ipv6 */
- (u8 *) & c->leased_address, /* host IP address */
- (u8 *) & c->router_address, /* router IP address */
- (u8 *) (c->l2_rewrite + 6)); /* host MAC address */
+ if (c->event_callback)
+ c->event_callback (c->client_index, c);
}
/*
@@ -977,13 +972,14 @@ dhcp_client_add_del (dhcp_client_add_del_args_t * a)
}
int
-dhcp_client_config (vlib_main_t * vm,
+dhcp_client_config (u32 is_add,
+ u32 client_index,
+ 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)
+ dhcp_event_cb_t event_callback,
+ u8 set_broadcast_flag, u32 pid)
{
dhcp_client_add_del_args_t _a, *a = &_a;
int rv;
@@ -1061,6 +1057,22 @@ dhcp_client_config (vlib_main_t * vm,
return rv;
}
+void
+dhcp_client_walk (dhcp_client_walk_cb_t cb, void *ctx)
+{
+ dhcp_client_main_t *dcm = &dhcp_client_main;
+ dhcp_client_t *c;
+
+ /* *INDENT-OFF* */
+ pool_foreach (c, dcm->clients,
+ ({
+ if (!cb(c, ctx))
+ break;
+ }));
+ /* *INDENT-ON* */
+
+}
+
static clib_error_t *
dhcp_client_set_command_fn (vlib_main_t * vm,
unformat_input_t * input,
diff --git a/src/vnet/dhcp/client.h b/src/vnet/dhcp/client.h
index d3be3ebf271..72cbf66733f 100644
--- a/src/vnet/dhcp/client.h
+++ b/src/vnet/dhcp/client.h
@@ -34,7 +34,15 @@ typedef enum
#undef _
} dhcp_client_state_t;
-typedef struct
+struct dhcp_client_t_;
+
+/**
+ * Callback function for DHCP complete events
+ */
+typedef void (*dhcp_event_cb_t) (u32 client_index,
+ const struct dhcp_client_t_ * client);
+
+typedef struct dhcp_client_t_
{
dhcp_client_state_t state;
@@ -78,7 +86,7 @@ typedef struct
u8 client_hardware_address[6];
u8 client_detect_feature_enabled;
- void *event_callback;
+ dhcp_event_cb_t event_callback;
} dhcp_client_t;
typedef struct
@@ -109,7 +117,7 @@ typedef struct
/* Information used for event callback */
u32 client_index;
u32 pid;
- void *event_callback;
+ dhcp_event_cb_t event_callback;
} dhcp_client_add_del_args_t;
extern dhcp_client_main_t dhcp_client_main;
@@ -121,13 +129,36 @@ int dhcp_client_for_us (u32 bi0,
ip4_header_t * ip0,
udp_header_t * u0, dhcp_header_t * dh0);
-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);
+/**
+ * Add/Delete DHCP clients
+ */
+extern int dhcp_client_config (u32 is_add,
+ u32 client_index,
+ vlib_main_t * vm,
+ u32 sw_if_index,
+ u8 * hostname,
+ u8 * client_id,
+ dhcp_event_cb_t event_callback,
+ u8 set_broadcast_flag, u32 pid);
+
+/**
+ * callback function for clients walking the DHCP client configurations
+ *
+ * @param client The client being visitsed
+ * @param data The data passed during the call to 'walk'
+ * @return !0 to continue walking 0 to stop.
+ */
+typedef int (*dhcp_client_walk_cb_t) (const dhcp_client_t * client,
+ void *data);
+
+/**
+ * Walk (visit each) DHCP client configuration
+ *
+ * @param cb The callback function invoked as each client is visited
+ * @param ctx Context data passed back to the client in the invocation of
+ * the callback.
+ */
+extern void dhcp_client_walk (dhcp_client_walk_cb_t cb, void *ctx);
#endif /* included_dhcp_client_h */
diff --git a/src/vnet/dhcp/dhcp.api b/src/vnet/dhcp/dhcp.api
index 975aa6ee9e7..30ead320089 100644
--- a/src/vnet/dhcp/dhcp.api
+++ b/src/vnet/dhcp/dhcp.api
@@ -13,7 +13,7 @@
* limitations under the License.
*/
-option version = "1.0.1";
+option version = "2.0.0";
/** \brief DHCP Proxy config add / del request
@param client_index - opaque cookie to identify the sender
@@ -62,45 +62,53 @@ autoreply define dhcp_proxy_set_vss
u8 is_add;
};
-/** \brief DHCP Client config add / del request
- @param client_index - opaque cookie to identify the sender
- @param context - sender context, to match reply w/ request
+/** \brief DHCP Client config data
@param sw_if_index - index of the interface for DHCP client
@param hostname - hostname
- @param client_id - Client ID - option 61
- @param is_add - add the config if non-zero, else delete
+ @param id - Client ID - option 61
@param want_dhcp_event - DHCP event sent to the sender
via dhcp_compl_event API message if non-zero
@param set_broadcast_flag - in the DHCP Discover to control
how the resulting OFFER is addressed.
@param pid - sender's pid
*/
-autoreply define dhcp_client_config
+typeonly define dhcp_client
{
- u32 client_index;
- u32 context;
u32 sw_if_index;
u8 hostname[64];
- u8 client_id[64];
- u8 is_add;
+ u8 id[64];
u8 want_dhcp_event;
u8 set_broadcast_flag;
u32 pid;
};
-/** \brief Tell client about a DHCP completion event
+/** \brief DHCP Client config add / del request
@param client_index - opaque cookie to identify the sender
- @param pid - client pid registered to receive notification
+ @param context - sender context, to match reply w/ request
+ @param is_add - add the config if non-zero, else delete
+ @param client - client configuration data
+*/
+autoreply define dhcp_client_config
+{
+ u32 client_index;
+ u32 context;
+ u8 is_add;
+ vl_api_dhcp_client_t client;
+};
+
+/** \brief Data learned by the client during the DHCP process
+ @param sw_if_index - the interface on which the client is configured
+ @param state - the state of the lease (see dhcp_client_state_t)
@param is_ipv6 - if non-zero the address is ipv6, else ipv4
@param mask_width - The length of the subnet mask assigned
@param host_address - Host IP address
@param router_address - Router IP address
@param host_mac - Host MAC address
*/
-define dhcp_compl_event
+typeonly define dhcp_lease
{
- u32 client_index;
- u32 pid;
+ u32 sw_if_index;
+ u8 state;
u8 hostname[64];
u8 is_ipv6;
u8 mask_width;
@@ -109,10 +117,41 @@ define dhcp_compl_event
u8 host_mac[6];
};
+/** \brief Tell client about a DHCP completion event
+ @param client_index - opaque cookie to identify the sender
+ @param pid - client pid registered to receive notification
+ @param lease - Data learned during the DHCP process;
+*/
+define dhcp_compl_event
+{
+ u32 client_index;
+ u32 pid;
+ vl_api_dhcp_lease_t lease;
+};
+
service {
rpc dhcp_client_config returns dhcp_client_config_reply events dhcp_compl_event;
};
+/** \brief Dump the DHCP client configurations
+ */
+define dhcp_client_dump
+{
+ u32 client_index;
+ u32 context;
+};
+
+/** \brief DHCP Client details returned from dump
+ * @param client - The configured client
+ * @param lease - The learned lease data
+ */
+define dhcp_client_details
+{
+ u32 context;
+ vl_api_dhcp_client_t client;
+ vl_api_dhcp_lease_t lease;
+};
+
/** \brief Dump DHCP proxy table
@param client_index - opaque cookie to identify the sender
@param True for IPv6 proxy table
diff --git a/src/vnet/dhcp/dhcp_api.c b/src/vnet/dhcp/dhcp_api.c
index 401f6b75edc..1dacf1178c2 100644
--- a/src/vnet/dhcp/dhcp_api.c
+++ b/src/vnet/dhcp/dhcp_api.c
@@ -48,7 +48,8 @@
_(DHCP_PROXY_CONFIG,dhcp_proxy_config) \
_(DHCP_PROXY_DUMP,dhcp_proxy_dump) \
_(DHCP_PROXY_SET_VSS,dhcp_proxy_set_vss) \
-_(DHCP_CLIENT_CONFIG, dhcp_client_config)
+_(DHCP_CLIENT_CONFIG, dhcp_client_config) \
+_(DHCP_CLIENT_DUMP, dhcp_client_dump)
static void
@@ -203,14 +204,56 @@ dhcp_send_details (fib_protocol_t proto,
vl_api_send_msg (reg, (u8 *) mp);
}
-void
-dhcp_compl_event_callback (u32 client_index, u32 pid, u8 * hostname,
- u8 mask_width, u8 is_ipv6, u8 * host_address,
- u8 * router_address, u8 * host_mac)
+static void
+dhcp_client_lease_encode (vl_api_dhcp_lease_t * lease,
+ const dhcp_client_t * client)
+{
+ size_t len;
+
+ lease->is_ipv6 = 0; // only support IPv6 clients
+ lease->sw_if_index = ntohl (client->sw_if_index);
+ lease->state = client->state;
+ len = clib_min (sizeof (lease->hostname) - 1, vec_len (client->hostname));
+ clib_memcpy (&lease->hostname, client->hostname, len);
+ lease->hostname[len] = 0;
+
+ lease->mask_width = client->subnet_mask_width;
+ clib_memcpy (&lease->host_address[0], (u8 *) & client->leased_address, 4);
+ clib_memcpy (&lease->router_address[0], (u8 *) & client->router_address, 4);
+
+ if (NULL != client->l2_rewrite)
+ clib_memcpy (&lease->host_mac[0], client->l2_rewrite + 6, 6);
+}
+
+static void
+dhcp_client_data_encode (vl_api_dhcp_client_t * vclient,
+ const dhcp_client_t * client)
+{
+ size_t len;
+
+ vclient->sw_if_index = ntohl (client->sw_if_index);
+ len = clib_min (sizeof (vclient->hostname) - 1, vec_len (client->hostname));
+ clib_memcpy (&vclient->hostname, client->hostname, len);
+ vclient->hostname[len] = 0;
+
+ len = clib_min (sizeof (vclient->id) - 1,
+ vec_len (client->client_identifier));
+ clib_memcpy (&vclient->id, client->client_identifier, len);
+ vclient->id[len] = 0;
+
+ if (NULL != client->event_callback)
+ vclient->want_dhcp_event = 1;
+ else
+ vclient->want_dhcp_event = 0;
+ vclient->set_broadcast_flag = client->set_broadcast_flag;
+ vclient->pid = client->pid;
+}
+
+static void
+dhcp_compl_event_callback (u32 client_index, const dhcp_client_t * client)
{
vl_api_registration_t *reg;
vl_api_dhcp_compl_event_t *mp;
- u32 len;
reg = vl_api_client_index_to_registration (client_index);
if (!reg)
@@ -218,17 +261,8 @@ dhcp_compl_event_callback (u32 client_index, u32 pid, u8 * hostname,
mp = vl_msg_api_alloc (sizeof (*mp));
mp->client_index = client_index;
- mp->pid = pid;
- mp->is_ipv6 = is_ipv6;
- len = (vec_len (hostname) < 63) ? vec_len (hostname) : 63;
- clib_memcpy (&mp->hostname, hostname, len);
- mp->hostname[len] = 0;
- mp->mask_width = mask_width;
- clib_memcpy (&mp->host_address[0], host_address, 16);
- clib_memcpy (&mp->router_address[0], router_address, 16);
-
- if (NULL != host_mac)
- clib_memcpy (&mp->host_mac[0], host_mac, 6);
+ mp->pid = client->pid;
+ dhcp_client_lease_encode (&mp->lease, client);
mp->_vl_msg_id = ntohs (VL_API_DHCP_COMPL_EVENT);
@@ -240,21 +274,76 @@ static void vl_api_dhcp_client_config_t_handler
{
vlib_main_t *vm = vlib_get_main ();
vl_api_dhcp_client_config_reply_t *rmp;
+ u32 sw_if_index;
int rv = 0;
- VALIDATE_SW_IF_INDEX (mp);
+ sw_if_index = ntohl (mp->client.sw_if_index);
+ if (!vnet_sw_if_index_is_api_valid (sw_if_index))
+ {
+ rv = VNET_API_ERROR_INVALID_SW_IF_INDEX;
+ goto bad_sw_if_index;
+ }
- rv = dhcp_client_config (vm, ntohl (mp->sw_if_index),
- mp->hostname, mp->client_id,
- mp->is_add, mp->client_index,
- mp->want_dhcp_event ? dhcp_compl_event_callback :
- NULL, mp->set_broadcast_flag, mp->pid);
+ rv = dhcp_client_config (mp->is_add,
+ mp->client_index,
+ vm,
+ sw_if_index,
+ mp->client.hostname,
+ mp->client.id,
+ (mp->client.want_dhcp_event ?
+ dhcp_compl_event_callback :
+ NULL),
+ mp->client.set_broadcast_flag, mp->client.pid);
BAD_SW_IF_INDEX_LABEL;
REPLY_MACRO (VL_API_DHCP_CLIENT_CONFIG_REPLY);
}
+typedef struct dhcp_client_send_walk_ctx_t_
+{
+ vl_api_registration_t *reg;
+ u32 context;
+} dhcp_client_send_walk_ctx_t;
+
+static int
+send_dhcp_client_entry (const dhcp_client_t * client, void *arg)
+{
+ dhcp_client_send_walk_ctx_t *ctx;
+ vl_api_dhcp_client_details_t *mp;
+
+ ctx = arg;
+
+ mp = vl_msg_api_alloc (sizeof (*mp));
+ memset (mp, 0, sizeof (*mp));
+
+ mp->_vl_msg_id = ntohs (VL_API_DHCP_CLIENT_DETAILS);
+ mp->context = ctx->context;
+
+ dhcp_client_data_encode (&mp->client, client);
+ dhcp_client_lease_encode (&mp->lease, client);
+
+ vl_api_send_msg (ctx->reg, (u8 *) mp);
+
+ return (1);
+}
+
+static void
+vl_api_dhcp_client_dump_t_handler (vl_api_dhcp_client_dump_t * mp)
+{
+ vl_api_registration_t *reg;
+
+ reg = vl_api_client_index_to_registration (mp->client_index);
+ if (!reg)
+ return;
+
+ dhcp_client_send_walk_ctx_t ctx = {
+ .reg = reg,
+ .context = mp->context,
+ };
+ dhcp_client_walk (send_dhcp_client_entry, &ctx);
+}
+
/*
* dhcp_api_hookup
* Add vpe's API message handlers to the table.
diff --git a/src/vpp/api/custom_dump.c b/src/vpp/api/custom_dump.c
index 4c88b8ff959..e8d143b3609 100644
--- a/src/vpp/api/custom_dump.c
+++ b/src/vpp/api/custom_dump.c
@@ -1011,13 +1011,13 @@ static void *vl_api_dhcp_client_config_t_print
s = format (0, "SCRIPT: dhcp_client_config ");
- s = format (s, "sw_if_index %d ", ntohl (mp->sw_if_index));
+ s = format (s, "sw_if_index %d ", ntohl (mp->client.sw_if_index));
- s = format (s, "hostname %s ", mp->hostname);
+ s = format (s, "hostname %s ", mp->client.hostname);
- s = format (s, "want_dhcp_event %d ", mp->want_dhcp_event);
+ s = format (s, "want_dhcp_event %d ", mp->client.want_dhcp_event);
- s = format (s, "pid %d ", ntohl (mp->pid));
+ s = format (s, "pid %d ", ntohl (mp->client.pid));
if (mp->is_add == 0)
s = format (s, "del ");