sys/vfs/hammer/hammer_undo.c

   1 /*
   2  * Copyright (c) 2008 The DragonFly Project.  All rights reserved.
   3  *
   4  * This code is derived from software contributed to The DragonFly Project
   5  * by Matthew Dillon <dillon@backplane.com>
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  *
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer.
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in
  15  *    the documentation and/or other materials provided with the
  16  *    distribution.
  17  * 3. Neither the name of The DragonFly Project nor the names of its
  18  *    contributors may be used to endorse or promote products derived
  19  *    from this software without specific, prior written permission.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  24  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
  25  * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  26  * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
  27  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  28  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
  29  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  30  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  31  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  32  * SUCH DAMAGE.
  33  *
  34  * $DragonFly: src/sys/vfs/hammer/hammer_undo.c,v 1.9 2008/05/02 06:51:57 dillon Exp $
  35  */
  36
  37 /*
  38  * HAMMER undo - undo buffer/FIFO management.
  39  */
  40
  41 #include "hammer.h"
  42
  43 /*
  44  * Convert a zone-3 undo offset into a zone-2 buffer offset.
  45  */
  46 hammer_off_t
  47 hammer_undo_lookup(hammer_mount_t hmp, hammer_off_t zone3_off, int *errorp)
  48 {
  49         hammer_volume_t root_volume;
  50         hammer_blockmap_t undomap;
  51         struct hammer_blockmap_layer2 *layer2;
  52         hammer_off_t result_offset;
  53         int i;
  54
  55         KKASSERT((zone3_off & HAMMER_OFF_ZONE_MASK) == HAMMER_ZONE_UNDO);
  56         root_volume = hammer_get_root_volume(hmp, errorp);
  57         if (*errorp)
  58                 return(0);
  59         undomap = &hmp->blockmap[HAMMER_ZONE_UNDO_INDEX];
  60         KKASSERT(HAMMER_ZONE_DECODE(undomap->alloc_offset) == HAMMER_ZONE_UNDO_INDEX);
  61         KKASSERT (zone3_off < undomap->alloc_offset);
  62
  63         i = (zone3_off & HAMMER_OFF_SHORT_MASK) / HAMMER_LARGEBLOCK_SIZE;
  64         layer2 = &root_volume->ondisk->vol0_undo_array[i];
  65         result_offset = layer2->u.phys_offset +
  66                         (zone3_off & HAMMER_LARGEBLOCK_MASK64);
  67
  68         hammer_rel_volume(root_volume, 0);
  69         return(result_offset);
  70 }
  71
  72 /*
  73  * Generate an UNDO record for the block of data at the specified zone1
  74  * or zone2 offset.
  75  */
  76 int
  77 hammer_generate_undo(hammer_transaction_t trans, hammer_io_t io,
  78                      hammer_off_t zone_off, void *base, int len)
  79 {
  80         hammer_volume_t root_volume;
  81         hammer_volume_ondisk_t ondisk;
  82         hammer_blockmap_t undomap;
  83         hammer_buffer_t buffer = NULL;
  84         struct hammer_blockmap_layer2 *layer2;
  85         hammer_fifo_undo_t undo;
  86         hammer_fifo_tail_t tail;
  87         hammer_off_t next_offset;
  88         hammer_off_t result_offset;
  89         int i;
  90         int error;
  91         int bytes;
  92
  93         root_volume = trans->rootvol;
  94         ondisk = root_volume->ondisk;
  95         undomap = &trans->hmp->blockmap[HAMMER_ZONE_UNDO_INDEX];
  96
  97         /* no undo recursion */
  98         hammer_modify_volume(NULL, root_volume, NULL, 0);
  99
 100 again:
 101         /*
 102          * Allocate space in the FIFO
 103          */
 104         bytes = ((len + HAMMER_HEAD_ALIGN_MASK) & ~HAMMER_HEAD_ALIGN_MASK) +
 105                 sizeof(struct hammer_fifo_undo) +
 106                 sizeof(struct hammer_fifo_tail);
 107         if (hammer_undo_space(trans->hmp) < bytes + HAMMER_BUFSIZE*2)
 108                 panic("hammer: insufficient undo FIFO space!");
 109
 110         next_offset = undomap->next_offset;
 111
 112         /*
 113          * Wrap next_offset
 114          */
 115         if (undomap->next_offset == undomap->alloc_offset) {
 116                 next_offset = HAMMER_ZONE_ENCODE(HAMMER_ZONE_UNDO_INDEX, 0);
 117                 undomap->next_offset = next_offset;
 118                 kprintf("undo zone's next_offset wrapped\n");
 119         }
 120
 121         i = (next_offset & HAMMER_OFF_SHORT_MASK) / HAMMER_LARGEBLOCK_SIZE;
 122         layer2 = &root_volume->ondisk->vol0_undo_array[i];
 123         result_offset = layer2->u.phys_offset +
 124                         (next_offset & HAMMER_LARGEBLOCK_MASK64);
 125
 126         undo = hammer_bread(trans->hmp, result_offset, &error, &buffer);
 127
 128         /*
 129          * We raced another thread, try again.
 130          */
 131         if (undomap->next_offset != next_offset)
 132                 goto again;
 133
 134         hammer_modify_buffer(NULL, buffer, NULL, 0);
 135
 136         /*
 137          * The FIFO entry would cross a buffer boundary, PAD to the end
 138          * of the buffer and try again.  Due to our data alignment, the
 139          * worst case (smallest) PAD record is 8 bytes.  PAD records only
 140          * populate the first 8 bytes of hammer_fifo_head and the tail may
 141          * be at the same offset as the head.
 142          */
 143         if ((result_offset ^ (result_offset + bytes)) & ~HAMMER_BUFMASK64) {
 144                 bytes = HAMMER_BUFSIZE - ((int)next_offset & HAMMER_BUFMASK);
 145                 tail = (void *)((char *)undo + bytes - sizeof(*tail));
 146                 if ((void *)undo != (void *)tail) {
 147                         tail->tail_signature = HAMMER_TAIL_SIGNATURE;
 148                         tail->tail_type = HAMMER_HEAD_TYPE_PAD;
 149                         tail->tail_size = bytes;
 150                 }
 151                 undo->head.hdr_signature = HAMMER_HEAD_SIGNATURE;
 152                 undo->head.hdr_type = HAMMER_HEAD_TYPE_PAD;
 153                 undo->head.hdr_size = bytes;
 154                 undomap->next_offset += bytes;
 155                 hammer_modify_buffer_done(buffer);
 156                 goto again;
 157         }
 158         if (hammer_debug_general & 0x0080)
 159                 kprintf("undo %016llx %d %d\n", result_offset, bytes, len);
 160
 161         /*
 162          * We're good, create the entry.
 163          */
 164         undo->head.hdr_signature = HAMMER_HEAD_SIGNATURE;
 165         undo->head.hdr_type = HAMMER_HEAD_TYPE_UNDO;
 166         undo->head.hdr_size = bytes;
 167         undo->head.reserved01 = 0;
 168         undo->head.hdr_crc = 0;
 169         undo->undo_offset = zone_off;
 170         undo->undo_data_bytes = len;
 171         bcopy(base, undo + 1, len);
 172
 173         tail = (void *)((char *)undo + bytes - sizeof(*tail));
 174         tail->tail_signature = HAMMER_TAIL_SIGNATURE;
 175         tail->tail_type = HAMMER_HEAD_TYPE_UNDO;
 176         tail->tail_size = bytes;
 177
 178         undo->head.hdr_crc = crc32(undo, bytes);
 179         hammer_modify_buffer_done(buffer);
 180
 181         /*
 182          * Update the undo offset space in the IO XXX
 183          */
 184
 185         undomap->next_offset += bytes;
 186         hammer_modify_volume_done(root_volume);
 187
 188         if (buffer)
 189                 hammer_rel_buffer(buffer, 0);
 190         return(error);
 191 }
 192
 193 int64_t
 194 hammer_undo_space(hammer_mount_t hmp)
 195 {
 196         hammer_blockmap_t rootmap;
 197         int64_t bytes;
 198         int64_t max_bytes;
 199
 200         rootmap = &hmp->blockmap[HAMMER_ZONE_UNDO_INDEX];
 201
 202         if (rootmap->first_offset <= rootmap->next_offset) {
 203                 bytes = (int)(rootmap->next_offset - rootmap->first_offset);
 204         } else {
 205                 bytes = (int)(rootmap->alloc_offset - rootmap->first_offset +
 206                               rootmap->next_offset);
 207         }
 208         max_bytes = (int)(rootmap->alloc_offset & HAMMER_OFF_SHORT_MASK);
 209         return(max_bytes - bytes);
 210 }
 211
 212 int64_t
 213 hammer_undo_max(hammer_mount_t hmp)
 214 {
 215         hammer_blockmap_t rootmap;
 216         int64_t max_bytes;
 217
 218         rootmap = &hmp->blockmap[HAMMER_ZONE_UNDO_INDEX];
 219         max_bytes = (int)(rootmap->alloc_offset & HAMMER_OFF_SHORT_MASK);
 220
 221         return(max_bytes);
 222 }
 223