systemless 0.122.1

High-Level Emulation for classic Macintosh applications
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
//! Device health and bounded desktop recovery; guest state stays with its owner.
use super::*;
use std::sync::{
    atomic::{AtomicBool, Ordering},
    Arc, Mutex,
};

/// Preserve hardware/driver identity alongside qualification logs, even if
/// presenter creation subsequently falls back and releases the adapter.
pub(super) fn report_adapter(info: &wgpu::AdapterInfo) {
    eprintln!(
        "[GPU-ADAPTER] {}",
        serde_json::json!({
            "name": info.name, "backend": format!("{:?}", info.backend),
            "device_type": format!("{:?}", info.device_type),
            "vendor": info.vendor, "device": info.device,
            "driver": info.driver, "driver_info": info.driver_info,
        })
    );
}

/// Dropping a wgpu queue waits for idle. Known-failed compute state must not
/// perform that potentially unbounded driver operation on the guest owner.
pub(super) fn retire_compute<T: Send + 'static>(state: T) {
    retire_with(state, |cleanup| {
        std::thread::Builder::new()
            .name("gpu-cleanup".into())
            .spawn(cleanup)
            .map(|_| ())
    });
}

fn retire_with<T: Send + 'static>(
    state: T,
    spawn: impl FnOnce(Box<dyn FnOnce() + Send>) -> std::io::Result<()>,
) {
    let retired = Arc::new(Mutex::new(Some(state)));
    let worker = retired.clone();
    if let Err(error) = spawn(Box::new(move || {
        let state = worker.lock().unwrap_or_else(|e| e.into_inner()).take();
        drop(state);
    })) {
        // Failure to create a worker must not run the same blocking destructor
        // here. One quarantined state per failed renderer remains until exit;
        // its sticky CPU fallback prevents further GPU initialization attempts.
        std::mem::forget(retired);
        eprintln!(
            "[GPU] Cannot start cleanup worker; retaining failed compute state until exit: {error}"
        );
    }
}

#[derive(Clone, Debug)]
pub(super) struct Failure {
    pub recoverable: bool,
    pub message: String,
}
impl Failure {
    pub fn lost(message: impl Into<String>) -> Self {
        Self {
            recoverable: true,
            message: message.into(),
        }
    }
}
impl From<String> for Failure {
    fn from(message: String) -> Self {
        Self {
            recoverable: false,
            message,
        }
    }
}
impl std::fmt::Display for Failure {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.write_str(&self.message)
    }
}

impl systemless::gpu_compute::ComputeHealth for Health {
    fn check(&self) -> Result<(), String> {
        Health::check(self).map_err(|error| error.to_string())
    }
    fn record(&self, error: String) {
        Health::record(self, Failure::from(error));
    }
    fn wait_readback(&self, device: &wgpu::Device) -> Result<(), String> {
        Health::wait_readback(self, device)
    }
}

pub(super) struct Health {
    readback_budget: std::time::Duration,
    failed: AtomicBool,
    failure: Mutex<Option<Failure>>,
    wake: Option<winit::event_loop::EventLoopProxy<()>>,
}
impl Health {
    pub fn install(
        device: &wgpu::Device,
        wake: Option<winit::event_loop::EventLoopProxy<()>>,
    ) -> Arc<Self> {
        let health = Arc::new(Self {
            readback_budget: super::wgpu_buffers::readback_budget(device),
            failed: AtomicBool::new(false),
            failure: Mutex::new(None),
            wake,
        });
        let lost = health.clone();
        device.set_device_lost_callback(move |reason, message| {
            // Dropping/replacing an owner intentionally destroys its device.
            if reason != wgpu::DeviceLostReason::Destroyed {
                lost.record(Failure::lost(format!("wgpu device lost: {message}")));
            }
        });
        let errors = health.clone();
        device.on_uncaptured_error(Arc::new(move |error| {
            errors.record(Failure::from(format!("wgpu error: {error}")));
        }));
        health
    }
    pub(super) fn record(&self, error: Failure) {
        let mut failure = self.failure.lock().unwrap_or_else(|e| e.into_inner());
        // Preserve a terminal error if a subsequent loss notification arrives.
        if failure
            .as_ref()
            .is_none_or(|old| old.recoverable && !error.recoverable)
        {
            *failure = Some(error);
        }
        self.failed.store(true, Ordering::Release);
        drop(failure);
        if let Some(wake) = &self.wake {
            let _ = wake.send_event(());
        }
    }
    pub fn wait_readback(&self, device: &wgpu::Device) -> Result<(), String> {
        self.finish_readback(super::wgpu_buffers::wait_for_readback(
            device,
            self.readback_budget,
        ))
    }

