2
* Unix SMB/CIFS implementation.
3
* Support for OneFS system interfaces.
5
* Copyright (C) Zack Kirsch, 2009
7
* This program is free software; you can redistribute it and/or modify
8
* it under the terms of the GNU General Public License as published by
9
* the Free Software Foundation; either version 3 of the License, or
10
* (at your option) any later version.
12
* This program is distributed in the hope that it will be useful,
13
* but WITHOUT ANY WARRANTY; without even the implied warranty of
14
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15
* GNU General Public License for more details.
17
* You should have received a copy of the GNU General Public License
18
* along with this program; if not, see <http://www.gnu.org/licenses/>.
24
#include <ifs/ifs_syscalls.h>
25
#include <sys/isi_cifs_brl.h>
26
#include <isi_ecs/isi_ecs_cbrl.h>
29
#define DBGC_CLASS DBGC_LOCKING
31
extern struct blocking_lock_record *blocking_lock_queue;
33
static uint64_t onefs_get_new_id(void) {
34
static uint64_t id = 0;
41
enum onefs_cbrl_lock_state {ONEFS_CBRL_NONE, ONEFS_CBRL_ASYNC, ONEFS_CBRL_DONE,
44
struct onefs_cbrl_blr_state {
46
enum onefs_cbrl_lock_state state;
49
static char *onefs_cbrl_blr_state_str(const struct blocking_lock_record *blr)
51
static fstring result;
52
struct onefs_cbrl_blr_state *bs;
56
bs = (struct onefs_cbrl_blr_state *)blr->blr_private;
59
fstrcpy(result, "NULL CBRL BLR state - Posix lock?");
65
fstr_sprintf(result, "CBRL BLR id=%llu: state=NONE", bs->id);
67
case ONEFS_CBRL_ASYNC:
68
fstr_sprintf(result, "CBRL BLR id=%llu: state=ASYNC", bs->id);
71
fstr_sprintf(result, "CBRL BLR id=%llu: state=DONE", bs->id);
73
case ONEFS_CBRL_ERROR:
74
fstr_sprintf(result, "CBRL BLR id=%llu: state=ERROR", bs->id);
77
fstr_sprintf(result, "CBRL BLR id=%llu: unknown state %d",
85
static void onefs_cbrl_enumerate_blq(const char *fn)
87
struct blocking_lock_record *blr;
92
DEBUG(10, ("CBRL BLR records (%s):\n", fn));
94
for (blr = blocking_lock_queue; blr; blr = blr->next)
95
DEBUGADD(10, ("%s\n", onefs_cbrl_blr_state_str(blr)));
98
static struct blocking_lock_record *onefs_cbrl_find_blr(uint64_t id)
100
struct blocking_lock_record *blr;
101
struct onefs_cbrl_blr_state *bs;
103
onefs_cbrl_enumerate_blq("onefs_cbrl_find_blr");
105
for (blr = blocking_lock_queue; blr; blr = blr->next) {
106
bs = (struct onefs_cbrl_blr_state *)blr->blr_private;
108
/* We don't control all of the BLRs on the BLQ. */
113
DEBUG(10, ("found %s\n",
114
onefs_cbrl_blr_state_str(blr)));
120
DEBUG(5, ("Could not find CBRL BLR for id %llu\n", id));
127
static void onefs_cbrl_async_success(uint64_t id)
129
struct blocking_lock_record *blr;
130
struct onefs_cbrl_blr_state *bs;
133
DEBUG(10, ("CBRL async success!\n"));
135
/* Find BLR with id. Its okay not to find one (race with cancel) */
136
blr = onefs_cbrl_find_blr(id);
140
bs = (struct onefs_cbrl_blr_state *)blr->blr_private;
142
SMB_ASSERT(bs->state == ONEFS_CBRL_ASYNC);
146
num_locks = SVAL(blr->req->vwv+7, 0);
148
if (blr->lock_num == num_locks)
149
bs->state = ONEFS_CBRL_DONE;
151
bs->state = ONEFS_CBRL_NONE;
153
/* Self contend our own level 2 oplock. The kernel handles
154
* contention of other opener's level 2 oplocks. */
155
contend_level2_oplocks_begin(blr->fsp,
156
LEVEL2_CONTEND_WINDOWS_BRL);
158
/* Process the queue, to try the next lock or finish up. */
159
process_blocking_lock_queue();
162
static void onefs_cbrl_async_failure(uint64_t id)
164
struct blocking_lock_record *blr;
165
struct onefs_cbrl_blr_state *bs;
167
DEBUG(10, ("CBRL async failure!\n"));
169
/* Find BLR with id. Its okay not to find one (race with cancel) */
170
blr = onefs_cbrl_find_blr(id);
174
bs = (struct onefs_cbrl_blr_state *)blr->blr_private;
177
SMB_ASSERT(bs->state == ONEFS_CBRL_ASYNC);
178
bs->state = ONEFS_CBRL_ERROR;
180
/* Process the queue. It will end up trying to retake the same lock,
181
* see the error in onefs_cbrl_lock_windows() and fail. */
182
process_blocking_lock_queue();
185
static struct cbrl_event_ops cbrl_ops =
186
{.cbrl_async_success = onefs_cbrl_async_success,
187
.cbrl_async_failure = onefs_cbrl_async_failure};
189
static void onefs_cbrl_events_handler(struct event_context *ev,
190
struct fd_event *fde,
194
DEBUG(10, ("onefs_cbrl_events_handler\n"));
196
if (cbrl_event_dispatcher(&cbrl_ops)) {
197
DEBUG(0, ("cbrl_event_dispatcher failed: %s\n",
202
static void onefs_init_cbrl(void)
204
static bool init_done = false;
205
static int cbrl_event_fd;
206
static struct fd_event *cbrl_fde;
211
DEBUG(10, ("onefs_init_cbrl\n"));
213
/* Register the event channel for CBRL. */
214
cbrl_event_fd = cbrl_event_register();
215
if (cbrl_event_fd == -1) {
216
DEBUG(0, ("cbrl_event_register failed: %s\n",
221
DEBUG(10, ("cbrl_event_fd = %d\n", cbrl_event_fd));
223
/* Register the CBRL event_fd with samba's event system */
224
cbrl_fde = event_add_fd(smbd_event_context(),
228
onefs_cbrl_events_handler,
236
* Blocking PID. As far as I can tell, the blocking_pid is only used to tell
237
* whether a posix lock or a CIFS lock blocked us. If it was a posix lock,
238
* Samba polls every 10 seconds, which we don't want. -zkirsch
240
#define ONEFS_BLOCKING_PID 0xABCDABCD
243
* @param[in] br_lck Contains the fsp.
244
* @param[in] plock Lock request.
245
* @param[in] blocking_lock Only used for figuring out the error.
246
* @param[in,out] blr The BLR for the already-deferred operation.
248
NTSTATUS onefs_brl_lock_windows(vfs_handle_struct *handle,
249
struct byte_range_lock *br_lck,
250
struct lock_struct *plock,
252
struct blocking_lock_record *blr)
254
int fd = br_lck->fsp->fh->fd;
256
enum cbrl_lock_type type;
258
bool pending = false;
259
bool pending_async = false;
261
struct onefs_cbrl_blr_state *bs;
264
START_PROFILE(syscall_brl_lock);
266
SMB_ASSERT(plock->lock_flav == WINDOWS_LOCK);
267
SMB_ASSERT(plock->lock_type != UNLOCK_LOCK);
269
onefs_cbrl_enumerate_blq("onefs_brl_lock_windows");
271
/* Will only initialize the first time its called. */
274
switch (plock->lock_type) {
281
case PENDING_WRITE_LOCK:
282
/* Called when a blocking lock request is added - do an
288
case PENDING_READ_LOCK:
289
/* Called when a blocking lock request is added - do an
296
/* UNLOCK_LOCK: should only be used for a POSIX_LOCK */
297
smb_panic("Invalid plock->lock_type passed in to "
298
"onefs_brl_lock_windows");
301
/* Figure out if we're actually doing the lock or a no-op. We need to
302
* do a no-op when process_blocking_lock_queue calls back into us.
304
* We know process_* is calling into us if a blr is passed in and
305
* pending is false. */
306
if (!pending && blr) {
307
/* Check the BLR state. */
308
bs = (struct onefs_cbrl_blr_state *)blr->blr_private;
311
/* ASYNC still in progress: The process_* calls will keep
312
* calling even if we haven't gotten the lock. Keep erroring
313
* without calling ifs_cbrl, or getting/setting an id. */
314
if (bs->state == ONEFS_CBRL_ASYNC) {
317
else if (bs->state == ONEFS_CBRL_ERROR) {
318
END_PROFILE(syscall_brl_lock);
319
return NT_STATUS_NO_MEMORY;
322
SMB_ASSERT(bs->state == ONEFS_CBRL_NONE);
327
SMB_ASSERT(blocking_lock);
329
id = onefs_get_new_id();
332
DEBUG(10, ("Calling ifs_cbrl(LOCK)...\n"));
333
error = ifs_cbrl(fd, CBRL_OP_LOCK, type, plock->start,
334
plock->size, async, id, plock->context.smbpid, plock->context.tid,
338
} else if (errno == EWOULDBLOCK) {
340
} else if (errno == EINPROGRESS) {
344
/* Talloc a new BLR private state. */
345
blr->blr_private = talloc(blr, struct onefs_cbrl_blr_state);
346
pending_async = true;
349
/* Store the new id in the BLR private state. */
350
bs = (struct onefs_cbrl_blr_state *)blr->blr_private;
352
bs->state = ONEFS_CBRL_ASYNC;
354
DEBUG(0, ("onefs_brl_lock_windows failure: error=%d (%s).\n",
355
errno, strerror(errno)));
360
END_PROFILE(syscall_brl_lock);
362
/* Failure - error or async. */
363
plock->context.smbpid = (uint32) ONEFS_BLOCKING_PID;
366
status = NT_STATUS_OK;
368
status = brl_lock_failed(br_lck->fsp, plock, blocking_lock);
370
DEBUG(10, ("returning %s.\n", nt_errstr(status)));
374
/* Self contend our own level 2 oplock. The kernel handles
375
* contention of other opener's level 2 oplocks. */
376
contend_level2_oplocks_begin(br_lck->fsp,
377
LEVEL2_CONTEND_WINDOWS_BRL);
379
END_PROFILE(syscall_brl_lock);
382
onefs_cbrl_enumerate_blq("onefs_brl_unlock_windows");
383
DEBUG(10, ("returning NT_STATUS_OK.\n"));
387
bool onefs_brl_unlock_windows(vfs_handle_struct *handle,
388
struct messaging_context *msg_ctx,
389
struct byte_range_lock *br_lck,
390
const struct lock_struct *plock)
393
int fd = br_lck->fsp->fh->fd;
395
START_PROFILE(syscall_brl_unlock);
397
SMB_ASSERT(plock->lock_flav == WINDOWS_LOCK);
398
SMB_ASSERT(plock->lock_type == UNLOCK_LOCK);
400
DEBUG(10, ("Calling ifs_cbrl(UNLOCK)...\n"));
401
error = ifs_cbrl(fd, CBRL_OP_UNLOCK, CBRL_LK_SH,
402
plock->start, plock->size, false, 0, plock->context.smbpid,
403
plock->context.tid, plock->fnum);
405
END_PROFILE(syscall_brl_unlock);
408
DEBUG(10, ("returning false.\n"));
412
/* For symmetry purposes, end our oplock contention even though its
413
* currently a no-op. */
414
contend_level2_oplocks_end(br_lck->fsp, LEVEL2_CONTEND_WINDOWS_BRL);
416
DEBUG(10, ("returning true.\n"));
419
/* Problem with storing things in TDB: I won't know what BRL to unlock in the TDB.
421
* - I could send Samba a message with which lock is being unlocked?
422
* - I could *easily* make the "id" something you always pass in to
423
* lock, unlock or cancel -- it identifies a lock. Makes sense!
427
/* Default implementation only calls this on PENDING locks. */
428
bool onefs_brl_cancel_windows(vfs_handle_struct *handle,
429
struct byte_range_lock *br_lck,
430
struct lock_struct *plock,
431
struct blocking_lock_record *blr)
434
int fd = br_lck->fsp->fh->fd;
435
struct onefs_cbrl_blr_state *bs;
437
START_PROFILE(syscall_brl_cancel);
440
SMB_ASSERT(plock->lock_flav == WINDOWS_LOCK);
443
onefs_cbrl_enumerate_blq("onefs_brl_cancel_windows");
445
bs = ((struct onefs_cbrl_blr_state *)blr->blr_private);
448
if (bs->state == ONEFS_CBRL_DONE || bs->state == ONEFS_CBRL_ERROR) {
450
DEBUG(10, ("State=%d, returning true\n", bs->state));
451
END_PROFILE(syscall_brl_cancel);
455
SMB_ASSERT(bs->state == ONEFS_CBRL_NONE ||
456
bs->state == ONEFS_CBRL_ASYNC);
459
DEBUG(10, ("Calling ifs_cbrl(CANCEL)...\n"));
460
error = ifs_cbrl(fd, CBRL_OP_CANCEL, CBRL_LK_UNSPEC, plock->start,
461
plock->size, false, bs->id, plock->context.smbpid,
462
plock->context.tid, plock->fnum);
464
END_PROFILE(syscall_brl_cancel);
467
DEBUG(10, ("returning false\n"));
468
bs->state = ONEFS_CBRL_ERROR;
472
bs->state = ONEFS_CBRL_DONE;
473
onefs_cbrl_enumerate_blq("onefs_brl_cancel_windows");
474
DEBUG(10, ("returning true\n"));
478
bool onefs_strict_lock(vfs_handle_struct *handle,
480
struct lock_struct *plock)
484
START_PROFILE(syscall_strict_lock);
486
SMB_ASSERT(plock->lock_type == READ_LOCK ||
487
plock->lock_type == WRITE_LOCK);
489
if (!lp_locking(handle->conn->params) ||
490
!lp_strict_locking(handle->conn->params)) {
491
END_PROFILE(syscall_strict_lock);
495
if (plock->lock_flav == POSIX_LOCK) {
496
END_PROFILE(syscall_strict_lock);
497
return SMB_VFS_NEXT_STRICT_LOCK(handle, fsp, plock);
500
if (plock->size == 0) {
501
END_PROFILE(syscall_strict_lock);
505
error = ifs_cbrl(fsp->fh->fd, CBRL_OP_LOCK,
506
plock->lock_type == READ_LOCK ? CBRL_LK_RD : CBRL_LK_WR,
507
plock->start, plock->size, 0, 0, plock->context.smbpid,
508
plock->context.tid, plock->fnum);
510
END_PROFILE(syscall_strict_lock);
515
void onefs_strict_unlock(vfs_handle_struct *handle,
517
struct lock_struct *plock)
519
START_PROFILE(syscall_strict_unlock);
521
SMB_ASSERT(plock->lock_type == READ_LOCK ||
522
plock->lock_type == WRITE_LOCK);
524
if (!lp_locking(handle->conn->params) ||
525
!lp_strict_locking(handle->conn->params)) {
526
END_PROFILE(syscall_strict_unlock);
530
if (plock->lock_flav == POSIX_LOCK) {
531
SMB_VFS_NEXT_STRICT_UNLOCK(handle, fsp, plock);
532
END_PROFILE(syscall_strict_unlock);
536
if (plock->size == 0) {
537
END_PROFILE(syscall_strict_unlock);
542
ifs_cbrl(fsp->fh->fd, CBRL_OP_UNLOCK,
543
plock->lock_type == READ_LOCK ? CBRL_LK_RD : CBRL_LK_WR,
544
plock->start, plock->size, 0, 0, plock->context.smbpid,
545
plock->context.tid, plock->fnum);
548
END_PROFILE(syscall_strict_unlock);
551
/* TODO Optimization: Abstract out brl_get_locks() in the Windows case.
552
* We'll malloc some memory or whatever (can't return NULL), but not actually
555
/* XXX brl_locktest: CBRL does not support calling this, but its only for
556
* strict locking. Add empty VOP? */
558
/* XXX brl_lockquery: CBRL does not support calling this for WINDOWS LOCKS, but
559
* its only called for POSIX LOCKS. Add empty VOP? */
561
/* XXX brl_close_fnum: CBRL will do this automatically. I think this is a NO-OP
562
* for us, we could add an empty VOP. */