systemless 0.110.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
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
//! Opt-in portable desktop presentation. Guest memory remains authoritative.
use super::renderer_recovery::{Failure, Health};
use std::rc::Rc;
use winit::window::Window;

struct CompactFrame {
    image: std::sync::Arc<systemless::systems::macintosh::memory::CompactPresentation>,
    crop: (u32, u32, u32, u32),
    output: (u32, u32),
}

impl CompactFrame {
    fn matches(
        &self,
        image: &std::sync::Arc<systemless::systems::macintosh::memory::CompactPresentation>,
        crop: (u32, u32, u32, u32),
        output: (u32, u32),
    ) -> bool {
        std::sync::Arc::ptr_eq(&self.image, image) && self.crop == crop && self.output == output
    }
}

pub(super) fn request_device(
    adapter: &wgpu::Adapter,
) -> Result<(wgpu::Device, wgpu::Queue), String> {
    // UMA adapters can upload into the same validated buffers the fragment
    // shader reads, avoiding a staging allocation and GPU copy per packet.
    let shared = matches!(
        adapter.get_info().device_type,
        wgpu::DeviceType::IntegratedGpu | wgpu::DeviceType::Cpu
    );
    let required_features = if shared {
        adapter.features() & wgpu::Features::MAPPABLE_PRIMARY_BUFFERS
    } else {
        wgpu::Features::empty()
    };
    pollster::block_on(adapter.request_device(&wgpu::DeviceDescriptor {
        required_features,
        ..Default::default()
    }))
    .map_err(|error| error.to_string())
}

fn raster_format() -> wgpu::TextureFormat {
    if cfg!(target_endian = "little") {
        wgpu::TextureFormat::Bgra8Unorm
    } else {
        wgpu::TextureFormat::Rgba8Unorm
    }
}

fn raster_upload<'a>(pixels: &'a [u32], _bytes: &'a mut Vec<u8>) -> &'a [u8] {
    #[cfg(target_endian = "little")]
    {
        super::wgpu_buffers::word_bytes(pixels)
    }
    #[cfg(target_endian = "big")]
    {
        _bytes.clear();
        _bytes.extend(
            pixels
                .iter()
                .flat_map(|p| [(*p >> 16) as u8, (*p >> 8) as u8, *p as u8, 255]),
        );
        _bytes
    }
}

pub struct WgpuPresenter {
    // Drop the surface before its owning window; raw handles never escape this owner.
    surface: wgpu::Surface<'static>,
    _window: Rc<Window>,
    health: std::sync::Arc<Health>,
    next_health_poll: std::cell::Cell<std::time::Instant>,
    device: wgpu::Device,
    queue: wgpu::Queue,
    config: wgpu::SurfaceConfiguration,
    pipeline: wgpu::RenderPipeline,
    geometry: wgpu::Buffer,
    raster_geometry: Option<[u32; 8]>,
    image: Option<(wgpu::Texture, wgpu::BindGroup)>,
    bytes: Vec<u8>,
    compact: super::wgpu_compact::CompactRenderer,
    last_compact: Option<CompactFrame>,
}

fn pipeline(device: &wgpu::Device, format: wgpu::TextureFormat) -> wgpu::RenderPipeline {
    pipeline_with_shader(device, format, include_str!("wgpu_present.wgsl"))
}

pub(super) fn pipeline_with_shader(
    device: &wgpu::Device,
    format: wgpu::TextureFormat,
    source: &str,
) -> wgpu::RenderPipeline {
    let shader = device.create_shader_module(wgpu::ShaderModuleDescriptor {
        label: Some("desktop presentation"),
        source: wgpu::ShaderSource::Wgsl(source.into()),
    });
    pipeline_with_module(device, format, &shader, None, &[])
}

