1 /* $XFree86: xc/lib/GL/dri/dri_util.h,v 1.1 2002/02/22 21:32:52 dawes Exp $ */
4 * DRI utility functions definitions.
6 * This module acts as glue between GLX and the actual hardware driver. A DRI
7 * driver doesn't really \e have to use any of this - it's optional. But, some
8 * useful stuff is done here that otherwise would have to be duplicated in most
11 * Basically, these utility functions take care of some of the dirty details of
12 * screen initialization, context creation, context binding, DRM setup, etc.
14 * These functions are compiled into each DRI driver so libGL.so knows nothing
19 * \author Kevin E. Martin <kevin@precisioninsight.com>
20 * \author Brian Paul <brian@precisioninsight.com>
24 * Copyright 1998-1999 Precision Insight, Inc., Cedar Park, Texas.
25 * All Rights Reserved.
27 * Permission is hereby granted, free of charge, to any person obtaining a
28 * copy of this software and associated documentation files (the
29 * "Software"), to deal in the Software without restriction, including
30 * without limitation the rights to use, copy, modify, merge, publish,
31 * distribute, sub license, and/or sell copies of the Software, and to
32 * permit persons to whom the Software is furnished to do so, subject to
33 * the following conditions:
35 * The above copyright notice and this permission notice (including the
36 * next paragraph) shall be included in all copies or substantial portions
39 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
40 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
41 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
42 * IN NO EVENT SHALL PRECISION INSIGHT AND/OR ITS SUPPLIERS BE LIABLE FOR
43 * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
44 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
45 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
52 #ifdef GLX_DIRECT_RENDERING
54 #define CAPI /* XXX this should be globally defined somewhere */
56 #ifdef DRI_NEW_INTERFACE_ONLY
59 # include "glxclient.h"
60 #endif /* DRI_NEW_INTERFACE_ONLY */
62 #include "drm_sarea.h"
63 #include "GL/internal/glcore.h"
64 #include "GL/internal/dri_interface.h"
66 #define GLX_BAD_CONTEXT 5
68 /* This is a temporary relic. Once all drivers are converted to support
69 * the new interface, it can go away.
71 #ifdef DRI_NEW_INTERFACE_ONLY
72 #define USE_NEW_INTERFACE
75 typedef struct __DRIdisplayPrivateRec __DRIdisplayPrivate
;
76 typedef struct __DRIscreenPrivateRec __DRIscreenPrivate
;
77 typedef struct __DRIcontextPrivateRec __DRIcontextPrivate
;
78 typedef struct __DRIdrawablePrivateRec __DRIdrawablePrivate
;
79 typedef struct __DRIswapInfoRec __DRIswapInfo
;
80 typedef struct __DRIutilversionRec2 __DRIutilversion2
;
84 * Used by DRI_VALIDATE_DRAWABLE_INFO
86 #define DRI_VALIDATE_DRAWABLE_INFO_ONCE(pDrawPriv) \
88 if (*(pDrawPriv->pStamp) != pDrawPriv->lastStamp) { \
89 __driUtilUpdateDrawableInfo(pDrawPriv); \
95 * Utility macro to validate the drawable information.
97 * See __DRIdrawablePrivate::pStamp and __DRIdrawablePrivate::lastStamp.
99 #define DRI_VALIDATE_DRAWABLE_INFO(psp, pdp) \
101 while (*(pdp->pStamp) != pdp->lastStamp) { \
102 DRM_UNLOCK(psp->fd, &psp->pSAREA->lock, \
103 pdp->driContextPriv->hHWContext); \
105 DRM_SPINLOCK(&psp->pSAREA->drawable_lock, psp->drawLockID); \
106 DRI_VALIDATE_DRAWABLE_INFO_ONCE(pdp); \
107 DRM_SPINUNLOCK(&psp->pSAREA->drawable_lock, psp->drawLockID); \
109 DRM_LIGHT_LOCK(psp->fd, &psp->pSAREA->lock, \
110 pdp->driContextPriv->hHWContext); \
116 * Driver callback functions.
118 * Each DRI driver must have one of these structures with all the pointers set
119 * to appropriate functions within the driver.
121 * When glXCreateContext() is called, for example, it'll call a helper function
122 * dri_util.c which in turn will jump through the \a CreateContext pointer in
125 struct __DriverAPIRec
{
127 * Driver initialization callback
129 GLboolean (*InitDriver
)(__DRIscreenPrivate
*driScrnPriv
);
132 * Screen destruction callback
134 void (*DestroyScreen
)(__DRIscreenPrivate
*driScrnPriv
);
137 * Context creation callback
139 GLboolean (*CreateContext
)(const __GLcontextModes
*glVis
,
140 __DRIcontextPrivate
*driContextPriv
,
141 void *sharedContextPrivate
);
144 * Context destruction callback
146 void (*DestroyContext
)(__DRIcontextPrivate
*driContextPriv
);
149 * Buffer (drawable) creation callback
151 GLboolean (*CreateBuffer
)(__DRIscreenPrivate
*driScrnPriv
,
152 __DRIdrawablePrivate
*driDrawPriv
,
153 const __GLcontextModes
*glVis
,
154 GLboolean pixmapBuffer
);
157 * Buffer (drawable) destruction callback
159 void (*DestroyBuffer
)(__DRIdrawablePrivate
*driDrawPriv
);
162 * Buffer swapping callback
164 void (*SwapBuffers
)(__DRIdrawablePrivate
*driDrawPriv
);
167 * Context activation callback
169 GLboolean (*MakeCurrent
)(__DRIcontextPrivate
*driContextPriv
,
170 __DRIdrawablePrivate
*driDrawPriv
,
171 __DRIdrawablePrivate
*driReadPriv
);
174 * Context unbinding callback
176 GLboolean (*UnbindContext
)(__DRIcontextPrivate
*driContextPriv
);
179 * Retrieves statistics about buffer swap operations. Required if
180 * GLX_OML_sync_control or GLX_MESA_swap_frame_usage is supported.
182 int (*GetSwapInfo
)( __DRIdrawablePrivate
*dPriv
, __DRIswapInfo
* sInfo
);
186 * Required if GLX_SGI_video_sync or GLX_OML_sync_control is
189 int (*GetMSC
)( __DRIscreenPrivate
* priv
, int64_t * count
);
192 * These are required if GLX_OML_sync_control is supported.
195 int (*WaitForMSC
)( __DRIdrawablePrivate
*priv
, int64_t target_msc
,
196 int64_t divisor
, int64_t remainder
,
198 int (*WaitForSBC
)( __DRIdrawablePrivate
*priv
, int64_t target_sbc
,
199 int64_t * msc
, int64_t * sbc
);
201 int64_t (*SwapBuffersMSC
)( __DRIdrawablePrivate
*priv
, int64_t target_msc
,
202 int64_t divisor
, int64_t remainder
);
207 struct __DRIswapInfoRec
{
209 * Number of swapBuffers operations that have been *completed*.
211 u_int64_t swap_count
;
214 * Unadjusted system time of the last buffer swap. This is the time
215 * when the swap completed, not the time when swapBuffers was called.
220 * Number of swap operations that occurred after the swap deadline. That
221 * is if a swap happens more than swap_interval frames after the previous
222 * swap, it has missed its deadline. If swap_interval is 0, then the
223 * swap deadline is 1 frame after the previous swap.
225 u_int64_t swap_missed_count
;
228 * Amount of time used by the last swap that missed its deadline. This
229 * is calculated as (__glXGetUST() - swap_ust) / (swap_interval *
230 * time_for_single_vrefresh)). If the actual value of swap_interval is
231 * 0, then 1 is used instead. If swap_missed_count is non-zero, this
232 * should be greater-than 1.0.
234 float swap_missed_usage
;
239 * Per-drawable private DRI driver information.
241 struct __DRIdrawablePrivateRec
{
243 * Kernel drawable handle
245 drm_drawable_t hHWDrawable
;
248 * Driver's private drawable information.
250 * This structure is opaque.
255 * X's drawable ID associated with this private drawable.
258 __DRIdrawable
*pdraw
;
261 * Reference count for number of context's currently bound to this
264 * Once it reaches zero, the drawable can be destroyed.
266 * \note This behavior will change with GLX 1.3.
271 * Index of this drawable information in the SAREA.
276 * Pointer to the "drawable has changed ID" stamp in the SAREA.
278 unsigned int *pStamp
;
281 * Last value of the stamp.
283 * If this differs from the value stored at __DRIdrawablePrivate::pStamp,
284 * then the drawable information has been modified by the X server, and the
285 * drawable information (below) should be retrieved from the X server.
287 unsigned int lastStamp
;
292 * Drawable information used in software fallbacks.
300 drm_clip_rect_t
*pClipRects
;
304 * \name Back and depthbuffer
306 * Information about the back and depthbuffer where different from above.
311 int backClipRectType
;
312 int numBackClipRects
;
313 drm_clip_rect_t
*pBackClipRects
;
317 * Pointer to context to which this drawable is currently bound.
319 __DRIcontextPrivate
*driContextPriv
;
322 * Pointer to screen on which this drawable was created.
324 __DRIscreenPrivate
*driScreenPriv
;
327 * \name Display and screen information.
329 * Basically just need these for when the locking code needs to call
330 * __driUtilUpdateDrawableInfo() which calls XF86DRIGetDrawableInfo().
333 __DRInativeDisplay
*display
;
338 * Called via glXSwapBuffers().
340 void (*swapBuffers
)( __DRIdrawablePrivate
*dPriv
);
343 * Get information about the location, size, and clip rects of the
344 * drawable within the display.
346 PFNGLXGETDRAWABLEINFOPROC getInfo
;
350 * Per-context private driver information.
352 struct __DRIcontextPrivateRec
{
354 * Kernel context handle used to access the device lock.
359 * Kernel context handle used to access the device lock.
361 drm_context_t hHWContext
;
364 * Device driver's private context data. This structure is opaque.
369 * This context's display pointer.
371 __DRInativeDisplay
*display
;
374 * Pointer to drawable currently bound to this context.
376 __DRIdrawablePrivate
*driDrawablePriv
;
379 * Pointer to screen on which this context was created.
381 __DRIscreenPrivate
*driScreenPriv
;
385 * Per-screen private driver information.
387 struct __DRIscreenPrivateRec
{
389 * Display for this screen
391 __DRInativeDisplay
*display
;
394 * Current screen's number
399 * Callback functions into the hardware-specific DRI driver code.
401 struct __DriverAPIRec DriverAPI
;
405 * DDX / 2D driver version information.
406 * \todo Replace these fields with a \c __DRIversionRec.
416 * DRI X extension version information.
417 * \todo Replace these fields with a \c __DRIversionRec.
427 * DRM (kernel module) version information.
428 * \todo Replace these fields with a \c __DRIversionRec.
437 * ID used when the client sets the drawable lock.
439 * The X server uses this value to detect if the client has died while
440 * holding the drawable lock.
445 * File descriptor returned when the kernel device driver is opened.
448 * - authenticate client to kernel
449 * - map the frame buffer, SAREA, etc.
450 * - close the kernel device driver
459 * - the device-independent per-drawable and per-context(?) information
464 * \name Direct frame buffer access information
465 * Used for software fallbacks.
478 * \name Device-dependent private information (stored in the SAREA).
480 * This data is accessed by the client driver only.
488 * Dummy context to which drawables are bound when not bound to any
491 * A dummy hHWContext is created for this context, and is used by the GL
492 * core when a hardware lock is required but the drawable is not currently
493 * bound (e.g., potentially during a SwapBuffers request). The dummy
494 * context is created when the first "real" context is created on this
497 __DRIcontextPrivate dummyContextPriv
;
500 * Hash table to hold the drawable information for this screen.
505 * Device-dependent private information (not stored in the SAREA).
507 * This pointer is never touched by the DRI layer.
512 * GLX visuals / FBConfigs for this screen. These are stored as a
516 * This field is \b only used in conjunction with the old interfaces. If
517 * the new interfaces are used, this field will be set to \c NULL and will
518 * not be dereferenced.
520 __GLcontextModes
*modes
;
523 * Pointer back to the \c __DRIscreen that contains this structure.
531 * Used to store a version which includes a major range instead of a single
532 * major version number.
534 struct __DRIutilversionRec2
{
535 int major_min
; /** min allowed Major version number. */
536 int major_max
; /** max allowed Major version number. */
537 int minor
; /**< Minor version number. */
538 int patch
; /**< Patch-level. */
543 __driUtilMessage(const char *f
, ...);
547 __driUtilUpdateDrawableInfo(__DRIdrawablePrivate
*pdp
);
550 extern __DRIscreenPrivate
* __driUtilCreateNewScreen( __DRInativeDisplay
*dpy
,
551 int scrn
, __DRIscreen
*psc
, __GLcontextModes
* modes
,
552 const __DRIversion
* ddx_version
, const __DRIversion
* dri_version
,
553 const __DRIversion
* drm_version
, const __DRIframebuffer
* frame_buffer
,
554 drm_sarea_t
*pSAREA
, int fd
, int internal_api_version
,
555 const struct __DriverAPIRec
*driverAPI
);
557 #ifndef DRI_NEW_INTERFACE_ONLY
558 extern __DRIscreenPrivate
*
559 __driUtilCreateScreen(Display
*dpy
, int scrn
, __DRIscreen
*psc
,
560 int numConfigs
, __GLXvisualConfig
*config
,
561 const struct __DriverAPIRec
*driverAPI
);
562 #endif /* DRI_NEW_INTERFACE_ONLY */
564 /* Test the version of the internal GLX API. Returns a value like strcmp. */
566 driCompareGLXAPIVersion( GLuint required_version
);
569 driCalculateSwapUsage( __DRIdrawablePrivate
*dPriv
,
570 int64_t last_swap_ust
, int64_t current_ust
);
572 /* Test for the GLX header glx.h */
575 (*glXGetProcAddress(const GLubyte
*procname
))( void );
578 #endif /* GLX_DIRECT_RENDERING */
580 #endif /* _DRI_UTIL_H_ */