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 #include <wayland-client.h>
  47 #include "wayland/wayland-egl/wayland-egl-backend.h"
  48 /* forward declarations of protocol elements */
  49 struct zwp_linux_dmabuf_v1;
  50 #endif
  51
  52 #include <GL/gl.h>
  53 #include <GL/internal/dri_interface.h>
  54
  55 #ifdef HAVE_DRM_PLATFORM
  56 #include <gbm_driint.h>
  57 #endif
  58
  59 #ifdef HAVE_ANDROID_PLATFORM
  60 #define LOG_TAG "EGL-DRI2"
  61
  62 #include <system/window.h>
  63 #include <hardware/gralloc.h>
  64 #include <gralloc_drm_handle.h>
  65
  66 #endif /* HAVE_ANDROID_PLATFORM */
  67
  68 #include "eglconfig.h"
  69 #include "eglcontext.h"
  70 #include "egldisplay.h"
  71 #include "egldriver.h"
  72 #include "eglcurrent.h"
  73 #include "egllog.h"
  74 #include "eglsurface.h"
  75 #include "eglimage.h"
  76 #include "eglsync.h"
  77
  78 #include "util/u_vector.h"
  79
  80 struct wl_buffer;
  81
  82 struct dri2_egl_display_vtbl {
  83    int (*authenticate)(_EGLDisplay *disp, uint32_t id);
  84
  85    _EGLSurface* (*create_window_surface)(_EGLDriver *drv, _EGLDisplay *dpy,
  86                                          _EGLConfig *config,
  87                                          void *native_window,
  88                                          const EGLint *attrib_list);
  89
  90    _EGLSurface* (*create_pixmap_surface)(_EGLDriver *drv, _EGLDisplay *dpy,
  91                                          _EGLConfig *config,
  92                                          void *native_pixmap,
  93                                          const EGLint *attrib_list);
  94
  95    _EGLSurface* (*create_pbuffer_surface)(_EGLDriver *drv, _EGLDisplay *dpy,
  96                                           _EGLConfig *config,
  97                                           const EGLint *attrib_list);
  98
  99    EGLBoolean (*destroy_surface)(_EGLDriver *drv, _EGLDisplay *dpy,
 100                                  _EGLSurface *surface);
 101
 102    EGLBoolean (*swap_interval)(_EGLDriver *drv, _EGLDisplay *dpy,
 103                                _EGLSurface *surf, EGLint interval);
 104
 105    _EGLImage* (*create_image)(_EGLDriver *drv, _EGLDisplay *dpy,
 106                               _EGLContext *ctx, EGLenum target,
 107                               EGLClientBuffer buffer,
 108                               const EGLint *attr_list);
 109
 110    EGLBoolean (*swap_buffers)(_EGLDriver *drv, _EGLDisplay *dpy,
 111                               _EGLSurface *surf);
 112
 113    EGLBoolean (*swap_buffers_with_damage)(_EGLDriver *drv, _EGLDisplay *dpy,
 114                                           _EGLSurface *surface,
 115                                           const EGLint *rects, EGLint n_rects);
 116
 117    EGLBoolean (*set_damage_region)(_EGLDriver *drv, _EGLDisplay *dpy,
 118                                    _EGLSurface *surface,
 119                                    const EGLint *rects, EGLint n_rects);
 120
 121    EGLBoolean (*swap_buffers_region)(_EGLDriver *drv, _EGLDisplay *dpy,
 122                                      _EGLSurface *surf, EGLint numRects,
 123                                      const EGLint *rects);
 124
 125    EGLBoolean (*post_sub_buffer)(_EGLDriver *drv, _EGLDisplay *dpy,
 126                                  _EGLSurface *surf,
 127                                  EGLint x, EGLint y,
 128                                  EGLint width, EGLint height);
 129
 130    EGLBoolean (*copy_buffers)(_EGLDriver *drv, _EGLDisplay *dpy,
 131                               _EGLSurface *surf, void *native_pixmap_target);
 132
 133    EGLint (*query_buffer_age)(_EGLDriver *drv, _EGLDisplay *dpy,
 134                               _EGLSurface *surf);
 135
 136    EGLBoolean (*query_surface)(_EGLDriver *drv, _EGLDisplay *dpy,
 137                                _EGLSurface *surf, EGLint attribute,
 138                                EGLint *value);
 139
 140    struct wl_buffer* (*create_wayland_buffer_from_image)(
 141                         _EGLDriver *drv, _EGLDisplay *dpy, _EGLImage *img);
 142
 143    EGLBoolean (*get_sync_values)(_EGLDisplay *display, _EGLSurface *surface,
 144                                  EGLuint64KHR *ust, EGLuint64KHR *msc,
 145                                  EGLuint64KHR *sbc);
 146
 147    __DRIdrawable *(*get_dri_drawable)(_EGLSurface *surf);
 148
 149    void (*close_screen_notify)(_EGLDisplay *dpy);
 150 };
 151
 152 struct dri2_egl_display
 153 {
 154    const struct dri2_egl_display_vtbl *vtbl;
 155
 156    int                       dri2_major;
 157    int                       dri2_minor;
 158    __DRIscreen              *dri_screen;
 159    bool                      own_dri_screen;
 160    const __DRIconfig       **driver_configs;
 161    void                     *driver;
 162    const __DRIcoreExtension       *core;
 163    const __DRIimageDriverExtension *image_driver;
 164    const __DRIdri2Extension       *dri2;
 165    const __DRIswrastExtension     *swrast;
 166    const __DRI2flushExtension     *flush;
 167    const __DRI2flushControlExtension *flush_control;
 168    const __DRItexBufferExtension  *tex_buffer;
 169    const __DRIimageExtension      *image;
 170    const __DRIrobustnessExtension *robustness;
 171    const __DRInoErrorExtension    *no_error;
 172    const __DRI2configQueryExtension *config;
 173    const __DRI2fenceExtension *fence;
 174    const __DRI2blobExtension *blob;
 175    const __DRI2rendererQueryExtension *rendererQuery;
 176    const __DRI2interopExtension *interop;
 177    int                       fd;
 178
 179    /* dri2_initialize/dri2_terminate increment/decrement this count, so does
 180     * dri2_make_current (tracks if there are active contexts/surfaces). */
 181    int                       ref_count;
 182
 183    bool                      own_device;
 184    bool                      invalidate_available;
 185    int                       min_swap_interval;
 186    int                       max_swap_interval;
 187    int                       default_swap_interval;
 188 #ifdef HAVE_DRM_PLATFORM
 189    struct gbm_dri_device    *gbm_dri;
 190 #endif
 191
 192    char                     *driver_name;
 193
 194    const __DRIextension    **loader_extensions;
 195    const __DRIextension    **driver_extensions;
 196
 197 #ifdef HAVE_X11_PLATFORM
 198    xcb_connection_t         *conn;
 199    xcb_screen_t             *screen;
 200    bool                     swap_available;
 201 #ifdef HAVE_DRI3
 202    bool                     multibuffers_available;
 203    int                      dri3_major_version;
 204    int                      dri3_minor_version;
 205    int                      present_major_version;
 206    int                      present_minor_version;
 207    struct loader_dri3_extensions loader_dri3_ext;
 208 #endif
 209 #endif
 210
 211 #ifdef HAVE_WAYLAND_PLATFORM
 212    struct wl_display        *wl_dpy;
 213    struct wl_display        *wl_dpy_wrapper;
 214    struct wl_registry       *wl_registry;
 215    struct wl_drm            *wl_server_drm;
 216    struct wl_drm            *wl_drm;
 217    struct wl_shm            *wl_shm;
 218    struct wl_event_queue    *wl_queue;
 219    struct zwp_linux_dmabuf_v1 *wl_dmabuf;
 220    struct u_vector          *wl_modifiers;
 221    bool                      authenticated;
 222    int                       formats;
 223    uint32_t                  capabilities;
 224    char                     *device_name;
 225 #endif
 226
 227 #ifdef HAVE_ANDROID_PLATFORM
 228    const gralloc_module_t *gralloc;
 229 #endif
 230
 231    bool                      is_render_node;
 232    bool                      is_different_gpu;
 233 };
 234
 235 struct dri2_egl_context
 236 {
 237    _EGLContext   base;
 238    __DRIcontext *dri_context;
 239 };
 240
 241 #ifdef HAVE_WAYLAND_PLATFORM
 242 enum wayland_buffer_type {
 243    WL_BUFFER_FRONT,
 244    WL_BUFFER_BACK,
 245    WL_BUFFER_THIRD,
 246    WL_BUFFER_COUNT
 247 };
 248 #endif
 249
 250 struct dri2_egl_surface
 251 {
 252    _EGLSurface          base;
 253    __DRIdrawable       *dri_drawable;
 254    __DRIbuffer          buffers[5];
 255    bool                 have_fake_front;
 256
 257 #ifdef HAVE_X11_PLATFORM
 258    xcb_drawable_t       drawable;
 259    xcb_xfixes_region_t  region;
 260    int                  depth;
 261    int                  bytes_per_pixel;
 262    xcb_gcontext_t       gc;
 263    xcb_gcontext_t       swapgc;
 264 #endif
 265
 266 #ifdef HAVE_WAYLAND_PLATFORM
 267    struct wl_egl_window  *wl_win;
 268    int                    dx;
 269    int                    dy;
 270    struct wl_event_queue *wl_queue;
 271    struct wl_surface     *wl_surface_wrapper;
 272    struct wl_display     *wl_dpy_wrapper;
 273    struct wl_drm         *wl_drm_wrapper;
 274    struct wl_callback    *throttle_callback;
 275    int                    format;
 276 #endif
 277
 278 #ifdef HAVE_DRM_PLATFORM
 279    struct gbm_dri_surface *gbm_surf;
 280 #endif
 281
 282    /* EGL-owned buffers */
 283    __DRIbuffer           *local_buffers[__DRI_BUFFER_COUNT];
 284
 285 #if defined(HAVE_WAYLAND_PLATFORM) || defined(HAVE_DRM_PLATFORM)
 286    struct {
 287 #ifdef HAVE_WAYLAND_PLATFORM
 288       struct wl_buffer   *wl_buffer;
 289       __DRIimage         *dri_image;
 290       /* for is_different_gpu case. NULL else */
 291       __DRIimage         *linear_copy;
 292       /* for swrast */
 293       void *data;
 294       int data_size;
 295 #endif
 296 #ifdef HAVE_DRM_PLATFORM
 297       struct gbm_bo       *bo;
 298 #endif
 299       bool                locked;
 300       int                 age;
 301    } color_buffers[4], *back, *current;
 302 #endif
 303
 304 #ifdef HAVE_ANDROID_PLATFORM
 305    struct ANativeWindow *window;
 306    struct ANativeWindowBuffer *buffer;
 307    __DRIimage *dri_image_back;
 308    __DRIimage *dri_image_front;
 309
 310    /* Used to record all the buffers created by ANativeWindow and their ages.
 311     * Usually Android uses at most triple buffers in ANativeWindow
 312     * so hardcode the number of color_buffers to 3.
 313     */
 314    struct {
 315       struct ANativeWindowBuffer *buffer;
 316       int age;
 317    } color_buffers[3], *back;
 318 #endif
 319
 320 #if defined(HAVE_SURFACELESS_PLATFORM)
 321       __DRIimage           *front;
 322       unsigned int         visual;
 323 #endif
 324    int out_fence_fd;
 325    EGLBoolean enable_out_fence;
 326 };
 327
 328 struct dri2_egl_config
 329 {
 330    _EGLConfig         base;
 331    const __DRIconfig *dri_config[2][2];
 332 };
 333
 334 struct dri2_egl_image
 335 {
 336    _EGLImage   base;
 337    __DRIimage *dri_image;
 338 };
 339
 340 struct dri2_egl_sync {
 341    _EGLSync base;
 342    mtx_t mutex;
 343    cnd_t cond;
 344    int refcount;
 345    void *fence;
 346 };
 347
 348 /* From xmlpool/options.h, user exposed so should be stable */
 349 #define DRI_CONF_VBLANK_NEVER 0
 350 #define DRI_CONF_VBLANK_DEF_INTERVAL_0 1
 351 #define DRI_CONF_VBLANK_DEF_INTERVAL_1 2
 352 #define DRI_CONF_VBLANK_ALWAYS_SYNC 3
 353
 354 /* standard typecasts */
 355 _EGL_DRIVER_STANDARD_TYPECASTS(dri2_egl)
 356 _EGL_DRIVER_TYPECAST(dri2_egl_image, _EGLImage, obj)
 357 _EGL_DRIVER_TYPECAST(dri2_egl_sync, _EGLSync, obj)
 358
 359 extern const __DRIimageLookupExtension image_lookup_extension;
 360 extern const __DRIuseInvalidateExtension use_invalidate;
 361 extern const __DRIbackgroundCallableExtension background_callable_extension;
 362
 363 EGLBoolean
 364 dri2_load_driver(_EGLDisplay *disp);
 365
 366 /* Helper for platforms not using dri2_create_screen */
 367 void
 368 dri2_setup_screen(_EGLDisplay *disp);
 369
 370 void
 371 dri2_setup_swap_interval(_EGLDisplay *disp, int max_swap_interval);
 372
 373 EGLBoolean
 374 dri2_load_driver_swrast(_EGLDisplay *disp);
 375
 376 EGLBoolean
 377 dri2_load_driver_dri3(_EGLDisplay *disp);
 378
 379 EGLBoolean
 380 dri2_create_screen(_EGLDisplay *disp);
 381
 382 EGLBoolean
 383 dri2_setup_extensions(_EGLDisplay *disp);
 384
 385 __DRIdrawable *
 386 dri2_surface_get_dri_drawable(_EGLSurface *surf);
 387
 388 __DRIimage *
 389 dri2_lookup_egl_image(__DRIscreen *screen, void *image, void *data);
 390
 391 struct dri2_egl_config *
 392 dri2_add_config(_EGLDisplay *disp, const __DRIconfig *dri_config, int id,
 393                 EGLint surface_type, const EGLint *attr_list,
 394                 const unsigned int *rgba_masks);
 395
 396 _EGLImage *
 397 dri2_create_image_khr(_EGLDriver *drv, _EGLDisplay *disp,
 398                       _EGLContext *ctx, EGLenum target,
 399                       EGLClientBuffer buffer, const EGLint *attr_list);
 400
 401 _EGLImage *
 402 dri2_create_image_dma_buf(_EGLDisplay *disp, _EGLContext *ctx,
 403                           EGLClientBuffer buffer, const EGLint *attr_list);
 404
 405 #ifdef HAVE_X11_PLATFORM
 406 EGLBoolean
 407 dri2_initialize_x11(_EGLDriver *drv, _EGLDisplay *disp);
 408 void
 409 dri2_teardown_x11(struct dri2_egl_display *dri2_dpy);
 410 #else
 411 static inline EGLBoolean
 412 dri2_initialize_x11(_EGLDriver *drv, _EGLDisplay *disp)
 413 {
 414    return _eglError(EGL_NOT_INITIALIZED, "X11 platform not built");
 415 }
 416 static inline void
 417 dri2_teardown_x11(struct dri2_egl_display *dri2_dpy) {}
 418 #endif
 419
 420 #ifdef HAVE_DRM_PLATFORM
 421 EGLBoolean
 422 dri2_initialize_drm(_EGLDriver *drv, _EGLDisplay *disp);
 423 void
 424 dri2_teardown_drm(struct dri2_egl_display *dri2_dpy);
 425 #else
 426 static inline EGLBoolean
 427 dri2_initialize_drm(_EGLDriver *drv, _EGLDisplay *disp)
 428 {
 429    return _eglError(EGL_NOT_INITIALIZED, "GBM/DRM platform not built");
 430 }
 431 static inline void
 432 dri2_teardown_drm(struct dri2_egl_display *dri2_dpy) {}
 433 #endif
 434
 435 #ifdef HAVE_WAYLAND_PLATFORM
 436 EGLBoolean
 437 dri2_initialize_wayland(_EGLDriver *drv, _EGLDisplay *disp);
 438 void
 439 dri2_teardown_wayland(struct dri2_egl_display *dri2_dpy);
 440 #else
 441 static inline EGLBoolean
 442 dri2_initialize_wayland(_EGLDriver *drv, _EGLDisplay *disp)
 443 {
 444    return _eglError(EGL_NOT_INITIALIZED, "Wayland platform not built");
 445 }
 446 static inline void
 447 dri2_teardown_wayland(struct dri2_egl_display *dri2_dpy) {}
 448 #endif
 449
 450 #ifdef HAVE_ANDROID_PLATFORM
 451 EGLBoolean
 452 dri2_initialize_android(_EGLDriver *drv, _EGLDisplay *disp);
 453 #else
 454 static inline EGLBoolean
 455 dri2_initialize_android(_EGLDriver *drv, _EGLDisplay *disp)
 456 {
 457    return _eglError(EGL_NOT_INITIALIZED, "Android platform not built");
 458 }
 459 #endif
 460
 461 #ifdef HAVE_SURFACELESS_PLATFORM
 462 EGLBoolean
 463 dri2_initialize_surfaceless(_EGLDriver *drv, _EGLDisplay *disp);
 464 #else
 465 static inline EGLBoolean
 466 dri2_initialize_surfaceless(_EGLDriver *drv, _EGLDisplay *disp)
 467 {
 468    return _eglError(EGL_NOT_INITIALIZED, "Surfaceless platform not built");
 469 }
 470 #endif
 471
 472 void
 473 dri2_flush_drawable_for_swapbuffers(_EGLDisplay *disp, _EGLSurface *draw);
 474
 475 const __DRIconfig *
 476 dri2_get_dri_config(struct dri2_egl_config *conf, EGLint surface_type,
 477                     EGLenum colorspace);
 478
 479 static inline void
 480 dri2_set_WL_bind_wayland_display(_EGLDriver *drv, _EGLDisplay *disp)
 481 {
 482 #ifdef HAVE_WAYLAND_PLATFORM
 483    struct dri2_egl_display *dri2_dpy = dri2_egl_display(disp);
 484
 485    (void) drv;
 486
 487    if (dri2_dpy->device_name && dri2_dpy->image) {
 488        if (dri2_dpy->image->base.version >= 10 &&
 489            dri2_dpy->image->getCapabilities != NULL) {
 490            int capabilities;
 491
 492            capabilities =
 493                dri2_dpy->image->getCapabilities(dri2_dpy->dri_screen);
 494            disp->Extensions.WL_bind_wayland_display =
 495                (capabilities & __DRI_IMAGE_CAP_GLOBAL_NAMES) != 0;
 496        } else {
 497            disp->Extensions.WL_bind_wayland_display = EGL_TRUE;
 498        }
 499    }
 500 #endif
 501 }
 502
 503 void
 504 dri2_display_destroy(_EGLDisplay *disp);
 505
 506 __DRIbuffer *
 507 dri2_egl_surface_alloc_local_buffer(struct dri2_egl_surface *dri2_surf,
 508                                     unsigned int att, unsigned int format);
 509
 510 void
 511 dri2_egl_surface_free_local_buffers(struct dri2_egl_surface *dri2_surf);
 512
 513 EGLBoolean
 514 dri2_init_surface(_EGLSurface *surf, _EGLDisplay *dpy, EGLint type,
 515         _EGLConfig *conf, const EGLint *attrib_list, EGLBoolean enable_out_fence);
 516
 517 void
 518 dri2_fini_surface(_EGLSurface *surf);
 519
 520 #endif /* EGL_DRI2_INCLUDED */