osfmk/kern/xpr.h

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