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 (serverid_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         if (e->stale) {
 621                 return false;
 622         }
 623
 624         num_props += ((e->op_type == NO_OPLOCK) ? 1 : 0);
 625         num_props += (EXCLUSIVE_OPLOCK_TYPE(e->op_type) ? 1 : 0);
 626         num_props += (LEVEL_II_OPLOCK_TYPE(e->op_type) ? 1 : 0);
 627
 628         if ((num_props > 1) && serverid_exists(&e->pid)) {
 629                 smb_panic("Invalid share mode entry");
 630         }
 631         return (num_props != 0);
 632 }
 633
 634 /*
 635  * In case d->share_modes[i] conflicts with something or otherwise is
 636  * being used, we need to make sure the corresponding process still
 637  * exists.
 638  */
 639 bool share_mode_stale_pid(struct share_mode_data *d, unsigned idx)
 640 {
 641         struct share_mode_entry *e;
 642
 643         if (idx > d->num_share_modes) {
 644                 DEBUG(1, ("Asking for index %u, only %u around\n",
 645                           idx, (unsigned)d->num_share_modes));
 646                 return false;
 647         }
 648         e = &d->share_modes[idx];
 649         if (serverid_exists(&e->pid)) {
 650                 DEBUG(10, ("PID %s (index %u out of %u) still exists\n",
 651                            procid_str_static(&e->pid), idx,
 652                            (unsigned)d->num_share_modes));
 653                 return false;
 654         }
 655         DEBUG(10, ("PID %s (index %u out of %u) does not exist anymore\n",
 656                    procid_str_static(&e->pid), idx,
 657                    (unsigned)d->num_share_modes));
 658
 659         e->stale = true;
 660
 661         if (d->num_delete_tokens != 0) {
 662                 uint32_t i, num_stale;
 663
 664                 /*
 665                  * We cannot have any delete tokens
 666                  * if there are no valid share modes.
 667                  */
 668
 669                 num_stale = 0;
 670
 671                 for (i=0; i<d->num_share_modes; i++) {
 672                         if (d->share_modes[i].stale) {
 673                                 num_stale += 1;
 674                         }
 675                 }
 676
 677                 if (num_stale == d->num_share_modes) {
 678                         /*
 679                          * No non-stale share mode found
 680                          */
 681                         TALLOC_FREE(d->delete_tokens);
 682                         d->num_delete_tokens = 0;
 683                 }
 684         }
 685
 686         d->modified = true;
 687         return true;
 688 }
 689
 690 /*******************************************************************
 691  Fill a share mode entry.
 692 ********************************************************************/
 693
 694 static void fill_share_mode_entry(struct share_mode_entry *e,
 695                                   files_struct *fsp,
 696                                   uid_t uid, uint64_t mid, uint16 op_type)
 697 {
 698         ZERO_STRUCTP(e);
 699         e->pid = messaging_server_id(fsp->conn->sconn->msg_ctx);
 700         e->share_access = fsp->share_access;
 701         e->private_options = fsp->fh->private_options;
 702         e->access_mask = fsp->access_mask;
 703         e->op_mid = mid;
 704         e->op_type = op_type;
 705         e->time.tv_sec = fsp->open_time.tv_sec;
 706         e->time.tv_usec = fsp->open_time.tv_usec;
 707         e->id = fsp->file_id;
 708         e->share_file_id = fsp->fh->gen_id;
 709         e->uid = (uint32)uid;
 710         e->flags = fsp->posix_open ? SHARE_MODE_FLAG_POSIX_OPEN : 0;
 711         e->name_hash = fsp->name_hash;
 712 }
 713
 714 static void add_share_mode_entry(struct share_mode_data *d,
 715                                  const struct share_mode_entry *entry)
 716 {
 717         ADD_TO_ARRAY(d, struct share_mode_entry, *entry,
 718                      &d->share_modes, &d->num_share_modes);
 719         d->modified = True;
 720 }
 721
 722 void set_share_mode(struct share_mode_lock *lck, files_struct *fsp,
 723                     uid_t uid, uint64_t mid, uint16 op_type)
 724 {
 725         struct share_mode_entry entry;
 726         fill_share_mode_entry(&entry, fsp, uid, mid, op_type);
 727         add_share_mode_entry(lck->data, &entry);
 728 }
 729
 730 /*******************************************************************
 731  Check if two share mode entries are identical, ignoring oplock
 732  and mid info and desired_access. (Removed paranoia test - it's
 733  not automatically a logic error if they are identical. JRA.)
 734 ********************************************************************/
 735
 736 static bool share_modes_identical(const struct share_mode_entry *e1,
 737                                   const struct share_mode_entry *e2)
 738 {
 739         /* We used to check for e1->share_access == e2->share_access here
 740            as well as the other fields but 2 different DOS or FCB opens
 741            sharing the same share mode entry may validly differ in
 742            fsp->share_access field. */
 743
 744         return (serverid_equal(&e1->pid, &e2->pid) &&
 745                 file_id_equal(&e1->id, &e2->id) &&
 746                 e1->share_file_id == e2->share_file_id );
 747 }
 748
 749 static struct share_mode_entry *find_share_mode_entry(struct share_mode_data *d,
 750                                                       struct share_mode_entry *entry)
 751 {
 752         int i;
 753
 754         if (!is_valid_share_mode_entry(entry)) {
 755                 return NULL;
 756         }
 757
 758         for (i=0; i<d->num_share_modes; i++) {
 759                 struct share_mode_entry *e = &d->share_modes[i];
 760                 if (is_valid_share_mode_entry(e) &&
 761                     share_modes_identical(e, entry)) {
 762                         return e;
 763                 }
 764         }
 765         return NULL;
 766 }
 767
 768 /*******************************************************************
 769  Del the share mode of a file for this process. Return the number of
 770  entries left.
 771 ********************************************************************/
 772
 773 bool del_share_mode(struct share_mode_lock *lck, files_struct *fsp)
 774 {
 775         struct share_mode_entry entry, *e;
 776
 777         /* Don't care about the pid owner being correct here - just a search. */
 778         fill_share_mode_entry(&entry, fsp, (uid_t)-1, 0, NO_OPLOCK);
 779
 780         e = find_share_mode_entry(lck->data, &entry);
 781         if (e == NULL) {
 782                 return False;
 783         }
 784         *e = lck->data->share_modes[lck->data->num_share_modes-1];
 785         lck->data->num_share_modes -= 1;
 786         lck->data->modified = True;
 787         return True;
 788 }
 789
 790 bool mark_share_mode_disconnected(struct share_mode_lock *lck,
 791                                   struct files_struct *fsp)
 792 {
 793         struct share_mode_entry entry, *e;
 794
 795         if (lck->data->num_share_modes != 1) {
 796                 return false;
 797         }
 798
 799         if (fsp->op == NULL) {
 800                 return false;
 801         }
 802         if (!fsp->op->global->durable) {
 803                 return false;
 804         }
 805
 806         /* Don't care about the pid owner being correct here - just a search. */
 807         fill_share_mode_entry(&entry, fsp, (uid_t)-1, 0, NO_OPLOCK);
 808
 809         e = find_share_mode_entry(lck->data, &entry);
 810         if (e == NULL) {
 811                 return false;
 812         }
 813
 814         DEBUG(10, ("Marking share mode entry disconnected for durable handle\n"));
 815
 816         server_id_set_disconnected(&e->pid);
 817
 818         /*
 819          * On reopen the caller needs to check that
 820          * the client comes with the correct handle.
 821          */
 822         e->share_file_id = fsp->op->global->open_persistent_id;
 823
 824         lck->data->modified = true;
 825         return true;
 826 }
 827
 828 /*******************************************************************
 829  Remove an oplock mid and mode entry from a share mode.
 830 ********************************************************************/
 831
 832 bool remove_share_oplock(struct share_mode_lock *lck, files_struct *fsp)
 833 {
 834         struct share_mode_entry entry, *e;
 835
 836         /* Don't care about the pid owner being correct here - just a search. */
 837         fill_share_mode_entry(&entry, fsp, (uid_t)-1, 0, NO_OPLOCK);
 838
 839         e = find_share_mode_entry(lck->data, &entry);
 840         if (e == NULL) {
 841                 return False;
 842         }
 843
 844         if (EXCLUSIVE_OPLOCK_TYPE(e->op_type)) {
 845                 /*
 846                  * Going from exclusive or batch,
 847                  * we always go through FAKE_LEVEL_II
 848                  * first.
 849                  */
 850                 if (!EXCLUSIVE_OPLOCK_TYPE(fsp->oplock_type)) {
 851                         smb_panic("remove_share_oplock: logic error");
 852                 }
 853                 e->op_type = FAKE_LEVEL_II_OPLOCK;
 854         } else {
 855                 e->op_type = NO_OPLOCK;
 856         }
 857         lck->data->modified = True;
 858         return True;
 859 }
 860
 861 /*******************************************************************
 862  Downgrade a oplock type from exclusive to level II.
 863 ********************************************************************/
 864
 865 bool downgrade_share_oplock(struct share_mode_lock *lck, files_struct *fsp)
 866 {
 867         struct share_mode_entry entry, *e;
 868
 869         /* Don't care about the pid owner being correct here - just a search. */
 870         fill_share_mode_entry(&entry, fsp, (uid_t)-1, 0, NO_OPLOCK);
 871
 872         e = find_share_mode_entry(lck->data, &entry);
 873         if (e == NULL) {
 874                 return False;
 875         }
 876
 877         e->op_type = LEVEL_II_OPLOCK;
 878         lck->data->modified = True;
 879         return True;
 880 }
 881
 882 /****************************************************************************
 883  Adds a delete on close token.
 884 ****************************************************************************/
 885
 886 static bool add_delete_on_close_token(struct share_mode_data *d,
 887                         uint32_t name_hash,
 888                         const struct security_token *nt_tok,
 889                         const struct security_unix_token *tok)
 890 {
 891         struct delete_token *tmp, *dtl;
 892
 893         tmp = talloc_realloc(d, d->delete_tokens, struct delete_token,
 894                              d->num_delete_tokens+1);
 895         if (tmp == NULL) {
 896                 return false;
 897         }
 898         d->delete_tokens = tmp;
 899         dtl = &d->delete_tokens[d->num_delete_tokens];
 900
 901         dtl->name_hash = name_hash;
 902         dtl->delete_nt_token = dup_nt_token(d->delete_tokens, nt_tok);
 903         if (dtl->delete_nt_token == NULL) {
 904                 return false;
 905         }
 906         dtl->delete_token = copy_unix_token(d->delete_tokens, tok);
 907         if (dtl->delete_token == NULL) {
 908                 return false;
 909         }
 910         d->num_delete_tokens += 1;
 911         d->modified = true;
 912         return true;
 913 }
 914
 915 /****************************************************************************
 916  Sets the delete on close flag over all share modes on this file.
 917  Modify the share mode entry for all files open
 918  on this device and inode to tell other smbds we have
 919  changed the delete on close flag. This will be noticed
 920  in the close code, the last closer will delete the file
 921  if flag is set.
 922  This makes a copy of any struct security_unix_token into the
 923  lck entry. This function is used when the lock is already granted.
 924 ****************************************************************************/
 925
 926 void set_delete_on_close_lck(files_struct *fsp,
 927                         struct share_mode_lock *lck,
 928                         bool delete_on_close,
 929                         const struct security_token *nt_tok,
 930                         const struct security_unix_token *tok)
 931 {
 932         struct share_mode_data *d = lck->data;
 933         int i;
 934         bool ret;
 935
 936         if (delete_on_close) {
 937                 SMB_ASSERT(nt_tok != NULL);
 938                 SMB_ASSERT(tok != NULL);
 939         } else {
 940                 SMB_ASSERT(nt_tok == NULL);
 941                 SMB_ASSERT(tok == NULL);
 942         }
 943
 944         for (i=0; i<d->num_delete_tokens; i++) {
 945                 struct delete_token *dt = &d->delete_tokens[i];
 946                 if (dt->name_hash == fsp->name_hash) {
 947                         d->modified = true;
 948                         if (delete_on_close == false) {
 949                                 /* Delete this entry. */
 950                                 TALLOC_FREE(dt->delete_nt_token);
 951                                 TALLOC_FREE(dt->delete_token);
 952                                 *dt = d->delete_tokens[
 953                                         d->num_delete_tokens-1];
 954                                 d->num_delete_tokens -= 1;
 955                         } else {
 956                                 /* Replace this token with the
 957                                    given tok. */
 958                                 TALLOC_FREE(dt->delete_nt_token);
 959                                 dt->delete_nt_token = dup_nt_token(dt, nt_tok);
 960                                 SMB_ASSERT(dt->delete_nt_token != NULL);
 961                                 TALLOC_FREE(dt->delete_token);
 962                                 dt->delete_token = copy_unix_token(dt, tok);
 963                                 SMB_ASSERT(dt->delete_token != NULL);
 964                         }
 965                         return;
 966                 }
 967         }
 968
 969         if (!delete_on_close) {
 970                 /* Nothing to delete - not found. */
 971                 return;
 972         }
 973
 974         ret = add_delete_on_close_token(lck->data, fsp->name_hash, nt_tok, tok);
 975         SMB_ASSERT(ret);
 976 }
 977
 978 bool set_delete_on_close(files_struct *fsp, bool delete_on_close,
 979                         const struct security_token *nt_tok,
 980                         const struct security_unix_token *tok)
 981 {
 982         struct share_mode_lock *lck;
 983
 984         DEBUG(10,("set_delete_on_close: %s delete on close flag for "
 985                   "%s, file %s\n",
 986                   delete_on_close ? "Adding" : "Removing", fsp_fnum_dbg(fsp),
 987                   fsp_str_dbg(fsp)));
 988
 989         lck = get_existing_share_mode_lock(talloc_tos(), fsp->file_id);
 990         if (lck == NULL) {
 991                 return False;
 992         }
 993
 994         if (delete_on_close) {
 995                 set_delete_on_close_lck(fsp, lck, true,
 996                         nt_tok,
 997                         tok);
 998         } else {
 999                 set_delete_on_close_lck(fsp, lck, false,
1000                         NULL,
1001                         NULL);
1002         }
1003
1004         if (fsp->is_directory) {
1005                 SMB_ASSERT(!is_ntfs_stream_smb_fname(fsp->fsp_name));
1006                 send_stat_cache_delete_message(fsp->conn->sconn->msg_ctx,
1007                                                fsp->fsp_name->base_name);
1008         }
1009
1010         TALLOC_FREE(lck);
1011
1012         fsp->delete_on_close = delete_on_close;
1013
1014         return True;
1015 }
1016
1017 static struct delete_token *find_delete_on_close_token(
1018         struct share_mode_data *d, uint32_t name_hash)
1019 {
1020         uint32_t i;
1021
1022         DEBUG(10, ("find_delete_on_close_token: name_hash = 0x%x\n",
1023                    (unsigned int)name_hash));
1024
1025         for (i=0; i<d->num_delete_tokens; i++) {
1026                 struct delete_token *dt = &d->delete_tokens[i];
1027
1028                 DEBUG(10, ("find__delete_on_close_token: dt->name_hash = 0x%x\n",
1029                            (unsigned int)dt->name_hash ));
1030                 if (dt->name_hash == name_hash) {
1031                         return dt;
1032                 }
1033         }
1034         return NULL;
1035 }
1036
1037 /****************************************************************************
1038  Return the NT token and UNIX token if there's a match. Return true if
1039  found, false if not.
1040 ****************************************************************************/
1041
1042 bool get_delete_on_close_token(struct share_mode_lock *lck,
1043                                         uint32_t name_hash,
1044                                         const struct security_token **pp_nt_tok,
1045                                         const struct security_unix_token **pp_tok)
1046 {
1047         struct delete_token *dt;
1048
1049         dt = find_delete_on_close_token(lck->data, name_hash);
1050         if (dt == NULL) {
1051                 return false;
1052         }
1053         *pp_nt_tok = dt->delete_nt_token;
1054         *pp_tok =  dt->delete_token;
1055         return true;
1056 }
1057
1058 bool is_delete_on_close_set(struct share_mode_lock *lck, uint32_t name_hash)
1059 {
1060         return find_delete_on_close_token(lck->data, name_hash) != NULL;
1061 }
1062
1063 bool set_sticky_write_time(struct file_id fileid, struct timespec write_time)
1064 {
1065         struct share_mode_lock *lck;
1066
1067         DEBUG(5,("set_sticky_write_time: %s id=%s\n",
1068                  timestring(talloc_tos(),
1069                             convert_timespec_to_time_t(write_time)),
1070                  file_id_string_tos(&fileid)));
1071
1072         lck = get_existing_share_mode_lock(talloc_tos(), fileid);
1073         if (lck == NULL) {
1074                 return False;
1075         }
1076
1077         if (timespec_compare(&lck->data->changed_write_time, &write_time) != 0) {
1078                 lck->data->modified = True;
1079                 lck->data->changed_write_time = write_time;
1080         }
1081
1082         TALLOC_FREE(lck);
1083         return True;
1084 }
1085
1086 bool set_write_time(struct file_id fileid, struct timespec write_time)
1087 {
1088         struct share_mode_lock *lck;
1089
1090         DEBUG(5,("set_write_time: %s id=%s\n",
1091                  timestring(talloc_tos(),
1092                             convert_timespec_to_time_t(write_time)),
1093                  file_id_string_tos(&fileid)));
1094
1095         lck = get_existing_share_mode_lock(talloc_tos(), fileid);
1096         if (lck == NULL) {
1097                 return False;
1098         }
1099
1100         if (timespec_compare(&lck->data->old_write_time, &write_time) != 0) {
1101                 lck->data->modified = True;
1102                 lck->data->old_write_time = write_time;
1103         }
1104
1105         TALLOC_FREE(lck);
1106         return True;
1107 }