1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * Copyright (c) International Business Machines Corp., 2006
5 * Author: Artem Bityutskiy (Битюцкий Артём)
9 #include <linux/debugfs.h>
10 #include <linux/uaccess.h>
11 #include <linux/module.h>
12 #include <linux/seq_file.h>
16 * ubi_dump_flash - dump a region of flash.
17 * @ubi: UBI device description object
18 * @pnum: the physical eraseblock number to dump
19 * @offset: the starting offset within the physical eraseblock to dump
20 * @len: the length of the region to dump
22 void ubi_dump_flash(struct ubi_device *ubi, int pnum, int offset, int len)
27 loff_t addr = (loff_t)pnum * ubi->peb_size + offset;
32 err = mtd_read(ubi->mtd, addr, len, &read, buf);
33 if (err && err != -EUCLEAN) {
34 ubi_err(ubi, "err %d while reading %d bytes from PEB %d:%d, read %zd bytes",
35 err, len, pnum, offset, read);
39 ubi_msg(ubi, "dumping %d bytes of data from PEB %d, offset %d",
41 print_hex_dump(KERN_DEBUG, "", DUMP_PREFIX_OFFSET, 32, 1, buf, len, 1);
48 * ubi_dump_ec_hdr - dump an erase counter header.
49 * @ec_hdr: the erase counter header to dump
51 void ubi_dump_ec_hdr(const struct ubi_ec_hdr *ec_hdr)
53 pr_err("Erase counter header dump:\n");
54 pr_err("\tmagic %#08x\n", be32_to_cpu(ec_hdr->magic));
55 pr_err("\tversion %d\n", (int)ec_hdr->version);
56 pr_err("\tec %llu\n", (long long)be64_to_cpu(ec_hdr->ec));
57 pr_err("\tvid_hdr_offset %d\n", be32_to_cpu(ec_hdr->vid_hdr_offset));
58 pr_err("\tdata_offset %d\n", be32_to_cpu(ec_hdr->data_offset));
59 pr_err("\timage_seq %d\n", be32_to_cpu(ec_hdr->image_seq));
60 pr_err("\thdr_crc %#08x\n", be32_to_cpu(ec_hdr->hdr_crc));
61 pr_err("erase counter header hexdump:\n");
62 print_hex_dump(KERN_DEBUG, "", DUMP_PREFIX_OFFSET, 32, 1,
63 ec_hdr, UBI_EC_HDR_SIZE, 1);
67 * ubi_dump_vid_hdr - dump a volume identifier header.
68 * @vid_hdr: the volume identifier header to dump
70 void ubi_dump_vid_hdr(const struct ubi_vid_hdr *vid_hdr)
72 pr_err("Volume identifier header dump:\n");
73 pr_err("\tmagic %08x\n", be32_to_cpu(vid_hdr->magic));
74 pr_err("\tversion %d\n", (int)vid_hdr->version);
75 pr_err("\tvol_type %d\n", (int)vid_hdr->vol_type);
76 pr_err("\tcopy_flag %d\n", (int)vid_hdr->copy_flag);
77 pr_err("\tcompat %d\n", (int)vid_hdr->compat);
78 pr_err("\tvol_id %d\n", be32_to_cpu(vid_hdr->vol_id));
79 pr_err("\tlnum %d\n", be32_to_cpu(vid_hdr->lnum));
80 pr_err("\tdata_size %d\n", be32_to_cpu(vid_hdr->data_size));
81 pr_err("\tused_ebs %d\n", be32_to_cpu(vid_hdr->used_ebs));
82 pr_err("\tdata_pad %d\n", be32_to_cpu(vid_hdr->data_pad));
83 pr_err("\tsqnum %llu\n",
84 (unsigned long long)be64_to_cpu(vid_hdr->sqnum));
85 pr_err("\thdr_crc %08x\n", be32_to_cpu(vid_hdr->hdr_crc));
86 pr_err("Volume identifier header hexdump:\n");
87 print_hex_dump(KERN_DEBUG, "", DUMP_PREFIX_OFFSET, 32, 1,
88 vid_hdr, UBI_VID_HDR_SIZE, 1);
92 * ubi_dump_vol_info - dump volume information.
93 * @vol: UBI volume description object
95 void ubi_dump_vol_info(const struct ubi_volume *vol)
97 pr_err("Volume information dump:\n");
98 pr_err("\tvol_id %d\n", vol->vol_id);
99 pr_err("\treserved_pebs %d\n", vol->reserved_pebs);
100 pr_err("\talignment %d\n", vol->alignment);
101 pr_err("\tdata_pad %d\n", vol->data_pad);
102 pr_err("\tvol_type %d\n", vol->vol_type);
103 pr_err("\tname_len %d\n", vol->name_len);
104 pr_err("\tusable_leb_size %d\n", vol->usable_leb_size);
105 pr_err("\tused_ebs %d\n", vol->used_ebs);
106 pr_err("\tused_bytes %lld\n", vol->used_bytes);
107 pr_err("\tlast_eb_bytes %d\n", vol->last_eb_bytes);
108 pr_err("\tcorrupted %d\n", vol->corrupted);
109 pr_err("\tupd_marker %d\n", vol->upd_marker);
111 if (vol->name_len <= UBI_VOL_NAME_MAX &&
112 strnlen(vol->name, vol->name_len + 1) == vol->name_len) {
113 pr_err("\tname %s\n", vol->name);
115 pr_err("\t1st 5 characters of name: %c%c%c%c%c\n",
116 vol->name[0], vol->name[1], vol->name[2],
117 vol->name[3], vol->name[4]);
122 * ubi_dump_vtbl_record - dump a &struct ubi_vtbl_record object.
123 * @r: the object to dump
124 * @idx: volume table index
126 void ubi_dump_vtbl_record(const struct ubi_vtbl_record *r, int idx)
128 int name_len = be16_to_cpu(r->name_len);
130 pr_err("Volume table record %d dump:\n", idx);
131 pr_err("\treserved_pebs %d\n", be32_to_cpu(r->reserved_pebs));
132 pr_err("\talignment %d\n", be32_to_cpu(r->alignment));
133 pr_err("\tdata_pad %d\n", be32_to_cpu(r->data_pad));
134 pr_err("\tvol_type %d\n", (int)r->vol_type);
135 pr_err("\tupd_marker %d\n", (int)r->upd_marker);
136 pr_err("\tname_len %d\n", name_len);
138 if (r->name[0] == '\0') {
139 pr_err("\tname NULL\n");
143 if (name_len <= UBI_VOL_NAME_MAX &&
144 strnlen(&r->name[0], name_len + 1) == name_len) {
145 pr_err("\tname %s\n", &r->name[0]);
147 pr_err("\t1st 5 characters of name: %c%c%c%c%c\n",
148 r->name[0], r->name[1], r->name[2], r->name[3],
151 pr_err("\tcrc %#08x\n", be32_to_cpu(r->crc));
155 * ubi_dump_av - dump a &struct ubi_ainf_volume object.
156 * @av: the object to dump
158 void ubi_dump_av(const struct ubi_ainf_volume *av)
160 pr_err("Volume attaching information dump:\n");
161 pr_err("\tvol_id %d\n", av->vol_id);
162 pr_err("\thighest_lnum %d\n", av->highest_lnum);
163 pr_err("\tleb_count %d\n", av->leb_count);
164 pr_err("\tcompat %d\n", av->compat);
165 pr_err("\tvol_type %d\n", av->vol_type);
166 pr_err("\tused_ebs %d\n", av->used_ebs);
167 pr_err("\tlast_data_size %d\n", av->last_data_size);
168 pr_err("\tdata_pad %d\n", av->data_pad);
172 * ubi_dump_aeb - dump a &struct ubi_ainf_peb object.
173 * @aeb: the object to dump
174 * @type: object type: 0 - not corrupted, 1 - corrupted
176 void ubi_dump_aeb(const struct ubi_ainf_peb *aeb, int type)
178 pr_err("eraseblock attaching information dump:\n");
179 pr_err("\tec %d\n", aeb->ec);
180 pr_err("\tpnum %d\n", aeb->pnum);
182 pr_err("\tlnum %d\n", aeb->lnum);
183 pr_err("\tscrub %d\n", aeb->scrub);
184 pr_err("\tsqnum %llu\n", aeb->sqnum);
189 * ubi_dump_mkvol_req - dump a &struct ubi_mkvol_req object.
190 * @req: the object to dump
192 void ubi_dump_mkvol_req(const struct ubi_mkvol_req *req)
196 pr_err("Volume creation request dump:\n");
197 pr_err("\tvol_id %d\n", req->vol_id);
198 pr_err("\talignment %d\n", req->alignment);
199 pr_err("\tbytes %lld\n", (long long)req->bytes);
200 pr_err("\tvol_type %d\n", req->vol_type);
201 pr_err("\tname_len %d\n", req->name_len);
203 memcpy(nm, req->name, 16);
205 pr_err("\t1st 16 characters of name: %s\n", nm);
209 * Root directory for UBI stuff in debugfs. Contains sub-directories which
210 * contain the stuff specific to particular UBI devices.
212 static struct dentry *dfs_rootdir;
215 * ubi_debugfs_init - create UBI debugfs directory.
217 * Create UBI debugfs directory. Returns zero in case of success and a negative
218 * error code in case of failure.
220 int ubi_debugfs_init(void)
222 if (!IS_ENABLED(CONFIG_DEBUG_FS))
225 dfs_rootdir = debugfs_create_dir("ubi", NULL);
226 if (IS_ERR_OR_NULL(dfs_rootdir)) {
227 int err = dfs_rootdir ? PTR_ERR(dfs_rootdir) : -ENODEV;
229 pr_err("UBI error: cannot create \"ubi\" debugfs directory, error %d\n",
238 * ubi_debugfs_exit - remove UBI debugfs directory.
240 void ubi_debugfs_exit(void)
242 if (IS_ENABLED(CONFIG_DEBUG_FS))
243 debugfs_remove(dfs_rootdir);
246 /* Read an UBI debugfs file */
247 static ssize_t dfs_file_read(struct file *file, char __user *user_buf,
248 size_t count, loff_t *ppos)
250 unsigned long ubi_num = (unsigned long)file->private_data;
251 struct dentry *dent = file->f_path.dentry;
252 struct ubi_device *ubi;
253 struct ubi_debug_info *d;
257 ubi = ubi_get_device(ubi_num);
262 if (dent == d->dfs_chk_gen)
264 else if (dent == d->dfs_chk_io)
266 else if (dent == d->dfs_chk_fastmap)
267 val = d->chk_fastmap;
268 else if (dent == d->dfs_disable_bgt)
269 val = d->disable_bgt;
270 else if (dent == d->dfs_emulate_bitflips)
271 val = d->emulate_bitflips;
272 else if (dent == d->dfs_emulate_io_failures)
273 val = d->emulate_io_failures;
274 else if (dent == d->dfs_emulate_power_cut) {
275 snprintf(buf, sizeof(buf), "%u\n", d->emulate_power_cut);
276 count = simple_read_from_buffer(user_buf, count, ppos,
279 } else if (dent == d->dfs_power_cut_min) {
280 snprintf(buf, sizeof(buf), "%u\n", d->power_cut_min);
281 count = simple_read_from_buffer(user_buf, count, ppos,
284 } else if (dent == d->dfs_power_cut_max) {
285 snprintf(buf, sizeof(buf), "%u\n", d->power_cut_max);
286 count = simple_read_from_buffer(user_buf, count, ppos,
302 count = simple_read_from_buffer(user_buf, count, ppos, buf, 2);
309 /* Write an UBI debugfs file */
310 static ssize_t dfs_file_write(struct file *file, const char __user *user_buf,
311 size_t count, loff_t *ppos)
313 unsigned long ubi_num = (unsigned long)file->private_data;
314 struct dentry *dent = file->f_path.dentry;
315 struct ubi_device *ubi;
316 struct ubi_debug_info *d;
321 ubi = ubi_get_device(ubi_num);
326 buf_size = min_t(size_t, count, (sizeof(buf) - 1));
327 if (copy_from_user(buf, user_buf, buf_size)) {
332 if (dent == d->dfs_power_cut_min) {
333 if (kstrtouint(buf, 0, &d->power_cut_min) != 0)
336 } else if (dent == d->dfs_power_cut_max) {
337 if (kstrtouint(buf, 0, &d->power_cut_max) != 0)
340 } else if (dent == d->dfs_emulate_power_cut) {
341 if (kstrtoint(buf, 0, &val) != 0)
344 d->emulate_power_cut = val;
350 else if (buf[0] == '0')
357 if (dent == d->dfs_chk_gen)
359 else if (dent == d->dfs_chk_io)
361 else if (dent == d->dfs_chk_fastmap)
362 d->chk_fastmap = val;
363 else if (dent == d->dfs_disable_bgt)
364 d->disable_bgt = val;
365 else if (dent == d->dfs_emulate_bitflips)
366 d->emulate_bitflips = val;
367 else if (dent == d->dfs_emulate_io_failures)
368 d->emulate_io_failures = val;
377 /* File operations for all UBI debugfs files except
378 * detailed_erase_block_info
380 static const struct file_operations dfs_fops = {
381 .read = dfs_file_read,
382 .write = dfs_file_write,
385 .owner = THIS_MODULE,
388 /* As long as the position is less then that total number of erase blocks,
389 * we still have more to print.
391 static void *eraseblk_count_seq_start(struct seq_file *s, loff_t *pos)
393 struct ubi_device *ubi = s->private;
396 return SEQ_START_TOKEN;
398 if (*pos < ubi->peb_count)
404 /* Since we are using the position as the iterator, we just need to check if we
405 * are done and increment the position.
407 static void *eraseblk_count_seq_next(struct seq_file *s, void *v, loff_t *pos)
409 struct ubi_device *ubi = s->private;
411 if (v == SEQ_START_TOKEN)
415 if (*pos < ubi->peb_count)
421 static void eraseblk_count_seq_stop(struct seq_file *s, void *v)
425 static int eraseblk_count_seq_show(struct seq_file *s, void *iter)
427 struct ubi_device *ubi = s->private;
428 struct ubi_wl_entry *wl;
429 int *block_number = iter;
430 int erase_count = -1;
433 /* If this is the start, print a header */
434 if (iter == SEQ_START_TOKEN) {
436 "physical_block_number\terase_count\tblock_status\tread_status\n");
440 err = ubi_io_is_bad(ubi, *block_number);
444 spin_lock(&ubi->wl_lock);
446 wl = ubi->lookuptbl[*block_number];
448 erase_count = wl->ec;
450 spin_unlock(&ubi->wl_lock);
455 seq_printf(s, "%-22d\t%-11d\n", *block_number, erase_count);
460 static const struct seq_operations eraseblk_count_seq_ops = {
461 .start = eraseblk_count_seq_start,
462 .next = eraseblk_count_seq_next,
463 .stop = eraseblk_count_seq_stop,
464 .show = eraseblk_count_seq_show
467 static int eraseblk_count_open(struct inode *inode, struct file *f)
472 err = seq_open(f, &eraseblk_count_seq_ops);
477 s->private = ubi_get_device((unsigned long)inode->i_private);
485 static int eraseblk_count_release(struct inode *inode, struct file *f)
487 struct seq_file *s = f->private_data;
488 struct ubi_device *ubi = s->private;
492 return seq_release(inode, f);
495 static const struct file_operations eraseblk_count_fops = {
496 .owner = THIS_MODULE,
497 .open = eraseblk_count_open,
500 .release = eraseblk_count_release,
504 * ubi_debugfs_init_dev - initialize debugfs for an UBI device.
505 * @ubi: UBI device description object
507 * This function creates all debugfs files for UBI device @ubi. Returns zero in
508 * case of success and a negative error code in case of failure.
510 int ubi_debugfs_init_dev(struct ubi_device *ubi)
513 unsigned long ubi_num = ubi->ubi_num;
516 struct ubi_debug_info *d = &ubi->dbg;
518 if (!IS_ENABLED(CONFIG_DEBUG_FS))
521 n = snprintf(d->dfs_dir_name, UBI_DFS_DIR_LEN + 1, UBI_DFS_DIR_NAME,
523 if (n == UBI_DFS_DIR_LEN) {
524 /* The array size is too small */
525 fname = UBI_DFS_DIR_NAME;
526 dent = ERR_PTR(-EINVAL);
530 fname = d->dfs_dir_name;
531 dent = debugfs_create_dir(fname, dfs_rootdir);
532 if (IS_ERR_OR_NULL(dent))
537 dent = debugfs_create_file(fname, S_IWUSR, d->dfs_dir, (void *)ubi_num,
539 if (IS_ERR_OR_NULL(dent))
541 d->dfs_chk_gen = dent;
544 dent = debugfs_create_file(fname, S_IWUSR, d->dfs_dir, (void *)ubi_num,
546 if (IS_ERR_OR_NULL(dent))
548 d->dfs_chk_io = dent;
550 fname = "chk_fastmap";
551 dent = debugfs_create_file(fname, S_IWUSR, d->dfs_dir, (void *)ubi_num,
553 if (IS_ERR_OR_NULL(dent))
555 d->dfs_chk_fastmap = dent;
557 fname = "tst_disable_bgt";
558 dent = debugfs_create_file(fname, S_IWUSR, d->dfs_dir, (void *)ubi_num,
560 if (IS_ERR_OR_NULL(dent))
562 d->dfs_disable_bgt = dent;
564 fname = "tst_emulate_bitflips";
565 dent = debugfs_create_file(fname, S_IWUSR, d->dfs_dir, (void *)ubi_num,
567 if (IS_ERR_OR_NULL(dent))
569 d->dfs_emulate_bitflips = dent;
571 fname = "tst_emulate_io_failures";
572 dent = debugfs_create_file(fname, S_IWUSR, d->dfs_dir, (void *)ubi_num,
574 if (IS_ERR_OR_NULL(dent))
576 d->dfs_emulate_io_failures = dent;
578 fname = "tst_emulate_power_cut";
579 dent = debugfs_create_file(fname, S_IWUSR, d->dfs_dir, (void *)ubi_num,
581 if (IS_ERR_OR_NULL(dent))
583 d->dfs_emulate_power_cut = dent;
585 fname = "tst_emulate_power_cut_min";
586 dent = debugfs_create_file(fname, S_IWUSR, d->dfs_dir, (void *)ubi_num,
588 if (IS_ERR_OR_NULL(dent))
590 d->dfs_power_cut_min = dent;
592 fname = "tst_emulate_power_cut_max";
593 dent = debugfs_create_file(fname, S_IWUSR, d->dfs_dir, (void *)ubi_num,
595 if (IS_ERR_OR_NULL(dent))
597 d->dfs_power_cut_max = dent;
599 fname = "detailed_erase_block_info";
600 dent = debugfs_create_file(fname, S_IRUSR, d->dfs_dir, (void *)ubi_num,
601 &eraseblk_count_fops);
602 if (IS_ERR_OR_NULL(dent))
608 debugfs_remove_recursive(d->dfs_dir);
610 err = dent ? PTR_ERR(dent) : -ENODEV;
611 ubi_err(ubi, "cannot create \"%s\" debugfs file or directory, error %d\n",
617 * dbg_debug_exit_dev - free all debugfs files corresponding to device @ubi
618 * @ubi: UBI device description object
620 void ubi_debugfs_exit_dev(struct ubi_device *ubi)
622 if (IS_ENABLED(CONFIG_DEBUG_FS))
623 debugfs_remove_recursive(ubi->dbg.dfs_dir);
627 * ubi_dbg_power_cut - emulate a power cut if it is time to do so
628 * @ubi: UBI device description object
629 * @caller: Flags set to indicate from where the function is being called
631 * Returns non-zero if a power cut was emulated, zero if not.
633 int ubi_dbg_power_cut(struct ubi_device *ubi, int caller)
637 if ((ubi->dbg.emulate_power_cut & caller) == 0)
640 if (ubi->dbg.power_cut_counter == 0) {
641 ubi->dbg.power_cut_counter = ubi->dbg.power_cut_min;
643 if (ubi->dbg.power_cut_max > ubi->dbg.power_cut_min) {
644 range = ubi->dbg.power_cut_max - ubi->dbg.power_cut_min;
645 ubi->dbg.power_cut_counter += prandom_u32() % range;
650 ubi->dbg.power_cut_counter--;
651 if (ubi->dbg.power_cut_counter)
654 ubi_msg(ubi, "XXXXXXXXXXXXXXX emulating a power cut XXXXXXXXXXXXXXXX");