j2k-metal 0.7.5

Metal decoder and encode-stage adapter for j2k
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

// SPDX-License-Identifier: MIT OR Apache-2.0

use super::{MetalBufferPools, PoolLimits};
use j2k_metal_support::{
    checked_blit_command_encoder, checked_command_buffer, checked_command_queue,
    checked_private_buffer, checked_shared_buffer_with_bytes, commit_and_wait,
};
use metal::foreign_types::ForeignType;
use metal::Device;

mod lookup;
mod production_limits;
mod warm_reuse;

fn device() -> Device {
    Device::system_default().expect("Metal device")
}

#[test]
fn completed_exact_size_reuse_updates_actual_byte_accounting() {
    let device = device();
    let pools =
        MetalBufferPools::with_limits_for_test(PoolLimits::new(64, 2), PoolLimits::new(64, 2));
    let mut buffer = pools
        .take_private(&device, 16)
        .expect("private buffer owner");
    let upload = checked_shared_buffer_with_bytes(&device, &[0xa5; 16]).expect("upload buffer");
    let queue = checked_command_queue(&device).expect("command queue");
    let command_buffer = checked_command_buffer(&queue).expect("command buffer");
    let blit = checked_blit_command_encoder(&command_buffer).expect("blit encoder");
    blit.copy_from_buffer(&upload, 0, &buffer, 0, 16);
    blit.end_encoding();
    commit_and_wait(&command_buffer).expect("buffer work completion before recycle");
    let pointer = buffer.as_ptr();

    for _ in 0..16 {
        pools
            .recycle_private(buffer)
            .expect("recycle private buffer");
        assert_eq!(pools.private_diagnostics().unwrap().cached_bytes, 16);
        buffer = pools
            .take_private(&device, 16)
            .expect("take private buffer");
        assert_eq!(buffer.as_ptr(), pointer);
    }
    drop(buffer);
    let diagnostics = pools.private_diagnostics().unwrap();
    assert_eq!(diagnostics.cached_bytes, 0);
    assert_eq!(diagnostics.cached_buffers, 0);
    assert_eq!(diagnostics.peak_cached_bytes, 16);
}

#[test]
fn unique_sizes_evict_oldest_buffers_under_both_limits() {
    let device = device();
    let pools =
        MetalBufferPools::with_limits_for_test(PoolLimits::new(10, 2), PoolLimits::new(10, 2));
    for bytes in [4, 5, 6] {
        let buffer = checked_private_buffer(&device, bytes).expect("private buffer");
        pools
            .recycle_private_checked(bytes, buffer)
            .expect("recycle private buffer");
    }

    let diagnostics = pools.private_diagnostics().unwrap();
    assert_eq!(diagnostics.cached_bytes, 6);
    assert_eq!(diagnostics.cached_buffers, 1);
    assert_eq!(diagnostics.evictions, 2);
}

#[test]
fn oversized_and_metadata_failed_recycles_drop_completed_buffers() {
    let device = device();
    let pools =
        MetalBufferPools::with_limits_for_test(PoolLimits::new(8, 2), PoolLimits::new(8, 2));
    pools
        .recycle_private_checked(
            8,
            checked_private_buffer(&device, 8).expect("exact private buffer"),
        )
        .expect("exact-limit recycle");
    let oversized = checked_private_buffer(&device, 9).expect("oversized private buffer");
    pools
        .recycle_private_checked(9, oversized)
        .expect("oversized recycle is a safe decline");
    pools.fail_next_private_metadata_reserve_for_test();
    let metadata_failure = checked_private_buffer(&device, 4).expect("private buffer");
    pools
        .recycle_private_checked(4, metadata_failure)
        .expect("metadata failure is a safe decline");

    let diagnostics = pools.private_diagnostics().unwrap();
    assert_eq!(diagnostics.cached_bytes, 8);
    assert_eq!(diagnostics.cached_buffers, 1);
    assert_eq!(diagnostics.rejections, 2);
    assert_eq!(diagnostics.metadata_failures, 1);
}

#[test]
fn recorded_size_mismatch_is_a_typed_invariant_failure() {
    let device = device();
    let pools =
        MetalBufferPools::with_limits_for_test(PoolLimits::new(16, 2), PoolLimits::new(16, 2));
    let buffer = checked_private_buffer(&device, 8).expect("private buffer");
    assert!(matches!(
        pools.recycle_private_checked(7, buffer),
        Err(crate::Error::MetalStateInvariant {
            state: "j2k metal private buffer pool",
            reason: "recorded buffer size differs from the Metal allocation length",
        })
    ));
    assert_eq!(pools.private_diagnostics().unwrap().size_mismatches, 1);
}

#[test]
fn backend_session_exposes_typed_pool_high_water_diagnostics() {
    let session = crate::MetalBackendSession::system_default().expect("Metal backend session");
    let diagnostics = session
        .buffer_pool_diagnostics()
        .expect("buffer-pool diagnostics");
    assert!(diagnostics.private.cached_bytes <= diagnostics.private.peak_cached_bytes);
    assert!(diagnostics.shared.cached_bytes <= diagnostics.shared.peak_cached_bytes);
    assert!(diagnostics.private.cached_buffers <= diagnostics.private.peak_cached_buffers);
    assert!(diagnostics.shared.cached_buffers <= diagnostics.shared.peak_cached_buffers);
}