Viewing file:  Symbol.h (5.32 KB) -rw-r--r--
Select action/file-type:
 (+) |  (+) |  (+) | Code (+) | Session (+) |  (+) | SDB (+) |  (+) |  (+) |  (+) |  (+) |  (+) |
//===- llvm/TextAPI/Symbol.h - TAPI Symbol ----------------------*- C++ -*-===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
#ifndef LLVM_TEXTAPI_SYMBOL_H
#define LLVM_TEXTAPI_SYMBOL_H
#include "llvm/ADT/BitmaskEnum.h"
#include "llvm/ADT/StringRef.h"
#include "llvm/Support/raw_ostream.h"
#include "llvm/TextAPI/ArchitectureSet.h"
#include "llvm/TextAPI/Target.h"
namespace llvm {
namespace MachO {
// clang-format off
/// Symbol flags.
enum class SymbolFlags : uint8_t {
/// No flags
None = 0,
/// Thread-local value symbol
ThreadLocalValue = 1U << 0,
/// Weak defined symbol
WeakDefined = 1U << 1,
/// Weak referenced symbol
WeakReferenced = 1U << 2,
/// Undefined
Undefined = 1U << 3,
/// Rexported
Rexported = 1U << 4,
/// Data Segment
Data = 1U << 5,
/// Text Segment
Text = 1U << 6,
LLVM_MARK_AS_BITMASK_ENUM(/*LargestValue=*/Text),
};
// clang-format on
/// Mapping of entry types in TextStubs.
enum class EncodeKind : uint8_t {
GlobalSymbol,
ObjectiveCClass,
ObjectiveCClassEHType,
ObjectiveCInstanceVariable,
};
constexpr StringLiteral ObjC1ClassNamePrefix = ".objc_class_name_";
constexpr StringLiteral ObjC2ClassNamePrefix = "_OBJC_CLASS_$_";
constexpr StringLiteral ObjC2MetaClassNamePrefix = "_OBJC_METACLASS_$_";
constexpr StringLiteral ObjC2EHTypePrefix = "_OBJC_EHTYPE_$_";
constexpr StringLiteral ObjC2IVarPrefix = "_OBJC_IVAR_$_";
/// ObjC Interface symbol mappings.
enum class ObjCIFSymbolKind : uint8_t {
None = 0,
/// Is OBJC_CLASS* symbol.
Class = 1U << 0,
/// Is OBJC_METACLASS* symbol.
MetaClass = 1U << 1,
/// Is OBJC_EHTYPE* symbol.
EHType = 1U << 2,
LLVM_MARK_AS_BITMASK_ENUM(/*LargestValue=*/EHType),
};
using TargetList = SmallVector<Target, 5>;
// Keep containers that hold Targets in sorted order and uniqued.
template <typename C>
typename C::iterator addEntry(C &Container, const Target &Targ) {
auto Iter =
lower_bound(Container, Targ, [](const Target &LHS, const Target &RHS) {
return LHS < RHS;
});
if ((Iter != std::end(Container)) && !(Targ < *Iter))
return Iter;
return Container.insert(Iter, Targ);
}
class Symbol {
public:
Symbol(EncodeKind Kind, StringRef Name, TargetList Targets, SymbolFlags Flags)
: Name(Name), Targets(std::move(Targets)), Kind(Kind), Flags(Flags) {}
void addTarget(Target InputTarget) { addEntry(Targets, InputTarget); }
EncodeKind getKind() const { return Kind; }
StringRef getName() const { return Name; }
ArchitectureSet getArchitectures() const {
return mapToArchitectureSet(Targets);
}
SymbolFlags getFlags() const { return Flags; }
bool isWeakDefined() const {
return (Flags & SymbolFlags::WeakDefined) == SymbolFlags::WeakDefined;
}
bool isWeakReferenced() const {
return (Flags & SymbolFlags::WeakReferenced) == SymbolFlags::WeakReferenced;
}
bool isThreadLocalValue() const {
return (Flags & SymbolFlags::ThreadLocalValue) ==
SymbolFlags::ThreadLocalValue;
}
bool isUndefined() const {
return (Flags & SymbolFlags::Undefined) == SymbolFlags::Undefined;
}
bool isReexported() const {
return (Flags & SymbolFlags::Rexported) == SymbolFlags::Rexported;
}
bool isData() const {
return (Flags & SymbolFlags::Data) == SymbolFlags::Data;
}
bool isText() const {
return (Flags & SymbolFlags::Text) == SymbolFlags::Text;
}
bool hasArchitecture(Architecture Arch) const {
return mapToArchitectureSet(Targets).contains(Arch);
}
bool hasTarget(const Target &Targ) const {
return llvm::is_contained(Targets, Targ);
}
using const_target_iterator = TargetList::const_iterator;
using const_target_range = llvm::iterator_range<const_target_iterator>;
const_target_range targets() const { return {Targets}; }
using const_filtered_target_iterator =
llvm::filter_iterator<const_target_iterator,
std::function<bool(const Target &)>>;
using const_filtered_target_range =
llvm::iterator_range<const_filtered_target_iterator>;
const_filtered_target_range targets(ArchitectureSet architectures) const;
#if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
void dump(raw_ostream &OS) const;
void dump() const { dump(llvm::errs()); }
#endif
bool operator==(const Symbol &O) const;
bool operator!=(const Symbol &O) const { return !(*this == O); }
bool operator<(const Symbol &O) const {
return std::tie(Kind, Name) < std::tie(O.Kind, O.Name);
}
private:
StringRef Name;
TargetList Targets;
EncodeKind Kind;
SymbolFlags Flags;
};
/// Lightweight struct for passing around symbol information.
struct SimpleSymbol {
StringRef Name;
EncodeKind Kind;
ObjCIFSymbolKind ObjCInterfaceType;
bool operator<(const SimpleSymbol &O) const {
return std::tie(Name, Kind, ObjCInterfaceType) <
std::tie(O.Name, O.Kind, O.ObjCInterfaceType);
}
};
/// Get symbol classification by parsing the name of a symbol.
///
/// \param SymName The name of symbol.
SimpleSymbol parseSymbol(StringRef SymName);
} // end namespace MachO.
} // end namespace llvm.
#endif // LLVM_TEXTAPI_SYMBOL_H
|