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 "main/glheader.h"
55 #include "GL/internal/glcore.h"
56 #include "GL/internal/dri_interface.h"
58 #define GLX_BAD_CONTEXT 5
60 typedef struct __DRIswapInfoRec __DRIswapInfo
;
62 /* Typedefs to avoid rewriting the world. */
63 typedef struct __DRIscreenRec __DRIscreenPrivate
;
64 typedef struct __DRIdrawableRec __DRIdrawablePrivate
;
65 typedef struct __DRIcontextRec __DRIcontextPrivate
;
70 extern const __DRIlegacyExtension driLegacyExtension
;
71 extern const __DRIcoreExtension driCoreExtension
;
72 extern const __DRIextension driReadDrawableExtension
;
73 extern const __DRIcopySubBufferExtension driCopySubBufferExtension
;
74 extern const __DRIswapControlExtension driSwapControlExtension
;
75 extern const __DRIframeTrackingExtension driFrameTrackingExtension
;
76 extern const __DRImediaStreamCounterExtension driMediaStreamCounterExtension
;
79 * Used by DRI_VALIDATE_DRAWABLE_INFO
81 #define DRI_VALIDATE_DRAWABLE_INFO_ONCE(pDrawPriv) \
83 if (*(pDrawPriv->pStamp) != pDrawPriv->lastStamp) { \
84 __driUtilUpdateDrawableInfo(pDrawPriv); \
90 * Utility macro to validate the drawable information.
92 * See __DRIdrawable::pStamp and __DRIdrawable::lastStamp.
94 #define DRI_VALIDATE_DRAWABLE_INFO(psp, pdp) \
96 while (*(pdp->pStamp) != pdp->lastStamp) { \
97 register unsigned int hwContext = psp->pSAREA->lock.lock & \
98 ~(DRM_LOCK_HELD | DRM_LOCK_CONT); \
99 DRM_UNLOCK(psp->fd, &psp->pSAREA->lock, hwContext); \
101 DRM_SPINLOCK(&psp->pSAREA->drawable_lock, psp->drawLockID); \
102 DRI_VALIDATE_DRAWABLE_INFO_ONCE(pdp); \
103 DRM_SPINUNLOCK(&psp->pSAREA->drawable_lock, psp->drawLockID); \
105 DRM_LIGHT_LOCK(psp->fd, &psp->pSAREA->lock, hwContext); \
110 * Same as above, but for two drawables simultaneously.
114 #define DRI_VALIDATE_TWO_DRAWABLES_INFO(psp, pdp, prp) \
116 while (*((pdp)->pStamp) != (pdp)->lastStamp || \
117 *((prp)->pStamp) != (prp)->lastStamp) { \
118 register unsigned int hwContext = (psp)->pSAREA->lock.lock & \
119 ~(DRM_LOCK_HELD | DRM_LOCK_CONT); \
120 DRM_UNLOCK((psp)->fd, &(psp)->pSAREA->lock, hwContext); \
122 DRM_SPINLOCK(&(psp)->pSAREA->drawable_lock, (psp)->drawLockID); \
123 DRI_VALIDATE_DRAWABLE_INFO_ONCE(pdp); \
124 DRI_VALIDATE_DRAWABLE_INFO_ONCE(prp); \
125 DRM_SPINUNLOCK(&(psp)->pSAREA->drawable_lock, (psp)->drawLockID); \
127 DRM_LIGHT_LOCK((psp)->fd, &(psp)->pSAREA->lock, hwContext); \
133 * Driver callback functions.
135 * Each DRI driver must have one of these structures with all the pointers set
136 * to appropriate functions within the driver.
138 * When glXCreateContext() is called, for example, it'll call a helper function
139 * dri_util.c which in turn will jump through the \a CreateContext pointer in
142 struct __DriverAPIRec
{
143 const __DRIconfig
**(*InitScreen
) (__DRIscreen
* priv
);
146 * Screen destruction callback
148 void (*DestroyScreen
)(__DRIscreen
*driScrnPriv
);
151 * Context creation callback
153 GLboolean (*CreateContext
)(const __GLcontextModes
*glVis
,
154 __DRIcontext
*driContextPriv
,
155 void *sharedContextPrivate
);
158 * Context destruction callback
160 void (*DestroyContext
)(__DRIcontext
*driContextPriv
);
163 * Buffer (drawable) creation callback
165 GLboolean (*CreateBuffer
)(__DRIscreen
*driScrnPriv
,
166 __DRIdrawable
*driDrawPriv
,
167 const __GLcontextModes
*glVis
,
168 GLboolean pixmapBuffer
);
171 * Buffer (drawable) destruction callback
173 void (*DestroyBuffer
)(__DRIdrawable
*driDrawPriv
);
176 * Buffer swapping callback
178 void (*SwapBuffers
)(__DRIdrawable
*driDrawPriv
);
181 * Context activation callback
183 GLboolean (*MakeCurrent
)(__DRIcontext
*driContextPriv
,
184 __DRIdrawable
*driDrawPriv
,
185 __DRIdrawable
*driReadPriv
);
188 * Context unbinding callback
190 GLboolean (*UnbindContext
)(__DRIcontext
*driContextPriv
);
193 * Retrieves statistics about buffer swap operations. Required if
194 * GLX_OML_sync_control or GLX_MESA_swap_frame_usage is supported.
196 int (*GetSwapInfo
)( __DRIdrawable
*dPriv
, __DRIswapInfo
* sInfo
);
200 * These are required if GLX_OML_sync_control is supported.
203 int (*WaitForMSC
)( __DRIdrawable
*priv
, int64_t target_msc
,
204 int64_t divisor
, int64_t remainder
,
206 int (*WaitForSBC
)( __DRIdrawable
*priv
, int64_t target_sbc
,
207 int64_t * msc
, int64_t * sbc
);
209 int64_t (*SwapBuffersMSC
)( __DRIdrawable
*priv
, int64_t target_msc
,
210 int64_t divisor
, int64_t remainder
);
212 void (*CopySubBuffer
)(__DRIdrawable
*driDrawPriv
,
213 int x
, int y
, int w
, int h
);
216 * New version of GetMSC so we can pass drawable data to the low
217 * level DRM driver (e.g. pipe info). Required if
218 * GLX_SGI_video_sync or GLX_OML_sync_control is supported.
220 int (*GetDrawableMSC
) ( __DRIscreen
* priv
,
221 __DRIdrawable
*drawablePrivate
,
226 /* DRI2 Entry point */
227 const __DRIconfig
**(*InitScreen2
) (__DRIscreen
* priv
);
230 extern const struct __DriverAPIRec driDriverAPI
;
233 struct __DRIswapInfoRec
{
235 * Number of swapBuffers operations that have been *completed*.
240 * Unadjusted system time of the last buffer swap. This is the time
241 * when the swap completed, not the time when swapBuffers was called.
246 * Number of swap operations that occurred after the swap deadline. That
247 * is if a swap happens more than swap_interval frames after the previous
248 * swap, it has missed its deadline. If swap_interval is 0, then the
249 * swap deadline is 1 frame after the previous swap.
251 uint64_t swap_missed_count
;
254 * Amount of time used by the last swap that missed its deadline. This
255 * is calculated as (__glXGetUST() - swap_ust) / (swap_interval *
256 * time_for_single_vrefresh)). If the actual value of swap_interval is
257 * 0, then 1 is used instead. If swap_missed_count is non-zero, this
258 * should be greater-than 1.0.
260 float swap_missed_usage
;
265 * Per-drawable private DRI driver information.
267 struct __DRIdrawableRec
{
269 * Kernel drawable handle
271 drm_drawable_t hHWDrawable
;
274 * Driver's private drawable information.
276 * This structure is opaque.
281 * Private data from the loader. We just hold on to it and pass
282 * it back when calling into loader provided functions.
287 * Reference count for number of context's currently bound to this
290 * Once it reaches zero, the drawable can be destroyed.
292 * \note This behavior will change with GLX 1.3.
297 * Index of this drawable information in the SAREA.
302 * Pointer to the "drawable has changed ID" stamp in the SAREA.
304 unsigned int *pStamp
;
307 * Last value of the stamp.
309 * If this differs from the value stored at __DRIdrawable::pStamp,
310 * then the drawable information has been modified by the X server, and the
311 * drawable information (below) should be retrieved from the X server.
313 unsigned int lastStamp
;
318 * Drawable information used in software fallbacks.
326 drm_clip_rect_t
*pClipRects
;
330 * \name Back and depthbuffer
332 * Information about the back and depthbuffer where different from above.
337 int backClipRectType
;
338 int numBackClipRects
;
339 drm_clip_rect_t
*pBackClipRects
;
343 * \name Vertical blank tracking information
344 * Used for waiting on vertical blank events.
348 unsigned int vblFlags
;
352 * \name Monotonic MSC tracking
354 * Low level driver is responsible for updating msc_base and
355 * vblSeq values so that higher level code can calculate
356 * a new msc value or msc target for a WaitMSC call. The new value
358 * msc = msc_base + get_vblank_count() - vblank_base;
360 * And for waiting on a value, core code will use:
361 * actual_target = target_msc - msc_base + vblank_base;
369 * Pointer to context to which this drawable is currently bound.
371 __DRIcontext
*driContextPriv
;
374 * Pointer to screen on which this drawable was created.
376 __DRIscreen
*driScreenPriv
;
379 * Controls swap interval as used by GLX_SGI_swap_control and
380 * GLX_MESA_swap_control.
382 unsigned int swap_interval
;
386 * Per-context private driver information.
388 struct __DRIcontextRec
{
390 * Kernel context handle used to access the device lock.
392 drm_context_t hHWContext
;
395 * Device driver's private context data. This structure is opaque.
400 * Pointer back to the \c __DRIcontext that contains this structure.
405 * Pointer to drawable currently bound to this context for drawing.
407 __DRIdrawable
*driDrawablePriv
;
410 * Pointer to drawable currently bound to this context for reading.
412 __DRIdrawable
*driReadablePriv
;
415 * Pointer to screen on which this context was created.
417 __DRIscreen
*driScreenPriv
;
421 * Per-screen private driver information.
423 struct __DRIscreenRec
{
425 * Current screen's number
430 * Callback functions into the hardware-specific DRI driver code.
432 struct __DriverAPIRec DriverAPI
;
434 const __DRIextension
**extensions
;
436 * DDX / 2D driver version information.
438 __DRIversion ddx_version
;
441 * DRI X extension version information.
443 __DRIversion dri_version
;
446 * DRM (kernel module) version information.
448 __DRIversion drm_version
;
451 * ID used when the client sets the drawable lock.
453 * The X server uses this value to detect if the client has died while
454 * holding the drawable lock.
459 * File descriptor returned when the kernel device driver is opened.
462 * - authenticate client to kernel
463 * - map the frame buffer, SAREA, etc.
464 * - close the kernel device driver
473 * - the device-independent per-drawable and per-context(?) information
478 * \name Direct frame buffer access information
479 * Used for software fallbacks.
492 * \name Device-dependent private information (stored in the SAREA).
494 * This data is accessed by the client driver only.
502 * Dummy context to which drawables are bound when not bound to any
505 * A dummy hHWContext is created for this context, and is used by the GL
506 * core when a hardware lock is required but the drawable is not currently
507 * bound (e.g., potentially during a SwapBuffers request). The dummy
508 * context is created when the first "real" context is created on this
511 __DRIcontext dummyContextPriv
;
514 * Device-dependent private information (not stored in the SAREA).
516 * This pointer is never touched by the DRI layer.
521 * Pointer back to the \c __DRIscreen that contains this structure.
525 /* Extensions provided by the loader. */
526 const __DRIgetDrawableInfoExtension
*getDrawableInfo
;
527 const __DRIsystemTimeExtension
*systemTime
;
528 const __DRIdamageExtension
*damage
;
531 /* Flag to indicate that this is a DRI2 screen. Many of the above
532 * fields will not be valid or initializaed in that case. */
534 __DRIdri2LoaderExtension
*loader
;
537 /* The lock actually in use, old sarea or DRI2 */
542 __driUtilMessage(const char *f
, ...);
546 __driUtilUpdateDrawableInfo(__DRIdrawable
*pdp
);
549 driCalculateSwapUsage( __DRIdrawable
*dPriv
,
550 int64_t last_swap_ust
, int64_t current_ust
);
553 driIntersectArea( drm_clip_rect_t rect1
, drm_clip_rect_t rect2
);
555 #endif /* _DRI_UTIL_H_ */