lib: make bt_value_map_foreach_entry_{const_}func() return a status code

[babeltrace.git] / src / common / common.h

diff --git a/src/common/common.h b/src/common/common.h
index dead87927f8522712d5f15d259df6bf2ab88d4e1..e931e2d10047aa188c439853bc634849ffcd4723 100644 (file)
--- a/src/common/common.h
+++ b/src/common/common.h
@@ -44,24 +44,38 @@
 #include "common/macros.h"
 #include "common/safe.h"
 
-#define BT_COMMON_COLOR_RESET              "\033[0m"
-#define BT_COMMON_COLOR_BOLD               "\033[1m"
-#define BT_COMMON_COLOR_FG_DEFAULT         "\033[39m"
-#define BT_COMMON_COLOR_FG_RED             "\033[31m"
-#define BT_COMMON_COLOR_FG_GREEN           "\033[32m"
-#define BT_COMMON_COLOR_FG_YELLOW          "\033[33m"
-#define BT_COMMON_COLOR_FG_BLUE            "\033[34m"
-#define BT_COMMON_COLOR_FG_MAGENTA         "\033[35m"
-#define BT_COMMON_COLOR_FG_CYAN            "\033[36m"
-#define BT_COMMON_COLOR_FG_LIGHT_GRAY      "\033[37m"
-#define BT_COMMON_COLOR_BG_DEFAULT         "\033[49m"
-#define BT_COMMON_COLOR_BG_RED             "\033[41m"
-#define BT_COMMON_COLOR_BG_GREEN           "\033[42m"
-#define BT_COMMON_COLOR_BG_YELLOW          "\033[43m"
-#define BT_COMMON_COLOR_BG_BLUE            "\033[44m"
-#define BT_COMMON_COLOR_BG_MAGENTA         "\033[45m"
-#define BT_COMMON_COLOR_BG_CYAN            "\033[46m"
-#define BT_COMMON_COLOR_BG_LIGHT_GRAY      "\033[47m"
+#define BT_COMMON_COLOR_RESET                  "\033[0m"
+#define BT_COMMON_COLOR_BOLD                   "\033[1m"
+#define BT_COMMON_COLOR_FG_DEFAULT             "\033[39m"
+#define BT_COMMON_COLOR_FG_RED                 "\033[31m"
+#define BT_COMMON_COLOR_FG_GREEN               "\033[32m"
+#define BT_COMMON_COLOR_FG_YELLOW              "\033[33m"
+#define BT_COMMON_COLOR_FG_BLUE                        "\033[34m"
+#define BT_COMMON_COLOR_FG_MAGENTA             "\033[35m"
+#define BT_COMMON_COLOR_FG_CYAN                        "\033[36m"
+#define BT_COMMON_COLOR_FG_LIGHT_GRAY          "\033[37m"
+#define BT_COMMON_COLOR_FG_BOLD_RED            "\033[1m\033[31m"
+#define BT_COMMON_COLOR_FG_BOLD_GREEN          "\033[1m\033[32m"
+#define BT_COMMON_COLOR_FG_BOLD_YELLOW         "\033[1m\033[33m"
+#define BT_COMMON_COLOR_FG_BOLD_BLUE           "\033[1m\033[34m"
+#define BT_COMMON_COLOR_FG_BOLD_MAGENTA                "\033[1m\033[35m"
+#define BT_COMMON_COLOR_FG_BOLD_CYAN           "\033[1m\033[36m"
+#define BT_COMMON_COLOR_FG_BOLD_LIGHT_GRAY     "\033[1m\033[37m"
+#define BT_COMMON_COLOR_FG_BRIGHT_RED          "\033[91m"
+#define BT_COMMON_COLOR_FG_BRIGHT_GREEN                "\033[92m"
+#define BT_COMMON_COLOR_FG_BRIGHT_YELLOW       "\033[93m"
+#define BT_COMMON_COLOR_FG_BRIGHT_BLUE         "\033[94m"
+#define BT_COMMON_COLOR_FG_BRIGHT_MAGENTA      "\033[95m"
+#define BT_COMMON_COLOR_FG_BRIGHT_CYAN         "\033[96m"
+#define BT_COMMON_COLOR_FG_BRIGHT_LIGHT_GRAY   "\033[97m"
+#define BT_COMMON_COLOR_BG_DEFAULT             "\033[49m"
+#define BT_COMMON_COLOR_BG_RED                 "\033[41m"
+#define BT_COMMON_COLOR_BG_GREEN               "\033[42m"
+#define BT_COMMON_COLOR_BG_YELLOW              "\033[43m"
+#define BT_COMMON_COLOR_BG_BLUE                        "\033[44m"
+#define BT_COMMON_COLOR_BG_MAGENTA             "\033[45m"
+#define BT_COMMON_COLOR_BG_CYAN                        "\033[46m"
+#define BT_COMMON_COLOR_BG_LIGHT_GRAY          "\033[47m"
 
 struct bt_common_lttng_live_url_parts {
        GString *proto;
@@ -140,6 +154,27 @@ 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);
 
