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
20 #define STAT_VERSION_MAJOR 1
21 #define STAT_VERSION_MINOR 2
25 #include <vlib/counter_types.h>
28 #include <vlib/stats/shared.h>
30 /* Default socket to exchange segment fd */
31 /* TODO: Get from runtime directory */
32 #define STAT_SEGMENT_SOCKET_FILE "/run/vpp/stats.sock"
33 #define STAT_SEGMENT_SOCKET_FILENAME "stats.sock"
38 stat_directory_type_t type;
42 counter_t *error_vector;
43 counter_t **simple_counter_vec;
44 vlib_counter_t **combined_counter_vec;
45 uint8_t **name_vector;
47 } stat_segment_data_t;
51 uint64_t current_epoch;
52 vlib_stats_shared_header_t *shared_header;
53 vlib_stats_entry_t *directory_vector;
58 extern stat_client_main_t stat_client_main;
60 stat_client_main_t *stat_client_get (void);
61 void stat_client_free (stat_client_main_t * sm);
62 int stat_segment_connect_r (const char *socket_name, stat_client_main_t * sm);
63 int stat_segment_connect (const char *socket_name);
64 void stat_segment_disconnect_r (stat_client_main_t * sm);
65 void stat_segment_disconnect (void);
66 uint8_t **stat_segment_string_vector (uint8_t ** string_vector,
68 int stat_segment_vec_len (void *vec);
69 void stat_segment_vec_free (void *vec);
70 uint32_t *stat_segment_ls_r (uint8_t ** patterns, stat_client_main_t * sm);
71 uint32_t *stat_segment_ls (uint8_t ** pattern);
72 stat_segment_data_t *stat_segment_dump_r (uint32_t * stats,
73 stat_client_main_t * sm);
74 stat_segment_data_t *stat_segment_dump (uint32_t * counter_vec);
75 stat_segment_data_t *stat_segment_dump_entry_r (uint32_t index,
76 stat_client_main_t * sm);
77 stat_segment_data_t *stat_segment_dump_entry (uint32_t index);
79 void stat_segment_data_free (stat_segment_data_t * res);
80 double stat_segment_heartbeat_r (stat_client_main_t * sm);
81 double stat_segment_heartbeat (void);
83 char *stat_segment_index_to_name_r (uint32_t index, stat_client_main_t * sm);
84 char *stat_segment_index_to_name (uint32_t index);
85 uint64_t stat_segment_version (void);
86 uint64_t stat_segment_version_r (stat_client_main_t * sm);
91 } stat_segment_access_t;
93 static inline uint64_t
97 clock_gettime (CLOCK_REALTIME, &ts);
98 return 1e9 * ts.tv_sec + ts.tv_nsec;
102 stat_segment_adjust (stat_client_main_t * sm, void *data)
104 char *csh = (char *) sm->shared_header;
105 char *p = csh + ((char *) data - (char *) sm->shared_header->base);
106 if (p > csh && p + sizeof (p) < csh + sm->memory_size)
112 * Returns 0 on success, -1 on failure (timeout)
115 stat_segment_access_start (stat_segment_access_t * sa,
116 stat_client_main_t * sm)
118 vlib_stats_shared_header_t *shared_header = sm->shared_header;
121 sa->epoch = shared_header->epoch;
124 max_time = _time_now_nsec () + sm->timeout;
125 while (shared_header->in_progress != 0 && _time_now_nsec () < max_time)
130 while (shared_header->in_progress != 0)
133 sm->directory_vector = (vlib_stats_entry_t *) stat_segment_adjust (
134 sm, (void *) sm->shared_header->directory_vector);
136 return _time_now_nsec () < max_time ? 0 : -1;
141 * set maximum number of nano seconds to wait for in_progress state
144 stat_segment_set_timeout_nsec (stat_client_main_t * sm, uint64_t timeout)
146 sm->timeout = timeout;
150 * set maximum number of nano seconds to wait for in_progress state
151 * this function can be called directly by module using shared stat
155 stat_segment_set_timeout (uint64_t timeout)
157 stat_client_main_t *sm = &stat_client_main;
158 stat_segment_set_timeout_nsec (sm, timeout);
163 stat_segment_access_end (stat_segment_access_t * sa, stat_client_main_t * sm)
165 vlib_stats_shared_header_t *shared_header = sm->shared_header;
167 if (shared_header->epoch != sa->epoch || shared_header->in_progress)
172 #endif /* included_stat_client_h */
175 * fd.io coding-style-patch-verification: ON
178 * eval: (c-set-style "gnu")