devorangefs-req.c 22.7 KB
Newer Older
1
// SPDX-License-Identifier: GPL-2.0
M
Mike Marshall 已提交
2 3 4 5 6 7 8 9 10 11
/*
 * (C) 2001 Clemson University and The University of Chicago
 *
 * Changes by Acxiom Corporation to add protocol version to kernel
 * communication, Copyright Acxiom Corporation, 2005.
 *
 * See COPYING in top-level directory.
 */

#include "protocol.h"
12 13 14
#include "orangefs-kernel.h"
#include "orangefs-dev-proto.h"
#include "orangefs-bufmap.h"
15
#include "orangefs-debugfs.h"
M
Mike Marshall 已提交
16 17 18 19 20 21

#include <linux/debugfs.h>
#include <linux/slab.h>

/* this file implements the /dev/pvfs2-req device node */

M
Martin Brandenburg 已提交
22
uint32_t orangefs_userspace_version;
23

M
Mike Marshall 已提交
24 25
static int open_access_count;

26 27
static DEFINE_MUTEX(devreq_mutex);

M
Mike Marshall 已提交
28 29 30
#define DUMP_DEVICE_ERROR()                                                   \
do {                                                                          \
	gossip_err("*****************************************************\n");\
31
	gossip_err("ORANGEFS Device Error:  You cannot open the device file ");  \
M
Mike Marshall 已提交
32
	gossip_err("\n/dev/%s more than once.  Please make sure that\nthere " \
33
		   "are no ", ORANGEFS_REQDEVICE_NAME);                          \
M
Mike Marshall 已提交
34 35 36 37
	gossip_err("instances of a program using this device\ncurrently "     \
		   "running. (You must verify this!)\n");                     \
	gossip_err("For example, you can use the lsof program as follows:\n");\
	gossip_err("'lsof | grep %s' (run this as root)\n",                   \
38
		   ORANGEFS_REQDEVICE_NAME);                                     \
M
Mike Marshall 已提交
39 40 41 42 43 44
	gossip_err("  open_access_count = %d\n", open_access_count);          \
	gossip_err("*****************************************************\n");\
} while (0)

static int hash_func(__u64 tag, int table_size)
{
M
Mike Marshall 已提交
45
	return do_div(tag, (unsigned int)table_size);
M
Mike Marshall 已提交
46 47
}

48
static void orangefs_devreq_add_op(struct orangefs_kernel_op_s *op)
M
Mike Marshall 已提交
49 50 51
{
	int index = hash_func(op->tag, hash_table_size);

52
	list_add_tail(&op->list, &orangefs_htable_ops_in_progress[index]);
M
Mike Marshall 已提交
53 54
}

M
Mike Marshall 已提交
55 56 57 58
/*
 * find the op with this tag and remove it from the in progress
 * hash table.
 */
59
static struct orangefs_kernel_op_s *orangefs_devreq_remove_op(__u64 tag)
M
Mike Marshall 已提交
60
{
61
	struct orangefs_kernel_op_s *op, *next;
M
Mike Marshall 已提交
62 63 64 65
	int index;

	index = hash_func(tag, hash_table_size);

66
	spin_lock(&orangefs_htable_ops_in_progress_lock);
M
Mike Marshall 已提交
67 68
	list_for_each_entry_safe(op,
				 next,
69
				 &orangefs_htable_ops_in_progress[index],
M
Mike Marshall 已提交
70
				 list) {
71 72
		if (op->tag == tag && !op_state_purged(op) &&
		    !op_state_given_up(op)) {
73
			list_del_init(&op->list);
74
			spin_unlock(&orangefs_htable_ops_in_progress_lock);
M
Mike Marshall 已提交
75 76 77 78
			return op;
		}
	}

79
	spin_unlock(&orangefs_htable_ops_in_progress_lock);
M
Mike Marshall 已提交
80 81 82
	return NULL;
}

83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120
/* Returns whether any FS are still pending remounted */
static int mark_all_pending_mounts(void)
{
	int unmounted = 1;
	struct orangefs_sb_info_s *orangefs_sb = NULL;

	spin_lock(&orangefs_superblocks_lock);
	list_for_each_entry(orangefs_sb, &orangefs_superblocks, list) {
		/* All of these file system require a remount */
		orangefs_sb->mount_pending = 1;
		unmounted = 0;
	}
	spin_unlock(&orangefs_superblocks_lock);
	return unmounted;
}

/*
 * Determine if a given file system needs to be remounted or not
 *  Returns -1 on error
 *           0 if already mounted
 *           1 if needs remount
 */
