dumpstate.h revision ad5f6c475934ac6a658a203069a9f055540946e7 
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/* 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
26#define ON_DRY_RUN(code) code
27#else
28#define ON_DRY_RUN_RETURN(X)
29#define ON_DRY_RUN(code)
30#endif
31
32
33#include <time.h>
34#include <unistd.h>
35#include <stdbool.h>
36#include <stdio.h>
37#include <vector>
38
39#define SU_PATH "/system/xbin/su"
40
41#ifdef __cplusplus
42extern "C" {
43#endif
44
45typedef void (for_each_pid_func)(int, const char *);
46typedef void (for_each_tid_func)(int, int, const char *);
47
48/* Estimated total weight of bugreport generation.
49 *
50 * Each section contributes to the total weight by an individual weight, so the overall progress
51 * can be calculated by dividing the all completed weight by the total weight.
52 *
53 * This value is defined empirically and it need to be adjusted as more sections are added.
54 *
55 * It does not need to match the exact sum of all sections, but ideally it should to be slight more
56 * than such sum: a value too high will cause the bugreport to finish before the user expected (for
57 * example, jumping from 70% to 100%), while a value too low will cause the progress to fluctuate
58 * down (for example, from 70% to 50%, since the actual max will be automatically increased every
59 * time it is reached).
60 */
61static const int WEIGHT_TOTAL = 4000;
62
63/* Most simple commands have 10 as timeout, so 5 is a good estimate */
64static const int WEIGHT_FILE = 5;
65
66/*
67 * TOOD: the dumpstate internal state is getting fragile; for example, this variable is defined
68 * here, declared at utils.cpp, and used on utils.cpp and dumpstate.cpp.
69 * It would be better to take advantage of the C++ migration and encapsulate the state in an object,
70 * but that will be better handled in a major C++ refactoring, which would also get rid of other C
71 * idioms (like using std::string instead of char*, removing varargs, etc...) */
72extern int do_update_progress;
73
74/* prints the contents of a file */
75int dump_file(const char *title, const char *path);
76
77/* prints the contents of the fd
78 * fd must have been opened with the flag O_NONBLOCK.
79 */
80int dump_file_from_fd(const char *title, const char *path, int fd);
81
82/* calls skip to gate calling dump_from_fd recursively
83 * in the specified directory. dump_from_fd defaults to
84 * dump_file_from_fd above when set to NULL. skip defaults
85 * to false when set to NULL. dump_from_fd will always be
86 * called with title NULL.
87 */
88int dump_files(const char *title, const char *dir,
89        bool (*skip)(const char *path),
90        int (*dump_from_fd)(const char *title, const char *path, int fd));
91
92/* forks a command and waits for it to finish -- terminate args with NULL */
93int run_command(const char *title, int timeout_seconds, const char *command, ...);
94
95/* forks a command and waits for it to finish
96   first element of args is the command, and last must be NULL.
97   command is always ran, even when _DUMPSTATE_DRY_RUN_ is defined. */
98int run_command_always(const char *title, int timeout_seconds, const char *args[]);
99
100/* sends a broadcast using Activity Manager */
101void send_broadcast(const std::string& action, const std::vector<std::string>& args);
102
103/* updates the overall progress of dumpstate by the given weight increment */
104void update_progress(int weight);
105
106/* prints all the system properties */
107void print_properties();
108
109/* redirect output to a service control socket */
110void redirect_to_socket(FILE *redirect, const char *service);
111
112/* redirect output to a file */
113void redirect_to_file(FILE *redirect, char *path);
114
115/* dump Dalvik and native stack traces, return the trace file location (NULL if none) */
116const char *dump_traces();
117
118/* for each process in the system, run the specified function */
119void for_each_pid(for_each_pid_func func, const char *header);
120
121/* for each thread in the system, run the specified function */
122void for_each_tid(for_each_tid_func func, const char *header);
123
124/* Displays a blocked processes in-kernel wait channel */
125void show_wchan(int pid, int tid, const char *name);
126
127/* Runs "showmap" for a process */
128void do_showmap(int pid, const char *name);
129
130/* Gets the dmesg output for the kernel */
131void do_dmesg();
132
133/* Prints the contents of all the routing tables, both IPv4 and IPv6. */
134void dump_route_tables();
135
136/* Play a sound via Stagefright */
137void play_sound(const char *path);
138
139/* Implemented by libdumpstate_board to dump board-specific info */
140void dumpstate_board();
141
142#ifdef __cplusplus
143}
144#endif
145
146#endif /* _DUMPSTATE_H_ */
147