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/>.
22 #include <sys/socket.h>
23 #include <sys/types.h>
31 #include <sys/epoll.h>
38 #include "sd-daemon.h"
42 #define STREAMS_MAX 4096
43 #define SERVER_FD_MAX 16
44 #define TIMEOUT_MSEC ((int) (DEFAULT_EXIT_USEC/USEC_PER_MSEC))
46 typedef struct Stream Stream;
48 typedef struct Server {
55 bool syslog_is_stream;
57 LIST_HEAD(Stream, streams);
61 typedef enum StreamTarget {
66 typedef enum StreamState {
91 char buffer[LINE_MAX+1];
94 LIST_FIELDS(Stream, stream);
97 static int stream_log(Stream *s, char *p, usec_t ts) {
99 char header_priority[16], header_time[64], header_pid[16];
100 struct iovec iovec[5];
106 priority = s->priority;
109 parse_syslog_priority(&p, &priority);
114 /* Patch in configured facility if necessary */
115 if ((priority & LOG_FACMASK) == 0)
116 priority = (s->priority & LOG_FACMASK) | priority;
119 * The format glibc uses to talk to the syslog daemon is:
121 * <priority>time process[pid]: msg
123 * The format the kernel uses is:
127 * We extend the latter to include the process name and pid.
130 snprintf(header_priority, sizeof(header_priority), "<%i>", priority);
131 char_array_0(header_priority);
133 if (s->target == STREAM_SYSLOG) {
137 t = (time_t) (ts / USEC_PER_SEC);
138 if (!(tm = localtime(&t)))
141 if (strftime(header_time, sizeof(header_time), "%h %e %T ", tm) <= 0)
145 snprintf(header_pid, sizeof(header_pid), "[%lu]: ", (unsigned long) s->pid);
146 char_array_0(header_pid);
149 IOVEC_SET_STRING(iovec[0], header_priority);
151 if (s->target == STREAM_SYSLOG) {
152 struct msghdr msghdr;
154 struct cmsghdr cmsghdr;
155 uint8_t buf[CMSG_SPACE(sizeof(struct ucred))];
160 control.cmsghdr.cmsg_level = SOL_SOCKET;
161 control.cmsghdr.cmsg_type = SCM_CREDENTIALS;
162 control.cmsghdr.cmsg_len = CMSG_LEN(sizeof(struct ucred));
164 ucred = (struct ucred*) CMSG_DATA(&control.cmsghdr);
169 IOVEC_SET_STRING(iovec[1], header_time);
170 IOVEC_SET_STRING(iovec[2], s->process);
171 IOVEC_SET_STRING(iovec[3], header_pid);
172 IOVEC_SET_STRING(iovec[4], p);
174 /* When using syslog via SOCK_STREAM separate the messages by NUL chars */
175 if (s->server->syslog_is_stream)
179 msghdr.msg_iov = iovec;
180 msghdr.msg_iovlen = ELEMENTSOF(iovec);
181 msghdr.msg_control = &control;
182 msghdr.msg_controllen = control.cmsghdr.cmsg_len;
187 if ((n = sendmsg(s->server->syslog_fd, &msghdr, MSG_NOSIGNAL)) < 0) {
189 if (errno == ESRCH) {
192 /* Hmm, maybe the process this
193 * line originates from is
194 * dead? Then let's patch in
195 * our own pid and retry,
196 * since we have nothing
201 if (ucred->pid != our_pid) {
202 ucred->pid = our_pid;
210 if (!s->server->syslog_is_stream ||
211 (size_t) n >= IOVEC_TOTAL_SIZE(iovec, ELEMENTSOF(iovec)))
214 IOVEC_INCREMENT(iovec, ELEMENTSOF(iovec), n);
217 } else if (s->target == STREAM_KMSG) {
218 IOVEC_SET_STRING(iovec[1], s->process);
219 IOVEC_SET_STRING(iovec[2], header_pid);
220 IOVEC_SET_STRING(iovec[3], p);
221 IOVEC_SET_STRING(iovec[4], (char*) "\n");
223 if (writev(s->server->kmsg_fd, iovec, ELEMENTSOF(iovec)) < 0)
226 assert_not_reached("Unknown log target");
228 if (s->tee_console) {
231 if ((console = open_terminal("/dev/console", O_WRONLY|O_NOCTTY|O_CLOEXEC)) >= 0) {
232 IOVEC_SET_STRING(iovec[0], s->process);
233 IOVEC_SET_STRING(iovec[1], header_pid);
234 IOVEC_SET_STRING(iovec[2], p);
235 IOVEC_SET_STRING(iovec[3], (char*) "\n");
237 writev(console, iovec, 4);
245 static int stream_line(Stream *s, char *p, usec_t ts) {
256 if (streq(p, "syslog") || streq(p, "syslog+console"))
257 s->target = STREAM_SYSLOG;
258 else if (streq(p, "kmsg") || streq(p, "kmsg+console")) {
260 if (s->server->kmsg_fd >= 0 && s->uid == 0)
261 s->target = STREAM_KMSG;
263 log_warning("/dev/kmsg logging not available.");
267 log_warning("Failed to parse log target line.");
271 if (endswith(p, "+console"))
272 s->tee_console = true;
274 s->state = STREAM_PRIORITY;
277 case STREAM_PRIORITY:
278 if ((r = safe_atoi(p, &s->priority)) < 0) {
279 log_warning("Failed to parse log priority line: %m");
283 if (s->priority < 0) {
284 log_warning("Log priority negative: %m");
288 s->state = STREAM_PROCESS;
292 if (!(s->process = strdup(p)))
295 s->state = STREAM_PREFIX;
300 if ((r = parse_boolean(p)) < 0)
304 s->state = STREAM_RUNNING;
308 return stream_log(s, p, ts);
311 assert_not_reached("Unknown stream state");
314 static int stream_scan(Stream *s, usec_t ts) {
322 remaining = s->length;
327 end = memchr(p, '\n', remaining);
329 if (remaining >= LINE_MAX) {
339 r = stream_line(s, p, ts);
347 memmove(s->buffer, p, remaining);
348 s->length = remaining;
354 static int stream_process(Stream *s, usec_t ts) {
359 l = read(s->fd, s->buffer+s->length, LINE_MAX-s->length);
365 log_warning("Failed to read from stream: %m");
374 r = stream_scan(s, ts);
382 static void stream_free(Stream *s) {
386 assert(s->server->n_streams > 0);
387 s->server->n_streams--;
388 LIST_REMOVE(Stream, stream, s->server->streams, s);
394 epoll_ctl(s->server->epoll_fd, EPOLL_CTL_DEL, s->fd, NULL);
396 close_nointr_nofail(s->fd);
403 static int stream_new(Server *s, int server_fd) {
407 socklen_t len = sizeof(ucred);
408 struct epoll_event ev;
413 if ((fd = accept4(server_fd, NULL, NULL, SOCK_NONBLOCK|SOCK_CLOEXEC)) < 0)
416 if (s->n_streams >= STREAMS_MAX) {
417 log_warning("Too many connections, refusing connection.");
418 close_nointr_nofail(fd);
422 if (!socket_tcpwrap(fd, "systemd-stdout-syslog-bridge")) {
423 close_nointr_nofail(fd);
427 if (!(stream = new0(Stream, 1))) {
428 close_nointr_nofail(fd);
434 if (getsockopt(stream->fd, SOL_SOCKET, SO_PEERCRED, &ucred, &len) < 0) {
439 if (shutdown(fd, SHUT_WR) < 0) {
445 ev.data.ptr = stream;
447 if (epoll_ctl(s->epoll_fd, EPOLL_CTL_ADD, fd, &ev) < 0) {
452 stream->pid = ucred.pid;
453 stream->uid = ucred.uid;
454 stream->gid = ucred.gid;
457 LIST_PREPEND(Stream, stream, s->streams, stream);
467 static void server_done(Server *s) {
472 stream_free(s->streams);
474 for (i = 0; i < s->n_server_fd; i++)
475 close_nointr_nofail(SD_LISTEN_FDS_START+i);
477 if (s->syslog_fd >= 0)
478 close_nointr_nofail(s->syslog_fd);
480 if (s->epoll_fd >= 0)
481 close_nointr_nofail(s->epoll_fd);
484 close_nointr_nofail(s->kmsg_fd);
487 static int server_init(Server *s, unsigned n_sockets) {
492 struct sockaddr_un un;
496 assert(n_sockets > 0);
500 s->n_server_fd = n_sockets;
504 if ((s->epoll_fd = epoll_create1(EPOLL_CLOEXEC)) < 0) {
506 log_error("Failed to create epoll object: %m");
510 for (i = 0; i < n_sockets; i++) {
511 struct epoll_event ev;
514 fd = SD_LISTEN_FDS_START+i;
516 if ((r = sd_is_socket(fd, AF_UNSPEC, SOCK_STREAM, 1)) < 0) {
517 log_error("Failed to determine file descriptor type: %s", strerror(-r));
522 log_error("Wrong file descriptor type.");
527 /* We use ev.data.ptr instead of ev.data.fd here,
528 * since on 64bit archs fd is 32bit while a pointer is
529 * 64bit. To make sure we can easily distinguish fd
530 * values and pointer values we want to make sure to
531 * write the full field unconditionally. */
535 ev.data.ptr = INT_TO_PTR(fd);
536 if (epoll_ctl(s->epoll_fd, EPOLL_CTL_ADD, fd, &ev) < 0) {
538 log_error("Failed to add server fd to epoll object: %m");
544 sa.un.sun_family = AF_UNIX;
545 strncpy(sa.un.sun_path, "/dev/log", sizeof(sa.un.sun_path));
547 if ((s->syslog_fd = socket(AF_UNIX, SOCK_DGRAM|SOCK_CLOEXEC, 0)) < 0) {
549 log_error("Failed to create log fd: %m");
553 if (connect(s->syslog_fd, &sa.sa, sizeof(sa)) < 0) {
554 close_nointr_nofail(s->syslog_fd);
556 if ((s->syslog_fd = socket(AF_UNIX, SOCK_STREAM|SOCK_CLOEXEC, 0)) < 0) {
558 log_error("Failed to create log fd: %m");
562 if (connect(s->syslog_fd, &sa.sa, sizeof(sa)) < 0) {
564 log_error("Failed to connect log socket to /dev/log: %m");
568 s->syslog_is_stream = true;
570 s->syslog_is_stream = false;
572 /* /dev/kmsg logging is strictly optional */
573 if ((s->kmsg_fd = open("/dev/kmsg", O_WRONLY|O_NOCTTY|O_CLOEXEC)) < 0)
574 log_warning("Failed to open /dev/kmsg for logging, disabling kernel log buffer support: %m");
583 static int process_event(Server *s, struct epoll_event *ev) {
588 /* Yes, this is a bit ugly, we assume that that valid pointers
589 * are > SD_LISTEN_FDS_START+SERVER_FD_MAX. Which is certainly
590 * true on Linux (and probably most other OSes, too, since the
591 * first 4k usually are part of a separate null pointer
592 * dereference page. */
594 if (PTR_TO_INT(ev->data.ptr) >= SD_LISTEN_FDS_START &&
595 PTR_TO_INT(ev->data.ptr) < SD_LISTEN_FDS_START+(int)s->n_server_fd) {
597 if (ev->events != EPOLLIN) {
598 log_info("Got invalid event from epoll. (1)");
602 if ((r = stream_new(s, PTR_TO_INT(ev->data.ptr))) < 0) {
603 log_info("Failed to accept new connection: %s", strerror(-r));
609 Stream *stream = ev->data.ptr;
611 ts = now(CLOCK_REALTIME);
613 if (!(ev->events & EPOLLIN)) {
614 log_info("Got invalid event from epoll. (2)");
619 if ((r = stream_process(stream, ts)) <= 0) {
622 log_info("Got error on stream: %s", strerror(-r));
632 int main(int argc, char *argv[]) {
634 int r = EXIT_FAILURE, n;
636 if (getppid() != 1) {
637 log_error("This program should be invoked by init only.");
642 log_error("This program does not take arguments.");
646 log_set_target(LOG_TARGET_SYSLOG_OR_KMSG);
647 log_parse_environment();
652 if ((n = sd_listen_fds(true)) < 0) {
653 log_error("Failed to read listening file descriptors from environment: %s", strerror(-r));
657 if (n <= 0 || n > SERVER_FD_MAX) {
658 log_error("No or too many file descriptors passed.");
662 if (server_init(&server, (unsigned) n) < 0)
665 log_debug("systemd-stdout-syslog-bridge running as pid %lu", (unsigned long) getpid());
669 "STATUS=Processing requests...");
672 struct epoll_event event;
675 if ((k = epoll_wait(server.epoll_fd,
677 server.n_streams <= 0 ? TIMEOUT_MSEC : -1)) < 0) {
682 log_error("epoll_wait() failed: %m");
689 if (process_event(&server, &event) < 0)
695 log_debug("systemd-stdout-syslog-bridge stopped as pid %lu", (unsigned long) getpid());
699 "STATUS=Shutting down...");
701 server_done(&server);