static int fs_mount_pending(__s32 fsid)
{
	int mount_pending = -1;
	struct orangefs_sb_info_s *orangefs_sb = NULL;

	spin_lock(&orangefs_superblocks_lock);
	list_for_each_entry(orangefs_sb, &orangefs_superblocks, list) {
		if (orangefs_sb->fs_id == fsid) {
			mount_pending = orangefs_sb->mount_pending;
			break;
		}
	}
	spin_unlock(&orangefs_superblocks_lock);
	return mount_pending;
}

121
static int orangefs_devreq_open(struct inode *inode, struct file *file)
M
Mike Marshall 已提交
122 123 124
{
	int ret = -EINVAL;

J
Jann Horn 已提交
125 126 127 128 129 130 131
	/* in order to ensure that the filesystem driver sees correct UIDs */
	if (file->f_cred->user_ns != &init_user_ns) {
		gossip_err("%s: device cannot be opened outside init_user_ns\n",
			   __func__);
		goto out;
	}

M
Mike Marshall 已提交
132
	if (!(file->f_flags & O_NONBLOCK)) {
133 134
		gossip_err("%s: device cannot be opened in blocking mode\n",
			   __func__);
M
Mike Marshall 已提交
135 136 137
		goto out;
	}
	ret = -EACCES;
138
	gossip_debug(GOSSIP_DEV_DEBUG, "client-core: opening device\n");
M
Mike Marshall 已提交
139 140 141
	mutex_lock(&devreq_mutex);

	if (open_access_count == 0) {
142
		open_access_count = 1;
143
		ret = 0;
M
Mike Marshall 已提交
144 145 146 147 148 149 150 151 152 153 154 155 156
	} else {
		DUMP_DEVICE_ERROR();
	}
	mutex_unlock(&devreq_mutex);

out:

	gossip_debug(GOSSIP_DEV_DEBUG,
		     "pvfs2-client-core: open device complete (ret = %d)\n",
		     ret);
	return ret;
}

