Received-SPF: pass (google.com: domain of linux-kernel+bounces-144925-linux.lists.archive=gmail.com@vger.kernel.org designates 139.178.88.99 as permitted sender) client-ip=139.178.88.99;
Message-ID: <d2b9540d-41fa-4ea1-95e4-82cf13d97287@collabora.com>
Date: Mon, 15 Apr 2024 15:42:54 +0500
Precedence: bulk
MIME-Version: 1.0
User-Agent: Mozilla Thunderbird
Cc: Muhammad Usama Anjum <usama.anjum@collabora.com>, kernel@collabora.com,
 linux-kselftest@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: Re: [PATCH v6] selftests/dmabuf-heap: conform test to TAP format
 output
To: Shuah Khan <shuah@kernel.org>, "T.J. Mercier" <tjmercier@google.com>
References: <20240327115353.3634735-1-usama.anjum@collabora.com>
 <84cd09fe-0d80-4e30-a8ab-3da7a1d43089@collabora.com>
 <18270cdc-e749-4982-8ae3-879133fcee8d@collabora.com>
Content-Language: en-US
From: Muhammad Usama Anjum <usama.anjum@collabora.com>
In-Reply-To: <18270cdc-e749-4982-8ae3-879133fcee8d@collabora.com>
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 7bit

I may d missed the acceptance email. The patch is already in the next.

