Merge branch 'for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/geert/linux...
[linux-btrfs-devel.git] / drivers / target / tcm_fc / tfc_cmd.c
blob80fbcde00cb694db7a628d3e0c0362a3e47650cd
1 /*
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
11 * more details.
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_tmr.h>
49 #include <target/configfs_macros.h>
51 #include "tcm_fc.h"
54 * Dump cmd state for debugging.
56 void ft_dump_cmd(struct ft_cmd *cmd, const char *caller)
58 struct fc_exch *ep;
59 struct fc_seq *sp;
60 struct se_cmd *se_cmd;
61 struct scatterlist *sg;
62 int count;
64 se_cmd = &cmd->se_cmd;
65 pr_debug("%s: cmd %p sess %p seq %p se_cmd %p\n",
66 caller, cmd, cmd->sess, cmd->seq, se_cmd);
67 pr_debug("%s: cmd %p cdb %p\n",
68 caller, cmd, cmd->cdb);
69 pr_debug("%s: cmd %p lun %d\n", caller, cmd, cmd->lun);
71 pr_debug("%s: cmd %p data_nents %u len %u se_cmd_flags <0x%x>\n",
72 caller, cmd, se_cmd->t_data_nents,
73 se_cmd->data_length, se_cmd->se_cmd_flags);
75 for_each_sg(se_cmd->t_data_sg, sg, se_cmd->t_data_nents, count)
76 pr_debug("%s: cmd %p sg %p page %p "
77 "len 0x%x off 0x%x\n",
78 caller, cmd, sg,
79 sg_page(sg), sg->length, sg->offset);
81 sp = cmd->seq;
82 if (sp) {
83 ep = fc_seq_exch(sp);
84 pr_debug("%s: cmd %p sid %x did %x "
85 "ox_id %x rx_id %x seq_id %x e_stat %x\n",
86 caller, cmd, ep->sid, ep->did, ep->oxid, ep->rxid,
87 sp->id, ep->esb_stat);
89 print_hex_dump(KERN_INFO, "ft_dump_cmd ", DUMP_PREFIX_NONE,
90 16, 4, cmd->cdb, MAX_COMMAND_SIZE, 0);
93 static void ft_free_cmd(struct ft_cmd *cmd)
95 struct fc_frame *fp;
96 struct fc_lport *lport;
98 if (!cmd)
99 return;
100 fp = cmd->req_frame;
101 lport = fr_dev(fp);
102 if (fr_seq(fp))
103 lport->tt.seq_release(fr_seq(fp));
104 fc_frame_free(fp);
105 ft_sess_put(cmd->sess); /* undo get from lookup at recv */
106 kfree(cmd);
109 void ft_release_cmd(struct se_cmd *se_cmd)
111 struct ft_cmd *cmd = container_of(se_cmd, struct ft_cmd, se_cmd);
113 ft_free_cmd(cmd);
116 void ft_check_stop_free(struct se_cmd *se_cmd)
118 transport_generic_free_cmd(se_cmd, 0, 0);
122 * Send response.
124 int ft_queue_status(struct se_cmd *se_cmd)
126 struct ft_cmd *cmd = container_of(se_cmd, struct ft_cmd, se_cmd);
127 struct fc_frame *fp;
128 struct fcp_resp_with_ext *fcp;
129 struct fc_lport *lport;
130 struct fc_exch *ep;
131 size_t len;
133 ft_dump_cmd(cmd, __func__);
134 ep = fc_seq_exch(cmd->seq);
135 lport = ep->lp;
136 len = sizeof(*fcp) + se_cmd->scsi_sense_length;
137 fp = fc_frame_alloc(lport, len);
138 if (!fp) {
139 /* XXX shouldn't just drop it - requeue and retry? */
140 return 0;
142 fcp = fc_frame_payload_get(fp, len);
143 memset(fcp, 0, len);
144 fcp->resp.fr_status = se_cmd->scsi_status;
146 len = se_cmd->scsi_sense_length;
147 if (len) {
148 fcp->resp.fr_flags |= FCP_SNS_LEN_VAL;
149 fcp->ext.fr_sns_len = htonl(len);
150 memcpy((fcp + 1), se_cmd->sense_buffer, len);
154 * Test underflow and overflow with one mask. Usually both are off.
155 * Bidirectional commands are not handled yet.
157 if (se_cmd->se_cmd_flags & (SCF_OVERFLOW_BIT | SCF_UNDERFLOW_BIT)) {
158 if (se_cmd->se_cmd_flags & SCF_OVERFLOW_BIT)
159 fcp->resp.fr_flags |= FCP_RESID_OVER;
160 else
161 fcp->resp.fr_flags |= FCP_RESID_UNDER;
162 fcp->ext.fr_resid = cpu_to_be32(se_cmd->residual_count);
166 * Send response.
168 cmd->seq = lport->tt.seq_start_next(cmd->seq);
169 fc_fill_fc_hdr(fp, FC_RCTL_DD_CMD_STATUS, ep->did, ep->sid, FC_TYPE_FCP,
170 FC_FC_EX_CTX | FC_FC_LAST_SEQ | FC_FC_END_SEQ, 0);
172 lport->tt.seq_send(lport, cmd->seq, fp);
173 lport->tt.exch_done(cmd->seq);
174 return 0;
177 int ft_write_pending_status(struct se_cmd *se_cmd)
179 struct ft_cmd *cmd = container_of(se_cmd, struct ft_cmd, se_cmd);
181 return cmd->write_data_len != se_cmd->data_length;
185 * Send TX_RDY (transfer ready).
187 int ft_write_pending(struct se_cmd *se_cmd)
189 struct ft_cmd *cmd = container_of(se_cmd, struct ft_cmd, se_cmd);
190 struct fc_frame *fp;
191 struct fcp_txrdy *txrdy;
192 struct fc_lport *lport;
193 struct fc_exch *ep;
194 struct fc_frame_header *fh;
195 u32 f_ctl;
197 ft_dump_cmd(cmd, __func__);
199 ep = fc_seq_exch(cmd->seq);
200 lport = ep->lp;
201 fp = fc_frame_alloc(lport, sizeof(*txrdy));
202 if (!fp)
203 return PYX_TRANSPORT_OUT_OF_MEMORY_RESOURCES;
205 txrdy = fc_frame_payload_get(fp, sizeof(*txrdy));
206 memset(txrdy, 0, sizeof(*txrdy));
207 txrdy->ft_burst_len = htonl(se_cmd->data_length);
209 cmd->seq = lport->tt.seq_start_next(cmd->seq);
210 fc_fill_fc_hdr(fp, FC_RCTL_DD_DATA_DESC, ep->did, ep->sid, FC_TYPE_FCP,
211 FC_FC_EX_CTX | FC_FC_END_SEQ | FC_FC_SEQ_INIT, 0);
213 fh = fc_frame_header_get(fp);
214 f_ctl = ntoh24(fh->fh_f_ctl);
216 /* Only if it is 'Exchange Responder' */
217 if (f_ctl & FC_FC_EX_CTX) {
218 /* Target is 'exchange responder' and sending XFER_READY
219 * to 'exchange initiator (initiator)'
221 if ((ep->xid <= lport->lro_xid) &&
222 (fh->fh_r_ctl == FC_RCTL_DD_DATA_DESC)) {
223 if (se_cmd->se_cmd_flags & SCF_SCSI_DATA_SG_IO_CDB) {
225 * cmd may have been broken up into multiple
226 * tasks. Link their sgs together so we can
227 * operate on them all at once.
229 transport_do_task_sg_chain(se_cmd);
230 cmd->sg = se_cmd->t_tasks_sg_chained;
231 cmd->sg_cnt =
232 se_cmd->t_tasks_sg_chained_no;
234 if (cmd->sg && lport->tt.ddp_target(lport, ep->xid,
235 cmd->sg,
236 cmd->sg_cnt))
237 cmd->was_ddp_setup = 1;
240 lport->tt.seq_send(lport, cmd->seq, fp);
241 return 0;
244 u32 ft_get_task_tag(struct se_cmd *se_cmd)
246 struct ft_cmd *cmd = container_of(se_cmd, struct ft_cmd, se_cmd);
248 return fc_seq_exch(cmd->seq)->rxid;
251 int ft_get_cmd_state(struct se_cmd *se_cmd)
253 return 0;
256 int ft_is_state_remove(struct se_cmd *se_cmd)
258 return 0; /* XXX TBD */
262 * FC sequence response handler for follow-on sequences (data) and aborts.
264 static void ft_recv_seq(struct fc_seq *sp, struct fc_frame *fp, void *arg)
266 struct ft_cmd *cmd = arg;
267 struct fc_frame_header *fh;
269 if (IS_ERR(fp)) {
270 /* XXX need to find cmd if queued */
271 cmd->se_cmd.t_state = TRANSPORT_REMOVE;
272 cmd->seq = NULL;
273 transport_generic_free_cmd(&cmd->se_cmd, 0, 0);
274 return;
277 fh = fc_frame_header_get(fp);
279 switch (fh->fh_r_ctl) {
280 case FC_RCTL_DD_SOL_DATA: /* write data */
281 ft_recv_write_data(cmd, fp);
282 break;
283 case FC_RCTL_DD_UNSOL_CTL: /* command */
284 case FC_RCTL_DD_SOL_CTL: /* transfer ready */
285 case FC_RCTL_DD_DATA_DESC: /* transfer ready */
286 default:
287 pr_debug("%s: unhandled frame r_ctl %x\n",
288 __func__, fh->fh_r_ctl);
289 ft_invl_hw_context(cmd);
290 fc_frame_free(fp);
291 transport_generic_free_cmd(&cmd->se_cmd, 0, 0);
292 break;
297 * Send a FCP response including SCSI status and optional FCP rsp_code.
298 * status is SAM_STAT_GOOD (zero) iff code is valid.
299 * This is used in error cases, such as allocation failures.
301 static void ft_send_resp_status(struct fc_lport *lport,
302 const struct fc_frame *rx_fp,
303 u32 status, enum fcp_resp_rsp_codes code)
305 struct fc_frame *fp;
306 struct fc_seq *sp;
307 const struct fc_frame_header *fh;
308 size_t len;
309 struct fcp_resp_with_ext *fcp;
310 struct fcp_resp_rsp_info *info;
312 fh = fc_frame_header_get(rx_fp);
313 pr_debug("FCP error response: did %x oxid %x status %x code %x\n",
314 ntoh24(fh->fh_s_id), ntohs(fh->fh_ox_id), status, code);
315 len = sizeof(*fcp);
316 if (status == SAM_STAT_GOOD)
317 len += sizeof(*info);
318 fp = fc_frame_alloc(lport, len);
319 if (!fp)
320 return;
321 fcp = fc_frame_payload_get(fp, len);
322 memset(fcp, 0, len);
323 fcp->resp.fr_status = status;
324 if (status == SAM_STAT_GOOD) {
325 fcp->ext.fr_rsp_len = htonl(sizeof(*info));
326 fcp->resp.fr_flags |= FCP_RSP_LEN_VAL;
327 info = (struct fcp_resp_rsp_info *)(fcp + 1);
328 info->rsp_code = code;
331 fc_fill_reply_hdr(fp, rx_fp, FC_RCTL_DD_CMD_STATUS, 0);
332 sp = fr_seq(fp);
333 if (sp)
334 lport->tt.seq_send(lport, sp, fp);
335 else
336 lport->tt.frame_send(lport, fp);
340 * Send error or task management response.
342 static void ft_send_resp_code(struct ft_cmd *cmd,
343 enum fcp_resp_rsp_codes code)
345 ft_send_resp_status(cmd->sess->tport->lport,
346 cmd->req_frame, SAM_STAT_GOOD, code);
351 * Send error or task management response.
352 * Always frees the cmd and associated state.
354 static void ft_send_resp_code_and_free(struct ft_cmd *cmd,
355 enum fcp_resp_rsp_codes code)
357 ft_send_resp_code(cmd, code);
358 ft_free_cmd(cmd);
362 * Handle Task Management Request.
364 static void ft_send_tm(struct ft_cmd *cmd)
366 struct se_tmr_req *tmr;
367 struct fcp_cmnd *fcp;
368 struct ft_sess *sess;
369 u8 tm_func;
371 fcp = fc_frame_payload_get(cmd->req_frame, sizeof(*fcp));
373 switch (fcp->fc_tm_flags) {
374 case FCP_TMF_LUN_RESET:
375 tm_func = TMR_LUN_RESET;
376 break;
377 case FCP_TMF_TGT_RESET:
378 tm_func = TMR_TARGET_WARM_RESET;
379 break;
380 case FCP_TMF_CLR_TASK_SET:
381 tm_func = TMR_CLEAR_TASK_SET;
382 break;
383 case FCP_TMF_ABT_TASK_SET:
384 tm_func = TMR_ABORT_TASK_SET;
385 break;
386 case FCP_TMF_CLR_ACA:
387 tm_func = TMR_CLEAR_ACA;
388 break;
389 default:
391 * FCP4r01 indicates having a combination of
392 * tm_flags set is invalid.
394 pr_debug("invalid FCP tm_flags %x\n", fcp->fc_tm_flags);
395 ft_send_resp_code_and_free(cmd, FCP_CMND_FIELDS_INVALID);
396 return;
399 pr_debug("alloc tm cmd fn %d\n", tm_func);
400 tmr = core_tmr_alloc_req(&cmd->se_cmd, cmd, tm_func);
401 if (!tmr) {
402 pr_debug("alloc failed\n");
403 ft_send_resp_code_and_free(cmd, FCP_TMF_FAILED);
404 return;
406 cmd->se_cmd.se_tmr_req = tmr;
408 switch (fcp->fc_tm_flags) {
409 case FCP_TMF_LUN_RESET:
410 cmd->lun = scsilun_to_int((struct scsi_lun *)fcp->fc_lun);
411 if (transport_lookup_tmr_lun(&cmd->se_cmd, cmd->lun) < 0) {
413 * Make sure to clean up newly allocated TMR request
414 * since "unable to handle TMR request because failed
415 * to get to LUN"
417 pr_debug("Failed to get LUN for TMR func %d, "
418 "se_cmd %p, unpacked_lun %d\n",
419 tm_func, &cmd->se_cmd, cmd->lun);
420 ft_dump_cmd(cmd, __func__);
421 sess = cmd->sess;
422 transport_send_check_condition_and_sense(&cmd->se_cmd,
423 cmd->se_cmd.scsi_sense_reason, 0);
424 transport_generic_free_cmd(&cmd->se_cmd, 0, 0);
425 ft_sess_put(sess);
426 return;
428 break;
429 case FCP_TMF_TGT_RESET:
430 case FCP_TMF_CLR_TASK_SET:
431 case FCP_TMF_ABT_TASK_SET:
432 case FCP_TMF_CLR_ACA:
433 break;
434 default:
435 return;
437 transport_generic_handle_tmr(&cmd->se_cmd);
441 * Send status from completed task management request.
443 int ft_queue_tm_resp(struct se_cmd *se_cmd)
445 struct ft_cmd *cmd = container_of(se_cmd, struct ft_cmd, se_cmd);
446 struct se_tmr_req *tmr = se_cmd->se_tmr_req;
447 enum fcp_resp_rsp_codes code;
449 switch (tmr->response) {
450 case TMR_FUNCTION_COMPLETE:
451 code = FCP_TMF_CMPL;
452 break;
453 case TMR_LUN_DOES_NOT_EXIST:
454 code = FCP_TMF_INVALID_LUN;
455 break;
456 case TMR_FUNCTION_REJECTED:
457 code = FCP_TMF_REJECTED;
458 break;
459 case TMR_TASK_DOES_NOT_EXIST:
460 case TMR_TASK_STILL_ALLEGIANT:
461 case TMR_TASK_FAILOVER_NOT_SUPPORTED:
462 case TMR_TASK_MGMT_FUNCTION_NOT_SUPPORTED:
463 case TMR_FUNCTION_AUTHORIZATION_FAILED:
464 default:
465 code = FCP_TMF_FAILED;
466 break;
468 pr_debug("tmr fn %d resp %d fcp code %d\n",
469 tmr->function, tmr->response, code);
470 ft_send_resp_code(cmd, code);
471 return 0;
474 static void ft_send_work(struct work_struct *work);
477 * Handle incoming FCP command.
479 static void ft_recv_cmd(struct ft_sess *sess, struct fc_frame *fp)
481 struct ft_cmd *cmd;
482 struct fc_lport *lport = sess->tport->lport;
484 cmd = kzalloc(sizeof(*cmd), GFP_ATOMIC);
485 if (!cmd)
486 goto busy;
487 cmd->sess = sess;
488 cmd->seq = lport->tt.seq_assign(lport, fp);
489 if (!cmd->seq) {
490 kfree(cmd);
491 goto busy;
493 cmd->req_frame = fp; /* hold frame during cmd */
495 INIT_WORK(&cmd->work, ft_send_work);
496 queue_work(sess->tport->tpg->workqueue, &cmd->work);
497 return;
499 busy:
500 pr_debug("cmd or seq allocation failure - sending BUSY\n");
501 ft_send_resp_status(lport, fp, SAM_STAT_BUSY, 0);
502 fc_frame_free(fp);
503 ft_sess_put(sess); /* undo get from lookup */
508 * Handle incoming FCP frame.
509 * Caller has verified that the frame is type FCP.
511 void ft_recv_req(struct ft_sess *sess, struct fc_frame *fp)
513 struct fc_frame_header *fh = fc_frame_header_get(fp);
515 switch (fh->fh_r_ctl) {
516 case FC_RCTL_DD_UNSOL_CMD: /* command */
517 ft_recv_cmd(sess, fp);
518 break;
519 case FC_RCTL_DD_SOL_DATA: /* write data */
520 case FC_RCTL_DD_UNSOL_CTL:
521 case FC_RCTL_DD_SOL_CTL:
522 case FC_RCTL_DD_DATA_DESC: /* transfer ready */
523 case FC_RCTL_ELS4_REQ: /* SRR, perhaps */
524 default:
525 pr_debug("%s: unhandled frame r_ctl %x\n",
526 __func__, fh->fh_r_ctl);
527 fc_frame_free(fp);
528 ft_sess_put(sess); /* undo get from lookup */
529 break;
534 * Send new command to target.
536 static void ft_send_work(struct work_struct *work)
538 struct ft_cmd *cmd = container_of(work, struct ft_cmd, work);
539 struct fc_frame_header *fh = fc_frame_header_get(cmd->req_frame);
540 struct se_cmd *se_cmd;
541 struct fcp_cmnd *fcp;
542 int data_dir = 0;
543 u32 data_len;
544 int task_attr;
545 int ret;
547 fcp = fc_frame_payload_get(cmd->req_frame, sizeof(*fcp));
548 if (!fcp)
549 goto err;
551 if (fcp->fc_flags & FCP_CFL_LEN_MASK)
552 goto err; /* not handling longer CDBs yet */
554 if (fcp->fc_tm_flags) {
555 task_attr = FCP_PTA_SIMPLE;
556 data_dir = DMA_NONE;
557 data_len = 0;
558 } else {
559 switch (fcp->fc_flags & (FCP_CFL_RDDATA | FCP_CFL_WRDATA)) {
560 case 0:
561 data_dir = DMA_NONE;
562 break;
563 case FCP_CFL_RDDATA:
564 data_dir = DMA_FROM_DEVICE;
565 break;
566 case FCP_CFL_WRDATA:
567 data_dir = DMA_TO_DEVICE;
568 break;
569 case FCP_CFL_WRDATA | FCP_CFL_RDDATA:
570 goto err; /* TBD not supported by tcm_fc yet */
573 * Locate the SAM Task Attr from fc_pri_ta
575 switch (fcp->fc_pri_ta & FCP_PTA_MASK) {
576 case FCP_PTA_HEADQ:
577 task_attr = MSG_HEAD_TAG;
578 break;
579 case FCP_PTA_ORDERED:
580 task_attr = MSG_ORDERED_TAG;
581 break;
582 case FCP_PTA_ACA:
583 task_attr = MSG_ACA_TAG;
584 break;
585 case FCP_PTA_SIMPLE: /* Fallthrough */
586 default:
587 task_attr = MSG_SIMPLE_TAG;
591 task_attr = fcp->fc_pri_ta & FCP_PTA_MASK;
592 data_len = ntohl(fcp->fc_dl);
593 cmd->cdb = fcp->fc_cdb;
596 se_cmd = &cmd->se_cmd;
598 * Initialize struct se_cmd descriptor from target_core_mod
599 * infrastructure
601 transport_init_se_cmd(se_cmd, &ft_configfs->tf_ops, cmd->sess->se_sess,
602 data_len, data_dir, task_attr,
603 &cmd->ft_sense_buffer[0]);
605 * Check for FCP task management flags
607 if (fcp->fc_tm_flags) {
608 ft_send_tm(cmd);
609 return;
612 fc_seq_exch(cmd->seq)->lp->tt.seq_set_resp(cmd->seq, ft_recv_seq, cmd);
614 cmd->lun = scsilun_to_int((struct scsi_lun *)fcp->fc_lun);
615 ret = transport_lookup_cmd_lun(&cmd->se_cmd, cmd->lun);
616 if (ret < 0) {
617 ft_dump_cmd(cmd, __func__);
618 transport_send_check_condition_and_sense(&cmd->se_cmd,
619 cmd->se_cmd.scsi_sense_reason, 0);
620 return;
623 ret = transport_generic_allocate_tasks(se_cmd, cmd->cdb);
625 pr_debug("r_ctl %x alloc task ret %d\n", fh->fh_r_ctl, ret);
626 ft_dump_cmd(cmd, __func__);
628 if (ret == -ENOMEM) {
629 transport_send_check_condition_and_sense(se_cmd,
630 TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE, 0);
631 transport_generic_free_cmd(se_cmd, 0, 0);
632 return;
634 if (ret == -EINVAL) {
635 if (se_cmd->se_cmd_flags & SCF_SCSI_RESERVATION_CONFLICT)
636 ft_queue_status(se_cmd);
637 else
638 transport_send_check_condition_and_sense(se_cmd,
639 se_cmd->scsi_sense_reason, 0);
640 transport_generic_free_cmd(se_cmd, 0, 0);
641 return;
643 transport_generic_handle_cdb(se_cmd);
644 return;
646 err:
647 ft_send_resp_code_and_free(cmd, FCP_CMND_FIELDS_INVALID);