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 (Битюцкий Артём)
19 #include <dm/devres.h>
20 #include <u-boot/zlib.h>
22 #include <linux/compat.h>
23 #include <linux/err.h>
24 #include <linux/lzo.h>
26 DECLARE_GLOBAL_DATA_PTR;
31 * We need a wrapper for zunzip() because the parameters are
32 * incompatible with the lzo decompressor.
34 static int gzip_decompress(const unsigned char *in, size_t in_len,
35 unsigned char *out, size_t *out_len)
37 return zunzip(out, *out_len, (unsigned char *)in,
38 (unsigned long *)out_len, 0, 0);
41 /* Fake description object for the "none" compressor */
42 static struct ubifs_compressor none_compr = {
43 .compr_type = UBIFS_COMPR_NONE,
49 static struct ubifs_compressor lzo_compr = {
50 .compr_type = UBIFS_COMPR_LZO,
52 .comp_mutex = &lzo_mutex,
56 .decompress = lzo1x_decompress_safe,
59 static struct ubifs_compressor zlib_compr = {
60 .compr_type = UBIFS_COMPR_ZLIB,
62 .comp_mutex = &deflate_mutex,
63 .decomp_mutex = &inflate_mutex,
66 .capi_name = "deflate",
67 .decompress = gzip_decompress,
70 /* All UBIFS compressors */
71 struct ubifs_compressor *ubifs_compressors[UBIFS_COMPR_TYPES_CNT];
80 static inline struct crypto_comp
81 *crypto_alloc_comp(const char *alg_name, u32 type, u32 mask)
83 struct ubifs_compressor *comp;
84 struct crypto_comp *ptr;
87 ptr = malloc_cache_aligned(sizeof(struct crypto_comp));
88 while (i < UBIFS_COMPR_TYPES_CNT) {
89 comp = ubifs_compressors[i];
94 if (strncmp(alg_name, comp->capi_name, strlen(alg_name)) == 0) {
100 if (i >= UBIFS_COMPR_TYPES_CNT) {
101 dbg_gen("invalid compression type %s", alg_name);
108 crypto_comp_decompress(const struct ubifs_info *c, struct crypto_comp *tfm,
109 const u8 *src, unsigned int slen, u8 *dst,
112 struct ubifs_compressor *compr = ubifs_compressors[tfm->compressor];
114 size_t tmp_len = *dlen;
116 if (compr->compr_type == UBIFS_COMPR_NONE) {
117 memcpy(dst, src, slen);
122 err = compr->decompress(src, slen, dst, &tmp_len);
124 ubifs_err(c, "cannot decompress %d bytes, compressor %s, "
125 "error %d", slen, compr->name, err);
133 /* from shrinker.c */
135 /* Global clean znode counter (for all mounted UBIFS instances) */
136 atomic_long_t ubifs_clean_zn_cnt;
141 * ubifs_decompress - decompress data.
142 * @in_buf: data to decompress
143 * @in_len: length of the data to decompress
144 * @out_buf: output buffer where decompressed data should
145 * @out_len: output length is returned here
146 * @compr_type: type of compression
148 * This function decompresses data from buffer @in_buf into buffer @out_buf.
149 * The length of the uncompressed data is returned in @out_len. This functions
150 * returns %0 on success or a negative error code on failure.
152 int ubifs_decompress(const struct ubifs_info *c, const void *in_buf,
153 int in_len, void *out_buf, int *out_len, int compr_type)
156 struct ubifs_compressor *compr;
158 if (unlikely(compr_type < 0 || compr_type >= UBIFS_COMPR_TYPES_CNT)) {
159 ubifs_err(c, "invalid compression type %d", compr_type);
163 compr = ubifs_compressors[compr_type];
165 if (unlikely(!compr->capi_name)) {
166 ubifs_err(c, "%s compression is not compiled in", compr->name);
170 if (compr_type == UBIFS_COMPR_NONE) {
171 memcpy(out_buf, in_buf, in_len);
176 if (compr->decomp_mutex)
177 mutex_lock(compr->decomp_mutex);
178 err = crypto_comp_decompress(c, compr->cc, in_buf, in_len, out_buf,
179 (unsigned int *)out_len);
180 if (compr->decomp_mutex)
181 mutex_unlock(compr->decomp_mutex);
183 ubifs_err(c, "cannot decompress %d bytes, compressor %s,"
184 " error %d", in_len, compr->name, err);
190 * compr_init - initialize a compressor.
191 * @compr: compressor description object
193 * This function initializes the requested compressor and returns zero in case
194 * of success or a negative error code in case of failure.
196 static int __init compr_init(struct ubifs_compressor *compr)
198 ubifs_compressors[compr->compr_type] = compr;
200 #ifdef CONFIG_NEEDS_MANUAL_RELOC
201 ubifs_compressors[compr->compr_type]->name += gd->reloc_off;
202 ubifs_compressors[compr->compr_type]->capi_name += gd->reloc_off;
203 ubifs_compressors[compr->compr_type]->decompress += gd->reloc_off;
206 if (compr->capi_name) {
207 compr->cc = crypto_alloc_comp(compr->capi_name, 0, 0);
208 if (IS_ERR(compr->cc)) {
209 dbg_gen("cannot initialize compressor %s,"
210 " error %ld", compr->name,
212 return PTR_ERR(compr->cc);
220 * ubifs_compressors_init - initialize UBIFS compressors.
222 * This function initializes the compressor which were compiled in. Returns
223 * zero in case of success and a negative error code in case of failure.
225 int __init ubifs_compressors_init(void)
229 err = compr_init(&lzo_compr);
233 err = compr_init(&zlib_compr);
237 err = compr_init(&none_compr);
248 static int filldir(struct ubifs_info *c, const char *name, int namlen,
249 u64 ino, unsigned int d_type)
255 case UBIFS_ITYPE_REG:
258 case UBIFS_ITYPE_DIR:
261 case UBIFS_ITYPE_LNK:
269 inode = ubifs_iget(c->vfs_sb, ino);
271 printf("%s: Error in ubifs_iget(), ino=%lld ret=%p!\n",
272 __func__, ino, inode);
275 ctime_r((time_t *)&inode->i_mtime, filetime);
276 printf("%9lld %24.24s ", inode->i_size, filetime);
281 printf("%s\n", name);
286 static int ubifs_printdir(struct file *file, void *dirent)
291 struct ubifs_dent_node *dent;
292 struct inode *dir = file->f_path.dentry->d_inode;
293 struct ubifs_info *c = dir->i_sb->s_fs_info;
295 dbg_gen("dir ino %lu, f_pos %#llx", dir->i_ino, file->f_pos);
297 if (file->f_pos > UBIFS_S_KEY_HASH_MASK || file->f_pos == 2)
299 * The directory was seek'ed to a senseless position or there
300 * are no more entries.
304 if (file->f_pos == 1) {
305 /* Find the first entry in TNC and save it */
306 lowest_dent_key(c, &key, dir->i_ino);
308 dent = ubifs_tnc_next_ent(c, &key, &nm);
314 file->f_pos = key_hash_flash(c, &dent->key);
315 file->private_data = dent;
318 dent = file->private_data;
321 * The directory was seek'ed to and is now readdir'ed.
322 * Find the entry corresponding to @file->f_pos or the
325 dent_key_init_hash(c, &key, dir->i_ino, file->f_pos);
327 dent = ubifs_tnc_next_ent(c, &key, &nm);
332 file->f_pos = key_hash_flash(c, &dent->key);
333 file->private_data = dent;
337 dbg_gen("feed '%s', ino %llu, new f_pos %#x",
338 dent->name, (unsigned long long)le64_to_cpu(dent->inum),
339 key_hash_flash(c, &dent->key));
341 ubifs_assert(le64_to_cpu(dent->ch.sqnum) > ubifs_inode(dir)->creat_sqnum);
344 nm.len = le16_to_cpu(dent->nlen);
345 over = filldir(c, (char *)dent->name, nm.len,
346 le64_to_cpu(dent->inum), dent->type);
350 /* Switch to the next entry */
351 key_read(c, &dent->key, &key);
352 nm.name = (char *)dent->name;
353 dent = ubifs_tnc_next_ent(c, &key, &nm);
359 kfree(file->private_data);
360 file->f_pos = key_hash_flash(c, &dent->key);
361 file->private_data = dent;
366 if (err != -ENOENT) {
367 ubifs_err(c, "cannot find next direntry, error %d", err);
371 kfree(file->private_data);
372 file->private_data = NULL;
377 static int ubifs_finddir(struct super_block *sb, char *dirname,
378 unsigned long root_inum, unsigned long *inum)
383 struct ubifs_dent_node *dent;
384 struct ubifs_info *c;
386 struct dentry *dentry;
390 file = kzalloc(sizeof(struct file), 0);
391 dentry = kzalloc(sizeof(struct dentry), 0);
392 dir = kzalloc(sizeof(struct inode), 0);
393 if (!file || !dentry || !dir) {
394 printf("%s: Error, no memory for malloc!\n", __func__);
400 file->f_path.dentry = dentry;
401 file->f_path.dentry->d_parent = dentry;
402 file->f_path.dentry->d_inode = dir;
403 file->f_path.dentry->d_inode->i_ino = root_inum;
406 dbg_gen("dir ino %lu, f_pos %#llx", dir->i_ino, file->f_pos);
408 /* Find the first entry in TNC and save it */
409 lowest_dent_key(c, &key, dir->i_ino);
411 dent = ubifs_tnc_next_ent(c, &key, &nm);
417 file->f_pos = key_hash_flash(c, &dent->key);
418 file->private_data = dent;
421 dbg_gen("feed '%s', ino %llu, new f_pos %#x",
422 dent->name, (unsigned long long)le64_to_cpu(dent->inum),
423 key_hash_flash(c, &dent->key));
425 ubifs_assert(le64_to_cpu(dent->ch.sqnum) > ubifs_inode(dir)->creat_sqnum);
428 nm.len = le16_to_cpu(dent->nlen);
429 if ((strncmp(dirname, (char *)dent->name, nm.len) == 0) &&
430 (strlen(dirname) == nm.len)) {
431 *inum = le64_to_cpu(dent->inum);
436 /* Switch to the next entry */
437 key_read(c, &dent->key, &key);
438 nm.name = (char *)dent->name;
439 dent = ubifs_tnc_next_ent(c, &key, &nm);
445 kfree(file->private_data);
446 file->f_pos = key_hash_flash(c, &dent->key);
447 file->private_data = dent;
453 dbg_gen("cannot find next direntry, error %d", err);
456 kfree(file->private_data);
464 static unsigned long ubifs_findfile(struct super_block *sb, char *filename)
469 char symlinkpath[128];
471 unsigned long root_inum = 1;
473 int symlink_count = 0; /* Don't allow symlink recursion */
476 strcpy(fpath, filename);
478 /* Remove all leading slashes */
483 * Handle root-direcoty ('/')
486 if (!name || *name == '\0')
491 struct ubifs_inode *ui;
493 /* Extract the actual part from the pathname. */
494 next = strchr(name, '/');
496 /* Remove all leading slashes. */
501 ret = ubifs_finddir(sb, name, root_inum, &inum);
504 inode = ubifs_iget(sb, inum);
508 ui = ubifs_inode(inode);
510 if ((inode->i_mode & S_IFMT) == S_IFLNK) {
513 /* We have some sort of symlink recursion, bail out */
514 if (symlink_count++ > 8) {
515 printf("Symlink recursion, aborting\n");
518 memcpy(link_name, ui->data, ui->data_len);
519 link_name[ui->data_len] = '\0';
521 if (link_name[0] == '/') {
522 /* Absolute path, redo everything without
523 * the leading slash */
524 next = name = link_name + 1;
528 /* Relative to cur dir */
529 sprintf(buf, "%s/%s",
530 link_name, next == NULL ? "" : next);
531 memcpy(symlinkpath, buf, sizeof(buf));
532 next = name = symlinkpath;
537 * Check if directory with this name exists
540 /* Found the node! */
541 if (!next || *next == '\0')
551 int ubifs_set_blk_dev(struct blk_desc *rbdd, disk_partition_t *info)
554 debug("UBIFS cannot be used with normal block devices\n");
559 * Should never happen since blk_get_device_part_str() already checks
560 * this, but better safe then sorry.
562 if (!ubifs_is_mounted()) {
563 debug("UBIFS not mounted, use ubifsmount to mount volume first!\n");
570 int ubifs_ls(const char *filename)
572 struct ubifs_info *c = ubifs_sb->s_fs_info;
574 struct dentry *dentry;
580 c->ubi = ubi_open_volume(c->vi.ubi_num, c->vi.vol_id, UBI_READONLY);
581 inum = ubifs_findfile(ubifs_sb, (char *)filename);
587 file = kzalloc(sizeof(struct file), 0);
588 dentry = kzalloc(sizeof(struct dentry), 0);
589 dir = kzalloc(sizeof(struct inode), 0);
590 if (!file || !dentry || !dir) {
591 printf("%s: Error, no memory for malloc!\n", __func__);
596 dir->i_sb = ubifs_sb;
597 file->f_path.dentry = dentry;
598 file->f_path.dentry->d_parent = dentry;
599 file->f_path.dentry->d_inode = dir;
600 file->f_path.dentry->d_inode->i_ino = inum;
602 file->private_data = NULL;
603 ubifs_printdir(file, dirent);
614 ubi_close_volume(c->ubi);
618 int ubifs_exists(const char *filename)
620 struct ubifs_info *c = ubifs_sb->s_fs_info;
623 c->ubi = ubi_open_volume(c->vi.ubi_num, c->vi.vol_id, UBI_READONLY);
624 inum = ubifs_findfile(ubifs_sb, (char *)filename);
625 ubi_close_volume(c->ubi);
630 int ubifs_size(const char *filename, loff_t *size)
632 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);
639 inum = ubifs_findfile(ubifs_sb, (char *)filename);
645 inode = ubifs_iget(ubifs_sb, inum);
647 printf("%s: Error reading inode %ld!\n", __func__, inum);
648 err = PTR_ERR(inode);
652 *size = inode->i_size;
656 ubi_close_volume(c->ubi);
666 static inline void *kmap(struct page *page)
671 static int read_block(struct inode *inode, void *addr, unsigned int block,
672 struct ubifs_data_node *dn)
674 struct ubifs_info *c = inode->i_sb->s_fs_info;
675 int err, len, out_len;
679 data_key_init(c, &key, inode->i_ino, block);
680 err = ubifs_tnc_lookup(c, &key, dn);
683 /* Not found, so it must be a hole */
684 memset(addr, 0, UBIFS_BLOCK_SIZE);
688 ubifs_assert(le64_to_cpu(dn->ch.sqnum) > ubifs_inode(inode)->creat_sqnum);
690 len = le32_to_cpu(dn->size);
691 if (len <= 0 || len > UBIFS_BLOCK_SIZE)
694 dlen = le32_to_cpu(dn->ch.len) - UBIFS_DATA_NODE_SZ;
695 out_len = UBIFS_BLOCK_SIZE;
696 err = ubifs_decompress(c, &dn->data, dlen, addr, &out_len,
697 le16_to_cpu(dn->compr_type));
698 if (err || len != out_len)
702 * Data length can be less than a full block, even for blocks that are
703 * not the last in the file (e.g., as a result of making a hole and
704 * appending data). Ensure that the remainder is zeroed out.
706 if (len < UBIFS_BLOCK_SIZE)
707 memset(addr + len, 0, UBIFS_BLOCK_SIZE - len);
712 ubifs_err(c, "bad data node (block %u, inode %lu)",
713 block, inode->i_ino);
714 ubifs_dump_node(c, dn);
718 static int do_readpage(struct ubifs_info *c, struct inode *inode,
719 struct page *page, int last_block_size)
723 unsigned int block, beyond;
724 struct ubifs_data_node *dn;
725 loff_t i_size = inode->i_size;
727 dbg_gen("ino %lu, pg %lu, i_size %lld",
728 inode->i_ino, page->index, i_size);
732 block = page->index << UBIFS_BLOCKS_PER_PAGE_SHIFT;
733 beyond = (i_size + UBIFS_BLOCK_SIZE - 1) >> UBIFS_BLOCK_SHIFT;
734 if (block >= beyond) {
735 /* Reading beyond inode */
736 memset(addr, 0, PAGE_CACHE_SIZE);
740 dn = kmalloc(UBIFS_MAX_DATA_NODE_SZ, GFP_NOFS);
748 if (block >= beyond) {
749 /* Reading beyond inode */
751 memset(addr, 0, UBIFS_BLOCK_SIZE);
754 * Reading last block? Make sure to not write beyond
755 * the requested size in the destination buffer.
757 if (((block + 1) == beyond) || last_block_size) {
762 * We need to buffer the data locally for the
763 * last block. This is to not pad the
764 * destination area to a multiple of
767 buff = malloc_cache_aligned(UBIFS_BLOCK_SIZE);
769 printf("%s: Error, malloc fails!\n",
775 /* Read block-size into temp buffer */
776 ret = read_block(inode, buff, block, dn);
779 if (err != -ENOENT) {
786 dlen = last_block_size;
788 dlen = le32_to_cpu(dn->size);
790 /* Now copy required size back to dest */
791 memcpy(addr, buff, dlen);
795 ret = read_block(inode, addr, block, dn);
803 if (++i >= UBIFS_BLOCKS_PER_PAGE)
806 addr += UBIFS_BLOCK_SIZE;
809 if (err == -ENOENT) {
810 /* Not found, so it must be a hole */
814 ubifs_err(c, "cannot read page %lu of inode %lu, error %d",
815 page->index, inode->i_ino, err);
829 int ubifs_read(const char *filename, void *buf, loff_t offset,
830 loff_t size, loff_t *actread)
832 struct ubifs_info *c = ubifs_sb->s_fs_info;
839 int last_block_size = 0;
843 if (offset & (PAGE_SIZE - 1)) {
844 printf("ubifs: Error offset must be a multiple of %d\n",
849 c->ubi = ubi_open_volume(c->vi.ubi_num, c->vi.vol_id, UBI_READONLY);
850 /* ubifs_findfile will resolve symlinks, so we know that we get
851 * the real file here */
852 inum = ubifs_findfile(ubifs_sb, (char *)filename);
861 inode = ubifs_iget(ubifs_sb, inum);
863 printf("%s: Error reading inode %ld!\n", __func__, inum);
864 err = PTR_ERR(inode);
868 if (offset > inode->i_size) {
869 printf("ubifs: Error offset (%lld) > file-size (%lld)\n",
876 * If no size was specified or if size bigger than filesize
877 * set size to filesize
879 if ((size == 0) || (size > (inode->i_size - offset)))
880 size = inode->i_size - offset;
882 count = (size + UBIFS_BLOCK_SIZE - 1) >> UBIFS_BLOCK_SHIFT;
885 page.index = offset / PAGE_SIZE;
887 for (i = 0; i < count; i++) {
889 * Make sure to not read beyond the requested size
891 if (((i + 1) == count) && (size < inode->i_size))
892 last_block_size = size - (i * PAGE_SIZE);
894 err = do_readpage(c, inode, &page, last_block_size);
898 page.addr += PAGE_SIZE;
903 printf("Error reading file '%s'\n", filename);
904 *actread = i * PAGE_SIZE;
913 ubi_close_volume(c->ubi);
917 void ubifs_close(void)
921 /* Compat wrappers for common/cmd_ubifs.c */
922 int ubifs_load(char *filename, u32 addr, u32 size)
927 printf("Loading file '%s' to addr 0x%08x...\n", filename, addr);
929 err = ubifs_read(filename, (void *)(uintptr_t)addr, 0, size, &actread);
931 env_set_hex("filesize", actread);
938 void uboot_ubifs_umount(void)
941 printf("Unmounting UBIFS volume %s!\n",
942 ((struct ubifs_info *)(ubifs_sb->s_fs_info))->vi.name);
943 ubifs_umount(ubifs_sb->s_fs_info);