2 * This file is part of UBIFS.
4 * Copyright (C) 2006-2008 Nokia Corporation.
6 * (C) Copyright 2008-2010
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);
154 /* from shrinker.c */
156 /* Global clean znode counter (for all mounted UBIFS instances) */
157 atomic_long_t ubifs_clean_zn_cnt;
162 * ubifs_decompress - decompress data.
163 * @in_buf: data to decompress
164 * @in_len: length of the data to decompress
165 * @out_buf: output buffer where decompressed data should
166 * @out_len: output length is returned here
167 * @compr_type: type of compression
169 * This function decompresses data from buffer @in_buf into buffer @out_buf.
170 * The length of the uncompressed data is returned in @out_len. This functions
171 * returns %0 on success or a negative error code on failure.
173 int ubifs_decompress(const void *in_buf, int in_len, void *out_buf,
174 int *out_len, int compr_type)
177 struct ubifs_compressor *compr;
179 if (unlikely(compr_type < 0 || compr_type >= UBIFS_COMPR_TYPES_CNT)) {
180 ubifs_err("invalid compression type %d", compr_type);
184 compr = ubifs_compressors[compr_type];
186 if (unlikely(!compr->capi_name)) {
187 ubifs_err("%s compression is not compiled in", compr->name);
191 if (compr_type == UBIFS_COMPR_NONE) {
192 memcpy(out_buf, in_buf, in_len);
197 if (compr->decomp_mutex)
198 mutex_lock(compr->decomp_mutex);
199 err = crypto_comp_decompress(compr->cc, in_buf, in_len, out_buf,
200 (unsigned int *)out_len);
201 if (compr->decomp_mutex)
202 mutex_unlock(compr->decomp_mutex);
204 ubifs_err("cannot decompress %d bytes, compressor %s, error %d",
205 in_len, compr->name, err);
211 * compr_init - initialize a compressor.
212 * @compr: compressor description object
214 * This function initializes the requested compressor and returns zero in case
215 * of success or a negative error code in case of failure.
217 static int __init compr_init(struct ubifs_compressor *compr)
219 ubifs_compressors[compr->compr_type] = compr;
221 #ifdef CONFIG_NEEDS_MANUAL_RELOC
222 ubifs_compressors[compr->compr_type]->name += gd->reloc_off;
223 ubifs_compressors[compr->compr_type]->capi_name += gd->reloc_off;
224 ubifs_compressors[compr->compr_type]->decompress += gd->reloc_off;
227 if (compr->capi_name) {
228 compr->cc = crypto_alloc_comp(compr->capi_name, 0, 0);
229 if (IS_ERR(compr->cc)) {
230 ubifs_err("cannot initialize compressor %s, error %ld",
231 compr->name, PTR_ERR(compr->cc));
232 return PTR_ERR(compr->cc);
240 * ubifs_compressors_init - initialize UBIFS compressors.
242 * This function initializes the compressor which were compiled in. Returns
243 * zero in case of success and a negative error code in case of failure.
245 int __init ubifs_compressors_init(void)
249 err = compr_init(&lzo_compr);
253 err = compr_init(&zlib_compr);
257 err = compr_init(&none_compr);
268 static int filldir(struct ubifs_info *c, const char *name, int namlen,
269 u64 ino, unsigned int d_type)
275 case UBIFS_ITYPE_REG:
278 case UBIFS_ITYPE_DIR:
281 case UBIFS_ITYPE_LNK:
289 inode = ubifs_iget(c->vfs_sb, ino);
291 printf("%s: Error in ubifs_iget(), ino=%lld ret=%p!\n",
292 __func__, ino, inode);
295 ctime_r((time_t *)&inode->i_mtime, filetime);
296 printf("%9lld %24.24s ", inode->i_size, filetime);
301 printf("%s\n", name);
306 static int ubifs_printdir(struct file *file, void *dirent)
311 struct ubifs_dent_node *dent;
312 struct inode *dir = file->f_path.dentry->d_inode;
313 struct ubifs_info *c = dir->i_sb->s_fs_info;
315 dbg_gen("dir ino %lu, f_pos %#llx", dir->i_ino, file->f_pos);
317 if (file->f_pos > UBIFS_S_KEY_HASH_MASK || file->f_pos == 2)
319 * The directory was seek'ed to a senseless position or there
320 * are no more entries.
324 if (file->f_pos == 1) {
325 /* Find the first entry in TNC and save it */
326 lowest_dent_key(c, &key, dir->i_ino);
328 dent = ubifs_tnc_next_ent(c, &key, &nm);
334 file->f_pos = key_hash_flash(c, &dent->key);
335 file->private_data = dent;
338 dent = file->private_data;
341 * The directory was seek'ed to and is now readdir'ed.
342 * Find the entry corresponding to @file->f_pos or the
345 dent_key_init_hash(c, &key, dir->i_ino, file->f_pos);
347 dent = ubifs_tnc_next_ent(c, &key, &nm);
352 file->f_pos = key_hash_flash(c, &dent->key);
353 file->private_data = dent;
357 dbg_gen("feed '%s', ino %llu, new f_pos %#x",
358 dent->name, (unsigned long long)le64_to_cpu(dent->inum),
359 key_hash_flash(c, &dent->key));
360 ubifs_assert(le64_to_cpu(dent->ch.sqnum) > ubifs_inode(dir)->creat_sqnum);
362 nm.len = le16_to_cpu(dent->nlen);
363 over = filldir(c, (char *)dent->name, nm.len,
364 le64_to_cpu(dent->inum), dent->type);
368 /* Switch to the next entry */
369 key_read(c, &dent->key, &key);
370 nm.name = (char *)dent->name;
371 dent = ubifs_tnc_next_ent(c, &key, &nm);
377 kfree(file->private_data);
378 file->f_pos = key_hash_flash(c, &dent->key);
379 file->private_data = dent;
384 if (err != -ENOENT) {
385 ubifs_err("cannot find next direntry, error %d", err);
389 kfree(file->private_data);
390 file->private_data = NULL;
395 static int ubifs_finddir(struct super_block *sb, char *dirname,
396 unsigned long root_inum, unsigned long *inum)
401 struct ubifs_dent_node *dent;
402 struct ubifs_info *c;
404 struct dentry *dentry;
408 file = kzalloc(sizeof(struct file), 0);
409 dentry = kzalloc(sizeof(struct dentry), 0);
410 dir = kzalloc(sizeof(struct inode), 0);
411 if (!file || !dentry || !dir) {
412 printf("%s: Error, no memory for malloc!\n", __func__);
418 file->f_path.dentry = dentry;
419 file->f_path.dentry->d_parent = dentry;
420 file->f_path.dentry->d_inode = dir;
421 file->f_path.dentry->d_inode->i_ino = root_inum;
424 dbg_gen("dir ino %lu, f_pos %#llx", dir->i_ino, file->f_pos);
426 /* Find the first entry in TNC and save it */
427 lowest_dent_key(c, &key, dir->i_ino);
429 dent = ubifs_tnc_next_ent(c, &key, &nm);
435 file->f_pos = key_hash_flash(c, &dent->key);
436 file->private_data = dent;
439 dbg_gen("feed '%s', ino %llu, new f_pos %#x",
440 dent->name, (unsigned long long)le64_to_cpu(dent->inum),
441 key_hash_flash(c, &dent->key));
442 ubifs_assert(le64_to_cpu(dent->ch.sqnum) > ubifs_inode(dir)->creat_sqnum);
444 nm.len = le16_to_cpu(dent->nlen);
445 if ((strncmp(dirname, (char *)dent->name, nm.len) == 0) &&
446 (strlen(dirname) == nm.len)) {
447 *inum = le64_to_cpu(dent->inum);
452 /* Switch to the next entry */
453 key_read(c, &dent->key, &key);
454 nm.name = (char *)dent->name;
455 dent = ubifs_tnc_next_ent(c, &key, &nm);
461 kfree(file->private_data);
462 file->f_pos = key_hash_flash(c, &dent->key);
463 file->private_data = dent;
469 ubifs_err("cannot find next direntry, error %d", err);
472 if (file->private_data)
473 kfree(file->private_data);
484 static unsigned long ubifs_findfile(struct super_block *sb, char *filename)
489 char symlinkpath[128];
491 unsigned long root_inum = 1;
493 int symlink_count = 0; /* Don't allow symlink recursion */
496 strcpy(fpath, filename);
498 /* Remove all leading slashes */
503 * Handle root-direcoty ('/')
506 if (!name || *name == '\0')
511 struct ubifs_inode *ui;
513 /* Extract the actual part from the pathname. */
514 next = strchr(name, '/');
516 /* Remove all leading slashes. */
521 ret = ubifs_finddir(sb, name, root_inum, &inum);
524 inode = ubifs_iget(sb, inum);
528 ui = ubifs_inode(inode);
530 if ((inode->i_mode & S_IFMT) == S_IFLNK) {
533 /* We have some sort of symlink recursion, bail out */
534 if (symlink_count++ > 8) {
535 printf("Symlink recursion, aborting\n");
538 memcpy(link_name, ui->data, ui->data_len);
539 link_name[ui->data_len] = '\0';
541 if (link_name[0] == '/') {
542 /* Absolute path, redo everything without
543 * the leading slash */
544 next = name = link_name + 1;
548 /* Relative to cur dir */
549 sprintf(buf, "%s/%s",
550 link_name, next == NULL ? "" : next);
551 memcpy(symlinkpath, buf, sizeof(buf));
552 next = name = symlinkpath;
557 * Check if directory with this name exists
560 /* Found the node! */
561 if (!next || *next == '\0')
571 int ubifs_ls(char *filename)
573 struct ubifs_info *c = ubifs_sb->s_fs_info;
575 struct dentry *dentry;
581 c->ubi = ubi_open_volume(c->vi.ubi_num, c->vi.vol_id, UBI_READONLY);
582 inum = ubifs_findfile(ubifs_sb, filename);
588 file = kzalloc(sizeof(struct file), 0);
589 dentry = kzalloc(sizeof(struct dentry), 0);
590 dir = kzalloc(sizeof(struct inode), 0);
591 if (!file || !dentry || !dir) {
592 printf("%s: Error, no memory for malloc!\n", __func__);
597 dir->i_sb = ubifs_sb;
598 file->f_path.dentry = dentry;
599 file->f_path.dentry->d_parent = dentry;
600 file->f_path.dentry->d_inode = dir;
601 file->f_path.dentry->d_inode->i_ino = inum;
603 file->private_data = NULL;
604 ubifs_printdir(file, dirent);
615 ubi_close_volume(c->ubi);
625 static inline void *kmap(struct page *page)
630 static int read_block(struct inode *inode, void *addr, unsigned int block,
631 struct ubifs_data_node *dn)
633 struct ubifs_info *c = inode->i_sb->s_fs_info;
634 int err, len, out_len;
638 data_key_init(c, &key, inode->i_ino, block);
639 err = ubifs_tnc_lookup(c, &key, dn);
642 /* Not found, so it must be a hole */
643 memset(addr, 0, UBIFS_BLOCK_SIZE);
647 ubifs_assert(le64_to_cpu(dn->ch.sqnum) > ubifs_inode(inode)->creat_sqnum);
649 len = le32_to_cpu(dn->size);
650 if (len <= 0 || len > UBIFS_BLOCK_SIZE)
653 dlen = le32_to_cpu(dn->ch.len) - UBIFS_DATA_NODE_SZ;
654 out_len = UBIFS_BLOCK_SIZE;
655 err = ubifs_decompress(&dn->data, dlen, addr, &out_len,
656 le16_to_cpu(dn->compr_type));
657 if (err || len != out_len)
661 * Data length can be less than a full block, even for blocks that are
662 * not the last in the file (e.g., as a result of making a hole and
663 * appending data). Ensure that the remainder is zeroed out.
665 if (len < UBIFS_BLOCK_SIZE)
666 memset(addr + len, 0, UBIFS_BLOCK_SIZE - len);
671 ubifs_err("bad data node (block %u, inode %lu)",
672 block, inode->i_ino);
673 ubifs_dump_node(c, dn);
677 static int do_readpage(struct ubifs_info *c, struct inode *inode,
678 struct page *page, int last_block_size)
682 unsigned int block, beyond;
683 struct ubifs_data_node *dn;
684 loff_t i_size = inode->i_size;
686 dbg_gen("ino %lu, pg %lu, i_size %lld",
687 inode->i_ino, page->index, i_size);
691 block = page->index << UBIFS_BLOCKS_PER_PAGE_SHIFT;
692 beyond = (i_size + UBIFS_BLOCK_SIZE - 1) >> UBIFS_BLOCK_SHIFT;
693 if (block >= beyond) {
694 /* Reading beyond inode */
695 memset(addr, 0, PAGE_CACHE_SIZE);
699 dn = kmalloc(UBIFS_MAX_DATA_NODE_SZ, GFP_NOFS);
707 if (block >= beyond) {
708 /* Reading beyond inode */
710 memset(addr, 0, UBIFS_BLOCK_SIZE);
713 * Reading last block? Make sure to not write beyond
714 * the requested size in the destination buffer.
716 if (((block + 1) == beyond) || last_block_size) {
721 * We need to buffer the data locally for the
722 * last block. This is to not pad the
723 * destination area to a multiple of
726 buff = malloc(UBIFS_BLOCK_SIZE);
728 printf("%s: Error, malloc fails!\n",
734 /* Read block-size into temp buffer */
735 ret = read_block(inode, buff, block, dn);
738 if (err != -ENOENT) {
745 dlen = last_block_size;
747 dlen = le32_to_cpu(dn->size);
749 /* Now copy required size back to dest */
750 memcpy(addr, buff, dlen);
754 ret = read_block(inode, addr, block, dn);
762 if (++i >= UBIFS_BLOCKS_PER_PAGE)
765 addr += UBIFS_BLOCK_SIZE;
768 if (err == -ENOENT) {
769 /* Not found, so it must be a hole */
773 ubifs_err("cannot read page %lu of inode %lu, error %d",
774 page->index, inode->i_ino, err);
788 int ubifs_load(char *filename, u32 addr, u32 size)
790 struct ubifs_info *c = ubifs_sb->s_fs_info;
797 int last_block_size = 0;
799 c->ubi = ubi_open_volume(c->vi.ubi_num, c->vi.vol_id, UBI_READONLY);
800 /* ubifs_findfile will resolve symlinks, so we know that we get
801 * the real file here */
802 inum = ubifs_findfile(ubifs_sb, filename);
811 inode = ubifs_iget(ubifs_sb, inum);
813 printf("%s: Error reading inode %ld!\n", __func__, inum);
814 err = PTR_ERR(inode);
819 * If no size was specified or if size bigger than filesize
820 * set size to filesize
822 if ((size == 0) || (size > inode->i_size))
823 size = inode->i_size;
825 count = (size + UBIFS_BLOCK_SIZE - 1) >> UBIFS_BLOCK_SHIFT;
826 printf("Loading file '%s' to addr 0x%08x with size %d (0x%08x)...\n",
827 filename, addr, size, size);
829 page.addr = (void *)addr;
832 for (i = 0; i < count; i++) {
834 * Make sure to not read beyond the requested size
836 if (((i + 1) == count) && (size < inode->i_size))
837 last_block_size = size - (i * PAGE_SIZE);
839 err = do_readpage(c, inode, &page, last_block_size);
843 page.addr += PAGE_SIZE;
848 printf("Error reading file '%s'\n", filename);
850 setenv_hex("filesize", size);
857 ubi_close_volume(c->ubi);