2 * PROJECT: ReactOS win32 kernel mode subsystem
3 * LICENSE: GPL - See COPYING in the top level directory
4 * FILE: subsystems/win32/win32k/objects/gdiobj.c
5 * PURPOSE: General GDI object manipulation routines
6 * PROGRAMMERS: Timo Kreuzer
10 * If you want to understand this code, you need to start thinking in portals.
11 * - gpaulRefCount is a global pointer to an allocated array of ULONG values,
12 * one for each handle. Bits 0 - 22 contain a reference count for the handle.
13 * It gets increased for each handle lock / reference. Bit 23 contains a valid
14 * bit. If this bit is 0, the handle got deleted and will be pushed to the free
15 * list, once all references are gone. Bits 24 - 31 contain the reuse value of
16 * the handle, which allows to check if the entry was changed before atomically
17 * exchanging the reference count.
18 * - Objects can exist with or without a handle
19 * - Objects with a handle can be locked either exclusively or shared.
20 * Both locks increase the handle reference count in gpaulRefCount.
21 * Exclusive locks also increase the BASEOBJECT's cExclusiveLock field
22 * and the first lock (can be acquired recursively) acquires a pushlock
23 * that is also stored in the BASEOBJECT.
24 * - Objects without a handle cannot have exclusive locks. Their reference
25 * count is tracked in the BASEOBJECT's ulShareCount field.
26 * - An object that is inserted in the handle table automatically has an
27 * exclusive lock. For objects that are "shared objects" (BRUSH, PALETTE, ...)
28 * this is the only way it can ever be exclusively locked. It prevents the
29 * object from being locked by another thread. A shared lock will simply fail,
30 * while an exclusive lock will succeed after the object was unlocked.
34 /* INCLUDES ******************************************************************/
42 #define DBG_INCREASE_LOCK_COUNT(pti, hobj) \
43 if (pti) ((PTHREADINFO)pti)->acExclusiveLockCount[((ULONG_PTR)hobj >> 16) & 0x1f]++;
44 #define DBG_DECREASE_LOCK_COUNT(pti, hobj) \
45 if (pti) ((PTHREADINFO)pti)->acExclusiveLockCount[((ULONG_PTR)hobj >> 16) & 0x1f]--;
46 #define ASSERT_SHARED_OBJECT_TYPE(objt) \
47 ASSERT((objt) == GDIObjType_SURF_TYPE || \
48 (objt) == GDIObjType_PAL_TYPE || \
49 (objt) == GDIObjType_LFONT_TYPE || \
50 (objt) == GDIObjType_PATH_TYPE || \
51 (objt) == GDIObjType_BRUSH_TYPE)
52 #define ASSERT_EXCLUSIVE_OBJECT_TYPE(objt) \
53 ASSERT((objt) == GDIObjType_DC_TYPE || \
54 (objt) == GDIObjType_RGN_TYPE)
56 #define DBG_INCREASE_LOCK_COUNT(ppi, hobj)
57 #define DBG_DECREASE_LOCK_COUNT(x, y)
58 #define ASSERT_SHARED_OBJECT_TYPE(objt)
59 #define ASSERT_EXCLUSIVE_OBJECT_TYPE(objt)
62 #if defined(_M_IX86) || defined(_M_AMD64)
63 #define InterlockedOr16 _InterlockedOr16
66 #define GDIOBJ_POOL_TAG(type) ('00hG' + (((type) & 0x1f) << 24))
70 REF_MASK_REUSE
= 0xff000000,
71 REF_INC_REUSE
= 0x01000000,
72 REF_MASK_VALID
= 0x00800000,
73 REF_MASK_COUNT
= 0x007fffff,
74 REF_MASK_INUSE
= 0x00ffffff,
77 /* GLOBALS *******************************************************************/
79 /* Per session handle table globals */
80 static PVOID gpvGdiHdlTblSection
= NULL
;
85 static PPAGED_LOOKASIDE_LIST gpaLookasideList
;
87 static BOOL NTAPI
GDIOBJ_Cleanup(PVOID ObjectBody
);
93 NULL
, /* 00 GDIObjType_DEF_TYPE */
94 DC_Cleanup
, /* 01 GDIObjType_DC_TYPE */
95 NULL
, /* 02 GDIObjType_UNUSED1_TYPE */
96 NULL
, /* 03 GDIObjType_UNUSED2_TYPE */
97 REGION_Cleanup
, /* 04 GDIObjType_RGN_TYPE */
98 SURFACE_Cleanup
, /* 05 GDIObjType_SURF_TYPE */
99 GDIOBJ_Cleanup
, /* 06 GDIObjType_CLIENTOBJ_TYPE */
100 GDIOBJ_Cleanup
, /* 07 GDIObjType_PATH_TYPE */
101 PALETTE_Cleanup
, /* 08 GDIObjType_PAL_TYPE */
102 GDIOBJ_Cleanup
, /* 09 GDIObjType_ICMLCS_TYPE */
103 GDIOBJ_Cleanup
, /* 0a GDIObjType_LFONT_TYPE */
104 NULL
, /* 0b GDIObjType_RFONT_TYPE, unused */
105 NULL
, /* 0c GDIObjType_PFE_TYPE, unused */
106 NULL
, /* 0d GDIObjType_PFT_TYPE, unused */
107 GDIOBJ_Cleanup
, /* 0e GDIObjType_ICMCXF_TYPE */
108 NULL
, /* 0f GDIObjType_SPRITE_TYPE, unused */
109 BRUSH_Cleanup
, /* 10 GDIObjType_BRUSH_TYPE, BRUSH, PEN, EXTPEN */
110 NULL
, /* 11 GDIObjType_UMPD_TYPE, unused */
111 NULL
, /* 12 GDIObjType_UNUSED4_TYPE */
112 NULL
, /* 13 GDIObjType_SPACE_TYPE, unused */
113 NULL
, /* 14 GDIObjType_UNUSED5_TYPE */
114 NULL
, /* 15 GDIObjType_META_TYPE, unused */
115 NULL
, /* 16 GDIObjType_EFSTATE_TYPE, unused */
116 NULL
, /* 17 GDIObjType_BMFD_TYPE, unused */
117 NULL
, /* 18 GDIObjType_VTFD_TYPE, unused */
118 NULL
, /* 19 GDIObjType_TTFD_TYPE, unused */
119 NULL
, /* 1a GDIObjType_RC_TYPE, unused */
120 NULL
, /* 1b GDIObjType_TEMP_TYPE, unused */
121 DRIVEROBJ_Cleanup
,/* 1c GDIObjType_DRVOBJ_TYPE */
122 NULL
, /* 1d GDIObjType_DCIOBJ_TYPE, unused */
123 NULL
, /* 1e GDIObjType_SPOOL_TYPE, unused */
124 NULL
, /* 1f reserved entry */
127 /* INTERNAL FUNCTIONS ********************************************************/
131 GDIOBJ_Cleanup(PVOID ObjectBody
)
138 InitLookasideList(UCHAR objt
, ULONG cjSize
)
140 ExInitializePagedLookasideList(&gpaLookasideList
[objt
],
145 GDITAG_HMGR_LOOKASIDE_START
+ (objt
<< 24),
152 InitGdiHandleTable(void)
155 LARGE_INTEGER liSize
;
157 SIZE_T cjViewSize
= 0;
159 /* Create a section for the shared handle table */
160 liSize
.QuadPart
= sizeof(GDI_HANDLE_TABLE
); // GDI_HANDLE_COUNT * sizeof(ENTRY);
161 status
= MmCreateSection(&gpvGdiHdlTblSection
,
169 if (!NT_SUCCESS(status
))
171 DPRINT1("INITGDI: Could not allocate a GDI handle table.\n");
175 /* Map the section in session space */
176 status
= MmMapViewInSessionSpace(gpvGdiHdlTblSection
,
179 if (!NT_SUCCESS(status
))
181 DPRINT1("INITGDI: Failed to map handle table section\n");
182 ObDereferenceObject(gpvGdiHdlTblSection
);
186 /* Allocate memory for the reference counter table */
187 gpaulRefCount
= EngAllocSectionMem(&pvSection
,
189 GDI_HANDLE_COUNT
* sizeof(ULONG
),
193 DPRINT1("INITGDI: Failed to allocate reference table.\n");
194 ObDereferenceObject(gpvGdiHdlTblSection
);
195 return STATUS_INSUFFICIENT_RESOURCES
;
199 gulFirstUnused
= RESERVE_ENTRIES_COUNT
;
201 GdiHandleTable
= (PVOID
)gpentHmgr
;
203 /* Initialize the lookaside lists */
204 gpaLookasideList
= ExAllocatePoolWithTag(NonPagedPool
,
205 GDIObjTypeTotal
* sizeof(PAGED_LOOKASIDE_LIST
),
207 if(!gpaLookasideList
)
208 return STATUS_NO_MEMORY
;
210 InitLookasideList(GDIObjType_DC_TYPE
, sizeof(DC
));
211 InitLookasideList(GDIObjType_RGN_TYPE
, sizeof(REGION
));
212 InitLookasideList(GDIObjType_SURF_TYPE
, sizeof(SURFACE
));
213 InitLookasideList(GDIObjType_CLIENTOBJ_TYPE
, sizeof(CLIENTOBJ
));
214 InitLookasideList(GDIObjType_PATH_TYPE
, sizeof(PATH
));
215 InitLookasideList(GDIObjType_PAL_TYPE
, sizeof(PALETTE
));
216 InitLookasideList(GDIObjType_ICMLCS_TYPE
, sizeof(COLORSPACE
));
217 InitLookasideList(GDIObjType_LFONT_TYPE
, sizeof(TEXTOBJ
));
218 InitLookasideList(GDIObjType_BRUSH_TYPE
, sizeof(BRUSH
));
220 return STATUS_SUCCESS
;
225 IncrementCurrentProcessGdiHandleCount(void)
227 PPROCESSINFO ppi
= PsGetCurrentProcessWin32Process();
228 if (ppi
) InterlockedIncrement((LONG
*)&ppi
->GDIHandleCount
);
233 DecrementCurrentProcessGdiHandleCount(void)
235 PPROCESSINFO ppi
= PsGetCurrentProcessWin32Process();
236 if (ppi
) InterlockedDecrement((LONG
*)&ppi
->GDIHandleCount
);
241 IncrementGdiHandleCount(ULONG ulProcessId
)
247 Status
= PsLookupProcessByProcessId(ULongToHandle(ulProcessId
), &pep
);
248 NT_ASSERT(NT_SUCCESS(Status
));
250 ppi
= PsGetProcessWin32Process(pep
);
251 if (ppi
) InterlockedIncrement((LONG
*)&ppi
->GDIHandleCount
);
252 if (NT_SUCCESS(Status
)) ObDereferenceObject(pep
);
257 DecrementGdiHandleCount(ULONG ulProcessId
)
263 Status
= PsLookupProcessByProcessId(ULongToHandle(ulProcessId
), &pep
);
264 NT_ASSERT(NT_SUCCESS(Status
));
266 ppi
= PsGetProcessWin32Process(pep
);
267 if (ppi
) InterlockedDecrement((LONG
*)&ppi
->GDIHandleCount
);
268 if (NT_SUCCESS(Status
)) ObDereferenceObject(pep
);
273 ENTRY_pentPopFreeEntry(VOID
)
275 ULONG iFirst
, iNext
, iPrev
;
278 DPRINT("Enter InterLockedPopFreeEntry\n");
282 /* Get the index and sequence number of the first free entry */
283 iFirst
= gulFirstFree
;
285 /* Check if we have a free entry */
286 if (!(iFirst
& GDI_HANDLE_INDEX_MASK
))
288 /* Increment FirstUnused and get the new index */
289 iFirst
= InterlockedIncrement((LONG
*)&gulFirstUnused
) - 1;
291 /* Check if we have unused entries left */
292 if (iFirst
>= GDI_HANDLE_COUNT
)
294 DPRINT1("No more GDI handles left!\n");
298 /* Return the old entry */
299 return &gpentHmgr
[iFirst
];
302 /* Get a pointer to the first free entry */
303 pentFree
= &gpentHmgr
[iFirst
& GDI_HANDLE_INDEX_MASK
];
305 /* Create a new value with an increased sequence number */
306 iNext
= (USHORT
)(ULONG_PTR
)pentFree
->einfo
.pobj
;
307 iNext
|= (iFirst
& ~GDI_HANDLE_INDEX_MASK
) + 0x10000;
309 /* Try to exchange the FirstFree value */
310 iPrev
= InterlockedCompareExchange((LONG
*)&gulFirstFree
,
314 while (iPrev
!= iFirst
);
316 /* Sanity check: is entry really free? */
317 ASSERT(((ULONG_PTR
)pentFree
->einfo
.pobj
& ~GDI_HANDLE_INDEX_MASK
) == 0);
322 /* Pushes an entry of the handle table to the free list,
323 The entry must not have any references left */
326 ENTRY_vPushFreeEntry(PENTRY pentFree
)
328 ULONG iToFree
, iFirst
, iPrev
, idxToFree
;
330 DPRINT("Enter ENTRY_vPushFreeEntry\n");
332 idxToFree
= pentFree
- gpentHmgr
;
333 ASSERT((gpaulRefCount
[idxToFree
] & REF_MASK_INUSE
) == 0);
335 /* Initialize entry */
336 pentFree
->Objt
= GDIObjType_DEF_TYPE
;
337 pentFree
->ObjectOwner
.ulObj
= 0;
338 pentFree
->pUser
= NULL
;
340 /* Increase reuse counter in entry and reference counter */
341 InterlockedExchangeAdd((LONG
*)&gpaulRefCount
[idxToFree
], REF_INC_REUSE
);
342 pentFree
->FullUnique
+= 0x0100;
346 /* Get the current first free index and sequence number */
347 iFirst
= gulFirstFree
;
349 /* Set the einfo.pobj member to the index of the first free entry */
350 pentFree
->einfo
.pobj
= UlongToPtr(iFirst
& GDI_HANDLE_INDEX_MASK
);
352 /* Combine new index and increased sequence number in iToFree */
353 iToFree
= idxToFree
| ((iFirst
& ~GDI_HANDLE_INDEX_MASK
) + 0x10000);
355 /* Try to atomically update the first free entry */
356 iPrev
= InterlockedCompareExchange((LONG
*)&gulFirstFree
,
360 while (iPrev
!= iFirst
);
365 ENTRY_ReferenceEntryByHandle(HGDIOBJ hobj
, FLONG fl
)
367 ULONG ulIndex
, cNewRefs
, cOldRefs
;
370 /* Get the handle index and check if its too big */
371 ulIndex
= GDI_HANDLE_GET_INDEX(hobj
);
372 if (ulIndex
>= GDI_HANDLE_COUNT
) return NULL
;
374 /* Get pointer to the entry */
375 pentry
= &gpentHmgr
[ulIndex
];
377 /* Get the current reference count */
378 cOldRefs
= gpaulRefCount
[ulIndex
];
382 /* Check if the slot is deleted */
383 if ((cOldRefs
& REF_MASK_VALID
) == 0)
385 DPRINT("GDIOBJ: Slot is not valid: 0x%lx, hobh=%p\n", cOldRefs
, hobj
);
389 /* Check if the unique value matches */
390 if (pentry
->FullUnique
!= (USHORT
)((ULONG_PTR
)hobj
>> 16))
392 DPRINT("GDIOBJ: Wrong unique value. Handle: 0x%4x, entry: 0x%4x\n",
393 (USHORT
)((ULONG_PTR
)hobj
>> 16), pentry
->FullUnique
);
397 /* Check if the object owner is this process or public */
398 if (!(fl
& GDIOBJFLAG_IGNOREPID
) &&
399 pentry
->ObjectOwner
.ulObj
!= GDI_OBJ_HMGR_PUBLIC
&&
400 pentry
->ObjectOwner
.ulObj
!= PtrToUlong(PsGetCurrentProcessId()))
402 DPRINT("GDIOBJ: Cannot reference foreign handle %p, pentry=%p:%lx.\n",
403 hobj
, pentry
, pentry
->ObjectOwner
.ulObj
);
407 /* Try to atomically increment the reference count */
408 cNewRefs
= cOldRefs
+ 1;
409 cOldRefs
= InterlockedCompareExchange((PLONG
)&gpaulRefCount
[ulIndex
],
413 while (cNewRefs
!= cOldRefs
+ 1);
415 /* Integrity checks */
416 ASSERT((pentry
->FullUnique
& 0x1f) == pentry
->Objt
);
417 ASSERT(pentry
->einfo
.pobj
&& pentry
->einfo
.pobj
->hHmgr
== hobj
);
424 ENTRY_hInsertObject(PENTRY pentry
, POBJ pobj
, UCHAR objt
, ULONG ulOwner
)
428 /* Calculate the handle index */
429 ulIndex
= pentry
- gpentHmgr
;
431 /* Update the fields in the ENTRY */
432 pentry
->einfo
.pobj
= pobj
;
433 pentry
->Objt
= objt
& 0x1f;
434 pentry
->FullUnique
= (pentry
->FullUnique
& 0xff00) | objt
;
435 pentry
->ObjectOwner
.ulObj
= ulOwner
;
437 /* Make the handle valid with 1 reference */
438 ASSERT((gpaulRefCount
[ulIndex
] & REF_MASK_INUSE
) == 0);
439 InterlockedOr((LONG
*)&gpaulRefCount
[ulIndex
], REF_MASK_VALID
| 1);
441 /* Return the handle */
442 return (HGDIOBJ
)(((ULONG_PTR
)pentry
->FullUnique
<< 16) | ulIndex
);
447 GDIOBJ_AllocateObject(UCHAR objt
, ULONG cjSize
, FLONG fl
)
451 if (fl
& BASEFLAG_LOOKASIDE
)
453 /* Allocate the object from a lookaside list */
454 pobj
= ExAllocateFromPagedLookasideList(&gpaLookasideList
[objt
& 0x1f]);
458 /* Allocate the object from paged pool */
459 pobj
= ExAllocatePoolWithTag(PagedPool
, cjSize
, GDIOBJ_POOL_TAG(objt
));
462 if (!pobj
) return NULL
;
464 /* Initialize the object */
465 RtlZeroMemory(pobj
, cjSize
);
466 pobj
->hHmgr
= (HGDIOBJ
)((ULONG_PTR
)objt
<< 16);
467 pobj
->cExclusiveLock
= 0;
468 pobj
->ulShareCount
= 1;
469 pobj
->BaseFlags
= fl
& 0xffff;
470 DBG_INITLOG(&pobj
->slhLog
);
471 DBG_LOGEVENT(&pobj
->slhLog
, EVENT_ALLOCATE
, 0);
478 GDIOBJ_vFreeObject(POBJ pobj
)
482 DBG_CLEANUP_EVENT_LIST(&pobj
->slhLog
);
484 /* Get the object type */
485 objt
= ((ULONG_PTR
)pobj
->hHmgr
>> 16) & 0x1f;
487 /* Call the cleanup procedure */
488 ASSERT(apfnCleanup
[objt
]);
489 apfnCleanup
[objt
](pobj
);
491 /* Check if the object is allocated from a lookaside list */
492 if (pobj
->BaseFlags
& BASEFLAG_LOOKASIDE
)
494 ExFreeToPagedLookasideList(&gpaLookasideList
[objt
], pobj
);
498 ExFreePoolWithTag(pobj
, GDIOBJ_POOL_TAG(objt
));
504 GDIOBJ_vDereferenceObject(POBJ pobj
)
506 ULONG cRefs
, ulIndex
;
508 /* Calculate the index */
509 ulIndex
= GDI_HANDLE_GET_INDEX(pobj
->hHmgr
);
511 /* Check if the object has a handle */
514 /* Decrement reference count */
515 ASSERT((gpaulRefCount
[ulIndex
] & REF_MASK_COUNT
) > 0);
516 cRefs
= InterlockedDecrement((LONG
*)&gpaulRefCount
[ulIndex
]);
517 DBG_LOGEVENT(&pobj
->slhLog
, EVENT_DEREFERENCE
, cRefs
);
519 /* Check if we reached 0 and handle bit is not set */
520 if ((cRefs
& REF_MASK_INUSE
) == 0)
522 /* Make sure it's ok to delete the object */
523 ASSERT(pobj
->BaseFlags
& BASEFLAG_READY_TO_DIE
);
525 /* Check if the handle was process owned */
526 if (gpentHmgr
[ulIndex
].ObjectOwner
.ulObj
!= GDI_OBJ_HMGR_PUBLIC
&&
527 gpentHmgr
[ulIndex
].ObjectOwner
.ulObj
!= GDI_OBJ_HMGR_NONE
)
529 /* Decrement the process handle count */
530 ASSERT(gpentHmgr
[ulIndex
].ObjectOwner
.ulObj
==
531 HandleToUlong(PsGetCurrentProcessId()));
532 DecrementCurrentProcessGdiHandleCount();
535 /* Push entry to the free list */
536 ENTRY_vPushFreeEntry(&gpentHmgr
[ulIndex
]);
538 /* Free the object */
539 GDIOBJ_vFreeObject(pobj
);
544 /* Decrement the objects reference count */
545 ASSERT(pobj
->ulShareCount
> 0);
546 cRefs
= InterlockedDecrement((LONG
*)&pobj
->ulShareCount
);
547 DBG_LOGEVENT(&pobj
->slhLog
, EVENT_DEREFERENCE
, cRefs
);
549 /* Check if we reached 0 */
552 /* Free the object */
553 GDIOBJ_vFreeObject(pobj
);
560 GDIOBJ_ReferenceObjectByHandle(
567 /* Check if the handle type matches */
568 ASSERT_SHARED_OBJECT_TYPE(objt
);
569 if ((((ULONG_PTR
)hobj
>> 16) & 0x1f) != objt
)
571 DPRINT("GDIOBJ: Wrong type. handle=%p, type=%x\n", hobj
, objt
);
575 /* Reference the handle entry */
576 pentry
= ENTRY_ReferenceEntryByHandle(hobj
, 0);
579 DPRINT("GDIOBJ: Requested handle 0x%p is not valid.\n", hobj
);
583 /* Get the pointer to the BASEOBJECT */
584 pobj
= pentry
->einfo
.pobj
;
586 /* Check if the object is exclusively locked */
587 if (pobj
->cExclusiveLock
!= 0)
589 DPRINT1("GDIOBJ: Cannot reference oject %p with exclusive lock.\n", hobj
);
590 GDIOBJ_vDereferenceObject(pobj
);
591 DBG_DUMP_EVENT_LIST(&pobj
->slhLog
);
595 DBG_LOGEVENT(&pobj
->slhLog
, EVENT_REFERENCE
, gpaulRefCount
[pentry
- gpentHmgr
]);
597 /* All is well, return the object */
603 GDIOBJ_vReferenceObjectByPointer(POBJ pobj
)
607 /* Check if the object has a handle */
608 if (GDI_HANDLE_GET_INDEX(pobj
->hHmgr
))
610 /* Increase the handle's reference count */
611 ULONG ulIndex
= GDI_HANDLE_GET_INDEX(pobj
->hHmgr
);
612 ASSERT((gpaulRefCount
[ulIndex
] & REF_MASK_COUNT
) > 0);
613 cRefs
= InterlockedIncrement((LONG
*)&gpaulRefCount
[ulIndex
]);
617 /* Increase the object's reference count */
618 cRefs
= InterlockedIncrement((LONG
*)&pobj
->ulShareCount
);
621 DBG_LOGEVENT(&pobj
->slhLog
, EVENT_REFERENCE
, cRefs
);
634 /* Check if the handle type matches */
635 ASSERT_EXCLUSIVE_OBJECT_TYPE(objt
);
636 if ((((ULONG_PTR
)hobj
>> 16) & 0x1f) != objt
)
638 DPRINT("Wrong object type: hobj=0x%p, objt=0x%x\n", hobj
, objt
);
642 /* Reference the handle entry */
643 pentry
= ENTRY_ReferenceEntryByHandle(hobj
, 0);
646 DPRINT("GDIOBJ: Requested handle 0x%p is not valid.\n", hobj
);
650 /* Get the pointer to the BASEOBJECT */
651 pobj
= pentry
->einfo
.pobj
;
653 /* Check if we already own the lock */
654 dwThreadId
= PtrToUlong(PsGetCurrentThreadId());
655 if (pobj
->dwThreadId
!= dwThreadId
)
657 /* Disable APCs and acquire the push lock */
658 KeEnterCriticalRegion();
659 ExAcquirePushLockExclusive(&pobj
->pushlock
);
661 /* Set us as lock owner */
662 ASSERT(pobj
->dwThreadId
== 0);
663 pobj
->dwThreadId
= dwThreadId
;
666 /* Increase lock count */
667 pobj
->cExclusiveLock
++;
668 DBG_INCREASE_LOCK_COUNT(PsGetCurrentProcessWin32Process(), hobj
);
669 DBG_LOGEVENT(&pobj
->slhLog
, EVENT_LOCK
, 0);
671 /* Return the object */
677 GDIOBJ_vUnlockObject(POBJ pobj
)
679 ULONG cRefs
, ulIndex
;
680 ASSERT(pobj
->cExclusiveLock
> 0);
682 /* Decrease lock count */
683 pobj
->cExclusiveLock
--;
684 DBG_DECREASE_LOCK_COUNT(PsGetCurrentProcessWin32Process(), pobj
->hHmgr
);
685 DBG_LOGEVENT(&pobj
->slhLog
, EVENT_UNLOCK
, 0);
687 /* Check if this was the last lock */
688 if (pobj
->cExclusiveLock
== 0)
690 /* Reset lock owner */
691 pobj
->dwThreadId
= 0;
693 /* Release the pushlock and reenable APCs */
694 ExReleasePushLockExclusive(&pobj
->pushlock
);
695 KeLeaveCriticalRegion();
698 /* Calculate the index */
699 ulIndex
= GDI_HANDLE_GET_INDEX(pobj
->hHmgr
);
701 /* Decrement reference count */
702 ASSERT((gpaulRefCount
[ulIndex
] & REF_MASK_COUNT
) > 0);
703 cRefs
= InterlockedDecrement((LONG
*)&gpaulRefCount
[ulIndex
]);
704 ASSERT(cRefs
& REF_MASK_VALID
);
709 GDIOBJ_hInsertObject(
716 /* Must have no handle and only one reference */
717 ASSERT(GDI_HANDLE_GET_INDEX(pobj
->hHmgr
) == 0);
718 ASSERT(pobj
->cExclusiveLock
== 0);
719 ASSERT(pobj
->ulShareCount
== 1);
721 /* Get a free handle entry */
722 pentry
= ENTRY_pentPopFreeEntry();
725 DPRINT1("GDIOBJ: Could not get a free entry.\n");
729 /* Make the object exclusively locked */
730 ExInitializePushLock(&pobj
->pushlock
);
731 KeEnterCriticalRegion();
732 ExAcquirePushLockExclusive(&pobj
->pushlock
);
733 pobj
->cExclusiveLock
= 1;
734 pobj
->dwThreadId
= PtrToUlong(PsGetCurrentThreadId());
735 DBG_INCREASE_LOCK_COUNT(PsGetCurrentProcessWin32Process(), pobj
->hHmgr
);
737 /* Get object type from the hHmgr field */
738 objt
= ((ULONG_PTR
)pobj
->hHmgr
>> 16) & 0xff;
739 ASSERT(objt
!= GDIObjType_DEF_TYPE
);
741 /* Check if current process is requested owner */
742 if (ulOwner
== GDI_OBJ_HMGR_POWNED
)
744 /* Increment the process handle count */
745 IncrementCurrentProcessGdiHandleCount();
748 ulOwner
= HandleToUlong(PsGetCurrentProcessId());
751 /* Insert the object into the handle table */
752 pobj
->hHmgr
= ENTRY_hInsertObject(pentry
, pobj
, objt
, ulOwner
);
754 /* Return the handle */
755 DPRINT("GDIOBJ: Created handle: %p\n", pobj
->hHmgr
);
756 DBG_LOGEVENT(&pobj
->slhLog
, EVENT_CREATE_HANDLE
, 0);
762 GDIOBJ_vSetObjectOwner(
769 /* This is a ugly HACK, needed to fix IntGdiSetDCOwnerEx */
770 if (GDI_HANDLE_IS_STOCKOBJ(pobj
->hHmgr
))
772 DPRINT("Trying to set ownership of stock object %p to %lx\n", pobj
->hHmgr
, ulNewOwner
);
776 /* Get the handle entry */
777 NT_ASSERT(GDI_HANDLE_GET_INDEX(pobj
->hHmgr
));
778 pentry
= &gpentHmgr
[GDI_HANDLE_GET_INDEX(pobj
->hHmgr
)];
780 /* Check if the new owner is the same as the old one */
781 ulOldOwner
= pentry
->ObjectOwner
.ulObj
;
782 if (ulOldOwner
== ulNewOwner
)
788 /* Is the current process requested? */
789 if (ulNewOwner
== GDI_OBJ_HMGR_POWNED
)
792 ulNewOwner
= HandleToUlong(PsGetCurrentProcessId());
796 if (ulNewOwner
== GDI_OBJ_HMGR_NONE
)
797 ulNewOwner
= GDI_OBJ_HMGR_PUBLIC
;
799 /* Was the object process owned? */
800 if ((ulOldOwner
!= GDI_OBJ_HMGR_PUBLIC
) &&
801 (ulOldOwner
!= GDI_OBJ_HMGR_NONE
))
803 /* Decrement the previous owners handle count */
804 DecrementGdiHandleCount(ulOldOwner
);
807 /* Is the new owner a process? */
808 if ((ulNewOwner
!= GDI_OBJ_HMGR_PUBLIC
) &&
809 (ulNewOwner
!= GDI_OBJ_HMGR_NONE
))
811 /* Increment the new owners handle count */
812 IncrementGdiHandleCount(ulNewOwner
);
816 /* Make sure we don't leak user mode memory */
817 NT_ASSERT(pentry
->pUser
== NULL
);
821 pentry
->ObjectOwner
.ulObj
= ulNewOwner
;
822 DBG_LOGEVENT(&pobj
->slhLog
, EVENT_SET_OWNER
, 0);
825 /* Locks 2 or 3 objects at a time */
828 GDIOBJ_bLockMultipleObjects(
834 UINT auiIndices
[3] = {0, 1, 2};
837 ASSERT(ulCount
<= 3);
839 /* Sort the handles */
840 for (i
= 0; i
< ulCount
- 1; i
++)
842 for (j
= i
+ 1; j
< ulCount
; j
++)
844 if ((ULONG_PTR
)ahObj
[auiIndices
[i
]] <
845 (ULONG_PTR
)ahObj
[auiIndices
[j
]])
848 auiIndices
[i
] = auiIndices
[j
];
854 /* Lock the objects in safe order */
855 for (i
= 0; i
< ulCount
; i
++)
857 /* Skip NULL handles */
858 if (ahObj
[auiIndices
[i
]] == NULL
)
860 apObj
[auiIndices
[i
]] = NULL
;
864 /* Lock the object */
865 apObj
[auiIndices
[i
]] = GDIOBJ_LockObject(ahObj
[auiIndices
[i
]], objt
);
867 /* Check for failure */
868 if (apObj
[auiIndices
[i
]] == NULL
)
873 if (apObj
[auiIndices
[i
]])
874 GDIOBJ_vUnlockObject(apObj
[auiIndices
[i
]]);
885 GDIOBJ_pvGetObjectAttr(POBJ pobj
)
887 ULONG ulIndex
= GDI_HANDLE_GET_INDEX(pobj
->hHmgr
);
888 return gpentHmgr
[ulIndex
].pUser
;
893 GDIOBJ_vSetObjectAttr(POBJ pobj
, PVOID pvObjAttr
)
899 /* Get the handle index */
900 ulIndex
= GDI_HANDLE_GET_INDEX(pobj
->hHmgr
);
902 /* Set pointer to the usermode attribute */
903 gpentHmgr
[ulIndex
].pUser
= pvObjAttr
;
908 GDIOBJ_vDeleteObject(POBJ pobj
)
912 /* Set the object's delete flag */
913 InterlockedOr16((SHORT
*)&pobj
->BaseFlags
, BASEFLAG_READY_TO_DIE
);
914 DBG_LOGEVENT(&pobj
->slhLog
, EVENT_DELETE
, 0);
916 /* Get the handle index */
917 ulIndex
= GDI_HANDLE_GET_INDEX(pobj
->hHmgr
);
920 /* Reset the handle valid bit */
921 InterlockedAnd((LONG
*)&gpaulRefCount
[ulIndex
], ~REF_MASK_VALID
);
923 /* Check if the object is exclusively locked */
924 if (pobj
->cExclusiveLock
!= 0)
926 /* Reset lock owner and lock count */
927 pobj
->dwThreadId
= 0;
928 pobj
->cExclusiveLock
= 0;
930 /* Release the pushlock and reenable APCs */
931 ExReleasePushLockExclusive(&pobj
->pushlock
);
932 KeLeaveCriticalRegion();
933 DBG_DECREASE_LOCK_COUNT(PsGetCurrentProcessWin32Process(), pobj
->hHmgr
);
937 /* Dereference the object (will take care of deletion) */
938 GDIOBJ_vDereferenceObject(pobj
);
943 GreIsHandleValid(HGDIOBJ hobj
)
947 pentry
= ENTRY_ReferenceEntryByHandle(hobj
, 0);
948 if (!pentry
) return FALSE
;
949 GDIOBJ_vDereferenceObject(pentry
->einfo
.pobj
);
955 GreDeleteObject(HGDIOBJ hobj
)
959 /* Check for stock objects */
960 if (GDI_HANDLE_IS_STOCKOBJ(hobj
))
962 DPRINT1("GreDeleteObject: Cannot delete stock object %p.\n", hobj
);
966 /* Reference the handle entry */
967 pentry
= ENTRY_ReferenceEntryByHandle(hobj
, 0);
970 DPRINT1("GreDeleteObject: Trying to delete invalid object %p\n", hobj
);
974 /* Check for public owner */
975 if (pentry
->ObjectOwner
.ulObj
== GDI_OBJ_HMGR_PUBLIC
)
977 DPRINT1("GreDeleteObject: Trying to delete global object %p\n", hobj
);
978 GDIOBJ_vDereferenceObject(pentry
->einfo
.pobj
);
982 /* Delete the object */
983 GDIOBJ_vDeleteObject(pentry
->einfo
.pobj
);
989 GreGetObjectOwner(HGDIOBJ hobj
)
991 ULONG ulIndex
, ulOwner
;
993 /* Get the handle index */
994 ulIndex
= GDI_HANDLE_GET_INDEX(hobj
);
996 /* Check if the handle is valid */
997 if (ulIndex
>= GDI_HANDLE_COUNT
||
998 gpentHmgr
[ulIndex
].Objt
== GDIObjType_DEF_TYPE
||
999 ((ULONG_PTR
)hobj
>> 16) != gpentHmgr
[ulIndex
].FullUnique
)
1001 DPRINT1("GreGetObjectOwner: invalid handle 0x%p.\n", hobj
);
1002 return GDI_OBJ_HMGR_RESTRICTED
;
1005 /* Get the object owner */
1006 ulOwner
= gpentHmgr
[ulIndex
].ObjectOwner
.ulObj
;
1008 if (ulOwner
== HandleToUlong(PsGetCurrentProcessId()))
1009 return GDI_OBJ_HMGR_POWNED
;
1011 if (ulOwner
== GDI_OBJ_HMGR_PUBLIC
)
1012 return GDI_OBJ_HMGR_PUBLIC
;
1014 return GDI_OBJ_HMGR_RESTRICTED
;
1019 GreSetObjectOwnerEx(
1026 /* Check for stock objects */
1027 if (GDI_HANDLE_IS_STOCKOBJ(hobj
))
1029 DPRINT("GreSetObjectOwner: Got stock object %p\n", hobj
);
1033 /* Reference the handle entry */
1034 pentry
= ENTRY_ReferenceEntryByHandle(hobj
, Flags
);
1037 DPRINT("GreSetObjectOwner: Invalid handle 0x%p.\n", hobj
);
1041 /* Call internal function */
1042 GDIOBJ_vSetObjectOwner(pentry
->einfo
.pobj
, ulOwner
);
1044 /* Dereference the object */
1045 GDIOBJ_vDereferenceObject(pentry
->einfo
.pobj
);
1056 return GreSetObjectOwnerEx(hobj
, ulOwner
, 0);
1070 /* Verify object type */
1071 objt
= ((ULONG_PTR
)hobj
>> 16) & 0x1f;
1072 if (objt
!= GDIObjType_BRUSH_TYPE
&&
1073 objt
!= GDIObjType_SURF_TYPE
&&
1074 objt
!= GDIObjType_LFONT_TYPE
&&
1075 objt
!= GDIObjType_PAL_TYPE
)
1077 DPRINT1("GreGetObject: Invalid object type\n");
1081 pvObj
= GDIOBJ_ReferenceObjectByHandle(hobj
, objt
);
1084 DPRINT("GreGetObject: Could not lock object\n");
1088 switch (GDI_HANDLE_GET_TYPE(hobj
))
1090 case GDILoObjType_LO_PEN_TYPE
:
1091 case GDILoObjType_LO_EXTPEN_TYPE
:
1092 iResult
= PEN_GetObject(pvObj
, cbCount
, pvBuffer
);
1095 case GDILoObjType_LO_BRUSH_TYPE
:
1096 iResult
= BRUSH_GetObject(pvObj
, cbCount
, pvBuffer
);
1099 case GDILoObjType_LO_BITMAP_TYPE
:
1100 iResult
= BITMAP_GetObject(pvObj
, cbCount
, pvBuffer
);
1103 case GDILoObjType_LO_FONT_TYPE
:
1104 iResult
= FontGetObject(pvObj
, cbCount
, pvBuffer
);
1107 case GDILoObjType_LO_PALETTE_TYPE
:
1108 iResult
= PALETTE_GetObject(pvObj
, cbCount
, pvBuffer
);
1112 DPRINT1("GDI object type of 0x%p not implemented\n", hobj
);
1116 GDIOBJ_vDereferenceObject(pvObj
);
1125 IN INT cjBufferSize
,
1126 OUT LPVOID lpBuffer
)
1128 UINT iResult
, cjMaxSize
;
1132 DIBSECTION dibsection
;
1136 EXTLOGFONTW extlogfontw
;
1137 ENUMLOGFONTEXDVW enumlogfontexdvw
;
1140 /* Normalize to the largest supported object size */
1141 cjMaxSize
= min((UINT
)cjBufferSize
, sizeof(object
));
1143 /* Now do the actual call */
1144 iResult
= GreGetObject(hobj
, cjMaxSize
, lpBuffer
? &object
: NULL
);
1146 /* Check if we have a buffer and data */
1147 if ((lpBuffer
!= NULL
) && (iResult
!= 0))
1149 /* Enter SEH for buffer transfer */
1152 /* Probe the buffer and copy it */
1153 cjMaxSize
= min(cjMaxSize
, iResult
);
1154 ProbeForWrite(lpBuffer
, cjMaxSize
, sizeof(WORD
));
1155 RtlCopyMemory(lpBuffer
, &object
, cjMaxSize
);
1157 _SEH2_EXCEPT(EXCEPTION_EXECUTE_HANDLER
)
1159 /* Clear the return value.
1160 * Do *NOT* set last error here! */
1166 /* Return the count */
1173 NtGdiCreateClientObj(
1179 /* Allocate a new object */
1180 pObject
= GDIOBJ_AllocateObject(GDIObjType_CLIENTOBJ_TYPE
,
1182 BASEFLAG_LOOKASIDE
);
1185 DPRINT1("NtGdiCreateClientObj: Could not allocate a clientobj.\n");
1189 /* Mask out everything that would change the type in a wrong manner */
1190 ulType
&= (GDI_HANDLE_TYPE_MASK
& ~GDI_HANDLE_BASETYPE_MASK
);
1192 /* Set the real object type */
1193 pObject
->hHmgr
= UlongToHandle(ulType
| GDILoObjType_LO_CLIENTOBJ_TYPE
);
1195 /* Create a handle */
1196 handle
= GDIOBJ_hInsertObject(pObject
, GDI_OBJ_HMGR_POWNED
);
1199 DPRINT1("NtGdiCreateClientObj: Could not create a handle.\n");
1200 GDIOBJ_vFreeObject(pObject
);
1205 GDIOBJ_vUnlockObject(pObject
);
1213 NtGdiDeleteClientObj(
1216 /* We first need to get the real type from the handle */
1217 ULONG ulType
= GDI_HANDLE_GET_TYPE(hobj
);
1219 /* Check if it's really a CLIENTOBJ */
1220 if ((ulType
& GDI_HANDLE_BASETYPE_MASK
) != GDILoObjType_LO_CLIENTOBJ_TYPE
)
1222 /* FIXME: SetLastError? */
1226 return GreDeleteObject(hobj
);
1231 PGDI_HANDLE_TABLE GdiHandleTable
= NULL
;
1234 GDIOBJ_ShareLockObj(HGDIOBJ hObj
, DWORD ExpectedType
)
1236 if (ExpectedType
== GDI_OBJECT_TYPE_DONTCARE
)
1237 ExpectedType
= GDI_HANDLE_GET_TYPE(hObj
);
1238 return GDIOBJ_ReferenceObjectByHandle(hObj
, (ExpectedType
>> 16) & 0x1f);
1241 // This function is not safe to use with concurrent deleting attempts
1242 // That shouldn't be a problem, since we don't have any processes yet,
1243 // that could delete the handle
1246 GDIOBJ_ConvertToStockObj(HGDIOBJ
*phObj
)
1251 /* Reference the handle entry */
1252 pentry
= ENTRY_ReferenceEntryByHandle(*phObj
, 0);
1255 DPRINT1("GDIOBJ: Requested handle 0x%p is not valid.\n", *phObj
);
1259 /* Update the entry */
1260 pentry
->FullUnique
|= GDI_ENTRY_STOCK_MASK
;
1261 pentry
->ObjectOwner
.ulObj
= 0;
1263 /* Get the pointer to the BASEOBJECT */
1264 pobj
= pentry
->einfo
.pobj
;
1266 /* Calculate the new handle */
1267 pobj
->hHmgr
= (HGDIOBJ
)((ULONG_PTR
)pobj
->hHmgr
| GDI_HANDLE_STOCK_MASK
);
1269 /* Return the new handle */
1270 *phObj
= pobj
->hHmgr
;
1272 /* Dereference the handle */
1273 GDIOBJ_vDereferenceObject(pobj
);
1279 GDIOBJ_AllocObjWithHandle(ULONG ObjectType
, ULONG cjSize
)
1283 UCHAR objt
= (ObjectType
>> 16) & 0xFF;
1285 if ((objt
== GDIObjType_DC_TYPE
&& cjSize
== sizeof(DC
)) ||
1286 (objt
== GDIObjType_PAL_TYPE
&& cjSize
== sizeof(PALETTE
)) ||
1287 (objt
== GDIObjType_RGN_TYPE
&& cjSize
== sizeof(REGION
)) ||
1288 (objt
== GDIObjType_SURF_TYPE
&& cjSize
== sizeof(SURFACE
)) ||
1289 (objt
== GDIObjType_PATH_TYPE
&& cjSize
== sizeof(PATH
)))
1291 fl
|= BASEFLAG_LOOKASIDE
;
1294 pobj
= GDIOBJ_AllocateObject(objt
, cjSize
, fl
);
1300 if (!GDIOBJ_hInsertObject(pobj
, GDI_OBJ_HMGR_POWNED
))
1302 GDIOBJ_vFreeObject(pobj
);
1309 GDI_MapHandleTable(PEPROCESS pProcess
)
1311 PVOID pvMappedView
= NULL
;
1313 LARGE_INTEGER liOffset
;
1314 ULONG cjViewSize
= sizeof(GDI_HANDLE_TABLE
);
1316 liOffset
.QuadPart
= 0;
1318 ASSERT(gpvGdiHdlTblSection
!= NULL
);
1319 ASSERT(pProcess
!= NULL
);
1321 Status
= MmMapViewOfSection(gpvGdiHdlTblSection
,
1332 if (!NT_SUCCESS(Status
))
1335 return pvMappedView
;
1339 GDI_CleanupForProcess(struct _EPROCESS
*Process
)
1346 DPRINT("CleanupForProcess prochandle %p Pid %p\n",
1347 Process
, Process
->UniqueProcessId
);
1349 ASSERT(Process
== PsGetCurrentProcess());
1351 /* Get the current process Id */
1352 dwProcessId
= PtrToUlong(PsGetCurrentProcessId());
1354 /* Loop all handles in the handle table */
1355 for (ulIndex
= RESERVE_ENTRIES_COUNT
; ulIndex
< gulFirstUnused
; ulIndex
++)
1357 pentry
= &gpentHmgr
[ulIndex
];
1359 /* Check if the object is owned by the process */
1360 if (pentry
->ObjectOwner
.ulObj
== dwProcessId
)
1362 ASSERT(pentry
->einfo
.pobj
->cExclusiveLock
== 0);
1364 /* Reference the object and delete it */
1365 InterlockedIncrement((LONG
*)&gpaulRefCount
[ulIndex
]);
1366 GDIOBJ_vDeleteObject(pentry
->einfo
.pobj
);
1372 DbgGdiHTIntegrityCheck();
1376 ppi
= PsGetCurrentProcessWin32Process();
1377 DPRINT("Completed cleanup for process %p\n", Process
->UniqueProcessId
);
1378 if (ppi
->GDIHandleCount
!= 0)
1380 DPRINT1("Leaking %d handles!\n", ppi
->GDIHandleCount
);
1384 /* Loop all handles in the handle table */
1385 for (ulIndex
= RESERVE_ENTRIES_COUNT
; ulIndex
< gulFirstUnused
; ulIndex
++)
1387 pentry
= &gpentHmgr
[ulIndex
];
1389 /* Check if the object is owned by the process */
1390 if (pentry
->ObjectOwner
.ulObj
== dwProcessId
)
1392 DPRINT1("Leaking object. Index=%lx, type=0x%x, refcount=%lx\n",
1393 ulIndex
, pentry
->Objt
, gpaulRefCount
[ulIndex
]);
1394 DBG_DUMP_EVENT_LIST(&pentry
->einfo
.pobj
->slhLog
);
1395 //DBG_CLEANUP_EVENT_LIST(&pentry->einfo.pobj->slhLog);