quickgui 0.1.5

A damage-driven, GPU-accelerated desktop GUI foundation
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
//! Extension registration happens before the host starts. Registered images remain loaded for
//! process lifetime; individual sessions still release all resources when they unmount.
use crate::extension_api::{self as abi, ComponentApi, Extension, ServiceApi};
use std::{
    collections::BTreeMap,
    sync::{Mutex, OnceLock},
};

#[derive(Clone)]
struct RegisteredService {
    version: String,
    api: ServiceApi,
}

#[derive(Clone)]
struct RegisteredComponent {
    version: String,
    api: ComponentApi,
}

#[derive(Default)]
struct Registry {
    services: BTreeMap<String, RegisteredService>,
    components: BTreeMap<String, RegisteredComponent>,
}

static SERVICES: OnceLock<Mutex<Registry>> = OnceLock::new();

fn services() -> &'static Mutex<Registry> {
    SERVICES.get_or_init(Default::default)
}

pub fn service(name: &str) -> Option<ServiceApi> {
    services()
        .lock()
        .unwrap()
        .services
        .get(name)
        .map(|service| service.api)
}

/// Look up a component package. Package names and component types are extension-owned.
pub fn component(name: &str) -> Option<ComponentApi> {
    services()
        .lock()
        .unwrap()
        .components
        .get(name)
        .map(|entry| entry.api)
}

pub fn shutdown_services() {
    // Never hold a registry lock while calling foreign code. Extensions can emit
    // their last events and release their sinks during shutdown.
    let extensions: Vec<_> = services()
        .lock()
        .unwrap()
        .services
        .values()
        .map(|service| service.api)
        .collect();
    for api in extensions {
        unsafe { (api.shutdown)() };
    }
}

/// Register an extension obtained from `quickgui_extension_v1` through an in-process loader.
///
/// # Safety
/// The descriptor, its borrowed strings, and function table must be readable and remain valid
/// until process exit. All functions must implement the documented ABI and ownership contracts.
pub unsafe fn register_extension(
    pointer: *const Extension,
    expected_name: &[u8],
) -> Result<(), &'static str> {
    unsafe {
        register_extension_versioned(pointer, expected_name, env!("CARGO_PKG_VERSION").as_bytes())
    }
}

/// Register an independently versioned extension. The imported package supplies
/// its exact version; compatibility is checked by the ABI and table layout.
///
/// # Safety
/// The same descriptor, lifetime, and function contracts as `register_extension` apply.
pub unsafe fn register_extension_versioned(
    pointer: *const Extension,
    expected_name: &[u8],
    expected_version: &[u8],
) -> Result<(), &'static str> {
    if pointer.is_null() {
        return Err("extension descriptor is null");
    }
    // Read only the fixed two-word header until the caller's layout is known to match.
    let header = pointer.cast::<u32>();
    if unsafe { header.read() } != abi::ABI_VERSION
        || unsafe { header.add(1).read() } as usize != size_of::<Extension>()
    {
        return Err("extension ABI version or descriptor size mismatch");
    }
    let descriptor = unsafe { &*pointer };
    if descriptor.name.len == 0
        || descriptor.name.len > abi::MAX_EXTENSION_NAME
        || descriptor.version.len == 0
        || descriptor.version.len > 64
        || descriptor.name.data.is_null()
        || descriptor.version.data.is_null()
    {
        return Err("invalid extension metadata");
    }
    let name = unsafe { std::slice::from_raw_parts(descriptor.name.data, descriptor.name.len) };
    if name != expected_name {
        return Err("loaded extension does not match the requested package");
    }
    if name == b"host" || !valid_name(name) {
        return Err("invalid extension name");
    }
    let version =
        unsafe { std::slice::from_raw_parts(descriptor.version.data, descriptor.version.len) };
    if version != expected_version {
        eprintln!(
            "quickgui extension {}: loaded version {:?}, requested {:?}",
            String::from_utf8_lossy(name),
            String::from_utf8_lossy(version),
            String::from_utf8_lossy(expected_version)
        );
        return Err("extension release does not match the importing package");
    }
    if descriptor.kind == abi::COMPONENT_EXTENSION {
        if descriptor.api.is_null()
            || descriptor.api_size as usize != size_of::<ComponentApi>()
            || !unsafe { valid_functions(descriptor.api, 5) }
        {
            return Err("component extension function table mismatch");
        }
        let api = unsafe { *(descriptor.api.cast::<ComponentApi>()) };
        return services().lock().unwrap().register_component(
            std::str::from_utf8(name).map_err(|_| "invalid extension name")?,
            std::str::from_utf8(version).map_err(|_| "invalid extension version")?,
            api,
        );
    }
    if descriptor.kind == abi::PACKAGE_EXTENSION {
        if descriptor.api.is_null()
            || descriptor.api_size as usize != size_of::<abi::PackageApi>()
            || !unsafe { valid_functions(descriptor.api, 7) }
        {
            return Err("package extension function table mismatch");
        }
        let api = unsafe { *(descriptor.api.cast::<abi::PackageApi>()) };
        return services().lock().unwrap().register_package(
            std::str::from_utf8(name).map_err(|_| "invalid extension name")?,
            std::str::from_utf8(version).map_err(|_| "invalid extension version")?,
            api,
        );
    }
    if descriptor.kind == abi::SERVICE_EXTENSION {
        if descriptor.api.is_null()
            || descriptor.api_size as usize != size_of::<ServiceApi>()
            || !unsafe { valid_functions(descriptor.api, 2) }
        {
            return Err("service extension function table mismatch");
        }
        let api = unsafe { *(descriptor.api.cast::<ServiceApi>()) };
        return services().lock().unwrap().register(
            std::str::from_utf8(name).map_err(|_| "invalid extension name")?,
            std::str::from_utf8(version).map_err(|_| "invalid extension version")?,
            api,
        );
    }
    Err("extension is not supported by this core version")
}

