[Intel-gfx] [PATCH] prime_mmap: Add new test for calling mmap() on dma-buf fds

[Ben Widawsky]

On Mon, Mar 17, 2014 at 07:43:35PM +0000, Rob Bradford wrote:
> From: Rob Bradford <rob at linux.intel.com>
> 
> This test has the following subtests:
> - test_correct for correctness of the data
> - test_map_unmap checks for mapping idempotency
> - test_reprime checks for dma-buf creation idempotency
> - test_forked checks for multiprocess access
> - test_refcounting checks for buffer reference counting
> - test_dup chats that dup()ing the fd works
> - test_errors checks the error return values for failures
> - test_aperture_limit tests multiple buffer creation at the gtt aperture
>   limit
> 
> Signed-off-by: Rob Bradford <rob at linux.intel.com>
> ---
>  tests/Makefile.sources |   1 +
>  tests/prime_mmap.c     | 384 +++++++++++++++++++++++++++++++++++++++++++++++++
>  2 files changed, 385 insertions(+)
>  create mode 100644 tests/prime_mmap.c
> 
> diff --git a/tests/Makefile.sources b/tests/Makefile.sources
> index 88866ac..d666381 100644
> --- a/tests/Makefile.sources
> +++ b/tests/Makefile.sources
> @@ -65,6 +65,7 @@ TESTS_progs_M = \
>  	pm_lpsp \
>  	pm_pc8 \
>  	pm_rps \
> +	prime_mmap \
>  	prime_self_import \
>  	template \
>  	$(NULL)
> diff --git a/tests/prime_mmap.c b/tests/prime_mmap.c
> new file mode 100644
> index 0000000..94ba191
> --- /dev/null
> +++ b/tests/prime_mmap.c
> @@ -0,0 +1,384 @@
> +
> +/*
> + * Copyright © 2014 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:
> + *    Rob Bradford <rob at linux.intel.com>
> + *
> + */
> +
> +/*
> + * Testcase: Check whether mmap()ing dma-buf works
> + */
> +#define _GNU_SOURCE
> +#include <unistd.h>
> +#include <stdlib.h>
> +#include <stdio.h>
> +#include <string.h>
> +#include <fcntl.h>
> +#include <inttypes.h>
> +#include <errno.h>
> +#include <sys/stat.h>
> +#include <sys/ioctl.h>
> +#include <pthread.h>
> +
> +#include "drm.h"
> +#include "i915_drm.h"
> +#include "drmtest.h"
> +#include "igt_debugfs.h"
> +#include "ioctl_wrappers.h"
> +
> +#define BO_SIZE (16*1024)
> +
> +static int fd;
> +
> +char pattern[] = {0xff, 0x00, 0x00, 0x00,
> +		  0x00, 0xff, 0x00, 0x00,
> +		  0x00, 0x00, 0xff, 0x00,
> +		  0x00, 0x00, 0x00, 0xff};
> +
> +static void
> +fill_bo(uint32_t handle, size_t size)
> +{
> +	off_t i;
> +	for (i = 0; i < size; i+=sizeof(pattern))
> +	{
> +		gem_write(fd, handle, i, pattern, sizeof(pattern));
> +	}
> +}

It'd probably be much better idea to mmap this, especially if you ever
intend to use a larger buffer.

