metal-rust-ffi 1.0.0

Audited Objective-C interoperability boundary for metal-rust
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
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
//! Audited Metal 4 archive queries and argument-table bindings.

use crate::foundation::{Error, metal_error};
use crate::metal::generated_object_types::{metal, metal4};
use crate::metal::{Buffer, ComputePipelineState, Device, RenderPipelineState, Texture};
use objc2::rc::Retained;
use objc2::runtime::AnyObject;
use objc2::{msg_send, sel};
use objc2_foundation::{NSError, NSString};
use objc2_metal::MTLResourceID;

const MAX_BUFFER_BIND_COUNT: usize = 31;
const MAX_TEXTURE_BIND_COUNT: usize = 128;
const MAX_SAMPLER_BIND_COUNT: usize = 16;

fn require_selector(
    object: &AnyObject,
    selector: objc2::runtime::Sel,
    context: &str,
) -> Result<(), Error> {
    // SAFETY: every Objective-C object implements respondsToSelector:, and
    // selector/bool use the stable Objective-C runtime ABI.
    let supported: bool = unsafe { msg_send![object, respondsToSelector: selector] };
    if supported {
        Ok(())
    } else {
        Err(Error::unsupported(format!("{context} is unavailable")))
    }
}

fn resource_id(object: &AnyObject, context: &str) -> Result<MTLResourceID, Error> {
    require_selector(object, sel!(gpuResourceID), context)?;
    // SAFETY: selector availability is checked and gpuResourceID returns the
    // SDK-declared one-u64 MTLResourceID value.
    Ok(unsafe { msg_send![object, gpuResourceID] })
}

/// A checked, Rust-owned description of an argument table.
///
/// Keeping the limits in Rust means invalid binding counts are rejected before
/// Objective-C sees them, and the created table can retain those exact bounds.
#[derive(Clone, Debug, Default, PartialEq, Eq)]
pub struct ArgumentTableDescriptor {
    label: Option<String>,
    max_buffer_bind_count: usize,
    max_texture_bind_count: usize,
    max_sampler_state_bind_count: usize,
    initialize_bindings: bool,
    support_attribute_strides: bool,
}

impl ArgumentTableDescriptor {
    /// Creates a descriptor with no binding slots.
    #[must_use]
    pub fn new() -> Self {
        Self::default()
    }

    #[must_use]
    /// Returns the optional debug label.
    pub fn label(&self) -> Option<&str> {
        self.label.as_deref()
    }

    /// Replaces or clears the debug label.
    pub fn set_label(&mut self, label: Option<&str>) {
        self.label = label.map(str::to_owned);
    }

    #[must_use]
    /// Returns the configured buffer binding count.
    pub const fn max_buffer_bind_count(&self) -> usize {
        self.max_buffer_bind_count
    }

    /// Sets the buffer binding count after checking Metal's limit.
    pub fn set_max_buffer_bind_count(&mut self, count: usize) -> Result<(), Error> {
        if count > MAX_BUFFER_BIND_COUNT {
            return Err(Error::invalid_argument(
                "Metal 4 argument tables support at most 31 buffer bindings",
            ));
        }
        self.max_buffer_bind_count = count;
        Ok(())
    }

    #[must_use]
    /// Returns the configured texture binding count.
    pub const fn max_texture_bind_count(&self) -> usize {
        self.max_texture_bind_count
    }

    /// Sets the texture binding count after checking Metal's limit.
    pub fn set_max_texture_bind_count(&mut self, count: usize) -> Result<(), Error> {
        if count > MAX_TEXTURE_BIND_COUNT {
            return Err(Error::invalid_argument(
                "Metal 4 argument tables support at most 128 texture bindings",
            ));
        }
        self.max_texture_bind_count = count;
        Ok(())
    }

    #[must_use]
    /// Returns the configured sampler binding count.
    pub const fn max_sampler_state_bind_count(&self) -> usize {
        self.max_sampler_state_bind_count
    }

    /// Sets the sampler binding count after checking Metal's limit.
    pub fn set_max_sampler_state_bind_count(&mut self, count: usize) -> Result<(), Error> {
        if count > MAX_SAMPLER_BIND_COUNT {
            return Err(Error::invalid_argument(
                "Metal 4 argument tables support at most 16 sampler bindings",
            ));
        }
        self.max_sampler_state_bind_count = count;
        Ok(())
    }

