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

   1 /**
   2  * \file dri_util.c
   3  * DRI utility functions.
   4  *
   5  * This module acts as glue between GLX and the actual hardware driver.  A DRI
   6  * driver doesn't really \e have to use any of this - it's optional.  But, some
   7  * useful stuff is done here that otherwise would have to be duplicated in most
   8  * drivers.
   9  *
  10  * Basically, these utility functions take care of some of the dirty details of
  11  * screen initialization, context creation, context binding, DRM setup, etc.
  12  *
  13  * These functions are compiled into each DRI driver so libGL.so knows nothing
  14  * about them.
  15  */
  16
  17
  18 #include <assert.h>
  19 #include <stdarg.h>
  20 #include <unistd.h>
  21 #include <sys/mman.h>
  22 #include <stdio.h>
  23
  24 #ifndef MAP_FAILED
  25 #define MAP_FAILED ((void *)-1)
  26 #endif
  27
  28 #include "main/imports.h"
  29 #define None 0
  30
  31 #include "dri_util.h"
  32 #include "drm_sarea.h"
  33 #include "utils.h"
  34 #include "xmlpool.h"
  35
  36 PUBLIC const char __dri2ConfigOptions[] =
  37    DRI_CONF_BEGIN
  38       DRI_CONF_SECTION_PERFORMANCE
  39          DRI_CONF_VBLANK_MODE(DRI_CONF_VBLANK_DEF_INTERVAL_1)
  40       DRI_CONF_SECTION_END
  41    DRI_CONF_END;
  42
  43 static const uint __dri2NConfigOptions = 1;
  44
  45 #ifndef GLX_OML_sync_control
  46 typedef GLboolean ( * PFNGLXGETMSCRATEOMLPROC) (__DRIdrawable *drawable, int32_t *numerator, int32_t *denominator);
  47 #endif
  48
  49 static void dri_get_drawable(__DRIdrawable *pdp);
  50 static void dri_put_drawable(__DRIdrawable *pdp);
  51
  52 /**
  53  * This is just a token extension used to signal that the driver
  54  * supports setting a read drawable.
  55  */
  56 const __DRIextension driReadDrawableExtension = {
  57     __DRI_READ_DRAWABLE, __DRI_READ_DRAWABLE_VERSION
  58 };
  59
  60 GLint
  61 driIntersectArea( drm_clip_rect_t rect1, drm_clip_rect_t rect2 )
  62 {
  63    if (rect2.x1 > rect1.x1) rect1.x1 = rect2.x1;
  64    if (rect2.x2 < rect1.x2) rect1.x2 = rect2.x2;
  65    if (rect2.y1 > rect1.y1) rect1.y1 = rect2.y1;
  66    if (rect2.y2 < rect1.y2) rect1.y2 = rect2.y2;
  67
  68    if (rect1.x1 > rect1.x2 || rect1.y1 > rect1.y2) return 0;
  69
  70    return (rect1.x2 - rect1.x1) * (rect1.y2 - rect1.y1);
  71 }
  72
  73 /*****************************************************************/
  74 /** \name Context (un)binding functions                          */
  75 /*****************************************************************/
  76 /*@{*/
  77
  78 /**
  79  * Unbind context.
  80  *
  81  * \param scrn the screen.
  82  * \param gc context.
  83  *
  84  * \return \c GL_TRUE on success, or \c GL_FALSE on failure.
  85  *
  86  * \internal
  87  * This function calls __DriverAPIRec::UnbindContext, and then decrements
  88  * __DRIdrawableRec::refcount which must be non-zero for a successful
  89  * return.
  90  *
  91  * While casting the opaque private pointers associated with the parameters
  92  * into their respective real types it also assures they are not \c NULL.
  93  */
  94 static int driUnbindContext(__DRIcontext *pcp)
  95 {
  96     __DRIscreen *psp;
  97     __DRIdrawable *pdp;
  98     __DRIdrawable *prp;
  99
 100     /*
 101     ** Assume error checking is done properly in glXMakeCurrent before
 102     ** calling driUnbindContext.
 103     */
 104
 105     if (pcp == NULL)
 106         return GL_FALSE;
 107
 108     psp = pcp->driScreenPriv;
 109     pdp = pcp->driDrawablePriv;
 110     prp = pcp->driReadablePriv;
 111
 112     /* already unbound */
 113     if (!pdp && !prp)
 114       return GL_TRUE;
 115     /* Let driver unbind drawable from context */
 116     (*psp->DriverAPI.UnbindContext)(pcp);
 117
 118     assert(pdp);
 119     if (pdp->refcount == 0) {
 120         /* ERROR!!! */
 121         return GL_FALSE;
 122     }
 123
 124     dri_put_drawable(pdp);
 125
 126     if (prp != pdp) {
 127         if (prp->refcount == 0) {
 128             /* ERROR!!! */
 129             return GL_FALSE;
 130         }
 131
 132         dri_put_drawable(prp);
 133     }
 134
 135
 136     /* XXX this is disabled so that if we call SwapBuffers on an unbound
 137      * window we can determine the last context bound to the window and
 138      * use that context's lock. (BrianP, 2-Dec-2000)
 139      */
 140     pcp->driDrawablePriv = pcp->driReadablePriv = NULL;
 141
 142     return GL_TRUE;
 143 }
 144
 145 /**
 146  * This function takes both a read buffer and a draw buffer.  This is needed
 147  * for \c glXMakeCurrentReadSGI or GLX 1.3's \c glXMakeContextCurrent
 148  * function.
 149  */
 150 static int driBindContext(__DRIcontext *pcp,
 151                           __DRIdrawable *pdp,
 152                           __DRIdrawable *prp)
 153 {
 154     __DRIscreen *psp = NULL;
 155
 156     /*
 157     ** Assume error checking is done properly in glXMakeCurrent before
 158     ** calling driUnbindContext.
 159     */
 160
 161     if (!pcp)
 162         return GL_FALSE;
 163
 164     /* Bind the drawable to the context */
 165     psp = pcp->driScreenPriv;
 166     pcp->driDrawablePriv = pdp;
 167     pcp->driReadablePriv = prp;
 168     if (pdp) {
 169         pdp->driContextPriv = pcp;
 170         dri_get_drawable(pdp);
 171     }
 172     if (prp && pdp != prp) {
 173         dri_get_drawable(prp);
 174     }
 175
 176     /*
 177     ** Now that we have a context associated with this drawable, we can
 178     ** initialize the drawable information if has not been done before.
 179     */
 180
 181     if (!psp->dri2.enabled) {
 182         if (pdp && !pdp->pStamp) {
 183             DRM_SPINLOCK(&psp->pSAREA->drawable_lock, psp->drawLockID);
 184             __driUtilUpdateDrawableInfo(pdp);
 185             DRM_SPINUNLOCK(&psp->pSAREA->drawable_lock, psp->drawLockID);
 186         }
 187         if (prp && pdp != prp && !prp->pStamp) {
 188             DRM_SPINLOCK(&psp->pSAREA->drawable_lock, psp->drawLockID);
 189             __driUtilUpdateDrawableInfo(prp);
 190             DRM_SPINUNLOCK(&psp->pSAREA->drawable_lock, psp->drawLockID);
 191         }
 192     }
 193
 194     /* Call device-specific MakeCurrent */
 195     return (*psp->DriverAPI.MakeCurrent)(pcp, pdp, prp);
 196 }
 197
 198 /*@}*/
 199
 200
 201 /*****************************************************************/
 202 /** \name Drawable handling functions                            */
 203 /*****************************************************************/
 204 /*@{*/
 205
 206 /**
 207  * Update private drawable information.
 208  *
 209  * \param pdp pointer to the private drawable information to update.
 210  *
 211  * This function basically updates the __DRIdrawable struct's
 212  * cliprect information by calling \c __DRIinterfaceMethods::getDrawableInfo.
 213  * This is usually called by the DRI_VALIDATE_DRAWABLE_INFO macro which
 214  * compares the __DRIdrwablePrivate pStamp and lastStamp values.  If
 215  * the values are different that means we have to update the clipping
 216  * info.
 217  */
 218 void
 219 __driUtilUpdateDrawableInfo(__DRIdrawable *pdp)
 220 {
 221     __DRIscreen *psp = pdp->driScreenPriv;
 222     __DRIcontext *pcp = pdp->driContextPriv;
 223
 224     if (!pcp
 225         || ((pdp != pcp->driDrawablePriv) && (pdp != pcp->driReadablePriv))) {
 226         /* ERROR!!!
 227          * ...but we must ignore it. There can be many contexts bound to a
 228          * drawable.
 229          */
 230     }
 231
 232     if (pdp->pClipRects) {
 233         free(pdp->pClipRects);
 234         pdp->pClipRects = NULL;
 235     }
 236
 237     if (pdp->pBackClipRects) {
 238         free(pdp->pBackClipRects);
 239         pdp->pBackClipRects = NULL;
 240     }
 241
 242     DRM_SPINUNLOCK(&psp->pSAREA->drawable_lock, psp->drawLockID);
 243
 244     if (! (*psp->getDrawableInfo->getDrawableInfo)(pdp,
 245                           &pdp->index, &pdp->lastStamp,
 246                           &pdp->x, &pdp->y, &pdp->w, &pdp->h,
 247                           &pdp->numClipRects, &pdp->pClipRects,
 248                           &pdp->backX,
 249                           &pdp->backY,
 250                           &pdp->numBackClipRects,
 251                           &pdp->pBackClipRects,
 252                           pdp->loaderPrivate)) {
 253         /* Error -- eg the window may have been destroyed.  Keep going
 254          * with no cliprects.
 255          */
 256         pdp->pStamp = &pdp->lastStamp; /* prevent endless loop */
 257         pdp->numClipRects = 0;
 258         pdp->pClipRects = NULL;
 259         pdp->numBackClipRects = 0;
 260         pdp->pBackClipRects = NULL;
 261     }
 262     else
 263        pdp->pStamp = &(psp->pSAREA->drawableTable[pdp->index].stamp);
 264
 265     DRM_SPINLOCK(&psp->pSAREA->drawable_lock, psp->drawLockID);
 266 }
 267
 268 /*@}*/
 269
 270 /*****************************************************************/
 271 /** \name GLX callbacks                                          */
 272 /*****************************************************************/
 273 /*@{*/
 274
 275 static void driReportDamage(__DRIdrawable *pdp,
 276                             struct drm_clip_rect *pClipRects, int numClipRects)
 277 {
 278     __DRIscreen *psp = pdp->driScreenPriv;
 279
 280     /* Check that we actually have the new damage report method */
 281     if (psp->damage) {
 282         /* Report the damage.  Currently, all our drivers draw
 283          * directly to the front buffer, so we report the damage there
 284          * rather than to the backing storein (if any).
 285          */
 286         (*psp->damage->reportDamage)(pdp,
 287                                      pdp->x, pdp->y,
 288                                      pClipRects, numClipRects,
 289                                      GL_TRUE, pdp->loaderPrivate);
 290     }
 291 }
 292
 293
 294 /**
 295  * Swap buffers.
 296  *
 297  * \param drawablePrivate opaque pointer to the per-drawable private info.
 298  *
 299  * \internal
 300  * This function calls __DRIdrawable::swapBuffers.
 301  *
 302  * Is called directly from glXSwapBuffers().
 303  */
 304 static void driSwapBuffers(__DRIdrawable *dPriv)
 305 {
 306     __DRIscreen *psp = dPriv->driScreenPriv;
 307     drm_clip_rect_t *rects;
 308     int i;
 309
 310     psp->DriverAPI.SwapBuffers(dPriv);
 311
 312     if (!dPriv->numClipRects)
 313         return;
 314
 315     rects = malloc(sizeof(*rects) * dPriv->numClipRects);
 316
 317     if (!rects)
 318         return;
 319
 320     for (i = 0; i < dPriv->numClipRects; i++) {
 321         rects[i].x1 = dPriv->pClipRects[i].x1 - dPriv->x;
 322         rects[i].y1 = dPriv->pClipRects[i].y1 - dPriv->y;
 323         rects[i].x2 = dPriv->pClipRects[i].x2 - dPriv->x;
 324         rects[i].y2 = dPriv->pClipRects[i].y2 - dPriv->y;
 325     }
 326
 327     driReportDamage(dPriv, rects, dPriv->numClipRects);
 328     free(rects);
 329 }
 330
 331 static int driDrawableGetMSC( __DRIscreen *sPriv, __DRIdrawable *dPriv,
 332                               int64_t *msc )
 333 {
 334     return sPriv->DriverAPI.GetDrawableMSC(sPriv, dPriv, msc);
 335 }
 336
 337
 338 static int driWaitForMSC(__DRIdrawable *dPriv, int64_t target_msc,
 339                          int64_t divisor, int64_t remainder,
 340                          int64_t * msc, int64_t * sbc)
 341 {
 342     __DRIswapInfo  sInfo;
 343     int  status;
 344
 345     status = dPriv->driScreenPriv->DriverAPI.WaitForMSC( dPriv, target_msc,
 346                                                          divisor, remainder,
 347                                                          msc );
 348
 349     /* GetSwapInfo() may not be provided by the driver if GLX_SGI_video_sync
 350      * is supported but GLX_OML_sync_control is not.  Therefore, don't return
 351      * an error value if GetSwapInfo() is not implemented.
 352     */
 353     if ( status == 0
 354          && dPriv->driScreenPriv->DriverAPI.GetSwapInfo ) {
 355         status = dPriv->driScreenPriv->DriverAPI.GetSwapInfo( dPriv, & sInfo );
 356         *sbc = sInfo.swap_count;
 357     }
 358
 359     return status;
 360 }
 361
 362
 363 const __DRImediaStreamCounterExtension driMediaStreamCounterExtension = {
 364     { __DRI_MEDIA_STREAM_COUNTER, __DRI_MEDIA_STREAM_COUNTER_VERSION },
 365     driWaitForMSC,
 366     driDrawableGetMSC,
 367 };
 368
 369
 370 static void driCopySubBuffer(__DRIdrawable *dPriv,
 371                               int x, int y, int w, int h)
 372 {
 373     drm_clip_rect_t rect;
 374
 375     rect.x1 = x;
 376     rect.y1 = dPriv->h - y - h;
 377     rect.x2 = x + w;
 378     rect.y2 = rect.y1 + h;
 379     driReportDamage(dPriv, &rect, 1);
 380
 381     dPriv->driScreenPriv->DriverAPI.CopySubBuffer(dPriv, x, y, w, h);
 382 }
 383
 384 const __DRIcopySubBufferExtension driCopySubBufferExtension = {
 385     { __DRI_COPY_SUB_BUFFER, __DRI_COPY_SUB_BUFFER_VERSION },
 386     driCopySubBuffer
 387 };
 388
 389 static void driSetSwapInterval(__DRIdrawable *dPriv, unsigned int interval)
 390 {
 391     dPriv->swap_interval = interval;
 392 }
 393
 394 static unsigned int driGetSwapInterval(__DRIdrawable *dPriv)
 395 {
 396     return dPriv->swap_interval;
 397 }
 398
 399 const __DRIswapControlExtension driSwapControlExtension = {
 400     { __DRI_SWAP_CONTROL, __DRI_SWAP_CONTROL_VERSION },
 401     driSetSwapInterval,
 402     driGetSwapInterval
 403 };
 404
 405
 406 /**
 407  * This is called via __DRIscreenRec's createNewDrawable pointer.
 408  */
 409 static __DRIdrawable *
 410 driCreateNewDrawable(__DRIscreen *psp, const __DRIconfig *config,
 411                      drm_drawable_t hwDrawable, int renderType,
 412                      const int *attrs, void *data)
 413 {
 414     __DRIdrawable *pdp;
 415
 416     /* Since pbuffers are not yet supported, no drawable attributes are
 417      * supported either.
 418      */
 419     (void) attrs;
 420
 421     pdp = malloc(sizeof *pdp);
 422     if (!pdp) {
 423         return NULL;
 424     }
 425
 426     pdp->driContextPriv = NULL;
 427     pdp->loaderPrivate = data;
 428     pdp->hHWDrawable = hwDrawable;
 429     pdp->refcount = 1;
 430     pdp->pStamp = NULL;
 431     pdp->lastStamp = 0;
 432     pdp->index = 0;
 433     pdp->x = 0;
 434     pdp->y = 0;
 435     pdp->w = 0;
 436     pdp->h = 0;
 437     pdp->numClipRects = 0;
 438     pdp->numBackClipRects = 0;
 439     pdp->pClipRects = NULL;
 440     pdp->pBackClipRects = NULL;
 441     pdp->vblSeq = 0;
 442     pdp->vblFlags = 0;
 443
 444     pdp->driScreenPriv = psp;
 445
 446     if (!(*psp->DriverAPI.CreateBuffer)(psp, pdp, &config->modes,
 447                                         renderType == GLX_PIXMAP_BIT)) {
 448        free(pdp);
 449        return NULL;
 450     }
 451
 452     pdp->msc_base = 0;
 453
 454     /* This special default value is replaced with the configured
 455      * default value when the drawable is first bound to a direct
 456      * rendering context.
 457      */
 458     pdp->swap_interval = (unsigned)-1;
 459
 460     return pdp;
 461 }
 462
 463
 464 static __DRIdrawable *
 465 dri2CreateNewDrawable(__DRIscreen *screen,
 466                       const __DRIconfig *config,
 467                       void *loaderPrivate)
 468 {
 469     __DRIdrawable *pdraw;
 470
 471     pdraw = driCreateNewDrawable(screen, config, 0, 0, NULL, loaderPrivate);
 472     if (!pdraw)
 473         return NULL;
 474
 475     pdraw->pClipRects = &pdraw->dri2.clipRect;
 476     pdraw->pBackClipRects = &pdraw->dri2.clipRect;
 477
 478     pdraw->pStamp = &pdraw->dri2.stamp;
 479     *pdraw->pStamp = pdraw->lastStamp + 1;
 480
 481     return pdraw;
 482 }
 483
 484 static int
 485 dri2ConfigQueryb(__DRIscreen *screen, const char *var, GLboolean *val)
 486 {
 487    if (!driCheckOption(&screen->optionCache, var, DRI_BOOL))
 488       return -1;
 489
 490    *val = driQueryOptionb(&screen->optionCache, var);
 491
 492    return 0;
 493 }
 494
 495 static int
 496 dri2ConfigQueryi(__DRIscreen *screen, const char *var, GLint *val)
 497 {
 498    if (!driCheckOption(&screen->optionCache, var, DRI_INT) &&
 499        !driCheckOption(&screen->optionCache, var, DRI_ENUM))
 500       return -1;
 501
 502     *val = driQueryOptioni(&screen->optionCache, var);
 503
 504     return 0;
 505 }
 506
 507 static int
 508 dri2ConfigQueryf(__DRIscreen *screen, const char *var, GLfloat *val)
 509 {
 510    if (!driCheckOption(&screen->optionCache, var, DRI_FLOAT))
 511       return -1;
 512
 513     *val = driQueryOptionf(&screen->optionCache, var);
 514
 515     return 0;
 516 }
 517
 518
 519 static void dri_get_drawable(__DRIdrawable *pdp)
 520 {
 521     pdp->refcount++;
 522 }
 523
 524 static void dri_put_drawable(__DRIdrawable *pdp)
 525 {
 526     __DRIscreen *psp;
 527
 528     if (pdp) {
 529         pdp->refcount--;
 530         if (pdp->refcount)
 531             return;
 532
 533         psp = pdp->driScreenPriv;
 534         (*psp->DriverAPI.DestroyBuffer)(pdp);
 535         if (pdp->pClipRects && pdp->pClipRects != &pdp->dri2.clipRect) {
 536             free(pdp->pClipRects);
 537             pdp->pClipRects = NULL;
 538         }
 539         if (pdp->pBackClipRects && pdp->pClipRects != &pdp->dri2.clipRect) {
 540             free(pdp->pBackClipRects);
 541             pdp->pBackClipRects = NULL;
 542         }
 543         free(pdp);
 544     }
 545 }
 546
 547 static void
 548 driDestroyDrawable(__DRIdrawable *pdp)
 549 {
 550     dri_put_drawable(pdp);
 551 }
 552
 553 /*@}*/
 554
 555
 556 /*****************************************************************/
 557 /** \name Context handling functions                             */
 558 /*****************************************************************/
 559 /*@{*/
 560
 561 /**
 562  * Destroy the per-context private information.
 563  *
 564  * \internal
 565  * This function calls __DriverAPIRec::DestroyContext on \p contextPrivate, calls
 566  * drmDestroyContext(), and finally frees \p contextPrivate.
 567  */
 568 static void
 569 driDestroyContext(__DRIcontext *pcp)
 570 {
 571     if (pcp) {
 572         (*pcp->driScreenPriv->DriverAPI.DestroyContext)(pcp);
 573         free(pcp);
 574     }
 575 }
 576
 577
 578 /**
 579  * Create the per-drawable private driver information.
 580  *
 581  * \param render_type   Type of rendering target.  \c GLX_RGBA is the only
 582  *                      type likely to ever be supported for direct-rendering.
 583  * \param shared        Context with which to share textures, etc. or NULL
 584  *
 585  * \returns An opaque pointer to the per-context private information on
 586  *          success, or \c NULL on failure.
 587  *
 588  * \internal
 589  * This function allocates and fills a __DRIcontextRec structure.  It
 590  * performs some device independent initialization and passes all the
 591  * relevent information to __DriverAPIRec::CreateContext to create the
 592  * context.
 593  *
 594  */
 595 static __DRIcontext *
 596 driCreateNewContext(__DRIscreen *psp, const __DRIconfig *config,
 597                     int render_type, __DRIcontext *shared,
 598                     drm_context_t hwContext, void *data)
 599 {
 600     __DRIcontext *pcp;
 601     void * const shareCtx = (shared != NULL) ? shared->driverPrivate : NULL;
 602
 603     pcp = malloc(sizeof *pcp);
 604     if (!pcp)
 605         return NULL;
 606
 607     pcp->driScreenPriv = psp;
 608     pcp->driDrawablePriv = NULL;
 609     pcp->loaderPrivate = data;
 610
 611     pcp->dri2.draw_stamp = 0;
 612     pcp->dri2.read_stamp = 0;
 613
 614     pcp->hHWContext = hwContext;
 615
 616     if ( !(*psp->DriverAPI.CreateContext)(API_OPENGL,
 617                                           &config->modes, pcp, shareCtx) ) {
 618         free(pcp);
 619         return NULL;
 620     }
 621
 622     return pcp;
 623 }
 624
 625 static unsigned int
 626 dri2GetAPIMask(__DRIscreen *screen)
 627 {
 628     return screen->api_mask;
 629 }
 630
 631 static __DRIcontext *
 632 dri2CreateNewContextForAPI(__DRIscreen *screen, int api,
 633                            const __DRIconfig *config,
 634                            __DRIcontext *shared, void *data)
 635 {
 636     __DRIcontext *context;
 637     void *shareCtx = (shared != NULL) ? shared->driverPrivate : NULL;
 638     gl_api mesa_api;
 639
 640     if (!(screen->api_mask & (1 << api)))
 641         return NULL;
 642
 643     switch (api) {
 644     case __DRI_API_OPENGL:
 645             mesa_api = API_OPENGL;
 646             break;
 647     case __DRI_API_GLES:
 648             mesa_api = API_OPENGLES;
 649             break;
 650     case __DRI_API_GLES2:
 651             mesa_api = API_OPENGLES2;
 652             break;
 653     }
 654
 655     context = malloc(sizeof *context);
 656     if (!context)
 657         return NULL;
 658
 659     context->driScreenPriv = screen;
 660     context->driDrawablePriv = NULL;
 661     context->loaderPrivate = data;
 662
 663     if (!(*screen->DriverAPI.CreateContext)(api, &config->modes,
 664                                             context, shareCtx) ) {
 665         free(context);
 666         return NULL;
 667     }
 668
 669     return context;
 670 }
 671
 672
 673 static __DRIcontext *
 674 dri2CreateNewContext(__DRIscreen *screen, const __DRIconfig *config,
 675                       __DRIcontext *shared, void *data)
 676 {
 677    return dri2CreateNewContextForAPI(screen, __DRI_API_OPENGL,
 678                                      config, shared, data);
 679 }
 680
 681 static int
 682 driCopyContext(__DRIcontext *dest, __DRIcontext *src, unsigned long mask)
 683 {
 684     return GL_FALSE;
 685 }
 686
 687 /*@}*/
 688
 689
 690 /*****************************************************************/
 691 /** \name Screen handling functions                              */
 692 /*****************************************************************/
 693 /*@{*/
 694
 695 /**
 696  * Destroy the per-screen private information.
 697  *
 698  * \internal
 699  * This function calls __DriverAPIRec::DestroyScreen on \p screenPrivate, calls
 700  * drmClose(), and finally frees \p screenPrivate.
 701  */
 702 static void driDestroyScreen(__DRIscreen *psp)
 703 {
 704     if (psp) {
 705         /* No interaction with the X-server is possible at this point.  This
 706          * routine is called after XCloseDisplay, so there is no protocol
 707          * stream open to the X-server anymore.
 708          */
 709
 710         if (psp->DriverAPI.DestroyScreen)
 711             (*psp->DriverAPI.DestroyScreen)(psp);
 712
 713         if (!psp->dri2.enabled) {
 714            (void)drmUnmap((drmAddress)psp->pSAREA, SAREA_MAX);
 715            (void)drmUnmap((drmAddress)psp->pFB, psp->fbSize);
 716            (void)drmCloseOnce(psp->fd);
 717         }
 718
 719         free(psp);
 720     }
 721 }
 722
 723 static void
 724 setupLoaderExtensions(__DRIscreen *psp,
 725                       const __DRIextension **extensions)
 726 {
 727     int i;
 728
 729     for (i = 0; extensions[i]; i++) {
 730         if (strcmp(extensions[i]->name, __DRI_GET_DRAWABLE_INFO) == 0)
 731             psp->getDrawableInfo = (__DRIgetDrawableInfoExtension *) extensions[i];
 732         if (strcmp(extensions[i]->name, __DRI_DAMAGE) == 0)
 733             psp->damage = (__DRIdamageExtension *) extensions[i];
 734         if (strcmp(extensions[i]->name, __DRI_SYSTEM_TIME) == 0)
 735             psp->systemTime = (__DRIsystemTimeExtension *) extensions[i];
 736         if (strcmp(extensions[i]->name, __DRI_DRI2_LOADER) == 0)
 737             psp->dri2.loader = (__DRIdri2LoaderExtension *) extensions[i];
 738         if (strcmp(extensions[i]->name, __DRI_IMAGE_LOOKUP) == 0)
 739             psp->dri2.image = (__DRIimageLookupExtension *) extensions[i];
 740         if (strcmp(extensions[i]->name, __DRI_USE_INVALIDATE) == 0)
 741             psp->dri2.useInvalidate = (__DRIuseInvalidateExtension *) extensions[i];
 742     }
 743 }
 744
 745 /**
 746  * This is the bootstrap function for the driver.  libGL supplies all of the
 747  * requisite information about the system, and the driver initializes itself.
 748  * This routine also fills in the linked list pointed to by \c driver_modes
 749  * with the \c __GLcontextModes that the driver can support for windows or
 750  * pbuffers.
 751  *
 752  * For legacy DRI.
 753  *
 754  * \param scrn  Index of the screen
 755  * \param ddx_version Version of the 2D DDX.  This may not be meaningful for
 756  *                    all drivers.
 757  * \param dri_version Version of the "server-side" DRI.
 758  * \param drm_version Version of the kernel DRM.
 759  * \param frame_buffer Data describing the location and layout of the
 760  *                     framebuffer.
 761  * \param pSAREA       Pointer to the SAREA.
 762  * \param fd           Device handle for the DRM.
 763  * \param extensions   ??
 764  * \param driver_modes  Returns modes suppoted by the driver
 765  * \param loaderPrivate  ??
 766  *
 767  * \note There is no need to check the minimum API version in this
 768  * function.  Since the name of this function is versioned, it is
 769  * impossible for a loader that is too old to even load this driver.
 770  */
 771 static __DRIscreen *
 772 driCreateNewScreen(int scrn,
 773                    const __DRIversion *ddx_version,
 774                    const __DRIversion *dri_version,
 775                    const __DRIversion *drm_version,
 776                    const __DRIframebuffer *frame_buffer,
 777                    drmAddress pSAREA, int fd,
 778                    const __DRIextension **extensions,
 779                    const __DRIconfig ***driver_modes,
 780                    void *loaderPrivate)
 781 {
 782     static const __DRIextension *emptyExtensionList[] = { NULL };
 783     __DRIscreen *psp;
 784
 785     psp = calloc(1, sizeof *psp);
 786     if (!psp)
 787         return NULL;
 788
 789     setupLoaderExtensions(psp, extensions);
 790
 791     /*
 792     ** NOT_DONE: This is used by the X server to detect when the client
 793     ** has died while holding the drawable lock.  The client sets the
 794     ** drawable lock to this value.
 795     */
 796     psp->drawLockID = 1;
 797
 798     psp->drm_version = *drm_version;
 799     psp->ddx_version = *ddx_version;
 800     psp->dri_version = *dri_version;
 801
 802     psp->pSAREA = pSAREA;
 803     psp->lock = (drmLock *) &psp->pSAREA->lock;
 804
 805     psp->pFB = frame_buffer->base;
 806     psp->fbSize = frame_buffer->size;
 807     psp->fbStride = frame_buffer->stride;
 808     psp->fbWidth = frame_buffer->width;
 809     psp->fbHeight = frame_buffer->height;
 810     psp->devPrivSize = frame_buffer->dev_priv_size;
 811     psp->pDevPriv = frame_buffer->dev_priv;
 812     psp->fbBPP = psp->fbStride * 8 / frame_buffer->width;
 813
 814     psp->extensions = emptyExtensionList;
 815     psp->fd = fd;
 816     psp->myNum = scrn;
 817     psp->dri2.enabled = GL_FALSE;
 818
 819     psp->DriverAPI = driDriverAPI;
 820     psp->api_mask = (1 << __DRI_API_OPENGL);
 821
 822     *driver_modes = driDriverAPI.InitScreen(psp);
 823     if (*driver_modes == NULL) {
 824         free(psp);
 825         return NULL;
 826     }
 827
 828     return psp;
 829 }
 830
 831 /**
 832  * DRI2
 833  */
 834 static __DRIscreen *
 835 dri2CreateNewScreen(int scrn, int fd,
 836                     const __DRIextension **extensions,
 837                     const __DRIconfig ***driver_configs, void *data)
 838 {
 839     static const __DRIextension *emptyExtensionList[] = { NULL };
 840     __DRIscreen *psp;
 841     drmVersionPtr version;
 842     driOptionCache options;
 843
 844     if (driDriverAPI.InitScreen2 == NULL)
 845         return NULL;
 846
 847     psp = calloc(1, sizeof(*psp));
 848     if (!psp)
 849         return NULL;
 850
 851     setupLoaderExtensions(psp, extensions);
 852
 853     version = drmGetVersion(fd);
 854     if (version) {
 855         psp->drm_version.major = version->version_major;
 856         psp->drm_version.minor = version->version_minor;
 857         psp->drm_version.patch = version->version_patchlevel;
 858         drmFreeVersion(version);
 859     }
 860
 861     psp->extensions = emptyExtensionList;
 862     psp->fd = fd;
 863     psp->myNum = scrn;
 864     psp->dri2.enabled = GL_TRUE;
 865
 866     psp->DriverAPI = driDriverAPI;
 867     psp->api_mask = (1 << __DRI_API_OPENGL);
 868     *driver_configs = driDriverAPI.InitScreen2(psp);
 869     if (*driver_configs == NULL) {
 870         free(psp);
 871         return NULL;
 872     }
 873
 874     psp->DriverAPI = driDriverAPI;
 875
 876     driParseOptionInfo(&options, __dri2ConfigOptions, __dri2NConfigOptions);
 877     driParseConfigFiles(&psp->optionCache, &options, psp->myNum, "dri2");
 878
 879     return psp;
 880 }
 881
 882 static const __DRIextension **driGetExtensions(__DRIscreen *psp)
 883 {
 884     return psp->extensions;
 885 }
 886
 887 /** Core interface */
 888 const __DRIcoreExtension driCoreExtension = {
 889     { __DRI_CORE, __DRI_CORE_VERSION },
 890     NULL,
 891     driDestroyScreen,
 892     driGetExtensions,
 893     driGetConfigAttrib,
 894     driIndexConfigAttrib,
 895     NULL,
 896     driDestroyDrawable,
 897     driSwapBuffers,
 898     NULL,
 899     driCopyContext,
 900     driDestroyContext,
 901     driBindContext,
 902     driUnbindContext
 903 };
 904
 905 /** Legacy DRI interface */
 906 const __DRIlegacyExtension driLegacyExtension = {
 907     { __DRI_LEGACY, __DRI_LEGACY_VERSION },
 908     driCreateNewScreen,
 909     driCreateNewDrawable,
 910     driCreateNewContext,
 911 };
 912
 913 /** DRI2 interface */
 914 const __DRIdri2Extension driDRI2Extension = {
 915     { __DRI_DRI2, __DRI_DRI2_VERSION },
 916     dri2CreateNewScreen,
 917     dri2CreateNewDrawable,
 918     dri2CreateNewContext,
 919     dri2GetAPIMask,
 920     dri2CreateNewContextForAPI
 921 };
 922
 923 const __DRI2configQueryExtension dri2ConfigQueryExtension = {
 924    { __DRI2_CONFIG_QUERY, __DRI2_CONFIG_QUERY_VERSION },
 925    dri2ConfigQueryb,
 926    dri2ConfigQueryi,
 927    dri2ConfigQueryf,
 928 };
 929
 930 /**
 931  * Calculate amount of swap interval used between GLX buffer swaps.
 932  *
 933  * The usage value, on the range [0,max], is the fraction of total swap
 934  * interval time used between GLX buffer swaps is calculated.
 935  *
 936  *            \f$p = t_d / (i * t_r)\f$
 937  *
 938  * Where \f$t_d\f$ is the time since the last GLX buffer swap, \f$i\f$ is the
 939  * swap interval (as set by \c glXSwapIntervalSGI), and \f$t_r\f$ time
 940  * required for a single vertical refresh period (as returned by \c
 941  * glXGetMscRateOML).
 942  *
 943  * See the documentation for the GLX_MESA_swap_frame_usage extension for more
 944  * details.
 945  *
 946  * \param   dPriv  Pointer to the private drawable structure.
 947  * \return  If less than a single swap interval time period was required
 948  *          between GLX buffer swaps, a number greater than 0 and less than
 949  *          1.0 is returned.  If exactly one swap interval time period is
 950  *          required, 1.0 is returned, and if more than one is required then
 951  *          a number greater than 1.0 will be returned.
 952  *
 953  * \sa glXSwapIntervalSGI glXGetMscRateOML
 954  *
 955  * \todo Instead of caching the \c glXGetMscRateOML function pointer, would it
 956  *       be possible to cache the sync rate?
 957  */
 958 float
 959 driCalculateSwapUsage( __DRIdrawable *dPriv, int64_t last_swap_ust,
 960                        int64_t current_ust )
 961 {
 962    int32_t   n;
 963    int32_t   d;
 964    int       interval;
 965    float     usage = 1.0;
 966    __DRIscreen *psp = dPriv->driScreenPriv;
 967
 968    if ( (*psp->systemTime->getMSCRate)(dPriv, &n, &d, dPriv->loaderPrivate) ) {
 969       interval = (dPriv->swap_interval != 0) ? dPriv->swap_interval : 1;
 970
 971
 972       /* We want to calculate
 973        * (current_UST - last_swap_UST) / (interval * us_per_refresh).  We get
 974        * current_UST by calling __glXGetUST.  last_swap_UST is stored in
 975        * dPriv->swap_ust.  interval has already been calculated.
 976        *
 977        * The only tricky part is us_per_refresh.  us_per_refresh is
 978        * 1000000 / MSC_rate.  We know the MSC_rate is n / d.  We can flip it
 979        * around and say us_per_refresh = 1000000 * d / n.  Since this goes in
 980        * the denominator of the final calculation, we calculate
 981        * (interval * 1000000 * d) and move n into the numerator.
 982        */
 983
 984       usage = (current_ust - last_swap_ust);
 985       usage *= n;
 986       usage /= (interval * d);
 987       usage /= 1000000.0;
 988    }
 989
 990    return usage;
 991 }
 992
 993 void
 994 dri2InvalidateDrawable(__DRIdrawable *drawable)
 995 {
 996     drawable->dri2.stamp++;
 997 }
 998
 999 /*@}*/