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