FD.io VPP  v19.08-27-gf4dcae4
Vector Packet Processing
stat_segment.h
Go to the documentation of this file.
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>
23 
24 typedef enum
25 {
43 
44 #define foreach_stat_segment_counter_name \
45  _(VECTOR_RATE, SCALAR_INDEX, vector_rate, /sys) \
46  _(VECTOR_RATE_PER_WORKER, COUNTER_VECTOR_SIMPLE, \
47  vector_rate_per_worker, /sys) \
48  _(NUM_WORKER_THREADS, SCALAR_INDEX, num_worker_threads, /sys) \
49  _(INPUT_RATE, SCALAR_INDEX, input_rate, /sys) \
50  _(LAST_UPDATE, SCALAR_INDEX, last_update, /sys) \
51  _(LAST_STATS_CLEAR, SCALAR_INDEX, last_stats_clear, /sys) \
52  _(HEARTBEAT, SCALAR_INDEX, heartbeat, /sys) \
53  _(NODE_CLOCKS, COUNTER_VECTOR_SIMPLE, clocks, /sys/node) \
54  _(NODE_VECTORS, COUNTER_VECTOR_SIMPLE, vectors, /sys/node) \
55  _(NODE_CALLS, COUNTER_VECTOR_SIMPLE, calls, /sys/node) \
56  _(NODE_SUSPENDS, COUNTER_VECTOR_SIMPLE, suspends, /sys/node) \
57  _(INTERFACE_NAMES, NAME_VECTOR, names, /if) \
58  _(NODE_NAMES, NAME_VECTOR, names, /sys/node) \
59  _(MEM_STATSEG_TOTAL, SCALAR_INDEX, total, /mem/statseg) \
60  _(MEM_STATSEG_USED, SCALAR_INDEX, used, /mem/statseg)
61 
62 typedef struct
63 {
65  union {
66  uint64_t offset;
67  uint64_t index;
68  uint64_t value;
69  };
70  uint64_t offset_vector;
71  char name[128]; // TODO change this to pointer to "somewhere"
73 
74 /* Default stat segment 32m */
75 #define STAT_SEGMENT_DEFAULT_SIZE (32<<20)
76 
77 /* Shared segment memory layout version */
78 #define STAT_SEGMENT_VERSION 1
79 
80 /*
81  * Shared header first in the shared memory segment.
82  */
83 typedef struct
84 {
86  atomic_int_fast64_t epoch;
87  atomic_int_fast64_t in_progress;
88  atomic_int_fast64_t directory_offset;
89  atomic_int_fast64_t error_offset;
90  atomic_int_fast64_t stats_offset;
92 
93 static inline uint64_t
94 stat_segment_offset (void *start, void *data)
95 {
96  return (char *) data - (char *) start;
97 }
98 
99 static inline void *
100 stat_segment_pointer (void *start, uint64_t offset)
101 {
102  return ((char *) start + offset);
103 }
104 
106 
107 typedef struct {
112 
113 typedef struct
114 {
115  /* internal, does not point to shared memory */
117 
118  /* statistics segment */
124 
128  ssize_t memory_size;
130  void *last;
131  void *heap;
132  stat_segment_shared_header_t *shared_header; /* pointer to shared memory segment */
133  int memfd;
134 
135  u64 last_input_packets; // OLE REMOVE?
137 
139 
140 clib_error_t *
141 stat_segment_register_gauge (u8 *names, stat_segment_update_fn update_fn, u32 index);
142 
143 #endif
Definition: stat_segment.h:62
stat_segment_main_t stat_segment_main
Definition: stat_segment.c:27
stat_segment_gauges_pool_t * gauges
Definition: stat_segment.h:116
stat_segment_shared_header_t * shared_header
Definition: stat_segment.h:132
uint64_t index
Definition: stat_segment.h:67
stat_segment_directory_entry_t * directory_vector
Definition: stat_segment.h:120
unsigned long u64
Definition: types.h:89
static uint64_t stat_segment_offset(void *start, void *data)
Definition: stat_segment.h:94
clib_error_t * stat_segment_register_gauge(u8 *names, stat_segment_update_fn update_fn, u32 index)
Definition: stat_segment.c:732
int i
u8 data[128]
Definition: ipsec.api:249
unsigned char u8
Definition: types.h:56
void(* stat_segment_update_fn)(stat_segment_directory_entry_t *e, u32 i)
Definition: stat_segment.h:105
atomic_int_fast64_t in_progress
Definition: stat_segment.h:87
uint64_t value
Definition: stat_segment.h:68
stat_segment_update_fn fn
Definition: stat_segment.h:109
unsigned int u32
Definition: types.h:88
static void * stat_segment_pointer(void *start, uint64_t offset)
Definition: stat_segment.h:100
uint64_t offset
Definition: stat_segment.h:66
stat_segment_counter_t
Definition: stat_segment.h:24
u8 name[64]
Definition: memclnt.api:152
stat_directory_type_t
Definition: stat_client.h:27
uint64_t offset_vector
Definition: stat_segment.h:70
struct _socket_t clib_socket_t
atomic_int_fast64_t epoch
Definition: stat_segment.h:86
template key/value backing page structure
Definition: bihash_doc.h:44
uword * directory_vector_by_name
Definition: stat_segment.h:119
u64 uword
Definition: types.h:112
clib_socket_t * socket
Definition: stat_segment.h:126
atomic_int_fast64_t stats_offset
Definition: stat_segment.h:90
atomic_int_fast64_t error_offset
Definition: stat_segment.h:89
clib_spinlock_t * stat_segment_lockp
Definition: stat_segment.h:125
atomic_int_fast64_t directory_offset
Definition: stat_segment.h:88
stat_directory_type_t type
Definition: stat_segment.h:64