2 *------------------------------------------------------------------
3 * memory_client.c - API message handling, client code.
5 * Copyright (c) 2010 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 *------------------------------------------------------------------
23 #include <sys/types.h>
26 #include <netinet/in.h>
33 #include <vppinfra/clib.h>
34 #include <vppinfra/vec.h>
35 #include <vppinfra/hash.h>
36 #include <vppinfra/bitmap.h>
37 #include <vppinfra/fifo.h>
38 #include <vppinfra/time.h>
39 #include <vppinfra/mheap.h>
40 #include <vppinfra/heap.h>
41 #include <vppinfra/pool.h>
42 #include <vppinfra/format.h>
44 #include <vlib/vlib.h>
45 #include <vlib/unix/unix.h>
46 #include <vlibmemory/api.h>
48 #include <vlibmemory/vl_memory_msg_enum.h>
50 #define vl_typedefs /* define message structures */
51 #include <vlibmemory/vl_memory_api_h.h>
54 #define vl_endianfun /* define message structures */
55 #include <vlibmemory/vl_memory_api_h.h>
58 /* instantiate all the print functions we know about */
59 #define vl_print(handle, ...) clib_warning (__VA_ARGS__)
61 #include <vlibmemory/vl_memory_api_h.h>
66 u8 rx_thread_jmpbuf_valid;
68 jmp_buf rx_thread_jmpbuf;
69 pthread_t rx_thread_handle;
70 /* Plugin message base lookup scheme */
71 volatile u8 first_msg_id_reply_ready;
72 u16 first_msg_id_reply;
73 } memory_client_main_t;
75 memory_client_main_t memory_client_main;
78 rx_thread_fn (void *arg)
80 unix_shared_memory_queue_t *q;
81 memory_client_main_t *mm = &memory_client_main;
82 api_main_t *am = &api_main;
84 q = am->vl_input_queue;
86 /* So we can make the rx thread terminate cleanly */
87 if (setjmp (mm->rx_thread_jmpbuf) == 0)
89 mm->rx_thread_jmpbuf_valid = 1;
92 vl_msg_api_queue_handler (q);
99 vl_api_rx_thread_exit_t_handler (vl_api_rx_thread_exit_t * mp)
101 memory_client_main_t *mm = &memory_client_main;
102 vl_msg_api_free (mp);
103 longjmp (mm->rx_thread_jmpbuf, 1);
107 noop_handler (void *notused)
111 #define foreach_api_msg \
112 _(RX_THREAD_EXIT, rx_thread_exit)
115 connect_to_vlib_internal (char *svm_name, char *client_name,
116 int rx_queue_size, int want_pthread)
119 memory_client_main_t *mm = &memory_client_main;
121 if ((rv = vl_client_api_map (svm_name)))
123 clib_warning ("vl_client_api map rv %d", rv);
128 vl_msg_api_set_handlers(VL_API_##N, #n, \
129 vl_api_##n##_t_handler, \
131 vl_api_##n##_t_endian, \
132 vl_api_##n##_t_print, \
133 sizeof(vl_api_##n##_t), 1);
137 if (vl_client_connect (client_name, 0 /* punt quota */ ,
138 rx_queue_size /* input queue */ ) < 0)
140 vl_client_api_unmap ();
144 /* Start the rx queue thread */
148 rv = pthread_create (&mm->rx_thread_handle,
149 NULL /*attr */ , rx_thread_fn, 0);
151 clib_warning ("pthread_create returned %d", rv);
154 mm->connected_to_vlib = 1;
159 vl_client_connect_to_vlib (char *svm_name, char *client_name,
162 return connect_to_vlib_internal (svm_name, client_name, rx_queue_size,
163 1 /* want pthread */ );
167 vl_client_connect_to_vlib_no_rx_pthread (char *svm_name, char *client_name,
170 return connect_to_vlib_internal (svm_name, client_name, rx_queue_size,
171 0 /* want pthread */ );
175 vl_client_disconnect_from_vlib (void)
177 memory_client_main_t *mm = &memory_client_main;
178 api_main_t *am = &api_main;
181 if (mm->rx_thread_jmpbuf_valid)
183 vl_api_rx_thread_exit_t *ep;
184 ep = vl_msg_api_alloc (sizeof (*ep));
185 ep->_vl_msg_id = ntohs (VL_API_RX_THREAD_EXIT);
186 vl_msg_api_send_shmem (am->vl_input_queue, (u8 *) & ep);
187 pthread_join (mm->rx_thread_handle, (void **) &junk);
189 if (mm->connected_to_vlib)
191 vl_client_disconnect ();
192 vl_client_api_unmap ();
194 memset (mm, 0, sizeof (*mm));
197 static void vl_api_get_first_msg_id_reply_t_handler
198 (vl_api_get_first_msg_id_reply_t * mp)
200 memory_client_main_t *mm = &memory_client_main;
201 i32 retval = ntohl (mp->retval);
203 mm->first_msg_id_reply = (retval >= 0) ? ntohs (mp->first_msg_id) : ~0;
204 mm->first_msg_id_reply_ready = 1;
208 vl_client_get_first_plugin_msg_id (char *plugin_name)
210 vl_api_get_first_msg_id_t *mp;
211 api_main_t *am = &api_main;
212 memory_client_main_t *mm = &memory_client_main;
215 clib_time_t clib_time;
218 if (strlen (plugin_name) + 1 > sizeof (mp->name))
221 memset (&clib_time, 0, sizeof (clib_time));
222 clib_time_init (&clib_time);
224 /* Push this plugin's first_msg_id_reply handler */
225 old_handler = am->msg_handlers[VL_API_GET_FIRST_MSG_ID_REPLY];
226 am->msg_handlers[VL_API_GET_FIRST_MSG_ID_REPLY] = (void *)
227 vl_api_get_first_msg_id_reply_t_handler;
229 /* Ask the data-plane for the message-ID base of the indicated plugin */
230 mm->first_msg_id_reply_ready = 0;
232 mp = vl_msg_api_alloc (sizeof (*mp));
233 memset (mp, 0, sizeof (*mp));
234 mp->_vl_msg_id = ntohs (VL_API_GET_FIRST_MSG_ID);
235 mp->client_index = am->my_client_index;
236 strncpy ((char *) mp->name, plugin_name, sizeof (mp->name) - 1);
238 vl_msg_api_send_shmem (am->shmem_hdr->vl_input_queue, (u8 *) & mp);
240 /* Synchronously wait for the answer */
243 timeout = clib_time_now (&clib_time) + 1.0;
245 while (clib_time_now (&clib_time) < timeout)
247 if (mm->first_msg_id_reply_ready == 1)
249 rv = mm->first_msg_id_reply;
253 /* Restore old handler */
254 am->msg_handlers[VL_API_GET_FIRST_MSG_ID_REPLY] = old_handler;
262 /* Restore the old handler */
263 am->msg_handlers[VL_API_GET_FIRST_MSG_ID_REPLY] = old_handler;
266 clib_warning ("plugin '%s' not registered", plugin_name);
272 vlib_node_sync_stats (vlib_main_t * vm, vlib_node_t * n)
274 clib_warning ("STUB called...");
278 * fd.io coding-style-patch-verification: ON
281 * eval: (c-set-style "gnu")