egldisplay.c 13.6 KB
Newer Older
Chia-I Wu's avatar
Chia-I Wu committed
1 2
/**************************************************************************
 *
Jose Fonseca's avatar
Jose Fonseca committed
3
 * Copyright 2008 VMware, Inc.
Chia-I Wu's avatar
Chia-I Wu committed
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30
 * Copyright 2009-2010 Chia-I Wu <olvaffe@gmail.com>
 * Copyright 2010-2011 LunarG, Inc.
 * All Rights Reserved.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the
 * "Software"), to deal in the Software without restriction, including
 * without limitation the rights to use, copy, modify, merge, publish,
 * distribute, sub license, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to
 * the following conditions:
 *
 * The above copyright notice and this permission notice (including the
 * next paragraph) shall be included in all copies or substantial portions
 * of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 * DEALINGS IN THE SOFTWARE.
 *
 **************************************************************************/


31 32 33 34 35
/**
 * Functions related to EGLDisplay.
 */

#include <assert.h>
Brian Paul's avatar
Brian Paul committed
36 37
#include <stdlib.h>
#include <string.h>
38 39
#include "c11/threads.h"

Brian Paul's avatar
Brian Paul committed
40
#include "eglcontext.h"
41
#include "eglcurrent.h"
42
#include "eglsurface.h"
Brian Paul's avatar
Brian Paul committed
43
#include "egldisplay.h"
44
#include "egldriver.h"
Brian Paul's avatar
Brian Paul committed
45
#include "eglglobals.h"
Chia-I Wu's avatar
Chia-I Wu committed
46
#include "egllog.h"
47 48
#include "eglimage.h"
#include "eglsync.h"
49

50 51 52 53 54 55 56 57 58 59 60 61
/* Includes for _eglNativePlatformDetectNativeDisplay */
#ifdef HAVE_MINCORE
#include <unistd.h>
#include <sys/mman.h>
#endif
#ifdef HAVE_WAYLAND_PLATFORM
#include <wayland-client.h>
#endif
#ifdef HAVE_DRM_PLATFORM
#include <gbm.h>
#endif

62

63
/**
64
 * Map --with-platforms names to platform types.
65 66 67 68 69 70 71 72
 */
static const struct {
   _EGLPlatformType platform;
   const char *name;
} egl_platforms[_EGL_NUM_PLATFORMS] = {
   { _EGL_PLATFORM_X11, "x11" },
   { _EGL_PLATFORM_WAYLAND, "wayland" },
   { _EGL_PLATFORM_DRM, "drm" },
73
   { _EGL_PLATFORM_ANDROID, "android" },
74 75
   { _EGL_PLATFORM_HAIKU, "haiku" },
   { _EGL_PLATFORM_SURFACELESS, "surfaceless" },
76 77 78
};


Chia-I Wu's avatar
Chia-I Wu committed
79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106
/**
 * Return the native platform by parsing EGL_PLATFORM.
 */
static _EGLPlatformType
_eglGetNativePlatformFromEnv(void)
{
   _EGLPlatformType plat = _EGL_INVALID_PLATFORM;
   const char *plat_name;
   EGLint i;

   plat_name = getenv("EGL_PLATFORM");
   /* try deprecated env variable */
   if (!plat_name || !plat_name[0])
      plat_name = getenv("EGL_DISPLAY");
   if (!plat_name || !plat_name[0])
      return _EGL_INVALID_PLATFORM;

   for (i = 0; i < _EGL_NUM_PLATFORMS; i++) {
      if (strcmp(egl_platforms[i].name, plat_name) == 0) {
         plat = egl_platforms[i].platform;
         break;
      }
   }

   return plat;
}


107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139
/**
 * Perform validity checks on a generic pointer.
 */
