Colin Cross | f45fa6b | 2012-03-26 12:38:26 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2008 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 _DUMPSTATE_H_ |
| 18 | #define _DUMPSTATE_H_ |
| 19 | |
Felipe Leme | 93d705b | 2015-11-10 20:10:25 -0800 | [diff] [blame] | 20 | /* When defined, skips the real dumps and just print the section headers. |
| 21 | Useful when debugging dumpstate itself. */ |
| 22 | //#define _DUMPSTATE_DRY_RUN_ |
| 23 | |
| 24 | #ifdef _DUMPSTATE_DRY_RUN_ |
| 25 | #define ON_DRY_RUN_RETURN(X) return X |
Christopher Ferris | ed24d2a | 2015-11-12 14:01:56 -0800 | [diff] [blame] | 26 | #define ON_DRY_RUN(code) code |
| 27 | #else |
Felipe Leme | 93d705b | 2015-11-10 20:10:25 -0800 | [diff] [blame] | 28 | #define ON_DRY_RUN_RETURN(X) |
Christopher Ferris | ed24d2a | 2015-11-12 14:01:56 -0800 | [diff] [blame] | 29 | #define ON_DRY_RUN(code) |
Felipe Leme | 93d705b | 2015-11-10 20:10:25 -0800 | [diff] [blame] | 30 | #endif |
| 31 | |
| 32 | |
Colin Cross | f45fa6b | 2012-03-26 12:38:26 -0700 | [diff] [blame] | 33 | #include <time.h> |
| 34 | #include <unistd.h> |
Colin Cross | 0c22e8b | 2012-11-02 15:46:56 -0700 | [diff] [blame] | 35 | #include <stdbool.h> |
Colin Cross | f45fa6b | 2012-03-26 12:38:26 -0700 | [diff] [blame] | 36 | #include <stdio.h> |
| 37 | |
| 38 | #define SU_PATH "/system/xbin/su" |
| 39 | |
Felipe Leme | 8620bb4 | 2015-11-10 11:04:45 -0800 | [diff] [blame] | 40 | #ifdef __cplusplus |
| 41 | extern "C" { |
| 42 | #endif |
| 43 | |
Colin Cross | 0c22e8b | 2012-11-02 15:46:56 -0700 | [diff] [blame] | 44 | typedef void (for_each_pid_func)(int, const char *); |
| 45 | typedef void (for_each_tid_func)(int, int, const char *); |
| 46 | |
Colin Cross | f45fa6b | 2012-03-26 12:38:26 -0700 | [diff] [blame] | 47 | /* prints the contents of a file */ |
Christopher Ferris | 1fe6107 | 2014-07-22 16:08:19 -0700 | [diff] [blame] | 48 | int dump_file(const char *title, const char *path); |
| 49 | |
Christopher Ferris | 54bcc5f | 2015-02-10 12:15:01 -0800 | [diff] [blame] | 50 | /* prints the contents of the fd |
| 51 | * fd must have been opened with the flag O_NONBLOCK. |
| 52 | */ |
Christopher Ferris | 1fe6107 | 2014-07-22 16:08:19 -0700 | [diff] [blame] | 53 | int dump_file_from_fd(const char *title, const char *path, int fd); |
Colin Cross | f45fa6b | 2012-03-26 12:38:26 -0700 | [diff] [blame] | 54 | |
Mark Salyzyn | 326842f | 2015-04-30 09:49:41 -0700 | [diff] [blame] | 55 | /* calls skip to gate calling dump_from_fd recursively |
| 56 | * in the specified directory. dump_from_fd defaults to |
| 57 | * dump_file_from_fd above when set to NULL. skip defaults |
| 58 | * to false when set to NULL. dump_from_fd will always be |
| 59 | * called with title NULL. |
| 60 | */ |
| 61 | int dump_files(const char *title, const char *dir, |
| 62 | bool (*skip)(const char *path), |
| 63 | int (*dump_from_fd)(const char *title, const char *path, int fd)); |
| 64 | |
Colin Cross | f45fa6b | 2012-03-26 12:38:26 -0700 | [diff] [blame] | 65 | /* forks a command and waits for it to finish -- terminate args with NULL */ |
| 66 | int run_command(const char *title, int timeout_seconds, const char *command, ...); |
| 67 | |
Felipe Leme | 93d705b | 2015-11-10 20:10:25 -0800 | [diff] [blame] | 68 | /* forks a command and waits for it to finish |
| 69 | first element of args is the command, and last must be NULL. |
| 70 | command is always ran, even when _DUMPSTATE_DRY_RUN_ is defined. */ |
| 71 | int run_command_always(const char *title, int timeout_seconds, const char *args[]); |
| 72 | |
Colin Cross | f45fa6b | 2012-03-26 12:38:26 -0700 | [diff] [blame] | 73 | /* prints all the system properties */ |
| 74 | void print_properties(); |
| 75 | |
| 76 | /* redirect output to a service control socket */ |
| 77 | void redirect_to_socket(FILE *redirect, const char *service); |
| 78 | |
Christopher Ferris | ff4a4dc | 2015-02-09 16:24:47 -0800 | [diff] [blame] | 79 | /* redirect output to a file */ |
| 80 | void redirect_to_file(FILE *redirect, char *path); |
Colin Cross | f45fa6b | 2012-03-26 12:38:26 -0700 | [diff] [blame] | 81 | |
Jeff Brown | bf7f492 | 2012-06-07 16:40:01 -0700 | [diff] [blame] | 82 | /* dump Dalvik and native stack traces, return the trace file location (NULL if none) */ |
| 83 | const char *dump_traces(); |
Colin Cross | f45fa6b | 2012-03-26 12:38:26 -0700 | [diff] [blame] | 84 | |
| 85 | /* for each process in the system, run the specified function */ |
Colin Cross | 0c22e8b | 2012-11-02 15:46:56 -0700 | [diff] [blame] | 86 | void for_each_pid(for_each_pid_func func, const char *header); |
| 87 | |
| 88 | /* for each thread in the system, run the specified function */ |
| 89 | void for_each_tid(for_each_tid_func func, const char *header); |
Colin Cross | f45fa6b | 2012-03-26 12:38:26 -0700 | [diff] [blame] | 90 | |
| 91 | /* Displays a blocked processes in-kernel wait channel */ |
Colin Cross | 0c22e8b | 2012-11-02 15:46:56 -0700 | [diff] [blame] | 92 | void show_wchan(int pid, int tid, const char *name); |
Colin Cross | f45fa6b | 2012-03-26 12:38:26 -0700 | [diff] [blame] | 93 | |
| 94 | /* Runs "showmap" for a process */ |
| 95 | void do_showmap(int pid, const char *name); |
| 96 | |
| 97 | /* Gets the dmesg output for the kernel */ |
| 98 | void do_dmesg(); |
| 99 | |
Sreeram Ramachandran | 2b3bba3 | 2014-07-08 15:40:55 -0700 | [diff] [blame] | 100 | /* Prints the contents of all the routing tables, both IPv4 and IPv6. */ |
| 101 | void dump_route_tables(); |
| 102 | |
Colin Cross | f45fa6b | 2012-03-26 12:38:26 -0700 | [diff] [blame] | 103 | /* Play a sound via Stagefright */ |
Christopher Ferris | 1fe6107 | 2014-07-22 16:08:19 -0700 | [diff] [blame] | 104 | void play_sound(const char *path); |
Colin Cross | f45fa6b | 2012-03-26 12:38:26 -0700 | [diff] [blame] | 105 | |
| 106 | /* Implemented by libdumpstate_board to dump board-specific info */ |
| 107 | void dumpstate_board(); |
| 108 | |
Felipe Leme | 8620bb4 | 2015-11-10 11:04:45 -0800 | [diff] [blame] | 109 | #ifdef __cplusplus |
| 110 | } |
| 111 | #endif |
| 112 | |
Colin Cross | f45fa6b | 2012-03-26 12:38:26 -0700 | [diff] [blame] | 113 | #endif /* _DUMPSTATE_H_ */ |