FD.io VPP  v19.08.2-294-g37e99c22d
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 <stdbool.h>
28 
29 /* Default socket to exchange segment fd */
30 #define STAT_SEGMENT_SOCKET_FILE "/run/vpp/stats.sock"
31 
32 typedef struct
33 {
34  char *name;
36  union
37  {
38  double scalar_value;
42  uint8_t **name_vector;
43  };
45 
46 typedef struct
47 {
48  uint64_t current_epoch;
51  ssize_t memory_size;
53 
55 
58 int stat_segment_connect_r (const char *socket_name, stat_client_main_t * sm);
59 int stat_segment_connect (const char *socket_name);
61 void stat_segment_disconnect (void);
62 uint8_t **stat_segment_string_vector (uint8_t ** string_vector,
63  const char *string);
64 int stat_segment_vec_len (void *vec);
65 void stat_segment_vec_free (void *vec);
66 uint32_t *stat_segment_ls_r (uint8_t ** patterns, stat_client_main_t * sm);
67 uint32_t *stat_segment_ls (uint8_t ** pattern);
68 stat_segment_data_t *stat_segment_dump_r (uint32_t * stats,
69  stat_client_main_t * sm);
70 stat_segment_data_t *stat_segment_dump (uint32_t * counter_vec);
72  stat_client_main_t * sm);
74 
77 double stat_segment_heartbeat (void);
78 
79 char *stat_segment_index_to_name_r (uint32_t index, stat_client_main_t * sm);
80 char *stat_segment_index_to_name (uint32_t index);
81 uint64_t stat_segment_version (void);
83 
84 typedef struct
85 {
86  uint64_t epoch;
88 
89 static inline void
91  stat_client_main_t * sm)
92 {
93  stat_segment_shared_header_t *shared_header = sm->shared_header;
94  sa->epoch = shared_header->epoch;
95  while (shared_header->in_progress != 0)
96  ;
100 }
101 
102 static inline bool
104 {
105  stat_segment_shared_header_t *shared_header = sm->shared_header;
106 
107  if (shared_header->epoch != sa->epoch || shared_header->in_progress)
108  return false;
109  return true;
110 }
111 
112 
113 #endif /* included_stat_client_h */
114 
115 /*
116  * fd.io coding-style-patch-verification: ON
117  *
118  * Local Variables:
119  * eval: (c-set-style "gnu")
120  * End:
121  */
void stat_segment_data_free(stat_segment_data_t *res)
Definition: stat_client.c:287
static void stat_segment_access_start(stat_segment_access_t *sa, stat_client_main_t *sm)
Definition: stat_client.h:90
int stat_segment_connect(const char *socket_name)
Definition: stat_client.c:151
stat_segment_directory_entry_t * directory_vector
Definition: stat_client.h:50
stat_segment_data_t * stat_segment_dump_r(uint32_t *stats, stat_client_main_t *sm)
Definition: stat_client.c:373
counter_t ** simple_counter_vec
Definition: stat_client.h:40
void stat_client_free(stat_client_main_t *sm)
Definition: stat_client.c:47
Combined counter to hold both packets and byte differences.
Definition: counter_types.h:26
uint32_t * stat_segment_ls(uint8_t **pattern)
Definition: stat_client.c:366
stat_segment_shared_header_t * shared_header
Definition: stat_client.h:49
double stat_segment_heartbeat_r(stat_client_main_t *sm)
Definition: stat_client.c:172
int stat_segment_connect_r(const char *socket_name, stat_client_main_t *sm)
Definition: stat_client.c:93
uint64_t current_epoch
Definition: stat_client.h:48
static void * stat_segment_pointer(void *start, uint64_t offset)
uint64_t counter_t
64bit counters
Definition: counter_types.h:22
uint8_t ** name_vector
Definition: stat_client.h:42
char * stat_segment_index_to_name(uint32_t index)
Definition: stat_client.c:476
char * stat_segment_index_to_name_r(uint32_t index, stat_client_main_t *sm)
Definition: stat_client.c:458
uint32_t * stat_segment_ls_r(uint8_t **patterns, stat_client_main_t *sm)
Definition: stat_client.c:313
stat_segment_data_t * stat_segment_dump(uint32_t *counter_vec)
Definition: stat_client.c:401
uint8_t ** stat_segment_string_vector(uint8_t **string_vector, const char *string)
Definition: stat_client.c:422
stat_directory_type_t
void stat_segment_disconnect_r(stat_client_main_t *sm)
Definition: stat_client.c:158
stat_directory_type_t type
Definition: stat_client.h:35
stat_segment_data_t * stat_segment_dump_entry_r(uint32_t index, stat_client_main_t *sm)
Definition: stat_client.c:433
uint64_t stat_segment_version(void)
Definition: stat_client.c:490
stat_segment_data_t * stat_segment_dump_entry(uint32_t index)
Definition: stat_client.c:451
stat_client_main_t stat_client_main
Definition: stat_client.c:35
void stat_segment_disconnect(void)
Definition: stat_client.c:165
uint64_t stat_segment_version_r(stat_client_main_t *sm)
Definition: stat_client.c:483
int stat_segment_vec_len(void *vec)
Definition: stat_client.c:409
double stat_segment_heartbeat(void)
Definition: stat_client.c:188
vlib_counter_t ** combined_counter_vec
Definition: stat_client.h:41
static bool stat_segment_access_end(stat_segment_access_t *sa, stat_client_main_t *sm)
Definition: stat_client.h:103
stat_client_main_t * stat_client_get(void)
Definition: stat_client.c:38
counter_t * error_vector
Definition: stat_client.h:39
void stat_segment_vec_free(void *vec)
Definition: stat_client.c:415