FD.io VPP  v19.01.3-6-g70449b9b9
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 #include <stdint.h>
21 #include <unistd.h>
22 #include <vlib/counter_types.h>
23 
24 typedef enum
25 {
32 
33 /* Default socket to exchange segment fd */
34 #define STAT_SEGMENT_SOCKET_FILE "/run/vpp/stats.sock"
35 
37 
38 typedef struct
39 {
40  char *name;
42  union
43  {
44  double scalar_value;
45  uint64_t error_value;
48  };
50 
53 int stat_segment_connect_r (const char *socket_name, stat_client_main_t * sm);
54 int stat_segment_connect (const char *socket_name);
56 void stat_segment_disconnect (void);
57 uint8_t **stat_segment_string_vector (uint8_t ** string_vector,
58  const char *string);
59 int stat_segment_vec_len (void *vec);
60 void stat_segment_vec_free (void *vec);
61 uint32_t *stat_segment_ls_r (uint8_t ** patterns, stat_client_main_t * sm);
62 uint32_t *stat_segment_ls (uint8_t ** pattern);
63 stat_segment_data_t *stat_segment_dump_r (uint32_t * stats,
64  stat_client_main_t * sm);
65 stat_segment_data_t *stat_segment_dump (uint32_t * counter_vec);
67  stat_client_main_t * sm);
69 
72 double stat_segment_heartbeat (void);
73 
74 char *stat_segment_index_to_name (uint32_t index);
75 
76 #endif /* included_stat_client_h */
77 
78 /*
79  * fd.io coding-style-patch-verification: ON
80  *
81  * Local Variables:
82  * eval: (c-set-style "gnu")
83  * End:
84  */
void stat_segment_data_free(stat_segment_data_t *res)
Definition: stat_client.c:262
int stat_segment_connect(const char *socket_name)
Definition: stat_client.c:163
stat_segment_data_t * stat_segment_dump_r(uint32_t *stats, stat_client_main_t *sm)
Definition: stat_client.c:374
counter_t ** simple_counter_vec
Definition: stat_client.h:46
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:367
double stat_segment_heartbeat_r(stat_client_main_t *sm)
Definition: stat_client.c:184
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
char * stat_segment_index_to_name(uint32_t index)
Definition: stat_client.c:459
uint32_t * stat_segment_ls_r(uint8_t **patterns, stat_client_main_t *sm)
Definition: stat_client.c:314
stat_segment_data_t * stat_segment_dump(uint32_t *counter_vec)
Definition: stat_client.c:402
uint8_t ** stat_segment_string_vector(uint8_t **string_vector, const char *string)
Definition: stat_client.c:423
void stat_segment_disconnect_r(stat_client_main_t *sm)
Definition: stat_client.c:170
stat_directory_type_t type
Definition: stat_client.h:41
stat_segment_data_t * stat_segment_dump_entry_r(uint32_t index, stat_client_main_t *sm)
Definition: stat_client.c:434
stat_directory_type_t
Definition: stat_client.h:24
stat_segment_data_t * stat_segment_dump_entry(uint32_t index)
Definition: stat_client.c:452
void stat_segment_disconnect(void)
Definition: stat_client.c:177
int stat_segment_vec_len(void *vec)
Definition: stat_client.c:410
double stat_segment_heartbeat(void)
Definition: stat_client.c:192
vlib_counter_t ** combined_counter_vec
Definition: stat_client.h:47
stat_client_main_t * stat_client_get(void)
Definition: stat_client.c:46
uint64_t error_value
Definition: stat_client.h:45
void stat_segment_vec_free(void *vec)
Definition: stat_client.c:416