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