mirror of
https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git
synced 2024-09-05 18:39:59 +00:00
![zhujun2](/assets/img/avatar_default.png)
when the argument type is 'unsigned int',printf '%u' in format string. Problem found during code reading. Update commit log with information on how the problem was found: Shuah Khan <skhan@linuxfoundation.org> Signed-off-by: zhujun2 <zhujun2@cmss.chinamobile.com> Signed-off-by: Shuah Khan <skhan@linuxfoundation.org>
346 lines
8.4 KiB
C
346 lines
8.4 KiB
C
/* SPDX-License-Identifier: GPL-2.0 */
|
|
/*
|
|
* kselftest.h: low-level kselftest framework to include from
|
|
* selftest programs. When possible, please use
|
|
* kselftest_harness.h instead.
|
|
*
|
|
* Copyright (c) 2014 Shuah Khan <shuahkh@osg.samsung.com>
|
|
* Copyright (c) 2014 Samsung Electronics Co., Ltd.
|
|
*
|
|
* Using this API consists of first counting how many tests your code
|
|
* has to run, and then starting up the reporting:
|
|
*
|
|
* ksft_print_header();
|
|
* ksft_set_plan(total_number_of_tests);
|
|
*
|
|
* For each test, report any progress, debugging, etc with:
|
|
*
|
|
* ksft_print_msg(fmt, ...);
|
|
*
|
|
* and finally report the pass/fail/skip/xfail state of the test with one of:
|
|
*
|
|
* ksft_test_result(condition, fmt, ...);
|
|
* ksft_test_result_pass(fmt, ...);
|
|
* ksft_test_result_fail(fmt, ...);
|
|
* ksft_test_result_skip(fmt, ...);
|
|
* ksft_test_result_xfail(fmt, ...);
|
|
* ksft_test_result_error(fmt, ...);
|
|
*
|
|
* When all tests are finished, clean up and exit the program with one of:
|
|
*
|
|
* ksft_finished();
|
|
* ksft_exit(condition);
|
|
* ksft_exit_pass();
|
|
* ksft_exit_fail();
|
|
*
|
|
* If the program wants to report details on why the entire program has
|
|
* failed, it can instead exit with a message (this is usually done when
|
|
* the program is aborting before finishing all tests):
|
|
*
|
|
* ksft_exit_fail_msg(fmt, ...);
|
|
*
|
|
*/
|
|
#ifndef __KSELFTEST_H
|
|
#define __KSELFTEST_H
|
|
|
|
#ifndef NOLIBC
|
|
#include <errno.h>
|
|
#include <stdlib.h>
|
|
#include <unistd.h>
|
|
#include <stdarg.h>
|
|
#include <string.h>
|
|
#include <stdio.h>
|
|
#endif
|
|
|
|
#ifndef ARRAY_SIZE
|
|
#define ARRAY_SIZE(arr) (sizeof(arr) / sizeof((arr)[0]))
|
|
#endif
|
|
|
|
/*
|
|
* gcc cpuid.h provides __cpuid_count() since v4.4.
|
|
* Clang/LLVM cpuid.h provides __cpuid_count() since v3.4.0.
|
|
*
|
|
* Provide local define for tests needing __cpuid_count() because
|
|
* selftests need to work in older environments that do not yet
|
|
* have __cpuid_count().
|
|
*/
|
|
#ifndef __cpuid_count
|
|
#define __cpuid_count(level, count, a, b, c, d) \
|
|
__asm__ __volatile__ ("cpuid\n\t" \
|
|
: "=a" (a), "=b" (b), "=c" (c), "=d" (d) \
|
|
: "0" (level), "2" (count))
|
|
#endif
|
|
|
|
/* define kselftest exit codes */
|
|
#define KSFT_PASS 0
|
|
#define KSFT_FAIL 1
|
|
#define KSFT_XFAIL 2
|
|
#define KSFT_XPASS 3
|
|
#define KSFT_SKIP 4
|
|
|
|
#define __printf(a, b) __attribute__((format(printf, a, b)))
|
|
|
|
/* counters */
|
|
struct ksft_count {
|
|
unsigned int ksft_pass;
|
|
unsigned int ksft_fail;
|
|
unsigned int ksft_xfail;
|
|
unsigned int ksft_xpass;
|
|
unsigned int ksft_xskip;
|
|
unsigned int ksft_error;
|
|
};
|
|
|
|
static struct ksft_count ksft_cnt;
|
|
static unsigned int ksft_plan;
|
|
|
|
static inline unsigned int ksft_test_num(void)
|
|
{
|
|
return ksft_cnt.ksft_pass + ksft_cnt.ksft_fail +
|
|
ksft_cnt.ksft_xfail + ksft_cnt.ksft_xpass +
|
|
ksft_cnt.ksft_xskip + ksft_cnt.ksft_error;
|
|
}
|
|
|
|
static inline void ksft_inc_pass_cnt(void) { ksft_cnt.ksft_pass++; }
|
|
static inline void ksft_inc_fail_cnt(void) { ksft_cnt.ksft_fail++; }
|
|
static inline void ksft_inc_xfail_cnt(void) { ksft_cnt.ksft_xfail++; }
|
|
static inline void ksft_inc_xpass_cnt(void) { ksft_cnt.ksft_xpass++; }
|
|
static inline void ksft_inc_xskip_cnt(void) { ksft_cnt.ksft_xskip++; }
|
|
static inline void ksft_inc_error_cnt(void) { ksft_cnt.ksft_error++; }
|
|
|
|
static inline int ksft_get_pass_cnt(void) { return ksft_cnt.ksft_pass; }
|
|
static inline int ksft_get_fail_cnt(void) { return ksft_cnt.ksft_fail; }
|
|
static inline int ksft_get_xfail_cnt(void) { return ksft_cnt.ksft_xfail; }
|
|
static inline int ksft_get_xpass_cnt(void) { return ksft_cnt.ksft_xpass; }
|
|
static inline int ksft_get_xskip_cnt(void) { return ksft_cnt.ksft_xskip; }
|
|
static inline int ksft_get_error_cnt(void) { return ksft_cnt.ksft_error; }
|
|
|
|
static inline void ksft_print_header(void)
|
|
{
|
|
/*
|
|
* Force line buffering; If stdout is not connected to a terminal, it
|
|
* will otherwise default to fully buffered, which can cause output
|
|
* duplication if there is content in the buffer when fork()ing. If
|
|
* there is a crash, line buffering also means the most recent output
|
|
* line will be visible.
|
|
*/
|
|
setvbuf(stdout, NULL, _IOLBF, 0);
|
|
|
|
if (!(getenv("KSFT_TAP_LEVEL")))
|
|
printf("TAP version 13\n");
|
|
}
|
|
|
|
static inline void ksft_set_plan(unsigned int plan)
|
|
{
|
|
ksft_plan = plan;
|
|
printf("1..%u\n", ksft_plan);
|
|
}
|
|
|
|
static inline void ksft_print_cnts(void)
|
|
{
|
|
if (ksft_plan != ksft_test_num())
|
|
printf("# Planned tests != run tests (%u != %u)\n",
|
|
ksft_plan, ksft_test_num());
|
|
printf("# Totals: pass:%u fail:%u xfail:%u xpass:%u skip:%u error:%u\n",
|
|
ksft_cnt.ksft_pass, ksft_cnt.ksft_fail,
|
|
ksft_cnt.ksft_xfail, ksft_cnt.ksft_xpass,
|
|
ksft_cnt.ksft_xskip, ksft_cnt.ksft_error);
|
|
}
|
|
|
|
static inline __printf(1, 2) void ksft_print_msg(const char *msg, ...)
|
|
{
|
|
int saved_errno = errno;
|
|
va_list args;
|
|
|
|
va_start(args, msg);
|
|
printf("# ");
|
|
errno = saved_errno;
|
|
vprintf(msg, args);
|
|
va_end(args);
|
|
}
|
|
|
|
static inline void ksft_perror(const char *msg)
|
|
{
|
|
#ifndef NOLIBC
|
|
ksft_print_msg("%s: %s (%d)\n", msg, strerror(errno), errno);
|
|
#else
|
|
/*
|
|
* nolibc doesn't provide strerror() and it seems
|
|
* inappropriate to add one, just print the errno.
|
|
*/
|
|
ksft_print_msg("%s: %d)\n", msg, errno);
|
|
#endif
|
|
}
|
|
|
|
static inline __printf(1, 2) void ksft_test_result_pass(const char *msg, ...)
|
|
{
|
|
int saved_errno = errno;
|
|
va_list args;
|
|
|
|
ksft_cnt.ksft_pass++;
|
|
|
|
va_start(args, msg);
|
|
printf("ok %u ", ksft_test_num());
|
|
errno = saved_errno;
|
|
vprintf(msg, args);
|
|
va_end(args);
|
|
}
|
|
|
|
static inline __printf(1, 2) void ksft_test_result_fail(const char *msg, ...)
|
|
{
|
|
int saved_errno = errno;
|
|
va_list args;
|
|
|
|
ksft_cnt.ksft_fail++;
|
|
|
|
va_start(args, msg);
|
|
printf("not ok %u ", ksft_test_num());
|
|
errno = saved_errno;
|
|
vprintf(msg, args);
|
|
va_end(args);
|
|
}
|
|
|
|
/**
|
|
* ksft_test_result() - Report test success based on truth of condition
|
|
*
|
|
* @condition: if true, report test success, otherwise failure.
|
|
*/
|
|
#define ksft_test_result(condition, fmt, ...) do { \
|
|
if (!!(condition)) \
|
|
ksft_test_result_pass(fmt, ##__VA_ARGS__);\
|
|
else \
|
|
ksft_test_result_fail(fmt, ##__VA_ARGS__);\
|
|
} while (0)
|
|
|
|
static inline __printf(1, 2) void ksft_test_result_xfail(const char *msg, ...)
|
|
{
|
|
int saved_errno = errno;
|
|
va_list args;
|
|
|
|
ksft_cnt.ksft_xfail++;
|
|
|
|
va_start(args, msg);
|
|
printf("ok %u # XFAIL ", ksft_test_num());
|
|
errno = saved_errno;
|
|
vprintf(msg, args);
|
|
va_end(args);
|
|
}
|
|
|
|
static inline __printf(1, 2) void ksft_test_result_skip(const char *msg, ...)
|
|
{
|
|
int saved_errno = errno;
|
|
va_list args;
|
|
|
|
ksft_cnt.ksft_xskip++;
|
|
|
|
va_start(args, msg);
|
|
printf("ok %u # SKIP ", ksft_test_num());
|
|
errno = saved_errno;
|
|
vprintf(msg, args);
|
|
va_end(args);
|
|
}
|
|
|
|
/* TODO: how does "error" differ from "fail" or "skip"? */
|
|
static inline __printf(1, 2) void ksft_test_result_error(const char *msg, ...)
|
|
{
|
|
int saved_errno = errno;
|
|
va_list args;
|
|
|
|
ksft_cnt.ksft_error++;
|
|
|
|
va_start(args, msg);
|
|
printf("not ok %u # error ", ksft_test_num());
|
|
errno = saved_errno;
|
|
vprintf(msg, args);
|
|
va_end(args);
|
|
}
|
|
|
|
static inline int ksft_exit_pass(void)
|
|
{
|
|
ksft_print_cnts();
|
|
exit(KSFT_PASS);
|
|
}
|
|
|
|
static inline int ksft_exit_fail(void)
|
|
{
|
|
ksft_print_cnts();
|
|
exit(KSFT_FAIL);
|
|
}
|
|
|
|
/**
|
|
* ksft_exit() - Exit selftest based on truth of condition
|
|
*
|
|
* @condition: if true, exit self test with success, otherwise fail.
|
|
*/
|
|
#define ksft_exit(condition) do { \
|
|
if (!!(condition)) \
|
|
ksft_exit_pass(); \
|
|
else \
|
|
ksft_exit_fail(); \
|
|
} while (0)
|
|
|
|
/**
|
|
* ksft_finished() - Exit selftest with success if all tests passed
|
|
*/
|
|
#define ksft_finished() \
|
|
ksft_exit(ksft_plan == \
|
|
ksft_cnt.ksft_pass + \
|
|
ksft_cnt.ksft_xfail + \
|
|
ksft_cnt.ksft_xskip)
|
|
|
|
static inline __printf(1, 2) int ksft_exit_fail_msg(const char *msg, ...)
|
|
{
|
|
int saved_errno = errno;
|
|
va_list args;
|
|
|
|
va_start(args, msg);
|
|
printf("Bail out! ");
|
|
errno = saved_errno;
|
|
vprintf(msg, args);
|
|
va_end(args);
|
|
|
|
ksft_print_cnts();
|
|
exit(KSFT_FAIL);
|
|
}
|
|
|
|
static inline int ksft_exit_xfail(void)
|
|
{
|
|
ksft_print_cnts();
|
|
exit(KSFT_XFAIL);
|
|
}
|
|
|
|
static inline int ksft_exit_xpass(void)
|
|
{
|
|
ksft_print_cnts();
|
|
exit(KSFT_XPASS);
|
|
}
|
|
|
|
static inline __printf(1, 2) int ksft_exit_skip(const char *msg, ...)
|
|
{
|
|
int saved_errno = errno;
|
|
va_list args;
|
|
|
|
va_start(args, msg);
|
|
|
|
/*
|
|
* FIXME: several tests misuse ksft_exit_skip so produce
|
|
* something sensible if some tests have already been run
|
|
* or a plan has been printed. Those tests should use
|
|
* ksft_test_result_skip or ksft_exit_fail_msg instead.
|
|
*/
|
|
if (ksft_plan || ksft_test_num()) {
|
|
ksft_cnt.ksft_xskip++;
|
|
printf("ok %d # SKIP ", 1 + ksft_test_num());
|
|
} else {
|
|
printf("1..0 # SKIP ");
|
|
}
|
|
if (msg) {
|
|
errno = saved_errno;
|
|
vprintf(msg, args);
|
|
va_end(args);
|
|
}
|
|
if (ksft_test_num())
|
|
ksft_print_cnts();
|
|
exit(KSFT_SKIP);
|
|
}
|
|
|
|
#endif /* __KSELFTEST_H */
|