[apple/xnu.git] / bsd / sys / trace.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@
 */
/* Copyright (c) 1995 NeXT Computer, Inc. All Rights Reserved */
/*-
 * Copyright (c) 1982, 1986, 1993
 *	The Regents of the University of California.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *	This product includes software developed by the University of
 *	California, Berkeley and its contributors.
 * 4. Neither the name of the University nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 *	@(#)trace.h	8.1 (Berkeley) 6/2/93
 */

#ifndef _SYS_TRACE_H_
#define	_SYS_TRACE_H_

/*
 * File system buffer tracing points; all trace <pack(dev, size), bn>
 */
#define	TR_BREADHIT	0	/* buffer read found in cache */
#define	TR_BREADMISS	1	/* buffer read not in cache */
#define	TR_BWRITE	2	/* buffer written */
#define	TR_BREADHITRA	3	/* buffer read-ahead found in cache */
#define	TR_BREADMISSRA	4	/* buffer read-ahead not in cache */
#define	TR_XFODMISS	5	/* exe fod read */
#define	TR_XFODHIT	6	/* exe fod read */
#define	TR_BRELSE	7	/* brelse */
#define	TR_BREALLOC	8	/* expand/contract a buffer */

/*
 * Memory allocator trace points; all trace the amount of memory involved
 */
#define	TR_MALL		10	/* memory allocated */

/*
 * Paging trace points: all are <vaddr, pid>
 */
#define	TR_INTRANS	20	/* page intransit block */
#define	TR_EINTRANS	21	/* page intransit wait done */
#define	TR_FRECLAIM	22	/* reclaim from free list */
#define	TR_RECLAIM	23	/* reclaim from loop */
#define	TR_XSFREC	24	/* reclaim from free list instead of drum */
#define	TR_XIFREC	25	/* reclaim from free list instead of fsys */
#define	TR_WAITMEM	26	/* wait for memory in pagein */
#define	TR_EWAITMEM	27	/* end memory wait in pagein */
#define	TR_ZFOD		28	/* zfod page fault */
#define	TR_EXFOD	29	/* exec fod page fault */
#define	TR_VRFOD	30	/* vread fod page fault */
#define	TR_CACHEFOD	31	/* fod in file system cache */
#define	TR_SWAPIN	32	/* drum page fault */
#define	TR_PGINDONE	33	/* page in done */
#define	TR_SWAPIO	34	/* swap i/o request arrives */

/*
 * System call trace points.
 */
#define	TR_VADVISE	40	/* vadvise occurred with <arg, pid> */

/*
 * Miscellaneous
 */
#define	TR_STAMP	45	/* user said vtrace(VTR_STAMP, value); */

/*
 * This defines the size of the trace flags array.
 */
#define	TR_NFLAGS	100	/* generous */

#define	TRCSIZ		4096

/*
 * Specifications of the vtrace() system call, which takes one argument.
 */
#define	VTRACE		64+51

#define	VTR_DISABLE	0		/* set a trace flag to 0 */
#define	VTR_ENABLE	1		/* set a trace flag to 1 */
#define	VTR_VALUE	2		/* return value of a trace flag */
#define	VTR_UALARM	3		/* set alarm to go off (sig 16) */
					/* in specified number of hz */
#define	VTR_STAMP	4		/* user specified stamp */

#ifdef KERNEL
#if TRACE
extern struct	proc *traceproc;
extern int	tracewhich, tracebuf[TRCSIZ];
extern u_int	tracex;
extern char	traceflags[TR_NFLAGS];
#define	pack(v,b)	(((v)->v_mount->mnt_stat.f_fsid.val[0])<<16)|(b)
#define	trace(a,b,c) {							\
	if (traceflags[a])						\
		trace1(a,b,c);						\
}
#else
#define	trace(a,b,c)
#endif
#endif /* KERNEL */
#endif /* !_SYS_TRACE_H_ */
Commit	Line	Data
1c79356b A	1	/*
	2	* Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
	3	*
	4	* @APPLE_LICENSE_HEADER_START@
	5	*
	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.
	11	*
	12	* This Original Code and all software distributed under the License are
	13	* distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
	14	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
	15	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
	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.
	19	*
	20	* @APPLE_LICENSE_HEADER_END@
	21	*/
	22	/* Copyright (c) 1995 NeXT Computer, Inc. All Rights Reserved */
	23	/*-
	24	* Copyright (c) 1982, 1986, 1993
	25	* The Regents of the University of California. All rights reserved.
	26	*
	27	* Redistribution and use in source and binary forms, with or without
	28	* modification, are permitted provided that the following conditions
	29	* are met:
	30	* 1. Redistributions of source code must retain the above copyright
	31	* notice, this list of conditions and the following disclaimer.
	32	* 2. Redistributions in binary form must reproduce the above copyright
	33	* notice, this list of conditions and the following disclaimer in the
	34	* documentation and/or other materials provided with the distribution.
	35	* 3. All advertising materials mentioning features or use of this software
	36	* must display the following acknowledgement:
	37	* This product includes software developed by the University of
	38	* California, Berkeley and its contributors.
	39	* 4. Neither the name of the University nor the names of its contributors
	40	* may be used to endorse or promote products derived from this software
	41	* without specific prior written permission.
	42	*
	43	* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
	44	* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	45	* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	46	* ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
	47	* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	48	* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	49	* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	50	* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	51	* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	52	* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	53	* SUCH DAMAGE.
	54	*
	55	* @(#)trace.h 8.1 (Berkeley) 6/2/93
	56	*/
	57
	58	#ifndef _SYS_TRACE_H_
	59	#define _SYS_TRACE_H_
	60
	61	/*
	62	* File system buffer tracing points; all trace <pack(dev, size), bn>
	63	*/
	64	#define TR_BREADHIT 0 /* buffer read found in cache */
