LibRISCV.Effects.Operations.Default.Machine.Register

Provides a polymorphic implementation of a register file. This module is intended to be used internally by interpreters for the Operations effect. This register file implementation also provides facilities for storing a concrete program counter.

Documentation

data RegisterFile (t :: Type -> Type -> Type) a

Register file addressed by RegIdx. The type is parameterized over an array implementation (such as IOUArray) and a generic value type (used to represent instruction operands).

Constructors

RegisterFile

Fields

• pc :: IORef Word32

  The current program counter (always concrete in this implementation).

• regs :: t RegIdx a

  The underlying array to store the register values.

mkRegFile :: forall (t :: Type -> Type -> Type) a. MArray t a IO => a -> IO (RegisterFile t a)

Create a new register file, initializing all registers with the given default value. This value must represent the zero value in the chosen value type.

dumpRegs :: forall (t :: Type -> Type -> Type) a. MArray t a IO => (a -> ShowS) -> RegisterFile t a -> IO String

Dump the current register file state as a String.

readRegister :: forall (t :: Type -> Type -> Type) a. MArray t a IO => RegisterFile t a -> RegIdx -> IO a

Read register value at given register index. For the Zero register index, the zero/default value (as passed to mkRegFile is always returned.

writeRegister :: forall (t :: Type -> Type -> Type) a. MArray t a IO => RegisterFile t a -> RegIdx -> a -> IO ()

Write register at given register index. Writes to the Zero register are ignored.

readPC :: forall (t :: Type -> Type -> Type) a. RegisterFile t a -> IO Word32

Returs the current program counter value.

writePC :: forall (t :: Type -> Type -> Type) a. RegisterFile t a -> Word32 -> IO ()

Write a new program counter value.