git.sur5r.net Git - i3/i3/blob - i3-dump-log/main.c

   1 /*
   2  * vim:ts=4:sw=4:expandtab
   3  *
   4  * i3 - an improved dynamic tiling window manager
   5  * © 2009-2012 Michael Stapelberg and contributors (see also: LICENSE)
   6  *
   7  * i3-dump-log/main.c: Dumps the i3 SHM log to stdout.
   8  *
   9  */
  10 #include <stdio.h>
  11 #include <stdbool.h>
  12 #include <sys/types.h>
  13 #include <sys/socket.h>
  14 #include <sys/un.h>
  15 #include <stdlib.h>
  16 #include <unistd.h>
  17 #include <string.h>
  18 #include <errno.h>
  19 #include <err.h>
  20 #include <stdint.h>
  21 #include <getopt.h>
  22 #include <limits.h>
  23 #include <fcntl.h>
  24 #include <sys/mman.h>
  25 #include <sys/stat.h>
  26
  27 #include "libi3.h"
  28 #include "shmlog.h"
  29 #include <i3/ipc.h>
  30
  31 static uint32_t offset_next_write,
  32                 wrap_count;
  33
  34 static i3_shmlog_header *header;
  35 static char *logbuffer,
  36             *walk;
  37
  38 static int check_for_wrap(void) {
  39     if (wrap_count == header->wrap_count)
  40         return 0;
  41
  42     /* The log wrapped. Print the remaining content and reset walk to the top
  43      * of the log. */
  44     wrap_count = header->wrap_count;
  45     write(STDOUT_FILENO, walk, ((logbuffer + header->offset_last_wrap) - walk));
  46     walk = logbuffer + sizeof(i3_shmlog_header);
  47     return 1;
  48 }
  49
  50 static void print_till_end(void) {
  51     check_for_wrap();
  52     int n = write(STDOUT_FILENO, walk, ((logbuffer + header->offset_next_write) - walk));
  53     if (n > 0) {
  54         walk += n;
  55     }
  56 }
  57
  58 int main(int argc, char *argv[]) {
  59     int o, option_index = 0;
  60     bool verbose = false,
  61          follow = false;
  62
  63     static struct option long_options[] = {
  64         {"version", no_argument, 0, 'v'},
  65         {"verbose", no_argument, 0, 'V'},
  66         {"follow", no_argument, 0, 'f'},
  67         {"help", no_argument, 0, 'h'},
  68         {0, 0, 0, 0}
  69     };
  70
  71     char *options_string = "s:vfVh";
  72
  73     while ((o = getopt_long(argc, argv, options_string, long_options, &option_index)) != -1) {
  74         if (o == 'v') {
  75             printf("i3-dump-log " I3_VERSION "\n");
  76             return 0;
  77         } else if (o == 'V') {
  78             verbose = true;
  79         } else if (o == 'f') {
  80             follow = true;
  81         } else if (o == 'h') {
  82             printf("i3-dump-log " I3_VERSION "\n");
  83             printf("i3-dump-log [-f] [-s <socket>]\n");
  84             return 0;
  85         }
  86     }
  87
  88     char *shmname = root_atom_contents("I3_SHMLOG_PATH");
  89     if (shmname == NULL) {
  90         /* Something failed. Let’s invest a little effort to find out what it
  91          * is. This is hugely helpful for users who want to debug i3 but are
  92          * not used to the procedure yet. */
  93         xcb_connection_t *conn;
  94         int screen;
  95         if ((conn = xcb_connect(NULL, &screen)) == NULL ||
  96             xcb_connection_has_error(conn)) {
  97             fprintf(stderr, "i3-dump-log: ERROR: Cannot connect to X11.\n\n");
  98             if (getenv("DISPLAY") == NULL) {
  99                 fprintf(stderr, "Your DISPLAY environment variable is not set.\n");
 100                 fprintf(stderr, "Are you running i3-dump-log via SSH or on a virtual console?\n");
 101                 fprintf(stderr, "Try DISPLAY=:0 i3-dump-log\n");
 102                 exit(1);
 103             }
 104             fprintf(stderr, "FYI: The DISPLAY environment variable is set to \"%s\".\n", getenv("DISPLAY"));
 105             exit(1);
 106         }
 107         if (root_atom_contents("I3_CONFIG_PATH") != NULL) {
 108             fprintf(stderr, "i3-dump-log: ERROR: i3 is running, but SHM logging is not enabled.\n\n");
 109             if (!is_debug_build()) {
 110                 fprintf(stderr, "You seem to be using a release version of i3:\n  %s\n\n", I3_VERSION);
 111                 fprintf(stderr, "Release versions do not use SHM logging by default,\ntherefore i3-dump-log does not work.\n\n");
 112                 fprintf(stderr, "Please follow this guide instead:\nhttp://i3wm.org/docs/debugging-release-version.html\n");
 113                 exit(1);
 114             }
 115         }
 116         errx(EXIT_FAILURE, "Cannot get I3_SHMLOG_PATH atom contents. Is i3 running on this display?");
 117     }
 118
 119     if (*shmname == '\0')
 120         errx(EXIT_FAILURE, "Cannot dump log: SHM logging is disabled in i3.");
 121
 122     struct stat statbuf;
 123
 124     /* NB: While we must never read, we need O_RDWR for the pthread condvar. */
 125     int logbuffer_shm = shm_open(shmname, O_RDWR, 0);
 126     if (logbuffer_shm == -1)
 127         err(EXIT_FAILURE, "Could not shm_open SHM segment for the i3 log (%s)", shmname);
 128
 129     if (fstat(logbuffer_shm, &statbuf) != 0)
 130         err(EXIT_FAILURE, "stat(%s)", shmname);
 131
 132     /* NB: While we must never read, we need O_RDWR for the pthread condvar. */
 133     logbuffer = mmap(NULL, statbuf.st_size, PROT_READ | PROT_WRITE, MAP_SHARED, logbuffer_shm, 0);
 134     if (logbuffer == MAP_FAILED)
 135         err(EXIT_FAILURE, "Could not mmap SHM segment for the i3 log");
 136
 137     header = (i3_shmlog_header*)logbuffer;
 138
 139     if (verbose)
 140         printf("next_write = %d, last_wrap = %d, logbuffer_size = %d, shmname = %s\n",
 141                header->offset_next_write, header->offset_last_wrap, header->size, shmname);
 142     walk = logbuffer + header->offset_next_write;
 143
 144     /* We first need to print old content in case there was at least one
 145      * wrapping already. */
 146
 147     if (*walk != '\0') {
 148         /* In case there was a write to the buffer already, skip the first
 149          * old line, it very likely is mangled. Not a problem, though, the log
 150          * is chatty enough to have plenty lines left. */
 151         while (*walk != '\n')
 152             walk++;
 153         walk++;
 154     }
 155
 156     /* In case there was no wrapping, this is a no-op, otherwise it prints the
 157      * old lines. */
 158     wrap_count = 0;
 159     check_for_wrap();
 160
 161     /* Then start from the beginning and print the newer lines */
 162     walk = logbuffer + sizeof(i3_shmlog_header);
 163     print_till_end();
 164
 165     if (follow) {
 166         /* Since pthread_cond_wait() expects a mutex, we need to provide one.
 167          * To not lock i3 (that’s bad, mhkay?) we just define one outside of
 168          * the shared memory. */
 169         pthread_mutex_t dummy_mutex = PTHREAD_MUTEX_INITIALIZER;
 170         pthread_mutex_lock(&dummy_mutex);
 171         while (1) {
 172             pthread_cond_wait(&(header->condvar), &dummy_mutex);
 173             /* If this was not a spurious wakeup, print the new lines. */
 174             if (header->offset_next_write != offset_next_write) {
 175                 offset_next_write = header->offset_next_write;
 176                 print_till_end();
 177             }
 178         }
 179     }
 180
 181     return 0;
 182 }