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_MACHO_SYMBOL_H
10 #define LLVM_TEXTAPI_MACHO_SYMBOL_H
11 
12 #include "llvm/ADT/BitmaskEnum.h"
13 #include "llvm/ADT/StringRef.h"
14 #include "llvm/Support/Error.h"
15 #include "llvm/Support/raw_ostream.h"
16 #include "llvm/TextAPI/ArchitectureSet.h"
17 #include "llvm/TextAPI/Target.h"
18 
19 namespace llvm {
20 namespace MachO {
21 
22 // clang-format off
23 
24 /// Symbol flags.
25 enum class SymbolFlags : uint8_t {
26   /// No flags
27   None             = 0,
28 
29   /// Thread-local value symbol
30   ThreadLocalValue = 1U << 0,
31 
32   /// Weak defined symbol
33   WeakDefined      = 1U << 1,
34 
35   /// Weak referenced symbol
36   WeakReferenced   = 1U << 2,
37 
38   /// Undefined
39   Undefined        = 1U << 3,
40 
41   /// Rexported
42   Rexported        = 1U << 4,
43 
44   LLVM_MARK_AS_BITMASK_ENUM(/*LargestValue=*/Rexported),
45 };
46 
47 // clang-format on
48 
49 enum class SymbolKind : uint8_t {
50   GlobalSymbol,
51   ObjectiveCClass,
52   ObjectiveCClassEHType,
53   ObjectiveCInstanceVariable,
54 };
55 
56 constexpr StringLiteral ObjC1ClassNamePrefix = ".objc_class_name_";
57 constexpr StringLiteral ObjC2ClassNamePrefix = "_OBJC_CLASS_$_";
58 constexpr StringLiteral ObjC2MetaClassNamePrefix = "_OBJC_METACLASS_$_";
59 constexpr StringLiteral ObjC2EHTypePrefix = "_OBJC_EHTYPE_$_";
60 constexpr StringLiteral ObjC2IVarPrefix = "_OBJC_IVAR_$_";
61 
62 using TargetList = SmallVector<Target, 5>;
63 class Symbol {
64 public:
Symbol(SymbolKind Kind,StringRef Name,TargetList Targets,SymbolFlags Flags)65   Symbol(SymbolKind Kind, StringRef Name, TargetList Targets, SymbolFlags Flags)
66       : Name(Name), Targets(std::move(Targets)), Kind(Kind), Flags(Flags) {}
67 
addTarget(Target target)68   void addTarget(Target target) { Targets.emplace_back(target); }
getKind()69   SymbolKind getKind() const { return Kind; }
getName()70   StringRef getName() const { return Name; }
getArchitectures()71   ArchitectureSet getArchitectures() const {
72     return mapToArchitectureSet(Targets);
73   }
getFlags()74   SymbolFlags getFlags() const { return Flags; }
75 
isWeakDefined()76   bool isWeakDefined() const {
77     return (Flags & SymbolFlags::WeakDefined) == SymbolFlags::WeakDefined;
78   }
79 
isWeakReferenced()80   bool isWeakReferenced() const {
81     return (Flags & SymbolFlags::WeakReferenced) == SymbolFlags::WeakReferenced;
82   }
83 
isThreadLocalValue()84   bool isThreadLocalValue() const {
85     return (Flags & SymbolFlags::ThreadLocalValue) ==
86            SymbolFlags::ThreadLocalValue;
87   }
88 
isUndefined()89   bool isUndefined() const {
90     return (Flags & SymbolFlags::Undefined) == SymbolFlags::Undefined;
91   }
92 
isReexported()93   bool isReexported() const {
94     return (Flags & SymbolFlags::Rexported) == SymbolFlags::Rexported;
95   }
96 
97   using const_target_iterator = TargetList::const_iterator;
98   using const_target_range = llvm::iterator_range<const_target_iterator>;
targets()99   const_target_range targets() const { return {Targets}; }
100 
101   using const_filtered_target_iterator =
102       llvm::filter_iterator<const_target_iterator,
103                             std::function<bool(const Target &)>>;
104   using const_filtered_target_range =
105       llvm::iterator_range<const_filtered_target_iterator>;
106   const_filtered_target_range targets(ArchitectureSet architectures) const;
107 
108 #if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
109   void dump(raw_ostream &OS) const;
dump()110   void dump() const { dump(llvm::errs()); }
111 #endif
112 
113   bool operator==(const Symbol &O) const {
114     return std::tie(Name, Kind, Targets, Flags) ==
115            std::tie(O.Name, O.Kind, O.Targets, O.Flags);
116   }
117 
118   bool operator!=(const Symbol &O) const { return !(*this == O); }
119 
120   bool operator<(const Symbol &O) const {
121     return std::tie(Name, Kind, Targets, Flags) <
122            std::tie(O.Name, O.Kind, O.Targets, O.Flags);
123   }
124 
125 private:
126   StringRef Name;
127   TargetList Targets;
128   SymbolKind Kind;
129   SymbolFlags Flags;
130 };
131 
132 } // end namespace MachO.
133 } // end namespace llvm.
134 
135 #endif // LLVM_TEXTAPI_MACHO_SYMBOL_H
136