source4/ntvfs/common/opendb.c

   1 /*
   2    Unix SMB/CIFS implementation.
   3
   4    Copyright (C) Andrew Tridgell 2004
   5
   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 2 of the License, or
   9    (at your option) any later version.
  10
  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.
  15
  16    You should have received a copy of the GNU General Public License
  17    along with this program; if not, write to the Free Software
  18    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  19 */
  20
  21 /*
  22   this is the open files database. It implements shared storage of
  23   what files are open between server instances, and implements the rules
  24   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 "db_wrap.h"
  46 #include "lib/messaging/irpc.h"
  47 #include "librpc/gen_ndr/ndr_opendb.h"
  48 #include "ntvfs/ntvfs.h"
  49
  50 struct odb_context {
  51         struct tdb_wrap *w;
  52         struct ntvfs_context *ntvfs_ctx;
  53         BOOL oplocks;
  54 };
  55
  56 /*
  57   an odb lock handle. You must obtain one of these using odb_lock() before doing
  58   any other operations.
  59 */
  60 struct odb_lock {
  61         struct odb_context *odb;
  62         TDB_DATA key;
  63 };
  64
  65 /*
  66   Open up the openfiles.tdb database. Close it down using
  67   talloc_free(). We need the messaging_ctx to allow for pending open
  68   notifications.
  69 */
  70 _PUBLIC_ struct odb_context *odb_init(TALLOC_CTX *mem_ctx,
  71                                       struct ntvfs_context *ntvfs_ctx)
  72 {
  73         char *path;
  74         struct odb_context *odb;
  75
  76         odb = talloc(mem_ctx, struct odb_context);
  77         if (odb == NULL) {
  78                 return NULL;
  79         }
  80
  81         path = smbd_tmp_path(odb, "openfiles.tdb");
  82         odb->w = tdb_wrap_open(odb, path, 0,
  83                                TDB_DEFAULT,
  84                                O_RDWR|O_CREAT, 0600);
  85         talloc_free(path);
  86         if (odb->w == NULL) {
  87                 talloc_free(odb);
  88                 return NULL;
  89         }
  90
  91         odb->ntvfs_ctx = ntvfs_ctx;
  92
  93         /* leave oplocks disabled by default until the code is working */
  94         odb->oplocks = lp_parm_bool(-1, "opendb", "oplocks", False);
  95
  96         return odb;
  97 }
  98
  99 /*
 100   destroy a lock on the database
 101 */
 102 static int odb_lock_destructor(struct odb_lock *lck)
 103 {
 104         tdb_chainunlock(lck->odb->w->tdb, lck->key);
 105         return 0;
 106 }
 107
 108 /*
 109   get a lock on a entry in the odb. This call returns a lock handle,
 110   which the caller should unlock using talloc_free().
 111 */
 112 _PUBLIC_ struct odb_lock *odb_lock(TALLOC_CTX *mem_ctx,
 113                                    struct odb_context *odb, DATA_BLOB *file_key)
 114 {
 115         struct odb_lock *lck;
 116
 117         lck = talloc(mem_ctx, struct odb_lock);
 118         if (lck == NULL) {
 119                 return NULL;
 120         }
 121
 122         lck->odb = talloc_reference(lck, odb);
 123         lck->key.dptr = talloc_memdup(lck, file_key->data, file_key->length);
 124         lck->key.dsize = file_key->length;
 125         if (lck->key.dptr == NULL) {
 126                 talloc_free(lck);
 127                 return NULL;
 128         }
 129
 130         if (tdb_chainlock(odb->w->tdb, lck->key) != 0) {
 131                 talloc_free(lck);
 132                 return NULL;
 133         }
 134
 135         talloc_set_destructor(lck, odb_lock_destructor);
 136
 137         return lck;
 138 }
 139
 140 /*
 141   determine if two odb_entry structures conflict
 142
 143   return NT_STATUS_OK on no conflict
 144 */
 145 static NTSTATUS share_conflict(struct opendb_entry *e1, struct opendb_entry *e2)
 146 {
 147         /* if either open involves no read.write or delete access then
 148            it can't conflict */
 149         if (!(e1->access_mask & (SEC_FILE_WRITE_DATA |
 150                                  SEC_FILE_APPEND_DATA |
 151                                  SEC_FILE_READ_DATA |
 152                                  SEC_FILE_EXECUTE |
 153                                  SEC_STD_DELETE))) {
 154                 return NT_STATUS_OK;
 155         }
 156         if (!(e2->access_mask & (SEC_FILE_WRITE_DATA |
 157                                  SEC_FILE_APPEND_DATA |
 158                                  SEC_FILE_READ_DATA |
 159                                  SEC_FILE_EXECUTE |
 160                                  SEC_STD_DELETE))) {
 161                 return NT_STATUS_OK;
 162         }
 163
 164         /* data IO access masks. This is skipped if the two open handles
 165            are on different streams (as in that case the masks don't
 166            interact) */
 167         if (e1->stream_id != e2->stream_id) {
 168                 return NT_STATUS_OK;
 169         }
 170
 171 #define CHECK_MASK(am, right, sa, share) \
 172         if (((am) & (right)) && !((sa) & (share))) return NT_STATUS_SHARING_VIOLATION
 173
 174         CHECK_MASK(e1->access_mask, SEC_FILE_WRITE_DATA | SEC_FILE_APPEND_DATA,
 175                    e2->share_access, NTCREATEX_SHARE_ACCESS_WRITE);
 176         CHECK_MASK(e2->access_mask, SEC_FILE_WRITE_DATA | SEC_FILE_APPEND_DATA,
 177                    e1->share_access, NTCREATEX_SHARE_ACCESS_WRITE);
 178
 179         CHECK_MASK(e1->access_mask, SEC_FILE_READ_DATA | SEC_FILE_EXECUTE,
 180                    e2->share_access, NTCREATEX_SHARE_ACCESS_READ);
 181         CHECK_MASK(e2->access_mask, SEC_FILE_READ_DATA | SEC_FILE_EXECUTE,
 182                    e1->share_access, NTCREATEX_SHARE_ACCESS_READ);
 183
 184         CHECK_MASK(e1->access_mask, SEC_STD_DELETE,
 185                    e2->share_access, NTCREATEX_SHARE_ACCESS_DELETE);
 186         CHECK_MASK(e2->access_mask, SEC_STD_DELETE,
 187                    e1->share_access, NTCREATEX_SHARE_ACCESS_DELETE);
 188
 189         return NT_STATUS_OK;
 190 }
 191
 192 /*
 193   pull a record, translating from the db format to the opendb_file structure defined
 194   in opendb.idl
 195 */
 196 static NTSTATUS odb_pull_record(struct odb_lock *lck, struct opendb_file *file)
 197 {
 198         struct odb_context *odb = lck->odb;
 199         TDB_DATA dbuf;
 200         DATA_BLOB blob;
 201         NTSTATUS status;
 202
 203         dbuf = tdb_fetch(odb->w->tdb, lck->key);
 204         if (dbuf.dptr == NULL) {
 205                 return NT_STATUS_OBJECT_NAME_NOT_FOUND;
 206         }
 207
 208         blob.data = dbuf.dptr;
 209         blob.length = dbuf.dsize;
 210
 211         status = ndr_pull_struct_blob(&blob, lck, file, (ndr_pull_flags_fn_t)ndr_pull_opendb_file);
 212
 213         free(dbuf.dptr);
 214
 215         return status;
 216 }
 217
 218 /*
 219   push a record, translating from the opendb_file structure defined in opendb.idl
 220 */
 221 static NTSTATUS odb_push_record(struct odb_lock *lck, struct opendb_file *file)
 222 {
 223         struct odb_context *odb = lck->odb;
 224         TDB_DATA dbuf;
 225         DATA_BLOB blob;
 226         NTSTATUS status;
 227         int ret;
 228
 229         if (file->num_entries == 0) {
 230                 ret = tdb_delete(odb->w->tdb, lck->key);
 231                 if (ret != 0) {
 232                         return NT_STATUS_INTERNAL_DB_CORRUPTION;
 233                 }
 234                 return NT_STATUS_OK;
 235         }
 236
 237         status = ndr_push_struct_blob(&blob, lck, file, (ndr_push_flags_fn_t)ndr_push_opendb_file);
 238         NT_STATUS_NOT_OK_RETURN(status);
 239
 240         dbuf.dptr = blob.data;
 241         dbuf.dsize = blob.length;
 242
 243         ret = tdb_store(odb->w->tdb, lck->key, dbuf, TDB_REPLACE);
 244         data_blob_free(&blob);
 245         if (ret != 0) {
 246                 return NT_STATUS_INTERNAL_DB_CORRUPTION;
 247         }
 248
 249         return NT_STATUS_OK;
 250 }
 251
 252 /*
 253   send an oplock break to a client
 254 */
 255 static NTSTATUS odb_oplock_break_send(struct odb_context *odb, struct opendb_entry *e)
 256 {
 257         /* tell the server handling this open file about the need to send the client
 258            a break */
 259         return messaging_send_ptr(odb->ntvfs_ctx->msg_ctx, e->server,
 260                                   MSG_NTVFS_OPLOCK_BREAK, e->file_handle);
 261 }
 262
 263 /*
 264   register an open file in the open files database. This implements the share_access
 265   rules
 266
 267   Note that the path is only used by the delete on close logic, not
 268   for comparing with other filenames
 269 */
 270 _PUBLIC_ NTSTATUS odb_open_file(struct odb_lock *lck, void *file_handle,
 271                                 uint32_t stream_id, uint32_t share_access,
 272                                 uint32_t access_mask, BOOL delete_on_close,
 273                                 const char *path,
 274                                 uint32_t oplock_level, uint32_t *oplock_granted)
 275 {
 276         struct odb_context *odb = lck->odb;
 277         struct opendb_entry e;
 278         int i;
 279         struct opendb_file file;
 280         NTSTATUS status;
 281
 282         if (odb->oplocks == False) {
 283                 oplock_level = OPLOCK_NONE;
 284         }
 285
 286         status = odb_pull_record(lck, &file);
 287         if (NT_STATUS_EQUAL(status, NT_STATUS_OBJECT_NAME_NOT_FOUND)) {
 288                 /* initialise a blank structure */
 289                 ZERO_STRUCT(file);
 290                 file.path = path;
 291         } else {
 292                 NT_STATUS_NOT_OK_RETURN(status);
 293         }
 294
 295         /* see if it conflicts */
 296         e.server          = odb->ntvfs_ctx->server_id;
 297         e.file_handle     = file_handle;
 298         e.stream_id       = stream_id;
 299         e.share_access    = share_access;
 300         e.access_mask     = access_mask;
 301         e.delete_on_close = delete_on_close;
 302         e.oplock_level    = OPLOCK_NONE;
 303
 304         /* see if anyone has an oplock, which we need to break */
 305         for (i=0;i<file.num_entries;i++) {
 306                 if (file.entries[i].oplock_level == OPLOCK_BATCH) {
 307                         /* a batch oplock caches close calls, which
 308                            means the client application might have
 309                            already closed the file. We have to allow
 310                            this close to propogate by sending a oplock
 311                            break request and suspending this call
 312                            until the break is acknowledged or the file
 313                            is closed */
 314                         odb_oplock_break_send(odb, &file.entries[i]);
 315                         return NT_STATUS_OPLOCK_NOT_GRANTED;
 316                 }
 317         }
 318
 319         if (file.delete_on_close ||
 320             (file.num_entries != 0 && delete_on_close)) {
 321                 /* while delete on close is set, no new opens are allowed */
 322                 return NT_STATUS_DELETE_PENDING;
 323         }
 324
 325         /* check for sharing violations */
 326         for (i=0;i<file.num_entries;i++) {
 327                 status = share_conflict(&file.entries[i], &e);
 328                 NT_STATUS_NOT_OK_RETURN(status);
 329         }
 330
 331         /* we now know the open could succeed, but we need to check
 332            for any exclusive oplocks. We can't grant a second open
 333            till these are broken. Note that we check for batch oplocks
 334            before checking for sharing violations, and check for
 335            exclusive oplocks afterwards. */
 336         for (i=0;i<file.num_entries;i++) {
 337                 if (file.entries[i].oplock_level == OPLOCK_EXCLUSIVE) {
 338                         odb_oplock_break_send(odb, &file.entries[i]);
 339                         return NT_STATUS_OPLOCK_NOT_GRANTED;
 340                 }
 341         }
 342
 343         /*
 344           possibly grant an exclusive or batch oplock if this is the only client
 345           with the file open. We don't yet grant levelII oplocks.
 346         */
 347         if (oplock_granted != NULL) {
 348                 if ((oplock_level == OPLOCK_BATCH ||
 349                      oplock_level == OPLOCK_EXCLUSIVE) &&
 350                     file.num_entries == 0) {
 351                         (*oplock_granted) = oplock_level;
 352                 } else {
 353                         (*oplock_granted) = OPLOCK_NONE;
 354                 }
 355                 e.oplock_level = (*oplock_granted);
 356         }
 357
 358         /* it doesn't conflict, so add it to the end */
 359         file.entries = talloc_realloc(lck, file.entries, struct opendb_entry,
 360                                       file.num_entries+1);
 361         NT_STATUS_HAVE_NO_MEMORY(file.entries);
 362
 363         file.entries[file.num_entries] = e;
 364         file.num_entries++;
 365
 366         return odb_push_record(lck, &file);
 367 }
 368
 369
 370 /*
 371   register a pending open file in the open files database
 372 */
 373 _PUBLIC_ NTSTATUS odb_open_file_pending(struct odb_lock *lck, void *private)
 374 {
 375         struct odb_context *odb = lck->odb;
 376         struct opendb_file file;
 377         NTSTATUS status;
 378
 379         status = odb_pull_record(lck, &file);
 380         NT_STATUS_NOT_OK_RETURN(status);
 381
 382         file.pending = talloc_realloc(lck, file.pending, struct opendb_pending,
 383                                       file.num_pending+1);
 384         NT_STATUS_HAVE_NO_MEMORY(file.pending);
 385
 386         file.pending[file.num_pending].server = odb->ntvfs_ctx->server_id;
 387         file.pending[file.num_pending].notify_ptr = private;
 388
 389         file.num_pending++;
 390
 391         return odb_push_record(lck, &file);
 392 }
 393
 394
 395 /*
 396   remove a opendb entry
 397 */
 398 _PUBLIC_ NTSTATUS odb_close_file(struct odb_lock *lck, void *file_handle)
 399 {
 400         struct odb_context *odb = lck->odb;
 401         struct opendb_file file;
 402         int i;
 403         NTSTATUS status;
 404
 405         status = odb_pull_record(lck, &file);
 406         NT_STATUS_NOT_OK_RETURN(status);
 407
 408         /* find the entry, and delete it */
 409         for (i=0;i<file.num_entries;i++) {
 410                 if (file_handle == file.entries[i].file_handle &&
 411                     cluster_id_equal(&odb->ntvfs_ctx->server_id, &file.entries[i].server)) {
 412                         if (file.entries[i].delete_on_close) {
 413                                 file.delete_on_close = True;
 414                         }
 415                         if (i < file.num_entries-1) {
 416                                 memmove(file.entries+i, file.entries+i+1,
 417                                         (file.num_entries - (i+1)) *
 418                                         sizeof(struct opendb_entry));
 419                         }
 420                         break;
 421                 }
 422         }
 423
 424         if (i == file.num_entries) {
 425                 return NT_STATUS_UNSUCCESSFUL;
 426         }
 427
 428         /* send any pending notifications, removing them once sent */
 429         for (i=0;i<file.num_pending;i++) {
 430                 messaging_send_ptr(odb->ntvfs_ctx->msg_ctx, file.pending[i].server,
 431                                    MSG_PVFS_RETRY_OPEN,
 432                                    file.pending[i].notify_ptr);
 433         }
 434         file.num_pending = 0;
 435
 436         file.num_entries--;
 437
 438         return odb_push_record(lck, &file);
 439 }
 440
 441
 442 /*
 443   remove a pending opendb entry
 444 */
 445 _PUBLIC_ NTSTATUS odb_remove_pending(struct odb_lock *lck, void *private)
 446 {
 447         struct odb_context *odb = lck->odb;
 448         int i;
 449         NTSTATUS status;
 450         struct opendb_file file;
 451
 452         status = odb_pull_record(lck, &file);
 453         NT_STATUS_NOT_OK_RETURN(status);
 454
 455         /* find the entry, and delete it */
 456         for (i=0;i<file.num_pending;i++) {
 457                 if (private == file.pending[i].notify_ptr &&
 458                     cluster_id_equal(&odb->ntvfs_ctx->server_id, &file.pending[i].server)) {
 459                         if (i < file.num_pending-1) {
 460                                 memmove(file.pending+i, file.pending+i+1,
 461                                         (file.num_pending - (i+1)) *
 462                                         sizeof(struct opendb_pending));
 463                         }
 464                         break;
 465                 }
 466         }
 467
 468         if (i == file.num_pending) {
 469                 return NT_STATUS_UNSUCCESSFUL;
 470         }
 471
 472         file.num_pending--;
 473
 474         return odb_push_record(lck, &file);
 475 }
 476
 477
 478 /*
 479   rename the path in a open file
 480 */
 481 _PUBLIC_ NTSTATUS odb_rename(struct odb_lock *lck, const char *path)
 482 {
 483         struct opendb_file file;
 484         NTSTATUS status;
 485
 486         status = odb_pull_record(lck, &file);
 487         if (NT_STATUS_EQUAL(NT_STATUS_OBJECT_NAME_NOT_FOUND, status)) {
 488                 /* not having the record at all is OK */
 489                 return NT_STATUS_OK;
 490         }
 491         NT_STATUS_NOT_OK_RETURN(status);
 492
 493         file.path = path;
 494         return odb_push_record(lck, &file);
 495 }
 496
 497 /*
 498   update delete on close flag on an open file
 499 */
 500 _PUBLIC_ NTSTATUS odb_set_delete_on_close(struct odb_lock *lck, BOOL del_on_close)
 501 {
 502         NTSTATUS status;
 503         struct opendb_file file;
 504
 505         status = odb_pull_record(lck, &file);
 506         NT_STATUS_NOT_OK_RETURN(status);
 507
 508         file.delete_on_close = del_on_close;
 509
 510         return odb_push_record(lck, &file);
 511 }
 512
 513 /*
 514   return the current value of the delete_on_close bit, and how many
 515   people still have the file open
 516 */
 517 _PUBLIC_ NTSTATUS odb_get_delete_on_close(struct odb_context *odb,
 518                                           DATA_BLOB *key, BOOL *del_on_close,
 519                                           int *open_count, char **path)
 520 {
 521         NTSTATUS status;
 522         struct opendb_file file;
 523         struct odb_lock *lck;
 524
 525         lck = odb_lock(odb, odb, key);
 526         NT_STATUS_HAVE_NO_MEMORY(lck);
 527
 528         status = odb_pull_record(lck, &file);
 529         if (NT_STATUS_EQUAL(NT_STATUS_OBJECT_NAME_NOT_FOUND, status)) {
 530                 talloc_free(lck);
 531                 (*del_on_close) = False;
 532                 return NT_STATUS_OK;
 533         }
 534         if (!NT_STATUS_IS_OK(status)) {
 535                 talloc_free(lck);
 536                 return status;
 537         }
 538
 539         (*del_on_close) = file.delete_on_close;
 540         if (open_count != NULL) {
 541                 (*open_count) = file.num_entries;
 542         }
 543         if (path != NULL) {
 544                 *path = talloc_strdup(odb, file.path);
 545                 NT_STATUS_HAVE_NO_MEMORY(*path);
 546                 if (file.num_entries == 1 && file.entries[0].delete_on_close) {
 547                         (*del_on_close) = True;
 548                 }
 549         }
 550
 551         talloc_free(lck);
 552
 553         return NT_STATUS_OK;
 554 }
 555
 556
 557 /*
 558   determine if a file can be opened with the given share_access,
 559   create_options and access_mask
 560 */
 561 _PUBLIC_ NTSTATUS odb_can_open(struct odb_lock *lck,
 562                                uint32_t share_access, uint32_t create_options,
 563                                uint32_t access_mask)
 564 {
 565         struct odb_context *odb = lck->odb;
 566         NTSTATUS status;
 567         struct opendb_file file;
 568         struct opendb_entry e;
 569         int i;
 570
 571         status = odb_pull_record(lck, &file);
 572         if (NT_STATUS_EQUAL(status, NT_STATUS_OBJECT_NAME_NOT_FOUND)) {
 573                 return NT_STATUS_OK;
 574         }
 575         NT_STATUS_NOT_OK_RETURN(status);
 576
 577         if ((create_options & NTCREATEX_OPTIONS_DELETE_ON_CLOSE) &&
 578             file.num_entries != 0) {
 579                 return NT_STATUS_SHARING_VIOLATION;
 580         }
 581
 582         if (file.delete_on_close) {
 583                 return NT_STATUS_DELETE_PENDING;
 584         }
 585
 586         e.server       = odb->ntvfs_ctx->server_id;
 587         e.file_handle  = NULL;
 588         e.stream_id    = 0;
 589         e.share_access = share_access;
 590         e.access_mask  = access_mask;
 591
 592         for (i=0;i<file.num_entries;i++) {
 593                 status = share_conflict(&file.entries[i], &e);
 594                 if (!NT_STATUS_IS_OK(status)) {
 595                         /* note that we discard the error code
 596                            here. We do this as unless we are actually
 597                            doing an open (which comes via a different
 598                            function), we need to return a sharing
 599                            violation */
 600                         return NT_STATUS_SHARING_VIOLATION;
 601                 }
 602         }
 603
 604         return NT_STATUS_OK;
 605 }