Always evaluate BT_ASSERT(); add BT_ASSERT_DBG() for debug mode only

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

diff --git a/src/common/common.h b/src/common/common.h
index 88de75e64348e1da481d2f115187eca69f5634ce..ab19d098b37a693e3dbb318afe2cf1d09474b043 100644 (file)
--- a/src/common/common.h
+++ b/src/common/common.h
@@ -31,6 +31,7 @@
 #include <stdbool.h>
 #include <stdint.h>
 #include <stdlib.h>
+#include <stdio.h>
 #include <unistd.h>
 #include <string.h>
 
@@ -351,6 +352,15 @@ GString *bt_common_fold(const char *str, unsigned int total_length,
 BT_HIDDEN
 int bt_common_get_term_size(unsigned int *width, unsigned int *height);
 
+/*
+ * Appends the textual content of `fp` to `str`, starting from its
+ * current position to the end of the file.
+ *
+ * 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);
+
 /*
  * Wraps read() function to handle EINTR and partial reads.
  * On success, it returns `count` received as parameter. On error, it returns a
@@ -362,10 +372,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);
@@ -388,7 +398,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:
@@ -407,30 +417,46 @@ static inline
 const char *bt_common_field_class_type_string(enum bt_field_class_type class_type)
 {
        switch (class_type) {
+       case BT_FIELD_CLASS_TYPE_BOOL:
+               return "BOOL";
+       case BT_FIELD_CLASS_TYPE_BIT_ARRAY:
+               return "BIT_ARRAY";
        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_REAL:
-               return "REAL";
        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_SINGLE_PRECISION_REAL:
+               return "SINGLE_PRECISION_REAL";
+       case BT_FIELD_CLASS_TYPE_DOUBLE_PRECISION_REAL:
+               return "DOUBLE_PRECISION_REAL";
        case BT_FIELD_CLASS_TYPE_STRING:
                return "STRING";
        case BT_FIELD_CLASS_TYPE_STRUCTURE:
                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_VARIANT_WITHOUT_SELECTOR:
-               return "VARIANT_WITHOUT_SELECTOR";
-       case BT_FIELD_CLASS_TYPE_VARIANT_WITH_UNSIGNED_SELECTOR:
-               return "VARIANT_WITH_UNSIGNED_SELECTOR";
-       case BT_FIELD_CLASS_TYPE_VARIANT_WITH_SIGNED_SELECTOR:
-               return "VARIANT_WITH_SIGNED_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)";
        }
@@ -541,7 +567,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;
@@ -603,8 +629,8 @@ const char *bt_common_func_status_string(int status)
        switch (status) {
        case __BT_FUNC_STATUS_OVERFLOW_ERROR:
                return "OVERFLOW";
-       case __BT_FUNC_STATUS_INVALID_OBJECT:
-               return "INVALID_OBJECT";
+       case __BT_FUNC_STATUS_UNKNOWN_OBJECT:
+               return "UNKNOWN_OBJECT";
        case __BT_FUNC_STATUS_MEMORY_ERROR:
                return "MEMORY_ERROR";
        case __BT_FUNC_STATUS_ERROR:
@@ -641,7 +667,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)) {