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 18 namespace llvm { 19 namespace MachO { 20 21 // clang-format off 22 23 /// Symbol flags. 24 enum 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 54 enum class SymbolKind : uint8_t { 55 GlobalSymbol, 56 ObjectiveCClass, 57 ObjectiveCClassEHType, 58 ObjectiveCInstanceVariable, 59 }; 60 61 constexpr StringLiteral ObjC1ClassNamePrefix = ".objc_class_name_"; 62 constexpr StringLiteral ObjC2ClassNamePrefix = "_OBJC_CLASS_$_"; 63 constexpr StringLiteral ObjC2MetaClassNamePrefix = "_OBJC_METACLASS_$_"; 64 constexpr StringLiteral ObjC2EHTypePrefix = "_OBJC_EHTYPE_$_"; 65 constexpr StringLiteral ObjC2IVarPrefix = "_OBJC_IVAR_$_"; 66 67 using TargetList = SmallVector<Target, 5>; 68 69 // Keep containers that hold Targets in sorted order and uniqued. 70 template <typename C> 71 typename 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 82 class Symbol { 83 public: 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 using const_target_iterator = TargetList::const_iterator; 125 using const_target_range = llvm::iterator_range<const_target_iterator>; 126 const_target_range targets() const { return {Targets}; } 127 128 using const_filtered_target_iterator = 129 llvm::filter_iterator<const_target_iterator, 130 std::function<bool(const Target &)>>; 131 using const_filtered_target_range = 132 llvm::iterator_range<const_filtered_target_iterator>; 133 const_filtered_target_range targets(ArchitectureSet architectures) const; 134 135 #if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP) 136 void dump(raw_ostream &OS) const; 137 void dump() const { dump(llvm::errs()); } 138 #endif 139 140 bool operator==(const Symbol &O) const; 141 142 bool operator!=(const Symbol &O) const { return !(*this == O); } 143 144 bool operator<(const Symbol &O) const { 145 return std::tie(Name, Kind, Targets, Flags) < 146 std::tie(O.Name, O.Kind, O.Targets, O.Flags); 147 } 148 149 private: 150 StringRef Name; 151 TargetList Targets; 152 SymbolKind Kind; 153 SymbolFlags Flags; 154 }; 155 156 } // end namespace MachO. 157 } // end namespace llvm. 158 159 #endif // LLVM_TEXTAPI_SYMBOL_H 160