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/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_base.h>
49 #include <target/target_core_tmr.h>
50 #include <target/configfs_macros.h>
55 * Dump cmd state for debugging.
57 void ft_dump_cmd(struct ft_cmd *cmd, const char *caller)
61 struct se_cmd *se_cmd;
64 if (!(ft_debug_logging & FT_DEBUG_IO))
67 se_cmd = &cmd->se_cmd;
68 printk(KERN_INFO "%s: cmd %p state %d sess %p seq %p se_cmd %p\n",
69 caller, cmd, cmd->state, cmd->sess, cmd->seq, se_cmd);
70 printk(KERN_INFO "%s: cmd %p cdb %p\n",
71 caller, cmd, cmd->cdb);
72 printk(KERN_INFO "%s: cmd %p lun %d\n", caller, cmd, cmd->lun);
74 printk(KERN_INFO "%s: cmd %p se_num %u buf %p len %u se_cmd_flags <0x%x>\n",
75 caller, cmd, se_cmd->t_tasks_se_num,
76 se_cmd->t_task_buf, se_cmd->data_length, se_cmd->se_cmd_flags);
78 list_for_each_entry(mem, &se_cmd->t_mem_list, se_list)
79 printk(KERN_INFO "%s: cmd %p mem %p page %p "
80 "len 0x%x off 0x%x\n",
82 mem->se_page, mem->se_len, mem->se_off);
86 printk(KERN_INFO "%s: cmd %p sid %x did %x "
87 "ox_id %x rx_id %x seq_id %x e_stat %x\n",
88 caller, cmd, ep->sid, ep->did, ep->oxid, ep->rxid,
89 sp->id, ep->esb_stat);
91 print_hex_dump(KERN_INFO, "ft_dump_cmd ", DUMP_PREFIX_NONE,
92 16, 4, cmd->cdb, MAX_COMMAND_SIZE, 0);
95 static void ft_queue_cmd(struct ft_sess *sess, struct ft_cmd *cmd)
97 struct se_queue_obj *qobj;
100 qobj = &sess->tport->tpg->qobj;
101 spin_lock_irqsave(&qobj->cmd_queue_lock, flags);
102 list_add_tail(&cmd->se_req.qr_list, &qobj->qobj_list);
103 spin_unlock_irqrestore(&qobj->cmd_queue_lock, flags);
104 atomic_inc(&qobj->queue_cnt);
105 wake_up_interruptible(&qobj->thread_wq);
108 static struct ft_cmd *ft_dequeue_cmd(struct se_queue_obj *qobj)
111 struct se_queue_req *qr;
113 spin_lock_irqsave(&qobj->cmd_queue_lock, flags);
114 if (list_empty(&qobj->qobj_list)) {
115 spin_unlock_irqrestore(&qobj->cmd_queue_lock, flags);
118 qr = list_first_entry(&qobj->qobj_list, struct se_queue_req, qr_list);
119 list_del(&qr->qr_list);
120 atomic_dec(&qobj->queue_cnt);
121 spin_unlock_irqrestore(&qobj->cmd_queue_lock, flags);
122 return container_of(qr, struct ft_cmd, se_req);
125 static void ft_free_cmd(struct ft_cmd *cmd)
128 struct fc_lport *lport;
135 lport->tt.seq_release(fr_seq(fp));
137 ft_sess_put(cmd->sess); /* undo get from lookup at recv */
141 void ft_release_cmd(struct se_cmd *se_cmd)
143 struct ft_cmd *cmd = container_of(se_cmd, struct ft_cmd, se_cmd);
148 void ft_check_stop_free(struct se_cmd *se_cmd)
150 transport_generic_free_cmd(se_cmd, 0, 1, 0);
156 int ft_queue_status(struct se_cmd *se_cmd)
158 struct ft_cmd *cmd = container_of(se_cmd, struct ft_cmd, se_cmd);
160 struct fcp_resp_with_ext *fcp;
161 struct fc_lport *lport;
165 ft_dump_cmd(cmd, __func__);
166 ep = fc_seq_exch(cmd->seq);
168 len = sizeof(*fcp) + se_cmd->scsi_sense_length;
169 fp = fc_frame_alloc(lport, len);
171 /* XXX shouldn't just drop it - requeue and retry? */
174 fcp = fc_frame_payload_get(fp, len);
176 fcp->resp.fr_status = se_cmd->scsi_status;
178 len = se_cmd->scsi_sense_length;
180 fcp->resp.fr_flags |= FCP_SNS_LEN_VAL;
181 fcp->ext.fr_sns_len = htonl(len);
182 memcpy((fcp + 1), se_cmd->sense_buffer, len);
186 * Test underflow and overflow with one mask. Usually both are off.
187 * Bidirectional commands are not handled yet.
189 if (se_cmd->se_cmd_flags & (SCF_OVERFLOW_BIT | SCF_UNDERFLOW_BIT)) {
190 if (se_cmd->se_cmd_flags & SCF_OVERFLOW_BIT)
191 fcp->resp.fr_flags |= FCP_RESID_OVER;
193 fcp->resp.fr_flags |= FCP_RESID_UNDER;
194 fcp->ext.fr_resid = cpu_to_be32(se_cmd->residual_count);
200 cmd->seq = lport->tt.seq_start_next(cmd->seq);
201 fc_fill_fc_hdr(fp, FC_RCTL_DD_CMD_STATUS, ep->did, ep->sid, FC_TYPE_FCP,
202 FC_FC_EX_CTX | FC_FC_LAST_SEQ | FC_FC_END_SEQ, 0);
204 lport->tt.seq_send(lport, cmd->seq, fp);
205 lport->tt.exch_done(cmd->seq);
209 int ft_write_pending_status(struct se_cmd *se_cmd)
211 struct ft_cmd *cmd = container_of(se_cmd, struct ft_cmd, se_cmd);
213 return cmd->write_data_len != se_cmd->data_length;
217 * Send TX_RDY (transfer ready).
219 int ft_write_pending(struct se_cmd *se_cmd)
221 struct ft_cmd *cmd = container_of(se_cmd, struct ft_cmd, se_cmd);
223 struct fcp_txrdy *txrdy;
224 struct fc_lport *lport;
226 struct fc_frame_header *fh;
229 ft_dump_cmd(cmd, __func__);
231 ep = fc_seq_exch(cmd->seq);
233 fp = fc_frame_alloc(lport, sizeof(*txrdy));
235 return PYX_TRANSPORT_OUT_OF_MEMORY_RESOURCES;
237 txrdy = fc_frame_payload_get(fp, sizeof(*txrdy));
238 memset(txrdy, 0, sizeof(*txrdy));
239 txrdy->ft_burst_len = htonl(se_cmd->data_length);
241 cmd->seq = lport->tt.seq_start_next(cmd->seq);
242 fc_fill_fc_hdr(fp, FC_RCTL_DD_DATA_DESC, ep->did, ep->sid, FC_TYPE_FCP,
243 FC_FC_EX_CTX | FC_FC_END_SEQ | FC_FC_SEQ_INIT, 0);
245 fh = fc_frame_header_get(fp);
246 f_ctl = ntoh24(fh->fh_f_ctl);
248 /* Only if it is 'Exchange Responder' */
249 if (f_ctl & FC_FC_EX_CTX) {
250 /* Target is 'exchange responder' and sending XFER_READY
251 * to 'exchange initiator (initiator)'
253 if ((ep->xid <= lport->lro_xid) &&
254 (fh->fh_r_ctl == FC_RCTL_DD_DATA_DESC)) {
255 if (se_cmd->se_cmd_flags & SCF_SCSI_DATA_SG_IO_CDB) {
257 * Map se_mem list to scatterlist, so that
258 * DDP can be setup. DDP setup function require
259 * scatterlist. se_mem_list is internal to
262 transport_do_task_sg_chain(se_cmd);
263 cmd->sg = se_cmd->t_tasks_sg_chained;
265 se_cmd->t_tasks_sg_chained_no;
267 if (cmd->sg && lport->tt.ddp_setup(lport, ep->xid,
268 cmd->sg, cmd->sg_cnt))
269 cmd->was_ddp_setup = 1;
272 lport->tt.seq_send(lport, cmd->seq, fp);
276 u32 ft_get_task_tag(struct se_cmd *se_cmd)
278 struct ft_cmd *cmd = container_of(se_cmd, struct ft_cmd, se_cmd);
280 return fc_seq_exch(cmd->seq)->rxid;
283 int ft_get_cmd_state(struct se_cmd *se_cmd)
285 struct ft_cmd *cmd = container_of(se_cmd, struct ft_cmd, se_cmd);
290 int ft_is_state_remove(struct se_cmd *se_cmd)
292 return 0; /* XXX TBD */
295 void ft_new_cmd_failure(struct se_cmd *se_cmd)
298 printk(KERN_INFO "%s: se_cmd %p\n", __func__, se_cmd);
302 * FC sequence response handler for follow-on sequences (data) and aborts.
304 static void ft_recv_seq(struct fc_seq *sp, struct fc_frame *fp, void *arg)
306 struct ft_cmd *cmd = arg;
307 struct fc_frame_header *fh;
310 /* XXX need to find cmd if queued */
311 cmd->se_cmd.t_state = TRANSPORT_REMOVE;
313 transport_generic_free_cmd(&cmd->se_cmd, 0, 1, 0);
317 fh = fc_frame_header_get(fp);
319 switch (fh->fh_r_ctl) {
320 case FC_RCTL_DD_SOL_DATA: /* write data */
321 ft_recv_write_data(cmd, fp);
323 case FC_RCTL_DD_UNSOL_CTL: /* command */
324 case FC_RCTL_DD_SOL_CTL: /* transfer ready */
325 case FC_RCTL_DD_DATA_DESC: /* transfer ready */
327 printk(KERN_INFO "%s: unhandled frame r_ctl %x\n",
328 __func__, fh->fh_r_ctl);
330 transport_generic_free_cmd(&cmd->se_cmd, 0, 1, 0);
336 * Send a FCP response including SCSI status and optional FCP rsp_code.
337 * status is SAM_STAT_GOOD (zero) iff code is valid.
338 * This is used in error cases, such as allocation failures.
340 static void ft_send_resp_status(struct fc_lport *lport,
341 const struct fc_frame *rx_fp,
342 u32 status, enum fcp_resp_rsp_codes code)
346 const struct fc_frame_header *fh;
348 struct fcp_resp_with_ext *fcp;
349 struct fcp_resp_rsp_info *info;
351 fh = fc_frame_header_get(rx_fp);
352 FT_IO_DBG("FCP error response: did %x oxid %x status %x code %x\n",
353 ntoh24(fh->fh_s_id), ntohs(fh->fh_ox_id), status, code);
355 if (status == SAM_STAT_GOOD)
356 len += sizeof(*info);
357 fp = fc_frame_alloc(lport, len);
360 fcp = fc_frame_payload_get(fp, len);
362 fcp->resp.fr_status = status;
363 if (status == SAM_STAT_GOOD) {
364 fcp->ext.fr_rsp_len = htonl(sizeof(*info));
365 fcp->resp.fr_flags |= FCP_RSP_LEN_VAL;
366 info = (struct fcp_resp_rsp_info *)(fcp + 1);
367 info->rsp_code = code;
370 fc_fill_reply_hdr(fp, rx_fp, FC_RCTL_DD_CMD_STATUS, 0);
373 lport->tt.seq_send(lport, sp, fp);
375 lport->tt.frame_send(lport, fp);
379 * Send error or task management response.
380 * Always frees the cmd and associated state.
382 static void ft_send_resp_code(struct ft_cmd *cmd, enum fcp_resp_rsp_codes code)
384 ft_send_resp_status(cmd->sess->tport->lport,
385 cmd->req_frame, SAM_STAT_GOOD, code);
390 * Handle Task Management Request.
392 static void ft_send_tm(struct ft_cmd *cmd)
394 struct se_tmr_req *tmr;
395 struct fcp_cmnd *fcp;
396 struct ft_sess *sess;
399 fcp = fc_frame_payload_get(cmd->req_frame, sizeof(*fcp));
401 switch (fcp->fc_tm_flags) {
402 case FCP_TMF_LUN_RESET:
403 tm_func = TMR_LUN_RESET;
405 case FCP_TMF_TGT_RESET:
406 tm_func = TMR_TARGET_WARM_RESET;
408 case FCP_TMF_CLR_TASK_SET:
409 tm_func = TMR_CLEAR_TASK_SET;
411 case FCP_TMF_ABT_TASK_SET:
412 tm_func = TMR_ABORT_TASK_SET;
414 case FCP_TMF_CLR_ACA:
415 tm_func = TMR_CLEAR_ACA;
419 * FCP4r01 indicates having a combination of
420 * tm_flags set is invalid.
422 FT_TM_DBG("invalid FCP tm_flags %x\n", fcp->fc_tm_flags);
423 ft_send_resp_code(cmd, FCP_CMND_FIELDS_INVALID);
427 FT_TM_DBG("alloc tm cmd fn %d\n", tm_func);
428 tmr = core_tmr_alloc_req(&cmd->se_cmd, cmd, tm_func);
430 FT_TM_DBG("alloc failed\n");
431 ft_send_resp_code(cmd, FCP_TMF_FAILED);
434 cmd->se_cmd.se_tmr_req = tmr;
436 switch (fcp->fc_tm_flags) {
437 case FCP_TMF_LUN_RESET:
438 cmd->lun = scsilun_to_int((struct scsi_lun *)fcp->fc_lun);
439 if (transport_lookup_tmr_lun(&cmd->se_cmd, cmd->lun) < 0) {
441 * Make sure to clean up newly allocated TMR request
442 * since "unable to handle TMR request because failed
445 FT_TM_DBG("Failed to get LUN for TMR func %d, "
446 "se_cmd %p, unpacked_lun %d\n",
447 tm_func, &cmd->se_cmd, cmd->lun);
448 ft_dump_cmd(cmd, __func__);
450 transport_send_check_condition_and_sense(&cmd->se_cmd,
451 cmd->se_cmd.scsi_sense_reason, 0);
452 transport_generic_free_cmd(&cmd->se_cmd, 0, 1, 0);
457 case FCP_TMF_TGT_RESET:
458 case FCP_TMF_CLR_TASK_SET:
459 case FCP_TMF_ABT_TASK_SET:
460 case FCP_TMF_CLR_ACA:
465 transport_generic_handle_tmr(&cmd->se_cmd);
469 * Send status from completed task management request.
471 int ft_queue_tm_resp(struct se_cmd *se_cmd)
473 struct ft_cmd *cmd = container_of(se_cmd, struct ft_cmd, se_cmd);
474 struct se_tmr_req *tmr = se_cmd->se_tmr_req;
475 enum fcp_resp_rsp_codes code;
477 switch (tmr->response) {
478 case TMR_FUNCTION_COMPLETE:
481 case TMR_LUN_DOES_NOT_EXIST:
482 code = FCP_TMF_INVALID_LUN;
484 case TMR_FUNCTION_REJECTED:
485 code = FCP_TMF_REJECTED;
487 case TMR_TASK_DOES_NOT_EXIST:
488 case TMR_TASK_STILL_ALLEGIANT:
489 case TMR_TASK_FAILOVER_NOT_SUPPORTED:
490 case TMR_TASK_MGMT_FUNCTION_NOT_SUPPORTED:
491 case TMR_FUNCTION_AUTHORIZATION_FAILED:
493 code = FCP_TMF_FAILED;
496 FT_TM_DBG("tmr fn %d resp %d fcp code %d\n",
497 tmr->function, tmr->response, code);
498 ft_send_resp_code(cmd, code);
503 * Handle incoming FCP command.
505 static void ft_recv_cmd(struct ft_sess *sess, struct fc_frame *fp)
508 struct fc_lport *lport = sess->tport->lport;
510 cmd = kzalloc(sizeof(*cmd), GFP_ATOMIC);
514 cmd->seq = lport->tt.seq_assign(lport, fp);
519 cmd->req_frame = fp; /* hold frame during cmd */
520 ft_queue_cmd(sess, cmd);
524 FT_IO_DBG("cmd or seq allocation failure - sending BUSY\n");
525 ft_send_resp_status(lport, fp, SAM_STAT_BUSY, 0);
527 ft_sess_put(sess); /* undo get from lookup */
532 * Handle incoming FCP frame.
533 * Caller has verified that the frame is type FCP.
535 void ft_recv_req(struct ft_sess *sess, struct fc_frame *fp)
537 struct fc_frame_header *fh = fc_frame_header_get(fp);
539 switch (fh->fh_r_ctl) {
540 case FC_RCTL_DD_UNSOL_CMD: /* command */
541 ft_recv_cmd(sess, fp);
543 case FC_RCTL_DD_SOL_DATA: /* write data */
544 case FC_RCTL_DD_UNSOL_CTL:
545 case FC_RCTL_DD_SOL_CTL:
546 case FC_RCTL_DD_DATA_DESC: /* transfer ready */
547 case FC_RCTL_ELS4_REQ: /* SRR, perhaps */
549 printk(KERN_INFO "%s: unhandled frame r_ctl %x\n",
550 __func__, fh->fh_r_ctl);
552 ft_sess_put(sess); /* undo get from lookup */
558 * Send new command to target.
560 static void ft_send_cmd(struct ft_cmd *cmd)
562 struct fc_frame_header *fh = fc_frame_header_get(cmd->req_frame);
563 struct se_cmd *se_cmd;
564 struct fcp_cmnd *fcp;
570 fcp = fc_frame_payload_get(cmd->req_frame, sizeof(*fcp));
574 if (fcp->fc_flags & FCP_CFL_LEN_MASK)
575 goto err; /* not handling longer CDBs yet */
577 if (fcp->fc_tm_flags) {
578 task_attr = FCP_PTA_SIMPLE;
582 switch (fcp->fc_flags & (FCP_CFL_RDDATA | FCP_CFL_WRDATA)) {
587 data_dir = DMA_FROM_DEVICE;
590 data_dir = DMA_TO_DEVICE;
592 case FCP_CFL_WRDATA | FCP_CFL_RDDATA:
593 goto err; /* TBD not supported by tcm_fc yet */
596 * Locate the SAM Task Attr from fc_pri_ta
598 switch (fcp->fc_pri_ta & FCP_PTA_MASK) {
600 task_attr = MSG_HEAD_TAG;
602 case FCP_PTA_ORDERED:
603 task_attr = MSG_ORDERED_TAG;
606 task_attr = MSG_ACA_TAG;
608 case FCP_PTA_SIMPLE: /* Fallthrough */
610 task_attr = MSG_SIMPLE_TAG;
614 task_attr = fcp->fc_pri_ta & FCP_PTA_MASK;
615 data_len = ntohl(fcp->fc_dl);
616 cmd->cdb = fcp->fc_cdb;
619 se_cmd = &cmd->se_cmd;
621 * Initialize struct se_cmd descriptor from target_core_mod
624 transport_init_se_cmd(se_cmd, &ft_configfs->tf_ops, cmd->sess->se_sess,
625 data_len, data_dir, task_attr,
626 &cmd->ft_sense_buffer[0]);
628 * Check for FCP task management flags
630 if (fcp->fc_tm_flags) {
635 fc_seq_exch(cmd->seq)->lp->tt.seq_set_resp(cmd->seq, ft_recv_seq, cmd);
637 cmd->lun = scsilun_to_int((struct scsi_lun *)fcp->fc_lun);
638 ret = transport_lookup_cmd_lun(&cmd->se_cmd, cmd->lun);
640 ft_dump_cmd(cmd, __func__);
641 transport_send_check_condition_and_sense(&cmd->se_cmd,
642 cmd->se_cmd.scsi_sense_reason, 0);
646 ret = transport_generic_allocate_tasks(se_cmd, cmd->cdb);
648 FT_IO_DBG("r_ctl %x alloc task ret %d\n", fh->fh_r_ctl, ret);
649 ft_dump_cmd(cmd, __func__);
651 if (ret == -ENOMEM) {
652 transport_send_check_condition_and_sense(se_cmd,
653 TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE, 0);
654 transport_generic_free_cmd(se_cmd, 0, 1, 0);
657 if (ret == -EINVAL) {
658 if (se_cmd->se_cmd_flags & SCF_SCSI_RESERVATION_CONFLICT)
659 ft_queue_status(se_cmd);
661 transport_send_check_condition_and_sense(se_cmd,
662 se_cmd->scsi_sense_reason, 0);
663 transport_generic_free_cmd(se_cmd, 0, 1, 0);
666 transport_generic_handle_cdb(se_cmd);
670 ft_send_resp_code(cmd, FCP_CMND_FIELDS_INVALID);
674 * Handle request in the command thread.
676 static void ft_exec_req(struct ft_cmd *cmd)
678 FT_IO_DBG("cmd state %x\n", cmd->state);
679 switch (cmd->state) {
690 * Currently one thread per tpg.
692 int ft_thread(void *arg)
694 struct ft_tpg *tpg = arg;
695 struct se_queue_obj *qobj = &tpg->qobj;
699 set_user_nice(current, -20);
701 while (!kthread_should_stop()) {
702 ret = wait_event_interruptible(qobj->thread_wq,
703 atomic_read(&qobj->queue_cnt) || kthread_should_stop());
704 if (ret < 0 || kthread_should_stop())
706 cmd = ft_dequeue_cmd(qobj);