svf-tools 1.0.1277 → 1.0.1279

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "svf-tools",
-  "version": "1.0.1277",
+  "version": "1.0.1279",
   "description": "* <b>[TypeClone](https://github.com/SVF-tools/SVF/wiki/TypeClone) published in our [ECOOP paper](https://yuleisui.github.io/publications/ecoop20.pdf) is now available in SVF </b> * <b>SVF now uses a single script for its build. Just type [`source ./build.sh`](https://github.com/SVF-tools/SVF/blob/master/build.sh) in your terminal, that's it!</b> * <b>SVF now supports LLVM-10.0.0! </b> * <b>We thank [bsauce](https://github.com/bsauce) for writing a user manual of SVF ([link1](https://www.jianshu.com/p/068a08ec749c) and [link2](https://www.jianshu.com/p/777c30d4240e)) in Chinese </b> * <b>SVF now supports LLVM-9.0.0 (Thank [Byoungyoung Lee](https://github.com/SVF-tools/SVF/issues/142) for his help!). </b> * <b>SVF now supports a set of [field-sensitive pointer analyses](https://yuleisui.github.io/publications/sas2019a.pdf). </b> * <b>[Use SVF as an external lib](https://github.com/SVF-tools/SVF/wiki/Using-SVF-as-a-lib-in-your-own-tool) for your own project (Contributed by [Hongxu Chen](https://github.com/HongxuChen)). </b> * <b>SVF now supports LLVM-7.0.0. </b> * <b>SVF now supports Docker. [Try SVF in Docker](https://github.com/SVF-tools/SVF/wiki/Try-SVF-in-Docker)! </b> * <b>SVF now supports [LLVM-6.0.0](https://github.com/svf-tools/SVF/pull/38) (Contributed by [Jack Anthony](https://github.com/jackanth)). </b> * <b>SVF now supports [LLVM-4.0.0](https://github.com/svf-tools/SVF/pull/23) (Contributed by Jared Carlson. Thank [Jared](https://github.com/jcarlson23) and [Will](https://github.com/dtzWill) for their in-depth [discussions](https://github.com/svf-tools/SVF/pull/18) about updating SVF!) </b> * <b>SVF now supports analysis for C++ programs.</b> <br />",
   "main": "index.js",
   "scripts": {

package/svf/include/Util/NodeIDAllocator.h

@@ -163,7 +163,13 @@ public:
         /// or a subset, depending on the client's wish.
         /// TODO: interfaces are getting unwieldy, an initialised object may be better.
         /// TODO: kind of sucks pta can't be const here because getPts isn't.
-        static std::vector<NodeID> cluster(BVDataPTAImpl *pta, const std::vector<std::pair<NodeID, unsigned>> keys, std::vector<std::pair<hclust_fast_methods, std::vector<NodeID>>> &candidates, std::string evalSubtitle="");
+        static std::vector<NodeID> cluster(
+            BVDataPTAImpl *pta,
+            const std::vector<std::pair<NodeID, unsigned>> keys,
+            std::vector<std::pair<hclust_fast_methods, std::vector<NodeID>>> &candidates,
+            std::string evalSubtitle="",
+            bool printStat=true
+        );
 
         // Returns a reverse node mapping for mapping generated by cluster().
         static std::vector<NodeID> getReverseNodeMapping(const std::vector<NodeID> &nodeMapping);
@@ -206,9 +212,12 @@ public:
 
         // From all the candidates, returns the best mapping for pointsToSets (points-to set -> # occurrences).
         static inline std::pair<hclust_fast_methods, std::vector<NodeID>> determineBestMapping(
-                    const std::vector<std::pair<hclust_fast_methods, std::vector<NodeID>>> &candidates,
-                    Map<PointsTo, unsigned> pointsToSets, const std::string &evalSubtitle, double &evalTime);
-
+            const std::vector<std::pair<hclust_fast_methods, std::vector<NodeID>>> &candidates,
+            Map<PointsTo, unsigned> pointsToSets,
+            const std::string &evalSubtitle,
+            double &evalTime,
+            bool printStat
+        );
     };
 };
 

package/svf/lib/Util/NodeIDAllocator.cpp

@@ -190,7 +190,13 @@ const std::string NodeIDAllocator::Clusterer::LargestRegion = "LargestRegion";
 const std::string NodeIDAllocator::Clusterer::BestCandidate = "BestCandidate";
 const std::string NodeIDAllocator::Clusterer::NumNonTrivialRegionObjects = "NumNonTrivObj";
 
