2 * SPDX-License-Identifier: MIT
4 * Copyright (c) 2018 EfficiOS Inc. and Linux Foundation
5 * Copyright (c) 2018 Philippe Proulx <pproulx@efficios.com>
8 #ifndef BABELTRACE_COMMON_INTERNAL_H
9 #define BABELTRACE_COMMON_INTERNAL_H
22 #include <babeltrace2/babeltrace.h>
24 #define __BT_IN_BABELTRACE_H
25 #include <babeltrace2/func-status.h>
27 #include "common/assert.h"
28 #include "common/macros.h"
29 #include "common/safe.h"
35 #define BT_COMMON_COLOR_RESET "\033[0m"
36 #define BT_COMMON_COLOR_BOLD "\033[1m"
37 #define BT_COMMON_COLOR_FG_DEFAULT "\033[39m"
38 #define BT_COMMON_COLOR_FG_RED "\033[31m"
39 #define BT_COMMON_COLOR_FG_GREEN "\033[32m"
40 #define BT_COMMON_COLOR_FG_YELLOW "\033[33m"
41 #define BT_COMMON_COLOR_FG_BLUE "\033[34m"
42 #define BT_COMMON_COLOR_FG_MAGENTA "\033[35m"
43 #define BT_COMMON_COLOR_FG_CYAN "\033[36m"
44 #define BT_COMMON_COLOR_FG_LIGHT_GRAY "\033[37m"
45 #define BT_COMMON_COLOR_FG_BOLD_RED "\033[1m\033[31m"
46 #define BT_COMMON_COLOR_FG_BOLD_GREEN "\033[1m\033[32m"
47 #define BT_COMMON_COLOR_FG_BOLD_YELLOW "\033[1m\033[33m"
48 #define BT_COMMON_COLOR_FG_BOLD_BLUE "\033[1m\033[34m"
49 #define BT_COMMON_COLOR_FG_BOLD_MAGENTA "\033[1m\033[35m"
50 #define BT_COMMON_COLOR_FG_BOLD_CYAN "\033[1m\033[36m"
51 #define BT_COMMON_COLOR_FG_BOLD_LIGHT_GRAY "\033[1m\033[37m"
52 #define BT_COMMON_COLOR_FG_BRIGHT_RED "\033[91m"
53 #define BT_COMMON_COLOR_FG_BRIGHT_GREEN "\033[92m"
54 #define BT_COMMON_COLOR_FG_BRIGHT_YELLOW "\033[93m"
55 #define BT_COMMON_COLOR_FG_BRIGHT_BLUE "\033[94m"
56 #define BT_COMMON_COLOR_FG_BRIGHT_MAGENTA "\033[95m"
57 #define BT_COMMON_COLOR_FG_BRIGHT_CYAN "\033[96m"
58 #define BT_COMMON_COLOR_FG_BRIGHT_LIGHT_GRAY "\033[97m"
59 #define BT_COMMON_COLOR_BG_DEFAULT "\033[49m"
60 #define BT_COMMON_COLOR_BG_RED "\033[41m"
61 #define BT_COMMON_COLOR_BG_GREEN "\033[42m"
62 #define BT_COMMON_COLOR_BG_YELLOW "\033[43m"
63 #define BT_COMMON_COLOR_BG_BLUE "\033[44m"
64 #define BT_COMMON_COLOR_BG_MAGENTA "\033[45m"
65 #define BT_COMMON_COLOR_BG_CYAN "\033[46m"
66 #define BT_COMMON_COLOR_BG_LIGHT_GRAY "\033[47m"
68 enum bt_common_color_when
{
69 BT_COMMON_COLOR_WHEN_AUTO
,
70 BT_COMMON_COLOR_WHEN_ALWAYS
,
71 BT_COMMON_COLOR_WHEN_NEVER
,
74 struct bt_common_color_codes
{
77 const char *fg_default
;
80 const char *fg_yellow
;
82 const char *fg_magenta
;
84 const char *fg_light_gray
;
85 const char *fg_bright_red
;
86 const char *fg_bright_green
;
87 const char *fg_bright_yellow
;
88 const char *fg_bright_blue
;
89 const char *fg_bright_magenta
;
90 const char *fg_bright_cyan
;
91 const char *fg_bright_light_gray
;
92 const char *bg_default
;
95 const char *bg_yellow
;
97 const char *bg_magenta
;
99 const char *bg_light_gray
;
102 struct bt_common_lttng_live_url_parts
{
105 GString
*target_hostname
;
106 GString
*session_name
;
108 /* -1 means default port */
113 * Checks if the current process has setuid or setgid access rights.
114 * Returns `true` if so.
116 bool bt_common_is_setuid_setgid(void);
119 * Returns the system-wide plugin path, e.g.
120 * `/usr/lib/babeltrace2/plugins`. Do not free the return value.
122 const char *bt_common_get_system_plugin_path(void);
125 * Returns the user plugin path, e.g.
126 * `/home/user/.local/lib/babeltrace2/plugins`. You need to free the
129 char *bt_common_get_home_plugin_path(int log_level
);
132 * Appends the list of directories in `paths` to the array `dirs`.
133 * `paths` is a list of directories separated by `:`. Returns 0 on
136 int bt_common_append_plugin_path_dirs(const char *paths
, GPtrArray
*dirs
);
139 * Returns `true` if terminal color codes are supported for this
142 bool bt_common_colors_supported(void);
144 const char *bt_common_color_reset(void);
146 const char *bt_common_color_bold(void);
148 const char *bt_common_color_fg_default(void);
150 const char *bt_common_color_fg_red(void);
152 const char *bt_common_color_fg_green(void);
154 const char *bt_common_color_fg_yellow(void);
156 const char *bt_common_color_fg_blue(void);
158 const char *bt_common_color_fg_magenta(void);
160 const char *bt_common_color_fg_cyan(void);
162 const char *bt_common_color_fg_light_gray(void);
164 const char *bt_common_color_fg_bright_red(void);
166 const char *bt_common_color_fg_bright_green(void);
168 const char *bt_common_color_fg_bright_yellow(void);
170 const char *bt_common_color_fg_bright_blue(void);
172 const char *bt_common_color_fg_bright_magenta(void);
174 const char *bt_common_color_fg_bright_cyan(void);
176 const char *bt_common_color_fg_bright_light_gray(void);
178 const char *bt_common_color_bg_default(void);
180 const char *bt_common_color_bg_red(void);
182 const char *bt_common_color_bg_green(void);
184 const char *bt_common_color_bg_yellow(void);
186 const char *bt_common_color_bg_blue(void);
188 const char *bt_common_color_bg_magenta(void);
190 const char *bt_common_color_bg_cyan(void);
192 const char *bt_common_color_bg_light_gray(void);
194 void bt_common_color_get_codes(struct bt_common_color_codes
*codes
,
195 enum bt_common_color_when use_colors
);
198 * Returns the substring from `input` to the first character found
199 * in the list of characters `end_chars`, unescaping any character
200 * found in `escapable_chars`, and sets `*end_pos` to the position of
201 * the end (from `input`). The caller owns the returned GString.
203 GString
*bt_common_string_until(const char *input
, const char *escapable_chars
,
204 const char *end_chars
, size_t *end_pos
);
207 * Returns the quoted version of `input` for a shell. If
208 * `with_single_quotes` is `true`, prepends and appends the `'` prefix
209 * and suffix to the returned string; otherwise the caller should
210 * prepend and append them manually, although they are not always
211 * required. The caller owns the returned GString.
213 GString
*bt_common_shell_quote(const char *input
, bool with_single_quotes
);
216 * Returns `true` if `input` is a string made only of printable
219 bool bt_common_string_is_printable(const char *input
);
222 * Destroys the parts of an LTTng live URL as returned by
223 * bt_common_parse_lttng_live_url().
225 void bt_common_destroy_lttng_live_url_parts(
226 struct bt_common_lttng_live_url_parts
*parts
);
229 * Parses the LTTng live URL `url` and returns its different parts.
230 * If there's an error, writes the error message into `*error_buf`
231 * up to `error_buf_size` bytes. You must destroy the returned value
232 * with bt_common_destroy_lttng_live_url_parts().
234 struct bt_common_lttng_live_url_parts
bt_common_parse_lttng_live_url(
235 const char *url
, char *error_buf
, size_t error_buf_size
);
238 * Normalizes (in place) a star globbing pattern to be used with
239 * bt_common_star_glob_match(). This function always succeeds.
241 void bt_common_normalize_star_glob_pattern(char *pattern
);
244 * Returns `true` if `candidate` (of size `candidate_len`) matches
245 * the star globbing pattern `pattern` (of size `pattern_len`).
247 bool bt_common_star_glob_match(const char *pattern
, size_t pattern_len
,
248 const char *candidate
, size_t candidate_len
);
251 * Normalizes the path `path`:
253 * * If it's a relative path, converts it to an absolute path using
254 * `wd` as the working directory (or the current working directory
256 * * Removes consecutive and trailing slashes.
257 * * Resolves `..` and `.` in the path (both in `path` and in `wd`).
258 * * Does NOT resolve symbolic links.
260 * The caller owns the returned GString.
262 GString
*bt_common_normalize_path(const char *path
, const char *wd
);
264 typedef void (* bt_common_handle_custom_specifier_func
)(void *priv_data
,
265 char **buf
, size_t avail_size
, const char **fmt
, va_list *args
);
268 * This is a custom vsnprintf() which handles the standard conversion
269 * specifier as well as custom ones.
271 * `fmt` is a typical printf()-style format string, with the following
274 * * The `*` width specifier is not accepted.
275 * * The `*` precision specifier is not accepted.
276 * * The `j` and `t` length modifiers are not accepted.
277 * * The `n` format specifier is not accepted.
278 * * The format specifiers defined in <inttypes.h> are not accepted
279 * except for `PRId64`, `PRIu64`, `PRIx64`, `PRIX64`, `PRIo64`, and
282 * `intro` specifies which special character immediately following an
283 * introductory `%` character in `fmt` is used to indicate a custom
284 * conversion specifier. For example, if `intro` is '@', then any `%@`
285 * sequence in `fmt` is the beginning of a custom conversion specifier.
287 * When a custom conversion specifier is encountered in `fmt`,
288 * the function calls `handle_specifier`. This callback receives:
291 * Custom, private data.
294 * Address of the current buffer pointer. `*buf` is the position to
295 * append new data. The callback must update `*buf` when appending
296 * new data. The callback must ensure not to write passed the whole
297 * buffer passed to bt_common_custom_vsnprintf().
300 * Number of bytes left in whole buffer from the `*buf` point.
303 * Address of the current format string pointer. `*fmt` points to
304 * the introductory `%` character, which is followed by the
305 * character `intro`. The callback must update `*fmt` so that it
306 * points after the whole custom conversion specifier.
309 * Variable argument list. Use va_arg() to get new arguments from
310 * this list and update it at the same time.
312 * Because this is an internal utility, this function and its callback
313 * do not return error codes: they abort when there's any error (bad
314 * format string, for example).
316 void bt_common_custom_vsnprintf(char *buf
, size_t buf_size
,
318 bt_common_handle_custom_specifier_func handle_specifier
,
319 void *priv_data
, const char *fmt
, va_list *args
);
322 * Variadic form of bt_common_custom_vsnprintf().
324 void bt_common_custom_snprintf(char *buf
, size_t buf_size
,
326 bt_common_handle_custom_specifier_func handle_specifier
,
327 void *priv_data
, const char *fmt
, ...);
330 * Returns the system page size.
332 size_t bt_common_get_page_size(int log_level
);
335 * Adds the digit separator `sep` as many times as needed to form groups
336 * of `digits_per_group` digits within `str`. `str` must have enough
337 * room to accomodate the new separators, that is:
339 * strlen(str) + (strlen(str) / digits_per_group) + 1
341 * Example: with `str` `1983198398213`, `digits_per_group` 3, and `sep`
342 * `,`, `str` becomes `1,983,198,398,213`.
344 * `strlen(str)` must not be 0. `digits_per_group` must not be 0. `sep`
347 void bt_common_sep_digits(char *str
, unsigned int digits_per_group
, char sep
);
350 * This is similar to what the command `fold --spaces` does: it wraps
351 * the input lines of `str`, breaking at spaces, and indenting each line
352 * with `indent` spaces so that each line fits the total length
355 * If an original line in `str` contains a word which is >= the content
356 * length (`total_length - indent`), then the corresponding folded line
357 * is also larger than the content length. In other words, breaking at
358 * spaces is a best effort, but it might not be possible.
360 * The returned string, on success, is owned by the caller.
362 GString
*bt_common_fold(const char *str
, unsigned int total_length
,
363 unsigned int indent
);
366 * Writes the terminal's width to `*width`, its height to `*height`,
367 * and returns 0 on success, or returns -1 on error.
369 int bt_common_get_term_size(unsigned int *width
, unsigned int *height
);
372 * Appends the textual content of `fp` to `str`, starting from its
373 * current position to the end of the file.
375 * This function does NOT rewind `fp` once it's done or on error.
377 int bt_common_append_file_content_to_g_string(GString
*str
, FILE *fp
);
379 void bt_common_abort(void) __attribute__((noreturn
));
382 * Wraps read() function to handle EINTR and partial reads.
383 * On success, it returns `count` received as parameter. On error, it returns a
384 * value smaller than the requested `count`.
387 ssize_t
bt_common_read(int fd
, void *buf
, size_t count
, int log_level
)
394 /* Never return an overflow value. */
395 BT_ASSERT_DBG(count
<= SSIZE_MAX
);
398 ret
= read(fd
, ((char *) buf
) + i
, count
- i
);
400 if (errno
== EINTR
) {
401 #ifdef BT_LOG_WRITE_CUR_LVL
402 BT_LOG_WRITE_CUR_LVL(BT_LOG_DEBUG
, log_level
,
404 "read() call interrupted; retrying...");
406 /* retry operation */
409 #ifdef BT_LOG_WRITE_ERRNO_CUR_LVL
410 BT_LOG_WRITE_ERRNO_CUR_LVL(BT_LOG_ERROR
,
411 log_level
, BT_LOG_TAG
,
412 "Error while reading", ": fd=%d", fd
);
418 BT_ASSERT_DBG(i
<= count
);
419 } while (count
- i
> 0 && ret
> 0);
434 const char *bt_common_field_class_type_string(enum bt_field_class_type class_type
)
436 switch (class_type
) {
437 case BT_FIELD_CLASS_TYPE_BOOL
:
439 case BT_FIELD_CLASS_TYPE_BIT_ARRAY
:
441 case BT_FIELD_CLASS_TYPE_INTEGER
:
443 case BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER
:
444 return "UNSIGNED_INTEGER";
445 case BT_FIELD_CLASS_TYPE_SIGNED_INTEGER
:
446 return "SIGNED_INTEGER";
447 case BT_FIELD_CLASS_TYPE_ENUMERATION
:
448 return "ENUMERATION";
449 case BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION
:
450 return "UNSIGNED_ENUMERATION";
451 case BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION
:
452 return "SIGNED_ENUMERATION";
453 case BT_FIELD_CLASS_TYPE_REAL
:
455 case BT_FIELD_CLASS_TYPE_SINGLE_PRECISION_REAL
:
456 return "SINGLE_PRECISION_REAL";
457 case BT_FIELD_CLASS_TYPE_DOUBLE_PRECISION_REAL
:
458 return "DOUBLE_PRECISION_REAL";
459 case BT_FIELD_CLASS_TYPE_STRING
:
461 case BT_FIELD_CLASS_TYPE_STRUCTURE
:
463 case BT_FIELD_CLASS_TYPE_ARRAY
:
465 case BT_FIELD_CLASS_TYPE_STATIC_ARRAY
:
466 return "STATIC_ARRAY";
467 case BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY
:
468 return "DYNAMIC_ARRAY";
469 case BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY_WITHOUT_LENGTH_FIELD
:
470 return "DYNAMIC_ARRAY_WITHOUT_LENGTH_FIELD";
471 case BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY_WITH_LENGTH_FIELD
:
472 return "DYNAMIC_ARRAY_WITH_LENGTH_FIELD";
473 case BT_FIELD_CLASS_TYPE_OPTION
:
475 case BT_FIELD_CLASS_TYPE_OPTION_WITHOUT_SELECTOR_FIELD
:
476 return "OPTION_WITHOUT_SELECTOR_FIELD";
477 case BT_FIELD_CLASS_TYPE_OPTION_WITH_SELECTOR_FIELD
:
478 return "OPTION_WITH_SELECTOR_FIELD";
479 case BT_FIELD_CLASS_TYPE_OPTION_WITH_BOOL_SELECTOR_FIELD
:
480 return "OPTION_WITH_BOOL_SELECTOR_FIELD";
481 case BT_FIELD_CLASS_TYPE_OPTION_WITH_INTEGER_SELECTOR_FIELD
:
482 return "OPTION_WITH_INTEGER_SELECTOR_FIELD";
483 case BT_FIELD_CLASS_TYPE_OPTION_WITH_UNSIGNED_INTEGER_SELECTOR_FIELD
:
484 return "OPTION_WITH_UNSIGNED_INTEGER_SELECTOR_FIELD";
485 case BT_FIELD_CLASS_TYPE_OPTION_WITH_SIGNED_INTEGER_SELECTOR_FIELD
:
486 return "OPTION_WITH_SIGNED_INTEGER_SELECTOR_FIELD";
487 case BT_FIELD_CLASS_TYPE_VARIANT
:
489 case BT_FIELD_CLASS_TYPE_VARIANT_WITHOUT_SELECTOR_FIELD
:
490 return "VARIANT_WITHOUT_SELECTOR_FIELD";
491 case BT_FIELD_CLASS_TYPE_VARIANT_WITH_SELECTOR_FIELD
:
492 return "VARIANT_WITH_SELECTOR_FIELD";
493 case BT_FIELD_CLASS_TYPE_VARIANT_WITH_INTEGER_SELECTOR_FIELD
:
494 return "VARIANT_WITH_INTEGER_SELECTOR_FIELD";
495 case BT_FIELD_CLASS_TYPE_VARIANT_WITH_UNSIGNED_INTEGER_SELECTOR_FIELD
:
496 return "VARIANT_WITH_UNSIGNED_INTEGER_SELECTOR_FIELD";
497 case BT_FIELD_CLASS_TYPE_VARIANT_WITH_SIGNED_INTEGER_SELECTOR_FIELD
:
498 return "VARIANT_WITH_SIGNED_INTEGER_SELECTOR_FIELD";
499 case __BT_FIELD_CLASS_TYPE_BIG_VALUE
:
507 const char *bt_common_field_class_integer_preferred_display_base_string(enum bt_field_class_integer_preferred_display_base base
)
510 case BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_BINARY
:
512 case BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_OCTAL
:
514 case BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_DECIMAL
:
516 case BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_HEXADECIMAL
:
517 return "HEXADECIMAL";
524 const char *bt_common_scope_string(enum bt_field_path_scope scope
)
527 case BT_FIELD_PATH_SCOPE_PACKET_CONTEXT
:
528 return "PACKET_CONTEXT";
529 case BT_FIELD_PATH_SCOPE_EVENT_COMMON_CONTEXT
:
530 return "EVENT_COMMON_CONTEXT";
531 case BT_FIELD_PATH_SCOPE_EVENT_SPECIFIC_CONTEXT
:
532 return "EVENT_SPECIFIC_CONTEXT";
533 case BT_FIELD_PATH_SCOPE_EVENT_PAYLOAD
:
534 return "EVENT_PAYLOAD";
541 const char *bt_common_event_class_log_level_string(
542 enum bt_event_class_log_level level
)
545 case BT_EVENT_CLASS_LOG_LEVEL_EMERGENCY
:
547 case BT_EVENT_CLASS_LOG_LEVEL_ALERT
:
549 case BT_EVENT_CLASS_LOG_LEVEL_CRITICAL
:
551 case BT_EVENT_CLASS_LOG_LEVEL_ERROR
:
553 case BT_EVENT_CLASS_LOG_LEVEL_WARNING
:
555 case BT_EVENT_CLASS_LOG_LEVEL_NOTICE
:
557 case BT_EVENT_CLASS_LOG_LEVEL_INFO
:
559 case BT_EVENT_CLASS_LOG_LEVEL_DEBUG_SYSTEM
:
560 return "DEBUG_SYSTEM";
561 case BT_EVENT_CLASS_LOG_LEVEL_DEBUG_PROGRAM
:
562 return "DEBUG_PROGRAM";
563 case BT_EVENT_CLASS_LOG_LEVEL_DEBUG_PROCESS
:
564 return "DEBUG_PROCESS";
565 case BT_EVENT_CLASS_LOG_LEVEL_DEBUG_MODULE
:
566 return "DEBUG_MODULE";
567 case BT_EVENT_CLASS_LOG_LEVEL_DEBUG_UNIT
:
569 case BT_EVENT_CLASS_LOG_LEVEL_DEBUG_FUNCTION
:
570 return "DEBUG_FUNCTION";
571 case BT_EVENT_CLASS_LOG_LEVEL_DEBUG_LINE
:
573 case BT_EVENT_CLASS_LOG_LEVEL_DEBUG
:
581 const char *bt_common_value_type_string(enum bt_value_type type
)
584 case BT_VALUE_TYPE_NULL
:
586 case BT_VALUE_TYPE_BOOL
:
588 case BT_VALUE_TYPE_INTEGER
:
590 case BT_VALUE_TYPE_UNSIGNED_INTEGER
:
591 return "UNSIGNED_INTEGER";
592 case BT_VALUE_TYPE_SIGNED_INTEGER
:
593 return "SIGNED_INTEGER";
594 case BT_VALUE_TYPE_REAL
:
596 case BT_VALUE_TYPE_STRING
:
598 case BT_VALUE_TYPE_ARRAY
:
600 case BT_VALUE_TYPE_MAP
:
608 GString
*bt_common_field_path_string(struct bt_field_path
*path
)
610 GString
*str
= g_string_new(NULL
);
619 g_string_append_printf(str
, "[%s", bt_common_scope_string(
620 bt_field_path_get_root_scope(path
)));
622 for (i
= 0; i
< bt_field_path_get_item_count(path
); i
++) {
623 const struct bt_field_path_item
*fp_item
=
624 bt_field_path_borrow_item_by_index_const(path
, i
);
626 switch (bt_field_path_item_get_type(fp_item
)) {
627 case BT_FIELD_PATH_ITEM_TYPE_INDEX
:
628 g_string_append_printf(str
, ", %" PRIu64
,
629 bt_field_path_item_index_get_index(fp_item
));
631 case BT_FIELD_PATH_ITEM_TYPE_CURRENT_ARRAY_ELEMENT
:
632 g_string_append(str
, ", <CUR>");
639 g_string_append(str
, "]");
646 const char *bt_common_logging_level_string(
647 enum bt_logging_level level
)
650 case BT_LOGGING_LEVEL_TRACE
:
652 case BT_LOGGING_LEVEL_DEBUG
:
654 case BT_LOGGING_LEVEL_INFO
:
656 case BT_LOGGING_LEVEL_WARNING
:
658 case BT_LOGGING_LEVEL_ERROR
:
660 case BT_LOGGING_LEVEL_FATAL
:
662 case BT_LOGGING_LEVEL_NONE
:
670 const char *bt_common_func_status_string(int status
)
673 case __BT_FUNC_STATUS_OVERFLOW_ERROR
:
675 case __BT_FUNC_STATUS_MEMORY_ERROR
:
676 return "MEMORY_ERROR";
677 case __BT_FUNC_STATUS_USER_ERROR
:
679 case __BT_FUNC_STATUS_ERROR
:
681 case __BT_FUNC_STATUS_OK
:
683 case __BT_FUNC_STATUS_END
:
685 case __BT_FUNC_STATUS_NOT_FOUND
:
687 case __BT_FUNC_STATUS_INTERRUPTED
:
688 return "INTERRUPTED";
689 case __BT_FUNC_STATUS_NO_MATCH
:
691 case __BT_FUNC_STATUS_AGAIN
:
693 case __BT_FUNC_STATUS_UNKNOWN_OBJECT
:
694 return "UNKNOWN_OBJECT";
700 #define NS_PER_S_I INT64_C(1000000000)
701 #define NS_PER_S_U UINT64_C(1000000000)
704 int bt_common_clock_value_from_ns_from_origin(
705 int64_t cc_offset_seconds
, uint64_t cc_offset_cycles
,
706 uint64_t cc_freq
, int64_t ns_from_origin
,
710 int64_t offset_in_ns
;
711 uint64_t value_in_ns
;
712 uint64_t rem_value_in_ns
;
713 uint64_t value_periods
;
714 uint64_t value_period_cycles
;
717 BT_ASSERT_DBG(raw_value
);
719 /* Compute offset part of requested value, in nanoseconds */
720 if (!bt_safe_to_mul_int64(cc_offset_seconds
, NS_PER_S_I
)) {
725 offset_in_ns
= cc_offset_seconds
* NS_PER_S_I
;
727 if (cc_freq
== NS_PER_S_U
) {
728 ns_to_add
= (int64_t) cc_offset_cycles
;
730 if (!bt_safe_to_mul_int64((int64_t) cc_offset_cycles
,
736 ns_to_add
= ((int64_t) cc_offset_cycles
* NS_PER_S_I
) /
740 if (!bt_safe_to_add_int64(offset_in_ns
, ns_to_add
)) {
745 offset_in_ns
+= ns_to_add
;
747 /* Value part in nanoseconds */
748 if (ns_from_origin
< offset_in_ns
) {
753 value_in_ns
= (uint64_t) (ns_from_origin
- offset_in_ns
);
755 /* Number of whole clock periods in `value_in_ns` */
756 value_periods
= value_in_ns
/ NS_PER_S_U
;
758 /* Remaining nanoseconds in cycles + whole clock periods in cycles */
759 rem_value_in_ns
= value_in_ns
- value_periods
* NS_PER_S_U
;
761 if (value_periods
> UINT64_MAX
/ cc_freq
) {
766 if (!bt_safe_to_mul_uint64(value_periods
, cc_freq
)) {
771 value_period_cycles
= value_periods
* cc_freq
;
773 if (!bt_safe_to_mul_uint64(cc_freq
, rem_value_in_ns
)) {
778 if (!bt_safe_to_add_uint64(cc_freq
* rem_value_in_ns
/ NS_PER_S_U
,
779 value_period_cycles
)) {
784 *raw_value
= cc_freq
* rem_value_in_ns
/ NS_PER_S_U
+
792 * bt_g_string_append_printf cannot be inlined because it expects a
793 * variadic argument list.
795 __BT_ATTR_FORMAT_PRINTF(2, 3)
796 int bt_common_g_string_append_printf(GString
*str
, const char *fmt
, ...);
799 void bt_common_g_string_append(GString
*str
, const char *s
)
801 gsize len
, allocated_len
, s_len
;
803 /* str->len excludes \0. */
806 allocated_len
= str
->allocated_len
- 1;
808 if (G_UNLIKELY(allocated_len
< len
+ s_len
)) {
810 g_string_set_size(str
, len
+ s_len
);
812 str
->len
= len
+ s_len
;
814 memcpy(str
->str
+ len
, s
, s_len
+ 1);
818 void bt_common_g_string_append_c(GString
*str
, char c
)
820 gsize len
, allocated_len
, s_len
;
822 /* str->len excludes \0. */
825 allocated_len
= str
->allocated_len
- 1;
827 if (G_UNLIKELY(allocated_len
< len
+ s_len
)) {
829 g_string_set_size(str
, len
+ s_len
);
831 str
->len
= len
+ s_len
;
834 str
->str
[len
+ 1] = '\0';
838 const char *bt_common_component_class_type_string(
839 enum bt_component_class_type type
)
842 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
844 case BT_COMPONENT_CLASS_TYPE_SINK
:
846 case BT_COMPONENT_CLASS_TYPE_FILTER
:
854 const char *bt_common_message_type_string(enum bt_message_type type
)
857 case BT_MESSAGE_TYPE_STREAM_BEGINNING
:
858 return "STREAM_BEGINNING";
859 case BT_MESSAGE_TYPE_STREAM_END
:
861 case BT_MESSAGE_TYPE_EVENT
:
863 case BT_MESSAGE_TYPE_PACKET_BEGINNING
:
864 return "PACKET_BEGINNING";
865 case BT_MESSAGE_TYPE_PACKET_END
:
867 case BT_MESSAGE_TYPE_DISCARDED_EVENTS
:
868 return "DISCARDED_EVENTS";
869 case BT_MESSAGE_TYPE_DISCARDED_PACKETS
:
870 return "DISCARDED_PACKETS";
871 case BT_MESSAGE_TYPE_MESSAGE_ITERATOR_INACTIVITY
:
872 return "MESSAGE_ITERATOR_INACTIVITY";
882 #endif /* BABELTRACE_COMMON_INTERNAL_H */