src/logger.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
  35 #include "util.h"
  36 #include "log.h"
  37 #include "list.h"
  38 #include "sd-daemon.h"
  39 #include "tcpwrap.h"
  40 #include "def.h"
  41
  42 #define STREAMS_MAX 4096
  43 #define SERVER_FD_MAX 16
  44 #define TIMEOUT_MSEC ((int) (DEFAULT_EXIT_USEC/USEC_PER_MSEC))
  45
  46 typedef struct Stream Stream;
  47
  48 typedef struct Server {
  49         int syslog_fd;
  50         int kmsg_fd;
  51         int epoll_fd;
  52
  53         unsigned n_server_fd;
  54
  55         bool syslog_is_stream;
  56
  57         LIST_HEAD(Stream, streams);
  58         unsigned n_streams;
  59 } Server;
  60
  61 typedef enum StreamTarget {
  62         STREAM_SYSLOG,
  63         STREAM_KMSG
  64 } StreamTarget;
  65
  66 typedef enum StreamState {
  67         STREAM_TARGET,
  68         STREAM_PRIORITY,
  69         STREAM_PROCESS,
  70         STREAM_PREFIX,
  71         STREAM_RUNNING
  72 } StreamState;
  73
  74 struct Stream {
  75         Server *server;
  76
  77         StreamState state;
  78
  79         int fd;
  80
  81         StreamTarget target;
  82         int priority;
  83         char *process;
  84         pid_t pid;
  85         uid_t uid;
  86         gid_t gid;
  87
  88         bool prefix:1;
  89         bool tee_console:1;
  90
  91         char buffer[LINE_MAX];
  92         size_t length;
  93
  94         LIST_FIELDS(Stream, stream);
  95 };
  96
  97 static int stream_log(Stream *s, char *p, usec_t ts) {
  98
  99         char header_priority[16], header_time[64], header_pid[16];
 100         struct iovec iovec[5];
 101         int priority;
 102
 103         assert(s);
 104         assert(p);
 105
 106         priority = s->priority;
 107
 108         if (s->prefix)
 109                 parse_syslog_priority(&p, &priority);
 110
 111         if (*p == 0)
 112                 return 0;
 113
 114         /* Patch in LOG_USER facility if necessary */
 115         if ((priority & LOG_FACMASK) == 0)
 116                 priority = LOG_USER | LOG_PRI(priority);
 117
 118         /*
 119          * The format glibc uses to talk to the syslog daemon is:
 120          *
 121          *     <priority>time process[pid]: msg
 122          *
 123          * The format the kernel uses is:
 124          *
 125          *     <priority>msg\n
 126          *
 127          *  We extend the latter to include the process name and pid.
 128          */
 129
 130         snprintf(header_priority, sizeof(header_priority), "<%i>", priority);
 131         char_array_0(header_priority);
 132
 133         if (s->target == STREAM_SYSLOG) {
 134                 time_t t;
 135                 struct tm *tm;
 136
 137                 t = (time_t) (ts / USEC_PER_SEC);
 138                 if (!(tm = localtime(&t)))
 139                         return -EINVAL;
 140
 141                 if (strftime(header_time, sizeof(header_time), "%h %e %T ", tm) <= 0)
 142                         return -EINVAL;
 143         }
 144
 145         snprintf(header_pid, sizeof(header_pid), "[%lu]: ", (unsigned long) s->pid);
 146         char_array_0(header_pid);
 147
 148         zero(iovec);
 149         IOVEC_SET_STRING(iovec[0], header_priority);
 150
 151         if (s->target == STREAM_SYSLOG) {
 152                 struct msghdr msghdr;
 153                 union {
 154                         struct cmsghdr cmsghdr;
 155                         uint8_t buf[CMSG_SPACE(sizeof(struct ucred))];
 156                 } control;
 157                 struct ucred *ucred;
 158
 159                 zero(control);
 160                 control.cmsghdr.cmsg_level = SOL_SOCKET;
 161                 control.cmsghdr.cmsg_type = SCM_CREDENTIALS;
 162                 control.cmsghdr.cmsg_len = CMSG_LEN(sizeof(struct ucred));
 163
 164                 ucred = (struct ucred*) CMSG_DATA(&control.cmsghdr);
 165                 ucred->pid = s->pid;
 166                 ucred->uid = s->uid;
 167                 ucred->gid = s->gid;
 168
 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);
 173
 174                 /* When using syslog via SOCK_STREAM separate the messages by NUL chars */
 175                 if (s->server->syslog_is_stream)
 176                         iovec[4].iov_len++;
 177
 178                 zero(msghdr);
 179                 msghdr.msg_iov = iovec;
 180                 msghdr.msg_iovlen = ELEMENTSOF(iovec);
 181                 msghdr.msg_control = &control;
 182                 msghdr.msg_controllen = control.cmsghdr.cmsg_len;
 183
 184                 for (;;) {
 185                         ssize_t n;
 186
 187                         if ((n = sendmsg(s->server->syslog_fd, &msghdr, MSG_NOSIGNAL)) < 0) {
 188
 189                                 if (errno == ESRCH) {
 190                                         pid_t our_pid;
 191
 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
 197                                          * better */
 198
 199                                         our_pid = getpid();
 200
 201                                         if (ucred->pid != our_pid) {
 202                                                 ucred->pid = our_pid;
 203                                                 continue;
 204                                         }
 205                                 }
 206
 207                                 return -errno;
 208                         }
 209
 210                         if (!s->server->syslog_is_stream ||
 211                             (size_t) n >= IOVEC_TOTAL_SIZE(iovec, ELEMENTSOF(iovec)))
 212                                 break;
 213
 214                         IOVEC_INCREMENT(iovec, ELEMENTSOF(iovec), n);
 215                 }
 216
 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");
 222
 223                 if (writev(s->server->kmsg_fd, iovec, ELEMENTSOF(iovec)) < 0)
 224                         return -errno;
 225         } else
 226                 assert_not_reached("Unknown log target");
 227
 228         if (s->tee_console) {
 229                 int console;
 230
 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");
 236
 237                         writev(console, iovec, 4);
 238                 }
 239
 240         }
 241
 242         return 0;
 243 }
 244
 245 static int stream_line(Stream *s, char *p, usec_t ts) {
 246         int r;
 247
 248         assert(s);
 249         assert(p);
 250
 251         p = strstrip(p);
 252
 253         switch (s->state) {
 254
 255         case STREAM_TARGET:
 256                 if (streq(p, "syslog") || streq(p, "syslog+console"))
 257                         s->target = STREAM_SYSLOG;
 258                 else if (streq(p, "kmsg") || streq(p, "kmsg+console")) {
 259
 260                         if (s->server->kmsg_fd >= 0 && s->uid == 0)
 261                                 s->target = STREAM_KMSG;
 262                         else {
 263                                 log_warning("/dev/kmsg logging not available.");
 264                                 return -EPERM;
 265                         }
 266                 } else {
 267                         log_warning("Failed to parse log target line.");
 268                         return -EBADMSG;
 269                 }
 270
 271                 if (endswith(p, "+console"))
 272                         s->tee_console = true;
 273
 274                 s->state = STREAM_PRIORITY;
 275                 return 0;
 276
 277         case STREAM_PRIORITY:
 278                 if ((r = safe_atoi(p, &s->priority)) < 0) {
 279                         log_warning("Failed to parse log priority line: %m");
 280                         return r;
 281                 }
 282
 283                 if (s->priority < 0) {
 284                         log_warning("Log priority negative: %m");
 285                         return -ERANGE;
 286                 }
 287
 288                 s->state = STREAM_PROCESS;
 289                 return 0;
 290
 291         case STREAM_PROCESS:
 292                 if (!(s->process = strdup(p)))
 293                         return -ENOMEM;
 294
 295                 s->state = STREAM_PREFIX;
 296                 return 0;
 297
 298         case STREAM_PREFIX:
 299
 300                 if ((r = parse_boolean(p)) < 0)
 301                         return r;
 302
 303                 s->prefix = r;
 304                 s->state = STREAM_RUNNING;
 305                 return 0;
 306
 307         case STREAM_RUNNING:
 308                 return stream_log(s, p, ts);
 309         }
 310
 311         assert_not_reached("Unknown stream state");
 312 }
 313
 314 static int stream_scan(Stream *s, usec_t ts) {
 315         char *p;
 316         size_t remaining;
 317         int r = 0;
 318
 319         assert(s);
 320
 321         p = s->buffer;
 322         remaining = s->length;
 323         for (;;) {
 324                 char *newline;
 325
 326                 if (!(newline = memchr(p, '\n', remaining)))
 327                         break;
 328
 329                 *newline = 0;
 330
 331                 if ((r = stream_line(s, p, ts)) >= 0) {
 332                         remaining -= newline-p+1;
 333                         p = newline+1;
 334                 }
 335         }
 336
 337         if (p > s->buffer) {
 338                 memmove(s->buffer, p, remaining);
 339                 s->length = remaining;
 340         }
 341
 342         return r;
 343 }
 344
 345 static int stream_process(Stream *s, usec_t ts) {
 346         ssize_t l;
 347         int r;
 348         assert(s);
 349
 350         if ((l = read(s->fd, s->buffer+s->length, LINE_MAX-s->length)) < 0) {
 351
 352                 if (errno == EAGAIN)
 353                         return 0;
 354
 355                 log_warning("Failed to read from stream: %m");
 356                 return -errno;
 357         }
 358
 359
 360         if (l == 0)
 361                 return 0;
 362
 363         s->length += l;
 364         r = stream_scan(s, ts);
 365
 366         if (r < 0)
 367                 return r;
 368
 369         return 1;
 370 }
 371
 372 static void stream_free(Stream *s) {
 373         assert(s);
 374
 375         if (s->server) {
 376                 assert(s->server->n_streams > 0);
 377                 s->server->n_streams--;
 378                 LIST_REMOVE(Stream, stream, s->server->streams, s);
 379
 380         }
 381
 382         if (s->fd >= 0) {
 383                 if (s->server)
 384                         epoll_ctl(s->server->epoll_fd, EPOLL_CTL_DEL, s->fd, NULL);
 385
 386                 close_nointr_nofail(s->fd);
 387         }
 388
 389         free(s->process);
 390         free(s);
 391 }
 392
 393 static int stream_new(Server *s, int server_fd) {
 394         Stream *stream;
 395         int fd;
 396         struct ucred ucred;
 397         socklen_t len = sizeof(ucred);
 398         struct epoll_event ev;
 399         int r;
 400
 401         assert(s);
 402
 403         if ((fd = accept4(server_fd, NULL, NULL, SOCK_NONBLOCK|SOCK_CLOEXEC)) < 0)
 404                 return -errno;
 405
 406         if (s->n_streams >= STREAMS_MAX) {
 407                 log_warning("Too many connections, refusing connection.");
 408                 close_nointr_nofail(fd);
 409                 return 0;
 410         }
 411
 412         if (!socket_tcpwrap(fd, "systemd-logger")) {
 413                 close_nointr_nofail(fd);
 414                 return 0;
 415         }
 416
 417         if (!(stream = new0(Stream, 1))) {
 418                 close_nointr_nofail(fd);
 419                 return -ENOMEM;
 420         }
 421
 422         stream->fd = fd;
 423
 424         if (getsockopt(stream->fd, SOL_SOCKET, SO_PEERCRED, &ucred, &len) < 0) {
 425                 r = -errno;
 426                 goto fail;
 427         }
 428
 429         if (shutdown(fd, SHUT_WR) < 0) {
 430                 r = -errno;
 431                 goto fail;
 432         }
 433
 434         zero(ev);
 435         ev.data.ptr = stream;
 436         ev.events = EPOLLIN;
 437         if (epoll_ctl(s->epoll_fd, EPOLL_CTL_ADD, fd, &ev) < 0) {
 438                 r = -errno;
 439                 goto fail;
 440         }
 441
 442         stream->pid = ucred.pid;
 443         stream->uid = ucred.uid;
 444         stream->gid = ucred.gid;
 445
 446         stream->server = s;
 447         LIST_PREPEND(Stream, stream, s->streams, stream);
 448         s->n_streams ++;
 449
 450         return 0;
 451
 452 fail:
 453         stream_free(stream);
 454         return r;
 455 }
 456
 457 static void server_done(Server *s) {
 458         unsigned i;
 459         assert(s);
 460
 461         while (s->streams)
 462                 stream_free(s->streams);
 463
 464         for (i = 0; i < s->n_server_fd; i++)
 465                 close_nointr_nofail(SD_LISTEN_FDS_START+i);
 466
 467         if (s->syslog_fd >= 0)
 468                 close_nointr_nofail(s->syslog_fd);
 469
 470         if (s->epoll_fd >= 0)
 471                 close_nointr_nofail(s->epoll_fd);
 472
 473         if (s->kmsg_fd >= 0)
 474                 close_nointr_nofail(s->kmsg_fd);
 475 }
 476
 477 static int server_init(Server *s, unsigned n_sockets) {
 478         int r;
 479         unsigned i;
 480         union {
 481                 struct sockaddr sa;
 482                 struct sockaddr_un un;
 483         } sa;
 484
 485         assert(s);
 486         assert(n_sockets > 0);
 487
 488         zero(*s);
 489
 490         s->n_server_fd = n_sockets;
 491         s->syslog_fd = -1;
 492         s->kmsg_fd = -1;
 493
 494         if ((s->epoll_fd = epoll_create1(EPOLL_CLOEXEC)) < 0) {
 495                 r = -errno;
 496                 log_error("Failed to create epoll object: %m");
 497                 goto fail;
 498         }
 499
 500         for (i = 0; i < n_sockets; i++) {
 501                 struct epoll_event ev;
 502                 int fd;
 503
 504                 fd = SD_LISTEN_FDS_START+i;
 505
 506                 if ((r = sd_is_socket(fd, AF_UNSPEC, SOCK_STREAM, 1)) < 0) {
 507                         log_error("Failed to determine file descriptor type: %s", strerror(-r));
 508                         goto fail;
 509                 }
 510
 511                 if (!r) {
 512                         log_error("Wrong file descriptor type.");
 513                         r = -EINVAL;
 514                         goto fail;
 515                 }
 516
 517                 /* We use ev.data.ptr instead of ev.data.fd here,
 518                  * since on 64bit archs fd is 32bit while a pointer is
 519                  * 64bit. To make sure we can easily distinguish fd
 520                  * values and pointer values we want to make sure to
 521                  * write the full field unconditionally. */
 522
 523                 zero(ev);
 524                 ev.events = EPOLLIN;
 525                 ev.data.ptr = INT_TO_PTR(fd);
 526                 if (epoll_ctl(s->epoll_fd, EPOLL_CTL_ADD, fd, &ev) < 0) {
 527                         r = -errno;
 528                         log_error("Failed to add server fd to epoll object: %m");
 529                         goto fail;
 530                 }
 531         }
 532
 533         zero(sa);
 534         sa.un.sun_family = AF_UNIX;
 535         strncpy(sa.un.sun_path, "/dev/log", sizeof(sa.un.sun_path));
 536
 537         if ((s->syslog_fd = socket(AF_UNIX, SOCK_DGRAM|SOCK_CLOEXEC, 0)) < 0) {
 538                 r = -errno;
 539                 log_error("Failed to create log fd: %m");
 540                 goto fail;
 541         }
 542
 543         if (connect(s->syslog_fd, &sa.sa, sizeof(sa)) < 0) {
 544                 close_nointr_nofail(s->syslog_fd);
 545
 546                 if ((s->syslog_fd = socket(AF_UNIX, SOCK_STREAM|SOCK_CLOEXEC, 0)) < 0) {
 547                         r = -errno;
 548                         log_error("Failed to create log fd: %m");
 549                         goto fail;
 550                 }
 551
 552                 if (connect(s->syslog_fd, &sa.sa, sizeof(sa)) < 0) {
 553                         r = -errno;
 554                         log_error("Failed to connect log socket to /dev/log: %m");
 555                         goto fail;
 556                 }
 557
 558                 s->syslog_is_stream = true;
 559         } else
 560                 s->syslog_is_stream = false;
 561
 562         /* /dev/kmsg logging is strictly optional */
 563         if ((s->kmsg_fd = open("/dev/kmsg", O_WRONLY|O_NOCTTY|O_CLOEXEC)) < 0)
 564                 log_warning("Failed to open /dev/kmsg for logging, disabling kernel log buffer support: %m");
 565
 566         return 0;
 567
 568 fail:
 569         server_done(s);
 570         return r;
 571 }
 572
 573 static int process_event(Server *s, struct epoll_event *ev) {
 574         int r;
 575
 576         assert(s);
 577
 578         /* Yes, this is a bit ugly, we assume that that valid pointers
 579          * are > SD_LISTEN_FDS_START+SERVER_FD_MAX. Which is certainly
 580          * true on Linux (and probably most other OSes, too, since the
 581          * first 4k usually are part of a separate null pointer
 582          * dereference page. */
 583
 584         if (PTR_TO_INT(ev->data.ptr) >= SD_LISTEN_FDS_START &&
 585             PTR_TO_INT(ev->data.ptr) < SD_LISTEN_FDS_START+(int)s->n_server_fd) {
 586
 587                 if (ev->events != EPOLLIN) {
 588                         log_info("Got invalid event from epoll. (1)");
 589                         return -EIO;
 590                 }
 591
 592                 if ((r = stream_new(s, PTR_TO_INT(ev->data.ptr))) < 0) {
 593                         log_info("Failed to accept new connection: %s", strerror(-r));
 594                         return r;
 595                 }
 596
 597         } else {
 598                 usec_t ts;
 599                 Stream *stream = ev->data.ptr;
 600
 601                 ts = now(CLOCK_REALTIME);
 602
 603                 if (!(ev->events & EPOLLIN)) {
 604                         log_info("Got invalid event from epoll. (2)");
 605                         stream_free(stream);
 606                         return 0;
 607                 }
 608
 609                 if ((r = stream_process(stream, ts)) <= 0) {
 610
 611                         if (r < 0)
 612                                 log_info("Got error on stream: %s", strerror(-r));
 613
 614                         stream_free(stream);
 615                         return 0;
 616                 }
 617         }
 618
 619         return 0;
 620 }
 621
 622 int main(int argc, char *argv[]) {
 623         Server server;
 624         int r = EXIT_FAILURE, n;
 625
 626         if (getppid() != 1) {
 627                 log_error("This program should be invoked by init only.");
 628                 return EXIT_FAILURE;
 629         }
 630
 631         if (argc > 1) {
 632                 log_error("This program does not take arguments.");
 633                 return EXIT_FAILURE;
 634         }
 635
 636         log_set_target(LOG_TARGET_SYSLOG_OR_KMSG);
 637         log_parse_environment();
 638         log_open();
 639
 640         if ((n = sd_listen_fds(true)) < 0) {
 641                 log_error("Failed to read listening file descriptors from environment: %s", strerror(-r));
 642                 return EXIT_FAILURE;
 643         }
 644
 645         if (n <= 0 || n > SERVER_FD_MAX) {
 646                 log_error("No or too many file descriptors passed.");
 647                 return EXIT_FAILURE;
 648         }
 649
 650         if (server_init(&server, (unsigned) n) < 0)
 651                 return EXIT_FAILURE;
 652
 653         log_debug("systemd-logger running as pid %lu", (unsigned long) getpid());
 654
 655         sd_notify(false,
 656                   "READY=1\n"
 657                   "STATUS=Processing requests...");
 658
 659         for (;;) {
 660                 struct epoll_event event;
 661                 int k;
 662
 663                 if ((k = epoll_wait(server.epoll_fd,
 664                                     &event, 1,
 665                                     server.n_streams <= 0 ? TIMEOUT_MSEC : -1)) < 0) {
 666
 667                         if (errno == EINTR)
 668                                 continue;
 669
 670                         log_error("epoll_wait() failed: %m");
 671                         goto fail;
 672                 }
 673
 674                 if (k <= 0)
 675                         break;
 676
 677                 if (process_event(&server, &event) < 0)
 678                         goto fail;
 679         }
 680
 681         r = EXIT_SUCCESS;
 682
 683         log_debug("systemd-logger stopped as pid %lu", (unsigned long) getpid());
 684
 685 fail:
 686         sd_notify(false,
 687                   "STATUS=Shutting down...");
 688
 689         server_done(&server);
 690
 691         return r;
 692 }