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_KDPTR_SGLIST   = 0x00000008,   /* kern_data_ptr is S/G list*/
  92         CTL_FLAG_EDPTR_SGLIST   = 0x00000010,   /* ext_data_ptr is S/G list */
  93         CTL_FLAG_DO_AUTOSENSE   = 0x00000020,   /* grab sense info */
  94         CTL_FLAG_USER_REQ       = 0x00000040,   /* request came from userland */
  95         CTL_FLAG_ALLOCATED      = 0x00000100,   /* data space allocated */
  96         CTL_FLAG_BLOCKED        = 0x00000200,   /* on the blocked queue */
  97         CTL_FLAG_ABORT_STATUS   = 0x00000400,   /* return TASK ABORTED status */
  98         CTL_FLAG_ABORT          = 0x00000800,   /* this I/O should be aborted */
  99         CTL_FLAG_DMA_INPROG     = 0x00001000,   /* DMA in progress */
 100         CTL_FLAG_DELAY_DONE     = 0x00004000,   /* delay injection done */
 101         CTL_FLAG_INT_COPY       = 0x00008000,   /* internal copy, no done call*/
 102         CTL_FLAG_SENT_2OTHER_SC = 0x00010000,
 103         CTL_FLAG_FROM_OTHER_SC  = 0x00020000,
 104         CTL_FLAG_IS_WAS_ON_RTR  = 0x00040000,   /* Don't rerun cmd on failover*/
 105         CTL_FLAG_BUS_ADDR       = 0x00080000,   /* ctl_sglist contains BUS
 106                                                    addresses, not virtual ones*/
 107         CTL_FLAG_IO_CONT        = 0x00100000,   /* Continue I/O instead of
 108                                                    completing */
 109 #if 0
 110         CTL_FLAG_ALREADY_DONE   = 0x00200000    /* I/O already completed */
 111 #endif
 112         CTL_FLAG_NO_DATAMOVE    = 0x00400000,
 113         CTL_FLAG_DMA_QUEUED     = 0x00800000,   /* DMA queued but not started*/
 114         CTL_FLAG_STATUS_QUEUED  = 0x01000000,   /* Status queued but not sent*/
 115
 116         CTL_FLAG_FAILOVER       = 0x04000000,   /* Killed by a failover */
 117         CTL_FLAG_IO_ACTIVE      = 0x08000000,   /* I/O active on this SC */
 118         CTL_FLAG_STATUS_SENT    = 0x10000000    /* Status sent by datamove */
 119 } ctl_io_flags;
 120
 121
 122 struct ctl_lba_len {
 123         uint64_t lba;
 124         uint32_t len;
 125 };
 126
 127 struct ctl_lba_len_flags {
 128         uint64_t lba;
 129         uint32_t len;
 130         uint32_t flags;
 131 #define CTL_LLF_FUA     0x04000000
 132 #define CTL_LLF_DPO     0x08000000
 133 #define CTL_LLF_READ    0x10000000
 134 #define CTL_LLF_WRITE   0x20000000
 135 #define CTL_LLF_VERIFY  0x40000000
 136 #define CTL_LLF_COMPARE 0x80000000
 137 };
 138
 139 struct ctl_ptr_len_flags {
 140         uint8_t *ptr;
 141         uint32_t len;
 142         uint32_t flags;
 143 };
 144
 145 union ctl_priv {
 146         uint8_t         bytes[sizeof(uint64_t) * 2];
 147         uint64_t        integer;
 148         void            *ptr;
 149 };
 150
 151 /*
 152  * Number of CTL private areas.
 153  */
 154 #define CTL_NUM_PRIV    6
 155
 156 /*
 157  * Which private area are we using for a particular piece of data?
 158  */
 159 #define CTL_PRIV_LUN            0       /* CTL LUN pointer goes here */
 160 #define CTL_PRIV_LBA_LEN        1       /* Decoded LBA/len for read/write*/
 161 #define CTL_PRIV_MODEPAGE       1       /* Modepage info for config write */
 162 #define CTL_PRIV_BACKEND        2       /* Reserved for block, RAIDCore */
 163 #define CTL_PRIV_BACKEND_LUN    3       /* Backend LUN pointer */
 164 #define CTL_PRIV_FRONTEND       4       /* Frontend storage */
 165 #define CTL_PRIV_FRONTEND2      5       /* Another frontend storage */
 166
 167 #define CTL_INVALID_PORTNAME 0xFF
 168 #define CTL_UNMAPPED_IID     0xFF
 169
 170 struct ctl_sg_entry {
 171         void    *addr;
 172         size_t  len;
 173 };
 174
 175 typedef enum {
 176         CTL_IO_NONE,
 177         CTL_IO_SCSI,
 178         CTL_IO_TASK,
 179 } ctl_io_type;
 180
 181 struct ctl_nexus {
 182         uint32_t initid;                /* Initiator ID */
 183         uint32_t targ_port;             /* Target port, filled in by PORT */
 184         uint32_t targ_lun;              /* Destination lun */
 185         uint32_t targ_mapped_lun;       /* Destination lun CTL-wide */
 186 };
 187
 188 typedef enum {
 189         CTL_MSG_SERIALIZE,
 190         CTL_MSG_R2R,
 191         CTL_MSG_FINISH_IO,
 192         CTL_MSG_BAD_JUJU,
 193         CTL_MSG_MANAGE_TASKS,
 194         CTL_MSG_PERS_ACTION,
 195         CTL_MSG_DATAMOVE,
 196         CTL_MSG_DATAMOVE_DONE,
 197         CTL_MSG_UA,                     /* Set/clear UA on secondary. */
 198         CTL_MSG_PORT_SYNC,              /* Information about port. */
 199         CTL_MSG_LUN_SYNC,               /* Information about LUN. */
 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_type;
 333
 334 /*
 335  * Task management I/O structure.  Aborts, bus resets, etc., are sent using
 336  * this structure.
 337  *
 338  * Note:  Make sure the io_hdr is *always* the first element in this
 339  * structure.
 340  */
 341 struct ctl_taskio {
 342         struct ctl_io_hdr       io_hdr;      /* common to all I/O types */
 343         ctl_task_type           task_action; /* Target Reset, Abort, etc.  */
 344         uint32_t                tag_num;     /* tag number */
 345         ctl_tag_type            tag_type;    /* simple, ordered, etc. */
 346 };
 347
 348 typedef enum {
 349         CTL_PR_REG_KEY,
 350         CTL_PR_UNREG_KEY,
 351         CTL_PR_PREEMPT,
 352         CTL_PR_CLEAR,
 353         CTL_PR_RESERVE,
 354         CTL_PR_RELEASE
 355 } ctl_pr_action;
 356
 357 /*
 358  * The PR info is specifically for sending Persistent Reserve actions
 359  * to the other SC which it must also act on.
 360  *
 361  * Note:  Make sure the io_hdr is *always* the first element in this
 362  * structure.
 363  */
 364 struct ctl_pr_info {
 365         ctl_pr_action        action;
 366         uint8_t              sa_res_key[8];
 367         uint8_t              res_type;
 368         uint32_t             residx;
 369 };
 370
 371 struct ctl_ha_msg_hdr {
 372         ctl_msg_type            msg_type;
 373         union ctl_io            *original_sc;
 374         union ctl_io            *serializing_sc;
 375         struct ctl_nexus        nexus;       /* Initiator, port, target, lun */
 376         uint32_t                status;      /* transaction status */
 377 };
 378
 379 #define CTL_HA_MAX_SG_ENTRIES   16
 380 #define CTL_HA_DATAMOVE_SEGMENT 131072
 381
 382 /*
 383  * Used for CTL_MSG_PERS_ACTION.
 384  */
 385 struct ctl_ha_msg_pr {
 386         struct ctl_ha_msg_hdr   hdr;
 387         struct ctl_pr_info      pr_info;
 388 };
 389
 390 /*
 391  * Used for CTL_MSG_UA.
 392  */
 393 struct ctl_ha_msg_ua {
 394         struct ctl_ha_msg_hdr   hdr;
 395         int                     ua_all;
 396         int                     ua_set;
 397         int                     ua_type;
 398 };
 399
 400 /*
 401  * The S/G handling here is a little different than the standard ctl_scsiio
 402  * structure, because we can't pass data by reference in between controllers.
 403  * The S/G list in the ctl_scsiio struct is normally passed in the
 404  * kern_data_ptr field.  So kern_sg_entries here will always be non-zero,
 405  * even if there is only one entry.
 406  *
 407  * Used for CTL_MSG_DATAMOVE.
 408  */
 409 struct ctl_ha_msg_dt {
 410         struct ctl_ha_msg_hdr   hdr;
 411         ctl_io_flags            flags;  /* Only I/O flags are used here */
 412         uint32_t                sg_sequence;     /* S/G portion number  */
 413         uint8_t                 sg_last;         /* last S/G batch = 1 */
 414         uint32_t                sent_sg_entries; /* previous S/G count */
 415         uint32_t                cur_sg_entries;  /* current S/G entries */
 416         uint32_t                kern_sg_entries; /* total S/G entries */
 417         uint32_t                kern_data_len;   /* Length of this S/G list */
 418         uint32_t                kern_total_len;  /* Total length of this
 419                                                     transaction */
 420         uint32_t                kern_data_resid; /* Length left to transfer
 421                                                     after this*/
 422         uint32_t                kern_rel_offset; /* Byte Offset of this
 423                                                     transfer */
 424         struct ctl_sg_entry     sg_list[CTL_HA_MAX_SG_ENTRIES];
 425 };
 426
 427 /*
 428  * Used for CTL_MSG_SERIALIZE, CTL_MSG_FINISH_IO, CTL_MSG_BAD_JUJU.
 429  */
 430 struct ctl_ha_msg_scsi {
 431         struct ctl_ha_msg_hdr   hdr;
 432         uint32_t                tag_num;     /* tag number */
 433         ctl_tag_type            tag_type;    /* simple, ordered, etc. */
 434         uint8_t                 cdb[CTL_MAX_CDBLEN];    /* CDB */
 435         uint8_t                 cdb_len;        /* CDB length */
 436         uint8_t                 scsi_status; /* SCSI status byte */
 437         uint8_t                 sense_len;   /* Returned sense length */
 438         uint8_t                 sense_residual; /* sense residual length */
 439         uint32_t                residual;    /* data residual length */
 440         uint32_t                fetd_status; /* trans status, set by FETD,
 441                                                 0 = good*/
 442         struct ctl_lba_len      lbalen;      /* used for stats */
 443         struct scsi_sense_data  sense_data;  /* sense data */
 444 };
 445
 446 /*
 447  * Used for CTL_MSG_MANAGE_TASKS.
 448  */
 449 struct ctl_ha_msg_task {
 450         struct ctl_ha_msg_hdr   hdr;
 451         ctl_task_type           task_action; /* Target Reset, Abort, etc.  */
 452         uint32_t                tag_num;     /* tag number */
 453         ctl_tag_type            tag_type;    /* simple, ordered, etc. */
 454 };
 455
 456 /*
 457  * Used for CTL_MSG_PORT_SYNC.
 458  */
 459 struct ctl_ha_msg_port {
 460         struct ctl_ha_msg_hdr   hdr;
 461         int                     port_type;
 462         int                     physical_port;
 463         int                     virtual_port;
 464         int                     status;
 465         int                     name_len;
 466         int                     lun_map_len;
 467         int                     port_devid_len;
 468         int                     target_devid_len;
 469         uint8_t                 data[];
 470 };
 471
 472 /*
 473  * Used for CTL_MSG_LUN_SYNC.
 474  */
 475 struct ctl_ha_msg_lun {
 476         struct ctl_ha_msg_hdr   hdr;
 477         int                     flags;
 478         unsigned int            pr_generation;
 479         uint32_t                pr_res_idx;
 480         uint8_t                 pr_res_type;
 481         int                     lun_devid_len;
 482         int                     pr_key_count;
 483         uint8_t                 data[];
 484 };
 485
 486 struct ctl_ha_msg_lun_pr_key {
 487         uint32_t                pr_iid;
 488         uint64_t                pr_key;
 489 };
 490
 491 union ctl_ha_msg {
 492         struct ctl_ha_msg_hdr   hdr;
 493         struct ctl_ha_msg_task  task;
 494         struct ctl_ha_msg_scsi  scsi;
 495         struct ctl_ha_msg_dt    dt;
 496         struct ctl_ha_msg_pr    pr;
 497         struct ctl_ha_msg_ua    ua;
 498         struct ctl_ha_msg_port  port;
 499         struct ctl_ha_msg_lun   lun;
 500 };
 501
 502
 503 struct ctl_prio {
 504         struct ctl_io_hdr  io_hdr;
 505         struct ctl_ha_msg_pr pr_msg;
 506 };
 507
 508
 509
 510 union ctl_io {
 511         struct ctl_io_hdr io_hdr;       /* common to all I/O types */
 512         struct ctl_scsiio scsiio;       /* Normal SCSI commands */
 513         struct ctl_taskio taskio;       /* SCSI task management/reset */
 514         struct ctl_prio   presio;       /* update per. res info on other SC */
 515 };
 516
 517 #ifdef _KERNEL
 518
 519 union ctl_io *ctl_alloc_io(void *pool_ref);
 520 union ctl_io *ctl_alloc_io_nowait(void *pool_ref);
 521 void ctl_free_io(union ctl_io *io);
 522 void ctl_zero_io(union ctl_io *io);
 523 void ctl_copy_io(union ctl_io *src, union ctl_io *dest);
 524
 525 #endif /* _KERNEL */
 526
 527 #endif  /* _CTL_IO_H_ */
 528
 529 /*
 530  * vim: ts=8
 531  */