aboutsummaryrefslogtreecommitdiffstats
path: root/contrib/libs/llvm12/include/llvm/MCA/Support.h
blob: 43d1b08e08f50af14d9065ff6c369ed33de69932 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
#pragma once 
 
#ifdef __GNUC__ 
#pragma GCC diagnostic push 
#pragma GCC diagnostic ignored "-Wunused-parameter" 
#endif 
 
//===--------------------- Support.h ----------------------------*- 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 
// 
//===----------------------------------------------------------------------===// 
/// \file 
/// 
/// Helper functions used by various pipeline components. 
/// 
//===----------------------------------------------------------------------===// 
 
#ifndef LLVM_MCA_SUPPORT_H 
#define LLVM_MCA_SUPPORT_H 
 
#include "llvm/ADT/ArrayRef.h" 
#include "llvm/ADT/SmallVector.h" 
#include "llvm/MC/MCSchedule.h" 
#include "llvm/Support/Error.h" 
 
namespace llvm { 
namespace mca { 
 
template <typename T> 
class InstructionError : public ErrorInfo<InstructionError<T>> { 
public: 
  static char ID; 
  std::string Message; 
  const T &Inst; 
 
  InstructionError(std::string M, const T &MCI) 
      : Message(std::move(M)), Inst(MCI) {} 
 
  void log(raw_ostream &OS) const override { OS << Message; } 
 
  std::error_code convertToErrorCode() const override { 
    return inconvertibleErrorCode(); 
  } 
}; 
 
template <typename T> char InstructionError<T>::ID; 
 
/// This class represents the number of cycles per resource (fractions of 
/// cycles).  That quantity is managed here as a ratio, and accessed via the 
/// double cast-operator below.  The two quantities, number of cycles and 
/// number of resources, are kept separate.  This is used by the 
/// ResourcePressureView to calculate the average resource cycles 
/// per instruction/iteration. 
class ResourceCycles { 
  unsigned Numerator, Denominator; 
 
public: 
  ResourceCycles() : Numerator(0), Denominator(1) {} 
  ResourceCycles(unsigned Cycles, unsigned ResourceUnits = 1) 
      : Numerator(Cycles), Denominator(ResourceUnits) {} 
 
  operator double() const { 
    assert(Denominator && "Invalid denominator (must be non-zero)."); 
    return (Denominator == 1) ? Numerator : (double)Numerator / Denominator; 
  } 
 
  unsigned getNumerator() const { return Numerator; } 
  unsigned getDenominator() const { return Denominator; } 
 
  // Add the components of RHS to this instance.  Instead of calculating 
  // the final value here, we keep track of the numerator and denominator 
  // separately, to reduce floating point error. 
  ResourceCycles &operator+=(const ResourceCycles &RHS); 
}; 
 
/// Populates vector Masks with processor resource masks. 
/// 
/// The number of bits set in a mask depends on the processor resource type. 
/// Each processor resource mask has at least one bit set. For groups, the 
/// number of bits set in the mask is equal to the cardinality of the group plus 
/// one. Excluding the most significant bit, the remaining bits in the mask 
/// identify processor resources that are part of the group. 
/// 
/// Example: 
/// 
///  ResourceA  -- Mask: 0b001 
///  ResourceB  -- Mask: 0b010 
///  ResourceAB -- Mask: 0b100 U (ResourceA::Mask | ResourceB::Mask) == 0b111 
/// 
/// ResourceAB is a processor resource group containing ResourceA and ResourceB. 
/// Each resource mask uniquely identifies a resource; both ResourceA and 
/// ResourceB only have one bit set. 
/// ResourceAB is a group; excluding the most significant bit in the mask, the 
/// remaining bits identify the composition of the group. 
/// 
/// Resource masks are used by the ResourceManager to solve set membership 
/// problems with simple bit manipulation operations. 
void computeProcResourceMasks(const MCSchedModel &SM, 
                              MutableArrayRef<uint64_t> Masks); 
 
// Returns the index of the highest bit set. For resource masks, the position of 
// the highest bit set can be used to construct a resource mask identifier. 
inline unsigned getResourceStateIndex(uint64_t Mask) { 
  assert(Mask && "Processor Resource Mask cannot be zero!"); 
  return (std::numeric_limits<uint64_t>::digits - countLeadingZeros(Mask)) - 1; 
} 
 
/// Compute the reciprocal block throughput from a set of processor resource 
/// cycles. The reciprocal block throughput is computed as the MAX between: 
///  - NumMicroOps / DispatchWidth 
///  - ProcResourceCycles / #ProcResourceUnits  (for every consumed resource). 
double computeBlockRThroughput(const MCSchedModel &SM, unsigned DispatchWidth, 
                               unsigned NumMicroOps, 
                               ArrayRef<unsigned> ProcResourceUsage); 
} // namespace mca 
} // namespace llvm 
 
#endif // LLVM_MCA_SUPPORT_H 
 
#ifdef __GNUC__ 
#pragma GCC diagnostic pop 
#endif