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);
94 rv = ip_proto_decode (in->protocol, &out->protocol);
97 out->port = clib_net_to_host_u16 (in->port);
103 vl_api_punt_ip_proto_decode (const vl_api_punt_ip_proto_t * in,
104 punt_ip_proto_t * out)
108 rv = ip_address_family_decode (in->af, &out->af);
111 rv = ip_proto_decode (in->protocol, &out->protocol);
117 vl_api_punt_exception_decode (const vl_api_punt_exception_t * in,
118 punt_exception_t * out)
122 out->reason = clib_net_to_host_u32 (in->id);
123 rv = vlib_punt_reason_validate (out->reason);
129 vl_api_punt_decode (const vl_api_punt_t * in, punt_reg_t * out)
133 rv = vl_api_punt_type_decode (in->type, &out->type);
141 return (vl_api_punt_l4_decode (&in->punt.l4, &out->punt.l4));
142 case PUNT_TYPE_EXCEPTION:
143 return (vl_api_punt_exception_decode (&in->punt.exception,
144 &out->punt.exception));
145 case PUNT_TYPE_IP_PROTO:
146 return (vl_api_punt_ip_proto_decode (&in->punt.ip_proto,
147 &out->punt.ip_proto));
154 vl_api_punt_l4_encode (const punt_l4_t * in, vl_api_punt_l4_t * out)
156 out->af = ip_address_family_encode (in->af);
157 out->protocol = ip_proto_encode (in->protocol);
158 out->port = clib_net_to_host_u16 (in->port);
162 vl_api_punt_ip_proto_encode (const punt_ip_proto_t * in,
163 vl_api_punt_ip_proto_t * out)
165 out->af = ip_address_family_encode (in->af);
166 out->protocol = ip_proto_encode (in->protocol);
170 vl_api_punt_exception_encode (const punt_exception_t * in,
171 vl_api_punt_exception_t * out)
173 out->id = clib_host_to_net_u32 (in->reason);
177 vl_api_punt_encode (const punt_reg_t * in, vl_api_punt_t * out)
179 out->type = vl_api_punt_type_encode (in->type);
184 vl_api_punt_l4_encode (&in->punt.l4, &out->punt.l4);
186 case PUNT_TYPE_IP_PROTO:
187 vl_api_punt_ip_proto_encode (&in->punt.ip_proto, &out->punt.ip_proto);
189 case PUNT_TYPE_EXCEPTION:
190 vl_api_punt_exception_encode (&in->punt.exception,
191 &out->punt.exception);
197 vl_api_set_punt_t_handler (vl_api_set_punt_t * mp)
199 vl_api_set_punt_reply_t *rmp;
200 vlib_main_t *vm = vlib_get_main ();
205 rv = vl_api_punt_decode (&mp->punt, &pr);
210 error = vnet_punt_add_del (vm, &pr, mp->is_add);
214 clib_error_report (error);
218 REPLY_MACRO (VL_API_SET_PUNT_REPLY);
222 vl_api_punt_socket_register_t_handler (vl_api_punt_socket_register_t * mp)
224 vl_api_punt_socket_register_reply_t *rmp;
225 vlib_main_t *vm = vlib_get_main ();
230 rv = vl_api_punt_decode (&mp->punt, &pr);
235 error = vnet_punt_socket_add (vm, ntohl (mp->header_version),
236 &pr, (char *) mp->pathname);
240 clib_error_report (error);
243 char *p = vnet_punt_get_server_pathname ();
246 REPLY_MACRO2 (VL_API_PUNT_SOCKET_REGISTER_REPLY,
248 memcpy ((char *) rmp->pathname, p, sizeof (rmp->pathname));
253 typedef struct punt_socket_send_ctx_t_
255 vl_api_registration_t *reg;
257 } punt_socket_send_ctx_t;
260 vl_api_punt_socket_send_details (const punt_client_t * pc, void *args)
262 punt_socket_send_ctx_t *ctx = args;
263 vl_api_punt_socket_details_t *mp;
265 mp = vl_msg_api_alloc (sizeof (*mp));
269 clib_memset (mp, 0, sizeof (*mp));
270 mp->_vl_msg_id = ntohs (VL_API_PUNT_SOCKET_DETAILS);
271 mp->context = ctx->context;
272 vl_api_punt_encode (&pc->reg, &mp->punt);
273 memcpy (mp->pathname, pc->caddr.sun_path, sizeof (pc->caddr.sun_path));
275 vl_api_send_msg (ctx->reg, (u8 *) mp);
277 return (WALK_CONTINUE);
281 vl_api_punt_socket_dump_t_handler (vl_api_punt_socket_dump_t * mp)
283 vl_api_registration_t *reg;
286 if (0 != vl_api_punt_type_decode (mp->type, &pt))
289 reg = vl_api_client_index_to_registration (mp->client_index);
293 punt_socket_send_ctx_t ctx = {
295 .context = mp->context,
298 punt_client_walk (pt, vl_api_punt_socket_send_details, &ctx);
302 vl_api_punt_socket_deregister_t_handler (vl_api_punt_socket_deregister_t * mp)
304 vl_api_punt_socket_deregister_reply_t *rmp;
305 vlib_main_t *vm = vlib_get_main ();
310 rv = vl_api_punt_decode (&mp->punt, &pr);
315 error = vnet_punt_socket_del (vm, &pr);
319 clib_error_report (error);
323 REPLY_MACRO (VL_API_PUNT_SOCKET_DEREGISTER_REPLY);
326 typedef struct punt_reason_dump_walk_ctx_t_
328 vl_api_registration_t *reg;
331 } punt_reason_dump_walk_ctx_t;
334 punt_reason_dump_walk_cb (vlib_punt_reason_t id, const u8 * name, void *args)
336 punt_reason_dump_walk_ctx_t *ctx = args;
337 vl_api_punt_reason_details_t *mp;
341 /* user requested a specific punt-reason */
342 if (vec_cmp (name, ctx->name))
343 /* not the reasonn we're lookgin for */
347 mp = vl_msg_api_alloc (sizeof (*mp) + vec_len (name));
351 clib_memset (mp, 0, sizeof (*mp));
352 mp->_vl_msg_id = ntohs (VL_API_PUNT_REASON_DETAILS);
354 mp->context = ctx->context;
355 mp->reason.id = clib_host_to_net_u32 (id);
356 vl_api_vec_to_api_string (name, &mp->reason.name);
358 vl_api_send_msg (ctx->reg, (u8 *) mp);
364 vl_api_punt_reason_dump_t_handler (vl_api_punt_reason_dump_t * mp)
366 vl_api_registration_t *reg;
368 reg = vl_api_client_index_to_registration (mp->client_index);
372 punt_reason_dump_walk_ctx_t ctx = {
374 .context = mp->context,
375 .name = vl_api_from_api_to_new_vec (&mp->reason.name),
378 punt_reason_walk (punt_reason_dump_walk_cb, &ctx);
383 #define vl_msg_name_crc_list
384 #include <vnet/ip/punt.api.h>
385 #undef vl_msg_name_crc_list
388 setup_message_id_table (api_main_t * am)
390 #define _(id,n,crc) vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id);
391 foreach_vl_msg_name_crc_punt;
395 static clib_error_t *
396 punt_api_hookup (vlib_main_t * vm)
398 api_main_t *am = vlibapi_get_main ();
401 vl_msg_api_set_handlers(VL_API_##N, #n, \
402 vl_api_##n##_t_handler, \
404 vl_api_##n##_t_endian, \
405 vl_api_##n##_t_print, \
406 sizeof(vl_api_##n##_t), 1);
407 foreach_punt_api_msg;
411 * Set up the (msg_name, crc, message-id) table
413 setup_message_id_table (am);
418 VLIB_API_INIT_FUNCTION (punt_api_hookup);
422 * fd.io coding-style-patch-verification: ON
425 * eval: (c-set-style "gnu")