157
/* Function for read() callers into the device */
158
static ssize_t orangefs_devreq_read(struct file *file,
M
Mike Marshall 已提交
159 160 161
				 char __user *buf,
				 size_t count, loff_t *offset)
{
162 163 164 165
	struct orangefs_kernel_op_s *op, *temp;
	__s32 proto_ver = ORANGEFS_KERNEL_PROTO_VERSION;
	static __s32 magic = ORANGEFS_DEVREQ_MAGIC;
	struct orangefs_kernel_op_s *cur_op = NULL;
166
	unsigned long ret;
M
Mike Marshall 已提交
167

168
	/* We do not support blocking IO. */
M
Mike Marshall 已提交
169
	if (!(file->f_flags & O_NONBLOCK)) {
170 171
		gossip_err("%s: blocking read from client-core.\n",
			   __func__);
M
Mike Marshall 已提交
172
		return -EINVAL;
173 174 175
	}

	/*
176
	 * The client will do an ioctl to find MAX_DEV_REQ_UPSIZE, then
177 178
	 * always read with that size buffer.
	 */
179
	if (count != MAX_DEV_REQ_UPSIZE) {
180 181 182 183
		gossip_err("orangefs: client-core tried to read wrong size\n");
		return -EINVAL;
	}

184 185 186 187
	/* Check for an empty list before locking. */
	if (list_empty(&orangefs_request_list))
		return -EAGAIN;

188
restart:
189
	/* Get next op (if any) from top of list. */
190 191
	spin_lock(&orangefs_request_list_lock);
	list_for_each_entry_safe(op, temp, &orangefs_request_list, list) {
192 193 194
		__s32 fsid;
		/* This lock is held past the end of the loop when we break. */
		spin_lock(&op->lock);
195
		if (unlikely(op_state_purged(op) || op_state_given_up(op))) {
196 197 198
			spin_unlock(&op->lock);
			continue;
		}
199 200

		fsid = fsid_of_op(op);
201
		if (fsid != ORANGEFS_FS_ID_NULL) {
202 203 204 205
			int ret;
			/* Skip ops whose filesystem needs to be mounted. */
			ret = fs_mount_pending(fsid);
			if (ret == 1) {
M
Mike Marshall 已提交
206
				gossip_debug(GOSSIP_DEV_DEBUG,
207 208 209 210 211
				    "%s: mount pending, skipping op tag "
				    "%llu %s\n",
				    __func__,
				    llu(op->tag),
				    get_opname_string(op));
212 213
				spin_unlock(&op->lock);
				continue;
214 215
			/*
			 * Skip ops whose filesystem we don't know about unless
216 217 218 219
			 * it is being mounted or unmounted.  It is possible for
			 * a filesystem we don't know about to be unmounted if
			 * it fails to mount in the kernel after userspace has
			 * been sent the mount request.
220
			 */
221 222
			/* XXX: is there a better way to detect this? */
			} else if (ret == -1 &&
223 224 225
				   !(op->upcall.type ==
					ORANGEFS_VFS_OP_FS_MOUNT ||
				     op->upcall.type ==
226 227 228
					ORANGEFS_VFS_OP_GETATTR ||
				     op->upcall.type ==
					ORANGEFS_VFS_OP_FS_UMOUNT)) {
229 230 231 232 233 234 235
				gossip_debug(GOSSIP_DEV_DEBUG,
				    "orangefs: skipping op tag %llu %s\n",
				    llu(op->tag), get_opname_string(op));
				gossip_err(
				    "orangefs: ERROR: fs_mount_pending %d\n",
				    fsid);
				spin_unlock(&op->lock);
M
Mike Marshall 已提交
236 237 238
				continue;
			}
		}
239 240 241 242 243 244 245 246 247 248 249 250 251 252
		/*
		 * Either this op does not pertain to a filesystem, is mounting
		 * a filesystem, or pertains to a mounted filesystem. Let it
		 * through.
		 */
		cur_op = op;
		break;
	}

	/*
	 * At this point we either have a valid op and can continue or have not
	 * found an op and must ask the client to try again later.
	 */
	if (!cur_op) {
253
		spin_unlock(&orangefs_request_list_lock);
254
		return -EAGAIN;
M
Mike Marshall 已提交
255 256
	}

M
Mike Marshall 已提交
257 258 259 260
	gossip_debug(GOSSIP_DEV_DEBUG, "%s: reading op tag %llu %s\n",
		     __func__,
		     llu(cur_op->tag),
		     get_opname_string(cur_op));
M
Mike Marshall 已提交
261

262 263 264 265 266 267
	/*
	 * Such an op should never be on the list in the first place. If so, we
	 * will abort.
	 */
	if (op_state_in_progress(cur_op) || op_state_serviced(cur_op)) {
		gossip_err("orangefs: ERROR: Current op already queued.\n");
268
		list_del_init(&cur_op->list);
M
Mike Marshall 已提交
269
		spin_unlock(&cur_op->lock);
270
		spin_unlock(&orangefs_request_list_lock);
271
		return -EAGAIN;
M
Mike Marshall 已提交
272
	}
M
Mike Marshall 已提交
273

274
	list_del_init(&cur_op->list);
275
	spin_unlock(&orangefs_request_list_lock);
276

277 278 279 280 281 282 283 284 285 286 287 288 289
	spin_unlock(&cur_op->lock);

	/* Push the upcall out. */
	ret = copy_to_user(buf, &proto_ver, sizeof(__s32));
	if (ret != 0)
		goto error;
	ret = copy_to_user(buf+sizeof(__s32), &magic, sizeof(__s32));
	if (ret != 0)
		goto error;
	ret = copy_to_user(buf+2 * sizeof(__s32), &cur_op->tag, sizeof(__u64));
	if (ret != 0)
		goto error;
	ret = copy_to_user(buf+2*sizeof(__s32)+sizeof(__u64), &cur_op->upcall,
290
			   sizeof(struct orangefs_upcall_s));
291 292 293
	if (ret != 0)
		goto error;

294
	spin_lock(&orangefs_htable_ops_in_progress_lock);
295 296 297
	spin_lock(&cur_op->lock);
	if (unlikely(op_state_given_up(cur_op))) {
		spin_unlock(&cur_op->lock);
298
		spin_unlock(&orangefs_htable_ops_in_progress_lock);
299
		complete(&cur_op->waitq);
300 301 302 303 304 305 306 307
		goto restart;
	}

	/*
	 * Set the operation to be in progress and move it between lists since
	 * it has been sent to the client.
	 */
	set_op_state_inprogress(cur_op);
308 309 310 311 312 313
	gossip_debug(GOSSIP_DEV_DEBUG,
		     "%s: 1 op:%s: op_state:%d: process:%s:\n",
		     __func__,
		     get_opname_string(cur_op),
		     cur_op->op_state,
		     current->comm);
314 315
	orangefs_devreq_add_op(cur_op);
	spin_unlock(&cur_op->lock);
316
	spin_unlock(&orangefs_htable_ops_in_progress_lock);
317

318
	/* The client only asks to read one size buffer. */
319
	return MAX_DEV_REQ_UPSIZE;
320 321 322 323 324 325 326
error:
	/*
	 * We were unable to copy the op data to the client. Put the op back in
	 * list. If client has crashed, the op will be purged later when the
	 * device is released.
	 */
	gossip_err("orangefs: Failed to copy data to user space\n");
327
	spin_lock(&orangefs_request_list_lock);
328
	spin_lock(&cur_op->lock);
329 330
	if (likely(!op_state_given_up(cur_op))) {
		set_op_state_waiting(cur_op);
331 332 333 334 335 336
		gossip_debug(GOSSIP_DEV_DEBUG,
			     "%s: 2 op:%s: op_state:%d: process:%s:\n",
			     __func__,
			     get_opname_string(cur_op),
			     cur_op->op_state,
			     current->comm);
337
		list_add(&cur_op->list, &orangefs_request_list);
338 339 340 341
		spin_unlock(&cur_op->lock);
	} else {
		spin_unlock(&cur_op->lock);
		complete(&cur_op->waitq);
342
	}
343
	spin_unlock(&orangefs_request_list_lock);
344
	return -EFAULT;
M
Mike Marshall 已提交
345 346
}

