Subversion Repositories QNX 8.QNX8 LLVM/Clang compiler suite

//===- SyntheticCountsUtils.h - utilities for count propagation--*- C++ -*-===//

//

// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.

// See https://llvm.org/LICENSE.txt for license information.

// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception

//

//===----------------------------------------------------------------------===//

//

// This file defines utilities for synthetic counts propagation.

//

//===----------------------------------------------------------------------===//

#ifndef LLVM_ANALYSIS_SYNTHETICCOUNTSUTILS_H

#define LLVM_ANALYSIS_SYNTHETICCOUNTSUTILS_H

#include "llvm/ADT/STLFunctionalExtras.h"

#include "llvm/Analysis/CallGraph.h"

#include "llvm/Support/ScaledNumber.h"

namespace llvm {

/// Class with methods to propagate synthetic entry counts.

///

/// This class is templated on the type of the call graph and designed to work

/// with the traditional per-module callgraph and the summary callgraphs used in

/// ThinLTO. This contains only static methods and alias templates.

template <typename CallGraphType> class SyntheticCountsUtils {

public:

  using Scaled64 = ScaledNumber<uint64_t>;

  using CGT = GraphTraits<CallGraphType>;

  using NodeRef = typename CGT::NodeRef;

  using EdgeRef = typename CGT::EdgeRef;

  using SccTy = std::vector<NodeRef>;

  // Not all EdgeRef have information about the source of the edge. Hence

  // NodeRef corresponding to the source of the EdgeRef is explicitly passed.

  using GetProfCountTy =

      function_ref<std::optional<Scaled64>(NodeRef, EdgeRef)>;

  using AddCountTy = function_ref<void(NodeRef, Scaled64)>;

  static void propagate(const CallGraphType &CG, GetProfCountTy GetProfCount,

                        AddCountTy AddCount);

private:

  static void propagateFromSCC(const SccTy &SCC, GetProfCountTy GetProfCount,

                               AddCountTy AddCount);

};

} // namespace llvm

#endif