2 *------------------------------------------------------------------
3 * punt_api.c - Punt api
5 * Copyright (c) 2016 Cisco and/or its affiliates.
6 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at:
10 * http://www.apache.org/licenses/LICENSE-2.0
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
17 *------------------------------------------------------------------
20 #include <vnet/vnet.h>
21 #include <vlibmemory/api.h>
22 #include <vnet/ip/punt.h>
23 #include <vnet/ip/ip_types_api.h>
25 #include <vnet/vnet_msg_enum.h>
27 #define vl_typedefs /* define message structures */
28 #include <vnet/vnet_all_api_h.h>
31 #define vl_endianfun /* define message structures */
32 #include <vnet/vnet_all_api_h.h>
35 /* instantiate all the print functions we know about */
36 #define vl_print(handle, ...) vlib_cli_output (handle, __VA_ARGS__)
38 #include <vnet/vnet_all_api_h.h>
41 #include <vlibapi/api_helper_macros.h>
43 #define foreach_punt_api_msg \
44 _(SET_PUNT, set_punt) \
45 _(PUNT_SOCKET_REGISTER, punt_socket_register) \
46 _(PUNT_SOCKET_DEREGISTER, punt_socket_deregister) \
47 _(PUNT_SOCKET_DUMP, punt_socket_dump) \
48 _(PUNT_REASON_DUMP, punt_reason_dump)
51 vl_api_punt_type_decode (vl_api_punt_type_t in, punt_type_t * out)
53 in = clib_net_to_host_u32 (in);
58 case PUNT_API_TYPE_##v: \
59 *out = PUNT_TYPE_##v; \
68 static vl_api_punt_type_t
69 vl_api_punt_type_encode (punt_type_t in)
71 vl_api_punt_type_t pt = PUNT_API_TYPE_L4;
77 pt = PUNT_API_TYPE_##v; \
83 return (clib_host_to_net_u32 (pt));
87 vl_api_punt_l4_decode (const vl_api_punt_l4_t * in, punt_l4_t * out)
91 rv = ip_address_family_decode (in->af, &out->af);
92 rv += ip_proto_decode (in->protocol, &out->protocol);
93 out->port = clib_net_to_host_u16 (in->port);
99 vl_api_punt_exception_decode (const vl_api_punt_exception_t * in,
100 punt_exception_t * out)
104 out->reason = clib_net_to_host_u32 (in->id);
105 rv = vlib_punt_reason_validate (out->reason);
111 vl_api_punt_decode (const vl_api_punt_t * in, punt_reg_t * out)
115 rv = vl_api_punt_type_decode (in->type, &out->type);
123 return (vl_api_punt_l4_decode (&in->punt.l4, &out->punt.l4));
124 case PUNT_TYPE_EXCEPTION:
125 return (vl_api_punt_exception_decode (&in->punt.exception,
126 &out->punt.exception));
133 vl_api_punt_l4_encode (const punt_l4_t * in, vl_api_punt_l4_t * out)
135 out->af = ip_address_family_encode (in->af);
136 out->protocol = ip_proto_encode (in->protocol);
137 out->port = clib_net_to_host_u16 (in->port);
141 vl_api_punt_exception_encode (const punt_exception_t * in,
142 vl_api_punt_exception_t * out)
144 out->id = clib_host_to_net_u32 (in->reason);
148 vl_api_punt_encode (const punt_reg_t * in, vl_api_punt_t * out)
150 out->type = vl_api_punt_type_encode (in->type);
155 vl_api_punt_l4_encode (&in->punt.l4, &out->punt.l4);
157 case PUNT_TYPE_EXCEPTION:
158 vl_api_punt_exception_encode (&in->punt.exception,
159 &out->punt.exception);
165 vl_api_set_punt_t_handler (vl_api_set_punt_t * mp)
167 vl_api_set_punt_reply_t *rmp;
168 vlib_main_t *vm = vlib_get_main ();
173 rv = vl_api_punt_decode (&mp->punt, &pr);
178 error = vnet_punt_add_del (vm, &pr, mp->is_add);
182 clib_error_report (error);
186 REPLY_MACRO (VL_API_SET_PUNT_REPLY);
190 vl_api_punt_socket_register_t_handler (vl_api_punt_socket_register_t * mp)
192 vl_api_punt_socket_register_reply_t *rmp;
193 vlib_main_t *vm = vlib_get_main ();
198 rv = vl_api_punt_decode (&mp->punt, &pr);
203 error = vnet_punt_socket_add (vm, ntohl (mp->header_version),
204 &pr, (char *) mp->pathname);
208 clib_error_report (error);
211 char *p = vnet_punt_get_server_pathname ();
214 REPLY_MACRO2 (VL_API_PUNT_SOCKET_REGISTER_REPLY,
216 memcpy ((char *) rmp->pathname, p, sizeof (rmp->pathname));
221 typedef struct punt_socket_send_ctx_t_
223 vl_api_registration_t *reg;
225 } punt_socket_send_ctx_t;
228 vl_api_punt_socket_send_details (const punt_client_t * pc, void *args)
230 punt_socket_send_ctx_t *ctx = args;
231 vl_api_punt_socket_details_t *mp;
233 mp = vl_msg_api_alloc (sizeof (*mp));
237 clib_memset (mp, 0, sizeof (*mp));
238 mp->_vl_msg_id = ntohs (VL_API_PUNT_SOCKET_DETAILS);
239 mp->context = ctx->context;
240 vl_api_punt_encode (&pc->reg, &mp->punt);
241 memcpy (mp->pathname, pc->caddr.sun_path, sizeof (pc->caddr.sun_path));
243 vl_api_send_msg (ctx->reg, (u8 *) mp);
245 return (WALK_CONTINUE);
249 vl_api_punt_socket_dump_t_handler (vl_api_punt_socket_dump_t * mp)
251 vl_api_registration_t *reg;
254 if (0 != vl_api_punt_type_decode (mp->type, &pt))
257 reg = vl_api_client_index_to_registration (mp->client_index);
261 punt_socket_send_ctx_t ctx = {
263 .context = mp->context,
266 punt_client_walk (pt, vl_api_punt_socket_send_details, &ctx);
270 vl_api_punt_socket_deregister_t_handler (vl_api_punt_socket_deregister_t * mp)
272 vl_api_punt_socket_deregister_reply_t *rmp;
273 vlib_main_t *vm = vlib_get_main ();
278 rv = vl_api_punt_decode (&mp->punt, &pr);
283 error = vnet_punt_socket_del (vm, &pr);
287 clib_error_report (error);
291 REPLY_MACRO (VL_API_PUNT_SOCKET_DEREGISTER_REPLY);
294 typedef struct punt_reason_dump_walk_ctx_t_
296 vl_api_registration_t *reg;
298 } punt_reason_dump_walk_ctx_t;
301 punt_reason_dump_walk_cb (vlib_punt_reason_t id, const u8 * name, void *args)
303 punt_reason_dump_walk_ctx_t *ctx = args;
304 vl_api_punt_reason_details_t *mp;
306 mp = vl_msg_api_alloc (sizeof (*mp) + vec_len (name));
310 clib_memset (mp, 0, sizeof (*mp));
311 mp->_vl_msg_id = ntohs (VL_API_PUNT_REASON_DETAILS);
313 mp->context = ctx->context;
314 mp->reason.id = clib_host_to_net_u32 (id);
315 vl_api_to_api_string (vec_len (name), (char *) name, &mp->reason.name);
317 vl_api_send_msg (ctx->reg, (u8 *) mp);
323 vl_api_punt_reason_dump_t_handler (vl_api_punt_reason_dump_t * mp)
325 vl_api_registration_t *reg;
327 reg = vl_api_client_index_to_registration (mp->client_index);
331 punt_reason_dump_walk_ctx_t ctx = {
333 .context = mp->context,
336 punt_reason_walk (punt_reason_dump_walk_cb, &ctx);
339 #define vl_msg_name_crc_list
340 #include <vnet/ip/punt.api.h>
341 #undef vl_msg_name_crc_list
344 setup_message_id_table (api_main_t * am)
346 #define _(id,n,crc) vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id);
347 foreach_vl_msg_name_crc_punt;
351 static clib_error_t *
352 punt_api_hookup (vlib_main_t * vm)
354 api_main_t *am = &api_main;
357 vl_msg_api_set_handlers(VL_API_##N, #n, \
358 vl_api_##n##_t_handler, \
360 vl_api_##n##_t_endian, \
361 vl_api_##n##_t_print, \
362 sizeof(vl_api_##n##_t), 1);
363 foreach_punt_api_msg;
367 * Set up the (msg_name, crc, message-id) table
369 setup_message_id_table (am);
374 VLIB_API_INIT_FUNCTION (punt_api_hookup);
378 * fd.io coding-style-patch-verification: ON
381 * eval: (c-set-style "gnu")