2 * Copyright (c) 2005 Cisco Systems. All rights reserved.
4 * This software is available to you under a choice of one of two
5 * licenses. You may choose to be licensed under the terms of the GNU
6 * General Public License (GPL) Version 2, available from the file
7 * COPYING in the main directory of this source tree, or the
8 * OpenIB.org BSD license below:
10 * Redistribution and use in source and binary forms, with or
11 * without modification, are permitted provided that the following
14 * - Redistributions of source code must retain the above
15 * copyright notice, this list of conditions and the following
18 * - Redistributions in binary form must reproduce the above
19 * copyright notice, this list of conditions and the following
20 * disclaimer in the documentation and/or other materials
21 * provided with the distribution.
23 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
24 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
25 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
26 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
27 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
28 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
29 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
33 #include <linux/module.h>
34 #include <linux/init.h>
35 #include <linux/slab.h>
36 #include <linux/err.h>
37 #include <linux/string.h>
38 #include <linux/parser.h>
39 #include <linux/random.h>
40 #include <linux/jiffies.h>
42 #include <asm/atomic.h>
44 #include <scsi/scsi.h>
45 #include <scsi/scsi_device.h>
46 #include <scsi/scsi_dbg.h>
48 #include <scsi/scsi_transport_srp.h>
52 #define DRV_NAME "ib_srp"
53 #define PFX DRV_NAME ": "
54 #define DRV_VERSION "0.2"
55 #define DRV_RELDATE "November 1, 2005"
57 MODULE_AUTHOR("Roland Dreier");
58 MODULE_DESCRIPTION("InfiniBand SCSI RDMA Protocol initiator "
59 "v" DRV_VERSION
" (" DRV_RELDATE
")");
60 MODULE_LICENSE("Dual BSD/GPL");
62 static int srp_sg_tablesize
= SRP_DEF_SG_TABLESIZE
;
63 static int srp_max_iu_len
;
65 module_param(srp_sg_tablesize
, int, 0444);
66 MODULE_PARM_DESC(srp_sg_tablesize
,
67 "Max number of gather/scatter entries per I/O (default is 12, max 255)");
69 static int topspin_workarounds
= 1;
71 module_param(topspin_workarounds
, int, 0444);
72 MODULE_PARM_DESC(topspin_workarounds
,
73 "Enable workarounds for Topspin/Cisco SRP target bugs if != 0");
75 static int mellanox_workarounds
= 1;
77 module_param(mellanox_workarounds
, int, 0444);
78 MODULE_PARM_DESC(mellanox_workarounds
,
79 "Enable workarounds for Mellanox SRP target bugs if != 0");
81 static void srp_add_one(struct ib_device
*device
);
82 static void srp_remove_one(struct ib_device
*device
);
83 static void srp_recv_completion(struct ib_cq
*cq
, void *target_ptr
);
84 static void srp_send_completion(struct ib_cq
*cq
, void *target_ptr
);
85 static int srp_cm_handler(struct ib_cm_id
*cm_id
, struct ib_cm_event
*event
);
87 static struct scsi_transport_template
*ib_srp_transport_template
;
89 static struct ib_client srp_client
= {
92 .remove
= srp_remove_one
95 static struct ib_sa_client srp_sa_client
;
97 static inline struct srp_target_port
*host_to_target(struct Scsi_Host
*host
)
99 return (struct srp_target_port
*) host
->hostdata
;
102 static const char *srp_target_info(struct Scsi_Host
*host
)
104 return host_to_target(host
)->target_name
;
107 static int srp_target_is_topspin(struct srp_target_port
*target
)
109 static const u8 topspin_oui
[3] = { 0x00, 0x05, 0xad };
110 static const u8 cisco_oui
[3] = { 0x00, 0x1b, 0x0d };
112 return topspin_workarounds
&&
113 (!memcmp(&target
->ioc_guid
, topspin_oui
, sizeof topspin_oui
) ||
114 !memcmp(&target
->ioc_guid
, cisco_oui
, sizeof cisco_oui
));
117 static int srp_target_is_mellanox(struct srp_target_port
*target
)
119 static const u8 mellanox_oui
[3] = { 0x00, 0x02, 0xc9 };
121 return mellanox_workarounds
&&
122 !memcmp(&target
->ioc_guid
, mellanox_oui
, sizeof mellanox_oui
);
125 static struct srp_iu
*srp_alloc_iu(struct srp_host
*host
, size_t size
,
127 enum dma_data_direction direction
)
131 iu
= kmalloc(sizeof *iu
, gfp_mask
);
135 iu
->buf
= kzalloc(size
, gfp_mask
);
139 iu
->dma
= ib_dma_map_single(host
->srp_dev
->dev
, iu
->buf
, size
,
141 if (ib_dma_mapping_error(host
->srp_dev
->dev
, iu
->dma
))
145 iu
->direction
= direction
;
157 static void srp_free_iu(struct srp_host
*host
, struct srp_iu
*iu
)
162 ib_dma_unmap_single(host
->srp_dev
->dev
, iu
->dma
, iu
->size
,
168 static void srp_qp_event(struct ib_event
*event
, void *context
)
170 printk(KERN_ERR PFX
"QP event %d\n", event
->event
);
173 static int srp_init_qp(struct srp_target_port
*target
,
176 struct ib_qp_attr
*attr
;
179 attr
= kmalloc(sizeof *attr
, GFP_KERNEL
);
183 ret
= ib_find_pkey(target
->srp_host
->srp_dev
->dev
,
184 target
->srp_host
->port
,
185 be16_to_cpu(target
->path
.pkey
),
190 attr
->qp_state
= IB_QPS_INIT
;
191 attr
->qp_access_flags
= (IB_ACCESS_REMOTE_READ
|
192 IB_ACCESS_REMOTE_WRITE
);
193 attr
->port_num
= target
->srp_host
->port
;
195 ret
= ib_modify_qp(qp
, attr
,
206 static int srp_new_cm_id(struct srp_target_port
*target
)
208 struct ib_cm_id
*new_cm_id
;
210 new_cm_id
= ib_create_cm_id(target
->srp_host
->srp_dev
->dev
,
211 srp_cm_handler
, target
);
212 if (IS_ERR(new_cm_id
))
213 return PTR_ERR(new_cm_id
);
216 ib_destroy_cm_id(target
->cm_id
);
217 target
->cm_id
= new_cm_id
;
222 static int srp_create_target_ib(struct srp_target_port
*target
)
224 struct ib_qp_init_attr
*init_attr
;
227 init_attr
= kzalloc(sizeof *init_attr
, GFP_KERNEL
);
231 target
->recv_cq
= ib_create_cq(target
->srp_host
->srp_dev
->dev
,
232 srp_recv_completion
, NULL
, target
, SRP_RQ_SIZE
, 0);
233 if (IS_ERR(target
->recv_cq
)) {
234 ret
= PTR_ERR(target
->recv_cq
);
238 target
->send_cq
= ib_create_cq(target
->srp_host
->srp_dev
->dev
,
239 srp_send_completion
, NULL
, target
, SRP_SQ_SIZE
, 0);
240 if (IS_ERR(target
->send_cq
)) {
241 ret
= PTR_ERR(target
->send_cq
);
245 ib_req_notify_cq(target
->recv_cq
, IB_CQ_NEXT_COMP
);
247 init_attr
->event_handler
= srp_qp_event
;
248 init_attr
->cap
.max_send_wr
= SRP_SQ_SIZE
;
249 init_attr
->cap
.max_recv_wr
= SRP_RQ_SIZE
;
250 init_attr
->cap
.max_recv_sge
= 1;
251 init_attr
->cap
.max_send_sge
= 1;
252 init_attr
->sq_sig_type
= IB_SIGNAL_ALL_WR
;
253 init_attr
->qp_type
= IB_QPT_RC
;
254 init_attr
->send_cq
= target
->send_cq
;
255 init_attr
->recv_cq
= target
->recv_cq
;
257 target
->qp
= ib_create_qp(target
->srp_host
->srp_dev
->pd
, init_attr
);
258 if (IS_ERR(target
->qp
)) {
259 ret
= PTR_ERR(target
->qp
);
263 ret
= srp_init_qp(target
, target
->qp
);
271 ib_destroy_qp(target
->qp
);
274 ib_destroy_cq(target
->send_cq
);
277 ib_destroy_cq(target
->recv_cq
);
284 static void srp_free_target_ib(struct srp_target_port
*target
)
288 ib_destroy_qp(target
->qp
);
289 ib_destroy_cq(target
->send_cq
);
290 ib_destroy_cq(target
->recv_cq
);
292 for (i
= 0; i
< SRP_RQ_SIZE
; ++i
)
293 srp_free_iu(target
->srp_host
, target
->rx_ring
[i
]);
294 for (i
= 0; i
< SRP_SQ_SIZE
; ++i
)
295 srp_free_iu(target
->srp_host
, target
->tx_ring
[i
]);
298 static void srp_path_rec_completion(int status
,
299 struct ib_sa_path_rec
*pathrec
,
302 struct srp_target_port
*target
= target_ptr
;
304 target
->status
= status
;
306 shost_printk(KERN_ERR
, target
->scsi_host
,
307 PFX
"Got failed path rec status %d\n", status
);
309 target
->path
= *pathrec
;
310 complete(&target
->done
);
313 static int srp_lookup_path(struct srp_target_port
*target
)
315 target
->path
.numb_path
= 1;
317 init_completion(&target
->done
);
319 target
->path_query_id
= ib_sa_path_rec_get(&srp_sa_client
,
320 target
->srp_host
->srp_dev
->dev
,
321 target
->srp_host
->port
,
323 IB_SA_PATH_REC_SERVICE_ID
|
324 IB_SA_PATH_REC_DGID
|
325 IB_SA_PATH_REC_SGID
|
326 IB_SA_PATH_REC_NUMB_PATH
|
328 SRP_PATH_REC_TIMEOUT_MS
,
330 srp_path_rec_completion
,
331 target
, &target
->path_query
);
332 if (target
->path_query_id
< 0)
333 return target
->path_query_id
;
335 wait_for_completion(&target
->done
);
337 if (target
->status
< 0)
338 shost_printk(KERN_WARNING
, target
->scsi_host
,
339 PFX
"Path record query failed\n");
341 return target
->status
;
344 static int srp_send_req(struct srp_target_port
*target
)
347 struct ib_cm_req_param param
;
348 struct srp_login_req priv
;
352 req
= kzalloc(sizeof *req
, GFP_KERNEL
);
356 req
->param
.primary_path
= &target
->path
;
357 req
->param
.alternate_path
= NULL
;
358 req
->param
.service_id
= target
->service_id
;
359 req
->param
.qp_num
= target
->qp
->qp_num
;
360 req
->param
.qp_type
= target
->qp
->qp_type
;
361 req
->param
.private_data
= &req
->priv
;
362 req
->param
.private_data_len
= sizeof req
->priv
;
363 req
->param
.flow_control
= 1;
365 get_random_bytes(&req
->param
.starting_psn
, 4);
366 req
->param
.starting_psn
&= 0xffffff;
369 * Pick some arbitrary defaults here; we could make these
370 * module parameters if anyone cared about setting them.
372 req
->param
.responder_resources
= 4;
373 req
->param
.remote_cm_response_timeout
= 20;
374 req
->param
.local_cm_response_timeout
= 20;
375 req
->param
.retry_count
= 7;
376 req
->param
.rnr_retry_count
= 7;
377 req
->param
.max_cm_retries
= 15;
379 req
->priv
.opcode
= SRP_LOGIN_REQ
;
381 req
->priv
.req_it_iu_len
= cpu_to_be32(srp_max_iu_len
);
382 req
->priv
.req_buf_fmt
= cpu_to_be16(SRP_BUF_FORMAT_DIRECT
|
383 SRP_BUF_FORMAT_INDIRECT
);
385 * In the published SRP specification (draft rev. 16a), the
386 * port identifier format is 8 bytes of ID extension followed
387 * by 8 bytes of GUID. Older drafts put the two halves in the
388 * opposite order, so that the GUID comes first.
390 * Targets conforming to these obsolete drafts can be
391 * recognized by the I/O Class they report.
393 if (target
->io_class
== SRP_REV10_IB_IO_CLASS
) {
394 memcpy(req
->priv
.initiator_port_id
,
395 &target
->path
.sgid
.global
.interface_id
, 8);
396 memcpy(req
->priv
.initiator_port_id
+ 8,
397 &target
->initiator_ext
, 8);
398 memcpy(req
->priv
.target_port_id
, &target
->ioc_guid
, 8);
399 memcpy(req
->priv
.target_port_id
+ 8, &target
->id_ext
, 8);
401 memcpy(req
->priv
.initiator_port_id
,
402 &target
->initiator_ext
, 8);
403 memcpy(req
->priv
.initiator_port_id
+ 8,
404 &target
->path
.sgid
.global
.interface_id
, 8);
405 memcpy(req
->priv
.target_port_id
, &target
->id_ext
, 8);
406 memcpy(req
->priv
.target_port_id
+ 8, &target
->ioc_guid
, 8);
410 * Topspin/Cisco SRP targets will reject our login unless we
411 * zero out the first 8 bytes of our initiator port ID and set
412 * the second 8 bytes to the local node GUID.
414 if (srp_target_is_topspin(target
)) {
415 shost_printk(KERN_DEBUG
, target
->scsi_host
,
416 PFX
"Topspin/Cisco initiator port ID workaround "
417 "activated for target GUID %016llx\n",
418 (unsigned long long) be64_to_cpu(target
->ioc_guid
));
419 memset(req
->priv
.initiator_port_id
, 0, 8);
420 memcpy(req
->priv
.initiator_port_id
+ 8,
421 &target
->srp_host
->srp_dev
->dev
->node_guid
, 8);
424 status
= ib_send_cm_req(target
->cm_id
, &req
->param
);
431 static void srp_disconnect_target(struct srp_target_port
*target
)
433 /* XXX should send SRP_I_LOGOUT request */
435 init_completion(&target
->done
);
436 if (ib_send_cm_dreq(target
->cm_id
, NULL
, 0)) {
437 shost_printk(KERN_DEBUG
, target
->scsi_host
,
438 PFX
"Sending CM DREQ failed\n");
441 wait_for_completion(&target
->done
);
444 static bool srp_change_state(struct srp_target_port
*target
,
445 enum srp_target_state old
,
446 enum srp_target_state
new)
448 bool changed
= false;
450 spin_lock_irq(target
->scsi_host
->host_lock
);
451 if (target
->state
== old
) {
455 spin_unlock_irq(target
->scsi_host
->host_lock
);
459 static void srp_remove_work(struct work_struct
*work
)
461 struct srp_target_port
*target
=
462 container_of(work
, struct srp_target_port
, work
);
464 if (!srp_change_state(target
, SRP_TARGET_DEAD
, SRP_TARGET_REMOVED
))
467 spin_lock(&target
->srp_host
->target_lock
);
468 list_del(&target
->list
);
469 spin_unlock(&target
->srp_host
->target_lock
);
471 srp_remove_host(target
->scsi_host
);
472 scsi_remove_host(target
->scsi_host
);
473 ib_destroy_cm_id(target
->cm_id
);
474 srp_free_target_ib(target
);
475 scsi_host_put(target
->scsi_host
);
478 static int srp_connect_target(struct srp_target_port
*target
)
483 ret
= srp_lookup_path(target
);
488 init_completion(&target
->done
);
489 ret
= srp_send_req(target
);
492 wait_for_completion(&target
->done
);
495 * The CM event handling code will set status to
496 * SRP_PORT_REDIRECT if we get a port redirect REJ
497 * back, or SRP_DLID_REDIRECT if we get a lid/qp
500 switch (target
->status
) {
504 case SRP_PORT_REDIRECT
:
505 ret
= srp_lookup_path(target
);
510 case SRP_DLID_REDIRECT
:
514 /* Our current CM id was stale, and is now in timewait.
515 * Try to reconnect with a new one.
517 if (!retries
-- || srp_new_cm_id(target
)) {
518 shost_printk(KERN_ERR
, target
->scsi_host
, PFX
519 "giving up on stale connection\n");
520 target
->status
= -ECONNRESET
;
521 return target
->status
;
524 shost_printk(KERN_ERR
, target
->scsi_host
, PFX
525 "retrying stale connection\n");
529 return target
->status
;
534 static void srp_unmap_data(struct scsi_cmnd
*scmnd
,
535 struct srp_target_port
*target
,
536 struct srp_request
*req
)
538 if (!scsi_sglist(scmnd
) ||
539 (scmnd
->sc_data_direction
!= DMA_TO_DEVICE
&&
540 scmnd
->sc_data_direction
!= DMA_FROM_DEVICE
))
544 ib_fmr_pool_unmap(req
->fmr
);
548 ib_dma_unmap_sg(target
->srp_host
->srp_dev
->dev
, scsi_sglist(scmnd
),
549 scsi_sg_count(scmnd
), scmnd
->sc_data_direction
);
552 static void srp_remove_req(struct srp_target_port
*target
, struct srp_request
*req
)
554 srp_unmap_data(req
->scmnd
, target
, req
);
556 list_move_tail(&req
->list
, &target
->free_reqs
);
559 static void srp_reset_req(struct srp_target_port
*target
, struct srp_request
*req
)
561 req
->scmnd
->result
= DID_RESET
<< 16;
562 req
->scmnd
->scsi_done(req
->scmnd
);
563 srp_remove_req(target
, req
);
566 static int srp_reconnect_target(struct srp_target_port
*target
)
568 struct ib_qp_attr qp_attr
;
569 struct srp_request
*req
, *tmp
;
573 if (!srp_change_state(target
, SRP_TARGET_LIVE
, SRP_TARGET_CONNECTING
))
576 srp_disconnect_target(target
);
578 * Now get a new local CM ID so that we avoid confusing the
579 * target in case things are really fouled up.
581 ret
= srp_new_cm_id(target
);
585 qp_attr
.qp_state
= IB_QPS_RESET
;
586 ret
= ib_modify_qp(target
->qp
, &qp_attr
, IB_QP_STATE
);
590 ret
= srp_init_qp(target
, target
->qp
);
594 while (ib_poll_cq(target
->recv_cq
, 1, &wc
) > 0)
596 while (ib_poll_cq(target
->send_cq
, 1, &wc
) > 0)
599 spin_lock_irq(target
->scsi_host
->host_lock
);
600 list_for_each_entry_safe(req
, tmp
, &target
->req_queue
, list
)
601 srp_reset_req(target
, req
);
602 spin_unlock_irq(target
->scsi_host
->host_lock
);
604 list_del_init(&target
->free_tx
);
605 for (i
= 0; i
< SRP_SQ_SIZE
; ++i
)
606 list_move(&target
->tx_ring
[i
]->list
, &target
->free_tx
);
608 target
->qp_in_error
= 0;
609 ret
= srp_connect_target(target
);
613 if (!srp_change_state(target
, SRP_TARGET_CONNECTING
, SRP_TARGET_LIVE
))
619 shost_printk(KERN_ERR
, target
->scsi_host
,
620 PFX
"reconnect failed (%d), removing target port.\n", ret
);
623 * We couldn't reconnect, so kill our target port off.
624 * However, we have to defer the real removal because we
625 * are in the context of the SCSI error handler now, which
626 * will deadlock if we call scsi_remove_host().
628 * Schedule our work inside the lock to avoid a race with
629 * the flush_scheduled_work() in srp_remove_one().
631 spin_lock_irq(target
->scsi_host
->host_lock
);
632 if (target
->state
== SRP_TARGET_CONNECTING
) {
633 target
->state
= SRP_TARGET_DEAD
;
634 INIT_WORK(&target
->work
, srp_remove_work
);
635 schedule_work(&target
->work
);
637 spin_unlock_irq(target
->scsi_host
->host_lock
);
642 static int srp_map_fmr(struct srp_target_port
*target
, struct scatterlist
*scat
,
643 int sg_cnt
, struct srp_request
*req
,
644 struct srp_direct_buf
*buf
)
652 struct srp_device
*dev
= target
->srp_host
->srp_dev
;
653 struct ib_device
*ibdev
= dev
->dev
;
654 struct scatterlist
*sg
;
659 if (srp_target_is_mellanox(target
) &&
660 (ib_sg_dma_address(ibdev
, &scat
[0]) & ~dev
->fmr_page_mask
))
664 scsi_for_each_sg(req
->scmnd
, sg
, sg_cnt
, i
) {
665 unsigned int dma_len
= ib_sg_dma_len(ibdev
, sg
);
667 if (ib_sg_dma_address(ibdev
, sg
) & ~dev
->fmr_page_mask
) {
673 if ((ib_sg_dma_address(ibdev
, sg
) + dma_len
) &
674 ~dev
->fmr_page_mask
) {
684 page_cnt
+= len
>> dev
->fmr_page_shift
;
685 if (page_cnt
> SRP_FMR_SIZE
)
688 dma_pages
= kmalloc(sizeof (u64
) * page_cnt
, GFP_ATOMIC
);
693 scsi_for_each_sg(req
->scmnd
, sg
, sg_cnt
, i
) {
694 unsigned int dma_len
= ib_sg_dma_len(ibdev
, sg
);
696 for (j
= 0; j
< dma_len
; j
+= dev
->fmr_page_size
)
697 dma_pages
[page_cnt
++] =
698 (ib_sg_dma_address(ibdev
, sg
) &
699 dev
->fmr_page_mask
) + j
;
702 req
->fmr
= ib_fmr_pool_map_phys(dev
->fmr_pool
,
703 dma_pages
, page_cnt
, io_addr
);
704 if (IS_ERR(req
->fmr
)) {
705 ret
= PTR_ERR(req
->fmr
);
710 buf
->va
= cpu_to_be64(ib_sg_dma_address(ibdev
, &scat
[0]) &
711 ~dev
->fmr_page_mask
);
712 buf
->key
= cpu_to_be32(req
->fmr
->fmr
->rkey
);
713 buf
->len
= cpu_to_be32(len
);
723 static int srp_map_data(struct scsi_cmnd
*scmnd
, struct srp_target_port
*target
,
724 struct srp_request
*req
)
726 struct scatterlist
*scat
;
727 struct srp_cmd
*cmd
= req
->cmd
->buf
;
728 int len
, nents
, count
;
729 u8 fmt
= SRP_DATA_DESC_DIRECT
;
730 struct srp_device
*dev
;
731 struct ib_device
*ibdev
;
733 if (!scsi_sglist(scmnd
) || scmnd
->sc_data_direction
== DMA_NONE
)
734 return sizeof (struct srp_cmd
);
736 if (scmnd
->sc_data_direction
!= DMA_FROM_DEVICE
&&
737 scmnd
->sc_data_direction
!= DMA_TO_DEVICE
) {
738 shost_printk(KERN_WARNING
, target
->scsi_host
,
739 PFX
"Unhandled data direction %d\n",
740 scmnd
->sc_data_direction
);
744 nents
= scsi_sg_count(scmnd
);
745 scat
= scsi_sglist(scmnd
);
747 dev
= target
->srp_host
->srp_dev
;
750 count
= ib_dma_map_sg(ibdev
, scat
, nents
, scmnd
->sc_data_direction
);
752 fmt
= SRP_DATA_DESC_DIRECT
;
753 len
= sizeof (struct srp_cmd
) + sizeof (struct srp_direct_buf
);
757 * The midlayer only generated a single gather/scatter
758 * entry, or DMA mapping coalesced everything to a
759 * single entry. So a direct descriptor along with
760 * the DMA MR suffices.
762 struct srp_direct_buf
*buf
= (void *) cmd
->add_data
;
764 buf
->va
= cpu_to_be64(ib_sg_dma_address(ibdev
, scat
));
765 buf
->key
= cpu_to_be32(dev
->mr
->rkey
);
766 buf
->len
= cpu_to_be32(ib_sg_dma_len(ibdev
, scat
));
767 } else if (srp_map_fmr(target
, scat
, count
, req
,
768 (void *) cmd
->add_data
)) {
770 * FMR mapping failed, and the scatterlist has more
771 * than one entry. Generate an indirect memory
774 struct srp_indirect_buf
*buf
= (void *) cmd
->add_data
;
775 struct scatterlist
*sg
;
779 fmt
= SRP_DATA_DESC_INDIRECT
;
780 len
= sizeof (struct srp_cmd
) +
781 sizeof (struct srp_indirect_buf
) +
782 count
* sizeof (struct srp_direct_buf
);
784 scsi_for_each_sg(scmnd
, sg
, count
, i
) {
785 unsigned int dma_len
= ib_sg_dma_len(ibdev
, sg
);
787 buf
->desc_list
[i
].va
=
788 cpu_to_be64(ib_sg_dma_address(ibdev
, sg
));
789 buf
->desc_list
[i
].key
=
790 cpu_to_be32(dev
->mr
->rkey
);
791 buf
->desc_list
[i
].len
= cpu_to_be32(dma_len
);
795 if (scmnd
->sc_data_direction
== DMA_TO_DEVICE
)
796 cmd
->data_out_desc_cnt
= count
;
798 cmd
->data_in_desc_cnt
= count
;
801 cpu_to_be64(req
->cmd
->dma
+ sizeof *cmd
+ sizeof *buf
);
802 buf
->table_desc
.key
=
803 cpu_to_be32(target
->srp_host
->srp_dev
->mr
->rkey
);
804 buf
->table_desc
.len
=
805 cpu_to_be32(count
* sizeof (struct srp_direct_buf
));
807 buf
->len
= cpu_to_be32(datalen
);
810 if (scmnd
->sc_data_direction
== DMA_TO_DEVICE
)
811 cmd
->buf_fmt
= fmt
<< 4;
819 * Must be called with target->scsi_host->host_lock held to protect
820 * req_lim and free_tx. Lock cannot be dropped between call here and
821 * call to __srp_post_send().
824 * An upper limit for the number of allocated information units for each
826 * - SRP_IU_CMD: SRP_CMD_SQ_SIZE, since the SCSI mid-layer never queues
827 * more than Scsi_Host.can_queue requests.
828 * - SRP_IU_TSK_MGMT: SRP_TSK_MGMT_SQ_SIZE.
829 * - SRP_IU_RSP: 1, since a conforming SRP target never sends more than
830 * one unanswered SRP request to an initiator.
832 static struct srp_iu
*__srp_get_tx_iu(struct srp_target_port
*target
,
833 enum srp_iu_type iu_type
)
835 s32 rsv
= (iu_type
== SRP_IU_TSK_MGMT
) ? 0 : SRP_TSK_MGMT_SQ_SIZE
;
838 srp_send_completion(target
->send_cq
, target
);
840 if (list_empty(&target
->free_tx
))
843 /* Initiator responses to target requests do not consume credits */
844 if (target
->req_lim
<= rsv
&& iu_type
!= SRP_IU_RSP
) {
845 ++target
->zero_req_lim
;
849 iu
= list_first_entry(&target
->free_tx
, struct srp_iu
, list
);
855 * Must be called with target->scsi_host->host_lock held to protect
856 * req_lim and free_tx.
858 static int __srp_post_send(struct srp_target_port
*target
,
859 struct srp_iu
*iu
, int len
)
862 struct ib_send_wr wr
, *bad_wr
;
867 list
.lkey
= target
->srp_host
->srp_dev
->mr
->lkey
;
870 wr
.wr_id
= (uintptr_t) iu
;
873 wr
.opcode
= IB_WR_SEND
;
874 wr
.send_flags
= IB_SEND_SIGNALED
;
876 ret
= ib_post_send(target
->qp
, &wr
, &bad_wr
);
880 if (iu
->type
!= SRP_IU_RSP
)
887 static int srp_post_recv(struct srp_target_port
*target
, struct srp_iu
*iu
)
889 struct ib_recv_wr wr
, *bad_wr
;
893 list
.length
= iu
->size
;
894 list
.lkey
= target
->srp_host
->srp_dev
->mr
->lkey
;
897 wr
.wr_id
= (uintptr_t) iu
;
901 return ib_post_recv(target
->qp
, &wr
, &bad_wr
);
904 static void srp_process_rsp(struct srp_target_port
*target
, struct srp_rsp
*rsp
)
906 struct srp_request
*req
;
907 struct scsi_cmnd
*scmnd
;
911 delta
= (s32
) be32_to_cpu(rsp
->req_lim_delta
);
913 spin_lock_irqsave(target
->scsi_host
->host_lock
, flags
);
915 target
->req_lim
+= delta
;
917 if (unlikely(rsp
->tag
& SRP_TAG_TSK_MGMT
)) {
918 target
->tsk_mgmt_status
= -1;
919 if (be32_to_cpu(rsp
->resp_data_len
) >= 4)
920 target
->tsk_mgmt_status
= rsp
->data
[3];
921 complete(&target
->tsk_mgmt_done
);
923 req
= &target
->req_ring
[rsp
->tag
];
926 shost_printk(KERN_ERR
, target
->scsi_host
,
927 "Null scmnd for RSP w/tag %016llx\n",
928 (unsigned long long) rsp
->tag
);
929 scmnd
->result
= rsp
->status
;
931 if (rsp
->flags
& SRP_RSP_FLAG_SNSVALID
) {
932 memcpy(scmnd
->sense_buffer
, rsp
->data
+
933 be32_to_cpu(rsp
->resp_data_len
),
934 min_t(int, be32_to_cpu(rsp
->sense_data_len
),
935 SCSI_SENSE_BUFFERSIZE
));
938 if (rsp
->flags
& (SRP_RSP_FLAG_DOOVER
| SRP_RSP_FLAG_DOUNDER
))
939 scsi_set_resid(scmnd
, be32_to_cpu(rsp
->data_out_res_cnt
));
940 else if (rsp
->flags
& (SRP_RSP_FLAG_DIOVER
| SRP_RSP_FLAG_DIUNDER
))
941 scsi_set_resid(scmnd
, be32_to_cpu(rsp
->data_in_res_cnt
));
943 scmnd
->host_scribble
= NULL
;
944 scmnd
->scsi_done(scmnd
);
945 srp_remove_req(target
, req
);
948 spin_unlock_irqrestore(target
->scsi_host
->host_lock
, flags
);
951 static int srp_response_common(struct srp_target_port
*target
, s32 req_delta
,
954 struct ib_device
*dev
;
959 dev
= target
->srp_host
->srp_dev
->dev
;
961 spin_lock_irqsave(target
->scsi_host
->host_lock
, flags
);
962 target
->req_lim
+= req_delta
;
964 iu
= __srp_get_tx_iu(target
, SRP_IU_RSP
);
966 shost_printk(KERN_ERR
, target
->scsi_host
, PFX
967 "no IU available to send response\n");
971 ib_dma_sync_single_for_cpu(dev
, iu
->dma
, len
, DMA_TO_DEVICE
);
972 memcpy(iu
->buf
, rsp
, len
);
973 ib_dma_sync_single_for_device(dev
, iu
->dma
, len
, DMA_TO_DEVICE
);
975 err
= __srp_post_send(target
, iu
, len
);
977 shost_printk(KERN_ERR
, target
->scsi_host
, PFX
978 "unable to post response: %d\n", err
);
981 spin_unlock_irqrestore(target
->scsi_host
->host_lock
, flags
);
985 static void srp_process_cred_req(struct srp_target_port
*target
,
986 struct srp_cred_req
*req
)
988 struct srp_cred_rsp rsp
= {
989 .opcode
= SRP_CRED_RSP
,
992 s32 delta
= be32_to_cpu(req
->req_lim_delta
);
994 if (srp_response_common(target
, delta
, &rsp
, sizeof rsp
))
995 shost_printk(KERN_ERR
, target
->scsi_host
, PFX
996 "problems processing SRP_CRED_REQ\n");
999 static void srp_process_aer_req(struct srp_target_port
*target
,
1000 struct srp_aer_req
*req
)
1002 struct srp_aer_rsp rsp
= {
1003 .opcode
= SRP_AER_RSP
,
1006 s32 delta
= be32_to_cpu(req
->req_lim_delta
);
1008 shost_printk(KERN_ERR
, target
->scsi_host
, PFX
1009 "ignoring AER for LUN %llu\n", be64_to_cpu(req
->lun
));
1011 if (srp_response_common(target
, delta
, &rsp
, sizeof rsp
))
1012 shost_printk(KERN_ERR
, target
->scsi_host
, PFX
1013 "problems processing SRP_AER_REQ\n");
1016 static void srp_handle_recv(struct srp_target_port
*target
, struct ib_wc
*wc
)
1018 struct ib_device
*dev
= target
->srp_host
->srp_dev
->dev
;
1019 struct srp_iu
*iu
= (struct srp_iu
*) wc
->wr_id
;
1023 ib_dma_sync_single_for_cpu(dev
, iu
->dma
, target
->max_ti_iu_len
,
1026 opcode
= *(u8
*) iu
->buf
;
1029 shost_printk(KERN_ERR
, target
->scsi_host
,
1030 PFX
"recv completion, opcode 0x%02x\n", opcode
);
1031 print_hex_dump(KERN_ERR
, "", DUMP_PREFIX_OFFSET
, 8, 1,
1032 iu
->buf
, wc
->byte_len
, true);
1037 srp_process_rsp(target
, iu
->buf
);
1041 srp_process_cred_req(target
, iu
->buf
);
1045 srp_process_aer_req(target
, iu
->buf
);
1049 /* XXX Handle target logout */
1050 shost_printk(KERN_WARNING
, target
->scsi_host
,
1051 PFX
"Got target logout request\n");
1055 shost_printk(KERN_WARNING
, target
->scsi_host
,
1056 PFX
"Unhandled SRP opcode 0x%02x\n", opcode
);
1060 ib_dma_sync_single_for_device(dev
, iu
->dma
, target
->max_ti_iu_len
,
1063 res
= srp_post_recv(target
, iu
);
1065 shost_printk(KERN_ERR
, target
->scsi_host
,
1066 PFX
"Recv failed with error code %d\n", res
);
1069 static void srp_recv_completion(struct ib_cq
*cq
, void *target_ptr
)
1071 struct srp_target_port
*target
= target_ptr
;
1074 ib_req_notify_cq(cq
, IB_CQ_NEXT_COMP
);
1075 while (ib_poll_cq(cq
, 1, &wc
) > 0) {
1077 shost_printk(KERN_ERR
, target
->scsi_host
,
1078 PFX
"failed receive status %d\n",
1080 target
->qp_in_error
= 1;
1084 srp_handle_recv(target
, &wc
);
1088 static void srp_send_completion(struct ib_cq
*cq
, void *target_ptr
)
1090 struct srp_target_port
*target
= target_ptr
;
1094 while (ib_poll_cq(cq
, 1, &wc
) > 0) {
1096 shost_printk(KERN_ERR
, target
->scsi_host
,
1097 PFX
"failed send status %d\n",
1099 target
->qp_in_error
= 1;
1103 iu
= (struct srp_iu
*) wc
.wr_id
;
1104 list_add(&iu
->list
, &target
->free_tx
);
1108 static int srp_queuecommand_lck(struct scsi_cmnd
*scmnd
,
1109 void (*done
)(struct scsi_cmnd
*))
1111 struct srp_target_port
*target
= host_to_target(scmnd
->device
->host
);
1112 struct srp_request
*req
;
1114 struct srp_cmd
*cmd
;
1115 struct ib_device
*dev
;
1118 if (target
->state
== SRP_TARGET_CONNECTING
)
1121 if (target
->state
== SRP_TARGET_DEAD
||
1122 target
->state
== SRP_TARGET_REMOVED
) {
1123 scmnd
->result
= DID_BAD_TARGET
<< 16;
1128 iu
= __srp_get_tx_iu(target
, SRP_IU_CMD
);
1132 dev
= target
->srp_host
->srp_dev
->dev
;
1133 ib_dma_sync_single_for_cpu(dev
, iu
->dma
, srp_max_iu_len
,
1136 req
= list_first_entry(&target
->free_reqs
, struct srp_request
, list
);
1138 scmnd
->scsi_done
= done
;
1140 scmnd
->host_scribble
= (void *) req
;
1143 memset(cmd
, 0, sizeof *cmd
);
1145 cmd
->opcode
= SRP_CMD
;
1146 cmd
->lun
= cpu_to_be64((u64
) scmnd
->device
->lun
<< 48);
1147 cmd
->tag
= req
->index
;
1148 memcpy(cmd
->cdb
, scmnd
->cmnd
, scmnd
->cmd_len
);
1153 len
= srp_map_data(scmnd
, target
, req
);
1155 shost_printk(KERN_ERR
, target
->scsi_host
,
1156 PFX
"Failed to map data\n");
1160 ib_dma_sync_single_for_device(dev
, iu
->dma
, srp_max_iu_len
,
1163 if (__srp_post_send(target
, iu
, len
)) {
1164 shost_printk(KERN_ERR
, target
->scsi_host
, PFX
"Send failed\n");
1168 list_move_tail(&req
->list
, &target
->req_queue
);
1173 srp_unmap_data(scmnd
, target
, req
);
1176 return SCSI_MLQUEUE_HOST_BUSY
;
1179 static DEF_SCSI_QCMD(srp_queuecommand
)
1181 static int srp_alloc_iu_bufs(struct srp_target_port
*target
)
1185 for (i
= 0; i
< SRP_RQ_SIZE
; ++i
) {
1186 target
->rx_ring
[i
] = srp_alloc_iu(target
->srp_host
,
1187 target
->max_ti_iu_len
,
1188 GFP_KERNEL
, DMA_FROM_DEVICE
);
1189 if (!target
->rx_ring
[i
])
1193 for (i
= 0; i
< SRP_SQ_SIZE
; ++i
) {
1194 target
->tx_ring
[i
] = srp_alloc_iu(target
->srp_host
,
1196 GFP_KERNEL
, DMA_TO_DEVICE
);
1197 if (!target
->tx_ring
[i
])
1200 list_add(&target
->tx_ring
[i
]->list
, &target
->free_tx
);
1206 for (i
= 0; i
< SRP_RQ_SIZE
; ++i
) {
1207 srp_free_iu(target
->srp_host
, target
->rx_ring
[i
]);
1208 target
->rx_ring
[i
] = NULL
;
1211 for (i
= 0; i
< SRP_SQ_SIZE
; ++i
) {
1212 srp_free_iu(target
->srp_host
, target
->tx_ring
[i
]);
1213 target
->tx_ring
[i
] = NULL
;
1219 static void srp_cm_rej_handler(struct ib_cm_id
*cm_id
,
1220 struct ib_cm_event
*event
,
1221 struct srp_target_port
*target
)
1223 struct Scsi_Host
*shost
= target
->scsi_host
;
1224 struct ib_class_port_info
*cpi
;
1227 switch (event
->param
.rej_rcvd
.reason
) {
1228 case IB_CM_REJ_PORT_CM_REDIRECT
:
1229 cpi
= event
->param
.rej_rcvd
.ari
;
1230 target
->path
.dlid
= cpi
->redirect_lid
;
1231 target
->path
.pkey
= cpi
->redirect_pkey
;
1232 cm_id
->remote_cm_qpn
= be32_to_cpu(cpi
->redirect_qp
) & 0x00ffffff;
1233 memcpy(target
->path
.dgid
.raw
, cpi
->redirect_gid
, 16);
1235 target
->status
= target
->path
.dlid
?
1236 SRP_DLID_REDIRECT
: SRP_PORT_REDIRECT
;
1239 case IB_CM_REJ_PORT_REDIRECT
:
1240 if (srp_target_is_topspin(target
)) {
1242 * Topspin/Cisco SRP gateways incorrectly send
1243 * reject reason code 25 when they mean 24
1246 memcpy(target
->path
.dgid
.raw
,
1247 event
->param
.rej_rcvd
.ari
, 16);
1249 shost_printk(KERN_DEBUG
, shost
,
1250 PFX
"Topspin/Cisco redirect to target port GID %016llx%016llx\n",
1251 (unsigned long long) be64_to_cpu(target
->path
.dgid
.global
.subnet_prefix
),
1252 (unsigned long long) be64_to_cpu(target
->path
.dgid
.global
.interface_id
));
1254 target
->status
= SRP_PORT_REDIRECT
;
1256 shost_printk(KERN_WARNING
, shost
,
1257 " REJ reason: IB_CM_REJ_PORT_REDIRECT\n");
1258 target
->status
= -ECONNRESET
;
1262 case IB_CM_REJ_DUPLICATE_LOCAL_COMM_ID
:
1263 shost_printk(KERN_WARNING
, shost
,
1264 " REJ reason: IB_CM_REJ_DUPLICATE_LOCAL_COMM_ID\n");
1265 target
->status
= -ECONNRESET
;
1268 case IB_CM_REJ_CONSUMER_DEFINED
:
1269 opcode
= *(u8
*) event
->private_data
;
1270 if (opcode
== SRP_LOGIN_REJ
) {
1271 struct srp_login_rej
*rej
= event
->private_data
;
1272 u32 reason
= be32_to_cpu(rej
->reason
);
1274 if (reason
== SRP_LOGIN_REJ_REQ_IT_IU_LENGTH_TOO_LARGE
)
1275 shost_printk(KERN_WARNING
, shost
,
1276 PFX
"SRP_LOGIN_REJ: requested max_it_iu_len too large\n");
1278 shost_printk(KERN_WARNING
, shost
,
1279 PFX
"SRP LOGIN REJECTED, reason 0x%08x\n", reason
);
1281 shost_printk(KERN_WARNING
, shost
,
1282 " REJ reason: IB_CM_REJ_CONSUMER_DEFINED,"
1283 " opcode 0x%02x\n", opcode
);
1284 target
->status
= -ECONNRESET
;
1287 case IB_CM_REJ_STALE_CONN
:
1288 shost_printk(KERN_WARNING
, shost
, " REJ reason: stale connection\n");
1289 target
->status
= SRP_STALE_CONN
;
1293 shost_printk(KERN_WARNING
, shost
, " REJ reason 0x%x\n",
1294 event
->param
.rej_rcvd
.reason
);
1295 target
->status
= -ECONNRESET
;
1299 static int srp_cm_handler(struct ib_cm_id
*cm_id
, struct ib_cm_event
*event
)
1301 struct srp_target_port
*target
= cm_id
->context
;
1302 struct ib_qp_attr
*qp_attr
= NULL
;
1308 switch (event
->event
) {
1309 case IB_CM_REQ_ERROR
:
1310 shost_printk(KERN_DEBUG
, target
->scsi_host
,
1311 PFX
"Sending CM REQ failed\n");
1313 target
->status
= -ECONNRESET
;
1316 case IB_CM_REP_RECEIVED
:
1318 opcode
= *(u8
*) event
->private_data
;
1320 if (opcode
== SRP_LOGIN_RSP
) {
1321 struct srp_login_rsp
*rsp
= event
->private_data
;
1323 target
->max_ti_iu_len
= be32_to_cpu(rsp
->max_ti_iu_len
);
1324 target
->req_lim
= be32_to_cpu(rsp
->req_lim_delta
);
1327 * Reserve credits for task management so we don't
1328 * bounce requests back to the SCSI mid-layer.
1330 target
->scsi_host
->can_queue
1331 = min(target
->req_lim
- SRP_TSK_MGMT_SQ_SIZE
,
1332 target
->scsi_host
->can_queue
);
1334 shost_printk(KERN_WARNING
, target
->scsi_host
,
1335 PFX
"Unhandled RSP opcode %#x\n", opcode
);
1336 target
->status
= -ECONNRESET
;
1340 if (!target
->rx_ring
[0]) {
1341 target
->status
= srp_alloc_iu_bufs(target
);
1346 qp_attr
= kmalloc(sizeof *qp_attr
, GFP_KERNEL
);
1348 target
->status
= -ENOMEM
;
1352 qp_attr
->qp_state
= IB_QPS_RTR
;
1353 target
->status
= ib_cm_init_qp_attr(cm_id
, qp_attr
, &attr_mask
);
1357 target
->status
= ib_modify_qp(target
->qp
, qp_attr
, attr_mask
);
1361 for (i
= 0; i
< SRP_RQ_SIZE
; i
++) {
1362 struct srp_iu
*iu
= target
->rx_ring
[i
];
1363 target
->status
= srp_post_recv(target
, iu
);
1370 qp_attr
->qp_state
= IB_QPS_RTS
;
1371 target
->status
= ib_cm_init_qp_attr(cm_id
, qp_attr
, &attr_mask
);
1375 target
->status
= ib_modify_qp(target
->qp
, qp_attr
, attr_mask
);
1379 target
->status
= ib_send_cm_rtu(cm_id
, NULL
, 0);
1385 case IB_CM_REJ_RECEIVED
:
1386 shost_printk(KERN_DEBUG
, target
->scsi_host
, PFX
"REJ received\n");
1389 srp_cm_rej_handler(cm_id
, event
, target
);
1392 case IB_CM_DREQ_RECEIVED
:
1393 shost_printk(KERN_WARNING
, target
->scsi_host
,
1394 PFX
"DREQ received - connection closed\n");
1395 if (ib_send_cm_drep(cm_id
, NULL
, 0))
1396 shost_printk(KERN_ERR
, target
->scsi_host
,
1397 PFX
"Sending CM DREP failed\n");
1400 case IB_CM_TIMEWAIT_EXIT
:
1401 shost_printk(KERN_ERR
, target
->scsi_host
,
1402 PFX
"connection closed\n");
1408 case IB_CM_MRA_RECEIVED
:
1409 case IB_CM_DREQ_ERROR
:
1410 case IB_CM_DREP_RECEIVED
:
1414 shost_printk(KERN_WARNING
, target
->scsi_host
,
1415 PFX
"Unhandled CM event %d\n", event
->event
);
1420 complete(&target
->done
);
1427 static int srp_send_tsk_mgmt(struct srp_target_port
*target
,
1428 u64 req_tag
, unsigned int lun
, u8 func
)
1430 struct ib_device
*dev
= target
->srp_host
->srp_dev
->dev
;
1432 struct srp_tsk_mgmt
*tsk_mgmt
;
1434 spin_lock_irq(target
->scsi_host
->host_lock
);
1436 if (target
->state
== SRP_TARGET_DEAD
||
1437 target
->state
== SRP_TARGET_REMOVED
)
1440 init_completion(&target
->tsk_mgmt_done
);
1442 iu
= __srp_get_tx_iu(target
, SRP_IU_TSK_MGMT
);
1446 ib_dma_sync_single_for_cpu(dev
, iu
->dma
, sizeof *tsk_mgmt
,
1449 memset(tsk_mgmt
, 0, sizeof *tsk_mgmt
);
1451 tsk_mgmt
->opcode
= SRP_TSK_MGMT
;
1452 tsk_mgmt
->lun
= cpu_to_be64((u64
) lun
<< 48);
1453 tsk_mgmt
->tag
= req_tag
| SRP_TAG_TSK_MGMT
;
1454 tsk_mgmt
->tsk_mgmt_func
= func
;
1455 tsk_mgmt
->task_tag
= req_tag
;
1457 ib_dma_sync_single_for_device(dev
, iu
->dma
, sizeof *tsk_mgmt
,
1459 if (__srp_post_send(target
, iu
, sizeof *tsk_mgmt
))
1462 spin_unlock_irq(target
->scsi_host
->host_lock
);
1464 if (!wait_for_completion_timeout(&target
->tsk_mgmt_done
,
1465 msecs_to_jiffies(SRP_ABORT_TIMEOUT_MS
)))
1471 spin_unlock_irq(target
->scsi_host
->host_lock
);
1475 static int srp_abort(struct scsi_cmnd
*scmnd
)
1477 struct srp_target_port
*target
= host_to_target(scmnd
->device
->host
);
1478 struct srp_request
*req
= (struct srp_request
*) scmnd
->host_scribble
;
1481 shost_printk(KERN_ERR
, target
->scsi_host
, "SRP abort called\n");
1483 if (!req
|| target
->qp_in_error
)
1485 if (srp_send_tsk_mgmt(target
, req
->index
, scmnd
->device
->lun
,
1486 SRP_TSK_ABORT_TASK
))
1489 spin_lock_irq(target
->scsi_host
->host_lock
);
1492 if (!target
->tsk_mgmt_status
) {
1493 srp_remove_req(target
, req
);
1494 scmnd
->result
= DID_ABORT
<< 16;
1499 spin_unlock_irq(target
->scsi_host
->host_lock
);
1504 static int srp_reset_device(struct scsi_cmnd
*scmnd
)
1506 struct srp_target_port
*target
= host_to_target(scmnd
->device
->host
);
1507 struct srp_request
*req
, *tmp
;
1509 shost_printk(KERN_ERR
, target
->scsi_host
, "SRP reset_device called\n");
1511 if (target
->qp_in_error
)
1513 if (srp_send_tsk_mgmt(target
, SRP_TAG_NO_REQ
, scmnd
->device
->lun
,
1516 if (target
->tsk_mgmt_status
)
1519 spin_lock_irq(target
->scsi_host
->host_lock
);
1521 list_for_each_entry_safe(req
, tmp
, &target
->req_queue
, list
)
1522 if (req
->scmnd
&& req
->scmnd
->device
== scmnd
->device
)
1523 srp_reset_req(target
, req
);
1525 spin_unlock_irq(target
->scsi_host
->host_lock
);
1530 static int srp_reset_host(struct scsi_cmnd
*scmnd
)
1532 struct srp_target_port
*target
= host_to_target(scmnd
->device
->host
);
1535 shost_printk(KERN_ERR
, target
->scsi_host
, PFX
"SRP reset_host called\n");
1537 if (!srp_reconnect_target(target
))
1543 static ssize_t
show_id_ext(struct device
*dev
, struct device_attribute
*attr
,
1546 struct srp_target_port
*target
= host_to_target(class_to_shost(dev
));
1548 if (target
->state
== SRP_TARGET_DEAD
||
1549 target
->state
== SRP_TARGET_REMOVED
)
1552 return sprintf(buf
, "0x%016llx\n",
1553 (unsigned long long) be64_to_cpu(target
->id_ext
));
1556 static ssize_t
show_ioc_guid(struct device
*dev
, struct device_attribute
*attr
,
1559 struct srp_target_port
*target
= host_to_target(class_to_shost(dev
));
1561 if (target
->state
== SRP_TARGET_DEAD
||
1562 target
->state
== SRP_TARGET_REMOVED
)
1565 return sprintf(buf
, "0x%016llx\n",
1566 (unsigned long long) be64_to_cpu(target
->ioc_guid
));
1569 static ssize_t
show_service_id(struct device
*dev
,
1570 struct device_attribute
*attr
, char *buf
)
1572 struct srp_target_port
*target
= host_to_target(class_to_shost(dev
));
1574 if (target
->state
== SRP_TARGET_DEAD
||
1575 target
->state
== SRP_TARGET_REMOVED
)
1578 return sprintf(buf
, "0x%016llx\n",
1579 (unsigned long long) be64_to_cpu(target
->service_id
));
1582 static ssize_t
show_pkey(struct device
*dev
, struct device_attribute
*attr
,
1585 struct srp_target_port
*target
= host_to_target(class_to_shost(dev
));
1587 if (target
->state
== SRP_TARGET_DEAD
||
1588 target
->state
== SRP_TARGET_REMOVED
)
1591 return sprintf(buf
, "0x%04x\n", be16_to_cpu(target
->path
.pkey
));
1594 static ssize_t
show_dgid(struct device
*dev
, struct device_attribute
*attr
,
1597 struct srp_target_port
*target
= host_to_target(class_to_shost(dev
));
1599 if (target
->state
== SRP_TARGET_DEAD
||
1600 target
->state
== SRP_TARGET_REMOVED
)
1603 return sprintf(buf
, "%pI6\n", target
->path
.dgid
.raw
);
1606 static ssize_t
show_orig_dgid(struct device
*dev
,
1607 struct device_attribute
*attr
, char *buf
)
1609 struct srp_target_port
*target
= host_to_target(class_to_shost(dev
));
1611 if (target
->state
== SRP_TARGET_DEAD
||
1612 target
->state
== SRP_TARGET_REMOVED
)
1615 return sprintf(buf
, "%pI6\n", target
->orig_dgid
);
1618 static ssize_t
show_req_lim(struct device
*dev
,
1619 struct device_attribute
*attr
, char *buf
)
1621 struct srp_target_port
*target
= host_to_target(class_to_shost(dev
));
1623 if (target
->state
== SRP_TARGET_DEAD
||
1624 target
->state
== SRP_TARGET_REMOVED
)
1627 return sprintf(buf
, "%d\n", target
->req_lim
);
1630 static ssize_t
show_zero_req_lim(struct device
*dev
,
1631 struct device_attribute
*attr
, char *buf
)
1633 struct srp_target_port
*target
= host_to_target(class_to_shost(dev
));
1635 if (target
->state
== SRP_TARGET_DEAD
||
1636 target
->state
== SRP_TARGET_REMOVED
)
1639 return sprintf(buf
, "%d\n", target
->zero_req_lim
);
1642 static ssize_t
show_local_ib_port(struct device
*dev
,
1643 struct device_attribute
*attr
, char *buf
)
1645 struct srp_target_port
*target
= host_to_target(class_to_shost(dev
));
1647 return sprintf(buf
, "%d\n", target
->srp_host
->port
);
1650 static ssize_t
show_local_ib_device(struct device
*dev
,
1651 struct device_attribute
*attr
, char *buf
)
1653 struct srp_target_port
*target
= host_to_target(class_to_shost(dev
));
1655 return sprintf(buf
, "%s\n", target
->srp_host
->srp_dev
->dev
->name
);
1658 static DEVICE_ATTR(id_ext
, S_IRUGO
, show_id_ext
, NULL
);
1659 static DEVICE_ATTR(ioc_guid
, S_IRUGO
, show_ioc_guid
, NULL
);
1660 static DEVICE_ATTR(service_id
, S_IRUGO
, show_service_id
, NULL
);
1661 static DEVICE_ATTR(pkey
, S_IRUGO
, show_pkey
, NULL
);
1662 static DEVICE_ATTR(dgid
, S_IRUGO
, show_dgid
, NULL
);
1663 static DEVICE_ATTR(orig_dgid
, S_IRUGO
, show_orig_dgid
, NULL
);
1664 static DEVICE_ATTR(req_lim
, S_IRUGO
, show_req_lim
, NULL
);
1665 static DEVICE_ATTR(zero_req_lim
, S_IRUGO
, show_zero_req_lim
, NULL
);
1666 static DEVICE_ATTR(local_ib_port
, S_IRUGO
, show_local_ib_port
, NULL
);
1667 static DEVICE_ATTR(local_ib_device
, S_IRUGO
, show_local_ib_device
, NULL
);
1669 static struct device_attribute
*srp_host_attrs
[] = {
1672 &dev_attr_service_id
,
1675 &dev_attr_orig_dgid
,
1677 &dev_attr_zero_req_lim
,
1678 &dev_attr_local_ib_port
,
1679 &dev_attr_local_ib_device
,
1683 static struct scsi_host_template srp_template
= {
1684 .module
= THIS_MODULE
,
1685 .name
= "InfiniBand SRP initiator",
1686 .proc_name
= DRV_NAME
,
1687 .info
= srp_target_info
,
1688 .queuecommand
= srp_queuecommand
,
1689 .eh_abort_handler
= srp_abort
,
1690 .eh_device_reset_handler
= srp_reset_device
,
1691 .eh_host_reset_handler
= srp_reset_host
,
1692 .can_queue
= SRP_CMD_SQ_SIZE
,
1694 .cmd_per_lun
= SRP_CMD_SQ_SIZE
,
1695 .use_clustering
= ENABLE_CLUSTERING
,
1696 .shost_attrs
= srp_host_attrs
1699 static int srp_add_target(struct srp_host
*host
, struct srp_target_port
*target
)
1701 struct srp_rport_identifiers ids
;
1702 struct srp_rport
*rport
;
1704 sprintf(target
->target_name
, "SRP.T10:%016llX",
1705 (unsigned long long) be64_to_cpu(target
->id_ext
));
1707 if (scsi_add_host(target
->scsi_host
, host
->srp_dev
->dev
->dma_device
))
1710 memcpy(ids
.port_id
, &target
->id_ext
, 8);
1711 memcpy(ids
.port_id
+ 8, &target
->ioc_guid
, 8);
1712 ids
.roles
= SRP_RPORT_ROLE_TARGET
;
1713 rport
= srp_rport_add(target
->scsi_host
, &ids
);
1714 if (IS_ERR(rport
)) {
1715 scsi_remove_host(target
->scsi_host
);
1716 return PTR_ERR(rport
);
1719 spin_lock(&host
->target_lock
);
1720 list_add_tail(&target
->list
, &host
->target_list
);
1721 spin_unlock(&host
->target_lock
);
1723 target
->state
= SRP_TARGET_LIVE
;
1725 scsi_scan_target(&target
->scsi_host
->shost_gendev
,
1726 0, target
->scsi_id
, SCAN_WILD_CARD
, 0);
1731 static void srp_release_dev(struct device
*dev
)
1733 struct srp_host
*host
=
1734 container_of(dev
, struct srp_host
, dev
);
1736 complete(&host
->released
);
1739 static struct class srp_class
= {
1740 .name
= "infiniband_srp",
1741 .dev_release
= srp_release_dev
1745 * Target ports are added by writing
1747 * id_ext=<SRP ID ext>,ioc_guid=<SRP IOC GUID>,dgid=<dest GID>,
1748 * pkey=<P_Key>,service_id=<service ID>
1750 * to the add_target sysfs attribute.
1754 SRP_OPT_ID_EXT
= 1 << 0,
1755 SRP_OPT_IOC_GUID
= 1 << 1,
1756 SRP_OPT_DGID
= 1 << 2,
1757 SRP_OPT_PKEY
= 1 << 3,
1758 SRP_OPT_SERVICE_ID
= 1 << 4,
1759 SRP_OPT_MAX_SECT
= 1 << 5,
1760 SRP_OPT_MAX_CMD_PER_LUN
= 1 << 6,
1761 SRP_OPT_IO_CLASS
= 1 << 7,
1762 SRP_OPT_INITIATOR_EXT
= 1 << 8,
1763 SRP_OPT_ALL
= (SRP_OPT_ID_EXT
|
1767 SRP_OPT_SERVICE_ID
),
1770 static const match_table_t srp_opt_tokens
= {
1771 { SRP_OPT_ID_EXT
, "id_ext=%s" },
1772 { SRP_OPT_IOC_GUID
, "ioc_guid=%s" },
1773 { SRP_OPT_DGID
, "dgid=%s" },
1774 { SRP_OPT_PKEY
, "pkey=%x" },
1775 { SRP_OPT_SERVICE_ID
, "service_id=%s" },
1776 { SRP_OPT_MAX_SECT
, "max_sect=%d" },
1777 { SRP_OPT_MAX_CMD_PER_LUN
, "max_cmd_per_lun=%d" },
1778 { SRP_OPT_IO_CLASS
, "io_class=%x" },
1779 { SRP_OPT_INITIATOR_EXT
, "initiator_ext=%s" },
1780 { SRP_OPT_ERR
, NULL
}
1783 static int srp_parse_options(const char *buf
, struct srp_target_port
*target
)
1785 char *options
, *sep_opt
;
1788 substring_t args
[MAX_OPT_ARGS
];
1794 options
= kstrdup(buf
, GFP_KERNEL
);
1799 while ((p
= strsep(&sep_opt
, ",")) != NULL
) {
1803 token
= match_token(p
, srp_opt_tokens
, args
);
1807 case SRP_OPT_ID_EXT
:
1808 p
= match_strdup(args
);
1813 target
->id_ext
= cpu_to_be64(simple_strtoull(p
, NULL
, 16));
1817 case SRP_OPT_IOC_GUID
:
1818 p
= match_strdup(args
);
1823 target
->ioc_guid
= cpu_to_be64(simple_strtoull(p
, NULL
, 16));
1828 p
= match_strdup(args
);
1833 if (strlen(p
) != 32) {
1834 printk(KERN_WARNING PFX
"bad dest GID parameter '%s'\n", p
);
1839 for (i
= 0; i
< 16; ++i
) {
1840 strlcpy(dgid
, p
+ i
* 2, 3);
1841 target
->path
.dgid
.raw
[i
] = simple_strtoul(dgid
, NULL
, 16);
1844 memcpy(target
->orig_dgid
, target
->path
.dgid
.raw
, 16);
1848 if (match_hex(args
, &token
)) {
1849 printk(KERN_WARNING PFX
"bad P_Key parameter '%s'\n", p
);
1852 target
->path
.pkey
= cpu_to_be16(token
);
1855 case SRP_OPT_SERVICE_ID
:
1856 p
= match_strdup(args
);
1861 target
->service_id
= cpu_to_be64(simple_strtoull(p
, NULL
, 16));
1862 target
->path
.service_id
= target
->service_id
;
1866 case SRP_OPT_MAX_SECT
:
1867 if (match_int(args
, &token
)) {
1868 printk(KERN_WARNING PFX
"bad max sect parameter '%s'\n", p
);
1871 target
->scsi_host
->max_sectors
= token
;
1874 case SRP_OPT_MAX_CMD_PER_LUN
:
1875 if (match_int(args
, &token
)) {
1876 printk(KERN_WARNING PFX
"bad max cmd_per_lun parameter '%s'\n", p
);
1879 target
->scsi_host
->cmd_per_lun
= min(token
, SRP_CMD_SQ_SIZE
);
1882 case SRP_OPT_IO_CLASS
:
1883 if (match_hex(args
, &token
)) {
1884 printk(KERN_WARNING PFX
"bad IO class parameter '%s' \n", p
);
1887 if (token
!= SRP_REV10_IB_IO_CLASS
&&
1888 token
!= SRP_REV16A_IB_IO_CLASS
) {
1889 printk(KERN_WARNING PFX
"unknown IO class parameter value"
1890 " %x specified (use %x or %x).\n",
1891 token
, SRP_REV10_IB_IO_CLASS
, SRP_REV16A_IB_IO_CLASS
);
1894 target
->io_class
= token
;
1897 case SRP_OPT_INITIATOR_EXT
:
1898 p
= match_strdup(args
);
1903 target
->initiator_ext
= cpu_to_be64(simple_strtoull(p
, NULL
, 16));
1908 printk(KERN_WARNING PFX
"unknown parameter or missing value "
1909 "'%s' in target creation request\n", p
);
1914 if ((opt_mask
& SRP_OPT_ALL
) == SRP_OPT_ALL
)
1917 for (i
= 0; i
< ARRAY_SIZE(srp_opt_tokens
); ++i
)
1918 if ((srp_opt_tokens
[i
].token
& SRP_OPT_ALL
) &&
1919 !(srp_opt_tokens
[i
].token
& opt_mask
))
1920 printk(KERN_WARNING PFX
"target creation request is "
1921 "missing parameter '%s'\n",
1922 srp_opt_tokens
[i
].pattern
);
1929 static ssize_t
srp_create_target(struct device
*dev
,
1930 struct device_attribute
*attr
,
1931 const char *buf
, size_t count
)
1933 struct srp_host
*host
=
1934 container_of(dev
, struct srp_host
, dev
);
1935 struct Scsi_Host
*target_host
;
1936 struct srp_target_port
*target
;
1940 target_host
= scsi_host_alloc(&srp_template
,
1941 sizeof (struct srp_target_port
));
1945 target_host
->transportt
= ib_srp_transport_template
;
1946 target_host
->max_lun
= SRP_MAX_LUN
;
1947 target_host
->max_cmd_len
= sizeof ((struct srp_cmd
*) (void *) 0L)->cdb
;
1949 target
= host_to_target(target_host
);
1951 target
->io_class
= SRP_REV16A_IB_IO_CLASS
;
1952 target
->scsi_host
= target_host
;
1953 target
->srp_host
= host
;
1955 INIT_LIST_HEAD(&target
->free_tx
);
1956 INIT_LIST_HEAD(&target
->free_reqs
);
1957 INIT_LIST_HEAD(&target
->req_queue
);
1958 for (i
= 0; i
< SRP_CMD_SQ_SIZE
; ++i
) {
1959 target
->req_ring
[i
].index
= i
;
1960 list_add_tail(&target
->req_ring
[i
].list
, &target
->free_reqs
);
1963 ret
= srp_parse_options(buf
, target
);
1967 ib_query_gid(host
->srp_dev
->dev
, host
->port
, 0, &target
->path
.sgid
);
1969 shost_printk(KERN_DEBUG
, target
->scsi_host
, PFX
1970 "new target: id_ext %016llx ioc_guid %016llx pkey %04x "
1971 "service_id %016llx dgid %pI6\n",
1972 (unsigned long long) be64_to_cpu(target
->id_ext
),
1973 (unsigned long long) be64_to_cpu(target
->ioc_guid
),
1974 be16_to_cpu(target
->path
.pkey
),
1975 (unsigned long long) be64_to_cpu(target
->service_id
),
1976 target
->path
.dgid
.raw
);
1978 ret
= srp_create_target_ib(target
);
1982 ret
= srp_new_cm_id(target
);
1986 target
->qp_in_error
= 0;
1987 ret
= srp_connect_target(target
);
1989 shost_printk(KERN_ERR
, target
->scsi_host
,
1990 PFX
"Connection failed\n");
1994 ret
= srp_add_target(host
, target
);
1996 goto err_disconnect
;
2001 srp_disconnect_target(target
);
2004 ib_destroy_cm_id(target
->cm_id
);
2007 srp_free_target_ib(target
);
2010 scsi_host_put(target_host
);
2015 static DEVICE_ATTR(add_target
, S_IWUSR
, NULL
, srp_create_target
);
2017 static ssize_t
show_ibdev(struct device
*dev
, struct device_attribute
*attr
,
2020 struct srp_host
*host
= container_of(dev
, struct srp_host
, dev
);
2022 return sprintf(buf
, "%s\n", host
->srp_dev
->dev
->name
);
2025 static DEVICE_ATTR(ibdev
, S_IRUGO
, show_ibdev
, NULL
);
2027 static ssize_t
show_port(struct device
*dev
, struct device_attribute
*attr
,
2030 struct srp_host
*host
= container_of(dev
, struct srp_host
, dev
);
2032 return sprintf(buf
, "%d\n", host
->port
);
2035 static DEVICE_ATTR(port
, S_IRUGO
, show_port
, NULL
);
2037 static struct srp_host
*srp_add_port(struct srp_device
*device
, u8 port
)
2039 struct srp_host
*host
;
2041 host
= kzalloc(sizeof *host
, GFP_KERNEL
);
2045 INIT_LIST_HEAD(&host
->target_list
);
2046 spin_lock_init(&host
->target_lock
);
2047 init_completion(&host
->released
);
2048 host
->srp_dev
= device
;
2051 host
->dev
.class = &srp_class
;
2052 host
->dev
.parent
= device
->dev
->dma_device
;
2053 dev_set_name(&host
->dev
, "srp-%s-%d", device
->dev
->name
, port
);
2055 if (device_register(&host
->dev
))
2057 if (device_create_file(&host
->dev
, &dev_attr_add_target
))
2059 if (device_create_file(&host
->dev
, &dev_attr_ibdev
))
2061 if (device_create_file(&host
->dev
, &dev_attr_port
))
2067 device_unregister(&host
->dev
);
2075 static void srp_add_one(struct ib_device
*device
)
2077 struct srp_device
*srp_dev
;
2078 struct ib_device_attr
*dev_attr
;
2079 struct ib_fmr_pool_param fmr_param
;
2080 struct srp_host
*host
;
2083 dev_attr
= kmalloc(sizeof *dev_attr
, GFP_KERNEL
);
2087 if (ib_query_device(device
, dev_attr
)) {
2088 printk(KERN_WARNING PFX
"Query device failed for %s\n",
2093 srp_dev
= kmalloc(sizeof *srp_dev
, GFP_KERNEL
);
2098 * Use the smallest page size supported by the HCA, down to a
2099 * minimum of 512 bytes (which is the smallest sector that a
2100 * SCSI command will ever carry).
2102 srp_dev
->fmr_page_shift
= max(9, ffs(dev_attr
->page_size_cap
) - 1);
2103 srp_dev
->fmr_page_size
= 1 << srp_dev
->fmr_page_shift
;
2104 srp_dev
->fmr_page_mask
= ~((u64
) srp_dev
->fmr_page_size
- 1);
2106 INIT_LIST_HEAD(&srp_dev
->dev_list
);
2108 srp_dev
->dev
= device
;
2109 srp_dev
->pd
= ib_alloc_pd(device
);
2110 if (IS_ERR(srp_dev
->pd
))
2113 srp_dev
->mr
= ib_get_dma_mr(srp_dev
->pd
,
2114 IB_ACCESS_LOCAL_WRITE
|
2115 IB_ACCESS_REMOTE_READ
|
2116 IB_ACCESS_REMOTE_WRITE
);
2117 if (IS_ERR(srp_dev
->mr
))
2120 memset(&fmr_param
, 0, sizeof fmr_param
);
2121 fmr_param
.pool_size
= SRP_FMR_POOL_SIZE
;
2122 fmr_param
.dirty_watermark
= SRP_FMR_DIRTY_SIZE
;
2123 fmr_param
.cache
= 1;
2124 fmr_param
.max_pages_per_fmr
= SRP_FMR_SIZE
;
2125 fmr_param
.page_shift
= srp_dev
->fmr_page_shift
;
2126 fmr_param
.access
= (IB_ACCESS_LOCAL_WRITE
|
2127 IB_ACCESS_REMOTE_WRITE
|
2128 IB_ACCESS_REMOTE_READ
);
2130 srp_dev
->fmr_pool
= ib_create_fmr_pool(srp_dev
->pd
, &fmr_param
);
2131 if (IS_ERR(srp_dev
->fmr_pool
))
2132 srp_dev
->fmr_pool
= NULL
;
2134 if (device
->node_type
== RDMA_NODE_IB_SWITCH
) {
2139 e
= device
->phys_port_cnt
;
2142 for (p
= s
; p
<= e
; ++p
) {
2143 host
= srp_add_port(srp_dev
, p
);
2145 list_add_tail(&host
->list
, &srp_dev
->dev_list
);
2148 ib_set_client_data(device
, &srp_client
, srp_dev
);
2153 ib_dealloc_pd(srp_dev
->pd
);
2162 static void srp_remove_one(struct ib_device
*device
)
2164 struct srp_device
*srp_dev
;
2165 struct srp_host
*host
, *tmp_host
;
2166 LIST_HEAD(target_list
);
2167 struct srp_target_port
*target
, *tmp_target
;
2169 srp_dev
= ib_get_client_data(device
, &srp_client
);
2171 list_for_each_entry_safe(host
, tmp_host
, &srp_dev
->dev_list
, list
) {
2172 device_unregister(&host
->dev
);
2174 * Wait for the sysfs entry to go away, so that no new
2175 * target ports can be created.
2177 wait_for_completion(&host
->released
);
2180 * Mark all target ports as removed, so we stop queueing
2181 * commands and don't try to reconnect.
2183 spin_lock(&host
->target_lock
);
2184 list_for_each_entry(target
, &host
->target_list
, list
) {
2185 spin_lock_irq(target
->scsi_host
->host_lock
);
2186 target
->state
= SRP_TARGET_REMOVED
;
2187 spin_unlock_irq(target
->scsi_host
->host_lock
);
2189 spin_unlock(&host
->target_lock
);
2192 * Wait for any reconnection tasks that may have
2193 * started before we marked our target ports as
2194 * removed, and any target port removal tasks.
2196 flush_scheduled_work();
2198 list_for_each_entry_safe(target
, tmp_target
,
2199 &host
->target_list
, list
) {
2200 srp_remove_host(target
->scsi_host
);
2201 scsi_remove_host(target
->scsi_host
);
2202 srp_disconnect_target(target
);
2203 ib_destroy_cm_id(target
->cm_id
);
2204 srp_free_target_ib(target
);
2205 scsi_host_put(target
->scsi_host
);
2211 if (srp_dev
->fmr_pool
)
2212 ib_destroy_fmr_pool(srp_dev
->fmr_pool
);
2213 ib_dereg_mr(srp_dev
->mr
);
2214 ib_dealloc_pd(srp_dev
->pd
);
2219 static struct srp_function_template ib_srp_transport_functions
= {
2222 static int __init
srp_init_module(void)
2226 BUILD_BUG_ON(FIELD_SIZEOF(struct ib_wc
, wr_id
) < sizeof(void *));
2228 if (srp_sg_tablesize
> 255) {
2229 printk(KERN_WARNING PFX
"Clamping srp_sg_tablesize to 255\n");
2230 srp_sg_tablesize
= 255;
2233 ib_srp_transport_template
=
2234 srp_attach_transport(&ib_srp_transport_functions
);
2235 if (!ib_srp_transport_template
)
2238 srp_template
.sg_tablesize
= srp_sg_tablesize
;
2239 srp_max_iu_len
= (sizeof (struct srp_cmd
) +
2240 sizeof (struct srp_indirect_buf
) +
2241 srp_sg_tablesize
* 16);
2243 ret
= class_register(&srp_class
);
2245 printk(KERN_ERR PFX
"couldn't register class infiniband_srp\n");
2246 srp_release_transport(ib_srp_transport_template
);
2250 ib_sa_register_client(&srp_sa_client
);
2252 ret
= ib_register_client(&srp_client
);
2254 printk(KERN_ERR PFX
"couldn't register IB client\n");
2255 srp_release_transport(ib_srp_transport_template
);
2256 ib_sa_unregister_client(&srp_sa_client
);
2257 class_unregister(&srp_class
);
2264 static void __exit
srp_cleanup_module(void)
2266 ib_unregister_client(&srp_client
);
2267 ib_sa_unregister_client(&srp_sa_client
);
2268 class_unregister(&srp_class
);
2269 srp_release_transport(ib_srp_transport_template
);
2272 module_init(srp_init_module
);
2273 module_exit(srp_cleanup_module
);