blob: bb0d307deadd321d0571d88a6a11f03ceac0d9bb [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>
12#include <linux/module.h>
13#include <linux/file.h>
14#include <linux/fs.h>
15#include <linux/poll.h>
16#include <linux/signal.h>
17#include <linux/spinlock.h>
18#include <linux/dlm.h>
19#include <linux/dlm_device.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090020#include <linux/slab.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 Teigland6d9f5502018-12-03 15:27:37 -060028#include "config.h"
David Teigland597d0ca2006-07-12 16:44:04 -050029
Denis Cheng0fe410d2008-01-29 13:50:16 +080030static const char name_prefix[] = "dlm";
Arjan van de Ven00977a52007-02-12 00:55:34 -080031static const struct file_operations device_fops;
David Teiglanddc68c7e2008-08-18 11:43:30 -050032static atomic_t dlm_monitor_opened;
33static int dlm_monitor_unused = 1;
David Teigland597d0ca2006-07-12 16:44:04 -050034
35#ifdef CONFIG_COMPAT
36
37struct dlm_lock_params32 {
38 __u8 mode;
39 __u8 namelen;
David Teiglandd7db9232007-05-18 09:00:32 -050040 __u16 unused;
41 __u32 flags;
David Teigland597d0ca2006-07-12 16:44:04 -050042 __u32 lkid;
43 __u32 parent;
David Teiglandd7db9232007-05-18 09:00:32 -050044 __u64 xid;
45 __u64 timeout;
David Teigland597d0ca2006-07-12 16:44:04 -050046 __u32 castparam;
47 __u32 castaddr;
48 __u32 bastparam;
49 __u32 bastaddr;
50 __u32 lksb;
David Teigland597d0ca2006-07-12 16:44:04 -050051 char lvb[DLM_USER_LVB_LEN];
52 char name[0];
53};
54
55struct dlm_write_request32 {
56 __u32 version[3];
57 __u8 cmd;
58 __u8 is64bit;
59 __u8 unused[2];
60
61 union {
62 struct dlm_lock_params32 lock;
63 struct dlm_lspace_params lspace;
David Teigland72c2be72007-03-30 15:06:16 -050064 struct dlm_purge_params purge;
David Teigland597d0ca2006-07-12 16:44:04 -050065 } i;
66};
67
68struct dlm_lksb32 {
69 __u32 sb_status;
70 __u32 sb_lkid;
71 __u8 sb_flags;
72 __u32 sb_lvbptr;
73};
74
75struct dlm_lock_result32 {
David Teiglandd7db9232007-05-18 09:00:32 -050076 __u32 version[3];
David Teigland597d0ca2006-07-12 16:44:04 -050077 __u32 length;
78 __u32 user_astaddr;
79 __u32 user_astparam;
80 __u32 user_lksb;
81 struct dlm_lksb32 lksb;
82 __u8 bast_mode;
83 __u8 unused[3];
84 /* Offsets may be zero if no data is present */
85 __u32 lvb_offset;
86};
87
88static void compat_input(struct dlm_write_request *kb,
Patrick Caulfeld2a792892008-01-17 10:25:28 +000089 struct dlm_write_request32 *kb32,
David Teigland1fecb1c2009-03-04 11:17:23 -060090 int namelen)
David Teigland597d0ca2006-07-12 16:44:04 -050091{
92 kb->version[0] = kb32->version[0];
93 kb->version[1] = kb32->version[1];
94 kb->version[2] = kb32->version[2];
95
96 kb->cmd = kb32->cmd;
97 kb->is64bit = kb32->is64bit;
98 if (kb->cmd == DLM_USER_CREATE_LOCKSPACE ||
99 kb->cmd == DLM_USER_REMOVE_LOCKSPACE) {
100 kb->i.lspace.flags = kb32->i.lspace.flags;
101 kb->i.lspace.minor = kb32->i.lspace.minor;
David Teigland1fecb1c2009-03-04 11:17:23 -0600102 memcpy(kb->i.lspace.name, kb32->i.lspace.name, namelen);
David Teigland72c2be72007-03-30 15:06:16 -0500103 } else if (kb->cmd == DLM_USER_PURGE) {
104 kb->i.purge.nodeid = kb32->i.purge.nodeid;
105 kb->i.purge.pid = kb32->i.purge.pid;
David Teigland597d0ca2006-07-12 16:44:04 -0500106 } else {
107 kb->i.lock.mode = kb32->i.lock.mode;
108 kb->i.lock.namelen = kb32->i.lock.namelen;
109 kb->i.lock.flags = kb32->i.lock.flags;
110 kb->i.lock.lkid = kb32->i.lock.lkid;
111 kb->i.lock.parent = kb32->i.lock.parent;
David Teiglandd7db9232007-05-18 09:00:32 -0500112 kb->i.lock.xid = kb32->i.lock.xid;
113 kb->i.lock.timeout = kb32->i.lock.timeout;
David Teigland597d0ca2006-07-12 16:44:04 -0500114 kb->i.lock.castparam = (void *)(long)kb32->i.lock.castparam;
115 kb->i.lock.castaddr = (void *)(long)kb32->i.lock.castaddr;
116 kb->i.lock.bastparam = (void *)(long)kb32->i.lock.bastparam;
117 kb->i.lock.bastaddr = (void *)(long)kb32->i.lock.bastaddr;
118 kb->i.lock.lksb = (void *)(long)kb32->i.lock.lksb;
119 memcpy(kb->i.lock.lvb, kb32->i.lock.lvb, DLM_USER_LVB_LEN);
David Teigland1fecb1c2009-03-04 11:17:23 -0600120 memcpy(kb->i.lock.name, kb32->i.lock.name, namelen);
David Teigland597d0ca2006-07-12 16:44:04 -0500121 }
122}
123
124static void compat_output(struct dlm_lock_result *res,
125 struct dlm_lock_result32 *res32)
126{
David Teiglandd7db9232007-05-18 09:00:32 -0500127 res32->version[0] = res->version[0];
128 res32->version[1] = res->version[1];
129 res32->version[2] = res->version[2];
130
David Teigland597d0ca2006-07-12 16:44:04 -0500131 res32->user_astaddr = (__u32)(long)res->user_astaddr;
132 res32->user_astparam = (__u32)(long)res->user_astparam;
133 res32->user_lksb = (__u32)(long)res->user_lksb;
134 res32->bast_mode = res->bast_mode;
135
136 res32->lvb_offset = res->lvb_offset;
137 res32->length = res->length;
138
139 res32->lksb.sb_status = res->lksb.sb_status;
140 res32->lksb.sb_flags = res->lksb.sb_flags;
141 res32->lksb.sb_lkid = res->lksb.sb_lkid;
142 res32->lksb.sb_lvbptr = (__u32)(long)res->lksb.sb_lvbptr;
143}
144#endif
145
David Teigland84d8cd62007-05-29 08:44:23 -0500146/* Figure out if this lock is at the end of its life and no longer
147 available for the application to use. The lkb still exists until
148 the final ast is read. A lock becomes EOL in three situations:
149 1. a noqueue request fails with EAGAIN
150 2. an unlock completes with EUNLOCK
151 3. a cancel of a waiting request completes with ECANCEL/EDEADLK
152 An EOL lock needs to be removed from the process's list of locks.
153 And we can't allow any new operation on an EOL lock. This is
154 not related to the lifetime of the lkb struct which is managed
155 entirely by refcount. */
156
David Teigland8304d6f2011-02-21 14:58:21 -0600157static int lkb_is_endoflife(int mode, int status)
David Teigland84d8cd62007-05-29 08:44:23 -0500158{
David Teigland8304d6f2011-02-21 14:58:21 -0600159 switch (status) {
David Teigland84d8cd62007-05-29 08:44:23 -0500160 case -DLM_EUNLOCK:
161 return 1;
162 case -DLM_ECANCEL:
163 case -ETIMEDOUT:
David Teigland8b4021f2007-05-29 08:46:00 -0500164 case -EDEADLK:
David Teigland84d8cd62007-05-29 08:44:23 -0500165 case -EAGAIN:
David Teigland8304d6f2011-02-21 14:58:21 -0600166 if (mode == DLM_LOCK_IV)
David Teigland84d8cd62007-05-29 08:44:23 -0500167 return 1;
168 break;
169 }
170 return 0;
171}
172
David Teiglandef0c2bb2007-03-28 09:56:46 -0500173/* we could possibly check if the cancel of an orphan has resulted in the lkb
174 being removed and then remove that lkb from the orphans list and free it */
David Teigland597d0ca2006-07-12 16:44:04 -0500175
David Teigland8304d6f2011-02-21 14:58:21 -0600176void dlm_user_add_ast(struct dlm_lkb *lkb, uint32_t flags, int mode,
177 int status, uint32_t sbflags, uint64_t seq)
David Teigland597d0ca2006-07-12 16:44:04 -0500178{
179 struct dlm_ls *ls;
180 struct dlm_user_args *ua;
181 struct dlm_user_proc *proc;
David Teigland8304d6f2011-02-21 14:58:21 -0600182 int rv;
David Teigland597d0ca2006-07-12 16:44:04 -0500183
David Teiglandef0c2bb2007-03-28 09:56:46 -0500184 if (lkb->lkb_flags & (DLM_IFL_ORPHAN | DLM_IFL_DEAD))
David Teigland597d0ca2006-07-12 16:44:04 -0500185 return;
David Teigland597d0ca2006-07-12 16:44:04 -0500186
187 ls = lkb->lkb_resource->res_ls;
188 mutex_lock(&ls->ls_clear_proc_locks);
189
190 /* If ORPHAN/DEAD flag is set, it means the process is dead so an ast
191 can't be delivered. For ORPHAN's, dlm_clear_proc_locks() freed
David Teiglandef0c2bb2007-03-28 09:56:46 -0500192 lkb->ua so we can't try to use it. This second check is necessary
193 for cases where a completion ast is received for an operation that
194 began before clear_proc_locks did its cancel/unlock. */
David Teigland597d0ca2006-07-12 16:44:04 -0500195
David Teiglandef0c2bb2007-03-28 09:56:46 -0500196 if (lkb->lkb_flags & (DLM_IFL_ORPHAN | DLM_IFL_DEAD))
David Teigland597d0ca2006-07-12 16:44:04 -0500197 goto out;
David Teigland597d0ca2006-07-12 16:44:04 -0500198
David Teiglandd292c0c2008-02-06 23:27:04 -0600199 DLM_ASSERT(lkb->lkb_ua, dlm_print_lkb(lkb););
200 ua = lkb->lkb_ua;
David Teigland597d0ca2006-07-12 16:44:04 -0500201 proc = ua->proc;
202
David Teigland8304d6f2011-02-21 14:58:21 -0600203 if ((flags & DLM_CB_BAST) && ua->bastaddr == NULL)
David Teigland597d0ca2006-07-12 16:44:04 -0500204 goto out;
205
David Teigland8304d6f2011-02-21 14:58:21 -0600206 if ((flags & DLM_CB_CAST) && lkb_is_endoflife(mode, status))
207 lkb->lkb_flags |= DLM_IFL_ENDOFLIFE;
208
David Teigland597d0ca2006-07-12 16:44:04 -0500209 spin_lock(&proc->asts_spin);
David Teiglandef0c2bb2007-03-28 09:56:46 -0500210
David Teigland8304d6f2011-02-21 14:58:21 -0600211 rv = dlm_add_lkb_callback(lkb, flags, mode, status, sbflags, seq);
212 if (rv < 0) {
213 spin_unlock(&proc->asts_spin);
214 goto out;
215 }
David Teiglandef0c2bb2007-03-28 09:56:46 -0500216
David Teigland23e8e1a2011-04-05 13:16:24 -0500217 if (list_empty(&lkb->lkb_cb_list)) {
David Teigland597d0ca2006-07-12 16:44:04 -0500218 kref_get(&lkb->lkb_ref);
David Teigland23e8e1a2011-04-05 13:16:24 -0500219 list_add_tail(&lkb->lkb_cb_list, &proc->asts);
David Teigland597d0ca2006-07-12 16:44:04 -0500220 wake_up_interruptible(&proc->wait);
221 }
David Teigland597d0ca2006-07-12 16:44:04 -0500222 spin_unlock(&proc->asts_spin);
David Teigland34e22be2006-07-18 11:24:04 -0500223
David Teigland8304d6f2011-02-21 14:58:21 -0600224 if (lkb->lkb_flags & DLM_IFL_ENDOFLIFE) {
225 /* N.B. spin_lock locks_spin, not asts_spin */
David Teiglandce5246b2008-01-14 15:48:58 -0600226 spin_lock(&proc->locks_spin);
David Teiglandef0c2bb2007-03-28 09:56:46 -0500227 if (!list_empty(&lkb->lkb_ownqueue)) {
228 list_del_init(&lkb->lkb_ownqueue);
229 dlm_put_lkb(lkb);
230 }
David Teiglandce5246b2008-01-14 15:48:58 -0600231 spin_unlock(&proc->locks_spin);
David Teigland34e22be2006-07-18 11:24:04 -0500232 }
David Teigland597d0ca2006-07-12 16:44:04 -0500233 out:
234 mutex_unlock(&ls->ls_clear_proc_locks);
235}
236
237static int device_user_lock(struct dlm_user_proc *proc,
238 struct dlm_lock_params *params)
239{
240 struct dlm_ls *ls;
241 struct dlm_user_args *ua;
David Teigland2ab4bd82014-10-17 11:05:50 -0500242 uint32_t lkid;
David Teigland597d0ca2006-07-12 16:44:04 -0500243 int error = -ENOMEM;
244
245 ls = dlm_find_lockspace_local(proc->lockspace);
246 if (!ls)
247 return -ENOENT;
248
249 if (!params->castaddr || !params->lksb) {
250 error = -EINVAL;
251 goto out;
252 }
253
David Teigland573c24c2009-11-30 16:34:43 -0600254 ua = kzalloc(sizeof(struct dlm_user_args), GFP_NOFS);
David Teigland597d0ca2006-07-12 16:44:04 -0500255 if (!ua)
256 goto out;
257 ua->proc = proc;
258 ua->user_lksb = params->lksb;
259 ua->castparam = params->castparam;
260 ua->castaddr = params->castaddr;
261 ua->bastparam = params->bastparam;
262 ua->bastaddr = params->bastaddr;
David Teiglandd7db9232007-05-18 09:00:32 -0500263 ua->xid = params->xid;
David Teigland597d0ca2006-07-12 16:44:04 -0500264
David Teigland2ab4bd82014-10-17 11:05:50 -0500265 if (params->flags & DLM_LKF_CONVERT) {
David Teigland597d0ca2006-07-12 16:44:04 -0500266 error = dlm_user_convert(ls, ua,
267 params->mode, params->flags,
David Teiglandd7db9232007-05-18 09:00:32 -0500268 params->lkid, params->lvb,
269 (unsigned long) params->timeout);
David Teigland2ab4bd82014-10-17 11:05:50 -0500270 } else if (params->flags & DLM_LKF_ORPHAN) {
271 error = dlm_user_adopt_orphan(ls, ua,
272 params->mode, params->flags,
273 params->name, params->namelen,
274 (unsigned long) params->timeout,
275 &lkid);
276 if (!error)
277 error = lkid;
278 } else {
David Teigland597d0ca2006-07-12 16:44:04 -0500279 error = dlm_user_request(ls, ua,
280 params->mode, params->flags,
281 params->name, params->namelen,
David Teiglandd7db9232007-05-18 09:00:32 -0500282 (unsigned long) params->timeout);
David Teigland597d0ca2006-07-12 16:44:04 -0500283 if (!error)
284 error = ua->lksb.sb_lkid;
285 }
286 out:
287 dlm_put_lockspace(ls);
288 return error;
289}
290
291static int device_user_unlock(struct dlm_user_proc *proc,
292 struct dlm_lock_params *params)
293{
294 struct dlm_ls *ls;
295 struct dlm_user_args *ua;
296 int error = -ENOMEM;
297
298 ls = dlm_find_lockspace_local(proc->lockspace);
299 if (!ls)
300 return -ENOENT;
301
David Teigland573c24c2009-11-30 16:34:43 -0600302 ua = kzalloc(sizeof(struct dlm_user_args), GFP_NOFS);
David Teigland597d0ca2006-07-12 16:44:04 -0500303 if (!ua)
304 goto out;
305 ua->proc = proc;
306 ua->user_lksb = params->lksb;
307 ua->castparam = params->castparam;
308 ua->castaddr = params->castaddr;
309
310 if (params->flags & DLM_LKF_CANCEL)
311 error = dlm_user_cancel(ls, ua, params->flags, params->lkid);
312 else
313 error = dlm_user_unlock(ls, ua, params->flags, params->lkid,
314 params->lvb);
315 out:
316 dlm_put_lockspace(ls);
317 return error;
318}
319
David Teigland8b4021f2007-05-29 08:46:00 -0500320static int device_user_deadlock(struct dlm_user_proc *proc,
321 struct dlm_lock_params *params)
322{
323 struct dlm_ls *ls;
324 int error;
325
326 ls = dlm_find_lockspace_local(proc->lockspace);
327 if (!ls)
328 return -ENOENT;
329
330 error = dlm_user_deadlock(ls, params->flags, params->lkid);
331
332 dlm_put_lockspace(ls);
333 return error;
334}
335
David Teigland0f8e0d92008-08-06 13:30:24 -0500336static int dlm_device_register(struct dlm_ls *ls, char *name)
Patrick Caulfield254da032007-03-21 09:23:53 +0000337{
338 int error, len;
339
David Teigland0f8e0d92008-08-06 13:30:24 -0500340 /* The device is already registered. This happens when the
341 lockspace is created multiple times from userspace. */
342 if (ls->ls_device.name)
343 return 0;
344
Patrick Caulfield254da032007-03-21 09:23:53 +0000345 error = -ENOMEM;
346 len = strlen(name) + strlen(name_prefix) + 2;
David Teigland573c24c2009-11-30 16:34:43 -0600347 ls->ls_device.name = kzalloc(len, GFP_NOFS);
Patrick Caulfield254da032007-03-21 09:23:53 +0000348 if (!ls->ls_device.name)
349 goto fail;
350
351 snprintf((char *)ls->ls_device.name, len, "%s_%s", name_prefix,
352 name);
353 ls->ls_device.fops = &device_fops;
354 ls->ls_device.minor = MISC_DYNAMIC_MINOR;
355
356 error = misc_register(&ls->ls_device);
357 if (error) {
358 kfree(ls->ls_device.name);
Edwin Török5c23d3e2017-08-03 10:30:06 +0100359 /* this has to be set to NULL
360 * to avoid a double-free in dlm_device_deregister
361 */
362 ls->ls_device.name = NULL;
Patrick Caulfield254da032007-03-21 09:23:53 +0000363 }
364fail:
365 return error;
366}
367
David Teigland0f8e0d92008-08-06 13:30:24 -0500368int dlm_device_deregister(struct dlm_ls *ls)
369{
David Teigland0f8e0d92008-08-06 13:30:24 -0500370 /* The device is not registered. This happens when the lockspace
371 was never used from userspace, or when device_create_lockspace()
372 calls dlm_release_lockspace() after the register fails. */
373 if (!ls->ls_device.name)
374 return 0;
375
Greg Kroah-Hartmanf368ed62015-07-30 15:59:57 -0700376 misc_deregister(&ls->ls_device);
377 kfree(ls->ls_device.name);
378 return 0;
David Teigland0f8e0d92008-08-06 13:30:24 -0500379}
380
David Teigland72c2be72007-03-30 15:06:16 -0500381static int device_user_purge(struct dlm_user_proc *proc,
382 struct dlm_purge_params *params)
383{
384 struct dlm_ls *ls;
385 int error;
386
387 ls = dlm_find_lockspace_local(proc->lockspace);
388 if (!ls)
389 return -ENOENT;
390
391 error = dlm_user_purge(ls, proc, params->nodeid, params->pid);
392
393 dlm_put_lockspace(ls);
394 return error;
395}
396
David Teigland597d0ca2006-07-12 16:44:04 -0500397static int device_create_lockspace(struct dlm_lspace_params *params)
398{
399 dlm_lockspace_t *lockspace;
400 struct dlm_ls *ls;
Patrick Caulfield254da032007-03-21 09:23:53 +0000401 int error;
David Teigland597d0ca2006-07-12 16:44:04 -0500402
403 if (!capable(CAP_SYS_ADMIN))
404 return -EPERM;
405
David Teigland6d9f5502018-12-03 15:27:37 -0600406 error = dlm_new_lockspace(params->name, dlm_config.ci_cluster_name, params->flags,
David Teigland60f98d12011-11-02 14:30:58 -0500407 DLM_USER_LVB_LEN, NULL, NULL, NULL,
408 &lockspace);
David Teigland597d0ca2006-07-12 16:44:04 -0500409 if (error)
410 return error;
411
412 ls = dlm_find_lockspace_local(lockspace);
413 if (!ls)
414 return -ENOENT;
415
David Teigland0f8e0d92008-08-06 13:30:24 -0500416 error = dlm_device_register(ls, params->name);
David Teigland597d0ca2006-07-12 16:44:04 -0500417 dlm_put_lockspace(ls);
David Teigland597d0ca2006-07-12 16:44:04 -0500418
Patrick Caulfield254da032007-03-21 09:23:53 +0000419 if (error)
420 dlm_release_lockspace(lockspace, 0);
421 else
422 error = ls->ls_device.minor;
423
David Teigland597d0ca2006-07-12 16:44:04 -0500424 return error;
425}
426
427static int device_remove_lockspace(struct dlm_lspace_params *params)
428{
429 dlm_lockspace_t *lockspace;
430 struct dlm_ls *ls;
David Teiglandc6e6f0b2006-08-30 10:50:18 -0500431 int error, force = 0;
David Teigland597d0ca2006-07-12 16:44:04 -0500432
433 if (!capable(CAP_SYS_ADMIN))
434 return -EPERM;
435
436 ls = dlm_find_lockspace_device(params->minor);
437 if (!ls)
438 return -ENOENT;
439
David Teiglandc6e6f0b2006-08-30 10:50:18 -0500440 if (params->flags & DLM_USER_LSFLG_FORCEFREE)
441 force = 2;
442
David Teigland597d0ca2006-07-12 16:44:04 -0500443 lockspace = ls->ls_local_handle;
David Teigland597d0ca2006-07-12 16:44:04 -0500444 dlm_put_lockspace(ls);
David Teigland0f8e0d92008-08-06 13:30:24 -0500445
446 /* The final dlm_release_lockspace waits for references to go to
447 zero, so all processes will need to close their device for the
448 ls before the release will proceed. release also calls the
449 device_deregister above. Converting a positive return value
450 from release to zero means that userspace won't know when its
451 release was the final one, but it shouldn't need to know. */
452
David Teiglandc6e6f0b2006-08-30 10:50:18 -0500453 error = dlm_release_lockspace(lockspace, force);
David Teigland0f8e0d92008-08-06 13:30:24 -0500454 if (error > 0)
455 error = 0;
David Teigland597d0ca2006-07-12 16:44:04 -0500456 return error;
457}
458
459/* Check the user's version matches ours */
460static int check_version(struct dlm_write_request *req)
461{
462 if (req->version[0] != DLM_DEVICE_VERSION_MAJOR ||
463 (req->version[0] == DLM_DEVICE_VERSION_MAJOR &&
464 req->version[1] > DLM_DEVICE_VERSION_MINOR)) {
465
466 printk(KERN_DEBUG "dlm: process %s (%d) version mismatch "
467 "user (%d.%d.%d) kernel (%d.%d.%d)\n",
468 current->comm,
Pavel Emelyanovba25f9d2007-10-18 23:40:40 -0700469 task_pid_nr(current),
David Teigland597d0ca2006-07-12 16:44:04 -0500470 req->version[0],
471 req->version[1],
472 req->version[2],
473 DLM_DEVICE_VERSION_MAJOR,
474 DLM_DEVICE_VERSION_MINOR,
475 DLM_DEVICE_VERSION_PATCH);
476 return -EINVAL;
477 }
478 return 0;
479}
480
481/*
482 * device_write
483 *
484 * device_user_lock
485 * dlm_user_request -> request_lock
486 * dlm_user_convert -> convert_lock
487 *
488 * device_user_unlock
489 * dlm_user_unlock -> unlock_lock
490 * dlm_user_cancel -> cancel_lock
491 *
492 * device_create_lockspace
493 * dlm_new_lockspace
494 *
495 * device_remove_lockspace
496 * dlm_release_lockspace
497 */
498
499/* a write to a lockspace device is a lock or unlock request, a write
500 to the control device is to create/remove a lockspace */
501
502static ssize_t device_write(struct file *file, const char __user *buf,
503 size_t count, loff_t *ppos)
504{
505 struct dlm_user_proc *proc = file->private_data;
506 struct dlm_write_request *kbuf;
David Teigland597d0ca2006-07-12 16:44:04 -0500507 int error;
508
509#ifdef CONFIG_COMPAT
510 if (count < sizeof(struct dlm_write_request32))
511#else
512 if (count < sizeof(struct dlm_write_request))
513#endif
514 return -EINVAL;
515
David Teiglandd4b0bcf2013-02-04 15:31:22 -0600516 /*
517 * can't compare against COMPAT/dlm_write_request32 because
518 * we don't yet know if is64bit is zero
519 */
Sasha Levin2b75bc92012-09-09 16:16:58 +0200520 if (count > sizeof(struct dlm_write_request) + DLM_RESNAME_MAXLEN)
Sasha Levin2b75bc92012-09-09 16:16:58 +0200521 return -EINVAL;
522
Al Viro16e5c1f2015-12-24 00:06:05 -0500523 kbuf = memdup_user_nul(buf, count);
Al Viro117aa412016-01-21 17:41:23 -0500524 if (IS_ERR(kbuf))
Al Viro16e5c1f2015-12-24 00:06:05 -0500525 return PTR_ERR(kbuf);
David Teigland597d0ca2006-07-12 16:44:04 -0500526
527 if (check_version(kbuf)) {
528 error = -EBADE;
529 goto out_free;
530 }
531
532#ifdef CONFIG_COMPAT
533 if (!kbuf->is64bit) {
534 struct dlm_write_request32 *k32buf;
David Teigland1fecb1c2009-03-04 11:17:23 -0600535 int namelen = 0;
536
537 if (count > sizeof(struct dlm_write_request32))
538 namelen = count - sizeof(struct dlm_write_request32);
539
David Teigland597d0ca2006-07-12 16:44:04 -0500540 k32buf = (struct dlm_write_request32 *)kbuf;
David Teigland1fecb1c2009-03-04 11:17:23 -0600541
542 /* add 1 after namelen so that the name string is terminated */
543 kbuf = kzalloc(sizeof(struct dlm_write_request) + namelen + 1,
David Teigland573c24c2009-11-30 16:34:43 -0600544 GFP_NOFS);
David Teiglandcb980d92008-07-29 15:21:19 -0500545 if (!kbuf) {
546 kfree(k32buf);
David Teigland597d0ca2006-07-12 16:44:04 -0500547 return -ENOMEM;
David Teiglandcb980d92008-07-29 15:21:19 -0500548 }
David Teigland597d0ca2006-07-12 16:44:04 -0500549
550 if (proc)
551 set_bit(DLM_PROC_FLAGS_COMPAT, &proc->flags);
David Teigland1fecb1c2009-03-04 11:17:23 -0600552
553 compat_input(kbuf, k32buf, namelen);
David Teigland597d0ca2006-07-12 16:44:04 -0500554 kfree(k32buf);
555 }
556#endif
557
558 /* do we really need this? can a write happen after a close? */
559 if ((kbuf->cmd == DLM_USER_LOCK || kbuf->cmd == DLM_USER_UNLOCK) &&
David Teiglandcb980d92008-07-29 15:21:19 -0500560 (proc && test_bit(DLM_PROC_FLAGS_CLOSING, &proc->flags))) {
561 error = -EINVAL;
562 goto out_free;
563 }
David Teigland597d0ca2006-07-12 16:44:04 -0500564
David Teigland597d0ca2006-07-12 16:44:04 -0500565 error = -EINVAL;
566
567 switch (kbuf->cmd)
568 {
569 case DLM_USER_LOCK:
570 if (!proc) {
571 log_print("no locking on control device");
David Teiglandc6ca7bc2013-08-12 15:22:43 -0500572 goto out_free;
David Teigland597d0ca2006-07-12 16:44:04 -0500573 }
574 error = device_user_lock(proc, &kbuf->i.lock);
575 break;
576
577 case DLM_USER_UNLOCK:
578 if (!proc) {
579 log_print("no locking on control device");
David Teiglandc6ca7bc2013-08-12 15:22:43 -0500580 goto out_free;
David Teigland597d0ca2006-07-12 16:44:04 -0500581 }
582 error = device_user_unlock(proc, &kbuf->i.lock);
583 break;
584
David Teigland8b4021f2007-05-29 08:46:00 -0500585 case DLM_USER_DEADLOCK:
586 if (!proc) {
587 log_print("no locking on control device");
David Teiglandc6ca7bc2013-08-12 15:22:43 -0500588 goto out_free;
David Teigland8b4021f2007-05-29 08:46:00 -0500589 }
590 error = device_user_deadlock(proc, &kbuf->i.lock);
591 break;
592
David Teigland597d0ca2006-07-12 16:44:04 -0500593 case DLM_USER_CREATE_LOCKSPACE:
594 if (proc) {
595 log_print("create/remove only on control device");
David Teiglandc6ca7bc2013-08-12 15:22:43 -0500596 goto out_free;
David Teigland597d0ca2006-07-12 16:44:04 -0500597 }
598 error = device_create_lockspace(&kbuf->i.lspace);
599 break;
600
601 case DLM_USER_REMOVE_LOCKSPACE:
602 if (proc) {
603 log_print("create/remove only on control device");
David Teiglandc6ca7bc2013-08-12 15:22:43 -0500604 goto out_free;
David Teigland597d0ca2006-07-12 16:44:04 -0500605 }
606 error = device_remove_lockspace(&kbuf->i.lspace);
607 break;
608
David Teigland72c2be72007-03-30 15:06:16 -0500609 case DLM_USER_PURGE:
610 if (!proc) {
611 log_print("no locking on control device");
David Teiglandc6ca7bc2013-08-12 15:22:43 -0500612 goto out_free;
David Teigland72c2be72007-03-30 15:06:16 -0500613 }
614 error = device_user_purge(proc, &kbuf->i.purge);
615 break;
616
David Teigland597d0ca2006-07-12 16:44:04 -0500617 default:
618 log_print("Unknown command passed to DLM device : %d\n",
619 kbuf->cmd);
620 }
621
David Teigland597d0ca2006-07-12 16:44:04 -0500622 out_free:
623 kfree(kbuf);
624 return error;
625}
626
627/* Every process that opens the lockspace device has its own "proc" structure
628 hanging off the open file that's used to keep track of locks owned by the
629 process and asts that need to be delivered to the process. */
630
631static int device_open(struct inode *inode, struct file *file)
632{
633 struct dlm_user_proc *proc;
634 struct dlm_ls *ls;
635
636 ls = dlm_find_lockspace_device(iminor(inode));
David Teiglandf9f2ed42008-09-04 12:51:20 -0500637 if (!ls)
David Teigland597d0ca2006-07-12 16:44:04 -0500638 return -ENOENT;
639
David Teigland573c24c2009-11-30 16:34:43 -0600640 proc = kzalloc(sizeof(struct dlm_user_proc), GFP_NOFS);
David Teigland597d0ca2006-07-12 16:44:04 -0500641 if (!proc) {
642 dlm_put_lockspace(ls);
643 return -ENOMEM;
644 }
645
646 proc->lockspace = ls->ls_local_handle;
647 INIT_LIST_HEAD(&proc->asts);
648 INIT_LIST_HEAD(&proc->locks);
David Teiglanda1bc86e2007-01-15 10:34:52 -0600649 INIT_LIST_HEAD(&proc->unlocking);
David Teigland597d0ca2006-07-12 16:44:04 -0500650 spin_lock_init(&proc->asts_spin);
651 spin_lock_init(&proc->locks_spin);
652 init_waitqueue_head(&proc->wait);
653 file->private_data = proc;
654
655 return 0;
656}
657
658static int device_close(struct inode *inode, struct file *file)
659{
660 struct dlm_user_proc *proc = file->private_data;
661 struct dlm_ls *ls;
David Teigland597d0ca2006-07-12 16:44:04 -0500662
663 ls = dlm_find_lockspace_local(proc->lockspace);
664 if (!ls)
665 return -ENOENT;
666
David Teigland597d0ca2006-07-12 16:44:04 -0500667 set_bit(DLM_PROC_FLAGS_CLOSING, &proc->flags);
668
669 dlm_clear_proc_locks(ls, proc);
670
671 /* at this point no more lkb's should exist for this lockspace,
672 so there's no chance of dlm_user_add_ast() being called and
673 looking for lkb->ua->proc */
674
675 kfree(proc);
676 file->private_data = NULL;
677
678 dlm_put_lockspace(ls);
679 dlm_put_lockspace(ls); /* for the find in device_open() */
680
681 /* FIXME: AUTOFREE: if this ls is no longer used do
682 device_remove_lockspace() */
683
David Teigland597d0ca2006-07-12 16:44:04 -0500684 return 0;
685}
686
David Teigland8304d6f2011-02-21 14:58:21 -0600687static int copy_result_to_user(struct dlm_user_args *ua, int compat,
688 uint32_t flags, int mode, int copy_lvb,
689 char __user *buf, size_t count)
David Teigland597d0ca2006-07-12 16:44:04 -0500690{
691#ifdef CONFIG_COMPAT
692 struct dlm_lock_result32 result32;
693#endif
694 struct dlm_lock_result result;
695 void *resultptr;
696 int error=0;
697 int len;
698 int struct_len;
699
700 memset(&result, 0, sizeof(struct dlm_lock_result));
David Teiglandd7db9232007-05-18 09:00:32 -0500701 result.version[0] = DLM_DEVICE_VERSION_MAJOR;
702 result.version[1] = DLM_DEVICE_VERSION_MINOR;
703 result.version[2] = DLM_DEVICE_VERSION_PATCH;
Tycho Andersenf4b75492018-11-02 14:18:22 -0600704 memcpy(&result.lksb, &ua->lksb, offsetof(struct dlm_lksb, sb_lvbptr));
David Teigland597d0ca2006-07-12 16:44:04 -0500705 result.user_lksb = ua->user_lksb;
706
707 /* FIXME: dlm1 provides for the user's bastparam/addr to not be updated
708 in a conversion unless the conversion is successful. See code
709 in dlm_user_convert() for updating ua from ua_tmp. OpenVMS, though,
710 notes that a new blocking AST address and parameter are set even if
711 the conversion fails, so maybe we should just do that. */
712
David Teigland8304d6f2011-02-21 14:58:21 -0600713 if (flags & DLM_CB_BAST) {
David Teigland597d0ca2006-07-12 16:44:04 -0500714 result.user_astaddr = ua->bastaddr;
715 result.user_astparam = ua->bastparam;
David Teigland89d799d2010-03-25 14:23:13 -0500716 result.bast_mode = mode;
David Teigland597d0ca2006-07-12 16:44:04 -0500717 } else {
718 result.user_astaddr = ua->castaddr;
719 result.user_astparam = ua->castparam;
720 }
721
722#ifdef CONFIG_COMPAT
723 if (compat)
724 len = sizeof(struct dlm_lock_result32);
725 else
726#endif
727 len = sizeof(struct dlm_lock_result);
728 struct_len = len;
729
730 /* copy lvb to userspace if there is one, it's been updated, and
731 the user buffer has space for it */
732
David Teigland8304d6f2011-02-21 14:58:21 -0600733 if (copy_lvb && ua->lksb.sb_lvbptr && count >= len + DLM_USER_LVB_LEN) {
David Teigland597d0ca2006-07-12 16:44:04 -0500734 if (copy_to_user(buf+len, ua->lksb.sb_lvbptr,
735 DLM_USER_LVB_LEN)) {
736 error = -EFAULT;
737 goto out;
738 }
739
740 result.lvb_offset = len;
741 len += DLM_USER_LVB_LEN;
742 }
743
744 result.length = len;
745 resultptr = &result;
746#ifdef CONFIG_COMPAT
747 if (compat) {
748 compat_output(&result, &result32);
749 resultptr = &result32;
750 }
751#endif
752
753 if (copy_to_user(buf, resultptr, struct_len))
754 error = -EFAULT;
755 else
756 error = len;
757 out:
758 return error;
759}
760
David Teiglandd7db9232007-05-18 09:00:32 -0500761static int copy_version_to_user(char __user *buf, size_t count)
762{
763 struct dlm_device_version ver;
764
765 memset(&ver, 0, sizeof(struct dlm_device_version));
766 ver.version[0] = DLM_DEVICE_VERSION_MAJOR;
767 ver.version[1] = DLM_DEVICE_VERSION_MINOR;
768 ver.version[2] = DLM_DEVICE_VERSION_PATCH;
769
770 if (copy_to_user(buf, &ver, sizeof(struct dlm_device_version)))
771 return -EFAULT;
772 return sizeof(struct dlm_device_version);
773}
774
David Teigland597d0ca2006-07-12 16:44:04 -0500775/* a read returns a single ast described in a struct dlm_lock_result */
776
777static ssize_t device_read(struct file *file, char __user *buf, size_t count,
778 loff_t *ppos)
779{
780 struct dlm_user_proc *proc = file->private_data;
781 struct dlm_lkb *lkb;
David Teigland597d0ca2006-07-12 16:44:04 -0500782 DECLARE_WAITQUEUE(wait, current);
David Teigland8304d6f2011-02-21 14:58:21 -0600783 struct dlm_callback cb;
784 int rv, resid, copy_lvb = 0;
David Teiglandb96f4652015-08-25 12:51:44 -0500785 int old_mode, new_mode;
David Teigland597d0ca2006-07-12 16:44:04 -0500786
David Teiglandd7db9232007-05-18 09:00:32 -0500787 if (count == sizeof(struct dlm_device_version)) {
David Teigland8304d6f2011-02-21 14:58:21 -0600788 rv = copy_version_to_user(buf, count);
789 return rv;
David Teiglandd7db9232007-05-18 09:00:32 -0500790 }
791
792 if (!proc) {
793 log_print("non-version read from control device %zu", count);
794 return -EINVAL;
795 }
796
David Teigland597d0ca2006-07-12 16:44:04 -0500797#ifdef CONFIG_COMPAT
798 if (count < sizeof(struct dlm_lock_result32))
799#else
800 if (count < sizeof(struct dlm_lock_result))
801#endif
802 return -EINVAL;
803
David Teigland89d799d2010-03-25 14:23:13 -0500804 try_another:
805
David Teigland597d0ca2006-07-12 16:44:04 -0500806 /* do we really need this? can a read happen after a close? */
807 if (test_bit(DLM_PROC_FLAGS_CLOSING, &proc->flags))
808 return -EINVAL;
809
810 spin_lock(&proc->asts_spin);
811 if (list_empty(&proc->asts)) {
812 if (file->f_flags & O_NONBLOCK) {
813 spin_unlock(&proc->asts_spin);
814 return -EAGAIN;
815 }
816
817 add_wait_queue(&proc->wait, &wait);
818
819 repeat:
820 set_current_state(TASK_INTERRUPTIBLE);
821 if (list_empty(&proc->asts) && !signal_pending(current)) {
822 spin_unlock(&proc->asts_spin);
823 schedule();
824 spin_lock(&proc->asts_spin);
825 goto repeat;
826 }
827 set_current_state(TASK_RUNNING);
828 remove_wait_queue(&proc->wait, &wait);
829
830 if (signal_pending(current)) {
831 spin_unlock(&proc->asts_spin);
832 return -ERESTARTSYS;
833 }
834 }
835
David Teigland8304d6f2011-02-21 14:58:21 -0600836 /* if we empty lkb_callbacks, we don't want to unlock the spinlock
David Teigland23e8e1a2011-04-05 13:16:24 -0500837 without removing lkb_cb_list; so empty lkb_cb_list is always
David Teigland8304d6f2011-02-21 14:58:21 -0600838 consistent with empty lkb_callbacks */
David Teigland597d0ca2006-07-12 16:44:04 -0500839
David Teigland23e8e1a2011-04-05 13:16:24 -0500840 lkb = list_entry(proc->asts.next, struct dlm_lkb, lkb_cb_list);
David Teigland597d0ca2006-07-12 16:44:04 -0500841
David Teiglandb96f4652015-08-25 12:51:44 -0500842 /* rem_lkb_callback sets a new lkb_last_cast */
843 old_mode = lkb->lkb_last_cast.mode;
844
David Teigland8304d6f2011-02-21 14:58:21 -0600845 rv = dlm_rem_lkb_callback(lkb->lkb_resource->res_ls, lkb, &cb, &resid);
846 if (rv < 0) {
847 /* this shouldn't happen; lkb should have been removed from
848 list when resid was zero */
849 log_print("dlm_rem_lkb_callback empty %x", lkb->lkb_id);
David Teigland23e8e1a2011-04-05 13:16:24 -0500850 list_del_init(&lkb->lkb_cb_list);
David Teigland8304d6f2011-02-21 14:58:21 -0600851 spin_unlock(&proc->asts_spin);
852 /* removes ref for proc->asts, may cause lkb to be freed */
853 dlm_put_lkb(lkb);
854 goto try_another;
David Teigland89d799d2010-03-25 14:23:13 -0500855 }
David Teigland8304d6f2011-02-21 14:58:21 -0600856 if (!resid)
David Teigland23e8e1a2011-04-05 13:16:24 -0500857 list_del_init(&lkb->lkb_cb_list);
David Teigland597d0ca2006-07-12 16:44:04 -0500858 spin_unlock(&proc->asts_spin);
859
David Teigland8304d6f2011-02-21 14:58:21 -0600860 if (cb.flags & DLM_CB_SKIP) {
861 /* removes ref for proc->asts, may cause lkb to be freed */
862 if (!resid)
863 dlm_put_lkb(lkb);
864 goto try_another;
David Teigland89d799d2010-03-25 14:23:13 -0500865 }
David Teigland597d0ca2006-07-12 16:44:04 -0500866
David Teigland8304d6f2011-02-21 14:58:21 -0600867 if (cb.flags & DLM_CB_CAST) {
David Teigland8304d6f2011-02-21 14:58:21 -0600868 new_mode = cb.mode;
869
870 if (!cb.sb_status && lkb->lkb_lksb->sb_lvbptr &&
871 dlm_lvb_operations[old_mode + 1][new_mode + 1])
872 copy_lvb = 1;
873
874 lkb->lkb_lksb->sb_status = cb.sb_status;
875 lkb->lkb_lksb->sb_flags = cb.sb_flags;
876 }
877
878 rv = copy_result_to_user(lkb->lkb_ua,
879 test_bit(DLM_PROC_FLAGS_COMPAT, &proc->flags),
880 cb.flags, cb.mode, copy_lvb, buf, count);
881
882 /* removes ref for proc->asts, may cause lkb to be freed */
883 if (!resid)
David Teigland597d0ca2006-07-12 16:44:04 -0500884 dlm_put_lkb(lkb);
885
David Teigland8304d6f2011-02-21 14:58:21 -0600886 return rv;
David Teigland597d0ca2006-07-12 16:44:04 -0500887}
888
889static unsigned int device_poll(struct file *file, poll_table *wait)
890{
891 struct dlm_user_proc *proc = file->private_data;
892
893 poll_wait(file, &proc->wait, wait);
894
895 spin_lock(&proc->asts_spin);
896 if (!list_empty(&proc->asts)) {
897 spin_unlock(&proc->asts_spin);
898 return POLLIN | POLLRDNORM;
899 }
900 spin_unlock(&proc->asts_spin);
901 return 0;
902}
903
David Teiglanddc68c7e2008-08-18 11:43:30 -0500904int dlm_user_daemon_available(void)
905{
906 /* dlm_controld hasn't started (or, has started, but not
907 properly populated configfs) */
908
909 if (!dlm_our_nodeid())
910 return 0;
911
912 /* This is to deal with versions of dlm_controld that don't
913 know about the monitor device. We assume that if the
914 dlm_controld was started (above), but the monitor device
915 was never opened, that it's an old version. dlm_controld
916 should open the monitor device before populating configfs. */
917
918 if (dlm_monitor_unused)
919 return 1;
920
921 return atomic_read(&dlm_monitor_opened) ? 1 : 0;
922}
923
David Teigland597d0ca2006-07-12 16:44:04 -0500924static int ctl_device_open(struct inode *inode, struct file *file)
925{
926 file->private_data = NULL;
927 return 0;
928}
929
930static int ctl_device_close(struct inode *inode, struct file *file)
931{
932 return 0;
933}
934
David Teiglanddc68c7e2008-08-18 11:43:30 -0500935static int monitor_device_open(struct inode *inode, struct file *file)
936{
937 atomic_inc(&dlm_monitor_opened);
938 dlm_monitor_unused = 0;
939 return 0;
940}
941
942static int monitor_device_close(struct inode *inode, struct file *file)
943{
944 if (atomic_dec_and_test(&dlm_monitor_opened))
945 dlm_stop_lockspaces();
946 return 0;
947}
948
Arjan van de Ven00977a52007-02-12 00:55:34 -0800949static const struct file_operations device_fops = {
David Teigland597d0ca2006-07-12 16:44:04 -0500950 .open = device_open,
951 .release = device_close,
952 .read = device_read,
953 .write = device_write,
954 .poll = device_poll,
955 .owner = THIS_MODULE,
Arnd Bergmann6038f372010-08-15 18:52:59 +0200956 .llseek = noop_llseek,
David Teigland597d0ca2006-07-12 16:44:04 -0500957};
958
Arjan van de Ven00977a52007-02-12 00:55:34 -0800959static const struct file_operations ctl_device_fops = {
David Teigland597d0ca2006-07-12 16:44:04 -0500960 .open = ctl_device_open,
961 .release = ctl_device_close,
David Teiglandd7db9232007-05-18 09:00:32 -0500962 .read = device_read,
David Teigland597d0ca2006-07-12 16:44:04 -0500963 .write = device_write,
964 .owner = THIS_MODULE,
Arnd Bergmann6038f372010-08-15 18:52:59 +0200965 .llseek = noop_llseek,
David Teigland597d0ca2006-07-12 16:44:04 -0500966};
967
Denis Cheng0fe410d2008-01-29 13:50:16 +0800968static struct miscdevice ctl_device = {
969 .name = "dlm-control",
970 .fops = &ctl_device_fops,
971 .minor = MISC_DYNAMIC_MINOR,
972};
973
David Teiglanddc68c7e2008-08-18 11:43:30 -0500974static const struct file_operations monitor_device_fops = {
975 .open = monitor_device_open,
976 .release = monitor_device_close,
977 .owner = THIS_MODULE,
Arnd Bergmann6038f372010-08-15 18:52:59 +0200978 .llseek = noop_llseek,
David Teiglanddc68c7e2008-08-18 11:43:30 -0500979};
980
981static struct miscdevice monitor_device = {
982 .name = "dlm-monitor",
983 .fops = &monitor_device_fops,
984 .minor = MISC_DYNAMIC_MINOR,
985};
986
Denis Cheng30727172008-02-02 01:53:46 +0800987int __init dlm_user_init(void)
David Teigland597d0ca2006-07-12 16:44:04 -0500988{
989 int error;
990
David Teiglanddc68c7e2008-08-18 11:43:30 -0500991 atomic_set(&dlm_monitor_opened, 0);
David Teigland597d0ca2006-07-12 16:44:04 -0500992
David Teiglanddc68c7e2008-08-18 11:43:30 -0500993 error = misc_register(&ctl_device);
994 if (error) {
995 log_print("misc_register failed for control device");
996 goto out;
997 }
998
999 error = misc_register(&monitor_device);
1000 if (error) {
1001 log_print("misc_register failed for monitor device");
1002 misc_deregister(&ctl_device);
1003 }
1004 out:
David Teigland597d0ca2006-07-12 16:44:04 -05001005 return error;
1006}
1007
1008void dlm_user_exit(void)
1009{
1010 misc_deregister(&ctl_device);
David Teiglanddc68c7e2008-08-18 11:43:30 -05001011 misc_deregister(&monitor_device);
David Teigland597d0ca2006-07-12 16:44:04 -05001012}
1013