2 * COPYRIGHT: See COPYING in the top level directory
3 * PROJECT: ReactOS kernel
4 * FILE: lib/opengl32/opengl32.c
5 * PURPOSE: OpenGL32 lib
6 * PROGRAMMER: Anich Gregor (blight), Royce Mitchell III
13 /* function prototypes */
14 static void OPENGL32_AppendICD( GLDRIVERDATA
*icd
);
15 static void OPENGL32_RemoveICD( GLDRIVERDATA
*icd
);
16 static GLDRIVERDATA
*OPENGL32_LoadDriver( LPCWSTR regKey
);
17 static DWORD
OPENGL32_InitializeDriver( GLDRIVERDATA
*icd
);
18 static BOOL
OPENGL32_UnloadDriver( GLDRIVERDATA
*icd
);
19 static DWORD
OPENGL32_RegGetDriverInfo( LPCWSTR driver
, GLDRIVERDATA
*icd
);
23 /* Do not assume it have the free value -1 set, any value can be in here */
24 DWORD OPENGL32_tls
= -1U;
25 GLPROCESSDATA OPENGL32_processdata
;
29 OPENGL32_ThreadAttach( void )
31 GLTHREADDATA
* lpData
= NULL
;
32 PROC
*dispatchTable
= NULL
;
35 dispatchTable
= (PROC
*)HeapAlloc( GetProcessHeap(),
36 HEAP_GENERATE_EXCEPTIONS
| HEAP_ZERO_MEMORY
,
37 sizeof (((ICDTable
*)(0))->dispatch_table
) );
38 if (dispatchTable
== NULL
)
40 DBGPRINT( "Error: Couldn't allocate GL dispatch table" );
44 lpData
= (GLTHREADDATA
*)HeapAlloc( GetProcessHeap(),
45 HEAP_GENERATE_EXCEPTIONS
| HEAP_ZERO_MEMORY
,
46 sizeof (GLTHREADDATA
) );
49 DBGPRINT( "Error: Couldn't allocate GLTHREADDATA" );
50 HeapFree( GetProcessHeap(), 0, dispatchTable
);
56 /* initialize dispatch table with empty functions */
57 #define X(func, ret, typeargs, args, icdidx, tebidx, stack) \
58 dispatchTable[icdidx] = (PROC)glEmptyFunc##stack; \
60 teb->glDispatchTable[tebidx] = (PVOID)glEmptyFunc##stack;
64 teb
->glTable
= dispatchTable
;
65 TlsSetValue( OPENGL32_tls
, lpData
);
72 OPENGL32_ThreadDetach( void )
74 GLTHREADDATA
* lpData
= NULL
;
75 PROC
*dispatchTable
= NULL
;
77 rosglMakeCurrent( NULL
, NULL
);
79 lpData
= (GLTHREADDATA
*)TlsGetValue( OPENGL32_tls
);
82 if (!HeapFree( GetProcessHeap(), 0, lpData
))
83 DBGPRINT( "Warning: HeapFree() on GLTHREADDATA failed (%d)",
88 dispatchTable
= NtCurrentTeb()->glTable
;
89 if (dispatchTable
!= NULL
)
91 if (!HeapFree( GetProcessHeap(), 0, dispatchTable
))
92 DBGPRINT( "Warning: HeapFree() on dispatch table failed (%d)",
99 OPENGL32_ProcessAttach( void )
101 SECURITY_ATTRIBUTES attrib
= { sizeof (SECURITY_ATTRIBUTES
), /* nLength */
102 NULL
, /* lpSecurityDescriptor */
103 TRUE
/* bInheritHandle */ };
105 OPENGL32_tls
= TlsAlloc();
106 if (-1U == OPENGL32_tls
)
109 memset( &OPENGL32_processdata
, 0, sizeof (OPENGL32_processdata
) );
111 /* create driver, glrc & dcdata list mutex */
112 OPENGL32_processdata
.driver_mutex
= CreateMutex( &attrib
, FALSE
, NULL
);
113 if (OPENGL32_processdata
.driver_mutex
== NULL
)
115 DBGPRINT( "Error: Couldn't create driver_list mutex (%d)",
119 OPENGL32_processdata
.glrc_mutex
= CreateMutex( &attrib
, FALSE
, NULL
);
120 if (OPENGL32_processdata
.glrc_mutex
== NULL
)
122 DBGPRINT( "Error: Couldn't create glrc_list mutex (%d)",
126 OPENGL32_processdata
.dcdata_mutex
= CreateMutex( &attrib
, FALSE
, NULL
);
127 if (OPENGL32_processdata
.dcdata_mutex
== NULL
)
129 DBGPRINT( "Error: Couldn't create dcdata_list mutex (%d)",
139 OPENGL32_ProcessDetach( void )
141 GLDRIVERDATA
*icd
, *icd2
;
142 GLDCDATA
*dcdata
, *dcdata2
;
146 for (dcdata
= OPENGL32_processdata
.dcdata_list
; dcdata
!= NULL
;)
149 dcdata
= dcdata
->next
;
150 if (!HeapFree( GetProcessHeap(), 0, dcdata2
))
151 DBGPRINT( "Warning: HeapFree() on DCDATA 0x%08x failed (%d)",
152 dcdata2
, GetLastError() );
155 for (glrc
= OPENGL32_processdata
.glrc_list
; glrc
!= NULL
;)
159 if (!HeapFree( GetProcessHeap(), 0, glrc2
))
160 DBGPRINT( "Warning: HeapFree() on GLRC 0x%08x failed (%d)",
161 glrc2
, GetLastError() );
164 for (icd
= OPENGL32_processdata
.driver_list
; icd
!= NULL
;)
168 if (!HeapFree( GetProcessHeap(), 0, icd2
))
169 DBGPRINT( "Warning: HeapFree() on DRIVERDATA 0x%08x failed (%d)",
170 icd2
, GetLastError() );
174 if (OPENGL32_processdata
.driver_mutex
!= NULL
)
175 CloseHandle( OPENGL32_processdata
.driver_mutex
);
176 if (OPENGL32_processdata
.glrc_mutex
!= NULL
)
177 CloseHandle( OPENGL32_processdata
.glrc_mutex
);
178 if (OPENGL32_processdata
.dcdata_mutex
!= NULL
)
179 CloseHandle( OPENGL32_processdata
.dcdata_mutex
);
182 if (OPENGL32_tls
!= -1U)
183 TlsFree(OPENGL32_tls
);
188 DllMain(HINSTANCE hInstance
, DWORD Reason
, LPVOID Reserved
)
190 DBGPRINT( "Info: Called!" );
193 /* The DLL is loading due to process
194 * initialization or a call to LoadLibrary.
196 case DLL_PROCESS_ATTACH
:
197 DBGTRACE( "Process attach" );
198 if (!OPENGL32_ProcessAttach())
200 /* No break: Initialize the index for first thread. */
202 /* The attached process creates a new thread. */
203 case DLL_THREAD_ATTACH
:
204 DBGTRACE( "Thread attach" );
205 if (!OPENGL32_ThreadAttach())
209 /* The thread of the attached process terminates. */
210 case DLL_THREAD_DETACH
:
211 DBGTRACE( "Thread detach" );
212 /* Release the allocated memory for this thread.*/
213 OPENGL32_ThreadDetach();
216 /* DLL unload due to process termination or FreeLibrary. */
217 case DLL_PROCESS_DETACH
:
218 DBGTRACE( "Process detach" );
219 OPENGL32_ThreadDetach();
220 OPENGL32_ProcessDetach();
228 /*! \brief Append ICD to linked list.
230 * \param icd GLDRIVERDATA to append to list
232 * \note Only call this when you hold the driver_mutex.
235 OPENGL32_AppendICD( GLDRIVERDATA
*icd
)
237 if (OPENGL32_processdata
.driver_list
== NULL
)
238 OPENGL32_processdata
.driver_list
= icd
;
241 GLDRIVERDATA
*p
= OPENGL32_processdata
.driver_list
;
242 while (p
->next
!= NULL
)
249 /*! \brief Remove ICD from linked list.
251 * \param icd GLDRIVERDATA to remove from list
253 * \note Only call this when you hold the driver_mutex.
256 OPENGL32_RemoveICD( GLDRIVERDATA
*icd
)
258 if (icd
== OPENGL32_processdata
.driver_list
)
259 OPENGL32_processdata
.driver_list
= icd
->next
;
262 GLDRIVERDATA
*p
= OPENGL32_processdata
.driver_list
;
272 DBGPRINT( "Error: ICD 0x%08x not found in list!", icd
);
277 /*! \brief Load an ICD.
279 * \param driver Name of installable client driver.
281 * \return Pointer to an allocated GLDRIVERDATA struct.
282 * \retval NULL Failure.
284 * \todo Call SetLastError() where appropriate.
286 static GLDRIVERDATA
*
287 OPENGL32_LoadDriver( LPCWSTR driver
)
292 DBGPRINT( "Info: Loading driver %ws...", driver
);
294 /* allocate driver data */
295 icd
= (GLDRIVERDATA
*)HeapAlloc( GetProcessHeap(),
296 HEAP_GENERATE_EXCEPTIONS
| HEAP_ZERO_MEMORY
,
297 sizeof (GLDRIVERDATA
) );
300 DBGPRINT( "Error: Couldn't allocate GLDRIVERDATA! (%d)", GetLastError() );
304 ret
= OPENGL32_RegGetDriverInfo( driver
, icd
);
305 if (ret
!= ERROR_SUCCESS
)
307 DBGPRINT( "Error: Couldn't query driver information (%d)", ret
);
308 if (!HeapFree( GetProcessHeap(), 0, icd
))
309 DBGPRINT( "Error: HeapFree() returned false, error code = %d",
314 DBGPRINT( "Info: Dll = %ws", icd
->dll
);
315 DBGPRINT( "Info: Version = 0x%08x", icd
->version
);
316 DBGPRINT( "Info: DriverVersion = 0x%08x", icd
->driver_version
);
317 DBGPRINT( "Info: Flags = 0x%08x", icd
->flags
);
319 /* load/initialize ICD */
320 ret
= OPENGL32_InitializeDriver( icd
);
321 if (ret
!= ERROR_SUCCESS
)
323 DBGPRINT( "Error: Couldnt initialize ICD!" );
324 if (!HeapFree( GetProcessHeap(), 0, icd
))
325 DBGPRINT( "Error: HeapFree() returned false, error code = %d",
330 /* append ICD to list */
331 OPENGL32_AppendICD( icd
);
332 DBGPRINT( "Info: ICD loaded." );
338 /*! \brief Initialize a driver (Load DLL and DrvXxx procs)
340 * \param icd ICD to initialize with the dll, version, driverVersion
341 * and flags already filled.
342 * \return Error code.
343 * \retval ERROR_SUCCESS Success
345 #define LOAD_DRV_PROC( icd, proc, required ) \
346 *(char**)&icd->proc = (char*)GetProcAddress( icd->handle, #proc ); \
347 if (required && icd->proc == NULL) { \
348 DBGPRINT( "Error: GetProcAddress(\"%s\") failed!", #proc ); \
349 FreeLibrary( icd->handle ); \
350 return GetLastError(); \
354 OPENGL32_InitializeDriver( GLDRIVERDATA
*icd
)
357 if (icd
->version
> 2)
358 DBGPRINT( "Warning: ICD version > 2 (%d)", icd
->version
);
361 icd
->handle
= LoadLibraryW( icd
->dll
);
362 if (icd
->handle
== NULL
)
364 DWORD err
= GetLastError();
365 DBGPRINT( "Error: Couldn't load DLL! (%d)", err
);
369 /* validate version */
370 if (icd
->driver_version
> 1)
372 LOAD_DRV_PROC(icd
, DrvValidateVersion
, FALSE
);
373 if (icd
->DrvValidateVersion
!= NULL
)
375 if (!icd
->DrvValidateVersion( icd
->driver_version
))
377 DBGPRINT( "Error: DrvValidateVersion failed!" );
379 FreeLibrary( icd
->handle
);
380 return ERROR_INVALID_FUNCTION
; /* FIXME: use better error code */
384 DBGPRINT( "Info: DrvValidateVersion not exported by ICD" );
387 /* load DrvXXX procs */
388 LOAD_DRV_PROC(icd
, DrvCopyContext
, TRUE
);
389 LOAD_DRV_PROC(icd
, DrvCreateContext
, FALSE
);
390 LOAD_DRV_PROC(icd
, DrvCreateLayerContext
, FALSE
);
391 LOAD_DRV_PROC(icd
, DrvDeleteContext
, TRUE
);
392 LOAD_DRV_PROC(icd
, DrvDescribeLayerPlane
, TRUE
);
393 LOAD_DRV_PROC(icd
, DrvDescribePixelFormat
, TRUE
);
394 LOAD_DRV_PROC(icd
, DrvGetLayerPaletteEntries
, TRUE
);
395 LOAD_DRV_PROC(icd
, DrvGetProcAddress
, TRUE
);
396 LOAD_DRV_PROC(icd
, DrvReleaseContext
, TRUE
);
397 LOAD_DRV_PROC(icd
, DrvRealizeLayerPalette
, TRUE
);
398 LOAD_DRV_PROC(icd
, DrvSetContext
, TRUE
);
399 LOAD_DRV_PROC(icd
, DrvSetLayerPaletteEntries
, TRUE
);
400 LOAD_DRV_PROC(icd
, DrvSetPixelFormat
, TRUE
);
401 LOAD_DRV_PROC(icd
, DrvShareLists
, TRUE
);
402 LOAD_DRV_PROC(icd
, DrvSwapBuffers
, TRUE
);
403 LOAD_DRV_PROC(icd
, DrvSwapLayerBuffers
, TRUE
);
405 /* we require at least one of DrvCreateContext and DrvCreateLayerContext */
406 if (icd
->DrvCreateContext
== NULL
&& icd
->DrvCreateLayerContext
== NULL
)
408 DBGPRINT( "Error: One of DrvCreateContext/DrvCreateLayerContext is required!" );
409 FreeLibrary( icd
->handle
);
410 return ERROR_INVALID_FUNCTION
; /* FIXME: use better error code... */
413 return ERROR_SUCCESS
;
417 /*! \brief Unload ICD.
419 * \retval TRUE Success.
420 * \retval FALSE Failure.
423 OPENGL32_UnloadDriver( GLDRIVERDATA
*icd
)
427 DBGPRINT( "Info: Unloading driver %ws...", icd
->driver_name
);
428 if (icd
->refcount
!= 0)
429 DBGPRINT( "Warning: ICD refcount = %d (should be 0)", icd
->refcount
);
432 if (!FreeLibrary( icd
->handle
))
435 DBGPRINT( "Warning: FreeLibrary on ICD %ws failed! (%d)", icd
->dll
,
440 OPENGL32_RemoveICD( icd
);
441 if (!HeapFree( GetProcessHeap(), 0, icd
))
444 DBGPRINT( "Warning: HeapFree() returned FALSE, error code = %d",
452 /*! \brief Load ICD (shared ICD data)
454 * \return Pointer to an allocated GLDRIVERDATA on success.
455 * \retval NULL Failure.
458 OPENGL32_LoadICD( LPCWSTR driver
)
463 if (WaitForSingleObject( OPENGL32_processdata
.driver_mutex
, INFINITE
) ==
466 DBGPRINT( "Error: WaitForSingleObject() failed (%d)", GetLastError() );
467 return NULL
; /* FIXME: do we have to expect such an error and handle it? */
470 /* look if ICD is already loaded */
471 for (icd
= OPENGL32_processdata
.driver_list
; icd
; icd
= icd
->next
)
473 if (!_wcsicmp( driver
, icd
->driver_name
)) /* found */
478 if (!ReleaseMutex( OPENGL32_processdata
.driver_mutex
))
479 DBGPRINT( "Error: ReleaseMutex() failed (%d)", GetLastError() );
485 /* not found - try to load */
486 icd
= OPENGL32_LoadDriver( driver
);
491 if (!ReleaseMutex( OPENGL32_processdata
.driver_mutex
))
492 DBGPRINT( "Error: ReleaseMutex() failed (%d)", GetLastError() );
498 /*! \brief Unload ICD (shared ICD data)
500 * \retval TRUE Success.
501 * \retval FALSE Failure.
504 OPENGL32_UnloadICD( GLDRIVERDATA
*icd
)
509 if (WaitForSingleObject( OPENGL32_processdata
.driver_mutex
, INFINITE
) ==
512 DBGPRINT( "Error: WaitForSingleObject() failed (%d)", GetLastError() );
513 return FALSE
; /* FIXME: do we have to expect such an error and handle it? */
516 if (--icd
->refcount
== 0)
517 ret
= OPENGL32_UnloadDriver( icd
);
520 if (!ReleaseMutex( OPENGL32_processdata
.driver_mutex
))
521 DBGPRINT( "Error: ReleaseMutex() failed (%d)", GetLastError() );
527 /*! \brief Enumerate OpenGLDrivers (from registry)
529 * \param idx Index of the driver to get information about.
530 * \param name Pointer to an array of WCHARs (can be NULL)
531 * \param cName Pointer to a DWORD. Input is len of name array.
532 * Output is length of the drivername.
533 * Can be NULL if name is NULL.
536 * \retval ERROR_NO_MORE_ITEMS End of driver list.
537 * \retval ERROR_SUCCESS Success.
541 OPENGL32_RegEnumDrivers( DWORD idx
, LPWSTR name
, LPDWORD cName
)
544 LPCWSTR subKey
= OPENGL_DRIVERS_SUBKEY
;
550 return ERROR_SUCCESS
; /* nothing to do */
553 return ERROR_INVALID_FUNCTION
; /* we need cName when name is given */
555 /* open OpenGLDrivers registry key */
556 ret
= RegOpenKeyExW( HKEY_LOCAL_MACHINE
, subKey
, 0, KEY_READ
, &hKey
);
557 if (ret
!= ERROR_SUCCESS
)
559 DBGPRINT( "Error: Couldn't open registry key '%ws'", subKey
);
563 /* get subkey name */
564 size
= sizeof (driver
) / sizeof (driver
[0]);
565 ret
= RegEnumKeyW( hKey
, idx
, name
, *cName
);
566 if (ret
!= ERROR_SUCCESS
)
568 DBGPRINT( "Error: Couldn't get OpenGLDrivers subkey name (%d)", ret
);
572 *cName
= wcslen( name
);
576 return ERROR_SUCCESS
;
578 #endif /* 0 -- unused */
581 /*! \brief Get registry values for a driver given a name.
583 * \param driver Name of the driver to get information about.
584 * \param icd Pointer to GLDRIVERDATA.
586 * \return Error code.
587 * \retval ERROR_SUCCESS Success.
589 * \note On success the following fields of \a icd are filled: \a driver_name,
590 * \a dll, \a version, \a driver_version and \a flags.
593 OPENGL32_RegGetDriverInfo( LPCWSTR driver
, GLDRIVERDATA
*icd
)
596 WCHAR subKey
[1024] = OPENGL_DRIVERS_SUBKEY2
;
600 /* drivers registry values */
601 DWORD version
= 1, driverVersion
= 0, flags
= 0;
604 /* open driver registry key */
605 wcsncat( subKey
, driver
, 1024 );
606 ret
= RegOpenKeyExW( HKEY_LOCAL_MACHINE
, subKey
, 0, KEY_READ
, &hKey
);
607 if (ret
!= ERROR_SUCCESS
)
609 DBGPRINT( "Error: Couldn't open registry key '%ws'", subKey
);
615 ret
= RegQueryValueExW( hKey
, L
"Dll", 0, &type
, (LPBYTE
)dll
, &size
);
616 if (ret
!= ERROR_SUCCESS
|| type
!= REG_SZ
)
618 DBGPRINT( "Error: Couldn't query Dll value or not a string" );
623 size
= sizeof (DWORD
);
624 ret
= RegQueryValueExW( hKey
, L
"Version", 0, &type
, (LPBYTE
)&version
, &size
);
625 if (ret
!= ERROR_SUCCESS
|| type
!= REG_DWORD
)
626 DBGPRINT( "Warning: Couldn't query Version value or not a DWORD" );
628 size
= sizeof (DWORD
);
629 ret
= RegQueryValueExW( hKey
, L
"DriverVersion", 0, &type
,
630 (LPBYTE
)&driverVersion
, &size
);
631 if (ret
!= ERROR_SUCCESS
|| type
!= REG_DWORD
)
632 DBGPRINT( "Warning: Couldn't query DriverVersion value or not a DWORD" );
634 size
= sizeof (DWORD
);
635 ret
= RegQueryValueExW( hKey
, L
"Flags", 0, &type
, (LPBYTE
)&flags
, &size
);
636 if (ret
!= ERROR_SUCCESS
|| type
!= REG_DWORD
)
637 DBGPRINT( "Warning: Couldn't query Flags value or not a DWORD" );
643 /* FIXME: NUL-terminate strings? */
644 wcsncpy( icd
->driver_name
, driver
,
645 sizeof (icd
->driver_name
) / sizeof (icd
->driver_name
[0]) - 1 );
646 wcsncpy( icd
->dll
, dll
,
647 sizeof (icd
->dll
) / sizeof (icd
->dll
[0]) );
648 icd
->version
= version
;
649 icd
->driver_version
= driverVersion
;
652 return ERROR_SUCCESS
;