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