LLVM  11.0.0git
InstrumentationMap.h
Go to the documentation of this file.
1 //===- InstrumentationMap.h - XRay Instrumentation Map ----------*- 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 // Defines the interface for extracting the instrumentation map from an
10 // XRay-instrumented binary.
11 //
12 //===----------------------------------------------------------------------===//
13 
14 #ifndef LLVM_XRAY_INSTRUMENTATION_MAP_H
15 #define LLVM_XRAY_INSTRUMENTATION_MAP_H
16 
17 #include "llvm/ADT/Optional.h"
18 #include "llvm/ADT/StringRef.h"
19 #include "llvm/Support/Error.h"
21 #include <cstdint>
22 #include <unordered_map>
23 #include <vector>
24 
25 namespace llvm {
26 
27 namespace xray {
28 
29 // Forward declare to make a friend.
30 class InstrumentationMap;
31 
32 /// Loads the instrumentation map from |Filename|. This auto-deduces the type of
33 /// the instrumentation map.
34 Expected<InstrumentationMap> loadInstrumentationMap(StringRef Filename);
35 
36 /// Represents an XRay instrumentation sled entry from an object file.
37 struct SledEntry {
38  /// Each entry here represents the kinds of supported instrumentation map
39  /// entries.
41 
42  /// The address of the sled.
43  uint64_t Address;
44 
45  /// The address of the function.
46  uint64_t Function;
47 
48  /// The kind of sled.
50 
51  /// Whether the sled was annotated to always be instrumented.
53 
54  unsigned char Version;
55 };
56 
58  int32_t FuncId;
59  yaml::Hex64 Address;
60  yaml::Hex64 Function;
63  std::string FunctionName;
64  unsigned char Version;
65 };
66 
67 /// The InstrumentationMap represents the computed function id's and indicated
68 /// function addresses from an object file (or a YAML file). This provides an
69 /// interface to just the mapping between the function id, and the function
70 /// address.
71 ///
72 /// We also provide raw access to the actual instrumentation map entries we find
73 /// associated with a particular object file.
74 ///
76 public:
77  using FunctionAddressMap = std::unordered_map<int32_t, uint64_t>;
78  using FunctionAddressReverseMap = std::unordered_map<uint64_t, int32_t>;
79  using SledContainer = std::vector<SledEntry>;
80 
81 private:
82  SledContainer Sleds;
83  FunctionAddressMap FunctionAddresses;
84  FunctionAddressReverseMap FunctionIds;
85 
87 
88 public:
89  /// Provides a raw accessor to the unordered map of function addresses.
90  const FunctionAddressMap &getFunctionAddresses() { return FunctionAddresses; }
91 
92  /// Returns an XRay computed function id, provided a function address.
93  Optional<int32_t> getFunctionId(uint64_t Addr) const;
94 
95  /// Returns the function address for a function id.
96  Optional<uint64_t> getFunctionAddr(int32_t FuncId) const;
97 
98  /// Provide read-only access to the entries of the instrumentation map.
99  const SledContainer &sleds() const { return Sleds; };
100 };
101 
102 } // end namespace xray
103 
104 namespace yaml {
105 
106 template <> struct ScalarEnumerationTraits<xray::SledEntry::FunctionKinds> {
108  IO.enumCase(Kind, "function-enter", xray::SledEntry::FunctionKinds::ENTRY);
109  IO.enumCase(Kind, "function-exit", xray::SledEntry::FunctionKinds::EXIT);
110  IO.enumCase(Kind, "tail-exit", xray::SledEntry::FunctionKinds::TAIL);
111  IO.enumCase(Kind, "log-args-enter",
113  IO.enumCase(Kind, "custom-event",
115  }
116 };
117 
118 template <> struct MappingTraits<xray::YAMLXRaySledEntry> {
119  static void mapping(IO &IO, xray::YAMLXRaySledEntry &Entry) {
120  IO.mapRequired("id", Entry.FuncId);
121  IO.mapRequired("address", Entry.Address);
122  IO.mapRequired("function", Entry.Function);
123  IO.mapRequired("kind", Entry.Kind);
124  IO.mapRequired("always-instrument", Entry.AlwaysInstrument);
125  IO.mapOptional("function-name", Entry.FunctionName);
126  IO.mapOptional("version", Entry.Version, 0);
127  }
128 
129  static constexpr bool flow = true;
130 };
131 
132 } // end namespace yaml
133 
134 } // end namespace llvm
135 
136 LLVM_YAML_IS_SEQUENCE_VECTOR(xray::YAMLXRaySledEntry)
137 
138 #endif // LLVM_XRAY_INSTRUMENTATION_MAP_H
Profile::FuncID FuncId
Definition: Profile.cpp:321
This class represents lattice values for constants.
Definition: AllocatorList.h:23
FunctionKinds
Each entry here represents the kinds of supported instrumentation map entries.
const FunctionAddressMap & getFunctionAddresses()
Provides a raw accessor to the unordered map of function addresses.
static void mapping(IO &IO, xray::YAMLXRaySledEntry &Entry)
bool AlwaysInstrument
Whether the sled was annotated to always be instrumented.
std::unordered_map< uint64_t, int32_t > FunctionAddressReverseMap
FunctionKinds Kind
The kind of sled.
std::vector< SledEntry > SledContainer
Tagged union holding either a T or a Error.
Definition: APFloat.h:42
Expected< InstrumentationMap > loadInstrumentationMap(StringRef Filename)
Loads the instrumentation map from |Filename|.
Represents an XRay instrumentation sled entry from an object file.
const SledContainer & sleds() const
Provide read-only access to the entries of the instrumentation map.
SledEntry::FunctionKinds Kind
uint64_t Address
The address of the sled.
static void enumeration(IO &IO, xray::SledEntry::FunctionKinds &Kind)
std::unordered_map< int32_t, uint64_t > FunctionAddressMap
The InstrumentationMap represents the computed function id&#39;s and indicated function addresses from an...
uint64_t Function
The address of the function.
StringRef - Represent a constant reference to a string, i.e.
Definition: StringRef.h:57