vulkan: Add an emulated timeline sync type

This is mostly copy+paste (and a bit of re-typing) from ANV.

Reviewed-by: Lionel Landwerlin <lionel.g.landwerlin@intel.com>
Acked-by: Bas Nieuwenhuizen <bas@basnieuwenhuizen.nl>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/13427>
This commit is contained in:
Jason Ekstrand 2021-10-18 18:12:59 -05:00
parent f3843b11c9
commit 301e20f7a3
3 changed files with 702 additions and 0 deletions

View File

@ -54,6 +54,8 @@ vulkan_runtime_files = files(
'vk_shader_module.h',
'vk_sync.c',
'vk_sync.h',
'vk_sync_timeline.c',
'vk_sync_timeline.h',
'vk_synchronization2.c',
)

View File

@ -0,0 +1,567 @@
/*
* Copyright © 2021 Intel Corporation
*
* Permission is hereby granted, free of charge, to any person obtaining a
* copy of this software and associated documentation files (the "Software"),
* to deal in the Software without restriction, including without limitation
* the rights to use, copy, modify, merge, publish, distribute, sublicense,
* and/or sell copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice (including the next
* paragraph) shall be included in all copies or substantial portions of the
* Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
* IN THE SOFTWARE.
*/
#include "vk_sync_timeline.h"
#include <inttypes.h>
#include "util/os_time.h"
#include "vk_alloc.h"
#include "vk_device.h"
#include "vk_log.h"
static struct vk_sync_timeline *
to_vk_sync_timeline(struct vk_sync *sync)
{
assert(sync->type->init == vk_sync_timeline_init);
return container_of(sync, struct vk_sync_timeline, sync);
}
static void
vk_sync_timeline_type_validate(const struct vk_sync_timeline_type *ttype)
{
ASSERTED const enum vk_sync_features req_features =
VK_SYNC_FEATURE_BINARY |
VK_SYNC_FEATURE_GPU_WAIT |
VK_SYNC_FEATURE_GPU_MULTI_WAIT |
VK_SYNC_FEATURE_CPU_WAIT |
VK_SYNC_FEATURE_CPU_RESET;
assert(!(req_features & ~ttype->point_sync_type->features));
}
VkResult
vk_sync_timeline_init(struct vk_device *device,
struct vk_sync *sync,
uint64_t initial_value)
{
struct vk_sync_timeline *timeline = to_vk_sync_timeline(sync);
int ret;
ASSERTED const struct vk_sync_timeline_type *ttype =
container_of(timeline->sync.type, struct vk_sync_timeline_type, sync);
vk_sync_timeline_type_validate(ttype);
ret = mtx_init(&timeline->mutex, mtx_plain);
if (ret != thrd_success)
return vk_errorf(device, VK_ERROR_UNKNOWN, "mtx_init failed");
ret = cnd_init(&timeline->cond);
if (ret != thrd_success) {
mtx_destroy(&timeline->mutex);
return vk_errorf(device, VK_ERROR_UNKNOWN, "cnd_init failed");
}
timeline->highest_past =
timeline->highest_pending = initial_value;
list_inithead(&timeline->pending_points);
list_inithead(&timeline->free_points);
return VK_SUCCESS;
}
static void
vk_sync_timeline_finish(struct vk_device *device,
struct vk_sync *sync)
{
struct vk_sync_timeline *timeline = to_vk_sync_timeline(sync);
list_for_each_entry_safe(struct vk_sync_timeline_point, point,
&timeline->free_points, link) {
list_del(&point->link);
vk_sync_finish(device, &point->sync);
vk_free(&device->alloc, point);
}
list_for_each_entry_safe(struct vk_sync_timeline_point, point,
&timeline->pending_points, link) {
list_del(&point->link);
vk_sync_finish(device, &point->sync);
vk_free(&device->alloc, point);
}
cnd_destroy(&timeline->cond);
mtx_destroy(&timeline->mutex);
}
static struct vk_sync_timeline_point *
vk_sync_timeline_first_point(struct vk_sync_timeline *timeline)
{
struct vk_sync_timeline_point *point =
list_first_entry(&timeline->pending_points,
struct vk_sync_timeline_point, link);
assert(point->value <= timeline->highest_pending);
assert(point->value > timeline->highest_past);
return point;
}
static VkResult
vk_sync_timeline_gc_locked(struct vk_device *device,
struct vk_sync_timeline *timeline,
bool drain);
static VkResult
vk_sync_timeline_alloc_point_locked(struct vk_device *device,
struct vk_sync_timeline *timeline,
uint64_t value,
struct vk_sync_timeline_point **point_out)
{
struct vk_sync_timeline_point *point;
VkResult result;
result = vk_sync_timeline_gc_locked(device, timeline, false);
if (unlikely(result != VK_SUCCESS))
return result;
if (list_is_empty(&timeline->free_points)) {
const struct vk_sync_timeline_type *ttype =
container_of(timeline->sync.type, struct vk_sync_timeline_type, sync);
const struct vk_sync_type *point_sync_type = ttype->point_sync_type;
size_t size = offsetof(struct vk_sync_timeline_point, sync) +
point_sync_type->size;
point = vk_zalloc(&device->alloc, size, 8,
VK_SYSTEM_ALLOCATION_SCOPE_DEVICE);
if (!point)
return vk_error(device, VK_ERROR_OUT_OF_HOST_MEMORY);
point->timeline = timeline;
result = vk_sync_init(device, &point->sync, point_sync_type,
0 /* flags */, 0 /* initial_value */);
if (unlikely(result != VK_SUCCESS)) {
vk_free(&device->alloc, point);
return result;
}
} else {
point = list_first_entry(&timeline->free_points,
struct vk_sync_timeline_point, link);
if (point->sync.type->reset) {
result = vk_sync_reset(device, &point->sync);
if (unlikely(result != VK_SUCCESS))
return result;
}
list_del(&point->link);
}
point->value = value;
*point_out = point;
return VK_SUCCESS;
}
VkResult
vk_sync_timeline_alloc_point(struct vk_device *device,
struct vk_sync_timeline *timeline,
uint64_t value,
struct vk_sync_timeline_point **point_out)
{
VkResult result;
mtx_lock(&timeline->mutex);
result = vk_sync_timeline_alloc_point_locked(device, timeline, value, point_out);
mtx_unlock(&timeline->mutex);
return result;
}
static void
vk_sync_timeline_point_free_locked(struct vk_sync_timeline *timeline,
struct vk_sync_timeline_point *point)
{
assert(point->refcount == 0 && !point->pending);
list_add(&point->link, &timeline->free_points);
}
void
vk_sync_timeline_point_free(struct vk_device *device,
struct vk_sync_timeline_point *point)
{
struct vk_sync_timeline *timeline = point->timeline;
mtx_lock(&timeline->mutex);
vk_sync_timeline_point_free_locked(timeline, point);
mtx_unlock(&timeline->mutex);
}
static void
vk_sync_timeline_point_ref(struct vk_sync_timeline_point *point)
{
point->refcount++;
}
static void
vk_sync_timeline_point_unref(struct vk_sync_timeline *timeline,
struct vk_sync_timeline_point *point)
{
assert(point->refcount > 0);
point->refcount--;
if (point->refcount == 0 && !point->pending)
vk_sync_timeline_point_free_locked(timeline, point);
}
static void
vk_sync_timeline_point_complete(struct vk_sync_timeline *timeline,
struct vk_sync_timeline_point *point)
{
if (!point->pending)
return;
assert(timeline->highest_past < point->value);
timeline->highest_past = point->value;
point->pending = false;
list_del(&point->link);
if (point->refcount == 0)
vk_sync_timeline_point_free_locked(timeline, point);
}
static VkResult
vk_sync_timeline_gc_locked(struct vk_device *device,
struct vk_sync_timeline *timeline,
bool drain)
{
list_for_each_entry_safe(struct vk_sync_timeline_point, point,
&timeline->pending_points, link) {
/* timeline->higest_pending is only incremented once submission has
* happened. If this point has a greater serial, it means the point
* hasn't been submitted yet.
*/
if (point->value > timeline->highest_pending)
return VK_SUCCESS;
/* If someone is waiting on this time point, consider it busy and don't
* try to recycle it. There's a slim possibility that it's no longer
* busy by the time we look at it but we would be recycling it out from
* under a waiter and that can lead to weird races.
*
* We walk the list in-order so if this time point is still busy so is
* every following time point
*/
assert(point->refcount >= 0);
if (point->refcount > 0 && !drain)
return VK_SUCCESS;
/* Garbage collect any signaled point. */
VkResult result = vk_sync_wait(device, &point->sync, 0,
VK_SYNC_WAIT_COMPLETE,
0 /* abs_timeout_ns */);
if (result == VK_TIMEOUT) {
/* We walk the list in-order so if this time point is still busy so
* is every following time point
*/
return VK_SUCCESS;
} else if (result != VK_SUCCESS) {
return result;
}
vk_sync_timeline_point_complete(timeline, point);
}
return VK_SUCCESS;
}
VkResult
vk_sync_timeline_point_install(struct vk_device *device,
struct vk_sync_timeline_point *point)
{
struct vk_sync_timeline *timeline = point->timeline;
mtx_lock(&timeline->mutex);
assert(point->value > timeline->highest_pending);
timeline->highest_pending = point->value;
assert(point->refcount == 0);
point->pending = true;
list_addtail(&point->link, &timeline->pending_points);
int ret = cnd_broadcast(&timeline->cond);
mtx_unlock(&timeline->mutex);
if (ret == thrd_error)
return vk_errorf(device, VK_ERROR_UNKNOWN, "cnd_broadcast failed");
return VK_SUCCESS;
}
static VkResult
vk_sync_timeline_get_point_locked(struct vk_device *device,
struct vk_sync_timeline *timeline,
uint64_t wait_value,
struct vk_sync_timeline_point **point_out)
{
if (timeline->highest_past >= wait_value) {
/* Nothing to wait on */
*point_out = NULL;
return VK_SUCCESS;
}
list_for_each_entry(struct vk_sync_timeline_point, point,
&timeline->pending_points, link) {
if (point->value >= wait_value) {
vk_sync_timeline_point_ref(point);
*point_out = point;
return VK_SUCCESS;
}
}
return VK_NOT_READY;
}
VkResult
vk_sync_timeline_get_point(struct vk_device *device,
struct vk_sync_timeline *timeline,
uint64_t wait_value,
struct vk_sync_timeline_point **point_out)
{
mtx_lock(&timeline->mutex);
VkResult result = vk_sync_timeline_get_point_locked(device, timeline,
wait_value, point_out);
mtx_unlock(&timeline->mutex);
return result;
}
void
vk_sync_timeline_point_release(struct vk_device *device,
struct vk_sync_timeline_point *point)
{
struct vk_sync_timeline *timeline = point->timeline;
mtx_lock(&timeline->mutex);
vk_sync_timeline_point_unref(timeline, point);
mtx_unlock(&timeline->mutex);
}
static VkResult
vk_sync_timeline_signal_locked(struct vk_device *device,
struct vk_sync_timeline *timeline,
uint64_t value)
{
VkResult result = vk_sync_timeline_gc_locked(device, timeline, true);
if (unlikely(result != VK_SUCCESS))
return result;
if (unlikely(value <= timeline->highest_past)) {
return vk_device_set_lost(device, "Timeline values must only ever "
"strictly increase.");
}
assert(list_is_empty(&timeline->pending_points));
assert(timeline->highest_pending == timeline->highest_past);
timeline->highest_pending = timeline->highest_past = value;
int ret = cnd_broadcast(&timeline->cond);
if (ret == thrd_error)
return vk_errorf(device, VK_ERROR_UNKNOWN, "cnd_broadcast failed");
return VK_SUCCESS;
}
static VkResult
vk_sync_timeline_signal(struct vk_device *device,
struct vk_sync *sync,
uint64_t value)
{
struct vk_sync_timeline *timeline = to_vk_sync_timeline(sync);
mtx_lock(&timeline->mutex);
VkResult result = vk_sync_timeline_signal_locked(device, timeline, value);
mtx_unlock(&timeline->mutex);
return result;
}
static VkResult
vk_sync_timeline_get_value(struct vk_device *device,
struct vk_sync *sync,
uint64_t *value)
{
struct vk_sync_timeline *timeline = to_vk_sync_timeline(sync);
mtx_lock(&timeline->mutex);
VkResult result = vk_sync_timeline_gc_locked(device, timeline, true);
mtx_unlock(&timeline->mutex);
if (result != VK_SUCCESS)
return result;
*value = timeline->highest_past;
return VK_SUCCESS;
}
#define NSEC_PER_SEC 1000000000ull
static bool
timespec_add_ns_overflow(struct timespec ts, uint64_t ns,
struct timespec *ts_out)
{
STATIC_ASSERT(sizeof(ts.tv_sec) <= sizeof(uint64_t));
/* We don't know so assume it's signed */
const uint64_t max_tv_sec = u_intN_max(sizeof(ts.tv_sec) * 8);
if (ns / NSEC_PER_SEC > max_tv_sec)
return true;
if (ts.tv_sec > max_tv_sec - ns / NSEC_PER_SEC)
return true;
ts.tv_sec += ns / NSEC_PER_SEC,
ts.tv_nsec += ns % NSEC_PER_SEC,
ts.tv_sec += ts.tv_nsec / NSEC_PER_SEC;
ts.tv_nsec = ts.tv_nsec % NSEC_PER_SEC;
*ts_out = ts;
return false;
}
static VkResult
vk_sync_timeline_wait_locked(struct vk_device *device,
struct vk_sync_timeline *timeline,
uint64_t wait_value,
enum vk_sync_wait_flags wait_flags,
uint64_t abs_timeout_ns)
{
/* Wait on the queue_submit condition variable until the timeline has a
* time point pending that's at least as high as wait_value.
*/
uint64_t now_ns = os_time_get_nano();
while (timeline->highest_pending < wait_value) {
if (now_ns >= abs_timeout_ns)
return VK_TIMEOUT;
int ret;
if (abs_timeout_ns >= INT64_MAX) {
/* Common infinite wait case */
ret = cnd_wait(&timeline->cond, &timeline->mutex);
} else {
/* This is really annoying. The C11 threads API uses CLOCK_REALTIME
* while all our absolute timeouts are in CLOCK_MONOTONIC. Best
* thing we can do is to convert and hope the system admin doesn't
* change the time out from under us.
*/
uint64_t rel_timeout_ns = abs_timeout_ns - now_ns;
struct timespec abstime;
timespec_get(&abstime, TIME_UTC);
if (timespec_add_ns_overflow(abstime, rel_timeout_ns, &abstime)) {
/* Overflowed; may as well be infinite */
ret = cnd_wait(&timeline->cond, &timeline->mutex);
} else {
ret = cnd_timedwait(&timeline->cond, &timeline->mutex, &abstime);
}
}
if (ret == thrd_error)
return vk_errorf(device, VK_ERROR_UNKNOWN, "cnd_timedwait failed");
/* We don't trust the timeout condition on cnd_timedwait() because of
* the potential clock issues caused by using CLOCK_REALTIME. Instead,
* update now_ns, go back to the top of the loop, and re-check.
*/
now_ns = os_time_get_nano();
}
if (wait_flags & VK_SYNC_WAIT_PENDING)
return VK_SUCCESS;
VkResult result = vk_sync_timeline_gc_locked(device, timeline, false);
if (result != VK_SUCCESS)
return result;
while (timeline->highest_past < wait_value) {
struct vk_sync_timeline_point *point = vk_sync_timeline_first_point(timeline);
/* Drop the lock while we wait. */
vk_sync_timeline_point_ref(point);
mtx_unlock(&timeline->mutex);
result = vk_sync_wait(device, &point->sync, 0,
VK_SYNC_WAIT_COMPLETE,
abs_timeout_ns);
/* Pick the mutex back up */
mtx_lock(&timeline->mutex);
vk_sync_timeline_point_unref(timeline, point);
/* This covers both VK_TIMEOUT and VK_ERROR_DEVICE_LOST */
if (result != VK_SUCCESS)
return result;
vk_sync_timeline_point_complete(timeline, point);
}
return VK_SUCCESS;
}
static VkResult
vk_sync_timeline_wait(struct vk_device *device,
struct vk_sync *sync,
uint64_t wait_value,
enum vk_sync_wait_flags wait_flags,
uint64_t abs_timeout_ns)
{
struct vk_sync_timeline *timeline = to_vk_sync_timeline(sync);
mtx_lock(&timeline->mutex);
VkResult result = vk_sync_timeline_wait_locked(device, timeline,
wait_value, wait_flags,
abs_timeout_ns);
mtx_unlock(&timeline->mutex);
return result;
}
struct vk_sync_timeline_type
vk_sync_timeline_get_type(const struct vk_sync_type *point_sync_type)
{
return (struct vk_sync_timeline_type) {
.sync = {
.size = sizeof(struct vk_sync_timeline),
.features = VK_SYNC_FEATURE_TIMELINE |
VK_SYNC_FEATURE_GPU_WAIT |
VK_SYNC_FEATURE_CPU_WAIT |
VK_SYNC_FEATURE_CPU_SIGNAL |
VK_SYNC_FEATURE_WAIT_ANY |
VK_SYNC_FEATURE_WAIT_PENDING,
.init = vk_sync_timeline_init,
.finish = vk_sync_timeline_finish,
.signal = vk_sync_timeline_signal,
.get_value = vk_sync_timeline_get_value,
.wait = vk_sync_timeline_wait,
},
.point_sync_type = point_sync_type,
};
}

