Bench, libdrm, egl sync, kb layouts, build errors

.github/workflows/build.yml

@@ -23,8 +23,9 @@ jobs:
 
       - uses: actions/checkout@v4
 
+      # vortex must stay warning-free, vendored runara still has upstream ones
       - name: Configure
-        run: meson setup build
+        run: meson setup build -Dwerror=true -Drunara:werror=false
 
       - name: Compile
         run: meson compile -C build

.gitignore

@@ -1,4 +1,4 @@
-./build
+./build*
 .cache
 *.json
 subprojects/cglm-*/

README.md

@@ -97,10 +97,11 @@ vortex -bp /usr/lib/vortex/backends/libcustom.so
 ### Environment Variables
 Vortex handles the following environment variables:
 
-| Env | Description | 
+| Env | Description |
 |--------|--------------|
 | `VT_DRM_NO_ATOMIC` | Force legacy DRM/KMS implementation |
 | `VT_DRM_NO_HARDWARE_CURSOR` | Force cursor compositing |
+| `VT_DRM_NO_DIRECT_SCANOUT` | Composite every surface, never put client buffers on hardware planes. Surfaces whose frame is not finished are already composited automatically, this forces it always |
 
 ## Notes
 - [`runara`](https://github.com/cococry/runara) is currently vendored into `subprojects/` but might not be in the future.

compbench.sh

@@ -0,0 +1,34 @@
+#!/usr/bin/env bash
+# stupid helper to compile versionned, then bench with glmark2-wayland
+# usage: compbench.sh [wl|drm] [glmark2 args...]
+
+set -euo pipefail
+
+MODE="${1:-wl}"
+shift || true
+
+# git rev parse branch
+BRANCH="$(git rev-parse --abbrev-ref HEAD)"
+# git rev parse commit
+COMMIT="$(git rev-parse --short HEAD)"
+BUILD="build-$BRANCH-$COMMIT"
+
+# meson conf
+meson setup --reconfigure "$BUILD"
+# meson comp
+meson compile -C "$BUILD"
+
+# -b only scans installed backends, scripts pass the build tree .so
+case "$MODE" in
+wl)
+	scripts/bench-run.sh "$BUILD" wl "$@"
+	;;
+drm)
+	# build stays user-owned, only the VT session needs root
+	sudo --preserve-env=VERBOSE,TIMEOUT,VT,VORTEX_ARGS,VT_DRM_NO_DIRECT_SCANOUT,CPUS scripts/bench-drm.sh "$BUILD" "$@"
+	;;
+*)
+	echo "unknown mode '$MODE' (wl|drm)" >&2
+	exit 1
+	;;
+esac

meson.build

@@ -26,6 +26,7 @@ dep_wayland_egl     = dependency('wayland-egl',       required: true)
 dep_wayland_protos  = dependency('wayland-protocols', required: true)
 dep_egl             = dependency('egl',               required: true)
 dep_udev            = dependency('libudev',           required: true)
+dep_libdrm          = dependency('libdrm',            required: true)
 dep_gl              = dependency('gl',                required: true)
 dep_pixman          = dependency('pixman-1',          required: true)
 dep_libinput        = dependency('libinput',          required: true)
@@ -37,6 +38,7 @@ protocols_dir     = dep_wayland_protos.get_variable(pkgconfig: 'pkgdatadir')
 xdg_shell_xml     = join_paths(protocols_dir, 'stable', 'xdg-shell', 'xdg-shell.xml')
 dma_buf_xml       = join_paths(protocols_dir, 'stable', 'linux-dmabuf', 'linux-dmabuf-v1.xml')
 explitic_sync_xml = join_paths(protocols_dir, 'unstable', 'linux-explicit-synchronization', 'linux-explicit-synchronization-unstable-v1.xml')
