blob: 2a669390cd7f64ce3c42e96cdba05017e82ea193 [file] [log] [blame]
David Teigland597d0ca2006-07-12 16:44:04 -05001/*
David Teigland7fe2b312010-02-24 11:08:18 -06002 * Copyright (C) 2006-2010 Red Hat, Inc. All rights reserved.
David Teigland597d0ca2006-07-12 16:44:04 -05003 *
4 * This copyrighted material is made available to anyone wishing to use,
5 * modify, copy, or redistribute it subject to the terms and conditions
6 * of the GNU General Public License v.2.
7 */
8
9#include <linux/miscdevice.h>
10#include <linux/init.h>
11#include <linux/wait.h>
David Teigland597d0ca2006-07-12 16:44:04 -050012#include <linux/file.h>
13#include <linux/fs.h>
14#include <linux/poll.h>
15#include <linux/signal.h>
16#include <linux/spinlock.h>
17#include <linux/dlm.h>
18#include <linux/dlm_device.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090019#include <linux/slab.h>
Ingo Molnar174cd4b2017-02-02 19:15:33 +010020#include <linux/sched/signal.h>
David Teigland597d0ca2006-07-12 16:44:04 -050021
22#include "dlm_internal.h"
23#include "lockspace.h"
24#include "lock.h"
25#include "lvb_table.h"
Adrian Bunk84c6e8c2007-02-26 00:18:42 +010026#include "user.h"
David Teigland8304d6f2011-02-21 14:58:21 -060027#include "ast.h"
David Teigland597d0ca2006-07-12 16:44:04 -050028
Denis Cheng0fe410d2008-01-29 13:50:16 +080029static const char name_prefix[] = "dlm";
Arjan van de Ven00977a52007-02-12 00:55:34 -080030static const struct file_operations device_fops;
David Teiglanddc68c7e2008-08-18 11:43:30 -050031static atomic_t dlm_monitor_opened;
32static int dlm_monitor_unused = 1;
David Teigland597d0ca2006-07-12 16:44:04 -050033
34#ifdef CONFIG_COMPAT
35
36struct dlm_lock_params32 {
37 __u8 mode;
38 __u8 namelen;
David Teiglandd7db9232007-05-18 09:00:32 -050039 __u16 unused;
40 __u32 flags;
David Teigland597d0ca2006-07-12 16:44:04 -050041 __u32 lkid;
42 __u32 parent;
David Teiglandd7db9232007-05-18 09:00:32 -050043 __u64 xid;
44 __u64 timeout;
David Teigland597d0ca2006-07-12 16:44:04 -050045 __u32 castparam;
46 __u32 castaddr;
47 __u32 bastparam;
48 __u32 bastaddr;
49 __u32 lksb;
David Teigland597d0ca2006-07-12 16:44:04 -050050 char lvb[DLM_USER_LVB_LEN];
51 char name[0];
52};
53
54struct dlm_write_request32 {
55 __u32 version[3];
56 __u8 cmd;
57 __u8 is64bit;
58 __u8 unused[2];
59
60 union {
61 struct dlm_lock_params32 lock;
62 struct dlm_lspace_params lspace;
David Teigland72c2be72007-03-30 15:06:16 -050063 struct dlm_purge_params purge;
David Teigland597d0ca2006-07-12 16:44:04 -050064 } i;
65};
66
67struct dlm_lksb32 {
68 __u32 sb_status;
69 __u32 sb_lkid;
70 __u8 sb_flags;
71 __u32 sb_lvbptr;
72};
73
74struct dlm_lock_result32 {
David Teiglandd7db9232007-05-18 09:00:32 -050075 __u32 version[3];
David Teigland597d0ca2006-07-12 16:44:04 -050076 __u32 length;
77 __u32 user_astaddr;
78 __u32 user_astparam;
79 __u32 user_lksb;
80 struct dlm_lksb32 lksb;
81 __u8 bast_mode;
82 __u8 unused[3];
83 /* Offsets may be zero if no data is present */
84 __u32 lvb_offset;
85};
86
87static void compat_input(struct dlm_write_request *kb,
Patrick Caulfeld2a792892008-01-17 10:25:28 +000088 struct dlm_write_request32 *kb32,
David Teigland1fecb1c2009-03-04 11:17:23 -060089 int namelen)
David Teigland597d0ca2006-07-12 16:44:04 -050090{
91 kb->version[0] = kb32->version[0];
92 kb->version[1] = kb32->version[1];
93 kb->version[2] = kb32->version[2];
94
95 kb->cmd = kb32->cmd;
96 kb->is64bit = kb32->is64bit;
97 if (kb->cmd == DLM_USER_CREATE_LOCKSPACE ||
98 kb->cmd == DLM_USER_REMOVE_LOCKSPACE) {
99 kb->i.lspace.flags = kb32->i.lspace.flags;
100 kb->i.lspace.minor = kb32->i.lspace.minor;
David Teigland1fecb1c2009-03-04 11:17:23 -0600101 memcpy(kb->i.lspace.name, kb32->i.lspace.name, namelen);
David Teigland72c2be72007-03-30 15:06:16 -0500102 } else if (kb->cmd == DLM_USER_PURGE) {
103 kb->i.purge.nodeid = kb32->i.purge.nodeid;
104 kb->i.purge.pid = kb32->i.purge.pid;
David Teigland597d0ca2006-07-12 16:44:04 -0500105 } else {
106 kb->i.lock.mode = kb32->i.lock.mode;
107 kb->i.lock.namelen = kb32->i.lock.namelen;
108 kb->i.lock.flags = kb32->i.lock.flags;
109 kb->i.lock.lkid = kb32->i.lock.lkid;
110 kb->i.lock.parent = kb32->i.lock.parent;
David Teiglandd7db9232007-05-18 09:00:32 -0500111 kb->i.lock.xid = kb32->i.lock.xid;
112 kb->i.lock.timeout = kb32->i.lock.timeout;
David Teigland597d0ca2006-07-12 16:44:04 -0500113 kb->i.lock.castparam = (void *)(long)kb32->i.lock.castparam;
114 kb->i.lock.castaddr = (void *)(long)kb32->i.lock.castaddr;
115 kb->i.lock.bastparam = (void *)(long)kb32->i.lock.bastparam;
116 kb->i.lock.bastaddr = (void *)(long)kb32->i.lock.bastaddr;
117 kb->i.lock.lksb = (void *)(long)kb32->i.lock.lksb;
118 memcpy(kb->i.lock.lvb, kb32->i.lock.lvb, DLM_USER_LVB_LEN);
David Teigland1fecb1c2009-03-04 11:17:23 -0600119 memcpy(kb->i.lock.name, kb32->i.lock.name, namelen);
David Teigland597d0ca2006-07-12 16:44:04 -0500120 }
121}
122
123static void compat_output(struct dlm_lock_result *res,
124 struct dlm_lock_result32 *res32)
125{
Vlad Tsyrklevich8286d6b2017-02-22 15:31:45 -0600126 memset(res32, 0, sizeof(*res32));
127
David Teiglandd7db9232007-05-18 09:00:32 -0500128 res32->version[0] = res->version[0];
129 res32->version[1] = res->version[1];
130 res32->version[2] = res->version[2];
131
David Teigland597d0ca2006-07-12 16:44:04 -0500132 res32->user_astaddr = (__u32)(long)res->user_astaddr;
133 res32->user_astparam = (__u32)(long)res->user_astparam;
134 res32->user_lksb = (__u32)(long)res->user_lksb;
135 res32->bast_mode = res->bast_mode;
136
137 res32->lvb_offset = res->lvb_offset;
138 res32->length = res->length;
139
140 res32->lksb.sb_status = res->lksb.sb_status;
141 res32->lksb.sb_flags = res->lksb.sb_flags;
142 res32->lksb.sb_lkid = res->lksb.sb_lkid;
143 res32->lksb.sb_lvbptr = (__u32)(long)res->lksb.sb_lvbptr;
144}
145#endif
146
David Teigland84d8cd62007-05-29 08:44:23 -0500147/* Figure out if this lock is at the end of its life and no longer
148 available for the application to use. The lkb still exists until
149 the final ast is read. A lock becomes EOL in three situations:
150 1. a noqueue request fails with EAGAIN
151 2. an unlock completes with EUNLOCK
152 3. a cancel of a waiting request completes with ECANCEL/EDEADLK
153 An EOL lock needs to be removed from the process's list of locks.
154 And we can't allow any new operation on an EOL lock. This is
155 not related to the lifetime of the lkb struct which is managed
156 entirely by refcount. */
157
David Teigland8304d6f2011-02-21 14:58:21 -0600158static int lkb_is_endoflife(int mode, int status)
David Teigland84d8cd62007-05-29 08:44:23 -0500159{
David Teigland8304d6f2011-02-21 14:58:21 -0600160 switch (status) {
David Teigland84d8cd62007-05-29 08:44:23 -0500161 case -DLM_EUNLOCK:
162 return 1;
163 case -DLM_ECANCEL:
164 case -ETIMEDOUT:
David Teigland8b4021f2007-05-29 08:46:00 -0500165 case -EDEADLK:
David Teigland84d8cd62007-05-29 08:44:23 -0500166 case -EAGAIN:
David Teigland8304d6f2011-02-21 14:58:21 -0600167 if (mode == DLM_LOCK_IV)
David Teigland84d8cd62007-05-29 08:44:23 -0500168 return 1;
169 break;
170 }
171 return 0;
172}
173
David Teiglandef0c2bb2007-03-28 09:56:46 -0500174/* we could possibly check if the cancel of an orphan has resulted in the lkb
175 being removed and then remove that lkb from the orphans list and free it */
David Teigland597d0ca2006-07-12 16:44:04 -0500176
David Teigland8304d6f2011-02-21 14:58:21 -0600177void dlm_user_add_ast(struct dlm_lkb *lkb, uint32_t flags, int mode,
178 int status, uint32_t sbflags, uint64_t seq)
David Teigland597d0ca2006-07-12 16:44:04 -0500179{
180 struct dlm_ls *ls;
181 struct dlm_user_args *ua;
182 struct dlm_user_proc *proc;
David Teigland8304d6f2011-02-21 14:58:21 -0600183 int rv;
David Teigland597d0ca2006-07-12 16:44:04 -0500184
David Teiglandef0c2bb2007-03-28 09:56:46 -0500185 if (lkb->lkb_flags & (DLM_IFL_ORPHAN | DLM_IFL_DEAD))
David Teigland597d0ca2006-07-12 16:44:04 -0500186 return;
David Teigland597d0ca2006-07-12 16:44:04 -0500187
188 ls = lkb->lkb_resource->res_ls;
189 mutex_lock(&ls->ls_clear_proc_locks);
190
191 /* If ORPHAN/DEAD flag is set, it means the process is dead so an ast
192 can't be delivered. For ORPHAN's, dlm_clear_proc_locks() freed
David Teiglandef0c2bb2007-03-28 09:56:46 -0500193 lkb->ua so we can't try to use it. This second check is necessary
194 for cases where a completion ast is received for an operation that
195 began before clear_proc_locks did its cancel/unlock. */
David Teigland597d0ca2006-07-12 16:44:04 -0500196
David Teiglandef0c2bb2007-03-28 09:56:46 -0500197 if (lkb->lkb_flags & (DLM_IFL_ORPHAN | DLM_IFL_DEAD))
David Teigland597d0ca2006-07-12 16:44:04 -0500198 goto out;
David Teigland597d0ca2006-07-12 16:44:04 -0500199
David Teiglandd292c0c2008-02-06 23:27:04 -0600200 DLM_ASSERT(lkb->lkb_ua, dlm_print_lkb(lkb););
201 ua = lkb->lkb_ua;
David Teigland597d0ca2006-07-12 16:44:04 -0500202 proc = ua->proc;
203
David Teigland8304d6f2011-02-21 14:58:21 -0600204 if ((flags & DLM_CB_BAST) && ua->bastaddr == NULL)
David Teigland597d0ca2006-07-12 16:44:04 -0500205 goto out;
206
David Teigland8304d6f2011-02-21 14:58:21 -0600207 if ((flags & DLM_CB_CAST) && lkb_is_endoflife(mode, status))
208 lkb->lkb_flags |= DLM_IFL_ENDOFLIFE;
209
David Teigland597d0ca2006-07-12 16:44:04 -0500210 spin_lock(&proc->asts_spin);
David Teiglandef0c2bb2007-03-28 09:56:46 -0500211
David Teigland8304d6f2011-02-21 14:58:21 -0600212 rv = dlm_add_lkb_callback(lkb, flags, mode, status, sbflags, seq);
213 if (rv < 0) {
214 spin_unlock(&proc->asts_spin);
215 goto out;
216 }
David Teiglandef0c2bb2007-03-28 09:56:46 -0500217
David Teigland23e8e1a2011-04-05 13:16:24 -0500218 if (list_empty(&lkb->lkb_cb_list)) {
David Teigland597d0ca2006-07-12 16:44:04 -0500219 kref_get(&lkb->lkb_ref);
David Teigland23e8e1a2011-04-05 13:16:24 -0500220 list_add_tail(&lkb->lkb_cb_list, &proc->asts);
David Teigland597d0ca2006-07-12 16:44:04 -0500221 wake_up_interruptible(&proc->wait);
222 }
David Teigland597d0ca2006-07-12 16:44:04 -0500223 spin_unlock(&proc->asts_spin);
David Teigland34e22be2006-07-18 11:24:04 -0500224
David Teigland8304d6f2011-02-21 14:58:21 -0600225 if (lkb->lkb_flags & DLM_IFL_ENDOFLIFE) {
226 /* N.B. spin_lock locks_spin, not asts_spin */
David Teiglandce5246b2008-01-14 15:48:58 -0600227 spin_lock(&proc->locks_spin);
David Teiglandef0c2bb2007-03-28 09:56:46 -0500228 if (!list_empty(&lkb->lkb_ownqueue)) {
229 list_del_init(&lkb->lkb_ownqueue);
230 dlm_put_lkb(lkb);
231 }
David Teiglandce5246b2008-01-14 15:48:58 -0600232 spin_unlock(&proc->locks_spin);
David Teigland34e22be2006-07-18 11:24:04 -0500233 }
David Teigland597d0ca2006-07-12 16:44:04 -0500234 out:
235 mutex_unlock(&ls->ls_clear_proc_locks);
236}
237
238static int device_user_lock(struct dlm_user_proc *proc,
239 struct dlm_lock_params *params)
240{
241 struct dlm_ls *ls;
242 struct dlm_user_args *ua;
David Teigland2ab4bd82014-10-17 11:05:50 -0500243 uint32_t lkid;
David Teigland597d0ca2006-07-12 16:44:04 -0500244 int error = -ENOMEM;
245
246 ls = dlm_find_lockspace_local(proc->lockspace);
247 if (!ls)
248 return -ENOENT;
249
250 if (!params->castaddr || !params->lksb) {
251 error = -EINVAL;
252 goto out;
253 }
254
David Teigland573c24c2009-11-30 16:34:43 -0600255 ua = kzalloc(sizeof(struct dlm_user_args), GFP_NOFS);
David Teigland597d0ca2006-07-12 16:44:04 -0500256 if (!ua)
257 goto out;
258 ua->proc = proc;
259 ua->user_lksb = params->lksb;
260 ua->castparam = params->castparam;
261 ua->castaddr = params->castaddr;
262 ua->bastparam = params->bastparam;
263 ua->bastaddr = params->bastaddr;
David Teiglandd7db9232007-05-18 09:00:32 -0500264 ua->xid = params->xid;
David Teigland597d0ca2006-07-12 16:44:04 -0500265
David Teigland2ab4bd82014-10-17 11:05:50 -0500266 if (params->flags & DLM_LKF_CONVERT) {
David Teigland597d0ca2006-07-12 16:44:04 -0500267 error = dlm_user_convert(ls, ua,
268 params->mode, params->flags,
David Teiglandd7db9232007-05-18 09:00:32 -0500269 params->lkid, params->lvb,
270 (unsigned long) params->timeout);
David Teigland2ab4bd82014-10-17 11:05:50 -0500271 } else if (params->flags & DLM_LKF_ORPHAN) {
272 error = dlm_user_adopt_orphan(ls, ua,
273 params->mode, params->flags,
274 params->name, params->namelen,
275 (unsigned long) params->timeout,
276 &lkid);
277 if (!error)
278 error = lkid;
279 } else {
David Teigland597d0ca2006-07-12 16:44:04 -0500280 error = dlm_user_request(ls, ua,
281 params->mode, params->flags,
282 params->name, params->namelen,
David Teiglandd7db9232007-05-18 09:00:32 -0500283 (unsigned long) params->timeout);
David Teigland597d0ca2006-07-12 16:44:04 -0500284 if (!error)
285 error = ua->lksb.sb_lkid;
286 }
287 out:
288 dlm_put_lockspace(ls);
289 return error;
290}
291
292static int device_user_unlock(struct dlm_user_proc *proc,
293 struct dlm_lock_params *params)
294{
295 struct dlm_ls *ls;
296 struct dlm_user_args *ua;
297 int error = -ENOMEM;
298
299 ls = dlm_find_lockspace_local(proc->lockspace);
300 if (!ls)
301 return -ENOENT;
302
David Teigland573c24c2009-11-30 16:34:43 -0600303 ua = kzalloc(sizeof(struct dlm_user_args), GFP_NOFS);
David Teigland597d0ca2006-07-12 16:44:04 -0500304 if (!ua)
305 goto out;
306 ua->proc = proc;
307 ua->user_lksb = params->lksb;
308 ua->castparam = params->castparam;
309 ua->castaddr = params->castaddr;
310
311 if (params->flags & DLM_LKF_CANCEL)
312 error = dlm_user_cancel(ls, ua, params->flags, params->lkid);
313 else
314 error = dlm_user_unlock(ls, ua, params->flags, params->lkid,
315 params->lvb);
316 out:
317 dlm_put_lockspace(ls);
318 return error;
319}
320
David Teigland8b4021f2007-05-29 08:46:00 -0500321static int device_user_deadlock(struct dlm_user_proc *proc,
322 struct dlm_lock_params *params)
323{
324 struct dlm_ls *ls;
325 int error;
326
327 ls = dlm_find_lockspace_local(proc->lockspace);
328 if (!ls)
329 return -ENOENT;
330
331 error = dlm_user_deadlock(ls, params->flags, params->lkid);
332
333 dlm_put_lockspace(ls);
334 return error;
335}
336
David Teigland0f8e0d92008-08-06 13:30:24 -0500337static int dlm_device_register(struct dlm_ls *ls, char *name)
Patrick Caulfield254da032007-03-21 09:23:53 +0000338{
339 int error, len;
340
David Teigland0f8e0d92008-08-06 13:30:24 -0500341 /* The device is already registered. This happens when the
342 lockspace is created multiple times from userspace. */
343 if (ls->ls_device.name)
344 return 0;
345
Patrick Caulfield254da032007-03-21 09:23:53 +0000346 error = -ENOMEM;
347 len = strlen(name) + strlen(name_prefix) + 2;
David Teigland573c24c2009-11-30 16:34:43 -0600348 ls->ls_device.name = kzalloc(len, GFP_NOFS);
Patrick Caulfield254da032007-03-21 09:23:53 +0000349 if (!ls->ls_device.name)
350 goto fail;
351
352 snprintf((char *)ls->ls_device.name, len, "%s_%s", name_prefix,
353 name);
354 ls->ls_device.fops = &device_fops;
355 ls->ls_device.minor = MISC_DYNAMIC_MINOR;
356
357 error = misc_register(&ls->ls_device);
358 if (error) {
359 kfree(ls->ls_device.name);
Edwin Török55acdd92017-08-03 10:30:06 +0100360 /* this has to be set to NULL
361 * to avoid a double-free in dlm_device_deregister
362 */
363 ls->ls_device.name = NULL;
Patrick Caulfield254da032007-03-21 09:23:53 +0000364 }
365fail:
366 return error;
367}
368
David Teigland0f8e0d92008-08-06 13:30:24 -0500369int dlm_device_deregister(struct dlm_ls *ls)
370{
David Teigland0f8e0d92008-08-06 13:30:24 -0500371 /* The device is not registered. This happens when the lockspace
372 was never used from userspace, or when device_create_lockspace()
373 calls dlm_release_lockspace() after the register fails. */
374 if (!ls->ls_device.name)
375 return 0;
376
Greg Kroah-Hartmanf368ed62015-07-30 15:59:57 -0700377 misc_deregister(&ls->ls_device);
378 kfree(ls->ls_device.name);
379 return 0;
David Teigland0f8e0d92008-08-06 13:30:24 -0500380}
381
David Teigland72c2be72007-03-30 15:06:16 -0500382static int device_user_purge(struct dlm_user_proc *proc,
383 struct dlm_purge_params *params)
384{
385 struct dlm_ls *ls;
386 int error;
387
388 ls = dlm_find_lockspace_local(proc->lockspace);
389 if (!ls)
390 return -ENOENT;
391
392 error = dlm_user_purge(ls, proc, params->nodeid, params->pid);
393
394 dlm_put_lockspace(ls);
395 return error;
396}
397
David Teigland597d0ca2006-07-12 16:44:04 -0500398static int device_create_lockspace(struct dlm_lspace_params *params)
399{
400 dlm_lockspace_t *lockspace;
401 struct dlm_ls *ls;
Patrick Caulfield254da032007-03-21 09:23:53 +0000402 int error;
David Teigland597d0ca2006-07-12 16:44:04 -0500403
404 if (!capable(CAP_SYS_ADMIN))
405 return -EPERM;
406
David Teigland60f98d12011-11-02 14:30:58 -0500407 error = dlm_new_lockspace(params->name, NULL, params->flags,
408 DLM_USER_LVB_LEN, NULL, NULL, NULL,
409 &lockspace);
David Teigland597d0ca2006-07-12 16:44:04 -0500410 if (error)
411 return error;
412
413 ls = dlm_find_lockspace_local(lockspace);
414 if (!ls)
415 return -ENOENT;
416
David Teigland0f8e0d92008-08-06 13:30:24 -0500417 error = dlm_device_register(ls, params->name);
David Teigland597d0ca2006-07-12 16:44:04 -0500418 dlm_put_lockspace(ls);
David Teigland597d0ca2006-07-12 16:44:04 -0500419
Patrick Caulfield254da032007-03-21 09:23:53 +0000420 if (error)
421 dlm_release_lockspace(lockspace, 0);
422 else
423 error = ls->ls_device.minor;
424
David Teigland597d0ca2006-07-12 16:44:04 -0500425 return error;
426}
427
428static int device_remove_lockspace(struct dlm_lspace_params *params)
429{
430 dlm_lockspace_t *lockspace;
431 struct dlm_ls *ls;
David Teiglandc6e6f0b2006-08-30 10:50:18 -0500432 int error, force = 0;
David Teigland597d0ca2006-07-12 16:44:04 -0500433
434 if (!capable(CAP_SYS_ADMIN))
435 return -EPERM;
436
437 ls = dlm_find_lockspace_device(params->minor);
438 if (!ls)
439 return -ENOENT;
440
David Teiglandc6e6f0b2006-08-30 10:50:18 -0500441 if (params->flags & DLM_USER_LSFLG_FORCEFREE)
442 force = 2;
443
David Teigland597d0ca2006-07-12 16:44:04 -0500444 lockspace = ls->ls_local_handle;
David Teigland597d0ca2006-07-12 16:44:04 -0500445 dlm_put_lockspace(ls);
David Teigland0f8e0d92008-08-06 13:30:24 -0500446
447 /* The final dlm_release_lockspace waits for references to go to
448 zero, so all processes will need to close their device for the
449 ls before the release will proceed. release also calls the
450 device_deregister above. Converting a positive return value
451 from release to zero means that userspace won't know when its
452 release was the final one, but it shouldn't need to know. */
453
David Teiglandc6e6f0b2006-08-30 10:50:18 -0500454 error = dlm_release_lockspace(lockspace, force);
David Teigland0f8e0d92008-08-06 13:30:24 -0500455 if (error > 0)
456 error = 0;
David Teigland597d0ca2006-07-12 16:44:04 -0500457 return error;
458}
459
460/* Check the user's version matches ours */
461static int check_version(struct dlm_write_request *req)
462{
463 if (req->version[0] != DLM_DEVICE_VERSION_MAJOR ||
464 (req->version[0] == DLM_DEVICE_VERSION_MAJOR &&
465 req->version[1] > DLM_DEVICE_VERSION_MINOR)) {
466
467 printk(KERN_DEBUG "dlm: process %s (%d) version mismatch "
468 "user (%d.%d.%d) kernel (%d.%d.%d)\n",
469 current->comm,
Pavel Emelyanovba25f9d2007-10-18 23:40:40 -0700470 task_pid_nr(current),
David Teigland597d0ca2006-07-12 16:44:04 -0500471 req->version[0],
472 req->version[1],
473 req->version[2],
474 DLM_DEVICE_VERSION_MAJOR,
475 DLM_DEVICE_VERSION_MINOR,
476 DLM_DEVICE_VERSION_PATCH);
477 return -EINVAL;
478 }
479 return 0;
480}
481
482/*
483 * device_write
484 *
485 * device_user_lock
486 * dlm_user_request -> request_lock
487 * dlm_user_convert -> convert_lock
488 *
489 * device_user_unlock
490 * dlm_user_unlock -> unlock_lock
491 * dlm_user_cancel -> cancel_lock
492 *
493 * device_create_lockspace
494 * dlm_new_lockspace
495 *
496 * device_remove_lockspace
497 * dlm_release_lockspace
498 */
499
500/* a write to a lockspace device is a lock or unlock request, a write
501 to the control device is to create/remove a lockspace */
502
503static ssize_t device_write(struct file *file, const char __user *buf,
504 size_t count, loff_t *ppos)
505{
506 struct dlm_user_proc *proc = file->private_data;
507 struct dlm_write_request *kbuf;
David Teigland597d0ca2006-07-12 16:44:04 -0500508 int error;
509
510#ifdef CONFIG_COMPAT
511 if (count < sizeof(struct dlm_write_request32))
512#else
513 if (count < sizeof(struct dlm_write_request))
514#endif
515 return -EINVAL;
516
David Teiglandd4b0bcf2013-02-04 15:31:22 -0600517 /*
518 * can't compare against COMPAT/dlm_write_request32 because
519 * we don't yet know if is64bit is zero
520 */
Sasha Levin2b75bc92012-09-09 16:16:58 +0200521 if (count > sizeof(struct dlm_write_request) + DLM_RESNAME_MAXLEN)
Sasha Levin2b75bc92012-09-09 16:16:58 +0200522 return -EINVAL;
523
Al Viro16e5c1f2015-12-24 00:06:05 -0500524 kbuf = memdup_user_nul(buf, count);
Al Viro117aa412016-01-21 17:41:23 -0500525 if (IS_ERR(kbuf))
Al Viro16e5c1f2015-12-24 00:06:05 -0500526 return PTR_ERR(kbuf);
David Teigland597d0ca2006-07-12 16:44:04 -0500527
528 if (check_version(kbuf)) {
529 error = -EBADE;
530 goto out_free;
531 }
532
533#ifdef CONFIG_COMPAT
534 if (!kbuf->is64bit) {
535 struct dlm_write_request32 *k32buf;
David Teigland1fecb1c2009-03-04 11:17:23 -0600536 int namelen = 0;
537
538 if (count > sizeof(struct dlm_write_request32))
539 namelen = count - sizeof(struct dlm_write_request32);
540
David Teigland597d0ca2006-07-12 16:44:04 -0500541 k32buf = (struct dlm_write_request32 *)kbuf;
David Teigland1fecb1c2009-03-04 11:17:23 -0600542
543 /* add 1 after namelen so that the name string is terminated */
544 kbuf = kzalloc(sizeof(struct dlm_write_request) + namelen + 1,
David Teigland573c24c2009-11-30 16:34:43 -0600545 GFP_NOFS);
David Teiglandcb980d92008-07-29 15:21:19 -0500546 if (!kbuf) {
547 kfree(k32buf);
David Teigland597d0ca2006-07-12 16:44:04 -0500548 return -ENOMEM;
David Teiglandcb980d92008-07-29 15:21:19 -0500549 }
David Teigland597d0ca2006-07-12 16:44:04 -0500550
551 if (proc)
552 set_bit(DLM_PROC_FLAGS_COMPAT, &proc->flags);
David Teigland1fecb1c2009-03-04 11:17:23 -0600553
554 compat_input(kbuf, k32buf, namelen);
David Teigland597d0ca2006-07-12 16:44:04 -0500555 kfree(k32buf);
556 }
557#endif
558
559 /* do we really need this? can a write happen after a close? */
560 if ((kbuf->cmd == DLM_USER_LOCK || kbuf->cmd == DLM_USER_UNLOCK) &&
David Teiglandcb980d92008-07-29 15:21:19 -0500561 (proc && test_bit(DLM_PROC_FLAGS_CLOSING, &proc->flags))) {
562 error = -EINVAL;
563 goto out_free;
564 }
David Teigland597d0ca2006-07-12 16:44:04 -0500565
David Teigland597d0ca2006-07-12 16:44:04 -0500566 error = -EINVAL;
567
568 switch (kbuf->cmd)
569 {
570 case DLM_USER_LOCK:
571 if (!proc) {
572 log_print("no locking on control device");
David Teiglandc6ca7bc2013-08-12 15:22:43 -0500573 goto out_free;
David Teigland597d0ca2006-07-12 16:44:04 -0500574 }
575 error = device_user_lock(proc, &kbuf->i.lock);
576 break;
577
578 case DLM_USER_UNLOCK:
579 if (!proc) {
580 log_print("no locking on control device");
David Teiglandc6ca7bc2013-08-12 15:22:43 -0500581 goto out_free;
David Teigland597d0ca2006-07-12 16:44:04 -0500582 }
583 error = device_user_unlock(proc, &kbuf->i.lock);
584 break;
585
David Teigland8b4021f2007-05-29 08:46:00 -0500586 case DLM_USER_DEADLOCK:
587 if (!proc) {
588 log_print("no locking on control device");
David Teiglandc6ca7bc2013-08-12 15:22:43 -0500589 goto out_free;
David Teigland8b4021f2007-05-29 08:46:00 -0500590 }
591 error = device_user_deadlock(proc, &kbuf->i.lock);
592 break;
593
David Teigland597d0ca2006-07-12 16:44:04 -0500594 case DLM_USER_CREATE_LOCKSPACE:
595 if (proc) {
596 log_print("create/remove only on control device");
David Teiglandc6ca7bc2013-08-12 15:22:43 -0500597 goto out_free;
David Teigland597d0ca2006-07-12 16:44:04 -0500598 }
599 error = device_create_lockspace(&kbuf->i.lspace);
600 break;
601
602 case DLM_USER_REMOVE_LOCKSPACE:
603 if (proc) {
604 log_print("create/remove only on control device");
David Teiglandc6ca7bc2013-08-12 15:22:43 -0500605 goto out_free;
David Teigland597d0ca2006-07-12 16:44:04 -0500606 }
607 error = device_remove_lockspace(&kbuf->i.lspace);
608 break;
609
David Teigland72c2be72007-03-30 15:06:16 -0500610 case DLM_USER_PURGE:
611 if (!proc) {
612 log_print("no locking on control device");
David Teiglandc6ca7bc2013-08-12 15:22:43 -0500613 goto out_free;
David Teigland72c2be72007-03-30 15:06:16 -0500614 }
615 error = device_user_purge(proc, &kbuf->i.purge);
616 break;
617
David Teigland597d0ca2006-07-12 16:44:04 -0500618 default:
619 log_print("Unknown command passed to DLM device : %d\n",
620 kbuf->cmd);
621 }
622
David Teigland597d0ca2006-07-12 16:44:04 -0500623 out_free:
624 kfree(kbuf);
625 return error;
626}
627
628/* Every process that opens the lockspace device has its own "proc" structure
629 hanging off the open file that's used to keep track of locks owned by the
630 process and asts that need to be delivered to the process. */
631
632static int device_open(struct inode *inode, struct file *file)
633{
634 struct dlm_user_proc *proc;
635 struct dlm_ls *ls;
636
637 ls = dlm_find_lockspace_device(iminor(inode));
David Teiglandf9f2ed42008-09-04 12:51:20 -0500638 if (!ls)
David Teigland597d0ca2006-07-12 16:44:04 -0500639 return -ENOENT;
640
David Teigland573c24c2009-11-30 16:34:43 -0600641 proc = kzalloc(sizeof(struct dlm_user_proc), GFP_NOFS);
David Teigland597d0ca2006-07-12 16:44:04 -0500642 if (!proc) {
643 dlm_put_lockspace(ls);
644 return -ENOMEM;
645 }
646
647 proc->lockspace = ls->ls_local_handle;
648 INIT_LIST_HEAD(&proc->asts);
649 INIT_LIST_HEAD(&proc->locks);
David Teiglanda1bc86e2007-01-15 10:34:52 -0600650 INIT_LIST_HEAD(&proc->unlocking);
David Teigland597d0ca2006-07-12 16:44:04 -0500651 spin_lock_init(&proc->asts_spin);
652 spin_lock_init(&proc->locks_spin);
653 init_waitqueue_head(&proc->wait);
654 file->private_data = proc;
655
656 return 0;
657}
658
659static int device_close(struct inode *inode, struct file *file)
660{
661 struct dlm_user_proc *proc = file->private_data;
662 struct dlm_ls *ls;
David Teigland597d0ca2006-07-12 16:44:04 -0500663
664 ls = dlm_find_lockspace_local(proc->lockspace);
665 if (!ls)
666 return -ENOENT;
667
David Teigland597d0ca2006-07-12 16:44:04 -0500668 set_bit(DLM_PROC_FLAGS_CLOSING, &proc->flags);
669
670 dlm_clear_proc_locks(ls, proc);
671
672 /* at this point no more lkb's should exist for this lockspace,
673 so there's no chance of dlm_user_add_ast() being called and
674 looking for lkb->ua->proc */
675
676 kfree(proc);
677 file->private_data = NULL;
678
679 dlm_put_lockspace(ls);
680 dlm_put_lockspace(ls); /* for the find in device_open() */
681
682 /* FIXME: AUTOFREE: if this ls is no longer used do
683 device_remove_lockspace() */
684
David Teigland597d0ca2006-07-12 16:44:04 -0500685 return 0;
686}
687
David Teigland8304d6f2011-02-21 14:58:21 -0600688static int copy_result_to_user(struct dlm_user_args *ua, int compat,
689 uint32_t flags, int mode, int copy_lvb,
690 char __user *buf, size_t count)
David Teigland597d0ca2006-07-12 16:44:04 -0500691{
692#ifdef CONFIG_COMPAT
693 struct dlm_lock_result32 result32;
694#endif
695 struct dlm_lock_result result;
696 void *resultptr;
697 int error=0;
698 int len;
699 int struct_len;
700
701 memset(&result, 0, sizeof(struct dlm_lock_result));
David Teiglandd7db9232007-05-18 09:00:32 -0500702 result.version[0] = DLM_DEVICE_VERSION_MAJOR;
703 result.version[1] = DLM_DEVICE_VERSION_MINOR;
704 result.version[2] = DLM_DEVICE_VERSION_PATCH;
David Teigland597d0ca2006-07-12 16:44:04 -0500705 memcpy(&result.lksb, &ua->lksb, sizeof(struct dlm_lksb));
706 result.user_lksb = ua->user_lksb;
707
708 /* FIXME: dlm1 provides for the user's bastparam/addr to not be updated
709 in a conversion unless the conversion is successful. See code
710 in dlm_user_convert() for updating ua from ua_tmp. OpenVMS, though,
711 notes that a new blocking AST address and parameter are set even if
712 the conversion fails, so maybe we should just do that. */
713
David Teigland8304d6f2011-02-21 14:58:21 -0600714 if (flags & DLM_CB_BAST) {
David Teigland597d0ca2006-07-12 16:44:04 -0500715 result.user_astaddr = ua->bastaddr;
716 result.user_astparam = ua->bastparam;
David Teigland89d799d2010-03-25 14:23:13 -0500717 result.bast_mode = mode;
David Teigland597d0ca2006-07-12 16:44:04 -0500718 } else {
719 result.user_astaddr = ua->castaddr;
720 result.user_astparam = ua->castparam;
721 }
722
723#ifdef CONFIG_COMPAT
724 if (compat)
725 len = sizeof(struct dlm_lock_result32);
726 else
727#endif
728 len = sizeof(struct dlm_lock_result);
729 struct_len = len;
730
731 /* copy lvb to userspace if there is one, it's been updated, and
732 the user buffer has space for it */
733
David Teigland8304d6f2011-02-21 14:58:21 -0600734 if (copy_lvb && ua->lksb.sb_lvbptr && count >= len + DLM_USER_LVB_LEN) {
David Teigland597d0ca2006-07-12 16:44:04 -0500735 if (copy_to_user(buf+len, ua->lksb.sb_lvbptr,
736 DLM_USER_LVB_LEN)) {
737 error = -EFAULT;
738 goto out;
739 }
740
741 result.lvb_offset = len;
742 len += DLM_USER_LVB_LEN;
743 }
744
745 result.length = len;
746 resultptr = &result;
747#ifdef CONFIG_COMPAT
748 if (compat) {
749 compat_output(&result, &result32);
750 resultptr = &result32;
751 }
752#endif
753
754 if (copy_to_user(buf, resultptr, struct_len))
755 error = -EFAULT;
756 else
757 error = len;
758 out:
759 return error;
760}
761
David Teiglandd7db9232007-05-18 09:00:32 -0500762static int copy_version_to_user(char __user *buf, size_t count)
763{
764 struct dlm_device_version ver;
765
766 memset(&ver, 0, sizeof(struct dlm_device_version));
767 ver.version[0] = DLM_DEVICE_VERSION_MAJOR;
768 ver.version[1] = DLM_DEVICE_VERSION_MINOR;
769 ver.version[2] = DLM_DEVICE_VERSION_PATCH;
770
771 if (copy_to_user(buf, &ver, sizeof(struct dlm_device_version)))
772 return -EFAULT;
773 return sizeof(struct dlm_device_version);
774}
775
David Teigland597d0ca2006-07-12 16:44:04 -0500776/* a read returns a single ast described in a struct dlm_lock_result */
777
778static ssize_t device_read(struct file *file, char __user *buf, size_t count,
779 loff_t *ppos)
780{
781 struct dlm_user_proc *proc = file->private_data;
782 struct dlm_lkb *lkb;
David Teigland597d0ca2006-07-12 16:44:04 -0500783 DECLARE_WAITQUEUE(wait, current);
David Teigland8304d6f2011-02-21 14:58:21 -0600784 struct dlm_callback cb;
785 int rv, resid, copy_lvb = 0;
David Teiglandb96f4652015-08-25 12:51:44 -0500786 int old_mode, new_mode;
David Teigland597d0ca2006-07-12 16:44:04 -0500787
David Teiglandd7db9232007-05-18 09:00:32 -0500788 if (count == sizeof(struct dlm_device_version)) {
David Teigland8304d6f2011-02-21 14:58:21 -0600789 rv = copy_version_to_user(buf, count);
790 return rv;
David Teiglandd7db9232007-05-18 09:00:32 -0500791 }
792
793 if (!proc) {
794 log_print("non-version read from control device %zu", count);
795 return -EINVAL;
796 }
797
David Teigland597d0ca2006-07-12 16:44:04 -0500798#ifdef CONFIG_COMPAT
799 if (count < sizeof(struct dlm_lock_result32))
800#else
801 if (count < sizeof(struct dlm_lock_result))
802#endif
803 return -EINVAL;
804
David Teigland89d799d2010-03-25 14:23:13 -0500805 try_another:
806
David Teigland597d0ca2006-07-12 16:44:04 -0500807 /* do we really need this? can a read happen after a close? */
808 if (test_bit(DLM_PROC_FLAGS_CLOSING, &proc->flags))
809 return -EINVAL;
810
811 spin_lock(&proc->asts_spin);
812 if (list_empty(&proc->asts)) {
813 if (file->f_flags & O_NONBLOCK) {
814 spin_unlock(&proc->asts_spin);
815 return -EAGAIN;
816 }
817
818 add_wait_queue(&proc->wait, &wait);
819
820 repeat:
821 set_current_state(TASK_INTERRUPTIBLE);
822 if (list_empty(&proc->asts) && !signal_pending(current)) {
823 spin_unlock(&proc->asts_spin);
824 schedule();
825 spin_lock(&proc->asts_spin);
826 goto repeat;
827 }
828 set_current_state(TASK_RUNNING);
829 remove_wait_queue(&proc->wait, &wait);
830
831 if (signal_pending(current)) {
832 spin_unlock(&proc->asts_spin);
833 return -ERESTARTSYS;
834 }
835 }
836
David Teigland8304d6f2011-02-21 14:58:21 -0600837 /* if we empty lkb_callbacks, we don't want to unlock the spinlock
David Teigland23e8e1a2011-04-05 13:16:24 -0500838 without removing lkb_cb_list; so empty lkb_cb_list is always
David Teigland8304d6f2011-02-21 14:58:21 -0600839 consistent with empty lkb_callbacks */
David Teigland597d0ca2006-07-12 16:44:04 -0500840
David Teigland23e8e1a2011-04-05 13:16:24 -0500841 lkb = list_entry(proc->asts.next, struct dlm_lkb, lkb_cb_list);
David Teigland597d0ca2006-07-12 16:44:04 -0500842
David Teiglandb96f4652015-08-25 12:51:44 -0500843 /* rem_lkb_callback sets a new lkb_last_cast */
844 old_mode = lkb->lkb_last_cast.mode;
845
David Teigland8304d6f2011-02-21 14:58:21 -0600846 rv = dlm_rem_lkb_callback(lkb->lkb_resource->res_ls, lkb, &cb, &resid);
847 if (rv < 0) {
848 /* this shouldn't happen; lkb should have been removed from
849 list when resid was zero */
850 log_print("dlm_rem_lkb_callback empty %x", lkb->lkb_id);
David Teigland23e8e1a2011-04-05 13:16:24 -0500851 list_del_init(&lkb->lkb_cb_list);
David Teigland8304d6f2011-02-21 14:58:21 -0600852 spin_unlock(&proc->asts_spin);
853 /* removes ref for proc->asts, may cause lkb to be freed */
854 dlm_put_lkb(lkb);
855 goto try_another;
David Teigland89d799d2010-03-25 14:23:13 -0500856 }
David Teigland8304d6f2011-02-21 14:58:21 -0600857 if (!resid)
David Teigland23e8e1a2011-04-05 13:16:24 -0500858 list_del_init(&lkb->lkb_cb_list);
David Teigland597d0ca2006-07-12 16:44:04 -0500859 spin_unlock(&proc->asts_spin);
860
David Teigland8304d6f2011-02-21 14:58:21 -0600861 if (cb.flags & DLM_CB_SKIP) {
862 /* removes ref for proc->asts, may cause lkb to be freed */
863 if (!resid)
864 dlm_put_lkb(lkb);
865 goto try_another;
David Teigland89d799d2010-03-25 14:23:13 -0500866 }
David Teigland597d0ca2006-07-12 16:44:04 -0500867
David Teigland8304d6f2011-02-21 14:58:21 -0600868 if (cb.flags & DLM_CB_CAST) {
David Teigland8304d6f2011-02-21 14:58:21 -0600869 new_mode = cb.mode;
870
871 if (!cb.sb_status && lkb->lkb_lksb->sb_lvbptr &&
872 dlm_lvb_operations[old_mode + 1][new_mode + 1])
873 copy_lvb = 1;
874
875 lkb->lkb_lksb->sb_status = cb.sb_status;
876 lkb->lkb_lksb->sb_flags = cb.sb_flags;
877 }
878
879 rv = copy_result_to_user(lkb->lkb_ua,
880 test_bit(DLM_PROC_FLAGS_COMPAT, &proc->flags),
881 cb.flags, cb.mode, copy_lvb, buf, count);
882
883 /* removes ref for proc->asts, may cause lkb to be freed */
884 if (!resid)
David Teigland597d0ca2006-07-12 16:44:04 -0500885 dlm_put_lkb(lkb);
886
David Teigland8304d6f2011-02-21 14:58:21 -0600887 return rv;
David Teigland597d0ca2006-07-12 16:44:04 -0500888}
889
Al Viro076ccb72017-07-03 01:02:18 -0400890static __poll_t device_poll(struct file *file, poll_table *wait)
David Teigland597d0ca2006-07-12 16:44:04 -0500891{
892 struct dlm_user_proc *proc = file->private_data;
893
894 poll_wait(file, &proc->wait, wait);
895
896 spin_lock(&proc->asts_spin);
897 if (!list_empty(&proc->asts)) {
898 spin_unlock(&proc->asts_spin);
Linus Torvaldsa9a08842018-02-11 14:34:03 -0800899 return EPOLLIN | EPOLLRDNORM;
David Teigland597d0ca2006-07-12 16:44:04 -0500900 }
901 spin_unlock(&proc->asts_spin);
902 return 0;
903}
904
David Teiglanddc68c7e2008-08-18 11:43:30 -0500905int dlm_user_daemon_available(void)
906{
907 /* dlm_controld hasn't started (or, has started, but not
908 properly populated configfs) */
909
910 if (!dlm_our_nodeid())
911 return 0;
912
913 /* This is to deal with versions of dlm_controld that don't
914 know about the monitor device. We assume that if the
915 dlm_controld was started (above), but the monitor device
916 was never opened, that it's an old version. dlm_controld
917 should open the monitor device before populating configfs. */
918
919 if (dlm_monitor_unused)
920 return 1;
921
922 return atomic_read(&dlm_monitor_opened) ? 1 : 0;
923}
924
David Teigland597d0ca2006-07-12 16:44:04 -0500925static int ctl_device_open(struct inode *inode, struct file *file)
926{
927 file->private_data = NULL;
928 return 0;
929}
930
931static int ctl_device_close(struct inode *inode, struct file *file)
932{
933 return 0;
934}
935
David Teiglanddc68c7e2008-08-18 11:43:30 -0500936static int monitor_device_open(struct inode *inode, struct file *file)
937{
938 atomic_inc(&dlm_monitor_opened);
939 dlm_monitor_unused = 0;
940 return 0;
941}
942
943static int monitor_device_close(struct inode *inode, struct file *file)
944{
945 if (atomic_dec_and_test(&dlm_monitor_opened))
946 dlm_stop_lockspaces();
947 return 0;
948}
949
Arjan van de Ven00977a52007-02-12 00:55:34 -0800950static const struct file_operations device_fops = {
David Teigland597d0ca2006-07-12 16:44:04 -0500951 .open = device_open,
952 .release = device_close,
953 .read = device_read,
954 .write = device_write,
955 .poll = device_poll,
956 .owner = THIS_MODULE,
Arnd Bergmann6038f372010-08-15 18:52:59 +0200957 .llseek = noop_llseek,
David Teigland597d0ca2006-07-12 16:44:04 -0500958};
959
Arjan van de Ven00977a52007-02-12 00:55:34 -0800960static const struct file_operations ctl_device_fops = {
David Teigland597d0ca2006-07-12 16:44:04 -0500961 .open = ctl_device_open,
962 .release = ctl_device_close,
David Teiglandd7db9232007-05-18 09:00:32 -0500963 .read = device_read,
David Teigland597d0ca2006-07-12 16:44:04 -0500964 .write = device_write,
965 .owner = THIS_MODULE,
Arnd Bergmann6038f372010-08-15 18:52:59 +0200966 .llseek = noop_llseek,
David Teigland597d0ca2006-07-12 16:44:04 -0500967};
968
Denis Cheng0fe410d2008-01-29 13:50:16 +0800969static struct miscdevice ctl_device = {
970 .name = "dlm-control",
971 .fops = &ctl_device_fops,
972 .minor = MISC_DYNAMIC_MINOR,
973};
974
David Teiglanddc68c7e2008-08-18 11:43:30 -0500975static const struct file_operations monitor_device_fops = {
976 .open = monitor_device_open,
977 .release = monitor_device_close,
978 .owner = THIS_MODULE,
Arnd Bergmann6038f372010-08-15 18:52:59 +0200979 .llseek = noop_llseek,
David Teiglanddc68c7e2008-08-18 11:43:30 -0500980};
981
982static struct miscdevice monitor_device = {
983 .name = "dlm-monitor",
984 .fops = &monitor_device_fops,
985 .minor = MISC_DYNAMIC_MINOR,
986};
987
Denis Cheng30727172008-02-02 01:53:46 +0800988int __init dlm_user_init(void)
David Teigland597d0ca2006-07-12 16:44:04 -0500989{
990 int error;
991
David Teiglanddc68c7e2008-08-18 11:43:30 -0500992 atomic_set(&dlm_monitor_opened, 0);
David Teigland597d0ca2006-07-12 16:44:04 -0500993
David Teiglanddc68c7e2008-08-18 11:43:30 -0500994 error = misc_register(&ctl_device);
995 if (error) {
996 log_print("misc_register failed for control device");
997 goto out;
998 }
999
1000 error = misc_register(&monitor_device);
1001 if (error) {
1002 log_print("misc_register failed for monitor device");
1003 misc_deregister(&ctl_device);
1004 }
1005 out:
David Teigland597d0ca2006-07-12 16:44:04 -05001006 return error;
1007}
1008
1009void dlm_user_exit(void)
1010{
1011 misc_deregister(&ctl_device);
David Teiglanddc68c7e2008-08-18 11:43:30 -05001012 misc_deregister(&monitor_device);
David Teigland597d0ca2006-07-12 16:44:04 -05001013}
1014