Struct lc3_ensemble::sim::SimFlags

pub struct SimFlags {
    pub strict: bool,
    pub use_real_halt: bool,
    pub machine_init: MachineInitStrategy,
    pub debug_frames: bool,
    pub ignore_privilege: bool,
}

Configuration flags for Simulator.

These can be modified after the Simulator is created with Simulator::new and their effects should still apply.

Read the field descriptions for more details.

Fields

strict: bool

Whether strict mode is enabled.

Strict mode adds additional integrity checks to the simulator, such as verifying initialization state is normal for provided data.

By default, this flag is false.

use_real_halt: bool

Whether to use the real HALT trap.

There are two implementations of HALT within Simulator:

• virtual HALT: On execution of HALT or TRAP x25, the simulator is automatically halted before executing any true TRAP routine.
• real HALT: On execution of HALT or TRAP x25, the TRAP routine for HALT implemented in the OS is run and executed as usual.

Real HALT is useful for maintaining integrity to the LC-3 ISA, whereas virtual HALT preserves the state of the machine prior to calling the OS’s HALT routine.

By default, this flag is false.

machine_init: MachineInitStrategy

The creation strategy for uninitialized Words.

This is used to initialize the mem and reg_file fields.

By default, this flag is MachineInitStrategy::default.

debug_frames: bool

Whether to store debugging information about call frames.

This flag only goes into effect after a Simulator::new or Simulator::reset call.

By default, this flag is false.

ignore_privilege: bool

If true, privilege checks are ignored and the simulator runs as though the executor has supervisor level privilege.

By default, this flag is false.

Trait Implementations

impl Clone for SimFlags

fn clone(&self) -> SimFlags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SimFlags

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

Formats the value using the given formatter.

impl Default for SimFlags

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for SimFlags

fn eq(&self, other: &SimFlags) -> 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 Copy for SimFlags

impl Eq for SimFlags

impl StructuralPartialEq for SimFlags