Klement Sekera | 58eb866 | 2017-06-09 06:06:49 +0200 | [diff] [blame] | 1 | /* |
| 2 | *------------------------------------------------------------------ |
| 3 | * api_common.h |
| 4 | * |
| 5 | * Copyright (c) 2009-2015 Cisco and/or its affiliates. |
| 6 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 7 | * you may not use this file except in compliance with the License. |
| 8 | * You may obtain a copy of the License at: |
| 9 | * |
| 10 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 11 | * |
| 12 | * Unless required by applicable law or agreed to in writing, software |
| 13 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 14 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 15 | * See the License for the specific language governing permissions and |
| 16 | * limitations under the License. |
| 17 | *------------------------------------------------------------------ |
| 18 | */ |
| 19 | |
| 20 | #ifndef included_api_common_h |
| 21 | #define included_api_common_h |
| 22 | |
Dave Barach | 905c14a | 2017-09-25 08:47:59 -0400 | [diff] [blame] | 23 | /** \file API common definitions |
| 24 | * See api_doc.md for more info |
| 25 | */ |
| 26 | |
Klement Sekera | 58eb866 | 2017-06-09 06:06:49 +0200 | [diff] [blame] | 27 | #include <vppinfra/clib_error.h> |
Dave Barach | b09f4d0 | 2019-07-15 16:00:03 -0400 | [diff] [blame] | 28 | #include <vppinfra/elog.h> |
Ole Troan | 413f4a5 | 2018-11-28 11:36:05 +0100 | [diff] [blame] | 29 | #include <vlibapi/api_types.h> |
Klement Sekera | 58eb866 | 2017-06-09 06:06:49 +0200 | [diff] [blame] | 30 | #include <svm/svm_common.h> |
Florin Coras | e86a8ed | 2018-01-05 03:20:25 -0800 | [diff] [blame] | 31 | #include <svm/queue.h> |
Klement Sekera | 58eb866 | 2017-06-09 06:06:49 +0200 | [diff] [blame] | 32 | |
Dave Barach | 905c14a | 2017-09-25 08:47:59 -0400 | [diff] [blame] | 33 | /** API registration types |
| 34 | */ |
Klement Sekera | 58eb866 | 2017-06-09 06:06:49 +0200 | [diff] [blame] | 35 | typedef enum |
| 36 | { |
| 37 | REGISTRATION_TYPE_FREE = 0, |
Dave Barach | 905c14a | 2017-09-25 08:47:59 -0400 | [diff] [blame] | 38 | REGISTRATION_TYPE_SHMEM, /**< Shared memory connection */ |
| 39 | REGISTRATION_TYPE_SOCKET_LISTEN, /**< Socket listener */ |
| 40 | REGISTRATION_TYPE_SOCKET_SERVER, /**< Socket server */ |
| 41 | REGISTRATION_TYPE_SOCKET_CLIENT, /**< Socket client */ |
Klement Sekera | 58eb866 | 2017-06-09 06:06:49 +0200 | [diff] [blame] | 42 | } vl_registration_type_t; |
| 43 | |
Dave Barach | 905c14a | 2017-09-25 08:47:59 -0400 | [diff] [blame] | 44 | /** An API client registration, only in vpp/vlib */ |
| 45 | |
Klement Sekera | 58eb866 | 2017-06-09 06:06:49 +0200 | [diff] [blame] | 46 | typedef struct vl_api_registration_ |
| 47 | { |
Dave Barach | 905c14a | 2017-09-25 08:47:59 -0400 | [diff] [blame] | 48 | vl_registration_type_t registration_type; /**< type */ |
Klement Sekera | 58eb866 | 2017-06-09 06:06:49 +0200 | [diff] [blame] | 49 | |
Dave Barach | 905c14a | 2017-09-25 08:47:59 -0400 | [diff] [blame] | 50 | /** Index in VLIB's brain (not shared memory). */ |
Klement Sekera | 58eb866 | 2017-06-09 06:06:49 +0200 | [diff] [blame] | 51 | u32 vl_api_registration_pool_index; |
| 52 | |
Dave Barach | 905c14a | 2017-09-25 08:47:59 -0400 | [diff] [blame] | 53 | u8 *name; /**< Client name */ |
Klement Sekera | 58eb866 | 2017-06-09 06:06:49 +0200 | [diff] [blame] | 54 | |
Dave Barach | 59b2565 | 2017-09-10 15:04:27 -0400 | [diff] [blame] | 55 | /* Zombie apocalypse checking */ |
| 56 | f64 last_heard; |
| 57 | int last_queue_head; |
| 58 | int unanswered_pings; |
| 59 | |
Dave Barach | 905c14a | 2017-09-25 08:47:59 -0400 | [diff] [blame] | 60 | /** shared memory only: pointer to client input queue */ |
Florin Coras | e86a8ed | 2018-01-05 03:20:25 -0800 | [diff] [blame] | 61 | svm_queue_t *vl_input_queue; |
Dave Barach | 59b2565 | 2017-09-10 15:04:27 -0400 | [diff] [blame] | 62 | svm_region_t *vlib_rp; |
| 63 | void *shmem_hdr; |
Klement Sekera | 58eb866 | 2017-06-09 06:06:49 +0200 | [diff] [blame] | 64 | |
| 65 | /* socket server and client */ |
Dave Barach | 905c14a | 2017-09-25 08:47:59 -0400 | [diff] [blame] | 66 | u32 clib_file_index; /**< Socket only: file index */ |
| 67 | i8 *unprocessed_input; /**< Socket only: pending input */ |
| 68 | u32 unprocessed_msg_length; /**< Socket only: unprocssed length */ |
Ole Troan | 94495f2 | 2018-08-02 11:58:12 +0200 | [diff] [blame] | 69 | u8 *output_vector; /**< Socket only: output vector */ |
Dave Barach | 59b2565 | 2017-09-10 15:04:27 -0400 | [diff] [blame] | 70 | int *additional_fds_to_close; |
Klement Sekera | 58eb866 | 2017-06-09 06:06:49 +0200 | [diff] [blame] | 71 | |
| 72 | /* socket client only */ |
Dave Barach | 905c14a | 2017-09-25 08:47:59 -0400 | [diff] [blame] | 73 | u32 server_handle; /**< Socket client only: server handle */ |
| 74 | u32 server_index; /**< Socket client only: server index */ |
Klement Sekera | 58eb866 | 2017-06-09 06:06:49 +0200 | [diff] [blame] | 75 | } vl_api_registration_t; |
| 76 | |
Florin Coras | b384b54 | 2018-01-15 01:08:33 -0800 | [diff] [blame] | 77 | #define VL_API_INVALID_FI ((u32)~0) |
Klement Sekera | 58eb866 | 2017-06-09 06:06:49 +0200 | [diff] [blame] | 78 | |
Dave Barach | 905c14a | 2017-09-25 08:47:59 -0400 | [diff] [blame] | 79 | /** Trace configuration for a single message */ |
Klement Sekera | 58eb866 | 2017-06-09 06:06:49 +0200 | [diff] [blame] | 80 | typedef struct |
| 81 | { |
Dave Barach | 905c14a | 2017-09-25 08:47:59 -0400 | [diff] [blame] | 82 | int size; /**< for sanity checking */ |
| 83 | int trace_enable; /**< trace this message */ |
| 84 | int replay_enable; /**< This message can be replayed */ |
Klement Sekera | 58eb866 | 2017-06-09 06:06:49 +0200 | [diff] [blame] | 85 | } trace_cfg_t; |
| 86 | |
Dave Barach | 905c14a | 2017-09-25 08:47:59 -0400 | [diff] [blame] | 87 | /** |
| 88 | * API trace state |
Klement Sekera | 58eb866 | 2017-06-09 06:06:49 +0200 | [diff] [blame] | 89 | */ |
| 90 | typedef struct |
| 91 | { |
Dave Barach | 905c14a | 2017-09-25 08:47:59 -0400 | [diff] [blame] | 92 | u8 endian; /**< trace endianness */ |
| 93 | u8 enabled; /**< trace is enabled */ |
| 94 | u8 wrapped; /**< trace has wrapped */ |
Klement Sekera | 58eb866 | 2017-06-09 06:06:49 +0200 | [diff] [blame] | 95 | u8 pad; |
Dave Barach | 905c14a | 2017-09-25 08:47:59 -0400 | [diff] [blame] | 96 | u32 nitems; /**< Number of trace records */ |
| 97 | u32 curindex; /**< Current index in circular buffer */ |
| 98 | u8 **traces; /**< Trace ring */ |
Klement Sekera | 58eb866 | 2017-06-09 06:06:49 +0200 | [diff] [blame] | 99 | } vl_api_trace_t; |
| 100 | |
Dave Barach | 905c14a | 2017-09-25 08:47:59 -0400 | [diff] [blame] | 101 | /** Trace RX / TX enum */ |
Klement Sekera | 58eb866 | 2017-06-09 06:06:49 +0200 | [diff] [blame] | 102 | typedef enum |
| 103 | { |
| 104 | VL_API_TRACE_TX, |
| 105 | VL_API_TRACE_RX, |
| 106 | } vl_api_trace_which_t; |
| 107 | |
| 108 | #define VL_API_LITTLE_ENDIAN 0x00 |
| 109 | #define VL_API_BIG_ENDIAN 0x01 |
| 110 | |
Dave Barach | 905c14a | 2017-09-25 08:47:59 -0400 | [diff] [blame] | 111 | /** Message range (belonging to a plugin) */ |
Klement Sekera | 58eb866 | 2017-06-09 06:06:49 +0200 | [diff] [blame] | 112 | typedef struct |
| 113 | { |
Dave Barach | 905c14a | 2017-09-25 08:47:59 -0400 | [diff] [blame] | 114 | u8 *name; /**< name of the plugin */ |
| 115 | u16 first_msg_id; /**< first assigned message ID */ |
| 116 | u16 last_msg_id; /**< last assigned message ID */ |
Klement Sekera | 58eb866 | 2017-06-09 06:06:49 +0200 | [diff] [blame] | 117 | } vl_api_msg_range_t; |
| 118 | |
Dave Barach | 905c14a | 2017-09-25 08:47:59 -0400 | [diff] [blame] | 119 | /** Message configuration definition */ |
Klement Sekera | 58eb866 | 2017-06-09 06:06:49 +0200 | [diff] [blame] | 120 | typedef struct |
| 121 | { |
Dave Barach | 905c14a | 2017-09-25 08:47:59 -0400 | [diff] [blame] | 122 | int id; /**< the message ID */ |
| 123 | char *name; /**< the message name */ |
| 124 | u32 crc; /**< message definition CRC */ |
| 125 | void *handler; /**< the message handler */ |
| 126 | void *cleanup; /**< non-default message cleanup handler */ |
| 127 | void *endian; /**< message endian function */ |
| 128 | void *print; /**< message print function */ |
| 129 | int size; /**< message size */ |
| 130 | int traced; /**< is this message to be traced? */ |
| 131 | int replay; /**< is this message to be replayed? */ |
| 132 | int message_bounce; /**< do not free message after processing */ |
| 133 | int is_mp_safe; /**< worker thread barrier required? */ |
Klement Sekera | 58eb866 | 2017-06-09 06:06:49 +0200 | [diff] [blame] | 134 | } vl_msg_api_msg_config_t; |
| 135 | |
Dave Barach | 905c14a | 2017-09-25 08:47:59 -0400 | [diff] [blame] | 136 | /** Message header structure */ |
Klement Sekera | 58eb866 | 2017-06-09 06:06:49 +0200 | [diff] [blame] | 137 | typedef struct msgbuf_ |
| 138 | { |
Florin Coras | e86a8ed | 2018-01-05 03:20:25 -0800 | [diff] [blame] | 139 | svm_queue_t *q; /**< message allocated in this shmem ring */ |
Dave Barach | 905c14a | 2017-09-25 08:47:59 -0400 | [diff] [blame] | 140 | u32 data_len; /**< message length not including header */ |
| 141 | u32 gc_mark_timestamp; /**< message garbage collector mark TS */ |
| 142 | u8 data[0]; /**< actual message begins here */ |
Klement Sekera | 58eb866 | 2017-06-09 06:06:49 +0200 | [diff] [blame] | 143 | } msgbuf_t; |
| 144 | |
| 145 | /* api_shared.c prototypes */ |
| 146 | void vl_msg_api_handler (void *the_msg); |
| 147 | void vl_msg_api_handler_no_free (void *the_msg); |
| 148 | void vl_msg_api_handler_no_trace_no_free (void *the_msg); |
| 149 | void vl_msg_api_trace_only (void *the_msg); |
| 150 | void vl_msg_api_cleanup_handler (void *the_msg); |
| 151 | void vl_msg_api_replay_handler (void *the_msg); |
| 152 | void vl_msg_api_socket_handler (void *the_msg); |
| 153 | void vl_msg_api_set_handlers (int msg_id, char *msg_name, |
| 154 | void *handler, |
| 155 | void *cleanup, |
| 156 | void *endian, |
| 157 | void *print, int msg_size, int traced); |
Matej Perina | 75a17ec | 2017-09-21 17:03:27 +0200 | [diff] [blame] | 158 | void vl_msg_api_clean_handlers (int msg_id); |
Klement Sekera | 58eb866 | 2017-06-09 06:06:49 +0200 | [diff] [blame] | 159 | void vl_msg_api_config (vl_msg_api_msg_config_t *); |
| 160 | void vl_msg_api_set_cleanup_handler (int msg_id, void *fp); |
Florin Coras | e86a8ed | 2018-01-05 03:20:25 -0800 | [diff] [blame] | 161 | void vl_msg_api_queue_handler (svm_queue_t * q); |
Klement Sekera | 58eb866 | 2017-06-09 06:06:49 +0200 | [diff] [blame] | 162 | |
| 163 | void vl_msg_api_barrier_sync (void) __attribute__ ((weak)); |
| 164 | void vl_msg_api_barrier_release (void) __attribute__ ((weak)); |
Colin Tregenza Dancer | eb1ac17 | 2017-09-06 20:23:24 +0100 | [diff] [blame] | 165 | #ifdef BARRIER_TRACING |
| 166 | void vl_msg_api_barrier_trace_context (const char *context) |
| 167 | __attribute__ ((weak)); |
| 168 | #else |
| 169 | #define vl_msg_api_barrier_trace_context(X) |
| 170 | #endif |
Klement Sekera | 58eb866 | 2017-06-09 06:06:49 +0200 | [diff] [blame] | 171 | void vl_msg_api_free (void *); |
| 172 | void vl_noop_handler (void *mp); |
| 173 | void vl_msg_api_increment_missing_client_counter (void); |
| 174 | void vl_msg_api_post_mortem_dump (void); |
| 175 | void vl_msg_api_post_mortem_dump_enable_disable (int enable); |
| 176 | void vl_msg_api_register_pd_handler (void *handler, |
| 177 | u16 msg_id_host_byte_order); |
| 178 | int vl_msg_api_pd_handler (void *mp, int rv); |
| 179 | |
| 180 | void vl_msg_api_set_first_available_msg_id (u16 first_avail); |
| 181 | u16 vl_msg_api_get_msg_ids (const char *name, int n); |
Florin Coras | e86a8ed | 2018-01-05 03:20:25 -0800 | [diff] [blame] | 182 | u32 vl_msg_api_get_msg_index (u8 * name_and_crc); |
Ole Troan | 73710c7 | 2018-06-04 22:27:49 +0200 | [diff] [blame] | 183 | void *vl_msg_push_heap (void); |
| 184 | void vl_msg_pop_heap (void *oldheap); |
Klement Sekera | 58eb866 | 2017-06-09 06:06:49 +0200 | [diff] [blame] | 185 | |
| 186 | typedef clib_error_t *(vl_msg_api_init_function_t) (u32 client_index); |
| 187 | |
| 188 | typedef struct _vl_msg_api_init_function_list_elt |
| 189 | { |
| 190 | struct _vl_msg_api_init_function_list_elt *next_init_function; |
| 191 | vl_msg_api_init_function_t *f; |
| 192 | } _vl_msg_api_function_list_elt_t; |
| 193 | |
Dave Barach | 0d056e5 | 2017-09-28 15:11:16 -0400 | [diff] [blame] | 194 | typedef struct |
| 195 | { |
| 196 | u32 major; |
| 197 | u32 minor; |
| 198 | u32 patch; |
| 199 | char name[64]; |
| 200 | } api_version_t; |
| 201 | |
Dave Barach | 905c14a | 2017-09-25 08:47:59 -0400 | [diff] [blame] | 202 | /** API main structure, used by both vpp and binary API clients */ |
Klement Sekera | 58eb866 | 2017-06-09 06:06:49 +0200 | [diff] [blame] | 203 | typedef struct |
| 204 | { |
Dave Barach | 905c14a | 2017-09-25 08:47:59 -0400 | [diff] [blame] | 205 | /** Message handler vector */ |
Klement Sekera | 58eb866 | 2017-06-09 06:06:49 +0200 | [diff] [blame] | 206 | void (**msg_handlers) (void *); |
Dave Barach | 905c14a | 2017-09-25 08:47:59 -0400 | [diff] [blame] | 207 | /** Plaform-dependent (aka hardware) message handler vector */ |
Klement Sekera | 58eb866 | 2017-06-09 06:06:49 +0200 | [diff] [blame] | 208 | int (**pd_msg_handlers) (void *, int); |
Dave Barach | 905c14a | 2017-09-25 08:47:59 -0400 | [diff] [blame] | 209 | |
| 210 | /** non-default message cleanup handler vector */ |
Klement Sekera | 58eb866 | 2017-06-09 06:06:49 +0200 | [diff] [blame] | 211 | void (**msg_cleanup_handlers) (void *); |
Dave Barach | 905c14a | 2017-09-25 08:47:59 -0400 | [diff] [blame] | 212 | |
| 213 | /** Message endian handler vector */ |
Klement Sekera | 58eb866 | 2017-06-09 06:06:49 +0200 | [diff] [blame] | 214 | void (**msg_endian_handlers) (void *); |
Dave Barach | 905c14a | 2017-09-25 08:47:59 -0400 | [diff] [blame] | 215 | |
| 216 | /** Message print function vector */ |
Klement Sekera | 58eb866 | 2017-06-09 06:06:49 +0200 | [diff] [blame] | 217 | void (**msg_print_handlers) (void *, void *); |
Dave Barach | 905c14a | 2017-09-25 08:47:59 -0400 | [diff] [blame] | 218 | |
| 219 | /** Message name vector */ |
Klement Sekera | 58eb866 | 2017-06-09 06:06:49 +0200 | [diff] [blame] | 220 | const char **msg_names; |
Dave Barach | 905c14a | 2017-09-25 08:47:59 -0400 | [diff] [blame] | 221 | |
| 222 | /** Don't automatically free message buffer vetor */ |
Klement Sekera | 58eb866 | 2017-06-09 06:06:49 +0200 | [diff] [blame] | 223 | u8 *message_bounce; |
Dave Barach | 905c14a | 2017-09-25 08:47:59 -0400 | [diff] [blame] | 224 | |
| 225 | /** Message is mp safe vector */ |
Klement Sekera | 58eb866 | 2017-06-09 06:06:49 +0200 | [diff] [blame] | 226 | u8 *is_mp_safe; |
Dave Barach | 905c14a | 2017-09-25 08:47:59 -0400 | [diff] [blame] | 227 | |
| 228 | /** Allocator ring vectors (in shared memory) */ |
Klement Sekera | 58eb866 | 2017-06-09 06:06:49 +0200 | [diff] [blame] | 229 | struct ring_alloc_ *arings; |
Dave Barach | 905c14a | 2017-09-25 08:47:59 -0400 | [diff] [blame] | 230 | |
| 231 | /** Number of times that the ring allocator failed */ |
Klement Sekera | 58eb866 | 2017-06-09 06:06:49 +0200 | [diff] [blame] | 232 | u32 ring_misses; |
Dave Barach | 905c14a | 2017-09-25 08:47:59 -0400 | [diff] [blame] | 233 | |
| 234 | /** Number of garbage-collected message buffers */ |
Klement Sekera | 58eb866 | 2017-06-09 06:06:49 +0200 | [diff] [blame] | 235 | u32 garbage_collects; |
Dave Barach | 905c14a | 2017-09-25 08:47:59 -0400 | [diff] [blame] | 236 | |
| 237 | /** Number of missing clients / failed message sends */ |
Klement Sekera | 58eb866 | 2017-06-09 06:06:49 +0200 | [diff] [blame] | 238 | u32 missing_clients; |
Dave Barach | 905c14a | 2017-09-25 08:47:59 -0400 | [diff] [blame] | 239 | |
| 240 | /** Received message trace configuration */ |
Klement Sekera | 58eb866 | 2017-06-09 06:06:49 +0200 | [diff] [blame] | 241 | vl_api_trace_t *rx_trace; |
Dave Barach | 905c14a | 2017-09-25 08:47:59 -0400 | [diff] [blame] | 242 | |
| 243 | /** Sent message trace configuration */ |
Klement Sekera | 58eb866 | 2017-06-09 06:06:49 +0200 | [diff] [blame] | 244 | vl_api_trace_t *tx_trace; |
Dave Barach | 905c14a | 2017-09-25 08:47:59 -0400 | [diff] [blame] | 245 | |
| 246 | /** Print every received message */ |
Klement Sekera | 58eb866 | 2017-06-09 06:06:49 +0200 | [diff] [blame] | 247 | int msg_print_flag; |
Dave Barach | 905c14a | 2017-09-25 08:47:59 -0400 | [diff] [blame] | 248 | |
| 249 | /** Current trace configuration */ |
Klement Sekera | 58eb866 | 2017-06-09 06:06:49 +0200 | [diff] [blame] | 250 | trace_cfg_t *api_trace_cfg; |
Dave Barach | 905c14a | 2017-09-25 08:47:59 -0400 | [diff] [blame] | 251 | |
| 252 | /** Current process PID */ |
Klement Sekera | 58eb866 | 2017-06-09 06:06:49 +0200 | [diff] [blame] | 253 | int our_pid; |
Dave Barach | 905c14a | 2017-09-25 08:47:59 -0400 | [diff] [blame] | 254 | |
Dave Barach | 7939f90 | 2017-10-04 10:03:52 -0400 | [diff] [blame] | 255 | /** Current binary api segment descriptor */ |
Klement Sekera | 58eb866 | 2017-06-09 06:06:49 +0200 | [diff] [blame] | 256 | svm_region_t *vlib_rp; |
Dave Barach | 905c14a | 2017-09-25 08:47:59 -0400 | [diff] [blame] | 257 | |
Dave Barach | 7939f90 | 2017-10-04 10:03:52 -0400 | [diff] [blame] | 258 | /** Primary api segment descriptor */ |
| 259 | svm_region_t *vlib_primary_rp; |
| 260 | |
Dave Barach | 905c14a | 2017-09-25 08:47:59 -0400 | [diff] [blame] | 261 | /** Vector of all mapped shared-VM segments */ |
Dave Barach | 59b2565 | 2017-09-10 15:04:27 -0400 | [diff] [blame] | 262 | svm_region_t **vlib_private_rps; |
Klement Sekera | 58eb866 | 2017-06-09 06:06:49 +0200 | [diff] [blame] | 263 | svm_region_t **mapped_shmem_regions; |
Dave Barach | 905c14a | 2017-09-25 08:47:59 -0400 | [diff] [blame] | 264 | |
| 265 | /** Binary API shared-memory segment header pointer */ |
Klement Sekera | 58eb866 | 2017-06-09 06:06:49 +0200 | [diff] [blame] | 266 | struct vl_shmem_hdr_ *shmem_hdr; |
Dave Barach | 905c14a | 2017-09-25 08:47:59 -0400 | [diff] [blame] | 267 | |
| 268 | /** vlib/vpp only: vector of client registrations */ |
Klement Sekera | 58eb866 | 2017-06-09 06:06:49 +0200 | [diff] [blame] | 269 | vl_api_registration_t **vl_clients; |
| 270 | |
Dave Barach | 905c14a | 2017-09-25 08:47:59 -0400 | [diff] [blame] | 271 | /** vlib/vpp only: serialized (message, name, crc) table */ |
Klement Sekera | 58eb866 | 2017-06-09 06:06:49 +0200 | [diff] [blame] | 272 | u8 *serialized_message_table_in_shmem; |
| 273 | |
Dave Barach | 905c14a | 2017-09-25 08:47:59 -0400 | [diff] [blame] | 274 | /** First available message ID, for theplugin msg allocator */ |
Klement Sekera | 58eb866 | 2017-06-09 06:06:49 +0200 | [diff] [blame] | 275 | u16 first_available_msg_id; |
| 276 | |
Dave Barach | 905c14a | 2017-09-25 08:47:59 -0400 | [diff] [blame] | 277 | /** Message range by name hash */ |
Klement Sekera | 58eb866 | 2017-06-09 06:06:49 +0200 | [diff] [blame] | 278 | uword *msg_range_by_name; |
| 279 | |
Dave Barach | 905c14a | 2017-09-25 08:47:59 -0400 | [diff] [blame] | 280 | /** vector of message ranges */ |
Klement Sekera | 58eb866 | 2017-06-09 06:06:49 +0200 | [diff] [blame] | 281 | vl_api_msg_range_t *msg_ranges; |
| 282 | |
Dave Barach | 905c14a | 2017-09-25 08:47:59 -0400 | [diff] [blame] | 283 | /** uid for the api shared memory region */ |
Klement Sekera | 58eb866 | 2017-06-09 06:06:49 +0200 | [diff] [blame] | 284 | int api_uid; |
Dave Barach | 905c14a | 2017-09-25 08:47:59 -0400 | [diff] [blame] | 285 | |
| 286 | /** gid for the api shared memory region */ |
Klement Sekera | 58eb866 | 2017-06-09 06:06:49 +0200 | [diff] [blame] | 287 | int api_gid; |
| 288 | |
Dave Barach | 905c14a | 2017-09-25 08:47:59 -0400 | [diff] [blame] | 289 | /** base virtual address for global VM region */ |
Klement Sekera | 58eb866 | 2017-06-09 06:06:49 +0200 | [diff] [blame] | 290 | u64 global_baseva; |
| 291 | |
Dave Barach | 905c14a | 2017-09-25 08:47:59 -0400 | [diff] [blame] | 292 | /** size of the global VM region */ |
Klement Sekera | 58eb866 | 2017-06-09 06:06:49 +0200 | [diff] [blame] | 293 | u64 global_size; |
| 294 | |
Dave Barach | 905c14a | 2017-09-25 08:47:59 -0400 | [diff] [blame] | 295 | /** size of the API region */ |
Klement Sekera | 58eb866 | 2017-06-09 06:06:49 +0200 | [diff] [blame] | 296 | u64 api_size; |
| 297 | |
Dave Barach | 905c14a | 2017-09-25 08:47:59 -0400 | [diff] [blame] | 298 | /** size of the global VM private mheap */ |
Klement Sekera | 58eb866 | 2017-06-09 06:06:49 +0200 | [diff] [blame] | 299 | u64 global_pvt_heap_size; |
| 300 | |
Dave Barach | 905c14a | 2017-09-25 08:47:59 -0400 | [diff] [blame] | 301 | /** size of the api private mheap */ |
Klement Sekera | 58eb866 | 2017-06-09 06:06:49 +0200 | [diff] [blame] | 302 | u64 api_pvt_heap_size; |
| 303 | |
Dave Barach | 905c14a | 2017-09-25 08:47:59 -0400 | [diff] [blame] | 304 | /** Peer input queue pointer */ |
Florin Coras | e86a8ed | 2018-01-05 03:20:25 -0800 | [diff] [blame] | 305 | svm_queue_t *vl_input_queue; |
Klement Sekera | 58eb866 | 2017-06-09 06:06:49 +0200 | [diff] [blame] | 306 | |
Dave Barach | 905c14a | 2017-09-25 08:47:59 -0400 | [diff] [blame] | 307 | /** |
Klement Sekera | 58eb866 | 2017-06-09 06:06:49 +0200 | [diff] [blame] | 308 | * All VLIB-side message handlers use my_client_index to identify |
| 309 | * the queue / client. This works in sim replay. |
| 310 | */ |
| 311 | int my_client_index; |
Dave Barach | 905c14a | 2017-09-25 08:47:59 -0400 | [diff] [blame] | 312 | /** |
Klement Sekera | 58eb866 | 2017-06-09 06:06:49 +0200 | [diff] [blame] | 313 | * This is the (shared VM) address of the registration, |
| 314 | * don't use it to id the connection since it can't possibly |
| 315 | * work in simulator replay. |
| 316 | */ |
| 317 | vl_api_registration_t *my_registration; |
| 318 | |
Dave Barach | 905c14a | 2017-09-25 08:47:59 -0400 | [diff] [blame] | 319 | /** vpp/vlib input queue length */ |
Klement Sekera | 58eb866 | 2017-06-09 06:06:49 +0200 | [diff] [blame] | 320 | u32 vlib_input_queue_length; |
| 321 | |
Dave Barach | 905c14a | 2017-09-25 08:47:59 -0400 | [diff] [blame] | 322 | /** client message index hash table */ |
Klement Sekera | 58eb866 | 2017-06-09 06:06:49 +0200 | [diff] [blame] | 323 | uword *msg_index_by_name_and_crc; |
| 324 | |
Dave Barach | 0d056e5 | 2017-09-28 15:11:16 -0400 | [diff] [blame] | 325 | /** api version list */ |
| 326 | api_version_t *api_version_list; |
| 327 | |
Dave Barach | 905c14a | 2017-09-25 08:47:59 -0400 | [diff] [blame] | 328 | /** Shared VM binary API region name */ |
Klement Sekera | 58eb866 | 2017-06-09 06:06:49 +0200 | [diff] [blame] | 329 | const char *region_name; |
Dave Barach | 905c14a | 2017-09-25 08:47:59 -0400 | [diff] [blame] | 330 | |
| 331 | /** Chroot path to the shared memory API files */ |
Klement Sekera | 58eb866 | 2017-06-09 06:06:49 +0200 | [diff] [blame] | 332 | const char *root_path; |
| 333 | |
Dave Barach | 905c14a | 2017-09-25 08:47:59 -0400 | [diff] [blame] | 334 | /** Replay in progress? */ |
Klement Sekera | 58eb866 | 2017-06-09 06:06:49 +0200 | [diff] [blame] | 335 | int replay_in_progress; |
| 336 | |
Dave Barach | 905c14a | 2017-09-25 08:47:59 -0400 | [diff] [blame] | 337 | /** Dump (msg-name, crc) snapshot here at startup */ |
Dave Barach | 49fe046 | 2017-09-12 17:06:56 -0400 | [diff] [blame] | 338 | u8 *save_msg_table_filename; |
| 339 | |
Dave Barach | 905c14a | 2017-09-25 08:47:59 -0400 | [diff] [blame] | 340 | /** List of API client reaper functions */ |
Klement Sekera | 58eb866 | 2017-06-09 06:06:49 +0200 | [diff] [blame] | 341 | _vl_msg_api_function_list_elt_t *reaper_function_registrations; |
| 342 | |
IJsbrand Wijnands | 8229580 | 2019-10-08 13:50:55 +0200 | [diff] [blame^] | 343 | /** Bin API thread handle */ |
| 344 | pthread_t rx_thread_handle; |
| 345 | |
Dave Barach | b09f4d0 | 2019-07-15 16:00:03 -0400 | [diff] [blame] | 346 | /** event log */ |
| 347 | elog_main_t *elog_main; |
| 348 | int elog_trace_api_messages; |
| 349 | |
Klement Sekera | 58eb866 | 2017-06-09 06:06:49 +0200 | [diff] [blame] | 350 | } api_main_t; |
| 351 | |
| 352 | extern api_main_t api_main; |
| 353 | |
Klement Sekera | 58eb866 | 2017-06-09 06:06:49 +0200 | [diff] [blame] | 354 | #endif /* included_api_common_h */ |
| 355 | |
| 356 | /* |
| 357 | * fd.io coding-style-patch-verification: ON |
| 358 | * |
| 359 | * Local Variables: |
| 360 | * eval: (c-set-style "gnu") |
| 361 | * End: |
| 362 | */ |