DiskArbitrationPrivate.h   [plain text]

/*
 * Copyright (c) 1998-2005 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_LICENSE_HEADER_START@
 * 
 * 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. 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, QUIET ENJOYMENT OR NON-INFRINGEMENT.
 * Please see the License for the specific language governing rights and
 * limitations under the License.
 * 
 * @APPLE_LICENSE_HEADER_END@
 */

#ifndef __DISKARBITRATION_DISKARBITRATIONPRIVATE__
#define __DISKARBITRATION_DISKARBITRATIONPRIVATE__

#include <mach/mach.h>
#include <sys/types.h>
#include <CoreFoundation/CoreFoundation.h>
#include <DiskArbitration/DiskArbitration.h>

#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */

#ifndef __DISKARBITRATIOND__

enum
{
    kDA_DISK_APPEARED                        = 1,
    kDA_DISK_UNMOUNT_PRE_NOTIFY              = 2,
    kDA_DISK_UNMOUNT_POST_NOTIFY             = 3,
    kDA_DISK_EJECT_PRE_NOTIFY                = 4,
    kDA_DISK_EJECT_POST_NOTIFY               = 5,
    kDA_CLIENT_DISCONNECTED                  = 6,
    kDA_DISK_CHANGED                         = 7,
    kDA_NOTIFICATIONS_COMPLETE               = 8,
    kDA_WILL_CLIENT_RELEASE_DEVICE           = 9,
    kDA_DEVICE_RESERVATION_STATUS            = 10,
    kDA_CLIENT_WILL_HANDLE_UNRECOGNIZED_DISK = 11,
    kDA_DISK_APPEARED1                       = 12,
    kDA_DISK_APPEARED_WITH_MT                = 13,
    kDA_BLUE_BOX_UPDATED                     = 16,
    kDA_DISK_WILL_BE_CHECKED                 = 21,
    kDA_CALL_FAILED                          = 22,
    kDA_CALL_SUCCEEDED                       = 23,
    kDA_DISK_APPROVAL_NOTIFY                 = 24,
    kDA_DISK_APPEARED_COMPLETE               = 25
};

enum
{
    kDiskArbDeviceIsReserved          = 0,
    kDiskArbDeviceIsNotReserved       = 1,
    kDiskArbDeviceReservationObtained = 2,
    kDiskArbDeviceReservationRefused  = 3
};

enum
{
    kDiskArbDiskAppearedLockedMask                 = 1 << 0,
    kDiskArbDiskAppearedEjectableMask              = 1 << 1,
    kDiskArbDiskAppearedWholeDiskMask              = 1 << 2,
    kDiskArbDiskAppearedNetworkDiskMask            = 1 << 3,
    kDiskArbDiskAppearedBeingCheckedMask           = 1 << 4,
    kDiskArbDiskAppearedNonLeafDiskMask            = 1 << 5,
    kDiskArbDiskAppearedCDROMMask                  = 1 << 6,
    kDiskArbDiskAppearedDVDROMMask                 = 1 << 7,
    kDiskArbDiskAppearedUnrecognizableFormat       = 1 << 8,
    kDiskArbDiskAppearedUnrecognizableSection      = 1 << 9,
    kDiskArbDiskAppearedRecognizableSectionMounted = 1 << 10,
    kDiskArbDiskAppearedDialogDisplayed            = 1 << 11,
    kDiskArbDiskAppearedNoMountMask                = 1 << 12,
    kDiskArbDiskAppearedNoSizeMask                 = 1 << 13,
    kDiskArbDiskAppearedCheckFailed                = 1 << 14,
    kDiskArbDiskAppearedInternal                   = 1 << 15,
};

enum
{
    kDiskArbApproveMounting       = 0,
    kDiskArbDisallowMounting      = 1 << 0,
    kDiskArbEjectDevice           = 1 << 2,
    kDiskArbRequireAuthentication = 1 << 3,
    kDiskArbMountReadOnly         = 1 << 4
};

