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