src/vlibapi/api.h

   1 /*
   2  *------------------------------------------------------------------
   3  * api.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_h
  21 #define included_api_h
  22
  23 #include <stddef.h>
  24 #include <vppinfra/error.h>
  25 #include <svm/svm.h>
  26 #include <svm/queue.h>
  27 #include <vlib/vlib.h>
  28 #include <vlib/unix/unix.h>
  29 #include <vlibapi/api_common.h>
  30
  31 typedef CLIB_PACKED ( struct {
  32    u32 nitems;
  33    u32 msgtbl_size;
  34    u8 wrapped;
  35 }) vl_api_trace_file_header_t;
  36
  37 int vl_msg_api_trace_save (api_main_t *am, vl_api_trace_which_t which,
  38                            FILE *fp, u8 is_json);
  39
  40 #define VLIB_API_INIT_FUNCTION(x) VLIB_DECLARE_INIT_FUNCTION(x,api_init)
  41
  42 /* Call given init function: used for init function dependencies. */
  43 #define vlib_call_api_init_function(vm, x)                              \
  44   ({                                                                    \
  45     extern vlib_init_function_t * _VLIB_INIT_FUNCTION_SYMBOL (x,api_init); \
  46     vlib_init_function_t * _f = _VLIB_INIT_FUNCTION_SYMBOL (x,api_init); \
  47     clib_error_t * _error = 0;                                          \
  48     if (! hash_get (vm->init_functions_called, _f))                     \
  49       {                                                                 \
  50         hash_set1 (vm->init_functions_called, _f);                      \
  51         _error = _f (vm);                                               \
  52       }                                                                 \
  53     _error;                                                             \
  54   })
  55
  56 #define _VL_MSG_API_FUNCTION_SYMBOL(x, type)    \
  57   _vl_msg_api_##type##_function_##x
  58
  59 #define VL_MSG_API_FUNCTION_SYMBOL(x)           \
  60   _VL_MSG_API_FUNCTION_SYMBOL(x, reaper)
  61
  62 #define VLIB_DECLARE_REAPER_FUNCTION(x, tag)                            \
  63 vl_msg_api_init_function_t * _VL_MSG_API_FUNCTION_SYMBOL (x, tag) = x;  \
  64 static void __vl_msg_api_add_##tag##_function_##x (void)                \
  65     __attribute__((__constructor__)) ;                                  \
  66                                                                         \
  67 static void __vl_msg_api_add_##tag##_function_##x (void)                \
  68 {                                                                       \
  69  api_main_t * am = vlibapi_get_main();                                  \
  70  static _vl_msg_api_function_list_elt_t _vl_msg_api_function;           \
  71  _vl_msg_api_function.next_init_function                                \
  72     = am->tag##_function_registrations;                                 \
  73   am->tag##_function_registrations = &_vl_msg_api_function;             \
  74  _vl_msg_api_function.f = &x;                                           \
  75 }
  76
  77 #define VL_MSG_API_REAPER_FUNCTION(x) VLIB_DECLARE_REAPER_FUNCTION(x,reaper)
  78
  79 /* Call reaper function with client index */
  80 #define vl_msg_api_call_reaper_function(ci)                             \
  81   ({                                                                    \
  82     extern vlib_init_function_t * VLIB_INIT_FUNCTION_SYMBOL (reaper);   \
  83     vlib_init_function_t * _f = VLIB_INIT_FUNCTION_SYMBOL (reaper);     \
  84     clib_error_t * _error = 0;                                          \
  85     _error = _f (ci);                                                   \
  86   })
  87
  88 static inline u32
  89 vl_msg_api_get_msg_length_inline (void *msg_arg)
  90 {
  91   u8 *msg = (u8 *) msg_arg;
  92
  93   msgbuf_t *header = (msgbuf_t *) (msg - offsetof (msgbuf_t, data));
  94
  95   return clib_net_to_host_u32 (header->data_len);
  96 }
  97
  98 int vl_msg_api_rx_trace_enabled (api_main_t * am);
  99 int vl_msg_api_tx_trace_enabled (api_main_t * am);
 100 void vl_msg_api_trace (api_main_t * am, vl_api_trace_t * tp, void *msg);
 101 int vl_msg_api_trace_onoff (api_main_t * am, vl_api_trace_which_t which,
 102                             int onoff);
 103 int vl_msg_api_trace_free (api_main_t * am, vl_api_trace_which_t which);
 104 int vl_msg_api_trace_configure (api_main_t * am, vl_api_trace_which_t which,
 105                                 u32 nitems);
 106 u32 vl_msg_api_max_length (void *mp);
 107 vl_api_trace_t *vl_msg_api_trace_get (api_main_t * am,
 108                                       vl_api_trace_which_t which);
 109 void vl_msg_api_add_msg_name_crc (api_main_t * am, const char *string,
 110                                   u32 id);
 111 void vl_msg_api_add_version (api_main_t * am, const char *string,
 112                              u32 major, u32 minor, u32 patch);
 113 /* node_serialize.c prototypes */
 114 u8 *vlib_node_serialize (vlib_main_t * vm, vlib_node_t *** node_dups,
 115                          u8 * vector, int include_nexts, int include_stats);
 116 vlib_node_t ***vlib_node_unserialize (u8 * vector);
 117
 118 u32 vl_msg_api_get_msg_length (void *msg_arg);
 119
 120 typedef int (*vl_msg_traverse_trace_fn) (u8 *, void *);
 121
 122 int vl_msg_traverse_trace (vl_api_trace_t *tp, vl_msg_traverse_trace_fn fn,
 123                            void *ctx);
 124
 125 always_inline void
 126 vl_api_increase_msg_trace_size (api_main_t *am, u32 msg_id, u32 inc)
 127 {
 128   am->msg_data[msg_id].trace_size += inc;
 129 }
 130
 131 always_inline void
 132 vl_api_set_msg_thread_safe (api_main_t *am, u32 msg_id, int v)
 133 {
 134   am->msg_data[msg_id].is_mp_safe = v != 0;
 135 }
 136
 137 always_inline void
 138 vl_api_set_msg_autoendian (api_main_t *am, u32 msg_id, int v)
 139 {
 140   am->msg_data[msg_id].is_autoendian = v != 0;
 141 }
 142
 143 always_inline void
 144 vl_api_allow_msg_replay (api_main_t *am, u32 msg_id, int v)
 145 {
 146   am->msg_data[msg_id].replay_allowed = v != 0;
 147 }
 148
 149 format_function_t format_vl_api_msg_text;
 150 format_function_t format_vl_api_msg_json;
 151
 152 #endif /* included_api_h */
 153 /*
 154  * fd.io coding-style-patch-verification: ON
 155  *
 156  * Local Variables:
 157  * eval: (c-set-style "gnu")
 158  * End:
 159  */