> +
> +static int
> +pattern_check(char *ptr, size_t size)
> +{
> +	off_t i;
> +	for (i = 0; i < size; i+=sizeof(pattern))
> +	{
> +		if (memcmp(ptr, pattern, sizeof(pattern)) != 0)
> +			return 1;
> +	}
> +
> +	return 0;
> +}
> +
> +static void
> +test_correct(void)
> +{
> +	int dma_buf_fd;
> +	char *ptr1, *ptr2;
> +	uint32_t handle;
> +
> +	handle = gem_create(fd, BO_SIZE);
> +	fill_bo(handle, BO_SIZE);
> +
> +	dma_buf_fd = prime_handle_to_fd(fd, handle);
> +	igt_assert(errno == 0);
> +
> +	/* Check correctness vs GEM_MMAP_GTT */
> +	ptr1 = gem_mmap(fd, handle, BO_SIZE, PROT_READ | PROT_WRITE);
> +	ptr2 = mmap(NULL, BO_SIZE, PROT_READ, MAP_SHARED, dma_buf_fd, 0);
> +	igt_assert(ptr1 != MAP_FAILED);
> +	igt_assert(ptr2 != MAP_FAILED);
> +	igt_assert(memcmp(ptr1, ptr2, BO_SIZE) == 0);
> +
> +	/* Check pattern correctness */
> +	igt_assert(pattern_check(ptr2, BO_SIZE) == 0);

This seems extra paranoid, but ok.

> +
> +	munmap(ptr1, BO_SIZE);
> +	munmap(ptr2, BO_SIZE);
> +	close(dma_buf_fd);
> +	gem_close(fd, handle);
> +}
> +
> +static void
> +test_map_unmap(void)
> +{
> +	int dma_buf_fd;
> +	char *ptr;
> +	uint32_t handle;
> +
> +	handle = gem_create(fd, BO_SIZE);
> +	fill_bo(handle, BO_SIZE);
> +
> +	dma_buf_fd = prime_handle_to_fd(fd, handle);
> +	igt_assert(errno == 0);
> +
> +	ptr = mmap(NULL, BO_SIZE, PROT_READ, MAP_SHARED, dma_buf_fd, 0);
> +	igt_assert(ptr != MAP_FAILED);
> +	igt_assert(pattern_check(ptr, BO_SIZE) == 0);
> +
> +	/* Unmap and remap */
> +	munmap(ptr, BO_SIZE);
> +	ptr = mmap(NULL, BO_SIZE, PROT_READ, MAP_SHARED, dma_buf_fd, 0);
> +	igt_assert(ptr != MAP_FAILED);
> +	igt_assert(pattern_check(ptr, BO_SIZE) == 0);
> +
> +	munmap(ptr, BO_SIZE);
> +	close(dma_buf_fd);
> +	gem_close(fd, handle);
> +}
> +
> +/* prime and then unprime and then prime again the same handle */
> +static void
> +test_reprime(void)
> +{
> +	int dma_buf_fd;
> +	char *ptr;
> +	uint32_t handle;
> +
> +	handle = gem_create(fd, BO_SIZE);
> +	fill_bo(handle, BO_SIZE);
> +
> +	dma_buf_fd = prime_handle_to_fd(fd, handle);
> +	igt_assert(errno == 0);
> +
> +	ptr = mmap(NULL, BO_SIZE, PROT_READ, MAP_SHARED, dma_buf_fd, 0);
> +	igt_assert(ptr != MAP_FAILED);
> +	igt_assert(pattern_check(ptr, BO_SIZE) == 0);
> +
> +	close (dma_buf_fd);
> +	igt_assert(pattern_check(ptr, BO_SIZE) == 0);
> +	munmap(ptr, BO_SIZE);
> +
> +	dma_buf_fd = prime_handle_to_fd(fd, handle);
> +	ptr = mmap(NULL, BO_SIZE, PROT_READ, MAP_SHARED, dma_buf_fd, 0);
> +	igt_assert(ptr != MAP_FAILED);
> +	igt_assert(pattern_check(ptr, BO_SIZE) == 0);
> +
> +	munmap(ptr, BO_SIZE);
> +	close(dma_buf_fd);
> +	gem_close(fd, handle);
> +}

I'm not really sure how useful this test is - but I don't know all that
much about how the internals work.

