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