move remaining help text from include/usage.src.h
[oweals/busybox.git] / util-linux / mkfs_ext2.c
1 /* vi: set sw=4 ts=4: */
2 /*
3  * mkfs_ext2: utility to create EXT2 filesystem
4  * inspired by genext2fs
5  *
6  * Busybox'ed (2009) by Vladimir Dronnikov <dronnikov@gmail.com>
7  *
8  * Licensed under GPLv2, see file LICENSE in this source tree.
9  */
10
11 //usage:#define mkfs_ext2_trivial_usage
12 //usage:       "[-Fn] "
13 /* //usage:    "[-c|-l filename] " */
14 //usage:       "[-b BLK_SIZE] "
15 /* //usage:    "[-f fragment-size] [-g blocks-per-group] " */
16 //usage:       "[-i INODE_RATIO] [-I INODE_SIZE] "
17 /* //usage:    "[-j] [-J journal-options] [-N number-of-inodes] " */
18 //usage:       "[-m RESERVED_PERCENT] "
19 /* //usage:    "[-o creator-os] [-O feature[,...]] [-q] " */
20 /* //usage:    "[r fs-revision-level] [-E extended-options] [-v] [-F] " */
21 //usage:       "[-L LABEL] "
22 /* //usage:    "[-M last-mounted-directory] [-S] [-T filesystem-type] " */
23 //usage:       "BLOCKDEV [KBYTES]"
24 //usage:#define mkfs_ext2_full_usage "\n\n"
25 //usage:       "        -b BLK_SIZE     Block size, bytes"
26 /* //usage:  "\n        -c              Check device for bad blocks" */
27 /* //usage:  "\n        -E opts         Set extended options" */
28 /* //usage:  "\n        -f size         Fragment size in bytes" */
29 //usage:     "\n        -F              Force"
30 /* //usage:  "\n        -g N            Number of blocks in a block group" */
31 //usage:     "\n        -i RATIO        Max number of files is filesystem_size / RATIO"
32 //usage:     "\n        -I BYTES        Inode size (min 128)"
33 /* //usage:  "\n        -j              Create a journal (ext3)" */
34 /* //usage:  "\n        -J opts         Set journal options (size/device)" */
35 /* //usage:  "\n        -l file         Read bad blocks list from file" */
36 //usage:     "\n        -L LBL          Volume label"
37 //usage:     "\n        -m PERCENT      Percent of blocks to reserve for admin"
38 /* //usage:  "\n        -M dir          Set last mounted directory" */
39 //usage:     "\n        -n              Dry run"
40 /* //usage:  "\n        -N N            Number of inodes to create" */
41 /* //usage:  "\n        -o os           Set the 'creator os' field" */
42 /* //usage:  "\n        -O features     Dir_index/filetype/has_journal/journal_dev/sparse_super" */
43 /* //usage:  "\n        -q              Quiet" */
44 /* //usage:  "\n        -r rev          Set filesystem revision" */
45 /* //usage:  "\n        -S              Write superblock and group descriptors only" */
46 /* //usage:  "\n        -T fs-type      Set usage type (news/largefile/largefile4)" */
47 /* //usage:  "\n        -v              Verbose" */
48
49 #include "libbb.h"
50 #include <linux/fs.h>
51 #include <linux/ext2_fs.h>
52
53 #define ENABLE_FEATURE_MKFS_EXT2_RESERVED_GDT 0
54 #define ENABLE_FEATURE_MKFS_EXT2_DIR_INDEX    1
55
56 // from e2fsprogs
57 #define s_reserved_gdt_blocks s_padding1
58 #define s_mkfs_time           s_reserved[0]
59 #define s_flags               s_reserved[22]
60
61 #define EXT2_HASH_HALF_MD4       1
62 #define EXT2_FLAGS_SIGNED_HASH   0x0001
63 #define EXT2_FLAGS_UNSIGNED_HASH 0x0002
64
65 // storage helpers
66 char BUG_wrong_field_size(void);
67 #define STORE_LE(field, value) \
68 do { \
69         if (sizeof(field) == 4) \
70                 field = SWAP_LE32(value); \
71         else if (sizeof(field) == 2) \
72                 field = SWAP_LE16(value); \
73         else if (sizeof(field) == 1) \
74                 field = (value); \
75         else \
76                 BUG_wrong_field_size(); \
77 } while (0)
78
79 #define FETCH_LE32(field) \
80         (sizeof(field) == 4 ? SWAP_LE32(field) : BUG_wrong_field_size())
81
82 // All fields are little-endian
83 struct ext2_dir {
84         uint32_t inode1;
85         uint16_t rec_len1;
86         uint8_t  name_len1;
87         uint8_t  file_type1;
88         char     name1[4];
89         uint32_t inode2;
90         uint16_t rec_len2;
91         uint8_t  name_len2;
92         uint8_t  file_type2;
93         char     name2[4];
94         uint32_t inode3;
95         uint16_t rec_len3;
96         uint8_t  name_len3;
97         uint8_t  file_type3;
98         char     name3[12];
99 };
100
101 static unsigned int_log2(unsigned arg)
102 {
103         unsigned r = 0;
104         while ((arg >>= 1) != 0)
105                 r++;
106         return r;
107 }
108
109 // taken from mkfs_minix.c. libbb candidate?
110 // "uint32_t size", since we never use it for anything >32 bits
111 static uint32_t div_roundup(uint32_t size, uint32_t n)
112 {
113         // Overflow-resistant
114         uint32_t res = size / n;
115         if (res * n != size)
116                 res++;
117         return res;
118 }
119
120 static void allocate(uint8_t *bitmap, uint32_t blocksize, uint32_t start, uint32_t end)
121 {
122         uint32_t i;
123
124 //bb_info_msg("ALLOC: [%u][%u][%u]: [%u-%u]:=[%x],[%x]", blocksize, start, end, start/8, blocksize - end/8 - 1, (1 << (start & 7)) - 1, (uint8_t)(0xFF00 >> (end & 7)));
125         memset(bitmap, 0, blocksize);
126         i = start / 8;
127         memset(bitmap, 0xFF, i);
128         bitmap[i] = (1 << (start & 7)) - 1; //0..7 => 00000000..01111111
129         i = end / 8;
130         bitmap[blocksize - i - 1] |= 0x7F00 >> (end & 7); //0..7 => 00000000..11111110
131         memset(bitmap + blocksize - i, 0xFF, i); // N.B. no overflow here!
132 }
133
134 static uint32_t has_super(uint32_t x)
135 {
136         // 0, 1 and powers of 3, 5, 7 up to 2^32 limit
137         static const uint32_t supers[] = {
138                 0, 1, 3, 5, 7, 9, 25, 27, 49, 81, 125, 243, 343, 625, 729,
139                 2187, 2401, 3125, 6561, 15625, 16807, 19683, 59049, 78125,
140                 117649, 177147, 390625, 531441, 823543, 1594323, 1953125,
141                 4782969, 5764801, 9765625, 14348907, 40353607, 43046721,
142                 48828125, 129140163, 244140625, 282475249, 387420489,
143                 1162261467, 1220703125, 1977326743, 3486784401/* >2^31 */,
144         };
145         const uint32_t *sp = supers + ARRAY_SIZE(supers);
146         while (1) {
147                 sp--;
148                 if (x == *sp)
149                         return 1;
150                 if (x > *sp)
151                         return 0;
152         }
153 }
154
155 #define fd 3    /* predefined output descriptor */
156
157 static void PUT(uint64_t off, void *buf, uint32_t size)
158 {
159 //      bb_info_msg("PUT[%llu]:[%u]", off, size);
160         xlseek(fd, off, SEEK_SET);
161         xwrite(fd, buf, size);
162 }
163
164 // 128 and 256-byte inodes:
165 // 128-byte inode is described by struct ext2_inode.
166 // 256-byte one just has these fields appended:
167 //      __u16   i_extra_isize;
168 //      __u16   i_pad1;
169 //      __u32   i_ctime_extra;  /* extra Change time (nsec << 2 | epoch) */
170 //      __u32   i_mtime_extra;  /* extra Modification time (nsec << 2 | epoch) */
171 //      __u32   i_atime_extra;  /* extra Access time (nsec << 2 | epoch) */
172 //      __u32   i_crtime;       /* File creation time */
173 //      __u32   i_crtime_extra; /* extra File creation time (nsec << 2 | epoch)*/
174 //      __u32   i_version_hi;   /* high 32 bits for 64-bit version */
175 // the rest is padding.
176 //
177 // linux/ext2_fs.h has "#define i_size_high i_dir_acl" which suggests that even
178 // 128-byte inode is capable of describing large files (i_dir_acl is meaningful
179 // only for directories, which never need i_size_high).
180 //
181 // Standard mke2fs creates a filesystem with 256-byte inodes if it is
182 // bigger than 0.5GB.
183
184 // Standard mke2fs 1.41.9:
185 // Usage: mke2fs [-c|-l filename] [-b block-size] [-f fragment-size]
186 //      [-i bytes-per-inode] [-I inode-size] [-J journal-options]
187 //      [-G meta group size] [-N number-of-inodes]
188 //      [-m reserved-blocks-percentage] [-o creator-os]
189 //      [-g blocks-per-group] [-L volume-label] [-M last-mounted-directory]
190 //      [-O feature[,...]] [-r fs-revision] [-E extended-option[,...]]
191 //      [-T fs-type] [-U UUID] [-jnqvFSV] device [blocks-count]
192 //
193 // Options not commented below are taken but silently ignored:
194 enum {
195         OPT_c = 1 << 0,
196         OPT_l = 1 << 1,
197         OPT_b = 1 << 2,         // block size, in bytes
198         OPT_f = 1 << 3,
199         OPT_i = 1 << 4,         // bytes per inode
200         OPT_I = 1 << 5,         // custom inode size, in bytes
201         OPT_J = 1 << 6,
202         OPT_G = 1 << 7,
203         OPT_N = 1 << 8,
204         OPT_m = 1 << 9,         // percentage of blocks reserved for superuser
205         OPT_o = 1 << 10,
206         OPT_g = 1 << 11,
207         OPT_L = 1 << 12,        // label
208         OPT_M = 1 << 13,
209         OPT_O = 1 << 14,
210         OPT_r = 1 << 15,
211         OPT_E = 1 << 16,
212         OPT_T = 1 << 17,
213         OPT_U = 1 << 18,
214         OPT_j = 1 << 19,
215         OPT_n = 1 << 20,        // dry run: do not write anything
216         OPT_q = 1 << 21,
217         OPT_v = 1 << 22,
218         OPT_F = 1 << 23,
219         OPT_S = 1 << 24,
220         //OPT_V = 1 << 25,      // -V version. bbox applets don't support that
221 };
222
223 int mkfs_ext2_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
224 int mkfs_ext2_main(int argc UNUSED_PARAM, char **argv)
225 {
226         unsigned i, pos, n;
227         unsigned bs, bpi;
228         unsigned blocksize, blocksize_log2;
229         unsigned inodesize, user_inodesize;
230         unsigned reserved_percent = 5;
231         unsigned long long kilobytes;
232         uint32_t nblocks, nblocks_full;
233         uint32_t nreserved;
234         uint32_t ngroups;
235         uint32_t bytes_per_inode;
236         uint32_t first_block;
237         uint32_t inodes_per_group;
238         uint32_t group_desc_blocks;
239         uint32_t inode_table_blocks;
240         uint32_t lost_and_found_blocks;
241         time_t timestamp;
242         const char *label = "";
243         struct stat st;
244         struct ext2_super_block *sb; // superblock
245         struct ext2_group_desc *gd; // group descriptors
246         struct ext2_inode *inode;
247         struct ext2_dir *dir;
248         uint8_t *buf;
249
250         // using global "option_mask32" instead of local "opts":
251         // we are register starved here
252         opt_complementary = "-1:b+:i+:I+:m+";
253         /*opts =*/ getopt32(argv, "cl:b:f:i:I:J:G:N:m:o:g:L:M:O:r:E:T:U:jnqvFS",
254                 /*lbfi:*/ NULL, &bs, NULL, &bpi,
255                 /*IJGN:*/ &user_inodesize, NULL, NULL, NULL,
256                 /*mogL:*/ &reserved_percent, NULL, NULL, &label,
257                 /*MOrE:*/ NULL, NULL, NULL, NULL,
258                 /*TU:*/ NULL, NULL);
259         argv += optind; // argv[0] -- device
260
261         // open the device, check the device is a block device
262         xmove_fd(xopen(argv[0], O_WRONLY), fd);
263         xfstat(fd, &st, argv[0]);
264         if (!S_ISBLK(st.st_mode) && !(option_mask32 & OPT_F))
265                 bb_error_msg_and_die("%s: not a block device", argv[0]);
266
267         // check if it is mounted
268         // N.B. what if we format a file? find_mount_point will return false negative since
269         // it is loop block device which is mounted!
270         if (find_mount_point(argv[0], 0))
271                 bb_error_msg_and_die("can't format mounted filesystem");
272
273         // get size in kbytes
274         kilobytes = get_volume_size_in_bytes(fd, argv[1], 1024, /*extend:*/ !(option_mask32 & OPT_n)) / 1024;
275
276         bytes_per_inode = 16384;
277         if (kilobytes < 512*1024)
278                 bytes_per_inode = 4096;
279         if (kilobytes < 3*1024)
280                 bytes_per_inode = 8192;
281         if (option_mask32 & OPT_i)
282                 bytes_per_inode = bpi;
283
284         // Determine block size and inode size
285         // block size is a multiple of 1024
286         // inode size is a multiple of 128
287         blocksize = 1024;
288         inodesize = sizeof(struct ext2_inode); // 128
289         if (kilobytes >= 512*1024) { // mke2fs 1.41.9 compat
290                 blocksize = 4096;
291                 inodesize = 256;
292         }
293         if (EXT2_MAX_BLOCK_SIZE > 4096) {
294                 // kilobytes >> 22 == size in 4gigabyte chunks.
295                 // if size >= 16k gigs, blocksize must be increased.
296                 // Try "mke2fs -F image $((16 * 1024*1024*1024))"
297                 while ((kilobytes >> 22) >= blocksize)
298                         blocksize *= 2;
299         }
300         if (option_mask32 & OPT_b)
301                 blocksize = bs;
302         if (blocksize < EXT2_MIN_BLOCK_SIZE
303          || blocksize > EXT2_MAX_BLOCK_SIZE
304          || (blocksize & (blocksize - 1)) // not power of 2
305         ) {
306                 bb_error_msg_and_die("blocksize %u is bad", blocksize);
307         }
308         // Do we have custom inode size?
309         if (option_mask32 & OPT_I) {
310                 if (user_inodesize < sizeof(*inode)
311                  || user_inodesize > blocksize
312                  || (user_inodesize & (user_inodesize - 1)) // not power of 2
313                 ) {
314                         bb_error_msg("-%c is bad", 'I');
315                 } else {
316                         inodesize = user_inodesize;
317                 }
318         }
319
320         if ((int32_t)bytes_per_inode < blocksize)
321                 bb_error_msg_and_die("-%c is bad", 'i');
322         // number of bits in one block, i.e. 8*blocksize
323 #define blocks_per_group (8 * blocksize)
324         first_block = (EXT2_MIN_BLOCK_SIZE == blocksize);
325         blocksize_log2 = int_log2(blocksize);
326
327         // Determine number of blocks
328         kilobytes >>= (blocksize_log2 - EXT2_MIN_BLOCK_LOG_SIZE);
329         nblocks = kilobytes;
330         if (nblocks != kilobytes)
331                 bb_error_msg_and_die("block count doesn't fit in 32 bits");
332 #define kilobytes kilobytes_unused_after_this
333         // Experimentally, standard mke2fs won't work on images smaller than 60k
334         if (nblocks < 60)
335                 bb_error_msg_and_die("need >= 60 blocks");
336
337         // How many reserved blocks?
338         if (reserved_percent > 50)
339                 bb_error_msg_and_die("-%c is bad", 'm');
340         nreserved = (uint64_t)nblocks * reserved_percent / 100;
341
342         // N.B. killing e2fsprogs feature! Unused blocks don't account in calculations
343         nblocks_full = nblocks;
344
345         // If last block group is too small, nblocks may be decreased in order
346         // to discard it, and control returns here to recalculate some
347         // parameters.
348         // Note: blocksize and bytes_per_inode are never recalculated.
349  retry:
350         // N.B. a block group can have no more than blocks_per_group blocks
351         ngroups = div_roundup(nblocks - first_block, blocks_per_group);
352
353         group_desc_blocks = div_roundup(ngroups, blocksize / sizeof(*gd));
354         // TODO: reserved blocks must be marked as such in the bitmaps,
355         // or resulting filesystem is corrupt
356         if (ENABLE_FEATURE_MKFS_EXT2_RESERVED_GDT) {
357                 /*
358                  * From e2fsprogs: Calculate the number of GDT blocks to reserve for online
359                  * filesystem growth.
360                  * The absolute maximum number of GDT blocks we can reserve is determined by
361                  * the number of block pointers that can fit into a single block.
362                  * We set it at 1024x the current filesystem size, or
363                  * the upper block count limit (2^32), whichever is lower.
364                  */
365                 uint32_t reserved_group_desc_blocks = 0xFFFFFFFF; // maximum block number
366                 if (nblocks < reserved_group_desc_blocks / 1024)
367                         reserved_group_desc_blocks = nblocks * 1024;
368                 reserved_group_desc_blocks = div_roundup(reserved_group_desc_blocks - first_block, blocks_per_group);
369                 reserved_group_desc_blocks = div_roundup(reserved_group_desc_blocks, blocksize / sizeof(*gd)) - group_desc_blocks;
370                 if (reserved_group_desc_blocks > blocksize / sizeof(uint32_t))
371                         reserved_group_desc_blocks = blocksize / sizeof(uint32_t);
372                 //TODO: STORE_LE(sb->s_reserved_gdt_blocks, reserved_group_desc_blocks);
373                 group_desc_blocks += reserved_group_desc_blocks;
374         }
375
376         {
377                 // N.B. e2fsprogs does as follows!
378                 uint32_t overhead, remainder;
379                 // ninodes is the max number of inodes in this filesystem
380                 uint32_t ninodes = ((uint64_t) nblocks_full * blocksize) / bytes_per_inode;
381                 if (ninodes < EXT2_GOOD_OLD_FIRST_INO+1)
382                         ninodes = EXT2_GOOD_OLD_FIRST_INO+1;
383                 inodes_per_group = div_roundup(ninodes, ngroups);
384                 // minimum number because the first EXT2_GOOD_OLD_FIRST_INO-1 are reserved
385                 if (inodes_per_group < 16)
386                         inodes_per_group = 16;
387                 // a block group can't have more inodes than blocks
388                 if (inodes_per_group > blocks_per_group)
389                         inodes_per_group = blocks_per_group;
390                 // adjust inodes per group so they completely fill the inode table blocks in the descriptor
391                 inodes_per_group = (div_roundup(inodes_per_group * inodesize, blocksize) * blocksize) / inodesize;
392                 // make sure the number of inodes per group is a multiple of 8
393                 inodes_per_group &= ~7;
394                 inode_table_blocks = div_roundup(inodes_per_group * inodesize, blocksize);
395
396                 // to be useful, lost+found should occupy at least 2 blocks (but not exceeding 16*1024 bytes),
397                 // and at most EXT2_NDIR_BLOCKS. So reserve these blocks right now
398                 /* Or e2fsprogs comment verbatim (what does it mean?):
399                  * Ensure that lost+found is at least 2 blocks, so we always
400                  * test large empty blocks for big-block filesystems. */
401                 lost_and_found_blocks = MIN(EXT2_NDIR_BLOCKS, 16 >> (blocksize_log2 - EXT2_MIN_BLOCK_LOG_SIZE));
402
403                 // the last group needs more attention: isn't it too small for possible overhead?
404                 overhead = (has_super(ngroups - 1) ? (1/*sb*/ + group_desc_blocks) : 0) + 1/*bbmp*/ + 1/*ibmp*/ + inode_table_blocks;
405                 remainder = (nblocks - first_block) % blocks_per_group;
406                 ////can't happen, nblocks >= 60 guarantees this
407                 ////if ((1 == ngroups)
408                 //// && remainder
409                 //// && (remainder < overhead + 1/* "/" */ + lost_and_found_blocks)
410                 ////) {
411                 ////    bb_error_msg_and_die("way small device");
412                 ////}
413
414                 // Standard mke2fs uses 50. Looks like a bug in our calculation
415                 // of "remainder" or "overhead" - we don't match standard mke2fs
416                 // when we transition from one group to two groups
417                 // (a bit after 8M image size), but it works for two->three groups
418                 // transition (at 16M).
419                 if (remainder && (remainder < overhead + 50)) {
420 //bb_info_msg("CHOP[%u]", remainder);
421                         nblocks -= remainder;
422                         goto retry;
423                 }
424         }
425
426         if (nblocks_full - nblocks)
427                 printf("warning: %u blocks unused\n\n", nblocks_full - nblocks);
428         printf(
429                 "Filesystem label=%s\n"
430                 "OS type: Linux\n"
431                 "Block size=%u (log=%u)\n"
432                 "Fragment size=%u (log=%u)\n"
433                 "%u inodes, %u blocks\n"
434                 "%u blocks (%u%%) reserved for the super user\n"
435                 "First data block=%u\n"
436                 "Maximum filesystem blocks=%u\n"
437                 "%u block groups\n"
438                 "%u blocks per group, %u fragments per group\n"
439                 "%u inodes per group"
440                 , label
441                 , blocksize, blocksize_log2 - EXT2_MIN_BLOCK_LOG_SIZE
442                 , blocksize, blocksize_log2 - EXT2_MIN_BLOCK_LOG_SIZE
443                 , inodes_per_group * ngroups, nblocks
444                 , nreserved, reserved_percent
445                 , first_block
446                 , group_desc_blocks * (blocksize / (unsigned)sizeof(*gd)) * blocks_per_group
447                 , ngroups
448                 , blocks_per_group, blocks_per_group
449                 , inodes_per_group
450         );
451         {
452                 const char *fmt = "\nSuperblock backups stored on blocks:\n"
453                         "\t%u";
454                 pos = first_block;
455                 for (i = 1; i < ngroups; i++) {
456                         pos += blocks_per_group;
457                         if (has_super(i)) {
458                                 printf(fmt, (unsigned)pos);
459                                 fmt = ", %u";
460                         }
461                 }
462         }
463         bb_putchar('\n');
464
465         if (option_mask32 & OPT_n) {
466                 if (ENABLE_FEATURE_CLEAN_UP)
467                         close(fd);
468                 return EXIT_SUCCESS;
469         }
470
471         // TODO: 3/5 refuse if mounted
472         // TODO: 4/5 compat options
473         // TODO: 1/5 sanity checks
474         // TODO: 0/5 more verbose error messages
475         // TODO: 4/5 bigendianness: recheck, wait for ARM reporters
476         // TODO: 2/5 reserved GDT: how to mark but not allocate?
477         // TODO: 3/5 dir_index?
478
479         // fill the superblock
480         sb = xzalloc(1024);
481         STORE_LE(sb->s_rev_level, EXT2_DYNAMIC_REV); // revision 1 filesystem
482         STORE_LE(sb->s_magic, EXT2_SUPER_MAGIC);
483         STORE_LE(sb->s_inode_size, inodesize);
484         // set "Required extra isize" and "Desired extra isize" fields to 28
485         if (inodesize != sizeof(*inode))
486                 STORE_LE(sb->s_reserved[21], 0x001C001C);
487         STORE_LE(sb->s_first_ino, EXT2_GOOD_OLD_FIRST_INO);
488         STORE_LE(sb->s_log_block_size, blocksize_log2 - EXT2_MIN_BLOCK_LOG_SIZE);
489         STORE_LE(sb->s_log_frag_size, blocksize_log2 - EXT2_MIN_BLOCK_LOG_SIZE);
490         // first 1024 bytes of the device are for boot record. If block size is 1024 bytes, then
491         // the first block is 1, otherwise 0
492         STORE_LE(sb->s_first_data_block, first_block);
493         // block and inode bitmaps occupy no more than one block, so maximum number of blocks is
494         STORE_LE(sb->s_blocks_per_group, blocks_per_group);
495         STORE_LE(sb->s_frags_per_group, blocks_per_group);
496         // blocks
497         STORE_LE(sb->s_blocks_count, nblocks);
498         // reserve blocks for superuser
499         STORE_LE(sb->s_r_blocks_count, nreserved);
500         // ninodes
501         STORE_LE(sb->s_inodes_per_group, inodes_per_group);
502         STORE_LE(sb->s_inodes_count, inodes_per_group * ngroups);
503         STORE_LE(sb->s_free_inodes_count, inodes_per_group * ngroups - EXT2_GOOD_OLD_FIRST_INO);
504         // timestamps
505         timestamp = time(NULL);
506         STORE_LE(sb->s_mkfs_time, timestamp);
507         STORE_LE(sb->s_wtime, timestamp);
508         STORE_LE(sb->s_lastcheck, timestamp);
509         // misc. Values are chosen to match mke2fs 1.41.9
510         STORE_LE(sb->s_state, 1); // TODO: what's 1?
511         STORE_LE(sb->s_creator_os, EXT2_OS_LINUX);
512         STORE_LE(sb->s_checkinterval, 24*60*60 * 180); // 180 days
513         STORE_LE(sb->s_errors, EXT2_ERRORS_DEFAULT);
514         // mke2fs 1.41.9 also sets EXT3_FEATURE_COMPAT_RESIZE_INODE
515         // and if >= 0.5GB, EXT3_FEATURE_RO_COMPAT_LARGE_FILE.
516         // we use values which match "mke2fs -O ^resize_inode":
517         // in this case 1.41.9 never sets EXT3_FEATURE_RO_COMPAT_LARGE_FILE.
518         STORE_LE(sb->s_feature_compat, EXT2_FEATURE_COMPAT_SUPP
519                 | (EXT2_FEATURE_COMPAT_RESIZE_INO * ENABLE_FEATURE_MKFS_EXT2_RESERVED_GDT)
520                 | (EXT2_FEATURE_COMPAT_DIR_INDEX * ENABLE_FEATURE_MKFS_EXT2_DIR_INDEX)
521         );
522         STORE_LE(sb->s_feature_incompat, EXT2_FEATURE_INCOMPAT_FILETYPE);
523         STORE_LE(sb->s_feature_ro_compat, EXT2_FEATURE_RO_COMPAT_SPARSE_SUPER);
524         STORE_LE(sb->s_flags, EXT2_FLAGS_UNSIGNED_HASH * ENABLE_FEATURE_MKFS_EXT2_DIR_INDEX);
525         generate_uuid(sb->s_uuid);
526         if (ENABLE_FEATURE_MKFS_EXT2_DIR_INDEX) {
527                 STORE_LE(sb->s_def_hash_version, EXT2_HASH_HALF_MD4);
528                 generate_uuid((uint8_t *)sb->s_hash_seed);
529         }
530         /*
531          * From e2fsprogs: add "jitter" to the superblock's check interval so that we
532          * don't check all the filesystems at the same time.  We use a
533          * kludgy hack of using the UUID to derive a random jitter value.
534          */
535         STORE_LE(sb->s_max_mnt_count,
536                 EXT2_DFL_MAX_MNT_COUNT
537                 + (sb->s_uuid[ARRAY_SIZE(sb->s_uuid)-1] % EXT2_DFL_MAX_MNT_COUNT));
538
539         // write the label
540         safe_strncpy((char *)sb->s_volume_name, label, sizeof(sb->s_volume_name));
541
542         // calculate filesystem skeleton structures
543         gd = xzalloc(group_desc_blocks * blocksize);
544         buf = xmalloc(blocksize);
545         sb->s_free_blocks_count = 0;
546         for (i = 0, pos = first_block, n = nblocks - first_block;
547                 i < ngroups;
548                 i++, pos += blocks_per_group, n -= blocks_per_group
549         ) {
550                 uint32_t overhead = pos + (has_super(i) ? (1/*sb*/ + group_desc_blocks) : 0);
551                 uint32_t free_blocks;
552                 // fill group descriptors
553                 STORE_LE(gd[i].bg_block_bitmap, overhead + 0);
554                 STORE_LE(gd[i].bg_inode_bitmap, overhead + 1);
555                 STORE_LE(gd[i].bg_inode_table, overhead + 2);
556                 overhead = overhead - pos + 1/*bbmp*/ + 1/*ibmp*/ + inode_table_blocks;
557                 gd[i].bg_free_inodes_count = inodes_per_group;
558                 //STORE_LE(gd[i].bg_used_dirs_count, 0);
559                 // N.B. both "/" and "/lost+found" are within the first block group
560                 // "/" occupies 1 block, "/lost+found" occupies lost_and_found_blocks...
561                 if (0 == i) {
562                         // ... thus increased overhead for the first block group ...
563                         overhead += 1 + lost_and_found_blocks;
564                         // ... and 2 used directories
565                         STORE_LE(gd[i].bg_used_dirs_count, 2);
566                         // well known reserved inodes belong to the first block too
567                         gd[i].bg_free_inodes_count -= EXT2_GOOD_OLD_FIRST_INO;
568                 }
569
570                 // cache free block count of the group
571                 free_blocks = (n < blocks_per_group ? n : blocks_per_group) - overhead;
572
573                 // mark preallocated blocks as allocated
574 //bb_info_msg("ALLOC: [%u][%u][%u]", blocksize, overhead, blocks_per_group - (free_blocks + overhead));
575                 allocate(buf, blocksize,
576                         // reserve "overhead" blocks
577                         overhead,
578                         // mark unused trailing blocks
579                         blocks_per_group - (free_blocks + overhead)
580                 );
581                 // dump block bitmap
582                 PUT((uint64_t)(FETCH_LE32(gd[i].bg_block_bitmap)) * blocksize, buf, blocksize);
583                 STORE_LE(gd[i].bg_free_blocks_count, free_blocks);
584
585                 // mark preallocated inodes as allocated
586                 allocate(buf, blocksize,
587                         // mark reserved inodes
588                         inodes_per_group - gd[i].bg_free_inodes_count,
589                         // mark unused trailing inodes
590                         blocks_per_group - inodes_per_group
591                 );
592                 // dump inode bitmap
593                 //PUT((uint64_t)(FETCH_LE32(gd[i].bg_block_bitmap)) * blocksize, buf, blocksize);
594                 //but it's right after block bitmap, so we can just:
595                 xwrite(fd, buf, blocksize);
596                 STORE_LE(gd[i].bg_free_inodes_count, gd[i].bg_free_inodes_count);
597
598                 // count overall free blocks
599                 sb->s_free_blocks_count += free_blocks;
600         }
601         STORE_LE(sb->s_free_blocks_count, sb->s_free_blocks_count);
602
603         // dump filesystem skeleton structures
604 //      printf("Writing superblocks and filesystem accounting information: ");
605         for (i = 0, pos = first_block; i < ngroups; i++, pos += blocks_per_group) {
606                 // dump superblock and group descriptors and their backups
607                 if (has_super(i)) {
608                         // N.B. 1024 byte blocks are special
609                         PUT(((uint64_t)pos * blocksize) + ((0 == i && 1024 != blocksize) ? 1024 : 0),
610                                         sb, 1024);
611                         PUT(((uint64_t)pos * blocksize) + blocksize,
612                                         gd, group_desc_blocks * blocksize);
613                 }
614         }
615
616         // zero boot sectors
617         memset(buf, 0, blocksize);
618         PUT(0, buf, 1024); // N.B. 1024 <= blocksize, so buf[0..1023] contains zeros
619         // zero inode tables
620         for (i = 0; i < ngroups; ++i)
621                 for (n = 0; n < inode_table_blocks; ++n)
622                         PUT((uint64_t)(FETCH_LE32(gd[i].bg_inode_table) + n) * blocksize,
623                                 buf, blocksize);
624
625         // prepare directory inode
626         inode = (struct ext2_inode *)buf;
627         STORE_LE(inode->i_mode, S_IFDIR | S_IRWXU | S_IRGRP | S_IROTH | S_IXGRP | S_IXOTH);
628         STORE_LE(inode->i_mtime, timestamp);
629         STORE_LE(inode->i_atime, timestamp);
630         STORE_LE(inode->i_ctime, timestamp);
631         STORE_LE(inode->i_size, blocksize);
632         // inode->i_blocks stores the number of 512 byte data blocks
633         // (512, because it goes directly to struct stat without scaling)
634         STORE_LE(inode->i_blocks, blocksize / 512);
635
636         // dump root dir inode
637         STORE_LE(inode->i_links_count, 3); // "/.", "/..", "/lost+found/.." point to this inode
638         STORE_LE(inode->i_block[0], FETCH_LE32(gd[0].bg_inode_table) + inode_table_blocks);
639         PUT(((uint64_t)FETCH_LE32(gd[0].bg_inode_table) * blocksize) + (EXT2_ROOT_INO-1) * inodesize,
640                                 buf, inodesize);
641
642         // dump lost+found dir inode
643         STORE_LE(inode->i_links_count, 2); // both "/lost+found" and "/lost+found/." point to this inode
644         STORE_LE(inode->i_size, lost_and_found_blocks * blocksize);
645         STORE_LE(inode->i_blocks, (lost_and_found_blocks * blocksize) / 512);
646         n = FETCH_LE32(inode->i_block[0]) + 1;
647         for (i = 0; i < lost_and_found_blocks; ++i)
648                 STORE_LE(inode->i_block[i], i + n); // use next block
649 //bb_info_msg("LAST BLOCK USED[%u]", i + n);
650         PUT(((uint64_t)FETCH_LE32(gd[0].bg_inode_table) * blocksize) + (EXT2_GOOD_OLD_FIRST_INO-1) * inodesize,
651                                 buf, inodesize);
652
653         // dump directories
654         memset(buf, 0, blocksize);
655         dir = (struct ext2_dir *)buf;
656
657         // dump 2nd+ blocks of "/lost+found"
658         STORE_LE(dir->rec_len1, blocksize); // e2fsck 1.41.4 compat (1.41.9 does not need this)
659         for (i = 1; i < lost_and_found_blocks; ++i)
660                 PUT((uint64_t)(FETCH_LE32(gd[0].bg_inode_table) + inode_table_blocks + 1+i) * blocksize,
661                                 buf, blocksize);
662
663         // dump 1st block of "/lost+found"
664         STORE_LE(dir->inode1, EXT2_GOOD_OLD_FIRST_INO);
665         STORE_LE(dir->rec_len1, 12);
666         STORE_LE(dir->name_len1, 1);
667         STORE_LE(dir->file_type1, EXT2_FT_DIR);
668         dir->name1[0] = '.';
669         STORE_LE(dir->inode2, EXT2_ROOT_INO);
670         STORE_LE(dir->rec_len2, blocksize - 12);
671         STORE_LE(dir->name_len2, 2);
672         STORE_LE(dir->file_type2, EXT2_FT_DIR);
673         dir->name2[0] = '.'; dir->name2[1] = '.';
674         PUT((uint64_t)(FETCH_LE32(gd[0].bg_inode_table) + inode_table_blocks + 1) * blocksize, buf, blocksize);
675
676         // dump root dir block
677         STORE_LE(dir->inode1, EXT2_ROOT_INO);
678         STORE_LE(dir->rec_len2, 12);
679         STORE_LE(dir->inode3, EXT2_GOOD_OLD_FIRST_INO);
680         STORE_LE(dir->rec_len3, blocksize - 12 - 12);
681         STORE_LE(dir->name_len3, 10);
682         STORE_LE(dir->file_type3, EXT2_FT_DIR);
683         strcpy(dir->name3, "lost+found");
684         PUT((uint64_t)(FETCH_LE32(gd[0].bg_inode_table) + inode_table_blocks + 0) * blocksize, buf, blocksize);
685
686         // cleanup
687         if (ENABLE_FEATURE_CLEAN_UP) {
688                 free(buf);
689                 free(gd);
690                 free(sb);
691         }
692
693         xclose(fd);
694         return EXIT_SUCCESS;
695 }