FD.io VPP  v19.04.3-1-gdfec10d13
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 1
22 
23 #include <stdint.h>
24 #include <unistd.h>
25 #include <vlib/counter_types.h>
26 
27 typedef enum
28 {
36 
37 /* Default socket to exchange segment fd */
38 #define STAT_SEGMENT_SOCKET_FILE "/run/vpp/stats.sock"
39 
41 
42 typedef struct
43 {
44  char *name;
46  union
47  {
48  double scalar_value;
49  uint64_t error_value;
52  uint8_t **name_vector;
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 (uint32_t index);
80 
81 #endif /* included_stat_client_h */
82 
83 /*
84  * fd.io coding-style-patch-verification: ON
85  *
86  * Local Variables:
87  * eval: (c-set-style "gnu")
88  * End:
89  */
void stat_segment_data_free(stat_segment_data_t *res)
Definition: stat_client.c:286
int stat_segment_connect(const char *socket_name)
Definition: stat_client.c:166
stat_segment_data_t * stat_segment_dump_r(uint32_t *stats, stat_client_main_t *sm)
Definition: stat_client.c:400
counter_t ** simple_counter_vec
Definition: stat_client.h:50
void stat_client_free(stat_client_main_t *sm)
Definition: stat_client.c:55
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:393
double stat_segment_heartbeat_r(stat_client_main_t *sm)
Definition: stat_client.c:187
int stat_segment_connect_r(const char *socket_name, stat_client_main_t *sm)
Definition: stat_client.c:108
uint64_t counter_t
64bit counters
Definition: counter_types.h:22
uint8_t ** name_vector
Definition: stat_client.h:52
char * stat_segment_index_to_name(uint32_t index)
Definition: stat_client.c:485
uint32_t * stat_segment_ls_r(uint8_t **patterns, stat_client_main_t *sm)
Definition: stat_client.c:340
stat_segment_data_t * stat_segment_dump(uint32_t *counter_vec)
Definition: stat_client.c:428
uint8_t ** stat_segment_string_vector(uint8_t **string_vector, const char *string)
Definition: stat_client.c:449
void stat_segment_disconnect_r(stat_client_main_t *sm)
Definition: stat_client.c:173
stat_directory_type_t type
Definition: stat_client.h:45
stat_segment_data_t * stat_segment_dump_entry_r(uint32_t index, stat_client_main_t *sm)
Definition: stat_client.c:460
stat_directory_type_t
Definition: stat_client.h:27
stat_segment_data_t * stat_segment_dump_entry(uint32_t index)
Definition: stat_client.c:478
void stat_segment_disconnect(void)
Definition: stat_client.c:180
int stat_segment_vec_len(void *vec)
Definition: stat_client.c:436
double stat_segment_heartbeat(void)
Definition: stat_client.c:195
vlib_counter_t ** combined_counter_vec
Definition: stat_client.h:51
stat_client_main_t * stat_client_get(void)
Definition: stat_client.c:46
uint64_t error_value
Definition: stat_client.h:49
void stat_segment_vec_free(void *vec)
Definition: stat_client.c:442