LLVM  12.0.0git
Classes | Public Types | Public Member Functions | List of all members
llvm::jitlink::LinkGraph Class Reference

#include "llvm/ExecutionEngine/JITLink/JITLink.h"

Classes

class  nested_collection_iterator
 

Public Types

using external_symbol_iterator = ExternalSymbolSet::iterator
 
using section_iterator = pointee_iterator< SectionList::iterator >
 
using const_section_iterator = pointee_iterator< SectionList::const_iterator >
 
using defined_symbol_iterator = nested_collection_iterator< const_section_iterator, Section::symbol_iterator, Symbol *, getSectionSymbols >
 
using const_defined_symbol_iterator = nested_collection_iterator< const_section_iterator, Section::const_symbol_iterator, const Symbol *, getSectionConstSymbols >
 
using block_iterator = nested_collection_iterator< const_section_iterator, Section::block_iterator, Block *, getSectionBlocks >
 
using const_block_iterator = nested_collection_iterator< const_section_iterator, Section::const_block_iterator, const Block *, getSectionConstBlocks >
 
using SplitBlockCache = Optional< SmallVector< Symbol *, 8 > >
 Cache type for the splitBlock function. More...
 

Public Member Functions

 LinkGraph (std::string Name, const Triple &TT, unsigned PointerSize, support::endianness Endianness)
 
const std::string & getName ()
 Returns the name of this graph (usually the name of the original underlying MemoryBuffer). More...
 
const TriplegetTargetTriple () const
 Returns the target triple for this Graph. More...
 
unsigned getPointerSize () const
 Returns the pointer size for use in this graph. More...
 
support::endianness getEndianness () const
 Returns the endianness of content in this graph. More...
 
StringRef allocateString (StringRef Source)
 Allocate a copy of the given string using the LinkGraph's allocator. More...
 
StringRef allocateString (Twine Source)
 Allocate a copy of the given string using the LinkGraph's allocator. More...
 
SectioncreateSection (StringRef Name, sys::Memory::ProtectionFlags Prot)
 Create a section with the given name, protection flags, and alignment. More...
 
BlockcreateContentBlock (Section &Parent, StringRef Content, uint64_t Address, uint64_t Alignment, uint64_t AlignmentOffset)
 Create a content block. More...
 
BlockcreateZeroFillBlock (Section &Parent, uint64_t Size, uint64_t Address, uint64_t Alignment, uint64_t AlignmentOffset)
 Create a zero-fill block. More...
 
BlocksplitBlock (Block &B, size_t SplitIndex, SplitBlockCache *Cache=nullptr)
 Splits block B at the given index which must be greater than zero. More...
 
SymboladdExternalSymbol (StringRef Name, uint64_t Size, Linkage L)
 Add an external symbol. More...
 
SymboladdAbsoluteSymbol (StringRef Name, JITTargetAddress Address, uint64_t Size, Linkage L, Scope S, bool IsLive)
 Add an absolute symbol. More...
 
SymboladdCommonSymbol (StringRef Name, Scope S, Section &Section, JITTargetAddress Address, uint64_t Size, uint64_t Alignment, bool IsLive)
 Convenience method for adding a weak zero-fill symbol. More...
 
SymboladdAnonymousSymbol (Block &Content, JITTargetAddress Offset, JITTargetAddress Size, bool IsCallable, bool IsLive)
 Add an anonymous symbol. More...
 
SymboladdDefinedSymbol (Block &Content, JITTargetAddress Offset, StringRef Name, JITTargetAddress Size, Linkage L, Scope S, bool IsCallable, bool IsLive)
 Add a named symbol. More...
 
iterator_range< section_iteratorsections ()
 
SectionfindSectionByName (StringRef Name)
 Returns the section with the given name if it exists, otherwise returns null. More...
 
iterator_range< block_iteratorblocks ()
 
iterator_range< const_block_iteratorblocks () const
 
iterator_range< external_symbol_iteratorexternal_symbols ()
 
