]> git.sur5r.net Git - i3/i3/blobdiff - src/log.c
Merge branch 'release-4.16.1'
[i3/i3] / src / log.c
index 10149081ed3e54f574f91598fa97c226f2a8df3d..916085f456a8d8c1a95dbfca8c13d3d5b038db12 100644 (file)
--- a/src/log.c
+++ b/src/log.c
@@ -1,14 +1,14 @@
-#undef I3__FILE__
-#define I3__FILE__ "log.c"
 /*
  * vim:ts=4:sw=4:expandtab
  *
  * i3 - an improved dynamic tiling window manager
- * © 2009-2011 Michael Stapelberg and contributors (see also: LICENSE)
+ * © 2009 Michael Stapelberg and contributors (see also: LICENSE)
  *
  * log.c: Logging functions.
  *
  */
+#include <config.h>
+
 #include <stdarg.h>
 #include <stdio.h>
 #include <string.h>
@@ -20,7 +20,9 @@
 #include <sys/mman.h>
 #include <sys/stat.h>
 #include <errno.h>
+#if !defined(__OpenBSD__)
 #include <pthread.h>
+#endif
 
 #include "util.h"
 #include "log.h"
@@ -58,6 +60,8 @@ static char *loglastwrap;
 static int logbuffer_size;
 /* File descriptor for shm_open. */
 static int logbuffer_shm;
+/* Size (in bytes) of physical memory */
+static long long physical_mem_bytes;
 
 /*
  * Writes the offsets for the next write and for the last wrap to the
@@ -84,19 +88,34 @@ void init_logging(void) {
             fprintf(stderr, "Could not initialize errorlog\n");
         else {
             errorfile = fopen(errorfilename, "w");
-            if (fcntl(fileno(errorfile), F_SETFD, FD_CLOEXEC)) {
-                fprintf(stderr, "Could not set close-on-exec flag\n");
+            if (!errorfile) {
+                fprintf(stderr, "Could not initialize errorlog on %s: %s\n",
+                        errorfilename, strerror(errno));
+            } else {
+                if (fcntl(fileno(errorfile), F_SETFD, FD_CLOEXEC)) {
+                    fprintf(stderr, "Could not set close-on-exec flag\n");
+                }
             }
         }
     }
+    if (physical_mem_bytes == 0) {
+#if defined(__APPLE__)
+        int mib[2] = {CTL_HW, HW_MEMSIZE};
+        size_t length = sizeof(long long);
+        sysctl(mib, 2, &physical_mem_bytes, &length, NULL, 0);
+#else
+        physical_mem_bytes = (long long)sysconf(_SC_PHYS_PAGES) *
+                             sysconf(_SC_PAGESIZE);
+#endif
+    }
     /* Start SHM logging if shmlog_size is > 0. shmlog_size is SHMLOG_SIZE by
      * default on development versions, and 0 on release versions. If it is
      * not > 0, the user has turned it off, so let's close the logbuffer. */
-     if (shmlog_size > 0 && logbuffer == NULL)
+    if (shmlog_size > 0 && logbuffer == NULL)
         open_logbuffer();
-     else if (shmlog_size <= 0 && logbuffer)
+    else if (shmlog_size <= 0 && logbuffer)
         close_logbuffer();
