2 * This file is part of UBIFS.
4 * Copyright (C) 2006-2008 Nokia Corporation.
6 * (C) Copyright 2008-2010
7 * Stefan Roese, DENX Software Engineering, sr@denx.de.
9 * This program is free software; you can redistribute it and/or modify it
10 * under the terms of the GNU General Public License version 2 as published by
11 * the Free Software Foundation.
13 * This program is distributed in the hope that it will be useful, but WITHOUT
14 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
15 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
18 * You should have received a copy of the GNU General Public License along with
19 * this program; if not, write to the Free Software Foundation, Inc., 51
20 * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
22 * Authors: Artem Bityutskiy (Битюцкий Артём)
29 #include <u-boot/zlib.h>
31 #include <linux/err.h>
32 #include <linux/lzo.h>
34 DECLARE_GLOBAL_DATA_PTR;
39 * We need a wrapper for zunzip() because the parameters are
40 * incompatible with the lzo decompressor.
42 static int gzip_decompress(const unsigned char *in, size_t in_len,
43 unsigned char *out, size_t *out_len)
45 return zunzip(out, *out_len, (unsigned char *)in,
46 (unsigned long *)out_len, 0, 0);
49 /* Fake description object for the "none" compressor */
50 static struct ubifs_compressor none_compr = {
51 .compr_type = UBIFS_COMPR_NONE,
57 static struct ubifs_compressor lzo_compr = {
58 .compr_type = UBIFS_COMPR_LZO,
60 .comp_mutex = &lzo_mutex,
64 .decompress = lzo1x_decompress_safe,
67 static struct ubifs_compressor zlib_compr = {
68 .compr_type = UBIFS_COMPR_ZLIB,
70 .comp_mutex = &deflate_mutex,
71 .decomp_mutex = &inflate_mutex,
74 .capi_name = "deflate",
75 .decompress = gzip_decompress,
78 /* All UBIFS compressors */
79 struct ubifs_compressor *ubifs_compressors[UBIFS_COMPR_TYPES_CNT];
86 * kmemdup - duplicate region of memory
88 * @src: memory region to duplicate
89 * @len: memory region length
90 * @gfp: GFP mask to use
92 void *kmemdup(const void *src, size_t len, gfp_t gfp)
96 p = kmalloc(len, gfp);
106 static inline struct crypto_comp
107 *crypto_alloc_comp(const char *alg_name, u32 type, u32 mask)
109 struct ubifs_compressor *comp;
110 struct crypto_comp *ptr;
113 ptr = malloc_cache_aligned(sizeof(struct crypto_comp));
114 while (i < UBIFS_COMPR_TYPES_CNT) {
115 comp = ubifs_compressors[i];
120 if (strncmp(alg_name, comp->capi_name, strlen(alg_name)) == 0) {
126 if (i >= UBIFS_COMPR_TYPES_CNT) {
127 dbg_gen("invalid compression type %s", alg_name);
134 crypto_comp_decompress(const struct ubifs_info *c, struct crypto_comp *tfm,
135 const u8 *src, unsigned int slen, u8 *dst,
138 struct ubifs_compressor *compr = ubifs_compressors[tfm->compressor];
141 if (compr->compr_type == UBIFS_COMPR_NONE) {
142 memcpy(dst, src, slen);
147 err = compr->decompress(src, slen, dst, (size_t *)dlen);
149 ubifs_err(c, "cannot decompress %d bytes, compressor %s, "
150 "error %d", slen, compr->name, err);
157 /* from shrinker.c */
159 /* Global clean znode counter (for all mounted UBIFS instances) */
160 atomic_long_t ubifs_clean_zn_cnt;
165 * ubifs_decompress - decompress data.
166 * @in_buf: data to decompress
167 * @in_len: length of the data to decompress
168 * @out_buf: output buffer where decompressed data should
169 * @out_len: output length is returned here
170 * @compr_type: type of compression
172 * This function decompresses data from buffer @in_buf into buffer @out_buf.
173 * The length of the uncompressed data is returned in @out_len. This functions
174 * returns %0 on success or a negative error code on failure.
176 int ubifs_decompress(const struct ubifs_info *c, const void *in_buf,
177 int in_len, void *out_buf, int *out_len, int compr_type)
180 struct ubifs_compressor *compr;
182 if (unlikely(compr_type < 0 || compr_type >= UBIFS_COMPR_TYPES_CNT)) {
183 ubifs_err(c, "invalid compression type %d", compr_type);
187 compr = ubifs_compressors[compr_type];
189 if (unlikely(!compr->capi_name)) {
190 ubifs_err(c, "%s compression is not compiled in", compr->name);
194 if (compr_type == UBIFS_COMPR_NONE) {
195 memcpy(out_buf, in_buf, in_len);
200 if (compr->decomp_mutex)
201 mutex_lock(compr->decomp_mutex);
202 err = crypto_comp_decompress(c, compr->cc, in_buf, in_len, out_buf,
203 (unsigned int *)out_len);
204 if (compr->decomp_mutex)
205 mutex_unlock(compr->decomp_mutex);
207 ubifs_err(c, "cannot decompress %d bytes, compressor %s,"
208 " error %d", in_len, compr->name, err);
214 * compr_init - initialize a compressor.
215 * @compr: compressor description object
217 * This function initializes the requested compressor and returns zero in case
218 * of success or a negative error code in case of failure.
220 static int __init compr_init(struct ubifs_compressor *compr)
222 ubifs_compressors[compr->compr_type] = compr;
224 #ifdef CONFIG_NEEDS_MANUAL_RELOC
225 ubifs_compressors[compr->compr_type]->name += gd->reloc_off;
226 ubifs_compressors[compr->compr_type]->capi_name += gd->reloc_off;
227 ubifs_compressors[compr->compr_type]->decompress += gd->reloc_off;
230 if (compr->capi_name) {
231 compr->cc = crypto_alloc_comp(compr->capi_name, 0, 0);
232 if (IS_ERR(compr->cc)) {
233 dbg_gen("cannot initialize compressor %s,"
234 " error %ld", compr->name,
236 return PTR_ERR(compr->cc);
244 * ubifs_compressors_init - initialize UBIFS compressors.
246 * This function initializes the compressor which were compiled in. Returns
247 * zero in case of success and a negative error code in case of failure.
249 int __init ubifs_compressors_init(void)
253 err = compr_init(&lzo_compr);
257 err = compr_init(&zlib_compr);
261 err = compr_init(&none_compr);
272 static int filldir(struct ubifs_info *c, const char *name, int namlen,
273 u64 ino, unsigned int d_type)
279 case UBIFS_ITYPE_REG:
282 case UBIFS_ITYPE_DIR:
285 case UBIFS_ITYPE_LNK:
293 inode = ubifs_iget(c->vfs_sb, ino);
295 printf("%s: Error in ubifs_iget(), ino=%lld ret=%p!\n",
296 __func__, ino, inode);
299 ctime_r((time_t *)&inode->i_mtime, filetime);
300 printf("%9lld %24.24s ", inode->i_size, filetime);
305 printf("%s\n", name);
310 static int ubifs_printdir(struct file *file, void *dirent)
315 struct ubifs_dent_node *dent;
316 struct inode *dir = file->f_path.dentry->d_inode;
317 struct ubifs_info *c = dir->i_sb->s_fs_info;
319 dbg_gen("dir ino %lu, f_pos %#llx", dir->i_ino, file->f_pos);
321 if (file->f_pos > UBIFS_S_KEY_HASH_MASK || file->f_pos == 2)
323 * The directory was seek'ed to a senseless position or there
324 * are no more entries.
328 if (file->f_pos == 1) {
329 /* Find the first entry in TNC and save it */
330 lowest_dent_key(c, &key, dir->i_ino);
332 dent = ubifs_tnc_next_ent(c, &key, &nm);
338 file->f_pos = key_hash_flash(c, &dent->key);
339 file->private_data = dent;
342 dent = file->private_data;
345 * The directory was seek'ed to and is now readdir'ed.
346 * Find the entry corresponding to @file->f_pos or the
349 dent_key_init_hash(c, &key, dir->i_ino, file->f_pos);
351 dent = ubifs_tnc_next_ent(c, &key, &nm);
356 file->f_pos = key_hash_flash(c, &dent->key);
357 file->private_data = dent;
361 dbg_gen("feed '%s', ino %llu, new f_pos %#x",
362 dent->name, (unsigned long long)le64_to_cpu(dent->inum),
363 key_hash_flash(c, &dent->key));
364 ubifs_assert(le64_to_cpu(dent->ch.sqnum) > ubifs_inode(dir)->creat_sqnum);
366 nm.len = le16_to_cpu(dent->nlen);
367 over = filldir(c, (char *)dent->name, nm.len,
368 le64_to_cpu(dent->inum), dent->type);
372 /* Switch to the next entry */
373 key_read(c, &dent->key, &key);
374 nm.name = (char *)dent->name;
375 dent = ubifs_tnc_next_ent(c, &key, &nm);
381 kfree(file->private_data);
382 file->f_pos = key_hash_flash(c, &dent->key);
383 file->private_data = dent;
388 if (err != -ENOENT) {
389 ubifs_err(c, "cannot find next direntry, error %d", err);
393 kfree(file->private_data);
394 file->private_data = NULL;
399 static int ubifs_finddir(struct super_block *sb, char *dirname,
400 unsigned long root_inum, unsigned long *inum)
405 struct ubifs_dent_node *dent;
406 struct ubifs_info *c;
408 struct dentry *dentry;
412 file = kzalloc(sizeof(struct file), 0);
413 dentry = kzalloc(sizeof(struct dentry), 0);
414 dir = kzalloc(sizeof(struct inode), 0);
415 if (!file || !dentry || !dir) {
416 printf("%s: Error, no memory for malloc!\n", __func__);
422 file->f_path.dentry = dentry;
423 file->f_path.dentry->d_parent = dentry;
424 file->f_path.dentry->d_inode = dir;
425 file->f_path.dentry->d_inode->i_ino = root_inum;
428 dbg_gen("dir ino %lu, f_pos %#llx", dir->i_ino, file->f_pos);
430 /* Find the first entry in TNC and save it */
431 lowest_dent_key(c, &key, dir->i_ino);
433 dent = ubifs_tnc_next_ent(c, &key, &nm);
439 file->f_pos = key_hash_flash(c, &dent->key);
440 file->private_data = dent;
443 dbg_gen("feed '%s', ino %llu, new f_pos %#x",
444 dent->name, (unsigned long long)le64_to_cpu(dent->inum),
445 key_hash_flash(c, &dent->key));
446 ubifs_assert(le64_to_cpu(dent->ch.sqnum) > ubifs_inode(dir)->creat_sqnum);
448 nm.len = le16_to_cpu(dent->nlen);
449 if ((strncmp(dirname, (char *)dent->name, nm.len) == 0) &&
450 (strlen(dirname) == nm.len)) {
451 *inum = le64_to_cpu(dent->inum);
456 /* Switch to the next entry */
457 key_read(c, &dent->key, &key);
458 nm.name = (char *)dent->name;
459 dent = ubifs_tnc_next_ent(c, &key, &nm);
465 kfree(file->private_data);
466 file->f_pos = key_hash_flash(c, &dent->key);
467 file->private_data = dent;
473 dbg_gen("cannot find next direntry, error %d", err);
476 if (file->private_data)
477 kfree(file->private_data);
488 static unsigned long ubifs_findfile(struct super_block *sb, char *filename)
493 char symlinkpath[128];
495 unsigned long root_inum = 1;
497 int symlink_count = 0; /* Don't allow symlink recursion */
500 strcpy(fpath, filename);
502 /* Remove all leading slashes */
507 * Handle root-direcoty ('/')
510 if (!name || *name == '\0')
515 struct ubifs_inode *ui;
517 /* Extract the actual part from the pathname. */
518 next = strchr(name, '/');
520 /* Remove all leading slashes. */
525 ret = ubifs_finddir(sb, name, root_inum, &inum);
528 inode = ubifs_iget(sb, inum);
532 ui = ubifs_inode(inode);
534 if ((inode->i_mode & S_IFMT) == S_IFLNK) {
537 /* We have some sort of symlink recursion, bail out */
538 if (symlink_count++ > 8) {
539 printf("Symlink recursion, aborting\n");
542 memcpy(link_name, ui->data, ui->data_len);
543 link_name[ui->data_len] = '\0';
545 if (link_name[0] == '/') {
546 /* Absolute path, redo everything without
547 * the leading slash */
548 next = name = link_name + 1;
552 /* Relative to cur dir */
553 sprintf(buf, "%s/%s",
554 link_name, next == NULL ? "" : next);
555 memcpy(symlinkpath, buf, sizeof(buf));
556 next = name = symlinkpath;
561 * Check if directory with this name exists
564 /* Found the node! */
565 if (!next || *next == '\0')
575 int ubifs_set_blk_dev(block_dev_desc_t *rbdd, disk_partition_t *info)
578 debug("UBIFS cannot be used with normal block devices\n");
583 * Should never happen since get_device_and_partition() already checks
584 * this, but better safe then sorry.
586 if (!ubifs_is_mounted()) {
587 debug("UBIFS not mounted, use ubifsmount to mount volume first!\n");
594 int ubifs_ls(const char *filename)
596 struct ubifs_info *c = ubifs_sb->s_fs_info;
598 struct dentry *dentry;
604 c->ubi = ubi_open_volume(c->vi.ubi_num, c->vi.vol_id, UBI_READONLY);
605 inum = ubifs_findfile(ubifs_sb, (char *)filename);
611 file = kzalloc(sizeof(struct file), 0);
612 dentry = kzalloc(sizeof(struct dentry), 0);
613 dir = kzalloc(sizeof(struct inode), 0);
614 if (!file || !dentry || !dir) {
615 printf("%s: Error, no memory for malloc!\n", __func__);
620 dir->i_sb = ubifs_sb;
621 file->f_path.dentry = dentry;
622 file->f_path.dentry->d_parent = dentry;
623 file->f_path.dentry->d_inode = dir;
624 file->f_path.dentry->d_inode->i_ino = inum;
626 file->private_data = NULL;
627 ubifs_printdir(file, dirent);
638 ubi_close_volume(c->ubi);
642 int ubifs_exists(const char *filename)
644 struct ubifs_info *c = ubifs_sb->s_fs_info;
647 c->ubi = ubi_open_volume(c->vi.ubi_num, c->vi.vol_id, UBI_READONLY);
648 inum = ubifs_findfile(ubifs_sb, (char *)filename);
649 ubi_close_volume(c->ubi);
654 int ubifs_size(const char *filename, loff_t *size)
656 struct ubifs_info *c = ubifs_sb->s_fs_info;
661 c->ubi = ubi_open_volume(c->vi.ubi_num, c->vi.vol_id, UBI_READONLY);
663 inum = ubifs_findfile(ubifs_sb, (char *)filename);
669 inode = ubifs_iget(ubifs_sb, inum);
671 printf("%s: Error reading inode %ld!\n", __func__, inum);
672 err = PTR_ERR(inode);
676 *size = inode->i_size;
680 ubi_close_volume(c->ubi);
690 static inline void *kmap(struct page *page)
695 static int read_block(struct inode *inode, void *addr, unsigned int block,
696 struct ubifs_data_node *dn)
698 struct ubifs_info *c = inode->i_sb->s_fs_info;
699 int err, len, out_len;
703 data_key_init(c, &key, inode->i_ino, block);
704 err = ubifs_tnc_lookup(c, &key, dn);
707 /* Not found, so it must be a hole */
708 memset(addr, 0, UBIFS_BLOCK_SIZE);
712 ubifs_assert(le64_to_cpu(dn->ch.sqnum) > ubifs_inode(inode)->creat_sqnum);
714 len = le32_to_cpu(dn->size);
715 if (len <= 0 || len > UBIFS_BLOCK_SIZE)
718 dlen = le32_to_cpu(dn->ch.len) - UBIFS_DATA_NODE_SZ;
719 out_len = UBIFS_BLOCK_SIZE;
720 err = ubifs_decompress(c, &dn->data, dlen, addr, &out_len,
721 le16_to_cpu(dn->compr_type));
722 if (err || len != out_len)
726 * Data length can be less than a full block, even for blocks that are
727 * not the last in the file (e.g., as a result of making a hole and
728 * appending data). Ensure that the remainder is zeroed out.
730 if (len < UBIFS_BLOCK_SIZE)
731 memset(addr + len, 0, UBIFS_BLOCK_SIZE - len);
736 ubifs_err(c, "bad data node (block %u, inode %lu)",
737 block, inode->i_ino);
738 ubifs_dump_node(c, dn);
742 static int do_readpage(struct ubifs_info *c, struct inode *inode,
743 struct page *page, int last_block_size)
747 unsigned int block, beyond;
748 struct ubifs_data_node *dn;
749 loff_t i_size = inode->i_size;
751 dbg_gen("ino %lu, pg %lu, i_size %lld",
752 inode->i_ino, page->index, i_size);
756 block = page->index << UBIFS_BLOCKS_PER_PAGE_SHIFT;
757 beyond = (i_size + UBIFS_BLOCK_SIZE - 1) >> UBIFS_BLOCK_SHIFT;
758 if (block >= beyond) {
759 /* Reading beyond inode */
760 memset(addr, 0, PAGE_CACHE_SIZE);
764 dn = kmalloc(UBIFS_MAX_DATA_NODE_SZ, GFP_NOFS);
772 if (block >= beyond) {
773 /* Reading beyond inode */
775 memset(addr, 0, UBIFS_BLOCK_SIZE);
778 * Reading last block? Make sure to not write beyond
779 * the requested size in the destination buffer.
781 if (((block + 1) == beyond) || last_block_size) {
786 * We need to buffer the data locally for the
787 * last block. This is to not pad the
788 * destination area to a multiple of
791 buff = malloc_cache_aligned(UBIFS_BLOCK_SIZE);
793 printf("%s: Error, malloc fails!\n",
799 /* Read block-size into temp buffer */
800 ret = read_block(inode, buff, block, dn);
803 if (err != -ENOENT) {
810 dlen = last_block_size;
812 dlen = le32_to_cpu(dn->size);
814 /* Now copy required size back to dest */
815 memcpy(addr, buff, dlen);
819 ret = read_block(inode, addr, block, dn);
827 if (++i >= UBIFS_BLOCKS_PER_PAGE)
830 addr += UBIFS_BLOCK_SIZE;
833 if (err == -ENOENT) {
834 /* Not found, so it must be a hole */
838 ubifs_err(c, "cannot read page %lu of inode %lu, error %d",
839 page->index, inode->i_ino, err);
853 int ubifs_read(const char *filename, void *buf, loff_t offset,
854 loff_t size, loff_t *actread)
856 struct ubifs_info *c = ubifs_sb->s_fs_info;
863 int last_block_size = 0;
867 if (offset & (PAGE_SIZE - 1)) {
868 printf("ubifs: Error offset must be a multple of %d\n",
873 c->ubi = ubi_open_volume(c->vi.ubi_num, c->vi.vol_id, UBI_READONLY);
874 /* ubifs_findfile will resolve symlinks, so we know that we get
875 * the real file here */
876 inum = ubifs_findfile(ubifs_sb, (char *)filename);
885 inode = ubifs_iget(ubifs_sb, inum);
887 printf("%s: Error reading inode %ld!\n", __func__, inum);
888 err = PTR_ERR(inode);
892 if (offset > inode->i_size) {
893 printf("ubifs: Error offset (%lld) > file-size (%lld)\n",
900 * If no size was specified or if size bigger than filesize
901 * set size to filesize
903 if ((size == 0) || (size > (inode->i_size - offset)))
904 size = inode->i_size - offset;
906 count = (size + UBIFS_BLOCK_SIZE - 1) >> UBIFS_BLOCK_SHIFT;
909 page.index = offset / PAGE_SIZE;
911 for (i = 0; i < count; i++) {
913 * Make sure to not read beyond the requested size
915 if (((i + 1) == count) && (size < inode->i_size))
916 last_block_size = size - (i * PAGE_SIZE);
918 err = do_readpage(c, inode, &page, last_block_size);
922 page.addr += PAGE_SIZE;
927 printf("Error reading file '%s'\n", filename);
928 *actread = i * PAGE_SIZE;
937 ubi_close_volume(c->ubi);
941 void ubifs_close(void)
945 /* Compat wrappers for common/cmd_ubifs.c */
946 int ubifs_load(char *filename, u32 addr, u32 size)
951 printf("Loading file '%s' to addr 0x%08x...\n", filename, addr);
953 err = ubifs_read(filename, (void *)addr, 0, size, &actread);
955 setenv_hex("filesize", actread);
962 void uboot_ubifs_umount(void)
965 printf("Unmounting UBIFS volume %s!\n",
966 ((struct ubifs_info *)(ubifs_sb->s_fs_info))->vi.name);
967 ubifs_umount(ubifs_sb->s_fs_info);