2 *------------------------------------------------------------------
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:
10 * http://www.apache.org/licenses/LICENSE-2.0
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 *------------------------------------------------------------------
20 #ifndef included_vlibmemory_api_h
21 #define included_vlibmemory_api_h
23 #include <vppinfra/error.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>
30 /* Allocated in shared memory */
33 * Ring-allocation scheme for client API messages
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.
39 * No locks, no hits, no errors...
41 typedef struct ring_alloc_
43 unix_shared_memory_queue_t *rp;
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.
55 #define foreach_vl_aring_size \
60 #define foreach_clnt_aring_size \
65 typedef struct vl_shmem_hdr_
69 /* getpid () for the VLIB client process */
72 /* Client sends VLIB msgs here. */
73 unix_shared_memory_queue_t *vl_input_queue;
75 /* Vector of rings; one for each size. */
77 /* VLIB allocates buffers to send msgs to clients here. */
78 ring_alloc_t *vl_rings;
80 /* Clients allocate buffer to send msgs to VLIB here. */
81 ring_alloc_t *client_rings;
83 /* Number of detected application restarts */
84 u32 application_restarts;
86 /* Number of messages reclaimed during application restart */
89 /* Number of garbage-collected messages */
94 #define VL_SHM_VERSION 2
96 #define VL_API_EPOCH_MASK 0xFF
97 #define VL_API_EPOCH_SHIFT 8
100 vl_msg_api_handle_get_epoch (u32 index)
102 return (index & VL_API_EPOCH_MASK);
106 vl_msg_api_handle_get_index (u32 index)
108 return (index >> VL_API_EPOCH_SHIFT);
112 vl_msg_api_handle_from_index_and_epoch (u32 index, u32 epoch)
115 ASSERT (index < 0x00FFFFFF);
117 handle = (index << VL_API_EPOCH_SHIFT) | (epoch & VL_API_EPOCH_MASK);
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);
127 void vl_register_mapped_shmem_region (svm_region_t * rp);
128 void vl_unmap_shmem (void);
129 void vl_msg_api_send_shmem (unix_shared_memory_queue_t * q, u8 * elem);
130 void vl_msg_api_send_shmem_nolock (unix_shared_memory_queue_t * q, u8 * elem);
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);
134 unix_shared_memory_queue_t *vl_api_client_index_to_input_queue (u32 index);
135 vl_api_registration_t *vl_api_client_index_to_registration (u32 index);
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);
143 void vl_set_global_memory_size (u64 size);
144 void vl_set_api_memory_size (u64 size);
145 void vl_set_global_pvt_heap_size (u64 size);
146 void vl_set_api_pvt_heap_size (u64 size);
147 void vl_enable_disable_memory_api (vlib_main_t * vm, int yesno);
148 void vl_client_disconnect_from_vlib (void);
149 int vl_client_connect_to_vlib (char *svm_name, char *client_name,
151 int vl_client_connect_to_vlib_no_rx_pthread (char *svm_name,
154 u16 vl_client_get_first_plugin_msg_id (char *plugin_name);
156 void vl_api_rpc_call_main_thread (void *fp, u8 * data, u32 data_length);
158 #endif /* included_vlibmemory_api_h */
161 * fd.io coding-style-patch-verification: ON
164 * eval: (c-set-style "gnu")