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
  31 typedef struct
  32 {
  33   volatile u32 lock;
  34   volatile u32 release_hint;
  35   u32 thread_index;
  36   u32 count;
  37   int tag;
  38 } data_structure_lock_t;
  39
  40 /**
  41  * @brief stats request registration indexes
  42  *
  43  */
  44 /* from .../vnet/vnet/ip/lookup.c. Yuck */
  45 /* *INDENT-OFF* */
  46 typedef CLIB_PACKED (struct
  47 {
  48   ip4_address_t address;
  49   u32 address_length: 6;
  50   u32 index:         26;
  51 }) ip4_route_t;
  52 /* *INDENT-ON* */
  53
  54 typedef struct
  55 {
  56   ip6_address_t address;
  57   u32 address_length;
  58   u32 index;
  59 } ip6_route_t;
  60
  61 typedef struct
  62 {
  63   ip4_route_t *ip4routes;
  64   ip6_route_t *ip6routes;
  65   mfib_prefix_t *mroutes;
  66   fib_table_t **fibs;
  67   mfib_table_t **mfibs;
  68   hash_pair_t **pvec;
  69   uword *results;
  70 } do_ip46_fibs_t;
  71
  72 typedef struct
  73 {
  74   u16 msg_id;
  75   u32 size;
  76   u32 client_index;
  77   u32 context;
  78   i32 retval;
  79 } client_registration_reply_t;
  80
  81 typedef enum
  82 {
  83 #define stats_reg(n) IDX_##n,
  84 #include <vpp/stats/stats.reg>
  85 #undef stats_reg
  86   STATS_REG_N_IDX,
  87 } stats_reg_index_t;
  88
  89 typedef struct
  90 {
  91   //Standard client information
  92   uword *client_hash;
  93   vpe_client_registration_t *clients;
  94   u32 item;
  95
  96 } vpe_client_stats_registration_t;
  97
  98
  99 typedef struct
 100 {
 101   void *mheap;
 102   pthread_t thread_self;
 103   pthread_t thread_handle;
 104
 105   u32 stats_poll_interval_in_seconds;
 106   u32 enable_poller;
 107
 108   /*
 109    * stats_registrations is a vector, indexed by
 110    * IDX_xxxx_COUNTER generated for each streaming
 111    * stat a client can register for. (see stats.reg)
 112    *
 113    * The values in the vector refer to pools.
 114    *
 115    * The pool is of type vpe_client_stats_registration_t
 116    *
 117    * This typedef consists of:
 118    *
 119    * u32 item: This is the instance of the IDX_xxxx_COUNTER a
 120    *           client is interested in.
 121    * vpe_client_registration_t *clients: The list of clients interested.
 122    *
 123    * e.g.
 124    * stats_registrations[IDX_INTERFACE_SIMPLE_COUNTERS] refers to a pool
 125    * containing elements:
 126    *
 127    * u32 item = sw_if_index1
 128    * clients = ["clienta","clientb"]
 129    *
 130    * When clients == NULL the pool element is freed. When the pool is empty
 131    *
 132    * ie
 133    * 0 == pool_elts(stats_registrations[IDX_INTERFACE_SIMPLE_COUNTERS]
 134    *
 135    * then there is no need to process INTERFACE_SIMPLE_COUNTERS
 136    *
 137    * Note that u32 item = ~0 is the simple case for ALL interfaces or fibs.
 138    *
 139    */
 140
 141   uword **stats_registration_hash;
 142   vpe_client_stats_registration_t **stats_registrations;
 143
 144   /* control-plane data structure lock */
 145   data_structure_lock_t *data_structure_lock;
 146
 147   /* bail out of FIB walk if set */
 148   clib_longjmp_t jmp_buf;
 149
 150   /* Vectors for Distribution funcs: do_ip4_fibs and do_ip6_fibs. */
 151   do_ip46_fibs_t do_ip46_fibs;
 152
 153   /*
 154      Working vector vars so as to not thrash memory allocator.
 155      Has effect of making "static"
 156    */
 157   vpe_client_stats_registration_t **regs_tmp;
 158   vpe_client_registration_t **clients_tmp;
 159
 160   /* convenience */
 161   vlib_main_t *vlib_main;
 162   vnet_main_t *vnet_main;
 163   vnet_interface_main_t *interface_main;
 164   api_main_t *api_main;
 165 } stats_main_t;
 166
 167 extern stats_main_t stats_main;
 168
 169 #endif /* __included_stats_h__ */
 170
 171 /*
 172  * fd.io coding-style-patch-verification: ON
 173  *
 174  * Local Variables:
 175  * eval: (c-set-style "gnu")
 176  * End:
 177  */