mirror of
				https://gitlab.freedesktop.org/wlroots/wlroots.git
				synced 2025-11-03 09:01:40 -05:00 
			
		
		
		
	[1] and [2] have introduced new wl_array usage in wlroots, but
contains a mistake: wl_array_for_each iterates over pointers to
the wl_array entries, not over entries themselves.
Fix all wl_array_for_each call sites. Name the variables "ptr"
to avoid confusion.
Found via ASan:
    ==148752==ERROR: AddressSanitizer: attempting free on address which was not malloc()-ed: 0x602000214111 in thread T0
        #0 0x7f6ff2235f19 in __interceptor_free /build/gcc/src/gcc/libsanitizer/asan/asan_malloc_linux.cpp:127
        #1 0x7f6ff1c04004 in wlr_tablet_destroy ../subprojects/wlroots/types/wlr_tablet_tool.c:24
        #2 0x7f6ff1b8463c in wlr_input_device_destroy ../subprojects/wlroots/types/wlr_input_device.c:51
        #3 0x7f6ff1ab9941 in backend_destroy ../subprojects/wlroots/backend/wayland/backend.c:306
        #4 0x7f6ff1a68323 in wlr_backend_destroy ../subprojects/wlroots/backend/backend.c:57
        #5 0x7f6ff1ab36b4 in multi_backend_destroy ../subprojects/wlroots/backend/multi/backend.c:57
        #6 0x7f6ff1ab417c in handle_display_destroy ../subprojects/wlroots/backend/multi/backend.c:124
        #7 0x7f6ff106184e in wl_display_destroy (/usr/lib/libwayland-server.so.0+0x884e)
        #8 0x55cd1a77c9e5 in server_fini ../sway/server.c:218
        #9 0x55cd1a77893f in main ../sway/main.c:400
        #10 0x7f6ff04bdb24 in __libc_start_main (/usr/lib/libc.so.6+0x27b24)
        #11 0x55cd1a73a7ad in _start (/home/simon/src/sway/build/sway/sway+0x33a7ad)
    0x602000214111 is located 1 bytes inside of 16-byte region [0x602000214110,0x602000214120)
    freed by thread T0 here:
        #0 0x7f6ff2235f19 in __interceptor_free /build/gcc/src/gcc/libsanitizer/asan/asan_malloc_linux.cpp:127
        #1 0x7f6ff1c04004 in wlr_tablet_destroy ../subprojects/wlroots/types/wlr_tablet_tool.c:24
        #2 0x7f6ff1b8463c in wlr_input_device_destroy ../subprojects/wlroots/types/wlr_input_device.c:51
        #3 0x7f6ff1ab9941 in backend_destroy ../subprojects/wlroots/backend/wayland/backend.c:306
        #4 0x7f6ff1a68323 in wlr_backend_destroy ../subprojects/wlroots/backend/backend.c:57
        #5 0x7f6ff1ab36b4 in multi_backend_destroy ../subprojects/wlroots/backend/multi/backend.c:57
        #6 0x7f6ff1ab417c in handle_display_destroy ../subprojects/wlroots/backend/multi/backend.c:124
        #7 0x7f6ff106184e in wl_display_destroy (/usr/lib/libwayland-server.so.0+0x884e)
    previously allocated by thread T0 here:
        #0 0x7f6ff2236279 in __interceptor_malloc /build/gcc/src/gcc/libsanitizer/asan/asan_malloc_linux.cpp:145
        #1 0x7f6ff1066d03 in wl_array_add (/usr/lib/libwayland-server.so.0+0xdd03)
[1]: https://github.com/swaywm/wlroots/pull/3002
[2]: https://github.com/swaywm/wlroots/pull/3004
		
	
			
		
			
				
	
	
		
			240 lines
		
	
	
	
		
			7 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
			
		
		
	
	
			240 lines
		
	
	
	
		
			7 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
#include <assert.h>
 | 
						|
#include <libinput.h>
 | 
						|
#include <stdlib.h>
 | 
						|
#include <stdio.h>
 | 
						|
#include <wlr/backend/interface.h>
 | 
						|
