/* Unix SMB/CIFS implementation. Copyright (C) Ronnie Sahlberg 2007 Copyright (C) Andrew Tridgell 2007 This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>. */ /* this is the open files database, ctdb backend. It implements shared storage of what files are open between server instances, and implements the rules of shared access to files. The caller needs to provide a file_key, which specifies what file they are talking about. This needs to be a unique key across all filesystems, and is usually implemented in terms of a device/inode pair. Before any operations can be performed the caller needs to establish a lock on the record associated with file_key. That is done by calling odb_lock(). The caller releases this lock by calling talloc_free() on the returned handle. All other operations on a record are done by passing the odb_lock() handle back to this module. The handle contains internal information about what file_key is being operated on. */ #include "includes.h" #include "system/filesys.h" #include "../tdb/include/tdb.h" #include "messaging/messaging.h" #include "tdb_wrap.h" #include "lib/messaging/irpc.h" #include "librpc/gen_ndr/ndr_opendb.h" #include "ntvfs/ntvfs.h" #include "ntvfs/common/ntvfs_common.h" #include "cluster/cluster.h" #include "include/ctdb.h" #include "param/param.h" struct odb_context { struct ctdb_context *ctdb; struct ctdb_db_context *ctdb_db; struct ntvfs_context *ntvfs_ctx; bool oplocks; }; /* an odb lock handle. You must obtain one of these using odb_lock() before doing any other operations. */ struct odb_lock { struct odb_context *odb; struct ctdb_record_handle *rec; TDB_DATA key; TDB_DATA data; }; /* Open up the openfiles.tdb database. Close it down using talloc_free(). We need the messaging_ctx to allow for pending open notifications. */ static struct odb_context *odb_ctdb_init(TALLOC_CTX *mem_ctx, struct ntvfs_context *ntvfs_ctx) { struct odb_context *odb; struct ctdb_context *ctdb = talloc_get_type(cluster_backend_handle(), struct ctdb_context); odb = talloc(mem_ctx, struct odb_context); if (odb == NULL) { return NULL; } odb->ctdb = ctdb; odb->ctdb_db = ctdb_attach(ctdb, "opendb"); if (!odb->ctdb_db) { DEBUG(0,("Failed to get attached ctdb db handle for opendb\n")); talloc_free(odb); return NULL; } odb->ntvfs_ctx = ntvfs_ctx; /* leave oplocks disabled by default until the code is working */ odb->oplocks = share_bool_option(ntvfs_ctx->config, SHARE_OPLOCKS, SHARE_OPLOCKS_DEFAULT); return odb; } /* get a lock on a entry in the odb. This call returns a lock handle, which the caller should unlock using talloc_free(). */ static struct odb_lock *odb_ctdb_lock(TALLOC_CTX *mem_ctx, struct odb_context *odb, DATA_BLOB *file_key) { struct odb_lock *lck; lck = talloc(mem_ctx, struct odb_lock); if (lck == NULL) { return NULL; } lck->odb = talloc_reference(lck, odb); lck->key.dptr = talloc_memdup(lck, file_key->data, file_key->length); lck->key.dsize = file_key->length; if (lck->key.dptr == NULL) { talloc_free(lck); return NULL; } lck->rec = ctdb_fetch_lock(odb->ctdb_db, (TALLOC_CTX *)lck, lck->key, &lck->data); if (!lck->rec) { talloc_free(lck); return NULL; } return lck; } static DATA_BLOB odb_ctdb_get_key(TALLOC_CTX *mem_ctx, struct odb_lock *lck) { /* * as this file will went away and isn't used yet, * copy the implementation from the tdb backend * --metze */ return data_blob_const(NULL, 0); } /* determine if two odb_entry structures conflict return NT_STATUS_OK on no conflict */ static NTSTATUS share_conflict(struct opendb_entry *e1, struct opendb_entry *e2) { /* if either open involves no read.write or delete access then it can't conflict */ if (!(e1->access_mask & (SEC_FILE_WRITE_DATA | SEC_FILE_APPEND_DATA | SEC_FILE_READ_DATA | SEC_FILE_EXECUTE | SEC_STD_DELETE))) { return NT_STATUS_OK; } if (!(e2->access_mask & (SEC_FILE_WRITE_DATA | SEC_FILE_APPEND_DATA | SEC_FILE_READ_DATA | SEC_FILE_EXECUTE | SEC_STD_DELETE))) { return NT_STATUS_OK; } /* data IO access masks. This is skipped if the two open handles are on different streams (as in that case the masks don't interact) */ if (e1->stream_id != e2->stream_id) { return NT_STATUS_OK; } #define CHECK_MASK(am, right, sa, share) \ if (((am) & (right)) && !((sa) & (share))) return NT_STATUS_SHARING_VIOLATION CHECK_MASK(e1->access_mask, SEC_FILE_WRITE_DATA | SEC_FILE_APPEND_DATA, e2->share_access, NTCREATEX_SHARE_ACCESS_WRITE); CHECK_MASK(e2->access_mask, SEC_FILE_WRITE_DATA | SEC_FILE_APPEND_DATA, e1->share_access, NTCREATEX_SHARE_ACCESS_WRITE); CHECK_MASK(e1->access_mask, SEC_FILE_READ_DATA | SEC_FILE_EXECUTE, e2->share_access, NTCREATEX_SHARE_ACCESS_READ); CHECK_MASK(e2->access_mask, SEC_FILE_READ_DATA | SEC_FILE_EXECUTE, e1->share_access, NTCREATEX_SHARE_ACCESS_READ); CHECK_MASK(e1->access_mask, SEC_STD_DELETE, e2->share_access, NTCREATEX_SHARE_ACCESS_DELETE); CHECK_MASK(e2->access_mask, SEC_STD_DELETE, e1->share_access, NTCREATEX_SHARE_ACCESS_DELETE); return NT_STATUS_OK; } /* pull a record, translating from the db format to the opendb_file structure defined in opendb.idl */ static NTSTATUS odb_pull_record(struct odb_lock *lck, struct opendb_file *file) { TDB_DATA dbuf; DATA_BLOB blob; enum ndr_err_code ndr_err; dbuf = lck->data; if (dbuf.dsize == 0) { /* empty record in ctdb means the record isn't there */ return NT_STATUS_OBJECT_NAME_NOT_FOUND; } blob.data = dbuf.dptr; blob.length = dbuf.dsize; 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); if (!NDR_ERR_CODE_IS_SUCCESS(ndr_err)) { return ndr_map_error2ntstatus(ndr_err); } return NT_STATUS_OK; } /* push a record, translating from the opendb_file structure defined in opendb.idl */ static NTSTATUS odb_push_record(struct odb_lock *lck, struct opendb_file *file) { TDB_DATA dbuf; DATA_BLOB blob; enum ndr_err_code ndr_err; int ret; if (!file->num_entries) { dbuf.dptr = NULL; dbuf.dsize = 0; ctdb_record_store(lck->rec, dbuf); talloc_free(lck->rec); return NT_STATUS_OK; } ndr_err = ndr_push_struct_blob(&blob, lck, lp_iconv_convenience(lck->odb->ntvfs_ctx->lp_ctx), file, (ndr_push_flags_fn_t)ndr_push_opendb_file); if (!NDR_ERR_CODE_IS_SUCCESS(ndr_err)) { return ndr_map_error2ntstatus(ndr_err); } dbuf.dptr = blob.data; dbuf.dsize = blob.length; ret = ctdb_record_store(lck->rec, dbuf); talloc_free(lck->rec); data_blob_free(&blob); if (ret != 0) { return NT_STATUS_INTERNAL_DB_CORRUPTION; } return NT_STATUS_OK; } #if 0 /* send an oplock break to a client */ static NTSTATUS odb_oplock_break_send(struct odb_context *odb, struct opendb_entry *e) { /* tell the server handling this open file about the need to send the client a break */ return messaging_send_ptr(odb->ntvfs_ctx->msg_ctx, e->server, MSG_NTVFS_OPLOCK_BREAK, e->file_handle); } #endif /* register an open file in the open files database. This implements the share_access rules Note that the path is only used by the delete on close logic, not for comparing with other filenames */ static NTSTATUS odb_ctdb_open_file(struct odb_lock *lck, void *file_handle, const char *path, int *fd, NTTIME open_write_time, bool allow_level_II_oplock, uint32_t oplock_level, uint32_t *oplock_granted) { /* * as this file will went away and isn't used yet, * copy the implementation from the tdb backend * --metze */ return NT_STATUS_FOOBAR; } /* register a pending open file in the open files database */ static NTSTATUS odb_ctdb_open_file_pending(struct odb_lock *lck, void *private) { struct odb_context *odb = lck->odb; struct opendb_file file; NTSTATUS status; status = odb_pull_record(lck, &file); NT_STATUS_NOT_OK_RETURN(status); file.pending = talloc_realloc(lck, file.pending, struct opendb_pending, file.num_pending+1); NT_STATUS_HAVE_NO_MEMORY(file.pending); file.pending[file.num_pending].server = odb->ntvfs_ctx->server_id; file.pending[file.num_pending].notify_ptr = private; file.num_pending++; return odb_push_record(lck, &file); } /* remove a opendb entry */ static NTSTATUS odb_ctdb_close_file(struct odb_lock *lck, void *file_handle, const char **_delete_path) { struct odb_context *odb = lck->odb; struct opendb_file file; const char *delete_path = NULL; int i; NTSTATUS status; status = odb_pull_record(lck, &file); NT_STATUS_NOT_OK_RETURN(status); /* find the entry, and delete it */ for (i=0;i<file.num_entries;i++) { if (file_handle == file.entries[i].file_handle && cluster_id_equal(&odb->ntvfs_ctx->server_id, &file.entries[i].server)) { if (file.entries[i].delete_on_close) { file.delete_on_close = true; } if (i < file.num_entries-1) { memmove(file.entries+i, file.entries+i+1, (file.num_entries - (i+1)) * sizeof(struct opendb_entry)); } break; } } if (i == file.num_entries) { return NT_STATUS_UNSUCCESSFUL; } /* send any pending notifications, removing them once sent */ for (i=0;i<file.num_pending;i++) { messaging_send_ptr(odb->ntvfs_ctx->msg_ctx, file.pending[i].server, MSG_PVFS_RETRY_OPEN, file.pending[i].notify_ptr); } file.num_pending = 0; file.num_entries--; if (file.num_entries == 0 && file.delete_on_close) { delete_path = talloc_strdup(lck, file.path); NT_STATUS_HAVE_NO_MEMORY(delete_path); } if (_delete_path) { *_delete_path = delete_path; } return odb_push_record(lck, &file); } /* update the oplock level of the client */ static NTSTATUS odb_ctdb_update_oplock(struct odb_lock *lck, void *file_handle, uint32_t oplock_level) { /* * as this file will went away and isn't used yet, * copy the implementation from the tdb backend * --metze */ return NT_STATUS_FOOBAR; } static NTSTATUS odb_ctdb_break_oplocks(struct odb_lock *lck) { /* * as this file will went away and isn't used yet, * copy the implementation from the tdb backend * --metze */ return NT_STATUS_FOOBAR; } /* remove a pending opendb entry */ static NTSTATUS odb_ctdb_remove_pending(struct odb_lock *lck, void *private) { struct odb_context *odb = lck->odb; int i; NTSTATUS status; struct opendb_file file; status = odb_pull_record(lck, &file); NT_STATUS_NOT_OK_RETURN(status); /* find the entry, and delete it */ for (i=0;i<file.num_pending;i++) { if (private == file.pending[i].notify_ptr && cluster_id_equal(&odb->ntvfs_ctx->server_id, &file.pending[i].server)) { if (i < file.num_pending-1) { memmove(file.pending+i, file.pending+i+1, (file.num_pending - (i+1)) * sizeof(struct opendb_pending)); } break; } } if (i == file.num_pending) { return NT_STATUS_UNSUCCESSFUL; } file.num_pending--; return odb_push_record(lck, &file); } /* rename the path in a open file */ static NTSTATUS odb_ctdb_rename(struct odb_lock *lck, const char *path) { struct opendb_file file; NTSTATUS status; status = odb_pull_record(lck, &file); if (NT_STATUS_EQUAL(NT_STATUS_OBJECT_NAME_NOT_FOUND, status)) { /* not having the record at all is OK */ return NT_STATUS_OK; } NT_STATUS_NOT_OK_RETURN(status); file.path = path; return odb_push_record(lck, &file); } /* get the path of an open file */ static NTSTATUS odb_ctdb_get_path(struct odb_lock *lck, const char **path) { struct opendb_file file; NTSTATUS status; *path = NULL; status = odb_pull_record(lck, &file); /* we don't ignore NT_STATUS_OBJECT_NAME_NOT_FOUND here */ NT_STATUS_NOT_OK_RETURN(status); *path = file.path; return NT_STATUS_OK; } /* update delete on close flag on an open file */ static NTSTATUS odb_ctdb_set_delete_on_close(struct odb_lock *lck, bool del_on_close) { NTSTATUS status; struct opendb_file file; status = odb_pull_record(lck, &file); NT_STATUS_NOT_OK_RETURN(status); file.delete_on_close = del_on_close; return odb_push_record(lck, &file); } static NTSTATUS odb_ctdb_set_write_time(struct odb_lock *lck, NTTIME write_time, bool force) { /* * as this file will went away and isn't used yet, * copy the implementation from the tdb backend * --metze */ return NT_STATUS_FOOBAR; } /* return the current value of the delete_on_close bit, and how many people still have the file open */ static NTSTATUS odb_ctdb_get_file_infos(struct odb_context *odb, DATA_BLOB *key, bool *del_on_close, NTTIME *write_time) { /* * as this file will went away and isn't used yet, * copy the implementation from the tdb backend * --metze */ return NT_STATUS_FOOBAR; } /* determine if a file can be opened with the given share_access, create_options and access_mask */ static NTSTATUS odb_ctdb_can_open(struct odb_lock *lck, uint32_t stream_id, uint32_t share_access, uint32_t access_mask, bool delete_on_close, uint32_t open_disposition, bool break_to_none) { struct odb_context *odb = lck->odb; NTSTATUS status; struct opendb_file file; struct opendb_entry e; int i; status = odb_pull_record(lck, &file); if (NT_STATUS_EQUAL(status, NT_STATUS_OBJECT_NAME_NOT_FOUND)) { return NT_STATUS_OK; } NT_STATUS_NOT_OK_RETURN(status); if (delete_on_close && file.num_entries != 0) { return NT_STATUS_SHARING_VIOLATION; } if (file.delete_on_close) { return NT_STATUS_DELETE_PENDING; } e.server = odb->ntvfs_ctx->server_id; e.file_handle = NULL; e.stream_id = 0; e.share_access = share_access; e.access_mask = access_mask; for (i=0;i<file.num_entries;i++) { status = share_conflict(&file.entries[i], &e); if (!NT_STATUS_IS_OK(status)) { /* note that we discard the error code here. We do this as unless we are actually doing an open (which comes via a different function), we need to return a sharing violation */ return NT_STATUS_SHARING_VIOLATION; } } return NT_STATUS_OK; } static const struct opendb_ops opendb_ctdb_ops = { .odb_init = odb_ctdb_init, .odb_lock = odb_ctdb_lock, .odb_get_key = odb_ctdb_get_key, .odb_open_file = odb_ctdb_open_file, .odb_open_file_pending = odb_ctdb_open_file_pending, .odb_close_file = odb_ctdb_close_file, .odb_remove_pending = odb_ctdb_remove_pending, .odb_rename = odb_ctdb_rename, .odb_get_path = odb_ctdb_get_path, .odb_set_delete_on_close = odb_ctdb_set_delete_on_close, .odb_set_write_time = odb_ctdb_set_write_time, .odb_get_file_infos = odb_ctdb_get_file_infos, .odb_can_open = odb_ctdb_can_open, .odb_update_oplock = odb_ctdb_update_oplock, .odb_break_oplocks = odb_ctdb_break_oplocks }; void odb_ctdb_init_ops(void) { odb_set_ops(&opendb_ctdb_ops); }