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 //
 518 // PNP Routines
 519 //
 520 NTSTATUS
 521 NTAPI
 522 PipCallDriverAddDevice(
 523     IN PDEVICE_NODE DeviceNode,
 524     IN BOOLEAN LoadDriver,
 525     IN PDRIVER_OBJECT DriverObject
 526 );
 527
 528 NTSTATUS
 529 NTAPI
 530 IopInitializePlugPlayServices(
 531     VOID
 532 );
 533
 534 BOOLEAN
 535 NTAPI
 536 PpInitSystem(
 537     VOID
 538 );
 539
 540 VOID
 541 PnpInit2(
 542     VOID
 543 );
 544
 545 VOID
 546 IopInitDriverImplementation(
 547     VOID
 548 );
 549
 550 VOID
 551 IopInitPnpNotificationImplementation(
 552     VOID
 553 );
 554
 555 VOID
 556 IopNotifyPlugPlayNotification(
 557     IN PDEVICE_OBJECT DeviceObject,
 558     IN IO_NOTIFICATION_EVENT_CATEGORY EventCategory,
 559     IN LPCGUID Event,
 560     IN PVOID EventCategoryData1,
 561     IN PVOID EventCategoryData2
 562 );
 563
 564 NTSTATUS
 565 IopGetSystemPowerDeviceObject(
 566     IN PDEVICE_OBJECT *DeviceObject
 567 );
 568
 569 PDEVICE_NODE
 570 NTAPI
 571 PipAllocateDeviceNode(
 572     IN PDEVICE_OBJECT PhysicalDeviceObject
 573 );
 574
 575 NTSTATUS
 576 IopCreateDeviceNode(
 577     IN PDEVICE_NODE ParentNode,
 578     IN PDEVICE_OBJECT PhysicalDeviceObject,
 579     IN PUNICODE_STRING ServiceName,
 580     OUT PDEVICE_NODE *DeviceNode
 581 );
 582
 583 NTSTATUS
 584 IopFreeDeviceNode(
 585     IN PDEVICE_NODE DeviceNode
 586 );
 587
 588 NTSTATUS
 589 NTAPI
 590 IopSynchronousCall(
 591     IN PDEVICE_OBJECT DeviceObject,
 592     IN PIO_STACK_LOCATION IoStackLocation,
 593     OUT PVOID *Information
 594 );
 595
 596 NTSTATUS
 597 NTAPI
 598 IopInitiatePnpIrp(
 599     IN PDEVICE_OBJECT DeviceObject,
 600     IN PIO_STATUS_BLOCK IoStatusBlock,
 601     IN ULONG MinorFunction,
 602     IN PIO_STACK_LOCATION Stack
 603 );
 604
 605 PDEVICE_NODE
 606 FASTCALL
 607 IopGetDeviceNode(
 608     IN PDEVICE_OBJECT DeviceObject
 609 );
 610
 611 NTSTATUS
 612 IopActionConfigureChildServices(
 613     IN PDEVICE_NODE DeviceNode,
 614     IN PVOID Context
 615 );
 616
 617 NTSTATUS
 618 IopActionInitChildServices(
 619     IN PDEVICE_NODE DeviceNode,
 620     IN PVOID Context
 621 );
 622
 623 NTSTATUS
 624 IopEnumerateDevice(
 625     IN PDEVICE_OBJECT DeviceObject
 626 );
 627
 628 NTSTATUS
 629 IoCreateDriverList(
 630     VOID
 631 );
 632
 633 NTSTATUS
 634 IoDestroyDriverList(
 635     VOID
 636 );
 637
 638 NTSTATUS
 639 INIT_FUNCTION
 640 IopInitPlugPlayEvents(VOID);
 641
 642 NTSTATUS
 643 IopQueueTargetDeviceEvent(
 644     const GUID *Guid,
 645     PUNICODE_STRING DeviceIds
 646 );
 647
 648 NTSTATUS
 649 IopInitializePnpServices(
 650     IN PDEVICE_NODE DeviceNode);
 651
 652 NTSTATUS
 653 NTAPI
 654 IopOpenRegistryKeyEx(
 655     PHANDLE KeyHandle,
 656     HANDLE ParentKey,
 657     PUNICODE_STRING Name,
 658     ACCESS_MASK DesiredAccess);
 659
 660 NTSTATUS
 661 NTAPI
 662 IopGetRegistryValue(
 663     IN HANDLE Handle,
 664     IN PWSTR ValueName,
 665     OUT PKEY_VALUE_FULL_INFORMATION *Information
 666 );
 667
 668 NTSTATUS
 669 NTAPI
 670 IopCreateRegistryKeyEx(
 671     OUT PHANDLE Handle,
 672     IN HANDLE BaseHandle OPTIONAL,
 673     IN PUNICODE_STRING KeyName,
 674     IN ACCESS_MASK DesiredAccess,
 675     IN ULONG CreateOptions,
 676     OUT PULONG Disposition OPTIONAL
 677 );
 678
 679 //
 680 // PnP Routines
 681 //
 682 NTSTATUS
 683 NTAPI
 684 IopUpdateRootKey(
 685     VOID
 686 );
 687
 688 NTSTATUS
 689 NTAPI
 690 PiInitCacheGroupInformation(
 691     VOID
 692 );
 693
 694 USHORT
 695 NTAPI
 696 PpInitGetGroupOrderIndex(
 697     IN HANDLE ServiceHandle
 698 );
 699
 700 USHORT
 701 NTAPI
 702 PipGetDriverTagPriority(
 703     IN HANDLE ServiceHandle
 704 );
 705
 706 NTSTATUS
 707 NTAPI
 708 PnpRegMultiSzToUnicodeStrings(
 709     IN PKEY_VALUE_FULL_INFORMATION KeyValueInformation,
 710     OUT PUNICODE_STRING *UnicodeStringList,
 711     OUT PULONG UnicodeStringCount
 712 );
 713
 714 BOOLEAN
 715 NTAPI
 716 PnpRegSzToString(
 717     IN PWCHAR RegSzData,
 718     IN ULONG RegSzLength,
 719     OUT PUSHORT StringLength OPTIONAL
 720 );
 721
 722 //
 723 // Initialization Routines
 724 //
 725 NTSTATUS
 726 NTAPI
 727 IopCreateArcNames(
 728     IN PLOADER_PARAMETER_BLOCK LoaderBlock
 729 );
 730
 731 NTSTATUS
 732 NTAPI
 733 IopReassignSystemRoot(
 734     IN PLOADER_PARAMETER_BLOCK LoaderBlock,
 735     OUT PANSI_STRING NtBootPath
 736 );
 737
 738 BOOLEAN
 739 NTAPI
 740 IoInitSystem(
 741     IN PLOADER_PARAMETER_BLOCK LoaderBlock
 742 );
 743
 744 //
 745 // Device/Volume Routines
 746 //
 747 VOID
 748 NTAPI
 749 IopReadyDeviceObjects(
 750     IN PDRIVER_OBJECT Driver
 751 );
 752
 753 NTSTATUS
 754 FASTCALL
 755 IopInitializeDevice(
 756     IN PDEVICE_NODE DeviceNode,
 757     IN PDRIVER_OBJECT DriverObject
 758 );
 759
 760 NTSTATUS
 761 IopStartDevice(
 762     IN PDEVICE_NODE DeviceNode
 763 );
 764
 765 PVPB
 766 NTAPI
 767 IopCheckVpbMounted(
 768     IN POPEN_PACKET OpenPacket,
 769     IN PDEVICE_OBJECT DeviceObject,
 770     IN PUNICODE_STRING RemainingName,
 771     OUT PNTSTATUS Status
 772 );
 773
 774 NTSTATUS
 775 NTAPI
 776 IopMountVolume(
 777     IN PDEVICE_OBJECT DeviceObject,
 778     IN BOOLEAN AllowRawMount,
 779     IN BOOLEAN DeviceIsLocked,
 780     IN BOOLEAN Alertable,
 781     OUT PVPB *Vpb
 782 );
 783
 784 PVOID
 785 IoOpenSymlink(
 786     IN PVOID SymbolicLink
 787 );
 788
 789 PVOID
 790 IoOpenFileOnDevice(
 791     IN PVOID SymbolicLink,
 792     IN PWCHAR Name
 793 );
 794
 795 NTSTATUS
 796 NTAPI
 797 IopCreateVpb(
 798     IN PDEVICE_OBJECT DeviceObject
 799 );
 800
 801 VOID
 802 NTAPI
 803 IopDereferenceVpb(
 804     IN PVPB Vpb
 805 );
 806
 807 VOID
 808 NTAPI
 809 IoInitFileSystemImplementation(
 810     VOID
 811 );
 812
 813 VOID
 814 NTAPI
 815 IoInitVpbImplementation(
 816     VOID
 817 );
 818
 819 NTSTATUS
 820 NTAPI
 821 IopReferenceDeviceObject(
 822     IN PDEVICE_OBJECT DeviceObject
 823 );
 824
 825 VOID
 826 NTAPI
 827 IopDereferenceDeviceObject(
 828     IN PDEVICE_OBJECT DeviceObject,
 829     IN BOOLEAN ForceUnload
 830 );
 831
 832 NTSTATUS
 833 NTAPI
 834 IoGetRelatedTargetDevice(IN PFILE_OBJECT FileObject,
 835                          OUT PDEVICE_OBJECT *DeviceObject
 836 );
 837
 838 //
 839 // IRP Routines
 840 //
 841 NTSTATUS
 842 NTAPI
 843 IopCleanupFailedIrp(
 844     IN PFILE_OBJECT FileObject,
 845     IN PKEVENT EventObject,
 846     IN PVOID Buffer OPTIONAL
 847 );
 848
 849 VOID
 850 NTAPI
 851 IopAbortInterruptedIrp(
 852     IN PKEVENT EventObject,
 853     IN PIRP Irp
 854 );
 855
 856 //
 857 // Shutdown routines
 858 //
 859 VOID
 860 IoInitShutdownNotification(
 861     VOID
 862 );
 863
 864 VOID
 865 NTAPI
 866 IoShutdownSystem(
 867     IN ULONG Phase
 868 );
 869
 870 VOID
 871 NTAPI
 872 IopShutdownBaseFileSystems(
 873     IN PLIST_ENTRY ListHead
 874 );
 875
 876 //
 877 // Boot logging support
 878 //
 879 VOID
 880 IopInitBootLog(
 881     IN BOOLEAN StartBootLog
 882 );
 883
 884 VOID
 885 IopStartBootLog(
 886     VOID
 887 );
 888
 889 VOID
 890 IopStopBootLog(
 891     VOID
 892 );
 893
 894 VOID
 895 IopBootLog(
 896     IN PUNICODE_STRING DriverName,
 897     IN BOOLEAN Success
 898 );
 899
 900 VOID
 901 IopSaveBootLogToFile(
 902     VOID
 903 );
 904
 905 //
 906 // I/O Cancellation Routines
 907 //
 908 VOID
 909 NTAPI
 910 IoCancelThreadIo(
 911     IN PETHREAD Thread
 912 );
 913
 914 VOID
 915 IoInitCancelHandling(
 916     VOID
 917 );
 918
 919 //
 920 // I/O Completion
 921 //
 922 VOID
 923 NTAPI
 924 IopCompleteRequest(
 925     IN PKAPC Apc,
 926     IN PKNORMAL_ROUTINE* NormalRoutine,
 927     IN PVOID* NormalContext,
 928     IN PVOID* SystemArgument1,
 929     IN PVOID* SystemArgument2
 930 );
 931
 932 //
 933 // Error Logging Routines
 934 //
 935 VOID
 936 NTAPI
 937 IopInitErrorLog(
 938     VOID
 939 );
 940
 941 VOID
 942 NTAPI
 943 IopLogWorker(
 944     IN PVOID Parameter
 945 );
 946
 947 //
 948 // Raw File System MiniDriver
 949 //
 950 BOOLEAN
 951 RawFsIsRawFileSystemDeviceObject(
 952     IN PDEVICE_OBJECT DeviceObject
 953 );
 954
 955 NTSTATUS
 956 NTAPI
 957 RawFsDriverEntry(
 958     IN PDRIVER_OBJECT DriverObject,
 959     IN PUNICODE_STRING RegistryPath
 960 );
 961
 962 //
 963 // PnP Root MiniDriver
 964 //
 965 NTSTATUS
 966 NTAPI
 967 PnpRootDriverEntry(
 968    IN PDRIVER_OBJECT DriverObject,
 969    IN PUNICODE_STRING RegistryPath
 970 );
 971
 972 NTSTATUS
 973 PnpRootCreateDevice(
 974     IN PUNICODE_STRING ServiceName,
 975     OUT PDEVICE_OBJECT *PhysicalDeviceObject,
 976     OUT OPTIONAL PUNICODE_STRING FullInstancePath
 977 );
 978
 979 //
 980 // Driver Routines
 981 //
 982 VOID
 983 FASTCALL
 984 IopInitializeBootDrivers(
 985     VOID
 986 );
 987
 988 VOID
 989 FASTCALL
 990 IopInitializeSystemDrivers(
 991     VOID
 992 );
 993
 994 NTSTATUS
 995 NTAPI
 996 IopCreateDriver(IN PUNICODE_STRING DriverName OPTIONAL,
 997                 IN PDRIVER_INITIALIZE InitializationFunction,
 998                 IN PUNICODE_STRING RegistryPath,
 999                 IN PVOID DllBase,
1000                 IN ULONG SizeOfImage,
1001                 OUT PDRIVER_OBJECT *pDriverObject);
1002
1003 VOID
1004 NTAPI
1005 IopDeleteDriver(
1006     IN PVOID ObjectBody
1007 );
1008
1009 NTSTATUS
1010 FASTCALL
1011 IopGetDriverObject(
1012     OUT PDRIVER_OBJECT *DriverObject,
1013     IN PUNICODE_STRING ServiceName,
1014     IN BOOLEAN FileSystem
1015 );
1016
1017 NTSTATUS
1018 FASTCALL
1019 IopLoadServiceModule(
1020     IN PUNICODE_STRING ServiceName,
1021     OUT PLDR_DATA_TABLE_ENTRY *ModuleObject
1022 );
1023
1024 VOID
1025 NTAPI
1026 IopLoadUnloadDriver(
1027     IN OUT PLOAD_UNLOAD_PARAMS LoadParams
1028 );
1029
1030 NTSTATUS
1031 FASTCALL
1032 IopInitializeDriverModule(
1033     IN PDEVICE_NODE DeviceNode,
1034     IN PLDR_DATA_TABLE_ENTRY ModuleObject,
1035     IN PUNICODE_STRING ServiceName,
1036     IN BOOLEAN FileSystemDriver,
1037     OUT PDRIVER_OBJECT *DriverObject
1038 );
1039
1040 NTSTATUS
1041 FASTCALL
1042 IopAttachFilterDrivers(
1043     IN PDEVICE_NODE DeviceNode,
1044     IN BOOLEAN Lower
1045 );
1046
1047 VOID
1048 NTAPI
1049 IopReinitializeDrivers(
1050     VOID
1051 );
1052
1053 VOID
1054 NTAPI
1055 IopReinitializeBootDrivers(
1056     VOID
1057 );
1058
1059 //
1060 // File Routines
1061 //
1062 VOID
1063 NTAPI
1064 IopDeleteDevice(IN PVOID ObjectBody);
1065
1066 NTSTATUS
1067 NTAPI
1068 IopParseDevice(
1069     IN PVOID ParseObject,
1070     IN PVOID ObjectType,
1071     IN OUT PACCESS_STATE AccessState,
1072     IN KPROCESSOR_MODE AccessMode,
1073     IN ULONG Attributes,
1074     IN OUT PUNICODE_STRING CompleteName,
1075     IN OUT PUNICODE_STRING RemainingName,
1076     IN OUT PVOID Context OPTIONAL,
1077     IN PSECURITY_QUALITY_OF_SERVICE SecurityQos OPTIONAL,
1078     OUT PVOID *Object
1079 );
1080
1081 NTSTATUS
1082 NTAPI
1083 IopParseFile(
1084     IN PVOID ParseObject,
1085     IN PVOID ObjectType,
1086     IN OUT PACCESS_STATE AccessState,
1087     IN KPROCESSOR_MODE AccessMode,
1088     IN ULONG Attributes,
1089     IN OUT PUNICODE_STRING CompleteName,
1090     IN OUT PUNICODE_STRING RemainingName,
1091     IN OUT PVOID Context OPTIONAL,
1092     IN PSECURITY_QUALITY_OF_SERVICE SecurityQos OPTIONAL,
1093     OUT PVOID *Object
1094 );
1095
1096 VOID
1097 NTAPI
1098 IopDeleteFile(
1099     IN PVOID ObjectBody
1100 );
1101
1102 NTSTATUS
1103 NTAPI
1104 IopSecurityFile(
1105     IN PVOID ObjectBody,
1106     IN SECURITY_OPERATION_CODE OperationCode,
1107     IN PSECURITY_INFORMATION SecurityInformation,
1108     IN OUT PSECURITY_DESCRIPTOR SecurityDescriptor,
1109     IN OUT PULONG BufferLength,
1110     OUT PSECURITY_DESCRIPTOR *OldSecurityDescriptor,
1111     IN POOL_TYPE PoolType,
1112     IN OUT PGENERIC_MAPPING GenericMapping
1113 );
1114
1115 NTSTATUS
1116 NTAPI
1117 IopQueryNameFile(
1118     IN PVOID ObjectBody,
1119     IN BOOLEAN HasName,
1120     OUT POBJECT_NAME_INFORMATION ObjectNameInfo,
1121     IN ULONG Length,
1122     OUT PULONG ReturnLength,
1123     IN KPROCESSOR_MODE PreviousMode
1124 );
1125
1126 VOID
1127 NTAPI
1128 IopCloseFile(
1129     IN PEPROCESS Process OPTIONAL,
1130     IN PVOID Object,
1131     IN ACCESS_MASK GrantedAccess,
1132     IN ULONG ProcessHandleCount,
1133     IN ULONG SystemHandleCount
1134 );
1135
1136 //
1137 // I/O Timer Routines
1138 //
1139 VOID
1140 FASTCALL
1141 IopInitTimerImplementation(
1142     VOID
1143 );
1144
1145 VOID
1146 NTAPI
1147 IopRemoveTimerFromTimerList(
1148     IN PIO_TIMER Timer
1149 );
1150
1151 //
1152 // I/O Completion Routines
1153 //
1154 VOID
1155 NTAPI
1156 IopDeleteIoCompletion(
1157     PVOID ObjectBody
1158 );
1159
1160 //
1161 // Ramdisk Routines
1162 //
1163 NTSTATUS
1164 NTAPI
1165 IopStartRamdisk(
1166     IN PLOADER_PARAMETER_BLOCK LoaderBlock
1167 );
1168
1169 //
1170 // Global I/O Data
1171 //
1172 extern POBJECT_TYPE IoCompletionType;
1173 extern PDEVICE_NODE IopRootDeviceNode;
1174 extern KSPIN_LOCK IopDeviceTreeLock;
1175 extern ULONG IopTraceLevel;
1176 extern GENERAL_LOOKASIDE IopMdlLookasideList;
1177 extern GENERIC_MAPPING IopCompletionMapping;
1178 extern GENERIC_MAPPING IopFileMapping;
1179 extern POBJECT_TYPE _IoFileObjectType;
1180 extern HAL_DISPATCH _HalDispatchTable;
1181 extern LIST_ENTRY IopErrorLogListHead;
1182 extern ULONG IopNumTriageDumpDataBlocks;
1183 extern PVOID IopTriageDumpDataBlocks[64];
1184 extern PIO_BUS_TYPE_GUID_LIST PnpBusTypeGuidList;
1185 extern PDRIVER_OBJECT IopRootDriverObject;
1186
1187 //
1188 // Inlined Functions
1189 //
1190 #include "io_x.h"