mirror of
				https://github.com/torvalds/linux.git
				synced 2025-11-04 02:30:34 +02:00 
			
		
		
		
	The reference counting issue happens in the normal path of kfree_at_end(). When kunit_alloc_and_get_resource() is invoked, the function forgets to handle the returned resource object, whose refcount increased inside, causing a refcount leak. Fix this issue by calling kunit_alloc_resource() instead of kunit_alloc_and_get_resource(). Fixed the following when applying: Shuah Khan <skhan@linuxfoundation.org> CHECK: Alignment should match open parenthesis + kunit_alloc_resource(test, NULL, kfree_res_free, GFP_KERNEL, (void *)to_free); Signed-off-by: Xiyu Yang <xiyuyang19@fudan.edu.cn> Signed-off-by: Xin Tan <tanxin.ctf@gmail.com> Reviewed-by: Daniel Latypov <dlatypov@google.com> Reviewed-by: Brendan Higgins <brendanhiggins@google.com> Signed-off-by: Shuah Khan <skhan@linuxfoundation.org>
		
			
				
	
	
		
			133 lines
		
	
	
	
		
			3.8 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
			
		
		
	
	
			133 lines
		
	
	
	
		
			3.8 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
// SPDX-License-Identifier: GPL-2.0
 | 
						|
/*
 | 
						|
 * KUnit test for the KUnit executor.
 | 
						|
 *
 | 
						|
 * Copyright (C) 2021, Google LLC.
 | 
						|
 * Author: Daniel Latypov <dlatypov@google.com>
 | 
						|
 */
 | 
						|
 | 
						|
#include <kunit/test.h>
 | 
						|
 | 
						|
static void kfree_at_end(struct kunit *test, const void *to_free);
 | 
						|
static struct kunit_suite *alloc_fake_suite(struct kunit *test,
 | 
						|
					    const char *suite_name);
 | 
						|
 | 
						|
static void filter_subsuite_test(struct kunit *test)
 | 
						|
{
 | 
						|
	struct kunit_suite *subsuite[3] = {NULL, NULL, NULL};
 | 
						|
	struct kunit_suite * const *filtered;
 | 
						|
 | 
						|
	subsuite[0] = alloc_fake_suite(test, "suite1");
 | 
						|
	subsuite[1] = alloc_fake_suite(test, "suite2");
 | 
						|
 | 
						|
	/* Want: suite1, suite2, NULL -> suite2, NULL */
 | 
						|
	filtered = kunit_filter_subsuite(subsuite, "suite2*");
 | 
						|
	KUNIT_ASSERT_NOT_ERR_OR_NULL(test, filtered);
 | 
						|
	kfree_at_end(test, filtered);
 | 
						|
 | 
						|
	KUNIT_ASSERT_NOT_ERR_OR_NULL(test, filtered[0]);
 | 
						|
	KUNIT_EXPECT_STREQ(test, (const char *)filtered[0]->name, "suite2");
 | 
						|
 | 
						|
	KUNIT_EXPECT_FALSE(test, filtered[1]);
 | 
						|
}
 | 
						|
 | 
						|
static void filter_subsuite_to_empty_test(struct kunit *test)
 | 
						|
{
 | 
						|
	struct kunit_suite *subsuite[3] = {NULL, NULL, NULL};
 | 
						|
	struct kunit_suite * const *filtered;
 | 
						|
 | 
						|
	subsuite[0] = alloc_fake_suite(test, "suite1");
 | 
						|
	subsuite[1] = alloc_fake_suite(test, "suite2");
 | 
						|
 | 
						|
	filtered = kunit_filter_subsuite(subsuite, "not_found");
 | 
						|
	kfree_at_end(test, filtered); /* just in case */
 | 
						|
 | 
						|
	KUNIT_EXPECT_FALSE_MSG(test, filtered,
 | 
						|
			       "should be NULL to indicate no match");
 | 
						|
}
 | 
						|
 | 
						|
static void kfree_subsuites_at_end(struct kunit *test, struct suite_set *suite_set)
 | 
						|
{
 | 
						|
	struct kunit_suite * const * const *suites;
 | 
						|
 | 
						|
	kfree_at_end(test, suite_set->start);
 | 
						|
	for (suites = suite_set->start; suites < suite_set->end; suites++)
 | 
						|
		kfree_at_end(test, *suites);
 | 
						|
}
 | 
						|
 | 
						|
