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 || \
55 (objt) == GDIObjType_LFONT_TYPE)
57 #define DBG_INCREASE_LOCK_COUNT(ppi, hobj)
58 #define DBG_DECREASE_LOCK_COUNT(x, y)
59 #define ASSERT_SHARED_OBJECT_TYPE(objt)
60 #define ASSERT_EXCLUSIVE_OBJECT_TYPE(objt)
63 #define MmMapViewInSessionSpace MmMapViewInSystemSpace
65 #if defined(_M_IX86) || defined(_M_AMD64)
66 #define InterlockedOr16 _InterlockedOr16
69 #define GDIOBJ_POOL_TAG(type) ('00hG' + ((objt & 0x1f) << 24))
73 REF_MASK_REUSE
= 0xff000000,
74 REF_INC_REUSE
= 0x01000000,
75 REF_MASK_VALID
= 0x00800000,
76 REF_MASK_COUNT
= 0x007fffff,
77 REF_MASK_INUSE
= 0x00ffffff,
80 /* GLOBALS *******************************************************************/
82 /* Per session handle table globals */
83 static PVOID gpvGdiHdlTblSection
= NULL
;
84 static PENTRY gpentHmgr
;
85 static PULONG gpaulRefCount
;
88 static PPAGED_LOOKASIDE_LIST gpaLookasideList
;
90 static BOOL NTAPI
GDIOBJ_Cleanup(PVOID ObjectBody
);
96 NULL
, /* 00 GDIObjType_DEF_TYPE */
97 DC_Cleanup
, /* 01 GDIObjType_DC_TYPE */
98 NULL
, /* 02 GDIObjType_UNUSED1_TYPE */
99 NULL
, /* 03 GDIObjType_UNUSED2_TYPE */
100 REGION_Cleanup
, /* 04 GDIObjType_RGN_TYPE */
101 SURFACE_Cleanup
, /* 05 GDIObjType_SURF_TYPE */
102 GDIOBJ_Cleanup
, /* 06 GDIObjType_CLIENTOBJ_TYPE */
103 GDIOBJ_Cleanup
, /* 07 GDIObjType_PATH_TYPE */
104 PALETTE_Cleanup
, /* 08 GDIObjType_PAL_TYPE */
105 GDIOBJ_Cleanup
, /* 09 GDIObjType_ICMLCS_TYPE */
106 GDIOBJ_Cleanup
, /* 0a GDIObjType_LFONT_TYPE */
107 NULL
, /* 0b GDIObjType_RFONT_TYPE, unused */
108 NULL
, /* 0c GDIObjType_PFE_TYPE, unused */
109 NULL
, /* 0d GDIObjType_PFT_TYPE, unused */
110 GDIOBJ_Cleanup
, /* 0e GDIObjType_ICMCXF_TYPE */
111 NULL
, /* 0f GDIObjType_SPRITE_TYPE, unused */
112 BRUSH_Cleanup
, /* 10 GDIObjType_BRUSH_TYPE, BRUSH, PEN, EXTPEN */
113 NULL
, /* 11 GDIObjType_UMPD_TYPE, unused */
114 NULL
, /* 12 GDIObjType_UNUSED4_TYPE */
115 NULL
, /* 13 GDIObjType_SPACE_TYPE, unused */
116 NULL
, /* 14 GDIObjType_UNUSED5_TYPE */
117 NULL
, /* 15 GDIObjType_META_TYPE, unused */
118 NULL
, /* 16 GDIObjType_EFSTATE_TYPE, unused */
119 NULL
, /* 17 GDIObjType_BMFD_TYPE, unused */
120 NULL
, /* 18 GDIObjType_VTFD_TYPE, unused */
121 NULL
, /* 19 GDIObjType_TTFD_TYPE, unused */
122 NULL
, /* 1a GDIObjType_RC_TYPE, unused */
123 NULL
, /* 1b GDIObjType_TEMP_TYPE, unused */
124 DRIVEROBJ_Cleanup
,/* 1c GDIObjType_DRVOBJ_TYPE */
125 NULL
, /* 1d GDIObjType_DCIOBJ_TYPE, unused */
126 NULL
, /* 1e GDIObjType_SPOOL_TYPE, unused */
127 NULL
, /* 1f reserved entry */
130 /* INTERNAL FUNCTIONS ********************************************************/
134 GDIOBJ_Cleanup(PVOID ObjectBody
)
141 InitLookasideList(UCHAR objt
, ULONG cjSize
)
143 ExInitializePagedLookasideList(&gpaLookasideList
[objt
],
148 GDITAG_HMGR_LOOKASIDE_START
+ (objt
<< 24),
155 InitGdiHandleTable(void)
158 LARGE_INTEGER liSize
;
160 SIZE_T cjViewSize
= 0;
162 /* Create a section for the shared handle table */
163 liSize
.QuadPart
= sizeof(GDI_HANDLE_TABLE
); // GDI_HANDLE_COUNT * sizeof(ENTRY);
164 status
= MmCreateSection(&gpvGdiHdlTblSection
,
172 if (!NT_SUCCESS(status
))
174 DPRINT1("INITGDI: Could not allocate a GDI handle table.\n");
178 /* Map the section in session space */
179 status
= MmMapViewInSessionSpace(gpvGdiHdlTblSection
,
182 if (!NT_SUCCESS(status
))
184 DPRINT1("INITGDI: Failed to map handle table section\n");
185 ObDereferenceObject(gpvGdiHdlTblSection
);
189 /* Allocate memory for the reference counter table */
190 gpaulRefCount
= EngAllocSectionMem(&pvSection
,
192 GDI_HANDLE_COUNT
* sizeof(ULONG
),
196 DPRINT1("INITGDI: Failed to allocate reference table.\n");
197 ObDereferenceObject(gpvGdiHdlTblSection
);
198 return STATUS_INSUFFICIENT_RESOURCES
;
202 gulFirstUnused
= RESERVE_ENTRIES_COUNT
;
204 GdiHandleTable
= (PVOID
)gpentHmgr
;
206 /* Initialize the lookaside lists */
207 gpaLookasideList
= ExAllocatePoolWithTag(NonPagedPool
,
208 GDIObjTypeTotal
* sizeof(PAGED_LOOKASIDE_LIST
),
210 if(!gpaLookasideList
)
211 return STATUS_NO_MEMORY
;
213 InitLookasideList(GDIObjType_DC_TYPE
, sizeof(DC
));
214 InitLookasideList(GDIObjType_RGN_TYPE
, sizeof(REGION
));
215 InitLookasideList(GDIObjType_SURF_TYPE
, sizeof(SURFACE
));
216 InitLookasideList(GDIObjType_CLIENTOBJ_TYPE
, sizeof(CLIENTOBJ
));
217 InitLookasideList(GDIObjType_PATH_TYPE
, sizeof(PATH
));
218 InitLookasideList(GDIObjType_PAL_TYPE
, sizeof(PALETTE
));
219 InitLookasideList(GDIObjType_ICMLCS_TYPE
, sizeof(COLORSPACE
));
220 InitLookasideList(GDIObjType_LFONT_TYPE
, sizeof(TEXTOBJ
));
221 InitLookasideList(GDIObjType_BRUSH_TYPE
, sizeof(BRUSH
));
223 return STATUS_SUCCESS
;
228 IncrementGdiHandleCount(void)
230 PPROCESSINFO ppi
= PsGetCurrentProcessWin32Process();
231 if (ppi
) InterlockedIncrement((LONG
*)&ppi
->GDIHandleCount
);
236 DecrementGdiHandleCount(void)
238 PPROCESSINFO ppi
= PsGetCurrentProcessWin32Process();
239 if (ppi
) InterlockedDecrement((LONG
*)&ppi
->GDIHandleCount
);
244 ENTRY_pentPopFreeEntry(VOID
)
246 ULONG iFirst
, iNext
, iPrev
;
249 DPRINT("Enter InterLockedPopFreeEntry\n");
253 /* Get the index and sequence number of the first free entry */
254 iFirst
= gulFirstFree
;
256 /* Check if we have a free entry */
257 if (!(iFirst
& GDI_HANDLE_INDEX_MASK
))
259 /* Increment FirstUnused and get the new index */
260 iFirst
= InterlockedIncrement((LONG
*)&gulFirstUnused
) - 1;
262 /* Check if we have unused entries left */
263 if (iFirst
>= GDI_HANDLE_COUNT
)
265 DPRINT1("No more GDI handles left!\n");
269 /* Return the old entry */
270 return &gpentHmgr
[iFirst
];
273 /* Get a pointer to the first free entry */
274 pentFree
= &gpentHmgr
[iFirst
& GDI_HANDLE_INDEX_MASK
];
276 /* Create a new value with an increased sequence number */
277 iNext
= (USHORT
)(ULONG_PTR
)pentFree
->einfo
.pobj
;
278 iNext
|= (iFirst
& ~GDI_HANDLE_INDEX_MASK
) + 0x10000;
280 /* Try to exchange the FirstFree value */
281 iPrev
= InterlockedCompareExchange((LONG
*)&gulFirstFree
,
285 while (iPrev
!= iFirst
);
287 /* Sanity check: is entry really free? */
288 ASSERT(((ULONG_PTR
)pentFree
->einfo
.pobj
& ~GDI_HANDLE_INDEX_MASK
) == 0);
293 /* Pushes an entry of the handle table to the free list,
294 The entry must not have any references left */
297 ENTRY_vPushFreeEntry(PENTRY pentFree
)
299 ULONG iToFree
, iFirst
, iPrev
, idxToFree
;
301 DPRINT("Enter ENTRY_vPushFreeEntry\n");
303 idxToFree
= pentFree
- gpentHmgr
;
304 ASSERT((gpaulRefCount
[idxToFree
] & REF_MASK_INUSE
) == 0);
306 /* Initialize entry */
307 pentFree
->Objt
= GDIObjType_DEF_TYPE
;
308 pentFree
->ObjectOwner
.ulObj
= 0;
309 pentFree
->pUser
= NULL
;
311 /* Increase reuse counter in entry and reference counter */
312 InterlockedExchangeAdd((LONG
*)&gpaulRefCount
[idxToFree
], REF_INC_REUSE
);
313 pentFree
->FullUnique
+= 0x0100;
317 /* Get the current first free index and sequence number */
318 iFirst
= gulFirstFree
;
320 /* Set the einfo.pobj member to the index of the first free entry */
321 pentFree
->einfo
.pobj
= UlongToPtr(iFirst
& GDI_HANDLE_INDEX_MASK
);
323 /* Combine new index and increased sequence number in iToFree */
324 iToFree
= idxToFree
| ((iFirst
& ~GDI_HANDLE_INDEX_MASK
) + 0x10000);
326 /* Try to atomically update the first free entry */
327 iPrev
= InterlockedCompareExchange((LONG
*)&gulFirstFree
,
331 while (iPrev
!= iFirst
);
336 ENTRY_ReferenceEntryByHandle(HGDIOBJ hobj
, FLONG fl
)
338 ULONG ulIndex
, cNewRefs
, cOldRefs
;
341 /* Get the handle index and check if its too big */
342 ulIndex
= GDI_HANDLE_GET_INDEX(hobj
);
343 if (ulIndex
>= GDI_HANDLE_COUNT
) return NULL
;
345 /* Get pointer to the entry */
346 pentry
= &gpentHmgr
[ulIndex
];
348 /* Get the current reference count */
349 cOldRefs
= gpaulRefCount
[ulIndex
];
353 /* Check if the slot is deleted */
354 if ((cOldRefs
& REF_MASK_VALID
) == 0)
356 DPRINT("GDIOBJ: Slot is not valid: 0x%lx, hobh=%p\n", cOldRefs
, hobj
);
360 /* Check if the unique value matches */
361 if (pentry
->FullUnique
!= (USHORT
)((ULONG_PTR
)hobj
>> 16))
363 DPRINT("GDIOBJ: Wrong unique value. Handle: 0x%4x, entry: 0x%4x\n",
364 (USHORT
)((ULONG_PTR
)hobj
>> 16, pentry
->FullUnique
));
368 /* Check if the object owner is this process or public */
369 if (!(fl
& GDIOBJFLAG_IGNOREPID
) &&
370 pentry
->ObjectOwner
.ulObj
!= GDI_OBJ_HMGR_PUBLIC
&&
371 pentry
->ObjectOwner
.ulObj
!= PtrToUlong(PsGetCurrentProcessId()))
373 DPRINT("GDIOBJ: Cannot reference foreign handle %p, pentry=%p:%lx.\n",
374 hobj
, pentry
, pentry
->ObjectOwner
.ulObj
);
378 /* Try to atomically increment the reference count */
379 cNewRefs
= cOldRefs
+ 1;
380 cOldRefs
= InterlockedCompareExchange((PLONG
)&gpaulRefCount
[ulIndex
],
384 while (cNewRefs
!= cOldRefs
+ 1);
386 /* Integrity checks */
387 ASSERT((pentry
->FullUnique
& 0x1f) == pentry
->Objt
);
388 ASSERT(pentry
->einfo
.pobj
&& pentry
->einfo
.pobj
->hHmgr
== hobj
);
395 ENTRY_hInsertObject(PENTRY pentry
, POBJ pobj
, UCHAR objt
, ULONG ulOwner
)
399 /* Calculate the handle index */
400 ulIndex
= pentry
- gpentHmgr
;
402 /* Update the fields in the ENTRY */
403 pentry
->einfo
.pobj
= pobj
;
404 pentry
->Objt
= objt
& 0x1f;
405 pentry
->FullUnique
= (pentry
->FullUnique
& 0xff00) | objt
;
406 pentry
->ObjectOwner
.ulObj
= ulOwner
;
408 /* Make the handle valid with 1 reference */
409 ASSERT((gpaulRefCount
[ulIndex
] & REF_MASK_INUSE
) == 0);
410 InterlockedOr((LONG
*)&gpaulRefCount
[ulIndex
], REF_MASK_VALID
| 1);
412 /* Return the handle */
413 return (HGDIOBJ
)(((ULONG_PTR
)pentry
->FullUnique
<< 16) | ulIndex
);
418 GDIOBJ_AllocateObject(UCHAR objt
, ULONG cjSize
, FLONG fl
)
422 if (fl
& BASEFLAG_LOOKASIDE
)
424 /* Allocate the object from a lookaside list */
425 pobj
= ExAllocateFromPagedLookasideList(&gpaLookasideList
[objt
& 0x1f]);
429 /* Allocate the object from paged pool */
430 pobj
= ExAllocatePoolWithTag(PagedPool
, cjSize
, GDIOBJ_POOL_TAG(objt
));
433 if (!pobj
) return NULL
;
435 /* Initialize the object */
436 RtlZeroMemory(pobj
, cjSize
);
437 pobj
->hHmgr
= (HGDIOBJ
)((ULONG_PTR
)objt
<< 16);
438 pobj
->cExclusiveLock
= 0;
439 pobj
->ulShareCount
= 1;
440 pobj
->BaseFlags
= fl
& 0xffff;
441 DBG_INITLOG(&pobj
->slhLog
);
442 DBG_LOGEVENT(&pobj
->slhLog
, EVENT_ALLOCATE
, 0);
449 GDIOBJ_vFreeObject(POBJ pobj
)
453 DBG_CLEANUP_EVENT_LIST(&pobj
->slhLog
);
455 /* Get the object type */
456 objt
= ((ULONG_PTR
)pobj
->hHmgr
>> 16) & 0x1f;
458 /* Call the cleanup procedure */
459 ASSERT(apfnCleanup
[objt
]);
460 apfnCleanup
[objt
](pobj
);
462 /* Check if the object is allocated from a lookaside list */
463 if (pobj
->BaseFlags
& BASEFLAG_LOOKASIDE
)
465 ExFreeToPagedLookasideList(&gpaLookasideList
[objt
], pobj
);
469 ExFreePoolWithTag(pobj
, GDIOBJ_POOL_TAG(objt
));
475 GDIOBJ_vDereferenceObject(POBJ pobj
)
477 ULONG cRefs
, ulIndex
;
479 /* Must not be exclusively locked */
480 ASSERT(pobj
->cExclusiveLock
== 0);
482 /* Check if the object has a handle */
483 if (GDI_HANDLE_GET_INDEX(pobj
->hHmgr
))
485 /* Calculate the index */
486 ulIndex
= GDI_HANDLE_GET_INDEX(pobj
->hHmgr
);
488 /* Decrement reference count */
489 ASSERT((gpaulRefCount
[ulIndex
] & REF_MASK_COUNT
) > 0);
490 cRefs
= InterlockedDecrement((LONG
*)&gpaulRefCount
[ulIndex
]) & REF_MASK_INUSE
;
492 /* Check if we reached 0 and handle bit is not set */
495 /* Check if the handle was process owned */
496 if (gpentHmgr
[ulIndex
].ObjectOwner
.ulObj
!= GDI_OBJ_HMGR_PUBLIC
&&
497 gpentHmgr
[ulIndex
].ObjectOwner
.ulObj
!= GDI_OBJ_HMGR_NONE
)
499 /* Decrement the process handle count */
500 ASSERT(gpentHmgr
[ulIndex
].ObjectOwner
.ulObj
==
501 HandleToUlong(PsGetCurrentProcessId()));
502 DecrementGdiHandleCount();
505 /* Push entry to the free list */
506 ENTRY_vPushFreeEntry(&gpentHmgr
[ulIndex
]);
511 /* Decrement the objects reference count */
512 ASSERT(pobj
->ulShareCount
> 0);
513 cRefs
= InterlockedDecrement((LONG
*)&pobj
->ulShareCount
);
516 DBG_LOGEVENT(&pobj
->slhLog
, EVENT_DEREFERENCE
, cRefs
);
518 /* Check if we reached 0 */
521 /* Make sure it's ok to delete the object */
522 ASSERT(pobj
->BaseFlags
& BASEFLAG_READY_TO_DIE
);
524 /* Free the object */
525 GDIOBJ_vFreeObject(pobj
);
531 GDIOBJ_ReferenceObjectByHandle(
538 /* Check if the handle type matches */
539 ASSERT_SHARED_OBJECT_TYPE(objt
);
540 if ((((ULONG_PTR
)hobj
>> 16) & 0x1f) != objt
)
542 DPRINT("GDIOBJ: Wrong type. handle=%p, type=%x\n", hobj
, objt
);
546 /* Reference the handle entry */
547 pentry
= ENTRY_ReferenceEntryByHandle(hobj
, 0);
550 DPRINT("GDIOBJ: Requested handle 0x%p is not valid.\n", hobj
);
554 /* Get the pointer to the BASEOBJECT */
555 pobj
= pentry
->einfo
.pobj
;
557 /* Check if the object is exclusively locked */
558 if (pobj
->cExclusiveLock
!= 0)
560 DPRINT1("GDIOBJ: Cannot reference oject %p with exclusive lock.\n", hobj
);
561 GDIOBJ_vDereferenceObject(pobj
);
562 DBG_DUMP_EVENT_LIST(&pobj
->slhLog
);
566 DBG_LOGEVENT(&pobj
->slhLog
, EVENT_REFERENCE
, gpaulRefCount
[pentry
- gpentHmgr
]);
568 /* All is well, return the object */
574 GDIOBJ_vReferenceObjectByPointer(POBJ pobj
)
578 /* Must not be exclusively locked */
579 ASSERT(pobj
->cExclusiveLock
== 0);
581 /* Check if the object has a handle */
582 if (GDI_HANDLE_GET_INDEX(pobj
->hHmgr
))
584 /* Increase the handle's reference count */
585 ULONG ulIndex
= GDI_HANDLE_GET_INDEX(pobj
->hHmgr
);
586 ASSERT((gpaulRefCount
[ulIndex
] & REF_MASK_COUNT
) > 0);
587 cRefs
= InterlockedIncrement((LONG
*)&gpaulRefCount
[ulIndex
]);
591 /* Increase the object's reference count */
592 cRefs
= InterlockedIncrement((LONG
*)&pobj
->ulShareCount
);
595 DBG_LOGEVENT(&pobj
->slhLog
, EVENT_REFERENCE
, cRefs
);
608 /* Check if the handle type matches */
609 ASSERT_EXCLUSIVE_OBJECT_TYPE(objt
);
610 if ((((ULONG_PTR
)hobj
>> 16) & 0x1f) != objt
)
612 DPRINT("Wrong object type: hobj=0x%p, objt=0x%x\n", hobj
, objt
);
616 /* Reference the handle entry */
617 pentry
= ENTRY_ReferenceEntryByHandle(hobj
, 0);
620 DPRINT("GDIOBJ: Requested handle 0x%p is not valid.\n", hobj
);
624 /* Get the pointer to the BASEOBJECT */
625 pobj
= pentry
->einfo
.pobj
;
627 /* Check if we already own the lock */
628 dwThreadId
= PtrToUlong(PsGetCurrentThreadId());
629 if (pobj
->dwThreadId
!= dwThreadId
)
631 /* Disable APCs and acquire the push lock */
632 KeEnterCriticalRegion();
633 ExAcquirePushLockExclusive(&pobj
->pushlock
);
635 /* Set us as lock owner */
636 ASSERT(pobj
->dwThreadId
== 0);
637 pobj
->dwThreadId
= dwThreadId
;
640 /* Increase lock count */
641 pobj
->cExclusiveLock
++;
642 DBG_INCREASE_LOCK_COUNT(PsGetCurrentProcessWin32Process(), hobj
);
643 DBG_LOGEVENT(&pobj
->slhLog
, EVENT_LOCK
, 0);
645 /* Return the object */
651 GDIOBJ_vUnlockObject(POBJ pobj
)
653 ULONG cRefs
, ulIndex
;
654 ASSERT(pobj
->cExclusiveLock
> 0);
656 /* Decrease lock count */
657 pobj
->cExclusiveLock
--;
658 DBG_DECREASE_LOCK_COUNT(PsGetCurrentProcessWin32Process(), pobj
->hHmgr
);
659 DBG_LOGEVENT(&pobj
->slhLog
, EVENT_UNLOCK
, 0);
661 /* Check if this was the last lock */
662 if (pobj
->cExclusiveLock
== 0)
664 /* Reset lock owner */
665 pobj
->dwThreadId
= 0;
667 /* Release the pushlock and reenable APCs */
668 ExReleasePushLockExclusive(&pobj
->pushlock
);
669 KeLeaveCriticalRegion();
672 /* Calculate the index */
673 ulIndex
= GDI_HANDLE_GET_INDEX(pobj
->hHmgr
);
675 /* Decrement reference count */
676 ASSERT((gpaulRefCount
[ulIndex
] & REF_MASK_COUNT
) > 0);
677 cRefs
= InterlockedDecrement((LONG
*)&gpaulRefCount
[ulIndex
]);
678 ASSERT(cRefs
& REF_MASK_VALID
);
683 GDIOBJ_hInsertObject(
690 /* Must have no handle and only one reference */
691 ASSERT(GDI_HANDLE_GET_INDEX(pobj
->hHmgr
) == 0);
692 ASSERT(pobj
->cExclusiveLock
== 0);
693 ASSERT(pobj
->ulShareCount
== 1);
695 /* Get a free handle entry */
696 pentry
= ENTRY_pentPopFreeEntry();
699 DPRINT1("GDIOBJ: Could not get a free entry.\n");
703 /* Make the object exclusively locked */
704 ExInitializePushLock(&pobj
->pushlock
);
705 KeEnterCriticalRegion();
706 ExAcquirePushLockExclusive(&pobj
->pushlock
);
707 pobj
->cExclusiveLock
= 1;
708 pobj
->dwThreadId
= PtrToUlong(PsGetCurrentThreadId());
709 DBG_INCREASE_LOCK_COUNT(PsGetCurrentProcessWin32Process(), pobj
->hHmgr
);
711 /* Get object type from the hHmgr field */
712 objt
= ((ULONG_PTR
)pobj
->hHmgr
>> 16) & 0xff;
713 ASSERT(objt
!= GDIObjType_DEF_TYPE
);
715 /* Check if current process is requested owner */
716 if (ulOwner
== GDI_OBJ_HMGR_POWNED
)
718 /* Increment the process handle count */
719 IncrementGdiHandleCount();
722 ulOwner
= HandleToUlong(PsGetCurrentProcessId());
725 /* Insert the object into the handle table */
726 pobj
->hHmgr
= ENTRY_hInsertObject(pentry
, pobj
, objt
, ulOwner
);
728 /* Return the handle */
729 DPRINT("GDIOBJ: Created handle: %p\n", pobj
->hHmgr
);
730 DBG_LOGEVENT(&pobj
->slhLog
, EVENT_CREATE_HANDLE
, 0);
736 GDIOBJ_vSetObjectOwner(
742 /* This is a ugly HACK, needed to fix IntGdiSetDCOwnerEx */
743 if (GDI_HANDLE_IS_STOCKOBJ(pobj
->hHmgr
))
745 DPRINT("Trying to set ownership of stock object %p to %lx\n", pobj
->hHmgr
, ulOwner
);
749 /* Get the handle entry */
750 ASSERT(GDI_HANDLE_GET_INDEX(pobj
->hHmgr
));
751 pentry
= &gpentHmgr
[GDI_HANDLE_GET_INDEX(pobj
->hHmgr
)];
753 /* Is the current process requested? */
754 if (ulOwner
== GDI_OBJ_HMGR_POWNED
)
757 ulOwner
= HandleToUlong(PsGetCurrentProcessId());
758 if (pentry
->ObjectOwner
.ulObj
!= ulOwner
)
760 IncrementGdiHandleCount();
765 if (ulOwner
== GDI_OBJ_HMGR_NONE
)
766 ulOwner
= GDI_OBJ_HMGR_PUBLIC
;
768 if (ulOwner
== GDI_OBJ_HMGR_PUBLIC
||
769 ulOwner
== GDI_OBJ_HMGR_NONE
)
771 /* Make sure we don't leak user mode memory */
772 ASSERT(pentry
->pUser
== NULL
);
773 if (pentry
->ObjectOwner
.ulObj
!= GDI_OBJ_HMGR_PUBLIC
&&
774 pentry
->ObjectOwner
.ulObj
!= GDI_OBJ_HMGR_NONE
)
776 DecrementGdiHandleCount();
781 pentry
->ObjectOwner
.ulObj
= ulOwner
;
784 /* Locks 2 or 3 objects at a time */
787 GDIOBJ_bLockMultipleObjects(
793 UINT auiIndices
[3] = {0, 1, 2};
796 ASSERT(ulCount
<= 3);
798 /* Sort the handles */
799 for (i
= 0; i
< ulCount
- 1; i
++)
801 for (j
= i
+ 1; j
< ulCount
; j
++)
803 if ((ULONG_PTR
)ahObj
[auiIndices
[i
]] <
804 (ULONG_PTR
)ahObj
[auiIndices
[j
]])
807 auiIndices
[i
] = auiIndices
[j
];
813 /* Lock the objects in safe order */
814 for (i
= 0; i
< ulCount
; i
++)
816 /* Skip NULL handles */
817 if (ahObj
[auiIndices
[i
]] == NULL
)
819 apObj
[auiIndices
[i
]] = NULL
;
823 /* Lock the object */
824 apObj
[auiIndices
[i
]] = GDIOBJ_LockObject(ahObj
[auiIndices
[i
]], objt
);
826 /* Check for failure */
827 if (apObj
[auiIndices
[i
]] == NULL
)
832 if (apObj
[auiIndices
[i
]])
833 GDIOBJ_vUnlockObject(apObj
[auiIndices
[i
]]);
844 GDIOBJ_pvGetObjectAttr(POBJ pobj
)
846 ULONG ulIndex
= GDI_HANDLE_GET_INDEX(pobj
->hHmgr
);
847 return gpentHmgr
[ulIndex
].pUser
;
852 GDIOBJ_vSetObjectAttr(POBJ pobj
, PVOID pvObjAttr
)
858 /* Get the handle index */
859 ulIndex
= GDI_HANDLE_GET_INDEX(pobj
->hHmgr
);
861 /* Set pointer to the usermode attribute */
862 gpentHmgr
[ulIndex
].pUser
= pvObjAttr
;
867 GDIOBJ_vDeleteObject(POBJ pobj
)
871 /* Set the object's delete flag */
872 InterlockedOr16((SHORT
*)&pobj
->BaseFlags
, BASEFLAG_READY_TO_DIE
);
873 DBG_LOGEVENT(&pobj
->slhLog
, EVENT_DELETE
, 0);
875 /* Get the handle index */
876 ulIndex
= GDI_HANDLE_GET_INDEX(pobj
->hHmgr
);
879 /* Reset the handle valid bit */
880 InterlockedAnd((LONG
*)&gpaulRefCount
[ulIndex
], ~REF_MASK_VALID
);
882 /* Check if the object is exclusively locked */
883 if (pobj
->cExclusiveLock
!= 0)
885 /* Reset lock owner and lock count */
886 pobj
->dwThreadId
= 0;
887 pobj
->cExclusiveLock
= 0;
889 /* Release the pushlock and reenable APCs */
890 ExReleasePushLockExclusive(&pobj
->pushlock
);
891 KeLeaveCriticalRegion();
892 DBG_DECREASE_LOCK_COUNT(PsGetCurrentProcessWin32Process(), pobj
->hHmgr
);
896 /* Dereference the object (will take care of deletion) */
897 GDIOBJ_vDereferenceObject(pobj
);
902 GreIsHandleValid(HGDIOBJ hobj
)
906 pentry
= ENTRY_ReferenceEntryByHandle(hobj
, 0);
907 if (!pentry
) return FALSE
;
908 GDIOBJ_vDereferenceObject(pentry
->einfo
.pobj
);
914 GreDeleteObject(HGDIOBJ hobj
)
918 /* Check for stock objects */
919 if (GDI_HANDLE_IS_STOCKOBJ(hobj
))
921 DPRINT1("GreDeleteObject: Cannot delete stock object %p.\n", hobj
);
925 /* Reference the handle entry */
926 pentry
= ENTRY_ReferenceEntryByHandle(hobj
, 0);
929 DPRINT1("GreDeleteObject: Trying to delete invalid object %p\n", hobj
);
933 /* Check for public owner */
934 if (pentry
->ObjectOwner
.ulObj
== GDI_OBJ_HMGR_PUBLIC
)
936 DPRINT1("GreDeleteObject: Trying to delete global object %p\n", hobj
);
937 GDIOBJ_vDereferenceObject(pentry
->einfo
.pobj
);
941 /* Delete the object */
942 GDIOBJ_vDeleteObject(pentry
->einfo
.pobj
);
948 GreGetObjectOwner(HGDIOBJ hobj
)
950 ULONG ulIndex
, ulOwner
;
952 /* Get the handle index */
953 ulIndex
= GDI_HANDLE_GET_INDEX(hobj
);
955 /* Check if the handle is valid */
956 if (ulIndex
>= GDI_HANDLE_COUNT
||
957 gpentHmgr
[ulIndex
].Objt
== GDIObjType_DEF_TYPE
||
958 ((ULONG_PTR
)hobj
>> 16) != gpentHmgr
[ulIndex
].FullUnique
)
960 DPRINT1("GreGetObjectOwner: invalid handle 0x%p.\n", hobj
);
961 return GDI_OBJ_HMGR_RESTRICTED
;
964 /* Get the object owner */
965 ulOwner
= gpentHmgr
[ulIndex
].ObjectOwner
.ulObj
;
967 if (ulOwner
== HandleToUlong(PsGetCurrentProcessId()))
968 return GDI_OBJ_HMGR_POWNED
;
970 if (ulOwner
== GDI_OBJ_HMGR_PUBLIC
)
971 return GDI_OBJ_HMGR_PUBLIC
;
973 return GDI_OBJ_HMGR_RESTRICTED
;
984 /* Check for stock objects */
985 if (GDI_HANDLE_IS_STOCKOBJ(hobj
))
987 DPRINT("GreSetObjectOwner: Got stock object %p\n", hobj
);
991 /* Reference the handle entry */
992 pentry
= ENTRY_ReferenceEntryByHandle(hobj
, 0);
995 DPRINT("GreSetObjectOwner: Invalid handle 0x%p.\n", hobj
);
999 /* Call internal function */
1000 GDIOBJ_vSetObjectOwner(pentry
->einfo
.pobj
, ulOwner
);
1002 /* Dereference the object */
1003 GDIOBJ_vDereferenceObject(pentry
->einfo
.pobj
);
1019 /* Verify object type */
1020 objt
= ((ULONG_PTR
)hobj
>> 16) & 0x1f;
1021 if (objt
!= GDIObjType_BRUSH_TYPE
&&
1022 objt
!= GDIObjType_SURF_TYPE
&&
1023 objt
!= GDIObjType_LFONT_TYPE
&&
1024 objt
!= GDIObjType_PAL_TYPE
)
1026 DPRINT1("GreGetObject: Invalid object type\n");
1030 pvObj
= GDIOBJ_ReferenceObjectByHandle(hobj
, objt
);
1033 DPRINT("GreGetObject: Could not lock object\n");
1037 switch (GDI_HANDLE_GET_TYPE(hobj
))
1039 case GDILoObjType_LO_PEN_TYPE
:
1040 case GDILoObjType_LO_EXTPEN_TYPE
:
1041 iResult
= PEN_GetObject(pvObj
, cbCount
, pvBuffer
);
1044 case GDILoObjType_LO_BRUSH_TYPE
:
1045 iResult
= BRUSH_GetObject(pvObj
, cbCount
, pvBuffer
);
1048 case GDILoObjType_LO_BITMAP_TYPE
:
1049 iResult
= BITMAP_GetObject(pvObj
, cbCount
, pvBuffer
);
1052 case GDILoObjType_LO_FONT_TYPE
:
1053 iResult
= FontGetObject(pvObj
, cbCount
, pvBuffer
);
1056 case GDILoObjType_LO_PALETTE_TYPE
:
1057 iResult
= PALETTE_GetObject(pvObj
, cbCount
, pvBuffer
);
1061 DPRINT1("GDI object type of 0x%p not implemented\n", hobj
);
1065 GDIOBJ_vDereferenceObject(pvObj
);
1075 OUT LPVOID lpBuffer
)
1082 DIBSECTION dibsection
;
1086 EXTLOGFONTW extlogfontw
;
1087 ENUMLOGFONTEXDVW enumlogfontexdvw
;
1090 /* Normalize to the largest supported object size */
1091 cbCount
= min((UINT
)cbCount
, sizeof(object
));
1093 /* Now do the actual call */
1094 iRetCount
= GreGetObject(hobj
, cbCount
, lpBuffer
? &object
: NULL
);
1095 cbCopyCount
= min((UINT
)cbCount
, (UINT
)iRetCount
);
1097 /* Make sure we have a buffer and a copy size */
1098 if ((cbCopyCount
) && (lpBuffer
))
1100 /* Enter SEH for buffer transfer */
1103 /* Probe the buffer and copy it */
1104 ProbeForWrite(lpBuffer
, cbCopyCount
, sizeof(WORD
));
1105 RtlCopyMemory(lpBuffer
, &object
, cbCopyCount
);
1107 _SEH2_EXCEPT(EXCEPTION_EXECUTE_HANDLER
)
1109 /* Clear the return value.
1110 * Do *NOT* set last error here! */
1116 /* Return the count */
1123 NtGdiCreateClientObj(
1129 /* Allocate a new object */
1130 pObject
= GDIOBJ_AllocateObject(GDIObjType_CLIENTOBJ_TYPE
,
1132 BASEFLAG_LOOKASIDE
);
1135 DPRINT1("NtGdiCreateClientObj: Could not allocate a clientobj.\n");
1139 /* Mask out everything that would change the type in a wrong manner */
1140 ulType
&= (GDI_HANDLE_TYPE_MASK
& ~GDI_HANDLE_BASETYPE_MASK
);
1142 /* Set the real object type */
1143 pObject
->hHmgr
= UlongToHandle(ulType
| GDILoObjType_LO_CLIENTOBJ_TYPE
);
1145 /* Create a handle */
1146 handle
= GDIOBJ_hInsertObject(pObject
, GDI_OBJ_HMGR_POWNED
);
1149 DPRINT1("NtGdiCreateClientObj: Could not create a handle.\n");
1150 GDIOBJ_vFreeObject(pObject
);
1155 GDIOBJ_vUnlockObject(pObject
);
1163 NtGdiDeleteClientObj(
1166 /* We first need to get the real type from the handle */
1167 ULONG ulType
= GDI_HANDLE_GET_TYPE(hobj
);
1169 /* Check if it's really a CLIENTOBJ */
1170 if ((ulType
& GDI_HANDLE_BASETYPE_MASK
) != GDILoObjType_LO_CLIENTOBJ_TYPE
)
1172 /* FIXME: SetLastError? */
1176 return GreDeleteObject(hobj
);
1181 PGDI_HANDLE_TABLE GdiHandleTable
= NULL
;
1184 GDIOBJ_ShareLockObj(HGDIOBJ hObj
, DWORD ExpectedType
)
1186 if (ExpectedType
== GDI_OBJECT_TYPE_DONTCARE
)
1187 ExpectedType
= GDI_HANDLE_GET_TYPE(hObj
);
1188 return GDIOBJ_ReferenceObjectByHandle(hObj
, (ExpectedType
>> 16) & 0x1f);
1191 // This function is not safe to use with concurrent deleting attempts
1192 // That shouldn't be a problem, since we don't have any processes yet,
1193 // that could delete the handle
1196 GDIOBJ_ConvertToStockObj(HGDIOBJ
*phObj
)
1201 /* Reference the handle entry */
1202 pentry
= ENTRY_ReferenceEntryByHandle(*phObj
, 0);
1205 DPRINT1("GDIOBJ: Requested handle 0x%p is not valid.\n", *phObj
);
1209 /* Update the entry */
1210 pentry
->FullUnique
|= GDI_ENTRY_STOCK_MASK
;
1211 pentry
->ObjectOwner
.ulObj
= 0;
1213 /* Get the pointer to the BASEOBJECT */
1214 pobj
= pentry
->einfo
.pobj
;
1216 /* Calculate the new handle */
1217 pobj
->hHmgr
= (HGDIOBJ
)((ULONG_PTR
)pobj
->hHmgr
| GDI_HANDLE_STOCK_MASK
);
1219 /* Return the new handle */
1220 *phObj
= pobj
->hHmgr
;
1222 /* Dereference the handle */
1223 GDIOBJ_vDereferenceObject(pobj
);
1229 GDIOBJ_AllocObjWithHandle(ULONG ObjectType
, ULONG cjSize
)
1233 UCHAR objt
= (ObjectType
>> 16) & 0xFF;
1235 if ((objt
== GDIObjType_DC_TYPE
&& cjSize
== sizeof(DC
)) ||
1236 (objt
== GDIObjType_PAL_TYPE
&& cjSize
== sizeof(PALETTE
)) ||
1237 (objt
== GDIObjType_RGN_TYPE
&& cjSize
== sizeof(REGION
)) ||
1238 (objt
== GDIObjType_SURF_TYPE
&& cjSize
== sizeof(SURFACE
)) ||
1239 (objt
== GDIObjType_PATH_TYPE
&& cjSize
== sizeof(PATH
)))
1241 fl
|= BASEFLAG_LOOKASIDE
;
1244 pobj
= GDIOBJ_AllocateObject(objt
, cjSize
, fl
);
1245 if (!GDIOBJ_hInsertObject(pobj
, GDI_OBJ_HMGR_POWNED
))
1247 GDIOBJ_vFreeObject(pobj
);
1254 GDI_MapHandleTable(PEPROCESS pProcess
)
1256 PVOID pvMappedView
= NULL
;
1258 LARGE_INTEGER liOffset
;
1259 ULONG cjViewSize
= sizeof(GDI_HANDLE_TABLE
);
1261 liOffset
.QuadPart
= 0;
1263 ASSERT(gpvGdiHdlTblSection
!= NULL
);
1264 ASSERT(pProcess
!= NULL
);
1266 Status
= MmMapViewOfSection(gpvGdiHdlTblSection
,
1277 if (!NT_SUCCESS(Status
))
1280 return pvMappedView
;
1284 GDI_CleanupForProcess(struct _EPROCESS
*Process
)
1291 DPRINT("CleanupForProcess prochandle %x Pid %d\n",
1292 Process
, Process
->UniqueProcessId
);
1294 ASSERT(Process
== PsGetCurrentProcess());
1296 /* Get the current process Id */
1297 dwProcessId
= PtrToUlong(PsGetCurrentProcessId());
1299 /* Loop all handles in the handle table */
1300 for (ulIndex
= RESERVE_ENTRIES_COUNT
; ulIndex
< gulFirstUnused
; ulIndex
++)
1302 pentry
= &gpentHmgr
[ulIndex
];
1304 /* Check if the object is owned by the process */
1305 if (pentry
->ObjectOwner
.ulObj
== dwProcessId
)
1307 ASSERT(pentry
->einfo
.pobj
->cExclusiveLock
== 0);
1309 /* Reference the object and delete it */
1310 InterlockedIncrement((LONG
*)&gpaulRefCount
[ulIndex
]);
1311 GDIOBJ_vDeleteObject(pentry
->einfo
.pobj
);
1317 DbgGdiHTIntegrityCheck();
1321 ppi
= PsGetCurrentProcessWin32Process();
1322 DPRINT("Completed cleanup for process %d\n", Process
->UniqueProcessId
);
1323 if (ppi
->GDIHandleCount
!= 0)
1325 DPRINT1("Leaking %d handles!\n", ppi
->GDIHandleCount
);
1329 /* Loop all handles in the handle table */
1330 for (ulIndex
= RESERVE_ENTRIES_COUNT
; ulIndex
< gulFirstUnused
; ulIndex
++)
1332 pentry
= &gpentHmgr
[ulIndex
];
1334 /* Check if the object is owned by the process */
1335 if (pentry
->ObjectOwner
.ulObj
== dwProcessId
)
1337 DPRINT1("Leaking object. Index=%lx, type=0x%x, refcount=%lx\n",
1338 ulIndex
, pentry
->Objt
, gpaulRefCount
[ulIndex
]);
1339 DBG_DUMP_EVENT_LIST(&pentry
->einfo
.pobj
->slhLog
);
1340 //DBG_CLEANUP_EVENT_LIST(&pentry->einfo.pobj->slhLog);