src/vpp/stats/stat_segment.h

   1 /*
   2  * Copyright (c) 2018 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
  16 #ifndef included_stat_segment_h
  17 #define included_stat_segment_h
  18
  19 #include <vlib/vlib.h>
  20 #include <vppinfra/socket.h>
  21 #include <vpp/stats/stat_segment_shared.h>
  22
  23 typedef enum
  24 {
  25   STAT_COUNTER_NUM_WORKER_THREADS = 0,
  26   STAT_COUNTER_INPUT_RATE,
  27   STAT_COUNTER_LAST_UPDATE,
  28   STAT_COUNTER_LAST_STATS_CLEAR,
  29   STAT_COUNTER_HEARTBEAT,
  30   STAT_COUNTER_NODE_CLOCKS,
  31   STAT_COUNTER_NODE_VECTORS,
  32   STAT_COUNTER_NODE_CALLS,
  33   STAT_COUNTER_NODE_SUSPENDS,
  34   STAT_COUNTER_INTERFACE_NAMES,
  35   STAT_COUNTER_NODE_NAMES,
  36   STAT_COUNTERS
  37 } stat_segment_counter_t;
  38
  39 /* clang-format off */
  40 #define foreach_stat_segment_node_counter_name                                \
  41   _ (NODE_CLOCKS, COUNTER_VECTOR_SIMPLE, clocks, /sys/node)                   \
  42   _ (NODE_VECTORS, COUNTER_VECTOR_SIMPLE, vectors, /sys/node)                 \
  43   _ (NODE_CALLS, COUNTER_VECTOR_SIMPLE, calls, /sys/node)                     \
  44   _ (NODE_SUSPENDS, COUNTER_VECTOR_SIMPLE, suspends, /sys/node)
  45
  46 #define foreach_stat_segment_counter_name                                     \
  47   _ (NUM_WORKER_THREADS, SCALAR_INDEX, num_worker_threads, /sys)              \
  48   _ (INPUT_RATE, SCALAR_INDEX, input_rate, /sys)                              \
  49   _ (LAST_UPDATE, SCALAR_INDEX, last_update, /sys)                            \
  50   _ (LAST_STATS_CLEAR, SCALAR_INDEX, last_stats_clear, /sys)                  \
  51   _ (HEARTBEAT, SCALAR_INDEX, heartbeat, /sys)                                \
  52   _ (INTERFACE_NAMES, NAME_VECTOR, names, /if)                                \
  53   _ (NODE_NAMES, NAME_VECTOR, names, /sys/node)                               \
  54   foreach_stat_segment_node_counter_name
  55 /* clang-format on */
  56
  57 /* Default stat segment 32m */
  58 #define STAT_SEGMENT_DEFAULT_SIZE       (32<<20)
  59
  60 /* Shared segment memory layout version */
  61 #define STAT_SEGMENT_VERSION            2
  62
  63 #define STAT_SEGMENT_INDEX_INVALID      UINT32_MAX
  64
  65 typedef void (*stat_segment_update_fn)(stat_segment_directory_entry_t * e, u32 i);
  66
  67 typedef struct {
  68   u32 directory_index;
  69   stat_segment_update_fn fn;
  70   u32 caller_index;
  71   u8 enabled;
  72 } stat_segment_gauges_pool_t;
  73
  74 typedef struct
  75 {
  76   /* internal, does not point to shared memory */
  77   stat_segment_gauges_pool_t *gauges;
  78
  79   /* statistics segment */
  80   uword *directory_vector_by_name;
  81   stat_segment_directory_entry_t *directory_vector;
  82   volatile u64 **error_vector;
  83   u8 **interfaces;
  84   u8 **nodes;
  85
  86   /* Update interval */
  87   f64 update_interval;
  88
  89   clib_spinlock_t *stat_segment_lockp;
  90   clib_socket_t *socket;
  91   u8 *socket_name;
  92   ssize_t memory_size;
  93   clib_mem_page_sz_t log2_page_sz;
  94   u8 node_counters_enabled;
  95   void *last;
  96   void *heap;
  97   stat_segment_shared_header_t *shared_header;  /* pointer to shared memory segment */
  98   int memfd;
  99
 100   u64 last_input_packets; // OLE REMOVE?
 101 } stat_segment_main_t;
 102
 103 extern stat_segment_main_t stat_segment_main;
 104
 105 clib_error_t *
 106 stat_segment_register_gauge (u8 *names, stat_segment_update_fn update_fn, u32 index);
 107 clib_error_t *
 108 stat_segment_register_state_counter(u8 *name, u32 *index);
 109 clib_error_t *
 110 stat_segment_deregister_state_counter(u32 index);
 111 void stat_segment_set_state_counter (u32 index, u64 value);
 112 uword stat_segment_poll_add (u32 vector_index,
 113                              stat_segment_update_fn update_fn,
 114                              u32 caller_index, u32 interval, u8 enabled);
 115 void stat_segment_poll_state (uword index, u8 enabled);
 116
 117 counter_t **stat_validate_counter_vector3 (counter_t **counters, u32 max1,
 118                                            u32 max2);
 119
 120 u32 stat_segment_new_entry (u8 *name, stat_directory_type_t t);
 121 void vlib_stats_register_mem_heap (clib_mem_heap_t *heap);
 122 void vlib_stat_segment_lock (void);
 123 void vlib_stat_segment_unlock (void);
 124 void vlib_stats_register_symlink (void *oldheap, u8 *name, u32 index1,
 125                                   u32 index2, u8 lock);
 126
 127 void stat_provider_register_vector_rate (u32 num_workers);
 128
 129 #endif