/**
* @name Find the root handle
* @brief Find the root handle using an optional name
*
* Get a handle to the root simulator object. This is usually the toplevel.
*
* If no name is provided, we return the first root instance.
*
* If name is provided, we check the name against the available objects until
* we find a match. If no match is found we return NULL
*/
GpiObjHdl *FliImpl::get_root_handle(const char *name)
{
mtiRegionIdT root;
char *rgn_name;
char *rgn_fullname;
std::string root_name;
std::string root_fullname;
PLI_INT32 accType;
PLI_INT32 accFullType;
for (root = mti_GetTopRegion(); root != NULL; root = mti_NextRegion(root)) {
LOG_DEBUG("Iterating over: %s", mti_GetRegionName(root));
if (name == NULL || !strcmp(name, mti_GetRegionName(root)))
break;
}
if (!root) {
goto error;
}
rgn_name = mti_GetRegionName(root);
rgn_fullname = mti_GetRegionFullName(root);
root_name = rgn_name;
root_fullname = rgn_fullname;
mti_VsimFree(rgn_fullname);
LOG_DEBUG("Found toplevel: %s, creating handle....", root_name.c_str());
accType = acc_fetch_type(root);
accFullType = acc_fetch_fulltype(root);
return create_gpi_obj_from_handle(root, root_name, root_fullname, accType, accFullType);
error:
LOG_ERROR("FLI: Couldn't find root handle %s", name);
for (root = mti_GetTopRegion(); root != NULL; root = mti_NextRegion(root)) {
if (name == NULL)
break;
LOG_ERROR("FLI: Toplevel instances: %s != %s...", name, mti_GetRegionName(root));
}
return NULL;
}
/**
* @name Find the root handle
* @brief Find the root handle using an optional name
*
* Get a handle to the root simulator object. This is usually the toplevel.
*
* If no name is provided, we return the first root instance.
*
* If name is provided, we check the name against the available objects until
* we find a match. If no match is found we return NULL
*/
GpiObjHdl *FliImpl::get_root_handle(const char *name)
{
mtiRegionIdT root;
GpiObjHdl *rv;
char *rgn_name;
std::string root_name;
for (root = mti_GetTopRegion(); root != NULL; root = mti_NextRegion(root)) {
LOG_DEBUG("Iterating over: %s", mti_GetRegionName(root));
if (name == NULL || !strcmp(name, mti_GetRegionName(root)))
break;
}
if (!root) {
goto error;
}
rgn_name = mti_GetRegionFullName(root);
root_name = rgn_name;
mti_VsimFree(rgn_name);
LOG_DEBUG("Found toplevel: %s, creating handle....", root_name.c_str());
rv = new FliRegionObjHdl(this, root);
rv->initialise(root_name);
LOG_DEBUG("Returning root handle %p", rv);
return rv;
error:
LOG_CRITICAL("FLI: Couldn't find root handle %s", name);
for (root = mti_GetTopRegion(); root != NULL; root = mti_NextRegion(root)) {
if (name == NULL)
break;
LOG_CRITICAL("FLI: Toplevel instances: %s != %s...", name, mti_GetRegionName(root));
}
return NULL;
}
GpiIterator::Status FliIterator::next_handle(std::string &name, GpiObjHdl **hdl, void **raw_hdl)
{
HANDLE obj;
GpiObjHdl *new_obj;
if (!selected)
return GpiIterator::END;
gpi_objtype_t obj_type = m_parent->get_type();
std::string parent_name = m_parent->get_name();
/* We want the next object in the current mapping.
* If the end of mapping is reached then we want to
* try next one until a new object is found
*/
do {
obj = NULL;
if (m_iterator != m_currentHandles->end()) {
obj = *m_iterator++;
/* For GPI_GENARRAY, only allow the generate statements through that match the name
* of the generate block.
*/
if (obj_type == GPI_GENARRAY) {
if (acc_fetch_fulltype(obj) == accForGenerate) {
std::string rgn_name = mti_GetRegionName(static_cast<mtiRegionIdT>(obj));
if (rgn_name.compare(0,parent_name.length(),parent_name) != 0) {
obj = NULL;
continue;
}
} else {
obj = NULL;
continue;
}
}
break;
} else {
LOG_DEBUG("No more valid handles in the current OneToMany=%d iterator", *one2many);
}
if (++one2many >= selected->end()) {
obj = NULL;
break;
}
/* GPI_GENARRAY are pseudo-regions and all that should be searched for are the sub-regions */
if (obj_type == GPI_GENARRAY && *one2many != FliIterator::OTM_REGIONS) {
LOG_DEBUG("fli_iterator OneToMany=%d skipped for GPI_GENARRAY type", *one2many);
continue;
}
populate_handle_list(*one2many);
switch (*one2many) {
case FliIterator::OTM_CONSTANTS:
case FliIterator::OTM_VARIABLE_SUB_ELEMENTS:
m_currentHandles = &m_vars;
m_iterator = m_vars.begin();
break;
case FliIterator::OTM_SIGNALS:
case FliIterator::OTM_SIGNAL_SUB_ELEMENTS:
m_currentHandles = &m_sigs;
m_iterator = m_sigs.begin();
break;
case FliIterator::OTM_REGIONS:
m_currentHandles = &m_regs;
m_iterator = m_regs.begin();
break;
default:
LOG_WARN("Unhandled OneToMany Type (%d)", *one2many);
}
} while (!obj);
if (NULL == obj) {
LOG_DEBUG("No more children, all relationships tested");
return GpiIterator::END;
}
char *c_name;
PLI_INT32 accType = 0;
PLI_INT32 accFullType = 0;
switch (*one2many) {
case FliIterator::OTM_CONSTANTS:
case FliIterator::OTM_VARIABLE_SUB_ELEMENTS:
c_name = mti_GetVarName(static_cast<mtiVariableIdT>(obj));
accFullType = accType = mti_GetVarKind(static_cast<mtiVariableIdT>(obj));
break;
case FliIterator::OTM_SIGNALS:
c_name = mti_GetSignalName(static_cast<mtiSignalIdT>(obj));
accType = acc_fetch_type(obj);
accFullType = acc_fetch_fulltype(obj);
break;
case FliIterator::OTM_SIGNAL_SUB_ELEMENTS:
c_name = mti_GetSignalNameIndirect(static_cast<mtiSignalIdT>(obj), NULL, 0);
accType = acc_fetch_type(obj);
accFullType = acc_fetch_fulltype(obj);
break;
case FliIterator::OTM_REGIONS:
c_name = mti_GetRegionName(static_cast<mtiRegionIdT>(obj));
accType = acc_fetch_type(obj);
accFullType = acc_fetch_fulltype(obj);
break;
default:
LOG_WARN("Unhandled OneToMany Type (%d)", *one2many);
}
if (!c_name) {
if (!VS_TYPE_IS_VHDL(accFullType)) {
*raw_hdl = (void *)obj;
return GpiIterator::NOT_NATIVE_NO_NAME;
}
return GpiIterator::NATIVE_NO_NAME;
}
/*
* If the parent is not a generate loop, then watch for generate handles and create
* the pseudo-region.
*
* NOTE: Taking advantage of the "caching" to only create one pseudo-region object.
* Otherwise a list would be required and checked while iterating
*/
if (*one2many == FliIterator::OTM_REGIONS && obj_type != GPI_GENARRAY && accFullType == accForGenerate) {
std::string idx_str = c_name;
std::size_t found = idx_str.find_last_of("(");
if (found != std::string::npos && found != 0) {
FliObj *fli_obj = dynamic_cast<FliObj *>(m_parent);
name = idx_str.substr(0,found);
obj = m_parent->get_handle<HANDLE>();
accType = fli_obj->get_acc_type();
accFullType = fli_obj->get_acc_full_type();
} else {
LOG_WARN("Unhandled Generate Loop Format - %s", name.c_str());
name = c_name;
}
} else {
name = c_name;
}
if (*one2many == FliIterator::OTM_SIGNAL_SUB_ELEMENTS) {
mti_VsimFree(c_name);
}
std::string fq_name = m_parent->get_fullname();
if (fq_name == "/") {
fq_name += name;
} else if (*one2many == FliIterator::OTM_SIGNAL_SUB_ELEMENTS ||
*one2many == FliIterator::OTM_VARIABLE_SUB_ELEMENTS ||
obj_type == GPI_GENARRAY) {
std::size_t found;
if (obj_type == GPI_STRUCTURE) {
found = name.find_last_of(".");
} else {
found = name.find_last_of("(");
}
if (found != std::string::npos) {
fq_name += name.substr(found);
if (obj_type != GPI_GENARRAY) {
name = name.substr(found+1);
}
} else {
LOG_WARN("Unhandled Sub-Element Format - %s", name.c_str());
fq_name += "/" + name;
}
} else {
fq_name += "/" + name;
}
FliImpl *fli_impl = reinterpret_cast<FliImpl *>(m_impl);
new_obj = fli_impl->create_gpi_obj_from_handle(obj, name, fq_name, accType, accFullType);
if (new_obj) {
*hdl = new_obj;
return GpiIterator::NATIVE;
} else {
return GpiIterator::NOT_NATIVE;
}
}
/**
* @name Native Check Create
* @brief Determine whether a simulation object is native to FLI and create
* a handle if it is
*/
GpiObjHdl* FliImpl::native_check_create(std::string &name, GpiObjHdl *parent)
{
bool search_rgn = false;
bool search_sig = false;
bool search_var = false;
std::string fq_name = parent->get_fullname();
gpi_objtype_t obj_type = parent->get_type();
if (fq_name == "/") {
fq_name += name;
search_rgn = true;
search_sig = true;
search_var = true;
} else if (obj_type == GPI_MODULE) {
fq_name += "/" + name;
search_rgn = true;
search_sig = true;
search_var = true;
} else if (obj_type == GPI_STRUCTURE) {
FliValueObjHdl *fli_obj = reinterpret_cast<FliValueObjHdl *>(parent);
fq_name += "." + name;
search_rgn = false;
search_var = fli_obj->is_var();
search_sig = !search_var;
} else {
LOG_ERROR("FLI: Parent of type %d must be of type GPI_MODULE or GPI_STRUCTURE to have a child.", obj_type);
return NULL;
}
LOG_DEBUG("Looking for child %s from %s", name.c_str(), parent->get_name_str());
std::vector<char> writable(fq_name.begin(), fq_name.end());
writable.push_back('\0');
HANDLE hdl = NULL;
PLI_INT32 accType;
PLI_INT32 accFullType;
if (search_rgn && (hdl = mti_FindRegion(&writable[0])) != NULL) {
accType = acc_fetch_type(hdl);
accFullType = acc_fetch_fulltype(hdl);
LOG_DEBUG("Found region %s -> %p", fq_name.c_str(), hdl);
LOG_DEBUG(" Type: %d", accType);
LOG_DEBUG(" Full Type: %d", accFullType);
} else if (search_sig && (hdl = mti_FindSignal(&writable[0])) != NULL) {
accType = acc_fetch_type(hdl);
accFullType = acc_fetch_fulltype(hdl);
LOG_DEBUG("Found a signal %s -> %p", fq_name.c_str(), hdl);
LOG_DEBUG(" Type: %d", accType);
LOG_DEBUG(" Full Type: %d", accFullType);
} else if (search_var && (hdl = mti_FindVar(&writable[0])) != NULL) {
accFullType = accType = mti_GetVarKind(static_cast<mtiVariableIdT>(hdl));
LOG_DEBUG("Found a variable %s -> %p", fq_name.c_str(), hdl);
LOG_DEBUG(" Type: %d", accType);
LOG_DEBUG(" Full Type: %d", accFullType);
} else if (search_rgn){
mtiRegionIdT rgn;
/* If not found, check to see if the name of a generate loop and create a pseudo-region */
for (rgn = mti_FirstLowerRegion(parent->get_handle<mtiRegionIdT>()); rgn != NULL; rgn = mti_NextRegion(rgn)) {
if (acc_fetch_fulltype(rgn) == accForGenerate) {
std::string rgn_name = mti_GetRegionName(static_cast<mtiRegionIdT>(rgn));
if (rgn_name.compare(0,name.length(),name) == 0) {
FliObj *fli_obj = dynamic_cast<FliObj *>(parent);
return create_gpi_obj_from_handle(parent->get_handle<HANDLE>(), name, fq_name, fli_obj->get_acc_type(), fli_obj->get_acc_full_type());
}
}
}
}
if (NULL == hdl) {
LOG_DEBUG("Didn't find anything named %s", &writable[0]);
return NULL;
}
/* Generate Loops have inconsistent behavior across fli. A "name"
* without an index, i.e. dut.loop vs dut.loop(0), will attempt to map
* to index 0, if index 0 exists. If it doesn't then it won't find anything.
*
* If this unique case is hit, we need to create the Pseudo-region, with the handle
* being equivalent to the parent handle.
*/
if (accFullType == accForGenerate) {
FliObj *fli_obj = dynamic_cast<FliObj *>(parent);
return create_gpi_obj_from_handle(parent->get_handle<HANDLE>(), name, fq_name, fli_obj->get_acc_type(), fli_obj->get_acc_full_type());
}
return create_gpi_obj_from_handle(hdl, name, fq_name, accType, accFullType);
}
GpiObjHdl *FliImpl::create_gpi_obj_from_handle(void *hdl, std::string &name, std::string &fq_name, int accType, int accFullType)
{
GpiObjHdl *new_obj = NULL;
LOG_DEBUG("Attepmting to create GPI object from handle (Type=%d, FullType=%d).", accType, accFullType);
if (!VS_TYPE_IS_VHDL(accFullType)) {
LOG_DEBUG("Handle is not a VHDL type.");
return NULL;
}
if (!isTypeValue(accType)) {
/* Need a Pseudo-region to handle generate loops in a consistent manner across interfaces
* and across the different methods of accessing data.
*/
std::string rgn_name = mti_GetRegionName(static_cast<mtiRegionIdT>(hdl));
if (name != rgn_name) {
LOG_DEBUG("Found pseudo-region %s -> %p", fq_name.c_str(), hdl);
new_obj = new FliObjHdl(this, hdl, GPI_GENARRAY, accType, accFullType);
} else {
LOG_DEBUG("Found region %s -> %p", fq_name.c_str(), hdl);
new_obj = new FliObjHdl(this, hdl, GPI_MODULE, accType, accFullType);
}
} else {
bool is_var;
bool is_const;
mtiTypeIdT valType;
mtiTypeKindT typeKind;
if (isTypeSignal(accType, accFullType)) {
LOG_DEBUG("Found a signal %s -> %p", fq_name.c_str(), hdl);
is_var = false;
is_const = false;
valType = mti_GetSignalType(static_cast<mtiSignalIdT>(hdl));
} else {
LOG_DEBUG("Found a variable %s -> %p", fq_name.c_str(), hdl);
is_var = true;
is_const = isValueConst(accFullType);
valType = mti_GetVarType(static_cast<mtiVariableIdT>(hdl));
}
typeKind = mti_GetTypeKind(valType);
switch (typeKind) {
case MTI_TYPE_ENUM:
if (isValueLogic(valType)) {
new_obj = new FliLogicObjHdl(this, hdl, GPI_REGISTER, is_const, accType, accFullType, is_var, valType, typeKind);
} else if (isValueBoolean(valType) || isValueChar(valType)) {
new_obj = new FliIntObjHdl(this, hdl, GPI_INTEGER, is_const, accType, accFullType, is_var, valType, typeKind);
} else {
new_obj = new FliEnumObjHdl(this, hdl, GPI_ENUM, is_const, accType, accFullType, is_var, valType, typeKind);
}
break;
case MTI_TYPE_SCALAR:
case MTI_TYPE_PHYSICAL:
new_obj = new FliIntObjHdl(this, hdl, GPI_INTEGER, is_const, accType, accFullType, is_var, valType, typeKind);
break;
case MTI_TYPE_REAL:
new_obj = new FliRealObjHdl(this, hdl, GPI_REAL, is_const, accType, accFullType, is_var, valType, typeKind);
break;
case MTI_TYPE_ARRAY: {
mtiTypeIdT elemType = mti_GetArrayElementType(valType);
mtiTypeKindT elemTypeKind = mti_GetTypeKind(elemType);
switch (elemTypeKind) {
case MTI_TYPE_ENUM:
if (isValueLogic(elemType)) {
new_obj = new FliLogicObjHdl(this, hdl, GPI_REGISTER, is_const, accType, accFullType, is_var, valType, typeKind); // std_logic_vector
} else if (isValueChar(elemType)) {
new_obj = new FliStringObjHdl(this, hdl, GPI_STRING, is_const, accType, accFullType, is_var, valType, typeKind);
} else {
new_obj = new FliValueObjHdl(this, hdl, GPI_ARRAY, false, accType, accFullType, is_var, valType, typeKind); // array of enums
}
break;
default:
new_obj = new FliValueObjHdl(this, hdl, GPI_ARRAY, false, accType, accFullType, is_var, valType, typeKind);// array of (array, Integer, Real, Record, etc.)
}
}
break;
case MTI_TYPE_RECORD:
new_obj = new FliValueObjHdl(this, hdl, GPI_STRUCTURE, false, accType, accFullType, is_var, valType, typeKind);
break;
default:
LOG_ERROR("Unable to handle object type for %s (%d)", name.c_str(), typeKind);
return NULL;
}
}
if (NULL == new_obj) {
LOG_DEBUG("Didn't find anything named %s", fq_name.c_str());
return NULL;
}
if (new_obj->initialise(name,fq_name) < 0) {
LOG_ERROR("Failed to initialise the handle %s", name.c_str());
delete new_obj;
return NULL;
}
return new_obj;
}
