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