[apple/xnu.git] / osfmk / profiling / i386 / profile-md.h

/*
 * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_LICENSE_HEADER_START@
 * 
 * The contents of this file constitute Original Code as defined in and
 * are subject to the Apple Public Source License Version 1.1 (the
 * "License").  You may not use this file except in compliance with the
 * License.  Please obtain a copy of the License at
 * http://www.apple.com/publicsource and read it before using this file.
 * 
 * This Original Code and all software distributed under the License are
 * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.  Please see the
 * License for the specific language governing rights and limitations
 * under the License.
 * 
 * @APPLE_LICENSE_HEADER_END@
 */
/*
 * @OSF_COPYRIGHT@
 */
/*
 * HISTORY
 * 
 * Revision 1.1.1.1  1998/09/22 21:05:49  wsanchez
 * Import of Mac OS X kernel (~semeria)
 *
 * Revision 1.1.1.1  1998/03/07 02:26:08  wsanchez
 * Import of OSF Mach kernel (~mburg)
 *
 * Revision 1.1.5.2  1996/07/31  09:57:36  paire
 * 	Added some more constraints to __asm__ functions for compilation
 * 	under gcc2.7.1 for PROF_CNT_[L]{ADD|SUB} macros
 * 	[96/06/14            paire]
 *
 * Revision 1.1.5.1  1995/01/06  19:53:52  devrcs
 * 	mk6 CR668 - 1.3b26 merge
 * 	new file for mk6
 * 	[1994/10/12  22:25:27  dwm]
 * 
 * Revision 1.1.2.2  1994/05/16  19:19:26  meissner
 * 	Add {,L}PROF_CNT_{SUB,LSUB,OVERFLOW} macros for gprof command.
 * 	[1994/05/10  10:36:06  meissner]
 * 
 * 	Correct 64-bit integer asms to specify result values as inputs, and use =g instead of =m.
 * 	Cast the integer argument to PROF_CNT_ADD to unsigned long, so a short register is widened.
 * 	Add more support for writing the gprof command.
 * 	PROF_CNT_{EQ,NE} should not use ^=, it just uses ^.
 * 	Round PROF_CNT_DIGITS up to 24 bytes so it is word aligned.
 * 	_profile_cnt_to_decimal now takes the low/high values as separate arguments.
 * 	Delete _profile_cnt_to_hex.
 * 	[1994/04/28  21:45:07  meissner]
 * 
 * 	Add more 64 bit arithmetic macros to support writing gprof.
 * 	[1994/04/20  15:47:05  meissner]
 * 
 * Revision 1.1.2.1  1994/04/08  17:51:56  meissner
 * 	Correct spelling on LPROF_CNT_TO_LDOUBLE macro.
 * 	[1994/04/08  16:18:06  meissner]
 * 
 * 	Make LHISTCOUNTER be 64 bits.
 * 	Define LPROF_CNT_INC to increment LHISTCOUNTER.
 * 	[1994/04/08  12:40:32  meissner]
 * 
 * 	Make most stats 64 bits, except for things like memory allocation.
 * 	[1994/04/02  14:58:34  meissner]
 * 
 * 	Add overflow support for {gprof,prof,old,dummy}_mcount counters.
 * 	[1994/03/17  20:13:37  meissner]
 * 
 * 	Add gprof/prof overflow support
 * 	[1994/03/17  14:56:56  meissner]
 * 
 * 	Define LHISTCOUNTER.
 * 	[1994/02/28  12:05:16  meissner]
 * 
 * 	Set HISTFRACTION to 4, so new lprofil call takes the same space.
 * 	[1994/02/24  16:15:34  meissner]
 * 
 * 	Add too_low/too_high to profile_stats.
 * 	[1994/02/16  22:38:23  meissner]
 * 
 * 	Make prof_cnt_t unsigned long.
 * 	[1994/02/11  16:52:09  meissner]
 * 
 * 	Remember function unique ptr in gfuncs structure to reset profiling.
 * 	Add support for range checking gprof arc {from,self}pc addresses.
 * 	Add counter for # times acontext was locked.
 * 	Expand copyright.
 * 	[1994/02/07  12:41:08  meissner]
 * 
 * 	Keep track of the number of times the kernel overflows the HISTCOUNTER counter.
 * 	[1994/02/03  20:13:31  meissner]
 * 
 * 	Add stats for {user,kernel,idle} mode in the kernel.
 * 	[1994/02/03  15:17:36  meissner]
 * 
 * 	No change.
 * 	[1994/02/03  00:58:59  meissner]
 * 
 * 	Combine _profile_{vars,stats,md}; Allow more than one _profile_vars.
 * 	[1994/02/01  12:04:04  meissner]
 * 
 * 	Split # records to # gprof and # prof records.
 * 	Add my_cpu/max_cpu fields.
 * 	[1994/01/28  23:33:30  meissner]
 * 
 * 	Eliminate hash_{size,mask} from gfuncs structure.
 * 	[1994/01/26  20:23:41  meissner]
 * 
 * 	Add structure size fields to _profile_{vars,stats,md}.
 * 	Add major/minor version number to _profile_md.
 * 	Move allocation context block pointer to main structure.
 * 	Delete shift count for allocation contexts.
 * 	[1994/01/25  01:46:08  meissner]
 * 
 * 	Add HASHFRACTION
 * 	[1994/01/22  01:14:02  meissner]
 * 
 * 	Split profile-md.h into profile-internal.h and profile-md.
 * 	[1994/01/20  20:57:18  meissner]
 * 
 * 	Fixup copyright.
 * 	[1994/01/18  23:08:14  meissner]
 * 
 * 	Make flags byte-sized.
 * 	Add have_bb flag.
 * 	Add init_format flag.
 * 	[1994/01/18  21:57:18  meissner]
 * 
 * 	CR 10198 - Initial version.
 * 	[1994/01/18  19:44:59  meissner]
 * 
 * $EndLog$
 */

