2 #define I3__FILE__ "ipc.c"
4 * vim:ts=4:sw=4:expandtab
6 * i3 - an improved dynamic tiling window manager
7 * © 2009 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 * Sends the specified event to all IPC clients which are currently connected
42 * and subscribed to this kind of event.
45 void ipc_send_event(const char *event, uint32_t message_type, const char *payload) {
47 TAILQ_FOREACH(current, &all_clients, clients) {
48 /* see if this client is interested in this event */
49 bool interested = false;
50 for (int i = 0; i < current->num_events; i++) {
51 if (strcasecmp(current->events[i], event) != 0)
59 ipc_send_message(current->fd, strlen(payload), message_type, (const uint8_t *)payload);
64 * Calls shutdown() on each socket and closes it. This function to be called
65 * when exiting or restarting only!
68 void ipc_shutdown(void) {
70 while (!TAILQ_EMPTY(&all_clients)) {
71 current = TAILQ_FIRST(&all_clients);
72 shutdown(current->fd, SHUT_RDWR);
74 TAILQ_REMOVE(&all_clients, current, clients);
80 * Executes the command and returns whether it could be successfully parsed
81 * or not (at the moment, always returns true).
84 IPC_HANDLER(command) {
85 /* To get a properly terminated buffer, we copy
86 * message_size bytes out of the buffer */
87 char *command = scalloc(message_size + 1, 1);
88 strncpy(command, (const char *)message, message_size);
89 LOG("IPC: received: *%s*\n", command);
90 yajl_gen gen = yajl_gen_alloc(NULL);
92 CommandResult *result = parse_command((const char *)command, gen);
95 if (result->needs_tree_render)
98 command_result_free(result);
100 const unsigned char *reply;
102 yajl_gen_get_buf(gen, &reply, &length);
104 ipc_send_message(fd, length, I3_IPC_REPLY_TYPE_COMMAND,
105 (const uint8_t *)reply);
110 static void dump_rect(yajl_gen gen, const char *name, Rect r) {
120 y(integer, r.height);
124 static void dump_binding(yajl_gen gen, Binding *bind) {
127 y(integer, bind->keycode);
130 ystr((const char *)(bind->input_type == B_KEYBOARD ? "keyboard" : "mouse"));
133 if (bind->symbol == NULL)
143 for (int i = 0; i < 8; i++) {
144 if (bind->mods & (1 << i)) {
146 case XCB_MOD_MASK_SHIFT:
149 case XCB_MOD_MASK_LOCK:
152 case XCB_MOD_MASK_CONTROL:
178 void dump_node(yajl_gen gen, struct Con *con, bool inplace_restart) {
181 y(integer, (long int)con);
194 case CT_FLOATING_CON:
195 ystr("floating_con");
204 DLOG("About to dump unknown container type=%d. This is a bug.\n", con->type);
209 /* provided for backwards compatibility only. */
211 if (!con_is_split(con))
214 if (con_orientation(con) == HORIZ)
220 ystr("scratchpad_state");
221 switch (con->scratchpad_state) {
222 case SCRATCHPAD_NONE:
225 case SCRATCHPAD_FRESH:
228 case SCRATCHPAD_CHANGED:
234 if (con->percent == 0.0)
237 y(double, con->percent);
240 y(bool, con->urgent);
242 if (con->mark != NULL) {
248 y(bool, (con == focused));
251 switch (con->layout) {
253 DLOG("About to dump layout=default, this is a bug in the code.\n");
276 ystr("workspace_layout");
277 switch (con->workspace_layout) {
288 DLOG("About to dump workspace_layout=%d (none of default/stacked/tabbed), this is a bug.\n", con->workspace_layout);
293 ystr("last_split_layout");
294 switch (con->layout) {
304 switch (con->border_style) {
316 ystr("current_border_width");
317 y(integer, con->current_border_width);
319 dump_rect(gen, "rect", con->rect);
320 dump_rect(gen, "deco_rect", con->deco_rect);
321 dump_rect(gen, "window_rect", con->window_rect);
322 dump_rect(gen, "geometry", con->geometry);
325 if (con->window && con->window->name)
326 ystr(i3string_as_utf8(con->window->name));
327 else if (con->name != NULL)
332 if (con->type == CT_WORKSPACE) {
334 y(integer, con->num);
339 y(integer, con->window->id);
343 if (con->window && !inplace_restart) {
344 /* Window properties are useless to preserve when restarting because
345 * they will be queried again anyway. However, for i3-save-tree(1),
346 * they are very useful and save i3-save-tree dealing with X11. */
347 ystr("window_properties");
350 #define DUMP_PROPERTY(key, prop_name) \
352 if (con->window->prop_name != NULL) { \
354 ystr(con->window->prop_name); \
358 DUMP_PROPERTY("class", class_class);
359 DUMP_PROPERTY("instance", class_instance);
360 DUMP_PROPERTY("window_role", role);
362 if (con->window->name != NULL) {
364 ystr(i3string_as_utf8(con->window->name));
367 ystr("transient_for");
368 if (con->window->transient_for == XCB_NONE)
371 y(integer, con->window->transient_for);
379 if (con->type != CT_DOCKAREA || !inplace_restart) {
380 TAILQ_FOREACH(node, &(con->nodes_head), nodes) {
381 dump_node(gen, node, inplace_restart);
386 ystr("floating_nodes");
388 TAILQ_FOREACH(node, &(con->floating_head), floating_windows) {
389 dump_node(gen, node, inplace_restart);
395 TAILQ_FOREACH(node, &(con->focus_head), focused) {
396 y(integer, (long int)node);
400 ystr("fullscreen_mode");
401 y(integer, con->fullscreen_mode);
404 switch (con->floating) {
405 case FLOATING_AUTO_OFF:
408 case FLOATING_AUTO_ON:
411 case FLOATING_USER_OFF:
414 case FLOATING_USER_ON:
422 TAILQ_FOREACH(match, &(con->swallow_head), matches) {
423 /* We will generate a new restart_mode match specification after this
424 * loop, so skip this one. */
425 if (match->restart_mode)
428 if (match->dock != -1) {
430 y(integer, match->dock);
431 ystr("insert_where");
432 y(integer, match->insert_where);
435 #define DUMP_REGEX(re_name) \
437 if (match->re_name != NULL) { \
439 ystr(match->re_name->pattern); \
444 DUMP_REGEX(instance);
445 DUMP_REGEX(window_role);
452 if (inplace_restart) {
453 if (con->window != NULL) {
456 y(integer, con->window->id);
457 ystr("restart_mode");
464 if (inplace_restart && con->window != NULL) {
466 y(integer, con->depth);
472 static void dump_bar_bindings(yajl_gen gen, Barconfig *config) {
473 if (TAILQ_EMPTY(&(config->bar_bindings)))
479 struct Barbinding *current;
480 TAILQ_FOREACH(current, &(config->bar_bindings), bindings) {
484 y(integer, current->input_code);
486 ystr(current->command);
494 static void dump_bar_config(yajl_gen gen, Barconfig *config) {
500 if (config->num_outputs > 0) {
503 for (int c = 0; c < config->num_outputs; c++)
504 ystr(config->outputs[c]);
508 #define YSTR_IF_SET(name) \
510 if (config->name) { \
512 ystr(config->name); \
516 YSTR_IF_SET(tray_output);
518 ystr("tray_padding");
519 y(integer, config->tray_padding);
521 YSTR_IF_SET(socket_path);
524 switch (config->mode) {
537 ystr("hidden_state");
538 switch (config->hidden_state) {
549 switch (config->modifier) {
578 dump_bar_bindings(gen, config);
581 if (config->position == P_BOTTOM)
586 YSTR_IF_SET(status_command);
589 if (config->separator_symbol) {
590 ystr("separator_symbol");
591 ystr(config->separator_symbol);
594 ystr("workspace_buttons");
595 y(bool, !config->hide_workspace_buttons);
597 ystr("strip_workspace_numbers");
598 y(bool, config->strip_workspace_numbers);
600 ystr("binding_mode_indicator");
601 y(bool, !config->hide_binding_mode_indicator);
604 y(bool, config->verbose);
607 #define YSTR_IF_SET(name) \
609 if (config->colors.name) { \
611 ystr(config->colors.name); \
617 YSTR_IF_SET(background);
618 YSTR_IF_SET(statusline);
619 YSTR_IF_SET(separator);
620 YSTR_IF_SET(focused_workspace_border);
621 YSTR_IF_SET(focused_workspace_bg);
622 YSTR_IF_SET(focused_workspace_text);
623 YSTR_IF_SET(active_workspace_border);
624 YSTR_IF_SET(active_workspace_bg);
625 YSTR_IF_SET(active_workspace_text);
626 YSTR_IF_SET(inactive_workspace_border);
627 YSTR_IF_SET(inactive_workspace_bg);
628 YSTR_IF_SET(inactive_workspace_text);
629 YSTR_IF_SET(urgent_workspace_border);
630 YSTR_IF_SET(urgent_workspace_bg);
631 YSTR_IF_SET(urgent_workspace_text);
632 YSTR_IF_SET(binding_mode_border);
633 YSTR_IF_SET(binding_mode_bg);
634 YSTR_IF_SET(binding_mode_text);
642 setlocale(LC_NUMERIC, "C");
643 yajl_gen gen = ygenalloc();
644 dump_node(gen, croot, false);
645 setlocale(LC_NUMERIC, "");
647 const unsigned char *payload;
649 y(get_buf, &payload, &length);
651 ipc_send_message(fd, length, I3_IPC_REPLY_TYPE_TREE, payload);
656 * Formats the reply message for a GET_WORKSPACES request and sends it to the
660 IPC_HANDLER(get_workspaces) {
661 yajl_gen gen = ygenalloc();
664 Con *focused_ws = con_get_workspace(focused);
667 TAILQ_FOREACH(output, &(croot->nodes_head), nodes) {
668 if (con_is_internal(output))
671 TAILQ_FOREACH(ws, &(output_get_content(output)->nodes_head), nodes) {
672 assert(ws->type == CT_WORKSPACE);
682 y(bool, workspace_is_visible(ws));
685 y(bool, ws == focused_ws);
690 y(integer, ws->rect.x);
692 y(integer, ws->rect.y);
694 y(integer, ws->rect.width);
696 y(integer, ws->rect.height);
711 const unsigned char *payload;
713 y(get_buf, &payload, &length);
715 ipc_send_message(fd, length, I3_IPC_REPLY_TYPE_WORKSPACES, payload);
720 * Formats the reply message for a GET_OUTPUTS request and sends it to the
724 IPC_HANDLER(get_outputs) {
725 yajl_gen gen = ygenalloc();
729 TAILQ_FOREACH(output, &outputs, outputs) {
736 y(bool, output->active);
739 y(bool, output->primary);
744 y(integer, output->rect.x);
746 y(integer, output->rect.y);
748 y(integer, output->rect.width);
750 y(integer, output->rect.height);
753 ystr("current_workspace");
755 if (output->con && (ws = con_get_fullscreen_con(output->con, CF_OUTPUT)))
765 const unsigned char *payload;
767 y(get_buf, &payload, &length);
769 ipc_send_message(fd, length, I3_IPC_REPLY_TYPE_OUTPUTS, payload);
774 * Formats the reply message for a GET_MARKS request and sends it to the
778 IPC_HANDLER(get_marks) {
779 yajl_gen gen = ygenalloc();
783 TAILQ_FOREACH(con, &all_cons, all_cons)
784 if (con->mark != NULL)
789 const unsigned char *payload;
791 y(get_buf, &payload, &length);
793 ipc_send_message(fd, length, I3_IPC_REPLY_TYPE_MARKS, payload);
798 * Returns the version of i3
801 IPC_HANDLER(get_version) {
802 yajl_gen gen = ygenalloc();
806 y(integer, MAJOR_VERSION);
809 y(integer, MINOR_VERSION);
812 y(integer, PATCH_VERSION);
814 ystr("human_readable");
817 ystr("loaded_config_file_name");
818 ystr(current_configpath);
822 const unsigned char *payload;
824 y(get_buf, &payload, &length);
826 ipc_send_message(fd, length, I3_IPC_REPLY_TYPE_VERSION, payload);
831 * Formats the reply message for a GET_BAR_CONFIG request and sends it to the
835 IPC_HANDLER(get_bar_config) {
836 yajl_gen gen = ygenalloc();
838 /* If no ID was passed, we return a JSON array with all IDs */
839 if (message_size == 0) {
842 TAILQ_FOREACH(current, &barconfigs, configs) {
847 const unsigned char *payload;
849 y(get_buf, &payload, &length);
851 ipc_send_message(fd, length, I3_IPC_REPLY_TYPE_BAR_CONFIG, payload);
856 /* To get a properly terminated buffer, we copy
857 * message_size bytes out of the buffer */
858 char *bar_id = scalloc(message_size + 1, 1);
859 strncpy(bar_id, (const char *)message, message_size);
860 LOG("IPC: looking for config for bar ID \"%s\"\n", bar_id);
861 Barconfig *current, *config = NULL;
862 TAILQ_FOREACH(current, &barconfigs, configs) {
863 if (strcmp(current->id, bar_id) != 0)
871 /* If we did not find a config for the given ID, the reply will contain
872 * a null 'id' field. */
880 dump_bar_config(gen, config);
883 const unsigned char *payload;
885 y(get_buf, &payload, &length);
887 ipc_send_message(fd, length, I3_IPC_REPLY_TYPE_BAR_CONFIG, payload);
892 * Callback for the YAJL parser (will be called when a string is parsed).
895 static int add_subscription(void *extra, const unsigned char *s,
897 ipc_client *client = extra;
899 DLOG("should add subscription to extra %p, sub %.*s\n", client, (int)len, s);
900 int event = client->num_events;
902 client->num_events++;
903 client->events = srealloc(client->events, client->num_events * sizeof(char *));
904 /* We copy the string because it is not null-terminated and strndup()
905 * is missing on some BSD systems */
906 client->events[event] = scalloc(len + 1, 1);
907 memcpy(client->events[event], s, len);
909 DLOG("client is now subscribed to:\n");
910 for (int i = 0; i < client->num_events; i++)
911 DLOG("event %s\n", client->events[i]);
918 * Subscribes this connection to the event types which were given as a JSON
919 * serialized array in the payload field of the message.
922 IPC_HANDLER(subscribe) {
925 ipc_client *current, *client = NULL;
927 /* Search the ipc_client structure for this connection */
928 TAILQ_FOREACH(current, &all_clients, clients) {
929 if (current->fd != fd)
936 if (client == NULL) {
937 ELOG("Could not find ipc_client data structure for fd %d\n", fd);
941 /* Setup the JSON parser */
942 static yajl_callbacks callbacks = {
943 .yajl_string = add_subscription,
946 p = yalloc(&callbacks, (void *)client);
947 stat = yajl_parse(p, (const unsigned char *)message, message_size);
948 if (stat != yajl_status_ok) {
950 err = yajl_get_error(p, true, (const unsigned char *)message,
952 ELOG("YAJL parse error: %s\n", err);
953 yajl_free_error(p, err);
955 const char *reply = "{\"success\":false}";
956 ipc_send_message(fd, strlen(reply), I3_IPC_REPLY_TYPE_SUBSCRIBE, (const uint8_t *)reply);
961 const char *reply = "{\"success\":true}";
962 ipc_send_message(fd, strlen(reply), I3_IPC_REPLY_TYPE_SUBSCRIBE, (const uint8_t *)reply);
965 /* The index of each callback function corresponds to the numeric
966 * value of the message type (see include/i3/ipc.h) */
967 handler_t handlers[8] = {
969 handle_get_workspaces,
974 handle_get_bar_config,
979 * Handler for activity on a client connection, receives a message from a
982 * For now, the maximum message size is 2048. I’m not sure for what the
983 * IPC interface will be used in the future, thus I’m not implementing a
984 * mechanism for arbitrarily long messages, as it seems like overkill
988 static void ipc_receive_message(EV_P_ struct ev_io *w, int revents) {
989 uint32_t message_type;
990 uint32_t message_length;
991 uint8_t *message = NULL;
993 int ret = ipc_recv_message(w->fd, &message_type, &message_length, &message);
994 /* EOF or other error */
996 /* Was this a spurious read? See ev(3) */
997 if (ret == -1 && errno == EAGAIN) {
1002 /* If not, there was some kind of error. We don’t bother
1003 * and close the connection */
1006 /* Delete the client from the list of clients */
1007 ipc_client *current;
1008 TAILQ_FOREACH(current, &all_clients, clients) {
1009 if (current->fd != w->fd)
1012 for (int i = 0; i < current->num_events; i++)
1013 free(current->events[i]);
1014 /* We can call TAILQ_REMOVE because we break out of the
1015 * TAILQ_FOREACH afterwards */
1016 TAILQ_REMOVE(&all_clients, current, clients);
1021 ev_io_stop(EV_A_ w);
1025 DLOG("IPC: client disconnected\n");
1029 if (message_type >= (sizeof(handlers) / sizeof(handler_t)))
1030 DLOG("Unhandled message type: %d\n", message_type);
1032 handler_t h = handlers[message_type];
1033 h(w->fd, message, 0, message_length, message_type);
1040 * Handler for activity on the listening socket, meaning that a new client
1041 * has just connected and we should accept() him. Sets up the event handler
1042 * for activity on the new connection and inserts the file descriptor into
1043 * the list of clients.
1046 void ipc_new_client(EV_P_ struct ev_io *w, int revents) {
1047 struct sockaddr_un peer;
1048 socklen_t len = sizeof(struct sockaddr_un);
1050 if ((client = accept(w->fd, (struct sockaddr *)&peer, &len)) < 0) {
1058 /* Close this file descriptor on exec() */
1059 (void)fcntl(client, F_SETFD, FD_CLOEXEC);
1061 set_nonblock(client);
1063 struct ev_io *package = scalloc(1, sizeof(struct ev_io));
1064 ev_io_init(package, ipc_receive_message, client, EV_READ);
1065 ev_io_start(EV_A_ package);
1067 DLOG("IPC: new client connected on fd %d\n", w->fd);
1069 ipc_client *new = scalloc(1, sizeof(ipc_client));
1072 TAILQ_INSERT_TAIL(&all_clients, new, clients);
1076 * Creates the UNIX domain socket at the given path, sets it to non-blocking
1077 * mode, bind()s and listen()s on it.
1080 int ipc_create_socket(const char *filename) {
1083 FREE(current_socketpath);
1085 char *resolved = resolve_tilde(filename);
1086 DLOG("Creating IPC-socket at %s\n", resolved);
1087 char *copy = sstrdup(resolved);
1088 const char *dir = dirname(copy);
1089 if (!path_exists(dir))
1090 mkdirp(dir, DEFAULT_DIR_MODE);
1093 /* Unlink the unix domain socket before */
1096 if ((sockfd = socket(AF_LOCAL, SOCK_STREAM, 0)) < 0) {
1102 (void)fcntl(sockfd, F_SETFD, FD_CLOEXEC);
1104 struct sockaddr_un addr;
1105 memset(&addr, 0, sizeof(struct sockaddr_un));
1106 addr.sun_family = AF_LOCAL;
1107 strncpy(addr.sun_path, resolved, sizeof(addr.sun_path) - 1);
1108 if (bind(sockfd, (struct sockaddr *)&addr, sizeof(struct sockaddr_un)) < 0) {
1114 set_nonblock(sockfd);
1116 if (listen(sockfd, 5) < 0) {
1122 current_socketpath = resolved;
1127 * Generates a json workspace event. Returns a dynamically allocated yajl
1128 * generator. Free with yajl_gen_free().
1130 yajl_gen ipc_marshal_workspace_event(const char *change, Con *current, Con *old) {
1131 setlocale(LC_NUMERIC, "C");
1132 yajl_gen gen = ygenalloc();
1140 if (current == NULL)
1143 dump_node(gen, current, false);
1149 dump_node(gen, old, false);
1153 setlocale(LC_NUMERIC, "");
1159 * For the workspace events we send, along with the usual "change" field, also
1160 * the workspace container in "current". For focus events, we send the
1161 * previously focused workspace in "old".
1163 void ipc_send_workspace_event(const char *change, Con *current, Con *old) {
1164 yajl_gen gen = ipc_marshal_workspace_event(change, current, old);
1166 const unsigned char *payload;
1168 y(get_buf, &payload, &length);
1170 ipc_send_event("workspace", I3_IPC_EVENT_WORKSPACE, (const char *)payload);
1176 * For the window events we send, along the usual "change" field,
1177 * also the window container, in "container".
1179 void ipc_send_window_event(const char *property, Con *con) {
1180 DLOG("Issue IPC window %s event (con = %p, window = 0x%08x)\n",
1181 property, con, (con->window ? con->window->id : XCB_WINDOW_NONE));
1183 setlocale(LC_NUMERIC, "C");
1184 yajl_gen gen = ygenalloc();
1192 dump_node(gen, con, false);
1196 const unsigned char *payload;
1198 y(get_buf, &payload, &length);
1200 ipc_send_event("window", I3_IPC_EVENT_WINDOW, (const char *)payload);
1202 setlocale(LC_NUMERIC, "");
1206 * For the barconfig update events, we send the serialized barconfig.
1208 void ipc_send_barconfig_update_event(Barconfig *barconfig) {
1209 DLOG("Issue barconfig_update event for id = %s\n", barconfig->id);
1210 setlocale(LC_NUMERIC, "C");
1211 yajl_gen gen = ygenalloc();
1213 dump_bar_config(gen, barconfig);
1215 const unsigned char *payload;
1217 y(get_buf, &payload, &length);
1219 ipc_send_event("barconfig_update", I3_IPC_EVENT_BARCONFIG_UPDATE, (const char *)payload);
1221 setlocale(LC_NUMERIC, "");
1225 * For the binding events, we send the serialized binding struct.
1227 void ipc_send_binding_event(const char *event_type, Binding *bind) {
1228 DLOG("Issue IPC binding %s event (sym = %s, code = %d)\n", event_type, bind->symbol, bind->keycode);
1230 setlocale(LC_NUMERIC, "C");
1232 yajl_gen gen = ygenalloc();
1240 dump_binding(gen, bind);
1244 const unsigned char *payload;
1246 y(get_buf, &payload, &length);
1248 ipc_send_event("binding", I3_IPC_EVENT_BINDING, (const char *)payload);
1251 setlocale(LC_NUMERIC, "");