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