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/utsname.h>
23 #include <linux/init.h>
24 #include <linux/slab.h>
25 #include <linux/kthread.h>
26 #include <linux/types.h>
27 #include <linux/string.h>
28 #include <linux/configfs.h>
29 #include <linux/ctype.h>
30 #include <linux/hash.h>
31 #include <linux/percpu_ida.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_fabric.h>
43 #include <target/configfs_macros.h>
48 * Dump cmd state for debugging.
50 static void _ft_dump_cmd(struct ft_cmd *cmd, const char *caller)
54 struct se_cmd *se_cmd;
55 struct scatterlist *sg;
58 se_cmd = &cmd->se_cmd;
59 pr_debug("%s: cmd %p sess %p seq %p se_cmd %p\n",
60 caller, cmd, cmd->sess, cmd->seq, se_cmd);
62 pr_debug("%s: cmd %p data_nents %u len %u se_cmd_flags <0x%x>\n",
63 caller, cmd, se_cmd->t_data_nents,
64 se_cmd->data_length, se_cmd->se_cmd_flags);
66 for_each_sg(se_cmd->t_data_sg, sg, se_cmd->t_data_nents, count)
67 pr_debug("%s: cmd %p sg %p page %p "
68 "len 0x%x off 0x%x\n",
70 sg_page(sg), sg->length, sg->offset);
75 pr_debug("%s: cmd %p sid %x did %x "
76 "ox_id %x rx_id %x seq_id %x e_stat %x\n",
77 caller, cmd, ep->sid, ep->did, ep->oxid, ep->rxid,
78 sp->id, ep->esb_stat);
82 void ft_dump_cmd(struct ft_cmd *cmd, const char *caller)
84 if (unlikely(ft_debug_logging))
85 _ft_dump_cmd(cmd, caller);
88 static void ft_free_cmd(struct ft_cmd *cmd)
91 struct fc_lport *lport;
100 lport->tt.seq_release(fr_seq(fp));
102 percpu_ida_free(&sess->se_sess->sess_tag_pool, cmd->se_cmd.map_tag);
103 ft_sess_put(sess); /* undo get from lookup at recv */
106 void ft_release_cmd(struct se_cmd *se_cmd)
108 struct ft_cmd *cmd = container_of(se_cmd, struct ft_cmd, se_cmd);
113 int ft_check_stop_free(struct se_cmd *se_cmd)
115 transport_generic_free_cmd(se_cmd, 0);
122 int ft_queue_status(struct se_cmd *se_cmd)
124 struct ft_cmd *cmd = container_of(se_cmd, struct ft_cmd, se_cmd);
126 struct fcp_resp_with_ext *fcp;
127 struct fc_lport *lport;
134 ft_dump_cmd(cmd, __func__);
135 ep = fc_seq_exch(cmd->seq);
137 len = sizeof(*fcp) + se_cmd->scsi_sense_length;
138 fp = fc_frame_alloc(lport, len);
140 se_cmd->scsi_status = SAM_STAT_TASK_SET_FULL;
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 rc = lport->tt.seq_send(lport, cmd->seq, fp);
176 pr_info_ratelimited("%s: Failed to send response frame %p, "
177 "xid <0x%x>\n", __func__, fp, ep->xid);
179 * Generate a TASK_SET_FULL status to notify the initiator
180 * to reduce it's queue_depth after the se_cmd response has
181 * been re-queued by target-core.
183 se_cmd->scsi_status = SAM_STAT_TASK_SET_FULL;
186 lport->tt.exch_done(cmd->seq);
190 int ft_write_pending_status(struct se_cmd *se_cmd)
192 struct ft_cmd *cmd = container_of(se_cmd, struct ft_cmd, se_cmd);
194 return cmd->write_data_len != se_cmd->data_length;
198 * Send TX_RDY (transfer ready).
200 int ft_write_pending(struct se_cmd *se_cmd)
202 struct ft_cmd *cmd = container_of(se_cmd, struct ft_cmd, se_cmd);
204 struct fcp_txrdy *txrdy;
205 struct fc_lport *lport;
207 struct fc_frame_header *fh;
210 ft_dump_cmd(cmd, __func__);
214 ep = fc_seq_exch(cmd->seq);
216 fp = fc_frame_alloc(lport, sizeof(*txrdy));
218 return -ENOMEM; /* Signal QUEUE_FULL */
220 txrdy = fc_frame_payload_get(fp, sizeof(*txrdy));
221 memset(txrdy, 0, sizeof(*txrdy));
222 txrdy->ft_burst_len = htonl(se_cmd->data_length);
224 cmd->seq = lport->tt.seq_start_next(cmd->seq);
225 fc_fill_fc_hdr(fp, FC_RCTL_DD_DATA_DESC, ep->did, ep->sid, FC_TYPE_FCP,
226 FC_FC_EX_CTX | FC_FC_END_SEQ | FC_FC_SEQ_INIT, 0);
228 fh = fc_frame_header_get(fp);
229 f_ctl = ntoh24(fh->fh_f_ctl);
231 /* Only if it is 'Exchange Responder' */
232 if (f_ctl & FC_FC_EX_CTX) {
233 /* Target is 'exchange responder' and sending XFER_READY
234 * to 'exchange initiator (initiator)'
236 if ((ep->xid <= lport->lro_xid) &&
237 (fh->fh_r_ctl == FC_RCTL_DD_DATA_DESC)) {
238 if ((se_cmd->se_cmd_flags & SCF_SCSI_DATA_CDB) &&
239 lport->tt.ddp_target(lport, ep->xid,
241 se_cmd->t_data_nents))
242 cmd->was_ddp_setup = 1;
245 lport->tt.seq_send(lport, cmd->seq, fp);
249 int ft_get_cmd_state(struct se_cmd *se_cmd)
255 * FC sequence response handler for follow-on sequences (data) and aborts.
257 static void ft_recv_seq(struct fc_seq *sp, struct fc_frame *fp, void *arg)
259 struct ft_cmd *cmd = arg;
260 struct fc_frame_header *fh;
262 if (unlikely(IS_ERR(fp))) {
263 /* XXX need to find cmd if queued */
269 fh = fc_frame_header_get(fp);
271 switch (fh->fh_r_ctl) {
272 case FC_RCTL_DD_SOL_DATA: /* write data */
273 ft_recv_write_data(cmd, fp);
275 case FC_RCTL_DD_UNSOL_CTL: /* command */
276 case FC_RCTL_DD_SOL_CTL: /* transfer ready */
277 case FC_RCTL_DD_DATA_DESC: /* transfer ready */
279 pr_debug("%s: unhandled frame r_ctl %x\n",
280 __func__, fh->fh_r_ctl);
281 ft_invl_hw_context(cmd);
283 transport_generic_free_cmd(&cmd->se_cmd, 0);
289 * Send a FCP response including SCSI status and optional FCP rsp_code.
290 * status is SAM_STAT_GOOD (zero) iff code is valid.
291 * This is used in error cases, such as allocation failures.
293 static void ft_send_resp_status(struct fc_lport *lport,
294 const struct fc_frame *rx_fp,
295 u32 status, enum fcp_resp_rsp_codes code)
299 const struct fc_frame_header *fh;
301 struct fcp_resp_with_ext *fcp;
302 struct fcp_resp_rsp_info *info;
304 fh = fc_frame_header_get(rx_fp);
305 pr_debug("FCP error response: did %x oxid %x status %x code %x\n",
306 ntoh24(fh->fh_s_id), ntohs(fh->fh_ox_id), status, code);
308 if (status == SAM_STAT_GOOD)
309 len += sizeof(*info);
310 fp = fc_frame_alloc(lport, len);
313 fcp = fc_frame_payload_get(fp, len);
315 fcp->resp.fr_status = status;
316 if (status == SAM_STAT_GOOD) {
317 fcp->ext.fr_rsp_len = htonl(sizeof(*info));
318 fcp->resp.fr_flags |= FCP_RSP_LEN_VAL;
319 info = (struct fcp_resp_rsp_info *)(fcp + 1);
320 info->rsp_code = code;
323 fc_fill_reply_hdr(fp, rx_fp, FC_RCTL_DD_CMD_STATUS, 0);
326 lport->tt.seq_send(lport, sp, fp);
327 lport->tt.exch_done(sp);
329 lport->tt.frame_send(lport, fp);
334 * Send error or task management response.
336 static void ft_send_resp_code(struct ft_cmd *cmd,
337 enum fcp_resp_rsp_codes code)
339 ft_send_resp_status(cmd->sess->tport->lport,
340 cmd->req_frame, SAM_STAT_GOOD, code);
345 * Send error or task management response.
346 * Always frees the cmd and associated state.
348 static void ft_send_resp_code_and_free(struct ft_cmd *cmd,
349 enum fcp_resp_rsp_codes code)
351 ft_send_resp_code(cmd, code);
356 * Handle Task Management Request.
358 static void ft_send_tm(struct ft_cmd *cmd)
360 struct fcp_cmnd *fcp;
364 fcp = fc_frame_payload_get(cmd->req_frame, sizeof(*fcp));
366 switch (fcp->fc_tm_flags) {
367 case FCP_TMF_LUN_RESET:
368 tm_func = TMR_LUN_RESET;
370 case FCP_TMF_TGT_RESET:
371 tm_func = TMR_TARGET_WARM_RESET;
373 case FCP_TMF_CLR_TASK_SET:
374 tm_func = TMR_CLEAR_TASK_SET;
376 case FCP_TMF_ABT_TASK_SET:
377 tm_func = TMR_ABORT_TASK_SET;
379 case FCP_TMF_CLR_ACA:
380 tm_func = TMR_CLEAR_ACA;
384 * FCP4r01 indicates having a combination of
385 * tm_flags set is invalid.
387 pr_debug("invalid FCP tm_flags %x\n", fcp->fc_tm_flags);
388 ft_send_resp_code_and_free(cmd, FCP_CMND_FIELDS_INVALID);
392 /* FIXME: Add referenced task tag for ABORT_TASK */
393 rc = target_submit_tmr(&cmd->se_cmd, cmd->sess->se_sess,
394 &cmd->ft_sense_buffer[0], scsilun_to_int(&fcp->fc_lun),
395 cmd, tm_func, GFP_KERNEL, 0, 0);
397 ft_send_resp_code_and_free(cmd, FCP_TMF_FAILED);
401 * Send status from completed task management request.
403 void ft_queue_tm_resp(struct se_cmd *se_cmd)
405 struct ft_cmd *cmd = container_of(se_cmd, struct ft_cmd, se_cmd);
406 struct se_tmr_req *tmr = se_cmd->se_tmr_req;
407 enum fcp_resp_rsp_codes code;
411 switch (tmr->response) {
412 case TMR_FUNCTION_COMPLETE:
415 case TMR_LUN_DOES_NOT_EXIST:
416 code = FCP_TMF_INVALID_LUN;
418 case TMR_FUNCTION_REJECTED:
419 code = FCP_TMF_REJECTED;
421 case TMR_TASK_DOES_NOT_EXIST:
422 case TMR_TASK_MGMT_FUNCTION_NOT_SUPPORTED:
424 code = FCP_TMF_FAILED;
427 pr_debug("tmr fn %d resp %d fcp code %d\n",
428 tmr->function, tmr->response, code);
429 ft_send_resp_code(cmd, code);
432 void ft_aborted_task(struct se_cmd *se_cmd)
437 static void ft_send_work(struct work_struct *work);
440 * Handle incoming FCP command.
442 static void ft_recv_cmd(struct ft_sess *sess, struct fc_frame *fp)
445 struct fc_lport *lport = sess->tport->lport;
446 struct se_session *se_sess = sess->se_sess;
449 tag = percpu_ida_alloc(&se_sess->sess_tag_pool, TASK_RUNNING);
453 cmd = &((struct ft_cmd *)se_sess->sess_cmd_map)[tag];
454 memset(cmd, 0, sizeof(struct ft_cmd));
456 cmd->se_cmd.map_tag = tag;
458 cmd->seq = lport->tt.seq_assign(lport, fp);
460 percpu_ida_free(&se_sess->sess_tag_pool, tag);
463 cmd->req_frame = fp; /* hold frame during cmd */
465 INIT_WORK(&cmd->work, ft_send_work);
466 queue_work(sess->tport->tpg->workqueue, &cmd->work);
470 pr_debug("cmd or seq allocation failure - sending BUSY\n");
471 ft_send_resp_status(lport, fp, SAM_STAT_BUSY, 0);
473 ft_sess_put(sess); /* undo get from lookup */
478 * Handle incoming FCP frame.
479 * Caller has verified that the frame is type FCP.
481 void ft_recv_req(struct ft_sess *sess, struct fc_frame *fp)
483 struct fc_frame_header *fh = fc_frame_header_get(fp);
485 switch (fh->fh_r_ctl) {
486 case FC_RCTL_DD_UNSOL_CMD: /* command */
487 ft_recv_cmd(sess, fp);
489 case FC_RCTL_DD_SOL_DATA: /* write data */
490 case FC_RCTL_DD_UNSOL_CTL:
491 case FC_RCTL_DD_SOL_CTL:
492 case FC_RCTL_DD_DATA_DESC: /* transfer ready */
493 case FC_RCTL_ELS4_REQ: /* SRR, perhaps */
495 pr_debug("%s: unhandled frame r_ctl %x\n",
496 __func__, fh->fh_r_ctl);
498 ft_sess_put(sess); /* undo get from lookup */
504 * Send new command to target.
506 static void ft_send_work(struct work_struct *work)
508 struct ft_cmd *cmd = container_of(work, struct ft_cmd, work);
509 struct fc_frame_header *fh = fc_frame_header_get(cmd->req_frame);
510 struct fcp_cmnd *fcp;
514 fcp = fc_frame_payload_get(cmd->req_frame, sizeof(*fcp));
518 if (fcp->fc_flags & FCP_CFL_LEN_MASK)
519 goto err; /* not handling longer CDBs yet */
522 * Check for FCP task management flags
524 if (fcp->fc_tm_flags) {
529 switch (fcp->fc_flags & (FCP_CFL_RDDATA | FCP_CFL_WRDATA)) {
534 data_dir = DMA_FROM_DEVICE;
537 data_dir = DMA_TO_DEVICE;
539 case FCP_CFL_WRDATA | FCP_CFL_RDDATA:
540 goto err; /* TBD not supported by tcm_fc yet */
543 * Locate the SAM Task Attr from fc_pri_ta
545 switch (fcp->fc_pri_ta & FCP_PTA_MASK) {
547 task_attr = TCM_HEAD_TAG;
549 case FCP_PTA_ORDERED:
550 task_attr = TCM_ORDERED_TAG;
553 task_attr = TCM_ACA_TAG;
555 case FCP_PTA_SIMPLE: /* Fallthrough */
557 task_attr = TCM_SIMPLE_TAG;
560 fc_seq_exch(cmd->seq)->lp->tt.seq_set_resp(cmd->seq, ft_recv_seq, cmd);
561 cmd->se_cmd.tag = fc_seq_exch(cmd->seq)->rxid;
563 * Use a single se_cmd->cmd_kref as we expect to release se_cmd
564 * directly from ft_check_stop_free callback in response path.
566 if (target_submit_cmd(&cmd->se_cmd, cmd->sess->se_sess, fcp->fc_cdb,
567 &cmd->ft_sense_buffer[0], scsilun_to_int(&fcp->fc_lun),
568 ntohl(fcp->fc_dl), task_attr, data_dir, 0))
571 pr_debug("r_ctl %x alloc target_submit_cmd\n", fh->fh_r_ctl);
575 ft_send_resp_code_and_free(cmd, FCP_CMND_FIELDS_INVALID);