Functions

Add field to meta register

Adds a field to the meta register.

Add an array of interfaces to a class

Interface arrays are especially useful when e.g. multiple "network ports" are available, although they can be added manually with distinct names (e.g. uartaiface, uartbiface, etc), the interface array registration allows for the addition of several interfaces at once. Individual interfaces are then referred to with normal index syntax, e.g. obj:uartiface[0].

Add a interface reference property.

temu_addLogginCategory adds a logging category to the class

0 for success, 1 indicates failure.

Make interface reference property and an interface inverses

A port is a bidirectional interface. Thus, if an interface reference is connected to another objects interface, the remote object will be told to issue a reverse connection. This is convenient as it simplifies device connection during system configuration and construction. That is, instead of calling the connect two times with the inverse connections explicitly, only one call is needed.

0 on success, non-zero otherwise.

Add a property to a class.

Add a interface reference property.

Add property without storage

A pseudo property does not have backing storage (and therefore no offset). They exist to provide access to computed properties.

Pseudo properties also work fine with C++ types with non-standard layout.

Pseudo properties are snapshotted if the set and get functions are implemented. The set and get should implement read and write without semantic effect. That is, if the property is a register, then the read and write should have the effect of an actual register access (including event rescheduling etc), while for a get/set, only the value of the register is modified, event restoration is done differently.

Add register property to class

Adds a register with the given name to a class. It returns a reference to a meta register which can be used to add fields.

A reference to a meta register which can be used to add fields.

Adds a register bank to a TEMU class

Pointer to the new register bank

temu_asDouble Converts the given property to double

Returns the property as an unsigned integer

temu_asInteger Converts the given propery to integer

Returns the property as integer

temu_asUnsigned Converts the given property to unsigned integer

Returns the property as an unsigned integer

Assemble an instruction

Instruction bitpattern.

Assemble an instruction to memory

Add asynchronous event triggered by file descriptor changes

Returns the file descriptor (Sock) if successful, otherwise -1.

Remove an asynchronous event triggered by file descriptor changes

Add asynchronously activated wall-clock timed events

The callback function will be called synchronously by the emulator core associated with Q. That means that when CB is executing it is safe to do anything that can be done from a normal event or MMIO handler.

Note that the event is only called when a CPU core or machine is running. When the timer has triggered, it is temporarily disabled and the CB is posted on the synchornous event queue as an async event. This will be executed when the next normal event expires (e.g. at the end of the current quanta). After the event has been called, depending on wether the timer is cyclic or not, it will be reactivated. This means that if the emulator is paused, at most one call to the event handler will be issued, and this will be done when the emulator is resumed.

Returns a file descriptor or timer ID.

Remove an async timer

Reverses bits in a 16 bit word.

Word with reversed bits.

Reverses bits in a 32 bit word.

Word with reversed bits.

Copy COW buffer. This will make a new buff object, but the underlying data will not be copied.

Buffer object referring to the same data as B.

Create a new COW buffer of size bytes.

Buffer object.

Delete buffer. The buffer B will be deleted. If there are no more copies of the buffer data anywhere, the data will be deallocated.

Get buffer length

Length of buffer in bytes

Get a pointer to readable buffer data

The pointer to the readable data will be returned.

Pointer to data buffer.

Remove len bytes from the start of the buffer.

Removing bytes from the buffer start will not change the underlying buffer object. And is not seen as a write for the purpose of the data block.

This does not affect other copies of this buffer.

Remove len bytes from the end of the buffer.

Removing bytes from the buffer tail will not change the underlying buffer object. And is not seen as a write for the purpose of the data block.

This does not affect other copies of this buffer.

Get a pointer to writable data.

If the data have more than one reference, a new copy of the data will be created.

Pointer to writable data.

Check object system sanity.

The function traverses all objects and their properties and ensures that all (scalar) interface properties are connected. An object can override the default check by implementing the checkSanity function in the ObjectIface.

Returns 0 if the object system is connected. Returns non-zero if the object system is not properly connected.

Get number of entries for the serialized property

Length of the property in elements. Negative on error.

Get value for named snapshot value

Property value with the contents saved to the snapshot

Get the class pointer for the named class

Pointer to the class if found, otherwise NULL

Get the class for the given object.

Pointer to the class type object

Query whether the class has a specific command implemented

0 if command is not implemented by class, 1 if implemented.

Clear lower set bit in word

A copy of Word with ther lowest set bit cleared

Clear lower set bit in word

A copy of Word with ther lowest set bit cleared

