Intravision/reactos
1
0
Fork 0
mirror of https://github.com/reactos/reactos.git synced 2024-12-27 17:44:45 +00:00
Code Issues Projects Releases Packages Wiki Activity

added file/line# tracking to GDIOBJ locking & unlocking to help track down any remaining GDIOBJ locking issues.

Browse source 
svn path=/trunk/; revision=5373
This commit is contained in:
Royce Mitchell III 2003-08-01 20:54:03 +00:00
parent 786eaea3f0
commit 6779fdedf7
2 changed files with 186 additions and 116 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
reactos/include/win32k/gdiobj.h
View file

@ -78,6 +78,8 @@ typedef struct _GDI_HANDLE_ENTRY
WORD wMagic; WORD wMagic;
HANDLE hProcessId; HANDLE hProcessId;
PGDIOBJ pObject; PGDIOBJ pObject;
const char* lockfile;
int lockline;
} GDI_HANDLE_ENTRY, *PGDI_HANDLE_ENTRY; } GDI_HANDLE_ENTRY, *PGDI_HANDLE_ENTRY;
typedef struct _GDI_HANDLE_TABLE typedef struct _GDI_HANDLE_TABLE
@ -102,6 +104,18 @@ BOOL FASTCALL GDIOBJ_UnlockMultipleObj( PGDIMULTILOCK pList, INT nObj );
WORD FASTCALL GDIOBJ_GetHandleMagic (HGDIOBJ ObjectHandle); WORD FASTCALL GDIOBJ_GetHandleMagic (HGDIOBJ ObjectHandle);
VOID STDCALL W32kDumpGdiObjects( INT Pid ); VOID STDCALL W32kDumpGdiObjects( INT Pid );
// a couple macros for debugging GDIOBJ locking
#define GDIOBJ_LockObj(obj,mag) GDIOBJ_LockObjDbg(__FILE__,__LINE__,obj,mag)
#define GDIOBJ_UnlockObj(obj,mag) GDIOBJ_UnlockObjDbg(__FILE__,__LINE__,obj,mag)
#ifdef GDIOBJ_LockObj
PGDIOBJ FASTCALL GDIOBJ_LockObjDbg (const char* file, int line, HGDIOBJ Obj, WORD Magic);
#endif//GDIOBJ_LockObj
#ifdef GDIOBJ_UnlockObj
BOOL FASTCALL GDIOBJ_UnlockObjDbg (const char* file, int line, HGDIOBJ Obj, WORD Magic);
#endif//GDIOBJ_UnlockObj
#define GDIOBJFLAG_DEFAULT (0x0) #define GDIOBJFLAG_DEFAULT (0x0)
#define GDIOBJFLAG_IGNOREPID (0x1) #define GDIOBJFLAG_IGNOREPID (0x1)
#define GDIOBJFLAG_IGNORELOCK (0x2) #define GDIOBJFLAG_IGNORELOCK (0x2)

288
reactos/subsys/win32k/objects/gdiobj.c
View file

