#![allow(clippy::missing_errors_doc)]
#[derive(Copy, Clone, Debug, PartialEq, Eq, Hash)]
pub enum WorkloadShape {
Streaming,
ProducerFast {
burst: u32,
},
WorkSteal {
n_consumers: u32,
batch_size: u32,
},
Cooperative {
n_cores: u32,
},
VariantRace {
n_variants: u32,
},
}
#[derive(Copy, Clone, Debug)]
pub struct WorkloadShapeHints {
pub use_mailbox_routing: bool,
pub oversubscription_log2: Option<u8>,
pub use_burst: bool,
}
impl WorkloadShape {
pub const fn hints(self) -> WorkloadShapeHints {
match self {
WorkloadShape::Streaming => WorkloadShapeHints {
use_mailbox_routing: false,
oversubscription_log2: None,
use_burst: false,
},
WorkloadShape::ProducerFast { burst } => WorkloadShapeHints {
use_mailbox_routing: false,
oversubscription_log2: Some(if burst >= 64 { 2 } else { 1 }),
use_burst: true,
},
WorkloadShape::WorkSteal {
n_consumers,
batch_size: _,
} => WorkloadShapeHints {
use_mailbox_routing: false,
oversubscription_log2: Some(if n_consumers >= 8 { 2 } else { 1 }),
use_burst: false,
},
WorkloadShape::Cooperative { n_cores } => WorkloadShapeHints {
use_mailbox_routing: n_cores >= 8,
oversubscription_log2: None,
use_burst: true,
},
WorkloadShape::VariantRace { n_variants: _ } => WorkloadShapeHints {
use_mailbox_routing: false,
oversubscription_log2: Some(0),
use_burst: false,
},
}
}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn streaming_maps_to_minimal_hints() {
let h = WorkloadShape::Streaming.hints();
assert!(!h.use_mailbox_routing);
assert!(!h.use_burst);
}
#[test]
fn producer_fast_enables_burst() {
let h = WorkloadShape::ProducerFast { burst: 64 }.hints();
assert!(h.use_burst);
assert_eq!(h.oversubscription_log2, Some(2));
}
#[test]
fn producer_fast_small_burst_lower_oversubscription() {
let h = WorkloadShape::ProducerFast { burst: 8 }.hints();
assert_eq!(h.oversubscription_log2, Some(1));
}
#[test]
fn work_steal_does_not_burst() {
let h = WorkloadShape::WorkSteal { n_consumers: 4, batch_size: 16 }.hints();
assert!(!h.use_burst);
assert_eq!(h.oversubscription_log2, Some(1));
}
#[test]
fn cooperative_enables_mailbox_at_threshold() {
let small = WorkloadShape::Cooperative { n_cores: 4 }.hints();
assert!(!small.use_mailbox_routing);
let large = WorkloadShape::Cooperative { n_cores: 16 }.hints();
assert!(large.use_mailbox_routing);
assert!(large.use_burst);
}
#[test]
fn variant_race_does_not_burst() {
let h = WorkloadShape::VariantRace { n_variants: 3 }.hints();
assert!(!h.use_burst);
assert_eq!(h.oversubscription_log2, Some(0));
}
}