Clear attribute on memory space location

Clear right most bit in a word

A copy of Word, in which right most bit to be cleared

Clear right most bit in a word

A copy of Word, in which right most bit to be cleared

Count leading zeroes

Number of leading zeros in Word

Count leading zeroes

Number of leading zeros in Word

Count leading zeroes

The number of leading zeros in Word

Add named argument to command

Get data pointer from command context This function shall be called in a command handler on the passed context.

data pointer

Get pointer to the command interpreter This function shall be called in a command handler on the passed context.

Pointer to interpreter

Get named option as integer from command context This function shall be called in a command handler on the passed context.

The integer bound to the named argument

Get named option as object pointer from command context This function shall be called in a command handler on the passed context.

Pointer to the option object

Get named option as double from command context This function shall be called in a command handler on the passed context.

The real value of the option as double

Get named option as string from command context This function shall be called in a command handler on the passed context.

C-string of the name of the option

Get positional option at index This function shall be called in a command handler on the passed context.

The option at position Idx as a C-string

Get number of positional options given This function shall be called in a command handler on the passed context.

The number of position optionals in Ctxt

Get a variable in the command line

In case the variable is not found NULL, otherwise a borrowed string.

Return 1 if the option is valid, 0 if invalid / not set This function shall be called in a command handler on the passed context.

1 if the option is valid, 0 if invalid / not set

Set a variable in the command line

Non-zero on errors

Add delegate interface to component

Delegate interfaces are interfaces in objects internal in the component. It is possible to use the connect function to attach directly to a component delegated interface (although, in practice the connection is done to the internal object’s interface).

Note that delegate interface do not support interface arrays, and can only expose a single interface instance at present.

Add delegate property to component

Delegate property are properties in objects internal in the component. It is possible to use the connect function to connect from a delegated property directly using the component instead of the underlying object.

Allocate a component object.

The component create shall be called in the component constructor/create function (the create function passed to the registerComponent function). It will allocate an opaque component object with the relevant name.

The returned component is what the component constructor should return.

Component pointer

Deallocate a component object

The component dispose shall be called by the component destructor/dispose function registered in the registerComponent call.

Note that a component is seen as owning all the objects created with createComponentObject, and subsequently, all objects created will be recursively deleted when deleting the component.

Query the component for a delegated interface

Normally this function is not needed for the end user, however some usecases can be seen for exposing this. It returns the IfaceRef that has been added as a delegate interface. The main use is to redelegate delegated interfaces in a component of components.

Interface reference associated with Name, if none is found, iref type will be teTY_Invalid.

Query the compontent for a delegated property

Normally this should not be called by the user. But is useful in case the user constructs components of components in which case a component can redelegate delegated properties.

Object name pair with the target object and property name.

Get named object in component

NULL if the object is not a member in the component

Connect an interface property in object A to the interface in object B. If A.PropName is an interface array, B,B:IfaceName will be appended to it. For dynamic arrays, it is pushed to the end, for static arrays, it is placed in the first null slot (unless, the indexing syntax is used in the property name).

0 on success, otherwise non-zero

Disable traps on processor

Enable traps on processor

Get a 32 bit floating point register

Host float with the content of the FPU register

Get a 32 bit floating point register

Floating point register contents

Get 64 bit floating point register as double

FPU register value

Get 64 bit floating point register contents

FPU register value

Get the clock frequency for the CPU

The configured clock frequency in Hz.

Get the Machine for a given CPU

Pointer to the machine object

Get the program counter

The program counter will be returned.

The value of the program counter register

Gets the register in the processor

Register value

Raise a trap The function simulates a trap being raised at the current PC.

Reset the processor.

Resetting the CPU will result in a reset cascade where all connected devices are also reset.

Run the processor for a number of cycles

The function runs the processor for a number of cycles. If you wish to run the processor with another time unit, you can compute the cycles from the clock frequency of the emulated processor.

In case the processor halts or enters idle mode and there are no pending events the function will return early.

The number of executed cycles.

Set floating point register value

Set 32 bit floating point register value

Set FPU register value

Set FPU register value

Set the program counter

The program counter will be set to the supplied value.

Set the register in the processor

Run the processor for a number of steps

This function is different from temu_cpuRun, which runs for a time. The steps here indicates instructions executed (including trapping instructions). This can be contrasted to the run function which may advance the cycle counter by more than one for an instruction (depending on the timing models).

The function may return early in case the processor halts its execution or has entered idle mode and there are no events pending.

The number of executed steps.

