LLVM 22.0.0git
ItaniumManglingCanonicalizer.h
Go to the documentation of this file.
1//===--- ItaniumManglingCanonicalizer.h -------------------------*- 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 a class for computing equivalence classes of mangled names
10// given a set of equivalences between name fragments.
11//
12//===----------------------------------------------------------------------===//
13
14#ifndef LLVM_PROFILEDATA_ITANIUMMANGLINGCANONICALIZER_H
15#define LLVM_PROFILEDATA_ITANIUMMANGLINGCANONICALIZER_H
16
18#include <cstdint>
19
20namespace llvm {
21
22class StringRef;
23
24/// Canonicalizer for mangled names.
25///
26/// This class allows specifying a list of "equivalent" manglings. For example,
27/// you can specify that Ss is equivalent to
28/// NSt3__112basic_stringIcNS_11char_traitsIcEENS_9allocatorIcEEEE
29/// and then manglings that refer to libstdc++'s 'std::string' will be
30/// considered equivalent to manglings that are the same except that they refer
31/// to libc++'s 'std::string'.
32///
33/// This can be used when data (eg, profiling data) is available for a version
34/// of a program built in a different configuration, with correspondingly
35/// different manglings.
37public:
42
43 enum class EquivalenceError {
44 Success,
45
46 /// Both the equivalent manglings have already been used as components of
47 /// some other mangling we've looked at. It's too late to add this
48 /// equivalence.
50
51 /// The first equivalent mangling is invalid.
53
54 /// The second equivalent mangling is invalid.
56 };
57
58 enum class FragmentKind {
59 /// The mangling fragment is a <name> (or a predefined <substitution>).
60 Name,
61 /// The mangling fragment is a <type>.
62 Type,
63 /// The mangling fragment is an <encoding>.
65 };
66
67 /// Add an equivalence between \p First and \p Second. Both manglings must
68 /// live at least as long as the canonicalizer.
70 StringRef Second);
71
72 using Key = uintptr_t;
73
74 /// Form a canonical key for the specified mangling. They key will be the
75 /// same for all equivalent manglings, and different for any two
76 /// non-equivalent manglings, but is otherwise unspecified.
77 ///
78 /// Returns Key() if (and only if) the mangling is not a valid Itanium C++
79 /// ABI mangling.
80 ///
81 /// The string denoted by Mangling must live as long as the canonicalizer.
83
84 /// Find a canonical key for the specified mangling, if one has already been
85 /// formed. Otherwise returns Key().
86 LLVM_ABI Key lookup(StringRef Mangling);
87
88private:
89 struct Impl;
90 Impl *P;
91};
92} // namespace llvm
93
94#endif // LLVM_PROFILEDATA_ITANIUMMANGLINGCANONICALIZER_H
#define LLVM_ABI
Definition: Compiler.h:213
#define P(N)
@ Encoding
The mangling fragment is an <encoding>.
@ Name
The mangling fragment is a <name> (or a predefined <substitution>).
@ Type
The mangling fragment is a <type>.
LLVM_ABI Key lookup(StringRef Mangling)
Find a canonical key for the specified mangling, if one has already been formed.
LLVM_ABI Key canonicalize(StringRef Mangling)
Form a canonical key for the specified mangling.
void operator=(const ItaniumManglingCanonicalizer &)=delete
ItaniumManglingCanonicalizer(const ItaniumManglingCanonicalizer &)=delete
@ InvalidFirstMangling
The first equivalent mangling is invalid.
@ InvalidSecondMangling
The second equivalent mangling is invalid.
@ ManglingAlreadyUsed
Both the equivalent manglings have already been used as components of some other mangling we've looke...
LLVM_ABI EquivalenceError addEquivalence(FragmentKind Kind, StringRef First, StringRef Second)
Add an equivalence between First and Second.
StringRef - Represent a constant reference to a string, i.e.
Definition: StringRef.h:55
This is an optimization pass for GlobalISel generic memory operations.
Definition: AddressRanges.h:18
@ First
Helpers to iterate all locations in the MemoryEffectsBase class.