api: verify message size on receipt
[vpp.git] / src / vlibmemory / memory_client.c
1 /*
2  *------------------------------------------------------------------
3  * memory_client.c - API message handling, client code.
4  *
5  * Copyright (c) 2010 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 <setjmp.h>
21
22 #include <svm/svm.h>
23 #include <svm/ssvm.h>
24 #include <vppinfra/serialize.h>
25 #include <vppinfra/hash.h>
26 #include <vlibmemory/memory_client.h>
27 #include <vlibapi/api_common.h>
28
29 /* A hack. vl_client_get_first_plugin_msg_id depends on it */
30 #include <vlibmemory/socket_client.h>
31
32 #include <vlibmemory/vl_memory_msg_enum.h>
33
34 #define vl_typedefs             /* define message structures */
35 #include <vlibmemory/vl_memory_api_h.h>
36 #undef vl_typedefs
37
38 #define vl_endianfun            /* define message structures */
39 #include <vlibmemory/vl_memory_api_h.h>
40 #undef vl_endianfun
41
42 #define vl_calcsizefun
43 #include <vlibmemory/vl_memory_api_h.h>
44 #undef vl_calcsizefun
45
46 /* instantiate all the print functions we know about */
47 #define vl_print(handle, ...) clib_warning (__VA_ARGS__)
48 #define vl_printfun
49 #include <vlibmemory/vl_memory_api_h.h>
50 #undef vl_printfun
51
52 memory_client_main_t memory_client_main;
53 __thread memory_client_main_t *my_memory_client_main = &memory_client_main;
54
55 typedef struct rx_thread_fn_arg
56 {
57   api_main_t *am;
58   memory_client_main_t *mm;
59 } rx_thread_fn_arg_t;
60
61 static void *
62 rx_thread_fn (void *arg)
63 {
64   rx_thread_fn_arg_t *a = (rx_thread_fn_arg_t *) arg;
65   memory_client_main_t *mm;
66   svm_queue_t *q;
67
68   vlibapi_set_main (a->am);
69   vlibapi_set_memory_client_main (a->mm);
70   free (a);
71
72   mm = vlibapi_get_memory_client_main ();
73   q = vlibapi_get_main ()->vl_input_queue;
74
75   /* So we can make the rx thread terminate cleanly */
76   if (setjmp (mm->rx_thread_jmpbuf) == 0)
77     {
78       mm->rx_thread_jmpbuf_valid = 1;
79       clib_mem_set_thread_index ();
80       while (1)
81         vl_msg_api_queue_handler (q);
82     }
83   pthread_exit (0);
84 }
85
86 static void
87 vl_api_rx_thread_exit_t_handler (vl_api_rx_thread_exit_t * mp)
88 {
89   memory_client_main_t *mm = vlibapi_get_memory_client_main ();
90   if (mm->rx_thread_jmpbuf_valid)
91     longjmp (mm->rx_thread_jmpbuf, 1);
92 }
93
94 static void
95 vl_api_name_and_crc_free (void)
96 {
97   api_main_t *am = vlibapi_get_main ();
98   int i;
99   u8 **keys = 0;
100   hash_pair_t *hp;
101
102   if (!am->msg_index_by_name_and_crc)
103     return;
104
105   /* *INDENT-OFF* */
106   hash_foreach_pair (hp, am->msg_index_by_name_and_crc,
107       ({
108         vec_add1 (keys, (u8 *) hp->key);
109       }));
110   /* *INDENT-ON* */
111   for (i = 0; i < vec_len (keys); i++)
112     vec_free (keys[i]);
113   vec_free (keys);
114   hash_free (am->msg_index_by_name_and_crc);
115 }
116
117 CLIB_NOSANITIZE_ADDR static void
118 VL_API_VEC_UNPOISON (const void *v)
119 {
120   const vec_header_t *vh = &((vec_header_t *) v)[-1];
121   CLIB_MEM_UNPOISON (vh, sizeof (*vh) + vec_len (v));
122 }
123
124 static void
125 vl_api_memclnt_create_reply_t_handler (vl_api_memclnt_create_reply_t * mp)
126 {
127   serialize_main_t _sm, *sm = &_sm;
128   api_main_t *am = vlibapi_get_main ();
129   u8 *tblv;
130   u32 nmsgs;
131   int i;
132   u8 *name_and_crc;
133   u32 msg_index;
134
135   am->my_client_index = mp->index;
136   am->my_registration = (vl_api_registration_t *) (uword) mp->handle;
137
138   /* Clean out any previous hash table (unlikely) */
139   vl_api_name_and_crc_free ();
140
141   am->msg_index_by_name_and_crc = hash_create_string (0, sizeof (uword));
142
143   /* Recreate the vnet-side API message handler table */
144   tblv = uword_to_pointer (mp->message_table, u8 *);
145   unserialize_open_data (sm, tblv, vec_len (tblv));
146   unserialize_integer (sm, &nmsgs, sizeof (u32));
147
148   VL_API_VEC_UNPOISON (tblv);
149
150   for (i = 0; i < nmsgs; i++)
151     {
152       msg_index = unserialize_likely_small_unsigned_integer (sm);
153       unserialize_cstring (sm, (char **) &name_and_crc);
154       hash_set_mem (am->msg_index_by_name_and_crc, name_and_crc, msg_index);
155     }
156 }
157
158 static void
159 noop_handler (void *notused)
160 {
161 }
162
163 void vl_msg_api_send_shmem (svm_queue_t * q, u8 * elem);
164 int
165 vl_client_connect (const char *name, int ctx_quota, int input_queue_size)
166 {
167   vl_api_memclnt_create_t *mp;
168   vl_api_memclnt_create_reply_t *rp;
169   svm_queue_t *vl_input_queue;
170   vl_shmem_hdr_t *shmem_hdr;
171   int rv = 0;
172   void *oldheap;
173   api_main_t *am = vlibapi_get_main ();
174
175   if (am->my_registration)
176     {
177       clib_warning ("client %s already connected...", name);
178       return -1;
179     }
180
181   if (am->vlib_rp == 0)
182     {
183       clib_warning ("am->vlib_rp NULL");
184       return -1;
185     }
186
187   shmem_hdr = am->shmem_hdr;
188
189   if (shmem_hdr == 0 || shmem_hdr->vl_input_queue == 0)
190     {
191       clib_warning ("shmem_hdr / input queue NULL");
192       return -1;
193     }
194
195   CLIB_MEM_UNPOISON (shmem_hdr, sizeof (*shmem_hdr));
196   VL_MSG_API_SVM_QUEUE_UNPOISON (shmem_hdr->vl_input_queue);
197
198   oldheap = vl_msg_push_heap ();
199   vl_input_queue = svm_queue_alloc_and_init (input_queue_size, sizeof (uword),
200                                              getpid ());
201   vl_msg_pop_heap (oldheap);
202
203   am->my_client_index = ~0;
204   am->my_registration = 0;
205   am->vl_input_queue = vl_input_queue;
206
207   mp = vl_msg_api_alloc (sizeof (vl_api_memclnt_create_t));
208   clib_memset (mp, 0, sizeof (*mp));
209   mp->_vl_msg_id = ntohs (VL_API_MEMCLNT_CREATE);
210   mp->ctx_quota = ctx_quota;
211   mp->input_queue = (uword) vl_input_queue;
212   strncpy ((char *) mp->name, name, sizeof (mp->name) - 1);
213
214   vl_msg_api_send_shmem (shmem_hdr->vl_input_queue, (u8 *) & mp);
215
216   while (1)
217     {
218       int qstatus;
219       struct timespec ts, tsrem;
220       int i;
221
222       /* Wait up to 10 seconds */
223       for (i = 0; i < 1000; i++)
224         {
225           qstatus = svm_queue_sub (vl_input_queue, (u8 *) & rp,
226                                    SVM_Q_NOWAIT, 0);
227           if (qstatus == 0)
228             goto read_one_msg;
229           ts.tv_sec = 0;
230           ts.tv_nsec = 10000 * 1000;    /* 10 ms */
231           while (nanosleep (&ts, &tsrem) < 0)
232             ts = tsrem;
233         }
234       /* Timeout... */
235       clib_warning ("memclnt_create_reply timeout");
236       return -1;
237
238     read_one_msg:
239       VL_MSG_API_UNPOISON (rp);
240       if (ntohs (rp->_vl_msg_id) != VL_API_MEMCLNT_CREATE_REPLY)
241         {
242           clib_warning ("unexpected reply: id %d", ntohs (rp->_vl_msg_id));
243           continue;
244         }
245       rv = clib_net_to_host_u32 (rp->response);
246
247       msgbuf_t *msgbuf = (msgbuf_t *) ((u8 *) rp - offsetof (msgbuf_t, data));
248       vl_msg_api_handler ((void *) rp, ntohl (msgbuf->data_len));
249       break;
250     }
251   return (rv);
252 }
253
254 static void
255 vl_api_memclnt_delete_reply_t_handler (vl_api_memclnt_delete_reply_t * mp)
256 {
257   void *oldheap;
258   api_main_t *am = vlibapi_get_main ();
259
260   oldheap = vl_msg_push_heap ();
261   svm_queue_free (am->vl_input_queue);
262   vl_msg_pop_heap (oldheap);
263
264   am->my_client_index = ~0;
265   am->my_registration = 0;
266   am->vl_input_queue = 0;
267 }
268
269 void
270 vl_client_send_disconnect (u8 do_cleanup)
271 {
272   vl_api_memclnt_delete_t *mp;
273   vl_shmem_hdr_t *shmem_hdr;
274   api_main_t *am = vlibapi_get_main ();
275
276   ASSERT (am->vlib_rp);
277   shmem_hdr = am->shmem_hdr;
278   ASSERT (shmem_hdr && shmem_hdr->vl_input_queue);
279
280   mp = vl_msg_api_alloc (sizeof (vl_api_memclnt_delete_t));
281   clib_memset (mp, 0, sizeof (*mp));
282   mp->_vl_msg_id = ntohs (VL_API_MEMCLNT_DELETE);
283   mp->index = am->my_client_index;
284   mp->handle = (uword) am->my_registration;
285   mp->do_cleanup = do_cleanup;
286
287   vl_msg_api_send_shmem (shmem_hdr->vl_input_queue, (u8 *) & mp);
288 }
289
290 int
291 vl_client_disconnect (void)
292 {
293   vl_api_memclnt_delete_reply_t *rp;
294   svm_queue_t *vl_input_queue;
295   api_main_t *am = vlibapi_get_main ();
296   time_t begin;
297   msgbuf_t *msgbuf;
298
299   vl_input_queue = am->vl_input_queue;
300   vl_client_send_disconnect (0 /* wait for reply */ );
301
302   /*
303    * Have to be careful here, in case the client is disconnecting
304    * because e.g. the vlib process died, or is unresponsive.
305    */
306   begin = time (0);
307   while (1)
308     {
309       time_t now;
310
311       now = time (0);
312
313       if (now >= (begin + 2))
314         {
315           clib_warning ("peer unresponsive, give up");
316           am->my_client_index = ~0;
317           am->my_registration = 0;
318           am->shmem_hdr = 0;
319           return -1;
320         }
321       if (svm_queue_sub (vl_input_queue, (u8 *) & rp, SVM_Q_NOWAIT, 0) < 0)
322         continue;
323
324       VL_MSG_API_UNPOISON (rp);
325
326       /* drain the queue */
327       if (ntohs (rp->_vl_msg_id) != VL_API_MEMCLNT_DELETE_REPLY)
328         {
329           clib_warning ("queue drain: %d", ntohs (rp->_vl_msg_id));
330           msgbuf = (msgbuf_t *) ((u8 *) rp - offsetof (msgbuf_t, data));
331           vl_msg_api_handler ((void *) rp, ntohl (msgbuf->data_len));
332           continue;
333         }
334       msgbuf = (msgbuf_t *) ((u8 *) rp - offsetof (msgbuf_t, data));
335       vl_msg_api_handler ((void *) rp, ntohl (msgbuf->data_len));
336       break;
337     }
338
339   vl_api_name_and_crc_free ();
340   return 0;
341 }
342
343 /**
344  * Stave off the binary API dead client reaper
345  * Only sent to inactive clients
346  */
347 static void
348 vl_api_memclnt_keepalive_t_handler (vl_api_memclnt_keepalive_t * mp)
349 {
350   vl_api_memclnt_keepalive_reply_t *rmp;
351   api_main_t *am;
352   vl_shmem_hdr_t *shmem_hdr;
353
354   am = vlibapi_get_main ();
355   shmem_hdr = am->shmem_hdr;
356
357   rmp = vl_msg_api_alloc_as_if_client (sizeof (*rmp));
358   clib_memset (rmp, 0, sizeof (*rmp));
359   rmp->_vl_msg_id = ntohs (VL_API_MEMCLNT_KEEPALIVE_REPLY);
360   rmp->context = mp->context;
361   vl_msg_api_send_shmem (shmem_hdr->vl_input_queue, (u8 *) & rmp);
362 }
363
364 #define foreach_api_msg                         \
365 _(RX_THREAD_EXIT, rx_thread_exit)               \
366 _(MEMCLNT_CREATE_REPLY, memclnt_create_reply)   \
367 _(MEMCLNT_DELETE_REPLY, memclnt_delete_reply)   \
368 _(MEMCLNT_KEEPALIVE, memclnt_keepalive)
369
370 void
371 vl_client_install_client_message_handlers (void)
372 {
373   api_main_t *am = vlibapi_get_main ();
374 #define _(N, n)                                                               \
375   vl_msg_api_set_handlers (                                                   \
376     VL_API_##N, #n, vl_api_##n##_t_handler, noop_handler,                     \
377     vl_api_##n##_t_endian, vl_api_##n##_t_print, sizeof (vl_api_##n##_t), 0,  \
378     vl_api_##n##_t_print_json, vl_api_##n##_t_tojson,                         \
379     vl_api_##n##_t_fromjson, vl_api_##n##_t_calc_size);                       \
380   am->api_trace_cfg[VL_API_##N].replay_enable = 0;
381   foreach_api_msg;
382 #undef _
383 }
384
385 int
386 vl_client_api_map (const char *region_name)
387 {
388   int rv;
389
390   if ((rv = vl_map_shmem (region_name, 0 /* is_vlib */ )) < 0)
391     return rv;
392
393   vl_client_install_client_message_handlers ();
394   return 0;
395 }
396
397 void
398 vl_client_api_unmap (void)
399 {
400   vl_unmap_shmem_client ();
401 }
402
403 u8
404 vl_mem_client_is_connected (void)
405 {
406   return (my_memory_client_main->connected_to_vlib != 0);
407 }
408
409 static int
410 connect_to_vlib_internal (const char *svm_name,
411                           const char *client_name,
412                           int rx_queue_size, void *(*thread_fn) (void *),
413                           void *thread_fn_arg, int do_map)
414 {
415   int rv = 0;
416   memory_client_main_t *mm = vlibapi_get_memory_client_main ();
417   api_main_t *am = vlibapi_get_main ();
418
419   if (do_map && (rv = vl_client_api_map (svm_name)))
420     {
421       clib_warning ("vl_client_api map rv %d", rv);
422       return rv;
423     }
424
425   if (vl_client_connect (client_name, 0 /* punt quota */ ,
426                          rx_queue_size /* input queue */ ) < 0)
427     {
428       vl_client_api_unmap ();
429       return -1;
430     }
431
432   /* Start the rx queue thread */
433
434   if (thread_fn)
435     {
436       if (thread_fn == rx_thread_fn)
437         {
438           rx_thread_fn_arg_t *arg;
439           arg = malloc (sizeof (*arg));
440           arg->am = vlibapi_get_main ();
441           arg->mm = vlibapi_get_memory_client_main ();
442           thread_fn_arg = (void *) arg;
443         }
444
445       rv = pthread_create (&mm->rx_thread_handle,
446                            NULL /*attr */ , thread_fn, thread_fn_arg);
447       if (rv)
448         {
449           clib_warning ("pthread_create returned %d", rv);
450           am->rx_thread_handle = 0;
451         }
452       else
453         {
454           am->rx_thread_handle = mm->rx_thread_handle;
455         }
456     }
457
458   mm->connected_to_vlib = 1;
459   return 0;
460 }
461
462 int
463 vl_client_connect_to_vlib (const char *svm_name,
464                            const char *client_name, int rx_queue_size)
465 {
466   return connect_to_vlib_internal (svm_name, client_name, rx_queue_size,
467                                    rx_thread_fn, 0 /* thread fn arg */ ,
468                                    1 /* do map */ );
469 }
470
471 int
472 vl_client_connect_to_vlib_no_rx_pthread (const char *svm_name,
473                                          const char *client_name,
474                                          int rx_queue_size)
475 {
476   return connect_to_vlib_internal (svm_name, client_name, rx_queue_size,
477                                    0 /* no rx_thread_fn */ ,
478                                    0 /* no thread fn arg */ ,
479                                    1 /* do map */ );
480 }
481
482 int
483 vl_client_connect_to_vlib_no_map (const char *svm_name,
484                                   const char *client_name, int rx_queue_size)
485 {
486   return connect_to_vlib_internal (svm_name, client_name, rx_queue_size,
487                                    rx_thread_fn, 0 /* no thread fn arg */ ,
488                                    0 /* dont map */ );
489 }
490
491 int
492 vl_client_connect_to_vlib_no_rx_pthread_no_map (const char *svm_name,
493                                                 const char *client_name,
494                                                 int rx_queue_size)
495 {
496   return connect_to_vlib_internal (svm_name, client_name, rx_queue_size,
497                                    0 /* no thread_fn */ ,
498                                    0 /* no thread fn arg */ ,
499                                    0 /* dont map */ );
500 }
501
502 int
503 vl_client_connect_to_vlib_thread_fn (const char *svm_name,
504                                      const char *client_name,
505                                      int rx_queue_size,
506                                      void *(*thread_fn) (void *), void *arg)
507 {
508   return connect_to_vlib_internal (svm_name, client_name, rx_queue_size,
509                                    thread_fn, arg, 1 /* do map */ );
510 }
511
512
513 static void
514 disconnect_from_vlib_internal (u8 do_unmap)
515 {
516   memory_client_main_t *mm = vlibapi_get_memory_client_main ();
517   api_main_t *am = vlibapi_get_main ();
518   uword junk;
519
520   if (mm->rx_thread_jmpbuf_valid)
521     {
522       vl_api_rx_thread_exit_t *ep;
523       ep = vl_msg_api_alloc (sizeof (*ep));
524       ep->_vl_msg_id = ntohs (VL_API_RX_THREAD_EXIT);
525       vl_msg_api_send_shmem (am->vl_input_queue, (u8 *) & ep);
526       pthread_join (mm->rx_thread_handle, (void **) &junk);
527     }
528   if (mm->connected_to_vlib)
529     {
530       vl_client_disconnect ();
531       if (do_unmap)
532         vl_client_api_unmap ();
533     }
534   clib_memset (mm, 0, sizeof (*mm));
535 }
536
537 void
538 vl_client_disconnect_from_vlib (void)
539 {
540   disconnect_from_vlib_internal (1);
541 }
542
543 void
544 vl_client_disconnect_from_vlib_no_unmap (void)
545 {
546   disconnect_from_vlib_internal (0);
547 }
548
549 static void vl_api_get_first_msg_id_reply_t_handler
550   (vl_api_get_first_msg_id_reply_t * mp)
551 {
552   memory_client_main_t *mm = vlibapi_get_memory_client_main ();
553   i32 retval = ntohl (mp->retval);
554
555   mm->first_msg_id_reply = (retval >= 0) ? ntohs (mp->first_msg_id) : ~0;
556   mm->first_msg_id_reply_ready = 1;
557 }
558
559 u16
560 vl_client_get_first_plugin_msg_id (const char *plugin_name)
561 {
562   vl_api_get_first_msg_id_t *mp;
563   api_main_t *am = vlibapi_get_main ();
564   memory_client_main_t *mm = vlibapi_get_memory_client_main ();
565   f64 timeout;
566   void *old_handler;
567   clib_time_t clib_time;
568   u16 rv = ~0;
569
570   if (strlen (plugin_name) + 1 > sizeof (mp->name))
571     return (rv);
572
573   clib_memset (&clib_time, 0, sizeof (clib_time));
574   clib_time_init (&clib_time);
575
576   /* Push this plugin's first_msg_id_reply handler */
577   old_handler = am->msg_handlers[VL_API_GET_FIRST_MSG_ID_REPLY];
578   am->msg_handlers[VL_API_GET_FIRST_MSG_ID_REPLY] = (void *)
579     vl_api_get_first_msg_id_reply_t_handler;
580   if (!am->msg_calc_size_funcs[VL_API_GET_FIRST_MSG_ID_REPLY])
581     {
582       am->msg_calc_size_funcs[VL_API_GET_FIRST_MSG_ID_REPLY] =
583         (uword (*) (void *)) vl_api_get_first_msg_id_reply_t_calc_size;
584     }
585
586   /* Ask the data-plane for the message-ID base of the indicated plugin */
587   mm->first_msg_id_reply_ready = 0;
588
589   /* Not using shm client */
590   if (!am->my_registration)
591     {
592       mp = vl_socket_client_msg_alloc (sizeof (*mp));
593       clib_memset (mp, 0, sizeof (*mp));
594       mp->_vl_msg_id = ntohs (VL_API_GET_FIRST_MSG_ID);
595       mp->client_index = am->my_client_index;
596       strncpy ((char *) mp->name, plugin_name, sizeof (mp->name) - 1);
597
598       if (vl_socket_client_write () <= 0)
599         goto sock_err;
600       if (vl_socket_client_read (1))
601         goto sock_err;
602
603       if (mm->first_msg_id_reply_ready == 1)
604         {
605           rv = mm->first_msg_id_reply;
606           goto result;
607         }
608
609     sock_err:
610       /* Restore old handler */
611       am->msg_handlers[VL_API_GET_FIRST_MSG_ID_REPLY] = old_handler;
612
613       return -1;
614     }
615   else
616     {
617       mp = vl_msg_api_alloc (sizeof (*mp));
618       clib_memset (mp, 0, sizeof (*mp));
619       mp->_vl_msg_id = ntohs (VL_API_GET_FIRST_MSG_ID);
620       mp->client_index = am->my_client_index;
621       strncpy ((char *) mp->name, plugin_name, sizeof (mp->name) - 1);
622
623       vl_msg_api_send_shmem (am->shmem_hdr->vl_input_queue, (u8 *) & mp);
624
625       /* Synchronously wait for the answer */
626       timeout = clib_time_now (&clib_time) + 1.0;
627       while (clib_time_now (&clib_time) < timeout)
628         {
629           if (mm->first_msg_id_reply_ready == 1)
630             {
631               rv = mm->first_msg_id_reply;
632               goto result;
633             }
634         }
635       /* Restore old handler */
636       am->msg_handlers[VL_API_GET_FIRST_MSG_ID_REPLY] = old_handler;
637
638       return rv;
639     }
640
641 result:
642
643   /* Restore the old handler */
644   am->msg_handlers[VL_API_GET_FIRST_MSG_ID_REPLY] = old_handler;
645
646   if (rv == (u16) ~ 0)
647     clib_warning ("plugin '%s' not registered", plugin_name);
648
649   return rv;
650 }
651
652 /*
653  * fd.io coding-style-patch-verification: ON
654  *
655  * Local Variables:
656  * eval: (c-set-style "gnu")
657  * End:
658  */