static EGLBoolean
_eglPointerIsDereferencable(void *p)
{
#ifdef HAVE_MINCORE
   uintptr_t addr = (uintptr_t) p;
   unsigned char valid = 0;
   const long page_size = getpagesize();

   if (p == NULL)
      return EGL_FALSE;

   /* align addr to page_size */
   addr &= ~(page_size - 1);

   if (mincore((void *) addr, page_size, &valid) < 0) {
      _eglLog(_EGL_DEBUG, "mincore failed: %m");
      return EGL_FALSE;
   }

   return (valid & 0x01) == 0x01;
#else
   return p != NULL;
#endif
}


/**
 * Try detecting native platform with the help of native display characteristcs.
 */
static _EGLPlatformType
140
_eglNativePlatformDetectNativeDisplay(void *nativeDisplay)
141 142 143 144 145 146 147
{
   if (nativeDisplay == EGL_DEFAULT_DISPLAY)
      return _EGL_INVALID_PLATFORM;

   if (_eglPointerIsDereferencable(nativeDisplay)) {
      void *first_pointer = *(void **) nativeDisplay;

Brian Paul's avatar
Brian Paul committed
148 149
      (void) first_pointer; /* silence unused var warning */

150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166
#ifdef HAVE_WAYLAND_PLATFORM
      /* wl_display is a wl_proxy, which is a wl_object.
       * wl_object's first element points to the interfacetype. */
      if (first_pointer == &wl_display_interface)
         return _EGL_PLATFORM_WAYLAND;
#endif

#ifdef HAVE_DRM_PLATFORM
      /* gbm has a pointer to its constructor as first element. */
      if (first_pointer == gbm_create_device)
         return _EGL_PLATFORM_DRM;
#endif

#ifdef HAVE_X11_PLATFORM
      /* If not matched to any other platform, fallback to x11. */
      return _EGL_PLATFORM_X11;
#endif
167 168 169 170

#ifdef HAVE_HAIKU_PLATFORM
	return _EGL_PLATFORM_HAIKU;
#endif
171 172 173 174 175 176
   }

   return _EGL_INVALID_PLATFORM;
}


Chia-I Wu's avatar
Chia-I Wu committed
177 178 179 180
/**
 * Return the native platform.  It is the platform of the EGL native types.
 */
_EGLPlatformType
181
_eglGetNativePlatform(void *nativeDisplay)
Chia-I Wu's avatar
Chia-I Wu committed
182
{
183
   static _EGLPlatformType native_platform = _EGL_INVALID_PLATFORM;
Chia-I Wu's avatar
Chia-I Wu committed
184 185

   if (native_platform == _EGL_INVALID_PLATFORM) {
186
      const char *detection_method;
187

188 189
      native_platform = _eglGetNativePlatformFromEnv();
      detection_method = "environment overwrite";
Chia-I Wu's avatar
Chia-I Wu committed
190

191 192 193 194 195 196 197 198 199 200 201 202 203
      if (native_platform == _EGL_INVALID_PLATFORM) {
         native_platform = _eglNativePlatformDetectNativeDisplay(nativeDisplay);
         detection_method = "autodetected";
      }

      if (native_platform == _EGL_INVALID_PLATFORM) {
         native_platform = _EGL_NATIVE_PLATFORM;
         detection_method = "build-time configuration";
      }

      _eglLog(_EGL_DEBUG, "Native platform type: %s (%s)",
              egl_platforms[native_platform].name, detection_method);
   }
204

Chia-I Wu's avatar
Chia-I Wu committed
205 206 207 208
   return native_platform;
}


209 210 211
/**
 * Finish display management.
 */
212
void
213 214
_eglFiniDisplay(void)
{
215
   _EGLDisplay *dpyList, *dpy;
216

217 218 219
   /* atexit function is called with global mutex locked */
   dpyList = _eglGlobal.DisplayList;
   while (dpyList) {
220 221
      EGLint i;

222 223 224
      /* pop list head */
      dpy = dpyList;
      dpyList = dpyList->Next;
225

226 227 228 229 230 231
      for (i = 0; i < _EGL_NUM_RESOURCES; i++) {
         if (dpy->ResourceLists[i]) {
            _eglLog(_EGL_DEBUG, "Display %p is destroyed with resources", dpy);
            break;
         }
      }
232

233
      free(dpy);
234
   }
235
   _eglGlobal.DisplayList = NULL;
236
}
Brian Paul's avatar
Brian Paul committed
237 238 239


