mirror of
https://github.com/c64scene-ar/llvm-6502.git
synced 2024-08-21 18:29:46 +00:00
Apparently, the style needs to be agreed upon first. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@240390 91177308-0d34-0410-b5e6-96231b3b80d8
265 lines
9.2 KiB
C++
265 lines
9.2 KiB
C++
//===-- llvm/User.h - User class definition ---------------------*- C++ -*-===//
|
|
//
|
|
// The LLVM Compiler Infrastructure
|
|
//
|
|
// This file is distributed under the University of Illinois Open Source
|
|
// License. See LICENSE.TXT for details.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
//
|
|
// This class defines the interface that one who uses a Value must implement.
|
|
// Each instance of the Value class keeps track of what User's have handles
|
|
// to it.
|
|
//
|
|
// * Instructions are the largest class of Users.
|
|
// * Constants may be users of other constants (think arrays and stuff)
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#ifndef LLVM_IR_USER_H
|
|
#define LLVM_IR_USER_H
|
|
|
|
#include "llvm/ADT/iterator.h"
|
|
#include "llvm/ADT/iterator_range.h"
|
|
#include "llvm/IR/Value.h"
|
|
#include "llvm/Support/AlignOf.h"
|
|
#include "llvm/Support/ErrorHandling.h"
|
|
|
|
namespace llvm {
|
|
|
|
/// \brief Compile-time customization of User operands.
|
|
///
|
|
/// Customizes operand-related allocators and accessors.
|
|
template <class>
|
|
struct OperandTraits;
|
|
|
|
class User : public Value {
|
|
User(const User &) = delete;
|
|
template <unsigned>
|
|
friend struct HungoffOperandTraits;
|
|
virtual void anchor();
|
|
|
|
protected:
|
|
/// Allocate a User with an operand pointer co-allocated.
|
|
///
|
|
/// This is used for subclasses which need to allocate a variable number
|
|
/// of operands, ie, 'hung off uses'.
|
|
void *operator new(size_t Size);
|
|
|
|
/// Allocate a User with the operands co-allocated.
|
|
///
|
|
/// This is used for subclasses which have a fixed number of operands.
|
|
void *operator new(size_t Size, unsigned Us);
|
|
|
|
User(Type *ty, unsigned vty, Use *OpList, unsigned NumOps)
|
|
: Value(ty, vty) {
|
|
assert(NumOps < (1u << NumUserOperandsBits) && "Too many operands");
|
|
NumUserOperands = NumOps;
|
|
// If we have hung off uses, then the operand list should initially be
|
|
// null.
|
|
assert((!HasHungOffUses || !getOperandList()) &&
|
|
"Error in initializing hung off uses for User");
|
|
}
|
|
|
|
/// \brief Allocate the array of Uses, followed by a pointer
|
|
/// (with bottom bit set) to the User.
|
|
/// \param IsPhi identifies callers which are phi nodes and which need
|
|
/// N BasicBlock* allocated along with N
|
|
void allocHungoffUses(unsigned N, bool IsPhi = false);
|
|
|
|
/// \brief Grow the number of hung off uses. Note that allocHungoffUses
|
|
/// should be called if there are no uses.
|
|
void growHungoffUses(unsigned N, bool IsPhi = false);
|
|
|
|
public:
|
|
~User() override {
|
|
}
|
|
/// \brief Free memory allocated for User and Use objects.
|
|
void operator delete(void *Usr);
|
|
/// \brief Placement delete - required by std, but never called.
|
|
void operator delete(void*, unsigned) {
|
|
llvm_unreachable("Constructor throws?");
|
|
}
|
|
/// \brief Placement delete - required by std, but never called.
|
|
void operator delete(void*, unsigned, bool) {
|
|
llvm_unreachable("Constructor throws?");
|
|
}
|
|
protected:
|
|
template <int Idx, typename U> static Use &OpFrom(const U *that) {
|
|
return Idx < 0
|
|
? OperandTraits<U>::op_end(const_cast<U*>(that))[Idx]
|
|
: OperandTraits<U>::op_begin(const_cast<U*>(that))[Idx];
|
|
}
|
|
template <int Idx> Use &Op() {
|
|
return OpFrom<Idx>(this);
|
|
}
|
|
template <int Idx> const Use &Op() const {
|
|
return OpFrom<Idx>(this);
|
|
}
|
|
private:
|
|
Use *&getHungOffOperands() { return *(reinterpret_cast<Use **>(this) - 1); }
|
|
|
|
Use *getIntrusiveOperands() {
|
|
return reinterpret_cast<Use *>(this) - NumUserOperands;
|
|
}
|
|
|
|
void setOperandList(Use *NewList) {
|
|
assert(HasHungOffUses &&
|
|
"Setting operand list only required for hung off uses");
|
|
getHungOffOperands() = NewList;
|
|
}
|
|
public:
|
|
Use *getOperandList() {
|
|
return HasHungOffUses ? getHungOffOperands() : getIntrusiveOperands();
|
|
}
|
|
const Use *getOperandList() const {
|
|
return const_cast<User *>(this)->getOperandList();
|
|
}
|
|
Value *getOperand(unsigned i) const {
|
|
assert(i < NumUserOperands && "getOperand() out of range!");
|
|
return getOperandList()[i];
|
|
}
|
|
void setOperand(unsigned i, Value *Val) {
|
|
assert(i < NumUserOperands && "setOperand() out of range!");
|
|
assert((!isa<Constant>((const Value*)this) ||
|
|
isa<GlobalValue>((const Value*)this)) &&
|
|
"Cannot mutate a constant with setOperand!");
|
|
getOperandList()[i] = Val;
|
|
}
|
|
const Use &getOperandUse(unsigned i) const {
|
|
assert(i < NumUserOperands && "getOperandUse() out of range!");
|
|
return getOperandList()[i];
|
|
}
|
|
Use &getOperandUse(unsigned i) {
|
|
assert(i < NumUserOperands && "getOperandUse() out of range!");
|
|
return getOperandList()[i];
|
|
}
|
|
|
|
unsigned getNumOperands() const { return NumUserOperands; }
|
|
|
|
/// Set the number of operands on a GlobalVariable.
|
|
///
|
|
/// GlobalVariable always allocates space for a single operands, but
|
|
/// doesn't always use it.
|
|
///
|
|
/// FIXME: As that the number of operands is used to find the start of
|
|
/// the allocated memory in operator delete, we need to always think we have
|
|
/// 1 operand before delete.
|
|
void setGlobalVariableNumOperands(unsigned NumOps) {
|
|
assert(NumOps <= 1 && "GlobalVariable can only have 0 or 1 operands");
|
|
NumUserOperands = NumOps;
|
|
}
|
|
|
|
/// Set the number of operands on a Function.
|
|
///
|
|
/// Function always allocates space for a single operands, but
|
|
/// doesn't always use it.
|
|
///
|
|
/// FIXME: As that the number of operands is used to find the start of
|
|
/// the allocated memory in operator delete, we need to always think we have
|
|
/// 1 operand before delete.
|
|
void setFunctionNumOperands(unsigned NumOps) {
|
|
assert(NumOps <= 1 && "Function can only have 0 or 1 operands");
|
|
NumUserOperands = NumOps;
|
|
}
|
|
|
|
/// \brief Subclasses with hung off uses need to manage the operand count
|
|
/// themselves. In these instances, the operand count isn't used to find the
|
|
/// OperandList, so there's no issue in having the operand count change.
|
|
void setNumHungOffUseOperands(unsigned NumOps) {
|
|
assert(HasHungOffUses && "Must have hung off uses to use this method");
|
|
assert(NumOps < (1u << NumUserOperandsBits) && "Too many operands");
|
|
NumUserOperands = NumOps;
|
|
}
|
|
|
|
// ---------------------------------------------------------------------------
|
|
// Operand Iterator interface...
|
|
//
|
|
typedef Use* op_iterator;
|
|
typedef const Use* const_op_iterator;
|
|
typedef iterator_range<op_iterator> op_range;
|
|
typedef iterator_range<const_op_iterator> const_op_range;
|
|
|
|
op_iterator op_begin() { return getOperandList(); }
|
|
const_op_iterator op_begin() const { return getOperandList(); }
|
|
op_iterator op_end() {
|
|
return getOperandList() + NumUserOperands;
|
|
}
|
|
const_op_iterator op_end() const {
|
|
return getOperandList() + NumUserOperands;
|
|
}
|
|
op_range operands() {
|
|
return op_range(op_begin(), op_end());
|
|
}
|
|
const_op_range operands() const {
|
|
return const_op_range(op_begin(), op_end());
|
|
}
|
|
|
|
/// \brief Iterator for directly iterating over the operand Values.
|
|
struct value_op_iterator
|
|
: iterator_adaptor_base<value_op_iterator, op_iterator,
|
|
std::random_access_iterator_tag, Value *,
|
|
ptrdiff_t, Value *, Value *> {
|
|
explicit value_op_iterator(Use *U = nullptr) : iterator_adaptor_base(U) {}
|
|
|
|
Value *operator*() const { return *I; }
|
|
Value *operator->() const { return operator*(); }
|
|
};
|
|
|
|
value_op_iterator value_op_begin() {
|
|
return value_op_iterator(op_begin());
|
|
}
|
|
value_op_iterator value_op_end() {
|
|
return value_op_iterator(op_end());
|
|
}
|
|
iterator_range<value_op_iterator> operand_values() {
|
|
return iterator_range<value_op_iterator>(value_op_begin(), value_op_end());
|
|
}
|
|
|
|
/// \brief Drop all references to operands.
|
|
///
|
|
/// This function is in charge of "letting go" of all objects that this User
|
|
/// refers to. This allows one to 'delete' a whole class at a time, even
|
|
/// though there may be circular references... First all references are
|
|
/// dropped, and all use counts go to zero. Then everything is deleted for
|
|
/// real. Note that no operations are valid on an object that has "dropped
|
|
/// all references", except operator delete.
|
|
void dropAllReferences() {
|
|
for (Use &U : operands())
|
|
U.set(nullptr);
|
|
}
|
|
|
|
/// \brief Replace uses of one Value with another.
|
|
///
|
|
/// Replaces all references to the "From" definition with references to the
|
|
/// "To" definition.
|
|
void replaceUsesOfWith(Value *From, Value *To);
|
|
|
|
// Methods for support type inquiry through isa, cast, and dyn_cast:
|
|
static inline bool classof(const Value *V) {
|
|
return isa<Instruction>(V) || isa<Constant>(V);
|
|
}
|
|
};
|
|
// Either Use objects, or a Use pointer can be prepended to User.
|
|
static_assert(AlignOf<Use>::Alignment >= AlignOf<User>::Alignment,
|
|
"Alignment is insufficient after objects prepended to User");
|
|
static_assert(AlignOf<Use *>::Alignment >= AlignOf<User>::Alignment,
|
|
"Alignment is insufficient after objects prepended to User");
|
|
|
|
template<> struct simplify_type<User::op_iterator> {
|
|
typedef Value* SimpleType;
|
|
static SimpleType getSimplifiedValue(User::op_iterator &Val) {
|
|
return Val->get();
|
|
}
|
|
};
|
|
template<> struct simplify_type<User::const_op_iterator> {
|
|
typedef /*const*/ Value* SimpleType;
|
|
static SimpleType getSimplifiedValue(User::const_op_iterator &Val) {
|
|
return Val->get();
|
|
}
|
|
};
|
|
|
|
} // End llvm namespace
|
|
|
|
#endif
|