1 /* 2 * Copyright (C) 2012 The Android Open Source Project 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 17 #ifndef _DEBUGGERD_TOMBSTONE_H 18 #define _DEBUGGERD_TOMBSTONE_H 19 20 #include <stdbool.h> 21 #include <stddef.h> 22 #include <sys/types.h> 23 24 #include <functional> 25 #include <map> 26 #include <string> 27 28 #include <android-base/unique_fd.h> 29 30 #include "open_files_list.h" 31 #include "types.h" 32 33 // Forward declarations 34 class BacktraceFrame; 35 class Cause; 36 class Tombstone; 37 38 namespace unwindstack { 39 struct FrameData; 40 class AndroidUnwinder; 41 } 42 43 // The maximum number of frames to save when unwinding. 44 constexpr size_t kMaxFrames = 256; 45 46 /* Create and open a tombstone file for writing. 47 * Returns a writable file descriptor, or -1 with errno set appropriately. 48 * If out_path is non-null, *out_path is set to the path of the tombstone file. 49 */ 50 int open_tombstone(std::string* path); 51 52 /* Creates a tombstone file and writes the crash dump to it. */ 53 void engrave_tombstone(android::base::unique_fd output_fd, android::base::unique_fd proto_fd, 54 unwindstack::AndroidUnwinder* unwinder, 55 const std::map<pid_t, ThreadInfo>& thread_info, pid_t target_thread, 56 const ProcessInfo& process_info, OpenFilesList* open_files, 57 std::string* amfd_data); 58 59 void engrave_tombstone_ucontext(int tombstone_fd, int proto_fd, uint64_t abort_msg_address, 60 siginfo_t* siginfo, ucontext_t* ucontext); 61 62 void engrave_tombstone_proto(Tombstone* tombstone, unwindstack::AndroidUnwinder* unwinder, 63 const std::map<pid_t, ThreadInfo>& threads, pid_t target_thread, 64 const ProcessInfo& process_info, const OpenFilesList* open_files); 65 66 bool tombstone_proto_to_text( 67 const Tombstone& tombstone, 68 std::function<void(const std::string& line, bool should_log)> callback); 69 70 void fill_in_backtrace_frame(BacktraceFrame* f, const unwindstack::FrameData& frame); 71 void set_human_readable_cause(Cause* cause, uint64_t fault_addr); 72 73 #endif // _DEBUGGERD_TOMBSTONE_H 74