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_API_H_
19#define SRC_VLIBMEMORY_MEMORY_API_H_
20
21#include <svm/svm.h>
22#include <svm/ssvm.h>
23#include <svm/queue.h>
24#include <vlib/vlib.h>
25#include <vlibapi/api.h>
26#include <vlibmemory/memory_shared.h>
27
28svm_queue_t *vl_api_client_index_to_input_queue (u32 index);
29int vl_mem_api_init (const char *region_name);
30void vl_mem_api_dead_client_scan (api_main_t * am, vl_shmem_hdr_t * shm,
31				  f64 now);
32int vl_mem_api_handle_msg_main (vlib_main_t * vm, vlib_node_runtime_t * node);
33int vl_mem_api_handle_msg_private (vlib_main_t * vm,
34				   vlib_node_runtime_t * node, u32 reg_index);
35int vl_mem_api_handle_rpc (vlib_main_t * vm, vlib_node_runtime_t * node);
36
37vl_api_registration_t *vl_mem_api_client_index_to_registration (u32 handle);
38void vl_mem_api_enable_disable (vlib_main_t * vm, int yesno);
39u32 vl_api_memclnt_create_internal (char *, svm_queue_t *);
40
41static inline u32
42vl_msg_api_handle_get_epoch (u32 index)
43{
44  return (index & VL_API_EPOCH_MASK);
45}
46
47static inline u32
48vl_msg_api_handle_get_index (u32 index)
49{
50  return (index >> VL_API_EPOCH_SHIFT);
51}
52
53static inline u32
54vl_msg_api_handle_from_index_and_epoch (u32 index, u32 epoch)
55{
56  u32 handle;
57  ASSERT (index < 0x00FFFFFF);
58
59  handle = (index << VL_API_EPOCH_SHIFT) | (epoch & VL_API_EPOCH_MASK);
60  return handle;
61}
62
63static inline u8
64vl_msg_api_handle_is_valid (u32 handle, u32 restarts)
65{
66  u32 epoch = vl_msg_api_handle_get_epoch (handle);
67  return ((restarts & VL_API_EPOCH_MASK) == epoch);
68}
69
70#define VL_MEM_API_LOG_Q_LEN(fmt,qlen)			\
71if (TRACE_VLIB_MEMORY_QUEUE)				\
72  do {							\
73      ELOG_TYPE_DECLARE (e) = {				\
74        .format = fmt,					\
75        .format_args = "i4",				\
76      };							\
77      struct { u32 len; } *ed;				\
78      ed = ELOG_DATA (&vm->elog_main, e);		\
79      ed->len = qlen;					\
80  } while (0)
81
82#endif /* SRC_VLIBMEMORY_MEMORY_API_H_ */
83
84/*
85 * fd.io coding-style-patch-verification: ON
86 *
87 * Local Variables:
88 * eval: (c-set-style "gnu")
89 * End:
90 */
91