More camelCase to under_score renaming.
[oweals/dinit.git] / src / dinit-log.cc
index 292e7805111b5e717c5effd252b64936e9e976aa..a67e5d3a5a01cc87a41cd295118353adfc65e79c 100644 (file)
 #include "dinit-log.h"
 #include "cpbuffer.h"
 
-extern EventLoop_t eventLoop;
+extern eventloop_t eventLoop;
 
 static bool log_current_line[2];  // Whether the current line is being logged (for console, main log)
-LogLevel log_level[2] = { LogLevel::WARN, LogLevel::WARN };
+loglevel_t log_level[2] = { loglevel_t::WARN, loglevel_t::WARN };
 
-static ServiceSet *service_set = nullptr;  // Reference to service set
+static service_set *services = nullptr;  // Reference to service set
 
 namespace {
-class BufferedLogStream : public EventLoop_t::FdWatcher
+class BufferedLogStream : public eventloop_t::fd_watcher_impl<BufferedLogStream>
 {
     private:
 
@@ -32,10 +32,10 @@ class BufferedLogStream : public EventLoop_t::FdWatcher
     // A "special message" is not stored in the circular buffer; instead
     // it is delivered from an external buffer not managed by BufferedLogger.
     bool special = false;      // currently outputting special message?
-    char *special_buf; // buffer containing special message
+    const char *special_buf; // buffer containing special message
     int msg_index;     // index into special message
 
-    CPBuffer<4096> log_buffer;
+    cpbuffer<4096> log_buffer;
     
     public:
     
@@ -50,7 +50,7 @@ class BufferedLogStream : public EventLoop_t::FdWatcher
         release = false;
     }
     
-    Rearm fdEvent(EventLoop_t &loop, int fd, int flags) noexcept override;
+    rearm fd_event(eventloop_t &loop, int fd, int flags) noexcept;
 
     // Check whether the console can be released.
     void flushForRelease();
@@ -63,7 +63,7 @@ class BufferedLogStream : public EventLoop_t::FdWatcher
         bool was_first = current_index == 0;
         current_index = log_buffer.get_length();
         if (was_first && ! release) {
-            setEnabled(eventLoop, true);
+            set_enabled(eventLoop, true);
         }
     }
     
@@ -81,6 +81,19 @@ class BufferedLogStream : public EventLoop_t::FdWatcher
     {
         log_buffer.append(s, len);
     }
+    
+    // Discard buffer; call only when the stream isn't active.
+    void discard()
+    {
+        current_index = 0;
+        log_buffer.trim_to(0);
+    }
+
+    // Mark that a message was discarded due to full buffer
+    void mark_discarded()
+    {
+        discarded = true;
+    }
 };
 }
 
@@ -96,7 +109,7 @@ void BufferedLogStream::release_console()
     if (release) {
         int flags = fcntl(1, F_GETFL, 0);
         fcntl(1, F_SETFL, flags & ~O_NONBLOCK);
-        service_set->pullConsoleQueue();
+        services->pull_console_queue();
     }
 }
 
@@ -106,52 +119,53 @@ void BufferedLogStream::flushForRelease()
     
     // Try to flush any messages that are currently buffered. (Console is non-blocking
     // so it will fail gracefully).
-    if (fdEvent(eventLoop, fd, OUT_EVENTS) == Rearm::DISARM) {
+    if (fd_event(eventLoop, fd, OUT_EVENTS) == rearm::DISARM) {
         // Console has already been released at this point.
-        setEnabled(eventLoop, false);
+        set_enabled(eventLoop, false);
     }
-    // fdEvent didn't want to disarm, so must be partway through a message; will
+    // fd_event didn't want to disarm, so must be partway through a message; will
     // release when it's finished.
 }
 
