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 void ft_check_stop_free(struct se_cmd *se_cmd)
117 transport_generic_free_cmd(se_cmd, 0, 0);
123 int ft_queue_status(struct se_cmd *se_cmd)
125 struct ft_cmd *cmd = container_of(se_cmd, struct ft_cmd, se_cmd);
127 struct fcp_resp_with_ext *fcp;
128 struct fc_lport *lport;
132 ft_dump_cmd(cmd, __func__);
133 ep = fc_seq_exch(cmd->seq);
135 len = sizeof(*fcp) + se_cmd->scsi_sense_length;
136 fp = fc_frame_alloc(lport, len);
138 /* XXX shouldn't just drop it - requeue and retry? */
141 fcp = fc_frame_payload_get(fp, len);
143 fcp->resp.fr_status = se_cmd->scsi_status;
145 len = se_cmd->scsi_sense_length;
147 fcp->resp.fr_flags |= FCP_SNS_LEN_VAL;
148 fcp->ext.fr_sns_len = htonl(len);
149 memcpy((fcp + 1), se_cmd->sense_buffer, len);
153 * Test underflow and overflow with one mask. Usually both are off.
154 * Bidirectional commands are not handled yet.
156 if (se_cmd->se_cmd_flags & (SCF_OVERFLOW_BIT | SCF_UNDERFLOW_BIT)) {
157 if (se_cmd->se_cmd_flags & SCF_OVERFLOW_BIT)
158 fcp->resp.fr_flags |= FCP_RESID_OVER;
160 fcp->resp.fr_flags |= FCP_RESID_UNDER;
161 fcp->ext.fr_resid = cpu_to_be32(se_cmd->residual_count);
167 cmd->seq = lport->tt.seq_start_next(cmd->seq);
168 fc_fill_fc_hdr(fp, FC_RCTL_DD_CMD_STATUS, ep->did, ep->sid, FC_TYPE_FCP,
169 FC_FC_EX_CTX | FC_FC_LAST_SEQ | FC_FC_END_SEQ, 0);
171 lport->tt.seq_send(lport, cmd->seq, fp);
172 lport->tt.exch_done(cmd->seq);
176 int ft_write_pending_status(struct se_cmd *se_cmd)
178 struct ft_cmd *cmd = container_of(se_cmd, struct ft_cmd, se_cmd);
180 return cmd->write_data_len != se_cmd->data_length;
184 * Send TX_RDY (transfer ready).
186 int ft_write_pending(struct se_cmd *se_cmd)
188 struct ft_cmd *cmd = container_of(se_cmd, struct ft_cmd, se_cmd);
190 struct fcp_txrdy *txrdy;
191 struct fc_lport *lport;
193 struct fc_frame_header *fh;
196 ft_dump_cmd(cmd, __func__);
198 ep = fc_seq_exch(cmd->seq);
200 fp = fc_frame_alloc(lport, sizeof(*txrdy));
202 return PYX_TRANSPORT_OUT_OF_MEMORY_RESOURCES;
204 txrdy = fc_frame_payload_get(fp, sizeof(*txrdy));
205 memset(txrdy, 0, sizeof(*txrdy));
206 txrdy->ft_burst_len = htonl(se_cmd->data_length);
208 cmd->seq = lport->tt.seq_start_next(cmd->seq);
209 fc_fill_fc_hdr(fp, FC_RCTL_DD_DATA_DESC, ep->did, ep->sid, FC_TYPE_FCP,
210 FC_FC_EX_CTX | FC_FC_END_SEQ | FC_FC_SEQ_INIT, 0);
212 fh = fc_frame_header_get(fp);
213 f_ctl = ntoh24(fh->fh_f_ctl);
215 /* Only if it is 'Exchange Responder' */
216 if (f_ctl & FC_FC_EX_CTX) {
217 /* Target is 'exchange responder' and sending XFER_READY
218 * to 'exchange initiator (initiator)'
220 if ((ep->xid <= lport->lro_xid) &&
221 (fh->fh_r_ctl == FC_RCTL_DD_DATA_DESC)) {
222 if (se_cmd->se_cmd_flags & SCF_SCSI_DATA_SG_IO_CDB) {
224 * cmd may have been broken up into multiple
225 * tasks. Link their sgs together so we can
226 * operate on them all at once.
228 transport_do_task_sg_chain(se_cmd);
229 cmd->sg = se_cmd->t_tasks_sg_chained;
231 se_cmd->t_tasks_sg_chained_no;
233 if (cmd->sg && lport->tt.ddp_target(lport, ep->xid,
236 cmd->was_ddp_setup = 1;
239 lport->tt.seq_send(lport, cmd->seq, fp);
243 u32 ft_get_task_tag(struct se_cmd *se_cmd)
245 struct ft_cmd *cmd = container_of(se_cmd, struct ft_cmd, se_cmd);
247 return fc_seq_exch(cmd->seq)->rxid;
250 int ft_get_cmd_state(struct se_cmd *se_cmd)
255 int ft_is_state_remove(struct se_cmd *se_cmd)
257 return 0; /* XXX TBD */
261 * FC sequence response handler for follow-on sequences (data) and aborts.
263 static void ft_recv_seq(struct fc_seq *sp, struct fc_frame *fp, void *arg)
265 struct ft_cmd *cmd = arg;
266 struct fc_frame_header *fh;
269 /* XXX need to find cmd if queued */
270 cmd->se_cmd.t_state = TRANSPORT_REMOVE;
272 transport_generic_free_cmd(&cmd->se_cmd, 0, 0);
276 fh = fc_frame_header_get(fp);
278 switch (fh->fh_r_ctl) {
279 case FC_RCTL_DD_SOL_DATA: /* write data */
280 ft_recv_write_data(cmd, fp);
282 case FC_RCTL_DD_UNSOL_CTL: /* command */
283 case FC_RCTL_DD_SOL_CTL: /* transfer ready */
284 case FC_RCTL_DD_DATA_DESC: /* transfer ready */
286 pr_debug("%s: unhandled frame r_ctl %x\n",
287 __func__, fh->fh_r_ctl);
288 ft_invl_hw_context(cmd);
290 transport_generic_free_cmd(&cmd->se_cmd, 0, 0);
296 * Send a FCP response including SCSI status and optional FCP rsp_code.
297 * status is SAM_STAT_GOOD (zero) iff code is valid.
298 * This is used in error cases, such as allocation failures.
300 static void ft_send_resp_status(struct fc_lport *lport,
301 const struct fc_frame *rx_fp,
302 u32 status, enum fcp_resp_rsp_codes code)
306 const struct fc_frame_header *fh;
308 struct fcp_resp_with_ext *fcp;
309 struct fcp_resp_rsp_info *info;
311 fh = fc_frame_header_get(rx_fp);
312 pr_debug("FCP error response: did %x oxid %x status %x code %x\n",
313 ntoh24(fh->fh_s_id), ntohs(fh->fh_ox_id), status, code);
315 if (status == SAM_STAT_GOOD)
316 len += sizeof(*info);
317 fp = fc_frame_alloc(lport, len);
320 fcp = fc_frame_payload_get(fp, len);
322 fcp->resp.fr_status = status;
323 if (status == SAM_STAT_GOOD) {
324 fcp->ext.fr_rsp_len = htonl(sizeof(*info));
325 fcp->resp.fr_flags |= FCP_RSP_LEN_VAL;
326 info = (struct fcp_resp_rsp_info *)(fcp + 1);
327 info->rsp_code = code;
330 fc_fill_reply_hdr(fp, rx_fp, FC_RCTL_DD_CMD_STATUS, 0);
333 lport->tt.seq_send(lport, sp, fp);
335 lport->tt.frame_send(lport, fp);
339 * Send error or task management response.
341 static void ft_send_resp_code(struct ft_cmd *cmd,
342 enum fcp_resp_rsp_codes code)
344 ft_send_resp_status(cmd->sess->tport->lport,
345 cmd->req_frame, SAM_STAT_GOOD, code);
350 * Send error or task management response.
351 * Always frees the cmd and associated state.
353 static void ft_send_resp_code_and_free(struct ft_cmd *cmd,
354 enum fcp_resp_rsp_codes code)
356 ft_send_resp_code(cmd, code);
361 * Handle Task Management Request.
363 static void ft_send_tm(struct ft_cmd *cmd)
365 struct se_tmr_req *tmr;
366 struct fcp_cmnd *fcp;
367 struct ft_sess *sess;
370 fcp = fc_frame_payload_get(cmd->req_frame, sizeof(*fcp));
372 switch (fcp->fc_tm_flags) {
373 case FCP_TMF_LUN_RESET:
374 tm_func = TMR_LUN_RESET;
376 case FCP_TMF_TGT_RESET:
377 tm_func = TMR_TARGET_WARM_RESET;
379 case FCP_TMF_CLR_TASK_SET:
380 tm_func = TMR_CLEAR_TASK_SET;
382 case FCP_TMF_ABT_TASK_SET:
383 tm_func = TMR_ABORT_TASK_SET;
385 case FCP_TMF_CLR_ACA:
386 tm_func = TMR_CLEAR_ACA;
390 * FCP4r01 indicates having a combination of
391 * tm_flags set is invalid.
393 pr_debug("invalid FCP tm_flags %x\n", fcp->fc_tm_flags);
394 ft_send_resp_code_and_free(cmd, FCP_CMND_FIELDS_INVALID);
398 pr_debug("alloc tm cmd fn %d\n", tm_func);
399 tmr = core_tmr_alloc_req(&cmd->se_cmd, cmd, tm_func);
401 pr_debug("alloc failed\n");
402 ft_send_resp_code_and_free(cmd, FCP_TMF_FAILED);
405 cmd->se_cmd.se_tmr_req = tmr;
407 switch (fcp->fc_tm_flags) {
408 case FCP_TMF_LUN_RESET:
409 cmd->lun = scsilun_to_int((struct scsi_lun *)fcp->fc_lun);
410 if (transport_lookup_tmr_lun(&cmd->se_cmd, cmd->lun) < 0) {
412 * Make sure to clean up newly allocated TMR request
413 * since "unable to handle TMR request because failed
416 pr_debug("Failed to get LUN for TMR func %d, "
417 "se_cmd %p, unpacked_lun %d\n",
418 tm_func, &cmd->se_cmd, cmd->lun);
419 ft_dump_cmd(cmd, __func__);
421 transport_send_check_condition_and_sense(&cmd->se_cmd,
422 cmd->se_cmd.scsi_sense_reason, 0);
423 transport_generic_free_cmd(&cmd->se_cmd, 0, 0);
428 case FCP_TMF_TGT_RESET:
429 case FCP_TMF_CLR_TASK_SET:
430 case FCP_TMF_ABT_TASK_SET:
431 case FCP_TMF_CLR_ACA:
436 transport_generic_handle_tmr(&cmd->se_cmd);
440 * Send status from completed task management request.
442 int ft_queue_tm_resp(struct se_cmd *se_cmd)
444 struct ft_cmd *cmd = container_of(se_cmd, struct ft_cmd, se_cmd);
445 struct se_tmr_req *tmr = se_cmd->se_tmr_req;
446 enum fcp_resp_rsp_codes code;
448 switch (tmr->response) {
449 case TMR_FUNCTION_COMPLETE:
452 case TMR_LUN_DOES_NOT_EXIST:
453 code = FCP_TMF_INVALID_LUN;
455 case TMR_FUNCTION_REJECTED:
456 code = FCP_TMF_REJECTED;
458 case TMR_TASK_DOES_NOT_EXIST:
459 case TMR_TASK_STILL_ALLEGIANT:
460 case TMR_TASK_FAILOVER_NOT_SUPPORTED:
461 case TMR_TASK_MGMT_FUNCTION_NOT_SUPPORTED:
462 case TMR_FUNCTION_AUTHORIZATION_FAILED:
464 code = FCP_TMF_FAILED;
467 pr_debug("tmr fn %d resp %d fcp code %d\n",
468 tmr->function, tmr->response, code);
469 ft_send_resp_code(cmd, code);
473 static void ft_send_work(struct work_struct *work);
476 * Handle incoming FCP command.
478 static void ft_recv_cmd(struct ft_sess *sess, struct fc_frame *fp)
481 struct fc_lport *lport = sess->tport->lport;
483 cmd = kzalloc(sizeof(*cmd), GFP_ATOMIC);
487 cmd->seq = lport->tt.seq_assign(lport, fp);
492 cmd->req_frame = fp; /* hold frame during cmd */
494 INIT_WORK(&cmd->work, ft_send_work);
495 queue_work(sess->tport->tpg->workqueue, &cmd->work);
499 pr_debug("cmd or seq allocation failure - sending BUSY\n");
500 ft_send_resp_status(lport, fp, SAM_STAT_BUSY, 0);
502 ft_sess_put(sess); /* undo get from lookup */
507 * Handle incoming FCP frame.
508 * Caller has verified that the frame is type FCP.
510 void ft_recv_req(struct ft_sess *sess, struct fc_frame *fp)
512 struct fc_frame_header *fh = fc_frame_header_get(fp);
514 switch (fh->fh_r_ctl) {
515 case FC_RCTL_DD_UNSOL_CMD: /* command */
516 ft_recv_cmd(sess, fp);
518 case FC_RCTL_DD_SOL_DATA: /* write data */
519 case FC_RCTL_DD_UNSOL_CTL:
520 case FC_RCTL_DD_SOL_CTL:
521 case FC_RCTL_DD_DATA_DESC: /* transfer ready */
522 case FC_RCTL_ELS4_REQ: /* SRR, perhaps */
524 pr_debug("%s: unhandled frame r_ctl %x\n",
525 __func__, fh->fh_r_ctl);
527 ft_sess_put(sess); /* undo get from lookup */
533 * Send new command to target.
535 static void ft_send_work(struct work_struct *work)
537 struct ft_cmd *cmd = container_of(work, struct ft_cmd, work);
538 struct fc_frame_header *fh = fc_frame_header_get(cmd->req_frame);
539 struct se_cmd *se_cmd;
540 struct fcp_cmnd *fcp;
546 fcp = fc_frame_payload_get(cmd->req_frame, sizeof(*fcp));
550 if (fcp->fc_flags & FCP_CFL_LEN_MASK)
551 goto err; /* not handling longer CDBs yet */
553 if (fcp->fc_tm_flags) {
554 task_attr = FCP_PTA_SIMPLE;
558 switch (fcp->fc_flags & (FCP_CFL_RDDATA | FCP_CFL_WRDATA)) {
563 data_dir = DMA_FROM_DEVICE;
566 data_dir = DMA_TO_DEVICE;
568 case FCP_CFL_WRDATA | FCP_CFL_RDDATA:
569 goto err; /* TBD not supported by tcm_fc yet */
572 * Locate the SAM Task Attr from fc_pri_ta
574 switch (fcp->fc_pri_ta & FCP_PTA_MASK) {
576 task_attr = MSG_HEAD_TAG;
578 case FCP_PTA_ORDERED:
579 task_attr = MSG_ORDERED_TAG;
582 task_attr = MSG_ACA_TAG;
584 case FCP_PTA_SIMPLE: /* Fallthrough */
586 task_attr = MSG_SIMPLE_TAG;
590 task_attr = fcp->fc_pri_ta & FCP_PTA_MASK;
591 data_len = ntohl(fcp->fc_dl);
592 cmd->cdb = fcp->fc_cdb;
595 se_cmd = &cmd->se_cmd;
597 * Initialize struct se_cmd descriptor from target_core_mod
600 transport_init_se_cmd(se_cmd, &ft_configfs->tf_ops, cmd->sess->se_sess,
601 data_len, data_dir, task_attr,
602 &cmd->ft_sense_buffer[0]);
604 * Check for FCP task management flags
606 if (fcp->fc_tm_flags) {
611 fc_seq_exch(cmd->seq)->lp->tt.seq_set_resp(cmd->seq, ft_recv_seq, cmd);
613 cmd->lun = scsilun_to_int((struct scsi_lun *)fcp->fc_lun);
614 ret = transport_lookup_cmd_lun(&cmd->se_cmd, cmd->lun);
616 ft_dump_cmd(cmd, __func__);
617 transport_send_check_condition_and_sense(&cmd->se_cmd,
618 cmd->se_cmd.scsi_sense_reason, 0);
622 ret = transport_generic_allocate_tasks(se_cmd, cmd->cdb);
624 pr_debug("r_ctl %x alloc task ret %d\n", fh->fh_r_ctl, ret);
625 ft_dump_cmd(cmd, __func__);
627 if (ret == -ENOMEM) {
628 transport_send_check_condition_and_sense(se_cmd,
629 TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE, 0);
630 transport_generic_free_cmd(se_cmd, 0, 0);
633 if (ret == -EINVAL) {
634 if (se_cmd->se_cmd_flags & SCF_SCSI_RESERVATION_CONFLICT)
635 ft_queue_status(se_cmd);
637 transport_send_check_condition_and_sense(se_cmd,
638 se_cmd->scsi_sense_reason, 0);
639 transport_generic_free_cmd(se_cmd, 0, 0);
642 transport_generic_handle_cdb(se_cmd);
646 ft_send_resp_code_and_free(cmd, FCP_CMND_FIELDS_INVALID);