2 * Copyright (c) 2005-2007, Joseph Koshy
3 * Copyright (c) 2007 The FreeBSD Foundation
6 * Portions of this software were developed by A. Joseph Koshy under
7 * sponsorship from the FreeBSD Foundation and Google, Inc.
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
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.
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
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 #define FLAGS_HAS_CPUMASK 0x00040000 /* -c */
56 #define DEFAULT_SAMPLE_COUNT 65536
57 #define DEFAULT_WAIT_INTERVAL 5.0
58 #define DEFAULT_DISPLAY_HEIGHT 256 /* file virtual height */
59 #define DEFAULT_DISPLAY_WIDTH 1024 /* file virtual width */
60 #define DEFAULT_BUFFER_SIZE 4096
61 #define DEFAULT_CALLGRAPH_DEPTH 4
63 #define PRINT_HEADER_PREFIX "# "
69 #define PARENTSOCKET 0
72 #define PMCSTAT_OPEN_FOR_READ 0
73 #define PMCSTAT_OPEN_FOR_WRITE 1
74 #define PMCSTAT_DEFAULT_NW_HOST "localhost"
75 #define PMCSTAT_DEFAULT_NW_PORT "9000"
76 #define PMCSTAT_NHASH 256
77 #define PMCSTAT_HASH_MASK 0xFF
79 #define PMCSTAT_LDD_COMMAND "/usr/bin/ldd"
81 #define PMCSTAT_PRINT_ENTRY(T,...) do { \
82 (void) fprintf(args.pa_printfile, "%-9s", T); \
83 (void) fprintf(args.pa_printfile, " " __VA_ARGS__); \
84 (void) fprintf(args.pa_printfile, "\n"); \
87 #define PMCSTAT_PL_NONE 0
88 #define PMCSTAT_PL_CALLGRAPH 1
89 #define PMCSTAT_PL_GPROF 2
90 #define PMCSTAT_PL_ANNOTATE 3
91 #define PMCSTAT_PL_CALLTREE 4
93 #define PMCSTAT_TOP_DELTA 0
94 #define PMCSTAT_TOP_ACCUM 1
96 #define min(A,B) ((A) < (B) ? (A) : (B))
97 #define max(A,B) ((A) > (B) ? (A) : (B))
100 PMCSTAT_FINISHED = 0,
106 STAILQ_ENTRY(pmcstat_ev) ev_next;
107 int ev_count; /* associated count if in sampling mode */
108 uint32_t ev_cpu; /* cpus for this event */
109 int ev_cumulative; /* show cumulative counts */
110 int ev_flags; /* PMC_F_* */
111 int ev_fieldskip; /* #leading spaces */
112 int ev_fieldwidth; /* print width */
113 enum pmc_mode ev_mode; /* desired mode */
114 char *ev_name; /* (derived) event name */
115 pmc_id_t ev_pmcid; /* allocated ID */
116 pmc_value_t ev_saved; /* for incremental counts */
117 char *ev_spec; /* event specification */
120 struct pmcstat_target {
121 SLIST_ENTRY(pmcstat_target) pt_next;
125 struct pmcstat_args {
126 int pa_flags; /* argument flags */
127 int pa_required; /* required features */
128 int pa_pplugin; /* pre-processing plugin */
129 int pa_plugin; /* analysis plugin */
130 int pa_verbosity; /* verbosity level */
131 FILE *pa_printfile; /* where to send printed output */
132 int pa_logfd; /* output log file */
133 char *pa_inputpath; /* path to input log */
134 char *pa_outputpath; /* path to output log */
135 void *pa_logparser; /* log file parser */
136 const char *pa_fsroot; /* FS root where executables reside */
137 char *pa_kernel; /* pathname of the kernel */
138 const char *pa_samplesdir; /* directory for profile files */
139 const char *pa_mapfilename;/* mapfile name */
140 FILE *pa_graphfile; /* where to send the callgraph */
141 int pa_graphdepth; /* print depth for callgraphs */
142 double pa_interval; /* printing interval in seconds */
143 uint32_t pa_cpumask; /* filter for CPUs analysed */
144 int pa_ctdumpinstr; /* dump instructions with calltree */
145 int pa_topmode; /* delta or accumulative */
146 int pa_toptty; /* output to tty or file */
147 int pa_topcolor; /* terminal support color */
148 int pa_mergepmc; /* merge PMC with same name */
151 STAILQ_HEAD(, pmcstat_ev) pa_events;
152 SLIST_HEAD(, pmcstat_target) pa_targets;
155 extern int pmcstat_displayheight; /* current terminal height */
156 extern int pmcstat_displaywidth; /* current terminal width */
157 extern struct pmcstat_args args; /* command line args */
159 /* Function prototypes */
160 void pmcstat_attach_pmcs(void);
161 void pmcstat_cleanup(void);
162 void pmcstat_clone_event_descriptor(
163 struct pmcstat_ev *_ev, uint32_t _cpumask);
164 int pmcstat_close_log(void);
165 void pmcstat_create_process(void);
166 void pmcstat_find_targets(const char *_arg);
167 void pmcstat_initialize_logging(void);
168 void pmcstat_kill_process(void);
169 int pmcstat_open_log(const char *_p, int _mode);
170 void pmcstat_print_counters(void);
171 void pmcstat_print_headers(void);
172 void pmcstat_print_pmcs(void);
173 void pmcstat_show_usage(void);
174 void pmcstat_shutdown_logging(void);
175 void pmcstat_start_pmcs(void);
176 void pmcstat_start_process(void);
177 int pmcstat_process_log(void);
178 int pmcstat_keypress_log(void);
179 void pmcstat_display_log(void);
180 void pmcstat_pluginconfigure_log(char *_opt);
181 uint32_t pmcstat_get_cpumask(const char *_a);
182 void pmcstat_topexit(void);
184 #endif /* _PMCSTAT_H_ */