grub-core/fs/ext2.c

   1 /* ext2.c - Second Extended filesystem */
   2 /*
   3  *  GRUB  --  GRand Unified Bootloader
   4  *  Copyright (C) 2003,2004,2005,2007,2008,2009  Free Software Foundation, Inc.
   5  *
   6  *  GRUB is free software: you can redistribute it and/or modify
   7  *  it under the terms of the GNU General Public License as published by
   8  *  the Free Software Foundation, either version 3 of the License, or
   9  *  (at your option) any later version.
  10  *
  11  *  GRUB is distributed in the hope that it will be useful,
  12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  *  GNU General Public License for more details.
  15  *
  16  *  You should have received a copy of the GNU General Public License
  17  *  along with GRUB.  If not, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 /* Magic value used to identify an ext2 filesystem.  */
  21 #define EXT2_MAGIC              0xEF53
  22 /* Amount of indirect blocks in an inode.  */
  23 #define INDIRECT_BLOCKS         12
  24
  25 /* The good old revision and the default inode size.  */
  26 #define EXT2_GOOD_OLD_REVISION          0
  27 #define EXT2_GOOD_OLD_INODE_SIZE        128
  28
  29 /* Filetype used in directory entry.  */
  30 #define FILETYPE_UNKNOWN        0
  31 #define FILETYPE_REG            1
  32 #define FILETYPE_DIRECTORY      2
  33 #define FILETYPE_SYMLINK        7
  34
  35 /* Filetype information as used in inodes.  */
  36 #define FILETYPE_INO_MASK       0170000
  37 #define FILETYPE_INO_REG        0100000
  38 #define FILETYPE_INO_DIRECTORY  0040000
  39 #define FILETYPE_INO_SYMLINK    0120000
  40
  41 #include <grub/err.h>
  42 #include <grub/file.h>
  43 #include <grub/mm.h>
  44 #include <grub/misc.h>
  45 #include <grub/disk.h>
  46 #include <grub/dl.h>
  47 #include <grub/types.h>
  48 #include <grub/fshelp.h>
  49
  50 GRUB_MOD_LICENSE ("GPLv3+");
  51
  52 /* Log2 size of ext2 block in 512 blocks.  */
  53 #define LOG2_EXT2_BLOCK_SIZE(data)                      \
  54         (grub_le_to_cpu32 (data->sblock.log2_block_size) + 1)
  55
  56 /* Log2 size of ext2 block in bytes.  */
  57 #define LOG2_BLOCK_SIZE(data)                                   \
  58         (grub_le_to_cpu32 (data->sblock.log2_block_size) + 10)
  59
  60 /* The size of an ext2 block in bytes.  */
  61 #define EXT2_BLOCK_SIZE(data)           (1U << LOG2_BLOCK_SIZE (data))
  62
  63 /* The revision level.  */
  64 #define EXT2_REVISION(data)     grub_le_to_cpu32 (data->sblock.revision_level)
  65
  66 /* The inode size.  */
  67 #define EXT2_INODE_SIZE(data)   \
  68   (data->sblock.revision_level \
  69    == grub_cpu_to_le32_compile_time (EXT2_GOOD_OLD_REVISION)    \
  70          ? EXT2_GOOD_OLD_INODE_SIZE \
  71          : grub_le_to_cpu16 (data->sblock.inode_size))
  72
  73 /* Superblock filesystem feature flags (RW compatible)
  74  * A filesystem with any of these enabled can be read and written by a driver
  75  * that does not understand them without causing metadata/data corruption.  */
  76 #define EXT2_FEATURE_COMPAT_DIR_PREALLOC        0x0001
  77 #define EXT2_FEATURE_COMPAT_IMAGIC_INODES       0x0002
  78 #define EXT3_FEATURE_COMPAT_HAS_JOURNAL         0x0004
  79 #define EXT2_FEATURE_COMPAT_EXT_ATTR            0x0008
  80 #define EXT2_FEATURE_COMPAT_RESIZE_INODE        0x0010
  81 #define EXT2_FEATURE_COMPAT_DIR_INDEX           0x0020
  82 /* Superblock filesystem feature flags (RO compatible)
  83  * A filesystem with any of these enabled can be safely read by a driver that
  84  * does not understand them, but should not be written to, usually because
  85  * additional metadata is required.  */
  86 #define EXT2_FEATURE_RO_COMPAT_SPARSE_SUPER     0x0001
  87 #define EXT2_FEATURE_RO_COMPAT_LARGE_FILE       0x0002
  88 #define EXT2_FEATURE_RO_COMPAT_BTREE_DIR        0x0004
  89 #define EXT4_FEATURE_RO_COMPAT_GDT_CSUM         0x0010
  90 #define EXT4_FEATURE_RO_COMPAT_DIR_NLINK        0x0020
  91 #define EXT4_FEATURE_RO_COMPAT_EXTRA_ISIZE      0x0040
  92 /* Superblock filesystem feature flags (back-incompatible)
  93  * A filesystem with any of these enabled should not be attempted to be read
  94  * by a driver that does not understand them, since they usually indicate
  95  * metadata format changes that might confuse the reader.  */
  96 #define EXT2_FEATURE_INCOMPAT_COMPRESSION       0x0001
  97 #define EXT2_FEATURE_INCOMPAT_FILETYPE          0x0002
  98 #define EXT3_FEATURE_INCOMPAT_RECOVER           0x0004 /* Needs recovery */
  99 #define EXT3_FEATURE_INCOMPAT_JOURNAL_DEV       0x0008 /* Volume is journal device */
 100 #define EXT2_FEATURE_INCOMPAT_META_BG           0x0010
 101 #define EXT4_FEATURE_INCOMPAT_EXTENTS           0x0040 /* Extents used */
 102 #define EXT4_FEATURE_INCOMPAT_64BIT             0x0080
 103 #define EXT4_FEATURE_INCOMPAT_MMP               0x0100
 104 #define EXT4_FEATURE_INCOMPAT_FLEX_BG           0x0200
 105
 106 /* The set of back-incompatible features this driver DOES support. Add (OR)
 107  * flags here as the related features are implemented into the driver.  */
 108 #define EXT2_DRIVER_SUPPORTED_INCOMPAT ( EXT2_FEATURE_INCOMPAT_FILETYPE \
 109                                        | EXT4_FEATURE_INCOMPAT_EXTENTS  \
 110                                        | EXT4_FEATURE_INCOMPAT_FLEX_BG \
 111                                        | EXT2_FEATURE_INCOMPAT_META_BG \
 112                                        | EXT4_FEATURE_INCOMPAT_64BIT)
 113 /* List of rationales for the ignored "incompatible" features:
 114  * needs_recovery: Not really back-incompatible - was added as such to forbid
 115  *                 ext2 drivers from mounting an ext3 volume with a dirty
 116  *                 journal because they will ignore the journal, but the next
 117  *                 ext3 driver to mount the volume will find the journal and
 118  *                 replay it, potentially corrupting the metadata written by
 119  *                 the ext2 drivers. Safe to ignore for this RO driver.
 120  * mmp:            Not really back-incompatible - was added as such to
 121  *                 avoid multiple read-write mounts. Safe to ignore for this
 122  *                 RO driver.
 123  */
 124 #define EXT2_DRIVER_IGNORED_INCOMPAT ( EXT3_FEATURE_INCOMPAT_RECOVER \
 125                                      | EXT4_FEATURE_INCOMPAT_MMP)
 126
 127
 128 #define EXT3_JOURNAL_MAGIC_NUMBER       0xc03b3998U
 129
 130 #define EXT3_JOURNAL_DESCRIPTOR_BLOCK   1
 131 #define EXT3_JOURNAL_COMMIT_BLOCK       2
 132 #define EXT3_JOURNAL_SUPERBLOCK_V1      3
 133 #define EXT3_JOURNAL_SUPERBLOCK_V2      4
 134 #define EXT3_JOURNAL_REVOKE_BLOCK       5
 135
 136 #define EXT3_JOURNAL_FLAG_ESCAPE        1
 137 #define EXT3_JOURNAL_FLAG_SAME_UUID     2
 138 #define EXT3_JOURNAL_FLAG_DELETED       4
 139 #define EXT3_JOURNAL_FLAG_LAST_TAG      8
 140
 141 #define EXT4_EXTENTS_FLAG               0x80000
 142
 143 /* The ext2 superblock.  */
 144 struct grub_ext2_sblock
 145 {
 146   grub_uint32_t total_inodes;
 147   grub_uint32_t total_blocks;
 148   grub_uint32_t reserved_blocks;
 149   grub_uint32_t free_blocks;
 150   grub_uint32_t free_inodes;
 151   grub_uint32_t first_data_block;
 152   grub_uint32_t log2_block_size;
 153   grub_uint32_t log2_fragment_size;
 154   grub_uint32_t blocks_per_group;
 155   grub_uint32_t fragments_per_group;
 156   grub_uint32_t inodes_per_group;
 157   grub_uint32_t mtime;
 158   grub_uint32_t utime;
 159   grub_uint16_t mnt_count;
 160   grub_uint16_t max_mnt_count;
 161   grub_uint16_t magic;
 162   grub_uint16_t fs_state;
 163   grub_uint16_t error_handling;
 164   grub_uint16_t minor_revision_level;
 165   grub_uint32_t lastcheck;
 166   grub_uint32_t checkinterval;
 167   grub_uint32_t creator_os;
 168   grub_uint32_t revision_level;
 169   grub_uint16_t uid_reserved;
 170   grub_uint16_t gid_reserved;
 171   grub_uint32_t first_inode;
 172   grub_uint16_t inode_size;
 173   grub_uint16_t block_group_number;
 174   grub_uint32_t feature_compatibility;
 175   grub_uint32_t feature_incompat;
 176   grub_uint32_t feature_ro_compat;
 177   grub_uint16_t uuid[8];
 178   char volume_name[16];
 179   char last_mounted_on[64];
 180   grub_uint32_t compression_info;
 181   grub_uint8_t prealloc_blocks;
 182   grub_uint8_t prealloc_dir_blocks;
 183   grub_uint16_t reserved_gdt_blocks;
 184   grub_uint8_t journal_uuid[16];
 185   grub_uint32_t journal_inum;
 186   grub_uint32_t journal_dev;
 187   grub_uint32_t last_orphan;
 188   grub_uint32_t hash_seed[4];
 189   grub_uint8_t def_hash_version;
 190   grub_uint8_t jnl_backup_type;
 191   grub_uint16_t group_desc_size;
 192   grub_uint32_t default_mount_opts;
 193   grub_uint32_t first_meta_bg;
 194   grub_uint32_t mkfs_time;
 195   grub_uint32_t jnl_blocks[17];
 196 };
 197
 198 /* The ext2 blockgroup.  */
 199 struct grub_ext2_block_group
 200 {
 201   grub_uint32_t block_id;
 202   grub_uint32_t inode_id;
 203   grub_uint32_t inode_table_id;
 204   grub_uint16_t free_blocks;
 205   grub_uint16_t free_inodes;
 206   grub_uint16_t used_dirs;
 207   grub_uint16_t pad;
 208   grub_uint32_t reserved[3];
 209   grub_uint32_t block_id_hi;
 210   grub_uint32_t inode_id_hi;
 211   grub_uint32_t inode_table_id_hi;
 212   grub_uint16_t free_blocks_hi;
 213   grub_uint16_t free_inodes_hi;
 214   grub_uint16_t used_dirs_hi;
 215   grub_uint16_t pad2;
 216   grub_uint32_t reserved2[3];
 217 };
 218
 219 /* The ext2 inode.  */
 220 struct grub_ext2_inode
 221 {
 222   grub_uint16_t mode;
 223   grub_uint16_t uid;
 224   grub_uint32_t size;
 225   grub_uint32_t atime;
 226   grub_uint32_t ctime;
 227   grub_uint32_t mtime;
 228   grub_uint32_t dtime;
 229   grub_uint16_t gid;
 230   grub_uint16_t nlinks;
 231   grub_uint32_t blockcnt;  /* Blocks of 512 bytes!! */
 232   grub_uint32_t flags;
 233   grub_uint32_t osd1;
 234   union
 235   {
 236     struct datablocks
 237     {
 238       grub_uint32_t dir_blocks[INDIRECT_BLOCKS];
 239       grub_uint32_t indir_block;
 240       grub_uint32_t double_indir_block;
 241       grub_uint32_t triple_indir_block;
 242     } blocks;
 243     char symlink[60];
 244   };
 245   grub_uint32_t version;
 246   grub_uint32_t acl;
 247   grub_uint32_t size_high;
 248   grub_uint32_t fragment_addr;
 249   grub_uint32_t osd2[3];
 250 };
 251
 252 /* The header of an ext2 directory entry.  */
 253 struct ext2_dirent
 254 {
 255   grub_uint32_t inode;
 256   grub_uint16_t direntlen;
 257 #define MAX_NAMELEN 255
 258   grub_uint8_t namelen;
 259   grub_uint8_t filetype;
 260 };
 261
 262 struct grub_ext3_journal_header
 263 {
 264   grub_uint32_t magic;
 265   grub_uint32_t block_type;
 266   grub_uint32_t sequence;
 267 };
 268
 269 struct grub_ext3_journal_revoke_header
 270 {
 271   struct grub_ext3_journal_header header;
 272   grub_uint32_t count;
 273   grub_uint32_t data[0];
 274 };
 275
 276 struct grub_ext3_journal_block_tag
 277 {
 278   grub_uint32_t block;
 279   grub_uint32_t flags;
 280 };
 281
 282 struct grub_ext3_journal_sblock
 283 {
 284   struct grub_ext3_journal_header header;
 285   grub_uint32_t block_size;
 286   grub_uint32_t maxlen;
 287   grub_uint32_t first;
 288   grub_uint32_t sequence;
 289   grub_uint32_t start;
 290 };
 291
 292 #define EXT4_EXT_MAGIC          0xf30a
 293
 294 struct grub_ext4_extent_header
 295 {
 296   grub_uint16_t magic;
 297   grub_uint16_t entries;
 298   grub_uint16_t max;
 299   grub_uint16_t depth;
 300   grub_uint32_t generation;
 301 };
 302
 303 struct grub_ext4_extent
 304 {
 305   grub_uint32_t block;
 306   grub_uint16_t len;
 307   grub_uint16_t start_hi;
 308   grub_uint32_t start;
 309 };
 310
 311 struct grub_ext4_extent_idx
 312 {
 313   grub_uint32_t block;
 314   grub_uint32_t leaf;
 315   grub_uint16_t leaf_hi;
 316   grub_uint16_t unused;
 317 };
 318
 319 struct grub_fshelp_node
 320 {
 321   struct grub_ext2_data *data;
 322   struct grub_ext2_inode inode;
 323   int ino;
 324   int inode_read;
 325 };
 326
 327 /* Information about a "mounted" ext2 filesystem.  */
 328 struct grub_ext2_data
 329 {
 330   struct grub_ext2_sblock sblock;
 331   int log_group_desc_size;
 332   grub_disk_t disk;
 333   struct grub_ext2_inode *inode;
 334   struct grub_fshelp_node diropen;
 335 };
 336
 337 static grub_dl_t my_mod;
 338
 339 \f
 340
 341 /* Check is a = b^x for some x.  */
 342 static inline int
 343 is_power_of (grub_uint64_t a, grub_uint32_t b)
 344 {
 345   grub_uint64_t c;
 346   /* Prevent overflow assuming b < 8.  */
 347   if (a >= (1LL << 60))
 348     return 0;
 349   for (c = 1; c <= a; c *= b);
 350   return (c == a);
 351 }
 352
 353
 354 static inline int
 355 group_has_super_block (struct grub_ext2_data *data, grub_uint64_t group)
 356 {
 357   if (!(data->sblock.feature_ro_compat
 358         & grub_cpu_to_le32_compile_time(EXT2_FEATURE_RO_COMPAT_SPARSE_SUPER)))
 359     return 1;
 360   /* Algorithm looked up in Linux source.  */
 361   if (group <= 1)
 362     return 1;
 363   /* Even number is never a power of odd number.  */
 364   if (!(group & 1))
 365     return 0;
 366   return (is_power_of(group, 7) || is_power_of(group, 5) ||
 367           is_power_of(group, 3));
 368 }
 369
 370 /* Read into BLKGRP the blockgroup descriptor of blockgroup GROUP of
 371    the mounted filesystem DATA.  */
 372 inline static grub_err_t
 373 grub_ext2_blockgroup (struct grub_ext2_data *data, grub_uint64_t group,
 374                       struct grub_ext2_block_group *blkgrp)
 375 {
 376   grub_uint64_t full_offset = (group << data->log_group_desc_size);
 377   grub_uint64_t block, offset;
 378   block = (full_offset >> LOG2_BLOCK_SIZE (data));
 379   offset = (full_offset & ((1 << LOG2_BLOCK_SIZE (data)) - 1));
 380   if ((data->sblock.feature_incompat
 381        & grub_cpu_to_le32_compile_time (EXT2_FEATURE_INCOMPAT_META_BG))
 382       && block >= grub_le_to_cpu32(data->sblock.first_meta_bg))
 383     {
 384       grub_uint64_t first_block_group;
 385       /* Find the first block group for which a descriptor
 386          is stored in given block. */
 387       first_block_group = (block << (LOG2_BLOCK_SIZE (data)
 388                                      - data->log_group_desc_size));
 389
 390       block = (first_block_group
 391                * grub_le_to_cpu32(data->sblock.blocks_per_group));
 392
 393       if (group_has_super_block (data, first_block_group))
 394         block++;
 395     }
 396   else
 397     /* Superblock.  */
 398     block++;
 399   return grub_disk_read (data->disk,
 400                          ((grub_le_to_cpu32 (data->sblock.first_data_block)
 401                            + block)
 402                           << LOG2_EXT2_BLOCK_SIZE (data)), offset,
 403                          sizeof (struct grub_ext2_block_group), blkgrp);
 404 }
 405
 406 static struct grub_ext4_extent_header *
 407 grub_ext4_find_leaf (struct grub_ext2_data *data,
 408                      struct grub_ext4_extent_header *ext_block,
 409                      grub_uint32_t fileblock)
 410 {
 411   struct grub_ext4_extent_idx *index;
 412   void *buf = NULL;
 413
 414   while (1)
 415     {
 416       int i;
 417       grub_disk_addr_t block;
 418
 419       index = (struct grub_ext4_extent_idx *) (ext_block + 1);
 420
 421       if (ext_block->magic != grub_cpu_to_le16_compile_time (EXT4_EXT_MAGIC))
 422         goto fail;
 423
 424       if (ext_block->depth == 0)
 425         return ext_block;
 426
 427       for (i = 0; i < grub_le_to_cpu16 (ext_block->entries); i++)
 428         {
 429           if (fileblock < grub_le_to_cpu32(index[i].block))
 430             break;
 431         }
 432
 433       if (--i < 0)
 434         goto fail;
 435
 436       block = grub_le_to_cpu16 (index[i].leaf_hi);
 437       block = (block << 32) | grub_le_to_cpu32 (index[i].leaf);
 438       if (!buf)
 439         buf = grub_malloc (EXT2_BLOCK_SIZE(data));
 440       if (!buf)
 441         goto fail;
 442       if (grub_disk_read (data->disk,
 443                           block << LOG2_EXT2_BLOCK_SIZE (data),
 444                           0, EXT2_BLOCK_SIZE(data), buf))
 445         goto fail;
 446
 447       ext_block = buf;
 448     }
 449  fail:
 450   grub_free (buf);
 451   return 0;
 452 }
 453
 454 static grub_disk_addr_t
 455 grub_ext2_read_block (grub_fshelp_node_t node, grub_disk_addr_t fileblock)
 456 {
 457   struct grub_ext2_data *data = node->data;
 458   struct grub_ext2_inode *inode = &node->inode;
 459   unsigned int blksz = EXT2_BLOCK_SIZE (data);
 460   grub_disk_addr_t blksz_quarter = blksz / 4;
 461   int log2_blksz = LOG2_EXT2_BLOCK_SIZE (data);
 462   int log_perblock = log2_blksz + 9 - 2;
 463   grub_uint32_t indir;
 464   int shift;
 465
 466   if (inode->flags & grub_cpu_to_le32_compile_time (EXT4_EXTENTS_FLAG))
 467     {
 468       struct grub_ext4_extent_header *leaf;
 469       struct grub_ext4_extent *ext;
 470       int i;
 471       grub_disk_addr_t ret;
 472
 473       leaf = grub_ext4_find_leaf (data, (struct grub_ext4_extent_header *) inode->blocks.dir_blocks, fileblock);
 474       if (! leaf)
 475         {
 476           grub_error (GRUB_ERR_BAD_FS, "invalid extent");
 477           return -1;
 478         }
 479
 480       ext = (struct grub_ext4_extent *) (leaf + 1);
 481       for (i = 0; i < grub_le_to_cpu16 (leaf->entries); i++)
 482         {
 483           if (fileblock < grub_le_to_cpu32 (ext[i].block))
 484             break;
 485         }
 486
 487       if (--i >= 0)
 488         {
 489           fileblock -= grub_le_to_cpu32 (ext[i].block);
 490           if (fileblock >= grub_le_to_cpu16 (ext[i].len))
 491             ret = 0;
 492           else
 493             {
 494               grub_disk_addr_t start;
 495
 496               start = grub_le_to_cpu16 (ext[i].start_hi);
 497               start = (start << 32) + grub_le_to_cpu32 (ext[i].start);
 498
 499               ret = fileblock + start;
 500             }
 501         }
 502       else
 503         {
 504           grub_error (GRUB_ERR_BAD_FS, "something wrong with extent");
 505           ret = -1;
 506         }
 507
 508       if (leaf != (struct grub_ext4_extent_header *) inode->blocks.dir_blocks)
 509         grub_free (leaf);
 510
 511       return ret;
 512     }
 513
 514   /* Direct blocks.  */
 515   if (fileblock < INDIRECT_BLOCKS)
 516     return grub_le_to_cpu32 (inode->blocks.dir_blocks[fileblock]);
 517   fileblock -= INDIRECT_BLOCKS;
 518   /* Indirect.  */
 519   if (fileblock < blksz_quarter)
 520     {
 521       indir = inode->blocks.indir_block;
 522       shift = 0;
 523       goto indirect;
 524     }
 525   fileblock -= blksz_quarter;
 526   /* Double indirect.  */
 527   if (fileblock < blksz_quarter * blksz_quarter)
 528     {
 529       indir = inode->blocks.double_indir_block;
 530       shift = 1;
 531       goto indirect;
 532     }
 533   fileblock -= blksz_quarter * blksz_quarter;
 534   /* Triple indirect.  */
 535   if (fileblock < blksz_quarter * blksz_quarter * (blksz_quarter + 1))
 536     {
 537       indir = inode->blocks.triple_indir_block;
 538       shift = 2;
 539       goto indirect;
 540     }
 541   grub_error (GRUB_ERR_BAD_FS,
 542               "ext2fs doesn't support quadruple indirect blocks");
 543   return -1;
 544
 545 indirect:
 546   do {
 547     /* If the indirect block is zero, all child blocks are absent
 548        (i.e. filled with zeros.) */
 549     if (indir == 0)
 550       return 0;
 551     if (grub_disk_read (data->disk,
 552                         ((grub_disk_addr_t) grub_le_to_cpu32 (indir))
 553                         << log2_blksz,
 554                         ((fileblock >> (log_perblock * shift))
 555                          & ((1 << log_perblock) - 1))
 556                         * sizeof (indir),
 557                         sizeof (indir), &indir))
 558       return -1;
 559   } while (shift--);
 560
 561   return grub_le_to_cpu32 (indir);
 562 }
 563
 564 /* Read LEN bytes from the file described by DATA starting with byte
 565    POS.  Return the amount of read bytes in READ.  */
 566 static grub_ssize_t
 567 grub_ext2_read_file (grub_fshelp_node_t node,
 568                      grub_disk_read_hook_t read_hook, void *read_hook_data,
 569                      grub_off_t pos, grub_size_t len, char *buf)
 570 {
 571   return grub_fshelp_read_file (node->data->disk, node,
 572                                 read_hook, read_hook_data,
 573                                 pos, len, buf, grub_ext2_read_block,
 574                                 grub_cpu_to_le32 (node->inode.size)
 575                                 | (((grub_off_t) grub_cpu_to_le32 (node->inode.size_high)) << 32),
 576                                 LOG2_EXT2_BLOCK_SIZE (node->data), 0);
 577
 578 }
 579
 580
 581 /* Read the inode INO for the file described by DATA into INODE.  */
 582 static grub_err_t
 583 grub_ext2_read_inode (struct grub_ext2_data *data,
 584                       int ino, struct grub_ext2_inode *inode)
 585 {
 586   struct grub_ext2_block_group blkgrp;
 587   struct grub_ext2_sblock *sblock = &data->sblock;
 588   int inodes_per_block;
 589   unsigned int blkno;
 590   unsigned int blkoff;
 591   grub_disk_addr_t base;
 592
 593   /* It is easier to calculate if the first inode is 0.  */
 594   ino--;
 595
 596   grub_ext2_blockgroup (data,
 597                         ino / grub_le_to_cpu32 (sblock->inodes_per_group),
 598                         &blkgrp);
 599   if (grub_errno)
 600     return grub_errno;
 601
 602   inodes_per_block = EXT2_BLOCK_SIZE (data) / EXT2_INODE_SIZE (data);
 603   blkno = (ino % grub_le_to_cpu32 (sblock->inodes_per_group))
 604     / inodes_per_block;
 605   blkoff = (ino % grub_le_to_cpu32 (sblock->inodes_per_group))
 606     % inodes_per_block;
 607
 608   base = grub_le_to_cpu32 (blkgrp.inode_table_id);
 609   if (data->log_group_desc_size >= 6)
 610     base |= (((grub_disk_addr_t) grub_le_to_cpu32 (blkgrp.inode_table_id_hi))
 611              << 32);
 612
 613   /* Read the inode.  */
 614   if (grub_disk_read (data->disk,
 615                       ((base + blkno) << LOG2_EXT2_BLOCK_SIZE (data)),
 616                       EXT2_INODE_SIZE (data) * blkoff,
 617                       sizeof (struct grub_ext2_inode), inode))
 618     return grub_errno;
 619
 620   return 0;
 621 }
 622
 623 static struct grub_ext2_data *
 624 grub_ext2_mount (grub_disk_t disk)
 625 {
 626   struct grub_ext2_data *data;
 627
 628   data = grub_malloc (sizeof (struct grub_ext2_data));
 629   if (!data)
 630     return 0;
 631
 632   /* Read the superblock.  */
 633   grub_disk_read (disk, 1 * 2, 0, sizeof (struct grub_ext2_sblock),
 634                   &data->sblock);
 635   if (grub_errno)
 636     goto fail;
 637
 638   /* Make sure this is an ext2 filesystem.  */
 639   if (data->sblock.magic != grub_cpu_to_le16_compile_time (EXT2_MAGIC)
 640       || grub_le_to_cpu32 (data->sblock.log2_block_size) >= 16
 641       || data->sblock.inodes_per_group == 0
 642       /* 20 already means 1GiB blocks. We don't want to deal with blocks overflowing int32. */
 643       || grub_le_to_cpu32 (data->sblock.log2_block_size) > 20
 644       || EXT2_INODE_SIZE (data) == 0
 645       || EXT2_BLOCK_SIZE (data) / EXT2_INODE_SIZE (data) == 0)
 646     {
 647       grub_error (GRUB_ERR_BAD_FS, "not an ext2 filesystem");
 648       goto fail;
 649     }
 650
 651   /* Check the FS doesn't have feature bits enabled that we don't support. */
 652   if (data->sblock.revision_level != grub_cpu_to_le32_compile_time (EXT2_GOOD_OLD_REVISION)
 653       && (data->sblock.feature_incompat
 654           & grub_cpu_to_le32_compile_time (~(EXT2_DRIVER_SUPPORTED_INCOMPAT
 655                                              | EXT2_DRIVER_IGNORED_INCOMPAT))))
 656     {
 657       grub_error (GRUB_ERR_BAD_FS, "filesystem has unsupported incompatible features");
 658       goto fail;
 659     }
 660
 661   if (data->sblock.revision_level != grub_cpu_to_le32_compile_time (EXT2_GOOD_OLD_REVISION)
 662       && (data->sblock.feature_incompat
 663           & grub_cpu_to_le32_compile_time (EXT4_FEATURE_INCOMPAT_64BIT))
 664       && data->sblock.group_desc_size != 0
 665       && ((data->sblock.group_desc_size & (data->sblock.group_desc_size - 1))
 666           == 0)
 667       && (data->sblock.group_desc_size & grub_cpu_to_le16_compile_time (0x1fe0)))
 668     {
 669       grub_uint16_t b = grub_le_to_cpu16 (data->sblock.group_desc_size);
 670       for (data->log_group_desc_size = 0; b != (1 << data->log_group_desc_size);
 671            data->log_group_desc_size++);
 672     }
 673   else
 674     data->log_group_desc_size = 5;
 675
 676   data->disk = disk;
 677
 678   data->diropen.data = data;
 679   data->diropen.ino = 2;
 680   data->diropen.inode_read = 1;
 681
 682   data->inode = &data->diropen.inode;
 683
 684   grub_ext2_read_inode (data, 2, data->inode);
 685   if (grub_errno)
 686     goto fail;
 687
 688   return data;
 689
 690  fail:
 691   if (grub_errno == GRUB_ERR_OUT_OF_RANGE)
 692     grub_error (GRUB_ERR_BAD_FS, "not an ext2 filesystem");
 693
 694   grub_free (data);
 695   return 0;
 696 }
 697
 698 static char *
 699 grub_ext2_read_symlink (grub_fshelp_node_t node)
 700 {
 701   char *symlink;
 702   struct grub_fshelp_node *diro = node;
 703
 704   if (! diro->inode_read)
 705     {
 706       grub_ext2_read_inode (diro->data, diro->ino, &diro->inode);
 707       if (grub_errno)
 708         return 0;
 709     }
 710
 711   symlink = grub_malloc (grub_le_to_cpu32 (diro->inode.size) + 1);
 712   if (! symlink)
 713     return 0;
 714
 715   /* If the filesize of the symlink is bigger than
 716      60 the symlink is stored in a separate block,
 717      otherwise it is stored in the inode.  */
 718   if (grub_le_to_cpu32 (diro->inode.size) <= sizeof (diro->inode.symlink))
 719     grub_memcpy (symlink,
 720                  diro->inode.symlink,
 721                  grub_le_to_cpu32 (diro->inode.size));
 722   else
 723     {
 724       grub_ext2_read_file (diro, 0, 0, 0,
 725                            grub_le_to_cpu32 (diro->inode.size),
 726                            symlink);
 727       if (grub_errno)
 728         {
 729           grub_free (symlink);
 730           return 0;
 731         }
 732     }
 733
 734   symlink[grub_le_to_cpu32 (diro->inode.size)] = '\0';
 735   return symlink;
 736 }
 737
 738 static int
 739 grub_ext2_iterate_dir (grub_fshelp_node_t dir,
 740                        grub_fshelp_iterate_dir_hook_t hook, void *hook_data)
 741 {
 742   unsigned int fpos = 0;
 743   struct grub_fshelp_node *diro = (struct grub_fshelp_node *) dir;
 744
 745   if (! diro->inode_read)
 746     {
 747       grub_ext2_read_inode (diro->data, diro->ino, &diro->inode);
 748       if (grub_errno)
 749         return 0;
 750     }
 751
 752   /* Search the file.  */
 753   while (fpos < grub_le_to_cpu32 (diro->inode.size))
 754     {
 755       struct ext2_dirent dirent;
 756
 757       grub_ext2_read_file (diro, 0, 0, fpos, sizeof (struct ext2_dirent),
 758                            (char *) &dirent);
 759       if (grub_errno)
 760         return 0;
 761
 762       if (dirent.direntlen == 0)
 763         return 0;
 764
 765       if (dirent.inode != 0 && dirent.namelen != 0)
 766         {
 767           char filename[MAX_NAMELEN + 1];
 768           struct grub_fshelp_node *fdiro;
 769           enum grub_fshelp_filetype type = GRUB_FSHELP_UNKNOWN;
 770
 771           grub_ext2_read_file (diro, 0, 0, fpos + sizeof (struct ext2_dirent),
 772                                dirent.namelen, filename);
 773           if (grub_errno)
 774             return 0;
 775
 776           fdiro = grub_malloc (sizeof (struct grub_fshelp_node));
 777           if (! fdiro)
 778             return 0;
 779
 780           fdiro->data = diro->data;
 781           fdiro->ino = grub_le_to_cpu32 (dirent.inode);
 782
 783           filename[dirent.namelen] = '\0';
 784
 785           if (dirent.filetype != FILETYPE_UNKNOWN)
 786             {
 787               fdiro->inode_read = 0;
 788
 789               if (dirent.filetype == FILETYPE_DIRECTORY)
 790                 type = GRUB_FSHELP_DIR;
 791               else if (dirent.filetype == FILETYPE_SYMLINK)
 792                 type = GRUB_FSHELP_SYMLINK;
 793               else if (dirent.filetype == FILETYPE_REG)
 794                 type = GRUB_FSHELP_REG;
 795             }
 796           else
 797             {
 798               /* The filetype can not be read from the dirent, read
 799                  the inode to get more information.  */
 800               grub_ext2_read_inode (diro->data,
 801                                     grub_le_to_cpu32 (dirent.inode),
 802                                     &fdiro->inode);
 803               if (grub_errno)
 804                 {
 805                   grub_free (fdiro);
 806                   return 0;
 807                 }
 808
 809               fdiro->inode_read = 1;
 810
 811               if ((grub_le_to_cpu16 (fdiro->inode.mode)
 812                    & FILETYPE_INO_MASK) == FILETYPE_INO_DIRECTORY)
 813                 type = GRUB_FSHELP_DIR;
 814               else if ((grub_le_to_cpu16 (fdiro->inode.mode)
 815                         & FILETYPE_INO_MASK) == FILETYPE_INO_SYMLINK)
 816                 type = GRUB_FSHELP_SYMLINK;
 817               else if ((grub_le_to_cpu16 (fdiro->inode.mode)
 818                         & FILETYPE_INO_MASK) == FILETYPE_INO_REG)
 819                 type = GRUB_FSHELP_REG;
 820             }
 821
 822           if (hook (filename, type, fdiro, hook_data))
 823             return 1;
 824         }
 825
 826       fpos += grub_le_to_cpu16 (dirent.direntlen);
 827     }
 828
 829   return 0;
 830 }
 831
 832 /* Open a file named NAME and initialize FILE.  */
 833 static grub_err_t
 834 grub_ext2_open (struct grub_file *file, const char *name)
 835 {
 836   struct grub_ext2_data *data;
 837   struct grub_fshelp_node *fdiro = 0;
 838   grub_err_t err;
 839
 840   grub_dl_ref (my_mod);
 841
 842   data = grub_ext2_mount (file->device->disk);
 843   if (! data)
 844     {
 845       err = grub_errno;
 846       goto fail;
 847     }
 848
 849   err = grub_fshelp_find_file (name, &data->diropen, &fdiro,
 850                                grub_ext2_iterate_dir,
 851                                grub_ext2_read_symlink, GRUB_FSHELP_REG);
 852   if (err)
 853     goto fail;
 854
 855   if (! fdiro->inode_read)
 856     {
 857       err = grub_ext2_read_inode (data, fdiro->ino, &fdiro->inode);
 858       if (err)
 859         goto fail;
 860     }
 861
 862   grub_memcpy (data->inode, &fdiro->inode, sizeof (struct grub_ext2_inode));
 863   grub_free (fdiro);
 864
 865   file->size = grub_le_to_cpu32 (data->inode->size);
 866   file->size |= ((grub_off_t) grub_le_to_cpu32 (data->inode->size_high)) << 32;
 867   file->data = data;
 868   file->offset = 0;
 869
 870   return 0;
 871
 872  fail:
 873   if (fdiro != &data->diropen)
 874     grub_free (fdiro);
 875   grub_free (data);
 876
 877   grub_dl_unref (my_mod);
 878
 879   return err;
 880 }
 881
 882 static grub_err_t
 883 grub_ext2_close (grub_file_t file)
 884 {
 885   grub_free (file->data);
 886
 887   grub_dl_unref (my_mod);
 888
 889   return GRUB_ERR_NONE;
 890 }
 891
 892 /* Read LEN bytes data from FILE into BUF.  */
 893 static grub_ssize_t
 894 grub_ext2_read (grub_file_t file, char *buf, grub_size_t len)
 895 {
 896   struct grub_ext2_data *data = (struct grub_ext2_data *) file->data;
 897
 898   return grub_ext2_read_file (&data->diropen,
 899                               file->read_hook, file->read_hook_data,
 900                               file->offset, len, buf);
 901 }
 902
 903
 904 /* Context for grub_ext2_dir.  */
 905 struct grub_ext2_dir_ctx
 906 {
 907   grub_fs_dir_hook_t hook;
 908   void *hook_data;
 909   struct grub_ext2_data *data;
 910 };
 911
 912 /* Helper for grub_ext2_dir.  */
 913 static int
 914 grub_ext2_dir_iter (const char *filename, enum grub_fshelp_filetype filetype,
 915                     grub_fshelp_node_t node, void *data)
 916 {
 917   struct grub_ext2_dir_ctx *ctx = data;
 918   struct grub_dirhook_info info;
 919
 920   grub_memset (&info, 0, sizeof (info));
 921   if (! node->inode_read)
 922     {
 923       grub_ext2_read_inode (ctx->data, node->ino, &node->inode);
 924       if (!grub_errno)
 925         node->inode_read = 1;
 926       grub_errno = GRUB_ERR_NONE;
 927     }
 928   if (node->inode_read)
 929     {
 930       info.mtimeset = 1;
 931       info.mtime = grub_le_to_cpu32 (node->inode.mtime);
 932     }
 933
 934   info.dir = ((filetype & GRUB_FSHELP_TYPE_MASK) == GRUB_FSHELP_DIR);
 935   grub_free (node);
 936   return ctx->hook (filename, &info, ctx->hook_data);
 937 }
 938
 939 static grub_err_t
 940 grub_ext2_dir (grub_device_t device, const char *path, grub_fs_dir_hook_t hook,
 941                void *hook_data)
 942 {
 943   struct grub_ext2_dir_ctx ctx = {
 944     .hook = hook,
 945     .hook_data = hook_data
 946   };
 947   struct grub_fshelp_node *fdiro = 0;
 948
 949   grub_dl_ref (my_mod);
 950
 951   ctx.data = grub_ext2_mount (device->disk);
 952   if (! ctx.data)
 953     goto fail;
 954
 955   grub_fshelp_find_file (path, &ctx.data->diropen, &fdiro,
 956                          grub_ext2_iterate_dir, grub_ext2_read_symlink,
 957                          GRUB_FSHELP_DIR);
 958   if (grub_errno)
 959     goto fail;
 960
 961   grub_ext2_iterate_dir (fdiro, grub_ext2_dir_iter, &ctx);
 962
 963  fail:
 964   if (fdiro != &ctx.data->diropen)
 965     grub_free (fdiro);
 966   grub_free (ctx.data);
 967
 968   grub_dl_unref (my_mod);
 969
 970   return grub_errno;
 971 }
 972
 973 static grub_err_t
 974 grub_ext2_label (grub_device_t device, char **label)
 975 {
 976   struct grub_ext2_data *data;
 977   grub_disk_t disk = device->disk;
 978
 979   grub_dl_ref (my_mod);
 980
 981   data = grub_ext2_mount (disk);
 982   if (data)
 983     *label = grub_strndup (data->sblock.volume_name,
 984                            sizeof (data->sblock.volume_name));
 985   else
 986     *label = NULL;
 987
 988   grub_dl_unref (my_mod);
 989
 990   grub_free (data);
 991
 992   return grub_errno;
 993 }
 994
 995 static grub_err_t
 996 grub_ext2_uuid (grub_device_t device, char **uuid)
 997 {
 998   struct grub_ext2_data *data;
 999   grub_disk_t disk = device->disk;
1000
1001   grub_dl_ref (my_mod);
1002
1003   data = grub_ext2_mount (disk);
1004   if (data)
1005     {
1006       *uuid = grub_xasprintf ("%04x%04x-%04x-%04x-%04x-%04x%04x%04x",
1007                              grub_be_to_cpu16 (data->sblock.uuid[0]),
1008                              grub_be_to_cpu16 (data->sblock.uuid[1]),
1009                              grub_be_to_cpu16 (data->sblock.uuid[2]),
1010                              grub_be_to_cpu16 (data->sblock.uuid[3]),
1011                              grub_be_to_cpu16 (data->sblock.uuid[4]),
1012                              grub_be_to_cpu16 (data->sblock.uuid[5]),
1013                              grub_be_to_cpu16 (data->sblock.uuid[6]),
1014                              grub_be_to_cpu16 (data->sblock.uuid[7]));
1015     }
1016   else
1017     *uuid = NULL;
1018
1019   grub_dl_unref (my_mod);
1020
1021   grub_free (data);
1022
1023   return grub_errno;
1024 }
1025
1026 /* Get mtime.  */
1027 static grub_err_t
1028 grub_ext2_mtime (grub_device_t device, grub_int32_t *tm)
1029 {
1030   struct grub_ext2_data *data;
1031   grub_disk_t disk = device->disk;
1032
1033   grub_dl_ref (my_mod);
1034
1035   data = grub_ext2_mount (disk);
1036   if (!data)
1037     *tm = 0;
1038   else
1039     *tm = grub_le_to_cpu32 (data->sblock.utime);
1040
1041   grub_dl_unref (my_mod);
1042
1043   grub_free (data);
1044
1045   return grub_errno;
1046
1047 }
1048
1049
1050 \f
1051 static struct grub_fs grub_ext2_fs =
1052   {
1053     .name = "ext2",
1054     .dir = grub_ext2_dir,
1055     .open = grub_ext2_open,
1056     .read = grub_ext2_read,
1057     .close = grub_ext2_close,
1058     .label = grub_ext2_label,
1059     .uuid = grub_ext2_uuid,
1060     .mtime = grub_ext2_mtime,
1061 #ifdef GRUB_UTIL
1062     .reserved_first_sector = 1,
1063     .blocklist_install = 1,
1064 #endif
1065     .next = 0
1066   };
1067
1068 GRUB_MOD_INIT(ext2)
1069 {
1070   grub_fs_register (&grub_ext2_fs);
1071   my_mod = mod;
1072 }
1073
1074 GRUB_MOD_FINI(ext2)
1075 {
1076   grub_fs_unregister (&grub_ext2_fs);
1077 }