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); \
111 * Driver callback functions.
113 * Each DRI driver must have one of these structures with all the pointers set
114 * to appropriate functions within the driver.
116 * When glXCreateContext() is called, for example, it'll call a helper function
117 * dri_util.c which in turn will jump through the \a CreateContext pointer in
120 struct __DriverAPIRec
{
121 const __DRIconfig
**(*InitScreen
) (__DRIscreen
* priv
);
124 * Screen destruction callback
126 void (*DestroyScreen
)(__DRIscreen
*driScrnPriv
);
129 * Context creation callback
131 GLboolean (*CreateContext
)(const __GLcontextModes
*glVis
,
132 __DRIcontext
*driContextPriv
,
133 void *sharedContextPrivate
);
136 * Context destruction callback
138 void (*DestroyContext
)(__DRIcontext
*driContextPriv
);
141 * Buffer (drawable) creation callback
143 GLboolean (*CreateBuffer
)(__DRIscreen
*driScrnPriv
,
144 __DRIdrawable
*driDrawPriv
,
145 const __GLcontextModes
*glVis
,
146 GLboolean pixmapBuffer
);
149 * Buffer (drawable) destruction callback
151 void (*DestroyBuffer
)(__DRIdrawable
*driDrawPriv
);
154 * Buffer swapping callback
156 void (*SwapBuffers
)(__DRIdrawable
*driDrawPriv
);
159 * Context activation callback
161 GLboolean (*MakeCurrent
)(__DRIcontext
*driContextPriv
,
162 __DRIdrawable
*driDrawPriv
,
163 __DRIdrawable
*driReadPriv
);
166 * Context unbinding callback
168 GLboolean (*UnbindContext
)(__DRIcontext
*driContextPriv
);
171 * Retrieves statistics about buffer swap operations. Required if
172 * GLX_OML_sync_control or GLX_MESA_swap_frame_usage is supported.
174 int (*GetSwapInfo
)( __DRIdrawable
*dPriv
, __DRIswapInfo
* sInfo
);
178 * These are required if GLX_OML_sync_control is supported.
181 int (*WaitForMSC
)( __DRIdrawable
*priv
, int64_t target_msc
,
182 int64_t divisor
, int64_t remainder
,
184 int (*WaitForSBC
)( __DRIdrawable
*priv
, int64_t target_sbc
,
185 int64_t * msc
, int64_t * sbc
);
187 int64_t (*SwapBuffersMSC
)( __DRIdrawable
*priv
, int64_t target_msc
,
188 int64_t divisor
, int64_t remainder
);
190 void (*CopySubBuffer
)(__DRIdrawable
*driDrawPriv
,
191 int x
, int y
, int w
, int h
);
194 * New version of GetMSC so we can pass drawable data to the low
195 * level DRM driver (e.g. pipe info). Required if
196 * GLX_SGI_video_sync or GLX_OML_sync_control is supported.
198 int (*GetDrawableMSC
) ( __DRIscreen
* priv
,
199 __DRIdrawable
*drawablePrivate
,
204 /* DRI2 Entry point */
205 const __DRIconfig
**(*InitScreen2
) (__DRIscreen
* priv
);
208 extern const struct __DriverAPIRec driDriverAPI
;
211 struct __DRIswapInfoRec
{
213 * Number of swapBuffers operations that have been *completed*.
218 * Unadjusted system time of the last buffer swap. This is the time
219 * when the swap completed, not the time when swapBuffers was called.
224 * Number of swap operations that occurred after the swap deadline. That
225 * is if a swap happens more than swap_interval frames after the previous
226 * swap, it has missed its deadline. If swap_interval is 0, then the
227 * swap deadline is 1 frame after the previous swap.
229 uint64_t swap_missed_count
;
232 * Amount of time used by the last swap that missed its deadline. This
233 * is calculated as (__glXGetUST() - swap_ust) / (swap_interval *
234 * time_for_single_vrefresh)). If the actual value of swap_interval is
235 * 0, then 1 is used instead. If swap_missed_count is non-zero, this
236 * should be greater-than 1.0.
238 float swap_missed_usage
;
243 * Per-drawable private DRI driver information.
245 struct __DRIdrawableRec
{
247 * Kernel drawable handle
249 drm_drawable_t hHWDrawable
;
252 * Driver's private drawable information.
254 * This structure is opaque.
259 * Private data from the loader. We just hold on to it and pass
260 * it back when calling into loader provided functions.
265 * Reference count for number of context's currently bound to this
268 * Once it reaches zero, the drawable can be destroyed.
270 * \note This behavior will change with GLX 1.3.
275 * Index of this drawable information in the SAREA.
280 * Pointer to the "drawable has changed ID" stamp in the SAREA.
282 unsigned int *pStamp
;
285 * Last value of the stamp.
287 * If this differs from the value stored at __DRIdrawable::pStamp,
288 * then the drawable information has been modified by the X server, and the
289 * drawable information (below) should be retrieved from the X server.
291 unsigned int lastStamp
;
296 * Drawable information used in software fallbacks.
304 drm_clip_rect_t
*pClipRects
;
308 * \name Back and depthbuffer
310 * Information about the back and depthbuffer where different from above.
315 int backClipRectType
;
316 int numBackClipRects
;
317 drm_clip_rect_t
*pBackClipRects
;
321 * \name Vertical blank tracking information
322 * Used for waiting on vertical blank events.
326 unsigned int vblFlags
;
330 * \name Monotonic MSC tracking
332 * Low level driver is responsible for updating msc_base and
333 * vblSeq values so that higher level code can calculate
334 * a new msc value or msc target for a WaitMSC call. The new value
336 * msc = msc_base + get_vblank_count() - vblank_base;
338 * And for waiting on a value, core code will use:
339 * actual_target = target_msc - msc_base + vblank_base;
347 * Pointer to context to which this drawable is currently bound.
349 __DRIcontext
*driContextPriv
;
352 * Pointer to screen on which this drawable was created.
354 __DRIscreen
*driScreenPriv
;
357 * Controls swap interval as used by GLX_SGI_swap_control and
358 * GLX_MESA_swap_control.
360 unsigned int swap_interval
;
364 * Per-context private driver information.
366 struct __DRIcontextRec
{
368 * Kernel context handle used to access the device lock.
370 drm_context_t hHWContext
;
373 * Device driver's private context data. This structure is opaque.
378 * Pointer back to the \c __DRIcontext that contains this structure.
383 * Pointer to drawable currently bound to this context for drawing.
385 __DRIdrawable
*driDrawablePriv
;
388 * Pointer to drawable currently bound to this context for reading.
390 __DRIdrawable
*driReadablePriv
;
393 * Pointer to screen on which this context was created.
395 __DRIscreen
*driScreenPriv
;
399 * Per-screen private driver information.
401 struct __DRIscreenRec
{
403 * Current screen's number
408 * Callback functions into the hardware-specific DRI driver code.
410 struct __DriverAPIRec DriverAPI
;
412 const __DRIextension
**extensions
;
414 * DDX / 2D driver version information.
416 __DRIversion ddx_version
;
419 * DRI X extension version information.
421 __DRIversion dri_version
;
424 * DRM (kernel module) version information.
426 __DRIversion drm_version
;
429 * ID used when the client sets the drawable lock.
431 * The X server uses this value to detect if the client has died while
432 * holding the drawable lock.
437 * File descriptor returned when the kernel device driver is opened.
440 * - authenticate client to kernel
441 * - map the frame buffer, SAREA, etc.
442 * - close the kernel device driver
451 * - the device-independent per-drawable and per-context(?) information
456 * \name Direct frame buffer access information
457 * Used for software fallbacks.
470 * \name Device-dependent private information (stored in the SAREA).
472 * This data is accessed by the client driver only.
480 * Dummy context to which drawables are bound when not bound to any
483 * A dummy hHWContext is created for this context, and is used by the GL
484 * core when a hardware lock is required but the drawable is not currently
485 * bound (e.g., potentially during a SwapBuffers request). The dummy
486 * context is created when the first "real" context is created on this
489 __DRIcontext dummyContextPriv
;
492 * Device-dependent private information (not stored in the SAREA).
494 * This pointer is never touched by the DRI layer.
499 * Pointer back to the \c __DRIscreen that contains this structure.
503 /* Extensions provided by the loader. */
504 const __DRIgetDrawableInfoExtension
*getDrawableInfo
;
505 const __DRIsystemTimeExtension
*systemTime
;
506 const __DRIdamageExtension
*damage
;
509 /* Flag to indicate that this is a DRI2 screen. Many of the above
510 * fields will not be valid or initializaed in that case. */
512 __DRIdri2LoaderExtension
*loader
;
515 /* The lock actually in use, old sarea or DRI2 */
520 __driUtilMessage(const char *f
, ...);
524 __driUtilUpdateDrawableInfo(__DRIdrawable
*pdp
);
527 driCalculateSwapUsage( __DRIdrawable
*dPriv
,
528 int64_t last_swap_ust
, int64_t current_ust
);
531 driIntersectArea( drm_clip_rect_t rect1
, drm_clip_rect_t rect2
);
533 #endif /* _DRI_UTIL_H_ */