Coverage-based estimation of loop weights (#16)

Author: augenzu

include/tsar/Analysis/Clang/CountedRegionsExtractor.h

@@ -0,0 +1,53 @@
+//=== CountedRegionsExtractor.h - Extracting Of CountedRegions From Code Coverage (Clang) --*- C++ -*===//
+//
+//                       Traits Static Analyzer (SAPFOR)
+//
+// Copyright 2018 DVM System Group
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+//===---------------------------------------------------------------------===//
+//
+// This file declares a pass to extract & store 
+// all the CountedRegions along with their ExecutionCounts
+// from a given code coverage file.
+//
+//===---------------------------------------------------------------------===//
+
+#ifndef TSAR_CLANG_COUNTED_REGIONS_EXTRACTOR_H
+#define TSAR_CLANG_COUNTED_REGIONS_EXTRACTOR_H
+
+#include <bcl/utility.h>
+#include "tsar/Transform/Clang/Passes.h"
+#include <llvm/Pass.h>
+#include <llvm/ProfileData/Coverage/CoverageMapping.h>
+#include <vector>
+
+namespace llvm {
+/// This immutable pass extracts & stores CountedRegions
+/// from a given code coverage file
+class ClangCountedRegionsExtractor : public ImmutablePass, private bcl::Uncopyable {
+public:
+  static char ID;
+
+  ClangCountedRegionsExtractor();
+
+  void initializePass() override;
+  const std::vector<coverage::CountedRegion> &getCountedRegions() const noexcept;
+  void getAnalysisUsage(AnalysisUsage &AU) const override;
+
+private:
+  std::vector<coverage::CountedRegion> CountedRegions{};
+};
+}
+#endif//TSAR_CLANG_COUNTED_REGIONS_EXTRACTOR_H

include/tsar/Analysis/Clang/Passes.h

@@ -32,6 +32,7 @@ namespace llvm {
 class PassRegistry;
 class FunctionPass;
 class ModulePass;
+class ImmutablePass;
 
 /// Initialize all passes to perform source-base analysis of C programs.
 void initializeClangAnalysis(PassRegistry &Registry);
@@ -149,5 +150,13 @@ void initializeClangIncludeTreeOnlyViewerPass(PassRegistry &Registry);
 /// Create a pass to display source file tree (filenames instead of
 /// full paths).
 ModulePass *createClangIncludeTreeOnlyViewer();
+
+/// Initialize a pass to extract & store all the CountedRegions
+/// from a given code coverage file.
+void initializeClangCountedRegionsExtractorPass(PassRegistry &Registry);
+
+/// Create a pass to extract & store all the CountedRegions
+/// from a given code coverage file.
+ImmutablePass *createClangCountedRegionsExtractor();
 }
 #endif//TSAR_CLANG_ANALYSIS_PASSES_H

include/tsar/Transform/Clang/LoopWeightsEstimator.h

@@ -0,0 +1,57 @@
+//=== LoopWeightsEstimator.h - Loop Weights Estimator (Clang) --*- C++ -*===//
+//
+//                       Traits Static Analyzer (SAPFOR)
+//
+// Copyright 2018 DVM System Group
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+//===---------------------------------------------------------------------===//
+//
+// This file declares a pass to estimate loop weights in a source code.
+//
+//===---------------------------------------------------------------------===//
+
+#ifndef TSAR_CLANG_LOOP_WEIGHTS_H
+#define TSAR_CLANG_LOOP_WEIGHTS_H
+
+
+#include <bcl/utility.h>
+#include "tsar/Transform/Clang/Passes.h"
+#include <llvm/IR/Metadata.h>
+#include <llvm/Pass.h>
+
+#include <map>
+
+
+namespace llvm {
+/// This per-module pass performs estimation of loop weights
+class ClangLoopWeightsEstimator : public ModulePass, private bcl::Uncopyable {
+public:
+  static char ID;
+
+  ClangLoopWeightsEstimator();
+
+  bool runOnModule(Module &M) override;
+  const std::map<MDNode *, uint64_t> &getLoopWeights() const noexcept;
+  void getAnalysisUsage(AnalysisUsage &AU) const override;
+
+private:
+  std::map<Function *, uint64_t> mFunctionEntryCounts{};
+  std::map<Function *, uint64_t> mFunctionBaseWeights{};
+  std::map<Function *, uint64_t> mFunctionEffectiveWeights{};
+  std::map<MDNode *, uint64_t> mLoopBaseWeights{};
+  std::map<MDNode *, uint64_t> mLoopEffectiveWeights{};
+};
+}
+#endif//TSAR_CLANG_LOOP_WEIGHTS_H

include/tsar/Transform/Clang/Passes.h

@@ -114,5 +114,11 @@ void initializeClangLoopReversePass(PassRegistry &Registry);
 
 /// Create a pass to reverse loop.
 ModulePass *createClangLoopReverse();
+
+/// Initialize a pass to estimate loop weights in a source code.
+void initializeClangLoopWeightsEstimatorPass(PassRegistry &Registry);
+
+/// Create a pass to estimate loop weights in a source code.
+ModulePass *createClangLoopWeightsEstimator();
 }
 #endif//TSAR_CLANG_TRANSFORM_PASSES_H

