]> CyberLeo.Net >> Repos - FreeBSD/stable/10.git/blob - sys/cam/ctl/ctl_private.h
MFC r268293:
[FreeBSD/stable/10.git] / sys / cam / ctl / ctl_private.h
1 /*-
2  * Copyright (c) 2003, 2004, 2005, 2008 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_private.h#7 $
31  * $FreeBSD$
32  */
33 /*
34  * CAM Target Layer driver private data structures/definitions.
35  *
36  * Author: Ken Merry <ken@FreeBSD.org>
37  */
38
39 #ifndef _CTL_PRIVATE_H_
40 #define _CTL_PRIVATE_H_
41
42 /*
43  * SCSI vendor and product names.
44  */
45 #define CTL_VENDOR              "FREEBSD "
46 #define CTL_DIRECT_PRODUCT      "CTLDISK         "
47 #define CTL_PROCESSOR_PRODUCT   "CTLPROCESSOR    "
48 #define CTL_UNKNOWN_PRODUCT     "CTLDEVICE       "
49
50 struct ctl_fe_ioctl_startstop_info {
51         struct cv                       sem;
52         struct ctl_hard_startstop_info  hs_info;
53 };
54
55 struct ctl_fe_ioctl_bbrread_info {
56         struct cv                       sem;
57         struct ctl_bbrread_info         *bbr_info;
58         int                             wakeup_done;
59         struct mtx                      *lock;
60 };
61
62 typedef enum {
63         CTL_IOCTL_INPROG,
64         CTL_IOCTL_DATAMOVE,
65         CTL_IOCTL_DONE
66 } ctl_fe_ioctl_state;
67
68 struct ctl_fe_ioctl_params {
69         struct cv               sem;
70         struct mtx              ioctl_mtx;
71         ctl_fe_ioctl_state      state;
72 };
73
74 #define CTL_POOL_ENTRIES_INTERNAL       200
75 #define CTL_POOL_ENTRIES_EMERGENCY      300
76 #define CTL_POOL_ENTRIES_OTHER_SC   200
77
78 typedef enum {
79         CTL_POOL_INTERNAL,
80         CTL_POOL_FETD,
81         CTL_POOL_EMERGENCY,
82         CTL_POOL_4OTHERSC
83 } ctl_pool_type;
84
85 typedef enum {
86         CTL_POOL_FLAG_NONE      = 0x00,
87         CTL_POOL_FLAG_INVALID   = 0x01
88 } ctl_pool_flags;
89
90 struct ctl_io_pool {
91         ctl_pool_type                   type;
92         ctl_pool_flags                  flags;
93         uint32_t                        id;
94         struct ctl_softc                *ctl_softc;
95         uint32_t                        refcount;
96         uint64_t                        total_allocated;
97         uint64_t                        total_freed;
98         int32_t                         total_ctl_io;
99         int32_t                         free_ctl_io;
100         STAILQ_HEAD(, ctl_io_hdr)       free_queue;
101         STAILQ_ENTRY(ctl_io_pool)       links;
102 };
103
104 typedef enum {
105         CTL_IOCTL_FLAG_NONE     = 0x00,
106         CTL_IOCTL_FLAG_ENABLED  = 0x01
107 } ctl_ioctl_flags;
108
109 struct ctl_ioctl_info {
110         ctl_ioctl_flags         flags;
111         uint32_t                cur_tag_num;
112         struct ctl_port         port;
113         char                    port_name[24];
114 };
115
116 typedef enum {
117         CTL_SER_BLOCK,
118         CTL_SER_EXTENT,
119         CTL_SER_PASS,
120         CTL_SER_SKIP
121 } ctl_serialize_action;
122
123 typedef enum {
124         CTL_ACTION_BLOCK,
125         CTL_ACTION_OVERLAP,
126         CTL_ACTION_OVERLAP_TAG,
127         CTL_ACTION_PASS,
128         CTL_ACTION_SKIP,
129         CTL_ACTION_ERROR
130 } ctl_action;
131
132 /*
133  * WARNING:  Keep the bottom nibble here free, we OR in the data direction
134  * flags for each command.
135  *
136  * Note:  "OK_ON_ALL_LUNS" == we don't have to have a lun configured
137  *        "OK_ON_BOTH"     == we have to have a lun configured
138  *        "SA5"            == command has 5-bit service action at byte 1
139  */
140 typedef enum {
141         CTL_CMD_FLAG_NONE               = 0x0000,
142         CTL_CMD_FLAG_NO_SENSE           = 0x0010,
143         CTL_CMD_FLAG_OK_ON_ALL_LUNS     = 0x0020,
144         CTL_CMD_FLAG_ALLOW_ON_RESV      = 0x0040,
145         CTL_CMD_FLAG_OK_ON_PROC         = 0x0100,
146         CTL_CMD_FLAG_OK_ON_SLUN         = 0x0200,
147         CTL_CMD_FLAG_OK_ON_BOTH         = 0x0300,
148         CTL_CMD_FLAG_OK_ON_STOPPED      = 0x0400,
149         CTL_CMD_FLAG_OK_ON_INOPERABLE   = 0x0800,
150         CTL_CMD_FLAG_OK_ON_OFFLINE      = 0x1000,
151         CTL_CMD_FLAG_OK_ON_SECONDARY    = 0x2000,
152         CTL_CMD_FLAG_ALLOW_ON_PR_RESV   = 0x4000,
153         CTL_CMD_FLAG_SA5                = 0x8000
154 } ctl_cmd_flags;
155
156 typedef enum {
157         CTL_SERIDX_TUR  = 0,
158         CTL_SERIDX_READ,
159         CTL_SERIDX_WRITE,
160         CTL_SERIDX_UNMAP,
161         CTL_SERIDX_MD_SNS,
162         CTL_SERIDX_MD_SEL,
163         CTL_SERIDX_RQ_SNS,
164         CTL_SERIDX_INQ,
165         CTL_SERIDX_RD_CAP,
166         CTL_SERIDX_RESV,
167         CTL_SERIDX_REL,
168         CTL_SERIDX_LOG_SNS,
169         CTL_SERIDX_FORMAT,
170         CTL_SERIDX_START,
171         CTL_SERIDX_PRES_IN,
172         CTL_SERIDX_PRES_OUT,
173         CTL_SERIDX_MAIN_IN,
174         /* TBD: others to be filled in as needed */
175         CTL_SERIDX_COUNT, /* LAST, not a normal code, provides # codes */
176         CTL_SERIDX_INVLD = CTL_SERIDX_COUNT
177 } ctl_seridx;
178
179 typedef int     ctl_opfunc(struct ctl_scsiio *ctsio);
180
181 struct ctl_cmd_entry {
182         ctl_opfunc              *execute;
183         ctl_seridx              seridx;
184         ctl_cmd_flags           flags;
185         ctl_lun_error_pattern   pattern;
186         uint8_t                 length;         /* CDB length */
187         uint8_t                 usage[15];      /* Mask of allowed CDB bits
188                                                  * after the opcode byte. */
189 };
190
191 typedef enum {
192         CTL_LUN_NONE            = 0x000,
193         CTL_LUN_CONTROL         = 0x001,
194         CTL_LUN_RESERVED        = 0x002,
195         CTL_LUN_INVALID         = 0x004,
196         CTL_LUN_DISABLED        = 0x008,
197         CTL_LUN_MALLOCED        = 0x010,
198         CTL_LUN_STOPPED         = 0x020,
199         CTL_LUN_INOPERABLE      = 0x040,
200         CTL_LUN_OFFLINE         = 0x080,
201         CTL_LUN_PR_RESERVED     = 0x100,
202         CTL_LUN_PRIMARY_SC      = 0x200,
203         CTL_LUN_SENSE_DESC      = 0x400
204 } ctl_lun_flags;
205
206 typedef enum {
207         CTLBLOCK_FLAG_NONE      = 0x00,
208         CTLBLOCK_FLAG_INVALID   = 0x01
209 } ctlblock_flags;
210
211 union ctl_softcs {
212         struct ctl_softc        *ctl_softc;
213         struct ctlblock_softc   *ctlblock_softc;
214 };
215
216 /*
217  * Mode page defaults.
218  */
219 #if 0
220 /*
221  * These values make Solaris trim off some of the capacity.
222  */
223 #define CTL_DEFAULT_SECTORS_PER_TRACK   63
224 #define CTL_DEFAULT_HEADS               255
225 /*
226  * These values seem to work okay.
227  */
228 #define CTL_DEFAULT_SECTORS_PER_TRACK   63
229 #define CTL_DEFAULT_HEADS               16
230 /*
231  * These values work reasonably well.
232  */
233 #define CTL_DEFAULT_SECTORS_PER_TRACK   512
234 #define CTL_DEFAULT_HEADS               64
235 #endif
236
237 /*
238  * Solaris is somewhat picky about how many heads and sectors per track you
239  * have defined in mode pages 3 and 4.  These values seem to cause Solaris
240  * to get the capacity more or less right when you run the format tool.
241  * They still have problems when dealing with devices larger than 1TB,
242  * but there isn't anything we can do about that.
243  *
244  * For smaller LUN sizes, this ends up causing the number of cylinders to
245  * work out to 0.  Solaris actually recognizes that and comes up with its
246  * own bogus geometry to fit the actual capacity of the drive.  They really
247  * should just give up on geometry and stick to the read capacity
248  * information alone for modern disk drives.
249  *
250  * One thing worth mentioning about Solaris' mkfs command is that it
251  * doesn't like sectors per track values larger than 256.  512 seems to
252  * work okay for format, but causes problems when you try to make a
253  * filesystem.
254  *
255  * Another caveat about these values:  the product of these two values
256  * really should be a power of 2.  This is because of the simplistic
257  * shift-based calculation that we have to use on the i386 platform to
258  * calculate the number of cylinders here.  (If you use a divide, you end
259  * up calling __udivdi3(), which is a hardware FP call on the PC.  On the
260  * XScale, it is done in software, so you can do that from inside the
261  * kernel.)
262  *
263  * So for the current values (256 S/T, 128 H), we get 32768, which works
264  * very nicely for calculating cylinders.
265  *
266  * If you want to change these values so that their product is no longer a
267  * power of 2, re-visit the calculation in ctl_init_page_index().  You may
268  * need to make it a bit more complicated to get the number of cylinders
269  * right.
270  */
271 #define CTL_DEFAULT_SECTORS_PER_TRACK   256
272 #define CTL_DEFAULT_HEADS               128
273
274 #define CTL_DEFAULT_ROTATION_RATE       10000
275
276 struct ctl_page_index;
277
278 typedef int     ctl_modesen_handler(struct ctl_scsiio *ctsio,
279                                     struct ctl_page_index *page_index,
280                                     int pc);
281 typedef int     ctl_modesel_handler(struct ctl_scsiio *ctsio,
282                                     struct ctl_page_index *page_index,
283                                     uint8_t *page_ptr);
284
285 typedef enum {
286         CTL_PAGE_FLAG_NONE       = 0x00,
287         CTL_PAGE_FLAG_DISK_ONLY  = 0x01
288 } ctl_page_flags;
289
290 struct ctl_page_index {
291         uint8_t                 page_code;
292         uint8_t                 subpage;
293         uint16_t                page_len;
294         uint8_t                 *page_data;
295         ctl_page_flags          page_flags;
296         ctl_modesen_handler     *sense_handler;
297         ctl_modesel_handler     *select_handler;
298 };
299
300 #define CTL_PAGE_CURRENT        0x00
301 #define CTL_PAGE_CHANGEABLE     0x01
302 #define CTL_PAGE_DEFAULT        0x02
303 #define CTL_PAGE_SAVED          0x03
304
305 static const struct ctl_page_index page_index_template[] = {
306         {SMS_FORMAT_DEVICE_PAGE, 0, sizeof(struct scsi_format_page), NULL,
307          CTL_PAGE_FLAG_DISK_ONLY, NULL, NULL},
308         {SMS_RIGID_DISK_PAGE, 0, sizeof(struct scsi_rigid_disk_page), NULL,
309          CTL_PAGE_FLAG_DISK_ONLY, NULL, NULL},
310         {SMS_CACHING_PAGE, 0, sizeof(struct scsi_caching_page), NULL,
311          CTL_PAGE_FLAG_DISK_ONLY, NULL, NULL},
312         {SMS_CONTROL_MODE_PAGE, 0, sizeof(struct scsi_control_page), NULL,
313          CTL_PAGE_FLAG_NONE, NULL, ctl_control_page_handler},
314         {SMS_VENDOR_SPECIFIC_PAGE | SMPH_SPF, PWR_SUBPAGE_CODE,
315          sizeof(struct copan_power_subpage), NULL, CTL_PAGE_FLAG_NONE,
316          ctl_power_sp_sense_handler, ctl_power_sp_handler},
317         {SMS_VENDOR_SPECIFIC_PAGE | SMPH_SPF, APS_SUBPAGE_CODE,
318          sizeof(struct copan_aps_subpage), NULL, CTL_PAGE_FLAG_NONE,
319          NULL, ctl_aps_sp_handler},
320         {SMS_VENDOR_SPECIFIC_PAGE | SMPH_SPF, DBGCNF_SUBPAGE_CODE,
321          sizeof(struct copan_debugconf_subpage), NULL, CTL_PAGE_FLAG_NONE,
322          ctl_debugconf_sp_sense_handler, ctl_debugconf_sp_select_handler},
323 };
324
325 #define CTL_NUM_MODE_PAGES sizeof(page_index_template)/   \
326                            sizeof(page_index_template[0])
327
328 struct ctl_mode_pages {
329         struct scsi_format_page         format_page[4];
330         struct scsi_rigid_disk_page     rigid_disk_page[4];
331         struct scsi_caching_page        caching_page[4];
332         struct scsi_control_page        control_page[4];
333         struct copan_power_subpage      power_subpage[4];
334         struct copan_aps_subpage        aps_subpage[4];
335         struct copan_debugconf_subpage  debugconf_subpage[4];
336         struct ctl_page_index           index[CTL_NUM_MODE_PAGES];
337 };
338
339 struct ctl_pending_sense {
340         ctl_ua_type             ua_pending;
341         struct scsi_sense_data  sense;
342 };
343
344 struct ctl_lun_delay_info {
345         ctl_delay_type          datamove_type;
346         uint32_t                datamove_delay;
347         ctl_delay_type          done_type;
348         uint32_t                done_delay;
349 };
350
351 typedef enum {
352         CTL_ERR_INJ_NONE        = 0x00,
353         CTL_ERR_INJ_ABORTED     = 0x01
354 } ctl_err_inject_flags;
355
356 typedef enum {
357         CTL_PR_FLAG_NONE        = 0x00,
358         CTL_PR_FLAG_REGISTERED  = 0x01,
359         CTL_PR_FLAG_ACTIVE_RES  = 0x02
360 } ctl_per_res_flags;
361
362 struct ctl_per_res_info {
363         struct scsi_per_res_key res_key;
364         uint8_t  registered;
365 };
366
367 #define CTL_PR_ALL_REGISTRANTS  0xFFFF
368 #define CTL_PR_NO_RESERVATION   0xFFF0
369
370 struct ctl_devid {
371         int             len;
372         uint8_t         data[];
373 };
374
375 /*
376  * For report target port groups.
377  */
378 #define NUM_TARGET_PORT_GROUPS  2
379 #define NUM_PORTS_PER_GRP       2
380
381 struct ctl_lun {
382         struct mtx                      lun_lock;
383         struct ctl_id                   target;
384         uint64_t                        lun;
385         ctl_lun_flags                   flags;
386         STAILQ_HEAD(,ctl_error_desc)    error_list;
387         uint64_t                        error_serial;
388         struct ctl_softc                *ctl_softc;
389         struct ctl_be_lun               *be_lun;
390         struct ctl_backend_driver       *backend;
391         int                             io_count;
392         struct ctl_lun_delay_info       delay_info;
393         int                             sync_interval;
394         int                             sync_count;
395         TAILQ_HEAD(ctl_ooaq, ctl_io_hdr)  ooa_queue;
396         TAILQ_HEAD(ctl_blockq,ctl_io_hdr) blocked_queue;
397         STAILQ_ENTRY(ctl_lun)           links;
398         STAILQ_ENTRY(ctl_lun)           run_links;
399         struct ctl_nexus                rsv_nexus;
400         uint32_t                        have_ca[CTL_MAX_INITIATORS >> 5];
401         struct ctl_pending_sense        pending_sense[CTL_MAX_INITIATORS];
402         struct ctl_mode_pages           mode_pages;
403         struct ctl_lun_io_stats         stats;
404         struct ctl_per_res_info         per_res[2*CTL_MAX_INITIATORS];
405         unsigned int                    PRGeneration;
406         int                             pr_key_count;
407         uint16_t                        pr_res_idx;
408         uint8_t                         res_type;
409         uint8_t                         write_buffer[524288];
410         struct ctl_devid                *lun_devid;
411 };
412
413 typedef enum {
414         CTL_FLAG_REAL_SYNC      = 0x02,
415         CTL_FLAG_MASTER_SHELF   = 0x04
416 } ctl_gen_flags;
417
418 struct ctl_wwpn_iid {
419         int in_use;
420         uint64_t wwpn;
421         uint32_t iid;
422         int32_t port;
423 };
424
425 #define CTL_MAX_THREADS         16
426
427 struct ctl_thread {
428         struct mtx_padalign queue_lock;
429         struct ctl_softc        *ctl_softc;
430         struct thread           *thread;
431         STAILQ_HEAD(, ctl_io_hdr) incoming_queue;
432         STAILQ_HEAD(, ctl_io_hdr) rtr_queue;
433         STAILQ_HEAD(, ctl_io_hdr) done_queue;
434         STAILQ_HEAD(, ctl_io_hdr) isc_queue;
435 };
436
437 struct ctl_softc {
438         struct mtx ctl_lock;
439         struct cdev *dev;
440         int open_count;
441         struct ctl_id target;
442         int num_disks;
443         int num_luns;
444         ctl_gen_flags flags;
445         ctl_ha_mode ha_mode;
446         int inquiry_pq_no_lun;
447         struct sysctl_ctx_list sysctl_ctx;
448         struct sysctl_oid *sysctl_tree;
449         struct ctl_ioctl_info ioctl_info;
450         struct ctl_io_pool *internal_pool;
451         struct ctl_io_pool *emergency_pool;
452         struct ctl_io_pool *othersc_pool;
453         struct proc *ctl_proc;
454         int targ_online;
455         uint32_t ctl_lun_mask[CTL_MAX_LUNS >> 5];
456         struct ctl_lun *ctl_luns[CTL_MAX_LUNS];
457         struct ctl_wwpn_iid wwpn_iid[CTL_MAX_PORTS][CTL_MAX_INIT_PER_PORT];
458         uint32_t ctl_port_mask;
459         uint64_t aps_locked_lun;
460         STAILQ_HEAD(, ctl_lun) lun_list;
461         STAILQ_HEAD(, ctl_be_lun) pending_lun_queue;
462         uint32_t num_frontends;
463         STAILQ_HEAD(, ctl_frontend) fe_list;
464         uint32_t num_ports;
465         STAILQ_HEAD(, ctl_port) port_list;
466         struct ctl_port *ctl_ports[CTL_MAX_PORTS];
467         uint32_t num_backends;
468         STAILQ_HEAD(, ctl_backend_driver) be_list;
469         struct mtx pool_lock;
470         uint32_t num_pools;
471         uint32_t cur_pool_id;
472         STAILQ_HEAD(, ctl_io_pool) io_pools;
473         time_t last_print_jiffies;
474         uint32_t skipped_prints;
475         struct ctl_thread threads[CTL_MAX_THREADS];
476 };
477
478 #ifdef _KERNEL
479
480 extern const struct ctl_cmd_entry ctl_cmd_table[256];
481
482 uint32_t ctl_get_initindex(struct ctl_nexus *nexus);
483 int ctl_pool_create(struct ctl_softc *ctl_softc, ctl_pool_type pool_type,
484                     uint32_t total_ctl_io, struct ctl_io_pool **npool);
485 void ctl_pool_free(struct ctl_io_pool *pool);
486 int ctl_scsi_release(struct ctl_scsiio *ctsio);
487 int ctl_scsi_reserve(struct ctl_scsiio *ctsio);
488 int ctl_start_stop(struct ctl_scsiio *ctsio);
489 int ctl_sync_cache(struct ctl_scsiio *ctsio);
490 int ctl_format(struct ctl_scsiio *ctsio);
491 int ctl_read_buffer(struct ctl_scsiio *ctsio);
492 int ctl_write_buffer(struct ctl_scsiio *ctsio);
493 int ctl_write_same(struct ctl_scsiio *ctsio);
494 int ctl_unmap(struct ctl_scsiio *ctsio);
495 int ctl_mode_select(struct ctl_scsiio *ctsio);
496 int ctl_mode_sense(struct ctl_scsiio *ctsio);
497 int ctl_read_capacity(struct ctl_scsiio *ctsio);
498 int ctl_read_capacity_16(struct ctl_scsiio *ctsio);
499 int ctl_read_write(struct ctl_scsiio *ctsio);
500 int ctl_cnw(struct ctl_scsiio *ctsio);
501 int ctl_report_luns(struct ctl_scsiio *ctsio);
502 int ctl_request_sense(struct ctl_scsiio *ctsio);
503 int ctl_tur(struct ctl_scsiio *ctsio);
504 int ctl_verify(struct ctl_scsiio *ctsio);
505 int ctl_inquiry(struct ctl_scsiio *ctsio);
506 int ctl_persistent_reserve_in(struct ctl_scsiio *ctsio);
507 int ctl_persistent_reserve_out(struct ctl_scsiio *ctsio);
508 int ctl_report_tagret_port_groups(struct ctl_scsiio *ctsio);
509 int ctl_report_supported_opcodes(struct ctl_scsiio *ctsio);
510 int ctl_report_supported_tmf(struct ctl_scsiio *ctsio);
511 int ctl_report_timestamp(struct ctl_scsiio *ctsio);
512 int ctl_isc(struct ctl_scsiio *ctsio);
513
514 #endif  /* _KERNEL */
515
516 #endif  /* _CTL_PRIVATE_H_ */
517
518 /*
519  * vim: ts=8
520  */