wayland 1.26.0: four members, and the macros become a module

Rebased on upstream 1.26.0 (from 1.23.1) and reorganised around what the
packages actually are:

  freedesktop.wayland-scanner   the protocol generator
  freedesktop.wayland           libwayland-client.so.0 + import wayland.client
  freedesktop.wayland-server    libwayland-server.so.0 + import wayland.server
  freedesktop.wayland-util      the macros, as entities a module can export

Each library package now ships BOTH the C library and its module wrapper, so
there is one package per library rather than a C one and a module one — the
opencv shape. The namespace is the upstream org.

The module wrappers add no API: every exported name is upstream's, spelled
upstream's way, and the export lists are generated from the public headers so a
version bump cannot quietly drop one.

Macros were the one thing that could not come through. `export` names
entities and a macro is not one, so wayland.util maps each to what it actually
is — WL_MARSHAL_FLAG_DESTROY to a constexpr, wl_container_of to a function
template, and the six *_for_each loops to ranges. Its test instantiates all of
them, including the _safe removal guarantee, and links nothing: the list is
wired by hand so a package of templates keeps zero dependencies.

1.26.0 needed one build fix over 1.23.1: scanner.c now calls strndup(), which
-std=c11 hides, so the scanner carries -D_GNU_SOURCE= as well.

CI runs the whole thing on gcc AND llvm — the export list is exactly where the
two disagree — and still builds the tree with upstream meson, so "no upstream
file is patched" has a test rather than a promise.

Author: speak-agent

.editorconfig

@@ -9,8 +9,8 @@ indent_style = tab
 indent_size = 8
 max_line_length = 80
 
-[*.xml]
-indent_style = tab
+[*.{xml,xsl}]
+indent_style = space
 indent_size = 2
 tab_width = 8
 

.git-blame-ignore-revs

@@ -0,0 +1,4 @@
+# Use the following command to ignore the following commits in git blame:
+#     git config blame.ignoreRevsFile .git-blame-ignore-revs
+
+77b9eb76369e27142b8be296b5f2eb1ca466272a # protocol: reindent wayland.xml

.github/workflows/ci.yml

@@ -1,10 +1,6 @@
-# Build all three members and prove the generated code is really generated.
-#
-# The interesting failure mode here is not "does it compile" — it is that a
-# HOST wayland-scanner would silently produce different code. 1.22 does not
-# know 1.23's `deprecated-since` attribute and rejects protocol/wayland.xml
-# outright, so the job asserts the generator that ran was the one this build
-# produced.
+# Build every member on BOTH toolchains, and check what a green compile would
+# not: that the generator is ours, that the sonames are canonical, and that the
+# two libraries do not overlap.
 name: ci
 
 on:
@@ -17,6 +13,14 @@ on:
 jobs:
   build:
     runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        # Both, because the module wrapper is where they differ most: GCC and
+        # Clang disagree about what a `using ::name;` in an export block may
+        # name, and a 300-entry export list is exactly where that shows up.
+        toolchain: [gcc, llvm]
+    name: build (${{ matrix.toolchain }})
     steps:
       - uses: actions/checkout@v4
 
@@ -27,21 +31,24 @@ jobs:
           "$HOME/.xlings/bin/xlings" install mcpp -y
 
       - name: Build the workspace
-        run: mcpp build --workspace
+        run: mcpp build --workspace --toolchain ${{ matrix.toolchain }}
 
-      - name: wayland-scanner runs and is 1.23.1
+      - name: The macro mappings actually run
+        run: mcpp test -p mcpp/util --toolchain ${{ matrix.toolchain }}
+
+      - name: wayland-scanner is ours, and is 1.26.0
         run: |
           scanner=$(find mcpp/scanner/target -name wayland-scanner -type f | head -1)
           test -n "$scanner" || { echo "no wayland-scanner was built"; exit 1; }
           "$scanner" --version
-          "$scanner" --version | grep -qx 'wayland-scanner 1.23.1'
+          "$scanner" --version | grep -qx 'wayland-scanner 1.26.0'
 
       - name: the generated protocol code came from THIS scanner
         run: |
           scanner=$(find mcpp/scanner/target -name wayland-scanner -type f | head -1)
           "$scanner" -s public-code protocol/wayland.xml /tmp/wayland-protocol.c
           head -1 /tmp/wayland-protocol.c
-          grep -q 'Generated by wayland-scanner 1.23.1' /tmp/wayland-protocol.c
+          grep -q 'Generated by wayland-scanner 1.26.0' /tmp/wayland-protocol.c
 
       - name: both libraries carry the canonical SONAMEs
         run: |
