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