blob: 8273ea4df81b056400bdec819bb27c8aa2227fd7 [file] [log] [blame]
/*
* Copyright (C) 2015 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#ifndef ART_RUNTIME_GC_ALLOCATION_RECORD_H_
#define ART_RUNTIME_GC_ALLOCATION_RECORD_H_
#include <list>
#include <memory>
#include "base/macros.h"
#include "base/mutex.h"
#include "gc_root.h"
#include "obj_ptr.h"
namespace art HIDDEN {
class ArtMethod;
class IsMarkedVisitor;
class Thread;
namespace mirror {
class Class;
class Object;
} // namespace mirror
namespace gc {
class AllocRecordStackTraceElement {
public:
int32_t ComputeLineNumber() const REQUIRES_SHARED(Locks::mutator_lock_);
AllocRecordStackTraceElement() = default;
AllocRecordStackTraceElement(ArtMethod* method, uint32_t dex_pc)
: method_(method),
dex_pc_(dex_pc) {}
ArtMethod* GetMethod() const {
return method_;
}
void SetMethod(ArtMethod* m) {
method_ = m;
}
uint32_t GetDexPc() const {
return dex_pc_;
}
void SetDexPc(uint32_t pc) {
dex_pc_ = pc;
}
bool operator==(const AllocRecordStackTraceElement& other) const {
return method_ == other.method_ && dex_pc_ == other.dex_pc_;
}
private:
ArtMethod* method_ = nullptr;
uint32_t dex_pc_ = 0;
};
class AllocRecordStackTrace {
public:
static constexpr size_t kHashMultiplier = 17;
AllocRecordStackTrace() = default;
AllocRecordStackTrace(AllocRecordStackTrace&& r) noexcept
: tid_(r.tid_),
stack_(std::move(r.stack_)) {}
AllocRecordStackTrace(const AllocRecordStackTrace& r)
: tid_(r.tid_),
stack_(r.stack_) {}
pid_t GetTid() const {
return tid_;
}
void SetTid(pid_t t) {
tid_ = t;
}
size_t GetDepth() const {
return stack_.size();
}
const AllocRecordStackTraceElement& GetStackElement(size_t index) const {
DCHECK_LT(index, GetDepth());
return stack_[index];
}
void AddStackElement(const AllocRecordStackTraceElement& element) {
stack_.push_back(element);
}
void SetStackElementAt(size_t index, ArtMethod* m, uint32_t dex_pc) {
DCHECK_LT(index, stack_.size());
stack_[index].SetMethod(m);
stack_[index].SetDexPc(dex_pc);
}
bool operator==(const AllocRecordStackTrace& other) const {
if (this == &other) return true;
return tid_ == other.tid_ && stack_ == other.stack_;
}
private:
pid_t tid_ = 0;
std::vector<AllocRecordStackTraceElement> stack_;
};
struct HashAllocRecordTypes {
size_t operator()(const AllocRecordStackTraceElement& r) const {
return std::hash<void*>()(reinterpret_cast<void*>(r.GetMethod())) *
AllocRecordStackTrace::kHashMultiplier + std::hash<uint32_t>()(r.GetDexPc());
}
size_t operator()(const AllocRecordStackTrace& r) const {
size_t depth = r.GetDepth();
size_t result = r.GetTid() * AllocRecordStackTrace::kHashMultiplier + depth;
for (size_t i = 0; i < depth; ++i) {
result = result * AllocRecordStackTrace::kHashMultiplier + (*this)(r.GetStackElement(i));
}
return result;
}
};
template <typename T> struct HashAllocRecordTypesPtr {
size_t operator()(const T* r) const {
if (r == nullptr) return 0;
return HashAllocRecordTypes()(*r);
}
};
template <typename T> struct EqAllocRecordTypesPtr {
bool operator()(const T* r1, const T* r2) const {
if (r1 == r2) return true;
if (r1 == nullptr || r2 == nullptr) return false;
return *r1 == *r2;
}
};
class AllocRecord {
public:
// All instances of AllocRecord should be managed by an instance of AllocRecordObjectMap.
AllocRecord(size_t count, mirror::Class* klass, AllocRecordStackTrace&& trace)
: byte_count_(count), klass_(klass), trace_(std::move(trace)) {}
size_t GetDepth() const {
return trace_.GetDepth();
}
const AllocRecordStackTrace* GetStackTrace() const {
return &trace_;
}
size_t ByteCount() const {
return byte_count_;
}
pid_t GetTid() const {
return trace_.GetTid();
}
mirror::Class* GetClass() const REQUIRES_SHARED(Locks::mutator_lock_) {
return klass_.Read();
}
const char* GetClassDescriptor(std::string* storage) const
REQUIRES_SHARED(Locks::mutator_lock_);
GcRoot<mirror::Class>& GetClassGcRoot() REQUIRES_SHARED(Locks::mutator_lock_) {
return klass_;
}
const AllocRecordStackTraceElement& StackElement(size_t index) const {
return trace_.GetStackElement(index);
}
private:
const size_t byte_count_;
// The klass_ could be a strong or weak root for GC
GcRoot<mirror::Class> klass_;
// TODO: Share between alloc records with identical stack traces.
AllocRecordStackTrace trace_;
};
class AllocRecordObjectMap {
public:
static constexpr size_t kDefaultNumAllocRecords = 512 * 1024;
static constexpr size_t kDefaultNumRecentRecords = 64 * 1024 - 1;
static constexpr size_t kDefaultAllocStackDepth = 16;
static constexpr size_t kMaxSupportedStackDepth = 128;
// GcRoot<mirror::Object> pointers in the list are weak roots, and the last recent_record_max_
// number of AllocRecord::klass_ pointers are strong roots (and the rest of klass_ pointers are
// weak roots). The last recent_record_max_ number of pairs in the list are always kept for DDMS's
// recent allocation tracking, but GcRoot<mirror::Object> pointers in these pairs can become null.
// Both types of pointers need read barriers, do not directly access them.
using EntryPair = std::pair<GcRoot<mirror::Object>, AllocRecord>;
using EntryList = std::list<EntryPair>;
// Caller needs to check that it is enabled before calling since we read the stack trace before
// checking the enabled boolean.
EXPORT void RecordAllocation(Thread* self, ObjPtr<mirror::Object>* obj, size_t byte_count)
REQUIRES(!Locks::alloc_tracker_lock_) REQUIRES_SHARED(Locks::mutator_lock_);
static void SetAllocTrackingEnabled(bool enabled) REQUIRES(!Locks::alloc_tracker_lock_);
AllocRecordObjectMap() REQUIRES(Locks::alloc_tracker_lock_);
~AllocRecordObjectMap();
void Put(mirror::Object* obj, AllocRecord&& record)
REQUIRES_SHARED(Locks::mutator_lock_)
REQUIRES(Locks::alloc_tracker_lock_) {
if (entries_.size() == alloc_record_max_) {
entries_.pop_front();
}
entries_.push_back(EntryPair(GcRoot<mirror::Object>(obj), std::move(record)));
}
size_t Size() const REQUIRES_SHARED(Locks::alloc_tracker_lock_) {
return entries_.size();
}
size_t GetRecentAllocationSize() const REQUIRES_SHARED(Locks::alloc_tracker_lock_) {
CHECK_LE(recent_record_max_, alloc_record_max_);
size_t sz = entries_.size();
return std::min(recent_record_max_, sz);
}
void VisitRoots(RootVisitor* visitor)
REQUIRES_SHARED(Locks::mutator_lock_)
REQUIRES(Locks::alloc_tracker_lock_);
void SweepAllocationRecords(IsMarkedVisitor* visitor)
REQUIRES_SHARED(Locks::mutator_lock_)
REQUIRES(Locks::alloc_tracker_lock_);
// Allocation tracking could be enabled by user in between DisallowNewAllocationRecords() and
// AllowNewAllocationRecords(), in which case new allocation records can be added although they
// should be disallowed. However, this is GC-safe because new objects are not processed in this GC
// cycle. The only downside of not handling this case is that such new allocation records can be
// swept from the list. But missing the first few records is acceptable for using the button to
// enable allocation tracking.
void DisallowNewAllocationRecords()
REQUIRES_SHARED(Locks::mutator_lock_)
REQUIRES(Locks::alloc_tracker_lock_);
void AllowNewAllocationRecords()
REQUIRES_SHARED(Locks::mutator_lock_)
REQUIRES(Locks::alloc_tracker_lock_);
void BroadcastForNewAllocationRecords()
REQUIRES(Locks::alloc_tracker_lock_);
// TODO: Is there a better way to hide the entries_'s type?
EntryList::iterator Begin()
REQUIRES_SHARED(Locks::mutator_lock_)
REQUIRES(Locks::alloc_tracker_lock_) {
return entries_.begin();
}
EntryList::iterator End()
REQUIRES_SHARED(Locks::mutator_lock_)
REQUIRES(Locks::alloc_tracker_lock_) {
return entries_.end();
}
EntryList::reverse_iterator RBegin()
REQUIRES_SHARED(Locks::mutator_lock_)
REQUIRES(Locks::alloc_tracker_lock_) {
return entries_.rbegin();
}
EntryList::reverse_iterator REnd()
REQUIRES_SHARED(Locks::mutator_lock_)
REQUIRES(Locks::alloc_tracker_lock_) {
return entries_.rend();
}
void Clear() REQUIRES(Locks::alloc_tracker_lock_);
private:
size_t alloc_record_max_ GUARDED_BY(Locks::alloc_tracker_lock_) = kDefaultNumAllocRecords;
size_t recent_record_max_ GUARDED_BY(Locks::alloc_tracker_lock_) = kDefaultNumRecentRecords;
size_t max_stack_depth_ = kDefaultAllocStackDepth;
bool allow_new_record_ GUARDED_BY(Locks::alloc_tracker_lock_) = true;
ConditionVariable new_record_condition_ GUARDED_BY(Locks::alloc_tracker_lock_);
// see the comment in typedef of EntryList
EntryList entries_ GUARDED_BY(Locks::alloc_tracker_lock_);
void SetMaxStackDepth(size_t max_stack_depth) REQUIRES(Locks::alloc_tracker_lock_);
};
} // namespace gc
} // namespace art
#endif // ART_RUNTIME_GC_ALLOCATION_RECORD_H_