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