Made VersionedFlowSensitive read-only functions & checks public (consistent with other WPA implementations)

Johanmyst · Johanmyst · commit 93446f684ad0 · 2025-05-02T10:00:21.000Z
Currently, most WPA implementations (e.g., `AndersenWaveDiff`) expose read-only functions (e.g., `printStat()`, `dumpTopLevelPtsTo()`, etc.) publically, as well as "constructors" like `solveAndWritePtsToFile()`, `readPtsFromFile()`, etc. However, `VersionedFlowSensitive` is the only one to mark these functions as `private`/`protected`. This makes it annoying to use polymorphism over the underlying PTA base class (i.e., `BVDataPTAImpl`) and the overridden virtual functions. This commit fixes that by marking these functions as public in the `VersionedFlowSensitive` WPA class.

This change allows me to use polymorphism to conveniently try different WPA backends like this:

```
SVF::BVDataPTAImpl *pta = nullptr;

switch(getChosenBackend()) {
    case Andersen_BASE:
        pta = new Andersen(...);
        break;
    case VFS_WPA:
        pta = new VersionedFlowSensitive(...);
        break;
    default:
        break;
}
```
diff --git a/svf/include/WPA/VersionedFlowSensitive.h b/svf/include/WPA/VersionedFlowSensitive.h
@@ -110,6 +110,45 @@ class VersionedFlowSensitive : public FlowSensitive
     /// Override since we want to assign different weights based on versioning.
     virtual void cluster(void) override;
 
+public:
+    /// Returns true if l is a store node.
+    virtual bool isStore(const NodeID l) const;
+
+    /// Returns true if l is a load node.
+    virtual bool isLoad(const NodeID l) const;
+
+    /// Shared code for getConsume and getYield. They wrap this function.
+    Version getVersion(const NodeID l, const NodeID o, const LocVersionMap &lvm) const;
+
+    /// Returns the consumed version of o at l. If no such version exists, returns invalidVersion.
+    Version getConsume(const NodeID l, const NodeID o) const;
+
+    /// Returns the yielded version of o at l. If no such version exists, returns invalidVersion.
+    Version getYield(const NodeID l, const NodeID o) const;
+
+    /// Returns the versions of o which rely on o:v.
+    std::vector<Version> &getReliantVersions(const NodeID o, const Version v);
+
+    /// Returns the statements which rely on o:v.
+    NodeBS &getStmtReliance(const NodeID o, const Version v);
+
+    /// Dumps versionReliance and stmtReliance.
+    void dumpReliances(void) const;
+
+    /// Dumps maps consume and yield.
+    void dumpLocVersionMaps(void) const;
+
+    void solveAndwritePtsToFile(const std::string& filename) override;
+
+    void writeVersionedAnalysisResultToFile(const std::string& filename);
+
+    void readVersionedAnalysisResultFromFile(std::ifstream& F);
+
+    void readPtsFromFile(const std::string& filename) override;
+
+    /// Dumps a MeldVersion to stdout.
+    static void dumpMeldVersion(MeldVersion &v);
+
 private:
     /// Prelabel the SVFG: set y(o) for stores and c(o) for delta nodes to a new version.
     void prelabel(void);
@@ -133,12 +172,6 @@ class VersionedFlowSensitive : public FlowSensitive
     /// Fills in isStoreMap and isLoadMap.
     virtual void buildIsStoreLoadMaps(void);
 
-    /// Returns true if l is a store node.
-    virtual bool isStore(const NodeID l) const;
-
-    /// Returns true if l is a load node.
-    virtual bool isLoad(const NodeID l) const;
-
     /// Fills in deltaMap and deltaSourceMap for the SVFG.
     virtual void buildDeltaMaps(void);
 
@@ -150,15 +183,6 @@ class VersionedFlowSensitive : public FlowSensitive
     /// edge to a delta node due to on-the-fly callgraph construction.
     virtual bool deltaSource(const NodeID l) const;
 
-    /// Shared code for getConsume and getYield. They wrap this function.
-    Version getVersion(const NodeID l, const NodeID o, const LocVersionMap &lvm) const;
-
-    /// Returns the consumed version of o at l. If no such version exists, returns invalidVersion.
-    Version getConsume(const NodeID l, const NodeID o) const;
-
-    /// Returns the yielded version of o at l. If no such version exists, returns invalidVersion.
-    Version getYield(const NodeID l, const NodeID o) const;
-
     /// Shared code for setConsume and setYield. They wrap this function.
     void setVersion(const NodeID l, const NodeID o, const Version v, LocVersionMap &lvm);
 
@@ -168,29 +192,6 @@ class VersionedFlowSensitive : public FlowSensitive
     /// Sets the yielded version of o at l to v.
     void setYield(const NodeID l, const NodeID o, const Version v);
 
-    /// Returns the versions of o which rely on o:v.
-    std::vector<Version> &getReliantVersions(const NodeID o, const Version v);
-
-    /// Returns the statements which rely on o:v.
-    NodeBS &getStmtReliance(const NodeID o, const Version v);
-
-    /// Dumps versionReliance and stmtReliance.
-    void dumpReliances(void) const;
-
-    /// Dumps maps consume and yield.
-    void dumpLocVersionMaps(void) const;
-
-    void solveAndwritePtsToFile(const std::string& filename) override;
-
-    void writeVersionedAnalysisResultToFile(const std::string& filename);
-
-    void readVersionedAnalysisResultFromFile(std::ifstream& F);
-
-    void readPtsFromFile(const std::string& filename) override;
-
-    /// Dumps a MeldVersion to stdout.
-    static void dumpMeldVersion(MeldVersion &v);
-
     /// Maps locations to objects to a version. The object version is what is
     /// consumed at that location.
     LocVersionMap consume;
