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