src/plugins/ioam/lib-trace/trace_test.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_test.c - test harness for trace plugin
  18  *------------------------------------------------------------------
  19  */
  20
  21 #include <vat/vat.h>
  22 #include <vlibapi/api.h>
  23 #include <vlibmemory/api.h>
  24 #include <vlibsocket/api.h>
  25 #include <vppinfra/error.h>
  26
  27 #define __plugin_msg_base trace_test_main.msg_id_base
  28 #include <vlibapi/vat_helper_macros.h>
  29
  30 /* Declare 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 /* declare message handlers for each api */
  39
  40 #define vl_endianfun            /* define message structures */
  41 #include <ioam/lib-trace/trace_all_api_h.h>
  42 #undef vl_endianfun
  43
  44 /* instantiate all the print functions we know about */
  45 #define vl_print(handle, ...)
  46 #define vl_printfun
  47 #include <ioam/lib-trace/trace_all_api_h.h>
  48 #undef vl_printfun
  49
  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>
  53 #undef vl_api_version
  54
  55
  56 typedef struct
  57 {
  58   /* API message ID base */
  59   u16 msg_id_base;
  60   vat_main_t *vat_main;
  61 } trace_test_main_t;
  62
  63 trace_test_main_t trace_test_main;
  64
  65 #define foreach_standard_reply_retval_handler     \
  66 _(trace_profile_add_reply)                          \
  67 _(trace_profile_del_reply)
  68
  69 #define foreach_custom_reply_handler     \
  70 _(trace_profile_show_config_reply,                                                                              \
  71   if(mp->trace_type)                                                                                            \
  72   {                                                                                                             \
  73      errmsg("                        Trace Type : 0x%x (%d)\n",mp->trace_type, mp->trace_type);                 \
  74      errmsg("         Trace timestamp precision : %d \n",mp->trace_tsp);                                        \
  75      errmsg("                           Node Id : 0x%x (%d)\n",htonl(mp->node_id), htonl(mp->node_id));         \
  76      errmsg("                          App Data : 0x%x (%d)\n",htonl(mp->app_data), htonl(mp->app_data));       \
  77   }                                                                                                             \
  78     else errmsg("No valid trace profile configuration found\n");)
  79 #define _(n)                                            \
  80     static void vl_api_##n##_t_handler                  \
  81     (vl_api_##n##_t * mp)                               \
  82     {                                                   \
  83         vat_main_t * vam = trace_test_main.vat_main;   \
  84         i32 retval = ntohl(mp->retval);                 \
  85         if (vam->async_mode) {                          \
  86             vam->async_errors += (retval < 0);          \
  87         } else {                                        \
  88             vam->retval = retval;                       \
  89             vam->result_ready = 1;                      \
  90         }                                               \
  91     }
  92 foreach_standard_reply_retval_handler;
  93 #undef _
  94
  95 #define _(n,body)                                       \
  96     static void vl_api_##n##_t_handler                  \
  97     (vl_api_##n##_t * mp)                               \
  98     {                                                   \
  99         vat_main_t * vam = trace_test_main.vat_main;    \
 100         i32 retval = ntohl(mp->retval);                 \
 101         if (vam->async_mode) {                          \
 102             vam->async_errors += (retval < 0);          \
 103         } else {                                        \
 104             vam->retval = retval;                       \
 105             vam->result_ready = 1;                      \
 106         }                                               \
 107         if(retval>=0)do{body;} while(0);                 \
 108         else errmsg("Error, retval: %d",retval);        \
 109     }
 110 foreach_custom_reply_handler;
 111 #undef _
 112 /*
 113  * Table of message reply handlers, must include boilerplate handlers
 114  * we just generated
 115  */
 116 #define foreach_vpe_api_reply_msg                                       \
 117 _(TRACE_PROFILE_ADD_REPLY, trace_profile_add_reply)                         \
 118 _(TRACE_PROFILE_DEL_REPLY, trace_profile_del_reply)                         \
 119 _(TRACE_PROFILE_SHOW_CONFIG_REPLY, trace_profile_show_config_reply)
 120
 121 static int
 122 api_trace_profile_add (vat_main_t * vam)
 123 {
 124   unformat_input_t *input = vam->input;
 125   vl_api_trace_profile_add_t *mp;
 126   u8 trace_type = 0;
 127   u8 num_elts = 0;
 128   u32 node_id = 0;
 129   u32 app_data = 0;
 130   u8 trace_tsp = 0;
 131   int ret;
 132
 133   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
 134     {
 135       if (unformat (input, "trace-type 0x%x", &trace_type))
 136         ;
 137       else if (unformat (input, "trace-elts %d", &num_elts))
 138         ;
 139       else if (unformat (input, "trace-tsp %d", &trace_tsp))
 140         ;
 141       else if (unformat (input, "node-id 0x%x", &node_id))
 142         ;
 143       else if (unformat (input, "app-data 0x%x", &app_data))
 144         ;
 145
 146       else
 147         break;
 148     }
 149
 150
 151   M (TRACE_PROFILE_ADD, mp);
 152
 153   mp->trace_type = trace_type;
 154   mp->trace_tsp = trace_tsp;
 155   mp->node_id = htonl (node_id);
 156   mp->app_data = htonl (app_data);
 157   mp->num_elts = num_elts;
 158
 159   S (mp);
 160   W (ret);
 161   return ret;
 162 }
 163
 164
 165
 166 static int
 167 api_trace_profile_del (vat_main_t * vam)
 168 {
 169   vl_api_trace_profile_del_t *mp;
 170   int ret;
 171
 172   M (TRACE_PROFILE_DEL, mp);
 173   S (mp);
 174   W (ret);
 175   return ret;
 176 }
 177
 178 static int
 179 api_trace_profile_show_config (vat_main_t * vam)
 180 {
 181   vl_api_trace_profile_show_config_t *mp;
 182   int ret;
 183
 184   M (TRACE_PROFILE_SHOW_CONFIG, mp);
 185   S (mp);
 186   W (ret);
 187   return ret;
 188 }
 189
 190 /*
 191  * List of messages that the api test plugin sends,
 192  * and that the data plane plugin processes
 193  */
 194 #define foreach_vpe_api_msg \
 195 _(trace_profile_add, ""\
 196   "trace-type <0x1f|0x3|0x9|0x11|0x19> trace-elts <nn> trace-tsp <0|1|2|3> node-id <node id in hex> app-data <app_data in hex>")  \
 197 _(trace_profile_del, "[id <nn>]")                    \
 198 _(trace_profile_show_config, "[id <nn>]")
 199
 200
 201 static void
 202 ioam_trace_vat_api_hookup (vat_main_t * vam)
 203 {
 204   trace_test_main_t *sm = &trace_test_main;
 205   /* Hook up handlers for replies from the data plane plug-in */
 206 #define _(N,n)                                                  \
 207     vl_msg_api_set_handlers((VL_API_##N + sm->msg_id_base),     \
 208                            #n,                                  \
 209                            vl_api_##n##_t_handler,              \
 210                            vl_noop_handler,                     \
 211                            vl_api_##n##_t_endian,               \
 212                            vl_api_##n##_t_print,                \
 213                            sizeof(vl_api_##n##_t), 1);
 214   foreach_vpe_api_reply_msg;
 215 #undef _
 216
 217   /* API messages we can send */
 218 #define _(n,h) hash_set_mem (vam->function_by_name, #n, api_##n);
 219   foreach_vpe_api_msg;
 220 #undef _
 221
 222   /* Help strings */
 223 #define _(n,h) hash_set_mem (vam->help_by_name, #n, h);
 224   foreach_vpe_api_msg;
 225 #undef _
 226 }
 227
 228 clib_error_t *
 229 vat_plugin_register (vat_main_t * vam)
 230 {
 231   trace_test_main_t *sm = &trace_test_main;
 232   u8 *name;
 233
 234   sm->vat_main = vam;
 235
 236   name = format (0, "ioam_trace_%08x%c", api_version, 0);
 237   sm->msg_id_base = vl_client_get_first_plugin_msg_id ((char *) name);
 238
 239   if (sm->msg_id_base != (u16) ~ 0)
 240     ioam_trace_vat_api_hookup (vam);
 241
 242   vec_free (name);
 243
 244   return 0;
 245 }
 246
 247 /*
 248  * fd.io coding-style-patch-verification: ON
 249  *
 250  * Local Variables:
 251  * eval: (c-set-style "gnu")
 252  * End:
 253  */