Enum ThreadControl

#[repr(u64)]
pub enum ThreadControl {
    Exit = 0,
    Yield = 1,
    SetTls = 2,
    GetTls = 3,
    SetUpcall = 4,
    GetUpcall = 5,
    ReadRegister = 6,
    WriteRegister = 7,
    SendMessage = 8,
    ChangeState = 9,
    SetTrapState = 10,
    GetTrapState = 11,
    SetPriority = 12,
    GetPriority = 13,
    SetAffinity = 14,
    GetAffinity = 15,
    ResumeFromUpcall = 16,
    GetSelfId = 17,
    GetActiveSctxId = 18,
}

Possible Thread Control operations

Variants

Exit = 0

Exit the thread. arg1 and arg2 should be code and location respectively, where code contains a 64-bit value to write into *location, followed by the kernel performing a thread-wake event on the memory word at location. If location is null, the write and thread-wake do not occur.

Yield = 1

Yield the thread’s CPU time now. The actual effect of this is unspecified, but it acts as a hint to the kernel that this thread does not need to run right now. The kernel, of course, is free to ignore this hint.

SetTls = 2

Set thread’s TLS pointer

GetTls = 3

Get the thread’s TLS pointer.

SetUpcall = 4

Set the thread’s upcall pointer (child threads in the same virtual address space will inherit).

GetUpcall = 5

Get the upcall pointer.

ReadRegister = 6

Read a register from the thread’s CPU state. The thread must be suspended.

WriteRegister = 7

Write a value to a register in the thread’s CPU state. The thread must be suspended.

SendMessage = 8

Send a user-defined async or sync event to the thread.

ChangeState = 9

Change the thread’s state. Allowed transitions are: running -> suspended suspended -> running running -> exited

SetTrapState = 10

Set the Trap State for the thread.

GetTrapState = 11

Get the Trap State for the thread.

SetPriority = 12

Set a thread’s priority. Threads require special permission to increase their priority.

GetPriority = 13

Get a thread’s priority.

SetAffinity = 14

Set a thread’s affinity.

GetAffinity = 15

Get a thread’s affinity.

ResumeFromUpcall = 16

Resume from an upcall.

GetSelfId = 17

Get the repr ID of the calling thread.

GetActiveSctxId = 18

Get the ID of the active security context.

Trait Implementations

impl Debug for ThreadControl

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

Formats the value using the given formatter.

impl From<ThreadControl> for u64

fn from(enum_value: ThreadControl) -> Self

Converts to this type from the input type.

impl From<u64> for ThreadControl

fn from(number: u64) -> Self

Converts to this type from the input type.

impl FromPrimitive for ThreadControl

type Primitive = u64

fn from_primitive(number: Self::Primitive) -> Self

impl Ord for ThreadControl

fn cmp(&self, other: &ThreadControl) -> Ordering

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for ThreadControl

fn eq(&self, other: &ThreadControl) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for ThreadControl

fn partial_cmp(&self, other: &ThreadControl) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for ThreadControl

impl StructuralPartialEq for ThreadControl