]> git.proxmox.com Git - mirror_ubuntu-artful-kernel.git/blame - block/bsg.c
ide: don't abuse cmd_type
[mirror_ubuntu-artful-kernel.git] / block / bsg.c
CommitLineData
3d6392cf 1/*
0c6a89ba 2 * bsg.c - block layer implementation of the sg v4 interface
3d6392cf
JA
3 *
4 * Copyright (C) 2004 Jens Axboe <axboe@suse.de> SUSE Labs
5 * Copyright (C) 2004 Peter M. Jones <pjones@redhat.com>
6 *
7 * This file is subject to the terms and conditions of the GNU General Public
8 * License version 2. See the file "COPYING" in the main directory of this
9 * archive for more details.
10 *
11 */
3d6392cf
JA
12#include <linux/module.h>
13#include <linux/init.h>
14#include <linux/file.h>
15#include <linux/blkdev.h>
16#include <linux/poll.h>
17#include <linux/cdev.h>
ad5ebd2f 18#include <linux/jiffies.h>
3d6392cf
JA
19#include <linux/percpu.h>
20#include <linux/uio.h>
598443a2 21#include <linux/idr.h>
3d6392cf 22#include <linux/bsg.h>
5a0e3ad6 23#include <linux/slab.h>
3d6392cf
JA
24
25#include <scsi/scsi.h>
26#include <scsi/scsi_ioctl.h>
27#include <scsi/scsi_cmnd.h>
4e2872d6
FT
28#include <scsi/scsi_device.h>
29#include <scsi/scsi_driver.h>
3d6392cf
JA
30#include <scsi/sg.h>
31
0ed081ce
FT
32#define BSG_DESCRIPTION "Block layer SCSI generic (bsg) driver"
33#define BSG_VERSION "0.4"
3d6392cf 34
3d6392cf 35struct bsg_device {
165125e1 36 struct request_queue *queue;
3d6392cf
JA
37 spinlock_t lock;
38 struct list_head busy_list;
39 struct list_head done_list;
40 struct hlist_node dev_list;
41 atomic_t ref_count;
3d6392cf
JA
42 int queued_cmds;
43 int done_cmds;
3d6392cf
JA
44 wait_queue_head_t wq_done;
45 wait_queue_head_t wq_free;
3ada8b7e 46 char name[20];
3d6392cf
JA
47 int max_queue;
48 unsigned long flags;
49};
50
51enum {
52 BSG_F_BLOCK = 1,
3d6392cf
JA
53};
54
5309cb38 55#define BSG_DEFAULT_CMDS 64
292b7f27 56#define BSG_MAX_DEVS 32768
3d6392cf
JA
57
58#undef BSG_DEBUG
59
60#ifdef BSG_DEBUG
24c03d47 61#define dprintk(fmt, args...) printk(KERN_ERR "%s: " fmt, __func__, ##args)
3d6392cf
JA
62#else
63#define dprintk(fmt, args...)
64#endif
65
3d6392cf 66static DEFINE_MUTEX(bsg_mutex);
598443a2 67static DEFINE_IDR(bsg_minor_idr);
3d6392cf 68
25fd1643 69#define BSG_LIST_ARRAY_SIZE 8
25fd1643 70static struct hlist_head bsg_device_list[BSG_LIST_ARRAY_SIZE];
3d6392cf
JA
71
72static struct class *bsg_class;
46f6ef4a 73static int bsg_major;
3d6392cf 74
5309cb38
JA
75static struct kmem_cache *bsg_cmd_cachep;
76
3d6392cf
JA
77/*
78 * our internal command type
79 */
80struct bsg_command {
81 struct bsg_device *bd;
82 struct list_head list;
83 struct request *rq;
84 struct bio *bio;
2c9ecdf4 85 struct bio *bidi_bio;
3d6392cf 86 int err;
70e36ece 87 struct sg_io_v4 hdr;
3d6392cf
JA
88};
89
90static void bsg_free_command(struct bsg_command *bc)
91{
92 struct bsg_device *bd = bc->bd;
3d6392cf
JA
93 unsigned long flags;
94
5309cb38 95 kmem_cache_free(bsg_cmd_cachep, bc);
3d6392cf
JA
96
97 spin_lock_irqsave(&bd->lock, flags);
98 bd->queued_cmds--;
3d6392cf
JA
99 spin_unlock_irqrestore(&bd->lock, flags);
100
101 wake_up(&bd->wq_free);
102}
103
e7d72173 104static struct bsg_command *bsg_alloc_command(struct bsg_device *bd)
3d6392cf 105{
e7d72173 106 struct bsg_command *bc = ERR_PTR(-EINVAL);
3d6392cf
JA
107
108 spin_lock_irq(&bd->lock);
109
110 if (bd->queued_cmds >= bd->max_queue)
111 goto out;
112
3d6392cf 113 bd->queued_cmds++;
3d6392cf
JA
114 spin_unlock_irq(&bd->lock);
115
25fd1643 116 bc = kmem_cache_zalloc(bsg_cmd_cachep, GFP_KERNEL);
5309cb38
JA
117 if (unlikely(!bc)) {
118 spin_lock_irq(&bd->lock);
7e75d730 119 bd->queued_cmds--;
e7d72173 120 bc = ERR_PTR(-ENOMEM);
7e75d730 121 goto out;
5309cb38
JA
122 }
123
3d6392cf
JA
124 bc->bd = bd;
125 INIT_LIST_HEAD(&bc->list);
5309cb38 126 dprintk("%s: returning free cmd %p\n", bd->name, bc);
3d6392cf
JA
127 return bc;
128out:
3d6392cf
JA
129 spin_unlock_irq(&bd->lock);
130 return bc;
131}
132
1c1133e1 133static inline struct hlist_head *bsg_dev_idx_hash(int index)
3d6392cf 134{
1c1133e1 135 return &bsg_device_list[index & (BSG_LIST_ARRAY_SIZE - 1)];
3d6392cf
JA
136}
137
165125e1 138static int blk_fill_sgv4_hdr_rq(struct request_queue *q, struct request *rq,
abf54393 139 struct sg_io_v4 *hdr, struct bsg_device *bd,
aeb5d727 140 fmode_t has_write_perm)
70e36ece 141{
82ed4db4
CH
142 struct scsi_request *req = scsi_req(rq);
143
9f5de6b1 144 if (hdr->request_len > BLK_MAX_CDB) {
82ed4db4
CH
145 req->cmd = kzalloc(hdr->request_len, GFP_KERNEL);
146 if (!req->cmd)
9f5de6b1
FT
147 return -ENOMEM;
148 }
70e36ece 149
82ed4db4 150 if (copy_from_user(req->cmd, (void __user *)(unsigned long)hdr->request,
70e36ece
FT
151 hdr->request_len))
152 return -EFAULT;
15d10b61
FT
153
154 if (hdr->subprotocol == BSG_SUB_PROTOCOL_SCSI_CMD) {
82ed4db4 155 if (blk_verify_command(req->cmd, has_write_perm))
15d10b61
FT
156 return -EPERM;
157 } else if (!capable(CAP_SYS_RAWIO))
70e36ece
FT
158 return -EPERM;
159
160 /*
161 * fill in request structure
162 */
82ed4db4 163 req->cmd_len = hdr->request_len;
70e36ece 164
ad5ebd2f 165 rq->timeout = msecs_to_jiffies(hdr->timeout);
70e36ece
FT
166 if (!rq->timeout)
167 rq->timeout = q->sg_timeout;
168 if (!rq->timeout)
169 rq->timeout = BLK_DEFAULT_SG_TIMEOUT;
f2f1fa78
LT
170 if (rq->timeout < BLK_MIN_SG_TIMEOUT)
171 rq->timeout = BLK_MIN_SG_TIMEOUT;
70e36ece
FT
172
173 return 0;
174}
175
3d6392cf 176/*
70e36ece 177 * Check if sg_io_v4 from user is allowed and valid
3d6392cf
JA
178 */
179static int
46f3cc17 180bsg_validate_sgv4_hdr(struct sg_io_v4 *hdr, int *rw)
3d6392cf 181{
15d10b61
FT
182 int ret = 0;
183
70e36ece 184 if (hdr->guard != 'Q')
3d6392cf 185 return -EINVAL;
3d6392cf 186
15d10b61
FT
187 switch (hdr->protocol) {
188 case BSG_PROTOCOL_SCSI:
189 switch (hdr->subprotocol) {
190 case BSG_SUB_PROTOCOL_SCSI_CMD:
191 case BSG_SUB_PROTOCOL_SCSI_TRANSPORT:
192 break;
193 default:
194 ret = -EINVAL;
195 }
196 break;
197 default:
198 ret = -EINVAL;
199 }
70e36ece 200
70e36ece 201 *rw = hdr->dout_xfer_len ? WRITE : READ;
15d10b61 202 return ret;
3d6392cf
JA
203}
204
205/*
70e36ece 206 * map sg_io_v4 to a request.
3d6392cf
JA
207 */
208static struct request *
82ed4db4 209bsg_map_hdr(struct bsg_device *bd, struct sg_io_v4 *hdr, fmode_t has_write_perm)
3d6392cf 210{
165125e1 211 struct request_queue *q = bd->queue;
2c9ecdf4 212 struct request *rq, *next_rq = NULL;
25fd1643 213 int ret, rw;
70e36ece 214 unsigned int dxfer_len;
2b727c63 215 void __user *dxferp = NULL;
c7a841f3
JS
216 struct bsg_class_device *bcd = &q->bsg_dev;
217
218 /* if the LLD has been removed then the bsg_unregister_queue will
219 * eventually be called and the class_dev was freed, so we can no
220 * longer use this request_queue. Return no such address.
221 */
222 if (!bcd->class_dev)
223 return ERR_PTR(-ENXIO);
3d6392cf 224
70e36ece
FT
225 dprintk("map hdr %llx/%u %llx/%u\n", (unsigned long long) hdr->dout_xferp,
226 hdr->dout_xfer_len, (unsigned long long) hdr->din_xferp,
227 hdr->din_xfer_len);
3d6392cf 228
46f3cc17 229 ret = bsg_validate_sgv4_hdr(hdr, &rw);
3d6392cf
JA
230 if (ret)
231 return ERR_PTR(ret);
232
233 /*
3ad2f3fb 234 * map scatter-gather elements separately and string them to request
3d6392cf
JA
235 */
236 rq = blk_get_request(q, rw, GFP_KERNEL);
a492f075
JL
237 if (IS_ERR(rq))
238 return rq;
82ed4db4 239 scsi_req_init(rq);
f27b087b 240
abf54393 241 ret = blk_fill_sgv4_hdr_rq(q, rq, hdr, bd, has_write_perm);
2c9ecdf4
FT
242 if (ret)
243 goto out;
244
245 if (rw == WRITE && hdr->din_xfer_len) {
246 if (!test_bit(QUEUE_FLAG_BIDI, &q->queue_flags)) {
247 ret = -EOPNOTSUPP;
248 goto out;
249 }
250
251 next_rq = blk_get_request(q, READ, GFP_KERNEL);
a492f075
JL
252 if (IS_ERR(next_rq)) {
253 ret = PTR_ERR(next_rq);
55872c5a 254 next_rq = NULL;
2c9ecdf4
FT
255 goto out;
256 }
257 rq->next_rq = next_rq;
40f62028 258 next_rq->cmd_type = rq->cmd_type;
2c9ecdf4 259
2b727c63 260 dxferp = (void __user *)(unsigned long)hdr->din_xferp;
152e283f
FT
261 ret = blk_rq_map_user(q, next_rq, NULL, dxferp,
262 hdr->din_xfer_len, GFP_KERNEL);
2c9ecdf4
FT
263 if (ret)
264 goto out;
3d6392cf
JA
265 }
266
70e36ece
FT
267 if (hdr->dout_xfer_len) {
268 dxfer_len = hdr->dout_xfer_len;
2b727c63 269 dxferp = (void __user *)(unsigned long)hdr->dout_xferp;
70e36ece
FT
270 } else if (hdr->din_xfer_len) {
271 dxfer_len = hdr->din_xfer_len;
2b727c63 272 dxferp = (void __user *)(unsigned long)hdr->din_xferp;
70e36ece
FT
273 } else
274 dxfer_len = 0;
275
276 if (dxfer_len) {
152e283f
FT
277 ret = blk_rq_map_user(q, rq, NULL, dxferp, dxfer_len,
278 GFP_KERNEL);
2c9ecdf4
FT
279 if (ret)
280 goto out;
3d6392cf 281 }
c1c20120 282
3d6392cf 283 return rq;
2c9ecdf4 284out:
82ed4db4 285 scsi_req_free_cmd(scsi_req(rq));
2c9ecdf4
FT
286 blk_put_request(rq);
287 if (next_rq) {
288 blk_rq_unmap_user(next_rq->bio);
289 blk_put_request(next_rq);
290 }
291 return ERR_PTR(ret);
3d6392cf
JA
292}
293
294/*
295 * async completion call-back from the block layer, when scsi/ide/whatever
296 * calls end_that_request_last() on a request
297 */
298static void bsg_rq_end_io(struct request *rq, int uptodate)
299{
300 struct bsg_command *bc = rq->end_io_data;
301 struct bsg_device *bd = bc->bd;
302 unsigned long flags;
303
5309cb38
JA
304 dprintk("%s: finished rq %p bc %p, bio %p stat %d\n",
305 bd->name, rq, bc, bc->bio, uptodate);
3d6392cf
JA
306
307 bc->hdr.duration = jiffies_to_msecs(jiffies - bc->hdr.duration);
308
309 spin_lock_irqsave(&bd->lock, flags);
25fd1643
JA
310 list_move_tail(&bc->list, &bd->done_list);
311 bd->done_cmds++;
3d6392cf 312 spin_unlock_irqrestore(&bd->lock, flags);
25fd1643
JA
313
314 wake_up(&bd->wq_done);
3d6392cf
JA
315}
316
317/*
318 * do final setup of a 'bc' and submit the matching 'rq' to the block
319 * layer for io
320 */
165125e1 321static void bsg_add_command(struct bsg_device *bd, struct request_queue *q,
3d6392cf
JA
322 struct bsg_command *bc, struct request *rq)
323{
05378940
BH
324 int at_head = (0 == (bc->hdr.flags & BSG_FLAG_Q_AT_TAIL));
325
3d6392cf
JA
326 /*
327 * add bc command to busy queue and submit rq for io
328 */
329 bc->rq = rq;
330 bc->bio = rq->bio;
2c9ecdf4
FT
331 if (rq->next_rq)
332 bc->bidi_bio = rq->next_rq->bio;
3d6392cf
JA
333 bc->hdr.duration = jiffies;
334 spin_lock_irq(&bd->lock);
335 list_add_tail(&bc->list, &bd->busy_list);
336 spin_unlock_irq(&bd->lock);
337
338 dprintk("%s: queueing rq %p, bc %p\n", bd->name, rq, bc);
339
340 rq->end_io_data = bc;
05378940 341 blk_execute_rq_nowait(q, NULL, rq, at_head, bsg_rq_end_io);
3d6392cf
JA
342}
343
25fd1643 344static struct bsg_command *bsg_next_done_cmd(struct bsg_device *bd)
3d6392cf
JA
345{
346 struct bsg_command *bc = NULL;
347
348 spin_lock_irq(&bd->lock);
349 if (bd->done_cmds) {
43ac9e62 350 bc = list_first_entry(&bd->done_list, struct bsg_command, list);
25fd1643
JA
351 list_del(&bc->list);
352 bd->done_cmds--;
3d6392cf
JA
353 }
354 spin_unlock_irq(&bd->lock);
355
356 return bc;
357}
358
359/*
360 * Get a finished command from the done list
361 */
e7d72173 362static struct bsg_command *bsg_get_done_cmd(struct bsg_device *bd)
3d6392cf
JA
363{
364 struct bsg_command *bc;
365 int ret;
366
367 do {
368 bc = bsg_next_done_cmd(bd);
369 if (bc)
370 break;
371
e7d72173
FT
372 if (!test_bit(BSG_F_BLOCK, &bd->flags)) {
373 bc = ERR_PTR(-EAGAIN);
374 break;
375 }
376
377 ret = wait_event_interruptible(bd->wq_done, bd->done_cmds);
3d6392cf 378 if (ret) {
e7d72173 379 bc = ERR_PTR(-ERESTARTSYS);
3d6392cf
JA
380 break;
381 }
382 } while (1);
383
384 dprintk("%s: returning done %p\n", bd->name, bc);
385
386 return bc;
387}
388
70e36ece 389static int blk_complete_sgv4_hdr_rq(struct request *rq, struct sg_io_v4 *hdr,
2c9ecdf4 390 struct bio *bio, struct bio *bidi_bio)
70e36ece 391{
82ed4db4 392 struct scsi_request *req = scsi_req(rq);
70e36ece
FT
393 int ret = 0;
394
c1c20120 395 dprintk("rq %p bio %p 0x%x\n", rq, bio, rq->errors);
70e36ece
FT
396 /*
397 * fill in all the output members
398 */
47897160 399 hdr->device_status = rq->errors & 0xff;
70e36ece
FT
400 hdr->transport_status = host_byte(rq->errors);
401 hdr->driver_status = driver_byte(rq->errors);
402 hdr->info = 0;
403 if (hdr->device_status || hdr->transport_status || hdr->driver_status)
404 hdr->info |= SG_INFO_CHECK;
70e36ece
FT
405 hdr->response_len = 0;
406
82ed4db4 407 if (req->sense_len && hdr->response) {
25fd1643 408 int len = min_t(unsigned int, hdr->max_response_len,
82ed4db4 409 req->sense_len);
70e36ece 410
2b727c63 411 ret = copy_to_user((void __user *)(unsigned long)hdr->response,
82ed4db4 412 req->sense, len);
70e36ece
FT
413 if (!ret)
414 hdr->response_len = len;
415 else
416 ret = -EFAULT;
417 }
418
2c9ecdf4 419 if (rq->next_rq) {
82ed4db4
CH
420 hdr->dout_resid = req->resid_len;
421 hdr->din_resid = scsi_req(rq->next_rq)->resid_len;
2c9ecdf4
FT
422 blk_rq_unmap_user(bidi_bio);
423 blk_put_request(rq->next_rq);
0c6a89ba 424 } else if (rq_data_dir(rq) == READ)
82ed4db4 425 hdr->din_resid = req->resid_len;
0c6a89ba 426 else
82ed4db4 427 hdr->dout_resid = req->resid_len;
2c9ecdf4 428
2d507a01
JB
429 /*
430 * If the request generated a negative error number, return it
431 * (providing we aren't already returning an error); if it's
432 * just a protocol response (i.e. non negative), that gets
433 * processed above.
434 */
435 if (!ret && rq->errors < 0)
436 ret = rq->errors;
437
70e36ece 438 blk_rq_unmap_user(bio);
82ed4db4 439 scsi_req_free_cmd(req);
70e36ece
FT
440 blk_put_request(rq);
441
442 return ret;
443}
444
2c561246
PZ
445static bool bsg_complete(struct bsg_device *bd)
446{
447 bool ret = false;
448 bool spin;
449
450 do {
451 spin_lock_irq(&bd->lock);
452
453 BUG_ON(bd->done_cmds > bd->queued_cmds);
454
455 /*
456 * All commands consumed.
457 */
458 if (bd->done_cmds == bd->queued_cmds)
459 ret = true;
460
461 spin = !test_bit(BSG_F_BLOCK, &bd->flags);
462
463 spin_unlock_irq(&bd->lock);
464 } while (!ret && spin);
465
466 return ret;
467}
468
3d6392cf
JA
469static int bsg_complete_all_commands(struct bsg_device *bd)
470{
471 struct bsg_command *bc;
472 int ret, tret;
473
474 dprintk("%s: entered\n", bd->name);
475
3d6392cf
JA
476 /*
477 * wait for all commands to complete
478 */
2c561246 479 io_wait_event(bd->wq_done, bsg_complete(bd));
3d6392cf
JA
480
481 /*
482 * discard done commands
483 */
484 ret = 0;
485 do {
e7d72173
FT
486 spin_lock_irq(&bd->lock);
487 if (!bd->queued_cmds) {
488 spin_unlock_irq(&bd->lock);
3d6392cf
JA
489 break;
490 }
efba1a31 491 spin_unlock_irq(&bd->lock);
3d6392cf 492
e7d72173
FT
493 bc = bsg_get_done_cmd(bd);
494 if (IS_ERR(bc))
495 break;
496
2c9ecdf4
FT
497 tret = blk_complete_sgv4_hdr_rq(bc->rq, &bc->hdr, bc->bio,
498 bc->bidi_bio);
3d6392cf
JA
499 if (!ret)
500 ret = tret;
501
502 bsg_free_command(bc);
503 } while (1);
504
505 return ret;
506}
507
25fd1643 508static int
e7d72173
FT
509__bsg_read(char __user *buf, size_t count, struct bsg_device *bd,
510 const struct iovec *iov, ssize_t *bytes_read)
3d6392cf
JA
511{
512 struct bsg_command *bc;
513 int nr_commands, ret;
514
70e36ece 515 if (count % sizeof(struct sg_io_v4))
3d6392cf
JA
516 return -EINVAL;
517
518 ret = 0;
70e36ece 519 nr_commands = count / sizeof(struct sg_io_v4);
3d6392cf 520 while (nr_commands) {
e7d72173 521 bc = bsg_get_done_cmd(bd);
3d6392cf
JA
522 if (IS_ERR(bc)) {
523 ret = PTR_ERR(bc);
524 break;
525 }
526
527 /*
528 * this is the only case where we need to copy data back
529 * after completing the request. so do that here,
530 * bsg_complete_work() cannot do that for us
531 */
2c9ecdf4
FT
532 ret = blk_complete_sgv4_hdr_rq(bc->rq, &bc->hdr, bc->bio,
533 bc->bidi_bio);
3d6392cf 534
25fd1643 535 if (copy_to_user(buf, &bc->hdr, sizeof(bc->hdr)))
3d6392cf
JA
536 ret = -EFAULT;
537
538 bsg_free_command(bc);
539
540 if (ret)
541 break;
542
70e36ece
FT
543 buf += sizeof(struct sg_io_v4);
544 *bytes_read += sizeof(struct sg_io_v4);
3d6392cf
JA
545 nr_commands--;
546 }
547
548 return ret;
549}
550
551static inline void bsg_set_block(struct bsg_device *bd, struct file *file)
552{
553 if (file->f_flags & O_NONBLOCK)
554 clear_bit(BSG_F_BLOCK, &bd->flags);
555 else
556 set_bit(BSG_F_BLOCK, &bd->flags);
557}
558
25fd1643
JA
559/*
560 * Check if the error is a "real" error that we should return.
561 */
3d6392cf
JA
562static inline int err_block_err(int ret)
563{
564 if (ret && ret != -ENOSPC && ret != -ENODATA && ret != -EAGAIN)
565 return 1;
566
567 return 0;
568}
569
570static ssize_t
571bsg_read(struct file *file, char __user *buf, size_t count, loff_t *ppos)
572{
573 struct bsg_device *bd = file->private_data;
574 int ret;
575 ssize_t bytes_read;
576
9e69fbb5 577 dprintk("%s: read %Zd bytes\n", bd->name, count);
3d6392cf
JA
578
579 bsg_set_block(bd, file);
0b07de85 580
3d6392cf 581 bytes_read = 0;
e7d72173 582 ret = __bsg_read(buf, count, bd, NULL, &bytes_read);
3d6392cf
JA
583 *ppos = bytes_read;
584
44194e3e 585 if (!bytes_read || err_block_err(ret))
3d6392cf
JA
586 bytes_read = ret;
587
588 return bytes_read;
589}
590
25fd1643 591static int __bsg_write(struct bsg_device *bd, const char __user *buf,
aeb5d727
AV
592 size_t count, ssize_t *bytes_written,
593 fmode_t has_write_perm)
3d6392cf
JA
594{
595 struct bsg_command *bc;
596 struct request *rq;
597 int ret, nr_commands;
598
70e36ece 599 if (count % sizeof(struct sg_io_v4))
3d6392cf
JA
600 return -EINVAL;
601
70e36ece 602 nr_commands = count / sizeof(struct sg_io_v4);
3d6392cf
JA
603 rq = NULL;
604 bc = NULL;
605 ret = 0;
606 while (nr_commands) {
165125e1 607 struct request_queue *q = bd->queue;
3d6392cf 608
e7d72173 609 bc = bsg_alloc_command(bd);
3d6392cf
JA
610 if (IS_ERR(bc)) {
611 ret = PTR_ERR(bc);
612 bc = NULL;
613 break;
614 }
615
3d6392cf
JA
616 if (copy_from_user(&bc->hdr, buf, sizeof(bc->hdr))) {
617 ret = -EFAULT;
618 break;
619 }
620
621 /*
622 * get a request, fill in the blanks, and add to request queue
623 */
82ed4db4 624 rq = bsg_map_hdr(bd, &bc->hdr, has_write_perm);
3d6392cf
JA
625 if (IS_ERR(rq)) {
626 ret = PTR_ERR(rq);
627 rq = NULL;
628 break;
629 }
630
631 bsg_add_command(bd, q, bc, rq);
632 bc = NULL;
633 rq = NULL;
634 nr_commands--;
70e36ece 635 buf += sizeof(struct sg_io_v4);
25fd1643 636 *bytes_written += sizeof(struct sg_io_v4);
3d6392cf
JA
637 }
638
3d6392cf
JA
639 if (bc)
640 bsg_free_command(bc);
641
642 return ret;
643}
644
645static ssize_t
646bsg_write(struct file *file, const char __user *buf, size_t count, loff_t *ppos)
647{
648 struct bsg_device *bd = file->private_data;
25fd1643 649 ssize_t bytes_written;
3d6392cf
JA
650 int ret;
651
9e69fbb5 652 dprintk("%s: write %Zd bytes\n", bd->name, count);
3d6392cf 653
128394ef
AV
654 if (unlikely(segment_eq(get_fs(), KERNEL_DS)))
655 return -EINVAL;
656
3d6392cf 657 bsg_set_block(bd, file);
3d6392cf 658
25fd1643 659 bytes_written = 0;
abf54393
FT
660 ret = __bsg_write(bd, buf, count, &bytes_written,
661 file->f_mode & FMODE_WRITE);
662
25fd1643 663 *ppos = bytes_written;
3d6392cf
JA
664
665 /*
666 * return bytes written on non-fatal errors
667 */
44194e3e 668 if (!bytes_written || err_block_err(ret))
25fd1643 669 bytes_written = ret;
3d6392cf 670
25fd1643
JA
671 dprintk("%s: returning %Zd\n", bd->name, bytes_written);
672 return bytes_written;
3d6392cf
JA
673}
674
3d6392cf
JA
675static struct bsg_device *bsg_alloc_device(void)
676{
3d6392cf 677 struct bsg_device *bd;
3d6392cf
JA
678
679 bd = kzalloc(sizeof(struct bsg_device), GFP_KERNEL);
680 if (unlikely(!bd))
681 return NULL;
682
683 spin_lock_init(&bd->lock);
684
5309cb38 685 bd->max_queue = BSG_DEFAULT_CMDS;
3d6392cf
JA
686
687 INIT_LIST_HEAD(&bd->busy_list);
688 INIT_LIST_HEAD(&bd->done_list);
689 INIT_HLIST_NODE(&bd->dev_list);
690
691 init_waitqueue_head(&bd->wq_free);
692 init_waitqueue_head(&bd->wq_done);
693 return bd;
3d6392cf
JA
694}
695
97f46ae4
FT
696static void bsg_kref_release_function(struct kref *kref)
697{
698 struct bsg_class_device *bcd =
699 container_of(kref, struct bsg_class_device, ref);
8df5fc04 700 struct device *parent = bcd->parent;
97f46ae4
FT
701
702 if (bcd->release)
703 bcd->release(bcd->parent);
704
8df5fc04 705 put_device(parent);
97f46ae4
FT
706}
707
3d6392cf
JA
708static int bsg_put_device(struct bsg_device *bd)
709{
97f46ae4
FT
710 int ret = 0, do_free;
711 struct request_queue *q = bd->queue;
3d6392cf
JA
712
713 mutex_lock(&bsg_mutex);
714
97f46ae4 715 do_free = atomic_dec_and_test(&bd->ref_count);
3f27e3ed
FT
716 if (!do_free) {
717 mutex_unlock(&bsg_mutex);
3d6392cf 718 goto out;
3f27e3ed
FT
719 }
720
721 hlist_del(&bd->dev_list);
722 mutex_unlock(&bsg_mutex);
3d6392cf
JA
723
724 dprintk("%s: tearing down\n", bd->name);
725
726 /*
727 * close can always block
728 */
729 set_bit(BSG_F_BLOCK, &bd->flags);
730
731 /*
732 * correct error detection baddies here again. it's the responsibility
733 * of the app to properly reap commands before close() if it wants
734 * fool-proof error detection
735 */
736 ret = bsg_complete_all_commands(bd);
737
5309cb38 738 kfree(bd);
3d6392cf 739out:
97f46ae4
FT
740 kref_put(&q->bsg_dev.ref, bsg_kref_release_function);
741 if (do_free)
742 blk_put_queue(q);
3d6392cf
JA
743 return ret;
744}
745
746static struct bsg_device *bsg_add_device(struct inode *inode,
d351af01 747 struct request_queue *rq,
3d6392cf
JA
748 struct file *file)
749{
25fd1643 750 struct bsg_device *bd;
3d6392cf
JA
751#ifdef BSG_DEBUG
752 unsigned char buf[32];
753#endif
09ac46c4 754 if (!blk_get_queue(rq))
c3ff1b90 755 return ERR_PTR(-ENXIO);
3d6392cf
JA
756
757 bd = bsg_alloc_device();
c3ff1b90
FT
758 if (!bd) {
759 blk_put_queue(rq);
3d6392cf 760 return ERR_PTR(-ENOMEM);
c3ff1b90 761 }
3d6392cf 762
d351af01 763 bd->queue = rq;
0b07de85 764
3d6392cf
JA
765 bsg_set_block(bd, file);
766
767 atomic_set(&bd->ref_count, 1);
3d6392cf 768 mutex_lock(&bsg_mutex);
842ea771 769 hlist_add_head(&bd->dev_list, bsg_dev_idx_hash(iminor(inode)));
3d6392cf 770
3ada8b7e 771 strncpy(bd->name, dev_name(rq->bsg_dev.class_dev), sizeof(bd->name) - 1);
3d6392cf 772 dprintk("bound to <%s>, max queue %d\n",
9e69fbb5 773 format_dev_t(buf, inode->i_rdev), bd->max_queue);
3d6392cf
JA
774
775 mutex_unlock(&bsg_mutex);
776 return bd;
777}
778
842ea771 779static struct bsg_device *__bsg_get_device(int minor, struct request_queue *q)
3d6392cf 780{
43ac9e62 781 struct bsg_device *bd;
3d6392cf
JA
782
783 mutex_lock(&bsg_mutex);
784
b67bfe0d 785 hlist_for_each_entry(bd, bsg_dev_idx_hash(minor), dev_list) {
842ea771 786 if (bd->queue == q) {
3d6392cf 787 atomic_inc(&bd->ref_count);
43ac9e62 788 goto found;
3d6392cf 789 }
3d6392cf 790 }
43ac9e62
FT
791 bd = NULL;
792found:
3d6392cf
JA
793 mutex_unlock(&bsg_mutex);
794 return bd;
795}
796
797static struct bsg_device *bsg_get_device(struct inode *inode, struct file *file)
798{
598443a2
FT
799 struct bsg_device *bd;
800 struct bsg_class_device *bcd;
3d6392cf 801
3d6392cf
JA
802 /*
803 * find the class device
804 */
3d6392cf 805 mutex_lock(&bsg_mutex);
598443a2 806 bcd = idr_find(&bsg_minor_idr, iminor(inode));
d45ac4fa 807 if (bcd)
97f46ae4 808 kref_get(&bcd->ref);
3d6392cf
JA
809 mutex_unlock(&bsg_mutex);
810
811 if (!bcd)
812 return ERR_PTR(-ENODEV);
813
842ea771 814 bd = __bsg_get_device(iminor(inode), bcd->queue);
d45ac4fa
FT
815 if (bd)
816 return bd;
817
818 bd = bsg_add_device(inode, bcd->queue, file);
819 if (IS_ERR(bd))
97f46ae4 820 kref_put(&bcd->ref, bsg_kref_release_function);
d45ac4fa
FT
821
822 return bd;
3d6392cf
JA
823}
824
825static int bsg_open(struct inode *inode, struct file *file)
826{
75bd2ef1
JC
827 struct bsg_device *bd;
828
75bd2ef1 829 bd = bsg_get_device(inode, file);
3d6392cf
JA
830
831 if (IS_ERR(bd))
832 return PTR_ERR(bd);
833
834 file->private_data = bd;
835 return 0;
836}
837
838static int bsg_release(struct inode *inode, struct file *file)
839{
840 struct bsg_device *bd = file->private_data;
841
842 file->private_data = NULL;
843 return bsg_put_device(bd);
844}
845
846static unsigned int bsg_poll(struct file *file, poll_table *wait)
847{
848 struct bsg_device *bd = file->private_data;
849 unsigned int mask = 0;
850
851 poll_wait(file, &bd->wq_done, wait);
852 poll_wait(file, &bd->wq_free, wait);
853
854 spin_lock_irq(&bd->lock);
855 if (!list_empty(&bd->done_list))
856 mask |= POLLIN | POLLRDNORM;
80ceb057 857 if (bd->queued_cmds < bd->max_queue)
3d6392cf
JA
858 mask |= POLLOUT;
859 spin_unlock_irq(&bd->lock);
860
861 return mask;
862}
863
25fd1643 864static long bsg_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
3d6392cf
JA
865{
866 struct bsg_device *bd = file->private_data;
867 int __user *uarg = (int __user *) arg;
2d507a01 868 int ret;
3d6392cf 869
3d6392cf
JA
870 switch (cmd) {
871 /*
872 * our own ioctls
873 */
874 case SG_GET_COMMAND_Q:
875 return put_user(bd->max_queue, uarg);
5309cb38 876 case SG_SET_COMMAND_Q: {
3d6392cf
JA
877 int queue;
878
879 if (get_user(queue, uarg))
880 return -EFAULT;
5309cb38 881 if (queue < 1)
3d6392cf
JA
882 return -EINVAL;
883
5309cb38 884 spin_lock_irq(&bd->lock);
3d6392cf 885 bd->max_queue = queue;
5309cb38 886 spin_unlock_irq(&bd->lock);
3d6392cf
JA
887 return 0;
888 }
889
890 /*
891 * SCSI/sg ioctls
892 */
893 case SG_GET_VERSION_NUM:
894 case SCSI_IOCTL_GET_IDLUN:
895 case SCSI_IOCTL_GET_BUS_NUMBER:
896 case SG_SET_TIMEOUT:
897 case SG_GET_TIMEOUT:
898 case SG_GET_RESERVED_SIZE:
899 case SG_SET_RESERVED_SIZE:
900 case SG_EMULATED_HOST:
3d6392cf
JA
901 case SCSI_IOCTL_SEND_COMMAND: {
902 void __user *uarg = (void __user *) arg;
74f3c8af 903 return scsi_cmd_ioctl(bd->queue, NULL, file->f_mode, cmd, uarg);
3d6392cf 904 }
10e8855b
FT
905 case SG_IO: {
906 struct request *rq;
2c9ecdf4 907 struct bio *bio, *bidi_bio = NULL;
10e8855b 908 struct sg_io_v4 hdr;
05378940 909 int at_head;
10e8855b
FT
910
911 if (copy_from_user(&hdr, uarg, sizeof(hdr)))
912 return -EFAULT;
913
82ed4db4 914 rq = bsg_map_hdr(bd, &hdr, file->f_mode & FMODE_WRITE);
10e8855b
FT
915 if (IS_ERR(rq))
916 return PTR_ERR(rq);
917
918 bio = rq->bio;
2c9ecdf4
FT
919 if (rq->next_rq)
920 bidi_bio = rq->next_rq->bio;
05378940
BH
921
922 at_head = (0 == (hdr.flags & BSG_FLAG_Q_AT_TAIL));
923 blk_execute_rq(bd->queue, NULL, rq, at_head);
2d507a01 924 ret = blk_complete_sgv4_hdr_rq(rq, &hdr, bio, bidi_bio);
10e8855b
FT
925
926 if (copy_to_user(uarg, &hdr, sizeof(hdr)))
927 return -EFAULT;
b711afa6 928
2d507a01 929 return ret;
10e8855b 930 }
3d6392cf
JA
931 /*
932 * block device ioctls
933 */
934 default:
935#if 0
936 return ioctl_by_bdev(bd->bdev, cmd, arg);
937#else
938 return -ENOTTY;
939#endif
940 }
941}
942
7344be05 943static const struct file_operations bsg_fops = {
3d6392cf
JA
944 .read = bsg_read,
945 .write = bsg_write,
946 .poll = bsg_poll,
947 .open = bsg_open,
948 .release = bsg_release,
25fd1643 949 .unlocked_ioctl = bsg_ioctl,
3d6392cf 950 .owner = THIS_MODULE,
6038f373 951 .llseek = default_llseek,
3d6392cf
JA
952};
953
d351af01 954void bsg_unregister_queue(struct request_queue *q)
3d6392cf 955{
d351af01 956 struct bsg_class_device *bcd = &q->bsg_dev;
3d6392cf 957
df468820
FT
958 if (!bcd->class_dev)
959 return;
3d6392cf
JA
960
961 mutex_lock(&bsg_mutex);
598443a2 962 idr_remove(&bsg_minor_idr, bcd->minor);
37b40adf
SG
963 if (q->kobj.sd)
964 sysfs_remove_link(&q->kobj, "bsg");
ee959b00 965 device_unregister(bcd->class_dev);
3d6392cf 966 bcd->class_dev = NULL;
97f46ae4 967 kref_put(&bcd->ref, bsg_kref_release_function);
3d6392cf
JA
968 mutex_unlock(&bsg_mutex);
969}
4cf0723a 970EXPORT_SYMBOL_GPL(bsg_unregister_queue);
3d6392cf 971
97f46ae4
FT
972int bsg_register_queue(struct request_queue *q, struct device *parent,
973 const char *name, void (*release)(struct device *))
3d6392cf 974{
598443a2 975 struct bsg_class_device *bcd;
3d6392cf 976 dev_t dev;
bab998d6 977 int ret;
ee959b00 978 struct device *class_dev = NULL;
39dca558
JB
979 const char *devname;
980
981 if (name)
982 devname = name;
983 else
3ada8b7e 984 devname = dev_name(parent);
3d6392cf
JA
985
986 /*
987 * we need a proper transport to send commands, not a stacked device
988 */
49fd524f 989 if (!queue_is_rq_based(q))
3d6392cf
JA
990 return 0;
991
d351af01 992 bcd = &q->bsg_dev;
3d6392cf 993 memset(bcd, 0, sizeof(*bcd));
3d6392cf
JA
994
995 mutex_lock(&bsg_mutex);
292b7f27 996
bab998d6
TH
997 ret = idr_alloc(&bsg_minor_idr, bcd, 0, BSG_MAX_DEVS, GFP_KERNEL);
998 if (ret < 0) {
999 if (ret == -ENOSPC) {
1000 printk(KERN_ERR "bsg: too many bsg devices\n");
1001 ret = -EINVAL;
1002 }
598443a2 1003 goto unlock;
598443a2
FT
1004 }
1005
bab998d6 1006 bcd->minor = ret;
d351af01 1007 bcd->queue = q;
97f46ae4
FT
1008 bcd->parent = get_device(parent);
1009 bcd->release = release;
1010 kref_init(&bcd->ref);
46f6ef4a 1011 dev = MKDEV(bsg_major, bcd->minor);
1ff9f542 1012 class_dev = device_create(bsg_class, parent, dev, NULL, "%s", devname);
4e2872d6
FT
1013 if (IS_ERR(class_dev)) {
1014 ret = PTR_ERR(class_dev);
598443a2 1015 goto put_dev;
4e2872d6
FT
1016 }
1017 bcd->class_dev = class_dev;
1018
abce891a 1019 if (q->kobj.sd) {
4e2872d6
FT
1020 ret = sysfs_create_link(&q->kobj, &bcd->class_dev->kobj, "bsg");
1021 if (ret)
598443a2 1022 goto unregister_class_dev;
4e2872d6
FT
1023 }
1024
3d6392cf
JA
1025 mutex_unlock(&bsg_mutex);
1026 return 0;
6826ee4f 1027
598443a2 1028unregister_class_dev:
ee959b00 1029 device_unregister(class_dev);
598443a2 1030put_dev:
97f46ae4 1031 put_device(parent);
bab998d6 1032 idr_remove(&bsg_minor_idr, bcd->minor);
598443a2 1033unlock:
264a0472 1034 mutex_unlock(&bsg_mutex);
4e2872d6
FT
1035 return ret;
1036}
4cf0723a 1037EXPORT_SYMBOL_GPL(bsg_register_queue);
4e2872d6 1038
7e7654a9 1039static struct cdev bsg_cdev;
292b7f27 1040
2c9ede55 1041static char *bsg_devnode(struct device *dev, umode_t *mode)
2bdf9149
KS
1042{
1043 return kasprintf(GFP_KERNEL, "bsg/%s", dev_name(dev));
1044}
1045
3d6392cf
JA
1046static int __init bsg_init(void)
1047{
1048 int ret, i;
46f6ef4a 1049 dev_t devid;
3d6392cf 1050
5309cb38 1051 bsg_cmd_cachep = kmem_cache_create("bsg_cmd",
20c2df83 1052 sizeof(struct bsg_command), 0, 0, NULL);
5309cb38
JA
1053 if (!bsg_cmd_cachep) {
1054 printk(KERN_ERR "bsg: failed creating slab cache\n");
1055 return -ENOMEM;
1056 }
1057
25fd1643 1058 for (i = 0; i < BSG_LIST_ARRAY_SIZE; i++)
3d6392cf
JA
1059 INIT_HLIST_HEAD(&bsg_device_list[i]);
1060
1061 bsg_class = class_create(THIS_MODULE, "bsg");
5309cb38 1062 if (IS_ERR(bsg_class)) {
9b9f770c
FT
1063 ret = PTR_ERR(bsg_class);
1064 goto destroy_kmemcache;
5309cb38 1065 }
e454cea2 1066 bsg_class->devnode = bsg_devnode;
3d6392cf 1067
46f6ef4a 1068 ret = alloc_chrdev_region(&devid, 0, BSG_MAX_DEVS, "bsg");
9b9f770c
FT
1069 if (ret)
1070 goto destroy_bsg_class;
292b7f27 1071
46f6ef4a
JA
1072 bsg_major = MAJOR(devid);
1073
292b7f27 1074 cdev_init(&bsg_cdev, &bsg_fops);
46f6ef4a 1075 ret = cdev_add(&bsg_cdev, MKDEV(bsg_major, 0), BSG_MAX_DEVS);
9b9f770c
FT
1076 if (ret)
1077 goto unregister_chrdev;
3d6392cf 1078
5d3a8cd3 1079 printk(KERN_INFO BSG_DESCRIPTION " version " BSG_VERSION
0ed081ce 1080 " loaded (major %d)\n", bsg_major);
3d6392cf 1081 return 0;
9b9f770c
FT
1082unregister_chrdev:
1083 unregister_chrdev_region(MKDEV(bsg_major, 0), BSG_MAX_DEVS);
1084destroy_bsg_class:
1085 class_destroy(bsg_class);
1086destroy_kmemcache:
1087 kmem_cache_destroy(bsg_cmd_cachep);
1088 return ret;
3d6392cf
JA
1089}
1090
1091MODULE_AUTHOR("Jens Axboe");
0ed081ce 1092MODULE_DESCRIPTION(BSG_DESCRIPTION);
3d6392cf
JA
1093MODULE_LICENSE("GPL");
1094
4e2872d6 1095device_initcall(bsg_init);