memory_client.h revision 684fb6e9
1/*
2 *------------------------------------------------------------------
3 * Copyright (c) 2018 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:
7 *
8 *     http://www.apache.org/licenses/LICENSE-2.0
9 *
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 *------------------------------------------------------------------
16 */
17
18#ifndef SRC_VLIBMEMORY_MEMORY_CLIENT_H_
19#define SRC_VLIBMEMORY_MEMORY_CLIENT_H_
20
21#include <vlibmemory/memory_shared.h>
22#include <setjmp.h>
23
24/*
25 * Exported so folks can code a working custom rx_pthread function
26 */
27typedef struct
28{
29  u8 rx_thread_jmpbuf_valid;
30  u8 connected_to_vlib;
31  jmp_buf rx_thread_jmpbuf;
32  pthread_t rx_thread_handle;
33  /* Plugin message base lookup scheme */
34  volatile u8 first_msg_id_reply_ready;
35  u16 first_msg_id_reply;
36} memory_client_main_t;
37
38extern memory_client_main_t memory_client_main;
39extern __thread memory_client_main_t *my_memory_client_main;
40
41int vl_client_connect (const char *name, int ctx_quota, int input_queue_size);
42void vl_client_send_disconnect (u8 do_cleanup);
43int vl_client_disconnect (void);
44int vl_client_api_map (const char *region_name);
45void vl_client_api_unmap (void);
46void vl_client_disconnect_from_vlib (void);
47void vl_client_disconnect_from_vlib_no_unmap (void);
48int vl_client_connect_to_vlib (const char *svm_name, const char *client_name,
49			       int rx_queue_size);
50int vl_client_connect_to_vlib_thread_fn (const char *svm_name,
51					 const char *client_name,
52					 int rx_queue_size,
53					 void *(*)(void *), void *);
54int vl_client_connect_to_vlib_no_rx_pthread (const char *svm_name,
55					     const char *client_name,
56					     int rx_queue_size);
57int vl_client_connect_to_vlib_no_map (const char *svm_name,
58				      const char *client_name,
59				      int rx_queue_size);
60int vl_client_connect_to_vlib_no_rx_pthread_no_map (const char *svm_name,
61						    const char *client_name,
62						    int rx_queue_size);
63void vl_client_install_client_message_handlers (void);
64u8 vl_mem_client_is_connected (void);
65
66always_inline memory_client_main_t *
67vlibapi_get_memory_client_main (void)
68{
69  ASSERT (my_memory_client_main);
70  return my_memory_client_main;
71}
72
73always_inline void
74vlibapi_set_memory_client_main (memory_client_main_t * mm)
75{
76  my_memory_client_main = mm;
77}
78
79#endif /* SRC_VLIBMEMORY_MEMORY_CLIENT_H_ */
80
81/*
82 * fd.io coding-style-patch-verification: ON
83 *
84 * Local Variables:
85 * eval: (c-set-style "gnu")
86 * End:
87 */
88