Pin
Classes | Enumerations | Functions

Classes

class  LEVEL_BASE::KNOBVALUE< TYPE >
 
class  LEVEL_BASE::KNOBVALUE_LIST< TYPE >
 
class  LEVEL_BASE::KNOB_BASE
 
class  LEVEL_BASE::KNOB< TYPE >
 
class  LEVEL_BASE::KNOB_COMMENT
 
class  LEVEL_BASE::ADDRESS_RANGE
 

Enumerations

enum  LEVEL_BASE::KNOB_MODE {
  KNOB_MODE_INVALID,
  LEVEL_BASE::KNOB_MODE_COMMENT,
  LEVEL_BASE::KNOB_MODE_WRITEONCE,
  LEVEL_BASE::KNOB_MODE_OVERWRITE,
  LEVEL_BASE::KNOB_MODE_ACCUMULATE,
  LEVEL_BASE::KNOB_MODE_APPEND,
  KNOB_MODE_LAST
}
 

Functions

BOOL LEVEL_BASE::KNOB_BASE::SetByUser () const
 
 LEVEL_BASE::KNOB_BASE::KNOB_BASE (const std::string &myprefix, const std::string &myname, const std::string &myfamily, const std::string &mydefault, const std::string &mypurpose, KNOB_MODE mymode=KNOB_MODE_WRITEONCE)
 
int LEVEL_BASE::KNOB_BASE::Compare (const KNOB_BASE &k2) const
 
STATIC VOID LEVEL_BASE::KNOB_BASE::CheckAllKnobs (BOOL allowDashes=FALSE)
 
STATIC UINT32 LEVEL_BASE::KNOB_BASE::NumberOfKnobs ()
 
STATIC VOID LEVEL_BASE::KNOB_BASE::DisableKnobFamily (const std::string &myfamily)
 
STATIC VOID LEVEL_BASE::KNOB_BASE::EnableKnobFamily (const std::string &myfamily)
 
STATIC VOID LEVEL_BASE::KNOB_BASE::DisableKnob (const std::string &myname)
 
STATIC VOID LEVEL_BASE::KNOB_BASE::EnableKnob (const std::string &myname)
 
STATIC KNOB_BASELEVEL_BASE::KNOB_BASE::FindKnob (const std::string &name)
 
STATIC KNOB_BASELEVEL_BASE::KNOB_BASE::FindFamily (const std::string &name)
 
STATIC KNOB_BASELEVEL_BASE::KNOB_BASE::FindEnabledKnob (const std::string &name)
 
STATIC std::string LEVEL_BASE::KNOB_BASE::StringKnobSummary ()
 

Detailed Description

Availability:
Mode: JIT & Probe
O/S: Linux & Windows
CPU: All

Enumeration Type Documentation

◆ KNOB_MODE

Per knob mode - indicates how multiple appearances of the mode on the command line are handled

Enumerator
KNOB_MODE_COMMENT 

comment for knob family

KNOB_MODE_WRITEONCE 

single value, single write

KNOB_MODE_OVERWRITE 

single value, overwrite, unless the user set the knob from command line.

KNOB_MODE_ACCUMULATE 

single value, update

KNOB_MODE_APPEND 

list of values, append

Function Documentation

◆ CheckAllKnobs()

VOID LEVEL_BASE::KNOB_BASE::CheckAllKnobs ( BOOL  allowDashes = FALSE)

Check for duplicates amongst the declared knobs

◆ Compare()

int LEVEL_BASE::KNOB_BASE::Compare ( const KNOB_BASE k2) const
Returns
TRUE if two knobs are identical.

◆ DisableKnob()

VOID LEVEL_BASE::KNOB_BASE::DisableKnob ( const std::string &  myname)

Disable a particular knob

Parameters
mynameThe particular knob to disable

◆ DisableKnobFamily()

VOID LEVEL_BASE::KNOB_BASE::DisableKnobFamily ( const std::string &  myfamily)

Disable all options within a given family of knobs

Parameters
myfamilyThe family to disable

◆ EnableKnob()

VOID LEVEL_BASE::KNOB_BASE::EnableKnob ( const std::string &  myname)

Enable a particular knob

Parameters
mynameThe knob to enable

◆ EnableKnobFamily()

VOID LEVEL_BASE::KNOB_BASE::EnableKnobFamily ( const std::string &  myfamily)

Enable all options within a given family of knobs

Parameters
myfamilyThe family to enable

◆ FindEnabledKnob()

KNOB_BASE * LEVEL_BASE::KNOB_BASE::FindEnabledKnob ( const std::string &  myname)

Search for a knob that is currently not disabled

Parameters
mynameThe name of the knob to search which is currently enabled

◆ FindFamily()

KNOB_BASE * LEVEL_BASE::KNOB_BASE::FindFamily ( const std::string &  family)

Search for a knob family

Parameters
familyThe family of knobs to locate

◆ FindKnob()

KNOB_BASE * LEVEL_BASE::KNOB_BASE::FindKnob ( const std::string &  myname)

Locate a knob from the list of declared knobs

Parameters
mynameThe name of the knob to locate

◆ KNOB_BASE()

LEVEL_BASE::KNOB_BASE::KNOB_BASE ( const std::string &  myprefix,
const std::string &  myname,
const std::string &  myfamily,
const std::string &  mydefault,
const std::string &  mypurpose,
KNOB_MODE  mymode = KNOB_MODE_WRITEONCE 
)

Create a new knob

Parameters
mynameName of the knob
myfamilyFamily to which the knob belongs to
mydefaultThe default value to which the knob is initialized with
mypurposeA string that explains the purpose of the knob
mymodeKNOB_MODE

◆ NumberOfKnobs()

UINT32 LEVEL_BASE::KNOB_BASE::NumberOfKnobs ( )
Returns
The total number of knobs that have been declared

◆ SetByUser()

BOOL LEVEL_BASE::KNOB_BASE::SetByUser ( ) const
Returns
TRUE if the user set the knob from command line, FALSE otherwise.

◆ StringKnobSummary()

std::string LEVEL_BASE::KNOB_BASE::StringKnobSummary ( )

Print out a summary of all the knobs declared