libratbag-plus/ratbagd/ratbagd.c

/***
  This file is part of ratbagd.

  Copyright 2015 David Herrmann <dh.herrmann@gmail.com>

  Permission is hereby granted, free of charge, to any person obtaining a
  copy of this software and associated documentation files (the "Software"),
  to deal in the Software without restriction, including without limitation
  the rights to use, copy, modify, merge, publish, distribute, sublicense,
  and/or sell copies of the Software, and to permit persons to whom the
  Software is furnished to do so, subject to the following conditions:

  The above copyright notice and this permission notice (including the next
  paragraph) shall be included in all copies or substantial portions of the
  Software.

  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  DEALINGS IN THE SOFTWARE.
***/

#include "config.h"

#include <linux/input-event-codes.h>

#include <assert.h>
#include <errno.h>
#include <libratbag.h>
#include <libudev.h>
#include <stdio.h>
#include <stdlib.h>
#include <sys/resource.h>
#include <systemd/sd-bus.h>
#include <systemd/sd-event.h>
#include "ratbagd.h"
#include "shared-macro.h"
#include "libratbag-util.h"

#include "ratbagd-test.h"

enum log_level {
	LL_QUIET = 1,
	LL_INFO,
	LL_VERBOSE,
	LL_RAW,
} log_level = LL_INFO;

void log_info(const char *fmt, ...)
{
	va_list args;

	va_start(args, fmt);
	if (log_level >= LL_INFO)
		vprintf(fmt, args);
	va_end(args);
}

void log_verbose(const char *fmt, ...)
{
	va_list args;

	va_start(args, fmt);

	if (log_level >= LL_VERBOSE)
		vprintf(fmt, args);
	va_end(args);
}

void log_error(const char *fmt, ...)
{
	va_list args;

	va_start(args, fmt);
	fprintf(stderr, "%s error: ", program_invocation_short_name);
	vfprintf(stderr, fmt, args);
	va_end(args);
}

static int ratbagd_find_device(sd_bus *bus,
			       const char *path,
			       const char *interface,
			       void *userdata,
			       void **found,
			       sd_bus_error *error)
{
	_cleanup_(freep) char *name = NULL;
	struct ratbagd *ctx = userdata;
	struct ratbagd_device *device;
	int r;

	r = sd_bus_path_decode_many(path,
				    RATBAGD_OBJ_ROOT "/device/%",
				    &name);
	if (r <= 0)
		return r;

	device = ratbagd_device_lookup(ctx, name);
	if (!device)
		return 0;

	*found = device;
	return 1;
}

static int ratbagd_list_devices(sd_bus *bus,
				const char *path,
				void *userdata,
				char ***paths,
				sd_bus_error *error)
{
	struct ratbagd *ctx = userdata;
	struct ratbagd_device *device;
	char **devices, **pos;

	devices = calloc(ctx->n_devices + 1, sizeof(char *));
	if (!devices)
		return -ENOMEM;

	pos = devices;

	RATBAGD_DEVICE_FOREACH(device, ctx) {
		*pos = strdup(ratbagd_device_get_path(device));
		if (!*pos)
			goto error;
		++pos;
	}

	*pos = NULL;
	*paths = devices;
	return 1;

error:
	for (pos = devices; *pos; ++pos)
		free(*pos);
	free(devices);
	return -ENOMEM;
}

static int ratbagd_get_devices(sd_bus *bus,
			       const char *path,
			       const char *interface,
			       const char *property,
			       sd_bus_message *reply,
			       void *userdata,
			       sd_bus_error *error)
{
	struct ratbagd *ctx = userdata;
	struct ratbagd_device *device;

	CHECK_CALL(sd_bus_message_open_container(reply, 'a', "o"));

	RATBAGD_DEVICE_FOREACH(device, ctx) {
		CHECK_CALL(sd_bus_message_append(reply,
						 "o",
						 ratbagd_device_get_path(device)));
	}

	CHECK_CALL(sd_bus_message_close_container(reply));

	return 0;
}

static const sd_bus_vtable ratbagd_vtable[] = {
	SD_BUS_VTABLE_START(0),
	SD_BUS_PROPERTY("Devices", "ao", ratbagd_get_devices, 0, SD_BUS_VTABLE_PROPERTY_EMITS_CHANGE),
#ifdef RATBAG_DEVELOPER_EDITION
	SD_BUS_METHOD("ResetTestDevice", "", "u", ratbagd_reset_test_device, SD_BUS_VTABLE_UNPRIVILEGED),
#endif /* RATBAG_DEVELOPER_EDITION */
	SD_BUS_VTABLE_END,
};

/* 32 pre-picked names. If you have more than 32 devices connected and need
 * ratbag to control them all, congratulations, you are official a niche
 * use-case.
 */
