2 * mkjournal.c --- make a journal for a filesystem
4 * Copyright (C) 2000 Theodore Ts'o.
7 * This file may be redistributed under the terms of the GNU Public
26 #include <sys/types.h>
29 #include <sys/ioctl.h>
32 #include <netinet/in.h>
41 * This function automatically sets up the journal superblock and
42 * returns it as an allocated block.
44 errcode_t ext2fs_create_journal_superblock(ext2_filsys fs,
45 __u32 size, int flags,
49 journal_superblock_t *jsb;
52 return EXT2_ET_JOURNAL_TOO_SMALL;
54 if ((retval = ext2fs_get_mem(fs->blocksize, &jsb)))
57 memset (jsb, 0, fs->blocksize);
59 jsb->s_header.h_magic = htonl(JFS_MAGIC_NUMBER);
60 if (flags & EXT2_MKJOURNAL_V1_SUPER)
61 jsb->s_header.h_blocktype = htonl(JFS_SUPERBLOCK_V1);
63 jsb->s_header.h_blocktype = htonl(JFS_SUPERBLOCK_V2);
64 jsb->s_blocksize = htonl(fs->blocksize);
65 jsb->s_maxlen = htonl(size);
66 jsb->s_nr_users = htonl(1);
67 jsb->s_first = htonl(1);
68 jsb->s_sequence = htonl(1);
69 memcpy(jsb->s_uuid, fs->super->s_uuid, sizeof(fs->super->s_uuid));
71 * If we're creating an external journal device, we need to
72 * adjust these fields.
74 if (fs->super->s_feature_incompat &
75 EXT3_FEATURE_INCOMPAT_JOURNAL_DEV) {
77 if (fs->blocksize == 1024)
78 jsb->s_first = htonl(3);
80 jsb->s_first = htonl(2);
83 *ret_jsb = (char *) jsb;
88 * This function writes a journal using POSIX routines. It is used
89 * for creating external journals and creating journals on live
92 static errcode_t write_journal_file(ext2_filsys fs, char *filename,
93 blk_t size, int flags)
100 if ((retval = ext2fs_create_journal_superblock(fs, size, flags, &buf)))
103 /* Open the device or journal file */
104 if ((fd = open(filename, O_WRONLY)) < 0) {
109 /* Write the superblock out */
110 retval = EXT2_ET_SHORT_WRITE;
111 ret_size = write(fd, buf, fs->blocksize);
116 if (ret_size != (int) fs->blocksize)
118 memset(buf, 0, fs->blocksize);
120 for (i = 1; i < size; i++) {
121 ret_size = write(fd, buf, fs->blocksize);
126 if (ret_size != (int) fs->blocksize)
133 ext2fs_free_mem(&buf);
138 * Convenience function which zeros out _num_ blocks starting at
139 * _blk_. In case of an error, the details of the error is returned
140 * via _ret_blk_ and _ret_count_ if they are non-NULL pointers.
141 * Returns 0 on success, and an error code on an error.
143 * As a special case, if the first argument is NULL, then it will
144 * attempt to free the static zeroizing buffer. (This is to keep
145 * programs that check for memory leaks happy.)
147 #define STRIDE_LENGTH 8
148 errcode_t ext2fs_zero_blocks(ext2_filsys fs, blk_t blk, int num,
149 blk_t *ret_blk, int *ret_count)
155 /* If fs is null, clean up the static buffer and return */
163 /* Allocate the zeroizing buffer if necessary */
165 buf = malloc(fs->blocksize * STRIDE_LENGTH);
168 memset(buf, 0, fs->blocksize * STRIDE_LENGTH);
170 /* OK, do the write loop */
173 if (blk % STRIDE_LENGTH) {
174 count = STRIDE_LENGTH - (blk % STRIDE_LENGTH);
175 if (count > (num - j))
179 if (count > STRIDE_LENGTH)
180 count = STRIDE_LENGTH;
182 retval = io_channel_write_blk(fs->io, blk, count, buf);
190 j += count; blk += count;
196 * Helper function for creating the journal using direct I/O routines
198 struct mkjournal_struct {
208 static int mkjournal_proc(ext2_filsys fs,
210 e2_blkcnt_t blockcnt,
211 blk_t ref_block EXT2FS_ATTR((unused)),
212 int ref_offset EXT2FS_ATTR((unused)),
215 struct mkjournal_struct *es = (struct mkjournal_struct *) priv_data;
223 retval = ext2fs_new_block(fs, es->goal, 0, &new_blk);
234 retval = io_channel_write_blk(fs->io, new_blk, 1, es->buf);
236 if (es->zero_count) {
237 if ((es->blk_to_zero + es->zero_count == new_blk) &&
238 (es->zero_count < 1024))
241 retval = ext2fs_zero_blocks(fs,
248 if (es->zero_count == 0) {
249 es->blk_to_zero = new_blk;
255 memset(es->buf, 0, fs->blocksize);
261 *blocknr = es->goal = new_blk;
262 ext2fs_block_alloc_stats(fs, new_blk, +1);
264 if (es->num_blocks == 0)
265 return (BLOCK_CHANGED | BLOCK_ABORT);
267 return BLOCK_CHANGED;
272 * This function creates a journal using direct I/O routines.
274 static errcode_t write_journal_inode(ext2_filsys fs, ext2_ino_t journal_ino,
275 blk_t size, int flags)
278 dgrp_t group, start, end, i, log_flex;
280 struct ext2_inode inode;
281 struct mkjournal_struct es;
283 if ((retval = ext2fs_create_journal_superblock(fs, size, flags, &buf)))
286 if ((retval = ext2fs_read_bitmaps(fs)))
289 if ((retval = ext2fs_read_inode(fs, journal_ino, &inode)))
292 if (inode.i_blocks > 0)
295 es.num_blocks = size;
301 if (fs->super->s_feature_incompat & EXT3_FEATURE_INCOMPAT_EXTENTS) {
302 inode.i_flags |= EXT4_EXTENTS_FL;
303 if ((retval = ext2fs_write_inode(fs, journal_ino, &inode)))
308 * Set the initial goal block to be roughly at the middle of
309 * the filesystem. Pick a group that has the largest number
312 group = ext2fs_group_of_blk(fs, (fs->super->s_blocks_count -
313 fs->super->s_first_data_block) / 2);
314 log_flex = 1 << fs->super->s_log_groups_per_flex;
315 if (fs->super->s_log_groups_per_flex && (group > log_flex)) {
316 group = group & ~(log_flex - 1);
317 while ((group < fs->group_desc_count) &&
318 fs->group_desc[group].bg_free_blocks_count == 0)
320 if (group == fs->group_desc_count)
324 start = (group > 0) ? group-1 : group;
325 end = ((group+1) < fs->group_desc_count) ? group+1 : group;
327 for (i=start+1; i <= end; i++)
328 if (fs->group_desc[i].bg_free_blocks_count >
329 fs->group_desc[group].bg_free_blocks_count)
332 es.goal = (fs->super->s_blocks_per_group * group) +
333 fs->super->s_first_data_block;
335 retval = ext2fs_block_iterate2(fs, journal_ino, BLOCK_FLAG_APPEND,
336 0, mkjournal_proc, &es);
342 retval = ext2fs_zero_blocks(fs, es.blk_to_zero,
343 es.zero_count, 0, 0);
348 if ((retval = ext2fs_read_inode(fs, journal_ino, &inode)))
351 inode.i_size += fs->blocksize * size;
352 ext2fs_iblk_add_blocks(fs, &inode, es.newblocks);
353 inode.i_mtime = inode.i_ctime = fs->now ? fs->now : time(0);
354 inode.i_links_count = 1;
355 inode.i_mode = LINUX_S_IFREG | 0600;
357 if ((retval = ext2fs_write_inode(fs, journal_ino, &inode)))
361 memcpy(fs->super->s_jnl_blocks, inode.i_block, EXT2_N_BLOCKS*4);
362 fs->super->s_jnl_blocks[16] = inode.i_size;
363 fs->super->s_jnl_backup_type = EXT3_JNL_BACKUP_BLOCKS;
364 ext2fs_mark_super_dirty(fs);
367 ext2fs_free_mem(&buf);
372 * Find a reasonable journal file size (in blocks) given the number of blocks
373 * in the filesystem. For very small filesystems, it is not reasonable to
374 * have a journal that fills more than half of the filesystem.
376 int ext2fs_default_journal_size(__u64 blocks)
382 if (blocks < 256*1024)
384 if (blocks < 512*1024)
386 if (blocks < 1024*1024)
392 * This function adds a journal device to a filesystem
394 errcode_t ext2fs_add_journal_device(ext2_filsys fs, ext2_filsys journal_dev)
399 journal_superblock_t *jsb;
403 /* Make sure the device exists and is a block device */
404 if (stat(journal_dev->device_name, &st) < 0)
407 if (!S_ISBLK(st.st_mode))
408 return EXT2_ET_JOURNAL_NOT_BLOCK; /* Must be a block device */
410 /* Get the journal superblock */
412 if (journal_dev->blocksize == 1024)
414 if ((retval = io_channel_read_blk(journal_dev->io, start, -1024, buf)))
417 jsb = (journal_superblock_t *) buf;
418 if ((jsb->s_header.h_magic != (unsigned) ntohl(JFS_MAGIC_NUMBER)) ||
419 (jsb->s_header.h_blocktype != (unsigned) ntohl(JFS_SUPERBLOCK_V2)))
420 return EXT2_ET_NO_JOURNAL_SB;
422 if (ntohl(jsb->s_blocksize) != (unsigned long) fs->blocksize)
423 return EXT2_ET_UNEXPECTED_BLOCK_SIZE;
425 /* Check and see if this filesystem has already been added */
426 nr_users = ntohl(jsb->s_nr_users);
427 for (i=0; i < nr_users; i++) {
428 if (memcmp(fs->super->s_uuid,
429 &jsb->s_users[i*16], 16) == 0)
433 memcpy(&jsb->s_users[nr_users*16],
434 fs->super->s_uuid, 16);
435 jsb->s_nr_users = htonl(nr_users+1);
438 /* Writeback the journal superblock */
439 if ((retval = io_channel_write_blk(journal_dev->io, start, -1024, buf)))
442 fs->super->s_journal_inum = 0;
443 fs->super->s_journal_dev = st.st_rdev;
444 memcpy(fs->super->s_journal_uuid, jsb->s_uuid,
445 sizeof(fs->super->s_journal_uuid));
446 fs->super->s_feature_compat |= EXT3_FEATURE_COMPAT_HAS_JOURNAL;
447 ext2fs_mark_super_dirty(fs);
452 * This function adds a journal inode to a filesystem, using either
453 * POSIX routines if the filesystem is mounted, or using direct I/O
454 * functions if it is not.
456 errcode_t ext2fs_add_journal_inode(ext2_filsys fs, blk_t size, int flags)
459 ext2_ino_t journal_ino;
465 if ((retval = ext2fs_check_mount_point(fs->device_name, &mount_flags,
466 jfile, sizeof(jfile)-10)))
469 if (mount_flags & EXT2_MF_MOUNTED) {
470 strcat(jfile, "/.journal");
473 * If .../.journal already exists, make sure any
474 * immutable or append-only flags are cleared.
476 #if defined(HAVE_CHFLAGS) && defined(UF_NODUMP)
477 (void) chflags (jfile, 0);
480 fd = open(jfile, O_RDONLY);
483 ioctl(fd, EXT2_IOC_SETFLAGS, &f);
489 /* Create the journal file */
490 if ((fd = open(jfile, O_CREAT|O_WRONLY, 0600)) < 0)
493 if ((retval = write_journal_file(fs, jfile, size, flags)))
496 /* Get inode number of the journal file */
497 if (fstat(fd, &st) < 0)
500 #if defined(HAVE_CHFLAGS) && defined(UF_NODUMP)
501 retval = fchflags (fd, UF_NODUMP|UF_IMMUTABLE);
504 f = EXT2_NODUMP_FL | EXT2_IMMUTABLE_FL;
505 retval = ioctl(fd, EXT2_IOC_SETFLAGS, &f);
512 journal_ino = st.st_ino;
514 if ((mount_flags & EXT2_MF_BUSY) &&
515 !(fs->flags & EXT2_FLAG_EXCLUSIVE)) {
519 journal_ino = EXT2_JOURNAL_INO;
520 if ((retval = write_journal_inode(fs, journal_ino,
525 fs->super->s_journal_inum = journal_ino;
526 fs->super->s_journal_dev = 0;
527 memset(fs->super->s_journal_uuid, 0,
528 sizeof(fs->super->s_journal_uuid));
529 fs->super->s_feature_compat |= EXT3_FEATURE_COMPAT_HAS_JOURNAL;
531 ext2fs_mark_super_dirty(fs);
540 main(int argc, char **argv)
547 fprintf(stderr, "Usage: %s filesystem\n", argv[0]);
550 device_name = argv[1];
552 retval = ext2fs_open (device_name, EXT2_FLAG_RW, 0, 0,
553 unix_io_manager, &fs);
555 com_err(argv[0], retval, "while opening %s", device_name);
559 retval = ext2fs_add_journal_inode(fs, 1024);
561 com_err(argv[0], retval, "while adding journal to %s",
565 retval = ext2fs_flush(fs);
567 printf("Warning, had trouble writing out superblocks.\n");