src/kmsg-syslogd.c

   1 /*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
   2
   3 /***
   4   This file is part of systemd.
   5
   6   Copyright 2010 Lennart Poettering
   7
   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.
  12
  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.
  17
  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/>.
  20 ***/
  21
  22 #include <sys/socket.h>
  23 #include <sys/types.h>
  24 #include <assert.h>
  25 #include <time.h>
  26 #include <string.h>
  27 #include <stdio.h>
  28 #include <errno.h>
  29 #include <unistd.h>
  30 #include <sys/poll.h>
  31 #include <sys/epoll.h>
  32 #include <sys/un.h>
  33 #include <fcntl.h>
  34 #include <sys/signalfd.h>
  35
  36 #include <systemd/sd-daemon.h>
  37
  38 #include "util.h"
  39 #include "log.h"
  40 #include "fdset.h"
  41
  42 #define SERVER_FD_MAX 16
  43
  44 typedef struct Stream Stream;
  45
  46 typedef struct Server {
  47         FDSet *syslog_fds;
  48         int kmsg_fd;
  49         int epoll_fd;
  50         int signal_fd;
  51 } Server;
  52
  53 static void server_done(Server *s) {
  54         assert(s);
  55
  56         if (s->epoll_fd >= 0)
  57                 close_nointr_nofail(s->epoll_fd);
  58
  59         if (s->kmsg_fd >= 0)
  60                 close_nointr_nofail(s->kmsg_fd);
  61
  62         if (s->signal_fd >= 0)
  63                 close_nointr_nofail(s->signal_fd);
  64
  65         if (s->syslog_fds)
  66                 fdset_free(s->syslog_fds);
  67 }
  68
  69 static int server_init(Server *s) {
  70         int i, r, n;
  71         struct epoll_event ev;
  72         sigset_t mask;
  73
  74         assert(s);
  75
  76         zero(*s);
  77         s->kmsg_fd = s->signal_fd = -1;
  78
  79         s->epoll_fd = epoll_create1(EPOLL_CLOEXEC);
  80         if (s->epoll_fd < 0) {
  81                 log_error("Failed to create epoll object: %m");
  82                 return -errno;
  83         }
  84
  85         s->syslog_fds = fdset_new();
  86         if (!s->syslog_fds) {
  87                 log_error("Failed to allocate file descriptor set: %s", strerror(ENOMEM));
  88                 return -ENOMEM;
  89         }
  90
  91         n = sd_listen_fds(true);
  92         if (n < 0) {
  93                 log_error("Failed to read listening file descriptors from environment: %s", strerror(-n));
  94                 return n;
  95         }
  96
  97         if (n <= 0 || n > SERVER_FD_MAX) {
  98                 log_error("No or too many file descriptors passed.");
  99                 return -EINVAL;
 100         }
 101
 102         for (i = 0; i < n; i++) {
 103                 int fd;
 104
 105                 fd = SD_LISTEN_FDS_START+i;
 106
 107                 r = sd_is_socket(fd, AF_UNSPEC, SOCK_DGRAM, -1);
 108                 if (r < 0) {
 109                         log_error("Failed to determine file descriptor type: %s", strerror(-r));
 110                         return r;
 111                 }
 112
 113                 if (!r) {
 114                         log_error("Wrong file descriptor type.");
 115                         return -EINVAL;
 116                 }
 117
 118                 zero(ev);
 119                 ev.events = EPOLLIN;
 120                 ev.data.fd = fd;
 121                 if (epoll_ctl(s->epoll_fd, EPOLL_CTL_ADD, fd, &ev) < 0) {
 122                         log_error("Failed to add server fd to epoll object: %m");
 123                         return -errno;
 124                 }
 125
 126                 r = fdset_put(s->syslog_fds, fd);
 127                 if (r < 0) {
 128                         log_error("Failed to store file descriptor in set: %s", strerror(-r));
 129                         return r;
 130                 }
 131         }
 132
 133         s->kmsg_fd = open("/dev/kmsg", O_WRONLY|O_NOCTTY|O_CLOEXEC);
 134         if (s->kmsg_fd < 0) {
 135                 log_error("Failed to open /dev/kmsg for logging: %m");
 136                 return -errno;
 137         }
 138
 139         assert_se(sigemptyset(&mask) == 0);
 140         sigset_add_many(&mask, SIGINT, SIGTERM, -1);
 141         assert_se(sigprocmask(SIG_SETMASK, &mask, NULL) == 0);
 142
 143         s->signal_fd = signalfd(-1, &mask, SFD_NONBLOCK|SFD_CLOEXEC);
 144         if (s->signal_fd < 0) {
 145                 log_error("signalfd(): %m");
 146                 return -errno;
 147         }
 148
 149         zero(ev);
 150         ev.events = EPOLLIN;
 151         ev.data.fd = s->signal_fd;
 152
 153         if (epoll_ctl(s->epoll_fd, EPOLL_CTL_ADD, s->signal_fd, &ev) < 0) {
 154                 log_error("epoll_ctl(): %m");
 155                 return -errno;
 156         }
 157
 158         return 0;
 159 }
 160
 161 static int read_process(const char **buf, struct iovec *iovec) {
 162         const char *p;
 163         size_t l;
 164
 165         assert(buf);
 166         assert(*buf);
 167         assert(iovec);
 168
 169         p = *buf;
 170
 171         p += strspn(p, WHITESPACE);
 172         l = strcspn(p, WHITESPACE);
 173
 174         if (l <= 0 ||
 175             p[l-1] != ':')
 176                 return 0;
 177
 178         l--;
 179
 180         if (p[l-1] == ']') {
 181                 size_t k = l-1;
 182
 183                 for (;;) {
 184
 185                         if (p[k] == '[') {
 186                                 l = k;
 187                                 break;
 188                         }
 189
 190                         if (k == 0)
 191                                 break;
 192
 193                         k--;
 194                 }
 195         }
 196
 197         iovec->iov_base = (char*) p;
 198         iovec->iov_len = l;
 199         *buf = p + l;
 200         return 1;
 201 }
 202
 203 static int write_message(Server *s, const char *buf, struct ucred *ucred) {
 204         ssize_t k;
 205         char priority[6], pid[16];
 206         struct iovec iovec[5];
 207         unsigned i = 0;
 208         char *process = NULL;
 209         int r = 0;
 210         int prio = LOG_USER | LOG_INFO;
 211
 212         assert(s);
 213         assert(buf);
 214
 215         parse_syslog_priority((char**) &buf, &prio);
 216
 217         if (*buf == 0)
 218                 return 0;
 219
 220         if ((prio & LOG_FACMASK) == 0)
 221                 prio = LOG_USER | LOG_PRI(prio);
 222
 223         /* First, set priority field */
 224         snprintf(priority, sizeof(priority), "<%i>", prio);
 225         char_array_0(priority);
 226         IOVEC_SET_STRING(iovec[i++], priority);
 227
 228         /* Second, skip date */
 229         skip_syslog_date((char**) &buf);
 230
 231         /* Then, add process if set */
 232         if (read_process(&buf, &iovec[i]) > 0)
 233                 i++;
 234         else if (ucred &&
 235                  ucred->pid > 0 &&
 236                  get_process_comm(ucred->pid, &process) >= 0)
 237                 IOVEC_SET_STRING(iovec[i++], process);
 238
 239         /* Skip the stored PID if we have a better one */
 240         if (ucred) {
 241                 snprintf(pid, sizeof(pid), "[%lu]: ", (unsigned long) ucred->pid);
 242                 char_array_0(pid);
 243                 IOVEC_SET_STRING(iovec[i++], pid);
 244
 245                 skip_syslog_pid((char**) &buf);
 246
 247                 if (*buf == ':')
 248                         buf++;
 249
 250                 buf += strspn(buf, WHITESPACE);
 251         }
 252
 253         /* Is the remaining message empty? */
 254         if (*buf) {
 255
 256                 /* And the rest is the message */
 257                 IOVEC_SET_STRING(iovec[i++], buf);
 258                 IOVEC_SET_STRING(iovec[i++], "\n");
 259
 260                 if ((k = writev(s->kmsg_fd, iovec, i)) <= 0) {
 261                         log_error("Failed to write log message to kmsg: %s", k < 0 ? strerror(errno) : "short write");
 262                         r = k < 0 ? -errno : -EIO;
 263                 }
 264         }
 265
 266         free(process);
 267
 268         return r;
 269 }
 270
 271 static int process_event(Server *s, struct epoll_event *ev) {
 272         assert(s);
 273
 274         if (ev->events != EPOLLIN) {
 275                 log_info("Got invalid event from epoll.");
 276                 return -EIO;
 277         }
 278
 279         if (ev->data.fd == s->signal_fd) {
 280                 struct signalfd_siginfo sfsi;
 281                 ssize_t n;
 282
 283                 n = read(s->signal_fd, &sfsi, sizeof(sfsi));
 284                 if (n != sizeof(sfsi)) {
 285
 286                         if (n >= 0)
 287                                 return -EIO;
 288
 289                         if (errno == EINTR || errno == EAGAIN)
 290                                 return 0;
 291
 292                         return -errno;
 293                 }
 294
 295                 log_debug("Received SIG%s", signal_to_string(sfsi.ssi_signo));
 296                 return 0;
 297
 298         } else {
 299                 for (;;) {
 300                         char buf[LINE_MAX+1];
 301                         struct msghdr msghdr;
 302                         struct iovec iovec;
 303                         struct ucred *ucred;
 304                         union {
 305                                 struct cmsghdr cmsghdr;
 306                                 uint8_t buf[CMSG_SPACE(sizeof(struct ucred))];
 307                         } control;
 308                         ssize_t n;
 309                         int k;
 310                         char *e;
 311
 312                         zero(iovec);
 313                         iovec.iov_base = buf;
 314                         iovec.iov_len = sizeof(buf)-1;
 315
 316                         zero(control);
 317                         zero(msghdr);
 318                         msghdr.msg_iov = &iovec;
 319                         msghdr.msg_iovlen = 1;
 320                         msghdr.msg_control = &control;
 321                         msghdr.msg_controllen = sizeof(control);
 322
 323                         n = recvmsg(ev->data.fd, &msghdr, MSG_DONTWAIT);
 324                         if (n < 0) {
 325
 326                                 if (errno == EINTR || errno == EAGAIN)
 327                                         return 1;
 328
 329                                 log_error("recvmsg() failed: %m");
 330                                 return -errno;
 331                         }
 332
 333                         if (msghdr.msg_controllen >= CMSG_LEN(sizeof(struct ucred)) &&
 334                             control.cmsghdr.cmsg_level == SOL_SOCKET &&
 335                             control.cmsghdr.cmsg_type == SCM_CREDENTIALS &&
 336                             control.cmsghdr.cmsg_len == CMSG_LEN(sizeof(struct ucred)))
 337                                 ucred = (struct ucred*) CMSG_DATA(&control.cmsghdr);
 338                         else
 339                                 ucred = NULL;
 340
 341                         e = memchr(buf, '\n', n);
 342                         if (e)
 343                                 *e = 0;
 344                         else
 345                                 buf[n] = 0;
 346
 347                         k = write_message(s, strstrip(buf), ucred);
 348                         if (k < 0)
 349                                 return k;
 350                 }
 351         }
 352
 353         return 1;
 354 }
 355
 356 int main(int argc, char *argv[]) {
 357         Server server;
 358         int r;
 359
 360         if (getppid() != 1) {
 361                 log_error("This program should be invoked by init only.");
 362                 return EXIT_FAILURE;
 363         }
 364
 365         if (argc > 1) {
 366                 log_error("This program does not take arguments.");
 367                 return EXIT_FAILURE;
 368         }
 369
 370         log_set_target(LOG_TARGET_KMSG);
 371         log_parse_environment();
 372         log_open();
 373
 374         umask(0022);
 375
 376         r = server_init(&server);
 377         if (r < 0)
 378                 goto finish;
 379
 380         log_debug("systemd-kmsg-syslogd running as pid %lu", (unsigned long) getpid());
 381
 382         sd_notify(false,
 383                   "READY=1\n"
 384                   "STATUS=Processing messages...");
 385
 386         for (;;) {
 387                 struct epoll_event event;
 388
 389                 r = epoll_wait(server.epoll_fd, &event, 1, -1);
 390                 if (r < 0) {
 391
 392                         if (errno == EINTR)
 393                                 continue;
 394
 395                         log_error("epoll_wait() failed: %m");
 396                         r = -errno;
 397                         goto finish;
 398                 } else if (r == 0)
 399                         break;
 400
 401                 r = process_event(&server, &event);
 402                 if (r < 0)
 403                         goto finish;
 404                 else if (r == 0)
 405                         break;
 406         }
 407
 408         log_debug("systemd-kmsg-syslogd stopped as pid %lu", (unsigned long) getpid());
 409
 410 finish:
 411         sd_notify(false,
 412                   "STATUS=Shutting down...");
 413
 414         server_done(&server);
 415
 416         return r < 0 ? EXIT_FAILURE : EXIT_SUCCESS;
 417 }