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 "tombstone.pb.h"
32 #include "types.h"
33 
34 // Forward declarations
35 class BacktraceFrame;
36 class Cause;
37 class Tombstone;
38 
39 namespace unwindstack {
40 struct FrameData;
41 class AndroidUnwinder;
42 }
43 
44 // The maximum number of frames to save when unwinding.
45 constexpr size_t kMaxFrames = 256;
46 
47 /* Create and open a tombstone file for writing.
48  * Returns a writable file descriptor, or -1 with errno set appropriately.
49  * If out_path is non-null, *out_path is set to the path of the tombstone file.
50  */
51 int open_tombstone(std::string* path);
52 
53 /* Creates a tombstone file and writes the crash dump to it. */
54 void engrave_tombstone(android::base::unique_fd output_fd, android::base::unique_fd proto_fd,
55                        unwindstack::AndroidUnwinder* unwinder,
56                        const std::map<pid_t, ThreadInfo>& thread_info, pid_t target_thread,
57                        const ProcessInfo& process_info, OpenFilesList* open_files,
58                        std::string* amfd_data, const Architecture* guest_arch = nullptr,
59                        unwindstack::AndroidUnwinder* guest_unwinder = nullptr);
60 
61 void engrave_tombstone_ucontext(int tombstone_fd, int proto_fd, uint64_t abort_msg_address,
62                                 siginfo_t* siginfo, ucontext_t* ucontext);
63 
64 void engrave_tombstone_proto(Tombstone* tombstone, unwindstack::AndroidUnwinder* unwinder,
65                              const std::map<pid_t, ThreadInfo>& threads, pid_t target_thread,
66                              const ProcessInfo& process_info, const OpenFilesList* open_files,
67                              const Architecture* guest_arch,
68                              unwindstack::AndroidUnwinder* guest_unwinder);
69 
70 bool tombstone_proto_to_text(
71     const Tombstone& tombstone,
72     std::function<void(const std::string& line, bool should_log)> callback);
73 
74 void fill_in_backtrace_frame(BacktraceFrame* f, const unwindstack::FrameData& frame);
75 void set_human_readable_cause(Cause* cause, uint64_t fault_addr);
76 
77 #endif  // _DEBUGGERD_TOMBSTONE_H
78