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 draw
->vtable
->set_swap_interval(draw
, interval
);
81 dri3_update_num_back(draw
);
84 /** dri3_free_render_buffer
86 * Free everything associated with one render buffer including pixmap, fence
87 * stuff and the driver image
90 dri3_free_render_buffer(struct loader_dri3_drawable
*draw
,
91 struct loader_dri3_buffer
*buffer
)
93 if (buffer
->own_pixmap
)
94 xcb_free_pixmap(draw
->conn
, buffer
->pixmap
);
95 xcb_sync_destroy_fence(draw
->conn
, buffer
->sync_fence
);
96 xshmfence_unmap_shm(buffer
->shm_fence
);
97 draw
->ext
->image
->destroyImage(buffer
->image
);
98 if (buffer
->linear_buffer
)
99 draw
->ext
->image
->destroyImage(buffer
->linear_buffer
);
104 loader_dri3_drawable_fini(struct loader_dri3_drawable
*draw
)
108 draw
->ext
->core
->destroyDrawable(draw
->dri_drawable
);
110 for (i
= 0; i
< LOADER_DRI3_NUM_BUFFERS
; i
++) {
111 if (draw
->buffers
[i
])
112 dri3_free_render_buffer(draw
, draw
->buffers
[i
]);
115 if (draw
->special_event
) {
116 xcb_void_cookie_t cookie
=
117 xcb_present_select_input_checked(draw
->conn
, draw
->eid
, draw
->drawable
,
118 XCB_PRESENT_EVENT_MASK_NO_EVENT
);
120 xcb_discard_reply(draw
->conn
, cookie
.sequence
);
121 xcb_unregister_for_special_event(draw
->conn
, draw
->special_event
);
126 loader_dri3_drawable_init(xcb_connection_t
*conn
,
127 xcb_drawable_t drawable
,
128 __DRIscreen
*dri_screen
,
129 bool is_different_gpu
,
130 const __DRIconfig
*dri_config
,
131 struct loader_dri3_extensions
*ext
,
132 const struct loader_dri3_vtable
*vtable
,
133 struct loader_dri3_drawable
*draw
)
135 xcb_get_geometry_cookie_t cookie
;
136 xcb_get_geometry_reply_t
*reply
;
137 xcb_generic_error_t
*error
;
138 GLint vblank_mode
= DRI_CONF_VBLANK_DEF_INTERVAL_1
;
143 draw
->vtable
= vtable
;
144 draw
->drawable
= drawable
;
145 draw
->dri_screen
= dri_screen
;
146 draw
->is_different_gpu
= is_different_gpu
;
149 draw
->have_fake_front
= 0;
150 draw
->first_init
= true;
152 if (draw
->ext
->config
)
153 draw
->ext
->config
->configQueryi(draw
->dri_screen
,
154 "vblank_mode", &vblank_mode
);
156 switch (vblank_mode
) {
157 case DRI_CONF_VBLANK_NEVER
:
158 case DRI_CONF_VBLANK_DEF_INTERVAL_0
:
161 case DRI_CONF_VBLANK_DEF_INTERVAL_1
:
162 case DRI_CONF_VBLANK_ALWAYS_SYNC
:
167 draw
->vtable
->set_swap_interval(draw
, swap_interval
);
169 dri3_update_num_back(draw
);
171 /* Create a new drawable */
173 draw
->ext
->image_driver
->createNewDrawable(dri_screen
,
177 if (!draw
->dri_drawable
)
180 cookie
= xcb_get_geometry(draw
->conn
, draw
->drawable
);
181 reply
= xcb_get_geometry_reply(draw
->conn
, cookie
, &error
);
182 if (reply
== NULL
|| error
!= NULL
) {
183 draw
->ext
->core
->destroyDrawable(draw
->dri_drawable
);
187 draw
->width
= reply
->width
;
188 draw
->height
= reply
->height
;
189 draw
->depth
= reply
->depth
;
190 draw
->vtable
->set_drawable_size(draw
, draw
->width
, draw
->height
);
194 * Make sure server has the same swap interval we do for the new
197 loader_dri3_set_swap_interval(draw
, swap_interval
);
203 * Process one Present event
206 dri3_handle_present_event(struct loader_dri3_drawable
*draw
,
207 xcb_present_generic_event_t
*ge
)
209 switch (ge
->evtype
) {
210 case XCB_PRESENT_CONFIGURE_NOTIFY
: {
211 xcb_present_configure_notify_event_t
*ce
= (void *) ge
;
213 draw
->width
= ce
->width
;
214 draw
->height
= ce
->height
;
215 draw
->vtable
->set_drawable_size(draw
, draw
->width
, draw
->height
);
218 case XCB_PRESENT_COMPLETE_NOTIFY
: {
219 xcb_present_complete_notify_event_t
*ce
= (void *) ge
;
221 /* Compute the processed SBC number from the received 32-bit serial number
222 * merged with the upper 32-bits of the sent 64-bit serial number while
225 if (ce
->kind
== XCB_PRESENT_COMPLETE_KIND_PIXMAP
) {
226 draw
->recv_sbc
= (draw
->send_sbc
& 0xffffffff00000000LL
) | ce
->serial
;
227 if (draw
->recv_sbc
> draw
->send_sbc
)
228 draw
->recv_sbc
-= 0x100000000;
230 case XCB_PRESENT_COMPLETE_MODE_FLIP
:
231 draw
->flipping
= true;
233 case XCB_PRESENT_COMPLETE_MODE_COPY
:
234 draw
->flipping
= false;
237 dri3_update_num_back(draw
);
239 if (draw
->vtable
->show_fps
)
240 draw
->vtable
->show_fps(draw
, ce
->ust
);
245 draw
->recv_msc_serial
= ce
->serial
;
246 draw
->notify_ust
= ce
->ust
;
247 draw
->notify_msc
= ce
->msc
;
251 case XCB_PRESENT_EVENT_IDLE_NOTIFY
: {
252 xcb_present_idle_notify_event_t
*ie
= (void *) ge
;
255 for (b
= 0; b
< sizeof(draw
->buffers
) / sizeof(draw
->buffers
[0]); b
++) {
256 struct loader_dri3_buffer
*buf
= draw
->buffers
[b
];
258 if (buf
&& buf
->pixmap
== ie
->pixmap
) {
260 if (draw
->num_back
<= b
&& b
< LOADER_DRI3_MAX_BACK
) {
261 dri3_free_render_buffer(draw
, buf
);
262 draw
->buffers
[b
] = NULL
;
274 dri3_wait_for_event(struct loader_dri3_drawable
*draw
)
276 xcb_generic_event_t
*ev
;
277 xcb_present_generic_event_t
*ge
;
279 xcb_flush(draw
->conn
);
280 ev
= xcb_wait_for_special_event(draw
->conn
, draw
->special_event
);
284 dri3_handle_present_event(draw
, ge
);
288 /** loader_dri3_wait_for_msc
290 * Get the X server to send an event when the target msc/divisor/remainder is
294 loader_dri3_wait_for_msc(struct loader_dri3_drawable
*draw
,
296 int64_t divisor
, int64_t remainder
,
297 int64_t *ust
, int64_t *msc
, int64_t *sbc
)
301 msc_serial
= ++draw
->send_msc_serial
;
302 xcb_present_notify_msc(draw
->conn
,
309 xcb_flush(draw
->conn
);
311 /* Wait for the event */
312 if (draw
->special_event
) {
313 while ((int32_t) (msc_serial
- draw
->recv_msc_serial
) > 0) {
314 if (!dri3_wait_for_event(draw
))
319 *ust
= draw
->notify_ust
;
320 *msc
= draw
->notify_msc
;
321 *sbc
= draw
->recv_sbc
;
326 /** loader_dri3_wait_for_sbc
328 * Wait for the completed swap buffer count to reach the specified
329 * target. Presumably the application knows that this will be reached with
330 * outstanding complete events, or we're going to be here awhile.
333 loader_dri3_wait_for_sbc(struct loader_dri3_drawable
*draw
,
334 int64_t target_sbc
, int64_t *ust
,
335 int64_t *msc
, int64_t *sbc
)
337 /* From the GLX_OML_sync_control spec:
339 * "If <target_sbc> = 0, the function will block until all previous
340 * swaps requested with glXSwapBuffersMscOML for that window have
344 target_sbc
= draw
->send_sbc
;
346 while (draw
->recv_sbc
< target_sbc
) {
347 if (!dri3_wait_for_event(draw
))
353 *sbc
= draw
->recv_sbc
;
357 /** loader_dri3_find_back
359 * Find an idle back buffer. If there isn't one, then
360 * wait for a present idle notify event from the X server
363 dri3_find_back(struct loader_dri3_drawable
*draw
)
366 xcb_generic_event_t
*ev
;
367 xcb_present_generic_event_t
*ge
;
370 for (b
= 0; b
< draw
->num_back
; b
++) {
371 int id
= LOADER_DRI3_BACK_ID((b
+ draw
->cur_back
) % draw
->num_back
);
372 struct loader_dri3_buffer
*buffer
= draw
->buffers
[id
];
374 if (!buffer
|| !buffer
->busy
) {
379 xcb_flush(draw
->conn
);
380 ev
= xcb_wait_for_special_event(draw
->conn
, draw
->special_event
);
384 dri3_handle_present_event(draw
, ge
);
388 static xcb_gcontext_t
389 dri3_drawable_gc(struct loader_dri3_drawable
*draw
)
393 xcb_create_gc(draw
->conn
,
394 (draw
->gc
= xcb_generate_id(draw
->conn
)),
396 XCB_GC_GRAPHICS_EXPOSURES
,
403 static struct loader_dri3_buffer
*
404 dri3_back_buffer(struct loader_dri3_drawable
*draw
)
406 return draw
->buffers
[LOADER_DRI3_BACK_ID(draw
->cur_back
)];
409 static struct loader_dri3_buffer
*
410 dri3_fake_front_buffer(struct loader_dri3_drawable
*draw
)
412 return draw
->buffers
[LOADER_DRI3_FRONT_ID
];
416 dri3_copy_area(xcb_connection_t
*c
,
417 xcb_drawable_t src_drawable
,
418 xcb_drawable_t dst_drawable
,
427 xcb_void_cookie_t cookie
;
429 cookie
= xcb_copy_area_checked(c
,
439 xcb_discard_reply(c
, cookie
.sequence
);
443 * Asks the driver to flush any queued work necessary for serializing with the
444 * X command stream, and optionally the slightly more strict requirement of
445 * glFlush() equivalence (which would require flushing even if nothing had
446 * been drawn to a window system framebuffer, for example).
449 loader_dri3_flush(struct loader_dri3_drawable
*draw
,
451 enum __DRI2throttleReason throttle_reason
)
453 /* NEED TO CHECK WHETHER CONTEXT IS NULL */
454 __DRIcontext
*dri_context
= draw
->vtable
->get_dri_context(draw
);
457 draw
->ext
->flush
->flush_with_flags(dri_context
, draw
->dri_drawable
,
458 flags
, throttle_reason
);
463 loader_dri3_copy_sub_buffer(struct loader_dri3_drawable
*draw
,
465 int width
, int height
,
468 struct loader_dri3_buffer
*back
;
469 unsigned flags
= __DRI2_FLUSH_DRAWABLE
;
470 __DRIcontext
*dri_context
;
472 dri_context
= draw
->vtable
->get_dri_context(draw
);
474 /* Check we have the right attachments */
475 if (!draw
->have_back
|| draw
->is_pixmap
)
479 flags
|= __DRI2_FLUSH_CONTEXT
;
480 loader_dri3_flush(draw
, flags
, __DRI2_THROTTLE_SWAPBUFFER
);
482 back
= dri3_back_buffer(draw
);
483 y
= draw
->height
- y
- height
;
485 if (draw
->is_different_gpu
&& draw
->vtable
->in_current_context(draw
)) {
486 /* Update the linear buffer part of the back buffer
487 * for the dri3_copy_area operation
489 draw
->ext
->image
->blitImage(dri_context
,
495 back
->height
, __BLIT_FLAG_FLUSH
);
496 /* We use blitImage to update our fake front,
498 if (draw
->have_fake_front
)
499 draw
->ext
->image
->blitImage(dri_context
,
500 dri3_fake_front_buffer(draw
)->image
,
503 x
, y
, width
, height
, __BLIT_FLAG_FLUSH
);
506 loader_dri3_swapbuffer_barrier(draw
);
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_swapbuffer_barrier(draw
);
599 loader_dri3_copy_drawable(draw
, draw
->drawable
, front
->pixmap
);
602 /** dri3_flush_present_events
604 * Process any present events that have been received from the X server
607 dri3_flush_present_events(struct loader_dri3_drawable
*draw
)
609 /* Check to see if any configuration changes have occurred
610 * since we were last invoked
612 if (draw
->special_event
) {
613 xcb_generic_event_t
*ev
;
615 while ((ev
= xcb_poll_for_special_event(draw
->conn
,
616 draw
->special_event
)) != NULL
) {
617 xcb_present_generic_event_t
*ge
= (void *) ev
;
618 dri3_handle_present_event(draw
, ge
);
623 /** loader_dri3_swap_buffers_msc
625 * Make the current back buffer visible using the present extension
628 loader_dri3_swap_buffers_msc(struct loader_dri3_drawable
*draw
,
629 int64_t target_msc
, int64_t divisor
,
630 int64_t remainder
, unsigned flush_flags
,
633 struct loader_dri3_buffer
*back
;
634 __DRIcontext
*dri_context
;
636 uint32_t options
= XCB_PRESENT_OPTION_NONE
;
639 dri_context
= draw
->vtable
->get_dri_context(draw
);
640 swap_interval
= draw
->vtable
->get_swap_interval(draw
);
642 draw
->vtable
->flush_drawable(draw
, flush_flags
);
644 back
= draw
->buffers
[dri3_find_back(draw
)];
645 if (draw
->is_different_gpu
&& back
) {
646 /* Update the linear buffer before presenting the pixmap */
647 draw
->ext
->image
->blitImage(dri_context
,
653 back
->height
, __BLIT_FLAG_FLUSH
);
654 /* Update the fake front */
655 if (draw
->have_fake_front
)
656 draw
->ext
->image
->blitImage(dri_context
,
657 draw
->buffers
[LOADER_DRI3_FRONT_ID
]->image
,
659 0, 0, draw
->width
, draw
->height
,
660 0, 0, draw
->width
, draw
->height
,
664 dri3_flush_present_events(draw
);
666 if (back
&& !draw
->is_pixmap
) {
667 dri3_fence_reset(draw
->conn
, back
);
669 /* Compute when we want the frame shown by taking the last known
670 * successful MSC and adding in a swap interval for each outstanding swap
671 * request. target_msc=divisor=remainder=0 means "Use glXSwapBuffers()
675 if (target_msc
== 0 && divisor
== 0 && remainder
== 0)
676 target_msc
= draw
->msc
+ swap_interval
*
677 (draw
->send_sbc
- draw
->recv_sbc
);
678 else if (divisor
== 0 && remainder
> 0) {
679 /* From the GLX_OML_sync_control spec:
680 * "If <divisor> = 0, the swap will occur when MSC becomes
681 * greater than or equal to <target_msc>."
683 * Note that there's no mention of the remainder. The Present
684 * extension throws BadValue for remainder != 0 with divisor == 0, so
685 * just drop the passed in value.
690 /* From the GLX_EXT_swap_control spec
691 * and the EGL 1.4 spec (page 53):
693 * "If <interval> is set to a value of 0, buffer swaps are not
694 * synchronized to a video frame."
696 * Implementation note: It is possible to enable triple buffering
697 * behaviour by not using XCB_PRESENT_OPTION_ASYNC, but this should not be
700 if (swap_interval
== 0)
701 options
|= XCB_PRESENT_OPTION_ASYNC
;
703 options
|= XCB_PRESENT_OPTION_COPY
;
706 back
->last_swap
= draw
->send_sbc
;
707 xcb_present_pixmap(draw
->conn
,
710 (uint32_t) draw
->send_sbc
,
715 None
, /* target_crtc */
722 ret
= (int64_t) draw
->send_sbc
;
724 /* If there's a fake front, then copy the source back buffer
725 * to the fake front to keep it up to date. This needs
726 * to reset the fence and make future users block until
727 * the X server is done copying the bits
729 if (draw
->have_fake_front
&& !draw
->is_different_gpu
) {
730 dri3_fence_reset(draw
->conn
, draw
->buffers
[LOADER_DRI3_FRONT_ID
]);
731 dri3_copy_area(draw
->conn
,
733 draw
->buffers
[LOADER_DRI3_FRONT_ID
]->pixmap
,
734 dri3_drawable_gc(draw
),
736 draw
->width
, draw
->height
);
737 dri3_fence_trigger(draw
->conn
, draw
->buffers
[LOADER_DRI3_FRONT_ID
]);
739 xcb_flush(draw
->conn
);
744 draw
->ext
->flush
->invalidate(draw
->dri_drawable
);
750 loader_dri3_query_buffer_age(struct loader_dri3_drawable
*draw
)
752 int back_id
= LOADER_DRI3_BACK_ID(dri3_find_back(draw
));
754 if (back_id
< 0 || !draw
->buffers
[back_id
])
757 if (draw
->buffers
[back_id
]->last_swap
!= 0)
758 return draw
->send_sbc
- draw
->buffers
[back_id
]->last_swap
+ 1;
765 * Wrapper around xcb_dri3_open
768 loader_dri3_open(xcb_connection_t
*conn
,
772 xcb_dri3_open_cookie_t cookie
;
773 xcb_dri3_open_reply_t
*reply
;
776 cookie
= xcb_dri3_open(conn
,
780 reply
= xcb_dri3_open_reply(conn
, cookie
, NULL
);
784 if (reply
->nfd
!= 1) {
789 fd
= xcb_dri3_open_reply_fds(conn
, reply
)[0];
791 fcntl(fd
, F_SETFD
, fcntl(fd
, F_GETFD
) | FD_CLOEXEC
);
797 dri3_cpp_for_format(uint32_t format
) {
799 case __DRI_IMAGE_FORMAT_R8
:
801 case __DRI_IMAGE_FORMAT_RGB565
:
802 case __DRI_IMAGE_FORMAT_GR88
:
804 case __DRI_IMAGE_FORMAT_XRGB8888
:
805 case __DRI_IMAGE_FORMAT_ARGB8888
:
806 case __DRI_IMAGE_FORMAT_ABGR8888
:
807 case __DRI_IMAGE_FORMAT_XBGR8888
:
808 case __DRI_IMAGE_FORMAT_XRGB2101010
:
809 case __DRI_IMAGE_FORMAT_ARGB2101010
:
810 case __DRI_IMAGE_FORMAT_SARGB8
:
812 case __DRI_IMAGE_FORMAT_NONE
:
818 /** loader_dri3_alloc_render_buffer
820 * Use the driver createImage function to construct a __DRIimage, then
821 * get a file descriptor for that and create an X pixmap from that
823 * Allocate an xshmfence for synchronization
825 static struct loader_dri3_buffer
*
826 dri3_alloc_render_buffer(struct loader_dri3_drawable
*draw
, unsigned int format
,
827 int width
, int height
, int depth
)
829 struct loader_dri3_buffer
*buffer
;
830 __DRIimage
*pixmap_buffer
;
832 xcb_sync_fence_t sync_fence
;
833 struct xshmfence
*shm_fence
;
834 int buffer_fd
, fence_fd
;
837 /* Create an xshmfence object and
838 * prepare to send that to the X server
841 fence_fd
= xshmfence_alloc_shm();
845 shm_fence
= xshmfence_map_shm(fence_fd
);
846 if (shm_fence
== NULL
)
849 /* Allocate the image from the driver
851 buffer
= calloc(1, sizeof *buffer
);
855 buffer
->cpp
= dri3_cpp_for_format(format
);
859 if (!draw
->is_different_gpu
) {
860 buffer
->image
= draw
->ext
->image
->createImage(draw
->dri_screen
,
863 __DRI_IMAGE_USE_SHARE
|
864 __DRI_IMAGE_USE_SCANOUT
|
865 __DRI_IMAGE_USE_BACKBUFFER
,
867 pixmap_buffer
= buffer
->image
;
872 buffer
->image
= draw
->ext
->image
->createImage(draw
->dri_screen
,
881 buffer
->linear_buffer
=
882 draw
->ext
->image
->createImage(draw
->dri_screen
,
883 width
, height
, format
,
884 __DRI_IMAGE_USE_SHARE
|
885 __DRI_IMAGE_USE_LINEAR
|
886 __DRI_IMAGE_USE_BACKBUFFER
,
888 pixmap_buffer
= buffer
->linear_buffer
;
890 if (!buffer
->linear_buffer
)
891 goto no_linear_buffer
;
894 /* X wants the stride, so ask the image for it
896 if (!draw
->ext
->image
->queryImage(pixmap_buffer
, __DRI_IMAGE_ATTRIB_STRIDE
,
898 goto no_buffer_attrib
;
900 buffer
->pitch
= stride
;
902 if (!draw
->ext
->image
->queryImage(pixmap_buffer
, __DRI_IMAGE_ATTRIB_FD
,
904 goto no_buffer_attrib
;
906 xcb_dri3_pixmap_from_buffer(draw
->conn
,
907 (pixmap
= xcb_generate_id(draw
->conn
)),
910 width
, height
, buffer
->pitch
,
911 depth
, buffer
->cpp
* 8,
914 xcb_dri3_fence_from_fd(draw
->conn
,
916 (sync_fence
= xcb_generate_id(draw
->conn
)),
920 buffer
->pixmap
= pixmap
;
921 buffer
->own_pixmap
= true;
922 buffer
->sync_fence
= sync_fence
;
923 buffer
->shm_fence
= shm_fence
;
924 buffer
->width
= width
;
925 buffer
->height
= height
;
927 /* Mark the buffer as idle
929 dri3_fence_set(buffer
);
934 draw
->ext
->image
->destroyImage(pixmap_buffer
);
936 if (draw
->is_different_gpu
)
937 draw
->ext
->image
->destroyImage(buffer
->image
);
941 xshmfence_unmap_shm(shm_fence
);
947 /** loader_dri3_update_drawable
949 * Called the first time we use the drawable and then
950 * after we receive present configure notify events to
951 * track the geometry of the drawable
954 dri3_update_drawable(__DRIdrawable
*driDrawable
,
955 struct loader_dri3_drawable
*draw
)
957 if (draw
->first_init
) {
958 xcb_get_geometry_cookie_t geom_cookie
;
959 xcb_get_geometry_reply_t
*geom_reply
;
960 xcb_void_cookie_t cookie
;
961 xcb_generic_error_t
*error
;
962 xcb_present_query_capabilities_cookie_t present_capabilities_cookie
;
963 xcb_present_query_capabilities_reply_t
*present_capabilities_reply
;
965 draw
->first_init
= false;
967 /* Try to select for input on the window.
969 * If the drawable is a window, this will get our events
972 * Otherwise, we'll get a BadWindow error back from this request which
973 * will let us know that the drawable is a pixmap instead.
976 draw
->eid
= xcb_generate_id(draw
->conn
);
978 xcb_present_select_input_checked(draw
->conn
, draw
->eid
, draw
->drawable
,
979 XCB_PRESENT_EVENT_MASK_CONFIGURE_NOTIFY
|
980 XCB_PRESENT_EVENT_MASK_COMPLETE_NOTIFY
|
981 XCB_PRESENT_EVENT_MASK_IDLE_NOTIFY
);
983 present_capabilities_cookie
=
984 xcb_present_query_capabilities(draw
->conn
, draw
->drawable
);
986 /* Create an XCB event queue to hold present events outside of the usual
987 * application event queue
989 draw
->special_event
= xcb_register_for_special_xge(draw
->conn
,
993 geom_cookie
= xcb_get_geometry(draw
->conn
, draw
->drawable
);
995 geom_reply
= xcb_get_geometry_reply(draw
->conn
, geom_cookie
, NULL
);
1000 draw
->width
= geom_reply
->width
;
1001 draw
->height
= geom_reply
->height
;
1002 draw
->depth
= geom_reply
->depth
;
1003 draw
->vtable
->set_drawable_size(draw
, draw
->width
, draw
->height
);
1007 draw
->is_pixmap
= false;
1009 /* Check to see if our select input call failed. If it failed with a
1010 * BadWindow error, then assume the drawable is a pixmap. Destroy the
1011 * special event queue created above and mark the drawable as a pixmap
1014 error
= xcb_request_check(draw
->conn
, cookie
);
1016 present_capabilities_reply
=
1017 xcb_present_query_capabilities_reply(draw
->conn
,
1018 present_capabilities_cookie
,
1021 if (present_capabilities_reply
) {
1022 draw
->present_capabilities
= present_capabilities_reply
->capabilities
;
1023 free(present_capabilities_reply
);
1025 draw
->present_capabilities
= 0;
1028 if (error
->error_code
!= BadWindow
) {
1032 draw
->is_pixmap
= true;
1033 xcb_unregister_for_special_event(draw
->conn
, draw
->special_event
);
1034 draw
->special_event
= NULL
;
1037 dri3_flush_present_events(draw
);
1041 /* the DRIimage createImage function takes __DRI_IMAGE_FORMAT codes, while
1042 * the createImageFromFds call takes __DRI_IMAGE_FOURCC codes. To avoid
1043 * complete confusion, just deal in __DRI_IMAGE_FORMAT codes for now and
1044 * translate to __DRI_IMAGE_FOURCC codes in the call to createImageFromFds
1047 image_format_to_fourcc(int format
)
1050 /* Convert from __DRI_IMAGE_FORMAT to __DRI_IMAGE_FOURCC (sigh) */
1052 case __DRI_IMAGE_FORMAT_SARGB8
: return __DRI_IMAGE_FOURCC_SARGB8888
;
1053 case __DRI_IMAGE_FORMAT_RGB565
: return __DRI_IMAGE_FOURCC_RGB565
;
1054 case __DRI_IMAGE_FORMAT_XRGB8888
: return __DRI_IMAGE_FOURCC_XRGB8888
;
1055 case __DRI_IMAGE_FORMAT_ARGB8888
: return __DRI_IMAGE_FOURCC_ARGB8888
;
1056 case __DRI_IMAGE_FORMAT_ABGR8888
: return __DRI_IMAGE_FOURCC_ABGR8888
;
1057 case __DRI_IMAGE_FORMAT_XBGR8888
: return __DRI_IMAGE_FOURCC_XBGR8888
;
1063 loader_dri3_create_image(xcb_connection_t
*c
,
1064 xcb_dri3_buffer_from_pixmap_reply_t
*bp_reply
,
1065 unsigned int format
,
1066 __DRIscreen
*dri_screen
,
1067 const __DRIimageExtension
*image
,
1068 void *loaderPrivate
)
1071 __DRIimage
*image_planar
, *ret
;
1074 /* Get an FD for the pixmap object
1076 fds
= xcb_dri3_buffer_from_pixmap_reply_fds(c
, bp_reply
);
1078 stride
= bp_reply
->stride
;
1081 /* createImageFromFds creates a wrapper __DRIimage structure which
1082 * can deal with multiple planes for things like Yuv images. So, once
1083 * we've gotten the planar wrapper, pull the single plane out of it and
1084 * discard the wrapper.
1086 image_planar
= image
->createImageFromFds(dri_screen
,
1089 image_format_to_fourcc(format
),
1091 &stride
, &offset
, loaderPrivate
);
1096 ret
= image
->fromPlanar(image_planar
, 0, loaderPrivate
);
1098 image
->destroyImage(image_planar
);
1103 /** dri3_get_pixmap_buffer
1105 * Get the DRM object for a pixmap from the X server and
1106 * wrap that with a __DRIimage structure using createImageFromFds
1108 static struct loader_dri3_buffer
*
1109 dri3_get_pixmap_buffer(__DRIdrawable
*driDrawable
, unsigned int format
,
1110 enum loader_dri3_buffer_type buffer_type
,
1111 struct loader_dri3_drawable
*draw
)
1113 int buf_id
= loader_dri3_pixmap_buf_id(buffer_type
);
1114 struct loader_dri3_buffer
*buffer
= draw
->buffers
[buf_id
];
1115 xcb_drawable_t pixmap
;
1116 xcb_dri3_buffer_from_pixmap_cookie_t bp_cookie
;
1117 xcb_dri3_buffer_from_pixmap_reply_t
*bp_reply
;
1118 xcb_sync_fence_t sync_fence
;
1119 struct xshmfence
*shm_fence
;
1121 __DRIscreen
*cur_screen
;
1126 pixmap
= draw
->drawable
;
1128 buffer
= calloc(1, sizeof *buffer
);
1132 fence_fd
= xshmfence_alloc_shm();
1135 shm_fence
= xshmfence_map_shm(fence_fd
);
1136 if (shm_fence
== NULL
) {
1141 xcb_dri3_fence_from_fd(draw
->conn
,
1143 (sync_fence
= xcb_generate_id(draw
->conn
)),
1147 bp_cookie
= xcb_dri3_buffer_from_pixmap(draw
->conn
, pixmap
);
1148 bp_reply
= xcb_dri3_buffer_from_pixmap_reply(draw
->conn
, bp_cookie
, NULL
);
1152 /* Get the currently-bound screen or revert to using the drawable's screen if
1153 * no contexts are currently bound. The latter case is at least necessary for
1154 * obs-studio, when using Window Capture (Xcomposite) as a Source.
1156 cur_screen
= draw
->vtable
->get_dri_screen(draw
);
1158 cur_screen
= draw
->dri_screen
;
1161 buffer
->image
= loader_dri3_create_image(draw
->conn
, bp_reply
, format
,
1162 cur_screen
, draw
->ext
->image
,
1167 buffer
->pixmap
= pixmap
;
1168 buffer
->own_pixmap
= false;
1169 buffer
->width
= bp_reply
->width
;
1170 buffer
->height
= bp_reply
->height
;
1171 buffer
->buffer_type
= buffer_type
;
1172 buffer
->shm_fence
= shm_fence
;
1173 buffer
->sync_fence
= sync_fence
;
1175 draw
->buffers
[buf_id
] = buffer
;
1183 xcb_sync_destroy_fence(draw
->conn
, sync_fence
);
1184 xshmfence_unmap_shm(shm_fence
);
1193 * Find a front or back buffer, allocating new ones as necessary
1195 static struct loader_dri3_buffer
*
1196 dri3_get_buffer(__DRIdrawable
*driDrawable
,
1197 unsigned int format
,
1198 enum loader_dri3_buffer_type buffer_type
,
1199 struct loader_dri3_drawable
*draw
)
1201 struct loader_dri3_buffer
*buffer
;
1203 __DRIcontext
*dri_context
;
1205 dri_context
= draw
->vtable
->get_dri_context(draw
);
1207 if (buffer_type
== loader_dri3_buffer_back
) {
1208 buf_id
= dri3_find_back(draw
);
1213 buf_id
= LOADER_DRI3_FRONT_ID
;
1216 buffer
= draw
->buffers
[buf_id
];
1218 /* Allocate a new buffer if there isn't an old one, or if that
1219 * old one is the wrong size
1221 if (!buffer
|| buffer
->width
!= draw
->width
||
1222 buffer
->height
!= draw
->height
) {
1223 struct loader_dri3_buffer
*new_buffer
;
1225 /* Allocate the new buffers
1227 new_buffer
= dri3_alloc_render_buffer(draw
,
1235 /* When resizing, copy the contents of the old buffer, waiting for that
1236 * copy to complete using our fences before proceeding
1238 switch (buffer_type
) {
1239 case loader_dri3_buffer_back
:
1241 if (!buffer
->linear_buffer
) {
1242 dri3_fence_reset(draw
->conn
, new_buffer
);
1243 dri3_fence_await(draw
->conn
, buffer
);
1244 dri3_copy_area(draw
->conn
,
1247 dri3_drawable_gc(draw
),
1249 draw
->width
, draw
->height
);
1250 dri3_fence_trigger(draw
->conn
, new_buffer
);
1251 } else if (draw
->vtable
->in_current_context(draw
)) {
1252 draw
->ext
->image
->blitImage(dri_context
,
1255 0, 0, draw
->width
, draw
->height
,
1256 0, 0, draw
->width
, draw
->height
, 0);
1258 dri3_free_render_buffer(draw
, buffer
);
1261 case loader_dri3_buffer_front
:
1262 loader_dri3_swapbuffer_barrier(draw
);
1263 dri3_fence_reset(draw
->conn
, new_buffer
);
1264 dri3_copy_area(draw
->conn
,
1267 dri3_drawable_gc(draw
),
1269 draw
->width
, draw
->height
);
1270 dri3_fence_trigger(draw
->conn
, new_buffer
);
1272 if (new_buffer
->linear_buffer
&&
1273 draw
->vtable
->in_current_context(draw
)) {
1274 dri3_fence_await(draw
->conn
, new_buffer
);
1275 draw
->ext
->image
->blitImage(dri_context
,
1277 new_buffer
->linear_buffer
,
1278 0, 0, draw
->width
, draw
->height
,
1279 0, 0, draw
->width
, draw
->height
, 0);
1283 buffer
= new_buffer
;
1284 buffer
->buffer_type
= buffer_type
;
1285 draw
->buffers
[buf_id
] = buffer
;
1287 dri3_fence_await(draw
->conn
, buffer
);
1289 /* Return the requested buffer */
1293 /** dri3_free_buffers
1295 * Free the front bufffer or all of the back buffers. Used
1296 * when the application changes which buffers it needs
1299 dri3_free_buffers(__DRIdrawable
*driDrawable
,
1300 enum loader_dri3_buffer_type buffer_type
,
1301 struct loader_dri3_drawable
*draw
)
1303 struct loader_dri3_buffer
*buffer
;
1308 switch (buffer_type
) {
1309 case loader_dri3_buffer_back
:
1310 first_id
= LOADER_DRI3_BACK_ID(0);
1311 n_id
= LOADER_DRI3_MAX_BACK
;
1313 case loader_dri3_buffer_front
:
1314 first_id
= LOADER_DRI3_FRONT_ID
;
1318 for (buf_id
= first_id
; buf_id
< first_id
+ n_id
; buf_id
++) {
1319 buffer
= draw
->buffers
[buf_id
];
1321 dri3_free_render_buffer(draw
, buffer
);
1322 draw
->buffers
[buf_id
] = NULL
;
1327 /** loader_dri3_get_buffers
1329 * The published buffer allocation API.
1330 * Returns all of the necessary buffers, allocating
1334 loader_dri3_get_buffers(__DRIdrawable
*driDrawable
,
1335 unsigned int format
,
1337 void *loaderPrivate
,
1338 uint32_t buffer_mask
,
1339 struct __DRIimageList
*buffers
)
1341 struct loader_dri3_drawable
*draw
= loaderPrivate
;
1342 struct loader_dri3_buffer
*front
, *back
;
1344 buffers
->image_mask
= 0;
1345 buffers
->front
= NULL
;
1346 buffers
->back
= NULL
;
1351 if (!dri3_update_drawable(driDrawable
, draw
))
1354 /* pixmaps always have front buffers */
1355 if (draw
->is_pixmap
)
1356 buffer_mask
|= __DRI_IMAGE_BUFFER_FRONT
;
1358 if (buffer_mask
& __DRI_IMAGE_BUFFER_FRONT
) {
1359 /* All pixmaps are owned by the server gpu.
1360 * When we use a different gpu, we can't use the pixmap
1361 * as buffer since it is potentially tiled a way
1362 * our device can't understand. In this case, use
1363 * a fake front buffer. Hopefully the pixmap
1364 * content will get synced with the fake front
1367 if (draw
->is_pixmap
&& !draw
->is_different_gpu
)
1368 front
= dri3_get_pixmap_buffer(driDrawable
,
1370 loader_dri3_buffer_front
,
1373 front
= dri3_get_buffer(driDrawable
,
1375 loader_dri3_buffer_front
,
1381 dri3_free_buffers(driDrawable
, loader_dri3_buffer_front
, draw
);
1382 draw
->have_fake_front
= 0;
1385 if (buffer_mask
& __DRI_IMAGE_BUFFER_BACK
) {
1386 back
= dri3_get_buffer(driDrawable
,
1388 loader_dri3_buffer_back
,
1392 draw
->have_back
= 1;
1394 dri3_free_buffers(driDrawable
, loader_dri3_buffer_back
, draw
);
1395 draw
->have_back
= 0;
1399 buffers
->image_mask
|= __DRI_IMAGE_BUFFER_FRONT
;
1400 buffers
->front
= front
->image
;
1401 draw
->have_fake_front
= draw
->is_different_gpu
|| !draw
->is_pixmap
;
1405 buffers
->image_mask
|= __DRI_IMAGE_BUFFER_BACK
;
1406 buffers
->back
= back
->image
;
1409 draw
->stamp
= stamp
;
1414 /** loader_dri3_update_drawable_geometry
1416 * Get the current drawable geometry.
1419 loader_dri3_update_drawable_geometry(struct loader_dri3_drawable
*draw
)
1421 xcb_get_geometry_cookie_t geom_cookie
;
1422 xcb_get_geometry_reply_t
*geom_reply
;
1424 geom_cookie
= xcb_get_geometry(draw
->conn
, draw
->drawable
);
1426 geom_reply
= xcb_get_geometry_reply(draw
->conn
, geom_cookie
, NULL
);
1429 draw
->width
= geom_reply
->width
;
1430 draw
->height
= geom_reply
->height
;
1431 draw
->vtable
->set_drawable_size(draw
, draw
->width
, draw
->height
);
1439 * Make sure the server has flushed all pending swap buffers to hardware
1440 * for this drawable. Ideally we'd want to send an X protocol request to
1441 * have the server block our connection until the swaps are complete. That
1442 * would avoid the potential round-trip here.
1445 loader_dri3_swapbuffer_barrier(struct loader_dri3_drawable
*draw
)
1447 int64_t ust
, msc
, sbc
;
1449 (void) loader_dri3_wait_for_sbc(draw
, 0, &ust
, &msc
, &sbc
);