pub(super) fn pipeline_with_module(
    device: &wgpu::Device,
    format: wgpu::TextureFormat,
    shader: &wgpu::ShaderModule,
    layout: Option<&wgpu::PipelineLayout>,
    constants: &[(&str, f64)],
) -> wgpu::RenderPipeline {
    device.create_render_pipeline(&wgpu::RenderPipelineDescriptor {
        label: Some("desktop presentation"),
        layout,
        vertex: wgpu::VertexState {
            module: shader,
            entry_point: Some("vs"),
            compilation_options: Default::default(),
            buffers: &[],
        },
        primitive: Default::default(),
        depth_stencil: None,
        multisample: Default::default(),
        fragment: Some(wgpu::FragmentState {
            module: shader,
            entry_point: Some("fs"),
            compilation_options: wgpu::PipelineCompilationOptions {
                constants,
                ..Default::default()
            },
            targets: &[Some(wgpu::ColorTargetState {
                format,
                blend: None,
                write_mask: wgpu::ColorWrites::ALL,
            })],
        }),
        multiview_mask: None,
        cache: None,
    })
}

impl WgpuPresenter {
    pub fn new(
        window: Rc<Window>,
        display: winit::event_loop::OwnedDisplayHandle,
        wake: Option<winit::event_loop::EventLoopProxy<()>>,
    ) -> Result<Self, String> {
        let instance = wgpu::Instance::new(wgpu::InstanceDescriptor::new_with_display_handle(
            Box::new(display.clone()),
        ));
        // SAFETY: the Rc below owns the window until after surface destruction.
        // Creation, use, and destruction all occur on the window's event-loop thread.
        let surface = unsafe {
            let target = wgpu::SurfaceTargetUnsafe::from_window(window.as_ref())
                .map_err(|e| e.to_string())?;
            instance
                .create_surface_unsafe(target)
                .map_err(|e| e.to_string())?
        };
        let adapter = pollster::block_on(instance.request_adapter(&wgpu::RequestAdapterOptions {
            compatible_surface: Some(&surface),
            ..Default::default()
        }))
        .map_err(|e| e.to_string())?;
        super::renderer_recovery::report_adapter(&adapter.get_info());
        let (device, queue) = request_device(&adapter)?;
        let health = Health::install(&device, wake);
        let mut config = surface
            .get_default_config(&adapter, 1, 1)
            .ok_or("surface has no supported configuration")?;
        // Guest RGB values already include Macintosh gamma; avoid a second sRGB encoding.
        config.format = surface
            .get_capabilities(&adapter)
            .formats
            .into_iter()
            .find(|f| !f.is_srgb())
            .ok_or("surface has no unorm format")?;
        config.present_mode = wgpu::PresentMode::AutoVsync;
        config.width = 0;
        config.height = 0;
        let pipeline = pipeline(&device, config.format);
        let geometry = device.create_buffer(&wgpu::BufferDescriptor {
            label: Some("desktop geometry"),
            size: 32,
            usage: wgpu::BufferUsages::UNIFORM | wgpu::BufferUsages::COPY_DST,
            mapped_at_creation: false,
        });
        eprintln!(
            "[GPU] wgpu {:?}: {}",
            adapter.get_info().backend,
            adapter.get_info().name
        );
        let compact = super::wgpu_compact::CompactRenderer::new(&device, &queue, config.format);
        health.check().map_err(|e| e.to_string())?;
        Ok(Self {
            health,
            next_health_poll: std::cell::Cell::new(std::time::Instant::now()),
            last_compact: None,
            raster_geometry: None,
            compact,
            surface,
            _window: window,
            device,
            queue,
            config,
            pipeline,
            geometry,
            image: None,
            bytes: Vec::new(),
        })
    }

    #[cfg(feature = "test-support")]
    pub(super) fn inject_failure(&self, failure: Failure) {
        self.health.record(failure);
    }

    #[cfg(feature = "test-support")]
    pub(super) fn resource_snapshot(&self) -> serde_json::Value {
        let mut report = super::gpu_resources::snapshot(&self.device);
        report["shared_pool"] = self.compact.shared_resource_snapshot().into();
        report
    }

    pub fn check_health(&self) -> Result<(), Failure> {
        let now = std::time::Instant::now();
        if now >= self.next_health_poll.get() {
            self.next_health_poll
                .set(now + std::time::Duration::from_millis(250));
            if let Err(error) = self.device.poll(wgpu::PollType::Poll) {
                self.health
                    .record(Failure::lost(format!("wgpu maintenance failed: {error}")));
            }
        }
        self.health.check()
    }

