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(
 260         struct smbd_server_connection *sconn, struct file_id id,
 261         unsigned long file_id)
 262 {
 263         files_struct *fsp = NULL;
 264
 265         if( DEBUGLVL( 3 ) ) {
 266                 dbgtext( "initial_break_processing: called for %s/%u\n",
 267                          file_id_string_tos(&id), (int)file_id);
 268                 dbgtext( "Current oplocks_open (exclusive = %d, levelII = %d)\n",
 269                         exclusive_oplocks_open, level_II_oplocks_open );
 270         }
 271
 272         /*
 273          * We need to search the file open table for the
 274          * entry containing this dev and inode, and ensure
 275          * we have an oplock on it.
 276          */
 277
 278         fsp = file_find_dif(sconn, id, file_id);
 279
 280         if(fsp == NULL) {
 281                 /* The file could have been closed in the meantime - return success. */
 282                 if( DEBUGLVL( 3 ) ) {
 283                         dbgtext( "initial_break_processing: cannot find open file with " );
 284                         dbgtext( "file_id %s gen_id = %lu", file_id_string_tos(&id), file_id);
 285                         dbgtext( "allowing break to succeed.\n" );
 286                 }
 287                 return NULL;
 288         }
 289
 290         /* Ensure we have an oplock on the file */
 291
 292         /*
 293          * There is a potential race condition in that an oplock could
 294          * have been broken due to another udp request, and yet there are
 295          * still oplock break messages being sent in the udp message
 296          * queue for this file. So return true if we don't have an oplock,
 297          * as we may have just freed it.
 298          */
 299
 300         if(fsp->oplock_type == NO_OPLOCK) {
 301                 if( DEBUGLVL( 3 ) ) {
 302                         dbgtext( "initial_break_processing: file %s ",
 303                                  fsp_str_dbg(fsp));
 304                         dbgtext( "(file_id = %s gen_id = %lu) has no oplock.\n",
 305                                  file_id_string_tos(&id), fsp->fh->gen_id );
 306                         dbgtext( "Allowing break to succeed regardless.\n" );
 307                 }
 308                 return NULL;
 309         }
 310
 311         return fsp;
 312 }
 313
 314 static void oplock_timeout_handler(struct event_context *ctx,
 315                                    struct timed_event *te,
 316                                    struct timeval now,
 317                                    void *private_data)
 318 {
 319         files_struct *fsp = (files_struct *)private_data;
 320
 321         /* Remove the timed event handler. */
 322         TALLOC_FREE(fsp->oplock_timeout);
 323         DEBUG(0, ("Oplock break failed for file %s -- replying anyway\n",
 324                   fsp_str_dbg(fsp)));
 325         remove_oplock(fsp);
 326         reply_to_oplock_break_requests(fsp);
 327 }
 328
 329 /*******************************************************************
 330  Add a timeout handler waiting for the client reply.
 331 *******************************************************************/
 332
 333 static void add_oplock_timeout_handler(files_struct *fsp)
 334 {
 335         /*
 336          * If kernel oplocks already notifies smbds when an oplock break times
 337          * out, just return.
 338          */
 339         if (koplocks &&
 340             (koplocks->flags & KOPLOCKS_TIMEOUT_NOTIFICATION)) {
 341                 return;
 342         }
 343
 344         if (fsp->oplock_timeout != NULL) {
 345                 DEBUG(0, ("Logic problem -- have an oplock event hanging "
 346                           "around\n"));
 347         }
 348
 349         fsp->oplock_timeout =
 350                 event_add_timed(smbd_event_context(), fsp,
 351                                 timeval_current_ofs(OPLOCK_BREAK_TIMEOUT, 0),
 352                                 oplock_timeout_handler, fsp);
 353
 354         if (fsp->oplock_timeout == NULL) {
 355                 DEBUG(0, ("Could not add oplock timeout handler\n"));
 356         }
 357 }
 358
 359 static void send_break_message_smb1(files_struct *fsp, int level)
 360 {
 361         char *break_msg = new_break_message_smb1(talloc_tos(),
 362                                         fsp,
 363                                         level);
 364         if (break_msg == NULL) {
 365                 exit_server("Could not talloc break_msg\n");
 366         }
 367
 368         show_msg(break_msg);
 369         if (!srv_send_smb(fsp->conn->sconn,
 370                         break_msg, false, 0,
 371                         IS_CONN_ENCRYPTED(fsp->conn),
 372                         NULL)) {
 373                 exit_server_cleanly("send_break_message_smb1: "
 374                         "srv_send_smb failed.");
 375         }
 376
 377         TALLOC_FREE(break_msg);
 378 }
 379
 380 void break_level2_to_none_async(files_struct *fsp)
 381 {
 382         struct smbd_server_connection *sconn = fsp->conn->sconn;
 383
 384         if (fsp->oplock_type == NO_OPLOCK) {
 385                 /* We already got a "break to none" message and we've handled
 386                  * it.  just ignore. */
 387                 DEBUG(3, ("process_oplock_async_level2_break_message: already "
 388                           "broken to none, ignoring.\n"));
 389                 return;
 390         }
 391
 392         if (fsp->oplock_type == FAKE_LEVEL_II_OPLOCK) {
 393                 /* Don't tell the client, just downgrade. */
 394                 DEBUG(3, ("process_oplock_async_level2_break_message: "
 395                           "downgrading fake level 2 oplock.\n"));
 396                 remove_oplock(fsp);
 397                 return;
 398         }
 399
 400         /* Ensure we're really at level2 state. */
 401         SMB_ASSERT(fsp->oplock_type == LEVEL_II_OPLOCK);
 402
 403         DEBUG(10,("process_oplock_async_level2_break_message: sending break "
 404                   "to none message for fid %d, file %s\n", fsp->fnum,
 405                   fsp_str_dbg(fsp)));
 406
 407         /* Now send a break to none message to our client. */
 408         if (sconn->using_smb2) {
 409                 send_break_message_smb2(fsp, OPLOCKLEVEL_NONE);
 410         } else {
 411                 send_break_message_smb1(fsp, OPLOCKLEVEL_NONE);
 412         }
 413
 414         /* Async level2 request, don't send a reply, just remove the oplock. */
 415         remove_oplock(fsp);
 416 }
 417
 418 /*******************************************************************
 419  This handles the case of a write triggering a break to none
 420  message on a level2 oplock.
 421  When we get this message we may be in any of three states :
 422  NO_OPLOCK, LEVEL_II, FAKE_LEVEL2. We only send a message to
 423  the client for LEVEL2.
 424 *******************************************************************/
 425
 426 void process_oplock_async_level2_break_message(struct messaging_context *msg_ctx,
 427                                                       void *private_data,
 428                                                       uint32_t msg_type,
 429                                                       struct server_id src,
 430                                                       DATA_BLOB *data)
 431 {
 432         struct share_mode_entry msg;
 433         files_struct *fsp;
 434
 435         if (data->data == NULL) {
 436                 DEBUG(0, ("Got NULL buffer\n"));
 437                 return;
 438         }
 439
 440         if (data->length != MSG_SMB_SHARE_MODE_ENTRY_SIZE) {
 441                 DEBUG(0, ("Got invalid msg len %d\n", (int)data->length));
 442                 return;
 443         }
 444
 445         /* De-linearize incoming message. */
 446         message_to_share_mode_entry(&msg, (char *)data->data);
 447
 448         DEBUG(10, ("Got oplock async level 2 break message from pid %s: "
 449                    "%s/%lu\n", procid_str(talloc_tos(), &src),
 450                    file_id_string_tos(&msg.id), msg.share_file_id));
 451
 452         fsp = initial_break_processing(smbd_server_conn, msg.id,
 453                                        msg.share_file_id);
 454
 455         if (fsp == NULL) {
 456                 /* We hit a race here. Break messages are sent, and before we
 457                  * get to process this message, we have closed the file.
 458                  * No need to reply as this is an async message. */
 459                 DEBUG(3, ("process_oplock_async_level2_break_message: Did not find fsp, ignoring\n"));
 460                 return;
 461         }
 462
 463         break_level2_to_none_async(fsp);
 464 }
 465
 466 /*******************************************************************
 467  This handles the generic oplock break message from another smbd.
 468 *******************************************************************/
 469
 470 static void process_oplock_break_message(struct messaging_context *msg_ctx,
 471                                          void *private_data,
 472                                          uint32_t msg_type,
 473                                          struct server_id src,
 474                                          DATA_BLOB *data)
 475 {
 476         struct smbd_server_connection *sconn = smbd_server_conn;
 477         struct share_mode_entry msg;
 478         files_struct *fsp;
 479         bool break_to_level2 = False;
 480
 481         if (data->data == NULL) {
 482                 DEBUG(0, ("Got NULL buffer\n"));
 483                 return;
 484         }
 485
 486         if (data->length != MSG_SMB_SHARE_MODE_ENTRY_SIZE) {
 487                 DEBUG(0, ("Got invalid msg len %d\n", (int)data->length));
 488                 return;
 489         }
 490
 491         /* De-linearize incoming message. */
 492         message_to_share_mode_entry(&msg, (char *)data->data);
 493
 494         DEBUG(10, ("Got oplock break message from pid %s: %s/%lu\n",
 495                    procid_str(talloc_tos(), &src), file_id_string_tos(&msg.id),
 496                    msg.share_file_id));
 497
 498         fsp = initial_break_processing(smbd_server_conn, msg.id,
 499                                        msg.share_file_id);
 500
 501         if (fsp == NULL) {
 502                 /* We hit a race here. Break messages are sent, and before we
 503                  * get to process this message, we have closed the file. Reply
 504                  * with 'ok, oplock broken' */
 505                 DEBUG(3, ("Did not find fsp\n"));
 506
 507                 /* We just send the same message back. */
 508                 messaging_send_buf(msg_ctx, src, MSG_SMB_BREAK_RESPONSE,
 509                                    (uint8 *)data->data,
 510                                    MSG_SMB_SHARE_MODE_ENTRY_SIZE);
 511                 return;
 512         }
 513
 514         if (fsp->sent_oplock_break != NO_BREAK_SENT) {
 515                 /* Remember we have to inform the requesting PID when the
 516                  * client replies */
 517                 msg.pid = src;
 518                 ADD_TO_ARRAY(NULL, struct share_mode_entry, msg,
 519                              &fsp->pending_break_messages,
 520                              &fsp->num_pending_break_messages);
 521                 return;
 522         }
 523
 524         if (EXCLUSIVE_OPLOCK_TYPE(msg.op_type) &&
 525             !EXCLUSIVE_OPLOCK_TYPE(fsp->oplock_type)) {
 526                 DEBUG(3, ("Already downgraded oplock on %s: %s\n",
 527                           file_id_string_tos(&fsp->file_id),
 528                           fsp_str_dbg(fsp)));
 529                 /* We just send the same message back. */
 530                 messaging_send_buf(msg_ctx, src, MSG_SMB_BREAK_RESPONSE,
 531                                    (uint8 *)data->data,
 532                                    MSG_SMB_SHARE_MODE_ENTRY_SIZE);
 533                 return;
 534         }
 535
 536         if ((global_client_caps & CAP_LEVEL_II_OPLOCKS) &&
 537             !(msg.op_type & FORCE_OPLOCK_BREAK_TO_NONE) &&
 538             !(koplocks && !(koplocks->flags & KOPLOCKS_LEVEL2_SUPPORTED)) &&
 539             lp_level2_oplocks(SNUM(fsp->conn))) {
 540                 break_to_level2 = True;
 541         }
 542
 543         /* Need to wait before sending a break
 544            message if we sent ourselves this message. */
 545         if (procid_is_me(&src)) {
 546                 wait_before_sending_break();
 547         }
 548
 549         if (sconn->using_smb2) {
 550                 send_break_message_smb2(fsp, break_to_level2 ?
 551                         OPLOCKLEVEL_II : OPLOCKLEVEL_NONE);
 552         } else {
 553                 send_break_message_smb1(fsp, break_to_level2 ?
 554                         OPLOCKLEVEL_II : OPLOCKLEVEL_NONE);
 555         }
 556
 557         fsp->sent_oplock_break = break_to_level2 ? LEVEL_II_BREAK_SENT:BREAK_TO_NONE_SENT;
 558
 559         msg.pid = src;
 560         ADD_TO_ARRAY(NULL, struct share_mode_entry, msg,
 561                      &fsp->pending_break_messages,
 562                      &fsp->num_pending_break_messages);
 563
 564         add_oplock_timeout_handler(fsp);
 565 }
 566
 567 /*******************************************************************
 568  This handles the kernel oplock break message.
 569 *******************************************************************/
 570
 571 static void process_kernel_oplock_break(struct messaging_context *msg_ctx,
 572                                         void *private_data,
 573                                         uint32_t msg_type,
 574                                         struct server_id src,
 575                                         DATA_BLOB *data)
 576 {
 577         struct smbd_server_connection *sconn = smbd_server_conn;
 578         struct file_id id;
 579         unsigned long file_id;
 580         files_struct *fsp;
 581
 582         if (data->data == NULL) {
 583                 DEBUG(0, ("Got NULL buffer\n"));
 584                 return;
 585         }
 586
 587         if (data->length != MSG_SMB_KERNEL_BREAK_SIZE) {
 588                 DEBUG(0, ("Got invalid msg len %d\n", (int)data->length));
 589                 return;
 590         }
 591
 592         /* Pull the data from the message. */
 593         pull_file_id_24((char *)data->data, &id);
 594         file_id = (unsigned long)IVAL(data->data, 24);
 595
 596         DEBUG(10, ("Got kernel oplock break message from pid %s: %s/%u\n",
 597                    procid_str(talloc_tos(), &src), file_id_string_tos(&id),
 598                    (unsigned int)file_id));
 599
 600         fsp = initial_break_processing(smbd_server_conn, id, file_id);
 601
 602         if (fsp == NULL) {
 603                 DEBUG(3, ("Got a kernel oplock break message for a file "
 604                           "I don't know about\n"));
 605                 return;
 606         }
 607
 608         if (fsp->sent_oplock_break != NO_BREAK_SENT) {
 609                 /* This is ok, kernel oplocks come in completely async */
 610                 DEBUG(3, ("Got a kernel oplock request while waiting for a "
 611                           "break reply\n"));
 612                 return;
 613         }
 614
 615         if (sconn->using_smb2) {
 616                 send_break_message_smb2(fsp, OPLOCKLEVEL_NONE);
 617         } else {
 618                 send_break_message_smb1(fsp, OPLOCKLEVEL_NONE);
 619         }
 620
 621         fsp->sent_oplock_break = BREAK_TO_NONE_SENT;
 622
 623         add_oplock_timeout_handler(fsp);
 624 }
 625
 626 void reply_to_oplock_break_requests(files_struct *fsp)
 627 {
 628         int i;
 629
 630         /*
 631          * If kernel oplocks already notifies smbds when oplocks are
 632          * broken/removed, just return.
 633          */
 634         if (koplocks &&
 635             (koplocks->flags & KOPLOCKS_OPLOCK_BROKEN_NOTIFICATION)) {
 636                 return;
 637         }
 638
 639         for (i=0; i<fsp->num_pending_break_messages; i++) {
 640                 struct share_mode_entry *e = &fsp->pending_break_messages[i];
 641                 char msg[MSG_SMB_SHARE_MODE_ENTRY_SIZE];
 642
 643                 share_mode_entry_to_message(msg, e);
 644
 645                 messaging_send_buf(fsp->conn->sconn->msg_ctx, e->pid,
 646                                    MSG_SMB_BREAK_RESPONSE,
 647                                    (uint8 *)msg,
 648                                    MSG_SMB_SHARE_MODE_ENTRY_SIZE);
 649         }
 650
 651         SAFE_FREE(fsp->pending_break_messages);
 652         fsp->num_pending_break_messages = 0;
 653         if (fsp->oplock_timeout != NULL) {
 654                 /* Remove the timed event handler. */
 655                 TALLOC_FREE(fsp->oplock_timeout);
 656                 fsp->oplock_timeout = NULL;
 657         }
 658         return;
 659 }
 660
 661 static void process_oplock_break_response(struct messaging_context *msg_ctx,
 662                                           void *private_data,
 663                                           uint32_t msg_type,
 664                                           struct server_id src,
 665                                           DATA_BLOB *data)
 666 {
 667         struct share_mode_entry msg;
 668
 669         if (data->data == NULL) {
 670                 DEBUG(0, ("Got NULL buffer\n"));
 671                 return;
 672         }
 673
 674         if (data->length != MSG_SMB_SHARE_MODE_ENTRY_SIZE) {
 675                 DEBUG(0, ("Got invalid msg len %u\n",
 676                           (unsigned int)data->length));
 677                 return;
 678         }
 679
 680         /* De-linearize incoming message. */
 681         message_to_share_mode_entry(&msg, (char *)data->data);
 682
 683         DEBUG(10, ("Got oplock break response from pid %s: %s/%lu mid %llu\n",
 684                    procid_str(talloc_tos(), &src), file_id_string_tos(&msg.id),
 685                    msg.share_file_id, (unsigned long long)msg.op_mid));
 686
 687         schedule_deferred_open_message_smb(msg.op_mid);
 688 }
 689
 690 static void process_open_retry_message(struct messaging_context *msg_ctx,
 691                                        void *private_data,
 692                                        uint32_t msg_type,
 693                                        struct server_id src,
 694                                        DATA_BLOB *data)
 695 {
 696         struct share_mode_entry msg;
 697
 698         if (data->data == NULL) {
 699                 DEBUG(0, ("Got NULL buffer\n"));
 700                 return;
 701         }
 702
 703         if (data->length != MSG_SMB_SHARE_MODE_ENTRY_SIZE) {
 704                 DEBUG(0, ("Got invalid msg len %d\n", (int)data->length));
 705                 return;
 706         }
 707
 708         /* De-linearize incoming message. */
 709         message_to_share_mode_entry(&msg, (char *)data->data);
 710
 711         DEBUG(10, ("Got open retry msg from pid %s: %s mid %llu\n",
 712                    procid_str(talloc_tos(), &src), file_id_string_tos(&msg.id),
 713                    (unsigned long long)msg.op_mid));
 714
 715         schedule_deferred_open_message_smb(msg.op_mid);
 716 }
 717
 718 /****************************************************************************
 719  This function is called on any file modification or lock request. If a file
 720  is level 2 oplocked then it must tell all other level 2 holders to break to
 721  none.
 722 ****************************************************************************/
 723
 724 static void contend_level2_oplocks_begin_default(files_struct *fsp,
 725                                               enum level2_contention_type type)
 726 {
 727         int i;
 728         struct share_mode_lock *lck;
 729
 730         /*
 731          * If this file is level II oplocked then we need
 732          * to grab the shared memory lock and inform all
 733          * other files with a level II lock that they need
 734          * to flush their read caches. We keep the lock over
 735          * the shared memory area whilst doing this.
 736          */
 737
 738         if (!LEVEL_II_OPLOCK_TYPE(fsp->oplock_type))
 739                 return;
 740
 741         lck = get_share_mode_lock(talloc_tos(), fsp->file_id, NULL, NULL,
 742                                   NULL);
 743         if (lck == NULL) {
 744                 DEBUG(0,("release_level_2_oplocks_on_change: failed to lock "
 745                          "share mode entry for file %s.\n", fsp_str_dbg(fsp)));
 746                 return;
 747         }
 748
 749         DEBUG(10,("release_level_2_oplocks_on_change: num_share_modes = %d\n",
 750                   lck->num_share_modes ));
 751
 752         for(i = 0; i < lck->num_share_modes; i++) {
 753                 struct share_mode_entry *share_entry = &lck->share_modes[i];
 754                 char msg[MSG_SMB_SHARE_MODE_ENTRY_SIZE];
 755
 756                 if (!is_valid_share_mode_entry(share_entry)) {
 757                         continue;
 758                 }
 759
 760                 /*
 761                  * As there could have been multiple writes waiting at the
 762                  * lock_share_entry gate we may not be the first to
 763                  * enter. Hence the state of the op_types in the share mode
 764                  * entries may be partly NO_OPLOCK and partly LEVEL_II or FAKE_LEVEL_II
 765                  * oplock. It will do no harm to re-send break messages to
 766                  * those smbd's that are still waiting their turn to remove
 767                  * their LEVEL_II state, and also no harm to ignore existing
 768                  * NO_OPLOCK states. JRA.
 769                  */
 770
 771                 DEBUG(10,("release_level_2_oplocks_on_change: "
 772                           "share_entry[%i]->op_type == %d\n",
 773                           i, share_entry->op_type ));
 774
 775                 if (share_entry->op_type == NO_OPLOCK) {
 776                         continue;
 777                 }
 778
 779                 /* Paranoia .... */
 780                 if (EXCLUSIVE_OPLOCK_TYPE(share_entry->op_type)) {
 781                         DEBUG(0,("release_level_2_oplocks_on_change: PANIC. "
 782                                  "share mode entry %d is an exlusive "
 783                                  "oplock !\n", i ));
 784                         TALLOC_FREE(lck);
 785                         abort();
 786                 }
 787
 788                 share_mode_entry_to_message(msg, share_entry);
 789
 790                 /*
 791                  * Deal with a race condition when breaking level2
 792                  * oplocks. Don't send all the messages and release
 793                  * the lock, this allows someone else to come in and
 794                  * get a level2 lock before any of the messages are
 795                  * processed, and thus miss getting a break message.
 796                  * Ensure at least one entry (the one we're breaking)
 797                  * is processed immediately under the lock and becomes
 798                  * set as NO_OPLOCK to stop any waiter getting a level2.
 799                  * Bugid #5980.
 800                  */
 801
 802                 if (procid_is_me(&share_entry->pid)) {
 803                         wait_before_sending_break();
 804                         break_level2_to_none_async(fsp);
 805                 } else {
 806                         messaging_send_buf(fsp->conn->sconn->msg_ctx,
 807                                         share_entry->pid,
 808                                         MSG_SMB_ASYNC_LEVEL2_BREAK,
 809                                         (uint8 *)msg,
 810                                         MSG_SMB_SHARE_MODE_ENTRY_SIZE);
 811                 }
 812         }
 813
 814         /* We let the message receivers handle removing the oplock state
 815            in the share mode lock db. */
 816
 817         TALLOC_FREE(lck);
 818 }
 819
 820 void contend_level2_oplocks_begin(files_struct *fsp,
 821                                   enum level2_contention_type type)
 822 {
 823         if (koplocks && koplocks->ops->contend_level2_oplocks_begin) {
 824                 koplocks->ops->contend_level2_oplocks_begin(fsp, type);
 825                 return;
 826         }
 827
 828         contend_level2_oplocks_begin_default(fsp, type);
 829 }
 830
 831 void contend_level2_oplocks_end(files_struct *fsp,
 832                                 enum level2_contention_type type)
 833 {
 834         /* Only kernel oplocks implement this so far */
 835         if (koplocks && koplocks->ops->contend_level2_oplocks_end) {
 836                 koplocks->ops->contend_level2_oplocks_end(fsp, type);
 837         }
 838 }
 839
 840 /****************************************************************************
 841  Linearize a share mode entry struct to an internal oplock break message.
 842 ****************************************************************************/
 843
 844 void share_mode_entry_to_message(char *msg, const struct share_mode_entry *e)
 845 {
 846         SIVAL(msg,OP_BREAK_MSG_PID_OFFSET,(uint32)e->pid.pid);
 847         SBVAL(msg,OP_BREAK_MSG_MID_OFFSET,e->op_mid);
 848         SSVAL(msg,OP_BREAK_MSG_OP_TYPE_OFFSET,e->op_type);
 849         SIVAL(msg,OP_BREAK_MSG_ACCESS_MASK_OFFSET,e->access_mask);
 850         SIVAL(msg,OP_BREAK_MSG_SHARE_ACCESS_OFFSET,e->share_access);
 851         SIVAL(msg,OP_BREAK_MSG_PRIV_OFFSET,e->private_options);
 852         SIVAL(msg,OP_BREAK_MSG_TIME_SEC_OFFSET,(uint32_t)e->time.tv_sec);
 853         SIVAL(msg,OP_BREAK_MSG_TIME_USEC_OFFSET,(uint32_t)e->time.tv_usec);
 854         push_file_id_24(msg+OP_BREAK_MSG_DEV_OFFSET, &e->id);
 855         SIVAL(msg,OP_BREAK_MSG_FILE_ID_OFFSET,e->share_file_id);
 856         SIVAL(msg,OP_BREAK_MSG_UID_OFFSET,e->uid);
 857         SSVAL(msg,OP_BREAK_MSG_FLAGS_OFFSET,e->flags);
 858 #ifdef CLUSTER_SUPPORT
 859         SIVAL(msg,OP_BREAK_MSG_VNN_OFFSET,e->pid.vnn);
 860 #endif
 861 }
 862
 863 /****************************************************************************
 864  De-linearize an internal oplock break message to a share mode entry struct.
 865 ****************************************************************************/
 866
 867 void message_to_share_mode_entry(struct share_mode_entry *e, char *msg)
 868 {
 869         e->pid.pid = (pid_t)IVAL(msg,OP_BREAK_MSG_PID_OFFSET);
 870         e->op_mid = BVAL(msg,OP_BREAK_MSG_MID_OFFSET);
 871         e->op_type = SVAL(msg,OP_BREAK_MSG_OP_TYPE_OFFSET);
 872         e->access_mask = IVAL(msg,OP_BREAK_MSG_ACCESS_MASK_OFFSET);
 873         e->share_access = IVAL(msg,OP_BREAK_MSG_SHARE_ACCESS_OFFSET);
 874         e->private_options = IVAL(msg,OP_BREAK_MSG_PRIV_OFFSET);
 875         e->time.tv_sec = (time_t)IVAL(msg,OP_BREAK_MSG_TIME_SEC_OFFSET);
 876         e->time.tv_usec = (int)IVAL(msg,OP_BREAK_MSG_TIME_USEC_OFFSET);
 877         pull_file_id_24(msg+OP_BREAK_MSG_DEV_OFFSET, &e->id);
 878         e->share_file_id = (unsigned long)IVAL(msg,OP_BREAK_MSG_FILE_ID_OFFSET);
 879         e->uid = (uint32)IVAL(msg,OP_BREAK_MSG_UID_OFFSET);
 880         e->flags = (uint16)SVAL(msg,OP_BREAK_MSG_FLAGS_OFFSET);
 881 #ifdef CLUSTER_SUPPORT
 882         e->pid.vnn = IVAL(msg,OP_BREAK_MSG_VNN_OFFSET);
 883 #endif
 884 }
 885
 886 /****************************************************************************
 887  Setup oplocks for this process.
 888 ****************************************************************************/
 889
 890 bool init_oplocks(struct messaging_context *msg_ctx)
 891 {
 892         DEBUG(3,("init_oplocks: initializing messages.\n"));
 893
 894         messaging_register(msg_ctx, NULL, MSG_SMB_BREAK_REQUEST,
 895                            process_oplock_break_message);
 896         messaging_register(msg_ctx, NULL, MSG_SMB_ASYNC_LEVEL2_BREAK,
 897                            process_oplock_async_level2_break_message);
 898         messaging_register(msg_ctx, NULL, MSG_SMB_BREAK_RESPONSE,
 899                            process_oplock_break_response);
 900         messaging_register(msg_ctx, NULL, MSG_SMB_KERNEL_BREAK,
 901                            process_kernel_oplock_break);
 902         messaging_register(msg_ctx, NULL, MSG_SMB_OPEN_RETRY,
 903                            process_open_retry_message);
 904
 905         if (lp_kernel_oplocks()) {
 906 #if HAVE_KERNEL_OPLOCKS_IRIX
 907                 koplocks = irix_init_kernel_oplocks(talloc_autofree_context());
 908 #elif HAVE_KERNEL_OPLOCKS_LINUX
 909                 koplocks = linux_init_kernel_oplocks(talloc_autofree_context());
 910 #elif HAVE_ONEFS
 911                 koplocks = onefs_init_kernel_oplocks(talloc_autofree_context());
 912 #endif
 913         }
 914
 915         return True;
 916 }