Merge branches 'release', 'asus', 'sony-laptop' and 'thinkpad' into release
[pandora-kernel.git] / drivers / scsi / scsi_tgt_lib.c
1 /*
2  * SCSI target lib functions
3  *
4  * Copyright (C) 2005 Mike Christie <michaelc@cs.wisc.edu>
5  * Copyright (C) 2005 FUJITA Tomonori <tomof@acm.org>
6  *
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.
11  *
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.
16  *
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
20  * 02110-1301 USA
21  */
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>
32
33 #include "scsi_tgt_priv.h"
34
35 static struct workqueue_struct *scsi_tgtd;
36 static struct kmem_cache *scsi_tgt_cmd_cache;
37
38 /*
39  * TODO: this struct will be killed when the block layer supports large bios
40  * and James's work struct code is in
41  */
42 struct scsi_tgt_cmd {
43         /* TODO replace work with James b's code */
44         struct work_struct work;
45         /* TODO fix limits of some drivers */
46         struct bio *bio;
47
48         struct list_head hash_list;
49         struct request *rq;
50         u64 itn_id;
51         u64 tag;
52 };
53
54 #define TGT_HASH_ORDER  4
55 #define cmd_hashfn(tag) hash_long((unsigned long) (tag), TGT_HASH_ORDER)
56
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;
61 };
62
63 /*
64  * Function:    scsi_host_get_command()
65  *
66  * Purpose:     Allocate and setup a scsi command block and blk request
67  *
68  * Arguments:   shost   - scsi host
69  *              data_dir - dma data dir
70  *              gfp_mask- allocator flags
71  *
72  * Returns:     The allocated scsi command structure.
73  *
74  * This should be called by target LLDs to get a command.
75  */
76 struct scsi_cmnd *scsi_host_get_command(struct Scsi_Host *shost,
77                                         enum dma_data_direction data_dir,
78                                         gfp_t gfp_mask)
79 {
80         int write = (data_dir == DMA_TO_DEVICE);
81         struct request *rq;
82         struct scsi_cmnd *cmd;
83         struct scsi_tgt_cmd *tcmd;
84
85         /* Bail if we can't get a reference to the device */
86         if (!get_device(&shost->shost_gendev))
87                 return NULL;
88
89         tcmd = kmem_cache_alloc(scsi_tgt_cmd_cache, GFP_ATOMIC);
90         if (!tcmd)
91                 goto put_dev;
92
93         /*
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.
97          */
98         rq = blk_get_request(shost->uspace_req_q, !write, gfp_mask);
99         if (!rq)
100                 goto free_tcmd;
101
102         cmd = __scsi_get_command(shost, gfp_mask);
103         if (!cmd)
104                 goto release_rq;
105
106         memset(cmd, 0, sizeof(*cmd));
107         cmd->sc_data_direction = data_dir;
108         cmd->jiffies_at_alloc = jiffies;
109         cmd->request = rq;
110
111         rq->special = cmd;
112         rq->cmd_type = REQ_TYPE_SPECIAL;
113         rq->cmd_flags |= REQ_TYPE_BLOCK_PC;
114         rq->end_io_data = tcmd;
115
116         tcmd->rq = rq;
117
118         return cmd;
119
120 release_rq:
121         blk_put_request(rq);
122 free_tcmd:
123         kmem_cache_free(scsi_tgt_cmd_cache, tcmd);
124 put_dev:
125         put_device(&shost->shost_gendev);
126         return NULL;
127
128 }
129 EXPORT_SYMBOL_GPL(scsi_host_get_command);
130
131 /*
132  * Function:    scsi_host_put_command()
133  *
134  * Purpose:     Free a scsi command block
135  *
136  * Arguments:   shost   - scsi host
137  *              cmd     - command block to free
138  *
139  * Returns:     Nothing.
140  *
141  * Notes:       The command must not belong to any lists.
142  */
143 void scsi_host_put_command(struct Scsi_Host *shost, struct scsi_cmnd *cmd)
144 {
145         struct request_queue *q = shost->uspace_req_q;
146         struct request *rq = cmd->request;
147         struct scsi_tgt_cmd *tcmd = rq->end_io_data;
148         unsigned long flags;
149
150         kmem_cache_free(scsi_tgt_cmd_cache, tcmd);
151
152         spin_lock_irqsave(q->queue_lock, flags);
153         __blk_put_request(q, rq);
154         spin_unlock_irqrestore(q->queue_lock, flags);
155
156         __scsi_put_command(shost, cmd, &shost->shost_gendev);
157 }
158 EXPORT_SYMBOL_GPL(scsi_host_put_command);
159
160 static void cmd_hashlist_del(struct scsi_cmnd *cmd)
161 {
162         struct request_queue *q = cmd->request->q;
163         struct scsi_tgt_queuedata *qdata = q->queuedata;
164         unsigned long flags;
165         struct scsi_tgt_cmd *tcmd = cmd->request->end_io_data;
166
167         spin_lock_irqsave(&qdata->cmd_hash_lock, flags);
168         list_del(&tcmd->hash_list);
169         spin_unlock_irqrestore(&qdata->cmd_hash_lock, flags);
170 }
171
172 static void scsi_unmap_user_pages(struct scsi_tgt_cmd *tcmd)
173 {
174         blk_rq_unmap_user(tcmd->bio);
175 }
176
177 static void scsi_tgt_cmd_destroy(struct work_struct *work)
178 {
179         struct scsi_tgt_cmd *tcmd =
180                 container_of(work, struct scsi_tgt_cmd, work);
181         struct scsi_cmnd *cmd = tcmd->rq->special;
182
183         dprintk("cmd %p %d %u\n", cmd, cmd->sc_data_direction,
184                 rq_data_dir(cmd->request));
185         scsi_unmap_user_pages(tcmd);
186         scsi_host_put_command(scsi_tgt_cmd_to_host(cmd), cmd);
187 }
188
189 static void init_scsi_tgt_cmd(struct request *rq, struct scsi_tgt_cmd *tcmd,
190                               u64 itn_id, u64 tag)
191 {
192         struct scsi_tgt_queuedata *qdata = rq->q->queuedata;
193         unsigned long flags;
194         struct list_head *head;
195
196         tcmd->itn_id = itn_id;
197         tcmd->tag = tag;
198         tcmd->bio = NULL;
199         INIT_WORK(&tcmd->work, scsi_tgt_cmd_destroy);
200         spin_lock_irqsave(&qdata->cmd_hash_lock, flags);
201         head = &qdata->cmd_hash[cmd_hashfn(tag)];
202         list_add(&tcmd->hash_list, head);
203         spin_unlock_irqrestore(&qdata->cmd_hash_lock, flags);
204 }
205
206 /*
207  * scsi_tgt_alloc_queue - setup queue used for message passing
208  * shost: scsi host
209  *
210  * This should be called by the LLD after host allocation.
211  * And will be released when the host is released.
212  */
213 int scsi_tgt_alloc_queue(struct Scsi_Host *shost)
214 {
215         struct scsi_tgt_queuedata *queuedata;
216         struct request_queue *q;
217         int err, i;
218
219         /*
220          * Do we need to send a netlink event or should uspace
221          * just respond to the hotplug event?
222          */
223         q = __scsi_alloc_queue(shost, NULL);
224         if (!q)
225                 return -ENOMEM;
226
227         queuedata = kzalloc(sizeof(*queuedata), GFP_KERNEL);
228         if (!queuedata) {
229                 err = -ENOMEM;
230                 goto cleanup_queue;
231         }
232         queuedata->shost = shost;
233         q->queuedata = queuedata;
234
235         /*
236          * this is a silly hack. We should probably just queue as many
237          * command as is recvd to userspace. uspace can then make
238          * sure we do not overload the HBA
239          */
240         q->nr_requests = shost->can_queue;
241         /*
242          * We currently only support software LLDs so this does
243          * not matter for now. Do we need this for the cards we support?
244          * If so we should make it a host template value.
245          */
246         blk_queue_dma_alignment(q, 0);
247         shost->uspace_req_q = q;
248
249         for (i = 0; i < ARRAY_SIZE(queuedata->cmd_hash); i++)
250                 INIT_LIST_HEAD(&queuedata->cmd_hash[i]);
251         spin_lock_init(&queuedata->cmd_hash_lock);
252
253         return 0;
254
255 cleanup_queue:
256         blk_cleanup_queue(q);
257         return err;
258 }
259 EXPORT_SYMBOL_GPL(scsi_tgt_alloc_queue);
260
261 void scsi_tgt_free_queue(struct Scsi_Host *shost)
262 {
263         int i;
264         unsigned long flags;
265         struct request_queue *q = shost->uspace_req_q;
266         struct scsi_cmnd *cmd;
267         struct scsi_tgt_queuedata *qdata = q->queuedata;
268         struct scsi_tgt_cmd *tcmd, *n;
269         LIST_HEAD(cmds);
270
271         spin_lock_irqsave(&qdata->cmd_hash_lock, flags);
272
273         for (i = 0; i < ARRAY_SIZE(qdata->cmd_hash); i++) {
274                 list_for_each_entry_safe(tcmd, n, &qdata->cmd_hash[i],
275                                          hash_list) {
276                         list_del(&tcmd->hash_list);
277                         list_add(&tcmd->hash_list, &cmds);
278                 }
279         }
280
281         spin_unlock_irqrestore(&qdata->cmd_hash_lock, flags);
282
283         while (!list_empty(&cmds)) {
284                 tcmd = list_entry(cmds.next, struct scsi_tgt_cmd, hash_list);
285                 list_del(&tcmd->hash_list);
286                 cmd = tcmd->rq->special;
287
288                 shost->hostt->eh_abort_handler(cmd);
289                 scsi_tgt_cmd_destroy(&tcmd->work);
290         }
291 }
292 EXPORT_SYMBOL_GPL(scsi_tgt_free_queue);
293
294 struct Scsi_Host *scsi_tgt_cmd_to_host(struct scsi_cmnd *cmd)
295 {
296         struct scsi_tgt_queuedata *queue = cmd->request->q->queuedata;
297         return queue->shost;
298 }
299 EXPORT_SYMBOL_GPL(scsi_tgt_cmd_to_host);
300
301 /*
302  * scsi_tgt_queue_command - queue command for userspace processing
303  * @cmd:        scsi command
304  * @scsilun:    scsi lun
305  * @tag:        unique value to identify this command for tmf
306  */
307 int scsi_tgt_queue_command(struct scsi_cmnd *cmd, u64 itn_id,
308                            struct scsi_lun *scsilun, u64 tag)
309 {
310         struct scsi_tgt_cmd *tcmd = cmd->request->end_io_data;
311         int err;
312
313         init_scsi_tgt_cmd(cmd->request, tcmd, itn_id, tag);
314         err = scsi_tgt_uspace_send_cmd(cmd, itn_id, scsilun, tag);
315         if (err)
316                 cmd_hashlist_del(cmd);
317
318         return err;
319 }
320 EXPORT_SYMBOL_GPL(scsi_tgt_queue_command);
321
322 /*
323  * This is run from a interrupt handler normally and the unmap
324  * needs process context so we must queue
325  */
326 static void scsi_tgt_cmd_done(struct scsi_cmnd *cmd)
327 {
328         struct scsi_tgt_cmd *tcmd = cmd->request->end_io_data;
329
330         dprintk("cmd %p %u\n", cmd, rq_data_dir(cmd->request));
331
332         scsi_tgt_uspace_send_status(cmd, tcmd->itn_id, tcmd->tag);
333
334         scsi_release_buffers(cmd);
335
336         queue_work(scsi_tgtd, &tcmd->work);
337 }
338
339 static int scsi_tgt_transfer_response(struct scsi_cmnd *cmd)
340 {
341         struct Scsi_Host *shost = scsi_tgt_cmd_to_host(cmd);
342         int err;
343
344         dprintk("cmd %p %u\n", cmd, rq_data_dir(cmd->request));
345
346         err = shost->hostt->transfer_response(cmd, scsi_tgt_cmd_done);
347         switch (err) {
348         case SCSI_MLQUEUE_HOST_BUSY:
349         case SCSI_MLQUEUE_DEVICE_BUSY:
350                 return -EAGAIN;
351         }
352         return 0;
353 }
354
355 /* TODO: test this crap and replace bio_map_user with new interface maybe */
356 static int scsi_map_user_pages(struct scsi_tgt_cmd *tcmd, struct scsi_cmnd *cmd,
357                                unsigned long uaddr, unsigned int len, int rw)
358 {
359         struct request_queue *q = cmd->request->q;
360         struct request *rq = cmd->request;
361         int err;
362
363         dprintk("%lx %u\n", uaddr, len);
364         err = blk_rq_map_user(q, rq, (void *)uaddr, len);
365         if (err) {
366                 /*
367                  * TODO: need to fixup sg_tablesize, max_segment_size,
368                  * max_sectors, etc for modern HW and software drivers
369                  * where this value is bogus.
370                  *
371                  * TODO2: we can alloc a reserve buffer of max size
372                  * we can handle and do the slow copy path for really large
373                  * IO.
374                  */
375                 eprintk("Could not handle request of size %u.\n", len);
376                 return err;
377         }
378
379         tcmd->bio = rq->bio;
380         err = scsi_init_io(cmd, GFP_KERNEL);
381         if (err) {
382                 scsi_release_buffers(cmd);
383                 goto unmap_rq;
384         }
385
386         return 0;
387
388 unmap_rq:
389         scsi_unmap_user_pages(tcmd);
390         return err;
391 }
392
393 static int scsi_tgt_copy_sense(struct scsi_cmnd *cmd, unsigned long uaddr,
394                                 unsigned len)
395 {
396         char __user *p = (char __user *) uaddr;
397
398         if (copy_from_user(cmd->sense_buffer, p,
399                            min_t(unsigned, SCSI_SENSE_BUFFERSIZE, len))) {
400                 printk(KERN_ERR "Could not copy the sense buffer\n");
401                 return -EIO;
402         }
403         return 0;
404 }
405
406 static int scsi_tgt_abort_cmd(struct Scsi_Host *shost, struct scsi_cmnd *cmd)
407 {
408         struct scsi_tgt_cmd *tcmd;
409         int err;
410
411         err = shost->hostt->eh_abort_handler(cmd);
412         if (err)
413                 eprintk("fail to abort %p\n", cmd);
414
415         tcmd = cmd->request->end_io_data;
416         scsi_tgt_cmd_destroy(&tcmd->work);
417         return err;
418 }
419
420 static struct request *tgt_cmd_hash_lookup(struct request_queue *q, u64 tag)
421 {
422         struct scsi_tgt_queuedata *qdata = q->queuedata;
423         struct request *rq = NULL;
424         struct list_head *head;
425         struct scsi_tgt_cmd *tcmd;
426         unsigned long flags;
427
428         head = &qdata->cmd_hash[cmd_hashfn(tag)];
429         spin_lock_irqsave(&qdata->cmd_hash_lock, flags);
430         list_for_each_entry(tcmd, head, hash_list) {
431                 if (tcmd->tag == tag) {
432                         rq = tcmd->rq;
433                         list_del(&tcmd->hash_list);
434                         break;
435                 }
436         }
437         spin_unlock_irqrestore(&qdata->cmd_hash_lock, flags);
438
439         return rq;
440 }
441
442 int scsi_tgt_kspace_exec(int host_no, u64 itn_id, int result, u64 tag,
443                          unsigned long uaddr, u32 len, unsigned long sense_uaddr,
444                          u32 sense_len, u8 rw)
445 {
446         struct Scsi_Host *shost;
447         struct scsi_cmnd *cmd;
448         struct request *rq;
449         struct scsi_tgt_cmd *tcmd;
450         int err = 0;
451
452         dprintk("%d %llu %d %u %lx %u\n", host_no, (unsigned long long) tag,
453                 result, len, uaddr, rw);
454
455         /* TODO: replace with a O(1) alg */
456         shost = scsi_host_lookup(host_no);
457         if (IS_ERR(shost)) {
458                 printk(KERN_ERR "Could not find host no %d\n", host_no);
459                 return -EINVAL;
460         }
461
462         if (!shost->uspace_req_q) {
463                 printk(KERN_ERR "Not target scsi host %d\n", host_no);
464                 goto done;
465         }
466
467         rq = tgt_cmd_hash_lookup(shost->uspace_req_q, tag);
468         if (!rq) {
469                 printk(KERN_ERR "Could not find tag %llu\n",
470                        (unsigned long long) tag);
471                 err = -EINVAL;
472                 goto done;
473         }
474         cmd = rq->special;
475
476         dprintk("cmd %p scb %x result %d len %d bufflen %u %u %x\n",
477                 cmd, cmd->cmnd[0], result, len, scsi_bufflen(cmd),
478                 rq_data_dir(rq), cmd->cmnd[0]);
479
480         if (result == TASK_ABORTED) {
481                 scsi_tgt_abort_cmd(shost, cmd);
482                 goto done;
483         }
484         /*
485          * store the userspace values here, the working values are
486          * in the request_* values
487          */
488         tcmd = cmd->request->end_io_data;
489         cmd->result = result;
490
491         if (cmd->result == SAM_STAT_CHECK_CONDITION)
492                 scsi_tgt_copy_sense(cmd, sense_uaddr, sense_len);
493
494         if (len) {
495                 err = scsi_map_user_pages(rq->end_io_data, cmd, uaddr, len, rw);
496                 if (err) {
497                         /*
498                          * user-space daemon bugs or OOM
499                          * TODO: we can do better for OOM.
500                          */
501                         struct scsi_tgt_queuedata *qdata;
502                         struct list_head *head;
503                         unsigned long flags;
504
505                         eprintk("cmd %p ret %d uaddr %lx len %d rw %d\n",
506                                 cmd, err, uaddr, len, rw);
507
508                         qdata = shost->uspace_req_q->queuedata;
509                         head = &qdata->cmd_hash[cmd_hashfn(tcmd->tag)];
510
511                         spin_lock_irqsave(&qdata->cmd_hash_lock, flags);
512                         list_add(&tcmd->hash_list, head);
513                         spin_unlock_irqrestore(&qdata->cmd_hash_lock, flags);
514
515                         goto done;
516                 }
517         }
518         err = scsi_tgt_transfer_response(cmd);
519 done:
520         scsi_host_put(shost);
521         return err;
522 }
523
524 int scsi_tgt_tsk_mgmt_request(struct Scsi_Host *shost, u64 itn_id,
525                               int function, u64 tag, struct scsi_lun *scsilun,
526                               void *data)
527 {
528         int err;
529
530         /* TODO: need to retry if this fails. */
531         err = scsi_tgt_uspace_send_tsk_mgmt(shost->host_no, itn_id,
532                                             function, tag, scsilun, data);
533         if (err < 0)
534                 eprintk("The task management request lost!\n");
535         return err;
536 }
537 EXPORT_SYMBOL_GPL(scsi_tgt_tsk_mgmt_request);
538
539 int scsi_tgt_kspace_tsk_mgmt(int host_no, u64 itn_id, u64 mid, int result)
540 {
541         struct Scsi_Host *shost;
542         int err = -EINVAL;
543
544         dprintk("%d %d %llx\n", host_no, result, (unsigned long long) mid);
545
546         shost = scsi_host_lookup(host_no);
547         if (IS_ERR(shost)) {
548                 printk(KERN_ERR "Could not find host no %d\n", host_no);
549                 return err;
550         }
551
552         if (!shost->uspace_req_q) {
553                 printk(KERN_ERR "Not target scsi host %d\n", host_no);
554                 goto done;
555         }
556
557         err = shost->transportt->tsk_mgmt_response(shost, itn_id, mid, result);
558 done:
559         scsi_host_put(shost);
560         return err;
561 }
562
563 int scsi_tgt_it_nexus_create(struct Scsi_Host *shost, u64 itn_id,
564                              char *initiator)
565 {
566         int err;
567
568         /* TODO: need to retry if this fails. */
569         err = scsi_tgt_uspace_send_it_nexus_request(shost->host_no, itn_id, 0,
570                                                     initiator);
571         if (err < 0)
572                 eprintk("The i_t_neuxs request lost, %d %llx!\n",
573                         shost->host_no, (unsigned long long)itn_id);
574         return err;
575 }
576 EXPORT_SYMBOL_GPL(scsi_tgt_it_nexus_create);
577
578 int scsi_tgt_it_nexus_destroy(struct Scsi_Host *shost, u64 itn_id)
579 {
580         int err;
581
582         /* TODO: need to retry if this fails. */
583         err = scsi_tgt_uspace_send_it_nexus_request(shost->host_no,
584                                                     itn_id, 1, NULL);
585         if (err < 0)
586                 eprintk("The i_t_neuxs request lost, %d %llx!\n",
587                         shost->host_no, (unsigned long long)itn_id);
588         return err;
589 }
590 EXPORT_SYMBOL_GPL(scsi_tgt_it_nexus_destroy);
591
592 int scsi_tgt_kspace_it_nexus_rsp(int host_no, u64 itn_id, int result)
593 {
594         struct Scsi_Host *shost;
595         int err = -EINVAL;
596
597         dprintk("%d %d%llx\n", host_no, result, (unsigned long long)itn_id);
598
599         shost = scsi_host_lookup(host_no);
600         if (IS_ERR(shost)) {
601                 printk(KERN_ERR "Could not find host no %d\n", host_no);
602                 return err;
603         }
604
605         if (!shost->uspace_req_q) {
606                 printk(KERN_ERR "Not target scsi host %d\n", host_no);
607                 goto done;
608         }
609
610         err = shost->transportt->it_nexus_response(shost, itn_id, result);
611 done:
612         scsi_host_put(shost);
613         return err;
614 }
615
616 static int __init scsi_tgt_init(void)
617 {
618         int err;
619
620         scsi_tgt_cmd_cache = kmem_cache_create("scsi_tgt_cmd",
621                                                sizeof(struct scsi_tgt_cmd),
622                                                0, 0, NULL);
623         if (!scsi_tgt_cmd_cache)
624                 return -ENOMEM;
625
626         scsi_tgtd = create_workqueue("scsi_tgtd");
627         if (!scsi_tgtd) {
628                 err = -ENOMEM;
629                 goto free_kmemcache;
630         }
631
632         err = scsi_tgt_if_init();
633         if (err)
634                 goto destroy_wq;
635
636         return 0;
637
638 destroy_wq:
639         destroy_workqueue(scsi_tgtd);
640 free_kmemcache:
641         kmem_cache_destroy(scsi_tgt_cmd_cache);
642         return err;
643 }
644
645 static void __exit scsi_tgt_exit(void)
646 {
647         destroy_workqueue(scsi_tgtd);
648         scsi_tgt_if_exit();
649         kmem_cache_destroy(scsi_tgt_cmd_cache);
650 }
651
652 module_init(scsi_tgt_init);
653 module_exit(scsi_tgt_exit);
654
655 MODULE_DESCRIPTION("SCSI target core");
656 MODULE_LICENSE("GPL");