src/log.c

   1 /*-*- Mode: C; c-basic-offset: 8 -*-*/
   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 #define LOG_BUFFER_MAX 1024
  36
  37 static LogTarget log_target = LOG_TARGET_CONSOLE;
  38 static int log_max_level = LOG_DEBUG;
  39
  40 static int console_fd = STDERR_FILENO;
  41 static int syslog_fd = -1;
  42 static int kmsg_fd = -1;
  43
  44 /* Akin to glibc's __abort_msg; which is private and we hance cannot
  45  * use here. */
  46 static char *log_abort_msg = NULL;
  47
  48 void log_close_console(void) {
  49
  50         if (console_fd < 0)
  51                 return;
  52
  53         if (getpid() == 1) {
  54                 if (console_fd >= 3)
  55                         close_nointr_nofail(console_fd);
  56
  57                 console_fd = -1;
  58         }
  59 }
  60
  61 static int log_open_console(void) {
  62
  63         if (console_fd >= 0)
  64                 return 0;
  65
  66         if (getpid() == 1) {
  67
  68                 if ((console_fd = open_terminal("/dev/console", O_WRONLY|O_NOCTTY|O_CLOEXEC)) < 0) {
  69                         log_error("Failed to open /dev/console for logging: %s", strerror(-console_fd));
  70                         return console_fd;
  71                 }
  72
  73                 log_info("Succesfully opened /dev/console for logging.");
  74         } else
  75                 console_fd = STDERR_FILENO;
  76
  77         return 0;
  78 }
  79
  80 void log_close_kmsg(void) {
  81
  82         if (kmsg_fd < 0)
  83                 return;
  84
  85         close_nointr_nofail(kmsg_fd);
  86         kmsg_fd = -1;
  87 }
  88
  89 static int log_open_kmsg(void) {
  90
  91         if (kmsg_fd >= 0)
  92                 return 0;
  93
  94         if ((kmsg_fd = open("/dev/kmsg", O_WRONLY|O_NOCTTY|O_CLOEXEC)) < 0) {
  95                 log_info("Failed to open /dev/kmsg for logging: %s", strerror(errno));
  96                 return -errno;
  97         }
  98
  99         log_info("Succesfully opened /dev/kmsg for logging.");
 100
 101         return 0;
 102 }
 103
 104 void log_close_syslog(void) {
 105
 106         if (syslog_fd < 0)
 107                 return;
 108
 109         close_nointr_nofail(syslog_fd);
 110         syslog_fd = -1;
 111 }
 112
 113 static int log_open_syslog(void) {
 114         union {
 115                 struct sockaddr sa;
 116                 struct sockaddr_un un;
 117         } sa;
 118         struct timeval tv;
 119         int r;
 120
 121         if (syslog_fd >= 0)
 122                 return 0;
 123
 124         if ((syslog_fd = socket(AF_UNIX, SOCK_DGRAM|SOCK_CLOEXEC, 0)) < 0) {
 125                 r = -errno;
 126                 goto fail;
 127         }
 128
 129         /* Make sure we don't block for more than 5s when talking to
 130          * syslog */
 131         timeval_store(&tv, SYSLOG_TIMEOUT_USEC);
 132         if (setsockopt(syslog_fd, SOL_SOCKET, SO_SNDTIMEO, &tv, sizeof(tv)) < 0) {
 133                 r = -errno;
 134                 goto fail;
 135         }
 136
 137         zero(sa);
 138         sa.un.sun_family = AF_UNIX;
 139         strncpy(sa.un.sun_path, "/dev/log", sizeof(sa.un.sun_path));
 140
 141         if (connect(syslog_fd, &sa.sa, sizeof(sa)) < 0) {
 142                 r = -errno;
 143                 goto fail;
 144         }
 145
 146         log_info("Succesfully opened syslog for logging.");
 147
 148         return 0;
 149
 150 fail:
 151         log_close_syslog();
 152         log_info("Failed to open syslog for logging: %s", strerror(-r));
 153         return r;
 154 }
 155
 156 int log_open(void) {
 157         int r;
 158
 159         /* If we don't use the console we close it here, to not get
 160          * killed by SAK. If we don't use syslog we close it here so
 161          * that we are not confused by somebody deleting the socket in
 162          * the fs. If we don't use /dev/kmsg we still keep it open,
 163          * because there is no reason to close it. */
 164
 165         if (log_target == LOG_TARGET_SYSLOG_OR_KMSG ||
 166             log_target == LOG_TARGET_SYSLOG)
 167                 if ((r = log_open_syslog()) >= 0) {
 168                         log_close_console();
 169                         return r;
 170                 }
 171
 172         if (log_target == LOG_TARGET_SYSLOG_OR_KMSG ||
 173             log_target == LOG_TARGET_KMSG)
 174                 if ((r = log_open_kmsg()) >= 0) {
 175                         log_close_syslog();
 176                         log_close_console();
 177                         return r;
 178                 }
 179
 180         log_close_syslog();
 181         return log_open_console();
 182 }
 183
 184 void log_set_target(LogTarget target) {
 185         assert(target >= 0);
 186         assert(target < _LOG_TARGET_MAX);
 187
 188         log_target = target;
 189 }
 190
 191 void log_set_max_level(int level) {
 192         assert((level & LOG_PRIMASK) == level);
 193
 194         log_max_level = level;
 195 }
 196
 197 static int write_to_console(
 198         int level,
 199         const char*file,
 200         int line,
 201         const char *func,
 202         const char *buffer) {
 203
 204         char location[64];
 205         struct iovec iovec[5];
 206         unsigned n = 0;
 207         bool highlight;
 208
 209         if (console_fd < 0)
 210                 return 0;
 211
 212         snprintf(location, sizeof(location), "(%s:%u) ", file, line);
 213         char_array_0(location);
 214
 215         highlight = LOG_PRI(level) <= LOG_ERR;
 216
 217         zero(iovec);
 218         IOVEC_SET_STRING(iovec[n++], location);
 219         if (highlight)
 220                 IOVEC_SET_STRING(iovec[n++], "\x1B[1;31m");
 221         IOVEC_SET_STRING(iovec[n++], buffer);
 222         if (highlight)
 223                 IOVEC_SET_STRING(iovec[n++], "\x1B[0m");
 224         IOVEC_SET_STRING(iovec[n++], "\n");
 225
 226         if (writev(console_fd, iovec, n) < 0)
 227                 return -errno;
 228
 229         return 1;
 230 }
 231
 232 static int write_to_syslog(
 233         int level,
 234         const char*file,
 235         int line,
 236         const char *func,
 237         const char *buffer) {
 238
 239         char header_priority[16], header_time[64], header_pid[16];
 240         struct iovec iovec[5];
 241         struct msghdr msghdr;
 242         time_t t;
 243         struct tm *tm;
 244
 245         if (syslog_fd < 0)
 246                 return 0;
 247
 248         snprintf(header_priority, sizeof(header_priority), "<%i>", LOG_MAKEPRI(LOG_DAEMON, LOG_PRI(level)));
 249         char_array_0(header_priority);
 250
 251         t = (time_t) (now(CLOCK_REALTIME) / USEC_PER_SEC);
 252         if (!(tm = localtime(&t)))
 253                 return -EINVAL;
 254
 255         if (strftime(header_time, sizeof(header_time), "%h %e %T ", tm) <= 0)
 256                 return -EINVAL;
 257
 258         snprintf(header_pid, sizeof(header_pid), "[%llu]: ", (unsigned long long) getpid());
 259         char_array_0(header_pid);
 260
 261         zero(iovec);
 262         IOVEC_SET_STRING(iovec[0], header_priority);
 263         IOVEC_SET_STRING(iovec[1], header_time);
 264         IOVEC_SET_STRING(iovec[2], __progname);
 265         IOVEC_SET_STRING(iovec[3], header_pid);
 266         IOVEC_SET_STRING(iovec[4], buffer);
 267
 268         zero(msghdr);
 269         msghdr.msg_iov = iovec;
 270         msghdr.msg_iovlen = ELEMENTSOF(iovec);
 271
 272         if (sendmsg(syslog_fd, &msghdr, 0) < 0)
 273                 return -errno;
 274
 275         return 1;
 276 }
 277
 278 static int write_to_kmsg(
 279         int level,
 280         const char*file,
 281         int line,
 282         const char *func,
 283         const char *buffer) {
 284
 285         char header_priority[16], header_pid[16];
 286         struct iovec iovec[5];
 287
 288         if (kmsg_fd < 0)
 289                 return 0;
 290
 291         snprintf(header_priority, sizeof(header_priority), "<%i>", LOG_PRI(level));
 292         char_array_0(header_priority);
 293
 294         snprintf(header_pid, sizeof(header_pid), "[%llu]: ", (unsigned long long) getpid());
 295         char_array_0(header_pid);
 296
 297         zero(iovec);
 298         IOVEC_SET_STRING(iovec[0], header_priority);
 299         IOVEC_SET_STRING(iovec[1], __progname);
 300         IOVEC_SET_STRING(iovec[2], header_pid);
 301         IOVEC_SET_STRING(iovec[3], buffer);
 302         IOVEC_SET_STRING(iovec[4], "\n");
 303
 304         if (writev(kmsg_fd, iovec, ELEMENTSOF(iovec)) < 0)
 305                 return -errno;
 306
 307         return 1;
 308 }
 309
 310 static int log_dispatch(
 311         int level,
 312         const char*file,
 313         int line,
 314         const char *func,
 315         const char *buffer) {
 316
 317         int r;
 318
 319         if (log_target == LOG_TARGET_SYSLOG_OR_KMSG ||
 320             log_target == LOG_TARGET_SYSLOG) {
 321
 322                 if ((r = write_to_syslog(level, file, line, func, buffer)) < 0) {
 323                         log_close_syslog();
 324                         log_open_kmsg();
 325                 } else if (r > 0)
 326                         return r;
 327         }
 328
 329         if (log_target == LOG_TARGET_SYSLOG_OR_KMSG ||
 330             log_target == LOG_TARGET_KMSG) {
 331
 332                 if ((r = write_to_kmsg(level, file, line, func, buffer)) < 0) {
 333                         log_close_kmsg();
 334                         log_open_console();
 335                 } else if (r > 0)
 336                         return r;
 337         }
 338
 339         return write_to_console(level, file, line, func, buffer);
 340 }
 341
 342 int log_meta(
 343         int level,
 344         const char*file,
 345         int line,
 346         const char *func,
 347         const char *format, ...) {
 348
 349         char buffer[LOG_BUFFER_MAX];
 350         int saved_errno, r;
 351         va_list ap;
 352
 353         if (_likely(LOG_PRI(level) > log_max_level))
 354                 return 0;
 355
 356         saved_errno = errno;
 357
 358         va_start(ap, format);
 359         vsnprintf(buffer, sizeof(buffer), format, ap);
 360         va_end(ap);
 361
 362         char_array_0(buffer);
 363
 364         r = log_dispatch(level, file, line, func, buffer);
 365         errno = saved_errno;
 366
 367         return r;
 368 }
 369
 370 void log_assert(
 371         const char*file,
 372         int line,
 373         const char *func,
 374         const char *format, ...) {
 375
 376         static char buffer[LOG_BUFFER_MAX];
 377         int saved_errno = errno;
 378         va_list ap;
 379
 380         va_start(ap, format);
 381         vsnprintf(buffer, sizeof(buffer), format, ap);
 382         va_end(ap);
 383
 384         char_array_0(buffer);
 385         log_abort_msg = buffer;
 386
 387         log_dispatch(LOG_CRIT, file, line, func, buffer);
 388         abort();
 389
 390         /* If the user chose to ignore this SIGABRT, we are happy to go on, as if nothing happened. */
 391         errno = saved_errno;
 392 }
 393
 394 int log_set_target_from_string(const char *e) {
 395         LogTarget t;
 396
 397         if ((t = log_target_from_string(e)) < 0)
 398                 return -EINVAL;
 399
 400         log_set_target(t);
 401         return 0;
 402 }
 403
 404 int log_set_max_level_from_string(const char *e) {
 405         int t;
 406
 407         if ((t = log_level_from_string(e)) < 0)
 408                 return -EINVAL;
 409
 410         log_set_max_level(t);
 411         return 0;
 412 }
 413
 414 void log_parse_environment(void) {
 415         const char *e;
 416
 417         if ((e = getenv("SYSTEMD_LOG_TARGET")))
 418                 if (log_set_target_from_string(e) < 0)
 419                         log_warning("Failed to parse log target %s. Ignoring.", e);
 420
 421         if ((e = getenv("SYSTEMD_LOG_LEVEL")))
 422                 if (log_set_max_level_from_string(e) < 0)
 423                         log_warning("Failed to parse log level %s. Ignoring.", e);
 424 }
 425
 426 LogTarget log_get_target(void) {
 427         return log_target;
 428 }
 429
 430 int log_get_max_level(void) {
 431         return log_max_level;
 432 }
 433
 434 static const char *const log_target_table[] = {
 435         [LOG_TARGET_CONSOLE] = "console",
 436         [LOG_TARGET_SYSLOG] = "syslog",
 437         [LOG_TARGET_KMSG] = "kmsg",
 438         [LOG_TARGET_SYSLOG_OR_KMSG] = "syslog-or-kmsg",
 439 };
 440
 441 DEFINE_STRING_TABLE_LOOKUP(log_target, LogTarget);