-Rearm BufferedLogStream::fdEvent(EventLoop_t &loop, int fd, int flags) noexcept
+rearm BufferedLogStream::fd_event(eventloop_t &loop, int fd, int flags) noexcept
 {
-    auto &log_stream = *this;
-    
-    if ((! partway) && log_stream.special) {
-        char * start = log_stream.special_buf + log_stream.msg_index;
-        char * end = std::find(log_stream.special_buf + log_stream.msg_index, (char *)nullptr, '\n');
+    if ((! partway) && (! special) && discarded) {
+        special_buf = "dinit: *** message discarded due to full buffer ****\n";
+        msg_index = 0;
+    }
+
+    if ((! partway) && special) {
+        const char * start = special_buf + msg_index;
+        const char * end = std::find(special_buf + msg_index, (const char *)nullptr, '\n');
         int r = write(fd, start, end - start + 1);
         if (r >= 0) {
             if (start + r > end) {
                 // All written: go on to next message in queue
-                log_stream.special = false;
-                log_stream.partway = false;
-                log_stream.msg_index = 0;
+                special = false;
+                partway = false;
+                msg_index = 0;
                 
                 if (release) {
                     release_console();
-                    return Rearm::DISARM;
+                    return rearm::DISARM;
                 }
             }
             else {
-                log_stream.msg_index += r;
-                return Rearm::REARM;
+                msg_index += r;
+                return rearm::REARM;
             }
         }
         else if (errno != EAGAIN && errno != EINTR && errno != EWOULDBLOCK) {
-            return Rearm::REMOVE;
+            return rearm::REMOVE;
         }
-        return Rearm::REARM;
+        return rearm::REARM;
     }
     else {
         // Writing from the regular circular buffer
         
-        // TODO issue special message if we have discarded a log message
-        
         if (current_index == 0) {
             release_console();
-            return Rearm::DISARM;
+            return rearm::DISARM;
         }
         
         // We try to find a complete line (terminated by '\n') in the buffer, and write it
@@ -180,7 +194,7 @@ Rearm BufferedLogStream::fdEvent(EventLoop_t &loop, int fd, int flags) noexcept
         // Do we need the second span?
         if (! will_complete && len != log_buffer.get_length()) {
             ptr = log_buffer.get_buf_base();
-            creptr = static_cast<char *>(logiov[1].iov_base) + log_buffer.get_length() - len;
+            creptr = ptr + log_buffer.get_length() - len;
             eptr = std::find(ptr, creptr, '\n');
             if (eptr != creptr) {
                 eptr++; // include '\n'
@@ -197,33 +211,33 @@ Rearm BufferedLogStream::fdEvent(EventLoop_t &loop, int fd, int flags) noexcept
 
         if (r >= 0) {
             bool complete = (r == len) && will_complete;
-            log_stream.log_buffer.consume(len);
-            log_stream.partway = ! complete;
+            log_buffer.consume(len);
+            partway = ! complete;
             if (complete) {
-                log_stream.current_index -= len;
-                if (log_stream.current_index == 0 || release) {
+                current_index -= len;
+                if (current_index == 0 || release) {
                     // No more messages buffered / stop logging to console:
                     release_console();
-                    return Rearm::DISARM;
+                    return rearm::DISARM;
                 }
             }
         }
         else if (errno != EAGAIN && errno != EINTR && errno != EWOULDBLOCK) {
-            return Rearm::REMOVE;
+            return rearm::REMOVE;
         }
     }
     
     // We've written something by the time we get here. We could fall through to below, but
     // let's give other events a chance to be processed by returning now.
-    return Rearm::REARM;
+    return rearm::REARM;
 }
 
 // Initialise the logging subsystem
 // Potentially throws std::bad_alloc or std::system_error
-void init_log(ServiceSet *sset)
+void init_log(service_set *sset)
 {
-    service_set = sset;
-    log_stream[DLOG_CONS].addWatch(eventLoop, STDOUT_FILENO, OUT_EVENTS); // TODO register in disabled state
+    services = sset;
+    log_stream[DLOG_CONS].add_watch(eventLoop, STDOUT_FILENO, OUT_EVENTS, false);
     enable_console_log(true);
 }
 
@@ -232,7 +246,7 @@ void init_log(ServiceSet *sset)
 void setup_main_log(int fd)
 {
     log_stream[DLOG_MAIN].init(fd);
-    log_stream[DLOG_MAIN].addWatch(eventLoop, fd, OUT_EVENTS);
+    log_stream[DLOG_MAIN].add_watch(eventLoop, fd, OUT_EVENTS);
 }
 
 bool is_log_flushed() noexcept
@@ -253,13 +267,17 @@ void enable_console_log(bool enable) noexcept
         fcntl(1, F_SETFL, flags | O_NONBLOCK);
         // Activate watcher:
         log_stream[DLOG_CONS].init(STDOUT_FILENO);
-        log_stream[DLOG_CONS].setEnabled(eventLoop, true);
+        log_stream[DLOG_CONS].set_enabled(eventLoop, true);
     }
     else if (! enable && log_to_console) {
         log_stream[DLOG_CONS].flushForRelease();
     }
 }
 
+void discard_console_log_buffer() noexcept
+{
+    log_stream[DLOG_CONS].discard();
+}
 
 // Variadic method to calculate the sum of string lengths:
 static int sum_length(const char *arg) noexcept
@@ -284,16 +302,16 @@ template <typename ... T> static void append(BufferedLogStream &buf, const char
     append(buf, t...);
 }
 
-static int log_level_to_syslog_level(LogLevel l)
+static int log_level_to_syslog_level(loglevel_t l)
 {
     switch (l) {
-    case LogLevel::DEBUG:
+    case loglevel_t::DEBUG:
         return LOG_DEBUG;
-    case LogLevel::INFO:
+    case loglevel_t::INFO:
         return LOG_INFO;
-    case LogLevel::WARN:
+    case loglevel_t::WARN:
         return LOG_WARNING;
-    case LogLevel::ERROR:
+    case loglevel_t::ERROR:
         return LOG_ERR;
     default: ;
     }
@@ -311,12 +329,12 @@ template <typename ... T> static void push_to_log(int idx, T ... args) noexcept
         log_stream[idx].commit_msg();
     }
     else {
-        // TODO mark a discarded message
+        log_stream[idx].mark_discarded();
     }
 }
 
 // Variadic method to potentially log a sequence of strings as a single message with the given log level:
-template <typename ... T> static void do_log(LogLevel lvl, T ... args) noexcept
+template <typename ... T> static void do_log(loglevel_t lvl, T ... args) noexcept
 {
     log_current_line[DLOG_CONS] = lvl >= log_level[DLOG_CONS];
     log_current_line[DLOG_MAIN] = lvl >= log_level[DLOG_MAIN];
@@ -350,7 +368,7 @@ template <typename ... T> static void do_log_main(T ... args) noexcept
 }
 
 // Log a message. A newline will be appended.
-void log(LogLevel lvl, const char *msg) noexcept
+void log(loglevel_t lvl, const char *msg) noexcept
 {
     do_log(lvl, "dinit: ", msg, "\n");
 }
@@ -366,7 +384,7 @@ template <typename T> static void do_log_part(int idx, T arg) noexcept
         else {
             log_stream[idx].rollback_msg();
             log_current_line[idx] = false;
-            // TODO mark discarded message
+            log_stream[idx].mark_discarded();
         }
     }
 }
