blob: aeca63419ee0e85c8ecedd97623380748e582960 [file] [log] [blame]
Ole Troan2fee1672018-08-23 13:00:53 +02001/*
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
Ole Troan58492a82018-09-04 13:19:12 +020020#include <stdint.h>
21#include <vpp/stats/stat_segment.h>
22#include <vlib/counter_types.h>
Ole Troan2fee1672018-08-23 13:00:53 +020023
24typedef struct
25{
Paul Vinciguerra56421092018-11-21 16:34:09 -080026 uint64_t current_epoch;
27 stat_segment_shared_header_t *shared_header;
28 stat_segment_directory_entry_t *directory_vector;
29 ssize_t memory_size;
30} stat_client_main_t;
31
32typedef struct
33{
Ole Troan2fee1672018-08-23 13:00:53 +020034 char *name;
35 stat_directory_type_t type;
36 union
37 {
Ole Troan58492a82018-09-04 13:19:12 +020038 double scalar_value;
39 uint64_t error_value;
Ole Troan2fee1672018-08-23 13:00:53 +020040 counter_t **simple_counter_vec;
41 vlib_counter_t **combined_counter_vec;
42 };
43} stat_segment_data_t;
44
Paul Vinciguerra56421092018-11-21 16:34:09 -080045stat_client_main_t *stat_client_get (void);
46void stat_client_free (stat_client_main_t * sm);
47int stat_segment_connect_r (char *socket_name, stat_client_main_t * sm);
Ole Troan2fee1672018-08-23 13:00:53 +020048int stat_segment_connect (char *socket_name);
Paul Vinciguerra56421092018-11-21 16:34:09 -080049void stat_segment_disconnect_r (stat_client_main_t * sm);
Ole Troan2fee1672018-08-23 13:00:53 +020050void stat_segment_disconnect (void);
Ole Troan58492a82018-09-04 13:19:12 +020051uint8_t **stat_segment_string_vector (uint8_t ** string_vector, char *string);
Ole Troan73202102018-08-31 00:29:48 +020052int stat_segment_vec_len (void *vec);
Ole Troan82540182018-10-22 09:41:29 +020053void stat_segment_vec_free (void *vec);
Paul Vinciguerra56421092018-11-21 16:34:09 -080054uint32_t *stat_segment_ls_r (uint8_t ** patterns, stat_client_main_t * sm);
Ole Troan58492a82018-09-04 13:19:12 +020055uint32_t *stat_segment_ls (uint8_t ** pattern);
Paul Vinciguerra56421092018-11-21 16:34:09 -080056stat_segment_data_t *stat_segment_dump_r (uint32_t * stats,
57 stat_client_main_t * sm);
Ole Troan58492a82018-09-04 13:19:12 +020058stat_segment_data_t *stat_segment_dump (uint32_t * counter_vec);
Paul Vinciguerra56421092018-11-21 16:34:09 -080059stat_segment_data_t *stat_segment_dump_entry_r (uint32_t index,
60 stat_client_main_t * sm);
Ole Troan58492a82018-09-04 13:19:12 +020061stat_segment_data_t *stat_segment_dump_entry (uint32_t index);
Ole Troan58492a82018-09-04 13:19:12 +020062
Paul Vinciguerra56421092018-11-21 16:34:09 -080063void stat_segment_data_free (stat_segment_data_t * res);
64double stat_segment_heartbeat_r (stat_client_main_t * sm);
Ole Troan58492a82018-09-04 13:19:12 +020065double stat_segment_heartbeat (void);
66
67char *stat_segment_index_to_name (uint32_t index);
Ole Troan2fee1672018-08-23 13:00:53 +020068
69#endif /* included_stat_client_h */
70
71/*
72 * fd.io coding-style-patch-verification: ON
73 *
74 * Local Variables:
75 * eval: (c-set-style "gnu")
76 * End:
77 */