#ifndef _PROFILE_MD_H
#define _PROFILE_MD_H

#include <types.h>

/*
 * Define the interfaces between the assembly language profiling support
 * that is common between the kernel, mach servers, and user space library.
 */

/*
 * Integer types used.
 */

typedef	long		prof_ptrint_t;	/* hold either pointer or signed int */
typedef	unsigned long	prof_uptrint_t;	/* hold either pointer or unsigned int */
typedef	long		prof_lock_t;	/* lock word type */
typedef unsigned char	prof_flag_t;	/* type for boolean flags */

/*
 * Double precision counter.
 */

typedef struct prof_cnt_t {
	prof_uptrint_t	low;		/* low 32 bits of counter */
	prof_uptrint_t	high;		/* high 32 bits of counter */
} prof_cnt_t;

#if defined(__GNUC__) && !defined(lint)
#define PROF_CNT_INC(cnt)					\
	__asm__("addl $1,%0; adcl $0,%1"			\
		: "=g" ((cnt).low), "=g" ((cnt).high)		\
		: "0" ((cnt).low), "1" ((cnt).high))

#define PROF_CNT_ADD(cnt,val)					\
	__asm__("addl %2,%0; adcl $0,%1"			\
		: "=g,r" ((cnt).low), "=g,r" ((cnt).high)	\
		: "r,g" ((unsigned long)(val)),			\
		"0,0" ((cnt).low), "1,1" ((cnt).high))

#define PROF_CNT_LADD(cnt,val)					\
	__asm__("addl %2,%0; adcl %3,%1"			\
		: "=g,r" ((cnt).low), "=g,r" ((cnt).high)	\
		: "r,g" ((val).low), "r,g" ((val).high),	\
		"0,0" ((cnt).low), "1,1" ((cnt).high))

#define PROF_CNT_SUB(cnt,val)					\
	__asm__("subl %2,%0; sbbl $0,%1"			\
		: "=g,r" ((cnt).low), "=g,r" ((cnt).high)	\
		: "r,g" ((unsigned long)(val)),			\
		"0,0" ((cnt).low), "1,1" ((cnt).high))

#define PROF_CNT_LSUB(cnt,val)					\
	__asm__("subl %2,%0; sbbl %3,%1"			\
		: "=g,r" ((cnt).low), "=g,r" ((cnt).high)	\
		: "r,g" ((val).low), "r,g" ((val).high),	\
		"0,0" ((cnt).low), "1,1" ((cnt).high))

#else
#define PROF_CNT_INC(cnt)	((++((cnt).low) == 0) ? ++((cnt).high) : 0)
#define PROF_CNT_ADD(cnt,val)	(((((cnt).low + (val)) < (val)) ? ((cnt).high++) : 0), ((cnt).low += (val)))
#define PROF_CNT_LADD(cnt,val)	(PROF_CNT_ADD(cnt,(val).low), (cnt).high += (val).high)
#define PROF_CNT_SUB(cnt,val)	(((((cnt).low - (val)) > (cnt).low) ? ((cnt).high--) : 0), ((cnt).low -= (val)))
#define PROF_CNT_LSUB(cnt,val)	(PROF_CNT_SUB(cnt,(val).low), (cnt).high -= (val).high)
#endif

