sys/vfs/hammer/hammer_cursor.c

   1 /*
   2  * Copyright (c) 2007-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_cursor.c,v 1.35 2008/07/02 21:57:54 dillon Exp $
  35  */
  36
  37 /*
  38  * HAMMER B-Tree index - cursor support routines
  39  */
  40 #include "hammer.h"
  41
  42 static int hammer_load_cursor_parent(hammer_cursor_t cursor, int try_exclusive);
  43
  44 /*
  45  * Initialize a fresh cursor using the B-Tree node cache.  If the cache
  46  * is not available initialize a fresh cursor at the root of the filesystem.
  47  */
  48 int
  49 hammer_init_cursor(hammer_transaction_t trans, hammer_cursor_t cursor,
  50                    hammer_node_cache_t cache, hammer_inode_t ip)
  51 {
  52         hammer_volume_t volume;
  53         hammer_node_t node;
  54         int error;
  55
  56         bzero(cursor, sizeof(*cursor));
  57
  58         cursor->trans = trans;
  59
  60         /*
  61          * If the cursor operation is on behalf of an inode, lock
  62          * the inode.
  63          */
  64         if ((cursor->ip = ip) != NULL) {
  65                 ++ip->cursor_ip_refs;
  66                 if (trans->type == HAMMER_TRANS_FLS)
  67                         hammer_lock_ex(&ip->lock);
  68                 else
  69                         hammer_lock_sh(&ip->lock);
  70         }
  71
  72         /*
  73          * Step 1 - acquire a locked node from the cache if possible
  74          */
  75         if (cache && cache->node) {
  76                 node = hammer_ref_node_safe(trans->hmp, cache, &error);
  77                 if (error == 0) {
  78                         hammer_lock_sh_lowpri(&node->lock);
  79                         if (node->flags & HAMMER_NODE_DELETED) {
  80                                 hammer_unlock(&node->lock);
  81                                 hammer_rel_node(node);
  82                                 node = NULL;
  83                         }
  84                 }
  85         } else {
  86                 node = NULL;
  87         }
  88
  89         /*
  90          * Step 2 - If we couldn't get a node from the cache, get
  91          * the one from the root of the filesystem.
  92          */
  93         while (node == NULL) {
  94                 volume = hammer_get_root_volume(trans->hmp, &error);
  95                 if (error)
  96                         break;
  97                 node = hammer_get_node(trans->hmp,
  98                                        volume->ondisk->vol0_btree_root,
  99                                        0, &error);
 100                 hammer_rel_volume(volume, 0);
 101                 if (error)
 102                         break;
 103                 hammer_lock_sh_lowpri(&node->lock);
 104
 105                 /*
 106                  * If someone got in before we could lock the node, retry.
 107                  */
 108                 if (node->flags & HAMMER_NODE_DELETED) {
 109                         hammer_unlock(&node->lock);
 110                         hammer_rel_node(node);
 111                         node = NULL;
 112                         continue;
 113                 }
 114                 if (volume->ondisk->vol0_btree_root != node->node_offset) {
 115                         hammer_unlock(&node->lock);
 116                         hammer_rel_node(node);
 117                         node = NULL;
 118                         continue;
 119                 }
 120         }
 121
 122         /*
 123          * Step 3 - finish initializing the cursor by acquiring the parent
 124          */
 125         cursor->node = node;
 126         if (error == 0)
 127                 error = hammer_load_cursor_parent(cursor, 0);
 128         KKASSERT(error == 0);
 129         /* if (error) hammer_done_cursor(cursor); */
 130         return(error);
 131 }
 132
 133 /*
 134  * Normalize a cursor.  Sometimes cursors can be left in a state
 135  * where node is NULL.  If the cursor is in this state, cursor up.
 136  */
 137 void
 138 hammer_normalize_cursor(hammer_cursor_t cursor)
 139 {
 140         if (cursor->node == NULL) {
 141                 KKASSERT(cursor->parent != NULL);
 142                 hammer_cursor_up(cursor);
 143         }
 144 }
 145
 146
 147 /*
 148  * We are finished with a cursor.  We NULL out various fields as sanity
 149  * check, in case the structure is inappropriately used afterwords.
 150  */
 151 void
 152 hammer_done_cursor(hammer_cursor_t cursor)
 153 {
 154         hammer_inode_t ip;
 155
 156         if (cursor->parent) {
 157                 hammer_unlock(&cursor->parent->lock);
 158                 hammer_rel_node(cursor->parent);
 159                 cursor->parent = NULL;
 160         }
 161         if (cursor->node) {
 162                 hammer_unlock(&cursor->node->lock);
 163                 hammer_rel_node(cursor->node);
 164                 cursor->node = NULL;
 165         }
 166         if (cursor->data_buffer) {
 167                 hammer_rel_buffer(cursor->data_buffer, 0);
 168                 cursor->data_buffer = NULL;
 169         }
 170         if (cursor->record_buffer) {
 171                 hammer_rel_buffer(cursor->record_buffer, 0);
 172                 cursor->record_buffer = NULL;
 173         }
 174         if ((ip = cursor->ip) != NULL) {
 175                 hammer_mem_done(cursor);
 176                 KKASSERT(ip->cursor_ip_refs > 0);
 177                 --ip->cursor_ip_refs;
 178 #if 1
 179                 hammer_unlock(&ip->lock);
 180 #endif
 181                 cursor->ip = NULL;
 182         }
 183
 184
 185         /*
 186          * If we deadlocked this node will be referenced.  Do a quick
 187          * lock/unlock to wait for the deadlock condition to clear.
 188          */
 189         if (cursor->deadlk_node) {
 190                 hammer_lock_ex_ident(&cursor->deadlk_node->lock, "hmrdlk");
 191                 hammer_unlock(&cursor->deadlk_node->lock);
 192                 hammer_rel_node(cursor->deadlk_node);
 193                 cursor->deadlk_node = NULL;
 194         }
 195         if (cursor->deadlk_rec) {
 196                 hammer_wait_mem_record_ident(cursor->deadlk_rec, "hmmdlr");
 197                 hammer_rel_mem_record(cursor->deadlk_rec);
 198                 cursor->deadlk_rec = NULL;
 199         }
 200
 201         cursor->data = NULL;
 202         cursor->leaf = NULL;
 203         cursor->left_bound = NULL;
 204         cursor->right_bound = NULL;
 205         cursor->trans = NULL;
 206 }
 207
 208 /*
 209  * Upgrade cursor->node and cursor->parent to exclusive locks.  This
 210  * function can return EDEADLK.
 211  *
 212  * The lock must already be either held shared or already held exclusively
 213  * by us.
 214  *
 215  * If we fail to upgrade the lock and cursor->deadlk_node is NULL,
 216  * we add another reference to the node that failed and set
 217  * cursor->deadlk_node so hammer_done_cursor() can block on it.
 218  */
 219 int
 220 hammer_cursor_upgrade(hammer_cursor_t cursor)
 221 {
 222         int error;
 223
 224         error = hammer_lock_upgrade(&cursor->node->lock);
 225         if (error && cursor->deadlk_node == NULL) {
 226                 cursor->deadlk_node = cursor->node;
 227                 hammer_ref_node(cursor->deadlk_node);
 228         } else if (error == 0 && cursor->parent) {
 229                 error = hammer_lock_upgrade(&cursor->parent->lock);
 230                 if (error && cursor->deadlk_node == NULL) {
 231                         cursor->deadlk_node = cursor->parent;
 232                         hammer_ref_node(cursor->deadlk_node);
 233                 }
 234         }
 235         return(error);
 236 }
 237
 238 int
 239 hammer_cursor_upgrade_node(hammer_cursor_t cursor)
 240 {
 241         int error;
 242
 243         error = hammer_lock_upgrade(&cursor->node->lock);
 244         if (error && cursor->deadlk_node == NULL) {
 245                 cursor->deadlk_node = cursor->node;
 246                 hammer_ref_node(cursor->deadlk_node);
 247         }
 248         return(error);
 249 }
 250
 251 /*
 252  * Downgrade cursor->node and cursor->parent to shared locks.  This
 253  * function can return EDEADLK.
 254  */
 255 void
 256 hammer_cursor_downgrade(hammer_cursor_t cursor)
 257 {
 258         if (hammer_lock_excl_owned(&cursor->node->lock, curthread))
 259                 hammer_lock_downgrade(&cursor->node->lock);
 260         if (cursor->parent &&
 261             hammer_lock_excl_owned(&cursor->parent->lock, curthread)) {
 262                 hammer_lock_downgrade(&cursor->parent->lock);
 263         }
 264 }
 265
 266 /*
 267  * Seek the cursor to the specified node and index.
 268  *
 269  * The caller must ref the node prior to calling this routine and release
 270  * it after it returns.  If the seek succeeds the cursor will gain its own
 271  * ref on the node.
 272  */
 273 int
 274 hammer_cursor_seek(hammer_cursor_t cursor, hammer_node_t node, int index)
 275 {
 276         int error;
 277
 278         hammer_cursor_downgrade(cursor);
 279         error = 0;
 280
 281         if (cursor->node != node) {
 282                 hammer_unlock(&cursor->node->lock);
 283                 hammer_rel_node(cursor->node);
 284                 cursor->node = node;
 285                 hammer_ref_node(node);
 286                 hammer_lock_sh(&node->lock);
 287                 KKASSERT ((node->flags & HAMMER_NODE_DELETED) == 0);
 288
 289                 if (cursor->parent) {
 290                         hammer_unlock(&cursor->parent->lock);
 291                         hammer_rel_node(cursor->parent);
 292                         cursor->parent = NULL;
 293                         cursor->parent_index = 0;
 294                 }
 295                 error = hammer_load_cursor_parent(cursor, 0);
 296         }
 297         cursor->index = index;
 298         return (error);
 299 }
 300
 301 /*
 302  * Load the parent of cursor->node into cursor->parent.
 303  */
 304 static
 305 int
 306 hammer_load_cursor_parent(hammer_cursor_t cursor, int try_exclusive)
 307 {
 308         hammer_mount_t hmp;
 309         hammer_node_t parent;
 310         hammer_node_t node;
 311         hammer_btree_elm_t elm;
 312         int error;
 313         int parent_index;
 314
 315         hmp = cursor->trans->hmp;
 316
 317         if (cursor->node->ondisk->parent) {
 318                 node = cursor->node;
 319                 parent = hammer_btree_get_parent(node, &parent_index,
 320                                                  &error, try_exclusive);
 321                 if (error == 0) {
 322                         elm = &parent->ondisk->elms[parent_index];
 323                         cursor->parent = parent;
 324                         cursor->parent_index = parent_index;
 325                         cursor->left_bound = &elm[0].internal.base;
 326                         cursor->right_bound = &elm[1].internal.base;
 327                 }
 328         } else {
 329                 cursor->parent = NULL;
 330                 cursor->parent_index = 0;
 331                 cursor->left_bound = &hmp->root_btree_beg;
 332                 cursor->right_bound = &hmp->root_btree_end;
 333                 error = 0;
 334         }
 335         return(error);
 336 }
 337
 338 /*
 339  * Cursor up to our parent node.  Return ENOENT if we are at the root of
 340  * the filesystem.
 341  */
 342 int
 343 hammer_cursor_up(hammer_cursor_t cursor)
 344 {
 345         int error;
 346
 347         hammer_cursor_downgrade(cursor);
 348
 349         /*
 350          * If the parent is NULL we are at the root of the B-Tree and
 351          * return ENOENT.
 352          */
 353         if (cursor->parent == NULL)
 354                 return (ENOENT);
 355
 356         /*
 357          * Set the node to its parent.
 358          */
 359         hammer_unlock(&cursor->node->lock);
 360         hammer_rel_node(cursor->node);
 361         cursor->node = cursor->parent;
 362         cursor->index = cursor->parent_index;
 363         cursor->parent = NULL;
 364         cursor->parent_index = 0;
 365
 366         error = hammer_load_cursor_parent(cursor, 0);
 367         return(error);
 368 }
 369
 370 /*
 371  * Special cursor up given a locked cursor.  The orignal node is not
 372  * unlocked and released and the cursor is not downgraded.  If we are
 373  * unable to acquire and lock the parent, EDEADLK is returned.
 374  */
 375 int
 376 hammer_cursor_up_locked(hammer_cursor_t cursor)
 377 {
 378         hammer_node_t save;
 379         int error;
 380
 381         /*
 382          * If the parent is NULL we are at the root of the B-Tree and
 383          * return ENOENT.
 384          */
 385         if (cursor->parent == NULL)
 386                 return (ENOENT);
 387
 388         save = cursor->node;
 389
 390         /*
 391          * Set the node to its parent.
 392          */
 393         cursor->node = cursor->parent;
 394         cursor->index = cursor->parent_index;
 395         cursor->parent = NULL;
 396         cursor->parent_index = 0;
 397
 398         /*
 399          * load the new parent, attempt to exclusively lock it.  Note that
 400          * we are still holding the old parent (now cursor->node) exclusively
 401          * locked.  This can return EDEADLK.
 402          */
 403         error = hammer_load_cursor_parent(cursor, 1);
 404         if (error) {
 405                 cursor->parent = cursor->node;
 406                 cursor->parent_index = cursor->index;
 407                 cursor->node = save;
 408                 cursor->index = 0;
 409         }
 410         return(error);
 411 }
 412
 413
 414 /*
 415  * Cursor down through the current node, which must be an internal node.
 416  *
 417  * This routine adjusts the cursor and sets index to 0.
 418  */
 419 int
 420 hammer_cursor_down(hammer_cursor_t cursor)
 421 {
 422         hammer_node_t node;
 423         hammer_btree_elm_t elm;
 424         int error;
 425
 426         /*
 427          * The current node becomes the current parent
 428          */
 429         hammer_cursor_downgrade(cursor);
 430         node = cursor->node;
 431         KKASSERT(cursor->index >= 0 && cursor->index < node->ondisk->count);
 432         if (cursor->parent) {
 433                 hammer_unlock(&cursor->parent->lock);
 434                 hammer_rel_node(cursor->parent);
 435         }
 436         cursor->parent = node;
 437         cursor->parent_index = cursor->index;
 438         cursor->node = NULL;
 439         cursor->index = 0;
 440
 441         /*
 442          * Extract element to push into at (node,index), set bounds.
 443          */
 444         elm = &node->ondisk->elms[cursor->parent_index];
 445
 446         /*
 447          * Ok, push down into elm.  If elm specifies an internal or leaf
 448          * node the current node must be an internal node.  If elm specifies
 449          * a spike then the current node must be a leaf node.
 450          */
 451         switch(elm->base.btype) {
 452         case HAMMER_BTREE_TYPE_INTERNAL:
 453         case HAMMER_BTREE_TYPE_LEAF:
 454                 KKASSERT(node->ondisk->type == HAMMER_BTREE_TYPE_INTERNAL);
 455                 KKASSERT(elm->internal.subtree_offset != 0);
 456                 cursor->left_bound = &elm[0].internal.base;
 457                 cursor->right_bound = &elm[1].internal.base;
 458                 node = hammer_get_node(cursor->trans->hmp,
 459                                        elm->internal.subtree_offset, 0, &error);
 460                 if (error == 0) {
 461                         KASSERT(elm->base.btype == node->ondisk->type, ("BTYPE MISMATCH %c %c NODE %p\n", elm->base.btype, node->ondisk->type, node));
 462                         if (node->ondisk->parent != cursor->parent->node_offset)
 463                                 panic("node %p %016llx vs %016llx\n", node, node->ondisk->parent, cursor->parent->node_offset);
 464                         KKASSERT(node->ondisk->parent == cursor->parent->node_offset);
 465                 }
 466                 break;
 467         default:
 468                 panic("hammer_cursor_down: illegal btype %02x (%c)\n",
 469                       elm->base.btype,
 470                       (elm->base.btype ? elm->base.btype : '?'));
 471                 break;
 472         }
 473         if (error == 0) {
 474                 hammer_lock_sh(&node->lock);
 475                 KKASSERT ((node->flags & HAMMER_NODE_DELETED) == 0);
 476                 cursor->node = node;
 477                 cursor->index = 0;
 478         }
 479         return(error);
 480 }
 481