2 * Copyright (c) 2020 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.
22 #include <vlib/vlib.h>
23 #include <vlibapi/api_types.h>
24 #include <vppinfra/hash.h>
25 #include <vppinfra/cJSON.h>
27 /* VPP API client includes */
28 #include <vpp-api/client/vppapiclient.h>
34 * Filter these messages as they are used to manage the API connection to VPP
36 char *filter_messages_strings[] = { "memclnt_create",
40 "memclnt_rx_thread_suspend",
41 "memclnt_read_timeout",
43 "trace_plugin_msg_ids",
47 filter_message (char *msgname)
49 char **p = filter_messages_strings;
53 if (strcmp (*p, msgname) == 0)
60 uword *function_by_name;
63 char *vat2_plugin_path;
65 vat2_find_plugin_path ()
67 char *p, path[PATH_MAX];
71 /* find executable path */
72 if ((rv = readlink ("/proc/self/exe", path, PATH_MAX - 1)) == -1)
75 /* readlink doesn't provide null termination */
79 if ((p = strrchr (path, '/')) == 0)
84 if ((p = strrchr (path, '/')) == 0)
88 s = format (0, "%s/lib/" CLIB_TARGET_TRIPLET "/vat2_plugins:"
89 "%s/lib/vat2_plugins", path, path);
91 vat2_plugin_path = (char *) s;
95 vac_callback (unsigned char *data, int len)
97 u16 result_msg_id = ntohs(*((u16 *)data));
98 DBG("Received something async: %d\n", result_msg_id);
101 int vat2_load_plugins (char *path, char *filter, int *loaded);
104 register_function (void)
108 vat2_find_plugin_path();
109 DBG("Plugin Path %s\n", vat2_plugin_path);
110 int rv = vat2_load_plugins(vat2_plugin_path, 0, &loaded);
111 DBG("Loaded %u plugins\n", loaded);
117 cJSON (*f) (cJSON *);
118 cJSON (*tojson) (void *);
122 struct apifuncs_s *apifuncs = 0;
125 vat2_register_function (char *name, cJSON (*f) (cJSON *),
126 cJSON (*tojson) (void *), u32 crc)
128 struct apifuncs_s funcs = { .f = f, .tojson = tojson, .crc = crc };
129 vec_add1 (apifuncs, funcs);
130 hash_set_mem (function_by_name, name, vec_len (apifuncs) - 1);
134 vat2_exec_command_by_name (char *msgname, cJSON *o)
136 if (filter_message (msgname))
139 cJSON *crc_obj = cJSON_GetObjectItem (o, "_crc");
142 fprintf (stderr, "Missing '_crc' element!\n");
145 char *crc_str = cJSON_GetStringValue (crc_obj);
146 u32 crc = (u32) strtol (crc_str, NULL, 16);
148 uword *p = hash_get_mem (function_by_name, msgname);
151 fprintf (stderr, "No such command %s\n", msgname);
154 if (crc != apifuncs[p[0]].crc)
156 fprintf (stderr, "API CRC does not match: %s!\n", msgname);
159 cJSON *(*fp) (cJSON *);
160 fp = (void *) apifuncs[p[0]].f;
161 cJSON *r = (*fp) (o);
165 char *output = cJSON_Print (r);
167 printf ("%s\n", output);
172 fprintf (stderr, "Call failed: %s\n", msgname);
179 vat2_exec_command (cJSON *o)
182 cJSON *msg_id_obj = cJSON_GetObjectItem (o, "_msgname");
185 fprintf (stderr, "Missing '_msgname' element!\n");
189 char *name = cJSON_GetStringValue (msg_id_obj);
191 return vat2_exec_command_by_name (name, o);
195 print_template (char *msgname)
197 uword *p = hash_get_mem (function_by_name, msgname);
201 cJSON *(*fp) (void *);
202 fp = (void *) apifuncs[p[0]].tojson;
206 void *scratch = malloc (2048);
210 memset (scratch, 0, 2048);
211 cJSON *t = fp (scratch);
215 char *output = cJSON_Print (t);
220 printf ("%s\n", output);
226 fprintf (stderr, "error printing template for: %s\n", msgname);
234 hash_foreach_mem (name, i, function_by_name, ({ printf ("%s\n", name); }));
241 "Usage: vat2 [OPTION] <message-name> <JSON object>\n"
242 "Send API message to VPP and print reply\n"
244 "-d, --debug Print additional information\n"
245 "-p, --prefix Specify shared memory prefix to connect to a given VPP "
247 "-f, --file File containing a JSON object with the arguments for "
248 "the message to send\n"
249 "--dump-apis List all APIs available in VAT2 (might not reflect "
251 "-t, --template Print a template JSON object for given API message\n"
253 printf ("%s", help_string);
256 int main (int argc, char **argv)
258 /* Create a heap of 64MB */
259 clib_mem_init (0, 64 << 20);
260 char *filename = 0, *prefix = 0;
265 int option_index = 0;
266 bool dump_api = false;
267 bool template = false;
269 static int debug_flag;
270 static struct option long_options[] = {
271 { "debug", no_argument, &debug_flag, 1 },
272 { "prefix", optional_argument, 0, 'p' },
273 { "file", required_argument, 0, 'f' },
274 { "dump-apis", no_argument, 0, 0 },
275 { "template", no_argument, 0, 't' },
279 while ((c = getopt_long (argc, argv, "hdp:f:", long_options,
280 &option_index)) != -1)
285 if (option_index == 3)
307 debug = debug_flag == 1 ? true : false;
308 DBG ("debug = %d, filename = %s shared memory prefix: %s\n", debug, filename,
311 for (index = optind; index < argc; index++)
312 DBG ("Non-option argument %s\n", argv[index]);
316 if (argc > index + 2)
318 fprintf (stderr, "%s: Too many arguments\n", argv[0]);
323 function_by_name = hash_create_string (0, sizeof (uword));
324 int res = register_function();
326 fprintf(stderr, "%s: loading plugins failed\n", argv[0]);
332 print_template (argv[index]);
342 /* Read message arguments from command line */
343 if (argc >= (index + 1))
345 msgname = argv[index];
347 if (argc == (index + 2)) {
348 o = cJSON_Parse(argv[index+1]);
350 fprintf(stderr, "%s: Failed parsing JSON input: %s\n", argv[0], cJSON_GetErrorPtr());
355 if (!msgname && !filename)
361 /* Read message from file */
365 fprintf (stderr, "%s: Superfluous arguments when filename given\n",
370 FILE *f = fopen(filename, "r");
371 size_t chunksize, bufsize;
376 fprintf(stderr, "%s: can't open file: %s\n", argv[0], filename);
380 chunksize = bufsize = 1024;
381 char *buf = malloc(bufsize);
382 while ((n = fread (buf + n_read, 1, chunksize, f)))
387 bufsize += chunksize;
388 buf = realloc (buf, bufsize);
393 o = cJSON_Parse(buf);
395 fprintf(stderr, "%s: Failed parsing JSON input: %s\n", argv[0], cJSON_GetErrorPtr());
404 fprintf (stderr, "%s: Failed parsing JSON input\n", argv[0]);
408 if (vac_connect ("vat2", prefix, 0, 1024))
410 fprintf (stderr, "Failed connecting to VPP\n");
416 vat2_exec_command_by_name (msgname, o);
420 if (cJSON_IsArray (o))
422 size_t size = cJSON_GetArraySize (o);
423 for (int i = 0; i < size; i++)
424 vat2_exec_command (cJSON_GetArrayItem (o, i));