347
/*
M
Mike Marshall 已提交
348 349 350 351 352 353 354 355
 * Function for writev() callers into the device.
 *
 * Userspace should have written:
 *  - __u32 version
 *  - __u32 magic
 *  - __u64 tag
 *  - struct orangefs_downcall_s
 *  - trailer buffer (in the case of READDIR operations)
356
 */
M
Mike Marshall 已提交
357 358
static ssize_t orangefs_devreq_write_iter(struct kiocb *iocb,
				      struct iov_iter *iter)
M
Mike Marshall 已提交
359
{
M
Mike Marshall 已提交
360
	ssize_t ret;
361
	struct orangefs_kernel_op_s *op = NULL;
M
Mike Marshall 已提交
362 363 364 365 366 367 368 369 370 371 372 373 374
	struct {
		__u32 version;
		__u32 magic;
		__u64 tag;
	} head;
	int total = ret = iov_iter_count(iter);
	int downcall_size = sizeof(struct orangefs_downcall_s);
	int head_size = sizeof(head);

	gossip_debug(GOSSIP_DEV_DEBUG, "%s: total:%d: ret:%zd:\n",
		     __func__,
		     total,
		     ret);
M
Mike Marshall 已提交
375

M
Mike Marshall 已提交
376
        if (total < MAX_DEV_REQ_DOWNSIZE) {
377
		gossip_err("%s: total:%d: must be at least:%u:\n",
M
Mike Marshall 已提交
378 379
			   __func__,
			   total,
380
			   (unsigned int) MAX_DEV_REQ_DOWNSIZE);
381
		return -EFAULT;
M
Mike Marshall 已提交
382
	}
M
Mike Marshall 已提交
383
     
384
	if (!copy_from_iter_full(&head, head_size, iter)) {
M
Mike Marshall 已提交
385
		gossip_err("%s: failed to copy head.\n", __func__);
386
		return -EFAULT;
387
	}
M
Mike Marshall 已提交
388 389 390 391 392 393 394

	if (head.version < ORANGEFS_MINIMUM_USERSPACE_VERSION) {
		gossip_err("%s: userspace claims version"
			   "%d, minimum version required: %d.\n",
			   __func__,
			   head.version,
			   ORANGEFS_MINIMUM_USERSPACE_VERSION);
395
		return -EPROTO;
M
Mike Marshall 已提交
396 397
	}

M
Mike Marshall 已提交
398 399
	if (head.magic != ORANGEFS_DEVREQ_MAGIC) {
		gossip_err("Error: Device magic number does not match.\n");
400
		return -EPROTO;
M
Mike Marshall 已提交
401
	}
M
Mike Marshall 已提交
402

M
Martin Brandenburg 已提交
403 404 405
	if (!orangefs_userspace_version) {
		orangefs_userspace_version = head.version;
	} else if (orangefs_userspace_version != head.version) {
406 407 408 409
		gossip_err("Error: userspace version changes\n");
		return -EPROTO;
	}

M
Mike Marshall 已提交
410
	/* remove the op from the in progress hash table */
M
Mike Marshall 已提交
411 412
	op = orangefs_devreq_remove_op(head.tag);
	if (!op) {
413 414 415
		gossip_debug(GOSSIP_DEV_DEBUG,
			     "%s: No one's waiting for tag %llu\n",
			     __func__, llu(head.tag));
416
		return ret;
M
Mike Marshall 已提交
417
	}
M
Mike Marshall 已提交
418

419
	if (!copy_from_iter_full(&op->downcall, downcall_size, iter)) {
M
Mike Marshall 已提交
420
		gossip_err("%s: failed to copy downcall.\n", __func__);
421
		goto Efault;
M
Mike Marshall 已提交
422 423
	}

M
Mike Marshall 已提交
424 425
	if (op->downcall.status)
		goto wakeup;
426

M
Mike Marshall 已提交
427 428 429 430 431 432 433 434 435 436 437 438 439 440
	/*
	 * We've successfully peeled off the head and the downcall. 
	 * Something has gone awry if total doesn't equal the
	 * sum of head_size, downcall_size and trailer_size.
	 */
	if ((head_size + downcall_size + op->downcall.trailer_size) != total) {
		gossip_err("%s: funky write, head_size:%d"
			   ": downcall_size:%d: trailer_size:%lld"
			   ": total size:%d:\n",
			   __func__,
			   head_size,
			   downcall_size,
			   op->downcall.trailer_size,
			   total);
441
		goto Efault;
M
Mike Marshall 已提交
442
	}
443

M
Mike Marshall 已提交
444 445 446 447 448 449
	/* Only READDIR operations should have trailers. */
	if ((op->downcall.type != ORANGEFS_VFS_OP_READDIR) &&
	    (op->downcall.trailer_size != 0)) {
		gossip_err("%s: %x operation with trailer.",
			   __func__,
			   op->downcall.type);
450
		goto Efault;
M
Mike Marshall 已提交
451
	}
452

M
Mike Marshall 已提交
453 454 455 456 457 458
	/* READDIR operations should always have trailers. */
	if ((op->downcall.type == ORANGEFS_VFS_OP_READDIR) &&
	    (op->downcall.trailer_size == 0)) {
		gossip_err("%s: %x operation with no trailer.",
			   __func__,
			   op->downcall.type);
459
		goto Efault;
M
Mike Marshall 已提交
460
	}
461

M
Mike Marshall 已提交
462 463
	if (op->downcall.type != ORANGEFS_VFS_OP_READDIR)
		goto wakeup;
M
Mike Marshall 已提交
464

465 466
	op->downcall.trailer_buf = vmalloc(op->downcall.trailer_size);
	if (!op->downcall.trailer_buf)
467
		goto Enomem;
468

M
Mike Marshall 已提交
469
	memset(op->downcall.trailer_buf, 0, op->downcall.trailer_size);
470 471
	if (!copy_from_iter_full(op->downcall.trailer_buf,
			         op->downcall.trailer_size, iter)) {
M
Mike Marshall 已提交
472 473
		gossip_err("%s: failed to copy trailer.\n", __func__);
		vfree(op->downcall.trailer_buf);
474
		goto Efault;
M
Mike Marshall 已提交
475
	}
476

M
Mike Marshall 已提交
477
wakeup:
478
	/*
M
Mike Marshall 已提交
479 480
	 * Return to vfs waitqueue, and back to service_operation
	 * through wait_for_matching_downcall. 
481 482
	 */
	spin_lock(&op->lock);
483
	if (unlikely(op_is_cancel(op))) {
484
		spin_unlock(&op->lock);
485
		put_cancel(op);
486 487
	} else if (unlikely(op_state_given_up(op))) {
		spin_unlock(&op->lock);
488
		complete(&op->waitq);
489 490
	} else {
		set_op_state_serviced(op);
491 492 493 494 495 496
		gossip_debug(GOSSIP_DEV_DEBUG,
			     "%s: op:%s: op_state:%d: process:%s:\n",
			     __func__,
			     get_opname_string(op),
			     op->op_state,
			     current->comm);
497 498
		spin_unlock(&op->lock);
	}
M
Mike Marshall 已提交
499
	return ret;
500

501 502 503 504 505 506 507 508 509
Efault:
	op->downcall.status = -(ORANGEFS_ERROR_BIT | 9);
	ret = -EFAULT;
	goto wakeup;

Enomem:
	op->downcall.status = -(ORANGEFS_ERROR_BIT | 8);
	ret = -ENOMEM;
	goto wakeup;
M
Mike Marshall 已提交
510 511 512 513 514 515 516
}

