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

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

namespace LightGBM {


Qiwei Ye's avatar
Qiwei Ye committed
15
16
17
18
#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
19
#endif
Qiwei Ye's avatar
Qiwei Ye committed
20
21
22

#ifndef CHECK_NOTNULL
#define CHECK_NOTNULL(pointer)                             \
Guolin Ke's avatar
Guolin Ke committed
23
  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
24
#endif
Qiwei Ye's avatar
Qiwei Ye committed
25

Guolin Ke's avatar
Guolin Ke committed
26

Guolin Ke's avatar
Guolin Ke committed
27
28
enum class LogLevel: int {
  Fatal = -1,
Qiwei Ye's avatar
Qiwei Ye committed
29
  Warning = 0,
Qiwei Ye's avatar
Qiwei Ye committed
30
  Info = 1,
Guolin Ke's avatar
Guolin Ke committed
31
  Debug = 2,
Guolin Ke's avatar
Guolin Ke committed
32
33
};

Qiwei Ye's avatar
Qiwei Ye committed
34
35

/*!
36
* \brief A static Log class
Qiwei Ye's avatar
Qiwei Ye committed
37
38
39
40
41
42
43
*/
class Log {
public:
  /*!
  * \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
44
45
46
47
  static void ResetLogLevel(LogLevel level) {
    GetLevel() = level;
  }

48
49
50
51
  static void ResetUseException(bool use_ex) {
    UseException() = use_ex;
  }

Guolin Ke's avatar
Guolin Ke committed
52
53
54
55
56
57
58
59
60
61
62
63
  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
64
  static void Warning(const char *format, ...) {
Guolin Ke's avatar
Guolin Ke committed
65
66
    va_list val;
    va_start(val, format);
Qiwei Ye's avatar
Qiwei Ye committed
67
    Write(LogLevel::Warning, "Warning", format, val);
Guolin Ke's avatar
Guolin Ke committed
68
69
70
71
    va_end(val);
  }
  static void Fatal(const char *format, ...) {
    va_list val;
72
    char str_buf[1024];
Guolin Ke's avatar
Guolin Ke committed
73
    va_start(val, format);
74
75
76
77
78
#ifdef _MSC_VER
    vsprintf_s(str_buf, format, val);
#else
    vsprintf(str_buf, format, val);
#endif
Guolin Ke's avatar
Guolin Ke committed
79
    va_end(val);
80
81
82
83
84
85
    if (UseException()) {
      throw std::runtime_error(std::string(str_buf));
    } else {
      fprintf(stderr, str_buf);
      exit(-1);
    }
Guolin Ke's avatar
Guolin Ke committed
86
  }
Qiwei Ye's avatar
Qiwei Ye committed
87
88

private:
Guolin Ke's avatar
Guolin Ke committed
89
90
91
92
93
94

  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);
95
      printf("\n");
Guolin Ke's avatar
Guolin Ke committed
96
97
98
99
      fflush(stdout);
    }
  }

100
  // a trick to use static variable in header file.
Guolin Ke's avatar
Guolin Ke committed
101
  // May be not good, but avoid to use an additional cpp file
Guolin Ke's avatar
Guolin Ke committed
102
103
104
#if defined(_MSC_VER)
  static LogLevel& GetLevel() { static __declspec(thread) LogLevel level = LogLevel::Info; return level; }
#else
Guolin Ke's avatar
Guolin Ke committed
105
  static LogLevel& GetLevel() { static thread_local LogLevel level = LogLevel::Info; return level; }
Guolin Ke's avatar
Guolin Ke committed
106
#endif
107

108
109
  static bool& UseException() { static bool use_ex = false; return use_ex; }

Qiwei Ye's avatar
Qiwei Ye committed
110
};
Guolin Ke's avatar
Guolin Ke committed
111
112

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