xref: /freebsd/usr.sbin/pmcstat/pmcstat.h (revision 38069501)
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 #include <libpmcstat.h>
37 
38 #define	DEFAULT_SAMPLE_COUNT		65536
39 #define	DEFAULT_WAIT_INTERVAL		5.0
40 #define	DEFAULT_DISPLAY_HEIGHT		256		/* file virtual height */
41 #define	DEFAULT_DISPLAY_WIDTH		1024		/* file virtual width */
42 #define	DEFAULT_BUFFER_SIZE		4096
43 #define	DEFAULT_CALLGRAPH_DEPTH		16
44 
45 #define	PRINT_HEADER_PREFIX		"# "
46 
47 #define	PMCSTAT_DEFAULT_NW_HOST		"localhost"
48 #define	PMCSTAT_DEFAULT_NW_PORT		"9000"
49 
50 #define	PMCSTAT_LDD_COMMAND		"/usr/bin/ldd"
51 
52 #define	PMCSTAT_PRINT_ENTRY(T,...) do {					\
53 		(void) fprintf(args.pa_printfile, "%-9s", T);		\
54 		(void) fprintf(args.pa_printfile, " "  __VA_ARGS__);	\
55 		(void) fprintf(args.pa_printfile, "\n");		\
56 	} while (0)
57 
58 #define PMCSTAT_PL_NONE		0
59 #define PMCSTAT_PL_CALLGRAPH	1
60 #define PMCSTAT_PL_GPROF	2
61 #define PMCSTAT_PL_ANNOTATE	3
62 #define PMCSTAT_PL_CALLTREE	4
63 #define PMCSTAT_PL_ANNOTATE_CG	5
64 
65 #define PMCSTAT_TOP_DELTA 	0
66 #define PMCSTAT_TOP_ACCUM	1
67 
68 extern int pmcstat_displayheight;	/* current terminal height */
69 extern int pmcstat_displaywidth;	/* current terminal width */
70 extern struct pmcstat_args args;	/* command line args */
71 
72 /* Function prototypes */
73 void	pmcstat_cleanup(void);
74 void	pmcstat_find_targets(const char *_arg);
75 void	pmcstat_kill_process(void);
76 void	pmcstat_print_counters(void);
77 void	pmcstat_print_headers(void);
78 void	pmcstat_print_pmcs(void);
79 void	pmcstat_show_usage(void);
80 void	pmcstat_start_pmcs(void);
81 int	pmcstat_process_log(void);
82 int	pmcstat_keypress_log(void);
83 void	pmcstat_display_log(void);
84 void	pmcstat_pluginconfigure_log(char *_opt);
85 void	pmcstat_topexit(void);
86 
87 void pmcstat_log_shutdown_logging(void);
88 void pmcstat_log_initialize_logging(void);
89 
90 #endif	/* _PMCSTAT_H_ */
91