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