source3/locking/share_mode_lock.c

   1 /*
   2    Unix SMB/CIFS implementation.
   3    Locking functions
   4    Copyright (C) Andrew Tridgell 1992-2000
   5    Copyright (C) Jeremy Allison 1992-2006
   6    Copyright (C) Volker Lendecke 2005
   7
   8    This program is free software; you can redistribute it and/or modify
   9    it under the terms of the GNU General Public License as published by
  10    the Free Software Foundation; either version 3 of the License, or
  11    (at your option) any later version.
  12
  13    This program is distributed in the hope that it will be useful,
  14    but WITHOUT ANY WARRANTY; without even the implied warranty of
  15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16    GNU General Public License for more details.
  17
  18    You should have received a copy of the GNU General Public License
  19    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  20
  21    Revision History:
  22
  23    12 aug 96: Erik.Devriendt@te6.siemens.be
  24    added support for shared memory implementation of share mode locking
  25
  26    May 1997. Jeremy Allison (jallison@whistle.com). Modified share mode
  27    locking to deal with multiple share modes per open file.
  28
  29    September 1997. Jeremy Allison (jallison@whistle.com). Added oplock
  30    support.
  31
  32    rewritten completely to use new tdb code. Tridge, Dec '99
  33
  34    Added POSIX locking support. Jeremy Allison (jeremy@valinux.com), Apr. 2000.
  35    Added Unix Extensions POSIX locking support. Jeremy Allison Mar 2006.
  36 */
  37
  38 #include "includes.h"
  39 #include "system/filesys.h"
  40 #include "locking/proto.h"
  41 #include "smbd/globals.h"
  42 #include "dbwrap/dbwrap.h"
  43 #include "dbwrap/dbwrap_open.h"
  44 #include "../libcli/security/security.h"
  45 #include "serverid.h"
  46 #include "messages.h"
  47 #include "util_tdb.h"
  48 #include "../librpc/gen_ndr/ndr_open_files.h"
  49
  50 #undef DBGC_CLASS
  51 #define DBGC_CLASS DBGC_LOCKING
  52
  53 #define NO_LOCKING_COUNT (-1)
  54
  55 /* the locking database handle */
  56 static struct db_context *lock_db;
  57
  58 static bool locking_init_internal(bool read_only)
  59 {
  60         brl_init(read_only);
  61
  62         if (lock_db)
  63                 return True;
  64
  65         lock_db = db_open(NULL, lock_path("locking.tdb"),
  66                           lp_open_files_db_hash_size(),
  67                           TDB_DEFAULT|TDB_VOLATILE|TDB_CLEAR_IF_FIRST|TDB_INCOMPATIBLE_HASH,
  68                           read_only?O_RDONLY:O_RDWR|O_CREAT, 0644,
  69                           DBWRAP_LOCK_ORDER_1);
  70
  71         if (!lock_db) {
  72                 DEBUG(0,("ERROR: Failed to initialise locking database\n"));
  73                 return False;
  74         }
  75
  76         if (!posix_locking_init(read_only))
  77                 return False;
  78
  79         return True;
  80 }
  81
  82 bool locking_init(void)
  83 {
  84         return locking_init_internal(false);
  85 }
  86
  87 bool locking_init_readonly(void)
  88 {
  89         return locking_init_internal(true);
  90 }
  91
  92 /*******************************************************************
  93  Deinitialize the share_mode management.
  94 ******************************************************************/
  95
  96 bool locking_end(void)
  97 {
  98         brl_shutdown();
  99         TALLOC_FREE(lock_db);
 100         return true;
 101 }
 102
 103 /*******************************************************************
 104  Form a static locking key for a dev/inode pair.
 105 ******************************************************************/
 106
 107 static TDB_DATA locking_key(const struct file_id *id, struct file_id *tmp)
 108 {
 109         *tmp = *id;
 110         return make_tdb_data((const uint8_t *)tmp, sizeof(*tmp));
 111 }
 112
 113 /*******************************************************************
 114  Get all share mode entries for a dev/inode pair.
 115 ********************************************************************/
 116
 117 static struct share_mode_data *parse_share_modes(TALLOC_CTX *mem_ctx,
 118                                                  const TDB_DATA dbuf)
 119 {
 120         struct share_mode_data *d;
 121         int i;
 122         struct server_id *pids;
 123         bool *pid_exists;
 124         enum ndr_err_code ndr_err;
 125         DATA_BLOB blob;
 126
 127         d = talloc_zero(mem_ctx, struct share_mode_data);
 128         if (d == NULL) {
 129                 DEBUG(0, ("talloc failed\n"));
 130                 goto fail;
 131         }
 132
 133         blob.data = dbuf.dptr;
 134         blob.length = dbuf.dsize;
 135
 136         ndr_err = ndr_pull_struct_blob(
 137                 &blob, d, d, (ndr_pull_flags_fn_t)ndr_pull_share_mode_data);
 138         if (!NDR_ERR_CODE_IS_SUCCESS(ndr_err)) {
 139                 DEBUG(1, ("ndr_pull_share_mode_lock failed\n"));
 140                 goto fail;
 141         }
 142
 143         d->modified = false;
 144         d->fresh = false;
 145
 146         if (DEBUGLEVEL >= 10) {
 147                 DEBUG(10, ("parse_share_modes:\n"));
 148                 NDR_PRINT_DEBUG(share_mode_data, d);
 149         }
 150
 151         /*
 152          * Ensure that each entry has a real process attached.
 153          */
 154
 155         pids = talloc_array(talloc_tos(), struct server_id,
 156                             d->num_share_modes);
 157         if (pids == NULL) {
 158                 DEBUG(0, ("talloc failed\n"));
 159                 goto fail;
 160         }
 161         pid_exists = talloc_array(talloc_tos(), bool, d->num_share_modes);
 162         if (pid_exists == NULL) {
 163                 DEBUG(0, ("talloc failed\n"));
 164                 goto fail;
 165         }
 166
 167         for (i=0; i<d->num_share_modes; i++) {
 168                 pids[i] = d->share_modes[i].pid;
 169         }
 170         if (!serverids_exist(pids, d->num_share_modes, pid_exists)) {
 171                 DEBUG(0, ("serverid_exists failed\n"));
 172                 goto fail;
 173         }
 174
 175         i = 0;
 176         while (i < d->num_share_modes) {
 177                 struct share_mode_entry *e = &d->share_modes[i];
 178                 if (!pid_exists[i]) {
 179                         *e = d->share_modes[d->num_share_modes-1];
 180                         d->num_share_modes -= 1;
 181                         d->modified = True;
 182                         continue;
 183                 }
 184                 i += 1;
 185         }
 186         TALLOC_FREE(pid_exists);
 187         TALLOC_FREE(pids);
 188         return d;
 189 fail:
 190         TALLOC_FREE(d);
 191         return NULL;
 192 }
 193
 194 /*******************************************************************
 195  Create a storable data blob from a modified share_mode_data struct.
 196 ********************************************************************/
 197
 198 static TDB_DATA unparse_share_modes(struct share_mode_data *d)
 199 {
 200         DATA_BLOB blob;
 201         enum ndr_err_code ndr_err;
 202
 203         if (DEBUGLEVEL >= 10) {
 204                 DEBUG(10, ("unparse_share_modes:\n"));
 205                 NDR_PRINT_DEBUG(share_mode_data, d);
 206         }
 207
 208         if (d->num_share_modes == 0) {
 209                 DEBUG(10, ("No used share mode found\n"));
 210                 return make_tdb_data(NULL, 0);
 211         }
 212
 213         ndr_err = ndr_push_struct_blob(
 214                 &blob, d, d, (ndr_push_flags_fn_t)ndr_push_share_mode_data);
 215         if (!NDR_ERR_CODE_IS_SUCCESS(ndr_err)) {
 216                 smb_panic("ndr_push_share_mode_lock failed");
 217         }
 218
 219         return make_tdb_data(blob.data, blob.length);
 220 }
 221
 222 /*******************************************************************
 223  If modified, store the share_mode_data back into the database.
 224 ********************************************************************/
 225
 226 static int share_mode_data_destructor(struct share_mode_data *d)
 227 {
 228         NTSTATUS status;
 229         TDB_DATA data;
 230
 231         if (!d->modified) {
 232                 return 0;
 233         }
 234
 235         data = unparse_share_modes(d);
 236
 237         if (data.dptr == NULL) {
 238                 if (!d->fresh) {
 239                         /* There has been an entry before, delete it */
 240
 241                         status = dbwrap_record_delete(d->record);
 242                         if (!NT_STATUS_IS_OK(status)) {
 243                                 char *errmsg;
 244
 245                                 DEBUG(0, ("delete_rec returned %s\n",
 246                                           nt_errstr(status)));
 247
 248                                 if (asprintf(&errmsg, "could not delete share "
 249                                              "entry: %s\n",
 250                                              nt_errstr(status)) == -1) {
 251                                         smb_panic("could not delete share"
 252                                                   "entry");
 253                                 }
 254                                 smb_panic(errmsg);
 255                         }
 256                 }
 257                 goto done;
 258         }
 259
 260         status = dbwrap_record_store(d->record, data, TDB_REPLACE);
 261         if (!NT_STATUS_IS_OK(status)) {
 262                 char *errmsg;
 263
 264                 DEBUG(0, ("store returned %s\n", nt_errstr(status)));
 265
 266                 if (asprintf(&errmsg, "could not store share mode entry: %s",
 267                              nt_errstr(status)) == -1) {
 268                         smb_panic("could not store share mode entry");
 269                 }
 270                 smb_panic(errmsg);
 271         }
 272
 273  done:
 274
 275         return 0;
 276 }
 277
 278 /*******************************************************************
 279  Allocate a new share_mode_data struct, mark it unmodified.
 280  fresh is set to note that currently there is no database entry.
 281 ********************************************************************/
 282
 283 static struct share_mode_data *fresh_share_mode_lock(
 284         TALLOC_CTX *mem_ctx, const char *servicepath,
 285         const struct smb_filename *smb_fname,
 286         const struct timespec *old_write_time)
 287 {
 288         struct share_mode_data *d;
 289
 290         if ((servicepath == NULL) || (smb_fname == NULL) ||
 291             (old_write_time == NULL)) {
 292                 return NULL;
 293         }
 294
 295         d = talloc_zero(mem_ctx, struct share_mode_data);
 296         if (d == NULL) {
 297                 goto fail;
 298         }
 299         d->base_name = talloc_strdup(d, smb_fname->base_name);
 300         if (d->base_name == NULL) {
 301                 goto fail;
 302         }
 303         if (smb_fname->stream_name != NULL) {
 304                 d->stream_name = talloc_strdup(d, smb_fname->stream_name);
 305                 if (d->stream_name == NULL) {
 306                         goto fail;
 307                 }
 308         }
 309         d->servicepath = talloc_strdup(d, servicepath);
 310         if (d->servicepath == NULL) {
 311                 goto fail;
 312         }
 313         d->old_write_time = *old_write_time;
 314         d->modified = false;
 315         d->fresh = true;
 316         return d;
 317 fail:
 318         DEBUG(0, ("talloc failed\n"));
 319         TALLOC_FREE(d);
 320         return NULL;
 321 }
 322
 323 /*******************************************************************
 324  Either fetch a share mode from the database, or allocate a fresh
 325  one if the record doesn't exist.
 326 ********************************************************************/
 327
 328 static struct share_mode_lock *get_share_mode_lock_internal(
 329         TALLOC_CTX *mem_ctx, const struct file_id id,
 330         const char *servicepath, const struct smb_filename *smb_fname,
 331         const struct timespec *old_write_time)
 332 {
 333         struct share_mode_lock *lck;
 334         struct share_mode_data *d;
 335         struct file_id tmp;
 336         struct db_record *rec;
 337         TDB_DATA key = locking_key(&id, &tmp);
 338         TDB_DATA value;
 339
 340         rec = dbwrap_fetch_locked(lock_db, mem_ctx, key);
 341         if (rec == NULL) {
 342                 DEBUG(3, ("Could not lock share entry\n"));
 343                 return NULL;
 344         }
 345
 346         value = dbwrap_record_get_value(rec);
 347
 348         if (value.dptr == NULL) {
 349                 d = fresh_share_mode_lock(mem_ctx, servicepath, smb_fname,
 350                                           old_write_time);
 351         } else {
 352                 d = parse_share_modes(mem_ctx, value);
 353         }
 354
 355         if (d == NULL) {
 356                 DEBUG(1, ("Could not get share mode lock\n"));
 357                 TALLOC_FREE(rec);
 358                 return NULL;
 359         }
 360         d->id = id;
 361         d->record = talloc_move(d, &rec);
 362         talloc_set_destructor(d, share_mode_data_destructor);
 363
 364         lck = talloc(mem_ctx, struct share_mode_lock);
 365         if (lck == NULL) {
 366                 DEBUG(1, ("talloc failed\n"));
 367                 TALLOC_FREE(d);
 368                 return NULL;
 369         }
 370         lck->data = talloc_move(lck, &d);
 371         return lck;
 372 }
 373
 374 /*
 375  * We can only ever have one share mode locked. Users of
 376  * get_share_mode_lock never see this, it will be refcounted by
 377  * talloc_reference.
 378  */
 379 static struct share_mode_lock *the_lock;
 380
 381 static int the_lock_destructor(struct share_mode_lock *l)
 382 {
 383         the_lock = NULL;
 384         return 0;
 385 }
 386
 387 /*******************************************************************
 388  Get a share_mode_lock, Reference counted to allow nexted calls.
 389 ********************************************************************/
 390
 391 struct share_mode_lock *get_share_mode_lock_fresh(
 392         TALLOC_CTX *mem_ctx,
 393         const struct file_id id,
 394         const char *servicepath,
 395         const struct smb_filename *smb_fname,
 396         const struct timespec *old_write_time)
 397 {
 398         TALLOC_CTX *frame = talloc_stackframe();
 399
 400         struct share_mode_lock *lck;
 401
 402         if (the_lock == NULL) {
 403                 the_lock = get_share_mode_lock_internal(
 404                         frame, id, servicepath, smb_fname, old_write_time);
 405                 if (the_lock == NULL) {
 406                         goto fail;
 407                 }
 408                 talloc_set_destructor(the_lock, the_lock_destructor);
 409         }
 410         if (!file_id_equal(&the_lock->data->id, &id)) {
 411                 DEBUG(1, ("Can not lock two share modes simultaneously\n"));
 412                 goto fail;
 413         }
 414         lck = talloc(mem_ctx, struct share_mode_lock);
 415         if (lck == NULL) {
 416                 DEBUG(1, ("talloc failed\n"));
 417                 goto fail;
 418         }
 419         if (talloc_reference(lck, the_lock) == NULL) {
 420                 DEBUG(1, ("talloc_reference failed\n"));
 421                 goto fail;
 422         }
 423         lck->data = the_lock->data;
 424         TALLOC_FREE(frame);
 425         return lck;
 426 fail:
 427         TALLOC_FREE(frame);
 428         return NULL;
 429 }
 430
 431 /*******************************************************************
 432  Get a share_mode_lock without locking the database or reference
 433  counting. Used by smbstatus to display existing share modes.
 434 ********************************************************************/
 435
 436 struct share_mode_lock *fetch_share_mode_unlocked(TALLOC_CTX *mem_ctx,
 437                                                   const struct file_id id)
 438 {
 439         struct share_mode_lock *lck;
 440         struct file_id tmp;
 441         TDB_DATA key = locking_key(&id, &tmp);
 442         TDB_DATA data;
 443         NTSTATUS status;
 444
 445         status = dbwrap_fetch(lock_db, talloc_tos(), key, &data);
 446         if (!NT_STATUS_IS_OK(status)) {
 447                 DEBUG(3, ("Could not fetch share entry\n"));
 448                 return NULL;
 449         }
 450         if (data.dptr == NULL) {
 451                 return NULL;
 452         }
 453         lck = talloc(mem_ctx, struct share_mode_lock);
 454         if (lck == NULL) {
 455                 TALLOC_FREE(data.dptr);
 456                 return NULL;
 457         }
 458         lck->data = parse_share_modes(lck, data);
 459         TALLOC_FREE(data.dptr);
 460         if (lck->data == NULL) {
 461                 TALLOC_FREE(lck);
 462                 return NULL;
 463         }
 464         return lck;
 465 }
 466
 467 struct forall_state {
 468         void (*fn)(const struct share_mode_entry *entry,
 469                    const char *sharepath,
 470                    const char *fname,
 471                    void *private_data);
 472         void *private_data;
 473 };
 474
 475 static int traverse_fn(struct db_record *rec, void *_state)
 476 {
 477         struct forall_state *state = (struct forall_state *)_state;
 478         uint32_t i;
 479         TDB_DATA key;
 480         TDB_DATA value;
 481         DATA_BLOB blob;
 482         enum ndr_err_code ndr_err;
 483         struct share_mode_data *d;
 484
 485         key = dbwrap_record_get_key(rec);
 486         value = dbwrap_record_get_value(rec);
 487
 488         /* Ensure this is a locking_key record. */
 489         if (key.dsize != sizeof(struct file_id))
 490                 return 0;
 491
 492         d = talloc(talloc_tos(), struct share_mode_data);
 493         if (d == NULL) {
 494                 return 0;
 495         }
 496
 497         blob.data = value.dptr;
 498         blob.length = value.dsize;
 499
 500         ndr_err = ndr_pull_struct_blob(
 501                 &blob, d, d, (ndr_pull_flags_fn_t)ndr_pull_share_mode_data);
 502         if (!NDR_ERR_CODE_IS_SUCCESS(ndr_err)) {
 503                 DEBUG(1, ("ndr_pull_share_mode_lock failed\n"));
 504                 return 0;
 505         }
 506         for (i=0; i<d->num_share_modes; i++) {
 507                 state->fn(&d->share_modes[i],
 508                           d->servicepath, d->base_name,
 509                           state->private_data);
 510         }
 511         TALLOC_FREE(d);
 512
 513         return 0;
 514 }
 515
 516 /*******************************************************************
 517  Call the specified function on each entry under management by the
 518  share mode system.
 519 ********************************************************************/
 520
 521 int share_mode_forall(void (*fn)(const struct share_mode_entry *, const char *,
 522                                  const char *, void *),
 523                       void *private_data)
 524 {
 525         struct forall_state state;
 526         NTSTATUS status;
 527         int count;
 528
 529         if (lock_db == NULL)
 530                 return 0;
 531
 532         state.fn = fn;
 533         state.private_data = private_data;
 534
 535         status = dbwrap_traverse_read(lock_db, traverse_fn, (void *)&state,
 536                                       &count);
 537
 538         if (!NT_STATUS_IS_OK(status)) {
 539                 return -1;
 540         } else {
 541                 return count;
 542         }
 543 }