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