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
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
|
#pragma once
///@file
#include "lix/libutil/types.hh"
#include "lix/libutil/error.hh"
#include "lix/libutil/config.hh"
#include "lix/libutil/log-format.hh" // IWYU pragma: keep
#include "result.hh"
#include "serialise.hh"
#include <kj/async.h>
#include <optional>
namespace nix {
enum ActivityType : uint8_t {
actUnknown = 0,
actCopyPath = 100,
actFileTransfer = 101,
actRealise = 102,
actCopyPaths = 103,
actBuilds = 104,
/** Fields:
* 0: string: path to store derivation being built.
* 1: string: representing the machine this is being built on. Empty string if local machine.
* 2: int: curRound, not used anymore, always 1?
* 3: int: nrRounds, not used anymore always 1?
*/
actBuild = 105,
actOptimiseStore = 106,
actVerifyPaths = 107,
/** Fields:
* 0: string: store path
* 1: string: substituter
*/
actSubstitute = 108,
/** Fields:
* 0: string: store path
* 1: string: substituter
*/
actQueryPathInfo = 109,
/** Fields:
* 0: string: store path
*/
actPostBuildHook = 110,
actBuildWaiting = 111,
};
template<>
struct json::is_integral_enum<ActivityType> : std::true_type {};
enum ResultType : uint8_t {
/** Fields:
* 0: int: bytes linked
*/
resFileLinked = 100,
/** Fields:
* 0: string: last line
*/
resBuildLogLine = 101,
resUntrustedPath = 102,
resCorruptedPath = 103,
/** Fields:
* 0: string: phase name
*/
resSetPhase = 104,
/** Fields:
* 0: int: done
* 1: int: expected
* 2: int: running
* 3: int: failed
*/
resProgress = 105,
/** Fields:
* 0: int: ActivityType
* 1: int: expected
*/
resSetExpected = 106,
/** Fields:
* 0: string: last line
*/
resPostBuildLogLine = 107,
};
template<>
struct json::is_integral_enum<ResultType> : std::true_type {};
typedef uint64_t ActivityId;
struct LoggerSettings : Config
{
#include "lix/libutil/logging-settings.gen.inc"
};
extern LoggerSettings loggerSettings;
class Activity;
class Logger
{
friend class Activity;
public:
enum class [[nodiscard]] BufferState {
HasSpace,
NeedsFlush,
};
struct Field
{
// FIXME: use std::variant.
enum { tInt = 0, tString = 1 } type;
uint64_t i = 0;
std::string s;
Field(const std::string & s) : type(tString), s(s) { }
Field(const char * s) : type(tString), s(s) { }
Field(const uint64_t & i) : type(tInt), i(i) { }
};
typedef std::vector<Field> Fields;
virtual ~Logger() { }
virtual void pause() { };
virtual void resetProgress() { };
virtual void resume() { };
// Whether the logger prints the whole build log
virtual bool isVerbose() { return false; }
virtual BufferState bufferState() const
{
return BufferState::HasSpace;
}
virtual BufferState log(Verbosity lvl, std::string_view s) = 0;
virtual BufferState logEI(const ErrorInfo & ei) = 0;
BufferState logEI(Verbosity lvl, ErrorInfo ei)
{
ei.level = lvl;
return logEI(ei);
}
Activity startActivity(
Verbosity lvl,
ActivityType type,
const std::string & s,
const Fields & fields = {},
const Activity * parent = nullptr
);
Activity
startActivity(ActivityType type, const Fields & fields = {}, const Activity * parent = nullptr);
virtual kj::Promise<Result<void>> flush()
{
return {result::success()};
}
virtual void waitForSpace(NeverAsync = {}) {}
protected:
virtual BufferState startActivityImpl(
ActivityId act,
Verbosity lvl,
ActivityType type,
const std::string & s,
const Fields & fields,
ActivityId parent
)
{
return BufferState::HasSpace;
}
virtual BufferState stopActivityImpl(ActivityId act)
{
return BufferState::HasSpace;
}
virtual BufferState resultImpl(ActivityId act, ResultType type, const Fields & fields)
{
return BufferState::HasSpace;
}
public:
virtual void writeToStdout(std::string_view s);
template<typename... Args>
inline void cout(const Args & ... args)
{
writeToStdout(fmt(args...));
}
virtual std::optional<char> ask(std::string_view s)
{ return {}; }
virtual void setPrintBuildLogs(bool printBuildLogs)
{ }
virtual void setPrintMultiline(bool printMultiline)
{ }
};
/**
* A variadic template that does nothing.
*
* Useful to call a function with each argument in a parameter pack.
*/
struct nop
{
template<typename... T> nop(T...)
{ }
};
class Activity
{
Logger * logger;
ActivityId id;
explicit Activity(Logger & logger);
public:
Activity(Activity && other) : logger(nullptr), id(0)
{
swap(other);
}
Activity & operator=(Activity && other)
{
Activity(std::move(other)).swap(*this);
return *this;
}
Activity(const Activity & act) = delete;
Activity & operator=(const Activity & act) = delete;
~Activity();
Logger & getLogger() const
{
return *logger;
}
void swap(Activity & other)
{
std::swap(logger, other.logger);
std::swap(id, other.id);
}
Activity addChild(
Verbosity level,
ActivityType type,
const std::string & s = "",
const Logger::Fields & fields = {}
) const
{
return logger->startActivity(level, type, s, fields, this);
}
Logger::BufferState progress(
uint64_t done = 0, uint64_t expected = 0, uint64_t running = 0, uint64_t failed = 0
) const
{
return result(resProgress, done, expected, running, failed);
}
Logger::BufferState setExpected(ActivityType type2, uint64_t expected) const
{
return result(resSetExpected, type2, expected);
}
template<typename... Args>
Logger::BufferState result(ResultType type, const Args &... args) const
{
Logger::Fields fields;
nop{(fields.emplace_back(Logger::Field(args)), 1)...};
return result(type, fields);
}
Logger::BufferState result(ResultType type, const Logger::Fields & fields) const
{
return logger->resultImpl(id, type, fields);
}
friend class Logger;
};
extern Logger * logger;
Logger * makeSimpleLogger(bool printBuildLogs = true);
Logger * makeJSONLogger(Logger & prevLogger);
/**
* suppress msgs > this
*/
extern Verbosity verbosity;
extern LoggerSettings loggerSettings;
#define ACTIVITY_PROGRESS(act, ...) \
do { \
auto && _lix_act = (act); \
if (_lix_act.progress(__VA_ARGS__) == ::nix::Logger::BufferState::NeedsFlush) { \
LIX_TRY_AWAIT(_lix_act.getLogger().flush()); \
} \
} while (0)
#define ACTIVITY_RESULT(act, ...) \
do { \
auto && _lix_act = (act); \
if (_lix_act.result(__VA_ARGS__) == ::nix::Logger::BufferState::NeedsFlush) { \
LIX_TRY_AWAIT(_lix_act.getLogger().flush()); \
} \
} while (0)
#define ACTIVITY_SET_EXPECTED(act, ...) \
do { \
auto && _lix_act = (act); \
if (_lix_act.setExpected(__VA_ARGS__) == ::nix::Logger::BufferState::NeedsFlush) { \
LIX_TRY_AWAIT(_lix_act.getLogger().flush()); \
} \
} while (0)
#define ACTIVITY_PROGRESS_SYNC(aio, act, ...) \
do { \
auto && _lix_act = (act); \
if (_lix_act.progress(__VA_ARGS__) == ::nix::Logger::BufferState::NeedsFlush) { \
(aio).blockOn(_lix_act.getLogger().flush()); \
} \
} while (0)
#define ACTIVITY_RESULT_SYNC(aio, act, ...) \
do { \
auto && _lix_act = (act); \
if (_lix_act.result(__VA_ARGS__) == ::nix::Logger::BufferState::NeedsFlush) { \
(aio).blockOn(_lix_act.getLogger().flush()); \
} \
} while (0)
#define ACTIVITY_SET_EXPECTED_SYNC(aio, act, ...) \
do { \
auto && _lix_act = (act); \
if (_lix_act.setExpected(__VA_ARGS__) == ::nix::Logger::BufferState::NeedsFlush) { \
(aio).blockOn(_lix_act.getLogger().flush()); \
} \
} while (0)
// NOTE: unlike activity progress updates we *do not* flush buffers for "normal"
// messages. the largest producers or log items are builds (which report logs as
// activity results), the curl thread (which can only wait after we have reached
// a buffer watermark, not actually flush it due to kj limitations), debug level
// log messages (which are not latency-sensitive), and interactive use (which we
// only ever run with a logger that writes directly to stderr). we have tried to
// add buffer flushing to these log macros, but it turned out to be *incredibly*
// invasive in many places to outright impossible in some, such as logError in a
// catch block (because c++ doesn't allow awaits in catch blocks). fucking mess.
/**
* Print a message with the standard ErrorInfo format.
* In general, use these 'log' macros for reporting problems that may require user
* intervention or that need more explanation. Use the 'print' macros for more
* lightweight status messages.
*/
#define logErrorInfo(level, errorInfo...) \
do { \
if ((level) <= ::nix::verbosity) { \
(void) ::nix::logger->logEI((level), errorInfo); \
} \
} while (0)
#define logError(errorInfo...) logErrorInfo(::nix::lvlError, errorInfo)
#define logWarning(errorInfo...) logErrorInfo(::nix::lvlWarn, errorInfo)
/**
* Print a string message if the current log level is at least the specified
* level. Note that this has to be implemented as a macro to ensure that the
* arguments are evaluated lazily. The format string *must* be a literal.
*/
#define printMsgUsing(loggerParam, level, fs, args...) \
do { \
auto _lix_logger_print_lvl = level; \
const char * _lix_format = []<size_t N>(const char(&_lix_fs)[N]) { return _lix_fs; }(fs); \
if (_lix_logger_print_lvl <= ::nix::verbosity) { \
(void \
) loggerParam->log(_lix_logger_print_lvl, ::nix::HintFmt(_lix_format, ##args).str()); \
} \
} while (0)
#define printMsg(level, fs, args...) printMsgUsing(::nix::logger, level, fs, ##args)
#define printWarning(fs, args...) printMsg(::nix::lvlWarn, fs, ##args)
#define printError(fs, args...) printMsg(::nix::lvlError, fs, ##args)
#define notice(fs, args...) printMsg(::nix::lvlNotice, fs, ##args)
#define printInfo(fs, args...) printMsg(::nix::lvlInfo, fs, ##args)
#define printTalkative(fs, args...) printMsg(::nix::lvlTalkative, fs, ##args)
#define debug(fs, args...) printMsg(::nix::lvlDebug, fs, ##args)
#define vomit(fs, args...) printMsg(::nix::lvlVomit, fs, ##args)
#define printTaggedWarning(fs, args...) \
printWarning(ANSI_WARNING "warning:" ANSI_NORMAL " " fs, ##args)
void writeLogsToStderr(std::string_view s);
/** Logs a fatal message as loudly as possible. This will go into syslog as well as stderr.
* The purpose of this function is making failures with redirected stderr louder. */
void logFatal(std::string const & s);
/**
* @param source A noun phrase describing the source of the message, e.g. "the builder".
*/
std::optional<JSON> parseJSONMessage(const std::string & msg, std::string_view source);
/**
* @param source A noun phrase describing the source of the message, e.g. "the builder".
*/
[[nodiscard]]
std::optional<Logger::BufferState> handleJSONLogMessage(
JSON & json,
const Activity & act,
std::map<ActivityId, Activity> & activities,
std::string_view source
);
/**
* @param source A noun phrase describing the source of the message, e.g. "the builder".
*/
[[nodiscard]]
std::optional<Logger::BufferState> handleJSONLogMessage(
const std::string & msg,
const Activity & act,
std::map<ActivityId, Activity> & activities,
std::string_view source
);
/**
* Split a log stream into lines, processing carriage returns (`\r`) as a terminal would.
*/
class LogLineSplitter
{
std::string line;
size_t pos = 0;
public:
/**
* Feeds some input to the splitter and returns the first full line or `nullopt` if
* there is no complete line in the buffer yet. If any input remains `input` is set
* to the unconsumed data and `feed` should be called again until `input` is empty.
* If this function returns `nullopt` it guarantees that `input` is fully consumed.
*/
std::optional<std::string> feed(std::string_view & input);
/**
* Clear the line buffer and return its current contents.
*/
std::string finish();
};
}
|