enum
{
    kDiskArbUnmountAllFlag      = 1 << 0,
    kDiskArbUnmountAndEjectFlag = 1 << 1,
    kDiskArbUnmountOneFlag      = 1 << 2,
    kDiskArbForceUnmountFlag    = 1 << 3,
    kDiskArbNetworkUnmountFlag  = 1 << 4
};

enum
{
    kDiskArbCompletedDiskAppeared = 1 << 0,
    kDiskArbCompletedPreUnmount   = 1 << 1,
    kDiskArbCompletedPostUnmount  = 1 << 2,
    kDiskArbCompletedPreEject     = 1 << 3,
    kDiskArbCompletedPostEject    = 1 << 4
};

enum
{
    kDiskArbRenameSuccessful      = 1 << 0,
    kDiskArbRenameRequiresRemount = 1 << 1
};

enum
{
    kDiskArbHandlesUnrecognizedFixedMedia           = 1 << 0,
    kDiskArbHandlesUnrecognizedCDMedia              = 1 << 1,
    kDiskArbHandlesUnrecognizedDVDMedia             = 1 << 2,
    kDiskArbHandlesUnrecognizedOtherRemovableMedia  = 1 << 3,
    kDiskArbHandlesUninitializedFixedMedia          = 1 << 10,
    kDiskArbHandlesUninitializedCDMedia             = 1 << 11,
    kDiskArbHandlesUninitializedDVDMedia            = 1 << 12,
    kDiskArbHandlesUninitializedOtherRemovableMedia = 1 << 13
};

enum
{
    kDiskArbHandlesAllUnrecognizedMedia                = 0x000000FF,
    kDiskArbHandlesAllUninitializedMedia               = 0x0000FF00,
    kDiskArbHandlesAllUnrecognizedOrUninitializedMedia = 0x0000FFFF,
};

enum
{
    kDiskArbUnmountRequestFailed         = 1 << 0,
    kDiskArbEjectRequestFailed           = 1 << 1,
    kDiskArbUnmountAndEjectRequestFailed = 1 << 2,
    kDiskArbDiskChangeRequestFailed      = 1 << 3
};

typedef char DiskArbDeviceTreePath[1024];
typedef char DiskArbDiskIdentifier[1024];
typedef char DiskArbGenericString[1024];
typedef char DiskArbIOContent[1024];
typedef char DiskArbMountpoint[1024];

typedef void ( *DiskArbCallback_BlueBoxBootVolumeUpdated_t )( int sequence );

typedef void ( *DiskArbCallback_CallFailedNotification_t )( char * disk, int type, int status );

typedef void ( *DiskArbCallback_CallSucceededNotification_t )( char * disk, int type );

typedef void ( *DiskArbCallback_ClientDisconnectedNotification_t )( void );

typedef void ( *DiskArbCallback_Device_Reservation_Status_t )( char * disk, int status, int pid );

typedef int  ( *DiskArbCallback_DiskAppeared_t )( char * disk, unsigned flags, char * mountpoint, char * content );

typedef void ( *DiskArbCallback_DiskAppeared2_t )( char *   disk,
                                                   unsigned flags,
                                                   char *   mountpoint,
                                                   char *   content,
                                                   char *   path,
                                                   unsigned sequence );

typedef void ( *DiskArbCallback_DiskAppearedComplete_t )( char *   disk,
                                                          unsigned flags,
                                                          char *   mountpoint,
                                                          char *   content,
                                                          char *   path,
                                                          unsigned sequence,
                                                          double   time,
                                                          char *   filesystem,
                                                          char *   name );

typedef int  ( *DiskArbCallback_DiskAppearedWithMountpoint_t )( char * disk, unsigned flags, char * mountpoint );

typedef void ( *DiskArbCallback_DiskApprovalNotification_t )( char *   disk,
                                                              char *   name,
                                                              char *   content,
                                                              char *   path,
                                                              unsigned flags,
                                                              int      writable,
                                                              int      removable,
                                                              int      whole,
                                                              char *   filesystem );

