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]));
109 ObDuplicateObject(PEPROCESS SourceProcess,
110 PEPROCESS TargetProcess,
112 PHANDLE TargetHandle,
113 ACCESS_MASK DesiredAccess,
114 BOOLEAN InheritHandle,
118 PHANDLE_REP SourceHandleRep;
121 KeAcquireSpinLock(&SourceProcess->HandleTable.ListLock, &oldIrql);
122 SourceHandleRep = ObpGetObjectByHandle(&SourceProcess->HandleTable,
124 if (SourceHandleRep == NULL)
126 KeReleaseSpinLock(&SourceProcess->HandleTable.ListLock, oldIrql);
127 return(STATUS_INVALID_HANDLE);
129 ObjectBody = SourceHandleRep->ObjectBody;
130 ObReferenceObjectByPointer(ObjectBody,
135 if (Options & DUPLICATE_SAME_ACCESS)
137 DesiredAccess = SourceHandleRep->GrantedAccess;
140 KeReleaseSpinLock(&SourceProcess->HandleTable.ListLock, oldIrql);
141 ObCreateHandle(TargetProcess,
147 if (Options & DUPLICATE_CLOSE_SOURCE)
149 ZwClose(SourceHandle);
152 ObDereferenceObject(ObjectBody);
153 return(STATUS_SUCCESS);
157 NtDuplicateObject (IN HANDLE SourceProcessHandle,
158 IN HANDLE SourceHandle,
159 IN HANDLE TargetProcessHandle,
160 OUT PHANDLE UnsafeTargetHandle,
161 IN ACCESS_MASK DesiredAccess,
162 IN BOOLEAN InheritHandle,
165 * FUNCTION: Copies a handle from one process space to another
167 * SourceProcessHandle = The source process owning the handle. The
168 * source process should have opened
169 * the SourceHandle with PROCESS_DUP_HANDLE
171 * SourceHandle = The handle to the object.
172 * TargetProcessHandle = The destination process owning the handle
173 * TargetHandle (OUT) = Caller should supply storage for the
175 * DesiredAccess = The desired access to the handle.
176 * InheritHandle = Indicates wheter the new handle will be inheritable
178 * Options = Specifies special actions upon duplicating the handle.
179 * Can be one of the values DUPLICATE_CLOSE_SOURCE |
180 * DUPLICATE_SAME_ACCESS. DUPLICATE_CLOSE_SOURCE specifies
181 * that the source handle should be closed after duplicating.
182 * DUPLICATE_SAME_ACCESS specifies to ignore the
183 * DesiredAccess paramter and just grant the same access to
186 * REMARKS: This function maps to the win32 DuplicateHandle.
189 PEPROCESS SourceProcess;
190 PEPROCESS TargetProcess;
191 PHANDLE_REP SourceHandleRep;
197 ASSERT_IRQL(PASSIVE_LEVEL);
199 Status = ObReferenceObjectByHandle(SourceProcessHandle,
203 (PVOID*)&SourceProcess,
205 if (!NT_SUCCESS(Status))
209 Status = ObReferenceObjectByHandle(TargetProcessHandle,
213 (PVOID*)&TargetProcess,
215 if (!NT_SUCCESS(Status))
217 ObDereferenceObject(SourceProcess);
220 KeAcquireSpinLock(&SourceProcess->HandleTable.ListLock, &oldIrql);
221 SourceHandleRep = ObpGetObjectByHandle(&SourceProcess->HandleTable,
223 if (SourceHandleRep == NULL)
225 KeReleaseSpinLock(&SourceProcess->HandleTable.ListLock, oldIrql);
226 ObDereferenceObject(SourceProcess);
227 ObDereferenceObject(TargetProcess);
228 return(STATUS_INVALID_HANDLE);
230 ObjectBody = SourceHandleRep->ObjectBody;
231 ObReferenceObjectByPointer(ObjectBody,
236 if (Options & DUPLICATE_SAME_ACCESS)
238 DesiredAccess = SourceHandleRep->GrantedAccess;
241 KeReleaseSpinLock(&SourceProcess->HandleTable.ListLock, oldIrql);
242 if (!SourceHandleRep->Inherit)
244 ObDereferenceObject(TargetProcess);
245 ObDereferenceObject(SourceProcess);
246 ObDereferenceObject(ObjectBody);
247 return STATUS_INVALID_HANDLE;
249 ObCreateHandle(TargetProcess,
255 if (Options & DUPLICATE_CLOSE_SOURCE)
257 ZwClose(SourceHandle);
260 ObDereferenceObject(TargetProcess);
261 ObDereferenceObject(SourceProcess);
262 ObDereferenceObject(ObjectBody);
264 Status = MmCopyToCaller(UnsafeTargetHandle, &TargetHandle, sizeof(HANDLE));
265 if (!NT_SUCCESS(Status))
270 return(STATUS_SUCCESS);
273 VOID ObCloseAllHandles(PEPROCESS Process)
276 PHANDLE_TABLE HandleTable;
277 PLIST_ENTRY current_entry;
278 PHANDLE_BLOCK current;
282 DPRINT("ObCloseAllHandles(Process %x)\n", Process);
284 HandleTable = &Process->HandleTable;
286 KeAcquireSpinLock(&HandleTable->ListLock, &oldIrql);
288 current_entry = HandleTable->ListHead.Flink;
290 while (current_entry != &HandleTable->ListHead)
292 current = CONTAINING_RECORD(current_entry, HANDLE_BLOCK, entry);
294 for (i = 0; i < HANDLE_BLOCK_ENTRIES; i++)
296 ObjectBody = current->handles[i].ObjectBody;
298 if (ObjectBody != NULL)
300 POBJECT_HEADER Header = BODY_TO_HEADER(ObjectBody);
302 if (Header->ObjectType == PsProcessType ||
303 Header->ObjectType == PsThreadType)
305 DPRINT("Deleting handle to %x\n", ObjectBody);
308 ObReferenceObjectByPointer(ObjectBody,
312 InterlockedDecrement(&Header->HandleCount);
313 current->handles[i].ObjectBody = NULL;
315 KeReleaseSpinLock(&HandleTable->ListLock, oldIrql);
318 if ((Header->ObjectType != NULL) &&
319 (Header->ObjectType->Close != NULL))
321 Header->ObjectType->Close(ObjectBody,
322 Header->HandleCount);
325 ObDereferenceObject(ObjectBody);
326 KeAttachProcess(Process);
327 KeAcquireSpinLock(&HandleTable->ListLock, &oldIrql);
328 current_entry = &HandleTable->ListHead;
333 current_entry = current_entry->Flink;
335 KeReleaseSpinLock(&HandleTable->ListLock, oldIrql);
336 DPRINT("ObCloseAllHandles() finished\n");
337 DPRINT("Type %x\n", BODY_TO_HEADER(Process)->ObjectType);
340 VOID ObDeleteHandleTable(PEPROCESS Process)
342 * FUNCTION: Deletes the handle table associated with a process
345 PLIST_ENTRY current = NULL;
346 PHANDLE_TABLE HandleTable = NULL;
348 ObCloseAllHandles(Process);
350 HandleTable = &Process->HandleTable;
351 current = RemoveHeadList(&HandleTable->ListHead);
353 while (current != &HandleTable->ListHead)
355 HANDLE_BLOCK* HandleBlock = CONTAINING_RECORD(current,
358 DPRINT("Freeing %x\n", HandleBlock);
359 ExFreePool(HandleBlock);
361 current = RemoveHeadList(&HandleTable->ListHead);
366 VOID ObCreateHandleTable(PEPROCESS Parent,
370 * FUNCTION: Creates a handle table for a process
372 * Parent = Parent process (or NULL if this is the first process)
373 * Inherit = True if the process should inherit its parent's handles
374 * Process = Process whose handle table is to be created
377 PHANDLE_TABLE ParentHandleTable, HandleTable;
379 PLIST_ENTRY parent_current;
381 PHANDLE_BLOCK current_block, new_block;
383 DPRINT("ObCreateHandleTable(Parent %x, Inherit %d, Process %x)\n",
384 Parent,Inherit,Process);
386 InitializeListHead(&(Process->HandleTable.ListHead));
387 KeInitializeSpinLock(&(Process->HandleTable.ListLock));
391 ParentHandleTable = &Parent->HandleTable;
392 HandleTable = &Process->HandleTable;
394 KeAcquireSpinLock(&Parent->HandleTable.ListLock, &oldIrql);
395 KeAcquireSpinLockAtDpcLevel(&Process->HandleTable.ListLock);
397 parent_current = ParentHandleTable->ListHead.Flink;
399 while (parent_current != &ParentHandleTable->ListHead)
401 current_block = CONTAINING_RECORD(parent_current,
404 new_block = ExAllocatePoolWithTag(NonPagedPool,
405 sizeof(HANDLE_BLOCK),
407 if (new_block == NULL)
411 RtlZeroMemory(new_block, sizeof(HANDLE_BLOCK));
413 for (i=0; i<HANDLE_BLOCK_ENTRIES; i++)
415 if (current_block->handles[i].ObjectBody)
417 if (current_block->handles[i].Inherit && Inherit)
419 new_block->handles[i].ObjectBody =
420 current_block->handles[i].ObjectBody;
421 new_block->handles[i].GrantedAccess =
422 current_block->handles[i].GrantedAccess;
423 new_block->handles[i].Inherit = TRUE;
424 InterlockedIncrement(&(BODY_TO_HEADER(current_block->handles[i].ObjectBody)->HandleCount));
428 InsertTailList(&Process->HandleTable.ListHead, &new_block->entry);
429 parent_current = parent_current->Flink;
431 KeReleaseSpinLockFromDpcLevel(&Process->HandleTable.ListLock);
432 KeReleaseSpinLock(&Parent->HandleTable.ListLock, oldIrql);
437 PVOID ObDeleteHandle(PEPROCESS Process, HANDLE Handle)
442 PHANDLE_TABLE HandleTable;
443 POBJECT_HEADER Header;
445 DPRINT("ObDeleteHandle(Handle %x)\n",Handle);
447 HandleTable = &Process->HandleTable;
449 KeAcquireSpinLock(&HandleTable->ListLock, &oldIrql);
451 Rep = ObpGetObjectByHandle(HandleTable, Handle);
454 KeReleaseSpinLock(&HandleTable->ListLock, oldIrql);
458 ObjectBody = Rep->ObjectBody;
459 DPRINT("ObjectBody %x\n", ObjectBody);
460 if (ObjectBody != NULL)
462 Header = BODY_TO_HEADER(ObjectBody);
463 InterlockedDecrement(&(BODY_TO_HEADER(ObjectBody)->HandleCount));
464 ObReferenceObjectByPointer(ObjectBody,
468 Rep->ObjectBody = NULL;
470 KeReleaseSpinLock(&HandleTable->ListLock, oldIrql);
472 if ((Header->ObjectType != NULL) &&
473 (Header->ObjectType->Close != NULL))
475 Header->ObjectType->Close(ObjectBody, Header->HandleCount);
480 KeReleaseSpinLock(&HandleTable->ListLock, oldIrql);
483 DPRINT("Finished ObDeleteHandle()\n");
488 NTSTATUS ObCreateHandle(PEPROCESS Process,
490 ACCESS_MASK GrantedAccess,
492 PHANDLE HandleReturn)
494 * FUNCTION: Add a handle referencing an object
496 * obj = Object body that the handle should refer to
497 * RETURNS: The created handle
498 * NOTE: The handle is valid only in the context of the current process
502 unsigned int handle=1;
504 HANDLE_BLOCK* new_blk = NULL;
505 PHANDLE_TABLE HandleTable;
508 DPRINT("ObCreateHandle(Process %x, obj %x)\n",Process,ObjectBody);
512 if (ObjectBody != NULL)
514 InterlockedIncrement(&(BODY_TO_HEADER(ObjectBody)->HandleCount));
516 HandleTable = &Process->HandleTable;
517 KeAcquireSpinLock(&HandleTable->ListLock, &oldlvl);
518 current = HandleTable->ListHead.Flink;
520 * Scan through the currently allocated handle blocks looking for a free
523 while (current != (&HandleTable->ListHead))
525 HANDLE_BLOCK* blk = CONTAINING_RECORD(current,HANDLE_BLOCK,entry);
527 DPRINT("Current %x\n",current);
529 for (i=0;i<HANDLE_BLOCK_ENTRIES;i++)
531 DPRINT("Considering slot %d containing %x\n",i,blk->handles[i]);
532 if (blk->handles[i].ObjectBody==NULL)
534 blk->handles[i].ObjectBody = ObjectBody;
535 blk->handles[i].GrantedAccess = GrantedAccess;
536 blk->handles[i].Inherit = Inherit;
537 KeReleaseSpinLock(&HandleTable->ListLock, oldlvl);
538 *HandleReturn = (HANDLE)((handle + i) << 2);
539 return(STATUS_SUCCESS);
543 handle = handle + HANDLE_BLOCK_ENTRIES;
544 current = current->Flink;
548 * Add a new handle block to the end of the list
551 (HANDLE_BLOCK *)ExAllocatePoolWithTag(NonPagedPool,sizeof(HANDLE_BLOCK),
555 *HandleReturn = (PHANDLE)NULL;
556 return(STATUS_INSUFFICIENT_RESOURCES);
558 RtlZeroMemory(new_blk,sizeof(HANDLE_BLOCK));
559 InsertTailList(&(Process->HandleTable.ListHead),
561 new_blk->handles[0].ObjectBody = ObjectBody;
562 new_blk->handles[0].GrantedAccess = GrantedAccess;
563 new_blk->handles[0].Inherit = Inherit;
564 KeReleaseSpinLock(&HandleTable->ListLock, oldlvl);
565 *HandleReturn = (HANDLE)(handle << 2);
566 return(STATUS_SUCCESS);
571 ObReferenceObjectByHandle(HANDLE Handle,
572 ACCESS_MASK DesiredAccess,
573 POBJECT_TYPE ObjectType,
574 KPROCESSOR_MODE AccessMode,
576 POBJECT_HANDLE_INFORMATION HandleInformationPtr)
578 * FUNCTION: Increments the reference count for an object and returns a
579 * pointer to its body
581 * Handle = Handle for the object
582 * DesiredAccess = Desired access to the object
585 * Object (OUT) = Points to the object body on return
586 * HandleInformation (OUT) = Contains information about the handle
591 PHANDLE_REP HandleRep;
592 POBJECT_HEADER ObjectHeader;
595 ACCESS_MASK GrantedAccess;
597 ASSERT_IRQL(PASSIVE_LEVEL);
599 DPRINT("ObReferenceObjectByHandle(Handle %x, DesiredAccess %x, "
600 "ObjectType %x, AccessMode %d, Object %x)\n",Handle,DesiredAccess,
601 ObjectType,AccessMode,Object);
605 * Handle special handle names
607 if (Handle == NtCurrentProcess() &&
608 (ObjectType == PsProcessType || ObjectType == NULL))
610 DPRINT("Reference from %x\n", ((PULONG)&Handle)[-1]);
612 ObReferenceObjectByPointer(PsGetCurrentProcess(),
616 *Object = PsGetCurrentProcess();
617 DPRINT("Referencing current process %x\n", PsGetCurrentProcess());
618 return(STATUS_SUCCESS);
620 else if (Handle == NtCurrentProcess())
623 return(STATUS_OBJECT_TYPE_MISMATCH);
625 if (Handle == NtCurrentThread() &&
626 (ObjectType == PsThreadType || ObjectType == NULL))
628 ObReferenceObjectByPointer(PsGetCurrentThread(),
632 *Object = PsGetCurrentThread();
634 return(STATUS_SUCCESS);
636 else if (Handle == NtCurrentThread())
639 return(STATUS_OBJECT_TYPE_MISMATCH);
642 KeAcquireSpinLock(&PsGetCurrentProcess()->HandleTable.ListLock,
644 HandleRep = ObpGetObjectByHandle(&PsGetCurrentProcess()->HandleTable,
646 if (HandleRep == NULL || HandleRep->ObjectBody == NULL)
648 KeReleaseSpinLock(&PsGetCurrentProcess()->HandleTable.ListLock,
650 return(STATUS_INVALID_HANDLE);
652 ObjectBody = HandleRep->ObjectBody;
653 DPRINT("ObjectBody %p\n",ObjectBody);
654 ObjectHeader = BODY_TO_HEADER(ObjectBody);
655 DPRINT("ObjectHeader->RefCount %lu\n",ObjectHeader->RefCount);
656 ObReferenceObjectByPointer(ObjectBody,
660 GrantedAccess = HandleRep->GrantedAccess;
661 KeReleaseSpinLock(&PsGetCurrentProcess()->HandleTable.ListLock,
664 ObjectHeader = BODY_TO_HEADER(ObjectBody);
665 DPRINT("ObjectHeader->RefCount %lu\n",ObjectHeader->RefCount);
667 if (ObjectType != NULL && ObjectType != ObjectHeader->ObjectType)
670 return(STATUS_OBJECT_TYPE_MISMATCH);
673 if (ObjectHeader->ObjectType == PsProcessType)
675 DPRINT("Reference from %x\n", ((PULONG)&Handle)[-1]);
678 if (AccessMode == UserMode)
680 RtlMapGenericMask(&DesiredAccess, ObjectHeader->ObjectType->Mapping);
682 if (!(GrantedAccess & DesiredAccess) &&
683 !((~GrantedAccess) & DesiredAccess))
686 return(STATUS_ACCESS_DENIED);
690 *Object = ObjectBody;
693 return(STATUS_SUCCESS);
697 /**********************************************************************
702 * Closes a handle reference to an object.
711 NTSTATUS STDCALL NtClose(HANDLE Handle)
714 POBJECT_HEADER Header;
716 assert_irql(PASSIVE_LEVEL);
718 DPRINT("NtClose(Handle %x)\n",Handle);
720 ObjectBody = ObDeleteHandle(PsGetCurrentProcess(), Handle);
721 if (ObjectBody == NULL)
723 return(STATUS_INVALID_HANDLE);
726 Header = BODY_TO_HEADER(ObjectBody);
728 DPRINT("Dereferencing %x\n", ObjectBody);
729 ObDereferenceObject(ObjectBody);
731 return(STATUS_SUCCESS);
735 ObInsertObject(PVOID Object,
736 PACCESS_STATE PassedAccessState,
737 ACCESS_MASK DesiredAccess,
738 ULONG AdditionalReferences,
739 PVOID* ReferencedObject,
742 return(ObCreateHandle(PsGetCurrentProcess(),