    pub(super) fn finish_readback(
        &self,
        result: Result<wgpu::PollStatus, wgpu::PollError>,
    ) -> Result<(), String> {
        if let Err(error) = result {
            // A timeout need not produce a device-lost callback. Quarantine
            // this compute state rather than retrying a stalled queue per frame.
            self.record(Failure::from(format!("GPU readback failed: {error}")));
        }
        self.check().map_err(|error| error.to_string())
    }

    pub fn check(&self) -> Result<(), Failure> {
        if !self.failed.load(Ordering::Acquire) {
            return Ok(());
        }
        Err(self
            .failure
            .lock()
            .unwrap_or_else(|e| e.into_inner())
            .as_ref()
            .unwrap()
            .clone())
    }
}

#[derive(Default)]
pub(super) struct Recovery {
    pub rebuilds: u8,
    pub fallback: Option<String>,
}
impl Recovery {
    fn rebuild(&mut self, error: &Failure) -> bool {
        // A session budget, not a consecutive-failure budget: even a device
        // which fails after each successful frame cannot loop forever.
        if error.recoverable && self.rebuilds < 2 {
            self.rebuilds += 1;
            true
        } else {
            false
        }
    }
}

impl App {
    pub(super) fn create_wgpu_presenter(&self) -> Result<wgpu_present::WgpuPresenter, String> {
        #[cfg(feature = "test-support")]
        if std::env::var_os("SYSTEMLESS_NATIVE_WINDOW_PROBE").is_some() {
            let fault = std::env::var("SYSTEMLESS_GPU_FAULT").unwrap_or_default();
            if matches!(fault.as_str(), "startup" | "platform-startup")
                || (fault == "recreate" && self.wgpu_recovery.rebuilds > 0)
            {
                return Err("qualification: injected presenter creation failure".to_owned());
            }
        }
        wgpu_present::WgpuPresenter::new(
            self.window.as_ref().ok_or("window unavailable")?.clone(),
            self.wgpu_display
                .as_ref()
                .ok_or("display unavailable")?
                .clone(),
            self.wgpu_wake.clone(),
        )
    }
    pub(super) fn create_platform_presenter(&mut self) -> Result<(), String> {
        let window = self.window.as_ref().ok_or("window unavailable")?.clone();
        #[cfg(all(feature = "test-support", not(target_os = "macos")))]
        if !self.use_software
            && std::env::var_os("SYSTEMLESS_NATIVE_WINDOW_PROBE").is_some()
            && matches!(
                std::env::var("SYSTEMLESS_GPU_FAULT")
                    .unwrap_or_default()
                    .as_str(),
                "platform-startup" | "platform-fatal"
            )
        {
            return Err("qualification: injected platform creation failure".into());
        }
        #[cfg(target_os = "macos")]
        {
            self.surface = Some(super::mac_present::Presenter::new(
                window,
                self.use_software,
            )?);
        }
        #[cfg(not(target_os = "macos"))]
        {
            #[cfg(target_os = "windows")]
            if !self.use_software
                && std::env::var_os("SYSTEMLESS_D3D11").as_deref()
                    != Some(std::ffi::OsStr::new("0"))
            {
                match d3d_present::D3dPresenter::new(
                    window.clone(),
                    self.gpu_wake
                        .as_ref()
                        .ok_or("display wake unavailable")?
                        .clone(),
                ) {
                    Ok(gpu) => {
                        self.gpu = Some(gpu);
                        return Ok(());
                    }
                    Err(error) => eprintln!("[GPU] {error}; using software presentation"),
                }
            }
            let context = softbuffer::Context::new(window.clone()).map_err(|e| e.to_string())?;
            self.surface = Some(Surface::new(&context, window).map_err(|e| e.to_string())?);
            self.surface_size = None;
        }
        Ok(())
    }
    pub(super) fn stop_renderer(&mut self, error: String) {
        eprintln!("[GPU] {error}");
        self.runtime_error = Some(error);
        self.closing = true;
        if let Some(owner) = &self.owner {
            owner.mailbox.request_shutdown();
        }
        if let Some(mut driver) = self.driver.take() {
            driver.sync_save_files(true);
        }
        self.show_runtime_error();
    }
    pub(super) fn recover_wgpu(&mut self, error: Failure) {
        // Destroy the old surface before a replacement claims the native view.
        self.wgpu = None;
        self.last_presented_guest_tick = None;
        self.force_next_render = true;
        #[cfg(target_os = "macos")]
        {
            self.force_gpu_present = true;
        }
        if self.wgpu_recovery.rebuild(&error) {
            match self.create_wgpu_presenter() {
                Ok(gpu) => {
                    eprintln!(
                        "[GPU] {}; recreated wgpu presenter ({}/2)",
                        error, self.wgpu_recovery.rebuilds
                    );
                    self.wgpu = Some(gpu);
                }
                Err(message) => {
                    self.fallback_wgpu(format!("{error}; recreation failed: {message}"))
                }
            }
        } else {
            self.fallback_wgpu(error.to_string());
        }
        if let Some(window) = &self.window {
            window.request_redraw();
        }
    }
    pub(super) fn fallback_wgpu(&mut self, message: String) {
        self.wgpu = None;
        self.use_wgpu = false;
        self.use_software = self.gpu_fallback == renderer_selection::GpuFallback::Software;
        self.wgpu_recovery.fallback = Some(message.clone());
        self.force_next_render = true;
        eprintln!(
            "[GPU] {message}; switching to {} presentation",
            self.gpu_fallback.name()
        );
        let result = create_fallback_presenter(self.use_software, |software| {
            self.use_software = software;
            self.create_platform_presenter()
        });
        match result {
            Ok(Some(platform_error)) => {
                self.wgpu_recovery.fallback = Some(format!(
                    "{message}; platform fallback failed: {platform_error}"
                ));
            }
            Ok(None) => {}
            Err(error) => self.stop_renderer(format!(
                "GPU fallback failed: {error} (original failure: {message})"
            )),
        }
    }
    pub(super) fn check_wgpu_health(&mut self) -> bool {
        if let Some(error) = self.wgpu.as_ref().and_then(|gpu| gpu.check_health().err()) {
            self.recover_wgpu(error);
            true
        } else {
            false
        }
    }
}

