src/examples/sample-plugin/sample/sample_test.c

   1 /*
   2  * Copyright (c) 2015 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  * sample_test.c - test harness plugin
  18  *------------------------------------------------------------------
  19  */
  20
  21 #include <vat/vat.h>
  22 #include <vlibapi/api.h>
  23 #include <vlibmemory/api.h>
  24 #include <vppinfra/error.h>
  25
  26 #define __plugin_msg_base sample_test_main.msg_id_base
  27 #include <vlibapi/vat_helper_macros.h>
  28
  29 uword unformat_sw_if_index (unformat_input_t * input, va_list * args);
  30
  31 /* Declare message IDs */
  32 #include <sample/sample_msg_enum.h>
  33
  34 /* define message structures */
  35 #define vl_typedefs
  36 #include <sample/sample_all_api_h.h>
  37 #undef vl_typedefs
  38
  39 /* declare message handlers for each api */
  40
  41 #define vl_endianfun             /* define message structures */
  42 #include <sample/sample_all_api_h.h>
  43 #undef vl_endianfun
  44
  45 /* instantiate all the print functions we know about */
  46 #define vl_print(handle, ...)
  47 #define vl_printfun
  48 #include <sample/sample_all_api_h.h>
  49 #undef vl_printfun
  50
  51 /* Get the API version number. */
  52 #define vl_api_version(n,v) static u32 api_version=(v);
  53 #include <sample/sample_all_api_h.h>
  54 #undef vl_api_version
  55
  56
  57 typedef struct {
  58     /* API message ID base */
  59     u16 msg_id_base;
  60     vat_main_t *vat_main;
  61 } sample_test_main_t;
  62
  63 sample_test_main_t sample_test_main;
  64
  65 #define foreach_standard_reply_retval_handler   \
  66 _(sample_macswap_enable_disable_reply)
  67
  68 #define _(n)                                            \
  69     static void vl_api_##n##_t_handler                  \
  70     (vl_api_##n##_t * mp)                               \
  71     {                                                   \
  72         vat_main_t * vam = sample_test_main.vat_main;   \
  73         i32 retval = ntohl(mp->retval);                 \
  74         if (vam->async_mode) {                          \
  75             vam->async_errors += (retval < 0);          \
  76         } else {                                        \
  77             vam->retval = retval;                       \
  78             vam->result_ready = 1;                      \
  79         }                                               \
  80     }
  81 foreach_standard_reply_retval_handler;
  82 #undef _
  83
  84 /*
  85  * Table of message reply handlers, must include boilerplate handlers
  86  * we just generated
  87  */
  88 #define foreach_vpe_api_reply_msg                                       \
  89 _(SAMPLE_MACSWAP_ENABLE_DISABLE_REPLY, sample_macswap_enable_disable_reply)
  90
  91
  92 static int api_sample_macswap_enable_disable (vat_main_t * vam)
  93 {
  94     unformat_input_t * i = vam->input;
  95     int enable_disable = 1;
  96     u32 sw_if_index = ~0;
  97     vl_api_sample_macswap_enable_disable_t * mp;
  98     int ret;
  99
 100     /* Parse args required to build the message */
 101     while (unformat_check_input (i) != UNFORMAT_END_OF_INPUT) {
 102         if (unformat (i, "%U", unformat_sw_if_index, vam, &sw_if_index))
 103             ;
 104         else if (unformat (i, "sw_if_index %d", &sw_if_index))
 105             ;
 106         else if (unformat (i, "disable"))
 107             enable_disable = 0;
 108         else
 109             break;
 110     }
 111
 112     if (sw_if_index == ~0) {
 113         errmsg ("missing interface name / explicit sw_if_index number \n");
 114         return -99;
 115     }
 116
 117     /* Construct the API message */
 118     M(SAMPLE_MACSWAP_ENABLE_DISABLE, mp);
 119     mp->sw_if_index = ntohl (sw_if_index);
 120     mp->enable_disable = enable_disable;
 121
 122     /* send it... */
 123     S(mp);
 124
 125     /* Wait for a reply... */
 126     W (ret);
 127     return ret;
 128 }
 129
 130 /*
 131  * List of messages that the api test plugin sends,
 132  * and that the data plane plugin processes
 133  */
 134 #define foreach_vpe_api_msg \
 135 _(sample_macswap_enable_disable, "<intfc> [disable]")
 136
 137 static void sample_api_hookup (vat_main_t *vam)
 138 {
 139     sample_test_main_t * sm = &sample_test_main;
 140     /* Hook up handlers for replies from the data plane plug-in */
 141 #define _(N,n)                                                  \
 142     vl_msg_api_set_handlers((VL_API_##N + sm->msg_id_base),     \
 143                            #n,                                  \
 144                            vl_api_##n##_t_handler,              \
 145                            vl_noop_handler,                     \
 146                            vl_api_##n##_t_endian,               \
 147                            vl_api_##n##_t_print,                \
 148                            sizeof(vl_api_##n##_t), 1);
 149     foreach_vpe_api_reply_msg;
 150 #undef _
 151
 152     /* API messages we can send */
 153 #define _(n,h) hash_set_mem (vam->function_by_name, #n, api_##n);
 154     foreach_vpe_api_msg;
 155 #undef _
 156
 157     /* Help strings */
 158 #define _(n,h) hash_set_mem (vam->help_by_name, #n, h);
 159     foreach_vpe_api_msg;
 160 #undef _
 161 }
 162
 163 clib_error_t * vat_plugin_register (vat_main_t *vam)
 164 {
 165   sample_test_main_t * sm = &sample_test_main;
 166   u8 * name;
 167
 168   sm->vat_main = vam;
 169
 170   name = format (0, "sample_%08x%c", api_version, 0);
 171   sm->msg_id_base = vl_client_get_first_plugin_msg_id ((char *) name);
 172
 173   if (sm->msg_id_base != (u16) ~0)
 174     sample_api_hookup (vam);
 175
 176   vec_free(name);
 177
 178   return 0;
 179 }