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 <stdatomic.h>
  20 #include <vlib/vlib.h>
  21 #include <vppinfra/socket.h>
  22 #include <vpp-api/client/stat_client.h>
  23
  24 typedef enum
  25 {
  26  STAT_COUNTER_VECTOR_RATE = 0,
  27  STAT_COUNTER_INPUT_RATE,
  28  STAT_COUNTER_LAST_UPDATE,
  29  STAT_COUNTER_LAST_STATS_CLEAR,
  30  STAT_COUNTER_HEARTBEAT,
  31  STAT_COUNTER_NODE_CLOCKS,
  32  STAT_COUNTER_NODE_VECTORS,
  33  STAT_COUNTER_NODE_CALLS,
  34  STAT_COUNTER_NODE_SUSPENDS,
  35  STAT_COUNTERS
  36 } stat_segment_counter_t;
  37
  38 #define foreach_stat_segment_counter_name                       \
  39   _(VECTOR_RATE, SCALAR_INDEX, vector_rate,)                    \
  40   _(INPUT_RATE, SCALAR_INDEX, input_rate,)                      \
  41   _(LAST_UPDATE, SCALAR_INDEX, last_update,)                    \
  42   _(LAST_STATS_CLEAR, SCALAR_INDEX, last_stats_clear,)          \
  43   _(HEARTBEAT, SCALAR_INDEX, heartbeat,)                        \
  44   _(NODE_CLOCKS, COUNTER_VECTOR_SIMPLE, clocks, /node)          \
  45   _(NODE_VECTORS, COUNTER_VECTOR_SIMPLE, vectors, /node)        \
  46   _(NODE_CALLS, COUNTER_VECTOR_SIMPLE, calls, /node)            \
  47   _(NODE_SUSPENDS, COUNTER_VECTOR_SIMPLE, suspends, /node)
  48
  49 typedef struct
  50 {
  51   stat_directory_type_t type;
  52   union {
  53     uint64_t offset;
  54     uint64_t index;
  55     uint64_t value;
  56   };
  57   uint64_t offset_vector;
  58   char name[128]; // TODO change this to pointer to "somewhere"
  59 } stat_segment_directory_entry_t;
  60
  61 /* Default stat segment 32m */
  62 #define STAT_SEGMENT_DEFAULT_SIZE       (32<<20)
  63
  64 /*
  65  * Shared header first in the shared memory segment.
  66  */
  67 typedef struct
  68 {
  69   atomic_int_fast64_t epoch;
  70   atomic_int_fast64_t in_progress;
  71   atomic_int_fast64_t directory_offset;
  72   atomic_int_fast64_t error_offset;
  73   atomic_int_fast64_t stats_offset;
  74 } stat_segment_shared_header_t;
  75
  76 static inline uint64_t
  77 stat_segment_offset (void *start, void *data)
  78 {
  79   return (char *) data - (char *) start;
  80 }
  81
  82 static inline void *
  83 stat_segment_pointer (void *start, uint64_t offset)
  84 {
  85   return ((char *) start + offset);
  86 }
  87
  88 typedef struct
  89 {
  90   /* statistics segment */
  91   uword *directory_vector_by_name;
  92   stat_segment_directory_entry_t *directory_vector;
  93   clib_spinlock_t *stat_segment_lockp;
  94   clib_socket_t *socket;
  95   u8 *socket_name;
  96   ssize_t memory_size;
  97   u8 node_counters_enabled;
  98   void *heap;
  99   stat_segment_shared_header_t *shared_header;  /* pointer to shared memory segment */
 100   int memfd;
 101
 102   u64 last_input_packets;
 103 } stat_segment_main_t;
 104
 105 extern stat_segment_main_t stat_segment_main;
 106
 107 #endif