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