fn valid_name(name: &[u8]) -> bool {
    name.first().is_some_and(u8::is_ascii_lowercase)
        && name
            .iter()
            .all(|byte| byte.is_ascii_lowercase() || byte.is_ascii_digit() || *byte == b'-')
}

unsafe fn valid_functions(table: *const std::ffi::c_void, count: usize) -> bool {
    // Check null entries before constructing Rust's non-null function-pointer types.
    (0..count).all(|index| unsafe { table.cast::<usize>().add(index).read() != 0 })
}

impl Registry {
    fn len(&self) -> usize {
        self.services.len()
            + self
                .components
                .keys()
                .filter(|name| !self.services.contains_key(*name))
                .count()
    }

    fn register_package(
        &mut self,
        name: &str,
        version: &str,
        api: abi::PackageApi,
    ) -> Result<(), &'static str> {
        match (self.services.get(name), self.components.get(name)) {
            (Some(service), Some(component))
                if service.version == version
                    && component.version == version
                    && service.api.invoke as usize == api.service.invoke as usize
                    && service.api.shutdown as usize == api.service.shutdown as usize
                    && component.api.create as usize == api.component.create as usize
                    && component.api.update as usize == api.component.update as usize
                    && component.api.render as usize == api.component.render as usize
                    && component.api.event as usize == api.component.event as usize
                    && component.api.destroy as usize == api.component.destroy as usize =>
            {
                return Ok(());
            }
            (None, None) => {}
            _ => return Err("a different extension with this name is already registered"),
        }
        if self.len() >= abi::MAX_EXTENSIONS {
            return Err("native extension registry is full");
        }
        self.services.insert(
            name.to_owned(),
            RegisteredService {
                version: version.to_owned(),
                api: api.service,
            },
        );
        self.components.insert(
            name.to_owned(),
            RegisteredComponent {
                version: version.to_owned(),
                api: api.component,
            },
        );
        Ok(())
    }
    fn register_component(
        &mut self,
        name: &str,
        version: &str,
        api: ComponentApi,
    ) -> Result<(), &'static str> {
        if self.services.contains_key(name) {
            return Err("a different extension with this name is already registered");
        }
        if let Some(current) = self.components.get(name) {
            if current.version != version
                || current.api.create as usize != api.create as usize
                || current.api.update as usize != api.update as usize
                || current.api.render as usize != api.render as usize
                || current.api.event as usize != api.event as usize
                || current.api.destroy as usize != api.destroy as usize
            {
                return Err("a different extension with this name is already registered");
            }
            return Ok(());
        }
        if self.len() >= abi::MAX_EXTENSIONS {
            return Err("native extension registry is full");
        }
        self.components.insert(
            name.to_owned(),
            RegisteredComponent {
                version: version.to_owned(),
                api,
            },
        );
        Ok(())
    }

    fn register(&mut self, name: &str, version: &str, api: ServiceApi) -> Result<(), &'static str> {
        if self.components.contains_key(name) {
            return Err("a different extension with this name is already registered");
        }
        if let Some(current) = self.services.get(name) {
            if current.version != version
                || current.api.invoke as usize != api.invoke as usize
                || current.api.shutdown as usize != api.shutdown as usize
            {
                return Err("a different extension with this name is already registered");
            }
            return Ok(());
        }
        if self.len() >= abi::MAX_EXTENSIONS {
            return Err("native extension registry is full");
        }
        self.services.insert(
            name.to_owned(),
            RegisteredService {
                version: version.to_owned(),
                api,
            },
        );
        Ok(())
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use std::ptr;
    use std::sync::atomic::{AtomicUsize, Ordering};

    static SHUTDOWNS: AtomicUsize = AtomicUsize::new(0);
    unsafe extern "C" fn invoke(_: u32, _: abi::Bytes, _: abi::Bytes, sink: abi::ServiceSink) {
        unsafe { (sink.release)(sink.context) };
    }
    unsafe extern "C" fn shutdown() {
        SHUTDOWNS.fetch_add(1, Ordering::SeqCst);
    }
    unsafe extern "C" fn other_shutdown() {
        SHUTDOWNS.fetch_add(10, Ordering::SeqCst);
    }
    static API: ServiceApi = ServiceApi { invoke, shutdown };

    unsafe extern "C" fn create_component(
        _: abi::Bytes,
        _: abi::Bytes,
        wake: abi::Wake,
        _: *mut std::ffi::c_void,
        _: abi::Reply,
    ) -> *mut std::ffi::c_void {
        unsafe { (wake.release)(wake.context) };
        std::ptr::null_mut()
    }
    unsafe extern "C" fn update_component(_: *mut std::ffi::c_void, _: abi::Bytes) -> i32 {
        0
    }
    unsafe extern "C" fn render_component(
        _: *mut std::ffi::c_void,
        _: abi::Bytes,
        _: *mut std::ffi::c_void,
        _: abi::Reply,
    ) -> i32 {
        0
    }
    unsafe extern "C" fn destroy_component(_: *mut std::ffi::c_void) {}
    unsafe extern "C" fn shutdown_package() {}
    const COMPONENT: ComponentApi = ComponentApi {
        create: create_component,
        update: update_component,
        render: render_component,
        event: render_component,
        destroy: destroy_component,
    };

    #[test]
    fn packages_register_both_capabilities_atomically_and_count_as_one() {
        let mut registry = Registry::default();
        let package = abi::PackageApi {
            component: COMPONENT,
            service: API,
        };
        registry
            .register_package("package", "1.0", package)
            .unwrap();
        registry
            .register_package("package", "1.0", package)
            .unwrap();
        assert_eq!(registry.len(), 1);
        assert!(
            registry.components.contains_key("package")
                && registry.services.contains_key("package")
        );
        assert!(
            registry
                .register_package("package", "2.0", package)
                .is_err()
        );
        assert!(registry.register("package", "1.0", API).is_err());
        assert_eq!(registry.services["package"].version, "1.0");
        for i in 1..abi::MAX_EXTENSIONS {
            registry
                .register(&format!("package-{i}"), "1.0", API)
                .unwrap();
        }
        assert!(
            registry
                .register_package("overflow", "1.0", package)
                .is_err()
        );
        assert!(
            !registry.services.contains_key("overflow")
                && !registry.components.contains_key("overflow")
        );
    }

    #[test]
    fn validates_both_tables_before_registering_a_package() {
        let nulls = [0_usize; 7];
        let package = abi::PackageApi {
            component: COMPONENT,
            service: ServiceApi {
                invoke,
                shutdown: shutdown_package,
            },
        };
        let mut descriptor = Extension {
            abi_version: abi::ABI_VERSION,
            descriptor_size: size_of::<Extension>() as u32,
            kind: abi::PACKAGE_EXTENSION,
            api_size: size_of::<abi::PackageApi>() as u32,
            name: abi::Bytes::new(b"independent-package-test"),
            version: abi::Bytes::new(b"1.0"),
            api: nulls.as_ptr().cast(),
        };
        assert!(
            unsafe {
                register_extension_versioned(&descriptor, b"independent-package-test", b"1.0")
            }
            .is_err()
        );
        assert!(
            component("independent-package-test").is_none()
                && service("independent-package-test").is_none()
        );
        descriptor.api = (&package as *const abi::PackageApi).cast();
        unsafe { register_extension_versioned(&descriptor, b"independent-package-test", b"1.0") }
            .unwrap();
        assert!(
            component("independent-package-test").is_some()
                && service("independent-package-test").is_some()
        );
    }

    #[test]
    fn accepts_independent_services_without_extension_specific_core_code() {
        let descriptor = Extension {
            abi_version: abi::ABI_VERSION,
            descriptor_size: size_of::<Extension>() as u32,
            kind: abi::SERVICE_EXTENSION,
            api_size: size_of::<ServiceApi>() as u32,
            name: abi::Bytes::new(b"independent-test-extension"),
            version: abi::Bytes::new(b"7.2.1"),
            api: ptr::addr_of!(API).cast(),
        };
        assert!(
            unsafe {
                register_extension_versioned(&descriptor, b"independent-test-extension", b"7.2.0")
            }
            .is_err()
        );
        for _ in 0..2 {
            unsafe {
                register_extension_versioned(&descriptor, b"independent-test-extension", b"7.2.1")
            }
            .unwrap();
        }
        assert_eq!(
            service("independent-test-extension").unwrap().invoke as usize,
            invoke as *const () as usize
        );
        assert!(service("unknown-test-extension").is_none());
        shutdown_services();
        assert_eq!(SHUTDOWNS.load(Ordering::SeqCst), 1);
    }

    #[test]
    fn bounds_registry_and_rejects_conflicting_versions_and_tables() {
        let mut registry = Registry::default();
        registry.register("one", "1.0.0", API).unwrap();
        registry.register("one", "1.0.0", API).unwrap();
        assert!(registry.register("one", "2.0.0", API).is_err());
        assert!(
            registry
                .register(
                    "one",
                    "1.0.0",
                    ServiceApi {
                        invoke,
                        shutdown: other_shutdown
                    }
                )
                .is_err()
        );
        for i in 1..abi::MAX_EXTENSIONS {
            registry
                .register(&format!("extension-{i}"), "1.0.0", API)
                .unwrap();
        }
        assert!(registry.register("overflow", "1.0.0", API).is_err());
    }

    #[test]
    fn rejects_invalid_service_names_kinds_and_null_callbacks() {
        let nulls = [0_usize; 2];
        let mut descriptor = Extension {
            abi_version: abi::ABI_VERSION,
            descriptor_size: size_of::<Extension>() as u32,
            kind: abi::SERVICE_EXTENSION,
            api_size: size_of::<ServiceApi>() as u32,
            name: abi::Bytes::new(b"extension/escape"),
            version: abi::Bytes::new(b"1.0.0"),
            api: ptr::addr_of!(API).cast(),
        };
        assert!(
            unsafe { register_extension_versioned(&descriptor, b"extension/escape", b"1.0.0") }
                .is_err()
        );
        descriptor.name = abi::Bytes::new(b"extension");
        descriptor.api = nulls.as_ptr().cast();
        assert_eq!(
            unsafe { register_extension_versioned(&descriptor, b"extension", b"1.0.0") },
            Err("service extension function table mismatch")
        );
        descriptor.api = ptr::addr_of!(API).cast();
        descriptor.kind = 999;
        assert!(
            unsafe { register_extension_versioned(&descriptor, b"extension", b"1.0.0") }.is_err()
        );
    }

    #[test]
    fn rejects_header_before_reading_an_unknown_descriptor_layout() {
        let header = [abi::ABI_VERSION + 1, 8];
        assert!(unsafe { register_extension(header.as_ptr().cast(), b"terminal") }.is_err());
        let short = [abi::ABI_VERSION, 8];
        assert!(unsafe { register_extension(short.as_ptr().cast(), b"terminal") }.is_err());
        assert!(unsafe { register_extension(ptr::null(), b"terminal") }.is_err());
    }
}