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         /* Sanity check */
 156         if (tdb->transaction && offset >= lock_offset(-1) && len != 0) {
 157                 tdb->ecode = TDB_ERR_RDONLY;
 158                 TDB_LOG((tdb, TDB_DEBUG_TRACE, "tdb_brlock attempted in transaction at offset %d rw_type=%d flags=%d len=%d\n",
 159                          offset, rw_type, flags, (int)len));
 160                 return -1;
 161         }
 162
 163         do {
 164                 ret = fcntl_lock(tdb, rw_type, offset, len,
 165                                  flags & TDB_LOCK_WAIT);
 166                 /* Check for a sigalarm break. */
 167                 if (ret == -1 && errno == EINTR &&
 168                                 tdb->interrupt_sig_ptr &&
 169                                 *tdb->interrupt_sig_ptr) {
 170                         break;
 171                 }
 172         } while (ret == -1 && errno == EINTR);
 173
 174         if (ret == -1) {
 175                 tdb->ecode = TDB_ERR_LOCK;
 176                 /* Generic lock error. errno set by fcntl.
 177                  * EAGAIN is an expected return from non-blocking
 178                  * locks. */
 179                 if (!(flags & TDB_LOCK_PROBE) && errno != EAGAIN) {
 180                         TDB_LOG((tdb, TDB_DEBUG_TRACE,"tdb_brlock failed (fd=%d) at offset %d rw_type=%d flags=%d len=%d\n",
 181                                  tdb->fd, offset, rw_type, flags, (int)len));
 182                 }
 183                 return -1;
 184         }
 185         return 0;
 186 }
 187
 188 int tdb_brunlock(struct tdb_context *tdb,
 189                  int rw_type, tdb_off_t offset, size_t len)
 190 {
 191         int ret;
 192
 193         if (tdb->flags & TDB_NOLOCK) {
 194                 return 0;
 195         }
 196
 197         do {
 198                 ret = fcntl_unlock(tdb, rw_type, offset, len);
 199         } while (ret == -1 && errno == EINTR);
 200
 201         if (ret == -1) {
 202                 TDB_LOG((tdb, TDB_DEBUG_TRACE,"tdb_brunlock failed (fd=%d) at offset %d rw_type=%d len=%d\n",
 203                          tdb->fd, offset, rw_type, (int)len));
 204         }
 205         return ret;
 206 }
 207
 208 /*
 209   upgrade a read lock to a write lock. This needs to be handled in a
 210   special way as some OSes (such as solaris) have too conservative
 211   deadlock detection and claim a deadlock when progress can be
 212   made. For those OSes we may loop for a while.
 213 */
 214 int tdb_allrecord_upgrade(struct tdb_context *tdb)
 215 {
 216         int count = 1000;
 217
 218         if (tdb->allrecord_lock.count != 1) {
 219                 TDB_LOG((tdb, TDB_DEBUG_ERROR,
 220                          "tdb_allrecord_upgrade failed: count %u too high\n",
 221                          tdb->allrecord_lock.count));
 222                 return -1;
 223         }
 224
 225         if (tdb->allrecord_lock.off != 1) {
 226                 TDB_LOG((tdb, TDB_DEBUG_ERROR,
 227                          "tdb_allrecord_upgrade failed: already upgraded?\n"));
 228                 return -1;
 229         }
 230
 231         while (count--) {
 232                 struct timeval tv;
 233                 if (tdb_brlock(tdb, F_WRLCK, FREELIST_TOP, 0,
 234                                TDB_LOCK_WAIT|TDB_LOCK_PROBE) == 0) {
 235                         tdb->allrecord_lock.ltype = F_WRLCK;
 236                         tdb->allrecord_lock.off = 0;
 237                         return 0;
 238                 }
 239                 if (errno != EDEADLK) {
 240                         break;
 241                 }
 242                 /* sleep for as short a time as we can - more portable than usleep() */
 243                 tv.tv_sec = 0;
 244                 tv.tv_usec = 1;
 245                 select(0, NULL, NULL, NULL, &tv);
 246         }
 247         TDB_LOG((tdb, TDB_DEBUG_TRACE,"tdb_allrecord_upgrade failed\n"));
 248         return -1;
 249 }
 250
 251 static struct tdb_lock_type *find_nestlock(struct tdb_context *tdb,
 252                                            tdb_off_t offset)
 253 {
 254         unsigned int i;
 255
 256         for (i=0; i<tdb->num_lockrecs; i++) {
 257                 if (tdb->lockrecs[i].off == offset) {
 258                         return &tdb->lockrecs[i];
 259                 }
 260         }
 261         return NULL;
 262 }
 263
 264 /* lock an offset in the database. */
 265 int tdb_nest_lock(struct tdb_context *tdb, uint32_t offset, int ltype,
 266                   enum tdb_lock_flags flags)
 267 {
 268         struct tdb_lock_type *new_lck;
 269
 270         if (offset >= lock_offset(tdb->header.hash_size)) {
 271                 tdb->ecode = TDB_ERR_LOCK;
 272                 TDB_LOG((tdb, TDB_DEBUG_ERROR,"tdb_lock: invalid offset %u for ltype=%d\n",
 273                          offset, ltype));
 274                 return -1;
 275         }
 276         if (tdb->flags & TDB_NOLOCK)
 277                 return 0;
 278
 279         new_lck = find_nestlock(tdb, offset);
 280         if (new_lck) {
 281                 /*
 282                  * Just increment the in-memory struct, posix locks
 283                  * don't stack.
 284                  */
 285                 new_lck->count++;
 286                 return 0;
 287         }
 288
 289         new_lck = (struct tdb_lock_type *)realloc(
 290                 tdb->lockrecs,
 291                 sizeof(*tdb->lockrecs) * (tdb->num_lockrecs+1));
 292         if (new_lck == NULL) {
 293                 errno = ENOMEM;
 294                 return -1;
 295         }
 296         tdb->lockrecs = new_lck;
 297
 298         /* Since fcntl locks don't nest, we do a lock for the first one,
 299            and simply bump the count for future ones */
 300         if (tdb_brlock(tdb, ltype, offset, 1, flags)) {
 301                 return -1;
 302         }
 303
 304         tdb->lockrecs[tdb->num_lockrecs].off = offset;
 305         tdb->lockrecs[tdb->num_lockrecs].count = 1;
 306         tdb->lockrecs[tdb->num_lockrecs].ltype = ltype;
 307         tdb->num_lockrecs++;
 308
 309         return 0;
 310 }
 311
 312 static int tdb_lock_list(struct tdb_context *tdb, int list, int ltype,
 313                          enum tdb_lock_flags waitflag)
 314 {
 315         int ret;
 316
 317         /* a allrecord lock allows us to avoid per chain locks */
 318         if (tdb->allrecord_lock.count &&
 319             (ltype == tdb->allrecord_lock.ltype || ltype == F_RDLCK)) {
 320                 return 0;
 321         }
 322
 323         if (tdb->allrecord_lock.count) {
 324                 tdb->ecode = TDB_ERR_LOCK;
 325                 ret = -1;
 326         } else {
 327                 ret = tdb_nest_lock(tdb, lock_offset(list), ltype, waitflag);
 328         }
 329         return ret;
 330 }
 331
 332 /* lock a list in the database. list -1 is the alloc list */
 333 int tdb_lock(struct tdb_context *tdb, int list, int ltype)
 334 {
 335         int ret;
 336
 337         ret = tdb_lock_list(tdb, list, ltype, TDB_LOCK_WAIT);
 338         if (ret) {
 339                 TDB_LOG((tdb, TDB_DEBUG_ERROR, "tdb_lock failed on list %d "
 340                          "ltype=%d (%s)\n",  list, ltype, strerror(errno)));
 341         }
 342         return ret;
 343 }
 344
 345 /* lock a list in the database. list -1 is the alloc list. non-blocking lock */
 346 int tdb_lock_nonblock(struct tdb_context *tdb, int list, int ltype)
 347 {
 348         return tdb_lock_list(tdb, list, ltype, TDB_LOCK_NOWAIT);
 349 }
 350
 351
 352 int tdb_nest_unlock(struct tdb_context *tdb, uint32_t offset, int ltype,
 353                     bool mark_lock)
 354 {
 355         int ret = -1;
 356         struct tdb_lock_type *lck;
 357
 358         if (tdb->flags & TDB_NOLOCK)
 359                 return 0;
 360
 361         /* Sanity checks */
 362         if (offset >= lock_offset(tdb->header.hash_size)) {
 363                 TDB_LOG((tdb, TDB_DEBUG_ERROR, "tdb_unlock: offset %u invalid (%d)\n", offset, tdb->header.hash_size));
 364                 return ret;
 365         }
 366
 367         lck = find_nestlock(tdb, offset);
 368         if ((lck == NULL) || (lck->count == 0)) {
 369                 TDB_LOG((tdb, TDB_DEBUG_ERROR, "tdb_unlock: count is 0\n"));
 370                 return -1;
 371         }
 372
 373         if (lck->count > 1) {
 374                 lck->count--;
 375                 return 0;
 376         }
 377
 378         /*
 379          * This lock has count==1 left, so we need to unlock it in the
 380          * kernel. We don't bother with decrementing the in-memory array
 381          * element, we're about to overwrite it with the last array element
 382          * anyway.
 383          */
 384
 385         if (mark_lock) {
 386                 ret = 0;
 387         } else {
 388                 ret = tdb_brunlock(tdb, ltype, offset, 1);
 389         }
 390
 391         /*
 392          * Shrink the array by overwriting the element just unlocked with the
 393          * last array element.
 394          */
 395         *lck = tdb->lockrecs[--tdb->num_lockrecs];
 396
 397         /*
 398          * We don't bother with realloc when the array shrinks, but if we have
 399          * a completely idle tdb we should get rid of the locked array.
 400          */
 401
 402         if (tdb->num_lockrecs == 0) {
 403                 SAFE_FREE(tdb->lockrecs);
 404         }
 405
 406         if (ret)
 407                 TDB_LOG((tdb, TDB_DEBUG_ERROR, "tdb_unlock: An error occurred unlocking!\n"));
 408         return ret;
 409 }
 410
 411 int tdb_unlock(struct tdb_context *tdb, int list, int ltype)
 412 {
 413         /* a global lock allows us to avoid per chain locks */
 414         if (tdb->allrecord_lock.count &&
 415             (ltype == tdb->allrecord_lock.ltype || ltype == F_RDLCK)) {
 416                 return 0;
 417         }
 418
 419         if (tdb->allrecord_lock.count) {
 420                 tdb->ecode = TDB_ERR_LOCK;
 421                 return -1;
 422         }
 423
 424         return tdb_nest_unlock(tdb, lock_offset(list), ltype, false);
 425 }
 426
 427 /*
 428   get the transaction lock
 429  */
 430 int tdb_transaction_lock(struct tdb_context *tdb, int ltype)
 431 {
 432         return tdb_nest_lock(tdb, TRANSACTION_LOCK, ltype, TDB_LOCK_WAIT);
 433 }
 434
 435 /*
 436   release the transaction lock
 437  */
 438 int tdb_transaction_unlock(struct tdb_context *tdb, int ltype)
 439 {
 440         return tdb_nest_unlock(tdb, TRANSACTION_LOCK, ltype, false);
 441 }
 442
 443
 444 /* lock/unlock entire database.  It can only be upgradable if you have some
 445  * other way of guaranteeing exclusivity (ie. transaction write lock). */
 446 int tdb_allrecord_lock(struct tdb_context *tdb, int ltype,
 447                        enum tdb_lock_flags flags, bool upgradable)
 448 {
 449         /* There are no locks on read-only dbs */
 450         if (tdb->read_only || tdb->traverse_read) {
 451                 tdb->ecode = TDB_ERR_LOCK;
 452                 return -1;
 453         }
 454
 455         if (tdb->allrecord_lock.count && tdb->allrecord_lock.ltype == ltype) {
 456                 tdb->allrecord_lock.count++;
 457                 return 0;
 458         }
 459
 460         if (tdb->allrecord_lock.count) {
 461                 /* a global lock of a different type exists */
 462                 tdb->ecode = TDB_ERR_LOCK;
 463                 return -1;
 464         }
 465
 466         if (tdb_have_extra_locks(tdb)) {
 467                 /* can't combine global and chain locks */
 468                 tdb->ecode = TDB_ERR_LOCK;
 469                 return -1;
 470         }
 471
 472         if (upgradable && ltype != F_RDLCK) {
 473                 /* tdb error: you can't upgrade a write lock! */
 474                 tdb->ecode = TDB_ERR_LOCK;
 475                 return -1;
 476         }
 477
 478         if (tdb_brlock(tdb, ltype, FREELIST_TOP, 0, flags)) {
 479                 if (flags & TDB_LOCK_WAIT) {
 480                         TDB_LOG((tdb, TDB_DEBUG_ERROR, "tdb_lockall failed (%s)\n", strerror(errno)));
 481                 }
 482                 return -1;
 483         }
 484
 485         tdb->allrecord_lock.count = 1;
 486         /* If it's upgradable, it's actually exclusive so we can treat
 487          * it as a write lock. */
 488         tdb->allrecord_lock.ltype = upgradable ? F_WRLCK : ltype;
 489         tdb->allrecord_lock.off = upgradable;
 490
 491         return 0;
 492 }
 493
 494
 495
 496 /* unlock entire db */
 497 int tdb_allrecord_unlock(struct tdb_context *tdb, int ltype, bool mark_lock)
 498 {
 499         /* There are no locks on read-only dbs */
 500         if (tdb->read_only || tdb->traverse_read) {
 501                 tdb->ecode = TDB_ERR_LOCK;
 502                 return -1;
 503         }
 504
 505         if (tdb->allrecord_lock.count == 0) {
 506                 tdb->ecode = TDB_ERR_LOCK;
 507                 return -1;
 508         }
 509
 510         /* Upgradable locks are marked as write locks. */
 511         if (tdb->allrecord_lock.ltype != ltype
 512             && (!tdb->allrecord_lock.off || ltype != F_RDLCK)) {
 513                 tdb->ecode = TDB_ERR_LOCK;
 514                 return -1;
 515         }
 516
 517         if (tdb->allrecord_lock.count > 1) {
 518                 tdb->allrecord_lock.count--;
 519                 return 0;
 520         }
 521
 522         if (!mark_lock && tdb_brunlock(tdb, ltype, FREELIST_TOP, 0)) {
 523                 TDB_LOG((tdb, TDB_DEBUG_ERROR, "tdb_unlockall failed (%s)\n", strerror(errno)));
 524                 return -1;
 525         }
 526
 527         tdb->allrecord_lock.count = 0;
 528         tdb->allrecord_lock.ltype = 0;
 529
 530         return 0;
 531 }
 532
 533 /* lock entire database with write lock */
 534 int tdb_lockall(struct tdb_context *tdb)
 535 {
 536         tdb_trace(tdb, "tdb_lockall");
 537         return tdb_allrecord_lock(tdb, F_WRLCK, TDB_LOCK_WAIT, false);
 538 }
 539
 540 /* lock entire database with write lock - mark only */
 541 int tdb_lockall_mark(struct tdb_context *tdb)
 542 {
 543         tdb_trace(tdb, "tdb_lockall_mark");
 544         return tdb_allrecord_lock(tdb, F_WRLCK, TDB_LOCK_MARK_ONLY, false);
 545 }
 546
 547 /* unlock entire database with write lock - unmark only */
 548 int tdb_lockall_unmark(struct tdb_context *tdb)
 549 {
 550         tdb_trace(tdb, "tdb_lockall_unmark");
 551         return tdb_allrecord_unlock(tdb, F_WRLCK, true);
 552 }
 553
 554 /* lock entire database with write lock - nonblocking varient */
 555 int tdb_lockall_nonblock(struct tdb_context *tdb)
 556 {
 557         int ret = tdb_allrecord_lock(tdb, F_WRLCK, TDB_LOCK_NOWAIT, false);
 558         tdb_trace_ret(tdb, "tdb_lockall_nonblock", ret);
 559         return ret;
 560 }
 561
 562 /* unlock entire database with write lock */
 563 int tdb_unlockall(struct tdb_context *tdb)
 564 {
 565         tdb_trace(tdb, "tdb_unlockall");
 566         return tdb_allrecord_unlock(tdb, F_WRLCK, false);
 567 }
 568
 569 /* lock entire database with read lock */
 570 int tdb_lockall_read(struct tdb_context *tdb)
 571 {
 572         tdb_trace(tdb, "tdb_lockall_read");
 573         return tdb_allrecord_lock(tdb, F_RDLCK, TDB_LOCK_WAIT, false);
 574 }
 575
 576 /* lock entire database with read lock - nonblock varient */
 577 int tdb_lockall_read_nonblock(struct tdb_context *tdb)
 578 {
 579         int ret = tdb_allrecord_lock(tdb, F_RDLCK, TDB_LOCK_NOWAIT, false);
 580         tdb_trace_ret(tdb, "tdb_lockall_read_nonblock", ret);
 581         return ret;
 582 }
 583
 584 /* unlock entire database with read lock */
 585 int tdb_unlockall_read(struct tdb_context *tdb)
 586 {
 587         tdb_trace(tdb, "tdb_unlockall_read");
 588         return tdb_allrecord_unlock(tdb, F_RDLCK, false);
 589 }
 590
 591 /* lock/unlock one hash chain. This is meant to be used to reduce
 592    contention - it cannot guarantee how many records will be locked */
 593 int tdb_chainlock(struct tdb_context *tdb, TDB_DATA key)
 594 {
 595         int ret = tdb_lock(tdb, BUCKET(tdb->hash_fn(&key)), F_WRLCK);
 596         tdb_trace_1rec(tdb, "tdb_chainlock", key);
 597         return ret;
 598 }
 599
 600 /* lock/unlock one hash chain, non-blocking. This is meant to be used
 601    to reduce contention - it cannot guarantee how many records will be
 602    locked */
 603 int tdb_chainlock_nonblock(struct tdb_context *tdb, TDB_DATA key)
 604 {
 605         int ret = tdb_lock_nonblock(tdb, BUCKET(tdb->hash_fn(&key)), F_WRLCK);
 606         tdb_trace_1rec_ret(tdb, "tdb_chainlock_nonblock", key, ret);
 607         return ret;
 608 }
 609
 610 /* mark a chain as locked without actually locking it. Warning! use with great caution! */
 611 int tdb_chainlock_mark(struct tdb_context *tdb, TDB_DATA key)
 612 {
 613         int ret = tdb_nest_lock(tdb, lock_offset(BUCKET(tdb->hash_fn(&key))),
 614                                 F_WRLCK, TDB_LOCK_MARK_ONLY);
 615         tdb_trace_1rec(tdb, "tdb_chainlock_mark", key);
 616         return ret;
 617 }
 618
 619 /* unmark a chain as locked without actually locking it. Warning! use with great caution! */
 620 int tdb_chainlock_unmark(struct tdb_context *tdb, TDB_DATA key)
 621 {
 622         tdb_trace_1rec(tdb, "tdb_chainlock_unmark", key);
 623         return tdb_nest_unlock(tdb, lock_offset(BUCKET(tdb->hash_fn(&key))),
 624                                F_WRLCK, true);
 625 }
 626
 627 int tdb_chainunlock(struct tdb_context *tdb, TDB_DATA key)
 628 {
 629         tdb_trace_1rec(tdb, "tdb_chainunlock", key);
 630         return tdb_unlock(tdb, BUCKET(tdb->hash_fn(&key)), F_WRLCK);
 631 }
 632
 633 int tdb_chainlock_read(struct tdb_context *tdb, TDB_DATA key)
 634 {
 635         int ret;
 636         ret = tdb_lock(tdb, BUCKET(tdb->hash_fn(&key)), F_RDLCK);
 637         tdb_trace_1rec(tdb, "tdb_chainlock_read", key);
 638         return ret;
 639 }
 640
 641 int tdb_chainunlock_read(struct tdb_context *tdb, TDB_DATA key)
 642 {
 643         tdb_trace_1rec(tdb, "tdb_chainunlock_read", key);
 644         return tdb_unlock(tdb, BUCKET(tdb->hash_fn(&key)), F_RDLCK);
 645 }
 646
 647
 648
 649 /* record lock stops delete underneath */
 650 int tdb_lock_record(struct tdb_context *tdb, tdb_off_t off)
 651 {
 652         if (tdb->allrecord_lock.count) {
 653                 return 0;
 654         }
 655         return off ? tdb_brlock(tdb, F_RDLCK, off, 1, TDB_LOCK_WAIT) : 0;
 656 }
 657
 658 /*
 659   Write locks override our own fcntl readlocks, so check it here.
 660   Note this is meant to be F_SETLK, *not* F_SETLKW, as it's not
 661   an error to fail to get the lock here.
 662 */
 663 int tdb_write_lock_record(struct tdb_context *tdb, tdb_off_t off)
 664 {
 665         struct tdb_traverse_lock *i;
 666         for (i = &tdb->travlocks; i; i = i->next)
 667                 if (i->off == off)
 668                         return -1;
 669         if (tdb->allrecord_lock.count) {
 670                 if (tdb->allrecord_lock.ltype == F_WRLCK) {
 671                         return 0;
 672                 }
 673                 return -1;
 674         }
 675         return tdb_brlock(tdb, F_WRLCK, off, 1, TDB_LOCK_NOWAIT|TDB_LOCK_PROBE);
 676 }
 677
 678 int tdb_write_unlock_record(struct tdb_context *tdb, tdb_off_t off)
 679 {
 680         if (tdb->allrecord_lock.count) {
 681                 return 0;
 682         }
 683         return tdb_brunlock(tdb, F_WRLCK, off, 1);
 684 }
 685
 686 /* fcntl locks don't stack: avoid unlocking someone else's */
 687 int tdb_unlock_record(struct tdb_context *tdb, tdb_off_t off)
 688 {
 689         struct tdb_traverse_lock *i;
 690         uint32_t count = 0;
 691
 692         if (tdb->allrecord_lock.count) {
 693                 return 0;
 694         }
 695
 696         if (off == 0)
 697                 return 0;
 698         for (i = &tdb->travlocks; i; i = i->next)
 699                 if (i->off == off)
 700                         count++;
 701         return (count == 1 ? tdb_brunlock(tdb, F_RDLCK, off, 1) : 0);
 702 }
 703
 704 bool tdb_have_extra_locks(struct tdb_context *tdb)
 705 {
 706         unsigned int extra = tdb->num_lockrecs;
 707
 708         /* A transaction holds the lock for all records. */
 709         if (!tdb->transaction && tdb->allrecord_lock.count) {
 710                 return true;
 711         }
 712
 713         /* We always hold the active lock if CLEAR_IF_FIRST. */
 714         if (find_nestlock(tdb, ACTIVE_LOCK)) {
 715                 extra--;
 716         }
 717
 718         /* In a transaction, we expect to hold the transaction lock */
 719         if (tdb->transaction && find_nestlock(tdb, TRANSACTION_LOCK)) {
 720                 extra--;
 721         }
 722
 723         return extra;
 724 }
 725
 726 /* The transaction code uses this to remove all locks.  Note that this
 727    may include OPEN_LOCK. */
 728 void tdb_release_extra_locks(struct tdb_context *tdb)
 729 {
 730         unsigned int i, extra = 0;
 731
 732         if (tdb->allrecord_lock.count != 0) {
 733                 tdb_brunlock(tdb, tdb->allrecord_lock.ltype, FREELIST_TOP, 0);
 734                 tdb->allrecord_lock.count = 0;
 735         }
 736
 737         for (i=0;i<tdb->num_lockrecs;i++) {
 738                 struct tdb_lock_type *lck = &tdb->lockrecs[i];
 739
 740                 /* Don't release transaction or active locks! */
 741                 if (tdb->transaction && lck->off == TRANSACTION_LOCK) {
 742                         tdb->lockrecs[extra++] = *lck;
 743                 } else if (lck->off == ACTIVE_LOCK) {
 744                         tdb->lockrecs[extra++] = *lck;
 745                 } else {
 746                         tdb_brunlock(tdb, lck->ltype, lck->off, 1);
 747                 }
 748         }
 749         tdb->num_lockrecs = extra;
 750         if (tdb->num_lockrecs == 0) {
 751                 SAFE_FREE(tdb->lockrecs);
 752         }
 753 }