2 * SCSI target lib functions
4 * Copyright (C) 2005 Mike Christie <michaelc@cs.wisc.edu>
5 * Copyright (C) 2005 FUJITA Tomonori <tomof@acm.org>
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License as
9 * published by the Free Software Foundation; either version 2 of the
10 * License, or (at your option) any later version.
12 * This program is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
22 #include <linux/blkdev.h>
23 #include <linux/hash.h>
24 #include <linux/module.h>
25 #include <linux/pagemap.h>
26 #include <scsi/scsi.h>
27 #include <scsi/scsi_cmnd.h>
28 #include <scsi/scsi_device.h>
29 #include <scsi/scsi_host.h>
30 #include <scsi/scsi_transport.h>
31 #include <scsi/scsi_tgt.h>
33 #include "scsi_tgt_priv.h"
35 static struct workqueue_struct *scsi_tgtd;
36 static struct kmem_cache *scsi_tgt_cmd_cache;
39 * TODO: this struct will be killed when the block layer supports large bios
40 * and James's work struct code is in
43 /* TODO replace work with James b's code */
44 struct work_struct work;
45 /* TODO fix limits of some drivers */
48 struct list_head hash_list;
54 #define TGT_HASH_ORDER 4
55 #define cmd_hashfn(tag) hash_long((unsigned long) (tag), TGT_HASH_ORDER)
57 struct scsi_tgt_queuedata {
58 struct Scsi_Host *shost;
59 struct list_head cmd_hash[1 << TGT_HASH_ORDER];
60 spinlock_t cmd_hash_lock;
64 * Function: scsi_host_get_command()
66 * Purpose: Allocate and setup a scsi command block and blk request
68 * Arguments: shost - scsi host
69 * data_dir - dma data dir
70 * gfp_mask- allocator flags
72 * Returns: The allocated scsi command structure.
74 * This should be called by target LLDs to get a command.
76 struct scsi_cmnd *scsi_host_get_command(struct Scsi_Host *shost,
77 enum dma_data_direction data_dir,
80 int write = (data_dir == DMA_TO_DEVICE);
82 struct scsi_cmnd *cmd;
83 struct scsi_tgt_cmd *tcmd;
85 /* Bail if we can't get a reference to the device */
86 if (!get_device(&shost->shost_gendev))
89 tcmd = kmem_cache_alloc(scsi_tgt_cmd_cache, GFP_ATOMIC);
94 * The blk helpers are used to the READ/WRITE requests
95 * transfering data from a initiator point of view. Since
96 * we are in target mode we want the opposite.
98 rq = blk_get_request(shost->uspace_req_q, !write, gfp_mask);
102 cmd = __scsi_get_command(shost, gfp_mask);
106 cmd->sc_data_direction = data_dir;
107 cmd->jiffies_at_alloc = jiffies;
111 rq->cmd_type = REQ_TYPE_SPECIAL;
112 rq->cmd_flags |= REQ_TYPE_BLOCK_PC;
113 rq->end_io_data = tcmd;
122 kmem_cache_free(scsi_tgt_cmd_cache, tcmd);
124 put_device(&shost->shost_gendev);
128 EXPORT_SYMBOL_GPL(scsi_host_get_command);
131 * Function: scsi_host_put_command()
133 * Purpose: Free a scsi command block
135 * Arguments: shost - scsi host
136 * cmd - command block to free
140 * Notes: The command must not belong to any lists.
142 void scsi_host_put_command(struct Scsi_Host *shost, struct scsi_cmnd *cmd)
144 struct request_queue *q = shost->uspace_req_q;
145 struct request *rq = cmd->request;
146 struct scsi_tgt_cmd *tcmd = rq->end_io_data;
149 kmem_cache_free(scsi_tgt_cmd_cache, tcmd);
151 spin_lock_irqsave(q->queue_lock, flags);
152 __blk_put_request(q, rq);
153 spin_unlock_irqrestore(q->queue_lock, flags);
155 __scsi_put_command(shost, cmd, &shost->shost_gendev);
157 EXPORT_SYMBOL_GPL(scsi_host_put_command);
159 static void cmd_hashlist_del(struct scsi_cmnd *cmd)
161 struct request_queue *q = cmd->request->q;
162 struct scsi_tgt_queuedata *qdata = q->queuedata;
164 struct scsi_tgt_cmd *tcmd = cmd->request->end_io_data;
166 spin_lock_irqsave(&qdata->cmd_hash_lock, flags);
167 list_del(&tcmd->hash_list);
168 spin_unlock_irqrestore(&qdata->cmd_hash_lock, flags);
171 static void scsi_unmap_user_pages(struct scsi_tgt_cmd *tcmd)
173 blk_rq_unmap_user(tcmd->bio);
176 static void scsi_tgt_cmd_destroy(struct work_struct *work)
178 struct scsi_tgt_cmd *tcmd =
179 container_of(work, struct scsi_tgt_cmd, work);
180 struct scsi_cmnd *cmd = tcmd->rq->special;
182 dprintk("cmd %p %d %u\n", cmd, cmd->sc_data_direction,
183 rq_data_dir(cmd->request));
184 scsi_unmap_user_pages(tcmd);
185 scsi_host_put_command(scsi_tgt_cmd_to_host(cmd), cmd);
188 static void init_scsi_tgt_cmd(struct request *rq, struct scsi_tgt_cmd *tcmd,
191 struct scsi_tgt_queuedata *qdata = rq->q->queuedata;
193 struct list_head *head;
195 tcmd->itn_id = itn_id;
198 INIT_WORK(&tcmd->work, scsi_tgt_cmd_destroy);
199 spin_lock_irqsave(&qdata->cmd_hash_lock, flags);
200 head = &qdata->cmd_hash[cmd_hashfn(tag)];
201 list_add(&tcmd->hash_list, head);
202 spin_unlock_irqrestore(&qdata->cmd_hash_lock, flags);
206 * scsi_tgt_alloc_queue - setup queue used for message passing
209 * This should be called by the LLD after host allocation.
210 * And will be released when the host is released.
212 int scsi_tgt_alloc_queue(struct Scsi_Host *shost)
214 struct scsi_tgt_queuedata *queuedata;
215 struct request_queue *q;
219 * Do we need to send a netlink event or should uspace
220 * just respond to the hotplug event?
222 q = __scsi_alloc_queue(shost, NULL);
226 queuedata = kzalloc(sizeof(*queuedata), GFP_KERNEL);
231 queuedata->shost = shost;
232 q->queuedata = queuedata;
235 * this is a silly hack. We should probably just queue as many
236 * command as is recvd to userspace. uspace can then make
237 * sure we do not overload the HBA
239 q->nr_requests = shost->can_queue;
241 * We currently only support software LLDs so this does
242 * not matter for now. Do we need this for the cards we support?
243 * If so we should make it a host template value.
245 blk_queue_dma_alignment(q, 0);
246 shost->uspace_req_q = q;
248 for (i = 0; i < ARRAY_SIZE(queuedata->cmd_hash); i++)
249 INIT_LIST_HEAD(&queuedata->cmd_hash[i]);
250 spin_lock_init(&queuedata->cmd_hash_lock);
255 blk_cleanup_queue(q);
258 EXPORT_SYMBOL_GPL(scsi_tgt_alloc_queue);
260 void scsi_tgt_free_queue(struct Scsi_Host *shost)
264 struct request_queue *q = shost->uspace_req_q;
265 struct scsi_cmnd *cmd;
266 struct scsi_tgt_queuedata *qdata = q->queuedata;
267 struct scsi_tgt_cmd *tcmd, *n;
270 spin_lock_irqsave(&qdata->cmd_hash_lock, flags);
272 for (i = 0; i < ARRAY_SIZE(qdata->cmd_hash); i++) {
273 list_for_each_entry_safe(tcmd, n, &qdata->cmd_hash[i],
275 list_del(&tcmd->hash_list);
276 list_add(&tcmd->hash_list, &cmds);
280 spin_unlock_irqrestore(&qdata->cmd_hash_lock, flags);
282 while (!list_empty(&cmds)) {
283 tcmd = list_entry(cmds.next, struct scsi_tgt_cmd, hash_list);
284 list_del(&tcmd->hash_list);
285 cmd = tcmd->rq->special;
287 shost->hostt->eh_abort_handler(cmd);
288 scsi_tgt_cmd_destroy(&tcmd->work);
291 EXPORT_SYMBOL_GPL(scsi_tgt_free_queue);
293 struct Scsi_Host *scsi_tgt_cmd_to_host(struct scsi_cmnd *cmd)
295 struct scsi_tgt_queuedata *queue = cmd->request->q->queuedata;
298 EXPORT_SYMBOL_GPL(scsi_tgt_cmd_to_host);
301 * scsi_tgt_queue_command - queue command for userspace processing
304 * @tag: unique value to identify this command for tmf
306 int scsi_tgt_queue_command(struct scsi_cmnd *cmd, u64 itn_id,
307 struct scsi_lun *scsilun, u64 tag)
309 struct scsi_tgt_cmd *tcmd = cmd->request->end_io_data;
312 init_scsi_tgt_cmd(cmd->request, tcmd, itn_id, tag);
313 err = scsi_tgt_uspace_send_cmd(cmd, itn_id, scsilun, tag);
315 cmd_hashlist_del(cmd);
319 EXPORT_SYMBOL_GPL(scsi_tgt_queue_command);
322 * This is run from a interrupt handler normally and the unmap
323 * needs process context so we must queue
325 static void scsi_tgt_cmd_done(struct scsi_cmnd *cmd)
327 struct scsi_tgt_cmd *tcmd = cmd->request->end_io_data;
329 dprintk("cmd %p %u\n", cmd, rq_data_dir(cmd->request));
331 scsi_tgt_uspace_send_status(cmd, tcmd->itn_id, tcmd->tag);
333 scsi_release_buffers(cmd);
335 queue_work(scsi_tgtd, &tcmd->work);
338 static int scsi_tgt_transfer_response(struct scsi_cmnd *cmd)
340 struct Scsi_Host *shost = scsi_tgt_cmd_to_host(cmd);
343 dprintk("cmd %p %u\n", cmd, rq_data_dir(cmd->request));
345 err = shost->hostt->transfer_response(cmd, scsi_tgt_cmd_done);
347 case SCSI_MLQUEUE_HOST_BUSY:
348 case SCSI_MLQUEUE_DEVICE_BUSY:
354 /* TODO: test this crap and replace bio_map_user with new interface maybe */
355 static int scsi_map_user_pages(struct scsi_tgt_cmd *tcmd, struct scsi_cmnd *cmd,
356 unsigned long uaddr, unsigned int len, int rw)
358 struct request_queue *q = cmd->request->q;
359 struct request *rq = cmd->request;
362 dprintk("%lx %u\n", uaddr, len);
363 err = blk_rq_map_user(q, rq, (void *)uaddr, len);
366 * TODO: need to fixup sg_tablesize, max_segment_size,
367 * max_sectors, etc for modern HW and software drivers
368 * where this value is bogus.
370 * TODO2: we can alloc a reserve buffer of max size
371 * we can handle and do the slow copy path for really large
374 eprintk("Could not handle request of size %u.\n", len);
379 err = scsi_init_io(cmd, GFP_KERNEL);
381 scsi_release_buffers(cmd);
385 * we use REQ_TYPE_BLOCK_PC so scsi_init_io doesn't set the
388 cmd->sdb.length = rq->data_len;
393 scsi_unmap_user_pages(tcmd);
397 static int scsi_tgt_copy_sense(struct scsi_cmnd *cmd, unsigned long uaddr,
400 char __user *p = (char __user *) uaddr;
402 if (copy_from_user(cmd->sense_buffer, p,
403 min_t(unsigned, SCSI_SENSE_BUFFERSIZE, len))) {
404 printk(KERN_ERR "Could not copy the sense buffer\n");
410 static int scsi_tgt_abort_cmd(struct Scsi_Host *shost, struct scsi_cmnd *cmd)
412 struct scsi_tgt_cmd *tcmd;
415 err = shost->hostt->eh_abort_handler(cmd);
417 eprintk("fail to abort %p\n", cmd);
419 tcmd = cmd->request->end_io_data;
420 scsi_tgt_cmd_destroy(&tcmd->work);
424 static struct request *tgt_cmd_hash_lookup(struct request_queue *q, u64 tag)
426 struct scsi_tgt_queuedata *qdata = q->queuedata;
427 struct request *rq = NULL;
428 struct list_head *head;
429 struct scsi_tgt_cmd *tcmd;
432 head = &qdata->cmd_hash[cmd_hashfn(tag)];
433 spin_lock_irqsave(&qdata->cmd_hash_lock, flags);
434 list_for_each_entry(tcmd, head, hash_list) {
435 if (tcmd->tag == tag) {
437 list_del(&tcmd->hash_list);
441 spin_unlock_irqrestore(&qdata->cmd_hash_lock, flags);
446 int scsi_tgt_kspace_exec(int host_no, u64 itn_id, int result, u64 tag,
447 unsigned long uaddr, u32 len, unsigned long sense_uaddr,
448 u32 sense_len, u8 rw)
450 struct Scsi_Host *shost;
451 struct scsi_cmnd *cmd;
453 struct scsi_tgt_cmd *tcmd;
456 dprintk("%d %llu %d %u %lx %u\n", host_no, (unsigned long long) tag,
457 result, len, uaddr, rw);
459 /* TODO: replace with a O(1) alg */
460 shost = scsi_host_lookup(host_no);
462 printk(KERN_ERR "Could not find host no %d\n", host_no);
466 if (!shost->uspace_req_q) {
467 printk(KERN_ERR "Not target scsi host %d\n", host_no);
471 rq = tgt_cmd_hash_lookup(shost->uspace_req_q, tag);
473 printk(KERN_ERR "Could not find tag %llu\n",
474 (unsigned long long) tag);
480 dprintk("cmd %p scb %x result %d len %d bufflen %u %u %x\n",
481 cmd, cmd->cmnd[0], result, len, scsi_bufflen(cmd),
482 rq_data_dir(rq), cmd->cmnd[0]);
484 if (result == TASK_ABORTED) {
485 scsi_tgt_abort_cmd(shost, cmd);
489 * store the userspace values here, the working values are
490 * in the request_* values
492 tcmd = cmd->request->end_io_data;
493 cmd->result = result;
495 if (cmd->result == SAM_STAT_CHECK_CONDITION)
496 scsi_tgt_copy_sense(cmd, sense_uaddr, sense_len);
499 err = scsi_map_user_pages(rq->end_io_data, cmd, uaddr, len, rw);
502 * user-space daemon bugs or OOM
503 * TODO: we can do better for OOM.
505 struct scsi_tgt_queuedata *qdata;
506 struct list_head *head;
509 eprintk("cmd %p ret %d uaddr %lx len %d rw %d\n",
510 cmd, err, uaddr, len, rw);
512 qdata = shost->uspace_req_q->queuedata;
513 head = &qdata->cmd_hash[cmd_hashfn(tcmd->tag)];
515 spin_lock_irqsave(&qdata->cmd_hash_lock, flags);
516 list_add(&tcmd->hash_list, head);
517 spin_unlock_irqrestore(&qdata->cmd_hash_lock, flags);
522 err = scsi_tgt_transfer_response(cmd);
524 scsi_host_put(shost);
528 int scsi_tgt_tsk_mgmt_request(struct Scsi_Host *shost, u64 itn_id,
529 int function, u64 tag, struct scsi_lun *scsilun,
534 /* TODO: need to retry if this fails. */
535 err = scsi_tgt_uspace_send_tsk_mgmt(shost->host_no, itn_id,
536 function, tag, scsilun, data);
538 eprintk("The task management request lost!\n");
541 EXPORT_SYMBOL_GPL(scsi_tgt_tsk_mgmt_request);
543 int scsi_tgt_kspace_tsk_mgmt(int host_no, u64 itn_id, u64 mid, int result)
545 struct Scsi_Host *shost;
548 dprintk("%d %d %llx\n", host_no, result, (unsigned long long) mid);
550 shost = scsi_host_lookup(host_no);
552 printk(KERN_ERR "Could not find host no %d\n", host_no);
556 if (!shost->uspace_req_q) {
557 printk(KERN_ERR "Not target scsi host %d\n", host_no);
561 err = shost->transportt->tsk_mgmt_response(shost, itn_id, mid, result);
563 scsi_host_put(shost);
567 int scsi_tgt_it_nexus_create(struct Scsi_Host *shost, u64 itn_id,
572 /* TODO: need to retry if this fails. */
573 err = scsi_tgt_uspace_send_it_nexus_request(shost->host_no, itn_id, 0,
576 eprintk("The i_t_neuxs request lost, %d %llx!\n",
577 shost->host_no, (unsigned long long)itn_id);
580 EXPORT_SYMBOL_GPL(scsi_tgt_it_nexus_create);
582 int scsi_tgt_it_nexus_destroy(struct Scsi_Host *shost, u64 itn_id)
586 /* TODO: need to retry if this fails. */
587 err = scsi_tgt_uspace_send_it_nexus_request(shost->host_no,
590 eprintk("The i_t_neuxs request lost, %d %llx!\n",
591 shost->host_no, (unsigned long long)itn_id);
594 EXPORT_SYMBOL_GPL(scsi_tgt_it_nexus_destroy);
596 int scsi_tgt_kspace_it_nexus_rsp(int host_no, u64 itn_id, int result)
598 struct Scsi_Host *shost;
601 dprintk("%d %d%llx\n", host_no, result, (unsigned long long)itn_id);
603 shost = scsi_host_lookup(host_no);
605 printk(KERN_ERR "Could not find host no %d\n", host_no);
609 if (!shost->uspace_req_q) {
610 printk(KERN_ERR "Not target scsi host %d\n", host_no);
614 err = shost->transportt->it_nexus_response(shost, itn_id, result);
616 scsi_host_put(shost);
620 static int __init scsi_tgt_init(void)
624 scsi_tgt_cmd_cache = kmem_cache_create("scsi_tgt_cmd",
625 sizeof(struct scsi_tgt_cmd),
627 if (!scsi_tgt_cmd_cache)
630 scsi_tgtd = create_workqueue("scsi_tgtd");
636 err = scsi_tgt_if_init();
643 destroy_workqueue(scsi_tgtd);
645 kmem_cache_destroy(scsi_tgt_cmd_cache);
649 static void __exit scsi_tgt_exit(void)
651 destroy_workqueue(scsi_tgtd);
653 kmem_cache_destroy(scsi_tgt_cmd_cache);
656 module_init(scsi_tgt_init);
657 module_exit(scsi_tgt_exit);
659 MODULE_DESCRIPTION("SCSI target core");
660 MODULE_LICENSE("GPL");