src/glx/dri3_priv.h

   1 /*
   2  * Copyright © 2013 Keith Packard
   3  *
   4  * Permission to use, copy, modify, distribute, and sell this software and its
   5  * documentation for any purpose is hereby granted without fee, provided that
   6  * the above copyright notice appear in all copies and that both that copyright
   7  * notice and this permission notice appear in supporting documentation, and
   8  * that the name of the copyright holders not be used in advertising or
   9  * publicity pertaining to distribution of the software without specific,
  10  * written prior permission.  The copyright holders make no representations
  11  * about the suitability of this software for any purpose.  It is provided "as
  12  * is" without express or implied warranty.
  13  *
  14  * THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
  15  * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
  16  * EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY SPECIAL, INDIRECT OR
  17  * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
  18  * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
  19  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
  20  * OF THIS SOFTWARE.
  21  */
  22
  23 /* This file was derived from dri2_priv.h which carries the following
  24  * copyright:
  25  *
  26  * Copyright © 2008 Red Hat, Inc.
  27  *
  28  * Permission is hereby granted, free of charge, to any person obtaining a
  29  * copy of this software and associated documentation files (the "Soft-
  30  * ware"), to deal in the Software without restriction, including without
  31  * limitation the rights to use, copy, modify, merge, publish, distribute,
  32  * and/or sell copies of the Software, and to permit persons to whom the
  33  * Software is furnished to do so, provided that the above copyright
  34  * notice(s) and this permission notice appear in all copies of the Soft-
  35  * ware and that both the above copyright notice(s) and this permission
  36  * notice appear in supporting documentation.
  37  *
  38  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  39  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABIL-
  40  * ITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OF THIRD PARTY
  41  * RIGHTS. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR HOLDERS INCLUDED IN
  42  * THIS NOTICE BE LIABLE FOR ANY CLAIM, OR ANY SPECIAL INDIRECT OR CONSE-
  43  * QUENTIAL DAMAGES, OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
  44  * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
  45  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFOR-
  46  * MANCE OF THIS SOFTWARE.
  47  *
  48  * Except as contained in this notice, the name of a copyright holder shall
  49  * not be used in advertising or otherwise to promote the sale, use or
  50  * other dealings in this Software without prior written authorization of
  51  * the copyright holder.
  52  *
  53  * Authors:
  54  *   Kristian Høgsberg (krh@redhat.com)
  55  */
  56
  57 #include <xcb/xcb.h>
  58 #include <xcb/dri3.h>
  59 #include <xcb/present.h>
  60 #include <xcb/sync.h>
  61
  62 /* From xmlpool/options.h, user exposed so should be stable */
  63 #define DRI_CONF_VBLANK_NEVER 0
  64 #define DRI_CONF_VBLANK_DEF_INTERVAL_0 1
  65 #define DRI_CONF_VBLANK_DEF_INTERVAL_1 2
  66 #define DRI_CONF_VBLANK_ALWAYS_SYNC 3
  67
  68 enum dri3_buffer_type {
  69    dri3_buffer_back = 0,
  70    dri3_buffer_front = 1
  71 };
  72
  73 struct dri3_buffer {
  74    __DRIimage   *image;
  75    uint32_t     pixmap;
  76
  77    /* Synchronization between the client and X server is done using an
  78     * xshmfence that is mapped into an X server SyncFence. This lets the
  79     * client check whether the X server is done using a buffer with a simple
  80     * xshmfence call, rather than going to read X events from the wire.
  81     *
  82     * However, we can only wait for one xshmfence to be triggered at a time,
  83     * so we need to know *which* buffer is going to be idle next. We do that
  84     * by waiting for a PresentIdleNotify event. When that event arrives, the
  85     * 'busy' flag gets cleared and the client knows that the fence has been
  86     * triggered, and that the wait call will not block.
  87     */
  88
  89    uint32_t     sync_fence;     /* XID of X SyncFence object */
  90    struct xshmfence *shm_fence; /* pointer to xshmfence object */
  91    GLboolean    busy;           /* Set on swap, cleared on IdleNotify */
  92    GLboolean    own_pixmap;     /* We allocated the pixmap ID, free on destroy */
  93    void         *driverPrivate;
  94
  95    uint32_t     size;
  96    uint32_t     pitch;
  97    uint32_t     cpp;
  98    uint32_t     flags;
  99    uint32_t     width, height;
 100    uint64_t     last_swap;
 101
 102    enum dri3_buffer_type        buffer_type;
 103 };
 104
 105 struct dri3_display
 106 {
 107    __GLXDRIdisplay base;
 108
 109    const __DRIextension **loader_extensions;
 110
 111    /* DRI3 bits */
 112    int dri3Major;
 113    int dri3Minor;
 114
 115    /* Present bits */
 116    int hasPresent;
 117    int presentMajor;
 118    int presentMinor;
 119 };
 120
 121 struct dri3_screen {
 122    struct glx_screen base;
 123
 124    __DRIscreen *driScreen;
 125    __GLXDRIscreen vtable;
 126
 127    const __DRIimageExtension *image;
 128    const __DRIimageDriverExtension *image_driver;
 129    const __DRIcoreExtension *core;
 130    const __DRI2flushExtension *f;
 131    const __DRI2configQueryExtension *config;
 132    const __DRItexBufferExtension *texBuffer;
 133    const __DRI2rendererQueryExtension *rendererQuery;
 134    const __DRIconfig **driver_configs;
 135
 136    void *driver;
 137    int fd;
 138
 139    Bool show_fps;
 140 };
 141
 142 struct dri3_context
 143 {
 144    struct glx_context base;
 145    __DRIcontext *driContext;
 146 };
 147
 148 #define DRI3_MAX_BACK   3
 149 #define DRI3_BACK_ID(i) (i)
 150 #define DRI3_FRONT_ID   (DRI3_MAX_BACK)
 151
 152 static inline int
 153 dri3_pixmap_buf_id(enum dri3_buffer_type buffer_type)
 154 {
 155    if (buffer_type == dri3_buffer_back)
 156       return DRI3_BACK_ID(0);
 157    else
 158       return DRI3_FRONT_ID;
 159 }
 160
 161 #define DRI3_NUM_BUFFERS        (1 + DRI3_MAX_BACK)
 162
 163 struct dri3_drawable {
 164    __GLXDRIdrawable base;
 165    __DRIdrawable *driDrawable;
 166    int width, height, depth;
 167    int swap_interval;
 168    uint8_t have_back;
 169    uint8_t have_fake_front;
 170    uint8_t is_pixmap;
 171    uint8_t flipping;
 172
 173    /* SBC numbers are tracked by using the serial numbers
 174     * in the present request and complete events
 175     */
 176    uint64_t send_sbc;
 177    uint64_t recv_sbc;
 178
 179    /* Last received UST/MSC values */
 180    uint64_t ust, msc;
 181
 182    /* Serial numbers for tracking wait_for_msc events */
 183    uint32_t send_msc_serial;
 184    uint32_t recv_msc_serial;
 185
 186    struct dri3_buffer *buffers[DRI3_NUM_BUFFERS];
 187    int cur_back;
 188    int num_back;
 189
 190    uint32_t *stamp;
 191
 192    xcb_present_event_t eid;
 193    xcb_gcontext_t gc;
 194    xcb_special_event_t *special_event;
 195 };