2 Unix SMB/CIFS implementation.
4 Copyright (C) Ronnie Sahlberg 2007
5 Copyright (C) Andrew Tridgell 2007
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>.
22 this is the open files database, ctdb backend. It implements shared
23 storage of what files are open between server instances, and
24 implements the rules of shared access to files.
26 The caller needs to provide a file_key, which specifies what file
27 they are talking about. This needs to be a unique key across all
28 filesystems, and is usually implemented in terms of a device/inode
31 Before any operations can be performed the caller needs to establish
32 a lock on the record associated with file_key. That is done by
33 calling odb_lock(). The caller releases this lock by calling
34 talloc_free() on the returned handle.
36 All other operations on a record are done by passing the odb_lock()
37 handle back to this module. The handle contains internal
38 information about what file_key is being operated on.
42 #include "system/filesys.h"
43 #include "lib/tdb/include/tdb.h"
44 #include "messaging/messaging.h"
46 #include "lib/messaging/irpc.h"
47 #include "librpc/gen_ndr/ndr_opendb.h"
48 #include "ntvfs/ntvfs.h"
49 #include "ntvfs/common/ntvfs_common.h"
50 #include "cluster/cluster.h"
51 #include "include/ctdb.h"
52 #include "param/param.h"
55 struct ctdb_context *ctdb;
56 struct ctdb_db_context *ctdb_db;
57 struct ntvfs_context *ntvfs_ctx;
62 an odb lock handle. You must obtain one of these using odb_lock() before doing
66 struct odb_context *odb;
67 struct ctdb_record_handle *rec;
73 Open up the openfiles.tdb database. Close it down using
74 talloc_free(). We need the messaging_ctx to allow for pending open
77 static struct odb_context *odb_ctdb_init(TALLOC_CTX *mem_ctx,
78 struct ntvfs_context *ntvfs_ctx)
80 struct odb_context *odb;
81 struct ctdb_context *ctdb = talloc_get_type(cluster_backend_handle(),
84 odb = talloc(mem_ctx, struct odb_context);
90 odb->ctdb_db = ctdb_attach(ctdb, "opendb");
92 DEBUG(0,("Failed to get attached ctdb db handle for opendb\n"));
97 odb->ntvfs_ctx = ntvfs_ctx;
99 /* leave oplocks disabled by default until the code is working */
100 odb->oplocks = lp_parm_bool(ntvfs_ctx->lp_ctx, NULL, "opendb", "oplocks", false);
106 get a lock on a entry in the odb. This call returns a lock handle,
107 which the caller should unlock using talloc_free().
109 static struct odb_lock *odb_ctdb_lock(TALLOC_CTX *mem_ctx,
110 struct odb_context *odb, DATA_BLOB *file_key)
112 struct odb_lock *lck;
114 lck = talloc(mem_ctx, struct odb_lock);
119 lck->odb = talloc_reference(lck, odb);
120 lck->key.dptr = talloc_memdup(lck, file_key->data, file_key->length);
121 lck->key.dsize = file_key->length;
122 if (lck->key.dptr == NULL) {
127 lck->rec = ctdb_fetch_lock(odb->ctdb_db, (TALLOC_CTX *)lck, lck->key, &lck->data);
136 static DATA_BLOB odb_ctdb_get_key(TALLOC_CTX *mem_ctx, struct odb_lock *lck)
139 * as this file will went away and isn't used yet,
140 * copy the implementation from the tdb backend
143 return data_blob_const(NULL, 0);
147 determine if two odb_entry structures conflict
149 return NT_STATUS_OK on no conflict
151 static NTSTATUS share_conflict(struct opendb_entry *e1, struct opendb_entry *e2)
153 /* if either open involves no read.write or delete access then
155 if (!(e1->access_mask & (SEC_FILE_WRITE_DATA |
156 SEC_FILE_APPEND_DATA |
162 if (!(e2->access_mask & (SEC_FILE_WRITE_DATA |
163 SEC_FILE_APPEND_DATA |
170 /* data IO access masks. This is skipped if the two open handles
171 are on different streams (as in that case the masks don't
173 if (e1->stream_id != e2->stream_id) {
177 #define CHECK_MASK(am, right, sa, share) \
178 if (((am) & (right)) && !((sa) & (share))) return NT_STATUS_SHARING_VIOLATION
180 CHECK_MASK(e1->access_mask, SEC_FILE_WRITE_DATA | SEC_FILE_APPEND_DATA,
181 e2->share_access, NTCREATEX_SHARE_ACCESS_WRITE);
182 CHECK_MASK(e2->access_mask, SEC_FILE_WRITE_DATA | SEC_FILE_APPEND_DATA,
183 e1->share_access, NTCREATEX_SHARE_ACCESS_WRITE);
185 CHECK_MASK(e1->access_mask, SEC_FILE_READ_DATA | SEC_FILE_EXECUTE,
186 e2->share_access, NTCREATEX_SHARE_ACCESS_READ);
187 CHECK_MASK(e2->access_mask, SEC_FILE_READ_DATA | SEC_FILE_EXECUTE,
188 e1->share_access, NTCREATEX_SHARE_ACCESS_READ);
190 CHECK_MASK(e1->access_mask, SEC_STD_DELETE,
191 e2->share_access, NTCREATEX_SHARE_ACCESS_DELETE);
192 CHECK_MASK(e2->access_mask, SEC_STD_DELETE,
193 e1->share_access, NTCREATEX_SHARE_ACCESS_DELETE);
199 pull a record, translating from the db format to the opendb_file structure defined
202 static NTSTATUS odb_pull_record(struct odb_lock *lck, struct opendb_file *file)
206 enum ndr_err_code ndr_err;
210 if (dbuf.dsize == 0) {
211 /* empty record in ctdb means the record isn't there */
212 return NT_STATUS_OBJECT_NAME_NOT_FOUND;
215 blob.data = dbuf.dptr;
216 blob.length = dbuf.dsize;
218 ndr_err = ndr_pull_struct_blob(&blob, lck, lp_iconv_convenience(lck->odb->ntvfs_ctx->lp_ctx), file, (ndr_pull_flags_fn_t)ndr_pull_opendb_file);
219 if (!NDR_ERR_CODE_IS_SUCCESS(ndr_err)) {
220 return ndr_map_error2ntstatus(ndr_err);
227 push a record, translating from the opendb_file structure defined in opendb.idl
229 static NTSTATUS odb_push_record(struct odb_lock *lck, struct opendb_file *file)
233 enum ndr_err_code ndr_err;
236 if (!file->num_entries) {
239 ctdb_record_store(lck->rec, dbuf);
240 talloc_free(lck->rec);
244 ndr_err = ndr_push_struct_blob(&blob, lck,
245 lp_iconv_convenience(lck->odb->ntvfs_ctx->lp_ctx),
246 file, (ndr_push_flags_fn_t)ndr_push_opendb_file);
247 if (!NDR_ERR_CODE_IS_SUCCESS(ndr_err)) {
248 return ndr_map_error2ntstatus(ndr_err);
251 dbuf.dptr = blob.data;
252 dbuf.dsize = blob.length;
254 ret = ctdb_record_store(lck->rec, dbuf);
255 talloc_free(lck->rec);
256 data_blob_free(&blob);
258 return NT_STATUS_INTERNAL_DB_CORRUPTION;
266 send an oplock break to a client
268 static NTSTATUS odb_oplock_break_send(struct odb_context *odb, struct opendb_entry *e)
270 /* tell the server handling this open file about the need to send the client
272 return messaging_send_ptr(odb->ntvfs_ctx->msg_ctx, e->server,
273 MSG_NTVFS_OPLOCK_BREAK, e->file_handle);
278 register an open file in the open files database. This implements the share_access
281 Note that the path is only used by the delete on close logic, not
282 for comparing with other filenames
284 static NTSTATUS odb_ctdb_open_file(struct odb_lock *lck,
285 void *file_handle, const char *path,
286 int *fd, bool allow_level_II_oplock,
287 uint32_t oplock_level, uint32_t *oplock_granted)
291 * as this file will went away and isn't used yet,
292 * copy the implementation from the tdb backend
295 return NT_STATUS_FOOBAR;
300 register a pending open file in the open files database
302 static NTSTATUS odb_ctdb_open_file_pending(struct odb_lock *lck, void *private)
304 struct odb_context *odb = lck->odb;
305 struct opendb_file file;
308 status = odb_pull_record(lck, &file);
309 NT_STATUS_NOT_OK_RETURN(status);
311 file.pending = talloc_realloc(lck, file.pending, struct opendb_pending,
313 NT_STATUS_HAVE_NO_MEMORY(file.pending);
315 file.pending[file.num_pending].server = odb->ntvfs_ctx->server_id;
316 file.pending[file.num_pending].notify_ptr = private;
320 return odb_push_record(lck, &file);
325 remove a opendb entry
327 static NTSTATUS odb_ctdb_close_file(struct odb_lock *lck, void *file_handle,
328 const char **_delete_path)
330 struct odb_context *odb = lck->odb;
331 struct opendb_file file;
332 const char *delete_path = NULL;
336 status = odb_pull_record(lck, &file);
337 NT_STATUS_NOT_OK_RETURN(status);
339 /* find the entry, and delete it */
340 for (i=0;i<file.num_entries;i++) {
341 if (file_handle == file.entries[i].file_handle &&
342 cluster_id_equal(&odb->ntvfs_ctx->server_id, &file.entries[i].server)) {
343 if (file.entries[i].delete_on_close) {
344 file.delete_on_close = true;
346 if (i < file.num_entries-1) {
347 memmove(file.entries+i, file.entries+i+1,
348 (file.num_entries - (i+1)) *
349 sizeof(struct opendb_entry));
355 if (i == file.num_entries) {
356 return NT_STATUS_UNSUCCESSFUL;
359 /* send any pending notifications, removing them once sent */
360 for (i=0;i<file.num_pending;i++) {
361 messaging_send_ptr(odb->ntvfs_ctx->msg_ctx, file.pending[i].server,
363 file.pending[i].notify_ptr);
365 file.num_pending = 0;
369 if (file.num_entries == 0 && file.delete_on_close) {
370 delete_path = talloc_strdup(lck, file.path);
371 NT_STATUS_HAVE_NO_MEMORY(delete_path);
375 *_delete_path = delete_path;
378 return odb_push_record(lck, &file);
382 update the oplock level of the client
384 static NTSTATUS odb_ctdb_update_oplock(struct odb_lock *lck, void *file_handle,
385 uint32_t oplock_level)
388 * as this file will went away and isn't used yet,
389 * copy the implementation from the tdb backend
392 return NT_STATUS_FOOBAR;
395 static NTSTATUS odb_ctdb_break_oplocks(struct odb_lock *lck)
398 * as this file will went away and isn't used yet,
399 * copy the implementation from the tdb backend
402 return NT_STATUS_FOOBAR;
406 remove a pending opendb entry
408 static NTSTATUS odb_ctdb_remove_pending(struct odb_lock *lck, void *private)
410 struct odb_context *odb = lck->odb;
413 struct opendb_file file;
415 status = odb_pull_record(lck, &file);
416 NT_STATUS_NOT_OK_RETURN(status);
418 /* find the entry, and delete it */
419 for (i=0;i<file.num_pending;i++) {
420 if (private == file.pending[i].notify_ptr &&
421 cluster_id_equal(&odb->ntvfs_ctx->server_id, &file.pending[i].server)) {
422 if (i < file.num_pending-1) {
423 memmove(file.pending+i, file.pending+i+1,
424 (file.num_pending - (i+1)) *
425 sizeof(struct opendb_pending));
431 if (i == file.num_pending) {
432 return NT_STATUS_UNSUCCESSFUL;
437 return odb_push_record(lck, &file);
442 rename the path in a open file
444 static NTSTATUS odb_ctdb_rename(struct odb_lock *lck, const char *path)
446 struct opendb_file file;
449 status = odb_pull_record(lck, &file);
450 if (NT_STATUS_EQUAL(NT_STATUS_OBJECT_NAME_NOT_FOUND, status)) {
451 /* not having the record at all is OK */
454 NT_STATUS_NOT_OK_RETURN(status);
457 return odb_push_record(lck, &file);
461 get the path of an open file
463 static NTSTATUS odb_ctdb_get_path(struct odb_lock *lck, const char **path)
465 struct opendb_file file;
470 status = odb_pull_record(lck, &file);
471 /* we don't ignore NT_STATUS_OBJECT_NAME_NOT_FOUND here */
472 NT_STATUS_NOT_OK_RETURN(status);
480 update delete on close flag on an open file
482 static NTSTATUS odb_ctdb_set_delete_on_close(struct odb_lock *lck, bool del_on_close)
485 struct opendb_file file;
487 status = odb_pull_record(lck, &file);
488 NT_STATUS_NOT_OK_RETURN(status);
490 file.delete_on_close = del_on_close;
492 return odb_push_record(lck, &file);
496 return the current value of the delete_on_close bit, and how many
497 people still have the file open
499 static NTSTATUS odb_ctdb_get_delete_on_close(struct odb_context *odb,
500 DATA_BLOB *key, bool *del_on_close)
503 struct opendb_file file;
504 struct odb_lock *lck;
506 (*del_on_close) = false;
508 lck = odb_lock(odb, odb, key);
509 NT_STATUS_HAVE_NO_MEMORY(lck);
511 status = odb_pull_record(lck, &file);
512 if (NT_STATUS_EQUAL(NT_STATUS_OBJECT_NAME_NOT_FOUND, status)) {
516 if (!NT_STATUS_IS_OK(status)) {
521 (*del_on_close) = file.delete_on_close;
530 determine if a file can be opened with the given share_access,
531 create_options and access_mask
533 static NTSTATUS odb_ctdb_can_open(struct odb_lock *lck,
534 uint32_t stream_id, uint32_t share_access,
535 uint32_t access_mask, bool delete_on_close,
536 uint32_t open_disposition, bool break_to_none)
538 struct odb_context *odb = lck->odb;
540 struct opendb_file file;
541 struct opendb_entry e;
544 status = odb_pull_record(lck, &file);
545 if (NT_STATUS_EQUAL(status, NT_STATUS_OBJECT_NAME_NOT_FOUND)) {
548 NT_STATUS_NOT_OK_RETURN(status);
550 if (delete_on_close &&
551 file.num_entries != 0) {
552 return NT_STATUS_SHARING_VIOLATION;
555 if (file.delete_on_close) {
556 return NT_STATUS_DELETE_PENDING;
559 e.server = odb->ntvfs_ctx->server_id;
560 e.file_handle = NULL;
562 e.share_access = share_access;
563 e.access_mask = access_mask;
565 for (i=0;i<file.num_entries;i++) {
566 status = share_conflict(&file.entries[i], &e);
567 if (!NT_STATUS_IS_OK(status)) {
568 /* note that we discard the error code
569 here. We do this as unless we are actually
570 doing an open (which comes via a different
571 function), we need to return a sharing
573 return NT_STATUS_SHARING_VIOLATION;
581 static const struct opendb_ops opendb_ctdb_ops = {
582 .odb_init = odb_ctdb_init,
583 .odb_lock = odb_ctdb_lock,
584 .odb_get_key = odb_ctdb_get_key,
585 .odb_open_file = odb_ctdb_open_file,
586 .odb_open_file_pending = odb_ctdb_open_file_pending,
587 .odb_close_file = odb_ctdb_close_file,
588 .odb_remove_pending = odb_ctdb_remove_pending,
589 .odb_rename = odb_ctdb_rename,
590 .odb_get_path = odb_ctdb_get_path,
591 .odb_set_delete_on_close = odb_ctdb_set_delete_on_close,
592 .odb_get_delete_on_close = odb_ctdb_get_delete_on_close,
593 .odb_can_open = odb_ctdb_can_open,
594 .odb_update_oplock = odb_ctdb_update_oplock,
595 .odb_break_oplocks = odb_ctdb_break_oplocks
599 void odb_ctdb_init_ops(void)
601 odb_set_ops(&opendb_ctdb_ops);