@@ -361,6 +396,9 @@ int bt_common_get_term_size(unsigned int *width, unsigned int *height);
 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
@@ -372,10 +410,10 @@ ssize_t bt_common_read(int fd, void *buf, size_t count, int log_level)
        size_t i = 0;
        ssize_t ret;
 
-       BT_ASSERT(buf);
+       BT_ASSERT_DBG(buf);
 
        /* Never return an overflow value. */
-       BT_ASSERT(count <= SSIZE_MAX);
+       BT_ASSERT_DBG(count <= SSIZE_MAX);
 
        do {
                ret = read(fd, buf + i, count - i);
@@ -398,7 +436,7 @@ ssize_t bt_common_read(int fd, void *buf, size_t count, int log_level)
                        }
                }
                i += ret;
-               BT_ASSERT(i <= count);
+               BT_ASSERT_DBG(i <= count);
        } while (count - i > 0 && ret > 0);
 
 end:
@@ -439,22 +477,24 @@ const char *bt_common_field_class_type_string(enum bt_field_class_type class_typ
                return "STRUCTURE";
        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_OPTION_WITHOUT_SELECTOR:
-               return "OPTION_WITHOUT_SELECTOR";
-       case BT_FIELD_CLASS_TYPE_OPTION_WITH_BOOL_SELECTOR:
-               return "OPTION_WITH_BOOL_SELECTOR";
-       case BT_FIELD_CLASS_TYPE_OPTION_WITH_UNSIGNED_INTEGER_SELECTOR:
-               return "OPTION_WITH_UNSIGNED_INTEGER_SELECTOR";
-       case BT_FIELD_CLASS_TYPE_OPTION_WITH_SIGNED_INTEGER_SELECTOR:
-               return "OPTION_WITH_SIGNED_INTEGER_SELECTOR";
-       case BT_FIELD_CLASS_TYPE_VARIANT_WITHOUT_SELECTOR:
-               return "VARIANT_WITHOUT_SELECTOR";
-       case BT_FIELD_CLASS_TYPE_VARIANT_WITH_UNSIGNED_INTEGER_SELECTOR:
-               return "VARIANT_WITH_UNSIGNED_INTEGER_SELECTOR";
-       case BT_FIELD_CLASS_TYPE_VARIANT_WITH_SIGNED_INTEGER_SELECTOR:
-               return "VARIANT_WITH_SIGNED_INTEGER_SELECTOR";
+       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_WITHOUT_SELECTOR_FIELD:
+               return "OPTION_WITHOUT_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_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_WITHOUT_SELECTOR_FIELD:
+               return "VARIANT_WITHOUT_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)";
        }
@@ -565,7 +605,7 @@ GString *bt_common_field_path_string(struct bt_field_path *path)
        GString *str = g_string_new(NULL);
        uint64_t i;
 
-       BT_ASSERT(path);
+       BT_ASSERT_DBG(path);
 
        if (!str) {
                goto end;
@@ -587,7 +627,7 @@ GString *bt_common_field_path_string(struct bt_field_path *path)
                        g_string_append(str, ", <CUR>");
                        break;
                default:
-                       abort();
+                       bt_common_abort();
                }
        }
 
@@ -631,6 +671,8 @@ const char *bt_common_func_status_string(int status)
                return "UNKNOWN_OBJECT";
        case __BT_FUNC_STATUS_MEMORY_ERROR:
                return "MEMORY_ERROR";
+       case __BT_FUNC_STATUS_USER_ERROR:
+               return "USER_ERROR";
        case __BT_FUNC_STATUS_ERROR:
                return "ERROR";
        case __BT_FUNC_STATUS_OK:
@@ -665,7 +707,7 @@ int bt_common_clock_value_from_ns_from_origin(
        uint64_t value_period_cycles;
        int64_t ns_to_add;
 
-       BT_ASSERT(raw_value);
+       BT_ASSERT_DBG(raw_value);
 
        /* Compute offset part of requested value, in nanoseconds */
        if (!bt_safe_to_mul_int64(cc_offset_seconds, NS_PER_S_I)) {