static const char *device_ids[] = {
"mara", "capybara", "porcupine", "paca",
"vole", "woodrat", "gerbil", "shrew",
"hare", "beaver", "gopher", "chinchilla",
"mouse", "rat", "rabbit", "guineapig",
"hutia", "degu", "gundi", "acouchy",
"nutria", "tuco-tuco", "paca", "hamster",
"zokor", "chipmunk", "squirrel", "marmot",
"groundhog", "suslik", "agouti", "blesmol",
};

/* bitmask telling us which ones of the above are free. */
static uint32_t device_ids_free = (1UL << ARRAY_LENGTH(device_ids)) - 1;

static inline const char *
pick_device_id(const char *sysname)
{
	int index;

	/* search for the first number in the sysname and where we find it,
	 * use that as lookup index. This way we get some sort of
	 * consistency, hidraw2 is always "rat", etc.
	 * Totally not necessary but we might as well have some fun here.
	 * Where this fails or picks an id already chosen, we fall back to
	 * "choose the first one free".
	 */
	if (sscanf(sysname, "%*[^0-9]%d", &index) == 1 &&
	    index >= 0 && (unsigned)index < sizeof(device_ids_free) * 8 &&
	    !!(device_ids_free & (1 << index)))
	    goto assign;

	index = ffs(device_ids_free);

	/* This can only happen if you have >32 devices, so let's not worry
	 * about this too much */
	if (index == 0)
		return sysname;

	index -= 1; /* ffs is 1-based */

assign:
	device_ids_free &= ~(1 << index);

	return device_ids[index];
}

static inline void
release_device_id(const char *id)
{
	for (size_t i = 0; i < ARRAY_LENGTH(device_ids); i++) {
		if (streq(id, device_ids[i])) {
			device_ids_free |= (1 << i);
			break;
		}
	}
}

static void ratbagd_process_device(struct ratbagd *ctx,
				   struct udev_device *udevice)
{
	struct ratbag_device *lib_device;
	struct ratbagd_device *device;
	const char *sysname;
	int r;

	/*
	 * TODO: libratbag should provide some mechanism to allow
	 *       device-grouping, just like libinput does. If multiple input
	 *       devices belong to the same virtual device, we should not add
	 *       it multiple times. Instead, libratbag should group them and
	 *       provide *us* a unique sysname that identifies the group, rather
	 *       than taking a random input-device as tag.
	 */

	sysname = udev_device_get_sysname(udevice);
	if (!sysname || !startswith(sysname, "hidraw"))
		return;

	device = ratbagd_device_lookup(ctx, sysname);

	if (streq_ptr("remove", udev_device_get_action(udevice))) {
		/* device was removed, unlink it and destroy our context */
		if (device) {
			release_device_id(ratbagd_device_get_id(device));
			ratbagd_device_unlink(device);
			ratbagd_device_free(device);


			(void) sd_bus_emit_properties_changed(ctx->bus,
							      RATBAGD_OBJ_ROOT,
							      RATBAGD_NAME_ROOT ".Manager",
							      "Devices",
							      NULL);
		}
	} else if (device) {
		/* device already known, refresh our view of the device */
	} else {
		const char *id;
		enum ratbag_error_code error;

		/* device unknown, create new one and link it */
		error = ratbag_device_new_from_udev_device(ctx->lib_ctx,
							   udevice,
							   &lib_device);
		if (error != RATBAG_SUCCESS)
			return; /* unsupported device */

		id = pick_device_id(sysname);
		r = ratbagd_device_new(&device, ctx, sysname, id, lib_device);

		/* the ratbagd_device takes its own reference, drop ours */
		ratbag_device_unref(lib_device);

		if (r < 0) {
			log_error("%s: cannot track device\n", sysname);
			return;
		}

		ratbagd_device_link(device);
		(void) sd_bus_emit_properties_changed(ctx->bus,
						      RATBAGD_OBJ_ROOT,
						      RATBAGD_NAME_ROOT ".Manager",
						      "Devices",
						      NULL);
	}
}

static int ratbagd_monitor_event(sd_event_source *source,
				 int fd,
				 uint32_t mask,
				 void *userdata)
{
	struct ratbagd *ctx = userdata;
	struct udev_device *udevice;

	udevice = udev_monitor_receive_device(ctx->monitor);
	if (!udevice)
		return 0;

	ratbagd_process_device(ctx, udevice);
	udev_device_unref(udevice);

	return 0;
}

static int ratbagd_lib_open_restricted(const char *path,
				       int flags,
				       void *userdata)
{
	return open(path, flags, 0);
}

static void ratbagd_lib_close_restricted(int fd, void *userdata)
{
	safe_close(fd);
}

static const struct ratbag_interface ratbagd_lib_interface = {
	.open_restricted	= ratbagd_lib_open_restricted,
	.close_restricted	= ratbagd_lib_close_restricted,
};

