1 // SPDX-License-Identifier: GPL-2.0-only
3 * Copyright (C) 2005-2008 Red Hat, Inc. All rights reserved.
7 #include <linux/miscdevice.h>
8 #include <linux/poll.h>
10 #include <linux/dlm_plock.h>
11 #include <linux/slab.h>
13 #include "dlm_internal.h"
14 #include "lockspace.h"
16 static spinlock_t ops_lock;
17 static struct list_head send_list;
18 static struct list_head recv_list;
19 static wait_queue_head_t send_wq;
20 static wait_queue_head_t recv_wq;
23 struct list_head list;
25 struct dlm_plock_info info;
26 int (*callback)(struct file_lock *fl, int result);
37 static inline void set_version(struct dlm_plock_info *info)
39 info->version[0] = DLM_PLOCK_VERSION_MAJOR;
40 info->version[1] = DLM_PLOCK_VERSION_MINOR;
41 info->version[2] = DLM_PLOCK_VERSION_PATCH;
44 static int check_version(struct dlm_plock_info *info)
46 if ((DLM_PLOCK_VERSION_MAJOR != info->version[0]) ||
47 (DLM_PLOCK_VERSION_MINOR < info->version[1])) {
48 log_print("plock device version mismatch: "
49 "kernel (%u.%u.%u), user (%u.%u.%u)",
50 DLM_PLOCK_VERSION_MAJOR,
51 DLM_PLOCK_VERSION_MINOR,
52 DLM_PLOCK_VERSION_PATCH,
61 static void send_op(struct plock_op *op)
63 set_version(&op->info);
64 INIT_LIST_HEAD(&op->list);
66 list_add_tail(&op->list, &send_list);
67 spin_unlock(&ops_lock);
71 /* If a process was killed while waiting for the only plock on a file,
72 locks_remove_posix will not see any lock on the file so it won't
73 send an unlock-close to us to pass on to userspace to clean up the
74 abandoned waiter. So, we have to insert the unlock-close when the
75 lock call is interrupted. */
77 static void do_unlock_close(struct dlm_ls *ls, u64 number,
78 struct file *file, struct file_lock *fl)
82 op = kzalloc(sizeof(*op), GFP_NOFS);
86 op->info.optype = DLM_PLOCK_OP_UNLOCK;
87 op->info.pid = fl->fl_pid;
88 op->info.fsid = ls->ls_global_id;
89 op->info.number = number;
91 op->info.end = OFFSET_MAX;
92 if (fl->fl_lmops && fl->fl_lmops->lm_grant)
93 op->info.owner = (__u64) fl->fl_pid;
95 op->info.owner = (__u64)(long) fl->fl_owner;
97 op->info.flags |= DLM_PLOCK_FL_CLOSE;
101 int dlm_posix_lock(dlm_lockspace_t *lockspace, u64 number, struct file *file,
102 int cmd, struct file_lock *fl)
106 struct plock_xop *xop;
109 ls = dlm_find_lockspace_local(lockspace);
113 xop = kzalloc(sizeof(*xop), GFP_NOFS);
120 op->info.optype = DLM_PLOCK_OP_LOCK;
121 op->info.pid = fl->fl_pid;
122 op->info.ex = (fl->fl_type == F_WRLCK);
123 op->info.wait = IS_SETLKW(cmd);
124 op->info.fsid = ls->ls_global_id;
125 op->info.number = number;
126 op->info.start = fl->fl_start;
127 op->info.end = fl->fl_end;
128 if (fl->fl_lmops && fl->fl_lmops->lm_grant) {
129 /* fl_owner is lockd which doesn't distinguish
130 processes on the nfs client */
131 op->info.owner = (__u64) fl->fl_pid;
132 op->callback = fl->fl_lmops->lm_grant;
133 locks_init_lock(&xop->flc);
134 locks_copy_lock(&xop->flc, fl);
138 op->info.owner = (__u64)(long) fl->fl_owner;
144 rv = wait_event_interruptible(recv_wq, (op->done != 0));
145 if (rv == -ERESTARTSYS) {
146 log_debug(ls, "dlm_posix_lock: wait killed %llx",
147 (unsigned long long)number);
148 spin_lock(&ops_lock);
150 spin_unlock(&ops_lock);
152 do_unlock_close(ls, number, file, fl);
156 rv = FILE_LOCK_DEFERRED;
160 spin_lock(&ops_lock);
161 if (!list_empty(&op->list)) {
162 log_error(ls, "dlm_posix_lock: op on list %llx",
163 (unsigned long long)number);
166 spin_unlock(&ops_lock);
171 if (locks_lock_file_wait(file, fl) < 0)
172 log_error(ls, "dlm_posix_lock: vfs lock error %llx",
173 (unsigned long long)number);
178 dlm_put_lockspace(ls);
181 EXPORT_SYMBOL_GPL(dlm_posix_lock);
183 /* Returns failure iff a successful lock operation should be canceled */
184 static int dlm_plock_callback(struct plock_op *op)
187 struct file_lock *fl;
188 struct file_lock *flc;
189 int (*notify)(struct file_lock *fl, int result) = NULL;
190 struct plock_xop *xop = (struct plock_xop *)op;
193 spin_lock(&ops_lock);
194 if (!list_empty(&op->list)) {
195 log_print("dlm_plock_callback: op on list %llx",
196 (unsigned long long)op->info.number);
199 spin_unlock(&ops_lock);
201 /* check if the following 2 are still valid or make a copy */
205 notify = op->callback;
208 notify(fl, op->info.rv);
212 /* got fs lock; bookkeep locally as well: */
213 flc->fl_flags &= ~FL_SLEEP;
214 if (posix_lock_file(file, flc, NULL)) {
216 * This can only happen in the case of kmalloc() failure.
217 * The filesystem's own lock is the authoritative lock,
218 * so a failure to get the lock locally is not a disaster.
219 * As long as the fs cannot reliably cancel locks (especially
220 * in a low-memory situation), we're better off ignoring
221 * this failure than trying to recover.
223 log_print("dlm_plock_callback: vfs lock error %llx file %p fl %p",
224 (unsigned long long)op->info.number, file, fl);
229 /* XXX: We need to cancel the fs lock here: */
230 log_print("dlm_plock_callback: lock granted after lock request "
231 "failed; dangling lock!\n");
240 int dlm_posix_unlock(dlm_lockspace_t *lockspace, u64 number, struct file *file,
241 struct file_lock *fl)
246 unsigned char fl_flags = fl->fl_flags;
248 ls = dlm_find_lockspace_local(lockspace);
252 op = kzalloc(sizeof(*op), GFP_NOFS);
258 /* cause the vfs unlock to return ENOENT if lock is not found */
259 fl->fl_flags |= FL_EXISTS;
261 rv = locks_lock_file_wait(file, fl);
267 log_error(ls, "dlm_posix_unlock: vfs unlock error %d %llx",
268 rv, (unsigned long long)number);
271 op->info.optype = DLM_PLOCK_OP_UNLOCK;
272 op->info.pid = fl->fl_pid;
273 op->info.fsid = ls->ls_global_id;
274 op->info.number = number;
275 op->info.start = fl->fl_start;
276 op->info.end = fl->fl_end;
277 if (fl->fl_lmops && fl->fl_lmops->lm_grant)
278 op->info.owner = (__u64) fl->fl_pid;
280 op->info.owner = (__u64)(long) fl->fl_owner;
282 if (fl->fl_flags & FL_CLOSE) {
283 op->info.flags |= DLM_PLOCK_FL_CLOSE;
290 wait_event(recv_wq, (op->done != 0));
292 spin_lock(&ops_lock);
293 if (!list_empty(&op->list)) {
294 log_error(ls, "dlm_posix_unlock: op on list %llx",
295 (unsigned long long)number);
298 spin_unlock(&ops_lock);
308 dlm_put_lockspace(ls);
309 fl->fl_flags = fl_flags;
312 EXPORT_SYMBOL_GPL(dlm_posix_unlock);
314 int dlm_posix_get(dlm_lockspace_t *lockspace, u64 number, struct file *file,
315 struct file_lock *fl)
321 ls = dlm_find_lockspace_local(lockspace);
325 op = kzalloc(sizeof(*op), GFP_NOFS);
331 op->info.optype = DLM_PLOCK_OP_GET;
332 op->info.pid = fl->fl_pid;
333 op->info.ex = (fl->fl_type == F_WRLCK);
334 op->info.fsid = ls->ls_global_id;
335 op->info.number = number;
336 op->info.start = fl->fl_start;
337 op->info.end = fl->fl_end;
338 if (fl->fl_lmops && fl->fl_lmops->lm_grant)
339 op->info.owner = (__u64) fl->fl_pid;
341 op->info.owner = (__u64)(long) fl->fl_owner;
344 wait_event(recv_wq, (op->done != 0));
346 spin_lock(&ops_lock);
347 if (!list_empty(&op->list)) {
348 log_error(ls, "dlm_posix_get: op on list %llx",
349 (unsigned long long)number);
352 spin_unlock(&ops_lock);
354 /* info.rv from userspace is 1 for conflict, 0 for no-conflict,
355 -ENOENT if there are no locks on the file */
359 fl->fl_type = F_UNLCK;
364 fl->fl_type = (op->info.ex) ? F_WRLCK : F_RDLCK;
365 fl->fl_flags = FL_POSIX;
366 fl->fl_pid = -op->info.pid;
367 fl->fl_start = op->info.start;
368 fl->fl_end = op->info.end;
374 dlm_put_lockspace(ls);
377 EXPORT_SYMBOL_GPL(dlm_posix_get);
379 /* a read copies out one plock request from the send list */
380 static ssize_t dev_read(struct file *file, char __user *u, size_t count,
383 struct dlm_plock_info info;
384 struct plock_op *op = NULL;
386 if (count < sizeof(info))
389 spin_lock(&ops_lock);
390 if (!list_empty(&send_list)) {
391 op = list_entry(send_list.next, struct plock_op, list);
392 if (op->info.flags & DLM_PLOCK_FL_CLOSE)
395 list_move(&op->list, &recv_list);
396 memcpy(&info, &op->info, sizeof(info));
398 spin_unlock(&ops_lock);
403 /* there is no need to get a reply from userspace for unlocks
404 that were generated by the vfs cleaning up for a close
405 (the process did not make an unlock call). */
407 if (op->info.flags & DLM_PLOCK_FL_CLOSE)
410 if (copy_to_user(u, &info, sizeof(info)))
415 /* a write copies in one plock result that should match a plock_op
417 static ssize_t dev_write(struct file *file, const char __user *u, size_t count,
420 struct dlm_plock_info info;
422 int found = 0, do_callback = 0;
424 if (count != sizeof(info))
427 if (copy_from_user(&info, u, sizeof(info)))
430 if (check_version(&info))
433 spin_lock(&ops_lock);
434 list_for_each_entry(op, &recv_list, list) {
435 if (op->info.fsid == info.fsid &&
436 op->info.number == info.number &&
437 op->info.owner == info.owner) {
438 list_del_init(&op->list);
439 memcpy(&op->info, &info, sizeof(info));
448 spin_unlock(&ops_lock);
452 dlm_plock_callback(op);
456 log_print("dev_write no op %x %llx", info.fsid,
457 (unsigned long long)info.number);
461 static __poll_t dev_poll(struct file *file, poll_table *wait)
465 poll_wait(file, &send_wq, wait);
467 spin_lock(&ops_lock);
468 if (!list_empty(&send_list))
469 mask = EPOLLIN | EPOLLRDNORM;
470 spin_unlock(&ops_lock);
475 static const struct file_operations dev_fops = {
479 .owner = THIS_MODULE,
480 .llseek = noop_llseek,
483 static struct miscdevice plock_dev_misc = {
484 .minor = MISC_DYNAMIC_MINOR,
485 .name = DLM_PLOCK_MISC_NAME,
489 int dlm_plock_init(void)
493 spin_lock_init(&ops_lock);
494 INIT_LIST_HEAD(&send_list);
495 INIT_LIST_HEAD(&recv_list);
496 init_waitqueue_head(&send_wq);
497 init_waitqueue_head(&recv_wq);
499 rv = misc_register(&plock_dev_misc);
501 log_print("dlm_plock_init: misc_register failed %d", rv);
505 void dlm_plock_exit(void)
507 misc_deregister(&plock_dev_misc);