xref: /linux-6.15/drivers/mtd/tests/speedtest.c (revision abc173ad)
1 /*
2  * Copyright (C) 2007 Nokia Corporation
3  *
4  * This program is free software; you can redistribute it and/or modify it
5  * under the terms of the GNU General Public License version 2 as published by
6  * the Free Software Foundation.
7  *
8  * This program is distributed in the hope that it will be useful, but WITHOUT
9  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
10  * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
11  * more details.
12  *
13  * You should have received a copy of the GNU General Public License along with
14  * this program; see the file COPYING. If not, write to the Free Software
15  * Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
16  *
17  * Test read and write speed of a MTD device.
18  *
19  * Author: Adrian Hunter <[email protected]>
20  */
21 
22 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
23 
24 #include <linux/init.h>
25 #include <linux/module.h>
26 #include <linux/moduleparam.h>
27 #include <linux/err.h>
28 #include <linux/mtd/mtd.h>
29 #include <linux/slab.h>
30 #include <linux/sched.h>
31 #include <linux/random.h>
32 
33 #include "mtd_test.h"
34 
35 static int dev = -EINVAL;
36 module_param(dev, int, S_IRUGO);
37 MODULE_PARM_DESC(dev, "MTD device number to use");
38 
39 static int count;
40 module_param(count, int, S_IRUGO);
41 MODULE_PARM_DESC(count, "Maximum number of eraseblocks to use "
42 			"(0 means use all)");
43 
44 static struct mtd_info *mtd;
45 static unsigned char *iobuf;
46 static unsigned char *bbt;
47 
48 static int pgsize;
49 static int ebcnt;
50 static int pgcnt;
51 static int goodebcnt;
52 static struct timeval start, finish;
53 
54 static int multiblock_erase(int ebnum, int blocks)
55 {
56 	int err;
57 	struct erase_info ei;
58 	loff_t addr = ebnum * mtd->erasesize;
59 
60 	memset(&ei, 0, sizeof(struct erase_info));
61 	ei.mtd  = mtd;
62 	ei.addr = addr;
63 	ei.len  = mtd->erasesize * blocks;
64 
65 	err = mtd_erase(mtd, &ei);
66 	if (err) {
67 		pr_err("error %d while erasing EB %d, blocks %d\n",
68 		       err, ebnum, blocks);
69 		return err;
70 	}
71 
72 	if (ei.state == MTD_ERASE_FAILED) {
73 		pr_err("some erase error occurred at EB %d,"
74 		       "blocks %d\n", ebnum, blocks);
75 		return -EIO;
76 	}
77 
78 	return 0;
79 }
80 
81 static int write_eraseblock(int ebnum)
82 {
83 	int err;
84 	loff_t addr = ebnum * mtd->erasesize;
85 
86 	err = mtdtest_write(mtd, addr, mtd->erasesize, iobuf);
87 	if (err)
88 		pr_err("error: write failed at %#llx\n", addr);
89 
90 	return err;
91 }
92 
93 static int write_eraseblock_by_page(int ebnum)
94 {
95 	int i, err = 0;
96 	loff_t addr = ebnum * mtd->erasesize;
97 	void *buf = iobuf;
98 
99 	for (i = 0; i < pgcnt; i++) {
100 		err = mtdtest_write(mtd, addr, pgsize, buf);
101 		if (err) {
102 			pr_err("error: write failed at %#llx\n",
103 			       addr);
104 			break;
105 		}
106 		addr += pgsize;
107 		buf += pgsize;
108 	}
109 
110 	return err;
111 }
112 
113 static int write_eraseblock_by_2pages(int ebnum)
114 {
115 	size_t sz = pgsize * 2;
116 	int i, n = pgcnt / 2, err = 0;
117 	loff_t addr = ebnum * mtd->erasesize;
118 	void *buf = iobuf;
119 
120 	for (i = 0; i < n; i++) {
121 		err = mtdtest_write(mtd, addr, sz, buf);
122 		if (err) {
123 			pr_err("error: write failed at %#llx\n",
124 			       addr);
125 			return err;
126 		}
127 		addr += sz;
128 		buf += sz;
129 	}
130 	if (pgcnt % 2) {
131 		err = mtdtest_write(mtd, addr, pgsize, buf);
132 		if (err) {
133 			pr_err("error: write failed at %#llx\n",
134 			       addr);
135 		}
136 	}
137 
138 	return err;
139 }
140 
141 static int read_eraseblock(int ebnum)
142 {
143 	loff_t addr = ebnum * mtd->erasesize;
144 
145 	return mtdtest_read(mtd, addr, mtd->erasesize, iobuf);
146 }
147 
148 static int read_eraseblock_by_page(int ebnum)
149 {
150 	int i, err = 0;
151 	loff_t addr = ebnum * mtd->erasesize;
152 	void *buf = iobuf;
153 
154 	for (i = 0; i < pgcnt; i++) {
155 		err = mtdtest_read(mtd, addr, pgsize, buf);
156 		if (err)
157 			break;
158 		addr += pgsize;
159 		buf += pgsize;
160 	}
161 
162 	return err;
163 }
164 
165 static int read_eraseblock_by_2pages(int ebnum)
166 {
167 	size_t sz = pgsize * 2;
168 	int i, n = pgcnt / 2, err = 0;
169 	loff_t addr = ebnum * mtd->erasesize;
170 	void *buf = iobuf;
171 
172 	for (i = 0; i < n; i++) {
173 		err = mtdtest_read(mtd, addr, sz, buf);
174 		if (err)
175 			return err;
176 		addr += sz;
177 		buf += sz;
178 	}
179 	if (pgcnt % 2)
180 		err = mtdtest_read(mtd, addr, pgsize, buf);
181 
182 	return err;
183 }
184 
185 static inline void start_timing(void)
186 {
187 	do_gettimeofday(&start);
188 }
189 
190 static inline void stop_timing(void)
191 {
192 	do_gettimeofday(&finish);
193 }
194 
195 static long calc_speed(void)
196 {
197 	uint64_t k;
198 	long ms;
199 
200 	ms = (finish.tv_sec - start.tv_sec) * 1000 +
201 	     (finish.tv_usec - start.tv_usec) / 1000;
202 	if (ms == 0)
203 		return 0;
204 	k = goodebcnt * (mtd->erasesize / 1024) * 1000;
205 	do_div(k, ms);
206 	return k;
207 }
208 
209 static int __init mtd_speedtest_init(void)
210 {
211 	int err, i, blocks, j, k;
212 	long speed;
213 	uint64_t tmp;
214 
215 	printk(KERN_INFO "\n");
216 	printk(KERN_INFO "=================================================\n");
217 
218 	if (dev < 0) {
219 		pr_info("Please specify a valid mtd-device via module parameter\n");
220 		pr_crit("CAREFUL: This test wipes all data on the specified MTD device!\n");
221 		return -EINVAL;
222 	}
223 
224 	if (count)
225 		pr_info("MTD device: %d    count: %d\n", dev, count);
226 	else
227 		pr_info("MTD device: %d\n", dev);
228 
229 	mtd = get_mtd_device(NULL, dev);
230 	if (IS_ERR(mtd)) {
231 		err = PTR_ERR(mtd);
232 		pr_err("error: cannot get MTD device\n");
233 		return err;
234 	}
235 
236 	if (mtd->writesize == 1) {
237 		pr_info("not NAND flash, assume page size is 512 "
238 		       "bytes.\n");
239 		pgsize = 512;
240 	} else
241 		pgsize = mtd->writesize;
242 
243 	tmp = mtd->size;
244 	do_div(tmp, mtd->erasesize);
245 	ebcnt = tmp;
246 	pgcnt = mtd->erasesize / pgsize;
247 
248 	pr_info("MTD device size %llu, eraseblock size %u, "
249 	       "page size %u, count of eraseblocks %u, pages per "
250 	       "eraseblock %u, OOB size %u\n",
251 	       (unsigned long long)mtd->size, mtd->erasesize,
252 	       pgsize, ebcnt, pgcnt, mtd->oobsize);
253 
254 	if (count > 0 && count < ebcnt)
255 		ebcnt = count;
256 
257 	err = -ENOMEM;
258 	iobuf = kmalloc(mtd->erasesize, GFP_KERNEL);
259 	if (!iobuf)
260 		goto out;
261 
262 	prandom_bytes(iobuf, mtd->erasesize);
263 
264 	bbt = kzalloc(ebcnt, GFP_KERNEL);
265 	if (!bbt)
266 		goto out;
267 	err = mtdtest_scan_for_bad_eraseblocks(mtd, bbt, 0, ebcnt);
268 	if (err)
269 		goto out;
270 	for (i = 0; i < ebcnt; i++) {
271 		if (!bbt[i])
272 			goodebcnt++;
273 	}
274 
275 	err = mtdtest_erase_good_eraseblocks(mtd, bbt, 0, ebcnt);
276 	if (err)
277 		goto out;
278 
279 	/* Write all eraseblocks, 1 eraseblock at a time */
280 	pr_info("testing eraseblock write speed\n");
281 	start_timing();
282 	for (i = 0; i < ebcnt; ++i) {
283 		if (bbt[i])
284 			continue;
285 		err = write_eraseblock(i);
286 		if (err)
287 			goto out;
288 		cond_resched();
289 	}
290 	stop_timing();
291 	speed = calc_speed();
292 	pr_info("eraseblock write speed is %ld KiB/s\n", speed);
293 
294 	/* Read all eraseblocks, 1 eraseblock at a time */
295 	pr_info("testing eraseblock read speed\n");
296 	start_timing();
297 	for (i = 0; i < ebcnt; ++i) {
298 		if (bbt[i])
299 			continue;
300 		err = read_eraseblock(i);
301 		if (err)
302 			goto out;
303 		cond_resched();
304 	}
305 	stop_timing();
306 	speed = calc_speed();
307 	pr_info("eraseblock read speed is %ld KiB/s\n", speed);
308 
309 	err = mtdtest_erase_good_eraseblocks(mtd, bbt, 0, ebcnt);
310 	if (err)
311 		goto out;
312 
313 	/* Write all eraseblocks, 1 page at a time */
314 	pr_info("testing page write speed\n");
315 	start_timing();
316 	for (i = 0; i < ebcnt; ++i) {
317 		if (bbt[i])
318 			continue;
319 		err = write_eraseblock_by_page(i);
320 		if (err)
321 			goto out;
322 		cond_resched();
323 	}
324 	stop_timing();
325 	speed = calc_speed();
326 	pr_info("page write speed is %ld KiB/s\n", speed);
327 
328 	/* Read all eraseblocks, 1 page at a time */
329 	pr_info("testing page read speed\n");
330 	start_timing();
331 	for (i = 0; i < ebcnt; ++i) {
332 		if (bbt[i])
333 			continue;
334 		err = read_eraseblock_by_page(i);
335 		if (err)
336 			goto out;
337 		cond_resched();
338 	}
339 	stop_timing();
340 	speed = calc_speed();
341 	pr_info("page read speed is %ld KiB/s\n", speed);
342 
343 	err = mtdtest_erase_good_eraseblocks(mtd, bbt, 0, ebcnt);
344 	if (err)
345 		goto out;
346 
347 	/* Write all eraseblocks, 2 pages at a time */
348 	pr_info("testing 2 page write speed\n");
349 	start_timing();
350 	for (i = 0; i < ebcnt; ++i) {
351 		if (bbt[i])
352 			continue;
353 		err = write_eraseblock_by_2pages(i);
354 		if (err)
355 			goto out;
356 		cond_resched();
357 	}
358 	stop_timing();
359 	speed = calc_speed();
360 	pr_info("2 page write speed is %ld KiB/s\n", speed);
361 
362 	/* Read all eraseblocks, 2 pages at a time */
363 	pr_info("testing 2 page read speed\n");
364 	start_timing();
365 	for (i = 0; i < ebcnt; ++i) {
366 		if (bbt[i])
367 			continue;
368 		err = read_eraseblock_by_2pages(i);
369 		if (err)
370 			goto out;
371 		cond_resched();
372 	}
373 	stop_timing();
374 	speed = calc_speed();
375 	pr_info("2 page read speed is %ld KiB/s\n", speed);
376 
377 	/* Erase all eraseblocks */
378 	pr_info("Testing erase speed\n");
379 	start_timing();
380 	err = mtdtest_erase_good_eraseblocks(mtd, bbt, 0, ebcnt);
381 	if (err)
382 		goto out;
383 	stop_timing();
384 	speed = calc_speed();
385 	pr_info("erase speed is %ld KiB/s\n", speed);
386 
387 	/* Multi-block erase all eraseblocks */
388 	for (k = 1; k < 7; k++) {
389 		blocks = 1 << k;
390 		pr_info("Testing %dx multi-block erase speed\n",
391 		       blocks);
392 		start_timing();
393 		for (i = 0; i < ebcnt; ) {
394 			for (j = 0; j < blocks && (i + j) < ebcnt; j++)
395 				if (bbt[i + j])
396 					break;
397 			if (j < 1) {
398 				i++;
399 				continue;
400 			}
401 			err = multiblock_erase(i, j);
402 			if (err)
403 				goto out;
404 			cond_resched();
405 			i += j;
406 		}
407 		stop_timing();
408 		speed = calc_speed();
409 		pr_info("%dx multi-block erase speed is %ld KiB/s\n",
410 		       blocks, speed);
411 	}
412 	pr_info("finished\n");
413 out:
414 	kfree(iobuf);
415 	kfree(bbt);
416 	put_mtd_device(mtd);
417 	if (err)
418 		pr_info("error %d occurred\n", err);
419 	printk(KERN_INFO "=================================================\n");
420 	return err;
421 }
422 module_init(mtd_speedtest_init);
423 
424 static void __exit mtd_speedtest_exit(void)
425 {
426 	return;
427 }
428 module_exit(mtd_speedtest_exit);
429 
430 MODULE_DESCRIPTION("Speed test module");
431 MODULE_AUTHOR("Adrian Hunter");
432 MODULE_LICENSE("GPL");
433