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