static struct ratbagd *ratbagd_free(struct ratbagd *ctx)
{
	struct ratbagd_device *device, *tmp;

	if (!ctx)
		return NULL;

	RATBAGD_DEVICE_FOREACH_SAFE(device, tmp, ctx) {
		ratbagd_device_unlink(device);
		ratbagd_device_free(device);
	}

	ctx->bus = sd_bus_flush_close_unref(ctx->bus);
	ctx->monitor_source = sd_event_source_unref(ctx->monitor_source);
	ctx->monitor = udev_monitor_unref(ctx->monitor);
	ctx->lib_ctx = ratbag_unref(ctx->lib_ctx);
	ctx->event = sd_event_unref(ctx->event);

	assert(!ctx->device_map.root);
	assert(!ctx->lib_ctx); /* ratbag returns non-NULL if still pinned */

	return mfree(ctx);
}

DEFINE_TRIVIAL_CLEANUP_FUNC(struct ratbagd *, ratbagd_free);

static int ratbagd_init_monitor(struct ratbagd *ctx)
{
	struct udev *udev;
	int r;

	udev = udev_new();
	if (!udev)
		return -ENOMEM;

	ctx->monitor = udev_monitor_new_from_netlink(udev, "udev");

	/* we don't need the context to stay around; drop it */
	udev_unref(udev);

	if (!ctx->monitor)
		return -ENOMEM;

	r = udev_monitor_filter_add_match_subsystem_devtype(ctx->monitor,
							    "hidraw",
							    NULL);
	if (r < 0)
		return r;

	r = udev_monitor_enable_receiving(ctx->monitor);
	if (r < 0)
		return r;

	r = sd_event_add_io(ctx->event,
			    &ctx->monitor_source,
			    udev_monitor_get_fd(ctx->monitor),
			    EPOLLIN,
			    ratbagd_monitor_event,
			    ctx);
	if (r < 0)
		return r;

	return 0;
}

static int ratbagd_new(struct ratbagd **out)
{
	_cleanup_(ratbagd_freep) struct ratbagd *ctx = NULL;
	int r;

	ctx = zalloc(sizeof(*ctx));

	r = sd_event_default(&ctx->event);
	if (r < 0)
		return r;

	r = sd_event_set_watchdog(ctx->event, true);
	if (r < 0)
		return r;

	ctx->lib_ctx = ratbag_create_context(&ratbagd_lib_interface, ctx);
	if (!ctx->lib_ctx)
		return -ENOMEM;

	if (log_level >= LL_RAW)
		ratbag_log_set_priority(ctx->lib_ctx,
					RATBAG_LOG_PRIORITY_RAW);
	else if (log_level >= LL_VERBOSE)
		ratbag_log_set_priority(ctx->lib_ctx,
					RATBAG_LOG_PRIORITY_DEBUG);

	r = ratbagd_init_monitor(ctx);
	if (r < 0)
		return r;

	r = sd_bus_open_system(&ctx->bus);
	if (r < 0)
		return r;

	r = sd_bus_add_object_vtable(ctx->bus,
				     NULL,
				     RATBAGD_OBJ_ROOT,
				     RATBAGD_NAME_ROOT ".Manager",
				     ratbagd_vtable,
				     ctx);
	if (r < 0)
		return r;

	r = sd_bus_add_fallback_vtable(ctx->bus,
				       NULL,
				       RATBAGD_OBJ_ROOT "/device",
				       RATBAGD_NAME_ROOT ".Device",
				       ratbagd_device_vtable,
				       ratbagd_find_device,
				       ctx);
	if (r < 0)
		return r;

	r = sd_bus_add_node_enumerator(ctx->bus,
				       NULL,
				       RATBAGD_OBJ_ROOT "/device",
				       ratbagd_list_devices,
				       ctx);
	if (r < 0)
		return r;

	r = sd_bus_request_name(ctx->bus, RATBAGD_NAME_ROOT, 0);
	if (r < 0)
		return r;

	r = sd_bus_attach_event(ctx->bus, ctx->event, 0);
	if (r < 0)
		return r;

	*out = ctx;
	ctx = NULL;
	return 0;
}

static int ratbagd_run_enumerate(struct ratbagd *ctx)
{
	struct udev_list_entry *list, *iter;
	struct udev_enumerate *e;
	struct udev *udev;
	int r;

	udev = udev_monitor_get_udev(ctx->monitor);

	e = udev_enumerate_new(udev);
	if (!e)
		return -ENOMEM;

	r = udev_enumerate_add_match_subsystem(e, "hidraw");
	if (r < 0)
		goto exit;

	r = udev_enumerate_add_match_is_initialized(e);
	if (r < 0)
		goto exit;

	r = udev_enumerate_scan_devices(e);
	if (r < 0)
		goto exit;

	list = udev_enumerate_get_list_entry(e);
	udev_list_entry_foreach(iter, list) {
		struct udev_device *udevice;
		const char *p;

		p = udev_list_entry_get_name(iter);
		udevice = udev_device_new_from_syspath(udev, p);
		if (udevice)
			ratbagd_process_device(ctx, udevice);
		udev_device_unref(udevice);
	}

	r = 0;

exit:
	udev_enumerate_unref(e);
	return r;
}