    fn acquire(&mut self, output: (u32, u32)) -> Result<Option<wgpu::SurfaceTexture>, Failure> {
        self.check_health()?;
        if output.0 == 0 || output.1 == 0 {
            return Ok(None);
        }
        let limit = self.device.limits().max_texture_dimension_2d;
        if output.0 > limit || output.1 > limit {
            return Err(
                format!("GPU drawable exceeds the adapter texture limit of {limit}").into(),
            );
        }
        if self.config.width != output.0 || self.config.height != output.1 {
            self.config.width = output.0;
            self.config.height = output.1;
            self.surface.configure(&self.device, &self.config);
            self.last_compact = None;
        }
        let frame = match self.surface.get_current_texture() {
            wgpu::CurrentSurfaceTexture::Success(frame)
            | wgpu::CurrentSurfaceTexture::Suboptimal(frame) => frame,
            wgpu::CurrentSurfaceTexture::Outdated => {
                self.surface.configure(&self.device, &self.config);
                self.last_compact = None;
                return Ok(None);
            }
            wgpu::CurrentSurfaceTexture::Timeout | wgpu::CurrentSurfaceTexture::Occluded => {
                return Ok(None);
            }
            wgpu::CurrentSurfaceTexture::Lost => {
                return Err(Failure::lost("wgpu surface lost"));
            }
            wgpu::CurrentSurfaceTexture::Validation => {
                return Err(Failure::from("wgpu surface validation failed".to_owned()));
            }
        };
        Ok(Some(frame))
    }

    pub fn invalidate(&mut self) {
        self.last_compact = None;
    }

    pub fn present_compact(
        &mut self,
        image: &std::sync::Arc<systemless::systems::macintosh::memory::CompactPresentation>,
        crop: (u32, u32, u32, u32),
        output: (u32, u32),
    ) -> Result<Option<bool>, Failure> {
        self.check_health()?;
        // Immutable packets may be reused for idle frontend frames. A host
        // expose/resize or a raster overlay invalidates this successful frame.
        if self
            .last_compact
            .as_ref()
            .is_some_and(|last| last.matches(image, crop, output))
        {
            return Ok(Some(true));
        }
        let viewport = super::aspect_fit_dimensions(crop.2, crop.3, output.0, output.1);
        if !self
            .compact
            .prepare(image, crop, viewport, &self.device.limits())
        {
            return Ok(None);
        }
        let Some(frame) = self.acquire(output)? else {
            return Ok(Some(false));
        };
        self.compact.encode(
            &self.device,
            &self.queue,
            image,
            crop,
            viewport,
            &frame.texture.create_view(&Default::default()),
        );
        self.check_health()?;
        self.queue.present(frame);
        self.check_health()?;
        self.last_compact = Some(CompactFrame {
            image: image.clone(),
            crop,
            output,
        });
        Ok(Some(true))
    }

