use arbitrary_int::{u3, u4};
use bitbybit::bitfield;
#[bitfield(u64)]
#[derive(Debug)]
pub struct IptOption {
#[bits(0..=3, rw)]
pub trace_mode: u4,
#[bits(4..=7, rw)]
pub timing_mode: u4,
#[bits(8..=11, rw)]
pub mtc_freq: u4,
#[bits(12..=15, rw)]
pub cyc_thresh: u4,
#[bits(16..=19, rw)]
pub buffer_size_exp: u4,
#[bits(20..=22, rw)]
pub match_settings: u3,
#[bit(23, rw)]
pub inherit_to_children: bool,
#[bits(24..=27, rw)]
pub ring_filter: u4,
#[bits(28..=63)]
_reserved: u36,
}
impl IptOption {
pub const TRACE_MODE_BUFFER: u4 = u4::new(1);
pub const TRACE_MODE_FILE: u4 = u4::new(2);
pub const TIMING_MODE_OFF: u4 = u4::new(0);
pub const TIMING_MODE_MTC: u4 = u4::new(1);
pub const TIMING_MODE_MTC_CYC: u4 = u4::new(2);
pub const RING_FILTER_USER: u4 = u4::new(0);
pub const RING_FILTER_KERNEL: u4 = u4::new(1);
pub const RING_FILTER_KERNEL_USER: u4 = u4::new(2);
pub const RING_FILTER_USER_SYSTEM_WIDE: u4 = u4::new(3);
pub const RING_FILTER_KERNEL_SYSTEM_WIDE: u4 = u4::new(4);
pub const RING_FILTER_KERNEL_USER_SYSTEM_WIDE: u4 = u4::new(5);
}
impl Default for IptOption {
fn default() -> Self {
Self::builder()
.with_trace_mode(Self::TRACE_MODE_BUFFER)
.with_timing_mode(Self::TIMING_MODE_OFF)
.with_buffer_size_exp(u4::new(8))
.with_inherit_to_children(false)
.with_ring_filter(Self::RING_FILTER_USER)
.value
}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn size_matches_msr_width() {
assert_eq!(size_of::<IptOption>(), 8);
}
#[test]
fn field_round_trip() {
let opt = IptOption::new_with_raw_value(0)
.with_trace_mode(IptOption::TRACE_MODE_BUFFER)
.with_buffer_size_exp(u4::new(12))
.with_ring_filter(IptOption::RING_FILTER_USER)
.with_inherit_to_children(true);
assert_eq!(opt.trace_mode(), IptOption::TRACE_MODE_BUFFER);
assert_eq!(opt.buffer_size_exp(), u4::new(12));
assert_eq!(opt.ring_filter(), IptOption::RING_FILTER_USER);
assert!(opt.inherit_to_children());
}
}