dumpstate.h revision 71a74ac75c8687195d27642fa0db31a796102c59 
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 fluctuate
69 * down (for example, from 70% to 50%, since the actual max will be automatically increased every
70 * time it is reached).
71 */
72static const int WEIGHT_TOTAL = 4000;
73
74/* Most simple commands have 10 as timeout, so 5 is a good estimate */
75static const int WEIGHT_FILE = 5;
76
77/*
78 * TODO: the dumpstate internal state is getting fragile; for example, this variable is defined
79 * here, declared at utils.cpp, and used on utils.cpp and dumpstate.cpp.
80 * It would be better to take advantage of the C++ migration and encapsulate the state in an object,
81 * but that will be better handled in a major C++ refactoring, which would also get rid of other C
82 * idioms (like using std::string instead of char*, removing varargs, etc...) */
83extern int do_update_progress, progress, weight_total;
84
85/* prints the contents of a file */
86int dump_file(const char *title, const char *path);
87
88/* saves the the contents of a file as a long */
89int read_file_as_long(const char *path, long int *output);
90
91/* prints the contents of the fd
92 * fd must have been opened with the flag O_NONBLOCK.
93 */
94int dump_file_from_fd(const char *title, const char *path, int fd);
95
96/* calls skip to gate calling dump_from_fd recursively
97 * in the specified directory. dump_from_fd defaults to
98 * dump_file_from_fd above when set to NULL. skip defaults
99 * to false when set to NULL. dump_from_fd will always be
100 * called with title NULL.
101 */
102int dump_files(const char *title, const char *dir,
103        bool (*skip)(const char *path),
104        int (*dump_from_fd)(const char *title, const char *path, int fd));
105
106/* forks a command and waits for it to finish -- terminate args with NULL */
107int run_command(const char *title, int timeout_seconds, const char *command, ...);
108
109/* forks a command and waits for it to finish
110   first element of args is the command, and last must be NULL.
111   command is always ran, even when _DUMPSTATE_DRY_RUN_ is defined. */
112int run_command_always(const char *title, int timeout_seconds, const char *args[]);
113
114/* sends a broadcast using Activity Manager */
115void send_broadcast(const std::string& action, const std::vector<std::string>& args);
116
117/* updates the overall progress of dumpstate by the given weight increment */
118void update_progress(int weight);
119
120/* prints all the system properties */
121void print_properties();
122
123/* redirect output to a service control socket */
124void redirect_to_socket(FILE *redirect, const char *service);
125
126/* redirect output to a file */
127void redirect_to_file(FILE *redirect, char *path);
128
129/* create leading directories, if necessary */
130void create_parent_dirs(const char *path);
131
132/* dump Dalvik and native stack traces, return the trace file location (NULL if none) */
133const char *dump_traces();
134
135/* for each process in the system, run the specified function */
136void for_each_pid(for_each_pid_func func, const char *header);
137
138/* for each thread in the system, run the specified function */
139void for_each_tid(for_each_tid_func func, const char *header);
140
141/* Displays a blocked processes in-kernel wait channel */
142void show_wchan(int pid, int tid, const char *name);
143
144/* Displays a processes times */
145void show_showtime(int pid, const char *name);
146
147/* Runs "showmap" for a process */
148void do_showmap(int pid, const char *name);
149
150/* Gets the dmesg output for the kernel */
151void do_dmesg();
152
153/* Prints the contents of all the routing tables, both IPv4 and IPv6. */
154void dump_route_tables();
155
156/* Play a sound via Stagefright */
157void play_sound(const char *path);
158
159/* Implemented by libdumpstate_board to dump board-specific info */
160void dumpstate_board();
161
162/* Takes a screenshot and save it to the given file */
163void take_screenshot(const std::string& path);
164
165/* Vibrates for a given durating (in milliseconds). */
166void vibrate(FILE* vibrator, int ms);
167
168/* Checks if a given path is a directory. */
169bool is_dir(const char* pathname);
170
171/** Gets the last modification time of a file, or default time if file is not found. */
172time_t get_mtime(int fd, time_t default_mtime);
173
174/* dump eMMC Extended CSD data */
175void dump_emmc_ecsd(const char *ext_csd_path);
176
177/** gets command-line arguments */
178void format_args(int argc, const char *argv[], std::string *args);
179
180/*
181 * Helper class used to report how long it takes for a section to finish.
182 *
183 * Typical usage:
184 *
185 *    DurationReporter duration_reporter(title);
186 *
187 */
188class DurationReporter {
189public:
190    DurationReporter(const char *title);
191    DurationReporter(const char *title, FILE* out);
192
193    ~DurationReporter();
194
195    static uint64_t nanotime();
196
197private:
198    const char* title_;
199    FILE* out_;
200    uint64_t started_;
201};
202
203#ifdef __cplusplus
204}
205#endif
206
207#endif /* _DUMPSTATE_H_ */
208