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