iokit/Kernel/IOServicePrivate.h

   1 /*
   2  * Copyright (c) 1998-2019 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  * Copyright (c) 1999 Apple Computer, Inc.  All rights reserved.
  30  *
  31  * HISTORY
  32  *
  33  */
  34
  35
  36 #ifndef _IOKIT_IOSERVICEPRIVATE_H
  37 #define _IOKIT_IOSERVICEPRIVATE_H
  38
  39 // options for getExistingServices()
  40 enum {
  41         kIONotifyOnce             = 0x00000001,
  42         kIOServiceExistingSet     = 0x00000002,
  43         kIOServiceChangesOK       = 0x00000004,
  44         kIOServiceInternalDone    = 0x00000008,
  45         kIOServiceClassDone       = 0x00000010,
  46 };
  47
  48 // masks for __state[1]
  49 enum {
  50         kIOServiceBusyStateMask     = 0x000003ff,
  51         kIOServiceBusyMax           = 1023,
  52         kIOServiceNeedConfigState   = 0x80000000,
  53         kIOServiceSynchronousState  = 0x40000000,
  54         kIOServiceModuleStallState  = 0x20000000,
  55         kIOServiceBusyWaiterState   = 0x10000000,
  56
  57         kIOServiceSyncPubState      = 0x08000000,
  58         kIOServiceConfigState       = 0x04000000,
  59         kIOServiceStartState        = 0x02000000,
  60         kIOServiceTermPhase2State   = 0x01000000,
  61         kIOServiceTermPhase3State   = 0x00800000,
  62         kIOServiceTermPhase1State   = 0x00400000,
  63         kIOServiceTerm1WaiterState  = 0x00200000,
  64         kIOServiceRecursing         = 0x00100000,
  65         kIOServiceNeedWillTerminate = 0x00080000,
  66         kIOServiceWaitDetachState   = 0x00040000,
  67         kIOServiceConfigRunning     = 0x00020000,
  68         kIOServiceFinalized         = 0x00010000,
  69 };
  70
  71 // notify state
  72 enum {
  73         kIOServiceNotifyEnable      = 0x00000001,
  74         kIOServiceNotifyWaiter      = 0x00000002,
  75         kIOServiceNotifyBlock       = 0x00000004
  76 };
  77
  78 struct _IOServiceNotifierInvocation {
  79         IOThread            thread;
  80         queue_chain_t       link;
  81 };
  82
  83 class _IOServiceNotifier : public IONotifier
  84 {
  85         friend class IOService;
  86
  87         OSDeclareDefaultStructors(_IOServiceNotifier);
  88
  89 public:
  90         OSOrderedSet *                      whence;
  91
  92         OSDictionary *                      matching;
  93         const OSSymbol *                    type;
  94         IOServiceMatchingNotificationHandler handler;
  95         IOServiceNotificationHandler        compatHandler;
  96         void *                              target;
  97         void *                              ref;
  98         SInt32                              priority;
  99         queue_head_t                        handlerInvocations;
 100         IOOptionBits                        state;
 101
 102         virtual void free() APPLE_KEXT_OVERRIDE;
 103         virtual void remove() APPLE_KEXT_OVERRIDE;
 104         virtual bool disable() APPLE_KEXT_OVERRIDE;
 105         virtual void enable( bool was ) APPLE_KEXT_OVERRIDE;
 106         virtual void wait();
 107 };
 108
 109 class _IOServiceInterestNotifier : public IONotifier
 110 {
 111         friend class IOService;
 112
 113         OSDeclareDefaultStructors(_IOServiceInterestNotifier);
 114
 115 public:
 116         queue_chain_t               chain;
 117
 118         IOServiceInterestHandler    handler;
 119         void *                      target;
 120         void *                      ref;
 121         queue_head_t                handlerInvocations;
 122         IOOptionBits                state;
 123
 124         virtual void free() APPLE_KEXT_OVERRIDE;
 125         virtual void remove() APPLE_KEXT_OVERRIDE;
 126         virtual bool disable() APPLE_KEXT_OVERRIDE;
 127         virtual void enable( bool was ) APPLE_KEXT_OVERRIDE;
 128         virtual void wait();
 129         virtual bool init() APPLE_KEXT_OVERRIDE;
 130 };
 131
 132 class _IOServiceNullNotifier : public IONotifier
 133 {
 134         OSDeclareDefaultStructors(_IOServiceNullNotifier);
 135
 136 public:
 137         virtual void taggedRetain(const void *tag) const APPLE_KEXT_OVERRIDE;
 138         virtual void taggedRelease(const void *tag, const int when) const APPLE_KEXT_OVERRIDE;
 139         virtual void free() APPLE_KEXT_OVERRIDE;
 140         virtual void remove() APPLE_KEXT_OVERRIDE;
 141         virtual bool disable() APPLE_KEXT_OVERRIDE;
 142         virtual void enable( bool was ) APPLE_KEXT_OVERRIDE;
 143         virtual void wait();
 144 };
 145
 146 class _IOConfigThread : public OSObject
 147 {
 148         friend class IOService;
 149
 150         OSDeclareDefaultStructors(_IOConfigThread);
 151
 152 public:
 153         static void configThread( int configThreadId );
 154         static void main( void * arg, wait_result_t result );
 155 };
 156
 157 enum {
 158         kMaxConfigThreads       = CONFIG_MAX_THREADS,
 159 };
 160
 161 enum {
 162         kMatchNubJob        = 10,
 163 };
 164
 165 class _IOServiceJob : public OSObject
 166 {
 167         friend class IOService;
 168
 169         OSDeclareDefaultStructors(_IOServiceJob);
 170
 171 public:
 172         int                 type;
 173         IOService *         nub;
 174         IOOptionBits        options;
 175
 176         static _IOServiceJob * startJob( IOService * nub, int type,
 177             IOOptionBits options = 0 );
 178         static void pingConfig( class _IOServiceJob * job );
 179 };
 180
 181 class IOResources : public IOService
 182 {
 183         friend class IOService;
 184
 185         OSDeclareDefaultStructors(IOResources);
 186
 187 public:
 188         static IOService * resources( void );
 189         virtual bool init( OSDictionary * dictionary = NULL ) APPLE_KEXT_OVERRIDE;
 190         virtual IOReturn newUserClient(task_t owningTask, void * securityID,
 191             UInt32 type, OSDictionary * properties,
 192             IOUserClient ** handler) APPLE_KEXT_OVERRIDE;
 193         virtual IOWorkLoop * getWorkLoop() const APPLE_KEXT_OVERRIDE;
 194         virtual bool matchPropertyTable( OSDictionary * table ) APPLE_KEXT_OVERRIDE;
 195         virtual IOReturn setProperties( OSObject * properties ) APPLE_KEXT_OVERRIDE;
 196 };
 197
 198 class IOUserResources : public IOService
 199 {
 200         friend class IOService;
 201
 202         OSDeclareDefaultStructors(IOUserResources);
 203
 204 public:
 205         static IOService * resources( void );
 206         virtual bool init( OSDictionary * dictionary = NULL ) APPLE_KEXT_OVERRIDE;
 207         virtual IOReturn newUserClient(task_t owningTask, void * securityID,
 208             UInt32 type, OSDictionary * properties,
 209             IOUserClient ** handler) APPLE_KEXT_OVERRIDE;
 210         virtual IOWorkLoop * getWorkLoop() const APPLE_KEXT_OVERRIDE;
 211         virtual bool matchPropertyTable( OSDictionary * table ) APPLE_KEXT_OVERRIDE;
 212 };
 213
 214 class _IOOpenServiceIterator : public OSIterator
 215 {
 216         friend class IOService;
 217
 218         OSDeclareDefaultStructors(_IOOpenServiceIterator);
 219
 220         OSIterator *        iter;
 221         const IOService *   client;
 222         const IOService *   provider;
 223         IOService *         last;
 224
 225 public:
 226         static OSIterator * iterator(LIBKERN_CONSUMED OSIterator * _iter,
 227             const IOService * client,
 228             const IOService * provider );
 229         virtual void free() APPLE_KEXT_OVERRIDE;
 230         virtual void reset() APPLE_KEXT_OVERRIDE;
 231         virtual bool isValid() APPLE_KEXT_OVERRIDE;
 232         virtual OSObject * getNextObject() APPLE_KEXT_OVERRIDE;
 233 };
 234
 235 extern const OSSymbol * gIOConsoleUsersKey;
 236 extern const OSSymbol * gIOConsoleSessionUIDKey;
 237 extern const OSSymbol * gIOConsoleSessionAuditIDKey;
 238 extern const OSSymbol * gIOConsoleSessionOnConsoleKey;
 239 extern const OSSymbol * gIOConsoleSessionSecureInputPIDKey;
 240
 241
 242 #define _interruptSourcesPrivate(service)   \
 243     ((IOInterruptSourcePrivate *)(&(service)->_interruptSources[(service)->_numInterruptSources]))
 244
 245 #define sizeofAllIOInterruptSource          \
 246     (sizeof(IOInterruptSourcePrivate) + sizeof(IOInterruptSource))
 247
 248 #endif /* ! _IOKIT_IOSERVICEPRIVATE_H */