simplification of irql manipulation in a couple of places - patch by Mike Nordell
[reactos.git] / reactos / subsys / win32k / objects / gdiobj.c
1 /*
2 * ReactOS W32 Subsystem
3 * Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003 ReactOS Team
4 *
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.
9 *
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.
14 *
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.
18 */
19 /*
20 * GDIOBJ.C - GDI object manipulation routines
21 *
22 * $Id: gdiobj.c,v 1.47 2003/10/16 03:26:51 vizzini Exp $
23 *
24 */
25
26 #undef WIN32_LEAN_AND_MEAN
27 #define WIN32_NO_STATUS
28 #include <windows.h>
29 #include <ddk/ntddk.h>
30 #include <include/dce.h>
31 #include <include/object.h>
32 #include <win32k/gdiobj.h>
33 #include <win32k/brush.h>
34 #include <win32k/pen.h>
35 #include <win32k/text.h>
36 #include <win32k/dc.h>
37 #include <win32k/bitmaps.h>
38 #include <win32k/region.h>
39 #include <win32k/cursoricon.h>
40 #include <include/palette.h>
41 #define NDEBUG
42 #include <win32k/debug1.h>
43
44 /*! Size of the GDI handle table
45 * http://www.windevnet.com/documents/s=7290/wdj9902b/9902b.htm
46 * gdi handle table can hold 0x4000 handles
47 */
48 #define GDI_HANDLE_COUNT 0x4000
49
50 #define GDI_GLOBAL_PROCESS ((HANDLE) 0xffffffff)
51
52 #define GDI_HANDLE_INDEX_MASK (GDI_HANDLE_COUNT - 1)
53 #define GDI_HANDLE_TYPE_MASK 0x007f0000
54 #define GDI_HANDLE_STOCK_MASK 0x00800000
55
56 #define GDI_HANDLE_CREATE(i, t) ((HANDLE)(((i) & GDI_HANDLE_INDEX_MASK) | ((t) & GDI_HANDLE_TYPE_MASK)))
57 #define GDI_HANDLE_GET_INDEX(h) (((DWORD)(h)) & GDI_HANDLE_INDEX_MASK)
58 #define GDI_HANDLE_GET_TYPE(h) (((DWORD)(h)) & GDI_HANDLE_TYPE_MASK)
59 #define GDI_HANDLE_IS_TYPE(h, t) ((t) == (((DWORD)(h)) & GDI_HANDLE_TYPE_MASK))
60 #define GDI_HANDLE_IS_STOCKOBJ(h) (0 != (((DWORD)(h)) & GDI_HANDLE_STOCK_MASK))
61 #define GDI_HANDLE_SET_STOCKOBJ(h) ((h) = (HANDLE)(((DWORD)(h)) | GDI_HANDLE_STOCK_MASK))
62
63 #define GDI_TYPE_TO_MAGIC(t) ((WORD) ((t) >> 16))
64 #define GDI_MAGIC_TO_TYPE(m) ((DWORD)(m) << 16)
65
66 #define GDI_VALID_OBJECT(h, obj, t, f) \
67 (NULL != (obj) \
68 && (GDI_MAGIC_TO_TYPE((obj)->Magic) == (t) || GDI_OBJECT_TYPE_DONTCARE == (t)) \
69 && (GDI_HANDLE_GET_TYPE((h)) == GDI_MAGIC_TO_TYPE((obj)->Magic)) \
70 && (((obj)->hProcessId == PsGetCurrentProcessId()) \
71 || (GDI_GLOBAL_PROCESS == (obj)->hProcessId) \
72 || ((f) & GDIOBJFLAG_IGNOREPID)))
73
74 typedef struct _GDI_HANDLE_TABLE
75 {
76 WORD wTableSize;
77 PGDIOBJHDR Handles[1];
78 } GDI_HANDLE_TABLE, *PGDI_HANDLE_TABLE;
79
80 /* GDI stock objects */
81
82 static LOGBRUSH WhiteBrush =
83 { BS_SOLID, RGB(255,255,255), 0 };
84
85 static LOGBRUSH LtGrayBrush =
86 /* FIXME : this should perhaps be BS_HATCHED, at least for 1 bitperpixel */
87 { BS_SOLID, RGB(192,192,192), 0 };
88
89 static LOGBRUSH GrayBrush =
90 /* FIXME : this should perhaps be BS_HATCHED, at least for 1 bitperpixel */
91 { BS_SOLID, RGB(128,128,128), 0 };
92
93 static LOGBRUSH DkGrayBrush =
94 /* This is BS_HATCHED, for 1 bitperpixel. This makes the spray work in pbrush */
95 /* NB_HATCH_STYLES is an index into HatchBrushes */
96 { BS_HATCHED, RGB(0,0,0), NB_HATCH_STYLES };
97
98 static LOGBRUSH BlackBrush =
99 { BS_SOLID, RGB(0,0,0), 0 };
100
101 static LOGBRUSH NullBrush =
102 { BS_NULL, 0, 0 };
103
104 static LOGPEN WhitePen =
105 { PS_SOLID, { 0, 0 }, RGB(255,255,255) };
106
107 static LOGPEN BlackPen =
108 { PS_SOLID, { 0, 0 }, RGB(0,0,0) };
109
110 static LOGPEN NullPen =
111 { PS_NULL, { 0, 0 }, 0 };
112
113 static LOGFONTW OEMFixedFont =
114 { 14, 0, 0, 0, FW_NORMAL, FALSE, FALSE, FALSE, OEM_CHARSET,
115 0, 0, DEFAULT_QUALITY, FIXED_PITCH | FF_MODERN, L"" };
116
117 static LOGFONTW AnsiFixedFont =
118 { 14, 0, 0, 0, FW_NORMAL, FALSE, FALSE, FALSE, ANSI_CHARSET,
119 0, 0, DEFAULT_QUALITY, FIXED_PITCH | FF_MODERN, L"" };
120
121 /*static LOGFONTW AnsiVarFont =
122 *{ 14, 0, 0, 0, FW_NORMAL, FALSE, FALSE, FALSE, ANSI_CHARSET,
123 * 0, 0, DEFAULT_QUALITY, VARIABLE_PITCH | FF_SWISS, L"MS Sans Serif" }; */
124
125 static LOGFONTW SystemFont =
126 { 14, 0, 0, 0, FW_NORMAL, FALSE, FALSE, FALSE, ANSI_CHARSET,
127 0, 0, DEFAULT_QUALITY, VARIABLE_PITCH | FF_SWISS, L"System" };
128
129 static LOGFONTW DeviceDefaultFont =
130 { 14, 0, 0, 0, FW_NORMAL, FALSE, FALSE, FALSE, ANSI_CHARSET,
131 0, 0, DEFAULT_QUALITY, VARIABLE_PITCH | FF_SWISS, L"" };
132
133 static LOGFONTW SystemFixedFont =
134 { 14, 0, 0, 0, FW_NORMAL, FALSE, FALSE, FALSE, ANSI_CHARSET,
135 0, 0, DEFAULT_QUALITY, FIXED_PITCH | FF_MODERN, L"" };
136
137 /* FIXME: Is this correct? */
138 static LOGFONTW DefaultGuiFont =
139 { 14, 0, 0, 0, FW_NORMAL, FALSE, FALSE, FALSE, ANSI_CHARSET,
140 0, 0, DEFAULT_QUALITY, VARIABLE_PITCH | FF_SWISS, L"MS Sans Serif" };
141
142 #define NB_STOCK_OBJECTS (DEFAULT_GUI_FONT + 1)
143
144 static HGDIOBJ *StockObjects[NB_STOCK_OBJECTS];
145 static PGDI_HANDLE_TABLE HandleTable = 0;
146 static FAST_MUTEX HandleTableMutex;
147 static FAST_MUTEX RefCountHandling;
148
149 /*!
150 * Allocate GDI object table.
151 * \param Size - number of entries in the object table.
152 * Notes:: Must be called at IRQL < DISPATCH_LEVEL.
153 */
154 static PGDI_HANDLE_TABLE FASTCALL
155 GDIOBJ_iAllocHandleTable (WORD Size)
156 {
157 PGDI_HANDLE_TABLE handleTable;
158
159 /* prevent APC delivery for the *FastMutexUnsafe calls */
160 const KIRQL PrevIrql = KfRaiseIrql(APC_LEVEL);
161 ExAcquireFastMutexUnsafe (&HandleTableMutex);
162 handleTable = ExAllocatePool(PagedPool,
163 sizeof(GDI_HANDLE_TABLE) +
164 sizeof(PGDIOBJ) * Size);
165 ASSERT( handleTable );
166 memset (handleTable,
167 0,
168 sizeof(GDI_HANDLE_TABLE) + sizeof(PGDIOBJ) * Size);
169 handleTable->wTableSize = Size;
170 ExReleaseFastMutexUnsafe (&HandleTableMutex);
171 KfLowerIrql(PrevIrql);
172
173 return handleTable;
174 }
175
176 /*!
177 * Returns the entry into the handle table by index.
178 */
179 static PGDIOBJHDR FASTCALL
180 GDIOBJ_iGetObjectForIndex(WORD TableIndex)
181 {
182 if (0 == TableIndex || HandleTable->wTableSize < TableIndex)
183 {
184 DPRINT1("Invalid TableIndex %u\n", (unsigned) TableIndex);
185 return NULL;
186 }
187
188 return HandleTable->Handles[TableIndex];
189 }
190
191 /*!
192 * Finds next free entry in the GDI handle table.
193 * \return index into the table is successful, zero otherwise.
194 */
195 static WORD FASTCALL
196 GDIOBJ_iGetNextOpenHandleIndex (void)
197 {
198 WORD tableIndex;
199
200 /* prevent APC delivery for the *FastMutexUnsafe calls */
201 const KIRQL PrevIrql = KfRaiseIrql(APC_LEVEL);
202 ExAcquireFastMutexUnsafe (&HandleTableMutex);
203 for (tableIndex = 1; tableIndex < HandleTable->wTableSize; tableIndex++)
204 {
205 if (NULL == HandleTable->Handles[tableIndex])
206 {
207 HandleTable->Handles[tableIndex] = (PGDIOBJHDR) -1;
208 break;
209 }
210 }
211 ExReleaseFastMutexUnsafe (&HandleTableMutex);
212 KfLowerIrql(PrevIrql);
213
214 return (tableIndex < HandleTable->wTableSize) ? tableIndex : 0;
215 }
216
217 /*!
218 * Allocate memory for GDI object and return handle to it.
219 *
220 * \param Size - size of the GDI object. This shouldn't to include the size of GDIOBJHDR.
221 * The actual amount of allocated memory is sizeof(GDIOBJHDR)+Size
222 * \param ObjectType - type of object \ref GDI object types
223 * \param CleanupProcPtr - Routine to be called on destruction of object
224 *
225 * \return Handle of the allocated object.
226 *
227 * \note Use GDIOBJ_Lock() to obtain pointer to the new object.
228 */
229 HGDIOBJ FASTCALL
230 GDIOBJ_AllocObj(WORD Size, DWORD ObjectType, GDICLEANUPPROC CleanupProc)
231 {
232 PGDIOBJHDR newObject;
233 WORD Index;
234
235 Index = GDIOBJ_iGetNextOpenHandleIndex ();
236 if (0 == Index)
237 {
238 DPRINT1("Out of GDI handles\n");
239 return NULL;
240 }
241
242 DPRINT("GDIOBJ_AllocObj: handle: %d, size: %d, type: 0x%08x\n", Index, Size, ObjectType);
243 newObject = ExAllocatePool(PagedPool, Size + sizeof (GDIOBJHDR));
244 if (newObject == NULL)
245 {
246 DPRINT1("GDIOBJ_AllocObj: failed\n");
247 return NULL;
248 }
249 RtlZeroMemory (newObject, Size + sizeof(GDIOBJHDR));
250
251 newObject->wTableIndex = Index;
252
253 newObject->dwCount = 0;
254 newObject->hProcessId = PsGetCurrentProcessId ();
255 newObject->CleanupProc = CleanupProc;
256 newObject->Magic = GDI_TYPE_TO_MAGIC(ObjectType);
257 newObject->lockfile = NULL;
258 newObject->lockline = 0;
259 HandleTable->Handles[Index] = newObject;
260
261 return GDI_HANDLE_CREATE(Index, ObjectType);
262 }
263
264 /*!
265 * Free memory allocated for the GDI object. For each object type this function calls the
266 * appropriate cleanup routine.
267 *
268 * \param hObj - handle of the object to be deleted.
269 * \param ObjectType - one of the \ref GDI object types
270 * or GDI_OBJECT_TYPE_DONTCARE.
271 * \param Flag - if set to GDIOBJFLAG_IGNOREPID then the routine doesn't check if the process that
272 * tries to delete the object is the same one that created it.
273 *
274 * \return Returns TRUE if succesful.
275 *
276 * \note You should only use GDIOBJFLAG_IGNOREPID if you are cleaning up after the process that terminated.
277 * \note This function deferres object deletion if it is still in use.
278 */
279 BOOL STDCALL
280 GDIOBJ_FreeObj(HGDIOBJ hObj, DWORD ObjectType, DWORD Flag)
281 {
282 PGDIOBJHDR objectHeader;
283 PGDIOBJ Obj;
284 BOOL bRet = TRUE;
285
286 objectHeader = GDIOBJ_iGetObjectForIndex(GDI_HANDLE_GET_INDEX(hObj));
287 DPRINT("GDIOBJ_FreeObj: hObj: 0x%08x, object: %x\n", hObj, objectHeader);
288
289 if (! GDI_VALID_OBJECT(hObj, objectHeader, ObjectType, Flag)
290 || GDI_GLOBAL_PROCESS == objectHeader->hProcessId)
291
292 {
293 DPRINT1("Can't delete hObj:0x%08x, type:0x%08x, flag:%d\n", hObj, ObjectType, Flag);
294 return FALSE;
295 }
296
297 DPRINT("FreeObj: locks: %x\n", objectHeader->dwCount );
298 if (!(Flag & GDIOBJFLAG_IGNORELOCK))
299 {
300 /* check that the reference count is zero. if not then set flag
301 * and delete object when releaseobj is called */
302 ExAcquireFastMutex(&RefCountHandling);
303 if ((objectHeader->dwCount & ~0x80000000) > 0 )
304 {
305 DPRINT("GDIOBJ_FreeObj: delayed object deletion: count %d\n", objectHeader->dwCount);
306 objectHeader->dwCount |= 0x80000000;
307 ExReleaseFastMutex(&RefCountHandling);
308 return TRUE;
309 }
310 ExReleaseFastMutex(&RefCountHandling);
311 }
312
313 /* allow object to delete internal data */
314 if (NULL != objectHeader->CleanupProc)
315 {
316 Obj = (PGDIOBJ)((PCHAR)objectHeader + sizeof(GDIOBJHDR));
317 bRet = (*(objectHeader->CleanupProc))(Obj);
318 }
319
320 ExFreePool(objectHeader);
321 HandleTable->Handles[GDI_HANDLE_GET_INDEX(hObj)] = NULL;
322
323 return bRet;
324 }
325
326 /*!
327 * Lock multiple objects. Use this function when you need to lock multiple objects and some of them may be
328 * duplicates. You should use this function to avoid trying to lock the same object twice!
329 *
330 * \param pList pointer to the list that contains handles to the objects. You should set hObj and ObjectType fields.
331 * \param nObj number of objects to lock
332 * \return for each entry in pList this function sets pObj field to point to the object.
333 *
334 * \note this function uses an O(n^2) algoritm because we shouldn't need to call it with more than 3 or 4 objects.
335 */
336 BOOL FASTCALL
337 GDIOBJ_LockMultipleObj(PGDIMULTILOCK pList, INT nObj)
338 {
339 INT i, j;
340 ASSERT( pList );
341 /* FIXME - check for "invalid" handles */
342 /* go through the list checking for duplicate objects */
343 for (i = 0; i < nObj; i++)
344 {
345 pList[i].pObj = NULL;
346 for (j = 0; j < i; j++)
347 {
348 if (pList[i].hObj == pList[j].hObj)
349 {
350 /* already locked, so just copy the pointer to the object */
351 pList[i].pObj = pList[j].pObj;
352 break;
353 }
354 }
355
356 if (NULL == pList[i].pObj)
357 {
358 /* object hasn't been locked, so lock it. */
359 if (NULL != pList[i].hObj)
360 {
361 pList[i].pObj = GDIOBJ_LockObj(pList[i].hObj, pList[i].ObjectType);
362 }
363 }
364 }
365
366 return TRUE;
367 }
368
369 /*!
370 * Unlock multiple objects. Use this function when you need to unlock multiple objects and some of them may be
371 * duplicates.
372 *
373 * \param pList pointer to the list that contains handles to the objects. You should set hObj and ObjectType fields.
374 * \param nObj number of objects to lock
375 *
376 * \note this function uses O(n^2) algoritm because we shouldn't need to call it with more than 3 or 4 objects.
377 */
378 BOOL FASTCALL
379 GDIOBJ_UnlockMultipleObj(PGDIMULTILOCK pList, INT nObj)
380 {
381 INT i, j;
382 ASSERT(pList);
383
384 /* go through the list checking for duplicate objects */
385 for (i = 0; i < nObj; i++)
386 {
387 if (NULL != pList[i].pObj)
388 {
389 for (j = i + 1; j < nObj; j++)
390 {
391 if ((pList[i].pObj == pList[j].pObj))
392 {
393 /* set the pointer to zero for all duplicates */
394 pList[j].pObj = NULL;
395 }
396 }
397 GDIOBJ_UnlockObj(pList[i].hObj, pList[i].ObjectType);
398 pList[i].pObj = NULL;
399 }
400 }
401
402 return TRUE;
403 }
404
405 /*!
406 * Marks the object as global. (Creator process ID is set to GDI_GLOBAL_PROCESS). Global objects may be
407 * accessed by any process.
408 * \param ObjectHandle - handle of the object to make global.
409 *
410 * \note Only stock objects should be marked global.
411 */
412 VOID FASTCALL
413 GDIOBJ_MarkObjectGlobal(HGDIOBJ ObjectHandle)
414 {
415 PGDIOBJHDR ObjHdr;
416
417 DPRINT("GDIOBJ_MarkObjectGlobal handle 0x%08x\n", ObjectHandle);
418 ObjHdr = GDIOBJ_iGetObjectForIndex(GDI_HANDLE_GET_INDEX(ObjectHandle));
419 if (NULL == ObjHdr)
420 {
421 return;
422 }
423
424 ObjHdr->hProcessId = GDI_GLOBAL_PROCESS;
425 }
426
427 /*!
428 * Removes the global mark from the object. Global objects may be
429 * accessed by any process.
430 * \param ObjectHandle - handle of the object to make local.
431 *
432 * \note Only stock objects should be marked global.
433 */
434 VOID FASTCALL
435 GDIOBJ_UnmarkObjectGlobal(HGDIOBJ ObjectHandle)
436 {
437 PGDIOBJHDR ObjHdr;
438
439 DPRINT("GDIOBJ_MarkObjectGlobal handle 0x%08x\n", ObjectHandle);
440 ObjHdr = GDIOBJ_iGetObjectForIndex(GDI_HANDLE_GET_INDEX(ObjectHandle));
441 if (NULL == ObjHdr || GDI_GLOBAL_PROCESS != ObjHdr->hProcessId)
442 {
443 return;
444 }
445
446 ObjHdr->hProcessId = PsGetCurrentProcessId();
447 }
448
449 /*!
450 * Get the type of the object.
451 * \param ObjectHandle - handle of the object.
452 * \return One of the \ref GDI object types
453 */
454 DWORD FASTCALL
455 GDIOBJ_GetObjectType(HGDIOBJ ObjectHandle)
456 {
457 PGDIOBJHDR ObjHdr;
458
459 ObjHdr = GDIOBJ_iGetObjectForIndex(GDI_HANDLE_GET_INDEX(ObjectHandle));
460 if (NULL == ObjHdr
461 || ! GDI_VALID_OBJECT(ObjectHandle, ObjHdr, GDI_MAGIC_TO_TYPE(ObjHdr->Magic), 0))
462 {
463 DPRINT1("Invalid ObjectHandle 0x%08x\n", ObjectHandle);
464 return 0;
465 }
466 DPRINT("GDIOBJ_GetObjectType for handle 0x%08x returns 0x%08x\n", ObjectHandle,
467 GDI_MAGIC_TO_TYPE(ObjHdr->Magic));
468
469 return GDI_MAGIC_TO_TYPE(ObjHdr->Magic);
470 }
471
472 /*!
473 * Initialization of the GDI object engine.
474 */
475 VOID FASTCALL
476 InitGdiObjectHandleTable (VOID)
477 {
478 DPRINT("InitGdiObjectHandleTable\n");
479 ExInitializeFastMutex (&HandleTableMutex);
480 ExInitializeFastMutex (&RefCountHandling);
481
482 HandleTable = GDIOBJ_iAllocHandleTable (GDI_HANDLE_COUNT);
483 DPRINT("HandleTable: %x\n", HandleTable );
484
485 InitEngHandleTable();
486 }
487
488 /*!
489 * Creates a bunch of stock objects: brushes, pens, fonts.
490 */
491 VOID FASTCALL
492 CreateStockObjects(void)
493 {
494 unsigned Object;
495
496 DPRINT("Beginning creation of stock objects\n");
497
498 /* Create GDI Stock Objects from the logical structures we've defined */
499
500 StockObjects[WHITE_BRUSH] = NtGdiCreateBrushIndirect(&WhiteBrush);
501 StockObjects[LTGRAY_BRUSH] = NtGdiCreateBrushIndirect(&LtGrayBrush);
502 StockObjects[GRAY_BRUSH] = NtGdiCreateBrushIndirect(&GrayBrush);
503 StockObjects[DKGRAY_BRUSH] = NtGdiCreateBrushIndirect(&DkGrayBrush);
504 StockObjects[BLACK_BRUSH] = NtGdiCreateBrushIndirect(&BlackBrush);
505 StockObjects[NULL_BRUSH] = NtGdiCreateBrushIndirect(&NullBrush);
506
507 StockObjects[WHITE_PEN] = NtGdiCreatePenIndirect(&WhitePen);
508 StockObjects[BLACK_PEN] = NtGdiCreatePenIndirect(&BlackPen);
509 StockObjects[NULL_PEN] = NtGdiCreatePenIndirect(&NullPen);
510
511 (void) TextIntCreateFontIndirect(&OEMFixedFont, (HFONT*)&StockObjects[OEM_FIXED_FONT]);
512 (void) TextIntCreateFontIndirect(&AnsiFixedFont, (HFONT*)&StockObjects[ANSI_FIXED_FONT]);
513 (void) TextIntCreateFontIndirect(&SystemFont, (HFONT*)&StockObjects[SYSTEM_FONT]);
514 (void) TextIntCreateFontIndirect(&DeviceDefaultFont, (HFONT*)&StockObjects[DEVICE_DEFAULT_FONT]);
515 (void) TextIntCreateFontIndirect(&SystemFixedFont, (HFONT*)&StockObjects[SYSTEM_FIXED_FONT]);
516 (void) TextIntCreateFontIndirect(&DefaultGuiFont, (HFONT*)&StockObjects[DEFAULT_GUI_FONT]);
517
518 StockObjects[DEFAULT_PALETTE] = (HGDIOBJ*)PALETTE_Init();
519
520 for (Object = 0; Object < NB_STOCK_OBJECTS; Object++)
521 {
522 if (NULL != StockObjects[Object])
523 {
524 GDIOBJ_MarkObjectGlobal(StockObjects[Object]);
525 /* GDI_HANDLE_SET_STOCKOBJ(StockObjects[Object]);*/
526 }
527 }
528
529 DPRINT("Completed creation of stock objects\n");
530 }
531
532 /*!
533 * Return stock object.
534 * \param Object - stock object id.
535 * \return Handle to the object.
536 */
537 HGDIOBJ STDCALL
538 NtGdiGetStockObject(INT Object)
539 {
540 DPRINT("NtGdiGetStockObject index %d\n", Object);
541
542 return ((Object < 0) || (NB_STOCK_OBJECTS <= Object)) ? NULL : StockObjects[Object];
543 }
544
545 /*!
546 * Delete GDI object
547 * \param hObject object handle
548 * \return if the function fails the returned value is FALSE.
549 */
550 BOOL STDCALL
551 NtGdiDeleteObject(HGDIOBJ hObject)
552 {
553 DPRINT("NtGdiDeleteObject handle 0x%08x\n", hObject);
554
555 return GDIOBJ_FreeObj(hObject, GDI_OBJECT_TYPE_DONTCARE, GDIOBJFLAG_DEFAULT);
556 }
557
558 /*!
559 * Internal function. Called when the process is destroyed to free the remaining GDI handles.
560 * \param Process - PID of the process that will be destroyed.
561 */
562 BOOL FASTCALL
563 CleanupForProcess (struct _EPROCESS *Process, INT Pid)
564 {
565 DWORD i;
566 PGDIOBJHDR objectHeader;
567 PEPROCESS CurrentProcess;
568
569 DPRINT("Starting CleanupForProcess prochandle %x Pid %d\n", Process, Pid);
570 CurrentProcess = PsGetCurrentProcess();
571 if (CurrentProcess != Process)
572 {
573 KeAttachProcess(Process);
574 }
575
576 for(i = 1; i < HandleTable->wTableSize; i++)
577 {
578 objectHeader = GDIOBJ_iGetObjectForIndex(i);
579 if (NULL != objectHeader &&
580 (INT) objectHeader->hProcessId == Pid)
581 {
582 DPRINT("CleanupForProcess: %d, process: %d, locks: %d, magic: 0x%x", i, objectHeader->hProcessId, objectHeader->dwCount, objectHeader->Magic);
583 GDIOBJ_FreeObj(GDI_HANDLE_CREATE(i, GDI_MAGIC_TO_TYPE(objectHeader->Magic)),
584 GDI_MAGIC_TO_TYPE(objectHeader->Magic),
585 GDIOBJFLAG_IGNOREPID | GDIOBJFLAG_IGNORELOCK);
586 }
587 }
588
589 if (CurrentProcess != Process)
590 {
591 KeDetachProcess();
592 }
593
594 DPRINT("Completed cleanup for process %d\n", Pid);
595
596 return TRUE;
597 }
598
599 #define GDIOBJ_TRACKLOCKS
600
601 #ifdef GDIOBJ_LockObj
602 #undef GDIOBJ_LockObj
603 PGDIOBJ FASTCALL
604 GDIOBJ_LockObjDbg (const char* file, int line, HGDIOBJ hObj, DWORD ObjectType)
605 {
606 PGDIOBJ rc;
607 PGDIOBJHDR ObjHdr = GDIOBJ_iGetObjectForIndex(GDI_HANDLE_GET_INDEX(hObj));
608
609 if (! GDI_VALID_OBJECT(hObj, ObjHdr, ObjectType, GDIOBJFLAG_DEFAULT))
610 {
611 int reason = 0;
612 if (NULL == ObjHdr)
613 {
614 reason = 1;
615 }
616 else if (GDI_MAGIC_TO_TYPE(ObjHdr->Magic) != ObjectType && ObjectType != GDI_OBJECT_TYPE_DONTCARE)
617 {
618 reason = 2;
619 }
620 else if (ObjHdr->hProcessId != GDI_GLOBAL_PROCESS
621 && ObjHdr->hProcessId != PsGetCurrentProcessId())
622 {
623 reason = 3;
624 }
625 else if (GDI_HANDLE_GET_TYPE(hObj) != ObjectType && ObjectType != GDI_OBJECT_TYPE_DONTCARE)
626 {
627 reason = 4;
628 }
629 DPRINT1("GDIOBJ_LockObj failed for 0x%08x, reqtype 0x%08x reason %d\n",
630 hObj, ObjectType, reason );
631 DPRINT1("\tcalled from: %s:%i\n", file, line );
632 return NULL;
633 }
634 if (NULL != ObjHdr->lockfile)
635 {
636 DPRINT1("Caution! GDIOBJ_LockObj trying to lock object (0x%x) second time\n", hObj );
637 DPRINT1("\tcalled from: %s:%i\n", file, line );
638 DPRINT1("\tpreviously locked from: %s:%i\n", ObjHdr->lockfile, ObjHdr->lockline );
639 }
640 DPRINT("(%s:%i) GDIOBJ_LockObj(0x%08x,0x%08x)\n", file, line, hObj, ObjectType);
641 rc = GDIOBJ_LockObj(hObj, ObjectType);
642 if (rc && NULL == ObjHdr->lockfile)
643 {
644 ObjHdr->lockfile = file;
645 ObjHdr->lockline = line;
646 }
647
648 return rc;
649 }
650 #endif//GDIOBJ_LockObj
651
652 #ifdef GDIOBJ_UnlockObj
653 #undef GDIOBJ_UnlockObj
654 BOOL FASTCALL
655 GDIOBJ_UnlockObjDbg (const char* file, int line, HGDIOBJ hObj, DWORD ObjectType)
656 {
657 PGDIOBJHDR ObjHdr = GDIOBJ_iGetObjectForIndex(GDI_HANDLE_GET_INDEX(hObj));
658
659 if (! GDI_VALID_OBJECT(hObj, ObjHdr, ObjectType, GDIOBJFLAG_DEFAULT))
660 {
661 DPRINT1("GDIBOJ_UnlockObj failed for 0x%08x, reqtype 0x%08x\n",
662 hObj, ObjectType);
663 DPRINT1("\tcalled from: %s:%i\n", file, line);
664 return FALSE;
665 }
666 DPRINT("(%s:%i) GDIOBJ_UnlockObj(0x%08x,0x%08x)\n", file, line, hObj, ObjectType);
667 ObjHdr->lockfile = NULL;
668 ObjHdr->lockline = 0;
669
670 return GDIOBJ_UnlockObj(hObj, ObjectType);
671 }
672 #endif//GDIOBJ_LockObj
673
674 /*!
675 * Return pointer to the object by handle.
676 *
677 * \param hObj Object handle
678 * \param ObjectType one of the object types defined in \ref GDI object types
679 * \return Pointer to the object.
680 *
681 * \note Process can only get pointer to the objects it created or global objects.
682 *
683 * \todo Don't allow to lock the objects twice! Synchronization!
684 */
685 PGDIOBJ FASTCALL
686 GDIOBJ_LockObj(HGDIOBJ hObj, DWORD ObjectType)
687 {
688 PGDIOBJHDR ObjHdr = GDIOBJ_iGetObjectForIndex(GDI_HANDLE_GET_INDEX(hObj));
689
690 DPRINT("GDIOBJ_LockObj: hObj: 0x%08x, type: 0x%08x, objhdr: %x\n", hObj, ObjectType, ObjHdr);
691 if (! GDI_VALID_OBJECT(hObj, ObjHdr, ObjectType, GDIOBJFLAG_DEFAULT))
692 {
693 DPRINT1("GDIBOJ_LockObj failed for 0x%08x, type 0x%08x\n",
694 hObj, ObjectType);
695 return NULL;
696 }
697
698 if(0 < ObjHdr->dwCount)
699 {
700 DPRINT1("Caution! GDIOBJ_LockObj trying to lock object (0x%x) second time\n", hObj);
701 DPRINT1("\t called from: %x\n", __builtin_return_address(0));
702 }
703
704 ExAcquireFastMutex(&RefCountHandling);
705 ObjHdr->dwCount++;
706 ExReleaseFastMutex(&RefCountHandling);
707 return (PGDIOBJ)((PCHAR)ObjHdr + sizeof(GDIOBJHDR));
708 }
709
710 /*!
711 * Release GDI object. Every object locked by GDIOBJ_LockObj() must be unlocked. You should unlock the object
712 * as soon as you don't need to have access to it's data.
713
714 * \param hObj Object handle
715 * \param ObjectType one of the object types defined in \ref GDI object types
716 *
717 * \note This function performs delayed cleanup. If the object is locked when GDI_FreeObj() is called
718 * then \em this function frees the object when reference count is zero.
719 *
720 * \todo Change synchronization algorithm.
721 */
722 #undef GDIOBJ_UnlockObj
723 BOOL FASTCALL
724 GDIOBJ_UnlockObj(HGDIOBJ hObj, DWORD ObjectType)
725 {
726 PGDIOBJHDR ObjHdr = GDIOBJ_iGetObjectForIndex(GDI_HANDLE_GET_INDEX(hObj));
727
728 DPRINT("GDIOBJ_UnlockObj: hObj: 0x%08x, type: 0x%08x, objhdr: %x\n", hObj, ObjectType, ObjHdr);
729 if (! GDI_VALID_OBJECT(hObj, ObjHdr, ObjectType, GDIOBJFLAG_DEFAULT))
730 {
731 DPRINT1( "GDIOBJ_UnLockObj: failed\n");
732 return FALSE;
733 }
734
735 ExAcquireFastMutex(&RefCountHandling);
736 if (0 == (ObjHdr->dwCount & ~0x80000000))
737 {
738 ExReleaseFastMutex(&RefCountHandling);
739 DPRINT1( "GDIOBJ_UnLockObj: unlock object (0x%x) that is not locked\n", hObj );
740 return FALSE;
741 }
742
743 ObjHdr->dwCount--;
744
745 if (ObjHdr->dwCount == 0x80000000)
746 {
747 //delayed object release
748 ObjHdr->dwCount = 0;
749 ExReleaseFastMutex(&RefCountHandling);
750 DPRINT("GDIOBJ_UnlockObj: delayed delete\n");
751 return GDIOBJ_FreeObj(hObj, ObjectType, GDIOBJFLAG_DEFAULT);
752 }
753 ExReleaseFastMutex(&RefCountHandling);
754
755 return TRUE;
756 }
757
758 /* EOF */