1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
|
//===--- Logging.h - Logging Interface --------------------------*- C++ -*-===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2014 - 2018 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See https://swift.org/LICENSE.txt for license information
// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
//===----------------------------------------------------------------------===//
#ifndef LLVM_INDEXSTOREDB_SUPPORT_LOGGING_H
#define LLVM_INDEXSTOREDB_SUPPORT_LOGGING_H
#include "IndexStoreDB/Support/LLVM.h"
#include "IndexStoreDB/Support/Visibility.h"
#include "llvm/ADT/IntrusiveRefCntPtr.h"
#include "llvm/ADT/SmallString.h"
#include "llvm/ADT/StringRef.h"
#include "llvm/Support/raw_ostream.h"
#include "llvm/Support/Timer.h"
#include <string>
namespace llvm {
class format_object_base;
}
namespace IndexStoreDB {
class Logger;
INDEXSTOREDB_EXPORT void writeEscaped(StringRef Str, raw_ostream &OS);
typedef IntrusiveRefCntPtr<Logger> LogRef;
/// \brief Collects logging output and writes it to stderr when it's destructed.
/// Common use case:
/// \code
/// if (LogRef Log = Logger::make(__func__, Logger::Level::Warning)) {
/// *Log << "stuff";
/// }
/// \endcode
class INDEXSTOREDB_EXPORT Logger : public llvm::ThreadSafeRefCountedBase<Logger> {
public:
enum class Level : unsigned char {
/// \brief No logging.
None = 0,
/// \brief Warning level.
Warning = 1,
/// \brief Information level for high priority messages.
InfoHighPrio = 2,
/// \brief Information level for medium priority messages.
InfoMediumPrio = 3,
/// \brief Information level for low priority messages.
InfoLowPrio = 4
};
private:
std::string Name;
Level CurrLevel;
SmallString<64> Msg;
llvm::raw_svector_ostream LogOS;
uint64_t thread_id;
llvm::TimeRecord TimeR;
static std::string LoggerName;
static std::atomic<Level> LoggingLevel;
public:
static void enableLoggingByEnvVar(const char *EnvVarName,
StringRef LoggerName);
static bool isLoggingEnabledForLevel(Level LogLevel) {
return LoggingLevel >= LogLevel;
}
static void enableLogging(StringRef Name, Level LogLevel) {
LoggerName = Name;
LoggingLevel = LogLevel;
}
static void setLogLevelByNum(unsigned LevelNum) {
LoggingLevel = getLogLevelByNum(LevelNum);
}
static Level getLogLevelByNum(unsigned LevelNum);
static unsigned getCurrentLogLevelNum();
static LogRef make(llvm::StringRef Name, Level LogLevel) {
if (isLoggingEnabledForLevel(LogLevel)) return new Logger(Name, LogLevel);
return nullptr;
}
Logger(StringRef Name, Level LogLevel);
~Logger();
llvm::raw_ostream &getOS() { return LogOS; }
Logger &operator<<(llvm::StringRef Str) { LogOS << Str; return *this; }
Logger &operator<<(const char *Str) { if (Str) LogOS << Str; return *this; }
Logger &operator<<(unsigned long N) { LogOS << N; return *this; }
Logger &operator<<(unsigned long long N) { LogOS << N; return *this; }
Logger &operator<<(long N) { LogOS << N ; return *this; }
Logger &operator<<(unsigned int N) { LogOS << N; return *this; }
Logger &operator<<(int N) { LogOS << N; return *this; }
Logger &operator<<(char C) { LogOS << C; return *this; }
Logger &operator<<(unsigned char C) { LogOS << C; return *this; }
Logger &operator<<(signed char C) { LogOS << C; return *this; }
Logger &operator<<(const llvm::format_object_base &Fmt);
};
} // namespace IndexStoreDB.
/// \brief Macros to automate common uses of Logger. Like this:
/// \code
/// LOG_FUNC_SECTION_WARN {
/// *Log << "blah";
/// }
/// \endcode
#define LOG_SECTION(NAME, LEVEL) \
if (IndexStoreDB::LogRef Log = IndexStoreDB::Logger::make(NAME, IndexStoreDB::Logger::Level::LEVEL))
#define LOG_FUNC_SECTION(LEVEL) LOG_SECTION(__func__, LEVEL)
#define LOG_FUNC_SECTION_WARN LOG_FUNC_SECTION(Warning)
#define LOG(NAME, LEVEL, msg) LOG_SECTION(NAME, LEVEL) \
do { *Log << msg; } while(0)
#define LOG_FUNC(LEVEL, msg) LOG_FUNC_SECTION(LEVEL) \
do { *Log << msg; } while(0)
#define LOG_WARN(NAME, msg) LOG(NAME, Warning, msg)
#define LOG_WARN_FUNC(msg) LOG_FUNC(Warning, msg)
#define LOG_INFO_FUNC(PRIO, msg) LOG_FUNC(Info##PRIO##Prio, msg)
#define LOG_INFO(NAME, PRIO, msg) LOG(NAME, Info##PRIO##Prio, msg)
#endif
|
