[igt-dev] [PATCH i-g-t] tests/amdgpu: Add tests that check for memory leaks

[Rodrigo Siqueira]

Hi,

Thanks a lot for this new test.

Reviewed-by: Rodrigo Siqueira <Rodrigo.Siqueira at amd.com>

On 09/01, Stylon Wang wrote:
> Check for memory leaks in these two cases:
> - Connector EDID parsing after suspend-resume
> - Triggerring of connector hotplugs
> 
> Depends on CONFIG_HAVE_DEBUG_KMEMLEAK=y in kernel config.
> 
> Signed-off-by: Stylon Wang <stylon.wang at amd.com>
> ---
>  tests/amdgpu/amd_mem_leak.c | 236 ++++++++++++++++++++++++++++++++++++
>  tests/amdgpu/meson.build    |   1 +
>  2 files changed, 237 insertions(+)
>  create mode 100644 tests/amdgpu/amd_mem_leak.c
> 
> diff --git a/tests/amdgpu/amd_mem_leak.c b/tests/amdgpu/amd_mem_leak.c
> new file mode 100644
> index 00000000..dee563cb
> --- /dev/null
> +++ b/tests/amdgpu/amd_mem_leak.c
> @@ -0,0 +1,236 @@
> +/*
> + * Copyright 2020 Advanced Micro Devices, Inc.
> + *
> + * 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 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 COPYRIGHT HOLDER(S) OR AUTHOR(S) 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 "igt.h"
> +#include "igt_amd.h"
> +#include <fcntl.h>
> +
> +IGT_TEST_DESCRIPTION("Test checking memory leaks with suspend-resume and connector hotplug");
> +
> +/* Common test data. */
> +typedef struct data {
> +	igt_display_t display;
> +	igt_plane_t *primary;
> +	igt_output_t *output;
> +	igt_pipe_t *pipe;
> +	drmModeModeInfo *mode;
> +	enum pipe pipe_id;
> +	int fd;
> +	int w;
> +	int h;
> +} data_t;
> +
> +/* Common test setup. */
> +static void test_init(data_t *data)
> +{
> +	igt_display_t *display = &data->display;
> +
> +	/* It doesn't matter which pipe we choose on amdpgu. */
> +	data->pipe_id = PIPE_A;
> +	data->pipe = &data->display.pipes[data->pipe_id];
> +
> +	igt_display_reset(display);
> +
> +	/* find a connected output */
> +	data->output = NULL;
> +	for (int i=0; i < data->display.n_outputs; ++i) {
> +		drmModeConnector *connector = data->display.outputs[i].config.connector;
> +		if (connector->connection == DRM_MODE_CONNECTED) {
> +			data->output = &data->display.outputs[i];
> +		}
> +	}
> +	igt_assert_f(data->output, "Requires connected output\n");
> +
> +	data->mode = igt_output_get_mode(data->output);
> +	igt_assert(data->mode);
> +
> +	data->primary =
> +		igt_pipe_get_plane_type(data->pipe, DRM_PLANE_TYPE_PRIMARY);
> +
> +	igt_output_set_pipe(data->output, data->pipe_id);
> +
> +	data->w = data->mode->hdisplay;
> +	data->h = data->mode->vdisplay;
> +}
> +
> +/* Common test cleanup. */
> +static void test_fini(data_t *data)
> +{
> +	igt_display_reset(&data->display);
> +}
> +
> +/* return True if scan successfully written to kmemleak */
> +static bool send_scan_memleak(void)
> +{
> +	FILE *fp;
> +	const char *cmd = "scan";
> +
> +	fp = fopen("/sys/kernel/debug/kmemleak", "r+");
> +	if (!fp) return false;
> +
> +	if(fwrite(cmd, 1, strlen(cmd), fp) != strlen(cmd))  {
> +		fclose(fp);
> +		return false;
> +	}
> +	fclose(fp);
> +	return true;
> +}
> +
> +/* return True if clear successfully sent to kmemleak */
> +static bool send_clear_memleak(void)
> +{
> +	FILE *fp;
> +	const char *cmd = "clear";
> +
> +	fp = fopen("/sys/kernel/debug/kmemleak", "r+");
> +	if (!fp) return false;
> +
> +	if(fwrite(cmd, 1, strlen(cmd), fp) != strlen(cmd))  {
> +		fclose(fp);
> +		return false;
> +	}
> +	fclose(fp);
> +	return true;
> +}
> +
> +/* return true if kmemleak is enabled and then clear earlier leak records */
> +static bool clear_memleak(data_t *data)
> +{
> +	/* Need to scan + clear twice to properly clear buffer or else leaks
> +	 * from modprobe or other tests may appear
> +	 */
> +	if (!send_scan_memleak() | !send_clear_memleak())
> +		return false;
> +	if (!send_scan_memleak() | !send_clear_memleak())
> +		return false;
> +
> +	return true;
> +}
> +
> +/* return true if kmemleak did not pick up any memory leaks */
> +static bool check_memleak(data_t *data)
> +{
> +	FILE *fp;
> +	const char *buf[1];
> +	const char *cmd = "scan";
> +	char read_buf[1024];
> +
> +	fp = fopen("/sys/kernel/debug/kmemleak", "r+");
> +	igt_assert_f(fp, "cannot open /sys/kernel/debug/kmemleak for reading\n");
> +
> +	/* trigger an immediate scan on memory leak */
> +	igt_assert_f(fwrite(cmd, 1, strlen(cmd), fp) == strlen(cmd),
> +			"fail to trigger a scan for memory leak\n");
> +
> +	/* read back to see if any leak */
> +	if (fread(buf, 1, 1, fp) == 0) {
> +		fclose(fp);
> +		return true;
> +	}
> +
> +	/* Dump contents of kmemleak */
> +	fseek(fp, 0L, SEEK_SET);
> +	while (fgets(read_buf, sizeof(read_buf), fp) != NULL) {
> +		igt_info("%s", read_buf);
> +	}
> +
> +	fclose(fp);
> +	return false;
> +}
> +
> +static void test_suspend_resume(data_t *data)
> +{
> +	igt_display_t *display = &data->display;
> +	igt_fb_t rfb;
> +
> +	test_init(data);
> +
> +	if(!clear_memleak(data)) {
> +		igt_skip("kmemleak is not enabled for this kernel\n");
> +	}
> +
> +	igt_create_pattern_fb(data->fd, data->w, data->h, DRM_FORMAT_XRGB8888, 0, &rfb);
> +	igt_plane_set_fb(data->primary, &rfb);
> +	igt_display_commit_atomic(display, DRM_MODE_ATOMIC_ALLOW_MODESET, NULL);
> +
> +	igt_system_suspend_autoresume(SUSPEND_STATE_MEM, SUSPEND_TEST_NONE);
> +
> +	igt_assert_f(check_memleak(data), "memory leak detected\n");
> +
> +	igt_remove_fb(data->fd, &rfb);
> +	test_fini(data);
> +}
> +
> +static void test_hotplug(data_t *data)
> +{
> +	igt_display_t *display = &data->display;
> +	igt_fb_t rfb;
> +
> +	test_init(data);
> +
> +	igt_amd_require_hpd(&data->display, data->fd);
> +
> +	if(!clear_memleak(data)) {
> +		igt_skip("kmemleak is not enabled for this kernel\n");
> +	}
> +
> +	igt_create_pattern_fb(data->fd, data->w, data->h, DRM_FORMAT_XRGB8888, 0, &rfb);
> +	igt_plane_set_fb(data->primary, &rfb);
> +	igt_display_commit_atomic(display, DRM_MODE_ATOMIC_ALLOW_MODESET, NULL);
> +
> +	igt_amd_trigger_hotplug(data->fd, data->output->name);
> +
> +	igt_assert_f(check_memleak(data), "memory leak detected\n");
> +
> +	igt_remove_fb(data->fd, &rfb);
> +	test_fini(data);
> +}
> +
> +igt_main
> +{
> +	data_t data;
> +
> +	igt_skip_on_simulation();
> +
> +	memset(&data, 0, sizeof(data));
> +
> +	igt_fixture
> +	{
> +		data.fd = drm_open_driver_master(DRIVER_AMDGPU);
> +
> +		kmstest_set_vt_graphics_mode();
> +
> +		igt_display_require(&data.display, data.fd);
> +		igt_require(data.display.is_atomic);
> +		igt_display_require_output(&data.display);
> +	}
> +
> +	igt_describe("Test memory leaks after resume from suspend");
> +	igt_subtest("connector-suspend-resume") test_suspend_resume(&data);
> +	igt_describe("Test memroy leaks after connector hotplug");
> +	igt_subtest("connector-hotplug") test_hotplug(&data);
> +
> +	igt_fixture
> +	{
> +		igt_display_fini(&data.display);
> +	}
> +}
> diff --git a/tests/amdgpu/meson.build b/tests/amdgpu/meson.build
> index 90489d82..d05a9c30 100644
> --- a/tests/amdgpu/meson.build
> +++ b/tests/amdgpu/meson.build
> @@ -12,6 +12,7 @@ if libdrm_amdgpu.found()
>  			  'amd_info',
>  			  'amd_prime',
>  			  'amd_module_load',
> +			  'amd_mem_leak',
>  			]
>  	amdgpu_deps += libdrm_amdgpu
>  endif
> -- 
> 2.32.0
> 

-- 
Rodrigo Siqueira
https://siqueira.tech