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