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 <generated/utsrelease.h>
23 #include <linux/utsname.h>
24 #include <linux/init.h>
25 #include <linux/slab.h>
26 #include <linux/kthread.h>
27 #include <linux/types.h>
28 #include <linux/string.h>
29 #include <linux/configfs.h>
30 #include <linux/ctype.h>
31 #include <linux/hash.h>
32 #include <asm/unaligned.h>
33 #include <scsi/scsi.h>
34 #include <scsi/scsi_host.h>
35 #include <scsi/scsi_device.h>
36 #include <scsi/scsi_cmnd.h>
37 #include <scsi/scsi_tcq.h>
38 #include <scsi/libfc.h>
39 #include <scsi/fc_encode.h>
41 #include <target/target_core_base.h>
42 #include <target/target_core_transport.h>
43 #include <target/target_core_fabric_ops.h>
44 #include <target/target_core_device.h>
45 #include <target/target_core_tpg.h>
46 #include <target/target_core_configfs.h>
47 #include <target/target_core_tmr.h>
48 #include <target/configfs_macros.h>
53 * Dump cmd state for debugging.
55 void ft_dump_cmd(struct ft_cmd *cmd, const char *caller)
59 struct se_cmd *se_cmd;
60 struct scatterlist *sg;
63 se_cmd = &cmd->se_cmd;
64 pr_debug("%s: cmd %p sess %p seq %p se_cmd %p\n",
65 caller, cmd, cmd->sess, cmd->seq, se_cmd);
66 pr_debug("%s: cmd %p cdb %p\n",
67 caller, cmd, cmd->cdb);
68 pr_debug("%s: cmd %p lun %d\n", caller, cmd, cmd->lun);
70 pr_debug("%s: cmd %p data_nents %u len %u se_cmd_flags <0x%x>\n",
71 caller, cmd, se_cmd->t_data_nents,
72 se_cmd->data_length, se_cmd->se_cmd_flags);
74 for_each_sg(se_cmd->t_data_sg, sg, se_cmd->t_data_nents, count)
75 pr_debug("%s: cmd %p sg %p page %p "
76 "len 0x%x off 0x%x\n",
78 sg_page(sg), sg->length, sg->offset);
83 pr_debug("%s: cmd %p sid %x did %x "
84 "ox_id %x rx_id %x seq_id %x e_stat %x\n",
85 caller, cmd, ep->sid, ep->did, ep->oxid, ep->rxid,
86 sp->id, ep->esb_stat);
88 print_hex_dump(KERN_INFO, "ft_dump_cmd ", DUMP_PREFIX_NONE,
89 16, 4, cmd->cdb, MAX_COMMAND_SIZE, 0);
92 static void ft_free_cmd(struct ft_cmd *cmd)
95 struct fc_lport *lport;
102 lport->tt.seq_release(fr_seq(fp));
104 ft_sess_put(cmd->sess); /* undo get from lookup at recv */
108 void ft_release_cmd(struct se_cmd *se_cmd)
110 struct ft_cmd *cmd = container_of(se_cmd, struct ft_cmd, se_cmd);
115 int ft_check_stop_free(struct se_cmd *se_cmd)
117 transport_generic_free_cmd(se_cmd, 0);
124 int ft_queue_status(struct se_cmd *se_cmd)
126 struct ft_cmd *cmd = container_of(se_cmd, struct ft_cmd, se_cmd);
128 struct fcp_resp_with_ext *fcp;
129 struct fc_lport *lport;
135 ft_dump_cmd(cmd, __func__);
136 ep = fc_seq_exch(cmd->seq);
138 len = sizeof(*fcp) + se_cmd->scsi_sense_length;
139 fp = fc_frame_alloc(lport, len);
141 /* XXX shouldn't just drop it - requeue and retry? */
144 fcp = fc_frame_payload_get(fp, len);
146 fcp->resp.fr_status = se_cmd->scsi_status;
148 len = se_cmd->scsi_sense_length;
150 fcp->resp.fr_flags |= FCP_SNS_LEN_VAL;
151 fcp->ext.fr_sns_len = htonl(len);
152 memcpy((fcp + 1), se_cmd->sense_buffer, len);
156 * Test underflow and overflow with one mask. Usually both are off.
157 * Bidirectional commands are not handled yet.
159 if (se_cmd->se_cmd_flags & (SCF_OVERFLOW_BIT | SCF_UNDERFLOW_BIT)) {
160 if (se_cmd->se_cmd_flags & SCF_OVERFLOW_BIT)
161 fcp->resp.fr_flags |= FCP_RESID_OVER;
163 fcp->resp.fr_flags |= FCP_RESID_UNDER;
164 fcp->ext.fr_resid = cpu_to_be32(se_cmd->residual_count);
170 cmd->seq = lport->tt.seq_start_next(cmd->seq);
171 fc_fill_fc_hdr(fp, FC_RCTL_DD_CMD_STATUS, ep->did, ep->sid, FC_TYPE_FCP,
172 FC_FC_EX_CTX | FC_FC_LAST_SEQ | FC_FC_END_SEQ, 0);
174 lport->tt.seq_send(lport, cmd->seq, fp);
175 lport->tt.exch_done(cmd->seq);
179 int ft_write_pending_status(struct se_cmd *se_cmd)
181 struct ft_cmd *cmd = container_of(se_cmd, struct ft_cmd, se_cmd);
183 return cmd->write_data_len != se_cmd->data_length;
187 * Send TX_RDY (transfer ready).
189 int ft_write_pending(struct se_cmd *se_cmd)
191 struct ft_cmd *cmd = container_of(se_cmd, struct ft_cmd, se_cmd);
193 struct fcp_txrdy *txrdy;
194 struct fc_lport *lport;
196 struct fc_frame_header *fh;
199 ft_dump_cmd(cmd, __func__);
203 ep = fc_seq_exch(cmd->seq);
205 fp = fc_frame_alloc(lport, sizeof(*txrdy));
207 return -ENOMEM; /* Signal QUEUE_FULL */
209 txrdy = fc_frame_payload_get(fp, sizeof(*txrdy));
210 memset(txrdy, 0, sizeof(*txrdy));
211 txrdy->ft_burst_len = htonl(se_cmd->data_length);
213 cmd->seq = lport->tt.seq_start_next(cmd->seq);
214 fc_fill_fc_hdr(fp, FC_RCTL_DD_DATA_DESC, ep->did, ep->sid, FC_TYPE_FCP,
215 FC_FC_EX_CTX | FC_FC_END_SEQ | FC_FC_SEQ_INIT, 0);
217 fh = fc_frame_header_get(fp);
218 f_ctl = ntoh24(fh->fh_f_ctl);
220 /* Only if it is 'Exchange Responder' */
221 if (f_ctl & FC_FC_EX_CTX) {
222 /* Target is 'exchange responder' and sending XFER_READY
223 * to 'exchange initiator (initiator)'
225 if ((ep->xid <= lport->lro_xid) &&
226 (fh->fh_r_ctl == FC_RCTL_DD_DATA_DESC)) {
227 if (se_cmd->se_cmd_flags & SCF_SCSI_DATA_SG_IO_CDB) {
229 * cmd may have been broken up into multiple
230 * tasks. Link their sgs together so we can
231 * operate on them all at once.
233 transport_do_task_sg_chain(se_cmd);
234 cmd->sg = se_cmd->t_tasks_sg_chained;
236 se_cmd->t_tasks_sg_chained_no;
238 if (cmd->sg && lport->tt.ddp_target(lport, ep->xid,
241 cmd->was_ddp_setup = 1;
244 lport->tt.seq_send(lport, cmd->seq, fp);
248 u32 ft_get_task_tag(struct se_cmd *se_cmd)
250 struct ft_cmd *cmd = container_of(se_cmd, struct ft_cmd, se_cmd);
252 return fc_seq_exch(cmd->seq)->rxid;
255 int ft_get_cmd_state(struct se_cmd *se_cmd)
260 int ft_is_state_remove(struct se_cmd *se_cmd)
262 return 0; /* XXX TBD */
266 * FC sequence response handler for follow-on sequences (data) and aborts.
268 static void ft_recv_seq(struct fc_seq *sp, struct fc_frame *fp, void *arg)
270 struct ft_cmd *cmd = arg;
271 struct fc_frame_header *fh;
273 if (unlikely(IS_ERR(fp))) {
274 /* XXX need to find cmd if queued */
280 fh = fc_frame_header_get(fp);
282 switch (fh->fh_r_ctl) {
283 case FC_RCTL_DD_SOL_DATA: /* write data */
284 ft_recv_write_data(cmd, fp);
286 case FC_RCTL_DD_UNSOL_CTL: /* command */
287 case FC_RCTL_DD_SOL_CTL: /* transfer ready */
288 case FC_RCTL_DD_DATA_DESC: /* transfer ready */
290 pr_debug("%s: unhandled frame r_ctl %x\n",
291 __func__, fh->fh_r_ctl);
292 ft_invl_hw_context(cmd);
294 transport_generic_free_cmd(&cmd->se_cmd, 0);
300 * Send a FCP response including SCSI status and optional FCP rsp_code.
301 * status is SAM_STAT_GOOD (zero) iff code is valid.
302 * This is used in error cases, such as allocation failures.
304 static void ft_send_resp_status(struct fc_lport *lport,
305 const struct fc_frame *rx_fp,
306 u32 status, enum fcp_resp_rsp_codes code)
310 const struct fc_frame_header *fh;
312 struct fcp_resp_with_ext *fcp;
313 struct fcp_resp_rsp_info *info;
315 fh = fc_frame_header_get(rx_fp);
316 pr_debug("FCP error response: did %x oxid %x status %x code %x\n",
317 ntoh24(fh->fh_s_id), ntohs(fh->fh_ox_id), status, code);
319 if (status == SAM_STAT_GOOD)
320 len += sizeof(*info);
321 fp = fc_frame_alloc(lport, len);
324 fcp = fc_frame_payload_get(fp, len);
326 fcp->resp.fr_status = status;
327 if (status == SAM_STAT_GOOD) {
328 fcp->ext.fr_rsp_len = htonl(sizeof(*info));
329 fcp->resp.fr_flags |= FCP_RSP_LEN_VAL;
330 info = (struct fcp_resp_rsp_info *)(fcp + 1);
331 info->rsp_code = code;
334 fc_fill_reply_hdr(fp, rx_fp, FC_RCTL_DD_CMD_STATUS, 0);
337 lport->tt.seq_send(lport, sp, fp);
338 lport->tt.exch_done(sp);
340 lport->tt.frame_send(lport, fp);
345 * Send error or task management response.
347 static void ft_send_resp_code(struct ft_cmd *cmd,
348 enum fcp_resp_rsp_codes code)
350 ft_send_resp_status(cmd->sess->tport->lport,
351 cmd->req_frame, SAM_STAT_GOOD, code);
356 * Send error or task management response.
357 * Always frees the cmd and associated state.
359 static void ft_send_resp_code_and_free(struct ft_cmd *cmd,
360 enum fcp_resp_rsp_codes code)
362 ft_send_resp_code(cmd, code);
367 * Handle Task Management Request.
369 static void ft_send_tm(struct ft_cmd *cmd)
371 struct se_tmr_req *tmr;
372 struct fcp_cmnd *fcp;
373 struct ft_sess *sess;
376 fcp = fc_frame_payload_get(cmd->req_frame, sizeof(*fcp));
378 switch (fcp->fc_tm_flags) {
379 case FCP_TMF_LUN_RESET:
380 tm_func = TMR_LUN_RESET;
382 case FCP_TMF_TGT_RESET:
383 tm_func = TMR_TARGET_WARM_RESET;
385 case FCP_TMF_CLR_TASK_SET:
386 tm_func = TMR_CLEAR_TASK_SET;
388 case FCP_TMF_ABT_TASK_SET:
389 tm_func = TMR_ABORT_TASK_SET;
391 case FCP_TMF_CLR_ACA:
392 tm_func = TMR_CLEAR_ACA;
396 * FCP4r01 indicates having a combination of
397 * tm_flags set is invalid.
399 pr_debug("invalid FCP tm_flags %x\n", fcp->fc_tm_flags);
400 ft_send_resp_code_and_free(cmd, FCP_CMND_FIELDS_INVALID);
404 pr_debug("alloc tm cmd fn %d\n", tm_func);
405 tmr = core_tmr_alloc_req(&cmd->se_cmd, cmd, tm_func, GFP_KERNEL);
407 pr_debug("alloc failed\n");
408 ft_send_resp_code_and_free(cmd, FCP_TMF_FAILED);
411 cmd->se_cmd.se_tmr_req = tmr;
413 switch (fcp->fc_tm_flags) {
414 case FCP_TMF_LUN_RESET:
415 cmd->lun = scsilun_to_int((struct scsi_lun *)fcp->fc_lun);
416 if (transport_lookup_tmr_lun(&cmd->se_cmd, cmd->lun) < 0) {
418 * Make sure to clean up newly allocated TMR request
419 * since "unable to handle TMR request because failed
422 pr_debug("Failed to get LUN for TMR func %d, "
423 "se_cmd %p, unpacked_lun %d\n",
424 tm_func, &cmd->se_cmd, cmd->lun);
425 ft_dump_cmd(cmd, __func__);
427 transport_send_check_condition_and_sense(&cmd->se_cmd,
428 cmd->se_cmd.scsi_sense_reason, 0);
429 transport_generic_free_cmd(&cmd->se_cmd, 0);
434 case FCP_TMF_TGT_RESET:
435 case FCP_TMF_CLR_TASK_SET:
436 case FCP_TMF_ABT_TASK_SET:
437 case FCP_TMF_CLR_ACA:
442 transport_generic_handle_tmr(&cmd->se_cmd);
446 * Send status from completed task management request.
448 int ft_queue_tm_resp(struct se_cmd *se_cmd)
450 struct ft_cmd *cmd = container_of(se_cmd, struct ft_cmd, se_cmd);
451 struct se_tmr_req *tmr = se_cmd->se_tmr_req;
452 enum fcp_resp_rsp_codes code;
456 switch (tmr->response) {
457 case TMR_FUNCTION_COMPLETE:
460 case TMR_LUN_DOES_NOT_EXIST:
461 code = FCP_TMF_INVALID_LUN;
463 case TMR_FUNCTION_REJECTED:
464 code = FCP_TMF_REJECTED;
466 case TMR_TASK_DOES_NOT_EXIST:
467 case TMR_TASK_STILL_ALLEGIANT:
468 case TMR_TASK_FAILOVER_NOT_SUPPORTED:
469 case TMR_TASK_MGMT_FUNCTION_NOT_SUPPORTED:
470 case TMR_FUNCTION_AUTHORIZATION_FAILED:
472 code = FCP_TMF_FAILED;
475 pr_debug("tmr fn %d resp %d fcp code %d\n",
476 tmr->function, tmr->response, code);
477 ft_send_resp_code(cmd, code);
481 static void ft_send_work(struct work_struct *work);
484 * Handle incoming FCP command.
486 static void ft_recv_cmd(struct ft_sess *sess, struct fc_frame *fp)
489 struct fc_lport *lport = sess->tport->lport;
491 cmd = kzalloc(sizeof(*cmd), GFP_ATOMIC);
495 cmd->seq = lport->tt.seq_assign(lport, fp);
500 cmd->req_frame = fp; /* hold frame during cmd */
502 INIT_WORK(&cmd->work, ft_send_work);
503 queue_work(sess->tport->tpg->workqueue, &cmd->work);
507 pr_debug("cmd or seq allocation failure - sending BUSY\n");
508 ft_send_resp_status(lport, fp, SAM_STAT_BUSY, 0);
510 ft_sess_put(sess); /* undo get from lookup */
515 * Handle incoming FCP frame.
516 * Caller has verified that the frame is type FCP.
518 void ft_recv_req(struct ft_sess *sess, struct fc_frame *fp)
520 struct fc_frame_header *fh = fc_frame_header_get(fp);
522 switch (fh->fh_r_ctl) {
523 case FC_RCTL_DD_UNSOL_CMD: /* command */
524 ft_recv_cmd(sess, fp);
526 case FC_RCTL_DD_SOL_DATA: /* write data */
527 case FC_RCTL_DD_UNSOL_CTL:
528 case FC_RCTL_DD_SOL_CTL:
529 case FC_RCTL_DD_DATA_DESC: /* transfer ready */
530 case FC_RCTL_ELS4_REQ: /* SRR, perhaps */
532 pr_debug("%s: unhandled frame r_ctl %x\n",
533 __func__, fh->fh_r_ctl);
535 ft_sess_put(sess); /* undo get from lookup */
541 * Send new command to target.
543 static void ft_send_work(struct work_struct *work)
545 struct ft_cmd *cmd = container_of(work, struct ft_cmd, work);
546 struct fc_frame_header *fh = fc_frame_header_get(cmd->req_frame);
547 struct se_cmd *se_cmd;
548 struct fcp_cmnd *fcp;
554 fcp = fc_frame_payload_get(cmd->req_frame, sizeof(*fcp));
558 if (fcp->fc_flags & FCP_CFL_LEN_MASK)
559 goto err; /* not handling longer CDBs yet */
561 if (fcp->fc_tm_flags) {
562 task_attr = FCP_PTA_SIMPLE;
566 switch (fcp->fc_flags & (FCP_CFL_RDDATA | FCP_CFL_WRDATA)) {
571 data_dir = DMA_FROM_DEVICE;
574 data_dir = DMA_TO_DEVICE;
576 case FCP_CFL_WRDATA | FCP_CFL_RDDATA:
577 goto err; /* TBD not supported by tcm_fc yet */
580 * Locate the SAM Task Attr from fc_pri_ta
582 switch (fcp->fc_pri_ta & FCP_PTA_MASK) {
584 task_attr = MSG_HEAD_TAG;
586 case FCP_PTA_ORDERED:
587 task_attr = MSG_ORDERED_TAG;
590 task_attr = MSG_ACA_TAG;
592 case FCP_PTA_SIMPLE: /* Fallthrough */
594 task_attr = MSG_SIMPLE_TAG;
598 task_attr = fcp->fc_pri_ta & FCP_PTA_MASK;
599 data_len = ntohl(fcp->fc_dl);
600 cmd->cdb = fcp->fc_cdb;
603 se_cmd = &cmd->se_cmd;
605 * Initialize struct se_cmd descriptor from target_core_mod
608 transport_init_se_cmd(se_cmd, &ft_configfs->tf_ops, cmd->sess->se_sess,
609 data_len, data_dir, task_attr,
610 &cmd->ft_sense_buffer[0]);
612 * Check for FCP task management flags
614 if (fcp->fc_tm_flags) {
619 fc_seq_exch(cmd->seq)->lp->tt.seq_set_resp(cmd->seq, ft_recv_seq, cmd);
621 cmd->lun = scsilun_to_int((struct scsi_lun *)fcp->fc_lun);
622 ret = transport_lookup_cmd_lun(&cmd->se_cmd, cmd->lun);
624 ft_dump_cmd(cmd, __func__);
625 transport_send_check_condition_and_sense(&cmd->se_cmd,
626 cmd->se_cmd.scsi_sense_reason, 0);
630 ret = transport_generic_allocate_tasks(se_cmd, cmd->cdb);
632 pr_debug("r_ctl %x alloc task ret %d\n", fh->fh_r_ctl, ret);
633 ft_dump_cmd(cmd, __func__);
635 if (ret == -ENOMEM) {
636 transport_send_check_condition_and_sense(se_cmd,
637 TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE, 0);
638 transport_generic_free_cmd(se_cmd, 0);
641 if (ret == -EINVAL) {
642 if (se_cmd->se_cmd_flags & SCF_SCSI_RESERVATION_CONFLICT)
643 ft_queue_status(se_cmd);
645 transport_send_check_condition_and_sense(se_cmd,
646 se_cmd->scsi_sense_reason, 0);
647 transport_generic_free_cmd(se_cmd, 0);
650 transport_handle_cdb_direct(se_cmd);
654 ft_send_resp_code_and_free(cmd, FCP_CMND_FIELDS_INVALID);