iterator_range< external_symbol_iteratorabsolute_symbols ()
 
iterator_range< defined_symbol_iteratordefined_symbols ()
 
iterator_range< const_defined_symbol_iteratordefined_symbols () const
 
void makeExternal (Symbol &Sym)
 Turn a defined symbol into an external one. More...
 
void removeExternalSymbol (Symbol &Sym)
 Removes an external symbol. Also removes the underlying Addressable. More...
 
void removeAbsoluteSymbol (Symbol &Sym)
 Remove an absolute symbol. Also removes the underlying Addressable. More...
 
void removeDefinedSymbol (Symbol &Sym)
 Removes defined symbols. Does not remove the underlying block. More...
 
void removeBlock (Block &B)
 Remove a block. More...
 
void dump (raw_ostream &OS, std::function< StringRef(Edge::Kind)> EdegKindToName=std::function< StringRef(Edge::Kind)>())
 Dump the graph. More...
 

Detailed Description

Definition at line 662 of file JITLink.h.

Member Typedef Documentation

◆ block_iterator

Definition at line 782 of file JITLink.h.

◆ const_block_iterator

Definition at line 787 of file JITLink.h.

◆ const_defined_symbol_iterator

Definition at line 778 of file JITLink.h.

◆ const_section_iterator

Definition at line 721 of file JITLink.h.

◆ defined_symbol_iterator

Definition at line 773 of file JITLink.h.

◆ external_symbol_iterator

Definition at line 718 of file JITLink.h.

◆ section_iterator

Definition at line 720 of file JITLink.h.

◆ SplitBlockCache

Cache type for the splitBlock function.

Definition at line 852 of file JITLink.h.

Constructor & Destructor Documentation

◆ LinkGraph()

llvm::jitlink::LinkGraph::LinkGraph ( std::string  Name,
const Triple TT,
unsigned  PointerSize,
support::endianness  Endianness 
)
inline

Definition at line 789 of file JITLink.h.

Member Function Documentation

◆ absolute_symbols()

iterator_range<external_symbol_iterator> llvm::jitlink::LinkGraph::absolute_symbols ( )
inline

◆ addAbsoluteSymbol()

Symbol& llvm::jitlink::LinkGraph::addAbsoluteSymbol ( StringRef  Name,
JITTargetAddress  Address,
uint64_t  Size,
Linkage  L,
Scope  S,
bool  IsLive 
)
inline

◆ addAnonymousSymbol()

Symbol& llvm::jitlink::LinkGraph::addAnonymousSymbol ( Block Content,
JITTargetAddress  Offset,
JITTargetAddress  Size,
bool  IsCallable,
bool  IsLive 
)
inline

◆ addCommonSymbol()

Symbol& llvm::jitlink::LinkGraph::addCommonSymbol ( StringRef  Name,
Scope  S,
Section Section,
JITTargetAddress  Address,
uint64_t  Size,
uint64_t  Alignment,
bool  IsLive 
)
inline

Convenience method for adding a weak zero-fill symbol.

Definition at line 907 of file JITLink.h.

References llvm::Address, llvm::BumpPtrAllocatorImpl< AllocatorT, SlabSize, SizeThreshold, GrowthDelay >::Allocate(), and llvm::Check::Size.

◆ addDefinedSymbol()

Symbol& llvm::jitlink::LinkGraph::addDefinedSymbol ( Block Content,
JITTargetAddress  Offset,
StringRef  Name,
JITTargetAddress  Size,
Linkage  L,
Scope  S,
bool  IsCallable,
bool  IsLive 
)
inline

◆ addExternalSymbol()

Symbol& llvm::jitlink::LinkGraph::addExternalSymbol ( StringRef  Name,
uint64_t  Size,
Linkage  L 
)
inline

Add an external symbol.

Some formats (e.g. ELF) allow Symbols to have sizes. For Symbols whose size is not known, you should substitute '0'. For external symbols Linkage determines whether the symbol must be present during lookup: Externals with strong linkage must be found or an error will be emitted. Externals with weak linkage are permitted to be undefined, in which case they are assigned a value of 0.