-std::vector<NodeID> NodeIDAllocator::Clusterer::cluster(BVDataPTAImpl *pta, const std::vector<std::pair<NodeID, unsigned>> keys, std::vector<std::pair<hclust_fast_methods, std::vector<NodeID>>> &candidates, std::string evalSubtitle)
+std::vector<NodeID> NodeIDAllocator::Clusterer::cluster(
+    BVDataPTAImpl *pta,
+    const std::vector<std::pair<NodeID, unsigned>> keys,
+    std::vector<std::pair<hclust_fast_methods, std::vector<NodeID>>> &candidates,
+    std::string evalSubtitle,
+    bool printStat
+)
 {
     assert(pta != nullptr && "Clusterer::cluster: given null BVDataPTAImpl");
     assert(Options::NodeAllocStrat() == Strategy::DENSE && "Clusterer::cluster: only dense allocation clustering currently supported");
@@ -385,8 +391,8 @@ std::vector<NodeID> NodeIDAllocator::Clusterer::cluster(BVDataPTAImpl *pta, cons
     }
 
     // Work out which of the mappings we generated looks best.
-    std::pair<hclust_fast_methods, std::vector<NodeID>> bestMapping = determineBestMapping(candidates, pointsToSets,
-            evalSubtitle, evalTime);
+    std::pair<hclust_fast_methods, std::vector<NodeID>> bestMapping =
+        determineBestMapping(candidates, pointsToSets, evalSubtitle, evalTime, printStat);
 
     overallStats[DistanceMatrixTime] = std::to_string(distanceMatrixTime);
     overallStats[DendrogramTraversalTime] = std::to_string(dendrogramTraversalTime);
@@ -395,7 +401,7 @@ std::vector<NodeID> NodeIDAllocator::Clusterer::cluster(BVDataPTAImpl *pta, cons
     overallStats[TotalTime] = std::to_string(distanceMatrixTime + dendrogramTraversalTime + fastClusterTime + regioningTime + evalTime);
 
     overallStats[BestCandidate] = SVFUtil::hclustMethodToString(bestMapping.first);
-    printStats(evalSubtitle + ": overall", overallStats);
+    if (printStat) { printStats(evalSubtitle + ": overall", overallStats); }
 
     return bestMapping.second;
 }
@@ -654,14 +660,18 @@ void NodeIDAllocator::Clusterer::evaluate(const std::vector<NodeID> &nodeMap, co
 
 // Work out which of the mappings we generated looks best.
 std::pair<hclust_fast_methods, std::vector<NodeID>> NodeIDAllocator::Clusterer::determineBestMapping(
-            const std::vector<std::pair<hclust_fast_methods, std::vector<NodeID>>> &candidates,
-            Map<PointsTo, unsigned> pointsToSets, const std::string &evalSubtitle, double &evalTime)
+    const std::vector<std::pair<hclust_fast_methods, std::vector<NodeID>>> &candidates,
+    Map<PointsTo, unsigned> pointsToSets,
+    const std::string &evalSubtitle,
+    double &evalTime,
+    bool printStat
+)
 {
     // In case we're not comparing anything, set to first "candidate".
     std::pair<hclust_fast_methods, std::vector<NodeID>> bestMapping = candidates[0];
     // Number of bits required for the best candidate.
     size_t bestWords = std::numeric_limits<size_t>::max();
-    if (evalSubtitle != "" || (enum hclust_fast_methods)Options::ClusterMethod() == HCLUST_METHOD_SVF_BEST)
+    if ((enum hclust_fast_methods)Options::ClusterMethod() == HCLUST_METHOD_SVF_BEST)
     {
         for (const std::pair<hclust_fast_methods, std::vector<NodeID>> &candidate : candidates)
         {
@@ -675,7 +685,7 @@ std::pair<hclust_fast_methods, std::vector<NodeID>> NodeIDAllocator::Clusterer::
             evaluate(candidateMapping, pointsToSets, candidateStats, true);
             const double clkEnd = PTAStat::getClk(true);
             evalTime += (clkEnd - clkStart) / TIMEINTERVAL;
-            printStats(evalSubtitle + ": candidate " + candidateMethodName, candidateStats);
+            if (printStat) { printStats(evalSubtitle + ": candidate " + candidateMethodName, candidateStats); }
 
             size_t candidateWords = 0;
             if (Options::PtType() == PointsTo::SBV) candidateWords = std::stoull(candidateStats[NewSbvNumWords]);

package/svf/lib/WPA/Andersen.cpp

@@ -431,7 +431,6 @@ void Andersen::initialize()
  */
 void Andersen::finalize()
 {
-    // TODO: check -stat too.
     // TODO: broken
     if (Options::ClusterAnder())
     {
@@ -440,7 +439,7 @@ void Andersen::finalize()
         // TODO: should we use liveOnly?
         // TODO: parameterise final arg.
         NodeIDAllocator::Clusterer::evaluate(*PointsTo::getCurrentBestNodeMapping(), ptd->getAllPts(true), stats, true);
-        NodeIDAllocator::Clusterer::printStats("post-main", stats);
+        if (print_stat) { NodeIDAllocator::Clusterer::printStats("post-main", stats); }
     }
 
     /// sanitize field insensitive obj
@@ -917,7 +916,9 @@ void Andersen::cluster(void) const
 
     std::vector<std::pair<hclust_fast_methods, std::vector<NodeID>>> candidates;
     PointsTo::MappingPtr nodeMapping =
-        std::make_shared<std::vector<NodeID>>(NodeIDAllocator::Clusterer::cluster(steens, keys, candidates, "aux-steens"));
+        std::make_shared<std::vector<NodeID>>(
+            NodeIDAllocator::Clusterer::cluster(steens, keys, candidates, "aux-steens", print_stat)
+        );
     PointsTo::MappingPtr reverseNodeMapping =
         std::make_shared<std::vector<NodeID>>(NodeIDAllocator::Clusterer::getReverseNodeMapping(*nodeMapping));
 

package/svf/lib/WPA/FlowSensitive.cpp

@@ -188,15 +188,7 @@ void FlowSensitive::finalize()
         Map<PointsTo, unsigned> allPts = ptd->getAllPts(true);
         // TODO: parameterise final arg.
         NodeIDAllocator::Clusterer::evaluate(*PointsTo::getCurrentBestNodeMapping(), allPts, stats, true);
-        NodeIDAllocator::Clusterer::printStats("post-main: best", stats);
-
-        // Do the same for the candidates. TODO: probably temporary for eval. purposes.
-        for (std::pair<hclust_fast_methods, std::vector<NodeID>> &candidate : candidateMappings)
-        {
-            // Can reuse stats, since we're always filling it with `evaluate`, it will always be overwritten.
-            NodeIDAllocator::Clusterer::evaluate(candidate.second, allPts, stats, true);
-            NodeIDAllocator::Clusterer::printStats("post-main: candidate " + SVFUtil::hclustMethodToString(candidate.first), stats);
-        }
+        if (print_stat) { NodeIDAllocator::Clusterer::printStats("post-main: best", stats); }
     }
 
     BVDataPTAImpl::finalize();
@@ -831,7 +823,9 @@ void FlowSensitive::cluster(void)
         keys.emplace_back(pair.first, 1);
 
     PointsTo::MappingPtr nodeMapping =
-        std::make_shared<std::vector<NodeID>>(NodeIDAllocator::Clusterer::cluster(ander, keys, candidateMappings, "aux-ander"));
+        std::make_shared<std::vector<NodeID>>(
+            NodeIDAllocator::Clusterer::cluster(ander, keys, candidateMappings, "aux-ander", print_stat)
+        );
     PointsTo::MappingPtr reverseNodeMapping =
         std::make_shared<std::vector<NodeID>>(NodeIDAllocator::Clusterer::getReverseNodeMapping(*nodeMapping));
 

package/svf/lib/WPA/VersionedFlowSensitive.cpp

@@ -791,7 +791,9 @@ void VersionedFlowSensitive::cluster(void)
     }
 
     PointsTo::MappingPtr nodeMapping =
-        std::make_shared<std::vector<NodeID>>(NodeIDAllocator::Clusterer::cluster(ander, keys, candidateMappings, "aux-ander"));
+        std::make_shared<std::vector<NodeID>>(
+            NodeIDAllocator::Clusterer::cluster(ander, keys, candidateMappings, "aux-ander", print_stat)
+        );
     PointsTo::MappingPtr reverseNodeMapping =
         std::make_shared<std::vector<NodeID>>(NodeIDAllocator::Clusterer::getReverseNodeMapping(*nodeMapping));