iokit/IOKit/IOKitDebug.h

   1 /*
   2  * Copyright (c) 1998-2010 Apple 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
  29 #ifndef _IOKIT_IOKITDEBUG_H
  30 #define _IOKIT_IOKITDEBUG_H
  31
  32 #include <IOKit/IOTypes.h>
  33
  34
  35 #ifdef __cplusplus
  36
  37 #include <libkern/c++/OSObject.h>
  38 #include <libkern/c++/OSDictionary.h>
  39 #include <libkern/c++/OSSerialize.h>
  40
  41 class IOKitDiagnostics : public OSObject
  42 {
  43     OSDeclareDefaultStructors(IOKitDiagnostics)
  44
  45 public:
  46     static OSObject * diagnostics( void );
  47     virtual bool serialize(OSSerialize *s) const APPLE_KEXT_OVERRIDE;
  48 private:
  49     static void updateOffset( OSDictionary * dict,
  50             UInt64 value, const char * name );
  51 };
  52
  53 #endif /* __cplusplus */
  54
  55 enum {
  56     // loggage
  57     kIOLogAttach        =         0x00000001ULL,
  58     kIOLogProbe         =         0x00000002ULL,
  59     kIOLogStart         =         0x00000004ULL,
  60     kIOLogRegister      =         0x00000008ULL,
  61     kIOLogMatch         =         0x00000010ULL,
  62     kIOLogConfig        =         0x00000020ULL,
  63     kIOLogYield         =         0x00000040ULL,
  64     kIOLogPower         =         0x00000080ULL,
  65     kIOLogMapping       =         0x00000100ULL,
  66     kIOLogCatalogue     =         0x00000200ULL,
  67         kIOLogTracePower    =         0x00000400ULL,  // Obsolete: Use iotrace=0x00000400ULL to enable now
  68     kIOLogDebugPower    =         0x00000800ULL,
  69     kIOLogServiceTree   =         0x00001000ULL,
  70     kIOLogDTree         =         0x00002000ULL,
  71     kIOLogMemory        =         0x00004000ULL,
  72     kIOLogKextMemory    =         0x00008000ULL,
  73     kOSLogRegistryMods  =         0x00010000ULL,  // Log attempts to modify registry collections
  74     kIOLogPMRootDomain  =         0x00020000ULL,
  75     kOSRegistryModsMode =         0x00040000ULL,  // Change default registry modification handling - panic vs. log
  76 //    kIOTraceIOService   =         0x00080000ULL,  // Obsolete: Use iotrace=0x00080000ULL to enable now
  77     kIOLogHibernate     =         0x00100000ULL,
  78     kIOStatistics       =         0x04000000ULL,
  79     kIOSleepWakeWdogOff =         0x40000000ULL,
  80     kIOKextSpinDump     =         0x80000000ULL,
  81
  82     // debug aids - change behaviour
  83     kIONoFreeObjects    =         0x00100000ULL,
  84     kIOLogSynchronous   =         0x00200000ULL,  // IOLog completes synchronously
  85     kIOTracking         =         0x00400000ULL,
  86     kIOWaitQuietPanics  =         0x00800000ULL,
  87     kIOWaitQuietBeforeRoot =      0x01000000ULL,
  88     kIOTrackingBoot     =         0x02000000ULL,
  89
  90     _kIODebugTopFlag    = 0x8000000000000000ULL   // force enum to be 64 bits
  91 };
  92
  93 enum {
  94         kIOTraceInterrupts              =               0x00000001ULL,  // Trace primary interrupts
  95         kIOTraceWorkLoops               =               0x00000002ULL,  // Trace workloop activity
  96         kIOTraceEventSources    =               0x00000004ULL,  // Trace non-passive event sources
  97         kIOTraceIntEventSource  =               0x00000008ULL,  // Trace IOIES and IOFIES sources
  98         kIOTraceCommandGates    =               0x00000010ULL,  // Trace command gate activity
  99         kIOTraceTimers                  =               0x00000020ULL,  // Trace timer event source activity
 100
 101         kIOTracePowerMgmt               =               0x00000400ULL,  // Trace power management changes
 102
 103         kIOTraceIOService       =               0x00080000ULL,  // registerService/termination
 104
 105         kIOTraceCompatBootArgs  =               kIOTraceIOService | kIOTracePowerMgmt
 106 };
 107
 108 extern SInt64    gIOKitDebug;
 109 extern SInt64    gIOKitTrace;
 110
 111 #ifdef __cplusplus
 112 extern "C" {
 113 #endif
 114
 115 #ifdef __cplusplus
 116 class IORegistryPlane;
 117 #endif
 118
 119 extern void    IOPrintPlane(
 120 #ifdef __cplusplus
 121                             const IORegistryPlane * plane
 122 #else
 123                             const struct IORegistryPlane * plane
 124 #endif
 125                            );
 126 #ifndef _OSCPPDEBUG_H
 127 extern void    OSPrintMemory( void );
 128 #endif
 129 #define IOPrintMemory OSPrintMemory
 130
 131
 132
 133 #define kIOKitDiagnosticsClientClassName "IOKitDiagnosticsClient"
 134
 135 enum
 136 {
 137     kIOKitDiagnosticsClientType = 0x99000002
 138 };
 139
 140
 141 struct IOKitDiagnosticsParameters
 142 {
 143     size_t    size;
 144     uint64_t  value;
 145     uint32_t  options;
 146     uint32_t  reserved[3];
 147 };
 148 typedef struct IOKitDiagnosticsParameters IOKitDiagnosticsParameters;
 149
 150 enum
 151 {
 152     kIOTrackingCallSiteBTs = 16,
 153 };
 154
 155 struct IOTrackingCallSiteInfo
 156 {
 157     uint32_t      count;
 158     size_t        size[2];
 159     uintptr_t     bt[kIOTrackingCallSiteBTs];
 160 };
 161
 162 #define kIOMallocTrackingName   "IOMalloc"
 163 #define kIOWireTrackingName     "IOWire"
 164 #define kIOMapTrackingName      "IOMap"
 165
 166 #if KERNEL && IOTRACKING
 167
 168 struct IOTrackingQueue;
 169 struct IOTrackingCallSite;
 170
 171 struct IOTracking
 172 {
 173     queue_chain_t        link;
 174     IOTrackingCallSite * site;
 175 #if !defined(__LP64__)
 176     uint32_t             flags;
 177 #endif
 178 };
 179
 180 struct IOTrackingAddress
 181 {
 182     IOTracking    tracking;
 183     uintptr_t     address;
 184     size_t        size;
 185 #if defined(__LP64__)
 186     uint32_t      flags;
 187 #endif
 188 };
 189
 190 void              IOTrackingInit(void);
 191 IOTrackingQueue * IOTrackingQueueAlloc(const char * name, size_t allocSize, size_t minCaptureSize, bool isAlloc);
 192 void              IOTrackingQueueFree(IOTrackingQueue * head);
 193 void              IOTrackingAdd(IOTrackingQueue * head, IOTracking * mem, size_t size, bool address);
 194 void              IOTrackingRemove(IOTrackingQueue * head, IOTracking * mem, size_t size);
 195 void              IOTrackingAlloc(IOTrackingQueue * head, uintptr_t address, size_t size);
 196 void              IOTrackingFree(IOTrackingQueue * head, uintptr_t address, size_t size);
 197 void              IOTrackingReset(IOTrackingQueue * head);
 198 void              IOTrackingAccumSize(IOTrackingQueue * head, IOTracking * mem, size_t size);
 199 kern_return_t     IOTrackingDebug(uint32_t selector, uint32_t options,
 200                                   const char * names, size_t namesLen,
 201                                   size_t size, OSObject ** result);
 202
 203 extern IOTrackingQueue * gIOMallocTracking;
 204 extern IOTrackingQueue * gIOWireTracking;
 205 extern IOTrackingQueue * gIOMapTracking;
 206
 207 #endif /* KERNEL && IOTRACKING */
 208
 209 enum
 210 {
 211     kIOTrackingExcludeNames      = 0x00000001,
 212 };
 213
 214 enum
 215 {
 216     kIOTrackingGetTracking       = 0x00000001,
 217     kIOTrackingPrintTracking     = 0x00000002,
 218     kIOTrackingResetTracking     = 0x00000003,
 219     kIOTrackingStartCapture      = 0x00000004,
 220     kIOTrackingStopCapture       = 0x00000005,
 221     kIOTrackingSetMinCaptureSize = 0x00000006,
 222     kIOTrackingLeaks             = 0x00000007,
 223     kIOTrackingInvalid           = 0xFFFFFFFE,
 224 };
 225
 226
 227 #ifdef __cplusplus
 228 } /* extern "C" */
 229 #endif /* __cplusplus */
 230
 231 #endif /* ! _IOKIT_IOKITDEBUG_H */