> +
> +/* map from another process */
> +static void
> +test_forked(void)
> +{
> +	int dma_buf_fd;
> +	char *ptr;
> +	uint32_t handle;
> +
> +	handle = gem_create(fd, BO_SIZE);
> +	fill_bo(handle, BO_SIZE);
> +
> +	dma_buf_fd = prime_handle_to_fd(fd, handle);
> +	igt_assert(errno == 0);
> +
> +	igt_fork(childno, 1) {
> +		ptr = mmap(NULL, BO_SIZE, PROT_READ, MAP_SHARED, dma_buf_fd, 0);
> +		igt_assert(ptr != MAP_FAILED);
> +		igt_assert(pattern_check(ptr, BO_SIZE) == 0);
> +		munmap(ptr, BO_SIZE);
> +		close(dma_buf_fd);
> +	}
> +	close(dma_buf_fd);
> +	igt_waitchildren();
> +	gem_close(fd, handle);
> +}
> +
> +static void
> +test_refcounting(void)
> +{
> +	int dma_buf_fd;
> +	char *ptr;
> +	uint32_t handle;
> +
> +	handle = gem_create(fd, BO_SIZE);
> +	fill_bo(handle, BO_SIZE);
> +
> +	dma_buf_fd = prime_handle_to_fd(fd, handle);
> +	igt_assert(errno == 0);
> +	/* Close gem object before mapping */
> +	gem_close(fd, handle);
> +
> +	ptr = mmap(NULL, BO_SIZE, PROT_READ, MAP_SHARED, dma_buf_fd, 0);
> +	igt_assert(ptr != MAP_FAILED);
> +	igt_assert(pattern_check(ptr, BO_SIZE) == 0);
> +	munmap(ptr, BO_SIZE);
> +	close (dma_buf_fd);
> +}
> +
> +/* dup before mmap */
> +static void
> +test_dup(void)
> +{
> +	int dma_buf_fd;
> +	char *ptr;
> +	uint32_t handle;
> +
> +	handle = gem_create(fd, BO_SIZE);
> +	fill_bo(handle, BO_SIZE);
> +
> +	dma_buf_fd = dup(prime_handle_to_fd(fd, handle));
> +	igt_assert(errno == 0);
> +
> +	ptr = mmap(NULL, BO_SIZE, PROT_READ, MAP_SHARED, dma_buf_fd, 0);
> +	igt_assert(ptr != MAP_FAILED);
> +	igt_assert(pattern_check(ptr, BO_SIZE) == 0);
> +	munmap(ptr, BO_SIZE);
> +	gem_close(fd, handle);
> +	close (dma_buf_fd);
> +}
> +
> +
> +/* Used for error case testing to avoid wrapper */
> +static int prime_handle_to_fd_no_assert(uint32_t handle, int *fd_out)
> +{
> +	struct drm_prime_handle args;
> +	int ret;
> +
> +	args.handle = handle;
> +	args.flags = DRM_CLOEXEC;
> +	args.fd = -1;
> +
> +	ret = drmIoctl(fd, DRM_IOCTL_PRIME_HANDLE_TO_FD, &args);
> +
> +	*fd_out = args.fd;
> +
> +	return ret;
> +}
> +
> +static void
> +test_errors(void)
> +{
> +	int dma_buf_fd;
> +	char *ptr;
> +	uint32_t handle;
> +
> +	/* Close gem object before priming */
> +	handle = gem_create(fd, BO_SIZE);
> +	fill_bo(handle, BO_SIZE);
> +	gem_close(fd, handle);
> +	prime_handle_to_fd_no_assert(handle, &dma_buf_fd);
> +	igt_assert(dma_buf_fd == -1 && errno == ENOENT);
> +	errno = 0;
> +
> +	/* close fd before mapping */
> +	handle = gem_create(fd, BO_SIZE);
> +	fill_bo(handle, BO_SIZE);
> +	dma_buf_fd = prime_handle_to_fd(fd, handle);
> +	igt_assert(errno == 0);
> +	close(dma_buf_fd);
> +	ptr = mmap(NULL, BO_SIZE, PROT_READ, MAP_SHARED, dma_buf_fd, 0);
> +	igt_assert(ptr == MAP_FAILED && errno == EBADF);
> +	errno = 0;
> +	gem_close(fd, handle);
> +
> +	/* Map too big */
> +	handle = gem_create(fd, BO_SIZE);
> +	fill_bo(handle, BO_SIZE);
> +	dma_buf_fd = prime_handle_to_fd(fd, handle);
> +	igt_assert(errno == 0);
> +	ptr = mmap(NULL, BO_SIZE * 2, PROT_READ, MAP_SHARED, dma_buf_fd, 0);
> +	igt_assert(ptr == MAP_FAILED && errno == EINVAL);
> +	errno = 0;
> +	close(dma_buf_fd);
> +	gem_close(fd, handle);
> +}
> +
> +static void
> +test_aperture_limit(void)
> +{
> +	int dma_buf_fd1, dma_buf_fd2;
> +	char *ptr1, *ptr2;
> +	uint32_t handle1, handle2;
> +	/* Two buffers the sum of which > mappable aperture */
> +	uint64_t size1 = (gem_mappable_aperture_size() * 7) / 8;
> +	uint64_t size2 = (gem_mappable_aperture_size() * 3) / 8;
> +
> +	handle1 = gem_create(fd, size1);
> +	fill_bo(handle1, BO_SIZE);
> +
> +	dma_buf_fd1 = prime_handle_to_fd(fd, handle1);
> +	igt_assert(errno == 0);
> +	ptr1 = mmap(NULL, size1, PROT_READ, MAP_SHARED, dma_buf_fd1, 0);
> +	igt_assert(ptr1 != MAP_FAILED);
> +	igt_assert(pattern_check(ptr1, BO_SIZE) == 0);
> +
> +	handle2 = gem_create(fd, size1);
> +	fill_bo(handle2, BO_SIZE);
> +	dma_buf_fd2 = prime_handle_to_fd(fd, handle2);
> +	igt_assert(errno == 0);
> +	ptr2 = mmap(NULL, size2, PROT_READ, MAP_SHARED, dma_buf_fd2, 0);
> +	igt_assert(ptr2 != MAP_FAILED);
> +	igt_assert(pattern_check(ptr2, BO_SIZE) == 0);
> +
> +	igt_assert(memcmp(ptr1, ptr2, BO_SIZE) == 0);
> +
> +	munmap(ptr1, size1);
> +	munmap(ptr2, size2);
> +	close(dma_buf_fd1);
> +	close(dma_buf_fd2);
> +	gem_close(fd, handle1);
> +	gem_close(fd, handle2);
> +}
> +
> +static int
> +check_for_dma_buf_mmap(void)
> +{
> +	int dma_buf_fd;
> +	char *ptr;
> +	uint32_t handle;
> +	int ret = 1;
> +
> +	handle = gem_create(fd, BO_SIZE);
> +	dma_buf_fd = prime_handle_to_fd(fd, handle);
> +	ptr = mmap(NULL, BO_SIZE, PROT_READ, MAP_SHARED, dma_buf_fd, 0);
> +	if (ptr != MAP_FAILED)
> +		ret = 0;
> +	munmap(ptr, BO_SIZE);
> +	gem_close(fd, handle);
> +	close (dma_buf_fd);
> +	return ret;
> +}
> +
> +igt_main
> +{
> +	struct {
> +		const char *name;
> +		void (*fn)(void);
> +	} tests[] = {
> +		{ "test_correct", test_correct },
> +		{ "test_map_unmap", test_map_unmap },
> +		{ "test_reprime", test_reprime },
> +		{ "test_forked", test_forked },
> +		{ "test_refcounting", test_refcounting },
> +		{ "test_dup", test_dup },
> +		{ "test_errors", test_errors },
> +		{ "test_aperture_limit", test_aperture_limit },
> +	};
> +	int i;
> +
> +	igt_fixture {
> +		fd = drm_open_any();
> +		errno = 0;
> +	}
> +
> +	igt_skip_on((check_for_dma_buf_mmap() != 0));
> +
> +	for (i = 0; i < ARRAY_SIZE(tests); i++) {
> +		igt_subtest(tests[i].name)
> +			tests[i].fn();
> +	}
> +
> +	igt_fixture
> +		close(fd);
> +}
> -- 

lgtm. Put the commit message in the test description and call it
Reviewed-by: Ben Widawsky <ben at bwidawsk.net>

I'm pretty impressed you used all the igt_*_foo.

-- 
Ben Widawsky, Intel Open Source Technology Center