On 4/14/24 6:22 PM, Muhammad Usama Anjum wrote:
> Kind reminder
> 
> On 4/4/24 4:49 PM, Muhammad Usama Anjum wrote:
>> Soft reminder
>>
>> On 3/27/24 4:53 PM, Muhammad Usama Anjum wrote:
>>> Conform the layout, informational and status messages to TAP. No
>>> functional change is intended other than the layout of output messages.
>>> Improve the TAP messages as well.
>>>
>>> Reviewed-by: T.J. Mercier <tjmercier@google.com>
>>> Signed-off-by: Muhammad Usama Anjum <usama.anjum@collabora.com>
>>> ---
>>> Changes since v5:
>>> - Make the TAP messages more by adding more informat
>>>
>>> Changes since v4:
>>> - close fds correctly with code changes added in v3
>>>
>>> Chanages since v3:
>>> - abort test-case instead of exiting if heap/mem allocation fails
>>> - Correct test_alloc_zeroed() test case in case of failure
>>>
>>> Changes since v2:
>>> - Minor improvements in test_alloc_zeroed() results
>>>
>>> Changes since v1:
>>> - Update some more error handling code
>>> ---
>>>  .../selftests/dmabuf-heaps/dmabuf-heap.c      | 247 +++++++-----------
>>>  1 file changed, 101 insertions(+), 146 deletions(-)
>>>
>>> diff --git a/tools/testing/selftests/dmabuf-heaps/dmabuf-heap.c b/tools/testing/selftests/dmabuf-heaps/dmabuf-heap.c
>>> index 890a8236a8ba7..5f541522364fb 100644
>>> --- a/tools/testing/selftests/dmabuf-heaps/dmabuf-heap.c
>>> +++ b/tools/testing/selftests/dmabuf-heaps/dmabuf-heap.c
>>> @@ -15,6 +15,7 @@
>>>  #include <linux/dma-buf.h>
>>>  #include <linux/dma-heap.h>
>>>  #include <drm/drm.h>
>>> +#include "../kselftest.h"
>>>  
>>>  #define DEVPATH "/dev/dma_heap"
>>>  
>>> @@ -90,14 +91,13 @@ static int dmabuf_heap_open(char *name)
>>>  	char buf[256];
>>>  
>>>  	ret = snprintf(buf, 256, "%s/%s", DEVPATH, name);
>>> -	if (ret < 0) {
>>> -		printf("snprintf failed!\n");
>>> -		return ret;
>>> -	}
>>> +	if (ret < 0)
>>> +		ksft_exit_fail_msg("snprintf failed! %d\n", ret);
>>>  
>>>  	fd = open(buf, O_RDWR);
>>>  	if (fd < 0)
>>> -		printf("open %s failed!\n", buf);
>>> +		ksft_exit_fail_msg("open %s failed: %s\n", buf, strerror(errno));
>>> +
>>>  	return fd;
>>>  }
>>>  
>>> @@ -140,7 +140,7 @@ static int dmabuf_sync(int fd, int start_stop)
>>>  
>>>  #define ONE_MEG (1024 * 1024)
>>>  
>>> -static int test_alloc_and_import(char *heap_name)
>>> +static void test_alloc_and_import(char *heap_name)
>>>  {
>>>  	int heap_fd = -1, dmabuf_fd = -1, importer_fd = -1;
>>>  	uint32_t handle = 0;
>>> @@ -148,27 +148,19 @@ static int test_alloc_and_import(char *heap_name)
>>>  	int ret;
>>>  
>>>  	heap_fd = dmabuf_heap_open(heap_name);
>>> -	if (heap_fd < 0)
>>> -		return -1;
>>>  
>>> -	printf("  Testing allocation and importing:  ");
>>> +	ksft_print_msg("Testing allocation and importing:\n");
>>>  	ret = dmabuf_heap_alloc(heap_fd, ONE_MEG, 0, &dmabuf_fd);
>>>  	if (ret) {
>>> -		printf("FAIL (Allocation Failed!)\n");
>>> -		ret = -1;
>>> -		goto out;
>>> +		ksft_test_result_fail("FAIL (Allocation Failed!) %d\n", ret);
>>> +		return;
>>>  	}
>>> +
>>>  	/* mmap and write a simple pattern */
>>> -	p = mmap(NULL,
>>> -		 ONE_MEG,
>>> -		 PROT_READ | PROT_WRITE,
>>> -		 MAP_SHARED,
>>> -		 dmabuf_fd,
>>> -		 0);
>>> +	p = mmap(NULL, ONE_MEG, PROT_READ | PROT_WRITE, MAP_SHARED, dmabuf_fd, 0);
>>>  	if (p == MAP_FAILED) {
>>> -		printf("FAIL (mmap() failed)\n");
>>> -		ret = -1;
>>> -		goto out;
>>> +		ksft_test_result_fail("FAIL (mmap() failed): %s\n", strerror(errno));
>>> +		goto close_and_return;
>>>  	}
>>>  
>>>  	dmabuf_sync(dmabuf_fd, DMA_BUF_SYNC_START);
>>> @@ -178,71 +170,64 @@ static int test_alloc_and_import(char *heap_name)
>>>  
>>>  	importer_fd = open_vgem();
>>>  	if (importer_fd < 0) {
>>> -		ret = importer_fd;
>>> -		printf("(Could not open vgem - skipping):  ");
>>> +		ksft_test_result_skip("Could not open vgem %d\n", importer_fd);
>>>  	} else {
>>>  		ret = import_vgem_fd(importer_fd, dmabuf_fd, &handle);
>>> -		if (ret < 0) {
>>> -			printf("FAIL (Failed to import buffer)\n");
>>> -			goto out;
>>> -		}
>>> +		ksft_test_result(ret >= 0, "Import buffer %d\n", ret);
>>>  	}
>>>  
>>>  	ret = dmabuf_sync(dmabuf_fd, DMA_BUF_SYNC_START);
>>>  	if (ret < 0) {
>>> -		printf("FAIL (DMA_BUF_SYNC_START failed!)\n");
>>> +		ksft_print_msg("FAIL (DMA_BUF_SYNC_START failed!) %d\n", ret);
>>>  		goto out;
>>>  	}
>>>  
>>>  	memset(p, 0xff, ONE_MEG);
>>>  	ret = dmabuf_sync(dmabuf_fd, DMA_BUF_SYNC_END);
>>>  	if (ret < 0) {
>>> -		printf("FAIL (DMA_BUF_SYNC_END failed!)\n");
>>> +		ksft_print_msg("FAIL (DMA_BUF_SYNC_END failed!) %d\n", ret);
>>>  		goto out;
>>>  	}
>>>  
>>>  	close_handle(importer_fd, handle);
>>> -	ret = 0;
>>> -	printf(" OK\n");
>>> +	ksft_test_result_pass("%s dmabuf sync succeeded\n", __func__);
>>> +	return;
>>> +
>>>  out:
>>> -	if (p)
>>> -		munmap(p, ONE_MEG);
>>> -	if (importer_fd >= 0)
>>> -		close(importer_fd);
>>> -	if (dmabuf_fd >= 0)
>>> -		close(dmabuf_fd);
>>> -	if (heap_fd >= 0)
>>> -		close(heap_fd);
>>> +	ksft_test_result_fail("%s dmabuf sync failed\n", __func__);
>>> +	munmap(p, ONE_MEG);
>>> +	close(importer_fd);
>>>  
>>> -	return ret;
>>> +close_and_return:
>>> +	close(dmabuf_fd);
>>> +	close(heap_fd);
>>>  }
>>>  
>>> -static int test_alloc_zeroed(char *heap_name, size_t size)
>>> +static void test_alloc_zeroed(char *heap_name, size_t size)
>>>  {
>>>  	int heap_fd = -1, dmabuf_fd[32];
>>> -	int i, j, ret;
>>> +	int i, j, k, ret;
>>>  	void *p = NULL;
>>>  	char *c;
>>>  
>>> -	printf("  Testing alloced %ldk buffers are zeroed:  ", size / 1024);
>>> +	ksft_print_msg("Testing alloced %ldk buffers are zeroed:\n", size / 1024);
>>>  	heap_fd = dmabuf_heap_open(heap_name);
>>> -	if (heap_fd < 0)
>>> -		return -1;
>>>  
>>>  	/* Allocate and fill a bunch of buffers */
>>>  	for (i = 0; i < 32; i++) {
>>>  		ret = dmabuf_heap_alloc(heap_fd, size, 0, &dmabuf_fd[i]);
>>> -		if (ret < 0) {
>>> -			printf("FAIL (Allocation (%i) failed)\n", i);
>>> -			goto out;
>>> +		if (ret) {
>>> +			ksft_test_result_fail("FAIL (Allocation (%i) failed) %d\n", i, ret);
>>> +			goto close_and_return;
>>>  		}
>>> +
>>>  		/* mmap and fill with simple pattern */
>>>  		p = mmap(NULL, size, PROT_READ | PROT_WRITE, MAP_SHARED, dmabuf_fd[i], 0);
>>>  		if (p == MAP_FAILED) {
>>> -			printf("FAIL (mmap() failed!)\n");
>>> -			ret = -1;
>>> -			goto out;
>>> +			ksft_test_result_fail("FAIL (mmap() failed!): %s\n", strerror(errno));
>>> +			goto close_and_return;
>>>  		}
>>> +
>>>  		dmabuf_sync(dmabuf_fd[i], DMA_BUF_SYNC_START);
>>>  		memset(p, 0xff, size);
>>>  		dmabuf_sync(dmabuf_fd[i], DMA_BUF_SYNC_END);
>>> @@ -251,48 +236,47 @@ static int test_alloc_zeroed(char *heap_name, size_t size)
>>>  	/* close them all */
>>>  	for (i = 0; i < 32; i++)
>>>  		close(dmabuf_fd[i]);
>>> +	ksft_test_result_pass("Allocate and fill a bunch of buffers\n");
>>>  
>>>  	/* Allocate and validate all buffers are zeroed */
>>>  	for (i = 0; i < 32; i++) {
>>>  		ret = dmabuf_heap_alloc(heap_fd, size, 0, &dmabuf_fd[i]);
>>>  		if (ret < 0) {
>>> -			printf("FAIL (Allocation (%i) failed)\n", i);
>>> -			goto out;
>>> +			ksft_test_result_fail("FAIL (Allocation (%i) failed) %d\n", i, ret);
>>> +			goto close_and_return;
>>>  		}
>>>  
>>>  		/* mmap and validate everything is zero */
>>>  		p = mmap(NULL, size, PROT_READ | PROT_WRITE, MAP_SHARED, dmabuf_fd[i], 0);
>>>  		if (p == MAP_FAILED) {
>>> -			printf("FAIL (mmap() failed!)\n");
>>> -			ret = -1;
>>> -			goto out;
>>> +			ksft_test_result_fail("FAIL (mmap() failed!): %s\n", strerror(errno));
>>> +			goto close_and_return;
>>>  		}
>>> +
>>>  		dmabuf_sync(dmabuf_fd[i], DMA_BUF_SYNC_START);
>>>  		c = (char *)p;
>>>  		for (j = 0; j < size; j++) {
>>>  			if (c[j] != 0) {
>>> -				printf("FAIL (Allocated buffer not zeroed @ %i)\n", j);
>>> -				break;
>>> +				ksft_print_msg("FAIL (Allocated buffer not zeroed @ %i)\n", j);
>>> +				dmabuf_sync(dmabuf_fd[i], DMA_BUF_SYNC_END);
>>> +				munmap(p, size);
>>> +				goto out;
>>>  			}
>>>  		}
>>>  		dmabuf_sync(dmabuf_fd[i], DMA_BUF_SYNC_END);
>>>  		munmap(p, size);
>>>  	}
>>> -	/* close them all */
>>> -	for (i = 0; i < 32; i++)
>>> -		close(dmabuf_fd[i]);
>>> -
>>> -	close(heap_fd);
>>> -	printf("OK\n");
>>> -	return 0;
>>>  
>>>  out:
>>> -	while (i > 0) {
>>> -		close(dmabuf_fd[i]);
>>> -		i--;
>>> -	}
>>> +	ksft_test_result(i == 32, "Allocate and validate all buffers are zeroed\n");
>>> +
>>> +close_and_return:
>>> +	/* close them all */
>>> +	for (k = 0; k < i; k++)
>>> +		close(dmabuf_fd[k]);
>>> +
>>>  	close(heap_fd);
>>> -	return ret;
>>> +	return;
>>>  }
>>>  
>>>  /* Test the ioctl version compatibility w/ a smaller structure then expected */
>>> @@ -360,126 +344,97 @@ static int dmabuf_heap_alloc_newer(int fd, size_t len, unsigned int flags,
>>>  	return ret;
>>>  }
>>>  
>>> -static int test_alloc_compat(char *heap_name)
>>> +static void test_alloc_compat(char *heap_name)
>>>  {
>>> -	int heap_fd = -1, dmabuf_fd = -1;
>>> -	int ret;
>>> +	int ret, heap_fd = -1, dmabuf_fd = -1;
>>>  
>>>  	heap_fd = dmabuf_heap_open(heap_name);
>>> -	if (heap_fd < 0)
>>> -		return -1;
>>>  
>>> -	printf("  Testing (theoretical)older alloc compat:  ");
>>> +	ksft_print_msg("Testing (theoretical) older alloc compat:\n");
>>>  	ret = dmabuf_heap_alloc_older(heap_fd, ONE_MEG, 0, &dmabuf_fd);
>>> -	if (ret) {
>>> -		printf("FAIL (Older compat allocation failed!)\n");
>>> -		ret = -1;
>>> -		goto out;
>>> -	}
>>> -	close(dmabuf_fd);
>>> -	printf("OK\n");
>>> +	if (dmabuf_fd >= 0)
>>> +		close(dmabuf_fd);
>>> +	ksft_test_result(!ret, "dmabuf_heap_alloc_older\n");
>>>  
>>> -	printf("  Testing (theoretical)newer alloc compat:  ");
>>> +	ksft_print_msg("Testing (theoretical) newer alloc compat:\n");
>>>  	ret = dmabuf_heap_alloc_newer(heap_fd, ONE_MEG, 0, &dmabuf_fd);
>>> -	if (ret) {
>>> -		printf("FAIL (Newer compat allocation failed!)\n");
>>> -		ret = -1;
>>> -		goto out;
>>> -	}
>>> -	printf("OK\n");
>>> -out:
>>>  	if (dmabuf_fd >= 0)
>>>  		close(dmabuf_fd);
>>> -	if (heap_fd >= 0)
>>> -		close(heap_fd);
>>> +	ksft_test_result(!ret, "dmabuf_heap_alloc_newer\n");
>>>  
>>> -	return ret;
>>> +	close(heap_fd);
>>>  }
>>>  
>>> -static int test_alloc_errors(char *heap_name)
>>> +static void test_alloc_errors(char *heap_name)
>>>  {
>>>  	int heap_fd = -1, dmabuf_fd = -1;
>>>  	int ret;
>>>  
>>>  	heap_fd = dmabuf_heap_open(heap_name);
>>> -	if (heap_fd < 0)
>>> -		return -1;
>>>  
>>> -	printf("  Testing expected error cases:  ");
>>> +	ksft_print_msg("Testing expected error cases:\n");
>>>  	ret = dmabuf_heap_alloc(0, ONE_MEG, 0x111111, &dmabuf_fd);
>>> -	if (!ret) {
>>> -		printf("FAIL (Did not see expected error (invalid fd)!)\n");
>>> -		ret = -1;
>>> -		goto out;
>>> -	}
>>> +	ksft_test_result(ret, "Error expected on invalid fd %d\n", ret);
>>>  
>>>  	ret = dmabuf_heap_alloc(heap_fd, ONE_MEG, 0x111111, &dmabuf_fd);
>>> -	if (!ret) {
>>> -		printf("FAIL (Did not see expected error (invalid heap flags)!)\n");
>>> -		ret = -1;
>>> -		goto out;
>>> -	}
>>> +	ksft_test_result(ret, "Error expected on invalid heap flags %d\n", ret);
>>>  
>>>  	ret = dmabuf_heap_alloc_fdflags(heap_fd, ONE_MEG,
>>>  					~(O_RDWR | O_CLOEXEC), 0, &dmabuf_fd);
>>> -	if (!ret) {
>>> -		printf("FAIL (Did not see expected error (invalid fd flags)!)\n");
>>> -		ret = -1;
>>> -		goto out;
>>> -	}
>>> +	ksft_test_result(ret, "Error expected on invalid heap flags %d\n", ret);
>>>  
>>> -	printf("OK\n");
>>> -	ret = 0;
>>> -out:
>>>  	if (dmabuf_fd >= 0)
>>>  		close(dmabuf_fd);
>>> -	if (heap_fd >= 0)
>>> -		close(heap_fd);
>>> +	close(heap_fd);
>>> +}
>>>  
>>> -	return ret;
>>> +static int numer_of_heaps(void)
>>> +{
>>> +	DIR *d = opendir(DEVPATH);
>>> +	struct dirent *dir;
>>> +	int heaps = 0;
>>> +
>>> +	while ((dir = readdir(d))) {
>>> +		if (!strncmp(dir->d_name, ".", 2))
>>> +			continue;
>>> +		if (!strncmp(dir->d_name, "..", 3))
>>> +			continue;
>>> +		heaps++;
>>> +	}
>>> +
>>> +	return heaps;
>>>  }
>>>  
>>>  int main(void)
>>>  {
>>> -	DIR *d;
>>>  	struct dirent *dir;
>>> -	int ret = -1;
>>> +	DIR *d;
>>> +
>>> +	ksft_print_header();
>>>  
>>>  	d = opendir(DEVPATH);
>>>  	if (!d) {
>>> -		printf("No %s directory?\n", DEVPATH);
>>> -		return -1;
>>> +		ksft_print_msg("No %s directory?\n", DEVPATH);
>>> +		return KSFT_SKIP;
>>>  	}
>>>  
>>> -	while ((dir = readdir(d)) != NULL) {
>>> +	ksft_set_plan(11 * numer_of_heaps());
>>> +
>>> +	while ((dir = readdir(d))) {
>>>  		if (!strncmp(dir->d_name, ".", 2))
>>>  			continue;
>>>  		if (!strncmp(dir->d_name, "..", 3))
>>>  			continue;
>>>  
>>> -		printf("Testing heap: %s\n", dir->d_name);
>>> -		printf("=======================================\n");
>>> -		ret = test_alloc_and_import(dir->d_name);
>>> -		if (ret)
>>> -			break;
>>> -
>>> -		ret = test_alloc_zeroed(dir->d_name, 4 * 1024);
>>> -		if (ret)
>>> -			break;
>>> -
>>> -		ret = test_alloc_zeroed(dir->d_name, ONE_MEG);
>>> -		if (ret)
>>> -			break;
>>> -
>>> -		ret = test_alloc_compat(dir->d_name);
>>> -		if (ret)
>>> -			break;
>>> -
>>> -		ret = test_alloc_errors(dir->d_name);
>>> -		if (ret)
>>> -			break;
>>> +		ksft_print_msg("Testing heap: %s\n", dir->d_name);
>>> +		ksft_print_msg("=======================================\n");
>>> +		test_alloc_and_import(dir->d_name);
>>> +		test_alloc_zeroed(dir->d_name, 4 * 1024);
>>> +		test_alloc_zeroed(dir->d_name, ONE_MEG);
>>> +		test_alloc_compat(dir->d_name);
>>> +		test_alloc_errors(dir->d_name);
>>>  	}
>>>  	closedir(d);
>>>  
>>> -	return ret;
>>> +	ksft_finished();
>>>  }
>>
> 

-- 
BR,
Muhammad Usama Anjum