git.ozlabs.org Git - ccan/blob - ccan/tdb/lock.c

   1  /*
   2    Unix SMB/CIFS implementation.
   3
   4    trivial database library
   5
   6    Copyright (C) Andrew Tridgell              1999-2005
   7    Copyright (C) Paul `Rusty' Russell              2000
   8    Copyright (C) Jeremy Allison                    2000-2003
   9
  10      ** NOTE! The following LGPL license applies to the tdb
  11      ** library. This does NOT imply that all of Samba is released
  12      ** under the LGPL
  13
  14    This library is free software; you can redistribute it and/or
  15    modify it under the terms of the GNU Lesser General Public
  16    License as published by the Free Software Foundation; either
  17    version 3 of the License, or (at your option) any later version.
  18
  19    This library is distributed in the hope that it will be useful,
  20    but WITHOUT ANY WARRANTY; without even the implied warranty of
  21    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  22    Lesser General Public License for more details.
  23
  24    You should have received a copy of the GNU Lesser General Public
  25    License along with this library; if not, see <http://www.gnu.org/licenses/>.
  26 */
  27
  28 #include "tdb_private.h"
  29
  30 void tdb_setalarm_sigptr(struct tdb_context *tdb, volatile sig_atomic_t *ptr)
  31 {
  32         tdb->interrupt_sig_ptr = ptr;
  33 }
  34
  35 static int fcntl_lock(struct tdb_context *tdb,
  36                       int rw, off_t off, off_t len, bool waitflag)
  37 {
  38         struct flock fl;
  39
  40         fl.l_type = rw;
  41         fl.l_whence = SEEK_SET;
  42         fl.l_start = off;
  43         fl.l_len = len;
  44         fl.l_pid = 0;
  45
  46         if (waitflag)
  47                 return fcntl(tdb->fd, F_SETLKW, &fl);
  48         else
  49                 return fcntl(tdb->fd, F_SETLK, &fl);
  50 }
  51
  52 static int fcntl_unlock(struct tdb_context *tdb, int rw, off_t off, off_t len)
  53 {
  54         struct flock fl;
  55 #if 0 /* Check they matched up locks and unlocks correctly. */
  56         char line[80];
  57         FILE *locks;
  58         bool found = false;
  59
  60         locks = fopen("/proc/locks", "r");
  61
  62         while (fgets(line, 80, locks)) {
  63                 char *p;
  64                 int type, start, l;
  65
  66                 /* eg. 1: FLOCK  ADVISORY  WRITE 2440 08:01:2180826 0 EOF */
  67                 p = strchr(line, ':') + 1;
  68                 if (strncmp(p, " POSIX  ADVISORY  ", strlen(" POSIX  ADVISORY  ")))
  69                         continue;
  70                 p += strlen(" FLOCK  ADVISORY  ");
  71                 if (strncmp(p, "READ  ", strlen("READ  ")) == 0)
  72                         type = F_RDLCK;
  73                 else if (strncmp(p, "WRITE ", strlen("WRITE ")) == 0)
  74                         type = F_WRLCK;
  75                 else
  76                         abort();
  77                 p += 6;
  78                 if (atoi(p) != getpid())
  79                         continue;
  80                 p = strchr(strchr(p, ' ') + 1, ' ') + 1;
  81                 start = atoi(p);
  82                 p = strchr(p, ' ') + 1;
  83                 if (strncmp(p, "EOF", 3) == 0)
  84                         l = 0;
  85                 else
  86                         l = atoi(p) - start + 1;
  87
  88                 if (off == start) {
  89                         if (len != l) {
  90                                 fprintf(stderr, "Len %u should be %u: %s",
  91                                         (int)len, l, line);
  92                                 abort();
  93                         }
  94                         if (type != rw) {
  95                                 fprintf(stderr, "Type %s wrong: %s",
  96                                         rw == F_RDLCK ? "READ" : "WRITE", line);
  97                                 abort();
  98                         }
  99                         found = true;
 100                         break;
 101                 }
 102         }
 103
 104         if (!found) {
 105                 fprintf(stderr, "Unlock on %u@%u not found!\n",
 106                         (int)off, (int)len);
 107                 abort();
 108         }
 109
 110         fclose(locks);
 111 #endif
 112
 113         fl.l_type = F_UNLCK;
 114         fl.l_whence = SEEK_SET;
 115         fl.l_start = off;
 116         fl.l_len = len;
 117         fl.l_pid = 0;
 118
 119         return fcntl(tdb->fd, F_SETLKW, &fl);
 120 }
 121
 122 /* list -1 is the alloc list, otherwise a hash chain. */
 123 static tdb_off_t lock_offset(int list)
 124 {
 125         return FREELIST_TOP + 4*list;
 126 }
 127
 128 /* a byte range locking function - return 0 on success
 129    this functions locks/unlocks 1 byte at the specified offset.
 130
 131    On error, errno is also set so that errors are passed back properly
 132    through tdb_open().
 133
 134    note that a len of zero means lock to end of file
 135 */
 136 int tdb_brlock(struct tdb_context *tdb,
 137                int rw_type, tdb_off_t offset, size_t len,
 138                enum tdb_lock_flags flags)
 139 {
 140         int ret;
 141
 142         if (tdb->flags & TDB_NOLOCK) {
 143                 return 0;
 144         }
 145
 146         if (flags & TDB_LOCK_MARK_ONLY) {
 147                 return 0;
 148         }
 149
 150         if ((rw_type == F_WRLCK) && (tdb->read_only || tdb->traverse_read)) {
 151                 tdb->ecode = TDB_ERR_RDONLY;
 152                 return -1;
 153         }
 154
 155         do {
 156                 ret = fcntl_lock(tdb, rw_type, offset, len,
 157                                  flags & TDB_LOCK_WAIT);
 158                 /* Check for a sigalarm break. */
 159                 if (ret == -1 && errno == EINTR &&
 160                                 tdb->interrupt_sig_ptr &&
 161                                 *tdb->interrupt_sig_ptr) {
 162                         break;
 163                 }
 164         } while (ret == -1 && errno == EINTR);
 165
 166         if (ret == -1) {
 167                 tdb->ecode = TDB_ERR_LOCK;
 168                 /* Generic lock error. errno set by fcntl.
 169                  * EAGAIN is an expected return from non-blocking
 170                  * locks. */
 171                 if (!(flags & TDB_LOCK_PROBE) && errno != EAGAIN) {
 172                         TDB_LOG((tdb, TDB_DEBUG_TRACE,"tdb_brlock failed (fd=%d) at offset %d rw_type=%d flags=%d len=%d\n",
 173                                  tdb->fd, offset, rw_type, flags, (int)len));
 174                 }
 175                 return -1;
 176         }
 177         return 0;
 178 }
 179
 180 int tdb_brunlock(struct tdb_context *tdb,
 181                  int rw_type, tdb_off_t offset, size_t len)
 182 {
 183         int ret;
 184
 185         if (tdb->flags & TDB_NOLOCK) {
 186                 return 0;
 187         }
 188
 189         do {
 190                 ret = fcntl_unlock(tdb, rw_type, offset, len);
 191         } while (ret == -1 && errno == EINTR);
 192
 193         if (ret == -1) {
 194                 TDB_LOG((tdb, TDB_DEBUG_TRACE,"tdb_brunlock failed (fd=%d) at offset %d rw_type=%d len=%d\n",
 195                          tdb->fd, offset, rw_type, (int)len));
 196         }
 197         return ret;
 198 }
 199
 200 /*
 201   upgrade a read lock to a write lock. This needs to be handled in a
 202   special way as some OSes (such as solaris) have too conservative
 203   deadlock detection and claim a deadlock when progress can be
 204   made. For those OSes we may loop for a while.
 205 */
 206 int tdb_allrecord_upgrade(struct tdb_context *tdb)
 207 {
 208         int count = 1000;
 209
 210         if (tdb->allrecord_lock.count != 1) {
 211                 TDB_LOG((tdb, TDB_DEBUG_ERROR,
 212                          "tdb_allrecord_upgrade failed: count %u too high\n",
 213                          tdb->allrecord_lock.count));
 214                 return -1;
 215         }
 216
 217         if (tdb->allrecord_lock.off != 1) {
 218                 TDB_LOG((tdb, TDB_DEBUG_ERROR,
 219                          "tdb_allrecord_upgrade failed: already upgraded?\n"));
 220                 return -1;
 221         }
 222
 223         while (count--) {
 224                 struct timeval tv;
 225                 if (tdb_brlock(tdb, F_WRLCK, FREELIST_TOP, 0,
 226                                TDB_LOCK_WAIT|TDB_LOCK_PROBE) == 0) {
 227                         tdb->allrecord_lock.ltype = F_WRLCK;
 228                         tdb->allrecord_lock.off = 0;
 229                         return 0;
 230                 }
 231                 if (errno != EDEADLK) {
 232                         break;
 233                 }
 234                 /* sleep for as short a time as we can - more portable than usleep() */
 235                 tv.tv_sec = 0;
 236                 tv.tv_usec = 1;
 237                 select(0, NULL, NULL, NULL, &tv);
 238         }
 239         TDB_LOG((tdb, TDB_DEBUG_TRACE,"tdb_allrecord_upgrade failed\n"));
 240         return -1;
 241 }
 242
 243 static struct tdb_lock_type *find_nestlock(struct tdb_context *tdb,
 244                                            tdb_off_t offset)
 245 {
 246         unsigned int i;
 247
 248         for (i=0; i<tdb->num_lockrecs; i++) {
 249                 if (tdb->lockrecs[i].off == offset) {
 250                         return &tdb->lockrecs[i];
 251                 }
 252         }
 253         return NULL;
 254 }
 255
 256 /* lock an offset in the database. */
 257 int tdb_nest_lock(struct tdb_context *tdb, uint32_t offset, int ltype,
 258                   enum tdb_lock_flags flags)
 259 {
 260         struct tdb_lock_type *new_lck;
 261
 262         if (offset >= lock_offset(tdb->header.hash_size)) {
 263                 tdb->ecode = TDB_ERR_LOCK;
 264                 TDB_LOG((tdb, TDB_DEBUG_ERROR,"tdb_lock: invalid offset %u for ltype=%d\n",
 265                          offset, ltype));
 266                 return -1;
 267         }
 268         if (tdb->flags & TDB_NOLOCK)
 269                 return 0;
 270
 271         new_lck = find_nestlock(tdb, offset);
 272         if (new_lck) {
 273                 /*
 274                  * Just increment the in-memory struct, posix locks
 275                  * don't stack.
 276                  */
 277                 new_lck->count++;
 278                 return 0;
 279         }
 280
 281         new_lck = (struct tdb_lock_type *)realloc(
 282                 tdb->lockrecs,
 283                 sizeof(*tdb->lockrecs) * (tdb->num_lockrecs+1));
 284         if (new_lck == NULL) {
 285                 errno = ENOMEM;
 286                 return -1;
 287         }
 288         tdb->lockrecs = new_lck;
 289
 290         /* Since fcntl locks don't nest, we do a lock for the first one,
 291            and simply bump the count for future ones */
 292         if (tdb_brlock(tdb, ltype, offset, 1, flags)) {
 293                 return -1;
 294         }
 295
 296         tdb->lockrecs[tdb->num_lockrecs].off = offset;
 297         tdb->lockrecs[tdb->num_lockrecs].count = 1;
 298         tdb->lockrecs[tdb->num_lockrecs].ltype = ltype;
 299         tdb->num_lockrecs++;
 300
 301         return 0;
 302 }
 303
 304 static int tdb_lock_and_recover(struct tdb_context *tdb)
 305 {
 306         int ret;
 307
 308         /* We need to match locking order in transaction commit. */
 309         if (tdb_brlock(tdb, F_WRLCK, FREELIST_TOP, 0, TDB_LOCK_WAIT)) {
 310                 return -1;
 311         }
 312
 313         if (tdb_brlock(tdb, F_WRLCK, OPEN_LOCK, 1, TDB_LOCK_WAIT)) {
 314                 tdb_brunlock(tdb, F_WRLCK, FREELIST_TOP, 0);
 315                 return -1;
 316         }
 317
 318         ret = tdb_transaction_recover(tdb);
 319
 320         tdb_brunlock(tdb, F_WRLCK, OPEN_LOCK, 1);
 321         tdb_brunlock(tdb, F_WRLCK, FREELIST_TOP, 0);
 322
 323         return ret;
 324 }
 325
 326 static bool have_data_locks(const struct tdb_context *tdb)
 327 {
 328         unsigned int i;
 329
 330         for (i = 0; i < tdb->num_lockrecs; i++) {
 331                 if (tdb->lockrecs[i].off >= lock_offset(-1))
 332                         return true;
 333         }
 334         return false;
 335 }
 336
 337 static int tdb_lock_list(struct tdb_context *tdb, int list, int ltype,
 338                          enum tdb_lock_flags waitflag)
 339 {
 340         int ret;
 341         bool check = false;
 342
 343         /* a allrecord lock allows us to avoid per chain locks */
 344         if (tdb->allrecord_lock.count &&
 345             (ltype == tdb->allrecord_lock.ltype || ltype == F_RDLCK)) {
 346                 return 0;
 347         }
 348
 349         if (tdb->allrecord_lock.count) {
 350                 tdb->ecode = TDB_ERR_LOCK;
 351                 ret = -1;
 352         } else {
 353                 /* Only check when we grab first data lock. */
 354                 check = !have_data_locks(tdb);
 355                 ret = tdb_nest_lock(tdb, lock_offset(list), ltype, waitflag);
 356
 357                 if (ret == 0 && check && tdb_needs_recovery(tdb)) {
 358                         tdb_nest_unlock(tdb, lock_offset(list), ltype, false);
 359
 360                         if (tdb_lock_and_recover(tdb) == -1) {
 361                                 return -1;
 362                         }
 363                         return tdb_lock_list(tdb, list, ltype, waitflag);
 364                 }
 365         }
 366         return ret;
 367 }
 368
 369 /* lock a list in the database. list -1 is the alloc list */
 370 int tdb_lock(struct tdb_context *tdb, int list, int ltype)
 371 {
 372         int ret;
 373
 374         ret = tdb_lock_list(tdb, list, ltype, TDB_LOCK_WAIT);
 375         if (ret) {
 376                 TDB_LOG((tdb, TDB_DEBUG_ERROR, "tdb_lock failed on list %d "
 377                          "ltype=%d (%s)\n",  list, ltype, strerror(errno)));
 378         }
 379         return ret;
 380 }
 381
 382 /* lock a list in the database. list -1 is the alloc list. non-blocking lock */
 383 int tdb_lock_nonblock(struct tdb_context *tdb, int list, int ltype)
 384 {
 385         return tdb_lock_list(tdb, list, ltype, TDB_LOCK_NOWAIT);
 386 }
 387
 388
 389 int tdb_nest_unlock(struct tdb_context *tdb, uint32_t offset, int ltype,
 390                     bool mark_lock)
 391 {
 392         int ret = -1;
 393         struct tdb_lock_type *lck;
 394
 395         if (tdb->flags & TDB_NOLOCK)
 396                 return 0;
 397
 398         /* Sanity checks */
 399         if (offset >= lock_offset(tdb->header.hash_size)) {
 400                 TDB_LOG((tdb, TDB_DEBUG_ERROR, "tdb_unlock: offset %u invalid (%d)\n", offset, tdb->header.hash_size));
 401                 return ret;
 402         }
 403
 404         lck = find_nestlock(tdb, offset);
 405         if ((lck == NULL) || (lck->count == 0)) {
 406                 TDB_LOG((tdb, TDB_DEBUG_ERROR, "tdb_unlock: count is 0\n"));
 407                 return -1;
 408         }
 409
 410         if (lck->count > 1) {
 411                 lck->count--;
 412                 return 0;
 413         }
 414
 415         /*
 416          * This lock has count==1 left, so we need to unlock it in the
 417          * kernel. We don't bother with decrementing the in-memory array
 418          * element, we're about to overwrite it with the last array element
 419          * anyway.
 420          */
 421
 422         if (mark_lock) {
 423                 ret = 0;
 424         } else {
 425                 ret = tdb_brunlock(tdb, ltype, offset, 1);
 426         }
 427
 428         /*
 429          * Shrink the array by overwriting the element just unlocked with the
 430          * last array element.
 431          */
 432         *lck = tdb->lockrecs[--tdb->num_lockrecs];
 433
 434         /*
 435          * We don't bother with realloc when the array shrinks, but if we have
 436          * a completely idle tdb we should get rid of the locked array.
 437          */
 438
 439         if (tdb->num_lockrecs == 0) {
 440                 SAFE_FREE(tdb->lockrecs);
 441         }
 442
 443         if (ret)
 444                 TDB_LOG((tdb, TDB_DEBUG_ERROR, "tdb_unlock: An error occurred unlocking!\n"));
 445         return ret;
 446 }
 447
 448 int tdb_unlock(struct tdb_context *tdb, int list, int ltype)
 449 {
 450         /* a global lock allows us to avoid per chain locks */
 451         if (tdb->allrecord_lock.count &&
 452             (ltype == tdb->allrecord_lock.ltype || ltype == F_RDLCK)) {
 453                 return 0;
 454         }
 455
 456         if (tdb->allrecord_lock.count) {
 457                 tdb->ecode = TDB_ERR_LOCK;
 458                 return -1;
 459         }
 460
 461         return tdb_nest_unlock(tdb, lock_offset(list), ltype, false);
 462 }
 463
 464 /*
 465   get the transaction lock
 466  */
 467 int tdb_transaction_lock(struct tdb_context *tdb, int ltype)
 468 {
 469         return tdb_nest_lock(tdb, TRANSACTION_LOCK, ltype, TDB_LOCK_WAIT);
 470 }
 471
 472 /*
 473   release the transaction lock
 474  */
 475 int tdb_transaction_unlock(struct tdb_context *tdb, int ltype)
 476 {
 477         return tdb_nest_unlock(tdb, TRANSACTION_LOCK, ltype, false);
 478 }
 479
 480 /* Returns 0 if all done, -1 if error, 1 if ok. */
 481 static int tdb_allrecord_check(struct tdb_context *tdb, int ltype,
 482                                enum tdb_lock_flags flags, bool upgradable)
 483 {
 484         /* There are no locks on read-only dbs */
 485         if (tdb->read_only || tdb->traverse_read) {
 486                 tdb->ecode = TDB_ERR_LOCK;
 487                 return -1;
 488         }
 489
 490         if (tdb->allrecord_lock.count && tdb->allrecord_lock.ltype == ltype) {
 491                 tdb->allrecord_lock.count++;
 492                 return 0;
 493         }
 494
 495         if (tdb->allrecord_lock.count) {
 496                 /* a global lock of a different type exists */
 497                 tdb->ecode = TDB_ERR_LOCK;
 498                 return -1;
 499         }
 500
 501         if (tdb_have_extra_locks(tdb)) {
 502                 /* can't combine global and chain locks */
 503                 tdb->ecode = TDB_ERR_LOCK;
 504                 return -1;
 505         }
 506
 507         if (upgradable && ltype != F_RDLCK) {
 508                 /* tdb error: you can't upgrade a write lock! */
 509                 tdb->ecode = TDB_ERR_LOCK;
 510                 return -1;
 511         }
 512         return 1;
 513 }
 514
 515 /* We only need to lock individual bytes, but Linux merges consecutive locks
 516  * so we lock in contiguous ranges. */
 517 static int tdb_chainlock_gradual(struct tdb_context *tdb,
 518                                  int ltype, enum tdb_lock_flags flags,
 519                                  size_t off, size_t len)
 520 {
 521         int ret;
 522         enum tdb_lock_flags nb_flags = (flags & ~TDB_LOCK_WAIT);
 523
 524         if (len <= 4) {
 525                 /* Single record.  Just do blocking lock. */
 526                 return tdb_brlock(tdb, ltype, off, len, flags);
 527         }
 528
 529         /* First we try non-blocking. */
 530         ret = tdb_brlock(tdb, ltype, off, len, nb_flags);
 531         if (ret == 0) {
 532                 return 0;
 533         }
 534
 535         /* Try locking first half, then second. */
 536         ret = tdb_chainlock_gradual(tdb, ltype, flags, off, len / 2);
 537         if (ret == -1)
 538                 return -1;
 539
 540         ret = tdb_chainlock_gradual(tdb, ltype, flags,
 541                                     off + len / 2, len - len / 2);
 542         if (ret == -1) {
 543                 tdb_brunlock(tdb, ltype, off, len / 2);
 544                 return -1;
 545         }
 546         return 0;
 547 }
 548
 549 /* lock/unlock entire database.  It can only be upgradable if you have some
 550  * other way of guaranteeing exclusivity (ie. transaction write lock).
 551  * We do the locking gradually to avoid being starved by smaller locks. */
 552 int tdb_allrecord_lock(struct tdb_context *tdb, int ltype,
 553                        enum tdb_lock_flags flags, bool upgradable)
 554 {
 555         switch (tdb_allrecord_check(tdb, ltype, flags, upgradable)) {
 556         case -1:
 557                 return -1;
 558         case 0:
 559                 return 0;
 560         }
 561
 562         /* We cover two kinds of locks:
 563          * 1) Normal chain locks.  Taken for almost all operations.
 564          * 3) Individual records locks.  Taken after normal or free
 565          *    chain locks.
 566          *
 567          * It is (1) which cause the starvation problem, so we're only
 568          * gradual for that. */
 569         if (tdb_chainlock_gradual(tdb, ltype, flags, FREELIST_TOP,
 570                                   tdb->header.hash_size * 4) == -1) {
 571                 return -1;
 572         }
 573
 574         /* Grab individual record locks. */
 575         if (tdb_brlock(tdb, ltype, lock_offset(tdb->header.hash_size), 0,
 576                        flags) == -1) {
 577                 tdb_brunlock(tdb, ltype, FREELIST_TOP,
 578                              tdb->header.hash_size * 4);
 579                 return -1;
 580         }
 581
 582         tdb->allrecord_lock.count = 1;
 583         /* If it's upgradable, it's actually exclusive so we can treat
 584          * it as a write lock. */
 585         tdb->allrecord_lock.ltype = upgradable ? F_WRLCK : ltype;
 586         tdb->allrecord_lock.off = upgradable;
 587
 588         if (tdb_needs_recovery(tdb)) {
 589                 bool mark = flags & TDB_LOCK_MARK_ONLY;
 590                 tdb_allrecord_unlock(tdb, ltype, mark);
 591                 if (mark) {
 592                         tdb->ecode = TDB_ERR_LOCK;
 593                         TDB_LOG((tdb, TDB_DEBUG_ERROR,
 594                                  "tdb_lockall_mark cannot do recovery\n"));
 595                         return -1;
 596                 }
 597                 if (tdb_lock_and_recover(tdb) == -1) {
 598                         return -1;
 599                 }
 600                 return tdb_allrecord_lock(tdb, ltype, flags, upgradable);
 601         }
 602
 603         return 0;
 604 }
 605
 606
 607
 608 /* unlock entire db */
 609 int tdb_allrecord_unlock(struct tdb_context *tdb, int ltype, bool mark_lock)
 610 {
 611         /* There are no locks on read-only dbs */
 612         if (tdb->read_only || tdb->traverse_read) {
 613                 tdb->ecode = TDB_ERR_LOCK;
 614                 return -1;
 615         }
 616
 617         if (tdb->allrecord_lock.count == 0) {
 618                 tdb->ecode = TDB_ERR_LOCK;
 619                 return -1;
 620         }
 621
 622         /* Upgradable locks are marked as write locks. */
 623         if (tdb->allrecord_lock.ltype != ltype
 624             && (!tdb->allrecord_lock.off || ltype != F_RDLCK)) {
 625                 tdb->ecode = TDB_ERR_LOCK;
 626                 return -1;
 627         }
 628
 629         if (tdb->allrecord_lock.count > 1) {
 630                 tdb->allrecord_lock.count--;
 631                 return 0;
 632         }
 633
 634         if (!mark_lock && tdb_brunlock(tdb, ltype, FREELIST_TOP, 0)) {
 635                 TDB_LOG((tdb, TDB_DEBUG_ERROR, "tdb_unlockall failed (%s)\n", strerror(errno)));
 636                 return -1;
 637         }
 638
 639         tdb->allrecord_lock.count = 0;
 640         tdb->allrecord_lock.ltype = 0;
 641
 642         return 0;
 643 }
 644
 645 /* lock entire database with write lock */
 646 int tdb_lockall(struct tdb_context *tdb)
 647 {
 648         tdb_trace(tdb, "tdb_lockall");
 649         return tdb_allrecord_lock(tdb, F_WRLCK, TDB_LOCK_WAIT, false);
 650 }
 651
 652 /* lock entire database with write lock - mark only */
 653 int tdb_lockall_mark(struct tdb_context *tdb)
 654 {
 655         tdb_trace(tdb, "tdb_lockall_mark");
 656         return tdb_allrecord_lock(tdb, F_WRLCK, TDB_LOCK_MARK_ONLY, false);
 657 }
 658
 659 /* unlock entire database with write lock - unmark only */
 660 int tdb_lockall_unmark(struct tdb_context *tdb)
 661 {
 662         tdb_trace(tdb, "tdb_lockall_unmark");
 663         return tdb_allrecord_unlock(tdb, F_WRLCK, true);
 664 }
 665
 666 /* lock entire database with write lock - nonblocking varient */
 667 int tdb_lockall_nonblock(struct tdb_context *tdb)
 668 {
 669         int ret = tdb_allrecord_lock(tdb, F_WRLCK, TDB_LOCK_NOWAIT, false);
 670         tdb_trace_ret(tdb, "tdb_lockall_nonblock", ret);
 671         return ret;
 672 }
 673
 674 /* unlock entire database with write lock */
 675 int tdb_unlockall(struct tdb_context *tdb)
 676 {
 677         tdb_trace(tdb, "tdb_unlockall");
 678         return tdb_allrecord_unlock(tdb, F_WRLCK, false);
 679 }
 680
 681 /* lock entire database with read lock */
 682 int tdb_lockall_read(struct tdb_context *tdb)
 683 {
 684         tdb_trace(tdb, "tdb_lockall_read");
 685         return tdb_allrecord_lock(tdb, F_RDLCK, TDB_LOCK_WAIT, false);
 686 }
 687
 688 /* lock entire database with read lock - nonblock varient */
 689 int tdb_lockall_read_nonblock(struct tdb_context *tdb)
 690 {
 691         int ret = tdb_allrecord_lock(tdb, F_RDLCK, TDB_LOCK_NOWAIT, false);
 692         tdb_trace_ret(tdb, "tdb_lockall_read_nonblock", ret);
 693         return ret;
 694 }
 695
 696 /* unlock entire database with read lock */
 697 int tdb_unlockall_read(struct tdb_context *tdb)
 698 {
 699         tdb_trace(tdb, "tdb_unlockall_read");
 700         return tdb_allrecord_unlock(tdb, F_RDLCK, false);
 701 }
 702
 703 /* lock/unlock one hash chain. This is meant to be used to reduce
 704    contention - it cannot guarantee how many records will be locked */
 705 int tdb_chainlock(struct tdb_context *tdb, TDB_DATA key)
 706 {
 707         int ret = tdb_lock(tdb, BUCKET(tdb->hash_fn(&key)), F_WRLCK);
 708         tdb_trace_1rec(tdb, "tdb_chainlock", key);
 709         return ret;
 710 }
 711
 712 /* lock/unlock one hash chain, non-blocking. This is meant to be used
 713    to reduce contention - it cannot guarantee how many records will be
 714    locked */
 715 int tdb_chainlock_nonblock(struct tdb_context *tdb, TDB_DATA key)
 716 {
 717         int ret = tdb_lock_nonblock(tdb, BUCKET(tdb->hash_fn(&key)), F_WRLCK);
 718         tdb_trace_1rec_ret(tdb, "tdb_chainlock_nonblock", key, ret);
 719         return ret;
 720 }
 721
 722 /* mark a chain as locked without actually locking it. Warning! use with great caution! */
 723 int tdb_chainlock_mark(struct tdb_context *tdb, TDB_DATA key)
 724 {
 725         int ret = tdb_nest_lock(tdb, lock_offset(BUCKET(tdb->hash_fn(&key))),
 726                                 F_WRLCK, TDB_LOCK_MARK_ONLY);
 727         tdb_trace_1rec(tdb, "tdb_chainlock_mark", key);
 728         return ret;
 729 }
 730
 731 /* unmark a chain as locked without actually locking it. Warning! use with great caution! */
 732 int tdb_chainlock_unmark(struct tdb_context *tdb, TDB_DATA key)
 733 {
 734         tdb_trace_1rec(tdb, "tdb_chainlock_unmark", key);
 735         return tdb_nest_unlock(tdb, lock_offset(BUCKET(tdb->hash_fn(&key))),
 736                                F_WRLCK, true);
 737 }
 738
 739 int tdb_chainunlock(struct tdb_context *tdb, TDB_DATA key)
 740 {
 741         tdb_trace_1rec(tdb, "tdb_chainunlock", key);
 742         return tdb_unlock(tdb, BUCKET(tdb->hash_fn(&key)), F_WRLCK);
 743 }
 744
 745 int tdb_chainlock_read(struct tdb_context *tdb, TDB_DATA key)
 746 {
 747         int ret;
 748         ret = tdb_lock(tdb, BUCKET(tdb->hash_fn(&key)), F_RDLCK);
 749         tdb_trace_1rec(tdb, "tdb_chainlock_read", key);
 750         return ret;
 751 }
 752
 753 int tdb_chainunlock_read(struct tdb_context *tdb, TDB_DATA key)
 754 {
 755         tdb_trace_1rec(tdb, "tdb_chainunlock_read", key);
 756         return tdb_unlock(tdb, BUCKET(tdb->hash_fn(&key)), F_RDLCK);
 757 }
 758
 759
 760
 761 /* record lock stops delete underneath */
 762 int tdb_lock_record(struct tdb_context *tdb, tdb_off_t off)
 763 {
 764         if (tdb->allrecord_lock.count) {
 765                 return 0;
 766         }
 767         return off ? tdb_brlock(tdb, F_RDLCK, off, 1, TDB_LOCK_WAIT) : 0;
 768 }
 769
 770 /*
 771   Write locks override our own fcntl readlocks, so check it here.
 772   Note this is meant to be F_SETLK, *not* F_SETLKW, as it's not
 773   an error to fail to get the lock here.
 774 */
 775 int tdb_write_lock_record(struct tdb_context *tdb, tdb_off_t off)
 776 {
 777         struct tdb_traverse_lock *i;
 778         for (i = &tdb->travlocks; i; i = i->next)
 779                 if (i->off == off)
 780                         return -1;
 781         if (tdb->allrecord_lock.count) {
 782                 if (tdb->allrecord_lock.ltype == F_WRLCK) {
 783                         return 0;
 784                 }
 785                 return -1;
 786         }
 787         return tdb_brlock(tdb, F_WRLCK, off, 1, TDB_LOCK_NOWAIT|TDB_LOCK_PROBE);
 788 }
 789
 790 int tdb_write_unlock_record(struct tdb_context *tdb, tdb_off_t off)
 791 {
 792         if (tdb->allrecord_lock.count) {
 793                 return 0;
 794         }
 795         return tdb_brunlock(tdb, F_WRLCK, off, 1);
 796 }
 797
 798 /* fcntl locks don't stack: avoid unlocking someone else's */
 799 int tdb_unlock_record(struct tdb_context *tdb, tdb_off_t off)
 800 {
 801         struct tdb_traverse_lock *i;
 802         uint32_t count = 0;
 803
 804         if (tdb->allrecord_lock.count) {
 805                 return 0;
 806         }
 807
 808         if (off == 0)
 809                 return 0;
 810         for (i = &tdb->travlocks; i; i = i->next)
 811                 if (i->off == off)
 812                         count++;
 813         return (count == 1 ? tdb_brunlock(tdb, F_RDLCK, off, 1) : 0);
 814 }
 815
 816 bool tdb_have_extra_locks(struct tdb_context *tdb)
 817 {
 818         unsigned int extra = tdb->num_lockrecs;
 819
 820         /* A transaction holds the lock for all records. */
 821         if (!tdb->transaction && tdb->allrecord_lock.count) {
 822                 return true;
 823         }
 824
 825         /* We always hold the active lock if CLEAR_IF_FIRST. */
 826         if (find_nestlock(tdb, ACTIVE_LOCK)) {
 827                 extra--;
 828         }
 829
 830         /* In a transaction, we expect to hold the transaction lock */
 831         if (tdb->transaction && find_nestlock(tdb, TRANSACTION_LOCK)) {
 832                 extra--;
 833         }
 834
 835         return extra;
 836 }
 837
 838 /* The transaction code uses this to remove all locks.  Note that this
 839    may include OPEN_LOCK. */
 840 void tdb_release_extra_locks(struct tdb_context *tdb)
 841 {
 842         unsigned int i, extra = 0;
 843
 844         if (tdb->allrecord_lock.count != 0) {
 845                 tdb_brunlock(tdb, tdb->allrecord_lock.ltype, FREELIST_TOP, 0);
 846                 tdb->allrecord_lock.count = 0;
 847         }
 848
 849         for (i=0;i<tdb->num_lockrecs;i++) {
 850                 struct tdb_lock_type *lck = &tdb->lockrecs[i];
 851
 852                 /* Don't release transaction or active locks! */
 853                 if (tdb->transaction && lck->off == TRANSACTION_LOCK) {
 854                         tdb->lockrecs[extra++] = *lck;
 855                 } else if (lck->off == ACTIVE_LOCK) {
 856                         tdb->lockrecs[extra++] = *lck;
 857                 } else {
 858                         tdb_brunlock(tdb, lck->ltype, lck->off, 1);
 859                 }
 860         }
 861         tdb->num_lockrecs = extra;
 862         if (tdb->num_lockrecs == 0) {
 863                 SAFE_FREE(tdb->lockrecs);
 864         }
 865 }