cd9e8286792f6e4970c9e56fe339b177dfe64812
[mesa.git] / 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
37 enum loader_dri3_buffer_type {
38 loader_dri3_buffer_back = 0,
39 loader_dri3_buffer_front = 1
40 };
41
42 struct loader_dri3_buffer {
43 __DRIimage *image;
44 __DRIimage *linear_buffer;
45 uint32_t pixmap;
46
47 /* Synchronization between the client and X server is done using an
48 * xshmfence that is mapped into an X server SyncFence. This lets the
49 * client check whether the X server is done using a buffer with a simple
50 * xshmfence call, rather than going to read X events from the wire.
51 *
52 * However, we can only wait for one xshmfence to be triggered at a time,
53 * so we need to know *which* buffer is going to be idle next. We do that
54 * by waiting for a PresentIdleNotify event. When that event arrives, the
55 * 'busy' flag gets cleared and the client knows that the fence has been
56 * triggered, and that the wait call will not block.
57 */
58
59 uint32_t sync_fence; /* XID of X SyncFence object */
60 struct xshmfence *shm_fence; /* pointer to xshmfence object */
61 bool busy; /* Set on swap, cleared on IdleNotify */
62 bool own_pixmap; /* We allocated the pixmap ID, free on destroy */
63
64 uint32_t size;
65 uint32_t pitch;
66 uint32_t cpp;
67 uint32_t flags;
68 uint32_t width, height;
69 uint64_t last_swap;
70
71 enum loader_dri3_buffer_type buffer_type;
72 };
73
74
75 #define LOADER_DRI3_MAX_BACK 4
76 #define LOADER_DRI3_BACK_ID(i) (i)
77 #define LOADER_DRI3_FRONT_ID (LOADER_DRI3_MAX_BACK)
78
79 static inline int
80 loader_dri3_pixmap_buf_id(enum loader_dri3_buffer_type buffer_type)
81 {
82 if (buffer_type == loader_dri3_buffer_back)
83 return LOADER_DRI3_BACK_ID(0);
84 else
85 return LOADER_DRI3_FRONT_ID;
86 }
87
88 struct loader_dri3_extensions {
89 const __DRIcoreExtension *core;
90 const __DRIimageDriverExtension *image_driver;
91 const __DRI2flushExtension *flush;
92 const __DRI2configQueryExtension *config;
93 const __DRItexBufferExtension *tex_buffer;
94 const __DRIimageExtension *image;
95 };
96
97 struct loader_dri3_drawable;
98
99 struct loader_dri3_vtable {
100 void (*set_drawable_size)(struct loader_dri3_drawable *, int, int);
101 bool (*in_current_context)(struct loader_dri3_drawable *);
102 __DRIcontext *(*get_dri_context)(struct loader_dri3_drawable *);
103 void (*flush_drawable)(struct loader_dri3_drawable *, unsigned);
104 void (*show_fps)(struct loader_dri3_drawable *, uint64_t);
105 };
106
107 #define LOADER_DRI3_NUM_BUFFERS (1 + LOADER_DRI3_MAX_BACK)
108
109 struct loader_dri3_drawable {
110 xcb_connection_t *conn;
111 __DRIdrawable *dri_drawable;
112 xcb_drawable_t drawable;
113 int width;
114 int height;
115 int depth;
116 uint8_t have_back;
117 uint8_t have_fake_front;
118 uint8_t is_pixmap;
119 uint8_t flipping;
120
121 /* Information about the GPU owning the buffer */
122 __DRIscreen *dri_screen;
123 bool is_different_gpu;
124
125 /* Present extension capabilities
126 */
127 uint32_t present_capabilities;
128
129 /* SBC numbers are tracked by using the serial numbers
130 * in the present request and complete events
131 */
132 uint64_t send_sbc;
133 uint64_t recv_sbc;
134
135 /* Last received UST/MSC values for pixmap present complete */
136 uint64_t ust, msc;
137
138 /* Last received UST/MSC values from present notify msc event */
139 uint64_t notify_ust, notify_msc;
140
141 /* Serial numbers for tracking wait_for_msc events */
142 uint32_t send_msc_serial;
143 uint32_t recv_msc_serial;
144
145 struct loader_dri3_buffer *buffers[LOADER_DRI3_NUM_BUFFERS];
146 int cur_back;
147 int num_back;
148 int cur_blit_source;
149
150 uint32_t *stamp;
151
152 xcb_present_event_t eid;
153 xcb_gcontext_t gc;
154 xcb_special_event_t *special_event;
155
156 bool first_init;
157 int swap_interval;
158
159 struct loader_dri3_extensions *ext;
160 const struct loader_dri3_vtable *vtable;
161
162 unsigned int swap_method;
163 };
164
165 void
166 loader_dri3_set_swap_interval(struct loader_dri3_drawable *draw,
167 int interval);
168
169 void
170 loader_dri3_drawable_fini(struct loader_dri3_drawable *draw);
171
172 int
173 loader_dri3_drawable_init(xcb_connection_t *conn,
174 xcb_drawable_t drawable,
175 __DRIscreen *dri_screen,
176 bool is_different_gpu,
177 const __DRIconfig *dri_config,
178 struct loader_dri3_extensions *ext,
179 const struct loader_dri3_vtable *vtable,
180 struct loader_dri3_drawable*);
181
182 bool loader_dri3_wait_for_msc(struct loader_dri3_drawable *draw,
183 int64_t target_msc,
184 int64_t divisor, int64_t remainder,
185 int64_t *ust, int64_t *msc, int64_t *sbc);
186
187 int64_t
188 loader_dri3_swap_buffers_msc(struct loader_dri3_drawable *draw,
189 int64_t target_msc, int64_t divisor,
190 int64_t remainder, unsigned flush_flags,
191 bool force_copy);
192
193 int
194 loader_dri3_wait_for_sbc(struct loader_dri3_drawable *draw,
195 int64_t target_sbc, int64_t *ust,
196 int64_t *msc, int64_t *sbc);
197
198 int loader_dri3_query_buffer_age(struct loader_dri3_drawable *draw);
199
200 void
201 loader_dri3_flush(struct loader_dri3_drawable *draw,
202 unsigned flags,
203 enum __DRI2throttleReason throttle_reason);
204
205 void
206 loader_dri3_copy_sub_buffer(struct loader_dri3_drawable *draw,
207 int x, int y,
208 int width, int height,
209 bool flush);
210
211 void
212 loader_dri3_copy_drawable(struct loader_dri3_drawable *draw,
213 xcb_drawable_t dest,
214 xcb_drawable_t src);
215
216 void
217 loader_dri3_wait_x(struct loader_dri3_drawable *draw);
218
219 void
220 loader_dri3_wait_gl(struct loader_dri3_drawable *draw);
221
222 int loader_dri3_open(xcb_connection_t *conn,
223 xcb_window_t root,
224 uint32_t provider);
225
226 __DRIimage *
227 loader_dri3_create_image(xcb_connection_t *c,
228 xcb_dri3_buffer_from_pixmap_reply_t *bp_reply,
229 unsigned int format,
230 __DRIscreen *dri_screen,
231 const __DRIimageExtension *image,
232 void *loaderPrivate);
233
234 int
235 loader_dri3_get_buffers(__DRIdrawable *driDrawable,
236 unsigned int format,
237 uint32_t *stamp,
238 void *loaderPrivate,
239 uint32_t buffer_mask,
240 struct __DRIimageList *buffers);
241
242 void
243 loader_dri3_update_drawable_geometry(struct loader_dri3_drawable *draw);
244
245 void
246 loader_dri3_swapbuffer_barrier(struct loader_dri3_drawable *draw);
247
248 void
249 loader_dri3_close_screen(__DRIscreen *dri_screen);
250 #endif