reactos/ntoskrnl/include/internal/io.h

   1 /*
   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)
   7 */
   8 #include "ntdddisk.h"
   9
  10 //
  11 // Define this if you want debugging support
  12 //
  13 #define _IO_DEBUG_                                      0x00
  14
  15 //
  16 // These define the Debug Masks Supported
  17 //
  18 #define IO_IRP_DEBUG                                    0x01
  19 #define IO_FILE_DEBUG                                   0x02
  20 #define IO_API_DEBUG                                    0x04
  21 #define IO_CTL_DEBUG                                    0x08
  22
  23 //
  24 // Debug/Tracing support
  25 //
  26 #if _IO_DEBUG_
  27 #ifdef NEW_DEBUG_SYSTEM_IMPLEMENTED // enable when Debug Filters are implemented
  28 #define IOTRACE(x, ...)                                     \
  29     {                                                       \
  30         DbgPrintEx("%s [%.16s] - ",                         \
  31                    __FUNCTION__,                            \
  32                    PsGetCurrentProcess()->ImageFileName);   \
  33         DbgPrintEx(__VA_ARGS__);                            \
  34     }
  35 #else
  36 #define IOTRACE(x, ...)                                     \
  37     if (x & IopTraceLevel)                                  \
  38     {                                                       \
  39         DbgPrint("%s [%.16s] - ",                           \
  40                  __FUNCTION__,                              \
  41                  PsGetCurrentProcess()->ImageFileName);     \
  42         DbgPrint(__VA_ARGS__);                              \
  43     }
  44 #endif
  45 #else
  46 #define IOTRACE(x, ...) DPRINT(__VA_ARGS__)
  47 #endif
  48
  49 //
  50 // Registry path to the enumeration root key
  51 //
  52 #define ENUM_ROOT L"\\Registry\\Machine\\System\\CurrentControlSet\\Enum"
  53
  54 //
  55 // Returns the type of METHOD_ used in this IOCTL
  56 //
  57 #define IO_METHOD_FROM_CTL_CODE(c)                      (c & 0x00000003)
  58
  59 //
  60 // Bugcheck codes for RAM disk booting
  61 //
  62 //
  63 // No LoaderXIPRom descriptor was found in the loader memory list
  64 //
  65 #define RD_NO_XIPROM_DESCRIPTOR  1
  66 //
  67 // Unable to open the RAM disk driver (ramdisk.sys or \Device\Ramdisk)
  68 //
  69 #define RD_NO_RAMDISK_DRIVER     2
  70 //
  71 // FSCTL_CREATE_RAM_DISK failed
  72 //
  73 #define RD_FSCTL_FAILED          3
  74 //
  75 // Unable to create GUID string from binary GUID
  76 //
  77 #define RD_GUID_CONVERT_FAILED   4
  78 //
  79 // Unable to create symbolic link pointing to the RAM disk device
  80 //
  81 #define RD_SYMLINK_CREATE_FAILED 5
  82
  83 //
  84 // We can call the Ob Inlined API, it's the same thing
  85 //
  86 #define IopAllocateMdlFromLookaside                     \
  87     ObpAllocateObjectCreateInfoBuffer
  88 #define IopFreeMdlFromLookaside                         \
  89     ObpFreeCapturedAttributes
  90
  91 //
  92 // Determines if the IRP is Synchronous
  93 //
  94 #define IsIrpSynchronous(Irp, FileObject)               \
  95     ((Irp->Flags & IRP_SYNCHRONOUS_API)  ||             \
  96      (!(FileObject) ?                                   \
  97         FALSE :                                         \
  98         FileObject->Flags & FO_SYNCHRONOUS_IO))         \
  99
 100 //
 101 // Returns the internal Device Object Extension
 102 //
 103 #define IoGetDevObjExtension(DeviceObject)              \
 104     ((PEXTENDED_DEVOBJ_EXTENSION)                       \
 105      (DeviceObject->DeviceObjectExtension))             \
 106
 107 //
 108 // Returns the internal Driver Object Extension
 109 //
 110 #define IoGetDrvObjExtension(DriverObject)              \
 111     ((PEXTENDED_DRIVER_EXTENSION)                       \
 112      (DriverObject->DriverExtension))                   \
 113
 114 /*
 115  * VOID
 116  * IopDeviceNodeSetFlag(
 117  *   PDEVICE_NODE DeviceNode,
 118  *   ULONG Flag);
 119  */
 120 #define IopDeviceNodeSetFlag(DeviceNode, Flag)          \
 121     ((DeviceNode)->Flags |= (Flag))
 122
 123 /*
 124  * VOID
 125  * IopDeviceNodeClearFlag(
 126  *   PDEVICE_NODE DeviceNode,
 127  *   ULONG Flag);
 128  */
 129 #define IopDeviceNodeClearFlag(DeviceNode, Flag)        \
 130     ((DeviceNode)->Flags &= ~(Flag))
 131
 132 /*
 133  * BOOLEAN
 134  * IopDeviceNodeHasFlag(
 135  *   PDEVICE_NODE DeviceNode,
 136  *   ULONG Flag);
 137  */
 138 #define IopDeviceNodeHasFlag(DeviceNode, Flag)          \
 139     (((DeviceNode)->Flags & (Flag)) > 0)
 140
 141 /*
 142  * VOID
 143  * IopDeviceNodeSetUserFlag(
 144  *   PDEVICE_NODE DeviceNode,
 145  *   ULONG UserFlag);
 146  */
 147 #define IopDeviceNodeSetUserFlag(DeviceNode, UserFlag)  \
 148     ((DeviceNode)->UserFlags |= (UserFlag))
 149
 150 /*
 151  * VOID
 152  * IopDeviceNodeClearUserFlag(
 153  *   PDEVICE_NODE DeviceNode,
 154  *   ULONG UserFlag);
 155  */
 156 #define IopDeviceNodeClearUserFlag(DeviceNode, UserFlag)\
 157     ((DeviceNode)->UserFlags &= ~(UserFlag))
 158
 159 /*
 160  * BOOLEAN
 161  * IopDeviceNodeHasUserFlag(
 162  *   PDEVICE_NODE DeviceNode,
 163  *   ULONG UserFlag);
 164  */
 165 #define IopDeviceNodeHasUserFlag(DeviceNode, UserFlag)  \
 166     (((DeviceNode)->UserFlags & (UserFlag)) > 0)
 167
 168  /*
 169  * VOID
 170  * IopDeviceNodeSetProblem(
 171  *   PDEVICE_NODE DeviceNode,
 172  *   ULONG Problem);
 173  */
 174 #define IopDeviceNodeSetProblem(DeviceNode, Problem)    \
 175     ((DeviceNode)->Problem |= (Problem))
 176
 177 /*
 178  * VOID
 179  * IopDeviceNodeClearProblem(
 180  *   PDEVICE_NODE DeviceNode,
 181  *   ULONG Problem);
 182  */
 183 #define IopDeviceNodeClearProblem(DeviceNode, Problem)  \
 184     ((DeviceNode)->Problem &= ~(Problem))
 185
 186 /*
 187  * BOOLEAN
 188  * IopDeviceNodeHasProblem(
 189  *   PDEVICE_NODE DeviceNode,
 190  *   ULONG Problem);
 191  */
 192 #define IopDeviceNodeHasProblem(DeviceNode, Problem)    \
 193     (((DeviceNode)->Problem & (Problem)) > 0)
 194
 195 /*
 196  * VOID
 197  * IopInitDeviceTreeTraverseContext(
 198  *   PDEVICETREE_TRAVERSE_CONTEXT DeviceTreeTraverseContext,
 199  *   PDEVICE_NODE DeviceNode,
 200  *   DEVICETREE_TRAVERSE_ROUTINE Action,
 201  *   PVOID Context);
 202  */
 203 #define IopInitDeviceTreeTraverseContext(               \
 204     _DeviceTreeTraverseContext, _DeviceNode, _Action,   \
 205     _Context) {                                         \
 206     (_DeviceTreeTraverseContext)->FirstDeviceNode =     \
 207         (_DeviceNode);                                  \
 208     (_DeviceTreeTraverseContext)->Action = (_Action);   \
 209     (_DeviceTreeTraverseContext)->Context = (_Context); }
 210
 211 /*
 212  * BOOLEAN
 213  * IopIsValidPhysicalDeviceObject(
 214  *   IN PDEVICE_OBJECT PhysicalDeviceObject);
 215  */
 216 #define IopIsValidPhysicalDeviceObject(PhysicalDeviceObject)                                                            \
 217         (((PEXTENDED_DEVOBJ_EXTENSION)PhysicalDeviceObject) &&                                                          \
 218         (((PEXTENDED_DEVOBJ_EXTENSION)PhysicalDeviceObject->DeviceObjectExtension)->DeviceNode) &&                      \
 219         (((PEXTENDED_DEVOBJ_EXTENSION)PhysicalDeviceObject->DeviceObjectExtension)->DeviceNode->Flags & DNF_ENUMERATED))
 220
 221 //
 222 // Device List Operations
 223 //
 224 typedef enum _IOP_DEVICE_LIST_OPERATION
 225 {
 226     IopRemove,
 227     IopAdd
 228 } IOP_DEVICE_LIST_OPERATION, *PIOP_DEVICE_LIST_OPERATION;
 229
 230 //
 231 // Transfer statistics
 232 //
 233 typedef enum _IOP_TRANSFER_TYPE
 234 {
 235     IopReadTransfer,
 236     IopWriteTransfer,
 237     IopOtherTransfer
 238 } IOP_TRANSFER_TYPE, *PIOP_TRANSFER_TYPE;
 239
 240 //
 241 // Packet Types when piggybacking on the IRP Overlay
 242 //
 243 typedef enum _COMPLETION_PACKET_TYPE
 244     {
 245     IopCompletionPacketIrp,
 246     IopCompletionPacketMini,
 247     IopCompletionPacketQuota
 248 } COMPLETION_PACKET_TYPE, *PCOMPLETION_PACKET_TYPE;
 249
 250 //
 251 // Special version of the IRP Overlay used to optimize I/O completion
 252 // by not using up a separate structure.
 253 //
 254 typedef struct _IOP_MINI_COMPLETION_PACKET
 255 {
 256     struct
 257     {
 258         LIST_ENTRY ListEntry;
 259         union
 260         {
 261             struct _IO_STACK_LOCATION *CurrentStackLocation;
 262             ULONG PacketType;
 263         };
 264     };
 265     PVOID KeyContext;
 266     PVOID ApcContext;
 267     NTSTATUS IoStatus;
 268     ULONG_PTR IoStatusInformation;
 269 } IOP_MINI_COMPLETION_PACKET, *PIOP_MINI_COMPLETION_PACKET;
 270
 271 //
 272 // I/O Completion Context for IoSetIoCompletionRoutineEx
 273 //
 274 typedef struct _IO_UNLOAD_SAFE_COMPLETION_CONTEXT
 275 {
 276     PDEVICE_OBJECT DeviceObject;
 277     PVOID Context;
 278     PIO_COMPLETION_ROUTINE CompletionRoutine;
 279 } IO_UNLOAD_SAFE_COMPLETION_CONTEXT, *PIO_UNLOAD_SAFE_COMPLETION_CONTEXT;
 280
 281 //
 282 // I/O Wrapper around the Executive Work Item
 283 //
 284 typedef struct _IO_WORKITEM
 285 {
 286     WORK_QUEUE_ITEM Item;
 287     PDEVICE_OBJECT DeviceObject;
 288     PIO_WORKITEM_ROUTINE WorkerRoutine;
 289     PVOID Context;
 290 } IO_WORKITEM;
 291
 292 //
 293 // I/O Wrapper around the Kernel Interrupt
 294 //
 295 typedef struct _IO_INTERRUPT
 296 {
 297     KINTERRUPT FirstInterrupt;
 298     PKINTERRUPT Interrupt[MAXIMUM_PROCESSORS];
 299     KSPIN_LOCK SpinLock;
 300 } IO_INTERRUPT, *PIO_INTERRUPT;
 301
 302 //
 303 // I/O Error Log Packet Header
 304 //
 305 typedef struct _ERROR_LOG_ENTRY
 306 {
 307     CSHORT Type;
 308     CSHORT Size;
 309     LIST_ENTRY ListEntry;
 310     PDEVICE_OBJECT DeviceObject;
 311     PDRIVER_OBJECT DriverObject;
 312     LARGE_INTEGER TimeStamp;
 313 } ERROR_LOG_ENTRY, *PERROR_LOG_ENTRY;
 314
 315 //
 316 // Event Log LPC Message
 317 //
 318 typedef struct _ELF_API_MSG
 319 {
 320     PORT_MESSAGE h;
 321     ULONG Unknown[2];
 322     IO_ERROR_LOG_MESSAGE IoErrorMessage;
 323 } ELF_API_MSG, *PELF_API_MSG;
 324
 325 //
 326 // To simplify matters, the kernel is made to support both the checked and free
 327 // version of the I/O Remove Lock in the same binary. This structure includes
 328 // both, since the DDK has the structure with a compile-time #ifdef.
 329 //
 330 typedef struct _EXTENDED_IO_REMOVE_LOCK
 331 {
 332     IO_REMOVE_LOCK_COMMON_BLOCK Common;
 333     IO_REMOVE_LOCK_DBG_BLOCK Dbg;
 334 } EXTENDED_IO_REMOVE_LOCK, *PEXTENDED_IO_REMOVE_LOCK;
 335
 336 //
 337 // Dummy File Object used inside the Open Packet so that OB knows how to
 338 // deal with the Object Pointer even though it's not a real file.
 339 //
 340 typedef struct _DUMMY_FILE_OBJECT
 341 {
 342     OBJECT_HEADER ObjectHeader;
 343     CHAR FileObjectBody[sizeof(FILE_OBJECT)];
 344 } DUMMY_FILE_OBJECT, *PDUMMY_FILE_OBJECT;
 345
 346 //
 347 // Open packet used as a context for Device/File parsing so that the parse
 348 // routine can know what operation is being requested.
 349 //
 350 typedef struct _OPEN_PACKET
 351 {
 352     CSHORT Type;
 353     CSHORT Size;
 354     PFILE_OBJECT FileObject;
 355     NTSTATUS FinalStatus;
 356     ULONG_PTR Information;
 357     ULONG ParseCheck;
 358     PFILE_OBJECT RelatedFileObject;
 359     OBJECT_ATTRIBUTES OriginalAttributes;
 360     LARGE_INTEGER AllocationSize;
 361     ULONG CreateOptions;
 362     USHORT FileAttributes;
 363     USHORT ShareAccess;
 364     PVOID EaBuffer;
 365     ULONG EaLength;
 366     ULONG Options;
 367     ULONG Disposition;
 368     PFILE_BASIC_INFORMATION BasicInformation;
 369     PFILE_NETWORK_OPEN_INFORMATION NetworkInformation;
 370     CREATE_FILE_TYPE CreateFileType;
 371     PVOID MailslotOrPipeParameters;
 372     BOOLEAN Override;
 373     BOOLEAN QueryOnly;
 374     BOOLEAN DeleteOnly;
 375     BOOLEAN FullAttributes;
 376     PDUMMY_FILE_OBJECT DummyFileObject;
 377     ULONG InternalFlags;
 378     //PIO_DRIVER_CREATE_CONTEXT DriverCreateContext; Vista only, needs ROS DDK Update
 379 } OPEN_PACKET, *POPEN_PACKET;
 380
 381 //
 382 // Parameters packet for Load/Unload work item's context
 383 //
 384 typedef struct _LOAD_UNLOAD_PARAMS
 385 {
 386     NTSTATUS Status;
 387     PUNICODE_STRING ServiceName;
 388     WORK_QUEUE_ITEM WorkItem;
 389     KEVENT Event;
 390     PDRIVER_OBJECT DriverObject;
 391 } LOAD_UNLOAD_PARAMS, *PLOAD_UNLOAD_PARAMS;
 392
 393 //
 394 // Boot Driver List Entry
 395 //
 396 typedef struct _DRIVER_INFORMATION
 397 {
 398     LIST_ENTRY Link;
 399     PDRIVER_OBJECT DriverObject;
 400     PBOOT_DRIVER_LIST_ENTRY DataTableEntry;
 401     HANDLE ServiceHandle;
 402     USHORT TagPosition;
 403     ULONG Failed;
 404     ULONG Processed;
 405     NTSTATUS Status;
 406 } DRIVER_INFORMATION, *PDRIVER_INFORMATION;
 407
 408 //
 409 // Boot Driver Node
 410 //
 411 typedef struct _BOOT_DRIVER_NODE
 412 {
 413     BOOT_DRIVER_LIST_ENTRY ListEntry;
 414     UNICODE_STRING Group;
 415     UNICODE_STRING Name;
 416     ULONG Tag;
 417     ULONG ErrorControl;
 418 } BOOT_DRIVER_NODE, *PBOOT_DRIVER_NODE;
 419
 420 //
 421 // List of Bus Type GUIDs
 422 //
 423 typedef struct _IO_BUS_TYPE_GUID_LIST
 424 {
 425     ULONG GuidCount;
 426     FAST_MUTEX Lock;
 427     GUID Guids[1];
 428 } IO_BUS_TYPE_GUID_LIST, *PIO_BUS_TYPE_GUID_LIST;
 429 extern PIO_BUS_TYPE_GUID_LIST IopBusTypeGuidList;
 430
 431 //
 432 // Shutdown entry for registed devices
 433 //
 434 typedef struct _SHUTDOWN_ENTRY
 435 {
 436     LIST_ENTRY ShutdownList;
 437     PDEVICE_OBJECT DeviceObject;
 438 } SHUTDOWN_ENTRY, *PSHUTDOWN_ENTRY;
 439
 440 //
 441 // F/S Notification entry for registered File Systems
 442 //
 443 typedef struct _FS_CHANGE_NOTIFY_ENTRY
 444 {
 445     LIST_ENTRY FsChangeNotifyList;
 446     PDRIVER_OBJECT DriverObject;
 447     PDRIVER_FS_NOTIFICATION FSDNotificationProc;
 448 } FS_CHANGE_NOTIFY_ENTRY, *PFS_CHANGE_NOTIFY_ENTRY;
 449
 450 //
 451 // Driver (Boot) Re-Initialization Entry
 452 //
 453 typedef struct _DRIVER_REINIT_ITEM
 454 {
 455     LIST_ENTRY ItemEntry;
 456     PDRIVER_OBJECT DriverObject;
 457     PDRIVER_REINITIALIZE ReinitRoutine;
 458     PVOID Context;
 459 } DRIVER_REINIT_ITEM, *PDRIVER_REINIT_ITEM;
 460
 461 //
 462 // Called on every visit of a node during a preorder-traversal of the device
 463 // node tree.
 464 // If the routine returns STATUS_UNSUCCESSFUL the traversal will stop and
 465 // STATUS_SUCCESS is returned to the caller who initiated the tree traversal.
 466 // Any other returned status code will be returned to the caller. If a status
 467 // code that indicates an error (other than STATUS_UNSUCCESSFUL) is returned,
 468 // the traversal is stopped immediately and the status code is returned to
 469 // the caller.
 470 //
 471 typedef
 472 NTSTATUS
 473 (*DEVICETREE_TRAVERSE_ROUTINE)(
 474     IN PDEVICE_NODE DeviceNode,
 475     IN PVOID Context
 476 );
 477
 478 //
 479 // Context information for traversing the device tree
 480 //
 481 typedef struct _DEVICETREE_TRAVERSE_CONTEXT
 482 {
 483     //
 484     // Current device node during a traversal
 485     //
 486     PDEVICE_NODE DeviceNode;
 487
 488     //
 489     // Initial device node where we start the traversal
 490     //
 491     PDEVICE_NODE FirstDeviceNode;
 492
 493     //
 494     // Action routine to be called for every device node
 495     //
 496     DEVICETREE_TRAVERSE_ROUTINE Action;
 497
 498     //
 499     // Context passed to the action routine
 500     //
 501     PVOID Context;
 502 } DEVICETREE_TRAVERSE_CONTEXT, *PDEVICETREE_TRAVERSE_CONTEXT;
 503
 504 //
 505 // Resource code
 506 //
 507 ULONG
 508 NTAPI
 509 PnpDetermineResourceListSize(IN PCM_RESOURCE_LIST ResourceList);
 510
 511 NTSTATUS
 512 NTAPI
 513 IopAssignDeviceResources(
 514     IN PDEVICE_NODE DeviceNode
 515 );
 516
 517 NTSTATUS
 518 NTAPI
 519 IopCreateResourceListFromRequirements(
 520     IN PIO_RESOURCE_REQUIREMENTS_LIST RequirementsList,
 521     OUT PCM_RESOURCE_LIST *ResourceList
 522 );
 523
 524 NTSTATUS
 525 NTAPI
 526 IopDetectResourceConflict(
 527      IN PCM_RESOURCE_LIST ResourceList,
 528      IN BOOLEAN Silent,
 529      OUT OPTIONAL PCM_PARTIAL_RESOURCE_DESCRIPTOR ConflictingDescriptor
 530 );
 531
 532 //
 533 // PNP Routines
 534 //
 535 NTSTATUS
 536 NTAPI
 537 PipCallDriverAddDevice(
 538     IN PDEVICE_NODE DeviceNode,
 539     IN BOOLEAN LoadDriver,
 540     IN PDRIVER_OBJECT DriverObject
 541 );
 542
 543 NTSTATUS
 544 NTAPI
 545 IopInitializePlugPlayServices(
 546     VOID
 547 );
 548
 549 BOOLEAN
 550 NTAPI
 551 PpInitSystem(
 552     VOID
 553 );
 554
 555 VOID
 556 PnpInit2(
 557     VOID
 558 );
 559
 560 VOID
 561 IopInitDriverImplementation(
 562     VOID
 563 );
 564
 565 VOID
 566 IopInitPnpNotificationImplementation(
 567     VOID
 568 );
 569
 570 VOID
 571 IopNotifyPlugPlayNotification(
 572     IN PDEVICE_OBJECT DeviceObject,
 573     IN IO_NOTIFICATION_EVENT_CATEGORY EventCategory,
 574     IN LPCGUID Event,
 575     IN PVOID EventCategoryData1,
 576     IN PVOID EventCategoryData2
 577 );
 578
 579 NTSTATUS
 580 IopGetSystemPowerDeviceObject(
 581     IN PDEVICE_OBJECT *DeviceObject
 582 );
 583
 584 PDEVICE_NODE
 585 NTAPI
 586 PipAllocateDeviceNode(
 587     IN PDEVICE_OBJECT PhysicalDeviceObject
 588 );
 589
 590 NTSTATUS
 591 IopCreateDeviceNode(
 592     IN PDEVICE_NODE ParentNode,
 593     IN PDEVICE_OBJECT PhysicalDeviceObject,
 594     IN PUNICODE_STRING ServiceName,
 595     OUT PDEVICE_NODE *DeviceNode
 596 );
 597
 598 NTSTATUS
 599 IopFreeDeviceNode(
 600     IN PDEVICE_NODE DeviceNode
 601 );
 602
 603 NTSTATUS
 604 NTAPI
 605 IopSynchronousCall(
 606     IN PDEVICE_OBJECT DeviceObject,
 607     IN PIO_STACK_LOCATION IoStackLocation,
 608     OUT PVOID *Information
 609 );
 610
 611 NTSTATUS
 612 NTAPI
 613 IopInitiatePnpIrp(
 614     IN PDEVICE_OBJECT DeviceObject,
 615     IN PIO_STATUS_BLOCK IoStatusBlock,
 616     IN ULONG MinorFunction,
 617     IN PIO_STACK_LOCATION Stack
 618 );
 619
 620 PDEVICE_NODE
 621 FASTCALL
 622 IopGetDeviceNode(
 623     IN PDEVICE_OBJECT DeviceObject
 624 );
 625
 626 NTSTATUS
 627 IopActionConfigureChildServices(
 628     IN PDEVICE_NODE DeviceNode,
 629     IN PVOID Context
 630 );
 631
 632 NTSTATUS
 633 IopActionInitChildServices(
 634     IN PDEVICE_NODE DeviceNode,
 635     IN PVOID Context
 636 );
 637
 638 NTSTATUS
 639 IopEnumerateDevice(
 640     IN PDEVICE_OBJECT DeviceObject
 641 );
 642
 643 NTSTATUS
 644 IoCreateDriverList(
 645     VOID
 646 );
 647
 648 NTSTATUS
 649 IoDestroyDriverList(
 650     VOID
 651 );
 652
 653 NTSTATUS
 654 INIT_FUNCTION
 655 IopInitPlugPlayEvents(VOID);
 656
 657 NTSTATUS
 658 IopQueueTargetDeviceEvent(
 659     const GUID *Guid,
 660     PUNICODE_STRING DeviceIds
 661 );
 662
 663 NTSTATUS
 664 IopInitializePnpServices(
 665     IN PDEVICE_NODE DeviceNode);
 666
 667 NTSTATUS
 668 NTAPI
 669 IopOpenRegistryKeyEx(
 670     PHANDLE KeyHandle,
 671     HANDLE ParentKey,
 672     PUNICODE_STRING Name,
 673     ACCESS_MASK DesiredAccess);
 674
 675 NTSTATUS
 676 NTAPI
 677 IopGetRegistryValue(
 678     IN HANDLE Handle,
 679     IN PWSTR ValueName,
 680     OUT PKEY_VALUE_FULL_INFORMATION *Information
 681 );
 682
 683 NTSTATUS
 684 NTAPI
 685 IopCreateRegistryKeyEx(
 686     OUT PHANDLE Handle,
 687     IN HANDLE BaseHandle OPTIONAL,
 688     IN PUNICODE_STRING KeyName,
 689     IN ACCESS_MASK DesiredAccess,
 690     IN ULONG CreateOptions,
 691     OUT PULONG Disposition OPTIONAL
 692 );
 693
 694 //
 695 // PnP Routines
 696 //
 697 NTSTATUS
 698 NTAPI
 699 IopUpdateRootKey(
 700     VOID
 701 );
 702
 703 NTSTATUS
 704 NTAPI
 705 PiInitCacheGroupInformation(
 706     VOID
 707 );
 708
 709 USHORT
 710 NTAPI
 711 PpInitGetGroupOrderIndex(
 712     IN HANDLE ServiceHandle
 713 );
 714
 715 USHORT
 716 NTAPI
 717 PipGetDriverTagPriority(
 718     IN HANDLE ServiceHandle
 719 );
 720
 721 NTSTATUS
 722 NTAPI
 723 PnpRegMultiSzToUnicodeStrings(
 724     IN PKEY_VALUE_FULL_INFORMATION KeyValueInformation,
 725     OUT PUNICODE_STRING *UnicodeStringList,
 726     OUT PULONG UnicodeStringCount
 727 );
 728
 729 BOOLEAN
 730 NTAPI
 731 PnpRegSzToString(
 732     IN PWCHAR RegSzData,
 733     IN ULONG RegSzLength,
 734     OUT PUSHORT StringLength OPTIONAL
 735 );
 736
 737 //
 738 // Initialization Routines
 739 //
 740 NTSTATUS
 741 NTAPI
 742 IopCreateArcNames(
 743     IN PLOADER_PARAMETER_BLOCK LoaderBlock
 744 );
 745
 746 NTSTATUS
 747 NTAPI
 748 IopReassignSystemRoot(
 749     IN PLOADER_PARAMETER_BLOCK LoaderBlock,
 750     OUT PANSI_STRING NtBootPath
 751 );
 752
 753 BOOLEAN
 754 NTAPI
 755 IoInitSystem(
 756     IN PLOADER_PARAMETER_BLOCK LoaderBlock
 757 );
 758
 759 BOOLEAN
 760 NTAPI
 761 IopVerifyDiskSignature(
 762     IN PDRIVE_LAYOUT_INFORMATION_EX DriveLayout,
 763     IN PARC_DISK_SIGNATURE ArcDiskSignature,
 764     OUT PULONG Signature
 765 );
 766
 767 //
 768 // Device/Volume Routines
 769 //
 770 VOID
 771 NTAPI
 772 IopReadyDeviceObjects(
 773     IN PDRIVER_OBJECT Driver
 774 );
 775
 776 NTSTATUS
 777 FASTCALL
 778 IopInitializeDevice(
 779     IN PDEVICE_NODE DeviceNode,
 780     IN PDRIVER_OBJECT DriverObject
 781 );
 782
 783 NTSTATUS
 784 IopStartDevice(
 785     IN PDEVICE_NODE DeviceNode
 786 );
 787
 788 PVPB
 789 NTAPI
 790 IopCheckVpbMounted(
 791     IN POPEN_PACKET OpenPacket,
 792     IN PDEVICE_OBJECT DeviceObject,
 793     IN PUNICODE_STRING RemainingName,
 794     OUT PNTSTATUS Status
 795 );
 796
 797 NTSTATUS
 798 NTAPI
 799 IopMountVolume(
 800     IN PDEVICE_OBJECT DeviceObject,
 801     IN BOOLEAN AllowRawMount,
 802     IN BOOLEAN DeviceIsLocked,
 803     IN BOOLEAN Alertable,
 804     OUT PVPB *Vpb
 805 );
 806
 807 PVOID
 808 IoOpenSymlink(
 809     IN PVOID SymbolicLink
 810 );
 811
 812 PVOID
 813 IoOpenFileOnDevice(
 814     IN PVOID SymbolicLink,
 815     IN PWCHAR Name
 816 );
 817
 818 NTSTATUS
 819 NTAPI
 820 IopCreateVpb(
 821     IN PDEVICE_OBJECT DeviceObject
 822 );
 823
 824 VOID
 825 NTAPI
 826 IopDereferenceVpb(
 827     IN PVPB Vpb
 828 );
 829
 830 VOID
 831 NTAPI
 832 IoInitFileSystemImplementation(
 833     VOID
 834 );
 835
 836 VOID
 837 NTAPI
 838 IoInitVpbImplementation(
 839     VOID
 840 );
 841
 842 NTSTATUS
 843 NTAPI
 844 IopReferenceDeviceObject(
 845     IN PDEVICE_OBJECT DeviceObject
 846 );
 847
 848 VOID
 849 NTAPI
 850 IopDereferenceDeviceObject(
 851     IN PDEVICE_OBJECT DeviceObject,
 852     IN BOOLEAN ForceUnload
 853 );
 854
 855 NTSTATUS
 856 NTAPI
 857 IoGetRelatedTargetDevice(IN PFILE_OBJECT FileObject,
 858                          OUT PDEVICE_OBJECT *DeviceObject
 859 );
 860
 861 //
 862 // IRP Routines
 863 //
 864 NTSTATUS
 865 NTAPI
 866 IopCleanupFailedIrp(
 867     IN PFILE_OBJECT FileObject,
 868     IN PKEVENT EventObject,
 869     IN PVOID Buffer OPTIONAL
 870 );
 871
 872 VOID
 873 NTAPI
 874 IopAbortInterruptedIrp(
 875     IN PKEVENT EventObject,
 876     IN PIRP Irp
 877 );
 878
 879 //
 880 // Shutdown routines
 881 //
 882 VOID
 883 IoInitShutdownNotification(
 884     VOID
 885 );
 886
 887 VOID
 888 NTAPI
 889 IoShutdownSystem(
 890     IN ULONG Phase
 891 );
 892
 893 VOID
 894 NTAPI
 895 IopShutdownBaseFileSystems(
 896     IN PLIST_ENTRY ListHead
 897 );
 898
 899 //
 900 // Boot logging support
 901 //
 902 VOID
 903 IopInitBootLog(
 904     IN BOOLEAN StartBootLog
 905 );
 906
 907 VOID
 908 IopStartBootLog(
 909     VOID
 910 );
 911
 912 VOID
 913 IopStopBootLog(
 914     VOID
 915 );
 916
 917 VOID
 918 IopBootLog(
 919     IN PUNICODE_STRING DriverName,
 920     IN BOOLEAN Success
 921 );
 922
 923 VOID
 924 IopSaveBootLogToFile(
 925     VOID
 926 );
 927
 928 //
 929 // I/O Cancellation Routines
 930 //
 931 VOID
 932 NTAPI
 933 IoCancelThreadIo(
 934     IN PETHREAD Thread
 935 );
 936
 937 VOID
 938 IoInitCancelHandling(
 939     VOID
 940 );
 941
 942 //
 943 // I/O Completion
 944 //
 945 VOID
 946 NTAPI
 947 IopCompleteRequest(
 948     IN PKAPC Apc,
 949     IN PKNORMAL_ROUTINE* NormalRoutine,
 950     IN PVOID* NormalContext,
 951     IN PVOID* SystemArgument1,
 952     IN PVOID* SystemArgument2
 953 );
 954
 955 //
 956 // Error Logging Routines
 957 //
 958 VOID
 959 NTAPI
 960 IopInitErrorLog(
 961     VOID
 962 );
 963
 964 VOID
 965 NTAPI
 966 IopLogWorker(
 967     IN PVOID Parameter
 968 );
 969
 970 //
 971 // Raw File System MiniDriver
 972 //
 973 BOOLEAN
 974 RawFsIsRawFileSystemDeviceObject(
 975     IN PDEVICE_OBJECT DeviceObject
 976 );
 977
 978 NTSTATUS
 979 NTAPI
 980 RawFsDriverEntry(
 981     IN PDRIVER_OBJECT DriverObject,
 982     IN PUNICODE_STRING RegistryPath
 983 );
 984
 985 //
 986 // PnP Root MiniDriver
 987 //
 988 NTSTATUS
 989 NTAPI
 990 PnpRootDriverEntry(
 991    IN PDRIVER_OBJECT DriverObject,
 992    IN PUNICODE_STRING RegistryPath
 993 );
 994
 995 NTSTATUS
 996 PnpRootCreateDevice(
 997     IN PUNICODE_STRING ServiceName,
 998     OUT PDEVICE_OBJECT *PhysicalDeviceObject,
 999     OUT OPTIONAL PUNICODE_STRING FullInstancePath
1000 );
1001
1002 //
1003 // Driver Routines
1004 //
1005 VOID
1006 FASTCALL
1007 IopInitializeBootDrivers(
1008     VOID
1009 );
1010
1011 VOID
1012 FASTCALL
1013 IopInitializeSystemDrivers(
1014     VOID
1015 );
1016
1017 NTSTATUS
1018 NTAPI
1019 IopCreateDriver(IN PUNICODE_STRING DriverName OPTIONAL,
1020                 IN PDRIVER_INITIALIZE InitializationFunction,
1021                 IN PUNICODE_STRING RegistryPath,
1022                 PLDR_DATA_TABLE_ENTRY ModuleObject,
1023                 OUT PDRIVER_OBJECT *pDriverObject);
1024
1025 VOID
1026 NTAPI
1027 IopDeleteDriver(
1028     IN PVOID ObjectBody
1029 );
1030
1031 NTSTATUS
1032 FASTCALL
1033 IopGetDriverObject(
1034     OUT PDRIVER_OBJECT *DriverObject,
1035     IN PUNICODE_STRING ServiceName,
1036     IN BOOLEAN FileSystem
1037 );
1038
1039 NTSTATUS
1040 FASTCALL
1041 IopLoadServiceModule(
1042     IN PUNICODE_STRING ServiceName,
1043     OUT PLDR_DATA_TABLE_ENTRY *ModuleObject
1044 );
1045
1046 VOID
1047 NTAPI
1048 IopLoadUnloadDriver(
1049     IN OUT PLOAD_UNLOAD_PARAMS LoadParams
1050 );
1051
1052 NTSTATUS
1053 FASTCALL
1054 IopInitializeDriverModule(
1055     IN PDEVICE_NODE DeviceNode,
1056     IN PLDR_DATA_TABLE_ENTRY ModuleObject,
1057     IN PUNICODE_STRING ServiceName,
1058     IN BOOLEAN FileSystemDriver,
1059     OUT PDRIVER_OBJECT *DriverObject
1060 );
1061
1062 NTSTATUS
1063 FASTCALL
1064 IopAttachFilterDrivers(
1065     IN PDEVICE_NODE DeviceNode,
1066     IN BOOLEAN Lower
1067 );
1068
1069 VOID
1070 NTAPI
1071 IopReinitializeDrivers(
1072     VOID
1073 );
1074
1075 VOID
1076 NTAPI
1077 IopReinitializeBootDrivers(
1078     VOID
1079 );
1080
1081 //
1082 // File Routines
1083 //
1084 VOID
1085 NTAPI
1086 IopDeleteDevice(IN PVOID ObjectBody);
1087
1088 NTSTATUS
1089 NTAPI
1090 IopParseDevice(
1091     IN PVOID ParseObject,
1092     IN PVOID ObjectType,
1093     IN OUT PACCESS_STATE AccessState,
1094     IN KPROCESSOR_MODE AccessMode,
1095     IN ULONG Attributes,
1096     IN OUT PUNICODE_STRING CompleteName,
1097     IN OUT PUNICODE_STRING RemainingName,
1098     IN OUT PVOID Context,
1099     IN PSECURITY_QUALITY_OF_SERVICE SecurityQos OPTIONAL,
1100     OUT PVOID *Object
1101 );
1102
1103 NTSTATUS
1104 NTAPI
1105 IopParseFile(
1106     IN PVOID ParseObject,
1107     IN PVOID ObjectType,
1108     IN OUT PACCESS_STATE AccessState,
1109     IN KPROCESSOR_MODE AccessMode,
1110     IN ULONG Attributes,
1111     IN OUT PUNICODE_STRING CompleteName,
1112     IN OUT PUNICODE_STRING RemainingName,
1113     IN OUT PVOID Context OPTIONAL,
1114     IN PSECURITY_QUALITY_OF_SERVICE SecurityQos OPTIONAL,
1115     OUT PVOID *Object
1116 );
1117
1118 VOID
1119 NTAPI
1120 IopDeleteFile(
1121     IN PVOID ObjectBody
1122 );
1123
1124 NTSTATUS
1125 NTAPI
1126 IopSecurityFile(
1127     IN PVOID ObjectBody,
1128     IN SECURITY_OPERATION_CODE OperationCode,
1129     IN PSECURITY_INFORMATION SecurityInformation,
1130     IN OUT PSECURITY_DESCRIPTOR SecurityDescriptor,
1131     IN OUT PULONG BufferLength,
1132     OUT PSECURITY_DESCRIPTOR *OldSecurityDescriptor,
1133     IN POOL_TYPE PoolType,
1134     IN OUT PGENERIC_MAPPING GenericMapping
1135 );
1136
1137 NTSTATUS
1138 NTAPI
1139 IopQueryNameFile(
1140     IN PVOID ObjectBody,
1141     IN BOOLEAN HasName,
1142     OUT POBJECT_NAME_INFORMATION ObjectNameInfo,
1143     IN ULONG Length,
1144     OUT PULONG ReturnLength,
1145     IN KPROCESSOR_MODE PreviousMode
1146 );
1147
1148 VOID
1149 NTAPI
1150 IopCloseFile(
1151     IN PEPROCESS Process OPTIONAL,
1152     IN PVOID Object,
1153     IN ACCESS_MASK GrantedAccess,
1154     IN ULONG ProcessHandleCount,
1155     IN ULONG SystemHandleCount
1156 );
1157
1158 PVOID
1159 NTAPI
1160 IoGetFileObjectFilterContext(
1161     IN PFILE_OBJECT FileObject
1162 );
1163
1164 NTSTATUS
1165 NTAPI
1166 IoChangeFileObjectFilterContext(
1167     IN PFILE_OBJECT FileObject,
1168     IN PVOID FilterContext,
1169     IN BOOLEAN Define
1170 );
1171
1172 //
1173 // I/O Timer Routines
1174 //
1175 VOID
1176 FASTCALL
1177 IopInitTimerImplementation(
1178     VOID
1179 );
1180
1181 VOID
1182 NTAPI
1183 IopRemoveTimerFromTimerList(
1184     IN PIO_TIMER Timer
1185 );
1186
1187 //
1188 // I/O Completion Routines
1189 //
1190 VOID
1191 NTAPI
1192 IopDeleteIoCompletion(
1193     PVOID ObjectBody
1194 );
1195
1196 //
1197 // Ramdisk Routines
1198 //
1199 NTSTATUS
1200 NTAPI
1201 IopStartRamdisk(
1202     IN PLOADER_PARAMETER_BLOCK LoaderBlock
1203 );
1204
1205 //
1206 // Configuration Routines
1207 //
1208 NTSTATUS
1209 NTAPI
1210 IopFetchConfigurationInformation(OUT PWSTR * SymbolicLinkList,
1211                                  IN GUID Guid,
1212                                  IN ULONG ExpectedInterfaces,
1213                                  IN PULONG Interfaces
1214 );
1215
1216 VOID
1217 NTAPI
1218 IopStoreSystemPartitionInformation(IN PUNICODE_STRING NtSystemPartitionDeviceName,
1219                                    IN PUNICODE_STRING OsLoaderPathName
1220 );
1221
1222 //
1223 // Global I/O Data
1224 //
1225 extern POBJECT_TYPE IoCompletionType;
1226 extern PDEVICE_NODE IopRootDeviceNode;
1227 extern KSPIN_LOCK IopDeviceTreeLock;
1228 extern ULONG IopTraceLevel;
1229 extern GENERAL_LOOKASIDE IopMdlLookasideList;
1230 extern GENERIC_MAPPING IopCompletionMapping;
1231 extern GENERIC_MAPPING IopFileMapping;
1232 extern POBJECT_TYPE _IoFileObjectType;
1233 extern HAL_DISPATCH _HalDispatchTable;
1234 extern LIST_ENTRY IopErrorLogListHead;
1235 extern ULONG IopNumTriageDumpDataBlocks;
1236 extern PVOID IopTriageDumpDataBlocks[64];
1237 extern PIO_BUS_TYPE_GUID_LIST PnpBusTypeGuidList;
1238 extern PDRIVER_OBJECT IopRootDriverObject;
1239
1240 //
1241 // Inlined Functions
1242 //
1243 #include "io_x.h"