2 * Copyright (c) 2010 Cisco Systems, Inc.
4 * This program is free software; you can redistribute it and/or modify it
5 * under the terms and conditions of the GNU General Public License,
6 * version 2, as published by the Free Software Foundation.
8 * This program is distributed in the hope it will be useful, but WITHOUT
9 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
10 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
13 * You should have received a copy of the GNU General Public License along with
14 * this program; if not, write to the Free Software Foundation, Inc.,
15 * 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
18 /* XXX TBD some includes may be extraneous */
20 #include <linux/module.h>
21 #include <linux/moduleparam.h>
22 #include <linux/version.h>
23 #include <generated/utsrelease.h>
24 #include <linux/utsname.h>
25 #include <linux/init.h>
26 #include <linux/slab.h>
27 #include <linux/kthread.h>
28 #include <linux/types.h>
29 #include <linux/string.h>
30 #include <linux/configfs.h>
31 #include <linux/ctype.h>
32 #include <linux/hash.h>
33 #include <asm/unaligned.h>
34 #include <scsi/scsi.h>
35 #include <scsi/scsi_host.h>
36 #include <scsi/scsi_device.h>
37 #include <scsi/scsi_cmnd.h>
38 #include <scsi/scsi_tcq.h>
39 #include <scsi/libfc.h>
40 #include <scsi/fc_encode.h>
42 #include <target/target_core_base.h>
43 #include <target/target_core_transport.h>
44 #include <target/target_core_fabric_ops.h>
45 #include <target/target_core_device.h>
46 #include <target/target_core_tpg.h>
47 #include <target/target_core_configfs.h>
48 #include <target/target_core_base.h>
49 #include <target/target_core_tmr.h>
50 #include <target/configfs_macros.h>
55 * Dump cmd state for debugging.
57 void ft_dump_cmd(struct ft_cmd *cmd, const char *caller)
61 struct se_cmd *se_cmd;
63 struct se_transport_task *task;
65 if (!(ft_debug_logging & FT_DEBUG_IO))
68 se_cmd = &cmd->se_cmd;
69 printk(KERN_INFO "%s: cmd %p state %d sess %p seq %p se_cmd %p\n",
70 caller, cmd, cmd->state, cmd->sess, cmd->seq, se_cmd);
71 printk(KERN_INFO "%s: cmd %p cdb %p\n",
72 caller, cmd, cmd->cdb);
73 printk(KERN_INFO "%s: cmd %p lun %d\n", caller, cmd, cmd->lun);
75 task = T_TASK(se_cmd);
76 printk(KERN_INFO "%s: cmd %p task %p se_num %u buf %p len %u se_cmd_flags <0x%x>\n",
77 caller, cmd, task, task->t_tasks_se_num,
78 task->t_task_buf, se_cmd->data_length, se_cmd->se_cmd_flags);
80 list_for_each_entry(mem, task->t_mem_list, se_list)
81 printk(KERN_INFO "%s: cmd %p mem %p page %p "
82 "len 0x%x off 0x%x\n",
84 mem->se_page, mem->se_len, mem->se_off);
88 printk(KERN_INFO "%s: cmd %p sid %x did %x "
89 "ox_id %x rx_id %x seq_id %x e_stat %x\n",
90 caller, cmd, ep->sid, ep->did, ep->oxid, ep->rxid,
91 sp->id, ep->esb_stat);
93 print_hex_dump(KERN_INFO, "ft_dump_cmd ", DUMP_PREFIX_NONE,
94 16, 4, cmd->cdb, MAX_COMMAND_SIZE, 0);
97 static void ft_queue_cmd(struct ft_sess *sess, struct ft_cmd *cmd)
99 struct se_queue_obj *qobj;
102 qobj = &sess->tport->tpg->qobj;
103 spin_lock_irqsave(&qobj->cmd_queue_lock, flags);
104 list_add_tail(&cmd->se_req.qr_list, &qobj->qobj_list);
105 spin_unlock_irqrestore(&qobj->cmd_queue_lock, flags);
106 atomic_inc(&qobj->queue_cnt);
107 wake_up_interruptible(&qobj->thread_wq);
110 static struct ft_cmd *ft_dequeue_cmd(struct se_queue_obj *qobj)
113 struct se_queue_req *qr;
115 spin_lock_irqsave(&qobj->cmd_queue_lock, flags);
116 if (list_empty(&qobj->qobj_list)) {
117 spin_unlock_irqrestore(&qobj->cmd_queue_lock, flags);
120 qr = list_first_entry(&qobj->qobj_list, struct se_queue_req, qr_list);
121 list_del(&qr->qr_list);
122 atomic_dec(&qobj->queue_cnt);
123 spin_unlock_irqrestore(&qobj->cmd_queue_lock, flags);
124 return container_of(qr, struct ft_cmd, se_req);
127 static void ft_free_cmd(struct ft_cmd *cmd)
130 struct fc_lport *lport;
137 lport->tt.seq_release(fr_seq(fp));
139 ft_sess_put(cmd->sess); /* undo get from lookup at recv */
143 void ft_release_cmd(struct se_cmd *se_cmd)
145 struct ft_cmd *cmd = container_of(se_cmd, struct ft_cmd, se_cmd);
150 void ft_check_stop_free(struct se_cmd *se_cmd)
152 transport_generic_free_cmd(se_cmd, 0, 1, 0);
158 int ft_queue_status(struct se_cmd *se_cmd)
160 struct ft_cmd *cmd = container_of(se_cmd, struct ft_cmd, se_cmd);
162 struct fcp_resp_with_ext *fcp;
163 struct fc_lport *lport;
167 ft_dump_cmd(cmd, __func__);
168 ep = fc_seq_exch(cmd->seq);
170 len = sizeof(*fcp) + se_cmd->scsi_sense_length;
171 fp = fc_frame_alloc(lport, len);
173 /* XXX shouldn't just drop it - requeue and retry? */
176 fcp = fc_frame_payload_get(fp, len);
178 fcp->resp.fr_status = se_cmd->scsi_status;
180 len = se_cmd->scsi_sense_length;
182 fcp->resp.fr_flags |= FCP_SNS_LEN_VAL;
183 fcp->ext.fr_sns_len = htonl(len);
184 memcpy((fcp + 1), se_cmd->sense_buffer, len);
188 * Test underflow and overflow with one mask. Usually both are off.
189 * Bidirectional commands are not handled yet.
191 if (se_cmd->se_cmd_flags & (SCF_OVERFLOW_BIT | SCF_UNDERFLOW_BIT)) {
192 if (se_cmd->se_cmd_flags & SCF_OVERFLOW_BIT)
193 fcp->resp.fr_flags |= FCP_RESID_OVER;
195 fcp->resp.fr_flags |= FCP_RESID_UNDER;
196 fcp->ext.fr_resid = cpu_to_be32(se_cmd->residual_count);
202 cmd->seq = lport->tt.seq_start_next(cmd->seq);
203 fc_fill_fc_hdr(fp, FC_RCTL_DD_CMD_STATUS, ep->did, ep->sid, FC_TYPE_FCP,
204 FC_FC_EX_CTX | FC_FC_LAST_SEQ | FC_FC_END_SEQ, 0);
206 lport->tt.seq_send(lport, cmd->seq, fp);
207 lport->tt.exch_done(cmd->seq);
211 int ft_write_pending_status(struct se_cmd *se_cmd)
213 struct ft_cmd *cmd = container_of(se_cmd, struct ft_cmd, se_cmd);
215 return cmd->write_data_len != se_cmd->data_length;
219 * Send TX_RDY (transfer ready).
221 int ft_write_pending(struct se_cmd *se_cmd)
223 struct ft_cmd *cmd = container_of(se_cmd, struct ft_cmd, se_cmd);
225 struct fcp_txrdy *txrdy;
226 struct fc_lport *lport;
228 struct fc_frame_header *fh;
231 ft_dump_cmd(cmd, __func__);
233 ep = fc_seq_exch(cmd->seq);
235 fp = fc_frame_alloc(lport, sizeof(*txrdy));
237 return PYX_TRANSPORT_OUT_OF_MEMORY_RESOURCES;
239 txrdy = fc_frame_payload_get(fp, sizeof(*txrdy));
240 memset(txrdy, 0, sizeof(*txrdy));
241 txrdy->ft_burst_len = htonl(se_cmd->data_length);
243 cmd->seq = lport->tt.seq_start_next(cmd->seq);
244 fc_fill_fc_hdr(fp, FC_RCTL_DD_DATA_DESC, ep->did, ep->sid, FC_TYPE_FCP,
245 FC_FC_EX_CTX | FC_FC_END_SEQ | FC_FC_SEQ_INIT, 0);
247 fh = fc_frame_header_get(fp);
248 f_ctl = ntoh24(fh->fh_f_ctl);
250 /* Only if it is 'Exchange Responder' */
251 if (f_ctl & FC_FC_EX_CTX) {
252 /* Target is 'exchange responder' and sending XFER_READY
253 * to 'exchange initiator (initiator)'
255 if ((ep->xid <= lport->lro_xid) &&
256 (fh->fh_r_ctl == FC_RCTL_DD_DATA_DESC)) {
257 if (se_cmd->se_cmd_flags & SCF_SCSI_DATA_SG_IO_CDB) {
259 * Map se_mem list to scatterlist, so that
260 * DDP can be setup. DDP setup function require
261 * scatterlist. se_mem_list is internal to
264 transport_do_task_sg_chain(se_cmd);
265 cmd->sg = T_TASK(se_cmd)->t_tasks_sg_chained;
267 T_TASK(se_cmd)->t_tasks_sg_chained_no;
269 if (cmd->sg && lport->tt.ddp_target(lport, ep->xid,
272 cmd->was_ddp_setup = 1;
275 lport->tt.seq_send(lport, cmd->seq, fp);
279 u32 ft_get_task_tag(struct se_cmd *se_cmd)
281 struct ft_cmd *cmd = container_of(se_cmd, struct ft_cmd, se_cmd);
283 return fc_seq_exch(cmd->seq)->rxid;
286 int ft_get_cmd_state(struct se_cmd *se_cmd)
288 struct ft_cmd *cmd = container_of(se_cmd, struct ft_cmd, se_cmd);
293 int ft_is_state_remove(struct se_cmd *se_cmd)
295 return 0; /* XXX TBD */
298 void ft_new_cmd_failure(struct se_cmd *se_cmd)
301 printk(KERN_INFO "%s: se_cmd %p\n", __func__, se_cmd);
305 * FC sequence response handler for follow-on sequences (data) and aborts.
307 static void ft_recv_seq(struct fc_seq *sp, struct fc_frame *fp, void *arg)
309 struct ft_cmd *cmd = arg;
310 struct fc_frame_header *fh;
313 /* XXX need to find cmd if queued */
314 cmd->se_cmd.t_state = TRANSPORT_REMOVE;
316 transport_generic_free_cmd(&cmd->se_cmd, 0, 1, 0);
320 fh = fc_frame_header_get(fp);
322 switch (fh->fh_r_ctl) {
323 case FC_RCTL_DD_SOL_DATA: /* write data */
324 ft_recv_write_data(cmd, fp);
326 case FC_RCTL_DD_UNSOL_CTL: /* command */
327 case FC_RCTL_DD_SOL_CTL: /* transfer ready */
328 case FC_RCTL_DD_DATA_DESC: /* transfer ready */
330 printk(KERN_INFO "%s: unhandled frame r_ctl %x\n",
331 __func__, fh->fh_r_ctl);
333 transport_generic_free_cmd(&cmd->se_cmd, 0, 1, 0);
339 * Send a FCP response including SCSI status and optional FCP rsp_code.
340 * status is SAM_STAT_GOOD (zero) iff code is valid.
341 * This is used in error cases, such as allocation failures.
343 static void ft_send_resp_status(struct fc_lport *lport,
344 const struct fc_frame *rx_fp,
345 u32 status, enum fcp_resp_rsp_codes code)
349 const struct fc_frame_header *fh;
351 struct fcp_resp_with_ext *fcp;
352 struct fcp_resp_rsp_info *info;
354 fh = fc_frame_header_get(rx_fp);
355 FT_IO_DBG("FCP error response: did %x oxid %x status %x code %x\n",
356 ntoh24(fh->fh_s_id), ntohs(fh->fh_ox_id), status, code);
358 if (status == SAM_STAT_GOOD)
359 len += sizeof(*info);
360 fp = fc_frame_alloc(lport, len);
363 fcp = fc_frame_payload_get(fp, len);
365 fcp->resp.fr_status = status;
366 if (status == SAM_STAT_GOOD) {
367 fcp->ext.fr_rsp_len = htonl(sizeof(*info));
368 fcp->resp.fr_flags |= FCP_RSP_LEN_VAL;
369 info = (struct fcp_resp_rsp_info *)(fcp + 1);
370 info->rsp_code = code;
373 fc_fill_reply_hdr(fp, rx_fp, FC_RCTL_DD_CMD_STATUS, 0);
376 lport->tt.seq_send(lport, sp, fp);
378 lport->tt.frame_send(lport, fp);
382 * Send error or task management response.
384 static void ft_send_resp_code(struct ft_cmd *cmd,
385 enum fcp_resp_rsp_codes code)
387 ft_send_resp_status(cmd->sess->tport->lport,
388 cmd->req_frame, SAM_STAT_GOOD, code);
393 * Send error or task management response.
394 * Always frees the cmd and associated state.
396 static void ft_send_resp_code_and_free(struct ft_cmd *cmd,
397 enum fcp_resp_rsp_codes code)
399 ft_send_resp_code(cmd, code);
404 * Handle Task Management Request.
406 static void ft_send_tm(struct ft_cmd *cmd)
408 struct se_tmr_req *tmr;
409 struct fcp_cmnd *fcp;
410 struct ft_sess *sess;
413 fcp = fc_frame_payload_get(cmd->req_frame, sizeof(*fcp));
415 switch (fcp->fc_tm_flags) {
416 case FCP_TMF_LUN_RESET:
417 tm_func = TMR_LUN_RESET;
419 case FCP_TMF_TGT_RESET:
420 tm_func = TMR_TARGET_WARM_RESET;
422 case FCP_TMF_CLR_TASK_SET:
423 tm_func = TMR_CLEAR_TASK_SET;
425 case FCP_TMF_ABT_TASK_SET:
426 tm_func = TMR_ABORT_TASK_SET;
428 case FCP_TMF_CLR_ACA:
429 tm_func = TMR_CLEAR_ACA;
433 * FCP4r01 indicates having a combination of
434 * tm_flags set is invalid.
436 FT_TM_DBG("invalid FCP tm_flags %x\n", fcp->fc_tm_flags);
437 ft_send_resp_code_and_free(cmd, FCP_CMND_FIELDS_INVALID);
441 FT_TM_DBG("alloc tm cmd fn %d\n", tm_func);
442 tmr = core_tmr_alloc_req(&cmd->se_cmd, cmd, tm_func);
444 FT_TM_DBG("alloc failed\n");
445 ft_send_resp_code_and_free(cmd, FCP_TMF_FAILED);
448 cmd->se_cmd.se_tmr_req = tmr;
450 switch (fcp->fc_tm_flags) {
451 case FCP_TMF_LUN_RESET:
452 cmd->lun = scsilun_to_int((struct scsi_lun *)fcp->fc_lun);
453 if (transport_get_lun_for_tmr(&cmd->se_cmd, cmd->lun) < 0) {
455 * Make sure to clean up newly allocated TMR request
456 * since "unable to handle TMR request because failed
459 FT_TM_DBG("Failed to get LUN for TMR func %d, "
460 "se_cmd %p, unpacked_lun %d\n",
461 tm_func, &cmd->se_cmd, cmd->lun);
462 ft_dump_cmd(cmd, __func__);
464 transport_send_check_condition_and_sense(&cmd->se_cmd,
465 cmd->se_cmd.scsi_sense_reason, 0);
466 transport_generic_free_cmd(&cmd->se_cmd, 0, 1, 0);
471 case FCP_TMF_TGT_RESET:
472 case FCP_TMF_CLR_TASK_SET:
473 case FCP_TMF_ABT_TASK_SET:
474 case FCP_TMF_CLR_ACA:
479 transport_generic_handle_tmr(&cmd->se_cmd);
483 * Send status from completed task management request.
485 int ft_queue_tm_resp(struct se_cmd *se_cmd)
487 struct ft_cmd *cmd = container_of(se_cmd, struct ft_cmd, se_cmd);
488 struct se_tmr_req *tmr = se_cmd->se_tmr_req;
489 enum fcp_resp_rsp_codes code;
491 switch (tmr->response) {
492 case TMR_FUNCTION_COMPLETE:
495 case TMR_LUN_DOES_NOT_EXIST:
496 code = FCP_TMF_INVALID_LUN;
498 case TMR_FUNCTION_REJECTED:
499 code = FCP_TMF_REJECTED;
501 case TMR_TASK_DOES_NOT_EXIST:
502 case TMR_TASK_STILL_ALLEGIANT:
503 case TMR_TASK_FAILOVER_NOT_SUPPORTED:
504 case TMR_TASK_MGMT_FUNCTION_NOT_SUPPORTED:
505 case TMR_FUNCTION_AUTHORIZATION_FAILED:
507 code = FCP_TMF_FAILED;
510 FT_TM_DBG("tmr fn %d resp %d fcp code %d\n",
511 tmr->function, tmr->response, code);
512 ft_send_resp_code(cmd, code);
517 * Handle incoming FCP command.
519 static void ft_recv_cmd(struct ft_sess *sess, struct fc_frame *fp)
522 struct fc_lport *lport = sess->tport->lport;
524 cmd = kzalloc(sizeof(*cmd), GFP_ATOMIC);
528 cmd->seq = lport->tt.seq_assign(lport, fp);
533 cmd->req_frame = fp; /* hold frame during cmd */
534 ft_queue_cmd(sess, cmd);
538 FT_IO_DBG("cmd or seq allocation failure - sending BUSY\n");
539 ft_send_resp_status(lport, fp, SAM_STAT_BUSY, 0);
541 ft_sess_put(sess); /* undo get from lookup */
546 * Handle incoming FCP frame.
547 * Caller has verified that the frame is type FCP.
549 void ft_recv_req(struct ft_sess *sess, struct fc_frame *fp)
551 struct fc_frame_header *fh = fc_frame_header_get(fp);
553 switch (fh->fh_r_ctl) {
554 case FC_RCTL_DD_UNSOL_CMD: /* command */
555 ft_recv_cmd(sess, fp);
557 case FC_RCTL_DD_SOL_DATA: /* write data */
558 case FC_RCTL_DD_UNSOL_CTL:
559 case FC_RCTL_DD_SOL_CTL:
560 case FC_RCTL_DD_DATA_DESC: /* transfer ready */
561 case FC_RCTL_ELS4_REQ: /* SRR, perhaps */
563 printk(KERN_INFO "%s: unhandled frame r_ctl %x\n",
564 __func__, fh->fh_r_ctl);
566 ft_sess_put(sess); /* undo get from lookup */
572 * Send new command to target.
574 static void ft_send_cmd(struct ft_cmd *cmd)
576 struct fc_frame_header *fh = fc_frame_header_get(cmd->req_frame);
577 struct se_cmd *se_cmd;
578 struct fcp_cmnd *fcp;
584 fcp = fc_frame_payload_get(cmd->req_frame, sizeof(*fcp));
588 if (fcp->fc_flags & FCP_CFL_LEN_MASK)
589 goto err; /* not handling longer CDBs yet */
591 if (fcp->fc_tm_flags) {
592 task_attr = FCP_PTA_SIMPLE;
596 switch (fcp->fc_flags & (FCP_CFL_RDDATA | FCP_CFL_WRDATA)) {
601 data_dir = DMA_FROM_DEVICE;
604 data_dir = DMA_TO_DEVICE;
606 case FCP_CFL_WRDATA | FCP_CFL_RDDATA:
607 goto err; /* TBD not supported by tcm_fc yet */
610 * Locate the SAM Task Attr from fc_pri_ta
612 switch (fcp->fc_pri_ta & FCP_PTA_MASK) {
614 task_attr = MSG_HEAD_TAG;
616 case FCP_PTA_ORDERED:
617 task_attr = MSG_ORDERED_TAG;
620 task_attr = MSG_ACA_TAG;
622 case FCP_PTA_SIMPLE: /* Fallthrough */
624 task_attr = MSG_SIMPLE_TAG;
628 task_attr = fcp->fc_pri_ta & FCP_PTA_MASK;
629 data_len = ntohl(fcp->fc_dl);
630 cmd->cdb = fcp->fc_cdb;
633 se_cmd = &cmd->se_cmd;
635 * Initialize struct se_cmd descriptor from target_core_mod
638 transport_init_se_cmd(se_cmd, &ft_configfs->tf_ops, cmd->sess->se_sess,
639 data_len, data_dir, task_attr,
640 &cmd->ft_sense_buffer[0]);
642 * Check for FCP task management flags
644 if (fcp->fc_tm_flags) {
649 fc_seq_exch(cmd->seq)->lp->tt.seq_set_resp(cmd->seq, ft_recv_seq, cmd);
651 cmd->lun = scsilun_to_int((struct scsi_lun *)fcp->fc_lun);
652 ret = transport_get_lun_for_cmd(&cmd->se_cmd, NULL, cmd->lun);
654 ft_dump_cmd(cmd, __func__);
655 transport_send_check_condition_and_sense(&cmd->se_cmd,
656 cmd->se_cmd.scsi_sense_reason, 0);
660 ret = transport_generic_allocate_tasks(se_cmd, cmd->cdb);
662 FT_IO_DBG("r_ctl %x alloc task ret %d\n", fh->fh_r_ctl, ret);
663 ft_dump_cmd(cmd, __func__);
666 transport_send_check_condition_and_sense(se_cmd,
667 TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE, 0);
668 transport_generic_free_cmd(se_cmd, 0, 1, 0);
672 if (se_cmd->se_cmd_flags & SCF_SCSI_RESERVATION_CONFLICT)
673 ft_queue_status(se_cmd);
675 transport_send_check_condition_and_sense(se_cmd,
676 se_cmd->scsi_sense_reason, 0);
677 transport_generic_free_cmd(se_cmd, 0, 1, 0);
680 transport_generic_handle_cdb(se_cmd);
684 ft_send_resp_code_and_free(cmd, FCP_CMND_FIELDS_INVALID);
689 * Handle request in the command thread.
691 static void ft_exec_req(struct ft_cmd *cmd)
693 FT_IO_DBG("cmd state %x\n", cmd->state);
694 switch (cmd->state) {
705 * Currently one thread per tpg.
707 int ft_thread(void *arg)
709 struct ft_tpg *tpg = arg;
710 struct se_queue_obj *qobj = &tpg->qobj;
714 set_user_nice(current, -20);
716 while (!kthread_should_stop()) {
717 ret = wait_event_interruptible(qobj->thread_wq,
718 atomic_read(&qobj->queue_cnt) || kthread_should_stop());
719 if (ret < 0 || kthread_should_stop())
721 cmd = ft_dequeue_cmd(qobj);