2 * Copyright 1998-1999 Precision Insight, Inc., Cedar Park, Texas.
5 * Permission is hereby granted, free of charge, to any person obtaining a
6 * copy of this software and associated documentation files (the
7 * "Software"), to deal in the Software without restriction, including
8 * without limitation the rights to use, copy, modify, merge, publish,
9 * distribute, sub license, and/or sell copies of the Software, and to
10 * permit persons to whom the Software is furnished to do so, subject to
11 * the following conditions:
13 * The above copyright notice and this permission notice (including the
14 * next paragraph) shall be included in all copies or substantial portions
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
18 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
19 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
20 * IN NO EVENT SHALL PRECISION INSIGHT AND/OR ITS SUPPLIERS BE LIABLE FOR
21 * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
22 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
23 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
28 * DRI utility functions definitions.
30 * This module acts as glue between GLX and the actual hardware driver. A DRI
31 * driver doesn't really \e have to use any of this - it's optional. But, some
32 * useful stuff is done here that otherwise would have to be duplicated in most
35 * Basically, these utility functions take care of some of the dirty details of
36 * screen initialization, context creation, context binding, DRM setup, etc.
38 * These functions are compiled into each DRI driver so libGL.so knows nothing
43 * \author Kevin E. Martin <kevin@precisioninsight.com>
44 * \author Brian Paul <brian@precisioninsight.com>
52 #include <drm_sarea.h>
54 #include "xmlconfig.h"
55 #include "main/glheader.h"
56 #include "main/mtypes.h"
57 #include "GL/internal/dri_interface.h"
59 #define GLX_BAD_CONTEXT 5
61 typedef struct __DRIswapInfoRec __DRIswapInfo
;
66 extern const __DRIcoreExtension driCoreExtension
;
67 extern const __DRIdri2Extension driDRI2Extension
;
68 extern const __DRIswapControlExtension driSwapControlExtension
;
69 extern const __DRImediaStreamCounterExtension driMediaStreamCounterExtension
;
70 extern const __DRI2configQueryExtension dri2ConfigQueryExtension
;
73 * Used by DRI_VALIDATE_DRAWABLE_INFO
75 #define DRI_VALIDATE_DRAWABLE_INFO_ONCE(pDrawPriv) \
77 if (*(pDrawPriv->pStamp) != pDrawPriv->lastStamp) { \
78 __driUtilUpdateDrawableInfo(pDrawPriv); \
84 * Utility macro to validate the drawable information.
86 * See __DRIdrawable::pStamp and __DRIdrawable::lastStamp.
88 #define DRI_VALIDATE_DRAWABLE_INFO(psp, pdp) \
90 while (*(pdp->pStamp) != pdp->lastStamp) { \
91 register unsigned int hwContext = psp->pSAREA->lock.lock & \
92 ~(DRM_LOCK_HELD | DRM_LOCK_CONT); \
93 DRM_UNLOCK(psp->fd, &psp->pSAREA->lock, hwContext); \
95 DRM_SPINLOCK(&psp->pSAREA->drawable_lock, psp->drawLockID); \
96 DRI_VALIDATE_DRAWABLE_INFO_ONCE(pdp); \
97 DRM_SPINUNLOCK(&psp->pSAREA->drawable_lock, psp->drawLockID); \
99 DRM_LIGHT_LOCK(psp->fd, &psp->pSAREA->lock, hwContext); \
104 * Same as above, but for two drawables simultaneously.
108 #define DRI_VALIDATE_TWO_DRAWABLES_INFO(psp, pdp, prp) \
110 while (*((pdp)->pStamp) != (pdp)->lastStamp || \
111 *((prp)->pStamp) != (prp)->lastStamp) { \
112 register unsigned int hwContext = (psp)->pSAREA->lock.lock & \
113 ~(DRM_LOCK_HELD | DRM_LOCK_CONT); \
114 DRM_UNLOCK((psp)->fd, &(psp)->pSAREA->lock, hwContext); \
116 DRM_SPINLOCK(&(psp)->pSAREA->drawable_lock, (psp)->drawLockID); \
117 DRI_VALIDATE_DRAWABLE_INFO_ONCE(pdp); \
118 DRI_VALIDATE_DRAWABLE_INFO_ONCE(prp); \
119 DRM_SPINUNLOCK(&(psp)->pSAREA->drawable_lock, (psp)->drawLockID); \
121 DRM_LIGHT_LOCK((psp)->fd, &(psp)->pSAREA->lock, hwContext); \
127 * Driver callback functions.
129 * Each DRI driver must have one of these structures with all the pointers set
130 * to appropriate functions within the driver.
132 * When glXCreateContext() is called, for example, it'll call a helper function
133 * dri_util.c which in turn will jump through the \a CreateContext pointer in
136 struct __DriverAPIRec
{
137 const __DRIconfig
**(*InitScreen
) (__DRIscreen
* priv
);
140 * Screen destruction callback
142 void (*DestroyScreen
)(__DRIscreen
*driScrnPriv
);
145 * Context creation callback
147 GLboolean (*CreateContext
)(gl_api api
,
148 const struct gl_config
*glVis
,
149 __DRIcontext
*driContextPriv
,
150 void *sharedContextPrivate
);
153 * Context destruction callback
155 void (*DestroyContext
)(__DRIcontext
*driContextPriv
);
158 * Buffer (drawable) creation callback
160 GLboolean (*CreateBuffer
)(__DRIscreen
*driScrnPriv
,
161 __DRIdrawable
*driDrawPriv
,
162 const struct gl_config
*glVis
,
163 GLboolean pixmapBuffer
);
166 * Buffer (drawable) destruction callback
168 void (*DestroyBuffer
)(__DRIdrawable
*driDrawPriv
);
171 * Buffer swapping callback
173 void (*SwapBuffers
)(__DRIdrawable
*driDrawPriv
);
176 * Context activation callback
178 GLboolean (*MakeCurrent
)(__DRIcontext
*driContextPriv
,
179 __DRIdrawable
*driDrawPriv
,
180 __DRIdrawable
*driReadPriv
);
183 * Context unbinding callback
185 GLboolean (*UnbindContext
)(__DRIcontext
*driContextPriv
);
188 * Retrieves statistics about buffer swap operations. Required if
189 * GLX_OML_sync_control or GLX_MESA_swap_frame_usage is supported.
191 int (*GetSwapInfo
)( __DRIdrawable
*dPriv
, __DRIswapInfo
* sInfo
);
195 * These are required if GLX_OML_sync_control is supported.
198 int (*WaitForMSC
)( __DRIdrawable
*priv
, int64_t target_msc
,
199 int64_t divisor
, int64_t remainder
,
201 int (*WaitForSBC
)( __DRIdrawable
*priv
, int64_t target_sbc
,
202 int64_t * msc
, int64_t * sbc
);
204 int64_t (*SwapBuffersMSC
)( __DRIdrawable
*priv
, int64_t target_msc
,
205 int64_t divisor
, int64_t remainder
);
207 void (*CopySubBuffer
)(__DRIdrawable
*driDrawPriv
,
208 int x
, int y
, int w
, int h
);
211 * New version of GetMSC so we can pass drawable data to the low
212 * level DRM driver (e.g. pipe info). Required if
213 * GLX_SGI_video_sync or GLX_OML_sync_control is supported.
215 int (*GetDrawableMSC
) ( __DRIscreen
* priv
,
216 __DRIdrawable
*drawablePrivate
,
221 /* DRI2 Entry point */
222 const __DRIconfig
**(*InitScreen2
) (__DRIscreen
* priv
);
224 __DRIbuffer
*(*AllocateBuffer
) (__DRIscreen
*screenPrivate
,
225 unsigned int attachment
,
227 int width
, int height
);
228 void (*ReleaseBuffer
) (__DRIscreen
*screenPrivate
, __DRIbuffer
*buffer
);
231 extern const struct __DriverAPIRec driDriverAPI
;
234 struct __DRIswapInfoRec
{
236 * Number of swapBuffers operations that have been *completed*.
241 * Unadjusted system time of the last buffer swap. This is the time
242 * when the swap completed, not the time when swapBuffers was called.
247 * Number of swap operations that occurred after the swap deadline. That
248 * is if a swap happens more than swap_interval frames after the previous
249 * swap, it has missed its deadline. If swap_interval is 0, then the
250 * swap deadline is 1 frame after the previous swap.
252 uint64_t swap_missed_count
;
255 * Amount of time used by the last swap that missed its deadline. This
256 * is calculated as (__glXGetUST() - swap_ust) / (swap_interval *
257 * time_for_single_vrefresh)). If the actual value of swap_interval is
258 * 0, then 1 is used instead. If swap_missed_count is non-zero, this
259 * should be greater-than 1.0.
261 float swap_missed_usage
;
266 * Per-drawable private DRI driver information.
268 struct __DRIdrawableRec
{
270 * Kernel drawable handle
272 drm_drawable_t hHWDrawable
;
275 * Driver's private drawable information.
277 * This structure is opaque.
282 * Private data from the loader. We just hold on to it and pass
283 * it back when calling into loader provided functions.
288 * Reference count for number of context's currently bound to this
291 * Once it reaches zero, the drawable can be destroyed.
293 * \note This behavior will change with GLX 1.3.
298 * Index of this drawable information in the SAREA.
303 * Pointer to the "drawable has changed ID" stamp in the SAREA (or
304 * to dri2.stamp if DRI2 is being used).
306 unsigned int *pStamp
;
309 * Last value of the stamp.
311 * If this differs from the value stored at __DRIdrawable::pStamp,
312 * then the drawable information has been modified by the X server, and the
313 * drawable information (below) should be retrieved from the X server.
315 unsigned int lastStamp
;
320 * Drawable information used in software fallbacks.
328 drm_clip_rect_t
*pClipRects
;
332 * \name Back and depthbuffer
334 * Information about the back and depthbuffer where different from above.
339 int backClipRectType
;
340 int numBackClipRects
;
341 drm_clip_rect_t
*pBackClipRects
;
345 * \name Vertical blank tracking information
346 * Used for waiting on vertical blank events.
350 unsigned int vblFlags
;
354 * \name Monotonic MSC tracking
356 * Low level driver is responsible for updating msc_base and
357 * vblSeq values so that higher level code can calculate
358 * a new msc value or msc target for a WaitMSC call. The new value
360 * msc = msc_base + get_vblank_count() - vblank_base;
362 * And for waiting on a value, core code will use:
363 * actual_target = target_msc - msc_base + vblank_base;
371 * Pointer to context to which this drawable is currently bound.
373 __DRIcontext
*driContextPriv
;
376 * Pointer to screen on which this drawable was created.
378 __DRIscreen
*driScreenPriv
;
381 * Controls swap interval as used by GLX_SGI_swap_control and
382 * GLX_MESA_swap_control.
384 unsigned int swap_interval
;
388 drm_clip_rect_t clipRect
;
393 * Per-context private driver information.
395 struct __DRIcontextRec
{
397 * Kernel context handle used to access the device lock.
399 drm_context_t hHWContext
;
402 * Device driver's private context data. This structure is opaque.
407 * Pointer to drawable currently bound to this context for drawing.
409 __DRIdrawable
*driDrawablePriv
;
412 * Pointer to drawable currently bound to this context for reading.
414 __DRIdrawable
*driReadablePriv
;
417 * Pointer to screen on which this context was created.
419 __DRIscreen
*driScreenPriv
;
422 * The loaders's private context data. This structure is opaque.
433 * Per-screen private driver information.
435 struct __DRIscreenRec
{
437 * Current screen's number
442 * Callback functions into the hardware-specific DRI driver code.
444 struct __DriverAPIRec DriverAPI
;
446 const __DRIextension
**extensions
;
448 * DDX / 2D driver version information.
450 __DRIversion ddx_version
;
453 * DRI X extension version information.
455 __DRIversion dri_version
;
458 * DRM (kernel module) version information.
460 __DRIversion drm_version
;
463 * ID used when the client sets the drawable lock.
465 * The X server uses this value to detect if the client has died while
466 * holding the drawable lock.
471 * File descriptor returned when the kernel device driver is opened.
474 * - authenticate client to kernel
475 * - map the frame buffer, SAREA, etc.
476 * - close the kernel device driver
485 * - the device-independent per-drawable and per-context(?) information
490 * \name Direct frame buffer access information
491 * Used for software fallbacks.
504 * \name Device-dependent private information (stored in the SAREA).
506 * This data is accessed by the client driver only.
514 * Device-dependent private information (not stored in the SAREA).
516 * This pointer is never touched by the DRI layer.
524 /* Extensions provided by the loader. */
525 const __DRIgetDrawableInfoExtension
*getDrawableInfo
;
526 const __DRIsystemTimeExtension
*systemTime
;
527 const __DRIdamageExtension
*damage
;
530 /* Flag to indicate that this is a DRI2 screen. Many of the above
531 * fields will not be valid or initializaed in that case. */
533 __DRIdri2LoaderExtension
*loader
;
534 __DRIimageLookupExtension
*image
;
535 __DRIuseInvalidateExtension
*useInvalidate
;
538 /* The lock actually in use, old sarea or DRI2 */
541 driOptionCache optionInfo
;
542 driOptionCache optionCache
;
543 unsigned int api_mask
;
548 __driUtilUpdateDrawableInfo(__DRIdrawable
*pdp
);
551 driCalculateSwapUsage( __DRIdrawable
*dPriv
,
552 int64_t last_swap_ust
, int64_t current_ust
);
555 driIntersectArea( drm_clip_rect_t rect1
, drm_clip_rect_t rect2
);
558 dri2InvalidateDrawable(__DRIdrawable
*drawable
);
560 #endif /* _DRI_UTIL_H_ */