@@ -56,10 +63,8 @@ jobs:
 
       - name: the two libraries do not overlap
         run: |
-          # Mesa's libEGL_mesa has DT_NEEDED on both; if one carried the
-          # other's API the process would resolve it to whichever loaded
-          # first. wl_display_create is server-only, wl_display_connect
-          # client-only.
+          # Mesa's libEGL_mesa has DT_NEEDED on both; if one carried the other's
+          # API the process would bind to whichever loaded first.
           c=$(find mcpp/client/target -name libwayland-client.so -type f | head -1)
           s=$(find mcpp/server/target -name libwayland-server.so -type f | head -1)
           readelf --dyn-syms -W "$c" | grep -q ' wl_display_connect' || exit 1
@@ -68,11 +73,21 @@ jobs:
           readelf --dyn-syms -W "$s" | grep -q ' wl_display_connect' && { echo "server leaked the client API"; exit 1; }
           echo "client and server APIs are disjoint"
 
-      - name: upstream's own build still works
+      - name: both modules produced a BMI
         run: |
-          # The fork patches no upstream file, so meson must still be able to
-          # build this tree. If this breaks, something was modified that should
-          # not have been.
+          for m in client server util; do
+            find "mcpp/$m/target" -name '*.gcm' -o -name '*.pcm' | head -1 | grep -q . \
+              || { echo "$m: no module interface was produced"; exit 1; }
+          done
+          echo "wayland.client, wayland.server and wayland.util all have interfaces"
+
+  upstream:
+    # The fork patches no upstream file, so meson must still build this tree.
+    # If this breaks, something was modified that should not have been.
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - run: |
           sudo apt-get update -qq
           sudo apt-get install -y -qq meson ninja-build libffi-dev libexpat1-dev
           meson setup build-meson -Ddocumentation=false -Ddtd_validation=false

.gitlab-ci.yml

@@ -43,7 +43,7 @@ include:
     # API changes. If you need new features from ci-templates you must bump
     # this to the current SHA you require from the ci-templates repo, however
     # be aware that you may need to account for API changes when doing so.
-    ref: b791bd48996e3ced9ca13f1c5ee82be8540b8adb
+    ref: 48c2c583a865bd59be21e8938df247faf460099c
     file:
       - '/templates/debian.yml'
       - '/templates/freebsd.yml'
@@ -62,6 +62,13 @@ stages:
   - "Build and test"
   - "Other build configurations"
 
+workflow:
+  rules:
+    - if: $CI_PIPELINE_SOURCE == "merge_request_event"
+    - if: $CI_COMMIT_BRANCH && $CI_OPEN_MERGE_REQUESTS
+      when: never
+    - if: $CI_COMMIT_BRANCH
+
 .ci-rules:
   rules:
     - when: on_success
@@ -70,12 +77,11 @@ stages:
 .os-debian:
   variables:
     BUILD_OS: debian
-    FDO_DISTRIBUTION_VERSION: bookworm
-    FDO_DISTRIBUTION_PACKAGES: 'build-essential pkg-config libexpat1-dev libffi-dev libxml2-dev doxygen graphviz xmlto xsltproc docbook-xsl python3-pip python3-setuptools ninja-build'
-    FDO_DISTRIBUTION_EXEC: 'pip3 install --break-system-packages meson~=0.57.2'
+    FDO_DISTRIBUTION_VERSION: trixie
+    FDO_DISTRIBUTION_PACKAGES: 'build-essential pkg-config libexpat1-dev libffi-dev libxml2-dev doxygen graphviz xmlto xsltproc docbook-xsl mdbook meson ninja-build'
     # bump this tag every time you change something which requires rebuilding the
     # base image
-    FDO_DISTRIBUTION_TAG: "2024-03-28.2"
+    FDO_DISTRIBUTION_TAG: "2026-01-31.0"
 
 .debian-x86_64:
   extends:
@@ -94,6 +100,7 @@ stages:
     - .os-debian
   variables:
     BUILD_ARCH: "armv7"
+    FDO_DISTRIBUTION_PLATFORM: "linux/arm/v7"
 
 
 # Does not inherit .ci-rules as we only want it to run in MR context.
@@ -147,13 +154,12 @@ armv7-debian-container_prep:
   stage: "Base container"
   variables:
     GIT_STRATEGY: none
-    FDO_BASE_IMAGE: "arm32v7/debian:$FDO_DISTRIBUTION_VERSION"
 
 
 # Core build environment.
 .build-env:
   variables:
