verilator/test_regress/t/t_vpi_package.cpp
2024-01-02 18:57:34 -05:00

256 lines
7.2 KiB
C++

// -*- mode: C++; c-file-style: "cc-mode" -*-
//*************************************************************************
//
// Copyright 2010-2011 by Wilson Snyder. This program is free software; you can
// redistribute it and/or modify it under the terms of either the GNU
// Lesser General Public License Version 3 or the Perl Artistic License
// Version 2.0.
// SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0
//
//*************************************************************************
#ifdef IS_VPI
#include "sv_vpi_user.h"
#include <cstdlib>
#else
#include "verilated.h"
#include "verilated_vcd_c.h"
#include "verilated_vpi.h"
#include "Vt_vpi_package.h"
#include "Vt_vpi_package__Dpi.h"
#include "svdpi.h"
#endif
#include <cstdio>
#include <cstring>
#include <iostream>
// These require the above. Comment prevents clang-format moving them
#include "TestSimulator.h"
#include "TestVpi.h"
// __FILE__ is too long
#define FILENM "t_vpi_package.cpp"
#define DEBUG \
if (0) printf
#define CHECK_RESULT_NZ(got) \
if (!(got)) { \
printf("%%Error: %s:%d: GOT = NULL EXP = !NULL\n", FILENM, __LINE__); \
return __LINE__; \
}
#define CHECK_RESULT_Z(got) \
if (got) { \
printf("%%Error: %s:%d: GOT = !NULL EXP = NULL\n", FILENM, __LINE__); \
return __LINE__; \
}
#define CHECK_RESULT(got, exp) \
if ((got) != (exp)) { \
std::cout << std::dec << "%Error: " << FILENM << ":" << __LINE__ << ": GOT = " << (got) \
<< " EXP = " << (exp) << std::endl; \
return __LINE__; \
}
#define CHECK_RESULT_CSTR(got, exp) \
if (std::strcmp((got), (exp))) { \
printf("%%Error: %s:%d: GOT = '%s' EXP = '%s'\n", FILENM, __LINE__, \
(got) ? (got) : "<null>", (exp) ? (exp) : "<null>"); \
return __LINE__; \
}
extern "C" {
int count_params(TestVpiHandle& handle, int expectedParams) {
TestVpiHandle it = vpi_iterate(vpiParameter, handle);
CHECK_RESULT_NZ(it)
int params = 0;
while (true) {
TestVpiHandle handle = vpi_scan(it);
if (!handle) break;
const int vpi_type = vpi_get(vpiType, handle);
CHECK_RESULT(vpi_type, vpiParameter);
params++;
}
it.freed();
CHECK_RESULT(params, expectedParams);
return 0;
}
int check_handle(char* name, vpiHandle scopeHandle) {
const TestVpiHandle handle = vpi_handle_by_name(name, scopeHandle);
CHECK_RESULT_NZ(handle)
return 0;
}
int mon_check() {
#ifdef TEST_VERBOSE
printf("-mon_check()\n");
#endif
TestVpiHandle it = vpi_iterate(vpiModule, NULL);
CHECK_RESULT_NZ(it)
bool found_t = false;
while (true) {
TestVpiHandle handle = vpi_scan(it);
if (handle == NULL) break;
CHECK_RESULT_CSTR("t", vpi_get_str(vpiName, handle))
CHECK_RESULT_Z(found_t)
found_t = true;
}
it.freed();
CHECK_RESULT_NZ(found_t);
it = vpi_iterate(vpiInstance, NULL);
CHECK_RESULT_NZ(it)
TestVpiHandle pkgHandle = NULL;
TestVpiHandle tHandle = NULL;
TestVpiHandle unitHandle = NULL;
while (true) {
TestVpiHandle handle = vpi_scan(it);
if (handle == NULL) break;
const char* name = vpi_get_str(vpiName, handle);
const char* fullname = vpi_get_str(vpiFullName, handle);
if (!strcmp("t", name)) {
CHECK_RESULT_CSTR("t", fullname)
CHECK_RESULT_Z(tHandle)
tHandle = handle;
handle.freed();
} else if (!strcmp("somepackage", name)) {
CHECK_RESULT_CSTR("somepackage::", fullname)
CHECK_RESULT_Z(pkgHandle)
pkgHandle = handle;
handle.freed();
} else if (!strcmp("$unit", name)) {
CHECK_RESULT_CSTR("$unit::", fullname)
CHECK_RESULT_Z(unitHandle)
unitHandle = handle;
handle.freed();
} else {
CHECK_RESULT_NZ(0)
}
}
it.freed();
CHECK_RESULT_NZ(pkgHandle)
CHECK_RESULT_NZ(tHandle)
CHECK_RESULT_NZ(unitHandle)
CHECK_RESULT_Z(count_params(unitHandle, 1));
CHECK_RESULT_Z(count_params(pkgHandle, 2));
CHECK_RESULT_Z(count_params(tHandle, 3));
CHECK_RESULT_Z(check_handle(const_cast<PLI_BYTE8*>("someOtherInt"), tHandle))
CHECK_RESULT_Z(check_handle(const_cast<PLI_BYTE8*>("t.someOtherInt"), NULL))
CHECK_RESULT_Z(check_handle(const_cast<PLI_BYTE8*>("someInt"), pkgHandle))
CHECK_RESULT_Z(check_handle(const_cast<PLI_BYTE8*>("somepackage::someInt"), NULL))
CHECK_RESULT_Z(check_handle(const_cast<PLI_BYTE8*>("dollarUnitInt"), unitHandle))
CHECK_RESULT_Z(check_handle(const_cast<PLI_BYTE8*>("$unit::dollarUnitInt"), NULL))
CHECK_RESULT_Z(check_handle(const_cast<PLI_BYTE8*>("somepackage"), NULL))
return 0; // Ok
}
}
//======================================================================
#ifdef IS_VPI
static int mon_check_vpi() {
TestVpiHandle href = vpi_handle(vpiSysTfCall, 0);
s_vpi_value vpi_value;
vpi_value.format = vpiIntVal;
vpi_value.value.integer = mon_check();
vpi_put_value(href, &vpi_value, NULL, vpiNoDelay);
return 0;
}
static s_vpi_systf_data vpi_systf_data[] = {{vpiSysFunc, vpiIntFunc, (PLI_BYTE8*)"$mon_check",
(PLI_INT32(*)(PLI_BYTE8*))mon_check_vpi, 0, 0, 0},
0};
// cver entry
void vpi_compat_bootstrap(void) {
p_vpi_systf_data systf_data_p;
systf_data_p = &(vpi_systf_data[0]);
while (systf_data_p->type != 0) vpi_register_systf(systf_data_p++);
}
// icarus entry
void (*vlog_startup_routines[])() = {vpi_compat_bootstrap, 0};
#else
int main(int argc, char** argv) {
const std::unique_ptr<VerilatedContext> contextp{new VerilatedContext};
uint64_t sim_time = 1100;
contextp->debug(0);
contextp->commandArgs(argc, argv);
// We're going to be checking for these errors so don't crash out
contextp->fatalOnVpiError(0);
{
// Construct and destroy
const std::unique_ptr<VM_PREFIX> topp{
new VM_PREFIX{contextp.get(),
// Note null name - we're flattening it out
""}};
}
// Test second construction
const std::unique_ptr<VM_PREFIX> topp{new VM_PREFIX{contextp.get(),
// Note null name - we're flattening it out
""}};
#ifdef VERILATOR
#ifdef TEST_VERBOSE
contextp->scopesDump();
#endif
#endif
#if VM_TRACE
contextp->traceEverOn(true);
VL_PRINTF("Enabling waves...\n");
VerilatedVcdC* tfp = new VerilatedVcdC;
topp->trace(tfp, 99);
tfp->open(STRINGIFY(TEST_OBJ_DIR) "/simx.vcd");
#endif
topp->eval();
contextp->timeInc(10);
while (contextp->time() < sim_time && !contextp->gotFinish()) {
contextp->timeInc(1);
topp->eval();
VerilatedVpi::callValueCbs();
// mon_do();
#if VM_TRACE
if (tfp) tfp->dump(contextp->time());
#endif
}
if (!contextp->gotFinish()) {
vl_fatal(FILENM, __LINE__, "main", "%Error: Timeout; never got a $finish");
}
topp->final();
#if VM_TRACE
if (tfp) tfp->close();
#endif
return 0;
}
#endif