2 * Copyright (c) 2009 The DragonFly Project. All rights reserved.
4 * This code is derived from software contributed to The DragonFly Project
5 * by Matthew Dillon <dillon@backplane.com> and
6 * Michael Neumann <mneumann@ntecs.de>
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in
16 * the documentation and/or other materials provided with the
18 * 3. Neither the name of The DragonFly Project nor the names of its
19 * contributors may be used to endorse or promote products derived
20 * from this software without specific, prior written permission.
22 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
25 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
26 * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
27 * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
28 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
29 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
30 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
31 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
32 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
39 struct bigblock_stat {
40 int64_t total_bigblocks;
41 int64_t total_free_bigblocks;
46 hammer_format_volume_header(struct hammer_mount *hmp,
47 struct hammer_volume_ondisk *ondisk,
48 const char *vol_name, int vol_no, int vol_count,
49 int64_t vol_size, int64_t boot_area_size, int64_t mem_area_size);
52 hammer_update_volumes_header(hammer_transaction_t trans,
53 struct bigblock_stat *stat);
56 hammer_do_reblock(hammer_transaction_t trans, hammer_inode_t ip);
59 hammer_format_freemap(hammer_transaction_t trans, hammer_volume_t volume,
60 struct bigblock_stat *stat);
63 hammer_free_freemap(hammer_transaction_t trans, hammer_volume_t volume,
64 struct bigblock_stat *stat);
67 hammer_test_free_freemap(hammer_transaction_t trans, hammer_volume_t volume);
70 hammer_ioc_volume_add(hammer_transaction_t trans, hammer_inode_t ip,
71 struct hammer_ioc_volume *ioc)
73 struct hammer_mount *hmp = trans->hmp;
74 struct mount *mp = hmp->mp;
75 struct hammer_volume_ondisk ondisk;
76 struct bigblock_stat stat;
77 hammer_volume_t volume;
81 if (mp->mnt_flag & MNT_RDONLY) {
82 hmkprintf(hmp, "Cannot add volume to read-only HAMMER filesystem\n");
86 if (hmp->nvolumes >= HAMMER_MAX_VOLUMES) {
87 hmkprintf(hmp, "Max number of HAMMER volumes exceeded\n");
91 if (hammer_lock_ex_try(&hmp->volume_lock) != 0) {
92 hmkprintf(hmp, "Another volume operation is in progress!\n");
97 * Find an unused volume number.
99 while (free_vol_no < HAMMER_MAX_VOLUMES &&
100 HAMMER_VOLUME_NUMBER_IS_SET(hmp, free_vol_no)) {
103 if (free_vol_no >= HAMMER_MAX_VOLUMES) {
104 hmkprintf(hmp, "Max number of HAMMER volumes exceeded\n");
109 error = hammer_format_volume_header(
112 hmp->rootvol->ondisk->vol_name,
121 error = hammer_install_volume(hmp, ioc->device_name, NULL, &ondisk);
125 hammer_sync_lock_sh(trans);
126 hammer_lock_ex(&hmp->blkmap_lock);
128 volume = hammer_get_volume(hmp, free_vol_no, &error);
129 KKASSERT(volume != NULL && error == 0);
131 error = hammer_format_freemap(trans, volume, &stat);
132 KKASSERT(error == 0);
133 hammer_rel_volume(volume, 0);
136 error = hammer_update_volumes_header(trans, &stat);
137 KKASSERT(error == 0);
139 hammer_unlock(&hmp->blkmap_lock);
140 hammer_sync_unlock(trans);
142 KKASSERT(error == 0);
144 hammer_unlock(&hmp->volume_lock);
146 hmkprintf(hmp, "An error occurred: %d\n", error);
155 hammer_ioc_volume_del(hammer_transaction_t trans, hammer_inode_t ip,
156 struct hammer_ioc_volume *ioc)
158 struct hammer_mount *hmp = trans->hmp;
159 struct mount *mp = hmp->mp;
160 struct hammer_volume_ondisk *ondisk;
161 struct bigblock_stat stat;
162 hammer_volume_t volume;
166 if (mp->mnt_flag & MNT_RDONLY) {
167 hmkprintf(hmp, "Cannot del volume from read-only HAMMER filesystem\n");
171 if (hmp->nvolumes <= 1) {
172 hmkprintf(hmp, "No HAMMER volume to delete\n");
176 if (hammer_lock_ex_try(&hmp->volume_lock) != 0) {
177 hmkprintf(hmp, "Another volume operation is in progress!\n");
182 * find volume by volname
185 HAMMER_VOLUME_NUMBER_FOREACH(hmp, vol_no) {
186 volume = hammer_get_volume(hmp, vol_no, &error);
187 KKASSERT(volume != NULL && error == 0);
188 if (strcmp(volume->vol_name, ioc->device_name) == 0) {
191 hammer_rel_volume(volume, 0);
195 if (volume == NULL) {
196 hmkprintf(hmp, "Couldn't find volume\n");
201 if (volume == trans->rootvol) {
202 hmkprintf(hmp, "Cannot remove root-volume\n");
203 hammer_rel_volume(volume, 0);
209 * Reblock filesystem if the volume is not empty
211 hmp->volume_to_remove = volume->vol_no;
213 if (hammer_test_free_freemap(trans, volume)) {
214 error = hammer_do_reblock(trans, ip);
216 hmp->volume_to_remove = -1;
217 hammer_rel_volume(volume, 0);
225 hammer_flush_dirty(hmp, 30);
227 hammer_sync_lock_sh(trans);
228 hammer_lock_ex(&hmp->blkmap_lock);
231 * We use stat later to update rootvol's big-block stats
233 error = hammer_free_freemap(trans, volume, &stat);
235 hmkprintf(hmp, "Failed to free volume: ");
237 kprintf("Volume %d not empty\n", volume->vol_no);
239 kprintf("%d\n", error);
240 hmp->volume_to_remove = -1;
241 hammer_rel_volume(volume, 0);
244 hammer_rel_volume(volume, 0);
249 RB_SCAN(hammer_buf_rb_tree, &hmp->rb_bufs_root, NULL,
250 hammer_unload_buffer, volume);
252 bzero(&ondisk, sizeof(ondisk));
253 error = hammer_unload_volume(volume, &ondisk);
255 hmkprintf(hmp, "Failed to unload volume\n");
260 error = hammer_update_volumes_header(trans, &stat);
261 KKASSERT(error == 0);
262 hmp->volume_to_remove = -1;
265 hammer_unlock(&hmp->blkmap_lock);
266 hammer_sync_unlock(trans);
269 hammer_unlock(&hmp->volume_lock);
271 hmkprintf(hmp, "An error occurred: %d\n", error);
277 hammer_ioc_volume_list(hammer_transaction_t trans, hammer_inode_t ip,
278 struct hammer_ioc_volume_list *ioc)
280 struct hammer_mount *hmp = trans->hmp;
281 hammer_volume_t volume;
285 if (hammer_lock_ex_try(&hmp->volume_lock) != 0) {
286 hmkprintf(hmp, "Another volume operation is in progress!\n");
290 HAMMER_VOLUME_NUMBER_FOREACH(hmp, i) {
291 if (cnt >= ioc->nvols)
293 volume = hammer_get_volume(hmp, i, &error);
294 KKASSERT(volume != NULL && error == 0);
296 len = strlen(volume->vol_name) + 1;
297 KKASSERT(len <= MAXPATHLEN);
299 error = copyout(volume->vol_name, ioc->vols[cnt].device_name,
301 hammer_rel_volume(volume, 0);
309 hammer_unlock(&hmp->volume_lock);
315 hammer_do_reblock(hammer_transaction_t trans, hammer_inode_t ip)
317 struct hammer_mount *hmp = trans->hmp;
321 struct hammer_ioc_reblock reblock;
322 bzero(&reblock, sizeof(reblock));
324 vol_no = trans->hmp->volume_to_remove;
325 KKASSERT(vol_no != -1);
327 reblock.key_beg.localization = HAMMER_MIN_LOCALIZATION;
328 reblock.key_beg.obj_id = HAMMER_MIN_OBJID;
329 reblock.key_end.localization = HAMMER_MAX_LOCALIZATION;
330 reblock.key_end.obj_id = HAMMER_MAX_OBJID;
331 reblock.head.flags = HAMMER_IOC_DO_FLAGS;
332 reblock.free_level = 0; /* reblock all big-blocks */
333 reblock.allpfs = 1; /* reblock all PFS */
334 reblock.vol_no = vol_no;
336 hmkprintf(hmp, "reblock started\n");
337 error = hammer_ioc_reblock(trans, ip, &reblock);
339 if (reblock.head.flags & HAMMER_IOC_HEAD_INTR) {
344 if (error == EINTR) {
345 hmkprintf(hmp, "reblock was interrupted\n");
347 hmkprintf(hmp, "reblock failed: %d\n", error);
356 * Iterate over all usable L1 entries of the volume and
357 * the corresponding L2 entries.
360 hammer_iterate_l1l2_entries(hammer_transaction_t trans, hammer_volume_t volume,
361 int (*callback)(hammer_transaction_t, hammer_volume_t, hammer_buffer_t*,
362 struct hammer_blockmap_layer1*, struct hammer_blockmap_layer2*,
363 hammer_off_t, hammer_off_t, void*),
366 struct hammer_mount *hmp = trans->hmp;
367 hammer_blockmap_t freemap = &hmp->blockmap[HAMMER_ZONE_FREEMAP_INDEX];
369 hammer_off_t phys_off;
370 hammer_off_t block_off;
371 hammer_off_t layer1_off;
372 hammer_off_t layer2_off;
373 hammer_off_t aligned_buf_end_off;
374 hammer_off_t aligned_vol_end_off;
375 struct hammer_blockmap_layer1 *layer1;
376 struct hammer_blockmap_layer2 *layer2;
377 hammer_buffer_t buffer1 = NULL;
378 hammer_buffer_t buffer2 = NULL;
381 * Calculate the usable size of the volume, which
382 * must be aligned at a big-block (8 MB) boundary.
384 aligned_buf_end_off = HAMMER_ENCODE_RAW_BUFFER(volume->ondisk->vol_no,
385 (volume->ondisk->vol_buf_end - volume->ondisk->vol_buf_beg)
386 & ~HAMMER_BIGBLOCK_MASK64);
387 aligned_vol_end_off = (aligned_buf_end_off + HAMMER_BLOCKMAP_LAYER2_MASK)
388 & ~HAMMER_BLOCKMAP_LAYER2_MASK;
391 * Iterate the volume's address space in chunks of 4 TB, where each
392 * chunk consists of at least one physically available 8 MB big-block.
394 * For each chunk we need one L1 entry and one L2 big-block.
395 * We use the first big-block of each chunk as L2 block.
397 for (phys_off = HAMMER_ENCODE_RAW_BUFFER(volume->ondisk->vol_no, 0);
398 phys_off < aligned_vol_end_off;
399 phys_off += HAMMER_BLOCKMAP_LAYER2) {
401 block_off < HAMMER_BLOCKMAP_LAYER2;
402 block_off += HAMMER_BIGBLOCK_SIZE) {
403 layer2_off = phys_off +
404 HAMMER_BLOCKMAP_LAYER2_OFFSET(block_off);
405 layer2 = hammer_bread(hmp, layer2_off, &error, &buffer2);
409 error = callback(trans, volume, &buffer2, NULL,
410 layer2, phys_off, block_off, data);
415 layer1_off = freemap->phys_offset +
416 HAMMER_BLOCKMAP_LAYER1_OFFSET(phys_off);
417 layer1 = hammer_bread(hmp, layer1_off, &error, &buffer1);
421 error = callback(trans, volume, &buffer1, layer1, NULL,
429 hammer_rel_buffer(buffer1, 0);
431 hammer_rel_buffer(buffer2, 0);
438 format_callback(hammer_transaction_t trans, hammer_volume_t volume,
439 hammer_buffer_t *bufferp,
440 struct hammer_blockmap_layer1 *layer1,
441 struct hammer_blockmap_layer2 *layer2,
442 hammer_off_t phys_off,
443 hammer_off_t block_off,
446 struct bigblock_stat *stat = (struct bigblock_stat*)data;
449 * Calculate the usable size of the volume, which must be aligned
450 * at a big-block (8 MB) boundary.
452 hammer_off_t aligned_buf_end_off;
453 aligned_buf_end_off = HAMMER_ENCODE_RAW_BUFFER(volume->ondisk->vol_no,
454 (volume->ondisk->vol_buf_end - volume->ondisk->vol_buf_beg)
455 & ~HAMMER_BIGBLOCK_MASK64);
458 KKASSERT(layer1->phys_offset == HAMMER_BLOCKMAP_UNAVAIL);
460 hammer_modify_buffer(trans, *bufferp, layer1, sizeof(*layer1));
461 bzero(layer1, sizeof(*layer1));
462 layer1->phys_offset = phys_off;
463 layer1->blocks_free = stat->counter;
464 layer1->layer1_crc = crc32(layer1, HAMMER_LAYER1_CRCSIZE);
465 hammer_modify_buffer_done(*bufferp);
466 stat->counter = 0; /* reset */
468 hammer_modify_buffer(trans, *bufferp, layer2, sizeof(*layer2));
469 bzero(layer2, sizeof(*layer2));
471 if (block_off == 0) {
473 * The first entry represents the L2 big-block itself.
474 * Note that the first entry represents the L1 big-block
475 * and the second entry represents the L2 big-block for
476 * root volume, but this function assumes the volume is
477 * non-root given that we can't add a new root volume.
479 KKASSERT(trans->rootvol && trans->rootvol != volume);
480 layer2->zone = HAMMER_ZONE_FREEMAP_INDEX;
481 layer2->append_off = HAMMER_BIGBLOCK_SIZE;
482 layer2->bytes_free = 0;
483 } else if (phys_off + block_off < aligned_buf_end_off) {
485 * Available big-block
488 layer2->append_off = 0;
489 layer2->bytes_free = HAMMER_BIGBLOCK_SIZE;
490 ++stat->total_bigblocks;
491 ++stat->total_free_bigblocks;
495 * Big-block outside of physically available
498 layer2->zone = HAMMER_ZONE_UNAVAIL_INDEX;
499 layer2->append_off = HAMMER_BIGBLOCK_SIZE;
500 layer2->bytes_free = 0;
503 layer2->entry_crc = crc32(layer2, HAMMER_LAYER2_CRCSIZE);
504 hammer_modify_buffer_done(*bufferp);
513 hammer_format_freemap(hammer_transaction_t trans, hammer_volume_t volume,
514 struct bigblock_stat *stat)
516 stat->total_bigblocks = 0;
517 stat->total_free_bigblocks = 0;
519 return hammer_iterate_l1l2_entries(trans, volume, format_callback, stat);
523 free_callback(hammer_transaction_t trans, hammer_volume_t volume __unused,
524 hammer_buffer_t *bufferp,
525 struct hammer_blockmap_layer1 *layer1,
526 struct hammer_blockmap_layer2 *layer2,
527 hammer_off_t phys_off,
528 hammer_off_t block_off __unused,
531 struct bigblock_stat *stat = (struct bigblock_stat*)data;
534 if (layer1->phys_offset == HAMMER_BLOCKMAP_UNAVAIL) {
536 * This layer1 entry is already free.
541 KKASSERT(HAMMER_VOL_DECODE(layer1->phys_offset) ==
542 trans->hmp->volume_to_remove);
547 hammer_modify_buffer(trans, *bufferp, layer1, sizeof(*layer1));
548 bzero(layer1, sizeof(*layer1));
549 layer1->phys_offset = HAMMER_BLOCKMAP_UNAVAIL;
550 layer1->layer1_crc = crc32(layer1, HAMMER_LAYER1_CRCSIZE);
551 hammer_modify_buffer_done(*bufferp);
555 if (layer2->zone == HAMMER_ZONE_UNAVAIL_INDEX) {
559 if (layer2->zone == HAMMER_ZONE_FREEMAP_INDEX) {
563 if (layer2->append_off == 0 &&
564 layer2->bytes_free == HAMMER_BIGBLOCK_SIZE) {
565 --stat->total_bigblocks;
566 --stat->total_free_bigblocks;
571 * We found a layer2 entry that is not empty!
582 * Non-zero return value means we can't free the volume.
585 test_free_callback(hammer_transaction_t trans, hammer_volume_t volume __unused,
586 hammer_buffer_t *bufferp,
587 struct hammer_blockmap_layer1 *layer1,
588 struct hammer_blockmap_layer2 *layer2,
589 hammer_off_t phys_off,
590 hammer_off_t block_off __unused,
593 if (layer2 == NULL) {
594 return(0); /* only layer2 needs to be tested */
597 if (layer2->zone == HAMMER_ZONE_UNAVAIL_INDEX) {
598 return(0); /* beyond physically available space */
600 if (layer2->zone == HAMMER_ZONE_FREEMAP_INDEX) {
601 return(0); /* big-block for layer1/2 */
603 if (layer2->append_off == 0 &&
604 layer2->bytes_free == HAMMER_BIGBLOCK_SIZE) {
605 return(0); /* big-block is 0% used */
608 return(EBUSY); /* big-block has data */
612 hammer_free_freemap(hammer_transaction_t trans, hammer_volume_t volume,
613 struct bigblock_stat *stat)
617 error = hammer_test_free_freemap(trans, volume);
619 return error; /* not ready to free */
621 stat->total_bigblocks = 0;
622 stat->total_free_bigblocks = 0;
624 return hammer_iterate_l1l2_entries(trans, volume, free_callback, stat);
628 hammer_test_free_freemap(hammer_transaction_t trans, hammer_volume_t volume)
630 return hammer_iterate_l1l2_entries(trans, volume, test_free_callback, NULL);
634 hammer_format_volume_header(struct hammer_mount *hmp,
635 struct hammer_volume_ondisk *ondisk,
636 const char *vol_name, int vol_no, int vol_count,
637 int64_t vol_size, int64_t boot_area_size, int64_t mem_area_size)
641 KKASSERT(HAMMER_BUFSIZE >= sizeof(struct hammer_volume_ondisk));
643 bzero(ondisk, sizeof(struct hammer_volume_ondisk));
644 ksnprintf(ondisk->vol_name, sizeof(ondisk->vol_name), "%s", vol_name);
645 ondisk->vol_fstype = hmp->rootvol->ondisk->vol_fstype;
646 ondisk->vol_signature = HAMMER_FSBUF_VOLUME;
647 ondisk->vol_fsid = hmp->fsid;
648 ondisk->vol_rootvol = hmp->rootvol->vol_no;
649 ondisk->vol_no = vol_no;
650 ondisk->vol_count = vol_count;
651 ondisk->vol_version = hmp->version;
654 * Reserve space for (future) header junk, copy volume relative
655 * offset from the existing root volume.
657 vol_alloc = hmp->rootvol->ondisk->vol_bot_beg;
658 ondisk->vol_bot_beg = vol_alloc;
659 vol_alloc += boot_area_size;
660 ondisk->vol_mem_beg = vol_alloc;
661 vol_alloc += mem_area_size;
664 * The remaining area is the zone 2 buffer allocation area.
666 ondisk->vol_buf_beg = vol_alloc;
667 ondisk->vol_buf_end = vol_size & ~(int64_t)HAMMER_BUFMASK;
669 if (ondisk->vol_buf_end < ondisk->vol_buf_beg) {
670 hmkprintf(hmp, "volume %d %s is too small to hold the volume header\n",
671 ondisk->vol_no, ondisk->vol_name);
675 ondisk->vol_nblocks = (ondisk->vol_buf_end - ondisk->vol_buf_beg) /
677 ondisk->vol_blocksize = HAMMER_BUFSIZE;
682 hammer_update_volumes_header(hammer_transaction_t trans,
683 struct bigblock_stat *stat)
685 struct hammer_mount *hmp = trans->hmp;
686 struct mount *mp = hmp->mp;
687 hammer_volume_t volume;
692 * Set each volume's new value of the vol_count field.
694 HAMMER_VOLUME_NUMBER_FOREACH(hmp, vol_no) {
695 volume = hammer_get_volume(hmp, vol_no, &error);
696 KKASSERT(volume != NULL && error == 0);
697 hammer_modify_volume_field(trans, volume, vol_count);
698 volume->ondisk->vol_count = hmp->nvolumes;
699 hammer_modify_volume_done(volume);
702 * Only changes to the header of the root volume
703 * are automatically flushed to disk. For all
704 * other volumes that we modify we do it here.
706 * No interlock is needed, volume buffers are not
707 * messed with by bioops.
709 if (volume != trans->rootvol && volume->io.modified) {
710 hammer_crc_set_volume(volume->ondisk);
711 hammer_io_flush(&volume->io, 0);
714 hammer_rel_volume(volume, 0);
718 * Update the total number of big-blocks.
720 hammer_modify_volume_field(trans, trans->rootvol, vol0_stat_bigblocks);
721 trans->rootvol->ondisk->vol0_stat_bigblocks += stat->total_bigblocks;
722 hammer_modify_volume_done(trans->rootvol);
725 * Big-block count changed so recompute the total number of blocks.
727 mp->mnt_stat.f_blocks = trans->rootvol->ondisk->vol0_stat_bigblocks *
728 HAMMER_BUFFERS_PER_BIGBLOCK;
729 mp->mnt_vstat.f_blocks = trans->rootvol->ondisk->vol0_stat_bigblocks *
730 HAMMER_BUFFERS_PER_BIGBLOCK;
733 * Update the total number of free big-blocks.
735 hammer_modify_volume_field(trans, trans->rootvol,
736 vol0_stat_freebigblocks);
737 trans->rootvol->ondisk->vol0_stat_freebigblocks +=
738 stat->total_free_bigblocks;
739 hammer_modify_volume_done(trans->rootvol);
742 * Update the copy in hmp.
744 hmp->copy_stat_freebigblocks =
745 trans->rootvol->ondisk->vol0_stat_freebigblocks;