a2ee8f9f5a387ed683733d1f8d434357a31b138f
[linux-2.6.git] / fs / cramfs / inode.c
1 /*
2  * Compressed rom filesystem for Linux.
3  *
4  * Copyright (C) 1999 Linus Torvalds.
5  *
6  * This file is released under the GPL.
7  */
8
9 /*
10  * These are the VFS interfaces to the compressed rom filesystem.
11  * The actual compression is based on zlib, see the other files.
12  */
13
14 #include <linux/module.h>
15 #include <linux/fs.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/vfs.h>
24 #include <linux/mutex.h>
25
26 #include <asm/uaccess.h>
27
28 static const struct super_operations cramfs_ops;
29 static const struct inode_operations cramfs_dir_inode_operations;
30 static const struct file_operations cramfs_directory_operations;
31 static const struct address_space_operations cramfs_aops;
32
33 static DEFINE_MUTEX(read_mutex);
34
35
36 /* These macros may change in future, to provide better st_ino semantics. */
37 #define OFFSET(x)       ((x)->i_ino)
38
39 static unsigned long cramino(const struct cramfs_inode *cino, unsigned int offset)
40 {
41         if (!cino->offset)
42                 return offset + 1;
43         if (!cino->size)
44                 return offset + 1;
45
46         /*
47          * The file mode test fixes buggy mkcramfs implementations where
48          * cramfs_inode->offset is set to a non zero value for entries
49          * which did not contain data, like devices node and fifos.
50          */
51         switch (cino->mode & S_IFMT) {
52         case S_IFREG:
53         case S_IFDIR:
54         case S_IFLNK:
55                 return cino->offset << 2;
56         default:
57                 break;
58         }
59         return offset + 1;
60 }
61
62 static struct inode *get_cramfs_inode(struct super_block *sb,
63         const struct cramfs_inode *cramfs_inode, unsigned int offset)
64 {
65         struct inode *inode;
66         static struct timespec zerotime;
67
68         inode = iget_locked(sb, cramino(cramfs_inode, offset));
69         if (!inode)
70                 return ERR_PTR(-ENOMEM);
71         if (!(inode->i_state & I_NEW))
72                 return inode;
73
74         switch (cramfs_inode->mode & S_IFMT) {
75         case S_IFREG:
76                 inode->i_fop = &generic_ro_fops;
77                 inode->i_data.a_ops = &cramfs_aops;
78                 break;
79         case S_IFDIR:
80                 inode->i_op = &cramfs_dir_inode_operations;
81                 inode->i_fop = &cramfs_directory_operations;
82                 break;
83         case S_IFLNK:
84                 inode->i_op = &page_symlink_inode_operations;
85                 inode->i_data.a_ops = &cramfs_aops;
86                 break;
87         default:
88                 init_special_inode(inode, cramfs_inode->mode,
89                                 old_decode_dev(cramfs_inode->size));
90         }
91
92         inode->i_mode = cramfs_inode->mode;
93         inode->i_uid = cramfs_inode->uid;
94         inode->i_gid = cramfs_inode->gid;
95
96         /* if the lower 2 bits are zero, the inode contains data */
97         if (!(inode->i_ino & 3)) {
98                 inode->i_size = cramfs_inode->size;
99                 inode->i_blocks = (cramfs_inode->size - 1) / 512 + 1;
100         }
101
102         /* Struct copy intentional */
103         inode->i_mtime = inode->i_atime = inode->i_ctime = zerotime;
104         /* inode->i_nlink is left 1 - arguably wrong for directories,
105            but it's the best we can do without reading the directory
106            contents.  1 yields the right result in GNU find, even
107            without -noleaf option. */
108
109         unlock_new_inode(inode);
110
111         return inode;
112 }
113
114 /*
115  * We have our own block cache: don't fill up the buffer cache
116  * with the rom-image, because the way the filesystem is set
117  * up the accesses should be fairly regular and cached in the
118  * page cache and dentry tree anyway..
119  *
120  * This also acts as a way to guarantee contiguous areas of up to
121  * BLKS_PER_BUF*PAGE_CACHE_SIZE, so that the caller doesn't need to
122  * worry about end-of-buffer issues even when decompressing a full
123  * page cache.
124  */
125 #define READ_BUFFERS (2)
126 /* NEXT_BUFFER(): Loop over [0..(READ_BUFFERS-1)]. */
127 #define NEXT_BUFFER(_ix) ((_ix) ^ 1)
128
129 /*
130  * BLKS_PER_BUF_SHIFT should be at least 2 to allow for "compressed"
131  * data that takes up more space than the original and with unlucky
132  * alignment.
133  */
134 #define BLKS_PER_BUF_SHIFT      (2)
135 #define BLKS_PER_BUF            (1 << BLKS_PER_BUF_SHIFT)
136 #define BUFFER_SIZE             (BLKS_PER_BUF*PAGE_CACHE_SIZE)
137
138 static unsigned char read_buffers[READ_BUFFERS][BUFFER_SIZE];
139 static unsigned buffer_blocknr[READ_BUFFERS];
140 static struct super_block * buffer_dev[READ_BUFFERS];
141 static int next_buffer;
142
143 /*
144  * Returns a pointer to a buffer containing at least LEN bytes of
145  * filesystem starting at byte offset OFFSET into the filesystem.
146  */
147 static void *cramfs_read(struct super_block *sb, unsigned int offset, unsigned int len)
148 {
149         struct address_space *mapping = sb->s_bdev->bd_inode->i_mapping;
150         struct page *pages[BLKS_PER_BUF];
151         unsigned i, blocknr, buffer;
152         unsigned long devsize;
153         char *data;
154
155         if (!len)
156                 return NULL;
157         blocknr = offset >> PAGE_CACHE_SHIFT;
158         offset &= PAGE_CACHE_SIZE - 1;
159
160         /* Check if an existing buffer already has the data.. */
161         for (i = 0; i < READ_BUFFERS; i++) {
162                 unsigned int blk_offset;
163
164                 if (buffer_dev[i] != sb)
165                         continue;
166                 if (blocknr < buffer_blocknr[i])
167                         continue;
168                 blk_offset = (blocknr - buffer_blocknr[i]) << PAGE_CACHE_SHIFT;
169                 blk_offset += offset;
170                 if (blk_offset + len > BUFFER_SIZE)
171                         continue;
172                 return read_buffers[i] + blk_offset;
173         }
174
175         devsize = mapping->host->i_size >> PAGE_CACHE_SHIFT;
176
177         /* Ok, read in BLKS_PER_BUF pages completely first. */
178         for (i = 0; i < BLKS_PER_BUF; i++) {
179                 struct page *page = NULL;
180
181                 if (blocknr + i < devsize) {
182                         page = read_mapping_page_async(mapping, blocknr + i,
183                                                                         NULL);
184                         /* synchronous error? */
185                         if (IS_ERR(page))
186                                 page = NULL;
187                 }
188                 pages[i] = page;
189         }
190
191         for (i = 0; i < BLKS_PER_BUF; i++) {
192                 struct page *page = pages[i];
193                 if (page) {
194                         wait_on_page_locked(page);
195                         if (!PageUptodate(page)) {
196                                 /* asynchronous error */
197                                 page_cache_release(page);
198                                 pages[i] = NULL;
199                         }
200                 }
201         }
202
203         buffer = next_buffer;
204         next_buffer = NEXT_BUFFER(buffer);
205         buffer_blocknr[buffer] = blocknr;
206         buffer_dev[buffer] = sb;
207
208         data = read_buffers[buffer];
209         for (i = 0; i < BLKS_PER_BUF; i++) {
210                 struct page *page = pages[i];
211                 if (page) {
212                         memcpy(data, kmap(page), PAGE_CACHE_SIZE);
213                         kunmap(page);
214                         page_cache_release(page);
215                 } else
216                         memset(data, 0, PAGE_CACHE_SIZE);
217                 data += PAGE_CACHE_SIZE;
218         }
219         return read_buffers[buffer] + offset;
220 }
221
222 static void cramfs_put_super(struct super_block *sb)
223 {
224         kfree(sb->s_fs_info);
225         sb->s_fs_info = NULL;
226 }
227
228 static int cramfs_remount(struct super_block *sb, int *flags, char *data)
229 {
230         *flags |= MS_RDONLY;
231         return 0;
232 }
233
234 static int cramfs_fill_super(struct super_block *sb, void *data, int silent)
235 {
236         int i;
237         struct cramfs_super super;
238         unsigned long root_offset;
239         struct cramfs_sb_info *sbi;
240         struct inode *root;
241
242         sb->s_flags |= MS_RDONLY;
243
244         sbi = kzalloc(sizeof(struct cramfs_sb_info), GFP_KERNEL);
245         if (!sbi)
246                 return -ENOMEM;
247         sb->s_fs_info = sbi;
248
249         /* Invalidate the read buffers on mount: think disk change.. */
250         mutex_lock(&read_mutex);
251         for (i = 0; i < READ_BUFFERS; i++)
252                 buffer_blocknr[i] = -1;
253
254         /* Read the first block and get the superblock from it */
255         memcpy(&super, cramfs_read(sb, 0, sizeof(super)), sizeof(super));
256         mutex_unlock(&read_mutex);
257
258         /* Do sanity checks on the superblock */
259         if (super.magic != CRAMFS_MAGIC) {
260                 /* check for wrong endianess */
261                 if (super.magic == CRAMFS_MAGIC_WEND) {
262                         if (!silent)
263                                 printk(KERN_ERR "cramfs: wrong endianess\n");
264                         goto out;
265                 }
266
267                 /* check at 512 byte offset */
268                 mutex_lock(&read_mutex);
269                 memcpy(&super, cramfs_read(sb, 512, sizeof(super)), sizeof(super));
270                 mutex_unlock(&read_mutex);
271                 if (super.magic != CRAMFS_MAGIC) {
272                         if (super.magic == CRAMFS_MAGIC_WEND && !silent)
273                                 printk(KERN_ERR "cramfs: wrong endianess\n");
274                         else if (!silent)
275                                 printk(KERN_ERR "cramfs: wrong magic\n");
276                         goto out;
277                 }
278         }
279
280         /* get feature flags first */
281         if (super.flags & ~CRAMFS_SUPPORTED_FLAGS) {
282                 printk(KERN_ERR "cramfs: unsupported filesystem features\n");
283                 goto out;
284         }
285
286         /* Check that the root inode is in a sane state */
287         if (!S_ISDIR(super.root.mode)) {
288                 printk(KERN_ERR "cramfs: root is not a directory\n");
289                 goto out;
290         }
291         /* correct strange, hard-coded permissions of mkcramfs */
292         super.root.mode |= (S_IRUSR | S_IXUSR | S_IRGRP | S_IXGRP | S_IROTH | S_IXOTH);
293
294         root_offset = super.root.offset << 2;
295         if (super.flags & CRAMFS_FLAG_FSID_VERSION_2) {
296                 sbi->size=super.size;
297                 sbi->blocks=super.fsid.blocks;
298                 sbi->files=super.fsid.files;
299         } else {
300                 sbi->size=1<<28;
301                 sbi->blocks=0;
302                 sbi->files=0;
303         }
304         sbi->magic=super.magic;
305         sbi->flags=super.flags;
306         if (root_offset == 0)
307                 printk(KERN_INFO "cramfs: empty filesystem");
308         else if (!(super.flags & CRAMFS_FLAG_SHIFTED_ROOT_OFFSET) &&
309                  ((root_offset != sizeof(struct cramfs_super)) &&
310                   (root_offset != 512 + sizeof(struct cramfs_super))))
311         {
312                 printk(KERN_ERR "cramfs: bad root offset %lu\n", root_offset);
313                 goto out;
314         }
315
316         /* Set it all up.. */
317         sb->s_op = &cramfs_ops;
318         root = get_cramfs_inode(sb, &super.root, 0);
319         if (IS_ERR(root))
320                 goto out;
321         sb->s_root = d_alloc_root(root);
322         if (!sb->s_root) {
323                 iput(root);
324                 goto out;
325         }
326         return 0;
327 out:
328         kfree(sbi);
329         sb->s_fs_info = NULL;
330         return -EINVAL;
331 }
332
333 static int cramfs_statfs(struct dentry *dentry, struct kstatfs *buf)
334 {
335         struct super_block *sb = dentry->d_sb;
336         u64 id = huge_encode_dev(sb->s_bdev->bd_dev);
337
338         buf->f_type = CRAMFS_MAGIC;
339         buf->f_bsize = PAGE_CACHE_SIZE;
340         buf->f_blocks = CRAMFS_SB(sb)->blocks;
341         buf->f_bfree = 0;
342         buf->f_bavail = 0;
343         buf->f_files = CRAMFS_SB(sb)->files;
344         buf->f_ffree = 0;
345         buf->f_fsid.val[0] = (u32)id;
346         buf->f_fsid.val[1] = (u32)(id >> 32);
347         buf->f_namelen = CRAMFS_MAXPATHLEN;
348         return 0;
349 }
350
351 /*
352  * Read a cramfs directory entry.
353  */
354 static int cramfs_readdir(struct file *filp, void *dirent, filldir_t filldir)
355 {
356         struct inode *inode = filp->f_path.dentry->d_inode;
357         struct super_block *sb = inode->i_sb;
358         char *buf;
359         unsigned int offset;
360         int copied;
361
362         /* Offset within the thing. */
363         offset = filp->f_pos;
364         if (offset >= inode->i_size)
365                 return 0;
366         /* Directory entries are always 4-byte aligned */
367         if (offset & 3)
368                 return -EINVAL;
369
370         buf = kmalloc(CRAMFS_MAXPATHLEN, GFP_KERNEL);
371         if (!buf)
372                 return -ENOMEM;
373
374         copied = 0;
375         while (offset < inode->i_size) {
376                 struct cramfs_inode *de;
377                 unsigned long nextoffset;
378                 char *name;
379                 ino_t ino;
380                 umode_t mode;
381                 int namelen, error;
382
383                 mutex_lock(&read_mutex);
384                 de = cramfs_read(sb, OFFSET(inode) + offset, sizeof(*de)+CRAMFS_MAXPATHLEN);
385                 name = (char *)(de+1);
386
387                 /*
388                  * Namelengths on disk are shifted by two
389                  * and the name padded out to 4-byte boundaries
390                  * with zeroes.
391                  */
392                 namelen = de->namelen << 2;
393                 memcpy(buf, name, namelen);
394                 ino = cramino(de, OFFSET(inode) + offset);
395                 mode = de->mode;
396                 mutex_unlock(&read_mutex);
397                 nextoffset = offset + sizeof(*de) + namelen;
398                 for (;;) {
399                         if (!namelen) {
400                                 kfree(buf);
401                                 return -EIO;
402                         }
403                         if (buf[namelen-1])
404                                 break;
405                         namelen--;
406                 }
407                 error = filldir(dirent, buf, namelen, offset, ino, mode >> 12);
408                 if (error)
409                         break;
410
411                 offset = nextoffset;
412                 filp->f_pos = offset;
413                 copied++;
414         }
415         kfree(buf);
416         return 0;
417 }
418
419 /*
420  * Lookup and fill in the inode data..
421  */
422 static struct dentry * cramfs_lookup(struct inode *dir, struct dentry *dentry, struct nameidata *nd)
423 {
424         unsigned int offset = 0;
425         struct inode *inode = NULL;
426         int sorted;
427
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;
432                 char *name;
433                 int namelen, retval;
434                 int dir_off = OFFSET(dir) + offset;
435
436                 de = cramfs_read(dir->i_sb, dir_off, sizeof(*de)+CRAMFS_MAXPATHLEN);
437                 name = (char *)(de+1);
438
439                 /* Try to take advantage of sorted directories */
440                 if (sorted && (dentry->d_name.name[0] < name[0]))
441                         break;
442
443                 namelen = de->namelen << 2;
444                 offset += sizeof(*de) + namelen;
445
446                 /* Quick check that the name is roughly the right length */
447                 if (((dentry->d_name.len + 3) & ~3) != namelen)
448                         continue;
449
450                 for (;;) {
451                         if (!namelen) {
452                                 inode = ERR_PTR(-EIO);
453                                 goto out;
454                         }
455                         if (name[namelen-1])
456                                 break;
457                         namelen--;
458                 }
459                 if (namelen != dentry->d_name.len)
460                         continue;
461                 retval = memcmp(dentry->d_name.name, name, namelen);
462                 if (retval > 0)
463                         continue;
464                 if (!retval) {
465                         inode = get_cramfs_inode(dir->i_sb, de, dir_off);
466                         break;
467                 }
468                 /* else (retval < 0) */
469                 if (sorted)
470                         break;
471         }
472 out:
473         mutex_unlock(&read_mutex);
474         if (IS_ERR(inode))
475                 return ERR_CAST(inode);
476         d_add(dentry, inode);
477         return NULL;
478 }
479
480 static int cramfs_readpage(struct file *file, struct page * page)
481 {
482         struct inode *inode = page->mapping->host;
483         u32 maxblock;
484         int bytes_filled;
485         void *pgdata;
486
487         maxblock = (inode->i_size + PAGE_CACHE_SIZE - 1) >> PAGE_CACHE_SHIFT;
488         bytes_filled = 0;
489         pgdata = kmap(page);
490
491         if (page->index < maxblock) {
492                 struct super_block *sb = inode->i_sb;
493                 u32 blkptr_offset = OFFSET(inode) + page->index*4;
494                 u32 start_offset, compr_len;
495
496                 start_offset = OFFSET(inode) + maxblock*4;
497                 mutex_lock(&read_mutex);
498                 if (page->index)
499                         start_offset = *(u32 *) cramfs_read(sb, blkptr_offset-4,
500                                 4);
501                 compr_len = (*(u32 *) cramfs_read(sb, blkptr_offset, 4) -
502                         start_offset);
503                 mutex_unlock(&read_mutex);
504
505                 if (compr_len == 0)
506                         ; /* hole */
507                 else if (unlikely(compr_len > (PAGE_CACHE_SIZE << 1))) {
508                         pr_err("cramfs: bad compressed blocksize %u\n",
509                                 compr_len);
510                         goto err;
511                 } else {
512                         mutex_lock(&read_mutex);
513                         bytes_filled = cramfs_uncompress_block(pgdata,
514                                  PAGE_CACHE_SIZE,
515                                  cramfs_read(sb, start_offset, compr_len),
516                                  compr_len);
517                         mutex_unlock(&read_mutex);
518                         if (unlikely(bytes_filled < 0))
519                                 goto err;
520                 }
521         }
522
523         memset(pgdata + bytes_filled, 0, PAGE_CACHE_SIZE - bytes_filled);
524         flush_dcache_page(page);
525         kunmap(page);
526         SetPageUptodate(page);
527         unlock_page(page);
528         return 0;
529
530 err:
531         kunmap(page);
532         ClearPageUptodate(page);
533         SetPageError(page);
534         unlock_page(page);
535         return 0;
536 }
537
538 static const struct address_space_operations cramfs_aops = {
539         .readpage = cramfs_readpage
540 };
541
542 /*
543  * Our operations:
544  */
545
546 /*
547  * A directory can only readdir
548  */
549 static const struct file_operations cramfs_directory_operations = {
550         .llseek         = generic_file_llseek,
551         .read           = generic_read_dir,
552         .readdir        = cramfs_readdir,
553 };
554
555 static const struct inode_operations cramfs_dir_inode_operations = {
556         .lookup         = cramfs_lookup,
557 };
558
559 static const struct super_operations cramfs_ops = {
560         .put_super      = cramfs_put_super,
561         .remount_fs     = cramfs_remount,
562         .statfs         = cramfs_statfs,
563 };
564
565 static struct dentry *cramfs_mount(struct file_system_type *fs_type,
566         int flags, const char *dev_name, void *data)
567 {
568         return mount_bdev(fs_type, flags, dev_name, data, cramfs_fill_super);
569 }
570
571 static struct file_system_type cramfs_fs_type = {
572         .owner          = THIS_MODULE,
573         .name           = "cramfs",
574         .mount          = cramfs_mount,
575         .kill_sb        = kill_block_super,
576         .fs_flags       = FS_REQUIRES_DEV,
577 };
578
579 static int __init init_cramfs_fs(void)
580 {
581         int rv;
582
583         rv = cramfs_uncompress_init();
584         if (rv < 0)
585                 return rv;
586         rv = register_filesystem(&cramfs_fs_type);
587         if (rv < 0)
588                 cramfs_uncompress_exit();
589         return rv;
590 }
591
592 static void __exit exit_cramfs_fs(void)
593 {
594         cramfs_uncompress_exit();
595         unregister_filesystem(&cramfs_fs_type);
596 }
597
598 module_init(init_cramfs_fs)
599 module_exit(exit_cramfs_fs)
600 MODULE_LICENSE("GPL");