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