-     atexit(purge_zerobyte_logfile);
+    atexit(purge_zerobyte_logfile);
 }
 
 /*
@@ -104,65 +123,58 @@ void init_logging(void) {
  *
  */
 void open_logbuffer(void) {
-        /* Reserve 1% of the RAM for the logfile, but at max 25 MiB.
+    /* Reserve 1% of the RAM for the logfile, but at max 25 MiB.
          * For 512 MiB of RAM this will lead to a 5 MiB log buffer.
          * At the moment (2011-12-10), no testcase leads to an i3 log
          * of more than ~ 600 KiB. */
-        long long physical_mem_bytes;
-#if defined(__APPLE__)
-        int mib[2] = { CTL_HW, HW_MEMSIZE };
-        size_t length = sizeof(long long);
-        sysctl(mib, 2, &physical_mem_bytes, &length, NULL, 0);
-#else
-        physical_mem_bytes = (long long)sysconf(_SC_PHYS_PAGES) *
-                                        sysconf(_SC_PAGESIZE);
-#endif
-        logbuffer_size = min(physical_mem_bytes * 0.01, shmlog_size);
+    logbuffer_size = min(physical_mem_bytes * 0.01, shmlog_size);
 #if defined(__FreeBSD__)
-        sasprintf(&shmlogname, "/tmp/i3-log-%d", getpid());
+    sasprintf(&shmlogname, "/tmp/i3-log-%d", getpid());
 #else
-        sasprintf(&shmlogname, "/i3-log-%d", getpid());
+    sasprintf(&shmlogname, "/i3-log-%d", getpid());
 #endif
-        logbuffer_shm = shm_open(shmlogname, O_RDWR | O_CREAT, S_IREAD | S_IWRITE);
-        if (logbuffer_shm == -1) {
-            fprintf(stderr, "Could not shm_open SHM segment for the i3 log: %s\n", strerror(errno));
-            return;
-        }
+    logbuffer_shm = shm_open(shmlogname, O_RDWR | O_CREAT, S_IREAD | S_IWRITE);
+    if (logbuffer_shm == -1) {
+        fprintf(stderr, "Could not shm_open SHM segment for the i3 log: %s\n", strerror(errno));
+        return;
+    }
 
 #if defined(__OpenBSD__) || defined(__APPLE__)
-        if (ftruncate(logbuffer_shm, logbuffer_size) == -1) {
-            fprintf(stderr, "Could not ftruncate SHM segment for the i3 log: %s\n", strerror(errno));
+    if (ftruncate(logbuffer_shm, logbuffer_size) == -1) {
+        fprintf(stderr, "Could not ftruncate SHM segment for the i3 log: %s\n", strerror(errno));
 #else
-        int ret;
-        if ((ret = posix_fallocate(logbuffer_shm, 0, logbuffer_size)) != 0) {
-            fprintf(stderr, "Could not ftruncate SHM segment for the i3 log: %s\n", strerror(ret));
+    int ret;
+    if ((ret = posix_fallocate(logbuffer_shm, 0, logbuffer_size)) != 0) {
+        fprintf(stderr, "Could not ftruncate SHM segment for the i3 log: %s\n", strerror(ret));
 #endif
-            close(logbuffer_shm);
-            shm_unlink(shmlogname);
-            return;
-        }
+        close(logbuffer_shm);
+        shm_unlink(shmlogname);
+        return;
+    }
 
-        logbuffer = mmap(NULL, logbuffer_size, PROT_READ | PROT_WRITE, MAP_SHARED, logbuffer_shm, 0);
-        if (logbuffer == MAP_FAILED) {
-            close_logbuffer();
-            fprintf(stderr, "Could not mmap SHM segment for the i3 log: %s\n", strerror(errno));
-            return;
-        }
+    logbuffer = mmap(NULL, logbuffer_size, PROT_READ | PROT_WRITE, MAP_SHARED, logbuffer_shm, 0);
+    if (logbuffer == MAP_FAILED) {
+        close_logbuffer();
+        fprintf(stderr, "Could not mmap SHM segment for the i3 log: %s\n", strerror(errno));
+        return;
+    }
 
-        /* Initialize with 0-bytes, just to be sure… */
-        memset(logbuffer, '\0', logbuffer_size);
+    /* Initialize with 0-bytes, just to be sure… */
+    memset(logbuffer, '\0', logbuffer_size);
 
-        header = (i3_shmlog_header*)logbuffer;
+    header = (i3_shmlog_header *)logbuffer;
 
-        pthread_condattr_t cond_attr;
-        pthread_condattr_init(&cond_attr);
-        if (pthread_condattr_setpshared(&cond_attr, PTHREAD_PROCESS_SHARED) != 0)
-            fprintf(stderr, "pthread_condattr_setpshared() failed, i3-dump-log -f will not work!\n");
-        pthread_cond_init(&(header->condvar), &cond_attr);
+#if !defined(__OpenBSD__)
+    pthread_condattr_t cond_attr;
+    pthread_condattr_init(&cond_attr);
+    if (pthread_condattr_setpshared(&cond_attr, PTHREAD_PROCESS_SHARED) != 0)
+        fprintf(stderr, "pthread_condattr_setpshared() failed, i3-dump-log -f will not work!\n");
+    pthread_cond_init(&(header->condvar), &cond_attr);
+#endif
 
-        logwalk = logbuffer + sizeof(i3_shmlog_header);
-        loglastwrap = logbuffer + logbuffer_size;
-        store_log_markers();
+    logwalk = logbuffer + sizeof(i3_shmlog_header);
+    loglastwrap = logbuffer + logbuffer_size;
+    store_log_markers();
 }
 
 /*
@@ -172,6 +184,7 @@ void open_logbuffer(void) {
 void close_logbuffer(void) {
     close(logbuffer_shm);
     shm_unlink(shmlogname);
+    free(shmlogname);
     logbuffer = NULL;
     shmlogname = "";
 }
@@ -246,6 +259,15 @@ static void vlog(const bool print, const char *fmt, va_list args) {
         len += vsnprintf(message + len, sizeof(message) - len, fmt, args);
         if (len >= sizeof(message)) {
             fprintf(stderr, "BUG: single log message > 4k\n");
+
+            /* vsnprintf returns the number of bytes that *would have been written*,
+             * not the actual amount written. Thus, limit len to sizeof(message) to avoid
+             * memory corruption and outputting garbage later.  */
+            len = sizeof(message);
+
+            /* Punch in a newline so the next log message is not dangling at
+             * the end of the truncated message. */
+            message[len - 2] = '\n';
         }
 
         /* If there is no space for the current message in the ringbuffer, we
@@ -264,8 +286,10 @@ static void vlog(const bool print, const char *fmt, va_list args) {
 
         store_log_markers();
 
+#if !defined(__OpenBSD__)
         /* Wake up all (i3-dump-log) processes waiting for condvar. */
         pthread_cond_broadcast(&(header->condvar));
+#endif
 
         if (print)
             fwrite(message, len, 1, stdout);