Struct SampleBranchFlag 

pub struct SampleBranchFlag(/* private fields */);

Specify what branches to include in a branch record.

This is used by the builder in combination with setting SampleFlag::BRANCH_STACK.

The first part of the value is the privilege level, which is a combination of USER, BRANCH, or HV. PLM_ALL is a convenience value with all 3 ORed together. If none of the privilege levels are set then the kernel will use the privilege level of the event.

The second part specifies which branch types are to be included in the branch stack. At least one of these bits must be set.

Implementations

impl SampleBranchFlag

pub const USER: Self

The branch target is in user space.

pub const KERNEL: Self

The branch target is in kernel space.

pub const HV: Self

The branch target is in the hypervisor.

pub const ANY: Self

Include any branch type.

pub const ANY_CALL: Self

Include any call branch.

This includes direct calls, indirect calls, and far jumps.

pub const IND_CALL: Self

Include indirect calls.

pub const CALL: Self

Include direct calls.

pub const ANY_RETURN: Self

Include any return branch.

pub const IND_JUMP: Self

Include indirect jumps.

pub const COND: Self

Include conditional branches.

pub const ABORT_TX: Self

Include transactional memory aborts.

pub const IN_TX: Self

Include branches in a transactional memory transaction.

pub const NO_TX: Self

Include branches not in a transactional memory transaction.

pub const CALL_STACK: Self

Include branches that are part of a hardware-generated call stack.

Note that this requires hardware support. See the manpage for platforms which support this.

impl SampleBranchFlag

pub const fn empty() -> Self

Get a flags value with all bits unset.

pub const fn all() -> Self

Get a flags value with all known bits set.

pub const fn bits(&self) -> u64

Get the underlying bits value.

The returned value is exactly the bits set in this flags value.

pub const fn from_bits(bits: u64) -> Option<Self>

Convert from a bits value.

This method will return None if any unknown bits are set.

pub const fn from_bits_truncate(bits: u64) -> Self

Convert from a bits value, unsetting any unknown bits.

pub const fn from_bits_retain(bits: u64) -> Self

Convert from a bits value exactly.

pub fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set.

This method will return None if name is empty or doesn’t correspond to any named flag.

pub const fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

pub const fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

pub const fn intersects(&self, other: Self) -> bool

Whether any set bits in a source flags value are also set in a target flags value.

pub const fn contains(&self, other: Self) -> bool

Whether all set bits in a source flags value are also set in a target flags value.

pub fn insert(&mut self, other: Self)

The bitwise or (|) of the bits in two flags values.

pub fn remove(&mut self, other: Self)

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. remove won’t truncate other, but the ! operator will.

pub fn toggle(&mut self, other: Self)

The bitwise exclusive-or (^) of the bits in two flags values.

pub fn set(&mut self, other: Self, value: bool)

Call insert when value is true or remove when value is false.

pub const fn intersection(self, other: Self) -> Self

The bitwise and (&) of the bits in two flags values.

pub const fn union(self, other: Self) -> Self

The bitwise or (|) of the bits in two flags values.

pub const fn difference(self, other: Self) -> Self

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

pub const fn symmetric_difference(self, other: Self) -> Self

The bitwise exclusive-or (^) of the bits in two flags values.

pub const fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl SampleBranchFlag

pub const fn iter(&self) -> Iter<SampleBranchFlag>

Yield a set of contained flags values.

Each yielded flags value will correspond to a defined named flag. Any unknown bits will be yielded together as a final flags value.

pub const fn iter_names(&self) -> IterNames<SampleBranchFlag>

Yield a set of contained named flags values.

This method is like iter, except only yields bits in contained named flags. Any unknown bits, or bits not corresponding to a contained flag will not be yielded.

impl SampleBranchFlag

pub const PLM_ALL: Self

All privilege levels (USER, KERNEL, and HV) ORed together.

Trait Implementations

impl Binary for SampleBranchFlag

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl BitAnd for SampleBranchFlag

fn bitand(self, other: Self) -> Self

The bitwise and (&) of the bits in two flags values.

type Output = SampleBranchFlag

