2011-01-16 16:10:57 +08:00
|
|
|
//===-- User.cpp - Implement the User class -------------------------------===//
|
|
|
|
//
|
2019-01-19 16:50:56 +08:00
|
|
|
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
|
|
|
|
// See https://llvm.org/LICENSE.txt for license information.
|
|
|
|
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
|
2011-01-16 16:10:57 +08:00
|
|
|
//
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
|
2013-01-02 19:36:10 +08:00
|
|
|
#include "llvm/IR/User.h"
|
|
|
|
#include "llvm/IR/Constant.h"
|
|
|
|
#include "llvm/IR/GlobalValue.h"
|
2011-01-16 16:10:57 +08:00
|
|
|
|
|
|
|
namespace llvm {
|
2015-06-11 06:38:30 +08:00
|
|
|
class BasicBlock;
|
2011-01-16 16:10:57 +08:00
|
|
|
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
// User Class
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
|
|
|
|
void User::replaceUsesOfWith(Value *From, Value *To) {
|
|
|
|
if (From == To) return; // Duh what?
|
|
|
|
|
|
|
|
assert((!isa<Constant>(this) || isa<GlobalValue>(this)) &&
|
|
|
|
"Cannot call User::replaceUsesOfWith on a constant!");
|
|
|
|
|
|
|
|
for (unsigned i = 0, E = getNumOperands(); i != E; ++i)
|
|
|
|
if (getOperand(i) == From) { // Is This operand is pointing to oldval?
|
|
|
|
// The side effects of this setOperand call include linking to
|
|
|
|
// "To", adding "this" to the uses list of To, and
|
|
|
|
// most importantly, removing "this" from the use list of "From".
|
|
|
|
setOperand(i, To); // Fix it now...
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
// User allocHungoffUses Implementation
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
|
2015-06-11 06:38:46 +08:00
|
|
|
void User::allocHungoffUses(unsigned N, bool IsPhi) {
|
2015-06-13 01:48:14 +08:00
|
|
|
assert(HasHungOffUses && "alloc must have hung off uses");
|
2015-06-17 09:21:20 +08:00
|
|
|
|
2016-10-20 23:02:18 +08:00
|
|
|
static_assert(alignof(Use) >= alignof(Use::UserRef),
|
2015-06-17 21:53:12 +08:00
|
|
|
"Alignment is insufficient for 'hung-off-uses' pieces");
|
2016-10-20 23:02:18 +08:00
|
|
|
static_assert(alignof(Use::UserRef) >= alignof(BasicBlock *),
|
2015-06-17 21:53:12 +08:00
|
|
|
"Alignment is insufficient for 'hung-off-uses' pieces");
|
2015-06-17 09:21:20 +08:00
|
|
|
|
2011-06-23 17:09:15 +08:00
|
|
|
// Allocate the array of Uses, followed by a pointer (with bottom bit set) to
|
|
|
|
// the User.
|
|
|
|
size_t size = N * sizeof(Use) + sizeof(Use::UserRef);
|
2015-06-11 06:38:30 +08:00
|
|
|
if (IsPhi)
|
|
|
|
size += N * sizeof(BasicBlock *);
|
2011-06-23 17:09:15 +08:00
|
|
|
Use *Begin = static_cast<Use*>(::operator new(size));
|
2011-01-16 16:10:57 +08:00
|
|
|
Use *End = Begin + N;
|
2011-06-20 22:12:33 +08:00
|
|
|
(void) new(End) Use::UserRef(const_cast<User*>(this), 1);
|
2015-06-13 01:48:05 +08:00
|
|
|
setOperandList(Use::initTags(Begin, End));
|
2011-01-16 16:10:57 +08:00
|
|
|
}
|
|
|
|
|
2015-06-11 06:38:41 +08:00
|
|
|
void User::growHungoffUses(unsigned NewNumUses, bool IsPhi) {
|
|
|
|
assert(HasHungOffUses && "realloc must have hung off uses");
|
|
|
|
|
|
|
|
unsigned OldNumUses = getNumOperands();
|
|
|
|
|
|
|
|
// We don't support shrinking the number of uses. We wouldn't have enough
|
|
|
|
// space to copy the old uses in to the new space.
|
|
|
|
assert(NewNumUses > OldNumUses && "realloc must grow num uses");
|
|
|
|
|
2015-06-13 01:48:05 +08:00
|
|
|
Use *OldOps = getOperandList();
|
2015-06-11 06:38:41 +08:00
|
|
|
allocHungoffUses(NewNumUses, IsPhi);
|
2015-06-13 01:48:05 +08:00
|
|
|
Use *NewOps = getOperandList();
|
2015-06-11 06:38:41 +08:00
|
|
|
|
|
|
|
// Now copy from the old operands list to the new one.
|
|
|
|
std::copy(OldOps, OldOps + OldNumUses, NewOps);
|
|
|
|
|
|
|
|
// If this is a Phi, then we need to copy the BB pointers too.
|
|
|
|
if (IsPhi) {
|
|
|
|
auto *OldPtr =
|
|
|
|
reinterpret_cast<char *>(OldOps + OldNumUses) + sizeof(Use::UserRef);
|
|
|
|
auto *NewPtr =
|
|
|
|
reinterpret_cast<char *>(NewOps + NewNumUses) + sizeof(Use::UserRef);
|
|
|
|
std::copy(OldPtr, OldPtr + (OldNumUses * sizeof(BasicBlock *)), NewPtr);
|
|
|
|
}
|
|
|
|
Use::zap(OldOps, OldOps + OldNumUses, true);
|
|
|
|
}
|
|
|
|
|
[IR] Teach `llvm::User` to co-allocate a descriptor.
Summary:
With this change, subclasses of `llvm::User` will be able to co-allocate
a variable number of bytes (called a "descriptor") with the `llvm::User`
instance. The co-allocated descriptor can later be accessed using
`llvm::User::getDescriptor`. This will be used in later changes to
implement operand bundles.
This change steals one bit from `NumUserOperands`, but given that it is
still 28 bits wide I don't think this will be a practical issue.
This change does not allow allocating hung off uses with descriptors.
This only for simplicity, not for any fundamental reason; and we can
easily add this functionality later if needed.
Reviewers: reames, chandlerc, dexonsmith, kmod, majnemer, pete, JosephTremoulet
Subscribers: pete, sanjoy, llvm-commits
Differential Revision: http://reviews.llvm.org/D12455
llvm-svn: 248453
2015-09-24 09:00:49 +08:00
|
|
|
|
|
|
|
// This is a private struct used by `User` to track the co-allocated descriptor
|
|
|
|
// section.
|
|
|
|
struct DescriptorInfo {
|
|
|
|
intptr_t SizeInBytes;
|
|
|
|
};
|
|
|
|
|
|
|
|
ArrayRef<const uint8_t> User::getDescriptor() const {
|
|
|
|
auto MutableARef = const_cast<User *>(this)->getDescriptor();
|
|
|
|
return {MutableARef.begin(), MutableARef.end()};
|
|
|
|
}
|
|
|
|
|
|
|
|
MutableArrayRef<uint8_t> User::getDescriptor() {
|
|
|
|
assert(HasDescriptor && "Don't call otherwise!");
|
|
|
|
assert(!HasHungOffUses && "Invariant!");
|
|
|
|
|
|
|
|
auto *DI = reinterpret_cast<DescriptorInfo *>(getIntrusiveOperands()) - 1;
|
|
|
|
assert(DI->SizeInBytes != 0 && "Should not have had a descriptor otherwise!");
|
|
|
|
|
|
|
|
return MutableArrayRef<uint8_t>(
|
|
|
|
reinterpret_cast<uint8_t *>(DI) - DI->SizeInBytes, DI->SizeInBytes);
|
|
|
|
}
|
|
|
|
|
2011-01-16 16:10:57 +08:00
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
// User operator new Implementations
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
|
[IR] Teach `llvm::User` to co-allocate a descriptor.
Summary:
With this change, subclasses of `llvm::User` will be able to co-allocate
a variable number of bytes (called a "descriptor") with the `llvm::User`
instance. The co-allocated descriptor can later be accessed using
`llvm::User::getDescriptor`. This will be used in later changes to
implement operand bundles.
This change steals one bit from `NumUserOperands`, but given that it is
still 28 bits wide I don't think this will be a practical issue.
This change does not allow allocating hung off uses with descriptors.
This only for simplicity, not for any fundamental reason; and we can
easily add this functionality later if needed.
Reviewers: reames, chandlerc, dexonsmith, kmod, majnemer, pete, JosephTremoulet
Subscribers: pete, sanjoy, llvm-commits
Differential Revision: http://reviews.llvm.org/D12455
llvm-svn: 248453
2015-09-24 09:00:49 +08:00
|
|
|
void *User::allocateFixedOperandUser(size_t Size, unsigned Us,
|
|
|
|
unsigned DescBytes) {
|
2015-06-13 01:48:10 +08:00
|
|
|
assert(Us < (1u << NumUserOperandsBits) && "Too many operands");
|
[IR] Teach `llvm::User` to co-allocate a descriptor.
Summary:
With this change, subclasses of `llvm::User` will be able to co-allocate
a variable number of bytes (called a "descriptor") with the `llvm::User`
instance. The co-allocated descriptor can later be accessed using
`llvm::User::getDescriptor`. This will be used in later changes to
implement operand bundles.
This change steals one bit from `NumUserOperands`, but given that it is
still 28 bits wide I don't think this will be a practical issue.
This change does not allow allocating hung off uses with descriptors.
This only for simplicity, not for any fundamental reason; and we can
easily add this functionality later if needed.
Reviewers: reames, chandlerc, dexonsmith, kmod, majnemer, pete, JosephTremoulet
Subscribers: pete, sanjoy, llvm-commits
Differential Revision: http://reviews.llvm.org/D12455
llvm-svn: 248453
2015-09-24 09:00:49 +08:00
|
|
|
|
|
|
|
static_assert(sizeof(DescriptorInfo) % sizeof(void *) == 0, "Required below");
|
|
|
|
|
|
|
|
unsigned DescBytesToAllocate =
|
|
|
|
DescBytes == 0 ? 0 : (DescBytes + sizeof(DescriptorInfo));
|
|
|
|
assert(DescBytesToAllocate % sizeof(void *) == 0 &&
|
|
|
|
"We need this to satisfy alignment constraints for Uses");
|
|
|
|
|
|
|
|
uint8_t *Storage = static_cast<uint8_t *>(
|
|
|
|
::operator new(Size + sizeof(Use) * Us + DescBytesToAllocate));
|
|
|
|
Use *Start = reinterpret_cast<Use *>(Storage + DescBytesToAllocate);
|
2011-01-16 16:10:57 +08:00
|
|
|
Use *End = Start + Us;
|
|
|
|
User *Obj = reinterpret_cast<User*>(End);
|
2015-06-13 01:48:10 +08:00
|
|
|
Obj->NumUserOperands = Us;
|
2015-06-13 01:48:18 +08:00
|
|
|
Obj->HasHungOffUses = false;
|
[IR] Teach `llvm::User` to co-allocate a descriptor.
Summary:
With this change, subclasses of `llvm::User` will be able to co-allocate
a variable number of bytes (called a "descriptor") with the `llvm::User`
instance. The co-allocated descriptor can later be accessed using
`llvm::User::getDescriptor`. This will be used in later changes to
implement operand bundles.
This change steals one bit from `NumUserOperands`, but given that it is
still 28 bits wide I don't think this will be a practical issue.
This change does not allow allocating hung off uses with descriptors.
This only for simplicity, not for any fundamental reason; and we can
easily add this functionality later if needed.
Reviewers: reames, chandlerc, dexonsmith, kmod, majnemer, pete, JosephTremoulet
Subscribers: pete, sanjoy, llvm-commits
Differential Revision: http://reviews.llvm.org/D12455
llvm-svn: 248453
2015-09-24 09:00:49 +08:00
|
|
|
Obj->HasDescriptor = DescBytes != 0;
|
2011-01-16 16:10:57 +08:00
|
|
|
Use::initTags(Start, End);
|
[IR] Teach `llvm::User` to co-allocate a descriptor.
Summary:
With this change, subclasses of `llvm::User` will be able to co-allocate
a variable number of bytes (called a "descriptor") with the `llvm::User`
instance. The co-allocated descriptor can later be accessed using
`llvm::User::getDescriptor`. This will be used in later changes to
implement operand bundles.
This change steals one bit from `NumUserOperands`, but given that it is
still 28 bits wide I don't think this will be a practical issue.
This change does not allow allocating hung off uses with descriptors.
This only for simplicity, not for any fundamental reason; and we can
easily add this functionality later if needed.
Reviewers: reames, chandlerc, dexonsmith, kmod, majnemer, pete, JosephTremoulet
Subscribers: pete, sanjoy, llvm-commits
Differential Revision: http://reviews.llvm.org/D12455
llvm-svn: 248453
2015-09-24 09:00:49 +08:00
|
|
|
|
|
|
|
if (DescBytes != 0) {
|
|
|
|
auto *DescInfo = reinterpret_cast<DescriptorInfo *>(Storage + DescBytes);
|
|
|
|
DescInfo->SizeInBytes = DescBytes;
|
|
|
|
}
|
|
|
|
|
2011-01-16 16:10:57 +08:00
|
|
|
return Obj;
|
|
|
|
}
|
|
|
|
|
[IR] Teach `llvm::User` to co-allocate a descriptor.
Summary:
With this change, subclasses of `llvm::User` will be able to co-allocate
a variable number of bytes (called a "descriptor") with the `llvm::User`
instance. The co-allocated descriptor can later be accessed using
`llvm::User::getDescriptor`. This will be used in later changes to
implement operand bundles.
This change steals one bit from `NumUserOperands`, but given that it is
still 28 bits wide I don't think this will be a practical issue.
This change does not allow allocating hung off uses with descriptors.
This only for simplicity, not for any fundamental reason; and we can
easily add this functionality later if needed.
Reviewers: reames, chandlerc, dexonsmith, kmod, majnemer, pete, JosephTremoulet
Subscribers: pete, sanjoy, llvm-commits
Differential Revision: http://reviews.llvm.org/D12455
llvm-svn: 248453
2015-09-24 09:00:49 +08:00
|
|
|
void *User::operator new(size_t Size, unsigned Us) {
|
|
|
|
return allocateFixedOperandUser(Size, Us, 0);
|
|
|
|
}
|
|
|
|
|
|
|
|
void *User::operator new(size_t Size, unsigned Us, unsigned DescBytes) {
|
|
|
|
return allocateFixedOperandUser(Size, Us, DescBytes);
|
|
|
|
}
|
|
|
|
|
2015-06-13 01:48:14 +08:00
|
|
|
void *User::operator new(size_t Size) {
|
2015-06-13 01:48:18 +08:00
|
|
|
// Allocate space for a single Use*
|
|
|
|
void *Storage = ::operator new(Size + sizeof(Use *));
|
|
|
|
Use **HungOffOperandList = static_cast<Use **>(Storage);
|
|
|
|
User *Obj = reinterpret_cast<User *>(HungOffOperandList + 1);
|
2015-06-13 01:48:14 +08:00
|
|
|
Obj->NumUserOperands = 0;
|
2015-06-13 01:48:18 +08:00
|
|
|
Obj->HasHungOffUses = true;
|
[IR] Teach `llvm::User` to co-allocate a descriptor.
Summary:
With this change, subclasses of `llvm::User` will be able to co-allocate
a variable number of bytes (called a "descriptor") with the `llvm::User`
instance. The co-allocated descriptor can later be accessed using
`llvm::User::getDescriptor`. This will be used in later changes to
implement operand bundles.
This change steals one bit from `NumUserOperands`, but given that it is
still 28 bits wide I don't think this will be a practical issue.
This change does not allow allocating hung off uses with descriptors.
This only for simplicity, not for any fundamental reason; and we can
easily add this functionality later if needed.
Reviewers: reames, chandlerc, dexonsmith, kmod, majnemer, pete, JosephTremoulet
Subscribers: pete, sanjoy, llvm-commits
Differential Revision: http://reviews.llvm.org/D12455
llvm-svn: 248453
2015-09-24 09:00:49 +08:00
|
|
|
Obj->HasDescriptor = false;
|
2015-06-13 01:48:18 +08:00
|
|
|
*HungOffOperandList = nullptr;
|
2015-06-13 01:48:14 +08:00
|
|
|
return Obj;
|
|
|
|
}
|
|
|
|
|
2011-01-16 16:10:57 +08:00
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
// User operator delete Implementation
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
|
2019-11-23 02:58:26 +08:00
|
|
|
// Repress memory sanitization, due to use-after-destroy by operator
|
|
|
|
// delete. Bug report 24578 identifies this issue.
|
|
|
|
LLVM_NO_SANITIZE_MEMORY_ATTRIBUTE void User::operator delete(void *Usr) {
|
2015-06-13 01:48:18 +08:00
|
|
|
// Hung off uses use a single Use* before the User, while other subclasses
|
|
|
|
// use a Use[] allocated prior to the user.
|
|
|
|
User *Obj = static_cast<User *>(Usr);
|
|
|
|
if (Obj->HasHungOffUses) {
|
[IR] Teach `llvm::User` to co-allocate a descriptor.
Summary:
With this change, subclasses of `llvm::User` will be able to co-allocate
a variable number of bytes (called a "descriptor") with the `llvm::User`
instance. The co-allocated descriptor can later be accessed using
`llvm::User::getDescriptor`. This will be used in later changes to
implement operand bundles.
This change steals one bit from `NumUserOperands`, but given that it is
still 28 bits wide I don't think this will be a practical issue.
This change does not allow allocating hung off uses with descriptors.
This only for simplicity, not for any fundamental reason; and we can
easily add this functionality later if needed.
Reviewers: reames, chandlerc, dexonsmith, kmod, majnemer, pete, JosephTremoulet
Subscribers: pete, sanjoy, llvm-commits
Differential Revision: http://reviews.llvm.org/D12455
llvm-svn: 248453
2015-09-24 09:00:49 +08:00
|
|
|
assert(!Obj->HasDescriptor && "not supported!");
|
|
|
|
|
2015-06-13 01:48:18 +08:00
|
|
|
Use **HungOffOperandList = static_cast<Use **>(Usr) - 1;
|
|
|
|
// drop the hung off uses.
|
|
|
|
Use::zap(*HungOffOperandList, *HungOffOperandList + Obj->NumUserOperands,
|
|
|
|
/* Delete */ true);
|
|
|
|
::operator delete(HungOffOperandList);
|
[IR] Teach `llvm::User` to co-allocate a descriptor.
Summary:
With this change, subclasses of `llvm::User` will be able to co-allocate
a variable number of bytes (called a "descriptor") with the `llvm::User`
instance. The co-allocated descriptor can later be accessed using
`llvm::User::getDescriptor`. This will be used in later changes to
implement operand bundles.
This change steals one bit from `NumUserOperands`, but given that it is
still 28 bits wide I don't think this will be a practical issue.
This change does not allow allocating hung off uses with descriptors.
This only for simplicity, not for any fundamental reason; and we can
easily add this functionality later if needed.
Reviewers: reames, chandlerc, dexonsmith, kmod, majnemer, pete, JosephTremoulet
Subscribers: pete, sanjoy, llvm-commits
Differential Revision: http://reviews.llvm.org/D12455
llvm-svn: 248453
2015-09-24 09:00:49 +08:00
|
|
|
} else if (Obj->HasDescriptor) {
|
|
|
|
Use *UseBegin = static_cast<Use *>(Usr) - Obj->NumUserOperands;
|
|
|
|
Use::zap(UseBegin, UseBegin + Obj->NumUserOperands, /* Delete */ false);
|
|
|
|
|
|
|
|
auto *DI = reinterpret_cast<DescriptorInfo *>(UseBegin) - 1;
|
|
|
|
uint8_t *Storage = reinterpret_cast<uint8_t *>(DI) - DI->SizeInBytes;
|
|
|
|
::operator delete(Storage);
|
2015-06-13 01:48:18 +08:00
|
|
|
} else {
|
|
|
|
Use *Storage = static_cast<Use *>(Usr) - Obj->NumUserOperands;
|
|
|
|
Use::zap(Storage, Storage + Obj->NumUserOperands,
|
|
|
|
/* Delete */ false);
|
|
|
|
::operator delete(Storage);
|
|
|
|
}
|
2011-01-16 16:10:57 +08:00
|
|
|
}
|
|
|
|
|
2015-06-23 17:49:53 +08:00
|
|
|
} // End llvm namespace
|