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, control_socket_fd; 83 84/* full path of the directory where the bugreport files will be written */ 85extern std::string bugreport_dir; 86 87/* root dir for all files copied as-is into the bugreport. */ 88extern const std::string ZIP_ROOT_DIR; 89 90/* Checkes whether dumpstate is generating a zipped bugreport. */ 91bool is_zipping(); 92 93/* adds a new entry to the existing zip file. */ 94bool add_zip_entry(const std::string& entry_name, const std::string& entry_path); 95 96/* adds a new entry to the existing zip file. */ 97bool add_zip_entry_from_fd(const std::string& entry_name, int fd); 98 99/* adds all files from a directory to the zipped bugreport file */ 100void add_dir(const char *dir, bool recursive); 101 102/* prints the contents of a file */ 103int dump_file(const char *title, const char *path); 104 105/* saves the the contents of a file as a long */ 106int read_file_as_long(const char *path, long int *output); 107 108/* prints the contents of the fd 109 * fd must have been opened with the flag O_NONBLOCK. 110 */ 111int dump_file_from_fd(const char *title, const char *path, int fd); 112 113/* calls skip to gate calling dump_from_fd recursively 114 * in the specified directory. dump_from_fd defaults to 115 * dump_file_from_fd above when set to NULL. skip defaults 116 * to false when set to NULL. dump_from_fd will always be 117 * called with title NULL. 118 */ 119int dump_files(const char *title, const char *dir, 120 bool (*skip)(const char *path), 121 int (*dump_from_fd)(const char *title, const char *path, int fd)); 122 123// TODO: need to refactor all those run_command variations; there shold be just one, receiving an 124// optional CommandOptions objects with values such as run_always, drop_root, etc... 125 126/* forks a command and waits for it to finish -- terminate args with NULL */ 127int run_command_as_shell(const char *title, int timeout_seconds, const char *command, ...); 128int run_command(const char *title, int timeout_seconds, const char *command, ...); 129 130enum RootMode { DROP_ROOT, DONT_DROP_ROOT }; 131enum StdoutMode { NORMAL_STDOUT, REDIRECT_TO_STDERR }; 132 133/* forks a command and waits for it to finish 134 first element of args is the command, and last must be NULL. 135 command is always ran, even when _DUMPSTATE_DRY_RUN_ is defined. */ 136int run_command_always(const char *title, RootMode root_mode, StdoutMode stdout_mode, 137 int timeout_seconds, const char *args[]); 138 139/* switch to non-root user and group */ 140bool drop_root_user(); 141 142/* sends a broadcast using Activity Manager */ 143void send_broadcast(const std::string& action, const std::vector<std::string>& args); 144 145/* updates the overall progress of dumpstate by the given weight increment */ 146void update_progress(int weight); 147 148/* prints all the system properties */ 149void print_properties(); 150 151/** opens a socket and returns its file descriptor */ 152int open_socket(const char *service); 153 154/* redirect output to a service control socket */ 155void redirect_to_socket(FILE *redirect, const char *service); 156 157/* redirect output to a file */ 158void redirect_to_file(FILE *redirect, char *path); 159 160/* create leading directories, if necessary */ 161void create_parent_dirs(const char *path); 162 163/* dump Dalvik and native stack traces, return the trace file location (NULL if none) */ 164const char *dump_traces(); 165 166/* for each process in the system, run the specified function */ 167void for_each_pid(for_each_pid_func func, const char *header); 168 169/* for each thread in the system, run the specified function */ 170void for_each_tid(for_each_tid_func func, const char *header); 171 172/* Displays a blocked processes in-kernel wait channel */ 173void show_wchan(int pid, int tid, const char *name); 174 175/* Displays a processes times */ 176void show_showtime(int pid, const char *name); 177 178/* Runs "showmap" for a process */ 179void do_showmap(int pid, const char *name); 180 181/* Gets the dmesg output for the kernel */ 182void do_dmesg(); 183 184/* Prints the contents of all the routing tables, both IPv4 and IPv6. */ 185void dump_route_tables(); 186 187/* Play a sound via Stagefright */ 188void play_sound(const char *path); 189 190/* Implemented by libdumpstate_board to dump board-specific info */ 191void dumpstate_board(); 192 193/* Takes a screenshot and save it to the given file */ 194void take_screenshot(const std::string& path); 195 196/* Vibrates for a given durating (in milliseconds). */ 197void vibrate(FILE* vibrator, int ms); 198 199/* Checks if a given path is a directory. */ 200bool is_dir(const char* pathname); 201 202/** Gets the last modification time of a file, or default time if file is not found. */ 203time_t get_mtime(int fd, time_t default_mtime); 204 205/* Dumps eMMC Extended CSD data. */ 206void dump_emmc_ecsd(const char *ext_csd_path); 207 208/** Gets command-line arguments. */ 209void format_args(int argc, const char *argv[], std::string *args); 210 211/** Tells if the device is running a user build. */ 212bool is_user_build(); 213 214/* 215 * Helper class used to report how long it takes for a section to finish. 216 * 217 * Typical usage: 218 * 219 * DurationReporter duration_reporter(title); 220 * 221 */ 222class DurationReporter { 223public: 224 DurationReporter(const char *title); 225 DurationReporter(const char *title, FILE* out); 226 227 ~DurationReporter(); 228 229 static uint64_t nanotime(); 230 231private: 232 const char* title_; 233 FILE* out_; 234 uint64_t started_; 235}; 236 237#ifdef __cplusplus 238} 239#endif 240 241#endif /* _DUMPSTATE_H_ */ 242