-    MESON_BUILD_TYPE: "-Dbuildtype=debug -Doptimization=0 -Db_sanitize=address,undefined"
+    MESON_BUILD_TYPE: "-Dbuildtype=debug -Doptimization=0 -Db_sanitize=address,undefined -Ddocbook_validation=true"
     # See https://gitlab.freedesktop.org/wayland/wayland/-/merge_requests/154
     ASAN_OPTIONS: "detect_odr_violation=0"
   before_script:
@@ -216,11 +222,11 @@ armv7-debian-container_prep:
     - .ci-rules
   stage: "Build and test"
   script:
-    - cd "$BUILDDIR"
-    - meson --prefix="$PREFIX" -Dicon_directory=/usr/share/X11/icons --fatal-meson-warnings -Dwerror=true ${MESON_BUILD_TYPE} ..
-    - ninja -k0 -j${FDO_CI_CONCURRENT:-4}
-    - meson test --num-processes ${FDO_CI_CONCURRENT:-4}
-    - ninja clean
+    - meson setup $BUILDDIR --prefix="$PREFIX" -Dicon_directory=/usr/share/X11/icons --fatal-meson-warnings -Dwerror=true ${MESON_BUILD_TYPE}
+    - ninja -C $BUILDDIR -k0 -j${FDO_CI_CONCURRENT:-4}
+    - meson test -C $BUILDDIR --num-processes ${FDO_CI_CONCURRENT:-4}
+    - ninja -C $BUILDDIR install
+    - ninja -C $BUILDDIR clean
   artifacts:
     name: wayland-$CI_JOB_NAME
     when: always
@@ -243,7 +249,7 @@ armv7-debian-container_prep:
     # the workspace to see details about the failed tests.
     - |
       set +e
-      /app/vmctl exec "pkg info; cd $CI_PROJECT_NAME ; meson $BUILDDIR --prefix=$PREFIX $MESON_BUILD_TYPE $MESON_ARGS && ninja -C $BUILDDIR -j${FDO_CI_CONCURRENT:-4}"
+      /app/vmctl exec "pkg info; cd $CI_PROJECT_NAME ; meson setup $BUILDDIR --prefix=$PREFIX $MESON_BUILD_TYPE $MESON_ARGS && ninja -C $BUILDDIR -j${FDO_CI_CONCURRENT:-4}"
       /app/vmctl exec "meson test --print-errorlogs -C $BUILDDIR --num-processes ${FDO_CI_CONCURRENT:-4}" && touch .tests-successful
       set -ex
       scp -r vm:$BUILDDIR/meson-logs .
@@ -299,11 +305,11 @@ armv7-release-debian-build:
 .os-freebsd:
   variables:
     BUILD_OS: freebsd
-    FDO_DISTRIBUTION_VERSION: "13.2"
+    FDO_DISTRIBUTION_VERSION: "14.4"
     FDO_DISTRIBUTION_PACKAGES: 'libxslt meson ninja pkgconf expat libffi libepoll-shim libxml2'
     # bump this tag every time you change something which requires rebuilding the
     # base image
-    FDO_DISTRIBUTION_TAG: "2023-08-02.0"
+    FDO_DISTRIBUTION_TAG: "2026-03-10.0"
     # Don't build documentation since installing the required tools massively
     # increases the VM image (and therefore container) size.
     MESON_ARGS: "--fatal-meson-warnings -Dwerror=true -Ddocumentation=false"

README.mcpp.md

@@ -1,14 +1,14 @@
 # mcpplibs/wayland
 
