source4/cluster/ctdb/opendb_ctdb.c

   1 /*
   2    Unix SMB/CIFS implementation.
   3
   4    Copyright (C) Ronnie Sahlberg 2007
   5    Copyright (C) Andrew Tridgell 2007
   6
   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.
  11
  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.
  16
  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/>.
  19 */
  20
  21 /*
  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.
  25
  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
  29   pair.
  30
  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.
  35
  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.
  39 */
  40
  41 #include "includes.h"
  42 #include "system/filesys.h"
  43 #include "../tdb/include/tdb.h"
  44 #include "messaging/messaging.h"
  45 #include "tdb_wrap.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"
  53
  54 struct odb_context {
  55         struct ctdb_context *ctdb;
  56         struct ctdb_db_context *ctdb_db;
  57         struct ntvfs_context *ntvfs_ctx;
  58         bool oplocks;
  59 };
  60
  61 /*
  62   an odb lock handle. You must obtain one of these using odb_lock() before doing
  63   any other operations.
  64 */
  65 struct odb_lock {
  66         struct odb_context *odb;
  67         struct ctdb_record_handle *rec;
  68         TDB_DATA key;
  69         TDB_DATA data;
  70 };
  71
  72 /*
  73   Open up the openfiles.tdb database. Close it down using
  74   talloc_free(). We need the messaging_ctx to allow for pending open
  75   notifications.
  76 */
  77 static struct odb_context *odb_ctdb_init(TALLOC_CTX *mem_ctx,
  78                                         struct ntvfs_context *ntvfs_ctx)
  79 {
  80         struct odb_context *odb;
  81         struct ctdb_context *ctdb = talloc_get_type(cluster_backend_handle(),
  82                                                     struct ctdb_context);
  83
  84         odb = talloc(mem_ctx, struct odb_context);
  85         if (odb == NULL) {
  86                 return NULL;
  87         }
  88
  89         odb->ctdb = ctdb;
  90         odb->ctdb_db = ctdb_attach(ctdb, "opendb");
  91         if (!odb->ctdb_db) {
  92                 DEBUG(0,("Failed to get attached ctdb db handle for opendb\n"));
  93                 talloc_free(odb);
  94                 return NULL;
  95         }
  96
  97         odb->ntvfs_ctx = ntvfs_ctx;
  98
  99         /* leave oplocks disabled by default until the code is working */
 100         odb->oplocks = share_bool_option(ntvfs_ctx->config, SHARE_OPLOCKS, SHARE_OPLOCKS_DEFAULT);
 101
 102         return odb;
 103 }
 104
 105 /*
 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().
 108 */
 109 static struct odb_lock *odb_ctdb_lock(TALLOC_CTX *mem_ctx,
 110                                      struct odb_context *odb, DATA_BLOB *file_key)
 111 {
 112         struct odb_lock *lck;
 113
 114         lck = talloc(mem_ctx, struct odb_lock);
 115         if (lck == NULL) {
 116                 return NULL;
 117         }
 118
 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) {
 123                 talloc_free(lck);
 124                 return NULL;
 125         }
 126
 127         lck->rec = ctdb_fetch_lock(odb->ctdb_db, (TALLOC_CTX *)lck, lck->key, &lck->data);
 128         if (!lck->rec) {
 129                 talloc_free(lck);
 130                 return NULL;
 131         }
 132
 133         return lck;
 134 }
 135
 136 static DATA_BLOB odb_ctdb_get_key(TALLOC_CTX *mem_ctx, struct odb_lock *lck)
 137 {
 138         /*
 139          * as this file will went away and isn't used yet,
 140          * copy the implementation from the tdb backend
 141          * --metze
 142          */
 143         return data_blob_const(NULL, 0);
 144 }
 145
 146 /*
 147   determine if two odb_entry structures conflict
 148
 149   return NT_STATUS_OK on no conflict
 150 */
 151 static NTSTATUS share_conflict(struct opendb_entry *e1, struct opendb_entry *e2)
 152 {
 153         /* if either open involves no read.write or delete access then
 154            it can't conflict */
 155         if (!(e1->access_mask & (SEC_FILE_WRITE_DATA |
 156                                  SEC_FILE_APPEND_DATA |
 157                                  SEC_FILE_READ_DATA |
 158                                  SEC_FILE_EXECUTE |
 159                                  SEC_STD_DELETE))) {
 160                 return NT_STATUS_OK;
 161         }
 162         if (!(e2->access_mask & (SEC_FILE_WRITE_DATA |
 163                                  SEC_FILE_APPEND_DATA |
 164                                  SEC_FILE_READ_DATA |
 165                                  SEC_FILE_EXECUTE |
 166                                  SEC_STD_DELETE))) {
 167                 return NT_STATUS_OK;
 168         }
 169
 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
 172            interact) */
 173         if (e1->stream_id != e2->stream_id) {
 174                 return NT_STATUS_OK;
 175         }
 176
 177 #define CHECK_MASK(am, right, sa, share) \
 178         if (((am) & (right)) && !((sa) & (share))) return NT_STATUS_SHARING_VIOLATION
 179
 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);
 184
 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);
 189
 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);
 194
 195         return NT_STATUS_OK;
 196 }
 197
 198 /*
 199   pull a record, translating from the db format to the opendb_file structure defined
 200   in opendb.idl
 201 */
 202 static NTSTATUS odb_pull_record(struct odb_lock *lck, struct opendb_file *file)
 203 {
 204         TDB_DATA dbuf;
 205         DATA_BLOB blob;
 206         enum ndr_err_code ndr_err;
 207
 208         dbuf = lck->data;
 209
 210         if (dbuf.dsize == 0) {
 211                 /* empty record in ctdb means the record isn't there */
 212                 return NT_STATUS_OBJECT_NAME_NOT_FOUND;
 213         }
 214
 215         blob.data = dbuf.dptr;
 216         blob.length = dbuf.dsize;
 217
 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);
 221         }
 222
 223         return NT_STATUS_OK;
 224 }
 225
 226 /*
 227   push a record, translating from the opendb_file structure defined in opendb.idl
 228 */
 229 static NTSTATUS odb_push_record(struct odb_lock *lck, struct opendb_file *file)
 230 {
 231         TDB_DATA dbuf;
 232         DATA_BLOB blob;
 233         enum ndr_err_code ndr_err;
 234         int ret;
 235
 236         if (!file->num_entries) {
 237                 dbuf.dptr  = NULL;
 238                 dbuf.dsize = 0;
 239                 ctdb_record_store(lck->rec, dbuf);
 240                 talloc_free(lck->rec);
 241                 return NT_STATUS_OK;
 242         }
 243
 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);
 249         }
 250
 251         dbuf.dptr = blob.data;
 252         dbuf.dsize = blob.length;
 253
 254         ret = ctdb_record_store(lck->rec, dbuf);
 255         talloc_free(lck->rec);
 256         data_blob_free(&blob);
 257         if (ret != 0) {
 258                 return NT_STATUS_INTERNAL_DB_CORRUPTION;
 259         }
 260
 261         return NT_STATUS_OK;
 262 }
 263
 264 #if 0
 265 /*
 266   send an oplock break to a client
 267 */
 268 static NTSTATUS odb_oplock_break_send(struct odb_context *odb, struct opendb_entry *e)
 269 {
 270         /* tell the server handling this open file about the need to send the client
 271            a break */
 272         return messaging_send_ptr(odb->ntvfs_ctx->msg_ctx, e->server,
 273                                   MSG_NTVFS_OPLOCK_BREAK, e->file_handle);
 274 }
 275 #endif
 276
 277 /*
 278   register an open file in the open files database. This implements the share_access
 279   rules
 280
 281   Note that the path is only used by the delete on close logic, not
 282   for comparing with other filenames
 283 */
 284 static NTSTATUS odb_ctdb_open_file(struct odb_lock *lck,
 285                                    void *file_handle, const char *path,
 286                                    int *fd, NTTIME open_write_time,
 287                                    bool allow_level_II_oplock,
 288                                    uint32_t oplock_level, uint32_t *oplock_granted)
 289
 290 {
 291         /*
 292          * as this file will went away and isn't used yet,
 293          * copy the implementation from the tdb backend
 294          * --metze
 295          */
 296         return NT_STATUS_FOOBAR;
 297 }
 298
 299
 300 /*
 301   register a pending open file in the open files database
 302 */
 303 static NTSTATUS odb_ctdb_open_file_pending(struct odb_lock *lck, void *private)
 304 {
 305         struct odb_context *odb = lck->odb;
 306         struct opendb_file file;
 307         NTSTATUS status;
 308
 309         status = odb_pull_record(lck, &file);
 310         NT_STATUS_NOT_OK_RETURN(status);
 311
 312         file.pending = talloc_realloc(lck, file.pending, struct opendb_pending,
 313                                       file.num_pending+1);
 314         NT_STATUS_HAVE_NO_MEMORY(file.pending);
 315
 316         file.pending[file.num_pending].server = odb->ntvfs_ctx->server_id;
 317         file.pending[file.num_pending].notify_ptr = private;
 318
 319         file.num_pending++;
 320
 321         return odb_push_record(lck, &file);
 322 }
 323
 324
 325 /*
 326   remove a opendb entry
 327 */
 328 static NTSTATUS odb_ctdb_close_file(struct odb_lock *lck, void *file_handle,
 329                                     const char **_delete_path)
 330 {
 331         struct odb_context *odb = lck->odb;
 332         struct opendb_file file;
 333         const char *delete_path = NULL;
 334         int i;
 335         NTSTATUS status;
 336
 337         status = odb_pull_record(lck, &file);
 338         NT_STATUS_NOT_OK_RETURN(status);
 339
 340         /* find the entry, and delete it */
 341         for (i=0;i<file.num_entries;i++) {
 342                 if (file_handle == file.entries[i].file_handle &&
 343                     cluster_id_equal(&odb->ntvfs_ctx->server_id, &file.entries[i].server)) {
 344                         if (file.entries[i].delete_on_close) {
 345                                 file.delete_on_close = true;
 346                         }
 347                         if (i < file.num_entries-1) {
 348                                 memmove(file.entries+i, file.entries+i+1,
 349                                         (file.num_entries - (i+1)) *
 350                                         sizeof(struct opendb_entry));
 351                         }
 352                         break;
 353                 }
 354         }
 355
 356         if (i == file.num_entries) {
 357                 return NT_STATUS_UNSUCCESSFUL;
 358         }
 359
 360         /* send any pending notifications, removing them once sent */
 361         for (i=0;i<file.num_pending;i++) {
 362                 messaging_send_ptr(odb->ntvfs_ctx->msg_ctx, file.pending[i].server,
 363                                    MSG_PVFS_RETRY_OPEN,
 364                                    file.pending[i].notify_ptr);
 365         }
 366         file.num_pending = 0;
 367
 368         file.num_entries--;
 369
 370         if (file.num_entries == 0 && file.delete_on_close) {
 371                 delete_path = talloc_strdup(lck, file.path);
 372                 NT_STATUS_HAVE_NO_MEMORY(delete_path);
 373         }
 374
 375         if (_delete_path) {
 376                 *_delete_path = delete_path;
 377         }
 378
 379         return odb_push_record(lck, &file);
 380 }
 381
 382 /*
 383   update the oplock level of the client
 384 */
 385 static NTSTATUS odb_ctdb_update_oplock(struct odb_lock *lck, void *file_handle,
 386                                        uint32_t oplock_level)
 387 {
 388         /*
 389          * as this file will went away and isn't used yet,
 390          * copy the implementation from the tdb backend
 391          * --metze
 392          */
 393         return NT_STATUS_FOOBAR;
 394 }
 395
 396 static NTSTATUS odb_ctdb_break_oplocks(struct odb_lock *lck)
 397 {
 398         /*
 399          * as this file will went away and isn't used yet,
 400          * copy the implementation from the tdb backend
 401          * --metze
 402          */
 403         return NT_STATUS_FOOBAR;
 404 }
 405
 406 /*
 407   remove a pending opendb entry
 408 */
 409 static NTSTATUS odb_ctdb_remove_pending(struct odb_lock *lck, void *private)
 410 {
 411         struct odb_context *odb = lck->odb;
 412         int i;
 413         NTSTATUS status;
 414         struct opendb_file file;
 415
 416         status = odb_pull_record(lck, &file);
 417         NT_STATUS_NOT_OK_RETURN(status);
 418
 419         /* find the entry, and delete it */
 420         for (i=0;i<file.num_pending;i++) {
 421                 if (private == file.pending[i].notify_ptr &&
 422                     cluster_id_equal(&odb->ntvfs_ctx->server_id, &file.pending[i].server)) {
 423                         if (i < file.num_pending-1) {
 424                                 memmove(file.pending+i, file.pending+i+1,
 425                                         (file.num_pending - (i+1)) *
 426                                         sizeof(struct opendb_pending));
 427                         }
 428                         break;
 429                 }
 430         }
 431
 432         if (i == file.num_pending) {
 433                 return NT_STATUS_UNSUCCESSFUL;
 434         }
 435
 436         file.num_pending--;
 437
 438         return odb_push_record(lck, &file);
 439 }
 440
 441
 442 /*
 443   rename the path in a open file
 444 */
 445 static NTSTATUS odb_ctdb_rename(struct odb_lock *lck, const char *path)
 446 {
 447         struct opendb_file file;
 448         NTSTATUS status;
 449
 450         status = odb_pull_record(lck, &file);
 451         if (NT_STATUS_EQUAL(NT_STATUS_OBJECT_NAME_NOT_FOUND, status)) {
 452                 /* not having the record at all is OK */
 453                 return NT_STATUS_OK;
 454         }
 455         NT_STATUS_NOT_OK_RETURN(status);
 456
 457         file.path = path;
 458         return odb_push_record(lck, &file);
 459 }
 460
 461 /*
 462   get the path of an open file
 463 */
 464 static NTSTATUS odb_ctdb_get_path(struct odb_lock *lck, const char **path)
 465 {
 466         struct opendb_file file;
 467         NTSTATUS status;
 468
 469         *path = NULL;
 470
 471         status = odb_pull_record(lck, &file);
 472         /* we don't ignore NT_STATUS_OBJECT_NAME_NOT_FOUND here */
 473         NT_STATUS_NOT_OK_RETURN(status);
 474
 475         *path = file.path;
 476
 477         return NT_STATUS_OK;
 478 }
 479
 480 /*
 481   update delete on close flag on an open file
 482 */
 483 static NTSTATUS odb_ctdb_set_delete_on_close(struct odb_lock *lck, bool del_on_close)
 484 {
 485         NTSTATUS status;
 486         struct opendb_file file;
 487
 488         status = odb_pull_record(lck, &file);
 489         NT_STATUS_NOT_OK_RETURN(status);
 490
 491         file.delete_on_close = del_on_close;
 492
 493         return odb_push_record(lck, &file);
 494 }
 495
 496 static NTSTATUS odb_ctdb_set_write_time(struct odb_lock *lck,
 497                                         NTTIME write_time, bool force)
 498 {
 499         /*
 500          * as this file will went away and isn't used yet,
 501          * copy the implementation from the tdb backend
 502          * --metze
 503          */
 504         return NT_STATUS_FOOBAR;
 505 }
 506
 507 /*
 508   return the current value of the delete_on_close bit, and how many
 509   people still have the file open
 510 */
 511 static NTSTATUS odb_ctdb_get_file_infos(struct odb_context *odb, DATA_BLOB *key,
 512                                         bool *del_on_close, NTTIME *write_time)
 513 {
 514         /*
 515          * as this file will went away and isn't used yet,
 516          * copy the implementation from the tdb backend
 517          * --metze
 518          */
 519         return NT_STATUS_FOOBAR;
 520 }
 521
 522
 523 /*
 524   determine if a file can be opened with the given share_access,
 525   create_options and access_mask
 526 */
 527 static NTSTATUS odb_ctdb_can_open(struct odb_lock *lck,
 528                                   uint32_t stream_id, uint32_t share_access,
 529                                   uint32_t access_mask, bool delete_on_close,
 530                                   uint32_t open_disposition, bool break_to_none)
 531 {
 532         struct odb_context *odb = lck->odb;
 533         NTSTATUS status;
 534         struct opendb_file file;
 535         struct opendb_entry e;
 536         int i;
 537
 538         status = odb_pull_record(lck, &file);
 539         if (NT_STATUS_EQUAL(status, NT_STATUS_OBJECT_NAME_NOT_FOUND)) {
 540                 return NT_STATUS_OK;
 541         }
 542         NT_STATUS_NOT_OK_RETURN(status);
 543
 544         if (delete_on_close &&
 545             file.num_entries != 0) {
 546                 return NT_STATUS_SHARING_VIOLATION;
 547         }
 548
 549         if (file.delete_on_close) {
 550                 return NT_STATUS_DELETE_PENDING;
 551         }
 552
 553         e.server       = odb->ntvfs_ctx->server_id;
 554         e.file_handle  = NULL;
 555         e.stream_id    = 0;
 556         e.share_access = share_access;
 557         e.access_mask  = access_mask;
 558
 559         for (i=0;i<file.num_entries;i++) {
 560                 status = share_conflict(&file.entries[i], &e);
 561                 if (!NT_STATUS_IS_OK(status)) {
 562                         /* note that we discard the error code
 563                            here. We do this as unless we are actually
 564                            doing an open (which comes via a different
 565                            function), we need to return a sharing
 566                            violation */
 567                         return NT_STATUS_SHARING_VIOLATION;
 568                 }
 569         }
 570
 571         return NT_STATUS_OK;
 572 }
 573
 574
 575 static const struct opendb_ops opendb_ctdb_ops = {
 576         .odb_init                = odb_ctdb_init,
 577         .odb_lock                = odb_ctdb_lock,
 578         .odb_get_key             = odb_ctdb_get_key,
 579         .odb_open_file           = odb_ctdb_open_file,
 580         .odb_open_file_pending   = odb_ctdb_open_file_pending,
 581         .odb_close_file          = odb_ctdb_close_file,
 582         .odb_remove_pending      = odb_ctdb_remove_pending,
 583         .odb_rename              = odb_ctdb_rename,
 584         .odb_get_path            = odb_ctdb_get_path,
 585         .odb_set_delete_on_close = odb_ctdb_set_delete_on_close,
 586         .odb_set_write_time      = odb_ctdb_set_write_time,
 587         .odb_get_file_infos      = odb_ctdb_get_file_infos,
 588         .odb_can_open            = odb_ctdb_can_open,
 589         .odb_update_oplock       = odb_ctdb_update_oplock,
 590         .odb_break_oplocks       = odb_ctdb_break_oplocks
 591 };
 592
 593
 594 void odb_ctdb_init_ops(void)
 595 {
 596         odb_set_ops(&opendb_ctdb_ops);
 597 }