source/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 "lib/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 = lp_parm_bool(ntvfs_ctx->lp_ctx, NULL, "opendb", "oplocks", false);
 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, bool allow_level_II_oplock,
 287                                    uint32_t oplock_level, uint32_t *oplock_granted)
 288
 289 {
 290         /*
 291          * as this file will went away and isn't used yet,
 292          * copy the implementation from the tdb backend
 293          * --metze
 294          */
 295         return NT_STATUS_FOOBAR;
 296 }
 297
 298
 299 /*
 300   register a pending open file in the open files database
 301 */
 302 static NTSTATUS odb_ctdb_open_file_pending(struct odb_lock *lck, void *private)
 303 {
 304         struct odb_context *odb = lck->odb;
 305         struct opendb_file file;
 306         NTSTATUS status;
 307
 308         status = odb_pull_record(lck, &file);
 309         NT_STATUS_NOT_OK_RETURN(status);
 310
 311         file.pending = talloc_realloc(lck, file.pending, struct opendb_pending,
 312                                       file.num_pending+1);
 313         NT_STATUS_HAVE_NO_MEMORY(file.pending);
 314
 315         file.pending[file.num_pending].server = odb->ntvfs_ctx->server_id;
 316         file.pending[file.num_pending].notify_ptr = private;
 317
 318         file.num_pending++;
 319
 320         return odb_push_record(lck, &file);
 321 }
 322
 323
 324 /*
 325   remove a opendb entry
 326 */
 327 static NTSTATUS odb_ctdb_close_file(struct odb_lock *lck, void *file_handle,
 328                                     const char **_delete_path)
 329 {
 330         struct odb_context *odb = lck->odb;
 331         struct opendb_file file;
 332         const char *delete_path = NULL;
 333         int i;
 334         NTSTATUS status;
 335
 336         status = odb_pull_record(lck, &file);
 337         NT_STATUS_NOT_OK_RETURN(status);
 338
 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;
 345                         }
 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));
 350                         }
 351                         break;
 352                 }
 353         }
 354
 355         if (i == file.num_entries) {
 356                 return NT_STATUS_UNSUCCESSFUL;
 357         }
 358
 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,
 362                                    MSG_PVFS_RETRY_OPEN,
 363                                    file.pending[i].notify_ptr);
 364         }
 365         file.num_pending = 0;
 366
 367         file.num_entries--;
 368
 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);
 372         }
 373
 374         if (_delete_path) {
 375                 *_delete_path = delete_path;
 376         }
 377
 378         return odb_push_record(lck, &file);
 379 }
 380
 381 /*
 382   update the oplock level of the client
 383 */
 384 static NTSTATUS odb_ctdb_update_oplock(struct odb_lock *lck, void *file_handle,
 385                                        uint32_t oplock_level)
 386 {
 387         /*
 388          * as this file will went away and isn't used yet,
 389          * copy the implementation from the tdb backend
 390          * --metze
 391          */
 392         return NT_STATUS_FOOBAR;
 393 }
 394
 395 static NTSTATUS odb_ctdb_break_oplocks(struct odb_lock *lck)
 396 {
 397         /*
 398          * as this file will went away and isn't used yet,
 399          * copy the implementation from the tdb backend
 400          * --metze
 401          */
 402         return NT_STATUS_FOOBAR;
 403 }
 404
 405 /*
 406   remove a pending opendb entry
 407 */
 408 static NTSTATUS odb_ctdb_remove_pending(struct odb_lock *lck, void *private)
 409 {
 410         struct odb_context *odb = lck->odb;
 411         int i;
 412         NTSTATUS status;
 413         struct opendb_file file;
 414
 415         status = odb_pull_record(lck, &file);
 416         NT_STATUS_NOT_OK_RETURN(status);
 417
 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));
 426                         }
 427                         break;
 428                 }
 429         }
 430
 431         if (i == file.num_pending) {
 432                 return NT_STATUS_UNSUCCESSFUL;
 433         }
 434
 435         file.num_pending--;
 436
 437         return odb_push_record(lck, &file);
 438 }
 439
 440
 441 /*
 442   rename the path in a open file
 443 */
 444 static NTSTATUS odb_ctdb_rename(struct odb_lock *lck, const char *path)
 445 {
 446         struct opendb_file file;
 447         NTSTATUS status;
 448
 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 */
 452                 return NT_STATUS_OK;
 453         }
 454         NT_STATUS_NOT_OK_RETURN(status);
 455
 456         file.path = path;
 457         return odb_push_record(lck, &file);
 458 }
 459
 460 /*
 461   get the path of an open file
 462 */
 463 static NTSTATUS odb_ctdb_get_path(struct odb_lock *lck, const char **path)
 464 {
 465         struct opendb_file file;
 466         NTSTATUS status;
 467
 468         *path = NULL;
 469
 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);
 473
 474         *path = file.path;
 475
 476         return NT_STATUS_OK;
 477 }
 478
 479 /*
 480   update delete on close flag on an open file
 481 */
 482 static NTSTATUS odb_ctdb_set_delete_on_close(struct odb_lock *lck, bool del_on_close)
 483 {
 484         NTSTATUS status;
 485         struct opendb_file file;
 486
 487         status = odb_pull_record(lck, &file);
 488         NT_STATUS_NOT_OK_RETURN(status);
 489
 490         file.delete_on_close = del_on_close;
 491
 492         return odb_push_record(lck, &file);
 493 }
 494
 495 /*
 496   return the current value of the delete_on_close bit, and how many
 497   people still have the file open
 498 */
 499 static NTSTATUS odb_ctdb_get_delete_on_close(struct odb_context *odb,
 500                                             DATA_BLOB *key, bool *del_on_close)
 501 {
 502         NTSTATUS status;
 503         struct opendb_file file;
 504         struct odb_lock *lck;
 505
 506         (*del_on_close) = false;
 507
 508         lck = odb_lock(odb, odb, key);
 509         NT_STATUS_HAVE_NO_MEMORY(lck);
 510
 511         status = odb_pull_record(lck, &file);
 512         if (NT_STATUS_EQUAL(NT_STATUS_OBJECT_NAME_NOT_FOUND, status)) {
 513                 talloc_free(lck);
 514                 return NT_STATUS_OK;
 515         }
 516         if (!NT_STATUS_IS_OK(status)) {
 517                 talloc_free(lck);
 518                 return status;
 519         }
 520
 521         (*del_on_close) = file.delete_on_close;
 522
 523         talloc_free(lck);
 524
 525         return NT_STATUS_OK;
 526 }
 527
 528
 529 /*
 530   determine if a file can be opened with the given share_access,
 531   create_options and access_mask
 532 */
 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)
 537 {
 538         struct odb_context *odb = lck->odb;
 539         NTSTATUS status;
 540         struct opendb_file file;
 541         struct opendb_entry e;
 542         int i;
 543
 544         status = odb_pull_record(lck, &file);
 545         if (NT_STATUS_EQUAL(status, NT_STATUS_OBJECT_NAME_NOT_FOUND)) {
 546                 return NT_STATUS_OK;
 547         }
 548         NT_STATUS_NOT_OK_RETURN(status);
 549
 550         if (delete_on_close &&
 551             file.num_entries != 0) {
 552                 return NT_STATUS_SHARING_VIOLATION;
 553         }
 554
 555         if (file.delete_on_close) {
 556                 return NT_STATUS_DELETE_PENDING;
 557         }
 558
 559         e.server       = odb->ntvfs_ctx->server_id;
 560         e.file_handle  = NULL;
 561         e.stream_id    = 0;
 562         e.share_access = share_access;
 563         e.access_mask  = access_mask;
 564
 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
 572                            violation */
 573                         return NT_STATUS_SHARING_VIOLATION;
 574                 }
 575         }
 576
 577         return NT_STATUS_OK;
 578 }
 579
 580
 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
 596 };
 597
 598
 599 void odb_ctdb_init_ops(void)
 600 {
 601         odb_set_ops(&opendb_ctdb_ops);
 602 }