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;
62 struct scatterlist *sg;
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 printk(KERN_INFO "%s: cmd %p data_nents %u len %u se_cmd_flags <0x%x>\n",
76 caller, cmd, se_cmd->t_data_nents,
77 se_cmd->data_length, se_cmd->se_cmd_flags);
79 for_each_sg(se_cmd->t_data_sg, sg, se_cmd->t_data_nents, count)
80 printk(KERN_INFO "%s: cmd %p sg %p page %p "
81 "len 0x%x off 0x%x\n",
83 sg_page(sg), sg->length, sg->offset);
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 ft_tpg *tpg = sess->tport->tpg;
100 struct se_queue_obj *qobj = &tpg->qobj;
103 qobj = &sess->tport->tpg->qobj;
104 spin_lock_irqsave(&qobj->cmd_queue_lock, flags);
105 list_add_tail(&cmd->se_req.qr_list, &qobj->qobj_list);
106 atomic_inc(&qobj->queue_cnt);
107 spin_unlock_irqrestore(&qobj->cmd_queue_lock, flags);
109 wake_up_process(tpg->thread);
112 static struct ft_cmd *ft_dequeue_cmd(struct se_queue_obj *qobj)
115 struct se_queue_req *qr;
117 spin_lock_irqsave(&qobj->cmd_queue_lock, flags);
118 if (list_empty(&qobj->qobj_list)) {
119 spin_unlock_irqrestore(&qobj->cmd_queue_lock, flags);
122 qr = list_first_entry(&qobj->qobj_list, struct se_queue_req, qr_list);
123 list_del(&qr->qr_list);
124 atomic_dec(&qobj->queue_cnt);
125 spin_unlock_irqrestore(&qobj->cmd_queue_lock, flags);
126 return container_of(qr, struct ft_cmd, se_req);
129 static void ft_free_cmd(struct ft_cmd *cmd)
132 struct fc_lport *lport;
139 lport->tt.seq_release(fr_seq(fp));
141 ft_sess_put(cmd->sess); /* undo get from lookup at recv */
145 void ft_release_cmd(struct se_cmd *se_cmd)
147 struct ft_cmd *cmd = container_of(se_cmd, struct ft_cmd, se_cmd);
152 void ft_check_stop_free(struct se_cmd *se_cmd)
154 transport_generic_free_cmd(se_cmd, 0, 0);
160 int ft_queue_status(struct se_cmd *se_cmd)
162 struct ft_cmd *cmd = container_of(se_cmd, struct ft_cmd, se_cmd);
164 struct fcp_resp_with_ext *fcp;
165 struct fc_lport *lport;
169 ft_dump_cmd(cmd, __func__);
170 ep = fc_seq_exch(cmd->seq);
172 len = sizeof(*fcp) + se_cmd->scsi_sense_length;
173 fp = fc_frame_alloc(lport, len);
175 /* XXX shouldn't just drop it - requeue and retry? */
178 fcp = fc_frame_payload_get(fp, len);
180 fcp->resp.fr_status = se_cmd->scsi_status;
182 len = se_cmd->scsi_sense_length;
184 fcp->resp.fr_flags |= FCP_SNS_LEN_VAL;
185 fcp->ext.fr_sns_len = htonl(len);
186 memcpy((fcp + 1), se_cmd->sense_buffer, len);
190 * Test underflow and overflow with one mask. Usually both are off.
191 * Bidirectional commands are not handled yet.
193 if (se_cmd->se_cmd_flags & (SCF_OVERFLOW_BIT | SCF_UNDERFLOW_BIT)) {
194 if (se_cmd->se_cmd_flags & SCF_OVERFLOW_BIT)
195 fcp->resp.fr_flags |= FCP_RESID_OVER;
197 fcp->resp.fr_flags |= FCP_RESID_UNDER;
198 fcp->ext.fr_resid = cpu_to_be32(se_cmd->residual_count);
204 cmd->seq = lport->tt.seq_start_next(cmd->seq);
205 fc_fill_fc_hdr(fp, FC_RCTL_DD_CMD_STATUS, ep->did, ep->sid, FC_TYPE_FCP,
206 FC_FC_EX_CTX | FC_FC_LAST_SEQ | FC_FC_END_SEQ, 0);
208 lport->tt.seq_send(lport, cmd->seq, fp);
209 lport->tt.exch_done(cmd->seq);
213 int ft_write_pending_status(struct se_cmd *se_cmd)
215 struct ft_cmd *cmd = container_of(se_cmd, struct ft_cmd, se_cmd);
217 return cmd->write_data_len != se_cmd->data_length;
221 * Send TX_RDY (transfer ready).
223 int ft_write_pending(struct se_cmd *se_cmd)
225 struct ft_cmd *cmd = container_of(se_cmd, struct ft_cmd, se_cmd);
227 struct fcp_txrdy *txrdy;
228 struct fc_lport *lport;
230 struct fc_frame_header *fh;
233 ft_dump_cmd(cmd, __func__);
235 ep = fc_seq_exch(cmd->seq);
237 fp = fc_frame_alloc(lport, sizeof(*txrdy));
239 return PYX_TRANSPORT_OUT_OF_MEMORY_RESOURCES;
241 txrdy = fc_frame_payload_get(fp, sizeof(*txrdy));
242 memset(txrdy, 0, sizeof(*txrdy));
243 txrdy->ft_burst_len = htonl(se_cmd->data_length);
245 cmd->seq = lport->tt.seq_start_next(cmd->seq);
246 fc_fill_fc_hdr(fp, FC_RCTL_DD_DATA_DESC, ep->did, ep->sid, FC_TYPE_FCP,
247 FC_FC_EX_CTX | FC_FC_END_SEQ | FC_FC_SEQ_INIT, 0);
249 fh = fc_frame_header_get(fp);
250 f_ctl = ntoh24(fh->fh_f_ctl);
252 /* Only if it is 'Exchange Responder' */
253 if (f_ctl & FC_FC_EX_CTX) {
254 /* Target is 'exchange responder' and sending XFER_READY
255 * to 'exchange initiator (initiator)'
257 if ((ep->xid <= lport->lro_xid) &&
258 (fh->fh_r_ctl == FC_RCTL_DD_DATA_DESC)) {
259 if (se_cmd->se_cmd_flags & SCF_SCSI_DATA_SG_IO_CDB) {
261 * cmd may have been broken up into multiple
262 * tasks. Link their sgs together so we can
263 * operate on them all at once.
265 transport_do_task_sg_chain(se_cmd);
266 cmd->sg = se_cmd->t_tasks_sg_chained;
268 se_cmd->t_tasks_sg_chained_no;
270 if (cmd->sg && lport->tt.ddp_setup(lport, ep->xid,
271 cmd->sg, cmd->sg_cnt))
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 */
299 * FC sequence response handler for follow-on sequences (data) and aborts.
301 static void ft_recv_seq(struct fc_seq *sp, struct fc_frame *fp, void *arg)
303 struct ft_cmd *cmd = arg;
304 struct fc_frame_header *fh;
307 /* XXX need to find cmd if queued */
308 cmd->se_cmd.t_state = TRANSPORT_REMOVE;
310 transport_generic_free_cmd(&cmd->se_cmd, 0, 0);
314 fh = fc_frame_header_get(fp);
316 switch (fh->fh_r_ctl) {
317 case FC_RCTL_DD_SOL_DATA: /* write data */
318 ft_recv_write_data(cmd, fp);
320 case FC_RCTL_DD_UNSOL_CTL: /* command */
321 case FC_RCTL_DD_SOL_CTL: /* transfer ready */
322 case FC_RCTL_DD_DATA_DESC: /* transfer ready */
324 printk(KERN_INFO "%s: unhandled frame r_ctl %x\n",
325 __func__, fh->fh_r_ctl);
327 transport_generic_free_cmd(&cmd->se_cmd, 0, 0);
333 * Send a FCP response including SCSI status and optional FCP rsp_code.
334 * status is SAM_STAT_GOOD (zero) iff code is valid.
335 * This is used in error cases, such as allocation failures.
337 static void ft_send_resp_status(struct fc_lport *lport,
338 const struct fc_frame *rx_fp,
339 u32 status, enum fcp_resp_rsp_codes code)
343 const struct fc_frame_header *fh;
345 struct fcp_resp_with_ext *fcp;
346 struct fcp_resp_rsp_info *info;
348 fh = fc_frame_header_get(rx_fp);
349 FT_IO_DBG("FCP error response: did %x oxid %x status %x code %x\n",
350 ntoh24(fh->fh_s_id), ntohs(fh->fh_ox_id), status, code);
352 if (status == SAM_STAT_GOOD)
353 len += sizeof(*info);
354 fp = fc_frame_alloc(lport, len);
357 fcp = fc_frame_payload_get(fp, len);
359 fcp->resp.fr_status = status;
360 if (status == SAM_STAT_GOOD) {
361 fcp->ext.fr_rsp_len = htonl(sizeof(*info));
362 fcp->resp.fr_flags |= FCP_RSP_LEN_VAL;
363 info = (struct fcp_resp_rsp_info *)(fcp + 1);
364 info->rsp_code = code;
367 fc_fill_reply_hdr(fp, rx_fp, FC_RCTL_DD_CMD_STATUS, 0);
370 lport->tt.seq_send(lport, sp, fp);
372 lport->tt.frame_send(lport, fp);
376 * Send error or task management response.
377 * Always frees the cmd and associated state.
379 static void ft_send_resp_code(struct ft_cmd *cmd, enum fcp_resp_rsp_codes code)
381 ft_send_resp_status(cmd->sess->tport->lport,
382 cmd->req_frame, SAM_STAT_GOOD, code);
387 * Handle Task Management Request.
389 static void ft_send_tm(struct ft_cmd *cmd)
391 struct se_tmr_req *tmr;
392 struct fcp_cmnd *fcp;
393 struct ft_sess *sess;
396 fcp = fc_frame_payload_get(cmd->req_frame, sizeof(*fcp));
398 switch (fcp->fc_tm_flags) {
399 case FCP_TMF_LUN_RESET:
400 tm_func = TMR_LUN_RESET;
402 case FCP_TMF_TGT_RESET:
403 tm_func = TMR_TARGET_WARM_RESET;
405 case FCP_TMF_CLR_TASK_SET:
406 tm_func = TMR_CLEAR_TASK_SET;
408 case FCP_TMF_ABT_TASK_SET:
409 tm_func = TMR_ABORT_TASK_SET;
411 case FCP_TMF_CLR_ACA:
412 tm_func = TMR_CLEAR_ACA;
416 * FCP4r01 indicates having a combination of
417 * tm_flags set is invalid.
419 FT_TM_DBG("invalid FCP tm_flags %x\n", fcp->fc_tm_flags);
420 ft_send_resp_code(cmd, FCP_CMND_FIELDS_INVALID);
424 FT_TM_DBG("alloc tm cmd fn %d\n", tm_func);
425 tmr = core_tmr_alloc_req(&cmd->se_cmd, cmd, tm_func);
427 FT_TM_DBG("alloc failed\n");
428 ft_send_resp_code(cmd, FCP_TMF_FAILED);
431 cmd->se_cmd.se_tmr_req = tmr;
433 switch (fcp->fc_tm_flags) {
434 case FCP_TMF_LUN_RESET:
435 cmd->lun = scsilun_to_int((struct scsi_lun *)fcp->fc_lun);
436 if (transport_lookup_tmr_lun(&cmd->se_cmd, cmd->lun) < 0) {
438 * Make sure to clean up newly allocated TMR request
439 * since "unable to handle TMR request because failed
442 FT_TM_DBG("Failed to get LUN for TMR func %d, "
443 "se_cmd %p, unpacked_lun %d\n",
444 tm_func, &cmd->se_cmd, cmd->lun);
445 ft_dump_cmd(cmd, __func__);
447 transport_send_check_condition_and_sense(&cmd->se_cmd,
448 cmd->se_cmd.scsi_sense_reason, 0);
449 transport_generic_free_cmd(&cmd->se_cmd, 0, 0);
454 case FCP_TMF_TGT_RESET:
455 case FCP_TMF_CLR_TASK_SET:
456 case FCP_TMF_ABT_TASK_SET:
457 case FCP_TMF_CLR_ACA:
462 transport_generic_handle_tmr(&cmd->se_cmd);
466 * Send status from completed task management request.
468 int ft_queue_tm_resp(struct se_cmd *se_cmd)
470 struct ft_cmd *cmd = container_of(se_cmd, struct ft_cmd, se_cmd);
471 struct se_tmr_req *tmr = se_cmd->se_tmr_req;
472 enum fcp_resp_rsp_codes code;
474 switch (tmr->response) {
475 case TMR_FUNCTION_COMPLETE:
478 case TMR_LUN_DOES_NOT_EXIST:
479 code = FCP_TMF_INVALID_LUN;
481 case TMR_FUNCTION_REJECTED:
482 code = FCP_TMF_REJECTED;
484 case TMR_TASK_DOES_NOT_EXIST:
485 case TMR_TASK_STILL_ALLEGIANT:
486 case TMR_TASK_FAILOVER_NOT_SUPPORTED:
487 case TMR_TASK_MGMT_FUNCTION_NOT_SUPPORTED:
488 case TMR_FUNCTION_AUTHORIZATION_FAILED:
490 code = FCP_TMF_FAILED;
493 FT_TM_DBG("tmr fn %d resp %d fcp code %d\n",
494 tmr->function, tmr->response, code);
495 ft_send_resp_code(cmd, code);
500 * Handle incoming FCP command.
502 static void ft_recv_cmd(struct ft_sess *sess, struct fc_frame *fp)
505 struct fc_lport *lport = sess->tport->lport;
507 cmd = kzalloc(sizeof(*cmd), GFP_ATOMIC);
511 cmd->seq = lport->tt.seq_assign(lport, fp);
516 cmd->req_frame = fp; /* hold frame during cmd */
517 ft_queue_cmd(sess, cmd);
521 FT_IO_DBG("cmd or seq allocation failure - sending BUSY\n");
522 ft_send_resp_status(lport, fp, SAM_STAT_BUSY, 0);
524 ft_sess_put(sess); /* undo get from lookup */
529 * Handle incoming FCP frame.
530 * Caller has verified that the frame is type FCP.
532 void ft_recv_req(struct ft_sess *sess, struct fc_frame *fp)
534 struct fc_frame_header *fh = fc_frame_header_get(fp);
536 switch (fh->fh_r_ctl) {
537 case FC_RCTL_DD_UNSOL_CMD: /* command */
538 ft_recv_cmd(sess, fp);
540 case FC_RCTL_DD_SOL_DATA: /* write data */
541 case FC_RCTL_DD_UNSOL_CTL:
542 case FC_RCTL_DD_SOL_CTL:
543 case FC_RCTL_DD_DATA_DESC: /* transfer ready */
544 case FC_RCTL_ELS4_REQ: /* SRR, perhaps */
546 printk(KERN_INFO "%s: unhandled frame r_ctl %x\n",
547 __func__, fh->fh_r_ctl);
549 ft_sess_put(sess); /* undo get from lookup */
555 * Send new command to target.
557 static void ft_send_cmd(struct ft_cmd *cmd)
559 struct fc_frame_header *fh = fc_frame_header_get(cmd->req_frame);
560 struct se_cmd *se_cmd;
561 struct fcp_cmnd *fcp;
567 fcp = fc_frame_payload_get(cmd->req_frame, sizeof(*fcp));
571 if (fcp->fc_flags & FCP_CFL_LEN_MASK)
572 goto err; /* not handling longer CDBs yet */
574 if (fcp->fc_tm_flags) {
575 task_attr = FCP_PTA_SIMPLE;
579 switch (fcp->fc_flags & (FCP_CFL_RDDATA | FCP_CFL_WRDATA)) {
584 data_dir = DMA_FROM_DEVICE;
587 data_dir = DMA_TO_DEVICE;
589 case FCP_CFL_WRDATA | FCP_CFL_RDDATA:
590 goto err; /* TBD not supported by tcm_fc yet */
593 * Locate the SAM Task Attr from fc_pri_ta
595 switch (fcp->fc_pri_ta & FCP_PTA_MASK) {
597 task_attr = MSG_HEAD_TAG;
599 case FCP_PTA_ORDERED:
600 task_attr = MSG_ORDERED_TAG;
603 task_attr = MSG_ACA_TAG;
605 case FCP_PTA_SIMPLE: /* Fallthrough */
607 task_attr = MSG_SIMPLE_TAG;
611 task_attr = fcp->fc_pri_ta & FCP_PTA_MASK;
612 data_len = ntohl(fcp->fc_dl);
613 cmd->cdb = fcp->fc_cdb;
616 se_cmd = &cmd->se_cmd;
618 * Initialize struct se_cmd descriptor from target_core_mod
621 transport_init_se_cmd(se_cmd, &ft_configfs->tf_ops, cmd->sess->se_sess,
622 data_len, data_dir, task_attr,
623 &cmd->ft_sense_buffer[0]);
625 * Check for FCP task management flags
627 if (fcp->fc_tm_flags) {
632 fc_seq_exch(cmd->seq)->lp->tt.seq_set_resp(cmd->seq, ft_recv_seq, cmd);
634 cmd->lun = scsilun_to_int((struct scsi_lun *)fcp->fc_lun);
635 ret = transport_lookup_cmd_lun(&cmd->se_cmd, cmd->lun);
637 ft_dump_cmd(cmd, __func__);
638 transport_send_check_condition_and_sense(&cmd->se_cmd,
639 cmd->se_cmd.scsi_sense_reason, 0);
643 ret = transport_generic_allocate_tasks(se_cmd, cmd->cdb);
645 FT_IO_DBG("r_ctl %x alloc task ret %d\n", fh->fh_r_ctl, ret);
646 ft_dump_cmd(cmd, __func__);
648 if (ret == -ENOMEM) {
649 transport_send_check_condition_and_sense(se_cmd,
650 TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE, 0);
651 transport_generic_free_cmd(se_cmd, 0, 0);
654 if (ret == -EINVAL) {
655 if (se_cmd->se_cmd_flags & SCF_SCSI_RESERVATION_CONFLICT)
656 ft_queue_status(se_cmd);
658 transport_send_check_condition_and_sense(se_cmd,
659 se_cmd->scsi_sense_reason, 0);
660 transport_generic_free_cmd(se_cmd, 0, 0);
663 transport_generic_handle_cdb(se_cmd);
667 ft_send_resp_code(cmd, FCP_CMND_FIELDS_INVALID);
671 * Handle request in the command thread.
673 static void ft_exec_req(struct ft_cmd *cmd)
675 FT_IO_DBG("cmd state %x\n", cmd->state);
676 switch (cmd->state) {
687 * Currently one thread per tpg.
689 int ft_thread(void *arg)
691 struct ft_tpg *tpg = arg;
692 struct se_queue_obj *qobj = &tpg->qobj;
695 while (!kthread_should_stop()) {
696 schedule_timeout_interruptible(MAX_SCHEDULE_TIMEOUT);
697 if (kthread_should_stop())
700 cmd = ft_dequeue_cmd(qobj);