blob: 142e21655eed76e2479404d592f5596c4b745f37 [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;
241 int error = -ENOMEM;
242
243 ls = dlm_find_lockspace_local(proc->lockspace);
244 if (!ls)
245 return -ENOENT;
246
247 if (!params->castaddr || !params->lksb) {
248 error = -EINVAL;
249 goto out;
250 }
251
David Teigland573c24c2009-11-30 16:34:43 -0600252 ua = kzalloc(sizeof(struct dlm_user_args), GFP_NOFS);
David Teigland597d0ca2006-07-12 16:44:04 -0500253 if (!ua)
254 goto out;
255 ua->proc = proc;
256 ua->user_lksb = params->lksb;
257 ua->castparam = params->castparam;
258 ua->castaddr = params->castaddr;
259 ua->bastparam = params->bastparam;
260 ua->bastaddr = params->bastaddr;
David Teiglandd7db9232007-05-18 09:00:32 -0500261 ua->xid = params->xid;
David Teigland597d0ca2006-07-12 16:44:04 -0500262
263 if (params->flags & DLM_LKF_CONVERT)
264 error = dlm_user_convert(ls, ua,
265 params->mode, params->flags,
David Teiglandd7db9232007-05-18 09:00:32 -0500266 params->lkid, params->lvb,
267 (unsigned long) params->timeout);
David Teigland597d0ca2006-07-12 16:44:04 -0500268 else {
269 error = dlm_user_request(ls, ua,
270 params->mode, params->flags,
271 params->name, params->namelen,
David Teiglandd7db9232007-05-18 09:00:32 -0500272 (unsigned long) params->timeout);
David Teigland597d0ca2006-07-12 16:44:04 -0500273 if (!error)
274 error = ua->lksb.sb_lkid;
275 }
276 out:
277 dlm_put_lockspace(ls);
278 return error;
279}
280
281static int device_user_unlock(struct dlm_user_proc *proc,
282 struct dlm_lock_params *params)
283{
284 struct dlm_ls *ls;
285 struct dlm_user_args *ua;
286 int error = -ENOMEM;
287
288 ls = dlm_find_lockspace_local(proc->lockspace);
289 if (!ls)
290 return -ENOENT;
291
David Teigland573c24c2009-11-30 16:34:43 -0600292 ua = kzalloc(sizeof(struct dlm_user_args), GFP_NOFS);
David Teigland597d0ca2006-07-12 16:44:04 -0500293 if (!ua)
294 goto out;
295 ua->proc = proc;
296 ua->user_lksb = params->lksb;
297 ua->castparam = params->castparam;
298 ua->castaddr = params->castaddr;
299
300 if (params->flags & DLM_LKF_CANCEL)
301 error = dlm_user_cancel(ls, ua, params->flags, params->lkid);
302 else
303 error = dlm_user_unlock(ls, ua, params->flags, params->lkid,
304 params->lvb);
305 out:
306 dlm_put_lockspace(ls);
307 return error;
308}
309
David Teigland8b4021f2007-05-29 08:46:00 -0500310static int device_user_deadlock(struct dlm_user_proc *proc,
311 struct dlm_lock_params *params)
312{
313 struct dlm_ls *ls;
314 int error;
315
316 ls = dlm_find_lockspace_local(proc->lockspace);
317 if (!ls)
318 return -ENOENT;
319
320 error = dlm_user_deadlock(ls, params->flags, params->lkid);
321
322 dlm_put_lockspace(ls);
323 return error;
324}
325
David Teigland0f8e0d92008-08-06 13:30:24 -0500326static int dlm_device_register(struct dlm_ls *ls, char *name)
Patrick Caulfield254da032007-03-21 09:23:53 +0000327{
328 int error, len;
329
David Teigland0f8e0d92008-08-06 13:30:24 -0500330 /* The device is already registered. This happens when the
331 lockspace is created multiple times from userspace. */
332 if (ls->ls_device.name)
333 return 0;
334
Patrick Caulfield254da032007-03-21 09:23:53 +0000335 error = -ENOMEM;
336 len = strlen(name) + strlen(name_prefix) + 2;
David Teigland573c24c2009-11-30 16:34:43 -0600337 ls->ls_device.name = kzalloc(len, GFP_NOFS);
Patrick Caulfield254da032007-03-21 09:23:53 +0000338 if (!ls->ls_device.name)
339 goto fail;
340
341 snprintf((char *)ls->ls_device.name, len, "%s_%s", name_prefix,
342 name);
343 ls->ls_device.fops = &device_fops;
344 ls->ls_device.minor = MISC_DYNAMIC_MINOR;
345
346 error = misc_register(&ls->ls_device);
347 if (error) {
348 kfree(ls->ls_device.name);
349 }
350fail:
351 return error;
352}
353
David Teigland0f8e0d92008-08-06 13:30:24 -0500354int dlm_device_deregister(struct dlm_ls *ls)
355{
356 int error;
357
358 /* The device is not registered. This happens when the lockspace
359 was never used from userspace, or when device_create_lockspace()
360 calls dlm_release_lockspace() after the register fails. */
361 if (!ls->ls_device.name)
362 return 0;
363
364 error = misc_deregister(&ls->ls_device);
365 if (!error)
366 kfree(ls->ls_device.name);
367 return error;
368}
369
David Teigland72c2be72007-03-30 15:06:16 -0500370static int device_user_purge(struct dlm_user_proc *proc,
371 struct dlm_purge_params *params)
372{
373 struct dlm_ls *ls;
374 int error;
375
376 ls = dlm_find_lockspace_local(proc->lockspace);
377 if (!ls)
378 return -ENOENT;
379
380 error = dlm_user_purge(ls, proc, params->nodeid, params->pid);
381
382 dlm_put_lockspace(ls);
383 return error;
384}
385
David Teigland597d0ca2006-07-12 16:44:04 -0500386static int device_create_lockspace(struct dlm_lspace_params *params)
387{
388 dlm_lockspace_t *lockspace;
389 struct dlm_ls *ls;
Patrick Caulfield254da032007-03-21 09:23:53 +0000390 int error;
David Teigland597d0ca2006-07-12 16:44:04 -0500391
392 if (!capable(CAP_SYS_ADMIN))
393 return -EPERM;
394
David Teigland60f98d12011-11-02 14:30:58 -0500395 error = dlm_new_lockspace(params->name, NULL, params->flags,
396 DLM_USER_LVB_LEN, NULL, NULL, NULL,
397 &lockspace);
David Teigland597d0ca2006-07-12 16:44:04 -0500398 if (error)
399 return error;
400
401 ls = dlm_find_lockspace_local(lockspace);
402 if (!ls)
403 return -ENOENT;
404
David Teigland0f8e0d92008-08-06 13:30:24 -0500405 error = dlm_device_register(ls, params->name);
David Teigland597d0ca2006-07-12 16:44:04 -0500406 dlm_put_lockspace(ls);
David Teigland597d0ca2006-07-12 16:44:04 -0500407
Patrick Caulfield254da032007-03-21 09:23:53 +0000408 if (error)
409 dlm_release_lockspace(lockspace, 0);
410 else
411 error = ls->ls_device.minor;
412
David Teigland597d0ca2006-07-12 16:44:04 -0500413 return error;
414}
415
416static int device_remove_lockspace(struct dlm_lspace_params *params)
417{
418 dlm_lockspace_t *lockspace;
419 struct dlm_ls *ls;
David Teiglandc6e6f0b2006-08-30 10:50:18 -0500420 int error, force = 0;
David Teigland597d0ca2006-07-12 16:44:04 -0500421
422 if (!capable(CAP_SYS_ADMIN))
423 return -EPERM;
424
425 ls = dlm_find_lockspace_device(params->minor);
426 if (!ls)
427 return -ENOENT;
428
David Teiglandc6e6f0b2006-08-30 10:50:18 -0500429 if (params->flags & DLM_USER_LSFLG_FORCEFREE)
430 force = 2;
431
David Teigland597d0ca2006-07-12 16:44:04 -0500432 lockspace = ls->ls_local_handle;
David Teigland597d0ca2006-07-12 16:44:04 -0500433 dlm_put_lockspace(ls);
David Teigland0f8e0d92008-08-06 13:30:24 -0500434
435 /* The final dlm_release_lockspace waits for references to go to
436 zero, so all processes will need to close their device for the
437 ls before the release will proceed. release also calls the
438 device_deregister above. Converting a positive return value
439 from release to zero means that userspace won't know when its
440 release was the final one, but it shouldn't need to know. */
441
David Teiglandc6e6f0b2006-08-30 10:50:18 -0500442 error = dlm_release_lockspace(lockspace, force);
David Teigland0f8e0d92008-08-06 13:30:24 -0500443 if (error > 0)
444 error = 0;
David Teigland597d0ca2006-07-12 16:44:04 -0500445 return error;
446}
447
448/* Check the user's version matches ours */
449static int check_version(struct dlm_write_request *req)
450{
451 if (req->version[0] != DLM_DEVICE_VERSION_MAJOR ||
452 (req->version[0] == DLM_DEVICE_VERSION_MAJOR &&
453 req->version[1] > DLM_DEVICE_VERSION_MINOR)) {
454
455 printk(KERN_DEBUG "dlm: process %s (%d) version mismatch "
456 "user (%d.%d.%d) kernel (%d.%d.%d)\n",
457 current->comm,
Pavel Emelyanovba25f9d2007-10-18 23:40:40 -0700458 task_pid_nr(current),
David Teigland597d0ca2006-07-12 16:44:04 -0500459 req->version[0],
460 req->version[1],
461 req->version[2],
462 DLM_DEVICE_VERSION_MAJOR,
463 DLM_DEVICE_VERSION_MINOR,
464 DLM_DEVICE_VERSION_PATCH);
465 return -EINVAL;
466 }
467 return 0;
468}
469
470/*
471 * device_write
472 *
473 * device_user_lock
474 * dlm_user_request -> request_lock
475 * dlm_user_convert -> convert_lock
476 *
477 * device_user_unlock
478 * dlm_user_unlock -> unlock_lock
479 * dlm_user_cancel -> cancel_lock
480 *
481 * device_create_lockspace
482 * dlm_new_lockspace
483 *
484 * device_remove_lockspace
485 * dlm_release_lockspace
486 */
487
488/* a write to a lockspace device is a lock or unlock request, a write
489 to the control device is to create/remove a lockspace */
490
491static ssize_t device_write(struct file *file, const char __user *buf,
492 size_t count, loff_t *ppos)
493{
494 struct dlm_user_proc *proc = file->private_data;
495 struct dlm_write_request *kbuf;
David Teigland597d0ca2006-07-12 16:44:04 -0500496 int error;
497
498#ifdef CONFIG_COMPAT
499 if (count < sizeof(struct dlm_write_request32))
500#else
501 if (count < sizeof(struct dlm_write_request))
502#endif
503 return -EINVAL;
504
David Teiglandd4b0bcf2013-02-04 15:31:22 -0600505 /*
506 * can't compare against COMPAT/dlm_write_request32 because
507 * we don't yet know if is64bit is zero
508 */
Sasha Levin2b75bc92012-09-09 16:16:58 +0200509 if (count > sizeof(struct dlm_write_request) + DLM_RESNAME_MAXLEN)
Sasha Levin2b75bc92012-09-09 16:16:58 +0200510 return -EINVAL;
511
David Teigland573c24c2009-11-30 16:34:43 -0600512 kbuf = kzalloc(count + 1, GFP_NOFS);
David Teigland597d0ca2006-07-12 16:44:04 -0500513 if (!kbuf)
514 return -ENOMEM;
515
516 if (copy_from_user(kbuf, buf, count)) {
517 error = -EFAULT;
518 goto out_free;
519 }
520
521 if (check_version(kbuf)) {
522 error = -EBADE;
523 goto out_free;
524 }
525
526#ifdef CONFIG_COMPAT
527 if (!kbuf->is64bit) {
528 struct dlm_write_request32 *k32buf;
David Teigland1fecb1c2009-03-04 11:17:23 -0600529 int namelen = 0;
530
531 if (count > sizeof(struct dlm_write_request32))
532 namelen = count - sizeof(struct dlm_write_request32);
533
David Teigland597d0ca2006-07-12 16:44:04 -0500534 k32buf = (struct dlm_write_request32 *)kbuf;
David Teigland1fecb1c2009-03-04 11:17:23 -0600535
536 /* add 1 after namelen so that the name string is terminated */
537 kbuf = kzalloc(sizeof(struct dlm_write_request) + namelen + 1,
David Teigland573c24c2009-11-30 16:34:43 -0600538 GFP_NOFS);
David Teiglandcb980d92008-07-29 15:21:19 -0500539 if (!kbuf) {
540 kfree(k32buf);
David Teigland597d0ca2006-07-12 16:44:04 -0500541 return -ENOMEM;
David Teiglandcb980d92008-07-29 15:21:19 -0500542 }
David Teigland597d0ca2006-07-12 16:44:04 -0500543
544 if (proc)
545 set_bit(DLM_PROC_FLAGS_COMPAT, &proc->flags);
David Teigland1fecb1c2009-03-04 11:17:23 -0600546
547 compat_input(kbuf, k32buf, namelen);
David Teigland597d0ca2006-07-12 16:44:04 -0500548 kfree(k32buf);
549 }
550#endif
551
552 /* do we really need this? can a write happen after a close? */
553 if ((kbuf->cmd == DLM_USER_LOCK || kbuf->cmd == DLM_USER_UNLOCK) &&
David Teiglandcb980d92008-07-29 15:21:19 -0500554 (proc && test_bit(DLM_PROC_FLAGS_CLOSING, &proc->flags))) {
555 error = -EINVAL;
556 goto out_free;
557 }
David Teigland597d0ca2006-07-12 16:44:04 -0500558
David Teigland597d0ca2006-07-12 16:44:04 -0500559 error = -EINVAL;
560
561 switch (kbuf->cmd)
562 {
563 case DLM_USER_LOCK:
564 if (!proc) {
565 log_print("no locking on control device");
David Teiglandc6ca7bc2013-08-12 15:22:43 -0500566 goto out_free;
David Teigland597d0ca2006-07-12 16:44:04 -0500567 }
568 error = device_user_lock(proc, &kbuf->i.lock);
569 break;
570
571 case DLM_USER_UNLOCK:
572 if (!proc) {
573 log_print("no locking on control device");
David Teiglandc6ca7bc2013-08-12 15:22:43 -0500574 goto out_free;
David Teigland597d0ca2006-07-12 16:44:04 -0500575 }
576 error = device_user_unlock(proc, &kbuf->i.lock);
577 break;
578
David Teigland8b4021f2007-05-29 08:46:00 -0500579 case DLM_USER_DEADLOCK:
580 if (!proc) {
581 log_print("no locking on control device");
David Teiglandc6ca7bc2013-08-12 15:22:43 -0500582 goto out_free;
David Teigland8b4021f2007-05-29 08:46:00 -0500583 }
584 error = device_user_deadlock(proc, &kbuf->i.lock);
585 break;
586
David Teigland597d0ca2006-07-12 16:44:04 -0500587 case DLM_USER_CREATE_LOCKSPACE:
588 if (proc) {
589 log_print("create/remove only on control device");
David Teiglandc6ca7bc2013-08-12 15:22:43 -0500590 goto out_free;
David Teigland597d0ca2006-07-12 16:44:04 -0500591 }
592 error = device_create_lockspace(&kbuf->i.lspace);
593 break;
594
595 case DLM_USER_REMOVE_LOCKSPACE:
596 if (proc) {
597 log_print("create/remove only on control device");
David Teiglandc6ca7bc2013-08-12 15:22:43 -0500598 goto out_free;
David Teigland597d0ca2006-07-12 16:44:04 -0500599 }
600 error = device_remove_lockspace(&kbuf->i.lspace);
601 break;
602
David Teigland72c2be72007-03-30 15:06:16 -0500603 case DLM_USER_PURGE:
604 if (!proc) {
605 log_print("no locking on control device");
David Teiglandc6ca7bc2013-08-12 15:22:43 -0500606 goto out_free;
David Teigland72c2be72007-03-30 15:06:16 -0500607 }
608 error = device_user_purge(proc, &kbuf->i.purge);
609 break;
610
David Teigland597d0ca2006-07-12 16:44:04 -0500611 default:
612 log_print("Unknown command passed to DLM device : %d\n",
613 kbuf->cmd);
614 }
615
David Teigland597d0ca2006-07-12 16:44:04 -0500616 out_free:
617 kfree(kbuf);
618 return error;
619}
620
621/* Every process that opens the lockspace device has its own "proc" structure
622 hanging off the open file that's used to keep track of locks owned by the
623 process and asts that need to be delivered to the process. */
624
625static int device_open(struct inode *inode, struct file *file)
626{
627 struct dlm_user_proc *proc;
628 struct dlm_ls *ls;
629
630 ls = dlm_find_lockspace_device(iminor(inode));
David Teiglandf9f2ed42008-09-04 12:51:20 -0500631 if (!ls)
David Teigland597d0ca2006-07-12 16:44:04 -0500632 return -ENOENT;
633
David Teigland573c24c2009-11-30 16:34:43 -0600634 proc = kzalloc(sizeof(struct dlm_user_proc), GFP_NOFS);
David Teigland597d0ca2006-07-12 16:44:04 -0500635 if (!proc) {
636 dlm_put_lockspace(ls);
637 return -ENOMEM;
638 }
639
640 proc->lockspace = ls->ls_local_handle;
641 INIT_LIST_HEAD(&proc->asts);
642 INIT_LIST_HEAD(&proc->locks);
David Teiglanda1bc86e2007-01-15 10:34:52 -0600643 INIT_LIST_HEAD(&proc->unlocking);
David Teigland597d0ca2006-07-12 16:44:04 -0500644 spin_lock_init(&proc->asts_spin);
645 spin_lock_init(&proc->locks_spin);
646 init_waitqueue_head(&proc->wait);
647 file->private_data = proc;
648
649 return 0;
650}
651
652static int device_close(struct inode *inode, struct file *file)
653{
654 struct dlm_user_proc *proc = file->private_data;
655 struct dlm_ls *ls;
David Teigland597d0ca2006-07-12 16:44:04 -0500656
657 ls = dlm_find_lockspace_local(proc->lockspace);
658 if (!ls)
659 return -ENOENT;
660
David Teigland597d0ca2006-07-12 16:44:04 -0500661 set_bit(DLM_PROC_FLAGS_CLOSING, &proc->flags);
662
663 dlm_clear_proc_locks(ls, proc);
664
665 /* at this point no more lkb's should exist for this lockspace,
666 so there's no chance of dlm_user_add_ast() being called and
667 looking for lkb->ua->proc */
668
669 kfree(proc);
670 file->private_data = NULL;
671
672 dlm_put_lockspace(ls);
673 dlm_put_lockspace(ls); /* for the find in device_open() */
674
675 /* FIXME: AUTOFREE: if this ls is no longer used do
676 device_remove_lockspace() */
677
David Teigland597d0ca2006-07-12 16:44:04 -0500678 return 0;
679}
680
David Teigland8304d6f2011-02-21 14:58:21 -0600681static int copy_result_to_user(struct dlm_user_args *ua, int compat,
682 uint32_t flags, int mode, int copy_lvb,
683 char __user *buf, size_t count)
David Teigland597d0ca2006-07-12 16:44:04 -0500684{
685#ifdef CONFIG_COMPAT
686 struct dlm_lock_result32 result32;
687#endif
688 struct dlm_lock_result result;
689 void *resultptr;
690 int error=0;
691 int len;
692 int struct_len;
693
694 memset(&result, 0, sizeof(struct dlm_lock_result));
David Teiglandd7db9232007-05-18 09:00:32 -0500695 result.version[0] = DLM_DEVICE_VERSION_MAJOR;
696 result.version[1] = DLM_DEVICE_VERSION_MINOR;
697 result.version[2] = DLM_DEVICE_VERSION_PATCH;
David Teigland597d0ca2006-07-12 16:44:04 -0500698 memcpy(&result.lksb, &ua->lksb, sizeof(struct dlm_lksb));
699 result.user_lksb = ua->user_lksb;
700
701 /* FIXME: dlm1 provides for the user's bastparam/addr to not be updated
702 in a conversion unless the conversion is successful. See code
703 in dlm_user_convert() for updating ua from ua_tmp. OpenVMS, though,
704 notes that a new blocking AST address and parameter are set even if
705 the conversion fails, so maybe we should just do that. */
706
David Teigland8304d6f2011-02-21 14:58:21 -0600707 if (flags & DLM_CB_BAST) {
David Teigland597d0ca2006-07-12 16:44:04 -0500708 result.user_astaddr = ua->bastaddr;
709 result.user_astparam = ua->bastparam;
David Teigland89d799d2010-03-25 14:23:13 -0500710 result.bast_mode = mode;
David Teigland597d0ca2006-07-12 16:44:04 -0500711 } else {
712 result.user_astaddr = ua->castaddr;
713 result.user_astparam = ua->castparam;
714 }
715
716#ifdef CONFIG_COMPAT
717 if (compat)
718 len = sizeof(struct dlm_lock_result32);
719 else
720#endif
721 len = sizeof(struct dlm_lock_result);
722 struct_len = len;
723
724 /* copy lvb to userspace if there is one, it's been updated, and
725 the user buffer has space for it */
726
David Teigland8304d6f2011-02-21 14:58:21 -0600727 if (copy_lvb && ua->lksb.sb_lvbptr && count >= len + DLM_USER_LVB_LEN) {
David Teigland597d0ca2006-07-12 16:44:04 -0500728 if (copy_to_user(buf+len, ua->lksb.sb_lvbptr,
729 DLM_USER_LVB_LEN)) {
730 error = -EFAULT;
731 goto out;
732 }
733
734 result.lvb_offset = len;
735 len += DLM_USER_LVB_LEN;
736 }
737
738 result.length = len;
739 resultptr = &result;
740#ifdef CONFIG_COMPAT
741 if (compat) {
742 compat_output(&result, &result32);
743 resultptr = &result32;
744 }
745#endif
746
747 if (copy_to_user(buf, resultptr, struct_len))
748 error = -EFAULT;
749 else
750 error = len;
751 out:
752 return error;
753}
754
David Teiglandd7db9232007-05-18 09:00:32 -0500755static int copy_version_to_user(char __user *buf, size_t count)
756{
757 struct dlm_device_version ver;
758
759 memset(&ver, 0, sizeof(struct dlm_device_version));
760 ver.version[0] = DLM_DEVICE_VERSION_MAJOR;
761 ver.version[1] = DLM_DEVICE_VERSION_MINOR;
762 ver.version[2] = DLM_DEVICE_VERSION_PATCH;
763
764 if (copy_to_user(buf, &ver, sizeof(struct dlm_device_version)))
765 return -EFAULT;
766 return sizeof(struct dlm_device_version);
767}
768
David Teigland597d0ca2006-07-12 16:44:04 -0500769/* a read returns a single ast described in a struct dlm_lock_result */
770
771static ssize_t device_read(struct file *file, char __user *buf, size_t count,
772 loff_t *ppos)
773{
774 struct dlm_user_proc *proc = file->private_data;
775 struct dlm_lkb *lkb;
David Teigland597d0ca2006-07-12 16:44:04 -0500776 DECLARE_WAITQUEUE(wait, current);
David Teigland8304d6f2011-02-21 14:58:21 -0600777 struct dlm_callback cb;
778 int rv, resid, copy_lvb = 0;
David Teigland597d0ca2006-07-12 16:44:04 -0500779
David Teiglandd7db9232007-05-18 09:00:32 -0500780 if (count == sizeof(struct dlm_device_version)) {
David Teigland8304d6f2011-02-21 14:58:21 -0600781 rv = copy_version_to_user(buf, count);
782 return rv;
David Teiglandd7db9232007-05-18 09:00:32 -0500783 }
784
785 if (!proc) {
786 log_print("non-version read from control device %zu", count);
787 return -EINVAL;
788 }
789
David Teigland597d0ca2006-07-12 16:44:04 -0500790#ifdef CONFIG_COMPAT
791 if (count < sizeof(struct dlm_lock_result32))
792#else
793 if (count < sizeof(struct dlm_lock_result))
794#endif
795 return -EINVAL;
796
David Teigland89d799d2010-03-25 14:23:13 -0500797 try_another:
798
David Teigland597d0ca2006-07-12 16:44:04 -0500799 /* do we really need this? can a read happen after a close? */
800 if (test_bit(DLM_PROC_FLAGS_CLOSING, &proc->flags))
801 return -EINVAL;
802
803 spin_lock(&proc->asts_spin);
804 if (list_empty(&proc->asts)) {
805 if (file->f_flags & O_NONBLOCK) {
806 spin_unlock(&proc->asts_spin);
807 return -EAGAIN;
808 }
809
810 add_wait_queue(&proc->wait, &wait);
811
812 repeat:
813 set_current_state(TASK_INTERRUPTIBLE);
814 if (list_empty(&proc->asts) && !signal_pending(current)) {
815 spin_unlock(&proc->asts_spin);
816 schedule();
817 spin_lock(&proc->asts_spin);
818 goto repeat;
819 }
820 set_current_state(TASK_RUNNING);
821 remove_wait_queue(&proc->wait, &wait);
822
823 if (signal_pending(current)) {
824 spin_unlock(&proc->asts_spin);
825 return -ERESTARTSYS;
826 }
827 }
828
David Teigland8304d6f2011-02-21 14:58:21 -0600829 /* if we empty lkb_callbacks, we don't want to unlock the spinlock
David Teigland23e8e1a2011-04-05 13:16:24 -0500830 without removing lkb_cb_list; so empty lkb_cb_list is always
David Teigland8304d6f2011-02-21 14:58:21 -0600831 consistent with empty lkb_callbacks */
David Teigland597d0ca2006-07-12 16:44:04 -0500832
David Teigland23e8e1a2011-04-05 13:16:24 -0500833 lkb = list_entry(proc->asts.next, struct dlm_lkb, lkb_cb_list);
David Teigland597d0ca2006-07-12 16:44:04 -0500834
David Teigland8304d6f2011-02-21 14:58:21 -0600835 rv = dlm_rem_lkb_callback(lkb->lkb_resource->res_ls, lkb, &cb, &resid);
836 if (rv < 0) {
837 /* this shouldn't happen; lkb should have been removed from
838 list when resid was zero */
839 log_print("dlm_rem_lkb_callback empty %x", lkb->lkb_id);
David Teigland23e8e1a2011-04-05 13:16:24 -0500840 list_del_init(&lkb->lkb_cb_list);
David Teigland8304d6f2011-02-21 14:58:21 -0600841 spin_unlock(&proc->asts_spin);
842 /* removes ref for proc->asts, may cause lkb to be freed */
843 dlm_put_lkb(lkb);
844 goto try_another;
David Teigland89d799d2010-03-25 14:23:13 -0500845 }
David Teigland8304d6f2011-02-21 14:58:21 -0600846 if (!resid)
David Teigland23e8e1a2011-04-05 13:16:24 -0500847 list_del_init(&lkb->lkb_cb_list);
David Teigland597d0ca2006-07-12 16:44:04 -0500848 spin_unlock(&proc->asts_spin);
849
David Teigland8304d6f2011-02-21 14:58:21 -0600850 if (cb.flags & DLM_CB_SKIP) {
851 /* removes ref for proc->asts, may cause lkb to be freed */
852 if (!resid)
853 dlm_put_lkb(lkb);
854 goto try_another;
David Teigland89d799d2010-03-25 14:23:13 -0500855 }
David Teigland597d0ca2006-07-12 16:44:04 -0500856
David Teigland8304d6f2011-02-21 14:58:21 -0600857 if (cb.flags & DLM_CB_CAST) {
858 int old_mode, new_mode;
David Teigland89d799d2010-03-25 14:23:13 -0500859
David Teigland8304d6f2011-02-21 14:58:21 -0600860 old_mode = lkb->lkb_last_cast.mode;
861 new_mode = cb.mode;
862
863 if (!cb.sb_status && lkb->lkb_lksb->sb_lvbptr &&
864 dlm_lvb_operations[old_mode + 1][new_mode + 1])
865 copy_lvb = 1;
866
867 lkb->lkb_lksb->sb_status = cb.sb_status;
868 lkb->lkb_lksb->sb_flags = cb.sb_flags;
869 }
870
871 rv = copy_result_to_user(lkb->lkb_ua,
872 test_bit(DLM_PROC_FLAGS_COMPAT, &proc->flags),
873 cb.flags, cb.mode, copy_lvb, buf, count);
874
875 /* removes ref for proc->asts, may cause lkb to be freed */
876 if (!resid)
David Teigland597d0ca2006-07-12 16:44:04 -0500877 dlm_put_lkb(lkb);
878
David Teigland8304d6f2011-02-21 14:58:21 -0600879 return rv;
David Teigland597d0ca2006-07-12 16:44:04 -0500880}
881
882static unsigned int device_poll(struct file *file, poll_table *wait)
883{
884 struct dlm_user_proc *proc = file->private_data;
885
886 poll_wait(file, &proc->wait, wait);
887
888 spin_lock(&proc->asts_spin);
889 if (!list_empty(&proc->asts)) {
890 spin_unlock(&proc->asts_spin);
891 return POLLIN | POLLRDNORM;
892 }
893 spin_unlock(&proc->asts_spin);
894 return 0;
895}
896
David Teiglanddc68c7e2008-08-18 11:43:30 -0500897int dlm_user_daemon_available(void)
898{
899 /* dlm_controld hasn't started (or, has started, but not
900 properly populated configfs) */
901
902 if (!dlm_our_nodeid())
903 return 0;
904
905 /* This is to deal with versions of dlm_controld that don't
906 know about the monitor device. We assume that if the
907 dlm_controld was started (above), but the monitor device
908 was never opened, that it's an old version. dlm_controld
909 should open the monitor device before populating configfs. */
910
911 if (dlm_monitor_unused)
912 return 1;
913
914 return atomic_read(&dlm_monitor_opened) ? 1 : 0;
915}
916
David Teigland597d0ca2006-07-12 16:44:04 -0500917static int ctl_device_open(struct inode *inode, struct file *file)
918{
919 file->private_data = NULL;
920 return 0;
921}
922
923static int ctl_device_close(struct inode *inode, struct file *file)
924{
925 return 0;
926}
927
David Teiglanddc68c7e2008-08-18 11:43:30 -0500928static int monitor_device_open(struct inode *inode, struct file *file)
929{
930 atomic_inc(&dlm_monitor_opened);
931 dlm_monitor_unused = 0;
932 return 0;
933}
934
935static int monitor_device_close(struct inode *inode, struct file *file)
936{
937 if (atomic_dec_and_test(&dlm_monitor_opened))
938 dlm_stop_lockspaces();
939 return 0;
940}
941
Arjan van de Ven00977a52007-02-12 00:55:34 -0800942static const struct file_operations device_fops = {
David Teigland597d0ca2006-07-12 16:44:04 -0500943 .open = device_open,
944 .release = device_close,
945 .read = device_read,
946 .write = device_write,
947 .poll = device_poll,
948 .owner = THIS_MODULE,
Arnd Bergmann6038f372010-08-15 18:52:59 +0200949 .llseek = noop_llseek,
David Teigland597d0ca2006-07-12 16:44:04 -0500950};
951
Arjan van de Ven00977a52007-02-12 00:55:34 -0800952static const struct file_operations ctl_device_fops = {
David Teigland597d0ca2006-07-12 16:44:04 -0500953 .open = ctl_device_open,
954 .release = ctl_device_close,
David Teiglandd7db9232007-05-18 09:00:32 -0500955 .read = device_read,
David Teigland597d0ca2006-07-12 16:44:04 -0500956 .write = device_write,
957 .owner = THIS_MODULE,
Arnd Bergmann6038f372010-08-15 18:52:59 +0200958 .llseek = noop_llseek,
David Teigland597d0ca2006-07-12 16:44:04 -0500959};
960
Denis Cheng0fe410d2008-01-29 13:50:16 +0800961static struct miscdevice ctl_device = {
962 .name = "dlm-control",
963 .fops = &ctl_device_fops,
964 .minor = MISC_DYNAMIC_MINOR,
965};
966
David Teiglanddc68c7e2008-08-18 11:43:30 -0500967static const struct file_operations monitor_device_fops = {
968 .open = monitor_device_open,
969 .release = monitor_device_close,
970 .owner = THIS_MODULE,
Arnd Bergmann6038f372010-08-15 18:52:59 +0200971 .llseek = noop_llseek,
David Teiglanddc68c7e2008-08-18 11:43:30 -0500972};
973
974static struct miscdevice monitor_device = {
975 .name = "dlm-monitor",
976 .fops = &monitor_device_fops,
977 .minor = MISC_DYNAMIC_MINOR,
978};
979
Denis Cheng30727172008-02-02 01:53:46 +0800980int __init dlm_user_init(void)
David Teigland597d0ca2006-07-12 16:44:04 -0500981{
982 int error;
983
David Teiglanddc68c7e2008-08-18 11:43:30 -0500984 atomic_set(&dlm_monitor_opened, 0);
David Teigland597d0ca2006-07-12 16:44:04 -0500985
David Teiglanddc68c7e2008-08-18 11:43:30 -0500986 error = misc_register(&ctl_device);
987 if (error) {
988 log_print("misc_register failed for control device");
989 goto out;
990 }
991
992 error = misc_register(&monitor_device);
993 if (error) {
994 log_print("misc_register failed for monitor device");
995 misc_deregister(&ctl_device);
996 }
997 out:
David Teigland597d0ca2006-07-12 16:44:04 -0500998 return error;
999}
1000
1001void dlm_user_exit(void)
1002{
1003 misc_deregister(&ctl_device);
David Teiglanddc68c7e2008-08-18 11:43:30 -05001004 misc_deregister(&monitor_device);
David Teigland597d0ca2006-07-12 16:44:04 -05001005}
1006