wireframe 0.3.0

Simplify building servers and clients for custom binary protocols.
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

//! Unit tests for codec benchmark workload and measurement helpers.

// These checks rely on real-time measurement behaviour and are unsuitable for loom.
#![cfg(not(loom))]

use rstest::rstest;

#[path = "common/codec_benchmark_support.rs"]
mod codec_benchmark_support;

#[path = "common/codec_fragmentation_benchmark_support.rs"]
mod codec_fragmentation_benchmark_support;

#[path = "common/codec_alloc_benchmark_support.rs"]
mod codec_alloc_benchmark_support;

use codec_alloc_benchmark_support::{AllocationBaseline, allocation_label};
use codec_benchmark_support::{
    BenchmarkWorkload,
    CodecUnderTest,
    LARGE_PAYLOAD_BYTES,
    PayloadClass,
    SMALL_PAYLOAD_BYTES,
    VALIDATION_ITERATIONS,
    benchmark_workloads,
    measure_decode,
    measure_encode,
    payload_for_class,
};
use codec_fragmentation_benchmark_support::{
    FRAGMENT_PAYLOAD_CAP_BYTES,
    MeasurementExt as _,
    measure_fragmentation_overhead,
};

#[rstest]
#[case::small(PayloadClass::Small, SMALL_PAYLOAD_BYTES)]
#[case::large(PayloadClass::Large, LARGE_PAYLOAD_BYTES)]
fn payload_for_class_matches_expected_size(#[case] class: PayloadClass, #[case] expected: usize) {
    let payload = payload_for_class(class);
    assert_eq!(payload.len(), expected);
}

#[test]
fn benchmark_workloads_cover_default_and_custom_codecs() {
    let workloads = benchmark_workloads();
    assert_eq!(
        workloads.len(),
        4,
        "matrix should include 2 codecs x 2 payload classes"
    );

    let has_default_small = workloads.contains(&BenchmarkWorkload {
        codec: CodecUnderTest::LengthDelimited,
        payload_class: PayloadClass::Small,
    });
    let has_default_large = workloads.contains(&BenchmarkWorkload {
        codec: CodecUnderTest::LengthDelimited,
        payload_class: PayloadClass::Large,
    });
    let has_hotline_small = workloads.contains(&BenchmarkWorkload {
        codec: CodecUnderTest::Hotline,
        payload_class: PayloadClass::Small,
    });
    let has_hotline_large = workloads.contains(&BenchmarkWorkload {
        codec: CodecUnderTest::Hotline,
        payload_class: PayloadClass::Large,
    });

    assert!(has_default_small);
    assert!(has_default_large);
    assert!(has_hotline_small);
    assert!(has_hotline_large);
}

#[rstest]
#[case::default_small(BenchmarkWorkload {
    codec: CodecUnderTest::LengthDelimited,
    payload_class: PayloadClass::Small,
})]
#[case::default_large(BenchmarkWorkload {
    codec: CodecUnderTest::LengthDelimited,
    payload_class: PayloadClass::Large,
})]
#[case::hotline_small(BenchmarkWorkload {
    codec: CodecUnderTest::Hotline,
    payload_class: PayloadClass::Small,
})]
#[case::hotline_large(BenchmarkWorkload {
    codec: CodecUnderTest::Hotline,
    payload_class: PayloadClass::Large,
})]
fn encode_measurement_reports_requested_iterations(#[case] workload: BenchmarkWorkload) {
    let measurement =
        measure_encode(workload, VALIDATION_ITERATIONS).expect("encode measurement failed");
    assert_eq!(measurement.operations, VALIDATION_ITERATIONS);
    assert!(measurement.payload_bytes > 0);
    assert!(measurement.nanos_per_op().is_some());
}

#[rstest]
#[case::default_small(BenchmarkWorkload {
    codec: CodecUnderTest::LengthDelimited,
    payload_class: PayloadClass::Small,
})]
#[case::default_large(BenchmarkWorkload {
    codec: CodecUnderTest::LengthDelimited,
    payload_class: PayloadClass::Large,
})]
#[case::hotline_small(BenchmarkWorkload {
    codec: CodecUnderTest::Hotline,
    payload_class: PayloadClass::Small,
})]
#[case::hotline_large(BenchmarkWorkload {
    codec: CodecUnderTest::Hotline,
    payload_class: PayloadClass::Large,
})]
fn decode_measurement_reports_requested_iterations(#[case] workload: BenchmarkWorkload) {
    let measurement =
        measure_decode(workload, VALIDATION_ITERATIONS).expect("decode measurement failed");
    assert_eq!(measurement.operations, VALIDATION_ITERATIONS);
    assert!(measurement.payload_bytes > 0);
    assert!(measurement.nanos_per_op().is_some());
}

#[test]
fn fragmentation_overhead_reports_fragmented_and_unfragmented_results() {
    let overhead = measure_fragmentation_overhead(
        PayloadClass::Large,
        VALIDATION_ITERATIONS,
        FRAGMENT_PAYLOAD_CAP_BYTES,
    )
    .expect("fragmentation overhead measurement failed");

    assert_eq!(overhead.unfragmented.operations, VALIDATION_ITERATIONS);
    assert_eq!(overhead.fragmented.operations, VALIDATION_ITERATIONS);
    assert!(overhead.fragmented.payload_bytes >= overhead.unfragmented.payload_bytes);
    assert!(overhead.nanos_ratio().is_some());
}

#[test]
fn allocation_label_includes_wrap_and_decode_counters() {
    let workload = BenchmarkWorkload {
        codec: CodecUnderTest::LengthDelimited,
        payload_class: PayloadClass::Small,
    };
    let label = allocation_label(
        workload,
        AllocationBaseline {
            wrap_allocations: 11,
            decode_allocations: 7,
        },
    );

    assert!(label.contains("wrap_allocs_11"));
    assert!(label.contains("decode_allocs_7"));
}