FD.io VPP  v21.10.1-2-g0a485f517
Vector Packet Processing
stat_client.h
Go to the documentation of this file.
1 /*
2  * stat_client.h - Library for access to VPP statistics segment
3  *
4  * Copyright (c) 2018 Cisco and/or its affiliates.
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at:
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  */
17 #ifndef included_stat_client_h
18 #define included_stat_client_h
19 
20 #define STAT_VERSION_MAJOR 1
21 #define STAT_VERSION_MINOR 2
22 
23 #include <stdint.h>
24 #include <unistd.h>
25 #include <vlib/counter_types.h>
26 #include <time.h>
27 #include <stdbool.h>
29 
30 /* Default socket to exchange segment fd */
31 /* TODO: Get from runtime directory */
32 #define STAT_SEGMENT_SOCKET_FILE "/run/vpp/stats.sock"
33 #define STAT_SEGMENT_SOCKET_FILENAME "stats.sock"
34 
35 typedef struct
36 {
37  char *name;
39  union
40  {
41  double scalar_value;
45  uint8_t **name_vector;
46  };
48 
49 typedef struct
50 {
51  uint64_t current_epoch;
54  ssize_t memory_size;
55  uint64_t timeout;
57 
59 
62 int stat_segment_connect_r (const char *socket_name, stat_client_main_t * sm);
63 int stat_segment_connect (const char *socket_name);
65 void stat_segment_disconnect (void);
66 uint8_t **stat_segment_string_vector (uint8_t ** string_vector,
67  const char *string);
68 int stat_segment_vec_len (void *vec);
69 void stat_segment_vec_free (void *vec);
70 uint32_t *stat_segment_ls_r (uint8_t ** patterns, stat_client_main_t * sm);
71 uint32_t *stat_segment_ls (uint8_t ** pattern);
73  stat_client_main_t * sm);
74 stat_segment_data_t *stat_segment_dump (uint32_t * counter_vec);
76  stat_client_main_t * sm);
78 
81 double stat_segment_heartbeat (void);
82 
84 char *stat_segment_index_to_name (uint32_t index);
85 uint64_t stat_segment_version (void);
87 
88 typedef struct
89 {
90  uint64_t epoch;
92 
93 static inline uint64_t
94 _time_now_nsec (void)
95 {
96  struct timespec ts;
97  clock_gettime (CLOCK_REALTIME, &ts);
98  return 1e9 * ts.tv_sec + ts.tv_nsec;
99 }
100 
101 static inline void *
103 {
104  char *csh = (char *) sm->shared_header;
105  char *p = csh + ((char *) data - (char *) sm->shared_header->base);
106  if (p > csh && p + sizeof (p) < csh + sm->memory_size)
107  return (void *) p;
108  return 0;
109 }
110 
111 /*
112  * Returns 0 on success, -1 on failure (timeout)
113  */
114 static inline int
116  stat_client_main_t * sm)
117 {
118  stat_segment_shared_header_t *shared_header = sm->shared_header;
119  uint64_t max_time;
120 
121  sa->epoch = shared_header->epoch;
122  if (sm->timeout)
123  {
124  max_time = _time_now_nsec () + sm->timeout;
125  while (shared_header->in_progress != 0 && _time_now_nsec () < max_time)
126  ;
127  }
128  else
129  {
130  while (shared_header->in_progress != 0)
131  ;
132  }
133  sm->directory_vector =
135  (void *)
137  if (sm->timeout)
138  return _time_now_nsec () < max_time ? 0 : -1;
139  return 0;
140 }
141 
142 /*
143  * set maximum number of nano seconds to wait for in_progress state
144  */
145 static inline void
147 {
148  sm->timeout = timeout;
149 }
150 
151 /*
152  * set maximum number of nano seconds to wait for in_progress state
153  * this function can be called directly by module using shared stat
154  * segment
155  */
156 static inline void
157 stat_segment_set_timeout (uint64_t timeout)
158 {
160  stat_segment_set_timeout_nsec (sm, timeout);
161 }
162 
163 
164 static inline bool
166 {
167  stat_segment_shared_header_t *shared_header = sm->shared_header;
168 
169  if (shared_header->epoch != sa->epoch || shared_header->in_progress)
170  return false;
171  return true;
172 }
173 
174 #endif /* included_stat_client_h */
175 
176 /*
177  * fd.io coding-style-patch-verification: ON
178  *
179  * Local Variables:
180  * eval: (c-set-style "gnu")
181  * End:
182  */
stat_segment_index_to_name
char * stat_segment_index_to_name(uint32_t index)
Definition: stat_client.c:523
stat_client_main_t::directory_vector
stat_segment_directory_entry_t * directory_vector
Definition: stat_client.h:53
stat_segment_dump_entry_r
stat_segment_data_t * stat_segment_dump_entry_r(uint32_t index, stat_client_main_t *sm)
Definition: stat_client.c:474
stat_segment_shared_header_t::base
void * base
Definition: stat_segment_shared.h:53
counter_types.h
stat_segment_data_t::simple_counter_vec
counter_t ** simple_counter_vec
Definition: stat_client.h:43
stat_segment_version_r
uint64_t stat_segment_version_r(stat_client_main_t *sm)
Definition: stat_client.c:530
stat_segment_data_t::error_vector
counter_t * error_vector
Definition: stat_client.h:42
stat_segment_version
uint64_t stat_segment_version(void)
Definition: stat_client.c:537
stat_segment_access_t
Definition: stat_client.h:88
stat_segment_data_t::name_vector
uint8_t ** name_vector
Definition: stat_client.h:45
stat_client_main
stat_client_main_t stat_client_main
Definition: stat_client.c:35
stat_segment_vec_len
int stat_segment_vec_len(void *vec)
Definition: stat_client.c:450
stat_segment_access_t::epoch
uint64_t epoch
Definition: stat_client.h:90
stat_directory_type_t
stat_directory_type_t
Definition: stat_segment_shared.h:19
stat_segment_vec_free
void stat_segment_vec_free(void *vec)
Definition: stat_client.c:456
stat_segment_dump
stat_segment_data_t * stat_segment_dump(uint32_t *counter_vec)
Definition: stat_client.c:442
stats
vl_api_ikev2_sa_stats_t stats
Definition: ikev2_types.api:162
stat_segment_data_t::scalar_value
double scalar_value
Definition: stat_client.h:41
stat_segment_data_free
void stat_segment_data_free(stat_segment_data_t *res)
Definition: stat_client.c:315
stat_segment_access_start
static int stat_segment_access_start(stat_segment_access_t *sa, stat_client_main_t *sm)
Definition: stat_client.h:115
stat_segment_set_timeout
static void stat_segment_set_timeout(uint64_t timeout)
Definition: stat_client.h:157
stat_segment_access_end
static bool stat_segment_access_end(stat_segment_access_t *sa, stat_client_main_t *sm)
Definition: stat_client.h:165
stat_client_main_t::current_epoch
uint64_t current_epoch
Definition: stat_client.h:51
stat_segment_connect
int stat_segment_connect(const char *socket_name)
Definition: stat_client.c:151
vlib_counter_t
Combined counter to hold both packets and byte differences.
Definition: counter_types.h:26
stat_client_get
stat_client_main_t * stat_client_get(void)
Definition: stat_client.c:38
counter_t
uint64_t counter_t
64bit counters
Definition: counter_types.h:22
stat_client_main_t::shared_header
stat_segment_shared_header_t * shared_header
Definition: stat_client.h:52
stat_segment_shared_header_t::directory_vector
volatile stat_segment_directory_entry_t * directory_vector
Definition: stat_segment_shared.h:56
stat_segment_connect_r
int stat_segment_connect_r(const char *socket_name, stat_client_main_t *sm)
Definition: stat_client.c:93
stat_segment_dump_r
stat_segment_data_t * stat_segment_dump_r(uint32_t *stats, stat_client_main_t *sm)
Definition: stat_client.c:412
stat_segment_dump_entry
stat_segment_data_t * stat_segment_dump_entry(uint32_t index)
Definition: stat_client.c:497
stat_segment_disconnect
void stat_segment_disconnect(void)
Definition: stat_client.c:165
time.h
stat_segment_heartbeat
double stat_segment_heartbeat(void)
Definition: stat_client.c:189
stat_client_main_t::memory_size
ssize_t memory_size
Definition: stat_client.h:54
stat_segment_ls_r
uint32_t * stat_segment_ls_r(uint8_t **patterns, stat_client_main_t *sm)
Definition: stat_client.c:351
stat_segment_heartbeat_r
double stat_segment_heartbeat_r(stat_client_main_t *sm)
Definition: stat_client.c:172
stat_client_main_t::timeout
uint64_t timeout
Definition: stat_client.h:55
stat_segment_ls
uint32_t * stat_segment_ls(uint8_t **pattern)
Definition: stat_client.c:405
stat_segment_shared_header_t
Definition: stat_segment_shared.h:50
data
u8 data[128]
Definition: ipsec_types.api:95
stat_segment_index_to_name_r
char * stat_segment_index_to_name_r(uint32_t index, stat_client_main_t *sm)
Definition: stat_client.c:504
stat_segment_directory_entry_t
Definition: stat_segment_shared.h:31
stat_segment_shared_header_t::in_progress
volatile uint64_t in_progress
Definition: stat_segment_shared.h:55
index
u32 index
Definition: flow_types.api:221
stat_segment_data_t
Definition: stat_client.h:35
stat_segment_set_timeout_nsec
static void stat_segment_set_timeout_nsec(stat_client_main_t *sm, uint64_t timeout)
Definition: stat_client.h:146
stat_segment_data_t::combined_counter_vec
vlib_counter_t ** combined_counter_vec
Definition: stat_client.h:44
stat_segment_data_t::type
stat_directory_type_t type
Definition: stat_client.h:38
stat_segment_adjust
static void * stat_segment_adjust(stat_client_main_t *sm, void *data)
Definition: stat_client.h:102
stat_segment_disconnect_r
void stat_segment_disconnect_r(stat_client_main_t *sm)
Definition: stat_client.c:158
stat_client_main_t
Definition: stat_client.h:49
stat_segment_data_t::name
char * name
Definition: stat_client.h:37
stat_segment_shared.h
stat_client_free
void stat_client_free(stat_client_main_t *sm)
Definition: stat_client.c:47
stat_segment_string_vector
uint8_t ** stat_segment_string_vector(uint8_t **string_vector, const char *string)
Definition: stat_client.c:463
stat_segment_shared_header_t::epoch
volatile uint64_t epoch
Definition: stat_segment_shared.h:54