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 static void dump_binding(yajl_gen gen, Binding *bind) {
157 y(integer, bind->keycode);
160 ystr((const char*)(bind->input_type == B_KEYBOARD ? "keyboard" : "mouse"));
163 if (bind->symbol == NULL)
173 for (int i = 0; i < 8; i++) {
174 if (bind->mods & (1 << i)) {
176 case XCB_MOD_MASK_SHIFT:
179 case XCB_MOD_MASK_LOCK:
182 case XCB_MOD_MASK_CONTROL:
208 void dump_node(yajl_gen gen, struct Con *con, bool inplace_restart) {
211 y(integer, (long int)con);
224 case CT_FLOATING_CON:
225 ystr("floating_con");
234 DLOG("About to dump unknown container type=%d. This is a bug.\n", con->type);
239 /* provided for backwards compatibility only. */
241 if (!con_is_split(con))
244 if (con_orientation(con) == HORIZ)
250 ystr("scratchpad_state");
251 switch (con->scratchpad_state) {
252 case SCRATCHPAD_NONE:
255 case SCRATCHPAD_FRESH:
258 case SCRATCHPAD_CHANGED:
264 if (con->percent == 0.0)
267 y(double, con->percent);
270 y(bool, con->urgent);
272 if (con->mark != NULL) {
278 y(bool, (con == focused));
281 switch (con->layout) {
283 DLOG("About to dump layout=default, this is a bug in the code.\n");
306 ystr("workspace_layout");
307 switch (con->workspace_layout) {
318 DLOG("About to dump workspace_layout=%d (none of default/stacked/tabbed), this is a bug.\n", con->workspace_layout);
323 ystr("last_split_layout");
324 switch (con->layout) {
334 switch (con->border_style) {
346 ystr("current_border_width");
347 y(integer, con->current_border_width);
349 dump_rect(gen, "rect", con->rect);
350 dump_rect(gen, "deco_rect", con->deco_rect);
351 dump_rect(gen, "window_rect", con->window_rect);
352 dump_rect(gen, "geometry", con->geometry);
355 if (con->window && con->window->name)
356 ystr(i3string_as_utf8(con->window->name));
357 else if (con->name != NULL)
362 if (con->type == CT_WORKSPACE) {
364 y(integer, con->num);
369 y(integer, con->window->id);
373 if (con->window && !inplace_restart) {
374 /* Window properties are useless to preserve when restarting because
375 * they will be queried again anyway. However, for i3-save-tree(1),
376 * they are very useful and save i3-save-tree dealing with X11. */
377 ystr("window_properties");
380 #define DUMP_PROPERTY(key, prop_name) \
382 if (con->window->prop_name != NULL) { \
384 ystr(con->window->prop_name); \
388 DUMP_PROPERTY("class", class_class);
389 DUMP_PROPERTY("instance", class_instance);
390 DUMP_PROPERTY("window_role", role);
392 if (con->window->name != NULL) {
394 ystr(i3string_as_utf8(con->window->name));
397 ystr("transient_for");
398 if (con->window->transient_for == XCB_NONE)
400 else y(integer, con->window->transient_for);
408 if (con->type != CT_DOCKAREA || !inplace_restart) {
409 TAILQ_FOREACH(node, &(con->nodes_head), nodes) {
410 dump_node(gen, node, inplace_restart);
415 ystr("floating_nodes");
417 TAILQ_FOREACH(node, &(con->floating_head), floating_windows) {
418 dump_node(gen, node, inplace_restart);
424 TAILQ_FOREACH(node, &(con->focus_head), focused) {
425 y(integer, (long int)node);
429 ystr("fullscreen_mode");
430 y(integer, con->fullscreen_mode);
433 switch (con->floating) {
434 case FLOATING_AUTO_OFF:
437 case FLOATING_AUTO_ON:
440 case FLOATING_USER_OFF:
443 case FLOATING_USER_ON:
451 TAILQ_FOREACH(match, &(con->swallow_head), matches) {
453 if (match->dock != -1) {
455 y(integer, match->dock);
456 ystr("insert_where");
457 y(integer, match->insert_where);
460 #define DUMP_REGEX(re_name) \
462 if (match->re_name != NULL) { \
464 ystr(match->re_name->pattern); \
469 DUMP_REGEX(instance);
470 DUMP_REGEX(window_role);
477 if (inplace_restart) {
478 if (con->window != NULL) {
481 y(integer, con->window->id);
482 ystr("restart_mode");
489 if (inplace_restart && con->window != NULL) {
491 y(integer, con->depth);
497 static void dump_bar_config(yajl_gen gen, Barconfig *config) {
503 if (config->num_outputs > 0) {
506 for (int c = 0; c < config->num_outputs; c++)
507 ystr(config->outputs[c]);
511 #define YSTR_IF_SET(name) \
513 if (config->name) { \
515 ystr(config->name); \
519 YSTR_IF_SET(tray_output);
520 YSTR_IF_SET(socket_path);
523 switch (config->mode) {
536 ystr("hidden_state");
537 switch (config->hidden_state) {
548 switch (config->modifier) {
577 if (config->wheel_up_cmd) {
578 ystr("wheel_up_cmd");
579 ystr(config->wheel_up_cmd);
582 if (config->wheel_down_cmd) {
583 ystr("wheel_down_cmd");
584 ystr(config->wheel_down_cmd);
588 if (config->position == P_BOTTOM)
593 YSTR_IF_SET(status_command);
596 ystr("workspace_buttons");
597 y(bool, !config->hide_workspace_buttons);
599 ystr("strip_workspace_numbers");
600 y(bool, config->strip_workspace_numbers);
602 ystr("binding_mode_indicator");
603 y(bool, !config->hide_binding_mode_indicator);
606 y(bool, config->verbose);
609 #define YSTR_IF_SET(name) \
611 if (config->colors.name) { \
613 ystr(config->colors.name); \
619 YSTR_IF_SET(background);
620 YSTR_IF_SET(statusline);
621 YSTR_IF_SET(separator);
622 YSTR_IF_SET(focused_workspace_border);
623 YSTR_IF_SET(focused_workspace_bg);
624 YSTR_IF_SET(focused_workspace_text);
625 YSTR_IF_SET(active_workspace_border);
626 YSTR_IF_SET(active_workspace_bg);
627 YSTR_IF_SET(active_workspace_text);
628 YSTR_IF_SET(inactive_workspace_border);
629 YSTR_IF_SET(inactive_workspace_bg);
630 YSTR_IF_SET(inactive_workspace_text);
631 YSTR_IF_SET(urgent_workspace_border);
632 YSTR_IF_SET(urgent_workspace_bg);
633 YSTR_IF_SET(urgent_workspace_text);
641 setlocale(LC_NUMERIC, "C");
642 yajl_gen gen = ygenalloc();
643 dump_node(gen, croot, false);
644 setlocale(LC_NUMERIC, "");
646 const unsigned char *payload;
648 y(get_buf, &payload, &length);
650 ipc_send_message(fd, length, I3_IPC_REPLY_TYPE_TREE, payload);
655 * Formats the reply message for a GET_WORKSPACES request and sends it to the
659 IPC_HANDLER(get_workspaces) {
660 yajl_gen gen = ygenalloc();
663 Con *focused_ws = con_get_workspace(focused);
666 TAILQ_FOREACH(output, &(croot->nodes_head), nodes) {
667 if (con_is_internal(output))
670 TAILQ_FOREACH(ws, &(output_get_content(output)->nodes_head), nodes) {
671 assert(ws->type == CT_WORKSPACE);
681 y(bool, workspace_is_visible(ws));
684 y(bool, ws == focused_ws);
689 y(integer, ws->rect.x);
691 y(integer, ws->rect.y);
693 y(integer, ws->rect.width);
695 y(integer, ws->rect.height);
710 const unsigned char *payload;
712 y(get_buf, &payload, &length);
714 ipc_send_message(fd, length, I3_IPC_REPLY_TYPE_WORKSPACES, payload);
719 * Formats the reply message for a GET_OUTPUTS request and sends it to the
723 IPC_HANDLER(get_outputs) {
724 yajl_gen gen = ygenalloc();
728 TAILQ_FOREACH(output, &outputs, outputs) {
735 y(bool, output->active);
738 y(bool, output->primary);
743 y(integer, output->rect.x);
745 y(integer, output->rect.y);
747 y(integer, output->rect.width);
749 y(integer, output->rect.height);
752 ystr("current_workspace");
754 if (output->con && (ws = con_get_fullscreen_con(output->con, CF_OUTPUT)))
764 const unsigned char *payload;
766 y(get_buf, &payload, &length);
768 ipc_send_message(fd, length, I3_IPC_REPLY_TYPE_OUTPUTS, payload);
773 * Formats the reply message for a GET_MARKS request and sends it to the
777 IPC_HANDLER(get_marks) {
778 yajl_gen gen = ygenalloc();
782 TAILQ_FOREACH(con, &all_cons, all_cons)
783 if (con->mark != NULL)
788 const unsigned char *payload;
790 y(get_buf, &payload, &length);
792 ipc_send_message(fd, length, I3_IPC_REPLY_TYPE_MARKS, payload);
797 * Returns the version of i3
800 IPC_HANDLER(get_version) {
801 yajl_gen gen = ygenalloc();
805 y(integer, MAJOR_VERSION);
808 y(integer, MINOR_VERSION);
811 y(integer, PATCH_VERSION);
813 ystr("human_readable");
818 const unsigned char *payload;
820 y(get_buf, &payload, &length);
822 ipc_send_message(fd, length, I3_IPC_REPLY_TYPE_VERSION, payload);
827 * Formats the reply message for a GET_BAR_CONFIG request and sends it to the
831 IPC_HANDLER(get_bar_config) {
832 yajl_gen gen = ygenalloc();
834 /* If no ID was passed, we return a JSON array with all IDs */
835 if (message_size == 0) {
838 TAILQ_FOREACH(current, &barconfigs, configs) {
843 const unsigned char *payload;
845 y(get_buf, &payload, &length);
847 ipc_send_message(fd, length, I3_IPC_REPLY_TYPE_BAR_CONFIG, payload);
852 /* To get a properly terminated buffer, we copy
853 * message_size bytes out of the buffer */
854 char *bar_id = scalloc(message_size + 1);
855 strncpy(bar_id, (const char *)message, message_size);
856 LOG("IPC: looking for config for bar ID \"%s\"\n", bar_id);
857 Barconfig *current, *config = NULL;
858 TAILQ_FOREACH(current, &barconfigs, configs) {
859 if (strcmp(current->id, bar_id) != 0)
867 /* If we did not find a config for the given ID, the reply will contain
868 * a null 'id' field. */
876 dump_bar_config(gen, config);
879 const unsigned char *payload;
881 y(get_buf, &payload, &length);
883 ipc_send_message(fd, length, I3_IPC_REPLY_TYPE_BAR_CONFIG, payload);
888 * Callback for the YAJL parser (will be called when a string is parsed).
891 static int add_subscription(void *extra, const unsigned char *s,
893 ipc_client *client = extra;
895 DLOG("should add subscription to extra %p, sub %.*s\n", client, (int)len, s);
896 int event = client->num_events;
898 client->num_events++;
899 client->events = realloc(client->events, client->num_events * sizeof(char *));
900 /* We copy the string because it is not null-terminated and strndup()
901 * is missing on some BSD systems */
902 client->events[event] = scalloc(len + 1);
903 memcpy(client->events[event], s, len);
905 DLOG("client is now subscribed to:\n");
906 for (int i = 0; i < client->num_events; i++)
907 DLOG("event %s\n", client->events[i]);
914 * Subscribes this connection to the event types which were given as a JSON
915 * serialized array in the payload field of the message.
918 IPC_HANDLER(subscribe) {
921 ipc_client *current, *client = NULL;
923 /* Search the ipc_client structure for this connection */
924 TAILQ_FOREACH(current, &all_clients, clients) {
925 if (current->fd != fd)
932 if (client == NULL) {
933 ELOG("Could not find ipc_client data structure for fd %d\n", fd);
937 /* Setup the JSON parser */
938 static yajl_callbacks callbacks = {
939 .yajl_string = add_subscription,
942 p = yalloc(&callbacks, (void *)client);
943 stat = yajl_parse(p, (const unsigned char *)message, message_size);
944 if (stat != yajl_status_ok) {
946 err = yajl_get_error(p, true, (const unsigned char *)message,
948 ELOG("YAJL parse error: %s\n", err);
949 yajl_free_error(p, err);
951 const char *reply = "{\"success\":false}";
952 ipc_send_message(fd, strlen(reply), I3_IPC_REPLY_TYPE_SUBSCRIBE, (const uint8_t *)reply);
957 const char *reply = "{\"success\":true}";
958 ipc_send_message(fd, strlen(reply), I3_IPC_REPLY_TYPE_SUBSCRIBE, (const uint8_t *)reply);
961 /* The index of each callback function corresponds to the numeric
962 * value of the message type (see include/i3/ipc.h) */
963 handler_t handlers[8] = {
965 handle_get_workspaces,
970 handle_get_bar_config,
975 * Handler for activity on a client connection, receives a message from a
978 * For now, the maximum message size is 2048. I’m not sure for what the
979 * IPC interface will be used in the future, thus I’m not implementing a
980 * mechanism for arbitrarily long messages, as it seems like overkill
984 static void ipc_receive_message(EV_P_ struct ev_io *w, int revents) {
985 uint32_t message_type;
986 uint32_t message_length;
987 uint8_t *message = NULL;
989 int ret = ipc_recv_message(w->fd, &message_type, &message_length, &message);
990 /* EOF or other error */
992 /* Was this a spurious read? See ev(3) */
993 if (ret == -1 && errno == EAGAIN) {
998 /* If not, there was some kind of error. We don’t bother
999 * and close the connection */
1002 /* Delete the client from the list of clients */
1003 ipc_client *current;
1004 TAILQ_FOREACH(current, &all_clients, clients) {
1005 if (current->fd != w->fd)
1008 for (int i = 0; i < current->num_events; i++)
1009 free(current->events[i]);
1010 /* We can call TAILQ_REMOVE because we break out of the
1011 * TAILQ_FOREACH afterwards */
1012 TAILQ_REMOVE(&all_clients, current, clients);
1017 ev_io_stop(EV_A_ w);
1021 DLOG("IPC: client disconnected\n");
1025 if (message_type >= (sizeof(handlers) / sizeof(handler_t)))
1026 DLOG("Unhandled message type: %d\n", message_type);
1028 handler_t h = handlers[message_type];
1029 h(w->fd, message, 0, message_length, message_type);
1036 * Handler for activity on the listening socket, meaning that a new client
1037 * has just connected and we should accept() him. Sets up the event handler
1038 * for activity on the new connection and inserts the file descriptor into
1039 * the list of clients.
1042 void ipc_new_client(EV_P_ struct ev_io *w, int revents) {
1043 struct sockaddr_un peer;
1044 socklen_t len = sizeof(struct sockaddr_un);
1046 if ((client = accept(w->fd, (struct sockaddr *)&peer, &len)) < 0) {
1054 /* Close this file descriptor on exec() */
1055 (void)fcntl(client, F_SETFD, FD_CLOEXEC);
1057 set_nonblock(client);
1059 struct ev_io *package = scalloc(sizeof(struct ev_io));
1060 ev_io_init(package, ipc_receive_message, client, EV_READ);
1061 ev_io_start(EV_A_ package);
1063 DLOG("IPC: new client connected on fd %d\n", w->fd);
1065 ipc_client *new = scalloc(sizeof(ipc_client));
1068 TAILQ_INSERT_TAIL(&all_clients, new, clients);
1072 * Creates the UNIX domain socket at the given path, sets it to non-blocking
1073 * mode, bind()s and listen()s on it.
1076 int ipc_create_socket(const char *filename) {
1079 FREE(current_socketpath);
1081 char *resolved = resolve_tilde(filename);
1082 DLOG("Creating IPC-socket at %s\n", resolved);
1083 char *copy = sstrdup(resolved);
1084 const char *dir = dirname(copy);
1085 if (!path_exists(dir))
1089 /* Unlink the unix domain socket before */
1092 if ((sockfd = socket(AF_LOCAL, SOCK_STREAM, 0)) < 0) {
1098 (void)fcntl(sockfd, F_SETFD, FD_CLOEXEC);
1100 struct sockaddr_un addr;
1101 memset(&addr, 0, sizeof(struct sockaddr_un));
1102 addr.sun_family = AF_LOCAL;
1103 strncpy(addr.sun_path, resolved, sizeof(addr.sun_path) - 1);
1104 if (bind(sockfd, (struct sockaddr *)&addr, sizeof(struct sockaddr_un)) < 0) {
1110 set_nonblock(sockfd);
1112 if (listen(sockfd, 5) < 0) {
1118 current_socketpath = resolved;
1123 * Generates a json workspace event. Returns a dynamically allocated yajl
1124 * generator. Free with yajl_gen_free().
1126 yajl_gen ipc_marshal_workspace_event(const char *change, Con *current, Con *old) {
1127 setlocale(LC_NUMERIC, "C");
1128 yajl_gen gen = ygenalloc();
1136 if (current == NULL)
1139 dump_node(gen, current, false);
1145 dump_node(gen, old, false);
1149 setlocale(LC_NUMERIC, "");
1155 * For the workspace events we send, along with the usual "change" field, also
1156 * the workspace container in "current". For focus events, we send the
1157 * previously focused workspace in "old".
1159 void ipc_send_workspace_event(const char *change, Con *current, Con *old) {
1160 yajl_gen gen = ipc_marshal_workspace_event(change, current, old);
1162 const unsigned char *payload;
1164 y(get_buf, &payload, &length);
1166 ipc_send_event("workspace", I3_IPC_EVENT_WORKSPACE, (const char *)payload);
1172 * For the window events we send, along the usual "change" field,
1173 * also the window container, in "container".
1175 void ipc_send_window_event(const char *property, Con *con) {
1176 DLOG("Issue IPC window %s event (con = %p, window = 0x%08x)\n",
1177 property, con, (con->window ? con->window->id : XCB_WINDOW_NONE));
1179 setlocale(LC_NUMERIC, "C");
1180 yajl_gen gen = ygenalloc();
1188 dump_node(gen, con, false);
1192 const unsigned char *payload;
1194 y(get_buf, &payload, &length);
1196 ipc_send_event("window", I3_IPC_EVENT_WINDOW, (const char *)payload);
1198 setlocale(LC_NUMERIC, "");
1202 * For the barconfig update events, we send the serialized barconfig.
1204 void ipc_send_barconfig_update_event(Barconfig *barconfig) {
1205 DLOG("Issue barconfig_update event for id = %s\n", barconfig->id);
1206 setlocale(LC_NUMERIC, "C");
1207 yajl_gen gen = ygenalloc();
1209 dump_bar_config(gen, barconfig);
1211 const unsigned char *payload;
1213 y(get_buf, &payload, &length);
1215 ipc_send_event("barconfig_update", I3_IPC_EVENT_BARCONFIG_UPDATE, (const char *)payload);
1217 setlocale(LC_NUMERIC, "");
1221 * For the binding events, we send the serialized binding struct.
1223 void ipc_send_binding_event(const char *event_type, Binding *bind) {
1224 DLOG("Issue IPC binding %s event (sym = %s, code = %d)\n", event_type, bind->symbol, bind->keycode);
1226 setlocale(LC_NUMERIC, "C");
1228 yajl_gen gen = ygenalloc();
1236 dump_binding(gen, bind);
1240 const unsigned char *payload;
1242 y(get_buf, &payload, &length);
1244 ipc_send_event("binding", I3_IPC_EVENT_BINDING, (const char *)payload);
1247 setlocale(LC_NUMERIC, "");