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