blob: 58c2f4a21b7f4233b34b70efb0602b297d7f9012 [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 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{
David Teiglandd7db9232007-05-18 09:00:32 -0500126 res32->version[0] = res->version[0];
127 res32->version[1] = res->version[1];
128 res32->version[2] = res->version[2];
129
David Teigland597d0ca2006-07-12 16:44:04 -0500130 res32->user_astaddr = (__u32)(long)res->user_astaddr;
131 res32->user_astparam = (__u32)(long)res->user_astparam;
132 res32->user_lksb = (__u32)(long)res->user_lksb;
133 res32->bast_mode = res->bast_mode;
134
135 res32->lvb_offset = res->lvb_offset;
136 res32->length = res->length;
137
138 res32->lksb.sb_status = res->lksb.sb_status;
139 res32->lksb.sb_flags = res->lksb.sb_flags;
140 res32->lksb.sb_lkid = res->lksb.sb_lkid;
141 res32->lksb.sb_lvbptr = (__u32)(long)res->lksb.sb_lvbptr;
142}
143#endif
144
David Teigland84d8cd62007-05-29 08:44:23 -0500145/* Figure out if this lock is at the end of its life and no longer
146 available for the application to use. The lkb still exists until
147 the final ast is read. A lock becomes EOL in three situations:
148 1. a noqueue request fails with EAGAIN
149 2. an unlock completes with EUNLOCK
150 3. a cancel of a waiting request completes with ECANCEL/EDEADLK
151 An EOL lock needs to be removed from the process's list of locks.
152 And we can't allow any new operation on an EOL lock. This is
153 not related to the lifetime of the lkb struct which is managed
154 entirely by refcount. */
155
David Teigland8304d6f2011-02-21 14:58:21 -0600156static int lkb_is_endoflife(int mode, int status)
David Teigland84d8cd62007-05-29 08:44:23 -0500157{
David Teigland8304d6f2011-02-21 14:58:21 -0600158 switch (status) {
David Teigland84d8cd62007-05-29 08:44:23 -0500159 case -DLM_EUNLOCK:
160 return 1;
161 case -DLM_ECANCEL:
162 case -ETIMEDOUT:
David Teigland8b4021f2007-05-29 08:46:00 -0500163 case -EDEADLK:
David Teigland84d8cd62007-05-29 08:44:23 -0500164 case -EAGAIN:
David Teigland8304d6f2011-02-21 14:58:21 -0600165 if (mode == DLM_LOCK_IV)
David Teigland84d8cd62007-05-29 08:44:23 -0500166 return 1;
167 break;
168 }
169 return 0;
170}
171
David Teiglandef0c2bb2007-03-28 09:56:46 -0500172/* we could possibly check if the cancel of an orphan has resulted in the lkb
173 being removed and then remove that lkb from the orphans list and free it */
David Teigland597d0ca2006-07-12 16:44:04 -0500174
David Teigland8304d6f2011-02-21 14:58:21 -0600175void dlm_user_add_ast(struct dlm_lkb *lkb, uint32_t flags, int mode,
176 int status, uint32_t sbflags, uint64_t seq)
David Teigland597d0ca2006-07-12 16:44:04 -0500177{
178 struct dlm_ls *ls;
179 struct dlm_user_args *ua;
180 struct dlm_user_proc *proc;
David Teigland8304d6f2011-02-21 14:58:21 -0600181 int rv;
David Teigland597d0ca2006-07-12 16:44:04 -0500182
David Teiglandef0c2bb2007-03-28 09:56:46 -0500183 if (lkb->lkb_flags & (DLM_IFL_ORPHAN | DLM_IFL_DEAD))
David Teigland597d0ca2006-07-12 16:44:04 -0500184 return;
David Teigland597d0ca2006-07-12 16:44:04 -0500185
186 ls = lkb->lkb_resource->res_ls;
187 mutex_lock(&ls->ls_clear_proc_locks);
188
189 /* If ORPHAN/DEAD flag is set, it means the process is dead so an ast
190 can't be delivered. For ORPHAN's, dlm_clear_proc_locks() freed
David Teiglandef0c2bb2007-03-28 09:56:46 -0500191 lkb->ua so we can't try to use it. This second check is necessary
192 for cases where a completion ast is received for an operation that
193 began before clear_proc_locks did its cancel/unlock. */
David Teigland597d0ca2006-07-12 16:44:04 -0500194
David Teiglandef0c2bb2007-03-28 09:56:46 -0500195 if (lkb->lkb_flags & (DLM_IFL_ORPHAN | DLM_IFL_DEAD))
David Teigland597d0ca2006-07-12 16:44:04 -0500196 goto out;
David Teigland597d0ca2006-07-12 16:44:04 -0500197
David Teiglandd292c0c2008-02-06 23:27:04 -0600198 DLM_ASSERT(lkb->lkb_ua, dlm_print_lkb(lkb););
199 ua = lkb->lkb_ua;
David Teigland597d0ca2006-07-12 16:44:04 -0500200 proc = ua->proc;
201
David Teigland8304d6f2011-02-21 14:58:21 -0600202 if ((flags & DLM_CB_BAST) && ua->bastaddr == NULL)
David Teigland597d0ca2006-07-12 16:44:04 -0500203 goto out;
204
David Teigland8304d6f2011-02-21 14:58:21 -0600205 if ((flags & DLM_CB_CAST) && lkb_is_endoflife(mode, status))
206 lkb->lkb_flags |= DLM_IFL_ENDOFLIFE;
207
David Teigland597d0ca2006-07-12 16:44:04 -0500208 spin_lock(&proc->asts_spin);
David Teiglandef0c2bb2007-03-28 09:56:46 -0500209
David Teigland8304d6f2011-02-21 14:58:21 -0600210 rv = dlm_add_lkb_callback(lkb, flags, mode, status, sbflags, seq);
211 if (rv < 0) {
212 spin_unlock(&proc->asts_spin);
213 goto out;
214 }
David Teiglandef0c2bb2007-03-28 09:56:46 -0500215
David Teigland23e8e1a2011-04-05 13:16:24 -0500216 if (list_empty(&lkb->lkb_cb_list)) {
David Teigland597d0ca2006-07-12 16:44:04 -0500217 kref_get(&lkb->lkb_ref);
David Teigland23e8e1a2011-04-05 13:16:24 -0500218 list_add_tail(&lkb->lkb_cb_list, &proc->asts);
David Teigland597d0ca2006-07-12 16:44:04 -0500219 wake_up_interruptible(&proc->wait);
220 }
David Teigland597d0ca2006-07-12 16:44:04 -0500221 spin_unlock(&proc->asts_spin);
David Teigland34e22be2006-07-18 11:24:04 -0500222
David Teigland8304d6f2011-02-21 14:58:21 -0600223 if (lkb->lkb_flags & DLM_IFL_ENDOFLIFE) {
224 /* N.B. spin_lock locks_spin, not asts_spin */
David Teiglandce5246b2008-01-14 15:48:58 -0600225 spin_lock(&proc->locks_spin);
David Teiglandef0c2bb2007-03-28 09:56:46 -0500226 if (!list_empty(&lkb->lkb_ownqueue)) {
227 list_del_init(&lkb->lkb_ownqueue);
228 dlm_put_lkb(lkb);
229 }
David Teiglandce5246b2008-01-14 15:48:58 -0600230 spin_unlock(&proc->locks_spin);
David Teigland34e22be2006-07-18 11:24:04 -0500231 }
David Teigland597d0ca2006-07-12 16:44:04 -0500232 out:
233 mutex_unlock(&ls->ls_clear_proc_locks);
234}
235
236static int device_user_lock(struct dlm_user_proc *proc,
237 struct dlm_lock_params *params)
238{
239 struct dlm_ls *ls;
240 struct dlm_user_args *ua;
David Teigland2ab4bd82014-10-17 11:05:50 -0500241 uint32_t lkid;
David Teigland597d0ca2006-07-12 16:44:04 -0500242 int error = -ENOMEM;
243
244 ls = dlm_find_lockspace_local(proc->lockspace);
245 if (!ls)
246 return -ENOENT;
247
248 if (!params->castaddr || !params->lksb) {
249 error = -EINVAL;
250 goto out;
251 }
252
David Teigland573c24c2009-11-30 16:34:43 -0600253 ua = kzalloc(sizeof(struct dlm_user_args), GFP_NOFS);
David Teigland597d0ca2006-07-12 16:44:04 -0500254 if (!ua)
255 goto out;
256 ua->proc = proc;
257 ua->user_lksb = params->lksb;
258 ua->castparam = params->castparam;
259 ua->castaddr = params->castaddr;
260 ua->bastparam = params->bastparam;
261 ua->bastaddr = params->bastaddr;
David Teiglandd7db9232007-05-18 09:00:32 -0500262 ua->xid = params->xid;
David Teigland597d0ca2006-07-12 16:44:04 -0500263
David Teigland2ab4bd82014-10-17 11:05:50 -0500264 if (params->flags & DLM_LKF_CONVERT) {
David Teigland597d0ca2006-07-12 16:44:04 -0500265 error = dlm_user_convert(ls, ua,
266 params->mode, params->flags,
David Teiglandd7db9232007-05-18 09:00:32 -0500267 params->lkid, params->lvb,
268 (unsigned long) params->timeout);
David Teigland2ab4bd82014-10-17 11:05:50 -0500269 } else if (params->flags & DLM_LKF_ORPHAN) {
270 error = dlm_user_adopt_orphan(ls, ua,
271 params->mode, params->flags,
272 params->name, params->namelen,
273 (unsigned long) params->timeout,
274 &lkid);
275 if (!error)
276 error = lkid;
277 } else {
David Teigland597d0ca2006-07-12 16:44:04 -0500278 error = dlm_user_request(ls, ua,
279 params->mode, params->flags,
280 params->name, params->namelen,
David Teiglandd7db9232007-05-18 09:00:32 -0500281 (unsigned long) params->timeout);
David Teigland597d0ca2006-07-12 16:44:04 -0500282 if (!error)
283 error = ua->lksb.sb_lkid;
284 }
285 out:
286 dlm_put_lockspace(ls);
287 return error;
288}
289
290static int device_user_unlock(struct dlm_user_proc *proc,
291 struct dlm_lock_params *params)
292{
293 struct dlm_ls *ls;
294 struct dlm_user_args *ua;
295 int error = -ENOMEM;
296
297 ls = dlm_find_lockspace_local(proc->lockspace);
298 if (!ls)
299 return -ENOENT;
300
David Teigland573c24c2009-11-30 16:34:43 -0600301 ua = kzalloc(sizeof(struct dlm_user_args), GFP_NOFS);
David Teigland597d0ca2006-07-12 16:44:04 -0500302 if (!ua)
303 goto out;
304 ua->proc = proc;
305 ua->user_lksb = params->lksb;
306 ua->castparam = params->castparam;
307 ua->castaddr = params->castaddr;
308
309 if (params->flags & DLM_LKF_CANCEL)
310 error = dlm_user_cancel(ls, ua, params->flags, params->lkid);
311 else
312 error = dlm_user_unlock(ls, ua, params->flags, params->lkid,
313 params->lvb);
314 out:
315 dlm_put_lockspace(ls);
316 return error;
317}
318
David Teigland8b4021f2007-05-29 08:46:00 -0500319static int device_user_deadlock(struct dlm_user_proc *proc,
320 struct dlm_lock_params *params)
321{
322 struct dlm_ls *ls;
323 int error;
324
325 ls = dlm_find_lockspace_local(proc->lockspace);
326 if (!ls)
327 return -ENOENT;
328
329 error = dlm_user_deadlock(ls, params->flags, params->lkid);
330
331 dlm_put_lockspace(ls);
332 return error;
333}
334
David Teigland0f8e0d92008-08-06 13:30:24 -0500335static int dlm_device_register(struct dlm_ls *ls, char *name)
Patrick Caulfield254da032007-03-21 09:23:53 +0000336{
337 int error, len;
338
David Teigland0f8e0d92008-08-06 13:30:24 -0500339 /* The device is already registered. This happens when the
340 lockspace is created multiple times from userspace. */
341 if (ls->ls_device.name)
342 return 0;
343
Patrick Caulfield254da032007-03-21 09:23:53 +0000344 error = -ENOMEM;
345 len = strlen(name) + strlen(name_prefix) + 2;
David Teigland573c24c2009-11-30 16:34:43 -0600346 ls->ls_device.name = kzalloc(len, GFP_NOFS);
Patrick Caulfield254da032007-03-21 09:23:53 +0000347 if (!ls->ls_device.name)
348 goto fail;
349
350 snprintf((char *)ls->ls_device.name, len, "%s_%s", name_prefix,
351 name);
352 ls->ls_device.fops = &device_fops;
353 ls->ls_device.minor = MISC_DYNAMIC_MINOR;
354
355 error = misc_register(&ls->ls_device);
356 if (error) {
357 kfree(ls->ls_device.name);
358 }
359fail:
360 return error;
361}
362
David Teigland0f8e0d92008-08-06 13:30:24 -0500363int dlm_device_deregister(struct dlm_ls *ls)
364{
David Teigland0f8e0d92008-08-06 13:30:24 -0500365 /* The device is not registered. This happens when the lockspace
366 was never used from userspace, or when device_create_lockspace()
367 calls dlm_release_lockspace() after the register fails. */
368 if (!ls->ls_device.name)
369 return 0;
370
Greg Kroah-Hartmanf368ed62015-07-30 15:59:57 -0700371 misc_deregister(&ls->ls_device);
372 kfree(ls->ls_device.name);
373 return 0;
David Teigland0f8e0d92008-08-06 13:30:24 -0500374}
375
David Teigland72c2be72007-03-30 15:06:16 -0500376static int device_user_purge(struct dlm_user_proc *proc,
377 struct dlm_purge_params *params)
378{
379 struct dlm_ls *ls;
380 int error;
381
382 ls = dlm_find_lockspace_local(proc->lockspace);
383 if (!ls)
384 return -ENOENT;
385
386 error = dlm_user_purge(ls, proc, params->nodeid, params->pid);
387
388 dlm_put_lockspace(ls);
389 return error;
390}
391
David Teigland597d0ca2006-07-12 16:44:04 -0500392static int device_create_lockspace(struct dlm_lspace_params *params)
393{
394 dlm_lockspace_t *lockspace;
395 struct dlm_ls *ls;
Patrick Caulfield254da032007-03-21 09:23:53 +0000396 int error;
David Teigland597d0ca2006-07-12 16:44:04 -0500397
398 if (!capable(CAP_SYS_ADMIN))
399 return -EPERM;
400
David Teigland60f98d12011-11-02 14:30:58 -0500401 error = dlm_new_lockspace(params->name, NULL, params->flags,
402 DLM_USER_LVB_LEN, NULL, NULL, NULL,
403 &lockspace);
David Teigland597d0ca2006-07-12 16:44:04 -0500404 if (error)
405 return error;
406
407 ls = dlm_find_lockspace_local(lockspace);
408 if (!ls)
409 return -ENOENT;
410
David Teigland0f8e0d92008-08-06 13:30:24 -0500411 error = dlm_device_register(ls, params->name);
David Teigland597d0ca2006-07-12 16:44:04 -0500412 dlm_put_lockspace(ls);
David Teigland597d0ca2006-07-12 16:44:04 -0500413
Patrick Caulfield254da032007-03-21 09:23:53 +0000414 if (error)
415 dlm_release_lockspace(lockspace, 0);
416 else
417 error = ls->ls_device.minor;
418
David Teigland597d0ca2006-07-12 16:44:04 -0500419 return error;
420}
421
422static int device_remove_lockspace(struct dlm_lspace_params *params)
423{
424 dlm_lockspace_t *lockspace;
425 struct dlm_ls *ls;
David Teiglandc6e6f0b2006-08-30 10:50:18 -0500426 int error, force = 0;
David Teigland597d0ca2006-07-12 16:44:04 -0500427
428 if (!capable(CAP_SYS_ADMIN))
429 return -EPERM;
430
431 ls = dlm_find_lockspace_device(params->minor);
432 if (!ls)
433 return -ENOENT;
434
David Teiglandc6e6f0b2006-08-30 10:50:18 -0500435 if (params->flags & DLM_USER_LSFLG_FORCEFREE)
436 force = 2;
437
David Teigland597d0ca2006-07-12 16:44:04 -0500438 lockspace = ls->ls_local_handle;
David Teigland597d0ca2006-07-12 16:44:04 -0500439 dlm_put_lockspace(ls);
David Teigland0f8e0d92008-08-06 13:30:24 -0500440
441 /* The final dlm_release_lockspace waits for references to go to
442 zero, so all processes will need to close their device for the
443 ls before the release will proceed. release also calls the
444 device_deregister above. Converting a positive return value
445 from release to zero means that userspace won't know when its
446 release was the final one, but it shouldn't need to know. */
447
David Teiglandc6e6f0b2006-08-30 10:50:18 -0500448 error = dlm_release_lockspace(lockspace, force);
David Teigland0f8e0d92008-08-06 13:30:24 -0500449 if (error > 0)
450 error = 0;
David Teigland597d0ca2006-07-12 16:44:04 -0500451 return error;
452}
453
454/* Check the user's version matches ours */
455static int check_version(struct dlm_write_request *req)
456{
457 if (req->version[0] != DLM_DEVICE_VERSION_MAJOR ||
458 (req->version[0] == DLM_DEVICE_VERSION_MAJOR &&
459 req->version[1] > DLM_DEVICE_VERSION_MINOR)) {
460
461 printk(KERN_DEBUG "dlm: process %s (%d) version mismatch "
462 "user (%d.%d.%d) kernel (%d.%d.%d)\n",
463 current->comm,
Pavel Emelyanovba25f9d2007-10-18 23:40:40 -0700464 task_pid_nr(current),
David Teigland597d0ca2006-07-12 16:44:04 -0500465 req->version[0],
466 req->version[1],
467 req->version[2],
468 DLM_DEVICE_VERSION_MAJOR,
469 DLM_DEVICE_VERSION_MINOR,
470 DLM_DEVICE_VERSION_PATCH);
471 return -EINVAL;
472 }
473 return 0;
474}
475
476/*
477 * device_write
478 *
479 * device_user_lock
480 * dlm_user_request -> request_lock
481 * dlm_user_convert -> convert_lock
482 *
483 * device_user_unlock
484 * dlm_user_unlock -> unlock_lock
485 * dlm_user_cancel -> cancel_lock
486 *
487 * device_create_lockspace
488 * dlm_new_lockspace
489 *
490 * device_remove_lockspace
491 * dlm_release_lockspace
492 */
493
494/* a write to a lockspace device is a lock or unlock request, a write
495 to the control device is to create/remove a lockspace */
496
497static ssize_t device_write(struct file *file, const char __user *buf,
498 size_t count, loff_t *ppos)
499{
500 struct dlm_user_proc *proc = file->private_data;
501 struct dlm_write_request *kbuf;
David Teigland597d0ca2006-07-12 16:44:04 -0500502 int error;
503
504#ifdef CONFIG_COMPAT
505 if (count < sizeof(struct dlm_write_request32))
506#else
507 if (count < sizeof(struct dlm_write_request))
508#endif
509 return -EINVAL;
510
David Teiglandd4b0bcf2013-02-04 15:31:22 -0600511 /*
512 * can't compare against COMPAT/dlm_write_request32 because
513 * we don't yet know if is64bit is zero
514 */
Sasha Levin2b75bc92012-09-09 16:16:58 +0200515 if (count > sizeof(struct dlm_write_request) + DLM_RESNAME_MAXLEN)
Sasha Levin2b75bc92012-09-09 16:16:58 +0200516 return -EINVAL;
517
Al Viro16e5c1f2015-12-24 00:06:05 -0500518 kbuf = memdup_user_nul(buf, count);
Al Viro117aa412016-01-21 17:41:23 -0500519 if (IS_ERR(kbuf))
Al Viro16e5c1f2015-12-24 00:06:05 -0500520 return PTR_ERR(kbuf);
David Teigland597d0ca2006-07-12 16:44:04 -0500521
522 if (check_version(kbuf)) {
523 error = -EBADE;
524 goto out_free;
525 }
526
527#ifdef CONFIG_COMPAT
528 if (!kbuf->is64bit) {
529 struct dlm_write_request32 *k32buf;
David Teigland1fecb1c2009-03-04 11:17:23 -0600530 int namelen = 0;
531
532 if (count > sizeof(struct dlm_write_request32))
533 namelen = count - sizeof(struct dlm_write_request32);
534
David Teigland597d0ca2006-07-12 16:44:04 -0500535 k32buf = (struct dlm_write_request32 *)kbuf;
David Teigland1fecb1c2009-03-04 11:17:23 -0600536
537 /* add 1 after namelen so that the name string is terminated */
538 kbuf = kzalloc(sizeof(struct dlm_write_request) + namelen + 1,
David Teigland573c24c2009-11-30 16:34:43 -0600539 GFP_NOFS);
David Teiglandcb980d92008-07-29 15:21:19 -0500540 if (!kbuf) {
541 kfree(k32buf);
David Teigland597d0ca2006-07-12 16:44:04 -0500542 return -ENOMEM;
David Teiglandcb980d92008-07-29 15:21:19 -0500543 }
David Teigland597d0ca2006-07-12 16:44:04 -0500544
545 if (proc)
546 set_bit(DLM_PROC_FLAGS_COMPAT, &proc->flags);
David Teigland1fecb1c2009-03-04 11:17:23 -0600547
548 compat_input(kbuf, k32buf, namelen);
David Teigland597d0ca2006-07-12 16:44:04 -0500549 kfree(k32buf);
550 }
551#endif
552
553 /* do we really need this? can a write happen after a close? */
554 if ((kbuf->cmd == DLM_USER_LOCK || kbuf->cmd == DLM_USER_UNLOCK) &&
David Teiglandcb980d92008-07-29 15:21:19 -0500555 (proc && test_bit(DLM_PROC_FLAGS_CLOSING, &proc->flags))) {
556 error = -EINVAL;
557 goto out_free;
558 }
David Teigland597d0ca2006-07-12 16:44:04 -0500559
David Teigland597d0ca2006-07-12 16:44:04 -0500560 error = -EINVAL;
561
562 switch (kbuf->cmd)
563 {
564 case DLM_USER_LOCK:
565 if (!proc) {
566 log_print("no locking on control device");
David Teiglandc6ca7bc2013-08-12 15:22:43 -0500567 goto out_free;
David Teigland597d0ca2006-07-12 16:44:04 -0500568 }
569 error = device_user_lock(proc, &kbuf->i.lock);
570 break;
571
572 case DLM_USER_UNLOCK:
573 if (!proc) {
574 log_print("no locking on control device");
David Teiglandc6ca7bc2013-08-12 15:22:43 -0500575 goto out_free;
David Teigland597d0ca2006-07-12 16:44:04 -0500576 }
577 error = device_user_unlock(proc, &kbuf->i.lock);
578 break;
579
David Teigland8b4021f2007-05-29 08:46:00 -0500580 case DLM_USER_DEADLOCK:
581 if (!proc) {
582 log_print("no locking on control device");
David Teiglandc6ca7bc2013-08-12 15:22:43 -0500583 goto out_free;
David Teigland8b4021f2007-05-29 08:46:00 -0500584 }
585 error = device_user_deadlock(proc, &kbuf->i.lock);
586 break;
587
David Teigland597d0ca2006-07-12 16:44:04 -0500588 case DLM_USER_CREATE_LOCKSPACE:
589 if (proc) {
590 log_print("create/remove only on control device");
David Teiglandc6ca7bc2013-08-12 15:22:43 -0500591 goto out_free;
David Teigland597d0ca2006-07-12 16:44:04 -0500592 }
593 error = device_create_lockspace(&kbuf->i.lspace);
594 break;
595
596 case DLM_USER_REMOVE_LOCKSPACE:
597 if (proc) {
598 log_print("create/remove only on control device");
David Teiglandc6ca7bc2013-08-12 15:22:43 -0500599 goto out_free;
David Teigland597d0ca2006-07-12 16:44:04 -0500600 }
601 error = device_remove_lockspace(&kbuf->i.lspace);
602 break;
603
David Teigland72c2be72007-03-30 15:06:16 -0500604 case DLM_USER_PURGE:
605 if (!proc) {
606 log_print("no locking on control device");
David Teiglandc6ca7bc2013-08-12 15:22:43 -0500607 goto out_free;
David Teigland72c2be72007-03-30 15:06:16 -0500608 }
609 error = device_user_purge(proc, &kbuf->i.purge);
610 break;
611
David Teigland597d0ca2006-07-12 16:44:04 -0500612 default:
613 log_print("Unknown command passed to DLM device : %d\n",
614 kbuf->cmd);
615 }
616
David Teigland597d0ca2006-07-12 16:44:04 -0500617 out_free:
618 kfree(kbuf);
619 return error;
620}
621
622/* Every process that opens the lockspace device has its own "proc" structure
623 hanging off the open file that's used to keep track of locks owned by the
624 process and asts that need to be delivered to the process. */
625
626static int device_open(struct inode *inode, struct file *file)
627{
628 struct dlm_user_proc *proc;
629 struct dlm_ls *ls;
630
631 ls = dlm_find_lockspace_device(iminor(inode));
David Teiglandf9f2ed42008-09-04 12:51:20 -0500632 if (!ls)
David Teigland597d0ca2006-07-12 16:44:04 -0500633 return -ENOENT;
634
David Teigland573c24c2009-11-30 16:34:43 -0600635 proc = kzalloc(sizeof(struct dlm_user_proc), GFP_NOFS);
David Teigland597d0ca2006-07-12 16:44:04 -0500636 if (!proc) {
637 dlm_put_lockspace(ls);
638 return -ENOMEM;
639 }
640
641 proc->lockspace = ls->ls_local_handle;
642 INIT_LIST_HEAD(&proc->asts);
643 INIT_LIST_HEAD(&proc->locks);
David Teiglanda1bc86e2007-01-15 10:34:52 -0600644 INIT_LIST_HEAD(&proc->unlocking);
David Teigland597d0ca2006-07-12 16:44:04 -0500645 spin_lock_init(&proc->asts_spin);
646 spin_lock_init(&proc->locks_spin);
647 init_waitqueue_head(&proc->wait);
648 file->private_data = proc;
649
650 return 0;
651}
652
653static int device_close(struct inode *inode, struct file *file)
654{
655 struct dlm_user_proc *proc = file->private_data;
656 struct dlm_ls *ls;
David Teigland597d0ca2006-07-12 16:44:04 -0500657
658 ls = dlm_find_lockspace_local(proc->lockspace);
659 if (!ls)
660 return -ENOENT;
661
David Teigland597d0ca2006-07-12 16:44:04 -0500662 set_bit(DLM_PROC_FLAGS_CLOSING, &proc->flags);
663
664 dlm_clear_proc_locks(ls, proc);
665
666 /* at this point no more lkb's should exist for this lockspace,
667 so there's no chance of dlm_user_add_ast() being called and
668 looking for lkb->ua->proc */
669
670 kfree(proc);
671 file->private_data = NULL;
672
673 dlm_put_lockspace(ls);
674 dlm_put_lockspace(ls); /* for the find in device_open() */
675
676 /* FIXME: AUTOFREE: if this ls is no longer used do
677 device_remove_lockspace() */
678
David Teigland597d0ca2006-07-12 16:44:04 -0500679 return 0;
680}
681
David Teigland8304d6f2011-02-21 14:58:21 -0600682static int copy_result_to_user(struct dlm_user_args *ua, int compat,
683 uint32_t flags, int mode, int copy_lvb,
684 char __user *buf, size_t count)
David Teigland597d0ca2006-07-12 16:44:04 -0500685{
686#ifdef CONFIG_COMPAT
687 struct dlm_lock_result32 result32;
688#endif
689 struct dlm_lock_result result;
690 void *resultptr;
691 int error=0;
692 int len;
693 int struct_len;
694
695 memset(&result, 0, sizeof(struct dlm_lock_result));
David Teiglandd7db9232007-05-18 09:00:32 -0500696 result.version[0] = DLM_DEVICE_VERSION_MAJOR;
697 result.version[1] = DLM_DEVICE_VERSION_MINOR;
698 result.version[2] = DLM_DEVICE_VERSION_PATCH;
David Teigland597d0ca2006-07-12 16:44:04 -0500699 memcpy(&result.lksb, &ua->lksb, sizeof(struct dlm_lksb));
700 result.user_lksb = ua->user_lksb;
701
702 /* FIXME: dlm1 provides for the user's bastparam/addr to not be updated
703 in a conversion unless the conversion is successful. See code
704 in dlm_user_convert() for updating ua from ua_tmp. OpenVMS, though,
705 notes that a new blocking AST address and parameter are set even if
706 the conversion fails, so maybe we should just do that. */
707
David Teigland8304d6f2011-02-21 14:58:21 -0600708 if (flags & DLM_CB_BAST) {
David Teigland597d0ca2006-07-12 16:44:04 -0500709 result.user_astaddr = ua->bastaddr;
710 result.user_astparam = ua->bastparam;
David Teigland89d799d2010-03-25 14:23:13 -0500711 result.bast_mode = mode;
David Teigland597d0ca2006-07-12 16:44:04 -0500712 } else {
713 result.user_astaddr = ua->castaddr;
714 result.user_astparam = ua->castparam;
715 }
716
717#ifdef CONFIG_COMPAT
718 if (compat)
719 len = sizeof(struct dlm_lock_result32);
720 else
721#endif
722 len = sizeof(struct dlm_lock_result);
723 struct_len = len;
724
725 /* copy lvb to userspace if there is one, it's been updated, and
726 the user buffer has space for it */
727
David Teigland8304d6f2011-02-21 14:58:21 -0600728 if (copy_lvb && ua->lksb.sb_lvbptr && count >= len + DLM_USER_LVB_LEN) {
David Teigland597d0ca2006-07-12 16:44:04 -0500729 if (copy_to_user(buf+len, ua->lksb.sb_lvbptr,
730 DLM_USER_LVB_LEN)) {
731 error = -EFAULT;
732 goto out;
733 }
734
735 result.lvb_offset = len;
736 len += DLM_USER_LVB_LEN;
737 }
738
739 result.length = len;
740 resultptr = &result;
741#ifdef CONFIG_COMPAT
742 if (compat) {
743 compat_output(&result, &result32);
744 resultptr = &result32;
745 }
746#endif
747
748 if (copy_to_user(buf, resultptr, struct_len))
749 error = -EFAULT;
750 else
751 error = len;
752 out:
753 return error;
754}
755
David Teiglandd7db9232007-05-18 09:00:32 -0500756static int copy_version_to_user(char __user *buf, size_t count)
757{
758 struct dlm_device_version ver;
759
760 memset(&ver, 0, sizeof(struct dlm_device_version));
761 ver.version[0] = DLM_DEVICE_VERSION_MAJOR;
762 ver.version[1] = DLM_DEVICE_VERSION_MINOR;
763 ver.version[2] = DLM_DEVICE_VERSION_PATCH;
764
765 if (copy_to_user(buf, &ver, sizeof(struct dlm_device_version)))
766 return -EFAULT;
767 return sizeof(struct dlm_device_version);
768}
769
David Teigland597d0ca2006-07-12 16:44:04 -0500770/* a read returns a single ast described in a struct dlm_lock_result */
771
772static ssize_t device_read(struct file *file, char __user *buf, size_t count,
773 loff_t *ppos)
774{
775 struct dlm_user_proc *proc = file->private_data;
776 struct dlm_lkb *lkb;
David Teigland597d0ca2006-07-12 16:44:04 -0500777 DECLARE_WAITQUEUE(wait, current);
David Teigland8304d6f2011-02-21 14:58:21 -0600778 struct dlm_callback cb;
779 int rv, resid, copy_lvb = 0;
David Teiglandb96f4652015-08-25 12:51:44 -0500780 int old_mode, new_mode;
David Teigland597d0ca2006-07-12 16:44:04 -0500781
David Teiglandd7db9232007-05-18 09:00:32 -0500782 if (count == sizeof(struct dlm_device_version)) {
David Teigland8304d6f2011-02-21 14:58:21 -0600783 rv = copy_version_to_user(buf, count);
784 return rv;
David Teiglandd7db9232007-05-18 09:00:32 -0500785 }
786
787 if (!proc) {
788 log_print("non-version read from control device %zu", count);
789 return -EINVAL;
790 }
791
David Teigland597d0ca2006-07-12 16:44:04 -0500792#ifdef CONFIG_COMPAT
793 if (count < sizeof(struct dlm_lock_result32))
794#else
795 if (count < sizeof(struct dlm_lock_result))
796#endif
797 return -EINVAL;
798
David Teigland89d799d2010-03-25 14:23:13 -0500799 try_another:
800
David Teigland597d0ca2006-07-12 16:44:04 -0500801 /* do we really need this? can a read happen after a close? */
802 if (test_bit(DLM_PROC_FLAGS_CLOSING, &proc->flags))
803 return -EINVAL;
804
805 spin_lock(&proc->asts_spin);
806 if (list_empty(&proc->asts)) {
807 if (file->f_flags & O_NONBLOCK) {
808 spin_unlock(&proc->asts_spin);
809 return -EAGAIN;
810 }
811
812 add_wait_queue(&proc->wait, &wait);
813
814 repeat:
815 set_current_state(TASK_INTERRUPTIBLE);
816 if (list_empty(&proc->asts) && !signal_pending(current)) {
817 spin_unlock(&proc->asts_spin);
818 schedule();
819 spin_lock(&proc->asts_spin);
820 goto repeat;
821 }
822 set_current_state(TASK_RUNNING);
823 remove_wait_queue(&proc->wait, &wait);
824
825 if (signal_pending(current)) {
826 spin_unlock(&proc->asts_spin);
827 return -ERESTARTSYS;
828 }
829 }
830
David Teigland8304d6f2011-02-21 14:58:21 -0600831 /* if we empty lkb_callbacks, we don't want to unlock the spinlock
David Teigland23e8e1a2011-04-05 13:16:24 -0500832 without removing lkb_cb_list; so empty lkb_cb_list is always
David Teigland8304d6f2011-02-21 14:58:21 -0600833 consistent with empty lkb_callbacks */
David Teigland597d0ca2006-07-12 16:44:04 -0500834
David Teigland23e8e1a2011-04-05 13:16:24 -0500835 lkb = list_entry(proc->asts.next, struct dlm_lkb, lkb_cb_list);
David Teigland597d0ca2006-07-12 16:44:04 -0500836
David Teiglandb96f4652015-08-25 12:51:44 -0500837 /* rem_lkb_callback sets a new lkb_last_cast */
838 old_mode = lkb->lkb_last_cast.mode;
839
David Teigland8304d6f2011-02-21 14:58:21 -0600840 rv = dlm_rem_lkb_callback(lkb->lkb_resource->res_ls, lkb, &cb, &resid);
841 if (rv < 0) {
842 /* this shouldn't happen; lkb should have been removed from
843 list when resid was zero */
844 log_print("dlm_rem_lkb_callback empty %x", lkb->lkb_id);
David Teigland23e8e1a2011-04-05 13:16:24 -0500845 list_del_init(&lkb->lkb_cb_list);
David Teigland8304d6f2011-02-21 14:58:21 -0600846 spin_unlock(&proc->asts_spin);
847 /* removes ref for proc->asts, may cause lkb to be freed */
848 dlm_put_lkb(lkb);
849 goto try_another;
David Teigland89d799d2010-03-25 14:23:13 -0500850 }
David Teigland8304d6f2011-02-21 14:58:21 -0600851 if (!resid)
David Teigland23e8e1a2011-04-05 13:16:24 -0500852 list_del_init(&lkb->lkb_cb_list);
David Teigland597d0ca2006-07-12 16:44:04 -0500853 spin_unlock(&proc->asts_spin);
854
David Teigland8304d6f2011-02-21 14:58:21 -0600855 if (cb.flags & DLM_CB_SKIP) {
856 /* removes ref for proc->asts, may cause lkb to be freed */
857 if (!resid)
858 dlm_put_lkb(lkb);
859 goto try_another;
David Teigland89d799d2010-03-25 14:23:13 -0500860 }
David Teigland597d0ca2006-07-12 16:44:04 -0500861
David Teigland8304d6f2011-02-21 14:58:21 -0600862 if (cb.flags & DLM_CB_CAST) {
David Teigland8304d6f2011-02-21 14:58:21 -0600863 new_mode = cb.mode;
864
865 if (!cb.sb_status && lkb->lkb_lksb->sb_lvbptr &&
866 dlm_lvb_operations[old_mode + 1][new_mode + 1])
867 copy_lvb = 1;
868
869 lkb->lkb_lksb->sb_status = cb.sb_status;
870 lkb->lkb_lksb->sb_flags = cb.sb_flags;
871 }
872
873 rv = copy_result_to_user(lkb->lkb_ua,
874 test_bit(DLM_PROC_FLAGS_COMPAT, &proc->flags),
875 cb.flags, cb.mode, copy_lvb, buf, count);
876
877 /* removes ref for proc->asts, may cause lkb to be freed */
878 if (!resid)
David Teigland597d0ca2006-07-12 16:44:04 -0500879 dlm_put_lkb(lkb);
880
David Teigland8304d6f2011-02-21 14:58:21 -0600881 return rv;
David Teigland597d0ca2006-07-12 16:44:04 -0500882}
883
884static unsigned int device_poll(struct file *file, poll_table *wait)
885{
886 struct dlm_user_proc *proc = file->private_data;
887
888 poll_wait(file, &proc->wait, wait);
889
890 spin_lock(&proc->asts_spin);
891 if (!list_empty(&proc->asts)) {
892 spin_unlock(&proc->asts_spin);
893 return POLLIN | POLLRDNORM;
894 }
895 spin_unlock(&proc->asts_spin);
896 return 0;
897}
898
David Teiglanddc68c7e2008-08-18 11:43:30 -0500899int dlm_user_daemon_available(void)
900{
901 /* dlm_controld hasn't started (or, has started, but not
902 properly populated configfs) */
903
904 if (!dlm_our_nodeid())
905 return 0;
906
907 /* This is to deal with versions of dlm_controld that don't
908 know about the monitor device. We assume that if the
909 dlm_controld was started (above), but the monitor device
910 was never opened, that it's an old version. dlm_controld
911 should open the monitor device before populating configfs. */
912
913 if (dlm_monitor_unused)
914 return 1;
915
916 return atomic_read(&dlm_monitor_opened) ? 1 : 0;
917}
918
David Teigland597d0ca2006-07-12 16:44:04 -0500919static int ctl_device_open(struct inode *inode, struct file *file)
920{
921 file->private_data = NULL;
922 return 0;
923}
924
925static int ctl_device_close(struct inode *inode, struct file *file)
926{
927 return 0;
928}
929
David Teiglanddc68c7e2008-08-18 11:43:30 -0500930static int monitor_device_open(struct inode *inode, struct file *file)
931{
932 atomic_inc(&dlm_monitor_opened);
933 dlm_monitor_unused = 0;
934 return 0;
935}
936
937static int monitor_device_close(struct inode *inode, struct file *file)
938{
939 if (atomic_dec_and_test(&dlm_monitor_opened))
940 dlm_stop_lockspaces();
941 return 0;
942}
943
Arjan van de Ven00977a52007-02-12 00:55:34 -0800944static const struct file_operations device_fops = {
David Teigland597d0ca2006-07-12 16:44:04 -0500945 .open = device_open,
946 .release = device_close,
947 .read = device_read,
948 .write = device_write,
949 .poll = device_poll,
950 .owner = THIS_MODULE,
Arnd Bergmann6038f372010-08-15 18:52:59 +0200951 .llseek = noop_llseek,
David Teigland597d0ca2006-07-12 16:44:04 -0500952};
953
Arjan van de Ven00977a52007-02-12 00:55:34 -0800954static const struct file_operations ctl_device_fops = {
David Teigland597d0ca2006-07-12 16:44:04 -0500955 .open = ctl_device_open,
956 .release = ctl_device_close,
David Teiglandd7db9232007-05-18 09:00:32 -0500957 .read = device_read,
David Teigland597d0ca2006-07-12 16:44:04 -0500958 .write = device_write,
959 .owner = THIS_MODULE,
Arnd Bergmann6038f372010-08-15 18:52:59 +0200960 .llseek = noop_llseek,
David Teigland597d0ca2006-07-12 16:44:04 -0500961};
962
Denis Cheng0fe410d2008-01-29 13:50:16 +0800963static struct miscdevice ctl_device = {
964 .name = "dlm-control",
965 .fops = &ctl_device_fops,
966 .minor = MISC_DYNAMIC_MINOR,
967};
968
David Teiglanddc68c7e2008-08-18 11:43:30 -0500969static const struct file_operations monitor_device_fops = {
970 .open = monitor_device_open,
971 .release = monitor_device_close,
972 .owner = THIS_MODULE,
Arnd Bergmann6038f372010-08-15 18:52:59 +0200973 .llseek = noop_llseek,
David Teiglanddc68c7e2008-08-18 11:43:30 -0500974};
975
976static struct miscdevice monitor_device = {
977 .name = "dlm-monitor",
978 .fops = &monitor_device_fops,
979 .minor = MISC_DYNAMIC_MINOR,
980};
981
Denis Cheng30727172008-02-02 01:53:46 +0800982int __init dlm_user_init(void)
David Teigland597d0ca2006-07-12 16:44:04 -0500983{
984 int error;
985
David Teiglanddc68c7e2008-08-18 11:43:30 -0500986 atomic_set(&dlm_monitor_opened, 0);
David Teigland597d0ca2006-07-12 16:44:04 -0500987
David Teiglanddc68c7e2008-08-18 11:43:30 -0500988 error = misc_register(&ctl_device);
989 if (error) {
990 log_print("misc_register failed for control device");
991 goto out;
992 }
993
994 error = misc_register(&monitor_device);
995 if (error) {
996 log_print("misc_register failed for monitor device");
997 misc_deregister(&ctl_device);
998 }
999 out:
David Teigland597d0ca2006-07-12 16:44:04 -05001000 return error;
1001}
1002
1003void dlm_user_exit(void)
1004{
1005 misc_deregister(&ctl_device);
David Teiglanddc68c7e2008-08-18 11:43:30 -05001006 misc_deregister(&monitor_device);
David Teigland597d0ca2006-07-12 16:44:04 -05001007}
1008