osfmk/kern/xpr.h

   1 /*
   2  * Copyright (c) 2000-2004 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_OSREFERENCE_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
  10  * License may not be used to create, or enable the creation or
  11  * redistribution of, unlawful or unlicensed copies of an Apple operating
  12  * system, or to circumvent, violate, or enable the circumvention or
  13  * violation of, any terms of an Apple operating system software license
  14  * agreement.
  15  *
  16  * Please obtain a copy of the License at
  17  * http://www.opensource.apple.com/apsl/ and read it before using this
  18  * file.
  19  *
  20  * The Original Code and all software distributed under the License are
  21  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  22  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  23  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  24  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  25  * Please see the License for the specific language governing rights and
  26  * limitations under the License.
  27  *
  28  * @APPLE_LICENSE_OSREFERENCE_HEADER_END@
  29  */
  30 /*
  31  * @OSF_COPYRIGHT@
  32  */
  33 /*
  34  * Mach Operating System
  35  * Copyright (c) 1991,1990,1989,1988,1987 Carnegie Mellon University
  36  * All Rights Reserved.
  37  *
  38  * Permission to use, copy, modify and distribute this software and its
  39  * documentation is hereby granted, provided that both the copyright
  40  * notice and this permission notice appear in all copies of the
  41  * software, derivative works or modified versions, and any portions
  42  * thereof, and that both notices appear in supporting documentation.
  43  *
  44  * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
  45  * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
  46  * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
  47  *
  48  * Carnegie Mellon requests users of this software to return to
  49  *
  50  *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
  51  *  School of Computer Science
  52  *  Carnegie Mellon University
  53  *  Pittsburgh PA 15213-3890
  54  *
  55  * any improvements or extensions that they make and grant Carnegie Mellon
  56  * the rights to redistribute these changes.
  57  */
  58 /*
  59  */
  60 /*
  61  * Include file for xpr circular buffer silent tracing.
  62  *
  63  */
  64 /*
  65  * If the kernel flag XPRDEBUG is set, the XPR macro is enabled.  The
  66  * macro should be invoked something like the following:
  67  *      XPR(XPR_SYSCALLS, "syscall: %d, 0x%x\n", syscallno, arg1, 0,0,0);
  68  * which will expand into the following code:
  69  *      if (xprflags & XPR_SYSCALLS)
  70  *              xpr("syscall: %d, 0x%x\n", syscallno, arg1, 0,0,0);
  71  * Xpr will log the pointer to the printf string and up to 5 arguements,
  72  * along with a timestamp and cpuinfo (for multi-processor systems), into
  73  * a circular buffer.  The actual printf processing is delayed until after
  74  * the buffer has been collected.  It is assumed that the text/data segments
  75  * of the kernel can easily be reconstructed in a post-processor which
  76  * performs the printf processing.
  77  *
  78  * If the XPRDEBUG compilation switch is not set, the XPR macro expands
  79  * to nothing.
  80  */
  81
  82 #ifndef _KERN_XPR_H_
  83 #define _KERN_XPR_H_
  84
  85 #ifdef  MACH_KERNEL
  86 #include <xpr_debug.h>
  87 #else   /* MACH_KERNEL */
  88 #include <sys/features.h>
  89 #endif  /* MACH_KERNEL */
  90
  91 #include <machine/xpr.h>
  92
  93 #if     XPR_DEBUG
  94
  95 #define XPR(flags, msg, arg1, arg2, arg3, arg4, arg5)           \
  96 MACRO_BEGIN                                                     \
  97         if (xprflags & (flags)) {                               \
  98                 xpr((msg), (long)(arg1), (long)(arg2),          \
  99                     (long)(arg3), (long)(arg4), (long)(arg5));  \
 100         }                                                       \
 101 MACRO_END
 102
 103 extern int xprflags;
 104
 105 /*
 106  * flags for message types.
 107  */
 108 #define XPR_TRAPS               (1 << 1)
 109 #define XPR_SCHED               (1 << 2)
 110 #define XPR_LOCK                (1 << 3)
 111 #define XPR_SLOCK               (1 << 4)
 112 #define XPR_PMAP                (1 << 6)
 113 #define XPR_VM_MAP              (1 << 7)
 114 #define XPR_VM_OBJECT           (1 << 8)
 115 #define XPR_VM_OBJECT_CACHE     (1 << 9)
 116 #define XPR_VM_PAGE             (1 << 10)
 117 #define XPR_VM_PAGEOUT          (1 << 11)
 118 #define XPR_MEMORY_OBJECT       (1 << 12)
 119 #define XPR_VM_FAULT            (1 << 13)
 120 #define XPR_VM_OBJECT_REP       (1 << 14)
 121 #define XPR_DEFAULT_PAGER       (1 << 15)
 122 #define XPR_INODE_PAGER         (1 << 16)
 123 #define XPR_INODE_PAGER_DATA    (1 << 17)
 124 #define XPR_XMM                 (1 << 18)
 125
 126 #else   /* XPR_DEBUG */
 127 #define XPR(flags, msg, arg1, arg2, arg3, arg4, arg5)
 128 #endif  /* XPR_DEBUG */
 129
 130 struct xprbuf {
 131         const char      *msg;
 132         long            arg1,arg2,arg3,arg4,arg5;
 133         int             timestamp;
 134         int             cpuinfo;
 135 };
 136
 137 /* Bootstrap XPR facility */
 138 extern void xprbootstrap(void);
 139
 140 /* Enable XPR facility */
 141 extern void xprinit(void);
 142
 143 /* Log an XPR message */
 144 extern void xpr(
 145         const char      *msg,
 146         long            arg1,
 147         long            arg2,
 148         long            arg3,
 149         long            arg4,
 150         long            arg5);
 151
 152 #endif /* _KERN_XPR_H_ */