Home | History | Annotate | Download | only in dumpstate
      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 #include <time.h>
     21 #include <unistd.h>
     22 #include <stdbool.h>
     23 #include <stdio.h>
     24 
     25 #define SU_PATH "/system/xbin/su"
     26 
     27 typedef void (for_each_pid_func)(int, const char *);
     28 typedef void (for_each_tid_func)(int, int, const char *);
     29 typedef void (for_each_userid_func)(int);
     30 
     31 /* prints the contents of a file */
     32 int dump_file(const char *title, const char *path);
     33 
     34 /* prints the contents of the fd */
     35 int dump_file_from_fd(const char *title, const char *path, int fd);
     36 
     37 /* forks a command and waits for it to finish -- terminate args with NULL */
     38 int run_command(const char *title, int timeout_seconds, const char *command, ...);
     39 
     40 /* prints all the system properties */
     41 void print_properties();
     42 
     43 /* redirect output to a service control socket */
     44 void redirect_to_socket(FILE *redirect, const char *service);
     45 
     46 /* redirect output to a file, optionally gzipping; returns gzip pid */
     47 pid_t redirect_to_file(FILE *redirect, char *path, int gzip_level);
     48 
     49 /* dump Dalvik and native stack traces, return the trace file location (NULL if none) */
     50 const char *dump_traces();
     51 
     52 /* for each process in the system, run the specified function */
     53 void for_each_pid(for_each_pid_func func, const char *header);
     54 
     55 /* for each thread in the system, run the specified function */
     56 void for_each_tid(for_each_tid_func func, const char *header);
     57 
     58 /* for each user id in the system, run the specified function */
     59 void for_each_userid(for_each_userid_func func, const char *header);
     60 
     61 /* Displays a blocked processes in-kernel wait channel */
     62 void show_wchan(int pid, int tid, const char *name);
     63 
     64 /* Runs "showmap" for a process */
     65 void do_showmap(int pid, const char *name);
     66 
     67 /* Gets the dmesg output for the kernel */
     68 void do_dmesg();
     69 
     70 /* Dumps settings for a given user id */
     71 void do_dump_settings(int userid);
     72 
     73 /* Prints the contents of all the routing tables, both IPv4 and IPv6. */
     74 void dump_route_tables();
     75 
     76 /* Play a sound via Stagefright */
     77 void play_sound(const char *path);
     78 
     79 /* Implemented by libdumpstate_board to dump board-specific info */
     80 void dumpstate_board();
     81 
     82 #endif /* _DUMPSTATE_H_ */
     83