src/common/common.h

   1 /*
   2  * SPDX-License-Identifier: MIT
   3  *
   4  * Copyright (c) 2018 EfficiOS Inc. and Linux Foundation
   5  * Copyright (c) 2018 Philippe Proulx <pproulx@efficios.com>
   6  */
   7
   8 #ifndef BABELTRACE_COMMON_INTERNAL_H
   9 #define BABELTRACE_COMMON_INTERNAL_H
  10
  11 #include <errno.h>
  12 #include <glib.h>
  13 #include <inttypes.h>
  14 #include <stdarg.h>
  15 #include <stdbool.h>
  16 #include <stdint.h>
  17 #include <stdlib.h>
  18 #include <stdio.h>
  19 #include <unistd.h>
  20 #include <string.h>
  21
  22 #include <babeltrace2/babeltrace.h>
  23
  24 #define __BT_IN_BABELTRACE_H
  25 #include <babeltrace2/func-status.h>
  26
  27 #include "common/assert.h"
  28 #include "common/macros.h"
  29 #include "common/safe.h"
  30
  31 #ifdef __cplusplus
  32 extern "C" {
  33 #endif
  34
  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"
  67
  68 enum bt_common_color_when {
  69         BT_COMMON_COLOR_WHEN_AUTO,
  70         BT_COMMON_COLOR_WHEN_ALWAYS,
  71         BT_COMMON_COLOR_WHEN_NEVER,
  72 };
  73
  74 struct bt_common_color_codes {
  75         const char *reset;
  76         const char *bold;
  77         const char *fg_default;
  78         const char *fg_red;
  79         const char *fg_green;
  80         const char *fg_yellow;
  81         const char *fg_blue;
  82         const char *fg_magenta;
  83         const char *fg_cyan;
  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;
  93         const char *bg_red;
  94         const char *bg_green;
  95         const char *bg_yellow;
  96         const char *bg_blue;
  97         const char *bg_magenta;
  98         const char *bg_cyan;
  99         const char *bg_light_gray;
 100 };
 101
 102 struct bt_common_lttng_live_url_parts {
 103         GString *proto;
 104         GString *hostname;
 105         GString *target_hostname;
 106         GString *session_name;
 107
 108         /* -1 means default port */
 109         int port;
 110 };
 111
 112 /*
 113  * Checks if the current process has setuid or setgid access rights.
 114  * Returns `true` if so.
 115  */
 116 bool bt_common_is_setuid_setgid(void);
 117
 118 /*
 119  * Returns the system-wide plugin path, e.g.
 120  * `/usr/lib/babeltrace2/plugins`. Do not free the return value.
 121  */
 122 const char *bt_common_get_system_plugin_path(void);
 123
 124 /*
 125  * Returns the user plugin path, e.g.
 126  * `/home/user/.local/lib/babeltrace2/plugins`. You need to free the
 127  * return value.
 128  */
 129 char *bt_common_get_home_plugin_path(int log_level);
 130
 131 /*
 132  * Appends the list of directories in `paths` to the array `dirs`.
 133  * `paths` is a list of directories separated by `:`. Returns 0 on
 134  * success.
 135  */
 136 int bt_common_append_plugin_path_dirs(const char *paths, GPtrArray *dirs);
 137
 138 /*
 139  * Returns `true` if terminal color codes are supported for this
 140  * process.
 141  */
 142 bool bt_common_colors_supported(void);
 143
 144 const char *bt_common_color_reset(void);
 145
 146 const char *bt_common_color_bold(void);
 147
 148 const char *bt_common_color_fg_default(void);
 149
 150 const char *bt_common_color_fg_red(void);
 151
 152 const char *bt_common_color_fg_green(void);
 153
 154 const char *bt_common_color_fg_yellow(void);
 155
 156 const char *bt_common_color_fg_blue(void);
 157
 158 const char *bt_common_color_fg_magenta(void);
 159
 160 const char *bt_common_color_fg_cyan(void);
 161
 162 const char *bt_common_color_fg_light_gray(void);
 163
 164 const char *bt_common_color_fg_bright_red(void);
 165
 166 const char *bt_common_color_fg_bright_green(void);
 167
 168 const char *bt_common_color_fg_bright_yellow(void);
 169
 170 const char *bt_common_color_fg_bright_blue(void);
 171
 172 const char *bt_common_color_fg_bright_magenta(void);
 173
 174 const char *bt_common_color_fg_bright_cyan(void);
 175
 176 const char *bt_common_color_fg_bright_light_gray(void);
 177
 178 const char *bt_common_color_bg_default(void);
 179
 180 const char *bt_common_color_bg_red(void);
 181
 182 const char *bt_common_color_bg_green(void);
 183
 184 const char *bt_common_color_bg_yellow(void);
 185
 186 const char *bt_common_color_bg_blue(void);
 187
 188 const char *bt_common_color_bg_magenta(void);
 189
 190 const char *bt_common_color_bg_cyan(void);
 191
 192 const char *bt_common_color_bg_light_gray(void);
 193
 194 void bt_common_color_get_codes(struct bt_common_color_codes *codes,
 195                 enum bt_common_color_when use_colors);
 196
 197 /*
 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.
 202  */
 203 GString *bt_common_string_until(const char *input, const char *escapable_chars,
 204                     const char *end_chars, size_t *end_pos);
 205
 206 /*
 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.
 212  */
 213 GString *bt_common_shell_quote(const char *input, bool with_single_quotes);
 214
 215 /*
 216  * Returns `true` if `input` is a string made only of printable
 217  * characters.
 218  */
 219 bool bt_common_string_is_printable(const char *input);
 220
 221 /*
 222  * Destroys the parts of an LTTng live URL as returned by
 223  * bt_common_parse_lttng_live_url().
 224  */
 225 void bt_common_destroy_lttng_live_url_parts(
 226                 struct bt_common_lttng_live_url_parts *parts);
 227
 228 /*
 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().
 233  */
 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);
 236
 237 /*
 238  * Normalizes (in place) a star globbing pattern to be used with
 239  * bt_common_star_glob_match(). This function always succeeds.
 240  */
 241 void bt_common_normalize_star_glob_pattern(char *pattern);
 242
 243 /*
 244  * Returns `true` if `candidate` (of size `candidate_len`) matches
 245  * the star globbing pattern `pattern` (of size `pattern_len`).
 246  */
 247 bool bt_common_star_glob_match(const char *pattern, size_t pattern_len,
 248                 const char *candidate, size_t candidate_len);
 249
 250 /*
 251  * Normalizes the path `path`:
 252  *
 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
 255  *   if `wd` is NULL).
 256  * * Removes consecutive and trailing slashes.
 257  * * Resolves `..` and `.` in the path (both in `path` and in `wd`).
 258  * * Does NOT resolve symbolic links.
 259  *
 260  * The caller owns the returned GString.
 261  */
 262 GString *bt_common_normalize_path(const char *path, const char *wd);
 263
 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);
 266
 267 /*
 268  * This is a custom vsnprintf() which handles the standard conversion
 269  * specifier as well as custom ones.
 270  *
 271  * `fmt` is a typical printf()-style format string, with the following
 272  * limitations:
 273  *
 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
 280  *   `PRIi64`.
 281  *
 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.
 286  *
 287  * When a custom conversion specifier is encountered in `fmt`,
 288  * the function calls `handle_specifier`. This callback receives:
 289  *
 290  * `priv_data`:
 291  *     Custom, private data.
 292  *
 293  * `buf`:
 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().
 298  *
 299  * `avail_size`:
 300  *     Number of bytes left in whole buffer from the `*buf` point.
 301  *
 302  * `fmt`:
 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.
 307  *
 308  * `args`:
 309  *     Variable argument list. Use va_arg() to get new arguments from
 310  *     this list and update it at the same time.
 311  *
 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).
 315  */
 316 void bt_common_custom_vsnprintf(char *buf, size_t buf_size,
 317                 char intro,
 318                 bt_common_handle_custom_specifier_func handle_specifier,
 319                 void *priv_data, const char *fmt, va_list *args);
 320
 321 /*
 322  * Variadic form of bt_common_custom_vsnprintf().
 323  */
 324 void bt_common_custom_snprintf(char *buf, size_t buf_size,
 325                 char intro,
 326                 bt_common_handle_custom_specifier_func handle_specifier,
 327                 void *priv_data, const char *fmt, ...);
 328
 329 /*
 330  * Returns the system page size.
 331  */
 332 size_t bt_common_get_page_size(int log_level);
 333
 334 /*
 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:
 338  *
 339  *     strlen(str) + (strlen(str) / digits_per_group) + 1
 340  *
 341  * Example: with `str` `1983198398213`, `digits_per_group` 3, and `sep`
 342  * `,`, `str` becomes `1,983,198,398,213`.
 343  *
 344  * `strlen(str)` must not be 0. `digits_per_group` must not be 0. `sep`
 345  * must not be `\0`.
 346  */
 347 void bt_common_sep_digits(char *str, unsigned int digits_per_group, char sep);
 348
 349 /*
 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
 353  * `total_length`.
 354  *
 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.
 359  *
 360  * The returned string, on success, is owned by the caller.
 361  */
 362 GString *bt_common_fold(const char *str, unsigned int total_length,
 363                 unsigned int indent);
 364
 365 /*
 366  * Writes the terminal's width to `*width`, its height to `*height`,
 367  * and returns 0 on success, or returns -1 on error.
 368  */
 369 int bt_common_get_term_size(unsigned int *width, unsigned int *height);
 370
 371 /*
 372  * Appends the textual content of `fp` to `str`, starting from its
 373  * current position to the end of the file.
 374  *
 375  * This function does NOT rewind `fp` once it's done or on error.
 376  */
 377 int bt_common_append_file_content_to_g_string(GString *str, FILE *fp);
 378
 379 void bt_common_abort(void) __attribute__((noreturn));
 380
 381 /*
 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`.
 385  */
 386 static inline
 387 ssize_t bt_common_read(int fd, void *buf, size_t count, int log_level)
 388 {
 389         size_t i = 0;
 390         ssize_t ret;
 391
 392         BT_ASSERT_DBG(buf);
 393
 394         /* Never return an overflow value. */
 395         BT_ASSERT_DBG(count <= SSIZE_MAX);
 396
 397         do {
 398                 ret = read(fd, ((char *) buf) + i, count - i);
 399                 if (ret < 0) {
 400                         if (errno == EINTR) {
 401 #ifdef BT_LOG_WRITE_CUR_LVL
 402                                 BT_LOG_WRITE_CUR_LVL(BT_LOG_DEBUG, log_level,
 403                                         BT_LOG_TAG,
 404                                         "read() call interrupted; retrying...");
 405 #endif
 406                                 /* retry operation */
 407                                 continue;
 408                         } else {
 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);
 413 #endif
 414                                 goto end;
 415                         }
 416                 }
 417                 i += ret;
 418                 BT_ASSERT_DBG(i <= count);
 419         } while (count - i > 0 && ret > 0);
 420
 421 end:
 422         if (ret >= 0) {
 423                 if (i == 0) {
 424                         ret = -1;
 425                 } else {
 426                         ret = i;
 427                 }
 428         }
 429
 430         return ret;
 431 }
 432
 433 static inline
 434 const char *bt_common_field_class_type_string(enum bt_field_class_type class_type)
 435 {
 436         switch (class_type) {
 437         case BT_FIELD_CLASS_TYPE_BOOL:
 438                 return "BOOL";
 439         case BT_FIELD_CLASS_TYPE_BIT_ARRAY:
 440                 return "BIT_ARRAY";
 441         case BT_FIELD_CLASS_TYPE_INTEGER:
 442                 return "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:
 454                 return "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:
 460                 return "STRING";
 461         case BT_FIELD_CLASS_TYPE_STRUCTURE:
 462                 return "STRUCTURE";
 463         case BT_FIELD_CLASS_TYPE_ARRAY:
 464                 return "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:
 474                 return "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:
 488                 return "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:
 500                 bt_common_abort ();
 501         }
 502
 503         bt_common_abort();
 504 };
 505
 506 static inline
 507 const char *bt_common_field_class_integer_preferred_display_base_string(enum bt_field_class_integer_preferred_display_base base)
 508 {
 509         switch (base) {
 510         case BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_BINARY:
 511                 return "BINARY";
 512         case BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_OCTAL:
 513                 return "OCTAL";
 514         case BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_DECIMAL:
 515                 return "DECIMAL";
 516         case BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_HEXADECIMAL:
 517                 return "HEXADECIMAL";
 518         }
 519
 520         bt_common_abort();
 521 }
 522
 523 static inline
 524 const char *bt_common_scope_string(enum bt_field_path_scope scope)
 525 {
 526         switch (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";
 535         }
 536
 537         bt_common_abort();
 538 }
 539
 540 static inline
 541 const char *bt_common_event_class_log_level_string(
 542                 enum bt_event_class_log_level level)
 543 {
 544         switch (level) {
 545         case BT_EVENT_CLASS_LOG_LEVEL_EMERGENCY:
 546                 return "EMERGENCY";
 547         case BT_EVENT_CLASS_LOG_LEVEL_ALERT:
 548                 return "ALERT";
 549         case BT_EVENT_CLASS_LOG_LEVEL_CRITICAL:
 550                 return "CRITICAL";
 551         case BT_EVENT_CLASS_LOG_LEVEL_ERROR:
 552                 return "ERROR";
 553         case BT_EVENT_CLASS_LOG_LEVEL_WARNING:
 554                 return "WARNING";
 555         case BT_EVENT_CLASS_LOG_LEVEL_NOTICE:
 556                 return "NOTICE";
 557         case BT_EVENT_CLASS_LOG_LEVEL_INFO:
 558                 return "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:
 568                 return "DEBUG_UNIT";
 569         case BT_EVENT_CLASS_LOG_LEVEL_DEBUG_FUNCTION:
 570                 return "DEBUG_FUNCTION";
 571         case BT_EVENT_CLASS_LOG_LEVEL_DEBUG_LINE:
 572                 return "DEBUG_LINE";
 573         case BT_EVENT_CLASS_LOG_LEVEL_DEBUG:
 574                 return "DEBUG";
 575         }
 576
 577         bt_common_abort();
 578 };
 579
 580 static inline
 581 const char *bt_common_value_type_string(enum bt_value_type type)
 582 {
 583         switch (type) {
 584         case BT_VALUE_TYPE_NULL:
 585                 return "NULL";
 586         case BT_VALUE_TYPE_BOOL:
 587                 return "BOOL";
 588         case BT_VALUE_TYPE_INTEGER:
 589                 return "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:
 595                 return "REAL";
 596         case BT_VALUE_TYPE_STRING:
 597                 return "STRING";
 598         case BT_VALUE_TYPE_ARRAY:
 599                 return "ARRAY";
 600         case BT_VALUE_TYPE_MAP:
 601                 return "MAP";
 602         }
 603
 604         bt_common_abort();
 605 };
 606
 607 static inline
 608 GString *bt_common_field_path_string(struct bt_field_path *path)
 609 {
 610         GString *str = g_string_new(NULL);
 611         uint64_t i;
 612
 613         BT_ASSERT_DBG(path);
 614
 615         if (!str) {
 616                 goto end;
 617         }
 618
 619         g_string_append_printf(str, "[%s", bt_common_scope_string(
 620                 bt_field_path_get_root_scope(path)));
 621
 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);
 625
 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));
 630                         break;
 631                 case BT_FIELD_PATH_ITEM_TYPE_CURRENT_ARRAY_ELEMENT:
 632                         g_string_append(str, ", <CUR>");
 633                         break;
 634                 default:
 635                         bt_common_abort();
 636                 }
 637         }
 638
 639         g_string_append(str, "]");
 640
 641 end:
 642         return str;
 643 }
 644
 645 static inline
 646 const char *bt_common_logging_level_string(
 647                 enum bt_logging_level level)
 648 {
 649         switch (level) {
 650         case BT_LOGGING_LEVEL_TRACE:
 651                 return "TRACE";
 652         case BT_LOGGING_LEVEL_DEBUG:
 653                 return "DEBUG";
 654         case BT_LOGGING_LEVEL_INFO:
 655                 return "INFO";
 656         case BT_LOGGING_LEVEL_WARNING:
 657                 return "WARNING";
 658         case BT_LOGGING_LEVEL_ERROR:
 659                 return "ERROR";
 660         case BT_LOGGING_LEVEL_FATAL:
 661                 return "FATAL";
 662         case BT_LOGGING_LEVEL_NONE:
 663                 return "NONE";
 664         }
 665
 666         bt_common_abort();
 667 };
 668
 669 static inline
 670 const char *bt_common_func_status_string(int status)
 671 {
 672         switch (status) {
 673         case __BT_FUNC_STATUS_OVERFLOW_ERROR:
 674                 return "OVERFLOW";
 675         case __BT_FUNC_STATUS_MEMORY_ERROR:
 676                 return "MEMORY_ERROR";
 677         case __BT_FUNC_STATUS_USER_ERROR:
 678                 return "USER_ERROR";
 679         case __BT_FUNC_STATUS_ERROR:
 680                 return "ERROR";
 681         case __BT_FUNC_STATUS_OK:
 682                 return "OK";
 683         case __BT_FUNC_STATUS_END:
 684                 return "END";
 685         case __BT_FUNC_STATUS_NOT_FOUND:
 686                 return "NOT_FOUND";
 687         case __BT_FUNC_STATUS_INTERRUPTED:
 688                 return "INTERRUPTED";
 689         case __BT_FUNC_STATUS_NO_MATCH:
 690                 return "NO_MATCH";
 691         case __BT_FUNC_STATUS_AGAIN:
 692                 return "AGAIN";
 693         case __BT_FUNC_STATUS_UNKNOWN_OBJECT:
 694                 return "UNKNOWN_OBJECT";
 695         }
 696
 697         bt_common_abort();
 698 }
 699
 700 #define NS_PER_S_I      INT64_C(1000000000)
 701 #define NS_PER_S_U      UINT64_C(1000000000)
 702
 703 static inline
 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,
 707                 uint64_t *raw_value)
 708 {
 709         int ret = 0;
 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;
 715         int64_t ns_to_add;
 716
 717         BT_ASSERT_DBG(raw_value);
 718
 719         /* Compute offset part of requested value, in nanoseconds */
 720         if (!bt_safe_to_mul_int64(cc_offset_seconds, NS_PER_S_I)) {
 721                 ret = -1;
 722                 goto end;
 723         }
 724
 725         offset_in_ns = cc_offset_seconds * NS_PER_S_I;
 726
 727         if (cc_freq == NS_PER_S_U) {
 728                 ns_to_add = (int64_t) cc_offset_cycles;
 729         } else {
 730                 if (!bt_safe_to_mul_int64((int64_t) cc_offset_cycles,
 731                                 NS_PER_S_I)) {
 732                         ret = -1;
 733                         goto end;
 734                 }
 735
 736                 ns_to_add = ((int64_t) cc_offset_cycles * NS_PER_S_I) /
 737                         (int64_t) cc_freq;
 738         }
 739
 740         if (!bt_safe_to_add_int64(offset_in_ns, ns_to_add)) {
 741                 ret = -1;
 742                 goto end;
 743         }
 744
 745         offset_in_ns += ns_to_add;
 746
 747         /* Value part in nanoseconds */
 748         if (ns_from_origin < offset_in_ns) {
 749                 ret = -1;
 750                 goto end;
 751         }
 752
 753         value_in_ns = (uint64_t) (ns_from_origin - offset_in_ns);
 754
 755         /* Number of whole clock periods in `value_in_ns` */
 756         value_periods = value_in_ns / NS_PER_S_U;
 757
 758         /* Remaining nanoseconds in cycles + whole clock periods in cycles */
 759         rem_value_in_ns = value_in_ns - value_periods * NS_PER_S_U;
 760
 761         if (value_periods > UINT64_MAX / cc_freq) {
 762                 ret = -1;
 763                 goto end;
 764         }
 765
 766         if (!bt_safe_to_mul_uint64(value_periods, cc_freq)) {
 767                 ret = -1;
 768                 goto end;
 769         }
 770
 771         value_period_cycles = value_periods * cc_freq;
 772
 773         if (!bt_safe_to_mul_uint64(cc_freq, rem_value_in_ns)) {
 774                 ret = -1;
 775                 goto end;
 776         }
 777
 778         if (!bt_safe_to_add_uint64(cc_freq * rem_value_in_ns / NS_PER_S_U,
 779                         value_period_cycles)) {
 780                 ret = -1;
 781                 goto end;
 782         }
 783
 784         *raw_value = cc_freq * rem_value_in_ns / NS_PER_S_U +
 785                 value_period_cycles;
 786
 787 end:
 788         return ret;
 789 }
 790
 791 /*
 792  * bt_g_string_append_printf cannot be inlined because it expects a
 793  * variadic argument list.
 794  */
 795 __BT_ATTR_FORMAT_PRINTF(2, 3)
 796 int bt_common_g_string_append_printf(GString *str, const char *fmt, ...);
 797
 798 static inline
 799 void bt_common_g_string_append(GString *str, const char *s)
 800 {
 801         gsize len, allocated_len, s_len;
 802
 803         /* str->len excludes \0. */
 804         len = str->len;
 805         /* Exclude \0. */
 806         allocated_len = str->allocated_len - 1;
 807         s_len = strlen(s);
 808         if (G_UNLIKELY(allocated_len < len + s_len)) {
 809                 /* Resize. */
 810                 g_string_set_size(str, len + s_len);
 811         } else {
 812                 str->len = len + s_len;
 813         }
 814         memcpy(str->str + len, s, s_len + 1);
 815 }
 816
 817 static inline
 818 void bt_common_g_string_append_c(GString *str, char c)
 819 {
 820         gsize len, allocated_len, s_len;
 821
 822         /* str->len excludes \0. */
 823         len = str->len;
 824         /* Exclude \0. */
 825         allocated_len = str->allocated_len - 1;
 826         s_len = 1;
 827         if (G_UNLIKELY(allocated_len < len + s_len)) {
 828                 /* Resize. */
 829                 g_string_set_size(str, len + s_len);
 830         } else {
 831                 str->len = len + s_len;
 832         }
 833         str->str[len] = c;
 834         str->str[len + 1] = '\0';
 835 }
 836
 837 static inline
 838 const char *bt_common_component_class_type_string(
 839                 enum bt_component_class_type type)
 840 {
 841         switch (type) {
 842         case BT_COMPONENT_CLASS_TYPE_SOURCE:
 843                 return "SOURCE";
 844         case BT_COMPONENT_CLASS_TYPE_SINK:
 845                 return "SINK";
 846         case BT_COMPONENT_CLASS_TYPE_FILTER:
 847                 return "FILTER";
 848         }
 849
 850         bt_common_abort();
 851 }
 852
 853 static inline
 854 const char *bt_common_message_type_string(enum bt_message_type type)
 855 {
 856         switch (type) {
 857         case BT_MESSAGE_TYPE_STREAM_BEGINNING:
 858                 return "STREAM_BEGINNING";
 859         case BT_MESSAGE_TYPE_STREAM_END:
 860                 return "STREAM_END";
 861         case BT_MESSAGE_TYPE_EVENT:
 862                 return "EVENT";
 863         case BT_MESSAGE_TYPE_PACKET_BEGINNING:
 864                 return "PACKET_BEGINNING";
 865         case BT_MESSAGE_TYPE_PACKET_END:
 866                 return "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";
 873         }
 874
 875         bt_common_abort();
 876 }
 877
 878 #ifdef __cplusplus
 879 }
 880 #endif
 881
 882 #endif /* BABELTRACE_COMMON_INTERNAL_H */