Core Wayland window system code and protocol
Find a file
David Benjamin 8a7ecd774c util: fix undefined behavior in wl_array_for_each
If a wl_array has size zero, wl_array_for_each computes NULL + 0 to get
to the end pointer. This should be fine, and indeed it would be fine in
C++. But the C specification has a mistake here and it is actually
undefined behavior. See
https://davidben.net/2024/01/15/empty-slices.html

Clang's -fsanitize=undefined flags this. I ran into this in Chromium's
build with wayland-scanner on one of our XML files.

../../third_party/wayland/src/src/scanner.c:1853:2: runtime error: applying zero offset to null pointer
    #0 0x55c979b8e02c in emit_code third_party/wayland/src/src/scanner.c:1853:2
    #1 0x55c979b89323 in main third_party/wayland/src/src/scanner.c
    #2 0x7f8dfdb8c6c9 in __libc_start_call_main csu/../sysdeps/nptl/libc_start_call_main.h:58:16
    #3 0x7f8dfdb8c784 in __libc_start_main csu/../csu/libc-start.c:360:3
    #4 0x55c979b70f39 in _start (...)

An empty XML file is sufficient to hit this case, so I've added it as a
test. To reproduce, undo the fix and include only the test, then build
with:

  CC=clang CFLAGS="-fno-sanitize-recover=undefined" meson build/ -Db_sanitize=undefined -Db_lundef=false
  ninja -C build test

Signed-off-by: David Benjamin <davidben@google.com>
2024-03-24 20:00:01 -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 protocol: document that color channels provide electrical values 2024-03-12 13:04:51 +00:00
src util: fix undefined behavior in wl_array_for_each 2024-03-24 20:00:01 -04:00
tests util: fix undefined behavior in wl_array_for_each 2024-03-24 20:00:01 -04: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 build: fix build and provide compat for OpenBSD 2024-02-21 15:46:41 +00: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.