1 /*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
4 This file is part of systemd.
6 Copyright 2010 Lennart Poettering
8 systemd is free software; you can redistribute it and/or modify it
9 under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 2 of the License, or
11 (at your option) any later version.
13 systemd is distributed in the hope that it will be useful, but
14 WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with systemd; If not, see <http://www.gnu.org/licenses/>.
27 #include <sys/socket.h>
34 #include "socket-util.h"
36 static LogTarget log_target = LOG_TARGET_CONSOLE;
37 static int log_max_level = LOG_INFO;
39 static int console_fd = STDERR_FILENO;
40 static int syslog_fd = -1;
41 static int kmsg_fd = -1;
42 static int journal_fd = -1;
44 static bool syslog_is_stream = false;
46 static bool show_color = false;
47 static bool show_location = false;
49 /* Akin to glibc's __abort_msg; which is private and we hence cannot
51 static char *log_abort_msg = NULL;
53 void log_close_console(void) {
60 close_nointr_nofail(console_fd);
66 static int log_open_console(void) {
73 console_fd = open_terminal("/dev/console", O_WRONLY|O_NOCTTY|O_CLOEXEC);
75 log_error("Failed to open /dev/console for logging: %s", strerror(-console_fd));
79 log_debug("Successfully opened /dev/console for logging.");
81 console_fd = STDERR_FILENO;
86 void log_close_kmsg(void) {
91 close_nointr_nofail(kmsg_fd);
95 static int log_open_kmsg(void) {
100 kmsg_fd = open("/dev/kmsg", O_WRONLY|O_NOCTTY|O_CLOEXEC);
102 log_error("Failed to open /dev/kmsg for logging: %s", strerror(errno));
106 log_debug("Successfully opened /dev/kmsg for logging.");
111 void log_close_syslog(void) {
116 close_nointr_nofail(syslog_fd);
120 static int create_log_socket(int type) {
123 /* All output to the syslog/journal fds we do asynchronously,
124 * and if the buffers are full we just drop the messages */
126 fd = socket(AF_UNIX, type|SOCK_CLOEXEC|SOCK_NONBLOCK, 0);
133 static int log_open_syslog(void) {
134 union sockaddr_union sa;
141 sa.un.sun_family = AF_UNIX;
142 strncpy(sa.un.sun_path, "/dev/log", sizeof(sa.un.sun_path));
144 syslog_fd = create_log_socket(SOCK_DGRAM);
150 if (connect(syslog_fd, &sa.sa, sizeof(sa)) < 0) {
151 close_nointr_nofail(syslog_fd);
153 /* Some legacy syslog systems still use stream
154 * sockets. They really shouldn't. But what can we
156 syslog_fd = create_log_socket(SOCK_STREAM);
162 if (connect(syslog_fd, &sa.sa, sizeof(sa)) < 0) {
167 syslog_is_stream = true;
169 syslog_is_stream = false;
171 log_debug("Successfully opened syslog for logging.");
177 log_debug("Failed to open syslog for logging: %s", strerror(-r));
181 void log_close_journal(void) {
186 close_nointr_nofail(journal_fd);
190 static int log_open_journal(void) {
191 union sockaddr_union sa;
197 journal_fd = create_log_socket(SOCK_DGRAM);
198 if (journal_fd < 0) {
204 sa.un.sun_family = AF_UNIX;
205 strncpy(sa.un.sun_path, "/run/systemd/journal/socket", sizeof(sa.un.sun_path));
207 if (connect(journal_fd, &sa.sa, offsetof(struct sockaddr_un, sun_path) + strlen(sa.un.sun_path)) < 0) {
212 log_debug("Successfully opened journal for logging.");
218 log_debug("Failed to open journal for logging: %s", strerror(-r));
225 /* If we don't use the console we close it here, to not get
226 * killed by SAK. If we don't use syslog we close it here so
227 * that we are not confused by somebody deleting the socket in
228 * the fs. If we don't use /dev/kmsg we still keep it open,
229 * because there is no reason to close it. */
231 if (log_target == LOG_TARGET_NULL) {
238 if (log_target != LOG_TARGET_AUTO ||
240 isatty(STDERR_FILENO) <= 0) {
242 if (log_target == LOG_TARGET_AUTO ||
243 log_target == LOG_TARGET_JOURNAL_OR_KMSG ||
244 log_target == LOG_TARGET_JOURNAL) {
245 r = log_open_journal();
253 if (log_target == LOG_TARGET_SYSLOG_OR_KMSG ||
254 log_target == LOG_TARGET_SYSLOG) {
255 r = log_open_syslog();
263 if (log_target == LOG_TARGET_AUTO ||
264 log_target == LOG_TARGET_JOURNAL_OR_KMSG ||
265 log_target == LOG_TARGET_SYSLOG_OR_KMSG ||
266 log_target == LOG_TARGET_KMSG) {
280 /* Get the real /dev/console if we are PID=1, hence reopen */
282 return log_open_console();
285 void log_set_target(LogTarget target) {
287 assert(target < _LOG_TARGET_MAX);
292 void log_close(void) {
299 void log_forget_fds(void) {
300 console_fd = kmsg_fd = syslog_fd = journal_fd = -1;
303 void log_set_max_level(int level) {
304 assert((level & LOG_PRIMASK) == level);
306 log_max_level = level;
309 static int write_to_console(
314 const char *buffer) {
317 struct iovec iovec[5];
324 highlight = LOG_PRI(level) <= LOG_ERR && show_color;
329 snprintf(location, sizeof(location), "(%s:%u) ", file, line);
330 char_array_0(location);
331 IOVEC_SET_STRING(iovec[n++], location);
335 IOVEC_SET_STRING(iovec[n++], ANSI_HIGHLIGHT_RED_ON);
336 IOVEC_SET_STRING(iovec[n++], buffer);
338 IOVEC_SET_STRING(iovec[n++], ANSI_HIGHLIGHT_OFF);
339 IOVEC_SET_STRING(iovec[n++], "\n");
341 if (writev(console_fd, iovec, n) < 0)
347 static int write_to_syslog(
352 const char *buffer) {
354 char header_priority[16], header_time[64], header_pid[16];
355 struct iovec iovec[5];
356 struct msghdr msghdr;
363 snprintf(header_priority, sizeof(header_priority), "<%i>", level);
364 char_array_0(header_priority);
366 t = (time_t) (now(CLOCK_REALTIME) / USEC_PER_SEC);
367 if (!(tm = localtime(&t)))
370 if (strftime(header_time, sizeof(header_time), "%h %e %T ", tm) <= 0)
373 snprintf(header_pid, sizeof(header_pid), "[%lu]: ", (unsigned long) getpid());
374 char_array_0(header_pid);
377 IOVEC_SET_STRING(iovec[0], header_priority);
378 IOVEC_SET_STRING(iovec[1], header_time);
379 IOVEC_SET_STRING(iovec[2], program_invocation_short_name);
380 IOVEC_SET_STRING(iovec[3], header_pid);
381 IOVEC_SET_STRING(iovec[4], buffer);
383 /* When using syslog via SOCK_STREAM separate the messages by NUL chars */
384 if (syslog_is_stream)
388 msghdr.msg_iov = iovec;
389 msghdr.msg_iovlen = ELEMENTSOF(iovec);
394 n = sendmsg(syslog_fd, &msghdr, MSG_NOSIGNAL);
398 if (!syslog_is_stream ||
399 (size_t) n >= IOVEC_TOTAL_SIZE(iovec, ELEMENTSOF(iovec)))
402 IOVEC_INCREMENT(iovec, ELEMENTSOF(iovec), n);
408 static int write_to_kmsg(
413 const char *buffer) {
415 char header_priority[16], header_pid[16];
416 struct iovec iovec[5];
421 snprintf(header_priority, sizeof(header_priority), "<%i>", level);
422 char_array_0(header_priority);
424 snprintf(header_pid, sizeof(header_pid), "[%lu]: ", (unsigned long) getpid());
425 char_array_0(header_pid);
428 IOVEC_SET_STRING(iovec[0], header_priority);
429 IOVEC_SET_STRING(iovec[1], program_invocation_short_name);
430 IOVEC_SET_STRING(iovec[2], header_pid);
431 IOVEC_SET_STRING(iovec[3], buffer);
432 IOVEC_SET_STRING(iovec[4], "\n");
434 if (writev(kmsg_fd, iovec, ELEMENTSOF(iovec)) < 0)
440 static int write_to_journal(
445 const char *buffer) {
447 char header[LINE_MAX];
448 struct iovec iovec[3];
454 snprintf(header, sizeof(header),
465 char_array_0(header);
468 IOVEC_SET_STRING(iovec[0], header);
469 IOVEC_SET_STRING(iovec[1], buffer);
470 IOVEC_SET_STRING(iovec[2], "\n");
474 mh.msg_iovlen = ELEMENTSOF(iovec);
476 if (sendmsg(journal_fd, &mh, MSG_NOSIGNAL) < 0)
482 static int log_dispatch(
491 if (log_target == LOG_TARGET_NULL)
494 /* Patch in LOG_DAEMON facility if necessary */
495 if ((level & LOG_FACMASK) == 0)
496 level = LOG_DAEMON | LOG_PRI(level);
502 buffer += strspn(buffer, NEWLINE);
507 if ((e = strpbrk(buffer, NEWLINE)))
510 if (log_target == LOG_TARGET_AUTO ||
511 log_target == LOG_TARGET_JOURNAL_OR_KMSG ||
512 log_target == LOG_TARGET_JOURNAL) {
514 k = write_to_journal(level, file, line, func, buffer);
523 if (log_target == LOG_TARGET_SYSLOG_OR_KMSG ||
524 log_target == LOG_TARGET_SYSLOG) {
526 k = write_to_syslog(level, file, line, func, buffer);
536 (log_target == LOG_TARGET_AUTO ||
537 log_target == LOG_TARGET_SYSLOG_OR_KMSG ||
538 log_target == LOG_TARGET_KMSG)) {
540 k = write_to_kmsg(level, file, line, func, buffer);
549 k = write_to_console(level, file, line, func, buffer);
560 int log_dump_internal(
569 /* This modifies the buffer... */
571 if (_likely_(LOG_PRI(level) > log_max_level))
575 r = log_dispatch(level, file, line, func, buffer);
586 const char *format, ...) {
588 char buffer[LINE_MAX];
592 if (_likely_(LOG_PRI(level) > log_max_level))
597 va_start(ap, format);
598 vsnprintf(buffer, sizeof(buffer), format, ap);
601 char_array_0(buffer);
603 r = log_dispatch(level, file, line, func, buffer);
609 #pragma GCC diagnostic push
610 #pragma GCC diagnostic ignored "-Wformat-nonliteral"
611 _noreturn_ static void log_assert(const char *text, const char *file, int line, const char *func, const char *format) {
612 static char buffer[LINE_MAX];
614 snprintf(buffer, sizeof(buffer), format, text, file, line, func);
616 char_array_0(buffer);
617 log_abort_msg = buffer;
619 log_dispatch(LOG_CRIT, file, line, func, buffer);
622 #pragma GCC diagnostic pop
624 void log_assert_failed(const char *text, const char *file, int line, const char *func) {
625 log_assert(text, file, line, func, "Assertion '%s' failed at %s:%u, function %s(). Aborting.");
628 void log_assert_failed_unreachable(const char *text, const char *file, int line, const char *func) {
629 log_assert(text, file, line, func, "Code should not be reached '%s' at %s:%u, function %s(). Aborting.");
632 int log_set_target_from_string(const char *e) {
635 t = log_target_from_string(e);
643 int log_set_max_level_from_string(const char *e) {
646 t = log_level_from_string(e);
650 log_set_max_level(t);
654 void log_parse_environment(void) {
657 if ((e = getenv("SYSTEMD_LOG_TARGET")))
658 if (log_set_target_from_string(e) < 0)
659 log_warning("Failed to parse log target %s. Ignoring.", e);
661 if ((e = getenv("SYSTEMD_LOG_LEVEL")))
662 if (log_set_max_level_from_string(e) < 0)
663 log_warning("Failed to parse log level %s. Ignoring.", e);
665 if ((e = getenv("SYSTEMD_LOG_COLOR")))
666 if (log_show_color_from_string(e) < 0)
667 log_warning("Failed to parse bool %s. Ignoring.", e);
669 if ((e = getenv("SYSTEMD_LOG_LOCATION")))
670 if (log_show_location_from_string(e) < 0)
671 log_warning("Failed to parse bool %s. Ignoring.", e);
674 LogTarget log_get_target(void) {
678 int log_get_max_level(void) {
679 return log_max_level;
682 void log_show_color(bool b) {
686 void log_show_location(bool b) {
690 int log_show_color_from_string(const char *e) {
693 t = parse_boolean(e);
701 int log_show_location_from_string(const char *e) {
704 t = parse_boolean(e);
708 log_show_location(t);
712 static const char *const log_target_table[] = {
713 [LOG_TARGET_CONSOLE] = "console",
714 [LOG_TARGET_KMSG] = "kmsg",
715 [LOG_TARGET_JOURNAL] = "journal",
716 [LOG_TARGET_JOURNAL_OR_KMSG] = "journal-or-kmsg",
717 [LOG_TARGET_SYSLOG] = "syslog",
718 [LOG_TARGET_SYSLOG_OR_KMSG] = "syslog-or-kmsg",
719 [LOG_TARGET_AUTO] = "auto",
720 [LOG_TARGET_NULL] = "null"
723 DEFINE_STRING_TABLE_LOOKUP(log_target, LogTarget);