src/vpp/stats/stats.h

   1 /*
   2  * Copyright (c) 2015 Cisco and/or its affiliates.
   3  * Licensed under the Apache License, Version 2.0 (the "License");
   4  * you may not use this file except in compliance with the License.
   5  * You may obtain a copy of the License at:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   9  * Unless required by applicable law or agreed to in writing, software
  10  * distributed under the License is distributed on an "AS IS" BASIS,
  11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12  * See the License for the specific language governing permissions and
  13  * limitations under the License.
  14  */
  15 #ifndef __included_stats_h__
  16 #define __included_stats_h__
  17
  18 #include <time.h>
  19 #include <vlib/vlib.h>
  20 #include <vnet/vnet.h>
  21 #include <vnet/interface.h>
  22 #include <pthread.h>
  23 #include <vlib/threads.h>
  24 #include <vnet/fib/fib_table.h>
  25 #include <vnet/mfib/mfib_table.h>
  26 #include <vlib/unix/unix.h>
  27 #include <vlibmemory/api.h>
  28 #include <vlibapi/api_helper_macros.h>
  29 #include <svm/queue.h>
  30 #include <svm/ssvm.h>
  31
  32 /* Default socket to exchange segment fd */
  33 #define STAT_SEGMENT_SOCKET_FILE "/run/vpp/stats.sock"
  34
  35 typedef struct
  36 {
  37   volatile u32 lock;
  38   volatile u32 release_hint;
  39   u32 thread_index;
  40   u32 count;
  41   int tag;
  42 } data_structure_lock_t;
  43
  44 /**
  45  * @brief stats request registration indexes
  46  *
  47  */
  48 /* from .../vnet/vnet/ip/lookup.c. Yuck */
  49 /* *INDENT-OFF* */
  50 typedef CLIB_PACKED (struct
  51 {
  52   ip4_address_t address;
  53   u32 address_length: 6;
  54   u32 index:         26;
  55 }) ip4_route_t;
  56 /* *INDENT-ON* */
  57
  58 typedef struct
  59 {
  60   ip6_address_t address;
  61   u32 address_length;
  62   u32 index;
  63 } ip6_route_t;
  64
  65 typedef struct
  66 {
  67   ip4_route_t *ip4routes;
  68   ip6_route_t *ip6routes;
  69   mfib_prefix_t *mroutes;
  70   fib_table_t **fibs;
  71   mfib_table_t **mfibs;
  72   hash_pair_t **pvec;
  73   uword *results;
  74 } do_ip46_fibs_t;
  75
  76 typedef struct
  77 {
  78   u16 msg_id;
  79   u32 size;
  80   u32 client_index;
  81   u32 context;
  82   i32 retval;
  83 } client_registration_reply_t;
  84
  85 typedef enum
  86 {
  87 #define stats_reg(n) IDX_##n,
  88 #include <vpp/stats/stats.reg>
  89 #undef stats_reg
  90   STATS_REG_N_IDX,
  91 } stats_reg_index_t;
  92
  93 typedef struct
  94 {
  95   //Standard client information
  96   uword *client_hash;
  97   vpe_client_registration_t *clients;
  98   u32 item;
  99
 100 } vpe_client_stats_registration_t;
 101
 102
 103 typedef struct
 104 {
 105   void *mheap;
 106   pthread_t thread_self;
 107   pthread_t thread_handle;
 108
 109   u32 stats_poll_interval_in_seconds;
 110   u32 enable_poller;
 111
 112   /*
 113    * stats_registrations is a vector, indexed by
 114    * IDX_xxxx_COUNTER generated for each streaming
 115    * stat a client can register for. (see stats.reg)
 116    *
 117    * The values in the vector refer to pools.
 118    *
 119    * The pool is of type vpe_client_stats_registration_t
 120    *
 121    * This typedef consists of:
 122    *
 123    * u32 item: This is the instance of the IDX_xxxx_COUNTER a
 124    *           client is interested in.
 125    * vpe_client_registration_t *clients: The list of clients interested.
 126    *
 127    * e.g.
 128    * stats_registrations[IDX_INTERFACE_SIMPLE_COUNTERS] refers to a pool
 129    * containing elements:
 130    *
 131    * u32 item = sw_if_index1
 132    * clients = ["clienta","clientb"]
 133    *
 134    * When clients == NULL the pool element is freed. When the pool is empty
 135    *
 136    * ie
 137    * 0 == pool_elts(stats_registrations[IDX_INTERFACE_SIMPLE_COUNTERS]
 138    *
 139    * then there is no need to process INTERFACE_SIMPLE_COUNTERS
 140    *
 141    * Note that u32 item = ~0 is the simple case for ALL interfaces or fibs.
 142    *
 143    */
 144
 145   uword **stats_registration_hash;
 146   vpe_client_stats_registration_t **stats_registrations;
 147
 148   /* control-plane data structure lock */
 149   data_structure_lock_t *data_structure_lock;
 150
 151   /* bail out of FIB walk if set */
 152   clib_longjmp_t jmp_buf;
 153
 154   /* Vectors for Distribution funcs: do_ip4_fibs and do_ip6_fibs. */
 155   do_ip46_fibs_t do_ip46_fibs;
 156
 157   /*
 158      Working vector vars so as to not thrash memory allocator.
 159      Has effect of making "static"
 160    */
 161   vpe_client_stats_registration_t **regs_tmp;
 162   vpe_client_registration_t **clients_tmp;
 163
 164   /* statistics segment */
 165   ssvm_private_t stat_segment;
 166   uword *counter_vector_by_name;
 167   clib_spinlock_t *stat_segment_lockp;
 168   clib_socket_t *socket;
 169   u8 *socket_name;
 170   uword memory_size;
 171   u8 serialize_nodes;
 172
 173   /* Pointers to scalar stats maintained by the stat thread */
 174   f64 *input_rate_ptr;
 175   f64 *last_runtime_ptr;
 176   f64 *last_runtime_stats_clear_ptr;
 177   f64 *vector_rate_ptr;
 178   f64 *heartbeat_ptr;
 179   u64 last_input_packets;
 180
 181   /* Pointers to vector stats maintained by the stat thread */
 182   u8 *serialized_nodes;
 183   vlib_main_t **stat_vms;
 184   vlib_node_t ***node_dups;
 185
 186   f64 *vectors_per_node;
 187   f64 *vector_rate_in;
 188   f64 *vector_rate_out;
 189   f64 *vector_rate_drop;
 190   f64 *vector_rate_punt;
 191
 192   /* convenience */
 193   vlib_main_t *vlib_main;
 194   vnet_main_t *vnet_main;
 195   vnet_interface_main_t *interface_main;
 196   api_main_t *api_main;
 197 } stats_main_t;
 198
 199 extern stats_main_t stats_main;
 200
 201 /* Default stat segment 32m */
 202 #define STAT_SEGMENT_DEFAULT_SIZE       (32<<20)
 203
 204 #define STAT_SEGMENT_OPAQUE_LOCK        0
 205 #define STAT_SEGMENT_OPAQUE_DIR         1
 206 #define STAT_SEGMENT_OPAQUE_EPOCH       2
 207
 208 typedef enum
 209 {
 210   STAT_DIR_TYPE_ILLEGAL = 0,
 211   STAT_DIR_TYPE_SCALAR_POINTER,
 212   STAT_DIR_TYPE_VECTOR_POINTER,
 213   STAT_DIR_TYPE_COUNTER_VECTOR_SIMPLE,
 214   STAT_DIR_TYPE_COUNTER_VECTOR_COMBINED,
 215   STAT_DIR_TYPE_ERROR_INDEX,
 216   STAT_DIR_TYPE_SERIALIZED_NODES,
 217 } stat_directory_type_t;
 218
 219 typedef struct
 220 {
 221   stat_directory_type_t type;
 222   void *value;
 223 } stat_segment_directory_entry_t;
 224
 225 void do_stat_segment_updates (stats_main_t * sm);
 226
 227 #endif /* __included_stats_h__ */
 228
 229 /*
 230  * fd.io coding-style-patch-verification: ON
 231  *
 232  * Local Variables:
 233  * eval: (c-set-style "gnu")
 234  * End:
 235  */