tests/kms_sequence: Add tests for new CRTC get/queue sequence ioctls [v2]

These ioctls replace drmWaitVBlank and add ns time resolution and
64-bit sequence numbers to comply with the Vulkan API specifications.

The tests were derived from the existing kms_vblank tests with the
'wait' variant elided as the new API doesn't provide a mechanism for
blocking in the kernel.

v2: from Dave Airlie <airlied@redhat.com>

 * Add local definitions of new ioctls to avoid requiring latest
   libdrm.

 * Remove FIRST_PIXEL_OUT as that has been removed from the proposed
   kernel patches.

Signed-off-by: Keith Packard <keithp@keithp.com>

5 files changed, 321 insertions, 1 deletions

diff --git a/lib/igt_kms.c b/lib/igt_kms.c
index 379bd0c3..44285baa 100644
--- a/lib/igt_kms.c
+++ b/lib/igt_kms.c
@@ -1983,7 +1983,7 @@ report_dup:
 	}
 }
 
-static igt_pipe_t *igt_output_get_driving_pipe(igt_output_t *output)
+igt_pipe_t *igt_output_get_driving_pipe(igt_output_t *output)
 {
 	igt_display_t *display = output->display;
 	enum pipe pipe;
diff --git a/lib/igt_kms.h b/lib/igt_kms.h
index 8dc118c9..92b66676 100644
--- a/lib/igt_kms.h
+++ b/lib/igt_kms.h
@@ -397,6 +397,7 @@ igt_plane_t *igt_output_get_plane(igt_output_t *output, int plane_idx);
 igt_plane_t *igt_output_get_plane_type(igt_output_t *output, int plane_type);
 igt_output_t *igt_output_from_connector(igt_display_t *display,
     drmModeConnector *connector);
+igt_pipe_t *igt_output_get_driving_pipe(igt_output_t *output);
 igt_plane_t *igt_pipe_get_plane_type(igt_pipe_t *pipe, int plane_type);
 bool igt_pipe_get_property(igt_pipe_t *pipe, const char *name,
 			   uint32_t *prop_id, uint64_t *value,
diff --git a/tests/Makefile.sources b/tests/Makefile.sources
index bb6652e2..9dc1d250 100644
--- a/tests/Makefile.sources
+++ b/tests/Makefile.sources
@@ -215,6 +215,7 @@ TESTS_progs = \
 	kms_tv_load_detect \
 	kms_universal_plane \
 	kms_vblank \
+	kms_sequence \
 	meta_test \
 	perf \
 	pm_backlight \
diff --git a/tests/kms_sequence.c b/tests/kms_sequence.c
new file mode 100644
index 00000000..783dda25
--- /dev/null
+++ b/tests/kms_sequence.c
@@ -0,0 +1,317 @@
+/*
+ * Copyright © 2015 Intel Corporation
+ * Copyright © 2017 Keith Packard
+ *
+ * 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.
+ */
+
+/** @file kms_sequence.c
+ *
+ * This is a test of drmCrtcGetSequence and drmCrtcQueueSequence
+ */
+
+#include "igt.h"
+#include <stdlib.h>
+#include <stdio.h>
+#include <string.h>
+#include <fcntl.h>
+#include <inttypes.h>
+#include <errno.h>
+#include <time.h>
+#include <sys/poll.h>
+#include <sys/stat.h>
+#include <sys/time.h>
+#include <sys/wait.h>
+
+#include <drm.h>
+
+#include "intel_bufmgr.h"
+
+IGT_TEST_DESCRIPTION("Test CrtcGetSequence and CrtcQueueSequence.");
+
+typedef struct {
+	igt_display_t display;
+	struct igt_fb primary_fb;
+	igt_output_t *output;
+	uint32_t crtc_id;
+	enum pipe pipe;
+	unsigned int flags;
+#define IDLE 1
+#define BUSY 2
+#define FORKED 4
+} data_t;
+
+struct local_drm_crtc_get_sequence {
+	__u32 crtc_id;
+	__u32 active;
+	__u64 sequence;
+	__u64 sequence_ns;
+};
+
+struct local_drm_crtc_queue_sequence {
+	__u32 crtc_id;
+	__u32 flags;
+	__u64 sequence;
+	__u64 user_data;
+};
+
+#define LOCAL_DRM_IOCTL_CRTC_GET_SEQUENCE     DRM_IOWR(0x3b, struct local_drm_crtc_get_sequence)
+#define LOCAL_DRM_IOCTL_CRTC_QUEUE_SEQUENCE   DRM_IOWR(0x3c, struct local_drm_crtc_queue_sequence)
+
+#define LOCAL_DRM_CRTC_SEQUENCE_RELATIVE              0x00000001      /* sequence is relative to current */
+#define LOCAL_DRM_CRTC_SEQUENCE_NEXT_ON_MISS          0x00000002      /* Use next sequence if we've missed */
+
+struct local_drm_event_crtc_sequence {
+        struct drm_event        base;
+        __u64                   user_data;
+        __s64                   time_ns;
+        __u64                   sequence;
+};
+
+
+static double elapsed(const struct timespec *start,
+		      const struct timespec *end,
+		      int loop)
+{
+	return (1e6*(end->tv_sec - start->tv_sec) + (end->tv_nsec - start->tv_nsec)/1000)/loop;
+}
+
+static void prepare_crtc(data_t *data, int fd, igt_output_t *output)
+{
+	drmModeModeInfo *mode;
+	igt_display_t *display = &data->display;
+	igt_plane_t *primary;
+
+	/* select the pipe we want to use */
+	igt_output_set_pipe(output, data->pipe);
+
+	/* create and set the primary plane fb */
+	mode = igt_output_get_mode(output);
+	igt_create_color_fb(fd, mode->hdisplay, mode->vdisplay,
+			    DRM_FORMAT_XRGB8888,
+			    LOCAL_DRM_FORMAT_MOD_NONE,
+			    0.0, 0.0, 0.0,
+			    &data->primary_fb);
+
+	primary = igt_output_get_plane_type(output, DRM_PLANE_TYPE_PRIMARY);
+	igt_plane_set_fb(primary, &data->primary_fb);
+
+	data->crtc_id = primary->pipe->crtc_id;
+
+	igt_display_commit(display);
+
+	igt_wait_for_vblank(fd, data->pipe);
+}
+
+static void cleanup_crtc(data_t *data, int fd, igt_output_t *output)
+{
+	igt_display_t *display = &data->display;
+	igt_plane_t *primary;
+
+	igt_remove_fb(fd, &data->primary_fb);
+
+	primary = igt_output_get_plane_type(output, DRM_PLANE_TYPE_PRIMARY);
+	igt_plane_set_fb(primary, NULL);
+
+	igt_output_set_pipe(output, PIPE_ANY);
+	igt_display_commit(display);
+}
+
+static int crtc_get_sequence(int fd, struct local_drm_crtc_get_sequence *cgs)
+{
+	int err;
+
+	err = 0;
+	if (igt_ioctl(fd, LOCAL_DRM_IOCTL_CRTC_GET_SEQUENCE, cgs))
+		err = -errno;
+
+	return err;
+}
+
+static int crtc_queue_sequence(int fd, struct local_drm_crtc_queue_sequence *cqs)
+{
+	int err;
+
+	err = 0;
+	if (igt_ioctl(fd, LOCAL_DRM_IOCTL_CRTC_QUEUE_SEQUENCE, cqs))
+		err = -errno;
+	return err;
+}
+
+static void run_test(data_t *data, int fd, void (*testfunc)(data_t *, int, int))
+{
+	int nchildren =
+		data->flags & FORKED ? sysconf(_SC_NPROCESSORS_ONLN) : 1;
+	igt_display_t *display = &data->display;
+	igt_output_t *output;
+	enum pipe p;
+	unsigned int valid_tests = 0;
+
+	for_each_pipe_with_valid_output(display, p, output) {
+		data->pipe = p;
+		prepare_crtc(data, fd, output);
+
+		igt_info("Beginning %s on pipe %s, connector %s (%d threads)\n",
+			 igt_subtest_name(),
+			 kmstest_pipe_name(data->pipe),
+			 igt_output_name(output),
+			 nchildren);
+
+		if (data->flags & BUSY) {
+			struct local_drm_crtc_queue_sequence cqs;
+
+			memset(&cqs, 0, sizeof(cqs));
+			cqs.crtc_id = data->crtc_id;
+			cqs.flags = LOCAL_DRM_CRTC_SEQUENCE_RELATIVE;
+			cqs.sequence = 120 + 12;
+			igt_assert_eq(crtc_queue_sequence(fd, &cqs), 0);
+		}
+
+		igt_fork(child, nchildren)
+			testfunc(data, fd, nchildren);
+		igt_waitchildren();
+
+		if (data->flags & BUSY) {
+			struct drm_event_vblank buf;
+			igt_assert_eq(read(fd, &buf, sizeof(buf)), sizeof(buf));
+		}
+
+		igt_assert(poll(&(struct pollfd){fd, POLLIN}, 1, 0) == 0);
+
+		igt_info("\n%s on pipe %s, connector %s: PASSED\n\n",
+			 igt_subtest_name(),
+			 kmstest_pipe_name(data->pipe),
+			 igt_output_name(output));
+
+		/* cleanup what prepare_crtc() has done */
+		cleanup_crtc(data, fd, output);
+		valid_tests++;
+	}
+
+	igt_require_f(valid_tests,
+		      "no valid crtc/connector combinations found\n");
+}
+
+static void sequence_get(data_t *data, int fd, int nchildren)
+{
+	struct local_drm_crtc_get_sequence cgs;
+	struct timespec start, end;
+	unsigned long sq, count = 0;
+
+	memset(&cgs, 0, sizeof(cgs));
+	cgs.crtc_id = data->crtc_id;
+	igt_assert_eq(crtc_get_sequence(fd, &cgs), 0);
+
+	sq = cgs.sequence;
+
+	clock_gettime(CLOCK_MONOTONIC, &start);
+	do {
+		igt_assert_eq(crtc_get_sequence(fd, &cgs), 0);
+		count++;
+	} while ((cgs.sequence - sq) <= 120);
+	clock_gettime(CLOCK_MONOTONIC, &end);
+
+	igt_info("Time to get current counter (%s):		%7.3fµs\n",
+		 data->flags & BUSY ? "busy" : "idle", elapsed(&start, &end, count));
+}
+
+static void sequence_queue(data_t *data, int fd, int nchildren)
+{
+	struct local_drm_crtc_get_sequence cgs_start, cgs_end;
+	struct local_drm_crtc_queue_sequence cqs;
+	unsigned long target;
+	int total = 120 / nchildren;
+	int n;
+	double frame_time;
+
+	memset(&cgs_start, 0, sizeof(cgs_start));
+	cgs_start.crtc_id = data->crtc_id;
+	igt_assert_eq(crtc_get_sequence(fd, &cgs_start), 0);
+
+	target = cgs_start.sequence + total;
+	for (n = 0; n < total; n++) {
+		memset(&cqs, 0, sizeof(cqs));
+		cqs.crtc_id = data->crtc_id;
+		cqs.flags = 0;
+		cqs.sequence = target;
+		igt_assert_eq(crtc_queue_sequence(fd, &cqs), 0);
+		igt_assert_eq(cqs.sequence, target);
+	}
+
+	for (n = 0; n < total; n++) {
+		struct local_drm_event_crtc_sequence ev;
+		igt_assert_eq(read(fd, &ev, sizeof(ev)), sizeof(ev));
+		igt_assert_eq(ev.sequence, target);
+	}
+	memset(&cgs_end, 0, sizeof(cgs_end));
+	cgs_end.crtc_id = data->crtc_id;
+	igt_assert_eq(crtc_get_sequence(fd, &cgs_end), 0);
+	igt_assert_eq(cgs_end.sequence, target);
+
+	frame_time = (double) (cgs_end.sequence_ns - cgs_start.sequence_ns) / (1e9 * total);
+	igt_info("Time per frame from queue to event (%s):      %7.3fms(%7.3fHz)\n",
+		 data->flags & BUSY ? "busy" : "idle",
+		 frame_time * 1000.0, 1.0/frame_time);
+}
+
+igt_main
+{
+	int fd;
+	data_t data;
+	const struct {
+		const char *name;
+		void (*func)(data_t *, int, int);
+		unsigned int valid;
+	} funcs[] = {
+		{ "get", sequence_get, IDLE | FORKED | BUSY },
+		{ "queue", sequence_queue, IDLE | BUSY },
+		{ }
+	}, *f;
+	const struct {
+		const char *name;
+		unsigned int flags;
+	} modes[] = {
+		{ "idle", IDLE },
+		{ "forked", IDLE | FORKED },
+		{ "busy", BUSY },
+		{ "forked-busy", BUSY | FORKED },
+		{ }
+	}, *m;
+
+	igt_skip_on_simulation();
+
+	igt_fixture {
+		fd = drm_open_driver(DRIVER_ANY);
+		kmstest_set_vt_graphics_mode();
+		igt_display_init(&data.display, fd);
+	}
+
+	for (f = funcs; f->name; f++) {
+		for (m = modes; m->name; m++) {
+			if (m->flags & ~f->valid)
+				continue;
+
+			igt_subtest_f("%s-%s", f->name, m->name) {
+				data.flags = m->flags;
+				run_test(&data, fd, f->func);
+			}
+		}
+	}
+}
diff --git a/tests/meson.build b/tests/meson.build
index 6cb3584a..af986eb6 100644
--- a/tests/meson.build
+++ b/tests/meson.build
@@ -195,6 +195,7 @@ test_progs = [
 	'kms_tv_load_detect',
 	'kms_universal_plane',
 	'kms_vblank',
+	'kms_sequence',
 	'meta_test',
 	'perf',
 	'pm_backlight',