mtd: sf: Make sf_mtd.c more robust
[platform/kernel/u-boot.git] / fs / fs.c
1 // SPDX-License-Identifier: GPL-2.0
2 /*
3  * Copyright (c) 2012, NVIDIA CORPORATION.  All rights reserved.
4  */
5
6 #include <config.h>
7 #include <errno.h>
8 #include <common.h>
9 #include <mapmem.h>
10 #include <part.h>
11 #include <ext4fs.h>
12 #include <fat.h>
13 #include <fs.h>
14 #include <sandboxfs.h>
15 #include <ubifs_uboot.h>
16 #include <btrfs.h>
17 #include <asm/io.h>
18 #include <div64.h>
19 #include <linux/math64.h>
20
21 DECLARE_GLOBAL_DATA_PTR;
22
23 static struct blk_desc *fs_dev_desc;
24 static int fs_dev_part;
25 static disk_partition_t fs_partition;
26 static int fs_type = FS_TYPE_ANY;
27
28 static inline int fs_probe_unsupported(struct blk_desc *fs_dev_desc,
29                                       disk_partition_t *fs_partition)
30 {
31         printf("** Unrecognized filesystem type **\n");
32         return -1;
33 }
34
35 static inline int fs_ls_unsupported(const char *dirname)
36 {
37         return -1;
38 }
39
40 /* generic implementation of ls in terms of opendir/readdir/closedir */
41 __maybe_unused
42 static int fs_ls_generic(const char *dirname)
43 {
44         struct fs_dir_stream *dirs;
45         struct fs_dirent *dent;
46         int nfiles = 0, ndirs = 0;
47
48         dirs = fs_opendir(dirname);
49         if (!dirs)
50                 return -errno;
51
52         while ((dent = fs_readdir(dirs))) {
53                 if (dent->type == FS_DT_DIR) {
54                         printf("            %s/\n", dent->name);
55                         ndirs++;
56                 } else {
57                         printf(" %8lld   %s\n", dent->size, dent->name);
58                         nfiles++;
59                 }
60         }
61
62         fs_closedir(dirs);
63
64         printf("\n%d file(s), %d dir(s)\n\n", nfiles, ndirs);
65
66         return 0;
67 }
68
69 static inline int fs_exists_unsupported(const char *filename)
70 {
71         return 0;
72 }
73
74 static inline int fs_size_unsupported(const char *filename, loff_t *size)
75 {
76         return -1;
77 }
78
79 static inline int fs_read_unsupported(const char *filename, void *buf,
80                                       loff_t offset, loff_t len,
81                                       loff_t *actread)
82 {
83         return -1;
84 }
85
86 static inline int fs_write_unsupported(const char *filename, void *buf,
87                                       loff_t offset, loff_t len,
88                                       loff_t *actwrite)
89 {
90         return -1;
91 }
92
93 static inline void fs_close_unsupported(void)
94 {
95 }
96
97 static inline int fs_uuid_unsupported(char *uuid_str)
98 {
99         return -1;
100 }
101
102 static inline int fs_opendir_unsupported(const char *filename,
103                                          struct fs_dir_stream **dirs)
104 {
105         return -EACCES;
106 }
107
108 static inline int fs_unlink_unsupported(const char *filename)
109 {
110         return -1;
111 }
112
113 static inline int fs_mkdir_unsupported(const char *dirname)
114 {
115         return -1;
116 }
117
118 struct fstype_info {
119         int fstype;
120         char *name;
121         /*
122          * Is it legal to pass NULL as .probe()'s  fs_dev_desc parameter? This
123          * should be false in most cases. For "virtual" filesystems which
124          * aren't based on a U-Boot block device (e.g. sandbox), this can be
125          * set to true. This should also be true for the dummy entry at the end
126          * of fstypes[], since that is essentially a "virtual" (non-existent)
127          * filesystem.
128          */
129         bool null_dev_desc_ok;
130         int (*probe)(struct blk_desc *fs_dev_desc,
131                      disk_partition_t *fs_partition);
132         int (*ls)(const char *dirname);
133         int (*exists)(const char *filename);
134         int (*size)(const char *filename, loff_t *size);
135         int (*read)(const char *filename, void *buf, loff_t offset,
136                     loff_t len, loff_t *actread);
137         int (*write)(const char *filename, void *buf, loff_t offset,
138                      loff_t len, loff_t *actwrite);
139         void (*close)(void);
140         int (*uuid)(char *uuid_str);
141         /*
142          * Open a directory stream.  On success return 0 and directory
143          * stream pointer via 'dirsp'.  On error, return -errno.  See
144          * fs_opendir().
145          */
146         int (*opendir)(const char *filename, struct fs_dir_stream **dirsp);
147         /*
148          * Read next entry from directory stream.  On success return 0
149          * and directory entry pointer via 'dentp'.  On error return
150          * -errno.  See fs_readdir().
151          */
152         int (*readdir)(struct fs_dir_stream *dirs, struct fs_dirent **dentp);
153         /* see fs_closedir() */
154         void (*closedir)(struct fs_dir_stream *dirs);
155         int (*unlink)(const char *filename);
156         int (*mkdir)(const char *dirname);
157 };
158
159 static struct fstype_info fstypes[] = {
160 #ifdef CONFIG_FS_FAT
161         {
162                 .fstype = FS_TYPE_FAT,
163                 .name = "fat",
164                 .null_dev_desc_ok = false,
165                 .probe = fat_set_blk_dev,
166                 .close = fat_close,
167                 .ls = fs_ls_generic,
168                 .exists = fat_exists,
169                 .size = fat_size,
170                 .read = fat_read_file,
171 #ifdef CONFIG_FAT_WRITE
172                 .write = file_fat_write,
173                 .unlink = fat_unlink,
174                 .mkdir = fat_mkdir,
175 #else
176                 .write = fs_write_unsupported,
177                 .unlink = fs_unlink_unsupported,
178                 .mkdir = fs_mkdir_unsupported,
179 #endif
180                 .uuid = fs_uuid_unsupported,
181                 .opendir = fat_opendir,
182                 .readdir = fat_readdir,
183                 .closedir = fat_closedir,
184         },
185 #endif
186 #ifdef CONFIG_FS_EXT4
187         {
188                 .fstype = FS_TYPE_EXT,
189                 .name = "ext4",
190                 .null_dev_desc_ok = false,
191                 .probe = ext4fs_probe,
192                 .close = ext4fs_close,
193                 .ls = ext4fs_ls,
194                 .exists = ext4fs_exists,
195                 .size = ext4fs_size,
196                 .read = ext4_read_file,
197 #ifdef CONFIG_CMD_EXT4_WRITE
198                 .write = ext4_write_file,
199 #else
200                 .write = fs_write_unsupported,
201 #endif
202                 .uuid = ext4fs_uuid,
203                 .opendir = fs_opendir_unsupported,
204                 .unlink = fs_unlink_unsupported,
205                 .mkdir = fs_mkdir_unsupported,
206         },
207 #endif
208 #ifdef CONFIG_SANDBOX
209         {
210                 .fstype = FS_TYPE_SANDBOX,
211                 .name = "sandbox",
212                 .null_dev_desc_ok = true,
213                 .probe = sandbox_fs_set_blk_dev,
214                 .close = sandbox_fs_close,
215                 .ls = sandbox_fs_ls,
216                 .exists = sandbox_fs_exists,
217                 .size = sandbox_fs_size,
218                 .read = fs_read_sandbox,
219                 .write = fs_write_sandbox,
220                 .uuid = fs_uuid_unsupported,
221                 .opendir = fs_opendir_unsupported,
222                 .unlink = fs_unlink_unsupported,
223                 .mkdir = fs_mkdir_unsupported,
224         },
225 #endif
226 #ifdef CONFIG_CMD_UBIFS
227         {
228                 .fstype = FS_TYPE_UBIFS,
229                 .name = "ubifs",
230                 .null_dev_desc_ok = true,
231                 .probe = ubifs_set_blk_dev,
232                 .close = ubifs_close,
233                 .ls = ubifs_ls,
234                 .exists = ubifs_exists,
235                 .size = ubifs_size,
236                 .read = ubifs_read,
237                 .write = fs_write_unsupported,
238                 .uuid = fs_uuid_unsupported,
239                 .opendir = fs_opendir_unsupported,
240                 .unlink = fs_unlink_unsupported,
241                 .mkdir = fs_mkdir_unsupported,
242         },
243 #endif
244 #ifdef CONFIG_FS_BTRFS
245         {
246                 .fstype = FS_TYPE_BTRFS,
247                 .name = "btrfs",
248                 .null_dev_desc_ok = false,
249                 .probe = btrfs_probe,
250                 .close = btrfs_close,
251                 .ls = btrfs_ls,
252                 .exists = btrfs_exists,
253                 .size = btrfs_size,
254                 .read = btrfs_read,
255                 .write = fs_write_unsupported,
256                 .uuid = btrfs_uuid,
257                 .opendir = fs_opendir_unsupported,
258                 .unlink = fs_unlink_unsupported,
259                 .mkdir = fs_mkdir_unsupported,
260         },
261 #endif
262         {
263                 .fstype = FS_TYPE_ANY,
264                 .name = "unsupported",
265                 .null_dev_desc_ok = true,
266                 .probe = fs_probe_unsupported,
267                 .close = fs_close_unsupported,
268                 .ls = fs_ls_unsupported,
269                 .exists = fs_exists_unsupported,
270                 .size = fs_size_unsupported,
271                 .read = fs_read_unsupported,
272                 .write = fs_write_unsupported,
273                 .uuid = fs_uuid_unsupported,
274                 .opendir = fs_opendir_unsupported,
275                 .unlink = fs_unlink_unsupported,
276                 .mkdir = fs_mkdir_unsupported,
277         },
278 };
279
280 static struct fstype_info *fs_get_info(int fstype)
281 {
282         struct fstype_info *info;
283         int i;
284
285         for (i = 0, info = fstypes; i < ARRAY_SIZE(fstypes) - 1; i++, info++) {
286                 if (fstype == info->fstype)
287                         return info;
288         }
289
290         /* Return the 'unsupported' sentinel */
291         return info;
292 }
293
294 /**
295  * fs_get_type_name() - Get type of current filesystem
296  *
297  * Return: Pointer to filesystem name
298  *
299  * Returns a string describing the current filesystem, or the sentinel
300  * "unsupported" for any unrecognised filesystem.
301  */
302 const char *fs_get_type_name(void)
303 {
304         return fs_get_info(fs_type)->name;
305 }
306
307 int fs_set_blk_dev(const char *ifname, const char *dev_part_str, int fstype)
308 {
309         struct fstype_info *info;
310         int part, i;
311 #ifdef CONFIG_NEEDS_MANUAL_RELOC
312         static int relocated;
313
314         if (!relocated) {
315                 for (i = 0, info = fstypes; i < ARRAY_SIZE(fstypes);
316                                 i++, info++) {
317                         info->name += gd->reloc_off;
318                         info->probe += gd->reloc_off;
319                         info->close += gd->reloc_off;
320                         info->ls += gd->reloc_off;
321                         info->read += gd->reloc_off;
322                         info->write += gd->reloc_off;
323                 }
324                 relocated = 1;
325         }
326 #endif
327
328         part = blk_get_device_part_str(ifname, dev_part_str, &fs_dev_desc,
329                                         &fs_partition, 1);
330         if (part < 0)
331                 return -1;
332
333         for (i = 0, info = fstypes; i < ARRAY_SIZE(fstypes); i++, info++) {
334                 if (fstype != FS_TYPE_ANY && info->fstype != FS_TYPE_ANY &&
335                                 fstype != info->fstype)
336                         continue;
337
338                 if (!fs_dev_desc && !info->null_dev_desc_ok)
339                         continue;
340
341                 if (!info->probe(fs_dev_desc, &fs_partition)) {
342                         fs_type = info->fstype;
343                         fs_dev_part = part;
344                         return 0;
345                 }
346         }
347
348         return -1;
349 }
350
351 /* set current blk device w/ blk_desc + partition # */
352 int fs_set_blk_dev_with_part(struct blk_desc *desc, int part)
353 {
354         struct fstype_info *info;
355         int ret, i;
356
357         if (part >= 1)
358                 ret = part_get_info(desc, part, &fs_partition);
359         else
360                 ret = part_get_info_whole_disk(desc, &fs_partition);
361         if (ret)
362                 return ret;
363         fs_dev_desc = desc;
364
365         for (i = 0, info = fstypes; i < ARRAY_SIZE(fstypes); i++, info++) {
366                 if (!info->probe(fs_dev_desc, &fs_partition)) {
367                         fs_type = info->fstype;
368                         return 0;
369                 }
370         }
371
372         return -1;
373 }
374
375 static void fs_close(void)
376 {
377         struct fstype_info *info = fs_get_info(fs_type);
378
379         info->close();
380
381         fs_type = FS_TYPE_ANY;
382 }
383
384 int fs_uuid(char *uuid_str)
385 {
386         struct fstype_info *info = fs_get_info(fs_type);
387
388         return info->uuid(uuid_str);
389 }
390
391 int fs_ls(const char *dirname)
392 {
393         int ret;
394
395         struct fstype_info *info = fs_get_info(fs_type);
396
397         ret = info->ls(dirname);
398
399         fs_type = FS_TYPE_ANY;
400         fs_close();
401
402         return ret;
403 }
404
405 int fs_exists(const char *filename)
406 {
407         int ret;
408
409         struct fstype_info *info = fs_get_info(fs_type);
410
411         ret = info->exists(filename);
412
413         fs_close();
414
415         return ret;
416 }
417
418 int fs_size(const char *filename, loff_t *size)
419 {
420         int ret;
421
422         struct fstype_info *info = fs_get_info(fs_type);
423
424         ret = info->size(filename, size);
425
426         fs_close();
427
428         return ret;
429 }
430
431 int fs_read(const char *filename, ulong addr, loff_t offset, loff_t len,
432             loff_t *actread)
433 {
434         struct fstype_info *info = fs_get_info(fs_type);
435         void *buf;
436         int ret;
437
438         /*
439          * We don't actually know how many bytes are being read, since len==0
440          * means read the whole file.
441          */
442         buf = map_sysmem(addr, len);
443         ret = info->read(filename, buf, offset, len, actread);
444         unmap_sysmem(buf);
445
446         /* If we requested a specific number of bytes, check we got it */
447         if (ret == 0 && len && *actread != len)
448                 debug("** %s shorter than offset + len **\n", filename);
449         fs_close();
450
451         return ret;
452 }
453
454 int fs_write(const char *filename, ulong addr, loff_t offset, loff_t len,
455              loff_t *actwrite)
456 {
457         struct fstype_info *info = fs_get_info(fs_type);
458         void *buf;
459         int ret;
460
461         buf = map_sysmem(addr, len);
462         ret = info->write(filename, buf, offset, len, actwrite);
463         unmap_sysmem(buf);
464
465         if (ret < 0 && len != *actwrite) {
466                 printf("** Unable to write file %s **\n", filename);
467                 ret = -1;
468         }
469         fs_close();
470
471         return ret;
472 }
473
474 struct fs_dir_stream *fs_opendir(const char *filename)
475 {
476         struct fstype_info *info = fs_get_info(fs_type);
477         struct fs_dir_stream *dirs = NULL;
478         int ret;
479
480         ret = info->opendir(filename, &dirs);
481         fs_close();
482         if (ret) {
483                 errno = -ret;
484                 return NULL;
485         }
486
487         dirs->desc = fs_dev_desc;
488         dirs->part = fs_dev_part;
489
490         return dirs;
491 }
492
493 struct fs_dirent *fs_readdir(struct fs_dir_stream *dirs)
494 {
495         struct fstype_info *info;
496         struct fs_dirent *dirent;
497         int ret;
498
499         fs_set_blk_dev_with_part(dirs->desc, dirs->part);
500         info = fs_get_info(fs_type);
501
502         ret = info->readdir(dirs, &dirent);
503         fs_close();
504         if (ret) {
505                 errno = -ret;
506                 return NULL;
507         }
508
509         return dirent;
510 }
511
512 void fs_closedir(struct fs_dir_stream *dirs)
513 {
514         struct fstype_info *info;
515
516         if (!dirs)
517                 return;
518
519         fs_set_blk_dev_with_part(dirs->desc, dirs->part);
520         info = fs_get_info(fs_type);
521
522         info->closedir(dirs);
523         fs_close();
524 }
525
526 int fs_unlink(const char *filename)
527 {
528         int ret;
529
530         struct fstype_info *info = fs_get_info(fs_type);
531
532         ret = info->unlink(filename);
533
534         fs_type = FS_TYPE_ANY;
535         fs_close();
536
537         return ret;
538 }
539
540 int fs_mkdir(const char *dirname)
541 {
542         int ret;
543
544         struct fstype_info *info = fs_get_info(fs_type);
545
546         ret = info->mkdir(dirname);
547
548         fs_type = FS_TYPE_ANY;
549         fs_close();
550
551         return ret;
552 }
553
554 int do_size(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[],
555                 int fstype)
556 {
557         loff_t size;
558
559         if (argc != 4)
560                 return CMD_RET_USAGE;
561
562         if (fs_set_blk_dev(argv[1], argv[2], fstype))
563                 return 1;
564
565         if (fs_size(argv[3], &size) < 0)
566                 return CMD_RET_FAILURE;
567
568         env_set_hex("filesize", size);
569
570         return 0;
571 }
572
573 int do_load(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[],
574                 int fstype)
575 {
576         unsigned long addr;
577         const char *addr_str;
578         const char *filename;
579         loff_t bytes;
580         loff_t pos;
581         loff_t len_read;
582         int ret;
583         unsigned long time;
584         char *ep;
585
586         if (argc < 2)
587                 return CMD_RET_USAGE;
588         if (argc > 7)
589                 return CMD_RET_USAGE;
590
591         if (fs_set_blk_dev(argv[1], (argc >= 3) ? argv[2] : NULL, fstype))
592                 return 1;
593
594         if (argc >= 4) {
595                 addr = simple_strtoul(argv[3], &ep, 16);
596                 if (ep == argv[3] || *ep != '\0')
597                         return CMD_RET_USAGE;
598         } else {
599                 addr_str = env_get("loadaddr");
600                 if (addr_str != NULL)
601                         addr = simple_strtoul(addr_str, NULL, 16);
602                 else
603                         addr = CONFIG_SYS_LOAD_ADDR;
604         }
605         if (argc >= 5) {
606                 filename = argv[4];
607         } else {
608                 filename = env_get("bootfile");
609                 if (!filename) {
610                         puts("** No boot file defined **\n");
611                         return 1;
612                 }
613         }
614         if (argc >= 6)
615                 bytes = simple_strtoul(argv[5], NULL, 16);
616         else
617                 bytes = 0;
618         if (argc >= 7)
619                 pos = simple_strtoul(argv[6], NULL, 16);
620         else
621                 pos = 0;
622
623         time = get_timer(0);
624         ret = fs_read(filename, addr, pos, bytes, &len_read);
625         time = get_timer(time);
626         if (ret < 0)
627                 return 1;
628
629         printf("%llu bytes read in %lu ms", len_read, time);
630         if (time > 0) {
631                 puts(" (");
632                 print_size(div_u64(len_read, time) * 1000, "/s");
633                 puts(")");
634         }
635         puts("\n");
636
637         env_set_hex("fileaddr", addr);
638         env_set_hex("filesize", len_read);
639
640         return 0;
641 }
642
643 int do_ls(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[],
644         int fstype)
645 {
646         if (argc < 2)
647                 return CMD_RET_USAGE;
648         if (argc > 4)
649                 return CMD_RET_USAGE;
650
651         if (fs_set_blk_dev(argv[1], (argc >= 3) ? argv[2] : NULL, fstype))
652                 return 1;
653
654         if (fs_ls(argc >= 4 ? argv[3] : "/"))
655                 return 1;
656
657         return 0;
658 }
659
660 int file_exists(const char *dev_type, const char *dev_part, const char *file,
661                 int fstype)
662 {
663         if (fs_set_blk_dev(dev_type, dev_part, fstype))
664                 return 0;
665
666         return fs_exists(file);
667 }
668
669 int do_save(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[],
670                 int fstype)
671 {
672         unsigned long addr;
673         const char *filename;
674         loff_t bytes;
675         loff_t pos;
676         loff_t len;
677         int ret;
678         unsigned long time;
679
680         if (argc < 6 || argc > 7)
681                 return CMD_RET_USAGE;
682
683         if (fs_set_blk_dev(argv[1], argv[2], fstype))
684                 return 1;
685
686         addr = simple_strtoul(argv[3], NULL, 16);
687         filename = argv[4];
688         bytes = simple_strtoul(argv[5], NULL, 16);
689         if (argc >= 7)
690                 pos = simple_strtoul(argv[6], NULL, 16);
691         else
692                 pos = 0;
693
694         time = get_timer(0);
695         ret = fs_write(filename, addr, pos, bytes, &len);
696         time = get_timer(time);
697         if (ret < 0)
698                 return 1;
699
700         printf("%llu bytes written in %lu ms", len, time);
701         if (time > 0) {
702                 puts(" (");
703                 print_size(div_u64(len, time) * 1000, "/s");
704                 puts(")");
705         }
706         puts("\n");
707
708         return 0;
709 }
710
711 int do_fs_uuid(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[],
712                 int fstype)
713 {
714         int ret;
715         char uuid[37];
716         memset(uuid, 0, sizeof(uuid));
717
718         if (argc < 3 || argc > 4)
719                 return CMD_RET_USAGE;
720
721         if (fs_set_blk_dev(argv[1], argv[2], fstype))
722                 return 1;
723
724         ret = fs_uuid(uuid);
725         if (ret)
726                 return CMD_RET_FAILURE;
727
728         if (argc == 4)
729                 env_set(argv[3], uuid);
730         else
731                 printf("%s\n", uuid);
732
733         return CMD_RET_SUCCESS;
734 }
735
736 int do_fs_type(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
737 {
738         struct fstype_info *info;
739
740         if (argc < 3 || argc > 4)
741                 return CMD_RET_USAGE;
742
743         if (fs_set_blk_dev(argv[1], argv[2], FS_TYPE_ANY))
744                 return 1;
745
746         info = fs_get_info(fs_type);
747
748         if (argc == 4)
749                 env_set(argv[3], info->name);
750         else
751                 printf("%s\n", info->name);
752
753         return CMD_RET_SUCCESS;
754 }
755
756 int do_rm(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[],
757           int fstype)
758 {
759         if (argc != 4)
760                 return CMD_RET_USAGE;
761
762         if (fs_set_blk_dev(argv[1], argv[2], fstype))
763                 return 1;
764
765         if (fs_unlink(argv[3]))
766                 return 1;
767
768         return 0;
769 }
770
771 int do_mkdir(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[],
772              int fstype)
773 {
774         int ret;
775
776         if (argc != 4)
777                 return CMD_RET_USAGE;
778
779         if (fs_set_blk_dev(argv[1], argv[2], fstype))
780                 return 1;
781
782         ret = fs_mkdir(argv[3]);
783         if (ret) {
784                 printf("** Unable to create a directory \"%s\" **\n", argv[3]);
785                 return 1;
786         }
787
788         return 0;
789 }