#define PROF_ULONG_TO_CNT(cnt,val)	(((cnt).high = 0), ((cnt).low = val))
#define	PROF_CNT_OVERFLOW(cnt,high,low)	(((high) = (cnt).high), ((low) = (cnt).low))
#define PROF_CNT_TO_ULONG(cnt)		(((cnt).high == 0) ? (cnt).low : 0xffffffffu)
#define PROF_CNT_TO_LDOUBLE(cnt)	((((long double)(cnt).high) * 4294967296.0L) + (long double)(cnt).low)
#define PROF_CNT_TO_DECIMAL(buf,cnt)	_profile_cnt_to_decimal(buf, (cnt).low, (cnt).high)
#define PROF_CNT_EQ_0(cnt)		(((cnt).high | (cnt).low) == 0)
#define PROF_CNT_NE_0(cnt)		(((cnt).high | (cnt).low) != 0)
#define PROF_CNT_EQ(cnt1,cnt2)		((((cnt1).high ^ (cnt2).high) | ((cnt1).low ^ (cnt2).low)) == 0)
#define PROF_CNT_NE(cnt1,cnt2)		((((cnt1).high ^ (cnt2).high) | ((cnt1).low ^ (cnt2).low)) != 0)
#define PROF_CNT_GT(cnt1,cnt2)		(((cnt1).high > (cnt2).high) || ((cnt1).low > (cnt2).low))
#define PROF_CNT_LT(cnt1,cnt2)		(((cnt1).high < (cnt2).high) || ((cnt1).low < (cnt2).low))

/* max # digits + null to hold prof_cnt_t values (round up to multiple of 4) */
#define PROF_CNT_DIGITS			24

/*
 * Types of the profil counter.
 */

typedef unsigned short	HISTCOUNTER;		/* profil */
typedef prof_cnt_t	LHISTCOUNTER;		/* lprofil */

#define LPROF_ULONG_TO_CNT(cnt,val)	PROF_ULONG_TO_CNT(cnt,val)
#define LPROF_CNT_INC(lp)		PROF_CNT_INC(lp)
#define LPROF_CNT_ADD(lp,val)		PROF_CNT_ADD(lp,val)
#define LPROF_CNT_LADD(lp,val)		PROF_CNT_LADD(lp,val)
#define LPROF_CNT_SUB(lp,val)		PROF_CNT_SUB(lp,val)
#define LPROF_CNT_LSUB(lp,val)		PROF_CNT_LSUB(lp,val)
#define	LPROF_CNT_OVERFLOW(lp,high,low)	PROF_CNT_OVERFLOW(lp,high,low)
#define LPROF_CNT_TO_ULONG(lp)		PROF_CNT_TO_ULONG(lp)
#define LPROF_CNT_TO_LDOUBLE(lp)	PROF_CNT_TO_LDOUBLE(lp)
#define LPROF_CNT_TO_DECIMAL(buf,cnt)	PROF_CNT_TO_DECIMAL(buf,cnt)
#define LPROF_CNT_EQ_0(cnt)		PROF_CNT_EQ_0(cnt)
#define LPROF_CNT_NE_0(cnt)		PROF_CNT_NE_0(cnt)
#define LPROF_CNT_EQ(cnt1,cnt2)		PROF_CNT_EQ(cnt1,cnt2)
#define LPROF_CNT_NE(cnt1,cnt2)		PROF_CNT_NE(cnt1,cnt2)
#define LPROF_CNT_GT(cnt1,cnt2)		PROF_CNT_GT(cnt1,cnt2)
#define LPROF_CNT_LT(cnt1,cnt2)		PROF_CNT_LT(cnt1,cnt2)
#define LPROF_CNT_DIGITS		PROF_CNT_DIGITS

/*
 *  fraction of text space to allocate for histogram counters
 */

#define HISTFRACTION    4

/*
 * Fraction of text space to allocate for from hash buckets.
 */

#define HASHFRACTION	HISTFRACTION

/*
 * Prof call count, external format.
 */

struct prof_ext {
	prof_uptrint_t	cvalue;		/* caller address */
	prof_uptrint_t	cncall;		/* # of calls */
};

/*
 * Prof call count, internal format.
 */

struct prof_int {
	struct prof_ext	prof;		/* external prof struct */
	prof_uptrint_t	overflow;	/* # times prof counter overflowed */
};

/*
 * Gprof arc, external format.
 */

struct gprof_arc {
	prof_uptrint_t	 frompc;	/* caller's caller */
	prof_uptrint_t	 selfpc;	/* caller's address */
	prof_uptrint_t	 count;		/* # times arc traversed */
};

/*
 * Gprof arc, internal format.
 */

struct hasharc {
	struct hasharc	*next;		/* next gprof record */
	struct gprof_arc arc;		/* gprof record */
	prof_uptrint_t	 overflow;	/* # times counter overflowed */
};

/*
 * Linked list of all function profile blocks.
 */

#define MAX_CACHE	3		/* # cache table entries */

struct gfuncs {
	struct hasharc **hash_ptr;		/* gprof hash table */
	struct hasharc **unique_ptr; 		/* function unique pointer */
	struct prof_int prof;			/* -p stats for elf */
	struct hasharc *cache_ptr[MAX_CACHE];	/* cache element pointers */
};

/*
 * Profile information which might be written out in ELF {,g}mon.out files.
 */

