Struct UserExitInfo

pub struct UserExitInfo {
    kind: i32,
    exit_code: i64,
    reason: Option<String>,
    msg: Option<String>,
    dump: Option<String>,
}

Rust counterpart of C struct user_exit_info.

Fields

kind: i32

The C enum scx_exit_kind value. Test against ScxExitKind. None-zero value indicates that the BPF scheduler has exited.

exit_code: i64

reason: Option<String>

msg: Option<String>

dump: Option<String>

Implementations

impl UserExitInfo

pub fn new( kind_ptr: *const i32, exit_code_ptr: *const i64, reason_ptr: *const c_char, msg_ptr: *const c_char, dump_ptr: *const c_char, ) -> Self

Create UserExitInfo from C struct user_exit_info. Each scheduler implementation creates its own Rust binding for the C struct user_exit_info, so we can’t take the type directly. Instead, this method takes each member field. Use the macro uei_read!() on the C type which then calls this method with the individual fields.

pub fn report(&self) -> Result<()>

Print out the exit message to stderr if the exit was normal. After an error exit, it throws an error containing the exit message instead. If debug dump exists, it’s always printed to stderr.

pub fn exit_code(&self) -> Option<i64>

Return the exit code that the scheduler gracefully exited with. This only applies when the BPF scheduler exits with scx_bpf_exit(), i.e. kind ScxExitKind::UnregBPF.

pub fn should_restart(&self) -> bool

Test whether the BPF scheduler requested restart.

Trait Implementations

impl Debug for UserExitInfo

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

Formats the value using the given formatter.

impl Default for UserExitInfo

fn default() -> UserExitInfo

Returns the “default value” for a type.