]> git.ipfire.org Git - thirdparty/kernel/linux.git/blame - fs/orangefs/devorangefs-req.c
License cleanup: add SPDX GPL-2.0 license identifier to files with no license
[thirdparty/kernel/linux.git] / fs / orangefs / devorangefs-req.c
CommitLineData
b2441318 1// SPDX-License-Identifier: GPL-2.0
5db11c21
MM
2/*
3 * (C) 2001 Clemson University and The University of Chicago
4 *
5 * Changes by Acxiom Corporation to add protocol version to kernel
6 * communication, Copyright Acxiom Corporation, 2005.
7 *
8 * See COPYING in top-level directory.
9 */
10
11#include "protocol.h"
575e9461
MM
12#include "orangefs-kernel.h"
13#include "orangefs-dev-proto.h"
14#include "orangefs-bufmap.h"
44f46410 15#include "orangefs-debugfs.h"
5db11c21
MM
16
17#include <linux/debugfs.h>
18#include <linux/slab.h>
19
20/* this file implements the /dev/pvfs2-req device node */
21
482664dd 22uint32_t orangefs_userspace_version;
f2ee3b75 23
5db11c21
MM
24static int open_access_count;
25
a0fe0515
MB
26static DEFINE_MUTEX(devreq_mutex);
27
5db11c21
MM
28#define DUMP_DEVICE_ERROR() \
29do { \
30 gossip_err("*****************************************************\n");\
8bb8aefd 31 gossip_err("ORANGEFS Device Error: You cannot open the device file "); \
5db11c21 32 gossip_err("\n/dev/%s more than once. Please make sure that\nthere " \
8bb8aefd 33 "are no ", ORANGEFS_REQDEVICE_NAME); \
5db11c21
MM
34 gossip_err("instances of a program using this device\ncurrently " \
35 "running. (You must verify this!)\n"); \
36 gossip_err("For example, you can use the lsof program as follows:\n");\
37 gossip_err("'lsof | grep %s' (run this as root)\n", \
8bb8aefd 38 ORANGEFS_REQDEVICE_NAME); \
5db11c21
MM
39 gossip_err(" open_access_count = %d\n", open_access_count); \
40 gossip_err("*****************************************************\n");\
41} while (0)
42
43static int hash_func(__u64 tag, int table_size)
44{
2c590d5f 45 return do_div(tag, (unsigned int)table_size);
5db11c21
MM
46}
47
8bb8aefd 48static void orangefs_devreq_add_op(struct orangefs_kernel_op_s *op)
5db11c21
MM
49{
50 int index = hash_func(op->tag, hash_table_size);
51
1d503617 52 list_add_tail(&op->list, &orangefs_htable_ops_in_progress[index]);
5db11c21
MM
53}
54
ca9f518e
MM
55/*
56 * find the op with this tag and remove it from the in progress
57 * hash table.
58 */
8bb8aefd 59static struct orangefs_kernel_op_s *orangefs_devreq_remove_op(__u64 tag)
5db11c21 60{
8bb8aefd 61 struct orangefs_kernel_op_s *op, *next;
5db11c21
MM
62 int index;
63
64 index = hash_func(tag, hash_table_size);
65
1d503617 66 spin_lock(&orangefs_htable_ops_in_progress_lock);
5db11c21
MM
67 list_for_each_entry_safe(op,
68 next,
1d503617 69 &orangefs_htable_ops_in_progress[index],
5db11c21 70 list) {
05a50a5b
AV
71 if (op->tag == tag && !op_state_purged(op) &&
72 !op_state_given_up(op)) {
ed42fe05 73 list_del_init(&op->list);
1d503617 74 spin_unlock(&orangefs_htable_ops_in_progress_lock);
5db11c21
MM
75 return op;
76 }
77 }
78
1d503617 79 spin_unlock(&orangefs_htable_ops_in_progress_lock);
5db11c21
MM
80 return NULL;
81}
82
acfcbaf1
MB
83/* Returns whether any FS are still pending remounted */
84static int mark_all_pending_mounts(void)
85{
86 int unmounted = 1;
87 struct orangefs_sb_info_s *orangefs_sb = NULL;
88
89 spin_lock(&orangefs_superblocks_lock);
90 list_for_each_entry(orangefs_sb, &orangefs_superblocks, list) {
91 /* All of these file system require a remount */
92 orangefs_sb->mount_pending = 1;
93 unmounted = 0;
94 }
95 spin_unlock(&orangefs_superblocks_lock);
96 return unmounted;
97}
98
99/*
100 * Determine if a given file system needs to be remounted or not
101 * Returns -1 on error
102 * 0 if already mounted
103 * 1 if needs remount
104 */
105static int fs_mount_pending(__s32 fsid)
106{
107 int mount_pending = -1;
108 struct orangefs_sb_info_s *orangefs_sb = NULL;
109
110 spin_lock(&orangefs_superblocks_lock);
111 list_for_each_entry(orangefs_sb, &orangefs_superblocks, list) {
112 if (orangefs_sb->fs_id == fsid) {
113 mount_pending = orangefs_sb->mount_pending;
114 break;
115 }
116 }
117 spin_unlock(&orangefs_superblocks_lock);
118 return mount_pending;
119}
120
8bb8aefd 121static int orangefs_devreq_open(struct inode *inode, struct file *file)
5db11c21
MM
122{
123 int ret = -EINVAL;
124
78fee0b6
JH
125 /* in order to ensure that the filesystem driver sees correct UIDs */
126 if (file->f_cred->user_ns != &init_user_ns) {
127 gossip_err("%s: device cannot be opened outside init_user_ns\n",
128 __func__);
129 goto out;
130 }
131
5db11c21 132 if (!(file->f_flags & O_NONBLOCK)) {
97f10027
MM
133 gossip_err("%s: device cannot be opened in blocking mode\n",
134 __func__);
5db11c21
MM
135 goto out;
136 }
137 ret = -EACCES;
97f10027 138 gossip_debug(GOSSIP_DEV_DEBUG, "client-core: opening device\n");
5db11c21
MM
139 mutex_lock(&devreq_mutex);
140
141 if (open_access_count == 0) {
fee25ce1 142 open_access_count = 1;
fb6d2526 143 ret = 0;
5db11c21
MM
144 } else {
145 DUMP_DEVICE_ERROR();
146 }
147 mutex_unlock(&devreq_mutex);
148
149out:
150
151 gossip_debug(GOSSIP_DEV_DEBUG,
152 "pvfs2-client-core: open device complete (ret = %d)\n",
153 ret);
154 return ret;
155}
156
97f10027 157/* Function for read() callers into the device */
8bb8aefd 158static ssize_t orangefs_devreq_read(struct file *file,
5db11c21
MM
159 char __user *buf,
160 size_t count, loff_t *offset)
161{
8bb8aefd
YL
162 struct orangefs_kernel_op_s *op, *temp;
163 __s32 proto_ver = ORANGEFS_KERNEL_PROTO_VERSION;
164 static __s32 magic = ORANGEFS_DEVREQ_MAGIC;
165 struct orangefs_kernel_op_s *cur_op = NULL;
24c8d080 166 unsigned long ret;
5db11c21 167
24c8d080 168 /* We do not support blocking IO. */
5db11c21 169 if (!(file->f_flags & O_NONBLOCK)) {
97f10027
MM
170 gossip_err("%s: blocking read from client-core.\n",
171 __func__);
5db11c21 172 return -EINVAL;
24c8d080
MB
173 }
174
175 /*
a762ae6d 176 * The client will do an ioctl to find MAX_DEV_REQ_UPSIZE, then
24c8d080
MB
177 * always read with that size buffer.
178 */
a762ae6d 179 if (count != MAX_DEV_REQ_UPSIZE) {
24c8d080
MB
180 gossip_err("orangefs: client-core tried to read wrong size\n");
181 return -EINVAL;
182 }
183
b7a57cca
MB
184 /* Check for an empty list before locking. */
185 if (list_empty(&orangefs_request_list))
186 return -EAGAIN;
187
ed42fe05 188restart:
24c8d080 189 /* Get next op (if any) from top of list. */
8bb8aefd
YL
190 spin_lock(&orangefs_request_list_lock);
191 list_for_each_entry_safe(op, temp, &orangefs_request_list, list) {
24c8d080
MB
192 __s32 fsid;
193 /* This lock is held past the end of the loop when we break. */
194 spin_lock(&op->lock);
05a50a5b 195 if (unlikely(op_state_purged(op) || op_state_given_up(op))) {
ed42fe05
AV
196 spin_unlock(&op->lock);
197 continue;
198 }
24c8d080
MB
199
200 fsid = fsid_of_op(op);
8bb8aefd 201 if (fsid != ORANGEFS_FS_ID_NULL) {
24c8d080
MB
202 int ret;
203 /* Skip ops whose filesystem needs to be mounted. */
204 ret = fs_mount_pending(fsid);
205 if (ret == 1) {
5db11c21 206 gossip_debug(GOSSIP_DEV_DEBUG,
5090c967
MM
207 "%s: mount pending, skipping op tag "
208 "%llu %s\n",
209 __func__,
210 llu(op->tag),
211 get_opname_string(op));
24c8d080
MB
212 spin_unlock(&op->lock);
213 continue;
97f10027
MM
214 /*
215 * Skip ops whose filesystem we don't know about unless
1ec1688c
MB
216 * it is being mounted or unmounted. It is possible for
217 * a filesystem we don't know about to be unmounted if
218 * it fails to mount in the kernel after userspace has
219 * been sent the mount request.
97f10027 220 */
24c8d080
MB
221 /* XXX: is there a better way to detect this? */
222 } else if (ret == -1 &&
97f10027
MM
223 !(op->upcall.type ==
224 ORANGEFS_VFS_OP_FS_MOUNT ||
225 op->upcall.type ==
1ec1688c
MB
226 ORANGEFS_VFS_OP_GETATTR ||
227 op->upcall.type ==
228 ORANGEFS_VFS_OP_FS_UMOUNT)) {
24c8d080
MB
229 gossip_debug(GOSSIP_DEV_DEBUG,
230 "orangefs: skipping op tag %llu %s\n",
231 llu(op->tag), get_opname_string(op));
232 gossip_err(
233 "orangefs: ERROR: fs_mount_pending %d\n",
234 fsid);
235 spin_unlock(&op->lock);
5db11c21 236 continue;
5db11c21
MM
237 }
238 }
24c8d080
MB
239 /*
240 * Either this op does not pertain to a filesystem, is mounting
241 * a filesystem, or pertains to a mounted filesystem. Let it
242 * through.
243 */
244 cur_op = op;
245 break;
246 }
247
248 /*
249 * At this point we either have a valid op and can continue or have not
250 * found an op and must ask the client to try again later.
251 */
252 if (!cur_op) {
8bb8aefd 253 spin_unlock(&orangefs_request_list_lock);
24c8d080 254 return -EAGAIN;
5db11c21
MM
255 }
256
ca9f518e
MM
257 gossip_debug(GOSSIP_DEV_DEBUG, "%s: reading op tag %llu %s\n",
258 __func__,
259 llu(cur_op->tag),
260 get_opname_string(cur_op));
5db11c21 261
24c8d080
MB
262 /*
263 * Such an op should never be on the list in the first place. If so, we
264 * will abort.
265 */
266 if (op_state_in_progress(cur_op) || op_state_serviced(cur_op)) {
267 gossip_err("orangefs: ERROR: Current op already queued.\n");
05a50a5b 268 list_del_init(&cur_op->list);
5db11c21 269 spin_unlock(&cur_op->lock);
8bb8aefd 270 spin_unlock(&orangefs_request_list_lock);
24c8d080 271 return -EAGAIN;
5db11c21 272 }
ca9f518e 273
ed42fe05 274 list_del_init(&cur_op->list);
8bb8aefd 275 spin_unlock(&orangefs_request_list_lock);
ed42fe05 276
24c8d080
MB
277 spin_unlock(&cur_op->lock);
278
279 /* Push the upcall out. */
280 ret = copy_to_user(buf, &proto_ver, sizeof(__s32));
281 if (ret != 0)
282 goto error;
283 ret = copy_to_user(buf+sizeof(__s32), &magic, sizeof(__s32));
284 if (ret != 0)
285 goto error;
286 ret = copy_to_user(buf+2 * sizeof(__s32), &cur_op->tag, sizeof(__u64));
287 if (ret != 0)
288 goto error;
289 ret = copy_to_user(buf+2*sizeof(__s32)+sizeof(__u64), &cur_op->upcall,
8bb8aefd 290 sizeof(struct orangefs_upcall_s));
24c8d080
MB
291 if (ret != 0)
292 goto error;
293
1d503617 294 spin_lock(&orangefs_htable_ops_in_progress_lock);
ed42fe05
AV
295 spin_lock(&cur_op->lock);
296 if (unlikely(op_state_given_up(cur_op))) {
297 spin_unlock(&cur_op->lock);
1d503617 298 spin_unlock(&orangefs_htable_ops_in_progress_lock);
05a50a5b 299 complete(&cur_op->waitq);
ed42fe05
AV
300 goto restart;
301 }
302
303 /*
304 * Set the operation to be in progress and move it between lists since
305 * it has been sent to the client.
306 */
307 set_op_state_inprogress(cur_op);
9d9e7ba9
MM
308 gossip_debug(GOSSIP_DEV_DEBUG,
309 "%s: 1 op:%s: op_state:%d: process:%s:\n",
310 __func__,
311 get_opname_string(cur_op),
312 cur_op->op_state,
313 current->comm);
ed42fe05
AV
314 orangefs_devreq_add_op(cur_op);
315 spin_unlock(&cur_op->lock);
1d503617 316 spin_unlock(&orangefs_htable_ops_in_progress_lock);
ed42fe05 317
24c8d080 318 /* The client only asks to read one size buffer. */
a762ae6d 319 return MAX_DEV_REQ_UPSIZE;
24c8d080
MB
320error:
321 /*
322 * We were unable to copy the op data to the client. Put the op back in
323 * list. If client has crashed, the op will be purged later when the
324 * device is released.
325 */
326 gossip_err("orangefs: Failed to copy data to user space\n");
8bb8aefd 327 spin_lock(&orangefs_request_list_lock);
24c8d080 328 spin_lock(&cur_op->lock);
ed42fe05
AV
329 if (likely(!op_state_given_up(cur_op))) {
330 set_op_state_waiting(cur_op);
9d9e7ba9
MM
331 gossip_debug(GOSSIP_DEV_DEBUG,
332 "%s: 2 op:%s: op_state:%d: process:%s:\n",
333 __func__,
334 get_opname_string(cur_op),
335 cur_op->op_state,
336 current->comm);
ed42fe05 337 list_add(&cur_op->list, &orangefs_request_list);
05a50a5b
AV
338 spin_unlock(&cur_op->lock);
339 } else {
340 spin_unlock(&cur_op->lock);
341 complete(&cur_op->waitq);
ed42fe05 342 }
8bb8aefd 343 spin_unlock(&orangefs_request_list_lock);
24c8d080 344 return -EFAULT;
5db11c21
MM
345}
346
97f10027 347/*
b3ae4755
MM
348 * Function for writev() callers into the device.
349 *
350 * Userspace should have written:
351 * - __u32 version
352 * - __u32 magic
353 * - __u64 tag
354 * - struct orangefs_downcall_s
355 * - trailer buffer (in the case of READDIR operations)
97f10027 356 */
b3ae4755
MM
357static ssize_t orangefs_devreq_write_iter(struct kiocb *iocb,
358 struct iov_iter *iter)
5db11c21 359{
b3ae4755 360 ssize_t ret;
8bb8aefd 361 struct orangefs_kernel_op_s *op = NULL;
b3ae4755
MM
362 struct {
363 __u32 version;
364 __u32 magic;
365 __u64 tag;
366 } head;
367 int total = ret = iov_iter_count(iter);
b3ae4755
MM
368 int downcall_size = sizeof(struct orangefs_downcall_s);
369 int head_size = sizeof(head);
370
371 gossip_debug(GOSSIP_DEV_DEBUG, "%s: total:%d: ret:%zd:\n",
372 __func__,
373 total,
374 ret);
5db11c21 375
b3ae4755 376 if (total < MAX_DEV_REQ_DOWNSIZE) {
cf0c2771 377 gossip_err("%s: total:%d: must be at least:%u:\n",
b3ae4755
MM
378 __func__,
379 total,
cf0c2771 380 (unsigned int) MAX_DEV_REQ_DOWNSIZE);
ed42fe05 381 return -EFAULT;
5db11c21 382 }
b3ae4755 383
cbbd26b8 384 if (!copy_from_iter_full(&head, head_size, iter)) {
b3ae4755 385 gossip_err("%s: failed to copy head.\n", __func__);
ed42fe05 386 return -EFAULT;
97f10027 387 }
b3ae4755
MM
388
389 if (head.version < ORANGEFS_MINIMUM_USERSPACE_VERSION) {
390 gossip_err("%s: userspace claims version"
391 "%d, minimum version required: %d.\n",
392 __func__,
393 head.version,
394 ORANGEFS_MINIMUM_USERSPACE_VERSION);
ed42fe05 395 return -EPROTO;
5db11c21 396 }
5db11c21 397
b3ae4755
MM
398 if (head.magic != ORANGEFS_DEVREQ_MAGIC) {
399 gossip_err("Error: Device magic number does not match.\n");
ed42fe05 400 return -EPROTO;
b3ae4755 401 }
5db11c21 402
482664dd
MB
403 if (!orangefs_userspace_version) {
404 orangefs_userspace_version = head.version;
405 } else if (orangefs_userspace_version != head.version) {
f2ee3b75
MB
406 gossip_err("Error: userspace version changes\n");
407 return -EPROTO;
408 }
409
ca9f518e 410 /* remove the op from the in progress hash table */
b3ae4755
MM
411 op = orangefs_devreq_remove_op(head.tag);
412 if (!op) {
05973c2e
MM
413 gossip_debug(GOSSIP_DEV_DEBUG,
414 "%s: No one's waiting for tag %llu\n",
415 __func__, llu(head.tag));
ed42fe05 416 return ret;
b3ae4755 417 }
5db11c21 418
cbbd26b8 419 if (!copy_from_iter_full(&op->downcall, downcall_size, iter)) {
b3ae4755 420 gossip_err("%s: failed to copy downcall.\n", __func__);
5964c1b8 421 goto Efault;
5db11c21
MM
422 }
423
b3ae4755
MM
424 if (op->downcall.status)
425 goto wakeup;
97f10027 426
b3ae4755
MM
427 /*
428 * We've successfully peeled off the head and the downcall.
429 * Something has gone awry if total doesn't equal the
430 * sum of head_size, downcall_size and trailer_size.
431 */
432 if ((head_size + downcall_size + op->downcall.trailer_size) != total) {
433 gossip_err("%s: funky write, head_size:%d"
434 ": downcall_size:%d: trailer_size:%lld"
435 ": total size:%d:\n",
436 __func__,
437 head_size,
438 downcall_size,
439 op->downcall.trailer_size,
440 total);
5964c1b8 441 goto Efault;
b3ae4755 442 }
97f10027 443
b3ae4755
MM
444 /* Only READDIR operations should have trailers. */
445 if ((op->downcall.type != ORANGEFS_VFS_OP_READDIR) &&
446 (op->downcall.trailer_size != 0)) {
447 gossip_err("%s: %x operation with trailer.",
448 __func__,
449 op->downcall.type);
5964c1b8 450 goto Efault;
b3ae4755 451 }
97f10027 452
b3ae4755
MM
453 /* READDIR operations should always have trailers. */
454 if ((op->downcall.type == ORANGEFS_VFS_OP_READDIR) &&
455 (op->downcall.trailer_size == 0)) {
456 gossip_err("%s: %x operation with no trailer.",
457 __func__,
458 op->downcall.type);
5964c1b8 459 goto Efault;
b3ae4755 460 }
97f10027 461
b3ae4755
MM
462 if (op->downcall.type != ORANGEFS_VFS_OP_READDIR)
463 goto wakeup;
5db11c21 464
07a25853
ME
465 op->downcall.trailer_buf = vmalloc(op->downcall.trailer_size);
466 if (!op->downcall.trailer_buf)
5964c1b8 467 goto Enomem;
07a25853 468
b3ae4755 469 memset(op->downcall.trailer_buf, 0, op->downcall.trailer_size);
cbbd26b8
AV
470 if (!copy_from_iter_full(op->downcall.trailer_buf,
471 op->downcall.trailer_size, iter)) {
b3ae4755
MM
472 gossip_err("%s: failed to copy trailer.\n", __func__);
473 vfree(op->downcall.trailer_buf);
5964c1b8 474 goto Efault;
b3ae4755 475 }
97f10027 476
b3ae4755 477wakeup:
2a9e5c22 478 /*
9f08cfe9
MM
479 * Return to vfs waitqueue, and back to service_operation
480 * through wait_for_matching_downcall.
2a9e5c22
AV
481 */
482 spin_lock(&op->lock);
5964c1b8 483 if (unlikely(op_is_cancel(op))) {
2a9e5c22 484 spin_unlock(&op->lock);
78699e29 485 put_cancel(op);
5964c1b8
AV
486 } else if (unlikely(op_state_given_up(op))) {
487 spin_unlock(&op->lock);
05a50a5b 488 complete(&op->waitq);
5964c1b8
AV
489 } else {
490 set_op_state_serviced(op);
9d9e7ba9
MM
491 gossip_debug(GOSSIP_DEV_DEBUG,
492 "%s: op:%s: op_state:%d: process:%s:\n",
493 __func__,
494 get_opname_string(op),
495 op->op_state,
496 current->comm);
5964c1b8
AV
497 spin_unlock(&op->lock);
498 }
b3ae4755 499 return ret;
ed42fe05 500
5964c1b8
AV
501Efault:
502 op->downcall.status = -(ORANGEFS_ERROR_BIT | 9);
503 ret = -EFAULT;
504 goto wakeup;
505
506Enomem:
507 op->downcall.status = -(ORANGEFS_ERROR_BIT | 8);
508 ret = -ENOMEM;
509 goto wakeup;
5db11c21
MM
510}
511
5db11c21
MM
512/*
513 * NOTE: gets called when the last reference to this device is dropped.
514 * Using the open_access_count variable, we enforce a reference count
515 * on this file so that it can be opened by only one process at a time.
516 * the devreq_mutex is used to make sure all i/o has completed
8bb8aefd 517 * before we call orangefs_bufmap_finalize, and similar such tricky
5db11c21
MM
518 * situations
519 */
8bb8aefd 520static int orangefs_devreq_release(struct inode *inode, struct file *file)
5db11c21
MM
521{
522 int unmounted = 0;
523
524 gossip_debug(GOSSIP_DEV_DEBUG,
525 "%s:pvfs2-client-core: exiting, closing device\n",
526 __func__);
527
528 mutex_lock(&devreq_mutex);
ea2c9c9f 529 orangefs_bufmap_finalize();
5db11c21 530
fee25ce1 531 open_access_count = -1;
5db11c21
MM
532
533 unmounted = mark_all_pending_mounts();
8bb8aefd 534 gossip_debug(GOSSIP_DEV_DEBUG, "ORANGEFS Device Close: Filesystem(s) %s\n",
5db11c21 535 (unmounted ? "UNMOUNTED" : "MOUNTED"));
5db11c21 536
5db11c21 537 purge_waiting_ops();
5db11c21 538 purge_inprogress_ops();
ea2c9c9f
AV
539
540 orangefs_bufmap_run_down();
541
5db11c21
MM
542 gossip_debug(GOSSIP_DEV_DEBUG,
543 "pvfs2-client-core: device close complete\n");
fee25ce1 544 open_access_count = 0;
482664dd 545 orangefs_userspace_version = 0;
fee25ce1 546 mutex_unlock(&devreq_mutex);
5db11c21
MM
547 return 0;
548}
549
550int is_daemon_in_service(void)
551{
552 int in_service;
553
554 /*
555 * What this function does is checks if client-core is alive
556 * based on the access count we maintain on the device.
557 */
558 mutex_lock(&devreq_mutex);
559 in_service = open_access_count == 1 ? 0 : -EIO;
560 mutex_unlock(&devreq_mutex);
561 return in_service;
562}
563
78699e29
AV
564bool __is_daemon_in_service(void)
565{
566 return open_access_count == 1;
567}
568
5db11c21
MM
569static inline long check_ioctl_command(unsigned int command)
570{
571 /* Check for valid ioctl codes */
8bb8aefd 572 if (_IOC_TYPE(command) != ORANGEFS_DEV_MAGIC) {
5db11c21
MM
573 gossip_err("device ioctl magic numbers don't match! Did you rebuild pvfs2-client-core/libpvfs2? [cmd %x, magic %x != %x]\n",
574 command,
575 _IOC_TYPE(command),
8bb8aefd 576 ORANGEFS_DEV_MAGIC);
5db11c21
MM
577 return -EINVAL;
578 }
579 /* and valid ioctl commands */
8bb8aefd 580 if (_IOC_NR(command) >= ORANGEFS_DEV_MAXNR || _IOC_NR(command) <= 0) {
5db11c21 581 gossip_err("Invalid ioctl command number [%d >= %d]\n",
8bb8aefd 582 _IOC_NR(command), ORANGEFS_DEV_MAXNR);
5db11c21
MM
583 return -ENOIOCTLCMD;
584 }
585 return 0;
586}
587
588static long dispatch_ioctl_command(unsigned int command, unsigned long arg)
589{
8bb8aefd 590 static __s32 magic = ORANGEFS_DEVREQ_MAGIC;
a762ae6d
MB
591 static __s32 max_up_size = MAX_DEV_REQ_UPSIZE;
592 static __s32 max_down_size = MAX_DEV_REQ_DOWNSIZE;
8bb8aefd 593 struct ORANGEFS_dev_map_desc user_desc;
5db11c21 594 int ret = 0;
5db11c21 595 int upstream_kmod = 1;
45996492 596 struct orangefs_sb_info_s *orangefs_sb;
5db11c21
MM
597
598 /* mtmoore: add locking here */
599
600 switch (command) {
8bb8aefd 601 case ORANGEFS_DEV_GET_MAGIC:
5db11c21
MM
602 return ((put_user(magic, (__s32 __user *) arg) == -EFAULT) ?
603 -EIO :
604 0);
8bb8aefd 605 case ORANGEFS_DEV_GET_MAX_UPSIZE:
5db11c21
MM
606 return ((put_user(max_up_size,
607 (__s32 __user *) arg) == -EFAULT) ?
608 -EIO :
609 0);
8bb8aefd 610 case ORANGEFS_DEV_GET_MAX_DOWNSIZE:
5db11c21
MM
611 return ((put_user(max_down_size,
612 (__s32 __user *) arg) == -EFAULT) ?
613 -EIO :
614 0);
8bb8aefd 615 case ORANGEFS_DEV_MAP:
5db11c21 616 ret = copy_from_user(&user_desc,
8bb8aefd 617 (struct ORANGEFS_dev_map_desc __user *)
5db11c21 618 arg,
8bb8aefd 619 sizeof(struct ORANGEFS_dev_map_desc));
ea2c9c9f
AV
620 /* WTF -EIO and not -EFAULT? */
621 return ret ? -EIO : orangefs_bufmap_initialize(&user_desc);
8bb8aefd 622 case ORANGEFS_DEV_REMOUNT_ALL:
5db11c21 623 gossip_debug(GOSSIP_DEV_DEBUG,
97f10027
MM
624 "%s: got ORANGEFS_DEV_REMOUNT_ALL\n",
625 __func__);
5db11c21
MM
626
627 /*
8bb8aefd 628 * remount all mounted orangefs volumes to regain the lost
5db11c21
MM
629 * dynamic mount tables (if any) -- NOTE: this is done
630 * without keeping the superblock list locked due to the
adcf34a2 631 * upcall/downcall waiting. also, the request mutex is
5db11c21
MM
632 * used to ensure that no operations will be serviced until
633 * all of the remounts are serviced (to avoid ops between
634 * mounts to fail)
635 */
1d503617 636 ret = mutex_lock_interruptible(&orangefs_request_mutex);
5db11c21
MM
637 if (ret < 0)
638 return ret;
639 gossip_debug(GOSSIP_DEV_DEBUG,
97f10027
MM
640 "%s: priority remount in progress\n",
641 __func__);
45996492
AV
642 spin_lock(&orangefs_superblocks_lock);
643 list_for_each_entry(orangefs_sb, &orangefs_superblocks, list) {
644 /*
645 * We have to drop the spinlock, so entries can be
646 * removed. They can't be freed, though, so we just
647 * keep the forward pointers and zero the back ones -
648 * that way we can get to the rest of the list.
649 */
650 if (!orangefs_sb->list.prev)
651 continue;
652 gossip_debug(GOSSIP_DEV_DEBUG,
653 "%s: Remounting SB %p\n",
654 __func__,
655 orangefs_sb);
656
657 spin_unlock(&orangefs_superblocks_lock);
658 ret = orangefs_remount(orangefs_sb);
659 spin_lock(&orangefs_superblocks_lock);
660 if (ret) {
5db11c21 661 gossip_debug(GOSSIP_DEV_DEBUG,
45996492 662 "SB %p remount failed\n",
8bb8aefd 663 orangefs_sb);
45996492 664 break;
5db11c21
MM
665 }
666 }
45996492 667 spin_unlock(&orangefs_superblocks_lock);
5db11c21 668 gossip_debug(GOSSIP_DEV_DEBUG,
97f10027
MM
669 "%s: priority remount complete\n",
670 __func__);
1d503617 671 mutex_unlock(&orangefs_request_mutex);
5db11c21
MM
672 return ret;
673
8bb8aefd 674 case ORANGEFS_DEV_UPSTREAM:
5db11c21
MM
675 ret = copy_to_user((void __user *)arg,
676 &upstream_kmod,
677 sizeof(upstream_kmod));
678
679 if (ret != 0)
680 return -EIO;
681 else
682 return ret;
683
8bb8aefd 684 case ORANGEFS_DEV_CLIENT_MASK:
44f46410 685 return orangefs_debugfs_new_client_mask((void __user *)arg);
8bb8aefd 686 case ORANGEFS_DEV_CLIENT_STRING:
44f46410 687 return orangefs_debugfs_new_client_string((void __user *)arg);
8bb8aefd 688 case ORANGEFS_DEV_DEBUG:
44f46410 689 return orangefs_debugfs_new_debug((void __user *)arg);
5db11c21
MM
690 default:
691 return -ENOIOCTLCMD;
692 }
693 return -ENOIOCTLCMD;
694}
695
8bb8aefd 696static long orangefs_devreq_ioctl(struct file *file,
5db11c21
MM
697 unsigned int command, unsigned long arg)
698{
699 long ret;
700
701 /* Check for properly constructed commands */
702 ret = check_ioctl_command(command);
703 if (ret < 0)
704 return (int)ret;
705
706 return (int)dispatch_ioctl_command(command, arg);
707}
708
709#ifdef CONFIG_COMPAT /* CONFIG_COMPAT is in .config */
710
8bb8aefd
YL
711/* Compat structure for the ORANGEFS_DEV_MAP ioctl */
712struct ORANGEFS_dev_map_desc32 {
5db11c21
MM
713 compat_uptr_t ptr;
714 __s32 total_size;
715 __s32 size;
716 __s32 count;
717};
718
719static unsigned long translate_dev_map26(unsigned long args, long *error)
720{
8bb8aefd 721 struct ORANGEFS_dev_map_desc32 __user *p32 = (void __user *)args;
5db11c21
MM
722 /*
723 * Depending on the architecture, allocate some space on the
724 * user-call-stack based on our expected layout.
725 */
8bb8aefd 726 struct ORANGEFS_dev_map_desc __user *p =
5db11c21 727 compat_alloc_user_space(sizeof(*p));
84d02150 728 compat_uptr_t addr;
5db11c21
MM
729
730 *error = 0;
731 /* get the ptr from the 32 bit user-space */
732 if (get_user(addr, &p32->ptr))
733 goto err;
734 /* try to put that into a 64-bit layout */
735 if (put_user(compat_ptr(addr), &p->ptr))
736 goto err;
737 /* copy the remaining fields */
738 if (copy_in_user(&p->total_size, &p32->total_size, sizeof(__s32)))
739 goto err;
740 if (copy_in_user(&p->size, &p32->size, sizeof(__s32)))
741 goto err;
742 if (copy_in_user(&p->count, &p32->count, sizeof(__s32)))
743 goto err;
744 return (unsigned long)p;
745err:
746 *error = -EFAULT;
747 return 0;
748}
749
750/*
751 * 32 bit user-space apps' ioctl handlers when kernel modules
752 * is compiled as a 64 bit one
753 */
8bb8aefd 754static long orangefs_devreq_compat_ioctl(struct file *filp, unsigned int cmd,
5db11c21
MM
755 unsigned long args)
756{
757 long ret;
758 unsigned long arg = args;
759
760 /* Check for properly constructed commands */
761 ret = check_ioctl_command(cmd);
762 if (ret < 0)
763 return ret;
8bb8aefd 764 if (cmd == ORANGEFS_DEV_MAP) {
5db11c21
MM
765 /*
766 * convert the arguments to what we expect internally
767 * in kernel space
768 */
769 arg = translate_dev_map26(args, &ret);
770 if (ret < 0) {
771 gossip_err("Could not translate dev map\n");
772 return ret;
773 }
774 }
775 /* no other ioctl requires translation */
776 return dispatch_ioctl_command(cmd, arg);
777}
778
2c590d5f
MM
779#endif /* CONFIG_COMPAT is in .config */
780
5db11c21 781/* the assigned character device major number */
8bb8aefd 782static int orangefs_dev_major;
5db11c21
MM
783
784/*
8bb8aefd 785 * Initialize orangefs device specific state:
5db11c21
MM
786 * Must be called at module load time only
787 */
8bb8aefd 788int orangefs_dev_init(void)
5db11c21 789{
8bb8aefd
YL
790 /* register orangefs-req device */
791 orangefs_dev_major = register_chrdev(0,
792 ORANGEFS_REQDEVICE_NAME,
793 &orangefs_devreq_file_operations);
794 if (orangefs_dev_major < 0) {
5db11c21
MM
795 gossip_debug(GOSSIP_DEV_DEBUG,
796 "Failed to register /dev/%s (error %d)\n",
8bb8aefd 797 ORANGEFS_REQDEVICE_NAME, orangefs_dev_major);
8bb8aefd 798 return orangefs_dev_major;
5db11c21
MM
799 }
800
801 gossip_debug(GOSSIP_DEV_DEBUG,
802 "*** /dev/%s character device registered ***\n",
8bb8aefd 803 ORANGEFS_REQDEVICE_NAME);
5db11c21 804 gossip_debug(GOSSIP_DEV_DEBUG, "'mknod /dev/%s c %d 0'.\n",
8bb8aefd 805 ORANGEFS_REQDEVICE_NAME, orangefs_dev_major);
5db11c21
MM
806 return 0;
807}
808
8bb8aefd 809void orangefs_dev_cleanup(void)
5db11c21 810{
8bb8aefd 811 unregister_chrdev(orangefs_dev_major, ORANGEFS_REQDEVICE_NAME);
5db11c21
MM
812 gossip_debug(GOSSIP_DEV_DEBUG,
813 "*** /dev/%s character device unregistered ***\n",
8bb8aefd 814 ORANGEFS_REQDEVICE_NAME);
5db11c21
MM
815}
816
8bb8aefd 817static unsigned int orangefs_devreq_poll(struct file *file,
5db11c21
MM
818 struct poll_table_struct *poll_table)
819{
820 int poll_revent_mask = 0;
821
83595db0 822 poll_wait(file, &orangefs_request_list_waitq, poll_table);
5db11c21 823
83595db0
AV
824 if (!list_empty(&orangefs_request_list))
825 poll_revent_mask |= POLL_IN;
5db11c21
MM
826 return poll_revent_mask;
827}
828
8bb8aefd 829const struct file_operations orangefs_devreq_file_operations = {
5db11c21 830 .owner = THIS_MODULE,
8bb8aefd
YL
831 .read = orangefs_devreq_read,
832 .write_iter = orangefs_devreq_write_iter,
833 .open = orangefs_devreq_open,
834 .release = orangefs_devreq_release,
835 .unlocked_ioctl = orangefs_devreq_ioctl,
5db11c21
MM
836
837#ifdef CONFIG_COMPAT /* CONFIG_COMPAT is in .config */
8bb8aefd 838 .compat_ioctl = orangefs_devreq_compat_ioctl,
5db11c21 839#endif
8bb8aefd 840 .poll = orangefs_devreq_poll
5db11c21 841};