iokit/Kernel/IOServicePrivate.h

   1 /*
   2  * Copyright (c) 1998-2000 Apple Computer, 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 };
  69
  70 // notify state
  71 enum {
  72     kIOServiceNotifyEnable      = 0x00000001,
  73     kIOServiceNotifyWaiter      = 0x00000002
  74 };
  75
  76 struct _IOServiceNotifierInvocation
  77 {
  78     IOThread            thread;
  79     queue_chain_t       link;
  80 };
  81
  82 class _IOServiceNotifier : public IONotifier
  83 {
  84     friend class IOService;
  85
  86     OSDeclareDefaultStructors(_IOServiceNotifier)
  87
  88 public:
  89     OSOrderedSet *                      whence;
  90
  91     OSDictionary *                      matching;
  92     const OSSymbol *                    type;
  93     IOServiceMatchingNotificationHandler handler;
  94     IOServiceNotificationHandler        compatHandler;
  95     void *                              target;
  96     void *                              ref;
  97     SInt32                              priority;
  98     queue_head_t                        handlerInvocations;
  99     IOOptionBits                        state;
 100
 101     virtual void free() APPLE_KEXT_OVERRIDE;
 102     virtual void remove() APPLE_KEXT_OVERRIDE;
 103     virtual bool disable() APPLE_KEXT_OVERRIDE;
 104     virtual void enable( bool was ) APPLE_KEXT_OVERRIDE;
 105     virtual void wait();
 106 };
 107
 108 class _IOServiceInterestNotifier : public IONotifier
 109 {
 110     friend class IOService;
 111
 112     OSDeclareDefaultStructors(_IOServiceInterestNotifier)
 113
 114 public:
 115     queue_chain_t               chain;
 116
 117     IOServiceInterestHandler    handler;
 118     void *                      target;
 119     void *                      ref;
 120     queue_head_t                handlerInvocations;
 121     IOOptionBits                state;
 122
 123     virtual void free() APPLE_KEXT_OVERRIDE;
 124     virtual void remove() APPLE_KEXT_OVERRIDE;
 125     virtual bool disable() APPLE_KEXT_OVERRIDE;
 126     virtual void enable( bool was ) APPLE_KEXT_OVERRIDE;
 127     virtual void wait();
 128     virtual bool init() APPLE_KEXT_OVERRIDE;
 129 };
 130
 131 class _IOServiceNullNotifier : public IONotifier
 132 {
 133     OSDeclareDefaultStructors(_IOServiceNullNotifier)
 134
 135 public:
 136     virtual void taggedRetain(const void *tag) const APPLE_KEXT_OVERRIDE;
 137     virtual void taggedRelease(const void *tag, const int when) const APPLE_KEXT_OVERRIDE;
 138     virtual void free() APPLE_KEXT_OVERRIDE;
 139     virtual void remove() APPLE_KEXT_OVERRIDE;
 140     virtual bool disable() APPLE_KEXT_OVERRIDE;
 141     virtual void enable( bool was ) APPLE_KEXT_OVERRIDE;
 142     virtual void wait();
 143 };
 144
 145 class _IOConfigThread : public OSObject
 146 {
 147     friend class IOService;
 148
 149     OSDeclareDefaultStructors(_IOConfigThread)
 150
 151 public:
 152     virtual void free() APPLE_KEXT_OVERRIDE;
 153
 154     static void configThread( void );
 155     static void main( void * arg, wait_result_t result );
 156 };
 157
 158 enum {
 159         kMaxConfigThreads       = CONFIG_MAX_THREADS,
 160 };
 161
 162 enum {
 163     kMatchNubJob        = 10,
 164 };
 165
 166 class _IOServiceJob : public OSObject
 167 {
 168     friend class IOService;
 169
 170     OSDeclareDefaultStructors(_IOServiceJob)
 171
 172 public:
 173     int                 type;
 174     IOService *         nub;
 175     IOOptionBits        options;
 176
 177     static _IOServiceJob * startJob( IOService * nub, int type,
 178                           IOOptionBits options = 0 );
 179     static void pingConfig( class _IOServiceJob * job );
 180
 181 };
 182
 183 class IOResources : public IOService
 184 {
 185     friend class IOService;
 186
 187     OSDeclareDefaultStructors(IOResources)
 188
 189 public:
 190     static IOService * resources( void );
 191     virtual bool init( OSDictionary * dictionary = 0 ) APPLE_KEXT_OVERRIDE;
 192     virtual IOReturn newUserClient(task_t owningTask, void * securityID,
 193                                    UInt32 type,  OSDictionary * properties,
 194                                    IOUserClient ** handler) APPLE_KEXT_OVERRIDE;
 195     virtual IOWorkLoop * getWorkLoop( ) const APPLE_KEXT_OVERRIDE;
 196     virtual bool matchPropertyTable( OSDictionary * table ) APPLE_KEXT_OVERRIDE;
 197     virtual IOReturn setProperties( OSObject * properties ) APPLE_KEXT_OVERRIDE;
 198 };
 199
 200 class _IOOpenServiceIterator : public OSIterator
 201 {
 202     friend class IOService;
 203
 204     OSDeclareDefaultStructors(_IOOpenServiceIterator)
 205
 206     OSIterator *        iter;
 207     const IOService *   client;
 208     const IOService *   provider;
 209     IOService *         last;
 210
 211 public:
 212     static OSIterator * iterator( OSIterator * _iter,
 213                                   const IOService * client,
 214                                   const IOService * provider );
 215     virtual void free() APPLE_KEXT_OVERRIDE;
 216     virtual void reset() APPLE_KEXT_OVERRIDE;
 217     virtual bool isValid() APPLE_KEXT_OVERRIDE;
 218     virtual OSObject * getNextObject() APPLE_KEXT_OVERRIDE;
 219 };
 220
 221 extern const OSSymbol * gIOConsoleUsersKey;
 222 extern const OSSymbol * gIOConsoleSessionUIDKey;
 223 extern const OSSymbol * gIOConsoleSessionAuditIDKey;
 224 extern const OSSymbol * gIOConsoleSessionOnConsoleKey;
 225 extern const OSSymbol * gIOConsoleSessionSecureInputPIDKey;
 226
 227 #endif /* ! _IOKIT_IOSERVICEPRIVATE_H */
 228