doc/api/libbabeltrace2/DoxygenLayout.xml: use `topics` tab
[babeltrace.git] / src / common / common.h
index 5266404c934e9e945a129a08c122ecc6cd4f3889..fd9da4e70f98a3430f6f9a44cfb751f31df28e1c 100644 (file)
@@ -113,14 +113,12 @@ struct bt_common_lttng_live_url_parts {
  * Checks if the current process has setuid or setgid access rights.
  * Returns `true` if so.
  */
-BT_HIDDEN
 bool bt_common_is_setuid_setgid(void);
 
 /*
  * Returns the system-wide plugin path, e.g.
  * `/usr/lib/babeltrace2/plugins`. Do not free the return value.
  */
-BT_HIDDEN
 const char *bt_common_get_system_plugin_path(void);
 
 /*
@@ -128,7 +126,6 @@ const char *bt_common_get_system_plugin_path(void);
  * `/home/user/.local/lib/babeltrace2/plugins`. You need to free the
  * return value.
  */
-BT_HIDDEN
 char *bt_common_get_home_plugin_path(int log_level);
 
 /*
@@ -136,92 +133,64 @@ char *bt_common_get_home_plugin_path(int log_level);
  * `paths` is a list of directories separated by `:`. Returns 0 on
  * success.
  */
-BT_HIDDEN
 int bt_common_append_plugin_path_dirs(const char *paths, GPtrArray *dirs);
 
 /*
  * Returns `true` if terminal color codes are supported for this
  * process.
  */
-BT_HIDDEN
 bool bt_common_colors_supported(void);
 
-BT_HIDDEN
 const char *bt_common_color_reset(void);
 
-BT_HIDDEN
 const char *bt_common_color_bold(void);
 
-BT_HIDDEN
 const char *bt_common_color_fg_default(void);
 
-BT_HIDDEN
 const char *bt_common_color_fg_red(void);
 
-BT_HIDDEN
 const char *bt_common_color_fg_green(void);
 
-BT_HIDDEN
 const char *bt_common_color_fg_yellow(void);
 
-BT_HIDDEN
 const char *bt_common_color_fg_blue(void);
 
-BT_HIDDEN
 const char *bt_common_color_fg_magenta(void);
 
-BT_HIDDEN
 const char *bt_common_color_fg_cyan(void);
 
-BT_HIDDEN
 const char *bt_common_color_fg_light_gray(void);
 
-BT_HIDDEN
 const char *bt_common_color_fg_bright_red(void);
 
-BT_HIDDEN
 const char *bt_common_color_fg_bright_green(void);
 
-BT_HIDDEN
 const char *bt_common_color_fg_bright_yellow(void);
 
-BT_HIDDEN
 const char *bt_common_color_fg_bright_blue(void);
 
-BT_HIDDEN
 const char *bt_common_color_fg_bright_magenta(void);
 
-BT_HIDDEN
 const char *bt_common_color_fg_bright_cyan(void);
 
-BT_HIDDEN
 const char *bt_common_color_fg_bright_light_gray(void);
 
-BT_HIDDEN
 const char *bt_common_color_bg_default(void);
 
-BT_HIDDEN
 const char *bt_common_color_bg_red(void);
 
-BT_HIDDEN
 const char *bt_common_color_bg_green(void);
 
-BT_HIDDEN
 const char *bt_common_color_bg_yellow(void);
 
-BT_HIDDEN
 const char *bt_common_color_bg_blue(void);
 
-BT_HIDDEN
 const char *bt_common_color_bg_magenta(void);
 
-BT_HIDDEN
 const char *bt_common_color_bg_cyan(void);
 
-BT_HIDDEN
 const char *bt_common_color_bg_light_gray(void);
 
-BT_HIDDEN
 void bt_common_color_get_codes(struct bt_common_color_codes *codes,
                enum bt_common_color_when use_colors);
 
@@ -231,7 +200,6 @@ void bt_common_color_get_codes(struct bt_common_color_codes *codes,
  * found in `escapable_chars`, and sets `*end_pos` to the position of
  * the end (from `input`). The caller owns the returned GString.
  */
-BT_HIDDEN
 GString *bt_common_string_until(const char *input, const char *escapable_chars,
                     const char *end_chars, size_t *end_pos);
 
@@ -242,21 +210,18 @@ GString *bt_common_string_until(const char *input, const char *escapable_chars,
  * prepend and append them manually, although they are not always
  * required. The caller owns the returned GString.
  */
-BT_HIDDEN
 GString *bt_common_shell_quote(const char *input, bool with_single_quotes);
 
 /*
  * Returns `true` if `input` is a string made only of printable
  * characters.
  */
-BT_HIDDEN
 bool bt_common_string_is_printable(const char *input);
 
 /*
  * Destroys the parts of an LTTng live URL as returned by
  * bt_common_parse_lttng_live_url().
  */
-BT_HIDDEN
 void bt_common_destroy_lttng_live_url_parts(
                struct bt_common_lttng_live_url_parts *parts);
 
@@ -266,7 +231,6 @@ void bt_common_destroy_lttng_live_url_parts(
  * up to `error_buf_size` bytes. You must destroy the returned value
  * with bt_common_destroy_lttng_live_url_parts().
  */
-BT_HIDDEN
 struct bt_common_lttng_live_url_parts bt_common_parse_lttng_live_url(
                const char *url, char *error_buf, size_t error_buf_size);
 
@@ -274,14 +238,12 @@ struct bt_common_lttng_live_url_parts bt_common_parse_lttng_live_url(
  * Normalizes (in place) a star globbing pattern to be used with
  * bt_common_star_glob_match(). This function always succeeds.
  */
-BT_HIDDEN
 void bt_common_normalize_star_glob_pattern(char *pattern);
 
 /*
  * Returns `true` if `candidate` (of size `candidate_len`) matches
  * the star globbing pattern `pattern` (of size `pattern_len`).
  */
-BT_HIDDEN
 bool bt_common_star_glob_match(const char *pattern, size_t pattern_len,
                 const char *candidate, size_t candidate_len);
 
@@ -297,7 +259,6 @@ bool bt_common_star_glob_match(const char *pattern, size_t pattern_len,
  *
  * The caller owns the returned GString.
  */
-BT_HIDDEN
 GString *bt_common_normalize_path(const char *path, const char *wd);
 
 typedef void (* bt_common_handle_custom_specifier_func)(void *priv_data,
@@ -352,31 +313,20 @@ typedef void (* bt_common_handle_custom_specifier_func)(void *priv_data,
  * do not return error codes: they abort when there's any error (bad
  * format string, for example).
  */
-BT_HIDDEN
 void bt_common_custom_vsnprintf(char *buf, size_t buf_size,
                char intro,
                bt_common_handle_custom_specifier_func handle_specifier,
                void *priv_data, const char *fmt, va_list *args);
 
-/*
- * Variadic form of bt_common_custom_vsnprintf().
- */
-BT_HIDDEN
-void bt_common_custom_snprintf(char *buf, size_t buf_size,
-               char intro,
-               bt_common_handle_custom_specifier_func handle_specifier,
-               void *priv_data, const char *fmt, ...);
-
 /*
  * Returns the system page size.
  */
-BT_HIDDEN
 size_t bt_common_get_page_size(int log_level);
 
 /*
  * Adds the digit separator `sep` as many times as needed to form groups
  * of `digits_per_group` digits within `str`. `str` must have enough
- * room to accomodate the new separators, that is:
+ * room to accommodate the new separators, that is:
  *
  *     strlen(str) + (strlen(str) / digits_per_group) + 1
  *
@@ -386,7 +336,6 @@ size_t bt_common_get_page_size(int log_level);
  * `strlen(str)` must not be 0. `digits_per_group` must not be 0. `sep`
  * must not be `\0`.
  */
-BT_HIDDEN
 void bt_common_sep_digits(char *str, unsigned int digits_per_group, char sep);
 
 /*
@@ -402,7 +351,6 @@ void bt_common_sep_digits(char *str, unsigned int digits_per_group, char sep);
  *
  * The returned string, on success, is owned by the caller.
  */
-BT_HIDDEN
 GString *bt_common_fold(const char *str, unsigned int total_length,
                unsigned int indent);
 
@@ -410,7 +358,6 @@ GString *bt_common_fold(const char *str, unsigned int total_length,
  * Writes the terminal's width to `*width`, its height to `*height`,
  * and returns 0 on success, or returns -1 on error.
  */
-BT_HIDDEN
 int bt_common_get_term_size(unsigned int *width, unsigned int *height);
 
 /*
@@ -419,64 +366,10 @@ int bt_common_get_term_size(unsigned int *width, unsigned int *height);
  *
  * This function does NOT rewind `fp` once it's done or on error.
  */
-BT_HIDDEN
 int bt_common_append_file_content_to_g_string(GString *str, FILE *fp);
 
-BT_HIDDEN
 void bt_common_abort(void) __attribute__((noreturn));
 
-/*
- * Wraps read() function to handle EINTR and partial reads.
- * On success, it returns `count` received as parameter. On error, it returns a
- * value smaller than the requested `count`.
- */
-static inline
-ssize_t bt_common_read(int fd, void *buf, size_t count, int log_level)
-{
-       size_t i = 0;
-       ssize_t ret;
-
-       BT_ASSERT_DBG(buf);
-
-       /* Never return an overflow value. */
-       BT_ASSERT_DBG(count <= SSIZE_MAX);
-
-       do {
-               ret = read(fd, ((char *) buf) + i, count - i);
-               if (ret < 0) {
-                       if (errno == EINTR) {
-#ifdef BT_LOG_WRITE_CUR_LVL
-                               BT_LOG_WRITE_CUR_LVL(BT_LOG_DEBUG, log_level,
-                                       BT_LOG_TAG,
-                                       "read() call interrupted; retrying...");
-#endif
-                               /* retry operation */
-                               continue;
-                       } else {
-#ifdef BT_LOG_WRITE_ERRNO_CUR_LVL
-                               BT_LOG_WRITE_ERRNO_CUR_LVL(BT_LOG_ERROR,
-                                       log_level, BT_LOG_TAG,
-                                       "Error while reading", ": fd=%d", fd);
-#endif
-                               goto end;
-                       }
-               }
-               i += ret;
-               BT_ASSERT_DBG(i <= count);
-       } while (count - i > 0 && ret > 0);
-
-end:
-       if (ret >= 0) {
-               if (i == 0) {
-                       ret = -1;
-               } else {
-                       ret = i;
-               }
-       }
-
-       return ret;
-}
-
 static inline
 const char *bt_common_field_class_type_string(enum bt_field_class_type class_type)
 {
@@ -485,14 +378,20 @@ const char *bt_common_field_class_type_string(enum bt_field_class_type class_typ
                return "BOOL";
        case BT_FIELD_CLASS_TYPE_BIT_ARRAY:
                return "BIT_ARRAY";
+       case BT_FIELD_CLASS_TYPE_INTEGER:
+               return "INTEGER";
        case BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER:
                return "UNSIGNED_INTEGER";
        case BT_FIELD_CLASS_TYPE_SIGNED_INTEGER:
                return "SIGNED_INTEGER";
+       case BT_FIELD_CLASS_TYPE_ENUMERATION:
+               return "ENUMERATION";
        case BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION:
                return "UNSIGNED_ENUMERATION";
        case BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION:
                return "SIGNED_ENUMERATION";
+       case BT_FIELD_CLASS_TYPE_REAL:
+               return "REAL";
        case BT_FIELD_CLASS_TYPE_SINGLE_PRECISION_REAL:
                return "SINGLE_PRECISION_REAL";
        case BT_FIELD_CLASS_TYPE_DOUBLE_PRECISION_REAL:
@@ -501,29 +400,47 @@ const char *bt_common_field_class_type_string(enum bt_field_class_type class_typ
                return "STRING";
        case BT_FIELD_CLASS_TYPE_STRUCTURE:
                return "STRUCTURE";
+       case BT_FIELD_CLASS_TYPE_ARRAY:
+               return "ARRAY";
        case BT_FIELD_CLASS_TYPE_STATIC_ARRAY:
                return "STATIC_ARRAY";
+       case BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY:
+               return "DYNAMIC_ARRAY";
        case BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY_WITHOUT_LENGTH_FIELD:
                return "DYNAMIC_ARRAY_WITHOUT_LENGTH_FIELD";
        case BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY_WITH_LENGTH_FIELD:
                return "DYNAMIC_ARRAY_WITH_LENGTH_FIELD";
+       case BT_FIELD_CLASS_TYPE_OPTION:
+               return "OPTION";
        case BT_FIELD_CLASS_TYPE_OPTION_WITHOUT_SELECTOR_FIELD:
                return "OPTION_WITHOUT_SELECTOR_FIELD";
+       case BT_FIELD_CLASS_TYPE_OPTION_WITH_SELECTOR_FIELD:
+               return "OPTION_WITH_SELECTOR_FIELD";
        case BT_FIELD_CLASS_TYPE_OPTION_WITH_BOOL_SELECTOR_FIELD:
                return "OPTION_WITH_BOOL_SELECTOR_FIELD";
+       case BT_FIELD_CLASS_TYPE_OPTION_WITH_INTEGER_SELECTOR_FIELD:
+               return "OPTION_WITH_INTEGER_SELECTOR_FIELD";
        case BT_FIELD_CLASS_TYPE_OPTION_WITH_UNSIGNED_INTEGER_SELECTOR_FIELD:
                return "OPTION_WITH_UNSIGNED_INTEGER_SELECTOR_FIELD";
        case BT_FIELD_CLASS_TYPE_OPTION_WITH_SIGNED_INTEGER_SELECTOR_FIELD:
                return "OPTION_WITH_SIGNED_INTEGER_SELECTOR_FIELD";
+       case BT_FIELD_CLASS_TYPE_VARIANT:
+               return "VARIANT";
        case BT_FIELD_CLASS_TYPE_VARIANT_WITHOUT_SELECTOR_FIELD:
                return "VARIANT_WITHOUT_SELECTOR_FIELD";
+       case BT_FIELD_CLASS_TYPE_VARIANT_WITH_SELECTOR_FIELD:
+               return "VARIANT_WITH_SELECTOR_FIELD";
+       case BT_FIELD_CLASS_TYPE_VARIANT_WITH_INTEGER_SELECTOR_FIELD:
+               return "VARIANT_WITH_INTEGER_SELECTOR_FIELD";
        case BT_FIELD_CLASS_TYPE_VARIANT_WITH_UNSIGNED_INTEGER_SELECTOR_FIELD:
                return "VARIANT_WITH_UNSIGNED_INTEGER_SELECTOR_FIELD";
        case BT_FIELD_CLASS_TYPE_VARIANT_WITH_SIGNED_INTEGER_SELECTOR_FIELD:
                return "VARIANT_WITH_SIGNED_INTEGER_SELECTOR_FIELD";
-       default:
-               return "(unknown)";
+       case __BT_FIELD_CLASS_TYPE_BIG_VALUE:
+               bt_common_abort ();
        }
+
+       bt_common_abort();
 };
 
 static inline
@@ -538,9 +455,9 @@ const char *bt_common_field_class_integer_preferred_display_base_string(enum bt_
                return "DECIMAL";
        case BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_HEXADECIMAL:
                return "HEXADECIMAL";
-       default:
-               return "(unknown)";
        }
+
+       bt_common_abort();
 }
 
 static inline
@@ -555,9 +472,9 @@ const char *bt_common_scope_string(enum bt_field_path_scope scope)
                return "EVENT_SPECIFIC_CONTEXT";
        case BT_FIELD_PATH_SCOPE_EVENT_PAYLOAD:
                return "EVENT_PAYLOAD";
-       default:
-               return "(unknown)";
        }
+
+       bt_common_abort();
 }
 
 static inline
@@ -595,9 +512,9 @@ const char *bt_common_event_class_log_level_string(
                return "DEBUG_LINE";
        case BT_EVENT_CLASS_LOG_LEVEL_DEBUG:
                return "DEBUG";
-       default:
-               return "(unknown)";
        }
+
+       bt_common_abort();
 };
 
 static inline
@@ -608,6 +525,8 @@ const char *bt_common_value_type_string(enum bt_value_type type)
                return "NULL";
        case BT_VALUE_TYPE_BOOL:
                return "BOOL";
+       case BT_VALUE_TYPE_INTEGER:
+               return "INTEGER";
        case BT_VALUE_TYPE_UNSIGNED_INTEGER:
                return "UNSIGNED_INTEGER";
        case BT_VALUE_TYPE_SIGNED_INTEGER:
@@ -620,48 +539,10 @@ const char *bt_common_value_type_string(enum bt_value_type type)
                return "ARRAY";
        case BT_VALUE_TYPE_MAP:
                return "MAP";
-       default:
-               return "(unknown)";
-       }
-};
-
-static inline
-GString *bt_common_field_path_string(struct bt_field_path *path)
-{
-       GString *str = g_string_new(NULL);
-       uint64_t i;
-
-       BT_ASSERT_DBG(path);
-
-       if (!str) {
-               goto end;
-       }
-
-       g_string_append_printf(str, "[%s", bt_common_scope_string(
-               bt_field_path_get_root_scope(path)));
-
-       for (i = 0; i < bt_field_path_get_item_count(path); i++) {
-               const struct bt_field_path_item *fp_item =
-                       bt_field_path_borrow_item_by_index_const(path, i);
-
-               switch (bt_field_path_item_get_type(fp_item)) {
-               case BT_FIELD_PATH_ITEM_TYPE_INDEX:
-                       g_string_append_printf(str, ", %" PRIu64,
-                               bt_field_path_item_index_get_index(fp_item));
-                       break;
-               case BT_FIELD_PATH_ITEM_TYPE_CURRENT_ARRAY_ELEMENT:
-                       g_string_append(str, ", <CUR>");
-                       break;
-               default:
-                       bt_common_abort();
-               }
        }
 
-       g_string_append(str, "]");
-
-end:
-       return str;
-}
+       bt_common_abort();
+};
 
 static inline
 const char *bt_common_logging_level_string(
@@ -682,9 +563,9 @@ const char *bt_common_logging_level_string(
                return "FATAL";
        case BT_LOGGING_LEVEL_NONE:
                return "NONE";
-       default:
-               return "(unknown)";
        }
+
+       bt_common_abort();
 };
 
 static inline
@@ -693,8 +574,6 @@ const char *bt_common_func_status_string(int status)
        switch (status) {
        case __BT_FUNC_STATUS_OVERFLOW_ERROR:
                return "OVERFLOW";
-       case __BT_FUNC_STATUS_UNKNOWN_OBJECT:
-               return "UNKNOWN_OBJECT";
        case __BT_FUNC_STATUS_MEMORY_ERROR:
                return "MEMORY_ERROR";
        case __BT_FUNC_STATUS_USER_ERROR:
@@ -707,13 +586,17 @@ const char *bt_common_func_status_string(int status)
                return "END";
        case __BT_FUNC_STATUS_NOT_FOUND:
                return "NOT_FOUND";
-       case __BT_FUNC_STATUS_AGAIN:
-               return "AGAIN";
        case __BT_FUNC_STATUS_INTERRUPTED:
                return "INTERRUPTED";
-       default:
-               return "(unknown)";
+       case __BT_FUNC_STATUS_NO_MATCH:
+               return "NO_MATCH";
+       case __BT_FUNC_STATUS_AGAIN:
+               return "AGAIN";
+       case __BT_FUNC_STATUS_UNKNOWN_OBJECT:
+               return "UNKNOWN_OBJECT";
        }
+
+       bt_common_abort();
 }
 
 #define NS_PER_S_I     INT64_C(1000000000)
@@ -811,7 +694,7 @@ end:
  * bt_g_string_append_printf cannot be inlined because it expects a
  * variadic argument list.
  */
-BT_HIDDEN __BT_ATTR_FORMAT_PRINTF(2, 3)
+__BT_ATTR_FORMAT_PRINTF(2, 3)
 int bt_common_g_string_append_printf(GString *str, const char *fmt, ...);
 
 static inline
@@ -853,6 +736,47 @@ void bt_common_g_string_append_c(GString *str, char c)
        str->str[len + 1] = '\0';
 }
 
