X-Git-Url: http://drtracing.org/?a=blobdiff_plain;f=src%2Fcommon%2Fcommon.h;h=b447ec889e51fa68d2ed5963b073b95759aec8f2;hb=5046c776430ff9f1c0580bad8cd36511fae636f8;hp=e931e2d10047aa188c439853bc634849ffcd4723;hpb=27c61ce8f6ee66d910507f8a40ae5497287c943e;p=babeltrace.git diff --git a/src/common/common.h b/src/common/common.h index e931e2d1..b447ec88 100644 --- a/src/common/common.h +++ b/src/common/common.h @@ -1,29 +1,13 @@ -#ifndef BABELTRACE_COMMON_INTERNAL_H -#define BABELTRACE_COMMON_INTERNAL_H - /* + * SPDX-License-Identifier: MIT + * * Copyright (c) 2018 EfficiOS Inc. and Linux Foundation * Copyright (c) 2018 Philippe Proulx - * - * Permission is hereby granted, free of charge, to any person obtaining a copy - * of this software and associated documentation files (the "Software"), to deal - * in the Software without restriction, including without limitation the rights - * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell - * copies of the Software, and to permit persons to whom the Software is - * furnished to do so, subject to the following conditions: - * - * The above copyright notice and this permission notice shall be included in - * all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR - * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, - * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE - * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER - * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, - * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE - * SOFTWARE. */ +#ifndef BABELTRACE_COMMON_INTERNAL_H +#define BABELTRACE_COMMON_INTERNAL_H + #include #include #include @@ -44,6 +28,10 @@ #include "common/macros.h" #include "common/safe.h" +#ifdef __cplusplus +extern "C" { +#endif + #define BT_COMMON_COLOR_RESET "\033[0m" #define BT_COMMON_COLOR_BOLD "\033[1m" #define BT_COMMON_COLOR_FG_DEFAULT "\033[39m" @@ -77,6 +65,40 @@ #define BT_COMMON_COLOR_BG_CYAN "\033[46m" #define BT_COMMON_COLOR_BG_LIGHT_GRAY "\033[47m" +enum bt_common_color_when { + BT_COMMON_COLOR_WHEN_AUTO, + BT_COMMON_COLOR_WHEN_ALWAYS, + BT_COMMON_COLOR_WHEN_NEVER, +}; + +struct bt_common_color_codes { + const char *reset; + const char *bold; + const char *fg_default; + const char *fg_red; + const char *fg_green; + const char *fg_yellow; + const char *fg_blue; + const char *fg_magenta; + const char *fg_cyan; + const char *fg_light_gray; + const char *fg_bright_red; + const char *fg_bright_green; + const char *fg_bright_yellow; + const char *fg_bright_blue; + const char *fg_bright_magenta; + const char *fg_bright_cyan; + const char *fg_bright_light_gray; + const char *bg_default; + const char *bg_red; + const char *bg_green; + const char *bg_yellow; + const char *bg_blue; + const char *bg_magenta; + const char *bg_cyan; + const char *bg_light_gray; +}; + struct bt_common_lttng_live_url_parts { GString *proto; GString *hostname; @@ -91,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); /* @@ -106,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); /* @@ -114,98 +133,73 @@ 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); +void bt_common_color_get_codes(struct bt_common_color_codes *codes, + enum bt_common_color_when use_colors); + /* * Returns the substring from `input` to the first character found * in the list of characters `end_chars`, unescaping any character * 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); @@ -216,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); @@ -240,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); @@ -248,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); @@ -271,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, @@ -326,7 +313,6 @@ 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, @@ -335,7 +321,6 @@ void bt_common_custom_vsnprintf(char *buf, size_t buf_size, /* * 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, @@ -344,7 +329,6 @@ void bt_common_custom_snprintf(char *buf, size_t buf_size, /* * Returns the system page size. */ -BT_HIDDEN size_t bt_common_get_page_size(int log_level); /* @@ -360,7 +344,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); /* @@ -376,7 +359,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); @@ -384,7 +366,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); /* @@ -393,10 +374,8 @@ 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)); /* @@ -416,7 +395,7 @@ ssize_t bt_common_read(int fd, void *buf, size_t count, int log_level) BT_ASSERT_DBG(count <= SSIZE_MAX); do { - ret = read(fd, buf + i, count - i); + ret = read(fd, ((char *) buf) + i, count - i); if (ret < 0) { if (errno == EINTR) { #ifdef BT_LOG_WRITE_CUR_LVL @@ -459,14 +438,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: @@ -475,29 +460,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 @@ -512,9 +515,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 @@ -529,9 +532,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 @@ -569,9 +572,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 @@ -582,6 +585,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: @@ -594,9 +599,9 @@ const char *bt_common_value_type_string(enum bt_value_type type) return "ARRAY"; case BT_VALUE_TYPE_MAP: return "MAP"; - default: - return "(unknown)"; } + + bt_common_abort(); }; static inline @@ -656,9 +661,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 @@ -667,8 +672,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: @@ -681,13 +684,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) @@ -785,7 +792,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) int bt_common_g_string_append_printf(GString *str, const char *fmt, ...); static inline @@ -827,4 +834,49 @@ 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 + #endif /* BABELTRACE_COMMON_INTERNAL_H */