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 static 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 struct CommandResult *command_output = parse_command((const char*)command);
123 if (command_output->needs_tree_render)
126 const unsigned char *reply;
128 yajl_gen_get_buf(command_output->json_gen, &reply, &length);
130 ipc_send_message(fd, length, I3_IPC_REPLY_TYPE_COMMAND,
131 (const uint8_t*)reply);
133 yajl_gen_free(command_output->json_gen);
136 static void dump_rect(yajl_gen gen, const char *name, Rect r) {
146 y(integer, r.height);
150 void dump_node(yajl_gen gen, struct Con *con, bool inplace_restart) {
153 y(integer, (long int)con);
166 case CT_FLOATING_CON:
167 ystr("floating_con");
176 DLOG("About to dump unknown container type=%d. This is a bug.\n", con->type);
181 /* provided for backwards compatibility only. */
183 if (!con_is_split(con))
186 if (con_orientation(con) == HORIZ)
188 else ystr("vertical");
191 ystr("scratchpad_state");
192 switch (con->scratchpad_state) {
193 case SCRATCHPAD_NONE:
196 case SCRATCHPAD_FRESH:
199 case SCRATCHPAD_CHANGED:
205 if (con->percent == 0.0)
207 else y(double, con->percent);
210 y(bool, con->urgent);
212 if (con->mark != NULL) {
218 y(bool, (con == focused));
221 switch (con->layout) {
223 DLOG("About to dump layout=default, this is a bug in the code.\n");
246 ystr("workspace_layout");
247 switch (con->workspace_layout) {
258 DLOG("About to dump workspace_layout=%d (none of default/stacked/tabbed), this is a bug.\n", con->workspace_layout);
263 ystr("last_split_layout");
264 switch (con->layout) {
274 switch (con->border_style) {
286 ystr("current_border_width");
287 y(integer, con->current_border_width);
289 dump_rect(gen, "rect", con->rect);
290 dump_rect(gen, "window_rect", con->window_rect);
291 dump_rect(gen, "geometry", con->geometry);
294 if (con->window && con->window->name)
295 ystr(i3string_as_utf8(con->window->name));
299 if (con->type == CT_WORKSPACE) {
301 y(integer, con->num);
306 y(integer, con->window->id);
309 if (con->window && !inplace_restart) {
310 /* Window properties are useless to preserve when restarting because
311 * they will be queried again anyway. However, for i3-save-tree(1),
312 * they are very useful and save i3-save-tree dealing with X11. */
313 ystr("window_properties");
316 #define DUMP_PROPERTY(key, prop_name) do { \
317 if (con->window->prop_name != NULL) { \
319 ystr(con->window->prop_name); \
323 DUMP_PROPERTY("class", class_class);
324 DUMP_PROPERTY("instance", class_instance);
325 DUMP_PROPERTY("window_role", role);
327 if (con->window->name != NULL) {
329 ystr(i3string_as_utf8(con->window->name));
338 if (con->type != CT_DOCKAREA || !inplace_restart) {
339 TAILQ_FOREACH(node, &(con->nodes_head), nodes) {
340 dump_node(gen, node, inplace_restart);
345 ystr("floating_nodes");
347 TAILQ_FOREACH(node, &(con->floating_head), floating_windows) {
348 dump_node(gen, node, inplace_restart);
354 TAILQ_FOREACH(node, &(con->focus_head), focused) {
355 y(integer, (long int)node);
359 ystr("fullscreen_mode");
360 y(integer, con->fullscreen_mode);
363 switch (con->floating) {
364 case FLOATING_AUTO_OFF:
367 case FLOATING_AUTO_ON:
370 case FLOATING_USER_OFF:
373 case FLOATING_USER_ON:
381 TAILQ_FOREACH(match, &(con->swallow_head), matches) {
383 if (match->dock != -1) {
385 y(integer, match->dock);
386 ystr("insert_where");
387 y(integer, match->insert_where);
390 #define DUMP_REGEX(re_name) do { \
391 if (match->re_name != NULL) { \
393 ystr(match->re_name->pattern); \
398 DUMP_REGEX(instance);
399 DUMP_REGEX(window_role);
406 if (inplace_restart) {
407 if (con->window != NULL) {
410 y(integer, con->window->id);
411 ystr("restart_mode");
418 if (inplace_restart && con->window != NULL) {
420 y(integer, con->depth);
427 setlocale(LC_NUMERIC, "C");
428 yajl_gen gen = ygenalloc();
429 dump_node(gen, croot, false);
430 setlocale(LC_NUMERIC, "");
432 const unsigned char *payload;
434 y(get_buf, &payload, &length);
436 ipc_send_message(fd, length, I3_IPC_REPLY_TYPE_TREE, payload);
442 * Formats the reply message for a GET_WORKSPACES request and sends it to the
446 IPC_HANDLER(get_workspaces) {
447 yajl_gen gen = ygenalloc();
450 Con *focused_ws = con_get_workspace(focused);
453 TAILQ_FOREACH(output, &(croot->nodes_head), nodes) {
454 if (con_is_internal(output))
457 TAILQ_FOREACH(ws, &(output_get_content(output)->nodes_head), nodes) {
458 assert(ws->type == CT_WORKSPACE);
464 else y(integer, ws->num);
470 y(bool, workspace_is_visible(ws));
473 y(bool, ws == focused_ws);
478 y(integer, ws->rect.x);
480 y(integer, ws->rect.y);
482 y(integer, ws->rect.width);
484 y(integer, ws->rect.height);
499 const unsigned char *payload;
501 y(get_buf, &payload, &length);
503 ipc_send_message(fd, length, I3_IPC_REPLY_TYPE_WORKSPACES, payload);
508 * Formats the reply message for a GET_OUTPUTS request and sends it to the
512 IPC_HANDLER(get_outputs) {
513 yajl_gen gen = ygenalloc();
517 TAILQ_FOREACH(output, &outputs, outputs) {
524 y(bool, output->active);
527 y(bool, output->primary);
532 y(integer, output->rect.x);
534 y(integer, output->rect.y);
536 y(integer, output->rect.width);
538 y(integer, output->rect.height);
541 ystr("current_workspace");
543 if (output->con && (ws = con_get_fullscreen_con(output->con, CF_OUTPUT)))
552 const unsigned char *payload;
554 y(get_buf, &payload, &length);
556 ipc_send_message(fd, length, I3_IPC_REPLY_TYPE_OUTPUTS, payload);
561 * Formats the reply message for a GET_MARKS request and sends it to the
565 IPC_HANDLER(get_marks) {
566 yajl_gen gen = ygenalloc();
570 TAILQ_FOREACH(con, &all_cons, all_cons)
571 if (con->mark != NULL)
576 const unsigned char *payload;
578 y(get_buf, &payload, &length);
580 ipc_send_message(fd, length, I3_IPC_REPLY_TYPE_MARKS, payload);
585 * Returns the version of i3
588 IPC_HANDLER(get_version) {
589 yajl_gen gen = ygenalloc();
593 y(integer, MAJOR_VERSION);
596 y(integer, MINOR_VERSION);
599 y(integer, PATCH_VERSION);
601 ystr("human_readable");
606 const unsigned char *payload;
608 y(get_buf, &payload, &length);
610 ipc_send_message(fd, length, I3_IPC_REPLY_TYPE_VERSION, payload);
615 * Formats the reply message for a GET_BAR_CONFIG request and sends it to the
619 IPC_HANDLER(get_bar_config) {
620 yajl_gen gen = ygenalloc();
622 /* If no ID was passed, we return a JSON array with all IDs */
623 if (message_size == 0) {
626 TAILQ_FOREACH(current, &barconfigs, configs) {
631 const unsigned char *payload;
633 y(get_buf, &payload, &length);
635 ipc_send_message(fd, length, I3_IPC_REPLY_TYPE_BAR_CONFIG, payload);
640 /* To get a properly terminated buffer, we copy
641 * message_size bytes out of the buffer */
642 char *bar_id = scalloc(message_size + 1);
643 strncpy(bar_id, (const char*)message, message_size);
644 LOG("IPC: looking for config for bar ID \"%s\"\n", bar_id);
645 Barconfig *current, *config = NULL;
646 TAILQ_FOREACH(current, &barconfigs, configs) {
647 if (strcmp(current->id, bar_id) != 0)
657 /* If we did not find a config for the given ID, the reply will contain
658 * a null 'id' field. */
665 if (config->num_outputs > 0) {
668 for (int c = 0; c < config->num_outputs; c++)
669 ystr(config->outputs[c]);
673 #define YSTR_IF_SET(name) \
675 if (config->name) { \
677 ystr(config->name); \
681 YSTR_IF_SET(tray_output);
682 YSTR_IF_SET(socket_path);
685 switch (config->mode) {
698 ystr("hidden_state");
699 switch (config->hidden_state) {
710 switch (config->modifier) {
740 if (config->position == P_BOTTOM)
744 YSTR_IF_SET(status_command);
747 ystr("workspace_buttons");
748 y(bool, !config->hide_workspace_buttons);
750 ystr("binding_mode_indicator");
751 y(bool, !config->hide_binding_mode_indicator);
754 y(bool, config->verbose);
757 #define YSTR_IF_SET(name) \
759 if (config->colors.name) { \
761 ystr(config->colors.name); \
767 YSTR_IF_SET(background);
768 YSTR_IF_SET(statusline);
769 YSTR_IF_SET(separator);
770 YSTR_IF_SET(focused_workspace_border);
771 YSTR_IF_SET(focused_workspace_bg);
772 YSTR_IF_SET(focused_workspace_text);
773 YSTR_IF_SET(active_workspace_border);
774 YSTR_IF_SET(active_workspace_bg);
775 YSTR_IF_SET(active_workspace_text);
776 YSTR_IF_SET(inactive_workspace_border);
777 YSTR_IF_SET(inactive_workspace_bg);
778 YSTR_IF_SET(inactive_workspace_text);
779 YSTR_IF_SET(urgent_workspace_border);
780 YSTR_IF_SET(urgent_workspace_bg);
781 YSTR_IF_SET(urgent_workspace_text);
789 const unsigned char *payload;
791 y(get_buf, &payload, &length);
793 ipc_send_message(fd, length, I3_IPC_REPLY_TYPE_BAR_CONFIG, payload);
798 * Callback for the YAJL parser (will be called when a string is parsed).
801 static int add_subscription(void *extra, const unsigned char *s,
803 ipc_client *client = extra;
805 DLOG("should add subscription to extra %p, sub %.*s\n", client, (int)len, s);
806 int event = client->num_events;
808 client->num_events++;
809 client->events = realloc(client->events, client->num_events * sizeof(char*));
810 /* We copy the string because it is not null-terminated and strndup()
811 * is missing on some BSD systems */
812 client->events[event] = scalloc(len+1);
813 memcpy(client->events[event], s, len);
815 DLOG("client is now subscribed to:\n");
816 for (int i = 0; i < client->num_events; i++)
817 DLOG("event %s\n", client->events[i]);
824 * Subscribes this connection to the event types which were given as a JSON
825 * serialized array in the payload field of the message.
828 IPC_HANDLER(subscribe) {
831 ipc_client *current, *client = NULL;
833 /* Search the ipc_client structure for this connection */
834 TAILQ_FOREACH(current, &all_clients, clients) {
835 if (current->fd != fd)
842 if (client == NULL) {
843 ELOG("Could not find ipc_client data structure for fd %d\n", fd);
847 /* Setup the JSON parser */
848 static yajl_callbacks callbacks = {
849 .yajl_string = add_subscription,
852 p = yalloc(&callbacks, (void*)client);
853 stat = yajl_parse(p, (const unsigned char*)message, message_size);
854 if (stat != yajl_status_ok) {
856 err = yajl_get_error(p, true, (const unsigned char*)message,
858 ELOG("YAJL parse error: %s\n", err);
859 yajl_free_error(p, err);
861 const char *reply = "{\"success\":false}";
862 ipc_send_message(fd, strlen(reply), I3_IPC_REPLY_TYPE_SUBSCRIBE, (const uint8_t*)reply);
867 const char *reply = "{\"success\":true}";
868 ipc_send_message(fd, strlen(reply), I3_IPC_REPLY_TYPE_SUBSCRIBE, (const uint8_t*)reply);
871 /* The index of each callback function corresponds to the numeric
872 * value of the message type (see include/i3/ipc.h) */
873 handler_t handlers[8] = {
875 handle_get_workspaces,
880 handle_get_bar_config,
885 * Handler for activity on a client connection, receives a message from a
888 * For now, the maximum message size is 2048. I’m not sure for what the
889 * IPC interface will be used in the future, thus I’m not implementing a
890 * mechanism for arbitrarily long messages, as it seems like overkill
894 static void ipc_receive_message(EV_P_ struct ev_io *w, int revents) {
895 uint32_t message_type;
896 uint32_t message_length;
899 int ret = ipc_recv_message(w->fd, &message_type, &message_length, &message);
900 /* EOF or other error */
902 /* Was this a spurious read? See ev(3) */
903 if (ret == -1 && errno == EAGAIN)
906 /* If not, there was some kind of error. We don’t bother
907 * and close the connection */
910 /* Delete the client from the list of clients */
912 TAILQ_FOREACH(current, &all_clients, clients) {
913 if (current->fd != w->fd)
916 for (int i = 0; i < current->num_events; i++)
917 free(current->events[i]);
918 /* We can call TAILQ_REMOVE because we break out of the
919 * TAILQ_FOREACH afterwards */
920 TAILQ_REMOVE(&all_clients, current, clients);
928 DLOG("IPC: client disconnected\n");
932 if (message_type >= (sizeof(handlers) / sizeof(handler_t)))
933 DLOG("Unhandled message type: %d\n", message_type);
935 handler_t h = handlers[message_type];
936 h(w->fd, message, 0, message_length, message_type);
941 * Handler for activity on the listening socket, meaning that a new client
942 * has just connected and we should accept() him. Sets up the event handler
943 * for activity on the new connection and inserts the file descriptor into
944 * the list of clients.
947 void ipc_new_client(EV_P_ struct ev_io *w, int revents) {
948 struct sockaddr_un peer;
949 socklen_t len = sizeof(struct sockaddr_un);
951 if ((client = accept(w->fd, (struct sockaddr*)&peer, &len)) < 0) {
954 else perror("accept()");
958 /* Close this file descriptor on exec() */
959 (void)fcntl(client, F_SETFD, FD_CLOEXEC);
961 set_nonblock(client);
963 struct ev_io *package = scalloc(sizeof(struct ev_io));
964 ev_io_init(package, ipc_receive_message, client, EV_READ);
965 ev_io_start(EV_A_ package);
967 DLOG("IPC: new client connected on fd %d\n", w->fd);
969 ipc_client *new = scalloc(sizeof(ipc_client));
972 TAILQ_INSERT_TAIL(&all_clients, new, clients);
976 * Creates the UNIX domain socket at the given path, sets it to non-blocking
977 * mode, bind()s and listen()s on it.
980 int ipc_create_socket(const char *filename) {
983 FREE(current_socketpath);
985 char *resolved = resolve_tilde(filename);
986 DLOG("Creating IPC-socket at %s\n", resolved);
987 char *copy = sstrdup(resolved);
988 const char *dir = dirname(copy);
989 if (!path_exists(dir))
993 /* Unlink the unix domain socket before */
996 if ((sockfd = socket(AF_LOCAL, SOCK_STREAM, 0)) < 0) {
1002 (void)fcntl(sockfd, F_SETFD, FD_CLOEXEC);
1004 struct sockaddr_un addr;
1005 memset(&addr, 0, sizeof(struct sockaddr_un));
1006 addr.sun_family = AF_LOCAL;
1007 strncpy(addr.sun_path, resolved, sizeof(addr.sun_path) - 1);
1008 if (bind(sockfd, (struct sockaddr*)&addr, sizeof(struct sockaddr_un)) < 0) {
1014 set_nonblock(sockfd);
1016 if (listen(sockfd, 5) < 0) {
1022 current_socketpath = resolved;
1027 * For the workspace "focus" event we send, along the usual "change" field,
1028 * also the current and previous workspace, in "current" and "old"
1031 void ipc_send_workspace_focus_event(Con *current, Con *old) {
1032 setlocale(LC_NUMERIC, "C");
1033 yajl_gen gen = ygenalloc();
1041 dump_node(gen, current, false);
1047 dump_node(gen, old, false);
1051 const unsigned char *payload;
1053 y(get_buf, &payload, &length);
1055 ipc_send_event("workspace", I3_IPC_EVENT_WORKSPACE, (const char *)payload);
1057 setlocale(LC_NUMERIC, "");