LLVM 20.0.0git
Public Member Functions | List of all members
llvm::MemoryWriteTracking Class Reference

#include "llvm/Analysis/InstructionPrecedenceTracking.h"

Inheritance diagram for llvm::MemoryWriteTracking:
Inheritance graph
[legend]

Public Member Functions

const InstructiongetFirstMemoryWrite (const BasicBlock *BB)
 Returns the topmost instruction that may write memory from the given basic block.
 
bool mayWriteToMemory (const BasicBlock *BB)
 Returns true if at least one instruction from the given basic block may write memory.
 
bool isDominatedByMemoryWriteFromSameBlock (const Instruction *Insn)
 Returns true if the first memory writing instruction of Insn's block exists and dominates Insn.
 
bool isSpecialInstruction (const Instruction *Insn) const override
 A predicate that defines whether or not the instruction Insn is considered special and needs to be tracked.
 
- Public Member Functions inherited from llvm::InstructionPrecedenceTracking
void insertInstructionTo (const Instruction *Inst, const BasicBlock *BB)
 Notifies this tracking that we are going to insert a new instruction Inst to the basic block BB.
 
void removeInstruction (const Instruction *Inst)
 Notifies this tracking that we are going to remove the instruction Inst It makes all necessary updates to internal caches to keep them consistent.
 
void removeUsersOf (const Instruction *Inst)
 Notifies this tracking that we are going to replace all uses of Inst.
 
void clear ()
 Invalidates all information from this tracking.
 

Additional Inherited Members

- Protected Member Functions inherited from llvm::InstructionPrecedenceTracking
const InstructiongetFirstSpecialInstruction (const BasicBlock *BB)
 Returns the topmost special instruction from the block BB.
 
bool hasSpecialInstructions (const BasicBlock *BB)
 Returns true iff at least one instruction from the basic block BB is special.
 
bool isPreceededBySpecialInstruction (const Instruction *Insn)
 Returns true iff the first special instruction of Insn's block exists and dominates Insn.
 
virtual bool isSpecialInstruction (const Instruction *Insn) const =0
 A predicate that defines whether or not the instruction Insn is considered special and needs to be tracked.
 
virtual ~InstructionPrecedenceTracking ()=default
 

Detailed Description

Definition at line 121 of file InstructionPrecedenceTracking.h.

Member Function Documentation

◆ getFirstMemoryWrite()

const Instruction * llvm::MemoryWriteTracking::getFirstMemoryWrite ( const BasicBlock BB)
inline

Returns the topmost instruction that may write memory from the given basic block.

Returns nullptr if there is no such instructions in the block.

Definition at line 125 of file InstructionPrecedenceTracking.h.

References llvm::InstructionPrecedenceTracking::getFirstSpecialInstruction().

◆ isDominatedByMemoryWriteFromSameBlock()

bool llvm::MemoryWriteTracking::isDominatedByMemoryWriteFromSameBlock ( const Instruction Insn)
inline

Returns true if the first memory writing instruction of Insn's block exists and dominates Insn.

Definition at line 137 of file InstructionPrecedenceTracking.h.

References Insn, and llvm::InstructionPrecedenceTracking::isPreceededBySpecialInstruction().

Referenced by llvm::ICFLoopSafetyInfo::doesNotWriteMemoryBefore().

◆ isSpecialInstruction()

bool MemoryWriteTracking::isSpecialInstruction ( const Instruction Insn) const
overridevirtual

A predicate that defines whether or not the instruction Insn is considered special and needs to be tracked.

Implementing this method in children classes allows to implement tracking of implicit control flow, memory writing instructions or any other kinds of instructions we might be interested in.

Implements llvm::InstructionPrecedenceTracking.

Definition at line 147 of file InstructionPrecedenceTracking.cpp.

References Insn, and llvm::PatternMatch::match().

◆ mayWriteToMemory()

bool llvm::MemoryWriteTracking::mayWriteToMemory ( const BasicBlock BB)
inline

Returns true if at least one instruction from the given basic block may write memory.

Definition at line 131 of file InstructionPrecedenceTracking.h.

References llvm::InstructionPrecedenceTracking::hasSpecialInstructions().

Referenced by llvm::ICFLoopSafetyInfo::doesNotWriteMemoryBefore().


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