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