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