blob: 5f4abc902a009f5c320e0ac8b72365ba2087f353 [file] [log] [blame]
Jens Axboe3d6392c2007-07-09 12:38:05 +02001/*
2 * bsg.c - block layer implementation of the sg v3 interface
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 */
12/*
13 * TODO
14 * - Should this get merged, block/scsi_ioctl.c will be migrated into
15 * this file. To keep maintenance down, it's easier to have them
16 * seperated right now.
17 *
18 */
Jens Axboe3d6392c2007-07-09 12:38:05 +020019#include <linux/module.h>
20#include <linux/init.h>
21#include <linux/file.h>
22#include <linux/blkdev.h>
23#include <linux/poll.h>
24#include <linux/cdev.h>
25#include <linux/percpu.h>
26#include <linux/uio.h>
27#include <linux/bsg.h>
28
29#include <scsi/scsi.h>
30#include <scsi/scsi_ioctl.h>
31#include <scsi/scsi_cmnd.h>
FUJITA Tomonori4e2872d2007-03-28 13:29:24 +020032#include <scsi/scsi_device.h>
33#include <scsi/scsi_driver.h>
Jens Axboe3d6392c2007-07-09 12:38:05 +020034#include <scsi/sg.h>
35
36static char bsg_version[] = "block layer sg (bsg) 0.4";
37
Jens Axboe3d6392c2007-07-09 12:38:05 +020038struct bsg_device {
Jens Axboe3d6392c2007-07-09 12:38:05 +020039 request_queue_t *queue;
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;
45 int minor;
46 int queued_cmds;
47 int done_cmds;
Jens Axboe3d6392c2007-07-09 12:38:05 +020048 wait_queue_head_t wq_done;
49 wait_queue_head_t wq_free;
FUJITA Tomonorid351af02007-07-09 12:40:35 +020050 char name[BUS_ID_SIZE];
Jens Axboe3d6392c2007-07-09 12:38:05 +020051 int max_queue;
52 unsigned long flags;
53};
54
55enum {
56 BSG_F_BLOCK = 1,
57 BSG_F_WRITE_PERM = 2,
58};
59
Jens Axboe5309cb32007-01-23 16:24:41 +010060#define BSG_DEFAULT_CMDS 64
FUJITA Tomonori292b7f22007-03-28 13:29:58 +020061#define BSG_MAX_DEVS 32768
Jens Axboe3d6392c2007-07-09 12:38:05 +020062
63#undef BSG_DEBUG
64
65#ifdef BSG_DEBUG
66#define dprintk(fmt, args...) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ##args)
67#else
68#define dprintk(fmt, args...)
69#endif
70
71#define list_entry_bc(entry) list_entry((entry), struct bsg_command, list)
72
73/*
74 * just for testing
75 */
76#define BSG_MAJOR (240)
77
78static DEFINE_MUTEX(bsg_mutex);
FUJITA Tomonori292b7f22007-03-28 13:29:58 +020079static int bsg_device_nr, bsg_minor_idx;
Jens Axboe3d6392c2007-07-09 12:38:05 +020080
81#define BSG_LIST_SIZE (8)
82#define bsg_list_idx(minor) ((minor) & (BSG_LIST_SIZE - 1))
83static struct hlist_head bsg_device_list[BSG_LIST_SIZE];
84
85static struct class *bsg_class;
86static LIST_HEAD(bsg_class_list);
87
Jens Axboe5309cb32007-01-23 16:24:41 +010088static struct kmem_cache *bsg_cmd_cachep;
89
Jens Axboe3d6392c2007-07-09 12:38:05 +020090/*
91 * our internal command type
92 */
93struct bsg_command {
94 struct bsg_device *bd;
95 struct list_head list;
96 struct request *rq;
97 struct bio *bio;
98 int err;
FUJITA Tomonori70e36ec2006-12-20 11:20:15 +010099 struct sg_io_v4 hdr;
100 struct sg_io_v4 __user *uhdr;
Jens Axboe3d6392c2007-07-09 12:38:05 +0200101 char sense[SCSI_SENSE_BUFFERSIZE];
102};
103
104static void bsg_free_command(struct bsg_command *bc)
105{
106 struct bsg_device *bd = bc->bd;
Jens Axboe3d6392c2007-07-09 12:38:05 +0200107 unsigned long flags;
108
Jens Axboe5309cb32007-01-23 16:24:41 +0100109 kmem_cache_free(bsg_cmd_cachep, bc);
Jens Axboe3d6392c2007-07-09 12:38:05 +0200110
111 spin_lock_irqsave(&bd->lock, flags);
112 bd->queued_cmds--;
Jens Axboe3d6392c2007-07-09 12:38:05 +0200113 spin_unlock_irqrestore(&bd->lock, flags);
114
115 wake_up(&bd->wq_free);
116}
117
FUJITA Tomonorie7d72172007-05-08 15:32:03 +0200118static struct bsg_command *bsg_alloc_command(struct bsg_device *bd)
Jens Axboe3d6392c2007-07-09 12:38:05 +0200119{
FUJITA Tomonorie7d72172007-05-08 15:32:03 +0200120 struct bsg_command *bc = ERR_PTR(-EINVAL);
Jens Axboe3d6392c2007-07-09 12:38:05 +0200121
122 spin_lock_irq(&bd->lock);
123
124 if (bd->queued_cmds >= bd->max_queue)
125 goto out;
126
Jens Axboe3d6392c2007-07-09 12:38:05 +0200127 bd->queued_cmds++;
Jens Axboe3d6392c2007-07-09 12:38:05 +0200128 spin_unlock_irq(&bd->lock);
129
Jens Axboe5309cb32007-01-23 16:24:41 +0100130 bc = kmem_cache_alloc(bsg_cmd_cachep, GFP_USER);
131 if (unlikely(!bc)) {
132 spin_lock_irq(&bd->lock);
FUJITA Tomonori7e75d732007-01-24 09:05:54 +0100133 bd->queued_cmds--;
FUJITA Tomonorie7d72172007-05-08 15:32:03 +0200134 bc = ERR_PTR(-ENOMEM);
FUJITA Tomonori7e75d732007-01-24 09:05:54 +0100135 goto out;
Jens Axboe5309cb32007-01-23 16:24:41 +0100136 }
137
Jens Axboe3d6392c2007-07-09 12:38:05 +0200138 memset(bc, 0, sizeof(*bc));
139 bc->bd = bd;
140 INIT_LIST_HEAD(&bc->list);
Jens Axboe5309cb32007-01-23 16:24:41 +0100141 dprintk("%s: returning free cmd %p\n", bd->name, bc);
Jens Axboe3d6392c2007-07-09 12:38:05 +0200142 return bc;
143out:
Jens Axboe3d6392c2007-07-09 12:38:05 +0200144 spin_unlock_irq(&bd->lock);
145 return bc;
146}
147
148static inline void
149bsg_del_done_cmd(struct bsg_device *bd, struct bsg_command *bc)
150{
151 bd->done_cmds--;
152 list_del(&bc->list);
153}
154
155static inline void
156bsg_add_done_cmd(struct bsg_device *bd, struct bsg_command *bc)
157{
158 bd->done_cmds++;
159 list_add_tail(&bc->list, &bd->done_list);
160 wake_up(&bd->wq_done);
161}
162
163static inline int bsg_io_schedule(struct bsg_device *bd, int state)
164{
165 DEFINE_WAIT(wait);
166 int ret = 0;
167
168 spin_lock_irq(&bd->lock);
169
170 BUG_ON(bd->done_cmds > bd->queued_cmds);
171
172 /*
173 * -ENOSPC or -ENODATA? I'm going for -ENODATA, meaning "I have no
174 * work to do", even though we return -ENOSPC after this same test
175 * during bsg_write() -- there, it means our buffer can't have more
176 * bsg_commands added to it, thus has no space left.
177 */
178 if (bd->done_cmds == bd->queued_cmds) {
179 ret = -ENODATA;
180 goto unlock;
181 }
182
183 if (!test_bit(BSG_F_BLOCK, &bd->flags)) {
184 ret = -EAGAIN;
185 goto unlock;
186 }
187
188 prepare_to_wait(&bd->wq_done, &wait, state);
189 spin_unlock_irq(&bd->lock);
190 io_schedule();
191 finish_wait(&bd->wq_done, &wait);
192
193 if ((state == TASK_INTERRUPTIBLE) && signal_pending(current))
194 ret = -ERESTARTSYS;
195
196 return ret;
197unlock:
198 spin_unlock_irq(&bd->lock);
199 return ret;
200}
201
FUJITA Tomonori70e36ec2006-12-20 11:20:15 +0100202static int blk_fill_sgv4_hdr_rq(request_queue_t *q, struct request *rq,
203 struct sg_io_v4 *hdr, int has_write_perm)
Jens Axboe3d6392c2007-07-09 12:38:05 +0200204{
FUJITA Tomonori70e36ec2006-12-20 11:20:15 +0100205 memset(rq->cmd, 0, BLK_MAX_CDB); /* ATAPI hates garbage after CDB */
206
207 if (copy_from_user(rq->cmd, (void *)(unsigned long)hdr->request,
208 hdr->request_len))
209 return -EFAULT;
210 if (blk_verify_command(rq->cmd, has_write_perm))
211 return -EPERM;
Jens Axboe3d6392c2007-07-09 12:38:05 +0200212
213 /*
FUJITA Tomonori70e36ec2006-12-20 11:20:15 +0100214 * fill in request structure
Jens Axboe3d6392c2007-07-09 12:38:05 +0200215 */
FUJITA Tomonori70e36ec2006-12-20 11:20:15 +0100216 rq->cmd_len = hdr->request_len;
217 rq->cmd_type = REQ_TYPE_BLOCK_PC;
Jens Axboe3d6392c2007-07-09 12:38:05 +0200218
FUJITA Tomonori70e36ec2006-12-20 11:20:15 +0100219 rq->timeout = (hdr->timeout * HZ) / 1000;
220 if (!rq->timeout)
221 rq->timeout = q->sg_timeout;
222 if (!rq->timeout)
223 rq->timeout = BLK_DEFAULT_SG_TIMEOUT;
Jens Axboe3d6392c2007-07-09 12:38:05 +0200224
225 return 0;
226}
227
228/*
FUJITA Tomonori70e36ec2006-12-20 11:20:15 +0100229 * Check if sg_io_v4 from user is allowed and valid
230 */
231static int
232bsg_validate_sgv4_hdr(request_queue_t *q, struct sg_io_v4 *hdr, int *rw)
233{
234 if (hdr->guard != 'Q')
235 return -EINVAL;
236 if (hdr->request_len > BLK_MAX_CDB)
237 return -EINVAL;
238 if (hdr->dout_xfer_len > (q->max_sectors << 9) ||
239 hdr->din_xfer_len > (q->max_sectors << 9))
240 return -EIO;
241
242 /* not supported currently */
243 if (hdr->protocol || hdr->subprotocol)
244 return -EINVAL;
245
246 /*
247 * looks sane, if no data then it should be fine from our POV
248 */
249 if (!hdr->dout_xfer_len && !hdr->din_xfer_len)
250 return 0;
251
252 /* not supported currently */
253 if (hdr->dout_xfer_len && hdr->din_xfer_len)
254 return -EINVAL;
255
256 *rw = hdr->dout_xfer_len ? WRITE : READ;
257
258 return 0;
259}
260
261/*
262 * map sg_io_v4 to a request.
Jens Axboe3d6392c2007-07-09 12:38:05 +0200263 */
264static struct request *
FUJITA Tomonori70e36ec2006-12-20 11:20:15 +0100265bsg_map_hdr(struct bsg_device *bd, struct sg_io_v4 *hdr)
Jens Axboe3d6392c2007-07-09 12:38:05 +0200266{
267 request_queue_t *q = bd->queue;
Jens Axboe3d6392c2007-07-09 12:38:05 +0200268 struct request *rq;
Jens Axboe2ef70862006-12-20 11:26:11 +0100269 int ret, rw = 0; /* shut up gcc */
FUJITA Tomonori70e36ec2006-12-20 11:20:15 +0100270 unsigned int dxfer_len;
271 void *dxferp = NULL;
Jens Axboe3d6392c2007-07-09 12:38:05 +0200272
FUJITA Tomonori70e36ec2006-12-20 11:20:15 +0100273 dprintk("map hdr %llx/%u %llx/%u\n", (unsigned long long) hdr->dout_xferp,
274 hdr->dout_xfer_len, (unsigned long long) hdr->din_xferp,
275 hdr->din_xfer_len);
Jens Axboe3d6392c2007-07-09 12:38:05 +0200276
FUJITA Tomonori70e36ec2006-12-20 11:20:15 +0100277 ret = bsg_validate_sgv4_hdr(q, hdr, &rw);
Jens Axboe3d6392c2007-07-09 12:38:05 +0200278 if (ret)
279 return ERR_PTR(ret);
280
281 /*
282 * map scatter-gather elements seperately and string them to request
283 */
284 rq = blk_get_request(q, rw, GFP_KERNEL);
FUJITA Tomonori70e36ec2006-12-20 11:20:15 +0100285 ret = blk_fill_sgv4_hdr_rq(q, rq, hdr, test_bit(BSG_F_WRITE_PERM,
286 &bd->flags));
Jens Axboe3d6392c2007-07-09 12:38:05 +0200287 if (ret) {
288 blk_put_request(rq);
289 return ERR_PTR(ret);
290 }
291
FUJITA Tomonori70e36ec2006-12-20 11:20:15 +0100292 if (hdr->dout_xfer_len) {
293 dxfer_len = hdr->dout_xfer_len;
294 dxferp = (void*)(unsigned long)hdr->dout_xferp;
295 } else if (hdr->din_xfer_len) {
296 dxfer_len = hdr->din_xfer_len;
297 dxferp = (void*)(unsigned long)hdr->din_xferp;
298 } else
299 dxfer_len = 0;
Jens Axboe3d6392c2007-07-09 12:38:05 +0200300
FUJITA Tomonori70e36ec2006-12-20 11:20:15 +0100301 if (dxfer_len) {
302 ret = blk_rq_map_user(q, rq, dxferp, dxfer_len);
303 if (ret) {
304 dprintk("failed map at %d\n", ret);
305 blk_put_request(rq);
306 rq = ERR_PTR(ret);
Jens Axboe3d6392c2007-07-09 12:38:05 +0200307 }
Jens Axboe3d6392c2007-07-09 12:38:05 +0200308 }
309
310 return rq;
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
Jens Axboe5309cb32007-01-23 16:24:41 +0100323 dprintk("%s: finished rq %p bc %p, bio %p stat %d\n",
324 bd->name, rq, bc, bc->bio, uptodate);
Jens Axboe3d6392c2007-07-09 12:38:05 +0200325
326 bc->hdr.duration = jiffies_to_msecs(jiffies - bc->hdr.duration);
327
328 spin_lock_irqsave(&bd->lock, flags);
329 list_del(&bc->list);
330 bsg_add_done_cmd(bd, bc);
331 spin_unlock_irqrestore(&bd->lock, flags);
332}
333
334/*
335 * do final setup of a 'bc' and submit the matching 'rq' to the block
336 * layer for io
337 */
338static void bsg_add_command(struct bsg_device *bd, request_queue_t *q,
339 struct bsg_command *bc, struct request *rq)
340{
341 rq->sense = bc->sense;
342 rq->sense_len = 0;
343
344 /*
345 * add bc command to busy queue and submit rq for io
346 */
347 bc->rq = rq;
348 bc->bio = rq->bio;
349 bc->hdr.duration = jiffies;
350 spin_lock_irq(&bd->lock);
351 list_add_tail(&bc->list, &bd->busy_list);
352 spin_unlock_irq(&bd->lock);
353
354 dprintk("%s: queueing rq %p, bc %p\n", bd->name, rq, bc);
355
356 rq->end_io_data = bc;
FUJITA Tomonorid351af02007-07-09 12:40:35 +0200357 blk_execute_rq_nowait(q, NULL, rq, 1, bsg_rq_end_io);
Jens Axboe3d6392c2007-07-09 12:38:05 +0200358}
359
360static inline struct bsg_command *bsg_next_done_cmd(struct bsg_device *bd)
361{
362 struct bsg_command *bc = NULL;
363
364 spin_lock_irq(&bd->lock);
365 if (bd->done_cmds) {
366 bc = list_entry_bc(bd->done_list.next);
367 bsg_del_done_cmd(bd, bc);
368 }
369 spin_unlock_irq(&bd->lock);
370
371 return bc;
372}
373
374/*
375 * Get a finished command from the done list
376 */
FUJITA Tomonorie7d72172007-05-08 15:32:03 +0200377static struct bsg_command *bsg_get_done_cmd(struct bsg_device *bd)
Jens Axboe3d6392c2007-07-09 12:38:05 +0200378{
379 struct bsg_command *bc;
380 int ret;
381
382 do {
383 bc = bsg_next_done_cmd(bd);
384 if (bc)
385 break;
386
FUJITA Tomonorie7d72172007-05-08 15:32:03 +0200387 if (!test_bit(BSG_F_BLOCK, &bd->flags)) {
388 bc = ERR_PTR(-EAGAIN);
389 break;
390 }
391
392 ret = wait_event_interruptible(bd->wq_done, bd->done_cmds);
Jens Axboe3d6392c2007-07-09 12:38:05 +0200393 if (ret) {
FUJITA Tomonorie7d72172007-05-08 15:32:03 +0200394 bc = ERR_PTR(-ERESTARTSYS);
Jens Axboe3d6392c2007-07-09 12:38:05 +0200395 break;
396 }
397 } while (1);
398
399 dprintk("%s: returning done %p\n", bd->name, bc);
400
401 return bc;
402}
403
FUJITA Tomonori70e36ec2006-12-20 11:20:15 +0100404static int blk_complete_sgv4_hdr_rq(struct request *rq, struct sg_io_v4 *hdr,
405 struct bio *bio)
406{
407 int ret = 0;
408
409 dprintk("rq %p bio %p %u\n", rq, bio, rq->errors);
410 /*
411 * fill in all the output members
412 */
413 hdr->device_status = status_byte(rq->errors);
414 hdr->transport_status = host_byte(rq->errors);
415 hdr->driver_status = driver_byte(rq->errors);
416 hdr->info = 0;
417 if (hdr->device_status || hdr->transport_status || hdr->driver_status)
418 hdr->info |= SG_INFO_CHECK;
419 hdr->din_resid = rq->data_len;
420 hdr->response_len = 0;
421
422 if (rq->sense_len && hdr->response) {
423 int len = min((unsigned int) hdr->max_response_len,
424 rq->sense_len);
425
426 ret = copy_to_user((void*)(unsigned long)hdr->response,
427 rq->sense, len);
428 if (!ret)
429 hdr->response_len = len;
430 else
431 ret = -EFAULT;
432 }
433
434 blk_rq_unmap_user(bio);
435 blk_put_request(rq);
436
437 return ret;
438}
439
Jens Axboe3d6392c2007-07-09 12:38:05 +0200440static int bsg_complete_all_commands(struct bsg_device *bd)
441{
442 struct bsg_command *bc;
443 int ret, tret;
444
445 dprintk("%s: entered\n", bd->name);
446
447 set_bit(BSG_F_BLOCK, &bd->flags);
448
449 /*
450 * wait for all commands to complete
451 */
452 ret = 0;
453 do {
454 ret = bsg_io_schedule(bd, TASK_UNINTERRUPTIBLE);
455 /*
456 * look for -ENODATA specifically -- we'll sometimes get
457 * -ERESTARTSYS when we've taken a signal, but we can't
458 * return until we're done freeing the queue, so ignore
459 * it. The signal will get handled when we're done freeing
460 * the bsg_device.
461 */
462 } while (ret != -ENODATA);
463
464 /*
465 * discard done commands
466 */
467 ret = 0;
468 do {
FUJITA Tomonorie7d72172007-05-08 15:32:03 +0200469 spin_lock_irq(&bd->lock);
470 if (!bd->queued_cmds) {
471 spin_unlock_irq(&bd->lock);
Jens Axboe3d6392c2007-07-09 12:38:05 +0200472 break;
473 }
FUJITA Tomonoriefba1a32007-06-07 13:24:06 +0200474 spin_unlock_irq(&bd->lock);
Jens Axboe3d6392c2007-07-09 12:38:05 +0200475
FUJITA Tomonorie7d72172007-05-08 15:32:03 +0200476 bc = bsg_get_done_cmd(bd);
477 if (IS_ERR(bc))
478 break;
479
FUJITA Tomonori70e36ec2006-12-20 11:20:15 +0100480 tret = blk_complete_sgv4_hdr_rq(bc->rq, &bc->hdr, bc->bio);
Jens Axboe3d6392c2007-07-09 12:38:05 +0200481 if (!ret)
482 ret = tret;
483
484 bsg_free_command(bc);
485 } while (1);
486
487 return ret;
488}
489
Jens Axboe3d6392c2007-07-09 12:38:05 +0200490static ssize_t
FUJITA Tomonorie7d72172007-05-08 15:32:03 +0200491__bsg_read(char __user *buf, size_t count, struct bsg_device *bd,
492 const struct iovec *iov, ssize_t *bytes_read)
Jens Axboe3d6392c2007-07-09 12:38:05 +0200493{
494 struct bsg_command *bc;
495 int nr_commands, ret;
496
FUJITA Tomonori70e36ec2006-12-20 11:20:15 +0100497 if (count % sizeof(struct sg_io_v4))
Jens Axboe3d6392c2007-07-09 12:38:05 +0200498 return -EINVAL;
499
500 ret = 0;
FUJITA Tomonori70e36ec2006-12-20 11:20:15 +0100501 nr_commands = count / sizeof(struct sg_io_v4);
Jens Axboe3d6392c2007-07-09 12:38:05 +0200502 while (nr_commands) {
FUJITA Tomonorie7d72172007-05-08 15:32:03 +0200503 bc = bsg_get_done_cmd(bd);
Jens Axboe3d6392c2007-07-09 12:38:05 +0200504 if (IS_ERR(bc)) {
505 ret = PTR_ERR(bc);
506 break;
507 }
508
509 /*
510 * this is the only case where we need to copy data back
511 * after completing the request. so do that here,
512 * bsg_complete_work() cannot do that for us
513 */
FUJITA Tomonori70e36ec2006-12-20 11:20:15 +0100514 ret = blk_complete_sgv4_hdr_rq(bc->rq, &bc->hdr, bc->bio);
Jens Axboe3d6392c2007-07-09 12:38:05 +0200515
516 if (copy_to_user(buf, (char *) &bc->hdr, sizeof(bc->hdr)))
517 ret = -EFAULT;
518
519 bsg_free_command(bc);
520
521 if (ret)
522 break;
523
FUJITA Tomonori70e36ec2006-12-20 11:20:15 +0100524 buf += sizeof(struct sg_io_v4);
525 *bytes_read += sizeof(struct sg_io_v4);
Jens Axboe3d6392c2007-07-09 12:38:05 +0200526 nr_commands--;
527 }
528
529 return ret;
530}
531
532static inline void bsg_set_block(struct bsg_device *bd, struct file *file)
533{
534 if (file->f_flags & O_NONBLOCK)
535 clear_bit(BSG_F_BLOCK, &bd->flags);
536 else
537 set_bit(BSG_F_BLOCK, &bd->flags);
538}
539
540static inline void bsg_set_write_perm(struct bsg_device *bd, struct file *file)
541{
542 if (file->f_mode & FMODE_WRITE)
543 set_bit(BSG_F_WRITE_PERM, &bd->flags);
544 else
545 clear_bit(BSG_F_WRITE_PERM, &bd->flags);
546}
547
548static inline int err_block_err(int ret)
549{
550 if (ret && ret != -ENOSPC && ret != -ENODATA && ret != -EAGAIN)
551 return 1;
552
553 return 0;
554}
555
556static ssize_t
557bsg_read(struct file *file, char __user *buf, size_t count, loff_t *ppos)
558{
559 struct bsg_device *bd = file->private_data;
560 int ret;
561 ssize_t bytes_read;
562
FUJITA Tomonori9e69fbb2006-12-20 11:18:22 +0100563 dprintk("%s: read %Zd bytes\n", bd->name, count);
Jens Axboe3d6392c2007-07-09 12:38:05 +0200564
565 bsg_set_block(bd, file);
566 bytes_read = 0;
FUJITA Tomonorie7d72172007-05-08 15:32:03 +0200567 ret = __bsg_read(buf, count, bd, NULL, &bytes_read);
Jens Axboe3d6392c2007-07-09 12:38:05 +0200568 *ppos = bytes_read;
569
570 if (!bytes_read || (bytes_read && err_block_err(ret)))
571 bytes_read = ret;
572
573 return bytes_read;
574}
575
576static ssize_t __bsg_write(struct bsg_device *bd, const char __user *buf,
577 size_t count, ssize_t *bytes_read)
578{
579 struct bsg_command *bc;
580 struct request *rq;
581 int ret, nr_commands;
582
FUJITA Tomonori70e36ec2006-12-20 11:20:15 +0100583 if (count % sizeof(struct sg_io_v4))
Jens Axboe3d6392c2007-07-09 12:38:05 +0200584 return -EINVAL;
585
FUJITA Tomonori70e36ec2006-12-20 11:20:15 +0100586 nr_commands = count / sizeof(struct sg_io_v4);
Jens Axboe3d6392c2007-07-09 12:38:05 +0200587 rq = NULL;
588 bc = NULL;
589 ret = 0;
590 while (nr_commands) {
591 request_queue_t *q = bd->queue;
Jens Axboe3d6392c2007-07-09 12:38:05 +0200592
FUJITA Tomonorie7d72172007-05-08 15:32:03 +0200593 bc = bsg_alloc_command(bd);
Jens Axboe3d6392c2007-07-09 12:38:05 +0200594 if (IS_ERR(bc)) {
595 ret = PTR_ERR(bc);
596 bc = NULL;
597 break;
598 }
599
FUJITA Tomonori70e36ec2006-12-20 11:20:15 +0100600 bc->uhdr = (struct sg_io_v4 __user *) buf;
Jens Axboe3d6392c2007-07-09 12:38:05 +0200601 if (copy_from_user(&bc->hdr, buf, sizeof(bc->hdr))) {
602 ret = -EFAULT;
603 break;
604 }
605
606 /*
607 * get a request, fill in the blanks, and add to request queue
608 */
FUJITA Tomonori70e36ec2006-12-20 11:20:15 +0100609 rq = bsg_map_hdr(bd, &bc->hdr);
Jens Axboe3d6392c2007-07-09 12:38:05 +0200610 if (IS_ERR(rq)) {
611 ret = PTR_ERR(rq);
612 rq = NULL;
613 break;
614 }
615
616 bsg_add_command(bd, q, bc, rq);
617 bc = NULL;
618 rq = NULL;
619 nr_commands--;
FUJITA Tomonori70e36ec2006-12-20 11:20:15 +0100620 buf += sizeof(struct sg_io_v4);
621 *bytes_read += sizeof(struct sg_io_v4);
Jens Axboe3d6392c2007-07-09 12:38:05 +0200622 }
623
Jens Axboe3d6392c2007-07-09 12:38:05 +0200624 if (bc)
625 bsg_free_command(bc);
626
627 return ret;
628}
629
630static ssize_t
631bsg_write(struct file *file, const char __user *buf, size_t count, loff_t *ppos)
632{
633 struct bsg_device *bd = file->private_data;
634 ssize_t bytes_read;
635 int ret;
636
FUJITA Tomonori9e69fbb2006-12-20 11:18:22 +0100637 dprintk("%s: write %Zd bytes\n", bd->name, count);
Jens Axboe3d6392c2007-07-09 12:38:05 +0200638
639 bsg_set_block(bd, file);
640 bsg_set_write_perm(bd, file);
641
642 bytes_read = 0;
643 ret = __bsg_write(bd, buf, count, &bytes_read);
644 *ppos = bytes_read;
645
646 /*
647 * return bytes written on non-fatal errors
648 */
649 if (!bytes_read || (bytes_read && err_block_err(ret)))
650 bytes_read = ret;
651
FUJITA Tomonori9e69fbb2006-12-20 11:18:22 +0100652 dprintk("%s: returning %Zd\n", bd->name, bytes_read);
Jens Axboe3d6392c2007-07-09 12:38:05 +0200653 return bytes_read;
654}
655
Jens Axboe3d6392c2007-07-09 12:38:05 +0200656static struct bsg_device *bsg_alloc_device(void)
657{
Jens Axboe3d6392c2007-07-09 12:38:05 +0200658 struct bsg_device *bd;
Jens Axboe3d6392c2007-07-09 12:38:05 +0200659
660 bd = kzalloc(sizeof(struct bsg_device), GFP_KERNEL);
661 if (unlikely(!bd))
662 return NULL;
663
664 spin_lock_init(&bd->lock);
665
Jens Axboe5309cb32007-01-23 16:24:41 +0100666 bd->max_queue = BSG_DEFAULT_CMDS;
Jens Axboe3d6392c2007-07-09 12:38:05 +0200667
668 INIT_LIST_HEAD(&bd->busy_list);
669 INIT_LIST_HEAD(&bd->done_list);
670 INIT_HLIST_NODE(&bd->dev_list);
671
672 init_waitqueue_head(&bd->wq_free);
673 init_waitqueue_head(&bd->wq_done);
674 return bd;
Jens Axboe3d6392c2007-07-09 12:38:05 +0200675}
676
677static int bsg_put_device(struct bsg_device *bd)
678{
679 int ret = 0;
680
681 mutex_lock(&bsg_mutex);
682
683 if (!atomic_dec_and_test(&bd->ref_count))
684 goto out;
685
686 dprintk("%s: tearing down\n", bd->name);
687
688 /*
689 * close can always block
690 */
691 set_bit(BSG_F_BLOCK, &bd->flags);
692
693 /*
694 * correct error detection baddies here again. it's the responsibility
695 * of the app to properly reap commands before close() if it wants
696 * fool-proof error detection
697 */
698 ret = bsg_complete_all_commands(bd);
699
700 blk_put_queue(bd->queue);
701 hlist_del(&bd->dev_list);
Jens Axboe5309cb32007-01-23 16:24:41 +0100702 kfree(bd);
Jens Axboe3d6392c2007-07-09 12:38:05 +0200703out:
704 mutex_unlock(&bsg_mutex);
705 return ret;
706}
707
708static struct bsg_device *bsg_add_device(struct inode *inode,
FUJITA Tomonorid351af02007-07-09 12:40:35 +0200709 struct request_queue *rq,
Jens Axboe3d6392c2007-07-09 12:38:05 +0200710 struct file *file)
711{
712 struct bsg_device *bd = NULL;
713#ifdef BSG_DEBUG
714 unsigned char buf[32];
715#endif
716
717 bd = bsg_alloc_device();
718 if (!bd)
719 return ERR_PTR(-ENOMEM);
720
FUJITA Tomonorid351af02007-07-09 12:40:35 +0200721 bd->queue = rq;
722 kobject_get(&rq->kobj);
Jens Axboe3d6392c2007-07-09 12:38:05 +0200723 bsg_set_block(bd, file);
724
725 atomic_set(&bd->ref_count, 1);
726 bd->minor = iminor(inode);
727 mutex_lock(&bsg_mutex);
FUJITA Tomonorid351af02007-07-09 12:40:35 +0200728 hlist_add_head(&bd->dev_list, &bsg_device_list[bsg_list_idx(bd->minor)]);
Jens Axboe3d6392c2007-07-09 12:38:05 +0200729
FUJITA Tomonorid351af02007-07-09 12:40:35 +0200730 strncpy(bd->name, rq->bsg_dev.class_dev->class_id, sizeof(bd->name) - 1);
Jens Axboe3d6392c2007-07-09 12:38:05 +0200731 dprintk("bound to <%s>, max queue %d\n",
FUJITA Tomonori9e69fbb2006-12-20 11:18:22 +0100732 format_dev_t(buf, inode->i_rdev), bd->max_queue);
Jens Axboe3d6392c2007-07-09 12:38:05 +0200733
734 mutex_unlock(&bsg_mutex);
735 return bd;
736}
737
738static struct bsg_device *__bsg_get_device(int minor)
739{
740 struct hlist_head *list = &bsg_device_list[bsg_list_idx(minor)];
741 struct bsg_device *bd = NULL;
742 struct hlist_node *entry;
743
744 mutex_lock(&bsg_mutex);
745
746 hlist_for_each(entry, list) {
747 bd = hlist_entry(entry, struct bsg_device, dev_list);
748 if (bd->minor == minor) {
749 atomic_inc(&bd->ref_count);
750 break;
751 }
752
753 bd = NULL;
754 }
755
756 mutex_unlock(&bsg_mutex);
757 return bd;
758}
759
760static struct bsg_device *bsg_get_device(struct inode *inode, struct file *file)
761{
762 struct bsg_device *bd = __bsg_get_device(iminor(inode));
763 struct bsg_class_device *bcd, *__bcd;
764
765 if (bd)
766 return bd;
767
768 /*
769 * find the class device
770 */
771 bcd = NULL;
772 mutex_lock(&bsg_mutex);
773 list_for_each_entry(__bcd, &bsg_class_list, list) {
774 if (__bcd->minor == iminor(inode)) {
775 bcd = __bcd;
776 break;
777 }
778 }
779 mutex_unlock(&bsg_mutex);
780
781 if (!bcd)
782 return ERR_PTR(-ENODEV);
783
FUJITA Tomonorid351af02007-07-09 12:40:35 +0200784 return bsg_add_device(inode, bcd->queue, file);
Jens Axboe3d6392c2007-07-09 12:38:05 +0200785}
786
787static int bsg_open(struct inode *inode, struct file *file)
788{
789 struct bsg_device *bd = bsg_get_device(inode, file);
790
791 if (IS_ERR(bd))
792 return PTR_ERR(bd);
793
794 file->private_data = bd;
795 return 0;
796}
797
798static int bsg_release(struct inode *inode, struct file *file)
799{
800 struct bsg_device *bd = file->private_data;
801
802 file->private_data = NULL;
803 return bsg_put_device(bd);
804}
805
806static unsigned int bsg_poll(struct file *file, poll_table *wait)
807{
808 struct bsg_device *bd = file->private_data;
809 unsigned int mask = 0;
810
811 poll_wait(file, &bd->wq_done, wait);
812 poll_wait(file, &bd->wq_free, wait);
813
814 spin_lock_irq(&bd->lock);
815 if (!list_empty(&bd->done_list))
816 mask |= POLLIN | POLLRDNORM;
817 if (bd->queued_cmds >= bd->max_queue)
818 mask |= POLLOUT;
819 spin_unlock_irq(&bd->lock);
820
821 return mask;
822}
823
824static int
825bsg_ioctl(struct inode *inode, struct file *file, unsigned int cmd,
826 unsigned long arg)
827{
828 struct bsg_device *bd = file->private_data;
829 int __user *uarg = (int __user *) arg;
830
831 if (!bd)
832 return -ENXIO;
833
834 switch (cmd) {
835 /*
836 * our own ioctls
837 */
838 case SG_GET_COMMAND_Q:
839 return put_user(bd->max_queue, uarg);
Jens Axboe5309cb32007-01-23 16:24:41 +0100840 case SG_SET_COMMAND_Q: {
Jens Axboe3d6392c2007-07-09 12:38:05 +0200841 int queue;
842
843 if (get_user(queue, uarg))
844 return -EFAULT;
Jens Axboe5309cb32007-01-23 16:24:41 +0100845 if (queue < 1)
Jens Axboe3d6392c2007-07-09 12:38:05 +0200846 return -EINVAL;
847
Jens Axboe5309cb32007-01-23 16:24:41 +0100848 spin_lock_irq(&bd->lock);
Jens Axboe3d6392c2007-07-09 12:38:05 +0200849 bd->max_queue = queue;
Jens Axboe5309cb32007-01-23 16:24:41 +0100850 spin_unlock_irq(&bd->lock);
Jens Axboe3d6392c2007-07-09 12:38:05 +0200851 return 0;
852 }
853
854 /*
855 * SCSI/sg ioctls
856 */
857 case SG_GET_VERSION_NUM:
858 case SCSI_IOCTL_GET_IDLUN:
859 case SCSI_IOCTL_GET_BUS_NUMBER:
860 case SG_SET_TIMEOUT:
861 case SG_GET_TIMEOUT:
862 case SG_GET_RESERVED_SIZE:
863 case SG_SET_RESERVED_SIZE:
864 case SG_EMULATED_HOST:
Jens Axboe3d6392c2007-07-09 12:38:05 +0200865 case SCSI_IOCTL_SEND_COMMAND: {
866 void __user *uarg = (void __user *) arg;
FUJITA Tomonorid351af02007-07-09 12:40:35 +0200867 return scsi_cmd_ioctl(file, bd->queue, NULL, cmd, uarg);
Jens Axboe3d6392c2007-07-09 12:38:05 +0200868 }
FUJITA Tomonori10e88552006-12-20 11:20:57 +0100869 case SG_IO: {
870 struct request *rq;
871 struct bio *bio;
872 struct sg_io_v4 hdr;
873
874 if (copy_from_user(&hdr, uarg, sizeof(hdr)))
875 return -EFAULT;
876
877 rq = bsg_map_hdr(bd, &hdr);
878 if (IS_ERR(rq))
879 return PTR_ERR(rq);
880
881 bio = rq->bio;
FUJITA Tomonorid351af02007-07-09 12:40:35 +0200882 blk_execute_rq(bd->queue, NULL, rq, 0);
FUJITA Tomonori10e88552006-12-20 11:20:57 +0100883 blk_complete_sgv4_hdr_rq(rq, &hdr, bio);
884
885 if (copy_to_user(uarg, &hdr, sizeof(hdr)))
886 return -EFAULT;
Jens Axboeb711afa2006-12-20 11:25:23 +0100887
888 return 0;
FUJITA Tomonori10e88552006-12-20 11:20:57 +0100889 }
Jens Axboe3d6392c2007-07-09 12:38:05 +0200890 /*
891 * block device ioctls
892 */
893 default:
894#if 0
895 return ioctl_by_bdev(bd->bdev, cmd, arg);
896#else
897 return -ENOTTY;
898#endif
899 }
900}
901
902static struct file_operations bsg_fops = {
903 .read = bsg_read,
904 .write = bsg_write,
905 .poll = bsg_poll,
906 .open = bsg_open,
907 .release = bsg_release,
908 .ioctl = bsg_ioctl,
909 .owner = THIS_MODULE,
910};
911
FUJITA Tomonorid351af02007-07-09 12:40:35 +0200912void bsg_unregister_queue(struct request_queue *q)
Jens Axboe3d6392c2007-07-09 12:38:05 +0200913{
FUJITA Tomonorid351af02007-07-09 12:40:35 +0200914 struct bsg_class_device *bcd = &q->bsg_dev;
Jens Axboe3d6392c2007-07-09 12:38:05 +0200915
916 if (!bcd->class_dev)
917 return;
918
919 mutex_lock(&bsg_mutex);
FUJITA Tomonorid351af02007-07-09 12:40:35 +0200920 sysfs_remove_link(&q->kobj, "bsg");
Jens Axboe3d6392c2007-07-09 12:38:05 +0200921 class_device_destroy(bsg_class, MKDEV(BSG_MAJOR, bcd->minor));
922 bcd->class_dev = NULL;
923 list_del_init(&bcd->list);
FUJITA Tomonori292b7f22007-03-28 13:29:58 +0200924 bsg_device_nr--;
Jens Axboe3d6392c2007-07-09 12:38:05 +0200925 mutex_unlock(&bsg_mutex);
926}
FUJITA Tomonori4cf07232007-03-30 11:19:39 +0200927EXPORT_SYMBOL_GPL(bsg_unregister_queue);
Jens Axboe3d6392c2007-07-09 12:38:05 +0200928
FUJITA Tomonori4cf07232007-03-30 11:19:39 +0200929int bsg_register_queue(struct request_queue *q, const char *name)
Jens Axboe3d6392c2007-07-09 12:38:05 +0200930{
FUJITA Tomonori292b7f22007-03-28 13:29:58 +0200931 struct bsg_class_device *bcd, *__bcd;
Jens Axboe3d6392c2007-07-09 12:38:05 +0200932 dev_t dev;
FUJITA Tomonori292b7f22007-03-28 13:29:58 +0200933 int ret = -EMFILE;
FUJITA Tomonori4e2872d2007-03-28 13:29:24 +0200934 struct class_device *class_dev = NULL;
Jens Axboe3d6392c2007-07-09 12:38:05 +0200935
936 /*
937 * we need a proper transport to send commands, not a stacked device
938 */
939 if (!q->request_fn)
940 return 0;
941
FUJITA Tomonorid351af02007-07-09 12:40:35 +0200942 bcd = &q->bsg_dev;
Jens Axboe3d6392c2007-07-09 12:38:05 +0200943 memset(bcd, 0, sizeof(*bcd));
944 INIT_LIST_HEAD(&bcd->list);
945
946 mutex_lock(&bsg_mutex);
FUJITA Tomonori292b7f22007-03-28 13:29:58 +0200947 if (bsg_device_nr == BSG_MAX_DEVS) {
948 printk(KERN_ERR "bsg: too many bsg devices\n");
949 goto err;
950 }
951
952retry:
953 list_for_each_entry(__bcd, &bsg_class_list, list) {
954 if (__bcd->minor == bsg_minor_idx) {
955 bsg_minor_idx++;
956 if (bsg_minor_idx == BSG_MAX_DEVS)
957 bsg_minor_idx = 0;
958 goto retry;
959 }
960 }
961
962 bcd->minor = bsg_minor_idx++;
963 if (bsg_minor_idx == BSG_MAX_DEVS)
964 bsg_minor_idx = 0;
965
FUJITA Tomonorid351af02007-07-09 12:40:35 +0200966 bcd->queue = q;
FUJITA Tomonori292b7f22007-03-28 13:29:58 +0200967 dev = MKDEV(BSG_MAJOR, bcd->minor);
FUJITA Tomonori4e2872d2007-03-28 13:29:24 +0200968 class_dev = class_device_create(bsg_class, NULL, dev, bcd->dev, "%s", name);
969 if (IS_ERR(class_dev)) {
970 ret = PTR_ERR(class_dev);
Jens Axboe264a0472007-01-23 16:30:17 +0100971 goto err;
FUJITA Tomonori4e2872d2007-03-28 13:29:24 +0200972 }
973 bcd->class_dev = class_dev;
974
975 if (q->kobj.dentry) {
976 ret = sysfs_create_link(&q->kobj, &bcd->class_dev->kobj, "bsg");
977 if (ret)
978 goto err;
979 }
980
Jens Axboe3d6392c2007-07-09 12:38:05 +0200981 list_add_tail(&bcd->list, &bsg_class_list);
FUJITA Tomonori292b7f22007-03-28 13:29:58 +0200982 bsg_device_nr++;
FUJITA Tomonori4e2872d2007-03-28 13:29:24 +0200983
Jens Axboe3d6392c2007-07-09 12:38:05 +0200984 mutex_unlock(&bsg_mutex);
985 return 0;
Jens Axboe264a0472007-01-23 16:30:17 +0100986err:
FUJITA Tomonori4e2872d2007-03-28 13:29:24 +0200987 if (class_dev)
Jens Axboe264a0472007-01-23 16:30:17 +0100988 class_device_destroy(bsg_class, MKDEV(BSG_MAJOR, bcd->minor));
989 mutex_unlock(&bsg_mutex);
FUJITA Tomonori4e2872d2007-03-28 13:29:24 +0200990 return ret;
Jens Axboe3d6392c2007-07-09 12:38:05 +0200991}
FUJITA Tomonori4cf07232007-03-30 11:19:39 +0200992EXPORT_SYMBOL_GPL(bsg_register_queue);
Jens Axboe3d6392c2007-07-09 12:38:05 +0200993
FUJITA Tomonori4e2872d2007-03-28 13:29:24 +0200994static int bsg_add(struct class_device *cl_dev, struct class_interface *cl_intf)
995{
996 int ret;
997 struct scsi_device *sdp = to_scsi_device(cl_dev->dev);
998 struct request_queue *rq = sdp->request_queue;
999
1000 if (rq->kobj.parent)
1001 ret = bsg_register_queue(rq, kobject_name(rq->kobj.parent));
1002 else
1003 ret = bsg_register_queue(rq, kobject_name(&sdp->sdev_gendev.kobj));
1004 return ret;
1005}
1006
1007static void bsg_remove(struct class_device *cl_dev, struct class_interface *cl_intf)
1008{
1009 bsg_unregister_queue(to_scsi_device(cl_dev->dev)->request_queue);
1010}
1011
1012static struct class_interface bsg_intf = {
1013 .add = bsg_add,
1014 .remove = bsg_remove,
1015};
1016
FUJITA Tomonori292b7f22007-03-28 13:29:58 +02001017static struct cdev bsg_cdev = {
1018 .kobj = {.name = "bsg", },
1019 .owner = THIS_MODULE,
1020};
1021
Jens Axboe3d6392c2007-07-09 12:38:05 +02001022static int __init bsg_init(void)
1023{
1024 int ret, i;
1025
Jens Axboe5309cb32007-01-23 16:24:41 +01001026 bsg_cmd_cachep = kmem_cache_create("bsg_cmd",
1027 sizeof(struct bsg_command), 0, 0, NULL, NULL);
1028 if (!bsg_cmd_cachep) {
1029 printk(KERN_ERR "bsg: failed creating slab cache\n");
1030 return -ENOMEM;
1031 }
1032
Jens Axboe3d6392c2007-07-09 12:38:05 +02001033 for (i = 0; i < BSG_LIST_SIZE; i++)
1034 INIT_HLIST_HEAD(&bsg_device_list[i]);
1035
1036 bsg_class = class_create(THIS_MODULE, "bsg");
Jens Axboe5309cb32007-01-23 16:24:41 +01001037 if (IS_ERR(bsg_class)) {
1038 kmem_cache_destroy(bsg_cmd_cachep);
Jens Axboe3d6392c2007-07-09 12:38:05 +02001039 return PTR_ERR(bsg_class);
Jens Axboe5309cb32007-01-23 16:24:41 +01001040 }
Jens Axboe3d6392c2007-07-09 12:38:05 +02001041
FUJITA Tomonori292b7f22007-03-28 13:29:58 +02001042 ret = register_chrdev_region(MKDEV(BSG_MAJOR, 0), BSG_MAX_DEVS, "bsg");
Jens Axboe3d6392c2007-07-09 12:38:05 +02001043 if (ret) {
Jens Axboe5309cb32007-01-23 16:24:41 +01001044 kmem_cache_destroy(bsg_cmd_cachep);
Jens Axboe3d6392c2007-07-09 12:38:05 +02001045 class_destroy(bsg_class);
1046 return ret;
1047 }
1048
FUJITA Tomonori292b7f22007-03-28 13:29:58 +02001049 cdev_init(&bsg_cdev, &bsg_fops);
1050 ret = cdev_add(&bsg_cdev, MKDEV(BSG_MAJOR, 0), BSG_MAX_DEVS);
1051 if (ret) {
1052 kmem_cache_destroy(bsg_cmd_cachep);
1053 class_destroy(bsg_class);
1054 unregister_chrdev_region(MKDEV(BSG_MAJOR, 0), BSG_MAX_DEVS);
1055 return ret;
1056 }
1057
FUJITA Tomonori4e2872d2007-03-28 13:29:24 +02001058 ret = scsi_register_interface(&bsg_intf);
1059 if (ret) {
1060 printk(KERN_ERR "bsg: failed register scsi interface %d\n", ret);
1061 kmem_cache_destroy(bsg_cmd_cachep);
1062 class_destroy(bsg_class);
1063 unregister_chrdev(BSG_MAJOR, "bsg");
1064 return ret;
1065 }
1066
Jens Axboe3d6392c2007-07-09 12:38:05 +02001067 printk(KERN_INFO "%s loaded\n", bsg_version);
1068 return 0;
1069}
1070
1071MODULE_AUTHOR("Jens Axboe");
1072MODULE_DESCRIPTION("Block layer SGSI generic (sg) driver");
1073MODULE_LICENSE("GPL");
1074
FUJITA Tomonori4e2872d2007-03-28 13:29:24 +02001075device_initcall(bsg_init);