View File

@ -0,0 +1,133 @@
/*
* Copyright © 2021 Intel Corporation
*
* Permission is hereby granted, free of charge, to any person obtaining a
* copy of this software and associated documentation files (the "Software"),
* to deal in the Software without restriction, including without limitation
* the rights to use, copy, modify, merge, publish, distribute, sublicense,
* and/or sell copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice (including the next
* paragraph) shall be included in all copies or substantial portions of the
* Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
* IN THE SOFTWARE.
*/
#ifndef VK_SYNC_TIMELINE_H
#define VK_SYNC_TIMELINE_H
#include "c11/threads.h"
#include "util/list.h"
#include "util/macros.h"
#include "vk_sync.h"
#ifdef __cplusplus
extern "C" {
#endif
struct vk_sync_timeline_type {
struct vk_sync_type sync;
/* Type of each individual time point */
const struct vk_sync_type *point_sync_type;
};
struct vk_sync_timeline_type
vk_sync_timeline_get_type(const struct vk_sync_type *point_sync_type);
struct vk_sync_timeline_point {
struct vk_sync_timeline *timeline;
struct list_head link;
uint64_t value;
int refcount;
bool pending;
struct vk_sync sync;
};
/** Implements a timeline vk_sync type on top of a binary vk_sync
*
* This is used for emulating VK_KHR_timeline_semaphores for implementations
* whose kernel driver do not yet support timeline syncobj. Since it's a
* requirement for Vulkan 1.2, it's useful to have an emulation like this.
*
* The driver should never see a vk_sync_timeline object. Instead, converting
* from vk_sync_timeline to a binary vk_sync for a particular time point is
* handled by common code. All a driver needs to do is declare its preferred
* binary vk_sync_type for emulation as follows:
*
* const struct vk_sync_type anv_bo_sync_type = {
* ...
* };
* VK_DECL_TIMELINE_TYPE(anv_bo_timeline_sync_type, &anv_bo_sync_type);
*
* and then anv_bo_timeline_sync_type.sync can be used as a sync type to
* provide timelines.
*/
struct vk_sync_timeline {
struct vk_sync sync;
mtx_t mutex;
cnd_t cond;
uint64_t highest_past;
uint64_t highest_pending;
struct list_head pending_points;
struct list_head free_points;
};
VkResult vk_sync_timeline_init(struct vk_device *device,
struct vk_sync *sync,
uint64_t initial_value);
VkResult vk_sync_timeline_alloc_point(struct vk_device *device,
struct vk_sync_timeline *timeline,
uint64_t value,
struct vk_sync_timeline_point **point_out);
void vk_sync_timeline_point_free(struct vk_device *device,
struct vk_sync_timeline_point *point);
VkResult vk_sync_timeline_point_install(struct vk_device *device,
struct vk_sync_timeline_point *point);
VkResult vk_sync_timeline_get_point(struct vk_device *device,
struct vk_sync_timeline *timeline,
uint64_t wait_value,
struct vk_sync_timeline_point **point_out);
void vk_sync_timeline_point_release(struct vk_device *device,
struct vk_sync_timeline_point *point);
static inline bool
vk_sync_type_is_vk_sync_timeline(const struct vk_sync_type *type)
{
return type->init == vk_sync_timeline_init;
}
static inline struct vk_sync_timeline *
vk_sync_as_timeline(struct vk_sync *sync)
{
if (!vk_sync_type_is_vk_sync_timeline(sync->type))
return NULL;
return container_of(sync, struct vk_sync_timeline, sync);
}
#ifdef __cplusplus
}
#endif
#endif /* VK_SYNC_TIMELINE_H */