    #[must_use]
    /// Returns whether Metal initializes bindings when creating the table.
    pub const fn initialize_bindings(&self) -> bool {
        self.initialize_bindings
    }

    /// Configures whether Metal initializes bindings when creating the table.
    pub fn set_initialize_bindings(&mut self, initialize: bool) {
        self.initialize_bindings = initialize;
    }

    #[must_use]
    /// Returns whether dynamic attribute strides are enabled.
    pub const fn support_attribute_strides(&self) -> bool {
        self.support_attribute_strides
    }

    /// Configures support for dynamic attribute strides.
    pub fn set_support_attribute_strides(&mut self, support: bool) {
        self.support_attribute_strides = support;
    }

    fn make_native(&self) -> Result<metal4::ArgumentTableDescriptor, Error> {
        let descriptor = metal4::ArgumentTableDescriptor::new()?;
        descriptor.set_max_buffer_bind_count(self.max_buffer_bind_count)?;
        descriptor.set_max_texture_bind_count(self.max_texture_bind_count)?;
        descriptor.set_max_sampler_state_bind_count(self.max_sampler_state_bind_count)?;
        descriptor.set_initialize_bindings(self.initialize_bindings)?;
        descriptor.set_support_attribute_strides(self.support_attribute_strides)?;
        if let Some(label) = &self.label {
            descriptor.set_label(label)?;
        }
        Ok(descriptor)
    }
}

/// An argument table that retains the exact checked bounds used at creation.
#[derive(Clone)]
pub struct ArgumentTable {
    inner: metal4::ArgumentTable,
    device: Device,
    label: Option<String>,
    max_buffer_bind_count: usize,
    max_texture_bind_count: usize,
    max_sampler_state_bind_count: usize,
    support_attribute_strides: bool,
}

