1//===- llvm/TextAPI/Symbol.h - TAPI Symbol ----------------------*- 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#ifndef LLVM_TEXTAPI_SYMBOL_H
10#define LLVM_TEXTAPI_SYMBOL_H
11
12#include "llvm/ADT/BitmaskEnum.h"
13#include "llvm/ADT/StringRef.h"
14#include "llvm/Support/raw_ostream.h"
15#include "llvm/TextAPI/ArchitectureSet.h"
16#include "llvm/TextAPI/Target.h"
17
18namespace llvm {
19namespace MachO {
20
21// clang-format off
22
23/// Symbol flags.
24enum class SymbolFlags : uint8_t {
25  /// No flags
26  None             = 0,
27
28  /// Thread-local value symbol
29  ThreadLocalValue = 1U << 0,
30
31  /// Weak defined symbol
32  WeakDefined      = 1U << 1,
33
34  /// Weak referenced symbol
35  WeakReferenced   = 1U << 2,
36
37  /// Undefined
38  Undefined        = 1U << 3,
39
40  /// Rexported
41  Rexported        = 1U << 4,
42
43  /// Data Segment
44  Data             = 1U << 5,
45
46  /// Text Segment
47  Text             = 1U << 6,
48
49  LLVM_MARK_AS_BITMASK_ENUM(/*LargestValue=*/Text),
50};
51
52// clang-format on
53
54enum class SymbolKind : uint8_t {
55  GlobalSymbol,
56  ObjectiveCClass,
57  ObjectiveCClassEHType,
58  ObjectiveCInstanceVariable,
59};
60
61constexpr StringLiteral ObjC1ClassNamePrefix = ".objc_class_name_";
62constexpr StringLiteral ObjC2ClassNamePrefix = "_OBJC_CLASS_$_";
63constexpr StringLiteral ObjC2MetaClassNamePrefix = "_OBJC_METACLASS_$_";
64constexpr StringLiteral ObjC2EHTypePrefix = "_OBJC_EHTYPE_$_";
65constexpr StringLiteral ObjC2IVarPrefix = "_OBJC_IVAR_$_";
66
67using TargetList = SmallVector<Target, 5>;
68
69// Keep containers that hold Targets in sorted order and uniqued.
70template <typename C>
71typename C::iterator addEntry(C &Container, const Target &Targ) {
72  auto Iter =
73      lower_bound(Container, Targ, [](const Target &LHS, const Target &RHS) {
74        return LHS < RHS;
75      });
76  if ((Iter != std::end(Container)) && !(Targ < *Iter))
77    return Iter;
78
79  return Container.insert(Iter, Targ);
80}
81
82class Symbol {
83public:
84  Symbol(SymbolKind Kind, StringRef Name, TargetList Targets, SymbolFlags Flags)
85      : Name(Name), Targets(std::move(Targets)), Kind(Kind), Flags(Flags) {}
86
87  void addTarget(Target InputTarget) { addEntry(Targets, InputTarget); }
88  SymbolKind getKind() const { return Kind; }
89  StringRef getName() const { return Name; }
90  ArchitectureSet getArchitectures() const {
91    return mapToArchitectureSet(Targets);
92  }
93  SymbolFlags getFlags() const { return Flags; }
94
95  bool isWeakDefined() const {
96    return (Flags & SymbolFlags::WeakDefined) == SymbolFlags::WeakDefined;
97  }
98
99  bool isWeakReferenced() const {
100    return (Flags & SymbolFlags::WeakReferenced) == SymbolFlags::WeakReferenced;
101  }
102
103  bool isThreadLocalValue() const {
104    return (Flags & SymbolFlags::ThreadLocalValue) ==
105           SymbolFlags::ThreadLocalValue;
106  }
107
108  bool isUndefined() const {
109    return (Flags & SymbolFlags::Undefined) == SymbolFlags::Undefined;
110  }
111
112  bool isReexported() const {
113    return (Flags & SymbolFlags::Rexported) == SymbolFlags::Rexported;
114  }
115
116  bool isData() const {
117    return (Flags & SymbolFlags::Data) == SymbolFlags::Data;
118  }
119
120  bool isText() const {
121    return (Flags & SymbolFlags::Text) == SymbolFlags::Text;
122  }
123
124  bool hasArchitecture(Architecture Arch) const {
125    return mapToArchitectureSet(Targets).contains(Arch);
126  }
127
128  bool hasTarget(const Target &Targ) const {
129    return llvm::is_contained(Targets, Targ);
130  }
131
132  using const_target_iterator = TargetList::const_iterator;
133  using const_target_range = llvm::iterator_range<const_target_iterator>;
134  const_target_range targets() const { return {Targets}; }
135
136  using const_filtered_target_iterator =
137      llvm::filter_iterator<const_target_iterator,
138                            std::function<bool(const Target &)>>;
139  using const_filtered_target_range =
140      llvm::iterator_range<const_filtered_target_iterator>;
141  const_filtered_target_range targets(ArchitectureSet architectures) const;
142
143#if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
144  void dump(raw_ostream &OS) const;
145  void dump() const { dump(llvm::errs()); }
146#endif
147
148  bool operator==(const Symbol &O) const;
149
150  bool operator!=(const Symbol &O) const { return !(*this == O); }
151
152  bool operator<(const Symbol &O) const {
153    return std::tie(Kind, Name) < std::tie(O.Kind, O.Name);
154  }
155
156private:
157  StringRef Name;
158  TargetList Targets;
159  SymbolKind Kind;
160  SymbolFlags Flags;
161};
162
163/// Lightweight struct for passing around symbol information.
164struct SimpleSymbol {
165  StringRef Name;
166  SymbolKind Kind;
167
168  bool operator<(const SimpleSymbol &O) const {
169    return std::tie(Name, Kind) < std::tie(O.Name, O.Kind);
170  }
171};
172
173/// Determine SymbolKind from Flags and parsing Name.
174///
175/// \param Name The name of symbol.
176/// \param Flags The flags pre-determined for the symbol.
177SimpleSymbol parseSymbol(StringRef SymName,
178                         const SymbolFlags Flags = SymbolFlags::None);
179
180} // end namespace MachO.
181} // end namespace llvm.
182
183#endif // LLVM_TEXTAPI_SYMBOL_H
184