2 * vim:ts=4:sw=4:expandtab
4 * i3 - an improved dynamic tiling window manager
6 * © 2009-2010 Michael Stapelberg and contributors
8 * See file LICENSE for license information.
10 * ipc.c: Everything about the UNIX domain sockets for IPC
13 #include <sys/socket.h>
18 #include <yajl/yajl_gen.h>
19 #include <yajl/yajl_parse.h>
23 /* Shorter names for all those yajl_gen_* functions */
24 #define y(x, ...) yajl_gen_ ## x (gen, ##__VA_ARGS__)
25 #define ystr(str) yajl_gen_string(gen, (unsigned char*)str, strlen(str))
27 TAILQ_HEAD(ipc_client_head, ipc_client) all_clients = TAILQ_HEAD_INITIALIZER(all_clients);
30 * Puts the given socket file descriptor into non-blocking mode or dies if
31 * setting O_NONBLOCK failed. Non-blocking sockets are a good idea for our
32 * IPC model because we should by no means block the window manager.
35 static void set_nonblock(int sockfd) {
36 int flags = fcntl(sockfd, F_GETFL, 0);
38 if (fcntl(sockfd, F_SETFL, flags) < 0)
39 err(-1, "Could not set O_NONBLOCK");
43 * Emulates mkdir -p (creates any missing folders)
46 static bool mkdirp(const char *path) {
47 if (mkdir(path, S_IRWXU | S_IRGRP | S_IXGRP | S_IROTH | S_IXOTH) == 0)
49 if (errno != ENOENT) {
50 ELOG("mkdir(%s) failed: %s\n", path, strerror(errno));
53 char *copy = strdup(path);
54 /* strip trailing slashes, if any */
55 while (copy[strlen(copy)-1] == '/')
56 copy[strlen(copy)-1] = '\0';
58 char *sep = strrchr(copy, '/');
64 result = mkdirp(path);
70 static void ipc_send_message(int fd, const unsigned char *payload,
71 int message_type, int message_size) {
72 int buffer_size = strlen("i3-ipc") + sizeof(uint32_t) +
73 sizeof(uint32_t) + message_size;
74 char msg[buffer_size];
77 strcpy(walk, "i3-ipc");
78 walk += strlen("i3-ipc");
79 memcpy(walk, &message_size, sizeof(uint32_t));
80 walk += sizeof(uint32_t);
81 memcpy(walk, &message_type, sizeof(uint32_t));
82 walk += sizeof(uint32_t);
83 memcpy(walk, payload, message_size);
86 int bytes_to_go = buffer_size;
87 while (sent_bytes < bytes_to_go) {
88 int n = write(fd, msg + sent_bytes, bytes_to_go);
90 DLOG("write() failed: %s\n", strerror(errno));
100 * Sends the specified event to all IPC clients which are currently connected
101 * and subscribed to this kind of event.
104 void ipc_send_event(const char *event, uint32_t message_type, const char *payload) {
106 TAILQ_FOREACH(current, &all_clients, clients) {
107 /* see if this client is interested in this event */
108 bool interested = false;
109 for (int i = 0; i < current->num_events; i++) {
110 if (strcasecmp(current->events[i], event) != 0)
118 ipc_send_message(current->fd, (const unsigned char*)payload,
119 message_type, strlen(payload));
124 * Calls shutdown() on each socket and closes it. This function to be called
125 * when exiting or restarting only!
128 void ipc_shutdown() {
130 TAILQ_FOREACH(current, &all_clients, clients) {
131 shutdown(current->fd, SHUT_RDWR);
137 * Executes the command and returns whether it could be successfully parsed
138 * or not (at the moment, always returns true).
141 IPC_HANDLER(command) {
142 /* To get a properly terminated buffer, we copy
143 * message_size bytes out of the buffer */
144 char *command = scalloc(message_size + 1);
145 strncpy(command, (const char*)message, message_size);
146 LOG("IPC: received: *%s*\n", command);
147 const char *reply = parse_cmd((const char*)command);
151 /* If no reply was provided, we just use the default success message */
153 reply = "{\"success\":true}";
154 ipc_send_message(fd, (const unsigned char*)reply,
155 I3_IPC_REPLY_TYPE_COMMAND, strlen(reply));
158 static void dump_rect(yajl_gen gen, const char *name, Rect r) {
168 y(integer, r.height);
172 void dump_node(yajl_gen gen, struct Con *con, bool inplace_restart) {
175 y(integer, (long int)con);
178 y(integer, con->type);
181 switch (con->orientation) {
194 y(double, con->percent);
197 y(integer, con->urgent);
200 y(integer, (con == focused));
203 y(integer, con->layout);
206 y(integer, con->border_style);
208 dump_rect(gen, "rect", con->rect);
209 dump_rect(gen, "window_rect", con->window_rect);
210 dump_rect(gen, "geometry", con->geometry);
215 if (con->type == CT_WORKSPACE) {
217 y(integer, con->num);
222 y(integer, con->window->id);
228 if (con->type != CT_DOCKAREA || !inplace_restart) {
229 TAILQ_FOREACH(node, &(con->nodes_head), nodes) {
230 dump_node(gen, node, inplace_restart);
235 ystr("floating_nodes");
237 TAILQ_FOREACH(node, &(con->floating_head), floating_windows) {
238 dump_node(gen, node, inplace_restart);
244 TAILQ_FOREACH(node, &(con->focus_head), nodes) {
245 y(integer, (long int)node);
249 ystr("fullscreen_mode");
250 y(integer, con->fullscreen_mode);
255 TAILQ_FOREACH(match, &(con->swallow_head), matches) {
256 if (match->dock != -1) {
259 y(integer, match->dock);
260 ystr("insert_where");
261 y(integer, match->insert_where);
265 /* TODO: the other swallow keys */
268 if (inplace_restart) {
269 if (con->window != NULL) {
272 y(integer, con->window->id);
282 setlocale(LC_NUMERIC, "C");
283 yajl_gen gen = yajl_gen_alloc(NULL, NULL);
284 dump_node(gen, croot, false);
285 setlocale(LC_NUMERIC, "");
287 const unsigned char *payload;
289 y(get_buf, &payload, &length);
291 ipc_send_message(fd, payload, I3_IPC_REPLY_TYPE_TREE, length);
296 * Formats the reply message for a GET_WORKSPACES request and sends it to the
300 IPC_HANDLER(get_workspaces) {
301 yajl_gen gen = yajl_gen_alloc(NULL, NULL);
304 Con *focused_ws = con_get_workspace(focused);
307 TAILQ_FOREACH(output, &(croot->nodes_head), nodes) {
309 TAILQ_FOREACH(ws, &(output_get_content(output)->nodes_head), nodes) {
310 assert(ws->type == CT_WORKSPACE);
316 else y(integer, ws->num);
322 y(bool, workspace_is_visible(ws));
325 y(bool, ws == focused_ws);
330 y(integer, ws->rect.x);
332 y(integer, ws->rect.y);
334 y(integer, ws->rect.width);
336 y(integer, ws->rect.height);
351 const unsigned char *payload;
353 y(get_buf, &payload, &length);
355 ipc_send_message(fd, payload, I3_IPC_REPLY_TYPE_WORKSPACES, length);
360 * Formats the reply message for a GET_OUTPUTS request and sends it to the
364 IPC_HANDLER(get_outputs) {
365 yajl_gen gen = yajl_gen_alloc(NULL, NULL);
369 TAILQ_FOREACH(output, &outputs, outputs) {
376 y(bool, output->active);
381 y(integer, output->rect.x);
383 y(integer, output->rect.y);
385 y(integer, output->rect.width);
387 y(integer, output->rect.height);
390 ystr("current_workspace");
392 if (output->con && (ws = con_get_fullscreen_con(output->con)))
401 const unsigned char *payload;
403 y(get_buf, &payload, &length);
405 ipc_send_message(fd, payload, I3_IPC_REPLY_TYPE_OUTPUTS, length);
410 * Callback for the YAJL parser (will be called when a string is parsed).
413 static int add_subscription(void *extra, const unsigned char *s,
415 ipc_client *client = extra;
417 DLOG("should add subscription to extra %p, sub %.*s\n", client, len, s);
418 int event = client->num_events;
420 client->num_events++;
421 client->events = realloc(client->events, client->num_events * sizeof(char*));
422 /* We copy the string because it is not null-terminated and strndup()
423 * is missing on some BSD systems */
424 client->events[event] = scalloc(len+1);
425 memcpy(client->events[event], s, len);
427 DLOG("client is now subscribed to:\n");
428 for (int i = 0; i < client->num_events; i++)
429 DLOG("event %s\n", client->events[i]);
436 * Subscribes this connection to the event types which were given as a JSON
437 * serialized array in the payload field of the message.
440 IPC_HANDLER(subscribe) {
442 yajl_callbacks callbacks;
444 ipc_client *current, *client = NULL;
446 /* Search the ipc_client structure for this connection */
447 TAILQ_FOREACH(current, &all_clients, clients) {
448 if (current->fd != fd)
455 if (client == NULL) {
456 ELOG("Could not find ipc_client data structure for fd %d\n", fd);
460 /* Setup the JSON parser */
461 memset(&callbacks, 0, sizeof(yajl_callbacks));
462 callbacks.yajl_string = add_subscription;
464 p = yajl_alloc(&callbacks, NULL, NULL, (void*)client);
465 stat = yajl_parse(p, (const unsigned char*)message, message_size);
466 if (stat != yajl_status_ok) {
468 err = yajl_get_error(p, true, (const unsigned char*)message,
470 ELOG("YAJL parse error: %s\n", err);
471 yajl_free_error(p, err);
473 const char *reply = "{\"success\":false}";
474 ipc_send_message(fd, (const unsigned char*)reply,
475 I3_IPC_REPLY_TYPE_SUBSCRIBE, strlen(reply));
480 const char *reply = "{\"success\":true}";
481 ipc_send_message(fd, (const unsigned char*)reply,
482 I3_IPC_REPLY_TYPE_SUBSCRIBE, strlen(reply));
485 /* The index of each callback function corresponds to the numeric
486 * value of the message type (see include/i3/ipc.h) */
487 handler_t handlers[5] = {
489 handle_get_workspaces,
496 * Handler for activity on a client connection, receives a message from a
499 * For now, the maximum message size is 2048. I’m not sure for what the
500 * IPC interface will be used in the future, thus I’m not implementing a
501 * mechanism for arbitrarily long messages, as it seems like overkill
505 static void ipc_receive_message(EV_P_ struct ev_io *w, int revents) {
507 int n = read(w->fd, buf, sizeof(buf));
509 /* On error or an empty message, we close the connection */
512 /* FIXME: I get these when closing a client socket,
513 * therefore we just treat them as an error. Is this
515 if (errno == EAGAIN || errno == EWOULDBLOCK)
519 /* If not, there was some kind of error. We don’t bother
520 * and close the connection */
523 /* Delete the client from the list of clients */
525 TAILQ_FOREACH(current, &all_clients, clients) {
526 if (current->fd != w->fd)
529 for (int i = 0; i < current->num_events; i++)
530 free(current->events[i]);
531 /* We can call TAILQ_REMOVE because we break out of the
532 * TAILQ_FOREACH afterwards */
533 TAILQ_REMOVE(&all_clients, current, clients);
539 DLOG("IPC: client disconnected\n");
543 /* Terminate the message correctly */
546 /* Check if the message starts with the i3 IPC magic code */
547 if (n < strlen(I3_IPC_MAGIC)) {
548 DLOG("IPC: message too short, ignoring\n");
552 if (strncmp(buf, I3_IPC_MAGIC, strlen(I3_IPC_MAGIC)) != 0) {
553 DLOG("IPC: message does not start with the IPC magic\n");
557 uint8_t *message = (uint8_t*)buf;
559 DLOG("IPC: n = %d\n", n);
560 message += strlen(I3_IPC_MAGIC);
561 n -= strlen(I3_IPC_MAGIC);
563 /* The next 32 bit after the magic are the message size */
564 uint32_t message_size = *((uint32_t*)message);
565 message += sizeof(uint32_t);
566 n -= sizeof(uint32_t);
568 if (message_size > n) {
569 DLOG("IPC: Either the message size was wrong or the message was not read completely, dropping\n");
573 /* The last 32 bits of the header are the message type */
574 uint32_t message_type = *((uint32_t*)message);
575 message += sizeof(uint32_t);
576 n -= sizeof(uint32_t);
578 if (message_type >= (sizeof(handlers) / sizeof(handler_t)))
579 DLOG("Unhandled message type: %d\n", message_type);
581 handler_t h = handlers[message_type];
582 h(w->fd, message, n, message_size, message_type);
585 message += message_size;
590 * Handler for activity on the listening socket, meaning that a new client
591 * has just connected and we should accept() him. Sets up the event handler
592 * for activity on the new connection and inserts the file descriptor into
593 * the list of clients.
596 void ipc_new_client(EV_P_ struct ev_io *w, int revents) {
597 struct sockaddr_un peer;
598 socklen_t len = sizeof(struct sockaddr_un);
600 if ((client = accept(w->fd, (struct sockaddr*)&peer, &len)) < 0) {
603 else perror("accept()");
607 set_nonblock(client);
609 struct ev_io *package = scalloc(sizeof(struct ev_io));
610 ev_io_init(package, ipc_receive_message, client, EV_READ);
611 ev_io_start(EV_A_ package);
613 DLOG("IPC: new client connected\n");
615 ipc_client *new = scalloc(sizeof(ipc_client));
618 TAILQ_INSERT_TAIL(&all_clients, new, clients);
622 * Creates the UNIX domain socket at the given path, sets it to non-blocking
623 * mode, bind()s and listen()s on it.
626 int ipc_create_socket(const char *filename) {
629 char *resolved = resolve_tilde(filename);
630 DLOG("Creating IPC-socket at %s\n", resolved);
631 char *copy = sstrdup(resolved);
632 const char *dir = dirname(copy);
633 if (!path_exists(dir))
637 /* Unlink the unix domain socket before */
640 if ((sockfd = socket(AF_LOCAL, SOCK_STREAM, 0)) < 0) {
646 (void)fcntl(sockfd, F_SETFD, FD_CLOEXEC);
648 struct sockaddr_un addr;
649 memset(&addr, 0, sizeof(struct sockaddr_un));
650 addr.sun_family = AF_LOCAL;
651 strncpy(addr.sun_path, resolved, sizeof(addr.sun_path) - 1);
652 if (bind(sockfd, (struct sockaddr*)&addr, sizeof(struct sockaddr_un)) < 0) {
659 set_nonblock(sockfd);
661 if (listen(sockfd, 5) < 0) {