/// A typed Metal resource accepted by an argument-table buffer slot.
#[derive(Clone, Copy)]
pub enum ArgumentTableResource<'a> {
    /// A conventional Metal buffer resource.
    Buffer(&'a Buffer),
    /// A Metal tensor resource.
    Tensor(&'a metal::Tensor),
    /// A Metal acceleration-structure resource.
    AccelerationStructure(&'a metal::AccelerationStructure),
}

impl<'a> ArgumentTableResource<'a> {
    fn object(self) -> (&'a AnyObject, &'static str) {
        match self {
            Self::Buffer(value) => (value.as_any_object(), "MTLBuffer.gpuResourceID"),
            Self::Tensor(value) => (value.as_inner(), "MTLTensor.gpuResourceID"),
            Self::AccelerationStructure(value) => {
                (value.as_inner(), "MTLAccelerationStructure.gpuResourceID")
            }
        }
    }
}

impl Device {
    /// Creates a Metal 4 argument table and owns any returned NSError.
    pub fn new_mtl4_argument_table(
        &self,
        descriptor: &ArgumentTableDescriptor,
    ) -> Result<ArgumentTable, Error> {
        require_selector(
            self.as_any_object(),
            sel!(newArgumentTableWithDescriptor:error:),
            "MTLDevice.newArgumentTableWithDescriptor:error:",
        )?;
        let native = descriptor.make_native()?;
        // SAFETY: the selector is present, the descriptor is a live native
        // MTL4ArgumentTableDescriptor, and `_` uses objc2's owned NSError
        // writeback adapter for the declared error parameter.
        let result: Result<Retained<AnyObject>, Retained<NSError>> = unsafe {
            msg_send![self.as_any_object(), newArgumentTableWithDescriptor: native.as_inner(), error: _]
        };
        let inner = result
            .map(metal4::ArgumentTable::from_inner)
            .map_err(|error| metal_error(&error))?;
        Ok(ArgumentTable {
            inner,
            device: self.clone(),
            label: descriptor.label.clone(),
            max_buffer_bind_count: descriptor.max_buffer_bind_count,
            max_texture_bind_count: descriptor.max_texture_bind_count,
            max_sampler_state_bind_count: descriptor.max_sampler_state_bind_count,
            support_attribute_strides: descriptor.support_attribute_strides,
        })
    }
}

impl ArgumentTable {
    #[allow(dead_code)]
    pub(crate) const fn as_generated(&self) -> &metal4::ArgumentTable {
        &self.inner
    }

    #[must_use]
    /// Returns the device that created this table.
    pub fn device(&self) -> Device {
        self.device.clone()
    }

    #[must_use]
    /// Returns the label captured when the table was created.
    pub fn label(&self) -> Option<&str> {
        self.label.as_deref()
    }

    fn ensure_same_device(&self, resource: &AnyObject, context: &str) -> Result<(), Error> {
        require_selector(resource, sel!(device), context)?;
        // SAFETY: selector availability is checked and every Metal allocation
        // used here declares a nonnull retained MTLDevice result.
        let resource_device: Retained<AnyObject> = unsafe { msg_send![resource, device] };
        if std::ptr::eq(&*resource_device, self.device.as_any_object()) {
            Ok(())
        } else {
            Err(Error::invalid_argument(
                "argument-table resources must belong to the table's device",
            ))
        }
    }

    fn check_buffer_index(&self, index: usize) -> Result<(), Error> {
        if index >= self.max_buffer_bind_count {
            Err(Error::invalid_argument(
                "buffer binding index exceeds the table descriptor limit",
            ))
        } else {
            Ok(())
        }
    }

    fn check_texture_index(&self, index: usize) -> Result<(), Error> {
        if index >= self.max_texture_bind_count {
            Err(Error::invalid_argument(
                "texture binding index exceeds the table descriptor limit",
            ))
        } else {
            Ok(())
        }
    }

    fn check_sampler_index(&self, index: usize) -> Result<(), Error> {
        if index >= self.max_sampler_state_bind_count {
            Err(Error::invalid_argument(
                "sampler binding index exceeds the table descriptor limit",
            ))
        } else {
            Ok(())
        }
    }

    /// Binds a buffer address after validating its offset and binding index.
    pub fn set_buffer(&self, buffer: &Buffer, offset: usize, index: usize) -> Result<(), Error> {
        self.check_buffer_index(index)?;
        self.ensure_same_device(buffer.as_any_object(), "MTLBuffer.device")?;
        if offset > buffer.length() {
            return Err(Error::invalid_argument(
                "buffer binding offset is out of bounds",
            ));
        }
        let address = buffer
            .gpu_address()
            .checked_add(offset as u64)
            .ok_or_else(|| Error::invalid_argument("buffer GPU address overflow"))?;
        require_selector(
            self.inner.as_inner(),
            sel!(setAddress:atIndex:),
            "MTL4ArgumentTable.setAddress:atIndex:",
        )?;
        // SAFETY: the table retains the descriptor's exact buffer count,
        // index was checked against it, and the address is within the buffer.
        unsafe {
            let _: () = msg_send![self.inner.as_inner(), setAddress: address, atIndex: index];
        }
        Ok(())
    }

    /// Binds a buffer address with a checked dynamic attribute stride.
    pub fn set_buffer_with_stride(
        &self,
        buffer: &Buffer,
        offset: usize,
        stride: usize,
        index: usize,
    ) -> Result<(), Error> {
        self.check_buffer_index(index)?;
        self.ensure_same_device(buffer.as_any_object(), "MTLBuffer.device")?;
        if !self.support_attribute_strides {
            return Err(Error::invalid_argument(
                "the table descriptor did not enable attribute strides",
            ));
        }
        let remaining = buffer
            .length()
            .checked_sub(offset)
            .ok_or_else(|| Error::invalid_argument("buffer binding offset is out of bounds"))?;
        if stride > remaining {
            return Err(Error::invalid_argument(
                "attribute stride exceeds the remaining buffer length",
            ));
        }
        let address = buffer
            .gpu_address()
            .checked_add(offset as u64)
            .ok_or_else(|| Error::invalid_argument("buffer GPU address overflow"))?;
        require_selector(
            self.inner.as_inner(),
            sel!(setAddress:attributeStride:atIndex:),
            "MTL4ArgumentTable.setAddress:attributeStride:atIndex:",
        )?;
        // SAFETY: index, address range, stride, and descriptor stride support
        // were checked before invoking the SDK-declared selector.
        unsafe {
            let _: () = msg_send![self.inner.as_inner(), setAddress: address, attributeStride: stride, atIndex: index];
        }
        Ok(())
    }

    /// Binds consecutive buffers from a Rust slice.
    pub fn set_buffers(
        &self,
        bindings: &[(&Buffer, usize)],
        start_index: usize,
    ) -> Result<(), Error> {
        let end = start_index
            .checked_add(bindings.len())
            .ok_or_else(|| Error::invalid_argument("buffer binding range overflow"))?;
        if end > self.max_buffer_bind_count {
            return Err(Error::invalid_argument(
                "buffer binding slice exceeds the table descriptor limit",
            ));
        }
        for (relative, &(buffer, offset)) in bindings.iter().enumerate() {
            self.set_buffer(buffer, offset, start_index + relative)?;
        }
        Ok(())
    }

    fn set_buffer_resource_object(
        &self,
        object: &AnyObject,
        index: usize,
        context: &str,
    ) -> Result<(), Error> {
        self.check_buffer_index(index)?;
        self.ensure_same_device(object, context)?;
        let id = resource_id(object, context)?;
        require_selector(
            self.inner.as_inner(),
            sel!(setResource:atBufferIndex:),
            "MTL4ArgumentTable.setResource:atBufferIndex:",
        )?;
        // SAFETY: index was checked against the retained descriptor count and
        // the opaque ID came from the live typed Metal resource itself.
        unsafe {
            let _: () = msg_send![self.inner.as_inner(), setResource: id, atBufferIndex: index];
        }
        Ok(())
    }

    /// Binds a typed resource to a checked buffer binding slot.
    pub fn set_resource(
        &self,
        resource: ArgumentTableResource<'_>,
        index: usize,
    ) -> Result<(), Error> {
        let (object, context) = resource.object();
        self.set_buffer_resource_object(object, index, context)
    }

    /// Binds a tensor to a checked buffer binding slot.
    pub fn set_tensor(&self, tensor: &metal::Tensor, index: usize) -> Result<(), Error> {
        self.set_resource(ArgumentTableResource::Tensor(tensor), index)
    }

    /// Binds an acceleration structure to a checked buffer binding slot.
    pub fn set_acceleration_structure(
        &self,
        structure: &metal::AccelerationStructure,
        index: usize,
    ) -> Result<(), Error> {
        self.set_resource(
            ArgumentTableResource::AccelerationStructure(structure),
            index,
        )
    }

    /// Binds a texture using the identifier read from the typed texture.
    pub fn set_texture(&self, texture: &Texture, index: usize) -> Result<(), Error> {
        self.check_texture_index(index)?;
        self.ensure_same_device(texture.as_any_object(), "MTLTexture.device")?;
        require_selector(
            self.inner.as_inner(),
            sel!(setTexture:atIndex:),
            "MTL4ArgumentTable.setTexture:atIndex:",
        )?;
        let raw = texture.gpu_resource_id()._impl;
        // SAFETY: MTLResourceID has exactly one u64 field in the SDK ABI.
        let id = unsafe { std::mem::transmute::<u64, MTLResourceID>(raw) };
        // SAFETY: index was checked against the retained texture count and the
        // resource ID was obtained from a live typed MTLTexture.
        unsafe {
            let _: () = msg_send![self.inner.as_inner(), setTexture: id, atIndex: index];
        }
        Ok(())
    }

    /// Binds consecutive textures from a Rust slice.
    pub fn set_textures(&self, textures: &[&Texture], start_index: usize) -> Result<(), Error> {
        let end = start_index
            .checked_add(textures.len())
            .ok_or_else(|| Error::invalid_argument("texture binding range overflow"))?;
        if end > self.max_texture_bind_count {
            return Err(Error::invalid_argument(
                "texture binding slice exceeds the table descriptor limit",
            ));
        }
        for (relative, texture) in textures.iter().enumerate() {
            self.set_texture(texture, start_index + relative)?;
        }
        Ok(())
    }

    /// Binds a sampler using the identifier read from the typed sampler.
    pub fn set_sampler_state(
        &self,
        sampler: &metal::SamplerState,
        index: usize,
    ) -> Result<(), Error> {
        self.check_sampler_index(index)?;
        self.ensure_same_device(sampler.as_inner(), "MTLSamplerState.device")?;
        let id = resource_id(sampler.as_inner(), "MTLSamplerState.gpuResourceID")?;
        require_selector(
            self.inner.as_inner(),
            sel!(setSamplerState:atIndex:),
            "MTL4ArgumentTable.setSamplerState:atIndex:",
        )?;
        // SAFETY: index was checked against the retained sampler count and the
        // resource ID was obtained from a live typed MTLSamplerState.
        unsafe {
            let _: () = msg_send![self.inner.as_inner(), setSamplerState: id, atIndex: index];
        }
        Ok(())
    }

    /// Binds consecutive samplers from a checked Rust slice.
    pub fn set_sampler_states(
        &self,
        samplers: &[&metal::SamplerState],
        start_index: usize,
    ) -> Result<(), Error> {
        let end = start_index
            .checked_add(samplers.len())
            .ok_or_else(|| Error::invalid_argument("sampler binding range overflow"))?;
        if end > self.max_sampler_state_bind_count {
            return Err(Error::invalid_argument(
                "sampler binding slice exceeds the table descriptor limit",
            ));
        }
        for (relative, sampler) in samplers.iter().enumerate() {
            self.set_sampler_state(sampler, start_index + relative)?;
        }
        Ok(())
    }

    /// Binds consecutive tensors to checked buffer binding slots.
    pub fn set_tensors(&self, tensors: &[&metal::Tensor], start_index: usize) -> Result<(), Error> {
        let end = start_index
            .checked_add(tensors.len())
            .ok_or_else(|| Error::invalid_argument("tensor binding range overflow"))?;
        if end > self.max_buffer_bind_count {
            return Err(Error::invalid_argument(
                "tensor binding slice exceeds the table descriptor limit",
            ));
        }
        for (relative, tensor) in tensors.iter().enumerate() {
            self.set_tensor(tensor, start_index + relative)?;
        }
        Ok(())
    }

    /// Binds consecutive acceleration structures to checked buffer slots.
    pub fn set_acceleration_structures(
        &self,
        structures: &[&metal::AccelerationStructure],
        start_index: usize,
    ) -> Result<(), Error> {
        let end = start_index
            .checked_add(structures.len())
            .ok_or_else(|| Error::invalid_argument("acceleration-structure range overflow"))?;
        if end > self.max_buffer_bind_count {
            return Err(Error::invalid_argument(
                "acceleration-structure slice exceeds the table descriptor limit",
            ));
        }
        for (relative, structure) in structures.iter().enumerate() {
            self.set_acceleration_structure(structure, start_index + relative)?;
        }
        Ok(())
    }
}

/// A checked wrapper around an archive returned by a Metal 4 serializer.
#[derive(Clone)]
pub struct Archive {
    inner: metal4::Archive,
}

impl Archive {
    #[allow(dead_code)]
    pub(crate) const fn from_generated(inner: metal4::Archive) -> Self {
        Self { inner }
    }

    /// Returns the optional archive label.
    pub fn label(&self) -> Result<Option<String>, Error> {
        self.inner.label()
    }

    /// Replaces or clears the archive label.
    pub fn set_label(&self, label: Option<&str>) -> Result<(), Error> {
        require_selector(
            self.inner.as_inner(),
            sel!(setLabel:),
            "MTL4Archive.setLabel:",
        )?;
        let label = label.map(NSString::from_str);
        // SAFETY: selector availability is checked and the optional NSString
        // remains live for the duration of the call.
        unsafe {
            let _: () = msg_send![self.inner.as_inner(), setLabel: label.as_deref()];
        }
        Ok(())
    }

    /// Looks up a binary function from this archive.
    pub fn new_binary_function(
        &self,
        descriptor: &metal4::BinaryFunctionDescriptor,
    ) -> Result<metal4::BinaryFunction, Error> {
        require_selector(
            self.inner.as_inner(),
            sel!(newBinaryFunctionWithDescriptor:error:),
            "MTL4Archive.newBinaryFunctionWithDescriptor:error:",
        )?;
        // SAFETY: selector availability is checked; the descriptor is live;
        // objc2 owns both the `new` result and NSError writeback.
        let result: Result<Retained<AnyObject>, Retained<NSError>> = unsafe {
            msg_send![self.inner.as_inner(), newBinaryFunctionWithDescriptor: descriptor.as_inner(), error: _]
        };
        result
            .map(metal4::BinaryFunction::from_inner)
            .map_err(|error| metal_error(&error))
    }

    /// Looks up a compute pipeline, optionally applying dynamic linking.
    pub fn new_compute_pipeline_state(
        &self,
        descriptor: &metal4::ComputePipelineDescriptor,
        linking: Option<&metal4::PipelineStageDynamicLinkingDescriptor>,
    ) -> Result<ComputePipelineState, Error> {
        let result: Result<Retained<AnyObject>, Retained<NSError>> = if let Some(linking) = linking
        {
            require_selector(
                self.inner.as_inner(),
                sel!(newComputePipelineStateWithDescriptor:dynamicLinkingDescriptor:error:),
                "MTL4Archive.newComputePipelineStateWithDescriptor:dynamicLinkingDescriptor:error:",
            )?;
            // SAFETY: selector availability and both live descriptor object
            // contracts were checked; objc2 owns result and error writeback.
            unsafe {
                msg_send![self.inner.as_inner(), newComputePipelineStateWithDescriptor: descriptor.as_inner(), dynamicLinkingDescriptor: linking.as_inner(), error: _]
            }
        } else {
            require_selector(
                self.inner.as_inner(),
                sel!(newComputePipelineStateWithDescriptor:error:),
                "MTL4Archive.newComputePipelineStateWithDescriptor:error:",
            )?;
            // SAFETY: selector availability and descriptor liveness are
            // checked; objc2 owns result and NSError writeback.
            unsafe {
                msg_send![self.inner.as_inner(), newComputePipelineStateWithDescriptor: descriptor.as_inner(), error: _]
            }
        };
        let inner = result.map_err(|error| metal_error(&error))?;
        // SAFETY: both selectors are declared to return an object conforming
        // to MTLComputePipelineState on success.
        let inner = unsafe { Retained::cast_unchecked(inner) };
        Ok(ComputePipelineState::new(inner))
    }

    /// Looks up a render pipeline, optionally applying dynamic linking.
    pub fn new_render_pipeline_state(
        &self,
        descriptor: &metal4::PipelineDescriptor,
        linking: Option<&metal4::RenderPipelineDynamicLinkingDescriptor>,
    ) -> Result<RenderPipelineState, Error> {
        let result: Result<Retained<AnyObject>, Retained<NSError>> = if let Some(linking) = linking
        {
            require_selector(
                self.inner.as_inner(),
                sel!(newRenderPipelineStateWithDescriptor:dynamicLinkingDescriptor:error:),
                "MTL4Archive.newRenderPipelineStateWithDescriptor:dynamicLinkingDescriptor:error:",
            )?;
            // SAFETY: selector availability and both descriptor object
            // contracts were checked; objc2 owns result and error writeback.
            unsafe {
                msg_send![self.inner.as_inner(), newRenderPipelineStateWithDescriptor: descriptor.as_inner(), dynamicLinkingDescriptor: linking.as_inner(), error: _]
            }
        } else {
            require_selector(
                self.inner.as_inner(),
                sel!(newRenderPipelineStateWithDescriptor:error:),
                "MTL4Archive.newRenderPipelineStateWithDescriptor:error:",
            )?;
            // SAFETY: selector availability and descriptor liveness are
            // checked; objc2 owns result and NSError writeback.
            unsafe {
                msg_send![self.inner.as_inner(), newRenderPipelineStateWithDescriptor: descriptor.as_inner(), error: _]
            }
        };
        let inner = result.map_err(|error| metal_error(&error))?;
        // SAFETY: both selectors are declared to return an object conforming
        // to MTLRenderPipelineState on success.
        let inner = unsafe { Retained::cast_unchecked(inner) };
        Ok(RenderPipelineState::new(inner))
    }
}

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

    #[test]
    fn descriptor_accepts_documented_binding_limits() {
        let mut descriptor = ArgumentTableDescriptor::new();
        descriptor
            .set_max_buffer_bind_count(MAX_BUFFER_BIND_COUNT)
            .unwrap();
        descriptor
            .set_max_texture_bind_count(MAX_TEXTURE_BIND_COUNT)
            .unwrap();
        descriptor
            .set_max_sampler_state_bind_count(MAX_SAMPLER_BIND_COUNT)
            .unwrap();
        assert_eq!(descriptor.max_buffer_bind_count(), 31);
        assert_eq!(descriptor.max_texture_bind_count(), 128);
        assert_eq!(descriptor.max_sampler_state_bind_count(), 16);
    }

    #[test]
    fn descriptor_rejects_counts_above_documented_limits() {
        let mut descriptor = ArgumentTableDescriptor::new();
        assert!(descriptor.set_max_buffer_bind_count(32).is_err());
        assert!(descriptor.set_max_texture_bind_count(129).is_err());
        assert!(descriptor.set_max_sampler_state_bind_count(17).is_err());
    }

    #[test]
    fn descriptor_owns_label_and_boolean_state() {
        let mut descriptor = ArgumentTableDescriptor::new();
        descriptor.set_label(Some("bindings"));
        descriptor.set_initialize_bindings(true);
        descriptor.set_support_attribute_strides(true);
        assert_eq!(descriptor.label(), Some("bindings"));
        assert!(descriptor.initialize_bindings());
        assert!(descriptor.support_attribute_strides());
        descriptor.set_label(None);
        assert_eq!(descriptor.label(), None);
    }
}