diff mbox

[i-g-t,v4,01/13] lib/sw_sync: Add helper functions for managing synchronization primitives

Message ID 20160914150442.18183-2-robert.foss@collabora.com (mailing list archive)
State New, archived
Headers show

Commit Message

Robert Foss Sept. 14, 2016, 3:04 p.m. UTC
From: Robert Foss <robert.foss@collabora.com>

Base functions to help testing the Sync File Framework (explicit fencing
mechanism ported from Android).
These functions allow you to create, use and destroy timelines and fences.

Signed-off-by: Robert Foss <robert.foss@collabora.com>
Signed-off-by: Gustavo Padovan <gustavo.padovan@collabora.co.uk>
Reviewed-by: Eric Engestrom <eric@engestrom.ch>
---
 lib/Makefile.sources |   2 +
 lib/sw_sync.c        | 190 +++++++++++++++++++++++++++++++++++++++++++++++++++
 lib/sw_sync.h        |  48 +++++++++++++
 3 files changed, 240 insertions(+)
 create mode 100644 lib/sw_sync.c
 create mode 100644 lib/sw_sync.h

Comments

Chris Wilson Sept. 15, 2016, 6:46 a.m. UTC | #1
On Wed, Sep 14, 2016 at 11:04:30AM -0400, robert.foss@collabora.com wrote:
> +void sw_sync_timeline_inc(int fd, uint32_t count)
> +{
> +	uint32_t arg = count;
> +
> +	if (fd == 0)
> +		return;

But fd = 0 is a valid fd, and might be a timeline somewhere.

Did you mean count == 0 ?

And even then (unless it is defined as an error condition in the kernel
ABI, and it should not be...) we should pass it through to the kernel.

> +	do_ioctl(fd, SW_SYNC_IOC_INC, &arg);
> +}
> +

> +int sw_sync_wait(int fence, int timeout)
> +{
> +	struct pollfd fds;
> +	int ret;
> +
> +	fds.fd = fence;
> +	fds.events = POLLIN | POLLERR;

POLLERR is always implied and doesn't need to be specified (it is
meaningless in .events).

int sw_sync_wait(int fence, int timeout)
{
#if BEING_FANCY
	return poll(&(struct pollfd){fd, POLLIN}, 1, timeout);
#else
	struct pollfd pfd = { fd, POLLIN };
	return poll(&pfd, 1, timeout);
#endif
}

Indentation has gone wrong, double check the whitespace.


