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     /* Start SHM logging if shmlog_size is > 0. shmlog_size is SHMLOG_SIZE by
  93      * default on development versions, and 0 on release versions. If it is
  94      * not > 0, the user has turned it off, so let's close the logbuffer. */
  95      if (shmlog_size > 0 && logbuffer == NULL)
  96         open_logbuffer();
  97      else if (shmlog_size <= 0 && logbuffer)
  98         close_logbuffer();
  99      atexit(purge_zerobyte_logfile);
 100 }
 101
 102 /*
 103  * Opens the logbuffer.
 104  *
 105  */
 106 void open_logbuffer(void) {
 107         /* Reserve 1% of the RAM for the logfile, but at max 25 MiB.
 108          * For 512 MiB of RAM this will lead to a 5 MiB log buffer.
 109          * At the moment (2011-12-10), no testcase leads to an i3 log
 110          * of more than ~ 600 KiB. */
 111         long long physical_mem_bytes;
 112 #if defined(__APPLE__)
 113         int mib[2] = { CTL_HW, HW_MEMSIZE };
 114         size_t length = sizeof(long long);
 115         sysctl(mib, 2, &physical_mem_bytes, &length, NULL, 0);
 116 #else
 117         physical_mem_bytes = (long long)sysconf(_SC_PHYS_PAGES) *
 118                                         sysconf(_SC_PAGESIZE);
 119 #endif
 120         logbuffer_size = min(physical_mem_bytes * 0.01, shmlog_size);
 121 #if defined(__FreeBSD__)
 122         sasprintf(&shmlogname, "/tmp/i3-log-%d", getpid());
 123 #else
 124         sasprintf(&shmlogname, "/i3-log-%d", getpid());
 125 #endif
 126         logbuffer_shm = shm_open(shmlogname, O_RDWR | O_CREAT, S_IREAD | S_IWRITE);
 127         if (logbuffer_shm == -1) {
 128             fprintf(stderr, "Could not shm_open SHM segment for the i3 log: %s\n", strerror(errno));
 129             return;
 130         }
 131
 132         int ret;
 133         if ((ret = posix_fallocate(logbuffer_shm, 0, logbuffer_size)) != 0) {
 134             close(logbuffer_shm);
 135             shm_unlink(shmlogname);
 136             fprintf(stderr, "Could not ftruncate SHM segment for the i3 log: %s\n", strerror(ret));
 137             return;
 138         }
 139
 140         logbuffer = mmap(NULL, logbuffer_size, PROT_READ | PROT_WRITE, MAP_SHARED, logbuffer_shm, 0);
 141         if (logbuffer == MAP_FAILED) {
 142             close_logbuffer();
 143             fprintf(stderr, "Could not mmap SHM segment for the i3 log: %s\n", strerror(errno));
 144             return;
 145         }
 146
 147         /* Initialize with 0-bytes, just to be sure… */
 148         memset(logbuffer, '\0', logbuffer_size);
 149
 150         header = (i3_shmlog_header*)logbuffer;
 151
 152         pthread_condattr_t cond_attr;
 153         pthread_condattr_init(&cond_attr);
 154         if (pthread_condattr_setpshared(&cond_attr, PTHREAD_PROCESS_SHARED) != 0)
 155             fprintf(stderr, "pthread_condattr_setpshared() failed, i3-dump-log -f will not work!\n");
 156         pthread_cond_init(&(header->condvar), &cond_attr);
 157
 158         logwalk = logbuffer + sizeof(i3_shmlog_header);
 159         loglastwrap = logbuffer + logbuffer_size;
 160         store_log_markers();
 161 }
 162
 163 /*
 164  * Closes the logbuffer.
 165  *
 166  */
 167 void close_logbuffer(void) {
 168     close(logbuffer_shm);
 169     shm_unlink(shmlogname);
 170     logbuffer = NULL;
 171     shmlogname = "";
 172 }
 173
 174 /*
 175  * Set verbosity of i3. If verbose is set to true, informative messages will
 176  * be printed to stdout. If verbose is set to false, only errors will be
 177  * printed.
 178  *
 179  */
 180 void set_verbosity(bool _verbose) {
 181     verbose = _verbose;
 182 }
 183
 184 /*
 185  * Get debug logging.
 186  *
 187  */
 188 bool get_debug_logging(void) {
 189     return debug_logging;
 190 }
 191
 192 /*
 193  * Set debug logging.
 194  *
 195  */
 196 void set_debug_logging(const bool _debug_logging) {
 197     debug_logging = _debug_logging;
 198 }
 199
 200 /*
 201  * Logs the given message to stdout (if print is true) while prefixing the
 202  * current time to it. Additionally, the message will be saved in the i3 SHM
 203  * log if enabled.
 204  * This is to be called by *LOG() which includes filename/linenumber/function.
 205  *
 206  */
 207 static void vlog(const bool print, const char *fmt, va_list args) {
 208     /* Precisely one page to not consume too much memory but to hold enough
 209      * data to be useful. */
 210     static char message[4096];
 211     static struct tm result;
 212     static time_t t;
 213     static struct tm *tmp;
 214     static size_t len;
 215
 216     /* Get current time */
 217     t = time(NULL);
 218     /* Convert time to local time (determined by the locale) */
 219     tmp = localtime_r(&t, &result);
 220     /* Generate time prefix */
 221     len = strftime(message, sizeof(message), "%x %X - ", tmp);
 222
 223     /*
 224      * logbuffer  print
 225      * ----------------
 226      *  true      true   format message, save, print
 227      *  true      false  format message, save
 228      *  false     true   print message only
 229      *  false     false  INVALID, never called
 230      */
 231     if (!logbuffer) {
 232 #ifdef DEBUG_TIMING
 233         struct timeval tv;
 234         gettimeofday(&tv, NULL);
 235         printf("%s%d.%d - ", message, tv.tv_sec, tv.tv_usec);
 236 #else
 237         printf("%s", message);
 238 #endif
 239         vprintf(fmt, args);
 240     } else {
 241         len += vsnprintf(message + len, sizeof(message) - len, fmt, args);
 242         if (len >= sizeof(message)) {
 243             fprintf(stderr, "BUG: single log message > 4k\n");
 244         }
 245
 246         /* If there is no space for the current message in the ringbuffer, we
 247          * need to wrap and write to the beginning again. */
 248         if (len >= (logbuffer_size - (logwalk - logbuffer))) {
 249             loglastwrap = logwalk;
 250             logwalk = logbuffer + sizeof(i3_shmlog_header);
 251             store_log_markers();
 252             header->wrap_count++;
 253         }
 254
 255         /* Copy the buffer, move the write pointer to the byte after our
 256          * current message. */
 257         strncpy(logwalk, message, len);
 258         logwalk += len;
 259
 260         store_log_markers();
 261
 262         /* Wake up all (i3-dump-log) processes waiting for condvar. */
 263         pthread_cond_broadcast(&(header->condvar));
 264
 265         if (print)
 266             fwrite(message, len, 1, stdout);
 267     }
 268 }
 269
 270 /*
 271  * Logs the given message to stdout while prefixing the current time to it,
 272  * but only if verbose mode is activated.
 273  *
 274  */
 275 void verboselog(char *fmt, ...) {
 276     va_list args;
 277
 278     if (!logbuffer && !verbose)
 279         return;
 280
 281     va_start(args, fmt);
 282     vlog(verbose, fmt, args);
 283     va_end(args);
 284 }
 285
 286 /*
 287  * Logs the given message to stdout while prefixing the current time to it.
 288  *
 289  */
 290 void errorlog(char *fmt, ...) {
 291     va_list args;
 292
 293     va_start(args, fmt);
 294     vlog(true, fmt, args);
 295     va_end(args);
 296
 297     /* also log to the error logfile, if opened */
 298     va_start(args, fmt);
 299     vfprintf(errorfile, fmt, args);
 300     fflush(errorfile);
 301     va_end(args);
 302 }
 303
 304 /*
 305  * Logs the given message to stdout while prefixing the current time to it,
 306  * but only if debug logging was activated.
 307  * This is to be called by DLOG() which includes filename/linenumber
 308  *
 309  */
 310 void debuglog(char *fmt, ...) {
 311     va_list args;
 312
 313     if (!logbuffer && !(debug_logging))
 314         return;
 315
 316     va_start(args, fmt);
 317     vlog(debug_logging, fmt, args);
 318     va_end(args);
 319 }
 320
 321 /*
 322  * Deletes the unused log files. Useful if i3 exits immediately, eg.
 323  * because --get-socketpath was called. We don't care for syscall
 324  * failures. This function is invoked automatically when exiting.
 325  */
 326 void purge_zerobyte_logfile(void) {
 327     struct stat st;
 328     char *slash;
 329
 330     if (!errorfilename)
 331         return;
 332
 333     /* don't delete the log file if it contains something */
 334     if ((stat(errorfilename, &st)) == -1 || st.st_size > 0)
 335         return;
 336
 337     if (unlink(errorfilename) == -1)
 338         return;
 339
 340     if ((slash = strrchr(errorfilename, '/')) != NULL) {
 341         *slash = '\0';
 342         /* possibly fails with ENOTEMPTY if there are files (or
 343          * sockets) left. */
 344         rmdir(errorfilename);
 345     }
 346 }