2 Unix SMB/CIFS implementation.
3 global locks based on dbwrap and messaging
4 Copyright (C) 2009 by Volker Lendecke
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 3 of the License, or
9 (at your option) any later version.
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with this program. If not, see <http://www.gnu.org/licenses/>.
23 static NTSTATUS g_lock_force_unlock(struct g_lock_ctx *ctx, const char *name,
24 struct server_id pid);
27 struct db_context *db;
28 struct messaging_context *msg;
32 * The "g_lock.tdb" file contains records, indexed by the 0-terminated
33 * lockname. The record contains an array of "struct g_lock_rec"
34 * structures. Waiters have the lock_type with G_LOCK_PENDING or'ed.
38 enum g_lock_type lock_type;
42 struct g_lock_ctx *g_lock_ctx_init(TALLOC_CTX *mem_ctx,
43 struct messaging_context *msg)
45 struct g_lock_ctx *result;
47 result = talloc(mem_ctx, struct g_lock_ctx);
53 result->db = db_open(result, lock_path("g_lock.tdb"), 0,
54 TDB_CLEAR_IF_FIRST|TDB_INCOMPATIBLE_HASH, O_RDWR|O_CREAT, 0700);
55 if (result->db == NULL) {
56 DEBUG(1, ("g_lock_init: Could not open g_lock.tdb"));
63 static bool g_lock_conflicts(enum g_lock_type lock_type,
64 const struct g_lock_rec *rec)
66 enum g_lock_type rec_lock = rec->lock_type;
68 if ((rec_lock & G_LOCK_PENDING) != 0) {
73 * Only tested write locks so far. Very likely this routine
74 * needs to be fixed for read locks....
76 if ((lock_type == G_LOCK_READ) && (rec_lock == G_LOCK_READ)) {
82 static bool g_lock_parse(TALLOC_CTX *mem_ctx, TDB_DATA data,
83 int *pnum_locks, struct g_lock_rec **plocks)
86 struct g_lock_rec *locks;
88 if ((data.dsize % sizeof(struct g_lock_rec)) != 0) {
89 DEBUG(1, ("invalid lock record length %d\n", (int)data.dsize));
93 num_locks = data.dsize / sizeof(struct g_lock_rec);
94 locks = talloc_array(mem_ctx, struct g_lock_rec, num_locks);
96 DEBUG(1, ("talloc failed\n"));
100 memcpy(locks, data.dptr, data.dsize);
102 DEBUG(10, ("locks:\n"));
103 for (i=0; i<num_locks; i++) {
104 DEBUGADD(10, ("%s: %s %s\n",
105 procid_str(debug_ctx(), &locks[i].pid),
106 ((locks[i].lock_type & 1) == G_LOCK_READ) ?
108 (locks[i].lock_type & G_LOCK_PENDING) ?
109 "(pending)" : "(owner)"));
111 if (((locks[i].lock_type & G_LOCK_PENDING) == 0)
112 && !process_exists(locks[i].pid)) {
114 DEBUGADD(10, ("lock owner %s died -- discarding\n",
115 procid_str(talloc_tos(),
118 if (i < (num_locks-1)) {
119 locks[i] = locks[num_locks-1];
126 *pnum_locks = num_locks;
130 static void g_lock_cleanup(int *pnum_locks, struct g_lock_rec *locks)
134 num_locks = *pnum_locks;
136 DEBUG(10, ("g_lock_cleanup: %d locks\n", num_locks));
138 for (i=0; i<num_locks; i++) {
139 if (process_exists(locks[i].pid)) {
142 DEBUGADD(10, ("%s does not exist -- discarding\n",
143 procid_str(debug_ctx(), &locks[i].pid)));
145 if (i < (num_locks-1)) {
146 locks[i] = locks[num_locks-1];
150 *pnum_locks = num_locks;
154 static struct g_lock_rec *g_lock_addrec(TALLOC_CTX *mem_ctx,
155 struct g_lock_rec *locks,
157 const struct server_id pid,
158 enum g_lock_type lock_type)
160 struct g_lock_rec *result;
161 int num_locks = *pnum_locks;
163 result = talloc_realloc(mem_ctx, locks, struct g_lock_rec,
165 if (result == NULL) {
169 result[num_locks].pid = pid;
170 result[num_locks].lock_type = lock_type;
175 static void g_lock_got_retry(struct messaging_context *msg,
178 struct server_id server_id,
180 static void g_lock_timedout(struct tevent_context *ev,
181 struct tevent_timer *te,
182 struct timeval current_time,
185 static NTSTATUS g_lock_trylock(struct g_lock_ctx *ctx, const char *name,
186 enum g_lock_type lock_type)
188 struct db_record *rec = NULL;
189 struct g_lock_rec *locks = NULL;
191 struct server_id self;
194 NTSTATUS status = NT_STATUS_OK;
195 NTSTATUS store_status;
198 rec = ctx->db->fetch_locked(ctx->db, talloc_tos(),
199 string_term_tdb_data(name));
201 DEBUG(10, ("fetch_locked(\"%s\") failed\n", name));
202 status = NT_STATUS_LOCK_NOT_GRANTED;
206 if (!g_lock_parse(talloc_tos(), rec->value, &num_locks, &locks)) {
207 DEBUG(10, ("g_lock_parse for %s failed\n", name));
208 status = NT_STATUS_INTERNAL_ERROR;
212 self = procid_self();
215 for (i=0; i<num_locks; i++) {
216 if (procid_equal(&self, &locks[i].pid)) {
217 if (our_index != -1) {
218 DEBUG(1, ("g_lock_trylock: Added ourself "
220 status = NT_STATUS_INTERNAL_ERROR;
223 if ((locks[i].lock_type & G_LOCK_PENDING) == 0) {
224 DEBUG(1, ("g_lock_trylock: Found ourself not "
226 status = NT_STATUS_INTERNAL_ERROR;
232 /* never conflict with ourself */
235 if (g_lock_conflicts(lock_type, &locks[i])) {
236 struct server_id pid = locks[i].pid;
238 if (!process_exists(pid)) {
241 status = g_lock_force_unlock(ctx, name, pid);
242 if (!NT_STATUS_IS_OK(status)) {
243 DEBUG(1, ("Could not unlock dead lock "
249 lock_type |= G_LOCK_PENDING;
253 if (our_index == -1) {
254 /* First round, add ourself */
256 locks = g_lock_addrec(talloc_tos(), locks, &num_locks,
259 DEBUG(10, ("g_lock_addrec failed\n"));
260 status = NT_STATUS_NO_MEMORY;
265 * Retry. We were pending last time. Overwrite the
266 * stored lock_type with what we calculated, we might
267 * have acquired the lock this time.
269 locks[our_index].lock_type = lock_type;
272 if (NT_STATUS_IS_OK(status) && ((lock_type & G_LOCK_PENDING) == 0)) {
274 * Walk through the list of locks, search for dead entries
276 g_lock_cleanup(&num_locks, locks);
279 data = make_tdb_data((uint8_t *)locks, num_locks * sizeof(*locks));
280 store_status = rec->store(rec, data, 0);
281 if (!NT_STATUS_IS_OK(store_status)) {
282 DEBUG(1, ("rec->store failed: %s\n",
283 nt_errstr(store_status)));
284 status = store_status;
291 if (NT_STATUS_IS_OK(status) && (lock_type & G_LOCK_PENDING) != 0) {
292 return STATUS_PENDING;
298 NTSTATUS g_lock_lock(struct g_lock_ctx *ctx, const char *name,
299 enum g_lock_type lock_type, struct timeval timeout)
301 struct tevent_timer *te = NULL;
304 struct timeval timeout_end;
305 struct timeval time_now;
307 DEBUG(10, ("Trying to acquire lock %d for %s\n", (int)lock_type,
310 if (lock_type & ~1) {
311 DEBUG(1, ("Got invalid lock type %d for %s\n",
312 (int)lock_type, name));
313 return NT_STATUS_INVALID_PARAMETER;
316 #ifdef CLUSTER_SUPPORT
317 if (lp_clustering()) {
318 status = ctdb_watch_us(messaging_ctdbd_connection());
319 if (!NT_STATUS_IS_OK(status)) {
320 DEBUG(10, ("could not register retry with ctdb: %s\n",
327 status = messaging_register(ctx->msg, &retry, MSG_DBWRAP_G_LOCK_RETRY,
329 if (!NT_STATUS_IS_OK(status)) {
330 DEBUG(10, ("messaging_register failed: %s\n",
335 time_now = timeval_current();
336 timeout_end = timeval_sum(&time_now, &timeout);
340 fd_set *r_fds = NULL;
343 struct timeval timeout_remaining, select_timeout;
345 status = g_lock_trylock(ctx, name, lock_type);
346 if (NT_STATUS_IS_OK(status)) {
347 DEBUG(10, ("Got lock %s\n", name));
350 if (!NT_STATUS_EQUAL(status, STATUS_PENDING)) {
351 DEBUG(10, ("g_lock_trylock failed: %s\n",
356 DEBUG(10, ("g_lock_trylock: Did not get lock, waiting...\n"));
358 /* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
359 * !!! HACK ALERT --- FIX ME !!!
360 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
361 * What we really want to do here is to react to
362 * MSG_DBWRAP_G_LOCK_RETRY messages that are either sent
363 * by a client doing g_lock_unlock or by ourselves when
364 * we receive a CTDB_SRVID_SAMBA_NOTIFY or
365 * CTDB_SRVID_RECONFIGURE message from ctdbd, i.e. when
366 * either a client holding a lock or a complete node
369 * Doing this properly involves calling tevent_loop_once(),
370 * but doing this here with the main ctdbd messaging context
371 * creates a nested event loop when g_lock_lock() is called
372 * from the main event loop, e.g. in a tcon_and_X where the
373 * share_info.tdb needs to be initialized and is locked by
374 * another process, or when the remore registry is accessed
375 * for writing and some other process already holds a lock
376 * on the registry.tdb.
378 * So as a quick fix, we act a little coarsely here: we do
379 * a select on the ctdb connection fd and when it is readable
380 * or we get EINTR, then we retry without actually parsing
381 * any ctdb packages or dispatching messages. This means that
382 * we retry more often than intended by design, but this does
383 * not harm and it is unobtrusive. When we have finished,
384 * the main loop will pick up all the messages and ctdb
385 * packets. The only extra twist is that we cannot use timed
386 * events here but have to handcode a timeout.
389 #ifdef CLUSTER_SUPPORT
390 if (lp_clustering()) {
391 struct ctdbd_connection *conn = messaging_ctdbd_connection();
395 max_fd = ctdbd_conn_get_fd(conn);
396 FD_SET(max_fd, r_fds);
400 time_now = timeval_current();
401 timeout_remaining = timeval_until(&time_now, &timeout_end);
402 select_timeout = timeval_set(60, 0);
404 select_timeout = timeval_min(&select_timeout,
407 ret = sys_select(max_fd + 1, r_fds, NULL, NULL,
410 if (errno != EINTR) {
411 DEBUG(1, ("error calling select: %s\n",
413 status = NT_STATUS_INTERNAL_ERROR;
418 * This means a signal was received.
419 * It might have been a MSG_DBWRAP_G_LOCK_RETRY message.
422 } else if (ret == 0) {
423 if (timeval_expired(&timeout_end)) {
424 DEBUG(10, ("g_lock_lock timed out\n"));
425 status = NT_STATUS_LOCK_NOT_GRANTED;
428 DEBUG(10, ("select returned 0 but timeout not "
429 "not expired, retrying\n"));
431 } else if (ret != 1) {
432 DEBUG(1, ("invalid return code of select: %d\n", ret));
433 status = NT_STATUS_INTERNAL_ERROR;
438 * This means ctdbd has sent us some data.
439 * Might be a CTDB_SRVID_RECONFIGURE or a
440 * CTDB_SRVID_SAMBA_NOTIFY message.
447 if (!NT_STATUS_IS_OK(status)) {
448 NTSTATUS unlock_status;
450 unlock_status = g_lock_unlock(ctx, name);
452 if (!NT_STATUS_IS_OK(unlock_status)) {
453 DEBUG(1, ("Could not remove ourself from the locking "
454 "db: %s\n", nt_errstr(status)));
458 messaging_deregister(ctx->msg, MSG_DBWRAP_G_LOCK_RETRY, &retry);
464 static void g_lock_got_retry(struct messaging_context *msg,
467 struct server_id server_id,
470 bool *pretry = (bool *)private_data;
472 DEBUG(10, ("Got retry message from pid %s\n",
473 procid_str(talloc_tos(), &server_id)));
478 static void g_lock_timedout(struct tevent_context *ev,
479 struct tevent_timer *te,
480 struct timeval current_time,
483 bool *ptimedout = (bool *)private_data;
488 static NTSTATUS g_lock_force_unlock(struct g_lock_ctx *ctx, const char *name,
489 struct server_id pid)
491 struct db_record *rec = NULL;
492 struct g_lock_rec *locks = NULL;
494 enum g_lock_type lock_type;
497 rec = ctx->db->fetch_locked(ctx->db, talloc_tos(),
498 string_term_tdb_data(name));
500 DEBUG(10, ("fetch_locked(\"%s\") failed\n", name));
501 status = NT_STATUS_INTERNAL_ERROR;
505 if (!g_lock_parse(talloc_tos(), rec->value, &num_locks, &locks)) {
506 DEBUG(10, ("g_lock_parse for %s failed\n", name));
507 status = NT_STATUS_INTERNAL_ERROR;
511 for (i=0; i<num_locks; i++) {
512 if (procid_equal(&pid, &locks[i].pid)) {
517 if (i == num_locks) {
518 DEBUG(10, ("g_lock_force_unlock: Lock not found\n"));
519 status = NT_STATUS_INTERNAL_ERROR;
523 lock_type = locks[i].lock_type;
525 if (i < (num_locks-1)) {
526 locks[i] = locks[num_locks-1];
530 if (num_locks == 0) {
531 status = rec->delete_rec(rec);
534 data = make_tdb_data((uint8_t *)locks,
535 sizeof(struct g_lock_rec) * num_locks);
536 status = rec->store(rec, data, 0);
539 if (!NT_STATUS_IS_OK(status)) {
540 DEBUG(1, ("g_lock_force_unlock: Could not store record: %s\n",
547 if ((lock_type & G_LOCK_PENDING) == 0) {
551 * We've been the lock holder. Others to retry. Don't
552 * tell all others to avoid a thundering herd. In case
553 * this leads to a complete stall because we miss some
554 * processes, the loop in g_lock_lock tries at least
558 for (i=0; i<num_locks; i++) {
559 if ((locks[i].lock_type & G_LOCK_PENDING) == 0) {
562 if (!process_exists(locks[i].pid)) {
567 * Ping all waiters to retry
569 status = messaging_send(ctx->msg, locks[i].pid,
570 MSG_DBWRAP_G_LOCK_RETRY,
572 if (!NT_STATUS_IS_OK(status)) {
573 DEBUG(1, ("sending retry to %s failed: %s\n",
574 procid_str(debug_ctx(),
580 if (num_wakeups > 5) {
587 * For the error path, TALLOC_FREE(rec) as well. In the good
588 * path we have already freed it.
596 NTSTATUS g_lock_unlock(struct g_lock_ctx *ctx, const char *name)
600 status = g_lock_force_unlock(ctx, name, procid_self());
602 #ifdef CLUSTER_SUPPORT
603 if (lp_clustering()) {
604 ctdb_unwatch(messaging_ctdbd_connection());
610 struct g_lock_locks_state {
611 int (*fn)(const char *name, void *private_data);
615 static int g_lock_locks_fn(struct db_record *rec, void *priv)
617 struct g_lock_locks_state *state = (struct g_lock_locks_state *)priv;
619 if ((rec->key.dsize == 0) || (rec->key.dptr[rec->key.dsize-1] != 0)) {
620 DEBUG(1, ("invalid key in g_lock.tdb, ignoring\n"));
623 return state->fn((char *)rec->key.dptr, state->private_data);
626 int g_lock_locks(struct g_lock_ctx *ctx,
627 int (*fn)(const char *name, void *private_data),
630 struct g_lock_locks_state state;
633 state.private_data = private_data;
635 return ctx->db->traverse_read(ctx->db, g_lock_locks_fn, &state);
638 NTSTATUS g_lock_dump(struct g_lock_ctx *ctx, const char *name,
639 int (*fn)(struct server_id pid,
640 enum g_lock_type lock_type,
646 struct g_lock_rec *locks = NULL;
649 if (ctx->db->fetch(ctx->db, talloc_tos(), string_term_tdb_data(name),
651 return NT_STATUS_NOT_FOUND;
654 if ((data.dsize == 0) || (data.dptr == NULL)) {
658 ret = g_lock_parse(talloc_tos(), data, &num_locks, &locks);
660 TALLOC_FREE(data.dptr);
663 DEBUG(10, ("g_lock_parse for %s failed\n", name));
664 return NT_STATUS_INTERNAL_ERROR;
667 for (i=0; i<num_locks; i++) {
668 if (fn(locks[i].pid, locks[i].lock_type, private_data) != 0) {
676 struct g_lock_get_state {
678 struct server_id *pid;
681 static int g_lock_get_fn(struct server_id pid, enum g_lock_type lock_type,
684 struct g_lock_get_state *state = (struct g_lock_get_state *)priv;
686 if ((lock_type & G_LOCK_PENDING) != 0) {
695 NTSTATUS g_lock_get(struct g_lock_ctx *ctx, const char *name,
696 struct server_id *pid)
698 struct g_lock_get_state state;
704 status = g_lock_dump(ctx, name, g_lock_get_fn, &state);
705 if (!NT_STATUS_IS_OK(status)) {
709 return NT_STATUS_NOT_FOUND;
714 static bool g_lock_init_all(TALLOC_CTX *mem_ctx,
715 struct tevent_context **pev,
716 struct messaging_context **pmsg,
717 struct g_lock_ctx **pg_ctx)
719 struct tevent_context *ev = NULL;
720 struct messaging_context *msg = NULL;
721 struct g_lock_ctx *g_ctx = NULL;
723 ev = tevent_context_init(mem_ctx);
725 d_fprintf(stderr, "ERROR: could not init event context\n");
728 msg = messaging_init(mem_ctx, procid_self(), ev);
730 d_fprintf(stderr, "ERROR: could not init messaging context\n");
733 g_ctx = g_lock_ctx_init(mem_ctx, msg);
735 d_fprintf(stderr, "ERROR: could not init g_lock context\n");
750 NTSTATUS g_lock_do(const char *name, enum g_lock_type lock_type,
751 struct timeval timeout,
752 void (*fn)(void *private_data), void *private_data)
754 struct tevent_context *ev = NULL;
755 struct messaging_context *msg = NULL;
756 struct g_lock_ctx *g_ctx = NULL;
759 if (!g_lock_init_all(talloc_tos(), &ev, &msg, &g_ctx)) {
760 status = NT_STATUS_ACCESS_DENIED;
764 status = g_lock_lock(g_ctx, name, lock_type, timeout);
765 if (!NT_STATUS_IS_OK(status)) {
769 g_lock_unlock(g_ctx, name);