lib/test_printf.c: test precision quirks
[linux-block.git] / lib / test_printf.c
CommitLineData
707cc728
RV
1/*
2 * Test cases for printf facility.
3 */
4
5#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
6
7#include <linux/init.h>
8#include <linux/kernel.h>
9#include <linux/module.h>
10#include <linux/printk.h>
11#include <linux/random.h>
12#include <linux/slab.h>
13#include <linux/string.h>
14
15#include <linux/socket.h>
16#include <linux/in.h>
17
18#define BUF_SIZE 256
331e4deb 19#define PAD_SIZE 16
707cc728
RV
20#define FILL_CHAR '$'
21
22#define PTR1 ((void*)0x01234567)
23#define PTR2 ((void*)(long)(int)0xfedcba98)
24
25#if BITS_PER_LONG == 64
26#define PTR1_ZEROES "000000000"
27#define PTR1_SPACES " "
28#define PTR1_STR "1234567"
29#define PTR2_STR "fffffffffedcba98"
30#define PTR_WIDTH 16
31#else
32#define PTR1_ZEROES "0"
33#define PTR1_SPACES " "
34#define PTR1_STR "1234567"
35#define PTR2_STR "fedcba98"
36#define PTR_WIDTH 8
37#endif
38#define PTR_WIDTH_STR stringify(PTR_WIDTH)
39
40static unsigned total_tests __initdata;
41static unsigned failed_tests __initdata;
42static char *test_buffer __initdata;
331e4deb 43static char *alloced_buffer __initdata;
707cc728
RV
44
45static int __printf(4, 0) __init
46do_test(int bufsize, const char *expect, int elen,
47 const char *fmt, va_list ap)
48{
49 va_list aq;
50 int ret, written;
51
52 total_tests++;
53
331e4deb 54 memset(alloced_buffer, FILL_CHAR, BUF_SIZE + 2*PAD_SIZE);
707cc728
RV
55 va_copy(aq, ap);
56 ret = vsnprintf(test_buffer, bufsize, fmt, aq);
57 va_end(aq);
58
59 if (ret != elen) {
60 pr_warn("vsnprintf(buf, %d, \"%s\", ...) returned %d, expected %d\n",
61 bufsize, fmt, ret, elen);
62 return 1;
63 }
64
331e4deb
RV
65 if (memchr_inv(alloced_buffer, FILL_CHAR, PAD_SIZE)) {
66 pr_warn("vsnprintf(buf, %d, \"%s\", ...) wrote before buffer\n", bufsize, fmt);
67 return 1;
68 }
69
707cc728 70 if (!bufsize) {
331e4deb 71 if (memchr_inv(test_buffer, FILL_CHAR, BUF_SIZE + PAD_SIZE)) {
707cc728
RV
72 pr_warn("vsnprintf(buf, 0, \"%s\", ...) wrote to buffer\n",
73 fmt);
74 return 1;
75 }
76 return 0;
77 }
78
79 written = min(bufsize-1, elen);
80 if (test_buffer[written]) {
81 pr_warn("vsnprintf(buf, %d, \"%s\", ...) did not nul-terminate buffer\n",
82 bufsize, fmt);
83 return 1;
84 }
85
331e4deb
RV
86 if (memchr_inv(test_buffer + written + 1, FILL_CHAR, BUF_SIZE + PAD_SIZE - (written + 1))) {
87 pr_warn("vsnprintf(buf, %d, \"%s\", ...) wrote beyond the nul-terminator\n",
88 bufsize, fmt);
89 return 1;
90 }
91
707cc728
RV
92 if (memcmp(test_buffer, expect, written)) {
93 pr_warn("vsnprintf(buf, %d, \"%s\", ...) wrote '%s', expected '%.*s'\n",
94 bufsize, fmt, test_buffer, written, expect);
95 return 1;
96 }
97 return 0;
98}
99
100static void __printf(3, 4) __init
101__test(const char *expect, int elen, const char *fmt, ...)
102{
103 va_list ap;
104 int rand;
105 char *p;
106
fd0515d5
RV
107 if (elen >= BUF_SIZE) {
108 pr_err("error in test suite: expected output length %d too long. Format was '%s'.\n",
109 elen, fmt);
110 failed_tests++;
111 return;
112 }
707cc728
RV
113
114 va_start(ap, fmt);
115
116 /*
117 * Every fmt+args is subjected to four tests: Three where we
118 * tell vsnprintf varying buffer sizes (plenty, not quite
119 * enough and 0), and then we also test that kvasprintf would
120 * be able to print it as expected.
121 */
122 failed_tests += do_test(BUF_SIZE, expect, elen, fmt, ap);
123 rand = 1 + prandom_u32_max(elen+1);
124 /* Since elen < BUF_SIZE, we have 1 <= rand <= BUF_SIZE. */
125 failed_tests += do_test(rand, expect, elen, fmt, ap);
126 failed_tests += do_test(0, expect, elen, fmt, ap);
127
128 p = kvasprintf(GFP_KERNEL, fmt, ap);
129 if (p) {
130 if (memcmp(p, expect, elen+1)) {
131 pr_warn("kvasprintf(..., \"%s\", ...) returned '%s', expected '%s'\n",
132 fmt, p, expect);
133 failed_tests++;
134 }
135 kfree(p);
136 }
137 va_end(ap);
138}
139
140#define test(expect, fmt, ...) \
141 __test(expect, strlen(expect), fmt, ##__VA_ARGS__)
142
143static void __init
144test_basic(void)
145{
146 /* Work around annoying "warning: zero-length gnu_printf format string". */
147 char nul = '\0';
148
149 test("", &nul);
150 test("100%", "100%%");
151 test("xxx%yyy", "xxx%cyyy", '%');
152 __test("xxx\0yyy", 7, "xxx%cyyy", '\0');
153}
154
155static void __init
156test_number(void)
157{
158 test("0x1234abcd ", "%#-12x", 0x1234abcd);
159 test(" 0x1234abcd", "%#12x", 0x1234abcd);
160 test("0|001| 12|+123| 1234|-123|-1234", "%d|%03d|%3d|%+d|% d|%+d|% d", 0, 1, 12, 123, 1234, -123, -1234);
161}
162
163static void __init
164test_string(void)
165{
166 test("", "%s%.0s", "", "123");
167 test("ABCD|abc|123", "%s|%.3s|%.*s", "ABCD", "abcdef", 3, "123456");
168 test("1 | 2|3 | 4|5 ", "%-3s|%3s|%-*s|%*s|%*s", "1", "2", 3, "3", 3, "4", -3, "5");
f176eb4c
RV
169 test("1234 ", "%-10.4s", "123456");
170 test(" 1234", "%10.4s", "123456");
707cc728 171 /*
f176eb4c
RV
172 * POSIX and C99 say that a negative precision (which is only
173 * possible to pass via a * argument) should be treated as if
174 * the precision wasn't present, and that if the precision is
175 * omitted (as in %.s), the precision should be taken to be
176 * 0. However, the kernel's printf behave exactly opposite,
177 * treating a negative precision as 0 and treating an omitted
178 * precision specifier as if no precision was given.
179 *
180 * These test cases document the current behaviour; should
181 * anyone ever feel the need to follow the standards more
182 * closely, this can be revisited.
707cc728 183 */
f176eb4c
RV
184 test(" ", "%4.*s", -5, "123456");
185 test("123456", "%.s", "123456");
707cc728
RV
186 test("a||", "%.s|%.0s|%.*s", "a", "b", 0, "c");
187 test("a | | ", "%-3.s|%-3.0s|%-3.*s", "a", "b", 0, "c");
188}
189
190static void __init
191plain(void)
192{
193 test(PTR1_ZEROES PTR1_STR " " PTR2_STR, "%p %p", PTR1, PTR2);
194 /*
195 * The field width is overloaded for some %p extensions to
196 * pass another piece of information. For plain pointers, the
197 * behaviour is slightly odd: One cannot pass either the 0
198 * flag nor a precision to %p without gcc complaining, and if
199 * one explicitly gives a field width, the number is no longer
200 * zero-padded.
201 */
202 test("|" PTR1_STR PTR1_SPACES " | " PTR1_SPACES PTR1_STR "|",
203 "|%-*p|%*p|", PTR_WIDTH+2, PTR1, PTR_WIDTH+2, PTR1);
204 test("|" PTR2_STR " | " PTR2_STR "|",
205 "|%-*p|%*p|", PTR_WIDTH+2, PTR2, PTR_WIDTH+2, PTR2);
206
207 /*
208 * Unrecognized %p extensions are treated as plain %p, but the
209 * alphanumeric suffix is ignored (that is, does not occur in
210 * the output.)
211 */
212 test("|"PTR1_ZEROES PTR1_STR"|", "|%p0y|", PTR1);
213 test("|"PTR2_STR"|", "|%p0y|", PTR2);
214}
215
216static void __init
217symbol_ptr(void)
218{
219}
220
221static void __init
222kernel_ptr(void)
223{
224}
225
226static void __init
227struct_resource(void)
228{
229}
230
231static void __init
232addr(void)
233{
234}
235
236static void __init
237escaped_str(void)
238{
239}
240
241static void __init
242hex_string(void)
243{
244 const char buf[3] = {0xc0, 0xff, 0xee};
245
246 test("c0 ff ee|c0:ff:ee|c0-ff-ee|c0ffee",
247 "%3ph|%3phC|%3phD|%3phN", buf, buf, buf, buf);
248 test("c0 ff ee|c0:ff:ee|c0-ff-ee|c0ffee",
249 "%*ph|%*phC|%*phD|%*phN", 3, buf, 3, buf, 3, buf, 3, buf);
250}
251
252static void __init
253mac(void)
254{
255 const u8 addr[6] = {0x2d, 0x48, 0xd6, 0xfc, 0x7a, 0x05};
256
257 test("2d:48:d6:fc:7a:05", "%pM", addr);
258 test("05:7a:fc:d6:48:2d", "%pMR", addr);
259 test("2d-48-d6-fc-7a-05", "%pMF", addr);
260 test("2d48d6fc7a05", "%pm", addr);
261 test("057afcd6482d", "%pmR", addr);
262}
263
264static void __init
265ip4(void)
266{
267 struct sockaddr_in sa;
268
269 sa.sin_family = AF_INET;
270 sa.sin_port = cpu_to_be16(12345);
271 sa.sin_addr.s_addr = cpu_to_be32(0x7f000001);
272
273 test("127.000.000.001|127.0.0.1", "%pi4|%pI4", &sa.sin_addr, &sa.sin_addr);
274 test("127.000.000.001|127.0.0.1", "%piS|%pIS", &sa, &sa);
275 sa.sin_addr.s_addr = cpu_to_be32(0x01020304);
276 test("001.002.003.004:12345|1.2.3.4:12345", "%piSp|%pISp", &sa, &sa);
277}
278
279static void __init
280ip6(void)
281{
282}
283
284static void __init
285ip(void)
286{
287 ip4();
288 ip6();
289}
290
291static void __init
292uuid(void)
293{
294 const char uuid[16] = {0x0, 0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7,
295 0x8, 0x9, 0xa, 0xb, 0xc, 0xd, 0xe, 0xf};
296
297 test("00010203-0405-0607-0809-0a0b0c0d0e0f", "%pUb", uuid);
298 test("00010203-0405-0607-0809-0A0B0C0D0E0F", "%pUB", uuid);
299 test("03020100-0504-0706-0809-0a0b0c0d0e0f", "%pUl", uuid);
300 test("03020100-0504-0706-0809-0A0B0C0D0E0F", "%pUL", uuid);
301}
302
303static void __init
304dentry(void)
305{
306}
307
308static void __init
309struct_va_format(void)
310{
311}
312
313static void __init
314struct_clk(void)
315{
316}
317
318static void __init
319bitmap(void)
320{
321 DECLARE_BITMAP(bits, 20);
322 const int primes[] = {2,3,5,7,11,13,17,19};
323 int i;
324
325 bitmap_zero(bits, 20);
326 test("00000|00000", "%20pb|%*pb", bits, 20, bits);
327 test("|", "%20pbl|%*pbl", bits, 20, bits);
328
329 for (i = 0; i < ARRAY_SIZE(primes); ++i)
330 set_bit(primes[i], bits);
331 test("a28ac|a28ac", "%20pb|%*pb", bits, 20, bits);
332 test("2-3,5,7,11,13,17,19|2-3,5,7,11,13,17,19", "%20pbl|%*pbl", bits, 20, bits);
333
334 bitmap_fill(bits, 20);
335 test("fffff|fffff", "%20pb|%*pb", bits, 20, bits);
336 test("0-19|0-19", "%20pbl|%*pbl", bits, 20, bits);
337}
338
339static void __init
340netdev_features(void)
341{
342}
343
344static void __init
345test_pointer(void)
346{
347 plain();
348 symbol_ptr();
349 kernel_ptr();
350 struct_resource();
351 addr();
352 escaped_str();
353 hex_string();
354 mac();
355 ip();
356 uuid();
357 dentry();
358 struct_va_format();
359 struct_clk();
360 bitmap();
361 netdev_features();
362}
363
364static int __init
365test_printf_init(void)
366{
331e4deb
RV
367 alloced_buffer = kmalloc(BUF_SIZE + 2*PAD_SIZE, GFP_KERNEL);
368 if (!alloced_buffer)
707cc728 369 return -ENOMEM;
331e4deb 370 test_buffer = alloced_buffer + PAD_SIZE;
707cc728
RV
371
372 test_basic();
373 test_number();
374 test_string();
375 test_pointer();
376
331e4deb 377 kfree(alloced_buffer);
707cc728
RV
378
379 if (failed_tests == 0)
380 pr_info("all %u tests passed\n", total_tests);
381 else
382 pr_warn("failed %u out of %u tests\n", failed_tests, total_tests);
383
384 return failed_tests ? -EINVAL : 0;
385}
386
387module_init(test_printf_init);
388
389MODULE_AUTHOR("Rasmus Villemoes <linux@rasmusvillemoes.dk>");
390MODULE_LICENSE("GPL");