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
28 #include <X11/xshmfence.h>
31 #include <xcb/present.h>
33 #include <X11/Xlib-xcb.h>
35 #include "loader_dri3_helper.h"
37 /* From xmlpool/options.h, user exposed so should be stable */
38 #define DRI_CONF_VBLANK_NEVER 0
39 #define DRI_CONF_VBLANK_DEF_INTERVAL_0 1
40 #define DRI_CONF_VBLANK_DEF_INTERVAL_1 2
41 #define DRI_CONF_VBLANK_ALWAYS_SYNC 3
44 dri3_fence_reset(xcb_connection_t
*c
, struct loader_dri3_buffer
*buffer
)
46 xshmfence_reset(buffer
->shm_fence
);
50 dri3_fence_set(struct loader_dri3_buffer
*buffer
)
52 xshmfence_trigger(buffer
->shm_fence
);
56 dri3_fence_trigger(xcb_connection_t
*c
, struct loader_dri3_buffer
*buffer
)
58 xcb_sync_trigger_fence(c
, buffer
->sync_fence
);
62 dri3_fence_await(xcb_connection_t
*c
, struct loader_dri3_buffer
*buffer
)
65 xshmfence_await(buffer
->shm_fence
);
69 dri3_update_num_back(struct loader_dri3_drawable
*draw
)
78 loader_dri3_set_swap_interval(struct loader_dri3_drawable
*draw
, int interval
)
80 interval
= draw
->vtable
->clamp_swap_interval(draw
, interval
);
81 draw
->vtable
->set_swap_interval(draw
, interval
);
82 dri3_update_num_back(draw
);
85 /** dri3_free_render_buffer
87 * Free everything associated with one render buffer including pixmap, fence
88 * stuff and the driver image
91 dri3_free_render_buffer(struct loader_dri3_drawable
*draw
,
92 struct loader_dri3_buffer
*buffer
)
94 if (buffer
->own_pixmap
)
95 xcb_free_pixmap(draw
->conn
, buffer
->pixmap
);
96 xcb_sync_destroy_fence(draw
->conn
, buffer
->sync_fence
);
97 xshmfence_unmap_shm(buffer
->shm_fence
);
98 (draw
->ext
->image
->destroyImage
)(buffer
->image
);
99 if (buffer
->linear_buffer
)
100 (draw
->ext
->image
->destroyImage
)(buffer
->linear_buffer
);
105 loader_dri3_drawable_fini(struct loader_dri3_drawable
*draw
)
109 (draw
->ext
->core
->destroyDrawable
)(draw
->dri_drawable
);
111 for (i
= 0; i
< LOADER_DRI3_NUM_BUFFERS
; i
++) {
112 if (draw
->buffers
[i
])
113 dri3_free_render_buffer(draw
, draw
->buffers
[i
]);
116 if (draw
->special_event
) {
117 xcb_void_cookie_t cookie
=
118 xcb_present_select_input_checked(draw
->conn
, draw
->eid
, draw
->drawable
,
119 XCB_PRESENT_EVENT_MASK_NO_EVENT
);
121 xcb_discard_reply(draw
->conn
, cookie
.sequence
);
122 xcb_unregister_for_special_event(draw
->conn
, draw
->special_event
);
127 loader_dri3_drawable_init(xcb_connection_t
*conn
,
128 xcb_drawable_t drawable
,
129 __DRIscreen
*dri_screen
,
130 bool is_different_gpu
,
131 const __DRIconfig
*dri_config
,
132 struct loader_dri3_extensions
*ext
,
133 const struct loader_dri3_vtable
*vtable
,
134 struct loader_dri3_drawable
*draw
)
136 xcb_get_geometry_cookie_t cookie
;
137 xcb_get_geometry_reply_t
*reply
;
138 xcb_generic_error_t
*error
;
139 GLint vblank_mode
= DRI_CONF_VBLANK_DEF_INTERVAL_1
;
144 draw
->vtable
= vtable
;
145 draw
->drawable
= drawable
;
146 draw
->dri_screen
= dri_screen
;
147 draw
->is_different_gpu
= is_different_gpu
;
150 draw
->have_fake_front
= 0;
151 draw
->first_init
= true;
153 if (draw
->ext
->config
)
154 draw
->ext
->config
->configQueryi(draw
->dri_screen
,
155 "vblank_mode", &vblank_mode
);
157 switch (vblank_mode
) {
158 case DRI_CONF_VBLANK_NEVER
:
159 case DRI_CONF_VBLANK_DEF_INTERVAL_0
:
162 case DRI_CONF_VBLANK_DEF_INTERVAL_1
:
163 case DRI_CONF_VBLANK_ALWAYS_SYNC
:
168 draw
->vtable
->set_swap_interval(draw
, swap_interval
);
170 dri3_update_num_back(draw
);
172 /* Create a new drawable */
174 (draw
->ext
->image_driver
->createNewDrawable
)(dri_screen
,
178 if (!draw
->dri_drawable
)
181 cookie
= xcb_get_geometry(draw
->conn
, draw
->drawable
);
182 reply
= xcb_get_geometry_reply(draw
->conn
, cookie
, &error
);
183 if (reply
== NULL
|| error
!= NULL
) {
184 draw
->ext
->core
->destroyDrawable(draw
->dri_drawable
);
188 draw
->width
= reply
->width
;
189 draw
->height
= reply
->height
;
190 draw
->depth
= reply
->depth
;
191 draw
->vtable
->set_drawable_size(draw
, draw
->width
, draw
->height
);
195 * Make sure server has the same swap interval we do for the new
198 loader_dri3_set_swap_interval(draw
, swap_interval
);
204 * Process one Present event
207 dri3_handle_present_event(struct loader_dri3_drawable
*draw
,
208 xcb_present_generic_event_t
*ge
)
210 switch (ge
->evtype
) {
211 case XCB_PRESENT_CONFIGURE_NOTIFY
: {
212 xcb_present_configure_notify_event_t
*ce
= (void *) ge
;
214 draw
->width
= ce
->width
;
215 draw
->height
= ce
->height
;
216 draw
->vtable
->set_drawable_size(draw
, draw
->width
, draw
->height
);
219 case XCB_PRESENT_COMPLETE_NOTIFY
: {
220 xcb_present_complete_notify_event_t
*ce
= (void *) ge
;
222 /* Compute the processed SBC number from the received 32-bit serial number
223 * merged with the upper 32-bits of the sent 64-bit serial number while
226 if (ce
->kind
== XCB_PRESENT_COMPLETE_KIND_PIXMAP
) {
227 draw
->recv_sbc
= (draw
->send_sbc
& 0xffffffff00000000LL
) | ce
->serial
;
228 if (draw
->recv_sbc
> draw
->send_sbc
)
229 draw
->recv_sbc
-= 0x100000000;
231 case XCB_PRESENT_COMPLETE_MODE_FLIP
:
232 draw
->flipping
= true;
234 case XCB_PRESENT_COMPLETE_MODE_COPY
:
235 draw
->flipping
= false;
238 dri3_update_num_back(draw
);
240 if (draw
->vtable
->show_fps
)
241 draw
->vtable
->show_fps(draw
, ce
->ust
);
246 draw
->recv_msc_serial
= ce
->serial
;
247 draw
->notify_ust
= ce
->ust
;
248 draw
->notify_msc
= ce
->msc
;
252 case XCB_PRESENT_EVENT_IDLE_NOTIFY
: {
253 xcb_present_idle_notify_event_t
*ie
= (void *) ge
;
256 for (b
= 0; b
< sizeof(draw
->buffers
) / sizeof(draw
->buffers
[0]); b
++) {
257 struct loader_dri3_buffer
*buf
= draw
->buffers
[b
];
259 if (buf
&& buf
->pixmap
== ie
->pixmap
) {
261 if (draw
->num_back
<= b
&& b
< LOADER_DRI3_MAX_BACK
) {
262 dri3_free_render_buffer(draw
, buf
);
263 draw
->buffers
[b
] = NULL
;
275 dri3_wait_for_event(struct loader_dri3_drawable
*draw
)
277 xcb_generic_event_t
*ev
;
278 xcb_present_generic_event_t
*ge
;
280 xcb_flush(draw
->conn
);
281 ev
= xcb_wait_for_special_event(draw
->conn
, draw
->special_event
);
285 dri3_handle_present_event(draw
, ge
);
289 /** loader_dri3_wait_for_msc
291 * Get the X server to send an event when the target msc/divisor/remainder is
295 loader_dri3_wait_for_msc(struct loader_dri3_drawable
*draw
,
297 int64_t divisor
, int64_t remainder
,
298 int64_t *ust
, int64_t *msc
, int64_t *sbc
)
302 msc_serial
= ++draw
->send_msc_serial
;
303 xcb_present_notify_msc(draw
->conn
,
310 xcb_flush(draw
->conn
);
312 /* Wait for the event */
313 if (draw
->special_event
) {
314 while ((int32_t) (msc_serial
- draw
->recv_msc_serial
) > 0) {
315 if (!dri3_wait_for_event(draw
))
320 *ust
= draw
->notify_ust
;
321 *msc
= draw
->notify_msc
;
322 *sbc
= draw
->recv_sbc
;
327 /** loader_dri3_wait_for_sbc
329 * Wait for the completed swap buffer count to reach the specified
330 * target. Presumably the application knows that this will be reached with
331 * outstanding complete events, or we're going to be here awhile.
334 loader_dri3_wait_for_sbc(struct loader_dri3_drawable
*draw
,
335 int64_t target_sbc
, int64_t *ust
,
336 int64_t *msc
, int64_t *sbc
)
338 /* From the GLX_OML_sync_control spec:
340 * "If <target_sbc> = 0, the function will block until all previous
341 * swaps requested with glXSwapBuffersMscOML for that window have
345 target_sbc
= draw
->send_sbc
;
347 while (draw
->recv_sbc
< target_sbc
) {
348 if (!dri3_wait_for_event(draw
))
354 *sbc
= draw
->recv_sbc
;
358 /** loader_dri3_find_back
360 * Find an idle back buffer. If there isn't one, then
361 * wait for a present idle notify event from the X server
364 dri3_find_back(struct loader_dri3_drawable
*draw
)
367 xcb_generic_event_t
*ev
;
368 xcb_present_generic_event_t
*ge
;
371 for (b
= 0; b
< draw
->num_back
; b
++) {
372 int id
= LOADER_DRI3_BACK_ID((b
+ draw
->cur_back
) % draw
->num_back
);
373 struct loader_dri3_buffer
*buffer
= draw
->buffers
[id
];
375 if (!buffer
|| !buffer
->busy
) {
380 xcb_flush(draw
->conn
);
381 ev
= xcb_wait_for_special_event(draw
->conn
, draw
->special_event
);
385 dri3_handle_present_event(draw
, ge
);
389 static xcb_gcontext_t
390 dri3_drawable_gc(struct loader_dri3_drawable
*draw
)
394 xcb_create_gc(draw
->conn
,
395 (draw
->gc
= xcb_generate_id(draw
->conn
)),
397 XCB_GC_GRAPHICS_EXPOSURES
,
404 static struct loader_dri3_buffer
*
405 dri3_back_buffer(struct loader_dri3_drawable
*draw
)
407 return draw
->buffers
[LOADER_DRI3_BACK_ID(draw
->cur_back
)];
410 static struct loader_dri3_buffer
*
411 dri3_fake_front_buffer(struct loader_dri3_drawable
*draw
)
413 return draw
->buffers
[LOADER_DRI3_FRONT_ID
];
417 dri3_copy_area(xcb_connection_t
*c
,
418 xcb_drawable_t src_drawable
,
419 xcb_drawable_t dst_drawable
,
428 xcb_void_cookie_t cookie
;
430 cookie
= xcb_copy_area_checked(c
,
440 xcb_discard_reply(c
, cookie
.sequence
);
444 * Asks the driver to flush any queued work necessary for serializing with the
445 * X command stream, and optionally the slightly more strict requirement of
446 * glFlush() equivalence (which would require flushing even if nothing had
447 * been drawn to a window system framebuffer, for example).
450 loader_dri3_flush(struct loader_dri3_drawable
*draw
,
452 enum __DRI2throttleReason throttle_reason
)
454 /* NEED TO CHECK WHETHER CONTEXT IS NULL */
455 __DRIcontext
*dri_context
= draw
->vtable
->get_dri_context(draw
);
458 draw
->ext
->flush
->flush_with_flags(dri_context
, draw
->dri_drawable
,
459 flags
, throttle_reason
);
464 loader_dri3_copy_sub_buffer(struct loader_dri3_drawable
*draw
,
466 int width
, int height
,
469 struct loader_dri3_buffer
*back
;
470 unsigned flags
= __DRI2_FLUSH_DRAWABLE
;
471 __DRIcontext
*dri_context
;
473 dri_context
= draw
->vtable
->get_dri_context(draw
);
475 /* Check we have the right attachments */
476 if (!draw
->have_back
|| draw
->is_pixmap
)
480 flags
|= __DRI2_FLUSH_CONTEXT
;
481 loader_dri3_flush(draw
, flags
, __DRI2_THROTTLE_SWAPBUFFER
);
483 back
= dri3_back_buffer(draw
);
484 y
= draw
->height
- y
- height
;
486 if (draw
->is_different_gpu
&& draw
->vtable
->in_current_context(draw
)) {
487 /* Update the linear buffer part of the back buffer
488 * for the dri3_copy_area operation
490 draw
->ext
->image
->blitImage(dri_context
,
496 back
->height
, __BLIT_FLAG_FLUSH
);
497 /* We use blitImage to update our fake front,
499 if (draw
->have_fake_front
)
500 draw
->ext
->image
->blitImage(dri_context
,
501 dri3_fake_front_buffer(draw
)->image
,
504 x
, y
, width
, height
, __BLIT_FLAG_FLUSH
);
507 dri3_fence_reset(draw
->conn
, back
);
508 dri3_copy_area(draw
->conn
,
509 dri3_back_buffer(draw
)->pixmap
,
511 dri3_drawable_gc(draw
),
512 x
, y
, x
, y
, width
, height
);
513 dri3_fence_trigger(draw
->conn
, back
);
514 /* Refresh the fake front (if present) after we just damaged the real
517 if (draw
->have_fake_front
&& !draw
->is_different_gpu
) {
518 dri3_fence_reset(draw
->conn
, dri3_fake_front_buffer(draw
));
519 dri3_copy_area(draw
->conn
,
520 dri3_back_buffer(draw
)->pixmap
,
521 dri3_fake_front_buffer(draw
)->pixmap
,
522 dri3_drawable_gc(draw
),
523 x
, y
, x
, y
, width
, height
);
524 dri3_fence_trigger(draw
->conn
, dri3_fake_front_buffer(draw
));
525 dri3_fence_await(draw
->conn
, dri3_fake_front_buffer(draw
));
527 dri3_fence_await(draw
->conn
, back
);
531 loader_dri3_copy_drawable(struct loader_dri3_drawable
*draw
,
535 loader_dri3_flush(draw
, __DRI2_FLUSH_DRAWABLE
, 0);
537 dri3_fence_reset(draw
->conn
, dri3_fake_front_buffer(draw
));
538 dri3_copy_area(draw
->conn
,
540 dri3_drawable_gc(draw
),
541 0, 0, 0, 0, draw
->width
, draw
->height
);
542 dri3_fence_trigger(draw
->conn
, dri3_fake_front_buffer(draw
));
543 dri3_fence_await(draw
->conn
, dri3_fake_front_buffer(draw
));
547 loader_dri3_wait_x(struct loader_dri3_drawable
*draw
)
549 struct loader_dri3_buffer
*front
;
550 __DRIcontext
*dri_context
;
552 if (draw
== NULL
|| !draw
->have_fake_front
)
555 front
= dri3_fake_front_buffer(draw
);
556 dri_context
= draw
->vtable
->get_dri_context(draw
);
558 loader_dri3_copy_drawable(draw
, front
->pixmap
, draw
->drawable
);
560 /* In the psc->is_different_gpu case, the linear buffer has been updated,
561 * but not yet the tiled buffer.
562 * Copy back to the tiled buffer we use for rendering.
563 * Note that we don't need flushing.
565 if (draw
->is_different_gpu
&& draw
->vtable
->in_current_context(draw
))
566 draw
->ext
->image
->blitImage(dri_context
,
568 front
->linear_buffer
,
576 loader_dri3_wait_gl(struct loader_dri3_drawable
*draw
)
578 struct loader_dri3_buffer
*front
;
579 __DRIcontext
*dri_context
;
581 if (draw
== NULL
|| !draw
->have_fake_front
)
584 front
= dri3_fake_front_buffer(draw
);
585 dri_context
= draw
->vtable
->get_dri_context(draw
);
587 /* In the psc->is_different_gpu case, we update the linear_buffer
588 * before updating the real front.
590 if (draw
->is_different_gpu
&& draw
->vtable
->in_current_context(draw
))
591 draw
->ext
->image
->blitImage(dri_context
,
592 front
->linear_buffer
,
597 front
->height
, __BLIT_FLAG_FLUSH
);
598 loader_dri3_copy_drawable(draw
, draw
->drawable
, front
->pixmap
);
601 /** dri3_flush_present_events
603 * Process any present events that have been received from the X server
606 dri3_flush_present_events(struct loader_dri3_drawable
*draw
)
608 /* Check to see if any configuration changes have occurred
609 * since we were last invoked
611 if (draw
->special_event
) {
612 xcb_generic_event_t
*ev
;
614 while ((ev
= xcb_poll_for_special_event(draw
->conn
,
615 draw
->special_event
)) != NULL
) {
616 xcb_present_generic_event_t
*ge
= (void *) ev
;
617 dri3_handle_present_event(draw
, ge
);
622 /** loader_dri3_swap_buffers_msc
624 * Make the current back buffer visible using the present extension
627 loader_dri3_swap_buffers_msc(struct loader_dri3_drawable
*draw
,
628 int64_t target_msc
, int64_t divisor
,
629 int64_t remainder
, unsigned flush_flags
,
632 struct loader_dri3_buffer
*back
;
633 __DRIcontext
*dri_context
;
635 uint32_t options
= XCB_PRESENT_OPTION_NONE
;
638 dri_context
= draw
->vtable
->get_dri_context(draw
);
639 swap_interval
= draw
->vtable
->get_swap_interval(draw
);
641 draw
->vtable
->flush_drawable(draw
, flush_flags
);
643 back
= draw
->buffers
[LOADER_DRI3_BACK_ID(draw
->cur_back
)];
644 if (draw
->is_different_gpu
&& back
) {
645 /* Update the linear buffer before presenting the pixmap */
646 draw
->ext
->image
->blitImage(dri_context
,
652 back
->height
, __BLIT_FLAG_FLUSH
);
653 /* Update the fake front */
654 if (draw
->have_fake_front
)
655 draw
->ext
->image
->blitImage(dri_context
,
656 draw
->buffers
[LOADER_DRI3_FRONT_ID
]->image
,
658 0, 0, draw
->width
, draw
->height
,
659 0, 0, draw
->width
, draw
->height
,
663 dri3_flush_present_events(draw
);
665 if (back
&& !draw
->is_pixmap
) {
666 dri3_fence_reset(draw
->conn
, back
);
668 /* Compute when we want the frame shown by taking the last known
669 * successful MSC and adding in a swap interval for each outstanding swap
670 * request. target_msc=divisor=remainder=0 means "Use glXSwapBuffers()
674 if (target_msc
== 0 && divisor
== 0 && remainder
== 0)
675 target_msc
= draw
->msc
+ swap_interval
*
676 (draw
->send_sbc
- draw
->recv_sbc
);
677 else if (divisor
== 0 && remainder
> 0) {
678 /* From the GLX_OML_sync_control spec:
679 * "If <divisor> = 0, the swap will occur when MSC becomes
680 * greater than or equal to <target_msc>."
682 * Note that there's no mention of the remainder. The Present
683 * extension throws BadValue for remainder != 0 with divisor == 0, so
684 * just drop the passed in value.
689 /* From the GLX_EXT_swap_control spec
690 * and the EGL 1.4 spec (page 53):
692 * "If <interval> is set to a value of 0, buffer swaps are not
693 * synchronized to a video frame."
695 * Implementation note: It is possible to enable triple buffering
696 * behaviour by not using XCB_PRESENT_OPTION_ASYNC, but this should not be
699 if (swap_interval
== 0)
700 options
|= XCB_PRESENT_OPTION_ASYNC
;
702 options
|= XCB_PRESENT_OPTION_COPY
;
705 back
->last_swap
= draw
->send_sbc
;
706 xcb_present_pixmap(draw
->conn
,
709 (uint32_t) draw
->send_sbc
,
714 None
, /* target_crtc */
721 ret
= (int64_t) draw
->send_sbc
;
723 /* If there's a fake front, then copy the source back buffer
724 * to the fake front to keep it up to date. This needs
725 * to reset the fence and make future users block until
726 * the X server is done copying the bits
728 if (draw
->have_fake_front
&& !draw
->is_different_gpu
) {
729 dri3_fence_reset(draw
->conn
, draw
->buffers
[LOADER_DRI3_FRONT_ID
]);
730 dri3_copy_area(draw
->conn
,
732 draw
->buffers
[LOADER_DRI3_FRONT_ID
]->pixmap
,
733 dri3_drawable_gc(draw
),
735 draw
->width
, draw
->height
);
736 dri3_fence_trigger(draw
->conn
, draw
->buffers
[LOADER_DRI3_FRONT_ID
]);
738 xcb_flush(draw
->conn
);
743 (draw
->ext
->flush
->invalidate
)(draw
->dri_drawable
);
749 loader_dri3_query_buffer_age(struct loader_dri3_drawable
*draw
)
751 int back_id
= LOADER_DRI3_BACK_ID(dri3_find_back(draw
));
753 if (back_id
< 0 || !draw
->buffers
[back_id
])
756 if (draw
->buffers
[back_id
]->last_swap
!= 0)
757 return draw
->send_sbc
- draw
->buffers
[back_id
]->last_swap
+ 1;
764 * Wrapper around xcb_dri3_open
767 loader_dri3_open(xcb_connection_t
*conn
,
771 xcb_dri3_open_cookie_t cookie
;
772 xcb_dri3_open_reply_t
*reply
;
775 cookie
= xcb_dri3_open(conn
,
779 reply
= xcb_dri3_open_reply(conn
, cookie
, NULL
);
783 if (reply
->nfd
!= 1) {
788 fd
= xcb_dri3_open_reply_fds(conn
, reply
)[0];
790 fcntl(fd
, F_SETFD
, fcntl(fd
, F_GETFD
) | FD_CLOEXEC
);
796 dri3_cpp_for_format(uint32_t format
) {
798 case __DRI_IMAGE_FORMAT_R8
:
800 case __DRI_IMAGE_FORMAT_RGB565
:
801 case __DRI_IMAGE_FORMAT_GR88
:
803 case __DRI_IMAGE_FORMAT_XRGB8888
:
804 case __DRI_IMAGE_FORMAT_ARGB8888
:
805 case __DRI_IMAGE_FORMAT_ABGR8888
:
806 case __DRI_IMAGE_FORMAT_XBGR8888
:
807 case __DRI_IMAGE_FORMAT_XRGB2101010
:
808 case __DRI_IMAGE_FORMAT_ARGB2101010
:
809 case __DRI_IMAGE_FORMAT_SARGB8
:
811 case __DRI_IMAGE_FORMAT_NONE
:
817 /** loader_dri3_alloc_render_buffer
819 * Use the driver createImage function to construct a __DRIimage, then
820 * get a file descriptor for that and create an X pixmap from that
822 * Allocate an xshmfence for synchronization
824 static struct loader_dri3_buffer
*
825 dri3_alloc_render_buffer(struct loader_dri3_drawable
*draw
, unsigned int format
,
826 int width
, int height
, int depth
)
828 struct loader_dri3_buffer
*buffer
;
829 __DRIimage
*pixmap_buffer
;
831 xcb_sync_fence_t sync_fence
;
832 struct xshmfence
*shm_fence
;
833 int buffer_fd
, fence_fd
;
836 /* Create an xshmfence object and
837 * prepare to send that to the X server
840 fence_fd
= xshmfence_alloc_shm();
844 shm_fence
= xshmfence_map_shm(fence_fd
);
845 if (shm_fence
== NULL
)
848 /* Allocate the image from the driver
850 buffer
= calloc(1, sizeof *buffer
);
854 buffer
->cpp
= dri3_cpp_for_format(format
);
858 if (!draw
->is_different_gpu
) {
859 buffer
->image
= (draw
->ext
->image
->createImage
)(draw
->dri_screen
,
862 __DRI_IMAGE_USE_SHARE
|
863 __DRI_IMAGE_USE_SCANOUT
|
864 __DRI_IMAGE_USE_BACKBUFFER
,
866 pixmap_buffer
= buffer
->image
;
871 buffer
->image
= (draw
->ext
->image
->createImage
)(draw
->dri_screen
,
880 buffer
->linear_buffer
=
881 (draw
->ext
->image
->createImage
)(draw
->dri_screen
,
882 width
, height
, format
,
883 __DRI_IMAGE_USE_SHARE
|
884 __DRI_IMAGE_USE_LINEAR
|
885 __DRI_IMAGE_USE_BACKBUFFER
,
887 pixmap_buffer
= buffer
->linear_buffer
;
889 if (!buffer
->linear_buffer
)
890 goto no_linear_buffer
;
893 /* X wants the stride, so ask the image for it
895 if (!(draw
->ext
->image
->queryImage
)(pixmap_buffer
, __DRI_IMAGE_ATTRIB_STRIDE
,
897 goto no_buffer_attrib
;
899 buffer
->pitch
= stride
;
901 if (!(draw
->ext
->image
->queryImage
)(pixmap_buffer
, __DRI_IMAGE_ATTRIB_FD
,
903 goto no_buffer_attrib
;
905 xcb_dri3_pixmap_from_buffer(draw
->conn
,
906 (pixmap
= xcb_generate_id(draw
->conn
)),
909 width
, height
, buffer
->pitch
,
910 depth
, buffer
->cpp
* 8,
913 xcb_dri3_fence_from_fd(draw
->conn
,
915 (sync_fence
= xcb_generate_id(draw
->conn
)),
919 buffer
->pixmap
= pixmap
;
920 buffer
->own_pixmap
= true;
921 buffer
->sync_fence
= sync_fence
;
922 buffer
->shm_fence
= shm_fence
;
923 buffer
->width
= width
;
924 buffer
->height
= height
;
926 /* Mark the buffer as idle
928 dri3_fence_set(buffer
);
933 (draw
->ext
->image
->destroyImage
)(pixmap_buffer
);
935 if (draw
->is_different_gpu
)
936 (draw
->ext
->image
->destroyImage
)(buffer
->image
);
940 xshmfence_unmap_shm(shm_fence
);
946 /** loader_dri3_update_drawable
948 * Called the first time we use the drawable and then
949 * after we receive present configure notify events to
950 * track the geometry of the drawable
953 dri3_update_drawable(__DRIdrawable
*driDrawable
,
954 struct loader_dri3_drawable
*draw
)
956 if (draw
->first_init
) {
957 xcb_get_geometry_cookie_t geom_cookie
;
958 xcb_get_geometry_reply_t
*geom_reply
;
959 xcb_void_cookie_t cookie
;
960 xcb_generic_error_t
*error
;
961 xcb_present_query_capabilities_cookie_t present_capabilities_cookie
;
962 xcb_present_query_capabilities_reply_t
*present_capabilities_reply
;
964 draw
->first_init
= false;
966 /* Try to select for input on the window.
968 * If the drawable is a window, this will get our events
971 * Otherwise, we'll get a BadWindow error back from this request which
972 * will let us know that the drawable is a pixmap instead.
975 draw
->eid
= xcb_generate_id(draw
->conn
);
977 xcb_present_select_input_checked(draw
->conn
, draw
->eid
, draw
->drawable
,
978 XCB_PRESENT_EVENT_MASK_CONFIGURE_NOTIFY
|
979 XCB_PRESENT_EVENT_MASK_COMPLETE_NOTIFY
|
980 XCB_PRESENT_EVENT_MASK_IDLE_NOTIFY
);
982 present_capabilities_cookie
=
983 xcb_present_query_capabilities(draw
->conn
, draw
->drawable
);
985 /* Create an XCB event queue to hold present events outside of the usual
986 * application event queue
988 draw
->special_event
= xcb_register_for_special_xge(draw
->conn
,
992 geom_cookie
= xcb_get_geometry(draw
->conn
, draw
->drawable
);
994 geom_reply
= xcb_get_geometry_reply(draw
->conn
, geom_cookie
, NULL
);
999 draw
->width
= geom_reply
->width
;
1000 draw
->height
= geom_reply
->height
;
1001 draw
->depth
= geom_reply
->depth
;
1002 draw
->vtable
->set_drawable_size(draw
, draw
->width
, draw
->height
);
1006 draw
->is_pixmap
= false;
1008 /* Check to see if our select input call failed. If it failed with a
1009 * BadWindow error, then assume the drawable is a pixmap. Destroy the
1010 * special event queue created above and mark the drawable as a pixmap
1013 error
= xcb_request_check(draw
->conn
, cookie
);
1015 present_capabilities_reply
=
1016 xcb_present_query_capabilities_reply(draw
->conn
,
1017 present_capabilities_cookie
,
1020 if (present_capabilities_reply
) {
1021 draw
->present_capabilities
= present_capabilities_reply
->capabilities
;
1022 free(present_capabilities_reply
);
1024 draw
->present_capabilities
= 0;
1027 if (error
->error_code
!= BadWindow
) {
1031 draw
->is_pixmap
= true;
1032 xcb_unregister_for_special_event(draw
->conn
, draw
->special_event
);
1033 draw
->special_event
= NULL
;
1036 dri3_flush_present_events(draw
);
1040 /* the DRIimage createImage function takes __DRI_IMAGE_FORMAT codes, while
1041 * the createImageFromFds call takes __DRI_IMAGE_FOURCC codes. To avoid
1042 * complete confusion, just deal in __DRI_IMAGE_FORMAT codes for now and
1043 * translate to __DRI_IMAGE_FOURCC codes in the call to createImageFromFds
1046 image_format_to_fourcc(int format
)
1049 /* Convert from __DRI_IMAGE_FORMAT to __DRI_IMAGE_FOURCC (sigh) */
1051 case __DRI_IMAGE_FORMAT_SARGB8
: return __DRI_IMAGE_FOURCC_SARGB8888
;
1052 case __DRI_IMAGE_FORMAT_RGB565
: return __DRI_IMAGE_FOURCC_RGB565
;
1053 case __DRI_IMAGE_FORMAT_XRGB8888
: return __DRI_IMAGE_FOURCC_XRGB8888
;
1054 case __DRI_IMAGE_FORMAT_ARGB8888
: return __DRI_IMAGE_FOURCC_ARGB8888
;
1055 case __DRI_IMAGE_FORMAT_ABGR8888
: return __DRI_IMAGE_FOURCC_ABGR8888
;
1056 case __DRI_IMAGE_FORMAT_XBGR8888
: return __DRI_IMAGE_FOURCC_XBGR8888
;
1062 loader_dri3_create_image(xcb_connection_t
*c
,
1063 xcb_dri3_buffer_from_pixmap_reply_t
*bp_reply
,
1064 unsigned int format
,
1065 __DRIscreen
*dri_screen
,
1066 const __DRIimageExtension
*image
,
1067 void *loaderPrivate
)
1070 __DRIimage
*image_planar
, *ret
;
1073 /* Get an FD for the pixmap object
1075 fds
= xcb_dri3_buffer_from_pixmap_reply_fds(c
, bp_reply
);
1077 stride
= bp_reply
->stride
;
1080 /* createImageFromFds creates a wrapper __DRIimage structure which
1081 * can deal with multiple planes for things like Yuv images. So, once
1082 * we've gotten the planar wrapper, pull the single plane out of it and
1083 * discard the wrapper.
1085 image_planar
= (image
->createImageFromFds
)(dri_screen
,
1088 image_format_to_fourcc(format
),
1090 &stride
, &offset
, loaderPrivate
);
1095 ret
= (image
->fromPlanar
)(image_planar
, 0, loaderPrivate
);
1097 (image
->destroyImage
)(image_planar
);
1102 /** dri3_get_pixmap_buffer
1104 * Get the DRM object for a pixmap from the X server and
1105 * wrap that with a __DRIimage structure using createImageFromFds
1107 static struct loader_dri3_buffer
*
1108 dri3_get_pixmap_buffer(__DRIdrawable
*driDrawable
, unsigned int format
,
1109 enum loader_dri3_buffer_type buffer_type
,
1110 struct loader_dri3_drawable
*draw
)
1112 int buf_id
= loader_dri3_pixmap_buf_id(buffer_type
);
1113 struct loader_dri3_buffer
*buffer
= draw
->buffers
[buf_id
];
1114 xcb_drawable_t pixmap
;
1115 xcb_dri3_buffer_from_pixmap_cookie_t bp_cookie
;
1116 xcb_dri3_buffer_from_pixmap_reply_t
*bp_reply
;
1117 xcb_sync_fence_t sync_fence
;
1118 struct xshmfence
*shm_fence
;
1120 __DRIscreen
*cur_screen
;
1125 pixmap
= draw
->drawable
;
1127 buffer
= calloc(1, sizeof *buffer
);
1131 fence_fd
= xshmfence_alloc_shm();
1134 shm_fence
= xshmfence_map_shm(fence_fd
);
1135 if (shm_fence
== NULL
) {
1140 xcb_dri3_fence_from_fd(draw
->conn
,
1142 (sync_fence
= xcb_generate_id(draw
->conn
)),
1146 bp_cookie
= xcb_dri3_buffer_from_pixmap(draw
->conn
, pixmap
);
1147 bp_reply
= xcb_dri3_buffer_from_pixmap_reply(draw
->conn
, bp_cookie
, NULL
);
1151 /* Get the currently-bound screen or revert to using the drawable's screen if
1152 * no contexts are currently bound. The latter case is at least necessary for
1153 * obs-studio, when using Window Capture (Xcomposite) as a Source.
1155 cur_screen
= draw
->vtable
->get_dri_screen(draw
);
1157 cur_screen
= draw
->dri_screen
;
1160 buffer
->image
= loader_dri3_create_image(draw
->conn
, bp_reply
, format
,
1161 cur_screen
, draw
->ext
->image
,
1166 buffer
->pixmap
= pixmap
;
1167 buffer
->own_pixmap
= false;
1168 buffer
->width
= bp_reply
->width
;
1169 buffer
->height
= bp_reply
->height
;
1170 buffer
->buffer_type
= buffer_type
;
1171 buffer
->shm_fence
= shm_fence
;
1172 buffer
->sync_fence
= sync_fence
;
1174 draw
->buffers
[buf_id
] = buffer
;
1182 xcb_sync_destroy_fence(draw
->conn
, sync_fence
);
1183 xshmfence_unmap_shm(shm_fence
);
1192 * Find a front or back buffer, allocating new ones as necessary
1194 static struct loader_dri3_buffer
*
1195 dri3_get_buffer(__DRIdrawable
*driDrawable
,
1196 unsigned int format
,
1197 enum loader_dri3_buffer_type buffer_type
,
1198 struct loader_dri3_drawable
*draw
)
1200 struct loader_dri3_buffer
*buffer
;
1202 __DRIcontext
*dri_context
;
1204 dri_context
= draw
->vtable
->get_dri_context(draw
);
1206 if (buffer_type
== loader_dri3_buffer_back
) {
1207 buf_id
= dri3_find_back(draw
);
1212 buf_id
= LOADER_DRI3_FRONT_ID
;
1215 buffer
= draw
->buffers
[buf_id
];
1217 /* Allocate a new buffer if there isn't an old one, or if that
1218 * old one is the wrong size
1220 if (!buffer
|| buffer
->width
!= draw
->width
||
1221 buffer
->height
!= draw
->height
) {
1222 struct loader_dri3_buffer
*new_buffer
;
1224 /* Allocate the new buffers
1226 new_buffer
= dri3_alloc_render_buffer(draw
,
1234 /* When resizing, copy the contents of the old buffer, waiting for that
1235 * copy to complete using our fences before proceeding
1237 switch (buffer_type
) {
1238 case loader_dri3_buffer_back
:
1240 if (!buffer
->linear_buffer
) {
1241 dri3_fence_reset(draw
->conn
, new_buffer
);
1242 dri3_fence_await(draw
->conn
, buffer
);
1243 dri3_copy_area(draw
->conn
,
1246 dri3_drawable_gc(draw
),
1248 draw
->width
, draw
->height
);
1249 dri3_fence_trigger(draw
->conn
, new_buffer
);
1250 } else if (draw
->vtable
->in_current_context(draw
)) {
1251 draw
->ext
->image
->blitImage(dri_context
,
1254 0, 0, draw
->width
, draw
->height
,
1255 0, 0, draw
->width
, draw
->height
, 0);
1257 dri3_free_render_buffer(draw
, buffer
);
1260 case loader_dri3_buffer_front
:
1261 dri3_fence_reset(draw
->conn
, new_buffer
);
1262 dri3_copy_area(draw
->conn
,
1265 dri3_drawable_gc(draw
),
1267 draw
->width
, draw
->height
);
1268 dri3_fence_trigger(draw
->conn
, new_buffer
);
1270 if (new_buffer
->linear_buffer
&&
1271 draw
->vtable
->in_current_context(draw
)) {
1272 dri3_fence_await(draw
->conn
, new_buffer
);
1273 draw
->ext
->image
->blitImage(dri_context
,
1275 new_buffer
->linear_buffer
,
1276 0, 0, draw
->width
, draw
->height
,
1277 0, 0, draw
->width
, draw
->height
, 0);
1281 buffer
= new_buffer
;
1282 buffer
->buffer_type
= buffer_type
;
1283 draw
->buffers
[buf_id
] = buffer
;
1285 dri3_fence_await(draw
->conn
, buffer
);
1287 /* Return the requested buffer */
1291 /** dri3_free_buffers
1293 * Free the front bufffer or all of the back buffers. Used
1294 * when the application changes which buffers it needs
1297 dri3_free_buffers(__DRIdrawable
*driDrawable
,
1298 enum loader_dri3_buffer_type buffer_type
,
1299 struct loader_dri3_drawable
*draw
)
1301 struct loader_dri3_buffer
*buffer
;
1306 switch (buffer_type
) {
1307 case loader_dri3_buffer_back
:
1308 first_id
= LOADER_DRI3_BACK_ID(0);
1309 n_id
= LOADER_DRI3_MAX_BACK
;
1311 case loader_dri3_buffer_front
:
1312 first_id
= LOADER_DRI3_FRONT_ID
;
1316 for (buf_id
= first_id
; buf_id
< first_id
+ n_id
; buf_id
++) {
1317 buffer
= draw
->buffers
[buf_id
];
1319 dri3_free_render_buffer(draw
, buffer
);
1320 draw
->buffers
[buf_id
] = NULL
;
1325 /** loader_dri3_get_buffers
1327 * The published buffer allocation API.
1328 * Returns all of the necessary buffers, allocating
1332 loader_dri3_get_buffers(__DRIdrawable
*driDrawable
,
1333 unsigned int format
,
1335 void *loaderPrivate
,
1336 uint32_t buffer_mask
,
1337 struct __DRIimageList
*buffers
)
1339 struct loader_dri3_drawable
*draw
= loaderPrivate
;
1340 struct loader_dri3_buffer
*front
, *back
;
1342 buffers
->image_mask
= 0;
1343 buffers
->front
= NULL
;
1344 buffers
->back
= NULL
;
1349 if (!dri3_update_drawable(driDrawable
, draw
))
1352 /* pixmaps always have front buffers */
1353 if (draw
->is_pixmap
)
1354 buffer_mask
|= __DRI_IMAGE_BUFFER_FRONT
;
1356 if (buffer_mask
& __DRI_IMAGE_BUFFER_FRONT
) {
1357 /* All pixmaps are owned by the server gpu.
1358 * When we use a different gpu, we can't use the pixmap
1359 * as buffer since it is potentially tiled a way
1360 * our device can't understand. In this case, use
1361 * a fake front buffer. Hopefully the pixmap
1362 * content will get synced with the fake front
1365 if (draw
->is_pixmap
&& !draw
->is_different_gpu
)
1366 front
= dri3_get_pixmap_buffer(driDrawable
,
1368 loader_dri3_buffer_front
,
1371 front
= dri3_get_buffer(driDrawable
,
1373 loader_dri3_buffer_front
,
1379 dri3_free_buffers(driDrawable
, loader_dri3_buffer_front
, draw
);
1380 draw
->have_fake_front
= 0;
1383 if (buffer_mask
& __DRI_IMAGE_BUFFER_BACK
) {
1384 back
= dri3_get_buffer(driDrawable
,
1386 loader_dri3_buffer_back
,
1390 draw
->have_back
= 1;
1392 dri3_free_buffers(driDrawable
, loader_dri3_buffer_back
, draw
);
1393 draw
->have_back
= 0;
1397 buffers
->image_mask
|= __DRI_IMAGE_BUFFER_FRONT
;
1398 buffers
->front
= front
->image
;
1399 draw
->have_fake_front
= draw
->is_different_gpu
|| !draw
->is_pixmap
;
1403 buffers
->image_mask
|= __DRI_IMAGE_BUFFER_BACK
;
1404 buffers
->back
= back
->image
;
1407 draw
->stamp
= stamp
;