#define MAX_BUCKETS 9			/* max bucket chain to print out */

struct profile_stats {			/* Debugging counters */
	prof_uptrint_t major_version;	/* major version number */
	prof_uptrint_t minor_version;	/* minor version number */
	prof_uptrint_t stats_size;	/* size of profile_vars structure */
	prof_uptrint_t profil_buckets; 	/* # profil buckets */
	prof_uptrint_t my_cpu;		/* identify current cpu/thread */
	prof_uptrint_t max_cpu;		/* identify max cpu/thread */
	prof_uptrint_t prof_records;	/* # of functions profiled */
	prof_uptrint_t gprof_records;	/* # of gprof arcs */
	prof_uptrint_t hash_buckets;	/* # gprof hash buckets */
	prof_uptrint_t bogus_count;	/* # of bogus functions found in gprof */

	prof_cnt_t cnt;			/* # of calls to _{,g}prof_mcount */
	prof_cnt_t dummy;		/* # of calls to _dummy_mcount */
	prof_cnt_t old_mcount;		/* # of calls to old mcount */
	prof_cnt_t hash_search;		/* # hash buckets searched */
	prof_cnt_t hash_num;		/* # times hash table searched */
	prof_cnt_t user_ticks;		/* # ticks in user space */
	prof_cnt_t kernel_ticks;	/* # ticks in kernel space */
	prof_cnt_t idle_ticks;		/* # ticks in idle mode */
	prof_cnt_t overflow_ticks;	/* # ticks where HISTCOUNTER overflowed */
	prof_cnt_t acontext_locked;	/* # times an acontext was locked */
	prof_cnt_t too_low;		/* # times a histogram tick was too low */
	prof_cnt_t too_high;		/* # times a histogram tick was too high */
	prof_cnt_t prof_overflow;	/* # times a prof count field overflowed */
	prof_cnt_t gprof_overflow;	/* # times a gprof count field overflowed */

					/* allocation statistics */
	prof_uptrint_t num_alloc  [(int)ACONTEXT_MAX];	/* # allocations */
	prof_uptrint_t bytes_alloc[(int)ACONTEXT_MAX];	/* bytes allocated */
	prof_uptrint_t num_context[(int)ACONTEXT_MAX];	/* # contexts */
	prof_uptrint_t wasted     [(int)ACONTEXT_MAX];	/* wasted bytes */
	prof_uptrint_t overhead   [(int)ACONTEXT_MAX];	/* overhead bytes */

	prof_uptrint_t buckets[MAX_BUCKETS+1]; /* # hash indexes that have n buckets */
	prof_cnt_t     cache_hits[MAX_CACHE];  /* # times nth cache entry matched */

	prof_cnt_t stats_unused[64];	/* reserved for future use */
};

#define PROFILE_MAJOR_VERSION 1
#define PROFILE_MINOR_VERSION 1

/*
 * Machine dependent fields.
 */

struct profile_md {
	int major_version;		/* major version number */
	int minor_version;		/* minor version number */
	size_t md_size;			/* size of profile_md structure */
	struct hasharc **hash_ptr;	/* gprof hash table */
	size_t hash_size;		/* size of hash table */
	prof_uptrint_t num_cache;	/* # of cache entries */
	void (*save_mcount_ptr)(void);	/* save for _mcount_ptr */
	void (**mcount_ptr_ptr)(void);	/* pointer to _mcount_ptr */
	struct hasharc *dummy_ptr;	/* pointer to dummy gprof record */
	void *(*alloc_pages)(size_t);	/* pointer to _profile_alloc_pages */
	char num_buffer[PROF_CNT_DIGITS]; /* convert 64 bit ints to string */
	long md_unused[58];		/* add unused fields */
};

/*
 * Record information about each function call.  Specify
 * caller, caller's caller, and a unique label for use by
 * the profiling routines.
 */
extern void _prof_mcount(void);
extern void _gprof_mcount(void);
extern void _dummy_mcount(void);
extern void (*_mcount_ptr)(void);

/*
 * Function in profile-md.c to convert prof_cnt_t to string format (decimal & hex).
 */
extern char *_profile_cnt_to_decimal(char *, prof_uptrint_t, prof_uptrint_t);

