2 * Copyright (c) 2016 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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
16 *------------------------------------------------------------------
17 * trace_api.c - iOAM Trace related APIs to create
18 * and maintain profiles
19 *------------------------------------------------------------------
22 #include <vnet/vnet.h>
23 #include <vnet/plugin/plugin.h>
24 #include <ioam/lib-trace/trace_util.h>
25 #include <ioam/lib-trace/trace_config.h>
27 #include <vlibapi/api.h>
28 #include <vlibmemory/api.h>
31 /* define message IDs */
32 #include <ioam/lib-trace/trace_msg_enum.h>
34 /* define message structures */
36 #include <ioam/lib-trace/trace_all_api_h.h>
39 /* define generated endian-swappers */
41 #include <ioam/lib-trace/trace_all_api_h.h>
44 /* instantiate all the print functions we know about */
45 #define vl_print(handle, ...) vlib_cli_output (handle, __VA_ARGS__)
47 #include <ioam/lib-trace/trace_all_api_h.h>
50 /* Get the API version number */
51 #define vl_api_version(n,v) static u32 api_version=(v);
52 #include <ioam/lib-trace/trace_all_api_h.h>
56 * A handy macro to set up a message reply.
57 * Assumes that the following variables are available:
58 * mp - pointer to request message
59 * rmp - pointer to reply message type
63 #define TRACE_REPLY_MACRO(t) \
65 unix_shared_memory_queue_t * q = \
66 vl_api_client_index_to_input_queue (mp->client_index); \
70 rmp = vl_msg_api_alloc (sizeof (*rmp)); \
71 rmp->_vl_msg_id = ntohs((t)+sm->msg_id_base); \
72 rmp->context = mp->context; \
73 rmp->retval = ntohl(rv); \
75 vl_msg_api_send_shmem (q, (u8 *)&rmp); \
79 #define TRACE_REPLY_MACRO2(t, body) \
81 unix_shared_memory_queue_t * q; \
82 rv = vl_msg_api_pd_handler (mp, rv); \
83 q = vl_api_client_index_to_input_queue (mp->client_index); \
87 rmp = vl_msg_api_alloc (sizeof (*rmp)); \
88 rmp->_vl_msg_id = ntohs((t)+sm->msg_id_base); \
89 rmp->context = mp->context; \
90 rmp->retval = ntohl(rv); \
91 do {body;} while (0); \
92 vl_msg_api_send_shmem (q, (u8 *)&rmp); \
96 /* List of message types that this plugin understands */
98 #define foreach_trace_plugin_api_msg \
99 _(TRACE_PROFILE_ADD, trace_profile_add) \
100 _(TRACE_PROFILE_DEL, trace_profile_del) \
101 _(TRACE_PROFILE_SHOW_CONFIG, trace_profile_show_config)
103 static void vl_api_trace_profile_add_t_handler
104 (vl_api_trace_profile_add_t * mp)
106 trace_main_t *sm = &trace_main;
108 vl_api_trace_profile_add_reply_t *rmp;
109 trace_profile *profile = NULL;
111 profile = trace_profile_find ();
115 trace_profile_create (profile, mp->trace_type, mp->num_elts,
116 mp->trace_tsp, ntohl (mp->node_id),
117 ntohl (mp->app_data));
126 TRACE_REPLY_MACRO (VL_API_TRACE_PROFILE_ADD_REPLY);
130 static void vl_api_trace_profile_del_t_handler
131 (vl_api_trace_profile_del_t * mp)
133 trace_main_t *sm = &trace_main;
135 vl_api_trace_profile_del_reply_t *rmp;
137 clear_trace_profiles ();
139 TRACE_REPLY_MACRO (VL_API_TRACE_PROFILE_DEL_REPLY);
142 static void vl_api_trace_profile_show_config_t_handler
143 (vl_api_trace_profile_show_config_t * mp)
145 trace_main_t *sm = &trace_main;
146 vl_api_trace_profile_show_config_reply_t *rmp;
148 trace_profile *profile = trace_profile_find ();
151 TRACE_REPLY_MACRO2 (VL_API_TRACE_PROFILE_SHOW_CONFIG_REPLY,
152 rmp->trace_type = profile->trace_type;
153 rmp->num_elts = profile->num_elts;
154 rmp->trace_tsp = profile->trace_tsp;
155 rmp->node_id = htonl (profile->node_id);
156 rmp->app_data = htonl (profile->app_data);
161 TRACE_REPLY_MACRO2 (VL_API_TRACE_PROFILE_SHOW_CONFIG_REPLY,
163 rmp->num_elts = 0; rmp->trace_tsp = 0;
164 rmp->node_id = 0; rmp->app_data = 0;
169 /* Set up the API message handling tables */
170 static clib_error_t *
171 trace_plugin_api_hookup (vlib_main_t * vm)
173 trace_main_t *sm = &trace_main;
175 vl_msg_api_set_handlers((VL_API_##N + sm->msg_id_base), \
177 vl_api_##n##_t_handler, \
179 vl_api_##n##_t_endian, \
180 vl_api_##n##_t_print, \
181 sizeof(vl_api_##n##_t), 1);
182 foreach_trace_plugin_api_msg;
188 #define vl_msg_name_crc_list
189 #include <ioam/lib-trace/trace_all_api_h.h>
190 #undef vl_msg_name_crc_list
193 setup_message_id_table (trace_main_t * sm, api_main_t * am)
195 #define _(id,n,crc) \
196 vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id + sm->msg_id_base);
197 foreach_vl_msg_name_crc_trace;
201 static clib_error_t *
202 trace_init (vlib_main_t * vm)
204 trace_main_t *sm = &trace_main;
205 clib_error_t *error = 0;
208 bzero (sm, sizeof (trace_main));
209 (void) trace_util_init ();
212 sm->vnet_main = vnet_get_main ();
214 name = format (0, "ioam_trace_%08x%c", api_version, 0);
216 /* Ask for a correctly-sized block of API message decode slots */
217 sm->msg_id_base = vl_msg_api_get_msg_ids
218 ((char *) name, VL_MSG_FIRST_AVAILABLE);
220 error = trace_plugin_api_hookup (vm);
222 /* Add our API messages to the global name_crc hash table */
223 setup_message_id_table (sm, &api_main);
230 VLIB_INIT_FUNCTION (trace_init);
233 * fd.io coding-style-patch-verification: ON
236 * eval: (c-set-style "gnu")