Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions docs/13-single-layer-windowing.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,9 +62,15 @@ Step by step, with the override's exact insertion point.
4. **The override is created.** The shim opens **its own wayland connection** to
gamescope's wayland socket (`wl_setup`), creates **its own `wl_surface`**
(`wlproto::compositor_create_surface`), wraps it in a `gamescope_swapchain`
(`swapchain_factory_create_swapchain`), and binds that surface to the X
window: `swapchain_override_window_content(scobj, server=0, bound_window)` —
`gamescope_swapchain.override_window_content`.
(`swapchain_factory_create_swapchain`). The binding to the X window waits
for a swapchain's first commit (`bind_window_at_first_commit`):
`swapchain_override_window_content(scobj, server=0, bound_window)` —
`gamescope_swapchain.override_window_content`, sent right before that
commit. gamescope keeps one surface per window and a new binding retires the
old one, so a swapchain that never presents (the Epic overlay creates one on
a child of the game's window only to find `Present`) never takes the window
from the game. `vkDestroySurfaceKHR` sends `gamescope_swapchain.destroy` and
`wl_surface.destroy`, which drop the binding on the compositor side.
5. **gamescope accepts it.** `gamescope_xwayland_server_t::handle_override_window_content`
(`src/wlserver.cpp:836`) resolves the named XID the same way —
`x11_window = x11_find_toplevel_for_xid( this->ctx->dpy, x11_window )` —
Expand Down
44 changes: 34 additions & 10 deletions icd_shim/src/proxy.rs
Original file line number Diff line number Diff line change
Expand Up @@ -764,6 +764,7 @@ unsafe fn commit_generated(sc: *mut GnSwapchain, slot_index: usize) {
let parent = unsafe { (*(*sc).surf).parent };
let _sg = SEND_LOCK.lock().unwrap();
unsafe {
bind_window_at_first_commit(sc);
wlproto::surface_attach(parent, (*s).buf, 0, 0);
wlproto::surface_damage_buffer(
parent,
Expand Down Expand Up @@ -2004,6 +2005,27 @@ fn worker_main(sc: *mut GnSwapchain) {
}
}

/// Binds the swapchain's override surface to its X window, once per swapchain,
/// right before its first commit. gamescope keeps one surface per window, so a
/// swapchain that never presents (the Epic overlay's Present probe on a child
/// of the game's window) must not take the window from the one that does.
/// Called with `SEND_LOCK` held.
unsafe fn bind_window_at_first_commit(sc: *mut GnSwapchain) {
unsafe {
let surf = (*sc).surf;
if (*sc).window_bound || (*surf).swapchain_obj.is_null() {
return;
}
(*sc).window_bound = true;
// Single xwayland server (--xwayland-count 1) is always id 0.
wlproto::swapchain_override_window_content((*surf).swapchain_obj, 0, (*surf).window);
crate::logf!(gndrm_obf::obf!(
"override: swapchain {sc:?} binds surface {surf:?} to XID {:#x} at its first commit",
(*surf).window
));
}
}

/// Commit a guest frame: into its X11 window on that route, otherwise attached
/// to the surface and committed. The slot's own fence has already been waited.
unsafe fn commit_real(sc: *mut GnSwapchain, idx: i32, fence_ms: u128) {
Expand Down Expand Up @@ -2139,6 +2161,7 @@ unsafe fn commit_real(sc: *mut GnSwapchain, idx: i32, fence_ms: u128) {
gamescope_present_mode(declared_present_mode(sc)),
);
}
bind_window_at_first_commit(sc);
wlproto::surface_attach(parent, (*s).buf, 0, 0);
wlproto::surface_damage_buffer(
parent,
Expand Down Expand Up @@ -2364,6 +2387,7 @@ unsafe extern "C" fn gn_vkCreateSwapchainKHR(
cv_put: Condvar::new(),
cv_free: Condvar::new(),
x11_trace: 0,
window_bound: false,
next: ptr::null_mut(),
});
let scp: *mut GnSwapchain = &mut *sc;
Expand Down Expand Up @@ -3055,6 +3079,7 @@ unsafe fn present_sync_commit(sc: *mut GnSwapchain, slot: *mut GnSlot, idx: i32)
gamescope_present_mode(declared_present_mode(sc)),
);
}
bind_window_at_first_commit(sc);
wlproto::surface_attach(parent, (*slot).buf, 0, 0);
wlproto::surface_damage_buffer(
parent,
Expand Down Expand Up @@ -7724,6 +7749,8 @@ pub struct GnSwapchain {
pub cv_put: Condvar,
pub cv_free: Condvar,
pub x11_trace: u32,
/// Set by `bind_window_at_first_commit`, under `SEND_LOCK`.
pub window_bound: bool,
pub next: *mut GnSwapchain,
/// Set once a destination could not be made: the set stops growing.
pub gen_no_grow: bool,
Expand Down Expand Up @@ -9667,10 +9694,10 @@ fn use_guest_surface() -> bool {

/// The override/Wayland present route — the DEFAULT (`GN_VKSHIM_GUEST_SURFACE`
/// unset, or any value other than exactly `1`; see `use_guest_surface`).
/// Creates the shim's OWN wl_surface, wraps it in a
/// gamescope_swapchain, and binds it to the guest's X window via
/// override_window_content; the compositor then routes this surface's commits
/// as that window's content. Presenting therefore shows the guest's frames
/// Creates the shim's OWN wl_surface and wraps it in a
/// gamescope_swapchain; a swapchain's first commit binds it to the guest's X
/// window via override_window_content (`bind_window_at_first_commit`), and the
/// compositor then routes this surface's commits as that window's content. Presenting therefore shows the guest's frames
/// directly — wine's own GDI/2D window content is NOT composited (the known
/// and accepted "chooses, never combines" consequence of this route). That
/// GDI/2D gap is exactly what the guest-surface route (the opt-in) buys.
Expand Down Expand Up @@ -9720,9 +9747,6 @@ unsafe fn xlib_override_surface(
return VK_ERROR_INITIALIZATION_FAILED;
}
let scobj = wlproto::swapchain_factory_create_swapchain(factory, surf);
// Single xwayland server (--xwayland-count 1) is always id 0. Bind to
// the window gamescope paints, not the one wine happened to name.
wlproto::swapchain_override_window_content(scobj, 0, bound_window);
wlproto::wl_display_flush(dpy);
drop(_sg);
let s = Box::new(GnSurface {
Expand All @@ -9745,7 +9769,7 @@ unsafe fn xlib_override_surface(
}
*out = s as usize as VkSurfaceKHR;
crate::logf!(gndrm_obf::obf!(
"override: proxy surface {:?} (own wl_surface {:?} bound to XID {:#x}; Vulkan-only, guest GDI/2D not composited)",
"override: proxy surface {:?} (own wl_surface {:?} for XID {:#x}, bound at its first present; Vulkan-only, guest GDI/2D not composited)",
s,
surf,
window
Expand Down Expand Up @@ -9903,10 +9927,10 @@ unsafe extern "C" fn gn_vkDestroySurfaceKHR(
if !(*s).swapchain_obj.is_null() || !(*s).own_surface.is_null() {
let _sg = SEND_LOCK.lock().unwrap();
if !(*s).swapchain_obj.is_null() {
wlproto::wl_proxy_destroy((*s).swapchain_obj);
wlproto::swapchain_destroy((*s).swapchain_obj);
}
if !(*s).own_surface.is_null() {
wlproto::wl_proxy_destroy((*s).own_surface);
wlproto::surface_destroy((*s).own_surface);
}
wlproto::wl_display_flush((*s).dpy);
drop(_sg);
Expand Down
12 changes: 12 additions & 0 deletions icd_shim/src/wlproto.rs
Original file line number Diff line number Diff line change
Expand Up @@ -315,6 +315,18 @@ pub unsafe fn swapchain_factory_create_swapchain(
)
}

/// gamescope_swapchain.destroy (opcode 0), then the proxy.
pub unsafe fn swapchain_destroy(sc: *mut wl_proxy) {
wl_proxy_marshal_array(sc, 0, std::ptr::null_mut());
wl_proxy_destroy(sc);
}

/// wl_surface.destroy (opcode 0), then the proxy.
pub unsafe fn surface_destroy(surface: *mut wl_proxy) {
wl_proxy_marshal_array(surface, 0, std::ptr::null_mut());
wl_proxy_destroy(surface);
}

/// gamescope_swapchain.override_window_content (opcode 1): server id, XID.
pub unsafe fn swapchain_override_window_content(sc: *mut wl_proxy, server: u32, xid: u32) {
let mut args = [wl_argument { u: server }, wl_argument { u: xid }];
Expand Down