2 *------------------------------------------------------------------
3 * Copyright (c) 2009 Cisco and/or its affiliates.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 *------------------------------------------------------------------
18 #ifndef included_vlibmemory_api_common_h
19 #define included_vlibmemory_api_common_h
21 #include <svm/svm_common.h>
22 #include <vlibapi/api_common.h>
23 #include <vlibmemory/unix_shared_memory_queue.h>
25 /* Allocated in shared memory */
28 * Ring-allocation scheme for client API messages
30 * Only one proc/thread has control of a given message buffer.
31 * To free a buffer allocated from one of these rings, we clear
32 * a field in the buffer (header), and leave.
34 * No locks, no hits, no errors...
36 typedef struct ring_alloc_
38 unix_shared_memory_queue_t *rp;
46 * Initializers for the (shared-memory) rings
47 * _(size, n). Note: each msg has an 8 byte header.
48 * Might want to change that to an index sometime.
50 #define foreach_vl_aring_size \
55 #define foreach_clnt_aring_size \
60 typedef struct vl_shmem_hdr_
64 /* getpid () for the VLIB client process */
67 /* Client sends VLIB msgs here. */
68 unix_shared_memory_queue_t *vl_input_queue;
70 /* Vector of rings; one for each size. */
72 /* VLIB allocates buffers to send msgs to clients here. */
73 ring_alloc_t *vl_rings;
75 /* Clients allocate buffer to send msgs to VLIB here. */
76 ring_alloc_t *client_rings;
78 /* Number of detected application restarts */
79 u32 application_restarts;
81 /* Number of messages reclaimed during application restart */
84 /* Number of garbage-collected messages */
89 #define VL_SHM_VERSION 2
91 #define VL_API_EPOCH_MASK 0xFF
92 #define VL_API_EPOCH_SHIFT 8
94 void *vl_msg_api_alloc (int nbytes);
95 void *vl_msg_api_alloc_or_null (int nbytes);
96 void *vl_msg_api_alloc_as_if_client (int nbytes);
97 void *vl_msg_api_alloc_as_if_client_or_null (int nbytes);
98 void vl_msg_api_free (void *a);
99 int vl_map_shmem (const char *region_name, int is_vlib);
100 void vl_register_mapped_shmem_region (svm_region_t * rp);
101 void vl_unmap_shmem (void);
102 void vl_msg_api_send_shmem (unix_shared_memory_queue_t * q, u8 * elem);
103 void vl_msg_api_send_shmem_nolock (unix_shared_memory_queue_t * q, u8 * elem);
104 void vl_msg_api_send (vl_api_registration_t * rp, u8 * elem);
105 int vl_client_connect (const char *name, int ctx_quota, int input_queue_size);
106 void vl_client_disconnect (void);
107 unix_shared_memory_queue_t *vl_api_client_index_to_input_queue (u32 index);
108 vl_api_registration_t *vl_api_client_index_to_registration (u32 index);
109 int vl_client_api_map (const char *region_name);
110 void vl_client_api_unmap (void);
111 void vl_set_memory_region_name (const char *name);
112 void vl_set_memory_root_path (const char *root_path);
113 void vl_set_memory_uid (int uid);
114 void vl_set_memory_gid (int gid);
115 void vl_set_global_memory_baseva (u64 baseva);
116 void vl_set_global_memory_size (u64 size);
117 void vl_set_api_memory_size (u64 size);
118 void vl_set_global_pvt_heap_size (u64 size);
119 void vl_set_api_pvt_heap_size (u64 size);
120 void vl_client_disconnect_from_vlib (void);
121 int vl_client_connect_to_vlib (const char *svm_name, const char *client_name,
123 int vl_client_connect_to_vlib_no_rx_pthread (const char *svm_name,
124 const char *client_name,
126 u16 vl_client_get_first_plugin_msg_id (const char *plugin_name);
128 void vl_api_rpc_call_main_thread (void *fp, u8 * data, u32 data_length);
129 u32 vl_api_memclnt_create_internal (char *, unix_shared_memory_queue_t *);
131 #endif /* included_vlibmemory_api_common_h */
134 * fd.io coding-style-patch-verification: ON
137 * eval: (c-set-style "gnu")