#include "circt/Dialect/Arc/Runtime/ArcRuntime.h"
#include "circt/Dialect/Arc/Runtime/Common.h"
#include "circt/Dialect/Arc/Runtime/IRInterface.h"
#include "circt/Dialect/Arc/Runtime/ModelInstance.h"
#include <cassert>
#include <cstdlib>
#include <iostream>

Include dependency graph for ArcRuntime.cpp:

Macros
#define	ARC_RUNTIME_ENABLE_EXPORT

Functions
static void	internalError (const char *message)

static ModelInstance *	getModelInstance (ArcState *instance)

ArcState *	arcRuntimeAllocateInstance (const ArcRuntimeModelInfo model, const char args)

void	arcRuntimeDeleteInstance (ArcState *instance)
	Destroy and deallocate the state of a model instance.

uint64_t	arcRuntimeGetAPIVersion ()
	Return the API version of the runtime library.

void	arcRuntimeOnEval (ArcState *instance)
	Pre-Eval hook. Must be called by the driver once before every `eval` step.

ArcState *	arcRuntimeGetStateFromModelState (uint8_t *modelState, uint64_t offset)
	Project a pointer to the model state to its ArcState container.

uint8_t *	arcRuntimeIR_allocInstance (const ArcRuntimeModelInfo model, const char args)
	Allocate and initialize the state for a new instance of the given hardware model.

void	arcRuntimeIR_onEval (uint8_t *modelState)
	Pre-Eval hook of the runtime library.

void	arcRuntimeIR_deleteInstance (uint8_t *modelState)
	Destroy and deallocate the state of a model instance.

Macro Definition Documentation

◆ ARC_RUNTIME_ENABLE_EXPORT

#define ARC_RUNTIME_ENABLE_EXPORT

Definition at line 14 of file ArcRuntime.cpp.

Function Documentation

◆ arcRuntimeAllocateInstance()

ArcState * arcRuntimeAllocateInstance	(	const ArcRuntimeModelInfo *	model,
		const char *	args
	)

Definition at line 43 of file ArcRuntime.cpp.

References ArcRuntimeModelInfo::apiVersion, ARC_RUNTIME_API_VERSION, ARC_RUNTIME_MAGIC, assert(), internalError(), and ArcRuntimeModelInfo::numStateBytes.

Referenced by arcRuntimeIR_allocInstance().

◆ arcRuntimeDeleteInstance()

void arcRuntimeDeleteInstance ( ArcState * instance )

Destroy and deallocate the state of a model instance.

Definition at line 61 of file ArcRuntime.cpp.

References ArcState::impl.

Referenced by arcRuntimeIR_deleteInstance().

◆ arcRuntimeGetAPIVersion()

uint64_t arcRuntimeGetAPIVersion ( )

Return the API version of the runtime library.

Definition at line 67 of file ArcRuntime.cpp.

References ARC_RUNTIME_API_VERSION.

◆ arcRuntimeGetStateFromModelState()

ArcState * arcRuntimeGetStateFromModelState	(	uint8_t *	modelState,
		uint64_t	offset
	)

Project a pointer to the model state to its ArcState container.

offset is the byte offset of the given pointer within the model state.

Definition at line 73 of file ArcRuntime.cpp.

References ARC_RUNTIME_MAGIC, internalError(), and ArcState::magic.

Referenced by arcRuntimeIR_deleteInstance(), and arcRuntimeIR_onEval().

◆ arcRuntimeIR_allocInstance()

uint8_t * arcRuntimeIR_allocInstance	(	const ArcRuntimeModelInfo *	model,
		const char *	args
	)

Allocate and initialize the state for a new instance of the given hardware model.

This function must allocate an ArcState struct with at least model->numStateBytes bytes provided for the modelState array. It must return the pointer to the zero initialized model state which is required to be 16-byte-aligned.

args is a zero terminated string containing implementation specific options for the new instance or null.

Definition at line 86 of file ArcRuntime.cpp.

References arcRuntimeAllocateInstance(), and ArcState::modelState.