Struct Header 

pub struct Header {
    pub magic: u32,
    pub version_current: u32,
    pub version_minimal: u32,
    pub min: [u16; 3],
    pub max: [u16; 3],
    pub mode: ExecMode,
    pub sections: u16,
    pub entry_sec: u16,
    pub entry_off: u32,
    pub author: [u8; 32],
    pub name: [u8; 32],
    pub _reserved: [u8; 20],
    /* private fields */
}

The main header struct, which contains the metadata of the PKE file.

Fields

magic: u32

The magic number, fixed to ‘PKEX’

version_current: u32

Format version used to generate this PKEX binary.

Represents the PKEX file specification revision that the builder followed when creating this executable. This is separate from version_minimum.

• Breaking binary layout changes: increment this value, set version_minimum equal to it.
• Backward-compatible extensions (only using reserved space): increment this value, leave version_minimum unchanged.

version_minimal: u32

Lowest PKEX format version that can parse this binary correctly.

Loader enforcement rule: If the maximum format version supported by the loader is less than this value, the loader MUST reject loading this executable.

min: [u16; 3]

The minimal kernel version supported.

Note

As the proka-bootloader’s definitions, its format is similar like [major, minor, fix]. See proka-bootloader crate for more informations.

max: [u16; 3]

The maximum kernel supported.

For notes, see above.

mode: ExecMode

Signifies is this executable run as userapp or coredrv.

sections: u16

The section table count.

entry_sec: u16

The section which contains the entry point.

entry_off: u32

The entry offset of the section.

author: [u8; 32]

The author name (max length is 32 bytes).

name: [u8; 32]

The executable/project name.

_reserved: [u8; 20]

Reserved fields

Implementations

impl Header

pub fn new() -> Self

Create a header object.

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

Validate is this a valid proka executable.

pub fn to_array(&self) -> [u8; 128]

Convert this header to array

Trait Implementations

impl Clone for Header

fn clone(&self) -> Header

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for Header

impl Debug for Header

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

Formats the value using the given formatter.

impl Default for Header

fn default() -> Self

Returns the “default value” for a type.

impl Pod for Header

impl Zeroable for Header

fn zeroed() -> Self

Calls zeroed.