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

   1 /*
   2  * vim:ts=4:sw=4:expandtab
   3  *
   4  * i3 - an improved dynamic tiling window manager
   5  *
   6  * © 2009-2010 Michael Stapelberg and contributors
   7  *
   8  * See file LICENSE for license information.
   9  *
  10  * ipc.c: Everything about the UNIX domain sockets for IPC
  11  *
  12  */
  13 #include <sys/socket.h>
  14 #include <sys/un.h>
  15 #include <fcntl.h>
  16 #include <libgen.h>
  17 #include <ev.h>
  18 #include <yajl/yajl_gen.h>
  19 #include <yajl/yajl_parse.h>
  20
  21 #include "all.h"
  22
  23 /* Shorter names for all those yajl_gen_* functions */
  24 #define y(x, ...) yajl_gen_ ## x (gen, ##__VA_ARGS__)
  25 #define ystr(str) yajl_gen_string(gen, (unsigned char*)str, strlen(str))
  26
  27 TAILQ_HEAD(ipc_client_head, ipc_client) all_clients = TAILQ_HEAD_INITIALIZER(all_clients);
  28
  29 /*
  30  * Puts the given socket file descriptor into non-blocking mode or dies if
  31  * setting O_NONBLOCK failed. Non-blocking sockets are a good idea for our
  32  * IPC model because we should by no means block the window manager.
  33  *
  34  */
  35 static void set_nonblock(int sockfd) {
  36     int flags = fcntl(sockfd, F_GETFL, 0);
  37     flags |= O_NONBLOCK;
  38     if (fcntl(sockfd, F_SETFL, flags) < 0)
  39         err(-1, "Could not set O_NONBLOCK");
  40 }
  41
  42 /*
  43  * Emulates mkdir -p (creates any missing folders)
  44  *
  45  */
  46 static bool mkdirp(const char *path) {
  47     if (mkdir(path, S_IRWXU | S_IRGRP | S_IXGRP | S_IROTH | S_IXOTH) == 0)
  48         return true;
  49     if (errno != ENOENT) {
  50         ELOG("mkdir(%s) failed: %s\n", path, strerror(errno));
  51         return false;
  52     }
  53     char *copy = strdup(path);
  54     /* strip trailing slashes, if any */
  55     while (copy[strlen(copy)-1] == '/')
  56         copy[strlen(copy)-1] = '\0';
  57
  58     char *sep = strrchr(copy, '/');
  59     if (sep == NULL)
  60         return false;
  61     *sep = '\0';
  62     bool result = false;
  63     if (mkdirp(copy))
  64         result = mkdirp(path);
  65     free(copy);
  66
  67     return result;
  68 }
  69
  70 static void ipc_send_message(int fd, const unsigned char *payload,
  71                              int message_type, int message_size) {
  72     int buffer_size = strlen("i3-ipc") + sizeof(uint32_t) +
  73                       sizeof(uint32_t) + message_size;
  74     char msg[buffer_size];
  75     char *walk = msg;
  76
  77     strcpy(walk, "i3-ipc");
  78     walk += strlen("i3-ipc");
  79     memcpy(walk, &message_size, sizeof(uint32_t));
  80     walk += sizeof(uint32_t);
  81     memcpy(walk, &message_type, sizeof(uint32_t));
  82     walk += sizeof(uint32_t);
  83     memcpy(walk, payload, message_size);
  84
  85     int sent_bytes = 0;
  86     int bytes_to_go = buffer_size;
  87     while (sent_bytes < bytes_to_go) {
  88         int n = write(fd, msg + sent_bytes, bytes_to_go);
  89         if (n == -1) {
  90             DLOG("write() failed: %s\n", strerror(errno));
  91             return;
  92         }
  93
  94         sent_bytes += n;
  95         bytes_to_go -= n;
  96     }
  97 }
  98
  99 /*
 100  * Sends the specified event to all IPC clients which are currently connected
 101  * and subscribed to this kind of event.
 102  *
 103  */
 104 void ipc_send_event(const char *event, uint32_t message_type, const char *payload) {
 105     ipc_client *current;
 106     TAILQ_FOREACH(current, &all_clients, clients) {
 107         /* see if this client is interested in this event */
 108         bool interested = false;
 109         for (int i = 0; i < current->num_events; i++) {
 110             if (strcasecmp(current->events[i], event) != 0)
 111                 continue;
 112             interested = true;
 113             break;
 114         }
 115         if (!interested)
 116             continue;
 117
 118         ipc_send_message(current->fd, (const unsigned char*)payload,
 119                          message_type, strlen(payload));
 120     }
 121 }
 122
 123 /*
 124  * Calls shutdown() on each socket and closes it. This function to be called
 125  * when exiting or restarting only!
 126  *
 127  */
 128 void ipc_shutdown() {
 129     ipc_client *current;
 130     TAILQ_FOREACH(current, &all_clients, clients) {
 131         shutdown(current->fd, SHUT_RDWR);
 132         close(current->fd);
 133     }
 134 }
 135
 136 /*
 137  * Executes the command and returns whether it could be successfully parsed
 138  * or not (at the moment, always returns true).
 139  *
 140  */
 141 IPC_HANDLER(command) {
 142     /* To get a properly terminated buffer, we copy
 143      * message_size bytes out of the buffer */
 144     char *command = scalloc(message_size + 1);
 145     strncpy(command, (const char*)message, message_size);
 146     LOG("IPC: received: *%s*\n", command);
 147     const char *reply = parse_cmd((const char*)command);
 148     tree_render();
 149     free(command);
 150
 151     /* If no reply was provided, we just use the default success message */
 152     if (reply == NULL)
 153         reply = "{\"success\":true}";
 154     ipc_send_message(fd, (const unsigned char*)reply,
 155                      I3_IPC_REPLY_TYPE_COMMAND, strlen(reply));
 156 }
 157
 158 static void dump_rect(yajl_gen gen, const char *name, Rect r) {
 159     ystr(name);
 160     y(map_open);
 161     ystr("x");
 162     y(integer, r.x);
 163     ystr("y");
 164     y(integer, r.y);
 165     ystr("width");
 166     y(integer, r.width);
 167     ystr("height");
 168     y(integer, r.height);
 169     y(map_close);
 170 }
 171
 172 void dump_node(yajl_gen gen, struct Con *con, bool inplace_restart) {
 173     y(map_open);
 174     ystr("id");
 175     y(integer, (long int)con);
 176
 177     ystr("type");
 178     y(integer, con->type);
 179
 180     ystr("orientation");
 181     switch (con->orientation) {
 182         case NO_ORIENTATION:
 183             ystr("none");
 184             break;
 185         case HORIZ:
 186             ystr("horizontal");
 187             break;
 188         case VERT:
 189             ystr("vertical");
 190             break;
 191     }
 192
 193     ystr("percent");
 194     y(double, con->percent);
 195
 196     ystr("urgent");
 197     y(integer, con->urgent);
 198
 199     ystr("focused");
 200     y(integer, (con == focused));
 201
 202     ystr("layout");
 203     y(integer, con->layout);
 204
 205     ystr("border");
 206     y(integer, con->border_style);
 207
 208     dump_rect(gen, "rect", con->rect);
 209     dump_rect(gen, "window_rect", con->window_rect);
 210
 211     ystr("name");
 212     ystr(con->name);
 213
 214     if (con->type == CT_WORKSPACE) {
 215         ystr("num");
 216         y(integer, con->num);
 217     }
 218
 219     ystr("window");
 220     if (con->window)
 221         y(integer, con->window->id);
 222     else y(null);
 223
 224     ystr("nodes");
 225     y(array_open);
 226     Con *node;
 227     TAILQ_FOREACH(node, &(con->nodes_head), nodes) {
 228         dump_node(gen, node, inplace_restart);
 229     }
 230     y(array_close);
 231
 232     ystr("floating_nodes");
 233     y(array_open);
 234     TAILQ_FOREACH(node, &(con->floating_head), floating_windows) {
 235         dump_node(gen, node, inplace_restart);
 236     }
 237     y(array_close);
 238
 239     ystr("focus");
 240     y(array_open);
 241     TAILQ_FOREACH(node, &(con->focus_head), nodes) {
 242         y(integer, (long int)node);
 243     }
 244     y(array_close);
 245
 246     ystr("fullscreen_mode");
 247     y(integer, con->fullscreen_mode);
 248
 249     if (inplace_restart) {
 250         if (con->window != NULL) {
 251             ystr("swallows");
 252             y(array_open);
 253             y(map_open);
 254             ystr("id");
 255             y(integer, con->window->id);
 256             y(map_close);
 257             y(array_close);
 258         }
 259     }
 260
 261     y(map_close);
 262 }
 263
 264 IPC_HANDLER(tree) {
 265     setlocale(LC_NUMERIC, "C");
 266     yajl_gen gen = yajl_gen_alloc(NULL, NULL);
 267     dump_node(gen, croot, false);
 268     setlocale(LC_NUMERIC, "");
 269
 270     const unsigned char *payload;
 271     unsigned int length;
 272     y(get_buf, &payload, &length);
 273
 274     ipc_send_message(fd, payload, I3_IPC_REPLY_TYPE_TREE, length);
 275     y(free);
 276 }
 277
 278 /*
 279  * Formats the reply message for a GET_WORKSPACES request and sends it to the
 280  * client
 281  *
 282  */
 283 IPC_HANDLER(get_workspaces) {
 284     yajl_gen gen = yajl_gen_alloc(NULL, NULL);
 285     y(array_open);
 286
 287     Con *focused_ws = con_get_workspace(focused);
 288
 289     Con *output;
 290     TAILQ_FOREACH(output, &(croot->nodes_head), nodes) {
 291         Con *ws;
 292         TAILQ_FOREACH(ws, &(output_get_content(output)->nodes_head), nodes) {
 293             assert(ws->type == CT_WORKSPACE);
 294             y(map_open);
 295
 296             ystr("num");
 297             if (ws->num == -1)
 298                 y(null);
 299             else y(integer, ws->num);
 300
 301             ystr("name");
 302             ystr(ws->name);
 303
 304             ystr("visible");
 305             y(bool, workspace_is_visible(ws));
 306
 307             ystr("focused");
 308             y(bool, ws == focused_ws);
 309
 310             ystr("rect");
 311             y(map_open);
 312             ystr("x");
 313             y(integer, ws->rect.x);
 314             ystr("y");
 315             y(integer, ws->rect.y);
 316             ystr("width");
 317             y(integer, ws->rect.width);
 318             ystr("height");
 319             y(integer, ws->rect.height);
 320             y(map_close);
 321
 322             ystr("output");
 323             ystr(output->name);
 324
 325             ystr("urgent");
 326             y(bool, ws->urgent);
 327
 328             y(map_close);
 329         }
 330     }
 331
 332     y(array_close);
 333
 334     const unsigned char *payload;
 335     unsigned int length;
 336     y(get_buf, &payload, &length);
 337
 338     ipc_send_message(fd, payload, I3_IPC_REPLY_TYPE_WORKSPACES, length);
 339     y(free);
 340 }
 341
 342 /*
 343  * Formats the reply message for a GET_OUTPUTS request and sends it to the
 344  * client
 345  *
 346  */
 347 IPC_HANDLER(get_outputs) {
 348     yajl_gen gen = yajl_gen_alloc(NULL, NULL);
 349     y(array_open);
 350
 351     Output *output;
 352     TAILQ_FOREACH(output, &outputs, outputs) {
 353         y(map_open);
 354
 355         ystr("name");
 356         ystr(output->name);
 357
 358         ystr("active");
 359         y(bool, output->active);
 360
 361         ystr("rect");
 362         y(map_open);
 363         ystr("x");
 364         y(integer, output->rect.x);
 365         ystr("y");
 366         y(integer, output->rect.y);
 367         ystr("width");
 368         y(integer, output->rect.width);
 369         ystr("height");
 370         y(integer, output->rect.height);
 371         y(map_close);
 372
 373         ystr("current_workspace");
 374         Con *ws = NULL;
 375         if (output->con && (ws = con_get_fullscreen_con(output->con)))
 376             ystr(ws->name);
 377         else y(null);
 378
 379         y(map_close);
 380     }
 381
 382     y(array_close);
 383
 384     const unsigned char *payload;
 385     unsigned int length;
 386     y(get_buf, &payload, &length);
 387
 388     ipc_send_message(fd, payload, I3_IPC_REPLY_TYPE_OUTPUTS, length);
 389     y(free);
 390 }
 391
 392 /*
 393  * Callback for the YAJL parser (will be called when a string is parsed).
 394  *
 395  */
 396 static int add_subscription(void *extra, const unsigned char *s,
 397                             unsigned int len) {
 398     ipc_client *client = extra;
 399
 400     DLOG("should add subscription to extra %p, sub %.*s\n", client, len, s);
 401     int event = client->num_events;
 402
 403     client->num_events++;
 404     client->events = realloc(client->events, client->num_events * sizeof(char*));
 405     /* We copy the string because it is not null-terminated and strndup()
 406      * is missing on some BSD systems */
 407     client->events[event] = scalloc(len+1);
 408     memcpy(client->events[event], s, len);
 409
 410     DLOG("client is now subscribed to:\n");
 411     for (int i = 0; i < client->num_events; i++)
 412         DLOG("event %s\n", client->events[i]);
 413     DLOG("(done)\n");
 414
 415     return 1;
 416 }
 417
 418 /*
 419  * Subscribes this connection to the event types which were given as a JSON
 420  * serialized array in the payload field of the message.
 421  *
 422  */
 423 IPC_HANDLER(subscribe) {
 424     yajl_handle p;
 425     yajl_callbacks callbacks;
 426     yajl_status stat;
 427     ipc_client *current, *client = NULL;
 428
 429     /* Search the ipc_client structure for this connection */
 430     TAILQ_FOREACH(current, &all_clients, clients) {
 431         if (current->fd != fd)
 432             continue;
 433
 434         client = current;
 435         break;
 436     }
 437
 438     if (client == NULL) {
 439         ELOG("Could not find ipc_client data structure for fd %d\n", fd);
 440         return;
 441     }
 442
 443     /* Setup the JSON parser */
 444     memset(&callbacks, 0, sizeof(yajl_callbacks));
 445     callbacks.yajl_string = add_subscription;
 446
 447     p = yajl_alloc(&callbacks, NULL, NULL, (void*)client);
 448     stat = yajl_parse(p, (const unsigned char*)message, message_size);
 449     if (stat != yajl_status_ok) {
 450         unsigned char *err;
 451         err = yajl_get_error(p, true, (const unsigned char*)message,
 452                              message_size);
 453         ELOG("YAJL parse error: %s\n", err);
 454         yajl_free_error(p, err);
 455
 456         const char *reply = "{\"success\":false}";
 457         ipc_send_message(fd, (const unsigned char*)reply,
 458                          I3_IPC_REPLY_TYPE_SUBSCRIBE, strlen(reply));
 459         yajl_free(p);
 460         return;
 461     }
 462     yajl_free(p);
 463     const char *reply = "{\"success\":true}";
 464     ipc_send_message(fd, (const unsigned char*)reply,
 465                      I3_IPC_REPLY_TYPE_SUBSCRIBE, strlen(reply));
 466 }
 467
 468 /* The index of each callback function corresponds to the numeric
 469  * value of the message type (see include/i3/ipc.h) */
 470 handler_t handlers[5] = {
 471     handle_command,
 472     handle_get_workspaces,
 473     handle_subscribe,
 474     handle_get_outputs,
 475     handle_tree
 476 };
 477
 478 /*
 479  * Handler for activity on a client connection, receives a message from a
 480  * client.
 481  *
 482  * For now, the maximum message size is 2048. I’m not sure for what the
 483  * IPC interface will be used in the future, thus I’m not implementing a
 484  * mechanism for arbitrarily long messages, as it seems like overkill
 485  * at the moment.
 486  *
 487  */
 488 static void ipc_receive_message(EV_P_ struct ev_io *w, int revents) {
 489     char buf[2048];
 490     int n = read(w->fd, buf, sizeof(buf));
 491
 492     /* On error or an empty message, we close the connection */
 493     if (n <= 0) {
 494 #if 0
 495         /* FIXME: I get these when closing a client socket,
 496          * therefore we just treat them as an error. Is this
 497          * correct? */
 498         if (errno == EAGAIN || errno == EWOULDBLOCK)
 499                 return;
 500 #endif
 501
 502         /* If not, there was some kind of error. We don’t bother
 503          * and close the connection */
 504         close(w->fd);
 505
 506         /* Delete the client from the list of clients */
 507         ipc_client *current;
 508         TAILQ_FOREACH(current, &all_clients, clients) {
 509             if (current->fd != w->fd)
 510                 continue;
 511
 512             for (int i = 0; i < current->num_events; i++)
 513                 free(current->events[i]);
 514             /* We can call TAILQ_REMOVE because we break out of the
 515              * TAILQ_FOREACH afterwards */
 516             TAILQ_REMOVE(&all_clients, current, clients);
 517             break;
 518         }
 519
 520         ev_io_stop(EV_A_ w);
 521
 522         DLOG("IPC: client disconnected\n");
 523         return;
 524     }
 525
 526     /* Terminate the message correctly */
 527     buf[n] = '\0';
 528
 529     /* Check if the message starts with the i3 IPC magic code */
 530     if (n < strlen(I3_IPC_MAGIC)) {
 531         DLOG("IPC: message too short, ignoring\n");
 532         return;
 533     }
 534
 535     if (strncmp(buf, I3_IPC_MAGIC, strlen(I3_IPC_MAGIC)) != 0) {
 536         DLOG("IPC: message does not start with the IPC magic\n");
 537         return;
 538     }
 539
 540     uint8_t *message = (uint8_t*)buf;
 541     while (n > 0) {
 542         DLOG("IPC: n = %d\n", n);
 543         message += strlen(I3_IPC_MAGIC);
 544         n -= strlen(I3_IPC_MAGIC);
 545
 546         /* The next 32 bit after the magic are the message size */
 547         uint32_t message_size = *((uint32_t*)message);
 548         message += sizeof(uint32_t);
 549         n -= sizeof(uint32_t);
 550
 551         if (message_size > n) {
 552             DLOG("IPC: Either the message size was wrong or the message was not read completely, dropping\n");
 553             return;
 554         }
 555
 556         /* The last 32 bits of the header are the message type */
 557         uint32_t message_type = *((uint32_t*)message);
 558         message += sizeof(uint32_t);
 559         n -= sizeof(uint32_t);
 560
 561         if (message_type >= (sizeof(handlers) / sizeof(handler_t)))
 562             DLOG("Unhandled message type: %d\n", message_type);
 563         else {
 564             handler_t h = handlers[message_type];
 565             h(w->fd, message, n, message_size, message_type);
 566         }
 567         n -= message_size;
 568         message += message_size;
 569     }
 570 }
 571
 572 /*
 573  * Handler for activity on the listening socket, meaning that a new client
 574  * has just connected and we should accept() him. Sets up the event handler
 575  * for activity on the new connection and inserts the file descriptor into
 576  * the list of clients.
 577  *
 578  */
 579 void ipc_new_client(EV_P_ struct ev_io *w, int revents) {
 580     struct sockaddr_un peer;
 581     socklen_t len = sizeof(struct sockaddr_un);
 582     int client;
 583     if ((client = accept(w->fd, (struct sockaddr*)&peer, &len)) < 0) {
 584         if (errno == EINTR)
 585             return;
 586         else perror("accept()");
 587         return;
 588     }
 589
 590     set_nonblock(client);
 591
 592     struct ev_io *package = scalloc(sizeof(struct ev_io));
 593     ev_io_init(package, ipc_receive_message, client, EV_READ);
 594     ev_io_start(EV_A_ package);
 595
 596     DLOG("IPC: new client connected\n");
 597
 598     ipc_client *new = scalloc(sizeof(ipc_client));
 599     new->fd = client;
 600
 601     TAILQ_INSERT_TAIL(&all_clients, new, clients);
 602 }
 603
 604 /*
 605  * Creates the UNIX domain socket at the given path, sets it to non-blocking
 606  * mode, bind()s and listen()s on it.
 607  *
 608  */
 609 int ipc_create_socket(const char *filename) {
 610     int sockfd;
 611
 612     char *resolved = resolve_tilde(filename);
 613     DLOG("Creating IPC-socket at %s\n", resolved);
 614     char *copy = sstrdup(resolved);
 615     const char *dir = dirname(copy);
 616     if (!path_exists(dir))
 617         mkdirp(dir);
 618     free(copy);
 619
 620     /* Unlink the unix domain socket before */
 621     unlink(resolved);
 622
 623     if ((sockfd = socket(AF_LOCAL, SOCK_STREAM, 0)) < 0) {
 624         perror("socket()");
 625         free(resolved);
 626         return -1;
 627     }
 628
 629     (void)fcntl(sockfd, F_SETFD, FD_CLOEXEC);
 630
 631     struct sockaddr_un addr;
 632     memset(&addr, 0, sizeof(struct sockaddr_un));
 633     addr.sun_family = AF_LOCAL;
 634     strncpy(addr.sun_path, resolved, sizeof(addr.sun_path) - 1);
 635     if (bind(sockfd, (struct sockaddr*)&addr, sizeof(struct sockaddr_un)) < 0) {
 636         perror("bind()");
 637         free(resolved);
 638         return -1;
 639     }
 640
 641     free(resolved);
 642     set_nonblock(sockfd);
 643
 644     if (listen(sockfd, 5) < 0) {
 645         perror("listen()");
 646         return -1;
 647     }
 648
 649     return sockfd;
 650 }