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