X-Git-Url: https://git.sur5r.net/?p=i3%2Fi3;a=blobdiff_plain;f=i3-dump-log%2Fmain.c;h=acb7fcb1f36308b64a2f075b038668c20f55f00c;hp=68cbdb46cfcaad2c9d177e90bd65a81639a10571;hb=d3beff23395356ec71fcc35a3b802163e12df73e;hpb=a930994dc983190c9f43f262d496f97285604a76 diff --git a/i3-dump-log/main.c b/i3-dump-log/main.c index 68cbdb46..acb7fcb1 100644 --- a/i3-dump-log/main.c +++ b/i3-dump-log/main.c @@ -2,7 +2,7 @@ * vim:ts=4:sw=4:expandtab * * i3 - an improved dynamic tiling window manager - * © 2009-2011 Michael Stapelberg and contributors (see also: LICENSE) + * © 2009-2012 Michael Stapelberg and contributors (see also: LICENSE) * * i3-dump-log/main.c: Dumps the i3 SHM log to stdout. * @@ -25,135 +25,162 @@ #include #include "libi3.h" +#include "shmlog.h" #include +static uint32_t offset_next_write, + wrap_count; + +static i3_shmlog_header *header; +static char *logbuffer, + *walk; + +static int check_for_wrap(void) { + if (wrap_count == header->wrap_count) + return 0; + + /* The log wrapped. Print the remaining content and reset walk to the top + * of the log. */ + wrap_count = header->wrap_count; + const int len = (logbuffer + header->offset_last_wrap) - walk; + if (write(STDOUT_FILENO, walk, len) != len) + err(EXIT_FAILURE, "write()"); + walk = logbuffer + sizeof(i3_shmlog_header); + return 1; +} + +static void print_till_end(void) { + check_for_wrap(); + const int len = (logbuffer + header->offset_next_write) - walk; + const int n = write(STDOUT_FILENO, walk, len); + if (len != n) + err(EXIT_FAILURE, "write()"); + if (n > 0) { + walk += n; + } +} + int main(int argc, char *argv[]) { - char *socket_path = getenv("I3SOCK"); int o, option_index = 0; - int message_type = I3_IPC_MESSAGE_TYPE_GET_LOG_MARKERS; - bool verbose = false; + bool verbose = false, + follow = false; static struct option long_options[] = { - {"socket", required_argument, 0, 's'}, {"version", no_argument, 0, 'v'}, {"verbose", no_argument, 0, 'V'}, + {"follow", no_argument, 0, 'f'}, {"help", no_argument, 0, 'h'}, {0, 0, 0, 0} }; - char *options_string = "s:vVh"; + char *options_string = "s:vfVh"; while ((o = getopt_long(argc, argv, options_string, long_options, &option_index)) != -1) { - if (o == 's') { - if (socket_path != NULL) - free(socket_path); - socket_path = sstrdup(optarg); - } else if (o == 'v') { + if (o == 'v') { printf("i3-dump-log " I3_VERSION "\n"); return 0; } else if (o == 'V') { verbose = true; + } else if (o == 'f') { + follow = true; } else if (o == 'h') { printf("i3-dump-log " I3_VERSION "\n"); - printf("i3-dump-log [-s ]\n"); + printf("i3-dump-log [-f] [-s ]\n"); return 0; } } - if (socket_path == NULL) - socket_path = socket_path_from_x11(); - - /* Fall back to the default socket path */ - if (socket_path == NULL) - socket_path = sstrdup("/tmp/i3-ipc.sock"); - - int sockfd = socket(AF_LOCAL, SOCK_STREAM, 0); - if (sockfd == -1) - err(EXIT_FAILURE, "Could not create socket"); - - struct sockaddr_un addr; - memset(&addr, 0, sizeof(struct sockaddr_un)); - addr.sun_family = AF_LOCAL; - strncpy(addr.sun_path, socket_path, sizeof(addr.sun_path) - 1); - if (connect(sockfd, (const struct sockaddr*)&addr, sizeof(struct sockaddr_un)) < 0) - err(EXIT_FAILURE, "Could not connect to i3"); - - if (ipc_send_message(sockfd, 0, message_type, NULL) == -1) - err(EXIT_FAILURE, "IPC: write()"); - - uint32_t reply_length; - uint8_t *reply; - int ret; - if ((ret = ipc_recv_message(sockfd, message_type, &reply_length, &reply)) != 0) { - if (ret == -1) - err(EXIT_FAILURE, "IPC: read()"); - exit(1); + char *shmname = root_atom_contents("I3_SHMLOG_PATH", NULL, 0); + if (shmname == NULL) { + /* Something failed. Let’s invest a little effort to find out what it + * is. This is hugely helpful for users who want to debug i3 but are + * not used to the procedure yet. */ + xcb_connection_t *conn; + int screen; + if ((conn = xcb_connect(NULL, &screen)) == NULL || + xcb_connection_has_error(conn)) { + fprintf(stderr, "i3-dump-log: ERROR: Cannot connect to X11.\n\n"); + if (getenv("DISPLAY") == NULL) { + fprintf(stderr, "Your DISPLAY environment variable is not set.\n"); + fprintf(stderr, "Are you running i3-dump-log via SSH or on a virtual console?\n"); + fprintf(stderr, "Try DISPLAY=:0 i3-dump-log\n"); + exit(1); + } + fprintf(stderr, "FYI: The DISPLAY environment variable is set to \"%s\".\n", getenv("DISPLAY")); + exit(1); + } + if (root_atom_contents("I3_CONFIG_PATH", conn, screen) != NULL) { + fprintf(stderr, "i3-dump-log: ERROR: i3 is running, but SHM logging is not enabled.\n\n"); + if (!is_debug_build()) { + fprintf(stderr, "You seem to be using a release version of i3:\n %s\n\n", I3_VERSION); + fprintf(stderr, "Release versions do not use SHM logging by default,\ntherefore i3-dump-log does not work.\n\n"); + fprintf(stderr, "Please follow this guide instead:\nhttp://i3wm.org/docs/debugging-release-version.html\n"); + exit(1); + } + } + errx(EXIT_FAILURE, "Cannot get I3_SHMLOG_PATH atom contents. Is i3 running on this display?"); } - char *buffer = NULL; - sasprintf(&buffer, "%.*s", reply_length, reply); - /* The reply will look like this: - * {"offset_next_write":1729,"offset_last_wrap":1996,"size":2048,"shmname":"/i3-log-399"} - * IMO, it’s not worth linking a JSON parser in just for this. If the - * structure changes in the future, this decision needs to be re-evaluated - * :). */ - int offset_next_write, offset_last_wrap, logbuffer_size; - char *next_write_str = strstr(buffer, "offset_next_write"), - *last_wrap_str = strstr(buffer, "offset_last_wrap"), - *size_str = strstr(buffer, "size"), - *shmname = strstr(buffer, "shmname"); - if (!next_write_str || - !last_wrap_str || - !size_str || - !shmname || - sscanf(next_write_str, "offset_next_write\":%d", &offset_next_write) != 1 || - sscanf(last_wrap_str, "offset_last_wrap\":%d", &offset_last_wrap) != 1 || - sscanf(size_str, "size\":%d", &logbuffer_size) != 1) - errx(EXIT_FAILURE, "invalid IPC reply: %s\n", buffer); - - shmname += strlen("shmname\":\""); - char *quote = strchr(shmname, '"'); - if (!quote) - errx(EXIT_FAILURE, "invalid IPC reply: %s\n", buffer); - *quote = '\0'; - - if (verbose) - printf("next_write = %d, last_wrap = %d, logbuffer_size = %d, shmname = %s\n", - offset_next_write, offset_last_wrap, logbuffer_size, shmname); if (*shmname == '\0') errx(EXIT_FAILURE, "Cannot dump log: SHM logging is disabled in i3."); - int logbuffer_shm = shm_open(shmname, O_RDONLY, 0); + struct stat statbuf; + + /* NB: While we must never write, we need O_RDWR for the pthread condvar. */ + int logbuffer_shm = shm_open(shmname, O_RDWR, 0); if (logbuffer_shm == -1) err(EXIT_FAILURE, "Could not shm_open SHM segment for the i3 log (%s)", shmname); - char *logbuffer = mmap(NULL, logbuffer_size, PROT_READ, MAP_SHARED, logbuffer_shm, 0); + if (fstat(logbuffer_shm, &statbuf) != 0) + err(EXIT_FAILURE, "stat(%s)", shmname); + + /* NB: While we must never write, we need PROT_WRITE for the pthread condvar. */ + logbuffer = mmap(NULL, statbuf.st_size, PROT_READ | PROT_WRITE, MAP_SHARED, logbuffer_shm, 0); if (logbuffer == MAP_FAILED) err(EXIT_FAILURE, "Could not mmap SHM segment for the i3 log"); - int chars; - char *walk = logbuffer + offset_next_write; - /* Skip the first line, it very likely is mangled. Not a problem, though, - * the log is chatty enough to have plenty lines left. */ - while (*walk != '\0') - walk++; + header = (i3_shmlog_header*)logbuffer; - /* Print the oldest log lines. We use printf("%s") to stop on \0. */ - while (walk < (logbuffer + offset_last_wrap)) { - chars = printf("%s", walk); - /* Shortcut: If there are two consecutive \0 bytes, this part of the - * buffer was never touched. To not call printf() for every byte of the - * buffer, we directly exit the loop. */ - if (*walk == '\0' && *(walk+1) == '\0') - break; - walk += (chars > 0 ? chars : 1); + if (verbose) + printf("next_write = %d, last_wrap = %d, logbuffer_size = %d, shmname = %s\n", + header->offset_next_write, header->offset_last_wrap, header->size, shmname); + walk = logbuffer + header->offset_next_write; + + /* We first need to print old content in case there was at least one + * wrapping already. */ + + if (*walk != '\0') { + /* In case there was a write to the buffer already, skip the first + * old line, it very likely is mangled. Not a problem, though, the log + * is chatty enough to have plenty lines left. */ + while (*walk != '\n') + walk++; + walk++; } + /* In case there was no wrapping, this is a no-op, otherwise it prints the + * old lines. */ + wrap_count = 0; + check_for_wrap(); + /* Then start from the beginning and print the newer lines */ - walk = logbuffer; - while (walk < (logbuffer + offset_next_write)) { - chars = printf("%s", walk); - walk += (chars > 0 ? chars : 1); + walk = logbuffer + sizeof(i3_shmlog_header); + print_till_end(); + + if (follow) { + /* Since pthread_cond_wait() expects a mutex, we need to provide one. + * To not lock i3 (that’s bad, mhkay?) we just define one outside of + * the shared memory. */ + pthread_mutex_t dummy_mutex = PTHREAD_MUTEX_INITIALIZER; + pthread_mutex_lock(&dummy_mutex); + while (1) { + pthread_cond_wait(&(header->condvar), &dummy_mutex); + /* If this was not a spurious wakeup, print the new lines. */ + if (header->offset_next_write != offset_next_write) { + offset_next_write = header->offset_next_write; + print_till_end(); + } + } } return 0;