Uses the MMU to translate the given virtual address Va to the physical address in the emulator

error code. 0 on success, non-zero otherwise,

Create and register global command

Create an object in a component.

This function works as the temu_createObject, except that the object created is inserted in the component.

The function is indended to be used in the component constructor.

Object names are uniqued using the objnamefmt paramters and following varargs. Plus, that the name of the component itself is prefixed as '[compname]-'.

Pointer to created object.

Create a new GDB server

Create object with class and name.

Allocated object. Result is NULL in case of: class does not exist, object already allocated with the given name, out of memory.

Checks whether A + L crosses power of 2 boundary (e.g. page)

True if boundary is crossed. False otherwise.

Checks whether A + L crosses power of 2 boundary (e.g. page)

True if boundary is crossed. False otherwise.

Count trailing zeroes, this can be used as a square root on a power of 2 word.

Number of trailing zeros in Word

Count trailing zeroes, this can be used as a square root on a power of 2 word.

Number of trailing zeros in Word

Count trailing zeroes

The number of trailing zeros in Word

Convert cycles to nanoseconds

Cycles converted to nanoseconds

Convert cycles to seconds

Cycles converted to seconds

De-serialise the simulation state.

The function clears the whole internal object system, reads the JSON file FileName and creates all the objects.

If a class implements the ObjectIface, the (optional) deserialise procedure will be called.

0 on success, otherwise non-zero

temu_deserialiseProp Deserialize a serialized property

temu_dictCreate Creates a dictionary object

A pointer to the dictionary object

temu_dictDispose Delete a dictionary object

temu_dictGetNextKey Given a specific key of a dictionary, the next key is provided by this function

The key that comes after Key, or nullptr on failure

temu_dictGetValue retrieve a dictionary value by name

The value

temu_dictInsertValue Inserts a name/value pair to a dictionary

0 on success. Other values indicate failures (e.g. the key is already used)

temu_dictRemoveValue Erase a name/value pair from a dictionary by name

0 on success. Other values indicate errors (e.g. key was unavailable in the dictionary)

Disassemble an instruction.

A pointer to a malloced instruction string or null incase of failure.

Disassemble an instruction.

A pointer to a a thread local instruction string or null incase of failure.

Disassemble an instruction in memory

The function dissasmbles an instruction and retuns a string allocated on the heap. You are responsible for its release using free().

A pointer to a malloced instruction string or null incase of failure.

Dispose a GDB server

Dispose object. The function will call the Objects dispose function.

Dispose (deallocate) the symbol table

Return non-zero if file has DWARF data

0 if file does not contain DWARF, 1 if the file contains DWARF.

Get length / EtherType field. By ethernet standard, the size field which is 16 bit, will be a length if it is

1500 and an ethertype tag if it is >= 1536.

Get a readable pointer to the payload. Note that the first bytes will often be an LLC header, it may not be your actual data payload.

It is possible to depublish events explicitly, but this is rarely needed as it is managed at termination time automatically.

Deschedule event

Get delta time in cycles for the given event and queue

Number of simulated cycles in the future the event will trigger

Get delta time in nanoseconds for the given event and queue

Number of simulated nanoseconds in the future when the event will trigger

Get delta time in seconds for the given event and queue

Number of simulated seconds in the future when the event will trigger

Check if event is scheduled

Zero (0) in case the event is not scheduled, otherwise non-zero for scheduled events.

Post an event to an asynchronous queue

Post events with a relative time in cycles in the future

Note that if posting a scheduled event, a warning will be printed and the event will be automatically descheduled before being inserted in the event queue.

Post events with a relative time in nanoseconds in the future

Post events with a relative time in seconds in the future

Post events in the event queue stack

Stacked events are executed either after the current instruction is finished or when the machine quanta expires in case of machine synchronised events.

Publish an event.

The function will allocate an event structure in the global event heap and return the event ID.

A typical use is to call the function in the object constructor and assign the event id to a field in the object. This field should not be snapshotted (i.e. it will be reassigned in the constructor) when restoring an object anyway.

The event ID >= 0 in case of success. Negative values indicate errors.

Publish a preallocated event object.

The event objects can be embedded in your own class if needed.

The event ID.

Get the frequency in Hz of the given queue.

Set the cycles property on an event.

Periodic events have the advantage that they do not slip due to reposting of event with respect to the event triggering time and behaves as if the reposting is 1, automatic and 2, is relative to the event schedule time. which differ from the triggering time by possibly a few cycles. Note, calling this function does not reschedule the event.