blob: 26bba1b1a8c256ec4556211bf90ec10805cf451a [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
20#include <time.h>
21#include <unistd.h>
Colin Cross0c22e8b2012-11-02 15:46:56 -070022#include <stdbool.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070023#include <stdio.h>
24
25#define SU_PATH "/system/xbin/su"
26
Colin Cross0c22e8b2012-11-02 15:46:56 -070027typedef void (for_each_pid_func)(int, const char *);
28typedef void (for_each_tid_func)(int, int, const char *);
John Spurlock5ecd4be2014-01-29 14:14:40 -050029typedef void (for_each_userid_func)(int);
Colin Cross0c22e8b2012-11-02 15:46:56 -070030
Colin Crossf45fa6b2012-03-26 12:38:26 -070031/* prints the contents of a file */
Christopher Ferris1fe61072014-07-22 16:08:19 -070032int dump_file(const char *title, const char *path);
33
Christopher Ferris54bcc5f2015-02-10 12:15:01 -080034/* prints the contents of the fd
35 * fd must have been opened with the flag O_NONBLOCK.
36 */
Christopher Ferris1fe61072014-07-22 16:08:19 -070037int dump_file_from_fd(const char *title, const char *path, int fd);
Colin Crossf45fa6b2012-03-26 12:38:26 -070038
Mark Salyzyn540e3de2015-04-30 09:49:41 -070039/* calls skip to gate calling dump_from_fd recursively
40 * in the specified directory. dump_from_fd defaults to
41 * dump_file_from_fd above when set to NULL. skip defaults
42 * to false when set to NULL. dump_from_fd will always be
43 * called with title NULL.
44 */
45int dump_files(const char *title, const char *dir,
46 bool (*skip)(const char *path),
47 int (*dump_from_fd)(const char *title, const char *path, int fd));
48
Colin Crossf45fa6b2012-03-26 12:38:26 -070049/* forks a command and waits for it to finish -- terminate args with NULL */
50int run_command(const char *title, int timeout_seconds, const char *command, ...);
51
52/* prints all the system properties */
53void print_properties();
54
55/* redirect output to a service control socket */
56void redirect_to_socket(FILE *redirect, const char *service);
57
Christopher Ferrisff4a4dc2015-02-09 16:24:47 -080058/* redirect output to a file */
59void redirect_to_file(FILE *redirect, char *path);
Colin Crossf45fa6b2012-03-26 12:38:26 -070060
Jeff Brownbf7f4922012-06-07 16:40:01 -070061/* dump Dalvik and native stack traces, return the trace file location (NULL if none) */
62const char *dump_traces();
Colin Crossf45fa6b2012-03-26 12:38:26 -070063
64/* for each process in the system, run the specified function */
Colin Cross0c22e8b2012-11-02 15:46:56 -070065void for_each_pid(for_each_pid_func func, const char *header);
66
67/* for each thread in the system, run the specified function */
68void for_each_tid(for_each_tid_func func, const char *header);
Colin Crossf45fa6b2012-03-26 12:38:26 -070069
John Spurlock5ecd4be2014-01-29 14:14:40 -050070/* for each user id in the system, run the specified function */
71void for_each_userid(for_each_userid_func func, const char *header);
72
Colin Crossf45fa6b2012-03-26 12:38:26 -070073/* Displays a blocked processes in-kernel wait channel */
Colin Cross0c22e8b2012-11-02 15:46:56 -070074void show_wchan(int pid, int tid, const char *name);
Colin Crossf45fa6b2012-03-26 12:38:26 -070075
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
John Spurlock5ecd4be2014-01-29 14:14:40 -050082/* Dumps settings for a given user id */
83void do_dump_settings(int userid);
84
Sreeram Ramachandran2b3bba32014-07-08 15:40:55 -070085/* Prints the contents of all the routing tables, both IPv4 and IPv6. */
86void dump_route_tables();
87
Colin Crossf45fa6b2012-03-26 12:38:26 -070088/* Play a sound via Stagefright */
Christopher Ferris1fe61072014-07-22 16:08:19 -070089void play_sound(const char *path);
Colin Crossf45fa6b2012-03-26 12:38:26 -070090
91/* Implemented by libdumpstate_board to dump board-specific info */
92void dumpstate_board();
93
94#endif /* _DUMPSTATE_H_ */