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 __DRIextension driReadDrawableExtension;
69 extern const __DRIcopySubBufferExtension driCopySubBufferExtension;
70 extern const __DRIswapControlExtension driSwapControlExtension;
71 extern const __DRImediaStreamCounterExtension driMediaStreamCounterExtension;
72 extern const __DRI2configQueryExtension dri2ConfigQueryExtension;
75 * Used by DRI_VALIDATE_DRAWABLE_INFO
77 #define DRI_VALIDATE_DRAWABLE_INFO_ONCE(pDrawPriv) \
79 if (*(pDrawPriv->pStamp) != pDrawPriv->lastStamp) { \
80 __driUtilUpdateDrawableInfo(pDrawPriv); \
86 * Utility macro to validate the drawable information.
88 * See __DRIdrawable::pStamp and __DRIdrawable::lastStamp.
90 #define DRI_VALIDATE_DRAWABLE_INFO(psp, pdp) \
92 while (*(pdp->pStamp) != pdp->lastStamp) { \
93 register unsigned int hwContext = psp->pSAREA->lock.lock & \
94 ~(DRM_LOCK_HELD | DRM_LOCK_CONT); \
95 DRM_UNLOCK(psp->fd, &psp->pSAREA->lock, hwContext); \
97 DRM_SPINLOCK(&psp->pSAREA->drawable_lock, psp->drawLockID); \
98 DRI_VALIDATE_DRAWABLE_INFO_ONCE(pdp); \
99 DRM_SPINUNLOCK(&psp->pSAREA->drawable_lock, psp->drawLockID); \
101 DRM_LIGHT_LOCK(psp->fd, &psp->pSAREA->lock, hwContext); \
106 * Same as above, but for two drawables simultaneously.
110 #define DRI_VALIDATE_TWO_DRAWABLES_INFO(psp, pdp, prp) \
112 while (*((pdp)->pStamp) != (pdp)->lastStamp || \
113 *((prp)->pStamp) != (prp)->lastStamp) { \
114 register unsigned int hwContext = (psp)->pSAREA->lock.lock & \
115 ~(DRM_LOCK_HELD | DRM_LOCK_CONT); \
116 DRM_UNLOCK((psp)->fd, &(psp)->pSAREA->lock, hwContext); \
118 DRM_SPINLOCK(&(psp)->pSAREA->drawable_lock, (psp)->drawLockID); \
119 DRI_VALIDATE_DRAWABLE_INFO_ONCE(pdp); \
120 DRI_VALIDATE_DRAWABLE_INFO_ONCE(prp); \
121 DRM_SPINUNLOCK(&(psp)->pSAREA->drawable_lock, (psp)->drawLockID); \
123 DRM_LIGHT_LOCK((psp)->fd, &(psp)->pSAREA->lock, hwContext); \
129 * Driver callback functions.
131 * Each DRI driver must have one of these structures with all the pointers set
132 * to appropriate functions within the driver.
134 * When glXCreateContext() is called, for example, it'll call a helper function
135 * dri_util.c which in turn will jump through the \a CreateContext pointer in
138 struct __DriverAPIRec {
139 const __DRIconfig **(*InitScreen) (__DRIscreen * priv);
142 * Screen destruction callback
144 void (*DestroyScreen)(__DRIscreen *driScrnPriv);
147 * Context creation callback
149 GLboolean (*CreateContext)(gl_api api,
150 const struct gl_config *glVis,
151 __DRIcontext *driContextPriv,
152 void *sharedContextPrivate);
155 * Context destruction callback
157 void (*DestroyContext)(__DRIcontext *driContextPriv);
160 * Buffer (drawable) creation callback
162 GLboolean (*CreateBuffer)(__DRIscreen *driScrnPriv,
163 __DRIdrawable *driDrawPriv,
164 const struct gl_config *glVis,
165 GLboolean pixmapBuffer);
168 * Buffer (drawable) destruction callback
170 void (*DestroyBuffer)(__DRIdrawable *driDrawPriv);
173 * Buffer swapping callback
175 void (*SwapBuffers)(__DRIdrawable *driDrawPriv);
178 * Context activation callback
180 GLboolean (*MakeCurrent)(__DRIcontext *driContextPriv,
181 __DRIdrawable *driDrawPriv,
182 __DRIdrawable *driReadPriv);
185 * Context unbinding callback
187 GLboolean (*UnbindContext)(__DRIcontext *driContextPriv);
190 * Retrieves statistics about buffer swap operations. Required if
191 * GLX_OML_sync_control or GLX_MESA_swap_frame_usage is supported.
193 int (*GetSwapInfo)( __DRIdrawable *dPriv, __DRIswapInfo * sInfo );
197 * These are required if GLX_OML_sync_control is supported.
200 int (*WaitForMSC)( __DRIdrawable *priv, int64_t target_msc,
201 int64_t divisor, int64_t remainder,
203 int (*WaitForSBC)( __DRIdrawable *priv, int64_t target_sbc,
204 int64_t * msc, int64_t * sbc );
206 int64_t (*SwapBuffersMSC)( __DRIdrawable *priv, int64_t target_msc,
207 int64_t divisor, int64_t remainder );
209 void (*CopySubBuffer)(__DRIdrawable *driDrawPriv,
210 int x, int y, int w, int h);
213 * New version of GetMSC so we can pass drawable data to the low
214 * level DRM driver (e.g. pipe info). Required if
215 * GLX_SGI_video_sync or GLX_OML_sync_control is supported.
217 int (*GetDrawableMSC) ( __DRIscreen * priv,
218 __DRIdrawable *drawablePrivate,
223 /* DRI2 Entry point */
224 const __DRIconfig **(*InitScreen2) (__DRIscreen * priv);
226 __DRIbuffer *(*AllocateBuffer) (__DRIscreen *screenPrivate,
227 unsigned int attachment,
229 int width, int height);
230 void (*ReleaseBuffer) (__DRIscreen *screenPrivate, __DRIbuffer *buffer);
233 extern const struct __DriverAPIRec driDriverAPI;
236 struct __DRIswapInfoRec {
238 * Number of swapBuffers operations that have been *completed*.
243 * Unadjusted system time of the last buffer swap. This is the time
244 * when the swap completed, not the time when swapBuffers was called.
249 * Number of swap operations that occurred after the swap deadline. That
250 * is if a swap happens more than swap_interval frames after the previous
251 * swap, it has missed its deadline. If swap_interval is 0, then the
252 * swap deadline is 1 frame after the previous swap.
254 uint64_t swap_missed_count;
257 * Amount of time used by the last swap that missed its deadline. This
258 * is calculated as (__glXGetUST() - swap_ust) / (swap_interval *
259 * time_for_single_vrefresh)). If the actual value of swap_interval is
260 * 0, then 1 is used instead. If swap_missed_count is non-zero, this
261 * should be greater-than 1.0.
263 float swap_missed_usage;
268 * Per-drawable private DRI driver information.
270 struct __DRIdrawableRec {
272 * Kernel drawable handle
274 drm_drawable_t hHWDrawable;
277 * Driver's private drawable information.
279 * This structure is opaque.
284 * Private data from the loader. We just hold on to it and pass
285 * it back when calling into loader provided functions.
290 * Reference count for number of context's currently bound to this
293 * Once it reaches zero, the drawable can be destroyed.
295 * \note This behavior will change with GLX 1.3.
300 * Index of this drawable information in the SAREA.
305 * Pointer to the "drawable has changed ID" stamp in the SAREA (or
306 * to dri2.stamp if DRI2 is being used).
308 unsigned int *pStamp;
311 * Last value of the stamp.
313 * If this differs from the value stored at __DRIdrawable::pStamp,
314 * then the drawable information has been modified by the X server, and the
315 * drawable information (below) should be retrieved from the X server.
317 unsigned int lastStamp;
322 * Drawable information used in software fallbacks.
330 drm_clip_rect_t *pClipRects;
334 * \name Back and depthbuffer
336 * Information about the back and depthbuffer where different from above.
341 int backClipRectType;
342 int numBackClipRects;
343 drm_clip_rect_t *pBackClipRects;
347 * \name Vertical blank tracking information
348 * Used for waiting on vertical blank events.
352 unsigned int vblFlags;
356 * \name Monotonic MSC tracking
358 * Low level driver is responsible for updating msc_base and
359 * vblSeq values so that higher level code can calculate
360 * a new msc value or msc target for a WaitMSC call. The new value
362 * msc = msc_base + get_vblank_count() - vblank_base;
364 * And for waiting on a value, core code will use:
365 * actual_target = target_msc - msc_base + vblank_base;
373 * Pointer to context to which this drawable is currently bound.
375 __DRIcontext *driContextPriv;
378 * Pointer to screen on which this drawable was created.
380 __DRIscreen *driScreenPriv;
383 * Controls swap interval as used by GLX_SGI_swap_control and
384 * GLX_MESA_swap_control.
386 unsigned int swap_interval;
390 drm_clip_rect_t clipRect;
395 * Per-context private driver information.
397 struct __DRIcontextRec {
399 * Kernel context handle used to access the device lock.
401 drm_context_t hHWContext;
404 * Device driver's private context data. This structure is opaque.
409 * Pointer to drawable currently bound to this context for drawing.
411 __DRIdrawable *driDrawablePriv;
414 * Pointer to drawable currently bound to this context for reading.
416 __DRIdrawable *driReadablePriv;
419 * Pointer to screen on which this context was created.
421 __DRIscreen *driScreenPriv;
424 * The loaders's private context data. This structure is opaque.
435 * Per-screen private driver information.
437 struct __DRIscreenRec {
439 * Current screen's number
444 * Callback functions into the hardware-specific DRI driver code.
446 struct __DriverAPIRec DriverAPI;
448 const __DRIextension **extensions;
450 * DDX / 2D driver version information.
452 __DRIversion ddx_version;
455 * DRI X extension version information.
457 __DRIversion dri_version;
460 * DRM (kernel module) version information.
462 __DRIversion drm_version;
465 * ID used when the client sets the drawable lock.
467 * The X server uses this value to detect if the client has died while
468 * holding the drawable lock.
473 * File descriptor returned when the kernel device driver is opened.
476 * - authenticate client to kernel
477 * - map the frame buffer, SAREA, etc.
478 * - close the kernel device driver
487 * - the device-independent per-drawable and per-context(?) information
492 * \name Direct frame buffer access information
493 * Used for software fallbacks.
506 * \name Device-dependent private information (stored in the SAREA).
508 * This data is accessed by the client driver only.
516 * Device-dependent private information (not stored in the SAREA).
518 * This pointer is never touched by the DRI layer.
526 /* Extensions provided by the loader. */
527 const __DRIgetDrawableInfoExtension *getDrawableInfo;
528 const __DRIsystemTimeExtension *systemTime;
529 const __DRIdamageExtension *damage;
532 /* Flag to indicate that this is a DRI2 screen. Many of the above
533 * fields will not be valid or initializaed in that case. */
535 __DRIdri2LoaderExtension *loader;
536 __DRIimageLookupExtension *image;
537 __DRIuseInvalidateExtension *useInvalidate;
540 /* The lock actually in use, old sarea or DRI2 */
543 driOptionCache optionInfo;
544 driOptionCache optionCache;
545 unsigned int api_mask;
550 __driUtilUpdateDrawableInfo(__DRIdrawable *pdp);
553 driCalculateSwapUsage( __DRIdrawable *dPriv,
554 int64_t last_swap_ust, int64_t current_ust );
557 driIntersectArea( drm_clip_rect_t rect1, drm_clip_rect_t rect2 );
560 dri2InvalidateDrawable(__DRIdrawable *drawable);
562 #endif /* _DRI_UTIL_H_ */