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 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)
196 ystr("scratchpad_state");
197 switch (con->scratchpad_state) {
198 case SCRATCHPAD_NONE:
201 case SCRATCHPAD_FRESH:
204 case SCRATCHPAD_CHANGED:
210 if (con->percent == 0.0)
213 y(double, con->percent);
216 y(bool, con->urgent);
218 if (con->mark != NULL) {
224 y(bool, (con == focused));
227 switch (con->layout) {
229 DLOG("About to dump layout=default, this is a bug in the code.\n");
252 ystr("workspace_layout");
253 switch (con->workspace_layout) {
264 DLOG("About to dump workspace_layout=%d (none of default/stacked/tabbed), this is a bug.\n", con->workspace_layout);
269 ystr("last_split_layout");
270 switch (con->layout) {
280 switch (con->border_style) {
292 ystr("current_border_width");
293 y(integer, con->current_border_width);
295 dump_rect(gen, "rect", con->rect);
296 dump_rect(gen, "window_rect", con->window_rect);
297 dump_rect(gen, "geometry", con->geometry);
300 if (con->window && con->window->name)
301 ystr(i3string_as_utf8(con->window->name));
302 else if (con->name != NULL)
307 if (con->type == CT_WORKSPACE) {
309 y(integer, con->num);
314 y(integer, con->window->id);
318 if (con->window && !inplace_restart) {
319 /* Window properties are useless to preserve when restarting because
320 * they will be queried again anyway. However, for i3-save-tree(1),
321 * they are very useful and save i3-save-tree dealing with X11. */
322 ystr("window_properties");
325 #define DUMP_PROPERTY(key, prop_name) \
327 if (con->window->prop_name != NULL) { \
329 ystr(con->window->prop_name); \
333 DUMP_PROPERTY("class", class_class);
334 DUMP_PROPERTY("instance", class_instance);
335 DUMP_PROPERTY("window_role", role);
337 if (con->window->name != NULL) {
339 ystr(i3string_as_utf8(con->window->name));
348 if (con->type != CT_DOCKAREA || !inplace_restart) {
349 TAILQ_FOREACH(node, &(con->nodes_head), nodes) {
350 dump_node(gen, node, inplace_restart);
355 ystr("floating_nodes");
357 TAILQ_FOREACH(node, &(con->floating_head), floating_windows) {
358 dump_node(gen, node, inplace_restart);
364 TAILQ_FOREACH(node, &(con->focus_head), focused) {
365 y(integer, (long int)node);
369 ystr("fullscreen_mode");
370 y(integer, con->fullscreen_mode);
373 switch (con->floating) {
374 case FLOATING_AUTO_OFF:
377 case FLOATING_AUTO_ON:
380 case FLOATING_USER_OFF:
383 case FLOATING_USER_ON:
391 TAILQ_FOREACH(match, &(con->swallow_head), matches) {
393 if (match->dock != -1) {
395 y(integer, match->dock);
396 ystr("insert_where");
397 y(integer, match->insert_where);
400 #define DUMP_REGEX(re_name) \
402 if (match->re_name != NULL) { \
404 ystr(match->re_name->pattern); \
409 DUMP_REGEX(instance);
410 DUMP_REGEX(window_role);
417 if (inplace_restart) {
418 if (con->window != NULL) {
421 y(integer, con->window->id);
422 ystr("restart_mode");
429 if (inplace_restart && con->window != NULL) {
431 y(integer, con->depth);
437 static void dump_bar_config(yajl_gen gen, Barconfig *config) {
443 if (config->num_outputs > 0) {
446 for (int c = 0; c < config->num_outputs; c++)
447 ystr(config->outputs[c]);
451 #define YSTR_IF_SET(name) \
453 if (config->name) { \
455 ystr(config->name); \
459 YSTR_IF_SET(tray_output);
460 YSTR_IF_SET(socket_path);
463 switch (config->mode) {
476 ystr("hidden_state");
477 switch (config->hidden_state) {
488 switch (config->modifier) {
517 if (config->wheel_up_cmd) {
518 ystr("wheel_up_cmd");
519 ystr(config->wheel_up_cmd);
522 if (config->wheel_down_cmd) {
523 ystr("wheel_down_cmd");
524 ystr(config->wheel_down_cmd);
528 if (config->position == P_BOTTOM)
533 YSTR_IF_SET(status_command);
536 ystr("workspace_buttons");
537 y(bool, !config->hide_workspace_buttons);
539 ystr("strip_workspace_numbers");
540 y(bool, config->strip_workspace_numbers);
542 ystr("binding_mode_indicator");
543 y(bool, !config->hide_binding_mode_indicator);
546 y(bool, config->verbose);
549 #define YSTR_IF_SET(name) \
551 if (config->colors.name) { \
553 ystr(config->colors.name); \
559 YSTR_IF_SET(background);
560 YSTR_IF_SET(statusline);
561 YSTR_IF_SET(separator);
562 YSTR_IF_SET(focused_workspace_border);
563 YSTR_IF_SET(focused_workspace_bg);
564 YSTR_IF_SET(focused_workspace_text);
565 YSTR_IF_SET(active_workspace_border);
566 YSTR_IF_SET(active_workspace_bg);
567 YSTR_IF_SET(active_workspace_text);
568 YSTR_IF_SET(inactive_workspace_border);
569 YSTR_IF_SET(inactive_workspace_bg);
570 YSTR_IF_SET(inactive_workspace_text);
571 YSTR_IF_SET(urgent_workspace_border);
572 YSTR_IF_SET(urgent_workspace_bg);
573 YSTR_IF_SET(urgent_workspace_text);
581 setlocale(LC_NUMERIC, "C");
582 yajl_gen gen = ygenalloc();
583 dump_node(gen, croot, false);
584 setlocale(LC_NUMERIC, "");
586 const unsigned char *payload;
588 y(get_buf, &payload, &length);
590 ipc_send_message(fd, length, I3_IPC_REPLY_TYPE_TREE, payload);
595 * Formats the reply message for a GET_WORKSPACES request and sends it to the
599 IPC_HANDLER(get_workspaces) {
600 yajl_gen gen = ygenalloc();
603 Con *focused_ws = con_get_workspace(focused);
606 TAILQ_FOREACH(output, &(croot->nodes_head), nodes) {
607 if (con_is_internal(output))
610 TAILQ_FOREACH(ws, &(output_get_content(output)->nodes_head), nodes) {
611 assert(ws->type == CT_WORKSPACE);
624 y(bool, workspace_is_visible(ws));
627 y(bool, ws == focused_ws);
632 y(integer, ws->rect.x);
634 y(integer, ws->rect.y);
636 y(integer, ws->rect.width);
638 y(integer, ws->rect.height);
653 const unsigned char *payload;
655 y(get_buf, &payload, &length);
657 ipc_send_message(fd, length, I3_IPC_REPLY_TYPE_WORKSPACES, payload);
662 * Formats the reply message for a GET_OUTPUTS request and sends it to the
666 IPC_HANDLER(get_outputs) {
667 yajl_gen gen = ygenalloc();
671 TAILQ_FOREACH(output, &outputs, outputs) {
678 y(bool, output->active);
681 y(bool, output->primary);
686 y(integer, output->rect.x);
688 y(integer, output->rect.y);
690 y(integer, output->rect.width);
692 y(integer, output->rect.height);
695 ystr("current_workspace");
697 if (output->con && (ws = con_get_fullscreen_con(output->con, CF_OUTPUT)))
707 const unsigned char *payload;
709 y(get_buf, &payload, &length);
711 ipc_send_message(fd, length, I3_IPC_REPLY_TYPE_OUTPUTS, payload);
716 * Formats the reply message for a GET_MARKS request and sends it to the
720 IPC_HANDLER(get_marks) {
721 yajl_gen gen = ygenalloc();
725 TAILQ_FOREACH(con, &all_cons, all_cons)
726 if (con->mark != NULL)
731 const unsigned char *payload;
733 y(get_buf, &payload, &length);
735 ipc_send_message(fd, length, I3_IPC_REPLY_TYPE_MARKS, payload);
740 * Returns the version of i3
743 IPC_HANDLER(get_version) {
744 yajl_gen gen = ygenalloc();
748 y(integer, MAJOR_VERSION);
751 y(integer, MINOR_VERSION);
754 y(integer, PATCH_VERSION);
756 ystr("human_readable");
761 const unsigned char *payload;
763 y(get_buf, &payload, &length);
765 ipc_send_message(fd, length, I3_IPC_REPLY_TYPE_VERSION, payload);
770 * Formats the reply message for a GET_BAR_CONFIG request and sends it to the
774 IPC_HANDLER(get_bar_config) {
775 yajl_gen gen = ygenalloc();
777 /* If no ID was passed, we return a JSON array with all IDs */
778 if (message_size == 0) {
781 TAILQ_FOREACH(current, &barconfigs, configs) {
786 const unsigned char *payload;
788 y(get_buf, &payload, &length);
790 ipc_send_message(fd, length, I3_IPC_REPLY_TYPE_BAR_CONFIG, payload);
795 /* To get a properly terminated buffer, we copy
796 * message_size bytes out of the buffer */
797 char *bar_id = scalloc(message_size + 1);
798 strncpy(bar_id, (const char *)message, message_size);
799 LOG("IPC: looking for config for bar ID \"%s\"\n", bar_id);
800 Barconfig *current, *config = NULL;
801 TAILQ_FOREACH(current, &barconfigs, configs) {
802 if (strcmp(current->id, bar_id) != 0)
810 /* If we did not find a config for the given ID, the reply will contain
811 * a null 'id' field. */
819 dump_bar_config(gen, config);
822 const unsigned char *payload;
824 y(get_buf, &payload, &length);
826 ipc_send_message(fd, length, I3_IPC_REPLY_TYPE_BAR_CONFIG, payload);
831 * Callback for the YAJL parser (will be called when a string is parsed).
834 static int add_subscription(void *extra, const unsigned char *s,
836 ipc_client *client = extra;
838 DLOG("should add subscription to extra %p, sub %.*s\n", client, (int)len, s);
839 int event = client->num_events;
841 client->num_events++;
842 client->events = realloc(client->events, client->num_events * sizeof(char *));
843 /* We copy the string because it is not null-terminated and strndup()
844 * is missing on some BSD systems */
845 client->events[event] = scalloc(len + 1);
846 memcpy(client->events[event], s, len);
848 DLOG("client is now subscribed to:\n");
849 for (int i = 0; i < client->num_events; i++)
850 DLOG("event %s\n", client->events[i]);
857 * Subscribes this connection to the event types which were given as a JSON
858 * serialized array in the payload field of the message.
861 IPC_HANDLER(subscribe) {
864 ipc_client *current, *client = NULL;
866 /* Search the ipc_client structure for this connection */
867 TAILQ_FOREACH(current, &all_clients, clients) {
868 if (current->fd != fd)
875 if (client == NULL) {
876 ELOG("Could not find ipc_client data structure for fd %d\n", fd);
880 /* Setup the JSON parser */
881 static yajl_callbacks callbacks = {
882 .yajl_string = add_subscription,
885 p = yalloc(&callbacks, (void *)client);
886 stat = yajl_parse(p, (const unsigned char *)message, message_size);
887 if (stat != yajl_status_ok) {
889 err = yajl_get_error(p, true, (const unsigned char *)message,
891 ELOG("YAJL parse error: %s\n", err);
892 yajl_free_error(p, err);
894 const char *reply = "{\"success\":false}";
895 ipc_send_message(fd, strlen(reply), I3_IPC_REPLY_TYPE_SUBSCRIBE, (const uint8_t *)reply);
900 const char *reply = "{\"success\":true}";
901 ipc_send_message(fd, strlen(reply), I3_IPC_REPLY_TYPE_SUBSCRIBE, (const uint8_t *)reply);
904 /* The index of each callback function corresponds to the numeric
905 * value of the message type (see include/i3/ipc.h) */
906 handler_t handlers[8] = {
908 handle_get_workspaces,
913 handle_get_bar_config,
918 * Handler for activity on a client connection, receives a message from a
921 * For now, the maximum message size is 2048. I’m not sure for what the
922 * IPC interface will be used in the future, thus I’m not implementing a
923 * mechanism for arbitrarily long messages, as it seems like overkill
927 static void ipc_receive_message(EV_P_ struct ev_io *w, int revents) {
928 uint32_t message_type;
929 uint32_t message_length;
930 uint8_t *message = NULL;
932 int ret = ipc_recv_message(w->fd, &message_type, &message_length, &message);
933 /* EOF or other error */
935 /* Was this a spurious read? See ev(3) */
936 if (ret == -1 && errno == EAGAIN) {
941 /* If not, there was some kind of error. We don’t bother
942 * and close the connection */
945 /* Delete the client from the list of clients */
947 TAILQ_FOREACH(current, &all_clients, clients) {
948 if (current->fd != w->fd)
951 for (int i = 0; i < current->num_events; i++)
952 free(current->events[i]);
953 /* We can call TAILQ_REMOVE because we break out of the
954 * TAILQ_FOREACH afterwards */
955 TAILQ_REMOVE(&all_clients, current, clients);
964 DLOG("IPC: client disconnected\n");
968 if (message_type >= (sizeof(handlers) / sizeof(handler_t)))
969 DLOG("Unhandled message type: %d\n", message_type);
971 handler_t h = handlers[message_type];
972 h(w->fd, message, 0, message_length, message_type);
979 * Handler for activity on the listening socket, meaning that a new client
980 * has just connected and we should accept() him. Sets up the event handler
981 * for activity on the new connection and inserts the file descriptor into
982 * the list of clients.
985 void ipc_new_client(EV_P_ struct ev_io *w, int revents) {
986 struct sockaddr_un peer;
987 socklen_t len = sizeof(struct sockaddr_un);
989 if ((client = accept(w->fd, (struct sockaddr *)&peer, &len)) < 0) {
997 /* Close this file descriptor on exec() */
998 (void)fcntl(client, F_SETFD, FD_CLOEXEC);
1000 set_nonblock(client);
1002 struct ev_io *package = scalloc(sizeof(struct ev_io));
1003 ev_io_init(package, ipc_receive_message, client, EV_READ);
1004 ev_io_start(EV_A_ package);
1006 DLOG("IPC: new client connected on fd %d\n", w->fd);
1008 ipc_client *new = scalloc(sizeof(ipc_client));
1011 TAILQ_INSERT_TAIL(&all_clients, new, clients);
1015 * Creates the UNIX domain socket at the given path, sets it to non-blocking
1016 * mode, bind()s and listen()s on it.
1019 int ipc_create_socket(const char *filename) {
1022 FREE(current_socketpath);
1024 char *resolved = resolve_tilde(filename);
1025 DLOG("Creating IPC-socket at %s\n", resolved);
1026 char *copy = sstrdup(resolved);
1027 const char *dir = dirname(copy);
1028 if (!path_exists(dir))
1032 /* Unlink the unix domain socket before */
1035 if ((sockfd = socket(AF_LOCAL, SOCK_STREAM, 0)) < 0) {
1041 (void)fcntl(sockfd, F_SETFD, FD_CLOEXEC);
1043 struct sockaddr_un addr;
1044 memset(&addr, 0, sizeof(struct sockaddr_un));
1045 addr.sun_family = AF_LOCAL;
1046 strncpy(addr.sun_path, resolved, sizeof(addr.sun_path) - 1);
1047 if (bind(sockfd, (struct sockaddr *)&addr, sizeof(struct sockaddr_un)) < 0) {
1053 set_nonblock(sockfd);
1055 if (listen(sockfd, 5) < 0) {
1061 current_socketpath = resolved;
1066 * For the workspace "focus" event we send, along the usual "change" field,
1067 * also the current and previous workspace, in "current" and "old"
1070 void ipc_send_workspace_focus_event(Con *current, Con *old) {
1071 setlocale(LC_NUMERIC, "C");
1072 yajl_gen gen = ygenalloc();
1080 dump_node(gen, current, false);
1086 dump_node(gen, old, false);
1090 const unsigned char *payload;
1092 y(get_buf, &payload, &length);
1094 ipc_send_event("workspace", I3_IPC_EVENT_WORKSPACE, (const char *)payload);
1096 setlocale(LC_NUMERIC, "");
1100 * For the window events we send, along the usual "change" field,
1101 * also the window container, in "container".
1103 void ipc_send_window_event(const char *property, Con *con) {
1104 DLOG("Issue IPC window %s event (con = %p, window = 0x%08x)\n",
1105 property, con, (con->window ? con->window->id : XCB_WINDOW_NONE));
1107 setlocale(LC_NUMERIC, "C");
1108 yajl_gen gen = ygenalloc();
1116 dump_node(gen, con, false);
1120 const unsigned char *payload;
1122 y(get_buf, &payload, &length);
1124 ipc_send_event("window", I3_IPC_EVENT_WINDOW, (const char *)payload);
1126 setlocale(LC_NUMERIC, "");
1130 * For the barconfig update events, we send the serialized barconfig.
1132 void ipc_send_barconfig_update_event(Barconfig *barconfig) {
1133 DLOG("Issue barconfig_update event for id = %s\n", barconfig->id);
1134 setlocale(LC_NUMERIC, "C");
1135 yajl_gen gen = ygenalloc();
1137 dump_bar_config(gen, barconfig);
1139 const unsigned char *payload;
1141 y(get_buf, &payload, &length);
1143 ipc_send_event("barconfig_update", I3_IPC_EVENT_BARCONFIG_UPDATE, (const char *)payload);
1145 setlocale(LC_NUMERIC, "");