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, unsigned n_sockets) {
  69         int r;
  70         unsigned i;
  71         struct epoll_event ev;
  72         sigset_t mask;
  73
  74         assert(s);
  75         assert(n_sockets > 0);
  76
  77         zero(*s);
  78
  79         s->kmsg_fd = s->signal_fd = -1;
  80
  81         if ((s->epoll_fd = epoll_create1(EPOLL_CLOEXEC)) < 0) {
  82                 r = -errno;
  83                 log_error("Failed to create epoll object: %s", strerror(errno));
  84                 goto fail;
  85         }
  86
  87         if (!(s->syslog_fds = fdset_new())) {
  88                 r = -ENOMEM;
  89                 log_error("Failed to allocate file descriptor set: %s", strerror(errno));
  90                 goto fail;
  91         }
  92
  93         for (i = 0; i < n_sockets; i++) {
  94                 int fd;
  95
  96                 fd = SD_LISTEN_FDS_START+i;
  97
  98                 if ((r = sd_is_socket(fd, AF_UNSPEC, SOCK_DGRAM, -1)) < 0) {
  99                         log_error("Failed to determine file descriptor type: %s", strerror(-r));
 100                         goto fail;
 101                 }
 102
 103                 if (!r) {
 104                         log_error("Wrong file descriptor type.");
 105                         r = -EINVAL;
 106                         goto fail;
 107                 }
 108
 109                 zero(ev);
 110                 ev.events = EPOLLIN;
 111                 ev.data.fd = fd;
 112                 if (epoll_ctl(s->epoll_fd, EPOLL_CTL_ADD, fd, &ev) < 0) {
 113                         r = -errno;
 114                         log_error("Failed to add server fd to epoll object: %s", strerror(errno));
 115                         goto fail;
 116                 }
 117
 118                 if ((r = fdset_put(s->syslog_fds, fd)) < 0) {
 119                         log_error("Failed to store file descriptor in set: %s", strerror(-r));
 120                         goto fail;
 121                 }
 122         }
 123
 124         if ((s->kmsg_fd = open("/dev/kmsg", O_WRONLY|O_NOCTTY|O_CLOEXEC)) < 0) {
 125                 log_error("Failed to open /dev/kmsg for logging: %m");
 126                 return -errno;
 127         }
 128
 129         assert_se(sigemptyset(&mask) == 0);
 130         sigset_add_many(&mask, SIGINT, SIGTERM, -1);
 131         assert_se(sigprocmask(SIG_SETMASK, &mask, NULL) == 0);
 132
 133         if ((s->signal_fd = signalfd(-1, &mask, SFD_NONBLOCK|SFD_CLOEXEC)) < 0) {
 134                 log_error("signalfd(): %m");
 135                 return -errno;
 136         }
 137
 138         zero(ev);
 139         ev.events = EPOLLIN;
 140         ev.data.fd = s->signal_fd;
 141
 142         if (epoll_ctl(s->epoll_fd, EPOLL_CTL_ADD, s->signal_fd, &ev) < 0) {
 143                 log_error("epoll_ctl(): %m");
 144                 return -errno;
 145         }
 146
 147         return 0;
 148
 149 fail:
 150         server_done(s);
 151         return r;
 152 }
 153
 154 static void skip_date(const char **buf) {
 155         enum {
 156                 LETTER,
 157                 SPACE,
 158                 NUMBER,
 159                 SPACE_OR_NUMBER,
 160                 COLON
 161         } sequence[] = {
 162                 LETTER, LETTER, LETTER,
 163                 SPACE,
 164                 SPACE_OR_NUMBER, NUMBER,
 165                 SPACE,
 166                 SPACE_OR_NUMBER, NUMBER,
 167                 COLON,
 168                 SPACE_OR_NUMBER, NUMBER,
 169                 COLON,
 170                 SPACE_OR_NUMBER, NUMBER,
 171                 SPACE
 172         };
 173
 174         const char *p;
 175         unsigned i;
 176
 177         assert(buf);
 178         assert(*buf);
 179
 180         p = *buf;
 181
 182         for (i = 0; i < ELEMENTSOF(sequence); i++, p++) {
 183
 184                 if (!*p)
 185                         return;
 186
 187                 switch (sequence[i]) {
 188
 189                 case SPACE:
 190                         if (*p != ' ')
 191                                 return;
 192                         break;
 193
 194                 case SPACE_OR_NUMBER:
 195                         if (*p == ' ')
 196                                 break;
 197
 198                         /* fall through */
 199
 200                 case NUMBER:
 201                         if (*p < '0' || *p > '9')
 202                                 return;
 203
 204                         break;
 205
 206                 case LETTER:
 207                         if (!(*p >= 'A' && *p <= 'Z') &&
 208                             !(*p >= 'a' && *p <= 'z'))
 209                                 return;
 210
 211                         break;
 212
 213                 case COLON:
 214                         if (*p != ':')
 215                                 return;
 216                         break;
 217
 218                 }
 219         }
 220
 221         *buf = p;
 222 }
 223
 224 static int read_process(const char **buf, struct iovec *iovec) {
 225         const char *p;
 226         size_t l;
 227
 228         assert(buf);
 229         assert(*buf);
 230         assert(iovec);
 231
 232         p = *buf;
 233
 234         p += strspn(p, WHITESPACE);
 235         l = strcspn(p, WHITESPACE);
 236
 237         if (l <= 0 ||
 238             p[l-1] != ':')
 239                 return 0;
 240
 241         l--;
 242
 243         if (p[l-1] == ']') {
 244                 size_t k = l-1;
 245
 246                 for (;;) {
 247
 248                         if (p[k] == '[') {
 249                                 l = k;
 250                                 break;
 251                         }
 252
 253                         if (k == 0)
 254                                 break;
 255
 256                         k--;
 257                 }
 258         }
 259
 260         iovec->iov_base = (char*) p;
 261         iovec->iov_len = l;
 262         *buf = p + l;
 263         return 1;
 264 }
 265
 266 static void skip_pid(const char **buf) {
 267         const char *p;
 268
 269         assert(buf);
 270         assert(*buf);
 271
 272         p = *buf;
 273
 274         if (*p != '[')
 275                 return;
 276
 277         p++;
 278         p += strspn(p, "0123456789");
 279
 280         if (*p != ']')
 281                 return;
 282
 283         p++;
 284
 285         *buf = p;
 286 }
 287
 288 static int write_message(Server *s, const char *buf, struct ucred *ucred) {
 289         ssize_t k;
 290         char priority[6], pid[16];
 291         struct iovec iovec[5];
 292         unsigned i = 0;
 293         char *process = NULL;
 294         int r = 0;
 295         int prio = LOG_USER | LOG_INFO;
 296
 297         assert(s);
 298         assert(buf);
 299
 300         parse_syslog_priority((char**) &buf, &prio);
 301
 302         if (*buf == 0)
 303                 return 0;
 304
 305         if ((prio & LOG_FACMASK) == 0)
 306                 prio = LOG_USER | LOG_PRI(prio);
 307
 308         /* First, set priority field */
 309         snprintf(priority, sizeof(priority), "<%i>", prio);
 310         char_array_0(priority);
 311         IOVEC_SET_STRING(iovec[i++], priority);
 312
 313         /* Second, skip date */
 314         skip_date(&buf);
 315
 316         /* Then, add process if set */
 317         if (read_process(&buf, &iovec[i]) > 0)
 318                 i++;
 319         else if (ucred &&
 320                  ucred->pid > 0 &&
 321                  get_process_name(ucred->pid, &process) >= 0)
 322                 IOVEC_SET_STRING(iovec[i++], process);
 323
 324         /* Skip the stored PID if we have a better one */
 325         if (ucred) {
 326                 snprintf(pid, sizeof(pid), "[%lu]: ", (unsigned long) ucred->pid);
 327                 char_array_0(pid);
 328                 IOVEC_SET_STRING(iovec[i++], pid);
 329
 330                 skip_pid(&buf);
 331
 332                 if (*buf == ':')
 333                         buf++;
 334
 335                 buf += strspn(buf, WHITESPACE);
 336         }
 337
 338         /* Is the remaining message empty? */
 339         if (*buf) {
 340
 341                 /* And the rest is the message */
 342                 IOVEC_SET_STRING(iovec[i++], buf);
 343                 IOVEC_SET_STRING(iovec[i++], "\n");
 344
 345                 if ((k = writev(s->kmsg_fd, iovec, i)) <= 0) {
 346                         log_error("Failed to write log message to kmsg: %s", k < 0 ? strerror(errno) : "short write");
 347                         r = k < 0 ? -errno : -EIO;
 348                 }
 349         }
 350
 351         free(process);
 352
 353         return r;
 354 }
 355
 356 static int process_event(Server *s, struct epoll_event *ev) {
 357         assert(s);
 358
 359         if (ev->events != EPOLLIN) {
 360                 log_info("Got invalid event from epoll.");
 361                 return -EIO;
 362         }
 363
 364         if (ev->data.fd == s->signal_fd) {
 365                 struct signalfd_siginfo sfsi;
 366                 ssize_t n;
 367
 368                 if ((n = read(s->signal_fd, &sfsi, sizeof(sfsi))) != sizeof(sfsi)) {
 369
 370                         if (n >= 0)
 371                                 return -EIO;
 372
 373                         if (errno == EINTR || errno == EAGAIN)
 374                                 return 0;
 375
 376                         return -errno;
 377                 }
 378
 379                 log_debug("Received SIG%s", signal_to_string(sfsi.ssi_signo));
 380                 return 0;
 381
 382         } else {
 383                 for (;;) {
 384                         char buf[LINE_MAX+1];
 385                         struct msghdr msghdr;
 386                         struct iovec iovec;
 387                         struct ucred *ucred;
 388                         union {
 389                                 struct cmsghdr cmsghdr;
 390                                 uint8_t buf[CMSG_SPACE(sizeof(struct ucred))];
 391                         } control;
 392                         ssize_t n;
 393                         int k;
 394                         char *e;
 395
 396                         zero(iovec);
 397                         iovec.iov_base = buf;
 398                         iovec.iov_len = sizeof(buf)-1;
 399
 400                         zero(control);
 401                         zero(msghdr);
 402                         msghdr.msg_iov = &iovec;
 403                         msghdr.msg_iovlen = 1;
 404                         msghdr.msg_control = &control;
 405                         msghdr.msg_controllen = sizeof(control);
 406
 407                         if ((n = recvmsg(ev->data.fd, &msghdr, MSG_DONTWAIT)) < 0) {
 408
 409                                 if (errno == EINTR || errno == EAGAIN)
 410                                         return 1;
 411
 412                                 log_error("recvmsg() failed: %m");
 413                                 return -errno;
 414                         }
 415
 416                         if (msghdr.msg_controllen >= CMSG_LEN(sizeof(struct ucred)) &&
 417                             control.cmsghdr.cmsg_level == SOL_SOCKET &&
 418                             control.cmsghdr.cmsg_type == SCM_CREDENTIALS &&
 419                             control.cmsghdr.cmsg_len == CMSG_LEN(sizeof(struct ucred)))
 420                                 ucred = (struct ucred*) CMSG_DATA(&control.cmsghdr);
 421                         else
 422                                 ucred = NULL;
 423
 424                         if ((e = memchr(buf, '\n', n)))
 425                                 *e = 0;
 426                         else
 427                                 buf[n] = 0;
 428
 429                         if ((k = write_message(s, strstrip(buf), ucred)) < 0)
 430                                 return k;
 431                 }
 432         }
 433
 434         return 1;
 435 }
 436
 437 int main(int argc, char *argv[]) {
 438         Server server;
 439         int r = EXIT_FAILURE, n;
 440
 441         if (getppid() != 1) {
 442                 log_error("This program should be invoked by init only.");
 443                 return EXIT_FAILURE;
 444         }
 445
 446         if (argc > 1) {
 447                 log_error("This program does not take arguments.");
 448                 return EXIT_FAILURE;
 449         }
 450
 451         log_set_target(LOG_TARGET_KMSG);
 452         log_parse_environment();
 453         log_open();
 454
 455         umask(0022);
 456
 457         if ((n = sd_listen_fds(true)) < 0) {
 458                 log_error("Failed to read listening file descriptors from environment: %s", strerror(-r));
 459                 return EXIT_FAILURE;
 460         }
 461
 462         if (n <= 0 || n > SERVER_FD_MAX) {
 463                 log_error("No or too many file descriptors passed.");
 464                 return EXIT_FAILURE;
 465         }
 466
 467         if (server_init(&server, (unsigned) n) < 0)
 468                 return EXIT_FAILURE;
 469
 470         log_debug("systemd-kmsg-syslogd running as pid %lu", (unsigned long) getpid());
 471
 472         sd_notify(false,
 473                   "READY=1\n"
 474                   "STATUS=Processing messages...");
 475
 476         for (;;) {
 477                 struct epoll_event event;
 478                 int k;
 479
 480                 if ((k = epoll_wait(server.epoll_fd, &event, 1, -1)) < 0) {
 481
 482                         if (errno == EINTR)
 483                                 continue;
 484
 485                         log_error("epoll_wait() failed: %m");
 486                         goto fail;
 487                 }
 488
 489                 if (k <= 0)
 490                         break;
 491
 492                 if ((k = process_event(&server, &event)) < 0)
 493                         goto fail;
 494
 495                 if (k == 0)
 496                         break;
 497         }
 498
 499         r = EXIT_SUCCESS;
 500
 501         log_debug("systemd-kmsg-syslogd stopped as pid %lu", (unsigned long) getpid());
 502
 503 fail:
 504         sd_notify(false,
 505                   "STATUS=Shutting down...");
 506
 507         server_done(&server);
 508
 509         return r;
 510 }