platform_bionic/libc/malloc_debug/BacktraceData.h
Christopher Ferris 602b88ccdd Provide method to dump backtrace heap data.
For non-zygote spawned processes, we might want to dump the backtrace
data. Provide a method to send a signal to a process and then dump the
data to a file.

Adds a method to dump the backtrace data on exit.

Update documentation and explain format of heap dump data.

Test: Ran unit tests, enabled new options and used them.
Change-Id: Ie2fa706694160731afe02c1382b037d06df1d069
2017-09-05 15:57:00 -07:00

71 lines
2.3 KiB
C++

/*
* Copyright (C) 2015 The Android Open Source Project
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
* OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
* AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*/
#ifndef DEBUG_MALLOC_BACKTRACEDATA_H
#define DEBUG_MALLOC_BACKTRACEDATA_H
#include <stdint.h>
#include <atomic>
#include <private/bionic_macros.h>
#include "OptionData.h"
// Forward declarations.
class Config;
class BacktraceData : public OptionData {
public:
BacktraceData(DebugData* debug_data, const Config& config, size_t* offset);
virtual ~BacktraceData() = default;
bool Initialize(const Config& config);
inline size_t alloc_offset() { return alloc_offset_; }
bool ShouldBacktrace() { return enabled_ == 1; }
void ToggleBacktraceEnabled() { enabled_.fetch_xor(1); }
void EnableDumping() { dump_ = true; }
bool ShouldDumpAndReset() {
bool expected = true;
return dump_.compare_exchange_strong(expected, false);
}
private:
size_t alloc_offset_ = 0;
std::atomic_uint8_t enabled_;
std::atomic_bool dump_;
DISALLOW_COPY_AND_ASSIGN(BacktraceData);
};
#endif // DEBUG_MALLOC_BACKTRACEDATA_H