blob: 2b9a32fdacb85686756fcf69ff31c1991acacb1a [file] [log] [blame]
/*
* Copyright (C) 2020 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.
*/
#pragma once
#include <stddef.h>
#include <stdint.h>
/*
* Implement fast stack unwinding for stack frames with frame pointers. Stores at most num_entries
* return addresses to buffer buf. Returns the number of available return addresses, which may be
* greater than num_entries.
*
* This function makes no guarantees about its behavior on encountering a frame built without frame
* pointers, except that it should not crash or enter an infinite loop, and that any frames prior to
* the frame built without frame pointers should be correct.
*
* This function is only meant to be used with memory safety tools such as sanitizers which need to
* take stack traces efficiently. Normal applications should use APIs such as libunwindstack or
* _Unwind_Backtrace.
*/
extern "C" size_t android_unsafe_frame_pointer_chase(uintptr_t* buf, size_t num_entries);