2 * PROJECT: ReactOS Kernel
3 * LICENSE: GPL - See COPYING in the top level directory
4 * FILE: ntoskrnl/io/iomgr/driver.c
5 * PURPOSE: Driver Object Management
6 * PROGRAMMERS: Alex Ionescu (alex.ionescu@reactos.org)
7 * Filip Navara (navaraf@reactos.org)
8 * Hervé Poussineau (hpoussin@reactos.org)
11 /* INCLUDES *******************************************************************/
17 /* GLOBALS ********************************************************************/
19 LIST_ENTRY DriverReinitListHead
;
20 KSPIN_LOCK DriverReinitListLock
;
21 PLIST_ENTRY DriverReinitTailEntry
;
23 PLIST_ENTRY DriverBootReinitTailEntry
;
24 LIST_ENTRY DriverBootReinitListHead
;
25 KSPIN_LOCK DriverBootReinitListLock
;
27 UNICODE_STRING IopHardwareDatabaseKey
=
28 RTL_CONSTANT_STRING(L
"\\REGISTRY\\MACHINE\\HARDWARE\\DESCRIPTION\\SYSTEM");
30 POBJECT_TYPE IoDriverObjectType
= NULL
;
32 #define TAG_RTLREGISTRY 'vrqR'
34 extern BOOLEAN ExpInTextModeSetup
;
35 extern BOOLEAN PnpSystemInit
;
38 PLIST_ENTRY IopGroupTable
;
40 /* PRIVATE FUNCTIONS **********************************************************/
43 IopInvalidDeviceRequest(
44 PDEVICE_OBJECT DeviceObject
,
47 Irp
->IoStatus
.Status
= STATUS_INVALID_DEVICE_REQUEST
;
48 Irp
->IoStatus
.Information
= 0;
49 IoCompleteRequest(Irp
, IO_NO_INCREMENT
);
50 return STATUS_INVALID_DEVICE_REQUEST
;
55 IopDeleteDriver(IN PVOID ObjectBody
)
57 PDRIVER_OBJECT DriverObject
= ObjectBody
;
58 PIO_CLIENT_EXTENSION DriverExtension
, NextDriverExtension
;
61 /* Get the extension and loop them */
62 DriverExtension
= IoGetDrvObjExtension(DriverObject
)->
63 ClientDriverExtension
;
64 while (DriverExtension
)
66 /* Get the next one */
67 NextDriverExtension
= DriverExtension
->NextExtension
;
68 ExFreePoolWithTag(DriverExtension
, TAG_DRIVER_EXTENSION
);
71 DriverExtension
= NextDriverExtension
;
74 /* Check if the driver image is still loaded */
75 if (DriverObject
->DriverSection
)
78 MmUnloadSystemImage(DriverObject
->DriverSection
);
81 /* Check if it has a name */
82 if (DriverObject
->DriverName
.Buffer
)
85 ExFreePool(DriverObject
->DriverName
.Buffer
);
88 #if 0 /* See a bit of hack in IopCreateDriver */
89 /* Check if it has a service key name */
90 if (DriverObject
->DriverExtension
->ServiceKeyName
.Buffer
)
93 ExFreePool(DriverObject
->DriverExtension
->ServiceKeyName
.Buffer
);
100 PDRIVER_OBJECT
*DriverObject
,
101 PUNICODE_STRING ServiceName
,
104 PDRIVER_OBJECT Object
;
105 WCHAR NameBuffer
[MAX_PATH
];
106 UNICODE_STRING DriverName
;
109 DPRINT("IopGetDriverObject(%p '%wZ' %x)\n",
110 DriverObject
, ServiceName
, FileSystem
);
112 *DriverObject
= NULL
;
114 /* Create ModuleName string */
115 if (ServiceName
== NULL
|| ServiceName
->Buffer
== NULL
)
116 /* We don't know which DriverObject we have to open */
117 return STATUS_INVALID_PARAMETER_2
;
119 DriverName
.Buffer
= NameBuffer
;
120 DriverName
.Length
= 0;
121 DriverName
.MaximumLength
= sizeof(NameBuffer
);
123 if (FileSystem
== TRUE
)
124 RtlAppendUnicodeToString(&DriverName
, FILESYSTEM_ROOT_NAME
);
126 RtlAppendUnicodeToString(&DriverName
, DRIVER_ROOT_NAME
);
127 RtlAppendUnicodeStringToString(&DriverName
, ServiceName
);
129 DPRINT("Driver name: '%wZ'\n", &DriverName
);
131 /* Open driver object */
132 Status
= ObReferenceObjectByName(
134 OBJ_OPENIF
| OBJ_KERNEL_HANDLE
| OBJ_CASE_INSENSITIVE
, /* Attributes */
135 NULL
, /* PassedAccessState */
136 0, /* DesiredAccess */
139 NULL
, /* ParseContext */
142 if (!NT_SUCCESS(Status
))
144 DPRINT("Failed to reference driver object, status=0x%08x\n", Status
);
148 *DriverObject
= Object
;
150 DPRINT("Driver Object: %p\n", Object
);
152 return STATUS_SUCCESS
;
157 * TRUE if String2 contains String1 as a suffix.
161 IopSuffixUnicodeString(
162 IN PCUNICODE_STRING String1
,
163 IN PCUNICODE_STRING String2
)
169 if (String2
->Length
< String1
->Length
)
172 Length
= String1
->Length
/ 2;
173 pc1
= String1
->Buffer
;
174 pc2
= &String2
->Buffer
[String2
->Length
/ sizeof(WCHAR
) - Length
];
180 if( *pc1
++ != *pc2
++ )
189 * IopDisplayLoadingMessage
191 * Display 'Loading XXX...' message.
197 IopDisplayLoadingMessage(PUNICODE_STRING ServiceName
)
199 CHAR TextBuffer
[256];
200 UNICODE_STRING DotSys
= RTL_CONSTANT_STRING(L
".SYS");
202 if (ExpInTextModeSetup
) return;
203 if (!KeLoaderBlock
) return;
204 RtlUpcaseUnicodeString(ServiceName
, ServiceName
, FALSE
);
205 snprintf(TextBuffer
, sizeof(TextBuffer
),
206 "%s%sSystem32\\Drivers\\%wZ%s\n",
207 KeLoaderBlock
->ArcBootDeviceName
,
208 KeLoaderBlock
->NtBootPathName
,
210 IopSuffixUnicodeString(&DotSys
, ServiceName
) ? "" : ".SYS");
211 HalDisplayString(TextBuffer
);
215 * IopNormalizeImagePath
217 * Normalize an image path to contain complete path.
221 * The input path and on exit the result path. ImagePath.Buffer
222 * must be allocated by ExAllocatePool on input. Caller is responsible
223 * for freeing the buffer when it's no longer needed.
226 * Name of the service that ImagePath belongs to.
232 * The input image path isn't freed on error.
236 IopNormalizeImagePath(
237 IN OUT PUNICODE_STRING ImagePath
,
238 IN PUNICODE_STRING ServiceName
)
240 UNICODE_STRING InputImagePath
;
245 sizeof(UNICODE_STRING
));
247 if (InputImagePath
.Length
== 0)
249 ImagePath
->Length
= 0;
250 ImagePath
->MaximumLength
=
251 (33 * sizeof(WCHAR
)) + ServiceName
->Length
+ sizeof(UNICODE_NULL
);
252 ImagePath
->Buffer
= ExAllocatePool(NonPagedPool
, ImagePath
->MaximumLength
);
253 if (ImagePath
->Buffer
== NULL
)
254 return STATUS_NO_MEMORY
;
256 RtlAppendUnicodeToString(ImagePath
, L
"\\SystemRoot\\system32\\drivers\\");
257 RtlAppendUnicodeStringToString(ImagePath
, ServiceName
);
258 RtlAppendUnicodeToString(ImagePath
, L
".sys");
260 if (InputImagePath
.Buffer
[0] != L
'\\')
262 ImagePath
->Length
= 0;
263 ImagePath
->MaximumLength
=
264 12 * sizeof(WCHAR
) + InputImagePath
.Length
+ sizeof(UNICODE_NULL
);
265 ImagePath
->Buffer
= ExAllocatePool(NonPagedPool
, ImagePath
->MaximumLength
);
266 if (ImagePath
->Buffer
== NULL
)
267 return STATUS_NO_MEMORY
;
269 RtlAppendUnicodeToString(ImagePath
, L
"\\SystemRoot\\");
270 RtlAppendUnicodeStringToString(ImagePath
, &InputImagePath
);
272 /* Free caller's string */
273 ExFreePoolWithTag(InputImagePath
.Buffer
, TAG_RTLREGISTRY
);
276 return STATUS_SUCCESS
;
280 * IopLoadServiceModule
282 * Load a module specified by registry settings for service.
286 * Name of the service to load.
293 IopLoadServiceModule(
294 IN PUNICODE_STRING ServiceName
,
295 OUT PLDR_DATA_TABLE_ENTRY
*ModuleObject
)
297 RTL_QUERY_REGISTRY_TABLE QueryTable
[3];
299 UNICODE_STRING ServiceImagePath
, CCSName
;
301 HANDLE CCSKey
, ServiceKey
;
304 DPRINT("IopLoadServiceModule(%wZ, 0x%p)\n", ServiceName
, ModuleObject
);
306 /* FIXME: This check may be removed once the bug is fixed */
307 if (ServiceName
->Buffer
== NULL
)
309 DPRINT1("If you see this, please report to Fireball or hpoussin!\n");
310 return STATUS_UNSUCCESSFUL
;
313 /* Open CurrentControlSet */
314 RtlInitUnicodeString(&CCSName
,
315 L
"\\Registry\\Machine\\SYSTEM\\CurrentControlSet\\Services");
316 Status
= IopOpenRegistryKeyEx(&CCSKey
, NULL
, &CCSName
, KEY_READ
);
317 if (!NT_SUCCESS(Status
))
319 DPRINT1("ZwOpenKey() failed with Status %08X\n", Status
);
323 /* Open service key */
324 Status
= IopOpenRegistryKeyEx(&ServiceKey
, CCSKey
, ServiceName
, KEY_READ
);
325 if (!NT_SUCCESS(Status
))
327 DPRINT1("ZwOpenKey() failed with Status %08X\n", Status
);
333 * Get information about the service.
336 RtlZeroMemory(QueryTable
, sizeof(QueryTable
));
338 RtlInitUnicodeString(&ServiceImagePath
, NULL
);
340 QueryTable
[0].Name
= L
"Start";
341 QueryTable
[0].Flags
= RTL_QUERY_REGISTRY_DIRECT
;
342 QueryTable
[0].EntryContext
= &ServiceStart
;
344 QueryTable
[1].Name
= L
"ImagePath";
345 QueryTable
[1].Flags
= RTL_QUERY_REGISTRY_DIRECT
;
346 QueryTable
[1].EntryContext
= &ServiceImagePath
;
348 Status
= RtlQueryRegistryValues(RTL_REGISTRY_HANDLE
,
349 (PWSTR
)ServiceKey
, QueryTable
, NULL
, NULL
);
354 if (!NT_SUCCESS(Status
))
356 DPRINT1("RtlQueryRegistryValues() failed (Status %x)\n", Status
);
361 * Normalize the image path for all later processing.
364 Status
= IopNormalizeImagePath(&ServiceImagePath
, ServiceName
);
366 if (!NT_SUCCESS(Status
))
368 DPRINT("IopNormalizeImagePath() failed (Status %x)\n", Status
);
373 * Case for disabled drivers
376 if (ServiceStart
>= 4)
378 /* FIXME: Check if it is the right status code */
379 Status
= STATUS_PLUGPLAY_NO_DEVICE
;
383 DPRINT("Loading module\n");
384 Status
= MmLoadSystemImage(&ServiceImagePath
, NULL
, NULL
, 0, (PVOID
)ModuleObject
, &BaseAddress
);
387 ExFreePool(ServiceImagePath
.Buffer
);
390 * Now check if the module was loaded successfully.
393 if (!NT_SUCCESS(Status
))
395 DPRINT("Module loading failed (Status %x)\n", Status
);
398 DPRINT("Module loading (Status %x)\n", Status
);
404 * IopInitializeDriverModule
406 * Initalize a loaded driver.
410 * Pointer to device node.
413 * Module object representing the driver. It can be retrieve by
414 * IopLoadServiceModule.
417 * Name of the service (as in registry).
420 * Set to TRUE for file system drivers.
423 * On successful return this contains the driver object representing
428 IopInitializeDriverModule(
429 IN PDEVICE_NODE DeviceNode
,
430 IN PLDR_DATA_TABLE_ENTRY ModuleObject
,
431 IN PUNICODE_STRING ServiceName
,
432 IN BOOLEAN FileSystemDriver
,
433 OUT PDRIVER_OBJECT
*DriverObject
)
435 const WCHAR ServicesKeyName
[] = L
"\\Registry\\Machine\\System\\CurrentControlSet\\Services\\";
436 WCHAR NameBuffer
[MAX_PATH
];
437 UNICODE_STRING DriverName
;
438 UNICODE_STRING RegistryKey
;
439 PDRIVER_INITIALIZE DriverEntry
;
440 PDRIVER_OBJECT Driver
;
443 DriverEntry
= ModuleObject
->EntryPoint
;
445 if (ServiceName
!= NULL
&& ServiceName
->Length
!= 0)
447 RegistryKey
.Length
= 0;
448 RegistryKey
.MaximumLength
= sizeof(ServicesKeyName
) + ServiceName
->Length
;
449 RegistryKey
.Buffer
= ExAllocatePool(PagedPool
, RegistryKey
.MaximumLength
);
450 if (RegistryKey
.Buffer
== NULL
)
452 return STATUS_INSUFFICIENT_RESOURCES
;
454 RtlAppendUnicodeToString(&RegistryKey
, ServicesKeyName
);
455 RtlAppendUnicodeStringToString(&RegistryKey
, ServiceName
);
459 RtlInitUnicodeString(&RegistryKey
, NULL
);
462 /* Create ModuleName string */
463 if (ServiceName
&& ServiceName
->Length
> 0)
465 if (FileSystemDriver
== TRUE
)
466 wcscpy(NameBuffer
, FILESYSTEM_ROOT_NAME
);
468 wcscpy(NameBuffer
, DRIVER_ROOT_NAME
);
470 RtlInitUnicodeString(&DriverName
, NameBuffer
);
471 DriverName
.MaximumLength
= sizeof(NameBuffer
);
473 RtlAppendUnicodeStringToString(&DriverName
, ServiceName
);
475 DPRINT("Driver name: '%wZ'\n", &DriverName
);
478 DriverName
.Length
= 0;
480 Status
= IopCreateDriver(
481 DriverName
.Length
> 0 ? &DriverName
: NULL
,
484 ModuleObject
->DllBase
,
485 ModuleObject
->SizeOfImage
,
487 RtlFreeUnicodeString(&RegistryKey
);
489 *DriverObject
= Driver
;
490 if (!NT_SUCCESS(Status
))
492 DPRINT("IopCreateDriver() failed (Status 0x%08lx)\n", Status
);
496 /* Set the driver as initialized */
497 IopReadyDeviceObjects(Driver
);
499 if (PnpSystemInit
) IopReinitializeDrivers();
501 return STATUS_SUCCESS
;
505 * IopAttachFilterDriversCallback
507 * Internal routine used by IopAttachFilterDrivers.
511 IopAttachFilterDriversCallback(
519 PDEVICE_NODE DeviceNode
= Context
;
520 UNICODE_STRING ServiceName
;
522 PLDR_DATA_TABLE_ENTRY ModuleObject
;
523 PDRIVER_OBJECT DriverObject
;
526 for (Filters
= ValueData
;
527 ((ULONG_PTR
)Filters
- (ULONG_PTR
)ValueData
) < ValueLength
&&
529 Filters
+= (ServiceName
.Length
/ sizeof(WCHAR
)) + 1)
531 DPRINT("Filter Driver: %S (%wZ)\n", Filters
, &DeviceNode
->InstancePath
);
532 ServiceName
.Buffer
= Filters
;
533 ServiceName
.MaximumLength
=
534 ServiceName
.Length
= wcslen(Filters
) * sizeof(WCHAR
);
536 /* Load and initialize the filter driver */
537 Status
= IopLoadServiceModule(&ServiceName
, &ModuleObject
);
538 if (Status
!= STATUS_IMAGE_ALREADY_LOADED
)
540 if (!NT_SUCCESS(Status
))
543 Status
= IopInitializeDriverModule(DeviceNode
, ModuleObject
, &ServiceName
,
544 FALSE
, &DriverObject
);
545 if (!NT_SUCCESS(Status
))
550 /* get existing DriverObject pointer */
551 Status
= IopGetDriverObject(
555 if (!NT_SUCCESS(Status
))
557 DPRINT1("IopGetDriverObject() returned status 0x%08x!\n", Status
);
562 Status
= IopInitializeDevice(DeviceNode
, DriverObject
);
563 if (!NT_SUCCESS(Status
))
567 return STATUS_SUCCESS
;
571 * IopAttachFilterDrivers
573 * Load filter drivers for specified device node.
577 * Set to TRUE for loading lower level filters or FALSE for upper
582 IopAttachFilterDrivers(
583 PDEVICE_NODE DeviceNode
,
586 RTL_QUERY_REGISTRY_TABLE QueryTable
[2] = { { NULL
, 0, NULL
, NULL
, 0, NULL
, 0 }, };
587 UNICODE_STRING Class
;
588 WCHAR ClassBuffer
[40];
589 UNICODE_STRING EnumRoot
= RTL_CONSTANT_STRING(ENUM_ROOT
);
590 HANDLE EnumRootKey
, SubKey
;
593 /* Open enumeration root key */
594 Status
= IopOpenRegistryKeyEx(&EnumRootKey
, NULL
,
595 &EnumRoot
, KEY_READ
);
596 if (!NT_SUCCESS(Status
))
598 DPRINT1("ZwOpenKey() failed with Status %08X\n", Status
);
603 Status
= IopOpenRegistryKeyEx(&SubKey
, EnumRootKey
,
604 &DeviceNode
->InstancePath
, KEY_READ
);
605 if (!NT_SUCCESS(Status
))
607 DPRINT1("ZwOpenKey() failed with Status %08X\n", Status
);
608 ZwClose(EnumRootKey
);
613 * First load the device filters
615 QueryTable
[0].QueryRoutine
= IopAttachFilterDriversCallback
;
617 QueryTable
[0].Name
= L
"LowerFilters";
619 QueryTable
[0].Name
= L
"UpperFilters";
620 QueryTable
[0].Flags
= RTL_QUERY_REGISTRY_REQUIRED
;
622 RtlQueryRegistryValues(
630 * Now get the class GUID
633 Class
.MaximumLength
= 40 * sizeof(WCHAR
);
634 Class
.Buffer
= ClassBuffer
;
635 QueryTable
[0].QueryRoutine
= NULL
;
636 QueryTable
[0].Name
= L
"ClassGUID";
637 QueryTable
[0].EntryContext
= &Class
;
638 QueryTable
[0].Flags
= RTL_QUERY_REGISTRY_REQUIRED
| RTL_QUERY_REGISTRY_DIRECT
;
640 Status
= RtlQueryRegistryValues(
649 ZwClose(EnumRootKey
);
652 * Load the class filter driver
654 if (NT_SUCCESS(Status
))
656 UNICODE_STRING ControlClass
= RTL_CONSTANT_STRING(L
"\\Registry\\Machine\\System\\CurrentControlSet\\Control\\Class");
658 Status
= IopOpenRegistryKeyEx(&EnumRootKey
, NULL
,
659 &ControlClass
, KEY_READ
);
660 if (!NT_SUCCESS(Status
))
662 DPRINT1("ZwOpenKey() failed with Status %08X\n", Status
);
667 Status
= IopOpenRegistryKeyEx(&SubKey
, EnumRootKey
,
669 if (!NT_SUCCESS(Status
))
671 DPRINT1("ZwOpenKey() failed with Status %08X\n", Status
);
672 ZwClose(EnumRootKey
);
676 QueryTable
[0].QueryRoutine
= IopAttachFilterDriversCallback
;
678 QueryTable
[0].Name
= L
"LowerFilters";
680 QueryTable
[0].Name
= L
"UpperFilters";
681 QueryTable
[0].EntryContext
= NULL
;
682 QueryTable
[0].Flags
= RTL_QUERY_REGISTRY_REQUIRED
;
684 RtlQueryRegistryValues(
693 ZwClose(EnumRootKey
);
696 return STATUS_SUCCESS
;
701 MiResolveImageReferences(IN PVOID ImageBase
,
702 IN PUNICODE_STRING ImageFileDirectory
,
703 IN PUNICODE_STRING NamePrefix OPTIONAL
,
704 OUT PCHAR
*MissingApi
,
705 OUT PWCHAR
*MissingDriver
,
706 OUT PLOAD_IMPORTS
*LoadImports
);
709 // Used for images already loaded (boot drivers)
713 LdrProcessDriverModule(PLDR_DATA_TABLE_ENTRY LdrEntry
,
714 PUNICODE_STRING FileName
,
715 PLDR_DATA_TABLE_ENTRY
*ModuleObject
)
718 UNICODE_STRING BaseName
, BaseDirectory
;
719 PLOAD_IMPORTS LoadedImports
= (PVOID
)-2;
720 PCHAR MissingApiName
, Buffer
;
721 PWCHAR MissingDriverName
;
722 PVOID DriverBase
= LdrEntry
->DllBase
;
724 /* Allocate a buffer we'll use for names */
725 Buffer
= ExAllocatePoolWithTag(NonPagedPool
, MAX_PATH
, TAG_LDR_WSTR
);
729 return STATUS_INSUFFICIENT_RESOURCES
;
732 /* Check for a separator */
733 if (FileName
->Buffer
[0] == OBJ_NAME_PATH_SEPARATOR
)
738 /* Loop the path until we get to the base name */
739 p
= &FileName
->Buffer
[FileName
->Length
/ sizeof(WCHAR
)];
740 while (*(p
- 1) != OBJ_NAME_PATH_SEPARATOR
) p
--;
743 BaseLength
= (ULONG
)(&FileName
->Buffer
[FileName
->Length
/ sizeof(WCHAR
)] - p
);
744 BaseLength
*= sizeof(WCHAR
);
746 /* Setup the string */
747 BaseName
.Length
= (USHORT
)BaseLength
;
752 /* Otherwise, we already have a base name */
753 BaseName
.Length
= FileName
->Length
;
754 BaseName
.Buffer
= FileName
->Buffer
;
757 /* Setup the maximum length */
758 BaseName
.MaximumLength
= BaseName
.Length
;
760 /* Now compute the base directory */
761 BaseDirectory
= *FileName
;
762 BaseDirectory
.Length
-= BaseName
.Length
;
763 BaseDirectory
.MaximumLength
= BaseDirectory
.Length
;
765 /* Resolve imports */
766 MissingApiName
= Buffer
;
767 Status
= MiResolveImageReferences(DriverBase
,
773 if (!NT_SUCCESS(Status
)) return Status
;
776 *ModuleObject
= LdrEntry
;
777 return STATUS_SUCCESS
;
781 * IopInitializeBuiltinDriver
783 * Initialize a driver that is already loaded in memory.
788 IopInitializeBuiltinDriver(IN PLDR_DATA_TABLE_ENTRY LdrEntry
)
790 PDEVICE_NODE DeviceNode
;
791 PDRIVER_OBJECT DriverObject
;
793 PWCHAR FileNameWithoutPath
;
794 LPWSTR FileExtension
;
795 PUNICODE_STRING ModuleName
= &LdrEntry
->BaseDllName
;
796 UNICODE_STRING ServiceName
;
799 * Display 'Loading XXX...' message
801 IopDisplayLoadingMessage(ModuleName
);
802 InbvIndicateProgress();
805 * Generate filename without path (not needed by freeldr)
807 FileNameWithoutPath
= wcsrchr(ModuleName
->Buffer
, L
'\\');
808 if (FileNameWithoutPath
== NULL
)
810 FileNameWithoutPath
= ModuleName
->Buffer
;
814 FileNameWithoutPath
++;
818 * Strip the file extension from ServiceName
820 RtlCreateUnicodeString(&ServiceName
, FileNameWithoutPath
);
821 FileExtension
= wcsrchr(ServiceName
.Buffer
, '.');
822 if (FileExtension
!= NULL
)
824 ServiceName
.Length
-= wcslen(FileExtension
) * sizeof(WCHAR
);
825 FileExtension
[0] = 0;
829 * Determine the right device object
831 /* Use IopRootDeviceNode for now */
832 Status
= IopCreateDeviceNode(IopRootDeviceNode
, NULL
, &ServiceName
, &DeviceNode
);
833 if (!NT_SUCCESS(Status
))
835 DPRINT1("Driver '%wZ' load failed, status (%x)\n", ModuleName
, Status
);
838 DeviceNode
->ServiceName
= ServiceName
;
841 * Initialize the driver
843 Status
= IopInitializeDriverModule(DeviceNode
, LdrEntry
,
844 &DeviceNode
->ServiceName
, FALSE
, &DriverObject
);
846 if (!NT_SUCCESS(Status
))
848 IopFreeDeviceNode(DeviceNode
);
852 Status
= IopInitializeDevice(DeviceNode
, DriverObject
);
853 if (NT_SUCCESS(Status
))
855 Status
= IopStartDevice(DeviceNode
);
862 * IopInitializeBootDrivers
864 * Initialize boot drivers and free memory for boot files.
874 IopInitializeBootDrivers(VOID
)
876 PLIST_ENTRY ListHead
, NextEntry
, NextEntry2
;
877 PLDR_DATA_TABLE_ENTRY LdrEntry
;
878 PDEVICE_NODE DeviceNode
;
879 PDRIVER_OBJECT DriverObject
;
880 LDR_DATA_TABLE_ENTRY ModuleObject
;
882 UNICODE_STRING DriverName
;
884 PDRIVER_INFORMATION DriverInfo
, DriverInfoTag
;
886 PBOOT_DRIVER_LIST_ENTRY BootEntry
;
887 DPRINT("IopInitializeBootDrivers()\n");
889 /* Use IopRootDeviceNode for now */
890 Status
= IopCreateDeviceNode(IopRootDeviceNode
, NULL
, NULL
, &DeviceNode
);
891 if (!NT_SUCCESS(Status
)) return;
893 /* Setup the module object for the RAW FS Driver */
894 ModuleObject
.DllBase
= NULL
;
895 ModuleObject
.SizeOfImage
= 0;
896 ModuleObject
.EntryPoint
= RawFsDriverEntry
;
897 RtlInitUnicodeString(&DriverName
, L
"RAW");
900 Status
= IopInitializeDriverModule(DeviceNode
,
905 if (!NT_SUCCESS(Status
))
908 IopFreeDeviceNode(DeviceNode
);
912 /* Now initialize the associated device */
913 Status
= IopInitializeDevice(DeviceNode
, DriverObject
);
914 if (!NT_SUCCESS(Status
))
917 IopFreeDeviceNode(DeviceNode
);
922 Status
= IopStartDevice(DeviceNode
);
923 if (!NT_SUCCESS(Status
))
926 IopFreeDeviceNode(DeviceNode
);
930 /* Get highest group order index */
931 IopGroupIndex
= PpInitGetGroupOrderIndex(NULL
);
932 if (IopGroupIndex
== 0xFFFF) ASSERT(FALSE
);
934 /* Allocate the group table */
935 IopGroupTable
= ExAllocatePoolWithTag(PagedPool
,
936 IopGroupIndex
* sizeof(LIST_ENTRY
),
938 if (IopGroupTable
== NULL
) ASSERT(FALSE
);
940 /* Initialize the group table lists */
941 for (i
= 0; i
< IopGroupIndex
; i
++) InitializeListHead(&IopGroupTable
[i
]);
943 /* Loop the boot modules */
944 ListHead
= &KeLoaderBlock
->LoadOrderListHead
;
945 NextEntry
= ListHead
->Flink
;
946 while (ListHead
!= NextEntry
)
949 LdrEntry
= CONTAINING_RECORD(NextEntry
,
950 LDR_DATA_TABLE_ENTRY
,
953 /* Check if the DLL needs to be initialized */
954 if (LdrEntry
->Flags
& LDRP_DRIVER_DEPENDENT_DLL
)
956 /* Call its entrypoint */
957 MmCallDllInitialize(LdrEntry
, NULL
);
960 /* Go to the next driver */
961 NextEntry
= NextEntry
->Flink
;
964 /* Loop the boot drivers */
965 ListHead
= &KeLoaderBlock
->BootDriverListHead
;
966 NextEntry
= ListHead
->Flink
;
967 while (ListHead
!= NextEntry
)
970 BootEntry
= CONTAINING_RECORD(NextEntry
,
971 BOOT_DRIVER_LIST_ENTRY
,
974 /* Get the driver loader entry */
975 LdrEntry
= BootEntry
->LdrEntry
;
977 /* Allocate our internal accounting structure */
978 DriverInfo
= ExAllocatePoolWithTag(PagedPool
,
979 sizeof(DRIVER_INFORMATION
),
983 /* Zero it and initialize it */
984 RtlZeroMemory(DriverInfo
, sizeof(DRIVER_INFORMATION
));
985 InitializeListHead(&DriverInfo
->Link
);
986 DriverInfo
->DataTableEntry
= BootEntry
;
988 /* Open the registry key */
989 Status
= IopOpenRegistryKeyEx(&KeyHandle
,
991 &BootEntry
->RegistryPath
,
993 if ((NT_SUCCESS(Status
)) || /* ReactOS HACK for SETUPLDR */
994 ((KeLoaderBlock
->SetupLdrBlock
) && (KeyHandle
= (PVOID
)1)))
996 /* Save the handle */
997 DriverInfo
->ServiceHandle
= KeyHandle
;
999 /* Get the group oder index */
1000 Index
= PpInitGetGroupOrderIndex(KeyHandle
);
1002 /* Get the tag position */
1003 DriverInfo
->TagPosition
= PipGetDriverTagPriority(KeyHandle
);
1005 /* Insert it into the list, at the right place */
1006 ASSERT(Index
< IopGroupIndex
);
1007 NextEntry2
= IopGroupTable
[Index
].Flink
;
1008 while (NextEntry2
!= &IopGroupTable
[Index
])
1010 /* Get the driver info */
1011 DriverInfoTag
= CONTAINING_RECORD(NextEntry2
,
1015 /* Check if we found the right tag position */
1016 if (DriverInfoTag
->TagPosition
> DriverInfo
->TagPosition
)
1023 NextEntry2
= NextEntry2
->Flink
;
1026 /* Insert us right before the next entry */
1027 NextEntry2
= NextEntry2
->Blink
;
1028 InsertHeadList(NextEntry2
, &DriverInfo
->Link
);
1032 /* Go to the next driver */
1033 NextEntry
= NextEntry
->Flink
;
1036 /* Loop each group index */
1037 for (i
= 0; i
< IopGroupIndex
; i
++)
1039 /* Loop each group table */
1040 NextEntry
= IopGroupTable
[i
].Flink
;
1041 while (NextEntry
!= &IopGroupTable
[i
])
1044 DriverInfo
= CONTAINING_RECORD(NextEntry
,
1048 /* Get the driver loader entry */
1049 LdrEntry
= DriverInfo
->DataTableEntry
->LdrEntry
;
1052 IopInitializeBuiltinDriver(LdrEntry
);
1055 NextEntry
= NextEntry
->Flink
;
1059 /* In old ROS, the loader list became empty after this point. Simulate. */
1060 InitializeListHead(&KeLoaderBlock
->LoadOrderListHead
);
1065 IopInitializeSystemDrivers(VOID
)
1067 PUNICODE_STRING
*DriverList
, *SavedList
;
1069 /* No system drivers on the boot cd */
1070 if (KeLoaderBlock
->SetupLdrBlock
) return;
1072 /* Get the driver list */
1073 SavedList
= DriverList
= CmGetSystemDriverList();
1079 /* Load the driver */
1080 ZwLoadDriver(*DriverList
);
1082 /* Free the entry */
1083 RtlFreeUnicodeString(*DriverList
);
1084 ExFreePool(*DriverList
);
1087 InbvIndicateProgress();
1092 ExFreePool(SavedList
);
1098 * Unloads a device driver.
1102 * Name of the service to unload (registry key).
1105 * Whether to unload Plug & Plug or only legacy drivers. If this
1106 * parameter is set to FALSE, the routine will unload only legacy
1113 * Guard the whole function by SEH.
1117 IopUnloadDriver(PUNICODE_STRING DriverServiceName
, BOOLEAN UnloadPnpDrivers
)
1119 RTL_QUERY_REGISTRY_TABLE QueryTable
[2];
1120 UNICODE_STRING ImagePath
;
1121 UNICODE_STRING ServiceName
;
1122 UNICODE_STRING ObjectName
;
1123 PDRIVER_OBJECT DriverObject
;
1124 PDEVICE_OBJECT DeviceObject
;
1125 PEXTENDED_DEVOBJ_EXTENSION DeviceExtension
;
1126 LOAD_UNLOAD_PARAMS LoadParams
;
1129 BOOLEAN SafeToUnload
= TRUE
;
1131 DPRINT("IopUnloadDriver('%wZ', %d)\n", DriverServiceName
, UnloadPnpDrivers
);
1136 * Get the service name from the registry key name
1139 Start
= wcsrchr(DriverServiceName
->Buffer
, L
'\\');
1141 Start
= DriverServiceName
->Buffer
;
1145 RtlInitUnicodeString(&ServiceName
, Start
);
1148 * Construct the driver object name
1151 ObjectName
.Length
= (wcslen(Start
) + 8) * sizeof(WCHAR
);
1152 ObjectName
.MaximumLength
= ObjectName
.Length
+ sizeof(WCHAR
);
1153 ObjectName
.Buffer
= ExAllocatePool(PagedPool
, ObjectName
.MaximumLength
);
1154 if (!ObjectName
.Buffer
) return STATUS_INSUFFICIENT_RESOURCES
;
1155 wcscpy(ObjectName
.Buffer
, L
"\\Driver\\");
1156 memcpy(ObjectName
.Buffer
+ 8, Start
, ObjectName
.Length
- 8 * sizeof(WCHAR
));
1157 ObjectName
.Buffer
[ObjectName
.Length
/sizeof(WCHAR
)] = 0;
1160 * Find the driver object
1162 Status
= ObReferenceObjectByName(&ObjectName
,
1169 (PVOID
*)&DriverObject
);
1171 if (!NT_SUCCESS(Status
))
1173 DPRINT1("Can't locate driver object for %wZ\n", &ObjectName
);
1174 ExFreePool(ObjectName
.Buffer
);
1179 * Free the buffer for driver object name
1181 ExFreePool(ObjectName
.Buffer
);
1183 /* Check that driver is not already unloading */
1184 if (DriverObject
->Flags
& DRVO_UNLOAD_INVOKED
)
1186 DPRINT1("Driver deletion pending\n");
1187 ObDereferenceObject(DriverObject
);
1188 return STATUS_DELETE_PENDING
;
1192 * Get path of service...
1195 RtlZeroMemory(QueryTable
, sizeof(QueryTable
));
1197 RtlInitUnicodeString(&ImagePath
, NULL
);
1199 QueryTable
[0].Name
= L
"ImagePath";
1200 QueryTable
[0].Flags
= RTL_QUERY_REGISTRY_DIRECT
;
1201 QueryTable
[0].EntryContext
= &ImagePath
;
1203 Status
= RtlQueryRegistryValues(RTL_REGISTRY_ABSOLUTE
,
1204 DriverServiceName
->Buffer
, QueryTable
, NULL
, NULL
);
1206 if (!NT_SUCCESS(Status
))
1208 DPRINT1("RtlQueryRegistryValues() failed (Status %x)\n", Status
);
1209 ObDereferenceObject(DriverObject
);
1214 * Normalize the image path for all later processing.
1217 Status
= IopNormalizeImagePath(&ImagePath
, &ServiceName
);
1219 if (!NT_SUCCESS(Status
))
1221 DPRINT1("IopNormalizeImagePath() failed (Status %x)\n", Status
);
1222 ObDereferenceObject(DriverObject
);
1227 * Free the service path
1230 ExFreePool(ImagePath
.Buffer
);
1233 * Unload the module and release the references to the device object
1236 /* Call the load/unload routine, depending on current process */
1237 if (DriverObject
->DriverUnload
&& DriverObject
->DriverSection
)
1239 /* Loop through each device object of the driver
1240 and set DOE_UNLOAD_PENDING flag */
1241 DeviceObject
= DriverObject
->DeviceObject
;
1242 while (DeviceObject
)
1244 /* Set the unload pending flag for the device */
1245 DeviceExtension
= IoGetDevObjExtension(DeviceObject
);
1246 DeviceExtension
->ExtensionFlags
|= DOE_UNLOAD_PENDING
;
1248 /* Make sure there are no attached devices or no reference counts */
1249 if ((DeviceObject
->ReferenceCount
) || (DeviceObject
->AttachedDevice
))
1251 /* Not safe to unload */
1252 DPRINT1("Drivers device object is referenced or has attached devices\n");
1254 SafeToUnload
= FALSE
;
1257 DeviceObject
= DeviceObject
->NextDevice
;
1260 /* If not safe to unload, then return success */
1263 ObDereferenceObject(DriverObject
);
1264 return STATUS_SUCCESS
;
1267 /* Set the unload invoked flag */
1268 DriverObject
->Flags
|= DRVO_UNLOAD_INVOKED
;
1270 if (PsGetCurrentProcess() == PsInitialSystemProcess
)
1272 /* Just call right away */
1273 (*DriverObject
->DriverUnload
)(DriverObject
);
1277 /* Load/Unload must be called from system process */
1279 /* Prepare parameters block */
1280 LoadParams
.DriverObject
= DriverObject
;
1281 KeInitializeEvent(&LoadParams
.Event
, NotificationEvent
, FALSE
);
1283 ExInitializeWorkItem(&LoadParams
.WorkItem
,
1284 (PWORKER_THREAD_ROUTINE
)IopLoadUnloadDriver
,
1285 (PVOID
)&LoadParams
);
1288 ExQueueWorkItem(&LoadParams
.WorkItem
, DelayedWorkQueue
);
1290 /* And wait when it completes */
1291 KeWaitForSingleObject(&LoadParams
.Event
, UserRequest
, KernelMode
,
1295 /* Mark the driver object temporary, so it could be deleted later */
1296 ObMakeTemporaryObject(DriverObject
);
1298 /* Dereference it 2 times */
1299 ObDereferenceObject(DriverObject
);
1300 ObDereferenceObject(DriverObject
);
1302 return STATUS_SUCCESS
;
1306 /* Dereference one time (refd inside this function) */
1307 ObDereferenceObject(DriverObject
);
1309 /* Return unloading failure */
1310 return STATUS_INVALID_DEVICE_REQUEST
;
1316 IopReinitializeDrivers(VOID
)
1318 PDRIVER_REINIT_ITEM ReinitItem
;
1321 /* Get the first entry and start looping */
1322 Entry
= ExInterlockedRemoveHeadList(&DriverReinitListHead
,
1323 &DriverReinitListLock
);
1327 ReinitItem
= CONTAINING_RECORD(Entry
, DRIVER_REINIT_ITEM
, ItemEntry
);
1329 /* Increment reinitialization counter */
1330 ReinitItem
->DriverObject
->DriverExtension
->Count
++;
1332 /* Remove the device object flag */
1333 ReinitItem
->DriverObject
->Flags
&= ~DRVO_REINIT_REGISTERED
;
1335 /* Call the routine */
1336 ReinitItem
->ReinitRoutine(ReinitItem
->DriverObject
,
1337 ReinitItem
->Context
,
1338 ReinitItem
->DriverObject
->
1339 DriverExtension
->Count
);
1341 /* Free the entry */
1344 /* Move to the next one */
1345 Entry
= ExInterlockedRemoveHeadList(&DriverReinitListHead
,
1346 &DriverReinitListLock
);
1352 IopReinitializeBootDrivers(VOID
)
1354 PDRIVER_REINIT_ITEM ReinitItem
;
1357 /* Get the first entry and start looping */
1358 Entry
= ExInterlockedRemoveHeadList(&DriverBootReinitListHead
,
1359 &DriverBootReinitListLock
);
1363 ReinitItem
= CONTAINING_RECORD(Entry
, DRIVER_REINIT_ITEM
, ItemEntry
);
1365 /* Increment reinitialization counter */
1366 ReinitItem
->DriverObject
->DriverExtension
->Count
++;
1368 /* Remove the device object flag */
1369 ReinitItem
->DriverObject
->Flags
&= ~DRVO_BOOTREINIT_REGISTERED
;
1371 /* Call the routine */
1372 ReinitItem
->ReinitRoutine(ReinitItem
->DriverObject
,
1373 ReinitItem
->Context
,
1374 ReinitItem
->DriverObject
->
1375 DriverExtension
->Count
);
1377 /* Free the entry */
1380 /* Move to the next one */
1381 Entry
= ExInterlockedRemoveHeadList(&DriverBootReinitListHead
,
1382 &DriverBootReinitListLock
);
1388 IopCreateDriver(IN PUNICODE_STRING DriverName OPTIONAL
,
1389 IN PDRIVER_INITIALIZE InitializationFunction
,
1390 IN PUNICODE_STRING RegistryPath
,
1392 IN ULONG SizeOfImage
,
1393 OUT PDRIVER_OBJECT
*pDriverObject
)
1395 WCHAR NameBuffer
[100];
1397 UNICODE_STRING LocalDriverName
;
1399 OBJECT_ATTRIBUTES ObjectAttributes
;
1401 PDRIVER_OBJECT DriverObject
;
1402 UNICODE_STRING ServiceKeyName
;
1404 ULONG i
, RetryCount
= 0;
1407 /* First, create a unique name for the driver if we don't have one */
1410 /* Create a random name and set up the string*/
1411 NameLength
= (USHORT
)swprintf(NameBuffer
,
1414 LocalDriverName
.Length
= NameLength
* sizeof(WCHAR
);
1415 LocalDriverName
.MaximumLength
= LocalDriverName
.Length
+ sizeof(UNICODE_NULL
);
1416 LocalDriverName
.Buffer
= NameBuffer
;
1420 /* So we can avoid another code path, use a local var */
1421 LocalDriverName
= *DriverName
;
1424 /* Initialize the Attributes */
1425 ObjectSize
= sizeof(DRIVER_OBJECT
) + sizeof(EXTENDED_DRIVER_EXTENSION
);
1426 InitializeObjectAttributes(&ObjectAttributes
,
1428 OBJ_PERMANENT
| OBJ_CASE_INSENSITIVE
,
1432 /* Create the Object */
1433 Status
= ObCreateObject(KernelMode
,
1441 (PVOID
*)&DriverObject
);
1442 if (!NT_SUCCESS(Status
)) return Status
;
1444 DPRINT("IopCreateDriver(): created DO %p\n", DriverObject
);
1446 /* Set up the Object */
1447 RtlZeroMemory(DriverObject
, ObjectSize
);
1448 DriverObject
->Type
= IO_TYPE_DRIVER
;
1449 DriverObject
->Size
= sizeof(DRIVER_OBJECT
);
1450 DriverObject
->Flags
= DRVO_LEGACY_DRIVER
;//DRVO_BUILTIN_DRIVER;
1451 DriverObject
->DriverExtension
= (PDRIVER_EXTENSION
)(DriverObject
+ 1);
1452 DriverObject
->DriverExtension
->DriverObject
= DriverObject
;
1453 DriverObject
->DriverInit
= InitializationFunction
;
1455 /* Loop all Major Functions */
1456 for (i
= 0; i
<= IRP_MJ_MAXIMUM_FUNCTION
; i
++)
1458 /* Invalidate each function */
1459 DriverObject
->MajorFunction
[i
] = IopInvalidDeviceRequest
;
1462 /* Set up the service key name buffer */
1463 ServiceKeyName
.Buffer
= ExAllocatePoolWithTag(PagedPool
,
1464 LocalDriverName
.Length
+
1467 if (!ServiceKeyName
.Buffer
)
1470 ObMakeTemporaryObject(DriverObject
);
1471 ObDereferenceObject(DriverObject
);
1472 return STATUS_INSUFFICIENT_RESOURCES
;
1475 /* Fill out the key data and copy the buffer */
1476 ServiceKeyName
.Length
= LocalDriverName
.Length
;
1477 ServiceKeyName
.MaximumLength
= LocalDriverName
.MaximumLength
;
1478 RtlCopyMemory(ServiceKeyName
.Buffer
,
1479 LocalDriverName
.Buffer
,
1480 LocalDriverName
.Length
);
1482 /* Null-terminate it and set it */
1483 ServiceKeyName
.Buffer
[ServiceKeyName
.Length
/ sizeof(WCHAR
)] = UNICODE_NULL
;
1484 DriverObject
->DriverExtension
->ServiceKeyName
= ServiceKeyName
;
1486 /* Also store it in the Driver Object. This is a bit of a hack. */
1487 RtlCopyMemory(&DriverObject
->DriverName
,
1489 sizeof(UNICODE_STRING
));
1491 /* Add the Object and get its handle */
1492 Status
= ObInsertObject(DriverObject
,
1499 /* Eliminate small possibility when this function is called more than
1500 once in a row, and KeTickCount doesn't get enough time to change */
1501 if (!DriverName
&& (Status
== STATUS_OBJECT_NAME_COLLISION
) && (RetryCount
< 100))
1507 if (!NT_SUCCESS(Status
)) return Status
;
1509 /* Now reference it */
1510 Status
= ObReferenceObjectByHandle(hDriver
,
1514 (PVOID
*)&DriverObject
,
1516 if (!NT_SUCCESS(Status
))
1519 ObMakeTemporaryObject(DriverObject
);
1520 ObDereferenceObject(DriverObject
);
1524 /* Close the extra handle */
1527 DriverObject
->HardwareDatabase
= &IopHardwareDatabaseKey
;
1528 DriverObject
->DriverStart
= DllBase
;
1529 DriverObject
->DriverSize
= SizeOfImage
;
1531 /* Finally, call its init function */
1532 DPRINT("RegistryKey: %wZ\n", RegistryPath
);
1533 DPRINT("Calling driver entrypoint at %p\n", InitializationFunction
);
1534 Status
= (*InitializationFunction
)(DriverObject
, RegistryPath
);
1535 if (!NT_SUCCESS(Status
))
1537 /* If it didn't work, then kill the object */
1538 DPRINT1("'%wZ' initialization failed, status (0x%08lx)\n", DriverName
, Status
);
1539 ObMakeTemporaryObject(DriverObject
);
1540 ObDereferenceObject(DriverObject
);
1544 /* Returns to caller the object */
1545 *pDriverObject
= DriverObject
;
1548 /* Loop all Major Functions */
1549 for (i
= 0; i
<= IRP_MJ_MAXIMUM_FUNCTION
; i
++)
1552 * Make sure the driver didn't set any dispatch entry point to NULL!
1553 * Doing so is illegal; drivers shouldn't touch entry points they
1557 /* Check if it did so anyway */
1558 if (!DriverObject
->MajorFunction
[i
])
1560 /* Print a warning in the debug log */
1561 DPRINT1("Driver <%wZ> set DriverObject->MajorFunction[%d] to NULL!\n",
1562 &DriverObject
->DriverName
, i
);
1565 DriverObject
->MajorFunction
[i
] = IopInvalidDeviceRequest
;
1569 /* Return the Status */
1573 /* PUBLIC FUNCTIONS ***********************************************************/
1580 IoCreateDriver(IN PUNICODE_STRING DriverName OPTIONAL
,
1581 IN PDRIVER_INITIALIZE InitializationFunction
)
1583 PDRIVER_OBJECT DriverObject
;
1584 return IopCreateDriver(DriverName
, InitializationFunction
, NULL
, 0, 0, &DriverObject
);
1592 IoDeleteDriver(IN PDRIVER_OBJECT DriverObject
)
1594 /* Simply dereference the Object */
1595 ObDereferenceObject(DriverObject
);
1603 IoRegisterBootDriverReinitialization(IN PDRIVER_OBJECT DriverObject
,
1604 IN PDRIVER_REINITIALIZE ReinitRoutine
,
1607 PDRIVER_REINIT_ITEM ReinitItem
;
1609 /* Allocate the entry */
1610 ReinitItem
= ExAllocatePoolWithTag(NonPagedPool
,
1611 sizeof(DRIVER_REINIT_ITEM
),
1613 if (!ReinitItem
) return;
1616 ReinitItem
->DriverObject
= DriverObject
;
1617 ReinitItem
->ReinitRoutine
= ReinitRoutine
;
1618 ReinitItem
->Context
= Context
;
1620 /* Set the Driver Object flag and insert the entry into the list */
1621 DriverObject
->Flags
|= DRVO_BOOTREINIT_REGISTERED
;
1622 ExInterlockedInsertTailList(&DriverBootReinitListHead
,
1623 &ReinitItem
->ItemEntry
,
1624 &DriverBootReinitListLock
);
1632 IoRegisterDriverReinitialization(IN PDRIVER_OBJECT DriverObject
,
1633 IN PDRIVER_REINITIALIZE ReinitRoutine
,
1636 PDRIVER_REINIT_ITEM ReinitItem
;
1638 /* Allocate the entry */
1639 ReinitItem
= ExAllocatePoolWithTag(NonPagedPool
,
1640 sizeof(DRIVER_REINIT_ITEM
),
1642 if (!ReinitItem
) return;
1645 ReinitItem
->DriverObject
= DriverObject
;
1646 ReinitItem
->ReinitRoutine
= ReinitRoutine
;
1647 ReinitItem
->Context
= Context
;
1649 /* Set the Driver Object flag and insert the entry into the list */
1650 DriverObject
->Flags
|= DRVO_REINIT_REGISTERED
;
1651 ExInterlockedInsertTailList(&DriverReinitListHead
,
1652 &ReinitItem
->ItemEntry
,
1653 &DriverReinitListLock
);
1661 IoAllocateDriverObjectExtension(IN PDRIVER_OBJECT DriverObject
,
1662 IN PVOID ClientIdentificationAddress
,
1663 IN ULONG DriverObjectExtensionSize
,
1664 OUT PVOID
*DriverObjectExtension
)
1667 PIO_CLIENT_EXTENSION DriverExtensions
, NewDriverExtension
;
1668 BOOLEAN Inserted
= FALSE
;
1670 /* Assume failure */
1671 *DriverObjectExtension
= NULL
;
1673 /* Allocate the extension */
1674 NewDriverExtension
= ExAllocatePoolWithTag(NonPagedPool
,
1675 sizeof(IO_CLIENT_EXTENSION
) +
1676 DriverObjectExtensionSize
,
1677 TAG_DRIVER_EXTENSION
);
1678 if (!NewDriverExtension
) return STATUS_INSUFFICIENT_RESOURCES
;
1680 /* Clear the extension for teh caller */
1681 RtlZeroMemory(NewDriverExtension
,
1682 sizeof(IO_CLIENT_EXTENSION
) + DriverObjectExtensionSize
);
1685 OldIrql
= KeRaiseIrqlToDpcLevel();
1687 /* Fill out the extension */
1688 NewDriverExtension
->ClientIdentificationAddress
= ClientIdentificationAddress
;
1690 /* Loop the current extensions */
1691 DriverExtensions
= IoGetDrvObjExtension(DriverObject
)->
1692 ClientDriverExtension
;
1693 while (DriverExtensions
)
1695 /* Check if the identifier matches */
1696 if (DriverExtensions
->ClientIdentificationAddress
==
1697 ClientIdentificationAddress
)
1699 /* We have a collision, break out */
1703 /* Go to the next one */
1704 DriverExtensions
= DriverExtensions
->NextExtension
;
1707 /* Check if we didn't collide */
1708 if (!DriverExtensions
)
1710 /* Link this one in */
1711 NewDriverExtension
->NextExtension
=
1712 IoGetDrvObjExtension(DriverObject
)->ClientDriverExtension
;
1713 IoGetDrvObjExtension(DriverObject
)->ClientDriverExtension
=
1718 /* Release the lock */
1719 KeLowerIrql(OldIrql
);
1721 /* Check if insertion failed */
1724 /* Free the entry and fail */
1725 ExFreePool(NewDriverExtension
);
1726 return STATUS_OBJECT_NAME_COLLISION
;
1729 /* Otherwise, return the pointer */
1730 *DriverObjectExtension
= NewDriverExtension
+ 1;
1731 return STATUS_SUCCESS
;
1739 IoGetDriverObjectExtension(IN PDRIVER_OBJECT DriverObject
,
1740 IN PVOID ClientIdentificationAddress
)
1743 PIO_CLIENT_EXTENSION DriverExtensions
;
1746 OldIrql
= KeRaiseIrqlToDpcLevel();
1748 /* Loop the list until we find the right one */
1749 DriverExtensions
= IoGetDrvObjExtension(DriverObject
)->ClientDriverExtension
;
1750 while (DriverExtensions
)
1752 /* Check for a match */
1753 if (DriverExtensions
->ClientIdentificationAddress
==
1754 ClientIdentificationAddress
)
1761 DriverExtensions
= DriverExtensions
->NextExtension
;
1765 KeLowerIrql(OldIrql
);
1767 /* Return nothing or the extension */
1768 if (!DriverExtensions
) return NULL
;
1769 return DriverExtensions
+ 1;
1773 IopLoadUnloadDriver(PLOAD_UNLOAD_PARAMS LoadParams
)
1775 RTL_QUERY_REGISTRY_TABLE QueryTable
[3];
1776 UNICODE_STRING ImagePath
;
1777 UNICODE_STRING ServiceName
;
1780 PDEVICE_NODE DeviceNode
;
1781 PDRIVER_OBJECT DriverObject
;
1782 PLDR_DATA_TABLE_ENTRY ModuleObject
;
1786 /* Check if it's an unload request */
1787 if (LoadParams
->DriverObject
)
1789 (*LoadParams
->DriverObject
->DriverUnload
)(LoadParams
->DriverObject
);
1791 /* Return success and signal the event */
1792 LoadParams
->Status
= STATUS_SUCCESS
;
1793 (VOID
)KeSetEvent(&LoadParams
->Event
, 0, FALSE
);
1797 RtlInitUnicodeString(&ImagePath
, NULL
);
1800 * Get the service name from the registry key name.
1802 ASSERT(LoadParams
->ServiceName
->Length
>= sizeof(WCHAR
));
1804 ServiceName
= *LoadParams
->ServiceName
;
1805 cur
= LoadParams
->ServiceName
->Buffer
+
1806 (LoadParams
->ServiceName
->Length
/ sizeof(WCHAR
)) - 1;
1807 while (LoadParams
->ServiceName
->Buffer
!= cur
)
1811 ServiceName
.Buffer
= cur
+ 1;
1812 ServiceName
.Length
= LoadParams
->ServiceName
->Length
-
1813 (USHORT
)((ULONG_PTR
)ServiceName
.Buffer
-
1814 (ULONG_PTR
)LoadParams
->ServiceName
->Buffer
);
1820 IopDisplayLoadingMessage(&ServiceName
);
1826 RtlZeroMemory(&QueryTable
, sizeof(QueryTable
));
1828 RtlInitUnicodeString(&ImagePath
, NULL
);
1830 QueryTable
[0].Name
= L
"Type";
1831 QueryTable
[0].Flags
= RTL_QUERY_REGISTRY_DIRECT
| RTL_QUERY_REGISTRY_REQUIRED
;
1832 QueryTable
[0].EntryContext
= &Type
;
1834 QueryTable
[1].Name
= L
"ImagePath";
1835 QueryTable
[1].Flags
= RTL_QUERY_REGISTRY_DIRECT
;
1836 QueryTable
[1].EntryContext
= &ImagePath
;
1838 Status
= RtlQueryRegistryValues(RTL_REGISTRY_ABSOLUTE
,
1839 LoadParams
->ServiceName
->Buffer
, QueryTable
, NULL
, NULL
);
1841 if (!NT_SUCCESS(Status
))
1843 DPRINT("RtlQueryRegistryValues() failed (Status %lx)\n", Status
);
1844 if (ImagePath
.Buffer
)
1845 ExFreePool(ImagePath
.Buffer
);
1846 LoadParams
->Status
= Status
;
1847 (VOID
)KeSetEvent(&LoadParams
->Event
, 0, FALSE
);
1852 * Normalize the image path for all later processing.
1855 Status
= IopNormalizeImagePath(&ImagePath
, &ServiceName
);
1857 if (!NT_SUCCESS(Status
))
1859 DPRINT("IopNormalizeImagePath() failed (Status %x)\n", Status
);
1860 LoadParams
->Status
= Status
;
1861 (VOID
)KeSetEvent(&LoadParams
->Event
, 0, FALSE
);
1865 DPRINT("FullImagePath: '%wZ'\n", &ImagePath
);
1866 DPRINT("Type: %lx\n", Type
);
1869 * Create device node
1872 /* Use IopRootDeviceNode for now */
1873 Status
= IopCreateDeviceNode(IopRootDeviceNode
, NULL
, &ServiceName
, &DeviceNode
);
1875 if (!NT_SUCCESS(Status
))
1877 DPRINT("IopCreateDeviceNode() failed (Status %lx)\n", Status
);
1878 LoadParams
->Status
= Status
;
1879 (VOID
)KeSetEvent(&LoadParams
->Event
, 0, FALSE
);
1883 /* Get existing DriverObject pointer (in case the driver has
1884 already been loaded and initialized) */
1885 Status
= IopGetDriverObject(
1888 (Type
== 2 /* SERVICE_FILE_SYSTEM_DRIVER */ ||
1889 Type
== 8 /* SERVICE_RECOGNIZER_DRIVER */));
1891 if (!NT_SUCCESS(Status
))
1894 * Load the driver module
1897 Status
= MmLoadSystemImage(&ImagePath
, NULL
, NULL
, 0, (PVOID
)&ModuleObject
, &BaseAddress
);
1898 if (!NT_SUCCESS(Status
) && Status
!= STATUS_IMAGE_ALREADY_LOADED
)
1900 DPRINT("MmLoadSystemImage() failed (Status %lx)\n", Status
);
1901 IopFreeDeviceNode(DeviceNode
);
1902 LoadParams
->Status
= Status
;
1903 (VOID
)KeSetEvent(&LoadParams
->Event
, 0, FALSE
);
1908 * Set a service name for the device node
1911 RtlCreateUnicodeString(&DeviceNode
->ServiceName
, ServiceName
.Buffer
);
1914 * Initialize the driver module if it's loaded for the first time
1916 if (Status
!= STATUS_IMAGE_ALREADY_LOADED
)
1918 Status
= IopInitializeDriverModule(
1921 &DeviceNode
->ServiceName
,
1922 (Type
== 2 /* SERVICE_FILE_SYSTEM_DRIVER */ ||
1923 Type
== 8 /* SERVICE_RECOGNIZER_DRIVER */),
1926 if (!NT_SUCCESS(Status
))
1928 DPRINT("IopInitializeDriver() failed (Status %lx)\n", Status
);
1929 MmUnloadSystemImage(ModuleObject
);
1930 IopFreeDeviceNode(DeviceNode
);
1931 LoadParams
->Status
= Status
;
1932 (VOID
)KeSetEvent(&LoadParams
->Event
, 0, FALSE
);
1937 /* Store its DriverSection, so that it could be unloaded */
1938 DriverObject
->DriverSection
= ModuleObject
;
1940 /* Initialize and start device */
1941 IopInitializeDevice(DeviceNode
, DriverObject
);
1942 Status
= IopStartDevice(DeviceNode
);
1946 DPRINT("DriverObject already exist in ObjectManager\n");
1948 /* IopGetDriverObject references the DriverObject, so dereference it */
1949 ObDereferenceObject(DriverObject
);
1951 /* Free device node since driver loading failed */
1952 IopFreeDeviceNode(DeviceNode
);
1955 /* Pass status to the caller and signal the event */
1956 LoadParams
->Status
= Status
;
1957 (VOID
)KeSetEvent(&LoadParams
->Event
, 0, FALSE
);
1963 * Loads a device driver.
1967 * Name of the service to load (registry key).
1976 NtLoadDriver(IN PUNICODE_STRING DriverServiceName
)
1978 UNICODE_STRING CapturedDriverServiceName
= { 0, 0, NULL
};
1979 KPROCESSOR_MODE PreviousMode
;
1980 LOAD_UNLOAD_PARAMS LoadParams
;
1985 PreviousMode
= KeGetPreviousMode();
1988 * Check security privileges
1991 /* FIXME: Uncomment when privileges will be correctly implemented. */
1993 if (!SeSinglePrivilegeCheck(SeLoadDriverPrivilege
, PreviousMode
))
1995 DPRINT("Privilege not held\n");
1996 return STATUS_PRIVILEGE_NOT_HELD
;
2000 Status
= ProbeAndCaptureUnicodeString(&CapturedDriverServiceName
,
2003 if (!NT_SUCCESS(Status
))
2008 DPRINT("NtLoadDriver('%wZ')\n", &CapturedDriverServiceName
);
2010 LoadParams
.ServiceName
= &CapturedDriverServiceName
;
2011 LoadParams
.DriverObject
= NULL
;
2012 KeInitializeEvent(&LoadParams
.Event
, NotificationEvent
, FALSE
);
2014 /* Call the load/unload routine, depending on current process */
2015 if (PsGetCurrentProcess() == PsInitialSystemProcess
)
2017 /* Just call right away */
2018 IopLoadUnloadDriver(&LoadParams
);
2022 /* Load/Unload must be called from system process */
2023 ExInitializeWorkItem(&LoadParams
.WorkItem
,
2024 (PWORKER_THREAD_ROUTINE
)IopLoadUnloadDriver
,
2025 (PVOID
)&LoadParams
);
2028 ExQueueWorkItem(&LoadParams
.WorkItem
, DelayedWorkQueue
);
2030 /* And wait when it completes */
2031 KeWaitForSingleObject(&LoadParams
.Event
, UserRequest
, KernelMode
,
2035 ReleaseCapturedUnicodeString(&CapturedDriverServiceName
,
2038 return LoadParams
.Status
;
2044 * Unloads a legacy device driver.
2048 * Name of the service to unload (registry key).
2058 NtUnloadDriver(IN PUNICODE_STRING DriverServiceName
)
2060 return IopUnloadDriver(DriverServiceName
, FALSE
);