src/loader/loader_dri3_helper.h

   1 /*
   2  * Copyright © 2013 Keith Packard
   3  * Copyright © 2015 Boyan Ding
   4  *
   5  * Permission to use, copy, modify, distribute, and sell this software and its
   6  * documentation for any purpose is hereby granted without fee, provided that
   7  * the above copyright notice appear in all copies and that both that copyright
   8  * notice and this permission notice appear in supporting documentation, and
   9  * that the name of the copyright holders not be used in advertising or
  10  * publicity pertaining to distribution of the software without specific,
  11  * written prior permission.  The copyright holders make no representations
  12  * about the suitability of this software for any purpose.  It is provided "as
  13  * is" without express or implied warranty.
  14  *
  15  * THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
  16  * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
  17  * EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY SPECIAL, INDIRECT OR
  18  * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
  19  * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
  20  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
  21  * OF THIS SOFTWARE.
  22  */
  23
  24 #ifndef LOADER_DRI3_HEADER_H
  25 #define LOADER_DRI3_HEADER_H
  26
  27 #include <stdbool.h>
  28 #include <stdint.h>
  29
  30 #include <xcb/xcb.h>
  31 #include <xcb/dri3.h>
  32 #include <xcb/present.h>
  33
  34 #include <GL/gl.h>
  35 #include <GL/internal/dri_interface.h>
  36 #include <c11/threads.h>
  37
  38 enum loader_dri3_buffer_type {
  39    loader_dri3_buffer_back = 0,
  40    loader_dri3_buffer_front = 1
  41 };
  42
  43 struct loader_dri3_buffer {
  44    __DRIimage   *image;
  45    __DRIimage   *linear_buffer;
  46    uint32_t     pixmap;
  47
  48    /* Synchronization between the client and X server is done using an
  49     * xshmfence that is mapped into an X server SyncFence. This lets the
  50     * client check whether the X server is done using a buffer with a simple
  51     * xshmfence call, rather than going to read X events from the wire.
  52     *
  53     * However, we can only wait for one xshmfence to be triggered at a time,
  54     * so we need to know *which* buffer is going to be idle next. We do that
  55     * by waiting for a PresentIdleNotify event. When that event arrives, the
  56     * 'busy' flag gets cleared and the client knows that the fence has been
  57     * triggered, and that the wait call will not block.
  58     */
  59
  60    uint32_t     sync_fence;     /* XID of X SyncFence object */
  61    struct xshmfence *shm_fence; /* pointer to xshmfence object */
  62    bool         busy;           /* Set on swap, cleared on IdleNotify */
  63    bool         own_pixmap;     /* We allocated the pixmap ID, free on destroy */
  64
  65    uint32_t     size;
  66    uint32_t     pitch;
  67    uint32_t     cpp;
  68    uint32_t     flags;
  69    uint32_t     width, height;
  70    uint64_t     last_swap;
  71 };
  72
  73
  74 #define LOADER_DRI3_MAX_BACK   4
  75 #define LOADER_DRI3_BACK_ID(i) (i)
  76 #define LOADER_DRI3_FRONT_ID   (LOADER_DRI3_MAX_BACK)
  77
  78 static inline int
  79 loader_dri3_pixmap_buf_id(enum loader_dri3_buffer_type buffer_type)
  80 {
  81    if (buffer_type == loader_dri3_buffer_back)
  82       return LOADER_DRI3_BACK_ID(0);
  83    else
  84       return LOADER_DRI3_FRONT_ID;
  85 }
  86
  87 struct loader_dri3_extensions {
  88    const __DRIcoreExtension *core;
  89    const __DRIimageDriverExtension *image_driver;
  90    const __DRI2flushExtension *flush;
  91    const __DRI2configQueryExtension *config;
  92    const __DRItexBufferExtension *tex_buffer;
  93    const __DRIimageExtension *image;
  94 };
  95
  96 struct loader_dri3_drawable;
  97
  98 struct loader_dri3_vtable {
  99    void (*set_drawable_size)(struct loader_dri3_drawable *, int, int);
 100    bool (*in_current_context)(struct loader_dri3_drawable *);
 101    __DRIcontext *(*get_dri_context)(struct loader_dri3_drawable *);
 102    void (*flush_drawable)(struct loader_dri3_drawable *, unsigned);
 103    void (*show_fps)(struct loader_dri3_drawable *, uint64_t);
 104 };
 105
 106 #define LOADER_DRI3_NUM_BUFFERS (1 + LOADER_DRI3_MAX_BACK)
 107
 108 struct loader_dri3_drawable {
 109    xcb_connection_t *conn;
 110    __DRIdrawable *dri_drawable;
 111    xcb_drawable_t drawable;
 112    int width;
 113    int height;
 114    int depth;
 115    uint8_t have_back;
 116    uint8_t have_fake_front;
 117    uint8_t is_pixmap;
 118    uint8_t flipping;
 119
 120    /* Information about the GPU owning the buffer */
 121    __DRIscreen *dri_screen;
 122    bool is_different_gpu;
 123
 124    /* Present extension capabilities
 125     */
 126    uint32_t present_capabilities;
 127
 128    /* SBC numbers are tracked by using the serial numbers
 129     * in the present request and complete events
 130     */
 131    uint64_t send_sbc;
 132    uint64_t recv_sbc;
 133
 134    /* Last received UST/MSC values for pixmap present complete */
 135    uint64_t ust, msc;
 136
 137    /* Last received UST/MSC values from present notify msc event */
 138    uint64_t notify_ust, notify_msc;
 139
 140    struct loader_dri3_buffer *buffers[LOADER_DRI3_NUM_BUFFERS];
 141    int cur_back;
 142    int num_back;
 143    int cur_blit_source;
 144
 145    uint32_t *stamp;
 146
 147    xcb_present_event_t eid;
 148    xcb_gcontext_t gc;
 149    xcb_special_event_t *special_event;
 150
 151    bool first_init;
 152    int swap_interval;
 153
 154    struct loader_dri3_extensions *ext;
 155    const struct loader_dri3_vtable *vtable;
 156
 157    unsigned int swap_method;
 158    unsigned int back_format;
 159
 160    /* Currently protects the following fields:
 161     * event_cnd, has_event_waiter,
 162     * recv_sbc, ust, msc, recv_msc_serial,
 163     * notify_ust, notify_msc
 164     */
 165    mtx_t mtx;
 166    cnd_t event_cnd;
 167    bool has_event_waiter;
 168 };
 169
 170 void
 171 loader_dri3_set_swap_interval(struct loader_dri3_drawable *draw,
 172                               int interval);
 173
 174 void
 175 loader_dri3_drawable_fini(struct loader_dri3_drawable *draw);
 176
 177 int
 178 loader_dri3_drawable_init(xcb_connection_t *conn,
 179                           xcb_drawable_t drawable,
 180                           __DRIscreen *dri_screen,
 181                           bool is_different_gpu,
 182                           const __DRIconfig *dri_config,
 183                           struct loader_dri3_extensions *ext,
 184                           const struct loader_dri3_vtable *vtable,
 185                           struct loader_dri3_drawable*);
 186
 187 bool loader_dri3_wait_for_msc(struct loader_dri3_drawable *draw,
 188                               int64_t target_msc,
 189                               int64_t divisor, int64_t remainder,
 190                               int64_t *ust, int64_t *msc, int64_t *sbc);
 191
 192 int64_t
 193 loader_dri3_swap_buffers_msc(struct loader_dri3_drawable *draw,
 194                              int64_t target_msc, int64_t divisor,
 195                              int64_t remainder, unsigned flush_flags,
 196                              bool force_copy);
 197
 198 int
 199 loader_dri3_wait_for_sbc(struct loader_dri3_drawable *draw,
 200                          int64_t target_sbc, int64_t *ust,
 201                          int64_t *msc, int64_t *sbc);
 202
 203 int loader_dri3_query_buffer_age(struct loader_dri3_drawable *draw);
 204
 205 void
 206 loader_dri3_flush(struct loader_dri3_drawable *draw,
 207                   unsigned flags,
 208                   enum __DRI2throttleReason throttle_reason);
 209
 210 void
 211 loader_dri3_copy_sub_buffer(struct loader_dri3_drawable *draw,
 212                             int x, int y,
 213                             int width, int height,
 214                             bool flush);
 215
 216 void
 217 loader_dri3_copy_drawable(struct loader_dri3_drawable *draw,
 218                           xcb_drawable_t dest,
 219                           xcb_drawable_t src);
 220
 221 void
 222 loader_dri3_wait_x(struct loader_dri3_drawable *draw);
 223
 224 void
 225 loader_dri3_wait_gl(struct loader_dri3_drawable *draw);
 226
 227 int loader_dri3_open(xcb_connection_t *conn,
 228                      xcb_window_t root,
 229                      uint32_t provider);
 230
 231 __DRIimage *
 232 loader_dri3_create_image(xcb_connection_t *c,
 233                          xcb_dri3_buffer_from_pixmap_reply_t *bp_reply,
 234                          unsigned int format,
 235                          __DRIscreen *dri_screen,
 236                          const __DRIimageExtension *image,
 237                          void *loaderPrivate);
 238
 239 int
 240 loader_dri3_get_buffers(__DRIdrawable *driDrawable,
 241                         unsigned int format,
 242                         uint32_t *stamp,
 243                         void *loaderPrivate,
 244                         uint32_t buffer_mask,
 245                         struct __DRIimageList *buffers);
 246
 247 void
 248 loader_dri3_update_drawable_geometry(struct loader_dri3_drawable *draw);
 249
 250 void
 251 loader_dri3_swapbuffer_barrier(struct loader_dri3_drawable *draw);
 252
 253 void
 254 loader_dri3_close_screen(__DRIscreen *dri_screen);
 255 #endif