act.h File Reference

#include <act/types.h>
#include <act/lang.h>
#include <act/body.h>
#include <act/value.h>
#include <common/config.h>
#include <map>
#include <unordered_set>
#include "warn.def"

Go to the source code of this file.

Classes
class	Act
	The main Act class used to read in an ACT file and create basic data structures. All design information can be accessed through this data structure. More...
class	ActPass
	The main ActPass class used to implement an ACT analysis/synthesis pass. All the core tools use this framework to operate on the ACT data structures. Passes are called once the design has been expanded. More...
class	ActDynamicPass
	This is an ActPass that is dynamically loaded in at run-time via a shared object library. A dynamic pass can be used to extend the Act framework at run-time without having to re-compile/statically link in new functionality. Apart from loading in new passes in at runtime via C++, the interact command-line interface to the Act system also supports loading in new passes at runtime. More...
struct	ActDynamicPass::act_sh_passlib_info
	This holds information about the shared object file. More...
struct	ActDynamicPass::act_sh_dispatch_table
	These are the C function pointers extracted from the shared library used to execute the various methods in the ActDynamicPass. More...

Macros
#define	ACT_MODEL_CHP   0
	Modeling level is the CHP language.
#define	ACT_MODEL_HSE   1
	Modeling level is the HSE language.
#define	ACT_MODEL_PRS   2
	Modeling level is the PRS language.
#define	ACT_MODEL_DEVICE   3
	Modeling level is device: PRS + sizing translated into netlist.
#define	ACT_MODEL_TOTAL   4
	The total number of modeling levels (used for error checking)
#define	WARNING_FLAG(x, y)    static int x ;

Functions
Expr *	const_expr (long val)
Expr *	const_expr_bool (int v)
Expr *	const_expr_real (double v)
void	act_add_global_pint (const char *name, int val)
void	act_add_global_pbool (const char *name, int val)

Variables
const char *	act_model_names []

Detailed Description

Contains top-level initialization/management functions for the ACT library.

ACT can model a circuit at different levels of detail. The four levels are specified below.

The default level is the most detailed model available that can be provided by the user (PRS)

Macro Definition Documentation

ACT_MODEL_CHP

#define ACT_MODEL_CHP   0

Modeling level is the CHP language.

ACT_MODEL_DEVICE

#define ACT_MODEL_DEVICE   3

Modeling level is device: PRS + sizing translated into netlist.

ACT_MODEL_HSE

#define ACT_MODEL_HSE   1

Modeling level is the HSE language.

ACT_MODEL_PRS

#define ACT_MODEL_PRS   2

Modeling level is the PRS language.

ACT_MODEL_TOTAL

#define ACT_MODEL_TOTAL   4

The total number of modeling levels (used for error checking)

WARNING_FLAG

#define WARNING_FLAG	(		x,
			y
	)		static int x ;

Function Documentation

act_add_global_pbool()

void act_add_global_pbool	(	const char *	name,
		int	val
	)

For internal use only. This function is used to add a constant parameter definition before the Act library is used to read in a file. It should be called after Act::Init() to add global parameter definitions. IT MUST BE CALLED BEFORE an Act object is created!

Parameters

name	is the name of the pbool parameter
val	is the value of the parameter

act_add_global_pint()

void act_add_global_pint	(	const char *	name,
		int	val
	)

For internal use only. This function is used to add a constant parameter definition before the Act library is used to read in a file. It should be called after Act::Init() to add global parameter definitions. IT MUST BE CALLED BEFORE an Act object is created!

Parameters

name	is the name of the pint parameter
val	is the value of the parameter

const_expr()

Expr * const_expr

(

long

val

)

Create an Expr pointer corresponding to a constant integer expression. Constant expressions are cached globally, and should never be explicitly free'd.

Parameters

val	is the constant value for the expression

Returns

an Expr corresponding to the constant value

const_expr_bool()

Expr * const_expr_bool

(

int

v

)

Create an Expr pointer corresponding to a constant Boolean value (true or false). Constant expressions are cached globally, and should never be explicitly free'd.

Parameters

v	is the constant value for the expression (1 for true, 0 for false)

Returns

an Expr corresponding to the constant Boolean value

const_expr_real()

Expr * const_expr_real

(

double

v

)

Create an Expr pointer corresponding to a constant real number. Constant expressions are cached globally, and should never be explicitly free'd.

Parameters

v	is the constant value for the expression.

Returns

an Expr corresponding to the constant real number.

Variable Documentation

act_model_names

const char* act_model_names[]

extern

the string name for each model level, indexed by the ACT_MODEL_... macros