/*
 * NOTE: gets called when the last reference to this device is dropped.
 * Using the open_access_count variable, we enforce a reference count
 * on this file so that it can be opened by only one process at a time.
 * the devreq_mutex is used to make sure all i/o has completed
517
 * before we call orangefs_bufmap_finalize, and similar such tricky
M
Mike Marshall 已提交
518 519
 * situations
 */
520
static int orangefs_devreq_release(struct inode *inode, struct file *file)
M
Mike Marshall 已提交
521 522 523 524 525 526 527 528
{
	int unmounted = 0;

	gossip_debug(GOSSIP_DEV_DEBUG,
		     "%s:pvfs2-client-core: exiting, closing device\n",
		     __func__);

	mutex_lock(&devreq_mutex);
A
Al Viro 已提交
529
	orangefs_bufmap_finalize();
M
Mike Marshall 已提交
530

531
	open_access_count = -1;
M
Mike Marshall 已提交
532 533

	unmounted = mark_all_pending_mounts();
534
	gossip_debug(GOSSIP_DEV_DEBUG, "ORANGEFS Device Close: Filesystem(s) %s\n",
M
Mike Marshall 已提交
535 536 537 538
		     (unmounted ? "UNMOUNTED" : "MOUNTED"));

	purge_waiting_ops();
	purge_inprogress_ops();
A
Al Viro 已提交
539 540 541

	orangefs_bufmap_run_down();

M
Mike Marshall 已提交
542 543
	gossip_debug(GOSSIP_DEV_DEBUG,
		     "pvfs2-client-core: device close complete\n");
544
	open_access_count = 0;
M
Martin Brandenburg 已提交
545
	orangefs_userspace_version = 0;
546
	mutex_unlock(&devreq_mutex);
M
Mike Marshall 已提交
547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563
	return 0;
}