typedef void ( *DiskArbCallback_DiskChangedNotification_t )( char * disk, char * mountpoint, char * name, int flags, int success );

typedef void ( *DiskArbCallback_EjectPostNotification_t )( char * disk, int status, pid_t dissenter );

typedef void ( *DiskArbCallback_EjectPreNotification_t )( char * disk, unsigned reserved0032 );

typedef void ( *DiskArbCallback_DiskWillBeCheckedNotification_t )( char * disk, int flags, char * content );

typedef void ( *DiskArbCallback_NotificationComplete_t )( int type );

typedef void ( *DiskArbCallback_UnknownFileSystemNotification_t )( char * disk,
                                                                   char * reserved0032,
                                                                   char * reserved0064,
                                                                   int    writable,
                                                                   int    removable,
                                                                   int    whole );

typedef void ( *DiskArbCallback_UnmountPostNotification_t )( char * disk, int status, pid_t dissenter );

typedef void ( *DiskArbCallback_UnmountPreNotification_t )( char * disk, unsigned reserved0032 );

typedef void ( *DiskArbCallback_Will_Client_Release_t )( char * disk, int pid );

typedef void ( *DiskArbCallback_Will_Client_Handle_Unrecognized_Disk_t )( char * disk,
                                                                          int    type,
                                                                          char * reserved0064,
                                                                          char * reserved0096,
                                                                          int    writable,
                                                                          int    removable,
                                                                          int    whole );