Definition at line 888 of file JITLink.h.

References llvm::BumpPtrAllocatorImpl< AllocatorT, SlabSize, SizeThreshold, GrowthDelay >::Allocate(), llvm::detail::DenseSetImpl< ValueT, MapTy, ValueInfoT >::insert(), and llvm::Check::Size.

◆ allocateString() [1/2]

StringRef llvm::jitlink::LinkGraph::allocateString ( StringRef  Source)
inline

Allocate a copy of the given string using the LinkGraph's allocator.

This can be useful when renaming symbols or adding new content to the graph.

Definition at line 810 of file JITLink.h.

References llvm::BumpPtrAllocatorImpl< AllocatorT, SlabSize, SizeThreshold, GrowthDelay >::Allocate(), llvm::copy(), and llvm::Sched::Source.

◆ allocateString() [2/2]

StringRef llvm::jitlink::LinkGraph::allocateString ( Twine  Source)
inline

Allocate a copy of the given string using the LinkGraph's allocator.

This can be useful when renaming symbols or adding new content to the graph.

Note: This Twine-based overload requires an extra string copy and an extra heap allocation for large strings. The StringRef overload should be preferred where possible.

Definition at line 823 of file JITLink.h.

References llvm::BumpPtrAllocatorImpl< AllocatorT, SlabSize, SizeThreshold, GrowthDelay >::Allocate(), llvm::copy(), and llvm::Sched::Source.

◆ blocks() [1/2]

iterator_range<block_iterator> llvm::jitlink::LinkGraph::blocks ( )
inline

Definition at line 953 of file JITLink.h.

References llvm::make_range().

Referenced by llvm::jitlink::BasicGOTAndStubsBuilder< BuilderImpl >::run().

◆ blocks() [2/2]

iterator_range<const_block_iterator> llvm::jitlink::LinkGraph::blocks ( ) const
inline

Definition at line 958 of file JITLink.h.

References llvm::make_range().

◆ createContentBlock()

Block& llvm::jitlink::LinkGraph::createContentBlock ( Section Parent,
StringRef  Content,
uint64_t  Address,
uint64_t  Alignment,
uint64_t  AlignmentOffset 
)
inline

Create a content block.

Definition at line 839 of file JITLink.h.

References llvm::Address, and Content.

◆ createSection()

Section& llvm::jitlink::LinkGraph::createSection ( StringRef  Name,
sys::Memory::ProtectionFlags  Prot 
)
inline

Create a section with the given name, protection flags, and alignment.

Definition at line 832 of file JITLink.h.

References llvm::move(), and llvm::ARMBuildAttrs::Section.

◆ createZeroFillBlock()

Block& llvm::jitlink::LinkGraph::createZeroFillBlock ( Section Parent,
uint64_t  Size,
uint64_t  Address,
uint64_t  Alignment,
uint64_t  AlignmentOffset 
)
inline

Create a zero-fill block.

Definition at line 846 of file JITLink.h.

References llvm::Address, and llvm::Check::Size.

◆ defined_symbols() [1/2]

iterator_range<defined_symbol_iterator> llvm::jitlink::LinkGraph::defined_symbols ( )
inline

Definition at line 971 of file JITLink.h.

References llvm::make_range().

◆ defined_symbols() [2/2]

iterator_range<const_defined_symbol_iterator> llvm::jitlink::LinkGraph::defined_symbols ( ) const
inline

Definition at line 976 of file JITLink.h.

References llvm::make_range().

◆ dump()

void llvm::jitlink::LinkGraph::dump ( raw_ostream OS,
std::function< StringRef(Edge::Kind)>  EdegKindToName = std::function<StringRef(Edge::Kind)>() 
)

Dump the graph.

If supplied, the EdgeKindToName function will be used to name edge kinds in the debug output. Otherwise raw edge kind numbers will be displayed.

Definition at line 254 of file JITLink.cpp.

