Find a file
Simon Ser 0817c52a21 backend/drm: get rid of BO handle table
The BO handle table exists to avoid double-closing a BO handle,
which aren't reference-counted by the kernel. But if we can
guarantee that there is only ever a single ref for each BO handle,
then we don't need the BO handle table anymore.

This is possible if we create the handle right before the ADDFB2
IOCTL, and close the handle right after. The handles are very
short-lived and we don't need to track their lifetime.

Because of multi-planar FBs, we need to be a bit careful: some
FB planes might share the same handle. But with a small check, it's
easy to avoid double-closing the same handle (which wouldn't be a
big deal anyways).

There's one gotcha though: drmModeSetCursor2 takes a BO handle as
input. Saving the handles until drmModeSetCursor2 time would require
us to track BO handle lifetimes, so we wouldn't be able to get rid
of the BO handle table. As a workaround, use drmModeGetFB to turn the
FB ID back to a BO handle, call drmModeSetCursor2 and then immediately
close the BO handle. The overhead should be minimal since these IOCTLs
are pretty cheap.

Closes: https://github.com/swaywm/wlroots/issues/3164
2021-10-29 11:38:37 +02:00
.builds render/vulkan: add Vulkan renderer 2021-10-18 11:51:13 +02:00
backend backend/drm: get rid of BO handle table 2021-10-29 11:38:37 +02:00
docs render: introduce WLR_RENDERER in wlr_renderer_autocreate_with_drm_fd 2021-04-20 21:14:27 +02:00
examples examples/foreign-toplevel: fix toplevel not being freed 2021-10-07 20:36:21 +02:00
include backend/drm: get rid of BO handle table 2021-10-29 11:38:37 +02:00
protocol Fix spelling errors 2021-10-02 10:22:13 +02:00
render render/egl.c: Fix memory leaks in egl_create 2021-10-27 07:30:36 -06:00
tinywl Fix spelling errors 2021-10-02 10:22:13 +02:00
types sceeencopy-v1: listen to output destroy in capture_output 2021-10-29 11:37:59 +02:00
util util/box: introduce wlr_fbox_empty 2021-09-22 10:45:39 -06:00
xcursor xcursor: fix CVE-2013-2003 2021-05-02 17:04:59 +02:00
xwayland xwayland: Allow to retrieve startup-id via _NET_STARTUP_INFO 2021-09-11 09:53:23 +02:00
.editorconfig Set .editorconfig ident_size 2019-01-25 11:37:46 +01:00
.gitignore Remove rootston 2019-08-09 08:34:59 +09:00
CONTRIBUTING.md Fix a typo in CONTRIBUTING.md 2021-09-24 16:33:26 +02:00
LICENSE Update LICENSE year (MIT license) 2018-04-12 21:29:59 -04:00
meson.build render/vulkan: add Vulkan renderer 2021-10-18 11:51:13 +02:00
meson_options.txt render/vulkan: add Vulkan renderer 2021-10-18 11:51:13 +02:00
README.md readme: refresh dependencies 2021-10-26 15:31:38 +02:00
wlroots.syms build: simplify version script 2021-06-17 11:03:21 +02:00

wlroots

Pluggable, composable, unopinionated modules for building a Wayland compositor; or about 60,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.

Check out our wiki to get started with wlroots. Join our IRC channel: #sway-devel on Libera Chat.

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 and GLESv2 (optional, for the GLES2 renderer)
  • Vulkan loader, headers and glslang (optional, for the Vulkan renderer)
  • libdrm
  • GBM
  • libinput (optional, for the libinput backend)
  • xkbcommon
  • udev
  • pixman
  • libseat

If you choose to enable X11 support:

  • xwayland (build-time only, optional at runtime)
  • libxcb
  • libxcb-render-util
  • libxcb-wm
  • libxcb-errors (optional, for improved error reporting)

Run these commands:

meson build/
ninja -C build/

Install like so:

sudo ninja -C build/ install

Contributing

See CONTRIBUTING.md.