src/log.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 <stdarg.h>
  23 #include <stdio.h>
  24 #include <errno.h>
  25 #include <unistd.h>
  26 #include <fcntl.h>
  27 #include <sys/socket.h>
  28 #include <sys/un.h>
  29
  30 #include "log.h"
  31 #include "util.h"
  32 #include "macro.h"
  33
  34 #define SYSLOG_TIMEOUT_USEC (5*USEC_PER_SEC)
  35
  36 static LogTarget log_target = LOG_TARGET_CONSOLE;
  37 static int log_max_level = LOG_INFO;
  38
  39 static int console_fd = STDERR_FILENO;
  40 static int syslog_fd = -1;
  41 static int kmsg_fd = -1;
  42
  43 static bool syslog_is_stream = false;
  44
  45 static bool show_color = false;
  46 static bool show_location = false;
  47
  48 /* Akin to glibc's __abort_msg; which is private and we hence cannot
  49  * use here. */
  50 static char *log_abort_msg = NULL;
  51
  52 void log_close_console(void) {
  53
  54         if (console_fd < 0)
  55                 return;
  56
  57         if (getpid() == 1) {
  58                 if (console_fd >= 3)
  59                         close_nointr_nofail(console_fd);
  60
  61                 console_fd = -1;
  62         }
  63 }
  64
  65 static int log_open_console(void) {
  66
  67         if (console_fd >= 0)
  68                 return 0;
  69
  70         if (getpid() == 1) {
  71
  72                 if ((console_fd = open_terminal("/dev/console", O_WRONLY|O_NOCTTY|O_CLOEXEC)) < 0) {
  73                         log_error("Failed to open /dev/console for logging: %s", strerror(-console_fd));
  74                         return console_fd;
  75                 }
  76
  77                 log_debug("Successfully opened /dev/console for logging.");
  78         } else
  79                 console_fd = STDERR_FILENO;
  80
  81         return 0;
  82 }
  83
  84 void log_close_kmsg(void) {
  85
  86         if (kmsg_fd < 0)
  87                 return;
  88
  89         close_nointr_nofail(kmsg_fd);
  90         kmsg_fd = -1;
  91 }
  92
  93 static int log_open_kmsg(void) {
  94
  95         if (kmsg_fd >= 0)
  96                 return 0;
  97
  98         if ((kmsg_fd = open("/dev/kmsg", O_WRONLY|O_NOCTTY|O_CLOEXEC)) < 0) {
  99                 log_error("Failed to open /dev/kmsg for logging: %s", strerror(errno));
 100                 return -errno;
 101         }
 102
 103         log_debug("Successfully opened /dev/kmsg for logging.");
 104
 105         return 0;
 106 }
 107
 108 void log_close_syslog(void) {
 109
 110         if (syslog_fd < 0)
 111                 return;
 112
 113         close_nointr_nofail(syslog_fd);
 114         syslog_fd = -1;
 115 }
 116
 117 static int create_log_socket(int type) {
 118         struct timeval tv;
 119         int fd;
 120
 121         if ((fd = socket(AF_UNIX, type|SOCK_CLOEXEC, 0)) < 0)
 122                 return -errno;
 123
 124         /* Make sure we don't block for more than 5s when talking to
 125          * syslog */
 126         timeval_store(&tv, SYSLOG_TIMEOUT_USEC);
 127         if (setsockopt(fd, SOL_SOCKET, SO_SNDTIMEO, &tv, sizeof(tv)) < 0) {
 128                 close_nointr_nofail(fd);
 129                 return -errno;
 130         }
 131
 132         return fd;
 133 }
 134
 135 static int log_open_syslog(void) {
 136         union {
 137                 struct sockaddr sa;
 138                 struct sockaddr_un un;
 139         } sa;
 140         int r;
 141
 142         if (syslog_fd >= 0)
 143                 return 0;
 144
 145         zero(sa);
 146         sa.un.sun_family = AF_UNIX;
 147         strncpy(sa.un.sun_path, "/dev/log", sizeof(sa.un.sun_path));
 148
 149         if ((syslog_fd = create_log_socket(SOCK_DGRAM)) < 0) {
 150                 r = -errno;
 151                 goto fail;
 152         }
 153
 154         if (connect(syslog_fd, &sa.sa, sizeof(sa)) < 0) {
 155                 close_nointr_nofail(syslog_fd);
 156
 157                 /* Some legacy syslog systems still use stream
 158                  * sockets. They really shouldn't. But what can we
 159                  * do... */
 160                 if ((syslog_fd = create_log_socket(SOCK_STREAM)) < 0) {
 161                         r = -errno;
 162                         goto fail;
 163                 }
 164
 165                 if (connect(syslog_fd, &sa.sa, sizeof(sa)) < 0) {
 166                         r = -errno;
 167                         goto fail;
 168                 }
 169
 170                 syslog_is_stream = true;
 171         } else
 172                 syslog_is_stream = false;
 173
 174         log_debug("Successfully opened syslog for logging.");
 175
 176         return 0;
 177
 178 fail:
 179         log_close_syslog();
 180         log_debug("Failed to open syslog for logging: %s", strerror(-r));
 181         return r;
 182 }
 183
 184 int log_open(void) {
 185         int r;
 186
 187         /* If we don't use the console we close it here, to not get
 188          * killed by SAK. If we don't use syslog we close it here so
 189          * that we are not confused by somebody deleting the socket in
 190          * the fs. If we don't use /dev/kmsg we still keep it open,
 191          * because there is no reason to close it. */
 192
 193         if (log_target == LOG_TARGET_NULL) {
 194                 log_close_syslog();
 195                 log_close_console();
 196                 return 0;
 197         }
 198
 199         if (log_target != LOG_TARGET_AUTO ||
 200             getpid() == 1 ||
 201             isatty(STDERR_FILENO) <= 0) {
 202
 203                 if (log_target == LOG_TARGET_AUTO ||
 204                     log_target == LOG_TARGET_SYSLOG_OR_KMSG ||
 205                     log_target == LOG_TARGET_SYSLOG)
 206                         if ((r = log_open_syslog()) >= 0) {
 207                                 log_close_console();
 208                                 return r;
 209                         }
 210                 if (log_target == LOG_TARGET_AUTO ||
 211                     log_target == LOG_TARGET_SYSLOG_OR_KMSG ||
 212                     log_target == LOG_TARGET_KMSG)
 213                         if ((r = log_open_kmsg()) >= 0) {
 214                                 log_close_syslog();
 215                                 log_close_console();
 216                                 return r;
 217                         }
 218         }
 219
 220         log_close_syslog();
 221
 222         /* Get the real /dev/console if we are PID=1, hence reopen */
 223         log_close_console();
 224         return log_open_console();
 225 }
 226
 227 void log_set_target(LogTarget target) {
 228         assert(target >= 0);
 229         assert(target < _LOG_TARGET_MAX);
 230
 231         log_target = target;
 232 }
 233
 234 void log_close(void) {
 235         log_close_console();
 236         log_close_kmsg();
 237         log_close_syslog();
 238 }
 239
 240 void log_set_max_level(int level) {
 241         assert((level & LOG_PRIMASK) == level);
 242
 243         log_max_level = level;
 244 }
 245
 246 static int write_to_console(
 247                 int level,
 248                 const char*file,
 249                 int line,
 250                 const char *func,
 251                 const char *buffer) {
 252
 253         char location[64];
 254         struct iovec iovec[5];
 255         unsigned n = 0;
 256         bool highlight;
 257
 258         if (console_fd < 0)
 259                 return 0;
 260
 261         snprintf(location, sizeof(location), "(%s:%u) ", file, line);
 262         char_array_0(location);
 263
 264         highlight = LOG_PRI(level) <= LOG_ERR && show_color;
 265
 266         zero(iovec);
 267         if (show_location)
 268                 IOVEC_SET_STRING(iovec[n++], location);
 269         if (highlight)
 270                 IOVEC_SET_STRING(iovec[n++], ANSI_HIGHLIGHT_ON);
 271         IOVEC_SET_STRING(iovec[n++], buffer);
 272         if (highlight)
 273                 IOVEC_SET_STRING(iovec[n++], ANSI_HIGHLIGHT_OFF);
 274         IOVEC_SET_STRING(iovec[n++], "\n");
 275
 276         if (writev(console_fd, iovec, n) < 0)
 277                 return -errno;
 278
 279         return 1;
 280 }
 281
 282 static int write_to_syslog(
 283         int level,
 284         const char*file,
 285         int line,
 286         const char *func,
 287         const char *buffer) {
 288
 289         char header_priority[16], header_time[64], header_pid[16];
 290         struct iovec iovec[5];
 291         struct msghdr msghdr;
 292         time_t t;
 293         struct tm *tm;
 294
 295         if (syslog_fd < 0)
 296                 return 0;
 297
 298         snprintf(header_priority, sizeof(header_priority), "<%i>", level);
 299         char_array_0(header_priority);
 300
 301         t = (time_t) (now(CLOCK_REALTIME) / USEC_PER_SEC);
 302         if (!(tm = localtime(&t)))
 303                 return -EINVAL;
 304
 305         if (strftime(header_time, sizeof(header_time), "%h %e %T ", tm) <= 0)
 306                 return -EINVAL;
 307
 308         snprintf(header_pid, sizeof(header_pid), "[%lu]: ", (unsigned long) getpid());
 309         char_array_0(header_pid);
 310
 311         zero(iovec);
 312         IOVEC_SET_STRING(iovec[0], header_priority);
 313         IOVEC_SET_STRING(iovec[1], header_time);
 314         IOVEC_SET_STRING(iovec[2], program_invocation_short_name);
 315         IOVEC_SET_STRING(iovec[3], header_pid);
 316         IOVEC_SET_STRING(iovec[4], buffer);
 317
 318         /* When using syslog via SOCK_STREAM separate the messages by NUL chars */
 319         if (syslog_is_stream)
 320                 iovec[4].iov_len++;
 321
 322         zero(msghdr);
 323         msghdr.msg_iov = iovec;
 324         msghdr.msg_iovlen = ELEMENTSOF(iovec);
 325
 326         for (;;) {
 327                 ssize_t n;
 328
 329                 if ((n = sendmsg(syslog_fd, &msghdr, MSG_NOSIGNAL)) < 0)
 330                         return -errno;
 331
 332                 if (!syslog_is_stream ||
 333                     (size_t) n >= IOVEC_TOTAL_SIZE(iovec, ELEMENTSOF(iovec)))
 334                         break;
 335
 336                 IOVEC_INCREMENT(iovec, ELEMENTSOF(iovec), n);
 337         }
 338
 339         return 1;
 340 }
 341
 342 static int write_to_kmsg(
 343         int level,
 344         const char*file,
 345         int line,
 346         const char *func,
 347         const char *buffer) {
 348
 349         char header_priority[16], header_pid[16];
 350         struct iovec iovec[5];
 351
 352         if (kmsg_fd < 0)
 353                 return 0;
 354
 355         snprintf(header_priority, sizeof(header_priority), "<%i>", level);
 356         char_array_0(header_priority);
 357
 358         snprintf(header_pid, sizeof(header_pid), "[%lu]: ", (unsigned long) getpid());
 359         char_array_0(header_pid);
 360
 361         zero(iovec);
 362         IOVEC_SET_STRING(iovec[0], header_priority);
 363         IOVEC_SET_STRING(iovec[1], program_invocation_short_name);
 364         IOVEC_SET_STRING(iovec[2], header_pid);
 365         IOVEC_SET_STRING(iovec[3], buffer);
 366         IOVEC_SET_STRING(iovec[4], "\n");
 367
 368         if (writev(kmsg_fd, iovec, ELEMENTSOF(iovec)) < 0)
 369                 return -errno;
 370
 371         return 1;
 372 }
 373
 374 static int log_dispatch(
 375         int level,
 376         const char*file,
 377         int line,
 378         const char *func,
 379         char *buffer) {
 380
 381         int r = 0;
 382
 383         if (log_target == LOG_TARGET_NULL)
 384                 return 0;
 385
 386         /* Patch in LOG_DAEMON facility if necessary */
 387         if ((level & LOG_FACMASK) == 0)
 388                 level = LOG_DAEMON | LOG_PRI(level);
 389
 390         do {
 391                 char *e;
 392                 int k = 0;
 393
 394                 buffer += strspn(buffer, NEWLINE);
 395
 396                 if (buffer[0] == 0)
 397                         break;
 398
 399                 if ((e = strpbrk(buffer, NEWLINE)))
 400                         *(e++) = 0;
 401
 402                 if (log_target == LOG_TARGET_AUTO ||
 403                     log_target == LOG_TARGET_SYSLOG_OR_KMSG ||
 404                     log_target == LOG_TARGET_SYSLOG) {
 405
 406                         if ((k = write_to_syslog(level, file, line, func, buffer)) < 0) {
 407                                 log_close_syslog();
 408                                 log_open_kmsg();
 409                         } else if (k > 0)
 410                                 r++;
 411                 }
 412
 413                 if (k <= 0 &&
 414                     (log_target == LOG_TARGET_AUTO ||
 415                      log_target == LOG_TARGET_SYSLOG_OR_KMSG ||
 416                      log_target == LOG_TARGET_KMSG)) {
 417
 418                         if ((k = write_to_kmsg(level, file, line, func, buffer)) < 0) {
 419                                 log_close_kmsg();
 420                                 log_open_console();
 421                         } else if (k > 0)
 422                                 r++;
 423                 }
 424
 425                 if (k <= 0 &&
 426                     (k = write_to_console(level, file, line, func, buffer)) < 0)
 427                         return k;
 428
 429                 buffer = e;
 430         } while (buffer);
 431
 432         return r;
 433 }
 434
 435 int log_dump_internal(
 436         int level,
 437         const char*file,
 438         int line,
 439         const char *func,
 440         char *buffer) {
 441
 442         int saved_errno, r;
 443
 444         /* This modifies the buffer... */
 445
 446         if (_likely_(LOG_PRI(level) > log_max_level))
 447                 return 0;
 448
 449         saved_errno = errno;
 450         r = log_dispatch(level, file, line, func, buffer);
 451         errno = saved_errno;
 452
 453         return r;
 454 }
 455
 456 int log_meta(
 457         int level,
 458         const char*file,
 459         int line,
 460         const char *func,
 461         const char *format, ...) {
 462
 463         char buffer[LINE_MAX];
 464         int saved_errno, r;
 465         va_list ap;
 466
 467         if (_likely_(LOG_PRI(level) > log_max_level))
 468                 return 0;
 469
 470         saved_errno = errno;
 471
 472         va_start(ap, format);
 473         vsnprintf(buffer, sizeof(buffer), format, ap);
 474         va_end(ap);
 475
 476         char_array_0(buffer);
 477
 478         r = log_dispatch(level, file, line, func, buffer);
 479         errno = saved_errno;
 480
 481         return r;
 482 }
 483
 484 void log_assert(
 485         const char*file,
 486         int line,
 487         const char *func,
 488         const char *format, ...) {
 489
 490         static char buffer[LINE_MAX];
 491         int saved_errno = errno;
 492         va_list ap;
 493
 494         va_start(ap, format);
 495         vsnprintf(buffer, sizeof(buffer), format, ap);
 496         va_end(ap);
 497
 498         char_array_0(buffer);
 499         log_abort_msg = buffer;
 500
 501         log_dispatch(LOG_CRIT, file, line, func, buffer);
 502         abort();
 503
 504         /* If the user chose to ignore this SIGABRT, we are happy to go on, as if nothing happened. */
 505         errno = saved_errno;
 506 }
 507
 508 int log_set_target_from_string(const char *e) {
 509         LogTarget t;
 510
 511         if ((t = log_target_from_string(e)) < 0)
 512                 return -EINVAL;
 513
 514         log_set_target(t);
 515         return 0;
 516 }
 517
 518 int log_set_max_level_from_string(const char *e) {
 519         int t;
 520
 521         if ((t = log_level_from_string(e)) < 0)
 522                 return -EINVAL;
 523
 524         log_set_max_level(t);
 525         return 0;
 526 }
 527
 528 void log_parse_environment(void) {
 529         const char *e;
 530
 531         if ((e = getenv("SYSTEMD_LOG_TARGET")))
 532                 if (log_set_target_from_string(e) < 0)
 533                         log_warning("Failed to parse log target %s. Ignoring.", e);
 534
 535         if ((e = getenv("SYSTEMD_LOG_LEVEL")))
 536                 if (log_set_max_level_from_string(e) < 0)
 537                         log_warning("Failed to parse log level %s. Ignoring.", e);
 538
 539         if ((e = getenv("SYSTEMD_LOG_COLOR")))
 540                 if (log_show_color_from_string(e) < 0)
 541                         log_warning("Failed to parse bool %s. Ignoring.", e);
 542
 543         if ((e = getenv("SYSTEMD_LOG_LOCATION")))
 544                 if (log_show_location_from_string(e) < 0)
 545                         log_warning("Failed to parse bool %s. Ignoring.", e);
 546 }
 547
 548 LogTarget log_get_target(void) {
 549         return log_target;
 550 }
 551
 552 int log_get_max_level(void) {
 553         return log_max_level;
 554 }
 555
 556 void log_show_color(bool b) {
 557         show_color = b;
 558 }
 559
 560 void log_show_location(bool b) {
 561         show_location = b;
 562 }
 563
 564 int log_show_color_from_string(const char *e) {
 565         int t;
 566
 567         if ((t = parse_boolean(e)) < 0)
 568                 return -EINVAL;
 569
 570         log_show_color(t);
 571         return 0;
 572 }
 573
 574 int log_show_location_from_string(const char *e) {
 575         int t;
 576
 577         if ((t = parse_boolean(e)) < 0)
 578                 return -EINVAL;
 579
 580         log_show_location(t);
 581         return 0;
 582 }
 583
 584 static const char *const log_target_table[] = {
 585         [LOG_TARGET_CONSOLE] = "console",
 586         [LOG_TARGET_SYSLOG] = "syslog",
 587         [LOG_TARGET_KMSG] = "kmsg",
 588         [LOG_TARGET_SYSLOG_OR_KMSG] = "syslog-or-kmsg",
 589         [LOG_TARGET_NULL] = "null",
 590         [LOG_TARGET_AUTO] = "auto"
 591 };
 592
 593 DEFINE_STRING_TABLE_LOOKUP(log_target, LogTarget);