@@ -380,7 +398,7 @@ static void do_log_commit(int idx) noexcept
 }
 
 // Log a multi-part message beginning
-void logMsgBegin(LogLevel lvl, const char *msg) noexcept
+void log_msg_begin(loglevel_t lvl, const char *msg) noexcept
 {
     log_current_line[DLOG_CONS] = lvl >= log_level[DLOG_CONS];
     log_current_line[DLOG_MAIN] = lvl >= log_level[DLOG_MAIN];
@@ -398,14 +416,14 @@ void logMsgBegin(LogLevel lvl, const char *msg) noexcept
 }
 
 // Continue a multi-part log message
-void logMsgPart(const char *msg) noexcept
+void log_msg_part(const char *msg) noexcept
 {
     do_log_part(DLOG_CONS, msg);
     do_log_part(DLOG_MAIN, msg);
 }
 
 // Complete a multi-part log message
-void logMsgEnd(const char *msg) noexcept
+void log_msg_end(const char *msg) noexcept
 {
     for (int i = 0; i < 2; i++) {
         do_log_part(i, msg);
@@ -414,19 +432,19 @@ void logMsgEnd(const char *msg) noexcept
     }
 }
 
-void logServiceStarted(const char *service_name) noexcept
+void log_service_started(const char *service_name) noexcept
 {
     do_log_cons("[  OK  ] ", service_name, "\n");
     do_log_main("dinit: service ", service_name, " started.\n");
 }
 
-void logServiceFailed(const char *service_name) noexcept
+void log_service_failed(const char *service_name) noexcept
 {
     do_log_cons("[FAILED] ", service_name, "\n");
     do_log_main("dinit: service ", service_name, " failed to start.\n");
 }
 
-void logServiceStopped(const char *service_name) noexcept
+void log_service_stopped(const char *service_name) noexcept
 {
     do_log_cons("[STOPPD] ", service_name, "\n");
     do_log_main("dinit: service ", service_name, " stopped.\n");