/**
Chia-I Wu's avatar
Chia-I Wu committed
240 241
 * Find the display corresponding to the specified native display, or create a
 * new one.
242 243
 */
_EGLDisplay *
244
_eglFindDisplay(_EGLPlatformType plat, void *plat_dpy)
245
{
246
   _EGLDisplay *dpy;
247

248 249 250
   if (plat == _EGL_INVALID_PLATFORM)
      return NULL;

251
   mtx_lock(_eglGlobal.Mutex);
252

Chia-I Wu's avatar
Chia-I Wu committed
253
   /* search the display list first */
254 255
   dpy = _eglGlobal.DisplayList;
   while (dpy) {
256
      if (dpy->Platform == plat && dpy->PlatformDisplay == plat_dpy)
Chia-I Wu's avatar
Chia-I Wu committed
257
         break;
258
      dpy = dpy->Next;
259 260
   }

Chia-I Wu's avatar
Chia-I Wu committed
261 262
   /* create a new display */
   if (!dpy) {
263
      dpy = calloc(1, sizeof(_EGLDisplay));
Chia-I Wu's avatar
Chia-I Wu committed
264
      if (dpy) {
265
         mtx_init(&dpy->Mutex, mtx_plain);
266 267
         dpy->Platform = plat;
         dpy->PlatformDisplay = plat_dpy;
Chia-I Wu's avatar
Chia-I Wu committed
268 269 270 271 272 273 274

         /* add to the display list */ 
         dpy->Next = _eglGlobal.DisplayList;
         _eglGlobal.DisplayList = dpy;
      }
   }

275
   mtx_unlock(_eglGlobal.Mutex);
276

Chia-I Wu's avatar
Chia-I Wu committed
277
   return dpy;
278 279 280
}


281 282 283 284
/**
 * Destroy the contexts and surfaces that are linked to the display.
 */
void
Chia-I Wu's avatar
Chia-I Wu committed
285
_eglReleaseDisplayResources(_EGLDriver *drv, _EGLDisplay *display)
286
{
287
   _EGLResource *list;
288

289 290 291 292
   list = display->ResourceLists[_EGL_RESOURCE_CONTEXT];
   while (list) {
      _EGLContext *ctx = (_EGLContext *) list;
      list = list->Next;
Chia-I Wu's avatar
Chia-I Wu committed
293 294 295

      _eglUnlinkContext(ctx);
      drv->API.DestroyContext(drv, display, ctx);
296
   }
297
   assert(!display->ResourceLists[_EGL_RESOURCE_CONTEXT]);
298

299 300 301 302
   list = display->ResourceLists[_EGL_RESOURCE_SURFACE];
   while (list) {
      _EGLSurface *surf = (_EGLSurface *) list;
      list = list->Next;
Chia-I Wu's avatar
Chia-I Wu committed
303 304 305

      _eglUnlinkSurface(surf);
      drv->API.DestroySurface(drv, display, surf);
306
   }
307
   assert(!display->ResourceLists[_EGL_RESOURCE_SURFACE]);
308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327

   list = display->ResourceLists[_EGL_RESOURCE_IMAGE];
   while (list) {
      _EGLImage *image = (_EGLImage *) list;
      list = list->Next;

      _eglUnlinkImage(image);
      drv->API.DestroyImageKHR(drv, display, image);
   }
   assert(!display->ResourceLists[_EGL_RESOURCE_IMAGE]);

   list = display->ResourceLists[_EGL_RESOURCE_SYNC];
   while (list) {
      _EGLSync *sync = (_EGLSync *) list;
      list = list->Next;

      _eglUnlinkSync(sync);
      drv->API.DestroySyncKHR(drv, display, sync);
   }
   assert(!display->ResourceLists[_EGL_RESOURCE_SYNC]);
328 329 330
}


