Merge pull request #6 from bnema/feat/wl-fixes

feat(server): support wl_fixes registry destruction and global removal acks

commit: d4696de0766403c79dda095e32186023ce87e1c7
author: bnema · 23d ago · 2026-09-29 05:44 UTC
committer: GitHub · 23d ago · 2026-09-29 05:44 UTC
merge of: ad674f5 + 57e7c0d · diff against the first parent
signature: GPG UnverifiedB5690EEEBB952194 The key is unknown
refs: tag: v0.6.0

4 files · +63 -5

M server/args.go +16 -5


@@ -67,11 +67,22 @@ func Array(p *runtime.Pinner, b []byte) Arg {
67	67
68	68		// Request argument accessors. Values are only valid during dispatch; the
69	69		// String and Array accessors copy.
70		-	func (a Arg) Uint() uint32 { return uint32(a) }
71		-	func (a Arg) Int() int32 { return int32(uint32(a)) }
72		-	func (a Arg) Fixed() Fixed { return Fixed(int32(uint32(a))) }
73		-	func (a Arg) NewID() uint32 { return uint32(a) }
74		-	func (a Arg) Resource() *Resource { return live.resources[uintptr(a)] }
	70	+	func (a Arg) Uint() uint32 { return uint32(a) }
	71	+	func (a Arg) Int() int32 { return int32(uint32(a)) }
	72	+	func (a Arg) Fixed() Fixed { return Fixed(int32(uint32(a))) }
	73	+	func (a Arg) NewID() uint32 { return uint32(a) }
	74	+
	75	+	// Resource returns the object argument, nil for a null object. An object
	76	+	// libwayland created itself (wl_registry, wl_callback of wl_display) comes
	77	+	// back as a bare handle: Destroy works, it has no handler, version or client.
	78	+	// Like other arguments, a bare handle is only valid during the dispatch; do
	79	+	// not retain it.
	80	+	func (a Arg) Resource() *Resource {
	81	+	if r := live.resources[uintptr(a)]; r != nil \|\| a == 0 {
	82	+	return r
	83	+	}
	84	+	return &Resource{c: uintptr(a), bare: true}
	85	+	}
75	86
76	87		// Fd returns a received file descriptor. The handler owns it and must close it.
77	88		func (a Arg) Fd() int { return int(int32(uint32(a))) }


@@ -67,11 +67,22 @@ func Array(p *runtime.Pinner, b []byte) Arg {
67			67
68		// Request argument accessors. Values are only valid during dispatch; the	68		// Request argument accessors. Values are only valid during dispatch; the
69		// String and Array accessors copy.	69		// String and Array accessors copy.
70	-	func (a Arg) Uint() uint32 { return uint32(a) }	70	+	func (a Arg) Uint() uint32 { return uint32(a) }
71	-	func (a Arg) Int() int32 { return int32(uint32(a)) }	71	+	func (a Arg) Int() int32 { return int32(uint32(a)) }
72	-	func (a Arg) Fixed() Fixed { return Fixed(int32(uint32(a))) }	72	+	func (a Arg) Fixed() Fixed { return Fixed(int32(uint32(a))) }
73	-	func (a Arg) NewID() uint32 { return uint32(a) }	73	+	func (a Arg) NewID() uint32 { return uint32(a) }
74	-	func (a Arg) Resource() *Resource { return live.resources[uintptr(a)] }	74	+
			75	+	// Resource returns the object argument, nil for a null object. An object
			76	+	// libwayland created itself (wl_registry, wl_callback of wl_display) comes
			77	+	// back as a bare handle: Destroy works, it has no handler, version or client.
			78	+	// Like other arguments, a bare handle is only valid during the dispatch; do
			79	+	// not retain it.
			80	+	func (a Arg) Resource() *Resource {
			81	+	if r := live.resources[uintptr(a)]; r != nil \|\| a == 0 {
			82	+	return r
			83	+	}
			84	+	return &Resource{c: uintptr(a), bare: true}
			85	+	}
75			86
76		// Fd returns a received file descriptor. The handler owns it and must close it.	87		// Fd returns a received file descriptor. The handler owns it and must close it.
77		func (a Arg) Fd() int { return int(int32(uint32(a))) }	88		func (a Arg) Fd() int { return int(int32(uint32(a))) }

M server/display.go +19 -0


@@ -32,6 +32,7 @@ type Resource struct {
32	32		handler Handler
33	33		OnDestroy func()
34	34		gone bool
	35	+	bare bool // created by libwayland, no destroy callback
35	36
36	37		// Data holds the owner's state, typically the generated wrapper.
37	38		Data any

@@ -127,6 +128,22 @@ func (g *Global) Remove() {
127	128		g.c = 0
128	129		}
129	130
	131	+	// AckGlobalRemove implements wl_fixes.ack_global_remove: libwayland checks
	132	+	// that registry announced the removed global name, posting
	133	+	// wl_fixes.invalid_ack_remove on fixes otherwise. It reports false when
	134	+	// libwayland-server is older than 1.26 and has no support.
	135	+	// Display goroutine only.
	136	+	func AckGlobalRemove(fixes, registry *Resource, name uint32) bool {
	137	+	if symFixesAckGlobalRemove == 0 {
	138	+	return false
	139	+	}
	140	+	if fixes == nil \|\| fixes.gone \|\| registry == nil \|\| registry.gone {
	141	+	return true
	142	+	}
	143	+	wlFixesHandleAckGlobalRemove(fixes.c, registry.c, name)
	144	+	return true
	145	+	}
	146	+
130	147		// Close destroys a display that has not started Run. It is a no-op once Run
131	148		// has started; Run owns destruction in that case. Call before Run starts.
132	149		func (d *Display) Close() {

@@ -270,6 +287,8 @@ func (r Resource) Iface() Interface { return r.iface }
270	287		func (r *Resource) Destroy() {
271	288		if !r.gone {
272	289		wlResourceDestroy(r.c)
	290	+	// A bare handle gets no destroy callback to mark it gone.
	291	+	r.gone = r.gone \|\| r.bare
273	292		}
274	293		}
275	294


@@ -32,6 +32,7 @@ type Resource struct {
32	handler Handler	32		handler Handler
33	OnDestroy func()	33		OnDestroy func()
34	gone bool	34		gone bool
		35	+	bare bool // created by libwayland, no destroy callback
35		36
36	// Data holds the owner's state, typically the generated wrapper.	37		// Data holds the owner's state, typically the generated wrapper.
37	Data any	38		Data any

@@ -127,6 +128,22 @@ func (g *Global) Remove() {
127	g.c = 0	128		g.c = 0
128	}	129		}
129		130
		131	+	// AckGlobalRemove implements wl_fixes.ack_global_remove: libwayland checks
		132	+	// that registry announced the removed global name, posting
		133	+	// wl_fixes.invalid_ack_remove on fixes otherwise. It reports false when
		134	+	// libwayland-server is older than 1.26 and has no support.
		135	+	// Display goroutine only.
		136	+	func AckGlobalRemove(fixes, registry *Resource, name uint32) bool {
		137	+	if symFixesAckGlobalRemove == 0 {
		138	+	return false
		139	+	}
		140	+	if fixes == nil \|\| fixes.gone \|\| registry == nil \|\| registry.gone {
		141	+	return true
		142	+	}
		143	+	wlFixesHandleAckGlobalRemove(fixes.c, registry.c, name)
		144	+	return true
		145	+	}
		146	+
130	// Close destroys a display that has not started Run. It is a no-op once Run	147		// Close destroys a display that has not started Run. It is a no-op once Run
131	// has started; Run owns destruction in that case. Call before Run starts.	148		// has started; Run owns destruction in that case. Call before Run starts.
132	func (d *Display) Close() {	149		func (d *Display) Close() {

@@ -270,6 +287,8 @@ func (r Resource) Iface() Interface { return r.iface }
270	func (r *Resource) Destroy() {	287		func (r *Resource) Destroy() {
271	if !r.gone {	288		if !r.gone {
272	wlResourceDestroy(r.c)	289		wlResourceDestroy(r.c)
		290	+	// A bare handle gets no destroy callback to mark it gone.
		291	+	r.gone = r.gone \|\| r.bare
273	}	292		}
274	}	293		}
275		294

M server/display_test.go +22 -0


@@ -38,6 +38,28 @@ func TestNoHandlerClosesFDs(t *testing.T) {
38	38		}
39	39		}
40	40
	41	+	// Objects libwayland created itself (wl_registry) come back as bare handles.
	42	+	func TestArgResourceUntracked(t *testing.T) {
	43	+	if Arg(0).Resource() != nil {
	44	+	t.Fatal("null object is not nil")
	45	+	}
	46	+	r := Arg(0x1234).Resource()
	47	+	if r == nil \|\| r.c != 0x1234 \|\| r.handler != nil \|\| !r.bare \|\| !r.Alive() {
	48	+	t.Fatalf("untracked object %+v", r)
	49	+	}
	50	+	}
	51	+
	52	+	func TestAckGlobalRemoveNilResources(t *testing.T) {
	53	+	if err := load(); err != nil {
	54	+	t.Skip(err)
	55	+	}
	56	+	// A dead or missing resource is ignored, whatever the library version.
	57	+	supported := AckGlobalRemove(nil, nil, 1)
	58	+	if supported != (symFixesAckGlobalRemove != 0) {
	59	+	t.Fatalf("supported %v with symbol %#x", supported, symFixesAckGlobalRemove)
	60	+	}
	61	+	}
	62	+
41	63		func TestDoStopped(t *testing.T) {
42	64		d, err := NewDisplay()
43	65		if err != nil {


@@ -38,6 +38,28 @@ func TestNoHandlerClosesFDs(t *testing.T) {
38	}	38		}
39	}	39		}
40		40
		41	+	// Objects libwayland created itself (wl_registry) come back as bare handles.
		42	+	func TestArgResourceUntracked(t *testing.T) {
		43	+	if Arg(0).Resource() != nil {
		44	+	t.Fatal("null object is not nil")
		45	+	}
		46	+	r := Arg(0x1234).Resource()
		47	+	if r == nil \|\| r.c != 0x1234 \|\| r.handler != nil \|\| !r.bare \|\| !r.Alive() {
		48	+	t.Fatalf("untracked object %+v", r)
		49	+	}
		50	+	}
		51	+
		52	+	func TestAckGlobalRemoveNilResources(t *testing.T) {
		53	+	if err := load(); err != nil {
		54	+	t.Skip(err)
		55	+	}
		56	+	// A dead or missing resource is ignored, whatever the library version.
		57	+	supported := AckGlobalRemove(nil, nil, 1)
		58	+	if supported != (symFixesAckGlobalRemove != 0) {
		59	+	t.Fatalf("supported %v with symbol %#x", supported, symFixesAckGlobalRemove)
		60	+	}
		61	+	}
		62	+
41	func TestDoStopped(t *testing.T) {	63		func TestDoStopped(t *testing.T) {
42	d, err := NewDisplay()	64		d, err := NewDisplay()
43	if err != nil {	65		if err != nil {

M server/lib.go +6 -0


@@ -32,6 +32,8 @@ var (
32	32		symDisplayFlushClients, symEventLoopDispatch, symResourceCreate uintptr
33	33		symResourceSetDispatcher, symResourcePostEventArr, symResourceDestroy, symResourceGetID uintptr
34	34		symErrnoLocation uintptr
	35	+	// wl_fixes support (libwayland 1.26+); zero on older libraries.
	36	+	symFixesAckGlobalRemove uintptr
35	37
36	38		// Shared C callbacks. purego callbacks are never freed, so there is one
37	39		// of each for the whole process.

@@ -84,6 +86,7 @@ func load() error {
84	86		return
85	87		}
86	88		}
	89	+	symFixesAckGlobalRemove, _ = purego.Dlsym(lib, "wl_fixes_handle_ack_global_remove")
87	90		symErrnoLocation, err = purego.Dlsym(lib, "__errno_location")
88	91		if err != nil {
89	92		libc, openErr := purego.Dlopen("libc.so.6", purego.RTLD_NOW\|purego.RTLD_GLOBAL)

@@ -148,3 +151,6 @@ func wlResourcePostEventArr(resource uintptr, opcode uint32, args unsafe.Pointer
148	151		func wlResourceDestroy(resource uintptr) {
149	152		purego.Syscall6(symResourceDestroy, resource, 0, 0, 0, 0, 0)
150	153		}
	154	+	func wlFixesHandleAckGlobalRemove(fixes, registry uintptr, name uint32) {
	155	+	purego.Syscall6(symFixesAckGlobalRemove, fixes, registry, uintptr(name), 0, 0, 0)
	156	+	}


@@ -32,6 +32,8 @@ var (
32	symDisplayFlushClients, symEventLoopDispatch, symResourceCreate uintptr	32		symDisplayFlushClients, symEventLoopDispatch, symResourceCreate uintptr
33	symResourceSetDispatcher, symResourcePostEventArr, symResourceDestroy, symResourceGetID uintptr	33		symResourceSetDispatcher, symResourcePostEventArr, symResourceDestroy, symResourceGetID uintptr
34	symErrnoLocation uintptr	34		symErrnoLocation uintptr
		35	+	// wl_fixes support (libwayland 1.26+); zero on older libraries.
		36	+	symFixesAckGlobalRemove uintptr
35		37
36	// Shared C callbacks. purego callbacks are never freed, so there is one	38		// Shared C callbacks. purego callbacks are never freed, so there is one
37	// of each for the whole process.	39		// of each for the whole process.

@@ -84,6 +86,7 @@ func load() error {
84	return	86		return
85	}	87		}
86	}	88		}
		89	+	symFixesAckGlobalRemove, _ = purego.Dlsym(lib, "wl_fixes_handle_ack_global_remove")
87	symErrnoLocation, err = purego.Dlsym(lib, "__errno_location")	90		symErrnoLocation, err = purego.Dlsym(lib, "__errno_location")
88	if err != nil {	91		if err != nil {
89	libc, openErr := purego.Dlopen("libc.so.6", purego.RTLD_NOW\|purego.RTLD_GLOBAL)	92		libc, openErr := purego.Dlopen("libc.so.6", purego.RTLD_NOW\|purego.RTLD_GLOBAL)

@@ -148,3 +151,6 @@ func wlResourcePostEventArr(resource uintptr, opcode uint32, args unsafe.Pointer
148	func wlResourceDestroy(resource uintptr) {	151		func wlResourceDestroy(resource uintptr) {
149	purego.Syscall6(symResourceDestroy, resource, 0, 0, 0, 0, 0)	152		purego.Syscall6(symResourceDestroy, resource, 0, 0, 0, 0, 0)
150	}	153		}
		154	+	func wlFixesHandleAckGlobalRemove(fixes, registry uintptr, name uint32) {
		155	+	purego.Syscall6(symFixesAckGlobalRemove, fixes, registry, uintptr(name), 0, 0, 0)
		156	+	}