Merge pull request #75 from minus7/ipc

i3 IPC

include/ipc.h

@@ -0,0 +1,18 @@
+#ifndef _SWAY_IPC_H
+#define _SWAY_IPC_H
+
+enum ipc_command_type {
+	IPC_COMMAND        = 0,
+	IPC_GET_WORKSPACES = 1,
+	IPC_SUBSCRIBE      = 2,
+	IPC_GET_OUTPUTS    = 3,
+	IPC_GET_TREE       = 4,
+	IPC_GET_MARKS      = 5,
+	IPC_GET_BAR_CONFIG = 6,
+	IPC_GET_VERSION    = 7,
+};
+
+void ipc_init(void);
+void ipc_terminate(void);
+
+#endif

include/log.h

@@ -13,6 +13,7 @@ typedef enum {
 void init_log(int verbosity);
 void sway_log_colors(int mode);
 void sway_log(int verbosity, const char* format, ...) __attribute__((format(printf,2,3)));
+void sway_log_errno(int verbosity, char* format, ...) __attribute__((format(printf,2,3)));
 void sway_abort(const char* format, ...) __attribute__((format(printf,1,2)));
 bool sway_assert(bool condition, const char* format, ...) __attribute__((format(printf,2,3)));
 

include/sway.h

@@ -0,0 +1,6 @@
+#ifndef _SWAY_SWAY_H
+#define _SWAY_SWAY_H
+
+void sway_terminate(void);
+
+#endif

sway/commands.c

@@ -15,6 +15,7 @@
 #include "commands.h"
 #include "container.h"
 #include "handlers.h"
+#include "sway.h"
 
 struct modifier_key {
 	char *name;
@@ -186,7 +187,7 @@ static bool cmd_exit(struct sway_config *config, int argc, char **argv) {
 	}
 	// Close all views
 	container_map(&root_container, kill_views, NULL);
-	exit(0);
+	sway_terminate();
 	return true;
 }
 

sway/ipc.c

@@ -0,0 +1,229 @@
+// See https://i3wm.org/docs/ipc.html for protocol information
+
+#include <errno.h>
+#include <string.h>
+#include <sys/socket.h>
+#include <sys/un.h>
+#include <stdbool.h>
+#include <wlc/wlc.h>
+#include <unistd.h>
+#include <stdlib.h>
+#include <stropts.h>
+#include <sys/ioctl.h>
+#include <fcntl.h>
+#include "ipc.h"
+#include "log.h"
+#include "config.h"
+#include "commands.h"
+
+static int ipc_socket = -1;
+static struct wlc_event_source *ipc_event_source =  NULL;
+static struct sockaddr_un ipc_sockaddr = {
+	.sun_family = AF_UNIX,
+	.sun_path = "/tmp/sway-ipc.sock"
+};
+
+static const char ipc_magic[] = {'i', '3', '-', 'i', 'p', 'c'};
+
+struct ipc_client {
+	struct wlc_event_source *event_source;
+	int fd;
+	uint32_t payload_length;
+	enum ipc_command_type current_command;
+};
+
+int ipc_handle_connection(int fd, uint32_t mask, void *data);
+int ipc_client_handle_readable(int client_fd, uint32_t mask, void *data);
+void ipc_client_disconnect(struct ipc_client *client);
+void ipc_client_handle_command(struct ipc_client *client);
+bool ipc_send_reply(struct ipc_client *client, const char *payload, uint32_t payload_length);
+
+void ipc_init(void) {
+	ipc_socket = socket(AF_UNIX, SOCK_STREAM | SOCK_NONBLOCK | SOCK_CLOEXEC, 0);
+	if (ipc_socket == -1) {
+		sway_abort("Unable to create IPC socket");
+	}
+
+	if (getenv("SWAYSOCK") != NULL) {
+		strncpy(ipc_sockaddr.sun_path, getenv("SWAYSOCK"), sizeof(ipc_sockaddr.sun_path));
+	}
+
+	unlink(ipc_sockaddr.sun_path);
+	if (bind(ipc_socket, (struct sockaddr *)&ipc_sockaddr, sizeof(ipc_sockaddr)) == -1) {
+		sway_abort("Unable to bind IPC socket");
+	}
+
+	if (listen(ipc_socket, 3) == -1) {
+		sway_abort("Unable to listen on IPC socket");
+	}
+
+	// Set i3 IPC socket path so that i3-msg works out of the box
+	setenv("I3SOCK", ipc_sockaddr.sun_path, 1);
+
+	ipc_event_source = wlc_event_loop_add_fd(ipc_socket, WLC_EVENT_READABLE, ipc_handle_connection, NULL);
+}
+
+void ipc_terminate(void) {
+	if (ipc_event_source) {
+		wlc_event_source_remove(ipc_event_source);
+	}
+	close(ipc_socket);
+	unlink(ipc_sockaddr.sun_path);
+}
+
+int ipc_handle_connection(int fd, uint32_t mask, void *data) {
+	(void) fd; (void) data;
+	sway_log(L_DEBUG, "Event on IPC listening socket");
+	assert(mask == WLC_EVENT_READABLE);
+
+	int client_fd = accept(ipc_socket, NULL, NULL);
+	if (client_fd == -1) {
+		sway_log_errno(L_INFO, "Unable to accept IPC client connection");
+		return 0;
+	}
+
+	int flags;
+	if ((flags=fcntl(client_fd, F_GETFD)) == -1 || fcntl(client_fd, F_SETFD, flags|FD_CLOEXEC) == -1) {
+		sway_log_errno(L_INFO, "Unable to set CLOEXEC on IPC client socket");
+		return 0;
+	}
+
+	struct ipc_client* client = malloc(sizeof(struct ipc_client));
+	client->payload_length = 0;
+	client->fd = client_fd;
+	client->event_source = wlc_event_loop_add_fd(client_fd, WLC_EVENT_READABLE, ipc_client_handle_readable, client);
+
+	return 0;
+}
+
+static const int ipc_header_size = sizeof(ipc_magic)+8;
+
+int ipc_client_handle_readable(int client_fd, uint32_t mask, void *data) {
+	struct ipc_client *client = data;
+	sway_log(L_DEBUG, "Event on IPC client socket %d", client_fd);
+
+	if (mask & WLC_EVENT_ERROR) {
+		sway_log(L_INFO, "IPC Client socket error, removing client");
+		ipc_client_disconnect(client);
+		return 0;
+	}
+
+	if (mask & WLC_EVENT_HANGUP) {
+		ipc_client_disconnect(client);
+		return 0;
+	}
+
+	int read_available;
+	ioctl(client_fd, FIONREAD, &read_available);
+
+	// Wait for the rest of the command payload in case the header has already been read
+	if (client->payload_length > 0) {
+		if (read_available >= client->payload_length) {
+			ipc_client_handle_command(client);
+		}
+		else {
+			sway_log(L_DEBUG, "Too little data to read payload on IPC Client socket, waiting for more (%d < %d)", read_available, client->payload_length);
+		}
+		return 0;
+	}
+
+	if (read_available < ipc_header_size) {
+		sway_log(L_DEBUG, "Too little data to read header on IPC Client socket, waiting for more (%d < %d)", read_available, ipc_header_size);
+		return 0;
+	}
+
+	char buf[ipc_header_size];
+	ssize_t received = recv(client_fd, buf, ipc_header_size, 0);
+	if (received == -1) {
+		sway_log_errno(L_INFO, "Unable to receive header from IPC client");
+		ipc_client_disconnect(client);
+		return 0;
+	}
+
+	if (memcmp(buf, ipc_magic, sizeof(ipc_magic)) != 0) {
+		sway_log(L_DEBUG, "IPC header check failed");
+		ipc_client_disconnect(client);
+		return 0;
+	}
+
+	client->payload_length = *(uint32_t *)&buf[sizeof(ipc_magic)];
+	client->current_command = (enum ipc_command_type) *(uint32_t *)&buf[sizeof(ipc_magic)+4];
+
+	if (read_available - received >= client->payload_length) {
+		ipc_client_handle_command(client);
+	}
+
+	return 0;
+}
+
+void ipc_client_disconnect(struct ipc_client *client)
+{
+	if (!sway_assert(client != NULL, "client != NULL")) {
+		return;
+	}
+
+	sway_log(L_INFO, "IPC Client %d disconnected", client->fd);
+	wlc_event_source_remove(client->event_source);
+	close(client->fd);
+	free(client);
+}
+
+void ipc_client_handle_command(struct ipc_client *client) {
+	if (!sway_assert(client != NULL, "client != NULL")) {
+		return;
+	}
+
+	char buf[client->payload_length + 1];
+	if (client->payload_length > 0)
+	{
+		ssize_t received = recv(client->fd, buf, client->payload_length, 0);
+		if (received == -1)
+		{
+			sway_log_errno(L_INFO, "Unable to receive payload from IPC client");
+			ipc_client_disconnect(client);
+			return;
+		}
+	}
+
+	switch (client->current_command) {
+	case IPC_COMMAND:
+	{
+		buf[client->payload_length] = '\0';
+		bool success = handle_command(config, buf);
+		char reply[64];
+		int length = snprintf(reply, sizeof(reply), "{\"success\":%s}", success ? "true" : "false");
+		ipc_send_reply(client, reply, (uint32_t) length);
+		break;
+	}
+	default:
+		sway_log(L_INFO, "Unknown IPC command type %i", client->current_command);
+		ipc_client_disconnect(client);
+		break;
+	}
+
+	client->payload_length = 0;
+}
+
+bool ipc_send_reply(struct ipc_client *client, const char *payload, uint32_t payload_length) {
+	assert(payload);
+
+	char data[ipc_header_size];
+
+	memcpy(data, ipc_magic, sizeof(ipc_magic));
+	*(uint32_t *)&(data[sizeof(ipc_magic)]) = payload_length;
+	*(uint32_t *)&(data[sizeof(ipc_magic)+4]) = client->current_command;
+
+	if (write(client->fd, data, ipc_header_size) == -1) {
+		sway_log_errno(L_INFO, "Unable to send header to IPC client");
+		ipc_client_disconnect(client);
+		return false;
+	}
+
+	if (write(client->fd, payload, payload_length) == -1) {
+		sway_log_errno(L_INFO, "Unable to send payload to IPC client");
+		ipc_client_disconnect(client);
+		return false;
+	}
+
+	return true;
+}

sway/log.c

@@ -1,10 +1,13 @@
 #include "log.h"
+#include "sway.h"
 #include <stdarg.h>
 #include <stdio.h>
 #include <stdlib.h>
 #include <fcntl.h>
 #include <unistd.h>
 #include <signal.h>
+#include <errno.h>
+#include <string.h>
 
 int colored = 1;
 int v = 0;
@@ -40,7 +43,7 @@ void sway_abort(const char *format, ...) {
 	vfprintf(stderr, format, args);
 	va_end(args);
 	fprintf(stderr, "\n");
-	exit(1);
+	sway_terminate();
 }
 
 void sway_log(int verbosity, const char* format, ...) {
@@ -66,6 +69,34 @@ void sway_log(int verbosity, const char* format, ...) {
 	}
 }
 
+void sway_log_errno(int verbosity, char* format, ...) {
+	if (verbosity <= v) {
+		int c = verbosity;
+		if (c > sizeof(verbosity_colors) / sizeof(char *)) {
+			c = sizeof(verbosity_colors) / sizeof(char *) - 1;
+		}
+
+		if (colored) {
+			fprintf(stderr, verbosity_colors[c]);
+		}
+
+		va_list args;
+		va_start(args, format);
+		vfprintf(stderr, format, args);
+		va_end(args);
+
+		fprintf(stderr, ": ");
+		char error[256];
+		strerror_r(errno, error, sizeof(error));
+		fprintf(stderr, error);
+
+		if (colored) {
+			fprintf(stderr, "\x1B[0m");
+		}
+		fprintf(stderr, "\n");
+	}
+}
+
 bool sway_assert(bool condition, const char* format, ...) {
 	if (condition) {
 		return true;

sway/main.c

@@ -9,6 +9,15 @@
 #include "config.h"
 #include "log.h"
 #include "handlers.h"
+#include "ipc.h"
+#include "sway.h"
+
+static bool terminate_request = false;
+
+void sway_terminate(void) {
+	terminate_request = true;
+	wlc_terminate();
+}
 
 static void sigchld_handle(int signal);
 
@@ -99,11 +108,18 @@ int main(int argc, char **argv) {
 		free(config_path);
 	}
 
+	ipc_init();
+
+	if (!terminate_request) {
 		wlc_run();
+	}
+
 	if (devnull) {
 		fclose(devnull);
 	}
 
+	ipc_terminate();
+
 	return 0;
 }