dumpstate.h revision faf67e3fe2451e75d0369906a579d3e1386a5064 
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#ifndef MYLOGD
33#define MYLOGD(...) fprintf(stderr, __VA_ARGS__); ALOGD(__VA_ARGS__);
34#endif
35
36#ifndef MYLOGI
37#define MYLOGI(...) fprintf(stderr, __VA_ARGS__); ALOGI(__VA_ARGS__);
38#endif
39
40#ifndef MYLOGE
41#define MYLOGE(...) fprintf(stderr, __VA_ARGS__); ALOGE(__VA_ARGS__);
42#endif
43
44#include <time.h>
45#include <unistd.h>
46#include <stdbool.h>
47#include <stdio.h>
48#include <vector>
49
50#define SU_PATH "/system/xbin/su"
51
52#ifdef __cplusplus
53extern "C" {
54#endif
55
56typedef void (for_each_pid_func)(int, const char *);
57typedef void (for_each_tid_func)(int, int, const char *);
58
59/* Estimated total weight of bugreport generation.
60 *
61 * Each section contributes to the total weight by an individual weight, so the overall progress
62 * can be calculated by dividing the all completed weight by the total weight.
63 *
64 * This value is defined empirically and it need to be adjusted as more sections are added.
65 *
66 * It does not need to match the exact sum of all sections, but ideally it should to be slight more
67 * than such sum: a value too high will cause the bugreport to finish before the user expected (for
68 * example, jumping from 70% to 100%), while a value too low will cause the progress to get stuck
69 * at an almost-finished value (like 99%) for a while.
70 */
71static const int WEIGHT_TOTAL = 6500;
72
73/* Most simple commands have 10 as timeout, so 5 is a good estimate */
74static const int WEIGHT_FILE = 5;
75
76/*
77 * TODO: the dumpstate internal state is getting fragile; for example, this variable is defined
78 * here, declared at utils.cpp, and used on utils.cpp and dumpstate.cpp.
79 * It would be better to take advantage of the C++ migration and encapsulate the state in an object,
80 * but that will be better handled in a major C++ refactoring, which would also get rid of other C
81 * idioms (like using std::string instead of char*, removing varargs, etc...) */
82extern int do_update_progress, progress, weight_total;
83
84/* prints the contents of a file */
85int dump_file(const char *title, const char *path);
86
87/* saves the the contents of a file as a long */
88int read_file_as_long(const char *path, long int *output);
89
90/* prints the contents of the fd
91 * fd must have been opened with the flag O_NONBLOCK.
92 */
93int dump_file_from_fd(const char *title, const char *path, int fd);
94
95/* calls skip to gate calling dump_from_fd recursively
96 * in the specified directory. dump_from_fd defaults to
97 * dump_file_from_fd above when set to NULL. skip defaults
98 * to false when set to NULL. dump_from_fd will always be
99 * called with title NULL.
100 */
101int dump_files(const char *title, const char *dir,
102        bool (*skip)(const char *path),
103        int (*dump_from_fd)(const char *title, const char *path, int fd));
104
105// TODO: need to refactor all those run_command variations; there shold be just one, receiving an
106// optional CommandOptions objects with values such as run_always, drop_root, etc...
107
108/* forks a command and waits for it to finish -- terminate args with NULL */
109int run_command_as_shell(const char *title, int timeout_seconds, const char *command, ...);
110int run_command(const char *title, int timeout_seconds, const char *command, ...);
111
112/* forks a command and waits for it to finish
113   first element of args is the command, and last must be NULL.
114   command is always ran, even when _DUMPSTATE_DRY_RUN_ is defined. */
115int run_command_always(const char *title, bool drop_root, int timeout_seconds, const char *args[]);
116
117/* switch to non-root user and group */
118bool drop_root_user();
119
120/* sends a broadcast using Activity Manager */
121void send_broadcast(const std::string& action, const std::vector<std::string>& args);
122
123/* updates the overall progress of dumpstate by the given weight increment */
124void update_progress(int weight);
125
126/* prints all the system properties */
127void print_properties();
128
129/* redirect output to a service control socket */
130void redirect_to_socket(FILE *redirect, const char *service);
131
132/* redirect output to a file */
133void redirect_to_file(FILE *redirect, char *path);
134
135/* create leading directories, if necessary */
136void create_parent_dirs(const char *path);
137
138/* dump Dalvik and native stack traces, return the trace file location (NULL if none) */
139const char *dump_traces();
140
141/* for each process in the system, run the specified function */
142void for_each_pid(for_each_pid_func func, const char *header);
143
144/* for each thread in the system, run the specified function */
145void for_each_tid(for_each_tid_func func, const char *header);
146
147/* Displays a blocked processes in-kernel wait channel */
148void show_wchan(int pid, int tid, const char *name);
149
150/* Displays a processes times */
151void show_showtime(int pid, const char *name);
152
153/* Runs "showmap" for a process */
154void do_showmap(int pid, const char *name);
155
156/* Gets the dmesg output for the kernel */
157void do_dmesg();
158
159/* Prints the contents of all the routing tables, both IPv4 and IPv6. */
160void dump_route_tables();
161
162/* Play a sound via Stagefright */
163void play_sound(const char *path);
164
165/* Implemented by libdumpstate_board to dump board-specific info */
166void dumpstate_board();
167
168/* Takes a screenshot and save it to the given file */
169void take_screenshot(const std::string& path);
170
171/* Vibrates for a given durating (in milliseconds). */
172void vibrate(FILE* vibrator, int ms);
173
174/* Checks if a given path is a directory. */
175bool is_dir(const char* pathname);
176
177/** Gets the last modification time of a file, or default time if file is not found. */
178time_t get_mtime(int fd, time_t default_mtime);
179
180/* dump eMMC Extended CSD data */
181void dump_emmc_ecsd(const char *ext_csd_path);
182
183/** gets command-line arguments */
184void format_args(int argc, const char *argv[], std::string *args);
185
186/*
187 * Helper class used to report how long it takes for a section to finish.
188 *
189 * Typical usage:
190 *
191 *    DurationReporter duration_reporter(title);
192 *
193 */
194class DurationReporter {
195public:
196    DurationReporter(const char *title);
197    DurationReporter(const char *title, FILE* out);
198
199    ~DurationReporter();
200
201    static uint64_t nanotime();
202
203private:
204    const char* title_;
205    FILE* out_;
206    uint64_t started_;
207};
208
209#ifdef __cplusplus
210}
211#endif
212
213#endif /* _DUMPSTATE_H_ */
214