LLVM 22.0.0git
Public Types | Public Member Functions | List of all members
llvm::GCFunctionInfo Class Reference

Garbage collection metadata for a single function. More...

#include "llvm/CodeGen/GCMetadata.h"

Public Types

using iterator = std::vector<GCPoint>::iterator
using roots_iterator = std::vector<GCRoot>::iterator
using live_iterator = std::vector<GCRoot>::const_iterator

Public Member Functions

LLVM_ABI GCFunctionInfo (const Function &F, GCStrategy &S)
LLVM_ABI ~GCFunctionInfo ()
LLVM_ABI bool invalidate (Function &F, const PreservedAnalyses &PA, FunctionAnalysisManager::Invalidator &Inv)
 Handle invalidation explicitly.
const Function & getFunction () const
 getFunction - Return the function to which this metadata applies.
GCStrategy & getStrategy ()
 getStrategy - Return the GC strategy for the function.
void addStackRoot (int Num, const Constant *Metadata)
 addStackRoot - Registers a root that lives on the stack.
roots_iterator removeStackRoot (roots_iterator position)
 removeStackRoot - Removes a root.
void addSafePoint (MCSymbol *Label, const DebugLoc &DL)
 addSafePoint - Notes the existence of a safe point.
uint64_t getFrameSize () const
 getFrameSize/setFrameSize - Records the function's frame size.
void setFrameSize (uint64_t S)
iterator begin ()
 begin/end - Iterators for safe points.
iterator end ()
size_t size () const
roots_iterator roots_begin ()
 roots_begin/roots_end - Iterators for all roots in the function.
roots_iterator roots_end ()
size_t roots_size () const
live_iterator live_begin (const iterator &p)
 live_begin/live_end - Iterators for live roots at a given safe point.
live_iterator live_end (const iterator &p)
size_t live_size (const iterator &p) const

Detailed Description

Garbage collection metadata for a single function.

Currently, this information only applies to GCStrategies which use GCRoot.

Definition at line 80 of file GCMetadata.h.

Member Typedef Documentation

◆ iterator

using llvm::GCFunctionInfo::iterator = std::vector<GCPoint>::iterator

Definition at line 82 of file GCMetadata.h.

◆ live_iterator

using llvm::GCFunctionInfo::live_iterator = std::vector<GCRoot>::const_iterator

Definition at line 84 of file GCMetadata.h.

◆ roots_iterator

using llvm::GCFunctionInfo::roots_iterator = std::vector<GCRoot>::iterator

Definition at line 83 of file GCMetadata.h.

Constructor & Destructor Documentation

◆ GCFunctionInfo()

LLVM_ABI llvm::GCFunctionInfo::GCFunctionInfo ( const Function & F,
GCStrategy & S )

References LLVM_ABI.

◆ ~GCFunctionInfo()

GCFunctionInfo::~GCFunctionInfo ( )
default

References LLVM_ABI.

Member Function Documentation

◆ addSafePoint()

void llvm::GCFunctionInfo::addSafePoint ( MCSymbol * Label,
const DebugLoc & DL )
inline

addSafePoint - Notes the existence of a safe point.

Num is the ID of the label just prior to the safe point (if the code generator is using MachineModuleInfo).

Definition at line 132 of file GCMetadata.h.

References DL.

◆ addStackRoot()

void llvm::GCFunctionInfo::addStackRoot ( int Num,
const Constant * Metadata )
inline

addStackRoot - Registers a root that lives on the stack.

Num is the stack object ID for the alloca (if the code generator is

Definition at line 120 of file GCMetadata.h.

◆ begin()

iterator llvm::GCFunctionInfo::begin ( )
inline

begin/end - Iterators for safe points.

Definition at line 141 of file GCMetadata.h.

◆ end()

iterator llvm::GCFunctionInfo::end ( )
inline

Definition at line 142 of file GCMetadata.h.

◆ getFrameSize()

uint64_t llvm::GCFunctionInfo::getFrameSize ( ) const
inline

getFrameSize/setFrameSize - Records the function's frame size.

Definition at line 137 of file GCMetadata.h.

◆ getFunction()

const Function & llvm::GCFunctionInfo::getFunction ( ) const
inline

getFunction - Return the function to which this metadata applies.

Definition at line 112 of file GCMetadata.h.

◆ getStrategy()

GCStrategy & llvm::GCFunctionInfo::getStrategy ( )
inline

getStrategy - Return the GC strategy for the function.

Definition at line 115 of file GCMetadata.h.

◆ invalidate()

bool GCFunctionInfo::invalidate ( Function & F,
const PreservedAnalyses & PA,
FunctionAnalysisManager::Invalidator & Inv )

Handle invalidation explicitly.

Definition at line 81 of file GCMetadata.cpp.

References llvm::PreservedAnalyses::getChecker().

◆ live_begin()

live_iterator llvm::GCFunctionInfo::live_begin ( const iterator & p)
inline

live_begin/live_end - Iterators for live roots at a given safe point.

Definition at line 151 of file GCMetadata.h.

References roots_begin().

◆ live_end()

live_iterator llvm::GCFunctionInfo::live_end ( const iterator & p)
inline

Definition at line 152 of file GCMetadata.h.

References roots_end().

◆ live_size()

size_t llvm::GCFunctionInfo::live_size ( const iterator & p) const
inline

Definition at line 153 of file GCMetadata.h.

References roots_size().

◆ removeStackRoot()

roots_iterator llvm::GCFunctionInfo::removeStackRoot ( roots_iterator position)
inline

removeStackRoot - Removes a root.

Definition at line 125 of file GCMetadata.h.

◆ roots_begin()

roots_iterator llvm::GCFunctionInfo::roots_begin ( )
inline

roots_begin/roots_end - Iterators for all roots in the function.

Definition at line 146 of file GCMetadata.h.

Referenced by live_begin().

◆ roots_end()

roots_iterator llvm::GCFunctionInfo::roots_end ( )
inline

Definition at line 147 of file GCMetadata.h.

Referenced by live_end().

◆ roots_size()

size_t llvm::GCFunctionInfo::roots_size ( ) const
inline

Definition at line 148 of file GCMetadata.h.

Referenced by live_size().

◆ setFrameSize()

void llvm::GCFunctionInfo::setFrameSize ( uint64_t S)
inline

Definition at line 138 of file GCMetadata.h.

◆ size()

size_t llvm::GCFunctionInfo::size ( ) const
inline

Definition at line 143 of file GCMetadata.h.

The documentation for this class was generated from the following files:
Generated on for LLVM by doxygen 1.14.0