1*2874c5fdSThomas Gleixner // SPDX-License-Identifier: GPL-2.0-or-later
286a89380SLuca Barbieri /*
386a89380SLuca Barbieri * Testsuite for atomic64_t functions
486a89380SLuca Barbieri *
586a89380SLuca Barbieri * Copyright © 2010 Luca Barbieri
686a89380SLuca Barbieri */
7b3b16d28SFabian Frederick
8b3b16d28SFabian Frederick #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
9b3b16d28SFabian Frederick
1086a89380SLuca Barbieri #include <linux/init.h>
1150af5eadSPaul Gortmaker #include <linux/bug.h>
120dbdd1bfSPeter Huewe #include <linux/kernel.h>
1360063497SArun Sharma #include <linux/atomic.h>
1455ded955SGeert Uytterhoeven #include <linux/module.h>
1586a89380SLuca Barbieri
16153a4334SAndi Kleen #ifdef CONFIG_X86
17cd4d09ecSBorislav Petkov #include <asm/cpufeature.h> /* for boot_cpu_has below */
18153a4334SAndi Kleen #endif
19153a4334SAndi Kleen
2041b9e9fcSPeter Zijlstra #define TEST(bit, op, c_op, val) \
2141b9e9fcSPeter Zijlstra do { \
2241b9e9fcSPeter Zijlstra atomic##bit##_set(&v, v0); \
2341b9e9fcSPeter Zijlstra r = v0; \
2441b9e9fcSPeter Zijlstra atomic##bit##_##op(val, &v); \
2541b9e9fcSPeter Zijlstra r c_op val; \
2641b9e9fcSPeter Zijlstra WARN(atomic##bit##_read(&v) != r, "%Lx != %Lx\n", \
2741b9e9fcSPeter Zijlstra (unsigned long long)atomic##bit##_read(&v), \
2841b9e9fcSPeter Zijlstra (unsigned long long)r); \
2941b9e9fcSPeter Zijlstra } while (0)
3041b9e9fcSPeter Zijlstra
31978e5a36SBoqun Feng /*
32978e5a36SBoqun Feng * Test for a atomic operation family,
33978e5a36SBoqun Feng * @test should be a macro accepting parameters (bit, op, ...)
34978e5a36SBoqun Feng */
35978e5a36SBoqun Feng
36978e5a36SBoqun Feng #define FAMILY_TEST(test, bit, op, args...) \
37978e5a36SBoqun Feng do { \
38978e5a36SBoqun Feng test(bit, op, ##args); \
39978e5a36SBoqun Feng test(bit, op##_acquire, ##args); \
40978e5a36SBoqun Feng test(bit, op##_release, ##args); \
41978e5a36SBoqun Feng test(bit, op##_relaxed, ##args); \
42978e5a36SBoqun Feng } while (0)
43978e5a36SBoqun Feng
44978e5a36SBoqun Feng #define TEST_RETURN(bit, op, c_op, val) \
45978e5a36SBoqun Feng do { \
46978e5a36SBoqun Feng atomic##bit##_set(&v, v0); \
47978e5a36SBoqun Feng r = v0; \
48978e5a36SBoqun Feng r c_op val; \
49978e5a36SBoqun Feng BUG_ON(atomic##bit##_##op(val, &v) != r); \
50978e5a36SBoqun Feng BUG_ON(atomic##bit##_read(&v) != r); \
51978e5a36SBoqun Feng } while (0)
52978e5a36SBoqun Feng
5328aa2bdaSPeter Zijlstra #define TEST_FETCH(bit, op, c_op, val) \
5428aa2bdaSPeter Zijlstra do { \
5528aa2bdaSPeter Zijlstra atomic##bit##_set(&v, v0); \
5628aa2bdaSPeter Zijlstra r = v0; \
5728aa2bdaSPeter Zijlstra r c_op val; \
5828aa2bdaSPeter Zijlstra BUG_ON(atomic##bit##_##op(val, &v) != v0); \
5928aa2bdaSPeter Zijlstra BUG_ON(atomic##bit##_read(&v) != r); \
6028aa2bdaSPeter Zijlstra } while (0)
6128aa2bdaSPeter Zijlstra
62978e5a36SBoqun Feng #define RETURN_FAMILY_TEST(bit, op, c_op, val) \
63978e5a36SBoqun Feng do { \
64978e5a36SBoqun Feng FAMILY_TEST(TEST_RETURN, bit, op, c_op, val); \
65978e5a36SBoqun Feng } while (0)
66978e5a36SBoqun Feng
6728aa2bdaSPeter Zijlstra #define FETCH_FAMILY_TEST(bit, op, c_op, val) \
6828aa2bdaSPeter Zijlstra do { \
6928aa2bdaSPeter Zijlstra FAMILY_TEST(TEST_FETCH, bit, op, c_op, val); \
7028aa2bdaSPeter Zijlstra } while (0)
7128aa2bdaSPeter Zijlstra
72978e5a36SBoqun Feng #define TEST_ARGS(bit, op, init, ret, expect, args...) \
73978e5a36SBoqun Feng do { \
74978e5a36SBoqun Feng atomic##bit##_set(&v, init); \
75978e5a36SBoqun Feng BUG_ON(atomic##bit##_##op(&v, ##args) != ret); \
76978e5a36SBoqun Feng BUG_ON(atomic##bit##_read(&v) != expect); \
77978e5a36SBoqun Feng } while (0)
78978e5a36SBoqun Feng
79978e5a36SBoqun Feng #define XCHG_FAMILY_TEST(bit, init, new) \
80978e5a36SBoqun Feng do { \
81978e5a36SBoqun Feng FAMILY_TEST(TEST_ARGS, bit, xchg, init, init, new, new); \
82978e5a36SBoqun Feng } while (0)
83978e5a36SBoqun Feng
84978e5a36SBoqun Feng #define CMPXCHG_FAMILY_TEST(bit, init, new, wrong) \
85978e5a36SBoqun Feng do { \
86978e5a36SBoqun Feng FAMILY_TEST(TEST_ARGS, bit, cmpxchg, \
87978e5a36SBoqun Feng init, init, new, init, new); \
88978e5a36SBoqun Feng FAMILY_TEST(TEST_ARGS, bit, cmpxchg, \
89978e5a36SBoqun Feng init, init, init, wrong, new); \
90978e5a36SBoqun Feng } while (0)
91978e5a36SBoqun Feng
92978e5a36SBoqun Feng #define INC_RETURN_FAMILY_TEST(bit, i) \
93978e5a36SBoqun Feng do { \
94978e5a36SBoqun Feng FAMILY_TEST(TEST_ARGS, bit, inc_return, \
95978e5a36SBoqun Feng i, (i) + one, (i) + one); \
96978e5a36SBoqun Feng } while (0)
97978e5a36SBoqun Feng
98978e5a36SBoqun Feng #define DEC_RETURN_FAMILY_TEST(bit, i) \
99978e5a36SBoqun Feng do { \
100978e5a36SBoqun Feng FAMILY_TEST(TEST_ARGS, bit, dec_return, \
101978e5a36SBoqun Feng i, (i) - one, (i) - one); \
102978e5a36SBoqun Feng } while (0)
103978e5a36SBoqun Feng
test_atomic(void)10441b9e9fcSPeter Zijlstra static __init void test_atomic(void)
10541b9e9fcSPeter Zijlstra {
10641b9e9fcSPeter Zijlstra int v0 = 0xaaa31337;
10741b9e9fcSPeter Zijlstra int v1 = 0xdeadbeef;
10841b9e9fcSPeter Zijlstra int onestwos = 0x11112222;
10941b9e9fcSPeter Zijlstra int one = 1;
11041b9e9fcSPeter Zijlstra
11141b9e9fcSPeter Zijlstra atomic_t v;
11241b9e9fcSPeter Zijlstra int r;
11341b9e9fcSPeter Zijlstra
11441b9e9fcSPeter Zijlstra TEST(, add, +=, onestwos);
11541b9e9fcSPeter Zijlstra TEST(, add, +=, -one);
11641b9e9fcSPeter Zijlstra TEST(, sub, -=, onestwos);
11741b9e9fcSPeter Zijlstra TEST(, sub, -=, -one);
11841b9e9fcSPeter Zijlstra TEST(, or, |=, v1);
11941b9e9fcSPeter Zijlstra TEST(, and, &=, v1);
12041b9e9fcSPeter Zijlstra TEST(, xor, ^=, v1);
12141b9e9fcSPeter Zijlstra TEST(, andnot, &= ~, v1);
122978e5a36SBoqun Feng
123978e5a36SBoqun Feng RETURN_FAMILY_TEST(, add_return, +=, onestwos);
124978e5a36SBoqun Feng RETURN_FAMILY_TEST(, add_return, +=, -one);
125978e5a36SBoqun Feng RETURN_FAMILY_TEST(, sub_return, -=, onestwos);
126978e5a36SBoqun Feng RETURN_FAMILY_TEST(, sub_return, -=, -one);
127978e5a36SBoqun Feng
12828aa2bdaSPeter Zijlstra FETCH_FAMILY_TEST(, fetch_add, +=, onestwos);
12928aa2bdaSPeter Zijlstra FETCH_FAMILY_TEST(, fetch_add, +=, -one);
13028aa2bdaSPeter Zijlstra FETCH_FAMILY_TEST(, fetch_sub, -=, onestwos);
13128aa2bdaSPeter Zijlstra FETCH_FAMILY_TEST(, fetch_sub, -=, -one);
13228aa2bdaSPeter Zijlstra
13328aa2bdaSPeter Zijlstra FETCH_FAMILY_TEST(, fetch_or, |=, v1);
13428aa2bdaSPeter Zijlstra FETCH_FAMILY_TEST(, fetch_and, &=, v1);
13528aa2bdaSPeter Zijlstra FETCH_FAMILY_TEST(, fetch_andnot, &= ~, v1);
13628aa2bdaSPeter Zijlstra FETCH_FAMILY_TEST(, fetch_xor, ^=, v1);
13728aa2bdaSPeter Zijlstra
138978e5a36SBoqun Feng INC_RETURN_FAMILY_TEST(, v0);
139978e5a36SBoqun Feng DEC_RETURN_FAMILY_TEST(, v0);
140978e5a36SBoqun Feng
141978e5a36SBoqun Feng XCHG_FAMILY_TEST(, v0, v1);
142978e5a36SBoqun Feng CMPXCHG_FAMILY_TEST(, v0, v1, onestwos);
143978e5a36SBoqun Feng
14441b9e9fcSPeter Zijlstra }
14541b9e9fcSPeter Zijlstra
14686a89380SLuca Barbieri #define INIT(c) do { atomic64_set(&v, c); r = c; } while (0)
test_atomic64(void)14741b9e9fcSPeter Zijlstra static __init void test_atomic64(void)
14886a89380SLuca Barbieri {
14986a89380SLuca Barbieri long long v0 = 0xaaa31337c001d00dLL;
15086a89380SLuca Barbieri long long v1 = 0xdeadbeefdeafcafeLL;
15186a89380SLuca Barbieri long long v2 = 0xfaceabadf00df001LL;
152ffba19ccSMichael Ellerman long long v3 = 0x8000000000000000LL;
15386a89380SLuca Barbieri long long onestwos = 0x1111111122222222LL;
15486a89380SLuca Barbieri long long one = 1LL;
155ffba19ccSMichael Ellerman int r_int;
15686a89380SLuca Barbieri
15786a89380SLuca Barbieri atomic64_t v = ATOMIC64_INIT(v0);
15886a89380SLuca Barbieri long long r = v0;
15986a89380SLuca Barbieri BUG_ON(v.counter != r);
16086a89380SLuca Barbieri
16186a89380SLuca Barbieri atomic64_set(&v, v1);
16286a89380SLuca Barbieri r = v1;
16386a89380SLuca Barbieri BUG_ON(v.counter != r);
16486a89380SLuca Barbieri BUG_ON(atomic64_read(&v) != r);
16586a89380SLuca Barbieri
16641b9e9fcSPeter Zijlstra TEST(64, add, +=, onestwos);
16741b9e9fcSPeter Zijlstra TEST(64, add, +=, -one);
16841b9e9fcSPeter Zijlstra TEST(64, sub, -=, onestwos);
16941b9e9fcSPeter Zijlstra TEST(64, sub, -=, -one);
17041b9e9fcSPeter Zijlstra TEST(64, or, |=, v1);
17141b9e9fcSPeter Zijlstra TEST(64, and, &=, v1);
17241b9e9fcSPeter Zijlstra TEST(64, xor, ^=, v1);
17341b9e9fcSPeter Zijlstra TEST(64, andnot, &= ~, v1);
17486a89380SLuca Barbieri
175978e5a36SBoqun Feng RETURN_FAMILY_TEST(64, add_return, +=, onestwos);
176978e5a36SBoqun Feng RETURN_FAMILY_TEST(64, add_return, +=, -one);
177978e5a36SBoqun Feng RETURN_FAMILY_TEST(64, sub_return, -=, onestwos);
178978e5a36SBoqun Feng RETURN_FAMILY_TEST(64, sub_return, -=, -one);
17986a89380SLuca Barbieri
18028aa2bdaSPeter Zijlstra FETCH_FAMILY_TEST(64, fetch_add, +=, onestwos);
18128aa2bdaSPeter Zijlstra FETCH_FAMILY_TEST(64, fetch_add, +=, -one);
18228aa2bdaSPeter Zijlstra FETCH_FAMILY_TEST(64, fetch_sub, -=, onestwos);
18328aa2bdaSPeter Zijlstra FETCH_FAMILY_TEST(64, fetch_sub, -=, -one);
18428aa2bdaSPeter Zijlstra
18528aa2bdaSPeter Zijlstra FETCH_FAMILY_TEST(64, fetch_or, |=, v1);
18628aa2bdaSPeter Zijlstra FETCH_FAMILY_TEST(64, fetch_and, &=, v1);
18728aa2bdaSPeter Zijlstra FETCH_FAMILY_TEST(64, fetch_andnot, &= ~, v1);
18828aa2bdaSPeter Zijlstra FETCH_FAMILY_TEST(64, fetch_xor, ^=, v1);
18928aa2bdaSPeter Zijlstra
19086a89380SLuca Barbieri INIT(v0);
19186a89380SLuca Barbieri atomic64_inc(&v);
19286a89380SLuca Barbieri r += one;
19386a89380SLuca Barbieri BUG_ON(v.counter != r);
19486a89380SLuca Barbieri
19586a89380SLuca Barbieri INIT(v0);
19686a89380SLuca Barbieri atomic64_dec(&v);
19786a89380SLuca Barbieri r -= one;
19886a89380SLuca Barbieri BUG_ON(v.counter != r);
19986a89380SLuca Barbieri
200978e5a36SBoqun Feng INC_RETURN_FAMILY_TEST(64, v0);
201978e5a36SBoqun Feng DEC_RETURN_FAMILY_TEST(64, v0);
20286a89380SLuca Barbieri
203978e5a36SBoqun Feng XCHG_FAMILY_TEST(64, v0, v1);
204978e5a36SBoqun Feng CMPXCHG_FAMILY_TEST(64, v0, v1, v2);
20586a89380SLuca Barbieri
20686a89380SLuca Barbieri INIT(v0);
2079efbcd59SLuca Barbieri BUG_ON(atomic64_add_unless(&v, one, v0));
20886a89380SLuca Barbieri BUG_ON(v.counter != r);
20986a89380SLuca Barbieri
21086a89380SLuca Barbieri INIT(v0);
2119efbcd59SLuca Barbieri BUG_ON(!atomic64_add_unless(&v, one, v1));
21286a89380SLuca Barbieri r += one;
21386a89380SLuca Barbieri BUG_ON(v.counter != r);
21486a89380SLuca Barbieri
21586a89380SLuca Barbieri INIT(onestwos);
21686a89380SLuca Barbieri BUG_ON(atomic64_dec_if_positive(&v) != (onestwos - 1));
21786a89380SLuca Barbieri r -= one;
21886a89380SLuca Barbieri BUG_ON(v.counter != r);
21986a89380SLuca Barbieri
22086a89380SLuca Barbieri INIT(0);
22186a89380SLuca Barbieri BUG_ON(atomic64_dec_if_positive(&v) != -one);
22286a89380SLuca Barbieri BUG_ON(v.counter != r);
22386a89380SLuca Barbieri
22486a89380SLuca Barbieri INIT(-one);
22586a89380SLuca Barbieri BUG_ON(atomic64_dec_if_positive(&v) != (-one - one));
22686a89380SLuca Barbieri BUG_ON(v.counter != r);
22786a89380SLuca Barbieri
22886a89380SLuca Barbieri INIT(onestwos);
22925a304f2SLuca Barbieri BUG_ON(!atomic64_inc_not_zero(&v));
23086a89380SLuca Barbieri r += one;
23186a89380SLuca Barbieri BUG_ON(v.counter != r);
23286a89380SLuca Barbieri
23386a89380SLuca Barbieri INIT(0);
23425a304f2SLuca Barbieri BUG_ON(atomic64_inc_not_zero(&v));
23586a89380SLuca Barbieri BUG_ON(v.counter != r);
23686a89380SLuca Barbieri
23786a89380SLuca Barbieri INIT(-one);
23825a304f2SLuca Barbieri BUG_ON(!atomic64_inc_not_zero(&v));
23986a89380SLuca Barbieri r += one;
24086a89380SLuca Barbieri BUG_ON(v.counter != r);
241ffba19ccSMichael Ellerman
242ffba19ccSMichael Ellerman /* Confirm the return value fits in an int, even if the value doesn't */
243ffba19ccSMichael Ellerman INIT(v3);
244ffba19ccSMichael Ellerman r_int = atomic64_inc_not_zero(&v);
245ffba19ccSMichael Ellerman BUG_ON(!r_int);
24641b9e9fcSPeter Zijlstra }
24741b9e9fcSPeter Zijlstra
test_atomics_init(void)24855ded955SGeert Uytterhoeven static __init int test_atomics_init(void)
24941b9e9fcSPeter Zijlstra {
25041b9e9fcSPeter Zijlstra test_atomic();
25141b9e9fcSPeter Zijlstra test_atomic64();
25286a89380SLuca Barbieri
25386a89380SLuca Barbieri #ifdef CONFIG_X86
254b3b16d28SFabian Frederick pr_info("passed for %s platform %s CX8 and %s SSE\n",
255a5c9161fSH. Peter Anvin #ifdef CONFIG_X86_64
256a5c9161fSH. Peter Anvin "x86-64",
257a5c9161fSH. Peter Anvin #elif defined(CONFIG_X86_CMPXCHG64)
258a5c9161fSH. Peter Anvin "i586+",
25986a89380SLuca Barbieri #else
260a5c9161fSH. Peter Anvin "i386+",
26186a89380SLuca Barbieri #endif
26286a89380SLuca Barbieri boot_cpu_has(X86_FEATURE_CX8) ? "with" : "without",
26386a89380SLuca Barbieri boot_cpu_has(X86_FEATURE_XMM) ? "with" : "without");
26486a89380SLuca Barbieri #else
265b3b16d28SFabian Frederick pr_info("passed\n");
26686a89380SLuca Barbieri #endif
26786a89380SLuca Barbieri
26886a89380SLuca Barbieri return 0;
26986a89380SLuca Barbieri }
27086a89380SLuca Barbieri
test_atomics_exit(void)27155ded955SGeert Uytterhoeven static __exit void test_atomics_exit(void) {}
27255ded955SGeert Uytterhoeven
27355ded955SGeert Uytterhoeven module_init(test_atomics_init);
27455ded955SGeert Uytterhoeven module_exit(test_atomics_exit);
27555ded955SGeert Uytterhoeven
27655ded955SGeert Uytterhoeven MODULE_LICENSE("GPL");
277