debugger.h revision 855fcc3114c20ff9fd286fe1723d1413fec9685a 
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 __CUTILS_DEBUGGER_H
18#define __CUTILS_DEBUGGER_H
19
20#include <sys/types.h>
21
22#ifdef __cplusplus
23extern "C" {
24#endif
25
26#if __LP64__
27#define DEBUGGER_SOCKET_NAME "android:debuggerd64"
28#else
29#define DEBUGGER_SOCKET_NAME "android:debuggerd"
30#endif
31
32typedef enum {
33    // dump a crash
34    DEBUGGER_ACTION_CRASH,
35    // dump a tombstone file
36    DEBUGGER_ACTION_DUMP_TOMBSTONE,
37    // dump a backtrace only back to the socket
38    DEBUGGER_ACTION_DUMP_BACKTRACE,
39} debugger_action_t;
40
41typedef struct {
42    debugger_action_t action;
43    pid_t tid;
44    uintptr_t abort_msg_address;
45    int32_t original_si_code;
46} debugger_msg_t;
47
48/* Dumps a process backtrace, registers, and stack to a tombstone file (requires root).
49 * Stores the tombstone path in the provided buffer.
50 * Returns 0 on success, -1 on error.
51 */
52int dump_tombstone(pid_t tid, char* pathbuf, size_t pathlen);
53
54/* Dumps a process backtrace only to the specified file (requires root).
55 * Returns 0 on success, -1 on error.
56 */
57int dump_backtrace_to_file(pid_t tid, int fd);
58
59#ifdef __cplusplus
60}
61#endif
62
63#endif /* __CUTILS_DEBUGGER_H */
64