2 #define I3__FILE__ "ipc.c"
4 * vim:ts=4:sw=4:expandtab
6 * i3 - an improved dynamic tiling window manager
7 * © 2009-2012 Michael Stapelberg and contributors (see also: LICENSE)
9 * ipc.c: UNIX domain socket IPC (initialization, client handling, protocol).
13 #include "yajl_utils.h"
15 #include <sys/socket.h>
20 #include <yajl/yajl_gen.h>
21 #include <yajl/yajl_parse.h>
23 char *current_socketpath = NULL;
25 TAILQ_HEAD(ipc_client_head, ipc_client) all_clients = TAILQ_HEAD_INITIALIZER(all_clients);
28 * Puts the given socket file descriptor into non-blocking mode or dies if
29 * setting O_NONBLOCK failed. Non-blocking sockets are a good idea for our
30 * IPC model because we should by no means block the window manager.
33 static void set_nonblock(int sockfd) {
34 int flags = fcntl(sockfd, F_GETFL, 0);
36 if (fcntl(sockfd, F_SETFL, flags) < 0)
37 err(-1, "Could not set O_NONBLOCK");
41 * Emulates mkdir -p (creates any missing folders)
44 static bool mkdirp(const char *path) {
45 if (mkdir(path, S_IRWXU | S_IRGRP | S_IXGRP | S_IROTH | S_IXOTH) == 0)
47 if (errno != ENOENT) {
48 ELOG("mkdir(%s) failed: %s\n", path, strerror(errno));
51 char *copy = sstrdup(path);
52 /* strip trailing slashes, if any */
53 while (copy[strlen(copy)-1] == '/')
54 copy[strlen(copy)-1] = '\0';
56 char *sep = strrchr(copy, '/');
64 result = mkdirp(path);
71 * Sends the specified event to all IPC clients which are currently connected
72 * and subscribed to this kind of event.
75 void ipc_send_event(const char *event, uint32_t message_type, const char *payload) {
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)
89 ipc_send_message(current->fd, strlen(payload), message_type, (const uint8_t*)payload);
94 * Calls shutdown() on each socket and closes it. This function to be called
95 * when exiting or restarting only!
98 void ipc_shutdown(void) {
100 while (!TAILQ_EMPTY(&all_clients)) {
101 current = TAILQ_FIRST(&all_clients);
102 shutdown(current->fd, SHUT_RDWR);
104 TAILQ_REMOVE(&all_clients, current, clients);
110 * Executes the command and returns whether it could be successfully parsed
111 * or not (at the moment, always returns true).
114 IPC_HANDLER(command) {
115 /* To get a properly terminated buffer, we copy
116 * message_size bytes out of the buffer */
117 char *command = scalloc(message_size + 1);
118 strncpy(command, (const char*)message, message_size);
119 LOG("IPC: received: *%s*\n", command);
120 yajl_gen gen = yajl_gen_alloc(NULL);
122 CommandResult *result = parse_command((const char*)command, gen);
125 if (result->needs_tree_render)
128 command_result_free(result);
130 const unsigned char *reply;
132 yajl_gen_get_buf(gen, &reply, &length);
134 ipc_send_message(fd, length, I3_IPC_REPLY_TYPE_COMMAND,
135 (const uint8_t*)reply);
140 static void dump_rect(yajl_gen gen, const char *name, Rect r) {
150 y(integer, r.height);
154 void dump_node(yajl_gen gen, struct Con *con, bool inplace_restart) {
157 y(integer, (long int)con);
170 case CT_FLOATING_CON:
171 ystr("floating_con");
180 DLOG("About to dump unknown container type=%d. This is a bug.\n", con->type);
185 /* provided for backwards compatibility only. */
187 if (!con_is_split(con))
190 if (con_orientation(con) == HORIZ)
192 else ystr("vertical");
195 ystr("scratchpad_state");
196 switch (con->scratchpad_state) {
197 case SCRATCHPAD_NONE:
200 case SCRATCHPAD_FRESH:
203 case SCRATCHPAD_CHANGED:
209 if (con->percent == 0.0)
211 else y(double, con->percent);
214 y(bool, con->urgent);
216 if (con->mark != NULL) {
222 y(bool, (con == focused));
225 switch (con->layout) {
227 DLOG("About to dump layout=default, this is a bug in the code.\n");
250 ystr("workspace_layout");
251 switch (con->workspace_layout) {
262 DLOG("About to dump workspace_layout=%d (none of default/stacked/tabbed), this is a bug.\n", con->workspace_layout);
267 ystr("last_split_layout");
268 switch (con->layout) {
278 switch (con->border_style) {
290 ystr("current_border_width");
291 y(integer, con->current_border_width);
293 dump_rect(gen, "rect", con->rect);
294 dump_rect(gen, "window_rect", con->window_rect);
295 dump_rect(gen, "geometry", con->geometry);
298 if (con->window && con->window->name)
299 ystr(i3string_as_utf8(con->window->name));
303 if (con->type == CT_WORKSPACE) {
305 y(integer, con->num);
310 y(integer, con->window->id);
313 if (con->window && !inplace_restart) {
314 /* Window properties are useless to preserve when restarting because
315 * they will be queried again anyway. However, for i3-save-tree(1),
316 * they are very useful and save i3-save-tree dealing with X11. */
317 ystr("window_properties");
320 #define DUMP_PROPERTY(key, prop_name) do { \
321 if (con->window->prop_name != NULL) { \
323 ystr(con->window->prop_name); \
327 DUMP_PROPERTY("class", class_class);
328 DUMP_PROPERTY("instance", class_instance);
329 DUMP_PROPERTY("window_role", role);
331 if (con->window->name != NULL) {
333 ystr(i3string_as_utf8(con->window->name));
342 if (con->type != CT_DOCKAREA || !inplace_restart) {
343 TAILQ_FOREACH(node, &(con->nodes_head), nodes) {
344 dump_node(gen, node, inplace_restart);
349 ystr("floating_nodes");
351 TAILQ_FOREACH(node, &(con->floating_head), floating_windows) {
352 dump_node(gen, node, inplace_restart);
358 TAILQ_FOREACH(node, &(con->focus_head), focused) {
359 y(integer, (long int)node);
363 ystr("fullscreen_mode");
364 y(integer, con->fullscreen_mode);
367 switch (con->floating) {
368 case FLOATING_AUTO_OFF:
371 case FLOATING_AUTO_ON:
374 case FLOATING_USER_OFF:
377 case FLOATING_USER_ON:
385 TAILQ_FOREACH(match, &(con->swallow_head), matches) {
387 if (match->dock != -1) {
389 y(integer, match->dock);
390 ystr("insert_where");
391 y(integer, match->insert_where);
394 #define DUMP_REGEX(re_name) do { \
395 if (match->re_name != NULL) { \
397 ystr(match->re_name->pattern); \
402 DUMP_REGEX(instance);
403 DUMP_REGEX(window_role);
410 if (inplace_restart) {
411 if (con->window != NULL) {
414 y(integer, con->window->id);
415 ystr("restart_mode");
422 if (inplace_restart && con->window != NULL) {
424 y(integer, con->depth);
430 static void dump_bar_config(yajl_gen gen, Barconfig *config) {
436 if (config->num_outputs > 0) {
439 for (int c = 0; c < config->num_outputs; c++)
440 ystr(config->outputs[c]);
444 #define YSTR_IF_SET(name) \
446 if (config->name) { \
448 ystr(config->name); \
452 YSTR_IF_SET(tray_output);
453 YSTR_IF_SET(socket_path);
456 switch (config->mode) {
469 ystr("hidden_state");
470 switch (config->hidden_state) {
481 switch (config->modifier) {
511 if (config->position == P_BOTTOM)
515 YSTR_IF_SET(status_command);
518 ystr("workspace_buttons");
519 y(bool, !config->hide_workspace_buttons);
521 ystr("strip_workspace_numbers");
522 y(bool, config->strip_workspace_numbers);
524 ystr("binding_mode_indicator");
525 y(bool, !config->hide_binding_mode_indicator);
528 y(bool, config->verbose);
531 #define YSTR_IF_SET(name) \
533 if (config->colors.name) { \
535 ystr(config->colors.name); \
541 YSTR_IF_SET(background);
542 YSTR_IF_SET(statusline);
543 YSTR_IF_SET(separator);
544 YSTR_IF_SET(focused_workspace_border);
545 YSTR_IF_SET(focused_workspace_bg);
546 YSTR_IF_SET(focused_workspace_text);
547 YSTR_IF_SET(active_workspace_border);
548 YSTR_IF_SET(active_workspace_bg);
549 YSTR_IF_SET(active_workspace_text);
550 YSTR_IF_SET(inactive_workspace_border);
551 YSTR_IF_SET(inactive_workspace_bg);
552 YSTR_IF_SET(inactive_workspace_text);
553 YSTR_IF_SET(urgent_workspace_border);
554 YSTR_IF_SET(urgent_workspace_bg);
555 YSTR_IF_SET(urgent_workspace_text);
563 setlocale(LC_NUMERIC, "C");
564 yajl_gen gen = ygenalloc();
565 dump_node(gen, croot, false);
566 setlocale(LC_NUMERIC, "");
568 const unsigned char *payload;
570 y(get_buf, &payload, &length);
572 ipc_send_message(fd, length, I3_IPC_REPLY_TYPE_TREE, payload);
578 * Formats the reply message for a GET_WORKSPACES request and sends it to the
582 IPC_HANDLER(get_workspaces) {
583 yajl_gen gen = ygenalloc();
586 Con *focused_ws = con_get_workspace(focused);
589 TAILQ_FOREACH(output, &(croot->nodes_head), nodes) {
590 if (con_is_internal(output))
593 TAILQ_FOREACH(ws, &(output_get_content(output)->nodes_head), nodes) {
594 assert(ws->type == CT_WORKSPACE);
600 else y(integer, ws->num);
606 y(bool, workspace_is_visible(ws));
609 y(bool, ws == focused_ws);
614 y(integer, ws->rect.x);
616 y(integer, ws->rect.y);
618 y(integer, ws->rect.width);
620 y(integer, ws->rect.height);
635 const unsigned char *payload;
637 y(get_buf, &payload, &length);
639 ipc_send_message(fd, length, I3_IPC_REPLY_TYPE_WORKSPACES, payload);
644 * Formats the reply message for a GET_OUTPUTS request and sends it to the
648 IPC_HANDLER(get_outputs) {
649 yajl_gen gen = ygenalloc();
653 TAILQ_FOREACH(output, &outputs, outputs) {
660 y(bool, output->active);
663 y(bool, output->primary);
668 y(integer, output->rect.x);
670 y(integer, output->rect.y);
672 y(integer, output->rect.width);
674 y(integer, output->rect.height);
677 ystr("current_workspace");
679 if (output->con && (ws = con_get_fullscreen_con(output->con, CF_OUTPUT)))
688 const unsigned char *payload;
690 y(get_buf, &payload, &length);
692 ipc_send_message(fd, length, I3_IPC_REPLY_TYPE_OUTPUTS, payload);
697 * Formats the reply message for a GET_MARKS request and sends it to the
701 IPC_HANDLER(get_marks) {
702 yajl_gen gen = ygenalloc();
706 TAILQ_FOREACH(con, &all_cons, all_cons)
707 if (con->mark != NULL)
712 const unsigned char *payload;
714 y(get_buf, &payload, &length);
716 ipc_send_message(fd, length, I3_IPC_REPLY_TYPE_MARKS, payload);
721 * Returns the version of i3
724 IPC_HANDLER(get_version) {
725 yajl_gen gen = ygenalloc();
729 y(integer, MAJOR_VERSION);
732 y(integer, MINOR_VERSION);
735 y(integer, PATCH_VERSION);
737 ystr("human_readable");
742 const unsigned char *payload;
744 y(get_buf, &payload, &length);
746 ipc_send_message(fd, length, I3_IPC_REPLY_TYPE_VERSION, payload);
751 * Formats the reply message for a GET_BAR_CONFIG request and sends it to the
755 IPC_HANDLER(get_bar_config) {
756 yajl_gen gen = ygenalloc();
758 /* If no ID was passed, we return a JSON array with all IDs */
759 if (message_size == 0) {
762 TAILQ_FOREACH(current, &barconfigs, configs) {
767 const unsigned char *payload;
769 y(get_buf, &payload, &length);
771 ipc_send_message(fd, length, I3_IPC_REPLY_TYPE_BAR_CONFIG, payload);
776 /* To get a properly terminated buffer, we copy
777 * message_size bytes out of the buffer */
778 char *bar_id = scalloc(message_size + 1);
779 strncpy(bar_id, (const char*)message, message_size);
780 LOG("IPC: looking for config for bar ID \"%s\"\n", bar_id);
781 Barconfig *current, *config = NULL;
782 TAILQ_FOREACH(current, &barconfigs, configs) {
783 if (strcmp(current->id, bar_id) != 0)
791 /* If we did not find a config for the given ID, the reply will contain
792 * a null 'id' field. */
800 dump_bar_config(gen, config);
803 const unsigned char *payload;
805 y(get_buf, &payload, &length);
807 ipc_send_message(fd, length, I3_IPC_REPLY_TYPE_BAR_CONFIG, payload);
812 * Callback for the YAJL parser (will be called when a string is parsed).
815 static int add_subscription(void *extra, const unsigned char *s,
817 ipc_client *client = extra;
819 DLOG("should add subscription to extra %p, sub %.*s\n", client, (int)len, s);
820 int event = client->num_events;
822 client->num_events++;
823 client->events = realloc(client->events, client->num_events * sizeof(char*));
824 /* We copy the string because it is not null-terminated and strndup()
825 * is missing on some BSD systems */
826 client->events[event] = scalloc(len+1);
827 memcpy(client->events[event], s, len);
829 DLOG("client is now subscribed to:\n");
830 for (int i = 0; i < client->num_events; i++)
831 DLOG("event %s\n", client->events[i]);
838 * Subscribes this connection to the event types which were given as a JSON
839 * serialized array in the payload field of the message.
842 IPC_HANDLER(subscribe) {
845 ipc_client *current, *client = NULL;
847 /* Search the ipc_client structure for this connection */
848 TAILQ_FOREACH(current, &all_clients, clients) {
849 if (current->fd != fd)
856 if (client == NULL) {
857 ELOG("Could not find ipc_client data structure for fd %d\n", fd);
861 /* Setup the JSON parser */
862 static yajl_callbacks callbacks = {
863 .yajl_string = add_subscription,
866 p = yalloc(&callbacks, (void*)client);
867 stat = yajl_parse(p, (const unsigned char*)message, message_size);
868 if (stat != yajl_status_ok) {
870 err = yajl_get_error(p, true, (const unsigned char*)message,
872 ELOG("YAJL parse error: %s\n", err);
873 yajl_free_error(p, err);
875 const char *reply = "{\"success\":false}";
876 ipc_send_message(fd, strlen(reply), I3_IPC_REPLY_TYPE_SUBSCRIBE, (const uint8_t*)reply);
881 const char *reply = "{\"success\":true}";
882 ipc_send_message(fd, strlen(reply), I3_IPC_REPLY_TYPE_SUBSCRIBE, (const uint8_t*)reply);
885 /* The index of each callback function corresponds to the numeric
886 * value of the message type (see include/i3/ipc.h) */
887 handler_t handlers[8] = {
889 handle_get_workspaces,
894 handle_get_bar_config,
899 * Handler for activity on a client connection, receives a message from a
902 * For now, the maximum message size is 2048. I’m not sure for what the
903 * IPC interface will be used in the future, thus I’m not implementing a
904 * mechanism for arbitrarily long messages, as it seems like overkill
908 static void ipc_receive_message(EV_P_ struct ev_io *w, int revents) {
909 uint32_t message_type;
910 uint32_t message_length;
911 uint8_t *message = NULL;
913 int ret = ipc_recv_message(w->fd, &message_type, &message_length, &message);
914 /* EOF or other error */
916 /* Was this a spurious read? See ev(3) */
917 if (ret == -1 && errno == EAGAIN) {
922 /* If not, there was some kind of error. We don’t bother
923 * and close the connection */
926 /* Delete the client from the list of clients */
928 TAILQ_FOREACH(current, &all_clients, clients) {
929 if (current->fd != w->fd)
932 for (int i = 0; i < current->num_events; i++)
933 free(current->events[i]);
934 /* We can call TAILQ_REMOVE because we break out of the
935 * TAILQ_FOREACH afterwards */
936 TAILQ_REMOVE(&all_clients, current, clients);
945 DLOG("IPC: client disconnected\n");
949 if (message_type >= (sizeof(handlers) / sizeof(handler_t)))
950 DLOG("Unhandled message type: %d\n", message_type);
952 handler_t h = handlers[message_type];
953 h(w->fd, message, 0, message_length, message_type);
960 * Handler for activity on the listening socket, meaning that a new client
961 * has just connected and we should accept() him. Sets up the event handler
962 * for activity on the new connection and inserts the file descriptor into
963 * the list of clients.
966 void ipc_new_client(EV_P_ struct ev_io *w, int revents) {
967 struct sockaddr_un peer;
968 socklen_t len = sizeof(struct sockaddr_un);
970 if ((client = accept(w->fd, (struct sockaddr*)&peer, &len)) < 0) {
973 else perror("accept()");
977 /* Close this file descriptor on exec() */
978 (void)fcntl(client, F_SETFD, FD_CLOEXEC);
980 set_nonblock(client);
982 struct ev_io *package = scalloc(sizeof(struct ev_io));
983 ev_io_init(package, ipc_receive_message, client, EV_READ);
984 ev_io_start(EV_A_ package);
986 DLOG("IPC: new client connected on fd %d\n", w->fd);
988 ipc_client *new = scalloc(sizeof(ipc_client));
991 TAILQ_INSERT_TAIL(&all_clients, new, clients);
995 * Creates the UNIX domain socket at the given path, sets it to non-blocking
996 * mode, bind()s and listen()s on it.
999 int ipc_create_socket(const char *filename) {
1002 FREE(current_socketpath);
1004 char *resolved = resolve_tilde(filename);
1005 DLOG("Creating IPC-socket at %s\n", resolved);
1006 char *copy = sstrdup(resolved);
1007 const char *dir = dirname(copy);
1008 if (!path_exists(dir))
1012 /* Unlink the unix domain socket before */
1015 if ((sockfd = socket(AF_LOCAL, SOCK_STREAM, 0)) < 0) {
1021 (void)fcntl(sockfd, F_SETFD, FD_CLOEXEC);
1023 struct sockaddr_un addr;
1024 memset(&addr, 0, sizeof(struct sockaddr_un));
1025 addr.sun_family = AF_LOCAL;
1026 strncpy(addr.sun_path, resolved, sizeof(addr.sun_path) - 1);
1027 if (bind(sockfd, (struct sockaddr*)&addr, sizeof(struct sockaddr_un)) < 0) {
1033 set_nonblock(sockfd);
1035 if (listen(sockfd, 5) < 0) {
1041 current_socketpath = resolved;
1046 * For the workspace "focus" event we send, along the usual "change" field,
1047 * also the current and previous workspace, in "current" and "old"
1050 void ipc_send_workspace_focus_event(Con *current, Con *old) {
1051 setlocale(LC_NUMERIC, "C");
1052 yajl_gen gen = ygenalloc();
1060 dump_node(gen, current, false);
1066 dump_node(gen, old, false);
1070 const unsigned char *payload;
1072 y(get_buf, &payload, &length);
1074 ipc_send_event("workspace", I3_IPC_EVENT_WORKSPACE, (const char *)payload);
1076 setlocale(LC_NUMERIC, "");
1080 * For the window events we send, along the usual "change" field,
1081 * also the window container, in "container".
1083 void ipc_send_window_event(const char *property, Con *con) {
1084 DLOG("Issue IPC window %s event (con = %p, window = 0x%08x)\n",
1085 property, con, (con->window ? con->window->id : XCB_WINDOW_NONE));
1087 setlocale(LC_NUMERIC, "C");
1088 yajl_gen gen = ygenalloc();
1096 dump_node(gen, con, false);
1100 const unsigned char *payload;
1102 y(get_buf, &payload, &length);
1104 ipc_send_event("window", I3_IPC_EVENT_WINDOW, (const char *)payload);
1106 setlocale(LC_NUMERIC, "");
1110 * For the barconfig update events, we send the serialized barconfig.
1112 void ipc_send_barconfig_update_event(Barconfig *barconfig) {
1113 DLOG("Issue barconfig_update event for id = %s\n", barconfig->id);
1114 setlocale(LC_NUMERIC, "C");
1115 yajl_gen gen = ygenalloc();
1117 dump_bar_config(gen, barconfig);
1119 const unsigned char *payload;
1121 y(get_buf, &payload, &length);
1123 ipc_send_event("barconfig_update", I3_IPC_EVENT_BARCONFIG_UPDATE, (const char *)payload);
1125 setlocale(LC_NUMERIC, "");