2 * Copyright © 2013 Keith Packard
3 * Copyright © 2015 Boyan Ding
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.
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
24 #ifndef LOADER_DRI3_HEADER_H
25 #define LOADER_DRI3_HEADER_H
32 #include <xcb/present.h>
35 #include <GL/internal/dri_interface.h>
36 #include <c11/threads.h>
38 enum loader_dri3_buffer_type
{
39 loader_dri3_buffer_back
= 0,
40 loader_dri3_buffer_front
= 1
43 struct loader_dri3_buffer
{
45 __DRIimage
*linear_buffer
;
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.
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.
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 */
72 uint32_t width
, height
;
77 #define LOADER_DRI3_MAX_BACK 4
78 #define LOADER_DRI3_BACK_ID(i) (i)
79 #define LOADER_DRI3_FRONT_ID (LOADER_DRI3_MAX_BACK)
82 loader_dri3_pixmap_buf_id(enum loader_dri3_buffer_type buffer_type
)
84 if (buffer_type
== loader_dri3_buffer_back
)
85 return LOADER_DRI3_BACK_ID(0);
87 return LOADER_DRI3_FRONT_ID
;
90 struct loader_dri3_extensions
{
91 const __DRIcoreExtension
*core
;
92 const __DRIimageDriverExtension
*image_driver
;
93 const __DRI2flushExtension
*flush
;
94 const __DRI2configQueryExtension
*config
;
95 const __DRItexBufferExtension
*tex_buffer
;
96 const __DRIimageExtension
*image
;
99 struct loader_dri3_drawable
;
101 struct loader_dri3_vtable
{
102 void (*set_drawable_size
)(struct loader_dri3_drawable
*, int, int);
103 bool (*in_current_context
)(struct loader_dri3_drawable
*);
104 __DRIcontext
*(*get_dri_context
)(struct loader_dri3_drawable
*);
105 __DRIscreen
*(*get_dri_screen
)(void);
106 void (*flush_drawable
)(struct loader_dri3_drawable
*, unsigned);
107 void (*show_fps
)(struct loader_dri3_drawable
*, uint64_t);
110 #define LOADER_DRI3_NUM_BUFFERS (1 + LOADER_DRI3_MAX_BACK)
112 struct loader_dri3_drawable
{
113 xcb_connection_t
*conn
;
114 __DRIdrawable
*dri_drawable
;
115 xcb_drawable_t drawable
;
120 uint8_t have_fake_front
;
123 /* Information about the GPU owning the buffer */
124 __DRIscreen
*dri_screen
;
125 bool is_different_gpu
;
126 bool multiplanes_available
;
128 /* Present extension capabilities
130 uint32_t present_capabilities
;
132 /* SBC numbers are tracked by using the serial numbers
133 * in the present request and complete events
138 /* Last received UST/MSC values for pixmap present complete */
141 /* Last received UST/MSC values from present notify msc event */
142 uint64_t notify_ust
, notify_msc
;
144 struct loader_dri3_buffer
*buffers
[LOADER_DRI3_NUM_BUFFERS
];
151 xcb_present_event_t eid
;
153 xcb_special_event_t
*special_event
;
158 struct loader_dri3_extensions
*ext
;
159 const struct loader_dri3_vtable
*vtable
;
161 unsigned int swap_method
;
162 unsigned int back_format
;
163 xcb_present_complete_mode_t last_present_mode
;
165 /* Currently protects the following fields:
166 * event_cnd, has_event_waiter,
167 * recv_sbc, ust, msc, recv_msc_serial,
168 * notify_ust, notify_msc
172 bool has_event_waiter
;
176 loader_dri3_set_swap_interval(struct loader_dri3_drawable
*draw
,
180 loader_dri3_drawable_fini(struct loader_dri3_drawable
*draw
);
183 loader_dri3_drawable_init(xcb_connection_t
*conn
,
184 xcb_drawable_t drawable
,
185 __DRIscreen
*dri_screen
,
186 bool is_different_gpu
,
187 bool is_multiplanes_available
,
188 const __DRIconfig
*dri_config
,
189 struct loader_dri3_extensions
*ext
,
190 const struct loader_dri3_vtable
*vtable
,
191 struct loader_dri3_drawable
*);
193 bool loader_dri3_wait_for_msc(struct loader_dri3_drawable
*draw
,
195 int64_t divisor
, int64_t remainder
,
196 int64_t *ust
, int64_t *msc
, int64_t *sbc
);
199 loader_dri3_swap_buffers_msc(struct loader_dri3_drawable
*draw
,
200 int64_t target_msc
, int64_t divisor
,
201 int64_t remainder
, unsigned flush_flags
,
205 loader_dri3_wait_for_sbc(struct loader_dri3_drawable
*draw
,
206 int64_t target_sbc
, int64_t *ust
,
207 int64_t *msc
, int64_t *sbc
);
209 int loader_dri3_query_buffer_age(struct loader_dri3_drawable
*draw
);
212 loader_dri3_flush(struct loader_dri3_drawable
*draw
,
214 enum __DRI2throttleReason throttle_reason
);
217 loader_dri3_copy_sub_buffer(struct loader_dri3_drawable
*draw
,
219 int width
, int height
,
223 loader_dri3_copy_drawable(struct loader_dri3_drawable
*draw
,
228 loader_dri3_wait_x(struct loader_dri3_drawable
*draw
);
231 loader_dri3_wait_gl(struct loader_dri3_drawable
*draw
);
233 int loader_dri3_open(xcb_connection_t
*conn
,
238 loader_dri3_create_image(xcb_connection_t
*c
,
239 xcb_dri3_buffer_from_pixmap_reply_t
*bp_reply
,
241 __DRIscreen
*dri_screen
,
242 const __DRIimageExtension
*image
,
243 void *loaderPrivate
);
246 loader_dri3_create_image_from_buffers(xcb_connection_t
*c
,
247 xcb_dri3_buffers_from_pixmap_reply_t
*bp_reply
,
249 __DRIscreen
*dri_screen
,
250 const __DRIimageExtension
*image
,
251 void *loaderPrivate
);
254 loader_dri3_get_buffers(__DRIdrawable
*driDrawable
,
258 uint32_t buffer_mask
,
259 struct __DRIimageList
*buffers
);
262 loader_dri3_update_drawable_geometry(struct loader_dri3_drawable
*draw
);
265 loader_dri3_swapbuffer_barrier(struct loader_dri3_drawable
*draw
);
268 loader_dri3_close_screen(__DRIscreen
*dri_screen
);