Core Wayland window system code and protocol
Find a file
Demi Marie Obenour d5cf2f5fc7 Add extended shared memory attach support
This provides an extended version of ‘create_pool’, called
‘create_pool2’, which allows the client to specify a 64-bit offset in
the file to map at.  As Wayland does not support 64-bit integers, the
offset is passed as two 32-bit numbers.

The intended use-case for this extension is when one needs to map a
surface from a character special device, but it can also be used with
regular files if one needs to map with a nonzero offset.  Qubes OS needs
the Wayland compositor to map the ‘/dev/xen/gntdev’ character device,
which represents memory shared by a different Xen virtual machine.
Currently, this can be accomplished by opening a separate instance of
‘/dev/xen/gntdev’ every time, but that is slightly wasteful.  Until
recently, it also on undocumented behavior in the kernel driver.

This also requires libwayland-server to be built with 64-bit off_t,
which should be supported on any reasonably modern system.  A
‘_Static_assert’ will trip if off_t is not large enough.

This also forbids resizing a pool of version 3 or later that is
currently in use.  On non-Linux systems, supporting pool resize requires
holding the file descriptor open, which can lead to file descriptor
exhaustion in the compositor.  This change allows libwayland-server to
close the file descriptor once the pool is first mapped.

Signed-off-by: Demi Marie Obenour <demiobenour@gmail.com>
2024-07-23 13:48:38 -04:00
.gitlab/issue_templates gitlab: make issue template the default 2023-11-21 15:44:31 +00:00
cursor cursor: add aliases for cursor name spec 2024-01-19 14:08:16 +00:00
doc doc: Improve wording for packed IDs 2024-01-22 12:37:26 +00:00
egl build: fix build and provide compat for OpenBSD 2024-02-21 15:46:41 +00:00
protocol Add extended shared memory attach support 2024-07-23 13:48:38 -04:00
src Add extended shared memory attach support 2024-07-23 13:48:38 -04:00
tests Mitigate UAF crashes due to wl_client_destroy reentrancy 2024-02-23 00:40:32 +00:00
.editorconfig editorconfig: add settings for the .gitlab-ci.yml file 2020-06-05 08:22:34 +10:00
.gitignore build: drop autotools 2021-03-05 09:15:04 +00:00
.gitlab-ci.yml ci: upgrade FreeBSD to 13.2 2023-08-02 16:47:07 +02:00
.mailmap Add a .mailmap file 2023-03-25 11:17:32 -05:00
.triage-policies.yml Add a triage-policies file for bugbot 2023-07-07 21:18:08 +10:00
CONTRIBUTING.md CONTRIBUTING: fix typo "excercising" 2020-12-17 16:03:14 -05:00
COPYING COPYING: Update to MIT Expat License rather than MIT X License 2015-06-12 15:31:21 -07:00
meson.build Add extended shared memory attach support 2024-07-23 13:48:38 -04:00
meson_options.txt meson: Use proper type for bools 2022-04-02 17:04:08 +03:00
README.md readme: convert to Markdown 2023-02-13 19:57:15 +01:00
release.sh release.sh: Don't push *all* tags 2023-01-16 10:03:54 +00:00
releasing.txt Add release.sh 2022-07-14 08:04:43 +00:00
wayland-scanner.m4 build: check wayland-scanner version 2020-01-16 17:25:06 +01:00
wayland-scanner.mk Pass input/output files as arguments to wayland-scanner 2017-08-18 15:20:24 +03:00

Wayland

Wayland is a project to define a protocol for a compositor to talk to its clients as well as a library implementation of the protocol. The compositor can be a standalone display server running on Linux kernel modesetting and evdev input devices, an X application, or a wayland client itself. The clients can be traditional applications, X servers (rootless or fullscreen) or other display servers.

The wayland protocol is essentially only about input handling and buffer management. The compositor receives input events and forwards them to the relevant client. The clients creates buffers and renders into them and notifies the compositor when it needs to redraw. The protocol also handles drag and drop, selections, window management and other interactions that must go through the compositor. However, the protocol does not handle rendering, which is one of the features that makes wayland so simple. All clients are expected to handle rendering themselves, typically through cairo or OpenGL.

Building the wayland libraries is fairly simple, aside from libffi, they don't have many dependencies:

$ git clone https://gitlab.freedesktop.org/wayland/wayland
$ cd wayland
$ meson build/ --prefix=PREFIX
$ ninja -C build/ install

where PREFIX is where you want to install the libraries.

See https://wayland.freedesktop.org for documentation.