/// Keep software as the final recovery option when a platform GPU is unusable.
/// Explicit software selection makes only one attempt.
fn create_fallback_presenter(
    software: bool,
    mut create: impl FnMut(bool) -> Result<(), String>,
) -> Result<Option<String>, String> {
    match create(software) {
        Ok(()) => Ok(None),
        Err(error) if software => Err(error),
        Err(platform_error) => {
            eprintln!(
                "[GPU] platform fallback failed: {platform_error}; trying software presentation"
            );
            create(true)
                .map(|()| Some(platform_error.clone()))
                .map_err(|software_error| {
                    format!("platform: {platform_error}; software: {software_error}")
                })
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    #[test]
    fn platform_fallback_failure_tries_software_and_preserves_diagnostic() {
        let mut attempts = Vec::new();
        let result = create_fallback_presenter(false, |software| {
            attempts.push(software);
            if software {
                Ok(())
            } else {
                Err("Metal unavailable".into())
            }
        });
        assert_eq!(attempts, [false, true]);
        assert_eq!(result, Ok(Some("Metal unavailable".into())));
    }
    #[test]
    fn fallback_exhaustion_preserves_both_errors_without_retrying() {
        let mut attempts = Vec::new();
        let result = create_fallback_presenter(false, |software| {
            attempts.push(software);
            Err(if software {
                "software unavailable"
            } else {
                "Metal unavailable"
            }
            .into())
        });
        assert_eq!(attempts, [false, true]);
        assert_eq!(
            result,
            Err("platform: Metal unavailable; software: software unavailable".into())
        );
    }
    #[test]
    fn healthy_platform_and_explicit_software_each_make_one_attempt() {
        for software in [false, true] {
            let mut attempts = Vec::new();
            assert_eq!(
                create_fallback_presenter(software, |selected| {
                    attempts.push(selected);
                    Ok(())
                }),
                Ok(None)
            );
            assert_eq!(attempts, [software]);
        }
        let mut attempts = 0;
        assert_eq!(
            create_fallback_presenter(true, |_| {
                attempts += 1;
                Err("software unavailable".into())
            }),
            Err("software unavailable".into())
        );
        assert_eq!(attempts, 1);
    }
    #[test]
    fn wgpu_failed_compute_cleanup_does_not_block_the_owner() {
        let (release, waiting) = std::sync::mpsc::channel();
        let (entered, started) = std::sync::mpsc::channel();
        let (finished, done) = std::sync::mpsc::channel();
        struct BlockingDrop {
            waiting: std::sync::mpsc::Receiver<()>,
            entered: std::sync::mpsc::Sender<()>,
            finished: std::sync::mpsc::Sender<()>,
        }
        impl Drop for BlockingDrop {
            fn drop(&mut self) {
                let _ = self.entered.send(());
                let _ = self.waiting.recv();
                let _ = self.finished.send(());
            }
        }
        let (returned, owner_returned) = std::sync::mpsc::channel();
        let owner = std::thread::spawn(move || {
            retire_compute(BlockingDrop {
                waiting,
                entered,
                finished,
            });
            returned.send(()).unwrap();
        });
        let timeout = std::time::Duration::from_secs(5);
        owner_returned
            .recv_timeout(timeout)
            .expect("owner must return while cleanup is blocked");
        started
            .recv_timeout(timeout)
            .expect("cleanup worker entered destructor");
        release.send(()).unwrap();
        done.recv_timeout(timeout)
            .expect("cleanup completes when driver makes progress");
        owner.join().unwrap();
    }

    #[test]
    fn wgpu_cleanup_worker_creation_failure_does_not_drop_on_the_owner() {
        struct DropFlag(Arc<AtomicBool>);
        impl Drop for DropFlag {
            fn drop(&mut self) {
                self.0.store(true, Ordering::Release);
            }
        }
        let dropped = Arc::new(AtomicBool::new(false));
        retire_with(DropFlag(dropped.clone()), |_| {
            Err(std::io::Error::other("injected worker failure"))
        });
        assert!(!dropped.load(Ordering::Acquire));
        // This intentionally retains a tiny guard, exactly as the production
        // failure path must retain a driver resource whose destructor can hang.
    }

    #[test]
    fn gpu_uncaptured_validation_error_is_reported_without_panicking() {
        let instance = wgpu::Instance::default();
        let adapter = match pollster::block_on(instance.request_adapter(&Default::default())) {
            Ok(adapter) => adapter,
            Err(error) => {
                assert!(
                    std::env::var_os("SYSTEMLESS_REQUIRE_GPU").is_none(),
                    "GPU required: {error}"
                );
                return;
            }
        };
        let (device, _) = pollster::block_on(adapter.request_device(&Default::default())).unwrap();
        let health = Health::install(&device, None);
        // MAP_READ cannot be combined with VERTEX without the optional mapping feature.
        let _invalid = device.create_buffer(&wgpu::BufferDescriptor {
            label: Some("qualification invalid usage"),
            size: 16,
            usage: wgpu::BufferUsages::MAP_READ | wgpu::BufferUsages::VERTEX,
            mapped_at_creation: false,
        });
        let error = health.check().expect_err("uncaptured validation callback");
        assert!(!error.recoverable);
        assert!(error.message.contains("wgpu error"));
    }
    #[test]
    fn gpu_recovery_budget_survives_successful_frames_and_terminal_errors() {
        let mut policy = Recovery::default();
        assert!(policy.rebuild(&Failure::lost("surface lost")));
        assert!(policy.rebuild(&Failure::lost("device lost after a successful frame")));
        assert!(!policy.rebuild(&Failure::lost("flapping device")));
        assert!(!Recovery::default().rebuild(&Failure::from("out of memory".to_owned())));
    }
    #[test]
    fn gpu_health_preserves_terminal_failure_over_later_loss() {
        let health = Health {
            readback_budget: std::time::Duration::from_secs(5),
            failed: AtomicBool::new(false),
            failure: Mutex::new(None),
            wake: None,
        };
        assert!(health.check().is_ok());
        health.record(Failure::lost("lost"));
        assert!(health.check().unwrap_err().recoverable);
        health.record(Failure::from("memory failure".to_owned()));
        health.record(Failure::lost("subsequent loss"));
        assert_eq!(health.check().unwrap_err().message, "memory failure");
    }
}