The resulting type after applying the & operator.

impl BitAndAssign for SampleBranchFlag

fn bitand_assign(&mut self, other: Self)

The bitwise and (&) of the bits in two flags values.

impl BitOr for SampleBranchFlag

fn bitor(self, other: SampleBranchFlag) -> Self

The bitwise or (|) of the bits in two flags values.

type Output = SampleBranchFlag

The resulting type after applying the | operator.

impl BitOrAssign for SampleBranchFlag

fn bitor_assign(&mut self, other: Self)

The bitwise or (|) of the bits in two flags values.

impl BitXor for SampleBranchFlag

fn bitxor(self, other: Self) -> Self

The bitwise exclusive-or (^) of the bits in two flags values.

type Output = SampleBranchFlag

The resulting type after applying the ^ operator.

impl BitXorAssign for SampleBranchFlag

fn bitxor_assign(&mut self, other: Self)

The bitwise exclusive-or (^) of the bits in two flags values.

impl Extend<SampleBranchFlag> for SampleBranchFlag

fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)

The bitwise or (|) of the bits in each flags value.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl Flags for SampleBranchFlag

const FLAGS: &'static [Flag<SampleBranchFlag>]

The set of defined flags.

type Bits = u64

The underlying bits type.

fn bits(&self) -> u64

Get the underlying bits value.

fn from_bits_retain(bits: u64) -> SampleBranchFlag

Convert from a bits value exactly.

fn empty() -> Self

Get a flags value with all bits unset.

fn all() -> Self

Get a flags value with all known bits set.

fn from_bits(bits: Self::Bits) -> Option<Self>

Convert from a bits value.

fn from_bits_truncate(bits: Self::Bits) -> Self

Convert from a bits value, unsetting any unknown bits.

fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set.

fn iter(&self) -> Iter<Self>

Yield a set of contained flags values.

fn iter_names(&self) -> IterNames<Self>

Yield a set of contained named flags values.

fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

fn intersects(&self, other: Self) -> bool

where Self: Sized,

Whether any set bits in a source flags value are also set in a target flags value.

fn contains(&self, other: Self) -> bool

where Self: Sized,

Whether all set bits in a source flags value are also set in a target flags value.

fn insert(&mut self, other: Self)

where Self: Sized,

The bitwise or (|) of the bits in two flags values.

fn remove(&mut self, other: Self)

where Self: Sized,

The intersection of a source flags value with the complement of a target flags value (&!).

fn toggle(&mut self, other: Self)

where Self: Sized,

The bitwise exclusive-or (^) of the bits in two flags values.

fn set(&mut self, other: Self, value: bool)

where Self: Sized,

Call Flags::insert when value is true or Flags::remove when value is false.

fn intersection(self, other: Self) -> Self

The bitwise and (&) of the bits in two flags values.

fn union(self, other: Self) -> Self

The bitwise or (|) of the bits in two flags values.

fn difference(self, other: Self) -> Self

The intersection of a source flags value with the complement of a target flags value (&!).

fn symmetric_difference(self, other: Self) -> Self

The bitwise exclusive-or (^) of the bits in two flags values.

fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl FromIterator<SampleBranchFlag> for SampleBranchFlag

fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self

The bitwise or (|) of the bits in each flags value.

impl IntoIterator for SampleBranchFlag

type Item = SampleBranchFlag

The type of the elements being iterated over.

type IntoIter = Iter<SampleBranchFlag>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl LowerHex for SampleBranchFlag

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Not for SampleBranchFlag

fn not(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

type Output = SampleBranchFlag

The resulting type after applying the ! operator.

impl Octal for SampleBranchFlag

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PublicFlags for SampleBranchFlag

type Primitive = u64

The type of the underlying storage.

type Internal = InternalBitFlags

The type of the internal field on the generated flags type.

impl Sub for SampleBranchFlag

fn sub(self, other: Self) -> Self

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

type Output = SampleBranchFlag

The resulting type after applying the - operator.

impl SubAssign for SampleBranchFlag

fn sub_assign(&mut self, other: Self)

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

impl UpperHex for SampleBranchFlag

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.