#endif /* _PROFILE_MD_H */
Commit	Line	Data
1c79356b A	1	/*
	2	* Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
	3	*
6601e61a	4	* @APPLE_LICENSE_HEADER_START@
1c79356b	5	*
6601e61a A	6	* The contents of this file constitute Original Code as defined in and
	7	* are subject to the Apple Public Source License Version 1.1 (the
	8	* "License"). You may not use this file except in compliance with the
	9	* License. Please obtain a copy of the License at
	10	* http://www.apple.com/publicsource and read it before using this file.
8f6c56a5	11	*
6601e61a A	12	* This Original Code and all software distributed under the License are
6601e61a A	13	* distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
8f6c56a5 A	14	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
8f6c56a5 A	15	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
6601e61a A	16	* FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT. Please see the
	17	* License for the specific language governing rights and limitations
	18	* under the License.
8f6c56a5	19	*
6601e61a	20	* @APPLE_LICENSE_HEADER_END@
1c79356b A	21	*/
	22	/*
	23	* @OSF_COPYRIGHT@
	24	*/
	25	/*
	26	* HISTORY
	27	*
	28	* Revision 1.1.1.1 1998/09/22 21:05:49 wsanchez
	29	* Import of Mac OS X kernel (~semeria)
	30	*
	31	* Revision 1.1.1.1 1998/03/07 02:26:08 wsanchez
	32	* Import of OSF Mach kernel (~mburg)
	33	*
	34	* Revision 1.1.5.2 1996/07/31 09:57:36 paire
	35	* Added some more constraints to __asm__ functions for compilation
	36	* under gcc2.7.1 for PROF_CNT_[L]{ADD\|SUB} macros
	37	* [96/06/14 paire]
	38	*
	39	* Revision 1.1.5.1 1995/01/06 19:53:52 devrcs
	40	* mk6 CR668 - 1.3b26 merge
	41	* new file for mk6
	42	* [1994/10/12 22:25:27 dwm]
	43	*
	44	* Revision 1.1.2.2 1994/05/16 19:19:26 meissner
	45	* Add {,L}PROF_CNT_{SUB,LSUB,OVERFLOW} macros for gprof command.
	46	* [1994/05/10 10:36:06 meissner]
	47	*
	48	* Correct 64-bit integer asms to specify result values as inputs, and use =g instead of =m.
	49	* Cast the integer argument to PROF_CNT_ADD to unsigned long, so a short register is widened.
	50	* Add more support for writing the gprof command.
	51	* PROF_CNT_{EQ,NE} should not use ^=, it just uses ^.
	52	* Round PROF_CNT_DIGITS up to 24 bytes so it is word aligned.
	53	* _profile_cnt_to_decimal now takes the low/high values as separate arguments.
	54	* Delete _profile_cnt_to_hex.
	55	* [1994/04/28 21:45:07 meissner]
	56	*
	57	* Add more 64 bit arithmetic macros to support writing gprof.
	58	* [1994/04/20 15:47:05 meissner]
	59	*
	60	* Revision 1.1.2.1 1994/04/08 17:51:56 meissner
	61	* Correct spelling on LPROF_CNT_TO_LDOUBLE macro.
	62	* [1994/04/08 16:18:06 meissner]
	63	*
	64	* Make LHISTCOUNTER be 64 bits.
	65	* Define LPROF_CNT_INC to increment LHISTCOUNTER.
	66	* [1994/04/08 12:40:32 meissner]
	67	*
	68	* Make most stats 64 bits, except for things like memory allocation.
	69	* [1994/04/02 14:58:34 meissner]
	70	*
	71	* Add overflow support for {gprof,prof,old,dummy}_mcount counters.
	72	* [1994/03/17 20:13:37 meissner]
	73	*
	74	* Add gprof/prof overflow support
	75	* [1994/03/17 14:56:56 meissner]
	76	*
	77	* Define LHISTCOUNTER.
	78	* [1994/02/28 12:05:16 meissner]
	79	*
	80	* Set HISTFRACTION to 4, so new lprofil call takes the same space.
	81	* [1994/02/24 16:15:34 meissner]
	82	*
	83	* Add too_low/too_high to profile_stats.
	84	* [1994/02/16 22:38:23 meissner]
85	*
86	* Make prof_cnt_t unsigned long.
87	* [1994/02/11 16:52:09 meissner]
88	*
89	* Remember function unique ptr in gfuncs structure to reset profiling.
90	* Add support for range checking gprof arc {from,self}pc addresses.
91	* Add counter for # times acontext was locked.
92	* Expand copyright.
93	* [1994/02/07 12:41:08 meissner]
94	*
95	* Keep track of the number of times the kernel overflows the HISTCOUNTER counter.
96	* [1994/02/03 20:13:31 meissner]
97	*
98	* Add stats for {user,kernel,idle} mode in the kernel.
99	* [1994/02/03 15:17:36 meissner]
100	*
101	* No change.
102	* [1994/02/03 00:58:59 meissner]
103	*
104	* Combine _profile_{vars,stats,md}; Allow more than one _profile_vars.
105	* [1994/02/01 12:04:04 meissner]
106	*
107	* Split # records to # gprof and # prof records.
108	* Add my_cpu/max_cpu fields.
109	* [1994/01/28 23:33:30 meissner]
110	*
111	* Eliminate hash_{size,mask} from gfuncs structure.
112	* [1994/01/26 20:23:41 meissner]
113	*
114	* Add structure size fields to _profile_{vars,stats,md}.
115	* Add major/minor version number to _profile_md.
116	* Move allocation context block pointer to main structure.
117	* Delete shift count for allocation contexts.
118	* [1994/01/25 01:46:08 meissner]
119	*
120	* Add HASHFRACTION
121	* [1994/01/22 01:14:02 meissner]
122	*
123	* Split profile-md.h into profile-internal.h and profile-md.
124	* [1994/01/20 20:57:18 meissner]
125	*
126	* Fixup copyright.
127	* [1994/01/18 23:08:14 meissner]
128	*
129	* Make flags byte-sized.
130	* Add have_bb flag.
131	* Add init_format flag.
132	* [1994/01/18 21:57:18 meissner]
133	*
134	* CR 10198 - Initial version.
135	* [1994/01/18 19:44:59 meissner]
136	*
137	* $EndLog$
138	*/
139
140	#ifndef _PROFILE_MD_H
141	#define _PROFILE_MD_H
142
55e303ae A	143	#include <types.h>
55e303ae A	144
1c79356b A	145	/*
	146	* Define the interfaces between the assembly language profiling support
	147	* that is common between the kernel, mach servers, and user space library.
	148	*/
	149
	150	/*
	151	* Integer types used.
	152	*/
	153
	154	typedef long prof_ptrint_t; /* hold either pointer or signed int */
	155	typedef unsigned long prof_uptrint_t; /* hold either pointer or unsigned int */
	156	typedef long prof_lock_t; /* lock word type */
	157	typedef unsigned char prof_flag_t; /* type for boolean flags */
	158
	159	/*
	160	* Double precision counter.
	161	*/
	162
	163	typedef struct prof_cnt_t {
	164	prof_uptrint_t low; /* low 32 bits of counter */
	165	prof_uptrint_t high; /* high 32 bits of counter */
	166	} prof_cnt_t;
	167
	168	#if defined(__GNUC__) && !defined(lint)
	169	#define PROF_CNT_INC(cnt) \
	170	__asm__("addl $1,%0; adcl $0,%1" \
	171	: "=g" ((cnt).low), "=g" ((cnt).high) \
	172	: "0" ((cnt).low), "1" ((cnt).high))
	173
	174	#define PROF_CNT_ADD(cnt,val) \
	175	__asm__("addl %2,%0; adcl $0,%1" \
	176	: "=g,r" ((cnt).low), "=g,r" ((cnt).high) \
	177	: "r,g" ((unsigned long)(val)), \
	178	"0,0" ((cnt).low), "1,1" ((cnt).high))
	179
	180	#define PROF_CNT_LADD(cnt,val) \
	181	__asm__("addl %2,%0; adcl %3,%1" \
	182	: "=g,r" ((cnt).low), "=g,r" ((cnt).high) \
	183	: "r,g" ((val).low), "r,g" ((val).high), \
	184	"0,0" ((cnt).low), "1,1" ((cnt).high))
	185
	186	#define PROF_CNT_SUB(cnt,val) \
	187	__asm__("subl %2,%0; sbbl $0,%1" \
	188	: "=g,r" ((cnt).low), "=g,r" ((cnt).high) \
	189	: "r,g" ((unsigned long)(val)), \
	190	"0,0" ((cnt).low), "1,1" ((cnt).high))
	191
	192	#define PROF_CNT_LSUB(cnt,val) \
	193	__asm__("subl %2,%0; sbbl %3,%1" \
	194	: "=g,r" ((cnt).low), "=g,r" ((cnt).high) \
	195	: "r,g" ((val).low), "r,g" ((val).high), \
	196	"0,0" ((cnt).low), "1,1" ((cnt).high))
	197
	198	#else
	199	#define PROF_CNT_INC(cnt) ((++((cnt).low) == 0) ? ++((cnt).high) : 0)
	200	#define PROF_CNT_ADD(cnt,val) (((((cnt).low + (val)) < (val)) ? ((cnt).high++) : 0), ((cnt).low += (val)))
	201	#define PROF_CNT_LADD(cnt,val) (PROF_CNT_ADD(cnt,(val).low), (cnt).high += (val).high)
	202	#define PROF_CNT_SUB(cnt,val) (((((cnt).low - (val)) > (cnt).low) ? ((cnt).high--) : 0), ((cnt).low -= (val)))
	203	#define PROF_CNT_LSUB(cnt,val) (PROF_CNT_SUB(cnt,(val).low), (cnt).high -= (val).high)
	204	#endif
	205
	206	#define PROF_ULONG_TO_CNT(cnt,val) (((cnt).high = 0), ((cnt).low = val))
	207	#define PROF_CNT_OVERFLOW(cnt,high,low) (((high) = (cnt).high), ((low) = (cnt).low))
	208	#define PROF_CNT_TO_ULONG(cnt) (((cnt).high == 0) ? (cnt).low : 0xffffffffu)
