/*
- * Copyright (c) 1998-2000 Apple Computer, Inc. All rights reserved.
+ * Copyright (c) 1998-2016 Apple Inc. All rights reserved.
*
- * @APPLE_LICENSE_HEADER_START@
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
*
- * The contents of this file constitute Original Code as defined in and
- * are subject to the Apple Public Source License Version 1.1 (the
- * "License"). You may not use this file except in compliance with the
- * License. Please obtain a copy of the License at
- * http://www.apple.com/publicsource and read it before using this file.
+ * This file contains Original Code and/or Modifications of Original Code
+ * as defined in and that are subject to the Apple Public Source License
+ * Version 2.0 (the 'License'). You may not use this file except in
+ * compliance with the License. The rights granted to you under the License
+ * may not be used to create, or enable the creation or redistribution of,
+ * unlawful or unlicensed copies of an Apple operating system, or to
+ * circumvent, violate, or enable the circumvention or violation of, any
+ * terms of an Apple operating system software license agreement.
*
- * This Original Code and all software distributed under the License are
- * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
+ * Please obtain a copy of the License at
+ * http://www.opensource.apple.com/apsl/ and read it before using this file.
+ *
+ * The Original Code and all software distributed under the License are
+ * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT. Please see the
- * License for the specific language governing rights and limitations
- * under the License.
+ * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
+ * Please see the License for the specific language governing rights and
+ * limitations under the License.
*
- * @APPLE_LICENSE_HEADER_END@
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
*/
/*
#include <IOKit/IOService.h>
#include <IOKit/OSMessageNotification.h>
+#if IOKITSTATS
+#include <IOKit/IOStatisticsPrivate.h>
+#endif
+
+#define _IOUSERCLIENT_SENDASYNCRESULT64WITHOPTIONS_ 1
enum {
kIOUCTypeMask = 0x0000000f,
kIOUCScalarIScalarO = 0,
kIOUCScalarIStructO = 2,
kIOUCStructIStructO = 3,
- kIOUCScalarIStructI = 4
+ kIOUCScalarIStructI = 4,
+
+ kIOUCForegroundOnly = 0x00000010,
};
+/*! @enum
+ @abstract Constant to denote a variable length structure argument to IOUserClient.
+ @constant kIOUCVariableStructureSize Use in the structures IOExternalMethod, IOExternalAsyncMethod, IOExternalMethodDispatch to specify the size of the structure is variable.
+*/
+enum {
+ kIOUCVariableStructureSize = 0xffffffff
+};
+
+
typedef IOReturn (IOService::*IOMethod)(void * p1, void * p2, void * p3,
void * p4, void * p5, void * p6 );
kIOUserNotifyMaxMessageSize = 64
};
+enum {
+ kIOUserNotifyOptionCanDrop = 0x1 /* Fail if queue is full, rather than infinitely queuing. */
+};
+
// keys for clientHasPrivilege
#define kIOClientPrivilegeAdministrator "root"
#define kIOClientPrivilegeLocalUser "local"
+#define kIOClientPrivilegeForeground "foreground"
+
+/*! @enum
+ @abstract Constants to specify the maximum number of scalar arguments in the IOExternalMethodArguments structure. These constants are documentary since the scalarInputCount, scalarOutputCount fields reflect the actual number passed.
+ @constant kIOExternalMethodScalarInputCountMax The maximum number of scalars able to passed on input.
+ @constant kIOExternalMethodScalarOutputCountMax The maximum number of scalars able to passed on output.
+*/
+enum {
+ kIOExternalMethodScalarInputCountMax = 16,
+ kIOExternalMethodScalarOutputCountMax = 16,
+};
+
+
+struct IOExternalMethodArguments
+{
+ uint32_t version;
+
+ uint32_t selector;
+
+ mach_port_t asyncWakePort;
+ io_user_reference_t * asyncReference;
+ uint32_t asyncReferenceCount;
+
+ const uint64_t * scalarInput;
+ uint32_t scalarInputCount;
+
+ const void * structureInput;
+ uint32_t structureInputSize;
+
+ IOMemoryDescriptor * structureInputDescriptor;
+
+ uint64_t * scalarOutput;
+ uint32_t scalarOutputCount;
+
+ void * structureOutput;
+ uint32_t structureOutputSize;
+
+ IOMemoryDescriptor * structureOutputDescriptor;
+ uint32_t structureOutputDescriptorSize;
+
+ uint32_t __reservedA;
+
+ OSObject ** structureVariableOutputData;
+
+ uint32_t __reserved[30];
+};
+
+typedef IOReturn (*IOExternalMethodAction)(OSObject * target, void * reference,
+ IOExternalMethodArguments * arguments);
+struct IOExternalMethodDispatch
+{
+ IOExternalMethodAction function;
+ uint32_t checkScalarInputCount;
+ uint32_t checkStructureInputSize;
+ uint32_t checkScalarOutputCount;
+ uint32_t checkStructureOutputSize;
+};
+
+enum {
+#define IO_EXTERNAL_METHOD_ARGUMENTS_CURRENT_VERSION 2
+ kIOExternalMethodArgumentsCurrentVersion = IO_EXTERNAL_METHOD_ARGUMENTS_CURRENT_VERSION
+};
+
/*!
@class IOUserClient
@abstract Provides a basis for communication between client applications and I/O Kit objects.
*/
-
class IOUserClient : public IOService
{
OSDeclareAbstractStructors(IOUserClient)
+#if IOKITSTATS
+ friend class IOStatistics;
+#endif
protected:
/*! @struct ExpansionData
@discussion This structure will be used to expand the capablilties of this class in the future.
*/
- struct ExpansionData { };
+ struct ExpansionData {
+#if IOKITSTATS
+ IOUserClientCounter *counter;
+#else
+ void *iokitstatsReserved;
+#endif
+ };
/*! @var reserved
Reserved for future use. (Internal use only)
*/
ExpansionData * reserved;
+ bool reserve();
+
+#ifdef XNU_KERNEL_PRIVATE
+
public:
OSSet * mappings;
- void * __reserved[8];
+ UInt8 sharedInstance;
+ UInt8 closed;
+ UInt8 __ipcFinal;
+ UInt8 __reservedA[1];
+ volatile SInt32 __ipc;
+ queue_head_t owners;
+#if __LP64__
+ void * __reserved[5];
+#else
+ void * __reserved[4];
+#endif
+
+#else /* XNU_KERNEL_PRIVATE */
+private:
+ void * __reserved[9];
+#endif /* XNU_KERNEL_PRIVATE */
+
+public:
+ virtual IOReturn externalMethod( uint32_t selector, IOExternalMethodArguments * arguments,
+ IOExternalMethodDispatch * dispatch = 0, OSObject * target = 0, void * reference = 0 );
+
+ virtual IOReturn registerNotificationPort(
+ mach_port_t port, UInt32 type, io_user_reference_t refCon);
private:
+#if __LP64__
OSMetaClassDeclareReservedUnused(IOUserClient, 0);
OSMetaClassDeclareReservedUnused(IOUserClient, 1);
+#else
+ OSMetaClassDeclareReservedUsed(IOUserClient, 0);
+ OSMetaClassDeclareReservedUsed(IOUserClient, 1);
+#endif
OSMetaClassDeclareReservedUnused(IOUserClient, 2);
OSMetaClassDeclareReservedUnused(IOUserClient, 3);
OSMetaClassDeclareReservedUnused(IOUserClient, 4);
OSMetaClassDeclareReservedUnused(IOUserClient, 14);
OSMetaClassDeclareReservedUnused(IOUserClient, 15);
+#ifdef XNU_KERNEL_PRIVATE
+
+ /* Available within xnu source only */
+public:
+ static void initialize( void );
+ static void destroyUserReferences( OSObject * obj );
+ static bool finalizeUserReferences( OSObject * obj );
+ IOMemoryMap * mapClientMemory64( IOOptionBits type,
+ task_t task,
+ IOOptionBits mapFlags = kIOMapAnywhere,
+ mach_vm_address_t atAddress = 0 );
+ IOReturn registerOwner(task_t task);
+ void noMoreSenders(void);
+
+#endif /* XNU_KERNEL_PRIVATE */
+
protected:
static IOReturn sendAsyncResult(OSAsyncReference reference,
IOReturn result, void *args[], UInt32 numArgs);
static void setAsyncReference(OSAsyncReference asyncRef,
mach_port_t wakePort,
void *callback, void *refcon);
-public:
- static void initialize( void );
+ static IOReturn sendAsyncResult64(OSAsyncReference64 reference,
+ IOReturn result, io_user_reference_t args[], UInt32 numArgs);
+
+ /*!
+ @function sendAsyncResult64WithOptions
+ @abstract Send a notification as with sendAsyncResult, but with finite queueing.
+ @discussion IOUserClient::sendAsyncResult64() will infitely queue messages if the client
+ is not processing them in a timely fashion. This variant will not, for simple
+ handling of situations where clients may be expected to stop processing messages.
+ */
+ static IOReturn sendAsyncResult64WithOptions(OSAsyncReference64 reference,
+ IOReturn result, io_user_reference_t args[], UInt32 numArgs,
+ IOOptionBits options);
+
+ static void setAsyncReference64(OSAsyncReference64 asyncRef,
+ mach_port_t wakePort,
+ mach_vm_address_t callback, io_user_reference_t refcon);
+
+ static void setAsyncReference64(OSAsyncReference64 asyncRef,
+ mach_port_t wakePort,
+ mach_vm_address_t callback, io_user_reference_t refcon,
+ task_t task);
- static void destroyUserReferences( OSObject * obj );
+public:
+
+ static IOReturn clientHasAuthorization( task_t task,
+ IOService * service );
static IOReturn clientHasPrivilege( void * securityToken,
const char * privilegeName );
+ static OSObject * copyClientEntitlement( task_t task,
+ const char * entitlement );
+
+ /*!
+ @function releaseAsyncReference64
+ @abstract Release the mach_port_t reference held within the OSAsyncReference64 structure.
+ @discussion The OSAsyncReference64 structure passed to async methods holds a reference to the wakeup mach port, which should be released to balance each async method call. Behavior is undefined if these calls are not correctly balanced.
+ @param reference The reference passed to the subclass IOAsyncMethod, or externalMethod() in the IOExternalMethodArguments.asyncReference field.
+ @result A return code.
+ */
+ static IOReturn releaseAsyncReference64(OSAsyncReference64 reference);
+ /*!
+ @function releaseNotificationPort
+ @abstract Release the mach_port_t passed to registerNotificationPort().
+ @discussion The mach_port_t passed to the registerNotificationPort() methods should be released to balance each call to registerNotificationPort(). Behavior is undefined if these calls are not correctly balanced.
+ @param port The mach_port_t argument previously passed to the subclass implementation of registerNotificationPort().
+ @result A return code.
+ */
+ static IOReturn releaseNotificationPort(mach_port_t port);
+
+ virtual bool init() APPLE_KEXT_OVERRIDE;
+ virtual bool init( OSDictionary * dictionary ) APPLE_KEXT_OVERRIDE;
// Currently ignores the all args, just passes up to IOService::init()
virtual bool initWithTask(
task_t owningTask, void * securityToken, UInt32 type,
virtual bool initWithTask(
task_t owningTask, void * securityToken, UInt32 type);
- virtual void free();
+ virtual void free() APPLE_KEXT_OVERRIDE;
virtual IOReturn clientClose( void );
virtual IOReturn clientDied( void );
IOOptionBits * options,
IOMemoryDescriptor ** memory );
- virtual IOMemoryMap * mapClientMemory( IOOptionBits type,
+#if !__LP64__
+private:
+ APPLE_KEXT_COMPATIBILITY_VIRTUAL
+ IOMemoryMap * mapClientMemory( IOOptionBits type,
task_t task,
IOOptionBits mapFlags = kIOMapAnywhere,
- IOVirtualAddress atAddress = 0 );
+ IOVirtualAddress atAddress = 0 );
+#endif
+
+ static IOReturn _sendAsyncResult64(OSAsyncReference64 reference,
+ IOReturn result, io_user_reference_t args[], UInt32 numArgs, IOOptionBits options);
+public:
/*!
@function removeMappingForDescriptor
// Old methods for accessing method vector backward compatiblility only
virtual IOExternalMethod *
- getExternalMethodForIndex( UInt32 index );
+ getExternalMethodForIndex( UInt32 index )
+ APPLE_KEXT_DEPRECATED;
virtual IOExternalAsyncMethod *
- getExternalAsyncMethodForIndex( UInt32 index );
+ getExternalAsyncMethodForIndex( UInt32 index )
+ APPLE_KEXT_DEPRECATED;
// Methods for accessing method vector.
virtual IOExternalMethod *
// Methods for accessing trap vector - old and new style
virtual IOExternalTrap *
- getExternalTrapForIndex( UInt32 index );
+ getExternalTrapForIndex( UInt32 index )
+ APPLE_KEXT_DEPRECATED;
+
virtual IOExternalTrap *
getTargetAndTrapForIndex( IOService **targetP, UInt32 index );
};
projects / apple / xnu.git / blobdiff