2 *------------------------------------------------------------------
3 * vlib_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>
35 * @brief Binary API messaging via shared memory
36 * Low-level, primary provisioning interface
38 /*? %%clicmd:group_label Binary API CLI %% ?*/
39 /*? %%syscfg:group_label Binary API configuration %% ?*/
41 #define TRACE_VLIB_MEMORY_QUEUE 0
43 #include <vlibmemory/vl_memory_msg_enum.h> /* enumerate all vlib messages */
45 #define vl_typedefs /* define message structures */
46 #include <vlibmemory/vl_memory_api_h.h>
49 /* instantiate all the print functions we know about */
50 #define vl_print(handle, ...) vlib_cli_output (handle, __VA_ARGS__)
52 #include <vlibmemory/vl_memory_api_h.h>
56 vl_api_trace_plugin_msg_ids_t_print (vl_api_trace_plugin_msg_ids_t * a,
59 vl_print (handle, "vl_api_trace_plugin_msg_ids: %s first %u last %u\n",
61 clib_host_to_net_u16 (a->first_msg_id),
62 clib_host_to_net_u16 (a->last_msg_id));
66 /* instantiate all the endian swap functions we know about */
68 #include <vlibmemory/vl_memory_api_h.h>
72 vl_api_get_first_msg_id_t_handler (vl_api_get_first_msg_id_t * mp)
74 vl_api_get_first_msg_id_reply_t *rmp;
75 vl_api_registration_t *regp;
77 api_main_t *am = vlibapi_get_main ();
78 vl_api_msg_range_t *rp;
80 u16 first_msg_id = ~0;
81 int rv = -7; /* VNET_API_ERROR_INVALID_VALUE */
83 regp = vl_api_client_index_to_registration (mp->client_index);
87 if (am->msg_range_by_name == 0)
89 strncpy ((char *) name, (char *) mp->name, ARRAY_LEN (name));
90 name[ARRAY_LEN (name) - 1] = '\0';
91 p = hash_get_mem (am->msg_range_by_name, name);
95 rp = vec_elt_at_index (am->msg_ranges, p[0]);
96 first_msg_id = rp->first_msg_id;
100 rmp = vl_msg_api_alloc (sizeof (*rmp));
101 rmp->_vl_msg_id = ntohs (VL_API_GET_FIRST_MSG_ID_REPLY);
102 rmp->context = mp->context;
103 rmp->retval = ntohl (rv);
104 rmp->first_msg_id = ntohs (first_msg_id);
105 vl_api_send_msg (regp, (u8 *) rmp);
109 vl_api_api_versions_t_handler (vl_api_api_versions_t * mp)
111 api_main_t *am = vlibapi_get_main ();
112 vl_api_api_versions_reply_t *rmp;
113 vl_api_registration_t *reg;
114 u32 nmsg = vec_len (am->api_version_list);
115 int msg_size = sizeof (*rmp) + sizeof (rmp->api_versions[0]) * nmsg;
118 reg = vl_api_client_index_to_registration (mp->client_index);
122 rmp = vl_msg_api_alloc (msg_size);
123 clib_memset (rmp, 0, msg_size);
124 rmp->_vl_msg_id = ntohs (VL_API_API_VERSIONS_REPLY);
126 /* fill in the message */
127 rmp->context = mp->context;
128 rmp->count = htonl (nmsg);
130 for (i = 0; i < nmsg; ++i)
132 api_version_t *vl = &am->api_version_list[i];
133 rmp->api_versions[i].major = htonl (vl->major);
134 rmp->api_versions[i].minor = htonl (vl->minor);
135 rmp->api_versions[i].patch = htonl (vl->patch);
136 strncpy ((char *) rmp->api_versions[i].name, vl->name,
137 ARRAY_LEN (rmp->api_versions[i].name));
138 rmp->api_versions[i].name[ARRAY_LEN (rmp->api_versions[i].name) - 1] =
142 vl_api_send_msg (reg, (u8 *) rmp);
145 #define foreach_vlib_api_msg \
146 _(GET_FIRST_MSG_ID, get_first_msg_id) \
147 _(API_VERSIONS, api_versions)
155 vl_msg_api_msg_config_t cfg;
156 vl_msg_api_msg_config_t *c = &cfg;
158 clib_memset (c, 0, sizeof (*c));
160 #define _(N,n) do { \
161 c->id = VL_API_##N; \
163 c->handler = vl_api_##n##_t_handler; \
164 c->cleanup = vl_noop_handler; \
165 c->endian = vl_api_##n##_t_endian; \
166 c->print = vl_api_##n##_t_print; \
167 c->size = sizeof(vl_api_##n##_t); \
168 c->traced = 1; /* trace, so these msgs print */ \
169 c->replay = 0; /* don't replay client create/delete msgs */ \
170 c->message_bounce = 0; /* don't bounce this message */ \
171 vl_msg_api_config(c);} while (0);
173 foreach_vlib_api_msg;
179 u64 vector_rate_histogram[SLEEP_N_BUCKETS];
182 * Callback to send ourselves a plugin numbering-space trace msg
185 send_one_plugin_msg_ids_msg (u8 * name, u16 first_msg_id, u16 last_msg_id)
187 vl_api_trace_plugin_msg_ids_t *mp;
188 api_main_t *am = vlibapi_get_main ();
189 vl_shmem_hdr_t *shmem_hdr = am->shmem_hdr;
192 mp = vl_msg_api_alloc_as_if_client (sizeof (*mp));
193 clib_memset (mp, 0, sizeof (*mp));
195 mp->_vl_msg_id = clib_host_to_net_u16 (VL_API_TRACE_PLUGIN_MSG_IDS);
196 strncpy ((char *) mp->plugin_name, (char *) name,
197 sizeof (mp->plugin_name) - 1);
198 mp->first_msg_id = clib_host_to_net_u16 (first_msg_id);
199 mp->last_msg_id = clib_host_to_net_u16 (last_msg_id);
201 q = shmem_hdr->vl_input_queue;
203 vl_msg_api_send_shmem (q, (u8 *) & mp);
207 vl_api_save_msg_table (void)
209 u8 *serialized_message_table;
210 api_main_t *am = vlibapi_get_main ();
215 * Snapshoot the api message table.
217 if (strstr ((char *) am->save_msg_table_filename, "..")
218 || index ((char *) am->save_msg_table_filename, '/'))
220 clib_warning ("illegal save-message-table filename '%s'",
221 am->save_msg_table_filename);
225 chroot_file = format (0, "/tmp/%s%c", am->save_msg_table_filename, 0);
227 fd = creat ((char *) chroot_file, 0644);
231 clib_unix_warning ("creat");
235 serialized_message_table = vl_api_serialize_message_table (am, 0);
237 rv = write (fd, serialized_message_table,
238 vec_len (serialized_message_table));
240 if (rv != vec_len (serialized_message_table))
241 clib_unix_warning ("write");
245 clib_unix_warning ("close");
247 vec_free (chroot_file);
248 vec_free (serialized_message_table);
251 clib_error_t *vat_builtin_main_init (vlib_main_t * vm) __attribute__ ((weak));
253 vat_builtin_main_init (vlib_main_t * vm)
259 vl_api_clnt_process (vlib_main_t * vm, vlib_node_runtime_t * node,
262 vlib_global_main_t *vgm = vlib_get_global_main ();
263 int private_segment_rotor = 0, i, rv;
264 vl_socket_args_for_process_t *a;
268 api_main_t *am = vlibapi_get_main ();
269 f64 dead_client_scan_time;
270 f64 sleep_time, start_time;
274 uword *event_data = 0;
277 if ((error = vl_sock_api_init (vm)))
279 clib_error_report (error);
280 clib_warning ("socksvr_api_init failed, quitting...");
284 if ((rv = vlib_api_init ()) < 0)
286 clib_warning ("vlib_api_init returned %d, quitting...", rv);
291 q = shm->vl_input_queue;
293 e = vlib_call_init_exit_functions (vm, &vgm->api_init_function_registrations,
294 1 /* call_once */, 1 /* is_global */);
296 clib_error_report (e);
298 e = vat_builtin_main_init (vm);
300 clib_error_report (e);
303 dead_client_scan_time = vlib_time_now (vm) + 10.0;
306 * Send plugin message range messages for each plugin we loaded
308 for (i = 0; i < vec_len (am->msg_ranges); i++)
310 vl_api_msg_range_t *rp = am->msg_ranges + i;
311 send_one_plugin_msg_ids_msg (rp->name, rp->first_msg_id,
316 * Save the api message table snapshot, if configured
318 if (am->save_msg_table_filename)
319 vl_api_save_msg_table ();
321 /* $$$ pay attention to frame size, control CPU usage */
325 * There's a reason for checking the queue before
326 * sleeping. If the vlib application crashes, it's entirely
327 * possible for a client to enqueue a connect request
328 * during the process restart interval.
330 * Unless some force of physics causes the new incarnation
331 * of the application to process the request, the client will
332 * sit and wait for Godot...
334 vector_rate = (f64) vlib_last_vectors_per_main_loop (vm);
335 start_time = vlib_time_now (vm);
338 if (vl_mem_api_handle_rpc (vm, node)
339 || vl_mem_api_handle_msg_main (vm, node))
341 vm->api_queue_nonempty = 0;
342 VL_MEM_API_LOG_Q_LEN ("q-underflow: len %d", 0);
347 /* Allow no more than 10us without a pause */
348 if (vlib_time_now (vm) > start_time + 10e-6)
350 int index = SLEEP_400_US;
351 if (vector_rate > 40.0)
353 else if (vector_rate > 20.0)
355 index = SLEEP_200_US;
358 else if (vector_rate >= 1.0)
360 index = SLEEP_100_US;
368 vector_rate_histogram[index] += 1;
374 * see if we have any private api shared-memory segments
375 * If so, push required context variables, and process
378 if (PREDICT_FALSE (vec_len (am->vlib_private_rps)))
380 if (private_segment_rotor >= vec_len (am->vlib_private_rps))
381 private_segment_rotor = 0;
382 vl_mem_api_handle_msg_private (vm, node, private_segment_rotor++);
385 vlib_process_wait_for_event_or_clock (vm, sleep_time);
386 vec_reset_length (event_data);
387 event_type = vlib_process_get_events (vm, &event_data);
388 now = vlib_time_now (vm);
392 case QUEUE_SIGNAL_EVENT:
393 vm->queue_signal_pending = 0;
394 VL_MEM_API_LOG_Q_LEN ("q-awake: len %d", q->cursize);
397 case SOCKET_READ_EVENT:
398 for (i = 0; i < vec_len (event_data); i++)
400 vl_api_registration_t *regp;
402 a = pool_elt_at_index (socket_main.process_args, event_data[i]);
403 regp = vl_socket_get_registration (a->reg_index);
406 vl_socket_process_api_msg (regp, (i8 *) a->data);
407 a = pool_elt_at_index (socket_main.process_args,
411 pool_put (socket_main.process_args, a);
420 clib_warning ("unknown event type %d", event_type);
424 if (now > dead_client_scan_time)
426 vl_mem_api_dead_client_scan (am, shm, now);
427 dead_client_scan_time = vlib_time_now (vm) + 10.0;
434 VLIB_REGISTER_NODE (vl_api_clnt_node) =
436 .function = vl_api_clnt_process,
437 .type = VLIB_NODE_TYPE_PROCESS,
438 .name = "api-rx-from-ring",
439 .state = VLIB_NODE_STATE_DISABLED,
440 .process_log2_n_stack_bytes = 18,
445 vl_mem_api_enable_disable (vlib_main_t * vm, int enable)
447 vlib_node_set_state (vm, vl_api_clnt_node.index,
449 ? VLIB_NODE_STATE_POLLING
450 : VLIB_NODE_STATE_DISABLED));
454 api_rx_from_node (vlib_main_t * vm,
455 vlib_node_runtime_t * node, vlib_frame_t * frame)
457 uword n_packets = frame->n_vectors;
462 vec_validate (long_msg, 4095);
463 n_left_from = frame->n_vectors;
464 from = vlib_frame_vector_args (frame);
466 while (n_left_from > 0)
474 b0 = vlib_get_buffer (vm, bi0);
478 msg = b0->data + b0->current_data;
479 msg_len = b0->current_length;
480 if (b0->flags & VLIB_BUFFER_NEXT_PRESENT)
482 ASSERT (long_msg != 0);
483 _vec_len (long_msg) = 0;
484 vec_add (long_msg, msg, msg_len);
485 while (b0->flags & VLIB_BUFFER_NEXT_PRESENT)
487 b0 = vlib_get_buffer (vm, b0->next_buffer);
488 msg = b0->data + b0->current_data;
489 msg_len = b0->current_length;
490 vec_add (long_msg, msg, msg_len);
494 vl_msg_api_handler_no_trace_no_free (msg);
497 /* Free what we've been given. */
498 vlib_buffer_free (vm, vlib_frame_vector_args (frame), n_packets);
504 VLIB_REGISTER_NODE (api_rx_from_node_node,static) = {
505 .function = api_rx_from_node,
506 .type = VLIB_NODE_TYPE_INTERNAL,
508 .name = "api-rx-from-node",
513 vl_api_rpc_call_t_handler (vl_api_rpc_call_t * mp)
515 vl_api_rpc_call_reply_t *rmp;
518 vlib_main_t *vm = vlib_get_main ();
520 if (mp->function == 0)
523 clib_warning ("rpc NULL function pointer");
528 if (mp->need_barrier_sync)
529 vlib_worker_thread_barrier_sync (vm);
531 fp = uword_to_pointer (mp->function, int (*)(void *));
534 if (mp->need_barrier_sync)
535 vlib_worker_thread_barrier_release (vm);
540 svm_queue_t *q = vl_api_client_index_to_input_queue (mp->client_index);
543 rmp = vl_msg_api_alloc_as_if_client (sizeof (*rmp));
544 rmp->_vl_msg_id = ntohs (VL_API_RPC_CALL_REPLY);
545 rmp->context = mp->context;
547 vl_msg_api_send_shmem (q, (u8 *) & rmp);
552 clib_warning ("multicast not yet implemented...");
557 vl_api_rpc_call_reply_t_handler (vl_api_rpc_call_reply_t * mp)
559 clib_warning ("unimplemented");
563 vl_api_send_pending_rpc_requests (vlib_main_t * vm)
565 vlib_main_t *vm_global = vlib_get_first_main ();
567 ASSERT (vm != vm_global);
569 clib_spinlock_lock_if_init (&vm_global->pending_rpc_lock);
570 vec_append (vm_global->pending_rpc_requests, vm->pending_rpc_requests);
571 vec_reset_length (vm->pending_rpc_requests);
572 clib_spinlock_unlock_if_init (&vm_global->pending_rpc_lock);
576 vl_api_rpc_call_main_thread_inline (void *fp, u8 * data, u32 data_length,
579 vl_api_rpc_call_t *mp;
580 vlib_main_t *vm_global = vlib_get_first_main ();
581 vlib_main_t *vm = vlib_get_main ();
583 /* Main thread and not a forced RPC: call the function directly */
584 if ((force_rpc == 0) && (vlib_get_thread_index () == 0))
586 void (*call_fp) (void *);
588 vlib_worker_thread_barrier_sync (vm);
593 vlib_worker_thread_barrier_release (vm);
597 /* Otherwise, actually do an RPC */
598 mp = vl_msg_api_alloc_as_if_client (sizeof (*mp) + data_length);
600 clib_memset (mp, 0, sizeof (*mp));
601 clib_memcpy_fast (mp->data, data, data_length);
602 mp->_vl_msg_id = ntohs (VL_API_RPC_CALL);
603 mp->function = pointer_to_uword (fp);
604 mp->need_barrier_sync = 1;
606 /* Add to the pending vector. Thread 0 requires locking. */
608 clib_spinlock_lock_if_init (&vm_global->pending_rpc_lock);
609 vec_add1 (vm->pending_rpc_requests, (uword) mp);
611 clib_spinlock_unlock_if_init (&vm_global->pending_rpc_lock);
615 * Check if called from worker threads.
616 * If so, make rpc call of fp through shmem.
617 * Otherwise, call fp directly
620 vl_api_rpc_call_main_thread (void *fp, u8 * data, u32 data_length)
622 vl_api_rpc_call_main_thread_inline (fp, data, data_length, /*force_rpc */
627 * Always make rpc call of fp through shmem, useful for calling from threads
628 * not setup as worker threads, such as DPDK callback thread
631 vl_api_force_rpc_call_main_thread (void *fp, u8 * data, u32 data_length)
633 vl_api_rpc_call_main_thread_inline (fp, data, data_length, /*force_rpc */
638 vl_api_trace_plugin_msg_ids_t_handler (vl_api_trace_plugin_msg_ids_t * mp)
640 api_main_t *am = vlibapi_get_main ();
641 vl_api_msg_range_t *rp;
644 /* Noop (except for tracing) during normal operation */
645 if (am->replay_in_progress == 0)
648 p = hash_get_mem (am->msg_range_by_name, mp->plugin_name);
651 clib_warning ("WARNING: traced plugin '%s' not in current image",
656 rp = vec_elt_at_index (am->msg_ranges, p[0]);
657 if (rp->first_msg_id != clib_net_to_host_u16 (mp->first_msg_id))
659 clib_warning ("WARNING: traced plugin '%s' first message id %d not %d",
660 mp->plugin_name, clib_net_to_host_u16 (mp->first_msg_id),
664 if (rp->last_msg_id != clib_net_to_host_u16 (mp->last_msg_id))
666 clib_warning ("WARNING: traced plugin '%s' last message id %d not %d",
667 mp->plugin_name, clib_net_to_host_u16 (mp->last_msg_id),
672 #define foreach_rpc_api_msg \
673 _(RPC_CALL,rpc_call) \
674 _(RPC_CALL_REPLY,rpc_call_reply)
676 #define foreach_plugin_trace_msg \
677 _(TRACE_PLUGIN_MSG_IDS,trace_plugin_msg_ids)
680 * Set the rpc callback at our earliest possible convenience.
681 * This avoids ordering issues between thread_init() -> start_workers and
682 * an init function which we could define here. If we ever intend to use
683 * vlib all by itself, we can't create a link-time dependency on
684 * an init function here and a typical "call foo_init first"
688 extern void *rpc_call_main_thread_cb_fn;
690 static clib_error_t *
691 rpc_api_hookup (vlib_main_t * vm)
693 api_main_t *am = vlibapi_get_main ();
695 vl_msg_api_set_handlers(VL_API_##N, #n, \
696 vl_api_##n##_t_handler, \
699 vl_api_##n##_t_print, \
700 sizeof(vl_api_##n##_t), 0 /* do not trace */);
705 vl_msg_api_set_handlers(VL_API_##N, #n, \
706 vl_api_##n##_t_handler, \
709 vl_api_##n##_t_print, \
710 sizeof(vl_api_##n##_t), 1 /* do trace */);
711 foreach_plugin_trace_msg;
714 /* No reason to halt the parade to create a trace record... */
715 am->is_mp_safe[VL_API_TRACE_PLUGIN_MSG_IDS] = 1;
716 rpc_call_main_thread_cb_fn = vl_api_rpc_call_main_thread;
720 VLIB_API_INIT_FUNCTION (rpc_api_hookup);
723 * fd.io coding-style-patch-verification: ON
726 * eval: (c-set-style "gnu")