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_ {
42 unix_shared_memory_queue_t *rp;
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.
54 #define foreach_vl_aring_size \
59 #define foreach_clnt_aring_size \
64 typedef struct vl_shmem_hdr_ {
67 /* getpid () for the VLIB client process */
70 /* Client sends VLIB msgs here. */
71 unix_shared_memory_queue_t *vl_input_queue;
73 /* Vector of rings; one for each size. */
75 /* VLIB allocates buffers to send msgs to clients here. */
76 ring_alloc_t *vl_rings;
78 /* Clients allocate buffer to send msgs to VLIB here. */
79 ring_alloc_t *client_rings;
81 /* Number of detected application restarts */
82 u32 application_restarts;
84 /* Number of messages reclaimed during application restart */
89 #define VL_SHM_VERSION 2
91 #define VL_API_EPOCH_MASK 0xFF
92 #define VL_API_EPOCH_SHIFT 8
94 static inline u32 vl_msg_api_handle_get_epoch (u32 index)
96 return (index & VL_API_EPOCH_MASK);
98 static inline u32 vl_msg_api_handle_get_index (u32 index)
100 return (index >> VL_API_EPOCH_SHIFT);
103 static inline u32 vl_msg_api_handle_from_index_and_epoch (u32 index, u32 epoch)
106 ASSERT (index < 0x00FFFFFF);
108 handle = (index<<VL_API_EPOCH_SHIFT) | (epoch & VL_API_EPOCH_MASK);
112 void *vl_msg_api_alloc(int nbytes);
113 void *vl_msg_api_alloc_as_if_client (int nbytes);
114 void vl_msg_api_free(void *a);
115 int vl_map_shmem (char *region_name, int is_vlib);
116 void vl_register_mapped_shmem_region(svm_region_t *rp);
117 void vl_unmap_shmem (void);
118 void vl_msg_api_send_shmem (unix_shared_memory_queue_t *q, u8 *elem);
119 void vl_msg_api_send_shmem_nolock (unix_shared_memory_queue_t *q, u8 *elem);
120 void vl_msg_api_send (vl_api_registration_t *rp, u8 *elem);
121 int vl_client_connect (char *name, int ctx_quota, int input_queue_size);
122 void vl_client_disconnect (void);
123 unix_shared_memory_queue_t *vl_api_client_index_to_input_queue (u32 index);
124 vl_api_registration_t *vl_api_client_index_to_registration (u32 index);
125 int vl_client_api_map (char *region_name);
126 void vl_client_api_unmap (void);
127 void vl_set_memory_region_name (char *name);
128 void vl_set_memory_root_path (char *root_path);
129 void vl_enable_disable_memory_api (vlib_main_t *vm, int yesno);
130 void vl_client_disconnect_from_vlib (void);
131 int vl_client_connect_to_vlib(char *svm_name, char *client_name,
133 int vl_client_connect_to_vlib_no_rx_pthread (char *svm_name, char *client_name,
135 u16 vl_client_get_first_plugin_msg_id (char * plugin_name);
137 void vl_api_rpc_call_main_thread (void *fp, u8 * data, u32 data_length);
139 #endif /* included_vlibmemory_api_h */