static void filter_suites_test(struct kunit *test)
 | 
						|
{
 | 
						|
	/* Suites per-file are stored as a NULL terminated array */
 | 
						|
	struct kunit_suite *subsuites[2][2] = {
 | 
						|
		{NULL, NULL},
 | 
						|
		{NULL, NULL},
 | 
						|
	};
 | 
						|
	/* Match the memory layout of suite_set */
 | 
						|
	struct kunit_suite * const * const suites[2] = {
 | 
						|
		subsuites[0], subsuites[1],
 | 
						|
	};
 | 
						|
 | 
						|
	const struct suite_set suite_set = {
 | 
						|
		.start = suites,
 | 
						|
		.end = suites + 2,
 | 
						|
	};
 | 
						|
	struct suite_set filtered = {.start = NULL, .end = NULL};
 | 
						|
 | 
						|
	/* Emulate two files, each having one suite */
 | 
						|
	subsuites[0][0] = alloc_fake_suite(test, "suite0");
 | 
						|
	subsuites[1][0] = alloc_fake_suite(test, "suite1");
 | 
						|
 | 
						|
	/* Filter out suite1 */
 | 
						|
	filtered = kunit_filter_suites(&suite_set, "suite0");
 | 
						|
	kfree_subsuites_at_end(test, &filtered); /* let us use ASSERTs without leaking */
 | 
						|
	KUNIT_ASSERT_EQ(test, filtered.end - filtered.start, (ptrdiff_t)1);
 | 
						|
 | 
						|
	KUNIT_ASSERT_NOT_ERR_OR_NULL(test, filtered.start);
 | 
						|
	KUNIT_ASSERT_NOT_ERR_OR_NULL(test, filtered.start[0]);
 | 
						|
	KUNIT_EXPECT_STREQ(test, (const char *)filtered.start[0][0]->name, "suite0");
 | 
						|
}
 | 
						|
 | 
						|
static struct kunit_case executor_test_cases[] = {
 | 
						|
	KUNIT_CASE(filter_subsuite_test),
 | 
						|
	KUNIT_CASE(filter_subsuite_to_empty_test),
 | 
						|
	KUNIT_CASE(filter_suites_test),
 | 
						|
	{}
 | 
						|
};
 | 
						|
 | 
						|
static struct kunit_suite executor_test_suite = {
 | 
						|
	.name = "kunit_executor_test",
 | 
						|
	.test_cases = executor_test_cases,
 | 
						|
};
 | 
						|
 | 
						|
kunit_test_suites(&executor_test_suite);
 | 
						|
 | 
						|
/* Test helpers */
 | 
						|
 | 
						|
static void kfree_res_free(struct kunit_resource *res)
 | 
						|
{
 | 
						|
	kfree(res->data);
 | 
						|
}
 | 
						|
 | 
						|
/* Use the resource API to register a call to kfree(to_free).
 | 
						|
 * Since we never actually use the resource, it's safe to use on const data.
 | 
						|
 */
 | 
						|
static void kfree_at_end(struct kunit *test, const void *to_free)
 | 
						|
{
 | 
						|
	/* kfree() handles NULL already, but avoid allocating a no-op cleanup. */
 | 
						|
	if (IS_ERR_OR_NULL(to_free))
 | 
						|
		return;
 | 
						|
	kunit_alloc_resource(test, NULL, kfree_res_free, GFP_KERNEL,
 | 
						|
			     (void *)to_free);
 | 
						|
}
 | 
						|
 | 
						|
static struct kunit_suite *alloc_fake_suite(struct kunit *test,
 | 
						|
					    const char *suite_name)
 | 
						|
{
 | 
						|
	struct kunit_suite *suite;
 | 
						|
 | 
						|
	/* We normally never expect to allocate suites, hence the non-const cast. */
 | 
						|
	suite = kunit_kzalloc(test, sizeof(*suite), GFP_KERNEL);
 | 
						|
	strncpy((char *)suite->name, suite_name, sizeof(suite->name) - 1);
 | 
						|
 | 
						|
	return suite;
 | 
						|
}
 |