]> CyberLeo.Net >> Repos - FreeBSD/stable/10.git/blob - sys/cam/ctl/ctl_io.h
MFC r288020: Remove couple excess SGLIST I/O flags.
[FreeBSD/stable/10.git] / sys / cam / ctl / ctl_io.h
1 /*-
2  * Copyright (c) 2003 Silicon Graphics International Corp.
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions, and the following disclaimer,
10  *    without modification.
11  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
12  *    substantially similar to the "NO WARRANTY" disclaimer below
13  *    ("Disclaimer") and any redistribution must be conditioned upon
14  *    including a substantially similar Disclaimer requirement for further
15  *    binary redistribution.
16  *
17  * NO WARRANTY
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22  * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
26  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
27  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28  * POSSIBILITY OF SUCH DAMAGES.
29  *
30  * $Id: //depot/users/kenm/FreeBSD-test2/sys/cam/ctl/ctl_io.h#5 $
31  * $FreeBSD$
32  */
33 /*
34  * CAM Target Layer data movement structures/interface.
35  *
36  * Author: Ken Merry <ken@FreeBSD.org>
37  */
38
39 #ifndef _CTL_IO_H_
40 #define _CTL_IO_H_
41
42 #ifdef _CTL_C
43 #define EXTERN(__var,__val) __var = __val
44 #else
45 #define EXTERN(__var,__val) extern __var
46 #endif
47
48 #define CTL_MAX_CDBLEN  32
49 /*
50  * Uncomment this next line to enable printing out times for I/Os
51  * that take longer than CTL_TIME_IO_SECS seconds to get to the datamove
52  * and/or done stage.
53  */
54 #define CTL_TIME_IO
55 #ifdef  CTL_TIME_IO
56 #define CTL_TIME_IO_DEFAULT_SECS        90
57 EXTERN(int ctl_time_io_secs, CTL_TIME_IO_DEFAULT_SECS);
58 #endif
59
60 /*
61  * Uncomment this next line to enable the CTL I/O delay feature.  You
62  * can delay I/O at two different points -- datamove and done.  This is
63  * useful for diagnosing abort conditions (for hosts that send an abort on a
64  * timeout), and for determining how long a host's timeout is.
65  */
66 //#define       CTL_IO_DELAY
67
68 typedef enum {
69         CTL_STATUS_NONE,        /* No status */
70         CTL_SUCCESS,            /* Transaction completed successfully */
71         CTL_CMD_TIMEOUT,        /* Command timed out, shouldn't happen here */
72         CTL_SEL_TIMEOUT,        /* Selection timeout, shouldn't happen here */
73         CTL_ERROR,              /* General CTL error XXX expand on this? */
74         CTL_SCSI_ERROR,         /* SCSI error, look at status byte/sense data */
75         CTL_CMD_ABORTED,        /* Command aborted, don't return status */
76         CTL_STATUS_MASK = 0xfff,/* Mask off any status flags */
77         CTL_AUTOSENSE = 0x1000  /* Autosense performed */
78 } ctl_io_status;
79
80 /*
81  * WARNING:  Keep the data in/out/none flags where they are.  They're used
82  * in conjuction with ctl_cmd_flags.  See comment above ctl_cmd_flags
83  * definition in ctl_private.h.
84  */
85 typedef enum {
86         CTL_FLAG_NONE           = 0x00000000,   /* no flags */
87         CTL_FLAG_DATA_IN        = 0x00000001,   /* DATA IN */
88         CTL_FLAG_DATA_OUT       = 0x00000002,   /* DATA OUT */
89         CTL_FLAG_DATA_NONE      = 0x00000003,   /* no data */
90         CTL_FLAG_DATA_MASK      = 0x00000003,
91         CTL_FLAG_DO_AUTOSENSE   = 0x00000020,   /* grab sense info */
92         CTL_FLAG_USER_REQ       = 0x00000040,   /* request came from userland */
93         CTL_FLAG_ALLOCATED      = 0x00000100,   /* data space allocated */
94         CTL_FLAG_BLOCKED        = 0x00000200,   /* on the blocked queue */
95         CTL_FLAG_ABORT_STATUS   = 0x00000400,   /* return TASK ABORTED status */
96         CTL_FLAG_ABORT          = 0x00000800,   /* this I/O should be aborted */
97         CTL_FLAG_DMA_INPROG     = 0x00001000,   /* DMA in progress */
98         CTL_FLAG_DELAY_DONE     = 0x00004000,   /* delay injection done */
99         CTL_FLAG_INT_COPY       = 0x00008000,   /* internal copy, no done call*/
100         CTL_FLAG_SENT_2OTHER_SC = 0x00010000,
101         CTL_FLAG_FROM_OTHER_SC  = 0x00020000,
102         CTL_FLAG_IS_WAS_ON_RTR  = 0x00040000,   /* Don't rerun cmd on failover*/
103         CTL_FLAG_BUS_ADDR       = 0x00080000,   /* ctl_sglist contains BUS
104                                                    addresses, not virtual ones*/
105         CTL_FLAG_IO_CONT        = 0x00100000,   /* Continue I/O instead of
106                                                    completing */
107 #if 0
108         CTL_FLAG_ALREADY_DONE   = 0x00200000    /* I/O already completed */
109 #endif
110         CTL_FLAG_NO_DATAMOVE    = 0x00400000,
111         CTL_FLAG_DMA_QUEUED     = 0x00800000,   /* DMA queued but not started*/
112         CTL_FLAG_STATUS_QUEUED  = 0x01000000,   /* Status queued but not sent*/
113
114         CTL_FLAG_FAILOVER       = 0x04000000,   /* Killed by a failover */
115         CTL_FLAG_IO_ACTIVE      = 0x08000000,   /* I/O active on this SC */
116         CTL_FLAG_STATUS_SENT    = 0x10000000,   /* Status sent by datamove */
117         CTL_FLAG_SERSEQ_DONE    = 0x20000000    /* All storage I/O started */
118 } ctl_io_flags;
119
120
121 struct ctl_lba_len {
122         uint64_t lba;
123         uint32_t len;
124 };
125
126 struct ctl_lba_len_flags {
127         uint64_t lba;
128         uint32_t len;
129         uint32_t flags;
130 #define CTL_LLF_FUA     0x04000000
131 #define CTL_LLF_DPO     0x08000000
132 #define CTL_LLF_READ    0x10000000
133 #define CTL_LLF_WRITE   0x20000000
134 #define CTL_LLF_VERIFY  0x40000000
135 #define CTL_LLF_COMPARE 0x80000000
136 };
137
138 struct ctl_ptr_len_flags {
139         uint8_t *ptr;
140         uint32_t len;
141         uint32_t flags;
142 };
143
144 union ctl_priv {
145         uint8_t         bytes[sizeof(uint64_t) * 2];
146         uint64_t        integer;
147         void            *ptr;
148 };
149
150 /*
151  * Number of CTL private areas.
152  */
153 #define CTL_NUM_PRIV    6
154
155 /*
156  * Which private area are we using for a particular piece of data?
157  */
158 #define CTL_PRIV_LUN            0       /* CTL LUN pointer goes here */
159 #define CTL_PRIV_LBA_LEN        1       /* Decoded LBA/len for read/write*/
160 #define CTL_PRIV_MODEPAGE       1       /* Modepage info for config write */
161 #define CTL_PRIV_BACKEND        2       /* Reserved for block, RAIDCore */
162 #define CTL_PRIV_BACKEND_LUN    3       /* Backend LUN pointer */
163 #define CTL_PRIV_FRONTEND       4       /* Frontend storage */
164 #define CTL_PRIV_FRONTEND2      5       /* Another frontend storage */
165
166 #define CTL_INVALID_PORTNAME 0xFF
167 #define CTL_UNMAPPED_IID     0xFF
168
169 struct ctl_sg_entry {
170         void    *addr;
171         size_t  len;
172 };
173
174 typedef enum {
175         CTL_IO_NONE,
176         CTL_IO_SCSI,
177         CTL_IO_TASK,
178 } ctl_io_type;
179
180 struct ctl_nexus {
181         uint32_t initid;                /* Initiator ID */
182         uint32_t targ_port;             /* Target port, filled in by PORT */
183         uint32_t targ_lun;              /* Destination lun */
184         uint32_t targ_mapped_lun;       /* Destination lun CTL-wide */
185 };
186
187 typedef enum {
188         CTL_MSG_SERIALIZE,
189         CTL_MSG_R2R,
190         CTL_MSG_FINISH_IO,
191         CTL_MSG_BAD_JUJU,
192         CTL_MSG_MANAGE_TASKS,
193         CTL_MSG_PERS_ACTION,
194         CTL_MSG_DATAMOVE,
195         CTL_MSG_DATAMOVE_DONE,
196         CTL_MSG_UA,                     /* Set/clear UA on secondary. */
197         CTL_MSG_PORT_SYNC,              /* Information about port. */
198         CTL_MSG_LUN_SYNC,               /* Information about LUN. */
199         CTL_MSG_IID_SYNC,               /* Information about initiator. */
200         CTL_MSG_FAILOVER                /* Fake, never sent though the wire */
201 } ctl_msg_type;
202
203 struct ctl_scsiio;
204
205 struct ctl_io_hdr {
206         uint32_t          version;      /* interface version XXX */
207         ctl_io_type       io_type;      /* task I/O, SCSI I/O, etc. */
208         ctl_msg_type      msg_type;
209         struct ctl_nexus  nexus;        /* Initiator, port, target, lun */
210         uint32_t          iid_indx;     /* the index into the iid mapping */
211         uint32_t          flags;        /* transaction flags */
212         uint32_t          status;       /* transaction status */
213         uint32_t          port_status;  /* trans status, set by PORT, 0 = good*/
214         uint32_t          timeout;      /* timeout in ms */
215         uint32_t          retries;      /* retry count */
216 #ifdef CTL_IO_DELAY
217         struct callout    delay_callout;
218 #endif /* CTL_IO_DELAY */
219 #ifdef CTL_TIME_IO
220         time_t            start_time;   /* I/O start time */
221         struct bintime    start_bt;     /* Timer start ticks */
222         struct bintime    dma_start_bt; /* DMA start ticks */
223         struct bintime    dma_bt;       /* DMA total ticks */
224         uint32_t          num_dmas;     /* Number of DMAs */
225 #endif /* CTL_TIME_IO */
226         union ctl_io      *original_sc;
227         union ctl_io      *serializing_sc;
228         void              *pool;        /* I/O pool */
229         union ctl_priv    ctl_private[CTL_NUM_PRIV];/* CTL private area */
230         struct ctl_sg_entry *remote_sglist;
231         struct ctl_sg_entry *local_sglist;
232         STAILQ_ENTRY(ctl_io_hdr) links; /* linked list pointer */
233         TAILQ_ENTRY(ctl_io_hdr) ooa_links;
234         TAILQ_ENTRY(ctl_io_hdr) blocked_links;
235 };
236
237 typedef enum {
238         CTL_TAG_UNTAGGED,
239         CTL_TAG_SIMPLE,
240         CTL_TAG_ORDERED,
241         CTL_TAG_HEAD_OF_QUEUE,
242         CTL_TAG_ACA
243 } ctl_tag_type;
244
245 union ctl_io;
246
247 /*
248  * SCSI passthrough I/O structure for the CAM Target Layer.  Note
249  * that some of these fields are here for completeness, but they aren't
250  * used in the CTL implementation.  e.g., timeout and retries won't be
251  * used.
252  *
253  * Note:  Make sure the io_hdr is *always* the first element in this
254  * structure.
255  */
256 struct ctl_scsiio {
257         struct ctl_io_hdr io_hdr;       /* common to all I/O types */
258
259         /*
260          * The ext_* fields are generally intended for frontend use; CTL itself
261          * doesn't modify or use them.
262          */
263         uint32_t   ext_sg_entries;      /* 0 = no S/G list, > 0 = num entries */
264         uint8_t    *ext_data_ptr;       /* data buffer or S/G list */
265         uint32_t   ext_data_len;        /* Data transfer length */
266         uint32_t   ext_data_filled;     /* Amount of data filled so far */
267
268         /*
269          * The number of scatter/gather entries in the list pointed to
270          * by kern_data_ptr.  0 means there is no list, just a data pointer.
271          */
272         uint32_t   kern_sg_entries;
273
274         uint32_t   rem_sg_entries;      /* Unused. */
275
276         /*
277          * The data pointer or a pointer to the scatter/gather list.
278          */
279         uint8_t    *kern_data_ptr;
280
281         /*
282          * Length of the data buffer or scatter/gather list.  It's also
283          * the length of this particular piece of the data transfer,
284          * ie. number of bytes expected to be transferred by the current
285          * invocation of frontend's datamove() callback.  It's always
286          * less than or equal to kern_total_len.
287          */
288         uint32_t   kern_data_len;
289
290         /*
291          * Total length of data to be transferred during this particular
292          * SCSI command, as decoded from SCSI CDB.
293          */
294         uint32_t   kern_total_len;
295
296         /*
297          * Amount of data left after the current data transfer.
298          */
299         uint32_t   kern_data_resid;
300
301         /*
302          * Byte offset of this transfer, equal to the amount of data
303          * already transferred for this SCSI command during previous
304          * datamove() invocations.
305          */
306         uint32_t   kern_rel_offset;
307
308         struct     scsi_sense_data sense_data;  /* sense data */
309         uint8_t    sense_len;           /* Returned sense length */
310         uint8_t    scsi_status;         /* SCSI status byte */
311         uint8_t    sense_residual;      /* Unused. */
312         uint32_t   residual;            /* data residual length */
313         uint32_t   tag_num;             /* tag number */
314         ctl_tag_type tag_type;          /* simple, ordered, head of queue,etc.*/
315         uint8_t    cdb_len;             /* CDB length */
316         uint8_t    cdb[CTL_MAX_CDBLEN]; /* CDB */
317         int        (*be_move_done)(union ctl_io *io); /* called by fe */
318         int        (*io_cont)(union ctl_io *io); /* to continue processing */
319 };
320
321 typedef enum {
322         CTL_TASK_ABORT_TASK,
323         CTL_TASK_ABORT_TASK_SET,
324         CTL_TASK_CLEAR_ACA,
325         CTL_TASK_CLEAR_TASK_SET,
326         CTL_TASK_I_T_NEXUS_RESET,
327         CTL_TASK_LUN_RESET,
328         CTL_TASK_TARGET_RESET,
329         CTL_TASK_BUS_RESET,
330         CTL_TASK_PORT_LOGIN,
331         CTL_TASK_PORT_LOGOUT,
332         CTL_TASK_QUERY_TASK,
333         CTL_TASK_QUERY_TASK_SET,
334         CTL_TASK_QUERY_ASYNC_EVENT
335 } ctl_task_type;
336
337 typedef enum {
338         CTL_TASK_FUNCTION_COMPLETE,
339         CTL_TASK_FUNCTION_SUCCEEDED,
340         CTL_TASK_FUNCTION_REJECTED,
341         CTL_TASK_LUN_DOES_NOT_EXIST,
342         CTL_TASK_FUNCTION_NOT_SUPPORTED
343 } ctl_task_status;
344
345 /*
346  * Task management I/O structure.  Aborts, bus resets, etc., are sent using
347  * this structure.
348  *
349  * Note:  Make sure the io_hdr is *always* the first element in this
350  * structure.
351  */
352 struct ctl_taskio {
353         struct ctl_io_hdr       io_hdr;      /* common to all I/O types */
354         ctl_task_type           task_action; /* Target Reset, Abort, etc.  */
355         uint32_t                tag_num;     /* tag number */
356         ctl_tag_type            tag_type;    /* simple, ordered, etc. */
357         uint8_t                 task_status; /* Complete, Succeeded, etc. */
358         uint8_t                 task_resp[3];/* Response information */
359 };
360
361 typedef enum {
362         CTL_PR_REG_KEY,
363         CTL_PR_UNREG_KEY,
364         CTL_PR_PREEMPT,
365         CTL_PR_CLEAR,
366         CTL_PR_RESERVE,
367         CTL_PR_RELEASE
368 } ctl_pr_action;
369
370 /*
371  * The PR info is specifically for sending Persistent Reserve actions
372  * to the other SC which it must also act on.
373  *
374  * Note:  Make sure the io_hdr is *always* the first element in this
375  * structure.
376  */
377 struct ctl_pr_info {
378         ctl_pr_action        action;
379         uint8_t              sa_res_key[8];
380         uint8_t              res_type;
381         uint32_t             residx;
382 };
383
384 struct ctl_ha_msg_hdr {
385         ctl_msg_type            msg_type;
386         uint32_t                status;      /* transaction status */
387         union ctl_io            *original_sc;
388         union ctl_io            *serializing_sc;
389         struct ctl_nexus        nexus;       /* Initiator, port, target, lun */
390 };
391
392 #define CTL_HA_MAX_SG_ENTRIES   16
393 #define CTL_HA_DATAMOVE_SEGMENT 131072
394
395 /*
396  * Used for CTL_MSG_PERS_ACTION.
397  */
398 struct ctl_ha_msg_pr {
399         struct ctl_ha_msg_hdr   hdr;
400         struct ctl_pr_info      pr_info;
401 };
402
403 /*
404  * Used for CTL_MSG_UA.
405  */
406 struct ctl_ha_msg_ua {
407         struct ctl_ha_msg_hdr   hdr;
408         int                     ua_all;
409         int                     ua_set;
410         int                     ua_type;
411         uint8_t                 ua_info[8];
412 };
413
414 /*
415  * The S/G handling here is a little different than the standard ctl_scsiio
416  * structure, because we can't pass data by reference in between controllers.
417  * The S/G list in the ctl_scsiio struct is normally passed in the
418  * kern_data_ptr field.  So kern_sg_entries here will always be non-zero,
419  * even if there is only one entry.
420  *
421  * Used for CTL_MSG_DATAMOVE.
422  */
423 struct ctl_ha_msg_dt {
424         struct ctl_ha_msg_hdr   hdr;
425         ctl_io_flags            flags;  /* Only I/O flags are used here */
426         uint32_t                sg_sequence;     /* S/G portion number  */
427         uint8_t                 sg_last;         /* last S/G batch = 1 */
428         uint32_t                sent_sg_entries; /* previous S/G count */
429         uint32_t                cur_sg_entries;  /* current S/G entries */
430         uint32_t                kern_sg_entries; /* total S/G entries */
431         uint32_t                kern_data_len;   /* Length of this S/G list */
432         uint32_t                kern_total_len;  /* Total length of this
433                                                     transaction */
434         uint32_t                kern_data_resid; /* Length left to transfer
435                                                     after this*/
436         uint32_t                kern_rel_offset; /* Byte Offset of this
437                                                     transfer */
438         struct ctl_sg_entry     sg_list[CTL_HA_MAX_SG_ENTRIES];
439 };
440
441 /*
442  * Used for CTL_MSG_SERIALIZE, CTL_MSG_FINISH_IO, CTL_MSG_BAD_JUJU.
443  */
444 struct ctl_ha_msg_scsi {
445         struct ctl_ha_msg_hdr   hdr;
446         uint32_t                tag_num;     /* tag number */
447         ctl_tag_type            tag_type;    /* simple, ordered, etc. */
448         uint8_t                 cdb[CTL_MAX_CDBLEN];    /* CDB */
449         uint8_t                 cdb_len;        /* CDB length */
450         uint8_t                 scsi_status; /* SCSI status byte */
451         uint8_t                 sense_len;   /* Returned sense length */
452         uint8_t                 sense_residual; /* sense residual length */
453         uint32_t                residual;    /* data residual length */
454         uint32_t                fetd_status; /* trans status, set by FETD,
455                                                 0 = good*/
456         struct scsi_sense_data  sense_data;  /* sense data */
457 };
458
459 /* 
460  * Used for CTL_MSG_MANAGE_TASKS.
461  */
462 struct ctl_ha_msg_task {
463         struct ctl_ha_msg_hdr   hdr;
464         ctl_task_type           task_action; /* Target Reset, Abort, etc.  */
465         uint32_t                tag_num;     /* tag number */
466         ctl_tag_type            tag_type;    /* simple, ordered, etc. */
467 };
468
469 /*
470  * Used for CTL_MSG_PORT_SYNC.
471  */
472 struct ctl_ha_msg_port {
473         struct ctl_ha_msg_hdr   hdr;
474         int                     port_type;
475         int                     physical_port;
476         int                     virtual_port;
477         int                     status;
478         int                     name_len;
479         int                     lun_map_len;
480         int                     port_devid_len;
481         int                     target_devid_len;
482         int                     init_devid_len;
483         uint8_t                 data[];
484 };
485
486 /*
487  * Used for CTL_MSG_LUN_SYNC.
488  */
489 struct ctl_ha_msg_lun {
490         struct ctl_ha_msg_hdr   hdr;
491         int                     flags;
492         unsigned int            pr_generation;
493         uint32_t                pr_res_idx;
494         uint8_t                 pr_res_type;
495         int                     lun_devid_len;
496         int                     pr_key_count;
497         uint8_t                 data[];
498 };
499
500 struct ctl_ha_msg_lun_pr_key {
501         uint32_t                pr_iid;
502         uint64_t                pr_key;
503 };
504
505 /*
506  * Used for CTL_MSG_IID_SYNC.
507  */
508 struct ctl_ha_msg_iid {
509         struct ctl_ha_msg_hdr   hdr;
510         int                     in_use;
511         int                     name_len;
512         uint64_t                wwpn;
513         uint8_t                 data[];
514 };
515
516 union ctl_ha_msg {
517         struct ctl_ha_msg_hdr   hdr;
518         struct ctl_ha_msg_task  task;
519         struct ctl_ha_msg_scsi  scsi;
520         struct ctl_ha_msg_dt    dt;
521         struct ctl_ha_msg_pr    pr;
522         struct ctl_ha_msg_ua    ua;
523         struct ctl_ha_msg_port  port;
524         struct ctl_ha_msg_lun   lun;
525         struct ctl_ha_msg_iid   iid;
526 };
527
528
529 struct ctl_prio {
530         struct ctl_io_hdr  io_hdr;
531         struct ctl_ha_msg_pr pr_msg;
532 };
533
534
535
536 union ctl_io {
537         struct ctl_io_hdr io_hdr;       /* common to all I/O types */
538         struct ctl_scsiio scsiio;       /* Normal SCSI commands */
539         struct ctl_taskio taskio;       /* SCSI task management/reset */
540         struct ctl_prio   presio;       /* update per. res info on other SC */
541 };
542
543 #ifdef _KERNEL
544
545 union ctl_io *ctl_alloc_io(void *pool_ref);
546 union ctl_io *ctl_alloc_io_nowait(void *pool_ref);
547 void ctl_free_io(union ctl_io *io);
548 void ctl_zero_io(union ctl_io *io);
549 void ctl_copy_io(union ctl_io *src, union ctl_io *dest);
550
551 #endif /* _KERNEL */
552
553 #endif  /* _CTL_IO_H_ */
554
555 /*
556  * vim: ts=8
557  */