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