bt_common_abort(): optionally execute a custom command before aborting
[babeltrace.git] / src / common / common.c
index d092768a147cf9a18bcabd001229d5966ff5fdfa..3acad47cfd88a2671293442f0f3f89894be5a967 100644 (file)
@@ -512,6 +512,7 @@ set_end_pos:
 error:
        if (output) {
                g_string_free(output, TRUE);
+               output = NULL;
        }
 
 end:
@@ -579,7 +580,7 @@ bool bt_common_string_is_printable(const char *input)
 {
        const char *ch;
        bool printable = true;
-       BT_ASSERT(input);
+       BT_ASSERT_DBG(input);
 
        for (ch = input; *ch != '\0'; ch++) {
                if (!isprint(*ch) && *ch != '\n' && *ch != '\r' &&
@@ -672,7 +673,7 @@ struct bt_common_lttng_live_url_parts bt_common_parse_lttng_live_url(
 
        at += end_pos;
 
-       /* :// */
+       /* `://` */
        if (strncmp(at, "://", 3) != 0) {
                if (error_buf) {
                        snprintf(error_buf, error_buf_size,
@@ -682,6 +683,7 @@ struct bt_common_lttng_live_url_parts bt_common_parse_lttng_live_url(
                goto error;
        }
 
+       /* Skip `://` */
        at += 3;
 
        /* Hostname */
@@ -731,12 +733,13 @@ struct bt_common_lttng_live_url_parts bt_common_parse_lttng_live_url(
        }
 
        if (at[end_pos] == '\0') {
+               /* Relay daemon hostname and ports provided only */
                goto end;
        }
 
        at += end_pos;
 
-       /* /host/ */
+       /* `/host/` */
        if (strncmp(at, "/host/", 6) != 0) {
                if (error_buf) {
                        snprintf(error_buf, error_buf_size,
@@ -760,9 +763,16 @@ struct bt_common_lttng_live_url_parts bt_common_parse_lttng_live_url(
        }
 
        if (at[end_pos] == '\0') {
-               goto end;
+               if (error_buf) {
+                       snprintf(error_buf, error_buf_size,
+                               "Missing `/` after target hostname (`%s`)",
+                               parts.target_hostname->str);
+               }
+
+               goto error;
        }
 
+       /* Skip `/` */
        at += end_pos + 1;
 
        /* Session name */
@@ -1246,7 +1256,7 @@ size_t bt_common_get_page_size(int log_level)
        if (page_size < 0) {
                BT_LOGF("Cannot get system's page size: ret=%d",
                        page_size);
-               abort();
+               bt_common_abort();
        }
 
        return page_size;
@@ -1261,7 +1271,7 @@ size_t bt_common_get_page_size(int log_level)
                strncpy(_tmp_fmt, *out_fmt_ch, _tmp_fmt_size);          \
                _tmp_fmt[_tmp_fmt_size] = '\0';                         \
                _count = snprintf(*buf_ch, _size, _tmp_fmt, __VA_ARGS__); \
-               BT_ASSERT(_count >= 0);                                 \
+               BT_ASSERT_DBG(_count >= 0);                                     \
                *buf_ch += MIN(_count, _size);                          \
        } while (0)
 
@@ -1403,13 +1413,11 @@ static inline void handle_conversion_specifier_std(char *buf, char **buf_ch,
 
                switch (length_mod) {
                case LENGTH_MOD_NONE:
-                       BUF_STD_APPEND_SINGLE_ARG(int);
-                       break;
                case LENGTH_MOD_LOW_L:
-                       BUF_STD_APPEND_SINGLE_ARG(wint_t);
+                       BUF_STD_APPEND_SINGLE_ARG(int);
                        break;
                default:
-                       abort();
+                       bt_common_abort();
                }
                break;
        }
@@ -1424,7 +1432,7 @@ static inline void handle_conversion_specifier_std(char *buf, char **buf_ch,
                        BUF_STD_APPEND_SINGLE_ARG(wchar_t *);
                        break;
                default:
-                       abort();
+                       bt_common_abort();
                }
                break;
        case 'd':
@@ -1447,7 +1455,7 @@ static inline void handle_conversion_specifier_std(char *buf, char **buf_ch,
                        BUF_STD_APPEND_SINGLE_ARG(size_t);
                        break;
                default:
-                       abort();
+                       bt_common_abort();
                }
                break;
        case 'o':
@@ -1472,7 +1480,7 @@ static inline void handle_conversion_specifier_std(char *buf, char **buf_ch,
                        BUF_STD_APPEND_SINGLE_ARG(size_t);
                        break;
                default:
-                       abort();
+                       bt_common_abort();
                }
                break;
        case 'f':
@@ -1491,7 +1499,7 @@ static inline void handle_conversion_specifier_std(char *buf, char **buf_ch,
                        BUF_STD_APPEND_SINGLE_ARG(long double);
                        break;
                default:
-                       abort();
+                       bt_common_abort();
                }
                break;
        case 'p':
@@ -1500,11 +1508,11 @@ static inline void handle_conversion_specifier_std(char *buf, char **buf_ch,
                if (length_mod == LENGTH_MOD_NONE) {
                        BUF_STD_APPEND_SINGLE_ARG(void *);
                } else {
-                       abort();
+                       bt_common_abort();
                }
                break;
        default:
-               abort();
+               bt_common_abort();
        }
 
 update_rw_fmt:
@@ -1520,13 +1528,13 @@ void bt_common_custom_vsnprintf(char *buf, size_t buf_size,
        const char *fmt_ch = fmt;
        char *buf_ch = buf;
 
-       BT_ASSERT(buf);
-       BT_ASSERT(fmt);
+       BT_ASSERT_DBG(buf);
+       BT_ASSERT_DBG(fmt);
 
        while (*fmt_ch != '\0') {
                switch (*fmt_ch) {
                case '%':
-                       BT_ASSERT(fmt_ch[1] != '\0');
+                       BT_ASSERT_DBG(fmt_ch[1] != '\0');
 
                        if (fmt_ch[1] == intro) {
                                handle_specifier(priv_data, &buf_ch,
@@ -1578,12 +1586,12 @@ void bt_common_sep_digits(char *str, unsigned int digits_per_group, char sep)
        uint64_t sep_count;
        uint64_t new_len;
 
-       BT_ASSERT(digits_per_group > 0);
-       BT_ASSERT(sep != '\0');
+       BT_ASSERT_DBG(digits_per_group > 0);
+       BT_ASSERT_DBG(sep != '\0');
 
        /* Compute new length of `str` */
        orig_len = strlen(str);
-       BT_ASSERT(orig_len > 0);
+       BT_ASSERT_DBG(orig_len > 0);
        sep_count = (orig_len - 1) / digits_per_group;
        new_len = strlen(str) + sep_count;
 
@@ -1683,10 +1691,10 @@ GString *bt_common_fold(const char *str, unsigned int total_length,
        gchar * const *line;
        unsigned int i;
 
-       BT_ASSERT(str);
-       BT_ASSERT(indent < total_length);
-       BT_ASSERT(tmp_line);
-       BT_ASSERT(folded);
+       BT_ASSERT_DBG(str);
+       BT_ASSERT_DBG(indent < total_length);
+       BT_ASSERT_DBG(tmp_line);
+       BT_ASSERT_DBG(folded);
 
        if (strlen(str) == 0) {
                /* Empty input string: empty output string */
@@ -1695,7 +1703,7 @@ GString *bt_common_fold(const char *str, unsigned int total_length,
 
        /* Split lines */
        lines = g_strsplit(str, "\n", 0);
-       BT_ASSERT(lines);
+       BT_ASSERT_DBG(lines);
 
        /* For each source line */
        for (line = lines; *line; line++) {
@@ -1712,7 +1720,7 @@ GString *bt_common_fold(const char *str, unsigned int total_length,
 
                /* Split words */
                line_words = g_strsplit(*line, " ", 0);
-               BT_ASSERT(line_words);
+               BT_ASSERT_DBG(line_words);
 
                /*
                 * Indent for first line (we know there's at least one
@@ -1780,9 +1788,7 @@ end:
                g_strfreev(lines);
        }
 
-       if (line_words) {
-               g_strfreev(line_words);
-       }
+       BT_ASSERT_DBG(!line_words);
 
        if (tmp_line) {
                g_string_free(tmp_line, TRUE);
@@ -1822,3 +1828,97 @@ end:
        return ret;
 }
 #endif /* __MINGW32__ */
+
+BT_HIDDEN
+int bt_common_g_string_append_printf(GString *str, const char *fmt, ...)
+{
+       va_list ap;
+       gsize len, allocated_len, available_len;
+       int print_len;
+
+       /* str->len excludes \0. */
+       len = str->len;
+       /* Explicitly exclude \0. */
+       allocated_len = str->allocated_len - 1;
+       available_len = allocated_len - len;
+
+       str->len = allocated_len;
+       va_start(ap, fmt);
+       print_len = vsnprintf(str->str + len, available_len + 1, fmt, ap);
+       va_end(ap);
+       if (print_len < 0) {
+               return print_len;
+       }
+       if (G_UNLIKELY(available_len < print_len)) {
+               /* Resize. */
+               g_string_set_size(str, len + print_len);
+               va_start(ap, fmt);
+               print_len = vsprintf(str->str + len, fmt, ap);
+               va_end(ap);
+       } else {
+               str->len = len + print_len;
+       }
+       return print_len;
+}
+
+BT_HIDDEN
+int bt_common_append_file_content_to_g_string(GString *str, FILE *fp)
+{
+       const size_t chunk_size = 4096;
+       int ret = 0;
+       char *buf;
+       size_t read_len;
+       gsize orig_len = str->len;
+
+       BT_ASSERT(str);
+       BT_ASSERT(fp);
+       buf = g_malloc(chunk_size);
+       if (!buf) {
+               ret = -1;
+               goto end;
+       }
+
+       while (true) {
+               if (ferror(fp)) {
+                       ret = -1;
+                       goto end;
+               }
+
+               if (feof(fp)) {
+                       break;
+               }
+
+               read_len = fread(buf, 1, chunk_size, fp);
+               g_string_append_len(str, buf, read_len);
+       }
+
+end:
+       if (ret) {
+               /* Remove what was appended */
+               g_string_truncate(str, orig_len);
+       }
+
+       g_free(buf);
+       return ret;
+}
+
+BT_HIDDEN
+void bt_common_abort(void)
+{
+       static const char * const exec_on_abort_env_name =
+               "BABELTRACE_EXEC_ON_ABORT";
+       const char *env_exec_on_abort;
+
+       env_exec_on_abort = getenv(exec_on_abort_env_name);
+       if (env_exec_on_abort) {
+               if (bt_common_is_setuid_setgid()) {
+                       goto do_abort;
+               }
+
+               (void) g_spawn_command_line_sync(env_exec_on_abort,
+                           NULL, NULL, NULL, NULL);
+       }
+
+do_abort:
+       abort();
+}
This page took 0.027002 seconds and 4 git commands to generate.