int is_daemon_in_service(void)
{
	int in_service;

	/*
	 * What this function does is checks if client-core is alive
	 * based on the access count we maintain on the device.
	 */
	mutex_lock(&devreq_mutex);
	in_service = open_access_count == 1 ? 0 : -EIO;
	mutex_unlock(&devreq_mutex);
	return in_service;
}

564 565 566 567 568
bool __is_daemon_in_service(void)
{
	return open_access_count == 1;
}

M
Mike Marshall 已提交
569 570 571
static inline long check_ioctl_command(unsigned int command)
{
	/* Check for valid ioctl codes */
572
	if (_IOC_TYPE(command) != ORANGEFS_DEV_MAGIC) {
M
Mike Marshall 已提交
573 574 575
		gossip_err("device ioctl magic numbers don't match! Did you rebuild pvfs2-client-core/libpvfs2? [cmd %x, magic %x != %x]\n",
			command,
			_IOC_TYPE(command),
576
			ORANGEFS_DEV_MAGIC);
M
Mike Marshall 已提交
577 578 579
		return -EINVAL;
	}
	/* and valid ioctl commands */
580
	if (_IOC_NR(command) >= ORANGEFS_DEV_MAXNR || _IOC_NR(command) <= 0) {
M
Mike Marshall 已提交
581
		gossip_err("Invalid ioctl command number [%d >= %d]\n",
582
			   _IOC_NR(command), ORANGEFS_DEV_MAXNR);
M
Mike Marshall 已提交
583 584 585 586 587 588 589
		return -ENOIOCTLCMD;
	}
	return 0;
}

