android_system_core/libutils/CallStack.cpp
Hans Boehm 9d3146af22 Prepare to fail in RefBase destructor if count is untouched
Move towards crashing if a normally configured RefBase object is
destroyed without ever incrementing the reference count. We've been
threatening to do this for a long time. The previously last known
violation had been fixed.

This also fixes stack trace printing from RefBase, which had previously
been broken, and which we found necessary to track down further
violations of this rule.

Unfortunately, we found several more violations with the aid of
that fix. After existing CLs are submitted, there are
still some failures, but they are no longer numerous. Thus this CL
doesn't actually crash in the event of a violation, but does log a
verbose stack trace if it encounters one.

Bugs have been filed against the remaining known RefBase client offenders.
We plan to enable crashing on usage violations once those are fixed.

The fix for the stack trace printing breakage unfortunately requires
the use of weak symbols in order to avoid a circular build dependency.
We expect to eventually replace this with execinfo.h functionality.

Some random reformatting, driven by consistency with current formatting
requirements.

Add missing include to BacktraceMap.h.

Bug: 79112958
Bug: 30292291
Test: Boot AOSP, Master
Change-Id: I8151c54560c3b6f75ffc4c48229f0388a2066958
2018-08-03 17:56:47 -07:00

100 lines
2.8 KiB
C++

/*
* Copyright (C) 2007 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.
*/
#define LOG_TAG "CallStack"
#include <utils/Printer.h>
#include <utils/Errors.h>
#include <utils/Log.h>
#include <backtrace/Backtrace.h>
#define CALLSTACK_WEAK // Don't generate weak definitions.
#include <utils/CallStack.h>
namespace android {
CallStack::CallStack() {
}
CallStack::CallStack(const char* logtag, int32_t ignoreDepth) {
this->update(ignoreDepth+1);
this->log(logtag);
}
CallStack::~CallStack() {
}
void CallStack::update(int32_t ignoreDepth, pid_t tid) {
mFrameLines.clear();
std::unique_ptr<Backtrace> backtrace(Backtrace::Create(BACKTRACE_CURRENT_PROCESS, tid));
if (!backtrace->Unwind(ignoreDepth)) {
ALOGW("%s: Failed to unwind callstack.", __FUNCTION__);
}
for (size_t i = 0; i < backtrace->NumFrames(); i++) {
mFrameLines.push_back(String8(backtrace->FormatFrameData(i).c_str()));
}
}
void CallStack::log(const char* logtag, android_LogPriority priority, const char* prefix) const {
LogPrinter printer(logtag, priority, prefix, /*ignoreBlankLines*/false);
print(printer);
}
void CallStack::dump(int fd, int indent, const char* prefix) const {
FdPrinter printer(fd, indent, prefix);
print(printer);
}
String8 CallStack::toString(const char* prefix) const {
String8 str;
String8Printer printer(&str, prefix);
print(printer);
return str;
}
void CallStack::print(Printer& printer) const {
for (size_t i = 0; i < mFrameLines.size(); i++) {
printer.printLine(mFrameLines[i]);
}
}
// The following four functions may be used via weak symbol references from libutils.
// Clients assume that if any of these symbols are available, then deleteStack() is.
CallStack::CallStackUPtr CallStack::getCurrentInternal(int ignoreDepth) {
CallStack::CallStackUPtr stack(new CallStack());
stack->update(ignoreDepth + 1);
return stack;
}
void CallStack::logStackInternal(const char* logtag, const CallStack* stack,
android_LogPriority priority) {
stack->log(logtag, priority);
}
String8 CallStack::stackToStringInternal(const char* prefix, const CallStack* stack) {
return stack->toString(prefix);
}
void CallStack::deleteStack(CallStack* stack) {
delete stack;
}
}; // namespace android