1/*
2 *------------------------------------------------------------------
3 * Copyright (c) 2017 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 VAPI_INTERNAL_H
19#define VAPI_INTERNAL_H
20
21#include <endian.h>
22#include <string.h>
23#include <vppinfra/types.h>
24
25/**
26 * @file vapi_internal.h
27 *
28 * internal vpp api C declarations
29 *
30 * This file contains internal vpp api C declarations. It's not intended to be
31 * used by the client programmer and the API defined here might change at any
32 * time..
33 */
34
35#ifdef __cplusplus
36extern "C" {
37#endif
38
39struct vapi_ctx_s;
40
41typedef struct __attribute__ ((__packed__))
42{
43  u16 _vl_msg_id;
44  u32 context;
45} vapi_type_msg_header1_t;
46
47typedef struct __attribute__ ((__packed__))
48{
49  u16 _vl_msg_id;
50  u32 client_index;
51  u32 context;
52} vapi_type_msg_header2_t;
53
54static inline void
55vapi_type_msg_header1_t_hton (vapi_type_msg_header1_t * h)
56{
57  h->_vl_msg_id = htobe16 (h->_vl_msg_id);
58}
59
60static inline void
61vapi_type_msg_header1_t_ntoh (vapi_type_msg_header1_t * h)
62{
63  h->_vl_msg_id = be16toh (h->_vl_msg_id);
64}
65
66static inline void
67vapi_type_msg_header2_t_hton (vapi_type_msg_header2_t * h)
68{
69  h->_vl_msg_id = htobe16 (h->_vl_msg_id);
70}
71
72static inline void
73vapi_type_msg_header2_t_ntoh (vapi_type_msg_header2_t * h)
74{
75  h->_vl_msg_id = be16toh (h->_vl_msg_id);
76}
77
78
79#include <vapi/vapi.h>
80
81typedef vapi_error_e (*vapi_cb_t) (struct vapi_ctx_s *, void *, vapi_error_e,
82				   bool, void *);
83
84typedef void (*generic_swap_fn_t) (void *payload);
85
86typedef struct
87{
88  const char *name;
89  size_t name_len;
90  const char *name_with_crc;
91  size_t name_with_crc_len;
92  bool has_context;
93  unsigned int context_offset;
94  unsigned int payload_offset;
95  size_t size;
96  generic_swap_fn_t swap_to_be;
97  generic_swap_fn_t swap_to_host;
98  vapi_msg_id_t id;		/* assigned at run-time */
99} vapi_message_desc_t;
100
101typedef struct
102{
103  const char *name;
104  int payload_offset;
105  size_t size;
106  void (*swap_to_be) (void *payload);
107  void (*swap_to_host) (void *payload);
108} vapi_event_desc_t;
109
110vapi_msg_id_t vapi_register_msg (vapi_message_desc_t * msg);
111u16 vapi_lookup_vl_msg_id (vapi_ctx_t ctx, vapi_msg_id_t id);
112vapi_msg_id_t vapi_lookup_vapi_msg_id_t (vapi_ctx_t ctx, u16 vl_msg_id);
113int vapi_get_client_index (vapi_ctx_t ctx);
114bool vapi_is_nonblocking (vapi_ctx_t ctx);
115bool vapi_requests_empty (vapi_ctx_t ctx);
116bool vapi_requests_full (vapi_ctx_t ctx);
117size_t vapi_get_request_count (vapi_ctx_t ctx);
118size_t vapi_get_max_request_count (vapi_ctx_t ctx);
119u32 vapi_gen_req_context (vapi_ctx_t ctx);
120void vapi_store_request (vapi_ctx_t ctx, u32 context, bool is_dump,
121			 vapi_cb_t callback, void *callback_ctx);
122int vapi_get_payload_offset (vapi_msg_id_t id);
123void (*vapi_get_swap_to_host_func (vapi_msg_id_t id)) (void *payload);
124void (*vapi_get_swap_to_be_func (vapi_msg_id_t id)) (void *payload);
125size_t vapi_get_message_size (vapi_msg_id_t id);
126size_t vapi_get_context_offset (vapi_msg_id_t id);
127bool vapi_msg_is_with_context (vapi_msg_id_t id);
128size_t vapi_get_message_count();
129const char *vapi_get_msg_name(vapi_msg_id_t id);
130
131vapi_error_e vapi_producer_lock (vapi_ctx_t ctx);
132vapi_error_e vapi_producer_unlock (vapi_ctx_t ctx);
133
134#ifdef __cplusplus
135}
136#endif
137
138#endif
139