2 * Copyright (C) 2010 The Android Open Source Project
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
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
17 #include "make_ext4fs.h"
18 #include "ext4_utils.h"
24 #include <sparse/sparse.h>
36 #include <sys/types.h>
38 /* TODO: Not implemented:
39 Allocating blocks in the same block group as the file inode
40 Hash or binary tree directories
43 static int filter_dot(const struct dirent *d)
45 return (strcmp(d->d_name, "..") && strcmp(d->d_name, "."));
48 static u32 build_default_directory_structure(const char *dir_path)
52 struct dentry dentries = {
53 .filename = "lost+found",
54 .file_type = EXT4_FT_DIR,
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);
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)
82 struct dentry *dentries;
83 struct dirent **namelist = NULL;
90 bool needs_lost_and_found = false;
93 entries = scandir(full_path, &namelist, filter_dot, (void*)alphasort);
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 */
101 entries = scandir(full_path, &namelist, filter_dot, (void*)alphasort);
104 error_errno("scandir");
105 return EXT4_ALLOCATE_FAILED;
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)
116 needs_lost_and_found = true;
119 dentries = calloc(entries, sizeof(struct dentry));
120 if (dentries == NULL)
121 critical_error_errno("malloc");
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");
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);
133 ret = lstat(dentries[i].full_path, &stat);
135 error_errno("lstat");
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;
146 dentries[i].mtime = fixed_time;
148 uint64_t capabilities;
149 if (fs_config_func != NULL) {
151 unsigned int mode = 0;
152 unsigned int uid = 0;
153 unsigned int gid = 0;
154 int dir = S_ISDIR(stat.st_mode);
155 fs_config_func(dentries[i].path, dir, &uid, &gid, &mode, &capabilities);
156 dentries[i].mode = mode;
157 dentries[i].uid = uid;
158 dentries[i].gid = gid;
159 dentries[i].capabilities = capabilities;
161 error("can't set android permissions - built without android support");
165 if (S_ISREG(stat.st_mode)) {
166 dentries[i].file_type = EXT4_FT_REG_FILE;
167 } else if (S_ISDIR(stat.st_mode)) {
168 dentries[i].file_type = EXT4_FT_DIR;
170 } else if (S_ISCHR(stat.st_mode)) {
171 dentries[i].file_type = EXT4_FT_CHRDEV;
172 } else if (S_ISBLK(stat.st_mode)) {
173 dentries[i].file_type = EXT4_FT_BLKDEV;
174 } else if (S_ISFIFO(stat.st_mode)) {
175 dentries[i].file_type = EXT4_FT_FIFO;
176 } else if (S_ISSOCK(stat.st_mode)) {
177 dentries[i].file_type = EXT4_FT_SOCK;
178 } else if (S_ISLNK(stat.st_mode)) {
179 dentries[i].file_type = EXT4_FT_SYMLINK;
180 dentries[i].link = calloc(info.block_size, 1);
181 readlink(dentries[i].full_path, dentries[i].link, info.block_size - 1);
183 error("unknown file type on %s", dentries[i].path);
190 if (needs_lost_and_found) {
191 /* insert a lost+found directory at the beginning of the dentries */
192 struct dentry *tmp = calloc(entries + 1, sizeof(struct dentry));
193 memset(tmp, 0, sizeof(struct dentry));
194 memcpy(tmp + 1, dentries, entries * sizeof(struct dentry));
197 dentries[0].filename = strdup("lost+found");
198 asprintf(&dentries[0].path, "%slost+found", dir_path);
199 dentries[0].full_path = NULL;
200 dentries[0].size = 0;
201 dentries[0].mode = S_IRWXU;
202 dentries[0].file_type = EXT4_FT_DIR;
209 inode = make_directory(dir_inode, entries, dentries, dirs);
211 for (i = 0; i < entries; i++) {
212 if (dentries[i].file_type == EXT4_FT_REG_FILE) {
213 entry_inode = make_file(dentries[i].full_path, dentries[i].size);
214 } else if (dentries[i].file_type == EXT4_FT_DIR) {
215 char *subdir_full_path = NULL;
216 char *subdir_dir_path;
217 if (dentries[i].full_path) {
218 ret = asprintf(&subdir_full_path, "%s/", dentries[i].full_path);
220 critical_error_errno("asprintf");
222 ret = asprintf(&subdir_dir_path, "%s/", dentries[i].path);
224 critical_error_errno("asprintf");
225 entry_inode = build_directory_structure(subdir_full_path,
226 subdir_dir_path, inode, fs_config_func, verbose, fixed_time);
227 free(subdir_full_path);
228 free(subdir_dir_path);
229 } else if (dentries[i].file_type == EXT4_FT_SYMLINK) {
230 entry_inode = make_link(dentries[i].link);
231 } else if (dentries[i].file_type == EXT4_FT_CHRDEV ||
232 dentries[i].file_type == EXT4_FT_BLKDEV ||
233 dentries[i].file_type == EXT4_FT_SOCK ||
234 dentries[i].file_type == EXT4_FT_FIFO) {
235 entry_inode = make_special(dentries[i].full_path);
237 error("unknown file type on %s", dentries[i].path);
240 *dentries[i].inode = entry_inode;
242 ret = inode_set_permissions(entry_inode, dentries[i].mode,
243 dentries[i].uid, dentries[i].gid,
246 error("failed to set permissions on %s\n", dentries[i].path);
249 * It's important to call inode_set_selinux() before
250 * inode_set_capabilities(). Extended attributes need to
251 * be stored sorted order, and we guarantee this by making
252 * the calls in the proper order.
253 * Please see xattr_assert_sane() in contents.c
255 ret = inode_set_selinux(entry_inode, dentries[i].secon);
257 error("failed to set SELinux context on %s\n", dentries[i].path);
258 ret = inode_set_capabilities(entry_inode, dentries[i].capabilities);
260 error("failed to set capability on %s\n", dentries[i].path);
262 free(dentries[i].path);
263 free(dentries[i].full_path);
264 free(dentries[i].link);
265 free((void *)dentries[i].filename);
266 free(dentries[i].secon);
274 static u32 compute_block_size()
279 static u32 compute_journal_blocks()
281 u32 journal_blocks = DIV_ROUND_UP(info.len, info.block_size) / 64;
282 if (journal_blocks < 1024)
283 journal_blocks = 1024;
284 if (journal_blocks > 32768)
285 journal_blocks = 32768;
286 return journal_blocks;
289 static u32 compute_blocks_per_group()
291 return info.block_size * 8;
294 static u32 compute_inodes()
296 return DIV_ROUND_UP(info.len, info.block_size) / 4;
299 static u32 compute_inodes_per_group()
301 u32 blocks = DIV_ROUND_UP(info.len, info.block_size);
302 u32 block_groups = DIV_ROUND_UP(blocks, info.blocks_per_group);
303 u32 inodes = DIV_ROUND_UP(info.inodes, block_groups);
304 inodes = EXT4_ALIGN(inodes, (info.block_size / info.inode_size));
306 /* After properly rounding up the number of inodes/group,
307 * make sure to update the total inodes field in the info struct.
309 info.inodes = inodes * block_groups;
314 static u32 compute_bg_desc_reserve_blocks()
316 u32 blocks = DIV_ROUND_UP(info.len, info.block_size);
317 u32 block_groups = DIV_ROUND_UP(blocks, info.blocks_per_group);
318 u32 bg_desc_blocks = DIV_ROUND_UP(block_groups * sizeof(struct ext2_group_desc),
321 u32 bg_desc_reserve_blocks =
322 DIV_ROUND_UP(block_groups * 1024 * sizeof(struct ext2_group_desc),
323 info.block_size) - bg_desc_blocks;
325 if (bg_desc_reserve_blocks > info.block_size / sizeof(u32))
326 bg_desc_reserve_blocks = info.block_size / sizeof(u32);
328 return bg_desc_reserve_blocks;
331 void reset_ext4fs_info() {
332 // Reset all the global data structures used by make_ext4fs so it
333 // can be called again.
334 memset(&info, 0, sizeof(info));
335 memset(&aux_info, 0, sizeof(aux_info));
337 if (ext4_sparse_file) {
338 sparse_file_destroy(ext4_sparse_file);
339 ext4_sparse_file = NULL;
343 int make_ext4fs_sparse_fd(int fd, long long len,
344 const char *mountpoint)
349 return make_ext4fs_internal(fd, NULL, mountpoint, NULL, 0, 1, 0, 0, 0, -1, NULL);
352 int make_ext4fs(const char *filename, long long len,
353 const char *mountpoint)
361 fd = open(filename, O_WRONLY | O_CREAT | O_TRUNC, 0644);
367 status = make_ext4fs_internal(fd, NULL, mountpoint, NULL, 0, 0, 0, 1, 0, -1, NULL);
373 /* return a newly-malloc'd string that is a copy of str. The new string
374 is guaranteed to have a trailing slash. If absolute is true, the new string
375 is also guaranteed to have a leading slash.
377 static char *canonicalize_slashes(const char *str, bool absolute)
380 int len = strlen(str);
391 if (str[0] != '/' && absolute) {
394 if (str[len - 1] != '/') {
397 ret = malloc(newlen + 1);
399 critical_error("malloc");
403 if (str[0] != '/' && absolute) {
410 if (str[len - 1] != '/') {
414 if (ptr != ret + newlen) {
415 critical_error("assertion failed\n");
423 static char *canonicalize_abs_slashes(const char *str)
425 return canonicalize_slashes(str, true);
428 static char *canonicalize_rel_slashes(const char *str)
430 return canonicalize_slashes(str, false);
433 int make_ext4fs_internal(int fd, const char *_directory,
434 const char *_mountpoint, fs_config_func_t fs_config_func, int gzip,
435 int sparse, int crc, int wipe,
436 int verbose, time_t fixed_time,
437 FILE* block_list_file)
442 char *directory = NULL;
444 if (setjmp(setjmp_env))
445 return EXIT_FAILURE; /* Handle a call to longjmp() */
447 if (_mountpoint == NULL) {
448 mountpoint = strdup("");
450 mountpoint = canonicalize_abs_slashes(_mountpoint);
454 directory = canonicalize_rel_slashes(_directory);
458 info.len = get_file_size(fd);
461 fprintf(stderr, "Need size of filesystem\n");
465 if (info.block_size <= 0)
466 info.block_size = compute_block_size();
468 /* Round down the filesystem length to be a multiple of the block size */
469 info.len &= ~((u64)info.block_size - 1);
471 if (info.journal_blocks == 0)
472 info.journal_blocks = compute_journal_blocks();
474 if (info.no_journal == 0)
475 info.feat_compat = EXT4_FEATURE_COMPAT_HAS_JOURNAL;
477 info.journal_blocks = 0;
479 if (info.blocks_per_group <= 0)
480 info.blocks_per_group = compute_blocks_per_group();
482 if (info.inodes <= 0)
483 info.inodes = compute_inodes();
485 if (info.inode_size <= 0)
486 info.inode_size = 256;
488 if (info.label == NULL)
491 info.inodes_per_group = compute_inodes_per_group();
494 EXT4_FEATURE_COMPAT_RESIZE_INODE |
495 EXT4_FEATURE_COMPAT_EXT_ATTR;
497 info.feat_ro_compat |=
498 EXT4_FEATURE_RO_COMPAT_SPARSE_SUPER |
499 EXT4_FEATURE_RO_COMPAT_LARGE_FILE |
500 EXT4_FEATURE_RO_COMPAT_GDT_CSUM;
502 info.feat_incompat |=
503 EXT4_FEATURE_INCOMPAT_EXTENTS |
504 EXT4_FEATURE_INCOMPAT_FILETYPE;
507 info.bg_desc_reserve_blocks = compute_bg_desc_reserve_blocks();
509 printf("Creating filesystem with parameters:\n");
510 printf(" Size: %"PRIu64"\n", info.len);
511 printf(" Block size: %d\n", info.block_size);
512 printf(" Blocks per group: %d\n", info.blocks_per_group);
513 printf(" Inodes per group: %d\n", info.inodes_per_group);
514 printf(" Inode size: %d\n", info.inode_size);
515 printf(" Journal blocks: %d\n", info.journal_blocks);
516 printf(" Label: %s\n", info.label);
518 ext4_create_fs_aux_info();
520 printf(" Blocks: %"PRIu64"\n", aux_info.len_blocks);
521 printf(" Block groups: %d\n", aux_info.groups);
522 printf(" Reserved block group size: %d\n", info.bg_desc_reserve_blocks);
524 ext4_sparse_file = sparse_file_new(info.block_size, info.len);
526 block_allocator_init();
530 if (reserve_inodes(0, 10) == EXT4_ALLOCATE_FAILED)
531 error("failed to reserve first 10 inodes");
533 if (info.feat_compat & EXT4_FEATURE_COMPAT_HAS_JOURNAL)
534 ext4_create_journal_inode();
536 if (info.feat_compat & EXT4_FEATURE_COMPAT_RESIZE_INODE)
537 ext4_create_resize_inode();
540 // Windows needs only 'create an empty fs image' functionality
542 root_inode_num = build_default_directory_structure(mountpoint);
545 root_inode_num = build_directory_structure(directory, mountpoint, 0,
546 fs_config_func, verbose, fixed_time);
548 root_inode_num = build_default_directory_structure(mountpoint);
551 root_mode = S_IRWXU | S_IRGRP | S_IXGRP | S_IROTH | S_IXOTH;
552 inode_set_permissions(root_inode_num, root_mode, 0, 0, 0);
558 if (block_list_file) {
559 size_t dirlen = directory ? strlen(directory) : 0;
560 struct block_allocation* p = get_saved_allocation_chain();
562 if (directory && strncmp(p->filename, directory, dirlen) == 0) {
563 // substitute mountpoint for the leading directory in the filename, in the output file
564 fprintf(block_list_file, "%s%s", mountpoint, p->filename + dirlen);
566 fprintf(block_list_file, "%s", p->filename);
568 print_blocks(block_list_file, p);
569 struct block_allocation* pn = p->next;
575 printf("Created filesystem with %d/%d inodes and %d/%d blocks\n",
576 aux_info.sb->s_inodes_count - aux_info.sb->s_free_inodes_count,
577 aux_info.sb->s_inodes_count,
578 aux_info.sb->s_blocks_count_lo - aux_info.sb->s_free_blocks_count_lo,
579 aux_info.sb->s_blocks_count_lo);
581 if (wipe && WIPE_IS_SUPPORTED) {
582 wipe_block_device(fd, info.len);
585 write_ext4_image(fd, gzip, sparse, crc);
587 sparse_file_destroy(ext4_sparse_file);
588 ext4_sparse_file = NULL;