65	#define TR_BREADMISS 1 /* buffer read not in cache */
66	#define TR_BWRITE 2 /* buffer written */
67	#define TR_BREADHITRA 3 /* buffer read-ahead found in cache */
68	#define TR_BREADMISSRA 4 /* buffer read-ahead not in cache */
69	#define TR_XFODMISS 5 /* exe fod read */
70	#define TR_XFODHIT 6 /* exe fod read */
71	#define TR_BRELSE 7 /* brelse */
72	#define TR_BREALLOC 8 /* expand/contract a buffer */
73
74	/*
75	* Memory allocator trace points; all trace the amount of memory involved
76	*/
77	#define TR_MALL 10 /* memory allocated */
78
79	/*
80	* Paging trace points: all are <vaddr, pid>
81	*/
82	#define TR_INTRANS 20 /* page intransit block */
83	#define TR_EINTRANS 21 /* page intransit wait done */
84	#define TR_FRECLAIM 22 /* reclaim from free list */
85	#define TR_RECLAIM 23 /* reclaim from loop */
86	#define TR_XSFREC 24 /* reclaim from free list instead of drum */
87	#define TR_XIFREC 25 /* reclaim from free list instead of fsys */
88	#define TR_WAITMEM 26 /* wait for memory in pagein */
89	#define TR_EWAITMEM 27 /* end memory wait in pagein */
90	#define TR_ZFOD 28 /* zfod page fault */
91	#define TR_EXFOD 29 /* exec fod page fault */
92	#define TR_VRFOD 30 /* vread fod page fault */
93	#define TR_CACHEFOD 31 /* fod in file system cache */
94	#define TR_SWAPIN 32 /* drum page fault */
95	#define TR_PGINDONE 33 /* page in done */
96	#define TR_SWAPIO 34 /* swap i/o request arrives */
97
98	/*
99	* System call trace points.
100	*/
101	#define TR_VADVISE 40 /* vadvise occurred with <arg, pid> */
102
103	/*
104	* Miscellaneous
105	*/
106	#define TR_STAMP 45 /* user said vtrace(VTR_STAMP, value); */
107
108	/*
109	* This defines the size of the trace flags array.
110	*/
111	#define TR_NFLAGS 100 /* generous */
112
113	#define TRCSIZ 4096
114
115	/*
116	* Specifications of the vtrace() system call, which takes one argument.
117	*/
118	#define VTRACE 64+51
119
120	#define VTR_DISABLE 0 /* set a trace flag to 0 */
121	#define VTR_ENABLE 1 /* set a trace flag to 1 */
122	#define VTR_VALUE 2 /* return value of a trace flag */
123	#define VTR_UALARM 3 /* set alarm to go off (sig 16) */
124	/* in specified number of hz */
125	#define VTR_STAMP 4 /* user specified stamp */
126
127	#ifdef KERNEL
128	#if TRACE
129	extern struct proc *traceproc;
130	extern int tracewhich, tracebuf[TRCSIZ];
131	extern u_int tracex;
132	extern char traceflags[TR_NFLAGS];
133	#define pack(v,b) (((v)->v_mount->mnt_stat.f_fsid.val[0])<<16)\|(b)
134	#define trace(a,b,c) { \
135	if (traceflags[a]) \
136	trace1(a,b,c); \
137	}
138	#else
139	#define trace(a,b,c)
140	#endif
141	#endif /* KERNEL */
142	#endif /* !_SYS_TRACE_H_ */
143