2 * vim:ts=4:sw=4:expandtab
4 * i3 - an improved dynamic tiling window manager
5 * © 2009-2011 Michael Stapelberg and contributors (see also: LICENSE)
7 * ipc.c: UNIX domain socket IPC (initialization, client handling, protocol).
12 #include <sys/socket.h>
17 #include <yajl/yajl_gen.h>
18 #include <yajl/yajl_parse.h>
19 #include <yajl/yajl_version.h>
21 char *current_socketpath = NULL;
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))
27 TAILQ_HEAD(ipc_client_head, ipc_client) all_clients = TAILQ_HEAD_INITIALIZER(all_clients);
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.
35 static void set_nonblock(int sockfd) {
36 int flags = fcntl(sockfd, F_GETFL, 0);
38 if (fcntl(sockfd, F_SETFL, flags) < 0)
39 err(-1, "Could not set O_NONBLOCK");
43 * Emulates mkdir -p (creates any missing folders)
46 static bool mkdirp(const char *path) {
47 if (mkdir(path, S_IRWXU | S_IRGRP | S_IXGRP | S_IROTH | S_IXOTH) == 0)
49 if (errno != ENOENT) {
50 ELOG("mkdir(%s) failed: %s\n", path, strerror(errno));
53 char *copy = strdup(path);
54 /* strip trailing slashes, if any */
55 while (copy[strlen(copy)-1] == '/')
56 copy[strlen(copy)-1] = '\0';
58 char *sep = strrchr(copy, '/');
66 result = mkdirp(path);
73 * Sends the specified event to all IPC clients which are currently connected
74 * and subscribed to this kind of event.
77 void ipc_send_event(const char *event, uint32_t message_type, const char *payload) {
79 TAILQ_FOREACH(current, &all_clients, clients) {
80 /* see if this client is interested in this event */
81 bool interested = false;
82 for (int i = 0; i < current->num_events; i++) {
83 if (strcasecmp(current->events[i], event) != 0)
91 ipc_send_message(current->fd, strlen(payload), message_type, (const uint8_t*)payload);
96 * Calls shutdown() on each socket and closes it. This function to be called
97 * when exiting or restarting only!
100 void ipc_shutdown() {
102 while (!TAILQ_EMPTY(&all_clients)) {
103 current = TAILQ_FIRST(&all_clients);
104 shutdown(current->fd, SHUT_RDWR);
106 TAILQ_REMOVE(&all_clients, current, clients);
112 * Executes the command and returns whether it could be successfully parsed
113 * or not (at the moment, always returns true).
116 IPC_HANDLER(command) {
117 /* To get a properly terminated buffer, we copy
118 * message_size bytes out of the buffer */
119 char *command = scalloc(message_size + 1);
120 strncpy(command, (const char*)message, message_size);
121 LOG("IPC: received: *%s*\n", command);
122 char *reply = parse_cmd((const char*)command);
123 char *save_reply = reply;
126 /* If no reply was provided, we just use the default success message */
128 reply = "{\"success\":true}";
129 ipc_send_message(fd, strlen(reply), I3_IPC_REPLY_TYPE_COMMAND, (const uint8_t*)reply);
134 static void dump_rect(yajl_gen gen, const char *name, Rect r) {
144 y(integer, r.height);
148 void dump_node(yajl_gen gen, struct Con *con, bool inplace_restart) {
151 y(integer, (long int)con);
154 y(integer, con->type);
157 switch (con->orientation) {
170 if (con->percent == 0.0)
172 else y(double, con->percent);
175 y(bool, con->urgent);
177 if (con->mark != NULL) {
183 y(bool, (con == focused));
186 switch (con->layout) {
205 switch (con->border_style) {
217 dump_rect(gen, "rect", con->rect);
218 dump_rect(gen, "window_rect", con->window_rect);
219 dump_rect(gen, "geometry", con->geometry);
222 if (con->window && con->window->name_json)
223 ystr(con->window->name_json);
227 if (con->type == CT_WORKSPACE) {
229 y(integer, con->num);
234 y(integer, con->window->id);
240 if (con->type != CT_DOCKAREA || !inplace_restart) {
241 TAILQ_FOREACH(node, &(con->nodes_head), nodes) {
242 dump_node(gen, node, inplace_restart);
247 ystr("floating_nodes");
249 TAILQ_FOREACH(node, &(con->floating_head), floating_windows) {
250 dump_node(gen, node, inplace_restart);
256 TAILQ_FOREACH(node, &(con->focus_head), focused) {
257 y(integer, (long int)node);
261 ystr("fullscreen_mode");
262 y(integer, con->fullscreen_mode);
267 TAILQ_FOREACH(match, &(con->swallow_head), matches) {
268 if (match->dock != -1) {
271 y(integer, match->dock);
272 ystr("insert_where");
273 y(integer, match->insert_where);
277 /* TODO: the other swallow keys */
280 if (inplace_restart) {
281 if (con->window != NULL) {
284 y(integer, con->window->id);
294 setlocale(LC_NUMERIC, "C");
296 yajl_gen gen = yajl_gen_alloc(NULL);
298 yajl_gen gen = yajl_gen_alloc(NULL, NULL);
300 dump_node(gen, croot, false);
301 setlocale(LC_NUMERIC, "");
303 const unsigned char *payload;
309 y(get_buf, &payload, &length);
311 ipc_send_message(fd, length, I3_IPC_REPLY_TYPE_TREE, payload);
317 * Formats the reply message for a GET_WORKSPACES request and sends it to the
321 IPC_HANDLER(get_workspaces) {
323 yajl_gen gen = yajl_gen_alloc(NULL);
325 yajl_gen gen = yajl_gen_alloc(NULL, NULL);
329 Con *focused_ws = con_get_workspace(focused);
332 TAILQ_FOREACH(output, &(croot->nodes_head), nodes) {
334 TAILQ_FOREACH(ws, &(output_get_content(output)->nodes_head), nodes) {
335 assert(ws->type == CT_WORKSPACE);
341 else y(integer, ws->num);
347 y(bool, workspace_is_visible(ws));
350 y(bool, ws == focused_ws);
355 y(integer, ws->rect.x);
357 y(integer, ws->rect.y);
359 y(integer, ws->rect.width);
361 y(integer, ws->rect.height);
376 const unsigned char *payload;
382 y(get_buf, &payload, &length);
384 ipc_send_message(fd, length, I3_IPC_REPLY_TYPE_WORKSPACES, payload);
389 * Formats the reply message for a GET_OUTPUTS request and sends it to the
393 IPC_HANDLER(get_outputs) {
395 yajl_gen gen = yajl_gen_alloc(NULL);
397 yajl_gen gen = yajl_gen_alloc(NULL, NULL);
402 TAILQ_FOREACH(output, &outputs, outputs) {
409 y(bool, output->active);
414 y(integer, output->rect.x);
416 y(integer, output->rect.y);
418 y(integer, output->rect.width);
420 y(integer, output->rect.height);
423 ystr("current_workspace");
425 if (output->con && (ws = con_get_fullscreen_con(output->con, CF_OUTPUT)))
434 const unsigned char *payload;
440 y(get_buf, &payload, &length);
442 ipc_send_message(fd, length, I3_IPC_REPLY_TYPE_OUTPUTS, payload);
447 * Formats the reply message for a GET_MARKS request and sends it to the
451 IPC_HANDLER(get_marks) {
453 yajl_gen gen = yajl_gen_alloc(NULL);
455 yajl_gen gen = yajl_gen_alloc(NULL, NULL);
460 TAILQ_FOREACH(con, &all_cons, all_cons)
461 if (con->mark != NULL)
466 const unsigned char *payload;
472 y(get_buf, &payload, &length);
474 ipc_send_message(fd, length, I3_IPC_REPLY_TYPE_MARKS, payload);
479 * Formats the reply message for a GET_BAR_CONFIG request and sends it to the
483 IPC_HANDLER(get_bar_config) {
485 yajl_gen gen = yajl_gen_alloc(NULL);
487 yajl_gen gen = yajl_gen_alloc(NULL, NULL);
490 /* If no ID was passed, we return a JSON array with all IDs */
491 if (message_size == 0) {
494 TAILQ_FOREACH(current, &barconfigs, configs) {
499 const unsigned char *payload;
505 y(get_buf, &payload, &length);
507 ipc_send_message(fd, length, I3_IPC_REPLY_TYPE_BAR_CONFIG, payload);
512 /* To get a properly terminated buffer, we copy
513 * message_size bytes out of the buffer */
514 char *bar_id = scalloc(message_size + 1);
515 strncpy(bar_id, (const char*)message, message_size);
516 LOG("IPC: looking for config for bar ID \"%s\"\n", bar_id);
517 Barconfig *current, *config = NULL;
518 TAILQ_FOREACH(current, &barconfigs, configs) {
519 if (strcmp(current->id, bar_id) != 0)
529 /* If we did not find a config for the given ID, the reply will contain
530 * a null 'id' field. */
537 if (config->num_outputs > 0) {
540 for (int c = 0; c < config->num_outputs; c++)
541 ystr(config->outputs[c]);
545 #define YSTR_IF_SET(name) \
547 if (config->name) { \
549 ystr(config->name); \
553 YSTR_IF_SET(tray_output);
554 YSTR_IF_SET(socket_path);
557 if (config->mode == M_HIDE)
562 if (config->position == P_BOTTOM)
566 YSTR_IF_SET(status_command);
569 ystr("workspace_buttons");
570 y(bool, !config->hide_workspace_buttons);
573 y(bool, config->verbose);
576 #define YSTR_IF_SET(name) \
578 if (config->colors.name) { \
580 ystr(config->colors.name); \
586 YSTR_IF_SET(background);
587 YSTR_IF_SET(statusline);
588 YSTR_IF_SET(focused_workspace_text);
589 YSTR_IF_SET(focused_workspace_bg);
590 YSTR_IF_SET(active_workspace_text);
591 YSTR_IF_SET(active_workspace_bg);
592 YSTR_IF_SET(inactive_workspace_text);
593 YSTR_IF_SET(inactive_workspace_bg);
594 YSTR_IF_SET(urgent_workspace_text);
595 YSTR_IF_SET(urgent_workspace_bg);
603 const unsigned char *payload;
609 y(get_buf, &payload, &length);
611 ipc_send_message(fd, length, I3_IPC_REPLY_TYPE_BAR_CONFIG, payload);
616 * Formats the reply message for a GET_LOG_MARKERS request and sends it to the
620 IPC_HANDLER(get_log_markers) {
622 yajl_gen gen = yajl_gen_alloc(NULL);
624 yajl_gen gen = yajl_gen_alloc(NULL, NULL);
627 int offset_next_write, offset_last_wrap, logsize;
628 get_log_markers(&offset_next_write, &offset_last_wrap, &logsize);
631 ystr("offset_next_write");
632 y(integer, offset_next_write);
634 ystr("offset_last_wrap");
635 y(integer, offset_last_wrap);
645 const unsigned char *payload;
651 y(get_buf, &payload, &length);
653 ipc_send_message(fd, length, I3_IPC_REPLY_TYPE_LOG_MARKERS, payload);
658 * Callback for the YAJL parser (will be called when a string is parsed).
662 static int add_subscription(void *extra, const unsigned char *s,
665 static int add_subscription(void *extra, const unsigned char *s,
668 ipc_client *client = extra;
670 DLOG("should add subscription to extra %p, sub %.*s\n", client, len, s);
671 int event = client->num_events;
673 client->num_events++;
674 client->events = realloc(client->events, client->num_events * sizeof(char*));
675 /* We copy the string because it is not null-terminated and strndup()
676 * is missing on some BSD systems */
677 client->events[event] = scalloc(len+1);
678 memcpy(client->events[event], s, len);
680 DLOG("client is now subscribed to:\n");
681 for (int i = 0; i < client->num_events; i++)
682 DLOG("event %s\n", client->events[i]);
689 * Subscribes this connection to the event types which were given as a JSON
690 * serialized array in the payload field of the message.
693 IPC_HANDLER(subscribe) {
695 yajl_callbacks callbacks;
697 ipc_client *current, *client = NULL;
699 /* Search the ipc_client structure for this connection */
700 TAILQ_FOREACH(current, &all_clients, clients) {
701 if (current->fd != fd)
708 if (client == NULL) {
709 ELOG("Could not find ipc_client data structure for fd %d\n", fd);
713 /* Setup the JSON parser */
714 memset(&callbacks, 0, sizeof(yajl_callbacks));
715 callbacks.yajl_string = add_subscription;
718 p = yajl_alloc(&callbacks, NULL, (void*)client);
720 p = yajl_alloc(&callbacks, NULL, NULL, (void*)client);
722 stat = yajl_parse(p, (const unsigned char*)message, message_size);
723 if (stat != yajl_status_ok) {
725 err = yajl_get_error(p, true, (const unsigned char*)message,
727 ELOG("YAJL parse error: %s\n", err);
728 yajl_free_error(p, err);
730 const char *reply = "{\"success\":false}";
731 ipc_send_message(fd, strlen(reply), I3_IPC_REPLY_TYPE_SUBSCRIBE, (const uint8_t*)reply);
736 const char *reply = "{\"success\":true}";
737 ipc_send_message(fd, strlen(reply), I3_IPC_REPLY_TYPE_SUBSCRIBE, (const uint8_t*)reply);
740 /* The index of each callback function corresponds to the numeric
741 * value of the message type (see include/i3/ipc.h) */
742 handler_t handlers[8] = {
744 handle_get_workspaces,
749 handle_get_bar_config,
750 handle_get_log_markers
754 * Handler for activity on a client connection, receives a message from a
757 * For now, the maximum message size is 2048. I’m not sure for what the
758 * IPC interface will be used in the future, thus I’m not implementing a
759 * mechanism for arbitrarily long messages, as it seems like overkill
763 static void ipc_receive_message(EV_P_ struct ev_io *w, int revents) {
765 int n = read(w->fd, buf, sizeof(buf));
767 /* On error or an empty message, we close the connection */
770 /* FIXME: I get these when closing a client socket,
771 * therefore we just treat them as an error. Is this
773 if (errno == EAGAIN || errno == EWOULDBLOCK)
777 /* If not, there was some kind of error. We don’t bother
778 * and close the connection */
781 /* Delete the client from the list of clients */
783 TAILQ_FOREACH(current, &all_clients, clients) {
784 if (current->fd != w->fd)
787 for (int i = 0; i < current->num_events; i++)
788 free(current->events[i]);
789 /* We can call TAILQ_REMOVE because we break out of the
790 * TAILQ_FOREACH afterwards */
791 TAILQ_REMOVE(&all_clients, current, clients);
799 DLOG("IPC: client disconnected\n");
803 /* Terminate the message correctly */
806 /* Check if the message starts with the i3 IPC magic code */
807 if (n < strlen(I3_IPC_MAGIC)) {
808 DLOG("IPC: message too short, ignoring\n");
812 if (strncmp(buf, I3_IPC_MAGIC, strlen(I3_IPC_MAGIC)) != 0) {
813 DLOG("IPC: message does not start with the IPC magic\n");
817 uint8_t *message = (uint8_t*)buf;
819 DLOG("IPC: n = %d\n", n);
820 message += strlen(I3_IPC_MAGIC);
821 n -= strlen(I3_IPC_MAGIC);
823 /* The next 32 bit after the magic are the message size */
824 uint32_t message_size;
825 memcpy(&message_size, (uint32_t*)message, sizeof(uint32_t));
826 message += sizeof(uint32_t);
827 n -= sizeof(uint32_t);
829 if (message_size > n) {
830 DLOG("IPC: Either the message size was wrong or the message was not read completely, dropping\n");
834 /* The last 32 bits of the header are the message type */
835 uint32_t message_type;
836 memcpy(&message_type, (uint32_t*)message, sizeof(uint32_t));
837 message += sizeof(uint32_t);
838 n -= sizeof(uint32_t);
840 if (message_type >= (sizeof(handlers) / sizeof(handler_t)))
841 DLOG("Unhandled message type: %d\n", message_type);
843 handler_t h = handlers[message_type];
844 h(w->fd, message, n, message_size, message_type);
847 message += message_size;
852 * Handler for activity on the listening socket, meaning that a new client
853 * has just connected and we should accept() him. Sets up the event handler
854 * for activity on the new connection and inserts the file descriptor into
855 * the list of clients.
858 void ipc_new_client(EV_P_ struct ev_io *w, int revents) {
859 struct sockaddr_un peer;
860 socklen_t len = sizeof(struct sockaddr_un);
862 if ((client = accept(w->fd, (struct sockaddr*)&peer, &len)) < 0) {
865 else perror("accept()");
869 /* Close this file descriptor on exec() */
870 (void)fcntl(client, F_SETFD, FD_CLOEXEC);
872 set_nonblock(client);
874 struct ev_io *package = scalloc(sizeof(struct ev_io));
875 ev_io_init(package, ipc_receive_message, client, EV_READ);
876 ev_io_start(EV_A_ package);
878 DLOG("IPC: new client connected on fd %d\n", w->fd);
880 ipc_client *new = scalloc(sizeof(ipc_client));
883 TAILQ_INSERT_TAIL(&all_clients, new, clients);
887 * Creates the UNIX domain socket at the given path, sets it to non-blocking
888 * mode, bind()s and listen()s on it.
891 int ipc_create_socket(const char *filename) {
894 FREE(current_socketpath);
896 char *resolved = resolve_tilde(filename);
897 DLOG("Creating IPC-socket at %s\n", resolved);
898 char *copy = sstrdup(resolved);
899 const char *dir = dirname(copy);
900 if (!path_exists(dir))
904 /* Unlink the unix domain socket before */
907 if ((sockfd = socket(AF_LOCAL, SOCK_STREAM, 0)) < 0) {
913 (void)fcntl(sockfd, F_SETFD, FD_CLOEXEC);
915 struct sockaddr_un addr;
916 memset(&addr, 0, sizeof(struct sockaddr_un));
917 addr.sun_family = AF_LOCAL;
918 strncpy(addr.sun_path, resolved, sizeof(addr.sun_path) - 1);
919 if (bind(sockfd, (struct sockaddr*)&addr, sizeof(struct sockaddr_un)) < 0) {
925 set_nonblock(sockfd);
927 if (listen(sockfd, 5) < 0) {
933 current_socketpath = resolved;