15460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao//===- LDSymbol.h ---------------------------------------------------------===// 25460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao// 35460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao// The MCLinker Project 45460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao// 55460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao// This file is distributed under the University of Illinois Open Source 65460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao// License. See LICENSE.TXT for details. 75460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao// 85460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao//===----------------------------------------------------------------------===// 95460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao#ifndef MCLD_LD_SYMBOL_H 105460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao#define MCLD_LD_SYMBOL_H 115460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao#ifdef ENABLE_UNITTEST 125460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao#include <gtest.h> 135460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao#endif 145460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao 15cedee4b38f4786845183be7f5916dd520a170ae0Shih-wei Liao#include <cassert> 16cedee4b38f4786845183be7f5916dd520a170ae0Shih-wei Liao 1722add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao#include <mcld/Config/Config.h> 18cedee4b38f4786845183be7f5916dd520a170ae0Shih-wei Liao#include <mcld/ADT/Uncopyable.h> 19cedee4b38f4786845183be7f5916dd520a170ae0Shih-wei Liao#include <mcld/LD/ResolveInfo.h> 2022add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao#include <mcld/Support/Allocators.h> 215460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao 226f75755c9204b1d8817ae5a65a2f7e5af0ec3f70Stephen Hines#include <llvm/Support/ManagedStatic.h> 236f75755c9204b1d8817ae5a65a2f7e5af0ec3f70Stephen Hines 2422add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liaonamespace mcld { 2522add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao 2622add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liaoclass FragmentRef; 275460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao 285460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao/** \class LDSymbol 295460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao * \brief LDSymbol provides a consistent abstraction for different formats 305460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao * in different targets. 315460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao */ 325460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liaoclass LDSymbol 335460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao{ 345460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liaopublic: 355460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao // FIXME: use SizeTrait<32> or SizeTrait<64> instead of big type 365460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao typedef ResolveInfo::SizeType SizeType; 375460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao typedef uint64_t ValueType; 385460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao 395460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liaopublic: 405460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao ~LDSymbol(); 415460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao 4222add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao // ----- factory method ----- // 4322add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao static LDSymbol* Create(ResolveInfo& pResolveInfo); 4422add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao 4522add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao static void Destroy(LDSymbol*& pSymbol); 4622add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao 4722add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao /// Clear - This function tells MCLinker to clear all created LDSymbols. 4822add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao static void Clear(); 4922add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao 5022add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao /// NullSymbol() - This returns a reference to a LDSymbol that represents Null 5122add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao /// symbol. 5222add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao static LDSymbol* Null(); 5322add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao 545460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao // ----- observers ----- // 5522add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao bool isNull() const; 5622add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao 575460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao const char* name() const { 585460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao assert(NULL != m_pResolveInfo); 595460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao return m_pResolveInfo->name(); 605460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao } 615460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao 625460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao unsigned int nameSize() const { 635460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao assert(NULL != m_pResolveInfo); 645460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao return m_pResolveInfo->nameSize(); 655460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao } 665460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao 675460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao llvm::StringRef str() const { 685460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao assert(NULL != m_pResolveInfo); 695460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao return llvm::StringRef(m_pResolveInfo->name(), m_pResolveInfo->nameSize()); 705460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao } 715460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao 725460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao bool isDyn() const { 735460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao assert(NULL != m_pResolveInfo); 745460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao return m_pResolveInfo->isDyn(); 755460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao } 765460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao 775460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao unsigned int type() const { 785460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao assert(NULL != m_pResolveInfo); 795460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao return m_pResolveInfo->type(); 805460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao } 815460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao unsigned int desc() const { 825460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao assert(NULL != m_pResolveInfo); 835460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao return m_pResolveInfo->desc(); 845460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao } 855460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao unsigned int binding() const { 865460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao assert(NULL != m_pResolveInfo); 875460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao return m_pResolveInfo->binding(); 885460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao } 895460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao 905460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao uint8_t other() const { 915460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao assert(NULL != m_pResolveInfo); 925460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao return m_pResolveInfo->other(); 935460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao } 945460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao 955460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao uint8_t visibility() const { 965460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao assert(NULL != m_pResolveInfo); 975460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao return m_pResolveInfo->other(); 985460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao } 995460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao 1005460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao ValueType value() const 1015460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao { return m_Value; } 1025460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao 103cedee4b38f4786845183be7f5916dd520a170ae0Shih-wei Liao const FragmentRef* fragRef() const 1045460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao { return m_pFragRef; } 1055460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao 1065460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao SizeType size() const 1075460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao { return m_pResolveInfo->size(); } 1085460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao 1095460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao ResolveInfo* resolveInfo() 1105460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao { return m_pResolveInfo; } 1115460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao 112affc150dc44fab1911775a49636d0ce85333b634Zonr Chang const ResolveInfo* resolveInfo() const 1135460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao { return m_pResolveInfo; } 1145460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao 11522add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao bool hasFragRef() const; 1165460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao 1175460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao // ----- modifiers ----- // 1185460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao void setSize(SizeType pSize) { 1195460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao assert(NULL != m_pResolveInfo); 1205460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao m_pResolveInfo->setSize(pSize); 1215460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao } 1225460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao 1235460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao void setValue(ValueType pValue) 1245460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao { m_Value = pValue; } 125affc150dc44fab1911775a49636d0ce85333b634Zonr Chang 126cedee4b38f4786845183be7f5916dd520a170ae0Shih-wei Liao void setFragmentRef(FragmentRef* pFragmentRef); 1275460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao 1285460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao void setResolveInfo(const ResolveInfo& pInfo); 1295460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao 1305460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liaoprivate: 13122add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao friend class Chunk<LDSymbol, MCLD_SYMBOLS_PER_INPUT>; 1326f75755c9204b1d8817ae5a65a2f7e5af0ec3f70Stephen Hines template<class T> friend void* llvm::object_creator(); 13322add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao 13422add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao LDSymbol(); 13522add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao LDSymbol(const LDSymbol& pCopy); 13622add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao LDSymbol& operator=(const LDSymbol& pCopy); 13722add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liao 13822add6ff3426df1a85089fe6a6e1597ee3b6f300Shih-wei Liaoprivate: 1395460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao // ----- Symbol's fields ----- // 1405460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao ResolveInfo* m_pResolveInfo; 141cedee4b38f4786845183be7f5916dd520a170ae0Shih-wei Liao FragmentRef* m_pFragRef; 1425460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao ValueType m_Value; 1435460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao 1445460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao}; 1455460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao 1465460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao} // namespace mcld 1475460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao 1485460a1f25d9ddecb5c70667267d66d51af177a99Shih-wei Liao#endif 149affc150dc44fab1911775a49636d0ce85333b634Zonr Chang 150