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