3 * COPYRIGHT: See COPYING in the top level directory
4 * PROJECT: ReactOS kernel
5 * FILE: lib/opengl32/opengl32.c
6 * PURPOSE: OpenGL32 lib
7 * PROGRAMMER: Anich Gregor (blight), Royce Mitchell III
12 #define WIN32_LEAN_AND_MEAN
13 #define WIN32_NO_STATUS
22 /* function prototypes */
23 static void OPENGL32_AppendICD( GLDRIVERDATA
*icd
);
24 static void OPENGL32_RemoveICD( GLDRIVERDATA
*icd
);
25 static GLDRIVERDATA
*OPENGL32_LoadDriver( LPCWSTR regKey
);
26 static DWORD
OPENGL32_InitializeDriver( GLDRIVERDATA
*icd
);
27 static BOOL
OPENGL32_UnloadDriver( GLDRIVERDATA
*icd
);
28 static DWORD
OPENGL32_RegGetDriverInfo( LPCWSTR driver
, GLDRIVERDATA
*icd
);
32 /* Do not assume it have the free value -1 set, any value can be in here */
33 DWORD OPENGL32_tls
= -1;
34 GLPROCESSDATA OPENGL32_processdata
;
38 OPENGL32_ThreadAttach()
40 GLTHREADDATA
* lpData
= NULL
;
41 PROC
*dispatchTable
= NULL
;
44 dispatchTable
= (PROC
*)HeapAlloc( GetProcessHeap(),
45 HEAP_GENERATE_EXCEPTIONS
| HEAP_ZERO_MEMORY
,
46 sizeof (((ICDTable
*)(0))->dispatch_table
) );
47 if (dispatchTable
== NULL
)
49 DBGPRINT( "Error: Couldn't allocate GL dispatch table" );
53 lpData
= (GLTHREADDATA
*)HeapAlloc( GetProcessHeap(),
54 HEAP_GENERATE_EXCEPTIONS
| HEAP_ZERO_MEMORY
,
55 sizeof (GLTHREADDATA
) );
58 DBGPRINT( "Error: Couldn't allocate GLTHREADDATA" );
59 HeapFree( GetProcessHeap(), 0, dispatchTable
);
65 /* initialize dispatch table with empty functions */
66 #define X(func, ret, typeargs, args, icdidx, tebidx, stack) \
67 dispatchTable[icdidx] = (PROC)glEmptyFunc##stack; \
69 teb->glDispatchTable[tebidx] = (PVOID)glEmptyFunc##stack;
73 teb
->glTable
= dispatchTable
;
74 TlsSetValue( OPENGL32_tls
, lpData
);
81 OPENGL32_ThreadDetach()
83 GLTHREADDATA
* lpData
= NULL
;
84 PROC
*dispatchTable
= NULL
;
86 rosglMakeCurrent( NULL
, NULL
);
88 lpData
= (GLTHREADDATA
*)TlsGetValue( OPENGL32_tls
);
91 if (!HeapFree( GetProcessHeap(), 0, lpData
))
92 DBGPRINT( "Warning: HeapFree() on GLTHREADDATA failed (%d)",
96 dispatchTable
= NtCurrentTeb()->glTable
;
97 if (dispatchTable
!= NULL
)
99 if (!HeapFree( GetProcessHeap(), 0, dispatchTable
))
100 DBGPRINT( "Warning: HeapFree() on dispatch table failed (%d)",
107 OPENGL32_ProcessAttach()
109 SECURITY_ATTRIBUTES attrib
= { sizeof (SECURITY_ATTRIBUTES
), /* nLength */
110 NULL
, /* lpSecurityDescriptor */
111 TRUE
/* bInheritHandle */ };
113 OPENGL32_tls
= TlsAlloc();
114 if (-1 == OPENGL32_tls
)
117 memset( &OPENGL32_processdata
, 0, sizeof (OPENGL32_processdata
) );
119 /* create driver, glrc & dcdata list mutex */
120 OPENGL32_processdata
.driver_mutex
= CreateMutex( &attrib
, FALSE
, NULL
);
121 if (OPENGL32_processdata
.driver_mutex
== NULL
)
123 DBGPRINT( "Error: Couldn't create driver_list mutex (%d)",
127 OPENGL32_processdata
.glrc_mutex
= CreateMutex( &attrib
, FALSE
, NULL
);
128 if (OPENGL32_processdata
.glrc_mutex
== NULL
)
130 DBGPRINT( "Error: Couldn't create glrc_list mutex (%d)",
134 OPENGL32_processdata
.dcdata_mutex
= CreateMutex( &attrib
, FALSE
, NULL
);
135 if (OPENGL32_processdata
.dcdata_mutex
== NULL
)
137 DBGPRINT( "Error: Couldn't create dcdata_list mutex (%d)",
147 OPENGL32_ProcessDetach()
149 GLDRIVERDATA
*icd
, *icd2
;
150 GLDCDATA
*dcdata
, *dcdata2
;
154 for (dcdata
= OPENGL32_processdata
.dcdata_list
; dcdata
!= NULL
;)
157 dcdata
= dcdata
->next
;
158 if (!HeapFree( GetProcessHeap(), 0, dcdata2
))
159 DBGPRINT( "Warning: HeapFree() on DCDATA 0x%08x failed (%d)",
160 dcdata2
, GetLastError() );
163 for (glrc
= OPENGL32_processdata
.glrc_list
; glrc
!= NULL
;)
167 if (!HeapFree( GetProcessHeap(), 0, glrc2
))
168 DBGPRINT( "Warning: HeapFree() on GLRC 0x%08x failed (%d)",
169 glrc2
, GetLastError() );
172 for (icd
= OPENGL32_processdata
.driver_list
; icd
!= NULL
;)
176 if (!HeapFree( GetProcessHeap(), 0, icd2
))
177 DBGPRINT( "Warning: HeapFree() on DRIVERDATA 0x%08x failed (%d)",
178 icd2
, GetLastError() );
182 if (OPENGL32_processdata
.driver_mutex
!= NULL
)
183 CloseHandle( OPENGL32_processdata
.driver_mutex
);
184 if (OPENGL32_processdata
.glrc_mutex
!= NULL
)
185 CloseHandle( OPENGL32_processdata
.glrc_mutex
);
186 if (OPENGL32_processdata
.dcdata_mutex
!= NULL
)
187 CloseHandle( OPENGL32_processdata
.dcdata_mutex
);
190 if (OPENGL32_tls
!= -1)
191 TlsFree(OPENGL32_tls
);
196 DllMain(HINSTANCE hInstance
, DWORD Reason
, LPVOID Reserved
)
198 DBGPRINT( "Info: Called!" );
201 /* The DLL is loading due to process
202 * initialization or a call to LoadLibrary.
204 case DLL_PROCESS_ATTACH
:
205 DBGTRACE( "Process attach" );
206 if (!OPENGL32_ProcessAttach())
208 /* No break: Initialize the index for first thread. */
210 /* The attached process creates a new thread. */
211 case DLL_THREAD_ATTACH
:
212 DBGTRACE( "Thread attach" );
213 if (!OPENGL32_ThreadAttach())
217 /* The thread of the attached process terminates. */
218 case DLL_THREAD_DETACH
:
219 DBGTRACE( "Thread detach" );
220 /* Release the allocated memory for this thread.*/
221 OPENGL32_ThreadDetach();
224 /* DLL unload due to process termination or FreeLibrary. */
225 case DLL_PROCESS_DETACH
:
226 DBGTRACE( "Process detach" );
227 OPENGL32_ThreadDetach();
228 OPENGL32_ProcessDetach();
236 /*! \brief Append ICD to linked list.
238 * \param icd GLDRIVERDATA to append to list
240 * \note Only call this when you hold the driver_mutex.
243 OPENGL32_AppendICD( GLDRIVERDATA
*icd
)
245 if (OPENGL32_processdata
.driver_list
== NULL
)
246 OPENGL32_processdata
.driver_list
= icd
;
249 GLDRIVERDATA
*p
= OPENGL32_processdata
.driver_list
;
250 while (p
->next
!= NULL
)
257 /*! \brief Remove ICD from linked list.
259 * \param icd GLDRIVERDATA to remove from list
261 * \note Only call this when you hold the driver_mutex.
264 OPENGL32_RemoveICD( GLDRIVERDATA
*icd
)
266 if (icd
== OPENGL32_processdata
.driver_list
)
267 OPENGL32_processdata
.driver_list
= icd
->next
;
270 GLDRIVERDATA
*p
= OPENGL32_processdata
.driver_list
;
280 DBGPRINT( "Error: ICD 0x%08x not found in list!", icd
);
285 /*! \brief Load an ICD.
287 * \param driver Name of installable client driver.
289 * \return Pointer to an allocated GLDRIVERDATA struct.
290 * \retval NULL Failure.
292 * \todo Call SetLastError() where appropriate.
294 static GLDRIVERDATA
*
295 OPENGL32_LoadDriver( LPCWSTR driver
)
300 DBGPRINT( "Info: Loading driver %ws...", driver
);
302 /* allocate driver data */
303 icd
= (GLDRIVERDATA
*)HeapAlloc( GetProcessHeap(),
304 HEAP_GENERATE_EXCEPTIONS
| HEAP_ZERO_MEMORY
,
305 sizeof (GLDRIVERDATA
) );
308 DBGPRINT( "Error: Couldn't allocate GLDRIVERDATA! (%d)", GetLastError() );
312 ret
= OPENGL32_RegGetDriverInfo( driver
, icd
);
313 if (ret
!= ERROR_SUCCESS
)
315 DBGPRINT( "Error: Couldn't query driver information (%d)", ret
);
316 if (!HeapFree( GetProcessHeap(), 0, icd
))
317 DBGPRINT( "Error: HeapFree() returned false, error code = %d",
322 DBGPRINT( "Info: Dll = %ws", icd
->dll
);
323 DBGPRINT( "Info: Version = 0x%08x", icd
->version
);
324 DBGPRINT( "Info: DriverVersion = 0x%08x", icd
->driver_version
);
325 DBGPRINT( "Info: Flags = 0x%08x", icd
->flags
);
327 /* load/initialize ICD */
328 ret
= OPENGL32_InitializeDriver( icd
);
329 if (ret
!= ERROR_SUCCESS
)
331 DBGPRINT( "Error: Couldnt initialize ICD!" );
332 if (!HeapFree( GetProcessHeap(), 0, icd
))
333 DBGPRINT( "Error: HeapFree() returned false, error code = %d",
338 /* append ICD to list */
339 OPENGL32_AppendICD( icd
);
340 DBGPRINT( "Info: ICD loaded." );
346 /*! \brief Initialize a driver (Load DLL and DrvXxx procs)
348 * \param icd ICD to initialize with the dll, version, driverVersion
349 * and flags already filled.
350 * \return Error code.
351 * \retval ERROR_SUCCESS Success
353 #define LOAD_DRV_PROC( icd, proc, required ) \
354 *(char**)&icd->proc = (char*)GetProcAddress( icd->handle, #proc ); \
355 if (required && icd->proc == NULL) { \
356 DBGPRINT( "Error: GetProcAddress(\"%s\") failed!", #proc ); \
357 FreeLibrary( icd->handle ); \
358 return GetLastError(); \
362 OPENGL32_InitializeDriver( GLDRIVERDATA
*icd
)
365 if (icd
->version
> 2)
366 DBGPRINT( "Warning: ICD version > 2 (%d)", icd
->version
);
369 icd
->handle
= LoadLibraryW( icd
->dll
);
370 if (icd
->handle
== NULL
)
372 DWORD err
= GetLastError();
373 DBGPRINT( "Error: Couldn't load DLL! (%d)", err
);
377 /* validate version */
378 if (icd
->driver_version
> 1)
380 LOAD_DRV_PROC(icd
, DrvValidateVersion
, FALSE
);
381 if (icd
->DrvValidateVersion
!= NULL
)
383 if (!icd
->DrvValidateVersion( icd
->driver_version
))
385 DBGPRINT( "Error: DrvValidateVersion failed!" );
387 FreeLibrary( icd
->handle
);
388 return ERROR_INVALID_FUNCTION
; /* FIXME: use better error code */
392 DBGPRINT( "Info: DrvValidateVersion not exported by ICD" );
395 /* load DrvXXX procs */
396 LOAD_DRV_PROC(icd
, DrvCopyContext
, TRUE
);
397 LOAD_DRV_PROC(icd
, DrvCreateContext
, FALSE
);
398 LOAD_DRV_PROC(icd
, DrvCreateLayerContext
, FALSE
);
399 LOAD_DRV_PROC(icd
, DrvDeleteContext
, TRUE
);
400 LOAD_DRV_PROC(icd
, DrvDescribeLayerPlane
, TRUE
);
401 LOAD_DRV_PROC(icd
, DrvDescribePixelFormat
, TRUE
);
402 LOAD_DRV_PROC(icd
, DrvGetLayerPaletteEntries
, TRUE
);
403 LOAD_DRV_PROC(icd
, DrvGetProcAddress
, TRUE
);
404 LOAD_DRV_PROC(icd
, DrvReleaseContext
, TRUE
);
405 LOAD_DRV_PROC(icd
, DrvRealizeLayerPalette
, TRUE
);
406 LOAD_DRV_PROC(icd
, DrvSetContext
, TRUE
);
407 LOAD_DRV_PROC(icd
, DrvSetLayerPaletteEntries
, TRUE
);
408 LOAD_DRV_PROC(icd
, DrvSetPixelFormat
, TRUE
);
409 LOAD_DRV_PROC(icd
, DrvShareLists
, TRUE
);
410 LOAD_DRV_PROC(icd
, DrvSwapBuffers
, TRUE
);
411 LOAD_DRV_PROC(icd
, DrvSwapLayerBuffers
, TRUE
);
413 /* we require at least one of DrvCreateContext and DrvCreateLayerContext */
414 if (icd
->DrvCreateContext
== NULL
&& icd
->DrvCreateLayerContext
== NULL
)
416 DBGPRINT( "Error: One of DrvCreateContext/DrvCreateLayerContext is required!" );
417 FreeLibrary( icd
->handle
);
418 return ERROR_INVALID_FUNCTION
; /* FIXME: use better error code... */
421 return ERROR_SUCCESS
;
425 /*! \brief Unload ICD.
427 * \retval TRUE Success.
428 * \retval FALSE Failure.
431 OPENGL32_UnloadDriver( GLDRIVERDATA
*icd
)
435 DBGPRINT( "Info: Unloading driver %ws...", icd
->driver_name
);
436 if (icd
->refcount
!= 0)
437 DBGPRINT( "Warning: ICD refcount = %d (should be 0)", icd
->refcount
);
440 if (!FreeLibrary( icd
->handle
))
443 DBGPRINT( "Warning: FreeLibrary on ICD %ws failed! (%d)", icd
->dll
,
448 OPENGL32_RemoveICD( icd
);
449 if (!HeapFree( GetProcessHeap(), 0, icd
))
452 DBGPRINT( "Warning: HeapFree() returned FALSE, error code = %d",
460 /*! \brief Load ICD (shared ICD data)
462 * \return Pointer to an allocated GLDRIVERDATA on success.
463 * \retval NULL Failure.
466 OPENGL32_LoadICD( LPCWSTR driver
)
471 if (WaitForSingleObject( OPENGL32_processdata
.driver_mutex
, INFINITE
) ==
474 DBGPRINT( "Error: WaitForSingleObject() failed (%d)", GetLastError() );
475 return NULL
; /* FIXME: do we have to expect such an error and handle it? */
478 /* look if ICD is already loaded */
479 for (icd
= OPENGL32_processdata
.driver_list
; icd
; icd
= icd
->next
)
481 if (!_wcsicmp( driver
, icd
->driver_name
)) /* found */
486 if (!ReleaseMutex( OPENGL32_processdata
.driver_mutex
))
487 DBGPRINT( "Error: ReleaseMutex() failed (%d)", GetLastError() );
493 /* not found - try to load */
494 icd
= OPENGL32_LoadDriver( driver
);
499 if (!ReleaseMutex( OPENGL32_processdata
.driver_mutex
))
500 DBGPRINT( "Error: ReleaseMutex() failed (%d)", GetLastError() );
506 /*! \brief Unload ICD (shared ICD data)
508 * \retval TRUE Success.
509 * \retval FALSE Failure.
512 OPENGL32_UnloadICD( GLDRIVERDATA
*icd
)
517 if (WaitForSingleObject( OPENGL32_processdata
.driver_mutex
, INFINITE
) ==
520 DBGPRINT( "Error: WaitForSingleObject() failed (%d)", GetLastError() );
521 return FALSE
; /* FIXME: do we have to expect such an error and handle it? */
525 if (icd
->refcount
== 0)
527 ret
= OPENGL32_UnloadDriver( icd
);
528 /* FIXME: InitializeICD crashes when called a second time */
531 if (!ReleaseMutex( OPENGL32_processdata
.driver_mutex
))
532 DBGPRINT( "Error: ReleaseMutex() failed (%d)", GetLastError() );
538 /*! \brief Enumerate OpenGLDrivers (from registry)
540 * \param idx Index of the driver to get information about.
541 * \param name Pointer to an array of WCHARs (can be NULL)
542 * \param cName Pointer to a DWORD. Input is len of name array.
543 * Output is length of the drivername.
544 * Can be NULL if name is NULL.
547 * \retval ERROR_NO_MORE_ITEMS End of driver list.
548 * \retval ERROR_SUCCESS Success.
552 OPENGL32_RegEnumDrivers( DWORD idx
, LPWSTR name
, LPDWORD cName
)
555 LPCWSTR subKey
= OPENGL_DRIVERS_SUBKEY
;
561 return ERROR_SUCCESS
; /* nothing to do */
564 return ERROR_INVALID_FUNCTION
; /* we need cName when name is given */
566 /* open OpenGLDrivers registry key */
567 ret
= RegOpenKeyExW( HKEY_LOCAL_MACHINE
, subKey
, 0, KEY_READ
, &hKey
);
568 if (ret
!= ERROR_SUCCESS
)
570 DBGPRINT( "Error: Couldn't open registry key '%ws'", subKey
);
574 /* get subkey name */
575 size
= sizeof (driver
) / sizeof (driver
[0]);
576 ret
= RegEnumKeyW( hKey
, idx
, name
, *cName
);
577 if (ret
!= ERROR_SUCCESS
)
579 DBGPRINT( "Error: Couldn't get OpenGLDrivers subkey name (%d)", ret
);
583 *cName
= wcslen( name
);
587 return ERROR_SUCCESS
;
589 #endif /* 0 -- unused */
592 /*! \brief Get registry values for a driver given a name.
594 * \param driver Name of the driver to get information about.
595 * \param icd Pointer to GLDRIVERDATA.
597 * \return Error code.
598 * \retval ERROR_SUCCESS Success.
600 * \note On success the following fields of \a icd are filled: \a driver_name,
601 * \a dll, \a version, \a driver_version and \a flags.
604 OPENGL32_RegGetDriverInfo( LPCWSTR driver
, GLDRIVERDATA
*icd
)
607 WCHAR subKey
[1024] = OPENGL_DRIVERS_SUBKEY
"\\";
611 /* drivers registry values */
612 DWORD version
= 1, driverVersion
= 0, flags
= 0;
615 /* open driver registry key */
616 wcsncat( subKey
, driver
, 1024 );
617 ret
= RegOpenKeyExW( HKEY_LOCAL_MACHINE
, subKey
, 0, KEY_READ
, &hKey
);
618 if (ret
!= ERROR_SUCCESS
)
620 DBGPRINT( "Error: Couldn't open registry key '%ws'", subKey
);
626 ret
= RegQueryValueExW( hKey
, L
"Dll", 0, &type
, (LPBYTE
)dll
, &size
);
627 if (ret
!= ERROR_SUCCESS
|| type
!= REG_SZ
)
629 DBGPRINT( "Error: Couldn't query Dll value or not a string" );
634 size
= sizeof (DWORD
);
635 ret
= RegQueryValueExW( hKey
, L
"Version", 0, &type
, (LPBYTE
)&version
, &size
);
636 if (ret
!= ERROR_SUCCESS
|| type
!= REG_DWORD
)
637 DBGPRINT( "Warning: Couldn't query Version value or not a DWORD" );
639 size
= sizeof (DWORD
);
640 ret
= RegQueryValueExW( hKey
, L
"DriverVersion", 0, &type
,
641 (LPBYTE
)&driverVersion
, &size
);
642 if (ret
!= ERROR_SUCCESS
|| type
!= REG_DWORD
)
643 DBGPRINT( "Warning: Couldn't query DriverVersion value or not a DWORD" );
645 size
= sizeof (DWORD
);
646 ret
= RegQueryValueExW( hKey
, L
"Flags", 0, &type
, (LPBYTE
)&flags
, &size
);
647 if (ret
!= ERROR_SUCCESS
|| type
!= REG_DWORD
)
648 DBGPRINT( "Warning: Couldn't query Flags value or not a DWORD" );
654 /* FIXME: NUL-terminate strings? */
655 wcsncpy( icd
->driver_name
, driver
,
656 sizeof (icd
->driver_name
) / sizeof (icd
->driver_name
[0]) - 1 );
657 wcsncpy( icd
->dll
, dll
,
658 sizeof (icd
->dll
) / sizeof (icd
->dll
[0]) );
659 icd
->version
= version
;
660 icd
->driver_version
= driverVersion
;
663 return ERROR_SUCCESS
;