static int on_timeout_cb(sd_event_source *s, uint64_t usec, void *userdata)
{
	log_info("Exiting after idle\n");
	sd_event_exit(sd_event_source_get_event(s), 0);
	return 0;
}

static int before_idle_cb(sd_event_source *s, void *userdata)
{
	struct ratbagd *ctx = userdata;
	uint64_t usec;

	sd_event_now(sd_event_source_get_event(s), CLOCK_MONOTONIC, &usec);
#define min2us(us_) (us_ * 1000000 * 60)
	usec += min2us(20);
	sd_event_source_set_time(ctx->timeout_source, usec);

	return 0;
}

static int sighandler(sd_event_source *source,
		      const struct signalfd_siginfo *si,
		      void *userdata)
{
	sd_event *event = sd_event_source_get_event(source);
	sd_event_exit(event, 0);
	return 0;
}

static int ratbagd_run(struct ratbagd *ctx)
{
	int r;

	r = ratbagd_run_enumerate(ctx);
	if (r < 0)
		return r;

	sigset_t sigset;
	sigemptyset(&sigset);
	sigaddset(&sigset, SIGINT);
	sigprocmask(SIG_BLOCK, &sigset, NULL);
	sd_event_add_signal(ctx->event, NULL, SIGINT, sighandler, NULL);

	/* exit-on-idle: we set up a timer to simply exit. Since we don't
	 * store anything, it doesn't matter and we can just restart next
	 * time someone wants us.
	 *
	 * since we don't want to monitor every single dbus call, we just
	 * set up a post source that gets called before we go idle. That
	 * resets the timer, so as long as something is happening, ratbagd
	 * won't exit.
	 */
	sd_event_add_time(ctx->event,
			  &ctx->timeout_source,
			  CLOCK_MONOTONIC,
			  -1, /* infinite, see before_idle_cb */
			  min2us(1), /* accuracy doesn't matter */
			  on_timeout_cb,
			  ctx);
	sd_event_add_post(ctx->event, NULL, before_idle_cb, ctx);

	return sd_event_loop(ctx->event);
}

int main(int argc, char *argv[])
{
	struct ratbagd *ctx = NULL;
	int r;

#if DISABLE_COREDUMP
	const struct rlimit corelimit = { 0, 0 };

	setrlimit(RLIMIT_CORE, &corelimit);
#endif

	if (argc > 1) {
		if (streq(argv[1], "--version")) {
			printf("%s\n", RATBAG_VERSION);
			return 0;
		} else if (streq(argv[1], "--quiet")) {
			log_level = LL_QUIET;
		} else if (streq(argv[1], "--verbose=raw")) {
			log_level = LL_RAW;
		} else if (streq(argv[1], "--verbose")) {
			log_level = LL_VERBOSE;
		} else {
			fprintf(stderr, "Usage: %s [--version | --quiet | --verbose[=raw]]\n",
				program_invocation_short_name);
			r = -EINVAL;
			goto exit;
		}
	}

	r = ratbagd_new(&ctx);
	if (r < 0)
		goto exit;

	ratbagd_init_test_device(ctx);

	r = ratbagd_run(ctx);

exit:
	ratbagd_free(ctx);

	if (r < 0) {
		if (r == -EEXIST) {
			log_error("Bus name is taken, another instance of ratbagd is already running.\n");
		} else {
			errno = -r;
			log_error("Failed to start ratbagd: %m\n");
		}
		return EXIT_FAILURE;
	}

	return EXIT_SUCCESS;
}

struct ratbagd_callback
{
	ratbagd_callback_t callback;
	void *userdata;
};

static int ratbagd_callback_handler(sd_event_source *s, void *userdata)
{
	struct ratbagd_callback *cb = userdata;

	cb->callback(cb->userdata);

	sd_event_source_set_enabled(s, SD_EVENT_OFF);
	sd_event_source_unref(s);
	free(cb);

	return 0;
}

void ratbagd_schedule_task(struct ratbagd *ctx,
			   ratbagd_callback_t callback,
			   void *userdata)
{
	struct ratbagd_callback *cb = zalloc(sizeof *cb);
	sd_event_source *source;

	cb->callback = callback;
	cb->userdata = userdata;

	sd_event_add_post(ctx->event, &source, ratbagd_callback_handler, cb);
}