+static inline
+const char *bt_common_component_class_type_string(
+               enum bt_component_class_type type)
+{
+       switch (type) {
+       case BT_COMPONENT_CLASS_TYPE_SOURCE:
+               return "SOURCE";
+       case BT_COMPONENT_CLASS_TYPE_SINK:
+               return "SINK";
+       case BT_COMPONENT_CLASS_TYPE_FILTER:
+               return "FILTER";
+       }
+
+       bt_common_abort();
+}
+
+static inline
+const char *bt_common_message_type_string(enum bt_message_type type)
+{
+       switch (type) {
+       case BT_MESSAGE_TYPE_STREAM_BEGINNING:
+               return "STREAM_BEGINNING";
+       case BT_MESSAGE_TYPE_STREAM_END:
+               return "STREAM_END";
+       case BT_MESSAGE_TYPE_EVENT:
+               return "EVENT";
+       case BT_MESSAGE_TYPE_PACKET_BEGINNING:
+               return "PACKET_BEGINNING";
+       case BT_MESSAGE_TYPE_PACKET_END:
+               return "PACKET_END";
+       case BT_MESSAGE_TYPE_DISCARDED_EVENTS:
+               return "DISCARDED_EVENTS";
+       case BT_MESSAGE_TYPE_DISCARDED_PACKETS:
+               return "DISCARDED_PACKETS";
+       case BT_MESSAGE_TYPE_MESSAGE_ITERATOR_INACTIVITY:
+               return "MESSAGE_ITERATOR_INACTIVITY";
+       }
+
+       bt_common_abort();
+}
+
 #ifdef __cplusplus
 }
 #endif
This page took 0.029103 seconds and 4 git commands to generate.