2 * PROJECT: ReactOS Kernel
3 * LICENSE: GPL - See COPYING in the top level directory
4 * FILE: ntoskrnl/include/io.h
5 * PURPOSE: Internal header for the I/O Manager
6 * PROGRAMMERS: Alex Ionescu (alex.ionescu@reactos.org)
11 // Define this if you want debugging support
13 #define _IO_DEBUG_ 0x00
16 // These define the Debug Masks Supported
18 #define IO_IRP_DEBUG 0x01
19 #define IO_FILE_DEBUG 0x02
20 #define IO_API_DEBUG 0x04
21 #define IO_CTL_DEBUG 0x08
24 // Debug/Tracing support
27 #ifdef NEW_DEBUG_SYSTEM_IMPLEMENTED // enable when Debug Filters are implemented
28 #define IOTRACE(x, ...) \
30 DbgPrintEx("%s [%.16s] - ", \
32 PsGetCurrentProcess()->ImageFileName); \
33 DbgPrintEx(__VA_ARGS__); \
36 #define IOTRACE(x, ...) \
37 if (x & IopTraceLevel) \
39 DbgPrint("%s [%.16s] - ", \
41 PsGetCurrentProcess()->ImageFileName); \
42 DbgPrint(__VA_ARGS__); \
46 #define IOTRACE(x, ...) DPRINT(__VA_ARGS__)
50 // Registry path to the enumeration root key
52 #define ENUM_ROOT L"\\Registry\\Machine\\System\\CurrentControlSet\\Enum"
55 // Returns the type of METHOD_ used in this IOCTL
57 #define IO_METHOD_FROM_CTL_CODE(c) (c & 0x00000003)
60 // Bugcheck codes for RAM disk booting
63 // No LoaderXIPRom descriptor was found in the loader memory list
65 #define RD_NO_XIPROM_DESCRIPTOR 1
67 // Unable to open the RAM disk driver (ramdisk.sys or \Device\Ramdisk)
69 #define RD_NO_RAMDISK_DRIVER 2
71 // FSCTL_CREATE_RAM_DISK failed
73 #define RD_FSCTL_FAILED 3
75 // Unable to create GUID string from binary GUID
77 #define RD_GUID_CONVERT_FAILED 4
79 // Unable to create symbolic link pointing to the RAM disk device
81 #define RD_SYMLINK_CREATE_FAILED 5
84 // We can call the Ob Inlined API, it's the same thing
86 #define IopAllocateMdlFromLookaside \
87 ObpAllocateObjectCreateInfoBuffer
88 #define IopFreeMdlFromLookaside \
89 ObpFreeCapturedAttributes
92 // Returns the size of a CM_RESOURCE_LIST
94 #define CM_RESOURCE_LIST_SIZE(ResList) \
95 (ResList->Count == 1) ? \
98 List[0].PartialResourceList. \
99 PartialDescriptors[(ResList)-> \
101 PartialResourceList. \
104 FIELD_OFFSET(CM_RESOURCE_LIST, List)
107 // Determines if the IRP is Synchronous
109 #define IsIrpSynchronous(Irp, FileObject) \
110 ((Irp->Flags & IRP_SYNCHRONOUS_API) || \
113 FileObject->Flags & FO_SYNCHRONOUS_IO)) \
116 // Returns the internal Device Object Extension
118 #define IoGetDevObjExtension(DeviceObject) \
119 ((PEXTENDED_DEVOBJ_EXTENSION) \
120 (DeviceObject->DeviceObjectExtension)) \
123 // Returns the internal Driver Object Extension
125 #define IoGetDrvObjExtension(DriverObject) \
126 ((PEXTENDED_DRIVER_EXTENSION) \
127 (DriverObject->DriverExtension)) \
131 * IopDeviceNodeSetFlag(
132 * PDEVICE_NODE DeviceNode,
135 #define IopDeviceNodeSetFlag(DeviceNode, Flag) \
136 ((DeviceNode)->Flags |= (Flag))
140 * IopDeviceNodeClearFlag(
141 * PDEVICE_NODE DeviceNode,
144 #define IopDeviceNodeClearFlag(DeviceNode, Flag) \
145 ((DeviceNode)->Flags &= ~(Flag))
149 * IopDeviceNodeHasFlag(
150 * PDEVICE_NODE DeviceNode,
153 #define IopDeviceNodeHasFlag(DeviceNode, Flag) \
154 (((DeviceNode)->Flags & (Flag)) > 0)
158 * IopDeviceNodeSetUserFlag(
159 * PDEVICE_NODE DeviceNode,
162 #define IopDeviceNodeSetUserFlag(DeviceNode, UserFlag) \
163 ((DeviceNode)->UserFlags |= (UserFlag))
167 * IopDeviceNodeClearUserFlag(
168 * PDEVICE_NODE DeviceNode,
171 #define IopDeviceNodeClearUserFlag(DeviceNode, UserFlag)\
172 ((DeviceNode)->UserFlags &= ~(UserFlag))
176 * IopDeviceNodeHasUserFlag(
177 * PDEVICE_NODE DeviceNode,
180 #define IopDeviceNodeHasUserFlag(DeviceNode, UserFlag) \
181 (((DeviceNode)->UserFlags & (UserFlag)) > 0)
185 * IopDeviceNodeSetProblem(
186 * PDEVICE_NODE DeviceNode,
189 #define IopDeviceNodeSetProblem(DeviceNode, Problem) \
190 ((DeviceNode)->Problem |= (Problem))
194 * IopDeviceNodeClearProblem(
195 * PDEVICE_NODE DeviceNode,
198 #define IopDeviceNodeClearProblem(DeviceNode, Problem) \
199 ((DeviceNode)->Problem &= ~(Problem))
203 * IopDeviceNodeHasProblem(
204 * PDEVICE_NODE DeviceNode,
207 #define IopDeviceNodeHasProblem(DeviceNode, Problem) \
208 (((DeviceNode)->Problem & (Problem)) > 0)
212 * IopInitDeviceTreeTraverseContext(
213 * PDEVICETREE_TRAVERSE_CONTEXT DeviceTreeTraverseContext,
214 * PDEVICE_NODE DeviceNode,
215 * DEVICETREE_TRAVERSE_ROUTINE Action,
218 #define IopInitDeviceTreeTraverseContext( \
219 _DeviceTreeTraverseContext, _DeviceNode, _Action, \
221 (_DeviceTreeTraverseContext)->FirstDeviceNode = \
223 (_DeviceTreeTraverseContext)->Action = (_Action); \
224 (_DeviceTreeTraverseContext)->Context = (_Context); }
227 // Device List Operations
229 typedef enum _IOP_DEVICE_LIST_OPERATION
233 } IOP_DEVICE_LIST_OPERATION
, *PIOP_DEVICE_LIST_OPERATION
;
236 // Transfer statistics
238 typedef enum _IOP_TRANSFER_TYPE
243 } IOP_TRANSFER_TYPE
, *PIOP_TRANSFER_TYPE
;
246 // Packet Types when piggybacking on the IRP Overlay
248 typedef enum _COMPLETION_PACKET_TYPE
250 IopCompletionPacketIrp
,
251 IopCompletionPacketMini
,
252 IopCompletionPacketQuota
253 } COMPLETION_PACKET_TYPE
, *PCOMPLETION_PACKET_TYPE
;
256 // Special version of the IRP Overlay used to optimize I/O completion
257 // by not using up a separate structure.
259 typedef struct _IOP_MINI_COMPLETION_PACKET
263 LIST_ENTRY ListEntry
;
266 struct _IO_STACK_LOCATION
*CurrentStackLocation
;
273 ULONG_PTR IoStatusInformation
;
274 } IOP_MINI_COMPLETION_PACKET
, *PIOP_MINI_COMPLETION_PACKET
;
277 // I/O Completion Context for IoSetIoCompletionRoutineEx
279 typedef struct _IO_UNLOAD_SAFE_COMPLETION_CONTEXT
281 PDEVICE_OBJECT DeviceObject
;
283 PIO_COMPLETION_ROUTINE CompletionRoutine
;
284 } IO_UNLOAD_SAFE_COMPLETION_CONTEXT
, *PIO_UNLOAD_SAFE_COMPLETION_CONTEXT
;
287 // I/O Wrapper around the Executive Work Item
289 typedef struct _IO_WORKITEM
291 WORK_QUEUE_ITEM Item
;
292 PDEVICE_OBJECT DeviceObject
;
293 PIO_WORKITEM_ROUTINE WorkerRoutine
;
298 // I/O Wrapper around the Kernel Interrupt
300 typedef struct _IO_INTERRUPT
302 KINTERRUPT FirstInterrupt
;
303 PKINTERRUPT Interrupt
[MAXIMUM_PROCESSORS
];
305 } IO_INTERRUPT
, *PIO_INTERRUPT
;
308 // I/O Error Log Packet Header
310 typedef struct _ERROR_LOG_ENTRY
314 LIST_ENTRY ListEntry
;
315 PDEVICE_OBJECT DeviceObject
;
316 PDRIVER_OBJECT DriverObject
;
317 LARGE_INTEGER TimeStamp
;
318 } ERROR_LOG_ENTRY
, *PERROR_LOG_ENTRY
;
321 // Event Log LPC Message
323 typedef struct _ELF_API_MSG
327 IO_ERROR_LOG_MESSAGE IoErrorMessage
;
328 } ELF_API_MSG
, *PELF_API_MSG
;
331 // To simplify matters, the kernel is made to support both the checked and free
332 // version of the I/O Remove Lock in the same binary. This structure includes
333 // both, since the DDK has the structure with a compile-time #ifdef.
335 typedef struct _EXTENDED_IO_REMOVE_LOCK
337 IO_REMOVE_LOCK_COMMON_BLOCK Common
;
338 IO_REMOVE_LOCK_DBG_BLOCK Dbg
;
339 } EXTENDED_IO_REMOVE_LOCK
, *PEXTENDED_IO_REMOVE_LOCK
;
342 // Dummy File Object used inside the Open Packet so that OB knows how to
343 // deal with the Object Pointer even though it's not a real file.
345 typedef struct _DUMMY_FILE_OBJECT
347 OBJECT_HEADER ObjectHeader
;
348 CHAR FileObjectBody
[sizeof(FILE_OBJECT
)];
349 } DUMMY_FILE_OBJECT
, *PDUMMY_FILE_OBJECT
;
352 // Open packet used as a context for Device/File parsing so that the parse
353 // routine can know what operation is being requested.
355 typedef struct _OPEN_PACKET
359 PFILE_OBJECT FileObject
;
360 NTSTATUS FinalStatus
;
361 ULONG_PTR Information
;
363 PFILE_OBJECT RelatedFileObject
;
364 OBJECT_ATTRIBUTES OriginalAttributes
;
365 LARGE_INTEGER AllocationSize
;
367 USHORT FileAttributes
;
373 PFILE_BASIC_INFORMATION BasicInformation
;
374 PFILE_NETWORK_OPEN_INFORMATION NetworkInformation
;
375 CREATE_FILE_TYPE CreateFileType
;
376 PVOID MailslotOrPipeParameters
;
380 BOOLEAN FullAttributes
;
381 PDUMMY_FILE_OBJECT DummyFileObject
;
383 //PIO_DRIVER_CREATE_CONTEXT DriverCreateContext; Vista only, needs ROS DDK Update
384 } OPEN_PACKET
, *POPEN_PACKET
;
387 // Parameters packet for Load/Unload work item's context
389 typedef struct _LOAD_UNLOAD_PARAMS
392 PUNICODE_STRING ServiceName
;
393 WORK_QUEUE_ITEM WorkItem
;
395 PDRIVER_OBJECT DriverObject
;
396 } LOAD_UNLOAD_PARAMS
, *PLOAD_UNLOAD_PARAMS
;
399 // List of Bus Type GUIDs
401 typedef struct _IO_BUS_TYPE_GUID_LIST
406 } IO_BUS_TYPE_GUID_LIST
, *PIO_BUS_TYPE_GUID_LIST
;
407 extern PIO_BUS_TYPE_GUID_LIST IopBusTypeGuidList
;
410 // Shutdown entry for registed devices
412 typedef struct _SHUTDOWN_ENTRY
414 LIST_ENTRY ShutdownList
;
415 PDEVICE_OBJECT DeviceObject
;
416 } SHUTDOWN_ENTRY
, *PSHUTDOWN_ENTRY
;
419 // F/S Notification entry for registered File Systems
421 typedef struct _FS_CHANGE_NOTIFY_ENTRY
423 LIST_ENTRY FsChangeNotifyList
;
424 PDRIVER_OBJECT DriverObject
;
425 PDRIVER_FS_NOTIFICATION FSDNotificationProc
;
426 } FS_CHANGE_NOTIFY_ENTRY
, *PFS_CHANGE_NOTIFY_ENTRY
;
429 // Driver (Boot) Re-Initialization Entry
431 typedef struct _DRIVER_REINIT_ITEM
433 LIST_ENTRY ItemEntry
;
434 PDRIVER_OBJECT DriverObject
;
435 PDRIVER_REINITIALIZE ReinitRoutine
;
437 } DRIVER_REINIT_ITEM
, *PDRIVER_REINIT_ITEM
;
440 // Called on every visit of a node during a preorder-traversal of the device
442 // If the routine returns STATUS_UNSUCCESSFUL the traversal will stop and
443 // STATUS_SUCCESS is returned to the caller who initiated the tree traversal.
444 // Any other returned status code will be returned to the caller. If a status
445 // code that indicates an error (other than STATUS_UNSUCCESSFUL) is returned,
446 // the traversal is stopped immediately and the status code is returned to
451 (*DEVICETREE_TRAVERSE_ROUTINE
)(
452 IN PDEVICE_NODE DeviceNode
,
457 // Context information for traversing the device tree
459 typedef struct _DEVICETREE_TRAVERSE_CONTEXT
462 // Current device node during a traversal
464 PDEVICE_NODE DeviceNode
;
467 // Initial device node where we start the traversal
469 PDEVICE_NODE FirstDeviceNode
;
472 // Action routine to be called for every device node
474 DEVICETREE_TRAVERSE_ROUTINE Action
;
477 // Context passed to the action routine
480 } DEVICETREE_TRAVERSE_CONTEXT
, *PDEVICETREE_TRAVERSE_CONTEXT
;
502 IopInitDriverImplementation(
507 IopInitPnpNotificationImplementation(
512 IopNotifyPlugPlayNotification(
513 IN PDEVICE_OBJECT DeviceObject
,
514 IN IO_NOTIFICATION_EVENT_CATEGORY EventCategory
,
516 IN PVOID EventCategoryData1
,
517 IN PVOID EventCategoryData2
521 IopGetSystemPowerDeviceObject(
522 IN PDEVICE_OBJECT
*DeviceObject
527 IN PDEVICE_NODE ParentNode
,
528 IN PDEVICE_OBJECT PhysicalDeviceObject
,
529 IN PUNICODE_STRING ServiceName
,
530 OUT PDEVICE_NODE
*DeviceNode
535 IN PDEVICE_NODE DeviceNode
540 IN PDEVICE_OBJECT DeviceObject
,
541 IN PIO_STATUS_BLOCK IoStatusBlock
,
542 IN ULONG MinorFunction
,
543 IN PIO_STACK_LOCATION Stack
549 IN PDEVICE_OBJECT DeviceObject
553 IopActionConfigureChildServices(
554 IN PDEVICE_NODE DeviceNode
,
559 IopActionInitChildServices(
560 IN PDEVICE_NODE DeviceNode
,
566 IN PDEVICE_OBJECT DeviceObject
581 IopInitPlugPlayEvents(VOID
);
584 IopQueueTargetDeviceEvent(
586 PUNICODE_STRING DeviceIds
590 IopInitializePnpServices(
591 IN PDEVICE_NODE DeviceNode
);
595 IopOpenRegistryKeyEx(
598 PUNICODE_STRING Name
,
599 ACCESS_MASK DesiredAccess
);
603 IopGetRegistryValue(IN HANDLE Handle
,
605 OUT PKEY_VALUE_FULL_INFORMATION
*Information
);
609 // Initialization Routines
614 IN PLOADER_PARAMETER_BLOCK LoaderBlock
619 IopReassignSystemRoot(
620 IN PLOADER_PARAMETER_BLOCK LoaderBlock
,
621 OUT PANSI_STRING NtBootPath
627 IN PLOADER_PARAMETER_BLOCK LoaderBlock
631 // Device/Volume Routines
636 IN PDEVICE_NODE DeviceNode
,
637 IN PDRIVER_OBJECT DriverObject
642 IN PDEVICE_NODE DeviceNode
648 IN POPEN_PACKET OpenPacket
,
649 IN PDEVICE_OBJECT DeviceObject
,
650 IN PUNICODE_STRING RemainingName
,
657 IN PDEVICE_OBJECT DeviceObject
,
658 IN BOOLEAN AllowRawMount
,
659 IN BOOLEAN DeviceIsLocked
,
660 IN BOOLEAN Alertable
,
666 IN PVOID SymbolicLink
671 IN PVOID SymbolicLink
,
678 IN PDEVICE_OBJECT DeviceObject
689 IoInitFileSystemImplementation(
695 IoInitVpbImplementation(
701 IopReferenceDeviceObject(
702 IN PDEVICE_OBJECT DeviceObject
707 IopDereferenceDeviceObject(
708 IN PDEVICE_OBJECT DeviceObject
,
709 IN BOOLEAN ForceUnload
714 IoGetRelatedTargetDevice(IN PFILE_OBJECT FileObject
,
715 OUT PDEVICE_OBJECT
*DeviceObject
724 IN PFILE_OBJECT FileObject
,
725 IN PKEVENT EventObject
,
726 IN PVOID Buffer OPTIONAL
731 IopAbortInterruptedIrp(
732 IN PKEVENT EventObject
,
740 IoInitShutdownNotification(
746 IoShutdownRegisteredDevices(
752 IoShutdownRegisteredFileSystems(
757 // Boot logging support
761 IN BOOLEAN StartBootLog
776 IN PUNICODE_STRING DriverName
,
781 IopSaveBootLogToFile(
786 // I/O Cancellation Routines
795 IoInitCancelHandling(
806 IN PKNORMAL_ROUTINE
* NormalRoutine
,
807 IN PVOID
* NormalContext
,
808 IN PVOID
* SystemArgument1
,
809 IN PVOID
* SystemArgument2
813 // Error Logging Routines
828 // Raw File System MiniDriver
831 RawFsIsRawFileSystemDeviceObject(
832 IN PDEVICE_OBJECT DeviceObject
838 IN PDRIVER_OBJECT DriverObject
,
839 IN PUNICODE_STRING RegistryPath
843 // PnP Root MiniDriver
848 IN PDRIVER_OBJECT DriverObject
,
849 IN PUNICODE_STRING RegistryPath
854 IN PUNICODE_STRING ServiceName
,
855 IN OUT PDEVICE_OBJECT
*PhysicalDeviceObject
863 IopInitializeBootDrivers(
869 IopInitializeSystemDrivers(
875 IopCreateDriver(IN PUNICODE_STRING DriverName OPTIONAL
,
876 IN PDRIVER_INITIALIZE InitializationFunction
,
877 IN PUNICODE_STRING RegistryPath
,
879 IN ULONG SizeOfImage
,
880 OUT PDRIVER_OBJECT
*pDriverObject
);
891 OUT PDRIVER_OBJECT
*DriverObject
,
892 IN PUNICODE_STRING ServiceName
,
893 IN BOOLEAN FileSystem
898 IopLoadServiceModule(
899 IN PUNICODE_STRING ServiceName
,
900 OUT PLDR_DATA_TABLE_ENTRY
*ModuleObject
906 IN OUT PLOAD_UNLOAD_PARAMS LoadParams
911 IopInitializeDriverModule(
912 IN PDEVICE_NODE DeviceNode
,
913 IN PLDR_DATA_TABLE_ENTRY ModuleObject
,
914 IN PUNICODE_STRING ServiceName
,
915 IN BOOLEAN FileSystemDriver
,
916 OUT PDRIVER_OBJECT
*DriverObject
921 IopAttachFilterDrivers(
922 IN PDEVICE_NODE DeviceNode
,
928 IopReinitializeDrivers(
934 IopReinitializeBootDrivers(
943 IopDeleteDevice(IN PVOID ObjectBody
);
948 IN PVOID ParseObject
,
950 IN OUT PACCESS_STATE AccessState
,
951 IN KPROCESSOR_MODE AccessMode
,
953 IN OUT PUNICODE_STRING CompleteName
,
954 IN OUT PUNICODE_STRING RemainingName
,
955 IN OUT PVOID Context OPTIONAL
,
956 IN PSECURITY_QUALITY_OF_SERVICE SecurityQos OPTIONAL
,
963 IN PVOID ParseObject
,
965 IN OUT PACCESS_STATE AccessState
,
966 IN KPROCESSOR_MODE AccessMode
,
968 IN OUT PUNICODE_STRING CompleteName
,
969 IN OUT PUNICODE_STRING RemainingName
,
970 IN OUT PVOID Context OPTIONAL
,
971 IN PSECURITY_QUALITY_OF_SERVICE SecurityQos OPTIONAL
,
985 IN SECURITY_OPERATION_CODE OperationCode
,
986 IN PSECURITY_INFORMATION SecurityInformation
,
987 IN OUT PSECURITY_DESCRIPTOR SecurityDescriptor
,
988 IN OUT PULONG BufferLength
,
989 OUT PSECURITY_DESCRIPTOR
*OldSecurityDescriptor
,
990 IN POOL_TYPE PoolType
,
991 IN OUT PGENERIC_MAPPING GenericMapping
999 OUT POBJECT_NAME_INFORMATION ObjectNameInfo
,
1001 OUT PULONG ReturnLength
,
1002 IN KPROCESSOR_MODE PreviousMode
1008 IN PEPROCESS Process OPTIONAL
,
1010 IN ACCESS_MASK GrantedAccess
,
1011 IN ULONG ProcessHandleCount
,
1012 IN ULONG SystemHandleCount
1016 // I/O Timer Routines
1020 IopInitTimerImplementation(
1026 IopRemoveTimerFromTimerList(
1031 // I/O Completion Routines
1035 IopDeleteIoCompletion(
1045 IN PLOADER_PARAMETER_BLOCK LoaderBlock
1051 extern POBJECT_TYPE IoCompletionType
;
1052 extern PDEVICE_NODE IopRootDeviceNode
;
1053 extern ULONG IopTraceLevel
;
1054 extern GENERAL_LOOKASIDE IopMdlLookasideList
;
1055 extern GENERIC_MAPPING IopCompletionMapping
;
1056 extern GENERIC_MAPPING IopFileMapping
;
1057 extern POBJECT_TYPE _IoFileObjectType
;
1058 extern HAL_DISPATCH _HalDispatchTable
;
1059 extern LIST_ENTRY IopErrorLogListHead
;
1060 extern ULONG IopNumTriageDumpDataBlocks
;
1061 extern PVOID IopTriageDumpDataBlocks
[64];
1064 // Inlined Functions