Consolidate CLI output functions

cli/include/hse/cli/output.h

@@ -0,0 +1,21 @@
+/* SPDX-License-Identifier: Apache-2.0 OR MIT
+ *
+ * SPDX-FileCopyrightText: Copyright 2023 Micron Technology, Inc.
+ */
+
+#include <hse/types.h>
+
+#include <hse/util/compiler.h>
+
+HSE_PRINTF(2, 3) void
+error(hse_err_t err, const char *fmt, ...);
+
+#define errorx(_fmt, ...) error(0, (_fmt), ##__VA_ARGS__)
+
+HSE_PRINTF(2, 3) HSE_NORETURN void
+fatal(hse_err_t err, const char *fmt, ...);
+
+#define fatalx(_fmt, ...) fatal(0, (_fmt), ##__VA_ARGS__)
+
+HSE_PRINTF(1, 2) HSE_NORETURN void
+syntax(const char *fmt, ...);

cli/lib/meson.build

@@ -3,6 +3,7 @@
 # SPDX-FileCopyrightText: Copyright 2021 Micron Technology, Inc.
 
 cli_sources = files(
+    'output.c',
     'param.c',
     'program.c',
     'rest/api.c',

cli/lib/output.c

@@ -0,0 +1,81 @@
+/* SPDX-License-Identifier: Apache-2.0 OR MIT
+ *
+ * SPDX-FileCopyrightText: Copyright 2023 Micron Technology, Inc.
+ */
+
+#include <assert.h>
+#include <stdarg.h>
+#include <stddef.h>
+#include <stdio.h>
+#include <stdlib.h>
+#include <sysexits.h>
+
+#include <hse/hse.h>
+
+#include <hse/cli/output.h>
+#include <hse/cli/program.h>
+#include <hse/util/compiler.h>
+
+static thread_local char error_buffer_tls[1024];
+
+static void
+eprint(const hse_err_t err, const char *fmt, va_list ap)
+{
+    int rc HSE_MAYBE_UNUSED;
+
+    /* We take progname from argv[0]. argv[0] may contain % symbols which could
+     * cause an escape in the vfprintf() below, so just print it plainly for
+     * safety.
+     */
+    fputs(progname, stderr);
+    if (err) {
+        char buf[256];
+        size_t needed_sz HSE_MAYBE_UNUSED;
+
+        needed_sz = hse_strerror(err, buf, sizeof(buf));
+        assert(needed_sz < sizeof(buf));
+
+        rc = snprintf(error_buffer_tls, sizeof(error_buffer_tls), ": %s: %s\n", fmt, buf);
+    } else {
+        rc = snprintf(error_buffer_tls, sizeof(error_buffer_tls), ": %s\n", fmt);
+    }
+    assert(rc >= 0 && rc < sizeof(error_buffer_tls));
+
+    vfprintf(stderr, error_buffer_tls, ap);
+}
+
+void
+error(const hse_err_t err, const char * const fmt, ...)
+{
+    va_list ap;
+
+    va_start(ap, fmt);
+    eprint(err, fmt, ap);
+    va_end(ap);
+}
+
+void
+fatal(const hse_err_t err, const char * const fmt, ...)
+{
+    va_list ap;
+
+    va_start(ap, fmt);
+    eprint(err, fmt, ap);
+    va_end(ap);
+
+    exit(1);
+}
+
+void
+syntax(const char * const fmt, ...)
+{
+    va_list ap;
+    char msg[256];
+
+    va_start(ap, fmt);
+    vsnprintf(msg, sizeof(msg), fmt, ap);
+    va_end(ap);
+
+    error(0, "%s, use -h for help", msg);
+    exit(EX_USAGE);
+}

cli/meson.build

@@ -24,6 +24,8 @@ hse_cli = static_library(
     ],
     dependencies: [
         cjson_dep,
+        # TODO: Remove when the cli can depend on libhse-util
+        hse_internal_dep,
         hse_error_dep,
         libcurl_dep,
         rbtree_dep,

tools/attack/attack.c

@@ -29,37 +29,10 @@
 
 #include <hse/hse.h>
 
+#include <hse/cli/output.h>
 #include <hse/cli/program.h>
 #include <hse/util/compiler.h>
 
-void HSE_PRINTF(2, 3)
-fatal(hse_err_t err, char *fmt, ...)
-{
-    va_list ap;
-
-    va_start(ap, fmt);
-    vfprintf(stderr, fmt, ap);
-    if (err)
-        fprintf(stderr, ": %ld\n", (long)err);
-    else
-        fprintf(stderr, "\n");
-    va_end(ap);
-    exit(1);
-}
-
-void HSE_PRINTF(1, 2)
-syntax(const char *fmt, ...)
-{
-    char msg[256];
-    va_list ap;
-
-    va_start(ap, fmt);
-    vsnprintf(msg, sizeof(msg), fmt, ap);
-    va_end(ap);
-
-    fprintf(stderr, "%s: %s, use -h for help\n", progname, msg);
-}
-
 void
 usage(void)
 {

tools/bnt/bnt.c

@@ -36,6 +36,7 @@
 #include <hse/hse.h>
 #include <hse/version.h>
 
+#include <hse/cli/output.h>
 #include <hse/cli/program.h>
 #include <hse/util/bonsai_tree.h>
 #include <hse/util/compiler.h>
@@ -350,18 +351,6 @@ humanize(u_long *nump, char **sufp)
     }
 }
 
-__attribute__((format(printf, 1, 2))) void
-syntax(const char *fmt, ...)
-{
-    va_list ap;
-
-    va_start(ap, fmt);
-    vsnprintf(emsg, sizeof(emsg), fmt, ap);
-    va_end(ap);
-
-    fprintf(stderr, "%s: %s, use -h for help\n", progname, emsg);
-}
-
 uint64_t
 strtou64(const void *str, char **endp, u_int base)
 {

tools/boundcur/boundcur.c

@@ -19,6 +19,7 @@
 #include <hse/flags.h>
 #include <hse/hse.h>
 
+#include <hse/cli/output.h>
 #include <hse/cli/param.h>
 #include <hse/cli/program.h>
 #include <hse/util/arch.h>
@@ -134,19 +135,6 @@ do_work(void *arg)
     rc = hse_kvs_cursor_destroy(c);
 }
 
-void HSE_PRINTF(1, 2)
-syntax(const char *fmt, ...)
-{
-    char msg[256];
-    va_list ap;
-
-    va_start(ap, fmt);
-    vsnprintf(msg, sizeof(msg), fmt, ap);
-    va_end(ap);
-
-    fprintf(stderr, "%s: %s, use -h for help\n", progname, msg);
-}
-
 void
 usage(void)
 {
@@ -237,10 +225,10 @@ main(int argc, char **argv)
     switch (rc) {
     case 0:
         if (optind < argc)
-            fatal(0, "unknown parameter: %s", argv[optind]);
+            fatalx("unknown parameter: %s", argv[optind]);
         break;
     case EINVAL:
-        fatal(0, "missing group name (e.g. %s) before parameter %s\n", PG_KVDB_OPEN, argv[optind]);
+        fatalx("missing group name (e.g. %s) before parameter %s\n", PG_KVDB_OPEN, argv[optind]);
         break;
     default:
         fatal(rc, "error processing parameter %s\n", argv[optind]);

tools/capput/capput.c

@@ -46,6 +46,7 @@
 
 #include <hse/hse.h>
 
+#include <hse/cli/output.h>
 #include <hse/cli/param.h>
 #include <hse/cli/program.h>
 #include <hse/util/arch.h>
@@ -533,19 +534,6 @@ reader(void *arg)
     hse_kvdb_txn_free(targ->kvdb, txn);
 }
 
-void
-syntax(const char *fmt, ...)
-{
-    char msg[256];
-    va_list ap;
-
-    va_start(ap, fmt);
-    vsnprintf(msg, sizeof(msg), fmt, ap);
-    va_end(ap);
-
-    fprintf(stderr, "%s: %s, use -h for help\n", progname, msg);
-}
-
 void
 usage(void)
 {
@@ -681,10 +669,10 @@ main(int argc, char **argv)
     switch (rc) {
     case 0:
         if (optind < argc)
-            fatal(0, "unknown parameter: %s", argv[optind]);
+            fatalx("unknown parameter: %s", argv[optind]);
         break;
     case EINVAL:
-        fatal(0, "missing group name (e.g. %s) before parameter %s\n", PG_KVDB_OPEN, argv[optind]);
+        fatalx("missing group name (e.g. %s) before parameter %s\n", PG_KVDB_OPEN, argv[optind]);
         break;
     default:
         fatal(rc, "error processing parameter %s\n", argv[optind]);

tools/cn_metrics/cn_metrics.c

@@ -9,6 +9,7 @@
 
 #include <hse/hse.h>
 
+#include <hse/cli/output.h>
 #include <hse/cli/program.h>
 #include <hse/ikvdb/cn.h>
 #include <hse/ikvdb/csched.h>
@@ -48,19 +49,6 @@ usage(void)
         progname);
 }
 
-void
-syntax(const char *fmt, ...)
-{
-    char msg[256];
-    va_list ap;
-
-    va_start(ap, fmt);
-    vsnprintf(msg, sizeof(msg), fmt, ap);
-    va_end(ap);
-
-    fprintf(stderr, "%s: %s, use -h for help\n", progname, msg);
-}
-
 /* Big enough for s64 min/max, u64 max, etc */
 #define BIGNUM_WIDTH_MAX 21 /* max width for signed 64-bit */
 
@@ -551,10 +539,10 @@ main(int argc, char **argv)
     switch (rc) {
     case 0:
         if (optind < argc)
-            fatal(0, "unknown parameter: %s", argv[optind]);
+            fatalx("unknown parameter: %s", argv[optind]);
         break;
     case EINVAL:
-        fatal(0, "missing group name (e.g. %s) before parameter %s\n", PG_KVDB_OPEN, argv[optind]);
+        fatalx("missing group name (e.g. %s) before parameter %s\n", PG_KVDB_OPEN, argv[optind]);
         break;
     default:
         fatal(rc, "error processing parameter %s\n", argv[optind]);

tools/cndump/cndb_dump.c

@@ -11,13 +11,13 @@
 
 #include <hse/hse.h>
 
+#include <hse/cli/output.h>
 #include <hse/cli/program.h>
 #include <hse/ikvdb/diag_kvdb.h>
 
 #include "cndb_reader.h"
 #include "cndb_record.h"
 #include "commands.h"
-#include "fatal.h"
 #include "globals.h"
 
 /* command line options for cndb sub-command */
@@ -103,11 +103,11 @@ cndb_cmd(int argc, char **argv)
 
     err = hse_init(0, NELEM(paramv), paramv);
     if (err)
-        fatal("hse_init", err);
+        fatal(err, "hse_init");
 
     err = diag_kvdb_open(opts.home, 0, 0, &kvdb);
     if (err)
-        fatal("diag_kvdb_open", err);
+        fatal(err, "diag_kvdb_open");
 
     cndb_iter_init(kvdb, &reader);
     cndb_rec_init(&rec);
@@ -117,7 +117,7 @@ cndb_cmd(int argc, char **argv)
 
     err = diag_kvdb_close(kvdb);
     if (err)
-        fatal("diag_kvdb_close", err);
+        fatal(err, "diag_kvdb_close");
 
     hse_fini();
 }

tools/cndump/cndb_reader.c

@@ -3,12 +3,12 @@
  * SPDX-FileCopyrightText: Copyright 2022 Micron Technology, Inc.
  */
 
+#include <hse/cli/output.h>
 #include <hse/ikvdb/diag_kvdb.h>
 #include <hse/mpool/mpool.h>
 
 #include "cndb_reader.h"
 #include "cndb_record.h"
-#include "fatal.h"
 
 static void
 read_record(struct cndb_dump_reader *reader, struct cndb_rec *rec)
@@ -23,7 +23,7 @@ read_record(struct cndb_dump_reader *reader, struct cndb_rec *rec)
     }
 
     if (err)
-        fatal("mpool_mdc_read", err);
+        fatal(err, "mpool_mdc_read");
 
     if (reclen) {
         rec->type = omf_cnhdr_type(rec->buf);
@@ -42,14 +42,14 @@ cndb_iter_init(struct hse_kvdb *kvdb, struct cndb_dump_reader *r)
 
     err = diag_kvdb_get_cndb(kvdb, &cndb);
     if (err)
-        fatal("diag_kvdb_get_cndb", err);
+        fatal(err, "diag_kvdb_get_cndb");
 
     r->mdc = cndb_mdc_get(cndb);
     r->eof = false;
 
     err = mpool_mdc_rewind(r->mdc);
     if (err)
-        fatal("mpool_mdc_rewind", err);
+        fatal(err, "mpool_mdc_rewind");
 }
 
 bool