src/egl/drivers/dri2/egl_dri2.h

   1 /*
   2  * Copyright © 2011 Intel Corporation
   3  *
   4  * Permission is hereby granted, free of charge, to any person obtaining a
   5  * copy of this software and associated documentation files (the "Software"),
   6  * to deal in the Software without restriction, including without limitation
   7  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
   8  * and/or sell copies of the Software, and to permit persons to whom the
   9  * Software is furnished to do so, subject to the following conditions:
  10  *
  11  * The above copyright notice and this permission notice (including the next
  12  * paragraph) shall be included in all copies or substantial portions of the
  13  * Software.
  14  *
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  16  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  17  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  18  * NONINFRINGEMENT.  IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
  19  * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
  20  * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  22  * DEALINGS IN THE SOFTWARE.
  23  *
  24  * Authors:
  25  *    Kristian Høgsberg <krh@bitplanet.net>
  26  */
  27
  28 #ifndef EGL_DRI2_INCLUDED
  29 #define EGL_DRI2_INCLUDED
  30
  31 #include <stdbool.h>
  32 #include <stdint.h>
  33
  34 #ifdef HAVE_X11_PLATFORM
  35 #include <xcb/xcb.h>
  36 #include <xcb/dri2.h>
  37 #include <xcb/xfixes.h>
  38 #include <X11/Xlib-xcb.h>
  39
  40 #ifdef HAVE_DRI3
  41 #include "loader_dri3_helper.h"
  42 #endif
  43 #endif
  44
  45 #ifdef HAVE_WAYLAND_PLATFORM
  46 /* forward declarations to avoid pulling wayland headers everywhere */
  47 struct wl_egl_window;
  48 struct wl_event_queue;
  49 struct wl_callback;
  50 struct wl_display;
  51 struct wl_drm;
  52 struct wl_registry;
  53 struct wl_shm;
  54 struct wl_surface;
  55 struct zwp_linux_dmabuf_v1;
  56 #endif
  57
  58 #include <GL/gl.h>
  59 #include <GL/internal/dri_interface.h>
  60
  61 #ifdef HAVE_DRM_PLATFORM
  62 #include <gbm_driint.h>
  63 #endif
  64
  65 #ifdef HAVE_ANDROID_PLATFORM
  66 #define LOG_TAG "EGL-DRI2"
  67
  68 #include <system/window.h>
  69 #include <hardware/gralloc.h>
  70 #endif /* HAVE_ANDROID_PLATFORM */
  71
  72 #include "eglconfig.h"
  73 #include "eglcontext.h"
  74 #include "egldevice.h"
  75 #include "egldisplay.h"
  76 #include "egldriver.h"
  77 #include "eglcurrent.h"
  78 #include "egllog.h"
  79 #include "eglsurface.h"
  80 #include "eglimage.h"
  81 #include "eglsync.h"
  82
  83 #include "util/u_vector.h"
  84 #include "util/bitset.h"
  85
  86 #define EGL_DRI2_MAX_FORMATS 10
  87
  88 struct wl_buffer;
  89
  90 struct dri2_egl_display_vtbl {
  91    /* mandatory on Wayland, unused otherwise */
  92    int (*authenticate)(_EGLDisplay *disp, uint32_t id);
  93
  94    /* mandatory */
  95    _EGLSurface* (*create_window_surface)(_EGLDisplay *disp, _EGLConfig *config,
  96                                          void *native_window,
  97                                          const EGLint *attrib_list);
  98
  99    /* optional */
 100    _EGLSurface* (*create_pixmap_surface)(_EGLDisplay *disp, _EGLConfig *config,
 101                                          void *native_pixmap,
 102                                          const EGLint *attrib_list);
 103
 104    /* optional */
 105    _EGLSurface* (*create_pbuffer_surface)(_EGLDisplay *disp, _EGLConfig *config,
 106                                           const EGLint *attrib_list);
 107
 108    /* mandatory */
 109    EGLBoolean (*destroy_surface)(_EGLDisplay *disp, _EGLSurface *surface);
 110
 111    /* optional */
 112    EGLBoolean (*swap_interval)(const _EGLDriver *drv, _EGLDisplay *disp,
 113                                _EGLSurface *surf, EGLint interval);
 114
 115    /* mandatory */
 116    _EGLImage* (*create_image)(const _EGLDriver *drv, _EGLDisplay *disp,
 117                               _EGLContext *ctx, EGLenum target,
 118                               EGLClientBuffer buffer,
 119                               const EGLint *attr_list);
 120
 121    /* mandatory */
 122    EGLBoolean (*swap_buffers)(const _EGLDriver *drv, _EGLDisplay *disp,
 123                               _EGLSurface *surf);
 124
 125    /* optional - falls back to .swap_buffers */
 126    EGLBoolean (*swap_buffers_with_damage)(const _EGLDriver *drv, _EGLDisplay *disp,
 127                                           _EGLSurface *surface,
 128                                           const EGLint *rects, EGLint n_rects);
 129
 130    /* optional */
 131    EGLBoolean (*swap_buffers_region)(const _EGLDriver *drv, _EGLDisplay *disp,
 132                                      _EGLSurface *surf, EGLint numRects,
 133                                      const EGLint *rects);
 134
 135    /* optional */
 136    EGLBoolean (*post_sub_buffer)(const _EGLDriver *drv, _EGLDisplay *disp,
 137                                  _EGLSurface *surf,
 138                                  EGLint x, EGLint y,
 139                                  EGLint width, EGLint height);
 140
 141    /* optional */
 142    EGLBoolean (*copy_buffers)(const _EGLDriver *drv, _EGLDisplay *disp,
 143                               _EGLSurface *surf, void *native_pixmap_target);
 144
 145    /* optional */
 146    EGLint (*query_buffer_age)(const _EGLDriver *drv, _EGLDisplay *disp,
 147                               _EGLSurface *surf);
 148
 149    /* optional */
 150    EGLBoolean (*query_surface)(_EGLDisplay *disp, _EGLSurface *surf,
 151                                EGLint attribute, EGLint *value);
 152
 153    /* optional */
 154    struct wl_buffer* (*create_wayland_buffer_from_image)(
 155                         const _EGLDriver *drv, _EGLDisplay *disp, _EGLImage *img);
 156
 157    /* optional */
 158    EGLBoolean (*get_sync_values)(_EGLDisplay *display, _EGLSurface *surface,
 159                                  EGLuint64KHR *ust, EGLuint64KHR *msc,
 160                                  EGLuint64KHR *sbc);
 161
 162    /* mandatory */
 163    __DRIdrawable *(*get_dri_drawable)(_EGLSurface *surf);
 164
 165    /* optional */
 166    void (*close_screen_notify)(_EGLDisplay *disp);
 167
 168    /* Used in EGL_KHR_mutable_render_buffer to update the native window's
 169     * shared buffer mode.
 170     * optional
 171     */
 172    bool (*set_shared_buffer_mode)(_EGLDisplay *disp, _EGLSurface *surf,
 173                                   bool mode);
 174 };
 175
 176 struct dri2_egl_display
 177 {
 178    const struct dri2_egl_display_vtbl *vtbl;
 179
 180    int                       dri2_major;
 181    int                       dri2_minor;
 182    __DRIscreen              *dri_screen;
 183    bool                      own_dri_screen;
 184    const __DRIconfig       **driver_configs;
 185    void                     *driver;
 186    const __DRIcoreExtension       *core;
 187    const __DRIimageDriverExtension *image_driver;
 188    const __DRIdri2Extension       *dri2;
 189    const __DRIswrastExtension     *swrast;
 190    const __DRI2flushExtension     *flush;
 191    const __DRI2flushControlExtension *flush_control;
 192    const __DRItexBufferExtension  *tex_buffer;
 193    const __DRIimageExtension      *image;
 194    const __DRIrobustnessExtension *robustness;
 195    const __DRInoErrorExtension    *no_error;
 196    const __DRI2configQueryExtension *config;
 197    const __DRI2fenceExtension *fence;
 198    const __DRI2bufferDamageExtension *buffer_damage;
 199    const __DRI2blobExtension *blob;
 200    const __DRI2rendererQueryExtension *rendererQuery;
 201    const __DRI2interopExtension *interop;
 202    const __DRIconfigOptionsExtension *configOptions;
 203    const __DRImutableRenderBufferDriverExtension *mutable_render_buffer;
 204    int                       fd;
 205
 206    /* dri2_initialize/dri2_terminate increment/decrement this count, so does
 207     * dri2_make_current (tracks if there are active contexts/surfaces). */
 208    int                       ref_count;
 209
 210    bool                      own_device;
 211    bool                      invalidate_available;
 212    int                       min_swap_interval;
 213    int                       max_swap_interval;
 214    int                       default_swap_interval;
 215 #ifdef HAVE_DRM_PLATFORM
 216    struct gbm_dri_device    *gbm_dri;
 217 #endif
 218
 219    char                     *driver_name;
 220
 221    const __DRIextension    **loader_extensions;
 222    const __DRIextension    **driver_extensions;
 223
 224 #ifdef HAVE_X11_PLATFORM
 225    xcb_connection_t         *conn;
 226    xcb_screen_t             *screen;
 227    bool                     swap_available;
 228 #ifdef HAVE_DRI3
 229    bool                     multibuffers_available;
 230    int                      dri3_major_version;
 231    int                      dri3_minor_version;
 232    int                      present_major_version;
 233    int                      present_minor_version;
 234    struct loader_dri3_extensions loader_dri3_ext;
 235 #endif
 236 #endif
 237
 238 #ifdef HAVE_WAYLAND_PLATFORM
 239    struct wl_display        *wl_dpy;
 240    struct wl_display        *wl_dpy_wrapper;
 241    struct wl_registry       *wl_registry;
 242    struct wl_drm            *wl_server_drm;
 243    struct wl_drm            *wl_drm;
 244    struct wl_shm            *wl_shm;
 245    struct wl_event_queue    *wl_queue;
 246    struct zwp_linux_dmabuf_v1 *wl_dmabuf;
 247    struct u_vector          *wl_modifiers;
 248    bool                      authenticated;
 249    BITSET_DECLARE(formats, EGL_DRI2_MAX_FORMATS);
 250    uint32_t                  capabilities;
 251    char                     *device_name;
 252 #endif
 253
 254 #ifdef HAVE_ANDROID_PLATFORM
 255    const gralloc_module_t *gralloc;
 256 #endif
 257
 258    bool                      is_render_node;
 259    bool                      is_different_gpu;
 260 };
 261
 262 struct dri2_egl_context
 263 {
 264    _EGLContext   base;
 265    __DRIcontext *dri_context;
 266 };
 267
 268 #ifdef HAVE_WAYLAND_PLATFORM
 269 enum wayland_buffer_type {
 270    WL_BUFFER_FRONT,
 271    WL_BUFFER_BACK,
 272    WL_BUFFER_THIRD,
 273    WL_BUFFER_COUNT
 274 };
 275 #endif
 276
 277 struct dri2_egl_surface
 278 {
 279    _EGLSurface          base;
 280    __DRIdrawable       *dri_drawable;
 281    __DRIbuffer          buffers[5];
 282    bool                 have_fake_front;
 283
 284 #ifdef HAVE_X11_PLATFORM
 285    xcb_drawable_t       drawable;
 286    xcb_xfixes_region_t  region;
 287    int                  depth;
 288    int                  bytes_per_pixel;
 289    xcb_gcontext_t       gc;
 290    xcb_gcontext_t       swapgc;
 291 #endif
 292
 293 #ifdef HAVE_WAYLAND_PLATFORM
 294    struct wl_egl_window  *wl_win;
 295    int                    dx;
 296    int                    dy;
 297    struct wl_event_queue *wl_queue;
 298    struct wl_surface     *wl_surface_wrapper;
 299    struct wl_display     *wl_dpy_wrapper;
 300    struct wl_drm         *wl_drm_wrapper;
 301    struct wl_callback    *throttle_callback;
 302    int                    format;
 303 #endif
 304
 305 #ifdef HAVE_DRM_PLATFORM
 306    struct gbm_dri_surface *gbm_surf;
 307 #endif
 308
 309    /* EGL-owned buffers */
 310    __DRIbuffer           *local_buffers[__DRI_BUFFER_COUNT];
 311
 312 #if defined(HAVE_WAYLAND_PLATFORM) || defined(HAVE_DRM_PLATFORM)
 313    struct {
 314 #ifdef HAVE_WAYLAND_PLATFORM
 315       struct wl_buffer   *wl_buffer;
 316       bool                wl_release;
 317       __DRIimage         *dri_image;
 318       /* for is_different_gpu case. NULL else */
 319       __DRIimage         *linear_copy;
 320       /* for swrast */
 321       void *data;
 322       int data_size;
 323 #endif
 324 #ifdef HAVE_DRM_PLATFORM
 325       struct gbm_bo       *bo;
 326 #endif
 327       bool                locked;
 328       int                 age;
 329    } color_buffers[4], *back, *current;
 330 #endif
 331
 332 #ifdef HAVE_ANDROID_PLATFORM
 333    struct ANativeWindow *window;
 334    struct ANativeWindowBuffer *buffer;
 335    __DRIimage *dri_image_back;
 336    __DRIimage *dri_image_front;
 337
 338    /* Used to record all the buffers created by ANativeWindow and their ages.
 339     * Allocate number of color_buffers based on query to android bufferqueue
 340     * and save color_buffers_count.
 341     */
 342    int color_buffers_count;
 343    struct {
 344       struct ANativeWindowBuffer *buffer;
 345       int age;
 346    } *color_buffers, *back;
 347 #endif
 348
 349    /* surfaceless and device */
 350    __DRIimage           *front;
 351    unsigned int         visual;
 352
 353    int out_fence_fd;
 354    EGLBoolean enable_out_fence;
 355
 356    /* swrast device */
 357    char *swrast_device_buffer;
 358 };
 359
 360 struct dri2_egl_config
 361 {
 362    _EGLConfig         base;
 363    const __DRIconfig *dri_config[2][2];
 364 };
 365
 366 struct dri2_egl_image
 367 {
 368    _EGLImage   base;
 369    __DRIimage *dri_image;
 370 };
 371
 372 struct dri2_egl_sync {
 373    _EGLSync base;
 374    mtx_t mutex;
 375    cnd_t cond;
 376    int refcount;
 377    void *fence;
 378 };
 379
 380 /* From driconf.h, user exposed so should be stable */
 381 #define DRI_CONF_VBLANK_NEVER 0
 382 #define DRI_CONF_VBLANK_DEF_INTERVAL_0 1
 383 #define DRI_CONF_VBLANK_DEF_INTERVAL_1 2
 384 #define DRI_CONF_VBLANK_ALWAYS_SYNC 3
 385
 386 /* standard typecasts */
 387 _EGL_DRIVER_STANDARD_TYPECASTS(dri2_egl)
 388 _EGL_DRIVER_TYPECAST(dri2_egl_image, _EGLImage, obj)
 389 _EGL_DRIVER_TYPECAST(dri2_egl_sync, _EGLSync, obj)
 390
 391 extern const __DRIimageLookupExtension image_lookup_extension;
 392 extern const __DRIuseInvalidateExtension use_invalidate;
 393 extern const __DRIbackgroundCallableExtension background_callable_extension;
 394 extern const __DRIswrastLoaderExtension swrast_pbuffer_loader_extension;
 395
 396 EGLBoolean
 397 dri2_load_driver(_EGLDisplay *disp);
 398
 399 /* Helper for platforms not using dri2_create_screen */
 400 void
 401 dri2_setup_screen(_EGLDisplay *disp);
 402
 403 void
 404 dri2_setup_swap_interval(_EGLDisplay *disp, int max_swap_interval);
 405
 406 EGLBoolean
 407 dri2_load_driver_swrast(_EGLDisplay *disp);
 408
 409 EGLBoolean
 410 dri2_load_driver_dri3(_EGLDisplay *disp);
 411
 412 EGLBoolean
 413 dri2_create_screen(_EGLDisplay *disp);
 414
 415 EGLBoolean
 416 dri2_setup_extensions(_EGLDisplay *disp);
 417
 418 __DRIdrawable *
 419 dri2_surface_get_dri_drawable(_EGLSurface *surf);
 420
 421 __DRIimage *
 422 dri2_lookup_egl_image(__DRIscreen *screen, void *image, void *data);
 423
 424 void
 425 dri2_get_shifts_and_sizes(const __DRIcoreExtension *core,
 426                           const __DRIconfig *config, int *shifts,
 427                           unsigned int *sizes);
 428
 429 void
 430 dri2_get_render_type_float(const __DRIcoreExtension *core,
 431                            const __DRIconfig *config,
 432                            bool *is_float);
 433
 434 unsigned int
 435 dri2_image_format_for_pbuffer_config(struct dri2_egl_display *dri2_dpy,
 436                                      const __DRIconfig *config);
 437
 438 struct dri2_egl_config *
 439 dri2_add_config(_EGLDisplay *disp, const __DRIconfig *dri_config, int id,
 440                 EGLint surface_type, const EGLint *attr_list,
 441                 const int *rgba_shifts, const unsigned int *rgba_sizes);
 442
 443 EGLBoolean
 444 dri2_add_pbuffer_configs_for_visuals(_EGLDisplay *disp);
 445
 446 _EGLImage *
 447 dri2_create_image_khr(const _EGLDriver *drv, _EGLDisplay *disp,
 448                       _EGLContext *ctx, EGLenum target,
 449                       EGLClientBuffer buffer, const EGLint *attr_list);
 450
 451 _EGLImage *
 452 dri2_create_image_dma_buf(_EGLDisplay *disp, _EGLContext *ctx,
 453                           EGLClientBuffer buffer, const EGLint *attr_list);
 454
 455 #ifdef HAVE_X11_PLATFORM
 456 EGLBoolean
 457 dri2_initialize_x11(_EGLDisplay *disp);
 458 void
 459 dri2_teardown_x11(struct dri2_egl_display *dri2_dpy);
 460 unsigned int
 461 dri2_x11_get_red_mask_for_depth(struct dri2_egl_display *dri2_dpy, int depth);
 462 #else
 463 static inline EGLBoolean
 464 dri2_initialize_x11(_EGLDisplay *disp)
 465 {
 466    return _eglError(EGL_NOT_INITIALIZED, "X11 platform not built");
 467 }
 468 static inline void
 469 dri2_teardown_x11(struct dri2_egl_display *dri2_dpy) {}
 470 static inline unsigned int
 471 dri2_x11_get_red_mask_for_depth(struct dri2_egl_display *dri2_dpy, int depth)
 472 {
 473    return 0;
 474 }
 475 #endif
 476
 477 #ifdef HAVE_DRM_PLATFORM
 478 EGLBoolean
 479 dri2_initialize_drm(_EGLDisplay *disp);
 480 void
 481 dri2_teardown_drm(struct dri2_egl_display *dri2_dpy);
 482 #else
 483 static inline EGLBoolean
 484 dri2_initialize_drm(_EGLDisplay *disp)
 485 {
 486    return _eglError(EGL_NOT_INITIALIZED, "GBM/DRM platform not built");
 487 }
 488 static inline void
 489 dri2_teardown_drm(struct dri2_egl_display *dri2_dpy) {}
 490 #endif
 491
 492 #ifdef HAVE_WAYLAND_PLATFORM
 493 EGLBoolean
 494 dri2_initialize_wayland(_EGLDisplay *disp);
 495 void
 496 dri2_teardown_wayland(struct dri2_egl_display *dri2_dpy);
 497 bool
 498 dri2_wl_is_format_supported(void* user_data, uint32_t format);
 499 #else
 500 static inline EGLBoolean
 501 dri2_initialize_wayland(_EGLDisplay *disp)
 502 {
 503    return _eglError(EGL_NOT_INITIALIZED, "Wayland platform not built");
 504 }
 505 static inline void
 506 dri2_teardown_wayland(struct dri2_egl_display *dri2_dpy) {}
 507 #endif
 508
 509 #ifdef HAVE_ANDROID_PLATFORM
 510 EGLBoolean
 511 dri2_initialize_android(_EGLDisplay *disp);
 512 #else
 513 static inline EGLBoolean
 514 dri2_initialize_android(_EGLDisplay *disp)
 515 {
 516    return _eglError(EGL_NOT_INITIALIZED, "Android platform not built");
 517 }
 518 #endif
 519
 520 EGLBoolean
 521 dri2_initialize_surfaceless(_EGLDisplay *disp);
 522
 523 EGLBoolean
 524 dri2_initialize_device(_EGLDisplay *disp);
 525 static inline void
 526 dri2_teardown_device(struct dri2_egl_display *dri2_dpy) { /* noop */ }
 527
 528 void
 529 dri2_flush_drawable_for_swapbuffers(_EGLDisplay *disp, _EGLSurface *draw);
 530
 531 const __DRIconfig *
 532 dri2_get_dri_config(struct dri2_egl_config *conf, EGLint surface_type,
 533                     EGLenum colorspace);
 534
 535 static inline void
 536 dri2_set_WL_bind_wayland_display(_EGLDisplay *disp)
 537 {
 538 #ifdef HAVE_WAYLAND_PLATFORM
 539    struct dri2_egl_display *dri2_dpy = dri2_egl_display(disp);
 540
 541    if (dri2_dpy->device_name && dri2_dpy->image) {
 542        if (dri2_dpy->image->base.version >= 10 &&
 543            dri2_dpy->image->getCapabilities != NULL) {
 544            int capabilities;
 545
 546            capabilities =
 547                dri2_dpy->image->getCapabilities(dri2_dpy->dri_screen);
 548            disp->Extensions.WL_bind_wayland_display =
 549                (capabilities & __DRI_IMAGE_CAP_GLOBAL_NAMES) != 0;
 550        } else {
 551            disp->Extensions.WL_bind_wayland_display = EGL_TRUE;
 552        }
 553    }
 554 #endif
 555 }
 556
 557 void
 558 dri2_display_destroy(_EGLDisplay *disp);
 559
 560 __DRIbuffer *
 561 dri2_egl_surface_alloc_local_buffer(struct dri2_egl_surface *dri2_surf,
 562                                     unsigned int att, unsigned int format);
 563
 564 void
 565 dri2_egl_surface_free_local_buffers(struct dri2_egl_surface *dri2_surf);
 566
 567 EGLBoolean
 568 dri2_init_surface(_EGLSurface *surf, _EGLDisplay *disp, EGLint type,
 569         _EGLConfig *conf, const EGLint *attrib_list,
 570         EGLBoolean enable_out_fence, void *native_surface);
 571
 572 void
 573 dri2_fini_surface(_EGLSurface *surf);
 574
 575 EGLBoolean
 576 dri2_create_drawable(struct dri2_egl_display *dri2_dpy,
 577                      const __DRIconfig *config,
 578                      struct dri2_egl_surface *dri2_surf,
 579                      void *loaderPrivate);
 580
 581 static inline uint64_t
 582 combine_u32_into_u64(uint32_t hi, uint32_t lo)
 583 {
 584    return (((uint64_t) hi) << 32) | (((uint64_t) lo) & 0xffffffff);
 585 }
 586
 587 #endif /* EGL_DRI2_INCLUDED */