2 *------------------------------------------------------------------
3 * memclnt_api.c VLIB API implementation
5 * Copyright (c) 2009 Cisco and/or its affiliates.
6 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at:
10 * http://www.apache.org/licenses/LICENSE-2.0
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
17 *------------------------------------------------------------------
22 #include <vppinfra/vec.h>
23 #include <vppinfra/hash.h>
24 #include <vppinfra/pool.h>
25 #include <vppinfra/format.h>
26 #include <vppinfra/byte_order.h>
27 #include <vppinfra/elog.h>
28 #include <vlib/vlib.h>
29 #include <vlib/unix/unix.h>
30 #include <vlibapi/api.h>
31 #include <vlibmemory/api.h>
32 #include <vlibapi/api_helper_macros.h>
36 * @brief Binary API messaging via shared memory
37 * Low-level, primary provisioning interface
39 /*? %%clicmd:group_label Binary API CLI %% ?*/
40 /*? %%syscfg:group_label Binary API configuration %% ?*/
42 #define TRACE_VLIB_MEMORY_QUEUE 0
44 #include <vlibmemory/vl_memory_msg_enum.h> /* enumerate all vlib messages */
46 #define vl_typedefs /* define message structures */
47 #include <vlibmemory/vl_memory_api_h.h>
50 /* instantiate all the print functions we know about */
52 #include <vlibmemory/vl_memory_api_h.h>
55 /* instantiate all the endian swap functions we know about */
57 #include <vlibmemory/vl_memory_api_h.h>
60 #define vl_calcsizefun
61 #include <vlibmemory/vl_memory_api_h.h>
65 vl_api_get_first_msg_id_t_handler (vl_api_get_first_msg_id_t *mp)
67 vl_api_get_first_msg_id_reply_t *rmp;
68 vl_api_registration_t *regp;
70 api_main_t *am = vlibapi_get_main ();
71 vl_api_msg_range_t *rp;
73 u16 first_msg_id = ~0;
74 int rv = -7; /* VNET_API_ERROR_INVALID_VALUE */
76 regp = vl_api_client_index_to_registration (mp->client_index);
80 if (am->msg_range_by_name == 0)
82 strncpy ((char *) name, (char *) mp->name, ARRAY_LEN (name));
83 name[ARRAY_LEN (name) - 1] = '\0';
84 p = hash_get_mem (am->msg_range_by_name, name);
88 rp = vec_elt_at_index (am->msg_ranges, p[0]);
89 first_msg_id = rp->first_msg_id;
93 rmp = vl_msg_api_alloc (sizeof (*rmp));
94 rmp->_vl_msg_id = ntohs (VL_API_GET_FIRST_MSG_ID_REPLY);
95 rmp->context = mp->context;
96 rmp->retval = ntohl (rv);
97 rmp->first_msg_id = ntohs (first_msg_id);
98 vl_api_send_msg (regp, (u8 *) rmp);
102 vl_api_api_versions_t_handler (vl_api_api_versions_t *mp)
104 api_main_t *am = vlibapi_get_main ();
105 vl_api_api_versions_reply_t *rmp;
106 vl_api_registration_t *reg;
107 u32 nmsg = vec_len (am->api_version_list);
108 int msg_size = sizeof (*rmp) + sizeof (rmp->api_versions[0]) * nmsg;
111 reg = vl_api_client_index_to_registration (mp->client_index);
115 rmp = vl_msg_api_alloc (msg_size);
116 clib_memset (rmp, 0, msg_size);
117 rmp->_vl_msg_id = ntohs (VL_API_API_VERSIONS_REPLY);
119 /* fill in the message */
120 rmp->context = mp->context;
121 rmp->count = htonl (nmsg);
123 for (i = 0; i < nmsg; ++i)
125 api_version_t *vl = &am->api_version_list[i];
126 rmp->api_versions[i].major = htonl (vl->major);
127 rmp->api_versions[i].minor = htonl (vl->minor);
128 rmp->api_versions[i].patch = htonl (vl->patch);
129 strncpy ((char *) rmp->api_versions[i].name, vl->name,
130 ARRAY_LEN (rmp->api_versions[i].name));
131 rmp->api_versions[i].name[ARRAY_LEN (rmp->api_versions[i].name) - 1] =
135 vl_api_send_msg (reg, (u8 *) rmp);
139 vl_api_control_ping_t_handler (vl_api_control_ping_t *mp)
141 vl_api_control_ping_reply_t *rmp;
144 REPLY_MACRO2 (VL_API_CONTROL_PING_REPLY,
145 ({ rmp->vpe_pid = ntohl (getpid ()); }));
149 vl_api_get_api_json_t_handler (vl_api_get_api_json_t *mp)
151 vl_api_get_api_json_reply_t *rmp;
152 api_main_t *am = vlibapi_get_main ();
156 vl_api_registration_t *rp =
157 vl_api_client_index_to_registration (mp->client_index);
161 s = format (s, "[\n");
163 vec_foreach (ptr, am->json_api_repr)
165 s = format (s, "%s,", ptr[0]);
167 s[vec_len (s) - 1] = ']'; // Replace last comma with a bracket
168 vec_terminate_c_string (s);
172 REPLY_MACRO3 (VL_API_GET_API_JSON_REPLY, n, ({
175 vl_api_c_string_to_api_string ((char *) s, &rmp->json);
181 #define foreach_vlib_api_msg \
182 _ (GET_FIRST_MSG_ID, get_first_msg_id) \
183 _ (API_VERSIONS, api_versions) \
184 _ (CONTROL_PING, control_ping) \
185 _ (GET_API_JSON, get_api_json)
193 api_main_t *am = vlibapi_get_main ();
194 vl_msg_api_msg_config_t cfg;
195 vl_msg_api_msg_config_t *c = &cfg;
197 cJSON_Hooks cjson_hooks = {
198 .malloc_fn = clib_mem_alloc,
199 .free_fn = clib_mem_free,
201 cJSON_InitHooks (&cjson_hooks);
203 clib_memset (c, 0, sizeof (*c));
208 c->id = VL_API_##N; \
210 c->handler = vl_api_##n##_t_handler; \
211 c->endian = vl_api_##n##_t_endian; \
212 c->format_fn = vl_api_##n##_t_format; \
213 c->tojson = vl_api_##n##_t_tojson; \
214 c->fromjson = vl_api_##n##_t_fromjson; \
215 c->calc_size = vl_api_##n##_t_calc_size; \
216 c->size = sizeof (vl_api_##n##_t); \
217 c->traced = 1; /* trace, so these msgs print */ \
218 c->replay = 0; /* don't replay client create/delete msgs */ \
219 c->message_bounce = 0; /* don't bounce this message */ \
220 vl_msg_api_config (c); \
224 foreach_vlib_api_msg;
227 /* Mark messages as mp safe */
228 vl_api_set_msg_thread_safe (am, VL_API_GET_FIRST_MSG_ID, 1);
229 vl_api_set_msg_thread_safe (am, VL_API_API_VERSIONS, 1);
230 vl_api_set_msg_thread_safe (am, VL_API_CONTROL_PING, 1);
231 vl_api_set_msg_thread_safe (am, VL_API_CONTROL_PING_REPLY, 1);
236 u64 vector_rate_histogram[SLEEP_N_BUCKETS];
239 * Callback to send ourselves a plugin numbering-space trace msg
242 send_one_plugin_msg_ids_msg (u8 *name, u16 first_msg_id, u16 last_msg_id)
244 vl_api_trace_plugin_msg_ids_t *mp;
245 api_main_t *am = vlibapi_get_main ();
246 vl_shmem_hdr_t *shmem_hdr = am->shmem_hdr;
249 mp = vl_msg_api_alloc_as_if_client (sizeof (*mp));
250 clib_memset (mp, 0, sizeof (*mp));
252 mp->_vl_msg_id = clib_host_to_net_u16 (VL_API_TRACE_PLUGIN_MSG_IDS);
253 strncpy ((char *) mp->plugin_name, (char *) name,
254 sizeof (mp->plugin_name) - 1);
255 mp->first_msg_id = clib_host_to_net_u16 (first_msg_id);
256 mp->last_msg_id = clib_host_to_net_u16 (last_msg_id);
258 q = shmem_hdr->vl_input_queue;
260 vl_msg_api_send_shmem (q, (u8 *) &mp);
264 vl_api_save_msg_table (void)
266 u8 *serialized_message_table;
267 api_main_t *am = vlibapi_get_main ();
272 * Snapshoot the api message table.
274 if (strstr ((char *) am->save_msg_table_filename, "..") ||
275 index ((char *) am->save_msg_table_filename, '/'))
277 clib_warning ("illegal save-message-table filename '%s'",
278 am->save_msg_table_filename);
282 chroot_file = format (0, "/tmp/%s%c", am->save_msg_table_filename, 0);
284 fd = creat ((char *) chroot_file, 0644);
288 clib_unix_warning ("creat");
292 serialized_message_table = vl_api_serialize_message_table (am, 0);
295 write (fd, serialized_message_table, vec_len (serialized_message_table));
297 if (rv != vec_len (serialized_message_table))
298 clib_unix_warning ("write");
302 clib_unix_warning ("close");
304 vec_free (chroot_file);
305 vec_free (serialized_message_table);
308 clib_error_t *vat_builtin_main_init (vlib_main_t *vm) __attribute__ ((weak));
310 vat_builtin_main_init (vlib_main_t *vm)
316 vl_api_clnt_process (vlib_main_t *vm, vlib_node_runtime_t *node,
319 vlib_global_main_t *vgm = vlib_get_global_main ();
320 int private_segment_rotor = 0, i, rv;
321 vl_socket_args_for_process_t *a;
325 api_main_t *am = vlibapi_get_main ();
326 f64 dead_client_scan_time;
327 f64 sleep_time, start_time;
331 uword *event_data = 0;
334 if ((error = vl_sock_api_init (vm)))
336 clib_error_report (error);
337 clib_warning ("socksvr_api_init failed, quitting...");
341 if ((rv = vlib_api_init ()) < 0)
343 clib_warning ("vlib_api_init returned %d, quitting...", rv);
348 q = shm->vl_input_queue;
350 e = vlib_call_init_exit_functions (vm, &vgm->api_init_function_registrations,
351 1 /* call_once */, 1 /* is_global */);
353 clib_error_report (e);
355 e = vat_builtin_main_init (vm);
357 clib_error_report (e);
360 dead_client_scan_time = vlib_time_now (vm) + 10.0;
363 * Send plugin message range messages for each plugin we loaded
365 for (i = 0; i < vec_len (am->msg_ranges); i++)
367 vl_api_msg_range_t *rp = am->msg_ranges + i;
368 send_one_plugin_msg_ids_msg (rp->name, rp->first_msg_id,
373 * Save the api message table snapshot, if configured
375 if (am->save_msg_table_filename)
376 vl_api_save_msg_table ();
378 /* $$$ pay attention to frame size, control CPU usage */
382 * There's a reason for checking the queue before
383 * sleeping. If the vlib application crashes, it's entirely
384 * possible for a client to enqueue a connect request
385 * during the process restart interval.
387 * Unless some force of physics causes the new incarnation
388 * of the application to process the request, the client will
389 * sit and wait for Godot...
391 vector_rate = (f64) vlib_last_vectors_per_main_loop (vm);
392 start_time = vlib_time_now (vm);
395 if (vl_mem_api_handle_rpc (vm, node) ||
396 vl_mem_api_handle_msg_main (vm, node))
398 vm->api_queue_nonempty = 0;
399 VL_MEM_API_LOG_Q_LEN ("q-underflow: len %d", 0);
404 /* Allow no more than 10us without a pause */
405 if (vlib_time_now (vm) > start_time + 10e-6)
407 int index = SLEEP_400_US;
408 if (vector_rate > 40.0)
410 else if (vector_rate > 20.0)
412 index = SLEEP_200_US;
415 else if (vector_rate >= 1.0)
417 index = SLEEP_100_US;
425 vector_rate_histogram[index] += 1;
431 * see if we have any private api shared-memory segments
432 * If so, push required context variables, and process
435 if (PREDICT_FALSE (vec_len (am->vlib_private_rps)))
437 if (private_segment_rotor >= vec_len (am->vlib_private_rps))
438 private_segment_rotor = 0;
439 vl_mem_api_handle_msg_private (vm, node, private_segment_rotor++);
442 vlib_process_wait_for_event_or_clock (vm, sleep_time);
443 vec_reset_length (event_data);
444 event_type = vlib_process_get_events (vm, &event_data);
445 now = vlib_time_now (vm);
449 case QUEUE_SIGNAL_EVENT:
450 vm->queue_signal_pending = 0;
451 VL_MEM_API_LOG_Q_LEN ("q-awake: len %d", q->cursize);
454 case SOCKET_READ_EVENT:
455 for (i = 0; i < vec_len (event_data); i++)
457 vl_api_registration_t *regp;
459 a = pool_elt_at_index (socket_main.process_args, event_data[i]);
460 regp = vl_socket_get_registration (a->reg_index);
463 vl_socket_process_api_msg (regp, (i8 *) a->data);
464 a = pool_elt_at_index (socket_main.process_args,
468 pool_put (socket_main.process_args, a);
477 clib_warning ("unknown event type %d", event_type);
481 if (now > dead_client_scan_time)
483 vl_mem_api_dead_client_scan (am, shm, now);
484 dead_client_scan_time = vlib_time_now (vm) + 10.0;
491 VLIB_REGISTER_NODE (vl_api_clnt_node) = {
492 .function = vl_api_clnt_process,
493 .type = VLIB_NODE_TYPE_PROCESS,
494 .name = "api-rx-from-ring",
495 .state = VLIB_NODE_STATE_DISABLED,
496 .process_log2_n_stack_bytes = 18,
500 vl_mem_api_enable_disable (vlib_main_t *vm, int enable)
502 vlib_node_set_state (
503 vm, vl_api_clnt_node.index,
504 (enable ? VLIB_NODE_STATE_POLLING : VLIB_NODE_STATE_DISABLED));
508 api_rx_from_node (vlib_main_t *vm, vlib_node_runtime_t *node,
511 uword n_packets = frame->n_vectors;
516 vec_validate (long_msg, 4095);
517 n_left_from = frame->n_vectors;
518 from = vlib_frame_vector_args (frame);
520 while (n_left_from > 0)
528 b0 = vlib_get_buffer (vm, bi0);
532 msg = b0->data + b0->current_data;
533 msg_len = b0->current_length;
534 if (b0->flags & VLIB_BUFFER_NEXT_PRESENT)
536 ASSERT (long_msg != 0);
537 vec_set_len (long_msg, 0);
538 vec_add (long_msg, msg, msg_len);
539 while (b0->flags & VLIB_BUFFER_NEXT_PRESENT)
541 b0 = vlib_get_buffer (vm, b0->next_buffer);
542 msg = b0->data + b0->current_data;
543 msg_len = b0->current_length;
544 vec_add (long_msg, msg, msg_len);
547 msg_len = vec_len (long_msg);
549 vl_msg_api_handler_no_trace_no_free (msg, msg_len);
552 /* Free what we've been given. */
553 vlib_buffer_free (vm, vlib_frame_vector_args (frame), n_packets);
558 VLIB_REGISTER_NODE (api_rx_from_node_node, static) = {
559 .function = api_rx_from_node,
560 .type = VLIB_NODE_TYPE_INTERNAL,
562 .name = "api-rx-from-node",
566 vl_api_rpc_call_t_handler (vl_api_rpc_call_t *mp)
568 vl_api_rpc_call_reply_t *rmp;
571 vlib_main_t *vm = vlib_get_main ();
573 if (mp->function == 0)
576 clib_warning ("rpc NULL function pointer");
581 if (mp->need_barrier_sync)
582 vlib_worker_thread_barrier_sync (vm);
584 fp = uword_to_pointer (mp->function, int (*) (void *));
587 if (mp->need_barrier_sync)
588 vlib_worker_thread_barrier_release (vm);
593 svm_queue_t *q = vl_api_client_index_to_input_queue (mp->client_index);
596 rmp = vl_msg_api_alloc_as_if_client (sizeof (*rmp));
597 rmp->_vl_msg_id = ntohs (VL_API_RPC_CALL_REPLY);
598 rmp->context = mp->context;
600 vl_msg_api_send_shmem (q, (u8 *) &rmp);
605 clib_warning ("multicast not yet implemented...");
610 vl_api_rpc_call_reply_t_handler (vl_api_rpc_call_reply_t *mp)
612 clib_warning ("unimplemented");
616 vl_api_send_pending_rpc_requests (vlib_main_t *vm)
618 vlib_main_t *vm_global = vlib_get_first_main ();
620 ASSERT (vm != vm_global);
622 clib_spinlock_lock_if_init (&vm_global->pending_rpc_lock);
623 vec_append (vm_global->pending_rpc_requests, vm->pending_rpc_requests);
624 vec_reset_length (vm->pending_rpc_requests);
625 clib_spinlock_unlock_if_init (&vm_global->pending_rpc_lock);
629 vl_api_rpc_call_main_thread_inline (void *fp, u8 *data, u32 data_length,
632 vl_api_rpc_call_t *mp;
633 vlib_main_t *vm_global = vlib_get_first_main ();
634 vlib_main_t *vm = vlib_get_main ();
636 /* Main thread and not a forced RPC: call the function directly */
637 if ((force_rpc == 0) && (vlib_get_thread_index () == 0))
639 void (*call_fp) (void *);
641 vlib_worker_thread_barrier_sync (vm);
646 vlib_worker_thread_barrier_release (vm);
650 /* Otherwise, actually do an RPC */
651 mp = vl_msg_api_alloc_as_if_client (sizeof (*mp) + data_length);
653 clib_memset (mp, 0, sizeof (*mp));
654 clib_memcpy_fast (mp->data, data, data_length);
655 mp->_vl_msg_id = ntohs (VL_API_RPC_CALL);
656 mp->function = pointer_to_uword (fp);
657 mp->need_barrier_sync = 1;
659 /* Add to the pending vector. Thread 0 requires locking. */
661 clib_spinlock_lock_if_init (&vm_global->pending_rpc_lock);
662 vec_add1 (vm->pending_rpc_requests, (uword) mp);
664 clib_spinlock_unlock_if_init (&vm_global->pending_rpc_lock);
668 * Check if called from worker threads.
669 * If so, make rpc call of fp through shmem.
670 * Otherwise, call fp directly
673 vl_api_rpc_call_main_thread (void *fp, u8 *data, u32 data_length)
675 vl_api_rpc_call_main_thread_inline (fp, data, data_length, /*force_rpc */
680 * Always make rpc call of fp through shmem, useful for calling from threads
681 * not setup as worker threads, such as DPDK callback thread
684 vl_api_force_rpc_call_main_thread (void *fp, u8 *data, u32 data_length)
686 vl_api_rpc_call_main_thread_inline (fp, data, data_length, /*force_rpc */
691 vl_api_trace_plugin_msg_ids_t_handler (vl_api_trace_plugin_msg_ids_t *mp)
693 api_main_t *am = vlibapi_get_main ();
694 vl_api_msg_range_t *rp;
697 /* Noop (except for tracing) during normal operation */
698 if (am->replay_in_progress == 0)
701 p = hash_get_mem (am->msg_range_by_name, mp->plugin_name);
704 clib_warning ("WARNING: traced plugin '%s' not in current image",
709 rp = vec_elt_at_index (am->msg_ranges, p[0]);
710 if (rp->first_msg_id != clib_net_to_host_u16 (mp->first_msg_id))
712 clib_warning ("WARNING: traced plugin '%s' first message id %d not %d",
713 mp->plugin_name, clib_net_to_host_u16 (mp->first_msg_id),
717 if (rp->last_msg_id != clib_net_to_host_u16 (mp->last_msg_id))
719 clib_warning ("WARNING: traced plugin '%s' last message id %d not %d",
720 mp->plugin_name, clib_net_to_host_u16 (mp->last_msg_id),
725 #define foreach_rpc_api_msg \
726 _ (RPC_CALL, rpc_call) \
727 _ (RPC_CALL_REPLY, rpc_call_reply)
729 #define foreach_plugin_trace_msg _ (TRACE_PLUGIN_MSG_IDS, trace_plugin_msg_ids)
732 * Set the rpc callback at our earliest possible convenience.
733 * This avoids ordering issues between thread_init() -> start_workers and
734 * an init function which we could define here. If we ever intend to use
735 * vlib all by itself, we can't create a link-time dependency on
736 * an init function here and a typical "call foo_init first"
740 extern void *rpc_call_main_thread_cb_fn;
742 static clib_error_t *
743 rpc_api_hookup (vlib_main_t *vm)
745 api_main_t *am = vlibapi_get_main ();
747 vl_msg_api_config (&(vl_msg_api_msg_config_t){ \
750 .handler = vl_api_##n##_t_handler, \
751 .format_fn = vl_api_##n##_t_format, \
752 .size = sizeof (vl_api_##n##_t), \
754 .tojson = vl_api_##n##_t_tojson, \
755 .fromjson = vl_api_##n##_t_fromjson, \
756 .calc_size = vl_api_##n##_t_calc_size, \
762 vl_msg_api_config (&(vl_msg_api_msg_config_t){ \
765 .handler = vl_api_##n##_t_handler, \
766 .endian = vl_api_##n##_t_endian, \
767 .format_fn = vl_api_##n##_t_format, \
768 .size = sizeof (vl_api_##n##_t), \
770 .tojson = vl_api_##n##_t_tojson, \
771 .fromjson = vl_api_##n##_t_fromjson, \
772 .calc_size = vl_api_##n##_t_calc_size, \
774 foreach_plugin_trace_msg
777 vl_api_allow_msg_replay (am, VL_API_TRACE_PLUGIN_MSG_IDS, 0);
779 /* No reason to halt the parade to create a trace record... */
780 vl_api_set_msg_thread_safe (am, VL_API_TRACE_PLUGIN_MSG_IDS, 1);
781 rpc_call_main_thread_cb_fn = vl_api_rpc_call_main_thread;
785 VLIB_API_INIT_FUNCTION (rpc_api_hookup);
788 * fd.io coding-style-patch-verification: ON
791 * eval: (c-set-style "gnu")