Support rand_mode (verilator#5273)

Signed-off-by: Krzysztof Bieganski <[email protected]>
VarunKoyyalagunta · Jul 31, 2024 · 2f5c58b · 2f5c58b
1 parent 403a197
commit 2f5c58b
Show file tree

Hide file tree

Showing 21 changed files with 762 additions and 189 deletions.
diff --git a/include/verilated_random.cpp b/include/verilated_random.cpp
@@ -403,8 +403,12 @@ bool VlRandomizer::parseSolution(std::iostream& f) {
 
         auto it = m_vars.find(name);
         if (it == m_vars.end()) continue;
+        const VlRandomVar& varr = *it->second;
+        if (m_randmode && !varr.randModeIdxNone()) {
+            if (!(m_randmode->at(varr.randModeIdx()))) continue;
+        }
 
-        it->second->set(std::move(value));
+        varr.set(std::move(value));
     }
 
     return true;

diff --git a/include/verilated_random.h b/include/verilated_random.h
@@ -38,15 +38,19 @@ class VlRandomVar final : public VlRandomExpr {
     const char* const m_name;  // Variable name
     void* const m_datap;  // Reference to variable data
     const int m_width;  // Variable width in bits
+    const std::uint32_t m_randModeIdx;  // rand_mode index
 
 public:
-    VlRandomVar(const char* name, int width, void* datap)
+    VlRandomVar(const char* name, int width, void* datap, std::uint32_t randModeIdx)
         : m_name{name}
         , m_datap{datap}
-        , m_width{width} {}
+        , m_width{width}
+        , m_randModeIdx{randModeIdx} {}
     const char* name() const { return m_name; }
     int width() const { return m_width; }
     void* datap() const { return m_datap; }
+    std::uint32_t randModeIdx() const { return m_randModeIdx; }
+    bool randModeIdxNone() const { return randModeIdx() == std::numeric_limits<unsigned>::max(); }
     bool set(std::string&&) const;
     void emit(std::ostream& s) const override;
 };
@@ -94,8 +98,9 @@ class VlRandomBinOp final : public VlRandomExpr {
 class VlRandomizer final {
     // MEMBERS
     std::vector<std::string> m_constraints;  // Solver-dependent constraints
-    std::map<std::string, std::shared_ptr<const VlRandomVar>>
-        m_vars;  // Solver-dependent variables
+    std::map<std::string, std::shared_ptr<const VlRandomVar>> m_vars;  // Solver-dependent
+                                                                       // variables
+    const VlQueue<CData>* m_randmode;  // rand_mode state;
 
     // PRIVATE METHODS
     std::shared_ptr<const VlRandomExpr> randomConstraint(VlRNG& rngr, int bits);
@@ -106,13 +111,15 @@ class VlRandomizer final {
     // Finds the next solution satisfying the constraints
     bool next(VlRNG& rngr);
     template <typename T>
-    void write_var(T& var, int width, const char* name) {
+    void write_var(T& var, int width, const char* name,
+                   std::uint32_t randmodeIdx = std::numeric_limits<std::uint32_t>::max()) {
         auto it = m_vars.find(name);
         if (it != m_vars.end()) return;
-        m_vars[name] = std::make_shared<const VlRandomVar>(name, width, &var);
+        m_vars[name] = std::make_shared<const VlRandomVar>(name, width, &var, randmodeIdx);
     }
     void hard(std::string&& constraint);
     void clear();
+    void set_randmode(const VlQueue<CData>& randmode) { m_randmode = &randmode; }
 #ifdef VL_DEBUG
     void dump() const;
 #endif

diff --git a/src/V3AstNodes.cpp b/src/V3AstNodes.cpp
@@ -2834,6 +2834,7 @@ void AstCMethodHard::setPurity() {
                                                           {"reverse", false},
                                                           {"rsort", false},
                                                           {"set", false},
+                                                          {"set_randmode", false},
                                                           {"shuffle", false},
                                                           {"size", true},
                                                           {"slice", true},

diff --git a/src/V3LinkDot.cpp b/src/V3LinkDot.cpp
@@ -3322,8 +3322,8 @@ class LinkDotResolveVisitor final : public VNVisitor {
                 } else if (VN_IS(nodep, New) && m_statep->forPrearray()) {
                     // Resolved in V3Width
                 } else if (nodep->name() == "randomize" || nodep->name() == "srandom"
-                           || nodep->name() == "get_randstate"
-                           || nodep->name() == "set_randstate") {
+                           || nodep->name() == "get_randstate" || nodep->name() == "set_randstate"
+                           || nodep->name() == "rand_mode") {
                     if (AstClass* const classp = VN_CAST(m_modp, Class)) {
                         nodep->classOrPackagep(classp);
                     } else {