FD.io VPP  v17.04-9-g99c0734
Vector Packet Processing
api.h
Go to the documentation of this file.
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>
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 {
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. */
74 
75  /* Vector of rings; one for each size. */
76 
77  /* VLIB allocates buffers to send msgs to clients here. */
79 
80  /* Clients allocate buffer to send msgs to VLIB here. */
82 
83  /* Number of detected application restarts */
85 
86  /* Number of messages reclaimed during application restart */
88 
89  /* Number of garbage-collected messages */
91 
93 
94 #define VL_SHM_VERSION 2
95 
96 #define VL_API_EPOCH_MASK 0xFF
97 #define VL_API_EPOCH_SHIFT 8
98 
99 static inline u32
101 {
102  return (index & VL_API_EPOCH_MASK);
103 }
104 
105 static inline u32
107 {
108  return (index >> VL_API_EPOCH_SHIFT);
109 }
110 
111 static inline u32
113 {
114  u32 handle;
115  ASSERT (index < 0x00FFFFFF);
116 
117  handle = (index << VL_API_EPOCH_SHIFT) | (epoch & VL_API_EPOCH_MASK);
118  return handle;
119 }
120 
121 void *vl_msg_api_alloc (int nbytes);
122 void *vl_msg_api_alloc_or_null (int nbytes);
123 void *vl_msg_api_alloc_as_if_client (int nbytes);
124 void *vl_msg_api_alloc_as_if_client_or_null (int nbytes);
125 void vl_msg_api_free (void *a);
126 int vl_map_shmem (char *region_name, int is_vlib);
128 void vl_unmap_shmem (void);
131 void vl_msg_api_send (vl_api_registration_t * rp, u8 * elem);
132 int vl_client_connect (char *name, int ctx_quota, int input_queue_size);
133 void vl_client_disconnect (void);
136 int vl_client_api_map (char *region_name);
137 void vl_client_api_unmap (void);
138 void vl_set_memory_region_name (char *name);
139 void vl_set_memory_root_path (char *root_path);
140 void vl_set_memory_uid (int uid);
141 void vl_set_memory_gid (int gid);
142 void vl_set_global_memory_baseva (u64 baseva);
147 void vl_enable_disable_memory_api (vlib_main_t * vm, int yesno);
149 int vl_client_connect_to_vlib (char *svm_name, char *client_name,
150  int rx_queue_size);
151 int vl_client_connect_to_vlib_no_rx_pthread (char *svm_name,
152  char *client_name,
153  int rx_queue_size);
154 u16 vl_client_get_first_plugin_msg_id (char *plugin_name);
155 
156 void vl_api_rpc_call_main_thread (void *fp, u8 * data, u32 data_length);
157 
158 #endif /* included_vlibmemory_api_h */
159 
160 /*
161  * fd.io coding-style-patch-verification: ON
162  *
163  * Local Variables:
164  * eval: (c-set-style "gnu")
165  * End:
166  */
int vl_client_connect_to_vlib(char *svm_name, char *client_name, int rx_queue_size)
void vl_enable_disable_memory_api(vlib_main_t *vm, int yesno)
Definition: memory_vlib.c:794
a
Definition: bitmap.h:516
void vl_set_memory_gid(int gid)
void vl_msg_api_send_shmem(unix_shared_memory_queue_t *q, u8 *elem)
void vl_set_global_pvt_heap_size(u64 size)
u32 application_restarts
Definition: api.h:84
void vl_client_disconnect_from_vlib(void)
unix_shared_memory_queue_t * vl_input_queue
Definition: api.h:73
u16 nitems
Definition: api.h:45
unix_shared_memory_queue_t * vl_api_client_index_to_input_queue(u32 index)
ring_alloc_t * client_rings
Definition: api.h:81
void vl_set_global_memory_baseva(u64 baseva)
void vl_set_api_pvt_heap_size(u64 size)
void vl_set_global_memory_size(u64 size)
void vl_unmap_shmem(void)
void vl_set_memory_uid(int uid)
void vl_msg_api_free(void *)
void vl_api_rpc_call_main_thread(void *fp, u8 *data, u32 data_length)
Definition: memory_vlib.c:1327
unsigned long u64
Definition: types.h:89
vl_api_registration_t * vl_api_client_index_to_registration(u32 index)
int vl_client_api_map(char *region_name)
void vl_set_memory_root_path(char *root_path)
volatile int vl_pid
Definition: api.h:70
static u32 vl_msg_api_handle_get_index(u32 index)
Definition: api.h:106
u16 vl_client_get_first_plugin_msg_id(char *plugin_name)
void * vl_msg_api_alloc(int nbytes)
ring_alloc_t * vl_rings
Definition: api.h:78
int vl_client_connect_to_vlib_no_rx_pthread(char *svm_name, char *client_name, int rx_queue_size)
u32 garbage_collects
Definition: api.h:90
struct vl_shmem_hdr_ vl_shmem_hdr_t
int vl_client_connect(char *name, int ctx_quota, int input_queue_size)
int version
Definition: api.h:67
#define ASSERT(truth)
#define VL_API_EPOCH_MASK
Definition: api.h:96
unsigned int u32
Definition: types.h:88
u16 size
Definition: api.h:44
u32 misses
Definition: api.h:47
u32 restart_reclaims
Definition: api.h:87
void vl_msg_api_send(vl_api_registration_t *rp, u8 *elem)
Definition: memory_vlib.c:104
#define VL_API_EPOCH_SHIFT
Definition: api.h:97
void vl_register_mapped_shmem_region(svm_region_t *rp)
void vl_client_disconnect(void)
void vl_client_api_unmap(void)
void vl_set_memory_region_name(char *name)
Definition: memory_vlib.c:1205
unsigned short u16
Definition: types.h:57
unsigned char u8
Definition: types.h:56
int vl_map_shmem(char *region_name, int is_vlib)
struct ring_alloc_ ring_alloc_t
unix_shared_memory_queue_t * rp
Definition: api.h:43
void * vl_msg_api_alloc_or_null(int nbytes)
void * vl_msg_api_alloc_as_if_client_or_null(int nbytes)
void vl_msg_api_send_shmem_nolock(unix_shared_memory_queue_t *q, u8 *elem)
void * vl_msg_api_alloc_as_if_client(int nbytes)
static u32 vl_msg_api_handle_get_epoch(u32 index)
Definition: api.h:100
u32 hits
Definition: api.h:46
void vl_set_api_memory_size(u64 size)
static u32 vl_msg_api_handle_from_index_and_epoch(u32 index, u32 epoch)
Definition: api.h:112
struct _unix_shared_memory_queue unix_shared_memory_queue_t