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 #define SOCKET_TIMEOUT_USEC (5*USEC_PER_SEC)
38 static LogTarget log_target
= LOG_TARGET_CONSOLE
;
39 static int log_max_level
= LOG_INFO
;
41 static int console_fd
= STDERR_FILENO
;
42 static int syslog_fd
= -1;
43 static int kmsg_fd
= -1;
44 static int journal_fd
= -1;
46 static bool syslog_is_stream
= false;
48 static bool show_color
= false;
49 static bool show_location
= false;
51 /* Akin to glibc's __abort_msg; which is private and we hence cannot
53 static char *log_abort_msg
= NULL
;
55 void log_close_console(void) {
62 close_nointr_nofail(console_fd
);
68 static int log_open_console(void) {
75 console_fd
= open_terminal("/dev/console", O_WRONLY
|O_NOCTTY
|O_CLOEXEC
);
77 log_error("Failed to open /dev/console for logging: %s", strerror(-console_fd
));
81 log_debug("Successfully opened /dev/console for logging.");
83 console_fd
= STDERR_FILENO
;
88 void log_close_kmsg(void) {
93 close_nointr_nofail(kmsg_fd
);
97 static int log_open_kmsg(void) {
102 kmsg_fd
= open("/dev/kmsg", O_WRONLY
|O_NOCTTY
|O_CLOEXEC
);
104 log_error("Failed to open /dev/kmsg for logging: %s", strerror(errno
));
108 log_debug("Successfully opened /dev/kmsg for logging.");
113 void log_close_syslog(void) {
118 close_nointr_nofail(syslog_fd
);
122 static int create_log_socket(int type
) {
127 /* systemd should not block on syslog */
128 type
|= SOCK_NONBLOCK
;
130 fd
= socket(AF_UNIX
, type
|SOCK_CLOEXEC
, 0);
134 /* Make sure we don't block for more than 5s when talking to
136 timeval_store(&tv
, SOCKET_TIMEOUT_USEC
);
137 if (setsockopt(fd
, SOL_SOCKET
, SO_SNDTIMEO
, &tv
, sizeof(tv
)) < 0) {
138 close_nointr_nofail(fd
);
145 static int log_open_syslog(void) {
146 union sockaddr_union sa
;
153 sa
.un
.sun_family
= AF_UNIX
;
154 strncpy(sa
.un
.sun_path
, "/dev/log", sizeof(sa
.un
.sun_path
));
156 syslog_fd
= create_log_socket(SOCK_DGRAM
);
162 if (connect(syslog_fd
, &sa
.sa
, sizeof(sa
)) < 0) {
163 close_nointr_nofail(syslog_fd
);
165 /* Some legacy syslog systems still use stream
166 * sockets. They really shouldn't. But what can we
168 syslog_fd
= create_log_socket(SOCK_STREAM
);
174 if (connect(syslog_fd
, &sa
.sa
, sizeof(sa
)) < 0) {
179 syslog_is_stream
= true;
181 syslog_is_stream
= false;
183 log_debug("Successfully opened syslog for logging.");
189 log_debug("Failed to open syslog for logging: %s", strerror(-r
));
193 void log_close_journal(void) {
198 close_nointr_nofail(journal_fd
);
202 static int log_open_journal(void) {
203 union sockaddr_union sa
;
209 journal_fd
= create_log_socket(SOCK_DGRAM
);
210 if (journal_fd
< 0) {
216 sa
.un
.sun_family
= AF_UNIX
;
217 strncpy(sa
.un
.sun_path
, "/run/systemd/journal/socket", sizeof(sa
.un
.sun_path
));
219 if (connect(journal_fd
, &sa
.sa
, offsetof(struct sockaddr_un
, sun_path
) + strlen(sa
.un
.sun_path
)) < 0) {
224 log_debug("Successfully opened journal for logging.");
230 log_debug("Failed to open journal for logging: %s", strerror(-r
));
237 /* If we don't use the console we close it here, to not get
238 * killed by SAK. If we don't use syslog we close it here so
239 * that we are not confused by somebody deleting the socket in
240 * the fs. If we don't use /dev/kmsg we still keep it open,
241 * because there is no reason to close it. */
243 if (log_target
== LOG_TARGET_NULL
) {
250 if (log_target
!= LOG_TARGET_AUTO
||
252 isatty(STDERR_FILENO
) <= 0) {
254 if (log_target
== LOG_TARGET_AUTO
||
255 log_target
== LOG_TARGET_JOURNAL_OR_KMSG
||
256 log_target
== LOG_TARGET_JOURNAL
) {
257 r
= log_open_journal();
265 if (log_target
== LOG_TARGET_SYSLOG_OR_KMSG
||
266 log_target
== LOG_TARGET_SYSLOG
) {
267 r
= log_open_syslog();
275 if (log_target
== LOG_TARGET_AUTO
||
276 log_target
== LOG_TARGET_JOURNAL_OR_KMSG
||
277 log_target
== LOG_TARGET_SYSLOG_OR_KMSG
||
278 log_target
== LOG_TARGET_KMSG
) {
292 /* Get the real /dev/console if we are PID=1, hence reopen */
294 return log_open_console();
297 void log_set_target(LogTarget target
) {
299 assert(target
< _LOG_TARGET_MAX
);
304 void log_close(void) {
311 void log_forget_fds(void) {
312 console_fd
= kmsg_fd
= syslog_fd
= journal_fd
= -1;
315 void log_set_max_level(int level
) {
316 assert((level
& LOG_PRIMASK
) == level
);
318 log_max_level
= level
;
321 static int write_to_console(
326 const char *buffer
) {
329 struct iovec iovec
[5];
336 highlight
= LOG_PRI(level
) <= LOG_ERR
&& show_color
;
341 snprintf(location
, sizeof(location
), "(%s:%u) ", file
, line
);
342 char_array_0(location
);
343 IOVEC_SET_STRING(iovec
[n
++], location
);
347 IOVEC_SET_STRING(iovec
[n
++], ANSI_HIGHLIGHT_RED_ON
);
348 IOVEC_SET_STRING(iovec
[n
++], buffer
);
350 IOVEC_SET_STRING(iovec
[n
++], ANSI_HIGHLIGHT_OFF
);
351 IOVEC_SET_STRING(iovec
[n
++], "\n");
353 if (writev(console_fd
, iovec
, n
) < 0)
359 static int write_to_syslog(
364 const char *buffer
) {
366 char header_priority
[16], header_time
[64], header_pid
[16];
367 struct iovec iovec
[5];
368 struct msghdr msghdr
;
375 snprintf(header_priority
, sizeof(header_priority
), "<%i>", level
);
376 char_array_0(header_priority
);
378 t
= (time_t) (now(CLOCK_REALTIME
) / USEC_PER_SEC
);
379 if (!(tm
= localtime(&t
)))
382 if (strftime(header_time
, sizeof(header_time
), "%h %e %T ", tm
) <= 0)
385 snprintf(header_pid
, sizeof(header_pid
), "[%lu]: ", (unsigned long) getpid());
386 char_array_0(header_pid
);
389 IOVEC_SET_STRING(iovec
[0], header_priority
);
390 IOVEC_SET_STRING(iovec
[1], header_time
);
391 IOVEC_SET_STRING(iovec
[2], program_invocation_short_name
);
392 IOVEC_SET_STRING(iovec
[3], header_pid
);
393 IOVEC_SET_STRING(iovec
[4], buffer
);
395 /* When using syslog via SOCK_STREAM separate the messages by NUL chars */
396 if (syslog_is_stream
)
400 msghdr
.msg_iov
= iovec
;
401 msghdr
.msg_iovlen
= ELEMENTSOF(iovec
);
406 n
= sendmsg(syslog_fd
, &msghdr
, MSG_NOSIGNAL
);
410 if (!syslog_is_stream
||
411 (size_t) n
>= IOVEC_TOTAL_SIZE(iovec
, ELEMENTSOF(iovec
)))
414 IOVEC_INCREMENT(iovec
, ELEMENTSOF(iovec
), n
);
420 static int write_to_kmsg(
425 const char *buffer
) {
427 char header_priority
[16], header_pid
[16];
428 struct iovec iovec
[5];
433 snprintf(header_priority
, sizeof(header_priority
), "<%i>", level
);
434 char_array_0(header_priority
);
436 snprintf(header_pid
, sizeof(header_pid
), "[%lu]: ", (unsigned long) getpid());
437 char_array_0(header_pid
);
440 IOVEC_SET_STRING(iovec
[0], header_priority
);
441 IOVEC_SET_STRING(iovec
[1], program_invocation_short_name
);
442 IOVEC_SET_STRING(iovec
[2], header_pid
);
443 IOVEC_SET_STRING(iovec
[3], buffer
);
444 IOVEC_SET_STRING(iovec
[4], "\n");
446 if (writev(kmsg_fd
, iovec
, ELEMENTSOF(iovec
)) < 0)
452 static int write_to_journal(
457 const char *buffer
) {
459 char header
[LINE_MAX
];
460 struct iovec iovec
[3];
466 snprintf(header
, sizeof(header
),
477 char_array_0(header
);
480 IOVEC_SET_STRING(iovec
[0], header
);
481 IOVEC_SET_STRING(iovec
[1], buffer
);
482 IOVEC_SET_STRING(iovec
[2], "\n");
486 mh
.msg_iovlen
= ELEMENTSOF(iovec
);
488 if (sendmsg(journal_fd
, &mh
, MSG_NOSIGNAL
) < 0)
494 static int log_dispatch(
503 if (log_target
== LOG_TARGET_NULL
)
506 /* Patch in LOG_DAEMON facility if necessary */
507 if ((level
& LOG_FACMASK
) == 0)
508 level
= LOG_DAEMON
| LOG_PRI(level
);
514 buffer
+= strspn(buffer
, NEWLINE
);
519 if ((e
= strpbrk(buffer
, NEWLINE
)))
522 if (log_target
== LOG_TARGET_AUTO
||
523 log_target
== LOG_TARGET_JOURNAL_OR_KMSG
||
524 log_target
== LOG_TARGET_JOURNAL
) {
526 k
= write_to_journal(level
, file
, line
, func
, buffer
);
535 if (log_target
== LOG_TARGET_SYSLOG_OR_KMSG
||
536 log_target
== LOG_TARGET_SYSLOG
) {
538 k
= write_to_syslog(level
, file
, line
, func
, buffer
);
548 (log_target
== LOG_TARGET_AUTO
||
549 log_target
== LOG_TARGET_SYSLOG_OR_KMSG
||
550 log_target
== LOG_TARGET_KMSG
)) {
552 k
= write_to_kmsg(level
, file
, line
, func
, buffer
);
561 k
= write_to_console(level
, file
, line
, func
, buffer
);
572 int log_dump_internal(
581 /* This modifies the buffer... */
583 if (_likely_(LOG_PRI(level
) > log_max_level
))
587 r
= log_dispatch(level
, file
, line
, func
, buffer
);
598 const char *format
, ...) {
600 char buffer
[LINE_MAX
];
604 if (_likely_(LOG_PRI(level
) > log_max_level
))
609 va_start(ap
, format
);
610 vsnprintf(buffer
, sizeof(buffer
), format
, ap
);
613 char_array_0(buffer
);
615 r
= log_dispatch(level
, file
, line
, func
, buffer
);
625 const char *format
, ...) {
627 static char buffer
[LINE_MAX
];
628 int saved_errno
= errno
;
631 va_start(ap
, format
);
632 vsnprintf(buffer
, sizeof(buffer
), format
, ap
);
635 char_array_0(buffer
);
636 log_abort_msg
= buffer
;
638 log_dispatch(LOG_CRIT
, file
, line
, func
, buffer
);
641 /* If the user chose to ignore this SIGABRT, we are happy to go on, as if nothing happened. */
645 int log_set_target_from_string(const char *e
) {
648 t
= log_target_from_string(e
);
656 int log_set_max_level_from_string(const char *e
) {
659 t
= log_level_from_string(e
);
663 log_set_max_level(t
);
667 void log_parse_environment(void) {
670 if ((e
= getenv("SYSTEMD_LOG_TARGET")))
671 if (log_set_target_from_string(e
) < 0)
672 log_warning("Failed to parse log target %s. Ignoring.", e
);
674 if ((e
= getenv("SYSTEMD_LOG_LEVEL")))
675 if (log_set_max_level_from_string(e
) < 0)
676 log_warning("Failed to parse log level %s. Ignoring.", e
);
678 if ((e
= getenv("SYSTEMD_LOG_COLOR")))
679 if (log_show_color_from_string(e
) < 0)
680 log_warning("Failed to parse bool %s. Ignoring.", e
);
682 if ((e
= getenv("SYSTEMD_LOG_LOCATION")))
683 if (log_show_location_from_string(e
) < 0)
684 log_warning("Failed to parse bool %s. Ignoring.", e
);
687 LogTarget
log_get_target(void) {
691 int log_get_max_level(void) {
692 return log_max_level
;
695 void log_show_color(bool b
) {
699 void log_show_location(bool b
) {
703 int log_show_color_from_string(const char *e
) {
706 t
= parse_boolean(e
);
714 int log_show_location_from_string(const char *e
) {
717 t
= parse_boolean(e
);
721 log_show_location(t
);
725 static const char *const log_target_table
[] = {
726 [LOG_TARGET_CONSOLE
] = "console",
727 [LOG_TARGET_KMSG
] = "kmsg",
728 [LOG_TARGET_JOURNAL
] = "journal",
729 [LOG_TARGET_JOURNAL_OR_KMSG
] = "journal-or-kmsg",
730 [LOG_TARGET_SYSLOG
] = "syslog",
731 [LOG_TARGET_SYSLOG_OR_KMSG
] = "syslog-or-kmsg",
732 [LOG_TARGET_AUTO
] = "auto",
733 [LOG_TARGET_NULL
] = "null"
736 DEFINE_STRING_TABLE_LOOKUP(log_target
, LogTarget
);