source3/locking/locking.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 /****************************************************************************
  56  Debugging aids :-).
  57 ****************************************************************************/
  58
  59 const char *lock_type_name(enum brl_type lock_type)
  60 {
  61         switch (lock_type) {
  62                 case READ_LOCK:
  63                         return "READ";
  64                 case WRITE_LOCK:
  65                         return "WRITE";
  66                 case PENDING_READ_LOCK:
  67                         return "PENDING_READ";
  68                 case PENDING_WRITE_LOCK:
  69                         return "PENDING_WRITE";
  70                 default:
  71                         return "other";
  72         }
  73 }
  74
  75 const char *lock_flav_name(enum brl_flavour lock_flav)
  76 {
  77         return (lock_flav == WINDOWS_LOCK) ? "WINDOWS_LOCK" : "POSIX_LOCK";
  78 }
  79
  80 /****************************************************************************
  81  Utility function called to see if a file region is locked.
  82  Called in the read/write codepath.
  83 ****************************************************************************/
  84
  85 void init_strict_lock_struct(files_struct *fsp,
  86                                 uint64_t smblctx,
  87                                 br_off start,
  88                                 br_off size,
  89                                 enum brl_type lock_type,
  90                                 struct lock_struct *plock)
  91 {
  92         SMB_ASSERT(lock_type == READ_LOCK || lock_type == WRITE_LOCK);
  93
  94         plock->context.smblctx = smblctx;
  95         plock->context.tid = fsp->conn->cnum;
  96         plock->context.pid = messaging_server_id(fsp->conn->sconn->msg_ctx);
  97         plock->start = start;
  98         plock->size = size;
  99         plock->fnum = fsp->fnum;
 100         plock->lock_type = lock_type;
 101         plock->lock_flav = lp_posix_cifsu_locktype(fsp);
 102 }
 103
 104 bool strict_lock_default(files_struct *fsp, struct lock_struct *plock)
 105 {
 106         int strict_locking = lp_strict_locking(fsp->conn->params);
 107         bool ret = False;
 108
 109         if (plock->size == 0) {
 110                 return True;
 111         }
 112
 113         if (!lp_locking(fsp->conn->params) || !strict_locking) {
 114                 return True;
 115         }
 116
 117         if (strict_locking == Auto) {
 118                 if  (EXCLUSIVE_OPLOCK_TYPE(fsp->oplock_type) && (plock->lock_type == READ_LOCK || plock->lock_type == WRITE_LOCK)) {
 119                         DEBUG(10,("is_locked: optimisation - exclusive oplock on file %s\n", fsp_str_dbg(fsp)));
 120                         ret = True;
 121                 } else if ((fsp->oplock_type == LEVEL_II_OPLOCK) &&
 122                            (plock->lock_type == READ_LOCK)) {
 123                         DEBUG(10,("is_locked: optimisation - level II oplock on file %s\n", fsp_str_dbg(fsp)));
 124                         ret = True;
 125                 } else {
 126                         struct byte_range_lock *br_lck;
 127
 128                         br_lck = brl_get_locks_readonly(fsp);
 129                         if (!br_lck) {
 130                                 return True;
 131                         }
 132                         ret = brl_locktest(br_lck,
 133                                         plock->context.smblctx,
 134                                         plock->context.pid,
 135                                         plock->start,
 136                                         plock->size,
 137                                         plock->lock_type,
 138                                         plock->lock_flav);
 139                 }
 140         } else {
 141                 struct byte_range_lock *br_lck;
 142
 143                 br_lck = brl_get_locks_readonly(fsp);
 144                 if (!br_lck) {
 145                         return True;
 146                 }
 147                 ret = brl_locktest(br_lck,
 148                                 plock->context.smblctx,
 149                                 plock->context.pid,
 150                                 plock->start,
 151                                 plock->size,
 152                                 plock->lock_type,
 153                                 plock->lock_flav);
 154         }
 155
 156         DEBUG(10,("strict_lock_default: flavour = %s brl start=%.0f "
 157                         "len=%.0f %s for fnum %llu file %s\n",
 158                         lock_flav_name(plock->lock_flav),
 159                         (double)plock->start, (double)plock->size,
 160                         ret ? "unlocked" : "locked",
 161                         (unsigned long long)plock->fnum, fsp_str_dbg(fsp)));
 162
 163         return ret;
 164 }
 165
 166 void strict_unlock_default(files_struct *fsp, struct lock_struct *plock)
 167 {
 168 }
 169
 170 /****************************************************************************
 171  Find out if a lock could be granted - return who is blocking us if we can't.
 172 ****************************************************************************/
 173
 174 NTSTATUS query_lock(files_struct *fsp,
 175                         uint64_t *psmblctx,
 176                         uint64_t *pcount,
 177                         uint64_t *poffset,
 178                         enum brl_type *plock_type,
 179                         enum brl_flavour lock_flav)
 180 {
 181         struct byte_range_lock *br_lck = NULL;
 182
 183         if (!fsp->can_lock) {
 184                 return fsp->is_directory ? NT_STATUS_INVALID_DEVICE_REQUEST : NT_STATUS_INVALID_HANDLE;
 185         }
 186
 187         if (!lp_locking(fsp->conn->params)) {
 188                 return NT_STATUS_OK;
 189         }
 190
 191         br_lck = brl_get_locks_readonly(fsp);
 192         if (!br_lck) {
 193                 return NT_STATUS_NO_MEMORY;
 194         }
 195
 196         return brl_lockquery(br_lck,
 197                         psmblctx,
 198                         messaging_server_id(fsp->conn->sconn->msg_ctx),
 199                         poffset,
 200                         pcount,
 201                         plock_type,
 202                         lock_flav);
 203 }
 204
 205 static void increment_current_lock_count(files_struct *fsp,
 206     enum brl_flavour lock_flav)
 207 {
 208         if (lock_flav == WINDOWS_LOCK &&
 209             fsp->current_lock_count != NO_LOCKING_COUNT) {
 210                 /* blocking ie. pending, locks also count here,
 211                  * as this is an efficiency counter to avoid checking
 212                  * the lock db. on close. JRA. */
 213
 214                 fsp->current_lock_count++;
 215         } else {
 216                 /* Notice that this has had a POSIX lock request.
 217                  * We can't count locks after this so forget them.
 218                  */
 219                 fsp->current_lock_count = NO_LOCKING_COUNT;
 220         }
 221 }
 222
 223 static void decrement_current_lock_count(files_struct *fsp,
 224     enum brl_flavour lock_flav)
 225 {
 226         if (lock_flav == WINDOWS_LOCK &&
 227             fsp->current_lock_count != NO_LOCKING_COUNT) {
 228                 SMB_ASSERT(fsp->current_lock_count > 0);
 229                 fsp->current_lock_count--;
 230         }
 231 }
 232
 233 /****************************************************************************
 234  Utility function called by locking requests.
 235 ****************************************************************************/
 236
 237 struct byte_range_lock *do_lock(struct messaging_context *msg_ctx,
 238                         files_struct *fsp,
 239                         uint64_t smblctx,
 240                         uint64_t count,
 241                         uint64_t offset,
 242                         enum brl_type lock_type,
 243                         enum brl_flavour lock_flav,
 244                         bool blocking_lock,
 245                         NTSTATUS *perr,
 246                         uint64_t *psmblctx,
 247                         struct blocking_lock_record *blr)
 248 {
 249         struct byte_range_lock *br_lck = NULL;
 250
 251         /* silently return ok on print files as we don't do locking there */
 252         if (fsp->print_file) {
 253                 *perr = NT_STATUS_OK;
 254                 return NULL;
 255         }
 256
 257         if (!fsp->can_lock) {
 258                 *perr = fsp->is_directory ? NT_STATUS_INVALID_DEVICE_REQUEST : NT_STATUS_INVALID_HANDLE;
 259                 return NULL;
 260         }
 261
 262         if (!lp_locking(fsp->conn->params)) {
 263                 *perr = NT_STATUS_OK;
 264                 return NULL;
 265         }
 266
 267         /* NOTE! 0 byte long ranges ARE allowed and should be stored  */
 268
 269         DEBUG(10,("do_lock: lock flavour %s lock type %s start=%.0f len=%.0f "
 270                 "blocking_lock=%s requested for %s file %s\n",
 271                 lock_flav_name(lock_flav), lock_type_name(lock_type),
 272                 (double)offset, (double)count, blocking_lock ? "true" :
 273                 "false", fsp_fnum_dbg(fsp), fsp_str_dbg(fsp)));
 274
 275         br_lck = brl_get_locks(talloc_tos(), fsp);
 276         if (!br_lck) {
 277                 *perr = NT_STATUS_NO_MEMORY;
 278                 return NULL;
 279         }
 280
 281         *perr = brl_lock(msg_ctx,
 282                         br_lck,
 283                         smblctx,
 284                         messaging_server_id(fsp->conn->sconn->msg_ctx),
 285                         offset,
 286                         count,
 287                         lock_type,
 288                         lock_flav,
 289                         blocking_lock,
 290                         psmblctx,
 291                         blr);
 292
 293         DEBUG(10, ("do_lock: returning status=%s\n", nt_errstr(*perr)));
 294
 295         increment_current_lock_count(fsp, lock_flav);
 296         return br_lck;
 297 }
 298
 299 /****************************************************************************
 300  Utility function called by unlocking requests.
 301 ****************************************************************************/
 302
 303 NTSTATUS do_unlock(struct messaging_context *msg_ctx,
 304                         files_struct *fsp,
 305                         uint64_t smblctx,
 306                         uint64_t count,
 307                         uint64_t offset,
 308                         enum brl_flavour lock_flav)
 309 {
 310         bool ok = False;
 311         struct byte_range_lock *br_lck = NULL;
 312
 313         if (!fsp->can_lock) {
 314                 return fsp->is_directory ? NT_STATUS_INVALID_DEVICE_REQUEST : NT_STATUS_INVALID_HANDLE;
 315         }
 316
 317         if (!lp_locking(fsp->conn->params)) {
 318                 return NT_STATUS_OK;
 319         }
 320
 321         DEBUG(10,("do_unlock: unlock start=%.0f len=%.0f requested for %s file %s\n",
 322                   (double)offset, (double)count, fsp_fnum_dbg(fsp),
 323                   fsp_str_dbg(fsp)));
 324
 325         br_lck = brl_get_locks(talloc_tos(), fsp);
 326         if (!br_lck) {
 327                 return NT_STATUS_NO_MEMORY;
 328         }
 329
 330         ok = brl_unlock(msg_ctx,
 331                         br_lck,
 332                         smblctx,
 333                         messaging_server_id(fsp->conn->sconn->msg_ctx),
 334                         offset,
 335                         count,
 336                         lock_flav);
 337
 338         TALLOC_FREE(br_lck);
 339
 340         if (!ok) {
 341                 DEBUG(10,("do_unlock: returning ERRlock.\n" ));
 342                 return NT_STATUS_RANGE_NOT_LOCKED;
 343         }
 344
 345         decrement_current_lock_count(fsp, lock_flav);
 346         return NT_STATUS_OK;
 347 }
 348
 349 /****************************************************************************
 350  Cancel any pending blocked locks.
 351 ****************************************************************************/
 352
 353 NTSTATUS do_lock_cancel(files_struct *fsp,
 354                         uint64 smblctx,
 355                         uint64_t count,
 356                         uint64_t offset,
 357                         enum brl_flavour lock_flav,
 358                         struct blocking_lock_record *blr)
 359 {
 360         bool ok = False;
 361         struct byte_range_lock *br_lck = NULL;
 362
 363         if (!fsp->can_lock) {
 364                 return fsp->is_directory ?
 365                         NT_STATUS_INVALID_DEVICE_REQUEST : NT_STATUS_INVALID_HANDLE;
 366         }
 367
 368         if (!lp_locking(fsp->conn->params)) {
 369                 return NT_STATUS_DOS(ERRDOS, ERRcancelviolation);
 370         }
 371
 372         DEBUG(10,("do_lock_cancel: cancel start=%.0f len=%.0f requested for %s file %s\n",
 373                   (double)offset, (double)count, fsp_fnum_dbg(fsp),
 374                   fsp_str_dbg(fsp)));
 375
 376         br_lck = brl_get_locks(talloc_tos(), fsp);
 377         if (!br_lck) {
 378                 return NT_STATUS_NO_MEMORY;
 379         }
 380
 381         ok = brl_lock_cancel(br_lck,
 382                         smblctx,
 383                         messaging_server_id(fsp->conn->sconn->msg_ctx),
 384                         offset,
 385                         count,
 386                         lock_flav,
 387                         blr);
 388
 389         TALLOC_FREE(br_lck);
 390
 391         if (!ok) {
 392                 DEBUG(10,("do_lock_cancel: returning ERRcancelviolation.\n" ));
 393                 return NT_STATUS_DOS(ERRDOS, ERRcancelviolation);
 394         }
 395
 396         decrement_current_lock_count(fsp, lock_flav);
 397         return NT_STATUS_OK;
 398 }
 399
 400 /****************************************************************************
 401  Remove any locks on this fd. Called from file_close().
 402 ****************************************************************************/
 403
 404 void locking_close_file(struct messaging_context *msg_ctx,
 405                         files_struct *fsp,
 406                         enum file_close_type close_type)
 407 {
 408         struct byte_range_lock *br_lck;
 409
 410         if (!lp_locking(fsp->conn->params)) {
 411                 return;
 412         }
 413
 414         /* If we have not outstanding locks or pending
 415          * locks then we don't need to look in the lock db.
 416          */
 417
 418         if (fsp->current_lock_count == 0) {
 419                 return;
 420         }
 421
 422         br_lck = brl_get_locks(talloc_tos(),fsp);
 423
 424         if (br_lck) {
 425                 cancel_pending_lock_requests_by_fid(fsp, br_lck, close_type);
 426                 brl_close_fnum(msg_ctx, br_lck);
 427                 TALLOC_FREE(br_lck);
 428         }
 429 }
 430
 431 /*******************************************************************
 432  Print out a share mode.
 433 ********************************************************************/
 434
 435 char *share_mode_str(TALLOC_CTX *ctx, int num, const struct share_mode_entry *e)
 436 {
 437         return talloc_asprintf(ctx, "share_mode_entry[%d]: "
 438                  "pid = %s, share_access = 0x%x, private_options = 0x%x, "
 439                  "access_mask = 0x%x, mid = 0x%llx, type= 0x%x, gen_id = %llu, "
 440                  "uid = %u, flags = %u, file_id %s, name_hash = 0x%x",
 441                  num,
 442                  procid_str_static(&e->pid),
 443                  e->share_access, e->private_options,
 444                  e->access_mask, (unsigned long long)e->op_mid,
 445                  e->op_type, (unsigned long long)e->share_file_id,
 446                  (unsigned int)e->uid, (unsigned int)e->flags,
 447                  file_id_string_tos(&e->id),
 448                  (unsigned int)e->name_hash);
 449 }
 450
 451 /*******************************************************************
 452  Fetch a share mode where we know one MUST exist. This call reference
 453  counts it internally to allow for nested lock fetches.
 454 ********************************************************************/
 455
 456 struct share_mode_lock *get_existing_share_mode_lock(TALLOC_CTX *mem_ctx,
 457                                                      const struct file_id id)
 458 {
 459         return get_share_mode_lock(mem_ctx, id, NULL, NULL, NULL);
 460 }
 461
 462 /*******************************************************************
 463  Sets the service name and filename for rename.
 464  At this point we emit "file renamed" messages to all
 465  process id's that have this file open.
 466  Based on an initial code idea from SATOH Fumiyasu <fumiya@samba.gr.jp>
 467 ********************************************************************/
 468
 469 bool rename_share_filename(struct messaging_context *msg_ctx,
 470                         struct share_mode_lock *lck,
 471                         const char *servicepath,
 472                         uint32_t orig_name_hash,
 473                         uint32_t new_name_hash,
 474                         const struct smb_filename *smb_fname_dst)
 475 {
 476         struct share_mode_data *d = lck->data;
 477         size_t sp_len;
 478         size_t bn_len;
 479         size_t sn_len;
 480         size_t msg_len;
 481         char *frm = NULL;
 482         int i;
 483         bool strip_two_chars = false;
 484         bool has_stream = smb_fname_dst->stream_name != NULL;
 485         struct server_id self_pid = messaging_server_id(msg_ctx);
 486
 487         DEBUG(10, ("rename_share_filename: servicepath %s newname %s\n",
 488                    servicepath, smb_fname_dst->base_name));
 489
 490         /*
 491          * rename_internal_fsp() and rename_internals() add './' to
 492          * head of newname if newname does not contain a '/'.
 493          */
 494         if (smb_fname_dst->base_name[0] &&
 495             smb_fname_dst->base_name[1] &&
 496             smb_fname_dst->base_name[0] == '.' &&
 497             smb_fname_dst->base_name[1] == '/') {
 498                 strip_two_chars = true;
 499         }
 500
 501         d->servicepath = talloc_strdup(d, servicepath);
 502         d->base_name = talloc_strdup(d, smb_fname_dst->base_name +
 503                                        (strip_two_chars ? 2 : 0));
 504         d->stream_name = talloc_strdup(d, smb_fname_dst->stream_name);
 505         if (d->base_name == NULL ||
 506             (has_stream && d->stream_name == NULL) ||
 507             d->servicepath == NULL) {
 508                 DEBUG(0, ("rename_share_filename: talloc failed\n"));
 509                 return False;
 510         }
 511         d->modified = True;
 512
 513         sp_len = strlen(d->servicepath);
 514         bn_len = strlen(d->base_name);
 515         sn_len = has_stream ? strlen(d->stream_name) : 0;
 516
 517         msg_len = MSG_FILE_RENAMED_MIN_SIZE + sp_len + 1 + bn_len + 1 +
 518             sn_len + 1;
 519
 520         /* Set up the name changed message. */
 521         frm = talloc_array(d, char, msg_len);
 522         if (!frm) {
 523                 return False;
 524         }
 525
 526         push_file_id_24(frm, &d->id);
 527
 528         DEBUG(10,("rename_share_filename: msg_len = %u\n", (unsigned int)msg_len ));
 529
 530         strlcpy(&frm[24],
 531                 d->servicepath ? d->servicepath : "",
 532                 sp_len+1);
 533         strlcpy(&frm[24 + sp_len + 1],
 534                 d->base_name ? d->base_name : "",
 535                 bn_len+1);
 536         strlcpy(&frm[24 + sp_len + 1 + bn_len + 1],
 537                 d->stream_name ? d->stream_name : "",
 538                 sn_len+1);
 539
 540         /* Send the messages. */
 541         for (i=0; i<d->num_share_modes; i++) {
 542                 struct share_mode_entry *se = &d->share_modes[i];
 543                 if (!is_valid_share_mode_entry(se)) {
 544                         continue;
 545                 }
 546
 547                 /* If this is a hardlink to the inode
 548                    with a different name, skip this. */
 549                 if (se->name_hash != orig_name_hash) {
 550                         continue;
 551                 }
 552
 553                 se->name_hash = new_name_hash;
 554
 555                 /* But not to ourselves... */
 556                 if (procid_equal(&se->pid, &self_pid)) {
 557                         continue;
 558                 }
 559
 560                 if (share_mode_stale_pid(d, i)) {
 561                         continue;
 562                 }
 563
 564                 DEBUG(10,("rename_share_filename: sending rename message to "
 565                           "pid %s file_id %s sharepath %s base_name %s "
 566                           "stream_name %s\n",
 567                           procid_str_static(&se->pid),
 568                           file_id_string_tos(&d->id),
 569                           d->servicepath, d->base_name,
 570                         has_stream ? d->stream_name : ""));
 571
 572                 messaging_send_buf(msg_ctx, se->pid, MSG_SMB_FILE_RENAME,
 573                                    (uint8 *)frm, msg_len);
 574         }
 575
 576         return True;
 577 }
 578
 579 void get_file_infos(struct file_id id,
 580                     uint32_t name_hash,
 581                     bool *delete_on_close,
 582                     struct timespec *write_time)
 583 {
 584         struct share_mode_lock *lck;
 585
 586         if (delete_on_close) {
 587                 *delete_on_close = false;
 588         }
 589
 590         if (write_time) {
 591                 ZERO_STRUCTP(write_time);
 592         }
 593
 594         if (!(lck = fetch_share_mode_unlocked(talloc_tos(), id))) {
 595                 return;
 596         }
 597
 598         if (delete_on_close) {
 599                 *delete_on_close = is_delete_on_close_set(lck, name_hash);
 600         }
 601
 602         if (write_time) {
 603                 struct timespec wt;
 604
 605                 wt = lck->data->changed_write_time;
 606                 if (null_timespec(wt)) {
 607                         wt = lck->data->old_write_time;
 608                 }
 609
 610                 *write_time = wt;
 611         }
 612
 613         TALLOC_FREE(lck);
 614 }
 615
 616 bool is_valid_share_mode_entry(const struct share_mode_entry *e)
 617 {
 618         int num_props = 0;
 619
 620         num_props += ((e->op_type == NO_OPLOCK) ? 1 : 0);
 621         num_props += (EXCLUSIVE_OPLOCK_TYPE(e->op_type) ? 1 : 0);
 622         num_props += (LEVEL_II_OPLOCK_TYPE(e->op_type) ? 1 : 0);
 623
 624         if ((num_props > 1) && serverid_exists(&e->pid)) {
 625                 smb_panic("Invalid share mode entry");
 626         }
 627         return (num_props != 0);
 628 }
 629
 630 bool is_deferred_open_entry(const struct share_mode_entry *e)
 631 {
 632         return (e->op_type == DEFERRED_OPEN_ENTRY);
 633 }
 634
 635 /*
 636  * In case d->share_modes[i] conflicts with something or otherwise is
 637  * being used, we need to make sure the corresponding process still
 638  * exists. This routine checks it and potentially removes the entry
 639  * from d->share_modes. Modifies d->num_share_modes, watch out in
 640  * routines iterating over that array.
 641  */
 642 bool share_mode_stale_pid(struct share_mode_data *d, unsigned i)
 643 {
 644         struct share_mode_entry *e;
 645
 646         if (i > d->num_share_modes) {
 647                 DEBUG(1, ("Asking for index %u, only %u around\n",
 648                           i, (unsigned)d->num_share_modes));
 649                 return false;
 650         }
 651         e = &d->share_modes[i];
 652         if (serverid_exists(&e->pid)) {
 653                 DEBUG(10, ("PID %s (index %u out of %u) still exists\n",
 654                            procid_str_static(&e->pid), i,
 655                            (unsigned)d->num_share_modes));
 656                 return false;
 657         }
 658         DEBUG(10, ("PID %s (index %u out of %u) does not exist anymore\n",
 659                    procid_str_static(&e->pid), i,
 660                    (unsigned)d->num_share_modes));
 661         *e = d->share_modes[d->num_share_modes-1];
 662         d->num_share_modes -= 1;
 663
 664         if (d->num_share_modes == 0 &&
 665             d->num_delete_tokens) {
 666                 /*
 667                  * We cannot have any delete tokens
 668                  * if there are no valid share modes.
 669                  */
 670                 TALLOC_FREE(d->delete_tokens);
 671                 d->num_delete_tokens = 0;
 672         }
 673
 674         d->modified = true;
 675         return true;
 676 }
 677
 678 /*******************************************************************
 679  Fill a share mode entry.
 680 ********************************************************************/
 681
 682 static void fill_share_mode_entry(struct share_mode_entry *e,
 683                                   files_struct *fsp,
 684                                   uid_t uid, uint64_t mid, uint16 op_type)
 685 {
 686         ZERO_STRUCTP(e);
 687         e->pid = messaging_server_id(fsp->conn->sconn->msg_ctx);
 688         e->share_access = fsp->share_access;
 689         e->private_options = fsp->fh->private_options;
 690         e->access_mask = fsp->access_mask;
 691         e->op_mid = mid;
 692         e->op_type = op_type;
 693         e->time.tv_sec = fsp->open_time.tv_sec;
 694         e->time.tv_usec = fsp->open_time.tv_usec;
 695         e->id = fsp->file_id;
 696         e->share_file_id = fsp->fh->gen_id;
 697         e->uid = (uint32)uid;
 698         e->flags = fsp->posix_open ? SHARE_MODE_FLAG_POSIX_OPEN : 0;
 699         e->name_hash = fsp->name_hash;
 700 }
 701
 702 static void fill_deferred_open_entry(struct share_mode_entry *e,
 703                                      const struct timeval request_time,
 704                                      struct file_id id,
 705                                      struct server_id pid,
 706                                      uint64_t mid)
 707 {
 708         ZERO_STRUCTP(e);
 709         e->pid = pid;
 710         e->op_mid = mid;
 711         e->op_type = DEFERRED_OPEN_ENTRY;
 712         e->time.tv_sec = request_time.tv_sec;
 713         e->time.tv_usec = request_time.tv_usec;
 714         e->id = id;
 715         e->uid = (uint32)-1;
 716         e->flags = 0;
 717 }
 718
 719 static void add_share_mode_entry(struct share_mode_data *d,
 720                                  const struct share_mode_entry *entry)
 721 {
 722         ADD_TO_ARRAY(d, struct share_mode_entry, *entry,
 723                      &d->share_modes, &d->num_share_modes);
 724         d->modified = True;
 725 }
 726
 727 void set_share_mode(struct share_mode_lock *lck, files_struct *fsp,
 728                     uid_t uid, uint64_t mid, uint16 op_type)
 729 {
 730         struct share_mode_entry entry;
 731         fill_share_mode_entry(&entry, fsp, uid, mid, op_type);
 732         add_share_mode_entry(lck->data, &entry);
 733 }
 734
 735 void add_deferred_open(struct share_mode_lock *lck, uint64_t mid,
 736                        struct timeval request_time,
 737                        struct server_id pid, struct file_id id)
 738 {
 739         struct share_mode_entry entry;
 740         fill_deferred_open_entry(&entry, request_time, id, pid, mid);
 741         add_share_mode_entry(lck->data, &entry);
 742 }
 743
 744 /*******************************************************************
 745  Check if two share mode entries are identical, ignoring oplock
 746  and mid info and desired_access. (Removed paranoia test - it's
 747  not automatically a logic error if they are identical. JRA.)
 748 ********************************************************************/
 749
 750 static bool share_modes_identical(struct share_mode_entry *e1,
 751                                   struct share_mode_entry *e2)
 752 {
 753         /* We used to check for e1->share_access == e2->share_access here
 754            as well as the other fields but 2 different DOS or FCB opens
 755            sharing the same share mode entry may validly differ in
 756            fsp->share_access field. */
 757
 758         return (procid_equal(&e1->pid, &e2->pid) &&
 759                 file_id_equal(&e1->id, &e2->id) &&
 760                 e1->share_file_id == e2->share_file_id );
 761 }
 762
 763 static bool deferred_open_identical(struct share_mode_entry *e1,
 764                                     struct share_mode_entry *e2)
 765 {
 766         return (procid_equal(&e1->pid, &e2->pid) &&
 767                 (e1->op_mid == e2->op_mid) &&
 768                 file_id_equal(&e1->id, &e2->id));
 769 }
 770
 771 static struct share_mode_entry *find_share_mode_entry(struct share_mode_data *d,
 772                                                       struct share_mode_entry *entry)
 773 {
 774         int i;
 775
 776         for (i=0; i<d->num_share_modes; i++) {
 777                 struct share_mode_entry *e = &d->share_modes[i];
 778                 if (is_valid_share_mode_entry(entry) &&
 779                     is_valid_share_mode_entry(e) &&
 780                     share_modes_identical(e, entry)) {
 781                         return e;
 782                 }
 783                 if (is_deferred_open_entry(entry) &&
 784                     is_deferred_open_entry(e) &&
 785                     deferred_open_identical(e, entry)) {
 786                         return e;
 787                 }
 788         }
 789         return NULL;
 790 }
 791
 792 /*******************************************************************
 793  Del the share mode of a file for this process. Return the number of
 794  entries left.
 795 ********************************************************************/
 796
 797 bool del_share_mode(struct share_mode_lock *lck, files_struct *fsp)
 798 {
 799         struct share_mode_entry entry, *e;
 800
 801         /* Don't care about the pid owner being correct here - just a search. */
 802         fill_share_mode_entry(&entry, fsp, (uid_t)-1, 0, NO_OPLOCK);
 803
 804         e = find_share_mode_entry(lck->data, &entry);
 805         if (e == NULL) {
 806                 return False;
 807         }
 808         *e = lck->data->share_modes[lck->data->num_share_modes-1];
 809         lck->data->num_share_modes -= 1;
 810         lck->data->modified = True;
 811         return True;
 812 }
 813
 814 void del_deferred_open_entry(struct share_mode_lock *lck, uint64_t mid,
 815                              struct server_id pid)
 816 {
 817         struct share_mode_entry entry, *e;
 818
 819         fill_deferred_open_entry(&entry, timeval_zero(),
 820                                  lck->data->id, pid, mid);
 821
 822         e = find_share_mode_entry(lck->data, &entry);
 823         if (e == NULL) {
 824                 return;
 825         }
 826         *e = lck->data->share_modes[lck->data->num_share_modes-1];
 827         lck->data->num_share_modes -= 1;
 828         lck->data->modified = True;
 829 }
 830
 831 /*******************************************************************
 832  Remove an oplock mid and mode entry from a share mode.
 833 ********************************************************************/
 834
 835 bool remove_share_oplock(struct share_mode_lock *lck, files_struct *fsp)
 836 {
 837         struct share_mode_entry entry, *e;
 838
 839         /* Don't care about the pid owner being correct here - just a search. */
 840         fill_share_mode_entry(&entry, fsp, (uid_t)-1, 0, NO_OPLOCK);
 841
 842         e = find_share_mode_entry(lck->data, &entry);
 843         if (e == NULL) {
 844                 return False;
 845         }
 846
 847         if (EXCLUSIVE_OPLOCK_TYPE(e->op_type)) {
 848                 /*
 849                  * Going from exclusive or batch,
 850                  * we always go through FAKE_LEVEL_II
 851                  * first.
 852                  */
 853                 if (!EXCLUSIVE_OPLOCK_TYPE(fsp->oplock_type)) {
 854                         smb_panic("remove_share_oplock: logic error");
 855                 }
 856                 e->op_type = FAKE_LEVEL_II_OPLOCK;
 857         } else {
 858                 e->op_type = NO_OPLOCK;
 859         }
 860         lck->data->modified = True;
 861         return True;
 862 }
 863
 864 /*******************************************************************
 865  Downgrade a oplock type from exclusive to level II.
 866 ********************************************************************/
 867
 868 bool downgrade_share_oplock(struct share_mode_lock *lck, files_struct *fsp)
 869 {
 870         struct share_mode_entry entry, *e;
 871
 872         /* Don't care about the pid owner being correct here - just a search. */
 873         fill_share_mode_entry(&entry, fsp, (uid_t)-1, 0, NO_OPLOCK);
 874
 875         e = find_share_mode_entry(lck->data, &entry);
 876         if (e == NULL) {
 877                 return False;
 878         }
 879
 880         e->op_type = LEVEL_II_OPLOCK;
 881         lck->data->modified = True;
 882         return True;
 883 }
 884
 885 /*************************************************************************
 886  Return a talloced copy of a struct security_unix_token. NULL on fail.
 887  (Should this be in locking.c.... ?).
 888 *************************************************************************/
 889
 890 static struct security_unix_token *copy_unix_token(TALLOC_CTX *ctx, const struct security_unix_token *tok)
 891 {
 892         struct security_unix_token *cpy;
 893
 894         cpy = talloc(ctx, struct security_unix_token);
 895         if (!cpy) {
 896                 return NULL;
 897         }
 898
 899         cpy->uid = tok->uid;
 900         cpy->gid = tok->gid;
 901         cpy->ngroups = tok->ngroups;
 902         if (tok->ngroups) {
 903                 /* Make this a talloc child of cpy. */
 904                 cpy->groups = (gid_t *)talloc_memdup(
 905                         cpy, tok->groups, tok->ngroups * sizeof(gid_t));
 906                 if (!cpy->groups) {
 907                         TALLOC_FREE(cpy);
 908                         return NULL;
 909                 }
 910         }
 911         return cpy;
 912 }
 913
 914 /****************************************************************************
 915  Adds a delete on close token.
 916 ****************************************************************************/
 917
 918 static bool add_delete_on_close_token(struct share_mode_data *d,
 919                         uint32_t name_hash,
 920                         const struct security_token *nt_tok,
 921                         const struct security_unix_token *tok)
 922 {
 923         struct delete_token *tmp, *dtl;
 924
 925         tmp = talloc_realloc(d, d->delete_tokens, struct delete_token,
 926                              d->num_delete_tokens+1);
 927         if (tmp == NULL) {
 928                 return false;
 929         }
 930         d->delete_tokens = tmp;
 931         dtl = &d->delete_tokens[d->num_delete_tokens];
 932
 933         dtl->name_hash = name_hash;
 934         dtl->delete_nt_token = dup_nt_token(d->delete_tokens, nt_tok);
 935         if (dtl->delete_nt_token == NULL) {
 936                 return false;
 937         }
 938         dtl->delete_token = copy_unix_token(d->delete_tokens, tok);
 939         if (dtl->delete_token == NULL) {
 940                 return false;
 941         }
 942         d->num_delete_tokens += 1;
 943         d->modified = true;
 944         return true;
 945 }
 946
 947 /****************************************************************************
 948  Sets the delete on close flag over all share modes on this file.
 949  Modify the share mode entry for all files open
 950  on this device and inode to tell other smbds we have
 951  changed the delete on close flag. This will be noticed
 952  in the close code, the last closer will delete the file
 953  if flag is set.
 954  This makes a copy of any struct security_unix_token into the
 955  lck entry. This function is used when the lock is already granted.
 956 ****************************************************************************/
 957
 958 void set_delete_on_close_lck(files_struct *fsp,
 959                         struct share_mode_lock *lck,
 960                         bool delete_on_close,
 961                         const struct security_token *nt_tok,
 962                         const struct security_unix_token *tok)
 963 {
 964         struct share_mode_data *d = lck->data;
 965         int i;
 966         bool ret;
 967
 968         if (delete_on_close) {
 969                 SMB_ASSERT(nt_tok != NULL);
 970                 SMB_ASSERT(tok != NULL);
 971         } else {
 972                 SMB_ASSERT(nt_tok == NULL);
 973                 SMB_ASSERT(tok == NULL);
 974         }
 975
 976         for (i=0; i<d->num_delete_tokens; i++) {
 977                 struct delete_token *dt = &d->delete_tokens[i];
 978                 if (dt->name_hash == fsp->name_hash) {
 979                         d->modified = true;
 980                         if (delete_on_close == false) {
 981                                 /* Delete this entry. */
 982                                 TALLOC_FREE(dt->delete_nt_token);
 983                                 TALLOC_FREE(dt->delete_token);
 984                                 *dt = d->delete_tokens[
 985                                         d->num_delete_tokens-1];
 986                                 d->num_delete_tokens -= 1;
 987                         } else {
 988                                 /* Replace this token with the
 989                                    given tok. */
 990                                 TALLOC_FREE(dt->delete_nt_token);
 991                                 dt->delete_nt_token = dup_nt_token(dt, nt_tok);
 992                                 SMB_ASSERT(dt->delete_nt_token != NULL);
 993                                 TALLOC_FREE(dt->delete_token);
 994                                 dt->delete_token = copy_unix_token(dt, tok);
 995                                 SMB_ASSERT(dt->delete_token != NULL);
 996                         }
 997                         return;
 998                 }
 999         }
1000
1001         if (!delete_on_close) {
1002                 /* Nothing to delete - not found. */
1003                 return;
1004         }
1005
1006         ret = add_delete_on_close_token(lck->data, fsp->name_hash, nt_tok, tok);
1007         SMB_ASSERT(ret);
1008 }
1009
1010 bool set_delete_on_close(files_struct *fsp, bool delete_on_close,
1011                         const struct security_token *nt_tok,
1012                         const struct security_unix_token *tok)
1013 {
1014         struct share_mode_lock *lck;
1015
1016         DEBUG(10,("set_delete_on_close: %s delete on close flag for "
1017                   "%s, file %s\n",
1018                   delete_on_close ? "Adding" : "Removing", fsp_fnum_dbg(fsp),
1019                   fsp_str_dbg(fsp)));
1020
1021         lck = get_existing_share_mode_lock(talloc_tos(), fsp->file_id);
1022         if (lck == NULL) {
1023                 return False;
1024         }
1025
1026         if (delete_on_close) {
1027                 set_delete_on_close_lck(fsp, lck, true,
1028                         nt_tok,
1029                         tok);
1030         } else {
1031                 set_delete_on_close_lck(fsp, lck, false,
1032                         NULL,
1033                         NULL);
1034         }
1035
1036         if (fsp->is_directory) {
1037                 SMB_ASSERT(!is_ntfs_stream_smb_fname(fsp->fsp_name));
1038                 send_stat_cache_delete_message(fsp->conn->sconn->msg_ctx,
1039                                                fsp->fsp_name->base_name);
1040         }
1041
1042         TALLOC_FREE(lck);
1043
1044         fsp->delete_on_close = delete_on_close;
1045
1046         return True;
1047 }
1048
1049 static struct delete_token *find_delete_on_close_token(
1050         struct share_mode_data *d, uint32_t name_hash)
1051 {
1052         uint32_t i;
1053
1054         DEBUG(10, ("find_delete_on_close_token: name_hash = 0x%x\n",
1055                    (unsigned int)name_hash));
1056
1057         for (i=0; i<d->num_delete_tokens; i++) {
1058                 struct delete_token *dt = &d->delete_tokens[i];
1059
1060                 DEBUG(10, ("find__delete_on_close_token: dt->name_hash = 0x%x\n",
1061                            (unsigned int)dt->name_hash ));
1062                 if (dt->name_hash == name_hash) {
1063                         return dt;
1064                 }
1065         }
1066         return NULL;
1067 }
1068
1069 /****************************************************************************
1070  Return the NT token and UNIX token if there's a match. Return true if
1071  found, false if not.
1072 ****************************************************************************/
1073
1074 bool get_delete_on_close_token(struct share_mode_lock *lck,
1075                                         uint32_t name_hash,
1076                                         const struct security_token **pp_nt_tok,
1077                                         const struct security_unix_token **pp_tok)
1078 {
1079         struct delete_token *dt;
1080
1081         dt = find_delete_on_close_token(lck->data, name_hash);
1082         if (dt == NULL) {
1083                 return false;
1084         }
1085         *pp_nt_tok = dt->delete_nt_token;
1086         *pp_tok =  dt->delete_token;
1087         return true;
1088 }
1089
1090 bool is_delete_on_close_set(struct share_mode_lock *lck, uint32_t name_hash)
1091 {
1092         return find_delete_on_close_token(lck->data, name_hash) != NULL;
1093 }
1094
1095 bool set_sticky_write_time(struct file_id fileid, struct timespec write_time)
1096 {
1097         struct share_mode_lock *lck;
1098
1099         DEBUG(5,("set_sticky_write_time: %s id=%s\n",
1100                  timestring(talloc_tos(),
1101                             convert_timespec_to_time_t(write_time)),
1102                  file_id_string_tos(&fileid)));
1103
1104         lck = get_existing_share_mode_lock(talloc_tos(), fileid);
1105         if (lck == NULL) {
1106                 return False;
1107         }
1108
1109         if (timespec_compare(&lck->data->changed_write_time, &write_time) != 0) {
1110                 lck->data->modified = True;
1111                 lck->data->changed_write_time = write_time;
1112         }
1113
1114         TALLOC_FREE(lck);
1115         return True;
1116 }
1117
1118 bool set_write_time(struct file_id fileid, struct timespec write_time)
1119 {
1120         struct share_mode_lock *lck;
1121
1122         DEBUG(5,("set_write_time: %s id=%s\n",
1123                  timestring(talloc_tos(),
1124                             convert_timespec_to_time_t(write_time)),
1125                  file_id_string_tos(&fileid)));
1126
1127         lck = get_existing_share_mode_lock(talloc_tos(), fileid);
1128         if (lck == NULL) {
1129                 return False;
1130         }
1131
1132         if (timespec_compare(&lck->data->old_write_time, &write_time) != 0) {
1133                 lck->data->modified = True;
1134                 lck->data->old_write_time = write_time;
1135         }
1136
1137         TALLOC_FREE(lck);
1138         return True;
1139 }