Sanity test existing persistence and new exciting non-persistent context
behaviour.

Signed-off-by: Chris Wilson <ch...@chris-wilson.co.uk>
Cc: Joonas Lahtinen <joonas.lahti...@linux.intel.com>
Cc: Michał Winiarski <michal.winiar...@intel.com>
Cc: Jon Bloomfield <jon.bloomfi...@intel.com>
---
 lib/i915/gem_context.c           |  37 ++++
 lib/i915/gem_context.h           |   8 +
 lib/igt_dummyload.c              |   3 +-
 lib/ioctl_wrappers.c             |   1 +
 tests/Makefile.sources           |   3 +
 tests/i915/gem_ctx_persistence.c | 353 +++++++++++++++++++++++++++++++
 tests/meson.build                |   1 +
 7 files changed, 405 insertions(+), 1 deletion(-)
 create mode 100644 tests/i915/gem_ctx_persistence.c

diff --git a/lib/i915/gem_context.c b/lib/i915/gem_context.c
index 83c5df961..1fae5191f 100644
--- a/lib/i915/gem_context.c
+++ b/lib/i915/gem_context.c
@@ -272,6 +272,43 @@ void gem_context_set_priority(int fd, uint32_t ctx_id, int 
prio)
        igt_assert_eq(__gem_context_set_priority(fd, ctx_id, prio), 0);
 }
 
+/**
+ * __gem_context_set_persistence:
+ * @i915: open i915 drm file descriptor
+ * @ctx: i915 context id
+ * @state: desired persistence
+ *
+ * Declare whether this context is allowed to persist after closing until
+ * its requests are complete (persistent=true) or if it should be
+ * immediately reaped on closing and its requests cancelled
+ * (persistent=false).
+ *
+ * Returns: An integer equal to zero for success and negative for failure
+ */
+int __gem_context_set_persistence(int i915, uint32_t ctx, bool state)
+{
+       struct drm_i915_gem_context_param p = {
+               .ctx_id = ctx,
+               .param = I915_CONTEXT_PARAM_PERSISTENCE,
+               .value = state,
+       };
+
+       return __gem_context_set_param(i915, &p);
+}
+
+/**
+ * __gem_context_set_persistence:
+ * @i915: open i915 drm file descriptor
+ * @ctx: i915 context id
+ * @state: desired persistence
+ *
+ * Like __gem_context_set_persistence(), except we assert on failure.
+ */
+void gem_context_set_persistence(int i915, uint32_t ctx, bool state)
+{
+       igt_assert_eq(__gem_context_set_persistence(i915, ctx, state), 0);
+}
+
 int
 __gem_context_clone(int i915,
                    uint32_t src, unsigned int share,
diff --git a/lib/i915/gem_context.h b/lib/i915/gem_context.h
index 8043c3401..c0d4c9615 100644
--- a/lib/i915/gem_context.h
+++ b/lib/i915/gem_context.h
@@ -24,6 +24,11 @@
 #ifndef GEM_CONTEXT_H
 #define GEM_CONTEXT_H
 
+#include <stdbool.h>
+#include <stdint.h>
+
+struct drm_i915_gem_context_param;
+
 uint32_t gem_context_create(int fd);
 int __gem_context_create(int fd, uint32_t *ctx_id);
 void gem_context_destroy(int fd, uint32_t ctx_id);
@@ -58,6 +63,9 @@ int __gem_context_get_param(int fd, struct 
drm_i915_gem_context_param *p);
 int __gem_context_set_priority(int fd, uint32_t ctx, int prio);
 void gem_context_set_priority(int fd, uint32_t ctx, int prio);
 
+int __gem_context_set_persistence(int i915, uint32_t ctx, bool state);
+void gem_context_set_persistence(int i915, uint32_t ctx, bool state);
+
 bool gem_context_has_engine(int fd, uint32_t ctx, uint64_t engine);
 
 #endif /* GEM_CONTEXT_H */
diff --git a/lib/igt_dummyload.c b/lib/igt_dummyload.c
index 65b5cc927..6060878dd 100644
--- a/lib/igt_dummyload.c
+++ b/lib/igt_dummyload.c
@@ -450,7 +450,8 @@ void igt_spin_free(int fd, igt_spin_t *spin)
                gem_close(fd, spin->poll_handle);
        }
 
-       gem_close(fd, spin->handle);
+       if (spin->handle)
+               gem_close(fd, spin->handle);
 
        if (spin->out_fence >= 0)
                close(spin->out_fence);
