Commit | Line | Data |
---|---|---|
1670bffd PP |
1 | #ifndef BABELTRACE_COMMON_INTERNAL_H |
2 | #define BABELTRACE_COMMON_INTERNAL_H | |
3 | ||
d94d92ac PP |
4 | /* |
5 | * Copyright (c) 2018 EfficiOS Inc. and Linux Foundation | |
6 | * Copyright (c) 2018 Philippe Proulx <pproulx@efficios.com> | |
7 | * | |
8 | * Permission is hereby granted, free of charge, to any person obtaining a copy | |
9 | * of this software and associated documentation files (the "Software"), to deal | |
10 | * in the Software without restriction, including without limitation the rights | |
11 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |
12 | * copies of the Software, and to permit persons to whom the Software is | |
13 | * furnished to do so, subject to the following conditions: | |
14 | * | |
15 | * The above copyright notice and this permission notice shall be included in | |
16 | * all copies or substantial portions of the Software. | |
17 | * | |
18 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
19 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
20 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |
21 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
22 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |
23 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | |
24 | * SOFTWARE. | |
25 | */ | |
26 | ||
91d81473 MJ |
27 | #include <errno.h> |
28 | #include <glib.h> | |
44c440bc | 29 | #include <inttypes.h> |
282b829b | 30 | #include <stdarg.h> |
91d81473 | 31 | #include <stdbool.h> |
44c440bc | 32 | #include <stdint.h> |
91d81473 | 33 | #include <stdlib.h> |
282b829b | 34 | #include <unistd.h> |
91d81473 MJ |
35 | |
36 | #include <babeltrace2/graph/self-message-iterator.h> | |
37 | #include <babeltrace2/trace-ir/event-class-const.h> | |
38 | #include <babeltrace2/trace-ir/field-class-const.h> | |
39 | #include <babeltrace2/trace-ir/field-path-const.h> | |
0ee90b74 | 40 | #include <babeltrace2/logging.h> |
91d81473 MJ |
41 | #include <babeltrace2/value.h> |
42 | ||
43 | #include "common/assert.h" | |
44 | #include "common/macros.h" | |
45 | #include "common/safe.h" | |
1670bffd | 46 | |
ad96d936 PP |
47 | #define BT_COMMON_COLOR_RESET "\033[0m" |
48 | #define BT_COMMON_COLOR_BOLD "\033[1m" | |
49 | #define BT_COMMON_COLOR_FG_DEFAULT "\033[39m" | |
50 | #define BT_COMMON_COLOR_FG_RED "\033[31m" | |
51 | #define BT_COMMON_COLOR_FG_GREEN "\033[32m" | |
52 | #define BT_COMMON_COLOR_FG_YELLOW "\033[33m" | |
53 | #define BT_COMMON_COLOR_FG_BLUE "\033[34m" | |
54 | #define BT_COMMON_COLOR_FG_MAGENTA "\033[35m" | |
55 | #define BT_COMMON_COLOR_FG_CYAN "\033[36m" | |
56 | #define BT_COMMON_COLOR_FG_LIGHT_GRAY "\033[37m" | |
57 | #define BT_COMMON_COLOR_BG_DEFAULT "\033[49m" | |
58 | #define BT_COMMON_COLOR_BG_RED "\033[41m" | |
59 | #define BT_COMMON_COLOR_BG_GREEN "\033[42m" | |
60 | #define BT_COMMON_COLOR_BG_YELLOW "\033[43m" | |
61 | #define BT_COMMON_COLOR_BG_BLUE "\033[44m" | |
62 | #define BT_COMMON_COLOR_BG_MAGENTA "\033[45m" | |
63 | #define BT_COMMON_COLOR_BG_CYAN "\033[46m" | |
64 | #define BT_COMMON_COLOR_BG_LIGHT_GRAY "\033[47m" | |
65 | ||
db0f160a PP |
66 | struct bt_common_lttng_live_url_parts { |
67 | GString *proto; | |
68 | GString *hostname; | |
69 | GString *target_hostname; | |
70 | GString *session_name; | |
71 | ||
72 | /* -1 means default port */ | |
73 | int port; | |
74 | }; | |
75 | ||
6eecdc5f PP |
76 | /* |
77 | * Checks if the current process has setuid or setgid access rights. | |
78 | * Returns `true` if so. | |
79 | */ | |
1670bffd PP |
80 | BT_HIDDEN |
81 | bool bt_common_is_setuid_setgid(void); | |
82 | ||
6eecdc5f PP |
83 | /* |
84 | * Returns the system-wide plugin path, e.g. | |
d9676d8c | 85 | * `/usr/lib/babeltrace2/plugins`. Do not free the return value. |
6eecdc5f | 86 | */ |
1670bffd PP |
87 | BT_HIDDEN |
88 | const char *bt_common_get_system_plugin_path(void); | |
89 | ||
6eecdc5f PP |
90 | /* |
91 | * Returns the user plugin path, e.g. | |
d9676d8c | 92 | * `/home/user/.local/lib/babeltrace2/plugins`. You need to free the |
6eecdc5f PP |
93 | * return value. |
94 | */ | |
1670bffd PP |
95 | BT_HIDDEN |
96 | char *bt_common_get_home_plugin_path(void); | |
97 | ||
6eecdc5f PP |
98 | /* |
99 | * Appends the list of directories in `paths` to the array `dirs`. | |
100 | * `paths` is a list of directories separated by `:`. Returns 0 on | |
101 | * success. | |
102 | */ | |
1670bffd PP |
103 | BT_HIDDEN |
104 | int bt_common_append_plugin_path_dirs(const char *paths, GPtrArray *dirs); | |
105 | ||
6eecdc5f PP |
106 | /* |
107 | * Returns `true` if terminal color codes are supported for this | |
108 | * process. | |
109 | */ | |
ad96d936 PP |
110 | BT_HIDDEN |
111 | bool bt_common_colors_supported(void); | |
112 | ||
290725f7 PP |
113 | BT_HIDDEN |
114 | const char *bt_common_color_reset(void); | |
115 | ||
116 | BT_HIDDEN | |
117 | const char *bt_common_color_bold(void); | |
118 | ||
119 | BT_HIDDEN | |
120 | const char *bt_common_color_fg_default(void); | |
121 | ||
122 | BT_HIDDEN | |
123 | const char *bt_common_color_fg_red(void); | |
124 | ||
125 | BT_HIDDEN | |
126 | const char *bt_common_color_fg_green(void); | |
127 | ||
128 | BT_HIDDEN | |
129 | const char *bt_common_color_fg_yellow(void); | |
130 | ||
131 | BT_HIDDEN | |
132 | const char *bt_common_color_fg_blue(void); | |
133 | ||
134 | BT_HIDDEN | |
135 | const char *bt_common_color_fg_magenta(void); | |
136 | ||
137 | BT_HIDDEN | |
138 | const char *bt_common_color_fg_cyan(void); | |
139 | ||
140 | BT_HIDDEN | |
141 | const char *bt_common_color_fg_light_gray(void); | |
142 | ||
143 | BT_HIDDEN | |
144 | const char *bt_common_color_bg_default(void); | |
145 | ||
146 | BT_HIDDEN | |
147 | const char *bt_common_color_bg_red(void); | |
148 | ||
149 | BT_HIDDEN | |
150 | const char *bt_common_color_bg_green(void); | |
151 | ||
152 | BT_HIDDEN | |
153 | const char *bt_common_color_bg_yellow(void); | |
154 | ||
155 | BT_HIDDEN | |
156 | const char *bt_common_color_bg_blue(void); | |
157 | ||
158 | BT_HIDDEN | |
159 | const char *bt_common_color_bg_magenta(void); | |
160 | ||
161 | BT_HIDDEN | |
162 | const char *bt_common_color_bg_cyan(void); | |
163 | ||
164 | BT_HIDDEN | |
165 | const char *bt_common_color_bg_light_gray(void); | |
166 | ||
6eecdc5f PP |
167 | /* |
168 | * Returns the substring from `input` to the first character found | |
169 | * in the list of characters `end_chars`, unescaping any character | |
170 | * found in `escapable_chars`, and sets `*end_pos` to the position of | |
171 | * the end (from `input`). The caller owns the returned GString. | |
172 | */ | |
db0f160a PP |
173 | BT_HIDDEN |
174 | GString *bt_common_string_until(const char *input, const char *escapable_chars, | |
175 | const char *end_chars, size_t *end_pos); | |
176 | ||
6eecdc5f PP |
177 | /* |
178 | * Returns the quoted version of `input` for a shell. If | |
179 | * `with_single_quotes` is `true`, prepends and appends the `'` prefix | |
180 | * and suffix to the returned string; otherwise the caller should | |
181 | * prepend and append them manually, although they are not always | |
182 | * required. The caller owns the returned GString. | |
183 | */ | |
db0f160a | 184 | BT_HIDDEN |
36b405c6 | 185 | GString *bt_common_shell_quote(const char *input, bool with_single_quotes); |
db0f160a | 186 | |
6eecdc5f PP |
187 | /* |
188 | * Returns `true` if `input` is a string made only of printable | |
189 | * characters. | |
190 | */ | |
db0f160a PP |
191 | BT_HIDDEN |
192 | bool bt_common_string_is_printable(const char *input); | |
193 | ||
6eecdc5f PP |
194 | /* |
195 | * Destroys the parts of an LTTng live URL as returned by | |
196 | * bt_common_parse_lttng_live_url(). | |
197 | */ | |
db0f160a PP |
198 | BT_HIDDEN |
199 | void bt_common_destroy_lttng_live_url_parts( | |
200 | struct bt_common_lttng_live_url_parts *parts); | |
201 | ||
6eecdc5f PP |
202 | /* |
203 | * Parses the LTTng live URL `url` and returns its different parts. | |
204 | * If there's an error, writes the error message into `*error_buf` | |
205 | * up to `error_buf_size` bytes. You must destroy the returned value | |
206 | * with bt_common_destroy_lttng_live_url_parts(). | |
207 | */ | |
db0f160a PP |
208 | BT_HIDDEN |
209 | struct bt_common_lttng_live_url_parts bt_common_parse_lttng_live_url( | |
210 | const char *url, char *error_buf, size_t error_buf_size); | |
211 | ||
6eecdc5f PP |
212 | /* |
213 | * Normalizes (in place) a star globbing pattern to be used with | |
214 | * bt_common_star_glob_match(). This function always succeeds. | |
215 | */ | |
9009cc24 PP |
216 | BT_HIDDEN |
217 | void bt_common_normalize_star_glob_pattern(char *pattern); | |
218 | ||
6eecdc5f PP |
219 | /* |
220 | * Returns `true` if `candidate` (of size `candidate_len`) matches | |
221 | * the star globbing pattern `pattern` (of size `pattern_len`). | |
222 | */ | |
9009cc24 PP |
223 | BT_HIDDEN |
224 | bool bt_common_star_glob_match(const char *pattern, size_t pattern_len, | |
225 | const char *candidate, size_t candidate_len); | |
226 | ||
6eecdc5f PP |
227 | /* |
228 | * Normalizes the path `path`: | |
229 | * | |
230 | * * If it's a relative path, converts it to an absolute path using | |
231 | * `wd` as the working directory (or the current working directory | |
232 | * if `wd` is NULL). | |
233 | * * Removes consecutive and trailing slashes. | |
234 | * * Resolves `..` and `.` in the path (both in `path` and in `wd`). | |
235 | * * Does NOT resolve symbolic links. | |
236 | * | |
237 | * The caller owns the returned GString. | |
238 | */ | |
e49a18d1 PP |
239 | BT_HIDDEN |
240 | GString *bt_common_normalize_path(const char *path, const char *wd); | |
241 | ||
85cd02cf PP |
242 | typedef void (* bt_common_handle_custom_specifier_func)(void *priv_data, |
243 | char **buf, size_t avail_size, const char **fmt, va_list *args); | |
244 | ||
245 | /* | |
246 | * This is a custom vsnprintf() which handles the standard conversion | |
247 | * specifier as well as custom ones. | |
248 | * | |
249 | * `fmt` is a typical printf()-style format string, with the following | |
250 | * limitations: | |
251 | * | |
252 | * * The `*` width specifier is not accepted. | |
253 | * * The `*` precision specifier is not accepted. | |
254 | * * The `j` and `t` length modifiers are not accepted. | |
255 | * * The `n` format specifier is not accepted. | |
256 | * * The format specifiers defined in <inttypes.h> are not accepted | |
257 | * except for `PRId64`, `PRIu64`, `PRIx64`, `PRIX64`, `PRIo64`, and | |
258 | * `PRIi64`. | |
259 | * | |
260 | * `intro` specifies which special character immediately following an | |
261 | * introductory `%` character in `fmt` is used to indicate a custom | |
262 | * conversion specifier. For example, if `intro` is '@', then any `%@` | |
263 | * sequence in `fmt` is the beginning of a custom conversion specifier. | |
264 | * | |
265 | * When a custom conversion specifier is encountered in `fmt`, | |
266 | * the function calls `handle_specifier`. This callback receives: | |
267 | * | |
268 | * `priv_data`: | |
269 | * Custom, private data. | |
270 | * | |
271 | * `buf`: | |
272 | * Address of the current buffer pointer. `*buf` is the position to | |
273 | * append new data. The callback must update `*buf` when appending | |
274 | * new data. The callback must ensure not to write passed the whole | |
275 | * buffer passed to bt_common_custom_vsnprintf(). | |
276 | * | |
277 | * `avail_size`: | |
278 | * Number of bytes left in whole buffer from the `*buf` point. | |
279 | * | |
280 | * `fmt`: | |
281 | * Address of the current format string pointer. `*fmt` points to | |
282 | * the introductory `%` character, which is followed by the | |
283 | * character `intro`. The callback must update `*fmt` so that it | |
284 | * points after the whole custom conversion specifier. | |
285 | * | |
286 | * `args`: | |
287 | * Variable argument list. Use va_arg() to get new arguments from | |
288 | * this list and update it at the same time. | |
289 | * | |
290 | * Because this is an internal utility, this function and its callback | |
291 | * do not return error codes: they abort when there's any error (bad | |
292 | * format string, for example). | |
293 | */ | |
294 | BT_HIDDEN | |
295 | void bt_common_custom_vsnprintf(char *buf, size_t buf_size, | |
296 | char intro, | |
297 | bt_common_handle_custom_specifier_func handle_specifier, | |
298 | void *priv_data, const char *fmt, va_list *args); | |
299 | ||
300 | /* | |
301 | * Variadic form of bt_common_custom_vsnprintf(). | |
302 | */ | |
303 | BT_HIDDEN | |
304 | void bt_common_custom_snprintf(char *buf, size_t buf_size, | |
305 | char intro, | |
306 | bt_common_handle_custom_specifier_func handle_specifier, | |
307 | void *priv_data, const char *fmt, ...); | |
308 | ||
108e5a1e | 309 | /* |
85cd02cf | 310 | * Returns the system page size. |
108e5a1e MJ |
311 | */ |
312 | BT_HIDDEN | |
313 | size_t bt_common_get_page_size(void); | |
314 | ||
ae83436e PP |
315 | /* |
316 | * Adds the digit separator `sep` as many times as needed to form groups | |
317 | * of `digits_per_group` digits within `str`. `str` must have enough | |
318 | * room to accomodate the new separators, that is: | |
319 | * | |
320 | * strlen(str) + (strlen(str) / digits_per_group) + 1 | |
321 | * | |
322 | * Example: with `str` `1983198398213`, `digits_per_group` 3, and `sep` | |
323 | * `,`, `str` becomes `1,983,198,398,213`. | |
324 | * | |
325 | * `strlen(str)` must not be 0. `digits_per_group` must not be 0. `sep` | |
326 | * must not be `\0`. | |
327 | */ | |
328 | BT_HIDDEN | |
329 | void bt_common_sep_digits(char *str, unsigned int digits_per_group, char sep); | |
330 | ||
282b829b FD |
331 | /* |
332 | * Wraps read() function to handle EINTR and partial reads. | |
333 | * On success, it returns `count` received as parameter. On error, it returns a | |
334 | * value smaller than the requested `count`. | |
335 | */ | |
336 | static inline | |
337 | ssize_t bt_common_read(int fd, void *buf, size_t count) | |
338 | { | |
339 | size_t i = 0; | |
340 | ssize_t ret; | |
341 | ||
342 | BT_ASSERT(buf); | |
343 | ||
344 | /* Never return an overflow value. */ | |
345 | BT_ASSERT(count <= SSIZE_MAX); | |
346 | ||
347 | do { | |
348 | ret = read(fd, buf + i, count - i); | |
349 | if (ret < 0) { | |
350 | if (errno == EINTR) { | |
351 | #ifdef BT_LOGD_STR | |
3f7d4d90 | 352 | BT_LOGD_STR("read() call interrupted; retrying..."); |
282b829b FD |
353 | #endif |
354 | /* retry operation */ | |
355 | continue; | |
356 | } else { | |
357 | #ifdef BT_LOGE_ERRNO | |
358 | BT_LOGE_ERRNO("Error while reading", ": fd=%d", | |
359 | fd); | |
360 | #endif | |
361 | goto end; | |
362 | } | |
363 | } | |
364 | i += ret; | |
365 | BT_ASSERT(i <= count); | |
366 | } while (count - i > 0 && ret > 0); | |
367 | ||
368 | end: | |
369 | if (ret >= 0) { | |
370 | if (i == 0) { | |
371 | ret = -1; | |
372 | } else { | |
373 | ret = i; | |
374 | } | |
375 | } | |
376 | ||
377 | return ret; | |
378 | } | |
379 | ||
3dca2276 | 380 | static inline |
864cad70 | 381 | const char *bt_common_field_class_type_string(enum bt_field_class_type class_type) |
3dca2276 | 382 | { |
864cad70 PP |
383 | switch (class_type) { |
384 | case BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER: | |
385 | return "BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER"; | |
386 | case BT_FIELD_CLASS_TYPE_SIGNED_INTEGER: | |
387 | return "BT_FIELD_CLASS_TYPE_SIGNED_INTEGER"; | |
388 | case BT_FIELD_CLASS_TYPE_REAL: | |
389 | return "BT_FIELD_CLASS_TYPE_REAL"; | |
390 | case BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION: | |
391 | return "BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION"; | |
392 | case BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION: | |
393 | return "BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION"; | |
394 | case BT_FIELD_CLASS_TYPE_STRING: | |
395 | return "BT_FIELD_CLASS_TYPE_STRING"; | |
396 | case BT_FIELD_CLASS_TYPE_STRUCTURE: | |
397 | return "BT_FIELD_CLASS_TYPE_STRUCTURE"; | |
398 | case BT_FIELD_CLASS_TYPE_STATIC_ARRAY: | |
399 | return "BT_FIELD_CLASS_TYPE_STATIC_ARRAY"; | |
400 | case BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY: | |
401 | return "BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY"; | |
402 | case BT_FIELD_CLASS_TYPE_VARIANT: | |
403 | return "BT_FIELD_CLASS_TYPE_VARIANT"; | |
3dca2276 PP |
404 | default: |
405 | return "(unknown)"; | |
406 | } | |
407 | }; | |
408 | ||
409 | static inline | |
5cd6d0e5 | 410 | const char *bt_common_field_class_integer_preferred_display_base_string(enum bt_field_class_integer_preferred_display_base base) |
3dca2276 PP |
411 | { |
412 | switch (base) { | |
5cd6d0e5 PP |
413 | case BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_BINARY: |
414 | return "BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_BINARY"; | |
415 | case BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_OCTAL: | |
416 | return "BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_OCTAL"; | |
417 | case BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_DECIMAL: | |
418 | return "BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_DECIMAL"; | |
419 | case BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_HEXADECIMAL: | |
420 | return "BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_HEXADECIMAL"; | |
3dca2276 PP |
421 | default: |
422 | return "(unknown)"; | |
423 | } | |
424 | } | |
425 | ||
426 | static inline | |
427 | const char *bt_common_scope_string(enum bt_scope scope) | |
428 | { | |
429 | switch (scope) { | |
44c440bc PP |
430 | case BT_SCOPE_PACKET_CONTEXT: |
431 | return "BT_SCOPE_PACKET_CONTEXT"; | |
44c440bc PP |
432 | case BT_SCOPE_EVENT_COMMON_CONTEXT: |
433 | return "BT_SCOPE_EVENT_COMMON_CONTEXT"; | |
434 | case BT_SCOPE_EVENT_SPECIFIC_CONTEXT: | |
435 | return "BT_SCOPE_EVENT_SPECIFIC_CONTEXT"; | |
3dca2276 PP |
436 | case BT_SCOPE_EVENT_PAYLOAD: |
437 | return "BT_SCOPE_EVENT_PAYLOAD"; | |
3dca2276 PP |
438 | default: |
439 | return "(unknown)"; | |
440 | } | |
441 | } | |
442 | ||
443 | static inline | |
444 | const char *bt_common_event_class_log_level_string( | |
445 | enum bt_event_class_log_level level) | |
446 | { | |
447 | switch (level) { | |
3dca2276 PP |
448 | case BT_EVENT_CLASS_LOG_LEVEL_EMERGENCY: |
449 | return "BT_EVENT_CLASS_LOG_LEVEL_EMERGENCY"; | |
450 | case BT_EVENT_CLASS_LOG_LEVEL_ALERT: | |
451 | return "BT_EVENT_CLASS_LOG_LEVEL_ALERT"; | |
452 | case BT_EVENT_CLASS_LOG_LEVEL_CRITICAL: | |
453 | return "BT_EVENT_CLASS_LOG_LEVEL_CRITICAL"; | |
454 | case BT_EVENT_CLASS_LOG_LEVEL_ERROR: | |
455 | return "BT_EVENT_CLASS_LOG_LEVEL_ERROR"; | |
456 | case BT_EVENT_CLASS_LOG_LEVEL_WARNING: | |
457 | return "BT_EVENT_CLASS_LOG_LEVEL_WARNING"; | |
458 | case BT_EVENT_CLASS_LOG_LEVEL_NOTICE: | |
459 | return "BT_EVENT_CLASS_LOG_LEVEL_NOTICE"; | |
460 | case BT_EVENT_CLASS_LOG_LEVEL_INFO: | |
461 | return "BT_EVENT_CLASS_LOG_LEVEL_INFO"; | |
462 | case BT_EVENT_CLASS_LOG_LEVEL_DEBUG_SYSTEM: | |
463 | return "BT_EVENT_CLASS_LOG_LEVEL_DEBUG_SYSTEM"; | |
464 | case BT_EVENT_CLASS_LOG_LEVEL_DEBUG_PROGRAM: | |
465 | return "BT_EVENT_CLASS_LOG_LEVEL_DEBUG_PROGRAM"; | |
466 | case BT_EVENT_CLASS_LOG_LEVEL_DEBUG_PROCESS: | |
467 | return "BT_EVENT_CLASS_LOG_LEVEL_DEBUG_PROCESS"; | |
468 | case BT_EVENT_CLASS_LOG_LEVEL_DEBUG_MODULE: | |
469 | return "BT_EVENT_CLASS_LOG_LEVEL_DEBUG_MODULE"; | |
470 | case BT_EVENT_CLASS_LOG_LEVEL_DEBUG_UNIT: | |
471 | return "BT_EVENT_CLASS_LOG_LEVEL_DEBUG_UNIT"; | |
472 | case BT_EVENT_CLASS_LOG_LEVEL_DEBUG_FUNCTION: | |
473 | return "BT_EVENT_CLASS_LOG_LEVEL_DEBUG_FUNCTION"; | |
474 | case BT_EVENT_CLASS_LOG_LEVEL_DEBUG_LINE: | |
475 | return "BT_EVENT_CLASS_LOG_LEVEL_DEBUG_LINE"; | |
476 | case BT_EVENT_CLASS_LOG_LEVEL_DEBUG: | |
477 | return "BT_EVENT_CLASS_LOG_LEVEL_DEBUG"; | |
478 | default: | |
479 | return "(unknown)"; | |
480 | } | |
481 | }; | |
482 | ||
da91b29a PP |
483 | static inline |
484 | const char *bt_common_value_type_string(enum bt_value_type type) | |
485 | { | |
486 | switch (type) { | |
487 | case BT_VALUE_TYPE_NULL: | |
488 | return "BT_VALUE_TYPE_NULL"; | |
489 | case BT_VALUE_TYPE_BOOL: | |
490 | return "BT_VALUE_TYPE_BOOL"; | |
fdd3a2da PP |
491 | case BT_VALUE_TYPE_UNSIGNED_INTEGER: |
492 | return "BT_VALUE_TYPE_UNSIGNED_INTEGER"; | |
493 | case BT_VALUE_TYPE_SIGNED_INTEGER: | |
494 | return "BT_VALUE_TYPE_SIGNED_INTEGER"; | |
da91b29a PP |
495 | case BT_VALUE_TYPE_REAL: |
496 | return "BT_VALUE_TYPE_REAL"; | |
497 | case BT_VALUE_TYPE_STRING: | |
498 | return "BT_VALUE_TYPE_STRING"; | |
499 | case BT_VALUE_TYPE_ARRAY: | |
500 | return "BT_VALUE_TYPE_ARRAY"; | |
501 | case BT_VALUE_TYPE_MAP: | |
502 | return "BT_VALUE_TYPE_MAP"; | |
503 | default: | |
504 | return "(unknown)"; | |
505 | } | |
506 | }; | |
507 | ||
3dca2276 | 508 | static inline |
bd1a54fe | 509 | GString *bt_common_field_path_string(struct bt_field_path *path) |
3dca2276 PP |
510 | { |
511 | GString *str = g_string_new(NULL); | |
44c440bc | 512 | uint64_t i; |
3dca2276 PP |
513 | |
514 | BT_ASSERT(path); | |
515 | ||
516 | if (!str) { | |
517 | goto end; | |
518 | } | |
519 | ||
520 | g_string_append_printf(str, "[%s", bt_common_scope_string( | |
521 | bt_field_path_get_root_scope(path))); | |
522 | ||
66ddcddf PP |
523 | for (i = 0; i < bt_field_path_get_item_count(path); i++) { |
524 | const struct bt_field_path_item *fp_item = | |
525 | bt_field_path_borrow_item_by_index_const(path, i); | |
526 | ||
527 | switch (bt_field_path_item_get_type(fp_item)) { | |
528 | case BT_FIELD_PATH_ITEM_TYPE_INDEX: | |
529 | g_string_append_printf(str, ", %" PRIu64, | |
530 | bt_field_path_item_index_get_index(fp_item)); | |
531 | break; | |
532 | case BT_FIELD_PATH_ITEM_TYPE_CURRENT_ARRAY_ELEMENT: | |
533 | g_string_append(str, ", <CUR>"); | |
534 | break; | |
535 | default: | |
536 | abort(); | |
537 | } | |
3dca2276 PP |
538 | } |
539 | ||
540 | g_string_append(str, "]"); | |
541 | ||
542 | end: | |
543 | return str; | |
544 | } | |
545 | ||
bfa3b6d8 | 546 | static inline |
bd1a54fe | 547 | const char *bt_common_self_message_iterator_status_string( |
bfa3b6d8 FD |
548 | enum bt_self_message_iterator_status status) |
549 | { | |
550 | switch (status) { | |
551 | case BT_SELF_MESSAGE_ITERATOR_STATUS_AGAIN: | |
552 | return "BT_SELF_MESSAGE_ITERATOR_STATUS_AGAIN"; | |
553 | case BT_SELF_MESSAGE_ITERATOR_STATUS_END: | |
554 | return "BT_SELF_MESSAGE_ITERATOR_STATUS_END"; | |
555 | case BT_SELF_MESSAGE_ITERATOR_STATUS_OK: | |
556 | return "BT_SELF_MESSAGE_ITERATOR_STATUS_OK"; | |
557 | case BT_SELF_MESSAGE_ITERATOR_STATUS_ERROR: | |
558 | return "BT_SELF_MESSAGE_ITERATOR_STATUS_ERROR"; | |
559 | case BT_SELF_MESSAGE_ITERATOR_STATUS_NOMEM: | |
560 | return "BT_SELF_MESSAGE_ITERATOR_STATUS_NOMEM"; | |
561 | default: | |
562 | return "(unknown)"; | |
563 | } | |
564 | }; | |
565 | ||
0ee90b74 PP |
566 | static inline |
567 | const char *bt_common_logging_level_string( | |
568 | enum bt_logging_level level) | |
569 | { | |
570 | switch (level) { | |
571 | case BT_LOGGING_LEVEL_VERBOSE: | |
572 | return "BT_LOGGING_LEVEL_VERBOSE"; | |
573 | case BT_LOGGING_LEVEL_DEBUG: | |
574 | return "BT_LOGGING_LEVEL_DEBUG"; | |
575 | case BT_LOGGING_LEVEL_INFO: | |
576 | return "BT_LOGGING_LEVEL_INFO"; | |
577 | case BT_LOGGING_LEVEL_WARN: | |
578 | return "BT_LOGGING_LEVEL_WARN"; | |
579 | case BT_LOGGING_LEVEL_ERROR: | |
580 | return "BT_LOGGING_LEVEL_ERROR"; | |
581 | case BT_LOGGING_LEVEL_FATAL: | |
582 | return "BT_LOGGING_LEVEL_FATAL"; | |
583 | case BT_LOGGING_LEVEL_NONE: | |
584 | return "BT_LOGGING_LEVEL_NONE"; | |
585 | default: | |
586 | return "(unknown)"; | |
587 | } | |
588 | }; | |
589 | ||
7de0e49a PP |
590 | #define NS_PER_S_I INT64_C(1000000000) |
591 | #define NS_PER_S_U UINT64_C(1000000000) | |
592 | ||
593 | static inline | |
594 | int bt_common_clock_value_from_ns_from_origin( | |
595 | int64_t cc_offset_seconds, uint64_t cc_offset_cycles, | |
596 | uint64_t cc_freq, int64_t ns_from_origin, | |
597 | uint64_t *raw_value) | |
598 | { | |
599 | int ret = 0; | |
600 | int64_t offset_in_ns; | |
601 | uint64_t value_in_ns; | |
602 | uint64_t rem_value_in_ns; | |
603 | uint64_t value_periods; | |
604 | uint64_t value_period_cycles; | |
605 | int64_t ns_to_add; | |
606 | ||
607 | BT_ASSERT(raw_value); | |
608 | ||
609 | /* Compute offset part of requested value, in nanoseconds */ | |
610 | if (!bt_safe_to_mul_int64(cc_offset_seconds, NS_PER_S_I)) { | |
611 | ret = -1; | |
612 | goto end; | |
613 | } | |
614 | ||
615 | offset_in_ns = cc_offset_seconds * NS_PER_S_I; | |
616 | ||
617 | if (cc_freq == NS_PER_S_U) { | |
618 | ns_to_add = (int64_t) cc_offset_cycles; | |
619 | } else { | |
620 | if (!bt_safe_to_mul_int64((int64_t) cc_offset_cycles, | |
621 | NS_PER_S_I)) { | |
622 | ret = -1; | |
623 | goto end; | |
624 | } | |
625 | ||
626 | ns_to_add = ((int64_t) cc_offset_cycles * NS_PER_S_I) / | |
627 | (int64_t) cc_freq; | |
628 | } | |
629 | ||
630 | if (!bt_safe_to_add_int64(offset_in_ns, ns_to_add)) { | |
631 | ret = -1; | |
632 | goto end; | |
633 | } | |
634 | ||
635 | offset_in_ns += ns_to_add; | |
636 | ||
637 | /* Value part in nanoseconds */ | |
638 | if (ns_from_origin < offset_in_ns) { | |
639 | ret = -1; | |
640 | goto end; | |
641 | } | |
642 | ||
643 | value_in_ns = (uint64_t) (ns_from_origin - offset_in_ns); | |
644 | ||
645 | /* Number of whole clock periods in `value_in_ns` */ | |
646 | value_periods = value_in_ns / NS_PER_S_U; | |
647 | ||
648 | /* Remaining nanoseconds in cycles + whole clock periods in cycles */ | |
649 | rem_value_in_ns = value_in_ns - value_periods * NS_PER_S_U; | |
650 | ||
651 | if (value_periods > UINT64_MAX / cc_freq) { | |
652 | ret = -1; | |
653 | goto end; | |
654 | } | |
655 | ||
656 | if (!bt_safe_to_mul_uint64(value_periods, cc_freq)) { | |
657 | ret = -1; | |
658 | goto end; | |
659 | } | |
660 | ||
661 | value_period_cycles = value_periods * cc_freq; | |
662 | ||
663 | if (!bt_safe_to_mul_uint64(cc_freq, rem_value_in_ns)) { | |
664 | ret = -1; | |
665 | goto end; | |
666 | } | |
667 | ||
668 | if (!bt_safe_to_add_uint64(cc_freq * rem_value_in_ns / NS_PER_S_U, | |
669 | value_period_cycles)) { | |
670 | ret = -1; | |
671 | goto end; | |
672 | } | |
673 | ||
674 | *raw_value = cc_freq * rem_value_in_ns / NS_PER_S_U + | |
675 | value_period_cycles; | |
676 | ||
677 | end: | |
678 | return ret; | |
679 | } | |
680 | ||
c9766bce | 681 | static inline |
0af5c7b0 PP |
682 | enum bt_self_message_iterator_status bt_common_message_iterator_status_to_self( |
683 | enum bt_message_iterator_status status) | |
c9766bce | 684 | { |
0af5c7b0 | 685 | return (int) status; |
c9766bce | 686 | } |
ae83436e | 687 | |
1670bffd | 688 | #endif /* BABELTRACE_COMMON_INTERNAL_H */ |