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