aboutsummaryrefslogtreecommitdiffstats
path: root/contrib/libs/llvm12/include/llvm/IR/PseudoProbe.h
blob: 56766cafc3017e18db0d4165e0e5c48428a0f4fa (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
#pragma once 
 
#ifdef __GNUC__ 
#pragma GCC diagnostic push 
#pragma GCC diagnostic ignored "-Wunused-parameter" 
#endif 
 
//===- PseudoProbe.h - Pseudo Probe IR Helpers ------------------*- 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 
// 
//===----------------------------------------------------------------------===// 
// 
// Pseudo probe IR intrinsic and dwarf discriminator manipulation routines. 
// 
//===----------------------------------------------------------------------===// 
 
#ifndef LLVM_IR_PSEUDOPROBE_H 
#define LLVM_IR_PSEUDOPROBE_H 
 
#include "llvm/ADT/Optional.h" 
#include <cassert> 
#include <cstdint> 
#include <limits> 
 
namespace llvm { 
 
class Instruction; 
class BasicBlock; 
 
constexpr const char *PseudoProbeDescMetadataName = "llvm.pseudo_probe_desc"; 
 
enum class PseudoProbeType { Block = 0, IndirectCall, DirectCall }; 
 
// The saturated distrution factor representing 100% for block probes. 
constexpr static uint64_t PseudoProbeFullDistributionFactor = 
    std::numeric_limits<uint64_t>::max(); 
 
struct PseudoProbeDwarfDiscriminator { 
public: 
  // The following APIs encodes/decodes per-probe information to/from a 
  // 32-bit integer which is organized as: 
  //  [2:0] - 0x7, this is reserved for regular discriminator, 
  //          see DWARF discriminator encoding rule 
  //  [18:3] - probe id 
  //  [25:19] - probe distribution factor 
  //  [28:26] - probe type, see PseudoProbeType 
  //  [31:29] - reserved for probe attributes 
  static uint32_t packProbeData(uint32_t Index, uint32_t Type, uint32_t Flags, 
                                uint32_t Factor) { 
    assert(Index <= 0xFFFF && "Probe index too big to encode, exceeding 2^16"); 
    assert(Type <= 0x7 && "Probe type too big to encode, exceeding 7"); 
    assert(Flags <= 0x7); 
    assert(Factor <= 100 && 
           "Probe distribution factor too big to encode, exceeding 100"); 
    return (Index << 3) | (Factor << 19) | (Type << 26) | 0x7; 
  } 
 
  static uint32_t extractProbeIndex(uint32_t Value) { 
    return (Value >> 3) & 0xFFFF; 
  } 
 
  static uint32_t extractProbeType(uint32_t Value) { 
    return (Value >> 26) & 0x7; 
  } 
 
  static uint32_t extractProbeAttributes(uint32_t Value) { 
    return (Value >> 29) & 0x7; 
  } 
 
  static uint32_t extractProbeFactor(uint32_t Value) { 
    return (Value >> 19) & 0x7F; 
  } 
 
  // The saturated distrution factor representing 100% for callsites. 
  constexpr static uint8_t FullDistributionFactor = 100; 
}; 
 
struct PseudoProbe { 
  uint32_t Id; 
  uint32_t Type; 
  uint32_t Attr; 
  float Factor; 
}; 
 
Optional<PseudoProbe> extractProbe(const Instruction &Inst); 
 
void setProbeDistributionFactor(Instruction &Inst, float Factor); 
 
} // end namespace llvm 
 
#endif // LLVM_IR_PSEUDOPROBE_H 
 
#ifdef __GNUC__ 
#pragma GCC diagnostic pop 
#endif