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);
252 vl_api_clnt_process (vlib_main_t * vm, vlib_node_runtime_t * node,
255 int private_segment_rotor = 0, i, rv;
256 vl_socket_args_for_process_t *a;
260 api_main_t *am = vlibapi_get_main ();
261 f64 dead_client_scan_time;
262 f64 sleep_time, start_time;
266 uword *event_data = 0;
269 if ((error = vl_sock_api_init (vm)))
271 clib_error_report (error);
272 clib_warning ("socksvr_api_init failed, quitting...");
276 if ((rv = vlib_api_init ()) < 0)
278 clib_warning ("vlib_api_init returned %d, quitting...", rv);
283 q = shm->vl_input_queue;
285 e = vlib_call_init_exit_functions
286 (vm, &vm->api_init_function_registrations, 1 /* call_once */ );
288 clib_error_report (e);
291 dead_client_scan_time = vlib_time_now (vm) + 10.0;
294 * Send plugin message range messages for each plugin we loaded
296 for (i = 0; i < vec_len (am->msg_ranges); i++)
298 vl_api_msg_range_t *rp = am->msg_ranges + i;
299 send_one_plugin_msg_ids_msg (rp->name, rp->first_msg_id,
304 * Save the api message table snapshot, if configured
306 if (am->save_msg_table_filename)
307 vl_api_save_msg_table ();
309 /* $$$ pay attention to frame size, control CPU usage */
313 * There's a reason for checking the queue before
314 * sleeping. If the vlib application crashes, it's entirely
315 * possible for a client to enqueue a connect request
316 * during the process restart interval.
318 * Unless some force of physics causes the new incarnation
319 * of the application to process the request, the client will
320 * sit and wait for Godot...
322 vector_rate = (f64) vlib_last_vectors_per_main_loop (vm);
323 start_time = vlib_time_now (vm);
326 if (vl_mem_api_handle_rpc (vm, node)
327 || vl_mem_api_handle_msg_main (vm, node))
329 vm->api_queue_nonempty = 0;
330 VL_MEM_API_LOG_Q_LEN ("q-underflow: len %d", 0);
335 /* Allow no more than 10us without a pause */
336 if (vlib_time_now (vm) > start_time + 10e-6)
338 int index = SLEEP_400_US;
339 if (vector_rate > 40.0)
341 else if (vector_rate > 20.0)
343 index = SLEEP_200_US;
346 else if (vector_rate >= 1.0)
348 index = SLEEP_100_US;
356 vector_rate_histogram[index] += 1;
362 * see if we have any private api shared-memory segments
363 * If so, push required context variables, and process
366 if (PREDICT_FALSE (vec_len (am->vlib_private_rps)))
368 if (private_segment_rotor >= vec_len (am->vlib_private_rps))
369 private_segment_rotor = 0;
370 vl_mem_api_handle_msg_private (vm, node, private_segment_rotor++);
373 vlib_process_wait_for_event_or_clock (vm, sleep_time);
374 vec_reset_length (event_data);
375 event_type = vlib_process_get_events (vm, &event_data);
376 now = vlib_time_now (vm);
380 case QUEUE_SIGNAL_EVENT:
381 vm->queue_signal_pending = 0;
382 VL_MEM_API_LOG_Q_LEN ("q-awake: len %d", q->cursize);
385 case SOCKET_READ_EVENT:
386 for (i = 0; i < vec_len (event_data); i++)
388 vl_api_registration_t *regp;
390 a = pool_elt_at_index (socket_main.process_args, event_data[i]);
391 regp = vl_socket_get_registration (a->reg_index);
394 vl_socket_process_api_msg (regp, (i8 *) a->data);
395 a = pool_elt_at_index (socket_main.process_args,
399 pool_put (socket_main.process_args, a);
408 clib_warning ("unknown event type %d", event_type);
412 if (now > dead_client_scan_time)
414 vl_mem_api_dead_client_scan (am, shm, now);
415 dead_client_scan_time = vlib_time_now (vm) + 10.0;
422 VLIB_REGISTER_NODE (vl_api_clnt_node) =
424 .function = vl_api_clnt_process,
425 .type = VLIB_NODE_TYPE_PROCESS,
426 .name = "api-rx-from-ring",
427 .state = VLIB_NODE_STATE_DISABLED,
432 vl_mem_api_enable_disable (vlib_main_t * vm, int enable)
434 vlib_node_set_state (vm, vl_api_clnt_node.index,
436 ? VLIB_NODE_STATE_POLLING
437 : VLIB_NODE_STATE_DISABLED));
441 api_rx_from_node (vlib_main_t * vm,
442 vlib_node_runtime_t * node, vlib_frame_t * frame)
444 uword n_packets = frame->n_vectors;
449 vec_validate (long_msg, 4095);
450 n_left_from = frame->n_vectors;
451 from = vlib_frame_vector_args (frame);
453 while (n_left_from > 0)
461 b0 = vlib_get_buffer (vm, bi0);
465 msg = b0->data + b0->current_data;
466 msg_len = b0->current_length;
467 if (b0->flags & VLIB_BUFFER_NEXT_PRESENT)
469 ASSERT (long_msg != 0);
470 _vec_len (long_msg) = 0;
471 vec_add (long_msg, msg, msg_len);
472 while (b0->flags & VLIB_BUFFER_NEXT_PRESENT)
474 b0 = vlib_get_buffer (vm, b0->next_buffer);
475 msg = b0->data + b0->current_data;
476 msg_len = b0->current_length;
477 vec_add (long_msg, msg, msg_len);
481 vl_msg_api_handler_no_trace_no_free (msg);
484 /* Free what we've been given. */
485 vlib_buffer_free (vm, vlib_frame_vector_args (frame), n_packets);
491 VLIB_REGISTER_NODE (api_rx_from_node_node,static) = {
492 .function = api_rx_from_node,
493 .type = VLIB_NODE_TYPE_INTERNAL,
495 .name = "api-rx-from-node",
500 vl_api_rpc_call_t_handler (vl_api_rpc_call_t * mp)
502 vl_api_rpc_call_reply_t *rmp;
505 vlib_main_t *vm = vlib_get_main ();
507 if (mp->function == 0)
510 clib_warning ("rpc NULL function pointer");
515 if (mp->need_barrier_sync)
516 vlib_worker_thread_barrier_sync (vm);
518 fp = uword_to_pointer (mp->function, int (*)(void *));
521 if (mp->need_barrier_sync)
522 vlib_worker_thread_barrier_release (vm);
527 svm_queue_t *q = vl_api_client_index_to_input_queue (mp->client_index);
530 rmp = vl_msg_api_alloc_as_if_client (sizeof (*rmp));
531 rmp->_vl_msg_id = ntohs (VL_API_RPC_CALL_REPLY);
532 rmp->context = mp->context;
534 vl_msg_api_send_shmem (q, (u8 *) & rmp);
539 clib_warning ("multicast not yet implemented...");
544 vl_api_rpc_call_reply_t_handler (vl_api_rpc_call_reply_t * mp)
546 clib_warning ("unimplemented");
550 vl_api_send_pending_rpc_requests (vlib_main_t * vm)
552 vlib_main_t *vm_global = &vlib_global_main;
554 ASSERT (vm != vm_global);
556 clib_spinlock_lock_if_init (&vm_global->pending_rpc_lock);
557 vec_append (vm_global->pending_rpc_requests, vm->pending_rpc_requests);
558 vec_reset_length (vm->pending_rpc_requests);
559 clib_spinlock_unlock_if_init (&vm_global->pending_rpc_lock);
563 vl_api_rpc_call_main_thread_inline (void *fp, u8 * data, u32 data_length,
566 vl_api_rpc_call_t *mp;
567 vlib_main_t *vm_global = &vlib_global_main;
568 vlib_main_t *vm = vlib_get_main ();
570 /* Main thread and not a forced RPC: call the function directly */
571 if ((force_rpc == 0) && (vlib_get_thread_index () == 0))
573 void (*call_fp) (void *);
575 vlib_worker_thread_barrier_sync (vm);
580 vlib_worker_thread_barrier_release (vm);
584 /* Otherwise, actually do an RPC */
585 mp = vl_msg_api_alloc_as_if_client (sizeof (*mp) + data_length);
587 clib_memset (mp, 0, sizeof (*mp));
588 clib_memcpy_fast (mp->data, data, data_length);
589 mp->_vl_msg_id = ntohs (VL_API_RPC_CALL);
590 mp->function = pointer_to_uword (fp);
591 mp->need_barrier_sync = 1;
593 /* Add to the pending vector. Thread 0 requires locking. */
595 clib_spinlock_lock_if_init (&vm_global->pending_rpc_lock);
596 vec_add1 (vm->pending_rpc_requests, (uword) mp);
598 clib_spinlock_unlock_if_init (&vm_global->pending_rpc_lock);
602 * Check if called from worker threads.
603 * If so, make rpc call of fp through shmem.
604 * Otherwise, call fp directly
607 vl_api_rpc_call_main_thread (void *fp, u8 * data, u32 data_length)
609 vl_api_rpc_call_main_thread_inline (fp, data, data_length, /*force_rpc */
614 * Always make rpc call of fp through shmem, useful for calling from threads
615 * not setup as worker threads, such as DPDK callback thread
618 vl_api_force_rpc_call_main_thread (void *fp, u8 * data, u32 data_length)
620 vl_api_rpc_call_main_thread_inline (fp, data, data_length, /*force_rpc */
625 vl_api_trace_plugin_msg_ids_t_handler (vl_api_trace_plugin_msg_ids_t * mp)
627 api_main_t *am = vlibapi_get_main ();
628 vl_api_msg_range_t *rp;
631 /* Noop (except for tracing) during normal operation */
632 if (am->replay_in_progress == 0)
635 p = hash_get_mem (am->msg_range_by_name, mp->plugin_name);
638 clib_warning ("WARNING: traced plugin '%s' not in current image",
643 rp = vec_elt_at_index (am->msg_ranges, p[0]);
644 if (rp->first_msg_id != clib_net_to_host_u16 (mp->first_msg_id))
646 clib_warning ("WARNING: traced plugin '%s' first message id %d not %d",
647 mp->plugin_name, clib_net_to_host_u16 (mp->first_msg_id),
651 if (rp->last_msg_id != clib_net_to_host_u16 (mp->last_msg_id))
653 clib_warning ("WARNING: traced plugin '%s' last message id %d not %d",
654 mp->plugin_name, clib_net_to_host_u16 (mp->last_msg_id),
659 #define foreach_rpc_api_msg \
660 _(RPC_CALL,rpc_call) \
661 _(RPC_CALL_REPLY,rpc_call_reply)
663 #define foreach_plugin_trace_msg \
664 _(TRACE_PLUGIN_MSG_IDS,trace_plugin_msg_ids)
667 * Set the rpc callback at our earliest possible convenience.
668 * This avoids ordering issues between thread_init() -> start_workers and
669 * an init function which we could define here. If we ever intend to use
670 * vlib all by itself, we can't create a link-time dependency on
671 * an init function here and a typical "call foo_init first"
675 extern void *rpc_call_main_thread_cb_fn;
677 static clib_error_t *
678 rpc_api_hookup (vlib_main_t * vm)
680 api_main_t *am = vlibapi_get_main ();
682 vl_msg_api_set_handlers(VL_API_##N, #n, \
683 vl_api_##n##_t_handler, \
686 vl_api_##n##_t_print, \
687 sizeof(vl_api_##n##_t), 0 /* do not trace */);
692 vl_msg_api_set_handlers(VL_API_##N, #n, \
693 vl_api_##n##_t_handler, \
696 vl_api_##n##_t_print, \
697 sizeof(vl_api_##n##_t), 1 /* do trace */);
698 foreach_plugin_trace_msg;
701 /* No reason to halt the parade to create a trace record... */
702 am->is_mp_safe[VL_API_TRACE_PLUGIN_MSG_IDS] = 1;
703 rpc_call_main_thread_cb_fn = vl_api_rpc_call_main_thread;
707 VLIB_API_INIT_FUNCTION (rpc_api_hookup);
710 * fd.io coding-style-patch-verification: ON
713 * eval: (c-set-style "gnu")