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