Ole Troan | 2fee167 | 2018-08-23 13:00:53 +0200 | [diff] [blame] | 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 | |
Ole Troan | d577e1f | 2019-04-29 13:38:52 +0200 | [diff] [blame] | 20 | #define STAT_VERSION_MAJOR 1 |
Ole Troan | 233e468 | 2019-05-16 15:01:34 +0200 | [diff] [blame] | 21 | #define STAT_VERSION_MINOR 2 |
Ole Troan | d577e1f | 2019-04-29 13:38:52 +0200 | [diff] [blame] | 22 | |
Ole Troan | 58492a8 | 2018-09-04 13:19:12 +0200 | [diff] [blame] | 23 | #include <stdint.h> |
Ole Troan | 2152e1c | 2018-11-23 23:07:13 +0100 | [diff] [blame] | 24 | #include <unistd.h> |
Ole Troan | 58492a8 | 2018-09-04 13:19:12 +0200 | [diff] [blame] | 25 | #include <vlib/counter_types.h> |
Ole Troan | fdc6780 | 2020-08-10 11:59:20 +0200 | [diff] [blame] | 26 | #include <time.h> |
Dave Barach | 531969e | 2019-08-14 09:35:41 -0400 | [diff] [blame] | 27 | #include <stdbool.h> |
| 28 | #include <vpp/stats/stat_segment_shared.h> |
Ole Troan | 2152e1c | 2018-11-23 23:07:13 +0100 | [diff] [blame] | 29 | |
| 30 | /* Default socket to exchange segment fd */ |
YohanPipereau | 71dd9d5 | 2019-06-06 16:34:14 +0200 | [diff] [blame] | 31 | /* TODO: Get from runtime directory */ |
Ole Troan | 2152e1c | 2018-11-23 23:07:13 +0100 | [diff] [blame] | 32 | #define STAT_SEGMENT_SOCKET_FILE "/run/vpp/stats.sock" |
YohanPipereau | 71dd9d5 | 2019-06-06 16:34:14 +0200 | [diff] [blame] | 33 | #define STAT_SEGMENT_SOCKET_FILENAME "stats.sock" |
Ole Troan | 2152e1c | 2018-11-23 23:07:13 +0100 | [diff] [blame] | 34 | |
Paul Vinciguerra | 5642109 | 2018-11-21 16:34:09 -0800 | [diff] [blame] | 35 | typedef struct |
| 36 | { |
Ole Troan | 2fee167 | 2018-08-23 13:00:53 +0200 | [diff] [blame] | 37 | char *name; |
| 38 | stat_directory_type_t type; |
| 39 | union |
| 40 | { |
Ole Troan | 58492a8 | 2018-09-04 13:19:12 +0200 | [diff] [blame] | 41 | double scalar_value; |
Ole Troan | 233e468 | 2019-05-16 15:01:34 +0200 | [diff] [blame] | 42 | counter_t *error_vector; |
Ole Troan | 2fee167 | 2018-08-23 13:00:53 +0200 | [diff] [blame] | 43 | counter_t **simple_counter_vec; |
| 44 | vlib_counter_t **combined_counter_vec; |
Ole Troan | 703908a | 2019-02-26 16:37:03 +0100 | [diff] [blame] | 45 | uint8_t **name_vector; |
Ole Troan | 2fee167 | 2018-08-23 13:00:53 +0200 | [diff] [blame] | 46 | }; |
| 47 | } stat_segment_data_t; |
| 48 | |
Dave Barach | 531969e | 2019-08-14 09:35:41 -0400 | [diff] [blame] | 49 | typedef struct |
| 50 | { |
| 51 | uint64_t current_epoch; |
| 52 | stat_segment_shared_header_t *shared_header; |
| 53 | stat_segment_directory_entry_t *directory_vector; |
| 54 | ssize_t memory_size; |
Ole Troan | fdc6780 | 2020-08-10 11:59:20 +0200 | [diff] [blame] | 55 | uint64_t timeout; |
Dave Barach | 531969e | 2019-08-14 09:35:41 -0400 | [diff] [blame] | 56 | } stat_client_main_t; |
| 57 | |
| 58 | extern stat_client_main_t stat_client_main; |
| 59 | |
Paul Vinciguerra | 5642109 | 2018-11-21 16:34:09 -0800 | [diff] [blame] | 60 | stat_client_main_t *stat_client_get (void); |
| 61 | void stat_client_free (stat_client_main_t * sm); |
Neale Ranns | 318d794 | 2018-12-03 01:53:32 -0800 | [diff] [blame] | 62 | int stat_segment_connect_r (const char *socket_name, stat_client_main_t * sm); |
| 63 | int stat_segment_connect (const char *socket_name); |
Paul Vinciguerra | 5642109 | 2018-11-21 16:34:09 -0800 | [diff] [blame] | 64 | void stat_segment_disconnect_r (stat_client_main_t * sm); |
Ole Troan | 2fee167 | 2018-08-23 13:00:53 +0200 | [diff] [blame] | 65 | void stat_segment_disconnect (void); |
Mohsin Kazmi | 90a9fdf | 2018-12-04 14:31:15 +0000 | [diff] [blame] | 66 | uint8_t **stat_segment_string_vector (uint8_t ** string_vector, |
| 67 | const char *string); |
Ole Troan | 7320210 | 2018-08-31 00:29:48 +0200 | [diff] [blame] | 68 | int stat_segment_vec_len (void *vec); |
Ole Troan | 8254018 | 2018-10-22 09:41:29 +0200 | [diff] [blame] | 69 | void stat_segment_vec_free (void *vec); |
Paul Vinciguerra | 5642109 | 2018-11-21 16:34:09 -0800 | [diff] [blame] | 70 | uint32_t *stat_segment_ls_r (uint8_t ** patterns, stat_client_main_t * sm); |
Ole Troan | 58492a8 | 2018-09-04 13:19:12 +0200 | [diff] [blame] | 71 | uint32_t *stat_segment_ls (uint8_t ** pattern); |
Paul Vinciguerra | 5642109 | 2018-11-21 16:34:09 -0800 | [diff] [blame] | 72 | stat_segment_data_t *stat_segment_dump_r (uint32_t * stats, |
| 73 | stat_client_main_t * sm); |
Ole Troan | 58492a8 | 2018-09-04 13:19:12 +0200 | [diff] [blame] | 74 | stat_segment_data_t *stat_segment_dump (uint32_t * counter_vec); |
Paul Vinciguerra | 5642109 | 2018-11-21 16:34:09 -0800 | [diff] [blame] | 75 | stat_segment_data_t *stat_segment_dump_entry_r (uint32_t index, |
| 76 | stat_client_main_t * sm); |
Ole Troan | 58492a8 | 2018-09-04 13:19:12 +0200 | [diff] [blame] | 77 | stat_segment_data_t *stat_segment_dump_entry (uint32_t index); |
Ole Troan | 58492a8 | 2018-09-04 13:19:12 +0200 | [diff] [blame] | 78 | |
Paul Vinciguerra | 5642109 | 2018-11-21 16:34:09 -0800 | [diff] [blame] | 79 | void stat_segment_data_free (stat_segment_data_t * res); |
| 80 | double stat_segment_heartbeat_r (stat_client_main_t * sm); |
Ole Troan | 58492a8 | 2018-09-04 13:19:12 +0200 | [diff] [blame] | 81 | double stat_segment_heartbeat (void); |
| 82 | |
Ole Troan | cbb8f58 | 2019-04-15 08:53:46 +0200 | [diff] [blame] | 83 | char *stat_segment_index_to_name_r (uint32_t index, stat_client_main_t * sm); |
Ole Troan | 58492a8 | 2018-09-04 13:19:12 +0200 | [diff] [blame] | 84 | char *stat_segment_index_to_name (uint32_t index); |
Ole Troan | b63dbc5 | 2019-06-14 10:26:14 +0200 | [diff] [blame] | 85 | uint64_t stat_segment_version (void); |
| 86 | uint64_t stat_segment_version_r (stat_client_main_t * sm); |
Ole Troan | 2fee167 | 2018-08-23 13:00:53 +0200 | [diff] [blame] | 87 | |
Dave Barach | 531969e | 2019-08-14 09:35:41 -0400 | [diff] [blame] | 88 | typedef struct |
| 89 | { |
| 90 | uint64_t epoch; |
| 91 | } stat_segment_access_t; |
| 92 | |
Ole Troan | fdc6780 | 2020-08-10 11:59:20 +0200 | [diff] [blame] | 93 | static inline uint64_t |
| 94 | _time_now_nsec (void) |
| 95 | { |
| 96 | struct timespec ts; |
| 97 | clock_gettime (CLOCK_REALTIME, &ts); |
| 98 | return 1e9 * ts.tv_sec + ts.tv_nsec; |
| 99 | } |
| 100 | |
Ole Troan | 7d29e32 | 2020-07-21 08:46:08 +0200 | [diff] [blame] | 101 | static inline void * |
| 102 | stat_segment_adjust (stat_client_main_t * sm, void *data) |
| 103 | { |
Vratko Polak | 18a71d8 | 2020-12-02 18:45:16 +0100 | [diff] [blame^] | 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) |
| 107 | return (void *) p; |
Ole Troan | 65c56c8 | 2020-10-21 11:55:28 +0200 | [diff] [blame] | 108 | return 0; |
Ole Troan | 7d29e32 | 2020-07-21 08:46:08 +0200 | [diff] [blame] | 109 | } |
| 110 | |
Vratko Polak | 9a412bc | 2020-08-14 18:00:33 +0200 | [diff] [blame] | 111 | /* |
| 112 | * Returns 0 on success, -1 on failure (timeout) |
| 113 | */ |
Ole Troan | fdc6780 | 2020-08-10 11:59:20 +0200 | [diff] [blame] | 114 | static inline int |
Dave Barach | 531969e | 2019-08-14 09:35:41 -0400 | [diff] [blame] | 115 | stat_segment_access_start (stat_segment_access_t * sa, |
| 116 | stat_client_main_t * sm) |
| 117 | { |
| 118 | stat_segment_shared_header_t *shared_header = sm->shared_header; |
Ole Troan | fdc6780 | 2020-08-10 11:59:20 +0200 | [diff] [blame] | 119 | uint64_t max_time; |
| 120 | |
Dave Barach | 531969e | 2019-08-14 09:35:41 -0400 | [diff] [blame] | 121 | sa->epoch = shared_header->epoch; |
Ole Troan | fdc6780 | 2020-08-10 11:59:20 +0200 | [diff] [blame] | 122 | if (sm->timeout) |
| 123 | { |
| 124 | max_time = _time_now_nsec () + sm->timeout; |
| 125 | while (shared_header->in_progress != 0 && _time_now_nsec () < max_time) |
| 126 | ; |
| 127 | } |
| 128 | else |
| 129 | { |
| 130 | while (shared_header->in_progress != 0) |
| 131 | ; |
| 132 | } |
Ole Troan | 7d29e32 | 2020-07-21 08:46:08 +0200 | [diff] [blame] | 133 | sm->directory_vector = |
| 134 | (stat_segment_directory_entry_t *) stat_segment_adjust (sm, |
| 135 | (void *) |
| 136 | sm->shared_header->directory_vector); |
Ole Troan | fdc6780 | 2020-08-10 11:59:20 +0200 | [diff] [blame] | 137 | if (sm->timeout) |
| 138 | return _time_now_nsec () < max_time ? 0 : -1; |
| 139 | return 0; |
| 140 | } |
| 141 | |
| 142 | /* |
| 143 | * set maximum number of nano seconds to wait for in_progress state |
| 144 | */ |
| 145 | static inline void |
| 146 | stat_segment_set_timeout_nsec (stat_client_main_t * sm, uint64_t timeout) |
| 147 | { |
| 148 | sm->timeout = timeout; |
Dave Barach | 531969e | 2019-08-14 09:35:41 -0400 | [diff] [blame] | 149 | } |
| 150 | |
Rajesh Goel | 7650086 | 2020-09-03 18:38:03 +0530 | [diff] [blame] | 151 | /* |
| 152 | * set maximum number of nano seconds to wait for in_progress state |
| 153 | * this function can be called directly by module using shared stat |
| 154 | * segment |
| 155 | */ |
| 156 | static inline void |
| 157 | stat_segment_set_timeout (uint64_t timeout) |
| 158 | { |
| 159 | stat_client_main_t *sm = &stat_client_main; |
| 160 | stat_segment_set_timeout_nsec (sm, timeout); |
| 161 | } |
| 162 | |
| 163 | |
Dave Barach | 531969e | 2019-08-14 09:35:41 -0400 | [diff] [blame] | 164 | static inline bool |
| 165 | stat_segment_access_end (stat_segment_access_t * sa, stat_client_main_t * sm) |
| 166 | { |
| 167 | stat_segment_shared_header_t *shared_header = sm->shared_header; |
| 168 | |
| 169 | if (shared_header->epoch != sa->epoch || shared_header->in_progress) |
| 170 | return false; |
| 171 | return true; |
| 172 | } |
| 173 | |
Ole Troan | 2fee167 | 2018-08-23 13:00:53 +0200 | [diff] [blame] | 174 | #endif /* included_stat_client_h */ |
| 175 | |
| 176 | /* |
| 177 | * fd.io coding-style-patch-verification: ON |
| 178 | * |
| 179 | * Local Variables: |
| 180 | * eval: (c-set-style "gnu") |
| 181 | * End: |
| 182 | */ |