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_set_max_level(int level) {
 235         assert((level & LOG_PRIMASK) == level);
 236
 237         log_max_level = level;
 238 }
 239
 240 static int write_to_console(
 241                 int level,
 242                 const char*file,
 243                 int line,
 244                 const char *func,
 245                 const char *buffer) {
 246
 247         char location[64];
 248         struct iovec iovec[5];
 249         unsigned n = 0;
 250         bool highlight;
 251
 252         if (console_fd < 0)
 253                 return 0;
 254
 255         snprintf(location, sizeof(location), "(%s:%u) ", file, line);
 256         char_array_0(location);
 257
 258         highlight = LOG_PRI(level) <= LOG_ERR && show_color;
 259
 260         zero(iovec);
 261         if (show_location)
 262                 IOVEC_SET_STRING(iovec[n++], location);
 263         if (highlight)
 264                 IOVEC_SET_STRING(iovec[n++], ANSI_HIGHLIGHT_ON);
 265         IOVEC_SET_STRING(iovec[n++], buffer);
 266         if (highlight)
 267                 IOVEC_SET_STRING(iovec[n++], ANSI_HIGHLIGHT_OFF);
 268         IOVEC_SET_STRING(iovec[n++], "\n");
 269
 270         if (writev(console_fd, iovec, n) < 0)
 271                 return -errno;
 272
 273         return 1;
 274 }
 275
 276 static int write_to_syslog(
 277         int level,
 278         const char*file,
 279         int line,
 280         const char *func,
 281         const char *buffer) {
 282
 283         char header_priority[16], header_time[64], header_pid[16];
 284         struct iovec iovec[5];
 285         struct msghdr msghdr;
 286         time_t t;
 287         struct tm *tm;
 288
 289         if (syslog_fd < 0)
 290                 return 0;
 291
 292         snprintf(header_priority, sizeof(header_priority), "<%i>", level);
 293         char_array_0(header_priority);
 294
 295         t = (time_t) (now(CLOCK_REALTIME) / USEC_PER_SEC);
 296         if (!(tm = localtime(&t)))
 297                 return -EINVAL;
 298
 299         if (strftime(header_time, sizeof(header_time), "%h %e %T ", tm) <= 0)
 300                 return -EINVAL;
 301
 302         snprintf(header_pid, sizeof(header_pid), "[%lu]: ", (unsigned long) getpid());
 303         char_array_0(header_pid);
 304
 305         zero(iovec);
 306         IOVEC_SET_STRING(iovec[0], header_priority);
 307         IOVEC_SET_STRING(iovec[1], header_time);
 308         IOVEC_SET_STRING(iovec[2], program_invocation_short_name);
 309         IOVEC_SET_STRING(iovec[3], header_pid);
 310         IOVEC_SET_STRING(iovec[4], buffer);
 311
 312         /* When using syslog via SOCK_STREAM separate the messages by NUL chars */
 313         if (syslog_is_stream)
 314                 iovec[4].iov_len++;
 315
 316         zero(msghdr);
 317         msghdr.msg_iov = iovec;
 318         msghdr.msg_iovlen = ELEMENTSOF(iovec);
 319
 320         for (;;) {
 321                 ssize_t n;
 322
 323                 if ((n = sendmsg(syslog_fd, &msghdr, MSG_NOSIGNAL)) < 0)
 324                         return -errno;
 325
 326                 if (!syslog_is_stream ||
 327                     (size_t) n >= IOVEC_TOTAL_SIZE(iovec, ELEMENTSOF(iovec)))
 328                         break;
 329
 330                 IOVEC_INCREMENT(iovec, ELEMENTSOF(iovec), n);
 331         }
 332
 333         return 1;
 334 }
 335
 336 static int write_to_kmsg(
 337         int level,
 338         const char*file,
 339         int line,
 340         const char *func,
 341         const char *buffer) {
 342
 343         char header_priority[16], header_pid[16];
 344         struct iovec iovec[5];
 345
 346         if (kmsg_fd < 0)
 347                 return 0;
 348
 349         snprintf(header_priority, sizeof(header_priority), "<%i>", level);
 350         char_array_0(header_priority);
 351
 352         snprintf(header_pid, sizeof(header_pid), "[%lu]: ", (unsigned long) getpid());
 353         char_array_0(header_pid);
 354
 355         zero(iovec);
 356         IOVEC_SET_STRING(iovec[0], header_priority);
 357         IOVEC_SET_STRING(iovec[1], program_invocation_short_name);
 358         IOVEC_SET_STRING(iovec[2], header_pid);
 359         IOVEC_SET_STRING(iovec[3], buffer);
 360         IOVEC_SET_STRING(iovec[4], "\n");
 361
 362         if (writev(kmsg_fd, iovec, ELEMENTSOF(iovec)) < 0)
 363                 return -errno;
 364
 365         return 1;
 366 }
 367
 368 static int log_dispatch(
 369         int level,
 370         const char*file,
 371         int line,
 372         const char *func,
 373         char *buffer) {
 374
 375         int r = 0;
 376
 377         if (log_target == LOG_TARGET_NULL)
 378                 return 0;
 379
 380         /* Patch in LOG_DAEMON facility if necessary */
 381         if ((level & LOG_FACMASK) == 0)
 382                 level = LOG_DAEMON | LOG_PRI(level);
 383
 384         do {
 385                 char *e;
 386                 int k = 0;
 387
 388                 buffer += strspn(buffer, NEWLINE);
 389
 390                 if (buffer[0] == 0)
 391                         break;
 392
 393                 if ((e = strpbrk(buffer, NEWLINE)))
 394                         *(e++) = 0;
 395
 396                 if (log_target == LOG_TARGET_AUTO ||
 397                     log_target == LOG_TARGET_SYSLOG_OR_KMSG ||
 398                     log_target == LOG_TARGET_SYSLOG) {
 399
 400                         if ((k = write_to_syslog(level, file, line, func, buffer)) < 0) {
 401                                 log_close_syslog();
 402                                 log_open_kmsg();
 403                         } else if (k > 0)
 404                                 r++;
 405                 }
 406
 407                 if (k <= 0 &&
 408                     (log_target == LOG_TARGET_AUTO ||
 409                      log_target == LOG_TARGET_SYSLOG_OR_KMSG ||
 410                      log_target == LOG_TARGET_KMSG)) {
 411
 412                         if ((k = write_to_kmsg(level, file, line, func, buffer)) < 0) {
 413                                 log_close_kmsg();
 414                                 log_open_console();
 415                         } else if (k > 0)
 416                                 r++;
 417                 }
 418
 419                 if (k <= 0 &&
 420                     (k = write_to_console(level, file, line, func, buffer)) < 0)
 421                         return k;
 422
 423                 buffer = e;
 424         } while (buffer);
 425
 426         return r;
 427 }
 428
 429 int log_dump_internal(
 430         int level,
 431         const char*file,
 432         int line,
 433         const char *func,
 434         char *buffer) {
 435
 436         int saved_errno, r;
 437
 438         /* This modifies the buffer... */
 439
 440         if (_likely_(LOG_PRI(level) > log_max_level))
 441                 return 0;
 442
 443         saved_errno = errno;
 444         r = log_dispatch(level, file, line, func, buffer);
 445         errno = saved_errno;
 446
 447         return r;
 448 }
 449
 450 int log_meta(
 451         int level,
 452         const char*file,
 453         int line,
 454         const char *func,
 455         const char *format, ...) {
 456
 457         char buffer[LINE_MAX];
 458         int saved_errno, r;
 459         va_list ap;
 460
 461         if (_likely_(LOG_PRI(level) > log_max_level))
 462                 return 0;
 463
 464         saved_errno = errno;
 465
 466         va_start(ap, format);
 467         vsnprintf(buffer, sizeof(buffer), format, ap);
 468         va_end(ap);
 469
 470         char_array_0(buffer);
 471
 472         r = log_dispatch(level, file, line, func, buffer);
 473         errno = saved_errno;
 474
 475         return r;
 476 }
 477
 478 void log_assert(
 479         const char*file,
 480         int line,
 481         const char *func,
 482         const char *format, ...) {
 483
 484         static char buffer[LINE_MAX];
 485         int saved_errno = errno;
 486         va_list ap;
 487
 488         va_start(ap, format);
 489         vsnprintf(buffer, sizeof(buffer), format, ap);
 490         va_end(ap);
 491
 492         char_array_0(buffer);
 493         log_abort_msg = buffer;
 494
 495         log_dispatch(LOG_CRIT, file, line, func, buffer);
 496         abort();
 497
 498         /* If the user chose to ignore this SIGABRT, we are happy to go on, as if nothing happened. */
 499         errno = saved_errno;
 500 }
 501
 502 int log_set_target_from_string(const char *e) {
 503         LogTarget t;
 504
 505         if ((t = log_target_from_string(e)) < 0)
 506                 return -EINVAL;
 507
 508         log_set_target(t);
 509         return 0;
 510 }
 511
 512 int log_set_max_level_from_string(const char *e) {
 513         int t;
 514
 515         if ((t = log_level_from_string(e)) < 0)
 516                 return -EINVAL;
 517
 518         log_set_max_level(t);
 519         return 0;
 520 }
 521
 522 void log_parse_environment(void) {
 523         const char *e;
 524
 525         if ((e = getenv("SYSTEMD_LOG_TARGET")))
 526                 if (log_set_target_from_string(e) < 0)
 527                         log_warning("Failed to parse log target %s. Ignoring.", e);
 528
 529         if ((e = getenv("SYSTEMD_LOG_LEVEL")))
 530                 if (log_set_max_level_from_string(e) < 0)
 531                         log_warning("Failed to parse log level %s. Ignoring.", e);
 532
 533         if ((e = getenv("SYSTEMD_LOG_COLOR")))
 534                 if (log_show_color_from_string(e) < 0)
 535                         log_warning("Failed to parse bool %s. Ignoring.", e);
 536
 537         if ((e = getenv("SYSTEMD_LOG_LOCATION")))
 538                 if (log_show_location_from_string(e) < 0)
 539                         log_warning("Failed to parse bool %s. Ignoring.", e);
 540 }
 541
 542 LogTarget log_get_target(void) {
 543         return log_target;
 544 }
 545
 546 int log_get_max_level(void) {
 547         return log_max_level;
 548 }
 549
 550 void log_show_color(bool b) {
 551         show_color = b;
 552 }
 553
 554 void log_show_location(bool b) {
 555         show_location = b;
 556 }
 557
 558 int log_show_color_from_string(const char *e) {
 559         int t;
 560
 561         if ((t = parse_boolean(e)) < 0)
 562                 return -EINVAL;
 563
 564         log_show_color(t);
 565         return 0;
 566 }
 567
 568 int log_show_location_from_string(const char *e) {
 569         int t;
 570
 571         if ((t = parse_boolean(e)) < 0)
 572                 return -EINVAL;
 573
 574         log_show_location(t);
 575         return 0;
 576 }
 577
 578 static const char *const log_target_table[] = {
 579         [LOG_TARGET_CONSOLE] = "console",
 580         [LOG_TARGET_SYSLOG] = "syslog",
 581         [LOG_TARGET_KMSG] = "kmsg",
 582         [LOG_TARGET_SYSLOG_OR_KMSG] = "syslog-or-kmsg",
 583         [LOG_TARGET_NULL] = "null",
 584         [LOG_TARGET_AUTO] = "auto"
 585 };
 586
 587 DEFINE_STRING_TABLE_LOOKUP(log_target, LogTarget);