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;
284 DPRINT("ObCloseAllHandles(Process %x)\n", Process);
286 HandleTable = &Process->HandleTable;
288 KeAcquireSpinLock(&HandleTable->ListLock, &oldIrql);
290 current_entry = HandleTable->ListHead.Flink;
292 while (current_entry != &HandleTable->ListHead)
294 current = CONTAINING_RECORD(current_entry, HANDLE_BLOCK, entry);
296 for (i = 0; i < HANDLE_BLOCK_ENTRIES; i++)
298 ObjectBody = current->handles[i].ObjectBody;
300 if (ObjectBody != NULL)
302 POBJECT_HEADER Header = BODY_TO_HEADER(ObjectBody);
304 if (Header->ObjectType == PsProcessType ||
305 Header->ObjectType == PsThreadType)
307 DPRINT("Deleting handle to %x\n", ObjectBody);
310 ObReferenceObjectByPointer(ObjectBody,
314 InterlockedDecrement(&Header->HandleCount);
315 current->handles[i].ObjectBody = NULL;
317 KeReleaseSpinLock(&HandleTable->ListLock, oldIrql);
320 if ((Header->ObjectType != NULL) &&
321 (Header->ObjectType->Close != NULL))
323 Header->ObjectType->Close(ObjectBody,
324 Header->HandleCount);
327 ObDereferenceObject(ObjectBody);
328 KeAttachProcess(Process);
329 KeAcquireSpinLock(&HandleTable->ListLock, &oldIrql);
330 current_entry = &HandleTable->ListHead;
335 current_entry = current_entry->Flink;
337 KeReleaseSpinLock(&HandleTable->ListLock, oldIrql);
338 DPRINT("ObCloseAllHandles() finished\n");
339 DPRINT("Type %x\n", BODY_TO_HEADER(Process)->ObjectType);
342 VOID ObDeleteHandleTable(PEPROCESS Process)
344 * FUNCTION: Deletes the handle table associated with a process
347 PLIST_ENTRY current = NULL;
348 PHANDLE_TABLE HandleTable = NULL;
350 ObCloseAllHandles(Process);
352 HandleTable = &Process->HandleTable;
353 current = RemoveHeadList(&HandleTable->ListHead);
355 while (current != &HandleTable->ListHead)
357 HANDLE_BLOCK* HandleBlock = CONTAINING_RECORD(current,
360 DPRINT("Freeing %x\n", HandleBlock);
361 ExFreePool(HandleBlock);
363 current = RemoveHeadList(&HandleTable->ListHead);
367 #endif /* LIBCAPTIVE */
369 VOID ObCreateHandleTable(PEPROCESS Parent,
373 * FUNCTION: Creates a handle table for a process
375 * Parent = Parent process (or NULL if this is the first process)
376 * Inherit = True if the process should inherit its parent's handles
377 * Process = Process whose handle table is to be created
380 PHANDLE_TABLE ParentHandleTable, HandleTable;
382 PLIST_ENTRY parent_current;
384 PHANDLE_BLOCK current_block, new_block;
386 DPRINT("ObCreateHandleTable(Parent %x, Inherit %d, Process %x)\n",
387 Parent,Inherit,Process);
389 InitializeListHead(&(Process->HandleTable.ListHead));
390 KeInitializeSpinLock(&(Process->HandleTable.ListLock));
394 ParentHandleTable = &Parent->HandleTable;
395 HandleTable = &Process->HandleTable;
397 KeAcquireSpinLock(&Parent->HandleTable.ListLock, &oldIrql);
398 KeAcquireSpinLockAtDpcLevel(&Process->HandleTable.ListLock);
400 parent_current = ParentHandleTable->ListHead.Flink;
402 while (parent_current != &ParentHandleTable->ListHead)
404 current_block = CONTAINING_RECORD(parent_current,
407 new_block = ExAllocatePoolWithTag(NonPagedPool,
408 sizeof(HANDLE_BLOCK),
410 if (new_block == NULL)
414 RtlZeroMemory(new_block, sizeof(HANDLE_BLOCK));
416 for (i=0; i<HANDLE_BLOCK_ENTRIES; i++)
418 if (current_block->handles[i].ObjectBody)
420 if (current_block->handles[i].Inherit && Inherit)
422 new_block->handles[i].ObjectBody =
423 current_block->handles[i].ObjectBody;
424 new_block->handles[i].GrantedAccess =
425 current_block->handles[i].GrantedAccess;
426 new_block->handles[i].Inherit = TRUE;
427 InterlockedIncrement(&(BODY_TO_HEADER(current_block->handles[i].ObjectBody)->HandleCount));
431 InsertTailList(&Process->HandleTable.ListHead, &new_block->entry);
432 parent_current = parent_current->Flink;
434 KeReleaseSpinLockFromDpcLevel(&Process->HandleTable.ListLock);
435 KeReleaseSpinLock(&Parent->HandleTable.ListLock, oldIrql);
440 PVOID ObDeleteHandle(PEPROCESS Process, HANDLE Handle)
445 PHANDLE_TABLE HandleTable;
446 POBJECT_HEADER Header;
448 DPRINT("ObDeleteHandle(Handle %x)\n",Handle);
450 HandleTable = &Process->HandleTable;
452 KeAcquireSpinLock(&HandleTable->ListLock, &oldIrql);
454 Rep = ObpGetObjectByHandle(HandleTable, Handle);
457 KeReleaseSpinLock(&HandleTable->ListLock, oldIrql);
461 ObjectBody = Rep->ObjectBody;
462 DPRINT("ObjectBody %x\n", ObjectBody);
463 if (ObjectBody != NULL)
465 Header = BODY_TO_HEADER(ObjectBody);
466 InterlockedDecrement(&(BODY_TO_HEADER(ObjectBody)->HandleCount));
467 ObReferenceObjectByPointer(ObjectBody,
471 Rep->ObjectBody = NULL;
473 KeReleaseSpinLock(&HandleTable->ListLock, oldIrql);
475 if ((Header->ObjectType != NULL) &&
476 (Header->ObjectType->Close != NULL))
478 Header->ObjectType->Close(ObjectBody, Header->HandleCount);
483 KeReleaseSpinLock(&HandleTable->ListLock, oldIrql);
486 DPRINT("Finished ObDeleteHandle()\n");
491 NTSTATUS ObCreateHandle(PEPROCESS Process,
493 ACCESS_MASK GrantedAccess,
495 PHANDLE HandleReturn)
497 * FUNCTION: Add a handle referencing an object
499 * obj = Object body that the handle should refer to
500 * RETURNS: The created handle
501 * NOTE: The handle is valid only in the context of the current process
505 unsigned int handle=1;
507 HANDLE_BLOCK* new_blk = NULL;
508 PHANDLE_TABLE HandleTable;
511 DPRINT("ObCreateHandle(Process %x, obj %x)\n",Process,ObjectBody);
515 if (ObjectBody != NULL)
517 InterlockedIncrement(&(BODY_TO_HEADER(ObjectBody)->HandleCount));
519 HandleTable = &Process->HandleTable;
520 KeAcquireSpinLock(&HandleTable->ListLock, &oldlvl);
521 current = HandleTable->ListHead.Flink;
523 * Scan through the currently allocated handle blocks looking for a free
526 while (current != (&HandleTable->ListHead))
528 HANDLE_BLOCK* blk = CONTAINING_RECORD(current,HANDLE_BLOCK,entry);
530 DPRINT("Current %x\n",current);
532 for (i=0;i<HANDLE_BLOCK_ENTRIES;i++)
534 DPRINT("Considering slot %d containing %x\n",i,blk->handles[i]);
535 if (blk->handles[i].ObjectBody==NULL)
537 blk->handles[i].ObjectBody = ObjectBody;
538 blk->handles[i].GrantedAccess = GrantedAccess;
539 blk->handles[i].Inherit = Inherit;
540 KeReleaseSpinLock(&HandleTable->ListLock, oldlvl);
541 *HandleReturn = (HANDLE)((handle + i) << 2);
542 return(STATUS_SUCCESS);
546 handle = handle + HANDLE_BLOCK_ENTRIES;
547 current = current->Flink;
551 * Add a new handle block to the end of the list
554 (HANDLE_BLOCK *)ExAllocatePoolWithTag(NonPagedPool,sizeof(HANDLE_BLOCK),
558 *HandleReturn = (PHANDLE)NULL;
559 return(STATUS_INSUFFICIENT_RESOURCES);
561 RtlZeroMemory(new_blk,sizeof(HANDLE_BLOCK));
562 InsertTailList(&(Process->HandleTable.ListHead),
564 new_blk->handles[0].ObjectBody = ObjectBody;
565 new_blk->handles[0].GrantedAccess = GrantedAccess;
566 new_blk->handles[0].Inherit = Inherit;
567 KeReleaseSpinLock(&HandleTable->ListLock, oldlvl);
568 *HandleReturn = (HANDLE)(handle << 2);
569 return(STATUS_SUCCESS);
574 ObReferenceObjectByHandle(HANDLE Handle,
575 ACCESS_MASK DesiredAccess,
576 POBJECT_TYPE ObjectType,
577 KPROCESSOR_MODE AccessMode,
579 POBJECT_HANDLE_INFORMATION HandleInformationPtr)
581 * FUNCTION: Increments the reference count for an object and returns a
582 * pointer to its body
584 * Handle = Handle for the object
585 * DesiredAccess = Desired access to the object
588 * Object (OUT) = Points to the object body on return
589 * HandleInformation (OUT) = Contains information about the handle
594 PHANDLE_REP HandleRep;
595 POBJECT_HEADER ObjectHeader;
598 ACCESS_MASK GrantedAccess;
600 ASSERT_IRQL(PASSIVE_LEVEL);
602 DPRINT("ObReferenceObjectByHandle(Handle %x, DesiredAccess %x, "
603 "ObjectType %x, AccessMode %d, Object %x)\n",Handle,DesiredAccess,
604 ObjectType,AccessMode,Object);
608 * Handle special handle names
610 if (Handle == NtCurrentProcess() &&
611 (ObjectType == PsProcessType || ObjectType == NULL))
613 DPRINT("Reference from %x\n", ((PULONG)&Handle)[-1]);
615 ObReferenceObjectByPointer(PsGetCurrentProcess(),
619 *Object = PsGetCurrentProcess();
620 DPRINT("Referencing current process %x\n", PsGetCurrentProcess());
621 return(STATUS_SUCCESS);
623 else if (Handle == NtCurrentProcess())
626 return(STATUS_OBJECT_TYPE_MISMATCH);
628 if (Handle == NtCurrentThread() &&
629 (ObjectType == PsThreadType || ObjectType == NULL))
631 ObReferenceObjectByPointer(PsGetCurrentThread(),
635 *Object = PsGetCurrentThread();
637 return(STATUS_SUCCESS);
639 else if (Handle == NtCurrentThread())
642 return(STATUS_OBJECT_TYPE_MISMATCH);
645 KeAcquireSpinLock(&PsGetCurrentProcess()->HandleTable.ListLock,
647 HandleRep = ObpGetObjectByHandle(&PsGetCurrentProcess()->HandleTable,
649 if (HandleRep == NULL || HandleRep->ObjectBody == NULL)
651 KeReleaseSpinLock(&PsGetCurrentProcess()->HandleTable.ListLock,
653 return(STATUS_INVALID_HANDLE);
655 ObjectBody = HandleRep->ObjectBody;
656 DPRINT("ObjectBody %p\n",ObjectBody);
657 ObjectHeader = BODY_TO_HEADER(ObjectBody);
658 DPRINT("ObjectHeader->RefCount %lu\n",ObjectHeader->RefCount);
659 ObReferenceObjectByPointer(ObjectBody,
663 GrantedAccess = HandleRep->GrantedAccess;
664 KeReleaseSpinLock(&PsGetCurrentProcess()->HandleTable.ListLock,
667 ObjectHeader = BODY_TO_HEADER(ObjectBody);
668 DPRINT("ObjectHeader->RefCount %lu\n",ObjectHeader->RefCount);
670 if (ObjectType != NULL && ObjectType != ObjectHeader->ObjectType)
673 return(STATUS_OBJECT_TYPE_MISMATCH);
676 if (ObjectHeader->ObjectType == PsProcessType)
678 DPRINT("Reference from %x\n", ((PULONG)&Handle)[-1]);
681 if (AccessMode == UserMode)
683 RtlMapGenericMask(&DesiredAccess, ObjectHeader->ObjectType->Mapping);
685 if (!(GrantedAccess & DesiredAccess) &&
686 !((~GrantedAccess) & DesiredAccess))
689 return(STATUS_ACCESS_DENIED);
693 *Object = ObjectBody;
696 return(STATUS_SUCCESS);
699 /**********************************************************************
704 * Closes a handle reference to an object.
713 NTSTATUS STDCALL NtClose(HANDLE Handle)
716 POBJECT_HEADER Header;
718 assert_irql(PASSIVE_LEVEL);
720 DPRINT("NtClose(Handle %x)\n",Handle);
722 ObjectBody = ObDeleteHandle(PsGetCurrentProcess(), Handle);
723 if (ObjectBody == NULL)
725 return(STATUS_INVALID_HANDLE);
728 Header = BODY_TO_HEADER(ObjectBody);
730 DPRINT("Dereferencing %x\n", ObjectBody);
731 ObDereferenceObject(ObjectBody);
733 return(STATUS_SUCCESS);
739 ObInsertObject(PVOID Object,
740 PACCESS_STATE PassedAccessState,
741 ACCESS_MASK DesiredAccess,
742 ULONG AdditionalReferences,
743 PVOID* ReferencedObject,
746 return(ObCreateHandle(PsGetCurrentProcess(),
753 #endif /* LIBCAPTIVE */