ctl.c revision 311409
1/*-
2 * Copyright (c) 2003-2009 Silicon Graphics International Corp.
3 * Copyright (c) 2012 The FreeBSD Foundation
4 * Copyright (c) 2015 Alexander Motin <mav@FreeBSD.org>
5 * All rights reserved.
6 *
7 * Portions of this software were developed by Edward Tomasz Napierala
8 * under sponsorship from the FreeBSD Foundation.
9 *
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
12 * are met:
13 * 1. Redistributions of source code must retain the above copyright
14 *    notice, this list of conditions, and the following disclaimer,
15 *    without modification.
16 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
17 *    substantially similar to the "NO WARRANTY" disclaimer below
18 *    ("Disclaimer") and any redistribution must be conditioned upon
19 *    including a substantially similar Disclaimer requirement for further
20 *    binary redistribution.
21 *
22 * NO WARRANTY
23 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
24 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
25 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
26 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
27 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
31 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
32 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
33 * POSSIBILITY OF SUCH DAMAGES.
34 *
35 * $Id$
36 */
37/*
38 * CAM Target Layer, a SCSI device emulation subsystem.
39 *
40 * Author: Ken Merry <ken@FreeBSD.org>
41 */
42
43#define _CTL_C
44
45#include <sys/cdefs.h>
46__FBSDID("$FreeBSD: stable/10/sys/cam/ctl/ctl.c 311409 2017-01-05 11:30:24Z mav $");
47
48#include <sys/param.h>
49#include <sys/systm.h>
50#include <sys/ctype.h>
51#include <sys/kernel.h>
52#include <sys/types.h>
53#include <sys/kthread.h>
54#include <sys/bio.h>
55#include <sys/fcntl.h>
56#include <sys/lock.h>
57#include <sys/module.h>
58#include <sys/mutex.h>
59#include <sys/condvar.h>
60#include <sys/malloc.h>
61#include <sys/conf.h>
62#include <sys/ioccom.h>
63#include <sys/queue.h>
64#include <sys/sbuf.h>
65#include <sys/smp.h>
66#include <sys/endian.h>
67#include <sys/sysctl.h>
68#include <vm/uma.h>
69
70#include <cam/cam.h>
71#include <cam/scsi/scsi_all.h>
72#include <cam/scsi/scsi_cd.h>
73#include <cam/scsi/scsi_da.h>
74#include <cam/ctl/ctl_io.h>
75#include <cam/ctl/ctl.h>
76#include <cam/ctl/ctl_frontend.h>
77#include <cam/ctl/ctl_util.h>
78#include <cam/ctl/ctl_backend.h>
79#include <cam/ctl/ctl_ioctl.h>
80#include <cam/ctl/ctl_ha.h>
81#include <cam/ctl/ctl_private.h>
82#include <cam/ctl/ctl_debug.h>
83#include <cam/ctl/ctl_scsi_all.h>
84#include <cam/ctl/ctl_error.h>
85
86struct ctl_softc *control_softc = NULL;
87
88/*
89 * Template mode pages.
90 */
91
92/*
93 * Note that these are default values only.  The actual values will be
94 * filled in when the user does a mode sense.
95 */
96const static struct scsi_da_rw_recovery_page rw_er_page_default = {
97	/*page_code*/SMS_RW_ERROR_RECOVERY_PAGE,
98	/*page_length*/sizeof(struct scsi_da_rw_recovery_page) - 2,
99	/*byte3*/SMS_RWER_AWRE|SMS_RWER_ARRE,
100	/*read_retry_count*/0,
101	/*correction_span*/0,
102	/*head_offset_count*/0,
103	/*data_strobe_offset_cnt*/0,
104	/*byte8*/SMS_RWER_LBPERE,
105	/*write_retry_count*/0,
106	/*reserved2*/0,
107	/*recovery_time_limit*/{0, 0},
108};
109
110const static struct scsi_da_rw_recovery_page rw_er_page_changeable = {
111	/*page_code*/SMS_RW_ERROR_RECOVERY_PAGE,
112	/*page_length*/sizeof(struct scsi_da_rw_recovery_page) - 2,
113	/*byte3*/SMS_RWER_PER,
114	/*read_retry_count*/0,
115	/*correction_span*/0,
116	/*head_offset_count*/0,
117	/*data_strobe_offset_cnt*/0,
118	/*byte8*/SMS_RWER_LBPERE,
119	/*write_retry_count*/0,
120	/*reserved2*/0,
121	/*recovery_time_limit*/{0, 0},
122};
123
124const static struct scsi_format_page format_page_default = {
125	/*page_code*/SMS_FORMAT_DEVICE_PAGE,
126	/*page_length*/sizeof(struct scsi_format_page) - 2,
127	/*tracks_per_zone*/ {0, 0},
128	/*alt_sectors_per_zone*/ {0, 0},
129	/*alt_tracks_per_zone*/ {0, 0},
130	/*alt_tracks_per_lun*/ {0, 0},
131	/*sectors_per_track*/ {(CTL_DEFAULT_SECTORS_PER_TRACK >> 8) & 0xff,
132			        CTL_DEFAULT_SECTORS_PER_TRACK & 0xff},
133	/*bytes_per_sector*/ {0, 0},
134	/*interleave*/ {0, 0},
135	/*track_skew*/ {0, 0},
136	/*cylinder_skew*/ {0, 0},
137	/*flags*/ SFP_HSEC,
138	/*reserved*/ {0, 0, 0}
139};
140
141const static struct scsi_format_page format_page_changeable = {
142	/*page_code*/SMS_FORMAT_DEVICE_PAGE,
143	/*page_length*/sizeof(struct scsi_format_page) - 2,
144	/*tracks_per_zone*/ {0, 0},
145	/*alt_sectors_per_zone*/ {0, 0},
146	/*alt_tracks_per_zone*/ {0, 0},
147	/*alt_tracks_per_lun*/ {0, 0},
148	/*sectors_per_track*/ {0, 0},
149	/*bytes_per_sector*/ {0, 0},
150	/*interleave*/ {0, 0},
151	/*track_skew*/ {0, 0},
152	/*cylinder_skew*/ {0, 0},
153	/*flags*/ 0,
154	/*reserved*/ {0, 0, 0}
155};
156
157const static struct scsi_rigid_disk_page rigid_disk_page_default = {
158	/*page_code*/SMS_RIGID_DISK_PAGE,
159	/*page_length*/sizeof(struct scsi_rigid_disk_page) - 2,
160	/*cylinders*/ {0, 0, 0},
161	/*heads*/ CTL_DEFAULT_HEADS,
162	/*start_write_precomp*/ {0, 0, 0},
163	/*start_reduced_current*/ {0, 0, 0},
164	/*step_rate*/ {0, 0},
165	/*landing_zone_cylinder*/ {0, 0, 0},
166	/*rpl*/ SRDP_RPL_DISABLED,
167	/*rotational_offset*/ 0,
168	/*reserved1*/ 0,
169	/*rotation_rate*/ {(CTL_DEFAULT_ROTATION_RATE >> 8) & 0xff,
170			   CTL_DEFAULT_ROTATION_RATE & 0xff},
171	/*reserved2*/ {0, 0}
172};
173
174const static struct scsi_rigid_disk_page rigid_disk_page_changeable = {
175	/*page_code*/SMS_RIGID_DISK_PAGE,
176	/*page_length*/sizeof(struct scsi_rigid_disk_page) - 2,
177	/*cylinders*/ {0, 0, 0},
178	/*heads*/ 0,
179	/*start_write_precomp*/ {0, 0, 0},
180	/*start_reduced_current*/ {0, 0, 0},
181	/*step_rate*/ {0, 0},
182	/*landing_zone_cylinder*/ {0, 0, 0},
183	/*rpl*/ 0,
184	/*rotational_offset*/ 0,
185	/*reserved1*/ 0,
186	/*rotation_rate*/ {0, 0},
187	/*reserved2*/ {0, 0}
188};
189
190const static struct scsi_da_verify_recovery_page verify_er_page_default = {
191	/*page_code*/SMS_VERIFY_ERROR_RECOVERY_PAGE,
192	/*page_length*/sizeof(struct scsi_da_verify_recovery_page) - 2,
193	/*byte3*/0,
194	/*read_retry_count*/0,
195	/*reserved*/{ 0, 0, 0, 0, 0, 0 },
196	/*recovery_time_limit*/{0, 0},
197};
198
199const static struct scsi_da_verify_recovery_page verify_er_page_changeable = {
200	/*page_code*/SMS_VERIFY_ERROR_RECOVERY_PAGE,
201	/*page_length*/sizeof(struct scsi_da_verify_recovery_page) - 2,
202	/*byte3*/SMS_VER_PER,
203	/*read_retry_count*/0,
204	/*reserved*/{ 0, 0, 0, 0, 0, 0 },
205	/*recovery_time_limit*/{0, 0},
206};
207
208const static struct scsi_caching_page caching_page_default = {
209	/*page_code*/SMS_CACHING_PAGE,
210	/*page_length*/sizeof(struct scsi_caching_page) - 2,
211	/*flags1*/ SCP_DISC | SCP_WCE,
212	/*ret_priority*/ 0,
213	/*disable_pf_transfer_len*/ {0xff, 0xff},
214	/*min_prefetch*/ {0, 0},
215	/*max_prefetch*/ {0xff, 0xff},
216	/*max_pf_ceiling*/ {0xff, 0xff},
217	/*flags2*/ 0,
218	/*cache_segments*/ 0,
219	/*cache_seg_size*/ {0, 0},
220	/*reserved*/ 0,
221	/*non_cache_seg_size*/ {0, 0, 0}
222};
223
224const static struct scsi_caching_page caching_page_changeable = {
225	/*page_code*/SMS_CACHING_PAGE,
226	/*page_length*/sizeof(struct scsi_caching_page) - 2,
227	/*flags1*/ SCP_WCE | SCP_RCD,
228	/*ret_priority*/ 0,
229	/*disable_pf_transfer_len*/ {0, 0},
230	/*min_prefetch*/ {0, 0},
231	/*max_prefetch*/ {0, 0},
232	/*max_pf_ceiling*/ {0, 0},
233	/*flags2*/ 0,
234	/*cache_segments*/ 0,
235	/*cache_seg_size*/ {0, 0},
236	/*reserved*/ 0,
237	/*non_cache_seg_size*/ {0, 0, 0}
238};
239
240const static struct scsi_control_page control_page_default = {
241	/*page_code*/SMS_CONTROL_MODE_PAGE,
242	/*page_length*/sizeof(struct scsi_control_page) - 2,
243	/*rlec*/0,
244	/*queue_flags*/SCP_QUEUE_ALG_RESTRICTED,
245	/*eca_and_aen*/0,
246	/*flags4*/SCP_TAS,
247	/*aen_holdoff_period*/{0, 0},
248	/*busy_timeout_period*/{0, 0},
249	/*extended_selftest_completion_time*/{0, 0}
250};
251
252const static struct scsi_control_page control_page_changeable = {
253	/*page_code*/SMS_CONTROL_MODE_PAGE,
254	/*page_length*/sizeof(struct scsi_control_page) - 2,
255	/*rlec*/SCP_DSENSE,
256	/*queue_flags*/SCP_QUEUE_ALG_MASK | SCP_NUAR,
257	/*eca_and_aen*/SCP_SWP,
258	/*flags4*/0,
259	/*aen_holdoff_period*/{0, 0},
260	/*busy_timeout_period*/{0, 0},
261	/*extended_selftest_completion_time*/{0, 0}
262};
263
264#define CTL_CEM_LEN	(sizeof(struct scsi_control_ext_page) - 4)
265
266const static struct scsi_control_ext_page control_ext_page_default = {
267	/*page_code*/SMS_CONTROL_MODE_PAGE | SMPH_SPF,
268	/*subpage_code*/0x01,
269	/*page_length*/{CTL_CEM_LEN >> 8, CTL_CEM_LEN},
270	/*flags*/0,
271	/*prio*/0,
272	/*max_sense*/0
273};
274
275const static struct scsi_control_ext_page control_ext_page_changeable = {
276	/*page_code*/SMS_CONTROL_MODE_PAGE | SMPH_SPF,
277	/*subpage_code*/0x01,
278	/*page_length*/{CTL_CEM_LEN >> 8, CTL_CEM_LEN},
279	/*flags*/0,
280	/*prio*/0,
281	/*max_sense*/0
282};
283
284const static struct scsi_info_exceptions_page ie_page_default = {
285	/*page_code*/SMS_INFO_EXCEPTIONS_PAGE,
286	/*page_length*/sizeof(struct scsi_info_exceptions_page) - 2,
287	/*info_flags*/SIEP_FLAGS_EWASC,
288	/*mrie*/SIEP_MRIE_NO,
289	/*interval_timer*/{0, 0, 0, 0},
290	/*report_count*/{0, 0, 0, 1}
291};
292
293const static struct scsi_info_exceptions_page ie_page_changeable = {
294	/*page_code*/SMS_INFO_EXCEPTIONS_PAGE,
295	/*page_length*/sizeof(struct scsi_info_exceptions_page) - 2,
296	/*info_flags*/SIEP_FLAGS_EWASC | SIEP_FLAGS_DEXCPT | SIEP_FLAGS_TEST |
297	    SIEP_FLAGS_LOGERR,
298	/*mrie*/0x0f,
299	/*interval_timer*/{0xff, 0xff, 0xff, 0xff},
300	/*report_count*/{0xff, 0xff, 0xff, 0xff}
301};
302
303#define CTL_LBPM_LEN	(sizeof(struct ctl_logical_block_provisioning_page) - 4)
304
305const static struct ctl_logical_block_provisioning_page lbp_page_default = {{
306	/*page_code*/SMS_INFO_EXCEPTIONS_PAGE | SMPH_SPF,
307	/*subpage_code*/0x02,
308	/*page_length*/{CTL_LBPM_LEN >> 8, CTL_LBPM_LEN},
309	/*flags*/0,
310	/*reserved*/{0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0},
311	/*descr*/{}},
312	{{/*flags*/0,
313	  /*resource*/0x01,
314	  /*reserved*/{0, 0},
315	  /*count*/{0, 0, 0, 0}},
316	 {/*flags*/0,
317	  /*resource*/0x02,
318	  /*reserved*/{0, 0},
319	  /*count*/{0, 0, 0, 0}},
320	 {/*flags*/0,
321	  /*resource*/0xf1,
322	  /*reserved*/{0, 0},
323	  /*count*/{0, 0, 0, 0}},
324	 {/*flags*/0,
325	  /*resource*/0xf2,
326	  /*reserved*/{0, 0},
327	  /*count*/{0, 0, 0, 0}}
328	}
329};
330
331const static struct ctl_logical_block_provisioning_page lbp_page_changeable = {{
332	/*page_code*/SMS_INFO_EXCEPTIONS_PAGE | SMPH_SPF,
333	/*subpage_code*/0x02,
334	/*page_length*/{CTL_LBPM_LEN >> 8, CTL_LBPM_LEN},
335	/*flags*/0,
336	/*reserved*/{0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0},
337	/*descr*/{}},
338	{{/*flags*/0,
339	  /*resource*/0,
340	  /*reserved*/{0, 0},
341	  /*count*/{0, 0, 0, 0}},
342	 {/*flags*/0,
343	  /*resource*/0,
344	  /*reserved*/{0, 0},
345	  /*count*/{0, 0, 0, 0}},
346	 {/*flags*/0,
347	  /*resource*/0,
348	  /*reserved*/{0, 0},
349	  /*count*/{0, 0, 0, 0}},
350	 {/*flags*/0,
351	  /*resource*/0,
352	  /*reserved*/{0, 0},
353	  /*count*/{0, 0, 0, 0}}
354	}
355};
356
357const static struct scsi_cddvd_capabilities_page cddvd_page_default = {
358	/*page_code*/SMS_CDDVD_CAPS_PAGE,
359	/*page_length*/sizeof(struct scsi_cddvd_capabilities_page) - 2,
360	/*caps1*/0x3f,
361	/*caps2*/0x00,
362	/*caps3*/0xf0,
363	/*caps4*/0x00,
364	/*caps5*/0x29,
365	/*caps6*/0x00,
366	/*obsolete*/{0, 0},
367	/*nvol_levels*/{0, 0},
368	/*buffer_size*/{8, 0},
369	/*obsolete2*/{0, 0},
370	/*reserved*/0,
371	/*digital*/0,
372	/*obsolete3*/0,
373	/*copy_management*/0,
374	/*reserved2*/0,
375	/*rotation_control*/0,
376	/*cur_write_speed*/0,
377	/*num_speed_descr*/0,
378};
379
380const static struct scsi_cddvd_capabilities_page cddvd_page_changeable = {
381	/*page_code*/SMS_CDDVD_CAPS_PAGE,
382	/*page_length*/sizeof(struct scsi_cddvd_capabilities_page) - 2,
383	/*caps1*/0,
384	/*caps2*/0,
385	/*caps3*/0,
386	/*caps4*/0,
387	/*caps5*/0,
388	/*caps6*/0,
389	/*obsolete*/{0, 0},
390	/*nvol_levels*/{0, 0},
391	/*buffer_size*/{0, 0},
392	/*obsolete2*/{0, 0},
393	/*reserved*/0,
394	/*digital*/0,
395	/*obsolete3*/0,
396	/*copy_management*/0,
397	/*reserved2*/0,
398	/*rotation_control*/0,
399	/*cur_write_speed*/0,
400	/*num_speed_descr*/0,
401};
402
403SYSCTL_NODE(_kern_cam, OID_AUTO, ctl, CTLFLAG_RD, 0, "CAM Target Layer");
404static int worker_threads = -1;
405TUNABLE_INT("kern.cam.ctl.worker_threads", &worker_threads);
406SYSCTL_INT(_kern_cam_ctl, OID_AUTO, worker_threads, CTLFLAG_RDTUN,
407    &worker_threads, 1, "Number of worker threads");
408static int ctl_debug = CTL_DEBUG_NONE;
409TUNABLE_INT("kern.cam.ctl.debug", &ctl_debug);
410SYSCTL_INT(_kern_cam_ctl, OID_AUTO, debug, CTLFLAG_RWTUN,
411    &ctl_debug, 0, "Enabled debug flags");
412
413/*
414 * Supported pages (0x00), Serial number (0x80), Device ID (0x83),
415 * Extended INQUIRY Data (0x86), Mode Page Policy (0x87),
416 * SCSI Ports (0x88), Third-party Copy (0x8F), Block limits (0xB0),
417 * Block Device Characteristics (0xB1) and Logical Block Provisioning (0xB2)
418 */
419#define SCSI_EVPD_NUM_SUPPORTED_PAGES	10
420
421static void ctl_isc_event_handler(ctl_ha_channel chanel, ctl_ha_event event,
422				  int param);
423static void ctl_copy_sense_data(union ctl_ha_msg *src, union ctl_io *dest);
424static void ctl_copy_sense_data_back(union ctl_io *src, union ctl_ha_msg *dest);
425static int ctl_init(void);
426void ctl_shutdown(void);
427static int ctl_open(struct cdev *dev, int flags, int fmt, struct thread *td);
428static int ctl_close(struct cdev *dev, int flags, int fmt, struct thread *td);
429static int ctl_serialize_other_sc_cmd(struct ctl_scsiio *ctsio);
430static void ctl_ioctl_fill_ooa(struct ctl_lun *lun, uint32_t *cur_fill_num,
431			      struct ctl_ooa *ooa_hdr,
432			      struct ctl_ooa_entry *kern_entries);
433static int ctl_ioctl(struct cdev *dev, u_long cmd, caddr_t addr, int flag,
434		     struct thread *td);
435static int ctl_alloc_lun(struct ctl_softc *ctl_softc, struct ctl_lun *lun,
436			 struct ctl_be_lun *be_lun);
437static int ctl_free_lun(struct ctl_lun *lun);
438static void ctl_create_lun(struct ctl_be_lun *be_lun);
439static struct ctl_port * ctl_io_port(struct ctl_io_hdr *io_hdr);
440
441static int ctl_do_mode_select(union ctl_io *io);
442static int ctl_pro_preempt(struct ctl_softc *softc, struct ctl_lun *lun,
443			   uint64_t res_key, uint64_t sa_res_key,
444			   uint8_t type, uint32_t residx,
445			   struct ctl_scsiio *ctsio,
446			   struct scsi_per_res_out *cdb,
447			   struct scsi_per_res_out_parms* param);
448static void ctl_pro_preempt_other(struct ctl_lun *lun,
449				  union ctl_ha_msg *msg);
450static void ctl_hndl_per_res_out_on_other_sc(union ctl_ha_msg *msg);
451static int ctl_inquiry_evpd_supported(struct ctl_scsiio *ctsio, int alloc_len);
452static int ctl_inquiry_evpd_serial(struct ctl_scsiio *ctsio, int alloc_len);
453static int ctl_inquiry_evpd_devid(struct ctl_scsiio *ctsio, int alloc_len);
454static int ctl_inquiry_evpd_eid(struct ctl_scsiio *ctsio, int alloc_len);
455static int ctl_inquiry_evpd_mpp(struct ctl_scsiio *ctsio, int alloc_len);
456static int ctl_inquiry_evpd_scsi_ports(struct ctl_scsiio *ctsio,
457					 int alloc_len);
458static int ctl_inquiry_evpd_block_limits(struct ctl_scsiio *ctsio,
459					 int alloc_len);
460static int ctl_inquiry_evpd_bdc(struct ctl_scsiio *ctsio, int alloc_len);
461static int ctl_inquiry_evpd_lbp(struct ctl_scsiio *ctsio, int alloc_len);
462static int ctl_inquiry_evpd(struct ctl_scsiio *ctsio);
463static int ctl_inquiry_std(struct ctl_scsiio *ctsio);
464static int ctl_get_lba_len(union ctl_io *io, uint64_t *lba, uint64_t *len);
465static ctl_action ctl_extent_check(union ctl_io *io1, union ctl_io *io2,
466    bool seq);
467static ctl_action ctl_extent_check_seq(union ctl_io *io1, union ctl_io *io2);
468static ctl_action ctl_check_for_blockage(struct ctl_lun *lun,
469    union ctl_io *pending_io, union ctl_io *ooa_io);
470static ctl_action ctl_check_ooa(struct ctl_lun *lun, union ctl_io *pending_io,
471				union ctl_io *starting_io);
472static int ctl_check_blocked(struct ctl_lun *lun);
473static int ctl_scsiio_lun_check(struct ctl_lun *lun,
474				const struct ctl_cmd_entry *entry,
475				struct ctl_scsiio *ctsio);
476static void ctl_failover_lun(union ctl_io *io);
477static int ctl_scsiio_precheck(struct ctl_softc *ctl_softc,
478			       struct ctl_scsiio *ctsio);
479static int ctl_scsiio(struct ctl_scsiio *ctsio);
480
481static int ctl_bus_reset(struct ctl_softc *ctl_softc, union ctl_io *io);
482static int ctl_target_reset(struct ctl_softc *ctl_softc, union ctl_io *io,
483			    ctl_ua_type ua_type);
484static int ctl_do_lun_reset(struct ctl_lun *lun, union ctl_io *io,
485			 ctl_ua_type ua_type);
486static int ctl_lun_reset(struct ctl_softc *ctl_softc, union ctl_io *io);
487static int ctl_abort_task(union ctl_io *io);
488static int ctl_abort_task_set(union ctl_io *io);
489static int ctl_query_task(union ctl_io *io, int task_set);
490static int ctl_i_t_nexus_reset(union ctl_io *io);
491static int ctl_query_async_event(union ctl_io *io);
492static void ctl_run_task(union ctl_io *io);
493#ifdef CTL_IO_DELAY
494static void ctl_datamove_timer_wakeup(void *arg);
495static void ctl_done_timer_wakeup(void *arg);
496#endif /* CTL_IO_DELAY */
497
498static void ctl_send_datamove_done(union ctl_io *io, int have_lock);
499static void ctl_datamove_remote_write_cb(struct ctl_ha_dt_req *rq);
500static int ctl_datamove_remote_dm_write_cb(union ctl_io *io);
501static void ctl_datamove_remote_write(union ctl_io *io);
502static int ctl_datamove_remote_dm_read_cb(union ctl_io *io);
503static void ctl_datamove_remote_read_cb(struct ctl_ha_dt_req *rq);
504static int ctl_datamove_remote_sgl_setup(union ctl_io *io);
505static int ctl_datamove_remote_xfer(union ctl_io *io, unsigned command,
506				    ctl_ha_dt_cb callback);
507static void ctl_datamove_remote_read(union ctl_io *io);
508static void ctl_datamove_remote(union ctl_io *io);
509static void ctl_process_done(union ctl_io *io);
510static void ctl_lun_thread(void *arg);
511static void ctl_thresh_thread(void *arg);
512static void ctl_work_thread(void *arg);
513static void ctl_enqueue_incoming(union ctl_io *io);
514static void ctl_enqueue_rtr(union ctl_io *io);
515static void ctl_enqueue_done(union ctl_io *io);
516static void ctl_enqueue_isc(union ctl_io *io);
517static const struct ctl_cmd_entry *
518    ctl_get_cmd_entry(struct ctl_scsiio *ctsio, int *sa);
519static const struct ctl_cmd_entry *
520    ctl_validate_command(struct ctl_scsiio *ctsio);
521static int ctl_cmd_applicable(uint8_t lun_type,
522    const struct ctl_cmd_entry *entry);
523
524static uint64_t ctl_get_prkey(struct ctl_lun *lun, uint32_t residx);
525static void ctl_clr_prkey(struct ctl_lun *lun, uint32_t residx);
526static void ctl_alloc_prkey(struct ctl_lun *lun, uint32_t residx);
527static void ctl_set_prkey(struct ctl_lun *lun, uint32_t residx, uint64_t key);
528
529/*
530 * Load the serialization table.  This isn't very pretty, but is probably
531 * the easiest way to do it.
532 */
533#include "ctl_ser_table.c"
534
535/*
536 * We only need to define open, close and ioctl routines for this driver.
537 */
538static struct cdevsw ctl_cdevsw = {
539	.d_version =	D_VERSION,
540	.d_flags =	0,
541	.d_open =	ctl_open,
542	.d_close =	ctl_close,
543	.d_ioctl =	ctl_ioctl,
544	.d_name =	"ctl",
545};
546
547
548MALLOC_DEFINE(M_CTL, "ctlmem", "Memory used for CTL");
549
550static int ctl_module_event_handler(module_t, int /*modeventtype_t*/, void *);
551
552static moduledata_t ctl_moduledata = {
553	"ctl",
554	ctl_module_event_handler,
555	NULL
556};
557
558DECLARE_MODULE(ctl, ctl_moduledata, SI_SUB_CONFIGURE, SI_ORDER_THIRD);
559MODULE_VERSION(ctl, 1);
560
561static struct ctl_frontend ha_frontend =
562{
563	.name = "ha",
564};
565
566static void
567ctl_ha_datamove(union ctl_io *io)
568{
569	struct ctl_lun *lun;
570	struct ctl_sg_entry *sgl;
571	union ctl_ha_msg msg;
572	uint32_t sg_entries_sent;
573	int do_sg_copy, i, j;
574
575	lun = (struct ctl_lun *)io->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
576	memset(&msg.dt, 0, sizeof(msg.dt));
577	msg.hdr.msg_type = CTL_MSG_DATAMOVE;
578	msg.hdr.original_sc = io->io_hdr.original_sc;
579	msg.hdr.serializing_sc = io;
580	msg.hdr.nexus = io->io_hdr.nexus;
581	msg.hdr.status = io->io_hdr.status;
582	msg.dt.flags = io->io_hdr.flags;
583
584	/*
585	 * We convert everything into a S/G list here.  We can't
586	 * pass by reference, only by value between controllers.
587	 * So we can't pass a pointer to the S/G list, only as many
588	 * S/G entries as we can fit in here.  If it's possible for
589	 * us to get more than CTL_HA_MAX_SG_ENTRIES S/G entries,
590	 * then we need to break this up into multiple transfers.
591	 */
592	if (io->scsiio.kern_sg_entries == 0) {
593		msg.dt.kern_sg_entries = 1;
594#if 0
595		if (io->io_hdr.flags & CTL_FLAG_BUS_ADDR) {
596			msg.dt.sg_list[0].addr = io->scsiio.kern_data_ptr;
597		} else {
598			/* XXX KDM use busdma here! */
599			msg.dt.sg_list[0].addr =
600			    (void *)vtophys(io->scsiio.kern_data_ptr);
601		}
602#else
603		KASSERT((io->io_hdr.flags & CTL_FLAG_BUS_ADDR) == 0,
604		    ("HA does not support BUS_ADDR"));
605		msg.dt.sg_list[0].addr = io->scsiio.kern_data_ptr;
606#endif
607		msg.dt.sg_list[0].len = io->scsiio.kern_data_len;
608		do_sg_copy = 0;
609	} else {
610		msg.dt.kern_sg_entries = io->scsiio.kern_sg_entries;
611		do_sg_copy = 1;
612	}
613
614	msg.dt.kern_data_len = io->scsiio.kern_data_len;
615	msg.dt.kern_total_len = io->scsiio.kern_total_len;
616	msg.dt.kern_data_resid = io->scsiio.kern_data_resid;
617	msg.dt.kern_rel_offset = io->scsiio.kern_rel_offset;
618	msg.dt.sg_sequence = 0;
619
620	/*
621	 * Loop until we've sent all of the S/G entries.  On the
622	 * other end, we'll recompose these S/G entries into one
623	 * contiguous list before processing.
624	 */
625	for (sg_entries_sent = 0; sg_entries_sent < msg.dt.kern_sg_entries;
626	    msg.dt.sg_sequence++) {
627		msg.dt.cur_sg_entries = MIN((sizeof(msg.dt.sg_list) /
628		    sizeof(msg.dt.sg_list[0])),
629		    msg.dt.kern_sg_entries - sg_entries_sent);
630		if (do_sg_copy != 0) {
631			sgl = (struct ctl_sg_entry *)io->scsiio.kern_data_ptr;
632			for (i = sg_entries_sent, j = 0;
633			     i < msg.dt.cur_sg_entries; i++, j++) {
634#if 0
635				if (io->io_hdr.flags & CTL_FLAG_BUS_ADDR) {
636					msg.dt.sg_list[j].addr = sgl[i].addr;
637				} else {
638					/* XXX KDM use busdma here! */
639					msg.dt.sg_list[j].addr =
640					    (void *)vtophys(sgl[i].addr);
641				}
642#else
643				KASSERT((io->io_hdr.flags &
644				    CTL_FLAG_BUS_ADDR) == 0,
645				    ("HA does not support BUS_ADDR"));
646				msg.dt.sg_list[j].addr = sgl[i].addr;
647#endif
648				msg.dt.sg_list[j].len = sgl[i].len;
649			}
650		}
651
652		sg_entries_sent += msg.dt.cur_sg_entries;
653		msg.dt.sg_last = (sg_entries_sent >= msg.dt.kern_sg_entries);
654		if (ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg,
655		    sizeof(msg.dt) - sizeof(msg.dt.sg_list) +
656		    sizeof(struct ctl_sg_entry) * msg.dt.cur_sg_entries,
657		    M_WAITOK) > CTL_HA_STATUS_SUCCESS) {
658			io->io_hdr.port_status = 31341;
659			io->scsiio.be_move_done(io);
660			return;
661		}
662		msg.dt.sent_sg_entries = sg_entries_sent;
663	}
664
665	/*
666	 * Officially handover the request from us to peer.
667	 * If failover has just happened, then we must return error.
668	 * If failover happen just after, then it is not our problem.
669	 */
670	if (lun)
671		mtx_lock(&lun->lun_lock);
672	if (io->io_hdr.flags & CTL_FLAG_FAILOVER) {
673		if (lun)
674			mtx_unlock(&lun->lun_lock);
675		io->io_hdr.port_status = 31342;
676		io->scsiio.be_move_done(io);
677		return;
678	}
679	io->io_hdr.flags &= ~CTL_FLAG_IO_ACTIVE;
680	io->io_hdr.flags |= CTL_FLAG_DMA_INPROG;
681	if (lun)
682		mtx_unlock(&lun->lun_lock);
683}
684
685static void
686ctl_ha_done(union ctl_io *io)
687{
688	union ctl_ha_msg msg;
689
690	if (io->io_hdr.io_type == CTL_IO_SCSI) {
691		memset(&msg, 0, sizeof(msg));
692		msg.hdr.msg_type = CTL_MSG_FINISH_IO;
693		msg.hdr.original_sc = io->io_hdr.original_sc;
694		msg.hdr.nexus = io->io_hdr.nexus;
695		msg.hdr.status = io->io_hdr.status;
696		msg.scsi.scsi_status = io->scsiio.scsi_status;
697		msg.scsi.tag_num = io->scsiio.tag_num;
698		msg.scsi.tag_type = io->scsiio.tag_type;
699		msg.scsi.sense_len = io->scsiio.sense_len;
700		msg.scsi.sense_residual = io->scsiio.sense_residual;
701		msg.scsi.residual = io->scsiio.residual;
702		memcpy(&msg.scsi.sense_data, &io->scsiio.sense_data,
703		    io->scsiio.sense_len);
704		ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg,
705		    sizeof(msg.scsi) - sizeof(msg.scsi.sense_data) +
706		    msg.scsi.sense_len, M_WAITOK);
707	}
708	ctl_free_io(io);
709}
710
711static void
712ctl_isc_handler_finish_xfer(struct ctl_softc *ctl_softc,
713			    union ctl_ha_msg *msg_info)
714{
715	struct ctl_scsiio *ctsio;
716
717	if (msg_info->hdr.original_sc == NULL) {
718		printf("%s: original_sc == NULL!\n", __func__);
719		/* XXX KDM now what? */
720		return;
721	}
722
723	ctsio = &msg_info->hdr.original_sc->scsiio;
724	ctsio->io_hdr.flags |= CTL_FLAG_IO_ACTIVE;
725	ctsio->io_hdr.msg_type = CTL_MSG_FINISH_IO;
726	ctsio->io_hdr.status = msg_info->hdr.status;
727	ctsio->scsi_status = msg_info->scsi.scsi_status;
728	ctsio->sense_len = msg_info->scsi.sense_len;
729	ctsio->sense_residual = msg_info->scsi.sense_residual;
730	ctsio->residual = msg_info->scsi.residual;
731	memcpy(&ctsio->sense_data, &msg_info->scsi.sense_data,
732	       msg_info->scsi.sense_len);
733	ctl_enqueue_isc((union ctl_io *)ctsio);
734}
735
736static void
737ctl_isc_handler_finish_ser_only(struct ctl_softc *ctl_softc,
738				union ctl_ha_msg *msg_info)
739{
740	struct ctl_scsiio *ctsio;
741
742	if (msg_info->hdr.serializing_sc == NULL) {
743		printf("%s: serializing_sc == NULL!\n", __func__);
744		/* XXX KDM now what? */
745		return;
746	}
747
748	ctsio = &msg_info->hdr.serializing_sc->scsiio;
749	ctsio->io_hdr.msg_type = CTL_MSG_FINISH_IO;
750	ctl_enqueue_isc((union ctl_io *)ctsio);
751}
752
753void
754ctl_isc_announce_lun(struct ctl_lun *lun)
755{
756	struct ctl_softc *softc = lun->ctl_softc;
757	union ctl_ha_msg *msg;
758	struct ctl_ha_msg_lun_pr_key pr_key;
759	int i, k;
760
761	if (softc->ha_link != CTL_HA_LINK_ONLINE)
762		return;
763	mtx_lock(&lun->lun_lock);
764	i = sizeof(msg->lun);
765	if (lun->lun_devid)
766		i += lun->lun_devid->len;
767	i += sizeof(pr_key) * lun->pr_key_count;
768alloc:
769	mtx_unlock(&lun->lun_lock);
770	msg = malloc(i, M_CTL, M_WAITOK);
771	mtx_lock(&lun->lun_lock);
772	k = sizeof(msg->lun);
773	if (lun->lun_devid)
774		k += lun->lun_devid->len;
775	k += sizeof(pr_key) * lun->pr_key_count;
776	if (i < k) {
777		free(msg, M_CTL);
778		i = k;
779		goto alloc;
780	}
781	bzero(&msg->lun, sizeof(msg->lun));
782	msg->hdr.msg_type = CTL_MSG_LUN_SYNC;
783	msg->hdr.nexus.targ_lun = lun->lun;
784	msg->hdr.nexus.targ_mapped_lun = lun->lun;
785	msg->lun.flags = lun->flags;
786	msg->lun.pr_generation = lun->pr_generation;
787	msg->lun.pr_res_idx = lun->pr_res_idx;
788	msg->lun.pr_res_type = lun->pr_res_type;
789	msg->lun.pr_key_count = lun->pr_key_count;
790	i = 0;
791	if (lun->lun_devid) {
792		msg->lun.lun_devid_len = lun->lun_devid->len;
793		memcpy(&msg->lun.data[i], lun->lun_devid->data,
794		    msg->lun.lun_devid_len);
795		i += msg->lun.lun_devid_len;
796	}
797	for (k = 0; k < CTL_MAX_INITIATORS; k++) {
798		if ((pr_key.pr_key = ctl_get_prkey(lun, k)) == 0)
799			continue;
800		pr_key.pr_iid = k;
801		memcpy(&msg->lun.data[i], &pr_key, sizeof(pr_key));
802		i += sizeof(pr_key);
803	}
804	mtx_unlock(&lun->lun_lock);
805	ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg->port, sizeof(msg->port) + i,
806	    M_WAITOK);
807	free(msg, M_CTL);
808
809	if (lun->flags & CTL_LUN_PRIMARY_SC) {
810		for (i = 0; i < CTL_NUM_MODE_PAGES; i++) {
811			ctl_isc_announce_mode(lun, -1,
812			    lun->mode_pages.index[i].page_code & SMPH_PC_MASK,
813			    lun->mode_pages.index[i].subpage);
814		}
815	}
816}
817
818void
819ctl_isc_announce_port(struct ctl_port *port)
820{
821	struct ctl_softc *softc = port->ctl_softc;
822	union ctl_ha_msg *msg;
823	int i;
824
825	if (port->targ_port < softc->port_min ||
826	    port->targ_port >= softc->port_max ||
827	    softc->ha_link != CTL_HA_LINK_ONLINE)
828		return;
829	i = sizeof(msg->port) + strlen(port->port_name) + 1;
830	if (port->lun_map)
831		i += sizeof(uint32_t) * CTL_MAX_LUNS;
832	if (port->port_devid)
833		i += port->port_devid->len;
834	if (port->target_devid)
835		i += port->target_devid->len;
836	if (port->init_devid)
837		i += port->init_devid->len;
838	msg = malloc(i, M_CTL, M_WAITOK);
839	bzero(&msg->port, sizeof(msg->port));
840	msg->hdr.msg_type = CTL_MSG_PORT_SYNC;
841	msg->hdr.nexus.targ_port = port->targ_port;
842	msg->port.port_type = port->port_type;
843	msg->port.physical_port = port->physical_port;
844	msg->port.virtual_port = port->virtual_port;
845	msg->port.status = port->status;
846	i = 0;
847	msg->port.name_len = sprintf(&msg->port.data[i],
848	    "%d:%s", softc->ha_id, port->port_name) + 1;
849	i += msg->port.name_len;
850	if (port->lun_map) {
851		msg->port.lun_map_len = sizeof(uint32_t) * CTL_MAX_LUNS;
852		memcpy(&msg->port.data[i], port->lun_map,
853		    msg->port.lun_map_len);
854		i += msg->port.lun_map_len;
855	}
856	if (port->port_devid) {
857		msg->port.port_devid_len = port->port_devid->len;
858		memcpy(&msg->port.data[i], port->port_devid->data,
859		    msg->port.port_devid_len);
860		i += msg->port.port_devid_len;
861	}
862	if (port->target_devid) {
863		msg->port.target_devid_len = port->target_devid->len;
864		memcpy(&msg->port.data[i], port->target_devid->data,
865		    msg->port.target_devid_len);
866		i += msg->port.target_devid_len;
867	}
868	if (port->init_devid) {
869		msg->port.init_devid_len = port->init_devid->len;
870		memcpy(&msg->port.data[i], port->init_devid->data,
871		    msg->port.init_devid_len);
872		i += msg->port.init_devid_len;
873	}
874	ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg->port, sizeof(msg->port) + i,
875	    M_WAITOK);
876	free(msg, M_CTL);
877}
878
879void
880ctl_isc_announce_iid(struct ctl_port *port, int iid)
881{
882	struct ctl_softc *softc = port->ctl_softc;
883	union ctl_ha_msg *msg;
884	int i, l;
885
886	if (port->targ_port < softc->port_min ||
887	    port->targ_port >= softc->port_max ||
888	    softc->ha_link != CTL_HA_LINK_ONLINE)
889		return;
890	mtx_lock(&softc->ctl_lock);
891	i = sizeof(msg->iid);
892	l = 0;
893	if (port->wwpn_iid[iid].name)
894		l = strlen(port->wwpn_iid[iid].name) + 1;
895	i += l;
896	msg = malloc(i, M_CTL, M_NOWAIT);
897	if (msg == NULL) {
898		mtx_unlock(&softc->ctl_lock);
899		return;
900	}
901	bzero(&msg->iid, sizeof(msg->iid));
902	msg->hdr.msg_type = CTL_MSG_IID_SYNC;
903	msg->hdr.nexus.targ_port = port->targ_port;
904	msg->hdr.nexus.initid = iid;
905	msg->iid.in_use = port->wwpn_iid[iid].in_use;
906	msg->iid.name_len = l;
907	msg->iid.wwpn = port->wwpn_iid[iid].wwpn;
908	if (port->wwpn_iid[iid].name)
909		strlcpy(msg->iid.data, port->wwpn_iid[iid].name, l);
910	mtx_unlock(&softc->ctl_lock);
911	ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg->iid, i, M_NOWAIT);
912	free(msg, M_CTL);
913}
914
915void
916ctl_isc_announce_mode(struct ctl_lun *lun, uint32_t initidx,
917    uint8_t page, uint8_t subpage)
918{
919	struct ctl_softc *softc = lun->ctl_softc;
920	union ctl_ha_msg msg;
921	u_int i;
922
923	if (softc->ha_link != CTL_HA_LINK_ONLINE)
924		return;
925	for (i = 0; i < CTL_NUM_MODE_PAGES; i++) {
926		if ((lun->mode_pages.index[i].page_code & SMPH_PC_MASK) ==
927		    page && lun->mode_pages.index[i].subpage == subpage)
928			break;
929	}
930	if (i == CTL_NUM_MODE_PAGES)
931		return;
932
933	/* Don't try to replicate pages not present on this device. */
934	if (lun->mode_pages.index[i].page_data == NULL)
935		return;
936
937	bzero(&msg.mode, sizeof(msg.mode));
938	msg.hdr.msg_type = CTL_MSG_MODE_SYNC;
939	msg.hdr.nexus.targ_port = initidx / CTL_MAX_INIT_PER_PORT;
940	msg.hdr.nexus.initid = initidx % CTL_MAX_INIT_PER_PORT;
941	msg.hdr.nexus.targ_lun = lun->lun;
942	msg.hdr.nexus.targ_mapped_lun = lun->lun;
943	msg.mode.page_code = page;
944	msg.mode.subpage = subpage;
945	msg.mode.page_len = lun->mode_pages.index[i].page_len;
946	memcpy(msg.mode.data, lun->mode_pages.index[i].page_data,
947	    msg.mode.page_len);
948	ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg.mode, sizeof(msg.mode),
949	    M_WAITOK);
950}
951
952static void
953ctl_isc_ha_link_up(struct ctl_softc *softc)
954{
955	struct ctl_port *port;
956	struct ctl_lun *lun;
957	union ctl_ha_msg msg;
958	int i;
959
960	/* Announce this node parameters to peer for validation. */
961	msg.login.msg_type = CTL_MSG_LOGIN;
962	msg.login.version = CTL_HA_VERSION;
963	msg.login.ha_mode = softc->ha_mode;
964	msg.login.ha_id = softc->ha_id;
965	msg.login.max_luns = CTL_MAX_LUNS;
966	msg.login.max_ports = CTL_MAX_PORTS;
967	msg.login.max_init_per_port = CTL_MAX_INIT_PER_PORT;
968	ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg.login, sizeof(msg.login),
969	    M_WAITOK);
970
971	STAILQ_FOREACH(port, &softc->port_list, links) {
972		ctl_isc_announce_port(port);
973		for (i = 0; i < CTL_MAX_INIT_PER_PORT; i++) {
974			if (port->wwpn_iid[i].in_use)
975				ctl_isc_announce_iid(port, i);
976		}
977	}
978	STAILQ_FOREACH(lun, &softc->lun_list, links)
979		ctl_isc_announce_lun(lun);
980}
981
982static void
983ctl_isc_ha_link_down(struct ctl_softc *softc)
984{
985	struct ctl_port *port;
986	struct ctl_lun *lun;
987	union ctl_io *io;
988	int i;
989
990	mtx_lock(&softc->ctl_lock);
991	STAILQ_FOREACH(lun, &softc->lun_list, links) {
992		mtx_lock(&lun->lun_lock);
993		if (lun->flags & CTL_LUN_PEER_SC_PRIMARY) {
994			lun->flags &= ~CTL_LUN_PEER_SC_PRIMARY;
995			ctl_est_ua_all(lun, -1, CTL_UA_ASYM_ACC_CHANGE);
996		}
997		mtx_unlock(&lun->lun_lock);
998
999		mtx_unlock(&softc->ctl_lock);
1000		io = ctl_alloc_io(softc->othersc_pool);
1001		mtx_lock(&softc->ctl_lock);
1002		ctl_zero_io(io);
1003		io->io_hdr.msg_type = CTL_MSG_FAILOVER;
1004		io->io_hdr.nexus.targ_mapped_lun = lun->lun;
1005		ctl_enqueue_isc(io);
1006	}
1007
1008	STAILQ_FOREACH(port, &softc->port_list, links) {
1009		if (port->targ_port >= softc->port_min &&
1010		    port->targ_port < softc->port_max)
1011			continue;
1012		port->status &= ~CTL_PORT_STATUS_ONLINE;
1013		for (i = 0; i < CTL_MAX_INIT_PER_PORT; i++) {
1014			port->wwpn_iid[i].in_use = 0;
1015			free(port->wwpn_iid[i].name, M_CTL);
1016			port->wwpn_iid[i].name = NULL;
1017		}
1018	}
1019	mtx_unlock(&softc->ctl_lock);
1020}
1021
1022static void
1023ctl_isc_ua(struct ctl_softc *softc, union ctl_ha_msg *msg, int len)
1024{
1025	struct ctl_lun *lun;
1026	uint32_t iid = ctl_get_initindex(&msg->hdr.nexus);
1027
1028	mtx_lock(&softc->ctl_lock);
1029	if (msg->hdr.nexus.targ_lun < CTL_MAX_LUNS &&
1030	    (lun = softc->ctl_luns[msg->hdr.nexus.targ_mapped_lun]) != NULL) {
1031		mtx_lock(&lun->lun_lock);
1032		mtx_unlock(&softc->ctl_lock);
1033		if (msg->ua.ua_type == CTL_UA_THIN_PROV_THRES &&
1034		    msg->ua.ua_set)
1035			memcpy(lun->ua_tpt_info, msg->ua.ua_info, 8);
1036		if (msg->ua.ua_all) {
1037			if (msg->ua.ua_set)
1038				ctl_est_ua_all(lun, iid, msg->ua.ua_type);
1039			else
1040				ctl_clr_ua_all(lun, iid, msg->ua.ua_type);
1041		} else {
1042			if (msg->ua.ua_set)
1043				ctl_est_ua(lun, iid, msg->ua.ua_type);
1044			else
1045				ctl_clr_ua(lun, iid, msg->ua.ua_type);
1046		}
1047		mtx_unlock(&lun->lun_lock);
1048	} else
1049		mtx_unlock(&softc->ctl_lock);
1050}
1051
1052static void
1053ctl_isc_lun_sync(struct ctl_softc *softc, union ctl_ha_msg *msg, int len)
1054{
1055	struct ctl_lun *lun;
1056	struct ctl_ha_msg_lun_pr_key pr_key;
1057	int i, k;
1058	ctl_lun_flags oflags;
1059	uint32_t targ_lun;
1060
1061	targ_lun = msg->hdr.nexus.targ_mapped_lun;
1062	mtx_lock(&softc->ctl_lock);
1063	if ((targ_lun >= CTL_MAX_LUNS) ||
1064	    ((lun = softc->ctl_luns[targ_lun]) == NULL)) {
1065		mtx_unlock(&softc->ctl_lock);
1066		return;
1067	}
1068	mtx_lock(&lun->lun_lock);
1069	mtx_unlock(&softc->ctl_lock);
1070	if (lun->flags & CTL_LUN_DISABLED) {
1071		mtx_unlock(&lun->lun_lock);
1072		return;
1073	}
1074	i = (lun->lun_devid != NULL) ? lun->lun_devid->len : 0;
1075	if (msg->lun.lun_devid_len != i || (i > 0 &&
1076	    memcmp(&msg->lun.data[0], lun->lun_devid->data, i) != 0)) {
1077		mtx_unlock(&lun->lun_lock);
1078		printf("%s: Received conflicting HA LUN %d\n",
1079		    __func__, msg->hdr.nexus.targ_lun);
1080		return;
1081	} else {
1082		/* Record whether peer is primary. */
1083		oflags = lun->flags;
1084		if ((msg->lun.flags & CTL_LUN_PRIMARY_SC) &&
1085		    (msg->lun.flags & CTL_LUN_DISABLED) == 0)
1086			lun->flags |= CTL_LUN_PEER_SC_PRIMARY;
1087		else
1088			lun->flags &= ~CTL_LUN_PEER_SC_PRIMARY;
1089		if (oflags != lun->flags)
1090			ctl_est_ua_all(lun, -1, CTL_UA_ASYM_ACC_CHANGE);
1091
1092		/* If peer is primary and we are not -- use data */
1093		if ((lun->flags & CTL_LUN_PRIMARY_SC) == 0 &&
1094		    (lun->flags & CTL_LUN_PEER_SC_PRIMARY)) {
1095			lun->pr_generation = msg->lun.pr_generation;
1096			lun->pr_res_idx = msg->lun.pr_res_idx;
1097			lun->pr_res_type = msg->lun.pr_res_type;
1098			lun->pr_key_count = msg->lun.pr_key_count;
1099			for (k = 0; k < CTL_MAX_INITIATORS; k++)
1100				ctl_clr_prkey(lun, k);
1101			for (k = 0; k < msg->lun.pr_key_count; k++) {
1102				memcpy(&pr_key, &msg->lun.data[i],
1103				    sizeof(pr_key));
1104				ctl_alloc_prkey(lun, pr_key.pr_iid);
1105				ctl_set_prkey(lun, pr_key.pr_iid,
1106				    pr_key.pr_key);
1107				i += sizeof(pr_key);
1108			}
1109		}
1110
1111		mtx_unlock(&lun->lun_lock);
1112		CTL_DEBUG_PRINT(("%s: Known LUN %d, peer is %s\n",
1113		    __func__, msg->hdr.nexus.targ_lun,
1114		    (msg->lun.flags & CTL_LUN_PRIMARY_SC) ?
1115		    "primary" : "secondary"));
1116
1117		/* If we are primary but peer doesn't know -- notify */
1118		if ((lun->flags & CTL_LUN_PRIMARY_SC) &&
1119		    (msg->lun.flags & CTL_LUN_PEER_SC_PRIMARY) == 0)
1120			ctl_isc_announce_lun(lun);
1121	}
1122}
1123
1124static void
1125ctl_isc_port_sync(struct ctl_softc *softc, union ctl_ha_msg *msg, int len)
1126{
1127	struct ctl_port *port;
1128	struct ctl_lun *lun;
1129	int i, new;
1130
1131	port = softc->ctl_ports[msg->hdr.nexus.targ_port];
1132	if (port == NULL) {
1133		CTL_DEBUG_PRINT(("%s: New port %d\n", __func__,
1134		    msg->hdr.nexus.targ_port));
1135		new = 1;
1136		port = malloc(sizeof(*port), M_CTL, M_WAITOK | M_ZERO);
1137		port->frontend = &ha_frontend;
1138		port->targ_port = msg->hdr.nexus.targ_port;
1139		port->fe_datamove = ctl_ha_datamove;
1140		port->fe_done = ctl_ha_done;
1141	} else if (port->frontend == &ha_frontend) {
1142		CTL_DEBUG_PRINT(("%s: Updated port %d\n", __func__,
1143		    msg->hdr.nexus.targ_port));
1144		new = 0;
1145	} else {
1146		printf("%s: Received conflicting HA port %d\n",
1147		    __func__, msg->hdr.nexus.targ_port);
1148		return;
1149	}
1150	port->port_type = msg->port.port_type;
1151	port->physical_port = msg->port.physical_port;
1152	port->virtual_port = msg->port.virtual_port;
1153	port->status = msg->port.status;
1154	i = 0;
1155	free(port->port_name, M_CTL);
1156	port->port_name = strndup(&msg->port.data[i], msg->port.name_len,
1157	    M_CTL);
1158	i += msg->port.name_len;
1159	if (msg->port.lun_map_len != 0) {
1160		if (port->lun_map == NULL)
1161			port->lun_map = malloc(sizeof(uint32_t) * CTL_MAX_LUNS,
1162			    M_CTL, M_WAITOK);
1163		memcpy(port->lun_map, &msg->port.data[i],
1164		    sizeof(uint32_t) * CTL_MAX_LUNS);
1165		i += msg->port.lun_map_len;
1166	} else {
1167		free(port->lun_map, M_CTL);
1168		port->lun_map = NULL;
1169	}
1170	if (msg->port.port_devid_len != 0) {
1171		if (port->port_devid == NULL ||
1172		    port->port_devid->len != msg->port.port_devid_len) {
1173			free(port->port_devid, M_CTL);
1174			port->port_devid = malloc(sizeof(struct ctl_devid) +
1175			    msg->port.port_devid_len, M_CTL, M_WAITOK);
1176		}
1177		memcpy(port->port_devid->data, &msg->port.data[i],
1178		    msg->port.port_devid_len);
1179		port->port_devid->len = msg->port.port_devid_len;
1180		i += msg->port.port_devid_len;
1181	} else {
1182		free(port->port_devid, M_CTL);
1183		port->port_devid = NULL;
1184	}
1185	if (msg->port.target_devid_len != 0) {
1186		if (port->target_devid == NULL ||
1187		    port->target_devid->len != msg->port.target_devid_len) {
1188			free(port->target_devid, M_CTL);
1189			port->target_devid = malloc(sizeof(struct ctl_devid) +
1190			    msg->port.target_devid_len, M_CTL, M_WAITOK);
1191		}
1192		memcpy(port->target_devid->data, &msg->port.data[i],
1193		    msg->port.target_devid_len);
1194		port->target_devid->len = msg->port.target_devid_len;
1195		i += msg->port.target_devid_len;
1196	} else {
1197		free(port->target_devid, M_CTL);
1198		port->target_devid = NULL;
1199	}
1200	if (msg->port.init_devid_len != 0) {
1201		if (port->init_devid == NULL ||
1202		    port->init_devid->len != msg->port.init_devid_len) {
1203			free(port->init_devid, M_CTL);
1204			port->init_devid = malloc(sizeof(struct ctl_devid) +
1205			    msg->port.init_devid_len, M_CTL, M_WAITOK);
1206		}
1207		memcpy(port->init_devid->data, &msg->port.data[i],
1208		    msg->port.init_devid_len);
1209		port->init_devid->len = msg->port.init_devid_len;
1210		i += msg->port.init_devid_len;
1211	} else {
1212		free(port->init_devid, M_CTL);
1213		port->init_devid = NULL;
1214	}
1215	if (new) {
1216		if (ctl_port_register(port) != 0) {
1217			printf("%s: ctl_port_register() failed with error\n",
1218			    __func__);
1219		}
1220	}
1221	mtx_lock(&softc->ctl_lock);
1222	STAILQ_FOREACH(lun, &softc->lun_list, links) {
1223		if (ctl_lun_map_to_port(port, lun->lun) >= CTL_MAX_LUNS)
1224			continue;
1225		mtx_lock(&lun->lun_lock);
1226		ctl_est_ua_all(lun, -1, CTL_UA_INQ_CHANGE);
1227		mtx_unlock(&lun->lun_lock);
1228	}
1229	mtx_unlock(&softc->ctl_lock);
1230}
1231
1232static void
1233ctl_isc_iid_sync(struct ctl_softc *softc, union ctl_ha_msg *msg, int len)
1234{
1235	struct ctl_port *port;
1236	int iid;
1237
1238	port = softc->ctl_ports[msg->hdr.nexus.targ_port];
1239	if (port == NULL) {
1240		printf("%s: Received IID for unknown port %d\n",
1241		    __func__, msg->hdr.nexus.targ_port);
1242		return;
1243	}
1244	iid = msg->hdr.nexus.initid;
1245	port->wwpn_iid[iid].in_use = msg->iid.in_use;
1246	port->wwpn_iid[iid].wwpn = msg->iid.wwpn;
1247	free(port->wwpn_iid[iid].name, M_CTL);
1248	if (msg->iid.name_len) {
1249		port->wwpn_iid[iid].name = strndup(&msg->iid.data[0],
1250		    msg->iid.name_len, M_CTL);
1251	} else
1252		port->wwpn_iid[iid].name = NULL;
1253}
1254
1255static void
1256ctl_isc_login(struct ctl_softc *softc, union ctl_ha_msg *msg, int len)
1257{
1258
1259	if (msg->login.version != CTL_HA_VERSION) {
1260		printf("CTL HA peers have different versions %d != %d\n",
1261		    msg->login.version, CTL_HA_VERSION);
1262		ctl_ha_msg_abort(CTL_HA_CHAN_CTL);
1263		return;
1264	}
1265	if (msg->login.ha_mode != softc->ha_mode) {
1266		printf("CTL HA peers have different ha_mode %d != %d\n",
1267		    msg->login.ha_mode, softc->ha_mode);
1268		ctl_ha_msg_abort(CTL_HA_CHAN_CTL);
1269		return;
1270	}
1271	if (msg->login.ha_id == softc->ha_id) {
1272		printf("CTL HA peers have same ha_id %d\n", msg->login.ha_id);
1273		ctl_ha_msg_abort(CTL_HA_CHAN_CTL);
1274		return;
1275	}
1276	if (msg->login.max_luns != CTL_MAX_LUNS ||
1277	    msg->login.max_ports != CTL_MAX_PORTS ||
1278	    msg->login.max_init_per_port != CTL_MAX_INIT_PER_PORT) {
1279		printf("CTL HA peers have different limits\n");
1280		ctl_ha_msg_abort(CTL_HA_CHAN_CTL);
1281		return;
1282	}
1283}
1284
1285static void
1286ctl_isc_mode_sync(struct ctl_softc *softc, union ctl_ha_msg *msg, int len)
1287{
1288	struct ctl_lun *lun;
1289	u_int i;
1290	uint32_t initidx, targ_lun;
1291
1292	targ_lun = msg->hdr.nexus.targ_mapped_lun;
1293	mtx_lock(&softc->ctl_lock);
1294	if ((targ_lun >= CTL_MAX_LUNS) ||
1295	    ((lun = softc->ctl_luns[targ_lun]) == NULL)) {
1296		mtx_unlock(&softc->ctl_lock);
1297		return;
1298	}
1299	mtx_lock(&lun->lun_lock);
1300	mtx_unlock(&softc->ctl_lock);
1301	if (lun->flags & CTL_LUN_DISABLED) {
1302		mtx_unlock(&lun->lun_lock);
1303		return;
1304	}
1305	for (i = 0; i < CTL_NUM_MODE_PAGES; i++) {
1306		if ((lun->mode_pages.index[i].page_code & SMPH_PC_MASK) ==
1307		    msg->mode.page_code &&
1308		    lun->mode_pages.index[i].subpage == msg->mode.subpage)
1309			break;
1310	}
1311	if (i == CTL_NUM_MODE_PAGES) {
1312		mtx_unlock(&lun->lun_lock);
1313		return;
1314	}
1315	memcpy(lun->mode_pages.index[i].page_data, msg->mode.data,
1316	    lun->mode_pages.index[i].page_len);
1317	initidx = ctl_get_initindex(&msg->hdr.nexus);
1318	if (initidx != -1)
1319		ctl_est_ua_all(lun, initidx, CTL_UA_MODE_CHANGE);
1320	mtx_unlock(&lun->lun_lock);
1321}
1322
1323/*
1324 * ISC (Inter Shelf Communication) event handler.  Events from the HA
1325 * subsystem come in here.
1326 */
1327static void
1328ctl_isc_event_handler(ctl_ha_channel channel, ctl_ha_event event, int param)
1329{
1330	struct ctl_softc *softc = control_softc;
1331	union ctl_io *io;
1332	struct ctl_prio *presio;
1333	ctl_ha_status isc_status;
1334
1335	CTL_DEBUG_PRINT(("CTL: Isc Msg event %d\n", event));
1336	if (event == CTL_HA_EVT_MSG_RECV) {
1337		union ctl_ha_msg *msg, msgbuf;
1338
1339		if (param > sizeof(msgbuf))
1340			msg = malloc(param, M_CTL, M_WAITOK);
1341		else
1342			msg = &msgbuf;
1343		isc_status = ctl_ha_msg_recv(CTL_HA_CHAN_CTL, msg, param,
1344		    M_WAITOK);
1345		if (isc_status != CTL_HA_STATUS_SUCCESS) {
1346			printf("%s: Error receiving message: %d\n",
1347			    __func__, isc_status);
1348			if (msg != &msgbuf)
1349				free(msg, M_CTL);
1350			return;
1351		}
1352
1353		CTL_DEBUG_PRINT(("CTL: msg_type %d\n", msg->msg_type));
1354		switch (msg->hdr.msg_type) {
1355		case CTL_MSG_SERIALIZE:
1356			io = ctl_alloc_io(softc->othersc_pool);
1357			ctl_zero_io(io);
1358			// populate ctsio from msg
1359			io->io_hdr.io_type = CTL_IO_SCSI;
1360			io->io_hdr.msg_type = CTL_MSG_SERIALIZE;
1361			io->io_hdr.original_sc = msg->hdr.original_sc;
1362			io->io_hdr.flags |= CTL_FLAG_FROM_OTHER_SC |
1363					    CTL_FLAG_IO_ACTIVE;
1364			/*
1365			 * If we're in serialization-only mode, we don't
1366			 * want to go through full done processing.  Thus
1367			 * the COPY flag.
1368			 *
1369			 * XXX KDM add another flag that is more specific.
1370			 */
1371			if (softc->ha_mode != CTL_HA_MODE_XFER)
1372				io->io_hdr.flags |= CTL_FLAG_INT_COPY;
1373			io->io_hdr.nexus = msg->hdr.nexus;
1374#if 0
1375			printf("port %u, iid %u, lun %u\n",
1376			       io->io_hdr.nexus.targ_port,
1377			       io->io_hdr.nexus.initid,
1378			       io->io_hdr.nexus.targ_lun);
1379#endif
1380			io->scsiio.tag_num = msg->scsi.tag_num;
1381			io->scsiio.tag_type = msg->scsi.tag_type;
1382#ifdef CTL_TIME_IO
1383			io->io_hdr.start_time = time_uptime;
1384			getbinuptime(&io->io_hdr.start_bt);
1385#endif /* CTL_TIME_IO */
1386			io->scsiio.cdb_len = msg->scsi.cdb_len;
1387			memcpy(io->scsiio.cdb, msg->scsi.cdb,
1388			       CTL_MAX_CDBLEN);
1389			if (softc->ha_mode == CTL_HA_MODE_XFER) {
1390				const struct ctl_cmd_entry *entry;
1391
1392				entry = ctl_get_cmd_entry(&io->scsiio, NULL);
1393				io->io_hdr.flags &= ~CTL_FLAG_DATA_MASK;
1394				io->io_hdr.flags |=
1395					entry->flags & CTL_FLAG_DATA_MASK;
1396			}
1397			ctl_enqueue_isc(io);
1398			break;
1399
1400		/* Performed on the Originating SC, XFER mode only */
1401		case CTL_MSG_DATAMOVE: {
1402			struct ctl_sg_entry *sgl;
1403			int i, j;
1404
1405			io = msg->hdr.original_sc;
1406			if (io == NULL) {
1407				printf("%s: original_sc == NULL!\n", __func__);
1408				/* XXX KDM do something here */
1409				break;
1410			}
1411			io->io_hdr.msg_type = CTL_MSG_DATAMOVE;
1412			io->io_hdr.flags |= CTL_FLAG_IO_ACTIVE;
1413			/*
1414			 * Keep track of this, we need to send it back over
1415			 * when the datamove is complete.
1416			 */
1417			io->io_hdr.serializing_sc = msg->hdr.serializing_sc;
1418			if (msg->hdr.status == CTL_SUCCESS)
1419				io->io_hdr.status = msg->hdr.status;
1420
1421			if (msg->dt.sg_sequence == 0) {
1422#ifdef CTL_TIME_IO
1423				getbinuptime(&io->io_hdr.dma_start_bt);
1424#endif
1425				i = msg->dt.kern_sg_entries +
1426				    msg->dt.kern_data_len /
1427				    CTL_HA_DATAMOVE_SEGMENT + 1;
1428				sgl = malloc(sizeof(*sgl) * i, M_CTL,
1429				    M_WAITOK | M_ZERO);
1430				io->io_hdr.remote_sglist = sgl;
1431				io->io_hdr.local_sglist =
1432				    &sgl[msg->dt.kern_sg_entries];
1433
1434				io->scsiio.kern_data_ptr = (uint8_t *)sgl;
1435
1436				io->scsiio.kern_sg_entries =
1437					msg->dt.kern_sg_entries;
1438				io->scsiio.rem_sg_entries =
1439					msg->dt.kern_sg_entries;
1440				io->scsiio.kern_data_len =
1441					msg->dt.kern_data_len;
1442				io->scsiio.kern_total_len =
1443					msg->dt.kern_total_len;
1444				io->scsiio.kern_data_resid =
1445					msg->dt.kern_data_resid;
1446				io->scsiio.kern_rel_offset =
1447					msg->dt.kern_rel_offset;
1448				io->io_hdr.flags &= ~CTL_FLAG_BUS_ADDR;
1449				io->io_hdr.flags |= msg->dt.flags &
1450				    CTL_FLAG_BUS_ADDR;
1451			} else
1452				sgl = (struct ctl_sg_entry *)
1453					io->scsiio.kern_data_ptr;
1454
1455			for (i = msg->dt.sent_sg_entries, j = 0;
1456			     i < (msg->dt.sent_sg_entries +
1457			     msg->dt.cur_sg_entries); i++, j++) {
1458				sgl[i].addr = msg->dt.sg_list[j].addr;
1459				sgl[i].len = msg->dt.sg_list[j].len;
1460
1461#if 0
1462				printf("%s: DATAMOVE: %p,%lu j=%d, i=%d\n",
1463				    __func__, sgl[i].addr, sgl[i].len, j, i);
1464#endif
1465			}
1466
1467			/*
1468			 * If this is the last piece of the I/O, we've got
1469			 * the full S/G list.  Queue processing in the thread.
1470			 * Otherwise wait for the next piece.
1471			 */
1472			if (msg->dt.sg_last != 0)
1473				ctl_enqueue_isc(io);
1474			break;
1475		}
1476		/* Performed on the Serializing (primary) SC, XFER mode only */
1477		case CTL_MSG_DATAMOVE_DONE: {
1478			if (msg->hdr.serializing_sc == NULL) {
1479				printf("%s: serializing_sc == NULL!\n",
1480				       __func__);
1481				/* XXX KDM now what? */
1482				break;
1483			}
1484			/*
1485			 * We grab the sense information here in case
1486			 * there was a failure, so we can return status
1487			 * back to the initiator.
1488			 */
1489			io = msg->hdr.serializing_sc;
1490			io->io_hdr.msg_type = CTL_MSG_DATAMOVE_DONE;
1491			io->io_hdr.flags &= ~CTL_FLAG_DMA_INPROG;
1492			io->io_hdr.flags |= CTL_FLAG_IO_ACTIVE;
1493			io->io_hdr.port_status = msg->scsi.fetd_status;
1494			io->scsiio.residual = msg->scsi.residual;
1495			if (msg->hdr.status != CTL_STATUS_NONE) {
1496				io->io_hdr.status = msg->hdr.status;
1497				io->scsiio.scsi_status = msg->scsi.scsi_status;
1498				io->scsiio.sense_len = msg->scsi.sense_len;
1499				io->scsiio.sense_residual =msg->scsi.sense_residual;
1500				memcpy(&io->scsiio.sense_data,
1501				    &msg->scsi.sense_data,
1502				    msg->scsi.sense_len);
1503				if (msg->hdr.status == CTL_SUCCESS)
1504					io->io_hdr.flags |= CTL_FLAG_STATUS_SENT;
1505			}
1506			ctl_enqueue_isc(io);
1507			break;
1508		}
1509
1510		/* Preformed on Originating SC, SER_ONLY mode */
1511		case CTL_MSG_R2R:
1512			io = msg->hdr.original_sc;
1513			if (io == NULL) {
1514				printf("%s: original_sc == NULL!\n",
1515				    __func__);
1516				break;
1517			}
1518			io->io_hdr.flags |= CTL_FLAG_IO_ACTIVE;
1519			io->io_hdr.msg_type = CTL_MSG_R2R;
1520			io->io_hdr.serializing_sc = msg->hdr.serializing_sc;
1521			ctl_enqueue_isc(io);
1522			break;
1523
1524		/*
1525		 * Performed on Serializing(i.e. primary SC) SC in SER_ONLY
1526		 * mode.
1527		 * Performed on the Originating (i.e. secondary) SC in XFER
1528		 * mode
1529		 */
1530		case CTL_MSG_FINISH_IO:
1531			if (softc->ha_mode == CTL_HA_MODE_XFER)
1532				ctl_isc_handler_finish_xfer(softc, msg);
1533			else
1534				ctl_isc_handler_finish_ser_only(softc, msg);
1535			break;
1536
1537		/* Preformed on Originating SC */
1538		case CTL_MSG_BAD_JUJU:
1539			io = msg->hdr.original_sc;
1540			if (io == NULL) {
1541				printf("%s: Bad JUJU!, original_sc is NULL!\n",
1542				       __func__);
1543				break;
1544			}
1545			ctl_copy_sense_data(msg, io);
1546			/*
1547			 * IO should have already been cleaned up on other
1548			 * SC so clear this flag so we won't send a message
1549			 * back to finish the IO there.
1550			 */
1551			io->io_hdr.flags &= ~CTL_FLAG_SENT_2OTHER_SC;
1552			io->io_hdr.flags |= CTL_FLAG_IO_ACTIVE;
1553
1554			/* io = msg->hdr.serializing_sc; */
1555			io->io_hdr.msg_type = CTL_MSG_BAD_JUJU;
1556			ctl_enqueue_isc(io);
1557			break;
1558
1559		/* Handle resets sent from the other side */
1560		case CTL_MSG_MANAGE_TASKS: {
1561			struct ctl_taskio *taskio;
1562			taskio = (struct ctl_taskio *)ctl_alloc_io(
1563			    softc->othersc_pool);
1564			ctl_zero_io((union ctl_io *)taskio);
1565			taskio->io_hdr.io_type = CTL_IO_TASK;
1566			taskio->io_hdr.flags |= CTL_FLAG_FROM_OTHER_SC;
1567			taskio->io_hdr.nexus = msg->hdr.nexus;
1568			taskio->task_action = msg->task.task_action;
1569			taskio->tag_num = msg->task.tag_num;
1570			taskio->tag_type = msg->task.tag_type;
1571#ifdef CTL_TIME_IO
1572			taskio->io_hdr.start_time = time_uptime;
1573			getbinuptime(&taskio->io_hdr.start_bt);
1574#endif /* CTL_TIME_IO */
1575			ctl_run_task((union ctl_io *)taskio);
1576			break;
1577		}
1578		/* Persistent Reserve action which needs attention */
1579		case CTL_MSG_PERS_ACTION:
1580			presio = (struct ctl_prio *)ctl_alloc_io(
1581			    softc->othersc_pool);
1582			ctl_zero_io((union ctl_io *)presio);
1583			presio->io_hdr.msg_type = CTL_MSG_PERS_ACTION;
1584			presio->io_hdr.flags |= CTL_FLAG_FROM_OTHER_SC;
1585			presio->io_hdr.nexus = msg->hdr.nexus;
1586			presio->pr_msg = msg->pr;
1587			ctl_enqueue_isc((union ctl_io *)presio);
1588			break;
1589		case CTL_MSG_UA:
1590			ctl_isc_ua(softc, msg, param);
1591			break;
1592		case CTL_MSG_PORT_SYNC:
1593			ctl_isc_port_sync(softc, msg, param);
1594			break;
1595		case CTL_MSG_LUN_SYNC:
1596			ctl_isc_lun_sync(softc, msg, param);
1597			break;
1598		case CTL_MSG_IID_SYNC:
1599			ctl_isc_iid_sync(softc, msg, param);
1600			break;
1601		case CTL_MSG_LOGIN:
1602			ctl_isc_login(softc, msg, param);
1603			break;
1604		case CTL_MSG_MODE_SYNC:
1605			ctl_isc_mode_sync(softc, msg, param);
1606			break;
1607		default:
1608			printf("Received HA message of unknown type %d\n",
1609			    msg->hdr.msg_type);
1610			ctl_ha_msg_abort(CTL_HA_CHAN_CTL);
1611			break;
1612		}
1613		if (msg != &msgbuf)
1614			free(msg, M_CTL);
1615	} else if (event == CTL_HA_EVT_LINK_CHANGE) {
1616		printf("CTL: HA link status changed from %d to %d\n",
1617		    softc->ha_link, param);
1618		if (param == softc->ha_link)
1619			return;
1620		if (softc->ha_link == CTL_HA_LINK_ONLINE) {
1621			softc->ha_link = param;
1622			ctl_isc_ha_link_down(softc);
1623		} else {
1624			softc->ha_link = param;
1625			if (softc->ha_link == CTL_HA_LINK_ONLINE)
1626				ctl_isc_ha_link_up(softc);
1627		}
1628		return;
1629	} else {
1630		printf("ctl_isc_event_handler: Unknown event %d\n", event);
1631		return;
1632	}
1633}
1634
1635static void
1636ctl_copy_sense_data(union ctl_ha_msg *src, union ctl_io *dest)
1637{
1638
1639	memcpy(&dest->scsiio.sense_data, &src->scsi.sense_data,
1640	    src->scsi.sense_len);
1641	dest->scsiio.scsi_status = src->scsi.scsi_status;
1642	dest->scsiio.sense_len = src->scsi.sense_len;
1643	dest->io_hdr.status = src->hdr.status;
1644}
1645
1646static void
1647ctl_copy_sense_data_back(union ctl_io *src, union ctl_ha_msg *dest)
1648{
1649
1650	memcpy(&dest->scsi.sense_data, &src->scsiio.sense_data,
1651	    src->scsiio.sense_len);
1652	dest->scsi.scsi_status = src->scsiio.scsi_status;
1653	dest->scsi.sense_len = src->scsiio.sense_len;
1654	dest->hdr.status = src->io_hdr.status;
1655}
1656
1657void
1658ctl_est_ua(struct ctl_lun *lun, uint32_t initidx, ctl_ua_type ua)
1659{
1660	struct ctl_softc *softc = lun->ctl_softc;
1661	ctl_ua_type *pu;
1662
1663	if (initidx < softc->init_min || initidx >= softc->init_max)
1664		return;
1665	mtx_assert(&lun->lun_lock, MA_OWNED);
1666	pu = lun->pending_ua[initidx / CTL_MAX_INIT_PER_PORT];
1667	if (pu == NULL)
1668		return;
1669	pu[initidx % CTL_MAX_INIT_PER_PORT] |= ua;
1670}
1671
1672void
1673ctl_est_ua_port(struct ctl_lun *lun, int port, uint32_t except, ctl_ua_type ua)
1674{
1675	int i;
1676
1677	mtx_assert(&lun->lun_lock, MA_OWNED);
1678	if (lun->pending_ua[port] == NULL)
1679		return;
1680	for (i = 0; i < CTL_MAX_INIT_PER_PORT; i++) {
1681		if (port * CTL_MAX_INIT_PER_PORT + i == except)
1682			continue;
1683		lun->pending_ua[port][i] |= ua;
1684	}
1685}
1686
1687void
1688ctl_est_ua_all(struct ctl_lun *lun, uint32_t except, ctl_ua_type ua)
1689{
1690	struct ctl_softc *softc = lun->ctl_softc;
1691	int i;
1692
1693	mtx_assert(&lun->lun_lock, MA_OWNED);
1694	for (i = softc->port_min; i < softc->port_max; i++)
1695		ctl_est_ua_port(lun, i, except, ua);
1696}
1697
1698void
1699ctl_clr_ua(struct ctl_lun *lun, uint32_t initidx, ctl_ua_type ua)
1700{
1701	struct ctl_softc *softc = lun->ctl_softc;
1702	ctl_ua_type *pu;
1703
1704	if (initidx < softc->init_min || initidx >= softc->init_max)
1705		return;
1706	mtx_assert(&lun->lun_lock, MA_OWNED);
1707	pu = lun->pending_ua[initidx / CTL_MAX_INIT_PER_PORT];
1708	if (pu == NULL)
1709		return;
1710	pu[initidx % CTL_MAX_INIT_PER_PORT] &= ~ua;
1711}
1712
1713void
1714ctl_clr_ua_all(struct ctl_lun *lun, uint32_t except, ctl_ua_type ua)
1715{
1716	struct ctl_softc *softc = lun->ctl_softc;
1717	int i, j;
1718
1719	mtx_assert(&lun->lun_lock, MA_OWNED);
1720	for (i = softc->port_min; i < softc->port_max; i++) {
1721		if (lun->pending_ua[i] == NULL)
1722			continue;
1723		for (j = 0; j < CTL_MAX_INIT_PER_PORT; j++) {
1724			if (i * CTL_MAX_INIT_PER_PORT + j == except)
1725				continue;
1726			lun->pending_ua[i][j] &= ~ua;
1727		}
1728	}
1729}
1730
1731void
1732ctl_clr_ua_allluns(struct ctl_softc *ctl_softc, uint32_t initidx,
1733    ctl_ua_type ua_type)
1734{
1735	struct ctl_lun *lun;
1736
1737	mtx_assert(&ctl_softc->ctl_lock, MA_OWNED);
1738	STAILQ_FOREACH(lun, &ctl_softc->lun_list, links) {
1739		mtx_lock(&lun->lun_lock);
1740		ctl_clr_ua(lun, initidx, ua_type);
1741		mtx_unlock(&lun->lun_lock);
1742	}
1743}
1744
1745static int
1746ctl_ha_role_sysctl(SYSCTL_HANDLER_ARGS)
1747{
1748	struct ctl_softc *softc = (struct ctl_softc *)arg1;
1749	struct ctl_lun *lun;
1750	struct ctl_lun_req ireq;
1751	int error, value;
1752
1753	value = (softc->flags & CTL_FLAG_ACTIVE_SHELF) ? 0 : 1;
1754	error = sysctl_handle_int(oidp, &value, 0, req);
1755	if ((error != 0) || (req->newptr == NULL))
1756		return (error);
1757
1758	mtx_lock(&softc->ctl_lock);
1759	if (value == 0)
1760		softc->flags |= CTL_FLAG_ACTIVE_SHELF;
1761	else
1762		softc->flags &= ~CTL_FLAG_ACTIVE_SHELF;
1763	STAILQ_FOREACH(lun, &softc->lun_list, links) {
1764		mtx_unlock(&softc->ctl_lock);
1765		bzero(&ireq, sizeof(ireq));
1766		ireq.reqtype = CTL_LUNREQ_MODIFY;
1767		ireq.reqdata.modify.lun_id = lun->lun;
1768		lun->backend->ioctl(NULL, CTL_LUN_REQ, (caddr_t)&ireq, 0,
1769		    curthread);
1770		if (ireq.status != CTL_LUN_OK) {
1771			printf("%s: CTL_LUNREQ_MODIFY returned %d '%s'\n",
1772			    __func__, ireq.status, ireq.error_str);
1773		}
1774		mtx_lock(&softc->ctl_lock);
1775	}
1776	mtx_unlock(&softc->ctl_lock);
1777	return (0);
1778}
1779
1780static int
1781ctl_init(void)
1782{
1783	struct make_dev_args args;
1784	struct ctl_softc *softc;
1785	void *other_pool;
1786	int i, error;
1787
1788	softc = control_softc = malloc(sizeof(*control_softc), M_DEVBUF,
1789			       M_WAITOK | M_ZERO);
1790
1791	make_dev_args_init(&args);
1792	args.mda_devsw = &ctl_cdevsw;
1793	args.mda_uid = UID_ROOT;
1794	args.mda_gid = GID_OPERATOR;
1795	args.mda_mode = 0600;
1796	args.mda_si_drv1 = softc;
1797	error = make_dev_s(&args, &softc->dev, "cam/ctl");
1798	if (error != 0) {
1799		free(control_softc, M_DEVBUF);
1800		return (error);
1801	}
1802
1803	sysctl_ctx_init(&softc->sysctl_ctx);
1804	softc->sysctl_tree = SYSCTL_ADD_NODE(&softc->sysctl_ctx,
1805		SYSCTL_STATIC_CHILDREN(_kern_cam), OID_AUTO, "ctl",
1806		CTLFLAG_RD, 0, "CAM Target Layer");
1807
1808	if (softc->sysctl_tree == NULL) {
1809		printf("%s: unable to allocate sysctl tree\n", __func__);
1810		destroy_dev(softc->dev);
1811		free(control_softc, M_DEVBUF);
1812		control_softc = NULL;
1813		return (ENOMEM);
1814	}
1815
1816	mtx_init(&softc->ctl_lock, "CTL mutex", NULL, MTX_DEF);
1817	softc->io_zone = uma_zcreate("CTL IO", sizeof(union ctl_io),
1818	    NULL, NULL, NULL, NULL, UMA_ALIGN_PTR, 0);
1819	softc->flags = 0;
1820
1821	TUNABLE_INT_FETCH("kern.cam.ctl.ha_mode", (int *)&softc->ha_mode);
1822	SYSCTL_ADD_INT(&softc->sysctl_ctx, SYSCTL_CHILDREN(softc->sysctl_tree),
1823	    OID_AUTO, "ha_mode", CTLFLAG_RDTUN, (int *)&softc->ha_mode, 0,
1824	    "HA mode (0 - act/stby, 1 - serialize only, 2 - xfer)");
1825
1826	/*
1827	 * In Copan's HA scheme, the "master" and "slave" roles are
1828	 * figured out through the slot the controller is in.  Although it
1829	 * is an active/active system, someone has to be in charge.
1830	 */
1831	TUNABLE_INT_FETCH("kern.cam.ctl.ha_id", &softc->ha_id);
1832	SYSCTL_ADD_INT(&softc->sysctl_ctx, SYSCTL_CHILDREN(softc->sysctl_tree),
1833	    OID_AUTO, "ha_id", CTLFLAG_RDTUN, &softc->ha_id, 0,
1834	    "HA head ID (0 - no HA)");
1835	if (softc->ha_id == 0 || softc->ha_id > NUM_HA_SHELVES) {
1836		softc->flags |= CTL_FLAG_ACTIVE_SHELF;
1837		softc->is_single = 1;
1838		softc->port_cnt = CTL_MAX_PORTS;
1839		softc->port_min = 0;
1840	} else {
1841		softc->port_cnt = CTL_MAX_PORTS / NUM_HA_SHELVES;
1842		softc->port_min = (softc->ha_id - 1) * softc->port_cnt;
1843	}
1844	softc->port_max = softc->port_min + softc->port_cnt;
1845	softc->init_min = softc->port_min * CTL_MAX_INIT_PER_PORT;
1846	softc->init_max = softc->port_max * CTL_MAX_INIT_PER_PORT;
1847
1848	SYSCTL_ADD_INT(&softc->sysctl_ctx, SYSCTL_CHILDREN(softc->sysctl_tree),
1849	    OID_AUTO, "ha_link", CTLFLAG_RD, (int *)&softc->ha_link, 0,
1850	    "HA link state (0 - offline, 1 - unknown, 2 - online)");
1851
1852	STAILQ_INIT(&softc->lun_list);
1853	STAILQ_INIT(&softc->pending_lun_queue);
1854	STAILQ_INIT(&softc->fe_list);
1855	STAILQ_INIT(&softc->port_list);
1856	STAILQ_INIT(&softc->be_list);
1857	ctl_tpc_init(softc);
1858
1859	if (ctl_pool_create(softc, "othersc", CTL_POOL_ENTRIES_OTHER_SC,
1860	                    &other_pool) != 0)
1861	{
1862		printf("ctl: can't allocate %d entry other SC pool, "
1863		       "exiting\n", CTL_POOL_ENTRIES_OTHER_SC);
1864		return (ENOMEM);
1865	}
1866	softc->othersc_pool = other_pool;
1867
1868	if (worker_threads <= 0)
1869		worker_threads = max(1, mp_ncpus / 4);
1870	if (worker_threads > CTL_MAX_THREADS)
1871		worker_threads = CTL_MAX_THREADS;
1872
1873	for (i = 0; i < worker_threads; i++) {
1874		struct ctl_thread *thr = &softc->threads[i];
1875
1876		mtx_init(&thr->queue_lock, "CTL queue mutex", NULL, MTX_DEF);
1877		thr->ctl_softc = softc;
1878		STAILQ_INIT(&thr->incoming_queue);
1879		STAILQ_INIT(&thr->rtr_queue);
1880		STAILQ_INIT(&thr->done_queue);
1881		STAILQ_INIT(&thr->isc_queue);
1882
1883		error = kproc_kthread_add(ctl_work_thread, thr,
1884		    &softc->ctl_proc, &thr->thread, 0, 0, "ctl", "work%d", i);
1885		if (error != 0) {
1886			printf("error creating CTL work thread!\n");
1887			ctl_pool_free(other_pool);
1888			return (error);
1889		}
1890	}
1891	error = kproc_kthread_add(ctl_lun_thread, softc,
1892	    &softc->ctl_proc, NULL, 0, 0, "ctl", "lun");
1893	if (error != 0) {
1894		printf("error creating CTL lun thread!\n");
1895		ctl_pool_free(other_pool);
1896		return (error);
1897	}
1898	error = kproc_kthread_add(ctl_thresh_thread, softc,
1899	    &softc->ctl_proc, NULL, 0, 0, "ctl", "thresh");
1900	if (error != 0) {
1901		printf("error creating CTL threshold thread!\n");
1902		ctl_pool_free(other_pool);
1903		return (error);
1904	}
1905
1906	SYSCTL_ADD_PROC(&softc->sysctl_ctx,SYSCTL_CHILDREN(softc->sysctl_tree),
1907	    OID_AUTO, "ha_role", CTLTYPE_INT | CTLFLAG_RWTUN,
1908	    softc, 0, ctl_ha_role_sysctl, "I", "HA role for this head");
1909
1910	if (softc->is_single == 0) {
1911		ctl_frontend_register(&ha_frontend);
1912		if (ctl_ha_msg_init(softc) != CTL_HA_STATUS_SUCCESS) {
1913			printf("ctl_init: ctl_ha_msg_init failed.\n");
1914			softc->is_single = 1;
1915		} else
1916		if (ctl_ha_msg_register(CTL_HA_CHAN_CTL, ctl_isc_event_handler)
1917		    != CTL_HA_STATUS_SUCCESS) {
1918			printf("ctl_init: ctl_ha_msg_register failed.\n");
1919			softc->is_single = 1;
1920		}
1921	}
1922	return (0);
1923}
1924
1925void
1926ctl_shutdown(void)
1927{
1928	struct ctl_softc *softc = control_softc;
1929	struct ctl_lun *lun, *next_lun;
1930
1931	if (softc->is_single == 0) {
1932		ctl_ha_msg_shutdown(softc);
1933		if (ctl_ha_msg_deregister(CTL_HA_CHAN_CTL)
1934		    != CTL_HA_STATUS_SUCCESS)
1935			printf("%s: ctl_ha_msg_deregister failed.\n", __func__);
1936		if (ctl_ha_msg_destroy(softc) != CTL_HA_STATUS_SUCCESS)
1937			printf("%s: ctl_ha_msg_destroy failed.\n", __func__);
1938		ctl_frontend_deregister(&ha_frontend);
1939	}
1940
1941	mtx_lock(&softc->ctl_lock);
1942
1943	STAILQ_FOREACH_SAFE(lun, &softc->lun_list, links, next_lun)
1944		ctl_free_lun(lun);
1945
1946	mtx_unlock(&softc->ctl_lock);
1947
1948#if 0
1949	ctl_shutdown_thread(softc->work_thread);
1950	mtx_destroy(&softc->queue_lock);
1951#endif
1952
1953	ctl_tpc_shutdown(softc);
1954	uma_zdestroy(softc->io_zone);
1955	mtx_destroy(&softc->ctl_lock);
1956
1957	destroy_dev(softc->dev);
1958
1959	sysctl_ctx_free(&softc->sysctl_ctx);
1960
1961	free(control_softc, M_DEVBUF);
1962	control_softc = NULL;
1963}
1964
1965static int
1966ctl_module_event_handler(module_t mod, int what, void *arg)
1967{
1968
1969	switch (what) {
1970	case MOD_LOAD:
1971		return (ctl_init());
1972	case MOD_UNLOAD:
1973		return (EBUSY);
1974	default:
1975		return (EOPNOTSUPP);
1976	}
1977}
1978
1979/*
1980 * XXX KDM should we do some access checks here?  Bump a reference count to
1981 * prevent a CTL module from being unloaded while someone has it open?
1982 */
1983static int
1984ctl_open(struct cdev *dev, int flags, int fmt, struct thread *td)
1985{
1986	return (0);
1987}
1988
1989static int
1990ctl_close(struct cdev *dev, int flags, int fmt, struct thread *td)
1991{
1992	return (0);
1993}
1994
1995/*
1996 * Remove an initiator by port number and initiator ID.
1997 * Returns 0 for success, -1 for failure.
1998 */
1999int
2000ctl_remove_initiator(struct ctl_port *port, int iid)
2001{
2002	struct ctl_softc *softc = port->ctl_softc;
2003
2004	mtx_assert(&softc->ctl_lock, MA_NOTOWNED);
2005
2006	if (iid > CTL_MAX_INIT_PER_PORT) {
2007		printf("%s: initiator ID %u > maximun %u!\n",
2008		       __func__, iid, CTL_MAX_INIT_PER_PORT);
2009		return (-1);
2010	}
2011
2012	mtx_lock(&softc->ctl_lock);
2013	port->wwpn_iid[iid].in_use--;
2014	port->wwpn_iid[iid].last_use = time_uptime;
2015	mtx_unlock(&softc->ctl_lock);
2016	ctl_isc_announce_iid(port, iid);
2017
2018	return (0);
2019}
2020
2021/*
2022 * Add an initiator to the initiator map.
2023 * Returns iid for success, < 0 for failure.
2024 */
2025int
2026ctl_add_initiator(struct ctl_port *port, int iid, uint64_t wwpn, char *name)
2027{
2028	struct ctl_softc *softc = port->ctl_softc;
2029	time_t best_time;
2030	int i, best;
2031
2032	mtx_assert(&softc->ctl_lock, MA_NOTOWNED);
2033
2034	if (iid >= CTL_MAX_INIT_PER_PORT) {
2035		printf("%s: WWPN %#jx initiator ID %u > maximum %u!\n",
2036		       __func__, wwpn, iid, CTL_MAX_INIT_PER_PORT);
2037		free(name, M_CTL);
2038		return (-1);
2039	}
2040
2041	mtx_lock(&softc->ctl_lock);
2042
2043	if (iid < 0 && (wwpn != 0 || name != NULL)) {
2044		for (i = 0; i < CTL_MAX_INIT_PER_PORT; i++) {
2045			if (wwpn != 0 && wwpn == port->wwpn_iid[i].wwpn) {
2046				iid = i;
2047				break;
2048			}
2049			if (name != NULL && port->wwpn_iid[i].name != NULL &&
2050			    strcmp(name, port->wwpn_iid[i].name) == 0) {
2051				iid = i;
2052				break;
2053			}
2054		}
2055	}
2056
2057	if (iid < 0) {
2058		for (i = 0; i < CTL_MAX_INIT_PER_PORT; i++) {
2059			if (port->wwpn_iid[i].in_use == 0 &&
2060			    port->wwpn_iid[i].wwpn == 0 &&
2061			    port->wwpn_iid[i].name == NULL) {
2062				iid = i;
2063				break;
2064			}
2065		}
2066	}
2067
2068	if (iid < 0) {
2069		best = -1;
2070		best_time = INT32_MAX;
2071		for (i = 0; i < CTL_MAX_INIT_PER_PORT; i++) {
2072			if (port->wwpn_iid[i].in_use == 0) {
2073				if (port->wwpn_iid[i].last_use < best_time) {
2074					best = i;
2075					best_time = port->wwpn_iid[i].last_use;
2076				}
2077			}
2078		}
2079		iid = best;
2080	}
2081
2082	if (iid < 0) {
2083		mtx_unlock(&softc->ctl_lock);
2084		free(name, M_CTL);
2085		return (-2);
2086	}
2087
2088	if (port->wwpn_iid[iid].in_use > 0 && (wwpn != 0 || name != NULL)) {
2089		/*
2090		 * This is not an error yet.
2091		 */
2092		if (wwpn != 0 && wwpn == port->wwpn_iid[iid].wwpn) {
2093#if 0
2094			printf("%s: port %d iid %u WWPN %#jx arrived"
2095			    " again\n", __func__, port->targ_port,
2096			    iid, (uintmax_t)wwpn);
2097#endif
2098			goto take;
2099		}
2100		if (name != NULL && port->wwpn_iid[iid].name != NULL &&
2101		    strcmp(name, port->wwpn_iid[iid].name) == 0) {
2102#if 0
2103			printf("%s: port %d iid %u name '%s' arrived"
2104			    " again\n", __func__, port->targ_port,
2105			    iid, name);
2106#endif
2107			goto take;
2108		}
2109
2110		/*
2111		 * This is an error, but what do we do about it?  The
2112		 * driver is telling us we have a new WWPN for this
2113		 * initiator ID, so we pretty much need to use it.
2114		 */
2115		printf("%s: port %d iid %u WWPN %#jx '%s' arrived,"
2116		    " but WWPN %#jx '%s' is still at that address\n",
2117		    __func__, port->targ_port, iid, wwpn, name,
2118		    (uintmax_t)port->wwpn_iid[iid].wwpn,
2119		    port->wwpn_iid[iid].name);
2120
2121		/*
2122		 * XXX KDM clear have_ca and ua_pending on each LUN for
2123		 * this initiator.
2124		 */
2125	}
2126take:
2127	free(port->wwpn_iid[iid].name, M_CTL);
2128	port->wwpn_iid[iid].name = name;
2129	port->wwpn_iid[iid].wwpn = wwpn;
2130	port->wwpn_iid[iid].in_use++;
2131	mtx_unlock(&softc->ctl_lock);
2132	ctl_isc_announce_iid(port, iid);
2133
2134	return (iid);
2135}
2136
2137static int
2138ctl_create_iid(struct ctl_port *port, int iid, uint8_t *buf)
2139{
2140	int len;
2141
2142	switch (port->port_type) {
2143	case CTL_PORT_FC:
2144	{
2145		struct scsi_transportid_fcp *id =
2146		    (struct scsi_transportid_fcp *)buf;
2147		if (port->wwpn_iid[iid].wwpn == 0)
2148			return (0);
2149		memset(id, 0, sizeof(*id));
2150		id->format_protocol = SCSI_PROTO_FC;
2151		scsi_u64to8b(port->wwpn_iid[iid].wwpn, id->n_port_name);
2152		return (sizeof(*id));
2153	}
2154	case CTL_PORT_ISCSI:
2155	{
2156		struct scsi_transportid_iscsi_port *id =
2157		    (struct scsi_transportid_iscsi_port *)buf;
2158		if (port->wwpn_iid[iid].name == NULL)
2159			return (0);
2160		memset(id, 0, 256);
2161		id->format_protocol = SCSI_TRN_ISCSI_FORMAT_PORT |
2162		    SCSI_PROTO_ISCSI;
2163		len = strlcpy(id->iscsi_name, port->wwpn_iid[iid].name, 252) + 1;
2164		len = roundup2(min(len, 252), 4);
2165		scsi_ulto2b(len, id->additional_length);
2166		return (sizeof(*id) + len);
2167	}
2168	case CTL_PORT_SAS:
2169	{
2170		struct scsi_transportid_sas *id =
2171		    (struct scsi_transportid_sas *)buf;
2172		if (port->wwpn_iid[iid].wwpn == 0)
2173			return (0);
2174		memset(id, 0, sizeof(*id));
2175		id->format_protocol = SCSI_PROTO_SAS;
2176		scsi_u64to8b(port->wwpn_iid[iid].wwpn, id->sas_address);
2177		return (sizeof(*id));
2178	}
2179	default:
2180	{
2181		struct scsi_transportid_spi *id =
2182		    (struct scsi_transportid_spi *)buf;
2183		memset(id, 0, sizeof(*id));
2184		id->format_protocol = SCSI_PROTO_SPI;
2185		scsi_ulto2b(iid, id->scsi_addr);
2186		scsi_ulto2b(port->targ_port, id->rel_trgt_port_id);
2187		return (sizeof(*id));
2188	}
2189	}
2190}
2191
2192/*
2193 * Serialize a command that went down the "wrong" side, and so was sent to
2194 * this controller for execution.  The logic is a little different than the
2195 * standard case in ctl_scsiio_precheck().  Errors in this case need to get
2196 * sent back to the other side, but in the success case, we execute the
2197 * command on this side (XFER mode) or tell the other side to execute it
2198 * (SER_ONLY mode).
2199 */
2200static int
2201ctl_serialize_other_sc_cmd(struct ctl_scsiio *ctsio)
2202{
2203	struct ctl_softc *softc = control_softc;
2204	union ctl_ha_msg msg_info;
2205	struct ctl_port *port;
2206	struct ctl_lun *lun;
2207	const struct ctl_cmd_entry *entry;
2208	int retval = 0;
2209	uint32_t targ_lun;
2210
2211	targ_lun = ctsio->io_hdr.nexus.targ_mapped_lun;
2212	mtx_lock(&softc->ctl_lock);
2213
2214	/* Make sure that we know about this port. */
2215	port = ctl_io_port(&ctsio->io_hdr);
2216	if (port == NULL || (port->status & CTL_PORT_STATUS_ONLINE) == 0) {
2217		ctl_set_internal_failure(ctsio, /*sks_valid*/ 0,
2218					 /*retry_count*/ 1);
2219		goto badjuju;
2220	}
2221
2222	/* Make sure that we know about this LUN. */
2223	if ((targ_lun < CTL_MAX_LUNS) &&
2224	    ((lun = softc->ctl_luns[targ_lun]) != NULL)) {
2225		mtx_lock(&lun->lun_lock);
2226		mtx_unlock(&softc->ctl_lock);
2227		/*
2228		 * If the LUN is invalid, pretend that it doesn't exist.
2229		 * It will go away as soon as all pending I/O has been
2230		 * completed.
2231		 */
2232		if (lun->flags & CTL_LUN_DISABLED) {
2233			mtx_unlock(&lun->lun_lock);
2234			lun = NULL;
2235		}
2236	} else {
2237		mtx_unlock(&softc->ctl_lock);
2238		lun = NULL;
2239	}
2240	if (lun == NULL) {
2241		/*
2242		 * The other node would not send this request to us unless
2243		 * received announce that we are primary node for this LUN.
2244		 * If this LUN does not exist now, it is probably result of
2245		 * a race, so respond to initiator in the most opaque way.
2246		 */
2247		ctl_set_busy(ctsio);
2248		goto badjuju;
2249	}
2250
2251	entry = ctl_get_cmd_entry(ctsio, NULL);
2252	if (ctl_scsiio_lun_check(lun, entry, ctsio) != 0) {
2253		mtx_unlock(&lun->lun_lock);
2254		goto badjuju;
2255	}
2256
2257	ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr = lun;
2258	ctsio->io_hdr.ctl_private[CTL_PRIV_BACKEND_LUN].ptr = lun->be_lun;
2259
2260	/*
2261	 * Every I/O goes into the OOA queue for a
2262	 * particular LUN, and stays there until completion.
2263	 */
2264#ifdef CTL_TIME_IO
2265	if (TAILQ_EMPTY(&lun->ooa_queue))
2266		lun->idle_time += getsbinuptime() - lun->last_busy;
2267#endif
2268	TAILQ_INSERT_TAIL(&lun->ooa_queue, &ctsio->io_hdr, ooa_links);
2269
2270	switch (ctl_check_ooa(lun, (union ctl_io *)ctsio,
2271		(union ctl_io *)TAILQ_PREV(&ctsio->io_hdr, ctl_ooaq,
2272		 ooa_links))) {
2273	case CTL_ACTION_BLOCK:
2274		ctsio->io_hdr.flags |= CTL_FLAG_BLOCKED;
2275		TAILQ_INSERT_TAIL(&lun->blocked_queue, &ctsio->io_hdr,
2276				  blocked_links);
2277		mtx_unlock(&lun->lun_lock);
2278		break;
2279	case CTL_ACTION_PASS:
2280	case CTL_ACTION_SKIP:
2281		if (softc->ha_mode == CTL_HA_MODE_XFER) {
2282			ctsio->io_hdr.flags |= CTL_FLAG_IS_WAS_ON_RTR;
2283			ctl_enqueue_rtr((union ctl_io *)ctsio);
2284			mtx_unlock(&lun->lun_lock);
2285		} else {
2286			ctsio->io_hdr.flags &= ~CTL_FLAG_IO_ACTIVE;
2287			mtx_unlock(&lun->lun_lock);
2288
2289			/* send msg back to other side */
2290			msg_info.hdr.original_sc = ctsio->io_hdr.original_sc;
2291			msg_info.hdr.serializing_sc = (union ctl_io *)ctsio;
2292			msg_info.hdr.msg_type = CTL_MSG_R2R;
2293			ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg_info,
2294			    sizeof(msg_info.hdr), M_WAITOK);
2295		}
2296		break;
2297	case CTL_ACTION_OVERLAP:
2298		TAILQ_REMOVE(&lun->ooa_queue, &ctsio->io_hdr, ooa_links);
2299		mtx_unlock(&lun->lun_lock);
2300		ctl_set_overlapped_cmd(ctsio);
2301		goto badjuju;
2302	case CTL_ACTION_OVERLAP_TAG:
2303		TAILQ_REMOVE(&lun->ooa_queue, &ctsio->io_hdr, ooa_links);
2304		mtx_unlock(&lun->lun_lock);
2305		ctl_set_overlapped_tag(ctsio, ctsio->tag_num);
2306		goto badjuju;
2307	case CTL_ACTION_ERROR:
2308	default:
2309		TAILQ_REMOVE(&lun->ooa_queue, &ctsio->io_hdr, ooa_links);
2310		mtx_unlock(&lun->lun_lock);
2311
2312		ctl_set_internal_failure(ctsio, /*sks_valid*/ 0,
2313					 /*retry_count*/ 0);
2314badjuju:
2315		ctl_copy_sense_data_back((union ctl_io *)ctsio, &msg_info);
2316		msg_info.hdr.original_sc = ctsio->io_hdr.original_sc;
2317		msg_info.hdr.serializing_sc = NULL;
2318		msg_info.hdr.msg_type = CTL_MSG_BAD_JUJU;
2319		ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg_info,
2320		    sizeof(msg_info.scsi), M_WAITOK);
2321		retval = 1;
2322		break;
2323	}
2324	return (retval);
2325}
2326
2327/*
2328 * Returns 0 for success, errno for failure.
2329 */
2330static void
2331ctl_ioctl_fill_ooa(struct ctl_lun *lun, uint32_t *cur_fill_num,
2332		   struct ctl_ooa *ooa_hdr, struct ctl_ooa_entry *kern_entries)
2333{
2334	union ctl_io *io;
2335
2336	mtx_lock(&lun->lun_lock);
2337	for (io = (union ctl_io *)TAILQ_FIRST(&lun->ooa_queue); (io != NULL);
2338	     (*cur_fill_num)++, io = (union ctl_io *)TAILQ_NEXT(&io->io_hdr,
2339	     ooa_links)) {
2340		struct ctl_ooa_entry *entry;
2341
2342		/*
2343		 * If we've got more than we can fit, just count the
2344		 * remaining entries.
2345		 */
2346		if (*cur_fill_num >= ooa_hdr->alloc_num)
2347			continue;
2348
2349		entry = &kern_entries[*cur_fill_num];
2350
2351		entry->tag_num = io->scsiio.tag_num;
2352		entry->lun_num = lun->lun;
2353#ifdef CTL_TIME_IO
2354		entry->start_bt = io->io_hdr.start_bt;
2355#endif
2356		bcopy(io->scsiio.cdb, entry->cdb, io->scsiio.cdb_len);
2357		entry->cdb_len = io->scsiio.cdb_len;
2358		if (io->io_hdr.flags & CTL_FLAG_BLOCKED)
2359			entry->cmd_flags |= CTL_OOACMD_FLAG_BLOCKED;
2360
2361		if (io->io_hdr.flags & CTL_FLAG_DMA_INPROG)
2362			entry->cmd_flags |= CTL_OOACMD_FLAG_DMA;
2363
2364		if (io->io_hdr.flags & CTL_FLAG_ABORT)
2365			entry->cmd_flags |= CTL_OOACMD_FLAG_ABORT;
2366
2367		if (io->io_hdr.flags & CTL_FLAG_IS_WAS_ON_RTR)
2368			entry->cmd_flags |= CTL_OOACMD_FLAG_RTR;
2369
2370		if (io->io_hdr.flags & CTL_FLAG_DMA_QUEUED)
2371			entry->cmd_flags |= CTL_OOACMD_FLAG_DMA_QUEUED;
2372	}
2373	mtx_unlock(&lun->lun_lock);
2374}
2375
2376static void *
2377ctl_copyin_alloc(void *user_addr, int len, char *error_str,
2378		 size_t error_str_len)
2379{
2380	void *kptr;
2381
2382	kptr = malloc(len, M_CTL, M_WAITOK | M_ZERO);
2383
2384	if (copyin(user_addr, kptr, len) != 0) {
2385		snprintf(error_str, error_str_len, "Error copying %d bytes "
2386			 "from user address %p to kernel address %p", len,
2387			 user_addr, kptr);
2388		free(kptr, M_CTL);
2389		return (NULL);
2390	}
2391
2392	return (kptr);
2393}
2394
2395static void
2396ctl_free_args(int num_args, struct ctl_be_arg *args)
2397{
2398	int i;
2399
2400	if (args == NULL)
2401		return;
2402
2403	for (i = 0; i < num_args; i++) {
2404		free(args[i].kname, M_CTL);
2405		free(args[i].kvalue, M_CTL);
2406	}
2407
2408	free(args, M_CTL);
2409}
2410
2411static struct ctl_be_arg *
2412ctl_copyin_args(int num_args, struct ctl_be_arg *uargs,
2413		char *error_str, size_t error_str_len)
2414{
2415	struct ctl_be_arg *args;
2416	int i;
2417
2418	args = ctl_copyin_alloc(uargs, num_args * sizeof(*args),
2419				error_str, error_str_len);
2420
2421	if (args == NULL)
2422		goto bailout;
2423
2424	for (i = 0; i < num_args; i++) {
2425		args[i].kname = NULL;
2426		args[i].kvalue = NULL;
2427	}
2428
2429	for (i = 0; i < num_args; i++) {
2430		uint8_t *tmpptr;
2431
2432		args[i].kname = ctl_copyin_alloc(args[i].name,
2433			args[i].namelen, error_str, error_str_len);
2434		if (args[i].kname == NULL)
2435			goto bailout;
2436
2437		if (args[i].kname[args[i].namelen - 1] != '\0') {
2438			snprintf(error_str, error_str_len, "Argument %d "
2439				 "name is not NUL-terminated", i);
2440			goto bailout;
2441		}
2442
2443		if (args[i].flags & CTL_BEARG_RD) {
2444			tmpptr = ctl_copyin_alloc(args[i].value,
2445				args[i].vallen, error_str, error_str_len);
2446			if (tmpptr == NULL)
2447				goto bailout;
2448			if ((args[i].flags & CTL_BEARG_ASCII)
2449			 && (tmpptr[args[i].vallen - 1] != '\0')) {
2450				snprintf(error_str, error_str_len, "Argument "
2451				    "%d value is not NUL-terminated", i);
2452				free(tmpptr, M_CTL);
2453				goto bailout;
2454			}
2455			args[i].kvalue = tmpptr;
2456		} else {
2457			args[i].kvalue = malloc(args[i].vallen,
2458			    M_CTL, M_WAITOK | M_ZERO);
2459		}
2460	}
2461
2462	return (args);
2463bailout:
2464
2465	ctl_free_args(num_args, args);
2466
2467	return (NULL);
2468}
2469
2470static void
2471ctl_copyout_args(int num_args, struct ctl_be_arg *args)
2472{
2473	int i;
2474
2475	for (i = 0; i < num_args; i++) {
2476		if (args[i].flags & CTL_BEARG_WR)
2477			copyout(args[i].kvalue, args[i].value, args[i].vallen);
2478	}
2479}
2480
2481/*
2482 * Escape characters that are illegal or not recommended in XML.
2483 */
2484int
2485ctl_sbuf_printf_esc(struct sbuf *sb, char *str, int size)
2486{
2487	char *end = str + size;
2488	int retval;
2489
2490	retval = 0;
2491
2492	for (; *str && str < end; str++) {
2493		switch (*str) {
2494		case '&':
2495			retval = sbuf_printf(sb, "&amp;");
2496			break;
2497		case '>':
2498			retval = sbuf_printf(sb, "&gt;");
2499			break;
2500		case '<':
2501			retval = sbuf_printf(sb, "&lt;");
2502			break;
2503		default:
2504			retval = sbuf_putc(sb, *str);
2505			break;
2506		}
2507
2508		if (retval != 0)
2509			break;
2510
2511	}
2512
2513	return (retval);
2514}
2515
2516static void
2517ctl_id_sbuf(struct ctl_devid *id, struct sbuf *sb)
2518{
2519	struct scsi_vpd_id_descriptor *desc;
2520	int i;
2521
2522	if (id == NULL || id->len < 4)
2523		return;
2524	desc = (struct scsi_vpd_id_descriptor *)id->data;
2525	switch (desc->id_type & SVPD_ID_TYPE_MASK) {
2526	case SVPD_ID_TYPE_T10:
2527		sbuf_printf(sb, "t10.");
2528		break;
2529	case SVPD_ID_TYPE_EUI64:
2530		sbuf_printf(sb, "eui.");
2531		break;
2532	case SVPD_ID_TYPE_NAA:
2533		sbuf_printf(sb, "naa.");
2534		break;
2535	case SVPD_ID_TYPE_SCSI_NAME:
2536		break;
2537	}
2538	switch (desc->proto_codeset & SVPD_ID_CODESET_MASK) {
2539	case SVPD_ID_CODESET_BINARY:
2540		for (i = 0; i < desc->length; i++)
2541			sbuf_printf(sb, "%02x", desc->identifier[i]);
2542		break;
2543	case SVPD_ID_CODESET_ASCII:
2544		sbuf_printf(sb, "%.*s", (int)desc->length,
2545		    (char *)desc->identifier);
2546		break;
2547	case SVPD_ID_CODESET_UTF8:
2548		sbuf_printf(sb, "%s", (char *)desc->identifier);
2549		break;
2550	}
2551}
2552
2553static int
2554ctl_ioctl(struct cdev *dev, u_long cmd, caddr_t addr, int flag,
2555	  struct thread *td)
2556{
2557	struct ctl_softc *softc = dev->si_drv1;
2558	struct ctl_lun *lun;
2559	int retval;
2560
2561	retval = 0;
2562
2563	switch (cmd) {
2564	case CTL_IO:
2565		retval = ctl_ioctl_io(dev, cmd, addr, flag, td);
2566		break;
2567	case CTL_ENABLE_PORT:
2568	case CTL_DISABLE_PORT:
2569	case CTL_SET_PORT_WWNS: {
2570		struct ctl_port *port;
2571		struct ctl_port_entry *entry;
2572
2573		entry = (struct ctl_port_entry *)addr;
2574
2575		mtx_lock(&softc->ctl_lock);
2576		STAILQ_FOREACH(port, &softc->port_list, links) {
2577			int action, done;
2578
2579			if (port->targ_port < softc->port_min ||
2580			    port->targ_port >= softc->port_max)
2581				continue;
2582
2583			action = 0;
2584			done = 0;
2585			if ((entry->port_type == CTL_PORT_NONE)
2586			 && (entry->targ_port == port->targ_port)) {
2587				/*
2588				 * If the user only wants to enable or
2589				 * disable or set WWNs on a specific port,
2590				 * do the operation and we're done.
2591				 */
2592				action = 1;
2593				done = 1;
2594			} else if (entry->port_type & port->port_type) {
2595				/*
2596				 * Compare the user's type mask with the
2597				 * particular frontend type to see if we
2598				 * have a match.
2599				 */
2600				action = 1;
2601				done = 0;
2602
2603				/*
2604				 * Make sure the user isn't trying to set
2605				 * WWNs on multiple ports at the same time.
2606				 */
2607				if (cmd == CTL_SET_PORT_WWNS) {
2608					printf("%s: Can't set WWNs on "
2609					       "multiple ports\n", __func__);
2610					retval = EINVAL;
2611					break;
2612				}
2613			}
2614			if (action == 0)
2615				continue;
2616
2617			/*
2618			 * XXX KDM we have to drop the lock here, because
2619			 * the online/offline operations can potentially
2620			 * block.  We need to reference count the frontends
2621			 * so they can't go away,
2622			 */
2623			if (cmd == CTL_ENABLE_PORT) {
2624				mtx_unlock(&softc->ctl_lock);
2625				ctl_port_online(port);
2626				mtx_lock(&softc->ctl_lock);
2627			} else if (cmd == CTL_DISABLE_PORT) {
2628				mtx_unlock(&softc->ctl_lock);
2629				ctl_port_offline(port);
2630				mtx_lock(&softc->ctl_lock);
2631			} else if (cmd == CTL_SET_PORT_WWNS) {
2632				ctl_port_set_wwns(port,
2633				    (entry->flags & CTL_PORT_WWNN_VALID) ?
2634				    1 : 0, entry->wwnn,
2635				    (entry->flags & CTL_PORT_WWPN_VALID) ?
2636				    1 : 0, entry->wwpn);
2637			}
2638			if (done != 0)
2639				break;
2640		}
2641		mtx_unlock(&softc->ctl_lock);
2642		break;
2643	}
2644	case CTL_GET_OOA: {
2645		struct ctl_ooa *ooa_hdr;
2646		struct ctl_ooa_entry *entries;
2647		uint32_t cur_fill_num;
2648
2649		ooa_hdr = (struct ctl_ooa *)addr;
2650
2651		if ((ooa_hdr->alloc_len == 0)
2652		 || (ooa_hdr->alloc_num == 0)) {
2653			printf("%s: CTL_GET_OOA: alloc len %u and alloc num %u "
2654			       "must be non-zero\n", __func__,
2655			       ooa_hdr->alloc_len, ooa_hdr->alloc_num);
2656			retval = EINVAL;
2657			break;
2658		}
2659
2660		if (ooa_hdr->alloc_len != (ooa_hdr->alloc_num *
2661		    sizeof(struct ctl_ooa_entry))) {
2662			printf("%s: CTL_GET_OOA: alloc len %u must be alloc "
2663			       "num %d * sizeof(struct ctl_ooa_entry) %zd\n",
2664			       __func__, ooa_hdr->alloc_len,
2665			       ooa_hdr->alloc_num,sizeof(struct ctl_ooa_entry));
2666			retval = EINVAL;
2667			break;
2668		}
2669
2670		entries = malloc(ooa_hdr->alloc_len, M_CTL, M_WAITOK | M_ZERO);
2671		if (entries == NULL) {
2672			printf("%s: could not allocate %d bytes for OOA "
2673			       "dump\n", __func__, ooa_hdr->alloc_len);
2674			retval = ENOMEM;
2675			break;
2676		}
2677
2678		mtx_lock(&softc->ctl_lock);
2679		if (((ooa_hdr->flags & CTL_OOA_FLAG_ALL_LUNS) == 0)
2680		 && ((ooa_hdr->lun_num >= CTL_MAX_LUNS)
2681		  || (softc->ctl_luns[ooa_hdr->lun_num] == NULL))) {
2682			mtx_unlock(&softc->ctl_lock);
2683			free(entries, M_CTL);
2684			printf("%s: CTL_GET_OOA: invalid LUN %ju\n",
2685			       __func__, (uintmax_t)ooa_hdr->lun_num);
2686			retval = EINVAL;
2687			break;
2688		}
2689
2690		cur_fill_num = 0;
2691
2692		if (ooa_hdr->flags & CTL_OOA_FLAG_ALL_LUNS) {
2693			STAILQ_FOREACH(lun, &softc->lun_list, links) {
2694				ctl_ioctl_fill_ooa(lun, &cur_fill_num,
2695				    ooa_hdr, entries);
2696			}
2697		} else {
2698			lun = softc->ctl_luns[ooa_hdr->lun_num];
2699			ctl_ioctl_fill_ooa(lun, &cur_fill_num, ooa_hdr,
2700			    entries);
2701		}
2702		mtx_unlock(&softc->ctl_lock);
2703
2704		ooa_hdr->fill_num = min(cur_fill_num, ooa_hdr->alloc_num);
2705		ooa_hdr->fill_len = ooa_hdr->fill_num *
2706			sizeof(struct ctl_ooa_entry);
2707		retval = copyout(entries, ooa_hdr->entries, ooa_hdr->fill_len);
2708		if (retval != 0) {
2709			printf("%s: error copying out %d bytes for OOA dump\n",
2710			       __func__, ooa_hdr->fill_len);
2711		}
2712
2713		getbinuptime(&ooa_hdr->cur_bt);
2714
2715		if (cur_fill_num > ooa_hdr->alloc_num) {
2716			ooa_hdr->dropped_num = cur_fill_num -ooa_hdr->alloc_num;
2717			ooa_hdr->status = CTL_OOA_NEED_MORE_SPACE;
2718		} else {
2719			ooa_hdr->dropped_num = 0;
2720			ooa_hdr->status = CTL_OOA_OK;
2721		}
2722
2723		free(entries, M_CTL);
2724		break;
2725	}
2726	case CTL_DELAY_IO: {
2727		struct ctl_io_delay_info *delay_info;
2728
2729		delay_info = (struct ctl_io_delay_info *)addr;
2730
2731#ifdef CTL_IO_DELAY
2732		mtx_lock(&softc->ctl_lock);
2733
2734		if ((delay_info->lun_id >= CTL_MAX_LUNS)
2735		 || (softc->ctl_luns[delay_info->lun_id] == NULL)) {
2736			delay_info->status = CTL_DELAY_STATUS_INVALID_LUN;
2737		} else {
2738			lun = softc->ctl_luns[delay_info->lun_id];
2739			mtx_lock(&lun->lun_lock);
2740
2741			delay_info->status = CTL_DELAY_STATUS_OK;
2742
2743			switch (delay_info->delay_type) {
2744			case CTL_DELAY_TYPE_CONT:
2745				break;
2746			case CTL_DELAY_TYPE_ONESHOT:
2747				break;
2748			default:
2749				delay_info->status =
2750					CTL_DELAY_STATUS_INVALID_TYPE;
2751				break;
2752			}
2753
2754			switch (delay_info->delay_loc) {
2755			case CTL_DELAY_LOC_DATAMOVE:
2756				lun->delay_info.datamove_type =
2757					delay_info->delay_type;
2758				lun->delay_info.datamove_delay =
2759					delay_info->delay_secs;
2760				break;
2761			case CTL_DELAY_LOC_DONE:
2762				lun->delay_info.done_type =
2763					delay_info->delay_type;
2764				lun->delay_info.done_delay =
2765					delay_info->delay_secs;
2766				break;
2767			default:
2768				delay_info->status =
2769					CTL_DELAY_STATUS_INVALID_LOC;
2770				break;
2771			}
2772			mtx_unlock(&lun->lun_lock);
2773		}
2774
2775		mtx_unlock(&softc->ctl_lock);
2776#else
2777		delay_info->status = CTL_DELAY_STATUS_NOT_IMPLEMENTED;
2778#endif /* CTL_IO_DELAY */
2779		break;
2780	}
2781	case CTL_GETSTATS: {
2782		struct ctl_stats *stats;
2783		int i;
2784
2785		stats = (struct ctl_stats *)addr;
2786
2787		if ((sizeof(struct ctl_lun_io_stats) * softc->num_luns) >
2788		     stats->alloc_len) {
2789			stats->status = CTL_SS_NEED_MORE_SPACE;
2790			stats->num_luns = softc->num_luns;
2791			break;
2792		}
2793		/*
2794		 * XXX KDM no locking here.  If the LUN list changes,
2795		 * things can blow up.
2796		 */
2797		i = 0;
2798		STAILQ_FOREACH(lun, &softc->lun_list, links) {
2799			retval = copyout(&lun->stats, &stats->lun_stats[i++],
2800					 sizeof(lun->stats));
2801			if (retval != 0)
2802				break;
2803		}
2804		stats->num_luns = softc->num_luns;
2805		stats->fill_len = sizeof(struct ctl_lun_io_stats) *
2806				 softc->num_luns;
2807		stats->status = CTL_SS_OK;
2808#ifdef CTL_TIME_IO
2809		stats->flags = CTL_STATS_FLAG_TIME_VALID;
2810#else
2811		stats->flags = CTL_STATS_FLAG_NONE;
2812#endif
2813		getnanouptime(&stats->timestamp);
2814		break;
2815	}
2816	case CTL_ERROR_INJECT: {
2817		struct ctl_error_desc *err_desc, *new_err_desc;
2818
2819		err_desc = (struct ctl_error_desc *)addr;
2820
2821		new_err_desc = malloc(sizeof(*new_err_desc), M_CTL,
2822				      M_WAITOK | M_ZERO);
2823		bcopy(err_desc, new_err_desc, sizeof(*new_err_desc));
2824
2825		mtx_lock(&softc->ctl_lock);
2826		lun = softc->ctl_luns[err_desc->lun_id];
2827		if (lun == NULL) {
2828			mtx_unlock(&softc->ctl_lock);
2829			free(new_err_desc, M_CTL);
2830			printf("%s: CTL_ERROR_INJECT: invalid LUN %ju\n",
2831			       __func__, (uintmax_t)err_desc->lun_id);
2832			retval = EINVAL;
2833			break;
2834		}
2835		mtx_lock(&lun->lun_lock);
2836		mtx_unlock(&softc->ctl_lock);
2837
2838		/*
2839		 * We could do some checking here to verify the validity
2840		 * of the request, but given the complexity of error
2841		 * injection requests, the checking logic would be fairly
2842		 * complex.
2843		 *
2844		 * For now, if the request is invalid, it just won't get
2845		 * executed and might get deleted.
2846		 */
2847		STAILQ_INSERT_TAIL(&lun->error_list, new_err_desc, links);
2848
2849		/*
2850		 * XXX KDM check to make sure the serial number is unique,
2851		 * in case we somehow manage to wrap.  That shouldn't
2852		 * happen for a very long time, but it's the right thing to
2853		 * do.
2854		 */
2855		new_err_desc->serial = lun->error_serial;
2856		err_desc->serial = lun->error_serial;
2857		lun->error_serial++;
2858
2859		mtx_unlock(&lun->lun_lock);
2860		break;
2861	}
2862	case CTL_ERROR_INJECT_DELETE: {
2863		struct ctl_error_desc *delete_desc, *desc, *desc2;
2864		int delete_done;
2865
2866		delete_desc = (struct ctl_error_desc *)addr;
2867		delete_done = 0;
2868
2869		mtx_lock(&softc->ctl_lock);
2870		lun = softc->ctl_luns[delete_desc->lun_id];
2871		if (lun == NULL) {
2872			mtx_unlock(&softc->ctl_lock);
2873			printf("%s: CTL_ERROR_INJECT_DELETE: invalid LUN %ju\n",
2874			       __func__, (uintmax_t)delete_desc->lun_id);
2875			retval = EINVAL;
2876			break;
2877		}
2878		mtx_lock(&lun->lun_lock);
2879		mtx_unlock(&softc->ctl_lock);
2880		STAILQ_FOREACH_SAFE(desc, &lun->error_list, links, desc2) {
2881			if (desc->serial != delete_desc->serial)
2882				continue;
2883
2884			STAILQ_REMOVE(&lun->error_list, desc, ctl_error_desc,
2885				      links);
2886			free(desc, M_CTL);
2887			delete_done = 1;
2888		}
2889		mtx_unlock(&lun->lun_lock);
2890		if (delete_done == 0) {
2891			printf("%s: CTL_ERROR_INJECT_DELETE: can't find "
2892			       "error serial %ju on LUN %u\n", __func__,
2893			       delete_desc->serial, delete_desc->lun_id);
2894			retval = EINVAL;
2895			break;
2896		}
2897		break;
2898	}
2899	case CTL_DUMP_STRUCTS: {
2900		int i, j, k;
2901		struct ctl_port *port;
2902		struct ctl_frontend *fe;
2903
2904		mtx_lock(&softc->ctl_lock);
2905		printf("CTL Persistent Reservation information start:\n");
2906		for (i = 0; i < CTL_MAX_LUNS; i++) {
2907			lun = softc->ctl_luns[i];
2908
2909			if ((lun == NULL)
2910			 || ((lun->flags & CTL_LUN_DISABLED) != 0))
2911				continue;
2912
2913			for (j = 0; j < CTL_MAX_PORTS; j++) {
2914				if (lun->pr_keys[j] == NULL)
2915					continue;
2916				for (k = 0; k < CTL_MAX_INIT_PER_PORT; k++){
2917					if (lun->pr_keys[j][k] == 0)
2918						continue;
2919					printf("  LUN %d port %d iid %d key "
2920					       "%#jx\n", i, j, k,
2921					       (uintmax_t)lun->pr_keys[j][k]);
2922				}
2923			}
2924		}
2925		printf("CTL Persistent Reservation information end\n");
2926		printf("CTL Ports:\n");
2927		STAILQ_FOREACH(port, &softc->port_list, links) {
2928			printf("  Port %d '%s' Frontend '%s' Type %u pp %d vp %d WWNN "
2929			       "%#jx WWPN %#jx\n", port->targ_port, port->port_name,
2930			       port->frontend->name, port->port_type,
2931			       port->physical_port, port->virtual_port,
2932			       (uintmax_t)port->wwnn, (uintmax_t)port->wwpn);
2933			for (j = 0; j < CTL_MAX_INIT_PER_PORT; j++) {
2934				if (port->wwpn_iid[j].in_use == 0 &&
2935				    port->wwpn_iid[j].wwpn == 0 &&
2936				    port->wwpn_iid[j].name == NULL)
2937					continue;
2938
2939				printf("    iid %u use %d WWPN %#jx '%s'\n",
2940				    j, port->wwpn_iid[j].in_use,
2941				    (uintmax_t)port->wwpn_iid[j].wwpn,
2942				    port->wwpn_iid[j].name);
2943			}
2944		}
2945		printf("CTL Port information end\n");
2946		mtx_unlock(&softc->ctl_lock);
2947		/*
2948		 * XXX KDM calling this without a lock.  We'd likely want
2949		 * to drop the lock before calling the frontend's dump
2950		 * routine anyway.
2951		 */
2952		printf("CTL Frontends:\n");
2953		STAILQ_FOREACH(fe, &softc->fe_list, links) {
2954			printf("  Frontend '%s'\n", fe->name);
2955			if (fe->fe_dump != NULL)
2956				fe->fe_dump();
2957		}
2958		printf("CTL Frontend information end\n");
2959		break;
2960	}
2961	case CTL_LUN_REQ: {
2962		struct ctl_lun_req *lun_req;
2963		struct ctl_backend_driver *backend;
2964
2965		lun_req = (struct ctl_lun_req *)addr;
2966
2967		backend = ctl_backend_find(lun_req->backend);
2968		if (backend == NULL) {
2969			lun_req->status = CTL_LUN_ERROR;
2970			snprintf(lun_req->error_str,
2971				 sizeof(lun_req->error_str),
2972				 "Backend \"%s\" not found.",
2973				 lun_req->backend);
2974			break;
2975		}
2976		if (lun_req->num_be_args > 0) {
2977			lun_req->kern_be_args = ctl_copyin_args(
2978				lun_req->num_be_args,
2979				lun_req->be_args,
2980				lun_req->error_str,
2981				sizeof(lun_req->error_str));
2982			if (lun_req->kern_be_args == NULL) {
2983				lun_req->status = CTL_LUN_ERROR;
2984				break;
2985			}
2986		}
2987
2988		retval = backend->ioctl(dev, cmd, addr, flag, td);
2989
2990		if (lun_req->num_be_args > 0) {
2991			ctl_copyout_args(lun_req->num_be_args,
2992				      lun_req->kern_be_args);
2993			ctl_free_args(lun_req->num_be_args,
2994				      lun_req->kern_be_args);
2995		}
2996		break;
2997	}
2998	case CTL_LUN_LIST: {
2999		struct sbuf *sb;
3000		struct ctl_lun_list *list;
3001		struct ctl_option *opt;
3002
3003		list = (struct ctl_lun_list *)addr;
3004
3005		/*
3006		 * Allocate a fixed length sbuf here, based on the length
3007		 * of the user's buffer.  We could allocate an auto-extending
3008		 * buffer, and then tell the user how much larger our
3009		 * amount of data is than his buffer, but that presents
3010		 * some problems:
3011		 *
3012		 * 1.  The sbuf(9) routines use a blocking malloc, and so
3013		 *     we can't hold a lock while calling them with an
3014		 *     auto-extending buffer.
3015 		 *
3016		 * 2.  There is not currently a LUN reference counting
3017		 *     mechanism, outside of outstanding transactions on
3018		 *     the LUN's OOA queue.  So a LUN could go away on us
3019		 *     while we're getting the LUN number, backend-specific
3020		 *     information, etc.  Thus, given the way things
3021		 *     currently work, we need to hold the CTL lock while
3022		 *     grabbing LUN information.
3023		 *
3024		 * So, from the user's standpoint, the best thing to do is
3025		 * allocate what he thinks is a reasonable buffer length,
3026		 * and then if he gets a CTL_LUN_LIST_NEED_MORE_SPACE error,
3027		 * double the buffer length and try again.  (And repeat
3028		 * that until he succeeds.)
3029		 */
3030		sb = sbuf_new(NULL, NULL, list->alloc_len, SBUF_FIXEDLEN);
3031		if (sb == NULL) {
3032			list->status = CTL_LUN_LIST_ERROR;
3033			snprintf(list->error_str, sizeof(list->error_str),
3034				 "Unable to allocate %d bytes for LUN list",
3035				 list->alloc_len);
3036			break;
3037		}
3038
3039		sbuf_printf(sb, "<ctllunlist>\n");
3040
3041		mtx_lock(&softc->ctl_lock);
3042		STAILQ_FOREACH(lun, &softc->lun_list, links) {
3043			mtx_lock(&lun->lun_lock);
3044			retval = sbuf_printf(sb, "<lun id=\"%ju\">\n",
3045					     (uintmax_t)lun->lun);
3046
3047			/*
3048			 * Bail out as soon as we see that we've overfilled
3049			 * the buffer.
3050			 */
3051			if (retval != 0)
3052				break;
3053
3054			retval = sbuf_printf(sb, "\t<backend_type>%s"
3055					     "</backend_type>\n",
3056					     (lun->backend == NULL) ?  "none" :
3057					     lun->backend->name);
3058
3059			if (retval != 0)
3060				break;
3061
3062			retval = sbuf_printf(sb, "\t<lun_type>%d</lun_type>\n",
3063					     lun->be_lun->lun_type);
3064
3065			if (retval != 0)
3066				break;
3067
3068			if (lun->backend == NULL) {
3069				retval = sbuf_printf(sb, "</lun>\n");
3070				if (retval != 0)
3071					break;
3072				continue;
3073			}
3074
3075			retval = sbuf_printf(sb, "\t<size>%ju</size>\n",
3076					     (lun->be_lun->maxlba > 0) ?
3077					     lun->be_lun->maxlba + 1 : 0);
3078
3079			if (retval != 0)
3080				break;
3081
3082			retval = sbuf_printf(sb, "\t<blocksize>%u</blocksize>\n",
3083					     lun->be_lun->blocksize);
3084
3085			if (retval != 0)
3086				break;
3087
3088			retval = sbuf_printf(sb, "\t<serial_number>");
3089
3090			if (retval != 0)
3091				break;
3092
3093			retval = ctl_sbuf_printf_esc(sb,
3094			    lun->be_lun->serial_num,
3095			    sizeof(lun->be_lun->serial_num));
3096
3097			if (retval != 0)
3098				break;
3099
3100			retval = sbuf_printf(sb, "</serial_number>\n");
3101
3102			if (retval != 0)
3103				break;
3104
3105			retval = sbuf_printf(sb, "\t<device_id>");
3106
3107			if (retval != 0)
3108				break;
3109
3110			retval = ctl_sbuf_printf_esc(sb,
3111			    lun->be_lun->device_id,
3112			    sizeof(lun->be_lun->device_id));
3113
3114			if (retval != 0)
3115				break;
3116
3117			retval = sbuf_printf(sb, "</device_id>\n");
3118
3119			if (retval != 0)
3120				break;
3121
3122			if (lun->backend->lun_info != NULL) {
3123				retval = lun->backend->lun_info(lun->be_lun->be_lun, sb);
3124				if (retval != 0)
3125					break;
3126			}
3127			STAILQ_FOREACH(opt, &lun->be_lun->options, links) {
3128				retval = sbuf_printf(sb, "\t<%s>%s</%s>\n",
3129				    opt->name, opt->value, opt->name);
3130				if (retval != 0)
3131					break;
3132			}
3133
3134			retval = sbuf_printf(sb, "</lun>\n");
3135
3136			if (retval != 0)
3137				break;
3138			mtx_unlock(&lun->lun_lock);
3139		}
3140		if (lun != NULL)
3141			mtx_unlock(&lun->lun_lock);
3142		mtx_unlock(&softc->ctl_lock);
3143
3144		if ((retval != 0)
3145		 || ((retval = sbuf_printf(sb, "</ctllunlist>\n")) != 0)) {
3146			retval = 0;
3147			sbuf_delete(sb);
3148			list->status = CTL_LUN_LIST_NEED_MORE_SPACE;
3149			snprintf(list->error_str, sizeof(list->error_str),
3150				 "Out of space, %d bytes is too small",
3151				 list->alloc_len);
3152			break;
3153		}
3154
3155		sbuf_finish(sb);
3156
3157		retval = copyout(sbuf_data(sb), list->lun_xml,
3158				 sbuf_len(sb) + 1);
3159
3160		list->fill_len = sbuf_len(sb) + 1;
3161		list->status = CTL_LUN_LIST_OK;
3162		sbuf_delete(sb);
3163		break;
3164	}
3165	case CTL_ISCSI: {
3166		struct ctl_iscsi *ci;
3167		struct ctl_frontend *fe;
3168
3169		ci = (struct ctl_iscsi *)addr;
3170
3171		fe = ctl_frontend_find("iscsi");
3172		if (fe == NULL) {
3173			ci->status = CTL_ISCSI_ERROR;
3174			snprintf(ci->error_str, sizeof(ci->error_str),
3175			    "Frontend \"iscsi\" not found.");
3176			break;
3177		}
3178
3179		retval = fe->ioctl(dev, cmd, addr, flag, td);
3180		break;
3181	}
3182	case CTL_PORT_REQ: {
3183		struct ctl_req *req;
3184		struct ctl_frontend *fe;
3185
3186		req = (struct ctl_req *)addr;
3187
3188		fe = ctl_frontend_find(req->driver);
3189		if (fe == NULL) {
3190			req->status = CTL_LUN_ERROR;
3191			snprintf(req->error_str, sizeof(req->error_str),
3192			    "Frontend \"%s\" not found.", req->driver);
3193			break;
3194		}
3195		if (req->num_args > 0) {
3196			req->kern_args = ctl_copyin_args(req->num_args,
3197			    req->args, req->error_str, sizeof(req->error_str));
3198			if (req->kern_args == NULL) {
3199				req->status = CTL_LUN_ERROR;
3200				break;
3201			}
3202		}
3203
3204		if (fe->ioctl)
3205			retval = fe->ioctl(dev, cmd, addr, flag, td);
3206		else
3207			retval = ENODEV;
3208
3209		if (req->num_args > 0) {
3210			ctl_copyout_args(req->num_args, req->kern_args);
3211			ctl_free_args(req->num_args, req->kern_args);
3212		}
3213		break;
3214	}
3215	case CTL_PORT_LIST: {
3216		struct sbuf *sb;
3217		struct ctl_port *port;
3218		struct ctl_lun_list *list;
3219		struct ctl_option *opt;
3220		int j;
3221		uint32_t plun;
3222
3223		list = (struct ctl_lun_list *)addr;
3224
3225		sb = sbuf_new(NULL, NULL, list->alloc_len, SBUF_FIXEDLEN);
3226		if (sb == NULL) {
3227			list->status = CTL_LUN_LIST_ERROR;
3228			snprintf(list->error_str, sizeof(list->error_str),
3229				 "Unable to allocate %d bytes for LUN list",
3230				 list->alloc_len);
3231			break;
3232		}
3233
3234		sbuf_printf(sb, "<ctlportlist>\n");
3235
3236		mtx_lock(&softc->ctl_lock);
3237		STAILQ_FOREACH(port, &softc->port_list, links) {
3238			retval = sbuf_printf(sb, "<targ_port id=\"%ju\">\n",
3239					     (uintmax_t)port->targ_port);
3240
3241			/*
3242			 * Bail out as soon as we see that we've overfilled
3243			 * the buffer.
3244			 */
3245			if (retval != 0)
3246				break;
3247
3248			retval = sbuf_printf(sb, "\t<frontend_type>%s"
3249			    "</frontend_type>\n", port->frontend->name);
3250			if (retval != 0)
3251				break;
3252
3253			retval = sbuf_printf(sb, "\t<port_type>%d</port_type>\n",
3254					     port->port_type);
3255			if (retval != 0)
3256				break;
3257
3258			retval = sbuf_printf(sb, "\t<online>%s</online>\n",
3259			    (port->status & CTL_PORT_STATUS_ONLINE) ? "YES" : "NO");
3260			if (retval != 0)
3261				break;
3262
3263			retval = sbuf_printf(sb, "\t<port_name>%s</port_name>\n",
3264			    port->port_name);
3265			if (retval != 0)
3266				break;
3267
3268			retval = sbuf_printf(sb, "\t<physical_port>%d</physical_port>\n",
3269			    port->physical_port);
3270			if (retval != 0)
3271				break;
3272
3273			retval = sbuf_printf(sb, "\t<virtual_port>%d</virtual_port>\n",
3274			    port->virtual_port);
3275			if (retval != 0)
3276				break;
3277
3278			if (port->target_devid != NULL) {
3279				sbuf_printf(sb, "\t<target>");
3280				ctl_id_sbuf(port->target_devid, sb);
3281				sbuf_printf(sb, "</target>\n");
3282			}
3283
3284			if (port->port_devid != NULL) {
3285				sbuf_printf(sb, "\t<port>");
3286				ctl_id_sbuf(port->port_devid, sb);
3287				sbuf_printf(sb, "</port>\n");
3288			}
3289
3290			if (port->port_info != NULL) {
3291				retval = port->port_info(port->onoff_arg, sb);
3292				if (retval != 0)
3293					break;
3294			}
3295			STAILQ_FOREACH(opt, &port->options, links) {
3296				retval = sbuf_printf(sb, "\t<%s>%s</%s>\n",
3297				    opt->name, opt->value, opt->name);
3298				if (retval != 0)
3299					break;
3300			}
3301
3302			if (port->lun_map != NULL) {
3303				sbuf_printf(sb, "\t<lun_map>on</lun_map>\n");
3304				for (j = 0; j < CTL_MAX_LUNS; j++) {
3305					plun = ctl_lun_map_from_port(port, j);
3306					if (plun >= CTL_MAX_LUNS)
3307						continue;
3308					sbuf_printf(sb,
3309					    "\t<lun id=\"%u\">%u</lun>\n",
3310					    j, plun);
3311				}
3312			}
3313
3314			for (j = 0; j < CTL_MAX_INIT_PER_PORT; j++) {
3315				if (port->wwpn_iid[j].in_use == 0 ||
3316				    (port->wwpn_iid[j].wwpn == 0 &&
3317				     port->wwpn_iid[j].name == NULL))
3318					continue;
3319
3320				if (port->wwpn_iid[j].name != NULL)
3321					retval = sbuf_printf(sb,
3322					    "\t<initiator id=\"%u\">%s</initiator>\n",
3323					    j, port->wwpn_iid[j].name);
3324				else
3325					retval = sbuf_printf(sb,
3326					    "\t<initiator id=\"%u\">naa.%08jx</initiator>\n",
3327					    j, port->wwpn_iid[j].wwpn);
3328				if (retval != 0)
3329					break;
3330			}
3331			if (retval != 0)
3332				break;
3333
3334			retval = sbuf_printf(sb, "</targ_port>\n");
3335			if (retval != 0)
3336				break;
3337		}
3338		mtx_unlock(&softc->ctl_lock);
3339
3340		if ((retval != 0)
3341		 || ((retval = sbuf_printf(sb, "</ctlportlist>\n")) != 0)) {
3342			retval = 0;
3343			sbuf_delete(sb);
3344			list->status = CTL_LUN_LIST_NEED_MORE_SPACE;
3345			snprintf(list->error_str, sizeof(list->error_str),
3346				 "Out of space, %d bytes is too small",
3347				 list->alloc_len);
3348			break;
3349		}
3350
3351		sbuf_finish(sb);
3352
3353		retval = copyout(sbuf_data(sb), list->lun_xml,
3354				 sbuf_len(sb) + 1);
3355
3356		list->fill_len = sbuf_len(sb) + 1;
3357		list->status = CTL_LUN_LIST_OK;
3358		sbuf_delete(sb);
3359		break;
3360	}
3361	case CTL_LUN_MAP: {
3362		struct ctl_lun_map *lm  = (struct ctl_lun_map *)addr;
3363		struct ctl_port *port;
3364
3365		mtx_lock(&softc->ctl_lock);
3366		if (lm->port < softc->port_min ||
3367		    lm->port >= softc->port_max ||
3368		    (port = softc->ctl_ports[lm->port]) == NULL) {
3369			mtx_unlock(&softc->ctl_lock);
3370			return (ENXIO);
3371		}
3372		if (port->status & CTL_PORT_STATUS_ONLINE) {
3373			STAILQ_FOREACH(lun, &softc->lun_list, links) {
3374				if (ctl_lun_map_to_port(port, lun->lun) >=
3375				    CTL_MAX_LUNS)
3376					continue;
3377				mtx_lock(&lun->lun_lock);
3378				ctl_est_ua_port(lun, lm->port, -1,
3379				    CTL_UA_LUN_CHANGE);
3380				mtx_unlock(&lun->lun_lock);
3381			}
3382		}
3383		mtx_unlock(&softc->ctl_lock); // XXX: port_enable sleeps
3384		if (lm->plun < CTL_MAX_LUNS) {
3385			if (lm->lun == UINT32_MAX)
3386				retval = ctl_lun_map_unset(port, lm->plun);
3387			else if (lm->lun < CTL_MAX_LUNS &&
3388			    softc->ctl_luns[lm->lun] != NULL)
3389				retval = ctl_lun_map_set(port, lm->plun, lm->lun);
3390			else
3391				return (ENXIO);
3392		} else if (lm->plun == UINT32_MAX) {
3393			if (lm->lun == UINT32_MAX)
3394				retval = ctl_lun_map_deinit(port);
3395			else
3396				retval = ctl_lun_map_init(port);
3397		} else
3398			return (ENXIO);
3399		if (port->status & CTL_PORT_STATUS_ONLINE)
3400			ctl_isc_announce_port(port);
3401		break;
3402	}
3403	default: {
3404		/* XXX KDM should we fix this? */
3405#if 0
3406		struct ctl_backend_driver *backend;
3407		unsigned int type;
3408		int found;
3409
3410		found = 0;
3411
3412		/*
3413		 * We encode the backend type as the ioctl type for backend
3414		 * ioctls.  So parse it out here, and then search for a
3415		 * backend of this type.
3416		 */
3417		type = _IOC_TYPE(cmd);
3418
3419		STAILQ_FOREACH(backend, &softc->be_list, links) {
3420			if (backend->type == type) {
3421				found = 1;
3422				break;
3423			}
3424		}
3425		if (found == 0) {
3426			printf("ctl: unknown ioctl command %#lx or backend "
3427			       "%d\n", cmd, type);
3428			retval = EINVAL;
3429			break;
3430		}
3431		retval = backend->ioctl(dev, cmd, addr, flag, td);
3432#endif
3433		retval = ENOTTY;
3434		break;
3435	}
3436	}
3437	return (retval);
3438}
3439
3440uint32_t
3441ctl_get_initindex(struct ctl_nexus *nexus)
3442{
3443	return (nexus->initid + (nexus->targ_port * CTL_MAX_INIT_PER_PORT));
3444}
3445
3446int
3447ctl_lun_map_init(struct ctl_port *port)
3448{
3449	struct ctl_softc *softc = port->ctl_softc;
3450	struct ctl_lun *lun;
3451	uint32_t i;
3452
3453	if (port->lun_map == NULL)
3454		port->lun_map = malloc(sizeof(uint32_t) * CTL_MAX_LUNS,
3455		    M_CTL, M_NOWAIT);
3456	if (port->lun_map == NULL)
3457		return (ENOMEM);
3458	for (i = 0; i < CTL_MAX_LUNS; i++)
3459		port->lun_map[i] = UINT32_MAX;
3460	if (port->status & CTL_PORT_STATUS_ONLINE) {
3461		if (port->lun_disable != NULL) {
3462			STAILQ_FOREACH(lun, &softc->lun_list, links)
3463				port->lun_disable(port->targ_lun_arg, lun->lun);
3464		}
3465		ctl_isc_announce_port(port);
3466	}
3467	return (0);
3468}
3469
3470int
3471ctl_lun_map_deinit(struct ctl_port *port)
3472{
3473	struct ctl_softc *softc = port->ctl_softc;
3474	struct ctl_lun *lun;
3475
3476	if (port->lun_map == NULL)
3477		return (0);
3478	free(port->lun_map, M_CTL);
3479	port->lun_map = NULL;
3480	if (port->status & CTL_PORT_STATUS_ONLINE) {
3481		if (port->lun_enable != NULL) {
3482			STAILQ_FOREACH(lun, &softc->lun_list, links)
3483				port->lun_enable(port->targ_lun_arg, lun->lun);
3484		}
3485		ctl_isc_announce_port(port);
3486	}
3487	return (0);
3488}
3489
3490int
3491ctl_lun_map_set(struct ctl_port *port, uint32_t plun, uint32_t glun)
3492{
3493	int status;
3494	uint32_t old;
3495
3496	if (port->lun_map == NULL) {
3497		status = ctl_lun_map_init(port);
3498		if (status != 0)
3499			return (status);
3500	}
3501	old = port->lun_map[plun];
3502	port->lun_map[plun] = glun;
3503	if ((port->status & CTL_PORT_STATUS_ONLINE) && old >= CTL_MAX_LUNS) {
3504		if (port->lun_enable != NULL)
3505			port->lun_enable(port->targ_lun_arg, plun);
3506		ctl_isc_announce_port(port);
3507	}
3508	return (0);
3509}
3510
3511int
3512ctl_lun_map_unset(struct ctl_port *port, uint32_t plun)
3513{
3514	uint32_t old;
3515
3516	if (port->lun_map == NULL)
3517		return (0);
3518	old = port->lun_map[plun];
3519	port->lun_map[plun] = UINT32_MAX;
3520	if ((port->status & CTL_PORT_STATUS_ONLINE) && old < CTL_MAX_LUNS) {
3521		if (port->lun_disable != NULL)
3522			port->lun_disable(port->targ_lun_arg, plun);
3523		ctl_isc_announce_port(port);
3524	}
3525	return (0);
3526}
3527
3528uint32_t
3529ctl_lun_map_from_port(struct ctl_port *port, uint32_t lun_id)
3530{
3531
3532	if (port == NULL)
3533		return (UINT32_MAX);
3534	if (port->lun_map == NULL || lun_id >= CTL_MAX_LUNS)
3535		return (lun_id);
3536	return (port->lun_map[lun_id]);
3537}
3538
3539uint32_t
3540ctl_lun_map_to_port(struct ctl_port *port, uint32_t lun_id)
3541{
3542	uint32_t i;
3543
3544	if (port == NULL)
3545		return (UINT32_MAX);
3546	if (port->lun_map == NULL)
3547		return (lun_id);
3548	for (i = 0; i < CTL_MAX_LUNS; i++) {
3549		if (port->lun_map[i] == lun_id)
3550			return (i);
3551	}
3552	return (UINT32_MAX);
3553}
3554
3555uint32_t
3556ctl_decode_lun(uint64_t encoded)
3557{
3558	uint8_t lun[8];
3559	uint32_t result = 0xffffffff;
3560
3561	be64enc(lun, encoded);
3562	switch (lun[0] & RPL_LUNDATA_ATYP_MASK) {
3563	case RPL_LUNDATA_ATYP_PERIPH:
3564		if ((lun[0] & 0x3f) == 0 && lun[2] == 0 && lun[3] == 0 &&
3565		    lun[4] == 0 && lun[5] == 0 && lun[6] == 0 && lun[7] == 0)
3566			result = lun[1];
3567		break;
3568	case RPL_LUNDATA_ATYP_FLAT:
3569		if (lun[2] == 0 && lun[3] == 0 && lun[4] == 0 && lun[5] == 0 &&
3570		    lun[6] == 0 && lun[7] == 0)
3571			result = ((lun[0] & 0x3f) << 8) + lun[1];
3572		break;
3573	case RPL_LUNDATA_ATYP_EXTLUN:
3574		switch (lun[0] & RPL_LUNDATA_EXT_EAM_MASK) {
3575		case 0x02:
3576			switch (lun[0] & RPL_LUNDATA_EXT_LEN_MASK) {
3577			case 0x00:
3578				result = lun[1];
3579				break;
3580			case 0x10:
3581				result = (lun[1] << 16) + (lun[2] << 8) +
3582				    lun[3];
3583				break;
3584			case 0x20:
3585				if (lun[1] == 0 && lun[6] == 0 && lun[7] == 0)
3586					result = (lun[2] << 24) +
3587					    (lun[3] << 16) + (lun[4] << 8) +
3588					    lun[5];
3589				break;
3590			}
3591			break;
3592		case RPL_LUNDATA_EXT_EAM_NOT_SPEC:
3593			result = 0xffffffff;
3594			break;
3595		}
3596		break;
3597	}
3598	return (result);
3599}
3600
3601uint64_t
3602ctl_encode_lun(uint32_t decoded)
3603{
3604	uint64_t l = decoded;
3605
3606	if (l <= 0xff)
3607		return (((uint64_t)RPL_LUNDATA_ATYP_PERIPH << 56) | (l << 48));
3608	if (l <= 0x3fff)
3609		return (((uint64_t)RPL_LUNDATA_ATYP_FLAT << 56) | (l << 48));
3610	if (l <= 0xffffff)
3611		return (((uint64_t)(RPL_LUNDATA_ATYP_EXTLUN | 0x12) << 56) |
3612		    (l << 32));
3613	return ((((uint64_t)RPL_LUNDATA_ATYP_EXTLUN | 0x22) << 56) | (l << 16));
3614}
3615
3616static struct ctl_port *
3617ctl_io_port(struct ctl_io_hdr *io_hdr)
3618{
3619
3620	return (control_softc->ctl_ports[io_hdr->nexus.targ_port]);
3621}
3622
3623int
3624ctl_ffz(uint32_t *mask, uint32_t first, uint32_t last)
3625{
3626	int i;
3627
3628	for (i = first; i < last; i++) {
3629		if ((mask[i / 32] & (1 << (i % 32))) == 0)
3630			return (i);
3631	}
3632	return (-1);
3633}
3634
3635int
3636ctl_set_mask(uint32_t *mask, uint32_t bit)
3637{
3638	uint32_t chunk, piece;
3639
3640	chunk = bit >> 5;
3641	piece = bit % (sizeof(uint32_t) * 8);
3642
3643	if ((mask[chunk] & (1 << piece)) != 0)
3644		return (-1);
3645	else
3646		mask[chunk] |= (1 << piece);
3647
3648	return (0);
3649}
3650
3651int
3652ctl_clear_mask(uint32_t *mask, uint32_t bit)
3653{
3654	uint32_t chunk, piece;
3655
3656	chunk = bit >> 5;
3657	piece = bit % (sizeof(uint32_t) * 8);
3658
3659	if ((mask[chunk] & (1 << piece)) == 0)
3660		return (-1);
3661	else
3662		mask[chunk] &= ~(1 << piece);
3663
3664	return (0);
3665}
3666
3667int
3668ctl_is_set(uint32_t *mask, uint32_t bit)
3669{
3670	uint32_t chunk, piece;
3671
3672	chunk = bit >> 5;
3673	piece = bit % (sizeof(uint32_t) * 8);
3674
3675	if ((mask[chunk] & (1 << piece)) == 0)
3676		return (0);
3677	else
3678		return (1);
3679}
3680
3681static uint64_t
3682ctl_get_prkey(struct ctl_lun *lun, uint32_t residx)
3683{
3684	uint64_t *t;
3685
3686	t = lun->pr_keys[residx/CTL_MAX_INIT_PER_PORT];
3687	if (t == NULL)
3688		return (0);
3689	return (t[residx % CTL_MAX_INIT_PER_PORT]);
3690}
3691
3692static void
3693ctl_clr_prkey(struct ctl_lun *lun, uint32_t residx)
3694{
3695	uint64_t *t;
3696
3697	t = lun->pr_keys[residx/CTL_MAX_INIT_PER_PORT];
3698	if (t == NULL)
3699		return;
3700	t[residx % CTL_MAX_INIT_PER_PORT] = 0;
3701}
3702
3703static void
3704ctl_alloc_prkey(struct ctl_lun *lun, uint32_t residx)
3705{
3706	uint64_t *p;
3707	u_int i;
3708
3709	i = residx/CTL_MAX_INIT_PER_PORT;
3710	if (lun->pr_keys[i] != NULL)
3711		return;
3712	mtx_unlock(&lun->lun_lock);
3713	p = malloc(sizeof(uint64_t) * CTL_MAX_INIT_PER_PORT, M_CTL,
3714	    M_WAITOK | M_ZERO);
3715	mtx_lock(&lun->lun_lock);
3716	if (lun->pr_keys[i] == NULL)
3717		lun->pr_keys[i] = p;
3718	else
3719		free(p, M_CTL);
3720}
3721
3722static void
3723ctl_set_prkey(struct ctl_lun *lun, uint32_t residx, uint64_t key)
3724{
3725	uint64_t *t;
3726
3727	t = lun->pr_keys[residx/CTL_MAX_INIT_PER_PORT];
3728	KASSERT(t != NULL, ("prkey %d is not allocated", residx));
3729	t[residx % CTL_MAX_INIT_PER_PORT] = key;
3730}
3731
3732/*
3733 * ctl_softc, pool_name, total_ctl_io are passed in.
3734 * npool is passed out.
3735 */
3736int
3737ctl_pool_create(struct ctl_softc *ctl_softc, const char *pool_name,
3738		uint32_t total_ctl_io, void **npool)
3739{
3740#ifdef IO_POOLS
3741	struct ctl_io_pool *pool;
3742
3743	pool = (struct ctl_io_pool *)malloc(sizeof(*pool), M_CTL,
3744					    M_NOWAIT | M_ZERO);
3745	if (pool == NULL)
3746		return (ENOMEM);
3747
3748	snprintf(pool->name, sizeof(pool->name), "CTL IO %s", pool_name);
3749	pool->ctl_softc = ctl_softc;
3750	pool->zone = uma_zsecond_create(pool->name, NULL,
3751	    NULL, NULL, NULL, ctl_softc->io_zone);
3752	/* uma_prealloc(pool->zone, total_ctl_io); */
3753
3754	*npool = pool;
3755#else
3756	*npool = ctl_softc->io_zone;
3757#endif
3758	return (0);
3759}
3760
3761void
3762ctl_pool_free(struct ctl_io_pool *pool)
3763{
3764
3765	if (pool == NULL)
3766		return;
3767
3768#ifdef IO_POOLS
3769	uma_zdestroy(pool->zone);
3770	free(pool, M_CTL);
3771#endif
3772}
3773
3774union ctl_io *
3775ctl_alloc_io(void *pool_ref)
3776{
3777	union ctl_io *io;
3778#ifdef IO_POOLS
3779	struct ctl_io_pool *pool = (struct ctl_io_pool *)pool_ref;
3780
3781	io = uma_zalloc(pool->zone, M_WAITOK);
3782#else
3783	io = uma_zalloc((uma_zone_t)pool_ref, M_WAITOK);
3784#endif
3785	if (io != NULL)
3786		io->io_hdr.pool = pool_ref;
3787	return (io);
3788}
3789
3790union ctl_io *
3791ctl_alloc_io_nowait(void *pool_ref)
3792{
3793	union ctl_io *io;
3794#ifdef IO_POOLS
3795	struct ctl_io_pool *pool = (struct ctl_io_pool *)pool_ref;
3796
3797	io = uma_zalloc(pool->zone, M_NOWAIT);
3798#else
3799	io = uma_zalloc((uma_zone_t)pool_ref, M_NOWAIT);
3800#endif
3801	if (io != NULL)
3802		io->io_hdr.pool = pool_ref;
3803	return (io);
3804}
3805
3806void
3807ctl_free_io(union ctl_io *io)
3808{
3809#ifdef IO_POOLS
3810	struct ctl_io_pool *pool;
3811#endif
3812
3813	if (io == NULL)
3814		return;
3815
3816#ifdef IO_POOLS
3817	pool = (struct ctl_io_pool *)io->io_hdr.pool;
3818	uma_zfree(pool->zone, io);
3819#else
3820	uma_zfree((uma_zone_t)io->io_hdr.pool, io);
3821#endif
3822}
3823
3824void
3825ctl_zero_io(union ctl_io *io)
3826{
3827	void *pool_ref;
3828
3829	if (io == NULL)
3830		return;
3831
3832	/*
3833	 * May need to preserve linked list pointers at some point too.
3834	 */
3835	pool_ref = io->io_hdr.pool;
3836	memset(io, 0, sizeof(*io));
3837	io->io_hdr.pool = pool_ref;
3838}
3839
3840int
3841ctl_expand_number(const char *buf, uint64_t *num)
3842{
3843	char *endptr;
3844	uint64_t number;
3845	unsigned shift;
3846
3847	number = strtoq(buf, &endptr, 0);
3848
3849	switch (tolower((unsigned char)*endptr)) {
3850	case 'e':
3851		shift = 60;
3852		break;
3853	case 'p':
3854		shift = 50;
3855		break;
3856	case 't':
3857		shift = 40;
3858		break;
3859	case 'g':
3860		shift = 30;
3861		break;
3862	case 'm':
3863		shift = 20;
3864		break;
3865	case 'k':
3866		shift = 10;
3867		break;
3868	case 'b':
3869	case '\0': /* No unit. */
3870		*num = number;
3871		return (0);
3872	default:
3873		/* Unrecognized unit. */
3874		return (-1);
3875	}
3876
3877	if ((number << shift) >> shift != number) {
3878		/* Overflow */
3879		return (-1);
3880	}
3881	*num = number << shift;
3882	return (0);
3883}
3884
3885
3886/*
3887 * This routine could be used in the future to load default and/or saved
3888 * mode page parameters for a particuar lun.
3889 */
3890static int
3891ctl_init_page_index(struct ctl_lun *lun)
3892{
3893	int i, page_code;
3894	struct ctl_page_index *page_index;
3895	const char *value;
3896	uint64_t ival;
3897
3898	memcpy(&lun->mode_pages.index, page_index_template,
3899	       sizeof(page_index_template));
3900
3901	for (i = 0; i < CTL_NUM_MODE_PAGES; i++) {
3902
3903		page_index = &lun->mode_pages.index[i];
3904		if (lun->be_lun->lun_type == T_DIRECT &&
3905		    (page_index->page_flags & CTL_PAGE_FLAG_DIRECT) == 0)
3906			continue;
3907		if (lun->be_lun->lun_type == T_PROCESSOR &&
3908		    (page_index->page_flags & CTL_PAGE_FLAG_PROC) == 0)
3909			continue;
3910		if (lun->be_lun->lun_type == T_CDROM &&
3911		    (page_index->page_flags & CTL_PAGE_FLAG_CDROM) == 0)
3912			continue;
3913
3914		page_code = page_index->page_code & SMPH_PC_MASK;
3915		switch (page_code) {
3916		case SMS_RW_ERROR_RECOVERY_PAGE: {
3917			KASSERT(page_index->subpage == SMS_SUBPAGE_PAGE_0,
3918			    ("subpage %#x for page %#x is incorrect!",
3919			    page_index->subpage, page_code));
3920			memcpy(&lun->mode_pages.rw_er_page[CTL_PAGE_CURRENT],
3921			       &rw_er_page_default,
3922			       sizeof(rw_er_page_default));
3923			memcpy(&lun->mode_pages.rw_er_page[CTL_PAGE_CHANGEABLE],
3924			       &rw_er_page_changeable,
3925			       sizeof(rw_er_page_changeable));
3926			memcpy(&lun->mode_pages.rw_er_page[CTL_PAGE_DEFAULT],
3927			       &rw_er_page_default,
3928			       sizeof(rw_er_page_default));
3929			memcpy(&lun->mode_pages.rw_er_page[CTL_PAGE_SAVED],
3930			       &rw_er_page_default,
3931			       sizeof(rw_er_page_default));
3932			page_index->page_data =
3933				(uint8_t *)lun->mode_pages.rw_er_page;
3934			break;
3935		}
3936		case SMS_FORMAT_DEVICE_PAGE: {
3937			struct scsi_format_page *format_page;
3938
3939			KASSERT(page_index->subpage == SMS_SUBPAGE_PAGE_0,
3940			    ("subpage %#x for page %#x is incorrect!",
3941			    page_index->subpage, page_code));
3942
3943			/*
3944			 * Sectors per track are set above.  Bytes per
3945			 * sector need to be set here on a per-LUN basis.
3946			 */
3947			memcpy(&lun->mode_pages.format_page[CTL_PAGE_CURRENT],
3948			       &format_page_default,
3949			       sizeof(format_page_default));
3950			memcpy(&lun->mode_pages.format_page[
3951			       CTL_PAGE_CHANGEABLE], &format_page_changeable,
3952			       sizeof(format_page_changeable));
3953			memcpy(&lun->mode_pages.format_page[CTL_PAGE_DEFAULT],
3954			       &format_page_default,
3955			       sizeof(format_page_default));
3956			memcpy(&lun->mode_pages.format_page[CTL_PAGE_SAVED],
3957			       &format_page_default,
3958			       sizeof(format_page_default));
3959
3960			format_page = &lun->mode_pages.format_page[
3961				CTL_PAGE_CURRENT];
3962			scsi_ulto2b(lun->be_lun->blocksize,
3963				    format_page->bytes_per_sector);
3964
3965			format_page = &lun->mode_pages.format_page[
3966				CTL_PAGE_DEFAULT];
3967			scsi_ulto2b(lun->be_lun->blocksize,
3968				    format_page->bytes_per_sector);
3969
3970			format_page = &lun->mode_pages.format_page[
3971				CTL_PAGE_SAVED];
3972			scsi_ulto2b(lun->be_lun->blocksize,
3973				    format_page->bytes_per_sector);
3974
3975			page_index->page_data =
3976				(uint8_t *)lun->mode_pages.format_page;
3977			break;
3978		}
3979		case SMS_RIGID_DISK_PAGE: {
3980			struct scsi_rigid_disk_page *rigid_disk_page;
3981			uint32_t sectors_per_cylinder;
3982			uint64_t cylinders;
3983#ifndef	__XSCALE__
3984			int shift;
3985#endif /* !__XSCALE__ */
3986
3987			KASSERT(page_index->subpage == SMS_SUBPAGE_PAGE_0,
3988			    ("subpage %#x for page %#x is incorrect!",
3989			    page_index->subpage, page_code));
3990
3991			/*
3992			 * Rotation rate and sectors per track are set
3993			 * above.  We calculate the cylinders here based on
3994			 * capacity.  Due to the number of heads and
3995			 * sectors per track we're using, smaller arrays
3996			 * may turn out to have 0 cylinders.  Linux and
3997			 * FreeBSD don't pay attention to these mode pages
3998			 * to figure out capacity, but Solaris does.  It
3999			 * seems to deal with 0 cylinders just fine, and
4000			 * works out a fake geometry based on the capacity.
4001			 */
4002			memcpy(&lun->mode_pages.rigid_disk_page[
4003			       CTL_PAGE_DEFAULT], &rigid_disk_page_default,
4004			       sizeof(rigid_disk_page_default));
4005			memcpy(&lun->mode_pages.rigid_disk_page[
4006			       CTL_PAGE_CHANGEABLE],&rigid_disk_page_changeable,
4007			       sizeof(rigid_disk_page_changeable));
4008
4009			sectors_per_cylinder = CTL_DEFAULT_SECTORS_PER_TRACK *
4010				CTL_DEFAULT_HEADS;
4011
4012			/*
4013			 * The divide method here will be more accurate,
4014			 * probably, but results in floating point being
4015			 * used in the kernel on i386 (__udivdi3()).  On the
4016			 * XScale, though, __udivdi3() is implemented in
4017			 * software.
4018			 *
4019			 * The shift method for cylinder calculation is
4020			 * accurate if sectors_per_cylinder is a power of
4021			 * 2.  Otherwise it might be slightly off -- you
4022			 * might have a bit of a truncation problem.
4023			 */
4024#ifdef	__XSCALE__
4025			cylinders = (lun->be_lun->maxlba + 1) /
4026				sectors_per_cylinder;
4027#else
4028			for (shift = 31; shift > 0; shift--) {
4029				if (sectors_per_cylinder & (1 << shift))
4030					break;
4031			}
4032			cylinders = (lun->be_lun->maxlba + 1) >> shift;
4033#endif
4034
4035			/*
4036			 * We've basically got 3 bytes, or 24 bits for the
4037			 * cylinder size in the mode page.  If we're over,
4038			 * just round down to 2^24.
4039			 */
4040			if (cylinders > 0xffffff)
4041				cylinders = 0xffffff;
4042
4043			rigid_disk_page = &lun->mode_pages.rigid_disk_page[
4044				CTL_PAGE_DEFAULT];
4045			scsi_ulto3b(cylinders, rigid_disk_page->cylinders);
4046
4047			if ((value = ctl_get_opt(&lun->be_lun->options,
4048			    "rpm")) != NULL) {
4049				scsi_ulto2b(strtol(value, NULL, 0),
4050				     rigid_disk_page->rotation_rate);
4051			}
4052
4053			memcpy(&lun->mode_pages.rigid_disk_page[CTL_PAGE_CURRENT],
4054			       &lun->mode_pages.rigid_disk_page[CTL_PAGE_DEFAULT],
4055			       sizeof(rigid_disk_page_default));
4056			memcpy(&lun->mode_pages.rigid_disk_page[CTL_PAGE_SAVED],
4057			       &lun->mode_pages.rigid_disk_page[CTL_PAGE_DEFAULT],
4058			       sizeof(rigid_disk_page_default));
4059
4060			page_index->page_data =
4061				(uint8_t *)lun->mode_pages.rigid_disk_page;
4062			break;
4063		}
4064		case SMS_VERIFY_ERROR_RECOVERY_PAGE: {
4065			KASSERT(page_index->subpage == SMS_SUBPAGE_PAGE_0,
4066			    ("subpage %#x for page %#x is incorrect!",
4067			    page_index->subpage, page_code));
4068			memcpy(&lun->mode_pages.verify_er_page[CTL_PAGE_CURRENT],
4069			       &verify_er_page_default,
4070			       sizeof(verify_er_page_default));
4071			memcpy(&lun->mode_pages.verify_er_page[CTL_PAGE_CHANGEABLE],
4072			       &verify_er_page_changeable,
4073			       sizeof(verify_er_page_changeable));
4074			memcpy(&lun->mode_pages.verify_er_page[CTL_PAGE_DEFAULT],
4075			       &verify_er_page_default,
4076			       sizeof(verify_er_page_default));
4077			memcpy(&lun->mode_pages.verify_er_page[CTL_PAGE_SAVED],
4078			       &verify_er_page_default,
4079			       sizeof(verify_er_page_default));
4080			page_index->page_data =
4081				(uint8_t *)lun->mode_pages.verify_er_page;
4082			break;
4083		}
4084		case SMS_CACHING_PAGE: {
4085			struct scsi_caching_page *caching_page;
4086
4087			KASSERT(page_index->subpage == SMS_SUBPAGE_PAGE_0,
4088			    ("subpage %#x for page %#x is incorrect!",
4089			    page_index->subpage, page_code));
4090			memcpy(&lun->mode_pages.caching_page[CTL_PAGE_DEFAULT],
4091			       &caching_page_default,
4092			       sizeof(caching_page_default));
4093			memcpy(&lun->mode_pages.caching_page[
4094			       CTL_PAGE_CHANGEABLE], &caching_page_changeable,
4095			       sizeof(caching_page_changeable));
4096			memcpy(&lun->mode_pages.caching_page[CTL_PAGE_SAVED],
4097			       &caching_page_default,
4098			       sizeof(caching_page_default));
4099			caching_page = &lun->mode_pages.caching_page[
4100			    CTL_PAGE_SAVED];
4101			value = ctl_get_opt(&lun->be_lun->options, "writecache");
4102			if (value != NULL && strcmp(value, "off") == 0)
4103				caching_page->flags1 &= ~SCP_WCE;
4104			value = ctl_get_opt(&lun->be_lun->options, "readcache");
4105			if (value != NULL && strcmp(value, "off") == 0)
4106				caching_page->flags1 |= SCP_RCD;
4107			memcpy(&lun->mode_pages.caching_page[CTL_PAGE_CURRENT],
4108			       &lun->mode_pages.caching_page[CTL_PAGE_SAVED],
4109			       sizeof(caching_page_default));
4110			page_index->page_data =
4111				(uint8_t *)lun->mode_pages.caching_page;
4112			break;
4113		}
4114		case SMS_CONTROL_MODE_PAGE: {
4115			switch (page_index->subpage) {
4116			case SMS_SUBPAGE_PAGE_0: {
4117				struct scsi_control_page *control_page;
4118
4119				memcpy(&lun->mode_pages.control_page[
4120				    CTL_PAGE_DEFAULT],
4121				       &control_page_default,
4122				       sizeof(control_page_default));
4123				memcpy(&lun->mode_pages.control_page[
4124				    CTL_PAGE_CHANGEABLE],
4125				       &control_page_changeable,
4126				       sizeof(control_page_changeable));
4127				memcpy(&lun->mode_pages.control_page[
4128				    CTL_PAGE_SAVED],
4129				       &control_page_default,
4130				       sizeof(control_page_default));
4131				control_page = &lun->mode_pages.control_page[
4132				    CTL_PAGE_SAVED];
4133				value = ctl_get_opt(&lun->be_lun->options,
4134				    "reordering");
4135				if (value != NULL &&
4136				    strcmp(value, "unrestricted") == 0) {
4137					control_page->queue_flags &=
4138					    ~SCP_QUEUE_ALG_MASK;
4139					control_page->queue_flags |=
4140					    SCP_QUEUE_ALG_UNRESTRICTED;
4141				}
4142				memcpy(&lun->mode_pages.control_page[
4143				    CTL_PAGE_CURRENT],
4144				       &lun->mode_pages.control_page[
4145				    CTL_PAGE_SAVED],
4146				       sizeof(control_page_default));
4147				page_index->page_data =
4148				    (uint8_t *)lun->mode_pages.control_page;
4149				break;
4150			}
4151			case 0x01:
4152				memcpy(&lun->mode_pages.control_ext_page[
4153				    CTL_PAGE_DEFAULT],
4154				       &control_ext_page_default,
4155				       sizeof(control_ext_page_default));
4156				memcpy(&lun->mode_pages.control_ext_page[
4157				    CTL_PAGE_CHANGEABLE],
4158				       &control_ext_page_changeable,
4159				       sizeof(control_ext_page_changeable));
4160				memcpy(&lun->mode_pages.control_ext_page[
4161				    CTL_PAGE_SAVED],
4162				       &control_ext_page_default,
4163				       sizeof(control_ext_page_default));
4164				memcpy(&lun->mode_pages.control_ext_page[
4165				    CTL_PAGE_CURRENT],
4166				       &lun->mode_pages.control_ext_page[
4167				    CTL_PAGE_SAVED],
4168				       sizeof(control_ext_page_default));
4169				page_index->page_data =
4170				    (uint8_t *)lun->mode_pages.control_ext_page;
4171				break;
4172			default:
4173				panic("subpage %#x for page %#x is incorrect!",
4174				      page_index->subpage, page_code);
4175			}
4176			break;
4177		}
4178		case SMS_INFO_EXCEPTIONS_PAGE: {
4179			switch (page_index->subpage) {
4180			case SMS_SUBPAGE_PAGE_0:
4181				memcpy(&lun->mode_pages.ie_page[CTL_PAGE_CURRENT],
4182				       &ie_page_default,
4183				       sizeof(ie_page_default));
4184				memcpy(&lun->mode_pages.ie_page[
4185				       CTL_PAGE_CHANGEABLE], &ie_page_changeable,
4186				       sizeof(ie_page_changeable));
4187				memcpy(&lun->mode_pages.ie_page[CTL_PAGE_DEFAULT],
4188				       &ie_page_default,
4189				       sizeof(ie_page_default));
4190				memcpy(&lun->mode_pages.ie_page[CTL_PAGE_SAVED],
4191				       &ie_page_default,
4192				       sizeof(ie_page_default));
4193				page_index->page_data =
4194					(uint8_t *)lun->mode_pages.ie_page;
4195				break;
4196			case 0x02: {
4197				struct ctl_logical_block_provisioning_page *page;
4198
4199				memcpy(&lun->mode_pages.lbp_page[CTL_PAGE_DEFAULT],
4200				       &lbp_page_default,
4201				       sizeof(lbp_page_default));
4202				memcpy(&lun->mode_pages.lbp_page[
4203				       CTL_PAGE_CHANGEABLE], &lbp_page_changeable,
4204				       sizeof(lbp_page_changeable));
4205				memcpy(&lun->mode_pages.lbp_page[CTL_PAGE_SAVED],
4206				       &lbp_page_default,
4207				       sizeof(lbp_page_default));
4208				page = &lun->mode_pages.lbp_page[CTL_PAGE_SAVED];
4209				value = ctl_get_opt(&lun->be_lun->options,
4210				    "avail-threshold");
4211				if (value != NULL &&
4212				    ctl_expand_number(value, &ival) == 0) {
4213					page->descr[0].flags |= SLBPPD_ENABLED |
4214					    SLBPPD_ARMING_DEC;
4215					if (lun->be_lun->blocksize)
4216						ival /= lun->be_lun->blocksize;
4217					else
4218						ival /= 512;
4219					scsi_ulto4b(ival >> CTL_LBP_EXPONENT,
4220					    page->descr[0].count);
4221				}
4222				value = ctl_get_opt(&lun->be_lun->options,
4223				    "used-threshold");
4224				if (value != NULL &&
4225				    ctl_expand_number(value, &ival) == 0) {
4226					page->descr[1].flags |= SLBPPD_ENABLED |
4227					    SLBPPD_ARMING_INC;
4228					if (lun->be_lun->blocksize)
4229						ival /= lun->be_lun->blocksize;
4230					else
4231						ival /= 512;
4232					scsi_ulto4b(ival >> CTL_LBP_EXPONENT,
4233					    page->descr[1].count);
4234				}
4235				value = ctl_get_opt(&lun->be_lun->options,
4236				    "pool-avail-threshold");
4237				if (value != NULL &&
4238				    ctl_expand_number(value, &ival) == 0) {
4239					page->descr[2].flags |= SLBPPD_ENABLED |
4240					    SLBPPD_ARMING_DEC;
4241					if (lun->be_lun->blocksize)
4242						ival /= lun->be_lun->blocksize;
4243					else
4244						ival /= 512;
4245					scsi_ulto4b(ival >> CTL_LBP_EXPONENT,
4246					    page->descr[2].count);
4247				}
4248				value = ctl_get_opt(&lun->be_lun->options,
4249				    "pool-used-threshold");
4250				if (value != NULL &&
4251				    ctl_expand_number(value, &ival) == 0) {
4252					page->descr[3].flags |= SLBPPD_ENABLED |
4253					    SLBPPD_ARMING_INC;
4254					if (lun->be_lun->blocksize)
4255						ival /= lun->be_lun->blocksize;
4256					else
4257						ival /= 512;
4258					scsi_ulto4b(ival >> CTL_LBP_EXPONENT,
4259					    page->descr[3].count);
4260				}
4261				memcpy(&lun->mode_pages.lbp_page[CTL_PAGE_CURRENT],
4262				       &lun->mode_pages.lbp_page[CTL_PAGE_SAVED],
4263				       sizeof(lbp_page_default));
4264				page_index->page_data =
4265					(uint8_t *)lun->mode_pages.lbp_page;
4266				break;
4267			}
4268			default:
4269				panic("subpage %#x for page %#x is incorrect!",
4270				      page_index->subpage, page_code);
4271			}
4272			break;
4273		}
4274		case SMS_CDDVD_CAPS_PAGE:{
4275			KASSERT(page_index->subpage == SMS_SUBPAGE_PAGE_0,
4276			    ("subpage %#x for page %#x is incorrect!",
4277			    page_index->subpage, page_code));
4278			memcpy(&lun->mode_pages.cddvd_page[CTL_PAGE_DEFAULT],
4279			       &cddvd_page_default,
4280			       sizeof(cddvd_page_default));
4281			memcpy(&lun->mode_pages.cddvd_page[
4282			       CTL_PAGE_CHANGEABLE], &cddvd_page_changeable,
4283			       sizeof(cddvd_page_changeable));
4284			memcpy(&lun->mode_pages.cddvd_page[CTL_PAGE_SAVED],
4285			       &cddvd_page_default,
4286			       sizeof(cddvd_page_default));
4287			memcpy(&lun->mode_pages.cddvd_page[CTL_PAGE_CURRENT],
4288			       &lun->mode_pages.cddvd_page[CTL_PAGE_SAVED],
4289			       sizeof(cddvd_page_default));
4290			page_index->page_data =
4291				(uint8_t *)lun->mode_pages.cddvd_page;
4292			break;
4293		}
4294		default:
4295			panic("invalid page code value %#x", page_code);
4296		}
4297	}
4298
4299	return (CTL_RETVAL_COMPLETE);
4300}
4301
4302static int
4303ctl_init_log_page_index(struct ctl_lun *lun)
4304{
4305	struct ctl_page_index *page_index;
4306	int i, j, k, prev;
4307
4308	memcpy(&lun->log_pages.index, log_page_index_template,
4309	       sizeof(log_page_index_template));
4310
4311	prev = -1;
4312	for (i = 0, j = 0, k = 0; i < CTL_NUM_LOG_PAGES; i++) {
4313
4314		page_index = &lun->log_pages.index[i];
4315		if (lun->be_lun->lun_type == T_DIRECT &&
4316		    (page_index->page_flags & CTL_PAGE_FLAG_DIRECT) == 0)
4317			continue;
4318		if (lun->be_lun->lun_type == T_PROCESSOR &&
4319		    (page_index->page_flags & CTL_PAGE_FLAG_PROC) == 0)
4320			continue;
4321		if (lun->be_lun->lun_type == T_CDROM &&
4322		    (page_index->page_flags & CTL_PAGE_FLAG_CDROM) == 0)
4323			continue;
4324
4325		if (page_index->page_code == SLS_LOGICAL_BLOCK_PROVISIONING &&
4326		    lun->backend->lun_attr == NULL)
4327			continue;
4328
4329		if (page_index->page_code != prev) {
4330			lun->log_pages.pages_page[j] = page_index->page_code;
4331			prev = page_index->page_code;
4332			j++;
4333		}
4334		lun->log_pages.subpages_page[k*2] = page_index->page_code;
4335		lun->log_pages.subpages_page[k*2+1] = page_index->subpage;
4336		k++;
4337	}
4338	lun->log_pages.index[0].page_data = &lun->log_pages.pages_page[0];
4339	lun->log_pages.index[0].page_len = j;
4340	lun->log_pages.index[1].page_data = &lun->log_pages.subpages_page[0];
4341	lun->log_pages.index[1].page_len = k * 2;
4342	lun->log_pages.index[2].page_data = &lun->log_pages.lbp_page[0];
4343	lun->log_pages.index[2].page_len = 12*CTL_NUM_LBP_PARAMS;
4344	lun->log_pages.index[3].page_data = (uint8_t *)&lun->log_pages.stat_page;
4345	lun->log_pages.index[3].page_len = sizeof(lun->log_pages.stat_page);
4346	lun->log_pages.index[4].page_data = (uint8_t *)&lun->log_pages.ie_page;
4347	lun->log_pages.index[4].page_len = sizeof(lun->log_pages.ie_page);
4348
4349	return (CTL_RETVAL_COMPLETE);
4350}
4351
4352static int
4353hex2bin(const char *str, uint8_t *buf, int buf_size)
4354{
4355	int i;
4356	u_char c;
4357
4358	memset(buf, 0, buf_size);
4359	while (isspace(str[0]))
4360		str++;
4361	if (str[0] == '0' && (str[1] == 'x' || str[1] == 'X'))
4362		str += 2;
4363	buf_size *= 2;
4364	for (i = 0; str[i] != 0 && i < buf_size; i++) {
4365		c = str[i];
4366		if (isdigit(c))
4367			c -= '0';
4368		else if (isalpha(c))
4369			c -= isupper(c) ? 'A' - 10 : 'a' - 10;
4370		else
4371			break;
4372		if (c >= 16)
4373			break;
4374		if ((i & 1) == 0)
4375			buf[i / 2] |= (c << 4);
4376		else
4377			buf[i / 2] |= c;
4378	}
4379	return ((i + 1) / 2);
4380}
4381
4382/*
4383 * LUN allocation.
4384 *
4385 * Requirements:
4386 * - caller allocates and zeros LUN storage, or passes in a NULL LUN if he
4387 *   wants us to allocate the LUN and he can block.
4388 * - ctl_softc is always set
4389 * - be_lun is set if the LUN has a backend (needed for disk LUNs)
4390 *
4391 * Returns 0 for success, non-zero (errno) for failure.
4392 */
4393static int
4394ctl_alloc_lun(struct ctl_softc *ctl_softc, struct ctl_lun *ctl_lun,
4395	      struct ctl_be_lun *const be_lun)
4396{
4397	struct ctl_lun *nlun, *lun;
4398	struct scsi_vpd_id_descriptor *desc;
4399	struct scsi_vpd_id_t10 *t10id;
4400	const char *eui, *naa, *scsiname, *vendor, *value;
4401	int lun_number, i, lun_malloced;
4402	int devidlen, idlen1, idlen2 = 0, len;
4403
4404	if (be_lun == NULL)
4405		return (EINVAL);
4406
4407	/*
4408	 * We currently only support Direct Access or Processor LUN types.
4409	 */
4410	switch (be_lun->lun_type) {
4411	case T_DIRECT:
4412	case T_PROCESSOR:
4413	case T_CDROM:
4414		break;
4415	case T_SEQUENTIAL:
4416	case T_CHANGER:
4417	default:
4418		be_lun->lun_config_status(be_lun->be_lun,
4419					  CTL_LUN_CONFIG_FAILURE);
4420		break;
4421	}
4422	if (ctl_lun == NULL) {
4423		lun = malloc(sizeof(*lun), M_CTL, M_WAITOK);
4424		lun_malloced = 1;
4425	} else {
4426		lun_malloced = 0;
4427		lun = ctl_lun;
4428	}
4429
4430	memset(lun, 0, sizeof(*lun));
4431	if (lun_malloced)
4432		lun->flags = CTL_LUN_MALLOCED;
4433
4434	/* Generate LUN ID. */
4435	devidlen = max(CTL_DEVID_MIN_LEN,
4436	    strnlen(be_lun->device_id, CTL_DEVID_LEN));
4437	idlen1 = sizeof(*t10id) + devidlen;
4438	len = sizeof(struct scsi_vpd_id_descriptor) + idlen1;
4439	scsiname = ctl_get_opt(&be_lun->options, "scsiname");
4440	if (scsiname != NULL) {
4441		idlen2 = roundup2(strlen(scsiname) + 1, 4);
4442		len += sizeof(struct scsi_vpd_id_descriptor) + idlen2;
4443	}
4444	eui = ctl_get_opt(&be_lun->options, "eui");
4445	if (eui != NULL) {
4446		len += sizeof(struct scsi_vpd_id_descriptor) + 16;
4447	}
4448	naa = ctl_get_opt(&be_lun->options, "naa");
4449	if (naa != NULL) {
4450		len += sizeof(struct scsi_vpd_id_descriptor) + 16;
4451	}
4452	lun->lun_devid = malloc(sizeof(struct ctl_devid) + len,
4453	    M_CTL, M_WAITOK | M_ZERO);
4454	desc = (struct scsi_vpd_id_descriptor *)lun->lun_devid->data;
4455	desc->proto_codeset = SVPD_ID_CODESET_ASCII;
4456	desc->id_type = SVPD_ID_PIV | SVPD_ID_ASSOC_LUN | SVPD_ID_TYPE_T10;
4457	desc->length = idlen1;
4458	t10id = (struct scsi_vpd_id_t10 *)&desc->identifier[0];
4459	memset(t10id->vendor, ' ', sizeof(t10id->vendor));
4460	if ((vendor = ctl_get_opt(&be_lun->options, "vendor")) == NULL) {
4461		strncpy((char *)t10id->vendor, CTL_VENDOR, sizeof(t10id->vendor));
4462	} else {
4463		strncpy(t10id->vendor, vendor,
4464		    min(sizeof(t10id->vendor), strlen(vendor)));
4465	}
4466	strncpy((char *)t10id->vendor_spec_id,
4467	    (char *)be_lun->device_id, devidlen);
4468	if (scsiname != NULL) {
4469		desc = (struct scsi_vpd_id_descriptor *)(&desc->identifier[0] +
4470		    desc->length);
4471		desc->proto_codeset = SVPD_ID_CODESET_UTF8;
4472		desc->id_type = SVPD_ID_PIV | SVPD_ID_ASSOC_LUN |
4473		    SVPD_ID_TYPE_SCSI_NAME;
4474		desc->length = idlen2;
4475		strlcpy(desc->identifier, scsiname, idlen2);
4476	}
4477	if (eui != NULL) {
4478		desc = (struct scsi_vpd_id_descriptor *)(&desc->identifier[0] +
4479		    desc->length);
4480		desc->proto_codeset = SVPD_ID_CODESET_BINARY;
4481		desc->id_type = SVPD_ID_PIV | SVPD_ID_ASSOC_LUN |
4482		    SVPD_ID_TYPE_EUI64;
4483		desc->length = hex2bin(eui, desc->identifier, 16);
4484		desc->length = desc->length > 12 ? 16 :
4485		    (desc->length > 8 ? 12 : 8);
4486		len -= 16 - desc->length;
4487	}
4488	if (naa != NULL) {
4489		desc = (struct scsi_vpd_id_descriptor *)(&desc->identifier[0] +
4490		    desc->length);
4491		desc->proto_codeset = SVPD_ID_CODESET_BINARY;
4492		desc->id_type = SVPD_ID_PIV | SVPD_ID_ASSOC_LUN |
4493		    SVPD_ID_TYPE_NAA;
4494		desc->length = hex2bin(naa, desc->identifier, 16);
4495		desc->length = desc->length > 8 ? 16 : 8;
4496		len -= 16 - desc->length;
4497	}
4498	lun->lun_devid->len = len;
4499
4500	mtx_lock(&ctl_softc->ctl_lock);
4501	/*
4502	 * See if the caller requested a particular LUN number.  If so, see
4503	 * if it is available.  Otherwise, allocate the first available LUN.
4504	 */
4505	if (be_lun->flags & CTL_LUN_FLAG_ID_REQ) {
4506		if ((be_lun->req_lun_id > (CTL_MAX_LUNS - 1))
4507		 || (ctl_is_set(ctl_softc->ctl_lun_mask, be_lun->req_lun_id))) {
4508			mtx_unlock(&ctl_softc->ctl_lock);
4509			if (be_lun->req_lun_id > (CTL_MAX_LUNS - 1)) {
4510				printf("ctl: requested LUN ID %d is higher "
4511				       "than CTL_MAX_LUNS - 1 (%d)\n",
4512				       be_lun->req_lun_id, CTL_MAX_LUNS - 1);
4513			} else {
4514				/*
4515				 * XXX KDM return an error, or just assign
4516				 * another LUN ID in this case??
4517				 */
4518				printf("ctl: requested LUN ID %d is already "
4519				       "in use\n", be_lun->req_lun_id);
4520			}
4521			if (lun->flags & CTL_LUN_MALLOCED)
4522				free(lun, M_CTL);
4523			be_lun->lun_config_status(be_lun->be_lun,
4524						  CTL_LUN_CONFIG_FAILURE);
4525			return (ENOSPC);
4526		}
4527		lun_number = be_lun->req_lun_id;
4528	} else {
4529		lun_number = ctl_ffz(ctl_softc->ctl_lun_mask, 0, CTL_MAX_LUNS);
4530		if (lun_number == -1) {
4531			mtx_unlock(&ctl_softc->ctl_lock);
4532			printf("ctl: can't allocate LUN, out of LUNs\n");
4533			if (lun->flags & CTL_LUN_MALLOCED)
4534				free(lun, M_CTL);
4535			be_lun->lun_config_status(be_lun->be_lun,
4536						  CTL_LUN_CONFIG_FAILURE);
4537			return (ENOSPC);
4538		}
4539	}
4540	ctl_set_mask(ctl_softc->ctl_lun_mask, lun_number);
4541
4542	mtx_init(&lun->lun_lock, "CTL LUN", NULL, MTX_DEF);
4543	lun->lun = lun_number;
4544	lun->be_lun = be_lun;
4545	/*
4546	 * The processor LUN is always enabled.  Disk LUNs come on line
4547	 * disabled, and must be enabled by the backend.
4548	 */
4549	lun->flags |= CTL_LUN_DISABLED;
4550	lun->backend = be_lun->be;
4551	be_lun->ctl_lun = lun;
4552	be_lun->lun_id = lun_number;
4553	atomic_add_int(&be_lun->be->num_luns, 1);
4554	if (be_lun->flags & CTL_LUN_FLAG_EJECTED)
4555		lun->flags |= CTL_LUN_EJECTED;
4556	if (be_lun->flags & CTL_LUN_FLAG_NO_MEDIA)
4557		lun->flags |= CTL_LUN_NO_MEDIA;
4558	if (be_lun->flags & CTL_LUN_FLAG_STOPPED)
4559		lun->flags |= CTL_LUN_STOPPED;
4560
4561	if (be_lun->flags & CTL_LUN_FLAG_PRIMARY)
4562		lun->flags |= CTL_LUN_PRIMARY_SC;
4563
4564	value = ctl_get_opt(&be_lun->options, "removable");
4565	if (value != NULL) {
4566		if (strcmp(value, "on") == 0)
4567			lun->flags |= CTL_LUN_REMOVABLE;
4568	} else if (be_lun->lun_type == T_CDROM)
4569		lun->flags |= CTL_LUN_REMOVABLE;
4570
4571	lun->ctl_softc = ctl_softc;
4572#ifdef CTL_TIME_IO
4573	lun->last_busy = getsbinuptime();
4574#endif
4575	TAILQ_INIT(&lun->ooa_queue);
4576	TAILQ_INIT(&lun->blocked_queue);
4577	STAILQ_INIT(&lun->error_list);
4578	lun->ie_reported = 1;
4579	callout_init_mtx(&lun->ie_callout, &lun->lun_lock, 0);
4580	ctl_tpc_lun_init(lun);
4581
4582	/*
4583	 * Initialize the mode and log page index.
4584	 */
4585	ctl_init_page_index(lun);
4586	ctl_init_log_page_index(lun);
4587
4588	/*
4589	 * Now, before we insert this lun on the lun list, set the lun
4590	 * inventory changed UA for all other luns.
4591	 */
4592	STAILQ_FOREACH(nlun, &ctl_softc->lun_list, links) {
4593		mtx_lock(&nlun->lun_lock);
4594		ctl_est_ua_all(nlun, -1, CTL_UA_LUN_CHANGE);
4595		mtx_unlock(&nlun->lun_lock);
4596	}
4597
4598	STAILQ_INSERT_TAIL(&ctl_softc->lun_list, lun, links);
4599
4600	ctl_softc->ctl_luns[lun_number] = lun;
4601
4602	ctl_softc->num_luns++;
4603
4604	/* Setup statistics gathering */
4605	lun->stats.device_type = be_lun->lun_type;
4606	lun->stats.lun_number = lun_number;
4607	lun->stats.blocksize = be_lun->blocksize;
4608	if (be_lun->blocksize == 0)
4609		lun->stats.flags = CTL_LUN_STATS_NO_BLOCKSIZE;
4610	for (i = 0;i < CTL_MAX_PORTS;i++)
4611		lun->stats.ports[i].targ_port = i;
4612
4613	mtx_unlock(&ctl_softc->ctl_lock);
4614
4615	lun->be_lun->lun_config_status(lun->be_lun->be_lun, CTL_LUN_CONFIG_OK);
4616	return (0);
4617}
4618
4619/*
4620 * Delete a LUN.
4621 * Assumptions:
4622 * - LUN has already been marked invalid and any pending I/O has been taken
4623 *   care of.
4624 */
4625static int
4626ctl_free_lun(struct ctl_lun *lun)
4627{
4628	struct ctl_softc *softc;
4629	struct ctl_lun *nlun;
4630	int i;
4631
4632	softc = lun->ctl_softc;
4633
4634	mtx_assert(&softc->ctl_lock, MA_OWNED);
4635
4636	STAILQ_REMOVE(&softc->lun_list, lun, ctl_lun, links);
4637
4638	ctl_clear_mask(softc->ctl_lun_mask, lun->lun);
4639
4640	softc->ctl_luns[lun->lun] = NULL;
4641
4642	if (!TAILQ_EMPTY(&lun->ooa_queue))
4643		panic("Freeing a LUN %p with outstanding I/O!!\n", lun);
4644
4645	softc->num_luns--;
4646
4647	/*
4648	 * Tell the backend to free resources, if this LUN has a backend.
4649	 */
4650	atomic_subtract_int(&lun->be_lun->be->num_luns, 1);
4651	lun->be_lun->lun_shutdown(lun->be_lun->be_lun);
4652
4653	lun->ie_reportcnt = UINT32_MAX;
4654	callout_drain(&lun->ie_callout);
4655
4656	ctl_tpc_lun_shutdown(lun);
4657	mtx_destroy(&lun->lun_lock);
4658	free(lun->lun_devid, M_CTL);
4659	for (i = 0; i < CTL_MAX_PORTS; i++)
4660		free(lun->pending_ua[i], M_CTL);
4661	for (i = 0; i < CTL_MAX_PORTS; i++)
4662		free(lun->pr_keys[i], M_CTL);
4663	free(lun->write_buffer, M_CTL);
4664	if (lun->flags & CTL_LUN_MALLOCED)
4665		free(lun, M_CTL);
4666
4667	STAILQ_FOREACH(nlun, &softc->lun_list, links) {
4668		mtx_lock(&nlun->lun_lock);
4669		ctl_est_ua_all(nlun, -1, CTL_UA_LUN_CHANGE);
4670		mtx_unlock(&nlun->lun_lock);
4671	}
4672
4673	return (0);
4674}
4675
4676static void
4677ctl_create_lun(struct ctl_be_lun *be_lun)
4678{
4679
4680	/*
4681	 * ctl_alloc_lun() should handle all potential failure cases.
4682	 */
4683	ctl_alloc_lun(control_softc, NULL, be_lun);
4684}
4685
4686int
4687ctl_add_lun(struct ctl_be_lun *be_lun)
4688{
4689	struct ctl_softc *softc = control_softc;
4690
4691	mtx_lock(&softc->ctl_lock);
4692	STAILQ_INSERT_TAIL(&softc->pending_lun_queue, be_lun, links);
4693	mtx_unlock(&softc->ctl_lock);
4694	wakeup(&softc->pending_lun_queue);
4695
4696	return (0);
4697}
4698
4699int
4700ctl_enable_lun(struct ctl_be_lun *be_lun)
4701{
4702	struct ctl_softc *softc;
4703	struct ctl_port *port, *nport;
4704	struct ctl_lun *lun;
4705	int retval;
4706
4707	lun = (struct ctl_lun *)be_lun->ctl_lun;
4708	softc = lun->ctl_softc;
4709
4710	mtx_lock(&softc->ctl_lock);
4711	mtx_lock(&lun->lun_lock);
4712	if ((lun->flags & CTL_LUN_DISABLED) == 0) {
4713		/*
4714		 * eh?  Why did we get called if the LUN is already
4715		 * enabled?
4716		 */
4717		mtx_unlock(&lun->lun_lock);
4718		mtx_unlock(&softc->ctl_lock);
4719		return (0);
4720	}
4721	lun->flags &= ~CTL_LUN_DISABLED;
4722	mtx_unlock(&lun->lun_lock);
4723
4724	STAILQ_FOREACH_SAFE(port, &softc->port_list, links, nport) {
4725		if ((port->status & CTL_PORT_STATUS_ONLINE) == 0 ||
4726		    port->lun_map != NULL || port->lun_enable == NULL)
4727			continue;
4728
4729		/*
4730		 * Drop the lock while we call the FETD's enable routine.
4731		 * This can lead to a callback into CTL (at least in the
4732		 * case of the internal initiator frontend.
4733		 */
4734		mtx_unlock(&softc->ctl_lock);
4735		retval = port->lun_enable(port->targ_lun_arg, lun->lun);
4736		mtx_lock(&softc->ctl_lock);
4737		if (retval != 0) {
4738			printf("%s: FETD %s port %d returned error "
4739			       "%d for lun_enable on lun %jd\n",
4740			       __func__, port->port_name, port->targ_port,
4741			       retval, (intmax_t)lun->lun);
4742		}
4743	}
4744
4745	mtx_unlock(&softc->ctl_lock);
4746	ctl_isc_announce_lun(lun);
4747
4748	return (0);
4749}
4750
4751int
4752ctl_disable_lun(struct ctl_be_lun *be_lun)
4753{
4754	struct ctl_softc *softc;
4755	struct ctl_port *port;
4756	struct ctl_lun *lun;
4757	int retval;
4758
4759	lun = (struct ctl_lun *)be_lun->ctl_lun;
4760	softc = lun->ctl_softc;
4761
4762	mtx_lock(&softc->ctl_lock);
4763	mtx_lock(&lun->lun_lock);
4764	if (lun->flags & CTL_LUN_DISABLED) {
4765		mtx_unlock(&lun->lun_lock);
4766		mtx_unlock(&softc->ctl_lock);
4767		return (0);
4768	}
4769	lun->flags |= CTL_LUN_DISABLED;
4770	mtx_unlock(&lun->lun_lock);
4771
4772	STAILQ_FOREACH(port, &softc->port_list, links) {
4773		if ((port->status & CTL_PORT_STATUS_ONLINE) == 0 ||
4774		    port->lun_map != NULL || port->lun_disable == NULL)
4775			continue;
4776
4777		/*
4778		 * Drop the lock before we call the frontend's disable
4779		 * routine, to avoid lock order reversals.
4780		 *
4781		 * XXX KDM what happens if the frontend list changes while
4782		 * we're traversing it?  It's unlikely, but should be handled.
4783		 */
4784		mtx_unlock(&softc->ctl_lock);
4785		retval = port->lun_disable(port->targ_lun_arg, lun->lun);
4786		mtx_lock(&softc->ctl_lock);
4787		if (retval != 0) {
4788			printf("%s: FETD %s port %d returned error "
4789			       "%d for lun_disable on lun %jd\n",
4790			       __func__, port->port_name, port->targ_port,
4791			       retval, (intmax_t)lun->lun);
4792		}
4793	}
4794
4795	mtx_unlock(&softc->ctl_lock);
4796	ctl_isc_announce_lun(lun);
4797
4798	return (0);
4799}
4800
4801int
4802ctl_start_lun(struct ctl_be_lun *be_lun)
4803{
4804	struct ctl_lun *lun = (struct ctl_lun *)be_lun->ctl_lun;
4805
4806	mtx_lock(&lun->lun_lock);
4807	lun->flags &= ~CTL_LUN_STOPPED;
4808	mtx_unlock(&lun->lun_lock);
4809	return (0);
4810}
4811
4812int
4813ctl_stop_lun(struct ctl_be_lun *be_lun)
4814{
4815	struct ctl_lun *lun = (struct ctl_lun *)be_lun->ctl_lun;
4816
4817	mtx_lock(&lun->lun_lock);
4818	lun->flags |= CTL_LUN_STOPPED;
4819	mtx_unlock(&lun->lun_lock);
4820	return (0);
4821}
4822
4823int
4824ctl_lun_no_media(struct ctl_be_lun *be_lun)
4825{
4826	struct ctl_lun *lun = (struct ctl_lun *)be_lun->ctl_lun;
4827
4828	mtx_lock(&lun->lun_lock);
4829	lun->flags |= CTL_LUN_NO_MEDIA;
4830	mtx_unlock(&lun->lun_lock);
4831	return (0);
4832}
4833
4834int
4835ctl_lun_has_media(struct ctl_be_lun *be_lun)
4836{
4837	struct ctl_lun *lun = (struct ctl_lun *)be_lun->ctl_lun;
4838	union ctl_ha_msg msg;
4839
4840	mtx_lock(&lun->lun_lock);
4841	lun->flags &= ~(CTL_LUN_NO_MEDIA | CTL_LUN_EJECTED);
4842	if (lun->flags & CTL_LUN_REMOVABLE)
4843		ctl_est_ua_all(lun, -1, CTL_UA_MEDIUM_CHANGE);
4844	mtx_unlock(&lun->lun_lock);
4845	if ((lun->flags & CTL_LUN_REMOVABLE) &&
4846	    lun->ctl_softc->ha_mode == CTL_HA_MODE_XFER) {
4847		bzero(&msg.ua, sizeof(msg.ua));
4848		msg.hdr.msg_type = CTL_MSG_UA;
4849		msg.hdr.nexus.initid = -1;
4850		msg.hdr.nexus.targ_port = -1;
4851		msg.hdr.nexus.targ_lun = lun->lun;
4852		msg.hdr.nexus.targ_mapped_lun = lun->lun;
4853		msg.ua.ua_all = 1;
4854		msg.ua.ua_set = 1;
4855		msg.ua.ua_type = CTL_UA_MEDIUM_CHANGE;
4856		ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg, sizeof(msg.ua),
4857		    M_WAITOK);
4858	}
4859	return (0);
4860}
4861
4862int
4863ctl_lun_ejected(struct ctl_be_lun *be_lun)
4864{
4865	struct ctl_lun *lun = (struct ctl_lun *)be_lun->ctl_lun;
4866
4867	mtx_lock(&lun->lun_lock);
4868	lun->flags |= CTL_LUN_EJECTED;
4869	mtx_unlock(&lun->lun_lock);
4870	return (0);
4871}
4872
4873int
4874ctl_lun_primary(struct ctl_be_lun *be_lun)
4875{
4876	struct ctl_lun *lun = (struct ctl_lun *)be_lun->ctl_lun;
4877
4878	mtx_lock(&lun->lun_lock);
4879	lun->flags |= CTL_LUN_PRIMARY_SC;
4880	ctl_est_ua_all(lun, -1, CTL_UA_ASYM_ACC_CHANGE);
4881	mtx_unlock(&lun->lun_lock);
4882	ctl_isc_announce_lun(lun);
4883	return (0);
4884}
4885
4886int
4887ctl_lun_secondary(struct ctl_be_lun *be_lun)
4888{
4889	struct ctl_lun *lun = (struct ctl_lun *)be_lun->ctl_lun;
4890
4891	mtx_lock(&lun->lun_lock);
4892	lun->flags &= ~CTL_LUN_PRIMARY_SC;
4893	ctl_est_ua_all(lun, -1, CTL_UA_ASYM_ACC_CHANGE);
4894	mtx_unlock(&lun->lun_lock);
4895	ctl_isc_announce_lun(lun);
4896	return (0);
4897}
4898
4899int
4900ctl_invalidate_lun(struct ctl_be_lun *be_lun)
4901{
4902	struct ctl_softc *softc;
4903	struct ctl_lun *lun;
4904
4905	lun = (struct ctl_lun *)be_lun->ctl_lun;
4906	softc = lun->ctl_softc;
4907
4908	mtx_lock(&lun->lun_lock);
4909
4910	/*
4911	 * The LUN needs to be disabled before it can be marked invalid.
4912	 */
4913	if ((lun->flags & CTL_LUN_DISABLED) == 0) {
4914		mtx_unlock(&lun->lun_lock);
4915		return (-1);
4916	}
4917	/*
4918	 * Mark the LUN invalid.
4919	 */
4920	lun->flags |= CTL_LUN_INVALID;
4921
4922	/*
4923	 * If there is nothing in the OOA queue, go ahead and free the LUN.
4924	 * If we have something in the OOA queue, we'll free it when the
4925	 * last I/O completes.
4926	 */
4927	if (TAILQ_EMPTY(&lun->ooa_queue)) {
4928		mtx_unlock(&lun->lun_lock);
4929		mtx_lock(&softc->ctl_lock);
4930		ctl_free_lun(lun);
4931		mtx_unlock(&softc->ctl_lock);
4932	} else
4933		mtx_unlock(&lun->lun_lock);
4934
4935	return (0);
4936}
4937
4938void
4939ctl_lun_capacity_changed(struct ctl_be_lun *be_lun)
4940{
4941	struct ctl_lun *lun = (struct ctl_lun *)be_lun->ctl_lun;
4942	union ctl_ha_msg msg;
4943
4944	mtx_lock(&lun->lun_lock);
4945	ctl_est_ua_all(lun, -1, CTL_UA_CAPACITY_CHANGE);
4946	mtx_unlock(&lun->lun_lock);
4947	if (lun->ctl_softc->ha_mode == CTL_HA_MODE_XFER) {
4948		/* Send msg to other side. */
4949		bzero(&msg.ua, sizeof(msg.ua));
4950		msg.hdr.msg_type = CTL_MSG_UA;
4951		msg.hdr.nexus.initid = -1;
4952		msg.hdr.nexus.targ_port = -1;
4953		msg.hdr.nexus.targ_lun = lun->lun;
4954		msg.hdr.nexus.targ_mapped_lun = lun->lun;
4955		msg.ua.ua_all = 1;
4956		msg.ua.ua_set = 1;
4957		msg.ua.ua_type = CTL_UA_CAPACITY_CHANGE;
4958		ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg, sizeof(msg.ua),
4959		    M_WAITOK);
4960	}
4961}
4962
4963/*
4964 * Backend "memory move is complete" callback for requests that never
4965 * make it down to say RAIDCore's configuration code.
4966 */
4967int
4968ctl_config_move_done(union ctl_io *io)
4969{
4970	int retval;
4971
4972	CTL_DEBUG_PRINT(("ctl_config_move_done\n"));
4973	KASSERT(io->io_hdr.io_type == CTL_IO_SCSI,
4974	    ("Config I/O type isn't CTL_IO_SCSI (%d)!", io->io_hdr.io_type));
4975
4976	if ((io->io_hdr.port_status != 0) &&
4977	    ((io->io_hdr.status & CTL_STATUS_MASK) == CTL_STATUS_NONE ||
4978	     (io->io_hdr.status & CTL_STATUS_MASK) == CTL_SUCCESS)) {
4979		/*
4980		 * For hardware error sense keys, the sense key
4981		 * specific value is defined to be a retry count,
4982		 * but we use it to pass back an internal FETD
4983		 * error code.  XXX KDM  Hopefully the FETD is only
4984		 * using 16 bits for an error code, since that's
4985		 * all the space we have in the sks field.
4986		 */
4987		ctl_set_internal_failure(&io->scsiio,
4988					 /*sks_valid*/ 1,
4989					 /*retry_count*/
4990					 io->io_hdr.port_status);
4991	}
4992
4993	if (ctl_debug & CTL_DEBUG_CDB_DATA)
4994		ctl_data_print(io);
4995	if (((io->io_hdr.flags & CTL_FLAG_DATA_MASK) == CTL_FLAG_DATA_IN) ||
4996	    ((io->io_hdr.status & CTL_STATUS_MASK) != CTL_STATUS_NONE &&
4997	     (io->io_hdr.status & CTL_STATUS_MASK) != CTL_SUCCESS) ||
4998	    ((io->io_hdr.flags & CTL_FLAG_ABORT) != 0)) {
4999		/*
5000		 * XXX KDM just assuming a single pointer here, and not a
5001		 * S/G list.  If we start using S/G lists for config data,
5002		 * we'll need to know how to clean them up here as well.
5003		 */
5004		if (io->io_hdr.flags & CTL_FLAG_ALLOCATED)
5005			free(io->scsiio.kern_data_ptr, M_CTL);
5006		ctl_done(io);
5007		retval = CTL_RETVAL_COMPLETE;
5008	} else {
5009		/*
5010		 * XXX KDM now we need to continue data movement.  Some
5011		 * options:
5012		 * - call ctl_scsiio() again?  We don't do this for data
5013		 *   writes, because for those at least we know ahead of
5014		 *   time where the write will go and how long it is.  For
5015		 *   config writes, though, that information is largely
5016		 *   contained within the write itself, thus we need to
5017		 *   parse out the data again.
5018		 *
5019		 * - Call some other function once the data is in?
5020		 */
5021
5022		/*
5023		 * XXX KDM call ctl_scsiio() again for now, and check flag
5024		 * bits to see whether we're allocated or not.
5025		 */
5026		retval = ctl_scsiio(&io->scsiio);
5027	}
5028	return (retval);
5029}
5030
5031/*
5032 * This gets called by a backend driver when it is done with a
5033 * data_submit method.
5034 */
5035void
5036ctl_data_submit_done(union ctl_io *io)
5037{
5038	/*
5039	 * If the IO_CONT flag is set, we need to call the supplied
5040	 * function to continue processing the I/O, instead of completing
5041	 * the I/O just yet.
5042	 *
5043	 * If there is an error, though, we don't want to keep processing.
5044	 * Instead, just send status back to the initiator.
5045	 */
5046	if ((io->io_hdr.flags & CTL_FLAG_IO_CONT) &&
5047	    (io->io_hdr.flags & CTL_FLAG_ABORT) == 0 &&
5048	    ((io->io_hdr.status & CTL_STATUS_MASK) == CTL_STATUS_NONE ||
5049	     (io->io_hdr.status & CTL_STATUS_MASK) == CTL_SUCCESS)) {
5050		io->scsiio.io_cont(io);
5051		return;
5052	}
5053	ctl_done(io);
5054}
5055
5056/*
5057 * This gets called by a backend driver when it is done with a
5058 * configuration write.
5059 */
5060void
5061ctl_config_write_done(union ctl_io *io)
5062{
5063	uint8_t *buf;
5064
5065	/*
5066	 * If the IO_CONT flag is set, we need to call the supplied
5067	 * function to continue processing the I/O, instead of completing
5068	 * the I/O just yet.
5069	 *
5070	 * If there is an error, though, we don't want to keep processing.
5071	 * Instead, just send status back to the initiator.
5072	 */
5073	if ((io->io_hdr.flags & CTL_FLAG_IO_CONT) &&
5074	    (io->io_hdr.flags & CTL_FLAG_ABORT) == 0 &&
5075	    ((io->io_hdr.status & CTL_STATUS_MASK) == CTL_STATUS_NONE ||
5076	     (io->io_hdr.status & CTL_STATUS_MASK) == CTL_SUCCESS)) {
5077		io->scsiio.io_cont(io);
5078		return;
5079	}
5080	/*
5081	 * Since a configuration write can be done for commands that actually
5082	 * have data allocated, like write buffer, and commands that have
5083	 * no data, like start/stop unit, we need to check here.
5084	 */
5085	if (io->io_hdr.flags & CTL_FLAG_ALLOCATED)
5086		buf = io->scsiio.kern_data_ptr;
5087	else
5088		buf = NULL;
5089	ctl_done(io);
5090	if (buf)
5091		free(buf, M_CTL);
5092}
5093
5094void
5095ctl_config_read_done(union ctl_io *io)
5096{
5097	uint8_t *buf;
5098
5099	/*
5100	 * If there is some error -- we are done, skip data transfer.
5101	 */
5102	if ((io->io_hdr.flags & CTL_FLAG_ABORT) != 0 ||
5103	    ((io->io_hdr.status & CTL_STATUS_MASK) != CTL_STATUS_NONE &&
5104	     (io->io_hdr.status & CTL_STATUS_MASK) != CTL_SUCCESS)) {
5105		if (io->io_hdr.flags & CTL_FLAG_ALLOCATED)
5106			buf = io->scsiio.kern_data_ptr;
5107		else
5108			buf = NULL;
5109		ctl_done(io);
5110		if (buf)
5111			free(buf, M_CTL);
5112		return;
5113	}
5114
5115	/*
5116	 * If the IO_CONT flag is set, we need to call the supplied
5117	 * function to continue processing the I/O, instead of completing
5118	 * the I/O just yet.
5119	 */
5120	if (io->io_hdr.flags & CTL_FLAG_IO_CONT) {
5121		io->scsiio.io_cont(io);
5122		return;
5123	}
5124
5125	ctl_datamove(io);
5126}
5127
5128/*
5129 * SCSI release command.
5130 */
5131int
5132ctl_scsi_release(struct ctl_scsiio *ctsio)
5133{
5134	struct ctl_lun *lun;
5135	uint32_t residx;
5136
5137	CTL_DEBUG_PRINT(("ctl_scsi_release\n"));
5138
5139	residx = ctl_get_initindex(&ctsio->io_hdr.nexus);
5140	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5141
5142	/*
5143	 * XXX KDM right now, we only support LUN reservation.  We don't
5144	 * support 3rd party reservations, or extent reservations, which
5145	 * might actually need the parameter list.  If we've gotten this
5146	 * far, we've got a LUN reservation.  Anything else got kicked out
5147	 * above.  So, according to SPC, ignore the length.
5148	 */
5149
5150	mtx_lock(&lun->lun_lock);
5151
5152	/*
5153	 * According to SPC, it is not an error for an intiator to attempt
5154	 * to release a reservation on a LUN that isn't reserved, or that
5155	 * is reserved by another initiator.  The reservation can only be
5156	 * released, though, by the initiator who made it or by one of
5157	 * several reset type events.
5158	 */
5159	if ((lun->flags & CTL_LUN_RESERVED) && (lun->res_idx == residx))
5160			lun->flags &= ~CTL_LUN_RESERVED;
5161
5162	mtx_unlock(&lun->lun_lock);
5163
5164	ctl_set_success(ctsio);
5165	ctl_done((union ctl_io *)ctsio);
5166	return (CTL_RETVAL_COMPLETE);
5167}
5168
5169int
5170ctl_scsi_reserve(struct ctl_scsiio *ctsio)
5171{
5172	struct ctl_lun *lun;
5173	uint32_t residx;
5174
5175	CTL_DEBUG_PRINT(("ctl_reserve\n"));
5176
5177	residx = ctl_get_initindex(&ctsio->io_hdr.nexus);
5178	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5179
5180	/*
5181	 * XXX KDM right now, we only support LUN reservation.  We don't
5182	 * support 3rd party reservations, or extent reservations, which
5183	 * might actually need the parameter list.  If we've gotten this
5184	 * far, we've got a LUN reservation.  Anything else got kicked out
5185	 * above.  So, according to SPC, ignore the length.
5186	 */
5187
5188	mtx_lock(&lun->lun_lock);
5189	if ((lun->flags & CTL_LUN_RESERVED) && (lun->res_idx != residx)) {
5190		ctl_set_reservation_conflict(ctsio);
5191		goto bailout;
5192	}
5193
5194	/* SPC-3 exceptions to SPC-2 RESERVE and RELEASE behavior. */
5195	if (lun->flags & CTL_LUN_PR_RESERVED) {
5196		ctl_set_success(ctsio);
5197		goto bailout;
5198	}
5199
5200	lun->flags |= CTL_LUN_RESERVED;
5201	lun->res_idx = residx;
5202	ctl_set_success(ctsio);
5203
5204bailout:
5205	mtx_unlock(&lun->lun_lock);
5206	ctl_done((union ctl_io *)ctsio);
5207	return (CTL_RETVAL_COMPLETE);
5208}
5209
5210int
5211ctl_start_stop(struct ctl_scsiio *ctsio)
5212{
5213	struct scsi_start_stop_unit *cdb;
5214	struct ctl_lun *lun;
5215	int retval;
5216
5217	CTL_DEBUG_PRINT(("ctl_start_stop\n"));
5218
5219	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5220	cdb = (struct scsi_start_stop_unit *)ctsio->cdb;
5221
5222	if ((cdb->how & SSS_PC_MASK) == 0) {
5223		if ((lun->flags & CTL_LUN_PR_RESERVED) &&
5224		    (cdb->how & SSS_START) == 0) {
5225			uint32_t residx;
5226
5227			residx = ctl_get_initindex(&ctsio->io_hdr.nexus);
5228			if (ctl_get_prkey(lun, residx) == 0 ||
5229			    (lun->pr_res_idx != residx && lun->pr_res_type < 4)) {
5230
5231				ctl_set_reservation_conflict(ctsio);
5232				ctl_done((union ctl_io *)ctsio);
5233				return (CTL_RETVAL_COMPLETE);
5234			}
5235		}
5236
5237		if ((cdb->how & SSS_LOEJ) &&
5238		    (lun->flags & CTL_LUN_REMOVABLE) == 0) {
5239			ctl_set_invalid_field(ctsio,
5240					      /*sks_valid*/ 1,
5241					      /*command*/ 1,
5242					      /*field*/ 4,
5243					      /*bit_valid*/ 1,
5244					      /*bit*/ 1);
5245			ctl_done((union ctl_io *)ctsio);
5246			return (CTL_RETVAL_COMPLETE);
5247		}
5248
5249		if ((cdb->how & SSS_START) == 0 && (cdb->how & SSS_LOEJ) &&
5250		    lun->prevent_count > 0) {
5251			/* "Medium removal prevented" */
5252			ctl_set_sense(ctsio, /*current_error*/ 1,
5253			    /*sense_key*/(lun->flags & CTL_LUN_NO_MEDIA) ?
5254			     SSD_KEY_NOT_READY : SSD_KEY_ILLEGAL_REQUEST,
5255			    /*asc*/ 0x53, /*ascq*/ 0x02, SSD_ELEM_NONE);
5256			ctl_done((union ctl_io *)ctsio);
5257			return (CTL_RETVAL_COMPLETE);
5258		}
5259	}
5260
5261	retval = lun->backend->config_write((union ctl_io *)ctsio);
5262	return (retval);
5263}
5264
5265int
5266ctl_prevent_allow(struct ctl_scsiio *ctsio)
5267{
5268	struct ctl_lun *lun;
5269	struct scsi_prevent *cdb;
5270	int retval;
5271	uint32_t initidx;
5272
5273	CTL_DEBUG_PRINT(("ctl_prevent_allow\n"));
5274
5275	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5276	cdb = (struct scsi_prevent *)ctsio->cdb;
5277
5278	if ((lun->flags & CTL_LUN_REMOVABLE) == 0) {
5279		ctl_set_invalid_opcode(ctsio);
5280		ctl_done((union ctl_io *)ctsio);
5281		return (CTL_RETVAL_COMPLETE);
5282	}
5283
5284	initidx = ctl_get_initindex(&ctsio->io_hdr.nexus);
5285	mtx_lock(&lun->lun_lock);
5286	if ((cdb->how & PR_PREVENT) &&
5287	    ctl_is_set(lun->prevent, initidx) == 0) {
5288		ctl_set_mask(lun->prevent, initidx);
5289		lun->prevent_count++;
5290	} else if ((cdb->how & PR_PREVENT) == 0 &&
5291	    ctl_is_set(lun->prevent, initidx)) {
5292		ctl_clear_mask(lun->prevent, initidx);
5293		lun->prevent_count--;
5294	}
5295	mtx_unlock(&lun->lun_lock);
5296	retval = lun->backend->config_write((union ctl_io *)ctsio);
5297	return (retval);
5298}
5299
5300/*
5301 * We support the SYNCHRONIZE CACHE command (10 and 16 byte versions), but
5302 * we don't really do anything with the LBA and length fields if the user
5303 * passes them in.  Instead we'll just flush out the cache for the entire
5304 * LUN.
5305 */
5306int
5307ctl_sync_cache(struct ctl_scsiio *ctsio)
5308{
5309	struct ctl_lun *lun;
5310	struct ctl_softc *softc;
5311	struct ctl_lba_len_flags *lbalen;
5312	uint64_t starting_lba;
5313	uint32_t block_count;
5314	int retval;
5315	uint8_t byte2;
5316
5317	CTL_DEBUG_PRINT(("ctl_sync_cache\n"));
5318
5319	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5320	softc = lun->ctl_softc;
5321	retval = 0;
5322
5323	switch (ctsio->cdb[0]) {
5324	case SYNCHRONIZE_CACHE: {
5325		struct scsi_sync_cache *cdb;
5326		cdb = (struct scsi_sync_cache *)ctsio->cdb;
5327
5328		starting_lba = scsi_4btoul(cdb->begin_lba);
5329		block_count = scsi_2btoul(cdb->lb_count);
5330		byte2 = cdb->byte2;
5331		break;
5332	}
5333	case SYNCHRONIZE_CACHE_16: {
5334		struct scsi_sync_cache_16 *cdb;
5335		cdb = (struct scsi_sync_cache_16 *)ctsio->cdb;
5336
5337		starting_lba = scsi_8btou64(cdb->begin_lba);
5338		block_count = scsi_4btoul(cdb->lb_count);
5339		byte2 = cdb->byte2;
5340		break;
5341	}
5342	default:
5343		ctl_set_invalid_opcode(ctsio);
5344		ctl_done((union ctl_io *)ctsio);
5345		goto bailout;
5346		break; /* NOTREACHED */
5347	}
5348
5349	/*
5350	 * We check the LBA and length, but don't do anything with them.
5351	 * A SYNCHRONIZE CACHE will cause the entire cache for this lun to
5352	 * get flushed.  This check will just help satisfy anyone who wants
5353	 * to see an error for an out of range LBA.
5354	 */
5355	if ((starting_lba + block_count) > (lun->be_lun->maxlba + 1)) {
5356		ctl_set_lba_out_of_range(ctsio);
5357		ctl_done((union ctl_io *)ctsio);
5358		goto bailout;
5359	}
5360
5361	lbalen = (struct ctl_lba_len_flags *)&ctsio->io_hdr.ctl_private[CTL_PRIV_LBA_LEN];
5362	lbalen->lba = starting_lba;
5363	lbalen->len = block_count;
5364	lbalen->flags = byte2;
5365	retval = lun->backend->config_write((union ctl_io *)ctsio);
5366
5367bailout:
5368	return (retval);
5369}
5370
5371int
5372ctl_format(struct ctl_scsiio *ctsio)
5373{
5374	struct scsi_format *cdb;
5375	struct ctl_lun *lun;
5376	int length, defect_list_len;
5377
5378	CTL_DEBUG_PRINT(("ctl_format\n"));
5379
5380	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5381
5382	cdb = (struct scsi_format *)ctsio->cdb;
5383
5384	length = 0;
5385	if (cdb->byte2 & SF_FMTDATA) {
5386		if (cdb->byte2 & SF_LONGLIST)
5387			length = sizeof(struct scsi_format_header_long);
5388		else
5389			length = sizeof(struct scsi_format_header_short);
5390	}
5391
5392	if (((ctsio->io_hdr.flags & CTL_FLAG_ALLOCATED) == 0)
5393	 && (length > 0)) {
5394		ctsio->kern_data_ptr = malloc(length, M_CTL, M_WAITOK);
5395		ctsio->kern_data_len = length;
5396		ctsio->kern_total_len = length;
5397		ctsio->kern_data_resid = 0;
5398		ctsio->kern_rel_offset = 0;
5399		ctsio->kern_sg_entries = 0;
5400		ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
5401		ctsio->be_move_done = ctl_config_move_done;
5402		ctl_datamove((union ctl_io *)ctsio);
5403
5404		return (CTL_RETVAL_COMPLETE);
5405	}
5406
5407	defect_list_len = 0;
5408
5409	if (cdb->byte2 & SF_FMTDATA) {
5410		if (cdb->byte2 & SF_LONGLIST) {
5411			struct scsi_format_header_long *header;
5412
5413			header = (struct scsi_format_header_long *)
5414				ctsio->kern_data_ptr;
5415
5416			defect_list_len = scsi_4btoul(header->defect_list_len);
5417			if (defect_list_len != 0) {
5418				ctl_set_invalid_field(ctsio,
5419						      /*sks_valid*/ 1,
5420						      /*command*/ 0,
5421						      /*field*/ 2,
5422						      /*bit_valid*/ 0,
5423						      /*bit*/ 0);
5424				goto bailout;
5425			}
5426		} else {
5427			struct scsi_format_header_short *header;
5428
5429			header = (struct scsi_format_header_short *)
5430				ctsio->kern_data_ptr;
5431
5432			defect_list_len = scsi_2btoul(header->defect_list_len);
5433			if (defect_list_len != 0) {
5434				ctl_set_invalid_field(ctsio,
5435						      /*sks_valid*/ 1,
5436						      /*command*/ 0,
5437						      /*field*/ 2,
5438						      /*bit_valid*/ 0,
5439						      /*bit*/ 0);
5440				goto bailout;
5441			}
5442		}
5443	}
5444
5445	ctl_set_success(ctsio);
5446bailout:
5447
5448	if (ctsio->io_hdr.flags & CTL_FLAG_ALLOCATED) {
5449		free(ctsio->kern_data_ptr, M_CTL);
5450		ctsio->io_hdr.flags &= ~CTL_FLAG_ALLOCATED;
5451	}
5452
5453	ctl_done((union ctl_io *)ctsio);
5454	return (CTL_RETVAL_COMPLETE);
5455}
5456
5457int
5458ctl_read_buffer(struct ctl_scsiio *ctsio)
5459{
5460	struct ctl_lun *lun;
5461	uint64_t buffer_offset;
5462	uint32_t len;
5463	uint8_t byte2;
5464	static uint8_t descr[4];
5465	static uint8_t echo_descr[4] = { 0 };
5466
5467	CTL_DEBUG_PRINT(("ctl_read_buffer\n"));
5468	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5469	switch (ctsio->cdb[0]) {
5470	case READ_BUFFER: {
5471		struct scsi_read_buffer *cdb;
5472
5473		cdb = (struct scsi_read_buffer *)ctsio->cdb;
5474		buffer_offset = scsi_3btoul(cdb->offset);
5475		len = scsi_3btoul(cdb->length);
5476		byte2 = cdb->byte2;
5477		break;
5478	}
5479	case READ_BUFFER_16: {
5480		struct scsi_read_buffer_16 *cdb;
5481
5482		cdb = (struct scsi_read_buffer_16 *)ctsio->cdb;
5483		buffer_offset = scsi_8btou64(cdb->offset);
5484		len = scsi_4btoul(cdb->length);
5485		byte2 = cdb->byte2;
5486		break;
5487	}
5488	default: /* This shouldn't happen. */
5489		ctl_set_invalid_opcode(ctsio);
5490		ctl_done((union ctl_io *)ctsio);
5491		return (CTL_RETVAL_COMPLETE);
5492	}
5493
5494	if ((byte2 & RWB_MODE) != RWB_MODE_DATA &&
5495	    (byte2 & RWB_MODE) != RWB_MODE_ECHO_DESCR &&
5496	    (byte2 & RWB_MODE) != RWB_MODE_DESCR) {
5497		ctl_set_invalid_field(ctsio,
5498				      /*sks_valid*/ 1,
5499				      /*command*/ 1,
5500				      /*field*/ 1,
5501				      /*bit_valid*/ 1,
5502				      /*bit*/ 4);
5503		ctl_done((union ctl_io *)ctsio);
5504		return (CTL_RETVAL_COMPLETE);
5505	}
5506
5507	if (buffer_offset > CTL_WRITE_BUFFER_SIZE ||
5508	    buffer_offset + len > CTL_WRITE_BUFFER_SIZE) {
5509		ctl_set_invalid_field(ctsio,
5510				      /*sks_valid*/ 1,
5511				      /*command*/ 1,
5512				      /*field*/ 6,
5513				      /*bit_valid*/ 0,
5514				      /*bit*/ 0);
5515		ctl_done((union ctl_io *)ctsio);
5516		return (CTL_RETVAL_COMPLETE);
5517	}
5518
5519	if ((byte2 & RWB_MODE) == RWB_MODE_DESCR) {
5520		descr[0] = 0;
5521		scsi_ulto3b(CTL_WRITE_BUFFER_SIZE, &descr[1]);
5522		ctsio->kern_data_ptr = descr;
5523		len = min(len, sizeof(descr));
5524	} else if ((byte2 & RWB_MODE) == RWB_MODE_ECHO_DESCR) {
5525		ctsio->kern_data_ptr = echo_descr;
5526		len = min(len, sizeof(echo_descr));
5527	} else {
5528		if (lun->write_buffer == NULL) {
5529			lun->write_buffer = malloc(CTL_WRITE_BUFFER_SIZE,
5530			    M_CTL, M_WAITOK);
5531		}
5532		ctsio->kern_data_ptr = lun->write_buffer + buffer_offset;
5533	}
5534	ctsio->kern_data_len = len;
5535	ctsio->kern_total_len = len;
5536	ctsio->kern_data_resid = 0;
5537	ctsio->kern_rel_offset = 0;
5538	ctsio->kern_sg_entries = 0;
5539	ctl_set_success(ctsio);
5540	ctsio->be_move_done = ctl_config_move_done;
5541	ctl_datamove((union ctl_io *)ctsio);
5542	return (CTL_RETVAL_COMPLETE);
5543}
5544
5545int
5546ctl_write_buffer(struct ctl_scsiio *ctsio)
5547{
5548	struct scsi_write_buffer *cdb;
5549	struct ctl_lun *lun;
5550	int buffer_offset, len;
5551
5552	CTL_DEBUG_PRINT(("ctl_write_buffer\n"));
5553
5554	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5555	cdb = (struct scsi_write_buffer *)ctsio->cdb;
5556
5557	if ((cdb->byte2 & RWB_MODE) != RWB_MODE_DATA) {
5558		ctl_set_invalid_field(ctsio,
5559				      /*sks_valid*/ 1,
5560				      /*command*/ 1,
5561				      /*field*/ 1,
5562				      /*bit_valid*/ 1,
5563				      /*bit*/ 4);
5564		ctl_done((union ctl_io *)ctsio);
5565		return (CTL_RETVAL_COMPLETE);
5566	}
5567
5568	len = scsi_3btoul(cdb->length);
5569	buffer_offset = scsi_3btoul(cdb->offset);
5570
5571	if (buffer_offset + len > CTL_WRITE_BUFFER_SIZE) {
5572		ctl_set_invalid_field(ctsio,
5573				      /*sks_valid*/ 1,
5574				      /*command*/ 1,
5575				      /*field*/ 6,
5576				      /*bit_valid*/ 0,
5577				      /*bit*/ 0);
5578		ctl_done((union ctl_io *)ctsio);
5579		return (CTL_RETVAL_COMPLETE);
5580	}
5581
5582	/*
5583	 * If we've got a kernel request that hasn't been malloced yet,
5584	 * malloc it and tell the caller the data buffer is here.
5585	 */
5586	if ((ctsio->io_hdr.flags & CTL_FLAG_ALLOCATED) == 0) {
5587		if (lun->write_buffer == NULL) {
5588			lun->write_buffer = malloc(CTL_WRITE_BUFFER_SIZE,
5589			    M_CTL, M_WAITOK);
5590		}
5591		ctsio->kern_data_ptr = lun->write_buffer + buffer_offset;
5592		ctsio->kern_data_len = len;
5593		ctsio->kern_total_len = len;
5594		ctsio->kern_data_resid = 0;
5595		ctsio->kern_rel_offset = 0;
5596		ctsio->kern_sg_entries = 0;
5597		ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
5598		ctsio->be_move_done = ctl_config_move_done;
5599		ctl_datamove((union ctl_io *)ctsio);
5600
5601		return (CTL_RETVAL_COMPLETE);
5602	}
5603
5604	ctl_set_success(ctsio);
5605	ctl_done((union ctl_io *)ctsio);
5606	return (CTL_RETVAL_COMPLETE);
5607}
5608
5609int
5610ctl_write_same(struct ctl_scsiio *ctsio)
5611{
5612	struct ctl_lun *lun;
5613	struct ctl_lba_len_flags *lbalen;
5614	uint64_t lba;
5615	uint32_t num_blocks;
5616	int len, retval;
5617	uint8_t byte2;
5618
5619	CTL_DEBUG_PRINT(("ctl_write_same\n"));
5620
5621	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5622
5623	switch (ctsio->cdb[0]) {
5624	case WRITE_SAME_10: {
5625		struct scsi_write_same_10 *cdb;
5626
5627		cdb = (struct scsi_write_same_10 *)ctsio->cdb;
5628
5629		lba = scsi_4btoul(cdb->addr);
5630		num_blocks = scsi_2btoul(cdb->length);
5631		byte2 = cdb->byte2;
5632		break;
5633	}
5634	case WRITE_SAME_16: {
5635		struct scsi_write_same_16 *cdb;
5636
5637		cdb = (struct scsi_write_same_16 *)ctsio->cdb;
5638
5639		lba = scsi_8btou64(cdb->addr);
5640		num_blocks = scsi_4btoul(cdb->length);
5641		byte2 = cdb->byte2;
5642		break;
5643	}
5644	default:
5645		/*
5646		 * We got a command we don't support.  This shouldn't
5647		 * happen, commands should be filtered out above us.
5648		 */
5649		ctl_set_invalid_opcode(ctsio);
5650		ctl_done((union ctl_io *)ctsio);
5651
5652		return (CTL_RETVAL_COMPLETE);
5653		break; /* NOTREACHED */
5654	}
5655
5656	/* ANCHOR flag can be used only together with UNMAP */
5657	if ((byte2 & SWS_UNMAP) == 0 && (byte2 & SWS_ANCHOR) != 0) {
5658		ctl_set_invalid_field(ctsio, /*sks_valid*/ 1,
5659		    /*command*/ 1, /*field*/ 1, /*bit_valid*/ 1, /*bit*/ 0);
5660		ctl_done((union ctl_io *)ctsio);
5661		return (CTL_RETVAL_COMPLETE);
5662	}
5663
5664	/*
5665	 * The first check is to make sure we're in bounds, the second
5666	 * check is to catch wrap-around problems.  If the lba + num blocks
5667	 * is less than the lba, then we've wrapped around and the block
5668	 * range is invalid anyway.
5669	 */
5670	if (((lba + num_blocks) > (lun->be_lun->maxlba + 1))
5671	 || ((lba + num_blocks) < lba)) {
5672		ctl_set_lba_out_of_range(ctsio);
5673		ctl_done((union ctl_io *)ctsio);
5674		return (CTL_RETVAL_COMPLETE);
5675	}
5676
5677	/* Zero number of blocks means "to the last logical block" */
5678	if (num_blocks == 0) {
5679		if ((lun->be_lun->maxlba + 1) - lba > UINT32_MAX) {
5680			ctl_set_invalid_field(ctsio,
5681					      /*sks_valid*/ 0,
5682					      /*command*/ 1,
5683					      /*field*/ 0,
5684					      /*bit_valid*/ 0,
5685					      /*bit*/ 0);
5686			ctl_done((union ctl_io *)ctsio);
5687			return (CTL_RETVAL_COMPLETE);
5688		}
5689		num_blocks = (lun->be_lun->maxlba + 1) - lba;
5690	}
5691
5692	len = lun->be_lun->blocksize;
5693
5694	/*
5695	 * If we've got a kernel request that hasn't been malloced yet,
5696	 * malloc it and tell the caller the data buffer is here.
5697	 */
5698	if ((byte2 & SWS_NDOB) == 0 &&
5699	    (ctsio->io_hdr.flags & CTL_FLAG_ALLOCATED) == 0) {
5700		ctsio->kern_data_ptr = malloc(len, M_CTL, M_WAITOK);
5701		ctsio->kern_data_len = len;
5702		ctsio->kern_total_len = len;
5703		ctsio->kern_data_resid = 0;
5704		ctsio->kern_rel_offset = 0;
5705		ctsio->kern_sg_entries = 0;
5706		ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
5707		ctsio->be_move_done = ctl_config_move_done;
5708		ctl_datamove((union ctl_io *)ctsio);
5709
5710		return (CTL_RETVAL_COMPLETE);
5711	}
5712
5713	lbalen = (struct ctl_lba_len_flags *)&ctsio->io_hdr.ctl_private[CTL_PRIV_LBA_LEN];
5714	lbalen->lba = lba;
5715	lbalen->len = num_blocks;
5716	lbalen->flags = byte2;
5717	retval = lun->backend->config_write((union ctl_io *)ctsio);
5718
5719	return (retval);
5720}
5721
5722int
5723ctl_unmap(struct ctl_scsiio *ctsio)
5724{
5725	struct ctl_lun *lun;
5726	struct scsi_unmap *cdb;
5727	struct ctl_ptr_len_flags *ptrlen;
5728	struct scsi_unmap_header *hdr;
5729	struct scsi_unmap_desc *buf, *end, *endnz, *range;
5730	uint64_t lba;
5731	uint32_t num_blocks;
5732	int len, retval;
5733	uint8_t byte2;
5734
5735	CTL_DEBUG_PRINT(("ctl_unmap\n"));
5736
5737	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5738	cdb = (struct scsi_unmap *)ctsio->cdb;
5739
5740	len = scsi_2btoul(cdb->length);
5741	byte2 = cdb->byte2;
5742
5743	/*
5744	 * If we've got a kernel request that hasn't been malloced yet,
5745	 * malloc it and tell the caller the data buffer is here.
5746	 */
5747	if ((ctsio->io_hdr.flags & CTL_FLAG_ALLOCATED) == 0) {
5748		ctsio->kern_data_ptr = malloc(len, M_CTL, M_WAITOK);
5749		ctsio->kern_data_len = len;
5750		ctsio->kern_total_len = len;
5751		ctsio->kern_data_resid = 0;
5752		ctsio->kern_rel_offset = 0;
5753		ctsio->kern_sg_entries = 0;
5754		ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
5755		ctsio->be_move_done = ctl_config_move_done;
5756		ctl_datamove((union ctl_io *)ctsio);
5757
5758		return (CTL_RETVAL_COMPLETE);
5759	}
5760
5761	len = ctsio->kern_total_len - ctsio->kern_data_resid;
5762	hdr = (struct scsi_unmap_header *)ctsio->kern_data_ptr;
5763	if (len < sizeof (*hdr) ||
5764	    len < (scsi_2btoul(hdr->length) + sizeof(hdr->length)) ||
5765	    len < (scsi_2btoul(hdr->desc_length) + sizeof (*hdr)) ||
5766	    scsi_2btoul(hdr->desc_length) % sizeof(*buf) != 0) {
5767		ctl_set_invalid_field(ctsio,
5768				      /*sks_valid*/ 0,
5769				      /*command*/ 0,
5770				      /*field*/ 0,
5771				      /*bit_valid*/ 0,
5772				      /*bit*/ 0);
5773		goto done;
5774	}
5775	len = scsi_2btoul(hdr->desc_length);
5776	buf = (struct scsi_unmap_desc *)(hdr + 1);
5777	end = buf + len / sizeof(*buf);
5778
5779	endnz = buf;
5780	for (range = buf; range < end; range++) {
5781		lba = scsi_8btou64(range->lba);
5782		num_blocks = scsi_4btoul(range->length);
5783		if (((lba + num_blocks) > (lun->be_lun->maxlba + 1))
5784		 || ((lba + num_blocks) < lba)) {
5785			ctl_set_lba_out_of_range(ctsio);
5786			ctl_done((union ctl_io *)ctsio);
5787			return (CTL_RETVAL_COMPLETE);
5788		}
5789		if (num_blocks != 0)
5790			endnz = range + 1;
5791	}
5792
5793	/*
5794	 * Block backend can not handle zero last range.
5795	 * Filter it out and return if there is nothing left.
5796	 */
5797	len = (uint8_t *)endnz - (uint8_t *)buf;
5798	if (len == 0) {
5799		ctl_set_success(ctsio);
5800		goto done;
5801	}
5802
5803	mtx_lock(&lun->lun_lock);
5804	ptrlen = (struct ctl_ptr_len_flags *)
5805	    &ctsio->io_hdr.ctl_private[CTL_PRIV_LBA_LEN];
5806	ptrlen->ptr = (void *)buf;
5807	ptrlen->len = len;
5808	ptrlen->flags = byte2;
5809	ctl_check_blocked(lun);
5810	mtx_unlock(&lun->lun_lock);
5811
5812	retval = lun->backend->config_write((union ctl_io *)ctsio);
5813	return (retval);
5814
5815done:
5816	if (ctsio->io_hdr.flags & CTL_FLAG_ALLOCATED) {
5817		free(ctsio->kern_data_ptr, M_CTL);
5818		ctsio->io_hdr.flags &= ~CTL_FLAG_ALLOCATED;
5819	}
5820	ctl_done((union ctl_io *)ctsio);
5821	return (CTL_RETVAL_COMPLETE);
5822}
5823
5824int
5825ctl_default_page_handler(struct ctl_scsiio *ctsio,
5826			 struct ctl_page_index *page_index, uint8_t *page_ptr)
5827{
5828	struct ctl_lun *lun;
5829	uint8_t *current_cp, *saved_cp;
5830	int set_ua;
5831	uint32_t initidx;
5832
5833	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5834	initidx = ctl_get_initindex(&ctsio->io_hdr.nexus);
5835	set_ua = 0;
5836
5837	current_cp = (page_index->page_data + (page_index->page_len *
5838	    CTL_PAGE_CURRENT));
5839	saved_cp = (page_index->page_data + (page_index->page_len *
5840	    CTL_PAGE_SAVED));
5841
5842	mtx_lock(&lun->lun_lock);
5843	if (memcmp(current_cp, page_ptr, page_index->page_len)) {
5844		memcpy(current_cp, page_ptr, page_index->page_len);
5845		memcpy(saved_cp, page_ptr, page_index->page_len);
5846		set_ua = 1;
5847	}
5848	if (set_ua != 0)
5849		ctl_est_ua_all(lun, initidx, CTL_UA_MODE_CHANGE);
5850	mtx_unlock(&lun->lun_lock);
5851	if (set_ua) {
5852		ctl_isc_announce_mode(lun,
5853		    ctl_get_initindex(&ctsio->io_hdr.nexus),
5854		    page_index->page_code, page_index->subpage);
5855	}
5856	return (CTL_RETVAL_COMPLETE);
5857}
5858
5859static void
5860ctl_ie_timer(void *arg)
5861{
5862	struct ctl_lun *lun = arg;
5863	uint64_t t;
5864
5865	if (lun->ie_asc == 0)
5866		return;
5867
5868	if (lun->MODE_IE.mrie == SIEP_MRIE_UA)
5869		ctl_est_ua_all(lun, -1, CTL_UA_IE);
5870	else
5871		lun->ie_reported = 0;
5872
5873	if (lun->ie_reportcnt < scsi_4btoul(lun->MODE_IE.report_count)) {
5874		lun->ie_reportcnt++;
5875		t = scsi_4btoul(lun->MODE_IE.interval_timer);
5876		if (t == 0 || t == UINT32_MAX)
5877			t = 3000;  /* 5 min */
5878		callout_schedule(&lun->ie_callout, t * hz / 10);
5879	}
5880}
5881
5882int
5883ctl_ie_page_handler(struct ctl_scsiio *ctsio,
5884			 struct ctl_page_index *page_index, uint8_t *page_ptr)
5885{
5886	struct scsi_info_exceptions_page *pg;
5887	struct ctl_lun *lun;
5888	uint64_t t;
5889
5890	(void)ctl_default_page_handler(ctsio, page_index, page_ptr);
5891
5892	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5893	pg = (struct scsi_info_exceptions_page *)page_ptr;
5894	mtx_lock(&lun->lun_lock);
5895	if (pg->info_flags & SIEP_FLAGS_TEST) {
5896		lun->ie_asc = 0x5d;
5897		lun->ie_ascq = 0xff;
5898		if (pg->mrie == SIEP_MRIE_UA) {
5899			ctl_est_ua_all(lun, -1, CTL_UA_IE);
5900			lun->ie_reported = 1;
5901		} else {
5902			ctl_clr_ua_all(lun, -1, CTL_UA_IE);
5903			lun->ie_reported = -1;
5904		}
5905		lun->ie_reportcnt = 1;
5906		if (lun->ie_reportcnt < scsi_4btoul(pg->report_count)) {
5907			lun->ie_reportcnt++;
5908			t = scsi_4btoul(pg->interval_timer);
5909			if (t == 0 || t == UINT32_MAX)
5910				t = 3000;  /* 5 min */
5911			callout_reset(&lun->ie_callout, t * hz / 10,
5912			    ctl_ie_timer, lun);
5913		}
5914	} else {
5915		lun->ie_asc = 0;
5916		lun->ie_ascq = 0;
5917		lun->ie_reported = 1;
5918		ctl_clr_ua_all(lun, -1, CTL_UA_IE);
5919		lun->ie_reportcnt = UINT32_MAX;
5920		callout_stop(&lun->ie_callout);
5921	}
5922	mtx_unlock(&lun->lun_lock);
5923	return (CTL_RETVAL_COMPLETE);
5924}
5925
5926static int
5927ctl_do_mode_select(union ctl_io *io)
5928{
5929	struct scsi_mode_page_header *page_header;
5930	struct ctl_page_index *page_index;
5931	struct ctl_scsiio *ctsio;
5932	int page_len, page_len_offset, page_len_size;
5933	union ctl_modepage_info *modepage_info;
5934	struct ctl_lun *lun;
5935	int *len_left, *len_used;
5936	int retval, i;
5937
5938	ctsio = &io->scsiio;
5939	page_index = NULL;
5940	page_len = 0;
5941	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5942
5943	modepage_info = (union ctl_modepage_info *)
5944		ctsio->io_hdr.ctl_private[CTL_PRIV_MODEPAGE].bytes;
5945	len_left = &modepage_info->header.len_left;
5946	len_used = &modepage_info->header.len_used;
5947
5948do_next_page:
5949
5950	page_header = (struct scsi_mode_page_header *)
5951		(ctsio->kern_data_ptr + *len_used);
5952
5953	if (*len_left == 0) {
5954		free(ctsio->kern_data_ptr, M_CTL);
5955		ctl_set_success(ctsio);
5956		ctl_done((union ctl_io *)ctsio);
5957		return (CTL_RETVAL_COMPLETE);
5958	} else if (*len_left < sizeof(struct scsi_mode_page_header)) {
5959
5960		free(ctsio->kern_data_ptr, M_CTL);
5961		ctl_set_param_len_error(ctsio);
5962		ctl_done((union ctl_io *)ctsio);
5963		return (CTL_RETVAL_COMPLETE);
5964
5965	} else if ((page_header->page_code & SMPH_SPF)
5966		&& (*len_left < sizeof(struct scsi_mode_page_header_sp))) {
5967
5968		free(ctsio->kern_data_ptr, M_CTL);
5969		ctl_set_param_len_error(ctsio);
5970		ctl_done((union ctl_io *)ctsio);
5971		return (CTL_RETVAL_COMPLETE);
5972	}
5973
5974
5975	/*
5976	 * XXX KDM should we do something with the block descriptor?
5977	 */
5978	for (i = 0; i < CTL_NUM_MODE_PAGES; i++) {
5979		page_index = &lun->mode_pages.index[i];
5980		if (lun->be_lun->lun_type == T_DIRECT &&
5981		    (page_index->page_flags & CTL_PAGE_FLAG_DIRECT) == 0)
5982			continue;
5983		if (lun->be_lun->lun_type == T_PROCESSOR &&
5984		    (page_index->page_flags & CTL_PAGE_FLAG_PROC) == 0)
5985			continue;
5986		if (lun->be_lun->lun_type == T_CDROM &&
5987		    (page_index->page_flags & CTL_PAGE_FLAG_CDROM) == 0)
5988			continue;
5989
5990		if ((page_index->page_code & SMPH_PC_MASK) !=
5991		    (page_header->page_code & SMPH_PC_MASK))
5992			continue;
5993
5994		/*
5995		 * If neither page has a subpage code, then we've got a
5996		 * match.
5997		 */
5998		if (((page_index->page_code & SMPH_SPF) == 0)
5999		 && ((page_header->page_code & SMPH_SPF) == 0)) {
6000			page_len = page_header->page_length;
6001			break;
6002		}
6003
6004		/*
6005		 * If both pages have subpages, then the subpage numbers
6006		 * have to match.
6007		 */
6008		if ((page_index->page_code & SMPH_SPF)
6009		  && (page_header->page_code & SMPH_SPF)) {
6010			struct scsi_mode_page_header_sp *sph;
6011
6012			sph = (struct scsi_mode_page_header_sp *)page_header;
6013			if (page_index->subpage == sph->subpage) {
6014				page_len = scsi_2btoul(sph->page_length);
6015				break;
6016			}
6017		}
6018	}
6019
6020	/*
6021	 * If we couldn't find the page, or if we don't have a mode select
6022	 * handler for it, send back an error to the user.
6023	 */
6024	if ((i >= CTL_NUM_MODE_PAGES)
6025	 || (page_index->select_handler == NULL)) {
6026		ctl_set_invalid_field(ctsio,
6027				      /*sks_valid*/ 1,
6028				      /*command*/ 0,
6029				      /*field*/ *len_used,
6030				      /*bit_valid*/ 0,
6031				      /*bit*/ 0);
6032		free(ctsio->kern_data_ptr, M_CTL);
6033		ctl_done((union ctl_io *)ctsio);
6034		return (CTL_RETVAL_COMPLETE);
6035	}
6036
6037	if (page_index->page_code & SMPH_SPF) {
6038		page_len_offset = 2;
6039		page_len_size = 2;
6040	} else {
6041		page_len_size = 1;
6042		page_len_offset = 1;
6043	}
6044
6045	/*
6046	 * If the length the initiator gives us isn't the one we specify in
6047	 * the mode page header, or if they didn't specify enough data in
6048	 * the CDB to avoid truncating this page, kick out the request.
6049	 */
6050	if ((page_len != (page_index->page_len - page_len_offset -
6051			  page_len_size))
6052	 || (*len_left < page_index->page_len)) {
6053
6054
6055		ctl_set_invalid_field(ctsio,
6056				      /*sks_valid*/ 1,
6057				      /*command*/ 0,
6058				      /*field*/ *len_used + page_len_offset,
6059				      /*bit_valid*/ 0,
6060				      /*bit*/ 0);
6061		free(ctsio->kern_data_ptr, M_CTL);
6062		ctl_done((union ctl_io *)ctsio);
6063		return (CTL_RETVAL_COMPLETE);
6064	}
6065
6066	/*
6067	 * Run through the mode page, checking to make sure that the bits
6068	 * the user changed are actually legal for him to change.
6069	 */
6070	for (i = 0; i < page_index->page_len; i++) {
6071		uint8_t *user_byte, *change_mask, *current_byte;
6072		int bad_bit;
6073		int j;
6074
6075		user_byte = (uint8_t *)page_header + i;
6076		change_mask = page_index->page_data +
6077			      (page_index->page_len * CTL_PAGE_CHANGEABLE) + i;
6078		current_byte = page_index->page_data +
6079			       (page_index->page_len * CTL_PAGE_CURRENT) + i;
6080
6081		/*
6082		 * Check to see whether the user set any bits in this byte
6083		 * that he is not allowed to set.
6084		 */
6085		if ((*user_byte & ~(*change_mask)) ==
6086		    (*current_byte & ~(*change_mask)))
6087			continue;
6088
6089		/*
6090		 * Go through bit by bit to determine which one is illegal.
6091		 */
6092		bad_bit = 0;
6093		for (j = 7; j >= 0; j--) {
6094			if ((((1 << i) & ~(*change_mask)) & *user_byte) !=
6095			    (((1 << i) & ~(*change_mask)) & *current_byte)) {
6096				bad_bit = i;
6097				break;
6098			}
6099		}
6100		ctl_set_invalid_field(ctsio,
6101				      /*sks_valid*/ 1,
6102				      /*command*/ 0,
6103				      /*field*/ *len_used + i,
6104				      /*bit_valid*/ 1,
6105				      /*bit*/ bad_bit);
6106		free(ctsio->kern_data_ptr, M_CTL);
6107		ctl_done((union ctl_io *)ctsio);
6108		return (CTL_RETVAL_COMPLETE);
6109	}
6110
6111	/*
6112	 * Decrement these before we call the page handler, since we may
6113	 * end up getting called back one way or another before the handler
6114	 * returns to this context.
6115	 */
6116	*len_left -= page_index->page_len;
6117	*len_used += page_index->page_len;
6118
6119	retval = page_index->select_handler(ctsio, page_index,
6120					    (uint8_t *)page_header);
6121
6122	/*
6123	 * If the page handler returns CTL_RETVAL_QUEUED, then we need to
6124	 * wait until this queued command completes to finish processing
6125	 * the mode page.  If it returns anything other than
6126	 * CTL_RETVAL_COMPLETE (e.g. CTL_RETVAL_ERROR), then it should have
6127	 * already set the sense information, freed the data pointer, and
6128	 * completed the io for us.
6129	 */
6130	if (retval != CTL_RETVAL_COMPLETE)
6131		goto bailout_no_done;
6132
6133	/*
6134	 * If the initiator sent us more than one page, parse the next one.
6135	 */
6136	if (*len_left > 0)
6137		goto do_next_page;
6138
6139	ctl_set_success(ctsio);
6140	free(ctsio->kern_data_ptr, M_CTL);
6141	ctl_done((union ctl_io *)ctsio);
6142
6143bailout_no_done:
6144
6145	return (CTL_RETVAL_COMPLETE);
6146
6147}
6148
6149int
6150ctl_mode_select(struct ctl_scsiio *ctsio)
6151{
6152	int param_len, pf, sp;
6153	int header_size, bd_len;
6154	union ctl_modepage_info *modepage_info;
6155
6156	switch (ctsio->cdb[0]) {
6157	case MODE_SELECT_6: {
6158		struct scsi_mode_select_6 *cdb;
6159
6160		cdb = (struct scsi_mode_select_6 *)ctsio->cdb;
6161
6162		pf = (cdb->byte2 & SMS_PF) ? 1 : 0;
6163		sp = (cdb->byte2 & SMS_SP) ? 1 : 0;
6164		param_len = cdb->length;
6165		header_size = sizeof(struct scsi_mode_header_6);
6166		break;
6167	}
6168	case MODE_SELECT_10: {
6169		struct scsi_mode_select_10 *cdb;
6170
6171		cdb = (struct scsi_mode_select_10 *)ctsio->cdb;
6172
6173		pf = (cdb->byte2 & SMS_PF) ? 1 : 0;
6174		sp = (cdb->byte2 & SMS_SP) ? 1 : 0;
6175		param_len = scsi_2btoul(cdb->length);
6176		header_size = sizeof(struct scsi_mode_header_10);
6177		break;
6178	}
6179	default:
6180		ctl_set_invalid_opcode(ctsio);
6181		ctl_done((union ctl_io *)ctsio);
6182		return (CTL_RETVAL_COMPLETE);
6183	}
6184
6185	/*
6186	 * From SPC-3:
6187	 * "A parameter list length of zero indicates that the Data-Out Buffer
6188	 * shall be empty. This condition shall not be considered as an error."
6189	 */
6190	if (param_len == 0) {
6191		ctl_set_success(ctsio);
6192		ctl_done((union ctl_io *)ctsio);
6193		return (CTL_RETVAL_COMPLETE);
6194	}
6195
6196	/*
6197	 * Since we'll hit this the first time through, prior to
6198	 * allocation, we don't need to free a data buffer here.
6199	 */
6200	if (param_len < header_size) {
6201		ctl_set_param_len_error(ctsio);
6202		ctl_done((union ctl_io *)ctsio);
6203		return (CTL_RETVAL_COMPLETE);
6204	}
6205
6206	/*
6207	 * Allocate the data buffer and grab the user's data.  In theory,
6208	 * we shouldn't have to sanity check the parameter list length here
6209	 * because the maximum size is 64K.  We should be able to malloc
6210	 * that much without too many problems.
6211	 */
6212	if ((ctsio->io_hdr.flags & CTL_FLAG_ALLOCATED) == 0) {
6213		ctsio->kern_data_ptr = malloc(param_len, M_CTL, M_WAITOK);
6214		ctsio->kern_data_len = param_len;
6215		ctsio->kern_total_len = param_len;
6216		ctsio->kern_data_resid = 0;
6217		ctsio->kern_rel_offset = 0;
6218		ctsio->kern_sg_entries = 0;
6219		ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
6220		ctsio->be_move_done = ctl_config_move_done;
6221		ctl_datamove((union ctl_io *)ctsio);
6222
6223		return (CTL_RETVAL_COMPLETE);
6224	}
6225
6226	switch (ctsio->cdb[0]) {
6227	case MODE_SELECT_6: {
6228		struct scsi_mode_header_6 *mh6;
6229
6230		mh6 = (struct scsi_mode_header_6 *)ctsio->kern_data_ptr;
6231		bd_len = mh6->blk_desc_len;
6232		break;
6233	}
6234	case MODE_SELECT_10: {
6235		struct scsi_mode_header_10 *mh10;
6236
6237		mh10 = (struct scsi_mode_header_10 *)ctsio->kern_data_ptr;
6238		bd_len = scsi_2btoul(mh10->blk_desc_len);
6239		break;
6240	}
6241	default:
6242		panic("%s: Invalid CDB type %#x", __func__, ctsio->cdb[0]);
6243	}
6244
6245	if (param_len < (header_size + bd_len)) {
6246		free(ctsio->kern_data_ptr, M_CTL);
6247		ctl_set_param_len_error(ctsio);
6248		ctl_done((union ctl_io *)ctsio);
6249		return (CTL_RETVAL_COMPLETE);
6250	}
6251
6252	/*
6253	 * Set the IO_CONT flag, so that if this I/O gets passed to
6254	 * ctl_config_write_done(), it'll get passed back to
6255	 * ctl_do_mode_select() for further processing, or completion if
6256	 * we're all done.
6257	 */
6258	ctsio->io_hdr.flags |= CTL_FLAG_IO_CONT;
6259	ctsio->io_cont = ctl_do_mode_select;
6260
6261	modepage_info = (union ctl_modepage_info *)
6262		ctsio->io_hdr.ctl_private[CTL_PRIV_MODEPAGE].bytes;
6263	memset(modepage_info, 0, sizeof(*modepage_info));
6264	modepage_info->header.len_left = param_len - header_size - bd_len;
6265	modepage_info->header.len_used = header_size + bd_len;
6266
6267	return (ctl_do_mode_select((union ctl_io *)ctsio));
6268}
6269
6270int
6271ctl_mode_sense(struct ctl_scsiio *ctsio)
6272{
6273	struct ctl_lun *lun;
6274	int pc, page_code, dbd, llba, subpage;
6275	int alloc_len, page_len, header_len, total_len;
6276	struct scsi_mode_block_descr *block_desc;
6277	struct ctl_page_index *page_index;
6278
6279	dbd = 0;
6280	llba = 0;
6281	block_desc = NULL;
6282
6283	CTL_DEBUG_PRINT(("ctl_mode_sense\n"));
6284
6285	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
6286	switch (ctsio->cdb[0]) {
6287	case MODE_SENSE_6: {
6288		struct scsi_mode_sense_6 *cdb;
6289
6290		cdb = (struct scsi_mode_sense_6 *)ctsio->cdb;
6291
6292		header_len = sizeof(struct scsi_mode_hdr_6);
6293		if (cdb->byte2 & SMS_DBD)
6294			dbd = 1;
6295		else
6296			header_len += sizeof(struct scsi_mode_block_descr);
6297
6298		pc = (cdb->page & SMS_PAGE_CTRL_MASK) >> 6;
6299		page_code = cdb->page & SMS_PAGE_CODE;
6300		subpage = cdb->subpage;
6301		alloc_len = cdb->length;
6302		break;
6303	}
6304	case MODE_SENSE_10: {
6305		struct scsi_mode_sense_10 *cdb;
6306
6307		cdb = (struct scsi_mode_sense_10 *)ctsio->cdb;
6308
6309		header_len = sizeof(struct scsi_mode_hdr_10);
6310
6311		if (cdb->byte2 & SMS_DBD)
6312			dbd = 1;
6313		else
6314			header_len += sizeof(struct scsi_mode_block_descr);
6315		if (cdb->byte2 & SMS10_LLBAA)
6316			llba = 1;
6317		pc = (cdb->page & SMS_PAGE_CTRL_MASK) >> 6;
6318		page_code = cdb->page & SMS_PAGE_CODE;
6319		subpage = cdb->subpage;
6320		alloc_len = scsi_2btoul(cdb->length);
6321		break;
6322	}
6323	default:
6324		ctl_set_invalid_opcode(ctsio);
6325		ctl_done((union ctl_io *)ctsio);
6326		return (CTL_RETVAL_COMPLETE);
6327		break; /* NOTREACHED */
6328	}
6329
6330	/*
6331	 * We have to make a first pass through to calculate the size of
6332	 * the pages that match the user's query.  Then we allocate enough
6333	 * memory to hold it, and actually copy the data into the buffer.
6334	 */
6335	switch (page_code) {
6336	case SMS_ALL_PAGES_PAGE: {
6337		u_int i;
6338
6339		page_len = 0;
6340
6341		/*
6342		 * At the moment, values other than 0 and 0xff here are
6343		 * reserved according to SPC-3.
6344		 */
6345		if ((subpage != SMS_SUBPAGE_PAGE_0)
6346		 && (subpage != SMS_SUBPAGE_ALL)) {
6347			ctl_set_invalid_field(ctsio,
6348					      /*sks_valid*/ 1,
6349					      /*command*/ 1,
6350					      /*field*/ 3,
6351					      /*bit_valid*/ 0,
6352					      /*bit*/ 0);
6353			ctl_done((union ctl_io *)ctsio);
6354			return (CTL_RETVAL_COMPLETE);
6355		}
6356
6357		for (i = 0; i < CTL_NUM_MODE_PAGES; i++) {
6358			page_index = &lun->mode_pages.index[i];
6359
6360			/* Make sure the page is supported for this dev type */
6361			if (lun->be_lun->lun_type == T_DIRECT &&
6362			    (page_index->page_flags & CTL_PAGE_FLAG_DIRECT) == 0)
6363				continue;
6364			if (lun->be_lun->lun_type == T_PROCESSOR &&
6365			    (page_index->page_flags & CTL_PAGE_FLAG_PROC) == 0)
6366				continue;
6367			if (lun->be_lun->lun_type == T_CDROM &&
6368			    (page_index->page_flags & CTL_PAGE_FLAG_CDROM) == 0)
6369				continue;
6370
6371			/*
6372			 * We don't use this subpage if the user didn't
6373			 * request all subpages.
6374			 */
6375			if ((page_index->subpage != 0)
6376			 && (subpage == SMS_SUBPAGE_PAGE_0))
6377				continue;
6378
6379#if 0
6380			printf("found page %#x len %d\n",
6381			       page_index->page_code & SMPH_PC_MASK,
6382			       page_index->page_len);
6383#endif
6384			page_len += page_index->page_len;
6385		}
6386		break;
6387	}
6388	default: {
6389		u_int i;
6390
6391		page_len = 0;
6392
6393		for (i = 0; i < CTL_NUM_MODE_PAGES; i++) {
6394			page_index = &lun->mode_pages.index[i];
6395
6396			/* Make sure the page is supported for this dev type */
6397			if (lun->be_lun->lun_type == T_DIRECT &&
6398			    (page_index->page_flags & CTL_PAGE_FLAG_DIRECT) == 0)
6399				continue;
6400			if (lun->be_lun->lun_type == T_PROCESSOR &&
6401			    (page_index->page_flags & CTL_PAGE_FLAG_PROC) == 0)
6402				continue;
6403			if (lun->be_lun->lun_type == T_CDROM &&
6404			    (page_index->page_flags & CTL_PAGE_FLAG_CDROM) == 0)
6405				continue;
6406
6407			/* Look for the right page code */
6408			if ((page_index->page_code & SMPH_PC_MASK) != page_code)
6409				continue;
6410
6411			/* Look for the right subpage or the subpage wildcard*/
6412			if ((page_index->subpage != subpage)
6413			 && (subpage != SMS_SUBPAGE_ALL))
6414				continue;
6415
6416#if 0
6417			printf("found page %#x len %d\n",
6418			       page_index->page_code & SMPH_PC_MASK,
6419			       page_index->page_len);
6420#endif
6421
6422			page_len += page_index->page_len;
6423		}
6424
6425		if (page_len == 0) {
6426			ctl_set_invalid_field(ctsio,
6427					      /*sks_valid*/ 1,
6428					      /*command*/ 1,
6429					      /*field*/ 2,
6430					      /*bit_valid*/ 1,
6431					      /*bit*/ 5);
6432			ctl_done((union ctl_io *)ctsio);
6433			return (CTL_RETVAL_COMPLETE);
6434		}
6435		break;
6436	}
6437	}
6438
6439	total_len = header_len + page_len;
6440#if 0
6441	printf("header_len = %d, page_len = %d, total_len = %d\n",
6442	       header_len, page_len, total_len);
6443#endif
6444
6445	ctsio->kern_data_ptr = malloc(total_len, M_CTL, M_WAITOK | M_ZERO);
6446	ctsio->kern_sg_entries = 0;
6447	ctsio->kern_data_resid = 0;
6448	ctsio->kern_rel_offset = 0;
6449	if (total_len < alloc_len) {
6450		ctsio->residual = alloc_len - total_len;
6451		ctsio->kern_data_len = total_len;
6452		ctsio->kern_total_len = total_len;
6453	} else {
6454		ctsio->residual = 0;
6455		ctsio->kern_data_len = alloc_len;
6456		ctsio->kern_total_len = alloc_len;
6457	}
6458
6459	switch (ctsio->cdb[0]) {
6460	case MODE_SENSE_6: {
6461		struct scsi_mode_hdr_6 *header;
6462
6463		header = (struct scsi_mode_hdr_6 *)ctsio->kern_data_ptr;
6464
6465		header->datalen = MIN(total_len - 1, 254);
6466		if (lun->be_lun->lun_type == T_DIRECT) {
6467			header->dev_specific = 0x10; /* DPOFUA */
6468			if ((lun->be_lun->flags & CTL_LUN_FLAG_READONLY) ||
6469			    (lun->MODE_CTRL.eca_and_aen & SCP_SWP) != 0)
6470				header->dev_specific |= 0x80; /* WP */
6471		}
6472		if (dbd)
6473			header->block_descr_len = 0;
6474		else
6475			header->block_descr_len =
6476				sizeof(struct scsi_mode_block_descr);
6477		block_desc = (struct scsi_mode_block_descr *)&header[1];
6478		break;
6479	}
6480	case MODE_SENSE_10: {
6481		struct scsi_mode_hdr_10 *header;
6482		int datalen;
6483
6484		header = (struct scsi_mode_hdr_10 *)ctsio->kern_data_ptr;
6485
6486		datalen = MIN(total_len - 2, 65533);
6487		scsi_ulto2b(datalen, header->datalen);
6488		if (lun->be_lun->lun_type == T_DIRECT) {
6489			header->dev_specific = 0x10; /* DPOFUA */
6490			if ((lun->be_lun->flags & CTL_LUN_FLAG_READONLY) ||
6491			    (lun->MODE_CTRL.eca_and_aen & SCP_SWP) != 0)
6492				header->dev_specific |= 0x80; /* WP */
6493		}
6494		if (dbd)
6495			scsi_ulto2b(0, header->block_descr_len);
6496		else
6497			scsi_ulto2b(sizeof(struct scsi_mode_block_descr),
6498				    header->block_descr_len);
6499		block_desc = (struct scsi_mode_block_descr *)&header[1];
6500		break;
6501	}
6502	default:
6503		panic("%s: Invalid CDB type %#x", __func__, ctsio->cdb[0]);
6504	}
6505
6506	/*
6507	 * If we've got a disk, use its blocksize in the block
6508	 * descriptor.  Otherwise, just set it to 0.
6509	 */
6510	if (dbd == 0) {
6511		if (lun->be_lun->lun_type == T_DIRECT)
6512			scsi_ulto3b(lun->be_lun->blocksize,
6513				    block_desc->block_len);
6514		else
6515			scsi_ulto3b(0, block_desc->block_len);
6516	}
6517
6518	switch (page_code) {
6519	case SMS_ALL_PAGES_PAGE: {
6520		int i, data_used;
6521
6522		data_used = header_len;
6523		for (i = 0; i < CTL_NUM_MODE_PAGES; i++) {
6524			struct ctl_page_index *page_index;
6525
6526			page_index = &lun->mode_pages.index[i];
6527			if (lun->be_lun->lun_type == T_DIRECT &&
6528			    (page_index->page_flags & CTL_PAGE_FLAG_DIRECT) == 0)
6529				continue;
6530			if (lun->be_lun->lun_type == T_PROCESSOR &&
6531			    (page_index->page_flags & CTL_PAGE_FLAG_PROC) == 0)
6532				continue;
6533			if (lun->be_lun->lun_type == T_CDROM &&
6534			    (page_index->page_flags & CTL_PAGE_FLAG_CDROM) == 0)
6535				continue;
6536
6537			/*
6538			 * We don't use this subpage if the user didn't
6539			 * request all subpages.  We already checked (above)
6540			 * to make sure the user only specified a subpage
6541			 * of 0 or 0xff in the SMS_ALL_PAGES_PAGE case.
6542			 */
6543			if ((page_index->subpage != 0)
6544			 && (subpage == SMS_SUBPAGE_PAGE_0))
6545				continue;
6546
6547			/*
6548			 * Call the handler, if it exists, to update the
6549			 * page to the latest values.
6550			 */
6551			if (page_index->sense_handler != NULL)
6552				page_index->sense_handler(ctsio, page_index,pc);
6553
6554			memcpy(ctsio->kern_data_ptr + data_used,
6555			       page_index->page_data +
6556			       (page_index->page_len * pc),
6557			       page_index->page_len);
6558			data_used += page_index->page_len;
6559		}
6560		break;
6561	}
6562	default: {
6563		int i, data_used;
6564
6565		data_used = header_len;
6566
6567		for (i = 0; i < CTL_NUM_MODE_PAGES; i++) {
6568			struct ctl_page_index *page_index;
6569
6570			page_index = &lun->mode_pages.index[i];
6571
6572			/* Look for the right page code */
6573			if ((page_index->page_code & SMPH_PC_MASK) != page_code)
6574				continue;
6575
6576			/* Look for the right subpage or the subpage wildcard*/
6577			if ((page_index->subpage != subpage)
6578			 && (subpage != SMS_SUBPAGE_ALL))
6579				continue;
6580
6581			/* Make sure the page is supported for this dev type */
6582			if (lun->be_lun->lun_type == T_DIRECT &&
6583			    (page_index->page_flags & CTL_PAGE_FLAG_DIRECT) == 0)
6584				continue;
6585			if (lun->be_lun->lun_type == T_PROCESSOR &&
6586			    (page_index->page_flags & CTL_PAGE_FLAG_PROC) == 0)
6587				continue;
6588			if (lun->be_lun->lun_type == T_CDROM &&
6589			    (page_index->page_flags & CTL_PAGE_FLAG_CDROM) == 0)
6590				continue;
6591
6592			/*
6593			 * Call the handler, if it exists, to update the
6594			 * page to the latest values.
6595			 */
6596			if (page_index->sense_handler != NULL)
6597				page_index->sense_handler(ctsio, page_index,pc);
6598
6599			memcpy(ctsio->kern_data_ptr + data_used,
6600			       page_index->page_data +
6601			       (page_index->page_len * pc),
6602			       page_index->page_len);
6603			data_used += page_index->page_len;
6604		}
6605		break;
6606	}
6607	}
6608
6609	ctl_set_success(ctsio);
6610	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
6611	ctsio->be_move_done = ctl_config_move_done;
6612	ctl_datamove((union ctl_io *)ctsio);
6613	return (CTL_RETVAL_COMPLETE);
6614}
6615
6616int
6617ctl_lbp_log_sense_handler(struct ctl_scsiio *ctsio,
6618			       struct ctl_page_index *page_index,
6619			       int pc)
6620{
6621	struct ctl_lun *lun;
6622	struct scsi_log_param_header *phdr;
6623	uint8_t *data;
6624	uint64_t val;
6625
6626	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
6627	data = page_index->page_data;
6628
6629	if (lun->backend->lun_attr != NULL &&
6630	    (val = lun->backend->lun_attr(lun->be_lun->be_lun, "blocksavail"))
6631	     != UINT64_MAX) {
6632		phdr = (struct scsi_log_param_header *)data;
6633		scsi_ulto2b(0x0001, phdr->param_code);
6634		phdr->param_control = SLP_LBIN | SLP_LP;
6635		phdr->param_len = 8;
6636		data = (uint8_t *)(phdr + 1);
6637		scsi_ulto4b(val >> CTL_LBP_EXPONENT, data);
6638		data[4] = 0x02; /* per-pool */
6639		data += phdr->param_len;
6640	}
6641
6642	if (lun->backend->lun_attr != NULL &&
6643	    (val = lun->backend->lun_attr(lun->be_lun->be_lun, "blocksused"))
6644	     != UINT64_MAX) {
6645		phdr = (struct scsi_log_param_header *)data;
6646		scsi_ulto2b(0x0002, phdr->param_code);
6647		phdr->param_control = SLP_LBIN | SLP_LP;
6648		phdr->param_len = 8;
6649		data = (uint8_t *)(phdr + 1);
6650		scsi_ulto4b(val >> CTL_LBP_EXPONENT, data);
6651		data[4] = 0x01; /* per-LUN */
6652		data += phdr->param_len;
6653	}
6654
6655	if (lun->backend->lun_attr != NULL &&
6656	    (val = lun->backend->lun_attr(lun->be_lun->be_lun, "poolblocksavail"))
6657	     != UINT64_MAX) {
6658		phdr = (struct scsi_log_param_header *)data;
6659		scsi_ulto2b(0x00f1, phdr->param_code);
6660		phdr->param_control = SLP_LBIN | SLP_LP;
6661		phdr->param_len = 8;
6662		data = (uint8_t *)(phdr + 1);
6663		scsi_ulto4b(val >> CTL_LBP_EXPONENT, data);
6664		data[4] = 0x02; /* per-pool */
6665		data += phdr->param_len;
6666	}
6667
6668	if (lun->backend->lun_attr != NULL &&
6669	    (val = lun->backend->lun_attr(lun->be_lun->be_lun, "poolblocksused"))
6670	     != UINT64_MAX) {
6671		phdr = (struct scsi_log_param_header *)data;
6672		scsi_ulto2b(0x00f2, phdr->param_code);
6673		phdr->param_control = SLP_LBIN | SLP_LP;
6674		phdr->param_len = 8;
6675		data = (uint8_t *)(phdr + 1);
6676		scsi_ulto4b(val >> CTL_LBP_EXPONENT, data);
6677		data[4] = 0x02; /* per-pool */
6678		data += phdr->param_len;
6679	}
6680
6681	page_index->page_len = data - page_index->page_data;
6682	return (0);
6683}
6684
6685int
6686ctl_sap_log_sense_handler(struct ctl_scsiio *ctsio,
6687			       struct ctl_page_index *page_index,
6688			       int pc)
6689{
6690	struct ctl_lun *lun;
6691	struct stat_page *data;
6692	uint64_t rn, wn, rb, wb;
6693	struct bintime rt, wt;
6694	int i;
6695
6696	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
6697	data = (struct stat_page *)page_index->page_data;
6698
6699	scsi_ulto2b(SLP_SAP, data->sap.hdr.param_code);
6700	data->sap.hdr.param_control = SLP_LBIN;
6701	data->sap.hdr.param_len = sizeof(struct scsi_log_stat_and_perf) -
6702	    sizeof(struct scsi_log_param_header);
6703	rn = wn = rb = wb = 0;
6704	bintime_clear(&rt);
6705	bintime_clear(&wt);
6706	for (i = 0; i < CTL_MAX_PORTS; i++) {
6707		rn += lun->stats.ports[i].operations[CTL_STATS_READ];
6708		wn += lun->stats.ports[i].operations[CTL_STATS_WRITE];
6709		rb += lun->stats.ports[i].bytes[CTL_STATS_READ];
6710		wb += lun->stats.ports[i].bytes[CTL_STATS_WRITE];
6711		bintime_add(&rt, &lun->stats.ports[i].time[CTL_STATS_READ]);
6712		bintime_add(&wt, &lun->stats.ports[i].time[CTL_STATS_WRITE]);
6713	}
6714	scsi_u64to8b(rn, data->sap.read_num);
6715	scsi_u64to8b(wn, data->sap.write_num);
6716	if (lun->stats.blocksize > 0) {
6717		scsi_u64to8b(wb / lun->stats.blocksize,
6718		    data->sap.recvieved_lba);
6719		scsi_u64to8b(rb / lun->stats.blocksize,
6720		    data->sap.transmitted_lba);
6721	}
6722	scsi_u64to8b((uint64_t)rt.sec * 1000 + rt.frac / (UINT64_MAX / 1000),
6723	    data->sap.read_int);
6724	scsi_u64to8b((uint64_t)wt.sec * 1000 + wt.frac / (UINT64_MAX / 1000),
6725	    data->sap.write_int);
6726	scsi_u64to8b(0, data->sap.weighted_num);
6727	scsi_u64to8b(0, data->sap.weighted_int);
6728	scsi_ulto2b(SLP_IT, data->it.hdr.param_code);
6729	data->it.hdr.param_control = SLP_LBIN;
6730	data->it.hdr.param_len = sizeof(struct scsi_log_idle_time) -
6731	    sizeof(struct scsi_log_param_header);
6732#ifdef CTL_TIME_IO
6733	scsi_u64to8b(lun->idle_time / SBT_1MS, data->it.idle_int);
6734#endif
6735	scsi_ulto2b(SLP_TI, data->ti.hdr.param_code);
6736	data->it.hdr.param_control = SLP_LBIN;
6737	data->ti.hdr.param_len = sizeof(struct scsi_log_time_interval) -
6738	    sizeof(struct scsi_log_param_header);
6739	scsi_ulto4b(3, data->ti.exponent);
6740	scsi_ulto4b(1, data->ti.integer);
6741	return (0);
6742}
6743
6744int
6745ctl_ie_log_sense_handler(struct ctl_scsiio *ctsio,
6746			       struct ctl_page_index *page_index,
6747			       int pc)
6748{
6749	struct ctl_lun *lun;
6750	struct scsi_log_informational_exceptions *data;
6751
6752	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
6753	data = (struct scsi_log_informational_exceptions *)page_index->page_data;
6754
6755	scsi_ulto2b(SLP_IE_GEN, data->hdr.param_code);
6756	data->hdr.param_control = SLP_LBIN;
6757	data->hdr.param_len = sizeof(struct scsi_log_informational_exceptions) -
6758	    sizeof(struct scsi_log_param_header);
6759	data->ie_asc = lun->ie_asc;
6760	data->ie_ascq = lun->ie_ascq;
6761	data->temperature = 0xff;
6762	return (0);
6763}
6764
6765int
6766ctl_log_sense(struct ctl_scsiio *ctsio)
6767{
6768	struct ctl_lun *lun;
6769	int i, pc, page_code, subpage;
6770	int alloc_len, total_len;
6771	struct ctl_page_index *page_index;
6772	struct scsi_log_sense *cdb;
6773	struct scsi_log_header *header;
6774
6775	CTL_DEBUG_PRINT(("ctl_log_sense\n"));
6776
6777	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
6778	cdb = (struct scsi_log_sense *)ctsio->cdb;
6779	pc = (cdb->page & SLS_PAGE_CTRL_MASK) >> 6;
6780	page_code = cdb->page & SLS_PAGE_CODE;
6781	subpage = cdb->subpage;
6782	alloc_len = scsi_2btoul(cdb->length);
6783
6784	page_index = NULL;
6785	for (i = 0; i < CTL_NUM_LOG_PAGES; i++) {
6786		page_index = &lun->log_pages.index[i];
6787
6788		/* Look for the right page code */
6789		if ((page_index->page_code & SL_PAGE_CODE) != page_code)
6790			continue;
6791
6792		/* Look for the right subpage or the subpage wildcard*/
6793		if (page_index->subpage != subpage)
6794			continue;
6795
6796		break;
6797	}
6798	if (i >= CTL_NUM_LOG_PAGES) {
6799		ctl_set_invalid_field(ctsio,
6800				      /*sks_valid*/ 1,
6801				      /*command*/ 1,
6802				      /*field*/ 2,
6803				      /*bit_valid*/ 0,
6804				      /*bit*/ 0);
6805		ctl_done((union ctl_io *)ctsio);
6806		return (CTL_RETVAL_COMPLETE);
6807	}
6808
6809	total_len = sizeof(struct scsi_log_header) + page_index->page_len;
6810
6811	ctsio->kern_data_ptr = malloc(total_len, M_CTL, M_WAITOK | M_ZERO);
6812	ctsio->kern_sg_entries = 0;
6813	ctsio->kern_data_resid = 0;
6814	ctsio->kern_rel_offset = 0;
6815	if (total_len < alloc_len) {
6816		ctsio->residual = alloc_len - total_len;
6817		ctsio->kern_data_len = total_len;
6818		ctsio->kern_total_len = total_len;
6819	} else {
6820		ctsio->residual = 0;
6821		ctsio->kern_data_len = alloc_len;
6822		ctsio->kern_total_len = alloc_len;
6823	}
6824
6825	header = (struct scsi_log_header *)ctsio->kern_data_ptr;
6826	header->page = page_index->page_code;
6827	if (page_index->page_code == SLS_LOGICAL_BLOCK_PROVISIONING)
6828		header->page |= SL_DS;
6829	if (page_index->subpage) {
6830		header->page |= SL_SPF;
6831		header->subpage = page_index->subpage;
6832	}
6833	scsi_ulto2b(page_index->page_len, header->datalen);
6834
6835	/*
6836	 * Call the handler, if it exists, to update the
6837	 * page to the latest values.
6838	 */
6839	if (page_index->sense_handler != NULL)
6840		page_index->sense_handler(ctsio, page_index, pc);
6841
6842	memcpy(header + 1, page_index->page_data, page_index->page_len);
6843
6844	ctl_set_success(ctsio);
6845	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
6846	ctsio->be_move_done = ctl_config_move_done;
6847	ctl_datamove((union ctl_io *)ctsio);
6848	return (CTL_RETVAL_COMPLETE);
6849}
6850
6851int
6852ctl_read_capacity(struct ctl_scsiio *ctsio)
6853{
6854	struct scsi_read_capacity *cdb;
6855	struct scsi_read_capacity_data *data;
6856	struct ctl_lun *lun;
6857	uint32_t lba;
6858
6859	CTL_DEBUG_PRINT(("ctl_read_capacity\n"));
6860
6861	cdb = (struct scsi_read_capacity *)ctsio->cdb;
6862
6863	lba = scsi_4btoul(cdb->addr);
6864	if (((cdb->pmi & SRC_PMI) == 0)
6865	 && (lba != 0)) {
6866		ctl_set_invalid_field(/*ctsio*/ ctsio,
6867				      /*sks_valid*/ 1,
6868				      /*command*/ 1,
6869				      /*field*/ 2,
6870				      /*bit_valid*/ 0,
6871				      /*bit*/ 0);
6872		ctl_done((union ctl_io *)ctsio);
6873		return (CTL_RETVAL_COMPLETE);
6874	}
6875
6876	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
6877
6878	ctsio->kern_data_ptr = malloc(sizeof(*data), M_CTL, M_WAITOK | M_ZERO);
6879	data = (struct scsi_read_capacity_data *)ctsio->kern_data_ptr;
6880	ctsio->residual = 0;
6881	ctsio->kern_data_len = sizeof(*data);
6882	ctsio->kern_total_len = sizeof(*data);
6883	ctsio->kern_data_resid = 0;
6884	ctsio->kern_rel_offset = 0;
6885	ctsio->kern_sg_entries = 0;
6886
6887	/*
6888	 * If the maximum LBA is greater than 0xfffffffe, the user must
6889	 * issue a SERVICE ACTION IN (16) command, with the read capacity
6890	 * serivce action set.
6891	 */
6892	if (lun->be_lun->maxlba > 0xfffffffe)
6893		scsi_ulto4b(0xffffffff, data->addr);
6894	else
6895		scsi_ulto4b(lun->be_lun->maxlba, data->addr);
6896
6897	/*
6898	 * XXX KDM this may not be 512 bytes...
6899	 */
6900	scsi_ulto4b(lun->be_lun->blocksize, data->length);
6901
6902	ctl_set_success(ctsio);
6903	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
6904	ctsio->be_move_done = ctl_config_move_done;
6905	ctl_datamove((union ctl_io *)ctsio);
6906	return (CTL_RETVAL_COMPLETE);
6907}
6908
6909int
6910ctl_read_capacity_16(struct ctl_scsiio *ctsio)
6911{
6912	struct scsi_read_capacity_16 *cdb;
6913	struct scsi_read_capacity_data_long *data;
6914	struct ctl_lun *lun;
6915	uint64_t lba;
6916	uint32_t alloc_len;
6917
6918	CTL_DEBUG_PRINT(("ctl_read_capacity_16\n"));
6919
6920	cdb = (struct scsi_read_capacity_16 *)ctsio->cdb;
6921
6922	alloc_len = scsi_4btoul(cdb->alloc_len);
6923	lba = scsi_8btou64(cdb->addr);
6924
6925	if ((cdb->reladr & SRC16_PMI)
6926	 && (lba != 0)) {
6927		ctl_set_invalid_field(/*ctsio*/ ctsio,
6928				      /*sks_valid*/ 1,
6929				      /*command*/ 1,
6930				      /*field*/ 2,
6931				      /*bit_valid*/ 0,
6932				      /*bit*/ 0);
6933		ctl_done((union ctl_io *)ctsio);
6934		return (CTL_RETVAL_COMPLETE);
6935	}
6936
6937	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
6938
6939	ctsio->kern_data_ptr = malloc(sizeof(*data), M_CTL, M_WAITOK | M_ZERO);
6940	data = (struct scsi_read_capacity_data_long *)ctsio->kern_data_ptr;
6941
6942	if (sizeof(*data) < alloc_len) {
6943		ctsio->residual = alloc_len - sizeof(*data);
6944		ctsio->kern_data_len = sizeof(*data);
6945		ctsio->kern_total_len = sizeof(*data);
6946	} else {
6947		ctsio->residual = 0;
6948		ctsio->kern_data_len = alloc_len;
6949		ctsio->kern_total_len = alloc_len;
6950	}
6951	ctsio->kern_data_resid = 0;
6952	ctsio->kern_rel_offset = 0;
6953	ctsio->kern_sg_entries = 0;
6954
6955	scsi_u64to8b(lun->be_lun->maxlba, data->addr);
6956	/* XXX KDM this may not be 512 bytes... */
6957	scsi_ulto4b(lun->be_lun->blocksize, data->length);
6958	data->prot_lbppbe = lun->be_lun->pblockexp & SRC16_LBPPBE;
6959	scsi_ulto2b(lun->be_lun->pblockoff & SRC16_LALBA_A, data->lalba_lbp);
6960	if (lun->be_lun->flags & CTL_LUN_FLAG_UNMAP)
6961		data->lalba_lbp[0] |= SRC16_LBPME | SRC16_LBPRZ;
6962
6963	ctl_set_success(ctsio);
6964	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
6965	ctsio->be_move_done = ctl_config_move_done;
6966	ctl_datamove((union ctl_io *)ctsio);
6967	return (CTL_RETVAL_COMPLETE);
6968}
6969
6970int
6971ctl_get_lba_status(struct ctl_scsiio *ctsio)
6972{
6973	struct scsi_get_lba_status *cdb;
6974	struct scsi_get_lba_status_data *data;
6975	struct ctl_lun *lun;
6976	struct ctl_lba_len_flags *lbalen;
6977	uint64_t lba;
6978	uint32_t alloc_len, total_len;
6979	int retval;
6980
6981	CTL_DEBUG_PRINT(("ctl_get_lba_status\n"));
6982
6983	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
6984	cdb = (struct scsi_get_lba_status *)ctsio->cdb;
6985	lba = scsi_8btou64(cdb->addr);
6986	alloc_len = scsi_4btoul(cdb->alloc_len);
6987
6988	if (lba > lun->be_lun->maxlba) {
6989		ctl_set_lba_out_of_range(ctsio);
6990		ctl_done((union ctl_io *)ctsio);
6991		return (CTL_RETVAL_COMPLETE);
6992	}
6993
6994	total_len = sizeof(*data) + sizeof(data->descr[0]);
6995	ctsio->kern_data_ptr = malloc(total_len, M_CTL, M_WAITOK | M_ZERO);
6996	data = (struct scsi_get_lba_status_data *)ctsio->kern_data_ptr;
6997
6998	if (total_len < alloc_len) {
6999		ctsio->residual = alloc_len - total_len;
7000		ctsio->kern_data_len = total_len;
7001		ctsio->kern_total_len = total_len;
7002	} else {
7003		ctsio->residual = 0;
7004		ctsio->kern_data_len = alloc_len;
7005		ctsio->kern_total_len = alloc_len;
7006	}
7007	ctsio->kern_data_resid = 0;
7008	ctsio->kern_rel_offset = 0;
7009	ctsio->kern_sg_entries = 0;
7010
7011	/* Fill dummy data in case backend can't tell anything. */
7012	scsi_ulto4b(4 + sizeof(data->descr[0]), data->length);
7013	scsi_u64to8b(lba, data->descr[0].addr);
7014	scsi_ulto4b(MIN(UINT32_MAX, lun->be_lun->maxlba + 1 - lba),
7015	    data->descr[0].length);
7016	data->descr[0].status = 0; /* Mapped or unknown. */
7017
7018	ctl_set_success(ctsio);
7019	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
7020	ctsio->be_move_done = ctl_config_move_done;
7021
7022	lbalen = (struct ctl_lba_len_flags *)&ctsio->io_hdr.ctl_private[CTL_PRIV_LBA_LEN];
7023	lbalen->lba = lba;
7024	lbalen->len = total_len;
7025	lbalen->flags = 0;
7026	retval = lun->backend->config_read((union ctl_io *)ctsio);
7027	return (CTL_RETVAL_COMPLETE);
7028}
7029
7030int
7031ctl_read_defect(struct ctl_scsiio *ctsio)
7032{
7033	struct scsi_read_defect_data_10 *ccb10;
7034	struct scsi_read_defect_data_12 *ccb12;
7035	struct scsi_read_defect_data_hdr_10 *data10;
7036	struct scsi_read_defect_data_hdr_12 *data12;
7037	uint32_t alloc_len, data_len;
7038	uint8_t format;
7039
7040	CTL_DEBUG_PRINT(("ctl_read_defect\n"));
7041
7042	if (ctsio->cdb[0] == READ_DEFECT_DATA_10) {
7043		ccb10 = (struct scsi_read_defect_data_10 *)&ctsio->cdb;
7044		format = ccb10->format;
7045		alloc_len = scsi_2btoul(ccb10->alloc_length);
7046		data_len = sizeof(*data10);
7047	} else {
7048		ccb12 = (struct scsi_read_defect_data_12 *)&ctsio->cdb;
7049		format = ccb12->format;
7050		alloc_len = scsi_4btoul(ccb12->alloc_length);
7051		data_len = sizeof(*data12);
7052	}
7053	if (alloc_len == 0) {
7054		ctl_set_success(ctsio);
7055		ctl_done((union ctl_io *)ctsio);
7056		return (CTL_RETVAL_COMPLETE);
7057	}
7058
7059	ctsio->kern_data_ptr = malloc(data_len, M_CTL, M_WAITOK | M_ZERO);
7060	if (data_len < alloc_len) {
7061		ctsio->residual = alloc_len - data_len;
7062		ctsio->kern_data_len = data_len;
7063		ctsio->kern_total_len = data_len;
7064	} else {
7065		ctsio->residual = 0;
7066		ctsio->kern_data_len = alloc_len;
7067		ctsio->kern_total_len = alloc_len;
7068	}
7069	ctsio->kern_data_resid = 0;
7070	ctsio->kern_rel_offset = 0;
7071	ctsio->kern_sg_entries = 0;
7072
7073	if (ctsio->cdb[0] == READ_DEFECT_DATA_10) {
7074		data10 = (struct scsi_read_defect_data_hdr_10 *)
7075		    ctsio->kern_data_ptr;
7076		data10->format = format;
7077		scsi_ulto2b(0, data10->length);
7078	} else {
7079		data12 = (struct scsi_read_defect_data_hdr_12 *)
7080		    ctsio->kern_data_ptr;
7081		data12->format = format;
7082		scsi_ulto2b(0, data12->generation);
7083		scsi_ulto4b(0, data12->length);
7084	}
7085
7086	ctl_set_success(ctsio);
7087	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
7088	ctsio->be_move_done = ctl_config_move_done;
7089	ctl_datamove((union ctl_io *)ctsio);
7090	return (CTL_RETVAL_COMPLETE);
7091}
7092
7093int
7094ctl_report_tagret_port_groups(struct ctl_scsiio *ctsio)
7095{
7096	struct scsi_maintenance_in *cdb;
7097	int retval;
7098	int alloc_len, ext, total_len = 0, g, pc, pg, ts, os;
7099	int num_ha_groups, num_target_ports, shared_group;
7100	struct ctl_lun *lun;
7101	struct ctl_softc *softc;
7102	struct ctl_port *port;
7103	struct scsi_target_group_data *rtg_ptr;
7104	struct scsi_target_group_data_extended *rtg_ext_ptr;
7105	struct scsi_target_port_group_descriptor *tpg_desc;
7106
7107	CTL_DEBUG_PRINT(("ctl_report_tagret_port_groups\n"));
7108
7109	cdb = (struct scsi_maintenance_in *)ctsio->cdb;
7110	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
7111	softc = lun->ctl_softc;
7112
7113	retval = CTL_RETVAL_COMPLETE;
7114
7115	switch (cdb->byte2 & STG_PDF_MASK) {
7116	case STG_PDF_LENGTH:
7117		ext = 0;
7118		break;
7119	case STG_PDF_EXTENDED:
7120		ext = 1;
7121		break;
7122	default:
7123		ctl_set_invalid_field(/*ctsio*/ ctsio,
7124				      /*sks_valid*/ 1,
7125				      /*command*/ 1,
7126				      /*field*/ 2,
7127				      /*bit_valid*/ 1,
7128				      /*bit*/ 5);
7129		ctl_done((union ctl_io *)ctsio);
7130		return(retval);
7131	}
7132
7133	num_target_ports = 0;
7134	shared_group = (softc->is_single != 0);
7135	mtx_lock(&softc->ctl_lock);
7136	STAILQ_FOREACH(port, &softc->port_list, links) {
7137		if ((port->status & CTL_PORT_STATUS_ONLINE) == 0)
7138			continue;
7139		if (ctl_lun_map_to_port(port, lun->lun) >= CTL_MAX_LUNS)
7140			continue;
7141		num_target_ports++;
7142		if (port->status & CTL_PORT_STATUS_HA_SHARED)
7143			shared_group = 1;
7144	}
7145	mtx_unlock(&softc->ctl_lock);
7146	num_ha_groups = (softc->is_single) ? 0 : NUM_HA_SHELVES;
7147
7148	if (ext)
7149		total_len = sizeof(struct scsi_target_group_data_extended);
7150	else
7151		total_len = sizeof(struct scsi_target_group_data);
7152	total_len += sizeof(struct scsi_target_port_group_descriptor) *
7153		(shared_group + num_ha_groups) +
7154	    sizeof(struct scsi_target_port_descriptor) * num_target_ports;
7155
7156	alloc_len = scsi_4btoul(cdb->length);
7157
7158	ctsio->kern_data_ptr = malloc(total_len, M_CTL, M_WAITOK | M_ZERO);
7159
7160	ctsio->kern_sg_entries = 0;
7161
7162	if (total_len < alloc_len) {
7163		ctsio->residual = alloc_len - total_len;
7164		ctsio->kern_data_len = total_len;
7165		ctsio->kern_total_len = total_len;
7166	} else {
7167		ctsio->residual = 0;
7168		ctsio->kern_data_len = alloc_len;
7169		ctsio->kern_total_len = alloc_len;
7170	}
7171	ctsio->kern_data_resid = 0;
7172	ctsio->kern_rel_offset = 0;
7173
7174	if (ext) {
7175		rtg_ext_ptr = (struct scsi_target_group_data_extended *)
7176		    ctsio->kern_data_ptr;
7177		scsi_ulto4b(total_len - 4, rtg_ext_ptr->length);
7178		rtg_ext_ptr->format_type = 0x10;
7179		rtg_ext_ptr->implicit_transition_time = 0;
7180		tpg_desc = &rtg_ext_ptr->groups[0];
7181	} else {
7182		rtg_ptr = (struct scsi_target_group_data *)
7183		    ctsio->kern_data_ptr;
7184		scsi_ulto4b(total_len - 4, rtg_ptr->length);
7185		tpg_desc = &rtg_ptr->groups[0];
7186	}
7187
7188	mtx_lock(&softc->ctl_lock);
7189	pg = softc->port_min / softc->port_cnt;
7190	if (lun->flags & (CTL_LUN_PRIMARY_SC | CTL_LUN_PEER_SC_PRIMARY)) {
7191		/* Some shelf is known to be primary. */
7192		if (softc->ha_link == CTL_HA_LINK_OFFLINE)
7193			os = TPG_ASYMMETRIC_ACCESS_UNAVAILABLE;
7194		else if (softc->ha_link == CTL_HA_LINK_UNKNOWN)
7195			os = TPG_ASYMMETRIC_ACCESS_TRANSITIONING;
7196		else if (softc->ha_mode == CTL_HA_MODE_ACT_STBY)
7197			os = TPG_ASYMMETRIC_ACCESS_STANDBY;
7198		else
7199			os = TPG_ASYMMETRIC_ACCESS_NONOPTIMIZED;
7200		if (lun->flags & CTL_LUN_PRIMARY_SC) {
7201			ts = TPG_ASYMMETRIC_ACCESS_OPTIMIZED;
7202		} else {
7203			ts = os;
7204			os = TPG_ASYMMETRIC_ACCESS_OPTIMIZED;
7205		}
7206	} else {
7207		/* No known primary shelf. */
7208		if (softc->ha_link == CTL_HA_LINK_OFFLINE) {
7209			ts = TPG_ASYMMETRIC_ACCESS_UNAVAILABLE;
7210			os = TPG_ASYMMETRIC_ACCESS_OPTIMIZED;
7211		} else if (softc->ha_link == CTL_HA_LINK_UNKNOWN) {
7212			ts = TPG_ASYMMETRIC_ACCESS_TRANSITIONING;
7213			os = TPG_ASYMMETRIC_ACCESS_OPTIMIZED;
7214		} else {
7215			ts = os = TPG_ASYMMETRIC_ACCESS_TRANSITIONING;
7216		}
7217	}
7218	if (shared_group) {
7219		tpg_desc->pref_state = ts;
7220		tpg_desc->support = TPG_AO_SUP | TPG_AN_SUP | TPG_S_SUP |
7221		    TPG_U_SUP | TPG_T_SUP;
7222		scsi_ulto2b(1, tpg_desc->target_port_group);
7223		tpg_desc->status = TPG_IMPLICIT;
7224		pc = 0;
7225		STAILQ_FOREACH(port, &softc->port_list, links) {
7226			if ((port->status & CTL_PORT_STATUS_ONLINE) == 0)
7227				continue;
7228			if (!softc->is_single &&
7229			    (port->status & CTL_PORT_STATUS_HA_SHARED) == 0)
7230				continue;
7231			if (ctl_lun_map_to_port(port, lun->lun) >= CTL_MAX_LUNS)
7232				continue;
7233			scsi_ulto2b(port->targ_port, tpg_desc->descriptors[pc].
7234			    relative_target_port_identifier);
7235			pc++;
7236		}
7237		tpg_desc->target_port_count = pc;
7238		tpg_desc = (struct scsi_target_port_group_descriptor *)
7239		    &tpg_desc->descriptors[pc];
7240	}
7241	for (g = 0; g < num_ha_groups; g++) {
7242		tpg_desc->pref_state = (g == pg) ? ts : os;
7243		tpg_desc->support = TPG_AO_SUP | TPG_AN_SUP | TPG_S_SUP |
7244		    TPG_U_SUP | TPG_T_SUP;
7245		scsi_ulto2b(2 + g, tpg_desc->target_port_group);
7246		tpg_desc->status = TPG_IMPLICIT;
7247		pc = 0;
7248		STAILQ_FOREACH(port, &softc->port_list, links) {
7249			if (port->targ_port < g * softc->port_cnt ||
7250			    port->targ_port >= (g + 1) * softc->port_cnt)
7251				continue;
7252			if ((port->status & CTL_PORT_STATUS_ONLINE) == 0)
7253				continue;
7254			if (port->status & CTL_PORT_STATUS_HA_SHARED)
7255				continue;
7256			if (ctl_lun_map_to_port(port, lun->lun) >= CTL_MAX_LUNS)
7257				continue;
7258			scsi_ulto2b(port->targ_port, tpg_desc->descriptors[pc].
7259			    relative_target_port_identifier);
7260			pc++;
7261		}
7262		tpg_desc->target_port_count = pc;
7263		tpg_desc = (struct scsi_target_port_group_descriptor *)
7264		    &tpg_desc->descriptors[pc];
7265	}
7266	mtx_unlock(&softc->ctl_lock);
7267
7268	ctl_set_success(ctsio);
7269	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
7270	ctsio->be_move_done = ctl_config_move_done;
7271	ctl_datamove((union ctl_io *)ctsio);
7272	return(retval);
7273}
7274
7275int
7276ctl_report_supported_opcodes(struct ctl_scsiio *ctsio)
7277{
7278	struct ctl_lun *lun;
7279	struct scsi_report_supported_opcodes *cdb;
7280	const struct ctl_cmd_entry *entry, *sentry;
7281	struct scsi_report_supported_opcodes_all *all;
7282	struct scsi_report_supported_opcodes_descr *descr;
7283	struct scsi_report_supported_opcodes_one *one;
7284	int retval;
7285	int alloc_len, total_len;
7286	int opcode, service_action, i, j, num;
7287
7288	CTL_DEBUG_PRINT(("ctl_report_supported_opcodes\n"));
7289
7290	cdb = (struct scsi_report_supported_opcodes *)ctsio->cdb;
7291	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
7292
7293	retval = CTL_RETVAL_COMPLETE;
7294
7295	opcode = cdb->requested_opcode;
7296	service_action = scsi_2btoul(cdb->requested_service_action);
7297	switch (cdb->options & RSO_OPTIONS_MASK) {
7298	case RSO_OPTIONS_ALL:
7299		num = 0;
7300		for (i = 0; i < 256; i++) {
7301			entry = &ctl_cmd_table[i];
7302			if (entry->flags & CTL_CMD_FLAG_SA5) {
7303				for (j = 0; j < 32; j++) {
7304					sentry = &((const struct ctl_cmd_entry *)
7305					    entry->execute)[j];
7306					if (ctl_cmd_applicable(
7307					    lun->be_lun->lun_type, sentry))
7308						num++;
7309				}
7310			} else {
7311				if (ctl_cmd_applicable(lun->be_lun->lun_type,
7312				    entry))
7313					num++;
7314			}
7315		}
7316		total_len = sizeof(struct scsi_report_supported_opcodes_all) +
7317		    num * sizeof(struct scsi_report_supported_opcodes_descr);
7318		break;
7319	case RSO_OPTIONS_OC:
7320		if (ctl_cmd_table[opcode].flags & CTL_CMD_FLAG_SA5) {
7321			ctl_set_invalid_field(/*ctsio*/ ctsio,
7322					      /*sks_valid*/ 1,
7323					      /*command*/ 1,
7324					      /*field*/ 2,
7325					      /*bit_valid*/ 1,
7326					      /*bit*/ 2);
7327			ctl_done((union ctl_io *)ctsio);
7328			return (CTL_RETVAL_COMPLETE);
7329		}
7330		total_len = sizeof(struct scsi_report_supported_opcodes_one) + 32;
7331		break;
7332	case RSO_OPTIONS_OC_SA:
7333		if ((ctl_cmd_table[opcode].flags & CTL_CMD_FLAG_SA5) == 0 ||
7334		    service_action >= 32) {
7335			ctl_set_invalid_field(/*ctsio*/ ctsio,
7336					      /*sks_valid*/ 1,
7337					      /*command*/ 1,
7338					      /*field*/ 2,
7339					      /*bit_valid*/ 1,
7340					      /*bit*/ 2);
7341			ctl_done((union ctl_io *)ctsio);
7342			return (CTL_RETVAL_COMPLETE);
7343		}
7344		total_len = sizeof(struct scsi_report_supported_opcodes_one) + 32;
7345		break;
7346	default:
7347		ctl_set_invalid_field(/*ctsio*/ ctsio,
7348				      /*sks_valid*/ 1,
7349				      /*command*/ 1,
7350				      /*field*/ 2,
7351				      /*bit_valid*/ 1,
7352				      /*bit*/ 2);
7353		ctl_done((union ctl_io *)ctsio);
7354		return (CTL_RETVAL_COMPLETE);
7355	}
7356
7357	alloc_len = scsi_4btoul(cdb->length);
7358
7359	ctsio->kern_data_ptr = malloc(total_len, M_CTL, M_WAITOK | M_ZERO);
7360
7361	ctsio->kern_sg_entries = 0;
7362
7363	if (total_len < alloc_len) {
7364		ctsio->residual = alloc_len - total_len;
7365		ctsio->kern_data_len = total_len;
7366		ctsio->kern_total_len = total_len;
7367	} else {
7368		ctsio->residual = 0;
7369		ctsio->kern_data_len = alloc_len;
7370		ctsio->kern_total_len = alloc_len;
7371	}
7372	ctsio->kern_data_resid = 0;
7373	ctsio->kern_rel_offset = 0;
7374
7375	switch (cdb->options & RSO_OPTIONS_MASK) {
7376	case RSO_OPTIONS_ALL:
7377		all = (struct scsi_report_supported_opcodes_all *)
7378		    ctsio->kern_data_ptr;
7379		num = 0;
7380		for (i = 0; i < 256; i++) {
7381			entry = &ctl_cmd_table[i];
7382			if (entry->flags & CTL_CMD_FLAG_SA5) {
7383				for (j = 0; j < 32; j++) {
7384					sentry = &((const struct ctl_cmd_entry *)
7385					    entry->execute)[j];
7386					if (!ctl_cmd_applicable(
7387					    lun->be_lun->lun_type, sentry))
7388						continue;
7389					descr = &all->descr[num++];
7390					descr->opcode = i;
7391					scsi_ulto2b(j, descr->service_action);
7392					descr->flags = RSO_SERVACTV;
7393					scsi_ulto2b(sentry->length,
7394					    descr->cdb_length);
7395				}
7396			} else {
7397				if (!ctl_cmd_applicable(lun->be_lun->lun_type,
7398				    entry))
7399					continue;
7400				descr = &all->descr[num++];
7401				descr->opcode = i;
7402				scsi_ulto2b(0, descr->service_action);
7403				descr->flags = 0;
7404				scsi_ulto2b(entry->length, descr->cdb_length);
7405			}
7406		}
7407		scsi_ulto4b(
7408		    num * sizeof(struct scsi_report_supported_opcodes_descr),
7409		    all->length);
7410		break;
7411	case RSO_OPTIONS_OC:
7412		one = (struct scsi_report_supported_opcodes_one *)
7413		    ctsio->kern_data_ptr;
7414		entry = &ctl_cmd_table[opcode];
7415		goto fill_one;
7416	case RSO_OPTIONS_OC_SA:
7417		one = (struct scsi_report_supported_opcodes_one *)
7418		    ctsio->kern_data_ptr;
7419		entry = &ctl_cmd_table[opcode];
7420		entry = &((const struct ctl_cmd_entry *)
7421		    entry->execute)[service_action];
7422fill_one:
7423		if (ctl_cmd_applicable(lun->be_lun->lun_type, entry)) {
7424			one->support = 3;
7425			scsi_ulto2b(entry->length, one->cdb_length);
7426			one->cdb_usage[0] = opcode;
7427			memcpy(&one->cdb_usage[1], entry->usage,
7428			    entry->length - 1);
7429		} else
7430			one->support = 1;
7431		break;
7432	}
7433
7434	ctl_set_success(ctsio);
7435	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
7436	ctsio->be_move_done = ctl_config_move_done;
7437	ctl_datamove((union ctl_io *)ctsio);
7438	return(retval);
7439}
7440
7441int
7442ctl_report_supported_tmf(struct ctl_scsiio *ctsio)
7443{
7444	struct scsi_report_supported_tmf *cdb;
7445	struct scsi_report_supported_tmf_data *data;
7446	int retval;
7447	int alloc_len, total_len;
7448
7449	CTL_DEBUG_PRINT(("ctl_report_supported_tmf\n"));
7450
7451	cdb = (struct scsi_report_supported_tmf *)ctsio->cdb;
7452
7453	retval = CTL_RETVAL_COMPLETE;
7454
7455	total_len = sizeof(struct scsi_report_supported_tmf_data);
7456	alloc_len = scsi_4btoul(cdb->length);
7457
7458	ctsio->kern_data_ptr = malloc(total_len, M_CTL, M_WAITOK | M_ZERO);
7459
7460	ctsio->kern_sg_entries = 0;
7461
7462	if (total_len < alloc_len) {
7463		ctsio->residual = alloc_len - total_len;
7464		ctsio->kern_data_len = total_len;
7465		ctsio->kern_total_len = total_len;
7466	} else {
7467		ctsio->residual = 0;
7468		ctsio->kern_data_len = alloc_len;
7469		ctsio->kern_total_len = alloc_len;
7470	}
7471	ctsio->kern_data_resid = 0;
7472	ctsio->kern_rel_offset = 0;
7473
7474	data = (struct scsi_report_supported_tmf_data *)ctsio->kern_data_ptr;
7475	data->byte1 |= RST_ATS | RST_ATSS | RST_CTSS | RST_LURS | RST_QTS |
7476	    RST_TRS;
7477	data->byte2 |= RST_QAES | RST_QTSS | RST_ITNRS;
7478
7479	ctl_set_success(ctsio);
7480	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
7481	ctsio->be_move_done = ctl_config_move_done;
7482	ctl_datamove((union ctl_io *)ctsio);
7483	return (retval);
7484}
7485
7486int
7487ctl_report_timestamp(struct ctl_scsiio *ctsio)
7488{
7489	struct scsi_report_timestamp *cdb;
7490	struct scsi_report_timestamp_data *data;
7491	struct timeval tv;
7492	int64_t timestamp;
7493	int retval;
7494	int alloc_len, total_len;
7495
7496	CTL_DEBUG_PRINT(("ctl_report_timestamp\n"));
7497
7498	cdb = (struct scsi_report_timestamp *)ctsio->cdb;
7499
7500	retval = CTL_RETVAL_COMPLETE;
7501
7502	total_len = sizeof(struct scsi_report_timestamp_data);
7503	alloc_len = scsi_4btoul(cdb->length);
7504
7505	ctsio->kern_data_ptr = malloc(total_len, M_CTL, M_WAITOK | M_ZERO);
7506
7507	ctsio->kern_sg_entries = 0;
7508
7509	if (total_len < alloc_len) {
7510		ctsio->residual = alloc_len - total_len;
7511		ctsio->kern_data_len = total_len;
7512		ctsio->kern_total_len = total_len;
7513	} else {
7514		ctsio->residual = 0;
7515		ctsio->kern_data_len = alloc_len;
7516		ctsio->kern_total_len = alloc_len;
7517	}
7518	ctsio->kern_data_resid = 0;
7519	ctsio->kern_rel_offset = 0;
7520
7521	data = (struct scsi_report_timestamp_data *)ctsio->kern_data_ptr;
7522	scsi_ulto2b(sizeof(*data) - 2, data->length);
7523	data->origin = RTS_ORIG_OUTSIDE;
7524	getmicrotime(&tv);
7525	timestamp = (int64_t)tv.tv_sec * 1000 + tv.tv_usec / 1000;
7526	scsi_ulto4b(timestamp >> 16, data->timestamp);
7527	scsi_ulto2b(timestamp & 0xffff, &data->timestamp[4]);
7528
7529	ctl_set_success(ctsio);
7530	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
7531	ctsio->be_move_done = ctl_config_move_done;
7532	ctl_datamove((union ctl_io *)ctsio);
7533	return (retval);
7534}
7535
7536int
7537ctl_persistent_reserve_in(struct ctl_scsiio *ctsio)
7538{
7539	struct scsi_per_res_in *cdb;
7540	int alloc_len, total_len = 0;
7541	/* struct scsi_per_res_in_rsrv in_data; */
7542	struct ctl_lun *lun;
7543	struct ctl_softc *softc;
7544	uint64_t key;
7545
7546	CTL_DEBUG_PRINT(("ctl_persistent_reserve_in\n"));
7547
7548	cdb = (struct scsi_per_res_in *)ctsio->cdb;
7549
7550	alloc_len = scsi_2btoul(cdb->length);
7551
7552	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
7553	softc = lun->ctl_softc;
7554
7555retry:
7556	mtx_lock(&lun->lun_lock);
7557	switch (cdb->action) {
7558	case SPRI_RK: /* read keys */
7559		total_len = sizeof(struct scsi_per_res_in_keys) +
7560			lun->pr_key_count *
7561			sizeof(struct scsi_per_res_key);
7562		break;
7563	case SPRI_RR: /* read reservation */
7564		if (lun->flags & CTL_LUN_PR_RESERVED)
7565			total_len = sizeof(struct scsi_per_res_in_rsrv);
7566		else
7567			total_len = sizeof(struct scsi_per_res_in_header);
7568		break;
7569	case SPRI_RC: /* report capabilities */
7570		total_len = sizeof(struct scsi_per_res_cap);
7571		break;
7572	case SPRI_RS: /* read full status */
7573		total_len = sizeof(struct scsi_per_res_in_header) +
7574		    (sizeof(struct scsi_per_res_in_full_desc) + 256) *
7575		    lun->pr_key_count;
7576		break;
7577	default:
7578		panic("%s: Invalid PR type %#x", __func__, cdb->action);
7579	}
7580	mtx_unlock(&lun->lun_lock);
7581
7582	ctsio->kern_data_ptr = malloc(total_len, M_CTL, M_WAITOK | M_ZERO);
7583
7584	if (total_len < alloc_len) {
7585		ctsio->residual = alloc_len - total_len;
7586		ctsio->kern_data_len = total_len;
7587		ctsio->kern_total_len = total_len;
7588	} else {
7589		ctsio->residual = 0;
7590		ctsio->kern_data_len = alloc_len;
7591		ctsio->kern_total_len = alloc_len;
7592	}
7593
7594	ctsio->kern_data_resid = 0;
7595	ctsio->kern_rel_offset = 0;
7596	ctsio->kern_sg_entries = 0;
7597
7598	mtx_lock(&lun->lun_lock);
7599	switch (cdb->action) {
7600	case SPRI_RK: { // read keys
7601        struct scsi_per_res_in_keys *res_keys;
7602		int i, key_count;
7603
7604		res_keys = (struct scsi_per_res_in_keys*)ctsio->kern_data_ptr;
7605
7606		/*
7607		 * We had to drop the lock to allocate our buffer, which
7608		 * leaves time for someone to come in with another
7609		 * persistent reservation.  (That is unlikely, though,
7610		 * since this should be the only persistent reservation
7611		 * command active right now.)
7612		 */
7613		if (total_len != (sizeof(struct scsi_per_res_in_keys) +
7614		    (lun->pr_key_count *
7615		     sizeof(struct scsi_per_res_key)))){
7616			mtx_unlock(&lun->lun_lock);
7617			free(ctsio->kern_data_ptr, M_CTL);
7618			printf("%s: reservation length changed, retrying\n",
7619			       __func__);
7620			goto retry;
7621		}
7622
7623		scsi_ulto4b(lun->pr_generation, res_keys->header.generation);
7624
7625		scsi_ulto4b(sizeof(struct scsi_per_res_key) *
7626			     lun->pr_key_count, res_keys->header.length);
7627
7628		for (i = 0, key_count = 0; i < CTL_MAX_INITIATORS; i++) {
7629			if ((key = ctl_get_prkey(lun, i)) == 0)
7630				continue;
7631
7632			/*
7633			 * We used lun->pr_key_count to calculate the
7634			 * size to allocate.  If it turns out the number of
7635			 * initiators with the registered flag set is
7636			 * larger than that (i.e. they haven't been kept in
7637			 * sync), we've got a problem.
7638			 */
7639			if (key_count >= lun->pr_key_count) {
7640				key_count++;
7641				continue;
7642			}
7643			scsi_u64to8b(key, res_keys->keys[key_count].key);
7644			key_count++;
7645		}
7646		break;
7647	}
7648	case SPRI_RR: { // read reservation
7649		struct scsi_per_res_in_rsrv *res;
7650		int tmp_len, header_only;
7651
7652		res = (struct scsi_per_res_in_rsrv *)ctsio->kern_data_ptr;
7653
7654		scsi_ulto4b(lun->pr_generation, res->header.generation);
7655
7656		if (lun->flags & CTL_LUN_PR_RESERVED)
7657		{
7658			tmp_len = sizeof(struct scsi_per_res_in_rsrv);
7659			scsi_ulto4b(sizeof(struct scsi_per_res_in_rsrv_data),
7660				    res->header.length);
7661			header_only = 0;
7662		} else {
7663			tmp_len = sizeof(struct scsi_per_res_in_header);
7664			scsi_ulto4b(0, res->header.length);
7665			header_only = 1;
7666		}
7667
7668		/*
7669		 * We had to drop the lock to allocate our buffer, which
7670		 * leaves time for someone to come in with another
7671		 * persistent reservation.  (That is unlikely, though,
7672		 * since this should be the only persistent reservation
7673		 * command active right now.)
7674		 */
7675		if (tmp_len != total_len) {
7676			mtx_unlock(&lun->lun_lock);
7677			free(ctsio->kern_data_ptr, M_CTL);
7678			printf("%s: reservation status changed, retrying\n",
7679			       __func__);
7680			goto retry;
7681		}
7682
7683		/*
7684		 * No reservation held, so we're done.
7685		 */
7686		if (header_only != 0)
7687			break;
7688
7689		/*
7690		 * If the registration is an All Registrants type, the key
7691		 * is 0, since it doesn't really matter.
7692		 */
7693		if (lun->pr_res_idx != CTL_PR_ALL_REGISTRANTS) {
7694			scsi_u64to8b(ctl_get_prkey(lun, lun->pr_res_idx),
7695			    res->data.reservation);
7696		}
7697		res->data.scopetype = lun->pr_res_type;
7698		break;
7699	}
7700	case SPRI_RC:     //report capabilities
7701	{
7702		struct scsi_per_res_cap *res_cap;
7703		uint16_t type_mask;
7704
7705		res_cap = (struct scsi_per_res_cap *)ctsio->kern_data_ptr;
7706		scsi_ulto2b(sizeof(*res_cap), res_cap->length);
7707		res_cap->flags1 = SPRI_CRH;
7708		res_cap->flags2 = SPRI_TMV | SPRI_ALLOW_5;
7709		type_mask = SPRI_TM_WR_EX_AR |
7710			    SPRI_TM_EX_AC_RO |
7711			    SPRI_TM_WR_EX_RO |
7712			    SPRI_TM_EX_AC |
7713			    SPRI_TM_WR_EX |
7714			    SPRI_TM_EX_AC_AR;
7715		scsi_ulto2b(type_mask, res_cap->type_mask);
7716		break;
7717	}
7718	case SPRI_RS: { // read full status
7719		struct scsi_per_res_in_full *res_status;
7720		struct scsi_per_res_in_full_desc *res_desc;
7721		struct ctl_port *port;
7722		int i, len;
7723
7724		res_status = (struct scsi_per_res_in_full*)ctsio->kern_data_ptr;
7725
7726		/*
7727		 * We had to drop the lock to allocate our buffer, which
7728		 * leaves time for someone to come in with another
7729		 * persistent reservation.  (That is unlikely, though,
7730		 * since this should be the only persistent reservation
7731		 * command active right now.)
7732		 */
7733		if (total_len < (sizeof(struct scsi_per_res_in_header) +
7734		    (sizeof(struct scsi_per_res_in_full_desc) + 256) *
7735		     lun->pr_key_count)){
7736			mtx_unlock(&lun->lun_lock);
7737			free(ctsio->kern_data_ptr, M_CTL);
7738			printf("%s: reservation length changed, retrying\n",
7739			       __func__);
7740			goto retry;
7741		}
7742
7743		scsi_ulto4b(lun->pr_generation, res_status->header.generation);
7744
7745		res_desc = &res_status->desc[0];
7746		for (i = 0; i < CTL_MAX_INITIATORS; i++) {
7747			if ((key = ctl_get_prkey(lun, i)) == 0)
7748				continue;
7749
7750			scsi_u64to8b(key, res_desc->res_key.key);
7751			if ((lun->flags & CTL_LUN_PR_RESERVED) &&
7752			    (lun->pr_res_idx == i ||
7753			     lun->pr_res_idx == CTL_PR_ALL_REGISTRANTS)) {
7754				res_desc->flags = SPRI_FULL_R_HOLDER;
7755				res_desc->scopetype = lun->pr_res_type;
7756			}
7757			scsi_ulto2b(i / CTL_MAX_INIT_PER_PORT,
7758			    res_desc->rel_trgt_port_id);
7759			len = 0;
7760			port = softc->ctl_ports[i / CTL_MAX_INIT_PER_PORT];
7761			if (port != NULL)
7762				len = ctl_create_iid(port,
7763				    i % CTL_MAX_INIT_PER_PORT,
7764				    res_desc->transport_id);
7765			scsi_ulto4b(len, res_desc->additional_length);
7766			res_desc = (struct scsi_per_res_in_full_desc *)
7767			    &res_desc->transport_id[len];
7768		}
7769		scsi_ulto4b((uint8_t *)res_desc - (uint8_t *)&res_status->desc[0],
7770		    res_status->header.length);
7771		break;
7772	}
7773	default:
7774		panic("%s: Invalid PR type %#x", __func__, cdb->action);
7775	}
7776	mtx_unlock(&lun->lun_lock);
7777
7778	ctl_set_success(ctsio);
7779	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
7780	ctsio->be_move_done = ctl_config_move_done;
7781	ctl_datamove((union ctl_io *)ctsio);
7782	return (CTL_RETVAL_COMPLETE);
7783}
7784
7785/*
7786 * Returns 0 if ctl_persistent_reserve_out() should continue, non-zero if
7787 * it should return.
7788 */
7789static int
7790ctl_pro_preempt(struct ctl_softc *softc, struct ctl_lun *lun, uint64_t res_key,
7791		uint64_t sa_res_key, uint8_t type, uint32_t residx,
7792		struct ctl_scsiio *ctsio, struct scsi_per_res_out *cdb,
7793		struct scsi_per_res_out_parms* param)
7794{
7795	union ctl_ha_msg persis_io;
7796	int i;
7797
7798	mtx_lock(&lun->lun_lock);
7799	if (sa_res_key == 0) {
7800		if (lun->pr_res_idx == CTL_PR_ALL_REGISTRANTS) {
7801			/* validate scope and type */
7802			if ((cdb->scope_type & SPR_SCOPE_MASK) !=
7803			     SPR_LU_SCOPE) {
7804				mtx_unlock(&lun->lun_lock);
7805				ctl_set_invalid_field(/*ctsio*/ ctsio,
7806						      /*sks_valid*/ 1,
7807						      /*command*/ 1,
7808						      /*field*/ 2,
7809						      /*bit_valid*/ 1,
7810						      /*bit*/ 4);
7811				ctl_done((union ctl_io *)ctsio);
7812				return (1);
7813			}
7814
7815		        if (type>8 || type==2 || type==4 || type==0) {
7816				mtx_unlock(&lun->lun_lock);
7817				ctl_set_invalid_field(/*ctsio*/ ctsio,
7818       	           				      /*sks_valid*/ 1,
7819						      /*command*/ 1,
7820						      /*field*/ 2,
7821						      /*bit_valid*/ 1,
7822						      /*bit*/ 0);
7823				ctl_done((union ctl_io *)ctsio);
7824				return (1);
7825		        }
7826
7827			/*
7828			 * Unregister everybody else and build UA for
7829			 * them
7830			 */
7831			for(i = 0; i < CTL_MAX_INITIATORS; i++) {
7832				if (i == residx || ctl_get_prkey(lun, i) == 0)
7833					continue;
7834
7835				ctl_clr_prkey(lun, i);
7836				ctl_est_ua(lun, i, CTL_UA_REG_PREEMPT);
7837			}
7838			lun->pr_key_count = 1;
7839			lun->pr_res_type = type;
7840			if (lun->pr_res_type != SPR_TYPE_WR_EX_AR &&
7841			    lun->pr_res_type != SPR_TYPE_EX_AC_AR)
7842				lun->pr_res_idx = residx;
7843			lun->pr_generation++;
7844			mtx_unlock(&lun->lun_lock);
7845
7846			/* send msg to other side */
7847			persis_io.hdr.nexus = ctsio->io_hdr.nexus;
7848			persis_io.hdr.msg_type = CTL_MSG_PERS_ACTION;
7849			persis_io.pr.pr_info.action = CTL_PR_PREEMPT;
7850			persis_io.pr.pr_info.residx = lun->pr_res_idx;
7851			persis_io.pr.pr_info.res_type = type;
7852			memcpy(persis_io.pr.pr_info.sa_res_key,
7853			       param->serv_act_res_key,
7854			       sizeof(param->serv_act_res_key));
7855			ctl_ha_msg_send(CTL_HA_CHAN_CTL, &persis_io,
7856			    sizeof(persis_io.pr), M_WAITOK);
7857		} else {
7858			/* not all registrants */
7859			mtx_unlock(&lun->lun_lock);
7860			free(ctsio->kern_data_ptr, M_CTL);
7861			ctl_set_invalid_field(ctsio,
7862					      /*sks_valid*/ 1,
7863					      /*command*/ 0,
7864					      /*field*/ 8,
7865					      /*bit_valid*/ 0,
7866					      /*bit*/ 0);
7867			ctl_done((union ctl_io *)ctsio);
7868			return (1);
7869		}
7870	} else if (lun->pr_res_idx == CTL_PR_ALL_REGISTRANTS
7871		|| !(lun->flags & CTL_LUN_PR_RESERVED)) {
7872		int found = 0;
7873
7874		if (res_key == sa_res_key) {
7875			/* special case */
7876			/*
7877			 * The spec implies this is not good but doesn't
7878			 * say what to do. There are two choices either
7879			 * generate a res conflict or check condition
7880			 * with illegal field in parameter data. Since
7881			 * that is what is done when the sa_res_key is
7882			 * zero I'll take that approach since this has
7883			 * to do with the sa_res_key.
7884			 */
7885			mtx_unlock(&lun->lun_lock);
7886			free(ctsio->kern_data_ptr, M_CTL);
7887			ctl_set_invalid_field(ctsio,
7888					      /*sks_valid*/ 1,
7889					      /*command*/ 0,
7890					      /*field*/ 8,
7891					      /*bit_valid*/ 0,
7892					      /*bit*/ 0);
7893			ctl_done((union ctl_io *)ctsio);
7894			return (1);
7895		}
7896
7897		for (i = 0; i < CTL_MAX_INITIATORS; i++) {
7898			if (ctl_get_prkey(lun, i) != sa_res_key)
7899				continue;
7900
7901			found = 1;
7902			ctl_clr_prkey(lun, i);
7903			lun->pr_key_count--;
7904			ctl_est_ua(lun, i, CTL_UA_REG_PREEMPT);
7905		}
7906		if (!found) {
7907			mtx_unlock(&lun->lun_lock);
7908			free(ctsio->kern_data_ptr, M_CTL);
7909			ctl_set_reservation_conflict(ctsio);
7910			ctl_done((union ctl_io *)ctsio);
7911			return (CTL_RETVAL_COMPLETE);
7912		}
7913		lun->pr_generation++;
7914		mtx_unlock(&lun->lun_lock);
7915
7916		/* send msg to other side */
7917		persis_io.hdr.nexus = ctsio->io_hdr.nexus;
7918		persis_io.hdr.msg_type = CTL_MSG_PERS_ACTION;
7919		persis_io.pr.pr_info.action = CTL_PR_PREEMPT;
7920		persis_io.pr.pr_info.residx = lun->pr_res_idx;
7921		persis_io.pr.pr_info.res_type = type;
7922		memcpy(persis_io.pr.pr_info.sa_res_key,
7923		       param->serv_act_res_key,
7924		       sizeof(param->serv_act_res_key));
7925		ctl_ha_msg_send(CTL_HA_CHAN_CTL, &persis_io,
7926		    sizeof(persis_io.pr), M_WAITOK);
7927	} else {
7928		/* Reserved but not all registrants */
7929		/* sa_res_key is res holder */
7930		if (sa_res_key == ctl_get_prkey(lun, lun->pr_res_idx)) {
7931			/* validate scope and type */
7932			if ((cdb->scope_type & SPR_SCOPE_MASK) !=
7933			     SPR_LU_SCOPE) {
7934				mtx_unlock(&lun->lun_lock);
7935				ctl_set_invalid_field(/*ctsio*/ ctsio,
7936						      /*sks_valid*/ 1,
7937						      /*command*/ 1,
7938						      /*field*/ 2,
7939						      /*bit_valid*/ 1,
7940						      /*bit*/ 4);
7941				ctl_done((union ctl_io *)ctsio);
7942				return (1);
7943			}
7944
7945			if (type>8 || type==2 || type==4 || type==0) {
7946				mtx_unlock(&lun->lun_lock);
7947				ctl_set_invalid_field(/*ctsio*/ ctsio,
7948						      /*sks_valid*/ 1,
7949						      /*command*/ 1,
7950						      /*field*/ 2,
7951						      /*bit_valid*/ 1,
7952						      /*bit*/ 0);
7953				ctl_done((union ctl_io *)ctsio);
7954				return (1);
7955			}
7956
7957			/*
7958			 * Do the following:
7959			 * if sa_res_key != res_key remove all
7960			 * registrants w/sa_res_key and generate UA
7961			 * for these registrants(Registrations
7962			 * Preempted) if it wasn't an exclusive
7963			 * reservation generate UA(Reservations
7964			 * Preempted) for all other registered nexuses
7965			 * if the type has changed. Establish the new
7966			 * reservation and holder. If res_key and
7967			 * sa_res_key are the same do the above
7968			 * except don't unregister the res holder.
7969			 */
7970
7971			for(i = 0; i < CTL_MAX_INITIATORS; i++) {
7972				if (i == residx || ctl_get_prkey(lun, i) == 0)
7973					continue;
7974
7975				if (sa_res_key == ctl_get_prkey(lun, i)) {
7976					ctl_clr_prkey(lun, i);
7977					lun->pr_key_count--;
7978					ctl_est_ua(lun, i, CTL_UA_REG_PREEMPT);
7979				} else if (type != lun->pr_res_type &&
7980				    (lun->pr_res_type == SPR_TYPE_WR_EX_RO ||
7981				     lun->pr_res_type == SPR_TYPE_EX_AC_RO)) {
7982					ctl_est_ua(lun, i, CTL_UA_RES_RELEASE);
7983				}
7984			}
7985			lun->pr_res_type = type;
7986			if (lun->pr_res_type != SPR_TYPE_WR_EX_AR &&
7987			    lun->pr_res_type != SPR_TYPE_EX_AC_AR)
7988				lun->pr_res_idx = residx;
7989			else
7990				lun->pr_res_idx = CTL_PR_ALL_REGISTRANTS;
7991			lun->pr_generation++;
7992			mtx_unlock(&lun->lun_lock);
7993
7994			persis_io.hdr.nexus = ctsio->io_hdr.nexus;
7995			persis_io.hdr.msg_type = CTL_MSG_PERS_ACTION;
7996			persis_io.pr.pr_info.action = CTL_PR_PREEMPT;
7997			persis_io.pr.pr_info.residx = lun->pr_res_idx;
7998			persis_io.pr.pr_info.res_type = type;
7999			memcpy(persis_io.pr.pr_info.sa_res_key,
8000			       param->serv_act_res_key,
8001			       sizeof(param->serv_act_res_key));
8002			ctl_ha_msg_send(CTL_HA_CHAN_CTL, &persis_io,
8003			    sizeof(persis_io.pr), M_WAITOK);
8004		} else {
8005			/*
8006			 * sa_res_key is not the res holder just
8007			 * remove registrants
8008			 */
8009			int found=0;
8010
8011			for (i = 0; i < CTL_MAX_INITIATORS; i++) {
8012				if (sa_res_key != ctl_get_prkey(lun, i))
8013					continue;
8014
8015				found = 1;
8016				ctl_clr_prkey(lun, i);
8017				lun->pr_key_count--;
8018				ctl_est_ua(lun, i, CTL_UA_REG_PREEMPT);
8019			}
8020
8021			if (!found) {
8022				mtx_unlock(&lun->lun_lock);
8023				free(ctsio->kern_data_ptr, M_CTL);
8024				ctl_set_reservation_conflict(ctsio);
8025				ctl_done((union ctl_io *)ctsio);
8026		        	return (1);
8027			}
8028			lun->pr_generation++;
8029			mtx_unlock(&lun->lun_lock);
8030
8031			persis_io.hdr.nexus = ctsio->io_hdr.nexus;
8032			persis_io.hdr.msg_type = CTL_MSG_PERS_ACTION;
8033			persis_io.pr.pr_info.action = CTL_PR_PREEMPT;
8034			persis_io.pr.pr_info.residx = lun->pr_res_idx;
8035			persis_io.pr.pr_info.res_type = type;
8036			memcpy(persis_io.pr.pr_info.sa_res_key,
8037			       param->serv_act_res_key,
8038			       sizeof(param->serv_act_res_key));
8039			ctl_ha_msg_send(CTL_HA_CHAN_CTL, &persis_io,
8040			    sizeof(persis_io.pr), M_WAITOK);
8041		}
8042	}
8043	return (0);
8044}
8045
8046static void
8047ctl_pro_preempt_other(struct ctl_lun *lun, union ctl_ha_msg *msg)
8048{
8049	uint64_t sa_res_key;
8050	int i;
8051
8052	sa_res_key = scsi_8btou64(msg->pr.pr_info.sa_res_key);
8053
8054	if (lun->pr_res_idx == CTL_PR_ALL_REGISTRANTS
8055	 || lun->pr_res_idx == CTL_PR_NO_RESERVATION
8056	 || sa_res_key != ctl_get_prkey(lun, lun->pr_res_idx)) {
8057		if (sa_res_key == 0) {
8058			/*
8059			 * Unregister everybody else and build UA for
8060			 * them
8061			 */
8062			for(i = 0; i < CTL_MAX_INITIATORS; i++) {
8063				if (i == msg->pr.pr_info.residx ||
8064				    ctl_get_prkey(lun, i) == 0)
8065					continue;
8066
8067				ctl_clr_prkey(lun, i);
8068				ctl_est_ua(lun, i, CTL_UA_REG_PREEMPT);
8069			}
8070
8071			lun->pr_key_count = 1;
8072			lun->pr_res_type = msg->pr.pr_info.res_type;
8073			if (lun->pr_res_type != SPR_TYPE_WR_EX_AR &&
8074			    lun->pr_res_type != SPR_TYPE_EX_AC_AR)
8075				lun->pr_res_idx = msg->pr.pr_info.residx;
8076		} else {
8077		        for (i = 0; i < CTL_MAX_INITIATORS; i++) {
8078				if (sa_res_key == ctl_get_prkey(lun, i))
8079					continue;
8080
8081				ctl_clr_prkey(lun, i);
8082				lun->pr_key_count--;
8083				ctl_est_ua(lun, i, CTL_UA_REG_PREEMPT);
8084			}
8085		}
8086	} else {
8087		for (i = 0; i < CTL_MAX_INITIATORS; i++) {
8088			if (i == msg->pr.pr_info.residx ||
8089			    ctl_get_prkey(lun, i) == 0)
8090				continue;
8091
8092			if (sa_res_key == ctl_get_prkey(lun, i)) {
8093				ctl_clr_prkey(lun, i);
8094				lun->pr_key_count--;
8095				ctl_est_ua(lun, i, CTL_UA_REG_PREEMPT);
8096			} else if (msg->pr.pr_info.res_type != lun->pr_res_type
8097			    && (lun->pr_res_type == SPR_TYPE_WR_EX_RO ||
8098			     lun->pr_res_type == SPR_TYPE_EX_AC_RO)) {
8099				ctl_est_ua(lun, i, CTL_UA_RES_RELEASE);
8100			}
8101		}
8102		lun->pr_res_type = msg->pr.pr_info.res_type;
8103		if (lun->pr_res_type != SPR_TYPE_WR_EX_AR &&
8104		    lun->pr_res_type != SPR_TYPE_EX_AC_AR)
8105			lun->pr_res_idx = msg->pr.pr_info.residx;
8106		else
8107			lun->pr_res_idx = CTL_PR_ALL_REGISTRANTS;
8108	}
8109	lun->pr_generation++;
8110
8111}
8112
8113
8114int
8115ctl_persistent_reserve_out(struct ctl_scsiio *ctsio)
8116{
8117	int retval;
8118	u_int32_t param_len;
8119	struct scsi_per_res_out *cdb;
8120	struct ctl_lun *lun;
8121	struct scsi_per_res_out_parms* param;
8122	struct ctl_softc *softc;
8123	uint32_t residx;
8124	uint64_t res_key, sa_res_key, key;
8125	uint8_t type;
8126	union ctl_ha_msg persis_io;
8127	int    i;
8128
8129	CTL_DEBUG_PRINT(("ctl_persistent_reserve_out\n"));
8130
8131	retval = CTL_RETVAL_COMPLETE;
8132
8133	cdb = (struct scsi_per_res_out *)ctsio->cdb;
8134	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
8135	softc = lun->ctl_softc;
8136
8137	/*
8138	 * We only support whole-LUN scope.  The scope & type are ignored for
8139	 * register, register and ignore existing key and clear.
8140	 * We sometimes ignore scope and type on preempts too!!
8141	 * Verify reservation type here as well.
8142	 */
8143	type = cdb->scope_type & SPR_TYPE_MASK;
8144	if ((cdb->action == SPRO_RESERVE)
8145	 || (cdb->action == SPRO_RELEASE)) {
8146		if ((cdb->scope_type & SPR_SCOPE_MASK) != SPR_LU_SCOPE) {
8147			ctl_set_invalid_field(/*ctsio*/ ctsio,
8148					      /*sks_valid*/ 1,
8149					      /*command*/ 1,
8150					      /*field*/ 2,
8151					      /*bit_valid*/ 1,
8152					      /*bit*/ 4);
8153			ctl_done((union ctl_io *)ctsio);
8154			return (CTL_RETVAL_COMPLETE);
8155		}
8156
8157		if (type>8 || type==2 || type==4 || type==0) {
8158			ctl_set_invalid_field(/*ctsio*/ ctsio,
8159					      /*sks_valid*/ 1,
8160					      /*command*/ 1,
8161					      /*field*/ 2,
8162					      /*bit_valid*/ 1,
8163					      /*bit*/ 0);
8164			ctl_done((union ctl_io *)ctsio);
8165			return (CTL_RETVAL_COMPLETE);
8166		}
8167	}
8168
8169	param_len = scsi_4btoul(cdb->length);
8170
8171	if ((ctsio->io_hdr.flags & CTL_FLAG_ALLOCATED) == 0) {
8172		ctsio->kern_data_ptr = malloc(param_len, M_CTL, M_WAITOK);
8173		ctsio->kern_data_len = param_len;
8174		ctsio->kern_total_len = param_len;
8175		ctsio->kern_data_resid = 0;
8176		ctsio->kern_rel_offset = 0;
8177		ctsio->kern_sg_entries = 0;
8178		ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
8179		ctsio->be_move_done = ctl_config_move_done;
8180		ctl_datamove((union ctl_io *)ctsio);
8181
8182		return (CTL_RETVAL_COMPLETE);
8183	}
8184
8185	param = (struct scsi_per_res_out_parms *)ctsio->kern_data_ptr;
8186
8187	residx = ctl_get_initindex(&ctsio->io_hdr.nexus);
8188	res_key = scsi_8btou64(param->res_key.key);
8189	sa_res_key = scsi_8btou64(param->serv_act_res_key);
8190
8191	/*
8192	 * Validate the reservation key here except for SPRO_REG_IGNO
8193	 * This must be done for all other service actions
8194	 */
8195	if ((cdb->action & SPRO_ACTION_MASK) != SPRO_REG_IGNO) {
8196		mtx_lock(&lun->lun_lock);
8197		if ((key = ctl_get_prkey(lun, residx)) != 0) {
8198			if (res_key != key) {
8199				/*
8200				 * The current key passed in doesn't match
8201				 * the one the initiator previously
8202				 * registered.
8203				 */
8204				mtx_unlock(&lun->lun_lock);
8205				free(ctsio->kern_data_ptr, M_CTL);
8206				ctl_set_reservation_conflict(ctsio);
8207				ctl_done((union ctl_io *)ctsio);
8208				return (CTL_RETVAL_COMPLETE);
8209			}
8210		} else if ((cdb->action & SPRO_ACTION_MASK) != SPRO_REGISTER) {
8211			/*
8212			 * We are not registered
8213			 */
8214			mtx_unlock(&lun->lun_lock);
8215			free(ctsio->kern_data_ptr, M_CTL);
8216			ctl_set_reservation_conflict(ctsio);
8217			ctl_done((union ctl_io *)ctsio);
8218			return (CTL_RETVAL_COMPLETE);
8219		} else if (res_key != 0) {
8220			/*
8221			 * We are not registered and trying to register but
8222			 * the register key isn't zero.
8223			 */
8224			mtx_unlock(&lun->lun_lock);
8225			free(ctsio->kern_data_ptr, M_CTL);
8226			ctl_set_reservation_conflict(ctsio);
8227			ctl_done((union ctl_io *)ctsio);
8228			return (CTL_RETVAL_COMPLETE);
8229		}
8230		mtx_unlock(&lun->lun_lock);
8231	}
8232
8233	switch (cdb->action & SPRO_ACTION_MASK) {
8234	case SPRO_REGISTER:
8235	case SPRO_REG_IGNO: {
8236
8237#if 0
8238		printf("Registration received\n");
8239#endif
8240
8241		/*
8242		 * We don't support any of these options, as we report in
8243		 * the read capabilities request (see
8244		 * ctl_persistent_reserve_in(), above).
8245		 */
8246		if ((param->flags & SPR_SPEC_I_PT)
8247		 || (param->flags & SPR_ALL_TG_PT)
8248		 || (param->flags & SPR_APTPL)) {
8249			int bit_ptr;
8250
8251			if (param->flags & SPR_APTPL)
8252				bit_ptr = 0;
8253			else if (param->flags & SPR_ALL_TG_PT)
8254				bit_ptr = 2;
8255			else /* SPR_SPEC_I_PT */
8256				bit_ptr = 3;
8257
8258			free(ctsio->kern_data_ptr, M_CTL);
8259			ctl_set_invalid_field(ctsio,
8260					      /*sks_valid*/ 1,
8261					      /*command*/ 0,
8262					      /*field*/ 20,
8263					      /*bit_valid*/ 1,
8264					      /*bit*/ bit_ptr);
8265			ctl_done((union ctl_io *)ctsio);
8266			return (CTL_RETVAL_COMPLETE);
8267		}
8268
8269		mtx_lock(&lun->lun_lock);
8270
8271		/*
8272		 * The initiator wants to clear the
8273		 * key/unregister.
8274		 */
8275		if (sa_res_key == 0) {
8276			if ((res_key == 0
8277			  && (cdb->action & SPRO_ACTION_MASK) == SPRO_REGISTER)
8278			 || ((cdb->action & SPRO_ACTION_MASK) == SPRO_REG_IGNO
8279			  && ctl_get_prkey(lun, residx) == 0)) {
8280				mtx_unlock(&lun->lun_lock);
8281				goto done;
8282			}
8283
8284			ctl_clr_prkey(lun, residx);
8285			lun->pr_key_count--;
8286
8287			if (residx == lun->pr_res_idx) {
8288				lun->flags &= ~CTL_LUN_PR_RESERVED;
8289				lun->pr_res_idx = CTL_PR_NO_RESERVATION;
8290
8291				if ((lun->pr_res_type == SPR_TYPE_WR_EX_RO ||
8292				     lun->pr_res_type == SPR_TYPE_EX_AC_RO) &&
8293				    lun->pr_key_count) {
8294					/*
8295					 * If the reservation is a registrants
8296					 * only type we need to generate a UA
8297					 * for other registered inits.  The
8298					 * sense code should be RESERVATIONS
8299					 * RELEASED
8300					 */
8301
8302					for (i = softc->init_min; i < softc->init_max; i++){
8303						if (ctl_get_prkey(lun, i) == 0)
8304							continue;
8305						ctl_est_ua(lun, i,
8306						    CTL_UA_RES_RELEASE);
8307					}
8308				}
8309				lun->pr_res_type = 0;
8310			} else if (lun->pr_res_idx == CTL_PR_ALL_REGISTRANTS) {
8311				if (lun->pr_key_count==0) {
8312					lun->flags &= ~CTL_LUN_PR_RESERVED;
8313					lun->pr_res_type = 0;
8314					lun->pr_res_idx = CTL_PR_NO_RESERVATION;
8315				}
8316			}
8317			lun->pr_generation++;
8318			mtx_unlock(&lun->lun_lock);
8319
8320			persis_io.hdr.nexus = ctsio->io_hdr.nexus;
8321			persis_io.hdr.msg_type = CTL_MSG_PERS_ACTION;
8322			persis_io.pr.pr_info.action = CTL_PR_UNREG_KEY;
8323			persis_io.pr.pr_info.residx = residx;
8324			ctl_ha_msg_send(CTL_HA_CHAN_CTL, &persis_io,
8325			    sizeof(persis_io.pr), M_WAITOK);
8326		} else /* sa_res_key != 0 */ {
8327
8328			/*
8329			 * If we aren't registered currently then increment
8330			 * the key count and set the registered flag.
8331			 */
8332			ctl_alloc_prkey(lun, residx);
8333			if (ctl_get_prkey(lun, residx) == 0)
8334				lun->pr_key_count++;
8335			ctl_set_prkey(lun, residx, sa_res_key);
8336			lun->pr_generation++;
8337			mtx_unlock(&lun->lun_lock);
8338
8339			persis_io.hdr.nexus = ctsio->io_hdr.nexus;
8340			persis_io.hdr.msg_type = CTL_MSG_PERS_ACTION;
8341			persis_io.pr.pr_info.action = CTL_PR_REG_KEY;
8342			persis_io.pr.pr_info.residx = residx;
8343			memcpy(persis_io.pr.pr_info.sa_res_key,
8344			       param->serv_act_res_key,
8345			       sizeof(param->serv_act_res_key));
8346			ctl_ha_msg_send(CTL_HA_CHAN_CTL, &persis_io,
8347			    sizeof(persis_io.pr), M_WAITOK);
8348		}
8349
8350		break;
8351	}
8352	case SPRO_RESERVE:
8353#if 0
8354                printf("Reserve executed type %d\n", type);
8355#endif
8356		mtx_lock(&lun->lun_lock);
8357		if (lun->flags & CTL_LUN_PR_RESERVED) {
8358			/*
8359			 * if this isn't the reservation holder and it's
8360			 * not a "all registrants" type or if the type is
8361			 * different then we have a conflict
8362			 */
8363			if ((lun->pr_res_idx != residx
8364			  && lun->pr_res_idx != CTL_PR_ALL_REGISTRANTS)
8365			 || lun->pr_res_type != type) {
8366				mtx_unlock(&lun->lun_lock);
8367				free(ctsio->kern_data_ptr, M_CTL);
8368				ctl_set_reservation_conflict(ctsio);
8369				ctl_done((union ctl_io *)ctsio);
8370				return (CTL_RETVAL_COMPLETE);
8371			}
8372			mtx_unlock(&lun->lun_lock);
8373		} else /* create a reservation */ {
8374			/*
8375			 * If it's not an "all registrants" type record
8376			 * reservation holder
8377			 */
8378			if (type != SPR_TYPE_WR_EX_AR
8379			 && type != SPR_TYPE_EX_AC_AR)
8380				lun->pr_res_idx = residx; /* Res holder */
8381			else
8382				lun->pr_res_idx = CTL_PR_ALL_REGISTRANTS;
8383
8384			lun->flags |= CTL_LUN_PR_RESERVED;
8385			lun->pr_res_type = type;
8386
8387			mtx_unlock(&lun->lun_lock);
8388
8389			/* send msg to other side */
8390			persis_io.hdr.nexus = ctsio->io_hdr.nexus;
8391			persis_io.hdr.msg_type = CTL_MSG_PERS_ACTION;
8392			persis_io.pr.pr_info.action = CTL_PR_RESERVE;
8393			persis_io.pr.pr_info.residx = lun->pr_res_idx;
8394			persis_io.pr.pr_info.res_type = type;
8395			ctl_ha_msg_send(CTL_HA_CHAN_CTL, &persis_io,
8396			    sizeof(persis_io.pr), M_WAITOK);
8397		}
8398		break;
8399
8400	case SPRO_RELEASE:
8401		mtx_lock(&lun->lun_lock);
8402		if ((lun->flags & CTL_LUN_PR_RESERVED) == 0) {
8403			/* No reservation exists return good status */
8404			mtx_unlock(&lun->lun_lock);
8405			goto done;
8406		}
8407		/*
8408		 * Is this nexus a reservation holder?
8409		 */
8410		if (lun->pr_res_idx != residx
8411		 && lun->pr_res_idx != CTL_PR_ALL_REGISTRANTS) {
8412			/*
8413			 * not a res holder return good status but
8414			 * do nothing
8415			 */
8416			mtx_unlock(&lun->lun_lock);
8417			goto done;
8418		}
8419
8420		if (lun->pr_res_type != type) {
8421			mtx_unlock(&lun->lun_lock);
8422			free(ctsio->kern_data_ptr, M_CTL);
8423			ctl_set_illegal_pr_release(ctsio);
8424			ctl_done((union ctl_io *)ctsio);
8425			return (CTL_RETVAL_COMPLETE);
8426		}
8427
8428		/* okay to release */
8429		lun->flags &= ~CTL_LUN_PR_RESERVED;
8430		lun->pr_res_idx = CTL_PR_NO_RESERVATION;
8431		lun->pr_res_type = 0;
8432
8433		/*
8434		 * If this isn't an exclusive access reservation and NUAR
8435		 * is not set, generate UA for all other registrants.
8436		 */
8437		if (type != SPR_TYPE_EX_AC && type != SPR_TYPE_WR_EX &&
8438		    (lun->MODE_CTRL.queue_flags & SCP_NUAR) == 0) {
8439			for (i = softc->init_min; i < softc->init_max; i++) {
8440				if (i == residx || ctl_get_prkey(lun, i) == 0)
8441					continue;
8442				ctl_est_ua(lun, i, CTL_UA_RES_RELEASE);
8443			}
8444		}
8445		mtx_unlock(&lun->lun_lock);
8446
8447		/* Send msg to other side */
8448		persis_io.hdr.nexus = ctsio->io_hdr.nexus;
8449		persis_io.hdr.msg_type = CTL_MSG_PERS_ACTION;
8450		persis_io.pr.pr_info.action = CTL_PR_RELEASE;
8451		ctl_ha_msg_send(CTL_HA_CHAN_CTL, &persis_io,
8452		     sizeof(persis_io.pr), M_WAITOK);
8453		break;
8454
8455	case SPRO_CLEAR:
8456		/* send msg to other side */
8457
8458		mtx_lock(&lun->lun_lock);
8459		lun->flags &= ~CTL_LUN_PR_RESERVED;
8460		lun->pr_res_type = 0;
8461		lun->pr_key_count = 0;
8462		lun->pr_res_idx = CTL_PR_NO_RESERVATION;
8463
8464		ctl_clr_prkey(lun, residx);
8465		for (i = 0; i < CTL_MAX_INITIATORS; i++)
8466			if (ctl_get_prkey(lun, i) != 0) {
8467				ctl_clr_prkey(lun, i);
8468				ctl_est_ua(lun, i, CTL_UA_REG_PREEMPT);
8469			}
8470		lun->pr_generation++;
8471		mtx_unlock(&lun->lun_lock);
8472
8473		persis_io.hdr.nexus = ctsio->io_hdr.nexus;
8474		persis_io.hdr.msg_type = CTL_MSG_PERS_ACTION;
8475		persis_io.pr.pr_info.action = CTL_PR_CLEAR;
8476		ctl_ha_msg_send(CTL_HA_CHAN_CTL, &persis_io,
8477		     sizeof(persis_io.pr), M_WAITOK);
8478		break;
8479
8480	case SPRO_PREEMPT:
8481	case SPRO_PRE_ABO: {
8482		int nretval;
8483
8484		nretval = ctl_pro_preempt(softc, lun, res_key, sa_res_key, type,
8485					  residx, ctsio, cdb, param);
8486		if (nretval != 0)
8487			return (CTL_RETVAL_COMPLETE);
8488		break;
8489	}
8490	default:
8491		panic("%s: Invalid PR type %#x", __func__, cdb->action);
8492	}
8493
8494done:
8495	free(ctsio->kern_data_ptr, M_CTL);
8496	ctl_set_success(ctsio);
8497	ctl_done((union ctl_io *)ctsio);
8498
8499	return (retval);
8500}
8501
8502/*
8503 * This routine is for handling a message from the other SC pertaining to
8504 * persistent reserve out. All the error checking will have been done
8505 * so only perorming the action need be done here to keep the two
8506 * in sync.
8507 */
8508static void
8509ctl_hndl_per_res_out_on_other_sc(union ctl_ha_msg *msg)
8510{
8511	struct ctl_softc *softc = control_softc;
8512	struct ctl_lun *lun;
8513	int i;
8514	uint32_t residx, targ_lun;
8515
8516	targ_lun = msg->hdr.nexus.targ_mapped_lun;
8517	mtx_lock(&softc->ctl_lock);
8518	if ((targ_lun >= CTL_MAX_LUNS) ||
8519	    ((lun = softc->ctl_luns[targ_lun]) == NULL)) {
8520		mtx_unlock(&softc->ctl_lock);
8521		return;
8522	}
8523	mtx_lock(&lun->lun_lock);
8524	mtx_unlock(&softc->ctl_lock);
8525	if (lun->flags & CTL_LUN_DISABLED) {
8526		mtx_unlock(&lun->lun_lock);
8527		return;
8528	}
8529	residx = ctl_get_initindex(&msg->hdr.nexus);
8530	switch(msg->pr.pr_info.action) {
8531	case CTL_PR_REG_KEY:
8532		ctl_alloc_prkey(lun, msg->pr.pr_info.residx);
8533		if (ctl_get_prkey(lun, msg->pr.pr_info.residx) == 0)
8534			lun->pr_key_count++;
8535		ctl_set_prkey(lun, msg->pr.pr_info.residx,
8536		    scsi_8btou64(msg->pr.pr_info.sa_res_key));
8537		lun->pr_generation++;
8538		break;
8539
8540	case CTL_PR_UNREG_KEY:
8541		ctl_clr_prkey(lun, msg->pr.pr_info.residx);
8542		lun->pr_key_count--;
8543
8544		/* XXX Need to see if the reservation has been released */
8545		/* if so do we need to generate UA? */
8546		if (msg->pr.pr_info.residx == lun->pr_res_idx) {
8547			lun->flags &= ~CTL_LUN_PR_RESERVED;
8548			lun->pr_res_idx = CTL_PR_NO_RESERVATION;
8549
8550			if ((lun->pr_res_type == SPR_TYPE_WR_EX_RO ||
8551			     lun->pr_res_type == SPR_TYPE_EX_AC_RO) &&
8552			    lun->pr_key_count) {
8553				/*
8554				 * If the reservation is a registrants
8555				 * only type we need to generate a UA
8556				 * for other registered inits.  The
8557				 * sense code should be RESERVATIONS
8558				 * RELEASED
8559				 */
8560
8561				for (i = softc->init_min; i < softc->init_max; i++) {
8562					if (ctl_get_prkey(lun, i) == 0)
8563						continue;
8564
8565					ctl_est_ua(lun, i, CTL_UA_RES_RELEASE);
8566				}
8567			}
8568			lun->pr_res_type = 0;
8569		} else if (lun->pr_res_idx == CTL_PR_ALL_REGISTRANTS) {
8570			if (lun->pr_key_count==0) {
8571				lun->flags &= ~CTL_LUN_PR_RESERVED;
8572				lun->pr_res_type = 0;
8573				lun->pr_res_idx = CTL_PR_NO_RESERVATION;
8574			}
8575		}
8576		lun->pr_generation++;
8577		break;
8578
8579	case CTL_PR_RESERVE:
8580		lun->flags |= CTL_LUN_PR_RESERVED;
8581		lun->pr_res_type = msg->pr.pr_info.res_type;
8582		lun->pr_res_idx = msg->pr.pr_info.residx;
8583
8584		break;
8585
8586	case CTL_PR_RELEASE:
8587		/*
8588		 * If this isn't an exclusive access reservation and NUAR
8589		 * is not set, generate UA for all other registrants.
8590		 */
8591		if (lun->pr_res_type != SPR_TYPE_EX_AC &&
8592		    lun->pr_res_type != SPR_TYPE_WR_EX &&
8593		    (lun->MODE_CTRL.queue_flags & SCP_NUAR) == 0) {
8594			for (i = softc->init_min; i < softc->init_max; i++)
8595				if (i == residx || ctl_get_prkey(lun, i) == 0)
8596					continue;
8597				ctl_est_ua(lun, i, CTL_UA_RES_RELEASE);
8598		}
8599
8600		lun->flags &= ~CTL_LUN_PR_RESERVED;
8601		lun->pr_res_idx = CTL_PR_NO_RESERVATION;
8602		lun->pr_res_type = 0;
8603		break;
8604
8605	case CTL_PR_PREEMPT:
8606		ctl_pro_preempt_other(lun, msg);
8607		break;
8608	case CTL_PR_CLEAR:
8609		lun->flags &= ~CTL_LUN_PR_RESERVED;
8610		lun->pr_res_type = 0;
8611		lun->pr_key_count = 0;
8612		lun->pr_res_idx = CTL_PR_NO_RESERVATION;
8613
8614		for (i=0; i < CTL_MAX_INITIATORS; i++) {
8615			if (ctl_get_prkey(lun, i) == 0)
8616				continue;
8617			ctl_clr_prkey(lun, i);
8618			ctl_est_ua(lun, i, CTL_UA_REG_PREEMPT);
8619		}
8620		lun->pr_generation++;
8621		break;
8622	}
8623
8624	mtx_unlock(&lun->lun_lock);
8625}
8626
8627int
8628ctl_read_write(struct ctl_scsiio *ctsio)
8629{
8630	struct ctl_lun *lun;
8631	struct ctl_lba_len_flags *lbalen;
8632	uint64_t lba;
8633	uint32_t num_blocks;
8634	int flags, retval;
8635	int isread;
8636
8637	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
8638
8639	CTL_DEBUG_PRINT(("ctl_read_write: command: %#x\n", ctsio->cdb[0]));
8640
8641	flags = 0;
8642	isread = ctsio->cdb[0] == READ_6  || ctsio->cdb[0] == READ_10
8643	      || ctsio->cdb[0] == READ_12 || ctsio->cdb[0] == READ_16;
8644	switch (ctsio->cdb[0]) {
8645	case READ_6:
8646	case WRITE_6: {
8647		struct scsi_rw_6 *cdb;
8648
8649		cdb = (struct scsi_rw_6 *)ctsio->cdb;
8650
8651		lba = scsi_3btoul(cdb->addr);
8652		/* only 5 bits are valid in the most significant address byte */
8653		lba &= 0x1fffff;
8654		num_blocks = cdb->length;
8655		/*
8656		 * This is correct according to SBC-2.
8657		 */
8658		if (num_blocks == 0)
8659			num_blocks = 256;
8660		break;
8661	}
8662	case READ_10:
8663	case WRITE_10: {
8664		struct scsi_rw_10 *cdb;
8665
8666		cdb = (struct scsi_rw_10 *)ctsio->cdb;
8667		if (cdb->byte2 & SRW10_FUA)
8668			flags |= CTL_LLF_FUA;
8669		if (cdb->byte2 & SRW10_DPO)
8670			flags |= CTL_LLF_DPO;
8671		lba = scsi_4btoul(cdb->addr);
8672		num_blocks = scsi_2btoul(cdb->length);
8673		break;
8674	}
8675	case WRITE_VERIFY_10: {
8676		struct scsi_write_verify_10 *cdb;
8677
8678		cdb = (struct scsi_write_verify_10 *)ctsio->cdb;
8679		flags |= CTL_LLF_FUA;
8680		if (cdb->byte2 & SWV_DPO)
8681			flags |= CTL_LLF_DPO;
8682		lba = scsi_4btoul(cdb->addr);
8683		num_blocks = scsi_2btoul(cdb->length);
8684		break;
8685	}
8686	case READ_12:
8687	case WRITE_12: {
8688		struct scsi_rw_12 *cdb;
8689
8690		cdb = (struct scsi_rw_12 *)ctsio->cdb;
8691		if (cdb->byte2 & SRW12_FUA)
8692			flags |= CTL_LLF_FUA;
8693		if (cdb->byte2 & SRW12_DPO)
8694			flags |= CTL_LLF_DPO;
8695		lba = scsi_4btoul(cdb->addr);
8696		num_blocks = scsi_4btoul(cdb->length);
8697		break;
8698	}
8699	case WRITE_VERIFY_12: {
8700		struct scsi_write_verify_12 *cdb;
8701
8702		cdb = (struct scsi_write_verify_12 *)ctsio->cdb;
8703		flags |= CTL_LLF_FUA;
8704		if (cdb->byte2 & SWV_DPO)
8705			flags |= CTL_LLF_DPO;
8706		lba = scsi_4btoul(cdb->addr);
8707		num_blocks = scsi_4btoul(cdb->length);
8708		break;
8709	}
8710	case READ_16:
8711	case WRITE_16: {
8712		struct scsi_rw_16 *cdb;
8713
8714		cdb = (struct scsi_rw_16 *)ctsio->cdb;
8715		if (cdb->byte2 & SRW12_FUA)
8716			flags |= CTL_LLF_FUA;
8717		if (cdb->byte2 & SRW12_DPO)
8718			flags |= CTL_LLF_DPO;
8719		lba = scsi_8btou64(cdb->addr);
8720		num_blocks = scsi_4btoul(cdb->length);
8721		break;
8722	}
8723	case WRITE_ATOMIC_16: {
8724		struct scsi_write_atomic_16 *cdb;
8725
8726		if (lun->be_lun->atomicblock == 0) {
8727			ctl_set_invalid_opcode(ctsio);
8728			ctl_done((union ctl_io *)ctsio);
8729			return (CTL_RETVAL_COMPLETE);
8730		}
8731
8732		cdb = (struct scsi_write_atomic_16 *)ctsio->cdb;
8733		if (cdb->byte2 & SRW12_FUA)
8734			flags |= CTL_LLF_FUA;
8735		if (cdb->byte2 & SRW12_DPO)
8736			flags |= CTL_LLF_DPO;
8737		lba = scsi_8btou64(cdb->addr);
8738		num_blocks = scsi_2btoul(cdb->length);
8739		if (num_blocks > lun->be_lun->atomicblock) {
8740			ctl_set_invalid_field(ctsio, /*sks_valid*/ 1,
8741			    /*command*/ 1, /*field*/ 12, /*bit_valid*/ 0,
8742			    /*bit*/ 0);
8743			ctl_done((union ctl_io *)ctsio);
8744			return (CTL_RETVAL_COMPLETE);
8745		}
8746		break;
8747	}
8748	case WRITE_VERIFY_16: {
8749		struct scsi_write_verify_16 *cdb;
8750
8751		cdb = (struct scsi_write_verify_16 *)ctsio->cdb;
8752		flags |= CTL_LLF_FUA;
8753		if (cdb->byte2 & SWV_DPO)
8754			flags |= CTL_LLF_DPO;
8755		lba = scsi_8btou64(cdb->addr);
8756		num_blocks = scsi_4btoul(cdb->length);
8757		break;
8758	}
8759	default:
8760		/*
8761		 * We got a command we don't support.  This shouldn't
8762		 * happen, commands should be filtered out above us.
8763		 */
8764		ctl_set_invalid_opcode(ctsio);
8765		ctl_done((union ctl_io *)ctsio);
8766
8767		return (CTL_RETVAL_COMPLETE);
8768		break; /* NOTREACHED */
8769	}
8770
8771	/*
8772	 * The first check is to make sure we're in bounds, the second
8773	 * check is to catch wrap-around problems.  If the lba + num blocks
8774	 * is less than the lba, then we've wrapped around and the block
8775	 * range is invalid anyway.
8776	 */
8777	if (((lba + num_blocks) > (lun->be_lun->maxlba + 1))
8778	 || ((lba + num_blocks) < lba)) {
8779		ctl_set_lba_out_of_range(ctsio);
8780		ctl_done((union ctl_io *)ctsio);
8781		return (CTL_RETVAL_COMPLETE);
8782	}
8783
8784	/*
8785	 * According to SBC-3, a transfer length of 0 is not an error.
8786	 * Note that this cannot happen with WRITE(6) or READ(6), since 0
8787	 * translates to 256 blocks for those commands.
8788	 */
8789	if (num_blocks == 0) {
8790		ctl_set_success(ctsio);
8791		ctl_done((union ctl_io *)ctsio);
8792		return (CTL_RETVAL_COMPLETE);
8793	}
8794
8795	/* Set FUA and/or DPO if caches are disabled. */
8796	if (isread) {
8797		if ((lun->MODE_CACHING.flags1 & SCP_RCD) != 0)
8798			flags |= CTL_LLF_FUA | CTL_LLF_DPO;
8799	} else {
8800		if ((lun->MODE_CACHING.flags1 & SCP_WCE) == 0)
8801			flags |= CTL_LLF_FUA;
8802	}
8803
8804	lbalen = (struct ctl_lba_len_flags *)
8805	    &ctsio->io_hdr.ctl_private[CTL_PRIV_LBA_LEN];
8806	lbalen->lba = lba;
8807	lbalen->len = num_blocks;
8808	lbalen->flags = (isread ? CTL_LLF_READ : CTL_LLF_WRITE) | flags;
8809
8810	ctsio->kern_total_len = num_blocks * lun->be_lun->blocksize;
8811	ctsio->kern_rel_offset = 0;
8812
8813	CTL_DEBUG_PRINT(("ctl_read_write: calling data_submit()\n"));
8814
8815	retval = lun->backend->data_submit((union ctl_io *)ctsio);
8816	return (retval);
8817}
8818
8819static int
8820ctl_cnw_cont(union ctl_io *io)
8821{
8822	struct ctl_scsiio *ctsio;
8823	struct ctl_lun *lun;
8824	struct ctl_lba_len_flags *lbalen;
8825	int retval;
8826
8827	ctsio = &io->scsiio;
8828	ctsio->io_hdr.status = CTL_STATUS_NONE;
8829	ctsio->io_hdr.flags &= ~CTL_FLAG_IO_CONT;
8830	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
8831	lbalen = (struct ctl_lba_len_flags *)
8832	    &ctsio->io_hdr.ctl_private[CTL_PRIV_LBA_LEN];
8833	lbalen->flags &= ~CTL_LLF_COMPARE;
8834	lbalen->flags |= CTL_LLF_WRITE;
8835
8836	CTL_DEBUG_PRINT(("ctl_cnw_cont: calling data_submit()\n"));
8837	retval = lun->backend->data_submit((union ctl_io *)ctsio);
8838	return (retval);
8839}
8840
8841int
8842ctl_cnw(struct ctl_scsiio *ctsio)
8843{
8844	struct ctl_lun *lun;
8845	struct ctl_lba_len_flags *lbalen;
8846	uint64_t lba;
8847	uint32_t num_blocks;
8848	int flags, retval;
8849
8850	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
8851
8852	CTL_DEBUG_PRINT(("ctl_cnw: command: %#x\n", ctsio->cdb[0]));
8853
8854	flags = 0;
8855	switch (ctsio->cdb[0]) {
8856	case COMPARE_AND_WRITE: {
8857		struct scsi_compare_and_write *cdb;
8858
8859		cdb = (struct scsi_compare_and_write *)ctsio->cdb;
8860		if (cdb->byte2 & SRW10_FUA)
8861			flags |= CTL_LLF_FUA;
8862		if (cdb->byte2 & SRW10_DPO)
8863			flags |= CTL_LLF_DPO;
8864		lba = scsi_8btou64(cdb->addr);
8865		num_blocks = cdb->length;
8866		break;
8867	}
8868	default:
8869		/*
8870		 * We got a command we don't support.  This shouldn't
8871		 * happen, commands should be filtered out above us.
8872		 */
8873		ctl_set_invalid_opcode(ctsio);
8874		ctl_done((union ctl_io *)ctsio);
8875
8876		return (CTL_RETVAL_COMPLETE);
8877		break; /* NOTREACHED */
8878	}
8879
8880	/*
8881	 * The first check is to make sure we're in bounds, the second
8882	 * check is to catch wrap-around problems.  If the lba + num blocks
8883	 * is less than the lba, then we've wrapped around and the block
8884	 * range is invalid anyway.
8885	 */
8886	if (((lba + num_blocks) > (lun->be_lun->maxlba + 1))
8887	 || ((lba + num_blocks) < lba)) {
8888		ctl_set_lba_out_of_range(ctsio);
8889		ctl_done((union ctl_io *)ctsio);
8890		return (CTL_RETVAL_COMPLETE);
8891	}
8892
8893	/*
8894	 * According to SBC-3, a transfer length of 0 is not an error.
8895	 */
8896	if (num_blocks == 0) {
8897		ctl_set_success(ctsio);
8898		ctl_done((union ctl_io *)ctsio);
8899		return (CTL_RETVAL_COMPLETE);
8900	}
8901
8902	/* Set FUA if write cache is disabled. */
8903	if ((lun->MODE_CACHING.flags1 & SCP_WCE) == 0)
8904		flags |= CTL_LLF_FUA;
8905
8906	ctsio->kern_total_len = 2 * num_blocks * lun->be_lun->blocksize;
8907	ctsio->kern_rel_offset = 0;
8908
8909	/*
8910	 * Set the IO_CONT flag, so that if this I/O gets passed to
8911	 * ctl_data_submit_done(), it'll get passed back to
8912	 * ctl_ctl_cnw_cont() for further processing.
8913	 */
8914	ctsio->io_hdr.flags |= CTL_FLAG_IO_CONT;
8915	ctsio->io_cont = ctl_cnw_cont;
8916
8917	lbalen = (struct ctl_lba_len_flags *)
8918	    &ctsio->io_hdr.ctl_private[CTL_PRIV_LBA_LEN];
8919	lbalen->lba = lba;
8920	lbalen->len = num_blocks;
8921	lbalen->flags = CTL_LLF_COMPARE | flags;
8922
8923	CTL_DEBUG_PRINT(("ctl_cnw: calling data_submit()\n"));
8924	retval = lun->backend->data_submit((union ctl_io *)ctsio);
8925	return (retval);
8926}
8927
8928int
8929ctl_verify(struct ctl_scsiio *ctsio)
8930{
8931	struct ctl_lun *lun;
8932	struct ctl_lba_len_flags *lbalen;
8933	uint64_t lba;
8934	uint32_t num_blocks;
8935	int bytchk, flags;
8936	int retval;
8937
8938	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
8939
8940	CTL_DEBUG_PRINT(("ctl_verify: command: %#x\n", ctsio->cdb[0]));
8941
8942	bytchk = 0;
8943	flags = CTL_LLF_FUA;
8944	switch (ctsio->cdb[0]) {
8945	case VERIFY_10: {
8946		struct scsi_verify_10 *cdb;
8947
8948		cdb = (struct scsi_verify_10 *)ctsio->cdb;
8949		if (cdb->byte2 & SVFY_BYTCHK)
8950			bytchk = 1;
8951		if (cdb->byte2 & SVFY_DPO)
8952			flags |= CTL_LLF_DPO;
8953		lba = scsi_4btoul(cdb->addr);
8954		num_blocks = scsi_2btoul(cdb->length);
8955		break;
8956	}
8957	case VERIFY_12: {
8958		struct scsi_verify_12 *cdb;
8959
8960		cdb = (struct scsi_verify_12 *)ctsio->cdb;
8961		if (cdb->byte2 & SVFY_BYTCHK)
8962			bytchk = 1;
8963		if (cdb->byte2 & SVFY_DPO)
8964			flags |= CTL_LLF_DPO;
8965		lba = scsi_4btoul(cdb->addr);
8966		num_blocks = scsi_4btoul(cdb->length);
8967		break;
8968	}
8969	case VERIFY_16: {
8970		struct scsi_rw_16 *cdb;
8971
8972		cdb = (struct scsi_rw_16 *)ctsio->cdb;
8973		if (cdb->byte2 & SVFY_BYTCHK)
8974			bytchk = 1;
8975		if (cdb->byte2 & SVFY_DPO)
8976			flags |= CTL_LLF_DPO;
8977		lba = scsi_8btou64(cdb->addr);
8978		num_blocks = scsi_4btoul(cdb->length);
8979		break;
8980	}
8981	default:
8982		/*
8983		 * We got a command we don't support.  This shouldn't
8984		 * happen, commands should be filtered out above us.
8985		 */
8986		ctl_set_invalid_opcode(ctsio);
8987		ctl_done((union ctl_io *)ctsio);
8988		return (CTL_RETVAL_COMPLETE);
8989	}
8990
8991	/*
8992	 * The first check is to make sure we're in bounds, the second
8993	 * check is to catch wrap-around problems.  If the lba + num blocks
8994	 * is less than the lba, then we've wrapped around and the block
8995	 * range is invalid anyway.
8996	 */
8997	if (((lba + num_blocks) > (lun->be_lun->maxlba + 1))
8998	 || ((lba + num_blocks) < lba)) {
8999		ctl_set_lba_out_of_range(ctsio);
9000		ctl_done((union ctl_io *)ctsio);
9001		return (CTL_RETVAL_COMPLETE);
9002	}
9003
9004	/*
9005	 * According to SBC-3, a transfer length of 0 is not an error.
9006	 */
9007	if (num_blocks == 0) {
9008		ctl_set_success(ctsio);
9009		ctl_done((union ctl_io *)ctsio);
9010		return (CTL_RETVAL_COMPLETE);
9011	}
9012
9013	lbalen = (struct ctl_lba_len_flags *)
9014	    &ctsio->io_hdr.ctl_private[CTL_PRIV_LBA_LEN];
9015	lbalen->lba = lba;
9016	lbalen->len = num_blocks;
9017	if (bytchk) {
9018		lbalen->flags = CTL_LLF_COMPARE | flags;
9019		ctsio->kern_total_len = num_blocks * lun->be_lun->blocksize;
9020	} else {
9021		lbalen->flags = CTL_LLF_VERIFY | flags;
9022		ctsio->kern_total_len = 0;
9023	}
9024	ctsio->kern_rel_offset = 0;
9025
9026	CTL_DEBUG_PRINT(("ctl_verify: calling data_submit()\n"));
9027	retval = lun->backend->data_submit((union ctl_io *)ctsio);
9028	return (retval);
9029}
9030
9031int
9032ctl_report_luns(struct ctl_scsiio *ctsio)
9033{
9034	struct ctl_softc *softc;
9035	struct scsi_report_luns *cdb;
9036	struct scsi_report_luns_data *lun_data;
9037	struct ctl_lun *lun, *request_lun;
9038	struct ctl_port *port;
9039	int num_luns, retval;
9040	uint32_t alloc_len, lun_datalen;
9041	int num_filled;
9042	uint32_t initidx, targ_lun_id, lun_id;
9043
9044	retval = CTL_RETVAL_COMPLETE;
9045	cdb = (struct scsi_report_luns *)ctsio->cdb;
9046	port = ctl_io_port(&ctsio->io_hdr);
9047	softc = port->ctl_softc;
9048
9049	CTL_DEBUG_PRINT(("ctl_report_luns\n"));
9050
9051	mtx_lock(&softc->ctl_lock);
9052	num_luns = 0;
9053	for (targ_lun_id = 0; targ_lun_id < CTL_MAX_LUNS; targ_lun_id++) {
9054		if (ctl_lun_map_from_port(port, targ_lun_id) < CTL_MAX_LUNS)
9055			num_luns++;
9056	}
9057	mtx_unlock(&softc->ctl_lock);
9058
9059	switch (cdb->select_report) {
9060	case RPL_REPORT_DEFAULT:
9061	case RPL_REPORT_ALL:
9062	case RPL_REPORT_NONSUBSID:
9063		break;
9064	case RPL_REPORT_WELLKNOWN:
9065	case RPL_REPORT_ADMIN:
9066	case RPL_REPORT_CONGLOM:
9067		num_luns = 0;
9068		break;
9069	default:
9070		ctl_set_invalid_field(ctsio,
9071				      /*sks_valid*/ 1,
9072				      /*command*/ 1,
9073				      /*field*/ 2,
9074				      /*bit_valid*/ 0,
9075				      /*bit*/ 0);
9076		ctl_done((union ctl_io *)ctsio);
9077		return (retval);
9078		break; /* NOTREACHED */
9079	}
9080
9081	alloc_len = scsi_4btoul(cdb->length);
9082	/*
9083	 * The initiator has to allocate at least 16 bytes for this request,
9084	 * so he can at least get the header and the first LUN.  Otherwise
9085	 * we reject the request (per SPC-3 rev 14, section 6.21).
9086	 */
9087	if (alloc_len < (sizeof(struct scsi_report_luns_data) +
9088	    sizeof(struct scsi_report_luns_lundata))) {
9089		ctl_set_invalid_field(ctsio,
9090				      /*sks_valid*/ 1,
9091				      /*command*/ 1,
9092				      /*field*/ 6,
9093				      /*bit_valid*/ 0,
9094				      /*bit*/ 0);
9095		ctl_done((union ctl_io *)ctsio);
9096		return (retval);
9097	}
9098
9099	request_lun = (struct ctl_lun *)
9100		ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
9101
9102	lun_datalen = sizeof(*lun_data) +
9103		(num_luns * sizeof(struct scsi_report_luns_lundata));
9104
9105	ctsio->kern_data_ptr = malloc(lun_datalen, M_CTL, M_WAITOK | M_ZERO);
9106	lun_data = (struct scsi_report_luns_data *)ctsio->kern_data_ptr;
9107	ctsio->kern_sg_entries = 0;
9108
9109	initidx = ctl_get_initindex(&ctsio->io_hdr.nexus);
9110
9111	mtx_lock(&softc->ctl_lock);
9112	for (targ_lun_id = 0, num_filled = 0; targ_lun_id < CTL_MAX_LUNS && num_filled < num_luns; targ_lun_id++) {
9113		lun_id = ctl_lun_map_from_port(port, targ_lun_id);
9114		if (lun_id >= CTL_MAX_LUNS)
9115			continue;
9116		lun = softc->ctl_luns[lun_id];
9117		if (lun == NULL)
9118			continue;
9119
9120		be64enc(lun_data->luns[num_filled++].lundata,
9121		    ctl_encode_lun(targ_lun_id));
9122
9123		/*
9124		 * According to SPC-3, rev 14 section 6.21:
9125		 *
9126		 * "The execution of a REPORT LUNS command to any valid and
9127		 * installed logical unit shall clear the REPORTED LUNS DATA
9128		 * HAS CHANGED unit attention condition for all logical
9129		 * units of that target with respect to the requesting
9130		 * initiator. A valid and installed logical unit is one
9131		 * having a PERIPHERAL QUALIFIER of 000b in the standard
9132		 * INQUIRY data (see 6.4.2)."
9133		 *
9134		 * If request_lun is NULL, the LUN this report luns command
9135		 * was issued to is either disabled or doesn't exist. In that
9136		 * case, we shouldn't clear any pending lun change unit
9137		 * attention.
9138		 */
9139		if (request_lun != NULL) {
9140			mtx_lock(&lun->lun_lock);
9141			ctl_clr_ua(lun, initidx, CTL_UA_LUN_CHANGE);
9142			mtx_unlock(&lun->lun_lock);
9143		}
9144	}
9145	mtx_unlock(&softc->ctl_lock);
9146
9147	/*
9148	 * It's quite possible that we've returned fewer LUNs than we allocated
9149	 * space for.  Trim it.
9150	 */
9151	lun_datalen = sizeof(*lun_data) +
9152		(num_filled * sizeof(struct scsi_report_luns_lundata));
9153
9154	if (lun_datalen < alloc_len) {
9155		ctsio->residual = alloc_len - lun_datalen;
9156		ctsio->kern_data_len = lun_datalen;
9157		ctsio->kern_total_len = lun_datalen;
9158	} else {
9159		ctsio->residual = 0;
9160		ctsio->kern_data_len = alloc_len;
9161		ctsio->kern_total_len = alloc_len;
9162	}
9163	ctsio->kern_data_resid = 0;
9164	ctsio->kern_rel_offset = 0;
9165	ctsio->kern_sg_entries = 0;
9166
9167	/*
9168	 * We set this to the actual data length, regardless of how much
9169	 * space we actually have to return results.  If the user looks at
9170	 * this value, he'll know whether or not he allocated enough space
9171	 * and reissue the command if necessary.  We don't support well
9172	 * known logical units, so if the user asks for that, return none.
9173	 */
9174	scsi_ulto4b(lun_datalen - 8, lun_data->length);
9175
9176	/*
9177	 * We can only return SCSI_STATUS_CHECK_COND when we can't satisfy
9178	 * this request.
9179	 */
9180	ctl_set_success(ctsio);
9181	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
9182	ctsio->be_move_done = ctl_config_move_done;
9183	ctl_datamove((union ctl_io *)ctsio);
9184	return (retval);
9185}
9186
9187int
9188ctl_request_sense(struct ctl_scsiio *ctsio)
9189{
9190	struct scsi_request_sense *cdb;
9191	struct scsi_sense_data *sense_ptr;
9192	struct ctl_softc *softc;
9193	struct ctl_lun *lun;
9194	uint32_t initidx;
9195	int have_error;
9196	scsi_sense_data_type sense_format;
9197	ctl_ua_type ua_type;
9198	uint8_t asc = 0, ascq = 0;
9199
9200	cdb = (struct scsi_request_sense *)ctsio->cdb;
9201
9202	softc = control_softc;
9203	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
9204
9205	CTL_DEBUG_PRINT(("ctl_request_sense\n"));
9206
9207	/*
9208	 * Determine which sense format the user wants.
9209	 */
9210	if (cdb->byte2 & SRS_DESC)
9211		sense_format = SSD_TYPE_DESC;
9212	else
9213		sense_format = SSD_TYPE_FIXED;
9214
9215	ctsio->kern_data_ptr = malloc(sizeof(*sense_ptr), M_CTL, M_WAITOK);
9216	sense_ptr = (struct scsi_sense_data *)ctsio->kern_data_ptr;
9217	ctsio->kern_sg_entries = 0;
9218
9219	/*
9220	 * struct scsi_sense_data, which is currently set to 256 bytes, is
9221	 * larger than the largest allowed value for the length field in the
9222	 * REQUEST SENSE CDB, which is 252 bytes as of SPC-4.
9223	 */
9224	ctsio->residual = 0;
9225	ctsio->kern_data_len = cdb->length;
9226	ctsio->kern_total_len = cdb->length;
9227
9228	ctsio->kern_data_resid = 0;
9229	ctsio->kern_rel_offset = 0;
9230	ctsio->kern_sg_entries = 0;
9231
9232	/*
9233	 * If we don't have a LUN, we don't have any pending sense.
9234	 */
9235	if (lun == NULL ||
9236	    ((lun->flags & CTL_LUN_PRIMARY_SC) == 0 &&
9237	     softc->ha_link < CTL_HA_LINK_UNKNOWN)) {
9238		/* "Logical unit not supported" */
9239		ctl_set_sense_data(sense_ptr, NULL, sense_format,
9240		    /*current_error*/ 1,
9241		    /*sense_key*/ SSD_KEY_ILLEGAL_REQUEST,
9242		    /*asc*/ 0x25,
9243		    /*ascq*/ 0x00,
9244		    SSD_ELEM_NONE);
9245		goto send;
9246	}
9247
9248	have_error = 0;
9249	initidx = ctl_get_initindex(&ctsio->io_hdr.nexus);
9250	/*
9251	 * Check for pending sense, and then for pending unit attentions.
9252	 * Pending sense gets returned first, then pending unit attentions.
9253	 */
9254	mtx_lock(&lun->lun_lock);
9255#ifdef CTL_WITH_CA
9256	if (ctl_is_set(lun->have_ca, initidx)) {
9257		scsi_sense_data_type stored_format;
9258
9259		/*
9260		 * Check to see which sense format was used for the stored
9261		 * sense data.
9262		 */
9263		stored_format = scsi_sense_type(&lun->pending_sense[initidx]);
9264
9265		/*
9266		 * If the user requested a different sense format than the
9267		 * one we stored, then we need to convert it to the other
9268		 * format.  If we're going from descriptor to fixed format
9269		 * sense data, we may lose things in translation, depending
9270		 * on what options were used.
9271		 *
9272		 * If the stored format is SSD_TYPE_NONE (i.e. invalid),
9273		 * for some reason we'll just copy it out as-is.
9274		 */
9275		if ((stored_format == SSD_TYPE_FIXED)
9276		 && (sense_format == SSD_TYPE_DESC))
9277			ctl_sense_to_desc((struct scsi_sense_data_fixed *)
9278			    &lun->pending_sense[initidx],
9279			    (struct scsi_sense_data_desc *)sense_ptr);
9280		else if ((stored_format == SSD_TYPE_DESC)
9281		      && (sense_format == SSD_TYPE_FIXED))
9282			ctl_sense_to_fixed((struct scsi_sense_data_desc *)
9283			    &lun->pending_sense[initidx],
9284			    (struct scsi_sense_data_fixed *)sense_ptr);
9285		else
9286			memcpy(sense_ptr, &lun->pending_sense[initidx],
9287			       MIN(sizeof(*sense_ptr),
9288			       sizeof(lun->pending_sense[initidx])));
9289
9290		ctl_clear_mask(lun->have_ca, initidx);
9291		have_error = 1;
9292	} else
9293#endif
9294	if (have_error == 0) {
9295		ua_type = ctl_build_ua(lun, initidx, sense_ptr, sense_format);
9296		if (ua_type != CTL_UA_NONE)
9297			have_error = 1;
9298		if (ua_type == CTL_UA_LUN_CHANGE) {
9299			mtx_unlock(&lun->lun_lock);
9300			mtx_lock(&softc->ctl_lock);
9301			ctl_clr_ua_allluns(softc, initidx, ua_type);
9302			mtx_unlock(&softc->ctl_lock);
9303			mtx_lock(&lun->lun_lock);
9304		}
9305	}
9306	if (have_error == 0) {
9307		/*
9308		 * Report informational exception if have one and allowed.
9309		 */
9310		if (lun->MODE_IE.mrie != SIEP_MRIE_NO) {
9311			asc = lun->ie_asc;
9312			ascq = lun->ie_ascq;
9313		}
9314		ctl_set_sense_data(sense_ptr, lun, sense_format,
9315		    /*current_error*/ 1,
9316		    /*sense_key*/ SSD_KEY_NO_SENSE,
9317		    /*asc*/ asc,
9318		    /*ascq*/ ascq,
9319		    SSD_ELEM_NONE);
9320	}
9321	mtx_unlock(&lun->lun_lock);
9322
9323send:
9324	/*
9325	 * We report the SCSI status as OK, since the status of the command
9326	 * itself is OK.  We're reporting sense as parameter data.
9327	 */
9328	ctl_set_success(ctsio);
9329	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
9330	ctsio->be_move_done = ctl_config_move_done;
9331	ctl_datamove((union ctl_io *)ctsio);
9332	return (CTL_RETVAL_COMPLETE);
9333}
9334
9335int
9336ctl_tur(struct ctl_scsiio *ctsio)
9337{
9338
9339	CTL_DEBUG_PRINT(("ctl_tur\n"));
9340
9341	ctl_set_success(ctsio);
9342	ctl_done((union ctl_io *)ctsio);
9343
9344	return (CTL_RETVAL_COMPLETE);
9345}
9346
9347/*
9348 * SCSI VPD page 0x00, the Supported VPD Pages page.
9349 */
9350static int
9351ctl_inquiry_evpd_supported(struct ctl_scsiio *ctsio, int alloc_len)
9352{
9353	struct scsi_vpd_supported_pages *pages;
9354	int sup_page_size;
9355	struct ctl_lun *lun;
9356	int p;
9357
9358	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
9359
9360	sup_page_size = sizeof(struct scsi_vpd_supported_pages) *
9361	    SCSI_EVPD_NUM_SUPPORTED_PAGES;
9362	ctsio->kern_data_ptr = malloc(sup_page_size, M_CTL, M_WAITOK | M_ZERO);
9363	pages = (struct scsi_vpd_supported_pages *)ctsio->kern_data_ptr;
9364	ctsio->kern_sg_entries = 0;
9365
9366	if (sup_page_size < alloc_len) {
9367		ctsio->residual = alloc_len - sup_page_size;
9368		ctsio->kern_data_len = sup_page_size;
9369		ctsio->kern_total_len = sup_page_size;
9370	} else {
9371		ctsio->residual = 0;
9372		ctsio->kern_data_len = alloc_len;
9373		ctsio->kern_total_len = alloc_len;
9374	}
9375	ctsio->kern_data_resid = 0;
9376	ctsio->kern_rel_offset = 0;
9377	ctsio->kern_sg_entries = 0;
9378
9379	/*
9380	 * The control device is always connected.  The disk device, on the
9381	 * other hand, may not be online all the time.  Need to change this
9382	 * to figure out whether the disk device is actually online or not.
9383	 */
9384	if (lun != NULL)
9385		pages->device = (SID_QUAL_LU_CONNECTED << 5) |
9386				lun->be_lun->lun_type;
9387	else
9388		pages->device = (SID_QUAL_LU_OFFLINE << 5) | T_DIRECT;
9389
9390	p = 0;
9391	/* Supported VPD pages */
9392	pages->page_list[p++] = SVPD_SUPPORTED_PAGES;
9393	/* Serial Number */
9394	pages->page_list[p++] = SVPD_UNIT_SERIAL_NUMBER;
9395	/* Device Identification */
9396	pages->page_list[p++] = SVPD_DEVICE_ID;
9397	/* Extended INQUIRY Data */
9398	pages->page_list[p++] = SVPD_EXTENDED_INQUIRY_DATA;
9399	/* Mode Page Policy */
9400	pages->page_list[p++] = SVPD_MODE_PAGE_POLICY;
9401	/* SCSI Ports */
9402	pages->page_list[p++] = SVPD_SCSI_PORTS;
9403	/* Third-party Copy */
9404	pages->page_list[p++] = SVPD_SCSI_TPC;
9405	if (lun != NULL && lun->be_lun->lun_type == T_DIRECT) {
9406		/* Block limits */
9407		pages->page_list[p++] = SVPD_BLOCK_LIMITS;
9408		/* Block Device Characteristics */
9409		pages->page_list[p++] = SVPD_BDC;
9410		/* Logical Block Provisioning */
9411		pages->page_list[p++] = SVPD_LBP;
9412	}
9413	pages->length = p;
9414
9415	ctl_set_success(ctsio);
9416	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
9417	ctsio->be_move_done = ctl_config_move_done;
9418	ctl_datamove((union ctl_io *)ctsio);
9419	return (CTL_RETVAL_COMPLETE);
9420}
9421
9422/*
9423 * SCSI VPD page 0x80, the Unit Serial Number page.
9424 */
9425static int
9426ctl_inquiry_evpd_serial(struct ctl_scsiio *ctsio, int alloc_len)
9427{
9428	struct scsi_vpd_unit_serial_number *sn_ptr;
9429	struct ctl_lun *lun;
9430	int data_len;
9431
9432	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
9433
9434	data_len = 4 + CTL_SN_LEN;
9435	ctsio->kern_data_ptr = malloc(data_len, M_CTL, M_WAITOK | M_ZERO);
9436	sn_ptr = (struct scsi_vpd_unit_serial_number *)ctsio->kern_data_ptr;
9437	if (data_len < alloc_len) {
9438		ctsio->residual = alloc_len - data_len;
9439		ctsio->kern_data_len = data_len;
9440		ctsio->kern_total_len = data_len;
9441	} else {
9442		ctsio->residual = 0;
9443		ctsio->kern_data_len = alloc_len;
9444		ctsio->kern_total_len = alloc_len;
9445	}
9446	ctsio->kern_data_resid = 0;
9447	ctsio->kern_rel_offset = 0;
9448	ctsio->kern_sg_entries = 0;
9449
9450	/*
9451	 * The control device is always connected.  The disk device, on the
9452	 * other hand, may not be online all the time.  Need to change this
9453	 * to figure out whether the disk device is actually online or not.
9454	 */
9455	if (lun != NULL)
9456		sn_ptr->device = (SID_QUAL_LU_CONNECTED << 5) |
9457				  lun->be_lun->lun_type;
9458	else
9459		sn_ptr->device = (SID_QUAL_LU_OFFLINE << 5) | T_DIRECT;
9460
9461	sn_ptr->page_code = SVPD_UNIT_SERIAL_NUMBER;
9462	sn_ptr->length = CTL_SN_LEN;
9463	/*
9464	 * If we don't have a LUN, we just leave the serial number as
9465	 * all spaces.
9466	 */
9467	if (lun != NULL) {
9468		strncpy((char *)sn_ptr->serial_num,
9469			(char *)lun->be_lun->serial_num, CTL_SN_LEN);
9470	} else
9471		memset(sn_ptr->serial_num, 0x20, CTL_SN_LEN);
9472
9473	ctl_set_success(ctsio);
9474	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
9475	ctsio->be_move_done = ctl_config_move_done;
9476	ctl_datamove((union ctl_io *)ctsio);
9477	return (CTL_RETVAL_COMPLETE);
9478}
9479
9480
9481/*
9482 * SCSI VPD page 0x86, the Extended INQUIRY Data page.
9483 */
9484static int
9485ctl_inquiry_evpd_eid(struct ctl_scsiio *ctsio, int alloc_len)
9486{
9487	struct scsi_vpd_extended_inquiry_data *eid_ptr;
9488	struct ctl_lun *lun;
9489	int data_len;
9490
9491	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
9492
9493	data_len = sizeof(struct scsi_vpd_extended_inquiry_data);
9494	ctsio->kern_data_ptr = malloc(data_len, M_CTL, M_WAITOK | M_ZERO);
9495	eid_ptr = (struct scsi_vpd_extended_inquiry_data *)ctsio->kern_data_ptr;
9496	ctsio->kern_sg_entries = 0;
9497
9498	if (data_len < alloc_len) {
9499		ctsio->residual = alloc_len - data_len;
9500		ctsio->kern_data_len = data_len;
9501		ctsio->kern_total_len = data_len;
9502	} else {
9503		ctsio->residual = 0;
9504		ctsio->kern_data_len = alloc_len;
9505		ctsio->kern_total_len = alloc_len;
9506	}
9507	ctsio->kern_data_resid = 0;
9508	ctsio->kern_rel_offset = 0;
9509	ctsio->kern_sg_entries = 0;
9510
9511	/*
9512	 * The control device is always connected.  The disk device, on the
9513	 * other hand, may not be online all the time.
9514	 */
9515	if (lun != NULL)
9516		eid_ptr->device = (SID_QUAL_LU_CONNECTED << 5) |
9517				     lun->be_lun->lun_type;
9518	else
9519		eid_ptr->device = (SID_QUAL_LU_OFFLINE << 5) | T_DIRECT;
9520	eid_ptr->page_code = SVPD_EXTENDED_INQUIRY_DATA;
9521	scsi_ulto2b(data_len - 4, eid_ptr->page_length);
9522	/*
9523	 * We support head of queue, ordered and simple tags.
9524	 */
9525	eid_ptr->flags2 = SVPD_EID_HEADSUP | SVPD_EID_ORDSUP | SVPD_EID_SIMPSUP;
9526	/*
9527	 * Volatile cache supported.
9528	 */
9529	eid_ptr->flags3 = SVPD_EID_V_SUP;
9530
9531	/*
9532	 * This means that we clear the REPORTED LUNS DATA HAS CHANGED unit
9533	 * attention for a particular IT nexus on all LUNs once we report
9534	 * it to that nexus once.  This bit is required as of SPC-4.
9535	 */
9536	eid_ptr->flags4 = SVPD_EID_LUICLT;
9537
9538	/*
9539	 * XXX KDM in order to correctly answer this, we would need
9540	 * information from the SIM to determine how much sense data it
9541	 * can send.  So this would really be a path inquiry field, most
9542	 * likely.  This can be set to a maximum of 252 according to SPC-4,
9543	 * but the hardware may or may not be able to support that much.
9544	 * 0 just means that the maximum sense data length is not reported.
9545	 */
9546	eid_ptr->max_sense_length = 0;
9547
9548	ctl_set_success(ctsio);
9549	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
9550	ctsio->be_move_done = ctl_config_move_done;
9551	ctl_datamove((union ctl_io *)ctsio);
9552	return (CTL_RETVAL_COMPLETE);
9553}
9554
9555static int
9556ctl_inquiry_evpd_mpp(struct ctl_scsiio *ctsio, int alloc_len)
9557{
9558	struct scsi_vpd_mode_page_policy *mpp_ptr;
9559	struct ctl_lun *lun;
9560	int data_len;
9561
9562	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
9563
9564	data_len = sizeof(struct scsi_vpd_mode_page_policy) +
9565	    sizeof(struct scsi_vpd_mode_page_policy_descr);
9566
9567	ctsio->kern_data_ptr = malloc(data_len, M_CTL, M_WAITOK | M_ZERO);
9568	mpp_ptr = (struct scsi_vpd_mode_page_policy *)ctsio->kern_data_ptr;
9569	ctsio->kern_sg_entries = 0;
9570
9571	if (data_len < alloc_len) {
9572		ctsio->residual = alloc_len - data_len;
9573		ctsio->kern_data_len = data_len;
9574		ctsio->kern_total_len = data_len;
9575	} else {
9576		ctsio->residual = 0;
9577		ctsio->kern_data_len = alloc_len;
9578		ctsio->kern_total_len = alloc_len;
9579	}
9580	ctsio->kern_data_resid = 0;
9581	ctsio->kern_rel_offset = 0;
9582	ctsio->kern_sg_entries = 0;
9583
9584	/*
9585	 * The control device is always connected.  The disk device, on the
9586	 * other hand, may not be online all the time.
9587	 */
9588	if (lun != NULL)
9589		mpp_ptr->device = (SID_QUAL_LU_CONNECTED << 5) |
9590				     lun->be_lun->lun_type;
9591	else
9592		mpp_ptr->device = (SID_QUAL_LU_OFFLINE << 5) | T_DIRECT;
9593	mpp_ptr->page_code = SVPD_MODE_PAGE_POLICY;
9594	scsi_ulto2b(data_len - 4, mpp_ptr->page_length);
9595	mpp_ptr->descr[0].page_code = 0x3f;
9596	mpp_ptr->descr[0].subpage_code = 0xff;
9597	mpp_ptr->descr[0].policy = SVPD_MPP_SHARED;
9598
9599	ctl_set_success(ctsio);
9600	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
9601	ctsio->be_move_done = ctl_config_move_done;
9602	ctl_datamove((union ctl_io *)ctsio);
9603	return (CTL_RETVAL_COMPLETE);
9604}
9605
9606/*
9607 * SCSI VPD page 0x83, the Device Identification page.
9608 */
9609static int
9610ctl_inquiry_evpd_devid(struct ctl_scsiio *ctsio, int alloc_len)
9611{
9612	struct scsi_vpd_device_id *devid_ptr;
9613	struct scsi_vpd_id_descriptor *desc;
9614	struct ctl_softc *softc;
9615	struct ctl_lun *lun;
9616	struct ctl_port *port;
9617	int data_len, g;
9618	uint8_t proto;
9619
9620	softc = control_softc;
9621
9622	port = ctl_io_port(&ctsio->io_hdr);
9623	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
9624
9625	data_len = sizeof(struct scsi_vpd_device_id) +
9626	    sizeof(struct scsi_vpd_id_descriptor) +
9627		sizeof(struct scsi_vpd_id_rel_trgt_port_id) +
9628	    sizeof(struct scsi_vpd_id_descriptor) +
9629		sizeof(struct scsi_vpd_id_trgt_port_grp_id);
9630	if (lun && lun->lun_devid)
9631		data_len += lun->lun_devid->len;
9632	if (port && port->port_devid)
9633		data_len += port->port_devid->len;
9634	if (port && port->target_devid)
9635		data_len += port->target_devid->len;
9636
9637	ctsio->kern_data_ptr = malloc(data_len, M_CTL, M_WAITOK | M_ZERO);
9638	devid_ptr = (struct scsi_vpd_device_id *)ctsio->kern_data_ptr;
9639	ctsio->kern_sg_entries = 0;
9640
9641	if (data_len < alloc_len) {
9642		ctsio->residual = alloc_len - data_len;
9643		ctsio->kern_data_len = data_len;
9644		ctsio->kern_total_len = data_len;
9645	} else {
9646		ctsio->residual = 0;
9647		ctsio->kern_data_len = alloc_len;
9648		ctsio->kern_total_len = alloc_len;
9649	}
9650	ctsio->kern_data_resid = 0;
9651	ctsio->kern_rel_offset = 0;
9652	ctsio->kern_sg_entries = 0;
9653
9654	/*
9655	 * The control device is always connected.  The disk device, on the
9656	 * other hand, may not be online all the time.
9657	 */
9658	if (lun != NULL)
9659		devid_ptr->device = (SID_QUAL_LU_CONNECTED << 5) |
9660				     lun->be_lun->lun_type;
9661	else
9662		devid_ptr->device = (SID_QUAL_LU_OFFLINE << 5) | T_DIRECT;
9663	devid_ptr->page_code = SVPD_DEVICE_ID;
9664	scsi_ulto2b(data_len - 4, devid_ptr->length);
9665
9666	if (port && port->port_type == CTL_PORT_FC)
9667		proto = SCSI_PROTO_FC << 4;
9668	else if (port && port->port_type == CTL_PORT_ISCSI)
9669		proto = SCSI_PROTO_ISCSI << 4;
9670	else
9671		proto = SCSI_PROTO_SPI << 4;
9672	desc = (struct scsi_vpd_id_descriptor *)devid_ptr->desc_list;
9673
9674	/*
9675	 * We're using a LUN association here.  i.e., this device ID is a
9676	 * per-LUN identifier.
9677	 */
9678	if (lun && lun->lun_devid) {
9679		memcpy(desc, lun->lun_devid->data, lun->lun_devid->len);
9680		desc = (struct scsi_vpd_id_descriptor *)((uint8_t *)desc +
9681		    lun->lun_devid->len);
9682	}
9683
9684	/*
9685	 * This is for the WWPN which is a port association.
9686	 */
9687	if (port && port->port_devid) {
9688		memcpy(desc, port->port_devid->data, port->port_devid->len);
9689		desc = (struct scsi_vpd_id_descriptor *)((uint8_t *)desc +
9690		    port->port_devid->len);
9691	}
9692
9693	/*
9694	 * This is for the Relative Target Port(type 4h) identifier
9695	 */
9696	desc->proto_codeset = proto | SVPD_ID_CODESET_BINARY;
9697	desc->id_type = SVPD_ID_PIV | SVPD_ID_ASSOC_PORT |
9698	    SVPD_ID_TYPE_RELTARG;
9699	desc->length = 4;
9700	scsi_ulto2b(ctsio->io_hdr.nexus.targ_port, &desc->identifier[2]);
9701	desc = (struct scsi_vpd_id_descriptor *)(&desc->identifier[0] +
9702	    sizeof(struct scsi_vpd_id_rel_trgt_port_id));
9703
9704	/*
9705	 * This is for the Target Port Group(type 5h) identifier
9706	 */
9707	desc->proto_codeset = proto | SVPD_ID_CODESET_BINARY;
9708	desc->id_type = SVPD_ID_PIV | SVPD_ID_ASSOC_PORT |
9709	    SVPD_ID_TYPE_TPORTGRP;
9710	desc->length = 4;
9711	if (softc->is_single ||
9712	    (port && port->status & CTL_PORT_STATUS_HA_SHARED))
9713		g = 1;
9714	else
9715		g = 2 + ctsio->io_hdr.nexus.targ_port / softc->port_cnt;
9716	scsi_ulto2b(g, &desc->identifier[2]);
9717	desc = (struct scsi_vpd_id_descriptor *)(&desc->identifier[0] +
9718	    sizeof(struct scsi_vpd_id_trgt_port_grp_id));
9719
9720	/*
9721	 * This is for the Target identifier
9722	 */
9723	if (port && port->target_devid) {
9724		memcpy(desc, port->target_devid->data, port->target_devid->len);
9725	}
9726
9727	ctl_set_success(ctsio);
9728	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
9729	ctsio->be_move_done = ctl_config_move_done;
9730	ctl_datamove((union ctl_io *)ctsio);
9731	return (CTL_RETVAL_COMPLETE);
9732}
9733
9734static int
9735ctl_inquiry_evpd_scsi_ports(struct ctl_scsiio *ctsio, int alloc_len)
9736{
9737	struct ctl_softc *softc = control_softc;
9738	struct scsi_vpd_scsi_ports *sp;
9739	struct scsi_vpd_port_designation *pd;
9740	struct scsi_vpd_port_designation_cont *pdc;
9741	struct ctl_lun *lun;
9742	struct ctl_port *port;
9743	int data_len, num_target_ports, iid_len, id_len;
9744
9745	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
9746
9747	num_target_ports = 0;
9748	iid_len = 0;
9749	id_len = 0;
9750	mtx_lock(&softc->ctl_lock);
9751	STAILQ_FOREACH(port, &softc->port_list, links) {
9752		if ((port->status & CTL_PORT_STATUS_ONLINE) == 0)
9753			continue;
9754		if (lun != NULL &&
9755		    ctl_lun_map_to_port(port, lun->lun) >= CTL_MAX_LUNS)
9756			continue;
9757		num_target_ports++;
9758		if (port->init_devid)
9759			iid_len += port->init_devid->len;
9760		if (port->port_devid)
9761			id_len += port->port_devid->len;
9762	}
9763	mtx_unlock(&softc->ctl_lock);
9764
9765	data_len = sizeof(struct scsi_vpd_scsi_ports) +
9766	    num_target_ports * (sizeof(struct scsi_vpd_port_designation) +
9767	     sizeof(struct scsi_vpd_port_designation_cont)) + iid_len + id_len;
9768	ctsio->kern_data_ptr = malloc(data_len, M_CTL, M_WAITOK | M_ZERO);
9769	sp = (struct scsi_vpd_scsi_ports *)ctsio->kern_data_ptr;
9770	ctsio->kern_sg_entries = 0;
9771
9772	if (data_len < alloc_len) {
9773		ctsio->residual = alloc_len - data_len;
9774		ctsio->kern_data_len = data_len;
9775		ctsio->kern_total_len = data_len;
9776	} else {
9777		ctsio->residual = 0;
9778		ctsio->kern_data_len = alloc_len;
9779		ctsio->kern_total_len = alloc_len;
9780	}
9781	ctsio->kern_data_resid = 0;
9782	ctsio->kern_rel_offset = 0;
9783	ctsio->kern_sg_entries = 0;
9784
9785	/*
9786	 * The control device is always connected.  The disk device, on the
9787	 * other hand, may not be online all the time.  Need to change this
9788	 * to figure out whether the disk device is actually online or not.
9789	 */
9790	if (lun != NULL)
9791		sp->device = (SID_QUAL_LU_CONNECTED << 5) |
9792				  lun->be_lun->lun_type;
9793	else
9794		sp->device = (SID_QUAL_LU_OFFLINE << 5) | T_DIRECT;
9795
9796	sp->page_code = SVPD_SCSI_PORTS;
9797	scsi_ulto2b(data_len - sizeof(struct scsi_vpd_scsi_ports),
9798	    sp->page_length);
9799	pd = &sp->design[0];
9800
9801	mtx_lock(&softc->ctl_lock);
9802	STAILQ_FOREACH(port, &softc->port_list, links) {
9803		if ((port->status & CTL_PORT_STATUS_ONLINE) == 0)
9804			continue;
9805		if (lun != NULL &&
9806		    ctl_lun_map_to_port(port, lun->lun) >= CTL_MAX_LUNS)
9807			continue;
9808		scsi_ulto2b(port->targ_port, pd->relative_port_id);
9809		if (port->init_devid) {
9810			iid_len = port->init_devid->len;
9811			memcpy(pd->initiator_transportid,
9812			    port->init_devid->data, port->init_devid->len);
9813		} else
9814			iid_len = 0;
9815		scsi_ulto2b(iid_len, pd->initiator_transportid_length);
9816		pdc = (struct scsi_vpd_port_designation_cont *)
9817		    (&pd->initiator_transportid[iid_len]);
9818		if (port->port_devid) {
9819			id_len = port->port_devid->len;
9820			memcpy(pdc->target_port_descriptors,
9821			    port->port_devid->data, port->port_devid->len);
9822		} else
9823			id_len = 0;
9824		scsi_ulto2b(id_len, pdc->target_port_descriptors_length);
9825		pd = (struct scsi_vpd_port_designation *)
9826		    ((uint8_t *)pdc->target_port_descriptors + id_len);
9827	}
9828	mtx_unlock(&softc->ctl_lock);
9829
9830	ctl_set_success(ctsio);
9831	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
9832	ctsio->be_move_done = ctl_config_move_done;
9833	ctl_datamove((union ctl_io *)ctsio);
9834	return (CTL_RETVAL_COMPLETE);
9835}
9836
9837static int
9838ctl_inquiry_evpd_block_limits(struct ctl_scsiio *ctsio, int alloc_len)
9839{
9840	struct scsi_vpd_block_limits *bl_ptr;
9841	struct ctl_lun *lun;
9842	uint64_t ival;
9843
9844	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
9845
9846	ctsio->kern_data_ptr = malloc(sizeof(*bl_ptr), M_CTL, M_WAITOK | M_ZERO);
9847	bl_ptr = (struct scsi_vpd_block_limits *)ctsio->kern_data_ptr;
9848	ctsio->kern_sg_entries = 0;
9849
9850	if (sizeof(*bl_ptr) < alloc_len) {
9851		ctsio->residual = alloc_len - sizeof(*bl_ptr);
9852		ctsio->kern_data_len = sizeof(*bl_ptr);
9853		ctsio->kern_total_len = sizeof(*bl_ptr);
9854	} else {
9855		ctsio->residual = 0;
9856		ctsio->kern_data_len = alloc_len;
9857		ctsio->kern_total_len = alloc_len;
9858	}
9859	ctsio->kern_data_resid = 0;
9860	ctsio->kern_rel_offset = 0;
9861	ctsio->kern_sg_entries = 0;
9862
9863	/*
9864	 * The control device is always connected.  The disk device, on the
9865	 * other hand, may not be online all the time.  Need to change this
9866	 * to figure out whether the disk device is actually online or not.
9867	 */
9868	if (lun != NULL)
9869		bl_ptr->device = (SID_QUAL_LU_CONNECTED << 5) |
9870				  lun->be_lun->lun_type;
9871	else
9872		bl_ptr->device = (SID_QUAL_LU_OFFLINE << 5) | T_DIRECT;
9873
9874	bl_ptr->page_code = SVPD_BLOCK_LIMITS;
9875	scsi_ulto2b(sizeof(*bl_ptr) - 4, bl_ptr->page_length);
9876	bl_ptr->max_cmp_write_len = 0xff;
9877	scsi_ulto4b(0xffffffff, bl_ptr->max_txfer_len);
9878	if (lun != NULL) {
9879		scsi_ulto4b(lun->be_lun->opttxferlen, bl_ptr->opt_txfer_len);
9880		if (lun->be_lun->flags & CTL_LUN_FLAG_UNMAP) {
9881			ival = 0xffffffff;
9882			ctl_get_opt_number(&lun->be_lun->options,
9883			    "unmap_max_lba", &ival);
9884			scsi_ulto4b(ival, bl_ptr->max_unmap_lba_cnt);
9885			ival = 0xffffffff;
9886			ctl_get_opt_number(&lun->be_lun->options,
9887			    "unmap_max_descr", &ival);
9888			scsi_ulto4b(ival, bl_ptr->max_unmap_blk_cnt);
9889			if (lun->be_lun->ublockexp != 0) {
9890				scsi_ulto4b((1 << lun->be_lun->ublockexp),
9891				    bl_ptr->opt_unmap_grain);
9892				scsi_ulto4b(0x80000000 | lun->be_lun->ublockoff,
9893				    bl_ptr->unmap_grain_align);
9894			}
9895		}
9896		scsi_ulto4b(lun->be_lun->atomicblock,
9897		    bl_ptr->max_atomic_transfer_length);
9898		scsi_ulto4b(0, bl_ptr->atomic_alignment);
9899		scsi_ulto4b(0, bl_ptr->atomic_transfer_length_granularity);
9900		scsi_ulto4b(0, bl_ptr->max_atomic_transfer_length_with_atomic_boundary);
9901		scsi_ulto4b(0, bl_ptr->max_atomic_boundary_size);
9902		ival = UINT64_MAX;
9903		ctl_get_opt_number(&lun->be_lun->options, "write_same_max_lba", &ival);
9904		scsi_u64to8b(ival, bl_ptr->max_write_same_length);
9905	}
9906
9907	ctl_set_success(ctsio);
9908	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
9909	ctsio->be_move_done = ctl_config_move_done;
9910	ctl_datamove((union ctl_io *)ctsio);
9911	return (CTL_RETVAL_COMPLETE);
9912}
9913
9914static int
9915ctl_inquiry_evpd_bdc(struct ctl_scsiio *ctsio, int alloc_len)
9916{
9917	struct scsi_vpd_block_device_characteristics *bdc_ptr;
9918	struct ctl_lun *lun;
9919	const char *value;
9920	u_int i;
9921
9922	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
9923
9924	ctsio->kern_data_ptr = malloc(sizeof(*bdc_ptr), M_CTL, M_WAITOK | M_ZERO);
9925	bdc_ptr = (struct scsi_vpd_block_device_characteristics *)ctsio->kern_data_ptr;
9926	ctsio->kern_sg_entries = 0;
9927
9928	if (sizeof(*bdc_ptr) < alloc_len) {
9929		ctsio->residual = alloc_len - sizeof(*bdc_ptr);
9930		ctsio->kern_data_len = sizeof(*bdc_ptr);
9931		ctsio->kern_total_len = sizeof(*bdc_ptr);
9932	} else {
9933		ctsio->residual = 0;
9934		ctsio->kern_data_len = alloc_len;
9935		ctsio->kern_total_len = alloc_len;
9936	}
9937	ctsio->kern_data_resid = 0;
9938	ctsio->kern_rel_offset = 0;
9939	ctsio->kern_sg_entries = 0;
9940
9941	/*
9942	 * The control device is always connected.  The disk device, on the
9943	 * other hand, may not be online all the time.  Need to change this
9944	 * to figure out whether the disk device is actually online or not.
9945	 */
9946	if (lun != NULL)
9947		bdc_ptr->device = (SID_QUAL_LU_CONNECTED << 5) |
9948				  lun->be_lun->lun_type;
9949	else
9950		bdc_ptr->device = (SID_QUAL_LU_OFFLINE << 5) | T_DIRECT;
9951	bdc_ptr->page_code = SVPD_BDC;
9952	scsi_ulto2b(sizeof(*bdc_ptr) - 4, bdc_ptr->page_length);
9953	if (lun != NULL &&
9954	    (value = ctl_get_opt(&lun->be_lun->options, "rpm")) != NULL)
9955		i = strtol(value, NULL, 0);
9956	else
9957		i = CTL_DEFAULT_ROTATION_RATE;
9958	scsi_ulto2b(i, bdc_ptr->medium_rotation_rate);
9959	if (lun != NULL &&
9960	    (value = ctl_get_opt(&lun->be_lun->options, "formfactor")) != NULL)
9961		i = strtol(value, NULL, 0);
9962	else
9963		i = 0;
9964	bdc_ptr->wab_wac_ff = (i & 0x0f);
9965	bdc_ptr->flags = SVPD_FUAB | SVPD_VBULS;
9966
9967	ctl_set_success(ctsio);
9968	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
9969	ctsio->be_move_done = ctl_config_move_done;
9970	ctl_datamove((union ctl_io *)ctsio);
9971	return (CTL_RETVAL_COMPLETE);
9972}
9973
9974static int
9975ctl_inquiry_evpd_lbp(struct ctl_scsiio *ctsio, int alloc_len)
9976{
9977	struct scsi_vpd_logical_block_prov *lbp_ptr;
9978	struct ctl_lun *lun;
9979	const char *value;
9980
9981	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
9982
9983	ctsio->kern_data_ptr = malloc(sizeof(*lbp_ptr), M_CTL, M_WAITOK | M_ZERO);
9984	lbp_ptr = (struct scsi_vpd_logical_block_prov *)ctsio->kern_data_ptr;
9985	ctsio->kern_sg_entries = 0;
9986
9987	if (sizeof(*lbp_ptr) < alloc_len) {
9988		ctsio->residual = alloc_len - sizeof(*lbp_ptr);
9989		ctsio->kern_data_len = sizeof(*lbp_ptr);
9990		ctsio->kern_total_len = sizeof(*lbp_ptr);
9991	} else {
9992		ctsio->residual = 0;
9993		ctsio->kern_data_len = alloc_len;
9994		ctsio->kern_total_len = alloc_len;
9995	}
9996	ctsio->kern_data_resid = 0;
9997	ctsio->kern_rel_offset = 0;
9998	ctsio->kern_sg_entries = 0;
9999
10000	/*
10001	 * The control device is always connected.  The disk device, on the
10002	 * other hand, may not be online all the time.  Need to change this
10003	 * to figure out whether the disk device is actually online or not.
10004	 */
10005	if (lun != NULL)
10006		lbp_ptr->device = (SID_QUAL_LU_CONNECTED << 5) |
10007				  lun->be_lun->lun_type;
10008	else
10009		lbp_ptr->device = (SID_QUAL_LU_OFFLINE << 5) | T_DIRECT;
10010
10011	lbp_ptr->page_code = SVPD_LBP;
10012	scsi_ulto2b(sizeof(*lbp_ptr) - 4, lbp_ptr->page_length);
10013	lbp_ptr->threshold_exponent = CTL_LBP_EXPONENT;
10014	if (lun != NULL && lun->be_lun->flags & CTL_LUN_FLAG_UNMAP) {
10015		lbp_ptr->flags = SVPD_LBP_UNMAP | SVPD_LBP_WS16 |
10016		    SVPD_LBP_WS10 | SVPD_LBP_RZ | SVPD_LBP_ANC_SUP;
10017		value = ctl_get_opt(&lun->be_lun->options, "provisioning_type");
10018		if (value != NULL) {
10019			if (strcmp(value, "resource") == 0)
10020				lbp_ptr->prov_type = SVPD_LBP_RESOURCE;
10021			else if (strcmp(value, "thin") == 0)
10022				lbp_ptr->prov_type = SVPD_LBP_THIN;
10023		} else
10024			lbp_ptr->prov_type = SVPD_LBP_THIN;
10025	}
10026
10027	ctl_set_success(ctsio);
10028	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
10029	ctsio->be_move_done = ctl_config_move_done;
10030	ctl_datamove((union ctl_io *)ctsio);
10031	return (CTL_RETVAL_COMPLETE);
10032}
10033
10034/*
10035 * INQUIRY with the EVPD bit set.
10036 */
10037static int
10038ctl_inquiry_evpd(struct ctl_scsiio *ctsio)
10039{
10040	struct ctl_lun *lun;
10041	struct scsi_inquiry *cdb;
10042	int alloc_len, retval;
10043
10044	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
10045	cdb = (struct scsi_inquiry *)ctsio->cdb;
10046	alloc_len = scsi_2btoul(cdb->length);
10047
10048	switch (cdb->page_code) {
10049	case SVPD_SUPPORTED_PAGES:
10050		retval = ctl_inquiry_evpd_supported(ctsio, alloc_len);
10051		break;
10052	case SVPD_UNIT_SERIAL_NUMBER:
10053		retval = ctl_inquiry_evpd_serial(ctsio, alloc_len);
10054		break;
10055	case SVPD_DEVICE_ID:
10056		retval = ctl_inquiry_evpd_devid(ctsio, alloc_len);
10057		break;
10058	case SVPD_EXTENDED_INQUIRY_DATA:
10059		retval = ctl_inquiry_evpd_eid(ctsio, alloc_len);
10060		break;
10061	case SVPD_MODE_PAGE_POLICY:
10062		retval = ctl_inquiry_evpd_mpp(ctsio, alloc_len);
10063		break;
10064	case SVPD_SCSI_PORTS:
10065		retval = ctl_inquiry_evpd_scsi_ports(ctsio, alloc_len);
10066		break;
10067	case SVPD_SCSI_TPC:
10068		retval = ctl_inquiry_evpd_tpc(ctsio, alloc_len);
10069		break;
10070	case SVPD_BLOCK_LIMITS:
10071		if (lun == NULL || lun->be_lun->lun_type != T_DIRECT)
10072			goto err;
10073		retval = ctl_inquiry_evpd_block_limits(ctsio, alloc_len);
10074		break;
10075	case SVPD_BDC:
10076		if (lun == NULL || lun->be_lun->lun_type != T_DIRECT)
10077			goto err;
10078		retval = ctl_inquiry_evpd_bdc(ctsio, alloc_len);
10079		break;
10080	case SVPD_LBP:
10081		if (lun == NULL || lun->be_lun->lun_type != T_DIRECT)
10082			goto err;
10083		retval = ctl_inquiry_evpd_lbp(ctsio, alloc_len);
10084		break;
10085	default:
10086err:
10087		ctl_set_invalid_field(ctsio,
10088				      /*sks_valid*/ 1,
10089				      /*command*/ 1,
10090				      /*field*/ 2,
10091				      /*bit_valid*/ 0,
10092				      /*bit*/ 0);
10093		ctl_done((union ctl_io *)ctsio);
10094		retval = CTL_RETVAL_COMPLETE;
10095		break;
10096	}
10097
10098	return (retval);
10099}
10100
10101/*
10102 * Standard INQUIRY data.
10103 */
10104static int
10105ctl_inquiry_std(struct ctl_scsiio *ctsio)
10106{
10107	struct scsi_inquiry_data *inq_ptr;
10108	struct scsi_inquiry *cdb;
10109	struct ctl_softc *softc = control_softc;
10110	struct ctl_port *port;
10111	struct ctl_lun *lun;
10112	char *val;
10113	uint32_t alloc_len, data_len;
10114	ctl_port_type port_type;
10115
10116	port = ctl_io_port(&ctsio->io_hdr);
10117	port_type = port->port_type;
10118	if (port_type == CTL_PORT_IOCTL || port_type == CTL_PORT_INTERNAL)
10119		port_type = CTL_PORT_SCSI;
10120
10121	lun = ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
10122	cdb = (struct scsi_inquiry *)ctsio->cdb;
10123	alloc_len = scsi_2btoul(cdb->length);
10124
10125	/*
10126	 * We malloc the full inquiry data size here and fill it
10127	 * in.  If the user only asks for less, we'll give him
10128	 * that much.
10129	 */
10130	data_len = offsetof(struct scsi_inquiry_data, vendor_specific1);
10131	ctsio->kern_data_ptr = malloc(data_len, M_CTL, M_WAITOK | M_ZERO);
10132	inq_ptr = (struct scsi_inquiry_data *)ctsio->kern_data_ptr;
10133	ctsio->kern_sg_entries = 0;
10134	ctsio->kern_data_resid = 0;
10135	ctsio->kern_rel_offset = 0;
10136
10137	if (data_len < alloc_len) {
10138		ctsio->residual = alloc_len - data_len;
10139		ctsio->kern_data_len = data_len;
10140		ctsio->kern_total_len = data_len;
10141	} else {
10142		ctsio->residual = 0;
10143		ctsio->kern_data_len = alloc_len;
10144		ctsio->kern_total_len = alloc_len;
10145	}
10146
10147	if (lun != NULL) {
10148		if ((lun->flags & CTL_LUN_PRIMARY_SC) ||
10149		    softc->ha_link >= CTL_HA_LINK_UNKNOWN) {
10150			inq_ptr->device = (SID_QUAL_LU_CONNECTED << 5) |
10151			    lun->be_lun->lun_type;
10152		} else {
10153			inq_ptr->device = (SID_QUAL_LU_OFFLINE << 5) |
10154			    lun->be_lun->lun_type;
10155		}
10156		if (lun->flags & CTL_LUN_REMOVABLE)
10157			inq_ptr->dev_qual2 |= SID_RMB;
10158	} else
10159		inq_ptr->device = (SID_QUAL_BAD_LU << 5) | T_NODEVICE;
10160
10161	/* RMB in byte 2 is 0 */
10162	inq_ptr->version = SCSI_REV_SPC4;
10163
10164	/*
10165	 * According to SAM-3, even if a device only supports a single
10166	 * level of LUN addressing, it should still set the HISUP bit:
10167	 *
10168	 * 4.9.1 Logical unit numbers overview
10169	 *
10170	 * All logical unit number formats described in this standard are
10171	 * hierarchical in structure even when only a single level in that
10172	 * hierarchy is used. The HISUP bit shall be set to one in the
10173	 * standard INQUIRY data (see SPC-2) when any logical unit number
10174	 * format described in this standard is used.  Non-hierarchical
10175	 * formats are outside the scope of this standard.
10176	 *
10177	 * Therefore we set the HiSup bit here.
10178	 *
10179	 * The response format is 2, per SPC-3.
10180	 */
10181	inq_ptr->response_format = SID_HiSup | 2;
10182
10183	inq_ptr->additional_length = data_len -
10184	    (offsetof(struct scsi_inquiry_data, additional_length) + 1);
10185	CTL_DEBUG_PRINT(("additional_length = %d\n",
10186			 inq_ptr->additional_length));
10187
10188	inq_ptr->spc3_flags = SPC3_SID_3PC | SPC3_SID_TPGS_IMPLICIT;
10189	if (port_type == CTL_PORT_SCSI)
10190		inq_ptr->spc2_flags = SPC2_SID_ADDR16;
10191	inq_ptr->spc2_flags |= SPC2_SID_MultiP;
10192	inq_ptr->flags = SID_CmdQue;
10193	if (port_type == CTL_PORT_SCSI)
10194		inq_ptr->flags |= SID_WBus16 | SID_Sync;
10195
10196	/*
10197	 * Per SPC-3, unused bytes in ASCII strings are filled with spaces.
10198	 * We have 8 bytes for the vendor name, and 16 bytes for the device
10199	 * name and 4 bytes for the revision.
10200	 */
10201	if (lun == NULL || (val = ctl_get_opt(&lun->be_lun->options,
10202	    "vendor")) == NULL) {
10203		strncpy(inq_ptr->vendor, CTL_VENDOR, sizeof(inq_ptr->vendor));
10204	} else {
10205		memset(inq_ptr->vendor, ' ', sizeof(inq_ptr->vendor));
10206		strncpy(inq_ptr->vendor, val,
10207		    min(sizeof(inq_ptr->vendor), strlen(val)));
10208	}
10209	if (lun == NULL) {
10210		strncpy(inq_ptr->product, CTL_DIRECT_PRODUCT,
10211		    sizeof(inq_ptr->product));
10212	} else if ((val = ctl_get_opt(&lun->be_lun->options, "product")) == NULL) {
10213		switch (lun->be_lun->lun_type) {
10214		case T_DIRECT:
10215			strncpy(inq_ptr->product, CTL_DIRECT_PRODUCT,
10216			    sizeof(inq_ptr->product));
10217			break;
10218		case T_PROCESSOR:
10219			strncpy(inq_ptr->product, CTL_PROCESSOR_PRODUCT,
10220			    sizeof(inq_ptr->product));
10221			break;
10222		case T_CDROM:
10223			strncpy(inq_ptr->product, CTL_CDROM_PRODUCT,
10224			    sizeof(inq_ptr->product));
10225			break;
10226		default:
10227			strncpy(inq_ptr->product, CTL_UNKNOWN_PRODUCT,
10228			    sizeof(inq_ptr->product));
10229			break;
10230		}
10231	} else {
10232		memset(inq_ptr->product, ' ', sizeof(inq_ptr->product));
10233		strncpy(inq_ptr->product, val,
10234		    min(sizeof(inq_ptr->product), strlen(val)));
10235	}
10236
10237	/*
10238	 * XXX make this a macro somewhere so it automatically gets
10239	 * incremented when we make changes.
10240	 */
10241	if (lun == NULL || (val = ctl_get_opt(&lun->be_lun->options,
10242	    "revision")) == NULL) {
10243		strncpy(inq_ptr->revision, "0001", sizeof(inq_ptr->revision));
10244	} else {
10245		memset(inq_ptr->revision, ' ', sizeof(inq_ptr->revision));
10246		strncpy(inq_ptr->revision, val,
10247		    min(sizeof(inq_ptr->revision), strlen(val)));
10248	}
10249
10250	/*
10251	 * For parallel SCSI, we support double transition and single
10252	 * transition clocking.  We also support QAS (Quick Arbitration
10253	 * and Selection) and Information Unit transfers on both the
10254	 * control and array devices.
10255	 */
10256	if (port_type == CTL_PORT_SCSI)
10257		inq_ptr->spi3data = SID_SPI_CLOCK_DT_ST | SID_SPI_QAS |
10258				    SID_SPI_IUS;
10259
10260	/* SAM-5 (no version claimed) */
10261	scsi_ulto2b(0x00A0, inq_ptr->version1);
10262	/* SPC-4 (no version claimed) */
10263	scsi_ulto2b(0x0460, inq_ptr->version2);
10264	if (port_type == CTL_PORT_FC) {
10265		/* FCP-2 ANSI INCITS.350:2003 */
10266		scsi_ulto2b(0x0917, inq_ptr->version3);
10267	} else if (port_type == CTL_PORT_SCSI) {
10268		/* SPI-4 ANSI INCITS.362:200x */
10269		scsi_ulto2b(0x0B56, inq_ptr->version3);
10270	} else if (port_type == CTL_PORT_ISCSI) {
10271		/* iSCSI (no version claimed) */
10272		scsi_ulto2b(0x0960, inq_ptr->version3);
10273	} else if (port_type == CTL_PORT_SAS) {
10274		/* SAS (no version claimed) */
10275		scsi_ulto2b(0x0BE0, inq_ptr->version3);
10276	}
10277
10278	if (lun == NULL) {
10279		/* SBC-4 (no version claimed) */
10280		scsi_ulto2b(0x0600, inq_ptr->version4);
10281	} else {
10282		switch (lun->be_lun->lun_type) {
10283		case T_DIRECT:
10284			/* SBC-4 (no version claimed) */
10285			scsi_ulto2b(0x0600, inq_ptr->version4);
10286			break;
10287		case T_PROCESSOR:
10288			break;
10289		case T_CDROM:
10290			/* MMC-6 (no version claimed) */
10291			scsi_ulto2b(0x04E0, inq_ptr->version4);
10292			break;
10293		default:
10294			break;
10295		}
10296	}
10297
10298	ctl_set_success(ctsio);
10299	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
10300	ctsio->be_move_done = ctl_config_move_done;
10301	ctl_datamove((union ctl_io *)ctsio);
10302	return (CTL_RETVAL_COMPLETE);
10303}
10304
10305int
10306ctl_inquiry(struct ctl_scsiio *ctsio)
10307{
10308	struct scsi_inquiry *cdb;
10309	int retval;
10310
10311	CTL_DEBUG_PRINT(("ctl_inquiry\n"));
10312
10313	cdb = (struct scsi_inquiry *)ctsio->cdb;
10314	if (cdb->byte2 & SI_EVPD)
10315		retval = ctl_inquiry_evpd(ctsio);
10316	else if (cdb->page_code == 0)
10317		retval = ctl_inquiry_std(ctsio);
10318	else {
10319		ctl_set_invalid_field(ctsio,
10320				      /*sks_valid*/ 1,
10321				      /*command*/ 1,
10322				      /*field*/ 2,
10323				      /*bit_valid*/ 0,
10324				      /*bit*/ 0);
10325		ctl_done((union ctl_io *)ctsio);
10326		return (CTL_RETVAL_COMPLETE);
10327	}
10328
10329	return (retval);
10330}
10331
10332int
10333ctl_get_config(struct ctl_scsiio *ctsio)
10334{
10335	struct scsi_get_config_header *hdr;
10336	struct scsi_get_config_feature *feature;
10337	struct scsi_get_config *cdb;
10338	struct ctl_lun *lun;
10339	uint32_t alloc_len, data_len;
10340	int rt, starting;
10341
10342	lun = ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
10343	cdb = (struct scsi_get_config *)ctsio->cdb;
10344	rt = (cdb->rt & SGC_RT_MASK);
10345	starting = scsi_2btoul(cdb->starting_feature);
10346	alloc_len = scsi_2btoul(cdb->length);
10347
10348	data_len = sizeof(struct scsi_get_config_header) +
10349	    sizeof(struct scsi_get_config_feature) + 8 +
10350	    sizeof(struct scsi_get_config_feature) + 8 +
10351	    sizeof(struct scsi_get_config_feature) + 4 +
10352	    sizeof(struct scsi_get_config_feature) + 4 +
10353	    sizeof(struct scsi_get_config_feature) + 8 +
10354	    sizeof(struct scsi_get_config_feature) +
10355	    sizeof(struct scsi_get_config_feature) + 4 +
10356	    sizeof(struct scsi_get_config_feature) + 4 +
10357	    sizeof(struct scsi_get_config_feature) + 4 +
10358	    sizeof(struct scsi_get_config_feature) + 4 +
10359	    sizeof(struct scsi_get_config_feature) + 4 +
10360	    sizeof(struct scsi_get_config_feature) + 4;
10361	ctsio->kern_data_ptr = malloc(data_len, M_CTL, M_WAITOK | M_ZERO);
10362	ctsio->kern_sg_entries = 0;
10363	ctsio->kern_data_resid = 0;
10364	ctsio->kern_rel_offset = 0;
10365
10366	hdr = (struct scsi_get_config_header *)ctsio->kern_data_ptr;
10367	if (lun->flags & CTL_LUN_NO_MEDIA)
10368		scsi_ulto2b(0x0000, hdr->current_profile);
10369	else
10370		scsi_ulto2b(0x0010, hdr->current_profile);
10371	feature = (struct scsi_get_config_feature *)(hdr + 1);
10372
10373	if (starting > 0x003b)
10374		goto done;
10375	if (starting > 0x003a)
10376		goto f3b;
10377	if (starting > 0x002b)
10378		goto f3a;
10379	if (starting > 0x002a)
10380		goto f2b;
10381	if (starting > 0x001f)
10382		goto f2a;
10383	if (starting > 0x001e)
10384		goto f1f;
10385	if (starting > 0x001d)
10386		goto f1e;
10387	if (starting > 0x0010)
10388		goto f1d;
10389	if (starting > 0x0003)
10390		goto f10;
10391	if (starting > 0x0002)
10392		goto f3;
10393	if (starting > 0x0001)
10394		goto f2;
10395	if (starting > 0x0000)
10396		goto f1;
10397
10398	/* Profile List */
10399	scsi_ulto2b(0x0000, feature->feature_code);
10400	feature->flags = SGC_F_PERSISTENT | SGC_F_CURRENT;
10401	feature->add_length = 8;
10402	scsi_ulto2b(0x0008, &feature->feature_data[0]);	/* CD-ROM */
10403	feature->feature_data[2] = 0x00;
10404	scsi_ulto2b(0x0010, &feature->feature_data[4]);	/* DVD-ROM */
10405	feature->feature_data[6] = 0x01;
10406	feature = (struct scsi_get_config_feature *)
10407	    &feature->feature_data[feature->add_length];
10408
10409f1:	/* Core */
10410	scsi_ulto2b(0x0001, feature->feature_code);
10411	feature->flags = 0x08 | SGC_F_PERSISTENT | SGC_F_CURRENT;
10412	feature->add_length = 8;
10413	scsi_ulto4b(0x00000000, &feature->feature_data[0]);
10414	feature->feature_data[4] = 0x03;
10415	feature = (struct scsi_get_config_feature *)
10416	    &feature->feature_data[feature->add_length];
10417
10418f2:	/* Morphing */
10419	scsi_ulto2b(0x0002, feature->feature_code);
10420	feature->flags = 0x04 | SGC_F_PERSISTENT | SGC_F_CURRENT;
10421	feature->add_length = 4;
10422	feature->feature_data[0] = 0x02;
10423	feature = (struct scsi_get_config_feature *)
10424	    &feature->feature_data[feature->add_length];
10425
10426f3:	/* Removable Medium */
10427	scsi_ulto2b(0x0003, feature->feature_code);
10428	feature->flags = 0x04 | SGC_F_PERSISTENT | SGC_F_CURRENT;
10429	feature->add_length = 4;
10430	feature->feature_data[0] = 0x39;
10431	feature = (struct scsi_get_config_feature *)
10432	    &feature->feature_data[feature->add_length];
10433
10434	if (rt == SGC_RT_CURRENT && (lun->flags & CTL_LUN_NO_MEDIA))
10435		goto done;
10436
10437f10:	/* Random Read */
10438	scsi_ulto2b(0x0010, feature->feature_code);
10439	feature->flags = 0x00;
10440	if ((lun->flags & CTL_LUN_NO_MEDIA) == 0)
10441		feature->flags |= SGC_F_CURRENT;
10442	feature->add_length = 8;
10443	scsi_ulto4b(lun->be_lun->blocksize, &feature->feature_data[0]);
10444	scsi_ulto2b(1, &feature->feature_data[4]);
10445	feature->feature_data[6] = 0x00;
10446	feature = (struct scsi_get_config_feature *)
10447	    &feature->feature_data[feature->add_length];
10448
10449f1d:	/* Multi-Read */
10450	scsi_ulto2b(0x001D, feature->feature_code);
10451	feature->flags = 0x00;
10452	if ((lun->flags & CTL_LUN_NO_MEDIA) == 0)
10453		feature->flags |= SGC_F_CURRENT;
10454	feature->add_length = 0;
10455	feature = (struct scsi_get_config_feature *)
10456	    &feature->feature_data[feature->add_length];
10457
10458f1e:	/* CD Read */
10459	scsi_ulto2b(0x001E, feature->feature_code);
10460	feature->flags = 0x00;
10461	if ((lun->flags & CTL_LUN_NO_MEDIA) == 0)
10462		feature->flags |= SGC_F_CURRENT;
10463	feature->add_length = 4;
10464	feature->feature_data[0] = 0x00;
10465	feature = (struct scsi_get_config_feature *)
10466	    &feature->feature_data[feature->add_length];
10467
10468f1f:	/* DVD Read */
10469	scsi_ulto2b(0x001F, feature->feature_code);
10470	feature->flags = 0x08;
10471	if ((lun->flags & CTL_LUN_NO_MEDIA) == 0)
10472		feature->flags |= SGC_F_CURRENT;
10473	feature->add_length = 4;
10474	feature->feature_data[0] = 0x01;
10475	feature->feature_data[2] = 0x03;
10476	feature = (struct scsi_get_config_feature *)
10477	    &feature->feature_data[feature->add_length];
10478
10479f2a:	/* DVD+RW */
10480	scsi_ulto2b(0x002A, feature->feature_code);
10481	feature->flags = 0x04;
10482	if ((lun->flags & CTL_LUN_NO_MEDIA) == 0)
10483		feature->flags |= SGC_F_CURRENT;
10484	feature->add_length = 4;
10485	feature->feature_data[0] = 0x00;
10486	feature->feature_data[1] = 0x00;
10487	feature = (struct scsi_get_config_feature *)
10488	    &feature->feature_data[feature->add_length];
10489
10490f2b:	/* DVD+R */
10491	scsi_ulto2b(0x002B, feature->feature_code);
10492	feature->flags = 0x00;
10493	if ((lun->flags & CTL_LUN_NO_MEDIA) == 0)
10494		feature->flags |= SGC_F_CURRENT;
10495	feature->add_length = 4;
10496	feature->feature_data[0] = 0x00;
10497	feature = (struct scsi_get_config_feature *)
10498	    &feature->feature_data[feature->add_length];
10499
10500f3a:	/* DVD+RW Dual Layer */
10501	scsi_ulto2b(0x003A, feature->feature_code);
10502	feature->flags = 0x00;
10503	if ((lun->flags & CTL_LUN_NO_MEDIA) == 0)
10504		feature->flags |= SGC_F_CURRENT;
10505	feature->add_length = 4;
10506	feature->feature_data[0] = 0x00;
10507	feature->feature_data[1] = 0x00;
10508	feature = (struct scsi_get_config_feature *)
10509	    &feature->feature_data[feature->add_length];
10510
10511f3b:	/* DVD+R Dual Layer */
10512	scsi_ulto2b(0x003B, feature->feature_code);
10513	feature->flags = 0x00;
10514	if ((lun->flags & CTL_LUN_NO_MEDIA) == 0)
10515		feature->flags |= SGC_F_CURRENT;
10516	feature->add_length = 4;
10517	feature->feature_data[0] = 0x00;
10518	feature = (struct scsi_get_config_feature *)
10519	    &feature->feature_data[feature->add_length];
10520
10521done:
10522	data_len = (uint8_t *)feature - (uint8_t *)hdr;
10523	if (rt == SGC_RT_SPECIFIC && data_len > 4) {
10524		feature = (struct scsi_get_config_feature *)(hdr + 1);
10525		if (scsi_2btoul(feature->feature_code) == starting)
10526			feature = (struct scsi_get_config_feature *)
10527			    &feature->feature_data[feature->add_length];
10528		data_len = (uint8_t *)feature - (uint8_t *)hdr;
10529	}
10530	scsi_ulto4b(data_len - 4, hdr->data_length);
10531	if (data_len < alloc_len) {
10532		ctsio->residual = alloc_len - data_len;
10533		ctsio->kern_data_len = data_len;
10534		ctsio->kern_total_len = data_len;
10535	} else {
10536		ctsio->residual = 0;
10537		ctsio->kern_data_len = alloc_len;
10538		ctsio->kern_total_len = alloc_len;
10539	}
10540
10541	ctl_set_success(ctsio);
10542	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
10543	ctsio->be_move_done = ctl_config_move_done;
10544	ctl_datamove((union ctl_io *)ctsio);
10545	return (CTL_RETVAL_COMPLETE);
10546}
10547
10548int
10549ctl_get_event_status(struct ctl_scsiio *ctsio)
10550{
10551	struct scsi_get_event_status_header *hdr;
10552	struct scsi_get_event_status *cdb;
10553	struct ctl_lun *lun;
10554	uint32_t alloc_len, data_len;
10555	int notif_class;
10556
10557	lun = ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
10558	cdb = (struct scsi_get_event_status *)ctsio->cdb;
10559	if ((cdb->byte2 & SGESN_POLLED) == 0) {
10560		ctl_set_invalid_field(ctsio, /*sks_valid*/ 1, /*command*/ 1,
10561		    /*field*/ 1, /*bit_valid*/ 1, /*bit*/ 0);
10562		ctl_done((union ctl_io *)ctsio);
10563		return (CTL_RETVAL_COMPLETE);
10564	}
10565	notif_class = cdb->notif_class;
10566	alloc_len = scsi_2btoul(cdb->length);
10567
10568	data_len = sizeof(struct scsi_get_event_status_header);
10569	ctsio->kern_data_ptr = malloc(data_len, M_CTL, M_WAITOK | M_ZERO);
10570	ctsio->kern_sg_entries = 0;
10571	ctsio->kern_data_resid = 0;
10572	ctsio->kern_rel_offset = 0;
10573
10574	if (data_len < alloc_len) {
10575		ctsio->residual = alloc_len - data_len;
10576		ctsio->kern_data_len = data_len;
10577		ctsio->kern_total_len = data_len;
10578	} else {
10579		ctsio->residual = 0;
10580		ctsio->kern_data_len = alloc_len;
10581		ctsio->kern_total_len = alloc_len;
10582	}
10583
10584	hdr = (struct scsi_get_event_status_header *)ctsio->kern_data_ptr;
10585	scsi_ulto2b(0, hdr->descr_length);
10586	hdr->nea_class = SGESN_NEA;
10587	hdr->supported_class = 0;
10588
10589	ctl_set_success(ctsio);
10590	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
10591	ctsio->be_move_done = ctl_config_move_done;
10592	ctl_datamove((union ctl_io *)ctsio);
10593	return (CTL_RETVAL_COMPLETE);
10594}
10595
10596int
10597ctl_mechanism_status(struct ctl_scsiio *ctsio)
10598{
10599	struct scsi_mechanism_status_header *hdr;
10600	struct scsi_mechanism_status *cdb;
10601	struct ctl_lun *lun;
10602	uint32_t alloc_len, data_len;
10603
10604	lun = ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
10605	cdb = (struct scsi_mechanism_status *)ctsio->cdb;
10606	alloc_len = scsi_2btoul(cdb->length);
10607
10608	data_len = sizeof(struct scsi_mechanism_status_header);
10609	ctsio->kern_data_ptr = malloc(data_len, M_CTL, M_WAITOK | M_ZERO);
10610	ctsio->kern_sg_entries = 0;
10611	ctsio->kern_data_resid = 0;
10612	ctsio->kern_rel_offset = 0;
10613
10614	if (data_len < alloc_len) {
10615		ctsio->residual = alloc_len - data_len;
10616		ctsio->kern_data_len = data_len;
10617		ctsio->kern_total_len = data_len;
10618	} else {
10619		ctsio->residual = 0;
10620		ctsio->kern_data_len = alloc_len;
10621		ctsio->kern_total_len = alloc_len;
10622	}
10623
10624	hdr = (struct scsi_mechanism_status_header *)ctsio->kern_data_ptr;
10625	hdr->state1 = 0x00;
10626	hdr->state2 = 0xe0;
10627	scsi_ulto3b(0, hdr->lba);
10628	hdr->slots_num = 0;
10629	scsi_ulto2b(0, hdr->slots_length);
10630
10631	ctl_set_success(ctsio);
10632	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
10633	ctsio->be_move_done = ctl_config_move_done;
10634	ctl_datamove((union ctl_io *)ctsio);
10635	return (CTL_RETVAL_COMPLETE);
10636}
10637
10638static void
10639ctl_ultomsf(uint32_t lba, uint8_t *buf)
10640{
10641
10642	lba += 150;
10643	buf[0] = 0;
10644	buf[1] = bin2bcd((lba / 75) / 60);
10645	buf[2] = bin2bcd((lba / 75) % 60);
10646	buf[3] = bin2bcd(lba % 75);
10647}
10648
10649int
10650ctl_read_toc(struct ctl_scsiio *ctsio)
10651{
10652	struct scsi_read_toc_hdr *hdr;
10653	struct scsi_read_toc_type01_descr *descr;
10654	struct scsi_read_toc *cdb;
10655	struct ctl_lun *lun;
10656	uint32_t alloc_len, data_len;
10657	int format, msf;
10658
10659	lun = ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
10660	cdb = (struct scsi_read_toc *)ctsio->cdb;
10661	msf = (cdb->byte2 & CD_MSF) != 0;
10662	format = cdb->format;
10663	alloc_len = scsi_2btoul(cdb->data_len);
10664
10665	data_len = sizeof(struct scsi_read_toc_hdr);
10666	if (format == 0)
10667		data_len += 2 * sizeof(struct scsi_read_toc_type01_descr);
10668	else
10669		data_len += sizeof(struct scsi_read_toc_type01_descr);
10670	ctsio->kern_data_ptr = malloc(data_len, M_CTL, M_WAITOK | M_ZERO);
10671	ctsio->kern_sg_entries = 0;
10672	ctsio->kern_data_resid = 0;
10673	ctsio->kern_rel_offset = 0;
10674
10675	if (data_len < alloc_len) {
10676		ctsio->residual = alloc_len - data_len;
10677		ctsio->kern_data_len = data_len;
10678		ctsio->kern_total_len = data_len;
10679	} else {
10680		ctsio->residual = 0;
10681		ctsio->kern_data_len = alloc_len;
10682		ctsio->kern_total_len = alloc_len;
10683	}
10684
10685	hdr = (struct scsi_read_toc_hdr *)ctsio->kern_data_ptr;
10686	if (format == 0) {
10687		scsi_ulto2b(0x12, hdr->data_length);
10688		hdr->first = 1;
10689		hdr->last = 1;
10690		descr = (struct scsi_read_toc_type01_descr *)(hdr + 1);
10691		descr->addr_ctl = 0x14;
10692		descr->track_number = 1;
10693		if (msf)
10694			ctl_ultomsf(0, descr->track_start);
10695		else
10696			scsi_ulto4b(0, descr->track_start);
10697		descr++;
10698		descr->addr_ctl = 0x14;
10699		descr->track_number = 0xaa;
10700		if (msf)
10701			ctl_ultomsf(lun->be_lun->maxlba+1, descr->track_start);
10702		else
10703			scsi_ulto4b(lun->be_lun->maxlba+1, descr->track_start);
10704	} else {
10705		scsi_ulto2b(0x0a, hdr->data_length);
10706		hdr->first = 1;
10707		hdr->last = 1;
10708		descr = (struct scsi_read_toc_type01_descr *)(hdr + 1);
10709		descr->addr_ctl = 0x14;
10710		descr->track_number = 1;
10711		if (msf)
10712			ctl_ultomsf(0, descr->track_start);
10713		else
10714			scsi_ulto4b(0, descr->track_start);
10715	}
10716
10717	ctl_set_success(ctsio);
10718	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
10719	ctsio->be_move_done = ctl_config_move_done;
10720	ctl_datamove((union ctl_io *)ctsio);
10721	return (CTL_RETVAL_COMPLETE);
10722}
10723
10724/*
10725 * For known CDB types, parse the LBA and length.
10726 */
10727static int
10728ctl_get_lba_len(union ctl_io *io, uint64_t *lba, uint64_t *len)
10729{
10730	if (io->io_hdr.io_type != CTL_IO_SCSI)
10731		return (1);
10732
10733	switch (io->scsiio.cdb[0]) {
10734	case COMPARE_AND_WRITE: {
10735		struct scsi_compare_and_write *cdb;
10736
10737		cdb = (struct scsi_compare_and_write *)io->scsiio.cdb;
10738
10739		*lba = scsi_8btou64(cdb->addr);
10740		*len = cdb->length;
10741		break;
10742	}
10743	case READ_6:
10744	case WRITE_6: {
10745		struct scsi_rw_6 *cdb;
10746
10747		cdb = (struct scsi_rw_6 *)io->scsiio.cdb;
10748
10749		*lba = scsi_3btoul(cdb->addr);
10750		/* only 5 bits are valid in the most significant address byte */
10751		*lba &= 0x1fffff;
10752		*len = cdb->length;
10753		break;
10754	}
10755	case READ_10:
10756	case WRITE_10: {
10757		struct scsi_rw_10 *cdb;
10758
10759		cdb = (struct scsi_rw_10 *)io->scsiio.cdb;
10760
10761		*lba = scsi_4btoul(cdb->addr);
10762		*len = scsi_2btoul(cdb->length);
10763		break;
10764	}
10765	case WRITE_VERIFY_10: {
10766		struct scsi_write_verify_10 *cdb;
10767
10768		cdb = (struct scsi_write_verify_10 *)io->scsiio.cdb;
10769
10770		*lba = scsi_4btoul(cdb->addr);
10771		*len = scsi_2btoul(cdb->length);
10772		break;
10773	}
10774	case READ_12:
10775	case WRITE_12: {
10776		struct scsi_rw_12 *cdb;
10777
10778		cdb = (struct scsi_rw_12 *)io->scsiio.cdb;
10779
10780		*lba = scsi_4btoul(cdb->addr);
10781		*len = scsi_4btoul(cdb->length);
10782		break;
10783	}
10784	case WRITE_VERIFY_12: {
10785		struct scsi_write_verify_12 *cdb;
10786
10787		cdb = (struct scsi_write_verify_12 *)io->scsiio.cdb;
10788
10789		*lba = scsi_4btoul(cdb->addr);
10790		*len = scsi_4btoul(cdb->length);
10791		break;
10792	}
10793	case READ_16:
10794	case WRITE_16: {
10795		struct scsi_rw_16 *cdb;
10796
10797		cdb = (struct scsi_rw_16 *)io->scsiio.cdb;
10798
10799		*lba = scsi_8btou64(cdb->addr);
10800		*len = scsi_4btoul(cdb->length);
10801		break;
10802	}
10803	case WRITE_ATOMIC_16: {
10804		struct scsi_write_atomic_16 *cdb;
10805
10806		cdb = (struct scsi_write_atomic_16 *)io->scsiio.cdb;
10807
10808		*lba = scsi_8btou64(cdb->addr);
10809		*len = scsi_2btoul(cdb->length);
10810		break;
10811	}
10812	case WRITE_VERIFY_16: {
10813		struct scsi_write_verify_16 *cdb;
10814
10815		cdb = (struct scsi_write_verify_16 *)io->scsiio.cdb;
10816
10817		*lba = scsi_8btou64(cdb->addr);
10818		*len = scsi_4btoul(cdb->length);
10819		break;
10820	}
10821	case WRITE_SAME_10: {
10822		struct scsi_write_same_10 *cdb;
10823
10824		cdb = (struct scsi_write_same_10 *)io->scsiio.cdb;
10825
10826		*lba = scsi_4btoul(cdb->addr);
10827		*len = scsi_2btoul(cdb->length);
10828		break;
10829	}
10830	case WRITE_SAME_16: {
10831		struct scsi_write_same_16 *cdb;
10832
10833		cdb = (struct scsi_write_same_16 *)io->scsiio.cdb;
10834
10835		*lba = scsi_8btou64(cdb->addr);
10836		*len = scsi_4btoul(cdb->length);
10837		break;
10838	}
10839	case VERIFY_10: {
10840		struct scsi_verify_10 *cdb;
10841
10842		cdb = (struct scsi_verify_10 *)io->scsiio.cdb;
10843
10844		*lba = scsi_4btoul(cdb->addr);
10845		*len = scsi_2btoul(cdb->length);
10846		break;
10847	}
10848	case VERIFY_12: {
10849		struct scsi_verify_12 *cdb;
10850
10851		cdb = (struct scsi_verify_12 *)io->scsiio.cdb;
10852
10853		*lba = scsi_4btoul(cdb->addr);
10854		*len = scsi_4btoul(cdb->length);
10855		break;
10856	}
10857	case VERIFY_16: {
10858		struct scsi_verify_16 *cdb;
10859
10860		cdb = (struct scsi_verify_16 *)io->scsiio.cdb;
10861
10862		*lba = scsi_8btou64(cdb->addr);
10863		*len = scsi_4btoul(cdb->length);
10864		break;
10865	}
10866	case UNMAP: {
10867		*lba = 0;
10868		*len = UINT64_MAX;
10869		break;
10870	}
10871	case SERVICE_ACTION_IN: {	/* GET LBA STATUS */
10872		struct scsi_get_lba_status *cdb;
10873
10874		cdb = (struct scsi_get_lba_status *)io->scsiio.cdb;
10875		*lba = scsi_8btou64(cdb->addr);
10876		*len = UINT32_MAX;
10877		break;
10878	}
10879	default:
10880		return (1);
10881		break; /* NOTREACHED */
10882	}
10883
10884	return (0);
10885}
10886
10887static ctl_action
10888ctl_extent_check_lba(uint64_t lba1, uint64_t len1, uint64_t lba2, uint64_t len2,
10889    bool seq)
10890{
10891	uint64_t endlba1, endlba2;
10892
10893	endlba1 = lba1 + len1 - (seq ? 0 : 1);
10894	endlba2 = lba2 + len2 - 1;
10895
10896	if ((endlba1 < lba2) || (endlba2 < lba1))
10897		return (CTL_ACTION_PASS);
10898	else
10899		return (CTL_ACTION_BLOCK);
10900}
10901
10902static int
10903ctl_extent_check_unmap(union ctl_io *io, uint64_t lba2, uint64_t len2)
10904{
10905	struct ctl_ptr_len_flags *ptrlen;
10906	struct scsi_unmap_desc *buf, *end, *range;
10907	uint64_t lba;
10908	uint32_t len;
10909
10910	/* If not UNMAP -- go other way. */
10911	if (io->io_hdr.io_type != CTL_IO_SCSI ||
10912	    io->scsiio.cdb[0] != UNMAP)
10913		return (CTL_ACTION_ERROR);
10914
10915	/* If UNMAP without data -- block and wait for data. */
10916	ptrlen = (struct ctl_ptr_len_flags *)
10917	    &io->io_hdr.ctl_private[CTL_PRIV_LBA_LEN];
10918	if ((io->io_hdr.flags & CTL_FLAG_ALLOCATED) == 0 ||
10919	    ptrlen->ptr == NULL)
10920		return (CTL_ACTION_BLOCK);
10921
10922	/* UNMAP with data -- check for collision. */
10923	buf = (struct scsi_unmap_desc *)ptrlen->ptr;
10924	end = buf + ptrlen->len / sizeof(*buf);
10925	for (range = buf; range < end; range++) {
10926		lba = scsi_8btou64(range->lba);
10927		len = scsi_4btoul(range->length);
10928		if ((lba < lba2 + len2) && (lba + len > lba2))
10929			return (CTL_ACTION_BLOCK);
10930	}
10931	return (CTL_ACTION_PASS);
10932}
10933
10934static ctl_action
10935ctl_extent_check(union ctl_io *io1, union ctl_io *io2, bool seq)
10936{
10937	uint64_t lba1, lba2;
10938	uint64_t len1, len2;
10939	int retval;
10940
10941	if (ctl_get_lba_len(io2, &lba2, &len2) != 0)
10942		return (CTL_ACTION_ERROR);
10943
10944	retval = ctl_extent_check_unmap(io1, lba2, len2);
10945	if (retval != CTL_ACTION_ERROR)
10946		return (retval);
10947
10948	if (ctl_get_lba_len(io1, &lba1, &len1) != 0)
10949		return (CTL_ACTION_ERROR);
10950
10951	if (io1->io_hdr.flags & CTL_FLAG_SERSEQ_DONE)
10952		seq = FALSE;
10953	return (ctl_extent_check_lba(lba1, len1, lba2, len2, seq));
10954}
10955
10956static ctl_action
10957ctl_extent_check_seq(union ctl_io *io1, union ctl_io *io2)
10958{
10959	uint64_t lba1, lba2;
10960	uint64_t len1, len2;
10961
10962	if (io1->io_hdr.flags & CTL_FLAG_SERSEQ_DONE)
10963		return (CTL_ACTION_PASS);
10964	if (ctl_get_lba_len(io1, &lba1, &len1) != 0)
10965		return (CTL_ACTION_ERROR);
10966	if (ctl_get_lba_len(io2, &lba2, &len2) != 0)
10967		return (CTL_ACTION_ERROR);
10968
10969	if (lba1 + len1 == lba2)
10970		return (CTL_ACTION_BLOCK);
10971	return (CTL_ACTION_PASS);
10972}
10973
10974static ctl_action
10975ctl_check_for_blockage(struct ctl_lun *lun, union ctl_io *pending_io,
10976    union ctl_io *ooa_io)
10977{
10978	const struct ctl_cmd_entry *pending_entry, *ooa_entry;
10979	const ctl_serialize_action *serialize_row;
10980
10981	/*
10982	 * The initiator attempted multiple untagged commands at the same
10983	 * time.  Can't do that.
10984	 */
10985	if ((pending_io->scsiio.tag_type == CTL_TAG_UNTAGGED)
10986	 && (ooa_io->scsiio.tag_type == CTL_TAG_UNTAGGED)
10987	 && ((pending_io->io_hdr.nexus.targ_port ==
10988	      ooa_io->io_hdr.nexus.targ_port)
10989	  && (pending_io->io_hdr.nexus.initid ==
10990	      ooa_io->io_hdr.nexus.initid))
10991	 && ((ooa_io->io_hdr.flags & (CTL_FLAG_ABORT |
10992	      CTL_FLAG_STATUS_SENT)) == 0))
10993		return (CTL_ACTION_OVERLAP);
10994
10995	/*
10996	 * The initiator attempted to send multiple tagged commands with
10997	 * the same ID.  (It's fine if different initiators have the same
10998	 * tag ID.)
10999	 *
11000	 * Even if all of those conditions are true, we don't kill the I/O
11001	 * if the command ahead of us has been aborted.  We won't end up
11002	 * sending it to the FETD, and it's perfectly legal to resend a
11003	 * command with the same tag number as long as the previous
11004	 * instance of this tag number has been aborted somehow.
11005	 */
11006	if ((pending_io->scsiio.tag_type != CTL_TAG_UNTAGGED)
11007	 && (ooa_io->scsiio.tag_type != CTL_TAG_UNTAGGED)
11008	 && (pending_io->scsiio.tag_num == ooa_io->scsiio.tag_num)
11009	 && ((pending_io->io_hdr.nexus.targ_port ==
11010	      ooa_io->io_hdr.nexus.targ_port)
11011	  && (pending_io->io_hdr.nexus.initid ==
11012	      ooa_io->io_hdr.nexus.initid))
11013	 && ((ooa_io->io_hdr.flags & (CTL_FLAG_ABORT |
11014	      CTL_FLAG_STATUS_SENT)) == 0))
11015		return (CTL_ACTION_OVERLAP_TAG);
11016
11017	/*
11018	 * If we get a head of queue tag, SAM-3 says that we should
11019	 * immediately execute it.
11020	 *
11021	 * What happens if this command would normally block for some other
11022	 * reason?  e.g. a request sense with a head of queue tag
11023	 * immediately after a write.  Normally that would block, but this
11024	 * will result in its getting executed immediately...
11025	 *
11026	 * We currently return "pass" instead of "skip", so we'll end up
11027	 * going through the rest of the queue to check for overlapped tags.
11028	 *
11029	 * XXX KDM check for other types of blockage first??
11030	 */
11031	if (pending_io->scsiio.tag_type == CTL_TAG_HEAD_OF_QUEUE)
11032		return (CTL_ACTION_PASS);
11033
11034	/*
11035	 * Ordered tags have to block until all items ahead of them
11036	 * have completed.  If we get called with an ordered tag, we always
11037	 * block, if something else is ahead of us in the queue.
11038	 */
11039	if (pending_io->scsiio.tag_type == CTL_TAG_ORDERED)
11040		return (CTL_ACTION_BLOCK);
11041
11042	/*
11043	 * Simple tags get blocked until all head of queue and ordered tags
11044	 * ahead of them have completed.  I'm lumping untagged commands in
11045	 * with simple tags here.  XXX KDM is that the right thing to do?
11046	 */
11047	if (((pending_io->scsiio.tag_type == CTL_TAG_UNTAGGED)
11048	  || (pending_io->scsiio.tag_type == CTL_TAG_SIMPLE))
11049	 && ((ooa_io->scsiio.tag_type == CTL_TAG_HEAD_OF_QUEUE)
11050	  || (ooa_io->scsiio.tag_type == CTL_TAG_ORDERED)))
11051		return (CTL_ACTION_BLOCK);
11052
11053	pending_entry = ctl_get_cmd_entry(&pending_io->scsiio, NULL);
11054	KASSERT(pending_entry->seridx < CTL_SERIDX_COUNT,
11055	    ("%s: Invalid seridx %d for pending CDB %02x %02x @ %p",
11056	     __func__, pending_entry->seridx, pending_io->scsiio.cdb[0],
11057	     pending_io->scsiio.cdb[1], pending_io));
11058	ooa_entry = ctl_get_cmd_entry(&ooa_io->scsiio, NULL);
11059	if (ooa_entry->seridx == CTL_SERIDX_INVLD)
11060		return (CTL_ACTION_PASS); /* Unsupported command in OOA queue */
11061	KASSERT(ooa_entry->seridx < CTL_SERIDX_COUNT,
11062	    ("%s: Invalid seridx %d for ooa CDB %02x %02x @ %p",
11063	     __func__, ooa_entry->seridx, ooa_io->scsiio.cdb[0],
11064	     ooa_io->scsiio.cdb[1], ooa_io));
11065
11066	serialize_row = ctl_serialize_table[ooa_entry->seridx];
11067
11068	switch (serialize_row[pending_entry->seridx]) {
11069	case CTL_SER_BLOCK:
11070		return (CTL_ACTION_BLOCK);
11071	case CTL_SER_EXTENT:
11072		return (ctl_extent_check(ooa_io, pending_io,
11073		    (lun->be_lun && lun->be_lun->serseq == CTL_LUN_SERSEQ_ON)));
11074	case CTL_SER_EXTENTOPT:
11075		if ((lun->MODE_CTRL.queue_flags & SCP_QUEUE_ALG_MASK) !=
11076		    SCP_QUEUE_ALG_UNRESTRICTED)
11077			return (ctl_extent_check(ooa_io, pending_io,
11078			    (lun->be_lun &&
11079			     lun->be_lun->serseq == CTL_LUN_SERSEQ_ON)));
11080		return (CTL_ACTION_PASS);
11081	case CTL_SER_EXTENTSEQ:
11082		if (lun->be_lun && lun->be_lun->serseq != CTL_LUN_SERSEQ_OFF)
11083			return (ctl_extent_check_seq(ooa_io, pending_io));
11084		return (CTL_ACTION_PASS);
11085	case CTL_SER_PASS:
11086		return (CTL_ACTION_PASS);
11087	case CTL_SER_BLOCKOPT:
11088		if ((lun->MODE_CTRL.queue_flags & SCP_QUEUE_ALG_MASK) !=
11089		    SCP_QUEUE_ALG_UNRESTRICTED)
11090			return (CTL_ACTION_BLOCK);
11091		return (CTL_ACTION_PASS);
11092	case CTL_SER_SKIP:
11093		return (CTL_ACTION_SKIP);
11094	default:
11095		panic("%s: Invalid serialization value %d for %d => %d",
11096		    __func__, serialize_row[pending_entry->seridx],
11097		    pending_entry->seridx, ooa_entry->seridx);
11098	}
11099
11100	return (CTL_ACTION_ERROR);
11101}
11102
11103/*
11104 * Check for blockage or overlaps against the OOA (Order Of Arrival) queue.
11105 * Assumptions:
11106 * - pending_io is generally either incoming, or on the blocked queue
11107 * - starting I/O is the I/O we want to start the check with.
11108 */
11109static ctl_action
11110ctl_check_ooa(struct ctl_lun *lun, union ctl_io *pending_io,
11111	      union ctl_io *starting_io)
11112{
11113	union ctl_io *ooa_io;
11114	ctl_action action;
11115
11116	mtx_assert(&lun->lun_lock, MA_OWNED);
11117
11118	/*
11119	 * Run back along the OOA queue, starting with the current
11120	 * blocked I/O and going through every I/O before it on the
11121	 * queue.  If starting_io is NULL, we'll just end up returning
11122	 * CTL_ACTION_PASS.
11123	 */
11124	for (ooa_io = starting_io; ooa_io != NULL;
11125	     ooa_io = (union ctl_io *)TAILQ_PREV(&ooa_io->io_hdr, ctl_ooaq,
11126	     ooa_links)){
11127
11128		/*
11129		 * This routine just checks to see whether
11130		 * cur_blocked is blocked by ooa_io, which is ahead
11131		 * of it in the queue.  It doesn't queue/dequeue
11132		 * cur_blocked.
11133		 */
11134		action = ctl_check_for_blockage(lun, pending_io, ooa_io);
11135		switch (action) {
11136		case CTL_ACTION_BLOCK:
11137		case CTL_ACTION_OVERLAP:
11138		case CTL_ACTION_OVERLAP_TAG:
11139		case CTL_ACTION_SKIP:
11140		case CTL_ACTION_ERROR:
11141			return (action);
11142			break; /* NOTREACHED */
11143		case CTL_ACTION_PASS:
11144			break;
11145		default:
11146			panic("%s: Invalid action %d\n", __func__, action);
11147		}
11148	}
11149
11150	return (CTL_ACTION_PASS);
11151}
11152
11153/*
11154 * Assumptions:
11155 * - An I/O has just completed, and has been removed from the per-LUN OOA
11156 *   queue, so some items on the blocked queue may now be unblocked.
11157 */
11158static int
11159ctl_check_blocked(struct ctl_lun *lun)
11160{
11161	struct ctl_softc *softc = lun->ctl_softc;
11162	union ctl_io *cur_blocked, *next_blocked;
11163
11164	mtx_assert(&lun->lun_lock, MA_OWNED);
11165
11166	/*
11167	 * Run forward from the head of the blocked queue, checking each
11168	 * entry against the I/Os prior to it on the OOA queue to see if
11169	 * there is still any blockage.
11170	 *
11171	 * We cannot use the TAILQ_FOREACH() macro, because it can't deal
11172	 * with our removing a variable on it while it is traversing the
11173	 * list.
11174	 */
11175	for (cur_blocked = (union ctl_io *)TAILQ_FIRST(&lun->blocked_queue);
11176	     cur_blocked != NULL; cur_blocked = next_blocked) {
11177		union ctl_io *prev_ooa;
11178		ctl_action action;
11179
11180		next_blocked = (union ctl_io *)TAILQ_NEXT(&cur_blocked->io_hdr,
11181							  blocked_links);
11182
11183		prev_ooa = (union ctl_io *)TAILQ_PREV(&cur_blocked->io_hdr,
11184						      ctl_ooaq, ooa_links);
11185
11186		/*
11187		 * If cur_blocked happens to be the first item in the OOA
11188		 * queue now, prev_ooa will be NULL, and the action
11189		 * returned will just be CTL_ACTION_PASS.
11190		 */
11191		action = ctl_check_ooa(lun, cur_blocked, prev_ooa);
11192
11193		switch (action) {
11194		case CTL_ACTION_BLOCK:
11195			/* Nothing to do here, still blocked */
11196			break;
11197		case CTL_ACTION_OVERLAP:
11198		case CTL_ACTION_OVERLAP_TAG:
11199			/*
11200			 * This shouldn't happen!  In theory we've already
11201			 * checked this command for overlap...
11202			 */
11203			break;
11204		case CTL_ACTION_PASS:
11205		case CTL_ACTION_SKIP: {
11206			const struct ctl_cmd_entry *entry;
11207
11208			/*
11209			 * The skip case shouldn't happen, this transaction
11210			 * should have never made it onto the blocked queue.
11211			 */
11212			/*
11213			 * This I/O is no longer blocked, we can remove it
11214			 * from the blocked queue.  Since this is a TAILQ
11215			 * (doubly linked list), we can do O(1) removals
11216			 * from any place on the list.
11217			 */
11218			TAILQ_REMOVE(&lun->blocked_queue, &cur_blocked->io_hdr,
11219				     blocked_links);
11220			cur_blocked->io_hdr.flags &= ~CTL_FLAG_BLOCKED;
11221
11222			if ((softc->ha_mode != CTL_HA_MODE_XFER) &&
11223			    (cur_blocked->io_hdr.flags & CTL_FLAG_FROM_OTHER_SC)){
11224				/*
11225				 * Need to send IO back to original side to
11226				 * run
11227				 */
11228				union ctl_ha_msg msg_info;
11229
11230				cur_blocked->io_hdr.flags &= ~CTL_FLAG_IO_ACTIVE;
11231				msg_info.hdr.original_sc =
11232					cur_blocked->io_hdr.original_sc;
11233				msg_info.hdr.serializing_sc = cur_blocked;
11234				msg_info.hdr.msg_type = CTL_MSG_R2R;
11235				ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg_info,
11236				    sizeof(msg_info.hdr), M_NOWAIT);
11237				break;
11238			}
11239			entry = ctl_get_cmd_entry(&cur_blocked->scsiio, NULL);
11240
11241			/*
11242			 * Check this I/O for LUN state changes that may
11243			 * have happened while this command was blocked.
11244			 * The LUN state may have been changed by a command
11245			 * ahead of us in the queue, so we need to re-check
11246			 * for any states that can be caused by SCSI
11247			 * commands.
11248			 */
11249			if (ctl_scsiio_lun_check(lun, entry,
11250						 &cur_blocked->scsiio) == 0) {
11251				cur_blocked->io_hdr.flags |=
11252				                      CTL_FLAG_IS_WAS_ON_RTR;
11253				ctl_enqueue_rtr(cur_blocked);
11254			} else
11255				ctl_done(cur_blocked);
11256			break;
11257		}
11258		default:
11259			/*
11260			 * This probably shouldn't happen -- we shouldn't
11261			 * get CTL_ACTION_ERROR, or anything else.
11262			 */
11263			break;
11264		}
11265	}
11266
11267	return (CTL_RETVAL_COMPLETE);
11268}
11269
11270/*
11271 * This routine (with one exception) checks LUN flags that can be set by
11272 * commands ahead of us in the OOA queue.  These flags have to be checked
11273 * when a command initially comes in, and when we pull a command off the
11274 * blocked queue and are preparing to execute it.  The reason we have to
11275 * check these flags for commands on the blocked queue is that the LUN
11276 * state may have been changed by a command ahead of us while we're on the
11277 * blocked queue.
11278 *
11279 * Ordering is somewhat important with these checks, so please pay
11280 * careful attention to the placement of any new checks.
11281 */
11282static int
11283ctl_scsiio_lun_check(struct ctl_lun *lun,
11284    const struct ctl_cmd_entry *entry, struct ctl_scsiio *ctsio)
11285{
11286	struct ctl_softc *softc = lun->ctl_softc;
11287	int retval;
11288	uint32_t residx;
11289
11290	retval = 0;
11291
11292	mtx_assert(&lun->lun_lock, MA_OWNED);
11293
11294	/*
11295	 * If this shelf is a secondary shelf controller, we may have to
11296	 * reject some commands disallowed by HA mode and link state.
11297	 */
11298	if ((lun->flags & CTL_LUN_PRIMARY_SC) == 0) {
11299		if (softc->ha_link == CTL_HA_LINK_OFFLINE &&
11300		    (entry->flags & CTL_CMD_FLAG_OK_ON_UNAVAIL) == 0) {
11301			ctl_set_lun_unavail(ctsio);
11302			retval = 1;
11303			goto bailout;
11304		}
11305		if ((lun->flags & CTL_LUN_PEER_SC_PRIMARY) == 0 &&
11306		    (entry->flags & CTL_CMD_FLAG_OK_ON_UNAVAIL) == 0) {
11307			ctl_set_lun_transit(ctsio);
11308			retval = 1;
11309			goto bailout;
11310		}
11311		if (softc->ha_mode == CTL_HA_MODE_ACT_STBY &&
11312		    (entry->flags & CTL_CMD_FLAG_OK_ON_STANDBY) == 0) {
11313			ctl_set_lun_standby(ctsio);
11314			retval = 1;
11315			goto bailout;
11316		}
11317
11318		/* The rest of checks are only done on executing side */
11319		if (softc->ha_mode == CTL_HA_MODE_XFER)
11320			goto bailout;
11321	}
11322
11323	if (entry->pattern & CTL_LUN_PAT_WRITE) {
11324		if (lun->be_lun &&
11325		    lun->be_lun->flags & CTL_LUN_FLAG_READONLY) {
11326			ctl_set_hw_write_protected(ctsio);
11327			retval = 1;
11328			goto bailout;
11329		}
11330		if ((lun->MODE_CTRL.eca_and_aen & SCP_SWP) != 0) {
11331			ctl_set_sense(ctsio, /*current_error*/ 1,
11332			    /*sense_key*/ SSD_KEY_DATA_PROTECT,
11333			    /*asc*/ 0x27, /*ascq*/ 0x02, SSD_ELEM_NONE);
11334			retval = 1;
11335			goto bailout;
11336		}
11337	}
11338
11339	/*
11340	 * Check for a reservation conflict.  If this command isn't allowed
11341	 * even on reserved LUNs, and if this initiator isn't the one who
11342	 * reserved us, reject the command with a reservation conflict.
11343	 */
11344	residx = ctl_get_initindex(&ctsio->io_hdr.nexus);
11345	if ((lun->flags & CTL_LUN_RESERVED)
11346	 && ((entry->flags & CTL_CMD_FLAG_ALLOW_ON_RESV) == 0)) {
11347		if (lun->res_idx != residx) {
11348			ctl_set_reservation_conflict(ctsio);
11349			retval = 1;
11350			goto bailout;
11351		}
11352	}
11353
11354	if ((lun->flags & CTL_LUN_PR_RESERVED) == 0 ||
11355	    (entry->flags & CTL_CMD_FLAG_ALLOW_ON_PR_RESV)) {
11356		/* No reservation or command is allowed. */;
11357	} else if ((entry->flags & CTL_CMD_FLAG_ALLOW_ON_PR_WRESV) &&
11358	    (lun->pr_res_type == SPR_TYPE_WR_EX ||
11359	     lun->pr_res_type == SPR_TYPE_WR_EX_RO ||
11360	     lun->pr_res_type == SPR_TYPE_WR_EX_AR)) {
11361		/* The command is allowed for Write Exclusive resv. */;
11362	} else {
11363		/*
11364		 * if we aren't registered or it's a res holder type
11365		 * reservation and this isn't the res holder then set a
11366		 * conflict.
11367		 */
11368		if (ctl_get_prkey(lun, residx) == 0 ||
11369		    (residx != lun->pr_res_idx && lun->pr_res_type < 4)) {
11370			ctl_set_reservation_conflict(ctsio);
11371			retval = 1;
11372			goto bailout;
11373		}
11374	}
11375
11376	if ((entry->flags & CTL_CMD_FLAG_OK_ON_NO_MEDIA) == 0) {
11377		if (lun->flags & CTL_LUN_EJECTED)
11378			ctl_set_lun_ejected(ctsio);
11379		else if (lun->flags & CTL_LUN_NO_MEDIA) {
11380			if (lun->flags & CTL_LUN_REMOVABLE)
11381				ctl_set_lun_no_media(ctsio);
11382			else
11383				ctl_set_lun_int_reqd(ctsio);
11384		} else if (lun->flags & CTL_LUN_STOPPED)
11385			ctl_set_lun_stopped(ctsio);
11386		else
11387			goto bailout;
11388		retval = 1;
11389		goto bailout;
11390	}
11391
11392bailout:
11393	return (retval);
11394}
11395
11396static void
11397ctl_failover_io(union ctl_io *io, int have_lock)
11398{
11399	ctl_set_busy(&io->scsiio);
11400	ctl_done(io);
11401}
11402
11403static void
11404ctl_failover_lun(union ctl_io *rio)
11405{
11406	struct ctl_softc *softc = control_softc;
11407	struct ctl_lun *lun;
11408	struct ctl_io_hdr *io, *next_io;
11409	uint32_t targ_lun;
11410
11411	targ_lun = rio->io_hdr.nexus.targ_mapped_lun;
11412	CTL_DEBUG_PRINT(("FAILOVER for lun %ju\n", targ_lun));
11413
11414	/* Find and lock the LUN. */
11415	mtx_lock(&softc->ctl_lock);
11416	if ((targ_lun < CTL_MAX_LUNS) &&
11417	    ((lun = softc->ctl_luns[targ_lun]) != NULL)) {
11418		mtx_lock(&lun->lun_lock);
11419		mtx_unlock(&softc->ctl_lock);
11420		if (lun->flags & CTL_LUN_DISABLED) {
11421			mtx_unlock(&lun->lun_lock);
11422			return;
11423		}
11424	} else {
11425		mtx_unlock(&softc->ctl_lock);
11426		return;
11427	}
11428
11429	if (softc->ha_mode == CTL_HA_MODE_XFER) {
11430		TAILQ_FOREACH_SAFE(io, &lun->ooa_queue, ooa_links, next_io) {
11431			/* We are master */
11432			if (io->flags & CTL_FLAG_FROM_OTHER_SC) {
11433				if (io->flags & CTL_FLAG_IO_ACTIVE) {
11434					io->flags |= CTL_FLAG_ABORT;
11435					io->flags |= CTL_FLAG_FAILOVER;
11436				} else { /* This can be only due to DATAMOVE */
11437					io->msg_type = CTL_MSG_DATAMOVE_DONE;
11438					io->flags &= ~CTL_FLAG_DMA_INPROG;
11439					io->flags |= CTL_FLAG_IO_ACTIVE;
11440					io->port_status = 31340;
11441					ctl_enqueue_isc((union ctl_io *)io);
11442				}
11443			}
11444			/* We are slave */
11445			if (io->flags & CTL_FLAG_SENT_2OTHER_SC) {
11446				io->flags &= ~CTL_FLAG_SENT_2OTHER_SC;
11447				if (io->flags & CTL_FLAG_IO_ACTIVE) {
11448					io->flags |= CTL_FLAG_FAILOVER;
11449				} else {
11450					ctl_set_busy(&((union ctl_io *)io)->
11451					    scsiio);
11452					ctl_done((union ctl_io *)io);
11453				}
11454			}
11455		}
11456	} else { /* SERIALIZE modes */
11457		TAILQ_FOREACH_SAFE(io, &lun->blocked_queue, blocked_links,
11458		    next_io) {
11459			/* We are master */
11460			if (io->flags & CTL_FLAG_FROM_OTHER_SC) {
11461				TAILQ_REMOVE(&lun->blocked_queue, io,
11462				    blocked_links);
11463				io->flags &= ~CTL_FLAG_BLOCKED;
11464				TAILQ_REMOVE(&lun->ooa_queue, io, ooa_links);
11465				ctl_free_io((union ctl_io *)io);
11466			}
11467		}
11468		TAILQ_FOREACH_SAFE(io, &lun->ooa_queue, ooa_links, next_io) {
11469			/* We are master */
11470			if (io->flags & CTL_FLAG_FROM_OTHER_SC) {
11471				TAILQ_REMOVE(&lun->ooa_queue, io, ooa_links);
11472				ctl_free_io((union ctl_io *)io);
11473			}
11474			/* We are slave */
11475			if (io->flags & CTL_FLAG_SENT_2OTHER_SC) {
11476				io->flags &= ~CTL_FLAG_SENT_2OTHER_SC;
11477				if (!(io->flags & CTL_FLAG_IO_ACTIVE)) {
11478					ctl_set_busy(&((union ctl_io *)io)->
11479					    scsiio);
11480					ctl_done((union ctl_io *)io);
11481				}
11482			}
11483		}
11484		ctl_check_blocked(lun);
11485	}
11486	mtx_unlock(&lun->lun_lock);
11487}
11488
11489static int
11490ctl_scsiio_precheck(struct ctl_softc *softc, struct ctl_scsiio *ctsio)
11491{
11492	struct ctl_lun *lun;
11493	const struct ctl_cmd_entry *entry;
11494	uint32_t initidx, targ_lun;
11495	int retval;
11496
11497	retval = 0;
11498
11499	lun = NULL;
11500
11501	targ_lun = ctsio->io_hdr.nexus.targ_mapped_lun;
11502	if ((targ_lun < CTL_MAX_LUNS)
11503	 && ((lun = softc->ctl_luns[targ_lun]) != NULL)) {
11504		/*
11505		 * If the LUN is invalid, pretend that it doesn't exist.
11506		 * It will go away as soon as all pending I/O has been
11507		 * completed.
11508		 */
11509		mtx_lock(&lun->lun_lock);
11510		if (lun->flags & CTL_LUN_DISABLED) {
11511			mtx_unlock(&lun->lun_lock);
11512			lun = NULL;
11513			ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr = NULL;
11514			ctsio->io_hdr.ctl_private[CTL_PRIV_BACKEND_LUN].ptr = NULL;
11515		} else {
11516			ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr = lun;
11517			ctsio->io_hdr.ctl_private[CTL_PRIV_BACKEND_LUN].ptr =
11518				lun->be_lun;
11519
11520			/*
11521			 * Every I/O goes into the OOA queue for a
11522			 * particular LUN, and stays there until completion.
11523			 */
11524#ifdef CTL_TIME_IO
11525			if (TAILQ_EMPTY(&lun->ooa_queue)) {
11526				lun->idle_time += getsbinuptime() -
11527				    lun->last_busy;
11528			}
11529#endif
11530			TAILQ_INSERT_TAIL(&lun->ooa_queue, &ctsio->io_hdr,
11531			    ooa_links);
11532		}
11533	} else {
11534		ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr = NULL;
11535		ctsio->io_hdr.ctl_private[CTL_PRIV_BACKEND_LUN].ptr = NULL;
11536	}
11537
11538	/* Get command entry and return error if it is unsuppotyed. */
11539	entry = ctl_validate_command(ctsio);
11540	if (entry == NULL) {
11541		if (lun)
11542			mtx_unlock(&lun->lun_lock);
11543		return (retval);
11544	}
11545
11546	ctsio->io_hdr.flags &= ~CTL_FLAG_DATA_MASK;
11547	ctsio->io_hdr.flags |= entry->flags & CTL_FLAG_DATA_MASK;
11548
11549	/*
11550	 * Check to see whether we can send this command to LUNs that don't
11551	 * exist.  This should pretty much only be the case for inquiry
11552	 * and request sense.  Further checks, below, really require having
11553	 * a LUN, so we can't really check the command anymore.  Just put
11554	 * it on the rtr queue.
11555	 */
11556	if (lun == NULL) {
11557		if (entry->flags & CTL_CMD_FLAG_OK_ON_NO_LUN) {
11558			ctsio->io_hdr.flags |= CTL_FLAG_IS_WAS_ON_RTR;
11559			ctl_enqueue_rtr((union ctl_io *)ctsio);
11560			return (retval);
11561		}
11562
11563		ctl_set_unsupported_lun(ctsio);
11564		ctl_done((union ctl_io *)ctsio);
11565		CTL_DEBUG_PRINT(("ctl_scsiio_precheck: bailing out due to invalid LUN\n"));
11566		return (retval);
11567	} else {
11568		/*
11569		 * Make sure we support this particular command on this LUN.
11570		 * e.g., we don't support writes to the control LUN.
11571		 */
11572		if (!ctl_cmd_applicable(lun->be_lun->lun_type, entry)) {
11573			mtx_unlock(&lun->lun_lock);
11574			ctl_set_invalid_opcode(ctsio);
11575			ctl_done((union ctl_io *)ctsio);
11576			return (retval);
11577		}
11578	}
11579
11580	initidx = ctl_get_initindex(&ctsio->io_hdr.nexus);
11581
11582#ifdef CTL_WITH_CA
11583	/*
11584	 * If we've got a request sense, it'll clear the contingent
11585	 * allegiance condition.  Otherwise, if we have a CA condition for
11586	 * this initiator, clear it, because it sent down a command other
11587	 * than request sense.
11588	 */
11589	if ((ctsio->cdb[0] != REQUEST_SENSE)
11590	 && (ctl_is_set(lun->have_ca, initidx)))
11591		ctl_clear_mask(lun->have_ca, initidx);
11592#endif
11593
11594	/*
11595	 * If the command has this flag set, it handles its own unit
11596	 * attention reporting, we shouldn't do anything.  Otherwise we
11597	 * check for any pending unit attentions, and send them back to the
11598	 * initiator.  We only do this when a command initially comes in,
11599	 * not when we pull it off the blocked queue.
11600	 *
11601	 * According to SAM-3, section 5.3.2, the order that things get
11602	 * presented back to the host is basically unit attentions caused
11603	 * by some sort of reset event, busy status, reservation conflicts
11604	 * or task set full, and finally any other status.
11605	 *
11606	 * One issue here is that some of the unit attentions we report
11607	 * don't fall into the "reset" category (e.g. "reported luns data
11608	 * has changed").  So reporting it here, before the reservation
11609	 * check, may be technically wrong.  I guess the only thing to do
11610	 * would be to check for and report the reset events here, and then
11611	 * check for the other unit attention types after we check for a
11612	 * reservation conflict.
11613	 *
11614	 * XXX KDM need to fix this
11615	 */
11616	if ((entry->flags & CTL_CMD_FLAG_NO_SENSE) == 0) {
11617		ctl_ua_type ua_type;
11618
11619		ua_type = ctl_build_ua(lun, initidx, &ctsio->sense_data,
11620		    SSD_TYPE_NONE);
11621		if (ua_type != CTL_UA_NONE) {
11622			mtx_unlock(&lun->lun_lock);
11623			ctsio->scsi_status = SCSI_STATUS_CHECK_COND;
11624			ctsio->io_hdr.status = CTL_SCSI_ERROR | CTL_AUTOSENSE;
11625			ctsio->sense_len = SSD_FULL_SIZE;
11626			ctl_done((union ctl_io *)ctsio);
11627			return (retval);
11628		}
11629	}
11630
11631
11632	if (ctl_scsiio_lun_check(lun, entry, ctsio) != 0) {
11633		mtx_unlock(&lun->lun_lock);
11634		ctl_done((union ctl_io *)ctsio);
11635		return (retval);
11636	}
11637
11638	/*
11639	 * XXX CHD this is where we want to send IO to other side if
11640	 * this LUN is secondary on this SC. We will need to make a copy
11641	 * of the IO and flag the IO on this side as SENT_2OTHER and the flag
11642	 * the copy we send as FROM_OTHER.
11643	 * We also need to stuff the address of the original IO so we can
11644	 * find it easily. Something similar will need be done on the other
11645	 * side so when we are done we can find the copy.
11646	 */
11647	if ((lun->flags & CTL_LUN_PRIMARY_SC) == 0 &&
11648	    (lun->flags & CTL_LUN_PEER_SC_PRIMARY) != 0 &&
11649	    (entry->flags & CTL_CMD_FLAG_RUN_HERE) == 0) {
11650		union ctl_ha_msg msg_info;
11651		int isc_retval;
11652
11653		ctsio->io_hdr.flags |= CTL_FLAG_SENT_2OTHER_SC;
11654		ctsio->io_hdr.flags &= ~CTL_FLAG_IO_ACTIVE;
11655		mtx_unlock(&lun->lun_lock);
11656
11657		msg_info.hdr.msg_type = CTL_MSG_SERIALIZE;
11658		msg_info.hdr.original_sc = (union ctl_io *)ctsio;
11659		msg_info.hdr.serializing_sc = NULL;
11660		msg_info.hdr.nexus = ctsio->io_hdr.nexus;
11661		msg_info.scsi.tag_num = ctsio->tag_num;
11662		msg_info.scsi.tag_type = ctsio->tag_type;
11663		msg_info.scsi.cdb_len = ctsio->cdb_len;
11664		memcpy(msg_info.scsi.cdb, ctsio->cdb, CTL_MAX_CDBLEN);
11665
11666		if ((isc_retval = ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg_info,
11667		    sizeof(msg_info.scsi) - sizeof(msg_info.scsi.sense_data),
11668		    M_WAITOK)) > CTL_HA_STATUS_SUCCESS) {
11669			ctl_set_busy(ctsio);
11670			ctl_done((union ctl_io *)ctsio);
11671			return (retval);
11672		}
11673		return (retval);
11674	}
11675
11676	switch (ctl_check_ooa(lun, (union ctl_io *)ctsio,
11677			      (union ctl_io *)TAILQ_PREV(&ctsio->io_hdr,
11678			      ctl_ooaq, ooa_links))) {
11679	case CTL_ACTION_BLOCK:
11680		ctsio->io_hdr.flags |= CTL_FLAG_BLOCKED;
11681		TAILQ_INSERT_TAIL(&lun->blocked_queue, &ctsio->io_hdr,
11682				  blocked_links);
11683		mtx_unlock(&lun->lun_lock);
11684		return (retval);
11685	case CTL_ACTION_PASS:
11686	case CTL_ACTION_SKIP:
11687		ctsio->io_hdr.flags |= CTL_FLAG_IS_WAS_ON_RTR;
11688		mtx_unlock(&lun->lun_lock);
11689		ctl_enqueue_rtr((union ctl_io *)ctsio);
11690		break;
11691	case CTL_ACTION_OVERLAP:
11692		mtx_unlock(&lun->lun_lock);
11693		ctl_set_overlapped_cmd(ctsio);
11694		ctl_done((union ctl_io *)ctsio);
11695		break;
11696	case CTL_ACTION_OVERLAP_TAG:
11697		mtx_unlock(&lun->lun_lock);
11698		ctl_set_overlapped_tag(ctsio, ctsio->tag_num & 0xff);
11699		ctl_done((union ctl_io *)ctsio);
11700		break;
11701	case CTL_ACTION_ERROR:
11702	default:
11703		mtx_unlock(&lun->lun_lock);
11704		ctl_set_internal_failure(ctsio,
11705					 /*sks_valid*/ 0,
11706					 /*retry_count*/ 0);
11707		ctl_done((union ctl_io *)ctsio);
11708		break;
11709	}
11710	return (retval);
11711}
11712
11713const struct ctl_cmd_entry *
11714ctl_get_cmd_entry(struct ctl_scsiio *ctsio, int *sa)
11715{
11716	const struct ctl_cmd_entry *entry;
11717	int service_action;
11718
11719	entry = &ctl_cmd_table[ctsio->cdb[0]];
11720	if (sa)
11721		*sa = ((entry->flags & CTL_CMD_FLAG_SA5) != 0);
11722	if (entry->flags & CTL_CMD_FLAG_SA5) {
11723		service_action = ctsio->cdb[1] & SERVICE_ACTION_MASK;
11724		entry = &((const struct ctl_cmd_entry *)
11725		    entry->execute)[service_action];
11726	}
11727	return (entry);
11728}
11729
11730const struct ctl_cmd_entry *
11731ctl_validate_command(struct ctl_scsiio *ctsio)
11732{
11733	const struct ctl_cmd_entry *entry;
11734	int i, sa;
11735	uint8_t diff;
11736
11737	entry = ctl_get_cmd_entry(ctsio, &sa);
11738	if (entry->execute == NULL) {
11739		if (sa)
11740			ctl_set_invalid_field(ctsio,
11741					      /*sks_valid*/ 1,
11742					      /*command*/ 1,
11743					      /*field*/ 1,
11744					      /*bit_valid*/ 1,
11745					      /*bit*/ 4);
11746		else
11747			ctl_set_invalid_opcode(ctsio);
11748		ctl_done((union ctl_io *)ctsio);
11749		return (NULL);
11750	}
11751	KASSERT(entry->length > 0,
11752	    ("Not defined length for command 0x%02x/0x%02x",
11753	     ctsio->cdb[0], ctsio->cdb[1]));
11754	for (i = 1; i < entry->length; i++) {
11755		diff = ctsio->cdb[i] & ~entry->usage[i - 1];
11756		if (diff == 0)
11757			continue;
11758		ctl_set_invalid_field(ctsio,
11759				      /*sks_valid*/ 1,
11760				      /*command*/ 1,
11761				      /*field*/ i,
11762				      /*bit_valid*/ 1,
11763				      /*bit*/ fls(diff) - 1);
11764		ctl_done((union ctl_io *)ctsio);
11765		return (NULL);
11766	}
11767	return (entry);
11768}
11769
11770static int
11771ctl_cmd_applicable(uint8_t lun_type, const struct ctl_cmd_entry *entry)
11772{
11773
11774	switch (lun_type) {
11775	case T_DIRECT:
11776		if ((entry->flags & CTL_CMD_FLAG_OK_ON_DIRECT) == 0)
11777			return (0);
11778		break;
11779	case T_PROCESSOR:
11780		if ((entry->flags & CTL_CMD_FLAG_OK_ON_PROC) == 0)
11781			return (0);
11782		break;
11783	case T_CDROM:
11784		if ((entry->flags & CTL_CMD_FLAG_OK_ON_CDROM) == 0)
11785			return (0);
11786		break;
11787	default:
11788		return (0);
11789	}
11790	return (1);
11791}
11792
11793static int
11794ctl_scsiio(struct ctl_scsiio *ctsio)
11795{
11796	int retval;
11797	const struct ctl_cmd_entry *entry;
11798
11799	retval = CTL_RETVAL_COMPLETE;
11800
11801	CTL_DEBUG_PRINT(("ctl_scsiio cdb[0]=%02X\n", ctsio->cdb[0]));
11802
11803	entry = ctl_get_cmd_entry(ctsio, NULL);
11804
11805	/*
11806	 * If this I/O has been aborted, just send it straight to
11807	 * ctl_done() without executing it.
11808	 */
11809	if (ctsio->io_hdr.flags & CTL_FLAG_ABORT) {
11810		ctl_done((union ctl_io *)ctsio);
11811		goto bailout;
11812	}
11813
11814	/*
11815	 * All the checks should have been handled by ctl_scsiio_precheck().
11816	 * We should be clear now to just execute the I/O.
11817	 */
11818	retval = entry->execute(ctsio);
11819
11820bailout:
11821	return (retval);
11822}
11823
11824/*
11825 * Since we only implement one target right now, a bus reset simply resets
11826 * our single target.
11827 */
11828static int
11829ctl_bus_reset(struct ctl_softc *softc, union ctl_io *io)
11830{
11831	return(ctl_target_reset(softc, io, CTL_UA_BUS_RESET));
11832}
11833
11834static int
11835ctl_target_reset(struct ctl_softc *softc, union ctl_io *io,
11836		 ctl_ua_type ua_type)
11837{
11838	struct ctl_port *port;
11839	struct ctl_lun *lun;
11840	int retval;
11841
11842	if (!(io->io_hdr.flags & CTL_FLAG_FROM_OTHER_SC)) {
11843		union ctl_ha_msg msg_info;
11844
11845		msg_info.hdr.nexus = io->io_hdr.nexus;
11846		if (ua_type==CTL_UA_TARG_RESET)
11847			msg_info.task.task_action = CTL_TASK_TARGET_RESET;
11848		else
11849			msg_info.task.task_action = CTL_TASK_BUS_RESET;
11850		msg_info.hdr.msg_type = CTL_MSG_MANAGE_TASKS;
11851		msg_info.hdr.original_sc = NULL;
11852		msg_info.hdr.serializing_sc = NULL;
11853		ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg_info,
11854		    sizeof(msg_info.task), M_WAITOK);
11855	}
11856	retval = 0;
11857
11858	mtx_lock(&softc->ctl_lock);
11859	port = ctl_io_port(&io->io_hdr);
11860	STAILQ_FOREACH(lun, &softc->lun_list, links) {
11861		if (port != NULL &&
11862		    ctl_lun_map_to_port(port, lun->lun) >= CTL_MAX_LUNS)
11863			continue;
11864		retval += ctl_do_lun_reset(lun, io, ua_type);
11865	}
11866	mtx_unlock(&softc->ctl_lock);
11867	io->taskio.task_status = CTL_TASK_FUNCTION_COMPLETE;
11868	return (retval);
11869}
11870
11871/*
11872 * The LUN should always be set.  The I/O is optional, and is used to
11873 * distinguish between I/Os sent by this initiator, and by other
11874 * initiators.  We set unit attention for initiators other than this one.
11875 * SAM-3 is vague on this point.  It does say that a unit attention should
11876 * be established for other initiators when a LUN is reset (see section
11877 * 5.7.3), but it doesn't specifically say that the unit attention should
11878 * be established for this particular initiator when a LUN is reset.  Here
11879 * is the relevant text, from SAM-3 rev 8:
11880 *
11881 * 5.7.2 When a SCSI initiator port aborts its own tasks
11882 *
11883 * When a SCSI initiator port causes its own task(s) to be aborted, no
11884 * notification that the task(s) have been aborted shall be returned to
11885 * the SCSI initiator port other than the completion response for the
11886 * command or task management function action that caused the task(s) to
11887 * be aborted and notification(s) associated with related effects of the
11888 * action (e.g., a reset unit attention condition).
11889 *
11890 * XXX KDM for now, we're setting unit attention for all initiators.
11891 */
11892static int
11893ctl_do_lun_reset(struct ctl_lun *lun, union ctl_io *io, ctl_ua_type ua_type)
11894{
11895	union ctl_io *xio;
11896#if 0
11897	uint32_t initidx;
11898#endif
11899	int i;
11900
11901	mtx_lock(&lun->lun_lock);
11902	/*
11903	 * Run through the OOA queue and abort each I/O.
11904	 */
11905	for (xio = (union ctl_io *)TAILQ_FIRST(&lun->ooa_queue); xio != NULL;
11906	     xio = (union ctl_io *)TAILQ_NEXT(&xio->io_hdr, ooa_links)) {
11907		xio->io_hdr.flags |= CTL_FLAG_ABORT | CTL_FLAG_ABORT_STATUS;
11908	}
11909
11910	/*
11911	 * This version sets unit attention for every
11912	 */
11913#if 0
11914	initidx = ctl_get_initindex(&io->io_hdr.nexus);
11915	ctl_est_ua_all(lun, initidx, ua_type);
11916#else
11917	ctl_est_ua_all(lun, -1, ua_type);
11918#endif
11919
11920	/*
11921	 * A reset (any kind, really) clears reservations established with
11922	 * RESERVE/RELEASE.  It does not clear reservations established
11923	 * with PERSISTENT RESERVE OUT, but we don't support that at the
11924	 * moment anyway.  See SPC-2, section 5.6.  SPC-3 doesn't address
11925	 * reservations made with the RESERVE/RELEASE commands, because
11926	 * those commands are obsolete in SPC-3.
11927	 */
11928	lun->flags &= ~CTL_LUN_RESERVED;
11929
11930#ifdef CTL_WITH_CA
11931	for (i = 0; i < CTL_MAX_INITIATORS; i++)
11932		ctl_clear_mask(lun->have_ca, i);
11933#endif
11934	lun->prevent_count = 0;
11935	for (i = 0; i < CTL_MAX_INITIATORS; i++)
11936		ctl_clear_mask(lun->prevent, i);
11937	mtx_unlock(&lun->lun_lock);
11938
11939	return (0);
11940}
11941
11942static int
11943ctl_lun_reset(struct ctl_softc *softc, union ctl_io *io)
11944{
11945	struct ctl_lun *lun;
11946	uint32_t targ_lun;
11947	int retval;
11948
11949	targ_lun = io->io_hdr.nexus.targ_mapped_lun;
11950	mtx_lock(&softc->ctl_lock);
11951	if ((targ_lun >= CTL_MAX_LUNS) ||
11952	    (lun = softc->ctl_luns[targ_lun]) == NULL) {
11953		mtx_unlock(&softc->ctl_lock);
11954		io->taskio.task_status = CTL_TASK_LUN_DOES_NOT_EXIST;
11955		return (1);
11956	}
11957	retval = ctl_do_lun_reset(lun, io, CTL_UA_LUN_RESET);
11958	mtx_unlock(&softc->ctl_lock);
11959	io->taskio.task_status = CTL_TASK_FUNCTION_COMPLETE;
11960
11961	if ((io->io_hdr.flags & CTL_FLAG_FROM_OTHER_SC) == 0) {
11962		union ctl_ha_msg msg_info;
11963
11964		msg_info.hdr.msg_type = CTL_MSG_MANAGE_TASKS;
11965		msg_info.hdr.nexus = io->io_hdr.nexus;
11966		msg_info.task.task_action = CTL_TASK_LUN_RESET;
11967		msg_info.hdr.original_sc = NULL;
11968		msg_info.hdr.serializing_sc = NULL;
11969		ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg_info,
11970		    sizeof(msg_info.task), M_WAITOK);
11971	}
11972	return (retval);
11973}
11974
11975static void
11976ctl_abort_tasks_lun(struct ctl_lun *lun, uint32_t targ_port, uint32_t init_id,
11977    int other_sc)
11978{
11979	union ctl_io *xio;
11980
11981	mtx_assert(&lun->lun_lock, MA_OWNED);
11982
11983	/*
11984	 * Run through the OOA queue and attempt to find the given I/O.
11985	 * The target port, initiator ID, tag type and tag number have to
11986	 * match the values that we got from the initiator.  If we have an
11987	 * untagged command to abort, simply abort the first untagged command
11988	 * we come to.  We only allow one untagged command at a time of course.
11989	 */
11990	for (xio = (union ctl_io *)TAILQ_FIRST(&lun->ooa_queue); xio != NULL;
11991	     xio = (union ctl_io *)TAILQ_NEXT(&xio->io_hdr, ooa_links)) {
11992
11993		if ((targ_port == UINT32_MAX ||
11994		     targ_port == xio->io_hdr.nexus.targ_port) &&
11995		    (init_id == UINT32_MAX ||
11996		     init_id == xio->io_hdr.nexus.initid)) {
11997			if (targ_port != xio->io_hdr.nexus.targ_port ||
11998			    init_id != xio->io_hdr.nexus.initid)
11999				xio->io_hdr.flags |= CTL_FLAG_ABORT_STATUS;
12000			xio->io_hdr.flags |= CTL_FLAG_ABORT;
12001			if (!other_sc && !(lun->flags & CTL_LUN_PRIMARY_SC)) {
12002				union ctl_ha_msg msg_info;
12003
12004				msg_info.hdr.nexus = xio->io_hdr.nexus;
12005				msg_info.task.task_action = CTL_TASK_ABORT_TASK;
12006				msg_info.task.tag_num = xio->scsiio.tag_num;
12007				msg_info.task.tag_type = xio->scsiio.tag_type;
12008				msg_info.hdr.msg_type = CTL_MSG_MANAGE_TASKS;
12009				msg_info.hdr.original_sc = NULL;
12010				msg_info.hdr.serializing_sc = NULL;
12011				ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg_info,
12012				    sizeof(msg_info.task), M_NOWAIT);
12013			}
12014		}
12015	}
12016}
12017
12018static int
12019ctl_abort_task_set(union ctl_io *io)
12020{
12021	struct ctl_softc *softc = control_softc;
12022	struct ctl_lun *lun;
12023	uint32_t targ_lun;
12024
12025	/*
12026	 * Look up the LUN.
12027	 */
12028	targ_lun = io->io_hdr.nexus.targ_mapped_lun;
12029	mtx_lock(&softc->ctl_lock);
12030	if ((targ_lun >= CTL_MAX_LUNS) ||
12031	    (lun = softc->ctl_luns[targ_lun]) == NULL) {
12032		mtx_unlock(&softc->ctl_lock);
12033		io->taskio.task_status = CTL_TASK_LUN_DOES_NOT_EXIST;
12034		return (1);
12035	}
12036
12037	mtx_lock(&lun->lun_lock);
12038	mtx_unlock(&softc->ctl_lock);
12039	if (io->taskio.task_action == CTL_TASK_ABORT_TASK_SET) {
12040		ctl_abort_tasks_lun(lun, io->io_hdr.nexus.targ_port,
12041		    io->io_hdr.nexus.initid,
12042		    (io->io_hdr.flags & CTL_FLAG_FROM_OTHER_SC) != 0);
12043	} else { /* CTL_TASK_CLEAR_TASK_SET */
12044		ctl_abort_tasks_lun(lun, UINT32_MAX, UINT32_MAX,
12045		    (io->io_hdr.flags & CTL_FLAG_FROM_OTHER_SC) != 0);
12046	}
12047	mtx_unlock(&lun->lun_lock);
12048	io->taskio.task_status = CTL_TASK_FUNCTION_COMPLETE;
12049	return (0);
12050}
12051
12052static int
12053ctl_i_t_nexus_reset(union ctl_io *io)
12054{
12055	struct ctl_softc *softc = control_softc;
12056	struct ctl_lun *lun;
12057	uint32_t initidx;
12058
12059	if (!(io->io_hdr.flags & CTL_FLAG_FROM_OTHER_SC)) {
12060		union ctl_ha_msg msg_info;
12061
12062		msg_info.hdr.nexus = io->io_hdr.nexus;
12063		msg_info.task.task_action = CTL_TASK_I_T_NEXUS_RESET;
12064		msg_info.hdr.msg_type = CTL_MSG_MANAGE_TASKS;
12065		msg_info.hdr.original_sc = NULL;
12066		msg_info.hdr.serializing_sc = NULL;
12067		ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg_info,
12068		    sizeof(msg_info.task), M_WAITOK);
12069	}
12070
12071	initidx = ctl_get_initindex(&io->io_hdr.nexus);
12072	mtx_lock(&softc->ctl_lock);
12073	STAILQ_FOREACH(lun, &softc->lun_list, links) {
12074		mtx_lock(&lun->lun_lock);
12075		ctl_abort_tasks_lun(lun, io->io_hdr.nexus.targ_port,
12076		    io->io_hdr.nexus.initid, 1);
12077#ifdef CTL_WITH_CA
12078		ctl_clear_mask(lun->have_ca, initidx);
12079#endif
12080		if ((lun->flags & CTL_LUN_RESERVED) && (lun->res_idx == initidx))
12081			lun->flags &= ~CTL_LUN_RESERVED;
12082		if (ctl_is_set(lun->prevent, initidx)) {
12083			ctl_clear_mask(lun->prevent, initidx);
12084			lun->prevent_count--;
12085		}
12086		ctl_est_ua(lun, initidx, CTL_UA_I_T_NEXUS_LOSS);
12087		mtx_unlock(&lun->lun_lock);
12088	}
12089	mtx_unlock(&softc->ctl_lock);
12090	io->taskio.task_status = CTL_TASK_FUNCTION_COMPLETE;
12091	return (0);
12092}
12093
12094static int
12095ctl_abort_task(union ctl_io *io)
12096{
12097	union ctl_io *xio;
12098	struct ctl_lun *lun;
12099	struct ctl_softc *softc;
12100#if 0
12101	struct sbuf sb;
12102	char printbuf[128];
12103#endif
12104	int found;
12105	uint32_t targ_lun;
12106
12107	softc = control_softc;
12108	found = 0;
12109
12110	/*
12111	 * Look up the LUN.
12112	 */
12113	targ_lun = io->io_hdr.nexus.targ_mapped_lun;
12114	mtx_lock(&softc->ctl_lock);
12115	if ((targ_lun >= CTL_MAX_LUNS) ||
12116	    (lun = softc->ctl_luns[targ_lun]) == NULL) {
12117		mtx_unlock(&softc->ctl_lock);
12118		io->taskio.task_status = CTL_TASK_LUN_DOES_NOT_EXIST;
12119		return (1);
12120	}
12121
12122#if 0
12123	printf("ctl_abort_task: called for lun %lld, tag %d type %d\n",
12124	       lun->lun, io->taskio.tag_num, io->taskio.tag_type);
12125#endif
12126
12127	mtx_lock(&lun->lun_lock);
12128	mtx_unlock(&softc->ctl_lock);
12129	/*
12130	 * Run through the OOA queue and attempt to find the given I/O.
12131	 * The target port, initiator ID, tag type and tag number have to
12132	 * match the values that we got from the initiator.  If we have an
12133	 * untagged command to abort, simply abort the first untagged command
12134	 * we come to.  We only allow one untagged command at a time of course.
12135	 */
12136	for (xio = (union ctl_io *)TAILQ_FIRST(&lun->ooa_queue); xio != NULL;
12137	     xio = (union ctl_io *)TAILQ_NEXT(&xio->io_hdr, ooa_links)) {
12138#if 0
12139		sbuf_new(&sb, printbuf, sizeof(printbuf), SBUF_FIXEDLEN);
12140
12141		sbuf_printf(&sb, "LUN %lld tag %d type %d%s%s%s%s: ",
12142			    lun->lun, xio->scsiio.tag_num,
12143			    xio->scsiio.tag_type,
12144			    (xio->io_hdr.blocked_links.tqe_prev
12145			    == NULL) ? "" : " BLOCKED",
12146			    (xio->io_hdr.flags &
12147			    CTL_FLAG_DMA_INPROG) ? " DMA" : "",
12148			    (xio->io_hdr.flags &
12149			    CTL_FLAG_ABORT) ? " ABORT" : "",
12150			    (xio->io_hdr.flags &
12151			    CTL_FLAG_IS_WAS_ON_RTR ? " RTR" : ""));
12152		ctl_scsi_command_string(&xio->scsiio, NULL, &sb);
12153		sbuf_finish(&sb);
12154		printf("%s\n", sbuf_data(&sb));
12155#endif
12156
12157		if ((xio->io_hdr.nexus.targ_port != io->io_hdr.nexus.targ_port)
12158		 || (xio->io_hdr.nexus.initid != io->io_hdr.nexus.initid)
12159		 || (xio->io_hdr.flags & CTL_FLAG_ABORT))
12160			continue;
12161
12162		/*
12163		 * If the abort says that the task is untagged, the
12164		 * task in the queue must be untagged.  Otherwise,
12165		 * we just check to see whether the tag numbers
12166		 * match.  This is because the QLogic firmware
12167		 * doesn't pass back the tag type in an abort
12168		 * request.
12169		 */
12170#if 0
12171		if (((xio->scsiio.tag_type == CTL_TAG_UNTAGGED)
12172		  && (io->taskio.tag_type == CTL_TAG_UNTAGGED))
12173		 || (xio->scsiio.tag_num == io->taskio.tag_num))
12174#endif
12175		/*
12176		 * XXX KDM we've got problems with FC, because it
12177		 * doesn't send down a tag type with aborts.  So we
12178		 * can only really go by the tag number...
12179		 * This may cause problems with parallel SCSI.
12180		 * Need to figure that out!!
12181		 */
12182		if (xio->scsiio.tag_num == io->taskio.tag_num) {
12183			xio->io_hdr.flags |= CTL_FLAG_ABORT;
12184			found = 1;
12185			if ((io->io_hdr.flags & CTL_FLAG_FROM_OTHER_SC) == 0 &&
12186			    !(lun->flags & CTL_LUN_PRIMARY_SC)) {
12187				union ctl_ha_msg msg_info;
12188
12189				msg_info.hdr.nexus = io->io_hdr.nexus;
12190				msg_info.task.task_action = CTL_TASK_ABORT_TASK;
12191				msg_info.task.tag_num = io->taskio.tag_num;
12192				msg_info.task.tag_type = io->taskio.tag_type;
12193				msg_info.hdr.msg_type = CTL_MSG_MANAGE_TASKS;
12194				msg_info.hdr.original_sc = NULL;
12195				msg_info.hdr.serializing_sc = NULL;
12196#if 0
12197				printf("Sent Abort to other side\n");
12198#endif
12199				ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg_info,
12200				    sizeof(msg_info.task), M_NOWAIT);
12201			}
12202#if 0
12203			printf("ctl_abort_task: found I/O to abort\n");
12204#endif
12205		}
12206	}
12207	mtx_unlock(&lun->lun_lock);
12208
12209	if (found == 0) {
12210		/*
12211		 * This isn't really an error.  It's entirely possible for
12212		 * the abort and command completion to cross on the wire.
12213		 * This is more of an informative/diagnostic error.
12214		 */
12215#if 0
12216		printf("ctl_abort_task: ABORT sent for nonexistent I/O: "
12217		       "%u:%u:%u tag %d type %d\n",
12218		       io->io_hdr.nexus.initid,
12219		       io->io_hdr.nexus.targ_port,
12220		       io->io_hdr.nexus.targ_lun, io->taskio.tag_num,
12221		       io->taskio.tag_type);
12222#endif
12223	}
12224	io->taskio.task_status = CTL_TASK_FUNCTION_COMPLETE;
12225	return (0);
12226}
12227
12228static int
12229ctl_query_task(union ctl_io *io, int task_set)
12230{
12231	union ctl_io *xio;
12232	struct ctl_lun *lun;
12233	struct ctl_softc *softc;
12234	int found = 0;
12235	uint32_t targ_lun;
12236
12237	softc = control_softc;
12238	targ_lun = io->io_hdr.nexus.targ_mapped_lun;
12239	mtx_lock(&softc->ctl_lock);
12240	if ((targ_lun >= CTL_MAX_LUNS) ||
12241	    (lun = softc->ctl_luns[targ_lun]) == NULL) {
12242		mtx_unlock(&softc->ctl_lock);
12243		io->taskio.task_status = CTL_TASK_LUN_DOES_NOT_EXIST;
12244		return (1);
12245	}
12246	mtx_lock(&lun->lun_lock);
12247	mtx_unlock(&softc->ctl_lock);
12248	for (xio = (union ctl_io *)TAILQ_FIRST(&lun->ooa_queue); xio != NULL;
12249	     xio = (union ctl_io *)TAILQ_NEXT(&xio->io_hdr, ooa_links)) {
12250
12251		if ((xio->io_hdr.nexus.targ_port != io->io_hdr.nexus.targ_port)
12252		 || (xio->io_hdr.nexus.initid != io->io_hdr.nexus.initid)
12253		 || (xio->io_hdr.flags & CTL_FLAG_ABORT))
12254			continue;
12255
12256		if (task_set || xio->scsiio.tag_num == io->taskio.tag_num) {
12257			found = 1;
12258			break;
12259		}
12260	}
12261	mtx_unlock(&lun->lun_lock);
12262	if (found)
12263		io->taskio.task_status = CTL_TASK_FUNCTION_SUCCEEDED;
12264	else
12265		io->taskio.task_status = CTL_TASK_FUNCTION_COMPLETE;
12266	return (0);
12267}
12268
12269static int
12270ctl_query_async_event(union ctl_io *io)
12271{
12272	struct ctl_lun *lun;
12273	struct ctl_softc *softc;
12274	ctl_ua_type ua;
12275	uint32_t targ_lun, initidx;
12276
12277	softc = control_softc;
12278	targ_lun = io->io_hdr.nexus.targ_mapped_lun;
12279	mtx_lock(&softc->ctl_lock);
12280	if ((targ_lun >= CTL_MAX_LUNS) ||
12281	    (lun = softc->ctl_luns[targ_lun]) == NULL) {
12282		mtx_unlock(&softc->ctl_lock);
12283		io->taskio.task_status = CTL_TASK_LUN_DOES_NOT_EXIST;
12284		return (1);
12285	}
12286	mtx_lock(&lun->lun_lock);
12287	mtx_unlock(&softc->ctl_lock);
12288	initidx = ctl_get_initindex(&io->io_hdr.nexus);
12289	ua = ctl_build_qae(lun, initidx, io->taskio.task_resp);
12290	mtx_unlock(&lun->lun_lock);
12291	if (ua != CTL_UA_NONE)
12292		io->taskio.task_status = CTL_TASK_FUNCTION_SUCCEEDED;
12293	else
12294		io->taskio.task_status = CTL_TASK_FUNCTION_COMPLETE;
12295	return (0);
12296}
12297
12298static void
12299ctl_run_task(union ctl_io *io)
12300{
12301	struct ctl_softc *softc = control_softc;
12302	int retval = 1;
12303
12304	CTL_DEBUG_PRINT(("ctl_run_task\n"));
12305	KASSERT(io->io_hdr.io_type == CTL_IO_TASK,
12306	    ("ctl_run_task: Unextected io_type %d\n", io->io_hdr.io_type));
12307	io->taskio.task_status = CTL_TASK_FUNCTION_NOT_SUPPORTED;
12308	bzero(io->taskio.task_resp, sizeof(io->taskio.task_resp));
12309	switch (io->taskio.task_action) {
12310	case CTL_TASK_ABORT_TASK:
12311		retval = ctl_abort_task(io);
12312		break;
12313	case CTL_TASK_ABORT_TASK_SET:
12314	case CTL_TASK_CLEAR_TASK_SET:
12315		retval = ctl_abort_task_set(io);
12316		break;
12317	case CTL_TASK_CLEAR_ACA:
12318		break;
12319	case CTL_TASK_I_T_NEXUS_RESET:
12320		retval = ctl_i_t_nexus_reset(io);
12321		break;
12322	case CTL_TASK_LUN_RESET:
12323		retval = ctl_lun_reset(softc, io);
12324		break;
12325	case CTL_TASK_TARGET_RESET:
12326		retval = ctl_target_reset(softc, io, CTL_UA_TARG_RESET);
12327		break;
12328	case CTL_TASK_BUS_RESET:
12329		retval = ctl_bus_reset(softc, io);
12330		break;
12331	case CTL_TASK_PORT_LOGIN:
12332		break;
12333	case CTL_TASK_PORT_LOGOUT:
12334		break;
12335	case CTL_TASK_QUERY_TASK:
12336		retval = ctl_query_task(io, 0);
12337		break;
12338	case CTL_TASK_QUERY_TASK_SET:
12339		retval = ctl_query_task(io, 1);
12340		break;
12341	case CTL_TASK_QUERY_ASYNC_EVENT:
12342		retval = ctl_query_async_event(io);
12343		break;
12344	default:
12345		printf("%s: got unknown task management event %d\n",
12346		       __func__, io->taskio.task_action);
12347		break;
12348	}
12349	if (retval == 0)
12350		io->io_hdr.status = CTL_SUCCESS;
12351	else
12352		io->io_hdr.status = CTL_ERROR;
12353	ctl_done(io);
12354}
12355
12356/*
12357 * For HA operation.  Handle commands that come in from the other
12358 * controller.
12359 */
12360static void
12361ctl_handle_isc(union ctl_io *io)
12362{
12363	int free_io;
12364	struct ctl_lun *lun;
12365	struct ctl_softc *softc = control_softc;
12366	uint32_t targ_lun;
12367
12368	targ_lun = io->io_hdr.nexus.targ_mapped_lun;
12369	lun = softc->ctl_luns[targ_lun];
12370
12371	switch (io->io_hdr.msg_type) {
12372	case CTL_MSG_SERIALIZE:
12373		free_io = ctl_serialize_other_sc_cmd(&io->scsiio);
12374		break;
12375	case CTL_MSG_R2R: {
12376		const struct ctl_cmd_entry *entry;
12377
12378		/*
12379		 * This is only used in SER_ONLY mode.
12380		 */
12381		free_io = 0;
12382		entry = ctl_get_cmd_entry(&io->scsiio, NULL);
12383		mtx_lock(&lun->lun_lock);
12384		if (ctl_scsiio_lun_check(lun,
12385		    entry, (struct ctl_scsiio *)io) != 0) {
12386			mtx_unlock(&lun->lun_lock);
12387			ctl_done(io);
12388			break;
12389		}
12390		io->io_hdr.flags |= CTL_FLAG_IS_WAS_ON_RTR;
12391		mtx_unlock(&lun->lun_lock);
12392		ctl_enqueue_rtr(io);
12393		break;
12394	}
12395	case CTL_MSG_FINISH_IO:
12396		if (softc->ha_mode == CTL_HA_MODE_XFER) {
12397			free_io = 0;
12398			ctl_done(io);
12399		} else {
12400			free_io = 1;
12401			mtx_lock(&lun->lun_lock);
12402			TAILQ_REMOVE(&lun->ooa_queue, &io->io_hdr,
12403				     ooa_links);
12404			ctl_check_blocked(lun);
12405			mtx_unlock(&lun->lun_lock);
12406		}
12407		break;
12408	case CTL_MSG_PERS_ACTION:
12409		ctl_hndl_per_res_out_on_other_sc(
12410			(union ctl_ha_msg *)&io->presio.pr_msg);
12411		free_io = 1;
12412		break;
12413	case CTL_MSG_BAD_JUJU:
12414		free_io = 0;
12415		ctl_done(io);
12416		break;
12417	case CTL_MSG_DATAMOVE:
12418		/* Only used in XFER mode */
12419		free_io = 0;
12420		ctl_datamove_remote(io);
12421		break;
12422	case CTL_MSG_DATAMOVE_DONE:
12423		/* Only used in XFER mode */
12424		free_io = 0;
12425		io->scsiio.be_move_done(io);
12426		break;
12427	case CTL_MSG_FAILOVER:
12428		ctl_failover_lun(io);
12429		free_io = 1;
12430		break;
12431	default:
12432		free_io = 1;
12433		printf("%s: Invalid message type %d\n",
12434		       __func__, io->io_hdr.msg_type);
12435		break;
12436	}
12437	if (free_io)
12438		ctl_free_io(io);
12439
12440}
12441
12442
12443/*
12444 * Returns the match type in the case of a match, or CTL_LUN_PAT_NONE if
12445 * there is no match.
12446 */
12447static ctl_lun_error_pattern
12448ctl_cmd_pattern_match(struct ctl_scsiio *ctsio, struct ctl_error_desc *desc)
12449{
12450	const struct ctl_cmd_entry *entry;
12451	ctl_lun_error_pattern filtered_pattern, pattern;
12452
12453	pattern = desc->error_pattern;
12454
12455	/*
12456	 * XXX KDM we need more data passed into this function to match a
12457	 * custom pattern, and we actually need to implement custom pattern
12458	 * matching.
12459	 */
12460	if (pattern & CTL_LUN_PAT_CMD)
12461		return (CTL_LUN_PAT_CMD);
12462
12463	if ((pattern & CTL_LUN_PAT_MASK) == CTL_LUN_PAT_ANY)
12464		return (CTL_LUN_PAT_ANY);
12465
12466	entry = ctl_get_cmd_entry(ctsio, NULL);
12467
12468	filtered_pattern = entry->pattern & pattern;
12469
12470	/*
12471	 * If the user requested specific flags in the pattern (e.g.
12472	 * CTL_LUN_PAT_RANGE), make sure the command supports all of those
12473	 * flags.
12474	 *
12475	 * If the user did not specify any flags, it doesn't matter whether
12476	 * or not the command supports the flags.
12477	 */
12478	if ((filtered_pattern & ~CTL_LUN_PAT_MASK) !=
12479	     (pattern & ~CTL_LUN_PAT_MASK))
12480		return (CTL_LUN_PAT_NONE);
12481
12482	/*
12483	 * If the user asked for a range check, see if the requested LBA
12484	 * range overlaps with this command's LBA range.
12485	 */
12486	if (filtered_pattern & CTL_LUN_PAT_RANGE) {
12487		uint64_t lba1;
12488		uint64_t len1;
12489		ctl_action action;
12490		int retval;
12491
12492		retval = ctl_get_lba_len((union ctl_io *)ctsio, &lba1, &len1);
12493		if (retval != 0)
12494			return (CTL_LUN_PAT_NONE);
12495
12496		action = ctl_extent_check_lba(lba1, len1, desc->lba_range.lba,
12497					      desc->lba_range.len, FALSE);
12498		/*
12499		 * A "pass" means that the LBA ranges don't overlap, so
12500		 * this doesn't match the user's range criteria.
12501		 */
12502		if (action == CTL_ACTION_PASS)
12503			return (CTL_LUN_PAT_NONE);
12504	}
12505
12506	return (filtered_pattern);
12507}
12508
12509static void
12510ctl_inject_error(struct ctl_lun *lun, union ctl_io *io)
12511{
12512	struct ctl_error_desc *desc, *desc2;
12513
12514	mtx_assert(&lun->lun_lock, MA_OWNED);
12515
12516	STAILQ_FOREACH_SAFE(desc, &lun->error_list, links, desc2) {
12517		ctl_lun_error_pattern pattern;
12518		/*
12519		 * Check to see whether this particular command matches
12520		 * the pattern in the descriptor.
12521		 */
12522		pattern = ctl_cmd_pattern_match(&io->scsiio, desc);
12523		if ((pattern & CTL_LUN_PAT_MASK) == CTL_LUN_PAT_NONE)
12524			continue;
12525
12526		switch (desc->lun_error & CTL_LUN_INJ_TYPE) {
12527		case CTL_LUN_INJ_ABORTED:
12528			ctl_set_aborted(&io->scsiio);
12529			break;
12530		case CTL_LUN_INJ_MEDIUM_ERR:
12531			ctl_set_medium_error(&io->scsiio,
12532			    (io->io_hdr.flags & CTL_FLAG_DATA_MASK) !=
12533			     CTL_FLAG_DATA_OUT);
12534			break;
12535		case CTL_LUN_INJ_UA:
12536			/* 29h/00h  POWER ON, RESET, OR BUS DEVICE RESET
12537			 * OCCURRED */
12538			ctl_set_ua(&io->scsiio, 0x29, 0x00);
12539			break;
12540		case CTL_LUN_INJ_CUSTOM:
12541			/*
12542			 * We're assuming the user knows what he is doing.
12543			 * Just copy the sense information without doing
12544			 * checks.
12545			 */
12546			bcopy(&desc->custom_sense, &io->scsiio.sense_data,
12547			      MIN(sizeof(desc->custom_sense),
12548				  sizeof(io->scsiio.sense_data)));
12549			io->scsiio.scsi_status = SCSI_STATUS_CHECK_COND;
12550			io->scsiio.sense_len = SSD_FULL_SIZE;
12551			io->io_hdr.status = CTL_SCSI_ERROR | CTL_AUTOSENSE;
12552			break;
12553		case CTL_LUN_INJ_NONE:
12554		default:
12555			/*
12556			 * If this is an error injection type we don't know
12557			 * about, clear the continuous flag (if it is set)
12558			 * so it will get deleted below.
12559			 */
12560			desc->lun_error &= ~CTL_LUN_INJ_CONTINUOUS;
12561			break;
12562		}
12563		/*
12564		 * By default, each error injection action is a one-shot
12565		 */
12566		if (desc->lun_error & CTL_LUN_INJ_CONTINUOUS)
12567			continue;
12568
12569		STAILQ_REMOVE(&lun->error_list, desc, ctl_error_desc, links);
12570
12571		free(desc, M_CTL);
12572	}
12573}
12574
12575#ifdef CTL_IO_DELAY
12576static void
12577ctl_datamove_timer_wakeup(void *arg)
12578{
12579	union ctl_io *io;
12580
12581	io = (union ctl_io *)arg;
12582
12583	ctl_datamove(io);
12584}
12585#endif /* CTL_IO_DELAY */
12586
12587void
12588ctl_datamove(union ctl_io *io)
12589{
12590	struct ctl_lun *lun;
12591	void (*fe_datamove)(union ctl_io *io);
12592
12593	mtx_assert(&control_softc->ctl_lock, MA_NOTOWNED);
12594
12595	CTL_DEBUG_PRINT(("ctl_datamove\n"));
12596
12597	lun = (struct ctl_lun *)io->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
12598#ifdef CTL_TIME_IO
12599	if ((time_uptime - io->io_hdr.start_time) > ctl_time_io_secs) {
12600		char str[256];
12601		char path_str[64];
12602		struct sbuf sb;
12603
12604		ctl_scsi_path_string(io, path_str, sizeof(path_str));
12605		sbuf_new(&sb, str, sizeof(str), SBUF_FIXEDLEN);
12606
12607		sbuf_cat(&sb, path_str);
12608		switch (io->io_hdr.io_type) {
12609		case CTL_IO_SCSI:
12610			ctl_scsi_command_string(&io->scsiio, NULL, &sb);
12611			sbuf_printf(&sb, "\n");
12612			sbuf_cat(&sb, path_str);
12613			sbuf_printf(&sb, "Tag: 0x%04x, type %d\n",
12614				    io->scsiio.tag_num, io->scsiio.tag_type);
12615			break;
12616		case CTL_IO_TASK:
12617			sbuf_printf(&sb, "Task I/O type: %d, Tag: 0x%04x, "
12618				    "Tag Type: %d\n", io->taskio.task_action,
12619				    io->taskio.tag_num, io->taskio.tag_type);
12620			break;
12621		default:
12622			panic("%s: Invalid CTL I/O type %d\n",
12623			    __func__, io->io_hdr.io_type);
12624		}
12625		sbuf_cat(&sb, path_str);
12626		sbuf_printf(&sb, "ctl_datamove: %jd seconds\n",
12627			    (intmax_t)time_uptime - io->io_hdr.start_time);
12628		sbuf_finish(&sb);
12629		printf("%s", sbuf_data(&sb));
12630	}
12631#endif /* CTL_TIME_IO */
12632
12633#ifdef CTL_IO_DELAY
12634	if (io->io_hdr.flags & CTL_FLAG_DELAY_DONE) {
12635		io->io_hdr.flags &= ~CTL_FLAG_DELAY_DONE;
12636	} else {
12637		if ((lun != NULL)
12638		 && (lun->delay_info.datamove_delay > 0)) {
12639
12640			callout_init(&io->io_hdr.delay_callout, /*mpsafe*/ 1);
12641			io->io_hdr.flags |= CTL_FLAG_DELAY_DONE;
12642			callout_reset(&io->io_hdr.delay_callout,
12643				      lun->delay_info.datamove_delay * hz,
12644				      ctl_datamove_timer_wakeup, io);
12645			if (lun->delay_info.datamove_type ==
12646			    CTL_DELAY_TYPE_ONESHOT)
12647				lun->delay_info.datamove_delay = 0;
12648			return;
12649		}
12650	}
12651#endif
12652
12653	/*
12654	 * This command has been aborted.  Set the port status, so we fail
12655	 * the data move.
12656	 */
12657	if (io->io_hdr.flags & CTL_FLAG_ABORT) {
12658		printf("ctl_datamove: tag 0x%04x on (%u:%u:%u) aborted\n",
12659		       io->scsiio.tag_num, io->io_hdr.nexus.initid,
12660		       io->io_hdr.nexus.targ_port,
12661		       io->io_hdr.nexus.targ_lun);
12662		io->io_hdr.port_status = 31337;
12663		/*
12664		 * Note that the backend, in this case, will get the
12665		 * callback in its context.  In other cases it may get
12666		 * called in the frontend's interrupt thread context.
12667		 */
12668		io->scsiio.be_move_done(io);
12669		return;
12670	}
12671
12672	/* Don't confuse frontend with zero length data move. */
12673	if (io->scsiio.kern_data_len == 0) {
12674		io->scsiio.be_move_done(io);
12675		return;
12676	}
12677
12678	fe_datamove = ctl_io_port(&io->io_hdr)->fe_datamove;
12679	fe_datamove(io);
12680}
12681
12682static void
12683ctl_send_datamove_done(union ctl_io *io, int have_lock)
12684{
12685	union ctl_ha_msg msg;
12686#ifdef CTL_TIME_IO
12687	struct bintime cur_bt;
12688#endif
12689
12690	memset(&msg, 0, sizeof(msg));
12691	msg.hdr.msg_type = CTL_MSG_DATAMOVE_DONE;
12692	msg.hdr.original_sc = io;
12693	msg.hdr.serializing_sc = io->io_hdr.serializing_sc;
12694	msg.hdr.nexus = io->io_hdr.nexus;
12695	msg.hdr.status = io->io_hdr.status;
12696	msg.scsi.tag_num = io->scsiio.tag_num;
12697	msg.scsi.tag_type = io->scsiio.tag_type;
12698	msg.scsi.scsi_status = io->scsiio.scsi_status;
12699	memcpy(&msg.scsi.sense_data, &io->scsiio.sense_data,
12700	       io->scsiio.sense_len);
12701	msg.scsi.sense_len = io->scsiio.sense_len;
12702	msg.scsi.sense_residual = io->scsiio.sense_residual;
12703	msg.scsi.fetd_status = io->io_hdr.port_status;
12704	msg.scsi.residual = io->scsiio.residual;
12705	io->io_hdr.flags &= ~CTL_FLAG_IO_ACTIVE;
12706	if (io->io_hdr.flags & CTL_FLAG_FAILOVER) {
12707		ctl_failover_io(io, /*have_lock*/ have_lock);
12708		return;
12709	}
12710	ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg,
12711	    sizeof(msg.scsi) - sizeof(msg.scsi.sense_data) +
12712	    msg.scsi.sense_len, M_WAITOK);
12713
12714#ifdef CTL_TIME_IO
12715	getbinuptime(&cur_bt);
12716	bintime_sub(&cur_bt, &io->io_hdr.dma_start_bt);
12717	bintime_add(&io->io_hdr.dma_bt, &cur_bt);
12718#endif
12719	io->io_hdr.num_dmas++;
12720}
12721
12722/*
12723 * The DMA to the remote side is done, now we need to tell the other side
12724 * we're done so it can continue with its data movement.
12725 */
12726static void
12727ctl_datamove_remote_write_cb(struct ctl_ha_dt_req *rq)
12728{
12729	union ctl_io *io;
12730	uint32_t i;
12731
12732	io = rq->context;
12733
12734	if (rq->ret != CTL_HA_STATUS_SUCCESS) {
12735		printf("%s: ISC DMA write failed with error %d", __func__,
12736		       rq->ret);
12737		ctl_set_internal_failure(&io->scsiio,
12738					 /*sks_valid*/ 1,
12739					 /*retry_count*/ rq->ret);
12740	}
12741
12742	ctl_dt_req_free(rq);
12743
12744	for (i = 0; i < io->scsiio.kern_sg_entries; i++)
12745		free(io->io_hdr.local_sglist[i].addr, M_CTL);
12746	free(io->io_hdr.remote_sglist, M_CTL);
12747	io->io_hdr.remote_sglist = NULL;
12748	io->io_hdr.local_sglist = NULL;
12749
12750	/*
12751	 * The data is in local and remote memory, so now we need to send
12752	 * status (good or back) back to the other side.
12753	 */
12754	ctl_send_datamove_done(io, /*have_lock*/ 0);
12755}
12756
12757/*
12758 * We've moved the data from the host/controller into local memory.  Now we
12759 * need to push it over to the remote controller's memory.
12760 */
12761static int
12762ctl_datamove_remote_dm_write_cb(union ctl_io *io)
12763{
12764	int retval;
12765
12766	retval = ctl_datamove_remote_xfer(io, CTL_HA_DT_CMD_WRITE,
12767					  ctl_datamove_remote_write_cb);
12768	return (retval);
12769}
12770
12771static void
12772ctl_datamove_remote_write(union ctl_io *io)
12773{
12774	int retval;
12775	void (*fe_datamove)(union ctl_io *io);
12776
12777	/*
12778	 * - Get the data from the host/HBA into local memory.
12779	 * - DMA memory from the local controller to the remote controller.
12780	 * - Send status back to the remote controller.
12781	 */
12782
12783	retval = ctl_datamove_remote_sgl_setup(io);
12784	if (retval != 0)
12785		return;
12786
12787	/* Switch the pointer over so the FETD knows what to do */
12788	io->scsiio.kern_data_ptr = (uint8_t *)io->io_hdr.local_sglist;
12789
12790	/*
12791	 * Use a custom move done callback, since we need to send completion
12792	 * back to the other controller, not to the backend on this side.
12793	 */
12794	io->scsiio.be_move_done = ctl_datamove_remote_dm_write_cb;
12795
12796	fe_datamove = ctl_io_port(&io->io_hdr)->fe_datamove;
12797	fe_datamove(io);
12798}
12799
12800static int
12801ctl_datamove_remote_dm_read_cb(union ctl_io *io)
12802{
12803#if 0
12804	char str[256];
12805	char path_str[64];
12806	struct sbuf sb;
12807#endif
12808	uint32_t i;
12809
12810	for (i = 0; i < io->scsiio.kern_sg_entries; i++)
12811		free(io->io_hdr.local_sglist[i].addr, M_CTL);
12812	free(io->io_hdr.remote_sglist, M_CTL);
12813	io->io_hdr.remote_sglist = NULL;
12814	io->io_hdr.local_sglist = NULL;
12815
12816#if 0
12817	scsi_path_string(io, path_str, sizeof(path_str));
12818	sbuf_new(&sb, str, sizeof(str), SBUF_FIXEDLEN);
12819	sbuf_cat(&sb, path_str);
12820	scsi_command_string(&io->scsiio, NULL, &sb);
12821	sbuf_printf(&sb, "\n");
12822	sbuf_cat(&sb, path_str);
12823	sbuf_printf(&sb, "Tag: 0x%04x, type %d\n",
12824		    io->scsiio.tag_num, io->scsiio.tag_type);
12825	sbuf_cat(&sb, path_str);
12826	sbuf_printf(&sb, "%s: flags %#x, status %#x\n", __func__,
12827		    io->io_hdr.flags, io->io_hdr.status);
12828	sbuf_finish(&sb);
12829	printk("%s", sbuf_data(&sb));
12830#endif
12831
12832
12833	/*
12834	 * The read is done, now we need to send status (good or bad) back
12835	 * to the other side.
12836	 */
12837	ctl_send_datamove_done(io, /*have_lock*/ 0);
12838
12839	return (0);
12840}
12841
12842static void
12843ctl_datamove_remote_read_cb(struct ctl_ha_dt_req *rq)
12844{
12845	union ctl_io *io;
12846	void (*fe_datamove)(union ctl_io *io);
12847
12848	io = rq->context;
12849
12850	if (rq->ret != CTL_HA_STATUS_SUCCESS) {
12851		printf("%s: ISC DMA read failed with error %d\n", __func__,
12852		       rq->ret);
12853		ctl_set_internal_failure(&io->scsiio,
12854					 /*sks_valid*/ 1,
12855					 /*retry_count*/ rq->ret);
12856	}
12857
12858	ctl_dt_req_free(rq);
12859
12860	/* Switch the pointer over so the FETD knows what to do */
12861	io->scsiio.kern_data_ptr = (uint8_t *)io->io_hdr.local_sglist;
12862
12863	/*
12864	 * Use a custom move done callback, since we need to send completion
12865	 * back to the other controller, not to the backend on this side.
12866	 */
12867	io->scsiio.be_move_done = ctl_datamove_remote_dm_read_cb;
12868
12869	/* XXX KDM add checks like the ones in ctl_datamove? */
12870
12871	fe_datamove = ctl_io_port(&io->io_hdr)->fe_datamove;
12872	fe_datamove(io);
12873}
12874
12875static int
12876ctl_datamove_remote_sgl_setup(union ctl_io *io)
12877{
12878	struct ctl_sg_entry *local_sglist;
12879	uint32_t len_to_go;
12880	int retval;
12881	int i;
12882
12883	retval = 0;
12884	local_sglist = io->io_hdr.local_sglist;
12885	len_to_go = io->scsiio.kern_data_len;
12886
12887	/*
12888	 * The difficult thing here is that the size of the various
12889	 * S/G segments may be different than the size from the
12890	 * remote controller.  That'll make it harder when DMAing
12891	 * the data back to the other side.
12892	 */
12893	for (i = 0; len_to_go > 0; i++) {
12894		local_sglist[i].len = MIN(len_to_go, CTL_HA_DATAMOVE_SEGMENT);
12895		local_sglist[i].addr =
12896		    malloc(local_sglist[i].len, M_CTL, M_WAITOK);
12897
12898		len_to_go -= local_sglist[i].len;
12899	}
12900	/*
12901	 * Reset the number of S/G entries accordingly.  The original
12902	 * number of S/G entries is available in rem_sg_entries.
12903	 */
12904	io->scsiio.kern_sg_entries = i;
12905
12906#if 0
12907	printf("%s: kern_sg_entries = %d\n", __func__,
12908	       io->scsiio.kern_sg_entries);
12909	for (i = 0; i < io->scsiio.kern_sg_entries; i++)
12910		printf("%s: sg[%d] = %p, %lu\n", __func__, i,
12911		       local_sglist[i].addr, local_sglist[i].len);
12912#endif
12913
12914	return (retval);
12915}
12916
12917static int
12918ctl_datamove_remote_xfer(union ctl_io *io, unsigned command,
12919			 ctl_ha_dt_cb callback)
12920{
12921	struct ctl_ha_dt_req *rq;
12922	struct ctl_sg_entry *remote_sglist, *local_sglist;
12923	uint32_t local_used, remote_used, total_used;
12924	int i, j, isc_ret;
12925
12926	rq = ctl_dt_req_alloc();
12927
12928	/*
12929	 * If we failed to allocate the request, and if the DMA didn't fail
12930	 * anyway, set busy status.  This is just a resource allocation
12931	 * failure.
12932	 */
12933	if ((rq == NULL)
12934	 && ((io->io_hdr.status & CTL_STATUS_MASK) != CTL_STATUS_NONE &&
12935	     (io->io_hdr.status & CTL_STATUS_MASK) != CTL_SUCCESS))
12936		ctl_set_busy(&io->scsiio);
12937
12938	if ((io->io_hdr.status & CTL_STATUS_MASK) != CTL_STATUS_NONE &&
12939	    (io->io_hdr.status & CTL_STATUS_MASK) != CTL_SUCCESS) {
12940
12941		if (rq != NULL)
12942			ctl_dt_req_free(rq);
12943
12944		/*
12945		 * The data move failed.  We need to return status back
12946		 * to the other controller.  No point in trying to DMA
12947		 * data to the remote controller.
12948		 */
12949
12950		ctl_send_datamove_done(io, /*have_lock*/ 0);
12951
12952		return (1);
12953	}
12954
12955	local_sglist = io->io_hdr.local_sglist;
12956	remote_sglist = io->io_hdr.remote_sglist;
12957	local_used = 0;
12958	remote_used = 0;
12959	total_used = 0;
12960
12961	/*
12962	 * Pull/push the data over the wire from/to the other controller.
12963	 * This takes into account the possibility that the local and
12964	 * remote sglists may not be identical in terms of the size of
12965	 * the elements and the number of elements.
12966	 *
12967	 * One fundamental assumption here is that the length allocated for
12968	 * both the local and remote sglists is identical.  Otherwise, we've
12969	 * essentially got a coding error of some sort.
12970	 */
12971	isc_ret = CTL_HA_STATUS_SUCCESS;
12972	for (i = 0, j = 0; total_used < io->scsiio.kern_data_len; ) {
12973		uint32_t cur_len;
12974		uint8_t *tmp_ptr;
12975
12976		rq->command = command;
12977		rq->context = io;
12978
12979		/*
12980		 * Both pointers should be aligned.  But it is possible
12981		 * that the allocation length is not.  They should both
12982		 * also have enough slack left over at the end, though,
12983		 * to round up to the next 8 byte boundary.
12984		 */
12985		cur_len = MIN(local_sglist[i].len - local_used,
12986			      remote_sglist[j].len - remote_used);
12987		rq->size = cur_len;
12988
12989		tmp_ptr = (uint8_t *)local_sglist[i].addr;
12990		tmp_ptr += local_used;
12991
12992#if 0
12993		/* Use physical addresses when talking to ISC hardware */
12994		if ((io->io_hdr.flags & CTL_FLAG_BUS_ADDR) == 0) {
12995			/* XXX KDM use busdma */
12996			rq->local = vtophys(tmp_ptr);
12997		} else
12998			rq->local = tmp_ptr;
12999#else
13000		KASSERT((io->io_hdr.flags & CTL_FLAG_BUS_ADDR) == 0,
13001		    ("HA does not support BUS_ADDR"));
13002		rq->local = tmp_ptr;
13003#endif
13004
13005		tmp_ptr = (uint8_t *)remote_sglist[j].addr;
13006		tmp_ptr += remote_used;
13007		rq->remote = tmp_ptr;
13008
13009		rq->callback = NULL;
13010
13011		local_used += cur_len;
13012		if (local_used >= local_sglist[i].len) {
13013			i++;
13014			local_used = 0;
13015		}
13016
13017		remote_used += cur_len;
13018		if (remote_used >= remote_sglist[j].len) {
13019			j++;
13020			remote_used = 0;
13021		}
13022		total_used += cur_len;
13023
13024		if (total_used >= io->scsiio.kern_data_len)
13025			rq->callback = callback;
13026
13027#if 0
13028		printf("%s: %s: local %p remote %p size %d\n", __func__,
13029		       (command == CTL_HA_DT_CMD_WRITE) ? "WRITE" : "READ",
13030		       rq->local, rq->remote, rq->size);
13031#endif
13032
13033		isc_ret = ctl_dt_single(rq);
13034		if (isc_ret > CTL_HA_STATUS_SUCCESS)
13035			break;
13036	}
13037	if (isc_ret != CTL_HA_STATUS_WAIT) {
13038		rq->ret = isc_ret;
13039		callback(rq);
13040	}
13041
13042	return (0);
13043}
13044
13045static void
13046ctl_datamove_remote_read(union ctl_io *io)
13047{
13048	int retval;
13049	uint32_t i;
13050
13051	/*
13052	 * This will send an error to the other controller in the case of a
13053	 * failure.
13054	 */
13055	retval = ctl_datamove_remote_sgl_setup(io);
13056	if (retval != 0)
13057		return;
13058
13059	retval = ctl_datamove_remote_xfer(io, CTL_HA_DT_CMD_READ,
13060					  ctl_datamove_remote_read_cb);
13061	if (retval != 0) {
13062		/*
13063		 * Make sure we free memory if there was an error..  The
13064		 * ctl_datamove_remote_xfer() function will send the
13065		 * datamove done message, or call the callback with an
13066		 * error if there is a problem.
13067		 */
13068		for (i = 0; i < io->scsiio.kern_sg_entries; i++)
13069			free(io->io_hdr.local_sglist[i].addr, M_CTL);
13070		free(io->io_hdr.remote_sglist, M_CTL);
13071		io->io_hdr.remote_sglist = NULL;
13072		io->io_hdr.local_sglist = NULL;
13073	}
13074}
13075
13076/*
13077 * Process a datamove request from the other controller.  This is used for
13078 * XFER mode only, not SER_ONLY mode.  For writes, we DMA into local memory
13079 * first.  Once that is complete, the data gets DMAed into the remote
13080 * controller's memory.  For reads, we DMA from the remote controller's
13081 * memory into our memory first, and then move it out to the FETD.
13082 */
13083static void
13084ctl_datamove_remote(union ctl_io *io)
13085{
13086
13087	mtx_assert(&control_softc->ctl_lock, MA_NOTOWNED);
13088
13089	if (io->io_hdr.flags & CTL_FLAG_FAILOVER) {
13090		ctl_failover_io(io, /*have_lock*/ 0);
13091		return;
13092	}
13093
13094	/*
13095	 * Note that we look for an aborted I/O here, but don't do some of
13096	 * the other checks that ctl_datamove() normally does.
13097	 * We don't need to run the datamove delay code, since that should
13098	 * have been done if need be on the other controller.
13099	 */
13100	if (io->io_hdr.flags & CTL_FLAG_ABORT) {
13101		printf("%s: tag 0x%04x on (%u:%u:%u) aborted\n", __func__,
13102		       io->scsiio.tag_num, io->io_hdr.nexus.initid,
13103		       io->io_hdr.nexus.targ_port,
13104		       io->io_hdr.nexus.targ_lun);
13105		io->io_hdr.port_status = 31338;
13106		ctl_send_datamove_done(io, /*have_lock*/ 0);
13107		return;
13108	}
13109
13110	if ((io->io_hdr.flags & CTL_FLAG_DATA_MASK) == CTL_FLAG_DATA_OUT)
13111		ctl_datamove_remote_write(io);
13112	else if ((io->io_hdr.flags & CTL_FLAG_DATA_MASK) == CTL_FLAG_DATA_IN)
13113		ctl_datamove_remote_read(io);
13114	else {
13115		io->io_hdr.port_status = 31339;
13116		ctl_send_datamove_done(io, /*have_lock*/ 0);
13117	}
13118}
13119
13120static void
13121ctl_process_done(union ctl_io *io)
13122{
13123	struct ctl_lun *lun;
13124	struct ctl_softc *softc = control_softc;
13125	void (*fe_done)(union ctl_io *io);
13126	union ctl_ha_msg msg;
13127	uint32_t targ_port = io->io_hdr.nexus.targ_port;
13128
13129	CTL_DEBUG_PRINT(("ctl_process_done\n"));
13130	fe_done = softc->ctl_ports[targ_port]->fe_done;
13131
13132#ifdef CTL_TIME_IO
13133	if ((time_uptime - io->io_hdr.start_time) > ctl_time_io_secs) {
13134		char str[256];
13135		char path_str[64];
13136		struct sbuf sb;
13137
13138		ctl_scsi_path_string(io, path_str, sizeof(path_str));
13139		sbuf_new(&sb, str, sizeof(str), SBUF_FIXEDLEN);
13140
13141		sbuf_cat(&sb, path_str);
13142		switch (io->io_hdr.io_type) {
13143		case CTL_IO_SCSI:
13144			ctl_scsi_command_string(&io->scsiio, NULL, &sb);
13145			sbuf_printf(&sb, "\n");
13146			sbuf_cat(&sb, path_str);
13147			sbuf_printf(&sb, "Tag: 0x%04x, type %d\n",
13148				    io->scsiio.tag_num, io->scsiio.tag_type);
13149			break;
13150		case CTL_IO_TASK:
13151			sbuf_printf(&sb, "Task I/O type: %d, Tag: 0x%04x, "
13152				    "Tag Type: %d\n", io->taskio.task_action,
13153				    io->taskio.tag_num, io->taskio.tag_type);
13154			break;
13155		default:
13156			panic("%s: Invalid CTL I/O type %d\n",
13157			    __func__, io->io_hdr.io_type);
13158		}
13159		sbuf_cat(&sb, path_str);
13160		sbuf_printf(&sb, "ctl_process_done: %jd seconds\n",
13161			    (intmax_t)time_uptime - io->io_hdr.start_time);
13162		sbuf_finish(&sb);
13163		printf("%s", sbuf_data(&sb));
13164	}
13165#endif /* CTL_TIME_IO */
13166
13167	switch (io->io_hdr.io_type) {
13168	case CTL_IO_SCSI:
13169		break;
13170	case CTL_IO_TASK:
13171		if (ctl_debug & CTL_DEBUG_INFO)
13172			ctl_io_error_print(io, NULL);
13173		fe_done(io);
13174		return;
13175	default:
13176		panic("%s: Invalid CTL I/O type %d\n",
13177		    __func__, io->io_hdr.io_type);
13178	}
13179
13180	lun = (struct ctl_lun *)io->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
13181	if (lun == NULL) {
13182		CTL_DEBUG_PRINT(("NULL LUN for lun %d\n",
13183				 io->io_hdr.nexus.targ_mapped_lun));
13184		goto bailout;
13185	}
13186
13187	mtx_lock(&lun->lun_lock);
13188
13189	/*
13190	 * Check to see if we have any informational exception and status
13191	 * of this command can be modified to report it in form of either
13192	 * RECOVERED ERROR or NO SENSE, depending on MRIE mode page field.
13193	 */
13194	if (lun->ie_reported == 0 && lun->ie_asc != 0 &&
13195	    io->io_hdr.status == CTL_SUCCESS &&
13196	    (io->io_hdr.flags & CTL_FLAG_STATUS_SENT) == 0) {
13197		uint8_t mrie = lun->MODE_IE.mrie;
13198		uint8_t per = ((lun->MODE_RWER.byte3 & SMS_RWER_PER) ||
13199		    (lun->MODE_VER.byte3 & SMS_VER_PER));
13200		if (((mrie == SIEP_MRIE_REC_COND && per) ||
13201		     mrie == SIEP_MRIE_REC_UNCOND ||
13202		     mrie == SIEP_MRIE_NO_SENSE) &&
13203		    (ctl_get_cmd_entry(&io->scsiio, NULL)->flags &
13204		     CTL_CMD_FLAG_NO_SENSE) == 0) {
13205			ctl_set_sense(&io->scsiio,
13206			      /*current_error*/ 1,
13207			      /*sense_key*/ (mrie == SIEP_MRIE_NO_SENSE) ?
13208			        SSD_KEY_NO_SENSE : SSD_KEY_RECOVERED_ERROR,
13209			      /*asc*/ lun->ie_asc,
13210			      /*ascq*/ lun->ie_ascq,
13211			      SSD_ELEM_NONE);
13212			lun->ie_reported = 1;
13213		}
13214	} else if (lun->ie_reported < 0)
13215		lun->ie_reported = 0;
13216
13217	/*
13218	 * Check to see if we have any errors to inject here.  We only
13219	 * inject errors for commands that don't already have errors set.
13220	 */
13221	if (!STAILQ_EMPTY(&lun->error_list) &&
13222	    ((io->io_hdr.status & CTL_STATUS_MASK) == CTL_SUCCESS) &&
13223	    ((io->io_hdr.flags & CTL_FLAG_STATUS_SENT) == 0))
13224		ctl_inject_error(lun, io);
13225
13226	/*
13227	 * XXX KDM how do we treat commands that aren't completed
13228	 * successfully?
13229	 *
13230	 * XXX KDM should we also track I/O latency?
13231	 */
13232	if ((io->io_hdr.status & CTL_STATUS_MASK) == CTL_SUCCESS &&
13233	    io->io_hdr.io_type == CTL_IO_SCSI) {
13234#ifdef CTL_TIME_IO
13235		struct bintime cur_bt;
13236#endif
13237		int type;
13238
13239		if ((io->io_hdr.flags & CTL_FLAG_DATA_MASK) ==
13240		    CTL_FLAG_DATA_IN)
13241			type = CTL_STATS_READ;
13242		else if ((io->io_hdr.flags & CTL_FLAG_DATA_MASK) ==
13243		    CTL_FLAG_DATA_OUT)
13244			type = CTL_STATS_WRITE;
13245		else
13246			type = CTL_STATS_NO_IO;
13247
13248		lun->stats.ports[targ_port].bytes[type] +=
13249		    io->scsiio.kern_total_len;
13250		lun->stats.ports[targ_port].operations[type]++;
13251#ifdef CTL_TIME_IO
13252		bintime_add(&lun->stats.ports[targ_port].dma_time[type],
13253		   &io->io_hdr.dma_bt);
13254		getbinuptime(&cur_bt);
13255		bintime_sub(&cur_bt, &io->io_hdr.start_bt);
13256		bintime_add(&lun->stats.ports[targ_port].time[type], &cur_bt);
13257#endif
13258		lun->stats.ports[targ_port].num_dmas[type] +=
13259		    io->io_hdr.num_dmas;
13260	}
13261
13262	/*
13263	 * Remove this from the OOA queue.
13264	 */
13265	TAILQ_REMOVE(&lun->ooa_queue, &io->io_hdr, ooa_links);
13266#ifdef CTL_TIME_IO
13267	if (TAILQ_EMPTY(&lun->ooa_queue))
13268		lun->last_busy = getsbinuptime();
13269#endif
13270
13271	/*
13272	 * Run through the blocked queue on this LUN and see if anything
13273	 * has become unblocked, now that this transaction is done.
13274	 */
13275	ctl_check_blocked(lun);
13276
13277	/*
13278	 * If the LUN has been invalidated, free it if there is nothing
13279	 * left on its OOA queue.
13280	 */
13281	if ((lun->flags & CTL_LUN_INVALID)
13282	 && TAILQ_EMPTY(&lun->ooa_queue)) {
13283		mtx_unlock(&lun->lun_lock);
13284		mtx_lock(&softc->ctl_lock);
13285		ctl_free_lun(lun);
13286		mtx_unlock(&softc->ctl_lock);
13287	} else
13288		mtx_unlock(&lun->lun_lock);
13289
13290bailout:
13291
13292	/*
13293	 * If this command has been aborted, make sure we set the status
13294	 * properly.  The FETD is responsible for freeing the I/O and doing
13295	 * whatever it needs to do to clean up its state.
13296	 */
13297	if (io->io_hdr.flags & CTL_FLAG_ABORT)
13298		ctl_set_task_aborted(&io->scsiio);
13299
13300	/*
13301	 * If enabled, print command error status.
13302	 */
13303	if ((io->io_hdr.status & CTL_STATUS_MASK) != CTL_SUCCESS &&
13304	    (ctl_debug & CTL_DEBUG_INFO) != 0)
13305		ctl_io_error_print(io, NULL);
13306
13307	/*
13308	 * Tell the FETD or the other shelf controller we're done with this
13309	 * command.  Note that only SCSI commands get to this point.  Task
13310	 * management commands are completed above.
13311	 */
13312	if ((softc->ha_mode != CTL_HA_MODE_XFER) &&
13313	    (io->io_hdr.flags & CTL_FLAG_SENT_2OTHER_SC)) {
13314		memset(&msg, 0, sizeof(msg));
13315		msg.hdr.msg_type = CTL_MSG_FINISH_IO;
13316		msg.hdr.serializing_sc = io->io_hdr.serializing_sc;
13317		msg.hdr.nexus = io->io_hdr.nexus;
13318		ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg,
13319		    sizeof(msg.scsi) - sizeof(msg.scsi.sense_data),
13320		    M_WAITOK);
13321	}
13322
13323	fe_done(io);
13324}
13325
13326#ifdef CTL_WITH_CA
13327/*
13328 * Front end should call this if it doesn't do autosense.  When the request
13329 * sense comes back in from the initiator, we'll dequeue this and send it.
13330 */
13331int
13332ctl_queue_sense(union ctl_io *io)
13333{
13334	struct ctl_lun *lun;
13335	struct ctl_port *port;
13336	struct ctl_softc *softc;
13337	uint32_t initidx, targ_lun;
13338
13339	softc = control_softc;
13340
13341	CTL_DEBUG_PRINT(("ctl_queue_sense\n"));
13342
13343	/*
13344	 * LUN lookup will likely move to the ctl_work_thread() once we
13345	 * have our new queueing infrastructure (that doesn't put things on
13346	 * a per-LUN queue initially).  That is so that we can handle
13347	 * things like an INQUIRY to a LUN that we don't have enabled.  We
13348	 * can't deal with that right now.
13349	 */
13350	mtx_lock(&softc->ctl_lock);
13351
13352	/*
13353	 * If we don't have a LUN for this, just toss the sense
13354	 * information.
13355	 */
13356	port = ctl_io_port(&ctsio->io_hdr);
13357	targ_lun = ctl_lun_map_from_port(port, io->io_hdr.nexus.targ_lun);
13358	if ((targ_lun < CTL_MAX_LUNS)
13359	 && (softc->ctl_luns[targ_lun] != NULL))
13360		lun = softc->ctl_luns[targ_lun];
13361	else
13362		goto bailout;
13363
13364	initidx = ctl_get_initindex(&io->io_hdr.nexus);
13365
13366	mtx_lock(&lun->lun_lock);
13367	/*
13368	 * Already have CA set for this LUN...toss the sense information.
13369	 */
13370	if (ctl_is_set(lun->have_ca, initidx)) {
13371		mtx_unlock(&lun->lun_lock);
13372		goto bailout;
13373	}
13374
13375	memcpy(&lun->pending_sense[initidx], &io->scsiio.sense_data,
13376	       MIN(sizeof(lun->pending_sense[initidx]),
13377	       sizeof(io->scsiio.sense_data)));
13378	ctl_set_mask(lun->have_ca, initidx);
13379	mtx_unlock(&lun->lun_lock);
13380
13381bailout:
13382	mtx_unlock(&softc->ctl_lock);
13383
13384	ctl_free_io(io);
13385
13386	return (CTL_RETVAL_COMPLETE);
13387}
13388#endif
13389
13390/*
13391 * Primary command inlet from frontend ports.  All SCSI and task I/O
13392 * requests must go through this function.
13393 */
13394int
13395ctl_queue(union ctl_io *io)
13396{
13397	struct ctl_port *port;
13398
13399	CTL_DEBUG_PRINT(("ctl_queue cdb[0]=%02X\n", io->scsiio.cdb[0]));
13400
13401#ifdef CTL_TIME_IO
13402	io->io_hdr.start_time = time_uptime;
13403	getbinuptime(&io->io_hdr.start_bt);
13404#endif /* CTL_TIME_IO */
13405
13406	/* Map FE-specific LUN ID into global one. */
13407	port = ctl_io_port(&io->io_hdr);
13408	io->io_hdr.nexus.targ_mapped_lun =
13409	    ctl_lun_map_from_port(port, io->io_hdr.nexus.targ_lun);
13410
13411	switch (io->io_hdr.io_type) {
13412	case CTL_IO_SCSI:
13413	case CTL_IO_TASK:
13414		if (ctl_debug & CTL_DEBUG_CDB)
13415			ctl_io_print(io);
13416		ctl_enqueue_incoming(io);
13417		break;
13418	default:
13419		printf("ctl_queue: unknown I/O type %d\n", io->io_hdr.io_type);
13420		return (EINVAL);
13421	}
13422
13423	return (CTL_RETVAL_COMPLETE);
13424}
13425
13426#ifdef CTL_IO_DELAY
13427static void
13428ctl_done_timer_wakeup(void *arg)
13429{
13430	union ctl_io *io;
13431
13432	io = (union ctl_io *)arg;
13433	ctl_done(io);
13434}
13435#endif /* CTL_IO_DELAY */
13436
13437void
13438ctl_serseq_done(union ctl_io *io)
13439{
13440	struct ctl_lun *lun;
13441
13442	lun = (struct ctl_lun *)io->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
13443	if (lun->be_lun == NULL ||
13444	    lun->be_lun->serseq == CTL_LUN_SERSEQ_OFF)
13445		return;
13446	mtx_lock(&lun->lun_lock);
13447	io->io_hdr.flags |= CTL_FLAG_SERSEQ_DONE;
13448	ctl_check_blocked(lun);
13449	mtx_unlock(&lun->lun_lock);
13450}
13451
13452void
13453ctl_done(union ctl_io *io)
13454{
13455
13456	/*
13457	 * Enable this to catch duplicate completion issues.
13458	 */
13459#if 0
13460	if (io->io_hdr.flags & CTL_FLAG_ALREADY_DONE) {
13461		printf("%s: type %d msg %d cdb %x iptl: "
13462		       "%u:%u:%u tag 0x%04x "
13463		       "flag %#x status %x\n",
13464			__func__,
13465			io->io_hdr.io_type,
13466			io->io_hdr.msg_type,
13467			io->scsiio.cdb[0],
13468			io->io_hdr.nexus.initid,
13469			io->io_hdr.nexus.targ_port,
13470			io->io_hdr.nexus.targ_lun,
13471			(io->io_hdr.io_type ==
13472			CTL_IO_TASK) ?
13473			io->taskio.tag_num :
13474			io->scsiio.tag_num,
13475		        io->io_hdr.flags,
13476			io->io_hdr.status);
13477	} else
13478		io->io_hdr.flags |= CTL_FLAG_ALREADY_DONE;
13479#endif
13480
13481	/*
13482	 * This is an internal copy of an I/O, and should not go through
13483	 * the normal done processing logic.
13484	 */
13485	if (io->io_hdr.flags & CTL_FLAG_INT_COPY)
13486		return;
13487
13488#ifdef CTL_IO_DELAY
13489	if (io->io_hdr.flags & CTL_FLAG_DELAY_DONE) {
13490		io->io_hdr.flags &= ~CTL_FLAG_DELAY_DONE;
13491	} else {
13492		struct ctl_lun *lun;
13493
13494		lun =(struct ctl_lun *)io->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
13495
13496		if ((lun != NULL)
13497		 && (lun->delay_info.done_delay > 0)) {
13498
13499			callout_init(&io->io_hdr.delay_callout, /*mpsafe*/ 1);
13500			io->io_hdr.flags |= CTL_FLAG_DELAY_DONE;
13501			callout_reset(&io->io_hdr.delay_callout,
13502				      lun->delay_info.done_delay * hz,
13503				      ctl_done_timer_wakeup, io);
13504			if (lun->delay_info.done_type == CTL_DELAY_TYPE_ONESHOT)
13505				lun->delay_info.done_delay = 0;
13506			return;
13507		}
13508	}
13509#endif /* CTL_IO_DELAY */
13510
13511	ctl_enqueue_done(io);
13512}
13513
13514static void
13515ctl_work_thread(void *arg)
13516{
13517	struct ctl_thread *thr = (struct ctl_thread *)arg;
13518	struct ctl_softc *softc = thr->ctl_softc;
13519	union ctl_io *io;
13520	int retval;
13521
13522	CTL_DEBUG_PRINT(("ctl_work_thread starting\n"));
13523
13524	for (;;) {
13525		/*
13526		 * We handle the queues in this order:
13527		 * - ISC
13528		 * - done queue (to free up resources, unblock other commands)
13529		 * - RtR queue
13530		 * - incoming queue
13531		 *
13532		 * If those queues are empty, we break out of the loop and
13533		 * go to sleep.
13534		 */
13535		mtx_lock(&thr->queue_lock);
13536		io = (union ctl_io *)STAILQ_FIRST(&thr->isc_queue);
13537		if (io != NULL) {
13538			STAILQ_REMOVE_HEAD(&thr->isc_queue, links);
13539			mtx_unlock(&thr->queue_lock);
13540			ctl_handle_isc(io);
13541			continue;
13542		}
13543		io = (union ctl_io *)STAILQ_FIRST(&thr->done_queue);
13544		if (io != NULL) {
13545			STAILQ_REMOVE_HEAD(&thr->done_queue, links);
13546			/* clear any blocked commands, call fe_done */
13547			mtx_unlock(&thr->queue_lock);
13548			ctl_process_done(io);
13549			continue;
13550		}
13551		io = (union ctl_io *)STAILQ_FIRST(&thr->incoming_queue);
13552		if (io != NULL) {
13553			STAILQ_REMOVE_HEAD(&thr->incoming_queue, links);
13554			mtx_unlock(&thr->queue_lock);
13555			if (io->io_hdr.io_type == CTL_IO_TASK)
13556				ctl_run_task(io);
13557			else
13558				ctl_scsiio_precheck(softc, &io->scsiio);
13559			continue;
13560		}
13561		io = (union ctl_io *)STAILQ_FIRST(&thr->rtr_queue);
13562		if (io != NULL) {
13563			STAILQ_REMOVE_HEAD(&thr->rtr_queue, links);
13564			mtx_unlock(&thr->queue_lock);
13565			retval = ctl_scsiio(&io->scsiio);
13566			if (retval != CTL_RETVAL_COMPLETE)
13567				CTL_DEBUG_PRINT(("ctl_scsiio failed\n"));
13568			continue;
13569		}
13570
13571		/* Sleep until we have something to do. */
13572		mtx_sleep(thr, &thr->queue_lock, PDROP | PRIBIO, "-", 0);
13573	}
13574}
13575
13576static void
13577ctl_lun_thread(void *arg)
13578{
13579	struct ctl_softc *softc = (struct ctl_softc *)arg;
13580	struct ctl_be_lun *be_lun;
13581
13582	CTL_DEBUG_PRINT(("ctl_lun_thread starting\n"));
13583
13584	for (;;) {
13585		mtx_lock(&softc->ctl_lock);
13586		be_lun = STAILQ_FIRST(&softc->pending_lun_queue);
13587		if (be_lun != NULL) {
13588			STAILQ_REMOVE_HEAD(&softc->pending_lun_queue, links);
13589			mtx_unlock(&softc->ctl_lock);
13590			ctl_create_lun(be_lun);
13591			continue;
13592		}
13593
13594		/* Sleep until we have something to do. */
13595		mtx_sleep(&softc->pending_lun_queue, &softc->ctl_lock,
13596		    PDROP | PRIBIO, "-", 0);
13597	}
13598}
13599
13600static void
13601ctl_thresh_thread(void *arg)
13602{
13603	struct ctl_softc *softc = (struct ctl_softc *)arg;
13604	struct ctl_lun *lun;
13605	struct ctl_logical_block_provisioning_page *page;
13606	const char *attr;
13607	union ctl_ha_msg msg;
13608	uint64_t thres, val;
13609	int i, e, set;
13610
13611	CTL_DEBUG_PRINT(("ctl_thresh_thread starting\n"));
13612
13613	for (;;) {
13614		mtx_lock(&softc->ctl_lock);
13615		STAILQ_FOREACH(lun, &softc->lun_list, links) {
13616			if ((lun->flags & CTL_LUN_DISABLED) ||
13617			    (lun->flags & CTL_LUN_NO_MEDIA) ||
13618			    lun->backend->lun_attr == NULL)
13619				continue;
13620			if ((lun->flags & CTL_LUN_PRIMARY_SC) == 0 &&
13621			    softc->ha_mode == CTL_HA_MODE_XFER)
13622				continue;
13623			if ((lun->MODE_RWER.byte8 & SMS_RWER_LBPERE) == 0)
13624				continue;
13625			e = 0;
13626			page = &lun->MODE_LBP;
13627			for (i = 0; i < CTL_NUM_LBP_THRESH; i++) {
13628				if ((page->descr[i].flags & SLBPPD_ENABLED) == 0)
13629					continue;
13630				thres = scsi_4btoul(page->descr[i].count);
13631				thres <<= CTL_LBP_EXPONENT;
13632				switch (page->descr[i].resource) {
13633				case 0x01:
13634					attr = "blocksavail";
13635					break;
13636				case 0x02:
13637					attr = "blocksused";
13638					break;
13639				case 0xf1:
13640					attr = "poolblocksavail";
13641					break;
13642				case 0xf2:
13643					attr = "poolblocksused";
13644					break;
13645				default:
13646					continue;
13647				}
13648				mtx_unlock(&softc->ctl_lock); // XXX
13649				val = lun->backend->lun_attr(
13650				    lun->be_lun->be_lun, attr);
13651				mtx_lock(&softc->ctl_lock);
13652				if (val == UINT64_MAX)
13653					continue;
13654				if ((page->descr[i].flags & SLBPPD_ARMING_MASK)
13655				    == SLBPPD_ARMING_INC)
13656					e = (val >= thres);
13657				else
13658					e = (val <= thres);
13659				if (e)
13660					break;
13661			}
13662			mtx_lock(&lun->lun_lock);
13663			if (e) {
13664				scsi_u64to8b((uint8_t *)&page->descr[i] -
13665				    (uint8_t *)page, lun->ua_tpt_info);
13666				if (lun->lasttpt == 0 ||
13667				    time_uptime - lun->lasttpt >= CTL_LBP_UA_PERIOD) {
13668					lun->lasttpt = time_uptime;
13669					ctl_est_ua_all(lun, -1, CTL_UA_THIN_PROV_THRES);
13670					set = 1;
13671				} else
13672					set = 0;
13673			} else {
13674				lun->lasttpt = 0;
13675				ctl_clr_ua_all(lun, -1, CTL_UA_THIN_PROV_THRES);
13676				set = -1;
13677			}
13678			mtx_unlock(&lun->lun_lock);
13679			if (set != 0 &&
13680			    lun->ctl_softc->ha_mode == CTL_HA_MODE_XFER) {
13681				/* Send msg to other side. */
13682				bzero(&msg.ua, sizeof(msg.ua));
13683				msg.hdr.msg_type = CTL_MSG_UA;
13684				msg.hdr.nexus.initid = -1;
13685				msg.hdr.nexus.targ_port = -1;
13686				msg.hdr.nexus.targ_lun = lun->lun;
13687				msg.hdr.nexus.targ_mapped_lun = lun->lun;
13688				msg.ua.ua_all = 1;
13689				msg.ua.ua_set = (set > 0);
13690				msg.ua.ua_type = CTL_UA_THIN_PROV_THRES;
13691				memcpy(msg.ua.ua_info, lun->ua_tpt_info, 8);
13692				mtx_unlock(&softc->ctl_lock); // XXX
13693				ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg,
13694				    sizeof(msg.ua), M_WAITOK);
13695				mtx_lock(&softc->ctl_lock);
13696			}
13697		}
13698		mtx_unlock(&softc->ctl_lock);
13699		pause("-", CTL_LBP_PERIOD * hz);
13700	}
13701}
13702
13703static void
13704ctl_enqueue_incoming(union ctl_io *io)
13705{
13706	struct ctl_softc *softc = control_softc;
13707	struct ctl_thread *thr;
13708	u_int idx;
13709
13710	idx = (io->io_hdr.nexus.targ_port * 127 +
13711	       io->io_hdr.nexus.initid) % worker_threads;
13712	thr = &softc->threads[idx];
13713	mtx_lock(&thr->queue_lock);
13714	STAILQ_INSERT_TAIL(&thr->incoming_queue, &io->io_hdr, links);
13715	mtx_unlock(&thr->queue_lock);
13716	wakeup(thr);
13717}
13718
13719static void
13720ctl_enqueue_rtr(union ctl_io *io)
13721{
13722	struct ctl_softc *softc = control_softc;
13723	struct ctl_thread *thr;
13724
13725	thr = &softc->threads[io->io_hdr.nexus.targ_mapped_lun % worker_threads];
13726	mtx_lock(&thr->queue_lock);
13727	STAILQ_INSERT_TAIL(&thr->rtr_queue, &io->io_hdr, links);
13728	mtx_unlock(&thr->queue_lock);
13729	wakeup(thr);
13730}
13731
13732static void
13733ctl_enqueue_done(union ctl_io *io)
13734{
13735	struct ctl_softc *softc = control_softc;
13736	struct ctl_thread *thr;
13737
13738	thr = &softc->threads[io->io_hdr.nexus.targ_mapped_lun % worker_threads];
13739	mtx_lock(&thr->queue_lock);
13740	STAILQ_INSERT_TAIL(&thr->done_queue, &io->io_hdr, links);
13741	mtx_unlock(&thr->queue_lock);
13742	wakeup(thr);
13743}
13744
13745static void
13746ctl_enqueue_isc(union ctl_io *io)
13747{
13748	struct ctl_softc *softc = control_softc;
13749	struct ctl_thread *thr;
13750
13751	thr = &softc->threads[io->io_hdr.nexus.targ_mapped_lun % worker_threads];
13752	mtx_lock(&thr->queue_lock);
13753	STAILQ_INSERT_TAIL(&thr->isc_queue, &io->io_hdr, links);
13754	mtx_unlock(&thr->queue_lock);
13755	wakeup(thr);
13756}
13757
13758/*
13759 *  vim: ts=8
13760 */
13761