331 332 333 334
/**
 * Free all the data hanging of an _EGLDisplay object, but not
 * the object itself.
 */
Brian Paul's avatar
Brian Paul committed
335
void
336
_eglCleanupDisplay(_EGLDisplay *disp)
Brian Paul's avatar
Brian Paul committed
337
{
338
   if (disp->Configs) {
339
      _eglDestroyArray(disp->Configs, free);
340
      disp->Configs = NULL;
341 342 343
   }

   /* XXX incomplete */
Brian Paul's avatar
Brian Paul committed
344
}
345 346


Chia-I Wu's avatar
Chia-I Wu committed
347 348 349 350 351 352 353 354
/**
 * Return EGL_TRUE if the given handle is a valid handle to a display.
 */
EGLBoolean
_eglCheckDisplayHandle(EGLDisplay dpy)
{
   _EGLDisplay *cur;

355
   mtx_lock(_eglGlobal.Mutex);
Chia-I Wu's avatar
Chia-I Wu committed
356 357 358 359 360 361
   cur = _eglGlobal.DisplayList;
   while (cur) {
      if (cur == (_EGLDisplay *) dpy)
         break;
      cur = cur->Next;
   }
362
   mtx_unlock(_eglGlobal.Mutex);
Chia-I Wu's avatar
Chia-I Wu committed
363 364 365 366
   return (cur != NULL);
}


367 368 369 370 371
/**
 * Return EGL_TRUE if the given resource is valid.  That is, the display does
 * own the resource.
 */
EGLBoolean
372
_eglCheckResource(void *res, _EGLResourceType type, _EGLDisplay *dpy)
373 374 375
{
   _EGLResource *list = dpy->ResourceLists[type];
   
376 377 378
   if (!res)
      return EGL_FALSE;

379
   while (list) {
380
      if (res == (void *) list) {
381 382 383 384 385 386 387 388 389 390
         assert(list->Display == dpy);
         break;
      }
      list = list->Next;
   }

   return (list != NULL);
}


391
/**
392 393 394 395 396
 * Initialize a display resource.  The size of the subclass object is
 * specified.
 *
 * This is supposed to be called from the initializers of subclasses, such as
 * _eglInitContext or _eglInitSurface.
397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430
 */
void
_eglInitResource(_EGLResource *res, EGLint size, _EGLDisplay *dpy)
{
   memset(res, 0, size);
   res->Display = dpy;
   res->RefCount = 1;
}


/**
 * Increment reference count for the resource.
 */
void
_eglGetResource(_EGLResource *res)
{
   assert(res && res->RefCount > 0);
   /* hopefully a resource is always manipulated with its display locked */
   res->RefCount++;
}


/**
 * Decrement reference count for the resource.
 */
EGLBoolean
_eglPutResource(_EGLResource *res)
{
   assert(res && res->RefCount > 0);
   res->RefCount--;
   return (!res->RefCount);
}


431
/**
432
 * Link a resource to its display.
433 434
 */
void
435
_eglLinkResource(_EGLResource *res, _EGLResourceType type)
436
{
437
   assert(res->Display);
438 439

   res->IsLinked = EGL_TRUE;
440 441
   res->Next = res->Display->ResourceLists[type];
   res->Display->ResourceLists[type] = res;
442
   _eglGetResource(res);
443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468
}


/**
 * Unlink a linked resource from its display.
 */
void
_eglUnlinkResource(_EGLResource *res, _EGLResourceType type)
{
   _EGLResource *prev;

   prev = res->Display->ResourceLists[type];
   if (prev != res) {
      while (prev) {
         if (prev->Next == res)
            break;
         prev = prev->Next;
      }
      assert(prev);
      prev->Next = res->Next;
   }
   else {
      res->Display->ResourceLists[type] = res->Next;
   }

   res->Next = NULL;
469
   res->IsLinked = EGL_FALSE;
470 471 472 473
   _eglPutResource(res);

   /* We always unlink before destroy.  The driver still owns a reference */
   assert(res->RefCount);
474
}
475 476 477

