2 * vim:ts=4:sw=4:expandtab
4 * i3 - an improved dynamic tiling window manager
6 * © 2009-2011 Michael Stapelberg and contributors
8 * See file LICENSE for license information.
10 * ipc.c: Everything about the UNIX domain sockets for IPC
13 #include <sys/socket.h>
18 #include <yajl/yajl_gen.h>
19 #include <yajl/yajl_parse.h>
20 #include <yajl/yajl_version.h>
24 char *current_socketpath = NULL;
26 /* Shorter names for all those yajl_gen_* functions */
27 #define y(x, ...) yajl_gen_ ## x (gen, ##__VA_ARGS__)
28 #define ystr(str) yajl_gen_string(gen, (unsigned char*)str, strlen(str))
30 TAILQ_HEAD(ipc_client_head, ipc_client) all_clients = TAILQ_HEAD_INITIALIZER(all_clients);
33 * Puts the given socket file descriptor into non-blocking mode or dies if
34 * setting O_NONBLOCK failed. Non-blocking sockets are a good idea for our
35 * IPC model because we should by no means block the window manager.
38 static void set_nonblock(int sockfd) {
39 int flags = fcntl(sockfd, F_GETFL, 0);
41 if (fcntl(sockfd, F_SETFL, flags) < 0)
42 err(-1, "Could not set O_NONBLOCK");
46 * Emulates mkdir -p (creates any missing folders)
49 static bool mkdirp(const char *path) {
50 if (mkdir(path, S_IRWXU | S_IRGRP | S_IXGRP | S_IROTH | S_IXOTH) == 0)
52 if (errno != ENOENT) {
53 ELOG("mkdir(%s) failed: %s\n", path, strerror(errno));
56 char *copy = strdup(path);
57 /* strip trailing slashes, if any */
58 while (copy[strlen(copy)-1] == '/')
59 copy[strlen(copy)-1] = '\0';
61 char *sep = strrchr(copy, '/');
67 result = mkdirp(path);
73 static void ipc_send_message(int fd, const unsigned char *payload,
74 int message_type, int message_size) {
75 int buffer_size = strlen("i3-ipc") + sizeof(uint32_t) +
76 sizeof(uint32_t) + message_size;
77 char msg[buffer_size];
80 strncpy(walk, "i3-ipc", buffer_size - 1);
81 walk += strlen("i3-ipc");
82 memcpy(walk, &message_size, sizeof(uint32_t));
83 walk += sizeof(uint32_t);
84 memcpy(walk, &message_type, sizeof(uint32_t));
85 walk += sizeof(uint32_t);
86 memcpy(walk, payload, message_size);
89 int bytes_to_go = buffer_size;
90 while (sent_bytes < bytes_to_go) {
91 int n = write(fd, msg + sent_bytes, bytes_to_go);
93 DLOG("write() failed: %s\n", strerror(errno));
103 * Sends the specified event to all IPC clients which are currently connected
104 * and subscribed to this kind of event.
107 void ipc_send_event(const char *event, uint32_t message_type, const char *payload) {
109 TAILQ_FOREACH(current, &all_clients, clients) {
110 /* see if this client is interested in this event */
111 bool interested = false;
112 for (int i = 0; i < current->num_events; i++) {
113 if (strcasecmp(current->events[i], event) != 0)
121 ipc_send_message(current->fd, (const unsigned char*)payload,
122 message_type, strlen(payload));
127 * Calls shutdown() on each socket and closes it. This function to be called
128 * when exiting or restarting only!
131 void ipc_shutdown() {
133 TAILQ_FOREACH(current, &all_clients, clients) {
134 shutdown(current->fd, SHUT_RDWR);
140 * Executes the command and returns whether it could be successfully parsed
141 * or not (at the moment, always returns true).
144 IPC_HANDLER(command) {
145 /* To get a properly terminated buffer, we copy
146 * message_size bytes out of the buffer */
147 char *command = scalloc(message_size + 1);
148 strncpy(command, (const char*)message, message_size);
149 LOG("IPC: received: *%s*\n", command);
150 char *reply = parse_cmd((const char*)command);
151 char *save_reply = reply;
154 /* If no reply was provided, we just use the default success message */
156 reply = "{\"success\":true}";
157 ipc_send_message(fd, (const unsigned char*)reply,
158 I3_IPC_REPLY_TYPE_COMMAND, strlen(reply));
163 static void dump_rect(yajl_gen gen, const char *name, Rect r) {
173 y(integer, r.height);
177 void dump_node(yajl_gen gen, struct Con *con, bool inplace_restart) {
180 y(integer, (long int)con);
183 y(integer, con->type);
186 switch (con->orientation) {
199 if (con->percent == 0.0)
201 else y(double, con->percent);
204 y(bool, con->urgent);
206 if (con->mark != NULL) {
212 y(bool, (con == focused));
215 switch (con->layout) {
234 switch (con->border_style) {
246 dump_rect(gen, "rect", con->rect);
247 dump_rect(gen, "window_rect", con->window_rect);
248 dump_rect(gen, "geometry", con->geometry);
251 if (con->window && con->window->name_json)
252 ystr(con->window->name_json);
256 if (con->type == CT_WORKSPACE) {
258 y(integer, con->num);
263 y(integer, con->window->id);
269 if (con->type != CT_DOCKAREA || !inplace_restart) {
270 TAILQ_FOREACH(node, &(con->nodes_head), nodes) {
271 dump_node(gen, node, inplace_restart);
276 ystr("floating_nodes");
278 TAILQ_FOREACH(node, &(con->floating_head), floating_windows) {
279 dump_node(gen, node, inplace_restart);
285 TAILQ_FOREACH(node, &(con->focus_head), nodes) {
286 y(integer, (long int)node);
290 ystr("fullscreen_mode");
291 y(integer, con->fullscreen_mode);
296 TAILQ_FOREACH(match, &(con->swallow_head), matches) {
297 if (match->dock != -1) {
300 y(integer, match->dock);
301 ystr("insert_where");
302 y(integer, match->insert_where);
306 /* TODO: the other swallow keys */
309 if (inplace_restart) {
310 if (con->window != NULL) {
313 y(integer, con->window->id);
323 setlocale(LC_NUMERIC, "C");
325 yajl_gen gen = yajl_gen_alloc(NULL);
327 yajl_gen gen = yajl_gen_alloc(NULL, NULL);
329 dump_node(gen, croot, false);
330 setlocale(LC_NUMERIC, "");
332 const unsigned char *payload;
338 y(get_buf, &payload, &length);
340 ipc_send_message(fd, payload, I3_IPC_REPLY_TYPE_TREE, length);
346 * Formats the reply message for a GET_WORKSPACES request and sends it to the
350 IPC_HANDLER(get_workspaces) {
352 yajl_gen gen = yajl_gen_alloc(NULL);
354 yajl_gen gen = yajl_gen_alloc(NULL, NULL);
358 Con *focused_ws = con_get_workspace(focused);
361 TAILQ_FOREACH(output, &(croot->nodes_head), nodes) {
363 TAILQ_FOREACH(ws, &(output_get_content(output)->nodes_head), nodes) {
364 assert(ws->type == CT_WORKSPACE);
370 else y(integer, ws->num);
376 y(bool, workspace_is_visible(ws));
379 y(bool, ws == focused_ws);
384 y(integer, ws->rect.x);
386 y(integer, ws->rect.y);
388 y(integer, ws->rect.width);
390 y(integer, ws->rect.height);
405 const unsigned char *payload;
411 y(get_buf, &payload, &length);
413 ipc_send_message(fd, payload, I3_IPC_REPLY_TYPE_WORKSPACES, length);
418 * Formats the reply message for a GET_OUTPUTS request and sends it to the
422 IPC_HANDLER(get_outputs) {
424 yajl_gen gen = yajl_gen_alloc(NULL);
426 yajl_gen gen = yajl_gen_alloc(NULL, NULL);
431 TAILQ_FOREACH(output, &outputs, outputs) {
438 y(bool, output->active);
443 y(integer, output->rect.x);
445 y(integer, output->rect.y);
447 y(integer, output->rect.width);
449 y(integer, output->rect.height);
452 ystr("current_workspace");
454 if (output->con && (ws = con_get_fullscreen_con(output->con, CF_OUTPUT)))
463 const unsigned char *payload;
469 y(get_buf, &payload, &length);
471 ipc_send_message(fd, payload, I3_IPC_REPLY_TYPE_OUTPUTS, length);
476 * Formats the reply message for a GET_MARKS request and sends it to the
480 IPC_HANDLER(get_marks) {
482 yajl_gen gen = yajl_gen_alloc(NULL);
484 yajl_gen gen = yajl_gen_alloc(NULL, NULL);
489 TAILQ_FOREACH(con, &all_cons, all_cons)
490 if (con->mark != NULL)
495 const unsigned char *payload;
501 y(get_buf, &payload, &length);
503 ipc_send_message(fd, payload, I3_IPC_REPLY_TYPE_MARKS, length);
508 * Callback for the YAJL parser (will be called when a string is parsed).
512 static int add_subscription(void *extra, const unsigned char *s,
515 static int add_subscription(void *extra, const unsigned char *s,
518 ipc_client *client = extra;
520 DLOG("should add subscription to extra %p, sub %.*s\n", client, len, s);
521 int event = client->num_events;
523 client->num_events++;
524 client->events = realloc(client->events, client->num_events * sizeof(char*));
525 /* We copy the string because it is not null-terminated and strndup()
526 * is missing on some BSD systems */
527 client->events[event] = scalloc(len+1);
528 memcpy(client->events[event], s, len);
530 DLOG("client is now subscribed to:\n");
531 for (int i = 0; i < client->num_events; i++)
532 DLOG("event %s\n", client->events[i]);
539 * Subscribes this connection to the event types which were given as a JSON
540 * serialized array in the payload field of the message.
543 IPC_HANDLER(subscribe) {
545 yajl_callbacks callbacks;
547 ipc_client *current, *client = NULL;
549 /* Search the ipc_client structure for this connection */
550 TAILQ_FOREACH(current, &all_clients, clients) {
551 if (current->fd != fd)
558 if (client == NULL) {
559 ELOG("Could not find ipc_client data structure for fd %d\n", fd);
563 /* Setup the JSON parser */
564 memset(&callbacks, 0, sizeof(yajl_callbacks));
565 callbacks.yajl_string = add_subscription;
568 p = yajl_alloc(&callbacks, NULL, (void*)client);
570 p = yajl_alloc(&callbacks, NULL, NULL, (void*)client);
572 stat = yajl_parse(p, (const unsigned char*)message, message_size);
573 if (stat != yajl_status_ok) {
575 err = yajl_get_error(p, true, (const unsigned char*)message,
577 ELOG("YAJL parse error: %s\n", err);
578 yajl_free_error(p, err);
580 const char *reply = "{\"success\":false}";
581 ipc_send_message(fd, (const unsigned char*)reply,
582 I3_IPC_REPLY_TYPE_SUBSCRIBE, strlen(reply));
587 const char *reply = "{\"success\":true}";
588 ipc_send_message(fd, (const unsigned char*)reply,
589 I3_IPC_REPLY_TYPE_SUBSCRIBE, strlen(reply));
592 /* The index of each callback function corresponds to the numeric
593 * value of the message type (see include/i3/ipc.h) */
594 handler_t handlers[6] = {
596 handle_get_workspaces,
604 * Handler for activity on a client connection, receives a message from a
607 * For now, the maximum message size is 2048. I’m not sure for what the
608 * IPC interface will be used in the future, thus I’m not implementing a
609 * mechanism for arbitrarily long messages, as it seems like overkill
613 static void ipc_receive_message(EV_P_ struct ev_io *w, int revents) {
615 int n = read(w->fd, buf, sizeof(buf));
617 /* On error or an empty message, we close the connection */
620 /* FIXME: I get these when closing a client socket,
621 * therefore we just treat them as an error. Is this
623 if (errno == EAGAIN || errno == EWOULDBLOCK)
627 /* If not, there was some kind of error. We don’t bother
628 * and close the connection */
631 /* Delete the client from the list of clients */
633 TAILQ_FOREACH(current, &all_clients, clients) {
634 if (current->fd != w->fd)
637 for (int i = 0; i < current->num_events; i++)
638 free(current->events[i]);
639 /* We can call TAILQ_REMOVE because we break out of the
640 * TAILQ_FOREACH afterwards */
641 TAILQ_REMOVE(&all_clients, current, clients);
647 DLOG("IPC: client disconnected\n");
651 /* Terminate the message correctly */
654 /* Check if the message starts with the i3 IPC magic code */
655 if (n < strlen(I3_IPC_MAGIC)) {
656 DLOG("IPC: message too short, ignoring\n");
660 if (strncmp(buf, I3_IPC_MAGIC, strlen(I3_IPC_MAGIC)) != 0) {
661 DLOG("IPC: message does not start with the IPC magic\n");
665 uint8_t *message = (uint8_t*)buf;
667 DLOG("IPC: n = %d\n", n);
668 message += strlen(I3_IPC_MAGIC);
669 n -= strlen(I3_IPC_MAGIC);
671 /* The next 32 bit after the magic are the message size */
672 uint32_t message_size;
673 memcpy(&message_size, (uint32_t*)message, sizeof(uint32_t));
674 message += sizeof(uint32_t);
675 n -= sizeof(uint32_t);
677 if (message_size > n) {
678 DLOG("IPC: Either the message size was wrong or the message was not read completely, dropping\n");
682 /* The last 32 bits of the header are the message type */
683 uint32_t message_type;
684 memcpy(&message_type, (uint32_t*)message, sizeof(uint32_t));
685 message += sizeof(uint32_t);
686 n -= sizeof(uint32_t);
688 if (message_type >= (sizeof(handlers) / sizeof(handler_t)))
689 DLOG("Unhandled message type: %d\n", message_type);
691 handler_t h = handlers[message_type];
692 h(w->fd, message, n, message_size, message_type);
695 message += message_size;
700 * Handler for activity on the listening socket, meaning that a new client
701 * has just connected and we should accept() him. Sets up the event handler
702 * for activity on the new connection and inserts the file descriptor into
703 * the list of clients.
706 void ipc_new_client(EV_P_ struct ev_io *w, int revents) {
707 struct sockaddr_un peer;
708 socklen_t len = sizeof(struct sockaddr_un);
710 if ((client = accept(w->fd, (struct sockaddr*)&peer, &len)) < 0) {
713 else perror("accept()");
717 set_nonblock(client);
719 struct ev_io *package = scalloc(sizeof(struct ev_io));
720 ev_io_init(package, ipc_receive_message, client, EV_READ);
721 ev_io_start(EV_A_ package);
723 DLOG("IPC: new client connected on fd %d\n", w->fd);
725 ipc_client *new = scalloc(sizeof(ipc_client));
728 TAILQ_INSERT_TAIL(&all_clients, new, clients);
732 * Creates the UNIX domain socket at the given path, sets it to non-blocking
733 * mode, bind()s and listen()s on it.
736 int ipc_create_socket(const char *filename) {
739 FREE(current_socketpath);
741 char *resolved = resolve_tilde(filename);
742 DLOG("Creating IPC-socket at %s\n", resolved);
743 char *copy = sstrdup(resolved);
744 const char *dir = dirname(copy);
745 if (!path_exists(dir))
749 /* Unlink the unix domain socket before */
752 if ((sockfd = socket(AF_LOCAL, SOCK_STREAM, 0)) < 0) {
758 (void)fcntl(sockfd, F_SETFD, FD_CLOEXEC);
760 struct sockaddr_un addr;
761 memset(&addr, 0, sizeof(struct sockaddr_un));
762 addr.sun_family = AF_LOCAL;
763 strncpy(addr.sun_path, resolved, sizeof(addr.sun_path) - 1);
764 if (bind(sockfd, (struct sockaddr*)&addr, sizeof(struct sockaddr_un)) < 0) {
770 set_nonblock(sockfd);
772 if (listen(sockfd, 5) < 0) {
778 current_socketpath = resolved;