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