static long dispatch_ioctl_command(unsigned int command, unsigned long arg)
{
590
	static __s32 magic = ORANGEFS_DEVREQ_MAGIC;
591 592
	static __s32 max_up_size = MAX_DEV_REQ_UPSIZE;
	static __s32 max_down_size = MAX_DEV_REQ_DOWNSIZE;
593
	struct ORANGEFS_dev_map_desc user_desc;
M
Mike Marshall 已提交
594 595
	int ret = 0;
	int upstream_kmod = 1;
596
	struct orangefs_sb_info_s *orangefs_sb;
M
Mike Marshall 已提交
597 598 599 600

	/* mtmoore: add locking here */

	switch (command) {
601
	case ORANGEFS_DEV_GET_MAGIC:
M
Mike Marshall 已提交
602 603 604
		return ((put_user(magic, (__s32 __user *) arg) == -EFAULT) ?
			-EIO :
			0);
605
	case ORANGEFS_DEV_GET_MAX_UPSIZE:
M
Mike Marshall 已提交
606 607 608 609
		return ((put_user(max_up_size,
				  (__s32 __user *) arg) == -EFAULT) ?
					-EIO :
					0);
610
	case ORANGEFS_DEV_GET_MAX_DOWNSIZE:
M
Mike Marshall 已提交
611 612 613 614
		return ((put_user(max_down_size,
				  (__s32 __user *) arg) == -EFAULT) ?
					-EIO :
					0);
615
	case ORANGEFS_DEV_MAP:
M
Mike Marshall 已提交
616
		ret = copy_from_user(&user_desc,
617
				     (struct ORANGEFS_dev_map_desc __user *)
M
Mike Marshall 已提交
618
				     arg,
619
				     sizeof(struct ORANGEFS_dev_map_desc));
A
Al Viro 已提交
620 621
		/* WTF -EIO and not -EFAULT? */
		return ret ? -EIO : orangefs_bufmap_initialize(&user_desc);
622
	case ORANGEFS_DEV_REMOUNT_ALL:
M
Mike Marshall 已提交
623
		gossip_debug(GOSSIP_DEV_DEBUG,
624 625
			     "%s: got ORANGEFS_DEV_REMOUNT_ALL\n",
			     __func__);
M
Mike Marshall 已提交
626 627

		/*
628
		 * remount all mounted orangefs volumes to regain the lost
M
Mike Marshall 已提交
629 630
		 * dynamic mount tables (if any) -- NOTE: this is done
		 * without keeping the superblock list locked due to the
M
Mike Marshall 已提交
631
		 * upcall/downcall waiting.  also, the request mutex is
M
Mike Marshall 已提交
632 633 634 635
		 * used to ensure that no operations will be serviced until
		 * all of the remounts are serviced (to avoid ops between
		 * mounts to fail)
		 */
636
		ret = mutex_lock_interruptible(&orangefs_request_mutex);
M
Mike Marshall 已提交
637 638 639
		if (ret < 0)
			return ret;
		gossip_debug(GOSSIP_DEV_DEBUG,
640 641
			     "%s: priority remount in progress\n",
			     __func__);
642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660
		spin_lock(&orangefs_superblocks_lock);
		list_for_each_entry(orangefs_sb, &orangefs_superblocks, list) {
			/*
			 * We have to drop the spinlock, so entries can be
			 * removed.  They can't be freed, though, so we just
			 * keep the forward pointers and zero the back ones -
			 * that way we can get to the rest of the list.
			 */
			if (!orangefs_sb->list.prev)
				continue;
			gossip_debug(GOSSIP_DEV_DEBUG,
				     "%s: Remounting SB %p\n",
				     __func__,
				     orangefs_sb);

			spin_unlock(&orangefs_superblocks_lock);
			ret = orangefs_remount(orangefs_sb);
			spin_lock(&orangefs_superblocks_lock);
			if (ret) {
M
Mike Marshall 已提交
661
				gossip_debug(GOSSIP_DEV_DEBUG,
662
					     "SB %p remount failed\n",
663
					     orangefs_sb);
664
				break;
M
Mike Marshall 已提交
665 666
			}
		}
667
		spin_unlock(&orangefs_superblocks_lock);
M
Mike Marshall 已提交
668
		gossip_debug(GOSSIP_DEV_DEBUG,
669 670
			     "%s: priority remount complete\n",
			     __func__);
671
		mutex_unlock(&orangefs_request_mutex);
M
Mike Marshall 已提交
672 673
		return ret;

674
	case ORANGEFS_DEV_UPSTREAM:
M
Mike Marshall 已提交
675 676 677 678 679 680 681 682 683
		ret = copy_to_user((void __user *)arg,
				    &upstream_kmod,
				    sizeof(upstream_kmod));

		if (ret != 0)
			return -EIO;
		else
			return ret;

684
	case ORANGEFS_DEV_CLIENT_MASK:
685
		return orangefs_debugfs_new_client_mask((void __user *)arg);
686
	case ORANGEFS_DEV_CLIENT_STRING:
687
		return orangefs_debugfs_new_client_string((void __user *)arg);
688
	case ORANGEFS_DEV_DEBUG:
689
		return orangefs_debugfs_new_debug((void __user *)arg);
M
Mike Marshall 已提交
690 691 692 693 694 695
	default:
		return -ENOIOCTLCMD;
	}
	return -ENOIOCTLCMD;
}

696
static long orangefs_devreq_ioctl(struct file *file,
M
Mike Marshall 已提交
697 698 699 700 701 702 703 704 705 706 707 708 709 710
			       unsigned int command, unsigned long arg)
{
	long ret;

	/* Check for properly constructed commands */
	ret = check_ioctl_command(command);
	if (ret < 0)
		return (int)ret;

	return (int)dispatch_ioctl_command(command, arg);
}

#ifdef CONFIG_COMPAT		/* CONFIG_COMPAT is in .config */

711 712
/*  Compat structure for the ORANGEFS_DEV_MAP ioctl */
struct ORANGEFS_dev_map_desc32 {
M
Mike Marshall 已提交
713 714 715 716 717 718 719 720
	compat_uptr_t ptr;
	__s32 total_size;
	__s32 size;
	__s32 count;
};

static unsigned long translate_dev_map26(unsigned long args, long *error)
{
721
	struct ORANGEFS_dev_map_desc32 __user *p32 = (void __user *)args;
M
Mike Marshall 已提交
722 723 724 725
	/*
	 * Depending on the architecture, allocate some space on the
	 * user-call-stack based on our expected layout.
	 */
726
	struct ORANGEFS_dev_map_desc __user *p =
M
Mike Marshall 已提交
727
	    compat_alloc_user_space(sizeof(*p));
728
	compat_uptr_t addr;
M
Mike Marshall 已提交
729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753

	*error = 0;
	/* get the ptr from the 32 bit user-space */
	if (get_user(addr, &p32->ptr))
		goto err;
	/* try to put that into a 64-bit layout */
	if (put_user(compat_ptr(addr), &p->ptr))
		goto err;
	/* copy the remaining fields */
	if (copy_in_user(&p->total_size, &p32->total_size, sizeof(__s32)))
		goto err;
	if (copy_in_user(&p->size, &p32->size, sizeof(__s32)))
		goto err;
	if (copy_in_user(&p->count, &p32->count, sizeof(__s32)))
		goto err;
	return (unsigned long)p;
err:
	*error = -EFAULT;
	return 0;
}

