git.sur5r.net Git - i3/i3/blob - src/log.c

   1 #undef I3__FILE__
   2 #define I3__FILE__ "log.c"
   3 /*
   4  * vim:ts=4:sw=4:expandtab
   5  *
   6  * i3 - an improved dynamic tiling window manager
   7  * © 2009-2011 Michael Stapelberg and contributors (see also: LICENSE)
   8  *
   9  * log.c: Logging functions.
  10  *
  11  */
  12 #include <stdarg.h>
  13 #include <stdio.h>
  14 #include <string.h>
  15 #include <stdbool.h>
  16 #include <stdlib.h>
  17 #include <sys/time.h>
  18 #include <unistd.h>
  19 #include <fcntl.h>
  20 #include <sys/mman.h>
  21 #include <sys/stat.h>
  22 #include <errno.h>
  23 #include <pthread.h>
  24 #if defined(__APPLE__)
  25 #include <sys/types.h>
  26 #include <sys/sysctl.h>
  27 #endif
  28
  29 #include "util.h"
  30 #include "log.h"
  31 #include "i3.h"
  32 #include "libi3.h"
  33 #include "shmlog.h"
  34
  35 static bool debug_logging = false;
  36 static bool verbose = false;
  37 static FILE *errorfile;
  38 char *errorfilename;
  39
  40 /* SHM logging variables */
  41
  42 /* The name for the SHM (/i3-log-%pid). Will end up on /dev/shm on most
  43  * systems. Global so that we can clean up at exit. */
  44 char *shmlogname = "";
  45 /* Size limit for the SHM log, by default 25 MiB. Can be overwritten using the
  46  * flag --shmlog-size. */
  47 int shmlog_size = 0;
  48 /* If enabled, logbuffer will point to a memory mapping of the i3 SHM log. */
  49 static char *logbuffer;
  50 /* A pointer (within logbuffer) where data will be written to next. */
  51 static char *logwalk;
  52 /* A pointer to the shmlog header */
  53 static i3_shmlog_header *header;
  54 /* A pointer to the byte where we last wrapped. Necessary to not print the
  55  * left-overs at the end of the ringbuffer. */
  56 static char *loglastwrap;
  57 /* Size (in bytes) of the i3 SHM log. */
  58 static int logbuffer_size;
  59 /* File descriptor for shm_open. */
  60 static int logbuffer_shm;
  61
  62 /*
  63  * Writes the offsets for the next write and for the last wrap to the
  64  * shmlog_header.
  65  * Necessary to print the i3 SHM log in the correct order.
  66  *
  67  */
  68 static void store_log_markers(void) {
  69     header->offset_next_write = (logwalk - logbuffer);
  70     header->offset_last_wrap = (loglastwrap - logbuffer);
  71     header->size = logbuffer_size;
  72 }
  73
  74 /*
  75  * Initializes logging by creating an error logfile in /tmp (or
  76  * XDG_RUNTIME_DIR, see get_process_filename()).
  77  *
  78  * Will be called twice if --shmlog-size is specified.
  79  *
  80  */
  81 void init_logging(void) {
  82     if (!errorfilename) {
  83         if (!(errorfilename = get_process_filename("errorlog")))
  84             fprintf(stderr, "Could not initialize errorlog\n");
  85         else {
  86             errorfile = fopen(errorfilename, "w");
  87             if (fcntl(fileno(errorfile), F_SETFD, FD_CLOEXEC)) {
  88                 fprintf(stderr, "Could not set close-on-exec flag\n");
  89             }
  90         }
  91     }
  92
  93     /* If this is a debug build (not a release version), we will enable SHM
  94      * logging by default, unless the user turned it off explicitly. */
  95     if (logbuffer == NULL && shmlog_size > 0) {
  96         /* Reserve 1% of the RAM for the logfile, but at max 25 MiB.
  97          * For 512 MiB of RAM this will lead to a 5 MiB log buffer.
  98          * At the moment (2011-12-10), no testcase leads to an i3 log
  99          * of more than ~ 600 KiB. */
 100         long long physical_mem_bytes;
 101 #if defined(__APPLE__)
 102         int mib[2] = { CTL_HW, HW_MEMSIZE };
 103         size_t length = sizeof(long long);
 104         sysctl(mib, 2, &physical_mem_bytes, &length, NULL, 0);
 105 #else
 106         physical_mem_bytes = (long long)sysconf(_SC_PHYS_PAGES) *
 107                                         sysconf(_SC_PAGESIZE);
 108 #endif
 109         logbuffer_size = min(physical_mem_bytes * 0.01, shmlog_size);
 110 #if defined(__FreeBSD__)
 111         sasprintf(&shmlogname, "/tmp/i3-log-%d", getpid());
 112 #else
 113         sasprintf(&shmlogname, "/i3-log-%d", getpid());
 114 #endif
 115         logbuffer_shm = shm_open(shmlogname, O_RDWR | O_CREAT, S_IREAD | S_IWRITE);
 116         if (logbuffer_shm == -1) {
 117             fprintf(stderr, "Could not shm_open SHM segment for the i3 log: %s\n", strerror(errno));
 118             return;
 119         }
 120
 121         if (ftruncate(logbuffer_shm, logbuffer_size) == -1) {
 122             close(logbuffer_shm);
 123             shm_unlink(shmlogname);
 124             fprintf(stderr, "Could not ftruncate SHM segment for the i3 log: %s\n", strerror(errno));
 125             return;
 126         }
 127
 128         logbuffer = mmap(NULL, logbuffer_size, PROT_READ | PROT_WRITE, MAP_SHARED, logbuffer_shm, 0);
 129         if (logbuffer == MAP_FAILED) {
 130             close(logbuffer_shm);
 131             shm_unlink(shmlogname);
 132             fprintf(stderr, "Could not mmap SHM segment for the i3 log: %s\n", strerror(errno));
 133             logbuffer = NULL;
 134             return;
 135         }
 136
 137         /* Initialize with 0-bytes, just to be sure… */
 138         memset(logbuffer, '\0', logbuffer_size);
 139
 140         header = (i3_shmlog_header*)logbuffer;
 141
 142         pthread_condattr_t cond_attr;
 143         pthread_condattr_init(&cond_attr);
 144         if (pthread_condattr_setpshared(&cond_attr, PTHREAD_PROCESS_SHARED) != 0)
 145             fprintf(stderr, "pthread_condattr_setpshared() failed, i3-dump-log -f will not work!\n");
 146         pthread_cond_init(&(header->condvar), &cond_attr);
 147
 148         logwalk = logbuffer + sizeof(i3_shmlog_header);
 149         loglastwrap = logbuffer + logbuffer_size;
 150         store_log_markers();
 151     }
 152     atexit(purge_zerobyte_logfile);
 153 }
 154
 155 /*
 156  * Set verbosity of i3. If verbose is set to true, informative messages will
 157  * be printed to stdout. If verbose is set to false, only errors will be
 158  * printed.
 159  *
 160  */
 161 void set_verbosity(bool _verbose) {
 162     verbose = _verbose;
 163 }
 164
 165 /*
 166  * Set debug logging.
 167  *
 168  */
 169 void set_debug_logging(const bool _debug_logging) {
 170     debug_logging = _debug_logging;
 171 }
 172
 173 /*
 174  * Logs the given message to stdout (if print is true) while prefixing the
 175  * current time to it. Additionally, the message will be saved in the i3 SHM
 176  * log if enabled.
 177  * This is to be called by *LOG() which includes filename/linenumber/function.
 178  *
 179  */
 180 static void vlog(const bool print, const char *fmt, va_list args) {
 181     /* Precisely one page to not consume too much memory but to hold enough
 182      * data to be useful. */
 183     static char message[4096];
 184     static struct tm result;
 185     static time_t t;
 186     static struct tm *tmp;
 187     static size_t len;
 188
 189     /* Get current time */
 190     t = time(NULL);
 191     /* Convert time to local time (determined by the locale) */
 192     tmp = localtime_r(&t, &result);
 193     /* Generate time prefix */
 194     len = strftime(message, sizeof(message), "%x %X - ", tmp);
 195
 196     /*
 197      * logbuffer  print
 198      * ----------------
 199      *  true      true   format message, save, print
 200      *  true      false  format message, save
 201      *  false     true   print message only
 202      *  false     false  INVALID, never called
 203      */
 204     if (!logbuffer) {
 205 #ifdef DEBUG_TIMING
 206         struct timeval tv;
 207         gettimeofday(&tv, NULL);
 208         printf("%s%d.%d - ", message, tv.tv_sec, tv.tv_usec);
 209 #else
 210         printf("%s", message);
 211 #endif
 212         vprintf(fmt, args);
 213     } else {
 214         len += vsnprintf(message + len, sizeof(message) - len, fmt, args);
 215         if (len >= sizeof(message)) {
 216             fprintf(stderr, "BUG: single log message > 4k\n");
 217         }
 218
 219         /* If there is no space for the current message in the ringbuffer, we
 220          * need to wrap and write to the beginning again. */
 221         if (len >= (logbuffer_size - (logwalk - logbuffer))) {
 222             loglastwrap = logwalk;
 223             logwalk = logbuffer + sizeof(i3_shmlog_header);
 224             store_log_markers();
 225             header->wrap_count++;
 226         }
 227
 228         /* Copy the buffer, move the write pointer to the byte after our
 229          * current message. */
 230         strncpy(logwalk, message, len);
 231         logwalk += len;
 232
 233         store_log_markers();
 234
 235         /* Wake up all (i3-dump-log) processes waiting for condvar. */
 236         pthread_cond_broadcast(&(header->condvar));
 237
 238         if (print)
 239             fwrite(message, len, 1, stdout);
 240     }
 241 }
 242
 243 /*
 244  * Logs the given message to stdout while prefixing the current time to it,
 245  * but only if verbose mode is activated.
 246  *
 247  */
 248 void verboselog(char *fmt, ...) {
 249     va_list args;
 250
 251     if (!logbuffer && !verbose)
 252         return;
 253
 254     va_start(args, fmt);
 255     vlog(verbose, fmt, args);
 256     va_end(args);
 257 }
 258
 259 /*
 260  * Logs the given message to stdout while prefixing the current time to it.
 261  *
 262  */
 263 void errorlog(char *fmt, ...) {
 264     va_list args;
 265
 266     va_start(args, fmt);
 267     vlog(true, fmt, args);
 268     va_end(args);
 269
 270     /* also log to the error logfile, if opened */
 271     va_start(args, fmt);
 272     vfprintf(errorfile, fmt, args);
 273     fflush(errorfile);
 274     va_end(args);
 275 }
 276
 277 /*
 278  * Logs the given message to stdout while prefixing the current time to it,
 279  * but only if debug logging was activated.
 280  * This is to be called by DLOG() which includes filename/linenumber
 281  *
 282  */
 283 void debuglog(char *fmt, ...) {
 284     va_list args;
 285
 286     if (!logbuffer && !(debug_logging))
 287         return;
 288
 289     va_start(args, fmt);
 290     vlog(debug_logging, fmt, args);
 291     va_end(args);
 292 }
 293
 294 /*
 295  * Deletes the unused log files. Useful if i3 exits immediately, eg.
 296  * because --get-socketpath was called. We don't care for syscall
 297  * failures. This function is invoked automatically when exiting.
 298  */
 299 void purge_zerobyte_logfile(void) {
 300     struct stat st;
 301     char *slash;
 302
 303     if (!errorfilename)
 304         return;
 305
 306     /* don't delete the log file if it contains something */
 307     if ((stat(errorfilename, &st)) == -1 || st.st_size > 0)
 308         return;
 309
 310     if (unlink(errorfilename) == -1)
 311         return;
 312
 313     if ((slash = strrchr(errorfilename, '/')) != NULL) {
 314         *slash = '\0';
 315         /* possibly fails with ENOTEMPTY if there are files (or
 316          * sockets) left. */
 317         rmdir(errorfilename);
 318     }
 319 }