    pub fn present(
        &mut self,
        pixels: &[u32],
        size: (u32, u32),
        crop: (u32, u32, u32, u32),
        output: (u32, u32),
    ) -> Result<bool, Failure> {
        self.check_health()?;
        if output.0 == 0 || output.1 == 0 {
            return Ok(false);
        }
        let limit = self.device.limits().max_texture_dimension_2d;
        if size.0 > limit || size.1 > limit || output.0 > limit || output.1 > limit {
            return Err(format!("GPU frame exceeds the adapter texture limit of {limit}").into());
        }
        if size.0 == 0
            || size.1 == 0
            || pixels.len() != size.0 as usize * size.1 as usize
            || crop.2 == 0
            || crop.3 == 0
            || crop.0.checked_add(crop.2).is_none_or(|x| x > size.0)
            || crop.1.checked_add(crop.3).is_none_or(|y| y > size.1)
        {
            return Err(Failure::from("invalid GPU frame geometry".to_owned()));
        }
        let Some(frame) = self.acquire(output)? else {
            return Ok(false);
        };
        if self
            .image
            .as_ref()
            .is_none_or(|(image, _)| image.width() != size.0 || image.height() != size.1)
        {
            let texture = self.device.create_texture(&wgpu::TextureDescriptor {
                label: Some("desktop RGB"),
                size: wgpu::Extent3d {
                    width: size.0,
                    height: size.1,
                    depth_or_array_layers: 1,
                },
                mip_level_count: 1,
                sample_count: 1,
                dimension: wgpu::TextureDimension::D2,
                format: raster_format(),
                usage: wgpu::TextureUsages::COPY_DST | wgpu::TextureUsages::TEXTURE_BINDING,
                view_formats: &[],
            });
            let group = self.device.create_bind_group(&wgpu::BindGroupDescriptor {
                label: Some("desktop image"),
                layout: &self.pipeline.get_bind_group_layout(0),
                entries: &[
                    wgpu::BindGroupEntry {
                        binding: 0,
                        resource: wgpu::BindingResource::TextureView(
                            &texture.create_view(&Default::default()),
                        ),
                    },
                    wgpu::BindGroupEntry {
                        binding: 1,
                        resource: self.geometry.as_entire_binding(),
                    },
                ],
            });
            self.image = Some((texture, group));
        }
        let bytes = raster_upload(pixels, &mut self.bytes);
        let (image, group) = self.image.as_ref().unwrap();
        self.queue.write_texture(
            image.as_image_copy(),
            bytes,
            wgpu::TexelCopyBufferLayout {
                offset: 0,
                bytes_per_row: Some(size.0 * 4),
                rows_per_image: Some(size.1),
            },
            image.size(),
        );
        let rect = super::aspect_fit_dimensions(crop.2, crop.3, output.0, output.1);
        let words = [
            crop.0, crop.1, crop.2, crop.3, rect.0, rect.1, rect.2, rect.3,
        ];
        if self.raster_geometry != Some(words) {
            self.queue
                .write_buffer(&self.geometry, 0, super::wgpu_buffers::word_bytes(&words));
            self.raster_geometry = Some(words);
        }
        let view = frame.texture.create_view(&Default::default());
        let mut encoder = self.device.create_command_encoder(&Default::default());
        {
            let mut pass = encoder.begin_render_pass(&wgpu::RenderPassDescriptor {
                label: Some("desktop"),
                color_attachments: &[Some(wgpu::RenderPassColorAttachment {
                    view: &view,
                    depth_slice: None,
                    resolve_target: None,
                    ops: wgpu::Operations {
                        load: wgpu::LoadOp::Clear(wgpu::Color::BLACK),
                        store: wgpu::StoreOp::Store,
                    },
                })],
                depth_stencil_attachment: None,
                timestamp_writes: None,
                occlusion_query_set: None,
                multiview_mask: None,
            });
            pass.set_pipeline(&self.pipeline);
            pass.set_bind_group(0, group, &[]);
            pass.set_viewport(
                rect.0 as f32,
                rect.1 as f32,
                rect.2 as f32,
                rect.3 as f32,
                0.,
                1.,
            );
            pass.draw(0..3, 0..1);
        }
        self.queue.submit([encoder.finish()]);
        self.check_health()?;
        self.queue.present(frame);
        self.check_health()?;
        self.last_compact = None;
        Ok(true)
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use wgpu::util::DeviceExt;

    #[test]
    fn unchanged_compact_frames_require_the_same_packet_crop_and_output() {
        let image = std::sync::Arc::new(
            systemless::systems::macintosh::memory::CompactPresentation::default(),
        );
        let frame = CompactFrame {
            image: image.clone(),
            crop: (0, 0, 640, 480),
            output: (800, 600),
        };
        assert!(frame.matches(&image, frame.crop, frame.output));
        assert!(!frame.matches(&image, (1, 0, 639, 480), frame.output));
        assert!(!frame.matches(&image, frame.crop, (1024, 768)));
        let replacement = std::sync::Arc::new((*image).clone());
        assert!(!frame.matches(&replacement, frame.crop, frame.output));
    }

    #[test]
    fn gpu_readback_preserves_rgb_crop_orientation_and_letterboxing() {
        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}"
                );
                eprintln!("SKIP GPU readback: {error}");
                return;
            }
        };
        let (device, queue) =
            pollster::block_on(adapter.request_device(&Default::default())).unwrap();
        let pipeline = pipeline(&device, wgpu::TextureFormat::Rgba8Unorm);
        let source = device.create_texture(&wgpu::TextureDescriptor {
            label: None,
            size: wgpu::Extent3d {
                width: 3,
                height: 2,
                depth_or_array_layers: 1,
            },
            mip_level_count: 1,
            sample_count: 1,
            dimension: wgpu::TextureDimension::D2,
            format: raster_format(),
            usage: wgpu::TextureUsages::COPY_DST | wgpu::TextureUsages::TEXTURE_BINDING,
            view_formats: &[],
        });
        // Crop the first column; all four remaining colors must retain their position.
        queue.write_texture(
            source.as_image_copy(),
            raster_upload(
                &[
                    0x00636363, 0x00123456, 0x00ff0000, 0x00636363, 0x0000ff00, 0x000000ff,
                ],
                &mut Vec::new(),
            ),
            wgpu::TexelCopyBufferLayout {
                offset: 0,
                bytes_per_row: Some(12),
                rows_per_image: Some(2),
            },
            source.size(),
        );
        let words = [1u32, 0, 2, 2, 1, 0, 2, 2];
        let bytes: Vec<u8> = words.into_iter().flat_map(u32::to_ne_bytes).collect();
        let geometry = device.create_buffer_init(&wgpu::util::BufferInitDescriptor {
            label: None,
            contents: &bytes,
            usage: wgpu::BufferUsages::UNIFORM,
        });
        let group = device.create_bind_group(&wgpu::BindGroupDescriptor {
            label: None,
            layout: &pipeline.get_bind_group_layout(0),
            entries: &[
                wgpu::BindGroupEntry {
                    binding: 0,
                    resource: wgpu::BindingResource::TextureView(
                        &source.create_view(&Default::default()),
                    ),
                },
                wgpu::BindGroupEntry {
                    binding: 1,
                    resource: geometry.as_entire_binding(),
                },
            ],
        });
        let target = device.create_texture(&wgpu::TextureDescriptor {
            label: None,
            size: wgpu::Extent3d {
                width: 4,
                height: 2,
                depth_or_array_layers: 1,
            },
            mip_level_count: 1,
            sample_count: 1,
            dimension: wgpu::TextureDimension::D2,
            format: wgpu::TextureFormat::Rgba8Unorm,
            usage: wgpu::TextureUsages::COPY_SRC | wgpu::TextureUsages::RENDER_ATTACHMENT,
            view_formats: &[],
        });
        let readback = device.create_buffer(&wgpu::BufferDescriptor {
            label: None,
            size: 512,
            usage: wgpu::BufferUsages::COPY_DST | wgpu::BufferUsages::MAP_READ,
            mapped_at_creation: false,
        });
        let mut encoder = device.create_command_encoder(&Default::default());
        {
            let view = target.create_view(&Default::default());
            let mut pass = encoder.begin_render_pass(&wgpu::RenderPassDescriptor {
                label: None,
                color_attachments: &[Some(wgpu::RenderPassColorAttachment {
                    view: &view,
                    depth_slice: None,
                    resolve_target: None,
                    ops: wgpu::Operations {
                        load: wgpu::LoadOp::Clear(wgpu::Color::BLACK),
                        store: wgpu::StoreOp::Store,
                    },
                })],
                ..Default::default()
            });
            pass.set_pipeline(&pipeline);
            pass.set_bind_group(0, &group, &[]);
            pass.set_viewport(1., 0., 2., 2., 0., 1.);
            pass.draw(0..3, 0..1);
        }
        encoder.copy_texture_to_buffer(
            target.as_image_copy(),
            wgpu::TexelCopyBufferInfo {
                buffer: &readback,
                layout: wgpu::TexelCopyBufferLayout {
                    offset: 0,
                    bytes_per_row: Some(256),
                    rows_per_image: Some(2),
                },
            },
            target.size(),
        );
        queue.submit([encoder.finish()]);
        let (tx, rx) = std::sync::mpsc::channel();
        readback
            .slice(..)
            .map_async(wgpu::MapMode::Read, move |result| tx.send(result).unwrap());
        device.poll(wgpu::PollType::wait_indefinitely()).unwrap();
        rx.recv().unwrap().unwrap();
        let data = readback.slice(..).get_mapped_range().unwrap();
        assert_eq!(
            &data[..16],
            &[0, 0, 0, 255, 18, 52, 86, 255, 255, 0, 0, 255, 0, 0, 0, 255]
        );
        assert_eq!(
            &data[256..272],
            &[0, 0, 0, 255, 0, 255, 0, 255, 0, 0, 255, 255, 0, 0, 0, 255]
        );
    }
}