make_ext4fs.c

   1 /*
   2  * Copyright (C) 2010 The Android Open Source Project
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *      http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #include "make_ext4fs.h"
  18 #include "ext4_utils.h"
  19 #include "allocate.h"
  20 #include "contents.h"
  21 #include "uuid.h"
  22 #include "wipe.h"
  23
  24 #include <sparse/sparse.h>
  25
  26 #include <assert.h>
  27 #include <dirent.h>
  28 #include <fcntl.h>
  29 #include <inttypes.h>
  30 #include <libgen.h>
  31 #include <stdio.h>
  32 #include <stdlib.h>
  33 #include <string.h>
  34 #include <unistd.h>
  35 #include <sys/stat.h>
  36 #include <sys/types.h>
  37
  38 /* TODO: Not implemented:
  39    Allocating blocks in the same block group as the file inode
  40    Hash or binary tree directories
  41  */
  42
  43 static int filter_dot(const struct dirent *d)
  44 {
  45         return (strcmp(d->d_name, "..") && strcmp(d->d_name, "."));
  46 }
  47
  48 static u32 build_default_directory_structure(const char *dir_path)
  49 {
  50         u32 inode;
  51         u32 root_inode;
  52         struct dentry dentries = {
  53                         .filename = "lost+found",
  54                         .file_type = EXT4_FT_DIR,
  55                         .mode = S_IRWXU,
  56                         .uid = 0,
  57                         .gid = 0,
  58                         .mtime = 0,
  59         };
  60         root_inode = make_directory(0, 1, &dentries, 1);
  61         inode = make_directory(root_inode, 0, NULL, 0);
  62         *dentries.inode = inode;
  63         inode_set_permissions(inode, dentries.mode,
  64                 dentries.uid, dentries.gid, dentries.mtime);
  65
  66         return root_inode;
  67 }
  68
  69 #ifndef USE_MINGW
  70 /* Read a local directory and create the same tree in the generated filesystem.
  71    Calls itself recursively with each directory in the given directory.
  72    full_path is an absolute or relative path, with a trailing slash, to the
  73    directory on disk that should be copied, or NULL if this is a directory
  74    that does not exist on disk (e.g. lost+found).
  75    dir_path is an absolute path, with trailing slash, to the same directory
  76    if the image were mounted at the specified mount point */
  77 static u32 build_directory_structure(const char *full_path, const char *dir_path,
  78                 u32 dir_inode, fs_config_func_t fs_config_func,
  79                 int verbose, time_t fixed_time)
  80 {
  81         int entries = 0;
  82         struct dentry *dentries;
  83         struct dirent **namelist = NULL;
  84         struct stat stat;
  85         int ret;
  86         int i;
  87         u32 inode;
  88         u32 entry_inode;
  89         u32 dirs = 0;
  90         bool needs_lost_and_found = false;
  91
  92         if (full_path) {
  93                 entries = scandir(full_path, &namelist, filter_dot, (void*)alphasort);
  94                 if (entries < 0) {
  95 #ifdef __GLIBC__
  96                         /* The scandir function implemented in glibc has a bug that makes it
  97                            erroneously fail with ENOMEM under certain circumstances.
  98                            As a workaround we can retry the scandir call with the same arguments.
  99                            GLIBC BZ: https://sourceware.org/bugzilla/show_bug.cgi?id=17804 */
 100                         if (errno == ENOMEM)
 101                                 entries = scandir(full_path, &namelist, filter_dot, (void*)alphasort);
 102 #endif
 103                         if (entries < 0) {
 104                                 error_errno("scandir");
 105                                 return EXT4_ALLOCATE_FAILED;
 106                         }
 107                 }
 108         }
 109
 110         if (dir_inode == 0) {
 111                 /* root directory, check if lost+found already exists */
 112                 for (i = 0; i < entries; i++)
 113                         if (strcmp(namelist[i]->d_name, "lost+found") == 0)
 114                                 break;
 115                 if (i == entries)
 116                         needs_lost_and_found = true;
 117         }
 118
 119         dentries = calloc(entries, sizeof(struct dentry));
 120         if (dentries == NULL)
 121                 critical_error_errno("malloc");
 122
 123         for (i = 0; i < entries; i++) {
 124                 dentries[i].filename = strdup(namelist[i]->d_name);
 125                 if (dentries[i].filename == NULL)
 126                         critical_error_errno("strdup");
 127
 128                 asprintf(&dentries[i].path, "%s%s", dir_path, namelist[i]->d_name);
 129                 asprintf(&dentries[i].full_path, "%s%s", full_path, namelist[i]->d_name);
 130
 131                 free(namelist[i]);
 132
 133                 ret = lstat(dentries[i].full_path, &stat);
 134                 if (ret < 0) {
 135                         error_errno("lstat");
 136                         i--;
 137                         entries--;
 138                         continue;
 139                 }
 140
 141                 dentries[i].size = stat.st_size;
 142                 dentries[i].mode = stat.st_mode & (S_ISUID|S_ISGID|S_ISVTX|S_IRWXU|S_IRWXG|S_IRWXO);
 143                 if (fixed_time == -1) {
 144                         dentries[i].mtime = stat.st_mtime;
 145                 } else {
 146                         dentries[i].mtime = fixed_time;
 147                 }
 148                 uint64_t capabilities;
 149                 if (fs_config_func != NULL) {
 150                         unsigned int mode = 0;
 151                         unsigned int uid = 0;
 152                         unsigned int gid = 0;
 153                         int dir = S_ISDIR(stat.st_mode);
 154                         fs_config_func(dentries[i].path, dir, &uid, &gid, &mode, &capabilities);
 155                         dentries[i].mode = mode;
 156                         dentries[i].uid = uid;
 157                         dentries[i].gid = gid;
 158                         dentries[i].capabilities = capabilities;
 159                 }
 160
 161                 if (S_ISREG(stat.st_mode)) {
 162                         dentries[i].file_type = EXT4_FT_REG_FILE;
 163                 } else if (S_ISDIR(stat.st_mode)) {
 164                         dentries[i].file_type = EXT4_FT_DIR;
 165                         dirs++;
 166                 } else if (S_ISCHR(stat.st_mode)) {
 167                         dentries[i].file_type = EXT4_FT_CHRDEV;
 168                 } else if (S_ISBLK(stat.st_mode)) {
 169                         dentries[i].file_type = EXT4_FT_BLKDEV;
 170                 } else if (S_ISFIFO(stat.st_mode)) {
 171                         dentries[i].file_type = EXT4_FT_FIFO;
 172                 } else if (S_ISSOCK(stat.st_mode)) {
 173                         dentries[i].file_type = EXT4_FT_SOCK;
 174                 } else if (S_ISLNK(stat.st_mode)) {
 175                         dentries[i].file_type = EXT4_FT_SYMLINK;
 176                         dentries[i].link = calloc(info.block_size, 1);
 177                         readlink(dentries[i].full_path, dentries[i].link, info.block_size - 1);
 178                 } else {
 179                         error("unknown file type on %s", dentries[i].path);
 180                         i--;
 181                         entries--;
 182                 }
 183         }
 184         free(namelist);
 185
 186         if (needs_lost_and_found) {
 187                 /* insert a lost+found directory at the beginning of the dentries */
 188                 struct dentry *tmp = calloc(entries + 1, sizeof(struct dentry));
 189                 memset(tmp, 0, sizeof(struct dentry));
 190                 memcpy(tmp + 1, dentries, entries * sizeof(struct dentry));
 191                 dentries = tmp;
 192
 193                 dentries[0].filename = strdup("lost+found");
 194                 asprintf(&dentries[0].path, "%slost+found", dir_path);
 195                 dentries[0].full_path = NULL;
 196                 dentries[0].size = 0;
 197                 dentries[0].mode = S_IRWXU;
 198                 dentries[0].file_type = EXT4_FT_DIR;
 199                 dentries[0].uid = 0;
 200                 dentries[0].gid = 0;
 201                 entries++;
 202                 dirs++;
 203         }
 204
 205         inode = make_directory(dir_inode, entries, dentries, dirs);
 206
 207         for (i = 0; i < entries; i++) {
 208                 if (dentries[i].file_type == EXT4_FT_REG_FILE) {
 209                         entry_inode = make_file(dentries[i].full_path, dentries[i].size);
 210                 } else if (dentries[i].file_type == EXT4_FT_DIR) {
 211                         char *subdir_full_path = NULL;
 212                         char *subdir_dir_path;
 213                         if (dentries[i].full_path) {
 214                                 ret = asprintf(&subdir_full_path, "%s/", dentries[i].full_path);
 215                                 if (ret < 0)
 216                                         critical_error_errno("asprintf");
 217                         }
 218                         ret = asprintf(&subdir_dir_path, "%s/", dentries[i].path);
 219                         if (ret < 0)
 220                                 critical_error_errno("asprintf");
 221                         entry_inode = build_directory_structure(subdir_full_path,
 222                                         subdir_dir_path, inode, fs_config_func, verbose, fixed_time);
 223                         free(subdir_full_path);
 224                         free(subdir_dir_path);
 225                 } else if (dentries[i].file_type == EXT4_FT_SYMLINK) {
 226                         entry_inode = make_link(dentries[i].link);
 227                 } else if (dentries[i].file_type == EXT4_FT_CHRDEV ||
 228                            dentries[i].file_type == EXT4_FT_BLKDEV ||
 229                            dentries[i].file_type == EXT4_FT_SOCK ||
 230                            dentries[i].file_type == EXT4_FT_FIFO) {
 231                         entry_inode = make_special(dentries[i].full_path);
 232                 } else {
 233                         error("unknown file type on %s", dentries[i].path);
 234                         entry_inode = 0;
 235                 }
 236                 *dentries[i].inode = entry_inode;
 237
 238                 ret = inode_set_permissions(entry_inode, dentries[i].mode,
 239                         dentries[i].uid, dentries[i].gid,
 240                         dentries[i].mtime);
 241                 if (ret)
 242                         error("failed to set permissions on %s\n", dentries[i].path);
 243
 244                 /*
 245                  * It's important to call inode_set_selinux() before
 246                  * inode_set_capabilities(). Extended attributes need to
 247                  * be stored sorted order, and we guarantee this by making
 248                  * the calls in the proper order.
 249                  * Please see xattr_assert_sane() in contents.c
 250                  */
 251                 ret = inode_set_selinux(entry_inode, dentries[i].secon);
 252                 if (ret)
 253                         error("failed to set SELinux context on %s\n", dentries[i].path);
 254                 ret = inode_set_capabilities(entry_inode, dentries[i].capabilities);
 255                 if (ret)
 256                         error("failed to set capability on %s\n", dentries[i].path);
 257
 258                 free(dentries[i].path);
 259                 free(dentries[i].full_path);
 260                 free(dentries[i].link);
 261                 free((void *)dentries[i].filename);
 262                 free(dentries[i].secon);
 263         }
 264
 265         free(dentries);
 266         return inode;
 267 }
 268 #endif
 269
 270 static u32 compute_block_size()
 271 {
 272         return 4096;
 273 }
 274
 275 static u32 compute_journal_blocks()
 276 {
 277         u32 journal_blocks = DIV_ROUND_UP(info.len, info.block_size) / 64;
 278         if (journal_blocks < 1024)
 279                 journal_blocks = 1024;
 280         if (journal_blocks > 32768)
 281                 journal_blocks = 32768;
 282         return journal_blocks;
 283 }
 284
 285 static u32 compute_blocks_per_group()
 286 {
 287         return info.block_size * 8;
 288 }
 289
 290 static u32 compute_inodes()
 291 {
 292         return DIV_ROUND_UP(info.len, info.block_size) / 4;
 293 }
 294
 295 static u32 compute_inodes_per_group()
 296 {
 297         u32 blocks = DIV_ROUND_UP(info.len, info.block_size);
 298         u32 block_groups = DIV_ROUND_UP(blocks, info.blocks_per_group);
 299         u32 inodes = DIV_ROUND_UP(info.inodes, block_groups);
 300         inodes = EXT4_ALIGN(inodes, (info.block_size / info.inode_size));
 301
 302         /* After properly rounding up the number of inodes/group,
 303          * make sure to update the total inodes field in the info struct.
 304          */
 305         info.inodes = inodes * block_groups;
 306
 307         return inodes;
 308 }
 309
 310 static u32 compute_bg_desc_reserve_blocks()
 311 {
 312         u32 blocks = DIV_ROUND_UP(info.len, info.block_size);
 313         u32 block_groups = DIV_ROUND_UP(blocks, info.blocks_per_group);
 314         u32 bg_desc_blocks = DIV_ROUND_UP(block_groups * sizeof(struct ext2_group_desc),
 315                         info.block_size);
 316
 317         u32 bg_desc_reserve_blocks =
 318                         DIV_ROUND_UP(block_groups * 1024 * sizeof(struct ext2_group_desc),
 319                                         info.block_size) - bg_desc_blocks;
 320
 321         if (bg_desc_reserve_blocks > info.block_size / sizeof(u32))
 322                 bg_desc_reserve_blocks = info.block_size / sizeof(u32);
 323
 324         return bg_desc_reserve_blocks;
 325 }
 326
 327 void reset_ext4fs_info() {
 328         // Reset all the global data structures used by make_ext4fs so it
 329         // can be called again.
 330         memset(&info, 0, sizeof(info));
 331         memset(&aux_info, 0, sizeof(aux_info));
 332
 333         if (ext4_sparse_file) {
 334                 sparse_file_destroy(ext4_sparse_file);
 335                 ext4_sparse_file = NULL;
 336         }
 337 }
 338
 339 int make_ext4fs_sparse_fd(int fd, long long len,
 340                                 const char *mountpoint)
 341 {
 342         reset_ext4fs_info();
 343         info.len = len;
 344
 345         return make_ext4fs_internal(fd, NULL, mountpoint, NULL, 0, 1, 0, 0, 0, -1, NULL);
 346 }
 347
 348 int make_ext4fs(const char *filename, long long len,
 349                                 const char *mountpoint)
 350 {
 351         int fd;
 352         int status;
 353
 354         reset_ext4fs_info();
 355         info.len = len;
 356
 357         fd = open(filename, O_WRONLY | O_CREAT | O_TRUNC, 0644);
 358         if (fd < 0) {
 359                 error_errno("open");
 360                 return EXIT_FAILURE;
 361         }
 362
 363         status = make_ext4fs_internal(fd, NULL, mountpoint, NULL, 0, 0, 0, 1, 0, -1, NULL);
 364         close(fd);
 365
 366         return status;
 367 }
 368
 369 /* return a newly-malloc'd string that is a copy of str.  The new string
 370    is guaranteed to have a trailing slash.  If absolute is true, the new string
 371    is also guaranteed to have a leading slash.
 372 */
 373 static char *canonicalize_slashes(const char *str, bool absolute)
 374 {
 375         char *ret;
 376         int len = strlen(str);
 377         int newlen = len;
 378         char *ptr;
 379
 380         if (len == 0) {
 381                 if (absolute)
 382                         return strdup("/");
 383                 else
 384                         return strdup("");
 385         }
 386
 387         if (str[0] != '/' && absolute) {
 388                 newlen++;
 389         }
 390         if (str[len - 1] != '/') {
 391                 newlen++;
 392         }
 393         ret = malloc(newlen + 1);
 394         if (!ret) {
 395                 critical_error("malloc");
 396         }
 397
 398         ptr = ret;
 399         if (str[0] != '/' && absolute) {
 400                 *ptr++ = '/';
 401         }
 402
 403         strcpy(ptr, str);
 404         ptr += len;
 405
 406         if (str[len - 1] != '/') {
 407                 *ptr++ = '/';
 408         }
 409
 410         if (ptr != ret + newlen) {
 411                 critical_error("assertion failed\n");
 412         }
 413
 414         *ptr = '\0';
 415
 416         return ret;
 417 }
 418
 419 static char *canonicalize_abs_slashes(const char *str)
 420 {
 421         return canonicalize_slashes(str, true);
 422 }
 423
 424 static char *canonicalize_rel_slashes(const char *str)
 425 {
 426         return canonicalize_slashes(str, false);
 427 }
 428
 429 int make_ext4fs_internal(int fd, const char *_directory,
 430                                                  const char *_mountpoint, fs_config_func_t fs_config_func, int gzip,
 431                                                  int sparse, int crc, int wipe,
 432                                                  int verbose, time_t fixed_time,
 433                                                  FILE* block_list_file)
 434 {
 435         u32 root_inode_num;
 436         u16 root_mode;
 437         char *mountpoint;
 438         char *directory = NULL;
 439
 440         if (setjmp(setjmp_env))
 441                 return EXIT_FAILURE; /* Handle a call to longjmp() */
 442
 443         if (_mountpoint == NULL) {
 444                 mountpoint = strdup("");
 445         } else {
 446                 mountpoint = canonicalize_abs_slashes(_mountpoint);
 447         }
 448
 449         if (_directory) {
 450                 directory = canonicalize_rel_slashes(_directory);
 451         }
 452
 453         if (info.len <= 0)
 454                 info.len = get_file_size(fd);
 455
 456         if (info.len <= 0) {
 457                 fprintf(stderr, "Need size of filesystem\n");
 458                 return EXIT_FAILURE;
 459         }
 460
 461         if (info.block_size <= 0)
 462                 info.block_size = compute_block_size();
 463
 464         /* Round down the filesystem length to be a multiple of the block size */
 465         info.len &= ~((u64)info.block_size - 1);
 466
 467         if (info.journal_blocks == 0)
 468                 info.journal_blocks = compute_journal_blocks();
 469
 470         if (info.no_journal == 0)
 471                 info.feat_compat = EXT4_FEATURE_COMPAT_HAS_JOURNAL;
 472         else
 473                 info.journal_blocks = 0;
 474
 475         if (info.blocks_per_group <= 0)
 476                 info.blocks_per_group = compute_blocks_per_group();
 477
 478         if (info.inodes <= 0)
 479                 info.inodes = compute_inodes();
 480
 481         if (info.inode_size <= 0)
 482                 info.inode_size = 256;
 483
 484         if (info.label == NULL)
 485                 info.label = "";
 486
 487         info.inodes_per_group = compute_inodes_per_group();
 488
 489         info.feat_compat |=
 490                         EXT4_FEATURE_COMPAT_RESIZE_INODE |
 491                         EXT4_FEATURE_COMPAT_EXT_ATTR;
 492
 493         info.feat_ro_compat |=
 494                         EXT4_FEATURE_RO_COMPAT_SPARSE_SUPER |
 495                         EXT4_FEATURE_RO_COMPAT_LARGE_FILE |
 496                         EXT4_FEATURE_RO_COMPAT_GDT_CSUM;
 497
 498         info.feat_incompat |=
 499                         EXT4_FEATURE_INCOMPAT_EXTENTS |
 500                         EXT4_FEATURE_INCOMPAT_FILETYPE;
 501
 502
 503         info.bg_desc_reserve_blocks = compute_bg_desc_reserve_blocks();
 504
 505         printf("Creating filesystem with parameters:\n");
 506         printf("    Size: %"PRIu64"\n", info.len);
 507         printf("    Block size: %d\n", info.block_size);
 508         printf("    Blocks per group: %d\n", info.blocks_per_group);
 509         printf("    Inodes per group: %d\n", info.inodes_per_group);
 510         printf("    Inode size: %d\n", info.inode_size);
 511         printf("    Journal blocks: %d\n", info.journal_blocks);
 512         printf("    Label: %s\n", info.label);
 513
 514         ext4_create_fs_aux_info();
 515
 516         printf("    Blocks: %"PRIu64"\n", aux_info.len_blocks);
 517         printf("    Block groups: %d\n", aux_info.groups);
 518         printf("    Reserved block group size: %d\n", info.bg_desc_reserve_blocks);
 519
 520         ext4_sparse_file = sparse_file_new(info.block_size, info.len);
 521
 522         block_allocator_init();
 523
 524         ext4_fill_in_sb();
 525
 526         if (reserve_inodes(0, 10) == EXT4_ALLOCATE_FAILED)
 527                 error("failed to reserve first 10 inodes");
 528
 529         if (info.feat_compat & EXT4_FEATURE_COMPAT_HAS_JOURNAL)
 530                 ext4_create_journal_inode();
 531
 532         if (info.feat_compat & EXT4_FEATURE_COMPAT_RESIZE_INODE)
 533                 ext4_create_resize_inode();
 534
 535 #ifdef USE_MINGW
 536         // Windows needs only 'create an empty fs image' functionality
 537         assert(!directory);
 538         root_inode_num = build_default_directory_structure(mountpoint);
 539 #else
 540         if (directory)
 541                 root_inode_num = build_directory_structure(directory, mountpoint, 0,
 542                         fs_config_func, verbose, fixed_time);
 543         else
 544                 root_inode_num = build_default_directory_structure(mountpoint);
 545 #endif
 546
 547         root_mode = S_IRWXU | S_IRGRP | S_IXGRP | S_IROTH | S_IXOTH;
 548         inode_set_permissions(root_inode_num, root_mode, 0, 0, 0);
 549
 550         ext4_update_free();
 551
 552         ext4_queue_sb();
 553
 554         if (block_list_file) {
 555                 size_t dirlen = directory ? strlen(directory) : 0;
 556                 struct block_allocation* p = get_saved_allocation_chain();
 557                 while (p) {
 558                         if (directory && strncmp(p->filename, directory, dirlen) == 0) {
 559                                 // substitute mountpoint for the leading directory in the filename, in the output file
 560                                 fprintf(block_list_file, "%s%s", mountpoint, p->filename + dirlen);
 561                         } else {
 562                                 fprintf(block_list_file, "%s", p->filename);
 563                         }
 564                         print_blocks(block_list_file, p);
 565                         struct block_allocation* pn = p->next;
 566                         free_alloc(p);
 567                         p = pn;
 568                 }
 569         }
 570
 571         printf("Created filesystem with %d/%d inodes and %d/%d blocks\n",
 572                         aux_info.sb->s_inodes_count - aux_info.sb->s_free_inodes_count,
 573                         aux_info.sb->s_inodes_count,
 574                         aux_info.sb->s_blocks_count_lo - aux_info.sb->s_free_blocks_count_lo,
 575                         aux_info.sb->s_blocks_count_lo);
 576
 577         if (wipe && WIPE_IS_SUPPORTED) {
 578                 wipe_block_device(fd, info.len);
 579         }
 580
 581         write_ext4_image(fd, gzip, sparse, crc);
 582
 583         sparse_file_destroy(ext4_sparse_file);
 584         ext4_sparse_file = NULL;
 585
 586         free(mountpoint);
 587         free(directory);
 588
 589         return 0;
 590 }