tests/dumb_buffer: Tests for creation and map

Dumb buffer creation and mapping are covered with test cases.

v2:
  Made as a generic test for dumb buffer creation [Chris]
v3:
  dumb_map is used [Chris]
  Added two tests for map.

Signed-off-by: Ramalingam C <ramalingam.c@intel.com>
Cc: Chris Wilson <chris@chris-wilson.co.uk>
Reviewed-by: Chris Wilson <chris@chris-wilson.co.uk>
Signed-off-by: Chris Wilson <chris@chris-wilson.co.uk>

1 files changed, 384 insertions, 0 deletions

diff --git a/tests/dumb_buffer.c b/tests/dumb_buffer.c
new file mode 100644
index 00000000..5774a73f
--- /dev/null
+++ b/tests/dumb_buffer.c
@@ -0,0 +1,384 @@
+/*
+ * 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.
+ *
+ * Authors:
+ *    Ramalingam C <ramalingam.c@intel.com>
+ *
+ */
+
+/** @file dumb_buffer.c
+ *
+ * The goal is to simply ensure that basics work and invalid input
+ * combinations are rejected.
+ */
+
+#include <stdlib.h>
+#include <sys/ioctl.h>
+#include <stdio.h>
+#include <string.h>
+#include <fcntl.h>
+#include <inttypes.h>
+#include <errno.h>
+#include <sys/stat.h>
+#include <sys/time.h>
+#include <getopt.h>
+#include <pthread.h>
+#include <stdatomic.h>
+
+#include <drm.h>
+
+#include "drmtest.h"
+#include "igt_aux.h"
+#include "ioctl_wrappers.h"
+
+IGT_TEST_DESCRIPTION("This is a test for the generic dumb buffer interface.");
+
+#define PAGE_SIZE 4096
+
+static int __dumb_create(int fd, struct drm_mode_create_dumb *create)
+{
+	int err = 0;
+
+	if (igt_ioctl(fd, DRM_IOCTL_MODE_CREATE_DUMB, create)) {
+		err = -errno;
+		igt_assume(err);
+	}
+
+	errno = 0;
+	return err;
+}
+
+static void dumb_create(int fd, struct drm_mode_create_dumb *create)
+{
+	igt_assert_eq(__dumb_create(fd, create), 0);
+}
+
+static void *__dumb_map(int fd, uint32_t handle, uint64_t size, unsigned prot)
+{
+	struct drm_mode_map_dumb arg = { handle };
+	void *ptr;
+
+	if (igt_ioctl(fd, DRM_IOCTL_MODE_MAP_DUMB, &arg))
+		return NULL;
+
+	ptr = mmap(NULL, size, prot, MAP_SHARED, fd, arg.offset);
+	if (ptr == MAP_FAILED)
+		return NULL;
+
+	return ptr;
+}
+
+static void *dumb_map(int fd, uint32_t handle, uint64_t size, unsigned prot)
+{
+	void *ptr;
+
+	ptr = __dumb_map(fd, handle, size, prot);
+	igt_assert(ptr);
+
+	return ptr;
+}
+
+static int __dumb_destroy(int fd, uint32_t handle)
+{
+	struct drm_mode_destroy_dumb arg = { handle };
+	int err = 0;
+
+	if (igt_ioctl(fd, DRM_IOCTL_MODE_DESTROY_DUMB, &arg)) {
+		err = -errno;
+		igt_assume(err);
+	}
+
+	errno = 0;
+	return err;
+}
+
+static void dumb_destroy(int fd, uint32_t handle)
+{
+	igt_assert_eq(__dumb_destroy(fd, handle), 0);
+}
+
+static void invalid_dimensions_test(int fd)
+{
+	struct drm_mode_create_dumb create;
+
+	memset(&create, 0, sizeof(create));
+	create.width = 4032;
+	create.height = 2016;
+	create.bpp = 24;
+	igt_assert_eq(__dumb_create(fd, &create), -EINVAL);
+
+	create.bpp = 32;
+	create.width = 0;
+	igt_assert_eq(__dumb_create(fd, &create), -EINVAL);
+
+	create.width = 4032;
+	create.height = 0;
+	igt_assert_eq(__dumb_create(fd, &create), -EINVAL);
+}
+
+static void valid_dumb_creation_test(int fd)
+{
+	struct drm_mode_create_dumb create = {
+		.width = 4032,
+		.height = 2016,
+		.bpp = 32,
+	};
+
+	dumb_create(fd, &create);
+	dumb_destroy(fd, create.handle);
+}
+
+static void valid_map(int fd)
+{
+	struct drm_mode_create_dumb create = {
+		.width = 4032,
+		.height = 2016,
+		.bpp = 32,
+	};
+
+	dumb_create(fd, &create);
+	munmap(dumb_map(fd, create.handle, create.size, PROT_READ),
+	       create.size);
+	dumb_destroy(fd, create.handle);
+}
+
+static void uaf_map(int fd)
+{
+	struct drm_mode_create_dumb create = {
+		.width = 4032,
+		.height = 2016,
+		.bpp = 32,
+	};
+	uint32_t *ptr;
+
+	dumb_create(fd, &create);
+	ptr = dumb_map(fd, create.handle, create.size, PROT_READ),
+	dumb_destroy(fd, create.handle);
+
+	igt_assert_eq(*ptr, 0);
+	munmap(ptr, create.size);
+}
+
+static void invalid_size_map(int fd)
+{
+	struct drm_mode_map_dumb arg = {};
+	struct drm_mode_create_dumb create = {
+		.width = 4032,
+		.height = 2016,
+		.bpp = 32,
+	};
+	void *ptr;
+
+	dumb_create(fd, &create);
+
+	arg.handle = create.handle;
+	do_ioctl(fd, DRM_IOCTL_MODE_MAP_DUMB, &arg);
+
+	ptr = mmap(NULL, create.size + 1, PROT_READ | PROT_WRITE,
+		   MAP_SHARED, fd, arg.offset);
+	igt_assert(ptr == MAP_FAILED);
+
+	dumb_destroy(fd, create.handle);
+}
+
+/*
+ * Creating an dumb buffer with non-aligned size and trying to access it with an
+ * offset, which is greater than the requested size but smaller than the
+ * object's last page boundary. pwrite here must be successful.
+ */
+static void valid_nonaligned_size(int fd)
+{
+	struct drm_mode_create_dumb create = {
+		.width = 24,
+		.height = 24,
+		.bpp = 32,
+	};
+	char buf[PAGE_SIZE];
+
+	igt_require(is_i915_device(fd));
+
+	dumb_create(fd, &create);
+
+	gem_write(fd, create.handle, PAGE_SIZE / 2, buf, PAGE_SIZE / 2);
+
+	dumb_destroy(fd, create.handle);
+}
+
+/*
+ * Creating an object with non-aligned size and trying to access it with an
+ * offset, which is greater than the requested size and larger than the
+ * object's last page boundary. pwrite here must fail.
+ */
+static void invalid_nonaligned_size(int fd)
+{
+	struct drm_mode_create_dumb create = {
+		.width = 24,
+		.height = 24,
+		.bpp = 32,
+	};
+	char buf[PAGE_SIZE];
+
+	igt_require(is_i915_device(fd));
+
+	dumb_create(fd, &create);
+	/* This should fail. Hence cannot use gem_write. */
+	igt_assert(__gem_write(fd, create.handle,
+			       create.size - (PAGE_SIZE / 2), buf, PAGE_SIZE));
+	dumb_destroy(fd, create.handle);
+}
+
+static uint64_t atomic_compare_swap_u64(_Atomic(uint64_t) *ptr,
+					uint64_t oldval, uint64_t newval)
+{
+	atomic_compare_exchange_strong(ptr, &oldval, newval);
+	return oldval;
+}
+
+static uint64_t get_npages(_Atomic(uint64_t) *global, uint64_t npages)
+{
+	uint64_t try, old, max;
+
+	max = *global;
+	do {
+		old = max;
+		try = 1 + npages % ((max / 2) ? (max / 2) : 1);
+		max -= try;
+	} while ((max = atomic_compare_swap_u64(global, old, max)) != old);
+
+	return try;
+}
+
+struct thread_clear {
+	_Atomic(uint64_t) max;
+	int timeout;
+	int fd;
+};
+
+#define MAX_PAGE_TO_REQUEST	102400
+
+static void *thread_clear(void *data)
+{
+	struct thread_clear *arg = data;
+	unsigned long checked = 0;
+	int fd = arg->fd;
+	void *ptr;
+
+	igt_until_timeout(arg->timeout) {
+		struct drm_mode_create_dumb create = {};
+		uint64_t npages;
+
+		npages = random();
+		npages = npages << 32;
+		npages |= random();
+		npages = get_npages(&arg->max, npages);
+
+		for (uint64_t _npages = npages; npages > 0; npages -= _npages) {
+			create.bpp = 32;
+			create.width = PAGE_SIZE / (create.bpp / 8);
+			_npages = npages <= MAX_PAGE_TO_REQUEST ? npages :
+				  MAX_PAGE_TO_REQUEST;
+			create.height = _npages;
+
+			dumb_create(fd, &create);
+			igt_assert_eq(PAGE_SIZE * create.height, create.size);
+
+			ptr = dumb_map(fd,
+				       create.handle, create.size,
+				       PROT_WRITE);
+
+			for (uint64_t page = 0; page < create.height; page++) {
+				uint64_t x;
+
+				memcpy(&x,
+				       ptr + page * 4096 + page % (4096 - sizeof(x)),
+				       sizeof(x));
+				igt_assert_eq_u64(x, 0);
+			}
+
+			munmap(ptr, create.size);
+
+			dumb_destroy(fd, create.handle);
+			atomic_fetch_add(&arg->max, _npages);
+				checked += _npages;
+		}
+	}
+
+	return (void *)(uintptr_t)checked;
+}
+
+static void always_clear(int fd, int timeout)
+{
+	struct thread_clear arg = {
+		.fd = fd,
+		.timeout = timeout,
+		.max = intel_get_avail_ram_mb() << (20 - 12), /* in pages */
+	};
+	const int ncpus = sysconf(_SC_NPROCESSORS_ONLN);
+	unsigned long checked;
+	pthread_t thread[ncpus];
+	void *result;
+
+	for (int i = 0; i < ncpus; i++)
+		pthread_create(&thread[i], NULL, thread_clear, &arg);
+
+	checked = 0;
+	for (int i = 0; i < ncpus; i++) {
+		pthread_join(thread[i], &result);
+		checked += (uintptr_t)result;
+	}
+	igt_info("Checked %'lu page allocations\n", checked);
+}
+
+igt_main
+{
+	int fd = -1;
+
+	igt_skip_on_simulation();
+
+	igt_fixture {
+		fd = drm_open_driver(DRIVER_ANY);
+	}
+
+	igt_subtest("invalid-bpp")
+		invalid_dimensions_test(fd);
+
+	igt_subtest("create-valid-dumb")
+		valid_dumb_creation_test(fd);
+
+	igt_subtest("create-valid-nonaligned")
+		valid_nonaligned_size(fd);
+
+	igt_subtest("create-invalid-nonaligned")
+		invalid_nonaligned_size(fd);
+
+	igt_subtest("map-valid")
+		valid_map(fd);
+
+	igt_subtest("map-uaf")
+		uaf_map(fd);
+
+	igt_subtest("map-invalid-size")
+		invalid_size_map(fd);
+
+	igt_subtest("create-clear")
+		always_clear(fd, 30);
+}