src/plugins/ioam/lib-trace/trace_api.c

   1 /*
   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:
   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  *------------------------------------------------------------------
  17  * trace_api.c - iOAM Trace related APIs to create
  18  *               and maintain profiles
  19  *------------------------------------------------------------------
  20  */
  21
  22 #include <vnet/vnet.h>
  23 #include <vnet/plugin/plugin.h>
  24 #include <ioam/lib-trace/trace_util.h>
  25
  26 #include <vlibapi/api.h>
  27 #include <vlibmemory/api.h>
  28 #include <vlibsocket/api.h>
  29
  30 /* define message IDs */
  31 #include <ioam/lib-trace/trace_msg_enum.h>
  32
  33 /* define message structures */
  34 #define vl_typedefs
  35 #include <ioam/lib-trace/trace_all_api_h.h>
  36 #undef vl_typedefs
  37
  38 /* define generated endian-swappers */
  39 #define vl_endianfun
  40 #include <ioam/lib-trace/trace_all_api_h.h>
  41 #undef vl_endianfun
  42
  43 /* instantiate all the print functions we know about */
  44 #define vl_print(handle, ...) vlib_cli_output (handle, __VA_ARGS__)
  45 #define vl_printfun
  46 #include <ioam/lib-trace/trace_all_api_h.h>
  47 #undef vl_printfun
  48
  49 /* Get the API version number */
  50 #define vl_api_version(n,v) static u32 api_version=(v);
  51 #include <ioam/lib-trace/trace_all_api_h.h>
  52 #undef vl_api_version
  53
  54 /*
  55  * A handy macro to set up a message reply.
  56  * Assumes that the following variables are available:
  57  * mp - pointer to request message
  58  * rmp - pointer to reply message type
  59  * rv - return value
  60  */
  61
  62 #define TRACE_REPLY_MACRO(t)                                          \
  63 do {                                                            \
  64     unix_shared_memory_queue_t * q =                            \
  65     vl_api_client_index_to_input_queue (mp->client_index);      \
  66     if (!q)                                                     \
  67         return;                                                 \
  68                                                                 \
  69     rmp = vl_msg_api_alloc (sizeof (*rmp));                     \
  70     rmp->_vl_msg_id = ntohs((t)+sm->msg_id_base);               \
  71     rmp->context = mp->context;                                 \
  72     rmp->retval = ntohl(rv);                                    \
  73                                                                 \
  74     vl_msg_api_send_shmem (q, (u8 *)&rmp);                      \
  75 } while(0);
  76
  77 /* *INDENT-OFF* */
  78 #define TRACE_REPLY_MACRO2(t, body)                                   \
  79 do {                                                            \
  80     unix_shared_memory_queue_t * q;                             \
  81     rv = vl_msg_api_pd_handler (mp, rv);                        \
  82     q = vl_api_client_index_to_input_queue (mp->client_index);  \
  83     if (!q)                                                     \
  84         return;                                                 \
  85                                                                 \
  86     rmp = vl_msg_api_alloc (sizeof (*rmp));                     \
  87     rmp->_vl_msg_id = ntohs((t)+sm->msg_id_base);               \
  88     rmp->context = mp->context;                                 \
  89     rmp->retval = ntohl(rv);                                    \
  90     do {body;} while (0);                                       \
  91     vl_msg_api_send_shmem (q, (u8 *)&rmp);                      \
  92 } while(0);
  93 /* *INDENT-ON* */
  94
  95 /* List of message types that this plugin understands */
  96
  97 #define foreach_trace_plugin_api_msg                                      \
  98 _(TRACE_PROFILE_ADD, trace_profile_add)                                     \
  99 _(TRACE_PROFILE_DEL, trace_profile_del)                                     \
 100 _(TRACE_PROFILE_SHOW_CONFIG, trace_profile_show_config)
 101
 102 static void vl_api_trace_profile_add_t_handler
 103   (vl_api_trace_profile_add_t * mp)
 104 {
 105   trace_main_t *sm = &trace_main;
 106   int rv = 0;
 107   vl_api_trace_profile_add_reply_t *rmp;
 108   trace_profile *profile = NULL;
 109
 110   profile = trace_profile_find ();
 111   if (profile)
 112     {
 113       rv =
 114         trace_profile_create (profile, mp->trace_type, mp->num_elts,
 115                               mp->trace_tsp, ntohl (mp->node_id),
 116                               ntohl (mp->app_data));
 117       if (rv != 0)
 118         goto ERROROUT;
 119     }
 120   else
 121     {
 122       rv = -3;
 123     }
 124 ERROROUT:
 125   TRACE_REPLY_MACRO (VL_API_TRACE_PROFILE_ADD_REPLY);
 126 }
 127
 128
 129 static void vl_api_trace_profile_del_t_handler
 130   (vl_api_trace_profile_del_t * mp)
 131 {
 132   trace_main_t *sm = &trace_main;
 133   int rv = 0;
 134   vl_api_trace_profile_del_reply_t *rmp;
 135
 136   clear_trace_profiles ();
 137
 138   TRACE_REPLY_MACRO (VL_API_TRACE_PROFILE_DEL_REPLY);
 139 }
 140
 141 static void vl_api_trace_profile_show_config_t_handler
 142   (vl_api_trace_profile_show_config_t * mp)
 143 {
 144   trace_main_t *sm = &trace_main;
 145   vl_api_trace_profile_show_config_reply_t *rmp;
 146   int rv = 0;
 147   trace_profile *profile = trace_profile_find ();
 148   if (profile->valid)
 149     {
 150       TRACE_REPLY_MACRO2 (VL_API_TRACE_PROFILE_SHOW_CONFIG_REPLY,
 151                           rmp->trace_type = profile->trace_type;
 152                           rmp->num_elts = profile->num_elts;
 153                           rmp->trace_tsp = profile->trace_tsp;
 154                           rmp->node_id = htonl (profile->node_id);
 155                           rmp->app_data = htonl (profile->app_data);
 156         );
 157     }
 158   else
 159     {
 160       TRACE_REPLY_MACRO2 (VL_API_TRACE_PROFILE_SHOW_CONFIG_REPLY,
 161                           rmp->trace_type = 0;
 162                           rmp->num_elts = 0; rmp->trace_tsp = 0;
 163                           rmp->node_id = 0; rmp->app_data = 0;
 164         );
 165     }
 166 }
 167
 168 /*
 169  * This routine exists to convince the vlib plugin framework that
 170  * we haven't accidentally copied a random .dll into the plugin directory.
 171  *
 172  * Also collects global variable pointers passed from the vpp engine
 173  */
 174
 175 clib_error_t *
 176 vlib_plugin_register (vlib_main_t * vm, vnet_plugin_handoff_t * h,
 177                       int from_early_init)
 178 {
 179   trace_main_t *sm = &trace_main;
 180   clib_error_t *error = 0;
 181
 182   sm->vlib_main = vm;
 183   sm->vnet_main = h->vnet_main;
 184   return error;
 185 }
 186
 187 /* Set up the API message handling tables */
 188 static clib_error_t *
 189 trace_plugin_api_hookup (vlib_main_t * vm)
 190 {
 191   trace_main_t *sm = &trace_main;
 192 #define _(N,n)                                                  \
 193     vl_msg_api_set_handlers((VL_API_##N + sm->msg_id_base),     \
 194                            #n,                                  \
 195                            vl_api_##n##_t_handler,              \
 196                            vl_noop_handler,                     \
 197                            vl_api_##n##_t_endian,               \
 198                            vl_api_##n##_t_print,                \
 199                            sizeof(vl_api_##n##_t), 1);
 200   foreach_trace_plugin_api_msg;
 201 #undef _
 202
 203   return 0;
 204 }
 205
 206 #define vl_msg_name_crc_list
 207 #include <ioam/lib-trace/trace_all_api_h.h>
 208 #undef vl_msg_name_crc_list
 209
 210 static void
 211 setup_message_id_table (trace_main_t * sm, api_main_t * am)
 212 {
 213 #define _(id,n,crc) \
 214   vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id + sm->msg_id_base);
 215   foreach_vl_msg_name_crc_trace;
 216 #undef _
 217 }
 218
 219 static clib_error_t *
 220 trace_init (vlib_main_t * vm)
 221 {
 222   trace_main_t *sm = &trace_main;
 223   clib_error_t *error = 0;
 224   u8 *name;
 225
 226   bzero (sm, sizeof (trace_main));
 227   (void) trace_util_init ();
 228   name = format (0, "ioam_trace_%08x%c", api_version, 0);
 229
 230   /* Ask for a correctly-sized block of API message decode slots */
 231   sm->msg_id_base = vl_msg_api_get_msg_ids
 232     ((char *) name, VL_MSG_FIRST_AVAILABLE);
 233
 234   error = trace_plugin_api_hookup (vm);
 235
 236   /* Add our API messages to the global name_crc hash table */
 237   setup_message_id_table (sm, &api_main);
 238
 239   vec_free (name);
 240
 241   return error;
 242 }
 243
 244 VLIB_INIT_FUNCTION (trace_init);
 245
 246 /*
 247  * fd.io coding-style-patch-verification: ON
 248  *
 249  * Local Variables:
 250  * eval: (c-set-style "gnu")
 251  * End:
 252  */