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