From a112b41d51ef8b114bbbbebb59eab1972750a23c Mon Sep 17 00:00:00 2001
From: Adam Malczewski <github@tradam.dev>
Date: Fri, 12 Jun 2026 20:34:03 +0900
Subject: Slice 3: THE SPIKE — RMLUi→wlr_scene bridge lands, GO
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Plan A verified on hardware (HD 4400/crocus): RMLUi renders into a GLES
3.2 sibling-context FBO backed by a dmabuf wlr_buffer (wlr_allocator +
EGLImage import), composited as a wlr_scene_buffer with per-frame damage.
Plan B (glReadPixels→shm) implemented and verified as runtime fallback;
auto-engages when any Plan-A precondition fails. Plan C not needed.

- Hello-world RML doc: text, data-bound frame counter, pointer input
  proof (hover/:active) — verified upright on screen via screenshot after
  fixing the classic FBO Y-flip (buffer-level V-flip keeps display ==
  document coords for input); position-aware orientation guard added.
- Temporary spike surface: Options::ui_spike + frame-count/orientation
  probes, host-bin --ui-spike flag; replaced by the real ui substrate
  contract in slice 4+.
- kernel suite 6 cases / 416 assertions green; ASan/UBSan clean in our
  code (Mesa leak noise + 2 benign UBSan downcast reports inside vendored
  RMLUi are known); idle RSS ≈83 MiB.
- Deferred (notes/plan.md §7): glFinish→EGL fence + swapchain; dmabuf
  render-format negotiation (private API in wlroots 0.20).
---
 packages/kernel/src/server.cpp | 40 ++++++++++++++++++++++++++++++++++++++++
 1 file changed, 40 insertions(+)

(limited to 'packages/kernel/src/server.cpp')

diff --git a/packages/kernel/src/server.cpp b/packages/kernel/src/server.cpp
index d4d6b56..df24f1f 100644
--- a/packages/kernel/src/server.cpp
+++ b/packages/kernel/src/server.cpp
@@ -58,6 +58,14 @@ void Server::terminate() {
     wl_display_terminate(impl_->display);
 }
 
+auto Server::ui_spike_frame_count() const -> int {
+    return impl_->ui_spike != nullptr ? impl_->ui_spike->frame_count() : 0;
+}
+
+auto Server::ui_spike_orientation() const -> int {
+    return impl_->ui_spike != nullptr ? impl_->ui_spike->check_orientation() : 0;
+}
+
 // ---- Impl lifecycle --------------------------------------------------------
 
 void Server::Impl::init() {
@@ -112,6 +120,10 @@ void Server::Impl::init() {
         throw std::runtime_error("failed to start the wlr_backend");
     }
 
+    if (options.ui_spike) {
+        start_ui_spike();
+    }
+
     if (!options.startup_cmd.empty()) {
         if (fork() == 0) {
             // Child only: don't pollute our own environment.
@@ -123,7 +135,29 @@ void Server::Impl::init() {
     }
 }
 
+void Server::Impl::start_ui_spike() {
+    // The bridge needs the wlr renderer's EGLDisplay to build its sibling
+    // GLES 3.2 context. Only the gles2 renderer exposes one; under the
+    // pixman renderer (e.g. headless CI) there is no GL path, so the spike
+    // stays disabled — slice-2 behaviour is preserved.
+    if (!wlr_renderer_is_gles2(renderer)) {
+        wlr_log(WLR_INFO, "ui-spike: renderer is not gles2; spike disabled");
+        return;
+    }
+    wlr_egl* egl = wlr_gles2_renderer_get_egl(renderer);
+    if (egl == nullptr) {
+        wlr_log(WLR_ERROR, "ui-spike: gles2 renderer has no wlr_egl");
+        return;
+    }
+    EGLDisplay display_egl = wlr_egl_get_display(egl);
+    ui_spike = UiSpike::create(&scene->tree, display_egl, allocator, renderer);
+}
+
 void Server::Impl::shutdown() {
+    // Slice-3 spike: tear down before scene/renderer/allocator die (it owns
+    // a scene node, GL objects on a sibling context, and borrows the others).
+    ui_spike.reset();
+
     if (display != nullptr) {
         wl_display_destroy_clients(display); // fires toplevel/popup destroy events
     }
@@ -199,6 +233,12 @@ void Server::Impl::handle_new_output(wlr_output* wlr_output) {
     outputs.push_back(std::move(owned));
 
     output->frame.connect(wlr_output->events.frame, [this, output](void*) {
+        // Slice-3 spike: render the RMLUi document if dirty, before commit so
+        // its damage is picked up this frame. Cheap no-op when disabled.
+        if (ui_spike != nullptr) {
+            ui_spike->tick();
+        }
+
         wlr_scene_output* scene_output = wlr_scene_get_scene_output(scene, output->output);
         wlr_scene_output_commit(scene_output, nullptr);
 
-- 
cgit v1.2.3