xref: /OK3568_Linux_fs/kernel/drivers/block/aoe/aoechr.c (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /* Copyright (c) 2012 Coraid, Inc.  See COPYING for GPL terms. */
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun  * aoechr.c
4*4882a593Smuzhiyun  * AoE character device driver
5*4882a593Smuzhiyun  */
6*4882a593Smuzhiyun 
7*4882a593Smuzhiyun #include <linux/hdreg.h>
8*4882a593Smuzhiyun #include <linux/blkdev.h>
9*4882a593Smuzhiyun #include <linux/completion.h>
10*4882a593Smuzhiyun #include <linux/delay.h>
11*4882a593Smuzhiyun #include <linux/slab.h>
12*4882a593Smuzhiyun #include <linux/mutex.h>
13*4882a593Smuzhiyun #include <linux/skbuff.h>
14*4882a593Smuzhiyun #include <linux/export.h>
15*4882a593Smuzhiyun #include "aoe.h"
16*4882a593Smuzhiyun 
17*4882a593Smuzhiyun enum {
18*4882a593Smuzhiyun 	//MINOR_STAT = 1, (moved to sysfs)
19*4882a593Smuzhiyun 	MINOR_ERR = 2,
20*4882a593Smuzhiyun 	MINOR_DISCOVER,
21*4882a593Smuzhiyun 	MINOR_INTERFACES,
22*4882a593Smuzhiyun 	MINOR_REVALIDATE,
23*4882a593Smuzhiyun 	MINOR_FLUSH,
24*4882a593Smuzhiyun 	MSGSZ = 2048,
25*4882a593Smuzhiyun 	NMSG = 100,		/* message backlog to retain */
26*4882a593Smuzhiyun };
27*4882a593Smuzhiyun 
28*4882a593Smuzhiyun struct aoe_chardev {
29*4882a593Smuzhiyun 	ulong minor;
30*4882a593Smuzhiyun 	char name[32];
31*4882a593Smuzhiyun };
32*4882a593Smuzhiyun 
33*4882a593Smuzhiyun enum { EMFL_VALID = 1 };
34*4882a593Smuzhiyun 
35*4882a593Smuzhiyun struct ErrMsg {
36*4882a593Smuzhiyun 	short flags;
37*4882a593Smuzhiyun 	short len;
38*4882a593Smuzhiyun 	char *msg;
39*4882a593Smuzhiyun };
40*4882a593Smuzhiyun 
41*4882a593Smuzhiyun static DEFINE_MUTEX(aoechr_mutex);
42*4882a593Smuzhiyun 
43*4882a593Smuzhiyun /* A ring buffer of error messages, to be read through
44*4882a593Smuzhiyun  * "/dev/etherd/err".  When no messages are present,
45*4882a593Smuzhiyun  * readers will block waiting for messages to appear.
46*4882a593Smuzhiyun  */
47*4882a593Smuzhiyun static struct ErrMsg emsgs[NMSG];
48*4882a593Smuzhiyun static int emsgs_head_idx, emsgs_tail_idx;
49*4882a593Smuzhiyun static struct completion emsgs_comp;
50*4882a593Smuzhiyun static spinlock_t emsgs_lock;
51*4882a593Smuzhiyun static int nblocked_emsgs_readers;
52*4882a593Smuzhiyun static struct class *aoe_class;
53*4882a593Smuzhiyun static struct aoe_chardev chardevs[] = {
54*4882a593Smuzhiyun 	{ MINOR_ERR, "err" },
55*4882a593Smuzhiyun 	{ MINOR_DISCOVER, "discover" },
56*4882a593Smuzhiyun 	{ MINOR_INTERFACES, "interfaces" },
57*4882a593Smuzhiyun 	{ MINOR_REVALIDATE, "revalidate" },
58*4882a593Smuzhiyun 	{ MINOR_FLUSH, "flush" },
59*4882a593Smuzhiyun };
60*4882a593Smuzhiyun 
61*4882a593Smuzhiyun static int
discover(void)62*4882a593Smuzhiyun discover(void)
63*4882a593Smuzhiyun {
64*4882a593Smuzhiyun 	aoecmd_cfg(0xffff, 0xff);
65*4882a593Smuzhiyun 	return 0;
66*4882a593Smuzhiyun }
67*4882a593Smuzhiyun 
68*4882a593Smuzhiyun static int
interfaces(const char __user * str,size_t size)69*4882a593Smuzhiyun interfaces(const char __user *str, size_t size)
70*4882a593Smuzhiyun {
71*4882a593Smuzhiyun 	if (set_aoe_iflist(str, size)) {
72*4882a593Smuzhiyun 		printk(KERN_ERR
73*4882a593Smuzhiyun 			"aoe: could not set interface list: too many interfaces\n");
74*4882a593Smuzhiyun 		return -EINVAL;
75*4882a593Smuzhiyun 	}
76*4882a593Smuzhiyun 	return 0;
77*4882a593Smuzhiyun }
78*4882a593Smuzhiyun 
79*4882a593Smuzhiyun static int
revalidate(const char __user * str,size_t size)80*4882a593Smuzhiyun revalidate(const char __user *str, size_t size)
81*4882a593Smuzhiyun {
82*4882a593Smuzhiyun 	int major, minor, n;
83*4882a593Smuzhiyun 	ulong flags;
84*4882a593Smuzhiyun 	struct aoedev *d;
85*4882a593Smuzhiyun 	struct sk_buff *skb;
86*4882a593Smuzhiyun 	char buf[16];
87*4882a593Smuzhiyun 
88*4882a593Smuzhiyun 	if (size >= sizeof buf)
89*4882a593Smuzhiyun 		return -EINVAL;
90*4882a593Smuzhiyun 	buf[sizeof buf - 1] = '\0';
91*4882a593Smuzhiyun 	if (copy_from_user(buf, str, size))
92*4882a593Smuzhiyun 		return -EFAULT;
93*4882a593Smuzhiyun 
94*4882a593Smuzhiyun 	n = sscanf(buf, "e%d.%d", &major, &minor);
95*4882a593Smuzhiyun 	if (n != 2) {
96*4882a593Smuzhiyun 		pr_err("aoe: invalid device specification %s\n", buf);
97*4882a593Smuzhiyun 		return -EINVAL;
98*4882a593Smuzhiyun 	}
99*4882a593Smuzhiyun 	d = aoedev_by_aoeaddr(major, minor, 0);
100*4882a593Smuzhiyun 	if (!d)
101*4882a593Smuzhiyun 		return -EINVAL;
102*4882a593Smuzhiyun 	spin_lock_irqsave(&d->lock, flags);
103*4882a593Smuzhiyun 	aoecmd_cleanslate(d);
104*4882a593Smuzhiyun 	aoecmd_cfg(major, minor);
105*4882a593Smuzhiyun loop:
106*4882a593Smuzhiyun 	skb = aoecmd_ata_id(d);
107*4882a593Smuzhiyun 	spin_unlock_irqrestore(&d->lock, flags);
108*4882a593Smuzhiyun 	/* try again if we are able to sleep a bit,
109*4882a593Smuzhiyun 	 * otherwise give up this revalidation
110*4882a593Smuzhiyun 	 */
111*4882a593Smuzhiyun 	if (!skb && !msleep_interruptible(250)) {
112*4882a593Smuzhiyun 		spin_lock_irqsave(&d->lock, flags);
113*4882a593Smuzhiyun 		goto loop;
114*4882a593Smuzhiyun 	}
115*4882a593Smuzhiyun 	aoedev_put(d);
116*4882a593Smuzhiyun 	if (skb) {
117*4882a593Smuzhiyun 		struct sk_buff_head queue;
118*4882a593Smuzhiyun 		__skb_queue_head_init(&queue);
119*4882a593Smuzhiyun 		__skb_queue_tail(&queue, skb);
120*4882a593Smuzhiyun 		aoenet_xmit(&queue);
121*4882a593Smuzhiyun 	}
122*4882a593Smuzhiyun 	return 0;
123*4882a593Smuzhiyun }
124*4882a593Smuzhiyun 
125*4882a593Smuzhiyun void
aoechr_error(char * msg)126*4882a593Smuzhiyun aoechr_error(char *msg)
127*4882a593Smuzhiyun {
128*4882a593Smuzhiyun 	struct ErrMsg *em;
129*4882a593Smuzhiyun 	char *mp;
130*4882a593Smuzhiyun 	ulong flags, n;
131*4882a593Smuzhiyun 
132*4882a593Smuzhiyun 	n = strlen(msg);
133*4882a593Smuzhiyun 
134*4882a593Smuzhiyun 	spin_lock_irqsave(&emsgs_lock, flags);
135*4882a593Smuzhiyun 
136*4882a593Smuzhiyun 	em = emsgs + emsgs_tail_idx;
137*4882a593Smuzhiyun 	if ((em->flags & EMFL_VALID)) {
138*4882a593Smuzhiyun bail:		spin_unlock_irqrestore(&emsgs_lock, flags);
139*4882a593Smuzhiyun 		return;
140*4882a593Smuzhiyun 	}
141*4882a593Smuzhiyun 
142*4882a593Smuzhiyun 	mp = kmemdup(msg, n, GFP_ATOMIC);
143*4882a593Smuzhiyun 	if (mp == NULL) {
144*4882a593Smuzhiyun 		printk(KERN_ERR "aoe: allocation failure, len=%ld\n", n);
145*4882a593Smuzhiyun 		goto bail;
146*4882a593Smuzhiyun 	}
147*4882a593Smuzhiyun 
148*4882a593Smuzhiyun 	em->msg = mp;
149*4882a593Smuzhiyun 	em->flags |= EMFL_VALID;
150*4882a593Smuzhiyun 	em->len = n;
151*4882a593Smuzhiyun 
152*4882a593Smuzhiyun 	emsgs_tail_idx++;
153*4882a593Smuzhiyun 	emsgs_tail_idx %= ARRAY_SIZE(emsgs);
154*4882a593Smuzhiyun 
155*4882a593Smuzhiyun 	spin_unlock_irqrestore(&emsgs_lock, flags);
156*4882a593Smuzhiyun 
157*4882a593Smuzhiyun 	if (nblocked_emsgs_readers)
158*4882a593Smuzhiyun 		complete(&emsgs_comp);
159*4882a593Smuzhiyun }
160*4882a593Smuzhiyun 
161*4882a593Smuzhiyun static ssize_t
aoechr_write(struct file * filp,const char __user * buf,size_t cnt,loff_t * offp)162*4882a593Smuzhiyun aoechr_write(struct file *filp, const char __user *buf, size_t cnt, loff_t *offp)
163*4882a593Smuzhiyun {
164*4882a593Smuzhiyun 	int ret = -EINVAL;
165*4882a593Smuzhiyun 
166*4882a593Smuzhiyun 	switch ((unsigned long) filp->private_data) {
167*4882a593Smuzhiyun 	default:
168*4882a593Smuzhiyun 		printk(KERN_INFO "aoe: can't write to that file.\n");
169*4882a593Smuzhiyun 		break;
170*4882a593Smuzhiyun 	case MINOR_DISCOVER:
171*4882a593Smuzhiyun 		ret = discover();
172*4882a593Smuzhiyun 		break;
173*4882a593Smuzhiyun 	case MINOR_INTERFACES:
174*4882a593Smuzhiyun 		ret = interfaces(buf, cnt);
175*4882a593Smuzhiyun 		break;
176*4882a593Smuzhiyun 	case MINOR_REVALIDATE:
177*4882a593Smuzhiyun 		ret = revalidate(buf, cnt);
178*4882a593Smuzhiyun 		break;
179*4882a593Smuzhiyun 	case MINOR_FLUSH:
180*4882a593Smuzhiyun 		ret = aoedev_flush(buf, cnt);
181*4882a593Smuzhiyun 		break;
182*4882a593Smuzhiyun 	}
183*4882a593Smuzhiyun 	if (ret == 0)
184*4882a593Smuzhiyun 		ret = cnt;
185*4882a593Smuzhiyun 	return ret;
186*4882a593Smuzhiyun }
187*4882a593Smuzhiyun 
188*4882a593Smuzhiyun static int
aoechr_open(struct inode * inode,struct file * filp)189*4882a593Smuzhiyun aoechr_open(struct inode *inode, struct file *filp)
190*4882a593Smuzhiyun {
191*4882a593Smuzhiyun 	int n, i;
192*4882a593Smuzhiyun 
193*4882a593Smuzhiyun 	mutex_lock(&aoechr_mutex);
194*4882a593Smuzhiyun 	n = iminor(inode);
195*4882a593Smuzhiyun 	filp->private_data = (void *) (unsigned long) n;
196*4882a593Smuzhiyun 
197*4882a593Smuzhiyun 	for (i = 0; i < ARRAY_SIZE(chardevs); ++i)
198*4882a593Smuzhiyun 		if (chardevs[i].minor == n) {
199*4882a593Smuzhiyun 			mutex_unlock(&aoechr_mutex);
200*4882a593Smuzhiyun 			return 0;
201*4882a593Smuzhiyun 		}
202*4882a593Smuzhiyun 	mutex_unlock(&aoechr_mutex);
203*4882a593Smuzhiyun 	return -EINVAL;
204*4882a593Smuzhiyun }
205*4882a593Smuzhiyun 
206*4882a593Smuzhiyun static int
aoechr_rel(struct inode * inode,struct file * filp)207*4882a593Smuzhiyun aoechr_rel(struct inode *inode, struct file *filp)
208*4882a593Smuzhiyun {
209*4882a593Smuzhiyun 	return 0;
210*4882a593Smuzhiyun }
211*4882a593Smuzhiyun 
212*4882a593Smuzhiyun static ssize_t
aoechr_read(struct file * filp,char __user * buf,size_t cnt,loff_t * off)213*4882a593Smuzhiyun aoechr_read(struct file *filp, char __user *buf, size_t cnt, loff_t *off)
214*4882a593Smuzhiyun {
215*4882a593Smuzhiyun 	unsigned long n;
216*4882a593Smuzhiyun 	char *mp;
217*4882a593Smuzhiyun 	struct ErrMsg *em;
218*4882a593Smuzhiyun 	ssize_t len;
219*4882a593Smuzhiyun 	ulong flags;
220*4882a593Smuzhiyun 
221*4882a593Smuzhiyun 	n = (unsigned long) filp->private_data;
222*4882a593Smuzhiyun 	if (n != MINOR_ERR)
223*4882a593Smuzhiyun 		return -EFAULT;
224*4882a593Smuzhiyun 
225*4882a593Smuzhiyun 	spin_lock_irqsave(&emsgs_lock, flags);
226*4882a593Smuzhiyun 
227*4882a593Smuzhiyun 	for (;;) {
228*4882a593Smuzhiyun 		em = emsgs + emsgs_head_idx;
229*4882a593Smuzhiyun 		if ((em->flags & EMFL_VALID) != 0)
230*4882a593Smuzhiyun 			break;
231*4882a593Smuzhiyun 		if (filp->f_flags & O_NDELAY) {
232*4882a593Smuzhiyun 			spin_unlock_irqrestore(&emsgs_lock, flags);
233*4882a593Smuzhiyun 			return -EAGAIN;
234*4882a593Smuzhiyun 		}
235*4882a593Smuzhiyun 		nblocked_emsgs_readers++;
236*4882a593Smuzhiyun 
237*4882a593Smuzhiyun 		spin_unlock_irqrestore(&emsgs_lock, flags);
238*4882a593Smuzhiyun 
239*4882a593Smuzhiyun 		n = wait_for_completion_interruptible(&emsgs_comp);
240*4882a593Smuzhiyun 
241*4882a593Smuzhiyun 		spin_lock_irqsave(&emsgs_lock, flags);
242*4882a593Smuzhiyun 
243*4882a593Smuzhiyun 		nblocked_emsgs_readers--;
244*4882a593Smuzhiyun 
245*4882a593Smuzhiyun 		if (n) {
246*4882a593Smuzhiyun 			spin_unlock_irqrestore(&emsgs_lock, flags);
247*4882a593Smuzhiyun 			return -ERESTARTSYS;
248*4882a593Smuzhiyun 		}
249*4882a593Smuzhiyun 	}
250*4882a593Smuzhiyun 	if (em->len > cnt) {
251*4882a593Smuzhiyun 		spin_unlock_irqrestore(&emsgs_lock, flags);
252*4882a593Smuzhiyun 		return -EAGAIN;
253*4882a593Smuzhiyun 	}
254*4882a593Smuzhiyun 	mp = em->msg;
255*4882a593Smuzhiyun 	len = em->len;
256*4882a593Smuzhiyun 	em->msg = NULL;
257*4882a593Smuzhiyun 	em->flags &= ~EMFL_VALID;
258*4882a593Smuzhiyun 
259*4882a593Smuzhiyun 	emsgs_head_idx++;
260*4882a593Smuzhiyun 	emsgs_head_idx %= ARRAY_SIZE(emsgs);
261*4882a593Smuzhiyun 
262*4882a593Smuzhiyun 	spin_unlock_irqrestore(&emsgs_lock, flags);
263*4882a593Smuzhiyun 
264*4882a593Smuzhiyun 	n = copy_to_user(buf, mp, len);
265*4882a593Smuzhiyun 	kfree(mp);
266*4882a593Smuzhiyun 	return n == 0 ? len : -EFAULT;
267*4882a593Smuzhiyun }
268*4882a593Smuzhiyun 
269*4882a593Smuzhiyun static const struct file_operations aoe_fops = {
270*4882a593Smuzhiyun 	.write = aoechr_write,
271*4882a593Smuzhiyun 	.read = aoechr_read,
272*4882a593Smuzhiyun 	.open = aoechr_open,
273*4882a593Smuzhiyun 	.release = aoechr_rel,
274*4882a593Smuzhiyun 	.owner = THIS_MODULE,
275*4882a593Smuzhiyun 	.llseek = noop_llseek,
276*4882a593Smuzhiyun };
277*4882a593Smuzhiyun 
aoe_devnode(struct device * dev,umode_t * mode)278*4882a593Smuzhiyun static char *aoe_devnode(struct device *dev, umode_t *mode)
279*4882a593Smuzhiyun {
280*4882a593Smuzhiyun 	return kasprintf(GFP_KERNEL, "etherd/%s", dev_name(dev));
281*4882a593Smuzhiyun }
282*4882a593Smuzhiyun 
283*4882a593Smuzhiyun int __init
aoechr_init(void)284*4882a593Smuzhiyun aoechr_init(void)
285*4882a593Smuzhiyun {
286*4882a593Smuzhiyun 	int n, i;
287*4882a593Smuzhiyun 
288*4882a593Smuzhiyun 	n = register_chrdev(AOE_MAJOR, "aoechr", &aoe_fops);
289*4882a593Smuzhiyun 	if (n < 0) {
290*4882a593Smuzhiyun 		printk(KERN_ERR "aoe: can't register char device\n");
291*4882a593Smuzhiyun 		return n;
292*4882a593Smuzhiyun 	}
293*4882a593Smuzhiyun 	init_completion(&emsgs_comp);
294*4882a593Smuzhiyun 	spin_lock_init(&emsgs_lock);
295*4882a593Smuzhiyun 	aoe_class = class_create(THIS_MODULE, "aoe");
296*4882a593Smuzhiyun 	if (IS_ERR(aoe_class)) {
297*4882a593Smuzhiyun 		unregister_chrdev(AOE_MAJOR, "aoechr");
298*4882a593Smuzhiyun 		return PTR_ERR(aoe_class);
299*4882a593Smuzhiyun 	}
300*4882a593Smuzhiyun 	aoe_class->devnode = aoe_devnode;
301*4882a593Smuzhiyun 
302*4882a593Smuzhiyun 	for (i = 0; i < ARRAY_SIZE(chardevs); ++i)
303*4882a593Smuzhiyun 		device_create(aoe_class, NULL,
304*4882a593Smuzhiyun 			      MKDEV(AOE_MAJOR, chardevs[i].minor), NULL,
305*4882a593Smuzhiyun 			      chardevs[i].name);
306*4882a593Smuzhiyun 
307*4882a593Smuzhiyun 	return 0;
308*4882a593Smuzhiyun }
309*4882a593Smuzhiyun 
310*4882a593Smuzhiyun void
aoechr_exit(void)311*4882a593Smuzhiyun aoechr_exit(void)
312*4882a593Smuzhiyun {
313*4882a593Smuzhiyun 	int i;
314*4882a593Smuzhiyun 
315*4882a593Smuzhiyun 	for (i = 0; i < ARRAY_SIZE(chardevs); ++i)
316*4882a593Smuzhiyun 		device_destroy(aoe_class, MKDEV(AOE_MAJOR, chardevs[i].minor));
317*4882a593Smuzhiyun 	class_destroy(aoe_class);
318*4882a593Smuzhiyun 	unregister_chrdev(AOE_MAJOR, "aoechr");
319*4882a593Smuzhiyun }
320*4882a593Smuzhiyun 
321