mirror of
https://github.com/verilator/verilator.git
synced 2025-01-20 05:14:02 +00:00
e6857df5c6
This commit has the following replacements applied:
s/\bAstUserInUseBase\b/VNUserInUseBase/g;
s/\bAstAttrType\b/VAttrType/g;
s/\bAstBasicDTypeKwd\b/VBasicDTypeKwd/g;
s/\bAstDisplayType\b/VDisplayType/g;
s/\bAstNDeleter\b/VNDeleter/g;
s/\bAstNRelinker\b/VNRelinker/g;
s/\bAstNVisitor\b/VNVisitor/g;
s/\bAstPragmaType\b/VPragmaType/g;
s/\bAstType\b/VNType/g;
s/\bAstUser1InUse\b/VNUser1InUse/g;
s/\bAstUser2InUse\b/VNUser2InUse/g;
s/\bAstUser3InUse\b/VNUser3InUse/g;
s/\bAstUser4InUse\b/VNUser4InUse/g;
s/\bAstUser5InUse\b/VNUser5InUse/g;
s/\bAstVarType\b/VVarType/g;
127 lines
4.5 KiB
C++
127 lines
4.5 KiB
C++
// -*- mode: C++; c-file-style: "cc-mode" -*-
|
|
//*************************************************************************
|
|
// DESCRIPTION: Verilator: Utility to hang advanced data structures of
|
|
// AstNode::user*p() pointers with automatic memory management.
|
|
//
|
|
// Code available from: https://verilator.org
|
|
//
|
|
//*************************************************************************
|
|
//
|
|
// Copyright 2003-2022 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
|
|
//
|
|
//*************************************************************************
|
|
|
|
#ifndef VERILATOR_V3ASTUSERALLOCATOR_H_
|
|
#define VERILATOR_V3ASTUSERALLOCATOR_H_
|
|
|
|
#include "config_build.h"
|
|
#include "verilatedos.h"
|
|
|
|
#include "V3Ast.h"
|
|
|
|
#include <type_traits>
|
|
#include <vector>
|
|
|
|
template <class T_Node, class T_Data, int T_UserN> class AstUserAllocatorBase VL_NOT_FINAL {
|
|
static_assert(1 <= T_UserN && T_UserN <= 5, "Wrong user pointer number");
|
|
static_assert(std::is_base_of<AstNode, T_Node>::value, "T_Node must be an AstNode type");
|
|
|
|
private:
|
|
std::vector<T_Data*> m_allocated;
|
|
|
|
inline T_Data* getUserp(const T_Node* nodep) const {
|
|
// This simplifies statically as T_UserN is constant. In C++17, use 'if constexpr'.
|
|
if (T_UserN == 1) {
|
|
const VNUser user = nodep->user1u();
|
|
return user.to<T_Data*>();
|
|
} else if (T_UserN == 2) {
|
|
const VNUser user = nodep->user2u();
|
|
return user.to<T_Data*>();
|
|
} else if (T_UserN == 3) {
|
|
const VNUser user = nodep->user3u();
|
|
return user.to<T_Data*>();
|
|
} else if (T_UserN == 4) {
|
|
const VNUser user = nodep->user4u();
|
|
return user.to<T_Data*>();
|
|
} else {
|
|
const VNUser user = nodep->user5u();
|
|
return user.to<T_Data*>();
|
|
}
|
|
}
|
|
|
|
inline void setUserp(T_Node* nodep, T_Data* userp) const {
|
|
// This simplifies statically as T_UserN is constant. In C++17, use 'if constexpr'.
|
|
if (T_UserN == 1) {
|
|
nodep->user1u(VNUser(userp));
|
|
} else if (T_UserN == 2) {
|
|
nodep->user2u(VNUser(userp));
|
|
} else if (T_UserN == 3) {
|
|
nodep->user3u(VNUser(userp));
|
|
} else if (T_UserN == 4) {
|
|
nodep->user4u(VNUser(userp));
|
|
} else {
|
|
nodep->user5u(VNUser(userp));
|
|
}
|
|
}
|
|
|
|
protected:
|
|
AstUserAllocatorBase() {
|
|
// This simplifies statically as T_UserN is constant. In C++17, use 'if constexpr'.
|
|
if (T_UserN == 1) {
|
|
VNUser1InUse::check();
|
|
} else if (T_UserN == 2) {
|
|
VNUser2InUse::check();
|
|
} else if (T_UserN == 3) {
|
|
VNUser3InUse::check();
|
|
} else if (T_UserN == 4) {
|
|
VNUser4InUse::check();
|
|
} else {
|
|
VNUser5InUse::check();
|
|
}
|
|
}
|
|
|
|
virtual ~AstUserAllocatorBase() {
|
|
// Delete all allocated data structures
|
|
for (T_Data* const p : m_allocated) { delete p; }
|
|
}
|
|
|
|
public:
|
|
// Get a reference to the user data
|
|
T_Data& operator()(T_Node* nodep) {
|
|
T_Data* userp = getUserp(nodep);
|
|
if (!userp) {
|
|
userp = new T_Data;
|
|
m_allocated.push_back(userp);
|
|
setUserp(nodep, userp);
|
|
}
|
|
return *userp;
|
|
}
|
|
|
|
// Get a reference to the user data
|
|
T_Data& operator()(const T_Node* nodep) {
|
|
T_Data* const userp = getUserp(nodep);
|
|
UASSERT_OBJ(userp, nodep, "Missing User data on const AstNode");
|
|
return *userp;
|
|
}
|
|
};
|
|
|
|
// User pointer allocator classes. T_Node is the type of node the allocator should be applied to
|
|
// and is simply there for a bit of extra type safety. T_Data is the type of the data structure
|
|
// managed by the allocator.
|
|
template <class T_Node, class T_Data>
|
|
class AstUser1Allocator final : public AstUserAllocatorBase<T_Node, T_Data, 1> {};
|
|
template <class T_Node, class T_Data>
|
|
class AstUser2Allocator final : public AstUserAllocatorBase<T_Node, T_Data, 2> {};
|
|
template <class T_Node, class T_Data>
|
|
class AstUser3Allocator final : public AstUserAllocatorBase<T_Node, T_Data, 3> {};
|
|
template <class T_Node, class T_Data>
|
|
class AstUser4Allocator final : public AstUserAllocatorBase<T_Node, T_Data, 4> {};
|
|
template <class T_Node, class T_Data>
|
|
class AstUser5Allocator final : public AstUserAllocatorBase<T_Node, T_Data, 5> {};
|
|
|
|
#endif // Guard
|