-[Wayland](https://gitlab.freedesktop.org/wayland/wayland) 1.23.1 with mcpp build
+[Wayland](https://gitlab.freedesktop.org/wayland/wayland) 1.26.0 with mcpp build
 support, consumed from [mcpp-index](https://github.com/mcpplibs/mcpp-index) as
 three packages:
 
 | package | output |
 |---|---|
-| `compat.wayland-scanner` | `wayland-scanner`, the protocol code generator |
-| `compat.wayland` | `libwayland-client.so.0` |
-| `compat.wayland-server` | `libwayland-server.so.0` |
+| `freedesktop.wayland-scanner` | `wayland-scanner`, the protocol code generator |
+| `freedesktop.wayland` | `libwayland-client.so.0` |
+| `freedesktop.wayland-server` | `libwayland-server.so.0` |
 
 ```bash
 mcpp build --workspace
@@ -42,5 +42,5 @@ version, so that mismatch is not expressible.
 
 ## Upstream
 
-Tracking wayland 1.23.1. Upstream sources, `protocol/`, `tests/` and the meson
+Tracking wayland 1.26.0. Upstream sources, `protocol/`, `tests/` and the meson
 build are untouched, so `meson setup build && ninja -C build` still works.

config.h

@@ -16,7 +16,7 @@
 #pragma once
 
 #define PACKAGE         "wayland"
-#define PACKAGE_VERSION "1.23.1"
+#define PACKAGE_VERSION "1.26.0"
 
 #define HAVE_SYS_PRCTL_H 1
 /* sys/procctl.h and sys/ucred.h are BSD; absent on linux. */
@@ -28,6 +28,8 @@
 #define HAVE_MEMFD_CREATE    1
 #define HAVE_MREMAP          1
 #define HAVE_STRNDUP         1
+/* new in 1.26: wayland-server uses it for the client thread id. */
+#define HAVE_GETTID          1
 
 /* `struct xucred` is FreeBSD's; the socket peer-credential path uses
  * SO_PEERCRED on linux instead. */

cursor/convert_font.c

@@ -29,7 +29,6 @@
  * http://fontforge.org/pcf-format.html
  */
 
-#include <assert.h>
 #include <fcntl.h>
 #include <stdint.h>
 #include <stdio.h>

cursor/wayland-cursor.c

@@ -27,6 +27,7 @@
 #include "xcursor.h"
 #include "wayland-cursor.h"
 #include "wayland-client.h"
+#include <limits.h>
 #include <stdio.h>
 #include <stdlib.h>
 #include <stdint.h>
@@ -68,11 +69,16 @@ shm_pool_create(struct wl_shm *shm, int size)
 		goto err_close;
 
 	pool->pool = wl_shm_create_pool(shm, pool->fd, size);
+	if (!pool->pool)
+		goto err_unmap;
+
 	pool->size = size;
 	pool->used = 0;
 
 	return pool;
 
+err_unmap:
+	munmap(pool->data, size);
 err_close:
 	close(pool->fd);
 err_free:
@@ -279,7 +285,8 @@ wl_cursor_create_from_xcursor_images(struct xcursor_images *images,
 {
 	struct cursor *cursor;
 	struct cursor_image *image;
-	int i, size;
+	size_t size;
+	int i;
 
 	cursor = malloc(sizeof *cursor);
 	if (!cursor)
@@ -309,7 +316,12 @@ wl_cursor_create_from_xcursor_images(struct xcursor_images *images,
 		image->image.hotspot_y = images->images[i]->yhot;
 		image->image.delay = images->images[i]->delay;
 
-		size = image->image.width * image->image.height * 4;
+		size = (size_t) image->image.width * image->image.height * 4;
+		if (size > INT_MAX) {
+			free(image);
+			break;
+		}
+
 		image->offset = shm_pool_allocate(theme->pool, size);
 		if (image->offset < 0) {
 			free(image);
@@ -339,6 +351,8 @@ load_callback(struct xcursor_images *images, void *data)
 {
 	struct wl_cursor_theme *theme = data;
 	struct wl_cursor *cursor;
+	struct wl_cursor **p;
+	size_t s;
 
 	if (wl_cursor_theme_get_cursor(theme, images->name)) {
 		xcursor_images_destroy(images);
@@ -348,15 +362,14 @@ load_callback(struct xcursor_images *images, void *data)
 	cursor = wl_cursor_create_from_xcursor_images(images, theme);
 
 	if (cursor) {
-		theme->cursor_count++;
-		theme->cursors =
-			realloc(theme->cursors,
-				theme->cursor_count * sizeof theme->cursors[0]);
+		s = theme->cursor_count + 1;
+		p = realloc(theme->cursors, s * sizeof theme->cursors[0]);
 
-		if (theme->cursors == NULL) {
-			theme->cursor_count--;
+		if (p == NULL) {
 			free(cursor);
 		} else {
+			theme->cursor_count = s;
+			theme->cursors = p;
 			theme->cursors[theme->cursor_count - 1] = cursor;
 		}
 	}
@@ -384,6 +397,9 @@ wl_cursor_theme_load(const char *name, int size, struct wl_shm *shm)
 	if (!theme)
 		return NULL;
 
+	if (size < 0 || (size > 0 && INT_MAX / size / 4 < size))
+		goto err;
+
 	if (!name)
 		name = "default";
 
@@ -393,7 +409,7 @@ wl_cursor_theme_load(const char *name, int size, struct wl_shm *shm)
 
 	theme->pool = shm_pool_create(shm, size * size * 4);
 	if (!theme->pool)
-		goto out_error_pool;
+		goto err;
 
 	xcursor_load_theme(name, size, load_callback, theme);
 
@@ -405,7 +421,7 @@ wl_cursor_theme_load(const char *name, int size, struct wl_shm *shm)
 
 	return theme;
 
-out_error_pool:
+err:
 	free(theme);
 	return NULL;
 }