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 -- obsolete
  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         kIOKitDebugUserOptions = 0
  95                            | kIOLogAttach
  96                            | kIOLogProbe
  97                            | kIOLogStart
  98                            | kIOLogRegister
  99                            | kIOLogMatch
 100                            | kIOLogConfig
 101                            | kIOLogYield
 102                            | kIOLogPower
 103                            | kIOLogMapping
 104                            | kIOLogCatalogue
 105                            | kIOLogTracePower
 106                            | kIOLogDebugPower
 107                            | kOSLogRegistryMods
 108                            | kIOLogPMRootDomain
 109                            | kOSRegistryModsMode
 110                            | kIOLogHibernate
 111                            | kIOSleepWakeWdogOff
 112                            | kIOKextSpinDump
 113                            | kIOWaitQuietPanics
 114 };
 115
 116 enum {
 117         kIOTraceInterrupts              =               0x00000001ULL,  // Trace primary interrupts
 118         kIOTraceWorkLoops               =               0x00000002ULL,  // Trace workloop activity
 119         kIOTraceEventSources    =               0x00000004ULL,  // Trace non-passive event sources
 120         kIOTraceIntEventSource  =               0x00000008ULL,  // Trace IOIES and IOFIES sources
 121         kIOTraceCommandGates    =               0x00000010ULL,  // Trace command gate activity
 122         kIOTraceTimers                  =               0x00000020ULL,  // Trace timer event source activity
 123
 124         kIOTracePowerMgmt               =               0x00000400ULL,  // Trace power management changes
 125
 126         kIOTraceIOService       =               0x00080000ULL,  // registerService/termination
 127
 128         kIOTraceCompatBootArgs  =               kIOTraceIOService | kIOTracePowerMgmt
 129 };
 130
 131 extern SInt64    gIOKitDebug;
 132 extern SInt64    gIOKitTrace;
 133
 134 #ifdef __cplusplus
 135 extern "C" {
 136 #endif
 137
 138 #ifdef __cplusplus
 139 class IORegistryPlane;
 140 #endif
 141
 142 extern void    IOPrintPlane(
 143 #ifdef __cplusplus
 144                             const IORegistryPlane * plane
 145 #else
 146                             const struct IORegistryPlane * plane
 147 #endif
 148                            );
 149 #ifndef _OSCPPDEBUG_H
 150 extern void    OSPrintMemory( void );
 151 #endif
 152 #define IOPrintMemory OSPrintMemory
 153
 154
 155
 156 #define kIOKitDiagnosticsClientClassName "IOKitDiagnosticsClient"
 157
 158 enum
 159 {
 160     kIOKitDiagnosticsClientType = 0x99000002
 161 };
 162
 163
 164 struct IOKitDiagnosticsParameters
 165 {
 166     size_t    size;
 167     uint64_t  value;
 168     uint32_t  options;
 169     uint32_t  tag;
 170     uint32_t  zsize;
 171     uint32_t  reserved[8];
 172 };
 173 typedef struct IOKitDiagnosticsParameters IOKitDiagnosticsParameters;
 174
 175 enum
 176 {
 177     kIOTrackingCallSiteBTs = 16,
 178 };
 179
 180 struct IOTrackingCallSiteInfo
 181 {
 182     uint32_t          count;
 183     pid_t             addressPID;
 184     mach_vm_address_t address;
 185     mach_vm_size_t    size[2];
 186     pid_t             btPID;
 187     mach_vm_address_t bt[2][kIOTrackingCallSiteBTs];
 188 };
 189
 190 #define kIOMallocTrackingName   "IOMalloc"
 191 #define kIOWireTrackingName     "IOWire"
 192 #define kIOMapTrackingName      "IOMap"
 193
 194 #if XNU_KERNEL_PRIVATE && IOTRACKING
 195
 196 struct IOTrackingQueue;
 197 struct IOTrackingCallSite;
 198
 199 struct IOTracking
 200 {
 201     queue_chain_t        link;
 202     IOTrackingCallSite * site;
 203 #if !defined(__LP64__)
 204     uint32_t             flags;
 205 #endif
 206 };
 207
 208 struct IOTrackingAddress
 209 {
 210     IOTracking    tracking;
 211     uintptr_t     address;
 212     size_t        size;
 213 #if defined(__LP64__)
 214     uint32_t      flags;
 215 #endif
 216 };
 217
 218 struct IOTrackingUser
 219 {
 220     queue_chain_t link;
 221     pid_t         btPID;
 222     uint8_t       user32;
 223     uint8_t       userCount;
 224     uintptr_t     bt[kIOTrackingCallSiteBTs];
 225     uintptr_t     btUser[kIOTrackingCallSiteBTs];
 226 };
 227
 228 enum
 229 {
 230     kIOTrackingQueueTypeDefaultOn = 0x00000001,
 231     kIOTrackingQueueTypeAlloc     = 0x00000002,
 232     kIOTrackingQueueTypeMap       = 0x00000004,
 233     kIOTrackingQueueTypeUser      = 0x00000008,
 234 };
 235
 236
 237 void              IOTrackingInit(void);
 238 IOTrackingQueue * IOTrackingQueueAlloc(const char * name, uintptr_t btEntry,
 239                                         size_t allocSize, size_t minCaptureSize,
 240                                         uint32_t type, uint32_t numSiteQs);
 241 void              IOTrackingQueueFree(IOTrackingQueue * head);
 242 void              IOTrackingAdd(IOTrackingQueue * head, IOTracking * mem, size_t size, bool address, vm_tag_t tag);
 243 void              IOTrackingRemove(IOTrackingQueue * head, IOTracking * mem, size_t size);
 244 void              IOTrackingAddUser(IOTrackingQueue * queue, IOTrackingUser * mem, vm_size_t size);
 245 void              IOTrackingRemoveUser(IOTrackingQueue * head, IOTrackingUser * tracking);
 246
 247 void              IOTrackingAlloc(IOTrackingQueue * head, uintptr_t address, size_t size);
 248 void              IOTrackingFree(IOTrackingQueue * head, uintptr_t address, size_t size);
 249 void              IOTrackingReset(IOTrackingQueue * head);
 250 void              IOTrackingAccumSize(IOTrackingQueue * head, IOTracking * mem, size_t size);
 251 kern_return_t     IOTrackingDebug(uint32_t selector, uint32_t options,
 252                                   const char * names, size_t namesLen,
 253                                   size_t size, OSObject ** result);
 254
 255 extern IOTrackingQueue * gIOMallocTracking;
 256 extern IOTrackingQueue * gIOWireTracking;
 257 extern IOTrackingQueue * gIOMapTracking;
 258
 259 #endif /* XNU_KERNEL_PRIVATE && IOTRACKING */
 260
 261 enum
 262 {
 263     kIOTrackingExcludeNames      = 0x00000001,
 264 };
 265
 266 enum
 267 {
 268     kIOTrackingGetTracking       = 0x00000001,
 269     kIOTrackingGetMappings       = 0x00000002,
 270     kIOTrackingResetTracking     = 0x00000003,
 271     kIOTrackingStartCapture      = 0x00000004,
 272     kIOTrackingStopCapture       = 0x00000005,
 273     kIOTrackingSetMinCaptureSize = 0x00000006,
 274     kIOTrackingLeaks             = 0x00000007,
 275     kIOTrackingInvalid           = 0xFFFFFFFE,
 276 };
 277
 278
 279 #ifdef __cplusplus
 280 } /* extern "C" */
 281 #endif /* __cplusplus */
 282
 283 #endif /* ! _IOKIT_IOKITDEBUG_H */