2 *------------------------------------------------------------------
3 * Copyright (c) 2009 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:
8 * http://www.apache.org/licenses/LICENSE-2.0
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 *------------------------------------------------------------------
18 #ifndef included_vlibmemory_api_common_h
19 #define included_vlibmemory_api_common_h
21 #include <svm/svm_common.h>
22 #include <vlibapi/api.h>
23 #include <vlibmemory/memory_api.h>
24 #include <vlibmemory/memory_client.h>
25 #include <vlibmemory/socket_api.h>
26 #include <vlibmemory/socket_client.h>
28 void vl_api_rpc_call_main_thread (void *fp, u8 * data, u32 data_length);
29 void vl_api_force_rpc_call_main_thread (void *fp, u8 * data, u32 data_length);
30 u16 vl_client_get_first_plugin_msg_id (const char *plugin_name);
31 void vl_api_send_pending_rpc_requests (vlib_main_t * vm);
32 u8 *vl_api_serialize_message_table (api_main_t * am, u8 * vector);
35 vl_api_send_msg (vl_api_registration_t * rp, u8 * elem)
37 if (PREDICT_FALSE (rp->registration_type > REGISTRATION_TYPE_SHMEM))
39 vl_socket_api_send (rp, elem);
43 vl_msg_api_send_shmem (rp->vl_input_queue, (u8 *) & elem);
48 vl_api_can_send_msg (vl_api_registration_t * rp)
50 if (PREDICT_FALSE (rp->registration_type > REGISTRATION_TYPE_SHMEM))
53 return vl_mem_api_can_send (rp->vl_input_queue);
56 always_inline vl_api_registration_t *
57 vl_api_client_index_to_registration (u32 index)
59 if (vl_socket_api_registration_handle_is_valid (ntohl (index)))
60 return vl_socket_api_client_handle_to_registration (ntohl (index));
61 return vl_mem_api_client_index_to_registration (index);
65 vl_api_registration_file_index (vl_api_registration_t * reg)
67 return reg->clib_file_index;
70 always_inline clib_file_t *
71 vl_api_registration_file (vl_api_registration_t * reg)
73 return clib_file_get (&file_main, vl_api_registration_file_index (reg));
77 vl_api_registration_del_file (vl_api_registration_t * reg)
79 clib_file_t *cf = vl_api_registration_file (reg);
81 clib_file_del (&file_main, cf);
84 always_inline clib_error_t *
85 vl_api_send_fd_msg (vl_api_registration_t * reg, int fds[], int n_fds)
87 clib_file_t *cf = vl_api_registration_file (reg);
89 return vl_sock_api_send_fd_msg (cf->file_descriptor, fds, n_fds);
93 always_inline clib_error_t *
94 vl_api_recv_fd_msg (vl_api_registration_t * reg, int fds[], int n_fds,
97 clib_file_t *cf = vl_api_registration_file (reg);
99 return vl_sock_api_recv_fd_msg (cf->file_descriptor, fds, n_fds, wait);
104 * vl_api_clnt process data used by transports (socket api in particular)
106 extern vlib_node_registration_t vl_api_clnt_node;
107 extern volatile int **vl_api_queue_cursizes;
109 typedef enum vl_api_clnt_process_events
111 QUEUE_SIGNAL_EVENT = 1,
113 } vl_api_clnt_process_events_t;
115 #define foreach_histogram_bucket \
123 #define _(n) SLEEP_##n##_US,
124 foreach_histogram_bucket
129 extern u64 vector_rate_histogram[];
132 * sockclnt APIs XXX are these actually used anywhere?
134 vl_api_registration_t *sockclnt_get_registration (u32 index);
135 void socksvr_add_pending_output (struct clib_file *uf,
136 struct vl_api_registration_ *cf,
137 u8 * buffer, uword buffer_bytes);
138 void vl_socket_process_msg (struct clib_file *uf,
139 struct vl_api_registration_ *rp, i8 * input_v);
140 u32 sockclnt_open_index (char *client_name, char *hostname, int port);
141 void sockclnt_close_index (u32 index);
142 void vl_client_msg_api_send (vl_api_registration_t * cm, u8 * elem);
144 #endif /* included_vlibmemory_api_common_h */
147 * fd.io coding-style-patch-verification: ON
150 * eval: (c-set-style "gnu")