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 "main/glheader.h"
  55 #include "GL/internal/glcore.h"
  56 #include "GL/internal/dri_interface.h"
  57
  58 #define GLX_BAD_CONTEXT                    5
  59
  60 typedef struct __DRIswapInfoRec        __DRIswapInfo;
  61
  62 /* Typedefs to avoid rewriting the world. */
  63 typedef struct __DRIscreenRec   __DRIscreenPrivate;
  64 typedef struct __DRIdrawableRec __DRIdrawablePrivate;
  65 typedef struct __DRIcontextRec  __DRIcontextPrivate;
  66
  67 /**
  68  * Extensions.
  69  */
  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;
  77
  78 /**
  79  * Used by DRI_VALIDATE_DRAWABLE_INFO
  80  */
  81 #define DRI_VALIDATE_DRAWABLE_INFO_ONCE(pDrawPriv)              \
  82     do {                                                        \
  83         if (*(pDrawPriv->pStamp) != pDrawPriv->lastStamp) {     \
  84             __driUtilUpdateDrawableInfo(pDrawPriv);             \
  85         }                                                       \
  86     } while (0)
  87
  88
  89 /**
  90  * Utility macro to validate the drawable information.
  91  *
  92  * See __DRIdrawable::pStamp and __DRIdrawable::lastStamp.
  93  */
  94 #define DRI_VALIDATE_DRAWABLE_INFO(psp, pdp)                            \
  95 do {                                                                    \
  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);             \
 100                                                                         \
 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);   \
 104                                                                         \
 105         DRM_LIGHT_LOCK(psp->fd, &psp->pSAREA->lock, hwContext);         \
 106     }                                                                   \
 107 } while (0)
 108
 109 /**
 110  * Same as above, but for two drawables simultaneously.
 111  *
 112  */
 113
 114 #define DRI_VALIDATE_TWO_DRAWABLES_INFO(psp, pdp, prp)                  \
 115 do {                                                            \
 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);         \
 121                                                                         \
 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); \
 126                                                                         \
 127         DRM_LIGHT_LOCK((psp)->fd, &(psp)->pSAREA->lock, hwContext);     \
 128     }                                                                   \
 129 } while (0)
 130
 131
 132 /**
 133  * Driver callback functions.
 134  *
 135  * Each DRI driver must have one of these structures with all the pointers set
 136  * to appropriate functions within the driver.
 137  *
 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
 140  * this structure.
 141  */
 142 struct __DriverAPIRec {
 143     const __DRIconfig **(*InitScreen) (__DRIscreen * priv);
 144
 145     /**
 146      * Screen destruction callback
 147      */
 148     void (*DestroyScreen)(__DRIscreen *driScrnPriv);
 149
 150     /**
 151      * Context creation callback
 152      */
 153     GLboolean (*CreateContext)(const __GLcontextModes *glVis,
 154                                __DRIcontext *driContextPriv,
 155                                void *sharedContextPrivate);
 156
 157     /**
 158      * Context destruction callback
 159      */
 160     void (*DestroyContext)(__DRIcontext *driContextPriv);
 161
 162     /**
 163      * Buffer (drawable) creation callback
 164      */
 165     GLboolean (*CreateBuffer)(__DRIscreen *driScrnPriv,
 166                               __DRIdrawable *driDrawPriv,
 167                               const __GLcontextModes *glVis,
 168                               GLboolean pixmapBuffer);
 169
 170     /**
 171      * Buffer (drawable) destruction callback
 172      */
 173     void (*DestroyBuffer)(__DRIdrawable *driDrawPriv);
 174
 175     /**
 176      * Buffer swapping callback
 177      */
 178     void (*SwapBuffers)(__DRIdrawable *driDrawPriv);
 179
 180     /**
 181      * Context activation callback
 182      */
 183     GLboolean (*MakeCurrent)(__DRIcontext *driContextPriv,
 184                              __DRIdrawable *driDrawPriv,
 185                              __DRIdrawable *driReadPriv);
 186
 187     /**
 188      * Context unbinding callback
 189      */
 190     GLboolean (*UnbindContext)(__DRIcontext *driContextPriv);
 191
 192     /**
 193      * Retrieves statistics about buffer swap operations.  Required if
 194      * GLX_OML_sync_control or GLX_MESA_swap_frame_usage is supported.
 195      */
 196     int (*GetSwapInfo)( __DRIdrawable *dPriv, __DRIswapInfo * sInfo );
 197
 198
 199     /**
 200      * These are required if GLX_OML_sync_control is supported.
 201      */
 202     /*@{*/
 203     int (*WaitForMSC)( __DRIdrawable *priv, int64_t target_msc,
 204                        int64_t divisor, int64_t remainder,
 205                        int64_t * msc );
 206     int (*WaitForSBC)( __DRIdrawable *priv, int64_t target_sbc,
 207                        int64_t * msc, int64_t * sbc );
 208
 209     int64_t (*SwapBuffersMSC)( __DRIdrawable *priv, int64_t target_msc,
 210                                int64_t divisor, int64_t remainder );
 211     /*@}*/
 212     void (*CopySubBuffer)(__DRIdrawable *driDrawPriv,
 213                           int x, int y, int w, int h);
 214
 215     /**
 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.
 219      */
 220     int (*GetDrawableMSC) ( __DRIscreen * priv,
 221                             __DRIdrawable *drawablePrivate,
 222                             int64_t *count);
 223
 224
 225
 226     /* DRI2 Entry point */
 227     const __DRIconfig **(*InitScreen2) (__DRIscreen * priv);
 228 };
 229
 230 extern const struct __DriverAPIRec driDriverAPI;
 231
 232
 233 struct __DRIswapInfoRec {
 234     /**
 235      * Number of swapBuffers operations that have been *completed*.
 236      */
 237     uint64_t swap_count;
 238
 239     /**
 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.
 242      */
 243     int64_t   swap_ust;
 244
 245     /**
 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.
 250      */
 251     uint64_t swap_missed_count;
 252
 253     /**
 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.
 259      */
 260     float     swap_missed_usage;
 261 };
 262
 263
 264 /**
 265  * Per-drawable private DRI driver information.
 266  */
 267 struct __DRIdrawableRec {
 268     /**
 269      * Kernel drawable handle
 270      */
 271     drm_drawable_t hHWDrawable;
 272
 273     /**
 274      * Driver's private drawable information.
 275      *
 276      * This structure is opaque.
 277      */
 278     void *driverPrivate;
 279
 280     /**
 281      * Private data from the loader.  We just hold on to it and pass
 282      * it back when calling into loader provided functions.
 283      */
 284     void *loaderPrivate;
 285
 286     /**
 287      * Reference count for number of context's currently bound to this
 288      * drawable.
 289      *
 290      * Once it reaches zero, the drawable can be destroyed.
 291      *
 292      * \note This behavior will change with GLX 1.3.
 293      */
 294     int refcount;
 295
 296     /**
 297      * Index of this drawable information in the SAREA.
 298      */
 299     unsigned int index;
 300
 301     /**
 302      * Pointer to the "drawable has changed ID" stamp in the SAREA.
 303      */
 304     unsigned int *pStamp;
 305
 306     /**
 307      * Last value of the stamp.
 308      *
 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.
 312      */
 313     unsigned int lastStamp;
 314
 315     /**
 316      * \name Drawable
 317      *
 318      * Drawable information used in software fallbacks.
 319      */
 320     /*@{*/
 321     int x;
 322     int y;
 323     int w;
 324     int h;
 325     int numClipRects;
 326     drm_clip_rect_t *pClipRects;
 327     /*@}*/
 328
 329     /**
 330      * \name Back and depthbuffer
 331      *
 332      * Information about the back and depthbuffer where different from above.
 333      */
 334     /*@{*/
 335     int backX;
 336     int backY;
 337     int backClipRectType;
 338     int numBackClipRects;
 339     drm_clip_rect_t *pBackClipRects;
 340     /*@}*/
 341
 342     /**
 343      * \name Vertical blank tracking information
 344      * Used for waiting on vertical blank events.
 345      */
 346     /*@{*/
 347     unsigned int vblSeq;
 348     unsigned int vblFlags;
 349     /*@}*/
 350
 351     /**
 352      * \name Monotonic MSC tracking
 353      *
 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
 357      * will be:
 358      *   msc = msc_base + get_vblank_count() - vblank_base;
 359      *
 360      * And for waiting on a value, core code will use:
 361      *   actual_target = target_msc - msc_base + vblank_base;
 362      */
 363     /*@{*/
 364     int64_t vblank_base;
 365     int64_t msc_base;
 366     /*@}*/
 367
 368     /**
 369      * Pointer to context to which this drawable is currently bound.
 370      */
 371     __DRIcontext *driContextPriv;
 372
 373     /**
 374      * Pointer to screen on which this drawable was created.
 375      */
 376     __DRIscreen *driScreenPriv;
 377
 378     /**
 379      * Controls swap interval as used by GLX_SGI_swap_control and
 380      * GLX_MESA_swap_control.
 381      */
 382     unsigned int swap_interval;
 383 };
 384
 385 /**
 386  * Per-context private driver information.
 387  */
 388 struct __DRIcontextRec {
 389     /**
 390      * Kernel context handle used to access the device lock.
 391      */
 392     drm_context_t hHWContext;
 393
 394     /**
 395      * Device driver's private context data.  This structure is opaque.
 396      */
 397     void *driverPrivate;
 398
 399     /**
 400      * Pointer back to the \c __DRIcontext that contains this structure.
 401      */
 402     __DRIcontext *pctx;
 403
 404     /**
 405      * Pointer to drawable currently bound to this context for drawing.
 406      */
 407     __DRIdrawable *driDrawablePriv;
 408
 409     /**
 410      * Pointer to drawable currently bound to this context for reading.
 411      */
 412     __DRIdrawable *driReadablePriv;
 413
 414     /**
 415      * Pointer to screen on which this context was created.
 416      */
 417     __DRIscreen *driScreenPriv;
 418 };
 419
 420 /**
 421  * Per-screen private driver information.
 422  */
 423 struct __DRIscreenRec {
 424     /**
 425      * Current screen's number
 426      */
 427     int myNum;
 428
 429     /**
 430      * Callback functions into the hardware-specific DRI driver code.
 431      */
 432     struct __DriverAPIRec DriverAPI;
 433
 434     const __DRIextension **extensions;
 435     /**
 436      * DDX / 2D driver version information.
 437      */
 438     __DRIversion ddx_version;
 439
 440     /**
 441      * DRI X extension version information.
 442      */
 443     __DRIversion dri_version;
 444
 445     /**
 446      * DRM (kernel module) version information.
 447      */
 448     __DRIversion drm_version;
 449
 450     /**
 451      * ID used when the client sets the drawable lock.
 452      *
 453      * The X server uses this value to detect if the client has died while
 454      * holding the drawable lock.
 455      */
 456     int drawLockID;
 457
 458     /**
 459      * File descriptor returned when the kernel device driver is opened.
 460      *
 461      * Used to:
 462      *   - authenticate client to kernel
 463      *   - map the frame buffer, SAREA, etc.
 464      *   - close the kernel device driver
 465      */
 466     int fd;
 467
 468     /**
 469      * SAREA pointer
 470      *
 471      * Used to access:
 472      *   - the device lock
 473      *   - the device-independent per-drawable and per-context(?) information
 474      */
 475     drm_sarea_t *pSAREA;
 476
 477     /**
 478      * \name Direct frame buffer access information
 479      * Used for software fallbacks.
 480      */
 481     /*@{*/
 482     unsigned char *pFB;
 483     int fbSize;
 484     int fbOrigin;
 485     int fbStride;
 486     int fbWidth;
 487     int fbHeight;
 488     int fbBPP;
 489     /*@}*/
 490
 491     /**
 492      * \name Device-dependent private information (stored in the SAREA).
 493      *
 494      * This data is accessed by the client driver only.
 495      */
 496     /*@{*/
 497     void *pDevPriv;
 498     int devPrivSize;
 499     /*@}*/
 500
 501     /**
 502      * Dummy context to which drawables are bound when not bound to any
 503      * other context.
 504      *
 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
 509      * screen.
 510      */
 511     __DRIcontext dummyContextPriv;
 512
 513     /**
 514      * Device-dependent private information (not stored in the SAREA).
 515      *
 516      * This pointer is never touched by the DRI layer.
 517      */
 518     void *private;
 519
 520     /**
 521      * Pointer back to the \c __DRIscreen that contains this structure.
 522      */
 523     __DRIscreen *psc;
 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     } dri2;
 536
 537     /* The lock actually in use, old sarea or DRI2 */
 538     drmLock *lock;
 539 };
 540
 541 extern void
 542 __driUtilMessage(const char *f, ...);
 543
 544
 545 extern void
 546 __driUtilUpdateDrawableInfo(__DRIdrawable *pdp);
 547
 548 extern float
 549 driCalculateSwapUsage( __DRIdrawable *dPriv,
 550                        int64_t last_swap_ust, int64_t current_ust );
 551
 552 extern GLint
 553 driIntersectArea( drm_clip_rect_t rect1, drm_clip_rect_t rect2 );
 554
 555 #endif /* _DRI_UTIL_H_ */