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 8
  87
  88 struct wl_buffer;
  89
  90 struct dri2_egl_display_vtbl {
  91    int (*authenticate)(_EGLDisplay *disp, uint32_t id);
  92
  93    _EGLSurface* (*create_window_surface)(_EGLDriver *drv, _EGLDisplay *disp,
  94                                          _EGLConfig *config,
  95                                          void *native_window,
  96                                          const EGLint *attrib_list);
  97
  98    _EGLSurface* (*create_pixmap_surface)(_EGLDriver *drv, _EGLDisplay *disp,
  99                                          _EGLConfig *config,
 100                                          void *native_pixmap,
 101                                          const EGLint *attrib_list);
 102
 103    _EGLSurface* (*create_pbuffer_surface)(_EGLDriver *drv, _EGLDisplay *disp,
 104                                           _EGLConfig *config,
 105                                           const EGLint *attrib_list);
 106
 107    EGLBoolean (*destroy_surface)(_EGLDriver *drv, _EGLDisplay *disp,
 108                                  _EGLSurface *surface);
 109
 110    EGLBoolean (*swap_interval)(_EGLDriver *drv, _EGLDisplay *disp,
 111                                _EGLSurface *surf, EGLint interval);
 112
 113    _EGLImage* (*create_image)(_EGLDriver *drv, _EGLDisplay *disp,
 114                               _EGLContext *ctx, EGLenum target,
 115                               EGLClientBuffer buffer,
 116                               const EGLint *attr_list);
 117
 118    EGLBoolean (*swap_buffers)(_EGLDriver *drv, _EGLDisplay *disp,
 119                               _EGLSurface *surf);
 120
 121    EGLBoolean (*swap_buffers_with_damage)(_EGLDriver *drv, _EGLDisplay *disp,
 122                                           _EGLSurface *surface,
 123                                           const EGLint *rects, EGLint n_rects);
 124
 125    EGLBoolean (*swap_buffers_region)(_EGLDriver *drv, _EGLDisplay *disp,
 126                                      _EGLSurface *surf, EGLint numRects,
 127                                      const EGLint *rects);
 128
 129    EGLBoolean (*post_sub_buffer)(_EGLDriver *drv, _EGLDisplay *disp,
 130                                  _EGLSurface *surf,
 131                                  EGLint x, EGLint y,
 132                                  EGLint width, EGLint height);
 133
 134    EGLBoolean (*copy_buffers)(_EGLDriver *drv, _EGLDisplay *disp,
 135                               _EGLSurface *surf, void *native_pixmap_target);
 136
 137    EGLint (*query_buffer_age)(_EGLDriver *drv, _EGLDisplay *disp,
 138                               _EGLSurface *surf);
 139
 140    EGLBoolean (*query_surface)(_EGLDriver *drv, _EGLDisplay *disp,
 141                                _EGLSurface *surf, EGLint attribute,
 142                                EGLint *value);
 143
 144    struct wl_buffer* (*create_wayland_buffer_from_image)(
 145                         _EGLDriver *drv, _EGLDisplay *disp, _EGLImage *img);
 146
 147    EGLBoolean (*get_sync_values)(_EGLDisplay *display, _EGLSurface *surface,
 148                                  EGLuint64KHR *ust, EGLuint64KHR *msc,
 149                                  EGLuint64KHR *sbc);
 150
 151    __DRIdrawable *(*get_dri_drawable)(_EGLSurface *surf);
 152
 153    void (*close_screen_notify)(_EGLDisplay *disp);
 154
 155    /* Used in EGL_KHR_mutable_render_buffer to update the native window's
 156     * shared buffer mode.
 157     */
 158    bool (*set_shared_buffer_mode)(_EGLDisplay *disp, _EGLSurface *surf,
 159                                   bool mode);
 160 };
 161
 162 struct dri2_egl_display
 163 {
 164    const struct dri2_egl_display_vtbl *vtbl;
 165
 166    int                       dri2_major;
 167    int                       dri2_minor;
 168    __DRIscreen              *dri_screen;
 169    bool                      own_dri_screen;
 170    const __DRIconfig       **driver_configs;
 171    void                     *driver;
 172    const __DRIcoreExtension       *core;
 173    const __DRIimageDriverExtension *image_driver;
 174    const __DRIdri2Extension       *dri2;
 175    const __DRIswrastExtension     *swrast;
 176    const __DRI2flushExtension     *flush;
 177    const __DRI2flushControlExtension *flush_control;
 178    const __DRItexBufferExtension  *tex_buffer;
 179    const __DRIimageExtension      *image;
 180    const __DRIrobustnessExtension *robustness;
 181    const __DRInoErrorExtension    *no_error;
 182    const __DRI2configQueryExtension *config;
 183    const __DRI2fenceExtension *fence;
 184    const __DRI2bufferDamageExtension *buffer_damage;
 185    const __DRI2blobExtension *blob;
 186    const __DRI2rendererQueryExtension *rendererQuery;
 187    const __DRI2interopExtension *interop;
 188    const __DRIconfigOptionsExtension *configOptions;
 189    const __DRImutableRenderBufferDriverExtension *mutable_render_buffer;
 190    int                       fd;
 191
 192    /* dri2_initialize/dri2_terminate increment/decrement this count, so does
 193     * dri2_make_current (tracks if there are active contexts/surfaces). */
 194    int                       ref_count;
 195
 196    bool                      own_device;
 197    bool                      invalidate_available;
 198    int                       min_swap_interval;
 199    int                       max_swap_interval;
 200    int                       default_swap_interval;
 201 #ifdef HAVE_DRM_PLATFORM
 202    struct gbm_dri_device    *gbm_dri;
 203 #endif
 204
 205    char                     *driver_name;
 206
 207    const __DRIextension    **loader_extensions;
 208    const __DRIextension    **driver_extensions;
 209
 210 #ifdef HAVE_X11_PLATFORM
 211    xcb_connection_t         *conn;
 212    xcb_screen_t             *screen;
 213    bool                     swap_available;
 214 #ifdef HAVE_DRI3
 215    bool                     multibuffers_available;
 216    int                      dri3_major_version;
 217    int                      dri3_minor_version;
 218    int                      present_major_version;
 219    int                      present_minor_version;
 220    struct loader_dri3_extensions loader_dri3_ext;
 221 #endif
 222 #endif
 223
 224 #ifdef HAVE_WAYLAND_PLATFORM
 225    struct wl_display        *wl_dpy;
 226    struct wl_display        *wl_dpy_wrapper;
 227    struct wl_registry       *wl_registry;
 228    struct wl_drm            *wl_server_drm;
 229    struct wl_drm            *wl_drm;
 230    struct wl_shm            *wl_shm;
 231    struct wl_event_queue    *wl_queue;
 232    struct zwp_linux_dmabuf_v1 *wl_dmabuf;
 233    struct u_vector          *wl_modifiers;
 234    bool                      authenticated;
 235    BITSET_DECLARE(formats, EGL_DRI2_MAX_FORMATS);
 236    uint32_t                  capabilities;
 237    char                     *device_name;
 238 #endif
 239
 240 #ifdef HAVE_ANDROID_PLATFORM
 241    const gralloc_module_t *gralloc;
 242 #endif
 243
 244    bool                      is_render_node;
 245    bool                      is_different_gpu;
 246 };
 247
 248 struct dri2_egl_context
 249 {
 250    _EGLContext   base;
 251    __DRIcontext *dri_context;
 252 };
 253
 254 #ifdef HAVE_WAYLAND_PLATFORM
 255 enum wayland_buffer_type {
 256    WL_BUFFER_FRONT,
 257    WL_BUFFER_BACK,
 258    WL_BUFFER_THIRD,
 259    WL_BUFFER_COUNT
 260 };
 261 #endif
 262
 263 struct dri2_egl_surface
 264 {
 265    _EGLSurface          base;
 266    __DRIdrawable       *dri_drawable;
 267    __DRIbuffer          buffers[5];
 268    bool                 have_fake_front;
 269
 270 #ifdef HAVE_X11_PLATFORM
 271    xcb_drawable_t       drawable;
 272    xcb_xfixes_region_t  region;
 273    int                  depth;
 274    int                  bytes_per_pixel;
 275    xcb_gcontext_t       gc;
 276    xcb_gcontext_t       swapgc;
 277 #endif
 278
 279 #ifdef HAVE_WAYLAND_PLATFORM
 280    struct wl_egl_window  *wl_win;
 281    int                    dx;
 282    int                    dy;
 283    struct wl_event_queue *wl_queue;
 284    struct wl_surface     *wl_surface_wrapper;
 285    struct wl_display     *wl_dpy_wrapper;
 286    struct wl_drm         *wl_drm_wrapper;
 287    struct wl_callback    *throttle_callback;
 288    int                    format;
 289 #endif
 290
 291 #ifdef HAVE_DRM_PLATFORM
 292    struct gbm_dri_surface *gbm_surf;
 293 #endif
 294
 295    /* EGL-owned buffers */
 296    __DRIbuffer           *local_buffers[__DRI_BUFFER_COUNT];
 297
 298 #if defined(HAVE_WAYLAND_PLATFORM) || defined(HAVE_DRM_PLATFORM)
 299    struct {
 300 #ifdef HAVE_WAYLAND_PLATFORM
 301       struct wl_buffer   *wl_buffer;
 302       bool                wl_release;
 303       __DRIimage         *dri_image;
 304       /* for is_different_gpu case. NULL else */
 305       __DRIimage         *linear_copy;
 306       /* for swrast */
 307       void *data;
 308       int data_size;
 309 #endif
 310 #ifdef HAVE_DRM_PLATFORM
 311       struct gbm_bo       *bo;
 312 #endif
 313       bool                locked;
 314       int                 age;
 315    } color_buffers[4], *back, *current;
 316 #endif
 317
 318 #ifdef HAVE_ANDROID_PLATFORM
 319    struct ANativeWindow *window;
 320    struct ANativeWindowBuffer *buffer;
 321    __DRIimage *dri_image_back;
 322    __DRIimage *dri_image_front;
 323
 324    /* Used to record all the buffers created by ANativeWindow and their ages.
 325     * Allocate number of color_buffers based on query to android bufferqueue
 326     * and save color_buffers_count.
 327     */
 328    int color_buffers_count;
 329    struct {
 330       struct ANativeWindowBuffer *buffer;
 331       int age;
 332    } *color_buffers, *back;
 333 #endif
 334
 335    /* surfaceless and device */
 336    __DRIimage           *front;
 337    unsigned int         visual;
 338
 339    int out_fence_fd;
 340    EGLBoolean enable_out_fence;
 341 };
 342
 343 struct dri2_egl_config
 344 {
 345    _EGLConfig         base;
 346    const __DRIconfig *dri_config[2][2];
 347 };
 348
 349 struct dri2_egl_image
 350 {
 351    _EGLImage   base;
 352    __DRIimage *dri_image;
 353 };
 354
 355 struct dri2_egl_sync {
 356    _EGLSync base;
 357    mtx_t mutex;
 358    cnd_t cond;
 359    int refcount;
 360    void *fence;
 361 };
 362
 363 /* From xmlpool/options.h, user exposed so should be stable */
 364 #define DRI_CONF_VBLANK_NEVER 0
 365 #define DRI_CONF_VBLANK_DEF_INTERVAL_0 1
 366 #define DRI_CONF_VBLANK_DEF_INTERVAL_1 2
 367 #define DRI_CONF_VBLANK_ALWAYS_SYNC 3
 368
 369 /* standard typecasts */
 370 _EGL_DRIVER_STANDARD_TYPECASTS(dri2_egl)
 371 _EGL_DRIVER_TYPECAST(dri2_egl_image, _EGLImage, obj)
 372 _EGL_DRIVER_TYPECAST(dri2_egl_sync, _EGLSync, obj)
 373
 374 extern const __DRIimageLookupExtension image_lookup_extension;
 375 extern const __DRIuseInvalidateExtension use_invalidate;
 376 extern const __DRIbackgroundCallableExtension background_callable_extension;
 377 extern const __DRIswrastLoaderExtension swrast_pbuffer_loader_extension;
 378
 379 EGLBoolean
 380 dri2_load_driver(_EGLDisplay *disp);
 381
 382 /* Helper for platforms not using dri2_create_screen */
 383 void
 384 dri2_setup_screen(_EGLDisplay *disp);
 385
 386 void
 387 dri2_setup_swap_interval(_EGLDisplay *disp, int max_swap_interval);
 388
 389 EGLBoolean
 390 dri2_load_driver_swrast(_EGLDisplay *disp);
 391
 392 EGLBoolean
 393 dri2_load_driver_dri3(_EGLDisplay *disp);
 394
 395 EGLBoolean
 396 dri2_create_screen(_EGLDisplay *disp);
 397
 398 EGLBoolean
 399 dri2_setup_extensions(_EGLDisplay *disp);
 400
 401 __DRIdrawable *
 402 dri2_surface_get_dri_drawable(_EGLSurface *surf);
 403
 404 __DRIimage *
 405 dri2_lookup_egl_image(__DRIscreen *screen, void *image, void *data);
 406
 407 void
 408 dri2_get_shifts_and_sizes(const __DRIcoreExtension *core,
 409                           const __DRIconfig *config, int *shifts,
 410                           unsigned int *sizes);
 411
 412 struct dri2_egl_config *
 413 dri2_add_config(_EGLDisplay *disp, const __DRIconfig *dri_config, int id,
 414                 EGLint surface_type, const EGLint *attr_list,
 415                 const int *rgba_shifts, const unsigned int *rgba_sizes);
 416
 417 _EGLImage *
 418 dri2_create_image_khr(_EGLDriver *drv, _EGLDisplay *disp,
 419                       _EGLContext *ctx, EGLenum target,
 420                       EGLClientBuffer buffer, const EGLint *attr_list);
 421
 422 _EGLImage *
 423 dri2_create_image_dma_buf(_EGLDisplay *disp, _EGLContext *ctx,
 424                           EGLClientBuffer buffer, const EGLint *attr_list);
 425
 426 #ifdef HAVE_X11_PLATFORM
 427 EGLBoolean
 428 dri2_initialize_x11(_EGLDriver *drv, _EGLDisplay *disp);
 429 void
 430 dri2_teardown_x11(struct dri2_egl_display *dri2_dpy);
 431 unsigned int
 432 dri2_x11_get_red_mask_for_depth(struct dri2_egl_display *dri2_dpy, int depth);
 433 #else
 434 static inline EGLBoolean
 435 dri2_initialize_x11(_EGLDriver *drv, _EGLDisplay *disp)
 436 {
 437    return _eglError(EGL_NOT_INITIALIZED, "X11 platform not built");
 438 }
 439 static inline void
 440 dri2_teardown_x11(struct dri2_egl_display *dri2_dpy) {}
 441 static inline unsigned int
 442 dri2_x11_get_red_mask_for_depth(struct dri2_egl_display *dri2_dpy, int depth)
 443 {
 444    return 0;
 445 }
 446 #endif
 447
 448 #ifdef HAVE_DRM_PLATFORM
 449 EGLBoolean
 450 dri2_initialize_drm(_EGLDriver *drv, _EGLDisplay *disp);
 451 void
 452 dri2_teardown_drm(struct dri2_egl_display *dri2_dpy);
 453 #else
 454 static inline EGLBoolean
 455 dri2_initialize_drm(_EGLDriver *drv, _EGLDisplay *disp)
 456 {
 457    return _eglError(EGL_NOT_INITIALIZED, "GBM/DRM platform not built");
 458 }
 459 static inline void
 460 dri2_teardown_drm(struct dri2_egl_display *dri2_dpy) {}
 461 #endif
 462
 463 #ifdef HAVE_WAYLAND_PLATFORM
 464 EGLBoolean
 465 dri2_initialize_wayland(_EGLDriver *drv, _EGLDisplay *disp);
 466 void
 467 dri2_teardown_wayland(struct dri2_egl_display *dri2_dpy);
 468 bool
 469 dri2_wl_is_format_supported(void* user_data, uint32_t format);
 470 #else
 471 static inline EGLBoolean
 472 dri2_initialize_wayland(_EGLDriver *drv, _EGLDisplay *disp)
 473 {
 474    return _eglError(EGL_NOT_INITIALIZED, "Wayland platform not built");
 475 }
 476 static inline void
 477 dri2_teardown_wayland(struct dri2_egl_display *dri2_dpy) {}
 478 #endif
 479
 480 #ifdef HAVE_ANDROID_PLATFORM
 481 EGLBoolean
 482 dri2_initialize_android(_EGLDriver *drv, _EGLDisplay *disp);
 483 #else
 484 static inline EGLBoolean
 485 dri2_initialize_android(_EGLDriver *drv, _EGLDisplay *disp)
 486 {
 487    return _eglError(EGL_NOT_INITIALIZED, "Android platform not built");
 488 }
 489 #endif
 490
 491 #ifdef HAVE_SURFACELESS_PLATFORM
 492 EGLBoolean
 493 dri2_initialize_surfaceless(_EGLDriver *drv, _EGLDisplay *disp);
 494 #else
 495 static inline EGLBoolean
 496 dri2_initialize_surfaceless(_EGLDriver *drv, _EGLDisplay *disp)
 497 {
 498    return _eglError(EGL_NOT_INITIALIZED, "Surfaceless platform not built");
 499 }
 500 #endif
 501
 502 EGLBoolean
 503 dri2_initialize_device(_EGLDriver *drv, _EGLDisplay *disp);
 504 static inline void
 505 dri2_teardown_device(struct dri2_egl_display *dri2_dpy) { /* noop */ }
 506
 507 void
 508 dri2_flush_drawable_for_swapbuffers(_EGLDisplay *disp, _EGLSurface *draw);
 509
 510 const __DRIconfig *
 511 dri2_get_dri_config(struct dri2_egl_config *conf, EGLint surface_type,
 512                     EGLenum colorspace);
 513
 514 static inline void
 515 dri2_set_WL_bind_wayland_display(_EGLDriver *drv, _EGLDisplay *disp)
 516 {
 517 #ifdef HAVE_WAYLAND_PLATFORM
 518    struct dri2_egl_display *dri2_dpy = dri2_egl_display(disp);
 519
 520    (void) drv;
 521
 522    if (dri2_dpy->device_name && dri2_dpy->image) {
 523        if (dri2_dpy->image->base.version >= 10 &&
 524            dri2_dpy->image->getCapabilities != NULL) {
 525            int capabilities;
 526
 527            capabilities =
 528                dri2_dpy->image->getCapabilities(dri2_dpy->dri_screen);
 529            disp->Extensions.WL_bind_wayland_display =
 530                (capabilities & __DRI_IMAGE_CAP_GLOBAL_NAMES) != 0;
 531        } else {
 532            disp->Extensions.WL_bind_wayland_display = EGL_TRUE;
 533        }
 534    }
 535 #endif
 536 }
 537
 538 void
 539 dri2_display_destroy(_EGLDisplay *disp);
 540
 541 __DRIbuffer *
 542 dri2_egl_surface_alloc_local_buffer(struct dri2_egl_surface *dri2_surf,
 543                                     unsigned int att, unsigned int format);
 544
 545 void
 546 dri2_egl_surface_free_local_buffers(struct dri2_egl_surface *dri2_surf);
 547
 548 EGLBoolean
 549 dri2_init_surface(_EGLSurface *surf, _EGLDisplay *disp, EGLint type,
 550         _EGLConfig *conf, const EGLint *attrib_list,
 551         EGLBoolean enable_out_fence, void *native_surface);
 552
 553 void
 554 dri2_fini_surface(_EGLSurface *surf);
 555
 556 EGLBoolean
 557 dri2_create_drawable(struct dri2_egl_display *dri2_dpy,
 558                      const __DRIconfig *config,
 559                      struct dri2_egl_surface *dri2_surf,
 560                      void *loaderPrivate);
 561
 562 static inline uint64_t
 563 combine_u32_into_u64(uint32_t hi, uint32_t lo)
 564 {
 565    return (((uint64_t) hi) << 32) | (((uint64_t) lo) & 0xffffffff);
 566 }
 567
 568 #endif /* EGL_DRI2_INCLUDED */