Add API calls for packet generator
[vpp.git] / vlib-api / vlibmemory / memory_shared.c
1 /*
2  *------------------------------------------------------------------
3  * memclnt_shared.c - API message handling, common code for both clients
4  * and the vlib process itself.
5  *
6  *
7  * Copyright (c) 2009 Cisco and/or its affiliates.
8  * Licensed under the Apache License, Version 2.0 (the "License");
9  * you may not use this file except in compliance with the License.
10  * You may obtain a copy of the License at:
11  *
12  *     http://www.apache.org/licenses/LICENSE-2.0
13  *
14  * Unless required by applicable law or agreed to in writing, software
15  * distributed under the License is distributed on an "AS IS" BASIS,
16  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17  * See the License for the specific language governing permissions and
18  * limitations under the License.
19  *------------------------------------------------------------------
20  */
21
22 #include <stdio.h>
23 #include <stdlib.h>
24 #include <stddef.h>
25 #include <string.h>
26 #include <unistd.h>
27 #include <signal.h>
28 #include <vppinfra/format.h>
29 #include <vppinfra/byte_order.h>
30 #include <vppinfra/error.h>
31 #include <vlib/vlib.h>
32 #include <vlib/unix/unix.h>
33 #include <vlibmemory/api.h>
34 #include <vlibmemory/unix_shared_memory_queue.h>
35
36 #include <vlibmemory/vl_memory_msg_enum.h>
37
38 #define vl_typedefs
39 #include <vlibmemory/vl_memory_api_h.h>
40 #undef vl_typedefs
41
42 static inline void *
43 vl_msg_api_alloc_internal (int nbytes, int pool)
44 {
45   int i;
46   msgbuf_t *rv;
47   ring_alloc_t *ap;
48   unix_shared_memory_queue_t *q;
49   void *oldheap;
50   vl_shmem_hdr_t *shmem_hdr;
51   api_main_t *am = &api_main;
52
53   shmem_hdr = am->shmem_hdr;
54
55   if (shmem_hdr == 0)
56     {
57       clib_warning ("shared memory header NULL");
58       return 0;
59     }
60
61   /* account for the msgbuf_t header */
62   nbytes += sizeof (msgbuf_t);
63
64   if (shmem_hdr->vl_rings == 0)
65     {
66       clib_warning ("vl_rings NULL");
67       return 0;
68     }
69
70   if (shmem_hdr->client_rings == 0)
71     {
72       clib_warning ("client_rings NULL");
73       return 0;
74     }
75
76   ap = pool ? shmem_hdr->vl_rings : shmem_hdr->client_rings;
77   for (i = 0; i < vec_len (ap); i++)
78     {
79       /* Too big? */
80       if (nbytes > ap[i].size)
81         {
82           continue;
83         }
84
85       q = ap[i].rp;
86       if (pool == 0)
87         {
88           pthread_mutex_lock (&q->mutex);
89         }
90       rv = (msgbuf_t *) (&q->data[0] + q->head * q->elsize);
91       /*
92        * Is this item still in use?
93        */
94       if (rv->q)
95         {
96           /* yes, loser; try next larger pool */
97           ap[i].misses++;
98           if (pool == 0)
99             pthread_mutex_unlock (&q->mutex);
100           continue;
101         }
102       /* OK, we have a winner */
103       ap[i].hits++;
104       /*
105        * Remember the source queue, although we
106        * don't need to know the queue to free the item.
107        */
108       rv->q = q;
109       q->head++;
110       if (q->head == q->maxsize)
111         q->head = 0;
112
113       if (pool == 0)
114         pthread_mutex_unlock (&q->mutex);
115       goto out;
116     }
117
118   /*
119    * Request too big, or head element of all size-compatible rings
120    * still in use. Fall back to shared-memory malloc.
121    */
122   am->ring_misses++;
123
124   pthread_mutex_lock (&am->vlib_rp->mutex);
125   oldheap = svm_push_data_heap (am->vlib_rp);
126   rv = clib_mem_alloc (nbytes);
127   rv->q = 0;
128   svm_pop_heap (oldheap);
129   pthread_mutex_unlock (&am->vlib_rp->mutex);
130
131 out:
132   rv->data_len = htonl (nbytes - sizeof (msgbuf_t));
133   return (rv->data);
134 }
135
136 void *
137 vl_msg_api_alloc (int nbytes)
138 {
139   int pool;
140   api_main_t *am = &api_main;
141   vl_shmem_hdr_t *shmem_hdr = am->shmem_hdr;
142
143   /*
144    * Clients use pool-0, vlib proc uses pool 1
145    */
146   pool = (am->our_pid == shmem_hdr->vl_pid);
147   return vl_msg_api_alloc_internal (nbytes, pool);
148 }
149
150 void *
151 vl_msg_api_alloc_as_if_client (int nbytes)
152 {
153   return vl_msg_api_alloc_internal (nbytes, 0);
154 }
155
156 void
157 vl_msg_api_free (void *a)
158 {
159   msgbuf_t *rv;
160   void *oldheap;
161   api_main_t *am = &api_main;
162
163   rv = (msgbuf_t *) (((u8 *) a) - offsetof (msgbuf_t, data));
164
165   /*
166    * Here's the beauty of the scheme.  Only one proc/thread has
167    * control of a given message buffer. To free a buffer, we just clear the
168    * queue field, and leave. No locks, no hits, no errors...
169    */
170   if (rv->q)
171     {
172       rv->q = 0;
173       return;
174     }
175
176   pthread_mutex_lock (&am->vlib_rp->mutex);
177   oldheap = svm_push_data_heap (am->vlib_rp);
178   clib_mem_free (rv);
179   svm_pop_heap (oldheap);
180   pthread_mutex_unlock (&am->vlib_rp->mutex);
181 }
182
183 static void
184 vl_msg_api_free_nolock (void *a)
185 {
186   msgbuf_t *rv;
187   void *oldheap;
188   api_main_t *am = &api_main;
189
190   rv = (msgbuf_t *) (((u8 *) a) - offsetof (msgbuf_t, data));
191   /*
192    * Here's the beauty of the scheme.  Only one proc/thread has
193    * control of a given message buffer. To free a buffer, we just clear the
194    * queue field, and leave. No locks, no hits, no errors...
195    */
196   if (rv->q)
197     {
198       rv->q = 0;
199       return;
200     }
201
202   oldheap = svm_push_data_heap (am->vlib_rp);
203   clib_mem_free (rv);
204   svm_pop_heap (oldheap);
205 }
206
207 void
208 vl_set_memory_root_path (char *name)
209 {
210   api_main_t *am = &api_main;
211
212   am->root_path = name;
213 }
214
215 void
216 vl_set_memory_uid (int uid)
217 {
218   api_main_t *am = &api_main;
219
220   am->api_uid = uid;
221 }
222
223 void
224 vl_set_memory_gid (int gid)
225 {
226   api_main_t *am = &api_main;
227
228   am->api_gid = gid;
229 }
230
231 int
232 vl_map_shmem (char *region_name, int is_vlib)
233 {
234   svm_map_region_args_t _a, *a = &_a;
235   svm_region_t *vlib_rp, *root_rp;
236   void *oldheap;
237   vl_shmem_hdr_t *shmem_hdr = 0;
238   api_main_t *am = &api_main;
239   int i;
240   struct timespec ts, tsrem;
241
242   if (is_vlib == 0)
243     svm_region_init_chroot (am->root_path);
244
245   memset (a, 0, sizeof (*a));
246
247   a->name = region_name;
248   a->size = 16 << 20;
249   a->flags = SVM_FLAGS_MHEAP;
250   a->uid = am->api_uid;
251   a->gid = am->api_gid;
252
253   vlib_rp = svm_region_find_or_create (a);
254
255   if (vlib_rp == 0)
256     return (-2);
257
258   pthread_mutex_lock (&vlib_rp->mutex);
259   /* Has someone else set up the shared-memory variable table? */
260   if (vlib_rp->user_ctx)
261     {
262       am->shmem_hdr = (void *) vlib_rp->user_ctx;
263       am->our_pid = getpid ();
264       if (is_vlib)
265         {
266           unix_shared_memory_queue_t *q;
267           uword old_msg;
268           /*
269            * application restart. Reset cached pids, API message
270            * rings, list of clients; otherwise, various things
271            * fail. (e.g. queue non-empty notification)
272            */
273
274           /* ghosts keep the region from disappearing properly */
275           svm_client_scan_this_region_nolock (vlib_rp);
276           am->shmem_hdr->application_restarts++;
277           q = am->shmem_hdr->vl_input_queue;
278           am->shmem_hdr->vl_pid = getpid ();
279           q->consumer_pid = am->shmem_hdr->vl_pid;
280           /* Drain the input queue, freeing msgs */
281           for (i = 0; i < 10; i++)
282             {
283               if (pthread_mutex_trylock (&q->mutex) == 0)
284                 {
285                   pthread_mutex_unlock (&q->mutex);
286                   goto mutex_ok;
287                 }
288               ts.tv_sec = 0;
289               ts.tv_nsec = 10000 * 1000;        /* 10 ms */
290               while (nanosleep (&ts, &tsrem) < 0)
291                 ts = tsrem;
292             }
293           /* Mutex buggered, "fix" it */
294           memset (&q->mutex, 0, sizeof (q->mutex));
295           clib_warning ("forcibly release main input queue mutex");
296
297         mutex_ok:
298           am->vlib_rp = vlib_rp;
299           while (unix_shared_memory_queue_sub (q,
300                                                (u8 *) & old_msg,
301                                                1 /* nowait */ )
302                  != -2 /* queue underflow */ )
303             {
304               vl_msg_api_free_nolock ((void *) old_msg);
305               am->shmem_hdr->restart_reclaims++;
306             }
307           pthread_mutex_unlock (&vlib_rp->mutex);
308           root_rp = svm_get_root_rp ();
309           ASSERT (root_rp);
310           /* Clean up the root region client list */
311           pthread_mutex_lock (&root_rp->mutex);
312           svm_client_scan_this_region_nolock (root_rp);
313           pthread_mutex_unlock (&root_rp->mutex);
314         }
315       else
316         {
317           pthread_mutex_unlock (&vlib_rp->mutex);
318         }
319       am->vlib_rp = vlib_rp;
320       vec_add1 (am->mapped_shmem_regions, vlib_rp);
321       return 0;
322     }
323   /* Clients simply have to wait... */
324   if (!is_vlib)
325     {
326       pthread_mutex_unlock (&vlib_rp->mutex);
327
328       /* Wait up to 100 seconds... */
329       for (i = 0; i < 10000; i++)
330         {
331           ts.tv_sec = 0;
332           ts.tv_nsec = 10000 * 1000;    /* 10 ms */
333           while (nanosleep (&ts, &tsrem) < 0)
334             ts = tsrem;
335           if (vlib_rp->user_ctx)
336             goto ready;
337         }
338       /* Clean up and leave... */
339       svm_region_unmap (vlib_rp);
340       clib_warning ("region init fail");
341       return (-2);
342
343     ready:
344       am->shmem_hdr = (void *) vlib_rp->user_ctx;
345       am->our_pid = getpid ();
346       am->vlib_rp = vlib_rp;
347       vec_add1 (am->mapped_shmem_regions, vlib_rp);
348       return 0;
349     }
350
351   /* Nope, it's our problem... */
352
353   oldheap = svm_push_data_heap (vlib_rp);
354
355   vec_validate (shmem_hdr, 0);
356   shmem_hdr->version = VL_SHM_VERSION;
357
358   /* vlib main input queue */
359   shmem_hdr->vl_input_queue =
360     unix_shared_memory_queue_init (1024, sizeof (uword), getpid (),
361                                    am->vlib_signal);
362
363   /* Set up the msg ring allocator */
364 #define _(sz,n)                                                 \
365     do {                                                        \
366         ring_alloc_t _rp;                                       \
367         _rp.rp = unix_shared_memory_queue_init ((n), (sz), 0, 0); \
368         _rp.size = (sz);                                        \
369         _rp.nitems = n;                                         \
370         _rp.hits = 0;                                           \
371         _rp.misses = 0;                                         \
372         vec_add1(shmem_hdr->vl_rings, _rp);                     \
373     } while (0);
374
375   foreach_vl_aring_size;
376 #undef _
377
378 #define _(sz,n)                                                 \
379     do {                                                        \
380         ring_alloc_t _rp;                                       \
381         _rp.rp = unix_shared_memory_queue_init ((n), (sz), 0, 0); \
382         _rp.size = (sz);                                        \
383         _rp.nitems = n;                                         \
384         _rp.hits = 0;                                           \
385         _rp.misses = 0;                                         \
386         vec_add1(shmem_hdr->client_rings, _rp);                 \
387     } while (0);
388
389   foreach_clnt_aring_size;
390 #undef _
391
392   am->shmem_hdr = shmem_hdr;
393   am->vlib_rp = vlib_rp;
394   am->our_pid = getpid ();
395   if (is_vlib)
396     am->shmem_hdr->vl_pid = am->our_pid;
397
398   svm_pop_heap (oldheap);
399
400   /*
401    * After absolutely everything that a client might see is set up,
402    * declare the shmem region valid
403    */
404   vlib_rp->user_ctx = shmem_hdr;
405
406   pthread_mutex_unlock (&vlib_rp->mutex);
407   vec_add1 (am->mapped_shmem_regions, vlib_rp);
408   return 0;
409 }
410
411 void
412 vl_register_mapped_shmem_region (svm_region_t * rp)
413 {
414   api_main_t *am = &api_main;
415
416   vec_add1 (am->mapped_shmem_regions, rp);
417 }
418
419 void
420 vl_unmap_shmem (void)
421 {
422   svm_region_t *rp;
423   int i;
424   api_main_t *am = &api_main;
425
426   if (!svm_get_root_rp ())
427     return;
428
429   for (i = 0; i < vec_len (am->mapped_shmem_regions); i++)
430     {
431       rp = am->mapped_shmem_regions[i];
432       svm_region_unmap (rp);
433     }
434
435   vec_free (am->mapped_shmem_regions);
436   am->shmem_hdr = 0;
437
438   svm_region_exit ();
439   /* $$$ more careful cleanup, valgrind run... */
440   vec_free (am->msg_handlers);
441   vec_free (am->msg_endian_handlers);
442   vec_free (am->msg_print_handlers);
443 }
444
445 void
446 vl_msg_api_send_shmem (unix_shared_memory_queue_t * q, u8 * elem)
447 {
448   api_main_t *am = &api_main;
449   uword *trace = (uword *) elem;
450
451   if (am->tx_trace && am->tx_trace->enabled)
452     vl_msg_api_trace (am, am->tx_trace, (void *) trace[0]);
453
454   (void) unix_shared_memory_queue_add (q, elem, 0 /* nowait */ );
455 }
456
457 void
458 vl_msg_api_send_shmem_nolock (unix_shared_memory_queue_t * q, u8 * elem)
459 {
460   api_main_t *am = &api_main;
461   uword *trace = (uword *) elem;
462
463   if (am->tx_trace && am->tx_trace->enabled)
464     vl_msg_api_trace (am, am->tx_trace, (void *) trace[0]);
465
466   (void) unix_shared_memory_queue_add_nolock (q, elem);
467 }
468
469 static void
470 vl_api_memclnt_create_reply_t_handler (vl_api_memclnt_create_reply_t * mp)
471 {
472   api_main_t *am = &api_main;
473   int rv;
474
475   am->my_client_index = mp->index;
476   am->my_registration = (vl_api_registration_t *) (uword) mp->handle;
477
478   rv = ntohl (mp->response);
479
480   if (rv < 0)
481     clib_warning ("WARNING: API mismatch detected");
482 }
483
484 void vl_client_add_api_signatures (vl_api_memclnt_create_t * mp)
485   __attribute__ ((weak));
486
487 void
488 vl_client_add_api_signatures (vl_api_memclnt_create_t * mp)
489 {
490   int i;
491
492   for (i = 0; i < ARRAY_LEN (mp->api_versions); i++)
493     mp->api_versions[i] = 0;
494 }
495
496 int
497 vl_client_connect (char *name, int ctx_quota, int input_queue_size)
498 {
499   svm_region_t *svm;
500   vl_api_memclnt_create_t *mp;
501   vl_api_memclnt_create_reply_t *rp;
502   unix_shared_memory_queue_t *vl_input_queue;
503   vl_shmem_hdr_t *shmem_hdr;
504   int rv = 0;
505   void *oldheap;
506   api_main_t *am = &api_main;
507
508   if (am->my_registration)
509     {
510       clib_warning ("client %s already connected...", name);
511       return -1;
512     }
513
514   if (am->vlib_rp == 0)
515     {
516       clib_warning ("am->vlib_rp NULL");
517       return -1;
518     }
519
520   svm = am->vlib_rp;
521   shmem_hdr = am->shmem_hdr;
522
523   if (shmem_hdr == 0 || shmem_hdr->vl_input_queue == 0)
524     {
525       clib_warning ("shmem_hdr / input queue NULL");
526       return -1;
527     }
528
529   pthread_mutex_lock (&svm->mutex);
530   oldheap = svm_push_data_heap (svm);
531   vl_input_queue =
532     unix_shared_memory_queue_init (input_queue_size, sizeof (uword),
533                                    getpid (), 0);
534   pthread_mutex_unlock (&svm->mutex);
535   svm_pop_heap (oldheap);
536
537   am->my_client_index = ~0;
538   am->my_registration = 0;
539   am->vl_input_queue = vl_input_queue;
540
541   mp = vl_msg_api_alloc (sizeof (vl_api_memclnt_create_t));
542   memset (mp, 0, sizeof (*mp));
543   mp->_vl_msg_id = ntohs (VL_API_MEMCLNT_CREATE);
544   mp->ctx_quota = ctx_quota;
545   mp->input_queue = (uword) vl_input_queue;
546   strncpy ((char *) mp->name, name, sizeof (mp->name) - 1);
547
548   vl_client_add_api_signatures (mp);
549
550   vl_msg_api_send_shmem (shmem_hdr->vl_input_queue, (u8 *) & mp);
551
552   while (1)
553     {
554       int qstatus;
555       struct timespec ts, tsrem;
556       int i;
557
558       /* Wait up to 10 seconds */
559       for (i = 0; i < 1000; i++)
560         {
561           qstatus = unix_shared_memory_queue_sub (vl_input_queue, (u8 *) & rp,
562                                                   1 /* nowait */ );
563           if (qstatus == 0)
564             goto read_one_msg;
565           ts.tv_sec = 0;
566           ts.tv_nsec = 10000 * 1000;    /* 10 ms */
567           while (nanosleep (&ts, &tsrem) < 0)
568             ts = tsrem;
569         }
570       /* Timeout... */
571       clib_warning ("memclnt_create_reply timeout");
572       return -1;
573
574     read_one_msg:
575       if (ntohs (rp->_vl_msg_id) != VL_API_MEMCLNT_CREATE_REPLY)
576         {
577           clib_warning ("unexpected reply: id %d", ntohs (rp->_vl_msg_id));
578           continue;
579         }
580       rv = clib_net_to_host_u32 (rp->response);
581
582       vl_msg_api_handler ((void *) rp);
583       break;
584     }
585   return (rv);
586 }
587
588 static void
589 vl_api_memclnt_delete_reply_t_handler (vl_api_memclnt_delete_reply_t * mp)
590 {
591   void *oldheap;
592   api_main_t *am = &api_main;
593
594   pthread_mutex_lock (&am->vlib_rp->mutex);
595   oldheap = svm_push_data_heap (am->vlib_rp);
596   unix_shared_memory_queue_free (am->vl_input_queue);
597   pthread_mutex_unlock (&am->vlib_rp->mutex);
598   svm_pop_heap (oldheap);
599
600   am->my_client_index = ~0;
601   am->my_registration = 0;
602   am->vl_input_queue = 0;
603 }
604
605 void
606 vl_client_disconnect (void)
607 {
608   vl_api_memclnt_delete_t *mp;
609   vl_api_memclnt_delete_reply_t *rp;
610   unix_shared_memory_queue_t *vl_input_queue;
611   vl_shmem_hdr_t *shmem_hdr;
612   time_t begin;
613   api_main_t *am = &api_main;
614
615   ASSERT (am->vlib_rp);
616   shmem_hdr = am->shmem_hdr;
617   ASSERT (shmem_hdr && shmem_hdr->vl_input_queue);
618
619   vl_input_queue = am->vl_input_queue;
620
621   mp = vl_msg_api_alloc (sizeof (vl_api_memclnt_delete_t));
622   memset (mp, 0, sizeof (*mp));
623   mp->_vl_msg_id = ntohs (VL_API_MEMCLNT_DELETE);
624   mp->index = am->my_client_index;
625   mp->handle = (uword) am->my_registration;
626
627   vl_msg_api_send_shmem (shmem_hdr->vl_input_queue, (u8 *) & mp);
628
629   /*
630    * Have to be careful here, in case the client is disconnecting
631    * because e.g. the vlib process died, or is unresponsive.
632    */
633
634   begin = time (0);
635   while (1)
636     {
637       time_t now;
638
639       now = time (0);
640
641       if (now >= (begin + 2))
642         {
643           clib_warning ("peer unresponsive, give up");
644           am->my_client_index = ~0;
645           am->my_registration = 0;
646           am->shmem_hdr = 0;
647           break;
648         }
649       if (unix_shared_memory_queue_sub (vl_input_queue, (u8 *) & rp, 1) < 0)
650         continue;
651
652       /* drain the queue */
653       if (ntohs (rp->_vl_msg_id) != VL_API_MEMCLNT_DELETE_REPLY)
654         {
655           vl_msg_api_handler ((void *) rp);
656           continue;
657         }
658       vl_msg_api_handler ((void *) rp);
659       break;
660     }
661 }
662
663 static inline vl_api_registration_t *
664 vl_api_client_index_to_registration_internal (u32 handle)
665 {
666   vl_api_registration_t **regpp;
667   vl_api_registration_t *regp;
668   api_main_t *am = &api_main;
669   u32 index;
670
671   index = vl_msg_api_handle_get_index (handle);
672   if ((am->shmem_hdr->application_restarts & VL_API_EPOCH_MASK)
673       != vl_msg_api_handle_get_epoch (handle))
674     {
675       vl_msg_api_increment_missing_client_counter ();
676       return 0;
677     }
678
679   regpp = am->vl_clients + index;
680
681   if (pool_is_free (am->vl_clients, regpp))
682     {
683       vl_msg_api_increment_missing_client_counter ();
684       return 0;
685     }
686   regp = *regpp;
687   return (regp);
688 }
689
690 vl_api_registration_t *
691 vl_api_client_index_to_registration (u32 index)
692 {
693   return (vl_api_client_index_to_registration_internal (index));
694 }
695
696 unix_shared_memory_queue_t *
697 vl_api_client_index_to_input_queue (u32 index)
698 {
699   vl_api_registration_t *regp;
700
701   regp = vl_api_client_index_to_registration_internal (index);
702   if (!regp)
703     return 0;
704   return (regp->vl_input_queue);
705 }
706
707 #define foreach_api_client_msg                  \
708 _(MEMCLNT_CREATE_REPLY, memclnt_create_reply)   \
709 _(MEMCLNT_DELETE_REPLY, memclnt_delete_reply)
710
711 int
712 vl_client_api_map (char *region_name)
713 {
714   int rv;
715
716   if ((rv = vl_map_shmem (region_name, 0 /* is_vlib */ )) < 0)
717     {
718       return rv;
719     }
720
721 #define _(N,n)                                                          \
722     vl_msg_api_set_handlers(VL_API_##N, 0 /* name */,                   \
723                            vl_api_##n##_t_handler,                      \
724                            0/* cleanup */, 0/* endian */, 0/* print */, \
725                            sizeof(vl_api_##n##_t), 1);
726   foreach_api_client_msg;
727 #undef _
728   return 0;
729 }
730
731 void
732 vl_client_api_unmap (void)
733 {
734   vl_unmap_shmem ();
735 }
736
737 /*
738  * fd.io coding-style-patch-verification: ON
739  *
740  * Local Variables:
741  * eval: (c-set-style "gnu")
742  * End:
743  */