capsule 0.1.5

A framework for network function development. Written in Rust, inspired by NetBricks and built on Intel's Data Plane Development Kit.
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

/*
* Copyright 2019 Comcast Cable Communications Management, LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* SPDX-License-Identifier: Apache-2.0
*/

//! Iterator extensions to [criterion], leveraging proptest strategy
//! generators.
//!
//! [criterion]: https://crates.io/crates/criterion

use super::Rvg;
use crate::batch::{Batch, PacketTx, Poll};
use crate::Mbuf;
use criterion::{black_box, Bencher};
use proptest::strategy::Strategy;
use std::cmp;
use std::sync::mpsc::{self, Receiver};
use std::time::{Duration, Instant};

/// Criterion `Bencher` extension trait.
pub trait BencherExt {
    /// Times a `routine` with an input generated via a `proptest strategy`
    /// batch of input, and then times the iteration of the benchmark over the
    /// input. See [`BatchSize`] for details on choosing the batch size. The
    /// routine consumes its input.
    ///
    /// [`BatchSize`]: https://docs.rs/criterion/latest/criterion/enum.BatchSize.html
    fn iter_proptest_batched<R, S, O>(&mut self, strategy: S, routine: R, batch_size: usize)
    where
        R: FnMut(S::Value) -> O,
        S: Strategy;

    /// Times a `routine` with an input generated via a `proptest strategy`
    /// batch of input that can be polled for benchmarking pipeline combinators
    /// in [`Batch`] and then times the iteration of the benchmark
    /// over the input. See [`BatchSize`] for details on choosing the batch size.
    ///
    /// [`BatchSize`]: https://docs.rs/criterion/latest/criterion/enum.BatchSize.html
    /// [`Batch`]: crate::batch::Batch
    fn iter_proptest_combinators<R, S, O>(&mut self, strategy: S, routine: R, batch_size: usize)
    where
        R: FnMut(Poll<Receiver<Mbuf>>) -> O,
        S: Strategy<Value = Mbuf>,
        O: Batch;
}

impl BencherExt for Bencher<'_> {
    fn iter_proptest_batched<R, S: Strategy, O>(
        &mut self,
        strategy: S,
        mut routine: R,
        batch_size: usize,
    ) where
        R: FnMut(S::Value) -> O,
    {
        self.iter_custom(|mut iters| {
            let mut total_elapsed = Duration::from_secs(0);
            let mut gen = Rvg::deterministic();
            while iters > 0 {
                let batch_size = cmp::min(batch_size, iters as usize);
                let inputs = black_box(gen.generate_vec(&strategy, batch_size));
                let mut outputs = Vec::with_capacity(batch_size);
                let start = Instant::now();
                outputs.extend(inputs.into_iter().map(&mut routine));
                total_elapsed += start.elapsed();

                black_box(outputs);

                iters -= batch_size as u64;
            }
            total_elapsed
        })
    }

    fn iter_proptest_combinators<R, S: Strategy<Value = Mbuf>, O: Batch>(
        &mut self,
        strategy: S,
        mut routine: R,
        batch_size: usize,
    ) where
        R: FnMut(Poll<Receiver<Mbuf>>) -> O,
    {
        self.iter_custom(|mut iters| {
            let mut total_elapsed = Duration::from_secs(0);
            let mut gen = Rvg::deterministic();
            while iters > 0 {
                let batch_size = cmp::min(batch_size, iters as usize);
                let inputs = black_box(gen.generate_vec(&strategy, batch_size));
                let mut outputs = Vec::with_capacity(batch_size);

                let (mut tx, rx) = mpsc::channel();
                tx.transmit(inputs.into_iter().collect::<Vec<_>>());
                let mut new_batch = Poll::new(rx);
                new_batch.replenish();

                let start = Instant::now();
                let mut batch = routine(new_batch);

                while let Some(disp) = batch.next() {
                    outputs.push(disp)
                }

                total_elapsed += start.elapsed();

                black_box(batch);
                black_box(outputs);

                iters -= batch_size as u64;
            }
            total_elapsed
        })
    }
}