diff --git a/lib/ioctl_wrappers.c b/lib/ioctl_wrappers.c
index 280fdd624..628f8b830 100644
--- a/lib/ioctl_wrappers.c
+++ b/lib/ioctl_wrappers.c
@@ -445,6 +445,7 @@ int gem_wait(int fd, uint32_t handle, int64_t *timeout_ns)
        ret = 0;
        if (igt_ioctl(fd, DRM_IOCTL_I915_GEM_WAIT, &wait))
                ret = -errno;
+       errno = 0;
 
        if (timeout_ns)
                *timeout_ns = wait.timeout_ns;
diff --git a/tests/Makefile.sources b/tests/Makefile.sources
index 343be0500..093eb57f3 100644
--- a/tests/Makefile.sources
+++ b/tests/Makefile.sources
@@ -154,6 +154,9 @@ gem_ctx_isolation_SOURCES = i915/gem_ctx_isolation.c
 TESTS_progs += gem_ctx_param
 gem_ctx_param_SOURCES = i915/gem_ctx_param.c
 
+TESTS_progs += gem_ctx_persistence
+gem_ctx_persistence_SOURCES = i915/gem_ctx_persistence.c
+
 TESTS_progs += gem_ctx_shared
 gem_ctx_shared_SOURCES = i915/gem_ctx_shared.c
 