#include <wlr/backend/session.h>
 | 
						|
#include <wlr/util/log.h>
 | 
						|
#include "backend/libinput.h"
 | 
						|
#include "util/signal.h"
 | 
						|
 | 
						|
static struct wlr_libinput_backend *get_libinput_backend_from_backend(
 | 
						|
		struct wlr_backend *wlr_backend) {
 | 
						|
	assert(wlr_backend_is_libinput(wlr_backend));
 | 
						|
	return (struct wlr_libinput_backend *)wlr_backend;
 | 
						|
}
 | 
						|
 | 
						|
static int libinput_open_restricted(const char *path,
 | 
						|
		int flags, void *_backend) {
 | 
						|
	struct wlr_libinput_backend *backend = _backend;
 | 
						|
	struct wlr_device *dev = wlr_session_open_file(backend->session, path);
 | 
						|
	if (dev == NULL) {
 | 
						|
		return -1;
 | 
						|
	}
 | 
						|
	return dev->fd;
 | 
						|
}
 | 
						|
 | 
						|
static void libinput_close_restricted(int fd, void *_backend) {
 | 
						|
	struct wlr_libinput_backend *backend = _backend;
 | 
						|
 | 
						|
	struct wlr_device *dev;
 | 
						|
	bool found = false;
 | 
						|
	wl_list_for_each(dev, &backend->session->devices, link) {
 | 
						|
		if (dev->fd == fd) {
 | 
						|
			found = true;
 | 
						|
			break;
 | 
						|
		}
 | 
						|
	}
 | 
						|
	if (found) {
 | 
						|
		wlr_session_close_file(backend->session, dev);
 | 
						|
	}
 | 
						|
}
 | 
						|
 | 
						|
static const struct libinput_interface libinput_impl = {
 | 
						|
	.open_restricted = libinput_open_restricted,
 | 
						|
	.close_restricted = libinput_close_restricted
 | 
						|
};
 | 
						|
 | 
						|
static int handle_libinput_readable(int fd, uint32_t mask, void *_backend) {
 | 
						|
	struct wlr_libinput_backend *backend = _backend;
 | 
						|
	int ret = libinput_dispatch(backend->libinput_context);
 | 
						|
	if (ret != 0) {
 | 
						|
		wlr_log(WLR_ERROR, "Failed to dispatch libinput: %s", strerror(-ret));
 | 
						|
		wl_display_terminate(backend->display);
 | 
						|
		return 0;
 | 
						|
	}
 | 
						|
	struct libinput_event *event;
 | 
						|
	while ((event = libinput_get_event(backend->libinput_context))) {
 | 
						|
		handle_libinput_event(backend, event);
 | 
						|
		libinput_event_destroy(event);
 | 
						|
	}
 | 
						|
	return 0;
 | 
						|
}
 | 
						|
 | 
						|
static enum wlr_log_importance libinput_log_priority_to_wlr(
 | 
						|
		enum libinput_log_priority priority) {
 | 
						|
	switch (priority) {
 | 
						|
	case LIBINPUT_LOG_PRIORITY_ERROR:
 | 
						|
		return WLR_ERROR;
 | 
						|
	case LIBINPUT_LOG_PRIORITY_INFO:
 | 
						|
		return WLR_INFO;
 | 
						|
	default:
 | 
						|
		return WLR_DEBUG;
 | 
						|
	}
 | 
						|
}
 | 
						|
 | 
						|
static void log_libinput(struct libinput *libinput_context,
 | 
						|
		enum libinput_log_priority priority, const char *fmt, va_list args) {
 | 
						|
	enum wlr_log_importance importance = libinput_log_priority_to_wlr(priority);
 | 
						|
	static char wlr_fmt[1024];
 | 
						|
	snprintf(wlr_fmt, sizeof(wlr_fmt), "[libinput] %s", fmt);
 | 
						|
	_wlr_vlog(importance, wlr_fmt, args);
 | 
						|
}
 | 
						|
 | 
						|
