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_event_state_mask(yajl_gen gen, Binding *bind) {
126 for (int i = 0; i < 20; i++) {
127 if (bind->event_state_mask & (1 << i)) {
129 case XCB_KEY_BUT_MASK_SHIFT:
132 case XCB_KEY_BUT_MASK_LOCK:
135 case XCB_KEY_BUT_MASK_CONTROL:
138 case XCB_KEY_BUT_MASK_MOD_1:
141 case XCB_KEY_BUT_MASK_MOD_2:
144 case XCB_KEY_BUT_MASK_MOD_3:
147 case XCB_KEY_BUT_MASK_MOD_4:
150 case XCB_KEY_BUT_MASK_MOD_5:
153 case XCB_KEY_BUT_MASK_BUTTON_1:
156 case XCB_KEY_BUT_MASK_BUTTON_2:
159 case XCB_KEY_BUT_MASK_BUTTON_3:
162 case XCB_KEY_BUT_MASK_BUTTON_4:
165 case XCB_KEY_BUT_MASK_BUTTON_5:
168 case (I3_XKB_GROUP_MASK_1 << 16):
171 case (I3_XKB_GROUP_MASK_2 << 16):
174 case (I3_XKB_GROUP_MASK_3 << 16):
177 case (I3_XKB_GROUP_MASK_4 << 16):
186 static void dump_binding(yajl_gen gen, Binding *bind) {
189 y(integer, bind->keycode);
192 ystr((const char *)(bind->input_type == B_KEYBOARD ? "keyboard" : "mouse"));
195 if (bind->symbol == NULL)
203 // This key is only provided for compatibility, new programs should use
204 // event_state_mask instead.
206 dump_event_state_mask(gen, bind);
208 ystr("event_state_mask");
209 dump_event_state_mask(gen, bind);
214 void dump_node(yajl_gen gen, struct Con *con, bool inplace_restart) {
217 y(integer, (long int)con);
230 case CT_FLOATING_CON:
231 ystr("floating_con");
240 DLOG("About to dump unknown container type=%d. This is a bug.\n", con->type);
245 /* provided for backwards compatibility only. */
247 if (!con_is_split(con))
250 if (con_orientation(con) == HORIZ)
256 ystr("scratchpad_state");
257 switch (con->scratchpad_state) {
258 case SCRATCHPAD_NONE:
261 case SCRATCHPAD_FRESH:
264 case SCRATCHPAD_CHANGED:
270 if (con->percent == 0.0)
273 y(double, con->percent);
276 y(bool, con->urgent);
278 if (!TAILQ_EMPTY(&(con->marks_head))) {
283 TAILQ_FOREACH(mark, &(con->marks_head), marks) {
291 y(bool, (con == focused));
294 switch (con->layout) {
296 DLOG("About to dump layout=default, this is a bug in the code.\n");
319 ystr("workspace_layout");
320 switch (con->workspace_layout) {
331 DLOG("About to dump workspace_layout=%d (none of default/stacked/tabbed), this is a bug.\n", con->workspace_layout);
336 ystr("last_split_layout");
337 switch (con->layout) {
347 switch (con->border_style) {
359 ystr("current_border_width");
360 y(integer, con->current_border_width);
362 dump_rect(gen, "rect", con->rect);
363 dump_rect(gen, "deco_rect", con->deco_rect);
364 dump_rect(gen, "window_rect", con->window_rect);
365 dump_rect(gen, "geometry", con->geometry);
368 if (con->window && con->window->name)
369 ystr(i3string_as_utf8(con->window->name));
370 else if (con->name != NULL)
375 if (con->type == CT_WORKSPACE) {
377 y(integer, con->num);
382 y(integer, con->window->id);
386 if (con->window && !inplace_restart) {
387 /* Window properties are useless to preserve when restarting because
388 * they will be queried again anyway. However, for i3-save-tree(1),
389 * they are very useful and save i3-save-tree dealing with X11. */
390 ystr("window_properties");
393 #define DUMP_PROPERTY(key, prop_name) \
395 if (con->window->prop_name != NULL) { \
397 ystr(con->window->prop_name); \
401 DUMP_PROPERTY("class", class_class);
402 DUMP_PROPERTY("instance", class_instance);
403 DUMP_PROPERTY("window_role", role);
405 if (con->window->name != NULL) {
407 ystr(i3string_as_utf8(con->window->name));
410 ystr("transient_for");
411 if (con->window->transient_for == XCB_NONE)
414 y(integer, con->window->transient_for);
422 if (con->type != CT_DOCKAREA || !inplace_restart) {
423 TAILQ_FOREACH(node, &(con->nodes_head), nodes) {
424 dump_node(gen, node, inplace_restart);
429 ystr("floating_nodes");
431 TAILQ_FOREACH(node, &(con->floating_head), floating_windows) {
432 dump_node(gen, node, inplace_restart);
438 TAILQ_FOREACH(node, &(con->focus_head), focused) {
439 y(integer, (long int)node);
443 ystr("fullscreen_mode");
444 y(integer, con->fullscreen_mode);
447 y(bool, con->sticky);
450 switch (con->floating) {
451 case FLOATING_AUTO_OFF:
454 case FLOATING_AUTO_ON:
457 case FLOATING_USER_OFF:
460 case FLOATING_USER_ON:
468 TAILQ_FOREACH(match, &(con->swallow_head), matches) {
469 /* We will generate a new restart_mode match specification after this
470 * loop, so skip this one. */
471 if (match->restart_mode)
474 if (match->dock != -1) {
476 y(integer, match->dock);
477 ystr("insert_where");
478 y(integer, match->insert_where);
481 #define DUMP_REGEX(re_name) \
483 if (match->re_name != NULL) { \
485 ystr(match->re_name->pattern); \
490 DUMP_REGEX(instance);
491 DUMP_REGEX(window_role);
498 if (inplace_restart) {
499 if (con->window != NULL) {
502 y(integer, con->window->id);
503 ystr("restart_mode");
510 if (inplace_restart && con->window != NULL) {
512 y(integer, con->depth);
518 static void dump_bar_bindings(yajl_gen gen, Barconfig *config) {
519 if (TAILQ_EMPTY(&(config->bar_bindings)))
525 struct Barbinding *current;
526 TAILQ_FOREACH(current, &(config->bar_bindings), bindings) {
530 y(integer, current->input_code);
532 ystr(current->command);
540 static void dump_bar_config(yajl_gen gen, Barconfig *config) {
546 if (config->num_outputs > 0) {
549 for (int c = 0; c < config->num_outputs; c++)
550 ystr(config->outputs[c]);
554 #define YSTR_IF_SET(name) \
556 if (config->name) { \
558 ystr(config->name); \
562 YSTR_IF_SET(tray_output);
564 ystr("tray_padding");
565 y(integer, config->tray_padding);
567 YSTR_IF_SET(socket_path);
570 switch (config->mode) {
583 ystr("hidden_state");
584 switch (config->hidden_state) {
595 switch (config->modifier) {
624 dump_bar_bindings(gen, config);
627 if (config->position == P_BOTTOM)
632 YSTR_IF_SET(status_command);
635 if (config->separator_symbol) {
636 ystr("separator_symbol");
637 ystr(config->separator_symbol);
640 ystr("workspace_buttons");
641 y(bool, !config->hide_workspace_buttons);
643 ystr("strip_workspace_numbers");
644 y(bool, config->strip_workspace_numbers);
646 ystr("binding_mode_indicator");
647 y(bool, !config->hide_binding_mode_indicator);
650 y(bool, config->verbose);
653 #define YSTR_IF_SET(name) \
655 if (config->colors.name) { \
657 ystr(config->colors.name); \
663 YSTR_IF_SET(background);
664 YSTR_IF_SET(statusline);
665 YSTR_IF_SET(separator);
666 YSTR_IF_SET(focused_workspace_border);
667 YSTR_IF_SET(focused_workspace_bg);
668 YSTR_IF_SET(focused_workspace_text);
669 YSTR_IF_SET(active_workspace_border);
670 YSTR_IF_SET(active_workspace_bg);
671 YSTR_IF_SET(active_workspace_text);
672 YSTR_IF_SET(inactive_workspace_border);
673 YSTR_IF_SET(inactive_workspace_bg);
674 YSTR_IF_SET(inactive_workspace_text);
675 YSTR_IF_SET(urgent_workspace_border);
676 YSTR_IF_SET(urgent_workspace_bg);
677 YSTR_IF_SET(urgent_workspace_text);
678 YSTR_IF_SET(binding_mode_border);
679 YSTR_IF_SET(binding_mode_bg);
680 YSTR_IF_SET(binding_mode_text);
688 setlocale(LC_NUMERIC, "C");
689 yajl_gen gen = ygenalloc();
690 dump_node(gen, croot, false);
691 setlocale(LC_NUMERIC, "");
693 const unsigned char *payload;
695 y(get_buf, &payload, &length);
697 ipc_send_message(fd, length, I3_IPC_REPLY_TYPE_TREE, payload);
702 * Formats the reply message for a GET_WORKSPACES request and sends it to the
706 IPC_HANDLER(get_workspaces) {
707 yajl_gen gen = ygenalloc();
710 Con *focused_ws = con_get_workspace(focused);
713 TAILQ_FOREACH(output, &(croot->nodes_head), nodes) {
714 if (con_is_internal(output))
717 TAILQ_FOREACH(ws, &(output_get_content(output)->nodes_head), nodes) {
718 assert(ws->type == CT_WORKSPACE);
728 y(bool, workspace_is_visible(ws));
731 y(bool, ws == focused_ws);
736 y(integer, ws->rect.x);
738 y(integer, ws->rect.y);
740 y(integer, ws->rect.width);
742 y(integer, ws->rect.height);
757 const unsigned char *payload;
759 y(get_buf, &payload, &length);
761 ipc_send_message(fd, length, I3_IPC_REPLY_TYPE_WORKSPACES, payload);
766 * Formats the reply message for a GET_OUTPUTS request and sends it to the
770 IPC_HANDLER(get_outputs) {
771 yajl_gen gen = ygenalloc();
775 TAILQ_FOREACH(output, &outputs, outputs) {
782 y(bool, output->active);
785 y(bool, output->primary);
790 y(integer, output->rect.x);
792 y(integer, output->rect.y);
794 y(integer, output->rect.width);
796 y(integer, output->rect.height);
799 ystr("current_workspace");
801 if (output->con && (ws = con_get_fullscreen_con(output->con, CF_OUTPUT)))
811 const unsigned char *payload;
813 y(get_buf, &payload, &length);
815 ipc_send_message(fd, length, I3_IPC_REPLY_TYPE_OUTPUTS, payload);
820 * Formats the reply message for a GET_MARKS request and sends it to the
824 IPC_HANDLER(get_marks) {
825 yajl_gen gen = ygenalloc();
829 TAILQ_FOREACH(con, &all_cons, all_cons) {
831 TAILQ_FOREACH(mark, &(con->marks_head), marks) {
838 const unsigned char *payload;
840 y(get_buf, &payload, &length);
842 ipc_send_message(fd, length, I3_IPC_REPLY_TYPE_MARKS, payload);
847 * Returns the version of i3
850 IPC_HANDLER(get_version) {
851 yajl_gen gen = ygenalloc();
855 y(integer, MAJOR_VERSION);
858 y(integer, MINOR_VERSION);
861 y(integer, PATCH_VERSION);
863 ystr("human_readable");
866 ystr("loaded_config_file_name");
867 ystr(current_configpath);
871 const unsigned char *payload;
873 y(get_buf, &payload, &length);
875 ipc_send_message(fd, length, I3_IPC_REPLY_TYPE_VERSION, payload);
880 * Formats the reply message for a GET_BAR_CONFIG request and sends it to the
884 IPC_HANDLER(get_bar_config) {
885 yajl_gen gen = ygenalloc();
887 /* If no ID was passed, we return a JSON array with all IDs */
888 if (message_size == 0) {
891 TAILQ_FOREACH(current, &barconfigs, configs) {
896 const unsigned char *payload;
898 y(get_buf, &payload, &length);
900 ipc_send_message(fd, length, I3_IPC_REPLY_TYPE_BAR_CONFIG, payload);
905 /* To get a properly terminated buffer, we copy
906 * message_size bytes out of the buffer */
908 sasprintf(&bar_id, "%.*s", message_size, message);
909 LOG("IPC: looking for config for bar ID \"%s\"\n", bar_id);
910 Barconfig *current, *config = NULL;
911 TAILQ_FOREACH(current, &barconfigs, configs) {
912 if (strcmp(current->id, bar_id) != 0)
921 /* If we did not find a config for the given ID, the reply will contain
922 * a null 'id' field. */
930 dump_bar_config(gen, config);
933 const unsigned char *payload;
935 y(get_buf, &payload, &length);
937 ipc_send_message(fd, length, I3_IPC_REPLY_TYPE_BAR_CONFIG, payload);
942 * Callback for the YAJL parser (will be called when a string is parsed).
945 static int add_subscription(void *extra, const unsigned char *s,
947 ipc_client *client = extra;
949 DLOG("should add subscription to extra %p, sub %.*s\n", client, (int)len, s);
950 int event = client->num_events;
952 client->num_events++;
953 client->events = srealloc(client->events, client->num_events * sizeof(char *));
954 /* We copy the string because it is not null-terminated and strndup()
955 * is missing on some BSD systems */
956 client->events[event] = scalloc(len + 1, 1);
957 memcpy(client->events[event], s, len);
959 DLOG("client is now subscribed to:\n");
960 for (int i = 0; i < client->num_events; i++)
961 DLOG("event %s\n", client->events[i]);
968 * Subscribes this connection to the event types which were given as a JSON
969 * serialized array in the payload field of the message.
972 IPC_HANDLER(subscribe) {
975 ipc_client *current, *client = NULL;
977 /* Search the ipc_client structure for this connection */
978 TAILQ_FOREACH(current, &all_clients, clients) {
979 if (current->fd != fd)
986 if (client == NULL) {
987 ELOG("Could not find ipc_client data structure for fd %d\n", fd);
991 /* Setup the JSON parser */
992 static yajl_callbacks callbacks = {
993 .yajl_string = add_subscription,
996 p = yalloc(&callbacks, (void *)client);
997 stat = yajl_parse(p, (const unsigned char *)message, message_size);
998 if (stat != yajl_status_ok) {
1000 err = yajl_get_error(p, true, (const unsigned char *)message,
1002 ELOG("YAJL parse error: %s\n", err);
1003 yajl_free_error(p, err);
1005 const char *reply = "{\"success\":false}";
1006 ipc_send_message(fd, strlen(reply), I3_IPC_REPLY_TYPE_SUBSCRIBE, (const uint8_t *)reply);
1011 const char *reply = "{\"success\":true}";
1012 ipc_send_message(fd, strlen(reply), I3_IPC_REPLY_TYPE_SUBSCRIBE, (const uint8_t *)reply);
1015 /* The index of each callback function corresponds to the numeric
1016 * value of the message type (see include/i3/ipc.h) */
1017 handler_t handlers[8] = {
1019 handle_get_workspaces,
1024 handle_get_bar_config,
1029 * Handler for activity on a client connection, receives a message from a
1032 * For now, the maximum message size is 2048. I’m not sure for what the
1033 * IPC interface will be used in the future, thus I’m not implementing a
1034 * mechanism for arbitrarily long messages, as it seems like overkill
1038 static void ipc_receive_message(EV_P_ struct ev_io *w, int revents) {
1039 uint32_t message_type;
1040 uint32_t message_length;
1041 uint8_t *message = NULL;
1043 int ret = ipc_recv_message(w->fd, &message_type, &message_length, &message);
1044 /* EOF or other error */
1046 /* Was this a spurious read? See ev(3) */
1047 if (ret == -1 && errno == EAGAIN) {
1052 /* If not, there was some kind of error. We don’t bother
1053 * and close the connection */
1056 /* Delete the client from the list of clients */
1057 ipc_client *current;
1058 TAILQ_FOREACH(current, &all_clients, clients) {
1059 if (current->fd != w->fd)
1062 for (int i = 0; i < current->num_events; i++)
1063 free(current->events[i]);
1064 /* We can call TAILQ_REMOVE because we break out of the
1065 * TAILQ_FOREACH afterwards */
1066 TAILQ_REMOVE(&all_clients, current, clients);
1071 ev_io_stop(EV_A_ w);
1075 DLOG("IPC: client disconnected\n");
1079 if (message_type >= (sizeof(handlers) / sizeof(handler_t)))
1080 DLOG("Unhandled message type: %d\n", message_type);
1082 handler_t h = handlers[message_type];
1083 h(w->fd, message, 0, message_length, message_type);
1090 * Handler for activity on the listening socket, meaning that a new client
1091 * has just connected and we should accept() him. Sets up the event handler
1092 * for activity on the new connection and inserts the file descriptor into
1093 * the list of clients.
1096 void ipc_new_client(EV_P_ struct ev_io *w, int revents) {
1097 struct sockaddr_un peer;
1098 socklen_t len = sizeof(struct sockaddr_un);
1100 if ((client = accept(w->fd, (struct sockaddr *)&peer, &len)) < 0) {
1108 /* Close this file descriptor on exec() */
1109 (void)fcntl(client, F_SETFD, FD_CLOEXEC);
1111 set_nonblock(client);
1113 struct ev_io *package = scalloc(1, sizeof(struct ev_io));
1114 ev_io_init(package, ipc_receive_message, client, EV_READ);
1115 ev_io_start(EV_A_ package);
1117 DLOG("IPC: new client connected on fd %d\n", w->fd);
1119 ipc_client *new = scalloc(1, sizeof(ipc_client));
1122 TAILQ_INSERT_TAIL(&all_clients, new, clients);
1126 * Creates the UNIX domain socket at the given path, sets it to non-blocking
1127 * mode, bind()s and listen()s on it.
1130 int ipc_create_socket(const char *filename) {
1133 FREE(current_socketpath);
1135 char *resolved = resolve_tilde(filename);
1136 DLOG("Creating IPC-socket at %s\n", resolved);
1137 char *copy = sstrdup(resolved);
1138 const char *dir = dirname(copy);
1139 if (!path_exists(dir))
1140 mkdirp(dir, DEFAULT_DIR_MODE);
1143 /* Unlink the unix domain socket before */
1146 if ((sockfd = socket(AF_LOCAL, SOCK_STREAM, 0)) < 0) {
1152 (void)fcntl(sockfd, F_SETFD, FD_CLOEXEC);
1154 struct sockaddr_un addr;
1155 memset(&addr, 0, sizeof(struct sockaddr_un));
1156 addr.sun_family = AF_LOCAL;
1157 strncpy(addr.sun_path, resolved, sizeof(addr.sun_path) - 1);
1158 if (bind(sockfd, (struct sockaddr *)&addr, sizeof(struct sockaddr_un)) < 0) {
1164 set_nonblock(sockfd);
1166 if (listen(sockfd, 5) < 0) {
1172 current_socketpath = resolved;
1177 * Generates a json workspace event. Returns a dynamically allocated yajl
1178 * generator. Free with yajl_gen_free().
1180 yajl_gen ipc_marshal_workspace_event(const char *change, Con *current, Con *old) {
1181 setlocale(LC_NUMERIC, "C");
1182 yajl_gen gen = ygenalloc();
1190 if (current == NULL)
1193 dump_node(gen, current, false);
1199 dump_node(gen, old, false);
1203 setlocale(LC_NUMERIC, "");
1209 * For the workspace events we send, along with the usual "change" field, also
1210 * the workspace container in "current". For focus events, we send the
1211 * previously focused workspace in "old".
1213 void ipc_send_workspace_event(const char *change, Con *current, Con *old) {
1214 yajl_gen gen = ipc_marshal_workspace_event(change, current, old);
1216 const unsigned char *payload;
1218 y(get_buf, &payload, &length);
1220 ipc_send_event("workspace", I3_IPC_EVENT_WORKSPACE, (const char *)payload);
1226 * For the window events we send, along the usual "change" field,
1227 * also the window container, in "container".
1229 void ipc_send_window_event(const char *property, Con *con) {
1230 DLOG("Issue IPC window %s event (con = %p, window = 0x%08x)\n",
1231 property, con, (con->window ? con->window->id : XCB_WINDOW_NONE));
1233 setlocale(LC_NUMERIC, "C");
1234 yajl_gen gen = ygenalloc();
1242 dump_node(gen, con, false);
1246 const unsigned char *payload;
1248 y(get_buf, &payload, &length);
1250 ipc_send_event("window", I3_IPC_EVENT_WINDOW, (const char *)payload);
1252 setlocale(LC_NUMERIC, "");
1256 * For the barconfig update events, we send the serialized barconfig.
1258 void ipc_send_barconfig_update_event(Barconfig *barconfig) {
1259 DLOG("Issue barconfig_update event for id = %s\n", barconfig->id);
1260 setlocale(LC_NUMERIC, "C");
1261 yajl_gen gen = ygenalloc();
1263 dump_bar_config(gen, barconfig);
1265 const unsigned char *payload;
1267 y(get_buf, &payload, &length);
1269 ipc_send_event("barconfig_update", I3_IPC_EVENT_BARCONFIG_UPDATE, (const char *)payload);
1271 setlocale(LC_NUMERIC, "");
1275 * For the binding events, we send the serialized binding struct.
1277 void ipc_send_binding_event(const char *event_type, Binding *bind) {
1278 DLOG("Issue IPC binding %s event (sym = %s, code = %d)\n", event_type, bind->symbol, bind->keycode);
1280 setlocale(LC_NUMERIC, "C");
1282 yajl_gen gen = ygenalloc();
1290 dump_binding(gen, bind);
1294 const unsigned char *payload;
1296 y(get_buf, &payload, &length);
1298 ipc_send_event("binding", I3_IPC_EVENT_BINDING, (const char *)payload);
1301 setlocale(LC_NUMERIC, "");