Line data Source code
1 : /*
2 : *------------------------------------------------------------------
3 : * memclnt_api.c VLIB API implementation
4 : *
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:
9 : *
10 : * http://www.apache.org/licenses/LICENSE-2.0
11 : *
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 : *------------------------------------------------------------------
18 : */
19 :
20 : #include <fcntl.h>
21 : #include <pthread.h>
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>
33 :
34 : /**
35 : * @file
36 : * @brief Binary API messaging via shared memory
37 : * Low-level, primary provisioning interface
38 : */
39 : /*? %%clicmd:group_label Binary API CLI %% ?*/
40 : /*? %%syscfg:group_label Binary API configuration %% ?*/
41 :
42 : #define TRACE_VLIB_MEMORY_QUEUE 0
43 :
44 : #include <vlibmemory/vl_memory_msg_enum.h> /* enumerate all vlib messages */
45 :
46 : #define vl_typedefs /* define message structures */
47 : #include <vlibmemory/vl_memory_api_h.h>
48 : #undef vl_typedefs
49 :
50 : /* instantiate all the print functions we know about */
51 : #define vl_printfun
52 : #include <vlibmemory/vl_memory_api_h.h>
53 : #undef vl_printfun
54 :
55 : /* instantiate all the endian swap functions we know about */
56 : #define vl_endianfun
57 : #include <vlibmemory/vl_memory_api_h.h>
58 : #undef vl_endianfun
59 :
60 : #define vl_calcsizefun
61 : #include <vlibmemory/vl_memory_api_h.h>
62 : #undef vl_calcsizefun
63 :
64 : static void
65 42 : vl_api_get_first_msg_id_t_handler (vl_api_get_first_msg_id_t *mp)
66 : {
67 : vl_api_get_first_msg_id_reply_t *rmp;
68 : vl_api_registration_t *regp;
69 : uword *p;
70 42 : api_main_t *am = vlibapi_get_main ();
71 : vl_api_msg_range_t *rp;
72 : u8 name[64];
73 42 : u16 first_msg_id = ~0;
74 42 : int rv = -7; /* VNET_API_ERROR_INVALID_VALUE */
75 :
76 42 : regp = vl_api_client_index_to_registration (mp->client_index);
77 42 : if (!regp)
78 0 : return;
79 :
80 42 : if (am->msg_range_by_name == 0)
81 0 : goto out;
82 42 : strncpy ((char *) name, (char *) mp->name, ARRAY_LEN (name));
83 42 : name[ARRAY_LEN (name) - 1] = '\0';
84 42 : p = hash_get_mem (am->msg_range_by_name, name);
85 42 : if (p == 0)
86 0 : goto out;
87 :
88 42 : rp = vec_elt_at_index (am->msg_ranges, p[0]);
89 42 : first_msg_id = rp->first_msg_id;
90 42 : rv = 0;
91 :
92 42 : out:
93 42 : rmp = vl_msg_api_alloc (sizeof (*rmp));
94 42 : rmp->_vl_msg_id = ntohs (VL_API_GET_FIRST_MSG_ID_REPLY);
95 42 : rmp->context = mp->context;
96 42 : rmp->retval = ntohl (rv);
97 42 : rmp->first_msg_id = ntohs (first_msg_id);
98 42 : vl_api_send_msg (regp, (u8 *) rmp);
99 : }
100 :
101 : void
102 0 : vl_api_api_versions_t_handler (vl_api_api_versions_t *mp)
103 : {
104 0 : api_main_t *am = vlibapi_get_main ();
105 : vl_api_api_versions_reply_t *rmp;
106 : vl_api_registration_t *reg;
107 0 : u32 nmsg = vec_len (am->api_version_list);
108 0 : int msg_size = sizeof (*rmp) + sizeof (rmp->api_versions[0]) * nmsg;
109 : int i;
110 :
111 0 : reg = vl_api_client_index_to_registration (mp->client_index);
112 0 : if (!reg)
113 0 : return;
114 :
115 0 : rmp = vl_msg_api_alloc (msg_size);
116 0 : clib_memset (rmp, 0, msg_size);
117 0 : rmp->_vl_msg_id = ntohs (VL_API_API_VERSIONS_REPLY);
118 :
119 : /* fill in the message */
120 0 : rmp->context = mp->context;
121 0 : rmp->count = htonl (nmsg);
122 :
123 0 : for (i = 0; i < nmsg; ++i)
124 : {
125 0 : api_version_t *vl = &am->api_version_list[i];
126 0 : rmp->api_versions[i].major = htonl (vl->major);
127 0 : rmp->api_versions[i].minor = htonl (vl->minor);
128 0 : rmp->api_versions[i].patch = htonl (vl->patch);
129 0 : strncpy ((char *) rmp->api_versions[i].name, vl->name,
130 : ARRAY_LEN (rmp->api_versions[i].name));
131 0 : rmp->api_versions[i].name[ARRAY_LEN (rmp->api_versions[i].name) - 1] =
132 : '\0';
133 : }
134 :
135 0 : vl_api_send_msg (reg, (u8 *) rmp);
136 : }
137 :
138 : static void
139 28648 : vl_api_control_ping_t_handler (vl_api_control_ping_t *mp)
140 : {
141 : vl_api_control_ping_reply_t *rmp;
142 28648 : int rv = 0;
143 :
144 28648 : REPLY_MACRO2 (VL_API_CONTROL_PING_REPLY,
145 : ({ rmp->vpe_pid = ntohl (getpid ()); }));
146 : }
147 :
148 : #define foreach_vlib_api_msg \
149 : _ (GET_FIRST_MSG_ID, get_first_msg_id) \
150 : _ (API_VERSIONS, api_versions) \
151 : _ (CONTROL_PING, control_ping)
152 :
153 : /*
154 : * vl_api_init
155 : */
156 : static int
157 559 : vlib_api_init (void)
158 : {
159 559 : api_main_t *am = vlibapi_get_main ();
160 : vl_msg_api_msg_config_t cfg;
161 559 : vl_msg_api_msg_config_t *c = &cfg;
162 :
163 559 : cJSON_Hooks cjson_hooks = {
164 : .malloc_fn = clib_mem_alloc,
165 : .free_fn = clib_mem_free,
166 : };
167 559 : cJSON_InitHooks (&cjson_hooks);
168 :
169 559 : clib_memset (c, 0, sizeof (*c));
170 :
171 : #define _(N, n) \
172 : do \
173 : { \
174 : c->id = VL_API_##N; \
175 : c->name = #n; \
176 : c->handler = vl_api_##n##_t_handler; \
177 : c->endian = vl_api_##n##_t_endian; \
178 : c->format_fn = vl_api_##n##_t_format; \
179 : c->tojson = vl_api_##n##_t_tojson; \
180 : c->fromjson = vl_api_##n##_t_fromjson; \
181 : c->calc_size = vl_api_##n##_t_calc_size; \
182 : c->size = sizeof (vl_api_##n##_t); \
183 : c->traced = 1; /* trace, so these msgs print */ \
184 : c->replay = 0; /* don't replay client create/delete msgs */ \
185 : c->message_bounce = 0; /* don't bounce this message */ \
186 : vl_msg_api_config (c); \
187 : } \
188 : while (0);
189 :
190 559 : foreach_vlib_api_msg;
191 : #undef _
192 :
193 559 : vl_api_set_msg_thread_safe (am, VL_API_CONTROL_PING, 1);
194 559 : vl_api_set_msg_thread_safe (am, VL_API_CONTROL_PING_REPLY, 1);
195 :
196 559 : return 0;
197 : }
198 :
199 : u64 vector_rate_histogram[SLEEP_N_BUCKETS];
200 :
201 : /*
202 : * Callback to send ourselves a plugin numbering-space trace msg
203 : */
204 : static void
205 58697 : send_one_plugin_msg_ids_msg (u8 *name, u16 first_msg_id, u16 last_msg_id)
206 : {
207 : vl_api_trace_plugin_msg_ids_t *mp;
208 58697 : api_main_t *am = vlibapi_get_main ();
209 58697 : vl_shmem_hdr_t *shmem_hdr = am->shmem_hdr;
210 : svm_queue_t *q;
211 :
212 58697 : mp = vl_msg_api_alloc_as_if_client (sizeof (*mp));
213 58697 : clib_memset (mp, 0, sizeof (*mp));
214 :
215 58697 : mp->_vl_msg_id = clib_host_to_net_u16 (VL_API_TRACE_PLUGIN_MSG_IDS);
216 58697 : strncpy ((char *) mp->plugin_name, (char *) name,
217 : sizeof (mp->plugin_name) - 1);
218 58697 : mp->first_msg_id = clib_host_to_net_u16 (first_msg_id);
219 58697 : mp->last_msg_id = clib_host_to_net_u16 (last_msg_id);
220 :
221 58697 : q = shmem_hdr->vl_input_queue;
222 :
223 58697 : vl_msg_api_send_shmem (q, (u8 *) &mp);
224 58697 : }
225 :
226 : void
227 0 : vl_api_save_msg_table (void)
228 : {
229 : u8 *serialized_message_table;
230 0 : api_main_t *am = vlibapi_get_main ();
231 : u8 *chroot_file;
232 : int fd, rv;
233 :
234 : /*
235 : * Snapshoot the api message table.
236 : */
237 0 : if (strstr ((char *) am->save_msg_table_filename, "..") ||
238 0 : index ((char *) am->save_msg_table_filename, '/'))
239 : {
240 0 : clib_warning ("illegal save-message-table filename '%s'",
241 : am->save_msg_table_filename);
242 0 : return;
243 : }
244 :
245 0 : chroot_file = format (0, "/tmp/%s%c", am->save_msg_table_filename, 0);
246 :
247 0 : fd = creat ((char *) chroot_file, 0644);
248 :
249 0 : if (fd < 0)
250 : {
251 0 : clib_unix_warning ("creat");
252 0 : return;
253 : }
254 :
255 0 : serialized_message_table = vl_api_serialize_message_table (am, 0);
256 :
257 0 : rv =
258 0 : write (fd, serialized_message_table, vec_len (serialized_message_table));
259 :
260 0 : if (rv != vec_len (serialized_message_table))
261 0 : clib_unix_warning ("write");
262 :
263 0 : rv = close (fd);
264 0 : if (rv < 0)
265 0 : clib_unix_warning ("close");
266 :
267 0 : vec_free (chroot_file);
268 0 : vec_free (serialized_message_table);
269 : }
270 :
271 : clib_error_t *vat_builtin_main_init (vlib_main_t *vm) __attribute__ ((weak));
272 : clib_error_t *
273 0 : vat_builtin_main_init (vlib_main_t *vm)
274 : {
275 0 : return 0;
276 : }
277 :
278 : static uword
279 559 : vl_api_clnt_process (vlib_main_t *vm, vlib_node_runtime_t *node,
280 : vlib_frame_t *f)
281 : {
282 559 : vlib_global_main_t *vgm = vlib_get_global_main ();
283 559 : int private_segment_rotor = 0, i, rv;
284 : vl_socket_args_for_process_t *a;
285 : vl_shmem_hdr_t *shm;
286 : svm_queue_t *q;
287 : clib_error_t *e;
288 559 : api_main_t *am = vlibapi_get_main ();
289 : f64 dead_client_scan_time;
290 : f64 sleep_time, start_time;
291 : f64 vector_rate;
292 : clib_error_t *error;
293 : uword event_type;
294 559 : uword *event_data = 0;
295 : f64 now;
296 :
297 559 : if ((error = vl_sock_api_init (vm)))
298 : {
299 0 : clib_error_report (error);
300 0 : clib_warning ("socksvr_api_init failed, quitting...");
301 0 : return 0;
302 : }
303 :
304 559 : if ((rv = vlib_api_init ()) < 0)
305 : {
306 0 : clib_warning ("vlib_api_init returned %d, quitting...", rv);
307 0 : return 0;
308 : }
309 :
310 559 : shm = am->shmem_hdr;
311 559 : q = shm->vl_input_queue;
312 :
313 559 : e = vlib_call_init_exit_functions (vm, &vgm->api_init_function_registrations,
314 : 1 /* call_once */, 1 /* is_global */);
315 559 : if (e)
316 0 : clib_error_report (e);
317 :
318 559 : e = vat_builtin_main_init (vm);
319 559 : if (e)
320 0 : clib_error_report (e);
321 :
322 559 : sleep_time = 10.0;
323 559 : dead_client_scan_time = vlib_time_now (vm) + 10.0;
324 :
325 : /*
326 : * Send plugin message range messages for each plugin we loaded
327 : */
328 59256 : for (i = 0; i < vec_len (am->msg_ranges); i++)
329 : {
330 58697 : vl_api_msg_range_t *rp = am->msg_ranges + i;
331 58697 : send_one_plugin_msg_ids_msg (rp->name, rp->first_msg_id,
332 58697 : rp->last_msg_id);
333 : }
334 :
335 : /*
336 : * Save the api message table snapshot, if configured
337 : */
338 559 : if (am->save_msg_table_filename)
339 0 : vl_api_save_msg_table ();
340 :
341 : /* $$$ pay attention to frame size, control CPU usage */
342 : while (1)
343 : {
344 : /*
345 : * There's a reason for checking the queue before
346 : * sleeping. If the vlib application crashes, it's entirely
347 : * possible for a client to enqueue a connect request
348 : * during the process restart interval.
349 : *
350 : * Unless some force of physics causes the new incarnation
351 : * of the application to process the request, the client will
352 : * sit and wait for Godot...
353 : */
354 426037 : vector_rate = (f64) vlib_last_vectors_per_main_loop (vm);
355 426037 : start_time = vlib_time_now (vm);
356 : while (1)
357 : {
358 949872 : if (vl_mem_api_handle_rpc (vm, node) ||
359 474936 : vl_mem_api_handle_msg_main (vm, node))
360 : {
361 415739 : vm->api_queue_nonempty = 0;
362 : VL_MEM_API_LOG_Q_LEN ("q-underflow: len %d", 0);
363 415739 : sleep_time = 20.0;
364 415739 : break;
365 : }
366 :
367 : /* Allow no more than 10us without a pause */
368 59197 : if (vlib_time_now (vm) > start_time + 10e-6)
369 : {
370 10298 : int index = SLEEP_400_US;
371 10298 : if (vector_rate > 40.0)
372 0 : sleep_time = 400e-6;
373 10298 : else if (vector_rate > 20.0)
374 : {
375 0 : index = SLEEP_200_US;
376 0 : sleep_time = 200e-6;
377 : }
378 10298 : else if (vector_rate >= 1.0)
379 : {
380 0 : index = SLEEP_100_US;
381 0 : sleep_time = 100e-6;
382 : }
383 : else
384 : {
385 10298 : index = SLEEP_10_US;
386 10298 : sleep_time = 10e-6;
387 : }
388 10298 : vector_rate_histogram[index] += 1;
389 10298 : break;
390 : }
391 : }
392 :
393 : /*
394 : * see if we have any private api shared-memory segments
395 : * If so, push required context variables, and process
396 : * a message.
397 : */
398 426037 : if (PREDICT_FALSE (vec_len (am->vlib_private_rps)))
399 : {
400 732 : if (private_segment_rotor >= vec_len (am->vlib_private_rps))
401 321 : private_segment_rotor = 0;
402 732 : vl_mem_api_handle_msg_private (vm, node, private_segment_rotor++);
403 : }
404 :
405 426037 : vlib_process_wait_for_event_or_clock (vm, sleep_time);
406 425478 : vec_reset_length (event_data);
407 425478 : event_type = vlib_process_get_events (vm, &event_data);
408 425478 : now = vlib_time_now (vm);
409 :
410 425478 : switch (event_type)
411 : {
412 10919 : case QUEUE_SIGNAL_EVENT:
413 10919 : vm->queue_signal_pending = 0;
414 : VL_MEM_API_LOG_Q_LEN ("q-awake: len %d", q->cursize);
415 :
416 10919 : break;
417 414208 : case SOCKET_READ_EVENT:
418 839766 : for (i = 0; i < vec_len (event_data); i++)
419 : {
420 : vl_api_registration_t *regp;
421 :
422 425558 : a = pool_elt_at_index (socket_main.process_args, event_data[i]);
423 425558 : regp = vl_socket_get_registration (a->reg_index);
424 425558 : if (regp)
425 : {
426 425558 : vl_socket_process_api_msg (regp, (i8 *) a->data);
427 425558 : a = pool_elt_at_index (socket_main.process_args,
428 : event_data[i]);
429 : }
430 425558 : vec_free (a->data);
431 425558 : pool_put (socket_main.process_args, a);
432 : }
433 414208 : break;
434 :
435 : /* Timeout... */
436 351 : case -1:
437 351 : break;
438 :
439 0 : default:
440 0 : clib_warning ("unknown event type %d", event_type);
441 0 : break;
442 : }
443 :
444 425478 : if (now > dead_client_scan_time)
445 : {
446 469 : vl_mem_api_dead_client_scan (am, shm, now);
447 469 : dead_client_scan_time = vlib_time_now (vm) + 10.0;
448 : }
449 : }
450 :
451 : return 0;
452 : }
453 :
454 178120 : VLIB_REGISTER_NODE (vl_api_clnt_node) = {
455 : .function = vl_api_clnt_process,
456 : .type = VLIB_NODE_TYPE_PROCESS,
457 : .name = "api-rx-from-ring",
458 : .state = VLIB_NODE_STATE_DISABLED,
459 : .process_log2_n_stack_bytes = 18,
460 : };
461 :
462 : void
463 559 : vl_mem_api_enable_disable (vlib_main_t *vm, int enable)
464 : {
465 559 : vlib_node_set_state (
466 : vm, vl_api_clnt_node.index,
467 : (enable ? VLIB_NODE_STATE_POLLING : VLIB_NODE_STATE_DISABLED));
468 559 : }
469 :
470 : static uword
471 0 : api_rx_from_node (vlib_main_t *vm, vlib_node_runtime_t *node,
472 : vlib_frame_t *frame)
473 : {
474 0 : uword n_packets = frame->n_vectors;
475 : uword n_left_from;
476 : u32 *from;
477 : static u8 *long_msg;
478 :
479 0 : vec_validate (long_msg, 4095);
480 0 : n_left_from = frame->n_vectors;
481 0 : from = vlib_frame_vector_args (frame);
482 :
483 0 : while (n_left_from > 0)
484 : {
485 : u32 bi0;
486 : vlib_buffer_t *b0;
487 : void *msg;
488 : uword msg_len;
489 :
490 0 : bi0 = from[0];
491 0 : b0 = vlib_get_buffer (vm, bi0);
492 0 : from += 1;
493 0 : n_left_from -= 1;
494 :
495 0 : msg = b0->data + b0->current_data;
496 0 : msg_len = b0->current_length;
497 0 : if (b0->flags & VLIB_BUFFER_NEXT_PRESENT)
498 : {
499 0 : ASSERT (long_msg != 0);
500 0 : vec_set_len (long_msg, 0);
501 0 : vec_add (long_msg, msg, msg_len);
502 0 : while (b0->flags & VLIB_BUFFER_NEXT_PRESENT)
503 : {
504 0 : b0 = vlib_get_buffer (vm, b0->next_buffer);
505 0 : msg = b0->data + b0->current_data;
506 0 : msg_len = b0->current_length;
507 0 : vec_add (long_msg, msg, msg_len);
508 : }
509 0 : msg = long_msg;
510 0 : msg_len = vec_len (long_msg);
511 : }
512 0 : vl_msg_api_handler_no_trace_no_free (msg, msg_len);
513 : }
514 :
515 : /* Free what we've been given. */
516 0 : vlib_buffer_free (vm, vlib_frame_vector_args (frame), n_packets);
517 :
518 0 : return n_packets;
519 : }
520 :
521 178120 : VLIB_REGISTER_NODE (api_rx_from_node_node, static) = {
522 : .function = api_rx_from_node,
523 : .type = VLIB_NODE_TYPE_INTERNAL,
524 : .vector_size = 4,
525 : .name = "api-rx-from-node",
526 : };
527 :
528 : static void
529 226 : vl_api_rpc_call_t_handler (vl_api_rpc_call_t *mp)
530 : {
531 : vl_api_rpc_call_reply_t *rmp;
532 : int (*fp) (void *);
533 226 : i32 rv = 0;
534 226 : vlib_main_t *vm = vlib_get_main ();
535 :
536 226 : if (mp->function == 0)
537 : {
538 0 : rv = -1;
539 0 : clib_warning ("rpc NULL function pointer");
540 : }
541 :
542 : else
543 : {
544 226 : if (mp->need_barrier_sync)
545 226 : vlib_worker_thread_barrier_sync (vm);
546 :
547 226 : fp = uword_to_pointer (mp->function, int (*) (void *));
548 226 : rv = fp (mp->data);
549 :
550 226 : if (mp->need_barrier_sync)
551 226 : vlib_worker_thread_barrier_release (vm);
552 : }
553 :
554 226 : if (mp->send_reply)
555 : {
556 0 : svm_queue_t *q = vl_api_client_index_to_input_queue (mp->client_index);
557 0 : if (q)
558 : {
559 0 : rmp = vl_msg_api_alloc_as_if_client (sizeof (*rmp));
560 0 : rmp->_vl_msg_id = ntohs (VL_API_RPC_CALL_REPLY);
561 0 : rmp->context = mp->context;
562 0 : rmp->retval = rv;
563 0 : vl_msg_api_send_shmem (q, (u8 *) &rmp);
564 : }
565 : }
566 226 : if (mp->multicast)
567 : {
568 0 : clib_warning ("multicast not yet implemented...");
569 : }
570 226 : }
571 :
572 : static void
573 0 : vl_api_rpc_call_reply_t_handler (vl_api_rpc_call_reply_t *mp)
574 : {
575 0 : clib_warning ("unimplemented");
576 0 : }
577 :
578 : void
579 169 : vl_api_send_pending_rpc_requests (vlib_main_t *vm)
580 : {
581 169 : vlib_main_t *vm_global = vlib_get_first_main ();
582 :
583 169 : ASSERT (vm != vm_global);
584 :
585 169 : clib_spinlock_lock_if_init (&vm_global->pending_rpc_lock);
586 169 : vec_append (vm_global->pending_rpc_requests, vm->pending_rpc_requests);
587 169 : vec_reset_length (vm->pending_rpc_requests);
588 169 : clib_spinlock_unlock_if_init (&vm_global->pending_rpc_lock);
589 169 : }
590 :
591 : always_inline void
592 5067 : vl_api_rpc_call_main_thread_inline (void *fp, u8 *data, u32 data_length,
593 : u8 force_rpc)
594 : {
595 : vl_api_rpc_call_t *mp;
596 5067 : vlib_main_t *vm_global = vlib_get_first_main ();
597 5067 : vlib_main_t *vm = vlib_get_main ();
598 :
599 : /* Main thread and not a forced RPC: call the function directly */
600 5067 : if ((force_rpc == 0) && (vlib_get_thread_index () == 0))
601 : {
602 : void (*call_fp) (void *);
603 :
604 4841 : vlib_worker_thread_barrier_sync (vm);
605 :
606 4841 : call_fp = fp;
607 4841 : call_fp (data);
608 :
609 4841 : vlib_worker_thread_barrier_release (vm);
610 4841 : return;
611 : }
612 :
613 : /* Otherwise, actually do an RPC */
614 226 : mp = vl_msg_api_alloc_as_if_client (sizeof (*mp) + data_length);
615 :
616 226 : clib_memset (mp, 0, sizeof (*mp));
617 226 : clib_memcpy_fast (mp->data, data, data_length);
618 226 : mp->_vl_msg_id = ntohs (VL_API_RPC_CALL);
619 226 : mp->function = pointer_to_uword (fp);
620 226 : mp->need_barrier_sync = 1;
621 :
622 : /* Add to the pending vector. Thread 0 requires locking. */
623 226 : if (vm == vm_global)
624 47 : clib_spinlock_lock_if_init (&vm_global->pending_rpc_lock);
625 226 : vec_add1 (vm->pending_rpc_requests, (uword) mp);
626 226 : if (vm == vm_global)
627 47 : clib_spinlock_unlock_if_init (&vm_global->pending_rpc_lock);
628 : }
629 :
630 : /*
631 : * Check if called from worker threads.
632 : * If so, make rpc call of fp through shmem.
633 : * Otherwise, call fp directly
634 : */
635 : void
636 5020 : vl_api_rpc_call_main_thread (void *fp, u8 *data, u32 data_length)
637 : {
638 5020 : vl_api_rpc_call_main_thread_inline (fp, data, data_length, /*force_rpc */
639 : 0);
640 5020 : }
641 :
642 : /*
643 : * Always make rpc call of fp through shmem, useful for calling from threads
644 : * not setup as worker threads, such as DPDK callback thread
645 : */
646 : void
647 47 : vl_api_force_rpc_call_main_thread (void *fp, u8 *data, u32 data_length)
648 : {
649 47 : vl_api_rpc_call_main_thread_inline (fp, data, data_length, /*force_rpc */
650 : 1);
651 47 : }
652 :
653 : static void
654 58697 : vl_api_trace_plugin_msg_ids_t_handler (vl_api_trace_plugin_msg_ids_t *mp)
655 : {
656 58697 : api_main_t *am = vlibapi_get_main ();
657 : vl_api_msg_range_t *rp;
658 : uword *p;
659 :
660 : /* Noop (except for tracing) during normal operation */
661 58697 : if (am->replay_in_progress == 0)
662 58697 : return;
663 :
664 0 : p = hash_get_mem (am->msg_range_by_name, mp->plugin_name);
665 0 : if (p == 0)
666 : {
667 0 : clib_warning ("WARNING: traced plugin '%s' not in current image",
668 : mp->plugin_name);
669 0 : return;
670 : }
671 :
672 0 : rp = vec_elt_at_index (am->msg_ranges, p[0]);
673 0 : if (rp->first_msg_id != clib_net_to_host_u16 (mp->first_msg_id))
674 : {
675 0 : clib_warning ("WARNING: traced plugin '%s' first message id %d not %d",
676 : mp->plugin_name, clib_net_to_host_u16 (mp->first_msg_id),
677 : rp->first_msg_id);
678 : }
679 :
680 0 : if (rp->last_msg_id != clib_net_to_host_u16 (mp->last_msg_id))
681 : {
682 0 : clib_warning ("WARNING: traced plugin '%s' last message id %d not %d",
683 : mp->plugin_name, clib_net_to_host_u16 (mp->last_msg_id),
684 : rp->last_msg_id);
685 : }
686 : }
687 :
688 : #define foreach_rpc_api_msg \
689 : _ (RPC_CALL, rpc_call) \
690 : _ (RPC_CALL_REPLY, rpc_call_reply)
691 :
692 : #define foreach_plugin_trace_msg _ (TRACE_PLUGIN_MSG_IDS, trace_plugin_msg_ids)
693 :
694 : /*
695 : * Set the rpc callback at our earliest possible convenience.
696 : * This avoids ordering issues between thread_init() -> start_workers and
697 : * an init function which we could define here. If we ever intend to use
698 : * vlib all by itself, we can't create a link-time dependency on
699 : * an init function here and a typical "call foo_init first"
700 : * guitar lick.
701 : */
702 :
703 : extern void *rpc_call_main_thread_cb_fn;
704 :
705 : static clib_error_t *
706 559 : rpc_api_hookup (vlib_main_t *vm)
707 : {
708 559 : api_main_t *am = vlibapi_get_main ();
709 : #define _(N, n) \
710 : vl_msg_api_config (&(vl_msg_api_msg_config_t){ \
711 : .id = VL_API_##N, \
712 : .name = #n, \
713 : .handler = vl_api_##n##_t_handler, \
714 : .format_fn = vl_api_##n##_t_format, \
715 : .size = sizeof (vl_api_##n##_t), \
716 : .traced = 0, \
717 : .tojson = vl_api_##n##_t_tojson, \
718 : .fromjson = vl_api_##n##_t_fromjson, \
719 : .calc_size = vl_api_##n##_t_calc_size, \
720 : });
721 559 : foreach_rpc_api_msg;
722 : #undef _
723 :
724 : #define _(N, n) \
725 : vl_msg_api_config (&(vl_msg_api_msg_config_t){ \
726 : .id = VL_API_##N, \
727 : .name = #n, \
728 : .handler = vl_api_##n##_t_handler, \
729 : .endian = vl_api_##n##_t_endian, \
730 : .format_fn = vl_api_##n##_t_format, \
731 : .size = sizeof (vl_api_##n##_t), \
732 : .traced = 1, \
733 : .tojson = vl_api_##n##_t_tojson, \
734 : .fromjson = vl_api_##n##_t_fromjson, \
735 : .calc_size = vl_api_##n##_t_calc_size, \
736 : });
737 559 : foreach_plugin_trace_msg
738 : #undef _
739 :
740 559 : vl_api_allow_msg_replay (am, VL_API_TRACE_PLUGIN_MSG_IDS, 0);
741 :
742 : /* No reason to halt the parade to create a trace record... */
743 559 : vl_api_set_msg_thread_safe (am, VL_API_TRACE_PLUGIN_MSG_IDS, 1);
744 559 : rpc_call_main_thread_cb_fn = vl_api_rpc_call_main_thread;
745 559 : return 0;
746 : }
747 :
748 20719 : VLIB_API_INIT_FUNCTION (rpc_api_hookup);
749 :
750 : /*
751 : * fd.io coding-style-patch-verification: ON
752 : *
753 : * Local Variables:
754 : * eval: (c-set-style "gnu")
755 : * End:
756 : */
|
