source3/smbd/oplock.c

   1 /*
   2    Unix SMB/CIFS implementation.
   3    oplock processing
   4    Copyright (C) Andrew Tridgell 1992-1998
   5    Copyright (C) Jeremy Allison 1998 - 2001
   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
  22 #define DBGC_CLASS DBGC_LOCKING
  23 #include "includes.h"
  24 #include "lib/util/server_id.h"
  25 #include "smbd/smbd.h"
  26 #include "smbd/globals.h"
  27 #include "messages.h"
  28 #include "../librpc/gen_ndr/ndr_open_files.h"
  29
  30 /*
  31  * helper function used by the kernel oplock backends to post the break message
  32  */
  33 void break_kernel_oplock(struct messaging_context *msg_ctx, files_struct *fsp)
  34 {
  35         uint8_t msg[MSG_SMB_KERNEL_BREAK_SIZE];
  36
  37         /* Put the kernel break info into the message. */
  38         push_file_id_24((char *)msg, &fsp->file_id);
  39         SIVAL(msg,24,fsp->fh->gen_id);
  40
  41         /* Don't need to be root here as we're only ever
  42            sending to ourselves. */
  43
  44         messaging_send_buf(msg_ctx, messaging_server_id(msg_ctx),
  45                            MSG_SMB_KERNEL_BREAK,
  46                            msg, MSG_SMB_KERNEL_BREAK_SIZE);
  47 }
  48
  49 /****************************************************************************
  50  Attempt to set an oplock on a file. Succeeds if kernel oplocks are
  51  disabled (just sets flags).
  52 ****************************************************************************/
  53
  54 NTSTATUS set_file_oplock(files_struct *fsp)
  55 {
  56         struct smbd_server_connection *sconn = fsp->conn->sconn;
  57         struct kernel_oplocks *koplocks = sconn->oplocks.kernel_ops;
  58         bool use_kernel = lp_kernel_oplocks(SNUM(fsp->conn)) &&
  59                         (koplocks != NULL);
  60
  61         if (fsp->oplock_type == LEVEL_II_OPLOCK && use_kernel) {
  62                 DEBUG(10, ("Refusing level2 oplock, kernel oplocks "
  63                            "don't support them\n"));
  64                 return NT_STATUS_NOT_SUPPORTED;
  65         }
  66
  67         if ((fsp->oplock_type != NO_OPLOCK) &&
  68             use_kernel &&
  69             !koplocks->ops->set_oplock(koplocks, fsp, fsp->oplock_type))
  70         {
  71                 return map_nt_error_from_unix(errno);
  72         }
  73
  74         fsp->sent_oplock_break = NO_BREAK_SENT;
  75         if (fsp->oplock_type == LEVEL_II_OPLOCK) {
  76                 sconn->oplocks.level_II_open++;
  77         } else if (EXCLUSIVE_OPLOCK_TYPE(fsp->oplock_type)) {
  78                 sconn->oplocks.exclusive_open++;
  79         }
  80
  81         DEBUG(5,("set_file_oplock: granted oplock on file %s, %s/%lu, "
  82                     "tv_sec = %x, tv_usec = %x\n",
  83                  fsp_str_dbg(fsp), file_id_string_tos(&fsp->file_id),
  84                  fsp->fh->gen_id, (int)fsp->open_time.tv_sec,
  85                  (int)fsp->open_time.tv_usec ));
  86
  87         return NT_STATUS_OK;
  88 }
  89
  90 /****************************************************************************
  91  Attempt to release an oplock on a file. Decrements oplock count.
  92 ****************************************************************************/
  93
  94 static void release_file_oplock(files_struct *fsp)
  95 {
  96         struct smbd_server_connection *sconn = fsp->conn->sconn;
  97         struct kernel_oplocks *koplocks = sconn->oplocks.kernel_ops;
  98         bool use_kernel = lp_kernel_oplocks(SNUM(fsp->conn)) &&
  99                         (koplocks != NULL);
 100
 101         if ((fsp->oplock_type != NO_OPLOCK) &&
 102             use_kernel) {
 103                 koplocks->ops->release_oplock(koplocks, fsp, NO_OPLOCK);
 104         }
 105
 106         if (fsp->oplock_type == LEVEL_II_OPLOCK) {
 107                 sconn->oplocks.level_II_open--;
 108         } else if (EXCLUSIVE_OPLOCK_TYPE(fsp->oplock_type)) {
 109                 sconn->oplocks.exclusive_open--;
 110         }
 111
 112         SMB_ASSERT(sconn->oplocks.exclusive_open>=0);
 113         SMB_ASSERT(sconn->oplocks.level_II_open>=0);
 114
 115         fsp->oplock_type = NO_OPLOCK;
 116         fsp->sent_oplock_break = NO_BREAK_SENT;
 117
 118         flush_write_cache(fsp, SAMBA_OPLOCK_RELEASE_FLUSH);
 119         delete_write_cache(fsp);
 120
 121         TALLOC_FREE(fsp->oplock_timeout);
 122 }
 123
 124 /****************************************************************************
 125  Attempt to downgrade an oplock on a file. Doesn't decrement oplock count.
 126 ****************************************************************************/
 127
 128 static void downgrade_file_oplock(files_struct *fsp)
 129 {
 130         struct smbd_server_connection *sconn = fsp->conn->sconn;
 131         struct kernel_oplocks *koplocks = sconn->oplocks.kernel_ops;
 132         bool use_kernel = lp_kernel_oplocks(SNUM(fsp->conn)) &&
 133                         (koplocks != NULL);
 134
 135         if (!EXCLUSIVE_OPLOCK_TYPE(fsp->oplock_type)) {
 136                 DEBUG(0, ("trying to downgrade an already-downgraded oplock!\n"));
 137                 return;
 138         }
 139
 140         if (use_kernel) {
 141                 koplocks->ops->release_oplock(koplocks, fsp, LEVEL_II_OPLOCK);
 142         }
 143         fsp->oplock_type = LEVEL_II_OPLOCK;
 144         sconn->oplocks.exclusive_open--;
 145         sconn->oplocks.level_II_open++;
 146         fsp->sent_oplock_break = NO_BREAK_SENT;
 147
 148         flush_write_cache(fsp, SAMBA_OPLOCK_RELEASE_FLUSH);
 149         delete_write_cache(fsp);
 150
 151         TALLOC_FREE(fsp->oplock_timeout);
 152 }
 153
 154 uint32_t get_lease_type(const struct share_mode_data *d,
 155                         const struct share_mode_entry *e)
 156 {
 157         if (e->op_type == LEASE_OPLOCK) {
 158                 return d->leases[e->lease_idx].current_state;
 159         }
 160         return map_oplock_to_lease_type(e->op_type);
 161 }
 162
 163 bool update_num_read_oplocks(files_struct *fsp, struct share_mode_lock *lck)
 164 {
 165         struct share_mode_data *d = lck->data;
 166         struct byte_range_lock *br_lck;
 167         uint32_t num_read_oplocks = 0;
 168         uint32_t i;
 169
 170         if (fsp_lease_type_is_exclusive(fsp)) {
 171                 const struct share_mode_entry *e = NULL;
 172                 uint32_t e_lease_type = 0;
 173
 174                 /*
 175                  * If we're fully exclusive, we don't need a brlock entry
 176                  */
 177                 remove_stale_share_mode_entries(d);
 178
 179                 e = find_share_mode_entry(lck, fsp);
 180                 if (e != NULL) {
 181                         e_lease_type = get_lease_type(d, e);
 182                 }
 183
 184                 if (!lease_type_is_exclusive(e_lease_type)) {
 185                         char *timestr = NULL;
 186
 187                         timestr = timeval_string(talloc_tos(),
 188                                                  &fsp->open_time,
 189                                                  true);
 190
 191                         NDR_PRINT_DEBUG(share_mode_data, d);
 192                         DBG_ERR("file [%s] file_id [%s] gen_id [%lu] "
 193                                 "open_time[%s] lease_type [0x%x] "
 194                                 "oplock_type [0x%x]\n",
 195                                 fsp_str_dbg(fsp),
 196                                 file_id_string_tos(&fsp->file_id),
 197                                 fsp->fh->gen_id, timestr,
 198                                 e_lease_type, fsp->oplock_type);
 199
 200                         smb_panic("Found non-exclusive lease");
 201                 }
 202
 203                 return true;
 204         }
 205
 206         for (i=0; i<d->num_share_modes; i++) {
 207                 struct share_mode_entry *e = &d->share_modes[i];
 208                 uint32_t e_lease_type = get_lease_type(d, e);
 209
 210                 if (e_lease_type & SMB2_LEASE_READ) {
 211                         num_read_oplocks += 1;
 212                 }
 213         }
 214
 215         br_lck = brl_get_locks_readonly(fsp);
 216         if (br_lck == NULL) {
 217                 return false;
 218         }
 219         if (brl_num_read_oplocks(br_lck) == num_read_oplocks) {
 220                 return true;
 221         }
 222
 223         br_lck = brl_get_locks(talloc_tos(), fsp);
 224         if (br_lck == NULL) {
 225                 return false;
 226         }
 227         brl_set_num_read_oplocks(br_lck, num_read_oplocks);
 228         TALLOC_FREE(br_lck);
 229         return true;
 230 }
 231
 232 /****************************************************************************
 233  Remove a file oplock with lock already held. Copes with level II and exclusive.
 234 ****************************************************************************/
 235
 236 bool remove_oplock_under_lock(files_struct *fsp, struct share_mode_lock *lck)
 237 {
 238         bool ret;
 239
 240         ret = remove_share_oplock(lck, fsp);
 241         if (!ret) {
 242                 DBG_ERR("failed to remove share oplock for "
 243                         "file %s, %s, %s\n",
 244                         fsp_str_dbg(fsp), fsp_fnum_dbg(fsp),
 245                         file_id_string_tos(&fsp->file_id));
 246         }
 247         release_file_oplock(fsp);
 248
 249         ret = update_num_read_oplocks(fsp, lck);
 250         if (!ret) {
 251                 DBG_ERR("update_num_read_oplocks failed for "
 252                         "file %s, %s, %s\n",
 253                         fsp_str_dbg(fsp), fsp_fnum_dbg(fsp),
 254                         file_id_string_tos(&fsp->file_id));
 255         }
 256
 257         return ret;
 258 }
 259
 260 /****************************************************************************
 261  Remove a file oplock. Copes with level II and exclusive.
 262  Locks then unlocks the share mode lock. Client can decide to go directly
 263  to none even if a "break-to-level II" was sent.
 264 ****************************************************************************/
 265
 266 bool remove_oplock(files_struct *fsp)
 267 {
 268         bool ret;
 269         struct share_mode_lock *lck;
 270
 271         DBG_DEBUG("remove_oplock called for %s\n", fsp_str_dbg(fsp));
 272
 273         /* Remove the oplock flag from the sharemode. */
 274         lck = get_existing_share_mode_lock(talloc_tos(), fsp->file_id);
 275         if (lck == NULL) {
 276                 DBG_ERR("failed to lock share entry for "
 277                          "file %s\n", fsp_str_dbg(fsp));
 278                 return false;
 279         }
 280
 281         ret = remove_oplock_under_lock(fsp, lck);
 282
 283         TALLOC_FREE(lck);
 284         return ret;
 285 }
 286
 287 /*
 288  * Deal with a reply when a break-to-level II was sent.
 289  */
 290 bool downgrade_oplock(files_struct *fsp)
 291 {
 292         bool ret;
 293         struct share_mode_lock *lck;
 294
 295         DEBUG(10, ("downgrade_oplock called for %s\n",
 296                    fsp_str_dbg(fsp)));
 297
 298         lck = get_existing_share_mode_lock(talloc_tos(), fsp->file_id);
 299         if (lck == NULL) {
 300                 DEBUG(0,("downgrade_oplock: failed to lock share entry for "
 301                          "file %s\n", fsp_str_dbg(fsp)));
 302                 return False;
 303         }
 304         ret = downgrade_share_oplock(lck, fsp);
 305         if (!ret) {
 306                 DEBUG(0,("downgrade_oplock: failed to downgrade share oplock "
 307                          "for file %s, %s, file_id %s\n",
 308                          fsp_str_dbg(fsp), fsp_fnum_dbg(fsp),
 309                          file_id_string_tos(&fsp->file_id)));
 310         }
 311         downgrade_file_oplock(fsp);
 312
 313         ret = update_num_read_oplocks(fsp, lck);
 314         if (!ret) {
 315                 DEBUG(0, ("%s: update_num_read_oplocks failed for "
 316                          "file %s, %s, %s\n",
 317                           __func__, fsp_str_dbg(fsp), fsp_fnum_dbg(fsp),
 318                          file_id_string_tos(&fsp->file_id)));
 319         }
 320
 321         TALLOC_FREE(lck);
 322         return ret;
 323 }
 324
 325 static void lease_timeout_handler(struct tevent_context *ctx,
 326                                   struct tevent_timer *te,
 327                                   struct timeval now,
 328                                   void *private_data)
 329 {
 330         struct fsp_lease *lease =
 331                 talloc_get_type_abort(private_data,
 332                 struct fsp_lease);
 333         struct files_struct *fsp;
 334         struct share_mode_lock *lck;
 335         uint16_t old_epoch = lease->lease.lease_epoch;
 336
 337         /*
 338          * This function runs without any specific impersonation
 339          * and must not call any SMB_VFS operations!
 340          */
 341
 342         fsp = file_find_one_fsp_from_lease_key(lease->sconn,
 343                                                &lease->lease.lease_key);
 344         if (fsp == NULL) {
 345                 /* race? */
 346                 TALLOC_FREE(lease->timeout);
 347                 return;
 348         }
 349
 350         /*
 351          * Paranoia check: There can only be one fsp_lease per lease
 352          * key
 353          */
 354         SMB_ASSERT(fsp->lease == lease);
 355
 356         lck = get_existing_share_mode_lock(
 357                         talloc_tos(), fsp->file_id);
 358         if (lck == NULL) {
 359                 /* race? */
 360                 TALLOC_FREE(lease->timeout);
 361                 return;
 362         }
 363
 364         fsp_lease_update(lck, fsp_client_guid(fsp), lease);
 365
 366         if (lease->lease.lease_epoch != old_epoch) {
 367                 /*
 368                  * If the epoch changed we need to wait for
 369                  * the next timeout to happen.
 370                  */
 371                 DEBUG(10, ("lease break timeout race (epoch) for file %s - ignoring\n",
 372                            fsp_str_dbg(fsp)));
 373                 TALLOC_FREE(lck);
 374                 return;
 375         }
 376
 377         if (!(lease->lease.lease_flags & SMB2_LEASE_FLAG_BREAK_IN_PROGRESS)) {
 378                 /*
 379                  * If the epoch changed we need to wait for
 380                  * the next timeout to happen.
 381                  */
 382                 DEBUG(10, ("lease break timeout race (flags) for file %s - ignoring\n",
 383                            fsp_str_dbg(fsp)));
 384                 TALLOC_FREE(lck);
 385                 return;
 386         }
 387
 388         DEBUG(1, ("lease break timed out for file %s -- replying anyway\n",
 389                   fsp_str_dbg(fsp)));
 390         (void)downgrade_lease(lease->sconn->client->connections,
 391                         1,
 392                         &fsp->file_id,
 393                         &lease->lease.lease_key,
 394                         SMB2_LEASE_NONE);
 395
 396         TALLOC_FREE(lck);
 397 }
 398
 399 bool fsp_lease_update(struct share_mode_lock *lck,
 400                       const struct GUID *client_guid,
 401                       struct fsp_lease *lease)
 402 {
 403         struct share_mode_data *d = lck->data;
 404         int idx;
 405         struct share_mode_lease *l = NULL;
 406
 407         idx = find_share_mode_lease(d, client_guid, &lease->lease.lease_key);
 408         if (idx == -1) {
 409                 DEBUG(1, ("%s: Could not find lease entry\n", __func__));
 410                 TALLOC_FREE(lease->timeout);
 411                 lease->lease.lease_state = SMB2_LEASE_NONE;
 412                 lease->lease.lease_epoch += 1;
 413                 lease->lease.lease_flags = 0;
 414                 return false;
 415         }
 416
 417         l = &d->leases[idx];
 418
 419         DEBUG(10,("%s: refresh lease state\n", __func__));
 420
 421         /* Ensure we're in sync with current lease state. */
 422         if (lease->lease.lease_epoch != l->epoch) {
 423                 DEBUG(10,("%s: cancel outdated timeout\n", __func__));
 424                 TALLOC_FREE(lease->timeout);
 425         }
 426         lease->lease.lease_epoch = l->epoch;
 427         lease->lease.lease_state = l->current_state;
 428
 429         if (l->breaking) {
 430                 lease->lease.lease_flags |= SMB2_LEASE_FLAG_BREAK_IN_PROGRESS;
 431
 432                 if (lease->timeout == NULL) {
 433                         struct timeval t = timeval_current_ofs(OPLOCK_BREAK_TIMEOUT, 0);
 434
 435                         DEBUG(10,("%s: setup timeout handler\n", __func__));
 436
 437                         /*
 438                          * lease_timeout_handler() only accesses locking.tdb
 439                          * so we don't use any impersonation and use
 440                          * the raw tevent context.
 441                          */
 442                         lease->timeout = tevent_add_timer(lease->sconn->raw_ev_ctx,
 443                                                           lease, t,
 444                                                           lease_timeout_handler,
 445                                                           lease);
 446                         if (lease->timeout == NULL) {
 447                                 DEBUG(0, ("%s: Could not add lease timeout handler\n",
 448                                           __func__));
 449                         }
 450                 }
 451         } else {
 452                 lease->lease.lease_flags &= ~SMB2_LEASE_FLAG_BREAK_IN_PROGRESS;
 453                 TALLOC_FREE(lease->timeout);
 454         }
 455
 456         return true;
 457 }
 458
 459 struct downgrade_lease_additional_state {
 460         struct tevent_immediate *im;
 461         struct smbXsrv_connection *xconn;
 462         uint32_t break_flags;
 463         struct smb2_lease_key lease_key;
 464         uint32_t break_from;
 465         uint32_t break_to;
 466         uint16_t new_epoch;
 467 };
 468
 469 static void downgrade_lease_additional_trigger(struct tevent_context *ev,
 470                                                struct tevent_immediate *im,
 471                                                void *private_data)
 472 {
 473         struct downgrade_lease_additional_state *state =
 474                 talloc_get_type_abort(private_data,
 475                 struct downgrade_lease_additional_state);
 476         struct smbXsrv_connection *xconn = state->xconn;
 477         NTSTATUS status;
 478
 479         status = smbd_smb2_send_lease_break(xconn,
 480                                             state->new_epoch,
 481                                             state->break_flags,
 482                                             &state->lease_key,
 483                                             state->break_from,
 484                                             state->break_to);
 485         TALLOC_FREE(state);
 486         if (!NT_STATUS_IS_OK(status)) {
 487                 smbd_server_connection_terminate(xconn,
 488                                                  nt_errstr(status));
 489                 return;
 490         }
 491 }
 492
 493 struct downgrade_lease_fsps_state {
 494         struct file_id id;
 495         struct share_mode_lock *lck;
 496         const struct smb2_lease_key *key;
 497 };
 498
 499 static struct files_struct *downgrade_lease_fsps(struct files_struct *fsp,
 500                                                  void *private_data)
 501 {
 502         struct downgrade_lease_fsps_state *state =
 503                 (struct downgrade_lease_fsps_state *)private_data;
 504
 505         if (fsp->oplock_type != LEASE_OPLOCK) {
 506                 return NULL;
 507         }
 508         if (!smb2_lease_key_equal(&fsp->lease->lease.lease_key, state->key)) {
 509                 return NULL;
 510         }
 511         if (!file_id_equal(&fsp->file_id, &state->id)) {
 512                 return NULL;
 513         }
 514
 515         fsp_lease_update(state->lck, fsp_client_guid(fsp), fsp->lease);
 516
 517         return NULL;
 518 }
 519
 520 NTSTATUS downgrade_lease(struct smbXsrv_connection *xconn,
 521                          uint32_t num_file_ids,
 522                          const struct file_id *ids,
 523                          const struct smb2_lease_key *key,
 524                          uint32_t lease_state)
 525 {
 526         struct smbd_server_connection *sconn = xconn->client->sconn;
 527         struct share_mode_lock *lck;
 528         struct share_mode_data *d = NULL;
 529         struct share_mode_lease *l = NULL;
 530         const struct file_id id = ids[0];
 531         int idx;
 532         uint32_t i;
 533         NTSTATUS status;
 534
 535         DEBUG(10, ("%s: Downgrading %s to %x\n", __func__,
 536                    file_id_string_tos(&id), (unsigned)lease_state));
 537
 538         lck = get_existing_share_mode_lock(talloc_tos(), id);
 539         if (lck == NULL) {
 540                 return NT_STATUS_OBJECT_NAME_NOT_FOUND;
 541         }
 542         d = lck->data;
 543
 544         idx = find_share_mode_lease(
 545                 d, &sconn->client->connections->smb2.client.guid, key);
 546         if (idx == -1) {
 547                 DEBUG(10, ("lease not found\n"));
 548                 return NT_STATUS_INVALID_PARAMETER;
 549         }
 550         l = &d->leases[idx];
 551
 552         if (!l->breaking) {
 553                 DBG_WARNING("Attempt to break from %"PRIu32" to %"PRIu32" - "
 554                             "but we're not in breaking state\n",
 555                             l->current_state, lease_state);
 556                 TALLOC_FREE(lck);
 557                 return NT_STATUS_UNSUCCESSFUL;
 558         }
 559
 560         /*
 561          * Can't upgrade anything: l->breaking_to_requested (and l->current_state)
 562          * must be a strict bitwise superset of new_lease_state
 563          */
 564         if ((lease_state & l->breaking_to_requested) != lease_state) {
 565                 DBG_WARNING("Attempt to upgrade from %"PRIu32" to %"PRIu32" "
 566                             "- expected %"PRIu32"\n",
 567                             l->current_state, lease_state,
 568                             l->breaking_to_requested);
 569                 TALLOC_FREE(lck);
 570                 return NT_STATUS_REQUEST_NOT_ACCEPTED;
 571         }
 572
 573         if (l->current_state != lease_state) {
 574                 l->current_state = lease_state;
 575                 d->modified = true;
 576         }
 577
 578         status = NT_STATUS_OK;
 579
 580         d->modified = true;
 581
 582         if ((lease_state & ~l->breaking_to_required) != 0) {
 583                 struct downgrade_lease_additional_state *state;
 584
 585                 DBG_INFO("lease state %"PRIu32" not fully broken from "
 586                          "%"PRIu32" to %"PRIu32"\n",
 587                          lease_state,
 588                          l->current_state,
 589                          l->breaking_to_required);
 590
 591                 l->breaking_to_requested = l->breaking_to_required;
 592
 593                 if (l->current_state & (SMB2_LEASE_WRITE|SMB2_LEASE_HANDLE)) {
 594                         /*
 595                          * Here we break in steps, as windows does
 596                          * see the breaking3 and v2_breaking3 tests.
 597                          */
 598                         l->breaking_to_requested |= SMB2_LEASE_READ;
 599                 }
 600
 601                 state = talloc_zero(xconn,
 602                                     struct downgrade_lease_additional_state);
 603                 if (state == NULL) {
 604                         TALLOC_FREE(lck);
 605                         return NT_STATUS_NO_MEMORY;
 606                 }
 607
 608                 state->im = tevent_create_immediate(state);
 609                 if (state->im == NULL) {
 610                         TALLOC_FREE(state);
 611                         TALLOC_FREE(lck);
 612                         return NT_STATUS_NO_MEMORY;
 613                 }
 614
 615                 state->xconn = xconn;
 616                 state->lease_key = l->lease_key;
 617                 state->break_from = l->current_state;
 618                 state->break_to = l->breaking_to_requested;
 619                 if (l->lease_version > 1) {
 620                         state->new_epoch = l->epoch;
 621                 }
 622
 623                 if (l->current_state & (SMB2_LEASE_WRITE|SMB2_LEASE_HANDLE)) {
 624                         state->break_flags =
 625                                 SMB2_NOTIFY_BREAK_LEASE_FLAG_ACK_REQUIRED;
 626                 } else {
 627                         /*
 628                          * This is an async break without
 629                          * SMB2_NOTIFY_BREAK_LEASE_FLAG_ACK_REQUIRED
 630                          *
 631                          * we need to store NONE state in the
 632                          * database.
 633                          */
 634                         l->current_state = 0;
 635                         l->breaking_to_requested = 0;
 636                         l->breaking_to_required = 0;
 637                         l->breaking = false;
 638
 639                         lck->data->modified = true;
 640                 }
 641
 642                 tevent_schedule_immediate(state->im,
 643                                           xconn->client->raw_ev_ctx,
 644                                           downgrade_lease_additional_trigger,
 645                                           state);
 646
 647                 status = NT_STATUS_OPLOCK_BREAK_IN_PROGRESS;
 648         } else {
 649                 DBG_DEBUG("breaking from %"PRIu32" to %"PRIu32" - "
 650                           "expected %"PRIu32"\n",
 651                           l->current_state,
 652                           lease_state,
 653                           l->breaking_to_requested);
 654
 655                 l->breaking_to_requested = 0;
 656                 l->breaking_to_required = 0;
 657                 l->breaking = false;
 658
 659                 d->modified = true;
 660         }
 661
 662         DEBUG(10, ("%s: Downgrading %s to %x => %s\n", __func__,
 663                    file_id_string_tos(&id), (unsigned)lease_state, nt_errstr(status)));
 664
 665         {
 666                 struct downgrade_lease_fsps_state state = {
 667                         .id = id, .lck = lck, .key = key,
 668                 };
 669
 670                 files_forall(sconn, downgrade_lease_fsps, &state);
 671         }
 672
 673         TALLOC_FREE(lck);
 674         DEBUG(10, ("%s: Downgrading %s to %x => %s\n", __func__,
 675                    file_id_string_tos(&id), (unsigned)lease_state, nt_errstr(status)));
 676
 677         /*
 678          * Dynamic share case. Ensure other opens are copies.
 679          * This will only be breaking to NONE.
 680          */
 681
 682         for (i = 1; i < num_file_ids; i++) {
 683                 lck = get_existing_share_mode_lock(talloc_tos(), ids[i]);
 684                 if (lck == NULL) {
 685                         return NT_STATUS_OBJECT_NAME_NOT_FOUND;
 686                 }
 687
 688                 {
 689                         struct downgrade_lease_fsps_state state = {
 690                                 .id = ids[i], .lck = lck, .key = key,
 691                         };
 692
 693                         files_forall(sconn, downgrade_lease_fsps, &state);
 694                 }
 695
 696                 DEBUG(10, ("%s: Downgrading %s to %x => %s\n", __func__,
 697                         file_id_string_tos(&ids[i]), (unsigned)lease_state, nt_errstr(status)));
 698
 699                 TALLOC_FREE(lck);
 700         }
 701
 702         return status;
 703 }
 704
 705 /****************************************************************************
 706  Set up an oplock break message.
 707 ****************************************************************************/
 708
 709 #define SMB1_BREAK_MESSAGE_LENGTH (smb_size + 8*2)
 710
 711 static void new_break_message_smb1(files_struct *fsp, int cmd,
 712                                    char result[SMB1_BREAK_MESSAGE_LENGTH])
 713 {
 714         memset(result,'\0',smb_size);
 715         srv_set_message(result,8,0,true);
 716         SCVAL(result,smb_com,SMBlockingX);
 717         SSVAL(result,smb_tid,fsp->conn->cnum);
 718         SSVAL(result,smb_pid,0xFFFF);
 719         SSVAL(result,smb_uid,0);
 720         SSVAL(result,smb_mid,0xFFFF);
 721         SCVAL(result,smb_vwv0,0xFF);
 722         SSVAL(result,smb_vwv2,fsp->fnum);
 723         SCVAL(result,smb_vwv3,LOCKING_ANDX_OPLOCK_RELEASE);
 724         SCVAL(result,smb_vwv3+1,cmd);
 725 }
 726
 727 /****************************************************************************
 728  Function to do the waiting before sending a local break.
 729 ****************************************************************************/
 730
 731 static void wait_before_sending_break(void)
 732 {
 733         long wait_time = (long)lp_oplock_break_wait_time();
 734
 735         if (wait_time) {
 736                 smb_msleep(wait_time);
 737         }
 738 }
 739
 740 /****************************************************************************
 741  Ensure that we have a valid oplock.
 742 ****************************************************************************/
 743
 744 static files_struct *initial_break_processing(
 745         struct smbd_server_connection *sconn, struct file_id id,
 746         unsigned long file_id)
 747 {
 748         files_struct *fsp = NULL;
 749
 750         DEBUG(3, ("initial_break_processing: called for %s/%u\n"
 751                   "Current oplocks_open (exclusive = %d, levelII = %d)\n",
 752                   file_id_string_tos(&id), (int)file_id,
 753                   sconn->oplocks.exclusive_open,
 754                   sconn->oplocks.level_II_open));
 755
 756         /*
 757          * We need to search the file open table for the
 758          * entry containing this dev and inode, and ensure
 759          * we have an oplock on it.
 760          */
 761
 762         fsp = file_find_dif(sconn, id, file_id);
 763
 764         if(fsp == NULL) {
 765                 /* The file could have been closed in the meantime - return success. */
 766                 DEBUG(3, ("initial_break_processing: cannot find open file "
 767                           "with file_id %s gen_id = %lu, allowing break to "
 768                           "succeed.\n", file_id_string_tos(&id), file_id));
 769                 return NULL;
 770         }
 771
 772         /* Ensure we have an oplock on the file */
 773
 774         /*
 775          * There is a potential race condition in that an oplock could
 776          * have been broken due to another udp request, and yet there are
 777          * still oplock break messages being sent in the udp message
 778          * queue for this file. So return true if we don't have an oplock,
 779          * as we may have just freed it.
 780          */
 781
 782         if(fsp->oplock_type == NO_OPLOCK) {
 783                 DEBUG(3, ("initial_break_processing: file %s (file_id = %s "
 784                           "gen_id = %lu) has no oplock. Allowing break to "
 785                           "succeed regardless.\n", fsp_str_dbg(fsp),
 786                           file_id_string_tos(&id), fsp->fh->gen_id));
 787                 return NULL;
 788         }
 789
 790         return fsp;
 791 }
 792
 793 static void oplock_timeout_handler(struct tevent_context *ctx,
 794                                    struct tevent_timer *te,
 795                                    struct timeval now,
 796                                    void *private_data)
 797 {
 798         files_struct *fsp = (files_struct *)private_data;
 799
 800         /*
 801          * Note this function doesn't run under any specific impersonation and
 802          * is not expected to call any SMB_VFS operation!
 803          */
 804
 805         SMB_ASSERT(fsp->sent_oplock_break != NO_BREAK_SENT);
 806
 807         /* Remove the timed event handler. */
 808         TALLOC_FREE(fsp->oplock_timeout);
 809         DEBUG(0, ("Oplock break failed for file %s -- replying anyway\n",
 810                   fsp_str_dbg(fsp)));
 811         remove_oplock(fsp);
 812 }
 813
 814 /*******************************************************************
 815  Add a timeout handler waiting for the client reply.
 816 *******************************************************************/
 817
 818 static void add_oplock_timeout_handler(files_struct *fsp)
 819 {
 820         if (fsp->oplock_timeout != NULL) {
 821                 DEBUG(0, ("Logic problem -- have an oplock event hanging "
 822                           "around\n"));
 823         }
 824
 825         /*
 826          * For now we keep the logic and use the
 827          * raw event context. We're called from
 828          * the messaging system from a raw event context.
 829          * Also oplock_timeout_handler doesn't invoke
 830          * SMB_VFS calls.
 831          */
 832         fsp->oplock_timeout =
 833                 tevent_add_timer(fsp->conn->sconn->raw_ev_ctx, fsp,
 834                                  timeval_current_ofs(OPLOCK_BREAK_TIMEOUT, 0),
 835                                  oplock_timeout_handler, fsp);
 836
 837         if (fsp->oplock_timeout == NULL) {
 838                 DEBUG(0, ("Could not add oplock timeout handler\n"));
 839         }
 840 }
 841
 842 static void send_break_message_smb1(files_struct *fsp, int level)
 843 {
 844         struct smbXsrv_connection *xconn = NULL;
 845         char break_msg[SMB1_BREAK_MESSAGE_LENGTH];
 846
 847         /*
 848          * For SMB1 we only have one connection
 849          */
 850         xconn = fsp->conn->sconn->client->connections;
 851
 852         new_break_message_smb1(fsp, level, break_msg);
 853
 854         show_msg(break_msg);
 855         if (!srv_send_smb(xconn,
 856                         break_msg, false, 0,
 857                         IS_CONN_ENCRYPTED(fsp->conn),
 858                         NULL)) {
 859                 exit_server_cleanly("send_break_message_smb1: "
 860                         "srv_send_smb failed.");
 861         }
 862 }
 863
 864 /*******************************************************************
 865  This handles the generic oplock break message from another smbd.
 866 *******************************************************************/
 867
 868 static void process_oplock_break_message(struct messaging_context *msg_ctx,
 869                                          void *private_data,
 870                                          uint32_t msg_type,
 871                                          struct server_id src,
 872                                          DATA_BLOB *data)
 873 {
 874         struct file_id id;
 875         struct share_mode_entry msg;
 876         files_struct *fsp;
 877         bool use_kernel;
 878         struct smbd_server_connection *sconn =
 879                 talloc_get_type_abort(private_data,
 880                 struct smbd_server_connection);
 881         struct server_id self = messaging_server_id(sconn->msg_ctx);
 882         struct kernel_oplocks *koplocks = sconn->oplocks.kernel_ops;
 883         uint16_t break_from;
 884         uint16_t break_to;
 885         bool break_needed = true;
 886         struct server_id_buf tmp;
 887
 888         if (data->data == NULL) {
 889                 DEBUG(0, ("Got NULL buffer\n"));
 890                 return;
 891         }
 892
 893         if (data->length != MSG_SMB_SHARE_MODE_ENTRY_SIZE) {
 894                 DEBUG(0, ("Got invalid msg len %d\n", (int)data->length));
 895                 return;
 896         }
 897
 898         /* De-linearize incoming message. */
 899         message_to_share_mode_entry(&id, &msg, (char *)data->data);
 900         break_to = msg.op_type;
 901
 902         DEBUG(10, ("Got oplock break to %u message from pid %s: %s/%llu\n",
 903                    (unsigned)break_to, server_id_str_buf(src, &tmp),
 904                    file_id_string_tos(&id),
 905                    (unsigned long long)msg.share_file_id));
 906
 907         fsp = initial_break_processing(sconn, id, msg.share_file_id);
 908
 909         if (fsp == NULL) {
 910                 /* We hit a race here. Break messages are sent, and before we
 911                  * get to process this message, we have closed the file. */
 912                 DEBUG(3, ("Did not find fsp\n"));
 913                 return;
 914         }
 915
 916         break_from = fsp_lease_type(fsp);
 917
 918         if (fsp->oplock_type != LEASE_OPLOCK) {
 919                 if (fsp->sent_oplock_break != NO_BREAK_SENT) {
 920                         /*
 921                          * Nothing to do anymore
 922                          */
 923                         DEBUG(10, ("fsp->sent_oplock_break = %d\n",
 924                                    fsp->sent_oplock_break));
 925                         return;
 926                 }
 927         }
 928
 929         if (!(global_client_caps & CAP_LEVEL_II_OPLOCKS)) {
 930                 DEBUG(10, ("client_caps without level2 oplocks\n"));
 931                 break_to &= ~SMB2_LEASE_READ;
 932         }
 933
 934         use_kernel = lp_kernel_oplocks(SNUM(fsp->conn)) &&
 935                         (koplocks != NULL);
 936         if (use_kernel) {
 937                 DEBUG(10, ("Kernel oplocks don't allow level2\n"));
 938                 break_to &= ~SMB2_LEASE_READ;
 939         }
 940
 941         if (!lp_level2_oplocks(SNUM(fsp->conn))) {
 942                 DEBUG(10, ("no level2 oplocks by config\n"));
 943                 break_to &= ~SMB2_LEASE_READ;
 944         }
 945
 946         if (fsp->oplock_type == LEASE_OPLOCK) {
 947                 struct share_mode_lock *lck;
 948                 int idx;
 949
 950                 lck = get_existing_share_mode_lock(
 951                         talloc_tos(), fsp->file_id);
 952                 if (lck == NULL) {
 953                         /*
 954                          * We hit a race here. Break messages are sent, and
 955                          * before we get to process this message, we have closed
 956                          * the file.
 957                          */
 958                         DEBUG(3, ("Did not find share_mode\n"));
 959                         return;
 960                 }
 961
 962                 idx = find_share_mode_lease(
 963                         lck->data,
 964                         fsp_client_guid(fsp),
 965                         &fsp->lease->lease.lease_key);
 966                 if (idx != -1) {
 967                         struct share_mode_lease *l;
 968                         l = &lck->data->leases[idx];
 969
 970                         break_from = l->current_state;
 971                         break_to &= l->current_state;
 972
 973                         if (l->breaking) {
 974                                 break_to &= l->breaking_to_required;
 975                                 if (l->breaking_to_required != break_to) {
 976                                         /*
 977                                          * Note we don't increment the epoch
 978                                          * here, which might be a bug in
 979                                          * Windows too...
 980                                          */
 981                                         l->breaking_to_required = break_to;
 982                                         lck->data->modified = true;
 983                                 }
 984                                 break_needed = false;
 985                         } else if (l->current_state == break_to) {
 986                                 break_needed = false;
 987                         } else if (l->current_state == SMB2_LEASE_READ) {
 988                                 l->current_state = SMB2_LEASE_NONE;
 989                                 /* Need to increment the epoch */
 990                                 l->epoch += 1;
 991                                 lck->data->modified = true;
 992                         } else {
 993                                 l->breaking = true;
 994                                 l->breaking_to_required = break_to;
 995                                 l->breaking_to_requested = break_to;
 996                                 /* Need to increment the epoch */
 997                                 l->epoch += 1;
 998                                 lck->data->modified = true;
 999                         }
1000
1001                         /* Ensure we're in sync with current lease state. */
1002                         fsp_lease_update(lck, fsp_client_guid(fsp), fsp->lease);
1003                 }
1004
1005                 TALLOC_FREE(lck);
1006         }
1007
1008         if (!break_needed) {
1009                 DEBUG(10,("%s: skip break\n", __func__));
1010                 return;
1011         }
1012
1013         if ((break_from == SMB2_LEASE_NONE) && !break_needed) {
1014                 DEBUG(3, ("Already downgraded oplock to none on %s: %s\n",
1015                           file_id_string_tos(&fsp->file_id),
1016                           fsp_str_dbg(fsp)));
1017                 return;
1018         }
1019
1020         DEBUG(10, ("break_from=%u, break_to=%u\n",
1021                    (unsigned)break_from, (unsigned)break_to));
1022
1023         if ((break_from == break_to) && !break_needed) {
1024                 DEBUG(3, ("Already downgraded oplock to %u on %s: %s\n",
1025                           (unsigned)break_to,
1026                           file_id_string_tos(&fsp->file_id),
1027                           fsp_str_dbg(fsp)));
1028                 return;
1029         }
1030
1031         /* Need to wait before sending a break
1032            message if we sent ourselves this message. */
1033         if (serverid_equal(&self, &src)) {
1034                 wait_before_sending_break();
1035         }
1036
1037         if (sconn->using_smb2) {
1038                 send_break_message_smb2(fsp, break_from, break_to);
1039         } else {
1040                 send_break_message_smb1(fsp, (break_to & SMB2_LEASE_READ) ?
1041                                         OPLOCKLEVEL_II : OPLOCKLEVEL_NONE);
1042         }
1043
1044         if ((break_from == SMB2_LEASE_READ) &&
1045             (break_to == SMB2_LEASE_NONE)) {
1046                 /*
1047                  * This is an async break without a reply and thus no timeout
1048                  *
1049                  * leases are handled above.
1050                  */
1051                 if (fsp->oplock_type != LEASE_OPLOCK) {
1052                         remove_oplock(fsp);
1053                 }
1054                 return;
1055         }
1056         if (fsp->oplock_type == LEASE_OPLOCK) {
1057                 return;
1058         }
1059
1060         fsp->sent_oplock_break = (break_to & SMB2_LEASE_READ) ?
1061                 LEVEL_II_BREAK_SENT:BREAK_TO_NONE_SENT;
1062
1063         add_oplock_timeout_handler(fsp);
1064 }
1065
1066 /*******************************************************************
1067  This handles the kernel oplock break message.
1068 *******************************************************************/
1069
1070 static void process_kernel_oplock_break(struct messaging_context *msg_ctx,
1071                                         void *private_data,
1072                                         uint32_t msg_type,
1073                                         struct server_id src,
1074                                         DATA_BLOB *data)
1075 {
1076         struct file_id id;
1077         unsigned long file_id;
1078         files_struct *fsp;
1079         struct smbd_server_connection *sconn =
1080                 talloc_get_type_abort(private_data,
1081                 struct smbd_server_connection);
1082         struct server_id_buf tmp;
1083
1084         if (data->data == NULL) {
1085                 DEBUG(0, ("Got NULL buffer\n"));
1086                 return;
1087         }
1088
1089         if (data->length != MSG_SMB_KERNEL_BREAK_SIZE) {
1090                 DEBUG(0, ("Got invalid msg len %d\n", (int)data->length));
1091                 return;
1092         }
1093
1094         /* Pull the data from the message. */
1095         pull_file_id_24((char *)data->data, &id);
1096         file_id = (unsigned long)IVAL(data->data, 24);
1097
1098         DEBUG(10, ("Got kernel oplock break message from pid %s: %s/%u\n",
1099                    server_id_str_buf(src, &tmp), file_id_string_tos(&id),
1100                    (unsigned int)file_id));
1101
1102         fsp = initial_break_processing(sconn, id, file_id);
1103
1104         if (fsp == NULL) {
1105                 DEBUG(3, ("Got a kernel oplock break message for a file "
1106                           "I don't know about\n"));
1107                 return;
1108         }
1109
1110         if (fsp->sent_oplock_break != NO_BREAK_SENT) {
1111                 /* This is ok, kernel oplocks come in completely async */
1112                 DEBUG(3, ("Got a kernel oplock request while waiting for a "
1113                           "break reply\n"));
1114                 return;
1115         }
1116
1117         if (sconn->using_smb2) {
1118                 send_break_message_smb2(fsp, 0, OPLOCKLEVEL_NONE);
1119         } else {
1120                 send_break_message_smb1(fsp, OPLOCKLEVEL_NONE);
1121         }
1122
1123         fsp->sent_oplock_break = BREAK_TO_NONE_SENT;
1124
1125         add_oplock_timeout_handler(fsp);
1126 }
1127
1128 static bool file_has_read_oplocks(struct files_struct *fsp)
1129 {
1130         struct byte_range_lock *brl;
1131         uint32_t num_read_oplocks = 0;
1132
1133         brl = brl_get_locks_readonly(fsp);
1134         if (brl == NULL) {
1135                 return false;
1136         }
1137
1138         num_read_oplocks = brl_num_read_oplocks(brl);
1139
1140         DBG_DEBUG("num_read_oplocks = %"PRIu32"\n", num_read_oplocks);
1141
1142         return (num_read_oplocks != 0);
1143 }
1144
1145 struct break_to_none_state {
1146         struct smbd_server_connection *sconn;
1147         struct file_id id;
1148         struct smb2_lease_key lease_key;
1149         struct GUID client_guid;
1150 };
1151 static void do_break_to_none(struct tevent_context *ctx,
1152                              struct tevent_immediate *im,
1153                              void *private_data);
1154
1155 /****************************************************************************
1156  This function is called on any file modification or lock request. If a file
1157  is level 2 oplocked then it must tell all other level 2 holders to break to
1158  none.
1159 ****************************************************************************/
1160
1161 static void contend_level2_oplocks_begin_default(files_struct *fsp,
1162                                               enum level2_contention_type type)
1163 {
1164         struct smbd_server_connection *sconn = fsp->conn->sconn;
1165         struct tevent_immediate *im;
1166         struct break_to_none_state *state;
1167         bool has_read_oplocks;
1168
1169         /*
1170          * If this file is level II oplocked then we need
1171          * to grab the shared memory lock and inform all
1172          * other files with a level II lock that they need
1173          * to flush their read caches. We keep the lock over
1174          * the shared memory area whilst doing this.
1175          */
1176
1177         if (fsp_lease_type_is_exclusive(fsp)) {
1178                 /*
1179                  * There can't be any level2 oplocks, we're alone.
1180                  */
1181                 return;
1182         }
1183
1184         has_read_oplocks = file_has_read_oplocks(fsp);
1185         if (!has_read_oplocks) {
1186                 DEBUG(10, ("No read oplocks around\n"));
1187                 return;
1188         }
1189
1190         /*
1191          * When we get here we might have a brlock entry locked. Also
1192          * locking the share mode entry would violate the locking
1193          * order. Breaking level2 oplocks to none is asynchronous
1194          * anyway, so we postpone this into an immediate event.
1195          */
1196
1197         state = talloc_zero(sconn, struct break_to_none_state);
1198         if (state == NULL) {
1199                 DEBUG(1, ("talloc failed\n"));
1200                 return;
1201         }
1202         state->sconn = sconn;
1203         state->id = fsp->file_id;
1204
1205         if (fsp->oplock_type == LEASE_OPLOCK) {
1206                 state->client_guid = *fsp_client_guid(fsp);
1207                 state->lease_key = fsp->lease->lease.lease_key;
1208                 DEBUG(10, ("Breaking through lease key %"PRIu64"/%"PRIu64"\n",
1209                            state->lease_key.data[0],
1210                            state->lease_key.data[1]));
1211         }
1212
1213         im = tevent_create_immediate(state);
1214         if (im == NULL) {
1215                 DEBUG(1, ("tevent_create_immediate failed\n"));
1216                 TALLOC_FREE(state);
1217                 return;
1218         }
1219
1220         /*
1221          * do_break_to_none() only operates on the
1222          * locking.tdb and sends network packets to
1223          * the client. That doesn't require any
1224          * impersonation, so we just use the
1225          * raw tevent context here.
1226          */
1227         tevent_schedule_immediate(im, sconn->raw_ev_ctx, do_break_to_none, state);
1228 }
1229
1230 static void send_break_to_none(struct messaging_context *msg_ctx,
1231                                const struct file_id *id,
1232                                const struct share_mode_entry *e)
1233 {
1234         char msg[MSG_SMB_SHARE_MODE_ENTRY_SIZE];
1235
1236         share_mode_entry_to_message(msg, id, e);
1237         /* Overload entry->op_type */
1238         SSVAL(msg, OP_BREAK_MSG_OP_TYPE_OFFSET, NO_OPLOCK);
1239
1240         messaging_send_buf(msg_ctx, e->pid, MSG_SMB_BREAK_REQUEST,
1241                            (uint8_t *)msg, sizeof(msg));
1242 }
1243
1244 static void do_break_to_none(struct tevent_context *ctx,
1245                              struct tevent_immediate *im,
1246                              void *private_data)
1247 {
1248         struct break_to_none_state *state = talloc_get_type_abort(
1249                 private_data, struct break_to_none_state);
1250         uint32_t i;
1251         struct share_mode_lock *lck;
1252         struct share_mode_data *d;
1253
1254         /*
1255          * Note this function doesn't run under any specific impersonation and
1256          * is not expected to call any SMB_VFS operation!
1257          */
1258
1259         lck = get_existing_share_mode_lock(talloc_tos(), state->id);
1260         if (lck == NULL) {
1261                 DEBUG(1, ("%s: failed to lock share mode entry for file %s.\n",
1262                           __func__, file_id_string_tos(&state->id)));
1263                 goto done;
1264         }
1265         d = lck->data;
1266
1267         /*
1268          * Walk leases and oplocks separately: We have to send one break per
1269          * lease. If we have multiple share_mode_entry having a common lease,
1270          * we would break the lease twice if we don't walk the leases list
1271          * separately.
1272          */
1273
1274         for (i=0; i<d->num_leases; i++) {
1275                 struct share_mode_lease *l = &d->leases[i];
1276                 struct share_mode_entry *e = NULL;
1277                 uint32_t j;
1278
1279                 if ((l->current_state & SMB2_LEASE_READ) == 0) {
1280                         continue;
1281                 }
1282                 if (smb2_lease_equal(&state->client_guid,
1283                                      &state->lease_key,
1284                                      &l->client_guid,
1285                                      &l->lease_key)) {
1286                         DEBUG(10, ("Don't break our own lease\n"));
1287                         continue;
1288                 }
1289
1290                 for (j=0; j<d->num_share_modes; j++) {
1291                         e = &d->share_modes[j];
1292
1293                         if (!is_valid_share_mode_entry(e)) {
1294                                 continue;
1295                         }
1296                         if (e->lease_idx == i) {
1297                                 break;
1298                         }
1299                 }
1300                 if (j == d->num_share_modes) {
1301                         DEBUG(0, ("leases[%"PRIu32"] has no share mode\n",
1302                                   i));
1303                         continue;
1304                 }
1305
1306                 DEBUG(10, ("Breaking lease# %"PRIu32" with share_entry# "
1307                            "%"PRIu32"\n", i, j));
1308
1309                 send_break_to_none(state->sconn->msg_ctx, &state->id, e);
1310         }
1311
1312         for(i = 0; i < d->num_share_modes; i++) {
1313                 struct share_mode_entry *e = &d->share_modes[i];
1314
1315                 if (!is_valid_share_mode_entry(e)) {
1316                         continue;
1317                 }
1318                 if (e->op_type == LEASE_OPLOCK) {
1319                         /*
1320                          * Took care of those in the loop above
1321                          */
1322                         continue;
1323                 }
1324
1325                 /*
1326                  * As there could have been multiple writes waiting at the
1327                  * lock_share_entry gate we may not be the first to
1328                  * enter. Hence the state of the op_types in the share mode
1329                  * entries may be partly NO_OPLOCK and partly LEVEL_II
1330                  * oplock. It will do no harm to re-send break messages to
1331                  * those smbd's that are still waiting their turn to remove
1332                  * their LEVEL_II state, and also no harm to ignore existing
1333                  * NO_OPLOCK states. JRA.
1334                  */
1335
1336                 DEBUG(10, ("%s: share_entry[%i]->op_type == %d\n", __func__,
1337                            i, e->op_type ));
1338
1339                 if (e->op_type == NO_OPLOCK) {
1340                         continue;
1341                 }
1342
1343                 /* Paranoia .... */
1344                 if (EXCLUSIVE_OPLOCK_TYPE(e->op_type)) {
1345                         DEBUG(0,("%s: PANIC. "
1346                                  "share mode entry %d is an exclusive "
1347                                  "oplock !\n", __func__, i ));
1348                         TALLOC_FREE(lck);
1349                         abort();
1350                 }
1351
1352                 send_break_to_none(state->sconn->msg_ctx, &state->id, e);
1353         }
1354
1355         /* We let the message receivers handle removing the oplock state
1356            in the share mode lock db. */
1357
1358         TALLOC_FREE(lck);
1359 done:
1360         TALLOC_FREE(state);
1361         return;
1362 }
1363
1364 void smbd_contend_level2_oplocks_begin(files_struct *fsp,
1365                                   enum level2_contention_type type)
1366 {
1367         contend_level2_oplocks_begin_default(fsp, type);
1368 }
1369
1370 void smbd_contend_level2_oplocks_end(files_struct *fsp,
1371                                 enum level2_contention_type type)
1372 {
1373         return;
1374 }
1375
1376 /****************************************************************************
1377  Linearize a share mode entry struct to an internal oplock break message.
1378 ****************************************************************************/
1379
1380 void share_mode_entry_to_message(char *msg, const struct file_id *id,
1381                                  const struct share_mode_entry *e)
1382 {
1383         SIVAL(msg,OP_BREAK_MSG_PID_OFFSET,(uint32_t)e->pid.pid);
1384         SBVAL(msg,OP_BREAK_MSG_MID_OFFSET,e->op_mid);
1385         SSVAL(msg,OP_BREAK_MSG_OP_TYPE_OFFSET,e->op_type);
1386         SIVAL(msg,OP_BREAK_MSG_ACCESS_MASK_OFFSET,e->access_mask);
1387         SIVAL(msg,OP_BREAK_MSG_SHARE_ACCESS_OFFSET,e->share_access);
1388         SIVAL(msg,OP_BREAK_MSG_PRIV_OFFSET,e->private_options);
1389         SIVAL(msg,OP_BREAK_MSG_TIME_SEC_OFFSET,(uint32_t)e->time.tv_sec);
1390         SIVAL(msg,OP_BREAK_MSG_TIME_USEC_OFFSET,(uint32_t)e->time.tv_usec);
1391         /*
1392          * "id" used to be part of share_mode_entry, thus the strange
1393          * place to put this. Feel free to move somewhere else :-)
1394          */
1395         push_file_id_24(msg+OP_BREAK_MSG_DEV_OFFSET, id);
1396         SIVAL(msg,OP_BREAK_MSG_FILE_ID_OFFSET,e->share_file_id);
1397         SIVAL(msg,OP_BREAK_MSG_UID_OFFSET,e->uid);
1398         SSVAL(msg,OP_BREAK_MSG_FLAGS_OFFSET,e->flags);
1399         SIVAL(msg,OP_BREAK_MSG_NAME_HASH_OFFSET,e->name_hash);
1400         SIVAL(msg,OP_BREAK_MSG_VNN_OFFSET,e->pid.vnn);
1401 }
1402
1403 /****************************************************************************
1404  De-linearize an internal oplock break message to a share mode entry struct.
1405 ****************************************************************************/
1406
1407 void message_to_share_mode_entry(struct file_id *id,
1408                                  struct share_mode_entry *e,
1409                                  const char *msg)
1410 {
1411         e->pid.pid = (pid_t)IVAL(msg,OP_BREAK_MSG_PID_OFFSET);
1412         e->op_mid = BVAL(msg,OP_BREAK_MSG_MID_OFFSET);
1413         e->op_type = SVAL(msg,OP_BREAK_MSG_OP_TYPE_OFFSET);
1414         e->access_mask = IVAL(msg,OP_BREAK_MSG_ACCESS_MASK_OFFSET);
1415         e->share_access = IVAL(msg,OP_BREAK_MSG_SHARE_ACCESS_OFFSET);
1416         e->private_options = IVAL(msg,OP_BREAK_MSG_PRIV_OFFSET);
1417         e->time.tv_sec = (time_t)IVAL(msg,OP_BREAK_MSG_TIME_SEC_OFFSET);
1418         e->time.tv_usec = (int)IVAL(msg,OP_BREAK_MSG_TIME_USEC_OFFSET);
1419         /*
1420          * "id" used to be part of share_mode_entry, thus the strange
1421          * place to put this. Feel free to move somewhere else :-)
1422          */
1423         pull_file_id_24(msg+OP_BREAK_MSG_DEV_OFFSET, id);
1424         e->share_file_id = (unsigned long)IVAL(msg,OP_BREAK_MSG_FILE_ID_OFFSET);
1425         e->uid = (uint32_t)IVAL(msg,OP_BREAK_MSG_UID_OFFSET);
1426         e->flags = (uint16_t)SVAL(msg,OP_BREAK_MSG_FLAGS_OFFSET);
1427         e->name_hash = IVAL(msg,OP_BREAK_MSG_NAME_HASH_OFFSET);
1428         e->pid.vnn = IVAL(msg,OP_BREAK_MSG_VNN_OFFSET);
1429 }
1430
1431 /****************************************************************************
1432  Setup oplocks for this process.
1433 ****************************************************************************/
1434
1435 bool init_oplocks(struct smbd_server_connection *sconn)
1436 {
1437         DEBUG(3,("init_oplocks: initializing messages.\n"));
1438
1439         messaging_register(sconn->msg_ctx, sconn, MSG_SMB_BREAK_REQUEST,
1440                            process_oplock_break_message);
1441         messaging_register(sconn->msg_ctx, sconn, MSG_SMB_KERNEL_BREAK,
1442                            process_kernel_oplock_break);
1443         return true;
1444 }
1445
1446 void init_kernel_oplocks(struct smbd_server_connection *sconn)
1447 {
1448         struct kernel_oplocks *koplocks = sconn->oplocks.kernel_ops;
1449
1450         /* only initialize once */
1451         if (koplocks == NULL) {
1452 #if HAVE_KERNEL_OPLOCKS_LINUX
1453                 koplocks = linux_init_kernel_oplocks(sconn);
1454 #endif
1455                 sconn->oplocks.kernel_ops = koplocks;
1456         }
1457 }