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 <u-boot/zlib.h>
21 #include <linux/compat.h>
22 #include <linux/err.h>
23 #include <linux/lzo.h>
25 DECLARE_GLOBAL_DATA_PTR;
30 * We need a wrapper for zunzip() because the parameters are
31 * incompatible with the lzo decompressor.
33 static int gzip_decompress(const unsigned char *in, size_t in_len,
34 unsigned char *out, size_t *out_len)
36 return zunzip(out, *out_len, (unsigned char *)in,
37 (unsigned long *)out_len, 0, 0);
40 /* Fake description object for the "none" compressor */
41 static struct ubifs_compressor none_compr = {
42 .compr_type = UBIFS_COMPR_NONE,
48 static struct ubifs_compressor lzo_compr = {
49 .compr_type = UBIFS_COMPR_LZO,
51 .comp_mutex = &lzo_mutex,
55 .decompress = lzo1x_decompress_safe,
58 static struct ubifs_compressor zlib_compr = {
59 .compr_type = UBIFS_COMPR_ZLIB,
61 .comp_mutex = &deflate_mutex,
62 .decomp_mutex = &inflate_mutex,
65 .capi_name = "deflate",
66 .decompress = gzip_decompress,
69 /* All UBIFS compressors */
70 struct ubifs_compressor *ubifs_compressors[UBIFS_COMPR_TYPES_CNT];
79 static inline struct crypto_comp
80 *crypto_alloc_comp(const char *alg_name, u32 type, u32 mask)
82 struct ubifs_compressor *comp;
83 struct crypto_comp *ptr;
86 ptr = malloc_cache_aligned(sizeof(struct crypto_comp));
87 while (i < UBIFS_COMPR_TYPES_CNT) {
88 comp = ubifs_compressors[i];
93 if (strncmp(alg_name, comp->capi_name, strlen(alg_name)) == 0) {
99 if (i >= UBIFS_COMPR_TYPES_CNT) {
100 dbg_gen("invalid compression type %s", alg_name);
107 crypto_comp_decompress(const struct ubifs_info *c, struct crypto_comp *tfm,
108 const u8 *src, unsigned int slen, u8 *dst,
111 struct ubifs_compressor *compr = ubifs_compressors[tfm->compressor];
113 size_t tmp_len = *dlen;
115 if (compr->compr_type == UBIFS_COMPR_NONE) {
116 memcpy(dst, src, slen);
121 err = compr->decompress(src, slen, dst, &tmp_len);
123 ubifs_err(c, "cannot decompress %d bytes, compressor %s, "
124 "error %d", slen, compr->name, err);
132 /* from shrinker.c */
134 /* Global clean znode counter (for all mounted UBIFS instances) */
135 atomic_long_t ubifs_clean_zn_cnt;
140 * ubifs_decompress - decompress data.
141 * @in_buf: data to decompress
142 * @in_len: length of the data to decompress
143 * @out_buf: output buffer where decompressed data should
144 * @out_len: output length is returned here
145 * @compr_type: type of compression
147 * This function decompresses data from buffer @in_buf into buffer @out_buf.
148 * The length of the uncompressed data is returned in @out_len. This functions
149 * returns %0 on success or a negative error code on failure.
151 int ubifs_decompress(const struct ubifs_info *c, const void *in_buf,
152 int in_len, void *out_buf, int *out_len, int compr_type)
155 struct ubifs_compressor *compr;
157 if (unlikely(compr_type < 0 || compr_type >= UBIFS_COMPR_TYPES_CNT)) {
158 ubifs_err(c, "invalid compression type %d", compr_type);
162 compr = ubifs_compressors[compr_type];
164 if (unlikely(!compr->capi_name)) {
165 ubifs_err(c, "%s compression is not compiled in", compr->name);
169 if (compr_type == UBIFS_COMPR_NONE) {
170 memcpy(out_buf, in_buf, in_len);
175 if (compr->decomp_mutex)
176 mutex_lock(compr->decomp_mutex);
177 err = crypto_comp_decompress(c, compr->cc, in_buf, in_len, out_buf,
178 (unsigned int *)out_len);
179 if (compr->decomp_mutex)
180 mutex_unlock(compr->decomp_mutex);
182 ubifs_err(c, "cannot decompress %d bytes, compressor %s,"
183 " error %d", in_len, compr->name, err);
189 * compr_init - initialize a compressor.
190 * @compr: compressor description object
192 * This function initializes the requested compressor and returns zero in case
193 * of success or a negative error code in case of failure.
195 static int __init compr_init(struct ubifs_compressor *compr)
197 ubifs_compressors[compr->compr_type] = compr;
199 #ifdef CONFIG_NEEDS_MANUAL_RELOC
200 ubifs_compressors[compr->compr_type]->name += gd->reloc_off;
201 ubifs_compressors[compr->compr_type]->capi_name += gd->reloc_off;
202 ubifs_compressors[compr->compr_type]->decompress += gd->reloc_off;
205 if (compr->capi_name) {
206 compr->cc = crypto_alloc_comp(compr->capi_name, 0, 0);
207 if (IS_ERR(compr->cc)) {
208 dbg_gen("cannot initialize compressor %s,"
209 " error %ld", compr->name,
211 return PTR_ERR(compr->cc);
219 * ubifs_compressors_init - initialize UBIFS compressors.
221 * This function initializes the compressor which were compiled in. Returns
222 * zero in case of success and a negative error code in case of failure.
224 int __init ubifs_compressors_init(void)
228 err = compr_init(&lzo_compr);
232 err = compr_init(&zlib_compr);
236 err = compr_init(&none_compr);
247 static int filldir(struct ubifs_info *c, const char *name, int namlen,
248 u64 ino, unsigned int d_type)
254 case UBIFS_ITYPE_REG:
257 case UBIFS_ITYPE_DIR:
260 case UBIFS_ITYPE_LNK:
268 inode = ubifs_iget(c->vfs_sb, ino);
270 printf("%s: Error in ubifs_iget(), ino=%lld ret=%p!\n",
271 __func__, ino, inode);
274 ctime_r((time_t *)&inode->i_mtime, filetime);
275 printf("%9lld %24.24s ", inode->i_size, filetime);
280 printf("%s\n", name);
285 static int ubifs_printdir(struct file *file, void *dirent)
290 struct ubifs_dent_node *dent;
291 struct inode *dir = file->f_path.dentry->d_inode;
292 struct ubifs_info *c = dir->i_sb->s_fs_info;
294 dbg_gen("dir ino %lu, f_pos %#llx", dir->i_ino, file->f_pos);
296 if (file->f_pos > UBIFS_S_KEY_HASH_MASK || file->f_pos == 2)
298 * The directory was seek'ed to a senseless position or there
299 * are no more entries.
303 if (file->f_pos == 1) {
304 /* Find the first entry in TNC and save it */
305 lowest_dent_key(c, &key, dir->i_ino);
307 dent = ubifs_tnc_next_ent(c, &key, &nm);
313 file->f_pos = key_hash_flash(c, &dent->key);
314 file->private_data = dent;
317 dent = file->private_data;
320 * The directory was seek'ed to and is now readdir'ed.
321 * Find the entry corresponding to @file->f_pos or the
324 dent_key_init_hash(c, &key, dir->i_ino, file->f_pos);
326 dent = ubifs_tnc_next_ent(c, &key, &nm);
331 file->f_pos = key_hash_flash(c, &dent->key);
332 file->private_data = dent;
336 dbg_gen("feed '%s', ino %llu, new f_pos %#x",
337 dent->name, (unsigned long long)le64_to_cpu(dent->inum),
338 key_hash_flash(c, &dent->key));
340 ubifs_assert(le64_to_cpu(dent->ch.sqnum) > ubifs_inode(dir)->creat_sqnum);
343 nm.len = le16_to_cpu(dent->nlen);
344 over = filldir(c, (char *)dent->name, nm.len,
345 le64_to_cpu(dent->inum), dent->type);
349 /* Switch to the next entry */
350 key_read(c, &dent->key, &key);
351 nm.name = (char *)dent->name;
352 dent = ubifs_tnc_next_ent(c, &key, &nm);
358 kfree(file->private_data);
359 file->f_pos = key_hash_flash(c, &dent->key);
360 file->private_data = dent;
365 if (err != -ENOENT) {
366 ubifs_err(c, "cannot find next direntry, error %d", err);
370 kfree(file->private_data);
371 file->private_data = NULL;
376 static int ubifs_finddir(struct super_block *sb, char *dirname,
377 unsigned long root_inum, unsigned long *inum)
382 struct ubifs_dent_node *dent;
383 struct ubifs_info *c;
385 struct dentry *dentry;
389 file = kzalloc(sizeof(struct file), 0);
390 dentry = kzalloc(sizeof(struct dentry), 0);
391 dir = kzalloc(sizeof(struct inode), 0);
392 if (!file || !dentry || !dir) {
393 printf("%s: Error, no memory for malloc!\n", __func__);
399 file->f_path.dentry = dentry;
400 file->f_path.dentry->d_parent = dentry;
401 file->f_path.dentry->d_inode = dir;
402 file->f_path.dentry->d_inode->i_ino = root_inum;
405 dbg_gen("dir ino %lu, f_pos %#llx", dir->i_ino, file->f_pos);
407 /* Find the first entry in TNC and save it */
408 lowest_dent_key(c, &key, dir->i_ino);
410 dent = ubifs_tnc_next_ent(c, &key, &nm);
416 file->f_pos = key_hash_flash(c, &dent->key);
417 file->private_data = dent;
420 dbg_gen("feed '%s', ino %llu, new f_pos %#x",
421 dent->name, (unsigned long long)le64_to_cpu(dent->inum),
422 key_hash_flash(c, &dent->key));
424 ubifs_assert(le64_to_cpu(dent->ch.sqnum) > ubifs_inode(dir)->creat_sqnum);
427 nm.len = le16_to_cpu(dent->nlen);
428 if ((strncmp(dirname, (char *)dent->name, nm.len) == 0) &&
429 (strlen(dirname) == nm.len)) {
430 *inum = le64_to_cpu(dent->inum);
435 /* Switch to the next entry */
436 key_read(c, &dent->key, &key);
437 nm.name = (char *)dent->name;
438 dent = ubifs_tnc_next_ent(c, &key, &nm);
444 kfree(file->private_data);
445 file->f_pos = key_hash_flash(c, &dent->key);
446 file->private_data = dent;
452 dbg_gen("cannot find next direntry, error %d", err);
455 kfree(file->private_data);
463 static unsigned long ubifs_findfile(struct super_block *sb, char *filename)
468 char symlinkpath[128];
470 unsigned long root_inum = 1;
472 int symlink_count = 0; /* Don't allow symlink recursion */
475 strcpy(fpath, filename);
477 /* Remove all leading slashes */
482 * Handle root-direcoty ('/')
485 if (!name || *name == '\0')
490 struct ubifs_inode *ui;
492 /* Extract the actual part from the pathname. */
493 next = strchr(name, '/');
495 /* Remove all leading slashes. */
500 ret = ubifs_finddir(sb, name, root_inum, &inum);
503 inode = ubifs_iget(sb, inum);
507 ui = ubifs_inode(inode);
509 if ((inode->i_mode & S_IFMT) == S_IFLNK) {
512 /* We have some sort of symlink recursion, bail out */
513 if (symlink_count++ > 8) {
514 printf("Symlink recursion, aborting\n");
517 memcpy(link_name, ui->data, ui->data_len);
518 link_name[ui->data_len] = '\0';
520 if (link_name[0] == '/') {
521 /* Absolute path, redo everything without
522 * the leading slash */
523 next = name = link_name + 1;
527 /* Relative to cur dir */
528 sprintf(buf, "%s/%s",
529 link_name, next == NULL ? "" : next);
530 memcpy(symlinkpath, buf, sizeof(buf));
531 next = name = symlinkpath;
536 * Check if directory with this name exists
539 /* Found the node! */
540 if (!next || *next == '\0')
550 int ubifs_set_blk_dev(struct blk_desc *rbdd, disk_partition_t *info)
553 debug("UBIFS cannot be used with normal block devices\n");
558 * Should never happen since blk_get_device_part_str() already checks
559 * this, but better safe then sorry.
561 if (!ubifs_is_mounted()) {
562 debug("UBIFS not mounted, use ubifsmount to mount volume first!\n");
569 int ubifs_ls(const char *filename)
571 struct ubifs_info *c = ubifs_sb->s_fs_info;
573 struct dentry *dentry;
579 c->ubi = ubi_open_volume(c->vi.ubi_num, c->vi.vol_id, UBI_READONLY);
580 inum = ubifs_findfile(ubifs_sb, (char *)filename);
586 file = kzalloc(sizeof(struct file), 0);
587 dentry = kzalloc(sizeof(struct dentry), 0);
588 dir = kzalloc(sizeof(struct inode), 0);
589 if (!file || !dentry || !dir) {
590 printf("%s: Error, no memory for malloc!\n", __func__);
595 dir->i_sb = ubifs_sb;
596 file->f_path.dentry = dentry;
597 file->f_path.dentry->d_parent = dentry;
598 file->f_path.dentry->d_inode = dir;
599 file->f_path.dentry->d_inode->i_ino = inum;
601 file->private_data = NULL;
602 ubifs_printdir(file, dirent);
613 ubi_close_volume(c->ubi);
617 int ubifs_exists(const char *filename)
619 struct ubifs_info *c = ubifs_sb->s_fs_info;
622 c->ubi = ubi_open_volume(c->vi.ubi_num, c->vi.vol_id, UBI_READONLY);
623 inum = ubifs_findfile(ubifs_sb, (char *)filename);
624 ubi_close_volume(c->ubi);
629 int ubifs_size(const char *filename, loff_t *size)
631 struct ubifs_info *c = ubifs_sb->s_fs_info;
636 c->ubi = ubi_open_volume(c->vi.ubi_num, c->vi.vol_id, UBI_READONLY);
638 inum = ubifs_findfile(ubifs_sb, (char *)filename);
644 inode = ubifs_iget(ubifs_sb, inum);
646 printf("%s: Error reading inode %ld!\n", __func__, inum);
647 err = PTR_ERR(inode);
651 *size = inode->i_size;
655 ubi_close_volume(c->ubi);
665 static inline void *kmap(struct page *page)
670 static int read_block(struct inode *inode, void *addr, unsigned int block,
671 struct ubifs_data_node *dn)
673 struct ubifs_info *c = inode->i_sb->s_fs_info;
674 int err, len, out_len;
678 data_key_init(c, &key, inode->i_ino, block);
679 err = ubifs_tnc_lookup(c, &key, dn);
682 /* Not found, so it must be a hole */
683 memset(addr, 0, UBIFS_BLOCK_SIZE);
687 ubifs_assert(le64_to_cpu(dn->ch.sqnum) > ubifs_inode(inode)->creat_sqnum);
689 len = le32_to_cpu(dn->size);
690 if (len <= 0 || len > UBIFS_BLOCK_SIZE)
693 dlen = le32_to_cpu(dn->ch.len) - UBIFS_DATA_NODE_SZ;
694 out_len = UBIFS_BLOCK_SIZE;
695 err = ubifs_decompress(c, &dn->data, dlen, addr, &out_len,
696 le16_to_cpu(dn->compr_type));
697 if (err || len != out_len)
701 * Data length can be less than a full block, even for blocks that are
702 * not the last in the file (e.g., as a result of making a hole and
703 * appending data). Ensure that the remainder is zeroed out.
705 if (len < UBIFS_BLOCK_SIZE)
706 memset(addr + len, 0, UBIFS_BLOCK_SIZE - len);
711 ubifs_err(c, "bad data node (block %u, inode %lu)",
712 block, inode->i_ino);
713 ubifs_dump_node(c, dn);
717 static int do_readpage(struct ubifs_info *c, struct inode *inode,
718 struct page *page, int last_block_size)
722 unsigned int block, beyond;
723 struct ubifs_data_node *dn;
724 loff_t i_size = inode->i_size;
726 dbg_gen("ino %lu, pg %lu, i_size %lld",
727 inode->i_ino, page->index, i_size);
731 block = page->index << UBIFS_BLOCKS_PER_PAGE_SHIFT;
732 beyond = (i_size + UBIFS_BLOCK_SIZE - 1) >> UBIFS_BLOCK_SHIFT;
733 if (block >= beyond) {
734 /* Reading beyond inode */
735 memset(addr, 0, PAGE_CACHE_SIZE);
739 dn = kmalloc(UBIFS_MAX_DATA_NODE_SZ, GFP_NOFS);
747 if (block >= beyond) {
748 /* Reading beyond inode */
750 memset(addr, 0, UBIFS_BLOCK_SIZE);
753 * Reading last block? Make sure to not write beyond
754 * the requested size in the destination buffer.
756 if (((block + 1) == beyond) || last_block_size) {
761 * We need to buffer the data locally for the
762 * last block. This is to not pad the
763 * destination area to a multiple of
766 buff = malloc_cache_aligned(UBIFS_BLOCK_SIZE);
768 printf("%s: Error, malloc fails!\n",
774 /* Read block-size into temp buffer */
775 ret = read_block(inode, buff, block, dn);
778 if (err != -ENOENT) {
785 dlen = last_block_size;
787 dlen = le32_to_cpu(dn->size);
789 /* Now copy required size back to dest */
790 memcpy(addr, buff, dlen);
794 ret = read_block(inode, addr, block, dn);
802 if (++i >= UBIFS_BLOCKS_PER_PAGE)
805 addr += UBIFS_BLOCK_SIZE;
808 if (err == -ENOENT) {
809 /* Not found, so it must be a hole */
813 ubifs_err(c, "cannot read page %lu of inode %lu, error %d",
814 page->index, inode->i_ino, err);
828 int ubifs_read(const char *filename, void *buf, loff_t offset,
829 loff_t size, loff_t *actread)
831 struct ubifs_info *c = ubifs_sb->s_fs_info;
838 int last_block_size = 0;
842 if (offset & (PAGE_SIZE - 1)) {
843 printf("ubifs: Error offset must be a multiple of %d\n",
848 c->ubi = ubi_open_volume(c->vi.ubi_num, c->vi.vol_id, UBI_READONLY);
849 /* ubifs_findfile will resolve symlinks, so we know that we get
850 * the real file here */
851 inum = ubifs_findfile(ubifs_sb, (char *)filename);
860 inode = ubifs_iget(ubifs_sb, inum);
862 printf("%s: Error reading inode %ld!\n", __func__, inum);
863 err = PTR_ERR(inode);
867 if (offset > inode->i_size) {
868 printf("ubifs: Error offset (%lld) > file-size (%lld)\n",
875 * If no size was specified or if size bigger than filesize
876 * set size to filesize
878 if ((size == 0) || (size > (inode->i_size - offset)))
879 size = inode->i_size - offset;
881 count = (size + UBIFS_BLOCK_SIZE - 1) >> UBIFS_BLOCK_SHIFT;
884 page.index = offset / PAGE_SIZE;
886 for (i = 0; i < count; i++) {
888 * Make sure to not read beyond the requested size
890 if (((i + 1) == count) && (size < inode->i_size))
891 last_block_size = size - (i * PAGE_SIZE);
893 err = do_readpage(c, inode, &page, last_block_size);
897 page.addr += PAGE_SIZE;
902 printf("Error reading file '%s'\n", filename);
903 *actread = i * PAGE_SIZE;
912 ubi_close_volume(c->ubi);
916 void ubifs_close(void)
920 /* Compat wrappers for common/cmd_ubifs.c */
921 int ubifs_load(char *filename, u32 addr, u32 size)
926 printf("Loading file '%s' to addr 0x%08x...\n", filename, addr);
928 err = ubifs_read(filename, (void *)(uintptr_t)addr, 0, size, &actread);
930 env_set_hex("filesize", actread);
937 void uboot_ubifs_umount(void)
940 printf("Unmounting UBIFS volume %s!\n",
941 ((struct ubifs_info *)(ubifs_sb->s_fs_info))->vi.name);
942 ubifs_umount(ubifs_sb->s_fs_info);