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