vlib-api/vlibmemory/api.h

   1 /*
   2  *------------------------------------------------------------------
   3  * api.h
   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 #ifndef included_vlibmemory_api_h
  21 #define included_vlibmemory_api_h
  22
  23 #include <vppinfra/error.h>
  24 #include <svm.h>
  25 #include <vlib/vlib.h>
  26 #include <vlibmemory/unix_shared_memory_queue.h>
  27 #include <vlib/unix/unix.h>
  28 #include <vlibapi/api.h>
  29
  30 /* Allocated in shared memory */
  31
  32 /*
  33  * Ring-allocation scheme for client API messages
  34  *
  35  * Only one proc/thread has control of a given message buffer.
  36  * To free a buffer allocated from one of these rings, we clear
  37  * a field in the buffer (header), and leave.
  38  *
  39  * No locks, no hits, no errors...
  40  */
  41 typedef struct ring_alloc_ {
  42     unix_shared_memory_queue_t *rp;
  43     u16 size;
  44     u16 nitems;
  45     u32 hits;
  46     u32 misses;
  47 } ring_alloc_t;
  48
  49 /*
  50  * Initializers for the (shared-memory) rings
  51  * _(size, n). Note: each msg has an 8 byte header.
  52  * Might want to change that to an index sometime.
  53  */
  54 #define foreach_vl_aring_size                   \
  55 _(64+8, 1024)                                   \
  56 _(256+8, 128)                                   \
  57 _(1024+8, 64)
  58
  59 #define foreach_clnt_aring_size                 \
  60 _(1024+8, 1024)                                 \
  61 _(2048+8, 128)                                  \
  62 _(4096+8, 8)
  63
  64 typedef struct vl_shmem_hdr_ {
  65     int version;
  66
  67     /* getpid () for the VLIB client process */
  68     volatile int vl_pid;
  69
  70     /* Client sends VLIB msgs here. */
  71     unix_shared_memory_queue_t *vl_input_queue;
  72
  73     /* Vector of rings; one for each size. */
  74
  75     /* VLIB allocates buffers to send msgs to clients here. */
  76     ring_alloc_t *vl_rings;
  77
  78     /* Clients allocate buffer to send msgs to VLIB here. */
  79     ring_alloc_t *client_rings;
  80
  81     /* Number of detected application restarts */
  82     u32 application_restarts;
  83
  84     /* Number of messages reclaimed during application restart */
  85     u32 restart_reclaims;
  86
  87 } vl_shmem_hdr_t;
  88
  89 #define VL_SHM_VERSION 2
  90
  91 #define VL_API_EPOCH_MASK 0xFF
  92 #define VL_API_EPOCH_SHIFT 8
  93
  94 static inline u32 vl_msg_api_handle_get_epoch (u32 index)
  95 {
  96     return (index & VL_API_EPOCH_MASK);
  97 }
  98 static inline u32 vl_msg_api_handle_get_index (u32 index)
  99 {
 100     return (index >> VL_API_EPOCH_SHIFT);
 101 }
 102
 103 static inline u32 vl_msg_api_handle_from_index_and_epoch (u32 index, u32 epoch)
 104 {
 105     u32 handle;
 106     ASSERT (index < 0x00FFFFFF);
 107
 108     handle = (index<<VL_API_EPOCH_SHIFT) | (epoch & VL_API_EPOCH_MASK);
 109     return handle;
 110 }
 111
 112
 113
 114 void *vl_msg_api_alloc(int nbytes);
 115 void *vl_msg_api_alloc_as_if_client (int nbytes);
 116 void vl_msg_api_free(void *a);
 117 int vl_map_shmem (char *region_name, int is_vlib);
 118 void vl_register_mapped_shmem_region(svm_region_t *rp);
 119 void vl_unmap_shmem (void);
 120 void vl_msg_api_send_shmem (unix_shared_memory_queue_t *q, u8 *elem);
 121 void vl_msg_api_send_shmem_nolock (unix_shared_memory_queue_t *q, u8 *elem);
 122 void vl_msg_api_send (vl_api_registration_t *rp, u8 *elem);
 123 int vl_client_connect (char *name, int ctx_quota, int input_queue_size);
 124 void vl_client_disconnect (void);
 125 unix_shared_memory_queue_t *vl_api_client_index_to_input_queue (u32 index);
 126 vl_api_registration_t *vl_api_client_index_to_registration (u32 index);
 127 int vl_client_api_map (char *region_name);
 128 void vl_client_api_unmap (void);
 129 void vl_set_memory_region_name (char *name);
 130 void vl_set_memory_root_path (char *root_path);
 131 void vl_enable_disable_memory_api (vlib_main_t *vm, int yesno);
 132 void vl_client_disconnect_from_vlib (void);
 133 int vl_client_connect_to_vlib(char *svm_name, char *client_name,
 134                               int rx_queue_size);
 135 int vl_client_connect_to_vlib_no_rx_pthread (char *svm_name, char *client_name,
 136                                              int rx_queue_size);
 137 u16 vl_client_get_first_plugin_msg_id (char * plugin_name);
 138
 139 #endif /* included_vlibmemory_api_h */