Sync with trunk for console graphics palettes.
[reactos.git] / ntoskrnl / io / iomgr / iomgr.c
1 /*
2 * COPYRIGHT: See COPYING in the top level directory
3 * PROJECT: ReactOS Kernel
4 * FILE: ntoskrnl/io/iomgr.c
5 * PURPOSE: I/O Manager Initialization and Misc Utility Functions
6 *
7 * PROGRAMMERS: David Welch (welch@mcmail.com)
8 */
9
10 /* INCLUDES ****************************************************************/
11
12 #include <ntoskrnl.h>
13 #define NDEBUG
14 #include <debug.h>
15
16 ULONG IopTraceLevel = 0;
17 BOOLEAN PnpSystemInit = FALSE;
18
19 VOID
20 NTAPI
21 IopTimerDispatch(
22 IN PKDPC Dpc,
23 IN PVOID DeferredContext,
24 IN PVOID SystemArgument1,
25 IN PVOID SystemArgument2
26 );
27
28 /* DATA ********************************************************************/
29
30 POBJECT_TYPE IoDeviceObjectType = NULL;
31 POBJECT_TYPE IoFileObjectType = NULL;
32 extern POBJECT_TYPE IoControllerObjectType;
33 extern UNICODE_STRING NtSystemRoot;
34 BOOLEAN IoCountOperations = TRUE;
35 ULONG IoReadOperationCount = 0;
36 LARGE_INTEGER IoReadTransferCount = {{0, 0}};
37 ULONG IoWriteOperationCount = 0;
38 LARGE_INTEGER IoWriteTransferCount = {{0, 0}};
39 ULONG IoOtherOperationCount = 0;
40 LARGE_INTEGER IoOtherTransferCount = {{0, 0}};
41 KSPIN_LOCK IoStatisticsLock = 0;
42 ULONG IopNumTriageDumpDataBlocks;
43 PVOID IopTriageDumpDataBlocks[64];
44
45 GENERIC_MAPPING IopFileMapping = {
46 FILE_GENERIC_READ,
47 FILE_GENERIC_WRITE,
48 FILE_GENERIC_EXECUTE,
49 FILE_ALL_ACCESS};
50
51 extern LIST_ENTRY ShutdownListHead;
52 extern LIST_ENTRY LastChanceShutdownListHead;
53 extern KSPIN_LOCK ShutdownListLock;
54 extern POBJECT_TYPE IoAdapterObjectType;
55 extern ERESOURCE IopDatabaseResource;
56 ERESOURCE IopSecurityResource;
57 extern KGUARDED_MUTEX PnpNotifyListLock;
58 extern LIST_ENTRY IopDiskFileSystemQueueHead;
59 extern LIST_ENTRY IopCdRomFileSystemQueueHead;
60 extern LIST_ENTRY IopTapeFileSystemQueueHead;
61 extern LIST_ENTRY IopNetworkFileSystemQueueHead;
62 extern LIST_ENTRY DriverBootReinitListHead;
63 extern LIST_ENTRY DriverReinitListHead;
64 extern LIST_ENTRY PnpNotifyListHead;
65 extern LIST_ENTRY IopFsNotifyChangeQueueHead;
66 extern LIST_ENTRY IopErrorLogListHead;
67 extern LIST_ENTRY IopTimerQueueHead;
68 extern KDPC IopTimerDpc;
69 extern KTIMER IopTimer;
70 extern KSPIN_LOCK IoStatisticsLock;
71 extern KSPIN_LOCK DriverReinitListLock;
72 extern KSPIN_LOCK DriverBootReinitListLock;
73 extern KSPIN_LOCK IopLogListLock;
74 extern KSPIN_LOCK IopTimerLock;
75
76 extern PDEVICE_OBJECT IopErrorLogObject;
77
78 GENERAL_LOOKASIDE IoLargeIrpLookaside;
79 GENERAL_LOOKASIDE IoSmallIrpLookaside;
80 GENERAL_LOOKASIDE IopMdlLookasideList;
81 extern GENERAL_LOOKASIDE IoCompletionPacketLookaside;
82
83 PLOADER_PARAMETER_BLOCK IopLoaderBlock;
84
85 #if defined (ALLOC_PRAGMA)
86 #pragma alloc_text(INIT, IoInitSystem)
87 #endif
88
89 /* INIT FUNCTIONS ************************************************************/
90
91 VOID
92 INIT_FUNCTION
93 NTAPI
94 IopInitLookasideLists(VOID)
95 {
96 ULONG LargeIrpSize, SmallIrpSize, MdlSize;
97 LONG i;
98 PKPRCB Prcb;
99 PGENERAL_LOOKASIDE CurrentList = NULL;
100
101 /* Calculate the sizes */
102 LargeIrpSize = sizeof(IRP) + (8 * sizeof(IO_STACK_LOCATION));
103 SmallIrpSize = sizeof(IRP) + sizeof(IO_STACK_LOCATION);
104 MdlSize = sizeof(MDL) + (23 * sizeof(PFN_NUMBER));
105
106 /* Initialize the Lookaside List for I\O Completion */
107 ExInitializeSystemLookasideList(&IoCompletionPacketLookaside,
108 NonPagedPool,
109 sizeof(IOP_MINI_COMPLETION_PACKET),
110 IOC_TAG1,
111 32,
112 &ExSystemLookasideListHead);
113
114 /* Initialize the Lookaside List for Large IRPs */
115 ExInitializeSystemLookasideList(&IoLargeIrpLookaside,
116 NonPagedPool,
117 LargeIrpSize,
118 IO_LARGEIRP,
119 64,
120 &ExSystemLookasideListHead);
121
122
123 /* Initialize the Lookaside List for Small IRPs */
124 ExInitializeSystemLookasideList(&IoSmallIrpLookaside,
125 NonPagedPool,
126 SmallIrpSize,
127 IO_SMALLIRP,
128 32,
129 &ExSystemLookasideListHead);
130
131 /* Initialize the Lookaside List for MDLs */
132 ExInitializeSystemLookasideList(&IopMdlLookasideList,
133 NonPagedPool,
134 MdlSize,
135 TAG_MDL,
136 128,
137 &ExSystemLookasideListHead);
138
139 /* Allocate the global lookaside list buffer */
140 CurrentList = ExAllocatePoolWithTag(NonPagedPool,
141 4 * KeNumberProcessors *
142 sizeof(GENERAL_LOOKASIDE),
143 TAG_IO);
144
145 /* Loop all processors */
146 for (i = 0; i < KeNumberProcessors; i++)
147 {
148 /* Get the PRCB for this CPU */
149 Prcb = KiProcessorBlock[i];
150 DPRINT("Setting up lookaside for CPU: %x, PRCB: %p\n", i, Prcb);
151
152 /* Write IRP credit limit */
153 Prcb->LookasideIrpFloat = 512 / KeNumberProcessors;
154
155 /* Set the I/O Completion List */
156 Prcb->PPLookasideList[LookasideCompletionList].L = &IoCompletionPacketLookaside;
157 if (CurrentList)
158 {
159 /* Initialize the Lookaside List for mini-packets */
160 ExInitializeSystemLookasideList(CurrentList,
161 NonPagedPool,
162 sizeof(IOP_MINI_COMPLETION_PACKET),
163 IO_SMALLIRP_CPU,
164 32,
165 &ExSystemLookasideListHead);
166 Prcb->PPLookasideList[LookasideCompletionList].P = CurrentList;
167 CurrentList++;
168
169 }
170 else
171 {
172 Prcb->PPLookasideList[LookasideCompletionList].P = &IoCompletionPacketLookaside;
173 }
174
175 /* Set the Large IRP List */
176 Prcb->PPLookasideList[LookasideLargeIrpList].L = &IoLargeIrpLookaside;
177 if (CurrentList)
178 {
179 /* Initialize the Lookaside List for Large IRPs */
180 ExInitializeSystemLookasideList(CurrentList,
181 NonPagedPool,
182 LargeIrpSize,
183 IO_LARGEIRP_CPU,
184 64,
185 &ExSystemLookasideListHead);
186 Prcb->PPLookasideList[LookasideLargeIrpList].P = CurrentList;
187 CurrentList++;
188
189 }
190 else
191 {
192 Prcb->PPLookasideList[LookasideLargeIrpList].P = &IoLargeIrpLookaside;
193 }
194
195 /* Set the Small IRP List */
196 Prcb->PPLookasideList[LookasideSmallIrpList].L = &IoSmallIrpLookaside;
197 if (CurrentList)
198 {
199 /* Initialize the Lookaside List for Small IRPs */
200 ExInitializeSystemLookasideList(CurrentList,
201 NonPagedPool,
202 SmallIrpSize,
203 IO_SMALLIRP_CPU,
204 32,
205 &ExSystemLookasideListHead);
206 Prcb->PPLookasideList[LookasideSmallIrpList].P = CurrentList;
207 CurrentList++;
208
209 }
210 else
211 {
212 Prcb->PPLookasideList[LookasideSmallIrpList].P = &IoSmallIrpLookaside;
213 }
214
215 /* Set the MDL Completion List */
216 Prcb->PPLookasideList[LookasideMdlList].L = &IopMdlLookasideList;
217 if (CurrentList)
218 {
219 /* Initialize the Lookaside List for MDLs */
220 ExInitializeSystemLookasideList(CurrentList,
221 NonPagedPool,
222 SmallIrpSize,
223 TAG_MDL,
224 128,
225 &ExSystemLookasideListHead);
226
227 Prcb->PPLookasideList[LookasideMdlList].P = CurrentList;
228 CurrentList++;
229
230 }
231 else
232 {
233 Prcb->PPLookasideList[LookasideMdlList].P = &IopMdlLookasideList;
234 }
235 }
236 }
237
238 BOOLEAN
239 INIT_FUNCTION
240 NTAPI
241 IopCreateObjectTypes(VOID)
242 {
243 OBJECT_TYPE_INITIALIZER ObjectTypeInitializer;
244 UNICODE_STRING Name;
245
246 /* Initialize default settings */
247 RtlZeroMemory(&ObjectTypeInitializer, sizeof(ObjectTypeInitializer));
248 ObjectTypeInitializer.Length = sizeof(ObjectTypeInitializer);
249 ObjectTypeInitializer.PoolType = NonPagedPool;
250 ObjectTypeInitializer.InvalidAttributes = OBJ_OPENLINK;
251 ObjectTypeInitializer.ValidAccessMask = FILE_ALL_ACCESS;
252 ObjectTypeInitializer.UseDefaultObject = TRUE;
253 ObjectTypeInitializer.GenericMapping = IopFileMapping;
254
255 /* Do the Adapter Type */
256 RtlInitUnicodeString(&Name, L"Adapter");
257 if (!NT_SUCCESS(ObCreateObjectType(&Name,
258 &ObjectTypeInitializer,
259 NULL,
260 &IoAdapterObjectType))) return FALSE;
261
262 /* Do the Controller Type */
263 RtlInitUnicodeString(&Name, L"Controller");
264 ObjectTypeInitializer.DefaultNonPagedPoolCharge = sizeof(CONTROLLER_OBJECT);
265 if (!NT_SUCCESS(ObCreateObjectType(&Name,
266 &ObjectTypeInitializer,
267 NULL,
268 &IoControllerObjectType))) return FALSE;
269
270 /* Do the Device Type */
271 RtlInitUnicodeString(&Name, L"Device");
272 ObjectTypeInitializer.DefaultNonPagedPoolCharge = sizeof(DEVICE_OBJECT);
273 ObjectTypeInitializer.DeleteProcedure = IopDeleteDevice;
274 ObjectTypeInitializer.ParseProcedure = IopParseDevice;
275 ObjectTypeInitializer.SecurityProcedure = IopSecurityFile;
276 ObjectTypeInitializer.CaseInsensitive = TRUE;
277 if (!NT_SUCCESS(ObCreateObjectType(&Name,
278 &ObjectTypeInitializer,
279 NULL,
280 &IoDeviceObjectType))) return FALSE;
281
282 /* Initialize the Driver object type */
283 RtlInitUnicodeString(&Name, L"Driver");
284 ObjectTypeInitializer.DefaultNonPagedPoolCharge = sizeof(DRIVER_OBJECT);
285 ObjectTypeInitializer.DeleteProcedure = IopDeleteDriver;
286 ObjectTypeInitializer.ParseProcedure = NULL;
287 ObjectTypeInitializer.SecurityProcedure = NULL;
288 if (!NT_SUCCESS(ObCreateObjectType(&Name,
289 &ObjectTypeInitializer,
290 NULL,
291 &IoDriverObjectType))) return FALSE;
292
293 /* Initialize the I/O Completion object type */
294 RtlInitUnicodeString(&Name, L"IoCompletion");
295 ObjectTypeInitializer.DefaultNonPagedPoolCharge = sizeof(KQUEUE);
296 ObjectTypeInitializer.ValidAccessMask = IO_COMPLETION_ALL_ACCESS;
297 ObjectTypeInitializer.InvalidAttributes |= OBJ_PERMANENT;
298 ObjectTypeInitializer.GenericMapping = IopCompletionMapping;
299 ObjectTypeInitializer.DeleteProcedure = IopDeleteIoCompletion;
300 if (!NT_SUCCESS(ObCreateObjectType(&Name,
301 &ObjectTypeInitializer,
302 NULL,
303 &IoCompletionType))) return FALSE;
304
305 /* Initialize the File object type */
306 RtlInitUnicodeString(&Name, L"File");
307 ObjectTypeInitializer.DefaultNonPagedPoolCharge = sizeof(FILE_OBJECT);
308 ObjectTypeInitializer.InvalidAttributes |= OBJ_EXCLUSIVE;
309 ObjectTypeInitializer.MaintainHandleCount = TRUE;
310 ObjectTypeInitializer.ValidAccessMask = FILE_ALL_ACCESS;
311 ObjectTypeInitializer.GenericMapping = IopFileMapping;
312 ObjectTypeInitializer.CloseProcedure = IopCloseFile;
313 ObjectTypeInitializer.DeleteProcedure = IopDeleteFile;
314 ObjectTypeInitializer.SecurityProcedure = IopSecurityFile;
315 ObjectTypeInitializer.QueryNameProcedure = IopQueryNameFile;
316 ObjectTypeInitializer.ParseProcedure = IopParseFile;
317 ObjectTypeInitializer.UseDefaultObject = FALSE;
318 if (!NT_SUCCESS(ObCreateObjectType(&Name,
319 &ObjectTypeInitializer,
320 NULL,
321 &IoFileObjectType))) return FALSE;
322
323 /* Success */
324 return TRUE;
325 }
326
327 BOOLEAN
328 INIT_FUNCTION
329 NTAPI
330 IopCreateRootDirectories()
331 {
332 OBJECT_ATTRIBUTES ObjectAttributes;
333 UNICODE_STRING DirName;
334 HANDLE Handle;
335
336 /* Create the '\Driver' object directory */
337 RtlInitUnicodeString(&DirName, L"\\Driver");
338 InitializeObjectAttributes(&ObjectAttributes,
339 &DirName,
340 OBJ_PERMANENT,
341 NULL,
342 NULL);
343 if (!NT_SUCCESS(NtCreateDirectoryObject(&Handle,
344 DIRECTORY_ALL_ACCESS,
345 &ObjectAttributes))) return FALSE;
346 NtClose(Handle);
347
348 /* Create the '\FileSystem' object directory */
349 RtlInitUnicodeString(&DirName, L"\\FileSystem");
350 InitializeObjectAttributes(&ObjectAttributes,
351 &DirName,
352 OBJ_PERMANENT,
353 NULL,
354 NULL);
355 if (!NT_SUCCESS(NtCreateDirectoryObject(&Handle,
356 DIRECTORY_ALL_ACCESS,
357 &ObjectAttributes))) return FALSE;
358 NtClose(Handle);
359
360 /* Return success */
361 return TRUE;
362 }
363
364 BOOLEAN
365 INIT_FUNCTION
366 NTAPI
367 IopMarkBootPartition(IN PLOADER_PARAMETER_BLOCK LoaderBlock)
368 {
369 OBJECT_ATTRIBUTES ObjectAttributes;
370 STRING DeviceString;
371 CHAR Buffer[256];
372 UNICODE_STRING DeviceName;
373 NTSTATUS Status;
374 HANDLE FileHandle;
375 IO_STATUS_BLOCK IoStatusBlock;
376 PFILE_OBJECT FileObject;
377
378 /* Build the ARC device name */
379 sprintf(Buffer, "\\ArcName\\%s", LoaderBlock->ArcBootDeviceName);
380 RtlInitAnsiString(&DeviceString, Buffer);
381 Status = RtlAnsiStringToUnicodeString(&DeviceName, &DeviceString, TRUE);
382 if (!NT_SUCCESS(Status)) return FALSE;
383
384 /* Open it */
385 InitializeObjectAttributes(&ObjectAttributes,
386 &DeviceName,
387 OBJ_CASE_INSENSITIVE,
388 NULL,
389 NULL);
390 Status = ZwOpenFile(&FileHandle,
391 FILE_READ_ATTRIBUTES,
392 &ObjectAttributes,
393 &IoStatusBlock,
394 0,
395 FILE_NON_DIRECTORY_FILE);
396 if (!NT_SUCCESS(Status))
397 {
398 /* Fail */
399 KeBugCheckEx(INACCESSIBLE_BOOT_DEVICE,
400 (ULONG_PTR)&DeviceName,
401 Status,
402 0,
403 0);
404 }
405
406 /* Get the DO */
407 Status = ObReferenceObjectByHandle(FileHandle,
408 0,
409 IoFileObjectType,
410 KernelMode,
411 (PVOID *)&FileObject,
412 NULL);
413 if (!NT_SUCCESS(Status))
414 {
415 /* Fail */
416 RtlFreeUnicodeString(&DeviceName);
417 return FALSE;
418 }
419
420 /* Mark it as the boot partition */
421 FileObject->DeviceObject->Flags |= DO_SYSTEM_BOOT_PARTITION;
422
423 /* Save a copy of the DO for the I/O Error Logger */
424 ObReferenceObject(FileObject->DeviceObject);
425 IopErrorLogObject = FileObject->DeviceObject;
426
427 /* Cleanup and return success */
428 RtlFreeUnicodeString(&DeviceName);
429 NtClose(FileHandle);
430 ObDereferenceObject(FileObject);
431 return TRUE;
432 }
433
434 BOOLEAN
435 INIT_FUNCTION
436 NTAPI
437 IoInitSystem(IN PLOADER_PARAMETER_BLOCK LoaderBlock)
438 {
439 LARGE_INTEGER ExpireTime;
440 NTSTATUS Status;
441 CHAR Buffer[256];
442 ANSI_STRING NtBootPath, RootString;
443
444 /* Initialize empty NT Boot Path */
445 RtlInitEmptyAnsiString(&NtBootPath, Buffer, sizeof(Buffer));
446
447 /* Initialize the lookaside lists */
448 IopInitLookasideLists();
449
450 /* Initialize all locks and lists */
451 ExInitializeResource(&IopDatabaseResource);
452 ExInitializeResource(&IopSecurityResource);
453 KeInitializeGuardedMutex(&PnpNotifyListLock);
454 InitializeListHead(&IopDiskFileSystemQueueHead);
455 InitializeListHead(&IopCdRomFileSystemQueueHead);
456 InitializeListHead(&IopTapeFileSystemQueueHead);
457 InitializeListHead(&IopNetworkFileSystemQueueHead);
458 InitializeListHead(&DriverBootReinitListHead);
459 InitializeListHead(&DriverReinitListHead);
460 InitializeListHead(&PnpNotifyListHead);
461 InitializeListHead(&ShutdownListHead);
462 InitializeListHead(&LastChanceShutdownListHead);
463 InitializeListHead(&IopFsNotifyChangeQueueHead);
464 InitializeListHead(&IopErrorLogListHead);
465 KeInitializeSpinLock(&IoStatisticsLock);
466 KeInitializeSpinLock(&DriverReinitListLock);
467 KeInitializeSpinLock(&DriverBootReinitListLock);
468 KeInitializeSpinLock(&ShutdownListLock);
469 KeInitializeSpinLock(&IopLogListLock);
470
471 /* Initialize Timer List Lock */
472 KeInitializeSpinLock(&IopTimerLock);
473
474 /* Initialize Timer List */
475 InitializeListHead(&IopTimerQueueHead);
476
477 /* Initialize the DPC/Timer which will call the other Timer Routines */
478 ExpireTime.QuadPart = -10000000;
479 KeInitializeDpc(&IopTimerDpc, IopTimerDispatch, NULL);
480 KeInitializeTimerEx(&IopTimer, SynchronizationTimer);
481 KeSetTimerEx(&IopTimer, ExpireTime, 1000, &IopTimerDpc);
482
483 /* Create Object Types */
484 if (!IopCreateObjectTypes())
485 {
486 DPRINT1("IopCreateObjectTypes failed!\n");
487 return FALSE;
488 }
489
490 /* Create Object Directories */
491 if (!IopCreateRootDirectories())
492 {
493 DPRINT1("IopCreateRootDirectories failed!\n");
494 return FALSE;
495 }
496
497 /* Initialize PnP manager */
498 IopInitializePlugPlayServices();
499
500 /* Initialize HAL Root Bus Driver */
501 HalInitPnpDriver();
502
503 /* Make loader block available for the whole kernel */
504 IopLoaderBlock = LoaderBlock;
505
506 /* Load boot start drivers */
507 IopInitializeBootDrivers();
508
509 /* Call back drivers that asked for */
510 IopReinitializeBootDrivers();
511
512 /* Check if this was a ramdisk boot */
513 if (!_strnicmp(LoaderBlock->ArcBootDeviceName, "ramdisk(0)", 10))
514 {
515 /* Initialize the ramdisk driver */
516 IopStartRamdisk(LoaderBlock);
517 }
518
519 /* No one should need loader block any longer */
520 IopLoaderBlock = NULL;
521
522 /* Create ARC names for boot devices */
523 Status = IopCreateArcNames(LoaderBlock);
524 if (!NT_SUCCESS(Status))
525 {
526 DPRINT1("IopCreateArcNames failed: %lx\n", Status);
527 return FALSE;
528 }
529
530 /* Mark the system boot partition */
531 if (!IopMarkBootPartition(LoaderBlock))
532 {
533 DPRINT1("IopMarkBootPartition failed!\n");
534 return FALSE;
535 }
536
537 /* Initialize PnP root relations */
538 IopEnumerateDevice(IopRootDeviceNode->PhysicalDeviceObject);
539
540 #ifndef _WINKD_
541 /* Read KDB Data */
542 KdbInit();
543
544 /* I/O is now setup for disk access, so phase 3 */
545 KdInitSystem(3, LoaderBlock);
546 #endif
547
548 /* Load services for devices found by PnP manager */
549 IopInitializePnpServices(IopRootDeviceNode);
550
551 /* Load system start drivers */
552 IopInitializeSystemDrivers();
553 PnpSystemInit = TRUE;
554
555 /* Reinitialize drivers that requested it */
556 IopReinitializeDrivers();
557
558 /* Convert SystemRoot from ARC to NT path */
559 Status = IopReassignSystemRoot(LoaderBlock, &NtBootPath);
560 if (!NT_SUCCESS(Status))
561 {
562 DPRINT1("IopReassignSystemRoot failed: %lx\n", Status);
563 return FALSE;
564 }
565
566 /* Set the ANSI_STRING for the root path */
567 RootString.MaximumLength = NtSystemRoot.MaximumLength / sizeof(WCHAR);
568 RootString.Length = 0;
569 RootString.Buffer = ExAllocatePoolWithTag(PagedPool,
570 RootString.MaximumLength,
571 TAG_IO);
572
573 /* Convert the path into the ANSI_STRING */
574 Status = RtlUnicodeStringToAnsiString(&RootString, &NtSystemRoot, FALSE);
575 if (!NT_SUCCESS(Status))
576 {
577 DPRINT1("RtlUnicodeStringToAnsiString failed: %lx\n", Status);
578 return FALSE;
579 }
580
581 /* Assign drive letters */
582 IoAssignDriveLetters(LoaderBlock,
583 &NtBootPath,
584 (PUCHAR)RootString.Buffer,
585 &RootString);
586
587 /* Update system root */
588 Status = RtlAnsiStringToUnicodeString(&NtSystemRoot, &RootString, FALSE);
589 if (!NT_SUCCESS(Status))
590 {
591 DPRINT1("RtlAnsiStringToUnicodeString failed: %lx\n", Status);
592 return FALSE;
593 }
594
595 /* Load the System DLL and its Entrypoints */
596 Status = PsLocateSystemDll();
597 if (!NT_SUCCESS(Status))
598 {
599 DPRINT1("PsLocateSystemDll failed: %lx\n", Status);
600 return FALSE;
601 }
602
603 /* Return success */
604 return TRUE;
605 }
606
607 /* EOF */