dumpstate.h revision ed24d2ae2cd6e8b0afb86efa555f18bcfaf74a64
1f45fa6b2853cc32385375a0b63ee39ad6a968869Colin Cross/* 2f45fa6b2853cc32385375a0b63ee39ad6a968869Colin Cross * Copyright (C) 2008 The Android Open Source Project 3f45fa6b2853cc32385375a0b63ee39ad6a968869Colin Cross * 4f45fa6b2853cc32385375a0b63ee39ad6a968869Colin Cross * Licensed under the Apache License, Version 2.0 (the "License"); 5f45fa6b2853cc32385375a0b63ee39ad6a968869Colin Cross * you may not use this file except in compliance with the License. 6f45fa6b2853cc32385375a0b63ee39ad6a968869Colin Cross * You may obtain a copy of the License at 7f45fa6b2853cc32385375a0b63ee39ad6a968869Colin Cross * 8f45fa6b2853cc32385375a0b63ee39ad6a968869Colin Cross * http://www.apache.org/licenses/LICENSE-2.0 9f45fa6b2853cc32385375a0b63ee39ad6a968869Colin Cross * 10f45fa6b2853cc32385375a0b63ee39ad6a968869Colin Cross * Unless required by applicable law or agreed to in writing, software 11f45fa6b2853cc32385375a0b63ee39ad6a968869Colin Cross * distributed under the License is distributed on an "AS IS" BASIS, 12f45fa6b2853cc32385375a0b63ee39ad6a968869Colin Cross * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13f45fa6b2853cc32385375a0b63ee39ad6a968869Colin Cross * See the License for the specific language governing permissions and 14f45fa6b2853cc32385375a0b63ee39ad6a968869Colin Cross * limitations under the License. 15f45fa6b2853cc32385375a0b63ee39ad6a968869Colin Cross */ 16f45fa6b2853cc32385375a0b63ee39ad6a968869Colin Cross 17f45fa6b2853cc32385375a0b63ee39ad6a968869Colin Cross#ifndef _DUMPSTATE_H_ 18f45fa6b2853cc32385375a0b63ee39ad6a968869Colin Cross#define _DUMPSTATE_H_ 19f45fa6b2853cc32385375a0b63ee39ad6a968869Colin Cross 2093d705b6d742e8f00167ff2384e35c2205a6f9daFelipe Leme/* When defined, skips the real dumps and just print the section headers. 2193d705b6d742e8f00167ff2384e35c2205a6f9daFelipe Leme Useful when debugging dumpstate itself. */ 2293d705b6d742e8f00167ff2384e35c2205a6f9daFelipe Leme//#define _DUMPSTATE_DRY_RUN_ 2393d705b6d742e8f00167ff2384e35c2205a6f9daFelipe Leme 2493d705b6d742e8f00167ff2384e35c2205a6f9daFelipe Leme#ifdef _DUMPSTATE_DRY_RUN_ 2593d705b6d742e8f00167ff2384e35c2205a6f9daFelipe Leme#define ON_DRY_RUN_RETURN(X) return X 26ed24d2ae2cd6e8b0afb86efa555f18bcfaf74a64Christopher Ferris#define ON_DRY_RUN(code) code 27ed24d2ae2cd6e8b0afb86efa555f18bcfaf74a64Christopher Ferris#else 2893d705b6d742e8f00167ff2384e35c2205a6f9daFelipe Leme#define ON_DRY_RUN_RETURN(X) 29ed24d2ae2cd6e8b0afb86efa555f18bcfaf74a64Christopher Ferris#define ON_DRY_RUN(code) 3093d705b6d742e8f00167ff2384e35c2205a6f9daFelipe Leme#endif 3193d705b6d742e8f00167ff2384e35c2205a6f9daFelipe Leme 3293d705b6d742e8f00167ff2384e35c2205a6f9daFelipe Leme 33f45fa6b2853cc32385375a0b63ee39ad6a968869Colin Cross#include <time.h> 34f45fa6b2853cc32385375a0b63ee39ad6a968869Colin Cross#include <unistd.h> 350c22e8b31651caf12a2b4d4acef5bc65d486e570Colin Cross#include <stdbool.h> 36f45fa6b2853cc32385375a0b63ee39ad6a968869Colin Cross#include <stdio.h> 37f45fa6b2853cc32385375a0b63ee39ad6a968869Colin Cross 38f45fa6b2853cc32385375a0b63ee39ad6a968869Colin Cross#define SU_PATH "/system/xbin/su" 39f45fa6b2853cc32385375a0b63ee39ad6a968869Colin Cross 408620bb4118a68721d10c29529dc6978847d08d00Felipe Leme#ifdef __cplusplus 418620bb4118a68721d10c29529dc6978847d08d00Felipe Lemeextern "C" { 428620bb4118a68721d10c29529dc6978847d08d00Felipe Leme#endif 438620bb4118a68721d10c29529dc6978847d08d00Felipe Leme 440c22e8b31651caf12a2b4d4acef5bc65d486e570Colin Crosstypedef void (for_each_pid_func)(int, const char *); 450c22e8b31651caf12a2b4d4acef5bc65d486e570Colin Crosstypedef void (for_each_tid_func)(int, int, const char *); 460c22e8b31651caf12a2b4d4acef5bc65d486e570Colin Cross 47f45fa6b2853cc32385375a0b63ee39ad6a968869Colin Cross/* prints the contents of a file */ 481fe6107b66516b225e0843836d60a69b1b57f3c3Christopher Ferrisint dump_file(const char *title, const char *path); 491fe6107b66516b225e0843836d60a69b1b57f3c3Christopher Ferris 5054bcc5ffd5a79f4f194089c58d3de571532bf39bChristopher Ferris/* prints the contents of the fd 5154bcc5ffd5a79f4f194089c58d3de571532bf39bChristopher Ferris * fd must have been opened with the flag O_NONBLOCK. 5254bcc5ffd5a79f4f194089c58d3de571532bf39bChristopher Ferris */ 531fe6107b66516b225e0843836d60a69b1b57f3c3Christopher Ferrisint dump_file_from_fd(const char *title, const char *path, int fd); 54f45fa6b2853cc32385375a0b63ee39ad6a968869Colin Cross 55326842fca4883f1256aa9ed019bb3206ee76fca7Mark Salyzyn/* calls skip to gate calling dump_from_fd recursively 56326842fca4883f1256aa9ed019bb3206ee76fca7Mark Salyzyn * in the specified directory. dump_from_fd defaults to 57326842fca4883f1256aa9ed019bb3206ee76fca7Mark Salyzyn * dump_file_from_fd above when set to NULL. skip defaults 58326842fca4883f1256aa9ed019bb3206ee76fca7Mark Salyzyn * to false when set to NULL. dump_from_fd will always be 59326842fca4883f1256aa9ed019bb3206ee76fca7Mark Salyzyn * called with title NULL. 60326842fca4883f1256aa9ed019bb3206ee76fca7Mark Salyzyn */ 61326842fca4883f1256aa9ed019bb3206ee76fca7Mark Salyzynint dump_files(const char *title, const char *dir, 62326842fca4883f1256aa9ed019bb3206ee76fca7Mark Salyzyn bool (*skip)(const char *path), 63326842fca4883f1256aa9ed019bb3206ee76fca7Mark Salyzyn int (*dump_from_fd)(const char *title, const char *path, int fd)); 64326842fca4883f1256aa9ed019bb3206ee76fca7Mark Salyzyn 65f45fa6b2853cc32385375a0b63ee39ad6a968869Colin Cross/* forks a command and waits for it to finish -- terminate args with NULL */ 66f45fa6b2853cc32385375a0b63ee39ad6a968869Colin Crossint run_command(const char *title, int timeout_seconds, const char *command, ...); 67f45fa6b2853cc32385375a0b63ee39ad6a968869Colin Cross 6893d705b6d742e8f00167ff2384e35c2205a6f9daFelipe Leme/* forks a command and waits for it to finish 6993d705b6d742e8f00167ff2384e35c2205a6f9daFelipe Leme first element of args is the command, and last must be NULL. 7093d705b6d742e8f00167ff2384e35c2205a6f9daFelipe Leme command is always ran, even when _DUMPSTATE_DRY_RUN_ is defined. */ 7193d705b6d742e8f00167ff2384e35c2205a6f9daFelipe Lemeint run_command_always(const char *title, int timeout_seconds, const char *args[]); 7293d705b6d742e8f00167ff2384e35c2205a6f9daFelipe Leme 73f45fa6b2853cc32385375a0b63ee39ad6a968869Colin Cross/* prints all the system properties */ 74f45fa6b2853cc32385375a0b63ee39ad6a968869Colin Crossvoid print_properties(); 75f45fa6b2853cc32385375a0b63ee39ad6a968869Colin Cross 76f45fa6b2853cc32385375a0b63ee39ad6a968869Colin Cross/* redirect output to a service control socket */ 77f45fa6b2853cc32385375a0b63ee39ad6a968869Colin Crossvoid redirect_to_socket(FILE *redirect, const char *service); 78f45fa6b2853cc32385375a0b63ee39ad6a968869Colin Cross 79ff4a4dc7e6e3ead12020b4dc17548d767a419ddeChristopher Ferris/* redirect output to a file */ 80ff4a4dc7e6e3ead12020b4dc17548d767a419ddeChristopher Ferrisvoid redirect_to_file(FILE *redirect, char *path); 81f45fa6b2853cc32385375a0b63ee39ad6a968869Colin Cross 82bf7f49238d0af497d4300f7e611cf831854d6434Jeff Brown/* dump Dalvik and native stack traces, return the trace file location (NULL if none) */ 83bf7f49238d0af497d4300f7e611cf831854d6434Jeff Brownconst char *dump_traces(); 84f45fa6b2853cc32385375a0b63ee39ad6a968869Colin Cross 85f45fa6b2853cc32385375a0b63ee39ad6a968869Colin Cross/* for each process in the system, run the specified function */ 860c22e8b31651caf12a2b4d4acef5bc65d486e570Colin Crossvoid for_each_pid(for_each_pid_func func, const char *header); 870c22e8b31651caf12a2b4d4acef5bc65d486e570Colin Cross 880c22e8b31651caf12a2b4d4acef5bc65d486e570Colin Cross/* for each thread in the system, run the specified function */ 890c22e8b31651caf12a2b4d4acef5bc65d486e570Colin Crossvoid for_each_tid(for_each_tid_func func, const char *header); 90f45fa6b2853cc32385375a0b63ee39ad6a968869Colin Cross 91f45fa6b2853cc32385375a0b63ee39ad6a968869Colin Cross/* Displays a blocked processes in-kernel wait channel */ 920c22e8b31651caf12a2b4d4acef5bc65d486e570Colin Crossvoid show_wchan(int pid, int tid, const char *name); 93f45fa6b2853cc32385375a0b63ee39ad6a968869Colin Cross 94f45fa6b2853cc32385375a0b63ee39ad6a968869Colin Cross/* Runs "showmap" for a process */ 95f45fa6b2853cc32385375a0b63ee39ad6a968869Colin Crossvoid do_showmap(int pid, const char *name); 96f45fa6b2853cc32385375a0b63ee39ad6a968869Colin Cross 97f45fa6b2853cc32385375a0b63ee39ad6a968869Colin Cross/* Gets the dmesg output for the kernel */ 98f45fa6b2853cc32385375a0b63ee39ad6a968869Colin Crossvoid do_dmesg(); 99f45fa6b2853cc32385375a0b63ee39ad6a968869Colin Cross 1002b3bba34aec65b612be8d1f52cd124d9c30955f9Sreeram Ramachandran/* Prints the contents of all the routing tables, both IPv4 and IPv6. */ 1012b3bba34aec65b612be8d1f52cd124d9c30955f9Sreeram Ramachandranvoid dump_route_tables(); 1022b3bba34aec65b612be8d1f52cd124d9c30955f9Sreeram Ramachandran 103f45fa6b2853cc32385375a0b63ee39ad6a968869Colin Cross/* Play a sound via Stagefright */ 1041fe6107b66516b225e0843836d60a69b1b57f3c3Christopher Ferrisvoid play_sound(const char *path); 105f45fa6b2853cc32385375a0b63ee39ad6a968869Colin Cross 106f45fa6b2853cc32385375a0b63ee39ad6a968869Colin Cross/* Implemented by libdumpstate_board to dump board-specific info */ 107f45fa6b2853cc32385375a0b63ee39ad6a968869Colin Crossvoid dumpstate_board(); 108f45fa6b2853cc32385375a0b63ee39ad6a968869Colin Cross 1098620bb4118a68721d10c29529dc6978847d08d00Felipe Leme#ifdef __cplusplus 1108620bb4118a68721d10c29529dc6978847d08d00Felipe Leme} 1118620bb4118a68721d10c29529dc6978847d08d00Felipe Leme#endif 1128620bb4118a68721d10c29529dc6978847d08d00Felipe Leme 113f45fa6b2853cc32385375a0b63ee39ad6a968869Colin Cross#endif /* _DUMPSTATE_H_ */ 114