• Home
  • Features
  • Pricing
  • Docs
  • Announcements
  • Sign In

systemd / systemd / 19448983682

17 Nov 2025 11:32PM UTC coverage: 72.503% (-0.2%) from 72.719%
19448983682

push

github

web-flow
core/unit: unit_process_job() tweaks (#39753)

6 of 8 new or added lines in 1 file covered. (75.0%)

3363 existing lines in 68 files now uncovered.

308308 of 425234 relevant lines covered (72.5%)

1141671.45 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

84.78
/src/basic/log.c
1
/* SPDX-License-Identifier: LGPL-2.1-or-later */
2

3
#include <fcntl.h>
4
#include <sys/signalfd.h>
5
#include <sys/stat.h>
6
#include <sys/uio.h>
7
#include <threads.h>
8
#include <unistd.h>
9

10
#include "sd-messages.h"
11

12
#include "alloc-util.h"
13
#include "ansi-color.h"
14
#include "argv-util.h"
15
#include "env-util.h"
16
#include "errno-util.h"
17
#include "extract-word.h"
18
#include "fd-util.h"
19
#include "format-util.h"
20
#include "iovec-util.h"
21
#include "list.h"
22
#include "log.h"
23
#include "log-context.h"
24
#include "parse-util.h"
25
#include "proc-cmdline.h"
26
#include "process-util.h"
27
#include "ratelimit.h"
28
#include "signal-util.h"
29
#include "socket-util.h"
30
#include "stdio-util.h"
31
#include "string-table.h"
32
#include "string-util.h"
33
#include "strv.h"
34
#include "syslog-util.h"
35
#include "terminal-util.h"
36
#include "time-util.h"
37
#include "utf8.h"
38

39
#define SNDBUF_SIZE (8*1024*1024)
40
#define IOVEC_MAX 256U
41

42
static log_syntax_callback_t log_syntax_callback = NULL;
43
static void *log_syntax_callback_userdata = NULL;
44

45
static LogTarget log_target = LOG_TARGET_CONSOLE;
46
static int log_max_level = LOG_INFO;
47
static int log_target_max_level[_LOG_TARGET_SINGLE_MAX] = {
48
        [LOG_TARGET_CONSOLE] = INT_MAX,
49
        [LOG_TARGET_KMSG]    = INT_MAX,
50
        [LOG_TARGET_SYSLOG]  = INT_MAX,
51
        [LOG_TARGET_JOURNAL] = INT_MAX,
52
};
53
static int log_facility = LOG_DAEMON;
54
static bool ratelimit_kmsg = true;
55

56
static int console_fd = STDERR_FILENO;
57
static int console_fd_is_tty = -1; /* tri-state: -1 means don't know */
58
static int syslog_fd = -EBADF;
59
static int kmsg_fd = -EBADF;
60
static int journal_fd = -EBADF;
61

62
static bool syslog_is_stream = false;
63

64
static int show_color = -1; /* tristate */
65
static bool show_location = false;
66
static bool show_time = false;
67
static bool show_tid = false;
68

69
static bool upgrade_syslog_to_journal = false;
70
static bool always_reopen_console = false;
71
static bool open_when_needed = false;
72
static bool prohibit_ipc = false;
73

74
static thread_local const char *log_prefix = NULL;
75

76
#if LOG_MESSAGE_VERIFICATION || defined(__COVERITY__)
77
bool _log_message_dummy = false; /* Always false */
78
#endif
79

80
/* An assert to use in logging functions that does not call recursively
81
 * into our logging functions (since that might lead to a loop). */
82
#define assert_raw(expr)                                                \
83
        do {                                                            \
84
                if (_unlikely_(!(expr))) {                              \
85
                        fputs(#expr "\n", stderr);                      \
86
                        abort();                                        \
87
                }                                                       \
88
        } while (false)
89

90
static void log_close_console(void) {
294,963✔
91
        /* See comment in log_close_journal() */
92
        (void) safe_close_above_stdio(TAKE_FD(console_fd));
294,963✔
93
        console_fd_is_tty = -1;
294,963✔
94
}
294,963✔
95

96
static int log_open_console(void) {
66,601✔
97

98
        if (!always_reopen_console) {
66,601✔
99
                console_fd = STDERR_FILENO;
51,222✔
100
                console_fd_is_tty = -1;
51,222✔
101
                return 0;
51,222✔
102
        }
103

104
        if (console_fd < 3) {
15,379✔
105
                int fd;
13,132✔
106

107
                fd = open_terminal("/dev/console", O_WRONLY|O_NOCTTY|O_CLOEXEC);
13,132✔
108
                if (fd < 0)
13,132✔
109
                        return fd;
110

111
                console_fd = fd_move_above_stdio(fd);
11,972✔
112
                console_fd_is_tty = true;
11,972✔
113
        }
114

115
        return 0;
116
}
117

118
static void log_close_kmsg(void) {
153,842✔
119
        /* See comment in log_close_journal() */
120
        (void) safe_close(TAKE_FD(kmsg_fd));
153,842✔
121
}
153,842✔
122

123
static int log_open_kmsg(void) {
10,866✔
124

125
        if (kmsg_fd >= 0)
10,866✔
126
                return 0;
127

128
        kmsg_fd = open("/dev/kmsg", O_WRONLY|O_NOCTTY|O_CLOEXEC);
8,290✔
129
        if (kmsg_fd < 0)
8,290✔
130
                return -errno;
4,142✔
131

132
        kmsg_fd = fd_move_above_stdio(kmsg_fd);
4,148✔
133
        return 0;
4,148✔
134
}
135

136
static void log_close_syslog(void) {
361,562✔
137
        /* See comment in log_close_journal() */
138
        (void) safe_close(TAKE_FD(syslog_fd));
361,562✔
139
}
361,562✔
140

141
static int create_log_socket(int type) {
133,482✔
142
        struct timeval tv;
133,482✔
143
        int fd;
133,482✔
144

145
        fd = socket(AF_UNIX, type|SOCK_CLOEXEC, 0);
133,482✔
146
        if (fd < 0)
133,482✔
147
                return -errno;
×
148

149
        fd = fd_move_above_stdio(fd);
133,482✔
150
        (void) fd_inc_sndbuf(fd, SNDBUF_SIZE);
133,482✔
151

152
        /* We need a blocking fd here since we'd otherwise lose messages way too early. However, let's not hang forever
153
         * in the unlikely case of a deadlock. */
154
        if (getpid_cached() == 1)
133,482✔
155
                timeval_store(&tv, 10 * USEC_PER_MSEC);
302✔
156
        else
157
                timeval_store(&tv, 10 * USEC_PER_SEC);
133,180✔
158
        (void) setsockopt(fd, SOL_SOCKET, SO_SNDTIMEO, &tv, sizeof(tv));
133,482✔
159

160
        return fd;
133,482✔
161
}
162

163
static int log_open_syslog(void) {
2✔
164
        int r;
2✔
165

166
        if (syslog_fd >= 0)
2✔
167
                return 0;
168

169
        syslog_fd = create_log_socket(SOCK_DGRAM);
2✔
170
        if (syslog_fd < 0) {
2✔
171
                r = syslog_fd;
×
172
                goto fail;
×
173
        }
174

175
        r = connect_unix_path(syslog_fd, AT_FDCWD, "/dev/log");
2✔
176
        if (r < 0) {
2✔
177
                safe_close(syslog_fd);
×
178

179
                /* Some legacy syslog systems still use stream sockets. They really shouldn't. But what can
180
                 * we do... */
181
                syslog_fd = create_log_socket(SOCK_STREAM);
×
182
                if (syslog_fd < 0) {
×
183
                        r = syslog_fd;
×
184
                        goto fail;
×
185
                }
186

187
                r = connect_unix_path(syslog_fd, AT_FDCWD, "/dev/log");
×
188
                if (r < 0)
×
189
                        goto fail;
×
190

191
                syslog_is_stream = true;
×
192
        } else
193
                syslog_is_stream = false;
2✔
194

195
        return 0;
196

197
fail:
×
198
        log_close_syslog();
×
199
        return r;
×
200
}
201

202
static void log_close_journal(void) {
226,286✔
203
        /* If the journal FD is bad, safe_close will fail, and will try to log, which will fail, so we'll
204
         * try to close the journal FD, which is bad, so safe_close will fail... Whether we can close it
205
         * or not, invalidate it immediately so that we don't get in a recursive loop until we run out of
206
         * stack. */
207
        (void) safe_close(TAKE_FD(journal_fd));
226,286✔
208
}
226,286✔
209

210
static int log_open_journal(void) {
143,897✔
211
        int r;
143,897✔
212

213
        if (journal_fd >= 0)
143,897✔
214
                return 0;
215

216
        journal_fd = create_log_socket(SOCK_DGRAM);
133,480✔
217
        if (journal_fd < 0) {
133,480✔
218
                r = journal_fd;
×
219
                goto fail;
×
220
        }
221

222
        r = connect_unix_path(journal_fd, AT_FDCWD, "/run/systemd/journal/socket");
133,480✔
223
        if (r < 0)
133,480✔
224
                goto fail;
53✔
225

226
        return 0;
227

228
fail:
53✔
229
        log_close_journal();
53✔
230
        return r;
53✔
231
}
232

233
bool stderr_is_journal(void) {
200,847✔
234
        _cleanup_free_ char *w = NULL;
200,847✔
235
        const char *e;
200,847✔
236
        uint64_t dev, ino;
200,847✔
237
        struct stat st;
200,847✔
238

239
        e = getenv("JOURNAL_STREAM");
200,847✔
240
        if (!e)
200,847✔
241
                return false;
242

243
        if (extract_first_word(&e, &w, ":", EXTRACT_DONT_COALESCE_SEPARATORS) <= 0)
24,498✔
244
                return false;
245
        if (!e)
24,498✔
246
                return false;
247

248
        if (safe_atou64(w, &dev) < 0)
24,498✔
249
                return false;
250
        if (safe_atou64(e, &ino) < 0)
24,498✔
251
                return false;
252

253
        if (fstat(STDERR_FILENO, &st) < 0)
24,498✔
254
                return false;
255

256
        return st.st_dev == dev && st.st_ino == ino;
25,503✔
257
}
258

259
int log_open(void) {
207,722✔
260
        int r;
207,722✔
261

262
        /* Do not call from library code. */
263

264
        /* This function is often called in preparation for logging. Let's make sure we don't clobber errno,
265
         * so that a call to a logging function immediately following a log_open() call can still easily
266
         * reference an error that happened immediately before the log_open() call. */
267
        PROTECT_ERRNO;
207,722✔
268

269
        /* If we don't use the console, we close it here to not get killed by SAK. If we don't use syslog, we
270
         * close it here too, so that we are not confused by somebody deleting the socket in the fs, and to
271
         * make sure we don't use it if prohibit_ipc is set. If we don't use /dev/kmsg we still keep it open,
272
         * because there is no reason to close it. */
273

274
        if (log_target == LOG_TARGET_NULL) {
207,722✔
275
                log_close_journal();
1✔
276
                log_close_syslog();
1✔
277
                log_close_console();
1✔
278
                return 0;
279
        }
280

281
        if (getpid_cached() == 1 ||
401,191✔
282
            stderr_is_journal() ||
193,470✔
283
            IN_SET(log_target,
177,103✔
284
                   LOG_TARGET_KMSG,
285
                   LOG_TARGET_JOURNAL,
286
                   LOG_TARGET_JOURNAL_OR_KMSG,
287
                   LOG_TARGET_SYSLOG,
288
                   LOG_TARGET_SYSLOG_OR_KMSG)) {
289

290
                if (!prohibit_ipc) {
147,151✔
291
                        if (IN_SET(log_target,
142,885✔
292
                                   LOG_TARGET_AUTO,
293
                                   LOG_TARGET_JOURNAL_OR_KMSG,
294
                                   LOG_TARGET_JOURNAL)) {
295

296
                                r = log_open_journal();
135,374✔
297
                                if (r >= 0) {
135,374✔
298
                                        log_close_syslog();
135,334✔
299
                                        log_close_console();
135,334✔
300
                                        return r;
301
                                }
302
                        }
303

304
                        if (IN_SET(log_target,
7,551✔
305
                                   LOG_TARGET_SYSLOG_OR_KMSG,
306
                                   LOG_TARGET_SYSLOG)) {
307

308
                                r = log_open_syslog();
2✔
309
                                if (r >= 0) {
2✔
310
                                        log_close_journal();
2✔
311
                                        log_close_console();
2✔
312
                                        return r;
313
                                }
314
                        }
315
                }
316

317
                if (IN_SET(log_target, LOG_TARGET_AUTO,
11,815✔
318
                                       LOG_TARGET_JOURNAL_OR_KMSG,
319
                                       LOG_TARGET_SYSLOG_OR_KMSG,
320
                                       LOG_TARGET_KMSG)) {
321
                        r = log_open_kmsg();
9,926✔
322
                        if (r >= 0) {
9,926✔
323
                                log_close_journal();
5,784✔
324
                                log_close_syslog();
5,784✔
325
                                log_close_console();
5,784✔
326
                                return r;
327
                        }
328
                }
329
        }
330

331
        log_close_journal();
66,601✔
332
        log_close_syslog();
66,601✔
333

334
        return log_open_console();
66,601✔
335
}
336

337
void log_set_target(LogTarget target) {
90,303✔
338
        assert(target >= 0);
90,303✔
339
        assert(target < _LOG_TARGET_MAX);
90,303✔
340

341
        if (upgrade_syslog_to_journal) {
90,303✔
342
                if (target == LOG_TARGET_SYSLOG)
302✔
343
                        target = LOG_TARGET_JOURNAL;
344
                else if (target == LOG_TARGET_SYSLOG_OR_KMSG)
302✔
345
                        target = LOG_TARGET_JOURNAL_OR_KMSG;
×
346
        }
347

348
        log_target = target;
90,303✔
349
}
90,303✔
350

351
void log_set_target_and_open(LogTarget target) {
289✔
352
        log_set_target(target);
289✔
353
        log_open();
289✔
354
}
289✔
355

356
void log_close(void) {
153,842✔
357
        /* Do not call from library code. */
358

359
        log_close_journal();
153,842✔
360
        log_close_syslog();
153,842✔
361
        log_close_kmsg();
153,842✔
362
        log_close_console();
153,842✔
363
}
153,842✔
364

365
void log_forget_fds(void) {
10,082✔
366
        /* Do not call from library code. */
367

368
        console_fd = kmsg_fd = syslog_fd = journal_fd = -EBADF;
10,082✔
369
        console_fd_is_tty = -1;
10,082✔
370
}
10,082✔
371

372
int log_set_max_level(int level) {
769,936✔
373
        assert(level == LOG_NULL || log_level_is_valid(level));
769,936✔
374

375
        int old = log_max_level;
769,936✔
376
        log_max_level = level;
769,936✔
377

378
        /* Also propagate max log level to libc's syslog(), just in case some other component loaded into our
379
         * process logs directly via syslog(). You might wonder why we maintain our own log level variable if
380
         * libc has the same functionality. This has multiple reasons, first and foremost that we want to
381
         * apply this to all our log targets, not just syslog and console. Moreover, we cannot query the
382
         * current log mask from glibc without changing it, but that's useful for testing the current log
383
         * level before even entering the log functions like we do in our macros. */
384
        setlogmask(LOG_UPTO(level));
769,936✔
385

386
        /* Ensure that our own LOG_NULL define maps sanely to the log mask */
387
        assert_cc(LOG_UPTO(LOG_NULL) == 0);
769,936✔
388

389
        return old;
769,936✔
390
}
391

392
void log_set_facility(int facility) {
167✔
393
        log_facility = facility;
167✔
394
}
167✔
395

396
static bool check_console_fd_is_tty(void) {
182,287✔
397
        if (console_fd < 0)
182,287✔
398
                return false;
399

400
        if (console_fd_is_tty < 0)
182,287✔
401
                console_fd_is_tty = isatty_safe(console_fd);
10,963✔
402

403
        return console_fd_is_tty;
182,287✔
404
}
405

406
static int write_to_console(
270,720✔
407
                int level,
408
                int error,
409
                const char *file,
410
                int line,
411
                const char *func,
412
                const char *buffer) {
413

414
        static int dumb = -1;
270,720✔
415

416
        char location[256],
270,720✔
417
             header_time[FORMAT_TIMESTAMP_MAX],
418
             prefix[1 + DECIMAL_STR_MAX(int) + 2],
419
             tid_string[3 + DECIMAL_STR_MAX(pid_t) + 1];
420
        struct iovec iovec[11];
270,720✔
421
        const char *on = NULL, *off = NULL;
270,720✔
422
        size_t n = 0;
270,720✔
423

424
        if (console_fd < 0)
270,720✔
425
                return 0;
270,720✔
426

427
        if (dumb < 0)
270,279✔
428
                dumb = getenv_terminal_is_dumb();
11,633✔
429

430
        if (LOG_PRI(level) > log_target_max_level[LOG_TARGET_CONSOLE])
270,279✔
431
                return 0;
432

433
        if (log_target == LOG_TARGET_CONSOLE_PREFIXED) {
182,287✔
434
                xsprintf(prefix, "<%i>", level);
370✔
435
                iovec[n++] = IOVEC_MAKE_STRING(prefix);
370✔
436
        }
437

438
        if (show_time &&
182,287✔
439
            format_timestamp(header_time, sizeof(header_time), now(CLOCK_REALTIME))) {
×
440
                iovec[n++] = IOVEC_MAKE_STRING(header_time);
×
441
                iovec[n++] = IOVEC_MAKE_STRING(" ");
×
442
        }
443

444
        if (show_tid) {
182,287✔
445
                xsprintf(tid_string, "(" PID_FMT ") ", gettid());
×
446
                iovec[n++] = IOVEC_MAKE_STRING(tid_string);
×
447
        }
448

449
        if (log_get_show_color())
182,287✔
450
                get_log_colors(LOG_PRI(level), &on, &off, NULL);
165,221✔
451

452
        if (show_location) {
182,287✔
453
                const char *lon = "", *loff = "";
×
454
                if (log_get_show_color()) {
×
455
                        lon = ansi_highlight_yellow4();
×
456
                        loff = ansi_normal();
×
457
                }
458

459
                (void) snprintf(location, sizeof location, "%s%s:%i%s: ", lon, file, line, loff);
×
460
                iovec[n++] = IOVEC_MAKE_STRING(location);
×
461
        }
462

463
        if (on)
182,287✔
464
                iovec[n++] = IOVEC_MAKE_STRING(on);
155,014✔
465
        if (log_prefix) {
182,287✔
466
                iovec[n++] = IOVEC_MAKE_STRING(log_prefix);
8,216✔
467
                iovec[n++] = IOVEC_MAKE_STRING(": ");
8,216✔
468
        }
469
        iovec[n++] = IOVEC_MAKE_STRING(buffer);
182,287✔
470
        if (off)
182,287✔
471
                iovec[n++] = IOVEC_MAKE_STRING(off);
155,014✔
472

473
        /* When writing to a TTY we output an extra '\r' (i.e. CR) first, to generate CRNL rather than just
474
         * NL. This is a robustness thing in case the TTY is currently in raw mode (specifically: has the
475
         * ONLCR flag off). We want that subsequent output definitely starts at the beginning of the line
476
         * again, after all. If the TTY is not in raw mode the extra CR should not hurt. If we're writing to
477
         * a dumb terminal, only write NL as CRNL might be interpreted as a double newline. */
478
        iovec[n++] = IOVEC_MAKE_STRING(check_console_fd_is_tty() && !dumb ? "\r\n" : "\n");
364,574✔
479

480
        if (writev(console_fd, iovec, n) < 0) {
182,287✔
481

482
                if (errno == EIO && getpid_cached() == 1) {
80✔
483

484
                        /* If somebody tried to kick us from our console tty (via vhangup() or suchlike), try
485
                         * to reconnect. */
486

487
                        log_close_console();
×
488
                        (void) log_open_console();
×
489
                        if (console_fd < 0)
×
490
                                return 0;
491

492
                        if (writev(console_fd, iovec, n) < 0)
×
493
                                return -errno;
×
494
                } else
495
                        return -errno;
80✔
496
        }
497

498
        return 1;
499
}
500

501
static int write_to_syslog(
180✔
502
                int level,
503
                int error,
504
                const char *file,
505
                int line,
506
                const char *func,
507
                const char *buffer) {
508

509
        char header_priority[2 + DECIMAL_STR_MAX(int) + 1],
180✔
510
             header_time[64],
511
             header_pid[4 + DECIMAL_STR_MAX(pid_t) + 1];
512
        struct tm tm;
180✔
513
        int r;
180✔
514

515
        if (syslog_fd < 0)
180✔
516
                return 0;
180✔
517

518
        if (LOG_PRI(level) > log_target_max_level[LOG_TARGET_SYSLOG])
180✔
519
                return 0;
520

521
        xsprintf(header_priority, "<%i>", level);
180✔
522

523
        r = localtime_or_gmtime_usec(now(CLOCK_REALTIME), /* utc= */ false, &tm);
180✔
524
        if (r < 0)
180✔
525
                return r;
526

527
        if (strftime(header_time, sizeof(header_time), "%h %e %T ", &tm) <= 0)
180✔
528
                return -EINVAL;
529

530
        xsprintf(header_pid, "["PID_FMT"]: ", getpid_cached());
180✔
531

532
        struct iovec iovec[] = {
1,440✔
533
                IOVEC_MAKE_STRING(header_priority),
180✔
534
                IOVEC_MAKE_STRING(header_time),
180✔
535
                IOVEC_MAKE_STRING(program_invocation_short_name),
180✔
536
                IOVEC_MAKE_STRING(header_pid),
180✔
537
                IOVEC_MAKE_STRING(strempty(log_prefix)),
292✔
538
                IOVEC_MAKE_STRING(log_prefix ? ": " : ""),
292✔
539
                IOVEC_MAKE_STRING(buffer),
180✔
540
        };
541
        const struct msghdr msghdr = {
180✔
542
                .msg_iov = iovec,
543
                .msg_iovlen = ELEMENTSOF(iovec),
544
        };
545

546
        /* When using syslog via SOCK_STREAM separate the messages by NUL chars */
547
        if (syslog_is_stream)
180✔
548
                iovec[ELEMENTSOF(iovec) - 1].iov_len++;
×
549

550
        for (;;) {
180✔
551
                ssize_t n;
180✔
552

553
                n = sendmsg(syslog_fd, &msghdr, MSG_NOSIGNAL);
180✔
554
                if (n < 0)
180✔
555
                        return -errno;
×
556

557
                if (!syslog_is_stream)
180✔
558
                        break;
559

560
                if (iovec_increment(iovec, ELEMENTSOF(iovec), n))
×
561
                        break;
562
        }
563

564
        return 1;
565
}
566

567
static int write_to_kmsg(
226,923✔
568
                int level,
569
                int error,
570
                const char *file,
571
                int line,
572
                const char *func,
573
                const char *buffer) {
574

575
        /* Set a ratelimit on the amount of messages logged to /dev/kmsg. This is mostly supposed to be a
576
         * safety catch for the case where start indiscriminately logging in a loop. It will not catch cases
577
         * where we log excessively, but not in a tight loop.
578
         *
579
         * Note that this ratelimit is per-emitter, so we might still overwhelm /dev/kmsg with multiple
580
         * loggers.
581
         */
582
        static thread_local RateLimit ratelimit = { 5 * USEC_PER_SEC, 200 };
226,923✔
583

584
        char header_priority[2 + DECIMAL_STR_MAX(int) + 1],
226,923✔
585
             header_pid[4 + DECIMAL_STR_MAX(pid_t) + 1];
586

587
        if (kmsg_fd < 0)
226,923✔
588
                return 0;
226,923✔
589

590
        if (LOG_PRI(level) > log_target_max_level[LOG_TARGET_KMSG])
41,359✔
591
                return 0;
592

593
        if (ratelimit_kmsg && !ratelimit_below(&ratelimit)) {
41,359✔
594
                if (ratelimit_num_dropped(&ratelimit) > 1)
×
595
                        return 0;
596

597
                buffer = "Too many messages being logged to kmsg, ignoring";
598
        }
599

600
        xsprintf(header_priority, "<%i>", level);
41,359✔
601
        xsprintf(header_pid, "["PID_FMT"]: ", getpid_cached());
41,359✔
602

603
        const struct iovec iovec[] = {
330,872✔
604
                IOVEC_MAKE_STRING(header_priority),
41,359✔
605
                IOVEC_MAKE_STRING(program_invocation_short_name),
41,359✔
606
                IOVEC_MAKE_STRING(header_pid),
41,359✔
607
                IOVEC_MAKE_STRING(strempty(log_prefix)),
65,107✔
608
                IOVEC_MAKE_STRING(log_prefix ? ": " : ""),
65,107✔
609
                IOVEC_MAKE_STRING(buffer),
41,359✔
610
                IOVEC_MAKE_STRING("\n"),
41,359✔
611
        };
612

613
        if (writev(kmsg_fd, iovec, ELEMENTSOF(iovec)) < 0)
41,359✔
614
                return -errno;
×
615

616
        return 1;
617
}
618

619
static int log_do_header(
5,417,221✔
620
                char *header,
621
                size_t size,
622
                int level,
623
                int error,
624
                const char *file, int line, const char *func,
625
                const char *object_field, const char *object,
626
                const char *extra_field, const char *extra) {
627
        int r;
5,417,221✔
628

629
        error = IS_SYNTHETIC_ERRNO(error) ? 0 : ERRNO_VALUE(error);
5,417,221✔
630

631
        r = snprintf(header, size,
5,417,221✔
632
                     "PRIORITY=%i\n"
633
                     "SYSLOG_FACILITY=%i\n"
634
                     "TID=" PID_FMT "\n"
635
                     "%s%.256s%s"        /* CODE_FILE */
636
                     "%s%.*i%s"          /* CODE_LINE */
637
                     "%s%.256s%s"        /* CODE_FUNC */
638
                     "%s%.*i%s"          /* ERRNO */
639
                     "%s%.256s%s"        /* object */
640
                     "%s%.256s%s"        /* extra */
641
                     "SYSLOG_IDENTIFIER=%.256s\n",
642
                     LOG_PRI(level),
643
                     LOG_FAC(level),
5,417,221✔
644
                     gettid(),
645
                     isempty(file) ? "" : "CODE_FILE=",
5,417,221✔
646
                     isempty(file) ? "" : file,
5,417,221✔
647
                     isempty(file) ? "" : "\n",
5,417,221✔
648
                     line ? "CODE_LINE=" : "",
649
                     line ? 1 : 0, line, /* %.0d means no output too, special case for 0 */
650
                     line ? "\n" : "",
651
                     isempty(func) ? "" : "CODE_FUNC=",
5,417,221✔
652
                     isempty(func) ? "" : func,
5,417,221✔
653
                     isempty(func) ? "" : "\n",
5,417,221✔
654
                     error ? "ERRNO=" : "",
655
                     error ? 1 : 0, error,
656
                     error ? "\n" : "",
657
                     isempty(object) ? "" : ASSERT_PTR(object_field),
5,417,221✔
658
                     isempty(object) ? "" : object,
5,417,221✔
659
                     isempty(object) ? "" : "\n",
5,417,221✔
660
                     isempty(extra) ? "" : ASSERT_PTR(extra_field),
5,417,221✔
661
                     isempty(extra) ? "" : extra,
5,417,221✔
662
                     isempty(extra) ? "" : "\n",
5,417,221✔
663
                     program_invocation_short_name);
664
        assert_raw((size_t) r < size);
5,417,221✔
665

666
        return 0;
5,417,221✔
667
}
668

669
static void log_do_context(struct iovec *iovec, size_t iovec_len, size_t *n) {
5,417,221✔
670
        assert(iovec);
5,417,221✔
671
        assert(n);
5,417,221✔
672

673
        LIST_FOREACH(ll, c, log_context_head()) {
7,570,084✔
674
                STRV_FOREACH(s, c->fields) {
19,987,032✔
675
                        if (*n + 2 >= iovec_len)
17,731,780✔
676
                                return;
×
677

678
                        iovec[(*n)++] = IOVEC_MAKE_STRING(*s);
17,731,780✔
679
                        iovec[(*n)++] = IOVEC_MAKE_STRING("\n");
17,731,780✔
680
                }
681

682
                for (size_t i = 0; i < c->n_input_iovec; i++) {
2,264,220✔
683
                        if (*n + 2 >= iovec_len)
8,968✔
684
                                return;
×
685

686
                        iovec[(*n)++] = c->input_iovec[i];
8,968✔
687
                        iovec[(*n)++] = IOVEC_MAKE_STRING("\n");
8,968✔
688
                }
689

690
                if (c->key && c->value) {
2,255,252✔
691
                        if (*n + 3 >= iovec_len)
231,572✔
692
                                return;
102,389✔
693

694
                        iovec[(*n)++] = IOVEC_MAKE_STRING(c->key);
129,183✔
695
                        iovec[(*n)++] = IOVEC_MAKE_STRING(c->value);
129,183✔
696
                        iovec[(*n)++] = IOVEC_MAKE_STRING("\n");
129,183✔
697
                }
698
        }
699
}
700

701
static int write_to_journal(
5,615,160✔
702
                int level,
703
                int error,
704
                const char *file,
705
                int line,
706
                const char *func,
707
                const char *object_field,
708
                const char *object,
709
                const char *extra_field,
710
                const char *extra,
711
                const char *buffer) {
712

713
        char header[LINE_MAX];
5,615,160✔
714
        size_t n = 0, iovec_len;
5,615,160✔
715
        struct iovec *iovec;
5,615,160✔
716

717
        if (journal_fd < 0)
5,615,160✔
718
                return 0;
5,615,160✔
719

720
        if (LOG_PRI(level) > log_target_max_level[LOG_TARGET_JOURNAL])
5,345,265✔
721
                return 0;
722

723
        iovec_len = MIN(6 + log_context_num_fields() * 3, IOVEC_MAX);
5,345,265✔
724
        iovec = newa(struct iovec, iovec_len);
5,345,265✔
725

726
        log_do_header(header, sizeof(header), level, error, file, line, func, object_field, object, extra_field, extra);
5,345,265✔
727

728
        iovec[n++] = IOVEC_MAKE_STRING(header);
5,345,265✔
729
        iovec[n++] = IOVEC_MAKE_STRING("MESSAGE=");
5,345,265✔
730
        if (log_prefix) {
5,345,265✔
731
                iovec[n++] = IOVEC_MAKE_STRING(log_prefix);
1,872,736✔
732
                iovec[n++] = IOVEC_MAKE_STRING(": ");
1,872,736✔
733
        }
734
        iovec[n++] = IOVEC_MAKE_STRING(buffer);
5,345,265✔
735
        iovec[n++] = IOVEC_MAKE_STRING("\n");
5,345,265✔
736

737
        log_do_context(iovec, iovec_len, &n);
5,345,265✔
738

739
        const struct msghdr msghdr = {
5,345,265✔
740
                .msg_iov = iovec,
741
                .msg_iovlen = n,
742
        };
743

744
        if (sendmsg(journal_fd, &msghdr, MSG_NOSIGNAL) < 0)
5,345,265✔
745
                return -errno;
1,061✔
746

747
        return 1;
748
}
749

750
int log_dispatch_internal(
5,646,702✔
751
                int level,
752
                int error,
753
                const char *file,
754
                int line,
755
                const char *func,
756
                const char *object_field,
757
                const char *object,
758
                const char *extra_field,
759
                const char *extra,
760
                char *buffer) {
761

762
        assert_raw(buffer);
5,646,702✔
763

764
        if (log_target == LOG_TARGET_NULL)
5,646,702✔
765
                return -ERRNO_VALUE(error);
37✔
766

767
        /* Patch in LOG_DAEMON facility if necessary */
768
        if (LOG_FAC(level) == 0)
5,646,665✔
769
                level |= log_facility;
5,637,089✔
770

771
        if (open_when_needed)
5,646,665✔
772
                (void) log_open();
106,697✔
773

774
        do {
5,710,988✔
775
                char *e;
5,710,988✔
776
                int k = 0;
5,710,988✔
777

778
                buffer += strspn(buffer, NEWLINE);
5,710,988✔
779

780
                if (buffer[0] == 0)
5,710,988✔
781
                        break;
782

783
                if ((e = strpbrk(buffer, NEWLINE)))
5,656,463✔
784
                        *(e++) = 0;
64,323✔
785

786
                if (IN_SET(log_target, LOG_TARGET_AUTO,
5,656,463✔
787
                                       LOG_TARGET_JOURNAL_OR_KMSG,
788
                                       LOG_TARGET_JOURNAL)) {
789

790
                        k = write_to_journal(level, error, file, line, func, object_field, object, extra_field, extra, buffer);
5,615,160✔
791
                        if (k < 0 && k != -EAGAIN)
5,615,160✔
792
                                log_close_journal();
3✔
793
                }
794

795
                if (IN_SET(log_target, LOG_TARGET_SYSLOG_OR_KMSG,
5,656,463✔
796
                                       LOG_TARGET_SYSLOG)) {
797

798
                        k = write_to_syslog(level, error, file, line, func, buffer);
180✔
799
                        if (k < 0 && k != -EAGAIN)
180✔
800
                                log_close_syslog();
×
801
                }
802

803
                if (k <= 0 &&
5,656,463✔
804
                    IN_SET(log_target, LOG_TARGET_AUTO,
312,079✔
805
                                       LOG_TARGET_SYSLOG_OR_KMSG,
806
                                       LOG_TARGET_JOURNAL_OR_KMSG,
807
                                       LOG_TARGET_KMSG)) {
808

809
                        if (k < 0)
226,923✔
810
                                log_open_kmsg();
940✔
811

812
                        k = write_to_kmsg(level, error, file, line, func, buffer);
226,923✔
813
                        if (k < 0) {
226,923✔
814
                                log_close_kmsg();
×
815
                                (void) log_open_console();
×
816
                        }
817
                }
818

819
                if (k <= 0)
312,079✔
820
                        (void) write_to_console(level, error, file, line, func, buffer);
270,720✔
821

822
                buffer = e;
5,656,463✔
823
        } while (buffer);
5,656,463✔
824

825
        if (open_when_needed)
5,646,665✔
826
                log_close();
106,697✔
827

828
        return -ERRNO_VALUE(error);
5,646,665✔
829
}
830

831
int log_dump_internal(
6✔
832
                int level,
833
                int error,
834
                const char *file,
835
                int line,
836
                const char *func,
837
                char *buffer) {
838

839
        PROTECT_ERRNO;
6✔
840

841
        /* This modifies the buffer... */
842

843
        if (_likely_(LOG_PRI(level) > log_max_level))
6✔
844
                return -ERRNO_VALUE(error);
×
845

846
        return log_dispatch_internal(level, error, file, line, func, NULL, NULL, NULL, NULL, buffer);
6✔
847
}
848

849
int log_internalv(
3,824,726✔
850
                int level,
851
                int error,
852
                const char *file,
853
                int line,
854
                const char *func,
855
                const char *format,
856
                va_list ap) {
857

858
        if (_likely_(LOG_PRI(level) > log_max_level))
3,824,726✔
859
                return -ERRNO_VALUE(error);
3,824,726✔
860

861
        /* Make sure that %m maps to the specified error (or "Success"). */
862
        char buffer[LINE_MAX];
3,824,431✔
863
        LOCAL_ERRNO(ERRNO_VALUE(error));
3,824,431✔
864

865
        (void) vsnprintf(buffer, sizeof buffer, format, ap);
3,824,431✔
866

867
        return log_dispatch_internal(level, error, file, line, func, NULL, NULL, NULL, NULL, buffer);
3,824,431✔
868
}
869

870
int log_internal(
3,822,951✔
871
                int level,
872
                int error,
873
                const char *file,
874
                int line,
875
                const char *func,
876
                const char *format, ...) {
877

878
        va_list ap;
3,822,951✔
879
        int r;
3,822,951✔
880

881
        va_start(ap, format);
3,822,951✔
882
        r = log_internalv(level, error, file, line, func, format, ap);
3,822,951✔
883
        va_end(ap);
3,822,951✔
884

885
        return r;
3,822,951✔
886
}
887

888
int log_object_internalv(
1,865,027✔
889
                int level,
890
                int error,
891
                const char *file,
892
                int line,
893
                const char *func,
894
                const char *object_field,
895
                const char *object,
896
                const char *extra_field,
897
                const char *extra,
898
                const char *format,
899
                va_list ap) {
900

901
        char *buffer, *b;
1,865,027✔
902

903
        if (_likely_(LOG_PRI(level) > log_max_level))
1,865,027✔
904
                return -ERRNO_VALUE(error);
1,865,027✔
905

906
        /* Make sure that %m maps to the specified error (or "Success"). */
907
        LOCAL_ERRNO(ERRNO_VALUE(error));
×
908

909
        LOG_SET_PREFIX(object);
3,625,724✔
910

911
        b = buffer = newa(char, LINE_MAX);
1,812,862✔
912
        (void) vsnprintf(b, LINE_MAX, format, ap);
1,812,862✔
913

914
        return log_dispatch_internal(level, error, file, line, func,
1,812,862✔
915
                                     object_field, object, extra_field, extra, buffer);
916
}
917

918
int log_object_internal(
1,860,047✔
919
                int level,
920
                int error,
921
                const char *file,
922
                int line,
923
                const char *func,
924
                const char *object_field,
925
                const char *object,
926
                const char *extra_field,
927
                const char *extra,
928
                const char *format, ...) {
929

930
        va_list ap;
1,860,047✔
931
        int r;
1,860,047✔
932

933
        va_start(ap, format);
1,860,047✔
934
        r = log_object_internalv(level, error, file, line, func, object_field, object, extra_field, extra, format, ap);
1,860,047✔
935
        va_end(ap);
1,860,047✔
936

937
        return r;
1,860,047✔
938
}
939

940
int log_oom_internal(int level, const char *file, int line, const char *func) {
×
941
        return log_internal(level, ENOMEM, file, line, func, "Out of memory.");
×
942
}
943

944
int log_format_iovec(
69,939✔
945
                struct iovec *iovec,
946
                size_t iovec_len,
947
                size_t *n,
948
                bool newline_separator,
949
                int error,
950
                const char *format,
951
                va_list ap) {
952

953
        while (format && *n + 1 < iovec_len) {
394,439✔
954
                va_list aq;
324,500✔
955
                char *m;
324,500✔
956
                int r;
324,500✔
957

958
                /* We need to copy the va_list structure,
959
                 * since vasprintf() leaves it afterwards at
960
                 * an undefined location */
961

962
                errno = ERRNO_VALUE(error);
324,500✔
963

964
                va_copy(aq, ap);
324,500✔
965
                r = vasprintf(&m, format, aq);
324,500✔
966
                va_end(aq);
324,500✔
967
                if (r < 0)
324,500✔
UNCOV
968
                        return -EINVAL;
×
969

970
                /* Now, jump enough ahead, so that we point to
971
                 * the next format string */
972
                VA_FORMAT_ADVANCE(format, ap);
1,041,494✔
973

974
                iovec[(*n)++] = IOVEC_MAKE_STRING(m);
324,500✔
975
                if (newline_separator)
324,500✔
976
                        iovec[(*n)++] = IOVEC_MAKE_STRING("\n");
322,767✔
977

978
                format = va_arg(ap, char *);
324,500✔
979
        }
980
        return 0;
981
}
982

983
int log_struct_internal(
78,817✔
984
                int level,
985
                int error,
986
                const char *file,
987
                int line,
988
                const char *func,
989
                const char *format, ...) {
990

991
        char buf[LINE_MAX];
78,817✔
992
        bool found = false;
78,817✔
993
        PROTECT_ERRNO;
78,817✔
994
        va_list ap;
78,817✔
995

996
        if (_likely_(LOG_PRI(level) > log_max_level) ||
78,817✔
997
            log_target == LOG_TARGET_NULL)
78,817✔
998
                return -ERRNO_VALUE(error);
50✔
999

1000
        if (LOG_FAC(level) == 0)
78,767✔
1001
                level |= log_facility;
78,767✔
1002

1003
        if (IN_SET(log_target,
78,767✔
1004
                   LOG_TARGET_AUTO,
1005
                   LOG_TARGET_JOURNAL_OR_KMSG,
1006
                   LOG_TARGET_JOURNAL)) {
1007

1008
                if (open_when_needed)
76,859✔
1009
                        log_open_journal();
8,523✔
1010

1011
                if (journal_fd >= 0) {
76,859✔
1012
                        char header[LINE_MAX];
69,751✔
1013
                        struct iovec *iovec;
69,751✔
1014
                        size_t n = 0, m, iovec_len;
69,751✔
1015
                        int r;
69,751✔
1016
                        bool fallback = false;
69,751✔
1017

1018
                        iovec_len = MIN(17 + log_context_num_fields() * 3, IOVEC_MAX);
69,751✔
1019
                        iovec = newa(struct iovec, iovec_len);
69,751✔
1020

1021
                        /* If the journal is available do structured logging.
1022
                         * Do not report the errno if it is synthetic. */
1023
                        log_do_header(header, sizeof(header), level, error, file, line, func, NULL, NULL, NULL, NULL);
69,751✔
1024
                        iovec[n++] = IOVEC_MAKE_STRING(header);
69,751✔
1025

1026
                        va_start(ap, format);
69,751✔
1027
                        DISABLE_WARNING_FORMAT_NONLITERAL;
69,751✔
1028
                        r = log_format_iovec(iovec, iovec_len, &n, true, error, format, ap);
69,751✔
1029
                        REENABLE_WARNING;
69,751✔
1030
                        m = n;
69,751✔
1031
                        if (r < 0)
69,751✔
1032
                                fallback = true;
1033
                        else {
1034
                                log_do_context(iovec, iovec_len, &n);
69,751✔
1035

1036
                                const struct msghdr msghdr = {
69,751✔
1037
                                        .msg_iov = iovec,
1038
                                        .msg_iovlen = n,
1039
                                };
1040

1041
                                (void) sendmsg(journal_fd, &msghdr, MSG_NOSIGNAL);
69,751✔
1042
                        }
1043

1044
                        va_end(ap);
69,751✔
1045
                        for (size_t i = 1; i < m; i += 2)
392,513✔
1046
                                free(iovec[i].iov_base);
322,762✔
1047

1048
                        if (!fallback) {
69,751✔
1049
                                if (open_when_needed)
69,751✔
1050
                                        log_close();
8,510✔
1051

1052
                                return -ERRNO_VALUE(error);
69,751✔
1053
                        }
1054
                }
1055
        }
1056

1057
        /* Fallback if journal logging is not available or didn't work. */
1058

1059
        va_start(ap, format);
9,016✔
1060
        while (format) {
27,311✔
1061
                va_list aq;
27,311✔
1062

1063
                errno = ERRNO_VALUE(error);
27,311✔
1064

1065
                va_copy(aq, ap);
27,311✔
1066
                DISABLE_WARNING_FORMAT_NONLITERAL;
27,311✔
1067
                (void) vsnprintf(buf, sizeof buf, format, aq);
27,311✔
1068
                REENABLE_WARNING;
27,311✔
1069
                va_end(aq);
27,311✔
1070

1071
                if (startswith(buf, "MESSAGE=")) {
27,311✔
1072
                        found = true;
9,016✔
1073
                        break;
9,016✔
1074
                }
1075

1076
                VA_FORMAT_ADVANCE(format, ap);
49,356✔
1077

1078
                format = va_arg(ap, char *);
18,295✔
1079
        }
1080
        va_end(ap);
9,016✔
1081

1082
        if (!found) {
9,016✔
UNCOV
1083
                if (open_when_needed)
×
UNCOV
1084
                        log_close();
×
1085

1086
                return -ERRNO_VALUE(error);
×
1087
        }
1088

1089
        return log_dispatch_internal(level, error, file, line, func, NULL, NULL, NULL, NULL, buf + 8);
9,016✔
1090
}
1091

1092
int log_struct_iovec_internal(
2,211✔
1093
                int level,
1094
                int error,
1095
                const char *file,
1096
                int line,
1097
                const char *func,
1098
                const struct iovec input_iovec[],
1099
                size_t n_input_iovec) {
1100

1101
        PROTECT_ERRNO;
2,211✔
1102

1103
        if (_likely_(LOG_PRI(level) > log_max_level) ||
2,211✔
1104
            log_target == LOG_TARGET_NULL)
2,211✔
UNCOV
1105
                return -ERRNO_VALUE(error);
×
1106

1107
        if (LOG_FAC(level) == 0)
2,211✔
1108
                level |= log_facility;
2,211✔
1109

1110
        if (IN_SET(log_target, LOG_TARGET_AUTO,
2,211✔
1111
                               LOG_TARGET_JOURNAL_OR_KMSG,
1112
                               LOG_TARGET_JOURNAL) &&
2,211✔
1113
            journal_fd >= 0) {
2,211✔
1114

1115
                char header[LINE_MAX];
2,205✔
1116
                struct iovec *iovec;
2,205✔
1117
                size_t n = 0, iovec_len;
2,205✔
1118

1119
                iovec_len = MIN(1 + n_input_iovec * 2 + log_context_num_fields() * 3, IOVEC_MAX);
2,205✔
1120
                iovec = newa(struct iovec, iovec_len);
2,205✔
1121

1122
                log_do_header(header, sizeof(header), level, error, file, line, func, NULL, NULL, NULL, NULL);
2,205✔
1123

1124
                iovec[n++] = IOVEC_MAKE_STRING(header);
2,205✔
1125
                for (size_t i = 0; i < n_input_iovec; i++) {
17,588✔
1126
                        iovec[n++] = input_iovec[i];
15,383✔
1127
                        iovec[n++] = IOVEC_MAKE_STRING("\n");
15,383✔
1128
                }
1129

1130
                log_do_context(iovec, iovec_len, &n);
2,205✔
1131

1132
                const struct msghdr msghdr = {
2,205✔
1133
                        .msg_iov = iovec,
1134
                        .msg_iovlen = n,
1135
                };
1136

1137
                if (sendmsg(journal_fd, &msghdr, MSG_NOSIGNAL) >= 0)
2,205✔
1138
                        return -ERRNO_VALUE(error);
2,202✔
1139
        }
1140

1141
        for (size_t i = 0; i < n_input_iovec; i++)
36✔
1142
                if (memory_startswith(input_iovec[i].iov_base, input_iovec[i].iov_len, "MESSAGE=")) {
36✔
1143
                        char *m;
9✔
1144

1145
                        m = strndupa_safe((char*) input_iovec[i].iov_base + STRLEN("MESSAGE="),
9✔
1146
                                          input_iovec[i].iov_len - STRLEN("MESSAGE="));
1147

1148
                        return log_dispatch_internal(level, error, file, line, func, NULL, NULL, NULL, NULL, m);
9✔
1149
                }
1150

1151
        /* Couldn't find MESSAGE=. */
UNCOV
1152
        return -ERRNO_VALUE(error);
×
1153
}
1154

1155
int log_set_target_from_string(const char *e) {
10,779✔
1156
        LogTarget t;
10,779✔
1157

1158
        t = log_target_from_string(e);
10,779✔
1159
        if (t < 0)
10,779✔
1160
                return t;
1161

1162
        log_set_target(t);
10,777✔
1163
        return 0;
10,777✔
1164
}
1165

1166
int log_set_max_level_from_string(const char *e) {
24,429✔
1167
        int r;
66,209✔
1168

1169
        for (;;) {
66,209✔
1170
                _cleanup_free_ char *word = NULL, *prefix = NULL;
66,209✔
1171
                LogTarget target;
66,209✔
1172
                const char *colon;
66,209✔
1173

1174
                r = extract_first_word(&e, &word, ",", 0);
66,209✔
1175
                if (r < 0)
66,209✔
1176
                        return r;
1177
                if (r == 0)
66,209✔
1178
                        break;
1179

1180
                colon = strchr(word, ':');
41,780✔
1181
                if (!colon) {
41,780✔
1182
                        r = log_level_from_string(word);
24,427✔
1183
                        if (r < 0)
24,427✔
1184
                                return r;
1185

1186
                        log_set_max_level(r);
24,427✔
1187
                        continue;
24,427✔
1188
                }
1189

1190
                prefix = strndup(word, colon - word);
17,353✔
1191
                if (!prefix)
17,353✔
1192
                        return -ENOMEM;
1193

1194
                target = log_target_from_string(prefix);
17,353✔
1195
                if (target < 0)
17,353✔
1196
                        return target;
1197

1198
                if (target >= _LOG_TARGET_SINGLE_MAX)
17,353✔
1199
                        return -EINVAL;
1200

1201
                r = log_level_from_string(colon + 1);
17,353✔
1202
                if (r < 0)
17,353✔
1203
                        return r;
1204

1205
                log_target_max_level[target] = r;
17,353✔
1206
        }
1207

1208
        return 0;
24,429✔
1209
}
1210

1211
int log_max_levels_to_string(int level, char **ret) {
2,498✔
1212
        _cleanup_free_ char *s = NULL;
2,498✔
1213
        int r;
2,498✔
1214

1215
        assert(ret);
2,498✔
1216

1217
        r = log_level_to_string_alloc(level, &s);
2,498✔
1218
        if (r < 0)
2,498✔
1219
                return r;
1220

1221
        for (LogTarget target = 0; target < _LOG_TARGET_SINGLE_MAX; target++) {
12,490✔
1222
                _cleanup_free_ char *l = NULL;
2,498✔
1223

1224
                if (log_target_max_level[target] == INT_MAX)
9,992✔
1225
                        continue;
7,494✔
1226

1227
                r = log_level_to_string_alloc(log_target_max_level[target], &l);
2,498✔
1228
                if (r < 0)
2,498✔
1229
                        return r;
1230

1231
                r = strextendf_with_separator(&s, ",", "%s:%s", log_target_to_string(target), l);
2,498✔
1232
                if (r < 0)
2,498✔
1233
                        return r;
1234
        }
1235

1236
        *ret = TAKE_PTR(s);
2,498✔
1237
        return 0;
2,498✔
1238
}
1239

1240
static int log_set_ratelimit_kmsg_from_string(const char *e) {
7,271✔
1241
        int r;
7,271✔
1242

1243
        r = parse_boolean(e);
7,271✔
1244
        if (r < 0)
7,271✔
1245
                return r;
1246

1247
        ratelimit_kmsg = r;
7,271✔
1248
        return 0;
7,271✔
1249
}
1250

1251
static int parse_proc_cmdline_item(const char *key, const char *value, void *data) {
262,184✔
1252

1253
        /*
1254
         * The systemd.log_xyz= settings are parsed by all tools, and
1255
         * so is "debug".
1256
         *
1257
         * However, "quiet" is only parsed by PID 1, and only turns of
1258
         * status output to /dev/console, but does not alter the log
1259
         * level.
1260
         */
1261

1262
        if (streq(key, "debug") && !value)
262,184✔
UNCOV
1263
                log_set_max_level(LOG_DEBUG);
×
1264

1265
        else if (proc_cmdline_key_streq(key, "systemd.log_target")) {
262,184✔
1266

UNCOV
1267
                if (proc_cmdline_value_missing(key, value))
×
1268
                        return 0;
1269

UNCOV
1270
                if (log_set_target_from_string(value) < 0)
×
UNCOV
1271
                        log_warning("Failed to parse log target '%s', ignoring.", value);
×
1272

1273
        } else if (proc_cmdline_key_streq(key, "systemd.log_level")) {
262,184✔
1274

1275
                if (proc_cmdline_value_missing(key, value))
7,271✔
1276
                        return 0;
1277

1278
                if (log_set_max_level_from_string(value) < 0)
7,271✔
UNCOV
1279
                        log_warning("Failed to parse log level setting '%s', ignoring.", value);
×
1280

1281
        } else if (proc_cmdline_key_streq(key, "systemd.log_color")) {
254,913✔
1282

UNCOV
1283
                if (log_show_color_from_string(value ?: "1") < 0)
×
UNCOV
1284
                        log_warning("Failed to parse log color setting '%s', ignoring.", value);
×
1285

1286
        } else if (proc_cmdline_key_streq(key, "systemd.log_location")) {
254,913✔
1287

UNCOV
1288
                if (log_show_location_from_string(value ?: "1") < 0)
×
UNCOV
1289
                        log_warning("Failed to parse log location setting '%s', ignoring.", value);
×
1290

1291
        } else if (proc_cmdline_key_streq(key, "systemd.log_tid")) {
254,913✔
1292

UNCOV
1293
                if (log_show_tid_from_string(value ?: "1") < 0)
×
UNCOV
1294
                        log_warning("Failed to parse log tid setting '%s', ignoring.", value);
×
1295

1296
        } else if (proc_cmdline_key_streq(key, "systemd.log_time")) {
254,913✔
1297

UNCOV
1298
                if (log_show_time_from_string(value ?: "1") < 0)
×
UNCOV
1299
                        log_warning("Failed to parse log time setting '%s', ignoring.", value);
×
1300

1301
        } else if (proc_cmdline_key_streq(key, "systemd.log_ratelimit_kmsg")) {
254,913✔
1302

1303
                if (log_set_ratelimit_kmsg_from_string(value ?: "1") < 0)
7,271✔
UNCOV
1304
                        log_warning("Failed to parse log ratelimit kmsg boolean '%s', ignoring.", value);
×
1305
        }
1306

1307
        return 0;
1308
}
1309

1310
static bool should_parse_proc_cmdline(void) {
70,092✔
1311
        /* PID1 always reads the kernel command line. */
1312
        if (getpid_cached() == 1)
70,092✔
1313
                return true;
1314

1315
        /* Otherwise, parse the command line if invoked directly by systemd. */
1316
        return invoked_by_systemd();
69,986✔
1317
}
1318

1319
void log_parse_environment_variables(void) {
72,554✔
1320
        const char *e;
72,554✔
1321
        int r;
72,554✔
1322

1323
        e = getenv("SYSTEMD_LOG_TARGET");
72,554✔
1324
        if (e && log_set_target_from_string(e) < 0)
72,554✔
1325
                log_warning("Failed to parse log target '%s', ignoring.", e);
2✔
1326

1327
        e = getenv("SYSTEMD_LOG_LEVEL");
72,554✔
1328
        if (e) {
72,554✔
1329
                r = log_set_max_level_from_string(e);
7,076✔
1330
                if (r < 0)
7,076✔
UNCOV
1331
                        log_warning_errno(r, "Failed to parse log level '%s', ignoring: %m", e);
×
1332
        } else {
1333
                /* If no explicit log level is specified then let's see if this is a debug invocation, and if
1334
                 * so raise the log level to debug too. Note that this is not symmetric: just because
1335
                 * DEBUG_INVOCATION is explicitly set to 0 we won't lower the log level below debug. This
1336
                 * follows the logic that debug logging is an opt-in thing anyway, and if there's any reason
1337
                 * to enable it we should not disable it here automatically. */
1338
                r = getenv_bool("DEBUG_INVOCATION");
65,478✔
1339
                if (r < 0 && r != -ENXIO)
65,478✔
UNCOV
1340
                        log_warning_errno(r, "Failed to parse $DEBUG_INVOCATION value, ignoring: %m");
×
1341
                else if (r > 0)
65,478✔
1342
                        log_set_max_level(LOG_DEBUG);
×
1343
        }
1344

1345
        e = getenv("SYSTEMD_LOG_COLOR");
72,554✔
1346
        if (e && log_show_color_from_string(e) < 0)
72,554✔
UNCOV
1347
                log_warning("Failed to parse log color '%s', ignoring.", e);
×
1348

1349
        e = getenv("SYSTEMD_LOG_LOCATION");
72,554✔
1350
        if (e && log_show_location_from_string(e) < 0)
72,554✔
UNCOV
1351
                log_warning("Failed to parse log location '%s', ignoring.", e);
×
1352

1353
        e = getenv("SYSTEMD_LOG_TIME");
72,554✔
1354
        if (e && log_show_time_from_string(e) < 0)
72,554✔
UNCOV
1355
                log_warning("Failed to parse log time '%s', ignoring.", e);
×
1356

1357
        e = getenv("SYSTEMD_LOG_TID");
72,554✔
1358
        if (e && log_show_tid_from_string(e) < 0)
72,554✔
UNCOV
1359
                log_warning("Failed to parse log tid '%s', ignoring.", e);
×
1360

1361
        e = getenv("SYSTEMD_LOG_RATELIMIT_KMSG");
72,554✔
1362
        if (e && log_set_ratelimit_kmsg_from_string(e) < 0)
72,554✔
UNCOV
1363
                log_warning("Failed to parse log ratelimit kmsg boolean '%s', ignoring.", e);
×
1364
}
72,554✔
1365

1366
void log_parse_environment(void) {
70,092✔
1367
        /* Do not call from library code. */
1368

1369
        if (should_parse_proc_cmdline())
70,092✔
1370
                (void) proc_cmdline_parse(parse_proc_cmdline_item, NULL, PROC_CMDLINE_STRIP_RD_PREFIX);
7,347✔
1371

1372
        log_parse_environment_variables();
70,092✔
1373
}
70,092✔
1374

1375
LogTarget log_get_target(void) {
19,126✔
1376
        return log_target;
19,126✔
1377
}
1378

1379
void log_settle_target(void) {
16,933✔
1380

1381
        /* If we're using LOG_TARGET_AUTO and opening the log again on every single log call, we'll check if
1382
         * stderr is attached to the journal every single log call. However, if we then close all file
1383
         * descriptors later, that will stop working because stderr will be closed as well. To avoid that
1384
         * problem, this function is used to permanently change the log target depending on whether stderr is
1385
         * connected to the journal or not. */
1386

1387
        LogTarget t = log_get_target();
16,933✔
1388

1389
        if (t != LOG_TARGET_AUTO)
16,933✔
1390
                return;
1391

1392
        t = getpid_cached() == 1 || stderr_is_journal() ? (prohibit_ipc ? LOG_TARGET_KMSG : LOG_TARGET_JOURNAL_OR_KMSG)
21,693✔
1393
                                                        : LOG_TARGET_CONSOLE;
14,404✔
1394
        log_set_target(t);
7,289✔
1395
}
1396

1397
int log_get_max_level(void) {
18,034,039✔
1398
        return log_max_level;
18,034,039✔
1399
}
1400

1401
int log_get_target_max_level(LogTarget target) {
8✔
1402
        assert(target >= 0);
8✔
1403
        assert(target < _LOG_TARGET_SINGLE_MAX);
8✔
1404
        return log_target_max_level[target];
8✔
1405
}
1406

1407
void log_show_color(bool b) {
60,944✔
1408
        show_color = b;
60,944✔
1409
}
60,944✔
1410

1411
bool log_get_show_color(void) {
217,329✔
1412
        return show_color > 0; /* Defaults to false. */
217,329✔
1413
}
1414

UNCOV
1415
void log_show_location(bool b) {
×
UNCOV
1416
        show_location = b;
×
1417
}
×
1418

1419
bool log_get_show_location(void) {
15✔
1420
        return show_location;
15✔
1421
}
1422

1423
void log_show_time(bool b) {
1✔
1424
        show_time = b;
1✔
1425
}
1✔
1426

1427
bool log_get_show_time(void) {
15✔
1428
        return show_time;
15✔
1429
}
1430

1431
void log_show_tid(bool b) {
1✔
1432
        show_tid = b;
1✔
1433
}
1✔
1434

UNCOV
1435
bool log_get_show_tid(void) {
×
UNCOV
1436
        return show_tid;
×
1437
}
1438

UNCOV
1439
int log_show_color_from_string(const char *e) {
×
UNCOV
1440
        int r;
×
1441

1442
        r = parse_boolean(e);
×
UNCOV
1443
        if (r < 0)
×
1444
                return r;
1445

UNCOV
1446
        log_show_color(r);
×
UNCOV
1447
        return 0;
×
1448
}
1449

UNCOV
1450
int log_show_location_from_string(const char *e) {
×
UNCOV
1451
        int r;
×
1452

1453
        r = parse_boolean(e);
×
UNCOV
1454
        if (r < 0)
×
1455
                return r;
1456

UNCOV
1457
        log_show_location(r);
×
UNCOV
1458
        return 0;
×
1459
}
1460

UNCOV
1461
int log_show_time_from_string(const char *e) {
×
UNCOV
1462
        int r;
×
1463

1464
        r = parse_boolean(e);
×
UNCOV
1465
        if (r < 0)
×
1466
                return r;
1467

UNCOV
1468
        log_show_time(r);
×
UNCOV
1469
        return 0;
×
1470
}
1471

UNCOV
1472
int log_show_tid_from_string(const char *e) {
×
UNCOV
1473
        int r;
×
1474

1475
        r = parse_boolean(e);
×
UNCOV
1476
        if (r < 0)
×
1477
                return r;
1478

UNCOV
1479
        log_show_tid(r);
×
UNCOV
1480
        return 0;
×
1481
}
1482

1483
bool log_on_console(void) {
88,766✔
1484
        if (IN_SET(log_target, LOG_TARGET_CONSOLE,
88,766✔
1485
                               LOG_TARGET_CONSOLE_PREFIXED))
1486
                return true;
1487

1488
        return syslog_fd < 0 && kmsg_fd < 0 && journal_fd < 0;
115,047✔
1489
}
1490

1491
static const char *const log_target_table[_LOG_TARGET_MAX] = {
1492
        [LOG_TARGET_CONSOLE]          = "console",
1493
        [LOG_TARGET_CONSOLE_PREFIXED] = "console-prefixed",
1494
        [LOG_TARGET_KMSG]             = "kmsg",
1495
        [LOG_TARGET_JOURNAL]          = "journal",
1496
        [LOG_TARGET_JOURNAL_OR_KMSG]  = "journal-or-kmsg",
1497
        [LOG_TARGET_SYSLOG]           = "syslog",
1498
        [LOG_TARGET_SYSLOG_OR_KMSG]   = "syslog-or-kmsg",
1499
        [LOG_TARGET_AUTO]             = "auto",
1500
        [LOG_TARGET_NULL]             = "null",
1501
};
1502

1503
DEFINE_STRING_TABLE_LOOKUP(log_target, LogTarget);
33,222✔
1504

1505
void log_received_signal(int level, const struct signalfd_siginfo *si) {
4,455✔
1506
        assert(si);
4,455✔
1507

1508
        if (si_code_from_process(si->ssi_code) && pid_is_valid(si->ssi_pid)) {
4,673✔
1509
                _cleanup_free_ char *p = NULL;
218✔
1510

1511
                (void) pid_get_comm(si->ssi_pid, &p);
218✔
1512

1513
                log_full(level,
218✔
1514
                         "Received SIG%s from PID %"PRIu32" (%s).",
1515
                         signal_to_string(si->ssi_signo),
1516
                         si->ssi_pid, strna(p));
1517
        } else
1518
                log_full(level,
4,237✔
1519
                         "Received SIG%s.",
1520
                         signal_to_string(si->ssi_signo));
1521
}
4,455✔
1522

1523
void set_log_syntax_callback(log_syntax_callback_t cb, void *userdata) {
912✔
1524
        assert(!log_syntax_callback || !cb);
912✔
1525
        assert(!log_syntax_callback_userdata || !userdata);
912✔
1526

1527
        log_syntax_callback = cb;
912✔
1528
        log_syntax_callback_userdata = userdata;
912✔
1529
}
912✔
1530

1531
int log_syntax_internal(
17,602✔
1532
                const char *unit,
1533
                int level,
1534
                const char *config_file,
1535
                unsigned config_line,
1536
                int error,
1537
                const char *file,
1538
                int line,
1539
                const char *func,
1540
                const char *format, ...) {
1541

1542
        PROTECT_ERRNO;
17,602✔
1543

1544
        if (log_syntax_callback)
17,602✔
1545
                log_syntax_callback(unit, level, log_syntax_callback_userdata);
1,518✔
1546

1547
        if (_likely_(LOG_PRI(level) > log_max_level) ||
17,602✔
1548
            log_target == LOG_TARGET_NULL)
17,602✔
1549
                return -ERRNO_VALUE(error);
30✔
1550

1551
        char buffer[LINE_MAX];
17,572✔
1552
        va_list ap;
17,572✔
1553
        const char *unit_fmt = NULL;
17,572✔
1554

1555
        errno = ERRNO_VALUE(error);
17,572✔
1556

1557
        va_start(ap, format);
17,572✔
1558
        (void) vsnprintf(buffer, sizeof buffer, format, ap);
17,572✔
1559
        va_end(ap);
17,572✔
1560

1561
        if (unit)
17,572✔
1562
                unit_fmt = getpid_cached() == 1 ? "UNIT=%s" : "USER_UNIT=%s";
9,931✔
1563

1564
        if (config_file) {
17,572✔
1565
                if (config_line > 0)
17,562✔
1566
                        return log_struct_internal(
10,984✔
1567
                                        level,
1568
                                        error,
1569
                                        file, line, func,
1570
                                        LOG_MESSAGE_ID(SD_MESSAGE_INVALID_CONFIGURATION_STR),
10,984✔
1571
                                        LOG_ITEM("CONFIG_FILE=%s", config_file),
10,984✔
1572
                                        LOG_ITEM("CONFIG_LINE=%u", config_line),
10,984✔
1573
                                        LOG_MESSAGE("%s:%u: %s", config_file, config_line, buffer),
10,984✔
1574
                                        unit_fmt, unit,
1575
                                        NULL);
1576
                else
1577
                        return log_struct_internal(
6,578✔
1578
                                        level,
1579
                                        error,
1580
                                        file, line, func,
1581
                                        LOG_MESSAGE_ID(SD_MESSAGE_INVALID_CONFIGURATION_STR),
6,578✔
1582
                                        LOG_ITEM("CONFIG_FILE=%s", config_file),
6,578✔
1583
                                        LOG_MESSAGE("%s: %s", config_file, buffer),
6,578✔
1584
                                        unit_fmt, unit,
1585
                                        NULL);
1586
        } else if (unit)
10✔
UNCOV
1587
                return log_struct_internal(
×
1588
                                level,
1589
                                error,
1590
                                file, line, func,
UNCOV
1591
                                LOG_MESSAGE_ID(SD_MESSAGE_INVALID_CONFIGURATION_STR),
×
UNCOV
1592
                                LOG_MESSAGE("%s: %s", unit, buffer),
×
1593
                                unit_fmt, unit,
1594
                                NULL);
1595
        else
1596
                return log_struct_internal(
10✔
1597
                                level,
1598
                                error,
1599
                                file, line, func,
1600
                                LOG_MESSAGE_ID(SD_MESSAGE_INVALID_CONFIGURATION_STR),
10✔
1601
                                LOG_MESSAGE("%s", buffer),
10✔
1602
                                NULL);
1603
}
1604

1605
int log_syntax_invalid_utf8_internal(
1✔
1606
                const char *unit,
1607
                int level,
1608
                const char *config_file,
1609
                unsigned config_line,
1610
                const char *file,
1611
                int line,
1612
                const char *func,
1613
                const char *rvalue) {
1614

UNCOV
1615
        PROTECT_ERRNO;
×
1616
        _cleanup_free_ char *p = NULL;
1✔
1617

1618
        if (rvalue)
1✔
1619
                p = utf8_escape_invalid(rvalue);
1✔
1620

1621
        return log_syntax_internal(unit, level, config_file, config_line,
1✔
1622
                                   SYNTHETIC_ERRNO(EINVAL), file, line, func,
1623
                                   "String is not UTF-8 clean, ignoring assignment: %s", strna(p));
1624
}
1625

1626
int log_syntax_parse_error_internal(
128✔
1627
                const char *unit,
1628
                const char *config_file,
1629
                unsigned config_line,
1630
                int error,
1631
                bool critical,
1632
                const char *file,
1633
                int line,
1634
                const char *func,
1635
                const char *lvalue,
1636
                const char *rvalue) {
1637

UNCOV
1638
        PROTECT_ERRNO;
×
1639
        _cleanup_free_ char *escaped = NULL;
128✔
1640

1641
        /* OOM is always handled as critical. */
1642
        if (ERRNO_VALUE(error) == ENOMEM)
128✔
UNCOV
1643
                return log_oom_internal(LOG_ERR, file, line, func);
×
1644

1645
        if (rvalue && !utf8_is_valid(rvalue)) {
256✔
UNCOV
1646
                escaped = utf8_escape_invalid(rvalue);
×
UNCOV
1647
                if (!escaped)
×
1648
                        rvalue = "(oom)";
1649
                else
UNCOV
1650
                        rvalue = " (escaped)";
×
1651
        }
1652

1653
        log_syntax_internal(unit, critical ? LOG_ERR : LOG_WARNING, config_file, config_line, error,
640✔
1654
                            file, line, func,
1655
                            "Failed to parse %s=%s%s%s%s%s",
1656
                            strna(lvalue), strempty(escaped), strempty(rvalue),
1657
                            critical ? "" : ", ignoring",
1658
                            error == 0 ? "." : ": ",
1659
                            error == 0 ? "" : STRERROR(error));
128✔
1660

1661
        return critical ? -ERRNO_VALUE(error) : 0;
128✔
1662
}
1663

1664
void log_set_upgrade_syslog_to_journal(bool b) {
245✔
1665
        upgrade_syslog_to_journal = b;
245✔
1666

1667
        /* Make the change effective immediately */
1668
        if (b) {
245✔
1669
                if (log_target == LOG_TARGET_SYSLOG)
245✔
UNCOV
1670
                        log_target = LOG_TARGET_JOURNAL;
×
1671
                else if (log_target == LOG_TARGET_SYSLOG_OR_KMSG)
245✔
1672
                        log_target = LOG_TARGET_JOURNAL_OR_KMSG;
×
1673
        }
1674
}
245✔
1675

1676
void log_set_always_reopen_console(bool b) {
10,327✔
1677
        always_reopen_console = b;
10,327✔
1678
}
10,327✔
1679

1680
void log_set_open_when_needed(bool b) {
25,787✔
1681
        open_when_needed = b;
25,787✔
1682
}
25,787✔
1683

1684
void log_set_prohibit_ipc(bool b) {
34,125✔
1685
        prohibit_ipc = b;
34,125✔
1686
}
34,125✔
1687

UNCOV
1688
int log_emergency_level(void) {
×
1689
        /* Returns the log level to use for log_emergency() logging. We use LOG_EMERG only when we are PID 1, as only
1690
         * then the system of the whole system is obviously affected. */
1691

UNCOV
1692
        return getpid_cached() == 1 ? LOG_EMERG : LOG_ERR;
×
1693
}
1694

1695
int log_dup_console(void) {
114✔
1696
        int copy;
114✔
1697

1698
        /* Duplicate the fd we use for fd logging if it's < 3 and use the copy from now on. This call is useful
1699
         * whenever we want to continue logging through the original fd, but want to rearrange stderr. */
1700

1701
        if (console_fd < 0 || console_fd >= 3)
114✔
1702
                return 0;
1703

1704
        copy = fcntl(console_fd, F_DUPFD_CLOEXEC, 3);
1✔
1705
        if (copy < 0)
1✔
UNCOV
1706
                return -errno;
×
1707

1708
        console_fd = copy;
1✔
1709
        return 0;
1✔
1710
}
1711

1712
void log_setup(void) {
69,471✔
1713
        log_set_target(LOG_TARGET_AUTO);
69,471✔
1714
        log_parse_environment();
69,471✔
1715
        (void) log_open();
69,471✔
1716
        if (log_on_console() && show_color < 0)
69,471✔
1717
                log_show_color(true);
60,849✔
1718
}
69,471✔
1719

1720
const char* _log_set_prefix(const char *prefix, bool force) {
3,646,570✔
1721
        const char *old = log_prefix;
3,646,570✔
1722

1723
        if (prefix || force)
3,646,570✔
1724
                log_prefix = prefix;
3,644,696✔
1725

1726
        return old;
3,646,570✔
1727
}
STATUS · Troubleshooting · Open an Issue · Sales · Support · CAREERS · ENTERPRISE · START FREE · SCHEDULE DEMO
ANNOUNCEMENTS · TWITTER · TOS & SLA · Supported CI Services · What's a CI service? · Automated Testing

© 2026 Coveralls, Inc