2 * Compressed rom filesystem for Linux.
4 * Copyright (C) 1999 Linus Torvalds.
6 * This file is released under the GPL.
10 * These are the VFS interfaces to the compressed rom filesystem.
11 * The actual compression is based on zlib, see the other files.
14 #include <linux/module.h>
16 #include <linux/pagemap.h>
17 #include <linux/init.h>
18 #include <linux/string.h>
19 #include <linux/blkdev.h>
20 #include <linux/cramfs_fs.h>
21 #include <linux/slab.h>
22 #include <linux/cramfs_fs_sb.h>
23 #include <linux/buffer_head.h>
24 #include <linux/vfs.h>
25 #include <linux/mutex.h>
27 #include <asm/uaccess.h>
29 static const struct super_operations cramfs_ops
;
30 static const struct inode_operations cramfs_dir_inode_operations
;
31 static const struct file_operations cramfs_directory_operations
;
32 static const struct address_space_operations cramfs_aops
;
34 static DEFINE_MUTEX(read_mutex
);
37 /* These macros may change in future, to provide better st_ino semantics. */
38 #define OFFSET(x) ((x)->i_ino)
40 static unsigned long cramino(struct cramfs_inode
*cino
, unsigned int offset
)
48 * The file mode test fixes buggy mkcramfs implementations where
49 * cramfs_inode->offset is set to a non zero value for entries
50 * which did not contain data, like devices node and fifos.
52 switch (cino
->mode
& S_IFMT
) {
56 return cino
->offset
<< 2;
63 static struct inode
*get_cramfs_inode(struct super_block
*sb
,
64 struct cramfs_inode
*cramfs_inode
, unsigned int offset
)
67 static struct timespec zerotime
;
69 inode
= iget_locked(sb
, cramino(cramfs_inode
, offset
));
71 return ERR_PTR(-ENOMEM
);
72 if (!(inode
->i_state
& I_NEW
))
75 switch (cramfs_inode
->mode
& S_IFMT
) {
77 inode
->i_fop
= &generic_ro_fops
;
78 inode
->i_data
.a_ops
= &cramfs_aops
;
81 inode
->i_op
= &cramfs_dir_inode_operations
;
82 inode
->i_fop
= &cramfs_directory_operations
;
85 inode
->i_op
= &page_symlink_inode_operations
;
86 inode
->i_data
.a_ops
= &cramfs_aops
;
89 init_special_inode(inode
, cramfs_inode
->mode
,
90 old_decode_dev(cramfs_inode
->size
));
93 inode
->i_mode
= cramfs_inode
->mode
;
94 inode
->i_uid
= cramfs_inode
->uid
;
95 inode
->i_gid
= cramfs_inode
->gid
;
97 /* if the lower 2 bits are zero, the inode contains data */
98 if (!(inode
->i_ino
& 3)) {
99 inode
->i_size
= cramfs_inode
->size
;
100 inode
->i_blocks
= (cramfs_inode
->size
- 1) / 512 + 1;
103 /* Struct copy intentional */
104 inode
->i_mtime
= inode
->i_atime
= inode
->i_ctime
= zerotime
;
105 /* inode->i_nlink is left 1 - arguably wrong for directories,
106 but it's the best we can do without reading the directory
107 contents. 1 yields the right result in GNU find, even
108 without -noleaf option. */
110 unlock_new_inode(inode
);
116 * We have our own block cache: don't fill up the buffer cache
117 * with the rom-image, because the way the filesystem is set
118 * up the accesses should be fairly regular and cached in the
119 * page cache and dentry tree anyway..
121 * This also acts as a way to guarantee contiguous areas of up to
122 * BLKS_PER_BUF*PAGE_CACHE_SIZE, so that the caller doesn't need to
123 * worry about end-of-buffer issues even when decompressing a full
126 #define READ_BUFFERS (2)
127 /* NEXT_BUFFER(): Loop over [0..(READ_BUFFERS-1)]. */
128 #define NEXT_BUFFER(_ix) ((_ix) ^ 1)
131 * BLKS_PER_BUF_SHIFT should be at least 2 to allow for "compressed"
132 * data that takes up more space than the original and with unlucky
135 #define BLKS_PER_BUF_SHIFT (2)
136 #define BLKS_PER_BUF (1 << BLKS_PER_BUF_SHIFT)
137 #define BUFFER_SIZE (BLKS_PER_BUF*PAGE_CACHE_SIZE)
139 static unsigned char read_buffers
[READ_BUFFERS
][BUFFER_SIZE
];
140 static unsigned buffer_blocknr
[READ_BUFFERS
];
141 static struct super_block
* buffer_dev
[READ_BUFFERS
];
142 static int next_buffer
;
145 * Returns a pointer to a buffer containing at least LEN bytes of
146 * filesystem starting at byte offset OFFSET into the filesystem.
148 static void *cramfs_read(struct super_block
*sb
, unsigned int offset
, unsigned int len
)
150 struct address_space
*mapping
= sb
->s_bdev
->bd_inode
->i_mapping
;
151 struct page
*pages
[BLKS_PER_BUF
];
152 unsigned i
, blocknr
, buffer
;
153 unsigned long devsize
;
158 blocknr
= offset
>> PAGE_CACHE_SHIFT
;
159 offset
&= PAGE_CACHE_SIZE
- 1;
161 /* Check if an existing buffer already has the data.. */
162 for (i
= 0; i
< READ_BUFFERS
; i
++) {
163 unsigned int blk_offset
;
165 if (buffer_dev
[i
] != sb
)
167 if (blocknr
< buffer_blocknr
[i
])
169 blk_offset
= (blocknr
- buffer_blocknr
[i
]) << PAGE_CACHE_SHIFT
;
170 blk_offset
+= offset
;
171 if (blk_offset
+ len
> BUFFER_SIZE
)
173 return read_buffers
[i
] + blk_offset
;
176 devsize
= mapping
->host
->i_size
>> PAGE_CACHE_SHIFT
;
178 /* Ok, read in BLKS_PER_BUF pages completely first. */
179 for (i
= 0; i
< BLKS_PER_BUF
; i
++) {
180 struct page
*page
= NULL
;
182 if (blocknr
+ i
< devsize
) {
183 page
= read_mapping_page_async(mapping
, blocknr
+ i
,
185 /* synchronous error? */
192 for (i
= 0; i
< BLKS_PER_BUF
; i
++) {
193 struct page
*page
= pages
[i
];
195 wait_on_page_locked(page
);
196 if (!PageUptodate(page
)) {
197 /* asynchronous error */
198 page_cache_release(page
);
204 buffer
= next_buffer
;
205 next_buffer
= NEXT_BUFFER(buffer
);
206 buffer_blocknr
[buffer
] = blocknr
;
207 buffer_dev
[buffer
] = sb
;
209 data
= read_buffers
[buffer
];
210 for (i
= 0; i
< BLKS_PER_BUF
; i
++) {
211 struct page
*page
= pages
[i
];
213 memcpy(data
, kmap(page
), PAGE_CACHE_SIZE
);
215 page_cache_release(page
);
217 memset(data
, 0, PAGE_CACHE_SIZE
);
218 data
+= PAGE_CACHE_SIZE
;
220 return read_buffers
[buffer
] + offset
;
223 static void cramfs_put_super(struct super_block
*sb
)
225 kfree(sb
->s_fs_info
);
226 sb
->s_fs_info
= NULL
;
229 static int cramfs_remount(struct super_block
*sb
, int *flags
, char *data
)
235 static int cramfs_fill_super(struct super_block
*sb
, void *data
, int silent
)
238 struct cramfs_super super
;
239 unsigned long root_offset
;
240 struct cramfs_sb_info
*sbi
;
243 sb
->s_flags
|= MS_RDONLY
;
245 sbi
= kzalloc(sizeof(struct cramfs_sb_info
), GFP_KERNEL
);
250 /* Invalidate the read buffers on mount: think disk change.. */
251 mutex_lock(&read_mutex
);
252 for (i
= 0; i
< READ_BUFFERS
; i
++)
253 buffer_blocknr
[i
] = -1;
255 /* Read the first block and get the superblock from it */
256 memcpy(&super
, cramfs_read(sb
, 0, sizeof(super
)), sizeof(super
));
257 mutex_unlock(&read_mutex
);
259 /* Do sanity checks on the superblock */
260 if (super
.magic
!= CRAMFS_MAGIC
) {
261 /* check for wrong endianess */
262 if (super
.magic
== CRAMFS_MAGIC_WEND
) {
264 printk(KERN_ERR
"cramfs: wrong endianess\n");
268 /* check at 512 byte offset */
269 mutex_lock(&read_mutex
);
270 memcpy(&super
, cramfs_read(sb
, 512, sizeof(super
)), sizeof(super
));
271 mutex_unlock(&read_mutex
);
272 if (super
.magic
!= CRAMFS_MAGIC
) {
273 if (super
.magic
== CRAMFS_MAGIC_WEND
&& !silent
)
274 printk(KERN_ERR
"cramfs: wrong endianess\n");
276 printk(KERN_ERR
"cramfs: wrong magic\n");
281 /* get feature flags first */
282 if (super
.flags
& ~CRAMFS_SUPPORTED_FLAGS
) {
283 printk(KERN_ERR
"cramfs: unsupported filesystem features\n");
287 /* Check that the root inode is in a sane state */
288 if (!S_ISDIR(super
.root
.mode
)) {
289 printk(KERN_ERR
"cramfs: root is not a directory\n");
292 /* correct strange, hard-coded permissions of mkcramfs */
293 super
.root
.mode
|= (S_IRUSR
| S_IXUSR
| S_IRGRP
| S_IXGRP
| S_IROTH
| S_IXOTH
);
295 root_offset
= super
.root
.offset
<< 2;
296 if (super
.flags
& CRAMFS_FLAG_FSID_VERSION_2
) {
297 sbi
->size
=super
.size
;
298 sbi
->blocks
=super
.fsid
.blocks
;
299 sbi
->files
=super
.fsid
.files
;
305 sbi
->magic
=super
.magic
;
306 sbi
->flags
=super
.flags
;
307 if (root_offset
== 0)
308 printk(KERN_INFO
"cramfs: empty filesystem");
309 else if (!(super
.flags
& CRAMFS_FLAG_SHIFTED_ROOT_OFFSET
) &&
310 ((root_offset
!= sizeof(struct cramfs_super
)) &&
311 (root_offset
!= 512 + sizeof(struct cramfs_super
))))
313 printk(KERN_ERR
"cramfs: bad root offset %lu\n", root_offset
);
317 /* Set it all up.. */
318 sb
->s_op
= &cramfs_ops
;
319 root
= get_cramfs_inode(sb
, &super
.root
, 0);
322 sb
->s_root
= d_alloc_root(root
);
330 sb
->s_fs_info
= NULL
;
334 static int cramfs_statfs(struct dentry
*dentry
, struct kstatfs
*buf
)
336 struct super_block
*sb
= dentry
->d_sb
;
337 u64 id
= huge_encode_dev(sb
->s_bdev
->bd_dev
);
339 buf
->f_type
= CRAMFS_MAGIC
;
340 buf
->f_bsize
= PAGE_CACHE_SIZE
;
341 buf
->f_blocks
= CRAMFS_SB(sb
)->blocks
;
344 buf
->f_files
= CRAMFS_SB(sb
)->files
;
346 buf
->f_fsid
.val
[0] = (u32
)id
;
347 buf
->f_fsid
.val
[1] = (u32
)(id
>> 32);
348 buf
->f_namelen
= CRAMFS_MAXPATHLEN
;
353 * Read a cramfs directory entry.
355 static int cramfs_readdir(struct file
*filp
, void *dirent
, filldir_t filldir
)
357 struct inode
*inode
= filp
->f_path
.dentry
->d_inode
;
358 struct super_block
*sb
= inode
->i_sb
;
363 /* Offset within the thing. */
364 offset
= filp
->f_pos
;
365 if (offset
>= inode
->i_size
)
367 /* Directory entries are always 4-byte aligned */
371 buf
= kmalloc(CRAMFS_MAXPATHLEN
, GFP_KERNEL
);
376 while (offset
< inode
->i_size
) {
377 struct cramfs_inode
*de
;
378 unsigned long nextoffset
;
384 mutex_lock(&read_mutex
);
385 de
= cramfs_read(sb
, OFFSET(inode
) + offset
, sizeof(*de
)+CRAMFS_MAXPATHLEN
);
386 name
= (char *)(de
+1);
389 * Namelengths on disk are shifted by two
390 * and the name padded out to 4-byte boundaries
393 namelen
= de
->namelen
<< 2;
394 memcpy(buf
, name
, namelen
);
395 ino
= cramino(de
, OFFSET(inode
) + offset
);
397 mutex_unlock(&read_mutex
);
398 nextoffset
= offset
+ sizeof(*de
) + namelen
;
408 error
= filldir(dirent
, buf
, namelen
, offset
, ino
, mode
>> 12);
413 filp
->f_pos
= offset
;
421 * Lookup and fill in the inode data..
423 static struct dentry
* cramfs_lookup(struct inode
*dir
, struct dentry
*dentry
, struct nameidata
*nd
)
425 unsigned int offset
= 0;
428 mutex_lock(&read_mutex
);
429 sorted
= CRAMFS_SB(dir
->i_sb
)->flags
& CRAMFS_FLAG_SORTED_DIRS
;
430 while (offset
< dir
->i_size
) {
431 struct cramfs_inode
*de
;
434 int dir_off
= OFFSET(dir
) + offset
;
436 de
= cramfs_read(dir
->i_sb
, dir_off
, sizeof(*de
)+CRAMFS_MAXPATHLEN
);
437 name
= (char *)(de
+1);
439 /* Try to take advantage of sorted directories */
440 if (sorted
&& (dentry
->d_name
.name
[0] < name
[0]))
443 namelen
= de
->namelen
<< 2;
444 offset
+= sizeof(*de
) + namelen
;
446 /* Quick check that the name is roughly the right length */
447 if (((dentry
->d_name
.len
+ 3) & ~3) != namelen
)
452 mutex_unlock(&read_mutex
);
453 return ERR_PTR(-EIO
);
459 if (namelen
!= dentry
->d_name
.len
)
461 retval
= memcmp(dentry
->d_name
.name
, name
, namelen
);
465 struct cramfs_inode entry
= *de
;
466 mutex_unlock(&read_mutex
);
467 d_add(dentry
, get_cramfs_inode(dir
->i_sb
, &entry
, dir_off
));
470 /* else (retval < 0) */
474 mutex_unlock(&read_mutex
);
479 static int cramfs_readpage(struct file
*file
, struct page
* page
)
481 struct inode
*inode
= page
->mapping
->host
;
486 maxblock
= (inode
->i_size
+ PAGE_CACHE_SIZE
- 1) >> PAGE_CACHE_SHIFT
;
490 if (page
->index
< maxblock
) {
491 struct super_block
*sb
= inode
->i_sb
;
492 u32 blkptr_offset
= OFFSET(inode
) + page
->index
*4;
493 u32 start_offset
, compr_len
;
495 start_offset
= OFFSET(inode
) + maxblock
*4;
496 mutex_lock(&read_mutex
);
498 start_offset
= *(u32
*) cramfs_read(sb
, blkptr_offset
-4,
500 compr_len
= (*(u32
*) cramfs_read(sb
, blkptr_offset
, 4) -
502 mutex_unlock(&read_mutex
);
506 else if (unlikely(compr_len
> (PAGE_CACHE_SIZE
<< 1))) {
507 pr_err("cramfs: bad compressed blocksize %u\n",
511 mutex_lock(&read_mutex
);
512 bytes_filled
= cramfs_uncompress_block(pgdata
,
514 cramfs_read(sb
, start_offset
, compr_len
),
516 mutex_unlock(&read_mutex
);
517 if (unlikely(bytes_filled
< 0))
522 memset(pgdata
+ bytes_filled
, 0, PAGE_CACHE_SIZE
- bytes_filled
);
523 flush_dcache_page(page
);
525 SetPageUptodate(page
);
531 ClearPageUptodate(page
);
537 static const struct address_space_operations cramfs_aops
= {
538 .readpage
= cramfs_readpage
546 * A directory can only readdir
548 static const struct file_operations cramfs_directory_operations
= {
549 .llseek
= generic_file_llseek
,
550 .read
= generic_read_dir
,
551 .readdir
= cramfs_readdir
,
554 static const struct inode_operations cramfs_dir_inode_operations
= {
555 .lookup
= cramfs_lookup
,
558 static const struct super_operations cramfs_ops
= {
559 .put_super
= cramfs_put_super
,
560 .remount_fs
= cramfs_remount
,
561 .statfs
= cramfs_statfs
,
564 static struct dentry
*cramfs_mount(struct file_system_type
*fs_type
,
565 int flags
, const char *dev_name
, void *data
)
567 return mount_bdev(fs_type
, flags
, dev_name
, data
, cramfs_fill_super
);
570 static struct file_system_type cramfs_fs_type
= {
571 .owner
= THIS_MODULE
,
573 .mount
= cramfs_mount
,
574 .kill_sb
= kill_block_super
,
575 .fs_flags
= FS_REQUIRES_DEV
,
578 static int __init
init_cramfs_fs(void)
582 rv
= cramfs_uncompress_init();
585 rv
= register_filesystem(&cramfs_fs_type
);
587 cramfs_uncompress_exit();
591 static void __exit
exit_cramfs_fs(void)
593 cramfs_uncompress_exit();
594 unregister_filesystem(&cramfs_fs_type
);
597 module_init(init_cramfs_fs
)
598 module_exit(exit_cramfs_fs
)
599 MODULE_LICENSE("GPL");