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

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