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