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/globals.h"
  25 #include "librpc/gen_ndr/messaging.h"
  26
  27 /****************************************************************************
  28  Get the number of current exclusive oplocks.
  29 ****************************************************************************/
  30
  31 int32 get_number_of_exclusive_open_oplocks(void)
  32 {
  33   return exclusive_oplocks_open;
  34 }
  35
  36 /*
  37  * helper function used by the kernel oplock backends to post the break message
  38  */
  39 void break_kernel_oplock(struct messaging_context *msg_ctx, files_struct *fsp)
  40 {
  41         uint8_t msg[MSG_SMB_KERNEL_BREAK_SIZE];
  42
  43         /* Put the kernel break info into the message. */
  44         push_file_id_24((char *)msg, &fsp->file_id);
  45         SIVAL(msg,24,fsp->fh->gen_id);
  46
  47         /* Don't need to be root here as we're only ever
  48            sending to ourselves. */
  49
  50         messaging_send_buf(msg_ctx, messaging_server_id(msg_ctx),
  51                            MSG_SMB_KERNEL_BREAK,
  52                            msg, MSG_SMB_KERNEL_BREAK_SIZE);
  53 }
  54
  55 /****************************************************************************
  56  Attempt to set an oplock on a file. Always succeeds if kernel oplocks are
  57  disabled (just sets flags). Returns True if oplock set.
  58 ****************************************************************************/
  59
  60 bool set_file_oplock(files_struct *fsp, int oplock_type)
  61 {
  62         if ((fsp->oplock_type == LEVEL_II_OPLOCK)
  63             && koplocks && !(koplocks->flags & KOPLOCKS_LEVEL2_SUPPORTED)) {
  64                 DEBUG(10, ("Refusing level2 oplock, kernel oplocks don't "
  65                            "support them\n"));
  66                 return false;
  67         }
  68         if ((fsp->oplock_type != NO_OPLOCK) &&
  69             (fsp->oplock_type != FAKE_LEVEL_II_OPLOCK) &&
  70             koplocks &&
  71             !koplocks->ops->set_oplock(koplocks, fsp, oplock_type)) {
  72                 return False;
  73         }
  74
  75         fsp->oplock_type = oplock_type;
  76         fsp->sent_oplock_break = NO_BREAK_SENT;
  77         if (oplock_type == LEVEL_II_OPLOCK) {
  78                 level_II_oplocks_open++;
  79         } else if (EXCLUSIVE_OPLOCK_TYPE(fsp->oplock_type)) {
  80                 exclusive_oplocks_open++;
  81         }
  82
  83         DEBUG(5,("set_file_oplock: granted oplock on file %s, %s/%lu, "
  84                     "tv_sec = %x, tv_usec = %x\n",
  85                  fsp_str_dbg(fsp), file_id_string_tos(&fsp->file_id),
  86                  fsp->fh->gen_id, (int)fsp->open_time.tv_sec,
  87                  (int)fsp->open_time.tv_usec ));
  88
  89         return True;
  90 }
  91
  92 /****************************************************************************
  93  Attempt to release an oplock on a file. Decrements oplock count.
  94 ****************************************************************************/
  95
  96 void release_file_oplock(files_struct *fsp)
  97 {
  98         if ((fsp->oplock_type != NO_OPLOCK) &&
  99             (fsp->oplock_type != FAKE_LEVEL_II_OPLOCK) &&
 100             koplocks) {
 101                 koplocks->ops->release_oplock(koplocks, fsp, NO_OPLOCK);
 102         }
 103
 104         if (fsp->oplock_type == LEVEL_II_OPLOCK) {
 105                 level_II_oplocks_open--;
 106         } else if (EXCLUSIVE_OPLOCK_TYPE(fsp->oplock_type)) {
 107                 exclusive_oplocks_open--;
 108         }
 109
 110         SMB_ASSERT(exclusive_oplocks_open>=0);
 111         SMB_ASSERT(level_II_oplocks_open>=0);
 112
 113         if (EXCLUSIVE_OPLOCK_TYPE(fsp->oplock_type)) {
 114                 /* This doesn't matter for close. */
 115                 fsp->oplock_type = FAKE_LEVEL_II_OPLOCK;
 116         } else {
 117                 fsp->oplock_type = NO_OPLOCK;
 118         }
 119         fsp->sent_oplock_break = NO_BREAK_SENT;
 120
 121         flush_write_cache(fsp, OPLOCK_RELEASE_FLUSH);
 122
 123         TALLOC_FREE(fsp->oplock_timeout);
 124 }
 125
 126 /****************************************************************************
 127  Attempt to downgrade an oplock on a file. Doesn't decrement oplock count.
 128 ****************************************************************************/
 129
 130 static void downgrade_file_oplock(files_struct *fsp)
 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         exclusive_oplocks_open--;
 142         level_II_oplocks_open++;
 143         fsp->sent_oplock_break = NO_BREAK_SENT;
 144 }
 145
 146 /****************************************************************************
 147  Remove a file oplock. Copes with level II and exclusive.
 148  Locks then unlocks the share mode lock. Client can decide to go directly
 149  to none even if a "break-to-level II" was sent.
 150 ****************************************************************************/
 151
 152 bool remove_oplock(files_struct *fsp)
 153 {
 154         bool ret;
 155         struct share_mode_lock *lck;
 156
 157         /* Remove the oplock flag from the sharemode. */
 158         lck = get_share_mode_lock(talloc_tos(), fsp->file_id, NULL, NULL,
 159                                   NULL);
 160         if (lck == NULL) {
 161                 DEBUG(0,("remove_oplock: failed to lock share entry for "
 162                          "file %s\n", fsp_str_dbg(fsp)));
 163                 return False;
 164         }
 165         ret = remove_share_oplock(lck, fsp);
 166         if (!ret) {
 167                 DEBUG(0,("remove_oplock: failed to remove share oplock for "
 168                          "file %s fnum %d, %s\n",
 169                          fsp_str_dbg(fsp), fsp->fnum,
 170                          file_id_string_tos(&fsp->file_id)));
 171         }
 172         release_file_oplock(fsp);
 173         TALLOC_FREE(lck);
 174         return ret;
 175 }
 176
 177 /*
 178  * Deal with a reply when a break-to-level II was sent.
 179  */
 180 bool downgrade_oplock(files_struct *fsp)
 181 {
 182         bool ret;
 183         struct share_mode_lock *lck;
 184
 185         lck = get_share_mode_lock(talloc_tos(), fsp->file_id, NULL, NULL,
 186                                   NULL);
 187         if (lck == NULL) {
 188                 DEBUG(0,("downgrade_oplock: failed to lock share entry for "
 189                          "file %s\n", fsp_str_dbg(fsp)));
 190                 return False;
 191         }
 192         ret = downgrade_share_oplock(lck, fsp);
 193         if (!ret) {
 194                 DEBUG(0,("downgrade_oplock: failed to downgrade share oplock "
 195                          "for file %s fnum %d, file_id %s\n",
 196                          fsp_str_dbg(fsp), fsp->fnum,
 197                          file_id_string_tos(&fsp->file_id)));
 198         }
 199
 200         downgrade_file_oplock(fsp);
 201         TALLOC_FREE(lck);
 202         return ret;
 203 }
 204
 205 /*
 206  * Some kernel oplock implementations handle the notification themselves.
 207  */
 208 bool should_notify_deferred_opens()
 209 {
 210         return !(koplocks &&
 211                 (koplocks->flags & KOPLOCKS_DEFERRED_OPEN_NOTIFICATION));
 212 }
 213
 214 /****************************************************************************
 215  Set up an oplock break message.
 216 ****************************************************************************/
 217
 218 static char *new_break_message_smb1(TALLOC_CTX *mem_ctx,
 219                                    files_struct *fsp, int cmd)
 220 {
 221         char *result = TALLOC_ARRAY(mem_ctx, char, smb_size + 8*2 + 0);
 222
 223         if (result == NULL) {
 224                 DEBUG(0, ("talloc failed\n"));
 225                 return NULL;
 226         }
 227
 228         memset(result,'\0',smb_size);
 229         srv_set_message(result,8,0,true);
 230         SCVAL(result,smb_com,SMBlockingX);
 231         SSVAL(result,smb_tid,fsp->conn->cnum);
 232         SSVAL(result,smb_pid,0xFFFF);
 233         SSVAL(result,smb_uid,0);
 234         SSVAL(result,smb_mid,0xFFFF);
 235         SCVAL(result,smb_vwv0,0xFF);
 236         SSVAL(result,smb_vwv2,fsp->fnum);
 237         SCVAL(result,smb_vwv3,LOCKING_ANDX_OPLOCK_RELEASE);
 238         SCVAL(result,smb_vwv3+1,cmd);
 239         return result;
 240 }
 241
 242 /****************************************************************************
 243  Function to do the waiting before sending a local break.
 244 ****************************************************************************/
 245
 246 static void wait_before_sending_break(void)
 247 {
 248         long wait_time = (long)lp_oplock_break_wait_time();
 249
 250         if (wait_time) {
 251                 smb_msleep(wait_time);
 252         }
 253 }
 254
 255 /****************************************************************************
 256  Ensure that we have a valid oplock.
 257 ****************************************************************************/
 258
 259 static files_struct *initial_break_processing(struct file_id id, unsigned long file_id)
 260 {
 261         files_struct *fsp = NULL;
 262
 263         if( DEBUGLVL( 3 ) ) {
 264                 dbgtext( "initial_break_processing: called for %s/%u\n",
 265                          file_id_string_tos(&id), (int)file_id);
 266                 dbgtext( "Current oplocks_open (exclusive = %d, levelII = %d)\n",
 267                         exclusive_oplocks_open, level_II_oplocks_open );
 268         }
 269
 270         /*
 271          * We need to search the file open table for the
 272          * entry containing this dev and inode, and ensure
 273          * we have an oplock on it.
 274          */
 275
 276         fsp = file_find_dif(id, file_id);
 277
 278         if(fsp == NULL) {
 279                 /* The file could have been closed in the meantime - return success. */
 280                 if( DEBUGLVL( 3 ) ) {
 281                         dbgtext( "initial_break_processing: cannot find open file with " );
 282                         dbgtext( "file_id %s gen_id = %lu", file_id_string_tos(&id), file_id);
 283                         dbgtext( "allowing break to succeed.\n" );
 284                 }
 285                 return NULL;
 286         }
 287
 288         /* Ensure we have an oplock on the file */
 289
 290         /*
 291          * There is a potential race condition in that an oplock could
 292          * have been broken due to another udp request, and yet there are
 293          * still oplock break messages being sent in the udp message
 294          * queue for this file. So return true if we don't have an oplock,
 295          * as we may have just freed it.
 296          */
 297
 298         if(fsp->oplock_type == NO_OPLOCK) {
 299                 if( DEBUGLVL( 3 ) ) {
 300                         dbgtext( "initial_break_processing: file %s ",
 301                                  fsp_str_dbg(fsp));
 302                         dbgtext( "(file_id = %s gen_id = %lu) has no oplock.\n",
 303                                  file_id_string_tos(&id), fsp->fh->gen_id );
 304                         dbgtext( "Allowing break to succeed regardless.\n" );
 305                 }
 306                 return NULL;
 307         }
 308
 309         return fsp;
 310 }
 311
 312 static void oplock_timeout_handler(struct event_context *ctx,
 313                                    struct timed_event *te,
 314                                    struct timeval now,
 315                                    void *private_data)
 316 {
 317         files_struct *fsp = (files_struct *)private_data;
 318
 319         /* Remove the timed event handler. */
 320         TALLOC_FREE(fsp->oplock_timeout);
 321         DEBUG(0, ("Oplock break failed for file %s -- replying anyway\n",
 322                   fsp_str_dbg(fsp)));
 323         remove_oplock(fsp);
 324         reply_to_oplock_break_requests(fsp);
 325 }
 326
 327 /*******************************************************************
 328  Add a timeout handler waiting for the client reply.
 329 *******************************************************************/
 330
 331 static void add_oplock_timeout_handler(files_struct *fsp)
 332 {
 333         /*
 334          * If kernel oplocks already notifies smbds when an oplock break times
 335          * out, just return.
 336          */
 337         if (koplocks &&
 338             (koplocks->flags & KOPLOCKS_TIMEOUT_NOTIFICATION)) {
 339                 return;
 340         }
 341
 342         if (fsp->oplock_timeout != NULL) {
 343                 DEBUG(0, ("Logic problem -- have an oplock event hanging "
 344                           "around\n"));
 345         }
 346
 347         fsp->oplock_timeout =
 348                 event_add_timed(smbd_event_context(), fsp,
 349                                 timeval_current_ofs(OPLOCK_BREAK_TIMEOUT, 0),
 350                                 oplock_timeout_handler, fsp);
 351
 352         if (fsp->oplock_timeout == NULL) {
 353                 DEBUG(0, ("Could not add oplock timeout handler\n"));
 354         }
 355 }
 356
 357 static void send_break_message_smb1(files_struct *fsp, int level)
 358 {
 359         char *break_msg = new_break_message_smb1(talloc_tos(),
 360                                         fsp,
 361                                         level);
 362         if (break_msg == NULL) {
 363                 exit_server("Could not talloc break_msg\n");
 364         }
 365
 366         show_msg(break_msg);
 367         if (!srv_send_smb(smbd_server_fd(),
 368                         break_msg, false, 0,
 369                         IS_CONN_ENCRYPTED(fsp->conn),
 370                         NULL)) {
 371                 exit_server_cleanly("send_break_message_smb1: "
 372                         "srv_send_smb failed.");
 373         }
 374
 375         TALLOC_FREE(break_msg);
 376 }
 377
 378 void break_level2_to_none_async(files_struct *fsp)
 379 {
 380         struct smbd_server_connection *sconn = fsp->conn->sconn;
 381
 382         if (fsp->oplock_type == NO_OPLOCK) {
 383                 /* We already got a "break to none" message and we've handled
 384                  * it.  just ignore. */
 385                 DEBUG(3, ("process_oplock_async_level2_break_message: already "
 386                           "broken to none, ignoring.\n"));
 387                 return;
 388         }
 389
 390         if (fsp->oplock_type == FAKE_LEVEL_II_OPLOCK) {
 391                 /* Don't tell the client, just downgrade. */
 392                 DEBUG(3, ("process_oplock_async_level2_break_message: "
 393                           "downgrading fake level 2 oplock.\n"));
 394                 remove_oplock(fsp);
 395                 return;
 396         }
 397
 398         /* Ensure we're really at level2 state. */
 399         SMB_ASSERT(fsp->oplock_type == LEVEL_II_OPLOCK);
 400
 401         DEBUG(10,("process_oplock_async_level2_break_message: sending break "
 402                   "to none message for fid %d, file %s\n", fsp->fnum,
 403                   fsp_str_dbg(fsp)));
 404
 405         /* Now send a break to none message to our client. */
 406         if (sconn->using_smb2) {
 407                 send_break_message_smb2(fsp, OPLOCKLEVEL_NONE);
 408         } else {
 409                 send_break_message_smb1(fsp, OPLOCKLEVEL_NONE);
 410         }
 411
 412         /* Async level2 request, don't send a reply, just remove the oplock. */
 413         remove_oplock(fsp);
 414 }
 415
 416 /*******************************************************************
 417  This handles the case of a write triggering a break to none
 418  message on a level2 oplock.
 419  When we get this message we may be in any of three states :
 420  NO_OPLOCK, LEVEL_II, FAKE_LEVEL2. We only send a message to
 421  the client for LEVEL2.
 422 *******************************************************************/
 423
 424 void process_oplock_async_level2_break_message(struct messaging_context *msg_ctx,
 425                                                       void *private_data,
 426                                                       uint32_t msg_type,
 427                                                       struct server_id src,
 428                                                       DATA_BLOB *data)
 429 {
 430         struct share_mode_entry msg;
 431         files_struct *fsp;
 432
 433         if (data->data == NULL) {
 434                 DEBUG(0, ("Got NULL buffer\n"));
 435                 return;
 436         }
 437
 438         if (data->length != MSG_SMB_SHARE_MODE_ENTRY_SIZE) {
 439                 DEBUG(0, ("Got invalid msg len %d\n", (int)data->length));
 440                 return;
 441         }
 442
 443         /* De-linearize incoming message. */
 444         message_to_share_mode_entry(&msg, (char *)data->data);
 445
 446         DEBUG(10, ("Got oplock async level 2 break message from pid %s: "
 447                    "%s/%lu\n", procid_str(talloc_tos(), &src),
 448                    file_id_string_tos(&msg.id), msg.share_file_id));
 449
 450         fsp = initial_break_processing(msg.id, msg.share_file_id);
 451
 452         if (fsp == NULL) {
 453                 /* We hit a race here. Break messages are sent, and before we
 454                  * get to process this message, we have closed the file.
 455                  * No need to reply as this is an async message. */
 456                 DEBUG(3, ("process_oplock_async_level2_break_message: Did not find fsp, ignoring\n"));
 457                 return;
 458         }
 459
 460         break_level2_to_none_async(fsp);
 461 }
 462
 463 /*******************************************************************
 464  This handles the generic oplock break message from another smbd.
 465 *******************************************************************/
 466
 467 static void process_oplock_break_message(struct messaging_context *msg_ctx,
 468                                          void *private_data,
 469                                          uint32_t msg_type,
 470                                          struct server_id src,
 471                                          DATA_BLOB *data)
 472 {
 473         struct smbd_server_connection *sconn = smbd_server_conn;
 474         struct share_mode_entry msg;
 475         files_struct *fsp;
 476         bool break_to_level2 = False;
 477
 478         if (data->data == NULL) {
 479                 DEBUG(0, ("Got NULL buffer\n"));
 480                 return;
 481         }
 482
 483         if (data->length != MSG_SMB_SHARE_MODE_ENTRY_SIZE) {
 484                 DEBUG(0, ("Got invalid msg len %d\n", (int)data->length));
 485                 return;
 486         }
 487
 488         /* De-linearize incoming message. */
 489         message_to_share_mode_entry(&msg, (char *)data->data);
 490
 491         DEBUG(10, ("Got oplock break message from pid %s: %s/%lu\n",
 492                    procid_str(talloc_tos(), &src), file_id_string_tos(&msg.id),
 493                    msg.share_file_id));
 494
 495         fsp = initial_break_processing(msg.id, msg.share_file_id);
 496
 497         if (fsp == NULL) {
 498                 /* We hit a race here. Break messages are sent, and before we
 499                  * get to process this message, we have closed the file. Reply
 500                  * with 'ok, oplock broken' */
 501                 DEBUG(3, ("Did not find fsp\n"));
 502
 503                 /* We just send the same message back. */
 504                 messaging_send_buf(msg_ctx, src, MSG_SMB_BREAK_RESPONSE,
 505                                    (uint8 *)data->data,
 506                                    MSG_SMB_SHARE_MODE_ENTRY_SIZE);
 507                 return;
 508         }
 509
 510         if (fsp->sent_oplock_break != NO_BREAK_SENT) {
 511                 /* Remember we have to inform the requesting PID when the
 512                  * client replies */
 513                 msg.pid = src;
 514                 ADD_TO_ARRAY(NULL, struct share_mode_entry, msg,
 515                              &fsp->pending_break_messages,
 516                              &fsp->num_pending_break_messages);
 517                 return;
 518         }
 519
 520         if (EXCLUSIVE_OPLOCK_TYPE(msg.op_type) &&
 521             !EXCLUSIVE_OPLOCK_TYPE(fsp->oplock_type)) {
 522                 DEBUG(3, ("Already downgraded oplock on %s: %s\n",
 523                           file_id_string_tos(&fsp->file_id),
 524                           fsp_str_dbg(fsp)));
 525                 /* We just send the same message back. */
 526                 messaging_send_buf(msg_ctx, src, MSG_SMB_BREAK_RESPONSE,
 527                                    (uint8 *)data->data,
 528                                    MSG_SMB_SHARE_MODE_ENTRY_SIZE);
 529                 return;
 530         }
 531
 532         if ((global_client_caps & CAP_LEVEL_II_OPLOCKS) &&
 533             !(msg.op_type & FORCE_OPLOCK_BREAK_TO_NONE) &&
 534             !(koplocks && !(koplocks->flags & KOPLOCKS_LEVEL2_SUPPORTED)) &&
 535             lp_level2_oplocks(SNUM(fsp->conn))) {
 536                 break_to_level2 = True;
 537         }
 538
 539         /* Need to wait before sending a break
 540            message if we sent ourselves this message. */
 541         if (procid_is_me(&src)) {
 542                 wait_before_sending_break();
 543         }
 544
 545         if (sconn->using_smb2) {
 546                 send_break_message_smb2(fsp, break_to_level2 ?
 547                         OPLOCKLEVEL_II : OPLOCKLEVEL_NONE);
 548         } else {
 549                 send_break_message_smb1(fsp, break_to_level2 ?
 550                         OPLOCKLEVEL_II : OPLOCKLEVEL_NONE);
 551         }
 552
 553         fsp->sent_oplock_break = break_to_level2 ? LEVEL_II_BREAK_SENT:BREAK_TO_NONE_SENT;
 554
 555         msg.pid = src;
 556         ADD_TO_ARRAY(NULL, struct share_mode_entry, msg,
 557                      &fsp->pending_break_messages,
 558                      &fsp->num_pending_break_messages);
 559
 560         add_oplock_timeout_handler(fsp);
 561 }
 562
 563 /*******************************************************************
 564  This handles the kernel oplock break message.
 565 *******************************************************************/
 566
 567 static void process_kernel_oplock_break(struct messaging_context *msg_ctx,
 568                                         void *private_data,
 569                                         uint32_t msg_type,
 570                                         struct server_id src,
 571                                         DATA_BLOB *data)
 572 {
 573         struct smbd_server_connection *sconn = smbd_server_conn;
 574         struct file_id id;
 575         unsigned long file_id;
 576         files_struct *fsp;
 577
 578         if (data->data == NULL) {
 579                 DEBUG(0, ("Got NULL buffer\n"));
 580                 return;
 581         }
 582
 583         if (data->length != MSG_SMB_KERNEL_BREAK_SIZE) {
 584                 DEBUG(0, ("Got invalid msg len %d\n", (int)data->length));
 585                 return;
 586         }
 587
 588         /* Pull the data from the message. */
 589         pull_file_id_24((char *)data->data, &id);
 590         file_id = (unsigned long)IVAL(data->data, 24);
 591
 592         DEBUG(10, ("Got kernel oplock break message from pid %s: %s/%u\n",
 593                    procid_str(talloc_tos(), &src), file_id_string_tos(&id),
 594                    (unsigned int)file_id));
 595
 596         fsp = initial_break_processing(id, file_id);
 597
 598         if (fsp == NULL) {
 599                 DEBUG(3, ("Got a kernel oplock break message for a file "
 600                           "I don't know about\n"));
 601                 return;
 602         }
 603
 604         if (fsp->sent_oplock_break != NO_BREAK_SENT) {
 605                 /* This is ok, kernel oplocks come in completely async */
 606                 DEBUG(3, ("Got a kernel oplock request while waiting for a "
 607                           "break reply\n"));
 608                 return;
 609         }
 610
 611         if (sconn->using_smb2) {
 612                 send_break_message_smb2(fsp, OPLOCKLEVEL_NONE);
 613         } else {
 614                 send_break_message_smb1(fsp, OPLOCKLEVEL_NONE);
 615         }
 616
 617         fsp->sent_oplock_break = BREAK_TO_NONE_SENT;
 618
 619         add_oplock_timeout_handler(fsp);
 620 }
 621
 622 void reply_to_oplock_break_requests(files_struct *fsp)
 623 {
 624         int i;
 625
 626         /*
 627          * If kernel oplocks already notifies smbds when oplocks are
 628          * broken/removed, just return.
 629          */
 630         if (koplocks &&
 631             (koplocks->flags & KOPLOCKS_OPLOCK_BROKEN_NOTIFICATION)) {
 632                 return;
 633         }
 634
 635         for (i=0; i<fsp->num_pending_break_messages; i++) {
 636                 struct share_mode_entry *e = &fsp->pending_break_messages[i];
 637                 char msg[MSG_SMB_SHARE_MODE_ENTRY_SIZE];
 638
 639                 share_mode_entry_to_message(msg, e);
 640
 641                 messaging_send_buf(fsp->conn->sconn->msg_ctx, e->pid,
 642                                    MSG_SMB_BREAK_RESPONSE,
 643                                    (uint8 *)msg,
 644                                    MSG_SMB_SHARE_MODE_ENTRY_SIZE);
 645         }
 646
 647         SAFE_FREE(fsp->pending_break_messages);
 648         fsp->num_pending_break_messages = 0;
 649         if (fsp->oplock_timeout != NULL) {
 650                 /* Remove the timed event handler. */
 651                 TALLOC_FREE(fsp->oplock_timeout);
 652                 fsp->oplock_timeout = NULL;
 653         }
 654         return;
 655 }
 656
 657 static void process_oplock_break_response(struct messaging_context *msg_ctx,
 658                                           void *private_data,
 659                                           uint32_t msg_type,
 660                                           struct server_id src,
 661                                           DATA_BLOB *data)
 662 {
 663         struct share_mode_entry msg;
 664
 665         if (data->data == NULL) {
 666                 DEBUG(0, ("Got NULL buffer\n"));
 667                 return;
 668         }
 669
 670         if (data->length != MSG_SMB_SHARE_MODE_ENTRY_SIZE) {
 671                 DEBUG(0, ("Got invalid msg len %u\n",
 672                           (unsigned int)data->length));
 673                 return;
 674         }
 675
 676         /* De-linearize incoming message. */
 677         message_to_share_mode_entry(&msg, (char *)data->data);
 678
 679         DEBUG(10, ("Got oplock break response from pid %s: %s/%lu mid %llu\n",
 680                    procid_str(talloc_tos(), &src), file_id_string_tos(&msg.id),
 681                    msg.share_file_id, (unsigned long long)msg.op_mid));
 682
 683         schedule_deferred_open_message_smb(msg.op_mid);
 684 }
 685
 686 static void process_open_retry_message(struct messaging_context *msg_ctx,
 687                                        void *private_data,
 688                                        uint32_t msg_type,
 689                                        struct server_id src,
 690                                        DATA_BLOB *data)
 691 {
 692         struct share_mode_entry msg;
 693
 694         if (data->data == NULL) {
 695                 DEBUG(0, ("Got NULL buffer\n"));
 696                 return;
 697         }
 698
 699         if (data->length != MSG_SMB_SHARE_MODE_ENTRY_SIZE) {
 700                 DEBUG(0, ("Got invalid msg len %d\n", (int)data->length));
 701                 return;
 702         }
 703
 704         /* De-linearize incoming message. */
 705         message_to_share_mode_entry(&msg, (char *)data->data);
 706
 707         DEBUG(10, ("Got open retry msg from pid %s: %s mid %llu\n",
 708                    procid_str(talloc_tos(), &src), file_id_string_tos(&msg.id),
 709                    (unsigned long long)msg.op_mid));
 710
 711         schedule_deferred_open_message_smb(msg.op_mid);
 712 }
 713
 714 /****************************************************************************
 715  This function is called on any file modification or lock request. If a file
 716  is level 2 oplocked then it must tell all other level 2 holders to break to
 717  none.
 718 ****************************************************************************/
 719
 720 static void contend_level2_oplocks_begin_default(files_struct *fsp,
 721                                               enum level2_contention_type type)
 722 {
 723         int i;
 724         struct share_mode_lock *lck;
 725
 726         /*
 727          * If this file is level II oplocked then we need
 728          * to grab the shared memory lock and inform all
 729          * other files with a level II lock that they need
 730          * to flush their read caches. We keep the lock over
 731          * the shared memory area whilst doing this.
 732          */
 733
 734         if (!LEVEL_II_OPLOCK_TYPE(fsp->oplock_type))
 735                 return;
 736
 737         lck = get_share_mode_lock(talloc_tos(), fsp->file_id, NULL, NULL,
 738                                   NULL);
 739         if (lck == NULL) {
 740                 DEBUG(0,("release_level_2_oplocks_on_change: failed to lock "
 741                          "share mode entry for file %s.\n", fsp_str_dbg(fsp)));
 742                 return;
 743         }
 744
 745         DEBUG(10,("release_level_2_oplocks_on_change: num_share_modes = %d\n",
 746                   lck->num_share_modes ));
 747
 748         for(i = 0; i < lck->num_share_modes; i++) {
 749                 struct share_mode_entry *share_entry = &lck->share_modes[i];
 750                 char msg[MSG_SMB_SHARE_MODE_ENTRY_SIZE];
 751
 752                 if (!is_valid_share_mode_entry(share_entry)) {
 753                         continue;
 754                 }
 755
 756                 /*
 757                  * As there could have been multiple writes waiting at the
 758                  * lock_share_entry gate we may not be the first to
 759                  * enter. Hence the state of the op_types in the share mode
 760                  * entries may be partly NO_OPLOCK and partly LEVEL_II or FAKE_LEVEL_II
 761                  * oplock. It will do no harm to re-send break messages to
 762                  * those smbd's that are still waiting their turn to remove
 763                  * their LEVEL_II state, and also no harm to ignore existing
 764                  * NO_OPLOCK states. JRA.
 765                  */
 766
 767                 DEBUG(10,("release_level_2_oplocks_on_change: "
 768                           "share_entry[%i]->op_type == %d\n",
 769                           i, share_entry->op_type ));
 770
 771                 if (share_entry->op_type == NO_OPLOCK) {
 772                         continue;
 773                 }
 774
 775                 /* Paranoia .... */
 776                 if (EXCLUSIVE_OPLOCK_TYPE(share_entry->op_type)) {
 777                         DEBUG(0,("release_level_2_oplocks_on_change: PANIC. "
 778                                  "share mode entry %d is an exlusive "
 779                                  "oplock !\n", i ));
 780                         TALLOC_FREE(lck);
 781                         abort();
 782                 }
 783
 784                 share_mode_entry_to_message(msg, share_entry);
 785
 786                 /*
 787                  * Deal with a race condition when breaking level2
 788                  * oplocks. Don't send all the messages and release
 789                  * the lock, this allows someone else to come in and
 790                  * get a level2 lock before any of the messages are
 791                  * processed, and thus miss getting a break message.
 792                  * Ensure at least one entry (the one we're breaking)
 793                  * is processed immediately under the lock and becomes
 794                  * set as NO_OPLOCK to stop any waiter getting a level2.
 795                  * Bugid #5980.
 796                  */
 797
 798                 if (procid_is_me(&share_entry->pid)) {
 799                         wait_before_sending_break();
 800                         break_level2_to_none_async(fsp);
 801                 } else {
 802                         messaging_send_buf(fsp->conn->sconn->msg_ctx,
 803                                         share_entry->pid,
 804                                         MSG_SMB_ASYNC_LEVEL2_BREAK,
 805                                         (uint8 *)msg,
 806                                         MSG_SMB_SHARE_MODE_ENTRY_SIZE);
 807                 }
 808         }
 809
 810         /* We let the message receivers handle removing the oplock state
 811            in the share mode lock db. */
 812
 813         TALLOC_FREE(lck);
 814 }
 815
 816 void contend_level2_oplocks_begin(files_struct *fsp,
 817                                   enum level2_contention_type type)
 818 {
 819         if (koplocks && koplocks->ops->contend_level2_oplocks_begin) {
 820                 koplocks->ops->contend_level2_oplocks_begin(fsp, type);
 821                 return;
 822         }
 823
 824         contend_level2_oplocks_begin_default(fsp, type);
 825 }
 826
 827 void contend_level2_oplocks_end(files_struct *fsp,
 828                                 enum level2_contention_type type)
 829 {
 830         /* Only kernel oplocks implement this so far */
 831         if (koplocks && koplocks->ops->contend_level2_oplocks_end) {
 832                 koplocks->ops->contend_level2_oplocks_end(fsp, type);
 833         }
 834 }
 835
 836 /****************************************************************************
 837  Linearize a share mode entry struct to an internal oplock break message.
 838 ****************************************************************************/
 839
 840 void share_mode_entry_to_message(char *msg, const struct share_mode_entry *e)
 841 {
 842         SIVAL(msg,OP_BREAK_MSG_PID_OFFSET,(uint32)e->pid.pid);
 843         SBVAL(msg,OP_BREAK_MSG_MID_OFFSET,e->op_mid);
 844         SSVAL(msg,OP_BREAK_MSG_OP_TYPE_OFFSET,e->op_type);
 845         SIVAL(msg,OP_BREAK_MSG_ACCESS_MASK_OFFSET,e->access_mask);
 846         SIVAL(msg,OP_BREAK_MSG_SHARE_ACCESS_OFFSET,e->share_access);
 847         SIVAL(msg,OP_BREAK_MSG_PRIV_OFFSET,e->private_options);
 848         SIVAL(msg,OP_BREAK_MSG_TIME_SEC_OFFSET,(uint32_t)e->time.tv_sec);
 849         SIVAL(msg,OP_BREAK_MSG_TIME_USEC_OFFSET,(uint32_t)e->time.tv_usec);
 850         push_file_id_24(msg+OP_BREAK_MSG_DEV_OFFSET, &e->id);
 851         SIVAL(msg,OP_BREAK_MSG_FILE_ID_OFFSET,e->share_file_id);
 852         SIVAL(msg,OP_BREAK_MSG_UID_OFFSET,e->uid);
 853         SSVAL(msg,OP_BREAK_MSG_FLAGS_OFFSET,e->flags);
 854 #ifdef CLUSTER_SUPPORT
 855         SIVAL(msg,OP_BREAK_MSG_VNN_OFFSET,e->pid.vnn);
 856 #endif
 857 }
 858
 859 /****************************************************************************
 860  De-linearize an internal oplock break message to a share mode entry struct.
 861 ****************************************************************************/
 862
 863 void message_to_share_mode_entry(struct share_mode_entry *e, char *msg)
 864 {
 865         e->pid.pid = (pid_t)IVAL(msg,OP_BREAK_MSG_PID_OFFSET);
 866         e->op_mid = BVAL(msg,OP_BREAK_MSG_MID_OFFSET);
 867         e->op_type = SVAL(msg,OP_BREAK_MSG_OP_TYPE_OFFSET);
 868         e->access_mask = IVAL(msg,OP_BREAK_MSG_ACCESS_MASK_OFFSET);
 869         e->share_access = IVAL(msg,OP_BREAK_MSG_SHARE_ACCESS_OFFSET);
 870         e->private_options = IVAL(msg,OP_BREAK_MSG_PRIV_OFFSET);
 871         e->time.tv_sec = (time_t)IVAL(msg,OP_BREAK_MSG_TIME_SEC_OFFSET);
 872         e->time.tv_usec = (int)IVAL(msg,OP_BREAK_MSG_TIME_USEC_OFFSET);
 873         pull_file_id_24(msg+OP_BREAK_MSG_DEV_OFFSET, &e->id);
 874         e->share_file_id = (unsigned long)IVAL(msg,OP_BREAK_MSG_FILE_ID_OFFSET);
 875         e->uid = (uint32)IVAL(msg,OP_BREAK_MSG_UID_OFFSET);
 876         e->flags = (uint16)SVAL(msg,OP_BREAK_MSG_FLAGS_OFFSET);
 877 #ifdef CLUSTER_SUPPORT
 878         e->pid.vnn = IVAL(msg,OP_BREAK_MSG_VNN_OFFSET);
 879 #endif
 880 }
 881
 882 /****************************************************************************
 883  Setup oplocks for this process.
 884 ****************************************************************************/
 885
 886 bool init_oplocks(struct messaging_context *msg_ctx)
 887 {
 888         DEBUG(3,("init_oplocks: initializing messages.\n"));
 889
 890         messaging_register(msg_ctx, NULL, MSG_SMB_BREAK_REQUEST,
 891                            process_oplock_break_message);
 892         messaging_register(msg_ctx, NULL, MSG_SMB_ASYNC_LEVEL2_BREAK,
 893                            process_oplock_async_level2_break_message);
 894         messaging_register(msg_ctx, NULL, MSG_SMB_BREAK_RESPONSE,
 895                            process_oplock_break_response);
 896         messaging_register(msg_ctx, NULL, MSG_SMB_KERNEL_BREAK,
 897                            process_kernel_oplock_break);
 898         messaging_register(msg_ctx, NULL, MSG_SMB_OPEN_RETRY,
 899                            process_open_retry_message);
 900
 901         if (lp_kernel_oplocks()) {
 902 #if HAVE_KERNEL_OPLOCKS_IRIX
 903                 koplocks = irix_init_kernel_oplocks(talloc_autofree_context());
 904 #elif HAVE_KERNEL_OPLOCKS_LINUX
 905                 koplocks = linux_init_kernel_oplocks(talloc_autofree_context());
 906 #elif HAVE_ONEFS
 907                 koplocks = onefs_init_kernel_oplocks(talloc_autofree_context());
 908 #endif
 909         }
 910
 911         return True;
 912 }