mirror of
https://github.com/verilator/verilator.git
synced 2025-01-01 04:07:34 +00:00
284 lines
10 KiB
C++
284 lines
10 KiB
C++
// -*- mode: C++; c-file-style: "cc-mode" -*-
|
|
//*************************************************************************
|
|
//
|
|
// Copyright 2003-2020 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
|
|
//
|
|
//*************************************************************************
|
|
///
|
|
/// \file
|
|
/// \brief Verilator: Include to provide information about symbol inspection
|
|
///
|
|
/// This file is for inclusion by internal files that need to inspect
|
|
/// specific symbols.
|
|
///
|
|
/// User routines wanting to inspect the symbol table should use
|
|
/// verilated_syms.h instead.
|
|
///
|
|
/// These classes are thread safe, and read only.
|
|
///
|
|
/// Code available from: https://verilator.org
|
|
///
|
|
//*************************************************************************
|
|
|
|
#ifndef _VERILATED_SYM_PROPS_H_
|
|
#define _VERILATED_SYM_PROPS_H_ 1 ///< Header Guard
|
|
|
|
#include "verilatedos.h"
|
|
|
|
//===========================================================================
|
|
/// Verilator range
|
|
/// Thread safety: Assume is constructed only with model, then any number of readers
|
|
|
|
// See also V3Ast::VNumRange
|
|
class VerilatedRange {
|
|
int m_left;
|
|
int m_right;
|
|
|
|
protected:
|
|
friend class VerilatedVarProps;
|
|
friend class VerilatedScope;
|
|
VerilatedRange()
|
|
: m_left(0)
|
|
, m_right(0) {}
|
|
VerilatedRange(int left, int right)
|
|
: m_left(left)
|
|
, m_right(right) {}
|
|
void init(int left, int right) {
|
|
m_left = left;
|
|
m_right = right;
|
|
}
|
|
|
|
public:
|
|
~VerilatedRange() {}
|
|
int left() const { return m_left; }
|
|
int right() const { return m_right; }
|
|
int low() const { return (m_left < m_right) ? m_left : m_right; }
|
|
int high() const { return (m_left > m_right) ? m_left : m_right; }
|
|
int elements() const {
|
|
return (VL_LIKELY(m_left >= m_right) ? (m_left - m_right + 1) : (m_right - m_left + 1));
|
|
}
|
|
int increment() const { return (m_left >= m_right) ? 1 : -1; }
|
|
};
|
|
|
|
//===========================================================================
|
|
/// Verilator variable
|
|
/// Thread safety: Assume is constructed only with model, then any number of readers
|
|
|
|
class VerilatedVarProps {
|
|
// TYPES
|
|
enum { MAGIC = 0xddc4f829 };
|
|
// MEMBERS
|
|
const vluint32_t m_magic; // Magic number
|
|
const VerilatedVarType m_vltype; // Data type
|
|
const VerilatedVarFlags m_vlflags; // Direction
|
|
const int m_pdims; // Packed dimensions
|
|
const int m_udims; // Unpacked dimensions
|
|
VerilatedRange m_packed; // Packed array range
|
|
VerilatedRange m_unpacked[3]; // Unpacked array range
|
|
// CONSTRUCTORS
|
|
protected:
|
|
friend class VerilatedScope;
|
|
VerilatedVarProps(VerilatedVarType vltype, VerilatedVarFlags vlflags, int pdims, int udims)
|
|
: m_magic(MAGIC)
|
|
, m_vltype(vltype)
|
|
, m_vlflags(vlflags)
|
|
, m_pdims(pdims)
|
|
, m_udims(udims) {}
|
|
|
|
public:
|
|
class Unpacked {};
|
|
// Without packed
|
|
VerilatedVarProps(VerilatedVarType vltype, int vlflags)
|
|
: m_magic(MAGIC)
|
|
, m_vltype(vltype)
|
|
, m_vlflags(VerilatedVarFlags(vlflags))
|
|
, m_pdims(0)
|
|
, m_udims(0) {}
|
|
VerilatedVarProps(VerilatedVarType vltype, int vlflags, Unpacked, int u0l, int u0r)
|
|
: m_magic(MAGIC)
|
|
, m_vltype(vltype)
|
|
, m_vlflags(VerilatedVarFlags(vlflags))
|
|
, m_pdims(0)
|
|
, m_udims(1) {
|
|
m_unpacked[0].init(u0l, u0r);
|
|
}
|
|
VerilatedVarProps(VerilatedVarType vltype, int vlflags, Unpacked, int u0l, int u0r, int u1l,
|
|
int u1r)
|
|
: m_magic(MAGIC)
|
|
, m_vltype(vltype)
|
|
, m_vlflags(VerilatedVarFlags(vlflags))
|
|
, m_pdims(0)
|
|
, m_udims(2) {
|
|
m_unpacked[0].init(u0l, u0r);
|
|
m_unpacked[1].init(u1l, u1r);
|
|
}
|
|
VerilatedVarProps(VerilatedVarType vltype, int vlflags, Unpacked, int u0l, int u0r, int u1l,
|
|
int u1r, int u2l, int u2r)
|
|
: m_magic(MAGIC)
|
|
, m_vltype(vltype)
|
|
, m_vlflags(VerilatedVarFlags(vlflags))
|
|
, m_pdims(0)
|
|
, m_udims(3) {
|
|
m_unpacked[0].init(u0l, u0r);
|
|
m_unpacked[1].init(u1l, u1r);
|
|
m_unpacked[2].init(u2l, u2r);
|
|
}
|
|
// With packed
|
|
class Packed {};
|
|
VerilatedVarProps(VerilatedVarType vltype, int vlflags, Packed, int pl, int pr)
|
|
: m_magic(MAGIC)
|
|
, m_vltype(vltype)
|
|
, m_vlflags(VerilatedVarFlags(vlflags))
|
|
, m_pdims(1)
|
|
, m_udims(0)
|
|
, m_packed(pl, pr) {}
|
|
VerilatedVarProps(VerilatedVarType vltype, int vlflags, Packed, int pl, int pr, Unpacked,
|
|
int u0l, int u0r)
|
|
: m_magic(MAGIC)
|
|
, m_vltype(vltype)
|
|
, m_vlflags(VerilatedVarFlags(vlflags))
|
|
, m_pdims(1)
|
|
, m_udims(1)
|
|
, m_packed(pl, pr) {
|
|
m_unpacked[0].init(u0l, u0r);
|
|
}
|
|
VerilatedVarProps(VerilatedVarType vltype, int vlflags, Packed, int pl, int pr, Unpacked,
|
|
int u0l, int u0r, int u1l, int u1r)
|
|
: m_magic(MAGIC)
|
|
, m_vltype(vltype)
|
|
, m_vlflags(VerilatedVarFlags(vlflags))
|
|
, m_pdims(1)
|
|
, m_udims(2)
|
|
, m_packed(pl, pr) {
|
|
m_unpacked[0].init(u0l, u0r);
|
|
m_unpacked[1].init(u1l, u1r);
|
|
}
|
|
VerilatedVarProps(VerilatedVarType vltype, int vlflags, Packed, int pl, int pr, Unpacked,
|
|
int u0l, int u0r, int u1l, int u1r, int u2l, int u2r)
|
|
: m_magic(MAGIC)
|
|
, m_vltype(vltype)
|
|
, m_vlflags(VerilatedVarFlags(vlflags))
|
|
, m_pdims(1)
|
|
, m_udims(3)
|
|
, m_packed(pl, pr) {
|
|
m_unpacked[0].init(u0l, u0r);
|
|
m_unpacked[1].init(u1l, u1r);
|
|
m_unpacked[2].init(u2l, u2r);
|
|
}
|
|
|
|
public:
|
|
~VerilatedVarProps() {}
|
|
// METHODS
|
|
bool magicOk() const { return m_magic == MAGIC; }
|
|
VerilatedVarType vltype() const { return m_vltype; }
|
|
VerilatedVarFlags vldir() const {
|
|
return static_cast<VerilatedVarFlags>(static_cast<int>(m_vlflags) & VLVF_MASK_DIR);
|
|
}
|
|
vluint32_t entSize() const;
|
|
bool isPublicRW() const { return ((m_vlflags & VLVF_PUB_RW) != 0); }
|
|
/// DPI compatible C standard layout
|
|
bool isDpiCLayout() const { return ((m_vlflags & VLVF_DPI_CLAY) != 0); }
|
|
int udims() const { return m_udims; }
|
|
int dims() const { return m_pdims + m_udims; }
|
|
const VerilatedRange& packed() const { return m_packed; }
|
|
const VerilatedRange& unpacked() const { return m_unpacked[0]; }
|
|
// DPI accessors
|
|
int left(int dim) const {
|
|
return dim == 0 ? m_packed.left()
|
|
: VL_LIKELY(dim >= 1 && dim <= 3) ? m_unpacked[dim - 1].left() : 0;
|
|
}
|
|
int right(int dim) const {
|
|
return dim == 0 ? m_packed.right()
|
|
: VL_LIKELY(dim >= 1 && dim <= 3) ? m_unpacked[dim - 1].right() : 0;
|
|
}
|
|
int low(int dim) const {
|
|
return dim == 0 ? m_packed.low()
|
|
: VL_LIKELY(dim >= 1 && dim <= 3) ? m_unpacked[dim - 1].low() : 0;
|
|
}
|
|
int high(int dim) const {
|
|
return dim == 0 ? m_packed.high()
|
|
: VL_LIKELY(dim >= 1 && dim <= 3) ? m_unpacked[dim - 1].high() : 0;
|
|
}
|
|
int increment(int dim) const {
|
|
return dim == 0 ? m_packed.increment()
|
|
: VL_LIKELY(dim >= 1 && dim <= 3) ? m_unpacked[dim - 1].increment() : 0;
|
|
}
|
|
int elements(int dim) const {
|
|
return dim == 0 ? m_packed.elements()
|
|
: VL_LIKELY(dim >= 1 && dim <= 3) ? m_unpacked[dim - 1].elements() : 0;
|
|
}
|
|
/// Total size in bytes (note DPI limited to 4GB)
|
|
size_t totalSize() const;
|
|
/// Adjust a data pointer to access a given array element, NuLL if something goes bad
|
|
void* datapAdjustIndex(void* datap, int dim, int indx) const;
|
|
};
|
|
|
|
//===========================================================================
|
|
/// Verilator DPI open array variable
|
|
|
|
class VerilatedDpiOpenVar {
|
|
// MEMBERS
|
|
const VerilatedVarProps* m_propsp; // Variable properties
|
|
void* m_datap; // Location of data (local to thread always, so safe)
|
|
public:
|
|
// CONSTRUCTORS
|
|
VerilatedDpiOpenVar(const VerilatedVarProps* propsp, void* datap)
|
|
: m_propsp(propsp)
|
|
, m_datap(datap) {}
|
|
VerilatedDpiOpenVar(const VerilatedVarProps* propsp, const void* datap)
|
|
: m_propsp(propsp)
|
|
, m_datap(const_cast<void*>(datap)) {}
|
|
~VerilatedDpiOpenVar() {}
|
|
// METHODS
|
|
void* datap() const { return m_datap; }
|
|
// METHODS - from VerilatedVarProps
|
|
bool magicOk() const { return m_propsp->magicOk(); }
|
|
VerilatedVarType vltype() const { return m_propsp->vltype(); }
|
|
bool isDpiStdLayout() const { return m_propsp->isDpiCLayout(); }
|
|
const VerilatedRange& packed() const { return m_propsp->packed(); }
|
|
const VerilatedRange& unpacked() const { return m_propsp->unpacked(); }
|
|
int udims() const { return m_propsp->udims(); }
|
|
int left(int dim) const { return m_propsp->left(dim); }
|
|
int right(int dim) const { return m_propsp->right(dim); }
|
|
int low(int dim) const { return m_propsp->low(dim); }
|
|
int high(int dim) const { return m_propsp->high(dim); }
|
|
int increment(int dim) const { return m_propsp->increment(dim); }
|
|
int elements(int dim) const { return m_propsp->elements(dim); }
|
|
size_t totalSize() const { return m_propsp->totalSize(); }
|
|
void* datapAdjustIndex(void* datap, int dim, int indx) const {
|
|
return m_propsp->datapAdjustIndex(datap, dim, indx);
|
|
}
|
|
};
|
|
|
|
//===========================================================================
|
|
/// Verilator variable
|
|
/// Thread safety: Assume is constructed only with model, then any number of readers
|
|
|
|
class VerilatedVar : public VerilatedVarProps {
|
|
// MEMBERS
|
|
void* m_datap; // Location of data
|
|
const char* m_namep; // Name - slowpath
|
|
protected:
|
|
friend class VerilatedScope;
|
|
// CONSTRUCTORS
|
|
VerilatedVar(const char* namep, void* datap, VerilatedVarType vltype,
|
|
VerilatedVarFlags vlflags, int dims)
|
|
: VerilatedVarProps(vltype, vlflags, (dims > 0 ? 1 : 0), ((dims > 1) ? dims - 1 : 0))
|
|
, m_datap(datap)
|
|
, m_namep(namep) {}
|
|
|
|
public:
|
|
~VerilatedVar() {}
|
|
// ACCESSORS
|
|
void* datap() const { return m_datap; }
|
|
const VerilatedRange& range() const { return packed(); } // Deprecated
|
|
const VerilatedRange& array() const { return unpacked(); } // Deprecated
|
|
const char* name() const { return m_namep; }
|
|
};
|
|
|
|
#endif // Guard
|