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 (Битюцкий Артём)
27 #include <u-boot/zlib.h>
29 #include <linux/err.h>
30 #include <linux/lzo.h>
32 DECLARE_GLOBAL_DATA_PTR;
37 * We need a wrapper for zunzip() because the parameters are
38 * incompatible with the lzo decompressor.
40 static int gzip_decompress(const unsigned char *in, size_t in_len,
41 unsigned char *out, size_t *out_len)
43 return zunzip(out, *out_len, (unsigned char *)in,
44 (unsigned long *)out_len, 0, 0);
47 /* Fake description object for the "none" compressor */
48 static struct ubifs_compressor none_compr = {
49 .compr_type = UBIFS_COMPR_NONE,
55 static struct ubifs_compressor lzo_compr = {
56 .compr_type = UBIFS_COMPR_LZO,
58 .comp_mutex = &lzo_mutex,
62 .decompress = lzo1x_decompress_safe,
65 static struct ubifs_compressor zlib_compr = {
66 .compr_type = UBIFS_COMPR_ZLIB,
68 .comp_mutex = &deflate_mutex,
69 .decomp_mutex = &inflate_mutex,
72 .capi_name = "deflate",
73 .decompress = gzip_decompress,
76 /* All UBIFS compressors */
77 struct ubifs_compressor *ubifs_compressors[UBIFS_COMPR_TYPES_CNT];
84 * kmemdup - duplicate region of memory
86 * @src: memory region to duplicate
87 * @len: memory region length
88 * @gfp: GFP mask to use
90 void *kmemdup(const void *src, size_t len, gfp_t gfp)
94 p = kmalloc(len, gfp);
104 static inline struct crypto_comp *crypto_alloc_comp(const char *alg_name,
107 struct ubifs_compressor *comp;
108 struct crypto_comp *ptr;
111 ptr = malloc(sizeof(struct crypto_comp));
112 while (i < UBIFS_COMPR_TYPES_CNT) {
113 comp = ubifs_compressors[i];
118 if (strncmp(alg_name, comp->capi_name, strlen(alg_name)) == 0) {
124 if (i >= UBIFS_COMPR_TYPES_CNT) {
125 ubifs_err("invalid compression type %s", alg_name);
131 static inline int crypto_comp_decompress(struct crypto_comp *tfm,
132 const u8 *src, unsigned int slen,
133 u8 *dst, unsigned int *dlen)
135 struct ubifs_compressor *compr = ubifs_compressors[tfm->compressor];
138 if (compr->compr_type == UBIFS_COMPR_NONE) {
139 memcpy(dst, src, slen);
144 err = compr->decompress(src, slen, dst, (size_t *)dlen);
146 ubifs_err("cannot decompress %d bytes, compressor %s, "
147 "error %d", slen, compr->name, err);
156 * ubifs_decompress - decompress data.
157 * @in_buf: data to decompress
158 * @in_len: length of the data to decompress
159 * @out_buf: output buffer where decompressed data should
160 * @out_len: output length is returned here
161 * @compr_type: type of compression
163 * This function decompresses data from buffer @in_buf into buffer @out_buf.
164 * The length of the uncompressed data is returned in @out_len. This functions
165 * returns %0 on success or a negative error code on failure.
167 int ubifs_decompress(const void *in_buf, int in_len, void *out_buf,
168 int *out_len, int compr_type)
171 struct ubifs_compressor *compr;
173 if (unlikely(compr_type < 0 || compr_type >= UBIFS_COMPR_TYPES_CNT)) {
174 ubifs_err("invalid compression type %d", compr_type);
178 compr = ubifs_compressors[compr_type];
180 if (unlikely(!compr->capi_name)) {
181 ubifs_err("%s compression is not compiled in", compr->name);
185 if (compr_type == UBIFS_COMPR_NONE) {
186 memcpy(out_buf, in_buf, in_len);
191 if (compr->decomp_mutex)
192 mutex_lock(compr->decomp_mutex);
193 err = crypto_comp_decompress(compr->cc, in_buf, in_len, out_buf,
194 (unsigned int *)out_len);
195 if (compr->decomp_mutex)
196 mutex_unlock(compr->decomp_mutex);
198 ubifs_err("cannot decompress %d bytes, compressor %s, error %d",
199 in_len, compr->name, err);
205 * compr_init - initialize a compressor.
206 * @compr: compressor description object
208 * This function initializes the requested compressor and returns zero in case
209 * of success or a negative error code in case of failure.
211 static int __init compr_init(struct ubifs_compressor *compr)
213 ubifs_compressors[compr->compr_type] = compr;
215 #ifdef CONFIG_NEEDS_MANUAL_RELOC
216 ubifs_compressors[compr->compr_type]->name += gd->reloc_off;
217 ubifs_compressors[compr->compr_type]->capi_name += gd->reloc_off;
218 ubifs_compressors[compr->compr_type]->decompress += gd->reloc_off;
221 if (compr->capi_name) {
222 compr->cc = crypto_alloc_comp(compr->capi_name, 0, 0);
223 if (IS_ERR(compr->cc)) {
224 ubifs_err("cannot initialize compressor %s, error %ld",
225 compr->name, PTR_ERR(compr->cc));
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));
354 ubifs_assert(le64_to_cpu(dent->ch.sqnum) > ubifs_inode(dir)->creat_sqnum);
356 nm.len = le16_to_cpu(dent->nlen);
357 over = filldir(c, (char *)dent->name, nm.len,
358 le64_to_cpu(dent->inum), dent->type);
362 /* Switch to the next entry */
363 key_read(c, &dent->key, &key);
364 nm.name = (char *)dent->name;
365 dent = ubifs_tnc_next_ent(c, &key, &nm);
371 kfree(file->private_data);
372 file->f_pos = key_hash_flash(c, &dent->key);
373 file->private_data = dent;
378 if (err != -ENOENT) {
379 ubifs_err("cannot find next direntry, error %d", err);
383 kfree(file->private_data);
384 file->private_data = NULL;
389 static int ubifs_finddir(struct super_block *sb, char *dirname,
390 unsigned long root_inum, unsigned long *inum)
395 struct ubifs_dent_node *dent;
396 struct ubifs_info *c;
398 struct dentry *dentry;
402 file = kzalloc(sizeof(struct file), 0);
403 dentry = kzalloc(sizeof(struct dentry), 0);
404 dir = kzalloc(sizeof(struct inode), 0);
405 if (!file || !dentry || !dir) {
406 printf("%s: Error, no memory for malloc!\n", __func__);
412 file->f_path.dentry = dentry;
413 file->f_path.dentry->d_parent = dentry;
414 file->f_path.dentry->d_inode = dir;
415 file->f_path.dentry->d_inode->i_ino = root_inum;
418 dbg_gen("dir ino %lu, f_pos %#llx", dir->i_ino, file->f_pos);
420 /* Find the first entry in TNC and save it */
421 lowest_dent_key(c, &key, dir->i_ino);
423 dent = ubifs_tnc_next_ent(c, &key, &nm);
429 file->f_pos = key_hash_flash(c, &dent->key);
430 file->private_data = dent;
433 dbg_gen("feed '%s', ino %llu, new f_pos %#x",
434 dent->name, (unsigned long long)le64_to_cpu(dent->inum),
435 key_hash_flash(c, &dent->key));
436 ubifs_assert(le64_to_cpu(dent->ch.sqnum) > ubifs_inode(dir)->creat_sqnum);
438 nm.len = le16_to_cpu(dent->nlen);
439 if ((strncmp(dirname, (char *)dent->name, nm.len) == 0) &&
440 (strlen(dirname) == nm.len)) {
441 *inum = le64_to_cpu(dent->inum);
446 /* Switch to the next entry */
447 key_read(c, &dent->key, &key);
448 nm.name = (char *)dent->name;
449 dent = ubifs_tnc_next_ent(c, &key, &nm);
455 kfree(file->private_data);
456 file->f_pos = key_hash_flash(c, &dent->key);
457 file->private_data = dent;
463 ubifs_err("cannot find next direntry, error %d", err);
466 if (file->private_data)
467 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_ls(char *filename)
567 struct ubifs_info *c = ubifs_sb->s_fs_info;
569 struct dentry *dentry;
575 c->ubi = ubi_open_volume(c->vi.ubi_num, c->vi.vol_id, UBI_READONLY);
576 inum = ubifs_findfile(ubifs_sb, filename);
582 file = kzalloc(sizeof(struct file), 0);
583 dentry = kzalloc(sizeof(struct dentry), 0);
584 dir = kzalloc(sizeof(struct inode), 0);
585 if (!file || !dentry || !dir) {
586 printf("%s: Error, no memory for malloc!\n", __func__);
591 dir->i_sb = ubifs_sb;
592 file->f_path.dentry = dentry;
593 file->f_path.dentry->d_parent = dentry;
594 file->f_path.dentry->d_inode = dir;
595 file->f_path.dentry->d_inode->i_ino = inum;
597 file->private_data = NULL;
598 ubifs_printdir(file, dirent);
609 ubi_close_volume(c->ubi);
619 static inline void *kmap(struct page *page)
624 static int read_block(struct inode *inode, void *addr, unsigned int block,
625 struct ubifs_data_node *dn)
627 struct ubifs_info *c = inode->i_sb->s_fs_info;
628 int err, len, out_len;
632 data_key_init(c, &key, inode->i_ino, block);
633 err = ubifs_tnc_lookup(c, &key, dn);
636 /* Not found, so it must be a hole */
637 memset(addr, 0, UBIFS_BLOCK_SIZE);
641 ubifs_assert(le64_to_cpu(dn->ch.sqnum) > ubifs_inode(inode)->creat_sqnum);
643 len = le32_to_cpu(dn->size);
644 if (len <= 0 || len > UBIFS_BLOCK_SIZE)
647 dlen = le32_to_cpu(dn->ch.len) - UBIFS_DATA_NODE_SZ;
648 out_len = UBIFS_BLOCK_SIZE;
649 err = ubifs_decompress(&dn->data, dlen, addr, &out_len,
650 le16_to_cpu(dn->compr_type));
651 if (err || len != out_len)
655 * Data length can be less than a full block, even for blocks that are
656 * not the last in the file (e.g., as a result of making a hole and
657 * appending data). Ensure that the remainder is zeroed out.
659 if (len < UBIFS_BLOCK_SIZE)
660 memset(addr + len, 0, UBIFS_BLOCK_SIZE - len);
665 ubifs_err("bad data node (block %u, inode %lu)",
666 block, inode->i_ino);
667 ubifs_dump_node(c, dn);
671 static int do_readpage(struct ubifs_info *c, struct inode *inode,
672 struct page *page, int last_block_size)
676 unsigned int block, beyond;
677 struct ubifs_data_node *dn;
678 loff_t i_size = inode->i_size;
680 dbg_gen("ino %lu, pg %lu, i_size %lld",
681 inode->i_ino, page->index, i_size);
685 block = page->index << UBIFS_BLOCKS_PER_PAGE_SHIFT;
686 beyond = (i_size + UBIFS_BLOCK_SIZE - 1) >> UBIFS_BLOCK_SHIFT;
687 if (block >= beyond) {
688 /* Reading beyond inode */
689 memset(addr, 0, PAGE_CACHE_SIZE);
693 dn = kmalloc(UBIFS_MAX_DATA_NODE_SZ, GFP_NOFS);
701 if (block >= beyond) {
702 /* Reading beyond inode */
704 memset(addr, 0, UBIFS_BLOCK_SIZE);
707 * Reading last block? Make sure to not write beyond
708 * the requested size in the destination buffer.
710 if (((block + 1) == beyond) || last_block_size) {
715 * We need to buffer the data locally for the
716 * last block. This is to not pad the
717 * destination area to a multiple of
720 buff = malloc(UBIFS_BLOCK_SIZE);
722 printf("%s: Error, malloc fails!\n",
728 /* Read block-size into temp buffer */
729 ret = read_block(inode, buff, block, dn);
732 if (err != -ENOENT) {
739 dlen = last_block_size;
741 dlen = le32_to_cpu(dn->size);
743 /* Now copy required size back to dest */
744 memcpy(addr, buff, dlen);
748 ret = read_block(inode, addr, block, dn);
756 if (++i >= UBIFS_BLOCKS_PER_PAGE)
759 addr += UBIFS_BLOCK_SIZE;
762 if (err == -ENOENT) {
763 /* Not found, so it must be a hole */
767 ubifs_err("cannot read page %lu of inode %lu, error %d",
768 page->index, inode->i_ino, err);
782 int ubifs_load(char *filename, u32 addr, u32 size)
784 struct ubifs_info *c = ubifs_sb->s_fs_info;
791 int last_block_size = 0;
793 c->ubi = ubi_open_volume(c->vi.ubi_num, c->vi.vol_id, UBI_READONLY);
794 /* ubifs_findfile will resolve symlinks, so we know that we get
795 * the real file here */
796 inum = ubifs_findfile(ubifs_sb, filename);
805 inode = ubifs_iget(ubifs_sb, inum);
807 printf("%s: Error reading inode %ld!\n", __func__, inum);
808 err = PTR_ERR(inode);
813 * If no size was specified or if size bigger than filesize
814 * set size to filesize
816 if ((size == 0) || (size > inode->i_size))
817 size = inode->i_size;
819 count = (size + UBIFS_BLOCK_SIZE - 1) >> UBIFS_BLOCK_SHIFT;
820 printf("Loading file '%s' to addr 0x%08x with size %d (0x%08x)...\n",
821 filename, addr, size, size);
823 page.addr = (void *)addr;
826 for (i = 0; i < count; i++) {
828 * Make sure to not read beyond the requested size
830 if (((i + 1) == count) && (size < inode->i_size))
831 last_block_size = size - (i * PAGE_SIZE);
833 err = do_readpage(c, inode, &page, last_block_size);
837 page.addr += PAGE_SIZE;
842 printf("Error reading file '%s'\n", filename);
844 setenv_hex("filesize", size);
851 ubi_close_volume(c->ubi);