forked from mirrors/linux
		
	add debugfs support for displaying kunit test suite results; this is especially useful for module-loaded tests to allow disentangling of test result display from other dmesg events. debugfs support is provided if CONFIG_KUNIT_DEBUGFS=y. As well as printk()ing messages, we append them to a per-test log. Signed-off-by: Alan Maguire <alan.maguire@oracle.com> Reviewed-by: Brendan Higgins <brendanhiggins@google.com> Reviewed-by: Frank Rowand <frank.rowand@sony.com> Signed-off-by: Shuah Khan <skhan@linuxfoundation.org>
		
			
				
	
	
		
			116 lines
		
	
	
	
		
			2.7 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
			
		
		
	
	
			116 lines
		
	
	
	
		
			2.7 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
// SPDX-License-Identifier: GPL-2.0
 | 
						|
/*
 | 
						|
 * Copyright (c) 2020, Oracle and/or its affiliates.
 | 
						|
 *    Author: Alan Maguire <alan.maguire@oracle.com>
 | 
						|
 */
 | 
						|
 | 
						|
#include <linux/debugfs.h>
 | 
						|
#include <linux/module.h>
 | 
						|
 | 
						|
#include <kunit/test.h>
 | 
						|
 | 
						|
#include "string-stream.h"
 | 
						|
 | 
						|
#define KUNIT_DEBUGFS_ROOT             "kunit"
 | 
						|
#define KUNIT_DEBUGFS_RESULTS          "results"
 | 
						|
 | 
						|
/*
 | 
						|
 * Create a debugfs representation of test suites:
 | 
						|
 *
 | 
						|
 * Path						Semantics
 | 
						|
 * /sys/kernel/debug/kunit/<testsuite>/results	Show results of last run for
 | 
						|
 *						testsuite
 | 
						|
 *
 | 
						|
 */
 | 
						|
 | 
						|
static struct dentry *debugfs_rootdir;
 | 
						|
 | 
						|
void kunit_debugfs_cleanup(void)
 | 
						|
{
 | 
						|
	debugfs_remove_recursive(debugfs_rootdir);
 | 
						|
}
 | 
						|
 | 
						|
void kunit_debugfs_init(void)
 | 
						|
{
 | 
						|
	if (!debugfs_rootdir)
 | 
						|
		debugfs_rootdir = debugfs_create_dir(KUNIT_DEBUGFS_ROOT, NULL);
 | 
						|
}
 | 
						|
 | 
						|
static void debugfs_print_result(struct seq_file *seq,
 | 
						|
				 struct kunit_suite *suite,
 | 
						|
				 struct kunit_case *test_case)
 | 
						|
{
 | 
						|
	if (!test_case || !test_case->log)
 | 
						|
		return;
 | 
						|
 | 
						|
	seq_printf(seq, "%s", test_case->log);
 | 
						|
}
 | 
						|
 | 
						|
/*
 | 
						|
 * /sys/kernel/debug/kunit/<testsuite>/results shows all results for testsuite.
 | 
						|
 */
 | 
						|
static int debugfs_print_results(struct seq_file *seq, void *v)
 | 
						|
{
 | 
						|
	struct kunit_suite *suite = (struct kunit_suite *)seq->private;
 | 
						|
	bool success = kunit_suite_has_succeeded(suite);
 | 
						|
	struct kunit_case *test_case;
 | 
						|
 | 
						|
	if (!suite || !suite->log)
 | 
						|
		return 0;
 | 
						|
 | 
						|
	seq_printf(seq, "%s", suite->log);
 | 
						|
 | 
						|
	kunit_suite_for_each_test_case(suite, test_case)
 | 
						|
		debugfs_print_result(seq, suite, test_case);
 | 
						|
 | 
						|
	seq_printf(seq, "%s %d - %s\n",
 | 
						|
		   kunit_status_to_string(success), 1, suite->name);
 | 
						|
	return 0;
 | 
						|
}
 | 
						|
 | 
						|
static int debugfs_release(struct inode *inode, struct file *file)
 | 
						|
{
 | 
						|
	return single_release(inode, file);
 | 
						|
}
 | 
						|
 | 
						|
static int debugfs_results_open(struct inode *inode, struct file *file)
 | 
						|
{
 | 
						|
	struct kunit_suite *suite;
 | 
						|
 | 
						|
	suite = (struct kunit_suite *)inode->i_private;
 | 
						|
 | 
						|
	return single_open(file, debugfs_print_results, suite);
 | 
						|
}
 | 
						|
 | 
						|
static const struct file_operations debugfs_results_fops = {
 | 
						|
	.open = debugfs_results_open,
 | 
						|
	.read = seq_read,
 | 
						|
	.llseek = seq_lseek,
 | 
						|
	.release = debugfs_release,
 | 
						|
};
 | 
						|
 | 
						|
void kunit_debugfs_create_suite(struct kunit_suite *suite)
 | 
						|
{
 | 
						|
	struct kunit_case *test_case;
 | 
						|
 | 
						|
	/* Allocate logs before creating debugfs representation. */
 | 
						|
	suite->log = kzalloc(KUNIT_LOG_SIZE, GFP_KERNEL);
 | 
						|
	kunit_suite_for_each_test_case(suite, test_case)
 | 
						|
		test_case->log = kzalloc(KUNIT_LOG_SIZE, GFP_KERNEL);
 | 
						|
 | 
						|
	suite->debugfs = debugfs_create_dir(suite->name, debugfs_rootdir);
 | 
						|
 | 
						|
	debugfs_create_file(KUNIT_DEBUGFS_RESULTS, S_IFREG | 0444,
 | 
						|
			    suite->debugfs,
 | 
						|
			    suite, &debugfs_results_fops);
 | 
						|
}
 | 
						|
 | 
						|
void kunit_debugfs_destroy_suite(struct kunit_suite *suite)
 | 
						|
{
 | 
						|
	struct kunit_case *test_case;
 | 
						|
 | 
						|
	debugfs_remove_recursive(suite->debugfs);
 | 
						|
	kfree(suite->log);
 | 
						|
	kunit_suite_for_each_test_case(suite, test_case)
 | 
						|
		kfree(test_case->log);
 | 
						|
}
 |