2 * stat_client.h - Library for access to VPP statistics segment
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:
9 * http://www.apache.org/licenses/LICENSE-2.0
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.
17 #ifndef included_stat_client_h
18 #define included_stat_client_h
22 #include <vlib/counter_types.h>
26 STAT_DIR_TYPE_ILLEGAL = 0,
27 STAT_DIR_TYPE_SCALAR_INDEX,
28 STAT_DIR_TYPE_COUNTER_VECTOR_SIMPLE,
29 STAT_DIR_TYPE_COUNTER_VECTOR_COMBINED,
30 STAT_DIR_TYPE_ERROR_INDEX,
31 } stat_directory_type_t;
33 /* Default socket to exchange segment fd */
34 #define STAT_SEGMENT_SOCKET_FILE "/run/vpp/stats.sock"
36 typedef struct stat_client_main_t stat_client_main_t;
41 stat_directory_type_t type;
46 counter_t **simple_counter_vec;
47 vlib_counter_t **combined_counter_vec;
49 } stat_segment_data_t;
51 stat_client_main_t *stat_client_get (void);
52 void stat_client_free (stat_client_main_t * sm);
53 int stat_segment_connect_r (const char *socket_name, stat_client_main_t * sm);
54 int stat_segment_connect (const char *socket_name);
55 void stat_segment_disconnect_r (stat_client_main_t * sm);
56 void stat_segment_disconnect (void);
57 uint8_t **stat_segment_string_vector (uint8_t ** string_vector,
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);
66 stat_segment_data_t *stat_segment_dump_entry_r (uint32_t index,
67 stat_client_main_t * sm);
68 stat_segment_data_t *stat_segment_dump_entry (uint32_t index);
70 void stat_segment_data_free (stat_segment_data_t * res);
71 double stat_segment_heartbeat_r (stat_client_main_t * sm);
72 double stat_segment_heartbeat (void);
74 char *stat_segment_index_to_name (uint32_t index);
76 #endif /* included_stat_client_h */
79 * fd.io coding-style-patch-verification: ON
82 * eval: (c-set-style "gnu")