Home | History | Annotate | Download | only in cutils
      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
     23 extern "C" {
     24 #endif
     25 
     26 #define DEBUGGER32_SOCKET_NAME "android:debuggerd"
     27 #define DEBUGGER64_SOCKET_NAME "android:debuggerd64"
     28 
     29 #if defined(__LP64__)
     30 #define DEBUGGER_SOCKET_NAME DEBUGGER64_SOCKET_NAME
     31 #else
     32 #define DEBUGGER_SOCKET_NAME DEBUGGER32_SOCKET_NAME
     33 #endif
     34 
     35 typedef enum {
     36     // dump a crash
     37     DEBUGGER_ACTION_CRASH,
     38     // dump a tombstone file
     39     DEBUGGER_ACTION_DUMP_TOMBSTONE,
     40     // dump a backtrace only back to the socket
     41     DEBUGGER_ACTION_DUMP_BACKTRACE,
     42 } debugger_action_t;
     43 
     44 typedef struct {
     45     debugger_action_t action;
     46     pid_t tid;
     47     uintptr_t abort_msg_address;
     48     int32_t original_si_code;
     49 } debugger_msg_t;
     50 
     51 #if defined(__LP64__)
     52 // For a 64 bit process to contact the 32 bit debuggerd.
     53 typedef struct {
     54     debugger_action_t action;
     55     pid_t tid;
     56     uint32_t abort_msg_address;
     57     int32_t original_si_code;
     58 } debugger32_msg_t;
     59 #endif
     60 
     61 /* Dumps a process backtrace, registers, and stack to a tombstone file (requires root).
     62  * Stores the tombstone path in the provided buffer.
     63  * Returns 0 on success, -1 on error.
     64  */
     65 int dump_tombstone(pid_t tid, char* pathbuf, size_t pathlen);
     66 
     67 /* Dumps a process backtrace only to the specified file (requires root).
     68  * Returns 0 on success, -1 on error.
     69  */
     70 int dump_backtrace_to_file(pid_t tid, int fd);
     71 
     72 #ifdef __cplusplus
     73 }
     74 #endif
     75 
     76 #endif /* __CUTILS_DEBUGGER_H */
     77