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:
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 SRC_VLIBMEMORY_MEMORY_API_H_
19 #define SRC_VLIBMEMORY_MEMORY_API_H_
23 #include <svm/queue.h>
24 #include <vlib/vlib.h>
25 #include <vlibapi/api.h>
26 #include <vlibmemory/memory_shared.h>
28 svm_queue_t *vl_api_client_index_to_input_queue (u32 index);
29 int vl_mem_api_init (const char *region_name);
30 void vl_mem_api_dead_client_scan (api_main_t * am, vl_shmem_hdr_t * shm,
32 int vl_mem_api_handle_msg_main (vlib_main_t * vm, vlib_node_runtime_t * node);
33 int vl_mem_api_handle_msg_private (vlib_main_t * vm,
34 vlib_node_runtime_t * node, u32 reg_index);
35 vl_api_registration_t *vl_mem_api_client_index_to_registration (u32 handle);
36 void vl_mem_api_enable_disable (vlib_main_t * vm, int yesno);
37 u32 vl_api_memclnt_create_internal (char *, svm_queue_t *);
40 vl_msg_api_handle_get_epoch (u32 index)
42 return (index & VL_API_EPOCH_MASK);
46 vl_msg_api_handle_get_index (u32 index)
48 return (index >> VL_API_EPOCH_SHIFT);
52 vl_msg_api_handle_from_index_and_epoch (u32 index, u32 epoch)
55 ASSERT (index < 0x00FFFFFF);
57 handle = (index << VL_API_EPOCH_SHIFT) | (epoch & VL_API_EPOCH_MASK);
62 vl_msg_api_handle_is_valid (u32 handle, u32 restarts)
64 u32 epoch = vl_msg_api_handle_get_epoch (handle);
65 return ((restarts & VL_API_EPOCH_MASK) == epoch);
68 #define VL_MEM_API_LOG_Q_LEN(fmt,qlen) \
69 if (TRACE_VLIB_MEMORY_QUEUE) \
71 ELOG_TYPE_DECLARE (e) = { \
73 .format_args = "i4", \
75 struct { u32 len; } *ed; \
76 ed = ELOG_DATA (&vm->elog_main, e); \
80 #endif /* SRC_VLIBMEMORY_MEMORY_API_H_ */
83 * fd.io coding-style-patch-verification: ON
86 * eval: (c-set-style "gnu")