src/mesa/drivers/dri/common/dri_util.h

   1 /*
   2  * Copyright 1998-1999 Precision Insight, Inc., Cedar Park, Texas.
   3  * All Rights Reserved.
   4  *
   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:
  12  *
  13  * The above copyright notice and this permission notice (including the
  14  * next paragraph) shall be included in all copies or substantial portions
  15  * of the Software.
  16  *
  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.
  24  */
  25
  26 /**
  27  * \file dri_util.h
  28  * DRI utility functions definitions.
  29  *
  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
  33  * drivers.
  34  *
  35  * Basically, these utility functions take care of some of the dirty details of
  36  * screen initialization, context creation, context binding, DRM setup, etc.
  37  *
  38  * These functions are compiled into each DRI driver so libGL.so knows nothing
  39  * about them.
  40  *
  41  * \sa dri_util.c.
  42  *
  43  * \author Kevin E. Martin <kevin@precisioninsight.com>
  44  * \author Brian Paul <brian@precisioninsight.com>
  45  */
  46
  47 #ifndef _DRI_UTIL_H_
  48 #define _DRI_UTIL_H_
  49
  50 #include <GL/gl.h>
  51 #include <drm.h>
  52 #include <drm_sarea.h>
  53 #include <xf86drm.h>
  54 #include "xmlconfig.h"
  55 #include "main/glheader.h"
  56 #include "main/mtypes.h"
  57 #include "GL/internal/dri_interface.h"
  58
  59 #define GLX_BAD_CONTEXT                    5
  60
  61 typedef struct __DRIswapInfoRec        __DRIswapInfo;
  62
  63 /**
  64  * Extensions.
  65  */
  66 extern const __DRIcoreExtension driCoreExtension;
  67 extern const __DRIdri2Extension driDRI2Extension;
  68 extern const __DRIcopySubBufferExtension driCopySubBufferExtension;
  69 extern const __DRIswapControlExtension driSwapControlExtension;
  70 extern const __DRImediaStreamCounterExtension driMediaStreamCounterExtension;
  71 extern const __DRI2configQueryExtension dri2ConfigQueryExtension;
  72
  73 /**
  74  * Used by DRI_VALIDATE_DRAWABLE_INFO
  75  */
  76 #define DRI_VALIDATE_DRAWABLE_INFO_ONCE(pDrawPriv)              \
  77     do {                                                        \
  78         if (*(pDrawPriv->pStamp) != pDrawPriv->lastStamp) {     \
  79             __driUtilUpdateDrawableInfo(pDrawPriv);             \
  80         }                                                       \
  81     } while (0)
  82
  83
  84 /**
  85  * Utility macro to validate the drawable information.
  86  *
  87  * See __DRIdrawable::pStamp and __DRIdrawable::lastStamp.
  88  */
  89 #define DRI_VALIDATE_DRAWABLE_INFO(psp, pdp)                            \
  90 do {                                                                    \
  91     while (*(pdp->pStamp) != pdp->lastStamp) {                          \
  92         register unsigned int hwContext = psp->pSAREA->lock.lock &      \
  93                      ~(DRM_LOCK_HELD | DRM_LOCK_CONT);                  \
  94         DRM_UNLOCK(psp->fd, &psp->pSAREA->lock, hwContext);             \
  95                                                                         \
  96         DRM_SPINLOCK(&psp->pSAREA->drawable_lock, psp->drawLockID);     \
  97         DRI_VALIDATE_DRAWABLE_INFO_ONCE(pdp);                           \
  98         DRM_SPINUNLOCK(&psp->pSAREA->drawable_lock, psp->drawLockID);   \
  99                                                                         \
 100         DRM_LIGHT_LOCK(psp->fd, &psp->pSAREA->lock, hwContext);         \
 101     }                                                                   \
 102 } while (0)
 103
 104 /**
 105  * Same as above, but for two drawables simultaneously.
 106  *
 107  */
 108
 109 #define DRI_VALIDATE_TWO_DRAWABLES_INFO(psp, pdp, prp)                  \
 110 do {                                                            \
 111     while (*((pdp)->pStamp) != (pdp)->lastStamp ||                      \
 112            *((prp)->pStamp) != (prp)->lastStamp) {                      \
 113         register unsigned int hwContext = (psp)->pSAREA->lock.lock &    \
 114             ~(DRM_LOCK_HELD | DRM_LOCK_CONT);                           \
 115         DRM_UNLOCK((psp)->fd, &(psp)->pSAREA->lock, hwContext);         \
 116                                                                         \
 117         DRM_SPINLOCK(&(psp)->pSAREA->drawable_lock, (psp)->drawLockID); \
 118         DRI_VALIDATE_DRAWABLE_INFO_ONCE(pdp);                           \
 119         DRI_VALIDATE_DRAWABLE_INFO_ONCE(prp);                           \
 120         DRM_SPINUNLOCK(&(psp)->pSAREA->drawable_lock, (psp)->drawLockID); \
 121                                                                         \
 122         DRM_LIGHT_LOCK((psp)->fd, &(psp)->pSAREA->lock, hwContext);     \
 123     }                                                                   \
 124 } while (0)
 125
 126
 127 /**
 128  * Driver callback functions.
 129  *
 130  * Each DRI driver must have one of these structures with all the pointers set
 131  * to appropriate functions within the driver.
 132  *
 133  * When glXCreateContext() is called, for example, it'll call a helper function
 134  * dri_util.c which in turn will jump through the \a CreateContext pointer in
 135  * this structure.
 136  */
 137 struct __DriverAPIRec {
 138     const __DRIconfig **(*InitScreen) (__DRIscreen * priv);
 139
 140     /**
 141      * Screen destruction callback
 142      */
 143     void (*DestroyScreen)(__DRIscreen *driScrnPriv);
 144
 145     /**
 146      * Context creation callback
 147      */
 148     GLboolean (*CreateContext)(gl_api api,
 149                                const struct gl_config *glVis,
 150                                __DRIcontext *driContextPriv,
 151                                void *sharedContextPrivate);
 152
 153     /**
 154      * Context destruction callback
 155      */
 156     void (*DestroyContext)(__DRIcontext *driContextPriv);
 157
 158     /**
 159      * Buffer (drawable) creation callback
 160      */
 161     GLboolean (*CreateBuffer)(__DRIscreen *driScrnPriv,
 162                               __DRIdrawable *driDrawPriv,
 163                               const struct gl_config *glVis,
 164                               GLboolean pixmapBuffer);
 165
 166     /**
 167      * Buffer (drawable) destruction callback
 168      */
 169     void (*DestroyBuffer)(__DRIdrawable *driDrawPriv);
 170
 171     /**
 172      * Buffer swapping callback
 173      */
 174     void (*SwapBuffers)(__DRIdrawable *driDrawPriv);
 175
 176     /**
 177      * Context activation callback
 178      */
 179     GLboolean (*MakeCurrent)(__DRIcontext *driContextPriv,
 180                              __DRIdrawable *driDrawPriv,
 181                              __DRIdrawable *driReadPriv);
 182
 183     /**
 184      * Context unbinding callback
 185      */
 186     GLboolean (*UnbindContext)(__DRIcontext *driContextPriv);
 187
 188     /**
 189      * Retrieves statistics about buffer swap operations.  Required if
 190      * GLX_OML_sync_control or GLX_MESA_swap_frame_usage is supported.
 191      */
 192     int (*GetSwapInfo)( __DRIdrawable *dPriv, __DRIswapInfo * sInfo );
 193
 194
 195     /**
 196      * These are required if GLX_OML_sync_control is supported.
 197      */
 198     /*@{*/
 199     int (*WaitForMSC)( __DRIdrawable *priv, int64_t target_msc,
 200                        int64_t divisor, int64_t remainder,
 201                        int64_t * msc );
 202     int (*WaitForSBC)( __DRIdrawable *priv, int64_t target_sbc,
 203                        int64_t * msc, int64_t * sbc );
 204
 205     int64_t (*SwapBuffersMSC)( __DRIdrawable *priv, int64_t target_msc,
 206                                int64_t divisor, int64_t remainder );
 207     /*@}*/
 208     void (*CopySubBuffer)(__DRIdrawable *driDrawPriv,
 209                           int x, int y, int w, int h);
 210
 211     /**
 212      * New version of GetMSC so we can pass drawable data to the low
 213      * level DRM driver (e.g. pipe info).  Required if
 214      * GLX_SGI_video_sync or GLX_OML_sync_control is supported.
 215      */
 216     int (*GetDrawableMSC) ( __DRIscreen * priv,
 217                             __DRIdrawable *drawablePrivate,
 218                             int64_t *count);
 219
 220
 221
 222     /* DRI2 Entry point */
 223     const __DRIconfig **(*InitScreen2) (__DRIscreen * priv);
 224
 225     __DRIbuffer *(*AllocateBuffer) (__DRIscreen *screenPrivate,
 226                                     unsigned int attachment,
 227                                     unsigned int format,
 228                                     int width, int height);
 229     void (*ReleaseBuffer) (__DRIscreen *screenPrivate, __DRIbuffer *buffer);
 230 };
 231
 232 extern const struct __DriverAPIRec driDriverAPI;
 233
 234
 235 struct __DRIswapInfoRec {
 236     /**
 237      * Number of swapBuffers operations that have been *completed*.
 238      */
 239     uint64_t swap_count;
 240
 241     /**
 242      * Unadjusted system time of the last buffer swap.  This is the time
 243      * when the swap completed, not the time when swapBuffers was called.
 244      */
 245     int64_t   swap_ust;
 246
 247     /**
 248      * Number of swap operations that occurred after the swap deadline.  That
 249      * is if a swap happens more than swap_interval frames after the previous
 250      * swap, it has missed its deadline.  If swap_interval is 0, then the
 251      * swap deadline is 1 frame after the previous swap.
 252      */
 253     uint64_t swap_missed_count;
 254
 255     /**
 256      * Amount of time used by the last swap that missed its deadline.  This
 257      * is calculated as (__glXGetUST() - swap_ust) / (swap_interval *
 258      * time_for_single_vrefresh)).  If the actual value of swap_interval is
 259      * 0, then 1 is used instead.  If swap_missed_count is non-zero, this
 260      * should be greater-than 1.0.
 261      */
 262     float     swap_missed_usage;
 263 };
 264
 265
 266 /**
 267  * Per-drawable private DRI driver information.
 268  */
 269 struct __DRIdrawableRec {
 270     /**
 271      * Kernel drawable handle
 272      */
 273     drm_drawable_t hHWDrawable;
 274
 275     /**
 276      * Driver's private drawable information.
 277      *
 278      * This structure is opaque.
 279      */
 280     void *driverPrivate;
 281
 282     /**
 283      * Private data from the loader.  We just hold on to it and pass
 284      * it back when calling into loader provided functions.
 285      */
 286     void *loaderPrivate;
 287
 288     /**
 289      * Reference count for number of context's currently bound to this
 290      * drawable.
 291      *
 292      * Once it reaches zero, the drawable can be destroyed.
 293      *
 294      * \note This behavior will change with GLX 1.3.
 295      */
 296     int refcount;
 297
 298     /**
 299      * Index of this drawable information in the SAREA.
 300      */
 301     unsigned int index;
 302
 303     /**
 304      * Pointer to the "drawable has changed ID" stamp in the SAREA (or
 305      * to dri2.stamp if DRI2 is being used).
 306      */
 307     unsigned int *pStamp;
 308
 309     /**
 310      * Last value of the stamp.
 311      *
 312      * If this differs from the value stored at __DRIdrawable::pStamp,
 313      * then the drawable information has been modified by the X server, and the
 314      * drawable information (below) should be retrieved from the X server.
 315      */
 316     unsigned int lastStamp;
 317
 318     /**
 319      * \name Drawable
 320      *
 321      * Drawable information used in software fallbacks.
 322      */
 323     /*@{*/
 324     int x;
 325     int y;
 326     int w;
 327     int h;
 328     int numClipRects;
 329     drm_clip_rect_t *pClipRects;
 330     /*@}*/
 331
 332     /**
 333      * \name Back and depthbuffer
 334      *
 335      * Information about the back and depthbuffer where different from above.
 336      */
 337     /*@{*/
 338     int backX;
 339     int backY;
 340     int backClipRectType;
 341     int numBackClipRects;
 342     drm_clip_rect_t *pBackClipRects;
 343     /*@}*/
 344
 345     /**
 346      * \name Vertical blank tracking information
 347      * Used for waiting on vertical blank events.
 348      */
 349     /*@{*/
 350     unsigned int vblSeq;
 351     unsigned int vblFlags;
 352     /*@}*/
 353
 354     /**
 355      * \name Monotonic MSC tracking
 356      *
 357      * Low level driver is responsible for updating msc_base and
 358      * vblSeq values so that higher level code can calculate
 359      * a new msc value or msc target for a WaitMSC call.  The new value
 360      * will be:
 361      *   msc = msc_base + get_vblank_count() - vblank_base;
 362      *
 363      * And for waiting on a value, core code will use:
 364      *   actual_target = target_msc - msc_base + vblank_base;
 365      */
 366     /*@{*/
 367     int64_t vblank_base;
 368     int64_t msc_base;
 369     /*@}*/
 370
 371     /**
 372      * Pointer to context to which this drawable is currently bound.
 373      */
 374     __DRIcontext *driContextPriv;
 375
 376     /**
 377      * Pointer to screen on which this drawable was created.
 378      */
 379     __DRIscreen *driScreenPriv;
 380
 381     /**
 382      * Controls swap interval as used by GLX_SGI_swap_control and
 383      * GLX_MESA_swap_control.
 384      */
 385     unsigned int swap_interval;
 386
 387     struct {
 388         unsigned int stamp;
 389         drm_clip_rect_t clipRect;
 390     } dri2;
 391 };
 392
 393 /**
 394  * Per-context private driver information.
 395  */
 396 struct __DRIcontextRec {
 397     /**
 398      * Kernel context handle used to access the device lock.
 399      */
 400     drm_context_t hHWContext;
 401
 402     /**
 403      * Device driver's private context data.  This structure is opaque.
 404      */
 405     void *driverPrivate;
 406
 407     /**
 408      * Pointer to drawable currently bound to this context for drawing.
 409      */
 410     __DRIdrawable *driDrawablePriv;
 411
 412     /**
 413      * Pointer to drawable currently bound to this context for reading.
 414      */
 415     __DRIdrawable *driReadablePriv;
 416
 417     /**
 418      * Pointer to screen on which this context was created.
 419      */
 420     __DRIscreen *driScreenPriv;
 421
 422     /**
 423      * The loaders's private context data.  This structure is opaque.
 424      */
 425     void *loaderPrivate;
 426
 427     struct {
 428         int draw_stamp;
 429         int read_stamp;
 430     } dri2;
 431 };
 432
 433 /**
 434  * Per-screen private driver information.
 435  */
 436 struct __DRIscreenRec {
 437     /**
 438      * Current screen's number
 439      */
 440     int myNum;
 441
 442     /**
 443      * Callback functions into the hardware-specific DRI driver code.
 444      */
 445     struct __DriverAPIRec DriverAPI;
 446
 447     const __DRIextension **extensions;
 448     /**
 449      * DDX / 2D driver version information.
 450      */
 451     __DRIversion ddx_version;
 452
 453     /**
 454      * DRI X extension version information.
 455      */
 456     __DRIversion dri_version;
 457
 458     /**
 459      * DRM (kernel module) version information.
 460      */
 461     __DRIversion drm_version;
 462
 463     /**
 464      * ID used when the client sets the drawable lock.
 465      *
 466      * The X server uses this value to detect if the client has died while
 467      * holding the drawable lock.
 468      */
 469     int drawLockID;
 470
 471     /**
 472      * File descriptor returned when the kernel device driver is opened.
 473      *
 474      * Used to:
 475      *   - authenticate client to kernel
 476      *   - map the frame buffer, SAREA, etc.
 477      *   - close the kernel device driver
 478      */
 479     int fd;
 480
 481     /**
 482      * SAREA pointer
 483      *
 484      * Used to access:
 485      *   - the device lock
 486      *   - the device-independent per-drawable and per-context(?) information
 487      */
 488     drm_sarea_t *pSAREA;
 489
 490     /**
 491      * \name Direct frame buffer access information
 492      * Used for software fallbacks.
 493      */
 494     /*@{*/
 495     unsigned char *pFB;
 496     int fbSize;
 497     int fbOrigin;
 498     int fbStride;
 499     int fbWidth;
 500     int fbHeight;
 501     int fbBPP;
 502     /*@}*/
 503
 504     /**
 505      * \name Device-dependent private information (stored in the SAREA).
 506      *
 507      * This data is accessed by the client driver only.
 508      */
 509     /*@{*/
 510     void *pDevPriv;
 511     int devPrivSize;
 512     /*@}*/
 513
 514     /**
 515      * Device-dependent private information (not stored in the SAREA).
 516      *
 517      * This pointer is never touched by the DRI layer.
 518      */
 519 #ifdef __cplusplus
 520     void *priv;
 521 #else
 522     void *private;
 523 #endif
 524
 525     /* Extensions provided by the loader. */
 526     const __DRIgetDrawableInfoExtension *getDrawableInfo;
 527     const __DRIsystemTimeExtension *systemTime;
 528     const __DRIdamageExtension *damage;
 529
 530     struct {
 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. */
 533         int enabled;
 534         __DRIdri2LoaderExtension *loader;
 535         __DRIimageLookupExtension *image;
 536         __DRIuseInvalidateExtension *useInvalidate;
 537     } dri2;
 538
 539     /* The lock actually in use, old sarea or DRI2 */
 540     drmLock *lock;
 541
 542     driOptionCache optionInfo;
 543     driOptionCache optionCache;
 544    unsigned int api_mask;
 545    void *loaderPrivate;
 546 };
 547
 548 extern void
 549 __driUtilUpdateDrawableInfo(__DRIdrawable *pdp);
 550
 551 extern float
 552 driCalculateSwapUsage( __DRIdrawable *dPriv,
 553                        int64_t last_swap_ust, int64_t current_ust );
 554
 555 extern GLint
 556 driIntersectArea( drm_clip_rect_t rect1, drm_clip_rect_t rect2 );
 557
 558 extern void
 559 dri2InvalidateDrawable(__DRIdrawable *drawable);
 560
 561 #endif /* _DRI_UTIL_H_ */