LLVM  14.0.0git
SyntheticCountsUtils.h
Go to the documentation of this file.
1 //===- SyntheticCountsUtils.h - utilities for count propagation--*- C++ -*-===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 //
9 // This file defines utilities for synthetic counts propagation.
10 //
11 //===----------------------------------------------------------------------===//
12 
13 #ifndef LLVM_ANALYSIS_SYNTHETICCOUNTSUTILS_H
14 #define LLVM_ANALYSIS_SYNTHETICCOUNTSUTILS_H
15 
16 #include "llvm/ADT/STLExtras.h"
19 
20 namespace llvm {
21 
22 /// Class with methods to propagate synthetic entry counts.
23 ///
24 /// This class is templated on the type of the call graph and designed to work
25 /// with the traditional per-module callgraph and the summary callgraphs used in
26 /// ThinLTO. This contains only static methods and alias templates.
27 template <typename CallGraphType> class SyntheticCountsUtils {
28 public:
31  using NodeRef = typename CGT::NodeRef;
32  using EdgeRef = typename CGT::EdgeRef;
33  using SccTy = std::vector<NodeRef>;
34 
35  // Not all EdgeRef have information about the source of the edge. Hence
36  // NodeRef corresponding to the source of the EdgeRef is explicitly passed.
39 
40  static void propagate(const CallGraphType &CG, GetProfCountTy GetProfCount,
41  AddCountTy AddCount);
42 
43 private:
44  static void propagateFromSCC(const SccTy &SCC, GetProfCountTy GetProfCount,
45  AddCountTy AddCount);
46 };
47 } // namespace llvm
48 
49 #endif
llvm
This file implements support for optimizing divisions by a constant.
Definition: AllocatorList.h:23
llvm::SyntheticCountsUtils::propagate
static void propagate(const CallGraphType &CG, GetProfCountTy GetProfCount, AddCountTy AddCount)
Propgate synthetic entry counts on a callgraph CG.
Definition: SyntheticCountsUtils.cpp:86
STLExtras.h
llvm::SyntheticCountsUtils::EdgeRef
typename CGT::EdgeRef EdgeRef
Definition: SyntheticCountsUtils.h:32
llvm::SyntheticCountsUtils::SccTy
std::vector< NodeRef > SccTy
Definition: SyntheticCountsUtils.h:33
llvm::function_ref
An efficient, type-erasing, non-owning reference to a callable.
Definition: STLExtras.h:168
llvm::AMDGPU::CPol::SCC
@ SCC
Definition: SIDefines.h:295
llvm::SyntheticCountsUtils::NodeRef
typename CGT::NodeRef NodeRef
Definition: SyntheticCountsUtils.h:31
ScaledNumber.h
llvm::ScaledNumber< uint64_t >
CallGraph.h
llvm::SyntheticCountsUtils
Class with methods to propagate synthetic entry counts.
Definition: SyntheticCountsUtils.h:27
llvm::GraphTraits::NodeRef
typename GraphType::UnknownGraphTypeError NodeRef
Definition: GraphTraits.h:78
llvm::GraphTraits
Definition: GraphTraits.h:35