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