3 * Copyright (C) 1998, 1999, 2000, 2001 ReactOS Team
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21 * COPYRIGHT: See COPYING in the top level directory
22 * PROJECT: ReactOS kernel
23 * FILE: ntoskrnl/ob/handle.c
24 * PURPOSE: Managing handles
25 * PROGRAMMER: David Welch (welch@cwcom.net)
30 /* INCLUDES ****************************************************************/
32 #include <ddk/ntddk.h>
33 #include <internal/ob.h>
34 #include <internal/ps.h>
35 #include <internal/pool.h>
36 #include <internal/safe.h>
39 #include <internal/debug.h>
41 /* TYPES *******************************************************************/
44 * PURPOSE: Defines a handle
49 ACCESS_MASK GrantedAccess;
51 } HANDLE_REP, *PHANDLE_REP;
53 #define HANDLE_BLOCK_ENTRIES ((PAGE_SIZE-sizeof(LIST_ENTRY))/sizeof(HANDLE_REP))
57 * PURPOSE: Defines a page's worth of handles
62 HANDLE_REP handles[HANDLE_BLOCK_ENTRIES];
63 } HANDLE_BLOCK, *PHANDLE_BLOCK;
66 /* GLOBALS *******************************************************************/
68 #define TAG_HANDLE_TABLE TAG('H', 'T', 'B', 'L')
70 /* FUNCTIONS ***************************************************************/
73 static PHANDLE_REP ObpGetObjectByHandle(PHANDLE_TABLE HandleTable, HANDLE h)
75 * FUNCTION: Get the data structure for a handle
77 * Process = Process to get the handle for
79 * ARGUMENTS: A pointer to the information about the handle on success,
84 unsigned int handle = (((unsigned int)h) >> 2) - 1;
85 unsigned int count=handle/HANDLE_BLOCK_ENTRIES;
86 HANDLE_BLOCK* blk = NULL;
89 DPRINT("ObpGetObjectByHandle(HandleTable %x, h %x)\n",HandleTable,h);
91 current = HandleTable->ListHead.Flink;
92 DPRINT("current %x\n",current);
96 current = current->Flink;
97 if (current == (&(HandleTable->ListHead)))
103 blk = CONTAINING_RECORD(current,HANDLE_BLOCK,entry);
104 DPRINT("object: %p\n",&(blk->handles[handle%HANDLE_BLOCK_ENTRIES]));
105 return(&(blk->handles[handle%HANDLE_BLOCK_ENTRIES]));
111 ObDuplicateObject(PEPROCESS SourceProcess,
112 PEPROCESS TargetProcess,
114 PHANDLE TargetHandle,
115 ACCESS_MASK DesiredAccess,
116 BOOLEAN InheritHandle,
120 PHANDLE_REP SourceHandleRep;
123 KeAcquireSpinLock(&SourceProcess->HandleTable.ListLock, &oldIrql);
124 SourceHandleRep = ObpGetObjectByHandle(&SourceProcess->HandleTable,
126 if (SourceHandleRep == NULL)
128 KeReleaseSpinLock(&SourceProcess->HandleTable.ListLock, oldIrql);
129 return(STATUS_INVALID_HANDLE);
131 ObjectBody = SourceHandleRep->ObjectBody;
132 ObReferenceObjectByPointer(ObjectBody,
137 if (Options & DUPLICATE_SAME_ACCESS)
139 DesiredAccess = SourceHandleRep->GrantedAccess;
142 KeReleaseSpinLock(&SourceProcess->HandleTable.ListLock, oldIrql);
143 ObCreateHandle(TargetProcess,
149 if (Options & DUPLICATE_CLOSE_SOURCE)
151 ZwClose(SourceHandle);
154 ObDereferenceObject(ObjectBody);
155 return(STATUS_SUCCESS);
159 NtDuplicateObject (IN HANDLE SourceProcessHandle,
160 IN HANDLE SourceHandle,
161 IN HANDLE TargetProcessHandle,
162 OUT PHANDLE UnsafeTargetHandle,
163 IN ACCESS_MASK DesiredAccess,
164 IN BOOLEAN InheritHandle,
167 * FUNCTION: Copies a handle from one process space to another
169 * SourceProcessHandle = The source process owning the handle. The
170 * source process should have opened
171 * the SourceHandle with PROCESS_DUP_HANDLE
173 * SourceHandle = The handle to the object.
174 * TargetProcessHandle = The destination process owning the handle
175 * TargetHandle (OUT) = Caller should supply storage for the
177 * DesiredAccess = The desired access to the handle.
178 * InheritHandle = Indicates wheter the new handle will be inheritable
180 * Options = Specifies special actions upon duplicating the handle.
181 * Can be one of the values DUPLICATE_CLOSE_SOURCE |
182 * DUPLICATE_SAME_ACCESS. DUPLICATE_CLOSE_SOURCE specifies
183 * that the source handle should be closed after duplicating.
184 * DUPLICATE_SAME_ACCESS specifies to ignore the
185 * DesiredAccess paramter and just grant the same access to
188 * REMARKS: This function maps to the win32 DuplicateHandle.
191 PEPROCESS SourceProcess;
192 PEPROCESS TargetProcess;
193 PHANDLE_REP SourceHandleRep;
199 ASSERT_IRQL(PASSIVE_LEVEL);
201 Status = ObReferenceObjectByHandle(SourceProcessHandle,
205 (PVOID*)&SourceProcess,
207 if (!NT_SUCCESS(Status))
211 Status = ObReferenceObjectByHandle(TargetProcessHandle,
215 (PVOID*)&TargetProcess,
217 if (!NT_SUCCESS(Status))
219 ObDereferenceObject(SourceProcess);
222 KeAcquireSpinLock(&SourceProcess->HandleTable.ListLock, &oldIrql);
223 SourceHandleRep = ObpGetObjectByHandle(&SourceProcess->HandleTable,
225 if (SourceHandleRep == NULL)
227 KeReleaseSpinLock(&SourceProcess->HandleTable.ListLock, oldIrql);
228 ObDereferenceObject(SourceProcess);
229 ObDereferenceObject(TargetProcess);
230 return(STATUS_INVALID_HANDLE);
232 ObjectBody = SourceHandleRep->ObjectBody;
233 ObReferenceObjectByPointer(ObjectBody,
238 if (Options & DUPLICATE_SAME_ACCESS)
240 DesiredAccess = SourceHandleRep->GrantedAccess;
243 KeReleaseSpinLock(&SourceProcess->HandleTable.ListLock, oldIrql);
244 if (!SourceHandleRep->Inherit)
246 ObDereferenceObject(TargetProcess);
247 ObDereferenceObject(SourceProcess);
248 ObDereferenceObject(ObjectBody);
249 return STATUS_INVALID_HANDLE;
251 ObCreateHandle(TargetProcess,
257 if (Options & DUPLICATE_CLOSE_SOURCE)
259 ZwClose(SourceHandle);
262 ObDereferenceObject(TargetProcess);
263 ObDereferenceObject(SourceProcess);
264 ObDereferenceObject(ObjectBody);
266 Status = MmCopyToCaller(UnsafeTargetHandle, &TargetHandle, sizeof(HANDLE));
267 if (!NT_SUCCESS(Status))
272 return(STATUS_SUCCESS);
275 VOID ObCloseAllHandles(PEPROCESS Process)
278 PHANDLE_TABLE HandleTable;
279 PLIST_ENTRY current_entry;
280 PHANDLE_BLOCK current;
283 BOOLEAN IsProcessHandle;
285 DPRINT("ObCloseAllHandles(Process %x)\n", Process);
287 HandleTable = &Process->HandleTable;
289 KeAcquireSpinLock(&HandleTable->ListLock, &oldIrql);
291 current_entry = HandleTable->ListHead.Flink;
293 while (current_entry != &HandleTable->ListHead)
295 current = CONTAINING_RECORD(current_entry, HANDLE_BLOCK, entry);
297 for (i = 0; i < HANDLE_BLOCK_ENTRIES; i++)
299 ObjectBody = current->handles[i].ObjectBody;
301 if (ObjectBody != NULL)
303 POBJECT_HEADER Header = BODY_TO_HEADER(ObjectBody);
305 if (Header->ObjectType == PsProcessType ||
306 Header->ObjectType == PsThreadType)
308 DPRINT("Deleting handle to %x\n", ObjectBody);
311 ObReferenceObjectByPointer(ObjectBody,
315 InterlockedDecrement(&Header->HandleCount);
316 current->handles[i].ObjectBody = NULL;
318 KeReleaseSpinLock(&HandleTable->ListLock, oldIrql);
320 if (Header->ObjectType == PsProcessType)
322 IsProcessHandle = TRUE;
327 IsProcessHandle = FALSE;
329 if ((Header->ObjectType != NULL) &&
330 (Header->ObjectType->Close != NULL))
332 Header->ObjectType->Close(ObjectBody,
333 Header->HandleCount);
336 ObDereferenceObject(ObjectBody);
339 KeAttachProcess(Process);
341 KeAcquireSpinLock(&HandleTable->ListLock, &oldIrql);
342 current_entry = &HandleTable->ListHead;
347 current_entry = current_entry->Flink;
349 KeReleaseSpinLock(&HandleTable->ListLock, oldIrql);
350 DPRINT("ObCloseAllHandles() finished\n");
351 DPRINT("Type %x\n", BODY_TO_HEADER(Process)->ObjectType);
354 VOID ObDeleteHandleTable(PEPROCESS Process)
356 * FUNCTION: Deletes the handle table associated with a process
359 PLIST_ENTRY current = NULL;
360 PHANDLE_TABLE HandleTable = NULL;
362 ObCloseAllHandles(Process);
364 HandleTable = &Process->HandleTable;
365 current = RemoveHeadList(&HandleTable->ListHead);
367 while (current != &HandleTable->ListHead)
369 HANDLE_BLOCK* HandleBlock = CONTAINING_RECORD(current,
372 DPRINT("Freeing %x\n", HandleBlock);
373 ExFreePool(HandleBlock);
375 current = RemoveHeadList(&HandleTable->ListHead);
379 #endif /* LIBCAPTIVE */
381 VOID ObCreateHandleTable(PEPROCESS Parent,
385 * FUNCTION: Creates a handle table for a process
387 * Parent = Parent process (or NULL if this is the first process)
388 * Inherit = True if the process should inherit its parent's handles
389 * Process = Process whose handle table is to be created
392 PHANDLE_TABLE ParentHandleTable, HandleTable;
394 PLIST_ENTRY parent_current;
396 PHANDLE_BLOCK current_block, new_block;
398 DPRINT("ObCreateHandleTable(Parent %x, Inherit %d, Process %x)\n",
399 Parent,Inherit,Process);
401 InitializeListHead(&(Process->HandleTable.ListHead));
402 KeInitializeSpinLock(&(Process->HandleTable.ListLock));
406 ParentHandleTable = &Parent->HandleTable;
407 HandleTable = &Process->HandleTable;
409 KeAcquireSpinLock(&Parent->HandleTable.ListLock, &oldIrql);
410 KeAcquireSpinLockAtDpcLevel(&Process->HandleTable.ListLock);
412 parent_current = ParentHandleTable->ListHead.Flink;
414 while (parent_current != &ParentHandleTable->ListHead)
416 current_block = CONTAINING_RECORD(parent_current,
419 new_block = ExAllocatePoolWithTag(NonPagedPool,
420 sizeof(HANDLE_BLOCK),
422 if (new_block == NULL)
426 RtlZeroMemory(new_block, sizeof(HANDLE_BLOCK));
428 for (i=0; i<HANDLE_BLOCK_ENTRIES; i++)
430 if (current_block->handles[i].ObjectBody)
432 if (current_block->handles[i].Inherit && Inherit)
434 new_block->handles[i].ObjectBody =
435 current_block->handles[i].ObjectBody;
436 new_block->handles[i].GrantedAccess =
437 current_block->handles[i].GrantedAccess;
438 new_block->handles[i].Inherit = TRUE;
439 InterlockedIncrement(&(BODY_TO_HEADER(current_block->handles[i].ObjectBody)->HandleCount));
443 InsertTailList(&Process->HandleTable.ListHead, &new_block->entry);
444 parent_current = parent_current->Flink;
446 KeReleaseSpinLockFromDpcLevel(&Process->HandleTable.ListLock);
447 KeReleaseSpinLock(&Parent->HandleTable.ListLock, oldIrql);
452 PVOID ObDeleteHandle(PEPROCESS Process, HANDLE Handle)
457 PHANDLE_TABLE HandleTable;
458 POBJECT_HEADER Header;
460 DPRINT("ObDeleteHandle(Handle %x)\n",Handle);
462 HandleTable = &Process->HandleTable;
464 KeAcquireSpinLock(&HandleTable->ListLock, &oldIrql);
466 Rep = ObpGetObjectByHandle(HandleTable, Handle);
469 KeReleaseSpinLock(&HandleTable->ListLock, oldIrql);
473 ObjectBody = Rep->ObjectBody;
474 DPRINT("ObjectBody %x\n", ObjectBody);
475 if (ObjectBody != NULL)
477 Header = BODY_TO_HEADER(ObjectBody);
478 InterlockedDecrement(&(BODY_TO_HEADER(ObjectBody)->HandleCount));
479 ObReferenceObjectByPointer(ObjectBody,
483 Rep->ObjectBody = NULL;
485 KeReleaseSpinLock(&HandleTable->ListLock, oldIrql);
487 if ((Header->ObjectType != NULL) &&
488 (Header->ObjectType->Close != NULL))
490 Header->ObjectType->Close(ObjectBody, Header->HandleCount);
495 KeReleaseSpinLock(&HandleTable->ListLock, oldIrql);
498 DPRINT("Finished ObDeleteHandle()\n");
503 NTSTATUS ObCreateHandle(PEPROCESS Process,
505 ACCESS_MASK GrantedAccess,
507 PHANDLE HandleReturn)
509 * FUNCTION: Add a handle referencing an object
511 * obj = Object body that the handle should refer to
512 * RETURNS: The created handle
513 * NOTE: The handle is valid only in the context of the current process
517 unsigned int handle=1;
519 HANDLE_BLOCK* new_blk = NULL;
520 PHANDLE_TABLE HandleTable;
523 DPRINT("ObCreateHandle(Process %x, obj %x)\n",Process,ObjectBody);
527 if (ObjectBody != NULL)
529 InterlockedIncrement(&(BODY_TO_HEADER(ObjectBody)->HandleCount));
531 HandleTable = &Process->HandleTable;
532 KeAcquireSpinLock(&HandleTable->ListLock, &oldlvl);
533 current = HandleTable->ListHead.Flink;
535 * Scan through the currently allocated handle blocks looking for a free
538 while (current != (&HandleTable->ListHead))
540 HANDLE_BLOCK* blk = CONTAINING_RECORD(current,HANDLE_BLOCK,entry);
542 DPRINT("Current %x\n",current);
544 for (i=0;i<HANDLE_BLOCK_ENTRIES;i++)
546 DPRINT("Considering slot %d containing %x\n",i,blk->handles[i]);
547 if (blk->handles[i].ObjectBody==NULL)
549 blk->handles[i].ObjectBody = ObjectBody;
550 blk->handles[i].GrantedAccess = GrantedAccess;
551 blk->handles[i].Inherit = Inherit;
552 KeReleaseSpinLock(&HandleTable->ListLock, oldlvl);
553 *HandleReturn = (HANDLE)((handle + i) << 2);
554 return(STATUS_SUCCESS);
558 handle = handle + HANDLE_BLOCK_ENTRIES;
559 current = current->Flink;
563 * Add a new handle block to the end of the list
566 (HANDLE_BLOCK *)ExAllocatePoolWithTag(NonPagedPool,sizeof(HANDLE_BLOCK),
570 *HandleReturn = (PHANDLE)NULL;
571 return(STATUS_INSUFFICIENT_RESOURCES);
573 RtlZeroMemory(new_blk,sizeof(HANDLE_BLOCK));
574 InsertTailList(&(Process->HandleTable.ListHead),
576 new_blk->handles[0].ObjectBody = ObjectBody;
577 new_blk->handles[0].GrantedAccess = GrantedAccess;
578 new_blk->handles[0].Inherit = Inherit;
579 KeReleaseSpinLock(&HandleTable->ListLock, oldlvl);
580 *HandleReturn = (HANDLE)(handle << 2);
581 return(STATUS_SUCCESS);
586 ObReferenceObjectByHandle(HANDLE Handle,
587 ACCESS_MASK DesiredAccess,
588 POBJECT_TYPE ObjectType,
589 KPROCESSOR_MODE AccessMode,
591 POBJECT_HANDLE_INFORMATION HandleInformationPtr)
593 * FUNCTION: Increments the reference count for an object and returns a
594 * pointer to its body
596 * Handle = Handle for the object
597 * DesiredAccess = Desired access to the object
600 * Object (OUT) = Points to the object body on return
601 * HandleInformation (OUT) = Contains information about the handle
606 PHANDLE_REP HandleRep;
607 POBJECT_HEADER ObjectHeader;
610 ACCESS_MASK GrantedAccess;
612 ASSERT_IRQL(PASSIVE_LEVEL);
614 DPRINT("ObReferenceObjectByHandle(Handle %x, DesiredAccess %x, "
615 "ObjectType %x, AccessMode %d, Object %x)\n",Handle,DesiredAccess,
616 ObjectType,AccessMode,Object);
620 * Handle special handle names
622 if (Handle == NtCurrentProcess() &&
623 (ObjectType == PsProcessType || ObjectType == NULL))
625 DPRINT("Reference from %x\n", ((PULONG)&Handle)[-1]);
627 ObReferenceObjectByPointer(PsGetCurrentProcess(),
631 *Object = PsGetCurrentProcess();
632 DPRINT("Referencing current process %x\n", PsGetCurrentProcess());
633 return(STATUS_SUCCESS);
635 else if (Handle == NtCurrentProcess())
638 return(STATUS_OBJECT_TYPE_MISMATCH);
640 if (Handle == NtCurrentThread() &&
641 (ObjectType == PsThreadType || ObjectType == NULL))
643 ObReferenceObjectByPointer(PsGetCurrentThread(),
647 *Object = PsGetCurrentThread();
649 return(STATUS_SUCCESS);
651 else if (Handle == NtCurrentThread())
654 return(STATUS_OBJECT_TYPE_MISMATCH);
657 KeAcquireSpinLock(&PsGetCurrentProcess()->HandleTable.ListLock,
659 HandleRep = ObpGetObjectByHandle(&PsGetCurrentProcess()->HandleTable,
661 if (HandleRep == NULL || HandleRep->ObjectBody == NULL)
663 KeReleaseSpinLock(&PsGetCurrentProcess()->HandleTable.ListLock,
665 return(STATUS_INVALID_HANDLE);
667 ObjectBody = HandleRep->ObjectBody;
668 DPRINT("ObjectBody %p\n",ObjectBody);
669 ObjectHeader = BODY_TO_HEADER(ObjectBody);
670 DPRINT("ObjectHeader->RefCount %lu\n",ObjectHeader->RefCount);
671 ObReferenceObjectByPointer(ObjectBody,
675 GrantedAccess = HandleRep->GrantedAccess;
676 KeReleaseSpinLock(&PsGetCurrentProcess()->HandleTable.ListLock,
679 ObjectHeader = BODY_TO_HEADER(ObjectBody);
680 DPRINT("ObjectHeader->RefCount %lu\n",ObjectHeader->RefCount);
682 if (ObjectType != NULL && ObjectType != ObjectHeader->ObjectType)
685 return(STATUS_OBJECT_TYPE_MISMATCH);
688 if (ObjectHeader->ObjectType == PsProcessType)
690 DPRINT("Reference from %x\n", ((PULONG)&Handle)[-1]);
693 if (AccessMode == UserMode)
695 RtlMapGenericMask(&DesiredAccess, ObjectHeader->ObjectType->Mapping);
697 if (!(GrantedAccess & DesiredAccess) &&
698 !((~GrantedAccess) & DesiredAccess))
701 return(STATUS_ACCESS_DENIED);
705 *Object = ObjectBody;
708 return(STATUS_SUCCESS);
711 /**********************************************************************
716 * Closes a handle reference to an object.
725 NTSTATUS STDCALL NtClose(HANDLE Handle)
728 POBJECT_HEADER Header;
730 assert_irql(PASSIVE_LEVEL);
732 DPRINT("NtClose(Handle %x)\n",Handle);
734 ObjectBody = ObDeleteHandle(PsGetCurrentProcess(), Handle);
735 if (ObjectBody == NULL)
737 return(STATUS_INVALID_HANDLE);
740 Header = BODY_TO_HEADER(ObjectBody);
742 DPRINT("Dereferencing %x\n", ObjectBody);
743 ObDereferenceObject(ObjectBody);
745 return(STATUS_SUCCESS);
751 ObInsertObject(PVOID Object,
752 PACCESS_STATE PassedAccessState,
753 ACCESS_MASK DesiredAccess,
754 ULONG AdditionalReferences,
755 PVOID* ReferencedObject,
758 return(ObCreateHandle(PsGetCurrentProcess(),
765 #endif /* LIBCAPTIVE */