extern void          DiskArbAddCallbackHandler( int type, void * callback, int overwrite );
extern kern_return_t DiskArbClientHandlesUninitializedDisks_auto( int yes );
extern kern_return_t DiskArbClientHandlesUnrecognizedDisks( int types, int priority );
extern kern_return_t DiskArbClientRelinquishesReservation( char * disk, int pid, int status );
extern kern_return_t DiskArbClientWillHandleUnrecognizedDisk( char * disk, int yes );
extern kern_return_t DiskArbDiskAppearedWithMountpointPing_auto( char * disk, unsigned reserved0032, char * mountpoint );
extern kern_return_t DiskArbDiskApprovedAck_auto( char * disk, int status );
extern kern_return_t DiskArbDiskDisappearedPing_auto( char * disk, unsigned reserved0032 );
extern kern_return_t DiskArbEjectPreNotifyAck_async_auto( char * disk, int status );
extern kern_return_t DiskArbEjectRequest_async_auto( char * disk, unsigned flags );
extern int           DiskArbGetVolumeEncoding_auto( char * disk );
extern boolean_t     DiskArbHandleMsg( mach_msg_header_t * message, mach_msg_header_t * reply );
extern kern_return_t DiskArbInit( void );
extern int           DiskArbIsActive( void );
extern kern_return_t DiskArbIsDeviceReservedForClient( char * disk );
extern kern_return_t DiskArbMsgLoop( void );
extern kern_return_t DiskArbMsgLoopWithTimeout( mach_msg_timeout_t timeout );
extern void          DiskArbNoOp( void );
extern kern_return_t DiskArbRefresh_auto( void );
extern void          DiskArbRegisterCallback_BlueBoxBootVolumeUpdated( DiskArbCallback_BlueBoxBootVolumeUpdated_t callback );
extern void          DiskArbRegisterCallback_CallFailedNotification( DiskArbCallback_CallFailedNotification_t callback );
extern void          DiskArbRegisterCallback_CallSucceededNotification( DiskArbCallback_CallSucceededNotification_t callback );
extern void          DiskArbRegisterCallback_ClientDisconnectedNotification( DiskArbCallback_ClientDisconnectedNotification_t callback );
extern void          DiskArbRegisterCallback_DiskAppeared( DiskArbCallback_DiskAppeared_t callback );
extern void          DiskArbRegisterCallback_DiskAppeared2( DiskArbCallback_DiskAppeared2_t callback );
extern void          DiskArbRegisterCallback_DiskAppearedWithMountpoint( DiskArbCallback_DiskAppearedWithMountpoint_t callback );
extern void          DiskArbRegisterCallback_DiskChangedNotification( DiskArbCallback_DiskChangedNotification_t callback );
extern void          DiskArbRegisterCallback_DiskWillBeCheckedNotification( DiskArbCallback_DiskWillBeCheckedNotification_t callback );
extern void          DiskArbRegisterCallback_EjectPostNotification( DiskArbCallback_EjectPostNotification_t callback );
extern void          DiskArbRegisterCallback_EjectPreNotification( DiskArbCallback_EjectPreNotification_t callback );
extern void          DiskArbRegisterCallback_NotificationComplete( DiskArbCallback_NotificationComplete_t callback );
extern void          DiskArbRegisterCallback_UnknownFileSystemNotification( DiskArbCallback_UnknownFileSystemNotification_t callback );
extern void          DiskArbRegisterCallback_UnmountPostNotification( DiskArbCallback_UnmountPostNotification_t callback );
extern void          DiskArbRegisterCallback_UnmountPreNotification( DiskArbCallback_UnmountPreNotification_t callback );
extern kern_return_t DiskArbReleaseClientReservationForDevice( char * disk );
extern void          DiskArbRemoveCallbackHandler( int type, void * callback );
extern kern_return_t DiskArbRequestDiskChange_auto( char * disk, char * name, int flags );
extern kern_return_t DiskArbRequestMount_auto( char * disk );
extern kern_return_t DiskArbRequestMountAndOwn_auto( char * disk );
extern kern_return_t DiskArbRetainClientReservationForDevice( char * disk );
extern kern_return_t DiskArbSetBlueBoxBootVolume_async_auto( int pid, int sequence );
extern kern_return_t DiskArbSetCurrentUser_auto( int user );
extern kern_return_t DiskArbSetVolumeEncoding_auto( char * disk, int encoding );
extern kern_return_t DiskArbStart( mach_port_t * port );
extern kern_return_t DiskArbUnmountAndEjectRequest_async_auto( char * disk, unsigned flags );
extern kern_return_t DiskArbUnmountPreNotifyAck_async_auto( char * disk, int status );
extern kern_return_t DiskArbUnmountRequest_async_auto( char * disk, unsigned flags );
extern void          DiskArbUpdateClientFlags( void );
extern kern_return_t DiskArbVSDBAdoptVolume_auto( char * disk );
extern kern_return_t DiskArbVSDBDisownVolume_auto( char * disk );
extern int           DiskArbVSDBGetVolumeStatus_auto( char * disk );

#endif /* !__DISKARBITRATIOND__ */

extern const CFStringRef kDAApprovalRunLoopMode;

extern const CFStringRef kDADiskDescriptionAppearanceTimeKey;

#ifndef __DISKARBITRATIOND__

extern DAReturn _DADiskRefresh( DADiskRef disk );

extern DAReturn _DADiskSetAdoption( DADiskRef disk, Boolean adoption );

extern DAReturn _DADiskSetClassic( DADiskRef disk );

extern DAReturn _DADiskSetEncoding( DADiskRef disk, UInt32 encoding );

typedef void ( *_DADiskClassicCallback )( DADiskRef disk, void * context );

extern void _DARegisterDiskClassicCallback( DASessionRef           session,
                                            CFDictionaryRef        match,
                                            _DADiskClassicCallback callback,
                                            void *                 context );

extern DADiskRef DADiskCreateFromVolumePath( CFAllocatorRef allocator, DASessionRef session, CFURLRef path );

typedef void ( *DAIdleCallback )( void * context );

extern void DARegisterIdleCallback( DASessionRef session, DAIdleCallback callback, void * context );

#endif /* !__DISKARBITRATIOND__ */

#ifdef __cplusplus
}
#endif /* __cplusplus */

#endif /* !__DISKARBITRATION_DISKARBITRATIONPRIVATE__ */