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));
305 if (con->type == CT_WORKSPACE) {
307 y(integer, con->num);
312 y(integer, con->window->id);
316 if (con->window && !inplace_restart) {
317 /* Window properties are useless to preserve when restarting because
318 * they will be queried again anyway. However, for i3-save-tree(1),
319 * they are very useful and save i3-save-tree dealing with X11. */
320 ystr("window_properties");
323 #define DUMP_PROPERTY(key, prop_name) \
325 if (con->window->prop_name != NULL) { \
327 ystr(con->window->prop_name); \
331 DUMP_PROPERTY("class", class_class);
332 DUMP_PROPERTY("instance", class_instance);
333 DUMP_PROPERTY("window_role", role);
335 if (con->window->name != NULL) {
337 ystr(i3string_as_utf8(con->window->name));
346 if (con->type != CT_DOCKAREA || !inplace_restart) {
347 TAILQ_FOREACH (node, &(con->nodes_head), nodes) {
348 dump_node(gen, node, inplace_restart);
353 ystr("floating_nodes");
355 TAILQ_FOREACH (node, &(con->floating_head), floating_windows) {
356 dump_node(gen, node, inplace_restart);
362 TAILQ_FOREACH (node, &(con->focus_head), focused) {
363 y(integer, (long int)node);
367 ystr("fullscreen_mode");
368 y(integer, con->fullscreen_mode);
371 switch (con->floating) {
372 case FLOATING_AUTO_OFF:
375 case FLOATING_AUTO_ON:
378 case FLOATING_USER_OFF:
381 case FLOATING_USER_ON:
389 TAILQ_FOREACH (match, &(con->swallow_head), matches) {
391 if (match->dock != -1) {
393 y(integer, match->dock);
394 ystr("insert_where");
395 y(integer, match->insert_where);
398 #define DUMP_REGEX(re_name) \
400 if (match->re_name != NULL) { \
402 ystr(match->re_name->pattern); \
407 DUMP_REGEX(instance);
408 DUMP_REGEX(window_role);
415 if (inplace_restart) {
416 if (con->window != NULL) {
419 y(integer, con->window->id);
420 ystr("restart_mode");
427 if (inplace_restart && con->window != NULL) {
429 y(integer, con->depth);
435 static void dump_bar_config(yajl_gen gen, Barconfig *config) {
441 if (config->num_outputs > 0) {
444 for (int c = 0; c < config->num_outputs; c++)
445 ystr(config->outputs[c]);
449 #define YSTR_IF_SET(name) \
451 if (config->name) { \
453 ystr(config->name); \
457 YSTR_IF_SET(tray_output);
458 YSTR_IF_SET(socket_path);
461 switch (config->mode) {
474 ystr("hidden_state");
475 switch (config->hidden_state) {
486 switch (config->modifier) {
516 if (config->position == P_BOTTOM)
521 YSTR_IF_SET(status_command);
524 ystr("workspace_buttons");
525 y(bool, !config->hide_workspace_buttons);
527 ystr("strip_workspace_numbers");
528 y(bool, config->strip_workspace_numbers);
530 ystr("binding_mode_indicator");
531 y(bool, !config->hide_binding_mode_indicator);
534 y(bool, config->verbose);
537 #define YSTR_IF_SET(name) \
539 if (config->colors.name) { \
541 ystr(config->colors.name); \
547 YSTR_IF_SET(background);
548 YSTR_IF_SET(statusline);
549 YSTR_IF_SET(separator);
550 YSTR_IF_SET(focused_workspace_border);
551 YSTR_IF_SET(focused_workspace_bg);
552 YSTR_IF_SET(focused_workspace_text);
553 YSTR_IF_SET(active_workspace_border);
554 YSTR_IF_SET(active_workspace_bg);
555 YSTR_IF_SET(active_workspace_text);
556 YSTR_IF_SET(inactive_workspace_border);
557 YSTR_IF_SET(inactive_workspace_bg);
558 YSTR_IF_SET(inactive_workspace_text);
559 YSTR_IF_SET(urgent_workspace_border);
560 YSTR_IF_SET(urgent_workspace_bg);
561 YSTR_IF_SET(urgent_workspace_text);
569 setlocale(LC_NUMERIC, "C");
570 yajl_gen gen = ygenalloc();
571 dump_node(gen, croot, false);
572 setlocale(LC_NUMERIC, "");
574 const unsigned char *payload;
576 y(get_buf, &payload, &length);
578 ipc_send_message(fd, length, I3_IPC_REPLY_TYPE_TREE, payload);
583 * Formats the reply message for a GET_WORKSPACES request and sends it to the
587 IPC_HANDLER(get_workspaces) {
588 yajl_gen gen = ygenalloc();
591 Con *focused_ws = con_get_workspace(focused);
594 TAILQ_FOREACH (output, &(croot->nodes_head), nodes) {
595 if (con_is_internal(output))
598 TAILQ_FOREACH (ws, &(output_get_content(output)->nodes_head), nodes) {
599 assert(ws->type == CT_WORKSPACE);
612 y(bool, workspace_is_visible(ws));
615 y(bool, ws == focused_ws);
620 y(integer, ws->rect.x);
622 y(integer, ws->rect.y);
624 y(integer, ws->rect.width);
626 y(integer, ws->rect.height);
641 const unsigned char *payload;
643 y(get_buf, &payload, &length);
645 ipc_send_message(fd, length, I3_IPC_REPLY_TYPE_WORKSPACES, payload);
650 * Formats the reply message for a GET_OUTPUTS request and sends it to the
654 IPC_HANDLER(get_outputs) {
655 yajl_gen gen = ygenalloc();
659 TAILQ_FOREACH (output, &outputs, outputs) {
666 y(bool, output->active);
669 y(bool, output->primary);
674 y(integer, output->rect.x);
676 y(integer, output->rect.y);
678 y(integer, output->rect.width);
680 y(integer, output->rect.height);
683 ystr("current_workspace");
685 if (output->con && (ws = con_get_fullscreen_con(output->con, CF_OUTPUT)))
695 const unsigned char *payload;
697 y(get_buf, &payload, &length);
699 ipc_send_message(fd, length, I3_IPC_REPLY_TYPE_OUTPUTS, payload);
704 * Formats the reply message for a GET_MARKS request and sends it to the
708 IPC_HANDLER(get_marks) {
709 yajl_gen gen = ygenalloc();
713 TAILQ_FOREACH (con, &all_cons, all_cons)
714 if (con->mark != NULL)
719 const unsigned char *payload;
721 y(get_buf, &payload, &length);
723 ipc_send_message(fd, length, I3_IPC_REPLY_TYPE_MARKS, payload);
728 * Returns the version of i3
731 IPC_HANDLER(get_version) {
732 yajl_gen gen = ygenalloc();
736 y(integer, MAJOR_VERSION);
739 y(integer, MINOR_VERSION);
742 y(integer, PATCH_VERSION);
744 ystr("human_readable");
749 const unsigned char *payload;
751 y(get_buf, &payload, &length);
753 ipc_send_message(fd, length, I3_IPC_REPLY_TYPE_VERSION, payload);
758 * Formats the reply message for a GET_BAR_CONFIG request and sends it to the
762 IPC_HANDLER(get_bar_config) {
763 yajl_gen gen = ygenalloc();
765 /* If no ID was passed, we return a JSON array with all IDs */
766 if (message_size == 0) {
769 TAILQ_FOREACH (current, &barconfigs, configs) {
774 const unsigned char *payload;
776 y(get_buf, &payload, &length);
778 ipc_send_message(fd, length, I3_IPC_REPLY_TYPE_BAR_CONFIG, payload);
783 /* To get a properly terminated buffer, we copy
784 * message_size bytes out of the buffer */
785 char *bar_id = scalloc(message_size + 1);
786 strncpy(bar_id, (const char *)message, message_size);
787 LOG("IPC: looking for config for bar ID \"%s\"\n", bar_id);
788 Barconfig *current, *config = NULL;
789 TAILQ_FOREACH (current, &barconfigs, configs) {
790 if (strcmp(current->id, bar_id) != 0)
798 /* If we did not find a config for the given ID, the reply will contain
799 * a null 'id' field. */
807 dump_bar_config(gen, config);
810 const unsigned char *payload;
812 y(get_buf, &payload, &length);
814 ipc_send_message(fd, length, I3_IPC_REPLY_TYPE_BAR_CONFIG, payload);
819 * Callback for the YAJL parser (will be called when a string is parsed).
822 static int add_subscription(void *extra, const unsigned char *s,
824 ipc_client *client = extra;
826 DLOG("should add subscription to extra %p, sub %.*s\n", client, (int)len, s);
827 int event = client->num_events;
829 client->num_events++;
830 client->events = realloc(client->events, client->num_events * sizeof(char *));
831 /* We copy the string because it is not null-terminated and strndup()
832 * is missing on some BSD systems */
833 client->events[event] = scalloc(len + 1);
834 memcpy(client->events[event], s, len);
836 DLOG("client is now subscribed to:\n");
837 for (int i = 0; i < client->num_events; i++)
838 DLOG("event %s\n", client->events[i]);
845 * Subscribes this connection to the event types which were given as a JSON
846 * serialized array in the payload field of the message.
849 IPC_HANDLER(subscribe) {
852 ipc_client *current, *client = NULL;
854 /* Search the ipc_client structure for this connection */
855 TAILQ_FOREACH (current, &all_clients, clients) {
856 if (current->fd != fd)
863 if (client == NULL) {
864 ELOG("Could not find ipc_client data structure for fd %d\n", fd);
868 /* Setup the JSON parser */
869 static yajl_callbacks callbacks = {
870 .yajl_string = add_subscription,
873 p = yalloc(&callbacks, (void *)client);
874 stat = yajl_parse(p, (const unsigned char *)message, message_size);
875 if (stat != yajl_status_ok) {
877 err = yajl_get_error(p, true, (const unsigned char *)message,
879 ELOG("YAJL parse error: %s\n", err);
880 yajl_free_error(p, err);
882 const char *reply = "{\"success\":false}";
883 ipc_send_message(fd, strlen(reply), I3_IPC_REPLY_TYPE_SUBSCRIBE, (const uint8_t *)reply);
888 const char *reply = "{\"success\":true}";
889 ipc_send_message(fd, strlen(reply), I3_IPC_REPLY_TYPE_SUBSCRIBE, (const uint8_t *)reply);
892 /* The index of each callback function corresponds to the numeric
893 * value of the message type (see include/i3/ipc.h) */
894 handler_t handlers[8] = {
896 handle_get_workspaces,
901 handle_get_bar_config,
906 * Handler for activity on a client connection, receives a message from a
909 * For now, the maximum message size is 2048. I’m not sure for what the
910 * IPC interface will be used in the future, thus I’m not implementing a
911 * mechanism for arbitrarily long messages, as it seems like overkill
915 static void ipc_receive_message(EV_P_ struct ev_io *w, int revents) {
916 uint32_t message_type;
917 uint32_t message_length;
918 uint8_t *message = NULL;
920 int ret = ipc_recv_message(w->fd, &message_type, &message_length, &message);
921 /* EOF or other error */
923 /* Was this a spurious read? See ev(3) */
924 if (ret == -1 && errno == EAGAIN) {
929 /* If not, there was some kind of error. We don’t bother
930 * and close the connection */
933 /* Delete the client from the list of clients */
935 TAILQ_FOREACH (current, &all_clients, clients) {
936 if (current->fd != w->fd)
939 for (int i = 0; i < current->num_events; i++)
940 free(current->events[i]);
941 /* We can call TAILQ_REMOVE because we break out of the
942 * TAILQ_FOREACH afterwards */
943 TAILQ_REMOVE(&all_clients, current, clients);
952 DLOG("IPC: client disconnected\n");
956 if (message_type >= (sizeof(handlers) / sizeof(handler_t)))
957 DLOG("Unhandled message type: %d\n", message_type);
959 handler_t h = handlers[message_type];
960 h(w->fd, message, 0, message_length, message_type);
967 * Handler for activity on the listening socket, meaning that a new client
968 * has just connected and we should accept() him. Sets up the event handler
969 * for activity on the new connection and inserts the file descriptor into
970 * the list of clients.
973 void ipc_new_client(EV_P_ struct ev_io *w, int revents) {
974 struct sockaddr_un peer;
975 socklen_t len = sizeof(struct sockaddr_un);
977 if ((client = accept(w->fd, (struct sockaddr *)&peer, &len)) < 0) {
985 /* Close this file descriptor on exec() */
986 (void)fcntl(client, F_SETFD, FD_CLOEXEC);
988 set_nonblock(client);
990 struct ev_io *package = scalloc(sizeof(struct ev_io));
991 ev_io_init(package, ipc_receive_message, client, EV_READ);
992 ev_io_start(EV_A_ package);
994 DLOG("IPC: new client connected on fd %d\n", w->fd);
996 ipc_client *new = scalloc(sizeof(ipc_client));
999 TAILQ_INSERT_TAIL(&all_clients, new, clients);
1003 * Creates the UNIX domain socket at the given path, sets it to non-blocking
1004 * mode, bind()s and listen()s on it.
1007 int ipc_create_socket(const char *filename) {
1010 FREE(current_socketpath);
1012 char *resolved = resolve_tilde(filename);
1013 DLOG("Creating IPC-socket at %s\n", resolved);
1014 char *copy = sstrdup(resolved);
1015 const char *dir = dirname(copy);
1016 if (!path_exists(dir))
1020 /* Unlink the unix domain socket before */
1023 if ((sockfd = socket(AF_LOCAL, SOCK_STREAM, 0)) < 0) {
1029 (void)fcntl(sockfd, F_SETFD, FD_CLOEXEC);
1031 struct sockaddr_un addr;
1032 memset(&addr, 0, sizeof(struct sockaddr_un));
1033 addr.sun_family = AF_LOCAL;
1034 strncpy(addr.sun_path, resolved, sizeof(addr.sun_path) - 1);
1035 if (bind(sockfd, (struct sockaddr *)&addr, sizeof(struct sockaddr_un)) < 0) {
1041 set_nonblock(sockfd);
1043 if (listen(sockfd, 5) < 0) {
1049 current_socketpath = resolved;
1054 * For the workspace "focus" event we send, along the usual "change" field,
1055 * also the current and previous workspace, in "current" and "old"
1058 void ipc_send_workspace_focus_event(Con *current, Con *old) {
1059 setlocale(LC_NUMERIC, "C");
1060 yajl_gen gen = ygenalloc();
1068 dump_node(gen, current, false);
1074 dump_node(gen, old, false);
1078 const unsigned char *payload;
1080 y(get_buf, &payload, &length);
1082 ipc_send_event("workspace", I3_IPC_EVENT_WORKSPACE, (const char *)payload);
1084 setlocale(LC_NUMERIC, "");
1088 * For the window events we send, along the usual "change" field,
1089 * also the window container, in "container".
1091 void ipc_send_window_event(const char *property, Con *con) {
1092 DLOG("Issue IPC window %s event (con = %p, window = 0x%08x)\n",
1093 property, con, (con->window ? con->window->id : XCB_WINDOW_NONE));
1095 setlocale(LC_NUMERIC, "C");
1096 yajl_gen gen = ygenalloc();
1104 dump_node(gen, con, false);
1108 const unsigned char *payload;
1110 y(get_buf, &payload, &length);
1112 ipc_send_event("window", I3_IPC_EVENT_WINDOW, (const char *)payload);
1114 setlocale(LC_NUMERIC, "");
1118 * For the barconfig update events, we send the serialized barconfig.
1120 void ipc_send_barconfig_update_event(Barconfig *barconfig) {
1121 DLOG("Issue barconfig_update event for id = %s\n", barconfig->id);
1122 setlocale(LC_NUMERIC, "C");
1123 yajl_gen gen = ygenalloc();
1125 dump_bar_config(gen, barconfig);
1127 const unsigned char *payload;
1129 y(get_buf, &payload, &length);
1131 ipc_send_event("barconfig_update", I3_IPC_EVENT_BARCONFIG_UPDATE, (const char *)payload);
1133 setlocale(LC_NUMERIC, "");