1 // SPDX-License-Identifier: GPL-2.0-only
3 * Copyright (c) 2010 Cisco Systems, Inc.
6 /* XXX TBD some includes may be extraneous */
8 #include <linux/module.h>
9 #include <linux/moduleparam.h>
10 #include <linux/utsname.h>
11 #include <linux/init.h>
12 #include <linux/slab.h>
13 #include <linux/kthread.h>
14 #include <linux/types.h>
15 #include <linux/string.h>
16 #include <linux/configfs.h>
17 #include <linux/ctype.h>
18 #include <linux/hash.h>
19 #include <asm/unaligned.h>
20 #include <scsi/scsi_tcq.h>
21 #include <scsi/libfc.h>
23 #include <target/target_core_base.h>
24 #include <target/target_core_fabric.h>
29 * Dump cmd state for debugging.
31 static void _ft_dump_cmd(struct ft_cmd *cmd, const char *caller)
35 struct se_cmd *se_cmd;
36 struct scatterlist *sg;
39 se_cmd = &cmd->se_cmd;
40 pr_debug("%s: cmd %p sess %p seq %p se_cmd %p\n",
41 caller, cmd, cmd->sess, cmd->seq, se_cmd);
43 pr_debug("%s: cmd %p data_nents %u len %u se_cmd_flags <0x%x>\n",
44 caller, cmd, se_cmd->t_data_nents,
45 se_cmd->data_length, se_cmd->se_cmd_flags);
47 for_each_sg(se_cmd->t_data_sg, sg, se_cmd->t_data_nents, count)
48 pr_debug("%s: cmd %p sg %p page %p "
49 "len 0x%x off 0x%x\n",
51 sg_page(sg), sg->length, sg->offset);
56 pr_debug("%s: cmd %p sid %x did %x "
57 "ox_id %x rx_id %x seq_id %x e_stat %x\n",
58 caller, cmd, ep->sid, ep->did, ep->oxid, ep->rxid,
59 sp->id, ep->esb_stat);
63 void ft_dump_cmd(struct ft_cmd *cmd, const char *caller)
65 if (unlikely(ft_debug_logging))
66 _ft_dump_cmd(cmd, caller);
69 static void ft_free_cmd(struct ft_cmd *cmd)
79 fc_seq_release(fr_seq(fp));
81 target_free_tag(sess->se_sess, &cmd->se_cmd);
82 ft_sess_put(sess); /* undo get from lookup at recv */
85 void ft_release_cmd(struct se_cmd *se_cmd)
87 struct ft_cmd *cmd = container_of(se_cmd, struct ft_cmd, se_cmd);
92 int ft_check_stop_free(struct se_cmd *se_cmd)
94 return transport_generic_free_cmd(se_cmd, 0);
100 int ft_queue_status(struct se_cmd *se_cmd)
102 struct ft_cmd *cmd = container_of(se_cmd, struct ft_cmd, se_cmd);
104 struct fcp_resp_with_ext *fcp;
105 struct fc_lport *lport;
112 ft_dump_cmd(cmd, __func__);
113 ep = fc_seq_exch(cmd->seq);
115 len = sizeof(*fcp) + se_cmd->scsi_sense_length;
116 fp = fc_frame_alloc(lport, len);
118 se_cmd->scsi_status = SAM_STAT_TASK_SET_FULL;
122 fcp = fc_frame_payload_get(fp, len);
124 fcp->resp.fr_status = se_cmd->scsi_status;
126 len = se_cmd->scsi_sense_length;
128 fcp->resp.fr_flags |= FCP_SNS_LEN_VAL;
129 fcp->ext.fr_sns_len = htonl(len);
130 memcpy((fcp + 1), se_cmd->sense_buffer, len);
134 * Test underflow and overflow with one mask. Usually both are off.
135 * Bidirectional commands are not handled yet.
137 if (se_cmd->se_cmd_flags & (SCF_OVERFLOW_BIT | SCF_UNDERFLOW_BIT)) {
138 if (se_cmd->se_cmd_flags & SCF_OVERFLOW_BIT)
139 fcp->resp.fr_flags |= FCP_RESID_OVER;
141 fcp->resp.fr_flags |= FCP_RESID_UNDER;
142 fcp->ext.fr_resid = cpu_to_be32(se_cmd->residual_count);
148 cmd->seq = fc_seq_start_next(cmd->seq);
149 fc_fill_fc_hdr(fp, FC_RCTL_DD_CMD_STATUS, ep->did, ep->sid, FC_TYPE_FCP,
150 FC_FC_EX_CTX | FC_FC_LAST_SEQ | FC_FC_END_SEQ, 0);
152 rc = fc_seq_send(lport, cmd->seq, fp);
154 pr_info_ratelimited("%s: Failed to send response frame %p, "
155 "xid <0x%x>\n", __func__, fp, ep->xid);
157 * Generate a TASK_SET_FULL status to notify the initiator
158 * to reduce it's queue_depth after the se_cmd response has
159 * been re-queued by target-core.
161 se_cmd->scsi_status = SAM_STAT_TASK_SET_FULL;
164 fc_exch_done(cmd->seq);
166 * Drop the extra ACK_KREF reference taken by target_submit_cmd()
167 * ahead of ft_check_stop_free() -> transport_generic_free_cmd()
168 * final se_cmd->cmd_kref put.
170 target_put_sess_cmd(&cmd->se_cmd);
175 * Send TX_RDY (transfer ready).
177 int ft_write_pending(struct se_cmd *se_cmd)
179 struct ft_cmd *cmd = container_of(se_cmd, struct ft_cmd, se_cmd);
181 struct fcp_txrdy *txrdy;
182 struct fc_lport *lport;
184 struct fc_frame_header *fh;
187 ft_dump_cmd(cmd, __func__);
191 ep = fc_seq_exch(cmd->seq);
193 fp = fc_frame_alloc(lport, sizeof(*txrdy));
195 return -ENOMEM; /* Signal QUEUE_FULL */
197 txrdy = fc_frame_payload_get(fp, sizeof(*txrdy));
198 memset(txrdy, 0, sizeof(*txrdy));
199 txrdy->ft_burst_len = htonl(se_cmd->data_length);
201 cmd->seq = fc_seq_start_next(cmd->seq);
202 fc_fill_fc_hdr(fp, FC_RCTL_DD_DATA_DESC, ep->did, ep->sid, FC_TYPE_FCP,
203 FC_FC_EX_CTX | FC_FC_END_SEQ | FC_FC_SEQ_INIT, 0);
205 fh = fc_frame_header_get(fp);
206 f_ctl = ntoh24(fh->fh_f_ctl);
208 /* Only if it is 'Exchange Responder' */
209 if (f_ctl & FC_FC_EX_CTX) {
210 /* Target is 'exchange responder' and sending XFER_READY
211 * to 'exchange initiator (initiator)'
213 if ((ep->xid <= lport->lro_xid) &&
214 (fh->fh_r_ctl == FC_RCTL_DD_DATA_DESC)) {
215 if ((se_cmd->se_cmd_flags & SCF_SCSI_DATA_CDB) &&
216 lport->tt.ddp_target(lport, ep->xid,
218 se_cmd->t_data_nents))
219 cmd->was_ddp_setup = 1;
222 fc_seq_send(lport, cmd->seq, fp);
227 * FC sequence response handler for follow-on sequences (data) and aborts.
229 static void ft_recv_seq(struct fc_seq *sp, struct fc_frame *fp, void *arg)
231 struct ft_cmd *cmd = arg;
232 struct fc_frame_header *fh;
235 /* XXX need to find cmd if queued */
241 fh = fc_frame_header_get(fp);
243 switch (fh->fh_r_ctl) {
244 case FC_RCTL_DD_SOL_DATA: /* write data */
245 ft_recv_write_data(cmd, fp);
247 case FC_RCTL_DD_UNSOL_CTL: /* command */
248 case FC_RCTL_DD_SOL_CTL: /* transfer ready */
249 case FC_RCTL_DD_DATA_DESC: /* transfer ready */
251 pr_debug("%s: unhandled frame r_ctl %x\n",
252 __func__, fh->fh_r_ctl);
253 ft_invl_hw_context(cmd);
255 transport_generic_free_cmd(&cmd->se_cmd, 0);
261 * Send a FCP response including SCSI status and optional FCP rsp_code.
262 * status is SAM_STAT_GOOD (zero) iff code is valid.
263 * This is used in error cases, such as allocation failures.
265 static void ft_send_resp_status(struct fc_lport *lport,
266 const struct fc_frame *rx_fp,
267 u32 status, enum fcp_resp_rsp_codes code)
271 const struct fc_frame_header *fh;
273 struct fcp_resp_with_ext *fcp;
274 struct fcp_resp_rsp_info *info;
276 fh = fc_frame_header_get(rx_fp);
277 pr_debug("FCP error response: did %x oxid %x status %x code %x\n",
278 ntoh24(fh->fh_s_id), ntohs(fh->fh_ox_id), status, code);
280 if (status == SAM_STAT_GOOD)
281 len += sizeof(*info);
282 fp = fc_frame_alloc(lport, len);
285 fcp = fc_frame_payload_get(fp, len);
287 fcp->resp.fr_status = status;
288 if (status == SAM_STAT_GOOD) {
289 fcp->ext.fr_rsp_len = htonl(sizeof(*info));
290 fcp->resp.fr_flags |= FCP_RSP_LEN_VAL;
291 info = (struct fcp_resp_rsp_info *)(fcp + 1);
292 info->rsp_code = code;
295 fc_fill_reply_hdr(fp, rx_fp, FC_RCTL_DD_CMD_STATUS, 0);
298 fc_seq_send(lport, sp, fp);
301 lport->tt.frame_send(lport, fp);
306 * Send error or task management response.
308 static void ft_send_resp_code(struct ft_cmd *cmd,
309 enum fcp_resp_rsp_codes code)
311 ft_send_resp_status(cmd->sess->tport->lport,
312 cmd->req_frame, SAM_STAT_GOOD, code);
317 * Send error or task management response.
318 * Always frees the cmd and associated state.
320 static void ft_send_resp_code_and_free(struct ft_cmd *cmd,
321 enum fcp_resp_rsp_codes code)
323 ft_send_resp_code(cmd, code);
328 * Handle Task Management Request.
330 static void ft_send_tm(struct ft_cmd *cmd)
332 struct fcp_cmnd *fcp;
336 fcp = fc_frame_payload_get(cmd->req_frame, sizeof(*fcp));
338 switch (fcp->fc_tm_flags) {
339 case FCP_TMF_LUN_RESET:
340 tm_func = TMR_LUN_RESET;
342 case FCP_TMF_TGT_RESET:
343 tm_func = TMR_TARGET_WARM_RESET;
345 case FCP_TMF_CLR_TASK_SET:
346 tm_func = TMR_CLEAR_TASK_SET;
348 case FCP_TMF_ABT_TASK_SET:
349 tm_func = TMR_ABORT_TASK_SET;
351 case FCP_TMF_CLR_ACA:
352 tm_func = TMR_CLEAR_ACA;
356 * FCP4r01 indicates having a combination of
357 * tm_flags set is invalid.
359 pr_debug("invalid FCP tm_flags %x\n", fcp->fc_tm_flags);
360 ft_send_resp_code_and_free(cmd, FCP_CMND_FIELDS_INVALID);
364 /* FIXME: Add referenced task tag for ABORT_TASK */
365 rc = target_submit_tmr(&cmd->se_cmd, cmd->sess->se_sess,
366 &cmd->ft_sense_buffer[0], scsilun_to_int(&fcp->fc_lun),
367 cmd, tm_func, GFP_KERNEL, 0, TARGET_SCF_ACK_KREF);
369 ft_send_resp_code_and_free(cmd, FCP_TMF_FAILED);
373 * Send status from completed task management request.
375 void ft_queue_tm_resp(struct se_cmd *se_cmd)
377 struct ft_cmd *cmd = container_of(se_cmd, struct ft_cmd, se_cmd);
378 struct se_tmr_req *tmr = se_cmd->se_tmr_req;
379 enum fcp_resp_rsp_codes code;
383 switch (tmr->response) {
384 case TMR_FUNCTION_COMPLETE:
387 case TMR_LUN_DOES_NOT_EXIST:
388 code = FCP_TMF_INVALID_LUN;
390 case TMR_FUNCTION_REJECTED:
391 code = FCP_TMF_REJECTED;
393 case TMR_TASK_DOES_NOT_EXIST:
394 case TMR_TASK_MGMT_FUNCTION_NOT_SUPPORTED:
396 code = FCP_TMF_FAILED;
399 pr_debug("tmr fn %d resp %d fcp code %d\n",
400 tmr->function, tmr->response, code);
401 ft_send_resp_code(cmd, code);
403 * Drop the extra ACK_KREF reference taken by target_submit_tmr()
404 * ahead of ft_check_stop_free() -> transport_generic_free_cmd()
405 * final se_cmd->cmd_kref put.
407 target_put_sess_cmd(&cmd->se_cmd);
410 void ft_aborted_task(struct se_cmd *se_cmd)
415 static void ft_send_work(struct work_struct *work);
418 * Handle incoming FCP command.
420 static void ft_recv_cmd(struct ft_sess *sess, struct fc_frame *fp)
423 struct fc_lport *lport = sess->tport->lport;
424 struct se_session *se_sess = sess->se_sess;
427 tag = sbitmap_queue_get(&se_sess->sess_tag_pool, &cpu);
431 cmd = &((struct ft_cmd *)se_sess->sess_cmd_map)[tag];
432 memset(cmd, 0, sizeof(struct ft_cmd));
434 cmd->se_cmd.map_tag = tag;
435 cmd->se_cmd.map_cpu = cpu;
437 cmd->seq = fc_seq_assign(lport, fp);
439 target_free_tag(se_sess, &cmd->se_cmd);
442 cmd->req_frame = fp; /* hold frame during cmd */
444 INIT_WORK(&cmd->work, ft_send_work);
445 queue_work(sess->tport->tpg->workqueue, &cmd->work);
449 pr_debug("cmd or seq allocation failure - sending BUSY\n");
450 ft_send_resp_status(lport, fp, SAM_STAT_BUSY, 0);
452 ft_sess_put(sess); /* undo get from lookup */
457 * Handle incoming FCP frame.
458 * Caller has verified that the frame is type FCP.
460 void ft_recv_req(struct ft_sess *sess, struct fc_frame *fp)
462 struct fc_frame_header *fh = fc_frame_header_get(fp);
464 switch (fh->fh_r_ctl) {
465 case FC_RCTL_DD_UNSOL_CMD: /* command */
466 ft_recv_cmd(sess, fp);
468 case FC_RCTL_DD_SOL_DATA: /* write data */
469 case FC_RCTL_DD_UNSOL_CTL:
470 case FC_RCTL_DD_SOL_CTL:
471 case FC_RCTL_DD_DATA_DESC: /* transfer ready */
472 case FC_RCTL_ELS4_REQ: /* SRR, perhaps */
474 pr_debug("%s: unhandled frame r_ctl %x\n",
475 __func__, fh->fh_r_ctl);
477 ft_sess_put(sess); /* undo get from lookup */
483 * Send new command to target.
485 static void ft_send_work(struct work_struct *work)
487 struct ft_cmd *cmd = container_of(work, struct ft_cmd, work);
488 struct fc_frame_header *fh = fc_frame_header_get(cmd->req_frame);
489 struct fcp_cmnd *fcp;
493 fcp = fc_frame_payload_get(cmd->req_frame, sizeof(*fcp));
497 if (fcp->fc_flags & FCP_CFL_LEN_MASK)
498 goto err; /* not handling longer CDBs yet */
501 * Check for FCP task management flags
503 if (fcp->fc_tm_flags) {
508 switch (fcp->fc_flags & (FCP_CFL_RDDATA | FCP_CFL_WRDATA)) {
513 data_dir = DMA_FROM_DEVICE;
516 data_dir = DMA_TO_DEVICE;
518 case FCP_CFL_WRDATA | FCP_CFL_RDDATA:
519 goto err; /* TBD not supported by tcm_fc yet */
522 * Locate the SAM Task Attr from fc_pri_ta
524 switch (fcp->fc_pri_ta & FCP_PTA_MASK) {
526 task_attr = TCM_HEAD_TAG;
528 case FCP_PTA_ORDERED:
529 task_attr = TCM_ORDERED_TAG;
532 task_attr = TCM_ACA_TAG;
536 task_attr = TCM_SIMPLE_TAG;
539 fc_seq_set_resp(cmd->seq, ft_recv_seq, cmd);
540 cmd->se_cmd.tag = fc_seq_exch(cmd->seq)->rxid;
543 * Use a single se_cmd->cmd_kref as we expect to release se_cmd
544 * directly from ft_check_stop_free callback in response path.
546 if (target_init_cmd(&cmd->se_cmd, cmd->sess->se_sess,
547 &cmd->ft_sense_buffer[0],
548 scsilun_to_int(&fcp->fc_lun), ntohl(fcp->fc_dl),
549 task_attr, data_dir, TARGET_SCF_ACK_KREF))
552 if (target_submit_prep(&cmd->se_cmd, fcp->fc_cdb, NULL, 0, NULL, 0,
553 NULL, 0, GFP_KERNEL))
556 target_submit(&cmd->se_cmd);
557 pr_debug("r_ctl %x target_submit_cmd %p\n", fh->fh_r_ctl, cmd);
561 ft_send_resp_code_and_free(cmd, FCP_CMND_FIELDS_INVALID);