209	#define PROF_CNT_TO_LDOUBLE(cnt) ((((long double)(cnt).high) * 4294967296.0L) + (long double)(cnt).low)
210	#define PROF_CNT_TO_DECIMAL(buf,cnt) _profile_cnt_to_decimal(buf, (cnt).low, (cnt).high)
211	#define PROF_CNT_EQ_0(cnt) (((cnt).high \| (cnt).low) == 0)
212	#define PROF_CNT_NE_0(cnt) (((cnt).high \| (cnt).low) != 0)
213	#define PROF_CNT_EQ(cnt1,cnt2) ((((cnt1).high ^ (cnt2).high) \| ((cnt1).low ^ (cnt2).low)) == 0)
214	#define PROF_CNT_NE(cnt1,cnt2) ((((cnt1).high ^ (cnt2).high) \| ((cnt1).low ^ (cnt2).low)) != 0)
215	#define PROF_CNT_GT(cnt1,cnt2) (((cnt1).high > (cnt2).high) \|\| ((cnt1).low > (cnt2).low))
216	#define PROF_CNT_LT(cnt1,cnt2) (((cnt1).high < (cnt2).high) \|\| ((cnt1).low < (cnt2).low))
217
218	/* max # digits + null to hold prof_cnt_t values (round up to multiple of 4) */
219	#define PROF_CNT_DIGITS 24
220
221	/*
222	* Types of the profil counter.
223	*/
224
225	typedef unsigned short HISTCOUNTER; /* profil */
226	typedef prof_cnt_t LHISTCOUNTER; /* lprofil */
227
228	#define LPROF_ULONG_TO_CNT(cnt,val) PROF_ULONG_TO_CNT(cnt,val)
229	#define LPROF_CNT_INC(lp) PROF_CNT_INC(lp)
230	#define LPROF_CNT_ADD(lp,val) PROF_CNT_ADD(lp,val)
231	#define LPROF_CNT_LADD(lp,val) PROF_CNT_LADD(lp,val)
232	#define LPROF_CNT_SUB(lp,val) PROF_CNT_SUB(lp,val)
233	#define LPROF_CNT_LSUB(lp,val) PROF_CNT_LSUB(lp,val)
234	#define LPROF_CNT_OVERFLOW(lp,high,low) PROF_CNT_OVERFLOW(lp,high,low)
235	#define LPROF_CNT_TO_ULONG(lp) PROF_CNT_TO_ULONG(lp)
236	#define LPROF_CNT_TO_LDOUBLE(lp) PROF_CNT_TO_LDOUBLE(lp)
237	#define LPROF_CNT_TO_DECIMAL(buf,cnt) PROF_CNT_TO_DECIMAL(buf,cnt)
238	#define LPROF_CNT_EQ_0(cnt) PROF_CNT_EQ_0(cnt)
239	#define LPROF_CNT_NE_0(cnt) PROF_CNT_NE_0(cnt)
240	#define LPROF_CNT_EQ(cnt1,cnt2) PROF_CNT_EQ(cnt1,cnt2)
241	#define LPROF_CNT_NE(cnt1,cnt2) PROF_CNT_NE(cnt1,cnt2)
242	#define LPROF_CNT_GT(cnt1,cnt2) PROF_CNT_GT(cnt1,cnt2)
243	#define LPROF_CNT_LT(cnt1,cnt2) PROF_CNT_LT(cnt1,cnt2)
244	#define LPROF_CNT_DIGITS PROF_CNT_DIGITS
245
246	/*
247	* fraction of text space to allocate for histogram counters
248	*/
249
250	#define HISTFRACTION 4
251
252	/*
253	* Fraction of text space to allocate for from hash buckets.
254	*/
255
256	#define HASHFRACTION HISTFRACTION
257
258	/*
259	* Prof call count, external format.
260	*/
261
262	struct prof_ext {
263	prof_uptrint_t cvalue; /* caller address */
264	prof_uptrint_t cncall; /* # of calls */
265	};
266
267	/*
268	* Prof call count, internal format.
269	*/
270
271	struct prof_int {
272	struct prof_ext prof; /* external prof struct */
273	prof_uptrint_t overflow; /* # times prof counter overflowed */
274	};
275
276	/*
277	* Gprof arc, external format.
278	*/
279
280	struct gprof_arc {
281	prof_uptrint_t frompc; /* caller's caller */
282	prof_uptrint_t selfpc; /* caller's address */
283	prof_uptrint_t count; /* # times arc traversed */
284	};
285
286	/*
287	* Gprof arc, internal format.
288	*/
289
290	struct hasharc {
291	struct hasharc next; / next gprof record */
292	struct gprof_arc arc; /* gprof record */
293	prof_uptrint_t overflow; /* # times counter overflowed */
294	};
295
296	/*
297	* Linked list of all function profile blocks.
298	*/
299
300	#define MAX_CACHE 3 /* # cache table entries */
301
302	struct gfuncs {
303	struct hasharc *hash_ptr; / gprof hash table */
304	struct hasharc *unique_ptr; / function unique pointer */
305	struct prof_int prof; /* -p stats for elf */
306	struct hasharc cache_ptr[MAX_CACHE]; / cache element pointers */
307	};
308
309	/*
310	* Profile information which might be written out in ELF {,g}mon.out files.
311	*/
312
313	#define MAX_BUCKETS 9 /* max bucket chain to print out */
314
315	struct profile_stats { /* Debugging counters */
316	prof_uptrint_t major_version; /* major version number */
317	prof_uptrint_t minor_version; /* minor version number */
318	prof_uptrint_t stats_size; /* size of profile_vars structure */
319	prof_uptrint_t profil_buckets; /* # profil buckets */
320	prof_uptrint_t my_cpu; /* identify current cpu/thread */
321	prof_uptrint_t max_cpu; /* identify max cpu/thread */
322	prof_uptrint_t prof_records; /* # of functions profiled */
323	prof_uptrint_t gprof_records; /* # of gprof arcs */
324	prof_uptrint_t hash_buckets; /* # gprof hash buckets */
325	prof_uptrint_t bogus_count; /* # of bogus functions found in gprof */
326
327	prof_cnt_t cnt; /* # of calls to _{,g}prof_mcount */
328	prof_cnt_t dummy; /* # of calls to _dummy_mcount */
329	prof_cnt_t old_mcount; /* # of calls to old mcount */
330	prof_cnt_t hash_search; /* # hash buckets searched */
331	prof_cnt_t hash_num; /* # times hash table searched */
332	prof_cnt_t user_ticks; /* # ticks in user space */
333	prof_cnt_t kernel_ticks; /* # ticks in kernel space */
334	prof_cnt_t idle_ticks; /* # ticks in idle mode */
335	prof_cnt_t overflow_ticks; /* # ticks where HISTCOUNTER overflowed */
336	prof_cnt_t acontext_locked; /* # times an acontext was locked */
337	prof_cnt_t too_low; /* # times a histogram tick was too low */
338	prof_cnt_t too_high; /* # times a histogram tick was too high */
339	prof_cnt_t prof_overflow; /* # times a prof count field overflowed */
340	prof_cnt_t gprof_overflow; /* # times a gprof count field overflowed */
341
342	/* allocation statistics */
343	prof_uptrint_t num_alloc [(int)ACONTEXT_MAX]; /* # allocations */
344	prof_uptrint_t bytes_alloc[(int)ACONTEXT_MAX]; /* bytes allocated */
345	prof_uptrint_t num_context[(int)ACONTEXT_MAX]; /* # contexts */
346	prof_uptrint_t wasted [(int)ACONTEXT_MAX]; /* wasted bytes */
347	prof_uptrint_t overhead [(int)ACONTEXT_MAX]; /* overhead bytes */
348
349	prof_uptrint_t buckets[MAX_BUCKETS+1]; /* # hash indexes that have n buckets */
350	prof_cnt_t cache_hits[MAX_CACHE]; /* # times nth cache entry matched */
351
352	prof_cnt_t stats_unused[64]; /* reserved for future use */
353	};
354
355	#define PROFILE_MAJOR_VERSION 1
356	#define PROFILE_MINOR_VERSION 1
357
358	/*
359	* Machine dependent fields.
360	*/
361
362	struct profile_md {
363	int major_version; /* major version number */
364	int minor_version; /* minor version number */
365	size_t md_size; /* size of profile_md structure */
366	struct hasharc *hash_ptr; / gprof hash table */
367	size_t hash_size; /* size of hash table */
368	prof_uptrint_t num_cache; /* # of cache entries */
369	void (save_mcount_ptr)(void); / save for _mcount_ptr */
370	void (*mcount_ptr_ptr)(void); / pointer to _mcount_ptr */
371	struct hasharc dummy_ptr; / pointer to dummy gprof record */
372	void (alloc_pages)(size_t); /* pointer to _profile_alloc_pages */
373	char num_buffer[PROF_CNT_DIGITS]; /* convert 64 bit ints to string */
374	long md_unused[58]; /* add unused fields */
375	};
376
377	/*
378	* Record information about each function call. Specify
379	* caller, caller's caller, and a unique label for use by
380	* the profiling routines.
381	*/
382	extern void _prof_mcount(void);
383	extern void _gprof_mcount(void);
384	extern void _dummy_mcount(void);
385	extern void (*_mcount_ptr)(void);
386
387	/*
388	* Function in profile-md.c to convert prof_cnt_t to string format (decimal & hex).
389	*/
390	extern char _profile_cnt_to_decimal(char , prof_uptrint_t, prof_uptrint_t);
391
392	#endif /* _PROFILE_MD_H */