blob: 25ae4534f7319ace52cfb2fe032398906cd85420 [file] [log] [blame]
Colin Crossf45fa6b2012-03-26 12:38:26 -07001/*
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 Leme93d705b2015-11-10 20:10:25 -080020/* 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 Ferrised24d2a2015-11-12 14:01:56 -080026#define ON_DRY_RUN(code) code
27#else
Felipe Leme93d705b2015-11-10 20:10:25 -080028#define ON_DRY_RUN_RETURN(X)
Christopher Ferrised24d2a2015-11-12 14:01:56 -080029#define ON_DRY_RUN(code)
Felipe Leme93d705b2015-11-10 20:10:25 -080030#endif
31
32
Colin Crossf45fa6b2012-03-26 12:38:26 -070033#include <time.h>
34#include <unistd.h>
Colin Cross0c22e8b2012-11-02 15:46:56 -070035#include <stdbool.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070036#include <stdio.h>
37
38#define SU_PATH "/system/xbin/su"
39
Felipe Leme8620bb42015-11-10 11:04:45 -080040#ifdef __cplusplus
41extern "C" {
42#endif
43
Colin Cross0c22e8b2012-11-02 15:46:56 -070044typedef void (for_each_pid_func)(int, const char *);
45typedef void (for_each_tid_func)(int, int, const char *);
46
Colin Crossf45fa6b2012-03-26 12:38:26 -070047/* prints the contents of a file */
Christopher Ferris1fe61072014-07-22 16:08:19 -070048int dump_file(const char *title, const char *path);
49
Christopher Ferris54bcc5f2015-02-10 12:15:01 -080050/* prints the contents of the fd
51 * fd must have been opened with the flag O_NONBLOCK.
52 */
Christopher Ferris1fe61072014-07-22 16:08:19 -070053int dump_file_from_fd(const char *title, const char *path, int fd);
Colin Crossf45fa6b2012-03-26 12:38:26 -070054
Mark Salyzyn326842f2015-04-30 09:49:41 -070055/* 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 */
61int 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 Crossf45fa6b2012-03-26 12:38:26 -070065/* forks a command and waits for it to finish -- terminate args with NULL */
66int run_command(const char *title, int timeout_seconds, const char *command, ...);
67
Felipe Leme93d705b2015-11-10 20:10:25 -080068/* 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. */
71int run_command_always(const char *title, int timeout_seconds, const char *args[]);
72
Colin Crossf45fa6b2012-03-26 12:38:26 -070073/* prints all the system properties */
74void print_properties();
75
76/* redirect output to a service control socket */
77void redirect_to_socket(FILE *redirect, const char *service);
78
Christopher Ferrisff4a4dc2015-02-09 16:24:47 -080079/* redirect output to a file */
80void redirect_to_file(FILE *redirect, char *path);
Colin Crossf45fa6b2012-03-26 12:38:26 -070081
Jeff Brownbf7f4922012-06-07 16:40:01 -070082/* dump Dalvik and native stack traces, return the trace file location (NULL if none) */
83const char *dump_traces();
Colin Crossf45fa6b2012-03-26 12:38:26 -070084
85/* for each process in the system, run the specified function */
Colin Cross0c22e8b2012-11-02 15:46:56 -070086void for_each_pid(for_each_pid_func func, const char *header);
87
88/* for each thread in the system, run the specified function */
89void for_each_tid(for_each_tid_func func, const char *header);
Colin Crossf45fa6b2012-03-26 12:38:26 -070090
91/* Displays a blocked processes in-kernel wait channel */
Colin Cross0c22e8b2012-11-02 15:46:56 -070092void show_wchan(int pid, int tid, const char *name);
Colin Crossf45fa6b2012-03-26 12:38:26 -070093
94/* Runs "showmap" for a process */
95void do_showmap(int pid, const char *name);
96
97/* Gets the dmesg output for the kernel */
98void do_dmesg();
99
Sreeram Ramachandran2b3bba32014-07-08 15:40:55 -0700100/* Prints the contents of all the routing tables, both IPv4 and IPv6. */
101void dump_route_tables();
102
Colin Crossf45fa6b2012-03-26 12:38:26 -0700103/* Play a sound via Stagefright */
Christopher Ferris1fe61072014-07-22 16:08:19 -0700104void play_sound(const char *path);
Colin Crossf45fa6b2012-03-26 12:38:26 -0700105
106/* Implemented by libdumpstate_board to dump board-specific info */
107void dumpstate_board();
108
Felipe Leme8620bb42015-11-10 11:04:45 -0800109#ifdef __cplusplus
110}
111#endif
112
Colin Crossf45fa6b2012-03-26 12:38:26 -0700113#endif /* _DUMPSTATE_H_ */