Merge branch 'feature-log-enhancement' into dev

src/common/log/ConsoleLog.cpp

@@ -66,7 +66,7 @@ ConsoleLog::ConsoleLog(xmrig::Controller *controller) :
 }
 
 
-void ConsoleLog::message(int level, const char* fmt, va_list args)
+void ConsoleLog::message(Level level, const char* fmt, va_list args)
 {
     time_t now = time(nullptr);
     tm stime;
@@ -77,43 +77,18 @@ void ConsoleLog::message(int level, const char* fmt, va_list args)
     localtime_r(&now, &stime);
 #   endif
 
-    const char* color = nullptr;
+    const bool isColors = m_controller->config()->isColors();
-    const bool colors = m_controller->config()->isColors();
 
-    if (colors) {
+    snprintf(m_fmt, sizeof(m_fmt) - 1, "[%d-%02d-%02d %02d:%02d:%02d]%s %s%s",
-        switch (level) {
-        case Log::ERR:
-            color = Log::kCL_RED;
-            break;
-
-        case Log::WARNING:
-            color = Log::kCL_YELLOW;
-            break;
-
-        case Log::NOTICE:
-            color = Log::kCL_WHITE;
-            break;
-
-        case Log::DEBUG:
-            color = Log::kCL_GRAY;
-            break;
-
-        default:
-            color = "";
-            break;
-        }
-    }
-
-    snprintf(m_fmt, sizeof(m_fmt) - 1, "[%d-%02d-%02d %02d:%02d:%02d]%s %s%s\n",
              stime.tm_year + 1900,
              stime.tm_mon + 1,
              stime.tm_mday,
              stime.tm_hour,
              stime.tm_min,
              stime.tm_sec,
-             colors ? color : "",
+             Log::colorByLevel(level, isColors),
              fmt,
-             colors ? Log::kCL_N : ""
+             Log::endl(isColors)
         );
 
     print(args);
@@ -122,7 +97,7 @@ void ConsoleLog::message(int level, const char* fmt, va_list args)
 
 void ConsoleLog::text(const char* fmt, va_list args)
 {
-    snprintf(m_fmt, sizeof(m_fmt) - 1, "%s%s\n", fmt, m_controller->config()->isColors() ? Log::kCL_N : "");
+    snprintf(m_fmt, sizeof(m_fmt) - 1, "%s%s", fmt, Log::endl(m_controller->config()->isColors()));
 
     print(args);
 }

src/common/log/ConsoleLog.h

@@ -41,14 +41,14 @@ class ConsoleLog : public ILogBackend
 public:
     ConsoleLog(xmrig::Controller *controller);
 
-    void message(int level, const char *fmt, va_list args) override;
+    void message(Level level, const char *fmt, va_list args) override;
     void text(const char *fmt, va_list args) override;
 
 private:
     bool isWritable() const;
     void print(va_list args);
 
-    char m_buf[512];
+    char m_buf[kBufferSize];
     char m_fmt[256];
     uv_buf_t m_uvBuf;
     uv_stream_t *m_stream;

src/common/log/FileLog.cpp

@@ -4,8 +4,8 @@
  * Copyright 2014      Lucas Jones <https://github.com/lucasjones>
  * Copyright 2014-2016 Wolf9466    <https://github.com/OhGodAPet>
  * Copyright 2016      Jay D Dee   <jayddee246@gmail.com>
- * Copyright 2016-2017 XMRig       <support@xmrig.com>
+ * Copyright 2017-2018 XMR-Stak    <https://github.com/fireice-uk>, <https://github.com/psychocrypt>
- *
+ * Copyright 2016-2018 XMRig       <https://github.com/xmrig>, <support@xmrig.com>
  *
  *   This program is free software: you can redistribute it and/or modify
  *   it under the terms of the GNU General Public License as published by
@@ -30,9 +30,13 @@
 
 
 #include "common/log/FileLog.h"
+#include "common/log/Log.h"
+#include "core/Config.h"
+#include "core/Controller.h"
 
 
-FileLog::FileLog(const char *fileName)
+FileLog::FileLog(xmrig::Controller *controller, const char *fileName) :
+    m_controller(controller)
 {
     uv_fs_t req;
     m_file = uv_fs_open(uv_default_loop(), &req, fileName, O_CREAT | O_APPEND | O_WRONLY, 0644, nullptr);
@@ -40,7 +44,7 @@ FileLog::FileLog(const char *fileName)
 }
 
 
-void FileLog::message(int level, const char* fmt, va_list args)
+void FileLog::message(Level level, const char* fmt, va_list args)
 {
     if (m_file < 0) {
         return;
@@ -55,29 +59,33 @@ void FileLog::message(int level, const char* fmt, va_list args)
     localtime_r(&now, &stime);
 #   endif
 
-    char *buf = new char[512];
+    const bool isColors = m_controller->config()->isColors();
-    int size = snprintf(buf, 23, "[%d-%02d-%02d %02d:%02d:%02d] ",
+
+    snprintf(m_fmt, sizeof(m_fmt) - 1, "[%d-%02d-%02d %02d:%02d:%02d]%s %s%s",
              stime.tm_year + 1900,
              stime.tm_mon + 1,
              stime.tm_mday,
              stime.tm_hour,
              stime.tm_min,
-                        stime.tm_sec);
+             stime.tm_sec,
+             Log::colorByLevel(level, isColors),
+             fmt,
+             Log::endl(isColors)
+        );
 
-    size = vsnprintf(buf + size, 512 - size - 1, fmt, args) + size;
+    char *buf = new char[kBufferSize];
-    buf[size] = '\n';
+    const int size = vsnprintf(buf, kBufferSize - 1, m_fmt, args);
 
-    write(buf, size + 1);
+    write(buf, size);
 }
 
 
 void FileLog::text(const char* fmt, va_list args)
 {
-    message(0, fmt, args);
+    message(INFO, fmt, args);
 }
 
 
-
 void FileLog::onWrite(uv_fs_t *req)
 {
     delete [] static_cast<char *>(req->data);

src/common/log/FileLog.h

@@ -4,8 +4,8 @@
  * Copyright 2014      Lucas Jones <https://github.com/lucasjones>
  * Copyright 2014-2016 Wolf9466    <https://github.com/OhGodAPet>
  * Copyright 2016      Jay D Dee   <jayddee246@gmail.com>
- * Copyright 2016-2017 XMRig       <support@xmrig.com>
+ * Copyright 2017-2018 XMR-Stak    <https://github.com/fireice-uk>, <https://github.com/psychocrypt>
- *
+ * Copyright 2016-2018 XMRig       <https://github.com/xmrig>, <support@xmrig.com>
  *
  *   This program is free software: you can redistribute it and/or modify
  *   it under the terms of the GNU General Public License as published by
@@ -31,12 +31,17 @@
 #include "interfaces/ILogBackend.h"
 
 
+namespace xmrig {
+    class Controller;
+}
+
+
 class FileLog : public ILogBackend
 {
 public:
-    FileLog(const char *fileName);
+    FileLog(xmrig::Controller *controller, const char *fileName);
 
-    void message(int level, const char* fmt, va_list args) override;
+    void message(Level level, const char* fmt, va_list args) override;
     void text(const char* fmt, va_list args) override;
 
 private:
@@ -44,7 +49,9 @@ private:
 
     void write(char *data, size_t size);
 
+    char m_fmt[256];
     int m_file;
+    xmrig::Controller *m_controller;
 };
 
 #endif /* __FILELOG_H__ */

src/common/log/Log.cpp

@@ -36,7 +36,20 @@
 Log *Log::m_self = nullptr;
 
 
-void Log::message(Log::Level level, const char* fmt, ...)
+static const char *colors[5] = {
+    "\x1B[0;31m",  /* ERR     */
+    "\x1B[0;33m",  /* WARNING */
+    "\x1B[1;37m",  /* NOTICE  */
+    "",            /* INFO    */
+#   ifdef WIN32
+    "\x1B[1;30m"   /* DEBUG   */
+#   else
+    "\x1B[90m"     /* DEBUG   */
+#   endif
+};
+
+
+void Log::message(ILogBackend::Level level, const char* fmt, ...)
 {
     uv_mutex_lock(&m_mutex);
 
@@ -76,6 +89,26 @@ void Log::text(const char* fmt, ...)
 }
 
 
+const char *Log::colorByLevel(ILogBackend::Level level, bool isColors)
+{
+    if (!isColors) {
+        return "";
+    }
+
+    return colors[level];
+}
+
+
+const char *Log::endl(bool isColors)
+{
+#   ifdef _WIN32
+    return isColors ? "\x1B[0m\r\n" : "\r\n";
+#   else
+    return isColors ? "\x1B[0m\n" : "\n";
+#   endif
+}
+
+
 Log::~Log()
 {
     for (auto backend : m_backends) {

src/common/log/Log.h

@@ -30,39 +30,23 @@
 #include <vector>
 
 
-class ILogBackend;
+#include "interfaces/ILogBackend.h"
 
 
 class Log
 {
 public:
-    enum Level {
-        ERR,
-        WARNING,
-        NOTICE,
-        INFO,
-        DEBUG
-    };
-
-    constexpr static const char* kCL_N      = "\x1B[0m";
-    constexpr static const char* kCL_RED    = "\x1B[31m";
-    constexpr static const char* kCL_YELLOW = "\x1B[33m";
-    constexpr static const char* kCL_WHITE  = "\x1B[01;37m";
-
-#   ifdef WIN32
-    constexpr static const char* kCL_GRAY = "\x1B[01;30m";
-#   else
-    constexpr static const char* kCL_GRAY = "\x1B[90m";
-#   endif
-
     static inline Log* i()                       { assert(m_self != nullptr); return m_self; }
     static inline void add(ILogBackend *backend) { i()->m_backends.push_back(backend); }
     static inline void init()                    { if (!m_self) { new Log(); } }
     static inline void release()                 { assert(m_self != nullptr); delete m_self; }
 
-    void message(Level level, const char* fmt, ...);
+    void message(ILogBackend::Level level, const char* fmt, ...);
     void text(const char* fmt, ...);
 
+    static const char *colorByLevel(ILogBackend::Level level, bool isColors = true);
+    static const char *endl(bool isColors = true);
+
 private:
     inline Log() {
         assert(m_self == nullptr);
@@ -92,20 +76,20 @@ private:
 #define WHITE(x)        "\x1B[0;37m" x "\x1B[0m"
 
 
-#define LOG_ERR(x, ...)    Log::i()->message(Log::ERR,     x, ##__VA_ARGS__)
+#define LOG_ERR(x, ...)    Log::i()->message(ILogBackend::ERR,     x, ##__VA_ARGS__)
-#define LOG_WARN(x, ...)   Log::i()->message(Log::WARNING, x, ##__VA_ARGS__)
+#define LOG_WARN(x, ...)   Log::i()->message(ILogBackend::WARNING, x, ##__VA_ARGS__)
-#define LOG_NOTICE(x, ...) Log::i()->message(Log::NOTICE,  x, ##__VA_ARGS__)
+#define LOG_NOTICE(x, ...) Log::i()->message(ILogBackend::NOTICE,  x, ##__VA_ARGS__)
-#define LOG_INFO(x, ...)   Log::i()->message(Log::INFO,    x, ##__VA_ARGS__)
+#define LOG_INFO(x, ...)   Log::i()->message(ILogBackend::INFO,    x, ##__VA_ARGS__)
 
 #ifdef APP_DEBUG
-#   define LOG_DEBUG(x, ...)      Log::i()->message(Log::DEBUG,   x, ##__VA_ARGS__)
+#   define LOG_DEBUG(x, ...)      Log::i()->message(ILogBackend::DEBUG,   x, ##__VA_ARGS__)
 #else
 #   define LOG_DEBUG(x, ...)
 #endif
 
 #if defined(APP_DEBUG) || defined(APP_DEVEL)
-#   define LOG_DEBUG_ERR(x, ...)  Log::i()->message(Log::ERR,     x, ##__VA_ARGS__)
+#   define LOG_DEBUG_ERR(x, ...)  Log::i()->message(ILogBackend::ERR,     x, ##__VA_ARGS__)
-#   define LOG_DEBUG_WARN(x, ...) Log::i()->message(Log::WARNING, x, ##__VA_ARGS__)
+#   define LOG_DEBUG_WARN(x, ...) Log::i()->message(ILogBackend::WARNING, x, ##__VA_ARGS__)
 #else
 #   define LOG_DEBUG_ERR(x, ...)
 #   define LOG_DEBUG_WARN(x, ...)

src/common/log/SysLog.cpp

@@ -4,8 +4,8 @@
  * Copyright 2014      Lucas Jones <https://github.com/lucasjones>
  * Copyright 2014-2016 Wolf9466    <https://github.com/OhGodAPet>
  * Copyright 2016      Jay D Dee   <jayddee246@gmail.com>
- * Copyright 2016-2017 XMRig       <support@xmrig.com>
+ * Copyright 2017-2018 XMR-Stak    <https://github.com/fireice-uk>, <https://github.com/psychocrypt>
- *
+ * Copyright 2016-2018 XMRig       <https://github.com/xmrig>, <support@xmrig.com>
  *
  *   This program is free software: you can redistribute it and/or modify
  *   it under the terms of the GNU General Public License as published by
@@ -35,13 +35,13 @@ SysLog::SysLog()
 }
 
 
-void SysLog::message(int level, const char *fmt, va_list args)
+void SysLog::message(Level level, const char *fmt, va_list args)
 {
-    vsyslog(level, fmt, args);
+    vsyslog(static_cast<int>(level), fmt, args);
 }
 
 
 void SysLog::text(const char *fmt, va_list args)
 {
-    message(LOG_INFO, fmt, args);
+    vsyslog(LOG_INFO, fmt, args);
 }

src/common/log/SysLog.h

@@ -4,8 +4,8 @@
  * Copyright 2014      Lucas Jones <https://github.com/lucasjones>
  * Copyright 2014-2016 Wolf9466    <https://github.com/OhGodAPet>
  * Copyright 2016      Jay D Dee   <jayddee246@gmail.com>
- * Copyright 2016-2017 XMRig       <support@xmrig.com>
+ * Copyright 2017-2018 XMR-Stak    <https://github.com/fireice-uk>, <https://github.com/psychocrypt>
- *
+ * Copyright 2016-2018 XMRig       <https://github.com/xmrig>, <support@xmrig.com>
  *
  *   This program is free software: you can redistribute it and/or modify
  *   it under the terms of the GNU General Public License as published by
@@ -33,7 +33,7 @@ class SysLog : public ILogBackend
 public:
     SysLog();
 
-    void message(int level, const char *fmt, va_list args) override;
+    void message(Level level, const char *fmt, va_list args) override;
     void text(const char *fmt, va_list args) override;
 };
 

src/core/Controller.cpp

@@ -110,7 +110,7 @@ int xmrig::Controller::init(int argc, char **argv)
     }
 
     if (config()->logFile()) {
-        Log::add(new FileLog(config()->logFile()));
+        Log::add(new FileLog(this, config()->logFile()));
     }
 
 #   ifdef HAVE_SYSLOG_H

src/interfaces/ILogBackend.h

@@ -4,8 +4,8 @@
  * Copyright 2014      Lucas Jones <https://github.com/lucasjones>
  * Copyright 2014-2016 Wolf9466    <https://github.com/OhGodAPet>
  * Copyright 2016      Jay D Dee   <jayddee246@gmail.com>
- * Copyright 2016-2017 XMRig       <support@xmrig.com>
+ * Copyright 2017-2018 XMR-Stak    <https://github.com/fireice-uk>, <https://github.com/psychocrypt>
- *
+ * Copyright 2016-2018 XMRig       <https://github.com/xmrig>, <support@xmrig.com>
  *
  *   This program is free software: you can redistribute it and/or modify
  *   it under the terms of the GNU General Public License as published by
@@ -26,14 +26,25 @@
 
 
 #include <stdarg.h>
+#include <stddef.h>
 
 
 class ILogBackend
 {
 public:
+    enum Level {
+        ERR,
+        WARNING,
+        NOTICE,
+        INFO,
+        DEBUG
+    };
+
+    constexpr static const size_t kBufferSize = 512;
+
     virtual ~ILogBackend() {}
 
-    virtual void message(int level, const char* fmt, va_list args) = 0;
+    virtual void message(Level level, const char* fmt, va_list args) = 0;
     virtual void text(const char* fmt, va_list args)                 = 0;
 };