1 // SPDX-License-Identifier: GPL-2.0
3 * This file is part of UBIFS.
5 * Copyright (C) 2006-2008 Nokia Corporation.
7 * (C) Copyright 2008-2010
8 * Stefan Roese, DENX Software Engineering, sr@denx.de.
10 * Authors: Artem Bityutskiy (Битюцкий Артём)
17 #include <u-boot/zlib.h>
19 #include <linux/err.h>
20 #include <linux/lzo.h>
22 DECLARE_GLOBAL_DATA_PTR
;
27 * We need a wrapper for zunzip() because the parameters are
28 * incompatible with the lzo decompressor.
30 static int gzip_decompress(const unsigned char *in
, size_t in_len
,
31 unsigned char *out
, size_t *out_len
)
33 return zunzip(out
, *out_len
, (unsigned char *)in
,
34 (unsigned long *)out_len
, 0, 0);
37 /* Fake description object for the "none" compressor */
38 static struct ubifs_compressor none_compr
= {
39 .compr_type
= UBIFS_COMPR_NONE
,
45 static struct ubifs_compressor lzo_compr
= {
46 .compr_type
= UBIFS_COMPR_LZO
,
48 .comp_mutex
= &lzo_mutex
,
52 .decompress
= lzo1x_decompress_safe
,
55 static struct ubifs_compressor zlib_compr
= {
56 .compr_type
= UBIFS_COMPR_ZLIB
,
58 .comp_mutex
= &deflate_mutex
,
59 .decomp_mutex
= &inflate_mutex
,
62 .capi_name
= "deflate",
63 .decompress
= gzip_decompress
,
66 /* All UBIFS compressors */
67 struct ubifs_compressor
*ubifs_compressors
[UBIFS_COMPR_TYPES_CNT
];
74 * kmemdup - duplicate region of memory
76 * @src: memory region to duplicate
77 * @len: memory region length
78 * @gfp: GFP mask to use
80 void *kmemdup(const void *src
, size_t len
, gfp_t gfp
)
84 p
= kmalloc(len
, gfp
);
94 static inline struct crypto_comp
95 *crypto_alloc_comp(const char *alg_name
, u32 type
, u32 mask
)
97 struct ubifs_compressor
*comp
;
98 struct crypto_comp
*ptr
;
101 ptr
= malloc_cache_aligned(sizeof(struct crypto_comp
));
102 while (i
< UBIFS_COMPR_TYPES_CNT
) {
103 comp
= ubifs_compressors
[i
];
108 if (strncmp(alg_name
, comp
->capi_name
, strlen(alg_name
)) == 0) {
114 if (i
>= UBIFS_COMPR_TYPES_CNT
) {
115 dbg_gen("invalid compression type %s", alg_name
);
122 crypto_comp_decompress(const struct ubifs_info
*c
, struct crypto_comp
*tfm
,
123 const u8
*src
, unsigned int slen
, u8
*dst
,
126 struct ubifs_compressor
*compr
= ubifs_compressors
[tfm
->compressor
];
128 size_t tmp_len
= *dlen
;
130 if (compr
->compr_type
== UBIFS_COMPR_NONE
) {
131 memcpy(dst
, src
, slen
);
136 err
= compr
->decompress(src
, slen
, dst
, &tmp_len
);
138 ubifs_err(c
, "cannot decompress %d bytes, compressor %s, "
139 "error %d", slen
, compr
->name
, err
);
147 /* from shrinker.c */
149 /* Global clean znode counter (for all mounted UBIFS instances) */
150 atomic_long_t ubifs_clean_zn_cnt
;
155 * ubifs_decompress - decompress data.
156 * @in_buf: data to decompress
157 * @in_len: length of the data to decompress
158 * @out_buf: output buffer where decompressed data should
159 * @out_len: output length is returned here
160 * @compr_type: type of compression
162 * This function decompresses data from buffer @in_buf into buffer @out_buf.
163 * The length of the uncompressed data is returned in @out_len. This functions
164 * returns %0 on success or a negative error code on failure.
166 int ubifs_decompress(const struct ubifs_info
*c
, const void *in_buf
,
167 int in_len
, void *out_buf
, int *out_len
, int compr_type
)
170 struct ubifs_compressor
*compr
;
172 if (unlikely(compr_type
< 0 || compr_type
>= UBIFS_COMPR_TYPES_CNT
)) {
173 ubifs_err(c
, "invalid compression type %d", compr_type
);
177 compr
= ubifs_compressors
[compr_type
];
179 if (unlikely(!compr
->capi_name
)) {
180 ubifs_err(c
, "%s compression is not compiled in", compr
->name
);
184 if (compr_type
== UBIFS_COMPR_NONE
) {
185 memcpy(out_buf
, in_buf
, in_len
);
190 if (compr
->decomp_mutex
)
191 mutex_lock(compr
->decomp_mutex
);
192 err
= crypto_comp_decompress(c
, compr
->cc
, in_buf
, in_len
, out_buf
,
193 (unsigned int *)out_len
);
194 if (compr
->decomp_mutex
)
195 mutex_unlock(compr
->decomp_mutex
);
197 ubifs_err(c
, "cannot decompress %d bytes, compressor %s,"
198 " error %d", in_len
, compr
->name
, err
);
204 * compr_init - initialize a compressor.
205 * @compr: compressor description object
207 * This function initializes the requested compressor and returns zero in case
208 * of success or a negative error code in case of failure.
210 static int __init
compr_init(struct ubifs_compressor
*compr
)
212 ubifs_compressors
[compr
->compr_type
] = compr
;
214 #ifdef CONFIG_NEEDS_MANUAL_RELOC
215 ubifs_compressors
[compr
->compr_type
]->name
+= gd
->reloc_off
;
216 ubifs_compressors
[compr
->compr_type
]->capi_name
+= gd
->reloc_off
;
217 ubifs_compressors
[compr
->compr_type
]->decompress
+= gd
->reloc_off
;
220 if (compr
->capi_name
) {
221 compr
->cc
= crypto_alloc_comp(compr
->capi_name
, 0, 0);
222 if (IS_ERR(compr
->cc
)) {
223 dbg_gen("cannot initialize compressor %s,"
224 " error %ld", compr
->name
,
226 return PTR_ERR(compr
->cc
);
234 * ubifs_compressors_init - initialize UBIFS compressors.
236 * This function initializes the compressor which were compiled in. Returns
237 * zero in case of success and a negative error code in case of failure.
239 int __init
ubifs_compressors_init(void)
243 err
= compr_init(&lzo_compr
);
247 err
= compr_init(&zlib_compr
);
251 err
= compr_init(&none_compr
);
262 static int filldir(struct ubifs_info
*c
, const char *name
, int namlen
,
263 u64 ino
, unsigned int d_type
)
269 case UBIFS_ITYPE_REG
:
272 case UBIFS_ITYPE_DIR
:
275 case UBIFS_ITYPE_LNK
:
283 inode
= ubifs_iget(c
->vfs_sb
, ino
);
285 printf("%s: Error in ubifs_iget(), ino=%lld ret=%p!\n",
286 __func__
, ino
, inode
);
289 ctime_r((time_t *)&inode
->i_mtime
, filetime
);
290 printf("%9lld %24.24s ", inode
->i_size
, filetime
);
295 printf("%s\n", name
);
300 static int ubifs_printdir(struct file
*file
, void *dirent
)
305 struct ubifs_dent_node
*dent
;
306 struct inode
*dir
= file
->f_path
.dentry
->d_inode
;
307 struct ubifs_info
*c
= dir
->i_sb
->s_fs_info
;
309 dbg_gen("dir ino %lu, f_pos %#llx", dir
->i_ino
, file
->f_pos
);
311 if (file
->f_pos
> UBIFS_S_KEY_HASH_MASK
|| file
->f_pos
== 2)
313 * The directory was seek'ed to a senseless position or there
314 * are no more entries.
318 if (file
->f_pos
== 1) {
319 /* Find the first entry in TNC and save it */
320 lowest_dent_key(c
, &key
, dir
->i_ino
);
322 dent
= ubifs_tnc_next_ent(c
, &key
, &nm
);
328 file
->f_pos
= key_hash_flash(c
, &dent
->key
);
329 file
->private_data
= dent
;
332 dent
= file
->private_data
;
335 * The directory was seek'ed to and is now readdir'ed.
336 * Find the entry corresponding to @file->f_pos or the
339 dent_key_init_hash(c
, &key
, dir
->i_ino
, file
->f_pos
);
341 dent
= ubifs_tnc_next_ent(c
, &key
, &nm
);
346 file
->f_pos
= key_hash_flash(c
, &dent
->key
);
347 file
->private_data
= dent
;
351 dbg_gen("feed '%s', ino %llu, new f_pos %#x",
352 dent
->name
, (unsigned long long)le64_to_cpu(dent
->inum
),
353 key_hash_flash(c
, &dent
->key
));
355 ubifs_assert(le64_to_cpu(dent
->ch
.sqnum
) > ubifs_inode(dir
)->creat_sqnum
);
358 nm
.len
= le16_to_cpu(dent
->nlen
);
359 over
= filldir(c
, (char *)dent
->name
, nm
.len
,
360 le64_to_cpu(dent
->inum
), dent
->type
);
364 /* Switch to the next entry */
365 key_read(c
, &dent
->key
, &key
);
366 nm
.name
= (char *)dent
->name
;
367 dent
= ubifs_tnc_next_ent(c
, &key
, &nm
);
373 kfree(file
->private_data
);
374 file
->f_pos
= key_hash_flash(c
, &dent
->key
);
375 file
->private_data
= dent
;
380 if (err
!= -ENOENT
) {
381 ubifs_err(c
, "cannot find next direntry, error %d", err
);
385 kfree(file
->private_data
);
386 file
->private_data
= NULL
;
391 static int ubifs_finddir(struct super_block
*sb
, char *dirname
,
392 unsigned long root_inum
, unsigned long *inum
)
397 struct ubifs_dent_node
*dent
;
398 struct ubifs_info
*c
;
400 struct dentry
*dentry
;
404 file
= kzalloc(sizeof(struct file
), 0);
405 dentry
= kzalloc(sizeof(struct dentry
), 0);
406 dir
= kzalloc(sizeof(struct inode
), 0);
407 if (!file
|| !dentry
|| !dir
) {
408 printf("%s: Error, no memory for malloc!\n", __func__
);
414 file
->f_path
.dentry
= dentry
;
415 file
->f_path
.dentry
->d_parent
= dentry
;
416 file
->f_path
.dentry
->d_inode
= dir
;
417 file
->f_path
.dentry
->d_inode
->i_ino
= root_inum
;
420 dbg_gen("dir ino %lu, f_pos %#llx", dir
->i_ino
, file
->f_pos
);
422 /* Find the first entry in TNC and save it */
423 lowest_dent_key(c
, &key
, dir
->i_ino
);
425 dent
= ubifs_tnc_next_ent(c
, &key
, &nm
);
431 file
->f_pos
= key_hash_flash(c
, &dent
->key
);
432 file
->private_data
= dent
;
435 dbg_gen("feed '%s', ino %llu, new f_pos %#x",
436 dent
->name
, (unsigned long long)le64_to_cpu(dent
->inum
),
437 key_hash_flash(c
, &dent
->key
));
439 ubifs_assert(le64_to_cpu(dent
->ch
.sqnum
) > ubifs_inode(dir
)->creat_sqnum
);
442 nm
.len
= le16_to_cpu(dent
->nlen
);
443 if ((strncmp(dirname
, (char *)dent
->name
, nm
.len
) == 0) &&
444 (strlen(dirname
) == nm
.len
)) {
445 *inum
= le64_to_cpu(dent
->inum
);
450 /* Switch to the next entry */
451 key_read(c
, &dent
->key
, &key
);
452 nm
.name
= (char *)dent
->name
;
453 dent
= ubifs_tnc_next_ent(c
, &key
, &nm
);
459 kfree(file
->private_data
);
460 file
->f_pos
= key_hash_flash(c
, &dent
->key
);
461 file
->private_data
= dent
;
467 dbg_gen("cannot find next direntry, error %d", err
);
470 kfree(file
->private_data
);
478 static unsigned long ubifs_findfile(struct super_block
*sb
, char *filename
)
483 char symlinkpath
[128];
485 unsigned long root_inum
= 1;
487 int symlink_count
= 0; /* Don't allow symlink recursion */
490 strcpy(fpath
, filename
);
492 /* Remove all leading slashes */
497 * Handle root-direcoty ('/')
500 if (!name
|| *name
== '\0')
505 struct ubifs_inode
*ui
;
507 /* Extract the actual part from the pathname. */
508 next
= strchr(name
, '/');
510 /* Remove all leading slashes. */
515 ret
= ubifs_finddir(sb
, name
, root_inum
, &inum
);
518 inode
= ubifs_iget(sb
, inum
);
522 ui
= ubifs_inode(inode
);
524 if ((inode
->i_mode
& S_IFMT
) == S_IFLNK
) {
527 /* We have some sort of symlink recursion, bail out */
528 if (symlink_count
++ > 8) {
529 printf("Symlink recursion, aborting\n");
532 memcpy(link_name
, ui
->data
, ui
->data_len
);
533 link_name
[ui
->data_len
] = '\0';
535 if (link_name
[0] == '/') {
536 /* Absolute path, redo everything without
537 * the leading slash */
538 next
= name
= link_name
+ 1;
542 /* Relative to cur dir */
543 sprintf(buf
, "%s/%s",
544 link_name
, next
== NULL
? "" : next
);
545 memcpy(symlinkpath
, buf
, sizeof(buf
));
546 next
= name
= symlinkpath
;
551 * Check if directory with this name exists
554 /* Found the node! */
555 if (!next
|| *next
== '\0')
565 int ubifs_set_blk_dev(struct blk_desc
*rbdd
, disk_partition_t
*info
)
568 debug("UBIFS cannot be used with normal block devices\n");
573 * Should never happen since blk_get_device_part_str() already checks
574 * this, but better safe then sorry.
576 if (!ubifs_is_mounted()) {
577 debug("UBIFS not mounted, use ubifsmount to mount volume first!\n");
584 int ubifs_ls(const char *filename
)
586 struct ubifs_info
*c
= ubifs_sb
->s_fs_info
;
588 struct dentry
*dentry
;
594 c
->ubi
= ubi_open_volume(c
->vi
.ubi_num
, c
->vi
.vol_id
, UBI_READONLY
);
595 inum
= ubifs_findfile(ubifs_sb
, (char *)filename
);
601 file
= kzalloc(sizeof(struct file
), 0);
602 dentry
= kzalloc(sizeof(struct dentry
), 0);
603 dir
= kzalloc(sizeof(struct inode
), 0);
604 if (!file
|| !dentry
|| !dir
) {
605 printf("%s: Error, no memory for malloc!\n", __func__
);
610 dir
->i_sb
= ubifs_sb
;
611 file
->f_path
.dentry
= dentry
;
612 file
->f_path
.dentry
->d_parent
= dentry
;
613 file
->f_path
.dentry
->d_inode
= dir
;
614 file
->f_path
.dentry
->d_inode
->i_ino
= inum
;
616 file
->private_data
= NULL
;
617 ubifs_printdir(file
, dirent
);
628 ubi_close_volume(c
->ubi
);
632 int ubifs_exists(const char *filename
)
634 struct ubifs_info
*c
= ubifs_sb
->s_fs_info
;
637 c
->ubi
= ubi_open_volume(c
->vi
.ubi_num
, c
->vi
.vol_id
, UBI_READONLY
);
638 inum
= ubifs_findfile(ubifs_sb
, (char *)filename
);
639 ubi_close_volume(c
->ubi
);
644 int ubifs_size(const char *filename
, loff_t
*size
)
646 struct ubifs_info
*c
= ubifs_sb
->s_fs_info
;
651 c
->ubi
= ubi_open_volume(c
->vi
.ubi_num
, c
->vi
.vol_id
, UBI_READONLY
);
653 inum
= ubifs_findfile(ubifs_sb
, (char *)filename
);
659 inode
= ubifs_iget(ubifs_sb
, inum
);
661 printf("%s: Error reading inode %ld!\n", __func__
, inum
);
662 err
= PTR_ERR(inode
);
666 *size
= inode
->i_size
;
670 ubi_close_volume(c
->ubi
);
680 static inline void *kmap(struct page
*page
)
685 static int read_block(struct inode
*inode
, void *addr
, unsigned int block
,
686 struct ubifs_data_node
*dn
)
688 struct ubifs_info
*c
= inode
->i_sb
->s_fs_info
;
689 int err
, len
, out_len
;
693 data_key_init(c
, &key
, inode
->i_ino
, block
);
694 err
= ubifs_tnc_lookup(c
, &key
, dn
);
697 /* Not found, so it must be a hole */
698 memset(addr
, 0, UBIFS_BLOCK_SIZE
);
702 ubifs_assert(le64_to_cpu(dn
->ch
.sqnum
) > ubifs_inode(inode
)->creat_sqnum
);
704 len
= le32_to_cpu(dn
->size
);
705 if (len
<= 0 || len
> UBIFS_BLOCK_SIZE
)
708 dlen
= le32_to_cpu(dn
->ch
.len
) - UBIFS_DATA_NODE_SZ
;
709 out_len
= UBIFS_BLOCK_SIZE
;
710 err
= ubifs_decompress(c
, &dn
->data
, dlen
, addr
, &out_len
,
711 le16_to_cpu(dn
->compr_type
));
712 if (err
|| len
!= out_len
)
716 * Data length can be less than a full block, even for blocks that are
717 * not the last in the file (e.g., as a result of making a hole and
718 * appending data). Ensure that the remainder is zeroed out.
720 if (len
< UBIFS_BLOCK_SIZE
)
721 memset(addr
+ len
, 0, UBIFS_BLOCK_SIZE
- len
);
726 ubifs_err(c
, "bad data node (block %u, inode %lu)",
727 block
, inode
->i_ino
);
728 ubifs_dump_node(c
, dn
);
732 static int do_readpage(struct ubifs_info
*c
, struct inode
*inode
,
733 struct page
*page
, int last_block_size
)
737 unsigned int block
, beyond
;
738 struct ubifs_data_node
*dn
;
739 loff_t i_size
= inode
->i_size
;
741 dbg_gen("ino %lu, pg %lu, i_size %lld",
742 inode
->i_ino
, page
->index
, i_size
);
746 block
= page
->index
<< UBIFS_BLOCKS_PER_PAGE_SHIFT
;
747 beyond
= (i_size
+ UBIFS_BLOCK_SIZE
- 1) >> UBIFS_BLOCK_SHIFT
;
748 if (block
>= beyond
) {
749 /* Reading beyond inode */
750 memset(addr
, 0, PAGE_CACHE_SIZE
);
754 dn
= kmalloc(UBIFS_MAX_DATA_NODE_SZ
, GFP_NOFS
);
762 if (block
>= beyond
) {
763 /* Reading beyond inode */
765 memset(addr
, 0, UBIFS_BLOCK_SIZE
);
768 * Reading last block? Make sure to not write beyond
769 * the requested size in the destination buffer.
771 if (((block
+ 1) == beyond
) || last_block_size
) {
776 * We need to buffer the data locally for the
777 * last block. This is to not pad the
778 * destination area to a multiple of
781 buff
= malloc_cache_aligned(UBIFS_BLOCK_SIZE
);
783 printf("%s: Error, malloc fails!\n",
789 /* Read block-size into temp buffer */
790 ret
= read_block(inode
, buff
, block
, dn
);
793 if (err
!= -ENOENT
) {
800 dlen
= last_block_size
;
802 dlen
= le32_to_cpu(dn
->size
);
804 /* Now copy required size back to dest */
805 memcpy(addr
, buff
, dlen
);
809 ret
= read_block(inode
, addr
, block
, dn
);
817 if (++i
>= UBIFS_BLOCKS_PER_PAGE
)
820 addr
+= UBIFS_BLOCK_SIZE
;
823 if (err
== -ENOENT
) {
824 /* Not found, so it must be a hole */
828 ubifs_err(c
, "cannot read page %lu of inode %lu, error %d",
829 page
->index
, inode
->i_ino
, err
);
843 int ubifs_read(const char *filename
, void *buf
, loff_t offset
,
844 loff_t size
, loff_t
*actread
)
846 struct ubifs_info
*c
= ubifs_sb
->s_fs_info
;
853 int last_block_size
= 0;
857 if (offset
& (PAGE_SIZE
- 1)) {
858 printf("ubifs: Error offset must be a multiple of %d\n",
863 c
->ubi
= ubi_open_volume(c
->vi
.ubi_num
, c
->vi
.vol_id
, UBI_READONLY
);
864 /* ubifs_findfile will resolve symlinks, so we know that we get
865 * the real file here */
866 inum
= ubifs_findfile(ubifs_sb
, (char *)filename
);
875 inode
= ubifs_iget(ubifs_sb
, inum
);
877 printf("%s: Error reading inode %ld!\n", __func__
, inum
);
878 err
= PTR_ERR(inode
);
882 if (offset
> inode
->i_size
) {
883 printf("ubifs: Error offset (%lld) > file-size (%lld)\n",
890 * If no size was specified or if size bigger than filesize
891 * set size to filesize
893 if ((size
== 0) || (size
> (inode
->i_size
- offset
)))
894 size
= inode
->i_size
- offset
;
896 count
= (size
+ UBIFS_BLOCK_SIZE
- 1) >> UBIFS_BLOCK_SHIFT
;
899 page
.index
= offset
/ PAGE_SIZE
;
901 for (i
= 0; i
< count
; i
++) {
903 * Make sure to not read beyond the requested size
905 if (((i
+ 1) == count
) && (size
< inode
->i_size
))
906 last_block_size
= size
- (i
* PAGE_SIZE
);
908 err
= do_readpage(c
, inode
, &page
, last_block_size
);
912 page
.addr
+= PAGE_SIZE
;
917 printf("Error reading file '%s'\n", filename
);
918 *actread
= i
* PAGE_SIZE
;
927 ubi_close_volume(c
->ubi
);
931 void ubifs_close(void)
935 /* Compat wrappers for common/cmd_ubifs.c */
936 int ubifs_load(char *filename
, u32 addr
, u32 size
)
941 printf("Loading file '%s' to addr 0x%08x...\n", filename
, addr
);
943 err
= ubifs_read(filename
, (void *)(uintptr_t)addr
, 0, size
, &actread
);
945 env_set_hex("filesize", actread
);
952 void uboot_ubifs_umount(void)
955 printf("Unmounting UBIFS volume %s!\n",
956 ((struct ubifs_info
*)(ubifs_sb
->s_fs_info
))->vi
.name
);
957 ubifs_umount(ubifs_sb
->s_fs_info
);