log: Use generalized sr_log() to implement logging helpers

[libsigrok.git] / src / log.c

diff --git a/src/log.c b/src/log.c
index db16c30dabb00597d438307196a19a310b01104f..750ada058e230f761d3165da53930c5201666bff 100644 (file)
--- a/src/log.c
+++ b/src/log.c
@@ -20,12 +20,11 @@
 
 #include <stdarg.h>
 #include <stdio.h>
-#include "libsigrok.h"
-/** @cond PRIVATE */
-#define NO_LOG_WRAPPERS
-/** @endcond */
+#include <libsigrok/libsigrok.h>
 #include "libsigrok-internal.h"
 
+#define LOG_PREFIX "log"
+
 /**
  * @file
  *
@@ -63,6 +62,8 @@ static void *sr_log_cb_data = NULL;
 /** @endcond */
 static char sr_log_domain[LOGDOMAIN_MAXLEN + 1] = LOGDOMAIN_DEFAULT;
 
+static int64_t sr_log_start_time = 0;
+
 /**
  * Set the libsigrok loglevel.
  *
@@ -86,6 +87,9 @@ SR_API int sr_log_loglevel_set(int loglevel)
                sr_err("Invalid loglevel %d.", loglevel);
                return SR_ERR_ARG;
        }
+       /* Output time stamps relative to time at startup */
+       if (loglevel >= SR_LOG_SPEW && sr_log_start_time == 0)
+               sr_log_start_time = g_get_monotonic_time();
 
        cur_loglevel = loglevel;
 
@@ -113,28 +117,31 @@ SR_API int sr_log_loglevel_get(void)
  *                  messages from now on. Must not be NULL. The maximum
  *                  length of the string is 30 characters (this does not
  *                  include the trailing NUL-byte). Longer strings are
- *                  silently truncated.
+ *                  truncated.
  *                  In order to not use a logdomain, pass an empty string.
  *                  The function makes its own copy of the input string, i.e.
  *                  the caller does not need to keep it around.
  *
- * @return SR_OK upon success, SR_ERR_ARG upon invalid logdomain.
+ * @retval SR_OK upon success.
+ * @retval SR_ERR_ARG @a logdomain was NULL.
+ * @retval SR_ERR @a logdomain was truncated.
  *
  * @since 0.1.0
  */
 SR_API int sr_log_logdomain_set(const char *logdomain)
 {
+       size_t len;
+
        if (!logdomain) {
-               sr_err("log: %s: logdomain was NULL", __func__);
+               sr_err("%s: logdomain was NULL", __func__);
                return SR_ERR_ARG;
        }
 
-       /* TODO: Error handling. */
-       snprintf((char *)&sr_log_domain, LOGDOMAIN_MAXLEN, "%s", logdomain);
+       len = g_strlcpy(sr_log_domain, logdomain, sizeof sr_log_domain);
 
-       sr_dbg("Log domain set to '%s'.", (const char *)&sr_log_domain);
+       sr_dbg("Log domain set to '%s'.", sr_log_domain);
 
-       return SR_OK;
+       return (len < sizeof sr_log_domain) ? SR_OK : SR_ERR;
 }
 
 /**
@@ -148,7 +155,7 @@ SR_API int sr_log_logdomain_set(const char *logdomain)
  */
 SR_API char *sr_log_logdomain_get(void)
 {
-       return g_strdup((const char *)&sr_log_domain);
+       return g_strdup(sr_log_domain);
 }
 
 /**
@@ -169,7 +176,7 @@ SR_API char *sr_log_logdomain_get(void)
 SR_API int sr_log_callback_set(sr_log_callback cb, void *cb_data)
 {
        if (!cb) {
-               sr_err("log: %s: cb was NULL", __func__);
+               sr_err("%s: cb was NULL", __func__);
                return SR_ERR_ARG;
        }
 
@@ -204,21 +211,35 @@ SR_API int sr_log_callback_set_default(void)
 
 static int sr_logv(void *cb_data, int loglevel, const char *format, va_list args)
 {
-       int ret;
+       int64_t elapsed;
+       int64_t min;
+       int sec;
+       int usec;
 
        /* This specific log callback doesn't need the void pointer data. */
        (void)cb_data;
 
        /* Only output messages of at least the selected loglevel(s). */
        if (loglevel > cur_loglevel)
-               return SR_OK; /* TODO? */
+               return SR_OK;
 
-       if (sr_log_domain[0] != '\0')
-               fprintf(stderr, "%s", sr_log_domain);
-       ret = vfprintf(stderr, format, args);
-       fprintf(stderr, "\n");
+       if (cur_loglevel >= SR_LOG_SPEW) {
+               elapsed = g_get_monotonic_time() - sr_log_start_time;
+               min = elapsed / G_TIME_SPAN_MINUTE;
+               sec = (elapsed % G_TIME_SPAN_MINUTE) / G_TIME_SPAN_SECOND;
+               usec = elapsed % G_TIME_SPAN_SECOND;
 
-       return ret;
+               if (fprintf(stderr, "[%.2" PRIi64 ":%.2d.%.6d] ", min, sec, usec) < 0)
+                       return SR_ERR;
+       }
+       if (sr_log_domain[0] != '\0' && fputs(sr_log_domain, stderr) < 0)
+               return SR_ERR;
+       if (vfprintf(stderr, format, args) < 0)
+               return SR_ERR;
+       if (putc('\n', stderr) < 0)
+               return SR_ERR;
+
+       return SR_OK;
 }
 
 /** @private */
@@ -234,69 +255,4 @@ SR_PRIV int sr_log(int loglevel, const char *format, ...)
        return ret;
 }
 
-/** @private */
-SR_PRIV int sr_spew(const char *format, ...)
-{
-       int ret;
-       va_list args;
-
-       va_start(args, format);
-       ret = sr_log_cb(sr_log_cb_data, SR_LOG_SPEW, format, args);
-       va_end(args);
-
-       return ret;
-}
-
-/** @private */
-SR_PRIV int sr_dbg(const char *format, ...)
-{
-       int ret;
-       va_list args;
-
-       va_start(args, format);
-       ret = sr_log_cb(sr_log_cb_data, SR_LOG_DBG, format, args);
-       va_end(args);
-
-       return ret;
-}
-
-/** @private */
-SR_PRIV int sr_info(const char *format, ...)
-{
-       int ret;
-       va_list args;
-
-       va_start(args, format);
-       ret = sr_log_cb(sr_log_cb_data, SR_LOG_INFO, format, args);
-       va_end(args);
-
-       return ret;
-}
-
-/** @private */
-SR_PRIV int sr_warn(const char *format, ...)
-{
-       int ret;
-       va_list args;
-
-       va_start(args, format);
-       ret = sr_log_cb(sr_log_cb_data, SR_LOG_WARN, format, args);
-       va_end(args);
-
-       return ret;
-}
-
-/** @private */
-SR_PRIV int sr_err(const char *format, ...)
-{
-       int ret;
-       va_list args;
-
-       va_start(args, format);
-       ret = sr_log_cb(sr_log_cb_data, SR_LOG_ERR, format, args);
-       va_end(args);
-
-       return ret;
-}
-
 /** @} */