@ -19,7 +19,7 @@
/* /*
* GDIOBJ.C - GDI object manipulation routines * GDIOBJ.C - GDI object manipulation routines
* *
* $Id: gdiobj.c,v 1.30 2003/08/01 16:08:14 royce Exp $ * $Id: gdiobj.c,v 1.31 2003/08/01 20:54:03 royce Exp $
* *
*/ */
@ -92,9 +92,9 @@ static LOGFONTW AnsiFixedFont =
//static UINT align_AnsiFixedFont = 1; //static UINT align_AnsiFixedFont = 1;
static LOGFONTW AnsiVarFont = //static LOGFONTW AnsiVarFont =
{ 14, 0, 0, 0, FW_NORMAL, FALSE, FALSE, FALSE, ANSI_CHARSET, //{ 14, 0, 0, 0, FW_NORMAL, FALSE, FALSE, FALSE, ANSI_CHARSET,
0, 0, DEFAULT_QUALITY, VARIABLE_PITCH | FF_SWISS, L"MS Sans Serif" }; // 0, 0, DEFAULT_QUALITY, VARIABLE_PITCH | FF_SWISS, L"MS Sans Serif" };
//static UINT align_AnsiVarFont = 1; //static UINT align_AnsiVarFont = 1;
@ -208,7 +208,8 @@ GDIOBJ_iGetNextOpenHandleIndex (void)
* *
* \note Use GDIOBJ_Lock() to obtain pointer to the new object. * \note Use GDIOBJ_Lock() to obtain pointer to the new object.
*/ */
HGDIOBJ FASTCALL GDIOBJ_AllocObj(WORD Size, WORD Magic) HGDIOBJ FASTCALL
GDIOBJ_AllocObj(WORD Size, WORD Magic)
{ {
PGDIOBJHDR newObject; PGDIOBJHDR newObject;
PGDI_HANDLE_ENTRY handleEntry; PGDI_HANDLE_ENTRY handleEntry;
@ -228,6 +229,8 @@ HGDIOBJ FASTCALL GDIOBJ_AllocObj(WORD Size, WORD Magic)
handleEntry->wMagic = Magic; handleEntry->wMagic = Magic;
handleEntry->hProcessId = PsGetCurrentProcessId (); handleEntry->hProcessId = PsGetCurrentProcessId ();
handleEntry->pObject = newObject; handleEntry->pObject = newObject;
handleEntry->lockfile = NULL;
handleEntry->lockline = 0;
DPRINT("GDIOBJ_AllocObj: object handle %d\n", newObject->wTableIndex ); DPRINT("GDIOBJ_AllocObj: object handle %d\n", newObject->wTableIndex );
return GDI_INDEX2HANDLE(newObject->wTableIndex); return GDI_INDEX2HANDLE(newObject->wTableIndex);
} }
@ -246,7 +249,8 @@ HGDIOBJ FASTCALL GDIOBJ_AllocObj(WORD Size, WORD Magic)
* \note You should only use GDIOBJFLAG_IGNOREPID if you are cleaning up after the process that terminated. * \note You should only use GDIOBJFLAG_IGNOREPID if you are cleaning up after the process that terminated.
* \note This function deferres object deletion if it is still in use. * \note This function deferres object deletion if it is still in use.
*/ */
BOOL STDCALL GDIOBJ_FreeObj(HGDIOBJ hObj, WORD Magic, DWORD Flag) BOOL STDCALL
GDIOBJ_FreeObj(HGDIOBJ hObj, WORD Magic, DWORD Flag)
{ {
PGDIOBJHDR objectHeader; PGDIOBJHDR objectHeader;
PGDI_HANDLE_ENTRY handleEntry; PGDI_HANDLE_ENTRY handleEntry;
@ -318,49 +322,6 @@ BOOL STDCALL GDIOBJ_FreeObj(HGDIOBJ hObj, WORD Magic, DWORD Flag)
return TRUE; return TRUE;
} }
/*!
* Return pointer to the object by handle.
*
* \param hObj Object handle
* \param Magic one of the magic numbers defined in \ref GDI Magic
* \return Pointer to the object.
*
* \note Process can only get pointer to the objects it created or global objects.
*
* \todo Don't allow to lock the objects twice! Synchronization!
*/
PGDIOBJ FASTCALL GDIOBJ_LockObj( HGDIOBJ hObj, WORD Magic )
{
PGDI_HANDLE_ENTRY handleEntry
= GDIOBJ_iGetHandleEntryForIndex ( GDI_HANDLE2INDEX(hObj) );
PGDIOBJHDR objectHeader;
DPRINT("GDIOBJ_LockObj: hObj: %d, magic: %x, \n handleEntry: %x, mag %x\n", hObj, Magic, handleEntry, handleEntry->wMagic);
if ( handleEntry == 0
|| (handleEntry->wMagic != Magic && Magic != GO_MAGIC_DONTCARE )
|| (handleEntry->hProcessId != (HANDLE)0xFFFFFFFF
&& handleEntry->hProcessId != PsGetCurrentProcessId ()
)
)
{
DPRINT("GDIBOJ_LockObj failed for %d, magic: %d, reqMagic\n",(WORD) hObj & 0xffff, handleEntry->wMagic, Magic);
return NULL;
}
objectHeader = (PGDIOBJHDR) handleEntry->pObject;
ASSERT(objectHeader);
if( objectHeader->dwCount > 0 )
{
DbgPrint("Caution! GDIOBJ_LockObj trying to lock object second time\n" );
DbgPrint("\t called from: %x\n", __builtin_return_address(0));
}
ExAcquireFastMutex(&RefCountHandling);
objectHeader->dwCount++;
ExReleaseFastMutex(&RefCountHandling);
return (PGDIOBJ)((PCHAR)objectHeader + sizeof(GDIOBJHDR));
}
/*! /*!
* Lock multiple objects. Use this function when you need to lock multiple objects and some of them may be * Lock multiple objects. Use this function when you need to lock multiple objects and some of them may be
* duplicates. You should use this function to avoid trying to lock the same object twice! * duplicates. You should use this function to avoid trying to lock the same object twice!
@ -371,7 +332,8 @@ PGDIOBJ FASTCALL GDIOBJ_LockObj( HGDIOBJ hObj, WORD Magic )
* *
* \note this function uses an O(n^2) algoritm because we shouldn't need to call it with more than 3 or 4 objects. * \note this function uses an O(n^2) algoritm because we shouldn't need to call it with more than 3 or 4 objects.
*/ */
BOOL FASTCALL GDIOBJ_LockMultipleObj( PGDIMULTILOCK pList, INT nObj ) BOOL FASTCALL
GDIOBJ_LockMultipleObj( PGDIMULTILOCK pList, INT nObj )
{ {
INT i, j; INT i, j;
ASSERT( pList ); ASSERT( pList );
@ -394,64 +356,6 @@ BOOL FASTCALL GDIOBJ_LockMultipleObj( PGDIMULTILOCK pList, INT nObj )
return TRUE; return TRUE;
} }
/*!
* Release GDI object. Every object locked by GDIOBJ_LockObj() must be unlocked. You should unlock the object
* as soon as you don't need to have access to it's data.
* \param hObj Object handle
* \param Magic one of the magic numbers defined in \ref GDI Magic
*
* \note This function performs delayed cleanup. If the object is locked when GDI_FreeObj() is called
* then \em this function frees the object when reference count is zero.
*
* \todo Change synchronization algorithm.
*/
BOOL FASTCALL GDIOBJ_UnlockObj( HGDIOBJ hObj, WORD Magic )
{
PGDI_HANDLE_ENTRY handleEntry
= GDIOBJ_iGetHandleEntryForIndex ( GDI_HANDLE2INDEX(hObj) );
PGDIOBJHDR objectHeader;
DPRINT("GDIOBJ_UnlockObj: hObj: %d, magic: %x, \n handleEntry: %x\n", hObj, Magic, handleEntry);
if ( handleEntry == 0
|| (handleEntry->wMagic != Magic && Magic != GO_MAGIC_DONTCARE )
|| (handleEntry->hProcessId != (HANDLE)0xFFFFFFFF
&& handleEntry->hProcessId != PsGetCurrentProcessId ()
)
)
{
DPRINT( "GDIOBJ_UnLockObj: failed\n");
return FALSE;
}
objectHeader = (PGDIOBJHDR) handleEntry->pObject;
ASSERT(objectHeader);
ExAcquireFastMutex(&RefCountHandling);
if( ( objectHeader->dwCount & ~0x80000000 ) == 0 )
{
ExReleaseFastMutex(&RefCountHandling);
DPRINT( "GDIOBJ_UnLockObj: unlock object that is not locked\n" );
return FALSE;
}
objectHeader = (PGDIOBJHDR) handleEntry->pObject;
ASSERT(objectHeader);
objectHeader->dwCount--;
if( objectHeader->dwCount == 0x80000000 )
{
//delayed object release
objectHeader->dwCount = 0;
ExReleaseFastMutex(&RefCountHandling);
DPRINT("GDIOBJ_UnlockObj: delayed delete\n");
return GDIOBJ_FreeObj( hObj, Magic, GDIOBJFLAG_DEFAULT );
}
ExReleaseFastMutex(&RefCountHandling);
return TRUE;
}
/*! /*!
* Unlock multiple objects. Use this function when you need to unlock multiple objects and some of them may be * Unlock multiple objects. Use this function when you need to unlock multiple objects and some of them may be
* duplicates. * duplicates.
@ -461,7 +365,8 @@ BOOL FASTCALL GDIOBJ_UnlockObj( HGDIOBJ hObj, WORD Magic )
* *
* \note this function uses O(n^2) algoritm because we shouldn't need to call it with more than 3 or 4 objects. * \note this function uses O(n^2) algoritm because we shouldn't need to call it with more than 3 or 4 objects.
*/ */
BOOL FASTCALL GDIOBJ_UnlockMultipleObj( PGDIMULTILOCK pList, INT nObj ) BOOL FASTCALL
GDIOBJ_UnlockMultipleObj( PGDIMULTILOCK pList, INT nObj )
{ {
INT i, j; INT i, j;
ASSERT( pList ); ASSERT( pList );
@ -488,7 +393,8 @@ BOOL FASTCALL GDIOBJ_UnlockMultipleObj( PGDIMULTILOCK pList, INT nObj )
* *
* \note Only stock objects should be marked global. * \note Only stock objects should be marked global.
*/ */
VOID FASTCALL GDIOBJ_MarkObjectGlobal(HGDIOBJ ObjectHandle) VOID FASTCALL
GDIOBJ_MarkObjectGlobal(HGDIOBJ ObjectHandle)
{ {
PGDI_HANDLE_ENTRY handleEntry; PGDI_HANDLE_ENTRY handleEntry;
@ -507,7 +413,8 @@ VOID FASTCALL GDIOBJ_MarkObjectGlobal(HGDIOBJ ObjectHandle)
* \param ObjectHandle - handle of the object. * \param ObjectHandle - handle of the object.
* \return GDI Magic value. * \return GDI Magic value.
*/ */
WORD FASTCALL GDIOBJ_GetHandleMagic (HGDIOBJ ObjectHandle) WORD FASTCALL
GDIOBJ_GetHandleMagic (HGDIOBJ ObjectHandle)
{ {
PGDI_HANDLE_ENTRY handleEntry; PGDI_HANDLE_ENTRY handleEntry;
@ -542,7 +449,8 @@ InitGdiObjectHandleTable (VOID)
/*! /*!
* Creates a bunch of stock objects: brushes, pens, fonts. * Creates a bunch of stock objects: brushes, pens, fonts.
*/ */
VOID FASTCALL CreateStockObjects(void) VOID FASTCALL
CreateStockObjects(void)
{ {
// Create GDI Stock Objects from the logical structures we've defined // Create GDI Stock Objects from the logical structures we've defined
@ -587,7 +495,8 @@ VOID FASTCALL CreateStockObjects(void)
* \param Object - stock object id. * \param Object - stock object id.
* \return Handle to the object. * \return Handle to the object.
*/ */
HGDIOBJ STDCALL W32kGetStockObject(INT Object) HGDIOBJ STDCALL
W32kGetStockObject(INT Object)
{ {
// check when adding new objects // check when adding new objects
if( (Object < 0) || (Object >= NB_STOCK_OBJECTS) ) if( (Object < 0) || (Object >= NB_STOCK_OBJECTS) )
@ -600,7 +509,8 @@ HGDIOBJ STDCALL W32kGetStockObject(INT Object)
* \param hObject object handle * \param hObject object handle
* \return if the function fails the returned value is NULL. * \return if the function fails the returned value is NULL.
*/ */
BOOL STDCALL W32kDeleteObject(HGDIOBJ hObject) BOOL STDCALL
W32kDeleteObject(HGDIOBJ hObject)
{ {
return GDIOBJ_FreeObj( hObject, GO_MAGIC_DONTCARE, GDIOBJFLAG_DEFAULT ); return GDIOBJ_FreeObj( hObject, GO_MAGIC_DONTCARE, GDIOBJFLAG_DEFAULT );
} }
@ -609,7 +519,8 @@ BOOL STDCALL W32kDeleteObject(HGDIOBJ hObject)
* Internal function. Called when the process is destroyed to free the remaining GDI handles. * Internal function. Called when the process is destroyed to free the remaining GDI handles.
* \param Process - PID of the process that will be destroyed. * \param Process - PID of the process that will be destroyed.
*/ */
BOOL FASTCALL CleanupForProcess (struct _EPROCESS *Process, INT Pid) BOOL FASTCALL
CleanupForProcess (struct _EPROCESS *Process, INT Pid)
{ {
DWORD i; DWORD i;
PGDI_HANDLE_ENTRY handleEntry; PGDI_HANDLE_ENTRY handleEntry;
@ -640,7 +551,8 @@ BOOL FASTCALL CleanupForProcess (struct _EPROCESS *Process, INT Pid)
* \param If process == 0 dump all the objects. * \param If process == 0 dump all the objects.
* *
*/ */
VOID STDCALL W32kDumpGdiObjects( INT Process ) VOID STDCALL
W32kDumpGdiObjects( INT Process )
{ {
DWORD i; DWORD i;
PGDI_HANDLE_ENTRY handleEntry; PGDI_HANDLE_ENTRY handleEntry;
@ -655,4 +567,148 @@ VOID STDCALL W32kDumpGdiObjects( INT Process )
} }
} }
#define GDIOBJ_TRACKLOCKS
#ifdef GDIOBJ_LockObj
#undef GDIOBJ_LockObj
PGDIOBJ FASTCALL
GDIOBJ_LockObjDbg ( const char* file, int line, HGDIOBJ hObj, WORD Magic )
{
PGDIOBJ rc;
PGDI_HANDLE_ENTRY handleEntry
= GDIOBJ_iGetHandleEntryForIndex ( GDI_HANDLE2INDEX(hObj) );
if ( handleEntry->lockfile )
{
DbgPrint("Caution! GDIOBJ_LockObj trying to lock object (0x%x) second time\n", hObj );
DbgPrint("\tcalled from: %s:%i\n", file, line );
DbgPrint("\tpreviously locked from: %s:%i\n", handleEntry->lockfile, handleEntry->lockline );
}
//DbgPrint("(%s:%i) GDIOBJ_LockObj(0x%x,0x%x)\n", file, line, hObj, Magic );
rc = GDIOBJ_LockObj(hObj,Magic);
if ( rc && !handleEntry->lockfile )
{
handleEntry->lockfile = file;
handleEntry->lockline = line;
}
return rc;
}
#endif//GDIOBJ_LockObj
#ifdef GDIOBJ_UnlockObj
#undef GDIOBJ_UnlockObj
BOOL FASTCALL
GDIOBJ_UnlockObjDbg ( const char* file, int line, HGDIOBJ hObj, WORD Magic )
{
PGDI_HANDLE_ENTRY handleEntry
= GDIOBJ_iGetHandleEntryForIndex ( GDI_HANDLE2INDEX(hObj) );
//DbgPrint("(%s:%i) GDIOBJ_UnlockObj(0x%x,0x%x)\n", file, line, hObj, Magic );
handleEntry->lockfile = NULL;
handleEntry->lockline = 0;
return GDIOBJ_UnlockObj(hObj,Magic);
}
#endif//GDIOBJ_LockObj
/*!
* Return pointer to the object by handle.
*
* \param hObj Object handle
* \param Magic one of the magic numbers defined in \ref GDI Magic
* \return Pointer to the object.
*
* \note Process can only get pointer to the objects it created or global objects.
*
* \todo Don't allow to lock the objects twice! Synchronization!
*/
PGDIOBJ FASTCALL
GDIOBJ_LockObj( HGDIOBJ hObj, WORD Magic )
{
PGDI_HANDLE_ENTRY handleEntry
= GDIOBJ_iGetHandleEntryForIndex ( GDI_HANDLE2INDEX(hObj) );
PGDIOBJHDR objectHeader;
DPRINT("GDIOBJ_LockObj: hObj: %d, magic: %x, \n handleEntry: %x, mag %x\n", hObj, Magic, handleEntry, handleEntry->wMagic);
if ( handleEntry == 0
|| (handleEntry->wMagic != Magic && Magic != GO_MAGIC_DONTCARE )
|| (handleEntry->hProcessId != (HANDLE)0xFFFFFFFF
&& handleEntry->hProcessId != PsGetCurrentProcessId ()
)
)
{
DPRINT("GDIBOJ_LockObj failed for %d, magic: %d, reqMagic\n",(WORD) hObj & 0xffff, handleEntry->wMagic, Magic);
return NULL;
}
objectHeader = (PGDIOBJHDR) handleEntry->pObject;
ASSERT(objectHeader);
if( objectHeader->dwCount > 0 )
{
DbgPrint("Caution! GDIOBJ_LockObj trying to lock object (0x%x) second time\n", hObj );
DbgPrint("\t called from: %x\n", __builtin_return_address(0));
}
ExAcquireFastMutex(&RefCountHandling);
objectHeader->dwCount++;
ExReleaseFastMutex(&RefCountHandling);
return (PGDIOBJ)((PCHAR)objectHeader + sizeof(GDIOBJHDR));
}
/*!
* Release GDI object. Every object locked by GDIOBJ_LockObj() must be unlocked. You should unlock the object
* as soon as you don't need to have access to it's data.
* \param hObj Object handle
* \param Magic one of the magic numbers defined in \ref GDI Magic
*
* \note This function performs delayed cleanup. If the object is locked when GDI_FreeObj() is called
* then \em this function frees the object when reference count is zero.
*
* \todo Change synchronization algorithm.
*/
#undef GDIOBJ_UnlockObj
BOOL FASTCALL
GDIOBJ_UnlockObj( HGDIOBJ hObj, WORD Magic )
{
PGDI_HANDLE_ENTRY handleEntry
= GDIOBJ_iGetHandleEntryForIndex ( GDI_HANDLE2INDEX(hObj) );
PGDIOBJHDR objectHeader;
DPRINT("GDIOBJ_UnlockObj: hObj: %d, magic: %x, \n handleEntry: %x\n", hObj, Magic, handleEntry);
if ( handleEntry == 0
|| (handleEntry->wMagic != Magic && Magic != GO_MAGIC_DONTCARE )
|| (handleEntry->hProcessId != (HANDLE)0xFFFFFFFF
&& handleEntry->hProcessId != PsGetCurrentProcessId ()
)
)
{
DPRINT( "GDIOBJ_UnLockObj: failed\n");
return FALSE;
}
objectHeader = (PGDIOBJHDR) handleEntry->pObject;
ASSERT(objectHeader);
ExAcquireFastMutex(&RefCountHandling);
if( ( objectHeader->dwCount & ~0x80000000 ) == 0 )
{
ExReleaseFastMutex(&RefCountHandling);
DPRINT( "GDIOBJ_UnLockObj: unlock object (0x%x) that is not locked\n", hObj );
return FALSE;
}
objectHeader = (PGDIOBJHDR) handleEntry->pObject;
ASSERT(objectHeader);
objectHeader->dwCount--;
if( objectHeader->dwCount == 0x80000000 )
{
//delayed object release
objectHeader->dwCount = 0;
ExReleaseFastMutex(&RefCountHandling);
DPRINT("GDIOBJ_UnlockObj: delayed delete\n");
return GDIOBJ_FreeObj( hObj, Magic, GDIOBJFLAG_DEFAULT );
}
ExReleaseFastMutex(&RefCountHandling);
return TRUE;
}
/* EOF */ /* EOF */