src/dinit-log.cc

   1 #include <iostream>
   2 #include <algorithm>
   3
   4 #include <unistd.h>
   5 #include <fcntl.h>
   6 #include <sys/syslog.h>
   7 #include <sys/uio.h>
   8
   9 #include "dasynq.h"
  10
  11 #include "service.h"
  12 #include "dinit-log.h"
  13 #include "cpbuffer.h"
  14
  15 // Dinit logging subsystem.
  16 //
  17 // Note that most actual functions for logging messages are found in the header, dinit-log.h.
  18 //
  19 // We have two separate log "streams": one for the console/stdout, one for the syslog facility. Both have a
  20 // circular buffer. Log messages are appended to the circular buffer (for the syslog stream, the messages
  21 // are prepended with a syslog priority indicator). Both streams start out inactive (release = true in
  22 // buffered_log_stream), which means they will buffer messages but not write them.
  23 //
  24 // The console log stream needs to be able to release the console, if a service is waiting to acquire it.
  25 // This is accomplished by calling flush_for_release() which then completes the output of the current
  26 // message (if any) and then assigns the console to a waiting service.
  27
  28 extern eventloop_t event_loop;
  29
  30 static bool log_current_line[2];  // Whether the current line is being logged (for console, main log)
  31 loglevel_t log_level[2] = { loglevel_t::WARN, loglevel_t::INFO };
  32 static bool log_format_syslog[2] = { false, true };
  33
  34 static service_set *services = nullptr;  // Reference to service set
  35
  36 using rearm = dasynq::rearm;
  37
  38 namespace {
  39 class buffered_log_stream : public eventloop_t::fd_watcher_impl<buffered_log_stream>
  40 {
  41     private:
  42
  43     // Outgoing:
  44     bool partway = false;     // if we are partway throught output of a log message
  45     bool discarded = false;   // if we have discarded a message
  46     bool release = true;      // if we should inhibit output and release console
  47
  48     // A "special message" is not stored in the circular buffer; instead
  49     // it is delivered from an external buffer not managed by BufferedLogger.
  50     bool special = false;      // currently outputting special message?
  51     const char *special_buf; // buffer containing special message
  52     int msg_index;     // index into special message
  53
  54     cpbuffer<4096> log_buffer;
  55
  56     public:
  57
  58     // Incoming:
  59     int current_index = 0;    // current/next incoming message index
  60
  61     int fd = -1;
  62
  63     void init(int fd)
  64     {
  65         this->fd = fd;
  66         release = false;
  67     }
  68
  69     rearm fd_event(eventloop_t &loop, int fd, int flags) noexcept;
  70
  71     // Check whether the console can be released.
  72     void flush_for_release();
  73     bool is_release_set() { return release; }
  74
  75     // Commit a log message
  76     void commit_msg()
  77     {
  78         bool was_first = current_index == 0;
  79         current_index = log_buffer.get_length();
  80         if (was_first && ! release) {
  81             set_enabled(event_loop, true);
  82         }
  83     }
  84
  85     void rollback_msg()
  86     {
  87         log_buffer.trim_to(current_index);
  88     }
  89
  90     int get_free()
  91     {
  92         return log_buffer.get_free();
  93     }
  94
  95     void append(const char *s, size_t len)
  96     {
  97         log_buffer.append(s, len);
  98     }
  99
 100     // Discard buffer; call only when the stream isn't active.
 101     void discard()
 102     {
 103         current_index = 0;
 104         log_buffer.trim_to(0);
 105     }
 106
 107     // Mark that a message was discarded due to full buffer
 108     void mark_discarded()
 109     {
 110         discarded = true;
 111     }
 112
 113     private:
 114     void release_console();
 115 };
 116 }
 117
 118 // Two log streams:
 119 // (One for main log, one for console)
 120 static buffered_log_stream log_stream[2];
 121
 122 constexpr static int DLOG_MAIN = 0; // main log facility
 123 constexpr static int DLOG_CONS = 1; // console
 124
 125 void buffered_log_stream::release_console()
 126 {
 127     if (release) {
 128         int flags = fcntl(1, F_GETFL, 0);
 129         fcntl(1, F_SETFL, flags & ~O_NONBLOCK);
 130         services->pull_console_queue();
 131     }
 132 }
 133
 134 void buffered_log_stream::flush_for_release()
 135 {
 136     release = true;
 137
 138     // Try to flush any messages that are currently buffered. (Console is non-blocking
 139     // so it will fail gracefully).
 140     if (fd_event(event_loop, fd, dasynq::OUT_EVENTS) == rearm::DISARM) {
 141         // Console has already been released at this point.
 142         set_enabled(event_loop, false);
 143     }
 144     // fd_event didn't want to disarm, so must be partway through a message; will
 145     // release when it's finished.
 146 }
 147
 148 rearm buffered_log_stream::fd_event(eventloop_t &loop, int fd, int flags) noexcept
 149 {
 150     if ((! partway) && (! special) && discarded) {
 151         special_buf = "dinit: *** log message discarded due to full buffer ***\n";
 152         msg_index = 0;
 153     }
 154
 155     if ((! partway) && special) {
 156         const char * start = special_buf + msg_index;
 157         const char * end = std::find(special_buf + msg_index, (const char *)nullptr, '\n');
 158         int r = write(fd, start, end - start + 1);
 159         if (r >= 0) {
 160             if (start + r > end) {
 161                 // All written: go on to next message in queue
 162                 special = false;
 163                 partway = false;
 164                 msg_index = 0;
 165
 166                 if (release) {
 167                     release_console();
 168                     return rearm::DISARM;
 169                 }
 170             }
 171             else {
 172                 msg_index += r;
 173                 return rearm::REARM;
 174             }
 175         }
 176         else if (errno != EAGAIN && errno != EINTR && errno != EWOULDBLOCK) {
 177             return rearm::REMOVE;
 178         }
 179         return rearm::REARM;
 180     }
 181     else {
 182         // Writing from the regular circular buffer
 183
 184         if (current_index == 0) {
 185             release_console();
 186             return rearm::DISARM;
 187         }
 188
 189         // We try to find a complete line (terminated by '\n') in the buffer, and write it
 190         // out. Since it may span the circular buffer end, it may consist of two distinct spans,
 191         // and so we use writev to write them atomically.
 192
 193         struct iovec logiov[2];
 194
 195         char *ptr = log_buffer.get_ptr(0);
 196         int len = log_buffer.get_contiguous_length(ptr);
 197         char *creptr = ptr + len;  // contiguous region end
 198         char *eptr = std::find(ptr, creptr, '\n');
 199
 200         bool will_complete = false;  // will complete this message?
 201         if (eptr != creptr) {
 202             eptr++;  // include '\n'
 203             will_complete = true;
 204         }
 205
 206         len = eptr - ptr;
 207
 208         logiov[0].iov_base = ptr;
 209         logiov[0].iov_len = len;
 210         int iovs_to_write = 1;
 211
 212         // Do we need the second span?
 213         if (! will_complete && len != log_buffer.get_length()) {
 214             ptr = log_buffer.get_buf_base();
 215             creptr = ptr + log_buffer.get_length() - len;
 216             eptr = std::find(ptr, creptr, '\n');
 217             if (eptr != creptr) {
 218                 eptr++; // include '\n'
 219                 // It should not ever be the case that we do not now have a complete message
 220                 will_complete = true;
 221             }
 222             logiov[1].iov_base = ptr;
 223             logiov[1].iov_len = eptr - ptr;
 224             len += logiov[1].iov_len;
 225             iovs_to_write = 2;
 226         }
 227
 228         ssize_t r = writev(fd, logiov, iovs_to_write);
 229
 230         if (r >= 0) {
 231             bool complete = (r == len) && will_complete;
 232             log_buffer.consume(len);
 233             partway = ! complete;
 234             if (complete) {
 235                 current_index -= len;
 236                 if (current_index == 0 || release) {
 237                     // No more messages buffered / stop logging to console:
 238                     release_console();
 239                     return rearm::DISARM;
 240                 }
 241             }
 242         }
 243         else if (errno != EAGAIN && errno != EINTR && errno != EWOULDBLOCK) {
 244             return rearm::REMOVE;
 245         }
 246     }
 247
 248     // We've written something by the time we get here. We could fall through to below, but
 249     // let's give other events a chance to be processed by returning now.
 250     return rearm::REARM;
 251 }
 252
 253 // Initialise the logging subsystem
 254 // Potentially throws std::bad_alloc or std::system_error
 255 void init_log(service_set *sset)
 256 {
 257     services = sset;
 258     log_stream[DLOG_CONS].add_watch(event_loop, STDOUT_FILENO, dasynq::OUT_EVENTS, false);
 259     enable_console_log(true);
 260 }
 261
 262 // Set up the main log to output to the given file descriptor.
 263 // Potentially throws std::bad_alloc or std::system_error
 264 void setup_main_log(int fd, bool syslog_format)
 265 {
 266     log_stream[DLOG_MAIN].init(fd);
 267     log_stream[DLOG_MAIN].add_watch(event_loop, fd, dasynq::OUT_EVENTS);
 268     log_format_syslog[DLOG_MAIN] = syslog_format;
 269 }
 270
 271 bool is_log_flushed() noexcept
 272 {
 273     return log_stream[DLOG_CONS].current_index == 0;
 274 }
 275
 276 // Enable or disable console logging. If disabled, console logging will be disabled on the
 277 // completion of output of the current message (if any), at which point the first service record
 278 // queued in the service set will acquire the console.
 279 void enable_console_log(bool enable) noexcept
 280 {
 281     bool log_to_console = ! log_stream[DLOG_CONS].is_release_set();
 282     if (enable && ! log_to_console) {
 283         // Set non-blocking IO:
 284         int flags = fcntl(STDOUT_FILENO, F_GETFL, 0);
 285         fcntl(STDOUT_FILENO, F_SETFL, flags | O_NONBLOCK);
 286         // Activate watcher:
 287         log_stream[DLOG_CONS].init(STDOUT_FILENO);
 288         log_stream[DLOG_CONS].set_enabled(event_loop, true);
 289     }
 290     else if (! enable && log_to_console) {
 291         log_stream[DLOG_CONS].flush_for_release();
 292     }
 293 }
 294
 295 void discard_console_log_buffer() noexcept
 296 {
 297     log_stream[DLOG_CONS].discard();
 298 }
 299
 300 // Variadic method to calculate the sum of string lengths:
 301 static int sum_length(const char *arg) noexcept
 302 {
 303     return std::strlen(arg);
 304 }
 305
 306 template <typename ... T> static int sum_length(const char * first, T ... args) noexcept
 307 {
 308     return sum_length(first) + sum_length(args...);
 309 }
 310
 311 // Variadic method to append strings to a buffer:
 312 static void append(buffered_log_stream &buf, const char *s)
 313 {
 314     buf.append(s, std::strlen(s));
 315 }
 316
 317 template <typename ... T> static void append(buffered_log_stream &buf, const char *u, T ... t)
 318 {
 319     append(buf, u);
 320     append(buf, t...);
 321 }
 322
 323 static int log_level_to_syslog_level(loglevel_t l)
 324 {
 325     switch (l) {
 326     case loglevel_t::DEBUG:
 327         return LOG_DEBUG;
 328     case loglevel_t::INFO:
 329         return LOG_INFO;
 330     case loglevel_t::WARN:
 331         return LOG_WARNING;
 332     case loglevel_t::ERROR:
 333         return LOG_ERR;
 334     default: ;
 335     }
 336
 337     return LOG_CRIT;
 338 }
 339
 340 // Variadic method to log a sequence of strings as a single message to a particular facility:
 341 template <typename ... T> static void push_to_log(int idx, T ... args) noexcept
 342 {
 343     if (! log_current_line[idx]) return;
 344     int amount = sum_length(args...);
 345     if (log_stream[idx].get_free() >= amount) {
 346         append(log_stream[idx], args...);
 347         log_stream[idx].commit_msg();
 348     }
 349     else {
 350         log_stream[idx].mark_discarded();
 351     }
 352 }
 353
 354 // Variadic method to potentially log a sequence of strings as a single message with the given log level:
 355 template <typename ... T> static void do_log(loglevel_t lvl, bool to_cons, T ... args) noexcept
 356 {
 357     log_current_line[DLOG_CONS] = (lvl >= log_level[DLOG_CONS]) && to_cons;
 358     log_current_line[DLOG_MAIN] = (lvl >= log_level[DLOG_MAIN]);
 359     push_to_log(DLOG_CONS, args...);
 360
 361     if (log_current_line[DLOG_MAIN]) {
 362         if (log_format_syslog[DLOG_MAIN]) {
 363             char svcbuf[10];
 364             snprintf(svcbuf, 10, "<%d>", LOG_DAEMON | log_level_to_syslog_level(lvl));
 365             push_to_log(DLOG_MAIN, svcbuf, args...);
 366         }
 367         else {
 368             push_to_log(DLOG_MAIN, args...);
 369         }
 370     }
 371 }
 372
 373 template <typename ... T> static void do_log_cons(T ... args) noexcept
 374 {
 375     log_current_line[DLOG_CONS] = true;
 376     log_current_line[DLOG_MAIN] = false;
 377     push_to_log(DLOG_CONS, args...);
 378 }
 379
 380 // Log to the main facility at NOTICE level
 381 template <typename ... T> static void do_log_main(T ... args) noexcept
 382 {
 383     log_current_line[DLOG_CONS] = false;
 384     log_current_line[DLOG_MAIN] = true;
 385
 386     if (log_format_syslog[DLOG_MAIN]) {
 387         char svcbuf[10];
 388         snprintf(svcbuf, 10, "<%d>", LOG_DAEMON | LOG_NOTICE);
 389         push_to_log(DLOG_MAIN, svcbuf, args...);
 390     }
 391     else {
 392         push_to_log(DLOG_MAIN, args...);
 393     }
 394 }
 395
 396 // Log a message. A newline will be appended.
 397 void log(loglevel_t lvl, const char *msg) noexcept
 398 {
 399     do_log(lvl, true, "dinit: ", msg, "\n");
 400 }
 401
 402 void log(loglevel_t lvl, bool to_cons, const char *msg) noexcept
 403 {
 404     do_log(lvl, to_cons, "dinit: ", msg, "\n");
 405 }
 406
 407 // Log part of a message. A series of calls to do_log_part must be followed by a call to do_log_commit.
 408 template <typename T> static void do_log_part(int idx, T arg) noexcept
 409 {
 410     if (log_current_line[idx]) {
 411         int amount = sum_length(arg);
 412         if (log_stream[idx].get_free() >= amount) {
 413             append(log_stream[idx], arg);
 414         }
 415         else {
 416             log_stream[idx].rollback_msg();
 417             log_current_line[idx] = false;
 418             log_stream[idx].mark_discarded();
 419         }
 420     }
 421 }
 422
 423 // Commit a message that was issued as a series of parts (via do_log_part).
 424 static void do_log_commit(int idx) noexcept
 425 {
 426     if (log_current_line[idx]) {
 427         log_stream[idx].commit_msg();
 428     }
 429 }
 430
 431 // Log a multi-part message beginning
 432 void log_msg_begin(loglevel_t lvl, const char *msg) noexcept
 433 {
 434     log_current_line[DLOG_CONS] = lvl >= log_level[DLOG_CONS];
 435     log_current_line[DLOG_MAIN] = lvl >= log_level[DLOG_MAIN];
 436
 437     // Prepend the syslog priority level string ("<N>") for the main log:
 438     if (log_current_line[DLOG_MAIN]) {
 439         if (log_format_syslog[DLOG_MAIN]) {
 440             char svcbuf[10];
 441             snprintf(svcbuf, 10, "<%d>", LOG_DAEMON | log_level_to_syslog_level(lvl));
 442             do_log_part(DLOG_MAIN, svcbuf);
 443         }
 444     }
 445
 446     for (int i = 0; i < 2; i++) {
 447         do_log_part(i, "dinit: ");
 448         do_log_part(i, msg);
 449     }
 450 }
 451
 452 // Continue a multi-part log message
 453 void log_msg_part(const char *msg) noexcept
 454 {
 455     do_log_part(DLOG_CONS, msg);
 456     do_log_part(DLOG_MAIN, msg);
 457 }
 458
 459 // Complete a multi-part log message
 460 void log_msg_end(const char *msg) noexcept
 461 {
 462     for (int i = 0; i < 2; i++) {
 463         do_log_part(i, msg);
 464         do_log_part(i, "\n");
 465         do_log_commit(i);
 466     }
 467 }
 468
 469 void log_service_started(const char *service_name) noexcept
 470 {
 471     do_log_cons("[  OK  ] ", service_name, "\n");
 472     do_log_main("dinit: service ", service_name, " started.\n");
 473 }
 474
 475 void log_service_failed(const char *service_name) noexcept
 476 {
 477     do_log_cons("[FAILED] ", service_name, "\n");
 478     do_log_main("dinit: service ", service_name, " failed to start.\n");
 479 }
 480
 481 void log_service_stopped(const char *service_name) noexcept
 482 {
 483     do_log_cons("[STOPPD] ", service_name, "\n");
 484     do_log_main("dinit: service ", service_name, " stopped.\n");
 485 }