48e8da851d
wl_resource_for_each_safe isn't safe to use here because it accesses
the list's head memory one last time at the end of the loop. Work
around this by breaking out early.
==19880==ERROR: AddressSanitizer: heap-use-after-free on address 0x60d0000e6368 at pc 0x7fab68619de2 bp 0x7ffd5c91cee0 sp 0x7ffd5c91ced0
READ of size 8 at 0x60d0000e6368 thread T0
#0 0x7fab68619de1 in wlr_seat_destroy ../types/seat/wlr_seat.c:179
#1 0x7fab68619fb9 in handle_display_destroy ../types/seat/wlr_seat.c:196
#2 0x7fab688e4f8f in wl_priv_signal_emit src/wayland-server.c:2024
#3 0x7fab688e56ca in wl_display_destroy src/wayland-server.c:1092
#4 0x40c11e in server_fini ../sway/server.c:138
#5 0x40b1a8 in main ../sway/main.c:438
#6 0x7fab67b5e18a in __libc_start_main ../csu/libc-start.c:308
#7 0x409359 in _start (/opt/wayland/bin/sway+0x409359)
0x60d0000e6368 is located 24 bytes inside of 144-byte region [0x60d0000e6350,0x60d0000e63e0)
freed by thread T0 here:
#0 0x7fab6a7d6880 in __interceptor_free (/lib64/libasan.so.5+0xee880)
#1 0x7fab68619805 in seat_client_handle_resource_destroy ../types/seat/wlr_seat.c:97
#2 0x7fab688e5025 in destroy_resource src/wayland-server.c:688
previously allocated by thread T0 here:
#0 0x7fab6a7d6e50 in calloc (/lib64/libasan.so.5+0xeee50)
#1 0x7fab686198df in seat_handle_bind ../types/seat/wlr_seat.c:127
#2 0x7fab6530503d in ffi_call_unix64 (/lib64/libffi.so.6+0x603d)
|
||
|---|---|---|
| backend | ||
| docs | ||
| examples | ||
| include | ||
| protocol | ||
| render | ||
| rootston | ||
| types | ||
| util | ||
| xcursor | ||
| xwayland | ||
| .build.yml | ||
| .editorconfig | ||
| .gitignore | ||
| CONTRIBUTING.md | ||
| glgen.sh | ||
| LICENSE | ||
| meson.build | ||
| meson_options.txt | ||
| README.md | ||
| wlroots.syms | ||
wlroots
Pluggable, composable, unopinionated modules for building a Wayland compositor; or about 40,000 lines of code you were going to write anyway.
- wlroots provides backends that abstract the underlying display and input hardware, including KMS/DRM, libinput, Wayland, X11, and headless backends, plus any custom backends you choose to write, which can all be created or destroyed at runtime and used in concert with each other.
- wlroots provides unopinionated, mostly standalone implementations of many Wayland interfaces, both from wayland.xml and various protocol extensions. We also promote the standardization of portable extensions across many compositors.
- wlroots provides several powerful, standalone, and optional tools that implement components common to many compositors, such as the arrangement of outputs in physical space.
- wlroots provides an Xwayland abstraction that allows you to have excellent Xwayland support without worrying about writing your own X11 window manager on top of writing your compositor.
- wlroots provides a renderer abstraction that simple compositors can use to avoid writing GL code directly, but which steps out of the way when your needs demand custom rendering code.
wlroots implements a huge variety of Wayland compositor features and implements them right, so you can focus on the features that make your compositor unique. By using wlroots, you get high performance, excellent hardware compatibility, broad support for many wayland interfaces, and comfortable development tools - or any subset of these features you like, because all of them work independently of one another and freely compose with anything you want to implement yourself.
Status: prior to 1.0 the API is not stable, but we've done most of the work and various projects are using wlroots to build Wayland compositors with.
wlroots is developed under the direction of the sway project. A variety of wrapper libraries are available for using it with your favorite programming language.
Building
Install dependencies:
- meson
- wayland
- wayland-protocols
- EGL
- GLESv2
- libdrm
- GBM
- libinput
- xkbcommon
- udev
- pixman
- systemd (optional, for logind support)
- elogind (optional, for logind support on systems without systemd)
- libcap (optional, for capability support)
If you choose to enable X11 support:
- xcb
- xcb-composite
- xcb-xfixes
- xcb-image
- xcb-render
- x11-xcb
- xcb-errors (optional, for improved error reporting)
- x11-icccm (optional, for improved Xwayland introspection)
- xcb-xkb (optional, for improved keyboard handling on the X11 backend)
Run these commands:
meson build
ninja -C build
On FreeBSD, you need to pass an extra flag to prevent a linking error:
meson build -D b_lundef=false.
Install like so:
sudo ninja -C build install
Running the test compositor
wlroots comes with a test compositor called rootston, which demonstrates the features of the library and is used as a testbed for the development of the library. It may also be useful as a reference for understanding how to use various wlroots features.
If you followed the build instructions above the rootston executable can be
found at ./build/rootston/rootston. To use it, refer to the example config at
./rootston/rootston.ini.example
and place a config file of your own at rootston.ini in the working directory
(or in an arbitrary location via rootston -C). Other options are available,
refer to rootston -h.
Contributing
See CONTRIBUTING.md.