log.h 2.49 KB
Newer Older
Guolin Ke's avatar
Guolin Ke committed
1
2
3
#ifndef LIGHTGBM_UTILS_LOG_H_
#define LIGHTGBM_UTILS_LOG_H_

4
5
#include <string>
#include <cstdarg>
Guolin Ke's avatar
Guolin Ke committed
6
7
8
#include <cstdio>
#include <cstdlib>
#include <cstring>
9
#include <exception>
10
#include <iostream>
11
#include <stdexcept>
Guolin Ke's avatar
Guolin Ke committed
12
13
14

namespace LightGBM {

15
#if defined(_MSC_VER)
16
#define THREAD_LOCAL __declspec(thread)
17
18
19
#else
#define THREAD_LOCAL thread_local
#endif
Guolin Ke's avatar
Guolin Ke committed
20

Qiwei Ye's avatar
Qiwei Ye committed
21
22
23
24
#ifndef CHECK
#define CHECK(condition)                                   \
  if (!(condition)) Log::Fatal("Check failed: " #condition \
     " at %s, line %d .\n", __FILE__,  __LINE__);
Guolin Ke's avatar
Guolin Ke committed
25
#endif
Qiwei Ye's avatar
Qiwei Ye committed
26
27
28

#ifndef CHECK_NOTNULL
#define CHECK_NOTNULL(pointer)                             \
Guolin Ke's avatar
Guolin Ke committed
29
  if ((pointer) == nullptr) LightGBM::Log::Fatal(#pointer " Can't be NULL at %s, line %d .\n", __FILE__,  __LINE__);
Guolin Ke's avatar
Guolin Ke committed
30
#endif
Qiwei Ye's avatar
Qiwei Ye committed
31

Guolin Ke's avatar
Guolin Ke committed
32

Guolin Ke's avatar
Guolin Ke committed
33
34
enum class LogLevel: int {
  Fatal = -1,
Qiwei Ye's avatar
Qiwei Ye committed
35
  Warning = 0,
Qiwei Ye's avatar
Qiwei Ye committed
36
  Info = 1,
Guolin Ke's avatar
Guolin Ke committed
37
  Debug = 2,
Guolin Ke's avatar
Guolin Ke committed
38
39
};

Qiwei Ye's avatar
Qiwei Ye committed
40
41

/*!
42
* \brief A static Log class
Qiwei Ye's avatar
Qiwei Ye committed
43
44
*/
class Log {
Nikita Titov's avatar
Nikita Titov committed
45
 public:
Qiwei Ye's avatar
Qiwei Ye committed
46
47
48
49
  /*!
  * \brief Resets the minimal log level. It is INFO by default.
  * \param level The new minimal log level.
  */
Guolin Ke's avatar
Guolin Ke committed
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
  static void ResetLogLevel(LogLevel level) {
    GetLevel() = level;
  }

  static void Debug(const char *format, ...) {
    va_list val;
    va_start(val, format);
    Write(LogLevel::Debug, "Debug", format, val);
    va_end(val);
  }
  static void Info(const char *format, ...) {
    va_list val;
    va_start(val, format);
    Write(LogLevel::Info, "Info", format, val);
    va_end(val);
  }
Qiwei Ye's avatar
Qiwei Ye committed
66
  static void Warning(const char *format, ...) {
Guolin Ke's avatar
Guolin Ke committed
67
68
    va_list val;
    va_start(val, format);
Qiwei Ye's avatar
Qiwei Ye committed
69
    Write(LogLevel::Warning, "Warning", format, val);
Guolin Ke's avatar
Guolin Ke committed
70
71
72
73
    va_end(val);
  }
  static void Fatal(const char *format, ...) {
    va_list val;
74
    char str_buf[1024];
Guolin Ke's avatar
Guolin Ke committed
75
    va_start(val, format);
76
77
78
79
80
#ifdef _MSC_VER
    vsprintf_s(str_buf, format, val);
#else
    vsprintf(str_buf, format, val);
#endif
Guolin Ke's avatar
Guolin Ke committed
81
    va_end(val);
Guolin Ke's avatar
Guolin Ke committed
82
83
    fprintf(stderr, "[LightGBM] [Fatal] %s\n", str_buf);
    fflush(stderr);
84
    throw std::runtime_error(std::string(str_buf));
Guolin Ke's avatar
Guolin Ke committed
85
  }
Qiwei Ye's avatar
Qiwei Ye committed
86

Nikita Titov's avatar
Nikita Titov committed
87
 private:
Guolin Ke's avatar
Guolin Ke committed
88
89
90
91
92
  static void Write(LogLevel level, const char* level_str, const char *format, va_list val) {
    if (level <= GetLevel()) {  // omit the message with low level
      // write to STDOUT
      printf("[LightGBM] [%s] ", level_str);
      vprintf(format, val);
93
      printf("\n");
Guolin Ke's avatar
Guolin Ke committed
94
95
96
97
      fflush(stdout);
    }
  }

98
  // a trick to use static variable in header file.
Guolin Ke's avatar
Guolin Ke committed
99
  // May be not good, but avoid to use an additional cpp file
100
  static LogLevel& GetLevel() { static THREAD_LOCAL LogLevel level = LogLevel::Info; return level; }
Qiwei Ye's avatar
Qiwei Ye committed
101
};
Guolin Ke's avatar
Guolin Ke committed
102
103

}  // namespace LightGBM
Guolin Ke's avatar
Guolin Ke committed
104
#endif   // LightGBM_UTILS_LOG_H_