src/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/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 {
  43   unix_shared_memory_queue_t *rp;
  44   u16 size;
  45   u16 nitems;
  46   u32 hits;
  47   u32 misses;
  48 } ring_alloc_t;
  49
  50 /*
  51  * Initializers for the (shared-memory) rings
  52  * _(size, n). Note: each msg has an 8 byte header.
  53  * Might want to change that to an index sometime.
  54  */
  55 #define foreach_vl_aring_size                   \
  56 _(64+8, 1024)                                   \
  57 _(256+8, 128)                                   \
  58 _(1024+8, 64)
  59
  60 #define foreach_clnt_aring_size                 \
  61 _(1024+8, 1024)                                 \
  62 _(2048+8, 128)                                  \
  63 _(4096+8, 8)
  64
  65 typedef struct vl_shmem_hdr_
  66 {
  67   int version;
  68
  69   /* getpid () for the VLIB client process */
  70   volatile int vl_pid;
  71
  72   /* Client sends VLIB msgs here. */
  73   unix_shared_memory_queue_t *vl_input_queue;
  74
  75   /* Vector of rings; one for each size. */
  76
  77   /* VLIB allocates buffers to send msgs to clients here. */
  78   ring_alloc_t *vl_rings;
  79
  80   /* Clients allocate buffer to send msgs to VLIB here. */
  81   ring_alloc_t *client_rings;
  82
  83   /* Number of detected application restarts */
  84   u32 application_restarts;
  85
  86   /* Number of messages reclaimed during application restart */
  87   u32 restart_reclaims;
  88
  89 } vl_shmem_hdr_t;
  90
  91 #define VL_SHM_VERSION 2
  92
  93 #define VL_API_EPOCH_MASK 0xFF
  94 #define VL_API_EPOCH_SHIFT 8
  95
  96 static inline u32
  97 vl_msg_api_handle_get_epoch (u32 index)
  98 {
  99   return (index & VL_API_EPOCH_MASK);
 100 }
 101
 102 static inline u32
 103 vl_msg_api_handle_get_index (u32 index)
 104 {
 105   return (index >> VL_API_EPOCH_SHIFT);
 106 }
 107
 108 static inline u32
 109 vl_msg_api_handle_from_index_and_epoch (u32 index, u32 epoch)
 110 {
 111   u32 handle;
 112   ASSERT (index < 0x00FFFFFF);
 113
 114   handle = (index << VL_API_EPOCH_SHIFT) | (epoch & VL_API_EPOCH_MASK);
 115   return handle;
 116 }
 117
 118 void *vl_msg_api_alloc (int nbytes);
 119 void *vl_msg_api_alloc_or_null (int nbytes);
 120 void *vl_msg_api_alloc_as_if_client (int nbytes);
 121 void *vl_msg_api_alloc_as_if_client_or_null (int nbytes);
 122 void vl_msg_api_free (void *a);
 123 int vl_map_shmem (char *region_name, int is_vlib);
 124 void vl_register_mapped_shmem_region (svm_region_t * rp);
 125 void vl_unmap_shmem (void);
 126 void vl_msg_api_send_shmem (unix_shared_memory_queue_t * q, u8 * elem);
 127 void vl_msg_api_send_shmem_nolock (unix_shared_memory_queue_t * q, u8 * elem);
 128 void vl_msg_api_send (vl_api_registration_t * rp, u8 * elem);
 129 int vl_client_connect (char *name, int ctx_quota, int input_queue_size);
 130 void vl_client_disconnect (void);
 131 unix_shared_memory_queue_t *vl_api_client_index_to_input_queue (u32 index);
 132 vl_api_registration_t *vl_api_client_index_to_registration (u32 index);
 133 int vl_client_api_map (char *region_name);
 134 void vl_client_api_unmap (void);
 135 void vl_set_memory_region_name (char *name);
 136 void vl_set_memory_root_path (char *root_path);
 137 void vl_set_memory_uid (int uid);
 138 void vl_set_memory_gid (int gid);
 139 void vl_set_global_memory_baseva (u64 baseva);
 140 void vl_set_global_memory_size (u64 size);
 141 void vl_set_api_memory_size (u64 size);
 142 void vl_set_global_pvt_heap_size (u64 size);
 143 void vl_set_api_pvt_heap_size (u64 size);
 144 void vl_enable_disable_memory_api (vlib_main_t * vm, int yesno);
 145 void vl_client_disconnect_from_vlib (void);
 146 int vl_client_connect_to_vlib (char *svm_name, char *client_name,
 147                                int rx_queue_size);
 148 int vl_client_connect_to_vlib_no_rx_pthread (char *svm_name,
 149                                              char *client_name,
 150                                              int rx_queue_size);
 151 u16 vl_client_get_first_plugin_msg_id (char *plugin_name);
 152
 153 void vl_api_rpc_call_main_thread (void *fp, u8 * data, u32 data_length);
 154
 155 #endif /* included_vlibmemory_api_h */
 156
 157 /*
 158  * fd.io coding-style-patch-verification: ON
 159  *
 160  * Local Variables:
 161  * eval: (c-set-style "gnu")
 162  * End:
 163  */