busybox/util-linux/mkfs_reiser.c
<<
>>
Prefs
   1/* vi: set sw=4 ts=4: */
   2/*
   3 * mkfs_reiser: utility to create ReiserFS filesystem
   4 *
   5 * Busybox'ed (2009) by Vladimir Dronnikov <dronnikov@gmail.com>
   6 *
   7 * Licensed under GPLv2, see file LICENSE in this source tree.
   8 */
   9//config:config MKFS_REISER
  10//config:       bool "mkfs_reiser"
  11//config:       default n
  12//config:       help
  13//config:       Utility to create ReiserFS filesystems.
  14//config:       Note: this applet needs a lot of testing and polishing.
  15
  16//applet:IF_MKFS_REISER(APPLET_ODDNAME(mkfs.reiser, mkfs_reiser, BB_DIR_SBIN, BB_SUID_DROP, mkfs_reiser))
  17
  18//kbuild:lib-$(CONFIG_MKFS_REISER) += mkfs_reiser.o
  19
  20//usage:#define mkfs_reiser_trivial_usage
  21//usage:       "[-f] [-l LABEL] BLOCKDEV [4K-BLOCKS]"
  22//usage:#define mkfs_reiser_full_usage "\n\n"
  23//usage:       "Make a ReiserFS V3 filesystem\n"
  24//usage:     "\n        -f      Force"
  25//usage:     "\n        -l LBL  Volume label"
  26
  27#include "libbb.h"
  28#include <linux/fs.h>
  29
  30struct journal_params {
  31        uint32_t jp_journal_1st_block;      /* where does journal start from on its device */
  32        uint32_t jp_journal_dev;            /* journal device st_rdev */
  33        uint32_t jp_journal_size;           /* size of the journal on FS creation. used to make sure they don't overflow it */
  34        uint32_t jp_journal_trans_max;      /* max number of blocks in a transaction.  */
  35        uint32_t jp_journal_magic;          /* random value made on fs creation (this was sb_journal_block_count) */
  36        uint32_t jp_journal_max_batch;      /* max number of blocks to batch into a trans */
  37        uint32_t jp_journal_max_commit_age; /* in seconds, how old can an async commit be */
  38        uint32_t jp_journal_max_trans_age;  /* in seconds, how old can a transaction be */
  39};
  40
  41struct reiserfs_journal_header {
  42        uint32_t jh_last_flush_trans_id;    /* id of last fully flushed transaction */
  43        uint32_t jh_first_unflushed_offset; /* offset in the log of where to start replay after a crash */
  44        uint32_t jh_mount_id;
  45        struct journal_params jh_journal;
  46        uint32_t jh_last_check_mount_id;    /* the mount id of the fs during the last reiserfsck --check. */
  47};
  48
  49struct reiserfs_super_block {
  50        uint32_t sb_block_count;            /* 0 number of block on data device */
  51        uint32_t sb_free_blocks;            /* 4 free blocks count */
  52        uint32_t sb_root_block;             /* 8 root of the tree */
  53
  54        struct journal_params sb_journal;   /* 12 */
  55
  56        uint16_t sb_blocksize;          /* 44 */
  57        uint16_t sb_oid_maxsize;        /* 46 max size of object id array, see get_objectid() commentary */
  58        uint16_t sb_oid_cursize;        /* 48 current size of object id array */
  59        uint16_t sb_umount_state;       /* 50 this is set to 1 when filesystem was umounted, to 2 - when not */
  60
  61        char s_magic[10];               /* 52 "ReIsErFs" or "ReIsEr2Fs" or "ReIsEr3Fs" */
  62        uint16_t sb_fs_state;           /* 62 it is set to used by fsck to mark which phase of rebuilding is done (used for fsck debugging) */
  63        uint32_t sb_hash_function_code; /* 64 code of function which was/is/will be used to sort names in a directory. See codes in above */
  64        uint16_t sb_tree_height;        /* 68 height of filesytem tree. Tree consisting of only one root block has 2 here */
  65        uint16_t sb_bmap_nr;            /* 70 amount of bitmap blocks needed to address each block of file system */
  66        uint16_t sb_version;            /* 72 this field is only reliable on filesystem with non-standard journal */
  67        uint16_t sb_reserved_for_journal;  /* 74 size in blocks of journal area on main device, we need to keep after non-standard journal relocation */
  68        uint32_t sb_inode_generation;   /* 76 */
  69        uint32_t sb_flags;              /* 80 Right now used only by inode-attributes, if enabled */
  70        unsigned char s_uuid[16];       /* 84 filesystem unique identifier */
  71        unsigned char s_label[16];      /* 100 filesystem volume label */
  72        uint16_t sb_mnt_count;          /* 116 */
  73        uint16_t sb_max_mnt_count;      /* 118 */
  74        uint32_t sb_lastcheck;          /* 120 */
  75        uint32_t sb_check_interval;     /* 124 */
  76/* zero filled by mkreiserfs and reiserfs_convert_objectid_map_v1() so any additions must be updated there as well. */
  77        char s_unused[76];              /* 128 */
  78        /* 204 */
  79};
  80
  81/* Header of a disk block.  More precisely, header of a formatted leaf
  82   or internal node, and not the header of an unformatted node. */
  83struct block_head {
  84        uint16_t blk2_level;        /* Level of a block in the tree. */
  85        uint16_t blk2_nr_item;      /* Number of keys/items in a block. */
  86        uint16_t blk2_free_space;   /* Block free space in bytes. */
  87        uint16_t blk_reserved;
  88        uint32_t reserved[4];
  89};
  90
  91#define REISERFS_DISK_OFFSET_IN_BYTES (64 * 1024)
  92
  93#define REISERFS_3_6_SUPER_MAGIC_STRING "ReIsEr2Fs"
  94#define REISERFS_FORMAT_3_6     2
  95#define DEFAULT_MAX_MNT_COUNT   30                      /* 30 mounts */
  96#define DEFAULT_CHECK_INTERVAL  (180 * 60 * 60 * 24)    /* 180 days */
  97
  98#define FS_CLEANLY_UMOUNTED     1 /* this was REISERFS_VALID_FS */
  99
 100#define JOURNAL_MIN_SIZE        512
 101/* biggest possible single transaction, don't change for now (8/3/99) */
 102#define JOURNAL_TRANS_MAX       1024
 103#define JOURNAL_TRANS_MIN       256     /* need to check whether it works */
 104#define JOURNAL_DEFAULT_RATIO   8       /* default journal size / max trans length */
 105#define JOURNAL_MIN_RATIO       2
 106/* max blocks to batch into one transaction, don't make this any bigger than 900 */
 107#define JOURNAL_MAX_BATCH       900
 108#define JOURNAL_MAX_COMMIT_AGE  30
 109
 110
 111// Standard mkreiserfs 3.6.21:
 112//   -b | --block-size N              size of file-system block, in bytes
 113//   -j | --journal-device FILE       path to separate device to hold journal
 114//   -s | --journal-size N            size of the journal in blocks
 115//   -o | --journal-offset N          offset of the journal from the start of
 116//                                    the separate device, in blocks
 117//   -t | --transaction-max-size N    maximal size of transaction, in blocks
 118//   -B | --badblocks file            store all bad blocks given in file on the fs
 119//   -h | --hash rupasov|tea|r5       hash function to use by default
 120//   -u | --uuid UUID                 store UUID in the superblock
 121//   -l | --label LABEL               store LABEL in the superblock
 122//   --format 3.5|3.6                 old 3.5 format or newer 3.6
 123//   -f | --force                     specified once, make mkreiserfs the whole
 124//                                    disk, not block device or mounted partition;
 125//                                    specified twice, do not ask for confirmation
 126//   -q | --quiet                     quiet work without messages, progress and
 127//                                    questions. Useful if run in a script. For use
 128//                                    by end users only.
 129//   -d | --debug                     print debugging information during mkreiser
 130//   -V                               print version and exit
 131
 132// Options not commented below are taken but silently ignored:
 133enum {
 134        OPT_b = 1 << 0,
 135        OPT_j = 1 << 1,
 136        OPT_s = 1 << 2,
 137        OPT_o = 1 << 3,
 138        OPT_t = 1 << 4,
 139        OPT_B = 1 << 5,
 140        OPT_h = 1 << 6,
 141        OPT_u = 1 << 7,
 142        OPT_l = 1 << 8,         // label
 143        OPT_f = 1 << 9,         // ask no questions
 144        OPT_q = 1 << 10,
 145        OPT_d = 1 << 11,
 146        //OPT_V = 1 << 12,      // -V version. bbox applets don't support that
 147};
 148
 149int mkfs_reiser_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
 150int mkfs_reiser_main(int argc UNUSED_PARAM, char **argv)
 151{
 152        unsigned blocksize = 4096;
 153        unsigned journal_blocks = 8192;
 154        unsigned blocks, bitmap_blocks, i, block;
 155        time_t timestamp;
 156        const char *label = "";
 157        struct stat st;
 158        int fd;
 159        uint8_t *buf;
 160        struct reiserfs_super_block *sb;
 161        struct journal_params *jp;
 162        struct block_head *root;
 163
 164        // using global "option_mask32" instead of local "opts":
 165        // we are register starved here
 166        /*opts =*/ getopt32(argv, "^" "b:+j:s:o:t:B:h:u:l:fqd" "\0" "-1",
 167                NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, &label);
 168        argv += optind; // argv[0] -- device
 169
 170        // check the device is a block device
 171        fd = xopen(argv[0], O_WRONLY | O_EXCL);
 172        xfstat(fd, &st, argv[0]);
 173        if (!S_ISBLK(st.st_mode) && !(option_mask32 & OPT_f))
 174                bb_error_msg_and_die("%s: not a block device", argv[0]);
 175
 176        // check if it is mounted
 177        // N.B. what if we format a file? find_mount_point will return false negative since
 178        // it is loop block device which is mounted!
 179        if (find_mount_point(argv[0], 0))
 180                bb_simple_error_msg_and_die("can't format mounted filesystem");
 181
 182        // open the device, get size in blocks
 183        blocks = get_volume_size_in_bytes(fd, argv[1], blocksize, /*extend:*/ 1) / blocksize;
 184
 185        // block number sanity check
 186        // we have a limit: skipped area, super block, journal and root block
 187        // all have to be addressed by one first bitmap
 188        block = REISERFS_DISK_OFFSET_IN_BYTES / blocksize // boot area
 189                + 1             // sb
 190                + 1             // bitmap#0
 191                + journal_blocks+1      // journal
 192        ;
 193
 194        // count overhead
 195        bitmap_blocks = (blocks - 1) / (blocksize * 8) + 1;
 196        i = block + bitmap_blocks;
 197
 198        // check overhead
 199        if (MIN(blocksize * 8, blocks) < i)
 200                bb_error_msg_and_die("need >= %u blocks", i);
 201
 202        // ask confirmation?
 203        // TODO: ???
 204
 205        // wipe out first REISERFS_DISK_OFFSET_IN_BYTES of device
 206        // TODO: do we really need to wipe?!
 207        xlseek(fd, REISERFS_DISK_OFFSET_IN_BYTES, SEEK_SET);
 208
 209        // fill superblock
 210        sb = (struct reiserfs_super_block *)xzalloc(blocksize);
 211        // block count
 212        STORE_LE(sb->sb_block_count, blocks);
 213        STORE_LE(sb->sb_free_blocks, blocks - i);
 214        // TODO: decypher!
 215        STORE_LE(sb->sb_root_block, block);
 216        // fill journal related fields
 217        jp = &sb->sb_journal;
 218        STORE_LE(jp->jp_journal_1st_block, REISERFS_DISK_OFFSET_IN_BYTES / blocksize + 1/*sb*/ + 1/*bmp#0*/);
 219        timestamp = time(NULL);
 220        srand(timestamp);
 221        STORE_LE(jp->jp_journal_magic, rand());
 222        STORE_LE(jp->jp_journal_size, journal_blocks);
 223        STORE_LE(jp->jp_journal_trans_max, JOURNAL_TRANS_MAX);
 224        STORE_LE(jp->jp_journal_max_batch, JOURNAL_MAX_BATCH);
 225        STORE_LE(jp->jp_journal_max_commit_age, JOURNAL_MAX_COMMIT_AGE);
 226        // sizes
 227        STORE_LE(sb->sb_blocksize, blocksize);
 228        STORE_LE(sb->sb_oid_maxsize, (blocksize - sizeof(*sb)) / sizeof(uint32_t) / 2 * 2);
 229        STORE_LE(sb->sb_oid_cursize, 2); // "." and ".."
 230        strcpy(sb->s_magic, REISERFS_3_6_SUPER_MAGIC_STRING);
 231        STORE_LE(sb->sb_bmap_nr, (bitmap_blocks > ((1LL << 16) - 1)) ? 0 : bitmap_blocks);
 232        // misc
 233        STORE_LE(sb->sb_version, REISERFS_FORMAT_3_6);
 234        STORE_LE(sb->sb_lastcheck, timestamp);
 235        STORE_LE(sb->sb_check_interval, DEFAULT_CHECK_INTERVAL);
 236        STORE_LE(sb->sb_mnt_count, 1);
 237        STORE_LE(sb->sb_max_mnt_count, DEFAULT_MAX_MNT_COUNT);
 238        STORE_LE(sb->sb_umount_state, FS_CLEANLY_UMOUNTED);
 239        STORE_LE(sb->sb_tree_height, 2);
 240        STORE_LE(sb->sb_hash_function_code, 3); // R5_HASH
 241        STORE_LE(sb->sb_flags, 1);
 242        //STORE_LE(sb->sb_reserved_for_journal, 0);
 243        // create UUID
 244        generate_uuid(sb->s_uuid);
 245        // write the label
 246        safe_strncpy((char *)sb->s_label, label, sizeof(sb->s_label));
 247
 248        // TODO: EMPIRIC! ENDIANNESS!
 249        // superblock has only 204 bytes. What are these?
 250        buf = (uint8_t *)sb;
 251        buf[205] = 1;
 252        buf[209] = 3;
 253
 254        // put superblock
 255        xwrite(fd, sb, blocksize);
 256
 257        // create bitmaps
 258        buf = xzalloc(blocksize);
 259
 260        // bitmap #0 uses initial "block"+1 blocks
 261        i = block + 1;
 262        memset(buf, 0xFF, i / 8);
 263        buf[i / 8] = (1 << (i & 7)) - 1; //0..7 => 00000000..01111111
 264        // mark trailing absent blocks, if any
 265        if (blocks < 8*blocksize) {
 266                unsigned n = 8*blocksize - blocks;
 267                i = n / 8;
 268                buf[blocksize - i - 1] |= 0x7F00 >> (n & 7); //0..7 => 00000000..11111110
 269                memset(buf + blocksize - i, 0xFF, i); // N.B. no overflow here!
 270        }
 271        // put bitmap #0
 272        xwrite(fd, buf, blocksize);
 273
 274        // now go journal blocks
 275        memset(buf, 0, blocksize);
 276        for (i = 0; i < journal_blocks; i++)
 277                xwrite(fd, buf, blocksize);
 278        // dump journal control block
 279        memcpy(&((struct reiserfs_journal_header *)buf)->jh_journal, &sb->sb_journal, sizeof(sb->sb_journal));
 280        xwrite(fd, buf, blocksize);
 281
 282        // other bitmaps are in every (8*blocksize)-th block
 283        // N.B. they use the only block -- namely bitmap itself!
 284        buf[0] = 0x01;
 285        // put bitmaps
 286        for (i = 1; i < bitmap_blocks; i++) {
 287                xlseek(fd, i*8*blocksize * blocksize, SEEK_SET);
 288                // mark trailing absent blocks, if any
 289                if (i == bitmap_blocks - 1 && (blocks % (8*blocksize))) {
 290                        unsigned n = 8*blocksize - blocks % (8*blocksize);
 291                        unsigned j = n / 8;
 292                        buf[blocksize - j - 1] |= 0x7F00 >> (n & 7); //0..7 => 00000000..11111110
 293                        memset(buf + blocksize - j, 0xFF, j); // N.B. no overflow here!
 294                }
 295                xwrite(fd, buf, blocksize);
 296        }
 297
 298        // fill root block
 299        // block head
 300        memset(buf, 0, blocksize);
 301        root = (struct block_head *)buf;
 302        STORE_LE(root->blk2_level, 1); // leaf node
 303        STORE_LE(root->blk2_nr_item, 2); // "." and ".."
 304        STORE_LE(root->blk2_free_space, blocksize - sizeof(struct block_head));
 305        // item head
 306        // root directory
 307        // TODO: EMPIRIC! ENDIANNESS!
 308        // TODO: indented assignments seem to be timestamps
 309buf[4] = 0134;
 310buf[24] = 01;
 311buf[28] = 02;
 312buf[42] = 054;
 313buf[44] = 0324;
 314buf[45] = 017;
 315buf[46] = 01;
 316buf[48] = 01;
 317buf[52] = 02;
 318buf[56] = 01;
 319buf[60] = 0364;
 320buf[61] = 01;
 321buf[64] = 02;
 322buf[66] = 060;
 323buf[68] = 0244;
 324buf[69] = 017;
 325buf[4004] = 01;
 326buf[4008] = 01;
 327buf[4012] = 02;
 328buf[4016] = 050;
 329buf[4018] = 04;
 330buf[4020] = 02;
 331buf[4028] = 01;
 332buf[4032] = 040;
 333buf[4034] = 04;
 334
 335buf[4036] = 056; buf[4037] = 056;       // ".."
 336buf[4044] = 056;                        // "."
 337
 338buf[4052] = 0355;
 339buf[4053] = 0101;
 340buf[4056] = 03;
 341buf[4060] = 060;
 342                buf[4076] = 0173;
 343                buf[4077] = 0240;
 344        buf[4078] = 0344;
 345        buf[4079] = 0112;
 346                buf[4080] = 0173;
 347                buf[4081] = 0240;
 348        buf[4082] = 0344;
 349        buf[4083] = 0112;
 350                buf[4084] = 0173;
 351                buf[4085] = 0240;
 352        buf[4086] = 0344;
 353        buf[4087] = 0112;
 354buf[4088] = 01;
 355
 356        // put root block
 357        xlseek(fd, block * blocksize, SEEK_SET);
 358        xwrite(fd, buf, blocksize);
 359
 360        // cleanup
 361        if (ENABLE_FEATURE_CLEAN_UP) {
 362                free(buf);
 363                free(sb);
 364        }
 365
 366        xclose(fd);
 367        return EXIT_SUCCESS;
 368}
 369