1 /*- 2 * Copyright (c) 2005-2007, Joseph Koshy 3 * Copyright (c) 2007 The FreeBSD Foundation 4 * All rights reserved. 5 * 6 * Portions of this software were developed by A. Joseph Koshy under 7 * sponsorship from the FreeBSD Foundation and Google, Inc. 8 * 9 * Redistribution and use in source and binary forms, with or without 10 * modification, are permitted provided that the following conditions 11 * are met: 12 * 1. Redistributions of source code must retain the above copyright 13 * notice, this list of conditions and the following disclaimer. 14 * 2. Redistributions in binary form must reproduce the above copyright 15 * notice, this list of conditions and the following disclaimer in the 16 * documentation and/or other materials provided with the distribution. 17 * 18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 19 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 21 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 22 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 23 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 24 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 25 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 26 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 27 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 28 * SUCH DAMAGE. 29 * 30 * $FreeBSD$ 31 */ 32 33 #ifndef _PMCSTAT_H_ 34 #define _PMCSTAT_H_ 35 36 #define FLAG_HAS_TARGET 0x00000001 /* process target */ 37 #define FLAG_HAS_WAIT_INTERVAL 0x00000002 /* -w secs */ 38 #define FLAG_HAS_OUTPUT_LOGFILE 0x00000004 /* -O file or pipe */ 39 #define FLAG_HAS_COMMANDLINE 0x00000008 /* command */ 40 #define FLAG_HAS_SAMPLING_PMCS 0x00000010 /* -S or -P */ 41 #define FLAG_HAS_COUNTING_PMCS 0x00000020 /* -s or -p */ 42 #define FLAG_HAS_PROCESS_PMCS 0x00000040 /* -P or -p */ 43 #define FLAG_HAS_SYSTEM_PMCS 0x00000080 /* -S or -s */ 44 #define FLAG_HAS_PIPE 0x00000100 /* implicit log */ 45 #define FLAG_READ_LOGFILE 0x00000200 /* -R file */ 46 #define FLAG_DO_GPROF 0x00000400 /* -g */ 47 #define FLAG_HAS_SAMPLESDIR 0x00000800 /* -D dir */ 48 #define FLAG_HAS_KERNELPATH 0x00001000 /* -k kernel */ 49 #define FLAG_DO_PRINT 0x00002000 /* -o */ 50 #define FLAG_DO_CALLGRAPHS 0x00004000 /* -G or -F */ 51 #define FLAG_DO_ANNOTATE 0x00008000 /* -m */ 52 #define FLAG_DO_TOP 0x00010000 /* -T */ 53 #define FLAG_DO_ANALYSIS 0x00020000 /* -g or -G or -m or -T */ 54 55 #define DEFAULT_SAMPLE_COUNT 65536 56 #define DEFAULT_WAIT_INTERVAL 5.0 57 #define DEFAULT_DISPLAY_HEIGHT 256 /* file virtual height */ 58 #define DEFAULT_DISPLAY_WIDTH 1024 /* file virtual width */ 59 #define DEFAULT_BUFFER_SIZE 4096 60 #define DEFAULT_CALLGRAPH_DEPTH 4 61 62 #define PRINT_HEADER_PREFIX "# " 63 #define READPIPEFD 0 64 #define WRITEPIPEFD 1 65 #define NPIPEFD 2 66 67 #define NSOCKPAIRFD 2 68 #define PARENTSOCKET 0 69 #define CHILDSOCKET 1 70 71 #define PMCSTAT_OPEN_FOR_READ 0 72 #define PMCSTAT_OPEN_FOR_WRITE 1 73 #define PMCSTAT_DEFAULT_NW_HOST "localhost" 74 #define PMCSTAT_DEFAULT_NW_PORT "9000" 75 #define PMCSTAT_NHASH 256 76 #define PMCSTAT_HASH_MASK 0xFF 77 78 #define PMCSTAT_LDD_COMMAND "/usr/bin/ldd" 79 80 #define PMCSTAT_PRINT_ENTRY(T,...) do { \ 81 (void) fprintf(args.pa_printfile, "%-9s", T); \ 82 (void) fprintf(args.pa_printfile, " " __VA_ARGS__); \ 83 (void) fprintf(args.pa_printfile, "\n"); \ 84 } while (0) 85 86 #define PMCSTAT_PL_NONE 0 87 #define PMCSTAT_PL_CALLGRAPH 1 88 #define PMCSTAT_PL_GPROF 2 89 #define PMCSTAT_PL_ANNOTATE 3 90 #define PMCSTAT_PL_CALLTREE 4 91 92 #define PMCSTAT_TOP_DELTA 0 93 #define PMCSTAT_TOP_ACCUM 1 94 95 #define min(A,B) ((A) < (B) ? (A) : (B)) 96 #define max(A,B) ((A) > (B) ? (A) : (B)) 97 98 enum pmcstat_state { 99 PMCSTAT_FINISHED = 0, 100 PMCSTAT_EXITING = 1, 101 PMCSTAT_RUNNING = 2 102 }; 103 104 struct pmcstat_ev { 105 STAILQ_ENTRY(pmcstat_ev) ev_next; 106 int ev_count; /* associated count if in sampling mode */ 107 uint32_t ev_cpu; /* cpus for this event */ 108 int ev_cumulative; /* show cumulative counts */ 109 int ev_flags; /* PMC_F_* */ 110 int ev_fieldskip; /* #leading spaces */ 111 int ev_fieldwidth; /* print width */ 112 enum pmc_mode ev_mode; /* desired mode */ 113 char *ev_name; /* (derived) event name */ 114 pmc_id_t ev_pmcid; /* allocated ID */ 115 pmc_value_t ev_saved; /* for incremental counts */ 116 char *ev_spec; /* event specification */ 117 }; 118 119 struct pmcstat_target { 120 SLIST_ENTRY(pmcstat_target) pt_next; 121 pid_t pt_pid; 122 }; 123 124 struct pmcstat_args { 125 int pa_flags; /* argument flags */ 126 int pa_required; /* required features */ 127 int pa_pplugin; /* pre-processing plugin */ 128 int pa_plugin; /* analysis plugin */ 129 int pa_verbosity; /* verbosity level */ 130 FILE *pa_printfile; /* where to send printed output */ 131 int pa_logfd; /* output log file */ 132 char *pa_inputpath; /* path to input log */ 133 char *pa_outputpath; /* path to output log */ 134 void *pa_logparser; /* log file parser */ 135 const char *pa_fsroot; /* FS root where executables reside */ 136 char *pa_kernel; /* pathname of the kernel */ 137 const char *pa_samplesdir; /* directory for profile files */ 138 const char *pa_mapfilename;/* mapfile name */ 139 FILE *pa_graphfile; /* where to send the callgraph */ 140 int pa_graphdepth; /* print depth for callgraphs */ 141 double pa_interval; /* printing interval in seconds */ 142 uint32_t pa_cpumask; /* filter for CPUs analysed */ 143 int pa_ctdumpinstr; /* dump instructions with calltree */ 144 int pa_topmode; /* delta or accumulative */ 145 int pa_toptty; /* output to tty or file */ 146 int pa_topcolor; /* terminal support color */ 147 int pa_mergepmc; /* merge PMC with same name */ 148 int pa_argc; 149 char **pa_argv; 150 STAILQ_HEAD(, pmcstat_ev) pa_events; 151 SLIST_HEAD(, pmcstat_target) pa_targets; 152 }; 153 154 extern int pmcstat_displayheight; /* current terminal height */ 155 extern int pmcstat_displaywidth; /* current terminal width */ 156 extern struct pmcstat_args args; /* command line args */ 157 158 /* Function prototypes */ 159 void pmcstat_attach_pmcs(void); 160 void pmcstat_cleanup(void); 161 void pmcstat_clone_event_descriptor( 162 struct pmcstat_ev *_ev, uint32_t _cpumask); 163 int pmcstat_close_log(void); 164 void pmcstat_create_process(void); 165 void pmcstat_find_targets(const char *_arg); 166 void pmcstat_initialize_logging(void); 167 void pmcstat_kill_process(void); 168 int pmcstat_open_log(const char *_p, int _mode); 169 void pmcstat_print_counters(void); 170 void pmcstat_print_headers(void); 171 void pmcstat_print_pmcs(void); 172 void pmcstat_show_usage(void); 173 void pmcstat_shutdown_logging(void); 174 void pmcstat_start_pmcs(void); 175 void pmcstat_start_process(void); 176 int pmcstat_process_log(void); 177 int pmcstat_keypress_log(void); 178 void pmcstat_display_log(void); 179 void pmcstat_pluginconfigure_log(char *_opt); 180 uint32_t pmcstat_get_cpumask(const char *_a); 181 void pmcstat_topexit(void); 182 183 #endif /* _PMCSTAT_H_ */ 184