blob: 8bce069f97b39e26435ff3cd0e2e3411ee1afb16 [file] [log] [blame]
Dave Barach371e4e12016-07-08 09:38:52 -04001/*
Ed Warnickecb9cada2015-12-08 15:45:58 -07002 *------------------------------------------------------------------
3 * memory_client.c - API message handling, client code.
4 *
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:
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
Ed Warnickecb9cada2015-12-08 15:45:58 -070020#include <setjmp.h>
Ed Warnickecb9cada2015-12-08 15:45:58 -070021
Florin Corase86a8ed2018-01-05 03:20:25 -080022#include <svm/svm.h>
Florin Coras4d9b9d82018-01-14 12:25:50 -080023#include <svm/ssvm.h>
Florin Corase86a8ed2018-01-05 03:20:25 -080024#include <vppinfra/serialize.h>
25#include <vppinfra/hash.h>
26#include <vlibmemory/memory_client.h>
Dave Barach39d69112019-11-27 11:42:13 -050027#include <vlibapi/api_common.h>
Florin Corase86a8ed2018-01-05 03:20:25 -080028
29/* A hack. vl_client_get_first_plugin_msg_id depends on it */
30#include <vlibmemory/socket_client.h>
Ed Warnickecb9cada2015-12-08 15:45:58 -070031
32#include <vlibmemory/vl_memory_msg_enum.h>
33
Dave Barach371e4e12016-07-08 09:38:52 -040034#define vl_typedefs /* define message structures */
35#include <vlibmemory/vl_memory_api_h.h>
Ed Warnickecb9cada2015-12-08 15:45:58 -070036#undef vl_typedefs
37
Dave Barach371e4e12016-07-08 09:38:52 -040038#define vl_endianfun /* define message structures */
39#include <vlibmemory/vl_memory_api_h.h>
Ed Warnickecb9cada2015-12-08 15:45:58 -070040#undef vl_endianfun
41
Klement Sekera9b7e8ac2021-11-22 21:26:20 +010042#define vl_calcsizefun
43#include <vlibmemory/vl_memory_api_h.h>
44#undef vl_calcsizefun
45
Ed Warnickecb9cada2015-12-08 15:45:58 -070046/* instantiate all the print functions we know about */
Ed Warnickecb9cada2015-12-08 15:45:58 -070047#define vl_printfun
48#include <vlibmemory/vl_memory_api_h.h>
49#undef vl_printfun
50
Ed Warnickecb9cada2015-12-08 15:45:58 -070051memory_client_main_t memory_client_main;
Dave Barach39d69112019-11-27 11:42:13 -050052__thread memory_client_main_t *my_memory_client_main = &memory_client_main;
Ed Warnickecb9cada2015-12-08 15:45:58 -070053
Florin Coras684fb6e2019-12-09 16:42:50 -080054typedef struct rx_thread_fn_arg
55{
56 api_main_t *am;
57 memory_client_main_t *mm;
58} rx_thread_fn_arg_t;
59
Dave Barach371e4e12016-07-08 09:38:52 -040060static void *
61rx_thread_fn (void *arg)
Ed Warnickecb9cada2015-12-08 15:45:58 -070062{
Florin Coras684fb6e2019-12-09 16:42:50 -080063 rx_thread_fn_arg_t *a = (rx_thread_fn_arg_t *) arg;
64 memory_client_main_t *mm;
Florin Corase86a8ed2018-01-05 03:20:25 -080065 svm_queue_t *q;
Ed Warnickecb9cada2015-12-08 15:45:58 -070066
Florin Coras684fb6e2019-12-09 16:42:50 -080067 vlibapi_set_main (a->am);
68 vlibapi_set_memory_client_main (a->mm);
Florin Coras68f58d72020-05-11 18:03:40 +000069 free (a);
Florin Coras684fb6e2019-12-09 16:42:50 -080070
71 mm = vlibapi_get_memory_client_main ();
Dave Barach39d69112019-11-27 11:42:13 -050072 q = vlibapi_get_main ()->vl_input_queue;
Ed Warnickecb9cada2015-12-08 15:45:58 -070073
Dave Barach371e4e12016-07-08 09:38:52 -040074 /* So we can make the rx thread terminate cleanly */
75 if (setjmp (mm->rx_thread_jmpbuf) == 0)
76 {
77 mm->rx_thread_jmpbuf_valid = 1;
Nathan Skrzypczakd516ca42019-08-01 18:14:06 +020078 clib_mem_set_thread_index ();
Dave Barachcf5e8482017-10-17 11:48:29 -040079 while (1)
80 vl_msg_api_queue_handler (q);
Ed Warnickecb9cada2015-12-08 15:45:58 -070081 }
Dave Barach371e4e12016-07-08 09:38:52 -040082 pthread_exit (0);
Ed Warnickecb9cada2015-12-08 15:45:58 -070083}
84
Dave Barach371e4e12016-07-08 09:38:52 -040085static void
86vl_api_rx_thread_exit_t_handler (vl_api_rx_thread_exit_t * mp)
Ed Warnickecb9cada2015-12-08 15:45:58 -070087{
Dave Barach39d69112019-11-27 11:42:13 -050088 memory_client_main_t *mm = vlibapi_get_memory_client_main ();
Ole Troanc5607892019-04-10 19:32:02 +020089 if (mm->rx_thread_jmpbuf_valid)
90 longjmp (mm->rx_thread_jmpbuf, 1);
Ed Warnickecb9cada2015-12-08 15:45:58 -070091}
92
Dave Barach371e4e12016-07-08 09:38:52 -040093static void
Ole Troan73710c72018-06-04 22:27:49 +020094vl_api_name_and_crc_free (void)
95{
Dave Barach39d69112019-11-27 11:42:13 -050096 api_main_t *am = vlibapi_get_main ();
Ole Troan73710c72018-06-04 22:27:49 +020097 int i;
98 u8 **keys = 0;
99 hash_pair_t *hp;
100
101 if (!am->msg_index_by_name_and_crc)
102 return;
103
Ole Troan73710c72018-06-04 22:27:49 +0200104 hash_foreach_pair (hp, am->msg_index_by_name_and_crc,
105 ({
106 vec_add1 (keys, (u8 *) hp->key);
107 }));
Ole Troan73710c72018-06-04 22:27:49 +0200108 for (i = 0; i < vec_len (keys); i++)
109 vec_free (keys[i]);
110 vec_free (keys);
111 hash_free (am->msg_index_by_name_and_crc);
112}
113
Damjan Marion79934e82022-04-05 12:40:31 +0200114__clib_nosanitize_addr static void
BenoƮt Ganne9fb6d402019-04-15 15:28:21 +0200115VL_API_VEC_UNPOISON (const void *v)
116{
117 const vec_header_t *vh = &((vec_header_t *) v)[-1];
Damjan Marion79934e82022-04-05 12:40:31 +0200118 clib_mem_unpoison (vh, sizeof (*vh) + vec_len (v));
BenoƮt Ganne9fb6d402019-04-15 15:28:21 +0200119}
120
Ole Troan73710c72018-06-04 22:27:49 +0200121static void
Dave Barach5c6c4bf2017-04-11 13:12:48 -0400122vl_api_memclnt_create_reply_t_handler (vl_api_memclnt_create_reply_t * mp)
123{
124 serialize_main_t _sm, *sm = &_sm;
Dave Barach39d69112019-11-27 11:42:13 -0500125 api_main_t *am = vlibapi_get_main ();
Dave Barach5c6c4bf2017-04-11 13:12:48 -0400126 u8 *tblv;
127 u32 nmsgs;
128 int i;
129 u8 *name_and_crc;
130 u32 msg_index;
131
132 am->my_client_index = mp->index;
133 am->my_registration = (vl_api_registration_t *) (uword) mp->handle;
134
135 /* Clean out any previous hash table (unlikely) */
Ole Troan73710c72018-06-04 22:27:49 +0200136 vl_api_name_and_crc_free ();
Dave Barach5c6c4bf2017-04-11 13:12:48 -0400137
138 am->msg_index_by_name_and_crc = hash_create_string (0, sizeof (uword));
139
140 /* Recreate the vnet-side API message handler table */
Damjan Marion7bee80c2017-04-26 15:32:12 +0200141 tblv = uword_to_pointer (mp->message_table, u8 *);
Dave Barachcf5e8482017-10-17 11:48:29 -0400142 unserialize_open_data (sm, tblv, vec_len (tblv));
Dave Barach5c6c4bf2017-04-11 13:12:48 -0400143 unserialize_integer (sm, &nmsgs, sizeof (u32));
144
BenoƮt Ganne9fb6d402019-04-15 15:28:21 +0200145 VL_API_VEC_UNPOISON (tblv);
146
Dave Barach5c6c4bf2017-04-11 13:12:48 -0400147 for (i = 0; i < nmsgs; i++)
148 {
149 msg_index = unserialize_likely_small_unsigned_integer (sm);
150 unserialize_cstring (sm, (char **) &name_and_crc);
151 hash_set_mem (am->msg_index_by_name_and_crc, name_and_crc, msg_index);
152 }
153}
154
Ole Troan2e1c8962019-04-10 09:44:23 +0200155void vl_msg_api_send_shmem (svm_queue_t * q, u8 * elem);
Dave Barach5c6c4bf2017-04-11 13:12:48 -0400156int
Neale Rannse72be392017-04-26 13:59:20 -0700157vl_client_connect (const char *name, int ctx_quota, int input_queue_size)
Dave Barach5c6c4bf2017-04-11 13:12:48 -0400158{
Dave Barach5c6c4bf2017-04-11 13:12:48 -0400159 vl_api_memclnt_create_t *mp;
160 vl_api_memclnt_create_reply_t *rp;
Florin Corase86a8ed2018-01-05 03:20:25 -0800161 svm_queue_t *vl_input_queue;
Dave Barach5c6c4bf2017-04-11 13:12:48 -0400162 vl_shmem_hdr_t *shmem_hdr;
163 int rv = 0;
164 void *oldheap;
Dave Barach39d69112019-11-27 11:42:13 -0500165 api_main_t *am = vlibapi_get_main ();
Dave Barach5c6c4bf2017-04-11 13:12:48 -0400166
167 if (am->my_registration)
168 {
169 clib_warning ("client %s already connected...", name);
170 return -1;
171 }
172
173 if (am->vlib_rp == 0)
174 {
175 clib_warning ("am->vlib_rp NULL");
176 return -1;
177 }
178
Dave Barach5c6c4bf2017-04-11 13:12:48 -0400179 shmem_hdr = am->shmem_hdr;
180
181 if (shmem_hdr == 0 || shmem_hdr->vl_input_queue == 0)
182 {
183 clib_warning ("shmem_hdr / input queue NULL");
184 return -1;
185 }
186
Damjan Marion79934e82022-04-05 12:40:31 +0200187 clib_mem_unpoison (shmem_hdr, sizeof (*shmem_hdr));
BenoƮt Ganne9fb6d402019-04-15 15:28:21 +0200188 VL_MSG_API_SVM_QUEUE_UNPOISON (shmem_hdr->vl_input_queue);
189
Nathan Skrzypczak0aa40132019-11-25 16:29:38 +0100190 oldheap = vl_msg_push_heap ();
Florin Corasc470e222018-08-01 07:53:18 -0700191 vl_input_queue = svm_queue_alloc_and_init (input_queue_size, sizeof (uword),
192 getpid ());
Nathan Skrzypczak0aa40132019-11-25 16:29:38 +0100193 vl_msg_pop_heap (oldheap);
Dave Barach5c6c4bf2017-04-11 13:12:48 -0400194
195 am->my_client_index = ~0;
196 am->my_registration = 0;
197 am->vl_input_queue = vl_input_queue;
198
199 mp = vl_msg_api_alloc (sizeof (vl_api_memclnt_create_t));
Dave Barachb7b92992018-10-17 10:38:51 -0400200 clib_memset (mp, 0, sizeof (*mp));
Dave Barach5c6c4bf2017-04-11 13:12:48 -0400201 mp->_vl_msg_id = ntohs (VL_API_MEMCLNT_CREATE);
202 mp->ctx_quota = ctx_quota;
203 mp->input_queue = (uword) vl_input_queue;
Ole Troan7adaa222019-08-27 15:05:27 +0200204 strncpy ((char *) mp->name, name, sizeof (mp->name) - 1);
Dave Barach5c6c4bf2017-04-11 13:12:48 -0400205
206 vl_msg_api_send_shmem (shmem_hdr->vl_input_queue, (u8 *) & mp);
207
208 while (1)
209 {
210 int qstatus;
211 struct timespec ts, tsrem;
212 int i;
213
214 /* Wait up to 10 seconds */
215 for (i = 0; i < 1000; i++)
216 {
Florin Corase86a8ed2018-01-05 03:20:25 -0800217 qstatus = svm_queue_sub (vl_input_queue, (u8 *) & rp,
Mohsin Kazmi3fca5672018-01-04 18:57:26 +0100218 SVM_Q_NOWAIT, 0);
Dave Barach5c6c4bf2017-04-11 13:12:48 -0400219 if (qstatus == 0)
220 goto read_one_msg;
221 ts.tv_sec = 0;
222 ts.tv_nsec = 10000 * 1000; /* 10 ms */
223 while (nanosleep (&ts, &tsrem) < 0)
224 ts = tsrem;
225 }
226 /* Timeout... */
227 clib_warning ("memclnt_create_reply timeout");
228 return -1;
229
230 read_one_msg:
BenoƮt Ganne9fb6d402019-04-15 15:28:21 +0200231 VL_MSG_API_UNPOISON (rp);
Dave Barach5c6c4bf2017-04-11 13:12:48 -0400232 if (ntohs (rp->_vl_msg_id) != VL_API_MEMCLNT_CREATE_REPLY)
233 {
234 clib_warning ("unexpected reply: id %d", ntohs (rp->_vl_msg_id));
235 continue;
236 }
237 rv = clib_net_to_host_u32 (rp->response);
238
Klement Sekera9b7e8ac2021-11-22 21:26:20 +0100239 msgbuf_t *msgbuf = (msgbuf_t *) ((u8 *) rp - offsetof (msgbuf_t, data));
240 vl_msg_api_handler ((void *) rp, ntohl (msgbuf->data_len));
Dave Barach5c6c4bf2017-04-11 13:12:48 -0400241 break;
242 }
243 return (rv);
244}
245
246static void
247vl_api_memclnt_delete_reply_t_handler (vl_api_memclnt_delete_reply_t * mp)
248{
249 void *oldheap;
Dave Barach39d69112019-11-27 11:42:13 -0500250 api_main_t *am = vlibapi_get_main ();
Dave Barach5c6c4bf2017-04-11 13:12:48 -0400251
Nathan Skrzypczak0aa40132019-11-25 16:29:38 +0100252 oldheap = vl_msg_push_heap ();
Florin Corase86a8ed2018-01-05 03:20:25 -0800253 svm_queue_free (am->vl_input_queue);
Nathan Skrzypczak0aa40132019-11-25 16:29:38 +0100254 vl_msg_pop_heap (oldheap);
Dave Barach5c6c4bf2017-04-11 13:12:48 -0400255
256 am->my_client_index = ~0;
257 am->my_registration = 0;
258 am->vl_input_queue = 0;
259}
260
Florin Coras940f78f2018-11-30 12:11:20 -0800261void
Florin Coraseaec2a62018-12-04 16:34:05 -0800262vl_client_send_disconnect (u8 do_cleanup)
Dave Barach5c6c4bf2017-04-11 13:12:48 -0400263{
264 vl_api_memclnt_delete_t *mp;
Dave Barach5c6c4bf2017-04-11 13:12:48 -0400265 vl_shmem_hdr_t *shmem_hdr;
Dave Barach39d69112019-11-27 11:42:13 -0500266 api_main_t *am = vlibapi_get_main ();
Dave Barach5c6c4bf2017-04-11 13:12:48 -0400267
268 ASSERT (am->vlib_rp);
269 shmem_hdr = am->shmem_hdr;
270 ASSERT (shmem_hdr && shmem_hdr->vl_input_queue);
271
Dave Barach5c6c4bf2017-04-11 13:12:48 -0400272 mp = vl_msg_api_alloc (sizeof (vl_api_memclnt_delete_t));
Dave Barachb7b92992018-10-17 10:38:51 -0400273 clib_memset (mp, 0, sizeof (*mp));
Dave Barach5c6c4bf2017-04-11 13:12:48 -0400274 mp->_vl_msg_id = ntohs (VL_API_MEMCLNT_DELETE);
275 mp->index = am->my_client_index;
276 mp->handle = (uword) am->my_registration;
Florin Coraseaec2a62018-12-04 16:34:05 -0800277 mp->do_cleanup = do_cleanup;
Dave Barach5c6c4bf2017-04-11 13:12:48 -0400278
279 vl_msg_api_send_shmem (shmem_hdr->vl_input_queue, (u8 *) & mp);
Florin Coras940f78f2018-11-30 12:11:20 -0800280}
281
282int
283vl_client_disconnect (void)
284{
285 vl_api_memclnt_delete_reply_t *rp;
286 svm_queue_t *vl_input_queue;
Dave Barach39d69112019-11-27 11:42:13 -0500287 api_main_t *am = vlibapi_get_main ();
Florin Coras940f78f2018-11-30 12:11:20 -0800288 time_t begin;
Klement Sekera9b7e8ac2021-11-22 21:26:20 +0100289 msgbuf_t *msgbuf;
Florin Coras940f78f2018-11-30 12:11:20 -0800290
291 vl_input_queue = am->vl_input_queue;
Florin Coraseaec2a62018-12-04 16:34:05 -0800292 vl_client_send_disconnect (0 /* wait for reply */ );
Dave Barach5c6c4bf2017-04-11 13:12:48 -0400293
294 /*
295 * Have to be careful here, in case the client is disconnecting
296 * because e.g. the vlib process died, or is unresponsive.
297 */
Dave Barach5c6c4bf2017-04-11 13:12:48 -0400298 begin = time (0);
299 while (1)
300 {
301 time_t now;
302
303 now = time (0);
304
305 if (now >= (begin + 2))
306 {
307 clib_warning ("peer unresponsive, give up");
308 am->my_client_index = ~0;
309 am->my_registration = 0;
310 am->shmem_hdr = 0;
Florin Corasd6c30d92018-01-29 05:11:24 -0800311 return -1;
Dave Barach5c6c4bf2017-04-11 13:12:48 -0400312 }
Mohsin Kazmi3fca5672018-01-04 18:57:26 +0100313 if (svm_queue_sub (vl_input_queue, (u8 *) & rp, SVM_Q_NOWAIT, 0) < 0)
Dave Barach5c6c4bf2017-04-11 13:12:48 -0400314 continue;
315
BenoƮt Ganne9fb6d402019-04-15 15:28:21 +0200316 VL_MSG_API_UNPOISON (rp);
317
Dave Barach5c6c4bf2017-04-11 13:12:48 -0400318 /* drain the queue */
319 if (ntohs (rp->_vl_msg_id) != VL_API_MEMCLNT_DELETE_REPLY)
320 {
Dave Barachcf5e8482017-10-17 11:48:29 -0400321 clib_warning ("queue drain: %d", ntohs (rp->_vl_msg_id));
Klement Sekera9b7e8ac2021-11-22 21:26:20 +0100322 msgbuf = (msgbuf_t *) ((u8 *) rp - offsetof (msgbuf_t, data));
323 vl_msg_api_handler ((void *) rp, ntohl (msgbuf->data_len));
Dave Barach5c6c4bf2017-04-11 13:12:48 -0400324 continue;
325 }
Klement Sekera9b7e8ac2021-11-22 21:26:20 +0100326 msgbuf = (msgbuf_t *) ((u8 *) rp - offsetof (msgbuf_t, data));
327 vl_msg_api_handler ((void *) rp, ntohl (msgbuf->data_len));
Dave Barach5c6c4bf2017-04-11 13:12:48 -0400328 break;
329 }
Ole Troan73710c72018-06-04 22:27:49 +0200330
331 vl_api_name_and_crc_free ();
Florin Corasd6c30d92018-01-29 05:11:24 -0800332 return 0;
Dave Barach5c6c4bf2017-04-11 13:12:48 -0400333}
334
Dave Barach59b25652017-09-10 15:04:27 -0400335/**
336 * Stave off the binary API dead client reaper
337 * Only sent to inactive clients
338 */
339static void
340vl_api_memclnt_keepalive_t_handler (vl_api_memclnt_keepalive_t * mp)
341{
342 vl_api_memclnt_keepalive_reply_t *rmp;
343 api_main_t *am;
344 vl_shmem_hdr_t *shmem_hdr;
345
Dave Barach39d69112019-11-27 11:42:13 -0500346 am = vlibapi_get_main ();
Dave Barach59b25652017-09-10 15:04:27 -0400347 shmem_hdr = am->shmem_hdr;
348
349 rmp = vl_msg_api_alloc_as_if_client (sizeof (*rmp));
Dave Barachb7b92992018-10-17 10:38:51 -0400350 clib_memset (rmp, 0, sizeof (*rmp));
Dave Barach59b25652017-09-10 15:04:27 -0400351 rmp->_vl_msg_id = ntohs (VL_API_MEMCLNT_KEEPALIVE_REPLY);
352 rmp->context = mp->context;
353 vl_msg_api_send_shmem (shmem_hdr->vl_input_queue, (u8 *) & rmp);
354}
355
Dave Barach5c6c4bf2017-04-11 13:12:48 -0400356#define foreach_api_msg \
357_(RX_THREAD_EXIT, rx_thread_exit) \
358_(MEMCLNT_CREATE_REPLY, memclnt_create_reply) \
Dave Barach59b25652017-09-10 15:04:27 -0400359_(MEMCLNT_DELETE_REPLY, memclnt_delete_reply) \
360_(MEMCLNT_KEEPALIVE, memclnt_keepalive)
Dave Barach5c6c4bf2017-04-11 13:12:48 -0400361
Dave Barach59b25652017-09-10 15:04:27 -0400362void
363vl_client_install_client_message_handlers (void)
Dave Barach5c6c4bf2017-04-11 13:12:48 -0400364{
Filip Tehlar36217e32021-07-23 08:51:10 +0000365 api_main_t *am = vlibapi_get_main ();
366#define _(N, n) \
Damjan Mariona2eb5072022-05-20 20:06:01 +0200367 vl_msg_api_config (&(vl_msg_api_msg_config_t){ \
368 .id = VL_API_##N, \
369 .name = #n, \
370 .handler = vl_api_##n##_t_handler, \
371 .endian = vl_api_##n##_t_endian, \
372 .format_fn = vl_api_##n##_t_format, \
373 .size = sizeof (vl_api_##n##_t), \
374 .traced = 0, \
375 .tojson = vl_api_##n##_t_tojson, \
376 .fromjson = vl_api_##n##_t_fromjson, \
377 .calc_size = vl_api_##n##_t_calc_size, \
378 }); \
Damjan Marioncada9eb2022-05-18 22:16:11 +0200379 am->msg_data[VL_API_##N].replay_allowed = 0;
Dave Barach5c6c4bf2017-04-11 13:12:48 -0400380 foreach_api_msg;
381#undef _
Dave Barach59b25652017-09-10 15:04:27 -0400382}
383
Dave Barach59b25652017-09-10 15:04:27 -0400384int
385vl_client_api_map (const char *region_name)
386{
387 int rv;
388
389 if ((rv = vl_map_shmem (region_name, 0 /* is_vlib */ )) < 0)
390 return rv;
391
392 vl_client_install_client_message_handlers ();
Dave Barach5c6c4bf2017-04-11 13:12:48 -0400393 return 0;
394}
395
396void
397vl_client_api_unmap (void)
398{
Florin Corasd6c30d92018-01-29 05:11:24 -0800399 vl_unmap_shmem_client ();
Dave Barach5c6c4bf2017-04-11 13:12:48 -0400400}
Ed Warnickecb9cada2015-12-08 15:45:58 -0700401
Florin Corasb384b542018-01-15 01:08:33 -0800402u8
403vl_mem_client_is_connected (void)
404{
Florin Coras64cf4592019-12-12 12:01:24 -0800405 return (my_memory_client_main->connected_to_vlib != 0);
Florin Corasb384b542018-01-15 01:08:33 -0800406}
407
Dave Barach371e4e12016-07-08 09:38:52 -0400408static int
Neale Rannse72be392017-04-26 13:59:20 -0700409connect_to_vlib_internal (const char *svm_name,
410 const char *client_name,
Dave Barach920180e2019-11-14 08:03:48 -0500411 int rx_queue_size, void *(*thread_fn) (void *),
Dave Barach39d69112019-11-27 11:42:13 -0500412 void *thread_fn_arg, int do_map)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700413{
Dave Barach371e4e12016-07-08 09:38:52 -0400414 int rv = 0;
Dave Barach39d69112019-11-27 11:42:13 -0500415 memory_client_main_t *mm = vlibapi_get_memory_client_main ();
416 api_main_t *am = vlibapi_get_main ();
Dave Barach371e4e12016-07-08 09:38:52 -0400417
Dave Barach59b25652017-09-10 15:04:27 -0400418 if (do_map && (rv = vl_client_api_map (svm_name)))
Dave Barach371e4e12016-07-08 09:38:52 -0400419 {
420 clib_warning ("vl_client_api map rv %d", rv);
421 return rv;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700422 }
Dave Barach371e4e12016-07-08 09:38:52 -0400423
Dave Barach371e4e12016-07-08 09:38:52 -0400424 if (vl_client_connect (client_name, 0 /* punt quota */ ,
425 rx_queue_size /* input queue */ ) < 0)
426 {
427 vl_client_api_unmap ();
428 return -1;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700429 }
430
Dave Barach371e4e12016-07-08 09:38:52 -0400431 /* Start the rx queue thread */
432
Dave Barach920180e2019-11-14 08:03:48 -0500433 if (thread_fn)
Dave Barach371e4e12016-07-08 09:38:52 -0400434 {
Florin Coras684fb6e2019-12-09 16:42:50 -0800435 if (thread_fn == rx_thread_fn)
436 {
437 rx_thread_fn_arg_t *arg;
Florin Coras68f58d72020-05-11 18:03:40 +0000438 arg = malloc (sizeof (*arg));
Florin Coras684fb6e2019-12-09 16:42:50 -0800439 arg->am = vlibapi_get_main ();
440 arg->mm = vlibapi_get_memory_client_main ();
441 thread_fn_arg = (void *) arg;
442 }
443
Dave Barach371e4e12016-07-08 09:38:52 -0400444 rv = pthread_create (&mm->rx_thread_handle,
Dave Barach39d69112019-11-27 11:42:13 -0500445 NULL /*attr */ , thread_fn, thread_fn_arg);
Dave Barach371e4e12016-07-08 09:38:52 -0400446 if (rv)
IJsbrand Wijnands82295802019-10-08 13:50:55 +0200447 {
448 clib_warning ("pthread_create returned %d", rv);
449 am->rx_thread_handle = 0;
450 }
451 else
452 {
453 am->rx_thread_handle = mm->rx_thread_handle;
454 }
Ed Warnickecb9cada2015-12-08 15:45:58 -0700455 }
Dave Barach371e4e12016-07-08 09:38:52 -0400456
457 mm->connected_to_vlib = 1;
458 return 0;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700459}
460
Dave Barach371e4e12016-07-08 09:38:52 -0400461int
Neale Rannse72be392017-04-26 13:59:20 -0700462vl_client_connect_to_vlib (const char *svm_name,
463 const char *client_name, int rx_queue_size)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700464{
Dave Barach371e4e12016-07-08 09:38:52 -0400465 return connect_to_vlib_internal (svm_name, client_name, rx_queue_size,
Dave Barach39d69112019-11-27 11:42:13 -0500466 rx_thread_fn, 0 /* thread fn arg */ ,
467 1 /* do map */ );
Ed Warnickecb9cada2015-12-08 15:45:58 -0700468}
469
Dave Barach371e4e12016-07-08 09:38:52 -0400470int
Neale Rannse72be392017-04-26 13:59:20 -0700471vl_client_connect_to_vlib_no_rx_pthread (const char *svm_name,
472 const char *client_name,
Dave Barach371e4e12016-07-08 09:38:52 -0400473 int rx_queue_size)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700474{
Dave Barach371e4e12016-07-08 09:38:52 -0400475 return connect_to_vlib_internal (svm_name, client_name, rx_queue_size,
Dave Barach920180e2019-11-14 08:03:48 -0500476 0 /* no rx_thread_fn */ ,
Dave Barach39d69112019-11-27 11:42:13 -0500477 0 /* no thread fn arg */ ,
Dave Barach59b25652017-09-10 15:04:27 -0400478 1 /* do map */ );
479}
480
481int
482vl_client_connect_to_vlib_no_map (const char *svm_name,
483 const char *client_name, int rx_queue_size)
484{
485 return connect_to_vlib_internal (svm_name, client_name, rx_queue_size,
Dave Barach39d69112019-11-27 11:42:13 -0500486 rx_thread_fn, 0 /* no thread fn arg */ ,
487 0 /* dont map */ );
Ed Warnickecb9cada2015-12-08 15:45:58 -0700488}
489
Tomasz Kulasek97dcf5b2019-01-31 18:26:32 +0100490int
491vl_client_connect_to_vlib_no_rx_pthread_no_map (const char *svm_name,
492 const char *client_name,
493 int rx_queue_size)
494{
495 return connect_to_vlib_internal (svm_name, client_name, rx_queue_size,
Dave Barach39d69112019-11-27 11:42:13 -0500496 0 /* no thread_fn */ ,
497 0 /* no thread fn arg */ ,
Tomasz Kulasek97dcf5b2019-01-31 18:26:32 +0100498 0 /* dont map */ );
499}
500
Dave Barach920180e2019-11-14 08:03:48 -0500501int
502vl_client_connect_to_vlib_thread_fn (const char *svm_name,
503 const char *client_name,
504 int rx_queue_size,
Dave Barach39d69112019-11-27 11:42:13 -0500505 void *(*thread_fn) (void *), void *arg)
Dave Barach920180e2019-11-14 08:03:48 -0500506{
507 return connect_to_vlib_internal (svm_name, client_name, rx_queue_size,
Dave Barach39d69112019-11-27 11:42:13 -0500508 thread_fn, arg, 1 /* do map */ );
Dave Barach920180e2019-11-14 08:03:48 -0500509}
510
Matthew Smith57f177d2022-12-15 22:18:08 +0000511void
512vl_client_stop_rx_thread (svm_queue_t *vl_input_queue)
513{
514 vl_api_rx_thread_exit_t *ep;
515 ep = vl_msg_api_alloc (sizeof (*ep));
516 ep->_vl_msg_id = ntohs (VL_API_RX_THREAD_EXIT);
517 vl_msg_api_send_shmem (vl_input_queue, (u8 *) &ep);
518}
Dave Barach920180e2019-11-14 08:03:48 -0500519
Florin Corasb384b542018-01-15 01:08:33 -0800520static void
521disconnect_from_vlib_internal (u8 do_unmap)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700522{
Dave Barach39d69112019-11-27 11:42:13 -0500523 memory_client_main_t *mm = vlibapi_get_memory_client_main ();
524 api_main_t *am = vlibapi_get_main ();
Dave Barach371e4e12016-07-08 09:38:52 -0400525 uword junk;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700526
Dave Barach371e4e12016-07-08 09:38:52 -0400527 if (mm->rx_thread_jmpbuf_valid)
528 {
Matthew Smith57f177d2022-12-15 22:18:08 +0000529 vl_client_stop_rx_thread (am->vl_input_queue);
Dave Barach371e4e12016-07-08 09:38:52 -0400530 pthread_join (mm->rx_thread_handle, (void **) &junk);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700531 }
Dave Barach371e4e12016-07-08 09:38:52 -0400532 if (mm->connected_to_vlib)
533 {
534 vl_client_disconnect ();
Florin Corasb384b542018-01-15 01:08:33 -0800535 if (do_unmap)
536 vl_client_api_unmap ();
Ed Warnickecb9cada2015-12-08 15:45:58 -0700537 }
Dave Barachb7b92992018-10-17 10:38:51 -0400538 clib_memset (mm, 0, sizeof (*mm));
Ed Warnickecb9cada2015-12-08 15:45:58 -0700539}
540
Florin Corasb384b542018-01-15 01:08:33 -0800541void
542vl_client_disconnect_from_vlib (void)
543{
544 disconnect_from_vlib_internal (1);
545}
546
547void
548vl_client_disconnect_from_vlib_no_unmap (void)
549{
550 disconnect_from_vlib_internal (0);
551}
552
Ed Warnickecb9cada2015-12-08 15:45:58 -0700553static void vl_api_get_first_msg_id_reply_t_handler
Dave Barach371e4e12016-07-08 09:38:52 -0400554 (vl_api_get_first_msg_id_reply_t * mp)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700555{
Dave Barach39d69112019-11-27 11:42:13 -0500556 memory_client_main_t *mm = vlibapi_get_memory_client_main ();
Dave Barach371e4e12016-07-08 09:38:52 -0400557 i32 retval = ntohl (mp->retval);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700558
Dave Barach371e4e12016-07-08 09:38:52 -0400559 mm->first_msg_id_reply = (retval >= 0) ? ntohs (mp->first_msg_id) : ~0;
560 mm->first_msg_id_reply_ready = 1;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700561}
562
Dave Barach371e4e12016-07-08 09:38:52 -0400563u16
Neale Rannse72be392017-04-26 13:59:20 -0700564vl_client_get_first_plugin_msg_id (const char *plugin_name)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700565{
Dave Barach371e4e12016-07-08 09:38:52 -0400566 vl_api_get_first_msg_id_t *mp;
Dave Barach39d69112019-11-27 11:42:13 -0500567 api_main_t *am = vlibapi_get_main ();
568 memory_client_main_t *mm = vlibapi_get_memory_client_main ();
Damjan Marioncada9eb2022-05-18 22:16:11 +0200569 vl_api_msg_data_t *m =
570 vl_api_get_msg_data (am, VL_API_GET_FIRST_MSG_ID_REPLY);
Dave Barach371e4e12016-07-08 09:38:52 -0400571 f64 timeout;
572 void *old_handler;
573 clib_time_t clib_time;
574 u16 rv = ~0;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700575
Ole Troan7adaa222019-08-27 15:05:27 +0200576 if (strlen (plugin_name) + 1 > sizeof (mp->name))
Dave Barach371e4e12016-07-08 09:38:52 -0400577 return (rv);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700578
Dave Barachb7b92992018-10-17 10:38:51 -0400579 clib_memset (&clib_time, 0, sizeof (clib_time));
Dave Barach371e4e12016-07-08 09:38:52 -0400580 clib_time_init (&clib_time);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700581
Dave Barach371e4e12016-07-08 09:38:52 -0400582 /* Push this plugin's first_msg_id_reply handler */
Damjan Marioncada9eb2022-05-18 22:16:11 +0200583 old_handler = m->handler;
584 m->handler = (void *) vl_api_get_first_msg_id_reply_t_handler;
585 if (!m->calc_size_func)
Klement Sekera9b7e8ac2021-11-22 21:26:20 +0100586 {
Damjan Marioncada9eb2022-05-18 22:16:11 +0200587 m->calc_size_func =
Klement Sekera9b7e8ac2021-11-22 21:26:20 +0100588 (uword (*) (void *)) vl_api_get_first_msg_id_reply_t_calc_size;
589 }
Ed Warnickecb9cada2015-12-08 15:45:58 -0700590
Dave Barach371e4e12016-07-08 09:38:52 -0400591 /* Ask the data-plane for the message-ID base of the indicated plugin */
592 mm->first_msg_id_reply_ready = 0;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700593
Florin Coras6d1caf92018-01-04 12:17:10 -0800594 /* Not using shm client */
595 if (!am->my_registration)
Dave Barach371e4e12016-07-08 09:38:52 -0400596 {
Florin Coras6d1caf92018-01-04 12:17:10 -0800597 mp = vl_socket_client_msg_alloc (sizeof (*mp));
Dave Barachb7b92992018-10-17 10:38:51 -0400598 clib_memset (mp, 0, sizeof (*mp));
Florin Coras6d1caf92018-01-04 12:17:10 -0800599 mp->_vl_msg_id = ntohs (VL_API_GET_FIRST_MSG_ID);
600 mp->client_index = am->my_client_index;
Ole Troan7adaa222019-08-27 15:05:27 +0200601 strncpy ((char *) mp->name, plugin_name, sizeof (mp->name) - 1);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700602
Florin Coras6d1caf92018-01-04 12:17:10 -0800603 if (vl_socket_client_write () <= 0)
604 goto sock_err;
605 if (vl_socket_client_read (1))
606 goto sock_err;
607
608 if (mm->first_msg_id_reply_ready == 1)
609 {
610 rv = mm->first_msg_id_reply;
611 goto result;
612 }
613
614 sock_err:
615 /* Restore old handler */
Damjan Marioncada9eb2022-05-18 22:16:11 +0200616 m->handler = old_handler;
Florin Coras6d1caf92018-01-04 12:17:10 -0800617
618 return -1;
619 }
620 else
621 {
622 mp = vl_msg_api_alloc (sizeof (*mp));
Dave Barachb7b92992018-10-17 10:38:51 -0400623 clib_memset (mp, 0, sizeof (*mp));
Florin Coras6d1caf92018-01-04 12:17:10 -0800624 mp->_vl_msg_id = ntohs (VL_API_GET_FIRST_MSG_ID);
625 mp->client_index = am->my_client_index;
Ole Troan7adaa222019-08-27 15:05:27 +0200626 strncpy ((char *) mp->name, plugin_name, sizeof (mp->name) - 1);
Florin Coras6d1caf92018-01-04 12:17:10 -0800627
628 vl_msg_api_send_shmem (am->shmem_hdr->vl_input_queue, (u8 *) & mp);
629
630 /* Synchronously wait for the answer */
631 timeout = clib_time_now (&clib_time) + 1.0;
Dave Barach371e4e12016-07-08 09:38:52 -0400632 while (clib_time_now (&clib_time) < timeout)
633 {
634 if (mm->first_msg_id_reply_ready == 1)
635 {
636 rv = mm->first_msg_id_reply;
637 goto result;
638 }
639 }
640 /* Restore old handler */
Damjan Marioncada9eb2022-05-18 22:16:11 +0200641 m->handler = old_handler;
Dave Barach371e4e12016-07-08 09:38:52 -0400642
643 return rv;
644 }
Ed Warnickecb9cada2015-12-08 15:45:58 -0700645
646result:
647
Dave Barach371e4e12016-07-08 09:38:52 -0400648 /* Restore the old handler */
Damjan Marioncada9eb2022-05-18 22:16:11 +0200649 m->handler = old_handler;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700650
Dave Barach371e4e12016-07-08 09:38:52 -0400651 if (rv == (u16) ~ 0)
652 clib_warning ("plugin '%s' not registered", plugin_name);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700653
Dave Barach371e4e12016-07-08 09:38:52 -0400654 return rv;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700655}
Dave Barach6931f592016-05-13 12:55:01 -0400656
Dave Barach371e4e12016-07-08 09:38:52 -0400657/*
658 * fd.io coding-style-patch-verification: ON
659 *
660 * Local Variables:
661 * eval: (c-set-style "gnu")
662 * End:
663 */