References E, llvm::StringRef::empty(), llvm::format(), llvm::jitlink::getGenericEdgeKindName(), llvm::jitlink::printEdge(), and llvm::to_string().

◆ external_symbols()

iterator_range<external_symbol_iterator> llvm::jitlink::LinkGraph::external_symbols ( )
inline

◆ findSectionByName()

Section* llvm::jitlink::LinkGraph::findSectionByName ( StringRef  Name)
inline

Returns the section with the given name if it exists, otherwise returns null.

Definition at line 946 of file JITLink.h.

References llvm::jitlink::Section::getName(), and sections().

◆ getEndianness()

support::endianness llvm::jitlink::LinkGraph::getEndianness ( ) const
inline

Returns the endianness of content in this graph.

Definition at line 805 of file JITLink.h.

◆ getName()

const std::string& llvm::jitlink::LinkGraph::getName ( )
inline

Returns the name of this graph (usually the name of the original underlying MemoryBuffer).

Definition at line 796 of file JITLink.h.

◆ getPointerSize()

unsigned llvm::jitlink::LinkGraph::getPointerSize ( ) const
inline

Returns the pointer size for use in this graph.

Definition at line 802 of file JITLink.h.

◆ getTargetTriple()

const Triple& llvm::jitlink::LinkGraph::getTargetTriple ( ) const
inline

Returns the target triple for this Graph.

Definition at line 799 of file JITLink.h.

◆ makeExternal()

void llvm::jitlink::LinkGraph::makeExternal ( Symbol Sym)
inline

◆ removeAbsoluteSymbol()

void llvm::jitlink::LinkGraph::removeAbsoluteSymbol ( Symbol Sym)
inline

◆ removeBlock()

void llvm::jitlink::LinkGraph::removeBlock ( Block B)
inline

Remove a block.

Definition at line 1028 of file JITLink.h.

References assert(), B, and llvm::none_of().

◆ removeDefinedSymbol()

void llvm::jitlink::LinkGraph::removeDefinedSymbol ( Symbol Sym)
inline

Removes defined symbols. Does not remove the underlying block.

Definition at line 1021 of file JITLink.h.

References assert(), llvm::jitlink::Symbol::getBlock(), llvm::jitlink::Block::getSection(), and llvm::jitlink::Symbol::isDefined().

◆ removeExternalSymbol()

void llvm::jitlink::LinkGraph::removeExternalSymbol ( Symbol Sym)
inline

◆ sections()

iterator_range<section_iterator> llvm::jitlink::LinkGraph::sections ( )
inline

Definition at line 939 of file JITLink.h.

References llvm::make_range().

Referenced by findSectionByName().

◆ splitBlock()

Block & llvm::jitlink::LinkGraph::splitBlock ( Block B,
size_t  SplitIndex,
SplitBlockCache Cache = nullptr 
)

Splits block B at the given index which must be greater than zero.

If SplitIndex == B.getSize() then this function is a no-op and returns B. If SplitIndex < B.getSize() then this function returns a new block covering the range [ 0, SplitIndex ), and B is modified to cover the range [ SplitIndex, B.size() ).

The optional Cache parameter can be used to speed up repeated calls to splitBlock for a single block. If the value is None the cache will be treated as uninitialized and splitBlock will populate it. Otherwise it is assumed to contain the list of Symbols pointing at B, sorted in descending order of offset.

Notes:

  1. The newly introduced block will have a new ordinal which will be higher than any other ordinals in the section. Clients are responsible for re-assigning block ordinals to restore a compatible order if needed.
  2. The cache is not automatically updated if new symbols are introduced between calls to splitBlock. Any newly introduced symbols may be added to the cache manually (descending offset order must be preserved), or the cache can be set to None and rebuilt by splitBlock on the next call.

Definition at line 179 of file JITLink.cpp.

References assert(), B, llvm::jitlink::Symbol::getOffset(), I, llvm::None, and llvm::sort().


The documentation for this class was generated from the following files: