pmcstat.h revision 294046
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: stable/10/usr.sbin/pmcstat/pmcstat.h 294046 2016-01-14 22:02:21Z jtl $ 31 */ 32 33#ifndef _PMCSTAT_H_ 34#define _PMCSTAT_H_ 35 36#include <sys/_cpuset.h> 37 38#define FLAG_HAS_TARGET 0x00000001 /* process target */ 39#define FLAG_HAS_WAIT_INTERVAL 0x00000002 /* -w secs */ 40#define FLAG_HAS_OUTPUT_LOGFILE 0x00000004 /* -O file or pipe */ 41#define FLAG_HAS_COMMANDLINE 0x00000008 /* command */ 42#define FLAG_HAS_SAMPLING_PMCS 0x00000010 /* -S or -P */ 43#define FLAG_HAS_COUNTING_PMCS 0x00000020 /* -s or -p */ 44#define FLAG_HAS_PROCESS_PMCS 0x00000040 /* -P or -p */ 45#define FLAG_HAS_SYSTEM_PMCS 0x00000080 /* -S or -s */ 46#define FLAG_HAS_PIPE 0x00000100 /* implicit log */ 47#define FLAG_READ_LOGFILE 0x00000200 /* -R file */ 48#define FLAG_DO_GPROF 0x00000400 /* -g */ 49#define FLAG_HAS_SAMPLESDIR 0x00000800 /* -D dir */ 50#define FLAG_HAS_KERNELPATH 0x00001000 /* -k kernel */ 51#define FLAG_DO_PRINT 0x00002000 /* -o */ 52#define FLAG_DO_CALLGRAPHS 0x00004000 /* -G or -F */ 53#define FLAG_DO_ANNOTATE 0x00008000 /* -m */ 54#define FLAG_DO_TOP 0x00010000 /* -T */ 55#define FLAG_DO_ANALYSIS 0x00020000 /* -g or -G or -m or -T */ 56#define FLAGS_HAS_CPUMASK 0x00040000 /* -c */ 57#define FLAG_HAS_DURATION 0x00080000 /* -l secs */ 58#define FLAG_DO_WIDE_GPROF_HC 0x00100000 /* -e */ 59 60#define DEFAULT_SAMPLE_COUNT 65536 61#define DEFAULT_WAIT_INTERVAL 5.0 62#define DEFAULT_DISPLAY_HEIGHT 256 /* file virtual height */ 63#define DEFAULT_DISPLAY_WIDTH 1024 /* file virtual width */ 64#define DEFAULT_BUFFER_SIZE 4096 65#define DEFAULT_CALLGRAPH_DEPTH 16 66 67#define PRINT_HEADER_PREFIX "# " 68#define READPIPEFD 0 69#define WRITEPIPEFD 1 70#define NPIPEFD 2 71 72#define NSOCKPAIRFD 2 73#define PARENTSOCKET 0 74#define CHILDSOCKET 1 75 76#define PMCSTAT_OPEN_FOR_READ 0 77#define PMCSTAT_OPEN_FOR_WRITE 1 78#define PMCSTAT_DEFAULT_NW_HOST "localhost" 79#define PMCSTAT_DEFAULT_NW_PORT "9000" 80#define PMCSTAT_NHASH 256 81#define PMCSTAT_HASH_MASK 0xFF 82 83#define PMCSTAT_LDD_COMMAND "/usr/bin/ldd" 84 85#define PMCSTAT_PRINT_ENTRY(T,...) do { \ 86 (void) fprintf(args.pa_printfile, "%-9s", T); \ 87 (void) fprintf(args.pa_printfile, " " __VA_ARGS__); \ 88 (void) fprintf(args.pa_printfile, "\n"); \ 89 } while (0) 90 91#define PMCSTAT_PL_NONE 0 92#define PMCSTAT_PL_CALLGRAPH 1 93#define PMCSTAT_PL_GPROF 2 94#define PMCSTAT_PL_ANNOTATE 3 95#define PMCSTAT_PL_CALLTREE 4 96#define PMCSTAT_PL_ANNOTATE_CG 5 97 98#define PMCSTAT_TOP_DELTA 0 99#define PMCSTAT_TOP_ACCUM 1 100 101#define min(A,B) ((A) < (B) ? (A) : (B)) 102#define max(A,B) ((A) > (B) ? (A) : (B)) 103 104enum pmcstat_state { 105 PMCSTAT_FINISHED = 0, 106 PMCSTAT_EXITING = 1, 107 PMCSTAT_RUNNING = 2 108}; 109 110struct pmcstat_ev { 111 STAILQ_ENTRY(pmcstat_ev) ev_next; 112 int ev_count; /* associated count if in sampling mode */ 113 uint32_t ev_cpu; /* cpus for this event */ 114 int ev_cumulative; /* show cumulative counts */ 115 int ev_flags; /* PMC_F_* */ 116 int ev_fieldskip; /* #leading spaces */ 117 int ev_fieldwidth; /* print width */ 118 enum pmc_mode ev_mode; /* desired mode */ 119 char *ev_name; /* (derived) event name */ 120 pmc_id_t ev_pmcid; /* allocated ID */ 121 pmc_value_t ev_saved; /* for incremental counts */ 122 char *ev_spec; /* event specification */ 123}; 124 125struct pmcstat_target { 126 SLIST_ENTRY(pmcstat_target) pt_next; 127 pid_t pt_pid; 128}; 129 130struct pmcstat_args { 131 int pa_flags; /* argument flags */ 132 int pa_required; /* required features */ 133 int pa_pplugin; /* pre-processing plugin */ 134 int pa_plugin; /* analysis plugin */ 135 int pa_verbosity; /* verbosity level */ 136 FILE *pa_printfile; /* where to send printed output */ 137 int pa_logfd; /* output log file */ 138 char *pa_inputpath; /* path to input log */ 139 char *pa_outputpath; /* path to output log */ 140 void *pa_logparser; /* log file parser */ 141 const char *pa_fsroot; /* FS root where executables reside */ 142 char *pa_kernel; /* pathname of the kernel */ 143 const char *pa_samplesdir; /* directory for profile files */ 144 const char *pa_mapfilename;/* mapfile name */ 145 FILE *pa_graphfile; /* where to send the callgraph */ 146 int pa_graphdepth; /* print depth for callgraphs */ 147 double pa_interval; /* printing interval in seconds */ 148 cpuset_t pa_cpumask; /* filter for CPUs analysed */ 149 int pa_ctdumpinstr; /* dump instructions with calltree */ 150 int pa_topmode; /* delta or accumulative */ 151 int pa_toptty; /* output to tty or file */ 152 int pa_topcolor; /* terminal support color */ 153 int pa_mergepmc; /* merge PMC with same name */ 154 double pa_duration; /* time duration */ 155 int pa_argc; 156 char **pa_argv; 157 STAILQ_HEAD(, pmcstat_ev) pa_events; 158 SLIST_HEAD(, pmcstat_target) pa_targets; 159}; 160 161extern int pmcstat_displayheight; /* current terminal height */ 162extern int pmcstat_displaywidth; /* current terminal width */ 163extern struct pmcstat_args args; /* command line args */ 164 165/* Function prototypes */ 166void pmcstat_attach_pmcs(void); 167void pmcstat_cleanup(void); 168int pmcstat_close_log(void); 169void pmcstat_create_process(void); 170void pmcstat_find_targets(const char *_arg); 171void pmcstat_initialize_logging(void); 172void pmcstat_kill_process(void); 173int pmcstat_open_log(const char *_p, int _mode); 174void pmcstat_print_counters(void); 175void pmcstat_print_headers(void); 176void pmcstat_print_pmcs(void); 177void pmcstat_show_usage(void); 178void pmcstat_shutdown_logging(void); 179void pmcstat_start_pmcs(void); 180void pmcstat_start_process(void); 181int pmcstat_process_log(void); 182int pmcstat_keypress_log(void); 183void pmcstat_display_log(void); 184void pmcstat_pluginconfigure_log(char *_opt); 185void pmcstat_topexit(void); 186 187#endif /* _PMCSTAT_H_ */ 188