luke
/
verilator
mirror of https://github.com/verilator/verilator.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Clean VPI struct member coverage 

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This commit is contained in:
Nick Brereton 2026-06-22 18:02:20 -04:00
parent 2004c87892
commit 91c2147fa9
5 changed files with 43 additions and 51 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
include/verilated.cpp
View File

@ -3929,8 +3929,6 @@ uint32_t VerilatedVarProps::entSize() const VL_MT_SAFE {
case VLVT_UINT32: size = sizeof(IData); break; case VLVT_UINT32: size = sizeof(IData); break;
case VLVT_UINT64: size = sizeof(QData); break; case VLVT_UINT64: size = sizeof(QData); break;
case VLVT_WDATA: size = VL_WORDS_I(entBits()) * sizeof(IData); break; case VLVT_WDATA: size = VL_WORDS_I(entBits()) * sizeof(IData); break;
case VLVT_STRUCT: size = 0; break;
case VLVT_UNION: size = 0; break;
default: size = 0; break; // LCOV_EXCL_LINE default: size = 0; break; // LCOV_EXCL_LINE
} }
return size; return size;
@ -4041,9 +4039,9 @@ VerilatedVar* VerilatedScope::varInsert(const char* namep, void* datap, bool isP
VerilatedVar* VerilatedScope::varInsertSized(const char* namep, void* datap, bool isParam, VerilatedVar* VerilatedScope::varInsertSized(const char* namep, void* datap, bool isParam,
VerilatedVarType vltype, int vlflags, int udims, VerilatedVarType vltype, int vlflags, int udims,
int pdims, uint32_t entSize...) VL_MT_UNSAFE { uint32_t entSize...) VL_MT_UNSAFE {
if (!m_varsp) m_varsp = new VerilatedVarNameMap; if (!m_varsp) m_varsp = new VerilatedVarNameMap;
VerilatedVar var(namep, datap, vltype, static_cast<VerilatedVarFlags>(vlflags), udims, pdims, VerilatedVar var(namep, datap, vltype, static_cast<VerilatedVarFlags>(vlflags), udims, 0,
isParam, entSize); isParam, entSize);
va_list ap; va_list ap;
@ -4054,12 +4052,6 @@ VerilatedVar* VerilatedScope::varInsertSized(const char* namep, void* datap, boo
var.m_unpacked[i].m_left = msb; var.m_unpacked[i].m_left = msb;
var.m_unpacked[i].m_right = lsb; var.m_unpacked[i].m_right = lsb;
} }
for (int i = 0; i < pdims; ++i) {
const int msb = va_arg(ap, int);
const int lsb = va_arg(ap, int);
var.m_packed[i].m_left = msb;
var.m_packed[i].m_right = lsb;
}
va_end(ap); va_end(ap);
m_varsp->emplace(namep, std::move(var)); m_varsp->emplace(namep, std::move(var));

4
include/verilated.h
View File

@ -766,8 +766,8 @@ public: // But internals only - called from verilated modules, VerilatedSyms
VerilatedVar* varInsert(const char* namep, void* datap, bool isParam, VerilatedVarType vltype, VerilatedVar* varInsert(const char* namep, void* datap, bool isParam, VerilatedVarType vltype,
int vlflags, int udims, int pdims, ...) VL_MT_UNSAFE; int vlflags, int udims, int pdims, ...) VL_MT_UNSAFE;
VerilatedVar* varInsertSized(const char* namep, void* datap, bool isParam, VerilatedVar* varInsertSized(const char* namep, void* datap, bool isParam,
VerilatedVarType vltype, int vlflags, int udims, int pdims, VerilatedVarType vltype, int vlflags, int udims, uint32_t entSize,
uint32_t entSize, ...) VL_MT_UNSAFE; ...) VL_MT_UNSAFE;
VerilatedVar* forceableVarInsert(const char* namep, void* datap, bool isParam, VerilatedVar* forceableVarInsert(const char* namep, void* datap, bool isParam,
VerilatedVarType vltype, int vlflags, VerilatedVarType vltype, int vlflags,
void* forceReadSignalData, const char* forceReadSignalName, void* forceReadSignalData, const char* forceReadSignalName,

72
include/verilated_vpi.cpp
View File

@ -505,9 +505,6 @@ public:
const char* const parentName = varp()->name(); const char* const parentName = varp()->name();
const std::string memberName = memberVarp->name(); const std::string memberName = memberVarp->name();
const size_t parentLen = std::strlen(parentName); const size_t parentLen = std::strlen(parentName);
if (memberName.size() <= parentLen || memberName.compare(0, parentLen, parentName) != 0
|| memberName[parentLen] != '.')
return nullptr; // LCOV_EXCL_LINE: Defensive; callers pass exact synthetic members
void* const parentDatap = varp()->datap(); void* const parentDatap = varp()->datap();
void* const memberDatap = memberVarp->datap(); void* const memberDatap = memberVarp->datap();
@ -2514,7 +2511,7 @@ static bool vl_vpi_parse_indices(std::string& name, std::vector<PLI_INT32>& indi
return true; return true;
} }
static const VerilatedScope* vl_vpi_top_port_scopep(const VerilatedScope* const scopep) { static const VerilatedScope* _vl_vpi_top_port_scopep(const VerilatedScope* const scopep) {
if (VL_UNLIKELY(!scopep)) return nullptr; if (VL_UNLIKELY(!scopep)) return nullptr;
if (scopep->type() != VerilatedScope::SCOPE_MODULE) return nullptr; if (scopep->type() != VerilatedScope::SCOPE_MODULE) return nullptr;
if (std::strcmp(scopep->name(), "TOP") == 0) return nullptr; if (std::strcmp(scopep->name(), "TOP") == 0) return nullptr;
@ -2522,9 +2519,9 @@ static const VerilatedScope* vl_vpi_top_port_scopep(const VerilatedScope* const
return Verilated::threadContextp()->scopeFind("TOP"); return Verilated::threadContextp()->scopeFind("TOP");
} }
static bool vl_vpi_find_dotted_var(const std::string& scopename, const std::string& basename, static bool _vl_vpi_find_dotted_var(const std::string& scopename, const std::string& basename,
const VerilatedScope*& scopep, const VerilatedVar*& varp, const VerilatedScope*& scopep, const VerilatedVar*& varp,
std::string& fullname) { std::string& fullname) {
if (scopename.empty()) return false; if (scopename.empty()) return false;
// Unpacked struct/union members are exposed as synthetic vars whose names contain dots // Unpacked struct/union members are exposed as synthetic vars whose names contain dots
@ -2542,7 +2539,7 @@ static bool vl_vpi_find_dotted_var(const std::string& scopename, const std::stri
scopep = Verilated::threadContextp()->scopeFind(dottedScope.empty() ? "TOP" scopep = Verilated::threadContextp()->scopeFind(dottedScope.empty() ? "TOP"
: dottedScope.c_str()); : dottedScope.c_str());
if (scopep) { if (scopep) {
if (const VerilatedScope* const topScopep = vl_vpi_top_port_scopep(scopep)) { if (const VerilatedScope* const topScopep = _vl_vpi_top_port_scopep(scopep)) {
if (const VerilatedVar* const topVarp = topScopep->varFind(dottedName.c_str())) { if (const VerilatedVar* const topVarp = topScopep->varFind(dottedName.c_str())) {
scopep = topScopep; scopep = topScopep;
varp = topVarp; varp = topVarp;
@ -2557,8 +2554,8 @@ static bool vl_vpi_find_dotted_var(const std::string& scopename, const std::stri
} }
} }
static VerilatedVpioVar* vl_vpi_handle_member_by_name(const std::string& name, static VerilatedVpioVar* _vl_vpi_handle_member_by_name(const std::string& name,
const VerilatedVpioVar* vop) { const VerilatedVpioVar* vop) {
const VerilatedScope* const scopep = vop->scopep(); const VerilatedScope* const scopep = vop->scopep();
if (VL_UNLIKELY(!scopep)) return nullptr; if (VL_UNLIKELY(!scopep)) return nullptr;
const std::string memberName = std::string{vop->varp()->name()} + "." + name; const std::string memberName = std::string{vop->varp()->name()} + "." + name;
@ -2567,8 +2564,8 @@ static VerilatedVpioVar* vl_vpi_handle_member_by_name(const std::string& name,
return vop->withMember(memberVarp); return vop->withMember(memberVarp);
} }
static VerilatedVpioVar* vl_vpi_handle_apply_indices(VerilatedVpioVar* vop, static VerilatedVpioVar* _vl_vpi_handle_apply_indices(VerilatedVpioVar* vop,
const std::vector<PLI_INT32>& indices) { const std::vector<PLI_INT32>& indices) {
for (const PLI_INT32 index : indices) { for (const PLI_INT32 index : indices) {
VerilatedVpioVar* const nextVop = vop->withIndex(index); VerilatedVpioVar* const nextVop = vop->withIndex(index);
VL_DO_CLEAR(delete vop, vop = nullptr); VL_DO_CLEAR(delete vop, vop = nullptr);
@ -2578,7 +2575,7 @@ static VerilatedVpioVar* vl_vpi_handle_apply_indices(VerilatedVpioVar* vop,
return vop; return vop;
} }
static bool vl_vpi_parse_optional_indices(std::string& name, std::vector<PLI_INT32>& indices) { static bool _vl_vpi_parse_optional_indices(std::string& name, std::vector<PLI_INT32>& indices) {
indices.clear(); indices.clear();
if (name.empty()) return false; if (name.empty()) return false;
if (name.back() != ']') return true; if (name.back() != ']') return true;
@ -2587,8 +2584,8 @@ static bool vl_vpi_parse_optional_indices(std::string& name, std::vector<PLI_INT
return vl_vpi_parse_indices(name, indices, &bitRange) && !bitRange.valid; return vl_vpi_parse_indices(name, indices, &bitRange) && !bitRange.valid;
} }
static std::vector<std::string> vl_vpi_split_dotted_name(const std::string& name) { static void _vl_vpi_split_dotted_name(const std::string& name, std::vector<std::string>& parts) {
std::vector<std::string> parts; parts.clear();
const char* const namep = name.c_str(); const char* const namep = name.c_str();
const char* beginp = namep; const char* beginp = namep;
const char* posp = beginp; const char* posp = beginp;
@ -2597,23 +2594,22 @@ static std::vector<std::string> vl_vpi_split_dotted_name(const std::string& name
beginp = ++posp; beginp = ++posp;
} }
parts.emplace_back(beginp); parts.emplace_back(beginp);
return parts;
} }
static VerilatedVpioVar* static VerilatedVpioVar*
vl_vpi_handle_indexed_member_from_scope(const VerilatedScope* const scopep, _vl_vpi_handle_indexed_member_from_scope(const VerilatedScope* const scopep,
const std::vector<std::string>& parts, const std::vector<std::string>& parts,
const size_t firstPart) { const size_t firstPart) {
if (VL_UNLIKELY(!scopep) || VL_UNLIKELY(firstPart >= parts.size())) return nullptr; if (VL_UNLIKELY(!scopep) || VL_UNLIKELY(firstPart >= parts.size())) return nullptr;
std::string baseName = parts[firstPart]; std::string baseName = parts[firstPart];
std::vector<PLI_INT32> indices; std::vector<PLI_INT32> indices;
if (!vl_vpi_parse_optional_indices(baseName, indices)) return nullptr; if (!_vl_vpi_parse_optional_indices(baseName, indices)) return nullptr;
const VerilatedScope* varScopep = scopep; const VerilatedScope* varScopep = scopep;
const VerilatedVar* baseVarp = nullptr; const VerilatedVar* baseVarp = nullptr;
std::string fullnameOverride; std::string fullnameOverride;
if (const VerilatedScope* const topScopep = vl_vpi_top_port_scopep(scopep)) { if (const VerilatedScope* const topScopep = _vl_vpi_top_port_scopep(scopep)) {
if (const VerilatedVar* const topVarp = topScopep->varFind(baseName.c_str())) { if (const VerilatedVar* const topVarp = topScopep->varFind(baseName.c_str())) {
varScopep = topScopep; varScopep = topScopep;
baseVarp = topVarp; baseVarp = topVarp;
@ -2629,29 +2625,30 @@ vl_vpi_handle_indexed_member_from_scope(const VerilatedScope* const scopep,
: new VerilatedVpioVar{baseVarp, varScopep, baseVarp->datap(), : new VerilatedVpioVar{baseVarp, varScopep, baseVarp->datap(),
_vl_vpi_member_local_name(baseVarp->name()), _vl_vpi_member_local_name(baseVarp->name()),
fullnameOverride}; fullnameOverride};
VerilatedVpioVar* vop = vl_vpi_handle_apply_indices(baseVop, indices); VerilatedVpioVar* vop = _vl_vpi_handle_apply_indices(baseVop, indices);
if (!vop) return nullptr; if (!vop) return nullptr;
for (size_t i = firstPart + 1; i < parts.size(); ++i) { for (size_t i = firstPart + 1; i < parts.size(); ++i) {
std::string memberName = parts[i]; std::string memberName = parts[i];
if (!vl_vpi_parse_optional_indices(memberName, indices)) { if (!_vl_vpi_parse_optional_indices(memberName, indices)) {
VL_DO_CLEAR(delete vop, vop = nullptr); VL_DO_CLEAR(delete vop, vop = nullptr);
return nullptr; return nullptr;
} }
VerilatedVpioVar* const memberVop = vl_vpi_handle_member_by_name(memberName, vop); VerilatedVpioVar* const memberVop = _vl_vpi_handle_member_by_name(memberName, vop);
VL_DO_CLEAR(delete vop, vop = nullptr); VL_DO_CLEAR(delete vop, vop = nullptr);
if (!memberVop) return nullptr; if (!memberVop) return nullptr;
vop = vl_vpi_handle_apply_indices(memberVop, indices); vop = _vl_vpi_handle_apply_indices(memberVop, indices);
if (!vop) return nullptr; if (!vop) return nullptr;
} }
return vop; return vop;
} }
static VerilatedVpioVar* static VerilatedVpioVar*
vl_vpi_handle_dotted_indexed_member_by_name(const std::string& scopeAndName) { _vl_vpi_handle_dotted_indexed_member_by_name(const std::string& scopeAndName) {
const std::vector<std::string> parts = vl_vpi_split_dotted_name(scopeAndName); std::vector<std::string> parts;
_vl_vpi_split_dotted_name(scopeAndName, parts);
if (parts.size() < 2) return nullptr; if (parts.size() < 2) return nullptr;
for (size_t firstPart = parts.size() - 1; firstPart > 0; --firstPart) { for (size_t firstPart = parts.size() - 1; firstPart > 0; --firstPart) {
@ -2661,13 +2658,13 @@ vl_vpi_handle_dotted_indexed_member_by_name(const std::string& scopeAndName) {
= Verilated::threadContextp()->scopeFind(scopeName.c_str()); = Verilated::threadContextp()->scopeFind(scopeName.c_str());
if (!scopep) continue; if (!scopep) continue;
if (VerilatedVpioVar* const vop if (VerilatedVpioVar* const vop
= vl_vpi_handle_indexed_member_from_scope(scopep, parts, firstPart)) { = _vl_vpi_handle_indexed_member_from_scope(scopep, parts, firstPart)) {
return vop; return vop;
} }
} }
const VerilatedScope* const topScopep = Verilated::threadContextp()->scopeFind("TOP"); const VerilatedScope* const topScopep = Verilated::threadContextp()->scopeFind("TOP");
return vl_vpi_handle_indexed_member_from_scope(topScopep, parts, 0); return _vl_vpi_handle_indexed_member_from_scope(topScopep, parts, 0);
} }
// for obtaining handles // for obtaining handles
@ -2702,7 +2699,8 @@ vpiHandle vpi_handle_by_name(PLI_BYTE8* namep, vpiHandle scope) {
scopeAndName scopeAndName
= std::string{voScopep->fullname()} + (scopeIsPackage ? "" : ".") + scopeAndName; = std::string{voScopep->fullname()} + (scopeIsPackage ? "" : ".") + scopeAndName;
} else if (voVarp && voVarp->isStructOrUnion()) { } else if (voVarp && voVarp->isStructOrUnion()) {
if (VerilatedVpioVar* const memberp = vl_vpi_handle_member_by_name(scopeAndName, voVarp)) { if (VerilatedVpioVar* const memberp
= _vl_vpi_handle_member_by_name(scopeAndName, voVarp)) {
return memberp->castVpiHandle(); return memberp->castVpiHandle();
} }
scopeAndName = std::string{voVarp->fullname()} + "." + scopeAndName; scopeAndName = std::string{voVarp->fullname()} + "." + scopeAndName;
@ -2769,9 +2767,9 @@ vpiHandle vpi_handle_by_name(PLI_BYTE8* namep, vpiHandle scope) {
// Exact unindexed member names can be found directly; indexed member paths need the // Exact unindexed member names can be found directly; indexed member paths need the
// component walker so array indices are applied before member offsets. // component walker so array indices are applied before member offsets.
if (!varp if (!varp
&& !vl_vpi_find_dotted_var(scopename, basename, scopep, varp, fullnameOverride)) { && !_vl_vpi_find_dotted_var(scopename, basename, scopep, varp, fullnameOverride)) {
if (VerilatedVpioVar* const memberp if (VerilatedVpioVar* const memberp
= vl_vpi_handle_dotted_indexed_member_by_name(scopeAndName)) { = _vl_vpi_handle_dotted_indexed_member_by_name(scopeAndName)) {
return memberp->castVpiHandle(); return memberp->castVpiHandle();
} }
return nullptr; return nullptr;
@ -3030,13 +3028,13 @@ PLI_INT32 vpi_get(PLI_INT32 property, vpiHandle object) {
case vpiPacked: { case vpiPacked: {
const VerilatedVpioVarBase* const vop = VerilatedVpioVarBase::castp(object); const VerilatedVpioVarBase* const vop = VerilatedVpioVarBase::castp(object);
if (VL_LIKELY(vop && vop->isStructOrUnion())) return 0; if (VL_LIKELY(vop && vop->isStructOrUnion())) return 0;
break; // FALLTHRU
} }
default: break; default:
VL_VPI_ERROR_(__FILE__, __LINE__, "%s: Unsupported property %s, nothing will be returned",
__func__, VerilatedVpiError::strFromVpiProp(property));
return vpiUndefined;
} }
VL_VPI_ERROR_(__FILE__, __LINE__, "%s: Unsupported property %s, nothing will be returned",
__func__, VerilatedVpiError::strFromVpiProp(property));
return vpiUndefined;
} }
PLI_INT64 vpi_get64(PLI_INT32 /*property*/, vpiHandle /*object*/) { PLI_INT64 vpi_get64(PLI_INT32 /*property*/, vpiHandle /*object*/) {

5
src/V3EmitCSyms.cpp
View File

@ -253,11 +253,12 @@ class EmitCSyms final : EmitCBaseVisitorConst {
stmt += vlEnumDir; // VLVD_IN etc stmt += vlEnumDir; // VLVD_IN etc
stmt += ", "; stmt += ", ";
stmt += std::to_string(udim); stmt += std::to_string(udim);
stmt += ", ";
stmt += std::to_string(pdim);
if (!entSize.empty()) { if (!entSize.empty()) {
stmt += ", "; stmt += ", ";
stmt += entSize; stmt += entSize;
} else {
stmt += ", ";
stmt += std::to_string(pdim);
} }
stmt += bounds; stmt += bounds;
stmt += ")"; stmt += ")";

1
test_regress/t/t_vpi_var.cpp
View File

@ -2232,6 +2232,7 @@ int main(int argc, char** argv) {
uint64_t sim_time = 1100; uint64_t sim_time = 1100;
contextp->debug(0); contextp->debug(0);
contextp->commandArgs(argc, argv); contextp->commandArgs(argc, argv);
VerilatedVpi::selfTest();
const std::unique_ptr<VM_PREFIX> topp{new VM_PREFIX{contextp.get(), const std::unique_ptr<VM_PREFIX> topp{new VM_PREFIX{contextp.get(),
// Note null name - we're flattening it out // Note null name - we're flattening it out