/*
 * 32 bit user-space apps' ioctl handlers when kernel modules
 * is compiled as a 64 bit one
 */
754
static long orangefs_devreq_compat_ioctl(struct file *filp, unsigned int cmd,
M
Mike Marshall 已提交
755 756 757 758 759 760 761 762 763
				      unsigned long args)
{
	long ret;
	unsigned long arg = args;

	/* Check for properly constructed commands */
	ret = check_ioctl_command(cmd);
	if (ret < 0)
		return ret;
764
	if (cmd == ORANGEFS_DEV_MAP) {
M
Mike Marshall 已提交
765 766 767 768 769 770 771 772 773 774 775 776 777 778
		/*
		 * convert the arguments to what we expect internally
		 * in kernel space
		 */
		arg = translate_dev_map26(args, &ret);
		if (ret < 0) {
			gossip_err("Could not translate dev map\n");
			return ret;
		}
	}
	/* no other ioctl requires translation */
	return dispatch_ioctl_command(cmd, arg);
}

M
Mike Marshall 已提交
779 780
#endif /* CONFIG_COMPAT is in .config */

M
Mike Marshall 已提交
781
/* the assigned character device major number */
782
static int orangefs_dev_major;
M
Mike Marshall 已提交
783 784

/*
785
 * Initialize orangefs device specific state:
M
Mike Marshall 已提交
786 787
 * Must be called at module load time only
 */
788
int orangefs_dev_init(void)
M
Mike Marshall 已提交
789
{
790 791 792 793 794
	/* register orangefs-req device  */
	orangefs_dev_major = register_chrdev(0,
					  ORANGEFS_REQDEVICE_NAME,
					  &orangefs_devreq_file_operations);
	if (orangefs_dev_major < 0) {
M
Mike Marshall 已提交
795 796
		gossip_debug(GOSSIP_DEV_DEBUG,
			     "Failed to register /dev/%s (error %d)\n",
797 798
			     ORANGEFS_REQDEVICE_NAME, orangefs_dev_major);
		return orangefs_dev_major;
M
Mike Marshall 已提交
799 800 801 802
	}

	gossip_debug(GOSSIP_DEV_DEBUG,
		     "*** /dev/%s character device registered ***\n",
803
		     ORANGEFS_REQDEVICE_NAME);
M
Mike Marshall 已提交
804
	gossip_debug(GOSSIP_DEV_DEBUG, "'mknod /dev/%s c %d 0'.\n",
805
		     ORANGEFS_REQDEVICE_NAME, orangefs_dev_major);
M
Mike Marshall 已提交
806 807 808
	return 0;
}

809
void orangefs_dev_cleanup(void)
M
Mike Marshall 已提交
810
{
811
	unregister_chrdev(orangefs_dev_major, ORANGEFS_REQDEVICE_NAME);
M
Mike Marshall 已提交
812 813
	gossip_debug(GOSSIP_DEV_DEBUG,
		     "*** /dev/%s character device unregistered ***\n",
814
		     ORANGEFS_REQDEVICE_NAME);
M
Mike Marshall 已提交
815 816
}

817
static unsigned int orangefs_devreq_poll(struct file *file,
M
Mike Marshall 已提交
818 819 820 821
				      struct poll_table_struct *poll_table)
{
	int poll_revent_mask = 0;

822
	poll_wait(file, &orangefs_request_list_waitq, poll_table);
M
Mike Marshall 已提交
823

824
	if (!list_empty(&orangefs_request_list))
A
Al Viro 已提交
825
		poll_revent_mask |= POLLIN;
M
Mike Marshall 已提交
826 827 828
	return poll_revent_mask;
}

829
const struct file_operations orangefs_devreq_file_operations = {
M
Mike Marshall 已提交
830
	.owner = THIS_MODULE,
831 832 833 834 835
	.read = orangefs_devreq_read,
	.write_iter = orangefs_devreq_write_iter,
	.open = orangefs_devreq_open,
	.release = orangefs_devreq_release,
	.unlocked_ioctl = orangefs_devreq_ioctl,
M
Mike Marshall 已提交
836 837

#ifdef CONFIG_COMPAT		/* CONFIG_COMPAT is in .config */
838
	.compat_ioctl = orangefs_devreq_compat_ioctl,
M
Mike Marshall 已提交
839
#endif
840
	.poll = orangefs_devreq_poll
M
Mike Marshall 已提交
841
};