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>
17 #include <yajl/yajl_gen.h>
18 #include <yajl/yajl_parse.h>
22 /* Shorter names for all those yajl_gen_* functions */
23 #define y(x, ...) yajl_gen_ ## x (gen, ##__VA_ARGS__)
24 #define ystr(str) yajl_gen_string(gen, (unsigned char*)str, strlen(str))
26 TAILQ_HEAD(ipc_client_head, ipc_client) all_clients = TAILQ_HEAD_INITIALIZER(all_clients);
29 * Puts the given socket file descriptor into non-blocking mode or dies if
30 * setting O_NONBLOCK failed. Non-blocking sockets are a good idea for our
31 * IPC model because we should by no means block the window manager.
34 static void set_nonblock(int sockfd) {
35 int flags = fcntl(sockfd, F_GETFL, 0);
37 if (fcntl(sockfd, F_SETFL, flags) < 0)
38 err(-1, "Could not set O_NONBLOCK");
41 static void ipc_send_message(int fd, const unsigned char *payload,
42 int message_type, int message_size) {
43 int buffer_size = strlen("i3-ipc") + sizeof(uint32_t) +
44 sizeof(uint32_t) + message_size;
45 char msg[buffer_size];
48 strcpy(walk, "i3-ipc");
49 walk += strlen("i3-ipc");
50 memcpy(walk, &message_size, sizeof(uint32_t));
51 walk += sizeof(uint32_t);
52 memcpy(walk, &message_type, sizeof(uint32_t));
53 walk += sizeof(uint32_t);
54 memcpy(walk, payload, message_size);
57 int bytes_to_go = buffer_size;
58 while (sent_bytes < bytes_to_go) {
59 int n = write(fd, msg + sent_bytes, bytes_to_go);
61 DLOG("write() failed: %s\n", strerror(errno));
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, (const unsigned char*)payload,
90 message_type, strlen(payload));
95 * Calls shutdown() on each socket and closes it. This function to be called
96 * when exiting or restarting only!
101 TAILQ_FOREACH(current, &all_clients, clients) {
102 shutdown(current->fd, SHUT_RDWR);
108 * Executes the command and returns whether it could be successfully parsed
109 * or not (at the moment, always returns true).
112 IPC_HANDLER(command) {
113 /* To get a properly terminated buffer, we copy
114 * message_size bytes out of the buffer */
115 char *command = scalloc(message_size);
116 strncpy(command, (const char*)message, message_size);
117 parse_cmd((const char*)command);
121 /* For now, every command gets a positive acknowledge
122 * (will change with the new command parser) */
123 const char *reply = "{\"success\":true}";
124 ipc_send_message(fd, (const unsigned char*)reply,
125 I3_IPC_REPLY_TYPE_COMMAND, strlen(reply));
128 void dump_node(yajl_gen gen, struct Con *con, bool inplace_restart) {
131 y(integer, (long int)con);
134 y(integer, con->type);
137 y(integer, con->orientation);
140 y(integer, con->layout);
145 y(integer, con->rect.x);
147 y(integer, con->rect.y);
149 y(integer, con->rect.width);
151 y(integer, con->rect.height);
159 y(integer, con->window->id);
165 TAILQ_FOREACH(node, &(con->nodes_head), nodes) {
166 dump_node(gen, node, inplace_restart);
172 TAILQ_FOREACH(node, &(con->focus_head), nodes) {
173 y(integer, (long int)node);
177 ystr("fullscreen_mode");
178 y(integer, con->fullscreen_mode);
180 if (inplace_restart) {
181 if (con->window != NULL) {
186 y(integer, con->window->id);
197 yajl_gen gen = yajl_gen_alloc(NULL, NULL);
198 dump_node(gen, croot, false);
200 const unsigned char *payload;
202 y(get_buf, &payload, &length);
204 ipc_send_message(fd, payload, I3_IPC_REPLY_TYPE_TREE, length);
211 * Formats the reply message for a GET_WORKSPACES request and sends it to the
215 IPC_HANDLER(get_workspaces) {
218 Client *last_focused = SLIST_FIRST(&(c_ws->focus_stack));
219 if (last_focused == SLIST_END(&(c_ws->focus_stack)))
222 yajl_gen gen = yajl_gen_alloc(NULL, NULL);
225 TAILQ_FOREACH(ws, workspaces, workspaces) {
226 if (ws->output == NULL)
231 y(integer, ws->num + 1);
237 y(bool, ws->output->current_workspace == ws);
245 y(integer, ws->rect.x);
247 y(integer, ws->rect.y);
249 y(integer, ws->rect.width);
251 y(integer, ws->rect.height);
255 ystr(ws->output->name);
265 const unsigned char *payload;
267 y(get_buf, &payload, &length);
269 ipc_send_message(fd, payload, I3_IPC_REPLY_TYPE_WORKSPACES, length);
274 * Formats the reply message for a GET_OUTPUTS request and sends it to the
278 IPC_HANDLER(get_outputs) {
281 yajl_gen gen = yajl_gen_alloc(NULL, NULL);
284 TAILQ_FOREACH(output, &outputs, outputs) {
291 y(bool, output->active);
296 y(integer, output->rect.x);
298 y(integer, output->rect.y);
300 y(integer, output->rect.width);
302 y(integer, output->rect.height);
305 ystr("current_workspace");
306 if (output->current_workspace == NULL)
308 else y(integer, output->current_workspace->num + 1);
315 const unsigned char *payload;
317 y(get_buf, &payload, &length);
319 ipc_send_message(fd, payload, I3_IPC_REPLY_TYPE_OUTPUTS, length);
324 * Callback for the YAJL parser (will be called when a string is parsed).
327 static int add_subscription(void *extra, const unsigned char *s,
329 ipc_client *client = extra;
331 DLOG("should add subscription to extra %p, sub %.*s\n", client, len, s);
332 int event = client->num_events;
334 client->num_events++;
335 client->events = realloc(client->events, client->num_events * sizeof(char*));
336 /* We copy the string because it is not null-terminated and strndup()
337 * is missing on some BSD systems */
338 client->events[event] = scalloc(len+1);
339 memcpy(client->events[event], s, len);
341 DLOG("client is now subscribed to:\n");
342 for (int i = 0; i < client->num_events; i++)
343 DLOG("event %s\n", client->events[i]);
350 * Subscribes this connection to the event types which were given as a JSON
351 * serialized array in the payload field of the message.
354 IPC_HANDLER(subscribe) {
356 yajl_callbacks callbacks;
358 ipc_client *current, *client = NULL;
360 /* Search the ipc_client structure for this connection */
361 TAILQ_FOREACH(current, &all_clients, clients) {
362 if (current->fd != fd)
369 if (client == NULL) {
370 ELOG("Could not find ipc_client data structure for fd %d\n", fd);
374 /* Setup the JSON parser */
375 memset(&callbacks, 0, sizeof(yajl_callbacks));
376 callbacks.yajl_string = add_subscription;
378 p = yajl_alloc(&callbacks, NULL, NULL, (void*)client);
379 stat = yajl_parse(p, (const unsigned char*)message, message_size);
380 if (stat != yajl_status_ok) {
382 err = yajl_get_error(p, true, (const unsigned char*)message,
384 ELOG("YAJL parse error: %s\n", err);
385 yajl_free_error(p, err);
387 const char *reply = "{\"success\":false}";
388 ipc_send_message(fd, (const unsigned char*)reply,
389 I3_IPC_REPLY_TYPE_SUBSCRIBE, strlen(reply));
394 const char *reply = "{\"success\":true}";
395 ipc_send_message(fd, (const unsigned char*)reply,
396 I3_IPC_REPLY_TYPE_SUBSCRIBE, strlen(reply));
400 /* The index of each callback function corresponds to the numeric
401 * value of the message type (see include/i3/ipc.h) */
402 handler_t handlers[2] = {
408 * Handler for activity on a client connection, receives a message from a
411 * For now, the maximum message size is 2048. I’m not sure for what the
412 * IPC interface will be used in the future, thus I’m not implementing a
413 * mechanism for arbitrarily long messages, as it seems like overkill
417 static void ipc_receive_message(EV_P_ struct ev_io *w, int revents) {
419 int n = read(w->fd, buf, sizeof(buf));
421 /* On error or an empty message, we close the connection */
424 /* FIXME: I get these when closing a client socket,
425 * therefore we just treat them as an error. Is this
427 if (errno == EAGAIN || errno == EWOULDBLOCK)
431 /* If not, there was some kind of error. We don’t bother
432 * and close the connection */
435 /* Delete the client from the list of clients */
437 TAILQ_FOREACH(current, &all_clients, clients) {
438 if (current->fd != w->fd)
441 for (int i = 0; i < current->num_events; i++)
442 free(current->events[i]);
443 /* We can call TAILQ_REMOVE because we break out of the
444 * TAILQ_FOREACH afterwards */
445 TAILQ_REMOVE(&all_clients, current, clients);
451 DLOG("IPC: client disconnected\n");
455 /* Terminate the message correctly */
458 /* Check if the message starts with the i3 IPC magic code */
459 if (n < strlen(I3_IPC_MAGIC)) {
460 DLOG("IPC: message too short, ignoring\n");
464 if (strncmp(buf, I3_IPC_MAGIC, strlen(I3_IPC_MAGIC)) != 0) {
465 DLOG("IPC: message does not start with the IPC magic\n");
469 uint8_t *message = (uint8_t*)buf;
471 DLOG("IPC: n = %d\n", n);
472 message += strlen(I3_IPC_MAGIC);
473 n -= strlen(I3_IPC_MAGIC);
475 /* The next 32 bit after the magic are the message size */
476 uint32_t message_size = *((uint32_t*)message);
477 message += sizeof(uint32_t);
478 n -= sizeof(uint32_t);
480 if (message_size > n) {
481 DLOG("IPC: Either the message size was wrong or the message was not read completely, dropping\n");
485 /* The last 32 bits of the header are the message type */
486 uint32_t message_type = *((uint32_t*)message);
487 message += sizeof(uint32_t);
488 n -= sizeof(uint32_t);
490 if (message_type >= (sizeof(handlers) / sizeof(handler_t)))
491 DLOG("Unhandled message type: %d\n", message_type);
493 handler_t h = handlers[message_type];
494 h(w->fd, message, n, message_size, message_type);
497 message += message_size;
502 * Handler for activity on the listening socket, meaning that a new client
503 * has just connected and we should accept() him. Sets up the event handler
504 * for activity on the new connection and inserts the file descriptor into
505 * the list of clients.
508 void ipc_new_client(EV_P_ struct ev_io *w, int revents) {
509 struct sockaddr_un peer;
510 socklen_t len = sizeof(struct sockaddr_un);
512 if ((client = accept(w->fd, (struct sockaddr*)&peer, &len)) < 0) {
515 else perror("accept()");
519 set_nonblock(client);
521 struct ev_io *package = scalloc(sizeof(struct ev_io));
522 ev_io_init(package, ipc_receive_message, client, EV_READ);
523 ev_io_start(EV_A_ package);
525 DLOG("IPC: new client connected\n");
527 ipc_client *new = scalloc(sizeof(ipc_client));
530 TAILQ_INSERT_TAIL(&all_clients, new, clients);
534 * Creates the UNIX domain socket at the given path, sets it to non-blocking
535 * mode, bind()s and listen()s on it.
538 int ipc_create_socket(const char *filename) {
541 /* Unlink the unix domain socket before */
544 if ((sockfd = socket(AF_LOCAL, SOCK_STREAM, 0)) < 0) {
549 (void)fcntl(sockfd, F_SETFD, FD_CLOEXEC);
551 struct sockaddr_un addr;
552 memset(&addr, 0, sizeof(struct sockaddr_un));
553 addr.sun_family = AF_LOCAL;
554 strcpy(addr.sun_path, filename);
555 if (bind(sockfd, (struct sockaddr*)&addr, sizeof(struct sockaddr_un)) < 0) {
560 set_nonblock(sockfd);
562 if (listen(sockfd, 5) < 0) {