lib/Analysis/Clang/CMakeLists.txt

@@ -2,7 +2,7 @@ set(ANALYSIS_SOURCES Passes.cpp DIMemoryMatcher.cpp NoMacroAssert.cpp
   MemoryMatcher.cpp LoopMatcher.cpp ExpressionMatcher.cpp CanonicalLoop.cpp
   PerfectLoop.cpp GlobalInfoExtractor.cpp ControlFlowTraits.cpp
   RegionDirectiveInfo.cpp VariableCollector.cpp ASTDependenceAnalysis.cpp
-  IncludeTree.cpp Utils.cpp)
+  IncludeTree.cpp Utils.cpp CountedRegionsExtractor.cpp)
 
 
 if(MSVC_IDE)

lib/Analysis/Clang/CountedRegionsExtractor.cpp

@@ -0,0 +1,110 @@
+//=== CountedRegionsExtractor.cpp - Extracting Of CountedRegions From Code Coverage (Clang) --*- C++ -*===//
+//
+//                       Traits Static Analyzer (SAPFOR)
+//
+// Copyright 2018 DVM System Group
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+//===---------------------------------------------------------------------===//
+//
+// This file defines a pass to extract & store 
+// all the CountedRegions along with their ExecutionCounts
+// from a given code coverage file.
+//
+//===---------------------------------------------------------------------===//
+
+#include "tsar/Analysis/Clang/CountedRegionsExtractor.h"
+#include "tsar/Analysis/Clang/GlobalInfoExtractor.h"
+#include "tsar/Analysis/Clang/NoMacroAssert.h"
+#include "tsar/Core/Query.h"
+#include "tsar/Frontend/Clang/TransformationContext.h"
+#include <clang/AST/Decl.h>
+#include <clang/AST/RecursiveASTVisitor.h>
+#include <clang/AST/Stmt.h>
+#include <clang/Basic/SourceLocation.h>
+#include <llvm/ADT/StringRef.h>
+#include <llvm/IR/Function.h>
+#include <llvm/IR/Module.h>
+#include <llvm/ProfileData/Coverage/CoverageMapping.h>
+#include <llvm/Support/Debug.h>
+#include <llvm/Support/raw_ostream.h>
+#include <vector>
+
+#include <iostream>
+
+using namespace clang;
+using namespace llvm;
+using namespace tsar;
+
+#undef DEBUG_TYPE
+#define DEBUG_TYPE "clang-counted-regions-extractor"
+
+char ClangCountedRegionsExtractor::ID = 0;
+
+INITIALIZE_PASS_IN_GROUP(ClangCountedRegionsExtractor, "clang-counted-regions-extractor",
+  "Extracting Of CountedRegions From Code Coverage (Clang)", false, false,
+  TransformationQueryManager::getPassRegistry())
+
+ClangCountedRegionsExtractor::ClangCountedRegionsExtractor() : ImmutablePass(ID) {
+  initializeClangCountedRegionsExtractorPass(*PassRegistry::getPassRegistry());
+}
+
+// Extracts & stores CountedRegions from code coverage
+void ClangCountedRegionsExtractor::initializePass() {
+  std::string ObjectFilename{ "/home/alex000/Documents/sapfor-total/working/main" };
+  std::string ProfileFilename{ "/home/alex000/Documents/sapfor-total/working/main.profdata" };
+
+  StringRef ObjectFilenameRef{ ObjectFilename };
+  ArrayRef<StringRef> ObjectFilenameRefs{ ObjectFilenameRef };
+  StringRef ProfileFilenameRef{ ProfileFilename };
+
+  auto CoverageOrErr = coverage::CoverageMapping::load(ObjectFilenameRefs, ProfileFilenameRef);
+  if (!CoverageOrErr) {
+    errs() << "COVERAGE ERROR\n";
+    return;
+  }
+
+  LLVM_DEBUG(llvm::dbgs() << "Coverage loading done\n";);
+
+  const auto &Coverage = CoverageOrErr->get();
+  
+  for (auto &FRI : Coverage->getCoveredFunctions()) {
+    for (auto CR : FRI.CountedRegions) {
+        CountedRegions.push_back(CR);
+    }
+  }
+
+  LLVM_DEBUG(llvm::dbgs() << "Stored CountedRegions:\n";);
+  for (const auto &CR : CountedRegions) {
+    LLVM_DEBUG(
+      llvm::dbgs() << "\tstart: " << CR.LineStart << ":" << CR.ColumnStart
+      << ", end: " << CR.LineEnd << ":" << CR.ColumnEnd
+      << ", count: " << CR.ExecutionCount << "\n";
+    );
+  }
+  LLVM_DEBUG(llvm::dbgs() << "\n";);
+}
+
+const std::vector<coverage::CountedRegion> &
+ClangCountedRegionsExtractor::getCountedRegions() const noexcept {
+	return CountedRegions;
+}
+
+void ClangCountedRegionsExtractor::getAnalysisUsage(AnalysisUsage &AU) const {
+  AU.setPreservesAll();
+}
+
+ImmutablePass *llvm::createClangCountedRegionsExtractor() {
+  return new ClangCountedRegionsExtractor();
+}