static bool backend_start(struct wlr_backend *wlr_backend) {
 | 
						|
	struct wlr_libinput_backend *backend =
 | 
						|
		get_libinput_backend_from_backend(wlr_backend);
 | 
						|
	wlr_log(WLR_DEBUG, "Initializing libinput");
 | 
						|
 | 
						|
	backend->libinput_context = libinput_udev_create_context(&libinput_impl,
 | 
						|
		backend, backend->session->udev);
 | 
						|
	if (!backend->libinput_context) {
 | 
						|
		wlr_log(WLR_ERROR, "Failed to create libinput context");
 | 
						|
		return false;
 | 
						|
	}
 | 
						|
 | 
						|
	if (libinput_udev_assign_seat(backend->libinput_context,
 | 
						|
			backend->session->seat) != 0) {
 | 
						|
		wlr_log(WLR_ERROR, "Failed to assign libinput seat");
 | 
						|
		return false;
 | 
						|
	}
 | 
						|
 | 
						|
	// TODO: More sophisticated logging
 | 
						|
	libinput_log_set_handler(backend->libinput_context, log_libinput);
 | 
						|
	libinput_log_set_priority(backend->libinput_context, LIBINPUT_LOG_PRIORITY_ERROR);
 | 
						|
 | 
						|
	int libinput_fd = libinput_get_fd(backend->libinput_context);
 | 
						|
	char *no_devs = getenv("WLR_LIBINPUT_NO_DEVICES");
 | 
						|
	if (no_devs) {
 | 
						|
		if (strcmp(no_devs, "1") != 0) {
 | 
						|
			no_devs = NULL;
 | 
						|
		}
 | 
						|
	}
 | 
						|
	if (!no_devs && backend->wlr_device_lists.size == 0) {
 | 
						|
		handle_libinput_readable(libinput_fd, WL_EVENT_READABLE, backend);
 | 
						|
		if (backend->wlr_device_lists.size == 0) {
 | 
						|
			wlr_log(WLR_ERROR, "libinput initialization failed, no input devices");
 | 
						|
			wlr_log(WLR_ERROR, "Set WLR_LIBINPUT_NO_DEVICES=1 to suppress this check");
 | 
						|
			return false;
 | 
						|
		}
 | 
						|
	}
 | 
						|
 | 
						|
	struct wl_event_loop *event_loop =
 | 
						|
		wl_display_get_event_loop(backend->display);
 | 
						|
	if (backend->input_event) {
 | 
						|
		wl_event_source_remove(backend->input_event);
 | 
						|
	}
 | 
						|
	backend->input_event = wl_event_loop_add_fd(event_loop, libinput_fd,
 | 
						|
			WL_EVENT_READABLE, handle_libinput_readable, backend);
 | 
						|
	if (!backend->input_event) {
 | 
						|
		wlr_log(WLR_ERROR, "Failed to create input event on event loop");
 | 
						|
		return false;
 | 
						|
	}
 | 
						|
	wlr_log(WLR_DEBUG, "libinput successfully initialized");
 | 
						|
	return true;
 | 
						|
}
 | 
						|
 | 
						|
static void backend_destroy(struct wlr_backend *wlr_backend) {
 | 
						|
	if (!wlr_backend) {
 | 
						|
		return;
 | 
						|
	}
 | 
						|
	struct wlr_libinput_backend *backend =
 | 
						|
		get_libinput_backend_from_backend(wlr_backend);
 | 
						|
 | 
						|
	struct wl_list **wlr_devices_ptr;
 | 
						|
	wl_array_for_each(wlr_devices_ptr, &backend->wlr_device_lists) {
 | 
						|
		struct wlr_input_device *wlr_dev, *next;
 | 
						|
		wl_list_for_each_safe(wlr_dev, next, *wlr_devices_ptr, link) {
 | 
						|
			wlr_input_device_destroy(wlr_dev);
 | 
						|
		}
 | 
						|
		free(*wlr_devices_ptr);
 | 
						|
	}
 | 
						|
 | 
						|
	wlr_backend_finish(wlr_backend);
 | 
						|
 | 
						|
	wl_list_remove(&backend->display_destroy.link);
 | 
						|
	wl_list_remove(&backend->session_destroy.link);
 | 
						|
	wl_list_remove(&backend->session_signal.link);
 | 
						|
 | 
						|
	wl_array_release(&backend->wlr_device_lists);
 | 
						|
	if (backend->input_event) {
 | 
						|
		wl_event_source_remove(backend->input_event);
 | 
						|
	}
 | 
						|
	libinput_unref(backend->libinput_context);
 | 
						|
	free(backend);
 | 
						|
}
 | 
						|
 | 
						|