#ifdef HAVE_X11_PLATFORM
static EGLBoolean
478
_eglParseX11DisplayAttribList(_EGLDisplay *display, const EGLint *attrib_list)
479 480 481 482 483 484 485 486 487 488 489 490 491 492
{
   int i;

   if (attrib_list == NULL) {
      return EGL_TRUE;
   }

   for (i = 0; attrib_list[i] != EGL_NONE; i += 2) {
      EGLint attrib = attrib_list[i];
      EGLint value = attrib_list[i + 1];

      /* EGL_EXT_platform_x11 recognizes exactly one attribute,
       * EGL_PLATFORM_X11_SCREEN_EXT, which is optional.
       */
493
      if (attrib == EGL_PLATFORM_X11_SCREEN_EXT) {
chadversary's avatar
chadversary committed
494
         display->Options.Platform = (void *)(uintptr_t)value;
495
      } else {
496 497 498 499 500 501 502 503 504 505 506 507
         _eglError(EGL_BAD_ATTRIBUTE, "eglGetPlatformDisplay");
         return EGL_FALSE;
      }
   }

   return EGL_TRUE;
}

_EGLDisplay*
_eglGetX11Display(Display *native_display,
                  const EGLint *attrib_list)
{
508 509 510
   _EGLDisplay *display = _eglFindDisplay(_EGL_PLATFORM_X11,
                                          native_display);

511
   if (!display) {
512
      _eglError(EGL_BAD_ALLOC, "eglGetPlatformDisplay");
513 514
      return NULL;
   }
515 516

   if (!_eglParseX11DisplayAttribList(display, attrib_list)) {
517 518 519
      return NULL;
   }

520
   return display;
521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552
}
#endif /* HAVE_X11_PLATFORM */

#ifdef HAVE_DRM_PLATFORM
_EGLDisplay*
_eglGetGbmDisplay(struct gbm_device *native_display,
                  const EGLint *attrib_list)
{
   /* EGL_MESA_platform_gbm recognizes no attributes. */
   if (attrib_list != NULL && attrib_list[0] != EGL_NONE) {
      _eglError(EGL_BAD_ATTRIBUTE, "eglGetPlatformDisplay");
      return NULL;
   }

   return _eglFindDisplay(_EGL_PLATFORM_DRM, native_display);
}
#endif /* HAVE_DRM_PLATFORM */

#ifdef HAVE_WAYLAND_PLATFORM
_EGLDisplay*
_eglGetWaylandDisplay(struct wl_display *native_display,
                      const EGLint *attrib_list)
{
   /* EGL_EXT_platform_wayland recognizes no attributes. */
   if (attrib_list != NULL && attrib_list[0] != EGL_NONE) {
      _eglError(EGL_BAD_ATTRIBUTE, "eglGetPlatformDisplay");
      return NULL;
   }

   return _eglFindDisplay(_EGL_PLATFORM_WAYLAND, native_display);
}
#endif /* HAVE_WAYLAND_PLATFORM */
553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573

#ifdef HAVE_SURFACELESS_PLATFORM
_EGLDisplay*
_eglGetSurfacelessDisplay(void *native_display,
                          const EGLint *attrib_list)
{
   /* This platform has no native display. */
   if (native_display != NULL) {
      _eglError(EGL_BAD_PARAMETER, "eglGetPlatformDisplay");
      return NULL;
   }

   /* This platform recognizes no display attributes. */
   if (attrib_list != NULL && attrib_list[0] != EGL_NONE) {
      _eglError(EGL_BAD_ATTRIBUTE, "eglGetPlatformDisplay");
      return NULL;
   }

   return _eglFindDisplay(_EGL_PLATFORM_SURFACELESS, native_display);
}
#endif /* HAVE_SURFACELESS_PLATFORM */