lib/Analysis/Clang/Passes.cpp

@@ -42,6 +42,7 @@ void llvm::initializeClangAnalysis(PassRegistry &Registry) {
   initializeClangIncludeTreeOnlyPrinterPass(Registry);
   initializeClangIncludeTreeViewerPass(Registry);
   initializeClangIncludeTreeOnlyViewerPass(Registry);
+  initializeClangCountedRegionsExtractorPass(Registry);
   // Initialize checkers.
   initializeClangNoMacroAssertPass(Registry);
 }

lib/Transform/Clang/CMakeLists.txt

@@ -2,7 +2,7 @@ set(TRANSFORM_SOURCES Passes.cpp ExprPropagation.cpp Inline.cpp RenameLocal.cpp
   DeadDeclsElimination.cpp Format.cpp OpenMPAutoPar.cpp DVMHWriter.cpp
   SharedMemoryAutoPar.cpp DVMHDirecitves.cpp DVMHSMAutoPar.cpp
   DVMHDataTransferIPO.cpp StructureReplacement.cpp LoopInterchange.cpp
-  LoopReversal.cpp)
+  LoopReversal.cpp LoopWeightsEstimator.cpp)
 
 if(MSVC_IDE)
   file(GLOB_RECURSE TRANSFORM_HEADERS RELATIVE ${CMAKE_CURRENT_SOURCE_DIR}