static const struct wlr_backend_impl backend_impl = {
 | 
						|
	.start = backend_start,
 | 
						|
	.destroy = backend_destroy,
 | 
						|
};
 | 
						|
 | 
						|
bool wlr_backend_is_libinput(struct wlr_backend *b) {
 | 
						|
	return b->impl == &backend_impl;
 | 
						|
}
 | 
						|
 | 
						|
static void session_signal(struct wl_listener *listener, void *data) {
 | 
						|
	struct wlr_libinput_backend *backend =
 | 
						|
		wl_container_of(listener, backend, session_signal);
 | 
						|
	struct wlr_session *session = backend->session;
 | 
						|
 | 
						|
	if (!backend->libinput_context) {
 | 
						|
		return;
 | 
						|
	}
 | 
						|
 | 
						|
	if (session->active) {
 | 
						|
		libinput_resume(backend->libinput_context);
 | 
						|
	} else {
 | 
						|
		libinput_suspend(backend->libinput_context);
 | 
						|
	}
 | 
						|
}
 | 
						|
 | 
						|
static void handle_session_destroy(struct wl_listener *listener, void *data) {
 | 
						|
	struct wlr_libinput_backend *backend =
 | 
						|
		wl_container_of(listener, backend, session_destroy);
 | 
						|
	backend_destroy(&backend->backend);
 | 
						|
}
 | 
						|
 | 
						|
static void handle_display_destroy(struct wl_listener *listener, void *data) {
 | 
						|
	struct wlr_libinput_backend *backend =
 | 
						|
		wl_container_of(listener, backend, display_destroy);
 | 
						|
	backend_destroy(&backend->backend);
 | 
						|
}
 | 
						|
 | 
						|
struct wlr_backend *wlr_libinput_backend_create(struct wl_display *display,
 | 
						|
		struct wlr_session *session) {
 | 
						|
	struct wlr_libinput_backend *backend =
 | 
						|
		calloc(1, sizeof(struct wlr_libinput_backend));
 | 
						|
	if (!backend) {
 | 
						|
		wlr_log(WLR_ERROR, "Allocation failed: %s", strerror(errno));
 | 
						|
		return NULL;
 | 
						|
	}
 | 
						|
	wlr_backend_init(&backend->backend, &backend_impl);
 | 
						|
 | 
						|
	wl_array_init(&backend->wlr_device_lists);
 | 
						|
 | 
						|
	backend->session = session;
 | 
						|
	backend->display = display;
 | 
						|
 | 
						|
	backend->session_signal.notify = session_signal;
 | 
						|
	wl_signal_add(&session->events.active, &backend->session_signal);
 | 
						|
 | 
						|
	backend->session_destroy.notify = handle_session_destroy;
 | 
						|
	wl_signal_add(&session->events.destroy, &backend->session_destroy);
 | 
						|
 | 
						|
	backend->display_destroy.notify = handle_display_destroy;
 | 
						|
	wl_display_add_destroy_listener(display, &backend->display_destroy);
 | 
						|
 | 
						|
	return &backend->backend;
 | 
						|
}
 | 
						|
 | 
						|
struct libinput_device *wlr_libinput_get_device_handle(
 | 
						|
		struct wlr_input_device *wlr_dev) {
 | 
						|
	struct wlr_libinput_input_device *dev =
 | 
						|
		(struct wlr_libinput_input_device *)wlr_dev;
 | 
						|
	return dev->handle;
 | 
						|
}
 | 
						|
 | 
						|
uint32_t usec_to_msec(uint64_t usec) {
 | 
						|
	return (uint32_t)(usec / 1000);
 | 
						|
}
 |