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