2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2003 Silicon Graphics International Corp.
5 * Copyright (c) 2014-2015 Alexander Motin <mav@FreeBSD.org>
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions, and the following disclaimer,
13 * without modification.
14 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
15 * substantially similar to the "NO WARRANTY" disclaimer below
16 * ("Disclaimer") and any redistribution must be conditioned upon
17 * including a substantially similar Disclaimer requirement for further
18 * binary redistribution.
21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
24 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
29 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
30 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
31 * POSSIBILITY OF SUCH DAMAGES.
33 * $Id: //depot/users/kenm/FreeBSD-test2/sys/cam/ctl/ctl_io.h#5 $
37 * CAM Target Layer data movement structures/interface.
39 * Author: Ken Merry <ken@FreeBSD.org>
45 #define CTL_MAX_CDBLEN 32
47 * Uncomment this next line to enable printing out times for I/Os
48 * that take longer than CTL_TIME_IO_SECS seconds to get to the datamove
53 #define CTL_TIME_IO_DEFAULT_SECS 90
57 * Uncomment this next line to enable the CTL I/O delay feature. You
58 * can delay I/O at two different points -- datamove and done. This is
59 * useful for diagnosing abort conditions (for hosts that send an abort on a
60 * timeout), and for determining how long a host's timeout is.
62 //#define CTL_IO_DELAY
65 CTL_STATUS_NONE, /* No status */
66 CTL_SUCCESS, /* Transaction completed successfully */
67 CTL_CMD_TIMEOUT, /* Command timed out, shouldn't happen here */
68 CTL_SEL_TIMEOUT, /* Selection timeout, shouldn't happen here */
69 CTL_ERROR, /* General CTL error XXX expand on this? */
70 CTL_SCSI_ERROR, /* SCSI error, look at status byte/sense data */
71 CTL_CMD_ABORTED, /* Command aborted, don't return status */
72 CTL_STATUS_MASK = 0xfff,/* Mask off any status flags */
73 CTL_AUTOSENSE = 0x1000 /* Autosense performed */
77 * WARNING: Keep the data in/out/none flags where they are. They're used
78 * in conjunction with ctl_cmd_flags. See comment above ctl_cmd_flags
79 * definition in ctl_private.h.
82 CTL_FLAG_NONE = 0x00000000, /* no flags */
83 CTL_FLAG_DATA_IN = 0x00000001, /* DATA IN */
84 CTL_FLAG_DATA_OUT = 0x00000002, /* DATA OUT */
85 CTL_FLAG_DATA_NONE = 0x00000003, /* no data */
86 CTL_FLAG_DATA_MASK = 0x00000003,
87 CTL_FLAG_DO_AUTOSENSE = 0x00000020, /* grab sense info */
88 CTL_FLAG_USER_REQ = 0x00000040, /* request came from userland */
89 CTL_FLAG_ALLOCATED = 0x00000100, /* data space allocated */
90 CTL_FLAG_BLOCKED = 0x00000200, /* on the blocked queue */
91 CTL_FLAG_ABORT_STATUS = 0x00000400, /* return TASK ABORTED status */
92 CTL_FLAG_ABORT = 0x00000800, /* this I/O should be aborted */
93 CTL_FLAG_DMA_INPROG = 0x00001000, /* DMA in progress */
94 CTL_FLAG_DELAY_DONE = 0x00004000, /* delay injection done */
95 CTL_FLAG_INT_COPY = 0x00008000, /* internal copy, no done call*/
96 CTL_FLAG_SENT_2OTHER_SC = 0x00010000,
97 CTL_FLAG_FROM_OTHER_SC = 0x00020000,
98 CTL_FLAG_IS_WAS_ON_RTR = 0x00040000, /* Don't rerun cmd on failover*/
99 CTL_FLAG_BUS_ADDR = 0x00080000, /* ctl_sglist contains BUS
100 addresses, not virtual ones*/
101 CTL_FLAG_IO_CONT = 0x00100000, /* Continue I/O instead of
104 CTL_FLAG_ALREADY_DONE = 0x00200000 /* I/O already completed */
106 CTL_FLAG_NO_DATAMOVE = 0x00400000,
107 CTL_FLAG_DMA_QUEUED = 0x00800000, /* DMA queued but not started*/
108 CTL_FLAG_STATUS_QUEUED = 0x01000000, /* Status queued but not sent*/
110 CTL_FLAG_FAILOVER = 0x04000000, /* Killed by a failover */
111 CTL_FLAG_IO_ACTIVE = 0x08000000, /* I/O active on this SC */
112 CTL_FLAG_STATUS_SENT = 0x10000000, /* Status sent by datamove */
113 CTL_FLAG_SERSEQ_DONE = 0x20000000 /* All storage I/O started */
122 struct ctl_lba_len_flags {
126 #define CTL_LLF_FUA 0x04000000
127 #define CTL_LLF_DPO 0x08000000
128 #define CTL_LLF_READ 0x10000000
129 #define CTL_LLF_WRITE 0x20000000
130 #define CTL_LLF_VERIFY 0x40000000
131 #define CTL_LLF_COMPARE 0x80000000
134 struct ctl_ptr_len_flags {
141 uint8_t bytes[sizeof(uint64_t) * 2];
143 uint64_t integers[2];
149 * Number of CTL private areas.
151 #define CTL_NUM_PRIV 6
154 * Which private area are we using for a particular piece of data?
156 #define CTL_PRIV_LUN 0 /* CTL LUN pointer goes here */
157 #define CTL_PRIV_LBA_LEN 1 /* Decoded LBA/len for read/write*/
158 #define CTL_PRIV_MODEPAGE 1 /* Modepage info for config write */
159 #define CTL_PRIV_BACKEND 2 /* Reserved for block, RAIDCore */
160 #define CTL_PRIV_BACKEND_LUN 3 /* Backend LUN pointer */
161 #define CTL_PRIV_FRONTEND 4 /* Frontend storage */
162 #define CTL_PRIV_FRONTEND2 5 /* Another frontend storage */
164 #define CTL_LUN(io) ((io)->io_hdr.ctl_private[CTL_PRIV_LUN].ptrs[0])
165 #define CTL_SOFTC(io) ((io)->io_hdr.ctl_private[CTL_PRIV_LUN].ptrs[1])
166 #define CTL_BACKEND_LUN(io) ((io)->io_hdr.ctl_private[CTL_PRIV_BACKEND_LUN].ptrs[0])
167 #define CTL_PORT(io) (((struct ctl_softc *)CTL_SOFTC(io))-> \
168 ctl_ports[(io)->io_hdr.nexus.targ_port])
171 * These are used only on Originating SC in XFER mode, where requests don't
172 * ever reach backends, so we can reuse backend's private storage.
174 #define CTL_RSGL(io) ((io)->io_hdr.ctl_private[CTL_PRIV_BACKEND].ptrs[0])
175 #define CTL_LSGL(io) ((io)->io_hdr.ctl_private[CTL_PRIV_BACKEND].ptrs[1])
176 #define CTL_RSGLT(io) ((struct ctl_sg_entry *)CTL_RSGL(io))
177 #define CTL_LSGLT(io) ((struct ctl_sg_entry *)CTL_LSGL(io))
179 #define CTL_INVALID_PORTNAME 0xFF
180 #define CTL_UNMAPPED_IID 0xFF
182 struct ctl_sg_entry {
194 uint32_t initid; /* Initiator ID */
195 uint32_t targ_port; /* Target port, filled in by PORT */
196 uint32_t targ_lun; /* Destination lun */
197 uint32_t targ_mapped_lun; /* Destination lun CTL-wide */
205 CTL_MSG_MANAGE_TASKS,
208 CTL_MSG_DATAMOVE_DONE,
209 CTL_MSG_UA, /* Set/clear UA on secondary. */
210 CTL_MSG_PORT_SYNC, /* Information about port. */
211 CTL_MSG_LUN_SYNC, /* Information about LUN. */
212 CTL_MSG_IID_SYNC, /* Information about initiator. */
213 CTL_MSG_LOGIN, /* Information about HA peer. */
214 CTL_MSG_MODE_SYNC, /* Mode page current content. */
215 CTL_MSG_FAILOVER /* Fake, never sent though the wire */
221 uint32_t version; /* interface version XXX */
222 ctl_io_type io_type; /* task I/O, SCSI I/O, etc. */
223 ctl_msg_type msg_type;
224 struct ctl_nexus nexus; /* Initiator, port, target, lun */
225 uint32_t iid_indx; /* the index into the iid mapping */
226 uint32_t flags; /* transaction flags */
227 uint32_t status; /* transaction status */
228 uint32_t port_status; /* trans status, set by PORT, 0 = good*/
229 uint32_t timeout; /* timeout in ms */
230 uint32_t retries; /* retry count */
232 struct callout delay_callout;
233 #endif /* CTL_IO_DELAY */
235 time_t start_time; /* I/O start time */
236 struct bintime start_bt; /* Timer start ticks */
237 struct bintime dma_start_bt; /* DMA start ticks */
238 struct bintime dma_bt; /* DMA total ticks */
239 #endif /* CTL_TIME_IO */
240 uint32_t num_dmas; /* Number of DMAs */
241 union ctl_io *remote_io; /* I/O counterpart on remote HA side */
243 void *pool; /* I/O pool */
244 union ctl_priv ctl_private[CTL_NUM_PRIV];/* CTL private area */
247 STAILQ_ENTRY(ctl_io_hdr) links; /* linked list pointer */
248 TAILQ_ENTRY(ctl_io_hdr) ooa_links;
249 TAILQ_ENTRY(ctl_io_hdr) blocked_links;
256 CTL_TAG_HEAD_OF_QUEUE,
263 * SCSI passthrough I/O structure for the CAM Target Layer. Note
264 * that some of these fields are here for completeness, but they aren't
265 * used in the CTL implementation. e.g., timeout and retries won't be
268 * Note: Make sure the io_hdr is *always* the first element in this
272 struct ctl_io_hdr io_hdr; /* common to all I/O types */
275 * The ext_* fields are generally intended for frontend use; CTL itself
276 * doesn't modify or use them.
278 uint32_t ext_sg_entries; /* 0 = no S/G list, > 0 = num entries */
279 uint8_t *ext_data_ptr; /* data buffer or S/G list */
280 uint32_t ext_data_len; /* Data transfer length */
281 uint32_t ext_data_filled; /* Amount of data filled so far */
284 * The number of scatter/gather entries in the list pointed to
285 * by kern_data_ptr. 0 means there is no list, just a data pointer.
287 uint32_t kern_sg_entries;
289 uint32_t rem_sg_entries; /* Unused. */
292 * The data pointer or a pointer to the scatter/gather list.
294 uint8_t *kern_data_ptr;
297 * Length of the data buffer or scatter/gather list. It's also
298 * the length of this particular piece of the data transfer,
299 * ie. number of bytes expected to be transferred by the current
300 * invocation of frontend's datamove() callback. It's always
301 * less than or equal to kern_total_len.
303 uint32_t kern_data_len;
306 * Total length of data to be transferred during this particular
307 * SCSI command, as decoded from SCSI CDB.
309 uint32_t kern_total_len;
312 * Amount of data left after the current data transfer.
314 uint32_t kern_data_resid;
317 * Byte offset of this transfer, equal to the amount of data
318 * already transferred for this SCSI command during previous
319 * datamove() invocations.
321 uint32_t kern_rel_offset;
323 struct scsi_sense_data sense_data; /* sense data */
324 uint8_t sense_len; /* Returned sense length */
325 uint8_t scsi_status; /* SCSI status byte */
326 uint8_t sense_residual; /* Unused. */
327 uint32_t residual; /* Unused */
328 uint32_t tag_num; /* tag number */
329 ctl_tag_type tag_type; /* simple, ordered, head of queue,etc.*/
330 uint8_t cdb_len; /* CDB length */
331 uint8_t cdb[CTL_MAX_CDBLEN]; /* CDB */
332 int (*be_move_done)(union ctl_io *io); /* called by fe */
333 int (*io_cont)(union ctl_io *io); /* to continue processing */
338 CTL_TASK_ABORT_TASK_SET,
340 CTL_TASK_CLEAR_TASK_SET,
341 CTL_TASK_I_T_NEXUS_RESET,
343 CTL_TASK_TARGET_RESET,
346 CTL_TASK_PORT_LOGOUT,
348 CTL_TASK_QUERY_TASK_SET,
349 CTL_TASK_QUERY_ASYNC_EVENT
353 CTL_TASK_FUNCTION_COMPLETE,
354 CTL_TASK_FUNCTION_SUCCEEDED,
355 CTL_TASK_FUNCTION_REJECTED,
356 CTL_TASK_LUN_DOES_NOT_EXIST,
357 CTL_TASK_FUNCTION_NOT_SUPPORTED
361 * Task management I/O structure. Aborts, bus resets, etc., are sent using
364 * Note: Make sure the io_hdr is *always* the first element in this
368 struct ctl_io_hdr io_hdr; /* common to all I/O types */
369 ctl_task_type task_action; /* Target Reset, Abort, etc. */
370 uint32_t tag_num; /* tag number */
371 ctl_tag_type tag_type; /* simple, ordered, etc. */
372 uint8_t task_status; /* Complete, Succeeded, etc. */
373 uint8_t task_resp[3];/* Response information */
380 #define CTL_HA_VERSION 3
383 * Used for CTL_MSG_LOGIN.
385 struct ctl_ha_msg_login {
386 ctl_msg_type msg_type;
392 int max_init_per_port;
405 * The PR info is specifically for sending Persistent Reserve actions
406 * to the other SC which it must also act on.
408 * Note: Make sure the io_hdr is *always* the first element in this
412 ctl_pr_action action;
413 uint8_t sa_res_key[8];
418 struct ctl_ha_msg_hdr {
419 ctl_msg_type msg_type;
420 uint32_t status; /* transaction status */
421 union ctl_io *original_sc;
422 union ctl_io *serializing_sc;
423 struct ctl_nexus nexus; /* Initiator, port, target, lun */
426 #define CTL_HA_MAX_SG_ENTRIES 16
427 #define CTL_HA_DATAMOVE_SEGMENT 131072
430 * Used for CTL_MSG_PERS_ACTION.
432 struct ctl_ha_msg_pr {
433 struct ctl_ha_msg_hdr hdr;
434 struct ctl_pr_info pr_info;
438 * Used for CTL_MSG_UA.
440 struct ctl_ha_msg_ua {
441 struct ctl_ha_msg_hdr hdr;
449 * The S/G handling here is a little different than the standard ctl_scsiio
450 * structure, because we can't pass data by reference in between controllers.
451 * The S/G list in the ctl_scsiio struct is normally passed in the
452 * kern_data_ptr field. So kern_sg_entries here will always be non-zero,
453 * even if there is only one entry.
455 * Used for CTL_MSG_DATAMOVE.
457 struct ctl_ha_msg_dt {
458 struct ctl_ha_msg_hdr hdr;
459 ctl_io_flags flags; /* Only I/O flags are used here */
460 uint32_t sg_sequence; /* S/G portion number */
461 uint8_t sg_last; /* last S/G batch = 1 */
462 uint32_t sent_sg_entries; /* previous S/G count */
463 uint32_t cur_sg_entries; /* current S/G entries */
464 uint32_t kern_sg_entries; /* total S/G entries */
465 uint32_t kern_data_len; /* Length of this S/G list */
466 uint32_t kern_total_len; /* Total length of this
468 uint32_t kern_data_resid; /* Length left to transfer
470 uint32_t kern_rel_offset; /* Byte Offset of this
472 struct ctl_sg_entry sg_list[CTL_HA_MAX_SG_ENTRIES];
476 * Used for CTL_MSG_SERIALIZE, CTL_MSG_FINISH_IO, CTL_MSG_BAD_JUJU,
477 * and CTL_MSG_DATAMOVE_DONE.
479 struct ctl_ha_msg_scsi {
480 struct ctl_ha_msg_hdr hdr;
481 uint32_t tag_num; /* tag number */
482 ctl_tag_type tag_type; /* simple, ordered, etc. */
483 uint8_t cdb[CTL_MAX_CDBLEN]; /* CDB */
484 uint8_t cdb_len; /* CDB length */
485 uint8_t scsi_status; /* SCSI status byte */
486 uint8_t sense_len; /* Returned sense length */
487 uint32_t port_status; /* trans status, set by FETD,
489 uint32_t kern_data_resid; /* for DATAMOVE_DONE */
490 struct scsi_sense_data sense_data; /* sense data */
494 * Used for CTL_MSG_MANAGE_TASKS.
496 struct ctl_ha_msg_task {
497 struct ctl_ha_msg_hdr hdr;
498 ctl_task_type task_action; /* Target Reset, Abort, etc. */
499 uint32_t tag_num; /* tag number */
500 ctl_tag_type tag_type; /* simple, ordered, etc. */
504 * Used for CTL_MSG_PORT_SYNC.
506 struct ctl_ha_msg_port {
507 struct ctl_ha_msg_hdr hdr;
515 int target_devid_len;
521 * Used for CTL_MSG_LUN_SYNC.
523 struct ctl_ha_msg_lun {
524 struct ctl_ha_msg_hdr hdr;
526 unsigned int pr_generation;
534 struct ctl_ha_msg_lun_pr_key {
540 * Used for CTL_MSG_IID_SYNC.
542 struct ctl_ha_msg_iid {
543 struct ctl_ha_msg_hdr hdr;
551 * Used for CTL_MSG_MODE_SYNC.
553 struct ctl_ha_msg_mode {
554 struct ctl_ha_msg_hdr hdr;
562 struct ctl_ha_msg_hdr hdr;
563 struct ctl_ha_msg_task task;
564 struct ctl_ha_msg_scsi scsi;
565 struct ctl_ha_msg_dt dt;
566 struct ctl_ha_msg_pr pr;
567 struct ctl_ha_msg_ua ua;
568 struct ctl_ha_msg_port port;
569 struct ctl_ha_msg_lun lun;
570 struct ctl_ha_msg_iid iid;
571 struct ctl_ha_msg_login login;
572 struct ctl_ha_msg_mode mode;
576 struct ctl_io_hdr io_hdr;
577 struct ctl_ha_msg_pr pr_msg;
581 struct ctl_io_hdr io_hdr; /* common to all I/O types */
582 struct ctl_scsiio scsiio; /* Normal SCSI commands */
583 struct ctl_taskio taskio; /* SCSI task management/reset */
584 struct ctl_prio presio; /* update per. res info on other SC */
589 union ctl_io *ctl_alloc_io(void *pool_ref);
590 union ctl_io *ctl_alloc_io_nowait(void *pool_ref);
591 void ctl_free_io(union ctl_io *io);
592 void ctl_zero_io(union ctl_io *io);
596 #endif /* _CTL_IO_H_ */