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 Lesser General Public License as published by
10 the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.
18 You should have received a copy of the GNU Lesser General Public License
19 along with systemd; If not, see <http://www.gnu.org/licenses/>.
27 #include <sys/socket.h>
36 #include "socket-util.h"
38 #define SNDBUF_SIZE (8*1024*1024)
40 static LogTarget log_target = LOG_TARGET_CONSOLE;
41 static int log_max_level = LOG_INFO;
42 static int log_facility = LOG_DAEMON;
44 static int console_fd = STDERR_FILENO;
45 static int syslog_fd = -1;
46 static int kmsg_fd = -1;
47 static int journal_fd = -1;
49 static bool syslog_is_stream = false;
51 static bool show_color = false;
52 static bool show_location = false;
54 /* Akin to glibc's __abort_msg; which is private and we hence cannot
56 static char *log_abort_msg = NULL;
58 void log_close_console(void) {
65 close_nointr_nofail(console_fd);
71 static int log_open_console(void) {
77 console_fd = open_terminal("/dev/console", O_WRONLY|O_NOCTTY|O_CLOEXEC);
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);
107 void log_close_syslog(void) {
112 close_nointr_nofail(syslog_fd);
116 static int create_log_socket(int type) {
119 /* All output to the syslog/journal fds we do asynchronously,
120 * and if the buffers are full we just drop the messages */
122 fd = socket(AF_UNIX, type|SOCK_CLOEXEC|SOCK_NONBLOCK, 0);
126 fd_inc_sndbuf(fd, SNDBUF_SIZE);
131 static int log_open_syslog(void) {
132 union sockaddr_union sa;
139 sa.un.sun_family = AF_UNIX;
140 strncpy(sa.un.sun_path, "/dev/log", sizeof(sa.un.sun_path));
142 syslog_fd = create_log_socket(SOCK_DGRAM);
148 if (connect(syslog_fd, &sa.sa, offsetof(struct sockaddr_un, sun_path) + strlen(sa.un.sun_path)) < 0) {
149 close_nointr_nofail(syslog_fd);
151 /* Some legacy syslog systems still use stream
152 * sockets. They really shouldn't. But what can we
154 syslog_fd = create_log_socket(SOCK_STREAM);
160 if (connect(syslog_fd, &sa.sa, offsetof(struct sockaddr_un, sun_path) + strlen(sa.un.sun_path)) < 0) {
165 syslog_is_stream = true;
167 syslog_is_stream = false;
176 void log_close_journal(void) {
181 close_nointr_nofail(journal_fd);
185 static int log_open_journal(void) {
186 union sockaddr_union sa;
192 journal_fd = create_log_socket(SOCK_DGRAM);
193 if (journal_fd < 0) {
199 sa.un.sun_family = AF_UNIX;
200 strncpy(sa.un.sun_path, "/run/systemd/journal/socket", sizeof(sa.un.sun_path));
202 if (connect(journal_fd, &sa.sa, offsetof(struct sockaddr_un, sun_path) + strlen(sa.un.sun_path)) < 0) {
217 /* If we don't use the console we close it here, to not get
218 * killed by SAK. If we don't use syslog we close it here so
219 * that we are not confused by somebody deleting the socket in
220 * the fs. If we don't use /dev/kmsg we still keep it open,
221 * because there is no reason to close it. */
223 if (log_target == LOG_TARGET_NULL) {
230 if ((log_target != LOG_TARGET_AUTO && log_target != LOG_TARGET_SAFE) ||
232 isatty(STDERR_FILENO) <= 0) {
234 if (log_target == LOG_TARGET_AUTO ||
235 log_target == LOG_TARGET_JOURNAL_OR_KMSG ||
236 log_target == LOG_TARGET_JOURNAL) {
237 r = log_open_journal();
245 if (log_target == LOG_TARGET_SYSLOG_OR_KMSG ||
246 log_target == LOG_TARGET_SYSLOG) {
247 r = log_open_syslog();
255 if (log_target == LOG_TARGET_AUTO ||
256 log_target == LOG_TARGET_SAFE ||
257 log_target == LOG_TARGET_JOURNAL_OR_KMSG ||
258 log_target == LOG_TARGET_SYSLOG_OR_KMSG ||
259 log_target == LOG_TARGET_KMSG) {
273 /* Get the real /dev/console if we are PID=1, hence reopen */
275 return log_open_console();
278 void log_set_target(LogTarget target) {
280 assert(target < _LOG_TARGET_MAX);
285 void log_close(void) {
292 void log_forget_fds(void) {
293 console_fd = kmsg_fd = syslog_fd = journal_fd = -1;
296 void log_set_max_level(int level) {
297 assert((level & LOG_PRIMASK) == level);
299 log_max_level = level;
302 void log_set_facility(int facility) {
303 log_facility = facility;
306 static int write_to_console(
311 const char *object_name,
313 const char *buffer) {
316 struct iovec iovec[5];
323 highlight = LOG_PRI(level) <= LOG_ERR && show_color;
328 snprintf(location, sizeof(location), "(%s:%u) ", file, line);
329 char_array_0(location);
330 IOVEC_SET_STRING(iovec[n++], location);
334 IOVEC_SET_STRING(iovec[n++], ANSI_HIGHLIGHT_RED_ON);
335 IOVEC_SET_STRING(iovec[n++], buffer);
337 IOVEC_SET_STRING(iovec[n++], ANSI_HIGHLIGHT_OFF);
338 IOVEC_SET_STRING(iovec[n++], "\n");
340 if (writev(console_fd, iovec, n) < 0)
346 static int write_to_syslog(
351 const char *object_name,
353 const char *buffer) {
355 char header_priority[16], header_time[64], header_pid[16];
356 struct iovec iovec[5];
357 struct msghdr msghdr;
364 snprintf(header_priority, sizeof(header_priority), "<%i>", level);
365 char_array_0(header_priority);
367 t = (time_t) (now(CLOCK_REALTIME) / USEC_PER_SEC);
372 if (strftime(header_time, sizeof(header_time), "%h %e %T ", tm) <= 0)
375 snprintf(header_pid, sizeof(header_pid), "[%lu]: ", (unsigned long) getpid());
376 char_array_0(header_pid);
379 IOVEC_SET_STRING(iovec[0], header_priority);
380 IOVEC_SET_STRING(iovec[1], header_time);
381 IOVEC_SET_STRING(iovec[2], program_invocation_short_name);
382 IOVEC_SET_STRING(iovec[3], header_pid);
383 IOVEC_SET_STRING(iovec[4], buffer);
385 /* When using syslog via SOCK_STREAM separate the messages by NUL chars */
386 if (syslog_is_stream)
390 msghdr.msg_iov = iovec;
391 msghdr.msg_iovlen = ELEMENTSOF(iovec);
396 n = sendmsg(syslog_fd, &msghdr, MSG_NOSIGNAL);
400 if (!syslog_is_stream ||
401 (size_t) n >= IOVEC_TOTAL_SIZE(iovec, ELEMENTSOF(iovec)))
404 IOVEC_INCREMENT(iovec, ELEMENTSOF(iovec), n);
410 static int write_to_kmsg(
415 const char *object_name,
417 const char *buffer) {
419 char header_priority[16], header_pid[16];
420 struct iovec iovec[5];
425 snprintf(header_priority, sizeof(header_priority), "<%i>", level);
426 char_array_0(header_priority);
428 snprintf(header_pid, sizeof(header_pid), "[%lu]: ", (unsigned long) getpid());
429 char_array_0(header_pid);
432 IOVEC_SET_STRING(iovec[0], header_priority);
433 IOVEC_SET_STRING(iovec[1], program_invocation_short_name);
434 IOVEC_SET_STRING(iovec[2], header_pid);
435 IOVEC_SET_STRING(iovec[3], buffer);
436 IOVEC_SET_STRING(iovec[4], "\n");
438 if (writev(kmsg_fd, iovec, ELEMENTSOF(iovec)) < 0)
444 static int log_do_header(char *header, size_t size,
446 const char *file, int line, const char *func,
447 const char *object_name, const char *object) {
448 snprintf(header, size,
450 "SYSLOG_FACILITY=%i\n"
455 "SYSLOG_IDENTIFIER=%s\n",
461 object ? object_name : "",
462 object ? LINE_MAX : 0, object, /* %.0s means no output */
464 program_invocation_short_name);
465 header[size - 1] = '\0';
469 static int write_to_journal(
474 const char *object_name,
476 const char *buffer) {
478 char header[LINE_MAX];
479 struct iovec iovec[4] = {{0}};
480 struct msghdr mh = {0};
485 log_do_header(header, sizeof(header), level,
486 file, line, func, object_name, object);
488 IOVEC_SET_STRING(iovec[0], header);
489 IOVEC_SET_STRING(iovec[1], "MESSAGE=");
490 IOVEC_SET_STRING(iovec[2], buffer);
491 IOVEC_SET_STRING(iovec[3], "\n");
494 mh.msg_iovlen = ELEMENTSOF(iovec);
496 if (sendmsg(journal_fd, &mh, MSG_NOSIGNAL) < 0)
502 static int log_dispatch(
507 const char *object_name,
513 if (log_target == LOG_TARGET_NULL)
516 /* Patch in LOG_DAEMON facility if necessary */
517 if ((level & LOG_FACMASK) == 0)
518 level = log_facility | LOG_PRI(level);
524 buffer += strspn(buffer, NEWLINE);
529 if ((e = strpbrk(buffer, NEWLINE)))
532 if (log_target == LOG_TARGET_AUTO ||
533 log_target == LOG_TARGET_JOURNAL_OR_KMSG ||
534 log_target == LOG_TARGET_JOURNAL) {
536 k = write_to_journal(level, file, line, func,
537 object_name, object, buffer);
546 if (log_target == LOG_TARGET_SYSLOG_OR_KMSG ||
547 log_target == LOG_TARGET_SYSLOG) {
549 k = write_to_syslog(level, file, line, func,
550 object_name, object, buffer);
560 (log_target == LOG_TARGET_AUTO ||
561 log_target == LOG_TARGET_SAFE ||
562 log_target == LOG_TARGET_SYSLOG_OR_KMSG ||
563 log_target == LOG_TARGET_JOURNAL_OR_KMSG ||
564 log_target == LOG_TARGET_KMSG)) {
566 k = write_to_kmsg(level, file, line, func,
567 object_name, object, buffer);
576 k = write_to_console(level, file, line, func,
577 object_name, object, buffer);
588 int log_dump_internal(
597 /* This modifies the buffer... */
599 if (_likely_(LOG_PRI(level) > log_max_level))
603 r = log_dispatch(level, file, line, func, NULL, NULL, buffer);
617 char buffer[LINE_MAX];
620 if (_likely_(LOG_PRI(level) > log_max_level))
624 vsnprintf(buffer, sizeof(buffer), format, ap);
625 char_array_0(buffer);
627 r = log_dispatch(level, file, line, func, NULL, NULL, buffer);
638 const char *format, ...) {
643 va_start(ap, format);
644 r = log_metav(level, file, line, func, format, ap);
650 int log_metav_object(
655 const char *object_name,
660 char buffer[LINE_MAX];
663 if (_likely_(LOG_PRI(level) > log_max_level))
667 vsnprintf(buffer, sizeof(buffer), format, ap);
668 char_array_0(buffer);
670 r = log_dispatch(level, file, line, func,
671 object_name, object, buffer);
682 const char *object_name,
684 const char *format, ...) {
689 va_start(ap, format);
690 r = log_metav_object(level, file, line, func,
691 object_name, object, format, ap);
697 #pragma GCC diagnostic push
698 #pragma GCC diagnostic ignored "-Wformat-nonliteral"
699 _noreturn_ static void log_assert(const char *text, const char *file, int line, const char *func, const char *format) {
700 static char buffer[LINE_MAX];
702 snprintf(buffer, sizeof(buffer), format, text, file, line, func);
704 char_array_0(buffer);
705 log_abort_msg = buffer;
707 log_dispatch(LOG_CRIT, file, line, func, NULL, NULL, buffer);
710 #pragma GCC diagnostic pop
712 _noreturn_ void log_assert_failed(const char *text, const char *file, int line, const char *func) {
713 log_assert(text, file, line, func, "Assertion '%s' failed at %s:%u, function %s(). Aborting.");
716 _noreturn_ void log_assert_failed_unreachable(const char *text, const char *file, int line, const char *func) {
717 log_assert(text, file, line, func, "Code should not be reached '%s' at %s:%u, function %s(). Aborting.");
720 int log_oom_internal(const char *file, int line, const char *func) {
721 log_meta(LOG_ERR, file, line, func, "Out of memory.");
725 int log_struct_internal(
730 const char *format, ...) {
736 if (_likely_(LOG_PRI(level) > log_max_level))
739 if (log_target == LOG_TARGET_NULL)
742 if ((level & LOG_FACMASK) == 0)
743 level = log_facility | LOG_PRI(level);
747 if ((log_target == LOG_TARGET_AUTO ||
748 log_target == LOG_TARGET_JOURNAL_OR_KMSG ||
749 log_target == LOG_TARGET_JOURNAL) &&
752 char header[LINE_MAX];
753 struct iovec iovec[17] = {{0}};
756 static const char nl = '\n';
758 /* If the journal is available do structured logging */
759 log_do_header(header, sizeof(header), level,
760 file, line, func, NULL, NULL);
761 IOVEC_SET_STRING(iovec[n++], header);
763 va_start(ap, format);
764 while (format && n + 1 < ELEMENTSOF(iovec)) {
768 /* We need to copy the va_list structure,
769 * since vasprintf() leaves it afterwards at
770 * an undefined location */
773 if (vasprintf(&buf, format, aq) < 0) {
780 /* Now, jump enough ahead, so that we point to
781 * the next format string */
782 VA_FORMAT_ADVANCE(format, ap);
784 IOVEC_SET_STRING(iovec[n++], buf);
786 iovec[n].iov_base = (char*) &nl;
787 iovec[n].iov_len = 1;
790 format = va_arg(ap, char *);
797 if (sendmsg(journal_fd, &mh, MSG_NOSIGNAL) < 0)
804 for (i = 1; i < n; i += 2)
805 free(iovec[i].iov_base);
811 /* Fallback if journal logging is not available */
813 va_start(ap, format);
818 vsnprintf(buf, sizeof(buf), format, aq);
822 if (startswith(buf, "MESSAGE=")) {
827 VA_FORMAT_ADVANCE(format, ap);
829 format = va_arg(ap, char *);
834 r = log_dispatch(level, file, line, func,
835 NULL, NULL, buf + 8);
844 int log_set_target_from_string(const char *e) {
847 t = log_target_from_string(e);
855 int log_set_max_level_from_string(const char *e) {
858 t = log_level_from_string(e);
862 log_set_max_level(t);
866 void log_parse_environment(void) {
869 e = secure_getenv("SYSTEMD_LOG_TARGET");
870 if (e && log_set_target_from_string(e) < 0)
871 log_warning("Failed to parse log target %s. Ignoring.", e);
873 e = secure_getenv("SYSTEMD_LOG_LEVEL");
874 if (e && log_set_max_level_from_string(e) < 0)
875 log_warning("Failed to parse log level %s. Ignoring.", e);
877 e = secure_getenv("SYSTEMD_LOG_COLOR");
878 if (e && log_show_color_from_string(e) < 0)
879 log_warning("Failed to parse bool %s. Ignoring.", e);
881 e = secure_getenv("SYSTEMD_LOG_LOCATION");
882 if (e && log_show_location_from_string(e) < 0)
883 log_warning("Failed to parse bool %s. Ignoring.", e);
886 LogTarget log_get_target(void) {
890 int log_get_max_level(void) {
891 return log_max_level;
894 void log_show_color(bool b) {
898 void log_show_location(bool b) {
902 int log_show_color_from_string(const char *e) {
905 t = parse_boolean(e);
913 int log_show_location_from_string(const char *e) {
916 t = parse_boolean(e);
920 log_show_location(t);
924 bool log_on_console(void) {
925 if (log_target == LOG_TARGET_CONSOLE)
928 return syslog_fd < 0 && kmsg_fd < 0 && journal_fd < 0;
931 static const char *const log_target_table[] = {
932 [LOG_TARGET_CONSOLE] = "console",
933 [LOG_TARGET_KMSG] = "kmsg",
934 [LOG_TARGET_JOURNAL] = "journal",
935 [LOG_TARGET_JOURNAL_OR_KMSG] = "journal-or-kmsg",
936 [LOG_TARGET_SYSLOG] = "syslog",
937 [LOG_TARGET_SYSLOG_OR_KMSG] = "syslog-or-kmsg",
938 [LOG_TARGET_AUTO] = "auto",
939 [LOG_TARGET_SAFE] = "safe",
940 [LOG_TARGET_NULL] = "null"
943 DEFINE_STRING_TABLE_LOOKUP(log_target, LogTarget);