dumpstate.h revision 8620bb4118a68721d10c29529dc6978847d08d00 
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
20#include <time.h>
21#include <unistd.h>
22#include <stdbool.h>
23#include <stdio.h>
24
25#define SU_PATH "/system/xbin/su"
26
27#ifdef __cplusplus
28extern "C" {
29#endif
30
31typedef void (for_each_pid_func)(int, const char *);
32typedef void (for_each_tid_func)(int, int, const char *);
33
34/* prints the contents of a file */
35int dump_file(const char *title, const char *path);
36
37/* prints the contents of the fd
38 * fd must have been opened with the flag O_NONBLOCK.
39 */
40int dump_file_from_fd(const char *title, const char *path, int fd);
41
42/* calls skip to gate calling dump_from_fd recursively
43 * in the specified directory. dump_from_fd defaults to
44 * dump_file_from_fd above when set to NULL. skip defaults
45 * to false when set to NULL. dump_from_fd will always be
46 * called with title NULL.
47 */
48int dump_files(const char *title, const char *dir,
49        bool (*skip)(const char *path),
50        int (*dump_from_fd)(const char *title, const char *path, int fd));
51
52/* forks a command and waits for it to finish -- terminate args with NULL */
53int run_command(const char *title, int timeout_seconds, const char *command, ...);
54
55/* prints all the system properties */
56void print_properties();
57
58/* redirect output to a service control socket */
59void redirect_to_socket(FILE *redirect, const char *service);
60
61/* redirect output to a file */
62void redirect_to_file(FILE *redirect, char *path);
63
64/* dump Dalvik and native stack traces, return the trace file location (NULL if none) */
65const char *dump_traces();
66
67/* for each process in the system, run the specified function */
68void for_each_pid(for_each_pid_func func, const char *header);
69
70/* for each thread in the system, run the specified function */
71void for_each_tid(for_each_tid_func func, const char *header);
72
73/* Displays a blocked processes in-kernel wait channel */
74void show_wchan(int pid, int tid, const char *name);
75
76/* Runs "showmap" for a process */
77void do_showmap(int pid, const char *name);
78
79/* Gets the dmesg output for the kernel */
80void do_dmesg();
81
82/* Prints the contents of all the routing tables, both IPv4 and IPv6. */
83void dump_route_tables();
84
85/* Play a sound via Stagefright */
86void play_sound(const char *path);
87
88/* Implemented by libdumpstate_board to dump board-specific info */
89void dumpstate_board();
90
91#ifdef __cplusplus
92}
93#endif
94
95#endif /* _DUMPSTATE_H_ */
96