+drm_syncobj_xml   = join_paths(protocols_dir, 'staging', 'linux-drm-syncobj', 'linux-drm-syncobj-v1.xml')
 
 xdg_server_header = custom_target(
   'xdg-shell-server-header',
@@ -85,6 +87,22 @@ explitic_sync_code = custom_target(
   install: false
 )
 
+drm_syncobj_header = custom_target(
+  'linux-drm-syncobj-header',
+  input: drm_syncobj_xml,
+  output: 'linux-drm-syncobj-v1-server-protocol.h',
+  command: [wayland_scanner, 'server-header', '@INPUT@', '@OUTPUT@'],
+  install: false
+)
+
+drm_syncobj_code = custom_target(
+  'linux-drm-syncobj-code',
+  input: drm_syncobj_xml,
+  output: 'linux-drm-syncobj-v1-protocol.c',
+  command: [wayland_scanner, 'private-code', '@INPUT@', '@OUTPUT@'],
+  install: false
+)
+
 vortex_src = files('src/vortex.c',
 'src/vortex.c',
 'src/render/renderer.c',
@@ -101,6 +119,8 @@ vortex_src = files('src/vortex.c',
 'src/protocols/linux_dmabuf.h',
 'src/protocols/linux_explicit_sync.c',
 'src/protocols/linux_explicit_sync.h',
+'src/protocols/linux_drm_syncobj.c',
+'src/protocols/linux_drm_syncobj.h',
 'src/protocols/wl_surface.h',
 'src/protocols/wl_surface.c',
 'src/protocols/wl_output.c',
@@ -145,7 +165,7 @@ vortex_inc = include_directories('include', '/usr/include/pixman-1/')
 deps = [
   dep_wayland_server, dep_wayland_egl,
   dep_egl, dep_libinput, dep_xcursor, dep_udev, dep_gl,
-  runara_dep, dep_pixman,
+  runara_dep, dep_pixman, dep_libdrm,
 ]
 if dep_xkbcommon.found()
   deps += dep_xkbcommon
@@ -171,7 +191,9 @@ vortex_exe = executable(
     dma_buf_header,
     dma_buf_code,
     explitic_sync_header,
-    explitic_sync_code
+    explitic_sync_code,
+    drm_syncobj_header,
+    drm_syncobj_code
   ],
   include_directories: vortex_inc,
   link_args: ['-Wl,-E'],

scripts/bench-drm.sh

@@ -0,0 +1,53 @@
+#!/usr/bin/env bash
+# run bench-run.sh in drm mode on a spare VT, from any terminal or ssh.
+# logind only hands out DRM master to an active session bound to a VT,
+# PAMName=login + TTYPath create exactly that for the transient unit.
+# usage: sudo bench-drm.sh <build-dir> [glmark2 args...]
+
+set -euo pipefail
+
+if [[ "$EUID" -ne 0 || -z "${SUDO_USER:-}" ]]; then
+	echo "run through sudo: sudo $0 <build-dir> [glmark2 args...]" >&2
+	exit 1
+fi
+
+BUILD="$(realpath "$1")"
+shift
+ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)"
+VT="${VT:-8}"
+TIMEOUT="${TIMEOUT:-600}"
+UNIT="vortex-bench"
+
+ORIG_VT="$(fgconsole)"
+trap 'chvt "$ORIG_VT"' EXIT
+
+echo "switching to VT $VT, back to VT $ORIG_VT when done"
+chvt "$VT"
+
+# hybrid CPUs: P/E core placement moves scores, CPUS=0-3 pins a run.
+# the unit is spawned by PID 1, so taskset on this script would not carry
+AFFINITY=()
+if [[ -n "${CPUS:-}" ]]; then
+	AFFINITY=(-p CPUAffinity="$CPUS")
+fi
+
+# RuntimeMaxSec backs up the vortex watchdog: the unit dying frees the VT
+status=0
+systemd-run --unit="$UNIT" --wait --collect "${AFFINITY[@]}" \
+	-p PAMName=login -p User="$SUDO_USER" \
+	-p TTYPath="/dev/tty$VT" -p StandardInput=tty-force \
+	-p StandardOutput=journal -p StandardError=journal \
+	-p TTYReset=yes -p TTYVTDisallocate=yes \
+	-p RuntimeMaxSec="$((TIMEOUT + 30))" \
+	-p WorkingDirectory="$ROOT" \
+	--setenv=TIMEOUT="$TIMEOUT" --setenv=VERBOSE="${VERBOSE:-0}" \
+	--setenv=VORTEX_ARGS="${VORTEX_ARGS:-}" \
+	--setenv=VT_DRM_NO_DIRECT_SCANOUT="${VT_DRM_NO_DIRECT_SCANOUT:-}" \
+	"$ROOT/scripts/bench-run.sh" "$BUILD" drm "$@" || status=$?
+
+# unit stdout did not reach the journal in testing, read results back
+if [[ -f "$BUILD/glmark2-drm.txt" ]]; then
+	cat "$BUILD/glmark2-drm.txt"
+fi
+echo "unit exited with status $status. vortex log: $BUILD/vortex-drm.log"
+exit "$status"

scripts/bench-run.sh

@@ -0,0 +1,85 @@
+#!/usr/bin/env bash
+# run vortex from a build dir, attach glmark2-wayland, save score.
+# usage: bench-run.sh <build-dir> <wl|drm> [glmark2 args...]
+
+set -euo pipefail
+
+BUILD="$1"
+MODE="$2"
+shift 2
+
+# watchdog: a hung vortex on drm keeps the VT. SIGABRT leaves a core.
+TIMEOUT="${TIMEOUT:-600}"
+LOG="$BUILD/vortex-$MODE.log"
+OUT="$BUILD/glmark2-$MODE.txt"
+# a failed run must not leave the previous score looking current
+rm -f "$OUT"
+
+case "$MODE" in
+wl)
+	BACKEND="$BUILD/src/backends/wayland/libwl-backend.so"
+	;;
+drm)
+	BACKEND="$BUILD/src/backends/drm/libdrm-backend.so"
+	if [[ "$(tty)" != /dev/tty[0-9]* ]]; then
+		echo "drm mode needs a VT, got $(tty). Use bench-drm.sh" >&2
+		exit 1
+	fi
+	# vortex picks the wl backend whenever this is set
+	unset WAYLAND_DISPLAY
+	;;
+*)
+	echo "unknown mode '$MODE' (wl|drm)" >&2
+	exit 1
+	;;
+esac
+
+# trace logging costs frames, only turn it on when debugging
+LOG_ARGS=()
+if [[ "${VERBOSE:-0}" == 1 ]]; then
+	LOG_ARGS=(--verbose)
+fi
+# extra vortex flags for A/B runs, e.g. "-expt linux-dmabuf-explicit-sync"
+read -ra VT_ARGS <<<"${VORTEX_ARGS:-}"
+
+# a killed vortex leaves its socket behind and the next one reuses the
+# name, so match on creation after launch rather than on a new name
+MARK="$(mktemp)"
+new_socket() {
+	find "$XDG_RUNTIME_DIR" -maxdepth 1 -type s -name 'wayland-*' \
+		-newer "$MARK" -printf '%f\n'
+}
+
+# line-buffered so the last lines before a hang/kill reach the log
+timeout -s ABRT -k 5 "$TIMEOUT" stdbuf -oL -eL \
+	"$BUILD/vortex" "${LOG_ARGS[@]}" "${VT_ARGS[@]}" --backend-path "$BACKEND" \
+	>"$LOG" 2>&1 &
+VPID=$!
+trap 'kill "$VPID" || true; wait "$VPID" || true; rm -f "$MARK"' EXIT
+
+# the new socket is vortex's. connecting before init finishes is fine:
+# the first roundtrip is only answered once the event loop runs.
+SOCK=""
+for _ in $(seq 100); do
+	if ! kill -0 "$VPID"; then
+		echo "vortex exited early, log: $LOG" >&2
+		cat "$LOG"
+		exit 1
+	fi
+	SOCK="$(new_socket)"
+	if [[ -n "$SOCK" ]]; then
+		break
+	fi
+	sleep 0.1
+done
+
+if [[ -z "$SOCK" ]]; then
+	echo "vortex not ready after 10s, log: $LOG" >&2
+	cat "$LOG"
+	exit 1
+fi
+
+echo "vortex ready on $SOCK ($MODE), running glmark2"
+# stderr too: a glmark2 init failure is otherwise invisible on drm
+WAYLAND_DISPLAY="$SOCK" glmark2-wayland "$@" 2>&1 | tee "$OUT"
+echo "score saved: $OUT, vortex log: $LOG"

src/backends/drm/atomic.c

@@ -219,7 +219,7 @@ static bool _atomic_prepare_liftoff(struct vt_drm_backend_state_t *drm,
 
       if (!liftoff_layer) {
         VT_ERROR(drm->comp->log, "Layer %p has no retained Liftoff layer.",
-                 layer);
+                 (void *)layer);
         return false;
       }