How do fences operate after their timeline is closed? (Are they
automatically signaled, or do they persist and are signaled normally?) Is
there a test for using fences from a closed timeline (I was looking but
didn't notice one).
-Chris
Robert Foss Sept. 15, 2016, 6:35 p.m. UTC | #2
On 2016-09-15 02:46 AM, Chris Wilson wrote:
> On Wed, Sep 14, 2016 at 11:04:30AM -0400, robert.foss@collabora.com wrote:
>> +void sw_sync_timeline_inc(int fd, uint32_t count)
>> +{
>> +	uint32_t arg = count;
>> +
>> +	if (fd == 0)
>> +		return;
>
> But fd = 0 is a valid fd, and might be a timeline somewhere.
>
> Did you mean count == 0 ?
>
> And even then (unless it is defined as an error condition in the kernel
> ABI, and it should not be...) we should pass it through to the kernel.

You're right, I'll change it in v5.

>
>> +	do_ioctl(fd, SW_SYNC_IOC_INC, &arg);
>> +}
>> +
>
>> +int sw_sync_wait(int fence, int timeout)
>> +{
>> +	struct pollfd fds;
>> +	int ret;
>> +
>> +	fds.fd = fence;
>> +	fds.events = POLLIN | POLLERR;
>
> POLLERR is always implied and doesn't need to be specified (it is
> meaningless in .events).
>
> int sw_sync_wait(int fence, int timeout)
> {
> #if BEING_FANCY
> 	return poll(&(struct pollfd){fd, POLLIN}, 1, timeout);
> #else
> 	struct pollfd pfd = { fd, POLLIN };
> 	return poll(&pfd, 1, timeout);
> #endif
> }
>
> Indentation has gone wrong, double check the whitespace.

That is definitely nicer looking. I'll drop it in for v5.

>
>
> How do fences operate after their timeline is closed? (Are they
> automatically signaled, or do they persist and are signaled normally?) Is
> there a test for using fences from a closed timeline (I was looking but
> didn't notice one).

I did some quick tests just to confirm, closing the timeline signals all 
of its fences.
Robert Foss Sept. 15, 2016, 7:28 p.m. UTC | #3
On 2016-09-15 02:35 PM, Robert Foss wrote:
>
>
> On 2016-09-15 02:46 AM, Chris Wilson wrote:
>> On Wed, Sep 14, 2016 at 11:04:30AM -0400, robert.foss@collabora.com
>> wrote:
>>> +void sw_sync_timeline_inc(int fd, uint32_t count)
>>> +{
>>> +    uint32_t arg = count;
>>> +
>>> +    if (fd == 0)
>>> +        return;
>>
>> But fd = 0 is a valid fd, and might be a timeline somewhere.
>>
>> Did you mean count == 0 ?
>>
>> And even then (unless it is defined as an error condition in the kernel
>> ABI, and it should not be...) we should pass it through to the kernel.
>
> You're right, I'll change it in v5.
>
>>
>>> +    do_ioctl(fd, SW_SYNC_IOC_INC, &arg);
>>> +}
>>> +
>>
>>> +int sw_sync_wait(int fence, int timeout)
>>> +{
>>> +    struct pollfd fds;
>>> +    int ret;
>>> +
>>> +    fds.fd = fence;
>>> +    fds.events = POLLIN | POLLERR;
>>
>> POLLERR is always implied and doesn't need to be specified (it is
>> meaningless in .events).
>>
>> int sw_sync_wait(int fence, int timeout)
>> {
>> #if BEING_FANCY
>>     return poll(&(struct pollfd){fd, POLLIN}, 1, timeout);
>> #else
>>     struct pollfd pfd = { fd, POLLIN };
>>     return poll(&pfd, 1, timeout);
>> #endif
>> }
>>
>> Indentation has gone wrong, double check the whitespace.
>
> That is definitely nicer looking. I'll drop it in for v5.
>
>>
>>
>> How do fences operate after their timeline is closed? (Are they
>> automatically signaled, or do they persist and are signaled normally?) Is
>> there a test for using fences from a closed timeline (I was looking but
>> didn't notice one).
>
> I did some quick tests just to confirm, closing the timeline signals all
> of its fences.

Actually, my quick test was wrong. A fence is _not_ signaled on when its 
timeline has been closed.

So you would like to see a test that confirms that a fence on closed 
timeline is not signaled?


Rob.
Gustavo Padovan Sept. 15, 2016, 7:36 p.m. UTC | #4
2016-09-15 Robert Foss <robert.foss@collabora.com>:

> 
> 
> On 2016-09-15 02:35 PM, Robert Foss wrote:
> > 
> > 
> > On 2016-09-15 02:46 AM, Chris Wilson wrote:
> > > On Wed, Sep 14, 2016 at 11:04:30AM -0400, robert.foss@collabora.com
> > > wrote:
> > > > +void sw_sync_timeline_inc(int fd, uint32_t count)
> > > > +{
> > > > +    uint32_t arg = count;
> > > > +
> > > > +    if (fd == 0)
> > > > +        return;
> > > 
> > > But fd = 0 is a valid fd, and might be a timeline somewhere.
> > > 
> > > Did you mean count == 0 ?
> > > 
> > > And even then (unless it is defined as an error condition in the kernel
> > > ABI, and it should not be...) we should pass it through to the kernel.
> > 
> > You're right, I'll change it in v5.
> > 
> > > 
> > > > +    do_ioctl(fd, SW_SYNC_IOC_INC, &arg);
> > > > +}
> > > > +
> > > 
> > > > +int sw_sync_wait(int fence, int timeout)
> > > > +{
> > > > +    struct pollfd fds;
> > > > +    int ret;
> > > > +
> > > > +    fds.fd = fence;
> > > > +    fds.events = POLLIN | POLLERR;
> > > 
> > > POLLERR is always implied and doesn't need to be specified (it is
> > > meaningless in .events).
> > > 
> > > int sw_sync_wait(int fence, int timeout)
> > > {
> > > #if BEING_FANCY
> > >     return poll(&(struct pollfd){fd, POLLIN}, 1, timeout);
> > > #else
> > >     struct pollfd pfd = { fd, POLLIN };
> > >     return poll(&pfd, 1, timeout);
> > > #endif
> > > }
> > > 
> > > Indentation has gone wrong, double check the whitespace.
> > 
> > That is definitely nicer looking. I'll drop it in for v5.
> > 
> > > 
> > > 
> > > How do fences operate after their timeline is closed? (Are they
> > > automatically signaled, or do they persist and are signaled normally?) Is
> > > there a test for using fences from a closed timeline (I was looking but
> > > didn't notice one).
> > 
> > I did some quick tests just to confirm, closing the timeline signals all
> > of its fences.
> 
> Actually, my quick test was wrong. A fence is _not_ signaled on when its
> timeline has been closed.
> 
> So you would like to see a test that confirms that a fence on closed
> timeline is not signaled?

Yes, please. Add this test and maybe another the signals the fence
before closing the timeline and the check if the fence is indeed
signaled.

Gustavo
diff mbox

Patch

diff --git a/lib/Makefile.sources b/lib/Makefile.sources
index bac9a7f..3dc7c3c 100644
--- a/lib/Makefile.sources
+++ b/lib/Makefile.sources
@@ -61,6 +61,8 @@  lib_source_list =	 	\
 	rendercopy_gen8.c	\
 	rendercopy_gen9.c	\
 	rendercopy.h		\
+	sw_sync.c		\
+	sw_sync.h		\
 	intel_reg_map.c		\
 	intel_iosf.c		\
 	igt_kms.c		\
diff --git a/lib/sw_sync.c b/lib/sw_sync.c
new file mode 100644
index 0000000..4e64837
--- /dev/null
+++ b/lib/sw_sync.c
@@ -0,0 +1,190 @@ 
+/*
+ * Copyright 2012 Google, Inc
+ * Copyright © 2016 Collabora, Ltd.
+ *
+ * Based on the implementation from the Android Open Source Project
+ *
+ * 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.
+ *
+ * Authors:
+ *    Robert Foss <robert.foss@collabora.com>
+ */
+
+#ifndef ANDROID
+#define _GNU_SOURCE
+#else
+#include <libgen.h>
+#endif
+#include <fcntl.h>
+#include <poll.h>
+#include <stdint.h>
+#include <linux/sync_file.h>
+#include <sys/ioctl.h>
+
+#include "sw_sync.h"
+#include "drmtest.h"
+#include "ioctl_wrappers.h"
+
+#ifndef SW_SYNC_IOC_INC
+struct sw_sync_create_fence_data {
+	__u32	value;
+	char	name[32];
+	__s32	fence;
+};
+
+#define SW_SYNC_IOC_MAGIC		'W'
+#define SW_SYNC_IOC_CREATE_FENCE	_IOWR(SW_SYNC_IOC_MAGIC, 0,\
+						struct sw_sync_create_fence_data)
+#define SW_SYNC_IOC_INC			_IOW(SW_SYNC_IOC_MAGIC, 1, __u32)
+#endif
+
+#define DEVFS_SW_SYNC   "/dev/sw_sync"
+#define DEBUGFS_SW_SYNC "/sys/kernel/debug/sync/sw_sync"
+
+
+int sw_sync_fd_is_valid(int fd)
+{
+	int status;
+
+	if (fd < 0)
+		return 0;
+
+	status = fcntl(fd, F_GETFD, 0);
+	return status >= 0;
+}
+
+int sw_sync_timeline_create(void)
+{
+	int fd = open(DEVFS_SW_SYNC, O_RDWR);
+
+	if (fd < 0)
+		fd = open(DEBUGFS_SW_SYNC, O_RDWR);
+
+	igt_assert(sw_sync_fd_is_valid(fd));
+
+	return fd;
+}
+
+int __sw_sync_fence_create(int fd, uint32_t seqno)
+{
+
+	struct sw_sync_create_fence_data data;
+
+	memset(&data, 0, sizeof(data));
+	data.value = seqno;
+
+	if (igt_ioctl(fd, SW_SYNC_IOC_CREATE_FENCE, &data))
+		return -errno;
+
+	return data.fence;
+}
+
+int sw_sync_fence_create(int fd, uint32_t seqno)
+{
+	int fence = __sw_sync_fence_create(fd, seqno);
+	igt_assert(fence >= 0);
+	return fence;
+}
+
+void sw_sync_timeline_inc(int fd, uint32_t count)
+{
+	uint32_t arg = count;
+
+	if (fd == 0)
+		return;
+
+	do_ioctl(fd, SW_SYNC_IOC_INC, &arg);
+}
+
+int sw_sync_merge(int fd1, int fd2)
+{
+	struct sync_merge_data data = {};
+	int err;
+
+	data.fd2 = fd2;
+
+	err = ioctl(fd1, SYNC_IOC_MERGE, &data);
+	if (err < 0)
+		return -errno;
+
+	sw_sync_fd_is_valid(data.fence);
+
+	return data.fence;
+}
+
+int sw_sync_wait(int fence, int timeout)
+{
+	struct pollfd fds;
+	int ret;
+
+	fds.fd = fence;
+	fds.events = POLLIN | POLLERR;
+
+	ret = poll(&fds, 1, timeout);
+
+	return ret;
+}
+
+int sw_sync_fence_count(int fd)
+{
+	struct sync_file_info info;
+
+	memset(&info, 0, sizeof(info));
+	if (ioctl(fd, SYNC_IOC_FILE_INFO, &info))
+	    return -errno;
+
+	return info.num_fences;
+}
+
+static int __sw_sync_fence_count_status(int fd, int status)
+{
+	struct sync_file_info info;
+	struct sync_fence_info *fence_info;
+	int count;
+	int i;
+
+	memset(&info, 0, sizeof(info));
+	if (ioctl(fd, SYNC_IOC_FILE_INFO, &info))
+		return -errno;
+
+	fence_info = calloc(info.num_fences, sizeof(*fence_info));
+	if (!fence_info)
+		return -ENOMEM;
+
+	info.sync_fence_info = (uintptr_t)fence_info;
+	if (ioctl(fd, SYNC_IOC_FILE_INFO, &info)) {
+		count = -errno;
+	} else {
+		count = 0;
+		for (i = 0 ; i < info.num_fences ; i++)
+		    count += fence_info[i].status == status;
+	}
+
+	free(fence_info);
+
+	return count;
+}
+
+int sw_sync_fence_count_status(int fd, int status)
+{
+	int count = __sw_sync_fence_count_status(fd, status);
+	igt_assert(count >= 0);
+	return count;
+}
diff --git a/lib/sw_sync.h b/lib/sw_sync.h
new file mode 100644
index 0000000..fee9249
--- /dev/null
+++ b/lib/sw_sync.h
@@ -0,0 +1,48 @@ 
+/*
+ * Copyright 2012 Google, Inc
+ * Copyright © 2016 Collabora, Ltd.
+ *
+ * Based on the implementation from the Android Open Source Project
+ *
+ * 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.
+ *
+ * Authors:
+ *    Robert Foss <robert.foss@collabora.com>
+ */
+
+#ifndef SW_SYNC_H
+#define SW_SYNC_H
+
+#define SW_SYNC_FENCE_STATUS_ERROR		(-1)
+#define SW_SYNC_FENCE_STATUS_ACTIVE		(0)
+#define SW_SYNC_FENCE_STATUS_SIGNALED	(1)
+
+int sw_sync_fd_is_valid(int fd);
+int sw_sync_timeline_create(void);
+int __sw_sync_fence_create(int fd, uint32_t seqno);
+int sw_sync_fence_create(int fd, uint32_t seqno);
+void sw_sync_timeline_inc(int fd, uint32_t count);
+int sw_sync_merge(int fd1, int fd2);
+int sw_sync_wait(int fence, int timeout);
+int sw_sync_fence_count(int fd);
+int sw_sync_fence_count_status(int fd, int status);
+
+#endif
+