diff --git a/tests/i915/gem_ctx_persistence.c b/tests/i915/gem_ctx_persistence.c
new file mode 100644
index 000000000..d6ef6b900
--- /dev/null
+++ b/tests/i915/gem_ctx_persistence.c
@@ -0,0 +1,353 @@
+/*
+ * Copyright © 2019 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 <errno.h>
+#include <sys/socket.h>
+#include <sys/types.h>
+#include <unistd.h>
+
+#include "drmtest.h" /* gem_quiescent_gpu()! */
+#include "i915/gem_context.h"
+#include "i915/gem_submission.h"
+#include "igt_debugfs.h"
+#include "igt_dummyload.h"
+#include "ioctl_wrappers.h" /* gem_wait()! */
+#include "sw_sync.h"
+
+static bool has_persistence(int i915)
+{
+       struct drm_i915_gem_context_param p = {
+               .param = I915_CONTEXT_PARAM_PERSISTENCE,
+       };
+       uint64_t saved;
+
+       if (__gem_context_get_param(i915, &p))
+               return false;
+
+       saved = p.value;
+       p.value = 0;
+       if (__gem_context_set_param(i915, &p))
+               return false;
+
+       p.value = saved;
+       return __gem_context_set_param(i915, &p) == 0;
+}
+
+static void test_idempotent(int i915)
+{
+       struct drm_i915_gem_context_param p = {
+               .param = I915_CONTEXT_PARAM_PERSISTENCE,
+       };
+       int expected;
+
+       /*
+        * Simple test to verify that we are able to read back the same boolean
+        * value as we set.
+        *
+        * Each time we invert the current value so that at the end of the test,
+        * if successful, we leave the context in the original state.
+        */
+
+       gem_context_get_param(i915, &p);
+       expected = !!p.value;
+
+       expected = !expected;
+       p.value = expected;
+       gem_context_set_param(i915, &p);
+       gem_context_get_param(i915, &p);
+       igt_assert_eq(p.value, expected);
+
+       expected = !expected; /* and restores */
+       p.value = expected;
+       gem_context_set_param(i915, &p);
+       gem_context_get_param(i915, &p);
+       igt_assert_eq(p.value, expected);
+}
+
+static void test_persistence(int i915)
+{
+       igt_spin_t *spin;
+       int64_t timeout;
+       uint32_t ctx;
+
+       /*
+        * Default behaviour are contexts remain alive until their last active
+        * request is retired -- no early termination.
+        */
+
+       ctx = gem_context_create(i915);
+       gem_context_set_persistence(i915, ctx, true);
+
+       spin = igt_spin_new(i915, ctx, .flags = IGT_SPIN_FENCE_OUT);
+       gem_context_destroy(i915, ctx);
+
+       timeout = NSEC_PER_SEC / 5;
+       igt_assert_eq(gem_wait(i915, spin->handle, &timeout), -ETIME);
+
+       igt_spin_end(spin);
+
+       timeout = NSEC_PER_SEC / 5;
+       igt_assert_eq(gem_wait(i915, spin->handle, &timeout), 0);
+       igt_assert_eq(sync_fence_status(spin->out_fence), 1);
+
+       igt_spin_free(i915, spin);
+       gem_quiescent_gpu(i915);
+}
+
+static void test_nonpersistent_cleanup(int i915)
+{
+       int64_t timeout = NSEC_PER_SEC / 5;
+       igt_spin_t *spin;
+       uint32_t ctx;
+
+       /*
+        * A nonpersistent context is terminated immediately upon closure,
+        * any inflight request is cancelled.
+        */
+
+       ctx = gem_context_create(i915);
+       gem_context_set_persistence(i915, ctx, false);
+
+       spin = igt_spin_new(i915, ctx, .flags = IGT_SPIN_FENCE_OUT);
+       gem_context_destroy(i915, ctx);
+
+       igt_assert_eq(gem_wait(i915, spin->handle, &timeout), 0);
+       igt_assert_eq(sync_fence_status(spin->out_fence), -EIO);
+
+       igt_spin_free(i915, spin);
+       gem_quiescent_gpu(i915);
+}
+
+static void test_nonpersistent_mixed(int i915)
+{
+       int fence[3];
+
+       /*
+        * Only a nonpersistent context is terminated immediately upon
+        * closure, any inflight request is cancelled. If there is also
+        * an active persistent context closed, it should be unafffected.
+        */
+
+       for (int i = 0; i < ARRAY_SIZE(fence); i++) {
+               igt_spin_t *spin;
+               uint32_t ctx;
+
+               ctx = gem_context_create(i915);
+               gem_context_set_persistence(i915, ctx, i & 1);
+
+               spin = igt_spin_new(i915, ctx, .flags = IGT_SPIN_FENCE_OUT);
+               gem_context_destroy(i915, ctx);
+
+               fence[i] = spin->out_fence;
+       }
+
+       /* Outer pair of contexts were non-persistent and killed */
+       igt_assert_eq(sync_fence_wait(fence[0], MSEC_PER_SEC / 5), 0);
+       igt_assert_eq(sync_fence_status(fence[0]), -EIO);
+
+       igt_assert_eq(sync_fence_wait(fence[2], MSEC_PER_SEC / 5), 0);
+       igt_assert_eq(sync_fence_status(fence[2]), -EIO);
+
+       /* But the middle context is still running */
+       igt_assert_eq(sync_fence_wait(fence[1], 0), -ETIME);
+
+       gem_quiescent_gpu(i915);
+}
+
+static void test_nonpersistent_hostile(int i915)
+{
+       int64_t timeout = NSEC_PER_SEC / 2;
+       igt_spin_t *spin;
+       uint32_t ctx;
+
+       /*
+        * If we cannot cleanly cancel the persistent context on closure,
+        * e.g. preemption fails, we are forced to reset the GPU to terminate
+        * the requests and cleanup the context.
+        */
+
+       ctx = gem_context_create(i915);
+       gem_context_set_persistence(i915, ctx, false);
+
+       spin = igt_spin_new(i915, ctx, .flags = IGT_SPIN_NO_PREEMPTION);
+       gem_context_destroy(i915, ctx);
+
+       igt_assert_eq(gem_wait(i915, spin->handle, &timeout), 0);
+
+       igt_spin_free(i915, spin);
+       gem_quiescent_gpu(i915);
+}
+
+static void test_nonpersistent_file(int i915)
+{
+       igt_spin_t *spin;
+       uint32_t ctx;
+
+       /*
+        * A context may live beyond its initial struct file, except if it
+        * has been made nonpersistent, in which case it must be terminated.
+        */
+
+       i915 = gem_reopen_driver(i915);
+
+       ctx = gem_context_create(i915);
+       gem_context_set_persistence(i915, ctx, false);
+
+       spin = igt_spin_new(i915, ctx, .flags = IGT_SPIN_FENCE_OUT);
+       close(i915);
+
+       igt_assert_eq(sync_fence_wait(spin->out_fence, MSEC_PER_SEC / 5), 0);
+       igt_assert_eq(sync_fence_status(spin->out_fence), -EIO);
+
+       spin->handle = 0;
+       igt_spin_free(-1, spin);
+}
+
+static void sendfd(int socket, int fd)
+{
+       char buf[CMSG_SPACE(sizeof(fd))];
+       struct iovec io = { .iov_base = (char *)"ABC", .iov_len = 3 };
+       struct msghdr msg = {
+               .msg_iov = &io,
+               .msg_iovlen = 1,
+               .msg_control = buf,
+               .msg_controllen = CMSG_LEN(sizeof(fd)),
+       };
+       struct cmsghdr *cmsg = CMSG_FIRSTHDR(&msg);
+
+       cmsg->cmsg_level = SOL_SOCKET;
+       cmsg->cmsg_type = SCM_RIGHTS;
+       cmsg->cmsg_len = msg.msg_controllen;
+       *(int *)CMSG_DATA(cmsg) = fd;
+
+       igt_assert(sendmsg(socket, &msg, 0) != -1);
+}
+
+static int recvfd(int socket)
+{
+       char m_buffer[256], c_buffer[256];
+       struct iovec io = {
+               .iov_base = m_buffer,
+               .iov_len = sizeof(m_buffer),
+       };
+       struct msghdr msg = {
+               .msg_iov = &io,
+               .msg_iovlen = 1,
+               .msg_control = c_buffer,
+               .msg_controllen = sizeof(c_buffer),
+       };
+
+       igt_assert(recvmsg(socket, &msg, 0) != -1);
+       return *(int *)CMSG_DATA(CMSG_FIRSTHDR(&msg));
+}
+
+static void test_nonpersistent_process(int i915)
+{
+       int fence[2], sv[2];
+
+       /*
+        * If a process dies early, any nonpersistent contexts it had
+        * open must be terminated too. But any persistent contexts,
+        * should survive until their requests are complete.
+        */
+
+       igt_require(socketpair(AF_UNIX, SOCK_DGRAM, 0, sv) == 0);
+
+       igt_fork(child, 1) {
+               i915 = gem_reopen_driver(i915);
+
+               for (int persists = 0; persists <= 1; persists++) {
+                       igt_spin_t *spin;
+                       uint32_t ctx;
+
+                       ctx = gem_context_create(i915);
+                       gem_context_set_persistence(i915, ctx, persists);
+
+                       spin = igt_spin_new(i915, ctx,
+                                           .flags = IGT_SPIN_FENCE_OUT);
+
+                       sendfd(sv[0], spin->out_fence);
+
+                       igt_list_del(&spin->link); /* prevent autocleanup */
+               }
+       }
+       close(sv[0]);
+       igt_waitchildren();
+
+       fence[0] = recvfd(sv[1]);
+       fence[1] = recvfd(sv[1]);
+       close(sv[1]);
+
+       /* First fence is non-persistent, so should be reset */
+       igt_assert_eq(sync_fence_wait(fence[0], MSEC_PER_SEC / 5), 0);
+       igt_assert_eq(sync_fence_status(fence[0]), -EIO);
+       close(fence[0]);
+
+       /* Second fence is persistent, so should be still spinning */
+       igt_assert_eq(sync_fence_wait(fence[1], 0), -ETIME);
+       close(fence[1]);
+
+       /* We have to manually clean up the orphaned spinner */
+       igt_drop_caches_set(i915, DROP_RESET_ACTIVE);
+
+       gem_quiescent_gpu(i915);
+}
+
+igt_main
+{
+       int i915;
+
+       igt_fixture {
+               i915 = drm_open_driver(DRIVER_INTEL);
+               igt_require_gem(i915);
+
+               igt_require(has_persistence(i915));
+       }
+
+       igt_subtest_group {
+               igt_subtest("idempotent")
+                       test_idempotent(i915);
+
+               igt_subtest("persistence")
+                       test_persistence(i915);
+
+               igt_subtest("cleanup")
+                       test_nonpersistent_cleanup(i915);
+
+               igt_subtest("mixed")
+                       test_nonpersistent_mixed(i915);
+
+               igt_subtest("hostile")
+                       test_nonpersistent_hostile(i915);
+
+               igt_subtest("file")
+                       test_nonpersistent_file(i915);
+
+               igt_subtest("process")
+                       test_nonpersistent_process(i915);
+       }
+
+       igt_fixture {
+               close(i915);
+       }
+}
diff --git a/tests/meson.build b/tests/meson.build
index 7e3f9e0a4..3f3eee277 100644
--- a/tests/meson.build
+++ b/tests/meson.build
@@ -121,6 +121,7 @@ i915_progs = [
        'gem_ctx_exec',
        'gem_ctx_isolation',
        'gem_ctx_param',
+       'gem_ctx_persistence',
        'gem_ctx_shared',
        'gem_ctx_switch',
        'gem_ctx_thrash',
-- 
2.23.0

_______________________________________________
Intel-gfx mailing list
Intel-gfx@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/intel-gfx

Reply via email to