xref: /freebsd/sys/cam/ctl/ctl.c (revision b6a05070fa77edc7ce6e60b61623fd806e807be6)
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$");
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 
86 struct 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  */
96 const static struct copan_debugconf_subpage debugconf_page_default = {
97 	DBGCNF_PAGE_CODE | SMPH_SPF,	/* page_code */
98 	DBGCNF_SUBPAGE_CODE,		/* subpage */
99 	{(sizeof(struct copan_debugconf_subpage) - 4) >> 8,
100 	 (sizeof(struct copan_debugconf_subpage) - 4) >> 0}, /* page_length */
101 	DBGCNF_VERSION,			/* page_version */
102 	{CTL_TIME_IO_DEFAULT_SECS>>8,
103 	 CTL_TIME_IO_DEFAULT_SECS>>0},	/* ctl_time_io_secs */
104 };
105 
106 const static struct copan_debugconf_subpage debugconf_page_changeable = {
107 	DBGCNF_PAGE_CODE | SMPH_SPF,	/* page_code */
108 	DBGCNF_SUBPAGE_CODE,		/* subpage */
109 	{(sizeof(struct copan_debugconf_subpage) - 4) >> 8,
110 	 (sizeof(struct copan_debugconf_subpage) - 4) >> 0}, /* page_length */
111 	0,				/* page_version */
112 	{0xff,0xff},			/* ctl_time_io_secs */
113 };
114 
115 const static struct scsi_da_rw_recovery_page rw_er_page_default = {
116 	/*page_code*/SMS_RW_ERROR_RECOVERY_PAGE,
117 	/*page_length*/sizeof(struct scsi_da_rw_recovery_page) - 2,
118 	/*byte3*/SMS_RWER_AWRE|SMS_RWER_ARRE,
119 	/*read_retry_count*/0,
120 	/*correction_span*/0,
121 	/*head_offset_count*/0,
122 	/*data_strobe_offset_cnt*/0,
123 	/*byte8*/SMS_RWER_LBPERE,
124 	/*write_retry_count*/0,
125 	/*reserved2*/0,
126 	/*recovery_time_limit*/{0, 0},
127 };
128 
129 const static struct scsi_da_rw_recovery_page rw_er_page_changeable = {
130 	/*page_code*/SMS_RW_ERROR_RECOVERY_PAGE,
131 	/*page_length*/sizeof(struct scsi_da_rw_recovery_page) - 2,
132 	/*byte3*/0,
133 	/*read_retry_count*/0,
134 	/*correction_span*/0,
135 	/*head_offset_count*/0,
136 	/*data_strobe_offset_cnt*/0,
137 	/*byte8*/0,
138 	/*write_retry_count*/0,
139 	/*reserved2*/0,
140 	/*recovery_time_limit*/{0, 0},
141 };
142 
143 const static struct scsi_format_page format_page_default = {
144 	/*page_code*/SMS_FORMAT_DEVICE_PAGE,
145 	/*page_length*/sizeof(struct scsi_format_page) - 2,
146 	/*tracks_per_zone*/ {0, 0},
147 	/*alt_sectors_per_zone*/ {0, 0},
148 	/*alt_tracks_per_zone*/ {0, 0},
149 	/*alt_tracks_per_lun*/ {0, 0},
150 	/*sectors_per_track*/ {(CTL_DEFAULT_SECTORS_PER_TRACK >> 8) & 0xff,
151 			        CTL_DEFAULT_SECTORS_PER_TRACK & 0xff},
152 	/*bytes_per_sector*/ {0, 0},
153 	/*interleave*/ {0, 0},
154 	/*track_skew*/ {0, 0},
155 	/*cylinder_skew*/ {0, 0},
156 	/*flags*/ SFP_HSEC,
157 	/*reserved*/ {0, 0, 0}
158 };
159 
160 const static struct scsi_format_page format_page_changeable = {
161 	/*page_code*/SMS_FORMAT_DEVICE_PAGE,
162 	/*page_length*/sizeof(struct scsi_format_page) - 2,
163 	/*tracks_per_zone*/ {0, 0},
164 	/*alt_sectors_per_zone*/ {0, 0},
165 	/*alt_tracks_per_zone*/ {0, 0},
166 	/*alt_tracks_per_lun*/ {0, 0},
167 	/*sectors_per_track*/ {0, 0},
168 	/*bytes_per_sector*/ {0, 0},
169 	/*interleave*/ {0, 0},
170 	/*track_skew*/ {0, 0},
171 	/*cylinder_skew*/ {0, 0},
172 	/*flags*/ 0,
173 	/*reserved*/ {0, 0, 0}
174 };
175 
176 const static struct scsi_rigid_disk_page rigid_disk_page_default = {
177 	/*page_code*/SMS_RIGID_DISK_PAGE,
178 	/*page_length*/sizeof(struct scsi_rigid_disk_page) - 2,
179 	/*cylinders*/ {0, 0, 0},
180 	/*heads*/ CTL_DEFAULT_HEADS,
181 	/*start_write_precomp*/ {0, 0, 0},
182 	/*start_reduced_current*/ {0, 0, 0},
183 	/*step_rate*/ {0, 0},
184 	/*landing_zone_cylinder*/ {0, 0, 0},
185 	/*rpl*/ SRDP_RPL_DISABLED,
186 	/*rotational_offset*/ 0,
187 	/*reserved1*/ 0,
188 	/*rotation_rate*/ {(CTL_DEFAULT_ROTATION_RATE >> 8) & 0xff,
189 			   CTL_DEFAULT_ROTATION_RATE & 0xff},
190 	/*reserved2*/ {0, 0}
191 };
192 
193 const static struct scsi_rigid_disk_page rigid_disk_page_changeable = {
194 	/*page_code*/SMS_RIGID_DISK_PAGE,
195 	/*page_length*/sizeof(struct scsi_rigid_disk_page) - 2,
196 	/*cylinders*/ {0, 0, 0},
197 	/*heads*/ 0,
198 	/*start_write_precomp*/ {0, 0, 0},
199 	/*start_reduced_current*/ {0, 0, 0},
200 	/*step_rate*/ {0, 0},
201 	/*landing_zone_cylinder*/ {0, 0, 0},
202 	/*rpl*/ 0,
203 	/*rotational_offset*/ 0,
204 	/*reserved1*/ 0,
205 	/*rotation_rate*/ {0, 0},
206 	/*reserved2*/ {0, 0}
207 };
208 
209 const static struct scsi_caching_page caching_page_default = {
210 	/*page_code*/SMS_CACHING_PAGE,
211 	/*page_length*/sizeof(struct scsi_caching_page) - 2,
212 	/*flags1*/ SCP_DISC | SCP_WCE,
213 	/*ret_priority*/ 0,
214 	/*disable_pf_transfer_len*/ {0xff, 0xff},
215 	/*min_prefetch*/ {0, 0},
216 	/*max_prefetch*/ {0xff, 0xff},
217 	/*max_pf_ceiling*/ {0xff, 0xff},
218 	/*flags2*/ 0,
219 	/*cache_segments*/ 0,
220 	/*cache_seg_size*/ {0, 0},
221 	/*reserved*/ 0,
222 	/*non_cache_seg_size*/ {0, 0, 0}
223 };
224 
225 const static struct scsi_caching_page caching_page_changeable = {
226 	/*page_code*/SMS_CACHING_PAGE,
227 	/*page_length*/sizeof(struct scsi_caching_page) - 2,
228 	/*flags1*/ SCP_WCE | SCP_RCD,
229 	/*ret_priority*/ 0,
230 	/*disable_pf_transfer_len*/ {0, 0},
231 	/*min_prefetch*/ {0, 0},
232 	/*max_prefetch*/ {0, 0},
233 	/*max_pf_ceiling*/ {0, 0},
234 	/*flags2*/ 0,
235 	/*cache_segments*/ 0,
236 	/*cache_seg_size*/ {0, 0},
237 	/*reserved*/ 0,
238 	/*non_cache_seg_size*/ {0, 0, 0}
239 };
240 
241 const static struct scsi_control_page control_page_default = {
242 	/*page_code*/SMS_CONTROL_MODE_PAGE,
243 	/*page_length*/sizeof(struct scsi_control_page) - 2,
244 	/*rlec*/0,
245 	/*queue_flags*/SCP_QUEUE_ALG_RESTRICTED,
246 	/*eca_and_aen*/0,
247 	/*flags4*/SCP_TAS,
248 	/*aen_holdoff_period*/{0, 0},
249 	/*busy_timeout_period*/{0, 0},
250 	/*extended_selftest_completion_time*/{0, 0}
251 };
252 
253 const static struct scsi_control_page control_page_changeable = {
254 	/*page_code*/SMS_CONTROL_MODE_PAGE,
255 	/*page_length*/sizeof(struct scsi_control_page) - 2,
256 	/*rlec*/SCP_DSENSE,
257 	/*queue_flags*/SCP_QUEUE_ALG_MASK,
258 	/*eca_and_aen*/SCP_SWP,
259 	/*flags4*/0,
260 	/*aen_holdoff_period*/{0, 0},
261 	/*busy_timeout_period*/{0, 0},
262 	/*extended_selftest_completion_time*/{0, 0}
263 };
264 
265 #define CTL_CEM_LEN	(sizeof(struct scsi_control_ext_page) - 4)
266 
267 const static struct scsi_control_ext_page control_ext_page_default = {
268 	/*page_code*/SMS_CONTROL_MODE_PAGE | SMPH_SPF,
269 	/*subpage_code*/0x01,
270 	/*page_length*/{CTL_CEM_LEN >> 8, CTL_CEM_LEN},
271 	/*flags*/0,
272 	/*prio*/0,
273 	/*max_sense*/0
274 };
275 
276 const static struct scsi_control_ext_page control_ext_page_changeable = {
277 	/*page_code*/SMS_CONTROL_MODE_PAGE | SMPH_SPF,
278 	/*subpage_code*/0x01,
279 	/*page_length*/{CTL_CEM_LEN >> 8, CTL_CEM_LEN},
280 	/*flags*/0,
281 	/*prio*/0,
282 	/*max_sense*/0
283 };
284 
285 const static struct scsi_info_exceptions_page ie_page_default = {
286 	/*page_code*/SMS_INFO_EXCEPTIONS_PAGE,
287 	/*page_length*/sizeof(struct scsi_info_exceptions_page) - 2,
288 	/*info_flags*/SIEP_FLAGS_DEXCPT,
289 	/*mrie*/0,
290 	/*interval_timer*/{0, 0, 0, 0},
291 	/*report_count*/{0, 0, 0, 0}
292 };
293 
294 const static struct scsi_info_exceptions_page ie_page_changeable = {
295 	/*page_code*/SMS_INFO_EXCEPTIONS_PAGE,
296 	/*page_length*/sizeof(struct scsi_info_exceptions_page) - 2,
297 	/*info_flags*/0,
298 	/*mrie*/0,
299 	/*interval_timer*/{0, 0, 0, 0},
300 	/*report_count*/{0, 0, 0, 0}
301 };
302 
303 #define CTL_LBPM_LEN	(sizeof(struct ctl_logical_block_provisioning_page) - 4)
304 
305 const 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 
331 const 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 
357 const 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 
380 const 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 
403 SYSCTL_NODE(_kern_cam, OID_AUTO, ctl, CTLFLAG_RD, 0, "CAM Target Layer");
404 static int worker_threads = -1;
405 SYSCTL_INT(_kern_cam_ctl, OID_AUTO, worker_threads, CTLFLAG_RDTUN,
406     &worker_threads, 1, "Number of worker threads");
407 static int ctl_debug = CTL_DEBUG_NONE;
408 SYSCTL_INT(_kern_cam_ctl, OID_AUTO, debug, CTLFLAG_RWTUN,
409     &ctl_debug, 0, "Enabled debug flags");
410 
411 /*
412  * Supported pages (0x00), Serial number (0x80), Device ID (0x83),
413  * Extended INQUIRY Data (0x86), Mode Page Policy (0x87),
414  * SCSI Ports (0x88), Third-party Copy (0x8F), Block limits (0xB0),
415  * Block Device Characteristics (0xB1) and Logical Block Provisioning (0xB2)
416  */
417 #define SCSI_EVPD_NUM_SUPPORTED_PAGES	10
418 
419 static void ctl_isc_event_handler(ctl_ha_channel chanel, ctl_ha_event event,
420 				  int param);
421 static void ctl_copy_sense_data(union ctl_ha_msg *src, union ctl_io *dest);
422 static void ctl_copy_sense_data_back(union ctl_io *src, union ctl_ha_msg *dest);
423 static int ctl_init(void);
424 void ctl_shutdown(void);
425 static int ctl_open(struct cdev *dev, int flags, int fmt, struct thread *td);
426 static int ctl_close(struct cdev *dev, int flags, int fmt, struct thread *td);
427 static int ctl_serialize_other_sc_cmd(struct ctl_scsiio *ctsio);
428 static void ctl_ioctl_fill_ooa(struct ctl_lun *lun, uint32_t *cur_fill_num,
429 			      struct ctl_ooa *ooa_hdr,
430 			      struct ctl_ooa_entry *kern_entries);
431 static int ctl_ioctl(struct cdev *dev, u_long cmd, caddr_t addr, int flag,
432 		     struct thread *td);
433 static int ctl_alloc_lun(struct ctl_softc *ctl_softc, struct ctl_lun *lun,
434 			 struct ctl_be_lun *be_lun);
435 static int ctl_free_lun(struct ctl_lun *lun);
436 static void ctl_create_lun(struct ctl_be_lun *be_lun);
437 static struct ctl_port * ctl_io_port(struct ctl_io_hdr *io_hdr);
438 
439 static int ctl_do_mode_select(union ctl_io *io);
440 static int ctl_pro_preempt(struct ctl_softc *softc, struct ctl_lun *lun,
441 			   uint64_t res_key, uint64_t sa_res_key,
442 			   uint8_t type, uint32_t residx,
443 			   struct ctl_scsiio *ctsio,
444 			   struct scsi_per_res_out *cdb,
445 			   struct scsi_per_res_out_parms* param);
446 static void ctl_pro_preempt_other(struct ctl_lun *lun,
447 				  union ctl_ha_msg *msg);
448 static void ctl_hndl_per_res_out_on_other_sc(union ctl_ha_msg *msg);
449 static int ctl_inquiry_evpd_supported(struct ctl_scsiio *ctsio, int alloc_len);
450 static int ctl_inquiry_evpd_serial(struct ctl_scsiio *ctsio, int alloc_len);
451 static int ctl_inquiry_evpd_devid(struct ctl_scsiio *ctsio, int alloc_len);
452 static int ctl_inquiry_evpd_eid(struct ctl_scsiio *ctsio, int alloc_len);
453 static int ctl_inquiry_evpd_mpp(struct ctl_scsiio *ctsio, int alloc_len);
454 static int ctl_inquiry_evpd_scsi_ports(struct ctl_scsiio *ctsio,
455 					 int alloc_len);
456 static int ctl_inquiry_evpd_block_limits(struct ctl_scsiio *ctsio,
457 					 int alloc_len);
458 static int ctl_inquiry_evpd_bdc(struct ctl_scsiio *ctsio, int alloc_len);
459 static int ctl_inquiry_evpd_lbp(struct ctl_scsiio *ctsio, int alloc_len);
460 static int ctl_inquiry_evpd(struct ctl_scsiio *ctsio);
461 static int ctl_inquiry_std(struct ctl_scsiio *ctsio);
462 static int ctl_get_lba_len(union ctl_io *io, uint64_t *lba, uint64_t *len);
463 static ctl_action ctl_extent_check(union ctl_io *io1, union ctl_io *io2,
464     bool seq);
465 static ctl_action ctl_extent_check_seq(union ctl_io *io1, union ctl_io *io2);
466 static ctl_action ctl_check_for_blockage(struct ctl_lun *lun,
467     union ctl_io *pending_io, union ctl_io *ooa_io);
468 static ctl_action ctl_check_ooa(struct ctl_lun *lun, union ctl_io *pending_io,
469 				union ctl_io *starting_io);
470 static int ctl_check_blocked(struct ctl_lun *lun);
471 static int ctl_scsiio_lun_check(struct ctl_lun *lun,
472 				const struct ctl_cmd_entry *entry,
473 				struct ctl_scsiio *ctsio);
474 static void ctl_failover_lun(union ctl_io *io);
475 static int ctl_scsiio_precheck(struct ctl_softc *ctl_softc,
476 			       struct ctl_scsiio *ctsio);
477 static int ctl_scsiio(struct ctl_scsiio *ctsio);
478 
479 static int ctl_bus_reset(struct ctl_softc *ctl_softc, union ctl_io *io);
480 static int ctl_target_reset(struct ctl_softc *ctl_softc, union ctl_io *io,
481 			    ctl_ua_type ua_type);
482 static int ctl_do_lun_reset(struct ctl_lun *lun, union ctl_io *io,
483 			 ctl_ua_type ua_type);
484 static int ctl_lun_reset(struct ctl_softc *ctl_softc, union ctl_io *io);
485 static int ctl_abort_task(union ctl_io *io);
486 static int ctl_abort_task_set(union ctl_io *io);
487 static int ctl_query_task(union ctl_io *io, int task_set);
488 static int ctl_i_t_nexus_reset(union ctl_io *io);
489 static int ctl_query_async_event(union ctl_io *io);
490 static void ctl_run_task(union ctl_io *io);
491 #ifdef CTL_IO_DELAY
492 static void ctl_datamove_timer_wakeup(void *arg);
493 static void ctl_done_timer_wakeup(void *arg);
494 #endif /* CTL_IO_DELAY */
495 
496 static void ctl_send_datamove_done(union ctl_io *io, int have_lock);
497 static void ctl_datamove_remote_write_cb(struct ctl_ha_dt_req *rq);
498 static int ctl_datamove_remote_dm_write_cb(union ctl_io *io);
499 static void ctl_datamove_remote_write(union ctl_io *io);
500 static int ctl_datamove_remote_dm_read_cb(union ctl_io *io);
501 static void ctl_datamove_remote_read_cb(struct ctl_ha_dt_req *rq);
502 static int ctl_datamove_remote_sgl_setup(union ctl_io *io);
503 static int ctl_datamove_remote_xfer(union ctl_io *io, unsigned command,
504 				    ctl_ha_dt_cb callback);
505 static void ctl_datamove_remote_read(union ctl_io *io);
506 static void ctl_datamove_remote(union ctl_io *io);
507 static void ctl_process_done(union ctl_io *io);
508 static void ctl_lun_thread(void *arg);
509 static void ctl_thresh_thread(void *arg);
510 static void ctl_work_thread(void *arg);
511 static void ctl_enqueue_incoming(union ctl_io *io);
512 static void ctl_enqueue_rtr(union ctl_io *io);
513 static void ctl_enqueue_done(union ctl_io *io);
514 static void ctl_enqueue_isc(union ctl_io *io);
515 static const struct ctl_cmd_entry *
516     ctl_get_cmd_entry(struct ctl_scsiio *ctsio, int *sa);
517 static const struct ctl_cmd_entry *
518     ctl_validate_command(struct ctl_scsiio *ctsio);
519 static int ctl_cmd_applicable(uint8_t lun_type,
520     const struct ctl_cmd_entry *entry);
521 
522 static uint64_t ctl_get_prkey(struct ctl_lun *lun, uint32_t residx);
523 static void ctl_clr_prkey(struct ctl_lun *lun, uint32_t residx);
524 static void ctl_alloc_prkey(struct ctl_lun *lun, uint32_t residx);
525 static void ctl_set_prkey(struct ctl_lun *lun, uint32_t residx, uint64_t key);
526 
527 /*
528  * Load the serialization table.  This isn't very pretty, but is probably
529  * the easiest way to do it.
530  */
531 #include "ctl_ser_table.c"
532 
533 /*
534  * We only need to define open, close and ioctl routines for this driver.
535  */
536 static struct cdevsw ctl_cdevsw = {
537 	.d_version =	D_VERSION,
538 	.d_flags =	0,
539 	.d_open =	ctl_open,
540 	.d_close =	ctl_close,
541 	.d_ioctl =	ctl_ioctl,
542 	.d_name =	"ctl",
543 };
544 
545 
546 MALLOC_DEFINE(M_CTL, "ctlmem", "Memory used for CTL");
547 
548 static int ctl_module_event_handler(module_t, int /*modeventtype_t*/, void *);
549 
550 static moduledata_t ctl_moduledata = {
551 	"ctl",
552 	ctl_module_event_handler,
553 	NULL
554 };
555 
556 DECLARE_MODULE(ctl, ctl_moduledata, SI_SUB_CONFIGURE, SI_ORDER_THIRD);
557 MODULE_VERSION(ctl, 1);
558 
559 static struct ctl_frontend ha_frontend =
560 {
561 	.name = "ha",
562 };
563 
564 static void
565 ctl_ha_datamove(union ctl_io *io)
566 {
567 	struct ctl_lun *lun;
568 	struct ctl_sg_entry *sgl;
569 	union ctl_ha_msg msg;
570 	uint32_t sg_entries_sent;
571 	int do_sg_copy, i, j;
572 
573 	lun = (struct ctl_lun *)io->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
574 	memset(&msg.dt, 0, sizeof(msg.dt));
575 	msg.hdr.msg_type = CTL_MSG_DATAMOVE;
576 	msg.hdr.original_sc = io->io_hdr.original_sc;
577 	msg.hdr.serializing_sc = io;
578 	msg.hdr.nexus = io->io_hdr.nexus;
579 	msg.hdr.status = io->io_hdr.status;
580 	msg.dt.flags = io->io_hdr.flags;
581 
582 	/*
583 	 * We convert everything into a S/G list here.  We can't
584 	 * pass by reference, only by value between controllers.
585 	 * So we can't pass a pointer to the S/G list, only as many
586 	 * S/G entries as we can fit in here.  If it's possible for
587 	 * us to get more than CTL_HA_MAX_SG_ENTRIES S/G entries,
588 	 * then we need to break this up into multiple transfers.
589 	 */
590 	if (io->scsiio.kern_sg_entries == 0) {
591 		msg.dt.kern_sg_entries = 1;
592 #if 0
593 		if (io->io_hdr.flags & CTL_FLAG_BUS_ADDR) {
594 			msg.dt.sg_list[0].addr = io->scsiio.kern_data_ptr;
595 		} else {
596 			/* XXX KDM use busdma here! */
597 			msg.dt.sg_list[0].addr =
598 			    (void *)vtophys(io->scsiio.kern_data_ptr);
599 		}
600 #else
601 		KASSERT((io->io_hdr.flags & CTL_FLAG_BUS_ADDR) == 0,
602 		    ("HA does not support BUS_ADDR"));
603 		msg.dt.sg_list[0].addr = io->scsiio.kern_data_ptr;
604 #endif
605 		msg.dt.sg_list[0].len = io->scsiio.kern_data_len;
606 		do_sg_copy = 0;
607 	} else {
608 		msg.dt.kern_sg_entries = io->scsiio.kern_sg_entries;
609 		do_sg_copy = 1;
610 	}
611 
612 	msg.dt.kern_data_len = io->scsiio.kern_data_len;
613 	msg.dt.kern_total_len = io->scsiio.kern_total_len;
614 	msg.dt.kern_data_resid = io->scsiio.kern_data_resid;
615 	msg.dt.kern_rel_offset = io->scsiio.kern_rel_offset;
616 	msg.dt.sg_sequence = 0;
617 
618 	/*
619 	 * Loop until we've sent all of the S/G entries.  On the
620 	 * other end, we'll recompose these S/G entries into one
621 	 * contiguous list before processing.
622 	 */
623 	for (sg_entries_sent = 0; sg_entries_sent < msg.dt.kern_sg_entries;
624 	    msg.dt.sg_sequence++) {
625 		msg.dt.cur_sg_entries = MIN((sizeof(msg.dt.sg_list) /
626 		    sizeof(msg.dt.sg_list[0])),
627 		    msg.dt.kern_sg_entries - sg_entries_sent);
628 		if (do_sg_copy != 0) {
629 			sgl = (struct ctl_sg_entry *)io->scsiio.kern_data_ptr;
630 			for (i = sg_entries_sent, j = 0;
631 			     i < msg.dt.cur_sg_entries; i++, j++) {
632 #if 0
633 				if (io->io_hdr.flags & CTL_FLAG_BUS_ADDR) {
634 					msg.dt.sg_list[j].addr = sgl[i].addr;
635 				} else {
636 					/* XXX KDM use busdma here! */
637 					msg.dt.sg_list[j].addr =
638 					    (void *)vtophys(sgl[i].addr);
639 				}
640 #else
641 				KASSERT((io->io_hdr.flags &
642 				    CTL_FLAG_BUS_ADDR) == 0,
643 				    ("HA does not support BUS_ADDR"));
644 				msg.dt.sg_list[j].addr = sgl[i].addr;
645 #endif
646 				msg.dt.sg_list[j].len = sgl[i].len;
647 			}
648 		}
649 
650 		sg_entries_sent += msg.dt.cur_sg_entries;
651 		msg.dt.sg_last = (sg_entries_sent >= msg.dt.kern_sg_entries);
652 		if (ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg,
653 		    sizeof(msg.dt) - sizeof(msg.dt.sg_list) +
654 		    sizeof(struct ctl_sg_entry) * msg.dt.cur_sg_entries,
655 		    M_WAITOK) > CTL_HA_STATUS_SUCCESS) {
656 			io->io_hdr.port_status = 31341;
657 			io->scsiio.be_move_done(io);
658 			return;
659 		}
660 		msg.dt.sent_sg_entries = sg_entries_sent;
661 	}
662 
663 	/*
664 	 * Officially handover the request from us to peer.
665 	 * If failover has just happened, then we must return error.
666 	 * If failover happen just after, then it is not our problem.
667 	 */
668 	if (lun)
669 		mtx_lock(&lun->lun_lock);
670 	if (io->io_hdr.flags & CTL_FLAG_FAILOVER) {
671 		if (lun)
672 			mtx_unlock(&lun->lun_lock);
673 		io->io_hdr.port_status = 31342;
674 		io->scsiio.be_move_done(io);
675 		return;
676 	}
677 	io->io_hdr.flags &= ~CTL_FLAG_IO_ACTIVE;
678 	io->io_hdr.flags |= CTL_FLAG_DMA_INPROG;
679 	if (lun)
680 		mtx_unlock(&lun->lun_lock);
681 }
682 
683 static void
684 ctl_ha_done(union ctl_io *io)
685 {
686 	union ctl_ha_msg msg;
687 
688 	if (io->io_hdr.io_type == CTL_IO_SCSI) {
689 		memset(&msg, 0, sizeof(msg));
690 		msg.hdr.msg_type = CTL_MSG_FINISH_IO;
691 		msg.hdr.original_sc = io->io_hdr.original_sc;
692 		msg.hdr.nexus = io->io_hdr.nexus;
693 		msg.hdr.status = io->io_hdr.status;
694 		msg.scsi.scsi_status = io->scsiio.scsi_status;
695 		msg.scsi.tag_num = io->scsiio.tag_num;
696 		msg.scsi.tag_type = io->scsiio.tag_type;
697 		msg.scsi.sense_len = io->scsiio.sense_len;
698 		msg.scsi.sense_residual = io->scsiio.sense_residual;
699 		msg.scsi.residual = io->scsiio.residual;
700 		memcpy(&msg.scsi.sense_data, &io->scsiio.sense_data,
701 		    io->scsiio.sense_len);
702 		ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg,
703 		    sizeof(msg.scsi) - sizeof(msg.scsi.sense_data) +
704 		    msg.scsi.sense_len, M_WAITOK);
705 	}
706 	ctl_free_io(io);
707 }
708 
709 static void
710 ctl_isc_handler_finish_xfer(struct ctl_softc *ctl_softc,
711 			    union ctl_ha_msg *msg_info)
712 {
713 	struct ctl_scsiio *ctsio;
714 
715 	if (msg_info->hdr.original_sc == NULL) {
716 		printf("%s: original_sc == NULL!\n", __func__);
717 		/* XXX KDM now what? */
718 		return;
719 	}
720 
721 	ctsio = &msg_info->hdr.original_sc->scsiio;
722 	ctsio->io_hdr.flags |= CTL_FLAG_IO_ACTIVE;
723 	ctsio->io_hdr.msg_type = CTL_MSG_FINISH_IO;
724 	ctsio->io_hdr.status = msg_info->hdr.status;
725 	ctsio->scsi_status = msg_info->scsi.scsi_status;
726 	ctsio->sense_len = msg_info->scsi.sense_len;
727 	ctsio->sense_residual = msg_info->scsi.sense_residual;
728 	ctsio->residual = msg_info->scsi.residual;
729 	memcpy(&ctsio->sense_data, &msg_info->scsi.sense_data,
730 	       msg_info->scsi.sense_len);
731 	ctl_enqueue_isc((union ctl_io *)ctsio);
732 }
733 
734 static void
735 ctl_isc_handler_finish_ser_only(struct ctl_softc *ctl_softc,
736 				union ctl_ha_msg *msg_info)
737 {
738 	struct ctl_scsiio *ctsio;
739 
740 	if (msg_info->hdr.serializing_sc == NULL) {
741 		printf("%s: serializing_sc == NULL!\n", __func__);
742 		/* XXX KDM now what? */
743 		return;
744 	}
745 
746 	ctsio = &msg_info->hdr.serializing_sc->scsiio;
747 	ctsio->io_hdr.msg_type = CTL_MSG_FINISH_IO;
748 	ctl_enqueue_isc((union ctl_io *)ctsio);
749 }
750 
751 void
752 ctl_isc_announce_lun(struct ctl_lun *lun)
753 {
754 	struct ctl_softc *softc = lun->ctl_softc;
755 	union ctl_ha_msg *msg;
756 	struct ctl_ha_msg_lun_pr_key pr_key;
757 	int i, k;
758 
759 	if (softc->ha_link != CTL_HA_LINK_ONLINE)
760 		return;
761 	mtx_lock(&lun->lun_lock);
762 	i = sizeof(msg->lun);
763 	if (lun->lun_devid)
764 		i += lun->lun_devid->len;
765 	i += sizeof(pr_key) * lun->pr_key_count;
766 alloc:
767 	mtx_unlock(&lun->lun_lock);
768 	msg = malloc(i, M_CTL, M_WAITOK);
769 	mtx_lock(&lun->lun_lock);
770 	k = sizeof(msg->lun);
771 	if (lun->lun_devid)
772 		k += lun->lun_devid->len;
773 	k += sizeof(pr_key) * lun->pr_key_count;
774 	if (i < k) {
775 		free(msg, M_CTL);
776 		i = k;
777 		goto alloc;
778 	}
779 	bzero(&msg->lun, sizeof(msg->lun));
780 	msg->hdr.msg_type = CTL_MSG_LUN_SYNC;
781 	msg->hdr.nexus.targ_lun = lun->lun;
782 	msg->hdr.nexus.targ_mapped_lun = lun->lun;
783 	msg->lun.flags = lun->flags;
784 	msg->lun.pr_generation = lun->pr_generation;
785 	msg->lun.pr_res_idx = lun->pr_res_idx;
786 	msg->lun.pr_res_type = lun->pr_res_type;
787 	msg->lun.pr_key_count = lun->pr_key_count;
788 	i = 0;
789 	if (lun->lun_devid) {
790 		msg->lun.lun_devid_len = lun->lun_devid->len;
791 		memcpy(&msg->lun.data[i], lun->lun_devid->data,
792 		    msg->lun.lun_devid_len);
793 		i += msg->lun.lun_devid_len;
794 	}
795 	for (k = 0; k < CTL_MAX_INITIATORS; k++) {
796 		if ((pr_key.pr_key = ctl_get_prkey(lun, k)) == 0)
797 			continue;
798 		pr_key.pr_iid = k;
799 		memcpy(&msg->lun.data[i], &pr_key, sizeof(pr_key));
800 		i += sizeof(pr_key);
801 	}
802 	mtx_unlock(&lun->lun_lock);
803 	ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg->port, sizeof(msg->port) + i,
804 	    M_WAITOK);
805 	free(msg, M_CTL);
806 
807 	if (lun->flags & CTL_LUN_PRIMARY_SC) {
808 		for (i = 0; i < CTL_NUM_MODE_PAGES; i++) {
809 			ctl_isc_announce_mode(lun, -1,
810 			    lun->mode_pages.index[i].page_code & SMPH_PC_MASK,
811 			    lun->mode_pages.index[i].subpage);
812 		}
813 	}
814 }
815 
816 void
817 ctl_isc_announce_port(struct ctl_port *port)
818 {
819 	struct ctl_softc *softc = port->ctl_softc;
820 	union ctl_ha_msg *msg;
821 	int i;
822 
823 	if (port->targ_port < softc->port_min ||
824 	    port->targ_port >= softc->port_max ||
825 	    softc->ha_link != CTL_HA_LINK_ONLINE)
826 		return;
827 	i = sizeof(msg->port) + strlen(port->port_name) + 1;
828 	if (port->lun_map)
829 		i += sizeof(uint32_t) * CTL_MAX_LUNS;
830 	if (port->port_devid)
831 		i += port->port_devid->len;
832 	if (port->target_devid)
833 		i += port->target_devid->len;
834 	if (port->init_devid)
835 		i += port->init_devid->len;
836 	msg = malloc(i, M_CTL, M_WAITOK);
837 	bzero(&msg->port, sizeof(msg->port));
838 	msg->hdr.msg_type = CTL_MSG_PORT_SYNC;
839 	msg->hdr.nexus.targ_port = port->targ_port;
840 	msg->port.port_type = port->port_type;
841 	msg->port.physical_port = port->physical_port;
842 	msg->port.virtual_port = port->virtual_port;
843 	msg->port.status = port->status;
844 	i = 0;
845 	msg->port.name_len = sprintf(&msg->port.data[i],
846 	    "%d:%s", softc->ha_id, port->port_name) + 1;
847 	i += msg->port.name_len;
848 	if (port->lun_map) {
849 		msg->port.lun_map_len = sizeof(uint32_t) * CTL_MAX_LUNS;
850 		memcpy(&msg->port.data[i], port->lun_map,
851 		    msg->port.lun_map_len);
852 		i += msg->port.lun_map_len;
853 	}
854 	if (port->port_devid) {
855 		msg->port.port_devid_len = port->port_devid->len;
856 		memcpy(&msg->port.data[i], port->port_devid->data,
857 		    msg->port.port_devid_len);
858 		i += msg->port.port_devid_len;
859 	}
860 	if (port->target_devid) {
861 		msg->port.target_devid_len = port->target_devid->len;
862 		memcpy(&msg->port.data[i], port->target_devid->data,
863 		    msg->port.target_devid_len);
864 		i += msg->port.target_devid_len;
865 	}
866 	if (port->init_devid) {
867 		msg->port.init_devid_len = port->init_devid->len;
868 		memcpy(&msg->port.data[i], port->init_devid->data,
869 		    msg->port.init_devid_len);
870 		i += msg->port.init_devid_len;
871 	}
872 	ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg->port, sizeof(msg->port) + i,
873 	    M_WAITOK);
874 	free(msg, M_CTL);
875 }
876 
877 void
878 ctl_isc_announce_iid(struct ctl_port *port, int iid)
879 {
880 	struct ctl_softc *softc = port->ctl_softc;
881 	union ctl_ha_msg *msg;
882 	int i, l;
883 
884 	if (port->targ_port < softc->port_min ||
885 	    port->targ_port >= softc->port_max ||
886 	    softc->ha_link != CTL_HA_LINK_ONLINE)
887 		return;
888 	mtx_lock(&softc->ctl_lock);
889 	i = sizeof(msg->iid);
890 	l = 0;
891 	if (port->wwpn_iid[iid].name)
892 		l = strlen(port->wwpn_iid[iid].name) + 1;
893 	i += l;
894 	msg = malloc(i, M_CTL, M_NOWAIT);
895 	if (msg == NULL) {
896 		mtx_unlock(&softc->ctl_lock);
897 		return;
898 	}
899 	bzero(&msg->iid, sizeof(msg->iid));
900 	msg->hdr.msg_type = CTL_MSG_IID_SYNC;
901 	msg->hdr.nexus.targ_port = port->targ_port;
902 	msg->hdr.nexus.initid = iid;
903 	msg->iid.in_use = port->wwpn_iid[iid].in_use;
904 	msg->iid.name_len = l;
905 	msg->iid.wwpn = port->wwpn_iid[iid].wwpn;
906 	if (port->wwpn_iid[iid].name)
907 		strlcpy(msg->iid.data, port->wwpn_iid[iid].name, l);
908 	mtx_unlock(&softc->ctl_lock);
909 	ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg->iid, i, M_NOWAIT);
910 	free(msg, M_CTL);
911 }
912 
913 void
914 ctl_isc_announce_mode(struct ctl_lun *lun, uint32_t initidx,
915     uint8_t page, uint8_t subpage)
916 {
917 	struct ctl_softc *softc = lun->ctl_softc;
918 	union ctl_ha_msg msg;
919 	int i;
920 
921 	if (softc->ha_link != CTL_HA_LINK_ONLINE)
922 		return;
923 	for (i = 0; i < CTL_NUM_MODE_PAGES; i++) {
924 		if ((lun->mode_pages.index[i].page_code & SMPH_PC_MASK) ==
925 		    page && lun->mode_pages.index[i].subpage == subpage)
926 			break;
927 	}
928 	if (i == CTL_NUM_MODE_PAGES)
929 		return;
930 
931 	/* Don't try to replicate pages not present on this device. */
932 	if (lun->mode_pages.index[i].page_data == NULL)
933 		return;
934 
935 	bzero(&msg.mode, sizeof(msg.mode));
936 	msg.hdr.msg_type = CTL_MSG_MODE_SYNC;
937 	msg.hdr.nexus.targ_port = initidx / CTL_MAX_INIT_PER_PORT;
938 	msg.hdr.nexus.initid = initidx % CTL_MAX_INIT_PER_PORT;
939 	msg.hdr.nexus.targ_lun = lun->lun;
940 	msg.hdr.nexus.targ_mapped_lun = lun->lun;
941 	msg.mode.page_code = page;
942 	msg.mode.subpage = subpage;
943 	msg.mode.page_len = lun->mode_pages.index[i].page_len;
944 	memcpy(msg.mode.data, lun->mode_pages.index[i].page_data,
945 	    msg.mode.page_len);
946 	ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg.mode, sizeof(msg.mode),
947 	    M_WAITOK);
948 }
949 
950 static void
951 ctl_isc_ha_link_up(struct ctl_softc *softc)
952 {
953 	struct ctl_port *port;
954 	struct ctl_lun *lun;
955 	union ctl_ha_msg msg;
956 	int i;
957 
958 	/* Announce this node parameters to peer for validation. */
959 	msg.login.msg_type = CTL_MSG_LOGIN;
960 	msg.login.version = CTL_HA_VERSION;
961 	msg.login.ha_mode = softc->ha_mode;
962 	msg.login.ha_id = softc->ha_id;
963 	msg.login.max_luns = CTL_MAX_LUNS;
964 	msg.login.max_ports = CTL_MAX_PORTS;
965 	msg.login.max_init_per_port = CTL_MAX_INIT_PER_PORT;
966 	ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg.login, sizeof(msg.login),
967 	    M_WAITOK);
968 
969 	STAILQ_FOREACH(port, &softc->port_list, links) {
970 		ctl_isc_announce_port(port);
971 		for (i = 0; i < CTL_MAX_INIT_PER_PORT; i++) {
972 			if (port->wwpn_iid[i].in_use)
973 				ctl_isc_announce_iid(port, i);
974 		}
975 	}
976 	STAILQ_FOREACH(lun, &softc->lun_list, links)
977 		ctl_isc_announce_lun(lun);
978 }
979 
980 static void
981 ctl_isc_ha_link_down(struct ctl_softc *softc)
982 {
983 	struct ctl_port *port;
984 	struct ctl_lun *lun;
985 	union ctl_io *io;
986 	int i;
987 
988 	mtx_lock(&softc->ctl_lock);
989 	STAILQ_FOREACH(lun, &softc->lun_list, links) {
990 		mtx_lock(&lun->lun_lock);
991 		if (lun->flags & CTL_LUN_PEER_SC_PRIMARY) {
992 			lun->flags &= ~CTL_LUN_PEER_SC_PRIMARY;
993 			ctl_est_ua_all(lun, -1, CTL_UA_ASYM_ACC_CHANGE);
994 		}
995 		mtx_unlock(&lun->lun_lock);
996 
997 		mtx_unlock(&softc->ctl_lock);
998 		io = ctl_alloc_io(softc->othersc_pool);
999 		mtx_lock(&softc->ctl_lock);
1000 		ctl_zero_io(io);
1001 		io->io_hdr.msg_type = CTL_MSG_FAILOVER;
1002 		io->io_hdr.nexus.targ_mapped_lun = lun->lun;
1003 		ctl_enqueue_isc(io);
1004 	}
1005 
1006 	STAILQ_FOREACH(port, &softc->port_list, links) {
1007 		if (port->targ_port >= softc->port_min &&
1008 		    port->targ_port < softc->port_max)
1009 			continue;
1010 		port->status &= ~CTL_PORT_STATUS_ONLINE;
1011 		for (i = 0; i < CTL_MAX_INIT_PER_PORT; i++) {
1012 			port->wwpn_iid[i].in_use = 0;
1013 			free(port->wwpn_iid[i].name, M_CTL);
1014 			port->wwpn_iid[i].name = NULL;
1015 		}
1016 	}
1017 	mtx_unlock(&softc->ctl_lock);
1018 }
1019 
1020 static void
1021 ctl_isc_ua(struct ctl_softc *softc, union ctl_ha_msg *msg, int len)
1022 {
1023 	struct ctl_lun *lun;
1024 	uint32_t iid = ctl_get_initindex(&msg->hdr.nexus);
1025 
1026 	mtx_lock(&softc->ctl_lock);
1027 	if (msg->hdr.nexus.targ_lun < CTL_MAX_LUNS &&
1028 	    (lun = softc->ctl_luns[msg->hdr.nexus.targ_mapped_lun]) != NULL) {
1029 		mtx_lock(&lun->lun_lock);
1030 		mtx_unlock(&softc->ctl_lock);
1031 		if (msg->ua.ua_type == CTL_UA_THIN_PROV_THRES &&
1032 		    msg->ua.ua_set)
1033 			memcpy(lun->ua_tpt_info, msg->ua.ua_info, 8);
1034 		if (msg->ua.ua_all) {
1035 			if (msg->ua.ua_set)
1036 				ctl_est_ua_all(lun, iid, msg->ua.ua_type);
1037 			else
1038 				ctl_clr_ua_all(lun, iid, msg->ua.ua_type);
1039 		} else {
1040 			if (msg->ua.ua_set)
1041 				ctl_est_ua(lun, iid, msg->ua.ua_type);
1042 			else
1043 				ctl_clr_ua(lun, iid, msg->ua.ua_type);
1044 		}
1045 		mtx_unlock(&lun->lun_lock);
1046 	} else
1047 		mtx_unlock(&softc->ctl_lock);
1048 }
1049 
1050 static void
1051 ctl_isc_lun_sync(struct ctl_softc *softc, union ctl_ha_msg *msg, int len)
1052 {
1053 	struct ctl_lun *lun;
1054 	struct ctl_ha_msg_lun_pr_key pr_key;
1055 	int i, k;
1056 	ctl_lun_flags oflags;
1057 	uint32_t targ_lun;
1058 
1059 	targ_lun = msg->hdr.nexus.targ_mapped_lun;
1060 	mtx_lock(&softc->ctl_lock);
1061 	if ((targ_lun >= CTL_MAX_LUNS) ||
1062 	    ((lun = softc->ctl_luns[targ_lun]) == NULL)) {
1063 		mtx_unlock(&softc->ctl_lock);
1064 		return;
1065 	}
1066 	mtx_lock(&lun->lun_lock);
1067 	mtx_unlock(&softc->ctl_lock);
1068 	if (lun->flags & CTL_LUN_DISABLED) {
1069 		mtx_unlock(&lun->lun_lock);
1070 		return;
1071 	}
1072 	i = (lun->lun_devid != NULL) ? lun->lun_devid->len : 0;
1073 	if (msg->lun.lun_devid_len != i || (i > 0 &&
1074 	    memcmp(&msg->lun.data[0], lun->lun_devid->data, i) != 0)) {
1075 		mtx_unlock(&lun->lun_lock);
1076 		printf("%s: Received conflicting HA LUN %d\n",
1077 		    __func__, msg->hdr.nexus.targ_lun);
1078 		return;
1079 	} else {
1080 		/* Record whether peer is primary. */
1081 		oflags = lun->flags;
1082 		if ((msg->lun.flags & CTL_LUN_PRIMARY_SC) &&
1083 		    (msg->lun.flags & CTL_LUN_DISABLED) == 0)
1084 			lun->flags |= CTL_LUN_PEER_SC_PRIMARY;
1085 		else
1086 			lun->flags &= ~CTL_LUN_PEER_SC_PRIMARY;
1087 		if (oflags != lun->flags)
1088 			ctl_est_ua_all(lun, -1, CTL_UA_ASYM_ACC_CHANGE);
1089 
1090 		/* If peer is primary and we are not -- use data */
1091 		if ((lun->flags & CTL_LUN_PRIMARY_SC) == 0 &&
1092 		    (lun->flags & CTL_LUN_PEER_SC_PRIMARY)) {
1093 			lun->pr_generation = msg->lun.pr_generation;
1094 			lun->pr_res_idx = msg->lun.pr_res_idx;
1095 			lun->pr_res_type = msg->lun.pr_res_type;
1096 			lun->pr_key_count = msg->lun.pr_key_count;
1097 			for (k = 0; k < CTL_MAX_INITIATORS; k++)
1098 				ctl_clr_prkey(lun, k);
1099 			for (k = 0; k < msg->lun.pr_key_count; k++) {
1100 				memcpy(&pr_key, &msg->lun.data[i],
1101 				    sizeof(pr_key));
1102 				ctl_alloc_prkey(lun, pr_key.pr_iid);
1103 				ctl_set_prkey(lun, pr_key.pr_iid,
1104 				    pr_key.pr_key);
1105 				i += sizeof(pr_key);
1106 			}
1107 		}
1108 
1109 		mtx_unlock(&lun->lun_lock);
1110 		CTL_DEBUG_PRINT(("%s: Known LUN %d, peer is %s\n",
1111 		    __func__, msg->hdr.nexus.targ_lun,
1112 		    (msg->lun.flags & CTL_LUN_PRIMARY_SC) ?
1113 		    "primary" : "secondary"));
1114 
1115 		/* If we are primary but peer doesn't know -- notify */
1116 		if ((lun->flags & CTL_LUN_PRIMARY_SC) &&
1117 		    (msg->lun.flags & CTL_LUN_PEER_SC_PRIMARY) == 0)
1118 			ctl_isc_announce_lun(lun);
1119 	}
1120 }
1121 
1122 static void
1123 ctl_isc_port_sync(struct ctl_softc *softc, union ctl_ha_msg *msg, int len)
1124 {
1125 	struct ctl_port *port;
1126 	struct ctl_lun *lun;
1127 	int i, new;
1128 
1129 	port = softc->ctl_ports[msg->hdr.nexus.targ_port];
1130 	if (port == NULL) {
1131 		CTL_DEBUG_PRINT(("%s: New port %d\n", __func__,
1132 		    msg->hdr.nexus.targ_port));
1133 		new = 1;
1134 		port = malloc(sizeof(*port), M_CTL, M_WAITOK | M_ZERO);
1135 		port->frontend = &ha_frontend;
1136 		port->targ_port = msg->hdr.nexus.targ_port;
1137 		port->fe_datamove = ctl_ha_datamove;
1138 		port->fe_done = ctl_ha_done;
1139 	} else if (port->frontend == &ha_frontend) {
1140 		CTL_DEBUG_PRINT(("%s: Updated port %d\n", __func__,
1141 		    msg->hdr.nexus.targ_port));
1142 		new = 0;
1143 	} else {
1144 		printf("%s: Received conflicting HA port %d\n",
1145 		    __func__, msg->hdr.nexus.targ_port);
1146 		return;
1147 	}
1148 	port->port_type = msg->port.port_type;
1149 	port->physical_port = msg->port.physical_port;
1150 	port->virtual_port = msg->port.virtual_port;
1151 	port->status = msg->port.status;
1152 	i = 0;
1153 	free(port->port_name, M_CTL);
1154 	port->port_name = strndup(&msg->port.data[i], msg->port.name_len,
1155 	    M_CTL);
1156 	i += msg->port.name_len;
1157 	if (msg->port.lun_map_len != 0) {
1158 		if (port->lun_map == NULL)
1159 			port->lun_map = malloc(sizeof(uint32_t) * CTL_MAX_LUNS,
1160 			    M_CTL, M_WAITOK);
1161 		memcpy(port->lun_map, &msg->port.data[i],
1162 		    sizeof(uint32_t) * CTL_MAX_LUNS);
1163 		i += msg->port.lun_map_len;
1164 	} else {
1165 		free(port->lun_map, M_CTL);
1166 		port->lun_map = NULL;
1167 	}
1168 	if (msg->port.port_devid_len != 0) {
1169 		if (port->port_devid == NULL ||
1170 		    port->port_devid->len != msg->port.port_devid_len) {
1171 			free(port->port_devid, M_CTL);
1172 			port->port_devid = malloc(sizeof(struct ctl_devid) +
1173 			    msg->port.port_devid_len, M_CTL, M_WAITOK);
1174 		}
1175 		memcpy(port->port_devid->data, &msg->port.data[i],
1176 		    msg->port.port_devid_len);
1177 		port->port_devid->len = msg->port.port_devid_len;
1178 		i += msg->port.port_devid_len;
1179 	} else {
1180 		free(port->port_devid, M_CTL);
1181 		port->port_devid = NULL;
1182 	}
1183 	if (msg->port.target_devid_len != 0) {
1184 		if (port->target_devid == NULL ||
1185 		    port->target_devid->len != msg->port.target_devid_len) {
1186 			free(port->target_devid, M_CTL);
1187 			port->target_devid = malloc(sizeof(struct ctl_devid) +
1188 			    msg->port.target_devid_len, M_CTL, M_WAITOK);
1189 		}
1190 		memcpy(port->target_devid->data, &msg->port.data[i],
1191 		    msg->port.target_devid_len);
1192 		port->target_devid->len = msg->port.target_devid_len;
1193 		i += msg->port.target_devid_len;
1194 	} else {
1195 		free(port->target_devid, M_CTL);
1196 		port->target_devid = NULL;
1197 	}
1198 	if (msg->port.init_devid_len != 0) {
1199 		if (port->init_devid == NULL ||
1200 		    port->init_devid->len != msg->port.init_devid_len) {
1201 			free(port->init_devid, M_CTL);
1202 			port->init_devid = malloc(sizeof(struct ctl_devid) +
1203 			    msg->port.init_devid_len, M_CTL, M_WAITOK);
1204 		}
1205 		memcpy(port->init_devid->data, &msg->port.data[i],
1206 		    msg->port.init_devid_len);
1207 		port->init_devid->len = msg->port.init_devid_len;
1208 		i += msg->port.init_devid_len;
1209 	} else {
1210 		free(port->init_devid, M_CTL);
1211 		port->init_devid = NULL;
1212 	}
1213 	if (new) {
1214 		if (ctl_port_register(port) != 0) {
1215 			printf("%s: ctl_port_register() failed with error\n",
1216 			    __func__);
1217 		}
1218 	}
1219 	mtx_lock(&softc->ctl_lock);
1220 	STAILQ_FOREACH(lun, &softc->lun_list, links) {
1221 		if (ctl_lun_map_to_port(port, lun->lun) >= CTL_MAX_LUNS)
1222 			continue;
1223 		mtx_lock(&lun->lun_lock);
1224 		ctl_est_ua_all(lun, -1, CTL_UA_INQ_CHANGE);
1225 		mtx_unlock(&lun->lun_lock);
1226 	}
1227 	mtx_unlock(&softc->ctl_lock);
1228 }
1229 
1230 static void
1231 ctl_isc_iid_sync(struct ctl_softc *softc, union ctl_ha_msg *msg, int len)
1232 {
1233 	struct ctl_port *port;
1234 	int iid;
1235 
1236 	port = softc->ctl_ports[msg->hdr.nexus.targ_port];
1237 	if (port == NULL) {
1238 		printf("%s: Received IID for unknown port %d\n",
1239 		    __func__, msg->hdr.nexus.targ_port);
1240 		return;
1241 	}
1242 	iid = msg->hdr.nexus.initid;
1243 	port->wwpn_iid[iid].in_use = msg->iid.in_use;
1244 	port->wwpn_iid[iid].wwpn = msg->iid.wwpn;
1245 	free(port->wwpn_iid[iid].name, M_CTL);
1246 	if (msg->iid.name_len) {
1247 		port->wwpn_iid[iid].name = strndup(&msg->iid.data[0],
1248 		    msg->iid.name_len, M_CTL);
1249 	} else
1250 		port->wwpn_iid[iid].name = NULL;
1251 }
1252 
1253 static void
1254 ctl_isc_login(struct ctl_softc *softc, union ctl_ha_msg *msg, int len)
1255 {
1256 
1257 	if (msg->login.version != CTL_HA_VERSION) {
1258 		printf("CTL HA peers have different versions %d != %d\n",
1259 		    msg->login.version, CTL_HA_VERSION);
1260 		ctl_ha_msg_abort(CTL_HA_CHAN_CTL);
1261 		return;
1262 	}
1263 	if (msg->login.ha_mode != softc->ha_mode) {
1264 		printf("CTL HA peers have different ha_mode %d != %d\n",
1265 		    msg->login.ha_mode, softc->ha_mode);
1266 		ctl_ha_msg_abort(CTL_HA_CHAN_CTL);
1267 		return;
1268 	}
1269 	if (msg->login.ha_id == softc->ha_id) {
1270 		printf("CTL HA peers have same ha_id %d\n", msg->login.ha_id);
1271 		ctl_ha_msg_abort(CTL_HA_CHAN_CTL);
1272 		return;
1273 	}
1274 	if (msg->login.max_luns != CTL_MAX_LUNS ||
1275 	    msg->login.max_ports != CTL_MAX_PORTS ||
1276 	    msg->login.max_init_per_port != CTL_MAX_INIT_PER_PORT) {
1277 		printf("CTL HA peers have different limits\n");
1278 		ctl_ha_msg_abort(CTL_HA_CHAN_CTL);
1279 		return;
1280 	}
1281 }
1282 
1283 static void
1284 ctl_isc_mode_sync(struct ctl_softc *softc, union ctl_ha_msg *msg, int len)
1285 {
1286 	struct ctl_lun *lun;
1287 	int i;
1288 	uint32_t initidx, targ_lun;
1289 
1290 	targ_lun = msg->hdr.nexus.targ_mapped_lun;
1291 	mtx_lock(&softc->ctl_lock);
1292 	if ((targ_lun >= CTL_MAX_LUNS) ||
1293 	    ((lun = softc->ctl_luns[targ_lun]) == NULL)) {
1294 		mtx_unlock(&softc->ctl_lock);
1295 		return;
1296 	}
1297 	mtx_lock(&lun->lun_lock);
1298 	mtx_unlock(&softc->ctl_lock);
1299 	if (lun->flags & CTL_LUN_DISABLED) {
1300 		mtx_unlock(&lun->lun_lock);
1301 		return;
1302 	}
1303 	for (i = 0; i < CTL_NUM_MODE_PAGES; i++) {
1304 		if ((lun->mode_pages.index[i].page_code & SMPH_PC_MASK) ==
1305 		    msg->mode.page_code &&
1306 		    lun->mode_pages.index[i].subpage == msg->mode.subpage)
1307 			break;
1308 	}
1309 	if (i == CTL_NUM_MODE_PAGES) {
1310 		mtx_unlock(&lun->lun_lock);
1311 		return;
1312 	}
1313 	memcpy(lun->mode_pages.index[i].page_data, msg->mode.data,
1314 	    lun->mode_pages.index[i].page_len);
1315 	initidx = ctl_get_initindex(&msg->hdr.nexus);
1316 	if (initidx != -1)
1317 		ctl_est_ua_all(lun, initidx, CTL_UA_MODE_CHANGE);
1318 	mtx_unlock(&lun->lun_lock);
1319 }
1320 
1321 /*
1322  * ISC (Inter Shelf Communication) event handler.  Events from the HA
1323  * subsystem come in here.
1324  */
1325 static void
1326 ctl_isc_event_handler(ctl_ha_channel channel, ctl_ha_event event, int param)
1327 {
1328 	struct ctl_softc *softc = control_softc;
1329 	union ctl_io *io;
1330 	struct ctl_prio *presio;
1331 	ctl_ha_status isc_status;
1332 
1333 	CTL_DEBUG_PRINT(("CTL: Isc Msg event %d\n", event));
1334 	if (event == CTL_HA_EVT_MSG_RECV) {
1335 		union ctl_ha_msg *msg, msgbuf;
1336 
1337 		if (param > sizeof(msgbuf))
1338 			msg = malloc(param, M_CTL, M_WAITOK);
1339 		else
1340 			msg = &msgbuf;
1341 		isc_status = ctl_ha_msg_recv(CTL_HA_CHAN_CTL, msg, param,
1342 		    M_WAITOK);
1343 		if (isc_status != CTL_HA_STATUS_SUCCESS) {
1344 			printf("%s: Error receiving message: %d\n",
1345 			    __func__, isc_status);
1346 			if (msg != &msgbuf)
1347 				free(msg, M_CTL);
1348 			return;
1349 		}
1350 
1351 		CTL_DEBUG_PRINT(("CTL: msg_type %d\n", msg->msg_type));
1352 		switch (msg->hdr.msg_type) {
1353 		case CTL_MSG_SERIALIZE:
1354 			io = ctl_alloc_io(softc->othersc_pool);
1355 			ctl_zero_io(io);
1356 			// populate ctsio from msg
1357 			io->io_hdr.io_type = CTL_IO_SCSI;
1358 			io->io_hdr.msg_type = CTL_MSG_SERIALIZE;
1359 			io->io_hdr.original_sc = msg->hdr.original_sc;
1360 			io->io_hdr.flags |= CTL_FLAG_FROM_OTHER_SC |
1361 					    CTL_FLAG_IO_ACTIVE;
1362 			/*
1363 			 * If we're in serialization-only mode, we don't
1364 			 * want to go through full done processing.  Thus
1365 			 * the COPY flag.
1366 			 *
1367 			 * XXX KDM add another flag that is more specific.
1368 			 */
1369 			if (softc->ha_mode != CTL_HA_MODE_XFER)
1370 				io->io_hdr.flags |= CTL_FLAG_INT_COPY;
1371 			io->io_hdr.nexus = msg->hdr.nexus;
1372 #if 0
1373 			printf("port %u, iid %u, lun %u\n",
1374 			       io->io_hdr.nexus.targ_port,
1375 			       io->io_hdr.nexus.initid,
1376 			       io->io_hdr.nexus.targ_lun);
1377 #endif
1378 			io->scsiio.tag_num = msg->scsi.tag_num;
1379 			io->scsiio.tag_type = msg->scsi.tag_type;
1380 #ifdef CTL_TIME_IO
1381 			io->io_hdr.start_time = time_uptime;
1382 			getbinuptime(&io->io_hdr.start_bt);
1383 #endif /* CTL_TIME_IO */
1384 			io->scsiio.cdb_len = msg->scsi.cdb_len;
1385 			memcpy(io->scsiio.cdb, msg->scsi.cdb,
1386 			       CTL_MAX_CDBLEN);
1387 			if (softc->ha_mode == CTL_HA_MODE_XFER) {
1388 				const struct ctl_cmd_entry *entry;
1389 
1390 				entry = ctl_get_cmd_entry(&io->scsiio, NULL);
1391 				io->io_hdr.flags &= ~CTL_FLAG_DATA_MASK;
1392 				io->io_hdr.flags |=
1393 					entry->flags & CTL_FLAG_DATA_MASK;
1394 			}
1395 			ctl_enqueue_isc(io);
1396 			break;
1397 
1398 		/* Performed on the Originating SC, XFER mode only */
1399 		case CTL_MSG_DATAMOVE: {
1400 			struct ctl_sg_entry *sgl;
1401 			int i, j;
1402 
1403 			io = msg->hdr.original_sc;
1404 			if (io == NULL) {
1405 				printf("%s: original_sc == NULL!\n", __func__);
1406 				/* XXX KDM do something here */
1407 				break;
1408 			}
1409 			io->io_hdr.msg_type = CTL_MSG_DATAMOVE;
1410 			io->io_hdr.flags |= CTL_FLAG_IO_ACTIVE;
1411 			/*
1412 			 * Keep track of this, we need to send it back over
1413 			 * when the datamove is complete.
1414 			 */
1415 			io->io_hdr.serializing_sc = msg->hdr.serializing_sc;
1416 			if (msg->hdr.status == CTL_SUCCESS)
1417 				io->io_hdr.status = msg->hdr.status;
1418 
1419 			if (msg->dt.sg_sequence == 0) {
1420 #ifdef CTL_TIME_IO
1421 				getbinuptime(&io->io_hdr.dma_start_bt);
1422 #endif
1423 				i = msg->dt.kern_sg_entries +
1424 				    msg->dt.kern_data_len /
1425 				    CTL_HA_DATAMOVE_SEGMENT + 1;
1426 				sgl = malloc(sizeof(*sgl) * i, M_CTL,
1427 				    M_WAITOK | M_ZERO);
1428 				io->io_hdr.remote_sglist = sgl;
1429 				io->io_hdr.local_sglist =
1430 				    &sgl[msg->dt.kern_sg_entries];
1431 
1432 				io->scsiio.kern_data_ptr = (uint8_t *)sgl;
1433 
1434 				io->scsiio.kern_sg_entries =
1435 					msg->dt.kern_sg_entries;
1436 				io->scsiio.rem_sg_entries =
1437 					msg->dt.kern_sg_entries;
1438 				io->scsiio.kern_data_len =
1439 					msg->dt.kern_data_len;
1440 				io->scsiio.kern_total_len =
1441 					msg->dt.kern_total_len;
1442 				io->scsiio.kern_data_resid =
1443 					msg->dt.kern_data_resid;
1444 				io->scsiio.kern_rel_offset =
1445 					msg->dt.kern_rel_offset;
1446 				io->io_hdr.flags &= ~CTL_FLAG_BUS_ADDR;
1447 				io->io_hdr.flags |= msg->dt.flags &
1448 				    CTL_FLAG_BUS_ADDR;
1449 			} else
1450 				sgl = (struct ctl_sg_entry *)
1451 					io->scsiio.kern_data_ptr;
1452 
1453 			for (i = msg->dt.sent_sg_entries, j = 0;
1454 			     i < (msg->dt.sent_sg_entries +
1455 			     msg->dt.cur_sg_entries); i++, j++) {
1456 				sgl[i].addr = msg->dt.sg_list[j].addr;
1457 				sgl[i].len = msg->dt.sg_list[j].len;
1458 
1459 #if 0
1460 				printf("%s: DATAMOVE: %p,%lu j=%d, i=%d\n",
1461 				    __func__, sgl[i].addr, sgl[i].len, j, i);
1462 #endif
1463 			}
1464 
1465 			/*
1466 			 * If this is the last piece of the I/O, we've got
1467 			 * the full S/G list.  Queue processing in the thread.
1468 			 * Otherwise wait for the next piece.
1469 			 */
1470 			if (msg->dt.sg_last != 0)
1471 				ctl_enqueue_isc(io);
1472 			break;
1473 		}
1474 		/* Performed on the Serializing (primary) SC, XFER mode only */
1475 		case CTL_MSG_DATAMOVE_DONE: {
1476 			if (msg->hdr.serializing_sc == NULL) {
1477 				printf("%s: serializing_sc == NULL!\n",
1478 				       __func__);
1479 				/* XXX KDM now what? */
1480 				break;
1481 			}
1482 			/*
1483 			 * We grab the sense information here in case
1484 			 * there was a failure, so we can return status
1485 			 * back to the initiator.
1486 			 */
1487 			io = msg->hdr.serializing_sc;
1488 			io->io_hdr.msg_type = CTL_MSG_DATAMOVE_DONE;
1489 			io->io_hdr.flags &= ~CTL_FLAG_DMA_INPROG;
1490 			io->io_hdr.flags |= CTL_FLAG_IO_ACTIVE;
1491 			io->io_hdr.port_status = msg->scsi.fetd_status;
1492 			io->scsiio.residual = msg->scsi.residual;
1493 			if (msg->hdr.status != CTL_STATUS_NONE) {
1494 				io->io_hdr.status = msg->hdr.status;
1495 				io->scsiio.scsi_status = msg->scsi.scsi_status;
1496 				io->scsiio.sense_len = msg->scsi.sense_len;
1497 				io->scsiio.sense_residual =msg->scsi.sense_residual;
1498 				memcpy(&io->scsiio.sense_data,
1499 				    &msg->scsi.sense_data,
1500 				    msg->scsi.sense_len);
1501 				if (msg->hdr.status == CTL_SUCCESS)
1502 					io->io_hdr.flags |= CTL_FLAG_STATUS_SENT;
1503 			}
1504 			ctl_enqueue_isc(io);
1505 			break;
1506 		}
1507 
1508 		/* Preformed on Originating SC, SER_ONLY mode */
1509 		case CTL_MSG_R2R:
1510 			io = msg->hdr.original_sc;
1511 			if (io == NULL) {
1512 				printf("%s: original_sc == NULL!\n",
1513 				    __func__);
1514 				break;
1515 			}
1516 			io->io_hdr.flags |= CTL_FLAG_IO_ACTIVE;
1517 			io->io_hdr.msg_type = CTL_MSG_R2R;
1518 			io->io_hdr.serializing_sc = msg->hdr.serializing_sc;
1519 			ctl_enqueue_isc(io);
1520 			break;
1521 
1522 		/*
1523 		 * Performed on Serializing(i.e. primary SC) SC in SER_ONLY
1524 		 * mode.
1525 		 * Performed on the Originating (i.e. secondary) SC in XFER
1526 		 * mode
1527 		 */
1528 		case CTL_MSG_FINISH_IO:
1529 			if (softc->ha_mode == CTL_HA_MODE_XFER)
1530 				ctl_isc_handler_finish_xfer(softc, msg);
1531 			else
1532 				ctl_isc_handler_finish_ser_only(softc, msg);
1533 			break;
1534 
1535 		/* Preformed on Originating SC */
1536 		case CTL_MSG_BAD_JUJU:
1537 			io = msg->hdr.original_sc;
1538 			if (io == NULL) {
1539 				printf("%s: Bad JUJU!, original_sc is NULL!\n",
1540 				       __func__);
1541 				break;
1542 			}
1543 			ctl_copy_sense_data(msg, io);
1544 			/*
1545 			 * IO should have already been cleaned up on other
1546 			 * SC so clear this flag so we won't send a message
1547 			 * back to finish the IO there.
1548 			 */
1549 			io->io_hdr.flags &= ~CTL_FLAG_SENT_2OTHER_SC;
1550 			io->io_hdr.flags |= CTL_FLAG_IO_ACTIVE;
1551 
1552 			/* io = msg->hdr.serializing_sc; */
1553 			io->io_hdr.msg_type = CTL_MSG_BAD_JUJU;
1554 			ctl_enqueue_isc(io);
1555 			break;
1556 
1557 		/* Handle resets sent from the other side */
1558 		case CTL_MSG_MANAGE_TASKS: {
1559 			struct ctl_taskio *taskio;
1560 			taskio = (struct ctl_taskio *)ctl_alloc_io(
1561 			    softc->othersc_pool);
1562 			ctl_zero_io((union ctl_io *)taskio);
1563 			taskio->io_hdr.io_type = CTL_IO_TASK;
1564 			taskio->io_hdr.flags |= CTL_FLAG_FROM_OTHER_SC;
1565 			taskio->io_hdr.nexus = msg->hdr.nexus;
1566 			taskio->task_action = msg->task.task_action;
1567 			taskio->tag_num = msg->task.tag_num;
1568 			taskio->tag_type = msg->task.tag_type;
1569 #ifdef CTL_TIME_IO
1570 			taskio->io_hdr.start_time = time_uptime;
1571 			getbinuptime(&taskio->io_hdr.start_bt);
1572 #endif /* CTL_TIME_IO */
1573 			ctl_run_task((union ctl_io *)taskio);
1574 			break;
1575 		}
1576 		/* Persistent Reserve action which needs attention */
1577 		case CTL_MSG_PERS_ACTION:
1578 			presio = (struct ctl_prio *)ctl_alloc_io(
1579 			    softc->othersc_pool);
1580 			ctl_zero_io((union ctl_io *)presio);
1581 			presio->io_hdr.msg_type = CTL_MSG_PERS_ACTION;
1582 			presio->io_hdr.flags |= CTL_FLAG_FROM_OTHER_SC;
1583 			presio->io_hdr.nexus = msg->hdr.nexus;
1584 			presio->pr_msg = msg->pr;
1585 			ctl_enqueue_isc((union ctl_io *)presio);
1586 			break;
1587 		case CTL_MSG_UA:
1588 			ctl_isc_ua(softc, msg, param);
1589 			break;
1590 		case CTL_MSG_PORT_SYNC:
1591 			ctl_isc_port_sync(softc, msg, param);
1592 			break;
1593 		case CTL_MSG_LUN_SYNC:
1594 			ctl_isc_lun_sync(softc, msg, param);
1595 			break;
1596 		case CTL_MSG_IID_SYNC:
1597 			ctl_isc_iid_sync(softc, msg, param);
1598 			break;
1599 		case CTL_MSG_LOGIN:
1600 			ctl_isc_login(softc, msg, param);
1601 			break;
1602 		case CTL_MSG_MODE_SYNC:
1603 			ctl_isc_mode_sync(softc, msg, param);
1604 			break;
1605 		default:
1606 			printf("Received HA message of unknown type %d\n",
1607 			    msg->hdr.msg_type);
1608 			ctl_ha_msg_abort(CTL_HA_CHAN_CTL);
1609 			break;
1610 		}
1611 		if (msg != &msgbuf)
1612 			free(msg, M_CTL);
1613 	} else if (event == CTL_HA_EVT_LINK_CHANGE) {
1614 		printf("CTL: HA link status changed from %d to %d\n",
1615 		    softc->ha_link, param);
1616 		if (param == softc->ha_link)
1617 			return;
1618 		if (softc->ha_link == CTL_HA_LINK_ONLINE) {
1619 			softc->ha_link = param;
1620 			ctl_isc_ha_link_down(softc);
1621 		} else {
1622 			softc->ha_link = param;
1623 			if (softc->ha_link == CTL_HA_LINK_ONLINE)
1624 				ctl_isc_ha_link_up(softc);
1625 		}
1626 		return;
1627 	} else {
1628 		printf("ctl_isc_event_handler: Unknown event %d\n", event);
1629 		return;
1630 	}
1631 }
1632 
1633 static void
1634 ctl_copy_sense_data(union ctl_ha_msg *src, union ctl_io *dest)
1635 {
1636 
1637 	memcpy(&dest->scsiio.sense_data, &src->scsi.sense_data,
1638 	    src->scsi.sense_len);
1639 	dest->scsiio.scsi_status = src->scsi.scsi_status;
1640 	dest->scsiio.sense_len = src->scsi.sense_len;
1641 	dest->io_hdr.status = src->hdr.status;
1642 }
1643 
1644 static void
1645 ctl_copy_sense_data_back(union ctl_io *src, union ctl_ha_msg *dest)
1646 {
1647 
1648 	memcpy(&dest->scsi.sense_data, &src->scsiio.sense_data,
1649 	    src->scsiio.sense_len);
1650 	dest->scsi.scsi_status = src->scsiio.scsi_status;
1651 	dest->scsi.sense_len = src->scsiio.sense_len;
1652 	dest->hdr.status = src->io_hdr.status;
1653 }
1654 
1655 void
1656 ctl_est_ua(struct ctl_lun *lun, uint32_t initidx, ctl_ua_type ua)
1657 {
1658 	struct ctl_softc *softc = lun->ctl_softc;
1659 	ctl_ua_type *pu;
1660 
1661 	if (initidx < softc->init_min || initidx >= softc->init_max)
1662 		return;
1663 	mtx_assert(&lun->lun_lock, MA_OWNED);
1664 	pu = lun->pending_ua[initidx / CTL_MAX_INIT_PER_PORT];
1665 	if (pu == NULL)
1666 		return;
1667 	pu[initidx % CTL_MAX_INIT_PER_PORT] |= ua;
1668 }
1669 
1670 void
1671 ctl_est_ua_port(struct ctl_lun *lun, int port, uint32_t except, ctl_ua_type ua)
1672 {
1673 	int i;
1674 
1675 	mtx_assert(&lun->lun_lock, MA_OWNED);
1676 	if (lun->pending_ua[port] == NULL)
1677 		return;
1678 	for (i = 0; i < CTL_MAX_INIT_PER_PORT; i++) {
1679 		if (port * CTL_MAX_INIT_PER_PORT + i == except)
1680 			continue;
1681 		lun->pending_ua[port][i] |= ua;
1682 	}
1683 }
1684 
1685 void
1686 ctl_est_ua_all(struct ctl_lun *lun, uint32_t except, ctl_ua_type ua)
1687 {
1688 	struct ctl_softc *softc = lun->ctl_softc;
1689 	int i;
1690 
1691 	mtx_assert(&lun->lun_lock, MA_OWNED);
1692 	for (i = softc->port_min; i < softc->port_max; i++)
1693 		ctl_est_ua_port(lun, i, except, ua);
1694 }
1695 
1696 void
1697 ctl_clr_ua(struct ctl_lun *lun, uint32_t initidx, ctl_ua_type ua)
1698 {
1699 	struct ctl_softc *softc = lun->ctl_softc;
1700 	ctl_ua_type *pu;
1701 
1702 	if (initidx < softc->init_min || initidx >= softc->init_max)
1703 		return;
1704 	mtx_assert(&lun->lun_lock, MA_OWNED);
1705 	pu = lun->pending_ua[initidx / CTL_MAX_INIT_PER_PORT];
1706 	if (pu == NULL)
1707 		return;
1708 	pu[initidx % CTL_MAX_INIT_PER_PORT] &= ~ua;
1709 }
1710 
1711 void
1712 ctl_clr_ua_all(struct ctl_lun *lun, uint32_t except, ctl_ua_type ua)
1713 {
1714 	struct ctl_softc *softc = lun->ctl_softc;
1715 	int i, j;
1716 
1717 	mtx_assert(&lun->lun_lock, MA_OWNED);
1718 	for (i = softc->port_min; i < softc->port_max; i++) {
1719 		if (lun->pending_ua[i] == NULL)
1720 			continue;
1721 		for (j = 0; j < CTL_MAX_INIT_PER_PORT; j++) {
1722 			if (i * CTL_MAX_INIT_PER_PORT + j == except)
1723 				continue;
1724 			lun->pending_ua[i][j] &= ~ua;
1725 		}
1726 	}
1727 }
1728 
1729 void
1730 ctl_clr_ua_allluns(struct ctl_softc *ctl_softc, uint32_t initidx,
1731     ctl_ua_type ua_type)
1732 {
1733 	struct ctl_lun *lun;
1734 
1735 	mtx_assert(&ctl_softc->ctl_lock, MA_OWNED);
1736 	STAILQ_FOREACH(lun, &ctl_softc->lun_list, links) {
1737 		mtx_lock(&lun->lun_lock);
1738 		ctl_clr_ua(lun, initidx, ua_type);
1739 		mtx_unlock(&lun->lun_lock);
1740 	}
1741 }
1742 
1743 static int
1744 ctl_ha_role_sysctl(SYSCTL_HANDLER_ARGS)
1745 {
1746 	struct ctl_softc *softc = (struct ctl_softc *)arg1;
1747 	struct ctl_lun *lun;
1748 	struct ctl_lun_req ireq;
1749 	int error, value;
1750 
1751 	value = (softc->flags & CTL_FLAG_ACTIVE_SHELF) ? 0 : 1;
1752 	error = sysctl_handle_int(oidp, &value, 0, req);
1753 	if ((error != 0) || (req->newptr == NULL))
1754 		return (error);
1755 
1756 	mtx_lock(&softc->ctl_lock);
1757 	if (value == 0)
1758 		softc->flags |= CTL_FLAG_ACTIVE_SHELF;
1759 	else
1760 		softc->flags &= ~CTL_FLAG_ACTIVE_SHELF;
1761 	STAILQ_FOREACH(lun, &softc->lun_list, links) {
1762 		mtx_unlock(&softc->ctl_lock);
1763 		bzero(&ireq, sizeof(ireq));
1764 		ireq.reqtype = CTL_LUNREQ_MODIFY;
1765 		ireq.reqdata.modify.lun_id = lun->lun;
1766 		lun->backend->ioctl(NULL, CTL_LUN_REQ, (caddr_t)&ireq, 0,
1767 		    curthread);
1768 		if (ireq.status != CTL_LUN_OK) {
1769 			printf("%s: CTL_LUNREQ_MODIFY returned %d '%s'\n",
1770 			    __func__, ireq.status, ireq.error_str);
1771 		}
1772 		mtx_lock(&softc->ctl_lock);
1773 	}
1774 	mtx_unlock(&softc->ctl_lock);
1775 	return (0);
1776 }
1777 
1778 static int
1779 ctl_init(void)
1780 {
1781 	struct ctl_softc *softc;
1782 	void *other_pool;
1783 	int i, error;
1784 
1785 	softc = control_softc = malloc(sizeof(*control_softc), M_DEVBUF,
1786 			       M_WAITOK | M_ZERO);
1787 
1788 	softc->dev = make_dev(&ctl_cdevsw, 0, UID_ROOT, GID_OPERATOR, 0600,
1789 			      "cam/ctl");
1790 	softc->dev->si_drv1 = softc;
1791 
1792 	sysctl_ctx_init(&softc->sysctl_ctx);
1793 	softc->sysctl_tree = SYSCTL_ADD_NODE(&softc->sysctl_ctx,
1794 		SYSCTL_STATIC_CHILDREN(_kern_cam), OID_AUTO, "ctl",
1795 		CTLFLAG_RD, 0, "CAM Target Layer");
1796 
1797 	if (softc->sysctl_tree == NULL) {
1798 		printf("%s: unable to allocate sysctl tree\n", __func__);
1799 		destroy_dev(softc->dev);
1800 		free(control_softc, M_DEVBUF);
1801 		control_softc = NULL;
1802 		return (ENOMEM);
1803 	}
1804 
1805 	mtx_init(&softc->ctl_lock, "CTL mutex", NULL, MTX_DEF);
1806 	softc->io_zone = uma_zcreate("CTL IO", sizeof(union ctl_io),
1807 	    NULL, NULL, NULL, NULL, UMA_ALIGN_PTR, 0);
1808 	softc->flags = 0;
1809 
1810 	SYSCTL_ADD_INT(&softc->sysctl_ctx, SYSCTL_CHILDREN(softc->sysctl_tree),
1811 	    OID_AUTO, "ha_mode", CTLFLAG_RDTUN, (int *)&softc->ha_mode, 0,
1812 	    "HA mode (0 - act/stby, 1 - serialize only, 2 - xfer)");
1813 
1814 	/*
1815 	 * In Copan's HA scheme, the "master" and "slave" roles are
1816 	 * figured out through the slot the controller is in.  Although it
1817 	 * is an active/active system, someone has to be in charge.
1818 	 */
1819 	SYSCTL_ADD_INT(&softc->sysctl_ctx, SYSCTL_CHILDREN(softc->sysctl_tree),
1820 	    OID_AUTO, "ha_id", CTLFLAG_RDTUN, &softc->ha_id, 0,
1821 	    "HA head ID (0 - no HA)");
1822 	if (softc->ha_id == 0 || softc->ha_id > NUM_HA_SHELVES) {
1823 		softc->flags |= CTL_FLAG_ACTIVE_SHELF;
1824 		softc->is_single = 1;
1825 		softc->port_cnt = CTL_MAX_PORTS;
1826 		softc->port_min = 0;
1827 	} else {
1828 		softc->port_cnt = CTL_MAX_PORTS / NUM_HA_SHELVES;
1829 		softc->port_min = (softc->ha_id - 1) * softc->port_cnt;
1830 	}
1831 	softc->port_max = softc->port_min + softc->port_cnt;
1832 	softc->init_min = softc->port_min * CTL_MAX_INIT_PER_PORT;
1833 	softc->init_max = softc->port_max * CTL_MAX_INIT_PER_PORT;
1834 
1835 	SYSCTL_ADD_INT(&softc->sysctl_ctx, SYSCTL_CHILDREN(softc->sysctl_tree),
1836 	    OID_AUTO, "ha_link", CTLFLAG_RD, (int *)&softc->ha_link, 0,
1837 	    "HA link state (0 - offline, 1 - unknown, 2 - online)");
1838 
1839 	STAILQ_INIT(&softc->lun_list);
1840 	STAILQ_INIT(&softc->pending_lun_queue);
1841 	STAILQ_INIT(&softc->fe_list);
1842 	STAILQ_INIT(&softc->port_list);
1843 	STAILQ_INIT(&softc->be_list);
1844 	ctl_tpc_init(softc);
1845 
1846 	if (ctl_pool_create(softc, "othersc", CTL_POOL_ENTRIES_OTHER_SC,
1847 	                    &other_pool) != 0)
1848 	{
1849 		printf("ctl: can't allocate %d entry other SC pool, "
1850 		       "exiting\n", CTL_POOL_ENTRIES_OTHER_SC);
1851 		return (ENOMEM);
1852 	}
1853 	softc->othersc_pool = other_pool;
1854 
1855 	if (worker_threads <= 0)
1856 		worker_threads = max(1, mp_ncpus / 4);
1857 	if (worker_threads > CTL_MAX_THREADS)
1858 		worker_threads = CTL_MAX_THREADS;
1859 
1860 	for (i = 0; i < worker_threads; i++) {
1861 		struct ctl_thread *thr = &softc->threads[i];
1862 
1863 		mtx_init(&thr->queue_lock, "CTL queue mutex", NULL, MTX_DEF);
1864 		thr->ctl_softc = softc;
1865 		STAILQ_INIT(&thr->incoming_queue);
1866 		STAILQ_INIT(&thr->rtr_queue);
1867 		STAILQ_INIT(&thr->done_queue);
1868 		STAILQ_INIT(&thr->isc_queue);
1869 
1870 		error = kproc_kthread_add(ctl_work_thread, thr,
1871 		    &softc->ctl_proc, &thr->thread, 0, 0, "ctl", "work%d", i);
1872 		if (error != 0) {
1873 			printf("error creating CTL work thread!\n");
1874 			ctl_pool_free(other_pool);
1875 			return (error);
1876 		}
1877 	}
1878 	error = kproc_kthread_add(ctl_lun_thread, softc,
1879 	    &softc->ctl_proc, NULL, 0, 0, "ctl", "lun");
1880 	if (error != 0) {
1881 		printf("error creating CTL lun thread!\n");
1882 		ctl_pool_free(other_pool);
1883 		return (error);
1884 	}
1885 	error = kproc_kthread_add(ctl_thresh_thread, softc,
1886 	    &softc->ctl_proc, NULL, 0, 0, "ctl", "thresh");
1887 	if (error != 0) {
1888 		printf("error creating CTL threshold thread!\n");
1889 		ctl_pool_free(other_pool);
1890 		return (error);
1891 	}
1892 
1893 	SYSCTL_ADD_PROC(&softc->sysctl_ctx,SYSCTL_CHILDREN(softc->sysctl_tree),
1894 	    OID_AUTO, "ha_role", CTLTYPE_INT | CTLFLAG_RWTUN,
1895 	    softc, 0, ctl_ha_role_sysctl, "I", "HA role for this head");
1896 
1897 	if (softc->is_single == 0) {
1898 		ctl_frontend_register(&ha_frontend);
1899 		if (ctl_ha_msg_init(softc) != CTL_HA_STATUS_SUCCESS) {
1900 			printf("ctl_init: ctl_ha_msg_init failed.\n");
1901 			softc->is_single = 1;
1902 		} else
1903 		if (ctl_ha_msg_register(CTL_HA_CHAN_CTL, ctl_isc_event_handler)
1904 		    != CTL_HA_STATUS_SUCCESS) {
1905 			printf("ctl_init: ctl_ha_msg_register failed.\n");
1906 			softc->is_single = 1;
1907 		}
1908 	}
1909 	return (0);
1910 }
1911 
1912 void
1913 ctl_shutdown(void)
1914 {
1915 	struct ctl_softc *softc = control_softc;
1916 	struct ctl_lun *lun, *next_lun;
1917 
1918 	if (softc->is_single == 0) {
1919 		ctl_ha_msg_shutdown(softc);
1920 		if (ctl_ha_msg_deregister(CTL_HA_CHAN_CTL)
1921 		    != CTL_HA_STATUS_SUCCESS)
1922 			printf("%s: ctl_ha_msg_deregister failed.\n", __func__);
1923 		if (ctl_ha_msg_destroy(softc) != CTL_HA_STATUS_SUCCESS)
1924 			printf("%s: ctl_ha_msg_destroy failed.\n", __func__);
1925 		ctl_frontend_deregister(&ha_frontend);
1926 	}
1927 
1928 	mtx_lock(&softc->ctl_lock);
1929 
1930 	STAILQ_FOREACH_SAFE(lun, &softc->lun_list, links, next_lun)
1931 		ctl_free_lun(lun);
1932 
1933 	mtx_unlock(&softc->ctl_lock);
1934 
1935 #if 0
1936 	ctl_shutdown_thread(softc->work_thread);
1937 	mtx_destroy(&softc->queue_lock);
1938 #endif
1939 
1940 	ctl_tpc_shutdown(softc);
1941 	uma_zdestroy(softc->io_zone);
1942 	mtx_destroy(&softc->ctl_lock);
1943 
1944 	destroy_dev(softc->dev);
1945 
1946 	sysctl_ctx_free(&softc->sysctl_ctx);
1947 
1948 	free(control_softc, M_DEVBUF);
1949 	control_softc = NULL;
1950 }
1951 
1952 static int
1953 ctl_module_event_handler(module_t mod, int what, void *arg)
1954 {
1955 
1956 	switch (what) {
1957 	case MOD_LOAD:
1958 		return (ctl_init());
1959 	case MOD_UNLOAD:
1960 		return (EBUSY);
1961 	default:
1962 		return (EOPNOTSUPP);
1963 	}
1964 }
1965 
1966 /*
1967  * XXX KDM should we do some access checks here?  Bump a reference count to
1968  * prevent a CTL module from being unloaded while someone has it open?
1969  */
1970 static int
1971 ctl_open(struct cdev *dev, int flags, int fmt, struct thread *td)
1972 {
1973 	return (0);
1974 }
1975 
1976 static int
1977 ctl_close(struct cdev *dev, int flags, int fmt, struct thread *td)
1978 {
1979 	return (0);
1980 }
1981 
1982 /*
1983  * Remove an initiator by port number and initiator ID.
1984  * Returns 0 for success, -1 for failure.
1985  */
1986 int
1987 ctl_remove_initiator(struct ctl_port *port, int iid)
1988 {
1989 	struct ctl_softc *softc = port->ctl_softc;
1990 
1991 	mtx_assert(&softc->ctl_lock, MA_NOTOWNED);
1992 
1993 	if (iid > CTL_MAX_INIT_PER_PORT) {
1994 		printf("%s: initiator ID %u > maximun %u!\n",
1995 		       __func__, iid, CTL_MAX_INIT_PER_PORT);
1996 		return (-1);
1997 	}
1998 
1999 	mtx_lock(&softc->ctl_lock);
2000 	port->wwpn_iid[iid].in_use--;
2001 	port->wwpn_iid[iid].last_use = time_uptime;
2002 	mtx_unlock(&softc->ctl_lock);
2003 	ctl_isc_announce_iid(port, iid);
2004 
2005 	return (0);
2006 }
2007 
2008 /*
2009  * Add an initiator to the initiator map.
2010  * Returns iid for success, < 0 for failure.
2011  */
2012 int
2013 ctl_add_initiator(struct ctl_port *port, int iid, uint64_t wwpn, char *name)
2014 {
2015 	struct ctl_softc *softc = port->ctl_softc;
2016 	time_t best_time;
2017 	int i, best;
2018 
2019 	mtx_assert(&softc->ctl_lock, MA_NOTOWNED);
2020 
2021 	if (iid >= CTL_MAX_INIT_PER_PORT) {
2022 		printf("%s: WWPN %#jx initiator ID %u > maximum %u!\n",
2023 		       __func__, wwpn, iid, CTL_MAX_INIT_PER_PORT);
2024 		free(name, M_CTL);
2025 		return (-1);
2026 	}
2027 
2028 	mtx_lock(&softc->ctl_lock);
2029 
2030 	if (iid < 0 && (wwpn != 0 || name != NULL)) {
2031 		for (i = 0; i < CTL_MAX_INIT_PER_PORT; i++) {
2032 			if (wwpn != 0 && wwpn == port->wwpn_iid[i].wwpn) {
2033 				iid = i;
2034 				break;
2035 			}
2036 			if (name != NULL && port->wwpn_iid[i].name != NULL &&
2037 			    strcmp(name, port->wwpn_iid[i].name) == 0) {
2038 				iid = i;
2039 				break;
2040 			}
2041 		}
2042 	}
2043 
2044 	if (iid < 0) {
2045 		for (i = 0; i < CTL_MAX_INIT_PER_PORT; i++) {
2046 			if (port->wwpn_iid[i].in_use == 0 &&
2047 			    port->wwpn_iid[i].wwpn == 0 &&
2048 			    port->wwpn_iid[i].name == NULL) {
2049 				iid = i;
2050 				break;
2051 			}
2052 		}
2053 	}
2054 
2055 	if (iid < 0) {
2056 		best = -1;
2057 		best_time = INT32_MAX;
2058 		for (i = 0; i < CTL_MAX_INIT_PER_PORT; i++) {
2059 			if (port->wwpn_iid[i].in_use == 0) {
2060 				if (port->wwpn_iid[i].last_use < best_time) {
2061 					best = i;
2062 					best_time = port->wwpn_iid[i].last_use;
2063 				}
2064 			}
2065 		}
2066 		iid = best;
2067 	}
2068 
2069 	if (iid < 0) {
2070 		mtx_unlock(&softc->ctl_lock);
2071 		free(name, M_CTL);
2072 		return (-2);
2073 	}
2074 
2075 	if (port->wwpn_iid[iid].in_use > 0 && (wwpn != 0 || name != NULL)) {
2076 		/*
2077 		 * This is not an error yet.
2078 		 */
2079 		if (wwpn != 0 && wwpn == port->wwpn_iid[iid].wwpn) {
2080 #if 0
2081 			printf("%s: port %d iid %u WWPN %#jx arrived"
2082 			    " again\n", __func__, port->targ_port,
2083 			    iid, (uintmax_t)wwpn);
2084 #endif
2085 			goto take;
2086 		}
2087 		if (name != NULL && port->wwpn_iid[iid].name != NULL &&
2088 		    strcmp(name, port->wwpn_iid[iid].name) == 0) {
2089 #if 0
2090 			printf("%s: port %d iid %u name '%s' arrived"
2091 			    " again\n", __func__, port->targ_port,
2092 			    iid, name);
2093 #endif
2094 			goto take;
2095 		}
2096 
2097 		/*
2098 		 * This is an error, but what do we do about it?  The
2099 		 * driver is telling us we have a new WWPN for this
2100 		 * initiator ID, so we pretty much need to use it.
2101 		 */
2102 		printf("%s: port %d iid %u WWPN %#jx '%s' arrived,"
2103 		    " but WWPN %#jx '%s' is still at that address\n",
2104 		    __func__, port->targ_port, iid, wwpn, name,
2105 		    (uintmax_t)port->wwpn_iid[iid].wwpn,
2106 		    port->wwpn_iid[iid].name);
2107 
2108 		/*
2109 		 * XXX KDM clear have_ca and ua_pending on each LUN for
2110 		 * this initiator.
2111 		 */
2112 	}
2113 take:
2114 	free(port->wwpn_iid[iid].name, M_CTL);
2115 	port->wwpn_iid[iid].name = name;
2116 	port->wwpn_iid[iid].wwpn = wwpn;
2117 	port->wwpn_iid[iid].in_use++;
2118 	mtx_unlock(&softc->ctl_lock);
2119 	ctl_isc_announce_iid(port, iid);
2120 
2121 	return (iid);
2122 }
2123 
2124 static int
2125 ctl_create_iid(struct ctl_port *port, int iid, uint8_t *buf)
2126 {
2127 	int len;
2128 
2129 	switch (port->port_type) {
2130 	case CTL_PORT_FC:
2131 	{
2132 		struct scsi_transportid_fcp *id =
2133 		    (struct scsi_transportid_fcp *)buf;
2134 		if (port->wwpn_iid[iid].wwpn == 0)
2135 			return (0);
2136 		memset(id, 0, sizeof(*id));
2137 		id->format_protocol = SCSI_PROTO_FC;
2138 		scsi_u64to8b(port->wwpn_iid[iid].wwpn, id->n_port_name);
2139 		return (sizeof(*id));
2140 	}
2141 	case CTL_PORT_ISCSI:
2142 	{
2143 		struct scsi_transportid_iscsi_port *id =
2144 		    (struct scsi_transportid_iscsi_port *)buf;
2145 		if (port->wwpn_iid[iid].name == NULL)
2146 			return (0);
2147 		memset(id, 0, 256);
2148 		id->format_protocol = SCSI_TRN_ISCSI_FORMAT_PORT |
2149 		    SCSI_PROTO_ISCSI;
2150 		len = strlcpy(id->iscsi_name, port->wwpn_iid[iid].name, 252) + 1;
2151 		len = roundup2(min(len, 252), 4);
2152 		scsi_ulto2b(len, id->additional_length);
2153 		return (sizeof(*id) + len);
2154 	}
2155 	case CTL_PORT_SAS:
2156 	{
2157 		struct scsi_transportid_sas *id =
2158 		    (struct scsi_transportid_sas *)buf;
2159 		if (port->wwpn_iid[iid].wwpn == 0)
2160 			return (0);
2161 		memset(id, 0, sizeof(*id));
2162 		id->format_protocol = SCSI_PROTO_SAS;
2163 		scsi_u64to8b(port->wwpn_iid[iid].wwpn, id->sas_address);
2164 		return (sizeof(*id));
2165 	}
2166 	default:
2167 	{
2168 		struct scsi_transportid_spi *id =
2169 		    (struct scsi_transportid_spi *)buf;
2170 		memset(id, 0, sizeof(*id));
2171 		id->format_protocol = SCSI_PROTO_SPI;
2172 		scsi_ulto2b(iid, id->scsi_addr);
2173 		scsi_ulto2b(port->targ_port, id->rel_trgt_port_id);
2174 		return (sizeof(*id));
2175 	}
2176 	}
2177 }
2178 
2179 /*
2180  * Serialize a command that went down the "wrong" side, and so was sent to
2181  * this controller for execution.  The logic is a little different than the
2182  * standard case in ctl_scsiio_precheck().  Errors in this case need to get
2183  * sent back to the other side, but in the success case, we execute the
2184  * command on this side (XFER mode) or tell the other side to execute it
2185  * (SER_ONLY mode).
2186  */
2187 static int
2188 ctl_serialize_other_sc_cmd(struct ctl_scsiio *ctsio)
2189 {
2190 	struct ctl_softc *softc = control_softc;
2191 	union ctl_ha_msg msg_info;
2192 	struct ctl_port *port;
2193 	struct ctl_lun *lun;
2194 	const struct ctl_cmd_entry *entry;
2195 	int retval = 0;
2196 	uint32_t targ_lun;
2197 
2198 	targ_lun = ctsio->io_hdr.nexus.targ_mapped_lun;
2199 	mtx_lock(&softc->ctl_lock);
2200 
2201 	/* Make sure that we know about this port. */
2202 	port = ctl_io_port(&ctsio->io_hdr);
2203 	if (port == NULL || (port->status & CTL_PORT_STATUS_ONLINE) == 0) {
2204 		ctl_set_internal_failure(ctsio, /*sks_valid*/ 0,
2205 					 /*retry_count*/ 1);
2206 		goto badjuju;
2207 	}
2208 
2209 	/* Make sure that we know about this LUN. */
2210 	if ((targ_lun < CTL_MAX_LUNS) &&
2211 	    ((lun = softc->ctl_luns[targ_lun]) != NULL)) {
2212 		mtx_lock(&lun->lun_lock);
2213 		mtx_unlock(&softc->ctl_lock);
2214 		/*
2215 		 * If the LUN is invalid, pretend that it doesn't exist.
2216 		 * It will go away as soon as all pending I/O has been
2217 		 * completed.
2218 		 */
2219 		if (lun->flags & CTL_LUN_DISABLED) {
2220 			mtx_unlock(&lun->lun_lock);
2221 			lun = NULL;
2222 		}
2223 	} else {
2224 		mtx_unlock(&softc->ctl_lock);
2225 		lun = NULL;
2226 	}
2227 	if (lun == NULL) {
2228 		/*
2229 		 * The other node would not send this request to us unless
2230 		 * received announce that we are primary node for this LUN.
2231 		 * If this LUN does not exist now, it is probably result of
2232 		 * a race, so respond to initiator in the most opaque way.
2233 		 */
2234 		ctl_set_busy(ctsio);
2235 		goto badjuju;
2236 	}
2237 
2238 	entry = ctl_get_cmd_entry(ctsio, NULL);
2239 	if (ctl_scsiio_lun_check(lun, entry, ctsio) != 0) {
2240 		mtx_unlock(&lun->lun_lock);
2241 		goto badjuju;
2242 	}
2243 
2244 	ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr = lun;
2245 	ctsio->io_hdr.ctl_private[CTL_PRIV_BACKEND_LUN].ptr = lun->be_lun;
2246 
2247 	/*
2248 	 * Every I/O goes into the OOA queue for a
2249 	 * particular LUN, and stays there until completion.
2250 	 */
2251 #ifdef CTL_TIME_IO
2252 	if (TAILQ_EMPTY(&lun->ooa_queue))
2253 		lun->idle_time += getsbinuptime() - lun->last_busy;
2254 #endif
2255 	TAILQ_INSERT_TAIL(&lun->ooa_queue, &ctsio->io_hdr, ooa_links);
2256 
2257 	switch (ctl_check_ooa(lun, (union ctl_io *)ctsio,
2258 		(union ctl_io *)TAILQ_PREV(&ctsio->io_hdr, ctl_ooaq,
2259 		 ooa_links))) {
2260 	case CTL_ACTION_BLOCK:
2261 		ctsio->io_hdr.flags |= CTL_FLAG_BLOCKED;
2262 		TAILQ_INSERT_TAIL(&lun->blocked_queue, &ctsio->io_hdr,
2263 				  blocked_links);
2264 		mtx_unlock(&lun->lun_lock);
2265 		break;
2266 	case CTL_ACTION_PASS:
2267 	case CTL_ACTION_SKIP:
2268 		if (softc->ha_mode == CTL_HA_MODE_XFER) {
2269 			ctsio->io_hdr.flags |= CTL_FLAG_IS_WAS_ON_RTR;
2270 			ctl_enqueue_rtr((union ctl_io *)ctsio);
2271 			mtx_unlock(&lun->lun_lock);
2272 		} else {
2273 			ctsio->io_hdr.flags &= ~CTL_FLAG_IO_ACTIVE;
2274 			mtx_unlock(&lun->lun_lock);
2275 
2276 			/* send msg back to other side */
2277 			msg_info.hdr.original_sc = ctsio->io_hdr.original_sc;
2278 			msg_info.hdr.serializing_sc = (union ctl_io *)ctsio;
2279 			msg_info.hdr.msg_type = CTL_MSG_R2R;
2280 			ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg_info,
2281 			    sizeof(msg_info.hdr), M_WAITOK);
2282 		}
2283 		break;
2284 	case CTL_ACTION_OVERLAP:
2285 		TAILQ_REMOVE(&lun->ooa_queue, &ctsio->io_hdr, ooa_links);
2286 		mtx_unlock(&lun->lun_lock);
2287 		ctl_set_overlapped_cmd(ctsio);
2288 		goto badjuju;
2289 	case CTL_ACTION_OVERLAP_TAG:
2290 		TAILQ_REMOVE(&lun->ooa_queue, &ctsio->io_hdr, ooa_links);
2291 		mtx_unlock(&lun->lun_lock);
2292 		ctl_set_overlapped_tag(ctsio, ctsio->tag_num);
2293 		goto badjuju;
2294 	case CTL_ACTION_ERROR:
2295 	default:
2296 		TAILQ_REMOVE(&lun->ooa_queue, &ctsio->io_hdr, ooa_links);
2297 		mtx_unlock(&lun->lun_lock);
2298 
2299 		ctl_set_internal_failure(ctsio, /*sks_valid*/ 0,
2300 					 /*retry_count*/ 0);
2301 badjuju:
2302 		ctl_copy_sense_data_back((union ctl_io *)ctsio, &msg_info);
2303 		msg_info.hdr.original_sc = ctsio->io_hdr.original_sc;
2304 		msg_info.hdr.serializing_sc = NULL;
2305 		msg_info.hdr.msg_type = CTL_MSG_BAD_JUJU;
2306 		ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg_info,
2307 		    sizeof(msg_info.scsi), M_WAITOK);
2308 		retval = 1;
2309 		break;
2310 	}
2311 	return (retval);
2312 }
2313 
2314 /*
2315  * Returns 0 for success, errno for failure.
2316  */
2317 static void
2318 ctl_ioctl_fill_ooa(struct ctl_lun *lun, uint32_t *cur_fill_num,
2319 		   struct ctl_ooa *ooa_hdr, struct ctl_ooa_entry *kern_entries)
2320 {
2321 	union ctl_io *io;
2322 
2323 	mtx_lock(&lun->lun_lock);
2324 	for (io = (union ctl_io *)TAILQ_FIRST(&lun->ooa_queue); (io != NULL);
2325 	     (*cur_fill_num)++, io = (union ctl_io *)TAILQ_NEXT(&io->io_hdr,
2326 	     ooa_links)) {
2327 		struct ctl_ooa_entry *entry;
2328 
2329 		/*
2330 		 * If we've got more than we can fit, just count the
2331 		 * remaining entries.
2332 		 */
2333 		if (*cur_fill_num >= ooa_hdr->alloc_num)
2334 			continue;
2335 
2336 		entry = &kern_entries[*cur_fill_num];
2337 
2338 		entry->tag_num = io->scsiio.tag_num;
2339 		entry->lun_num = lun->lun;
2340 #ifdef CTL_TIME_IO
2341 		entry->start_bt = io->io_hdr.start_bt;
2342 #endif
2343 		bcopy(io->scsiio.cdb, entry->cdb, io->scsiio.cdb_len);
2344 		entry->cdb_len = io->scsiio.cdb_len;
2345 		if (io->io_hdr.flags & CTL_FLAG_BLOCKED)
2346 			entry->cmd_flags |= CTL_OOACMD_FLAG_BLOCKED;
2347 
2348 		if (io->io_hdr.flags & CTL_FLAG_DMA_INPROG)
2349 			entry->cmd_flags |= CTL_OOACMD_FLAG_DMA;
2350 
2351 		if (io->io_hdr.flags & CTL_FLAG_ABORT)
2352 			entry->cmd_flags |= CTL_OOACMD_FLAG_ABORT;
2353 
2354 		if (io->io_hdr.flags & CTL_FLAG_IS_WAS_ON_RTR)
2355 			entry->cmd_flags |= CTL_OOACMD_FLAG_RTR;
2356 
2357 		if (io->io_hdr.flags & CTL_FLAG_DMA_QUEUED)
2358 			entry->cmd_flags |= CTL_OOACMD_FLAG_DMA_QUEUED;
2359 	}
2360 	mtx_unlock(&lun->lun_lock);
2361 }
2362 
2363 static void *
2364 ctl_copyin_alloc(void *user_addr, int len, char *error_str,
2365 		 size_t error_str_len)
2366 {
2367 	void *kptr;
2368 
2369 	kptr = malloc(len, M_CTL, M_WAITOK | M_ZERO);
2370 
2371 	if (copyin(user_addr, kptr, len) != 0) {
2372 		snprintf(error_str, error_str_len, "Error copying %d bytes "
2373 			 "from user address %p to kernel address %p", len,
2374 			 user_addr, kptr);
2375 		free(kptr, M_CTL);
2376 		return (NULL);
2377 	}
2378 
2379 	return (kptr);
2380 }
2381 
2382 static void
2383 ctl_free_args(int num_args, struct ctl_be_arg *args)
2384 {
2385 	int i;
2386 
2387 	if (args == NULL)
2388 		return;
2389 
2390 	for (i = 0; i < num_args; i++) {
2391 		free(args[i].kname, M_CTL);
2392 		free(args[i].kvalue, M_CTL);
2393 	}
2394 
2395 	free(args, M_CTL);
2396 }
2397 
2398 static struct ctl_be_arg *
2399 ctl_copyin_args(int num_args, struct ctl_be_arg *uargs,
2400 		char *error_str, size_t error_str_len)
2401 {
2402 	struct ctl_be_arg *args;
2403 	int i;
2404 
2405 	args = ctl_copyin_alloc(uargs, num_args * sizeof(*args),
2406 				error_str, error_str_len);
2407 
2408 	if (args == NULL)
2409 		goto bailout;
2410 
2411 	for (i = 0; i < num_args; i++) {
2412 		args[i].kname = NULL;
2413 		args[i].kvalue = NULL;
2414 	}
2415 
2416 	for (i = 0; i < num_args; i++) {
2417 		uint8_t *tmpptr;
2418 
2419 		args[i].kname = ctl_copyin_alloc(args[i].name,
2420 			args[i].namelen, error_str, error_str_len);
2421 		if (args[i].kname == NULL)
2422 			goto bailout;
2423 
2424 		if (args[i].kname[args[i].namelen - 1] != '\0') {
2425 			snprintf(error_str, error_str_len, "Argument %d "
2426 				 "name is not NUL-terminated", i);
2427 			goto bailout;
2428 		}
2429 
2430 		if (args[i].flags & CTL_BEARG_RD) {
2431 			tmpptr = ctl_copyin_alloc(args[i].value,
2432 				args[i].vallen, error_str, error_str_len);
2433 			if (tmpptr == NULL)
2434 				goto bailout;
2435 			if ((args[i].flags & CTL_BEARG_ASCII)
2436 			 && (tmpptr[args[i].vallen - 1] != '\0')) {
2437 				snprintf(error_str, error_str_len, "Argument "
2438 				    "%d value is not NUL-terminated", i);
2439 				goto bailout;
2440 			}
2441 			args[i].kvalue = tmpptr;
2442 		} else {
2443 			args[i].kvalue = malloc(args[i].vallen,
2444 			    M_CTL, M_WAITOK | M_ZERO);
2445 		}
2446 	}
2447 
2448 	return (args);
2449 bailout:
2450 
2451 	ctl_free_args(num_args, args);
2452 
2453 	return (NULL);
2454 }
2455 
2456 static void
2457 ctl_copyout_args(int num_args, struct ctl_be_arg *args)
2458 {
2459 	int i;
2460 
2461 	for (i = 0; i < num_args; i++) {
2462 		if (args[i].flags & CTL_BEARG_WR)
2463 			copyout(args[i].kvalue, args[i].value, args[i].vallen);
2464 	}
2465 }
2466 
2467 /*
2468  * Escape characters that are illegal or not recommended in XML.
2469  */
2470 int
2471 ctl_sbuf_printf_esc(struct sbuf *sb, char *str, int size)
2472 {
2473 	char *end = str + size;
2474 	int retval;
2475 
2476 	retval = 0;
2477 
2478 	for (; *str && str < end; str++) {
2479 		switch (*str) {
2480 		case '&':
2481 			retval = sbuf_printf(sb, "&amp;");
2482 			break;
2483 		case '>':
2484 			retval = sbuf_printf(sb, "&gt;");
2485 			break;
2486 		case '<':
2487 			retval = sbuf_printf(sb, "&lt;");
2488 			break;
2489 		default:
2490 			retval = sbuf_putc(sb, *str);
2491 			break;
2492 		}
2493 
2494 		if (retval != 0)
2495 			break;
2496 
2497 	}
2498 
2499 	return (retval);
2500 }
2501 
2502 static void
2503 ctl_id_sbuf(struct ctl_devid *id, struct sbuf *sb)
2504 {
2505 	struct scsi_vpd_id_descriptor *desc;
2506 	int i;
2507 
2508 	if (id == NULL || id->len < 4)
2509 		return;
2510 	desc = (struct scsi_vpd_id_descriptor *)id->data;
2511 	switch (desc->id_type & SVPD_ID_TYPE_MASK) {
2512 	case SVPD_ID_TYPE_T10:
2513 		sbuf_printf(sb, "t10.");
2514 		break;
2515 	case SVPD_ID_TYPE_EUI64:
2516 		sbuf_printf(sb, "eui.");
2517 		break;
2518 	case SVPD_ID_TYPE_NAA:
2519 		sbuf_printf(sb, "naa.");
2520 		break;
2521 	case SVPD_ID_TYPE_SCSI_NAME:
2522 		break;
2523 	}
2524 	switch (desc->proto_codeset & SVPD_ID_CODESET_MASK) {
2525 	case SVPD_ID_CODESET_BINARY:
2526 		for (i = 0; i < desc->length; i++)
2527 			sbuf_printf(sb, "%02x", desc->identifier[i]);
2528 		break;
2529 	case SVPD_ID_CODESET_ASCII:
2530 		sbuf_printf(sb, "%.*s", (int)desc->length,
2531 		    (char *)desc->identifier);
2532 		break;
2533 	case SVPD_ID_CODESET_UTF8:
2534 		sbuf_printf(sb, "%s", (char *)desc->identifier);
2535 		break;
2536 	}
2537 }
2538 
2539 static int
2540 ctl_ioctl(struct cdev *dev, u_long cmd, caddr_t addr, int flag,
2541 	  struct thread *td)
2542 {
2543 	struct ctl_softc *softc = dev->si_drv1;
2544 	struct ctl_lun *lun;
2545 	int retval;
2546 
2547 	retval = 0;
2548 
2549 	switch (cmd) {
2550 	case CTL_IO:
2551 		retval = ctl_ioctl_io(dev, cmd, addr, flag, td);
2552 		break;
2553 	case CTL_ENABLE_PORT:
2554 	case CTL_DISABLE_PORT:
2555 	case CTL_SET_PORT_WWNS: {
2556 		struct ctl_port *port;
2557 		struct ctl_port_entry *entry;
2558 
2559 		entry = (struct ctl_port_entry *)addr;
2560 
2561 		mtx_lock(&softc->ctl_lock);
2562 		STAILQ_FOREACH(port, &softc->port_list, links) {
2563 			int action, done;
2564 
2565 			if (port->targ_port < softc->port_min ||
2566 			    port->targ_port >= softc->port_max)
2567 				continue;
2568 
2569 			action = 0;
2570 			done = 0;
2571 			if ((entry->port_type == CTL_PORT_NONE)
2572 			 && (entry->targ_port == port->targ_port)) {
2573 				/*
2574 				 * If the user only wants to enable or
2575 				 * disable or set WWNs on a specific port,
2576 				 * do the operation and we're done.
2577 				 */
2578 				action = 1;
2579 				done = 1;
2580 			} else if (entry->port_type & port->port_type) {
2581 				/*
2582 				 * Compare the user's type mask with the
2583 				 * particular frontend type to see if we
2584 				 * have a match.
2585 				 */
2586 				action = 1;
2587 				done = 0;
2588 
2589 				/*
2590 				 * Make sure the user isn't trying to set
2591 				 * WWNs on multiple ports at the same time.
2592 				 */
2593 				if (cmd == CTL_SET_PORT_WWNS) {
2594 					printf("%s: Can't set WWNs on "
2595 					       "multiple ports\n", __func__);
2596 					retval = EINVAL;
2597 					break;
2598 				}
2599 			}
2600 			if (action == 0)
2601 				continue;
2602 
2603 			/*
2604 			 * XXX KDM we have to drop the lock here, because
2605 			 * the online/offline operations can potentially
2606 			 * block.  We need to reference count the frontends
2607 			 * so they can't go away,
2608 			 */
2609 			if (cmd == CTL_ENABLE_PORT) {
2610 				mtx_unlock(&softc->ctl_lock);
2611 				ctl_port_online(port);
2612 				mtx_lock(&softc->ctl_lock);
2613 			} else if (cmd == CTL_DISABLE_PORT) {
2614 				mtx_unlock(&softc->ctl_lock);
2615 				ctl_port_offline(port);
2616 				mtx_lock(&softc->ctl_lock);
2617 			} else if (cmd == CTL_SET_PORT_WWNS) {
2618 				ctl_port_set_wwns(port,
2619 				    (entry->flags & CTL_PORT_WWNN_VALID) ?
2620 				    1 : 0, entry->wwnn,
2621 				    (entry->flags & CTL_PORT_WWPN_VALID) ?
2622 				    1 : 0, entry->wwpn);
2623 			}
2624 			if (done != 0)
2625 				break;
2626 		}
2627 		mtx_unlock(&softc->ctl_lock);
2628 		break;
2629 	}
2630 	case CTL_GET_OOA: {
2631 		struct ctl_ooa *ooa_hdr;
2632 		struct ctl_ooa_entry *entries;
2633 		uint32_t cur_fill_num;
2634 
2635 		ooa_hdr = (struct ctl_ooa *)addr;
2636 
2637 		if ((ooa_hdr->alloc_len == 0)
2638 		 || (ooa_hdr->alloc_num == 0)) {
2639 			printf("%s: CTL_GET_OOA: alloc len %u and alloc num %u "
2640 			       "must be non-zero\n", __func__,
2641 			       ooa_hdr->alloc_len, ooa_hdr->alloc_num);
2642 			retval = EINVAL;
2643 			break;
2644 		}
2645 
2646 		if (ooa_hdr->alloc_len != (ooa_hdr->alloc_num *
2647 		    sizeof(struct ctl_ooa_entry))) {
2648 			printf("%s: CTL_GET_OOA: alloc len %u must be alloc "
2649 			       "num %d * sizeof(struct ctl_ooa_entry) %zd\n",
2650 			       __func__, ooa_hdr->alloc_len,
2651 			       ooa_hdr->alloc_num,sizeof(struct ctl_ooa_entry));
2652 			retval = EINVAL;
2653 			break;
2654 		}
2655 
2656 		entries = malloc(ooa_hdr->alloc_len, M_CTL, M_WAITOK | M_ZERO);
2657 		if (entries == NULL) {
2658 			printf("%s: could not allocate %d bytes for OOA "
2659 			       "dump\n", __func__, ooa_hdr->alloc_len);
2660 			retval = ENOMEM;
2661 			break;
2662 		}
2663 
2664 		mtx_lock(&softc->ctl_lock);
2665 		if (((ooa_hdr->flags & CTL_OOA_FLAG_ALL_LUNS) == 0)
2666 		 && ((ooa_hdr->lun_num >= CTL_MAX_LUNS)
2667 		  || (softc->ctl_luns[ooa_hdr->lun_num] == NULL))) {
2668 			mtx_unlock(&softc->ctl_lock);
2669 			free(entries, M_CTL);
2670 			printf("%s: CTL_GET_OOA: invalid LUN %ju\n",
2671 			       __func__, (uintmax_t)ooa_hdr->lun_num);
2672 			retval = EINVAL;
2673 			break;
2674 		}
2675 
2676 		cur_fill_num = 0;
2677 
2678 		if (ooa_hdr->flags & CTL_OOA_FLAG_ALL_LUNS) {
2679 			STAILQ_FOREACH(lun, &softc->lun_list, links) {
2680 				ctl_ioctl_fill_ooa(lun, &cur_fill_num,
2681 				    ooa_hdr, entries);
2682 			}
2683 		} else {
2684 			lun = softc->ctl_luns[ooa_hdr->lun_num];
2685 			ctl_ioctl_fill_ooa(lun, &cur_fill_num, ooa_hdr,
2686 			    entries);
2687 		}
2688 		mtx_unlock(&softc->ctl_lock);
2689 
2690 		ooa_hdr->fill_num = min(cur_fill_num, ooa_hdr->alloc_num);
2691 		ooa_hdr->fill_len = ooa_hdr->fill_num *
2692 			sizeof(struct ctl_ooa_entry);
2693 		retval = copyout(entries, ooa_hdr->entries, ooa_hdr->fill_len);
2694 		if (retval != 0) {
2695 			printf("%s: error copying out %d bytes for OOA dump\n",
2696 			       __func__, ooa_hdr->fill_len);
2697 		}
2698 
2699 		getbinuptime(&ooa_hdr->cur_bt);
2700 
2701 		if (cur_fill_num > ooa_hdr->alloc_num) {
2702 			ooa_hdr->dropped_num = cur_fill_num -ooa_hdr->alloc_num;
2703 			ooa_hdr->status = CTL_OOA_NEED_MORE_SPACE;
2704 		} else {
2705 			ooa_hdr->dropped_num = 0;
2706 			ooa_hdr->status = CTL_OOA_OK;
2707 		}
2708 
2709 		free(entries, M_CTL);
2710 		break;
2711 	}
2712 	case CTL_DELAY_IO: {
2713 		struct ctl_io_delay_info *delay_info;
2714 
2715 		delay_info = (struct ctl_io_delay_info *)addr;
2716 
2717 #ifdef CTL_IO_DELAY
2718 		mtx_lock(&softc->ctl_lock);
2719 
2720 		if ((delay_info->lun_id >= CTL_MAX_LUNS)
2721 		 || (softc->ctl_luns[delay_info->lun_id] == NULL)) {
2722 			delay_info->status = CTL_DELAY_STATUS_INVALID_LUN;
2723 		} else {
2724 			lun = softc->ctl_luns[delay_info->lun_id];
2725 			mtx_lock(&lun->lun_lock);
2726 
2727 			delay_info->status = CTL_DELAY_STATUS_OK;
2728 
2729 			switch (delay_info->delay_type) {
2730 			case CTL_DELAY_TYPE_CONT:
2731 				break;
2732 			case CTL_DELAY_TYPE_ONESHOT:
2733 				break;
2734 			default:
2735 				delay_info->status =
2736 					CTL_DELAY_STATUS_INVALID_TYPE;
2737 				break;
2738 			}
2739 
2740 			switch (delay_info->delay_loc) {
2741 			case CTL_DELAY_LOC_DATAMOVE:
2742 				lun->delay_info.datamove_type =
2743 					delay_info->delay_type;
2744 				lun->delay_info.datamove_delay =
2745 					delay_info->delay_secs;
2746 				break;
2747 			case CTL_DELAY_LOC_DONE:
2748 				lun->delay_info.done_type =
2749 					delay_info->delay_type;
2750 				lun->delay_info.done_delay =
2751 					delay_info->delay_secs;
2752 				break;
2753 			default:
2754 				delay_info->status =
2755 					CTL_DELAY_STATUS_INVALID_LOC;
2756 				break;
2757 			}
2758 			mtx_unlock(&lun->lun_lock);
2759 		}
2760 
2761 		mtx_unlock(&softc->ctl_lock);
2762 #else
2763 		delay_info->status = CTL_DELAY_STATUS_NOT_IMPLEMENTED;
2764 #endif /* CTL_IO_DELAY */
2765 		break;
2766 	}
2767 	case CTL_GETSTATS: {
2768 		struct ctl_stats *stats;
2769 		int i;
2770 
2771 		stats = (struct ctl_stats *)addr;
2772 
2773 		if ((sizeof(struct ctl_lun_io_stats) * softc->num_luns) >
2774 		     stats->alloc_len) {
2775 			stats->status = CTL_SS_NEED_MORE_SPACE;
2776 			stats->num_luns = softc->num_luns;
2777 			break;
2778 		}
2779 		/*
2780 		 * XXX KDM no locking here.  If the LUN list changes,
2781 		 * things can blow up.
2782 		 */
2783 		i = 0;
2784 		STAILQ_FOREACH(lun, &softc->lun_list, links) {
2785 			retval = copyout(&lun->stats, &stats->lun_stats[i++],
2786 					 sizeof(lun->stats));
2787 			if (retval != 0)
2788 				break;
2789 		}
2790 		stats->num_luns = softc->num_luns;
2791 		stats->fill_len = sizeof(struct ctl_lun_io_stats) *
2792 				 softc->num_luns;
2793 		stats->status = CTL_SS_OK;
2794 #ifdef CTL_TIME_IO
2795 		stats->flags = CTL_STATS_FLAG_TIME_VALID;
2796 #else
2797 		stats->flags = CTL_STATS_FLAG_NONE;
2798 #endif
2799 		getnanouptime(&stats->timestamp);
2800 		break;
2801 	}
2802 	case CTL_ERROR_INJECT: {
2803 		struct ctl_error_desc *err_desc, *new_err_desc;
2804 
2805 		err_desc = (struct ctl_error_desc *)addr;
2806 
2807 		new_err_desc = malloc(sizeof(*new_err_desc), M_CTL,
2808 				      M_WAITOK | M_ZERO);
2809 		bcopy(err_desc, new_err_desc, sizeof(*new_err_desc));
2810 
2811 		mtx_lock(&softc->ctl_lock);
2812 		lun = softc->ctl_luns[err_desc->lun_id];
2813 		if (lun == NULL) {
2814 			mtx_unlock(&softc->ctl_lock);
2815 			free(new_err_desc, M_CTL);
2816 			printf("%s: CTL_ERROR_INJECT: invalid LUN %ju\n",
2817 			       __func__, (uintmax_t)err_desc->lun_id);
2818 			retval = EINVAL;
2819 			break;
2820 		}
2821 		mtx_lock(&lun->lun_lock);
2822 		mtx_unlock(&softc->ctl_lock);
2823 
2824 		/*
2825 		 * We could do some checking here to verify the validity
2826 		 * of the request, but given the complexity of error
2827 		 * injection requests, the checking logic would be fairly
2828 		 * complex.
2829 		 *
2830 		 * For now, if the request is invalid, it just won't get
2831 		 * executed and might get deleted.
2832 		 */
2833 		STAILQ_INSERT_TAIL(&lun->error_list, new_err_desc, links);
2834 
2835 		/*
2836 		 * XXX KDM check to make sure the serial number is unique,
2837 		 * in case we somehow manage to wrap.  That shouldn't
2838 		 * happen for a very long time, but it's the right thing to
2839 		 * do.
2840 		 */
2841 		new_err_desc->serial = lun->error_serial;
2842 		err_desc->serial = lun->error_serial;
2843 		lun->error_serial++;
2844 
2845 		mtx_unlock(&lun->lun_lock);
2846 		break;
2847 	}
2848 	case CTL_ERROR_INJECT_DELETE: {
2849 		struct ctl_error_desc *delete_desc, *desc, *desc2;
2850 		int delete_done;
2851 
2852 		delete_desc = (struct ctl_error_desc *)addr;
2853 		delete_done = 0;
2854 
2855 		mtx_lock(&softc->ctl_lock);
2856 		lun = softc->ctl_luns[delete_desc->lun_id];
2857 		if (lun == NULL) {
2858 			mtx_unlock(&softc->ctl_lock);
2859 			printf("%s: CTL_ERROR_INJECT_DELETE: invalid LUN %ju\n",
2860 			       __func__, (uintmax_t)delete_desc->lun_id);
2861 			retval = EINVAL;
2862 			break;
2863 		}
2864 		mtx_lock(&lun->lun_lock);
2865 		mtx_unlock(&softc->ctl_lock);
2866 		STAILQ_FOREACH_SAFE(desc, &lun->error_list, links, desc2) {
2867 			if (desc->serial != delete_desc->serial)
2868 				continue;
2869 
2870 			STAILQ_REMOVE(&lun->error_list, desc, ctl_error_desc,
2871 				      links);
2872 			free(desc, M_CTL);
2873 			delete_done = 1;
2874 		}
2875 		mtx_unlock(&lun->lun_lock);
2876 		if (delete_done == 0) {
2877 			printf("%s: CTL_ERROR_INJECT_DELETE: can't find "
2878 			       "error serial %ju on LUN %u\n", __func__,
2879 			       delete_desc->serial, delete_desc->lun_id);
2880 			retval = EINVAL;
2881 			break;
2882 		}
2883 		break;
2884 	}
2885 	case CTL_DUMP_STRUCTS: {
2886 		int i, j, k;
2887 		struct ctl_port *port;
2888 		struct ctl_frontend *fe;
2889 
2890 		mtx_lock(&softc->ctl_lock);
2891 		printf("CTL Persistent Reservation information start:\n");
2892 		for (i = 0; i < CTL_MAX_LUNS; i++) {
2893 			lun = softc->ctl_luns[i];
2894 
2895 			if ((lun == NULL)
2896 			 || ((lun->flags & CTL_LUN_DISABLED) != 0))
2897 				continue;
2898 
2899 			for (j = 0; j < CTL_MAX_PORTS; j++) {
2900 				if (lun->pr_keys[j] == NULL)
2901 					continue;
2902 				for (k = 0; k < CTL_MAX_INIT_PER_PORT; k++){
2903 					if (lun->pr_keys[j][k] == 0)
2904 						continue;
2905 					printf("  LUN %d port %d iid %d key "
2906 					       "%#jx\n", i, j, k,
2907 					       (uintmax_t)lun->pr_keys[j][k]);
2908 				}
2909 			}
2910 		}
2911 		printf("CTL Persistent Reservation information end\n");
2912 		printf("CTL Ports:\n");
2913 		STAILQ_FOREACH(port, &softc->port_list, links) {
2914 			printf("  Port %d '%s' Frontend '%s' Type %u pp %d vp %d WWNN "
2915 			       "%#jx WWPN %#jx\n", port->targ_port, port->port_name,
2916 			       port->frontend->name, port->port_type,
2917 			       port->physical_port, port->virtual_port,
2918 			       (uintmax_t)port->wwnn, (uintmax_t)port->wwpn);
2919 			for (j = 0; j < CTL_MAX_INIT_PER_PORT; j++) {
2920 				if (port->wwpn_iid[j].in_use == 0 &&
2921 				    port->wwpn_iid[j].wwpn == 0 &&
2922 				    port->wwpn_iid[j].name == NULL)
2923 					continue;
2924 
2925 				printf("    iid %u use %d WWPN %#jx '%s'\n",
2926 				    j, port->wwpn_iid[j].in_use,
2927 				    (uintmax_t)port->wwpn_iid[j].wwpn,
2928 				    port->wwpn_iid[j].name);
2929 			}
2930 		}
2931 		printf("CTL Port information end\n");
2932 		mtx_unlock(&softc->ctl_lock);
2933 		/*
2934 		 * XXX KDM calling this without a lock.  We'd likely want
2935 		 * to drop the lock before calling the frontend's dump
2936 		 * routine anyway.
2937 		 */
2938 		printf("CTL Frontends:\n");
2939 		STAILQ_FOREACH(fe, &softc->fe_list, links) {
2940 			printf("  Frontend '%s'\n", fe->name);
2941 			if (fe->fe_dump != NULL)
2942 				fe->fe_dump();
2943 		}
2944 		printf("CTL Frontend information end\n");
2945 		break;
2946 	}
2947 	case CTL_LUN_REQ: {
2948 		struct ctl_lun_req *lun_req;
2949 		struct ctl_backend_driver *backend;
2950 
2951 		lun_req = (struct ctl_lun_req *)addr;
2952 
2953 		backend = ctl_backend_find(lun_req->backend);
2954 		if (backend == NULL) {
2955 			lun_req->status = CTL_LUN_ERROR;
2956 			snprintf(lun_req->error_str,
2957 				 sizeof(lun_req->error_str),
2958 				 "Backend \"%s\" not found.",
2959 				 lun_req->backend);
2960 			break;
2961 		}
2962 		if (lun_req->num_be_args > 0) {
2963 			lun_req->kern_be_args = ctl_copyin_args(
2964 				lun_req->num_be_args,
2965 				lun_req->be_args,
2966 				lun_req->error_str,
2967 				sizeof(lun_req->error_str));
2968 			if (lun_req->kern_be_args == NULL) {
2969 				lun_req->status = CTL_LUN_ERROR;
2970 				break;
2971 			}
2972 		}
2973 
2974 		retval = backend->ioctl(dev, cmd, addr, flag, td);
2975 
2976 		if (lun_req->num_be_args > 0) {
2977 			ctl_copyout_args(lun_req->num_be_args,
2978 				      lun_req->kern_be_args);
2979 			ctl_free_args(lun_req->num_be_args,
2980 				      lun_req->kern_be_args);
2981 		}
2982 		break;
2983 	}
2984 	case CTL_LUN_LIST: {
2985 		struct sbuf *sb;
2986 		struct ctl_lun_list *list;
2987 		struct ctl_option *opt;
2988 
2989 		list = (struct ctl_lun_list *)addr;
2990 
2991 		/*
2992 		 * Allocate a fixed length sbuf here, based on the length
2993 		 * of the user's buffer.  We could allocate an auto-extending
2994 		 * buffer, and then tell the user how much larger our
2995 		 * amount of data is than his buffer, but that presents
2996 		 * some problems:
2997 		 *
2998 		 * 1.  The sbuf(9) routines use a blocking malloc, and so
2999 		 *     we can't hold a lock while calling them with an
3000 		 *     auto-extending buffer.
3001  		 *
3002 		 * 2.  There is not currently a LUN reference counting
3003 		 *     mechanism, outside of outstanding transactions on
3004 		 *     the LUN's OOA queue.  So a LUN could go away on us
3005 		 *     while we're getting the LUN number, backend-specific
3006 		 *     information, etc.  Thus, given the way things
3007 		 *     currently work, we need to hold the CTL lock while
3008 		 *     grabbing LUN information.
3009 		 *
3010 		 * So, from the user's standpoint, the best thing to do is
3011 		 * allocate what he thinks is a reasonable buffer length,
3012 		 * and then if he gets a CTL_LUN_LIST_NEED_MORE_SPACE error,
3013 		 * double the buffer length and try again.  (And repeat
3014 		 * that until he succeeds.)
3015 		 */
3016 		sb = sbuf_new(NULL, NULL, list->alloc_len, SBUF_FIXEDLEN);
3017 		if (sb == NULL) {
3018 			list->status = CTL_LUN_LIST_ERROR;
3019 			snprintf(list->error_str, sizeof(list->error_str),
3020 				 "Unable to allocate %d bytes for LUN list",
3021 				 list->alloc_len);
3022 			break;
3023 		}
3024 
3025 		sbuf_printf(sb, "<ctllunlist>\n");
3026 
3027 		mtx_lock(&softc->ctl_lock);
3028 		STAILQ_FOREACH(lun, &softc->lun_list, links) {
3029 			mtx_lock(&lun->lun_lock);
3030 			retval = sbuf_printf(sb, "<lun id=\"%ju\">\n",
3031 					     (uintmax_t)lun->lun);
3032 
3033 			/*
3034 			 * Bail out as soon as we see that we've overfilled
3035 			 * the buffer.
3036 			 */
3037 			if (retval != 0)
3038 				break;
3039 
3040 			retval = sbuf_printf(sb, "\t<backend_type>%s"
3041 					     "</backend_type>\n",
3042 					     (lun->backend == NULL) ?  "none" :
3043 					     lun->backend->name);
3044 
3045 			if (retval != 0)
3046 				break;
3047 
3048 			retval = sbuf_printf(sb, "\t<lun_type>%d</lun_type>\n",
3049 					     lun->be_lun->lun_type);
3050 
3051 			if (retval != 0)
3052 				break;
3053 
3054 			if (lun->backend == NULL) {
3055 				retval = sbuf_printf(sb, "</lun>\n");
3056 				if (retval != 0)
3057 					break;
3058 				continue;
3059 			}
3060 
3061 			retval = sbuf_printf(sb, "\t<size>%ju</size>\n",
3062 					     (lun->be_lun->maxlba > 0) ?
3063 					     lun->be_lun->maxlba + 1 : 0);
3064 
3065 			if (retval != 0)
3066 				break;
3067 
3068 			retval = sbuf_printf(sb, "\t<blocksize>%u</blocksize>\n",
3069 					     lun->be_lun->blocksize);
3070 
3071 			if (retval != 0)
3072 				break;
3073 
3074 			retval = sbuf_printf(sb, "\t<serial_number>");
3075 
3076 			if (retval != 0)
3077 				break;
3078 
3079 			retval = ctl_sbuf_printf_esc(sb,
3080 			    lun->be_lun->serial_num,
3081 			    sizeof(lun->be_lun->serial_num));
3082 
3083 			if (retval != 0)
3084 				break;
3085 
3086 			retval = sbuf_printf(sb, "</serial_number>\n");
3087 
3088 			if (retval != 0)
3089 				break;
3090 
3091 			retval = sbuf_printf(sb, "\t<device_id>");
3092 
3093 			if (retval != 0)
3094 				break;
3095 
3096 			retval = ctl_sbuf_printf_esc(sb,
3097 			    lun->be_lun->device_id,
3098 			    sizeof(lun->be_lun->device_id));
3099 
3100 			if (retval != 0)
3101 				break;
3102 
3103 			retval = sbuf_printf(sb, "</device_id>\n");
3104 
3105 			if (retval != 0)
3106 				break;
3107 
3108 			if (lun->backend->lun_info != NULL) {
3109 				retval = lun->backend->lun_info(lun->be_lun->be_lun, sb);
3110 				if (retval != 0)
3111 					break;
3112 			}
3113 			STAILQ_FOREACH(opt, &lun->be_lun->options, links) {
3114 				retval = sbuf_printf(sb, "\t<%s>%s</%s>\n",
3115 				    opt->name, opt->value, opt->name);
3116 				if (retval != 0)
3117 					break;
3118 			}
3119 
3120 			retval = sbuf_printf(sb, "</lun>\n");
3121 
3122 			if (retval != 0)
3123 				break;
3124 			mtx_unlock(&lun->lun_lock);
3125 		}
3126 		if (lun != NULL)
3127 			mtx_unlock(&lun->lun_lock);
3128 		mtx_unlock(&softc->ctl_lock);
3129 
3130 		if ((retval != 0)
3131 		 || ((retval = sbuf_printf(sb, "</ctllunlist>\n")) != 0)) {
3132 			retval = 0;
3133 			sbuf_delete(sb);
3134 			list->status = CTL_LUN_LIST_NEED_MORE_SPACE;
3135 			snprintf(list->error_str, sizeof(list->error_str),
3136 				 "Out of space, %d bytes is too small",
3137 				 list->alloc_len);
3138 			break;
3139 		}
3140 
3141 		sbuf_finish(sb);
3142 
3143 		retval = copyout(sbuf_data(sb), list->lun_xml,
3144 				 sbuf_len(sb) + 1);
3145 
3146 		list->fill_len = sbuf_len(sb) + 1;
3147 		list->status = CTL_LUN_LIST_OK;
3148 		sbuf_delete(sb);
3149 		break;
3150 	}
3151 	case CTL_ISCSI: {
3152 		struct ctl_iscsi *ci;
3153 		struct ctl_frontend *fe;
3154 
3155 		ci = (struct ctl_iscsi *)addr;
3156 
3157 		fe = ctl_frontend_find("iscsi");
3158 		if (fe == NULL) {
3159 			ci->status = CTL_ISCSI_ERROR;
3160 			snprintf(ci->error_str, sizeof(ci->error_str),
3161 			    "Frontend \"iscsi\" not found.");
3162 			break;
3163 		}
3164 
3165 		retval = fe->ioctl(dev, cmd, addr, flag, td);
3166 		break;
3167 	}
3168 	case CTL_PORT_REQ: {
3169 		struct ctl_req *req;
3170 		struct ctl_frontend *fe;
3171 
3172 		req = (struct ctl_req *)addr;
3173 
3174 		fe = ctl_frontend_find(req->driver);
3175 		if (fe == NULL) {
3176 			req->status = CTL_LUN_ERROR;
3177 			snprintf(req->error_str, sizeof(req->error_str),
3178 			    "Frontend \"%s\" not found.", req->driver);
3179 			break;
3180 		}
3181 		if (req->num_args > 0) {
3182 			req->kern_args = ctl_copyin_args(req->num_args,
3183 			    req->args, req->error_str, sizeof(req->error_str));
3184 			if (req->kern_args == NULL) {
3185 				req->status = CTL_LUN_ERROR;
3186 				break;
3187 			}
3188 		}
3189 
3190 		if (fe->ioctl)
3191 			retval = fe->ioctl(dev, cmd, addr, flag, td);
3192 		else
3193 			retval = ENODEV;
3194 
3195 		if (req->num_args > 0) {
3196 			ctl_copyout_args(req->num_args, req->kern_args);
3197 			ctl_free_args(req->num_args, req->kern_args);
3198 		}
3199 		break;
3200 	}
3201 	case CTL_PORT_LIST: {
3202 		struct sbuf *sb;
3203 		struct ctl_port *port;
3204 		struct ctl_lun_list *list;
3205 		struct ctl_option *opt;
3206 		int j;
3207 		uint32_t plun;
3208 
3209 		list = (struct ctl_lun_list *)addr;
3210 
3211 		sb = sbuf_new(NULL, NULL, list->alloc_len, SBUF_FIXEDLEN);
3212 		if (sb == NULL) {
3213 			list->status = CTL_LUN_LIST_ERROR;
3214 			snprintf(list->error_str, sizeof(list->error_str),
3215 				 "Unable to allocate %d bytes for LUN list",
3216 				 list->alloc_len);
3217 			break;
3218 		}
3219 
3220 		sbuf_printf(sb, "<ctlportlist>\n");
3221 
3222 		mtx_lock(&softc->ctl_lock);
3223 		STAILQ_FOREACH(port, &softc->port_list, links) {
3224 			retval = sbuf_printf(sb, "<targ_port id=\"%ju\">\n",
3225 					     (uintmax_t)port->targ_port);
3226 
3227 			/*
3228 			 * Bail out as soon as we see that we've overfilled
3229 			 * the buffer.
3230 			 */
3231 			if (retval != 0)
3232 				break;
3233 
3234 			retval = sbuf_printf(sb, "\t<frontend_type>%s"
3235 			    "</frontend_type>\n", port->frontend->name);
3236 			if (retval != 0)
3237 				break;
3238 
3239 			retval = sbuf_printf(sb, "\t<port_type>%d</port_type>\n",
3240 					     port->port_type);
3241 			if (retval != 0)
3242 				break;
3243 
3244 			retval = sbuf_printf(sb, "\t<online>%s</online>\n",
3245 			    (port->status & CTL_PORT_STATUS_ONLINE) ? "YES" : "NO");
3246 			if (retval != 0)
3247 				break;
3248 
3249 			retval = sbuf_printf(sb, "\t<port_name>%s</port_name>\n",
3250 			    port->port_name);
3251 			if (retval != 0)
3252 				break;
3253 
3254 			retval = sbuf_printf(sb, "\t<physical_port>%d</physical_port>\n",
3255 			    port->physical_port);
3256 			if (retval != 0)
3257 				break;
3258 
3259 			retval = sbuf_printf(sb, "\t<virtual_port>%d</virtual_port>\n",
3260 			    port->virtual_port);
3261 			if (retval != 0)
3262 				break;
3263 
3264 			if (port->target_devid != NULL) {
3265 				sbuf_printf(sb, "\t<target>");
3266 				ctl_id_sbuf(port->target_devid, sb);
3267 				sbuf_printf(sb, "</target>\n");
3268 			}
3269 
3270 			if (port->port_devid != NULL) {
3271 				sbuf_printf(sb, "\t<port>");
3272 				ctl_id_sbuf(port->port_devid, sb);
3273 				sbuf_printf(sb, "</port>\n");
3274 			}
3275 
3276 			if (port->port_info != NULL) {
3277 				retval = port->port_info(port->onoff_arg, sb);
3278 				if (retval != 0)
3279 					break;
3280 			}
3281 			STAILQ_FOREACH(opt, &port->options, links) {
3282 				retval = sbuf_printf(sb, "\t<%s>%s</%s>\n",
3283 				    opt->name, opt->value, opt->name);
3284 				if (retval != 0)
3285 					break;
3286 			}
3287 
3288 			if (port->lun_map != NULL) {
3289 				sbuf_printf(sb, "\t<lun_map>on</lun_map>\n");
3290 				for (j = 0; j < CTL_MAX_LUNS; j++) {
3291 					plun = ctl_lun_map_from_port(port, j);
3292 					if (plun >= CTL_MAX_LUNS)
3293 						continue;
3294 					sbuf_printf(sb,
3295 					    "\t<lun id=\"%u\">%u</lun>\n",
3296 					    j, plun);
3297 				}
3298 			}
3299 
3300 			for (j = 0; j < CTL_MAX_INIT_PER_PORT; j++) {
3301 				if (port->wwpn_iid[j].in_use == 0 ||
3302 				    (port->wwpn_iid[j].wwpn == 0 &&
3303 				     port->wwpn_iid[j].name == NULL))
3304 					continue;
3305 
3306 				if (port->wwpn_iid[j].name != NULL)
3307 					retval = sbuf_printf(sb,
3308 					    "\t<initiator id=\"%u\">%s</initiator>\n",
3309 					    j, port->wwpn_iid[j].name);
3310 				else
3311 					retval = sbuf_printf(sb,
3312 					    "\t<initiator id=\"%u\">naa.%08jx</initiator>\n",
3313 					    j, port->wwpn_iid[j].wwpn);
3314 				if (retval != 0)
3315 					break;
3316 			}
3317 			if (retval != 0)
3318 				break;
3319 
3320 			retval = sbuf_printf(sb, "</targ_port>\n");
3321 			if (retval != 0)
3322 				break;
3323 		}
3324 		mtx_unlock(&softc->ctl_lock);
3325 
3326 		if ((retval != 0)
3327 		 || ((retval = sbuf_printf(sb, "</ctlportlist>\n")) != 0)) {
3328 			retval = 0;
3329 			sbuf_delete(sb);
3330 			list->status = CTL_LUN_LIST_NEED_MORE_SPACE;
3331 			snprintf(list->error_str, sizeof(list->error_str),
3332 				 "Out of space, %d bytes is too small",
3333 				 list->alloc_len);
3334 			break;
3335 		}
3336 
3337 		sbuf_finish(sb);
3338 
3339 		retval = copyout(sbuf_data(sb), list->lun_xml,
3340 				 sbuf_len(sb) + 1);
3341 
3342 		list->fill_len = sbuf_len(sb) + 1;
3343 		list->status = CTL_LUN_LIST_OK;
3344 		sbuf_delete(sb);
3345 		break;
3346 	}
3347 	case CTL_LUN_MAP: {
3348 		struct ctl_lun_map *lm  = (struct ctl_lun_map *)addr;
3349 		struct ctl_port *port;
3350 
3351 		mtx_lock(&softc->ctl_lock);
3352 		if (lm->port < softc->port_min ||
3353 		    lm->port >= softc->port_max ||
3354 		    (port = softc->ctl_ports[lm->port]) == NULL) {
3355 			mtx_unlock(&softc->ctl_lock);
3356 			return (ENXIO);
3357 		}
3358 		if (port->status & CTL_PORT_STATUS_ONLINE) {
3359 			STAILQ_FOREACH(lun, &softc->lun_list, links) {
3360 				if (ctl_lun_map_to_port(port, lun->lun) >=
3361 				    CTL_MAX_LUNS)
3362 					continue;
3363 				mtx_lock(&lun->lun_lock);
3364 				ctl_est_ua_port(lun, lm->port, -1,
3365 				    CTL_UA_LUN_CHANGE);
3366 				mtx_unlock(&lun->lun_lock);
3367 			}
3368 		}
3369 		mtx_unlock(&softc->ctl_lock); // XXX: port_enable sleeps
3370 		if (lm->plun < CTL_MAX_LUNS) {
3371 			if (lm->lun == UINT32_MAX)
3372 				retval = ctl_lun_map_unset(port, lm->plun);
3373 			else if (lm->lun < CTL_MAX_LUNS &&
3374 			    softc->ctl_luns[lm->lun] != NULL)
3375 				retval = ctl_lun_map_set(port, lm->plun, lm->lun);
3376 			else
3377 				return (ENXIO);
3378 		} else if (lm->plun == UINT32_MAX) {
3379 			if (lm->lun == UINT32_MAX)
3380 				retval = ctl_lun_map_deinit(port);
3381 			else
3382 				retval = ctl_lun_map_init(port);
3383 		} else
3384 			return (ENXIO);
3385 		if (port->status & CTL_PORT_STATUS_ONLINE)
3386 			ctl_isc_announce_port(port);
3387 		break;
3388 	}
3389 	default: {
3390 		/* XXX KDM should we fix this? */
3391 #if 0
3392 		struct ctl_backend_driver *backend;
3393 		unsigned int type;
3394 		int found;
3395 
3396 		found = 0;
3397 
3398 		/*
3399 		 * We encode the backend type as the ioctl type for backend
3400 		 * ioctls.  So parse it out here, and then search for a
3401 		 * backend of this type.
3402 		 */
3403 		type = _IOC_TYPE(cmd);
3404 
3405 		STAILQ_FOREACH(backend, &softc->be_list, links) {
3406 			if (backend->type == type) {
3407 				found = 1;
3408 				break;
3409 			}
3410 		}
3411 		if (found == 0) {
3412 			printf("ctl: unknown ioctl command %#lx or backend "
3413 			       "%d\n", cmd, type);
3414 			retval = EINVAL;
3415 			break;
3416 		}
3417 		retval = backend->ioctl(dev, cmd, addr, flag, td);
3418 #endif
3419 		retval = ENOTTY;
3420 		break;
3421 	}
3422 	}
3423 	return (retval);
3424 }
3425 
3426 uint32_t
3427 ctl_get_initindex(struct ctl_nexus *nexus)
3428 {
3429 	return (nexus->initid + (nexus->targ_port * CTL_MAX_INIT_PER_PORT));
3430 }
3431 
3432 int
3433 ctl_lun_map_init(struct ctl_port *port)
3434 {
3435 	struct ctl_softc *softc = port->ctl_softc;
3436 	struct ctl_lun *lun;
3437 	uint32_t i;
3438 
3439 	if (port->lun_map == NULL)
3440 		port->lun_map = malloc(sizeof(uint32_t) * CTL_MAX_LUNS,
3441 		    M_CTL, M_NOWAIT);
3442 	if (port->lun_map == NULL)
3443 		return (ENOMEM);
3444 	for (i = 0; i < CTL_MAX_LUNS; i++)
3445 		port->lun_map[i] = UINT32_MAX;
3446 	if (port->status & CTL_PORT_STATUS_ONLINE) {
3447 		if (port->lun_disable != NULL) {
3448 			STAILQ_FOREACH(lun, &softc->lun_list, links)
3449 				port->lun_disable(port->targ_lun_arg, lun->lun);
3450 		}
3451 		ctl_isc_announce_port(port);
3452 	}
3453 	return (0);
3454 }
3455 
3456 int
3457 ctl_lun_map_deinit(struct ctl_port *port)
3458 {
3459 	struct ctl_softc *softc = port->ctl_softc;
3460 	struct ctl_lun *lun;
3461 
3462 	if (port->lun_map == NULL)
3463 		return (0);
3464 	free(port->lun_map, M_CTL);
3465 	port->lun_map = NULL;
3466 	if (port->status & CTL_PORT_STATUS_ONLINE) {
3467 		if (port->lun_enable != NULL) {
3468 			STAILQ_FOREACH(lun, &softc->lun_list, links)
3469 				port->lun_enable(port->targ_lun_arg, lun->lun);
3470 		}
3471 		ctl_isc_announce_port(port);
3472 	}
3473 	return (0);
3474 }
3475 
3476 int
3477 ctl_lun_map_set(struct ctl_port *port, uint32_t plun, uint32_t glun)
3478 {
3479 	int status;
3480 	uint32_t old;
3481 
3482 	if (port->lun_map == NULL) {
3483 		status = ctl_lun_map_init(port);
3484 		if (status != 0)
3485 			return (status);
3486 	}
3487 	old = port->lun_map[plun];
3488 	port->lun_map[plun] = glun;
3489 	if ((port->status & CTL_PORT_STATUS_ONLINE) && old >= CTL_MAX_LUNS) {
3490 		if (port->lun_enable != NULL)
3491 			port->lun_enable(port->targ_lun_arg, plun);
3492 		ctl_isc_announce_port(port);
3493 	}
3494 	return (0);
3495 }
3496 
3497 int
3498 ctl_lun_map_unset(struct ctl_port *port, uint32_t plun)
3499 {
3500 	uint32_t old;
3501 
3502 	if (port->lun_map == NULL)
3503 		return (0);
3504 	old = port->lun_map[plun];
3505 	port->lun_map[plun] = UINT32_MAX;
3506 	if ((port->status & CTL_PORT_STATUS_ONLINE) && old < CTL_MAX_LUNS) {
3507 		if (port->lun_disable != NULL)
3508 			port->lun_disable(port->targ_lun_arg, plun);
3509 		ctl_isc_announce_port(port);
3510 	}
3511 	return (0);
3512 }
3513 
3514 uint32_t
3515 ctl_lun_map_from_port(struct ctl_port *port, uint32_t lun_id)
3516 {
3517 
3518 	if (port == NULL)
3519 		return (UINT32_MAX);
3520 	if (port->lun_map == NULL || lun_id >= CTL_MAX_LUNS)
3521 		return (lun_id);
3522 	return (port->lun_map[lun_id]);
3523 }
3524 
3525 uint32_t
3526 ctl_lun_map_to_port(struct ctl_port *port, uint32_t lun_id)
3527 {
3528 	uint32_t i;
3529 
3530 	if (port == NULL)
3531 		return (UINT32_MAX);
3532 	if (port->lun_map == NULL)
3533 		return (lun_id);
3534 	for (i = 0; i < CTL_MAX_LUNS; i++) {
3535 		if (port->lun_map[i] == lun_id)
3536 			return (i);
3537 	}
3538 	return (UINT32_MAX);
3539 }
3540 
3541 uint32_t
3542 ctl_decode_lun(uint64_t encoded)
3543 {
3544 	uint8_t lun[8];
3545 	uint32_t result = 0xffffffff;
3546 
3547 	be64enc(lun, encoded);
3548 	switch (lun[0] & RPL_LUNDATA_ATYP_MASK) {
3549 	case RPL_LUNDATA_ATYP_PERIPH:
3550 		if ((lun[0] & 0x3f) == 0 && lun[2] == 0 && lun[3] == 0 &&
3551 		    lun[4] == 0 && lun[5] == 0 && lun[6] == 0 && lun[7] == 0)
3552 			result = lun[1];
3553 		break;
3554 	case RPL_LUNDATA_ATYP_FLAT:
3555 		if (lun[2] == 0 && lun[3] == 0 && lun[4] == 0 && lun[5] == 0 &&
3556 		    lun[6] == 0 && lun[7] == 0)
3557 			result = ((lun[0] & 0x3f) << 8) + lun[1];
3558 		break;
3559 	case RPL_LUNDATA_ATYP_EXTLUN:
3560 		switch (lun[0] & RPL_LUNDATA_EXT_EAM_MASK) {
3561 		case 0x02:
3562 			switch (lun[0] & RPL_LUNDATA_EXT_LEN_MASK) {
3563 			case 0x00:
3564 				result = lun[1];
3565 				break;
3566 			case 0x10:
3567 				result = (lun[1] << 16) + (lun[2] << 8) +
3568 				    lun[3];
3569 				break;
3570 			case 0x20:
3571 				if (lun[1] == 0 && lun[6] == 0 && lun[7] == 0)
3572 					result = (lun[2] << 24) +
3573 					    (lun[3] << 16) + (lun[4] << 8) +
3574 					    lun[5];
3575 				break;
3576 			}
3577 			break;
3578 		case RPL_LUNDATA_EXT_EAM_NOT_SPEC:
3579 			result = 0xffffffff;
3580 			break;
3581 		}
3582 		break;
3583 	}
3584 	return (result);
3585 }
3586 
3587 uint64_t
3588 ctl_encode_lun(uint32_t decoded)
3589 {
3590 	uint64_t l = decoded;
3591 
3592 	if (l <= 0xff)
3593 		return (((uint64_t)RPL_LUNDATA_ATYP_PERIPH << 56) | (l << 48));
3594 	if (l <= 0x3fff)
3595 		return (((uint64_t)RPL_LUNDATA_ATYP_FLAT << 56) | (l << 48));
3596 	if (l <= 0xffffff)
3597 		return (((uint64_t)(RPL_LUNDATA_ATYP_EXTLUN | 0x12) << 56) |
3598 		    (l << 32));
3599 	return ((((uint64_t)RPL_LUNDATA_ATYP_EXTLUN | 0x22) << 56) | (l << 16));
3600 }
3601 
3602 static struct ctl_port *
3603 ctl_io_port(struct ctl_io_hdr *io_hdr)
3604 {
3605 
3606 	return (control_softc->ctl_ports[io_hdr->nexus.targ_port]);
3607 }
3608 
3609 int
3610 ctl_ffz(uint32_t *mask, uint32_t first, uint32_t last)
3611 {
3612 	int i;
3613 
3614 	for (i = first; i < last; i++) {
3615 		if ((mask[i / 32] & (1 << (i % 32))) == 0)
3616 			return (i);
3617 	}
3618 	return (-1);
3619 }
3620 
3621 int
3622 ctl_set_mask(uint32_t *mask, uint32_t bit)
3623 {
3624 	uint32_t chunk, piece;
3625 
3626 	chunk = bit >> 5;
3627 	piece = bit % (sizeof(uint32_t) * 8);
3628 
3629 	if ((mask[chunk] & (1 << piece)) != 0)
3630 		return (-1);
3631 	else
3632 		mask[chunk] |= (1 << piece);
3633 
3634 	return (0);
3635 }
3636 
3637 int
3638 ctl_clear_mask(uint32_t *mask, uint32_t bit)
3639 {
3640 	uint32_t chunk, piece;
3641 
3642 	chunk = bit >> 5;
3643 	piece = bit % (sizeof(uint32_t) * 8);
3644 
3645 	if ((mask[chunk] & (1 << piece)) == 0)
3646 		return (-1);
3647 	else
3648 		mask[chunk] &= ~(1 << piece);
3649 
3650 	return (0);
3651 }
3652 
3653 int
3654 ctl_is_set(uint32_t *mask, uint32_t bit)
3655 {
3656 	uint32_t chunk, piece;
3657 
3658 	chunk = bit >> 5;
3659 	piece = bit % (sizeof(uint32_t) * 8);
3660 
3661 	if ((mask[chunk] & (1 << piece)) == 0)
3662 		return (0);
3663 	else
3664 		return (1);
3665 }
3666 
3667 static uint64_t
3668 ctl_get_prkey(struct ctl_lun *lun, uint32_t residx)
3669 {
3670 	uint64_t *t;
3671 
3672 	t = lun->pr_keys[residx/CTL_MAX_INIT_PER_PORT];
3673 	if (t == NULL)
3674 		return (0);
3675 	return (t[residx % CTL_MAX_INIT_PER_PORT]);
3676 }
3677 
3678 static void
3679 ctl_clr_prkey(struct ctl_lun *lun, uint32_t residx)
3680 {
3681 	uint64_t *t;
3682 
3683 	t = lun->pr_keys[residx/CTL_MAX_INIT_PER_PORT];
3684 	if (t == NULL)
3685 		return;
3686 	t[residx % CTL_MAX_INIT_PER_PORT] = 0;
3687 }
3688 
3689 static void
3690 ctl_alloc_prkey(struct ctl_lun *lun, uint32_t residx)
3691 {
3692 	uint64_t *p;
3693 	u_int i;
3694 
3695 	i = residx/CTL_MAX_INIT_PER_PORT;
3696 	if (lun->pr_keys[i] != NULL)
3697 		return;
3698 	mtx_unlock(&lun->lun_lock);
3699 	p = malloc(sizeof(uint64_t) * CTL_MAX_INIT_PER_PORT, M_CTL,
3700 	    M_WAITOK | M_ZERO);
3701 	mtx_lock(&lun->lun_lock);
3702 	if (lun->pr_keys[i] == NULL)
3703 		lun->pr_keys[i] = p;
3704 	else
3705 		free(p, M_CTL);
3706 }
3707 
3708 static void
3709 ctl_set_prkey(struct ctl_lun *lun, uint32_t residx, uint64_t key)
3710 {
3711 	uint64_t *t;
3712 
3713 	t = lun->pr_keys[residx/CTL_MAX_INIT_PER_PORT];
3714 	KASSERT(t != NULL, ("prkey %d is not allocated", residx));
3715 	t[residx % CTL_MAX_INIT_PER_PORT] = key;
3716 }
3717 
3718 /*
3719  * ctl_softc, pool_name, total_ctl_io are passed in.
3720  * npool is passed out.
3721  */
3722 int
3723 ctl_pool_create(struct ctl_softc *ctl_softc, const char *pool_name,
3724 		uint32_t total_ctl_io, void **npool)
3725 {
3726 #ifdef IO_POOLS
3727 	struct ctl_io_pool *pool;
3728 
3729 	pool = (struct ctl_io_pool *)malloc(sizeof(*pool), M_CTL,
3730 					    M_NOWAIT | M_ZERO);
3731 	if (pool == NULL)
3732 		return (ENOMEM);
3733 
3734 	snprintf(pool->name, sizeof(pool->name), "CTL IO %s", pool_name);
3735 	pool->ctl_softc = ctl_softc;
3736 	pool->zone = uma_zsecond_create(pool->name, NULL,
3737 	    NULL, NULL, NULL, ctl_softc->io_zone);
3738 	/* uma_prealloc(pool->zone, total_ctl_io); */
3739 
3740 	*npool = pool;
3741 #else
3742 	*npool = ctl_softc->io_zone;
3743 #endif
3744 	return (0);
3745 }
3746 
3747 void
3748 ctl_pool_free(struct ctl_io_pool *pool)
3749 {
3750 
3751 	if (pool == NULL)
3752 		return;
3753 
3754 #ifdef IO_POOLS
3755 	uma_zdestroy(pool->zone);
3756 	free(pool, M_CTL);
3757 #endif
3758 }
3759 
3760 union ctl_io *
3761 ctl_alloc_io(void *pool_ref)
3762 {
3763 	union ctl_io *io;
3764 #ifdef IO_POOLS
3765 	struct ctl_io_pool *pool = (struct ctl_io_pool *)pool_ref;
3766 
3767 	io = uma_zalloc(pool->zone, M_WAITOK);
3768 #else
3769 	io = uma_zalloc((uma_zone_t)pool_ref, M_WAITOK);
3770 #endif
3771 	if (io != NULL)
3772 		io->io_hdr.pool = pool_ref;
3773 	return (io);
3774 }
3775 
3776 union ctl_io *
3777 ctl_alloc_io_nowait(void *pool_ref)
3778 {
3779 	union ctl_io *io;
3780 #ifdef IO_POOLS
3781 	struct ctl_io_pool *pool = (struct ctl_io_pool *)pool_ref;
3782 
3783 	io = uma_zalloc(pool->zone, M_NOWAIT);
3784 #else
3785 	io = uma_zalloc((uma_zone_t)pool_ref, M_NOWAIT);
3786 #endif
3787 	if (io != NULL)
3788 		io->io_hdr.pool = pool_ref;
3789 	return (io);
3790 }
3791 
3792 void
3793 ctl_free_io(union ctl_io *io)
3794 {
3795 #ifdef IO_POOLS
3796 	struct ctl_io_pool *pool;
3797 #endif
3798 
3799 	if (io == NULL)
3800 		return;
3801 
3802 #ifdef IO_POOLS
3803 	pool = (struct ctl_io_pool *)io->io_hdr.pool;
3804 	uma_zfree(pool->zone, io);
3805 #else
3806 	uma_zfree((uma_zone_t)io->io_hdr.pool, io);
3807 #endif
3808 }
3809 
3810 void
3811 ctl_zero_io(union ctl_io *io)
3812 {
3813 	void *pool_ref;
3814 
3815 	if (io == NULL)
3816 		return;
3817 
3818 	/*
3819 	 * May need to preserve linked list pointers at some point too.
3820 	 */
3821 	pool_ref = io->io_hdr.pool;
3822 	memset(io, 0, sizeof(*io));
3823 	io->io_hdr.pool = pool_ref;
3824 }
3825 
3826 int
3827 ctl_expand_number(const char *buf, uint64_t *num)
3828 {
3829 	char *endptr;
3830 	uint64_t number;
3831 	unsigned shift;
3832 
3833 	number = strtoq(buf, &endptr, 0);
3834 
3835 	switch (tolower((unsigned char)*endptr)) {
3836 	case 'e':
3837 		shift = 60;
3838 		break;
3839 	case 'p':
3840 		shift = 50;
3841 		break;
3842 	case 't':
3843 		shift = 40;
3844 		break;
3845 	case 'g':
3846 		shift = 30;
3847 		break;
3848 	case 'm':
3849 		shift = 20;
3850 		break;
3851 	case 'k':
3852 		shift = 10;
3853 		break;
3854 	case 'b':
3855 	case '\0': /* No unit. */
3856 		*num = number;
3857 		return (0);
3858 	default:
3859 		/* Unrecognized unit. */
3860 		return (-1);
3861 	}
3862 
3863 	if ((number << shift) >> shift != number) {
3864 		/* Overflow */
3865 		return (-1);
3866 	}
3867 	*num = number << shift;
3868 	return (0);
3869 }
3870 
3871 
3872 /*
3873  * This routine could be used in the future to load default and/or saved
3874  * mode page parameters for a particuar lun.
3875  */
3876 static int
3877 ctl_init_page_index(struct ctl_lun *lun)
3878 {
3879 	int i, page_code;
3880 	struct ctl_page_index *page_index;
3881 	const char *value;
3882 	uint64_t ival;
3883 
3884 	memcpy(&lun->mode_pages.index, page_index_template,
3885 	       sizeof(page_index_template));
3886 
3887 	for (i = 0; i < CTL_NUM_MODE_PAGES; i++) {
3888 
3889 		page_index = &lun->mode_pages.index[i];
3890 		if (lun->be_lun->lun_type == T_DIRECT &&
3891 		    (page_index->page_flags & CTL_PAGE_FLAG_DIRECT) == 0)
3892 			continue;
3893 		if (lun->be_lun->lun_type == T_PROCESSOR &&
3894 		    (page_index->page_flags & CTL_PAGE_FLAG_PROC) == 0)
3895 			continue;
3896 		if (lun->be_lun->lun_type == T_CDROM &&
3897 		    (page_index->page_flags & CTL_PAGE_FLAG_CDROM) == 0)
3898 			continue;
3899 
3900 		page_code = page_index->page_code & SMPH_PC_MASK;
3901 		switch (page_code) {
3902 		case SMS_RW_ERROR_RECOVERY_PAGE: {
3903 			KASSERT(page_index->subpage == SMS_SUBPAGE_PAGE_0,
3904 			    ("subpage %#x for page %#x is incorrect!",
3905 			    page_index->subpage, page_code));
3906 			memcpy(&lun->mode_pages.rw_er_page[CTL_PAGE_CURRENT],
3907 			       &rw_er_page_default,
3908 			       sizeof(rw_er_page_default));
3909 			memcpy(&lun->mode_pages.rw_er_page[CTL_PAGE_CHANGEABLE],
3910 			       &rw_er_page_changeable,
3911 			       sizeof(rw_er_page_changeable));
3912 			memcpy(&lun->mode_pages.rw_er_page[CTL_PAGE_DEFAULT],
3913 			       &rw_er_page_default,
3914 			       sizeof(rw_er_page_default));
3915 			memcpy(&lun->mode_pages.rw_er_page[CTL_PAGE_SAVED],
3916 			       &rw_er_page_default,
3917 			       sizeof(rw_er_page_default));
3918 			page_index->page_data =
3919 				(uint8_t *)lun->mode_pages.rw_er_page;
3920 			break;
3921 		}
3922 		case SMS_FORMAT_DEVICE_PAGE: {
3923 			struct scsi_format_page *format_page;
3924 
3925 			KASSERT(page_index->subpage == SMS_SUBPAGE_PAGE_0,
3926 			    ("subpage %#x for page %#x is incorrect!",
3927 			    page_index->subpage, page_code));
3928 
3929 			/*
3930 			 * Sectors per track are set above.  Bytes per
3931 			 * sector need to be set here on a per-LUN basis.
3932 			 */
3933 			memcpy(&lun->mode_pages.format_page[CTL_PAGE_CURRENT],
3934 			       &format_page_default,
3935 			       sizeof(format_page_default));
3936 			memcpy(&lun->mode_pages.format_page[
3937 			       CTL_PAGE_CHANGEABLE], &format_page_changeable,
3938 			       sizeof(format_page_changeable));
3939 			memcpy(&lun->mode_pages.format_page[CTL_PAGE_DEFAULT],
3940 			       &format_page_default,
3941 			       sizeof(format_page_default));
3942 			memcpy(&lun->mode_pages.format_page[CTL_PAGE_SAVED],
3943 			       &format_page_default,
3944 			       sizeof(format_page_default));
3945 
3946 			format_page = &lun->mode_pages.format_page[
3947 				CTL_PAGE_CURRENT];
3948 			scsi_ulto2b(lun->be_lun->blocksize,
3949 				    format_page->bytes_per_sector);
3950 
3951 			format_page = &lun->mode_pages.format_page[
3952 				CTL_PAGE_DEFAULT];
3953 			scsi_ulto2b(lun->be_lun->blocksize,
3954 				    format_page->bytes_per_sector);
3955 
3956 			format_page = &lun->mode_pages.format_page[
3957 				CTL_PAGE_SAVED];
3958 			scsi_ulto2b(lun->be_lun->blocksize,
3959 				    format_page->bytes_per_sector);
3960 
3961 			page_index->page_data =
3962 				(uint8_t *)lun->mode_pages.format_page;
3963 			break;
3964 		}
3965 		case SMS_RIGID_DISK_PAGE: {
3966 			struct scsi_rigid_disk_page *rigid_disk_page;
3967 			uint32_t sectors_per_cylinder;
3968 			uint64_t cylinders;
3969 #ifndef	__XSCALE__
3970 			int shift;
3971 #endif /* !__XSCALE__ */
3972 
3973 			KASSERT(page_index->subpage == SMS_SUBPAGE_PAGE_0,
3974 			    ("subpage %#x for page %#x is incorrect!",
3975 			    page_index->subpage, page_code));
3976 
3977 			/*
3978 			 * Rotation rate and sectors per track are set
3979 			 * above.  We calculate the cylinders here based on
3980 			 * capacity.  Due to the number of heads and
3981 			 * sectors per track we're using, smaller arrays
3982 			 * may turn out to have 0 cylinders.  Linux and
3983 			 * FreeBSD don't pay attention to these mode pages
3984 			 * to figure out capacity, but Solaris does.  It
3985 			 * seems to deal with 0 cylinders just fine, and
3986 			 * works out a fake geometry based on the capacity.
3987 			 */
3988 			memcpy(&lun->mode_pages.rigid_disk_page[
3989 			       CTL_PAGE_DEFAULT], &rigid_disk_page_default,
3990 			       sizeof(rigid_disk_page_default));
3991 			memcpy(&lun->mode_pages.rigid_disk_page[
3992 			       CTL_PAGE_CHANGEABLE],&rigid_disk_page_changeable,
3993 			       sizeof(rigid_disk_page_changeable));
3994 
3995 			sectors_per_cylinder = CTL_DEFAULT_SECTORS_PER_TRACK *
3996 				CTL_DEFAULT_HEADS;
3997 
3998 			/*
3999 			 * The divide method here will be more accurate,
4000 			 * probably, but results in floating point being
4001 			 * used in the kernel on i386 (__udivdi3()).  On the
4002 			 * XScale, though, __udivdi3() is implemented in
4003 			 * software.
4004 			 *
4005 			 * The shift method for cylinder calculation is
4006 			 * accurate if sectors_per_cylinder is a power of
4007 			 * 2.  Otherwise it might be slightly off -- you
4008 			 * might have a bit of a truncation problem.
4009 			 */
4010 #ifdef	__XSCALE__
4011 			cylinders = (lun->be_lun->maxlba + 1) /
4012 				sectors_per_cylinder;
4013 #else
4014 			for (shift = 31; shift > 0; shift--) {
4015 				if (sectors_per_cylinder & (1 << shift))
4016 					break;
4017 			}
4018 			cylinders = (lun->be_lun->maxlba + 1) >> shift;
4019 #endif
4020 
4021 			/*
4022 			 * We've basically got 3 bytes, or 24 bits for the
4023 			 * cylinder size in the mode page.  If we're over,
4024 			 * just round down to 2^24.
4025 			 */
4026 			if (cylinders > 0xffffff)
4027 				cylinders = 0xffffff;
4028 
4029 			rigid_disk_page = &lun->mode_pages.rigid_disk_page[
4030 				CTL_PAGE_DEFAULT];
4031 			scsi_ulto3b(cylinders, rigid_disk_page->cylinders);
4032 
4033 			if ((value = ctl_get_opt(&lun->be_lun->options,
4034 			    "rpm")) != NULL) {
4035 				scsi_ulto2b(strtol(value, NULL, 0),
4036 				     rigid_disk_page->rotation_rate);
4037 			}
4038 
4039 			memcpy(&lun->mode_pages.rigid_disk_page[CTL_PAGE_CURRENT],
4040 			       &lun->mode_pages.rigid_disk_page[CTL_PAGE_DEFAULT],
4041 			       sizeof(rigid_disk_page_default));
4042 			memcpy(&lun->mode_pages.rigid_disk_page[CTL_PAGE_SAVED],
4043 			       &lun->mode_pages.rigid_disk_page[CTL_PAGE_DEFAULT],
4044 			       sizeof(rigid_disk_page_default));
4045 
4046 			page_index->page_data =
4047 				(uint8_t *)lun->mode_pages.rigid_disk_page;
4048 			break;
4049 		}
4050 		case SMS_CACHING_PAGE: {
4051 			struct scsi_caching_page *caching_page;
4052 
4053 			KASSERT(page_index->subpage == SMS_SUBPAGE_PAGE_0,
4054 			    ("subpage %#x for page %#x is incorrect!",
4055 			    page_index->subpage, page_code));
4056 			memcpy(&lun->mode_pages.caching_page[CTL_PAGE_DEFAULT],
4057 			       &caching_page_default,
4058 			       sizeof(caching_page_default));
4059 			memcpy(&lun->mode_pages.caching_page[
4060 			       CTL_PAGE_CHANGEABLE], &caching_page_changeable,
4061 			       sizeof(caching_page_changeable));
4062 			memcpy(&lun->mode_pages.caching_page[CTL_PAGE_SAVED],
4063 			       &caching_page_default,
4064 			       sizeof(caching_page_default));
4065 			caching_page = &lun->mode_pages.caching_page[
4066 			    CTL_PAGE_SAVED];
4067 			value = ctl_get_opt(&lun->be_lun->options, "writecache");
4068 			if (value != NULL && strcmp(value, "off") == 0)
4069 				caching_page->flags1 &= ~SCP_WCE;
4070 			value = ctl_get_opt(&lun->be_lun->options, "readcache");
4071 			if (value != NULL && strcmp(value, "off") == 0)
4072 				caching_page->flags1 |= SCP_RCD;
4073 			memcpy(&lun->mode_pages.caching_page[CTL_PAGE_CURRENT],
4074 			       &lun->mode_pages.caching_page[CTL_PAGE_SAVED],
4075 			       sizeof(caching_page_default));
4076 			page_index->page_data =
4077 				(uint8_t *)lun->mode_pages.caching_page;
4078 			break;
4079 		}
4080 		case SMS_CONTROL_MODE_PAGE: {
4081 			switch (page_index->subpage) {
4082 			case SMS_SUBPAGE_PAGE_0: {
4083 				struct scsi_control_page *control_page;
4084 
4085 				memcpy(&lun->mode_pages.control_page[
4086 				    CTL_PAGE_DEFAULT],
4087 				       &control_page_default,
4088 				       sizeof(control_page_default));
4089 				memcpy(&lun->mode_pages.control_page[
4090 				    CTL_PAGE_CHANGEABLE],
4091 				       &control_page_changeable,
4092 				       sizeof(control_page_changeable));
4093 				memcpy(&lun->mode_pages.control_page[
4094 				    CTL_PAGE_SAVED],
4095 				       &control_page_default,
4096 				       sizeof(control_page_default));
4097 				control_page = &lun->mode_pages.control_page[
4098 				    CTL_PAGE_SAVED];
4099 				value = ctl_get_opt(&lun->be_lun->options,
4100 				    "reordering");
4101 				if (value != NULL &&
4102 				    strcmp(value, "unrestricted") == 0) {
4103 					control_page->queue_flags &=
4104 					    ~SCP_QUEUE_ALG_MASK;
4105 					control_page->queue_flags |=
4106 					    SCP_QUEUE_ALG_UNRESTRICTED;
4107 				}
4108 				memcpy(&lun->mode_pages.control_page[
4109 				    CTL_PAGE_CURRENT],
4110 				       &lun->mode_pages.control_page[
4111 				    CTL_PAGE_SAVED],
4112 				       sizeof(control_page_default));
4113 				page_index->page_data =
4114 				    (uint8_t *)lun->mode_pages.control_page;
4115 				break;
4116 			}
4117 			case 0x01:
4118 				memcpy(&lun->mode_pages.control_ext_page[
4119 				    CTL_PAGE_DEFAULT],
4120 				       &control_ext_page_default,
4121 				       sizeof(control_ext_page_default));
4122 				memcpy(&lun->mode_pages.control_ext_page[
4123 				    CTL_PAGE_CHANGEABLE],
4124 				       &control_ext_page_changeable,
4125 				       sizeof(control_ext_page_changeable));
4126 				memcpy(&lun->mode_pages.control_ext_page[
4127 				    CTL_PAGE_SAVED],
4128 				       &control_ext_page_default,
4129 				       sizeof(control_ext_page_default));
4130 				memcpy(&lun->mode_pages.control_ext_page[
4131 				    CTL_PAGE_CURRENT],
4132 				       &lun->mode_pages.control_ext_page[
4133 				    CTL_PAGE_SAVED],
4134 				       sizeof(control_ext_page_default));
4135 				page_index->page_data =
4136 				    (uint8_t *)lun->mode_pages.control_ext_page;
4137 				break;
4138 			default:
4139 				panic("subpage %#x for page %#x is incorrect!",
4140 				      page_index->subpage, page_code);
4141 			}
4142 			break;
4143 		}
4144 		case SMS_INFO_EXCEPTIONS_PAGE: {
4145 			switch (page_index->subpage) {
4146 			case SMS_SUBPAGE_PAGE_0:
4147 				memcpy(&lun->mode_pages.ie_page[CTL_PAGE_CURRENT],
4148 				       &ie_page_default,
4149 				       sizeof(ie_page_default));
4150 				memcpy(&lun->mode_pages.ie_page[
4151 				       CTL_PAGE_CHANGEABLE], &ie_page_changeable,
4152 				       sizeof(ie_page_changeable));
4153 				memcpy(&lun->mode_pages.ie_page[CTL_PAGE_DEFAULT],
4154 				       &ie_page_default,
4155 				       sizeof(ie_page_default));
4156 				memcpy(&lun->mode_pages.ie_page[CTL_PAGE_SAVED],
4157 				       &ie_page_default,
4158 				       sizeof(ie_page_default));
4159 				page_index->page_data =
4160 					(uint8_t *)lun->mode_pages.ie_page;
4161 				break;
4162 			case 0x02: {
4163 				struct ctl_logical_block_provisioning_page *page;
4164 
4165 				memcpy(&lun->mode_pages.lbp_page[CTL_PAGE_DEFAULT],
4166 				       &lbp_page_default,
4167 				       sizeof(lbp_page_default));
4168 				memcpy(&lun->mode_pages.lbp_page[
4169 				       CTL_PAGE_CHANGEABLE], &lbp_page_changeable,
4170 				       sizeof(lbp_page_changeable));
4171 				memcpy(&lun->mode_pages.lbp_page[CTL_PAGE_SAVED],
4172 				       &lbp_page_default,
4173 				       sizeof(lbp_page_default));
4174 				page = &lun->mode_pages.lbp_page[CTL_PAGE_SAVED];
4175 				value = ctl_get_opt(&lun->be_lun->options,
4176 				    "avail-threshold");
4177 				if (value != NULL &&
4178 				    ctl_expand_number(value, &ival) == 0) {
4179 					page->descr[0].flags |= SLBPPD_ENABLED |
4180 					    SLBPPD_ARMING_DEC;
4181 					if (lun->be_lun->blocksize)
4182 						ival /= lun->be_lun->blocksize;
4183 					else
4184 						ival /= 512;
4185 					scsi_ulto4b(ival >> CTL_LBP_EXPONENT,
4186 					    page->descr[0].count);
4187 				}
4188 				value = ctl_get_opt(&lun->be_lun->options,
4189 				    "used-threshold");
4190 				if (value != NULL &&
4191 				    ctl_expand_number(value, &ival) == 0) {
4192 					page->descr[1].flags |= SLBPPD_ENABLED |
4193 					    SLBPPD_ARMING_INC;
4194 					if (lun->be_lun->blocksize)
4195 						ival /= lun->be_lun->blocksize;
4196 					else
4197 						ival /= 512;
4198 					scsi_ulto4b(ival >> CTL_LBP_EXPONENT,
4199 					    page->descr[1].count);
4200 				}
4201 				value = ctl_get_opt(&lun->be_lun->options,
4202 				    "pool-avail-threshold");
4203 				if (value != NULL &&
4204 				    ctl_expand_number(value, &ival) == 0) {
4205 					page->descr[2].flags |= SLBPPD_ENABLED |
4206 					    SLBPPD_ARMING_DEC;
4207 					if (lun->be_lun->blocksize)
4208 						ival /= lun->be_lun->blocksize;
4209 					else
4210 						ival /= 512;
4211 					scsi_ulto4b(ival >> CTL_LBP_EXPONENT,
4212 					    page->descr[2].count);
4213 				}
4214 				value = ctl_get_opt(&lun->be_lun->options,
4215 				    "pool-used-threshold");
4216 				if (value != NULL &&
4217 				    ctl_expand_number(value, &ival) == 0) {
4218 					page->descr[3].flags |= SLBPPD_ENABLED |
4219 					    SLBPPD_ARMING_INC;
4220 					if (lun->be_lun->blocksize)
4221 						ival /= lun->be_lun->blocksize;
4222 					else
4223 						ival /= 512;
4224 					scsi_ulto4b(ival >> CTL_LBP_EXPONENT,
4225 					    page->descr[3].count);
4226 				}
4227 				memcpy(&lun->mode_pages.lbp_page[CTL_PAGE_CURRENT],
4228 				       &lun->mode_pages.lbp_page[CTL_PAGE_SAVED],
4229 				       sizeof(lbp_page_default));
4230 				page_index->page_data =
4231 					(uint8_t *)lun->mode_pages.lbp_page;
4232 				break;
4233 			}
4234 			default:
4235 				panic("subpage %#x for page %#x is incorrect!",
4236 				      page_index->subpage, page_code);
4237 			}
4238 			break;
4239 		}
4240 		case SMS_CDDVD_CAPS_PAGE:{
4241 			KASSERT(page_index->subpage == SMS_SUBPAGE_PAGE_0,
4242 			    ("subpage %#x for page %#x is incorrect!",
4243 			    page_index->subpage, page_code));
4244 			memcpy(&lun->mode_pages.cddvd_page[CTL_PAGE_DEFAULT],
4245 			       &cddvd_page_default,
4246 			       sizeof(cddvd_page_default));
4247 			memcpy(&lun->mode_pages.cddvd_page[
4248 			       CTL_PAGE_CHANGEABLE], &cddvd_page_changeable,
4249 			       sizeof(cddvd_page_changeable));
4250 			memcpy(&lun->mode_pages.cddvd_page[CTL_PAGE_SAVED],
4251 			       &cddvd_page_default,
4252 			       sizeof(cddvd_page_default));
4253 			memcpy(&lun->mode_pages.cddvd_page[CTL_PAGE_CURRENT],
4254 			       &lun->mode_pages.cddvd_page[CTL_PAGE_SAVED],
4255 			       sizeof(cddvd_page_default));
4256 			page_index->page_data =
4257 				(uint8_t *)lun->mode_pages.cddvd_page;
4258 			break;
4259 		}
4260 		case SMS_VENDOR_SPECIFIC_PAGE:{
4261 			switch (page_index->subpage) {
4262 			case DBGCNF_SUBPAGE_CODE: {
4263 				memcpy(&lun->mode_pages.debugconf_subpage[
4264 				       CTL_PAGE_CURRENT],
4265 				       &debugconf_page_default,
4266 				       sizeof(debugconf_page_default));
4267 				memcpy(&lun->mode_pages.debugconf_subpage[
4268 				       CTL_PAGE_CHANGEABLE],
4269 				       &debugconf_page_changeable,
4270 				       sizeof(debugconf_page_changeable));
4271 				memcpy(&lun->mode_pages.debugconf_subpage[
4272 				       CTL_PAGE_DEFAULT],
4273 				       &debugconf_page_default,
4274 				       sizeof(debugconf_page_default));
4275 				memcpy(&lun->mode_pages.debugconf_subpage[
4276 				       CTL_PAGE_SAVED],
4277 				       &debugconf_page_default,
4278 				       sizeof(debugconf_page_default));
4279 				page_index->page_data =
4280 				    (uint8_t *)lun->mode_pages.debugconf_subpage;
4281 				break;
4282 			}
4283 			default:
4284 				panic("subpage %#x for page %#x is incorrect!",
4285 				      page_index->subpage, page_code);
4286 			}
4287 			break;
4288 		}
4289 		default:
4290 			panic("invalid page code value %#x", page_code);
4291 		}
4292 	}
4293 
4294 	return (CTL_RETVAL_COMPLETE);
4295 }
4296 
4297 static int
4298 ctl_init_log_page_index(struct ctl_lun *lun)
4299 {
4300 	struct ctl_page_index *page_index;
4301 	int i, j, k, prev;
4302 
4303 	memcpy(&lun->log_pages.index, log_page_index_template,
4304 	       sizeof(log_page_index_template));
4305 
4306 	prev = -1;
4307 	for (i = 0, j = 0, k = 0; i < CTL_NUM_LOG_PAGES; i++) {
4308 
4309 		page_index = &lun->log_pages.index[i];
4310 		if (lun->be_lun->lun_type == T_DIRECT &&
4311 		    (page_index->page_flags & CTL_PAGE_FLAG_DIRECT) == 0)
4312 			continue;
4313 		if (lun->be_lun->lun_type == T_PROCESSOR &&
4314 		    (page_index->page_flags & CTL_PAGE_FLAG_PROC) == 0)
4315 			continue;
4316 		if (lun->be_lun->lun_type == T_CDROM &&
4317 		    (page_index->page_flags & CTL_PAGE_FLAG_CDROM) == 0)
4318 			continue;
4319 
4320 		if (page_index->page_code == SLS_LOGICAL_BLOCK_PROVISIONING &&
4321 		    lun->backend->lun_attr == NULL)
4322 			continue;
4323 
4324 		if (page_index->page_code != prev) {
4325 			lun->log_pages.pages_page[j] = page_index->page_code;
4326 			prev = page_index->page_code;
4327 			j++;
4328 		}
4329 		lun->log_pages.subpages_page[k*2] = page_index->page_code;
4330 		lun->log_pages.subpages_page[k*2+1] = page_index->subpage;
4331 		k++;
4332 	}
4333 	lun->log_pages.index[0].page_data = &lun->log_pages.pages_page[0];
4334 	lun->log_pages.index[0].page_len = j;
4335 	lun->log_pages.index[1].page_data = &lun->log_pages.subpages_page[0];
4336 	lun->log_pages.index[1].page_len = k * 2;
4337 	lun->log_pages.index[2].page_data = &lun->log_pages.lbp_page[0];
4338 	lun->log_pages.index[2].page_len = 12*CTL_NUM_LBP_PARAMS;
4339 	lun->log_pages.index[3].page_data = (uint8_t *)&lun->log_pages.stat_page;
4340 	lun->log_pages.index[3].page_len = sizeof(lun->log_pages.stat_page);
4341 
4342 	return (CTL_RETVAL_COMPLETE);
4343 }
4344 
4345 static int
4346 hex2bin(const char *str, uint8_t *buf, int buf_size)
4347 {
4348 	int i;
4349 	u_char c;
4350 
4351 	memset(buf, 0, buf_size);
4352 	while (isspace(str[0]))
4353 		str++;
4354 	if (str[0] == '0' && (str[1] == 'x' || str[1] == 'X'))
4355 		str += 2;
4356 	buf_size *= 2;
4357 	for (i = 0; str[i] != 0 && i < buf_size; i++) {
4358 		c = str[i];
4359 		if (isdigit(c))
4360 			c -= '0';
4361 		else if (isalpha(c))
4362 			c -= isupper(c) ? 'A' - 10 : 'a' - 10;
4363 		else
4364 			break;
4365 		if (c >= 16)
4366 			break;
4367 		if ((i & 1) == 0)
4368 			buf[i / 2] |= (c << 4);
4369 		else
4370 			buf[i / 2] |= c;
4371 	}
4372 	return ((i + 1) / 2);
4373 }
4374 
4375 /*
4376  * LUN allocation.
4377  *
4378  * Requirements:
4379  * - caller allocates and zeros LUN storage, or passes in a NULL LUN if he
4380  *   wants us to allocate the LUN and he can block.
4381  * - ctl_softc is always set
4382  * - be_lun is set if the LUN has a backend (needed for disk LUNs)
4383  *
4384  * Returns 0 for success, non-zero (errno) for failure.
4385  */
4386 static int
4387 ctl_alloc_lun(struct ctl_softc *ctl_softc, struct ctl_lun *ctl_lun,
4388 	      struct ctl_be_lun *const be_lun)
4389 {
4390 	struct ctl_lun *nlun, *lun;
4391 	struct scsi_vpd_id_descriptor *desc;
4392 	struct scsi_vpd_id_t10 *t10id;
4393 	const char *eui, *naa, *scsiname, *vendor, *value;
4394 	int lun_number, i, lun_malloced;
4395 	int devidlen, idlen1, idlen2 = 0, len;
4396 
4397 	if (be_lun == NULL)
4398 		return (EINVAL);
4399 
4400 	/*
4401 	 * We currently only support Direct Access or Processor LUN types.
4402 	 */
4403 	switch (be_lun->lun_type) {
4404 	case T_DIRECT:
4405 	case T_PROCESSOR:
4406 	case T_CDROM:
4407 		break;
4408 	case T_SEQUENTIAL:
4409 	case T_CHANGER:
4410 	default:
4411 		be_lun->lun_config_status(be_lun->be_lun,
4412 					  CTL_LUN_CONFIG_FAILURE);
4413 		break;
4414 	}
4415 	if (ctl_lun == NULL) {
4416 		lun = malloc(sizeof(*lun), M_CTL, M_WAITOK);
4417 		lun_malloced = 1;
4418 	} else {
4419 		lun_malloced = 0;
4420 		lun = ctl_lun;
4421 	}
4422 
4423 	memset(lun, 0, sizeof(*lun));
4424 	if (lun_malloced)
4425 		lun->flags = CTL_LUN_MALLOCED;
4426 
4427 	/* Generate LUN ID. */
4428 	devidlen = max(CTL_DEVID_MIN_LEN,
4429 	    strnlen(be_lun->device_id, CTL_DEVID_LEN));
4430 	idlen1 = sizeof(*t10id) + devidlen;
4431 	len = sizeof(struct scsi_vpd_id_descriptor) + idlen1;
4432 	scsiname = ctl_get_opt(&be_lun->options, "scsiname");
4433 	if (scsiname != NULL) {
4434 		idlen2 = roundup2(strlen(scsiname) + 1, 4);
4435 		len += sizeof(struct scsi_vpd_id_descriptor) + idlen2;
4436 	}
4437 	eui = ctl_get_opt(&be_lun->options, "eui");
4438 	if (eui != NULL) {
4439 		len += sizeof(struct scsi_vpd_id_descriptor) + 16;
4440 	}
4441 	naa = ctl_get_opt(&be_lun->options, "naa");
4442 	if (naa != NULL) {
4443 		len += sizeof(struct scsi_vpd_id_descriptor) + 16;
4444 	}
4445 	lun->lun_devid = malloc(sizeof(struct ctl_devid) + len,
4446 	    M_CTL, M_WAITOK | M_ZERO);
4447 	desc = (struct scsi_vpd_id_descriptor *)lun->lun_devid->data;
4448 	desc->proto_codeset = SVPD_ID_CODESET_ASCII;
4449 	desc->id_type = SVPD_ID_PIV | SVPD_ID_ASSOC_LUN | SVPD_ID_TYPE_T10;
4450 	desc->length = idlen1;
4451 	t10id = (struct scsi_vpd_id_t10 *)&desc->identifier[0];
4452 	memset(t10id->vendor, ' ', sizeof(t10id->vendor));
4453 	if ((vendor = ctl_get_opt(&be_lun->options, "vendor")) == NULL) {
4454 		strncpy((char *)t10id->vendor, CTL_VENDOR, sizeof(t10id->vendor));
4455 	} else {
4456 		strncpy(t10id->vendor, vendor,
4457 		    min(sizeof(t10id->vendor), strlen(vendor)));
4458 	}
4459 	strncpy((char *)t10id->vendor_spec_id,
4460 	    (char *)be_lun->device_id, devidlen);
4461 	if (scsiname != NULL) {
4462 		desc = (struct scsi_vpd_id_descriptor *)(&desc->identifier[0] +
4463 		    desc->length);
4464 		desc->proto_codeset = SVPD_ID_CODESET_UTF8;
4465 		desc->id_type = SVPD_ID_PIV | SVPD_ID_ASSOC_LUN |
4466 		    SVPD_ID_TYPE_SCSI_NAME;
4467 		desc->length = idlen2;
4468 		strlcpy(desc->identifier, scsiname, idlen2);
4469 	}
4470 	if (eui != NULL) {
4471 		desc = (struct scsi_vpd_id_descriptor *)(&desc->identifier[0] +
4472 		    desc->length);
4473 		desc->proto_codeset = SVPD_ID_CODESET_BINARY;
4474 		desc->id_type = SVPD_ID_PIV | SVPD_ID_ASSOC_LUN |
4475 		    SVPD_ID_TYPE_EUI64;
4476 		desc->length = hex2bin(eui, desc->identifier, 16);
4477 		desc->length = desc->length > 12 ? 16 :
4478 		    (desc->length > 8 ? 12 : 8);
4479 		len -= 16 - desc->length;
4480 	}
4481 	if (naa != NULL) {
4482 		desc = (struct scsi_vpd_id_descriptor *)(&desc->identifier[0] +
4483 		    desc->length);
4484 		desc->proto_codeset = SVPD_ID_CODESET_BINARY;
4485 		desc->id_type = SVPD_ID_PIV | SVPD_ID_ASSOC_LUN |
4486 		    SVPD_ID_TYPE_NAA;
4487 		desc->length = hex2bin(naa, desc->identifier, 16);
4488 		desc->length = desc->length > 8 ? 16 : 8;
4489 		len -= 16 - desc->length;
4490 	}
4491 	lun->lun_devid->len = len;
4492 
4493 	mtx_lock(&ctl_softc->ctl_lock);
4494 	/*
4495 	 * See if the caller requested a particular LUN number.  If so, see
4496 	 * if it is available.  Otherwise, allocate the first available LUN.
4497 	 */
4498 	if (be_lun->flags & CTL_LUN_FLAG_ID_REQ) {
4499 		if ((be_lun->req_lun_id > (CTL_MAX_LUNS - 1))
4500 		 || (ctl_is_set(ctl_softc->ctl_lun_mask, be_lun->req_lun_id))) {
4501 			mtx_unlock(&ctl_softc->ctl_lock);
4502 			if (be_lun->req_lun_id > (CTL_MAX_LUNS - 1)) {
4503 				printf("ctl: requested LUN ID %d is higher "
4504 				       "than CTL_MAX_LUNS - 1 (%d)\n",
4505 				       be_lun->req_lun_id, CTL_MAX_LUNS - 1);
4506 			} else {
4507 				/*
4508 				 * XXX KDM return an error, or just assign
4509 				 * another LUN ID in this case??
4510 				 */
4511 				printf("ctl: requested LUN ID %d is already "
4512 				       "in use\n", be_lun->req_lun_id);
4513 			}
4514 			if (lun->flags & CTL_LUN_MALLOCED)
4515 				free(lun, M_CTL);
4516 			be_lun->lun_config_status(be_lun->be_lun,
4517 						  CTL_LUN_CONFIG_FAILURE);
4518 			return (ENOSPC);
4519 		}
4520 		lun_number = be_lun->req_lun_id;
4521 	} else {
4522 		lun_number = ctl_ffz(ctl_softc->ctl_lun_mask, 0, CTL_MAX_LUNS);
4523 		if (lun_number == -1) {
4524 			mtx_unlock(&ctl_softc->ctl_lock);
4525 			printf("ctl: can't allocate LUN, out of LUNs\n");
4526 			if (lun->flags & CTL_LUN_MALLOCED)
4527 				free(lun, M_CTL);
4528 			be_lun->lun_config_status(be_lun->be_lun,
4529 						  CTL_LUN_CONFIG_FAILURE);
4530 			return (ENOSPC);
4531 		}
4532 	}
4533 	ctl_set_mask(ctl_softc->ctl_lun_mask, lun_number);
4534 
4535 	mtx_init(&lun->lun_lock, "CTL LUN", NULL, MTX_DEF);
4536 	lun->lun = lun_number;
4537 	lun->be_lun = be_lun;
4538 	/*
4539 	 * The processor LUN is always enabled.  Disk LUNs come on line
4540 	 * disabled, and must be enabled by the backend.
4541 	 */
4542 	lun->flags |= CTL_LUN_DISABLED;
4543 	lun->backend = be_lun->be;
4544 	be_lun->ctl_lun = lun;
4545 	be_lun->lun_id = lun_number;
4546 	atomic_add_int(&be_lun->be->num_luns, 1);
4547 	if (be_lun->flags & CTL_LUN_FLAG_EJECTED)
4548 		lun->flags |= CTL_LUN_EJECTED;
4549 	if (be_lun->flags & CTL_LUN_FLAG_NO_MEDIA)
4550 		lun->flags |= CTL_LUN_NO_MEDIA;
4551 	if (be_lun->flags & CTL_LUN_FLAG_STOPPED)
4552 		lun->flags |= CTL_LUN_STOPPED;
4553 
4554 	if (be_lun->flags & CTL_LUN_FLAG_PRIMARY)
4555 		lun->flags |= CTL_LUN_PRIMARY_SC;
4556 
4557 	value = ctl_get_opt(&be_lun->options, "removable");
4558 	if (value != NULL) {
4559 		if (strcmp(value, "on") == 0)
4560 			lun->flags |= CTL_LUN_REMOVABLE;
4561 	} else if (be_lun->lun_type == T_CDROM)
4562 		lun->flags |= CTL_LUN_REMOVABLE;
4563 
4564 	lun->ctl_softc = ctl_softc;
4565 #ifdef CTL_TIME_IO
4566 	lun->last_busy = getsbinuptime();
4567 #endif
4568 	TAILQ_INIT(&lun->ooa_queue);
4569 	TAILQ_INIT(&lun->blocked_queue);
4570 	STAILQ_INIT(&lun->error_list);
4571 	ctl_tpc_lun_init(lun);
4572 
4573 	/*
4574 	 * Initialize the mode and log page index.
4575 	 */
4576 	ctl_init_page_index(lun);
4577 	ctl_init_log_page_index(lun);
4578 
4579 	/*
4580 	 * Now, before we insert this lun on the lun list, set the lun
4581 	 * inventory changed UA for all other luns.
4582 	 */
4583 	STAILQ_FOREACH(nlun, &ctl_softc->lun_list, links) {
4584 		mtx_lock(&nlun->lun_lock);
4585 		ctl_est_ua_all(nlun, -1, CTL_UA_LUN_CHANGE);
4586 		mtx_unlock(&nlun->lun_lock);
4587 	}
4588 
4589 	STAILQ_INSERT_TAIL(&ctl_softc->lun_list, lun, links);
4590 
4591 	ctl_softc->ctl_luns[lun_number] = lun;
4592 
4593 	ctl_softc->num_luns++;
4594 
4595 	/* Setup statistics gathering */
4596 	lun->stats.device_type = be_lun->lun_type;
4597 	lun->stats.lun_number = lun_number;
4598 	lun->stats.blocksize = be_lun->blocksize;
4599 	if (be_lun->blocksize == 0)
4600 		lun->stats.flags = CTL_LUN_STATS_NO_BLOCKSIZE;
4601 	for (i = 0;i < CTL_MAX_PORTS;i++)
4602 		lun->stats.ports[i].targ_port = i;
4603 
4604 	mtx_unlock(&ctl_softc->ctl_lock);
4605 
4606 	lun->be_lun->lun_config_status(lun->be_lun->be_lun, CTL_LUN_CONFIG_OK);
4607 	return (0);
4608 }
4609 
4610 /*
4611  * Delete a LUN.
4612  * Assumptions:
4613  * - LUN has already been marked invalid and any pending I/O has been taken
4614  *   care of.
4615  */
4616 static int
4617 ctl_free_lun(struct ctl_lun *lun)
4618 {
4619 	struct ctl_softc *softc;
4620 	struct ctl_lun *nlun;
4621 	int i;
4622 
4623 	softc = lun->ctl_softc;
4624 
4625 	mtx_assert(&softc->ctl_lock, MA_OWNED);
4626 
4627 	STAILQ_REMOVE(&softc->lun_list, lun, ctl_lun, links);
4628 
4629 	ctl_clear_mask(softc->ctl_lun_mask, lun->lun);
4630 
4631 	softc->ctl_luns[lun->lun] = NULL;
4632 
4633 	if (!TAILQ_EMPTY(&lun->ooa_queue))
4634 		panic("Freeing a LUN %p with outstanding I/O!!\n", lun);
4635 
4636 	softc->num_luns--;
4637 
4638 	/*
4639 	 * Tell the backend to free resources, if this LUN has a backend.
4640 	 */
4641 	atomic_subtract_int(&lun->be_lun->be->num_luns, 1);
4642 	lun->be_lun->lun_shutdown(lun->be_lun->be_lun);
4643 
4644 	ctl_tpc_lun_shutdown(lun);
4645 	mtx_destroy(&lun->lun_lock);
4646 	free(lun->lun_devid, M_CTL);
4647 	for (i = 0; i < CTL_MAX_PORTS; i++)
4648 		free(lun->pending_ua[i], M_CTL);
4649 	for (i = 0; i < CTL_MAX_PORTS; i++)
4650 		free(lun->pr_keys[i], M_CTL);
4651 	free(lun->write_buffer, M_CTL);
4652 	if (lun->flags & CTL_LUN_MALLOCED)
4653 		free(lun, M_CTL);
4654 
4655 	STAILQ_FOREACH(nlun, &softc->lun_list, links) {
4656 		mtx_lock(&nlun->lun_lock);
4657 		ctl_est_ua_all(nlun, -1, CTL_UA_LUN_CHANGE);
4658 		mtx_unlock(&nlun->lun_lock);
4659 	}
4660 
4661 	return (0);
4662 }
4663 
4664 static void
4665 ctl_create_lun(struct ctl_be_lun *be_lun)
4666 {
4667 
4668 	/*
4669 	 * ctl_alloc_lun() should handle all potential failure cases.
4670 	 */
4671 	ctl_alloc_lun(control_softc, NULL, be_lun);
4672 }
4673 
4674 int
4675 ctl_add_lun(struct ctl_be_lun *be_lun)
4676 {
4677 	struct ctl_softc *softc = control_softc;
4678 
4679 	mtx_lock(&softc->ctl_lock);
4680 	STAILQ_INSERT_TAIL(&softc->pending_lun_queue, be_lun, links);
4681 	mtx_unlock(&softc->ctl_lock);
4682 	wakeup(&softc->pending_lun_queue);
4683 
4684 	return (0);
4685 }
4686 
4687 int
4688 ctl_enable_lun(struct ctl_be_lun *be_lun)
4689 {
4690 	struct ctl_softc *softc;
4691 	struct ctl_port *port, *nport;
4692 	struct ctl_lun *lun;
4693 	int retval;
4694 
4695 	lun = (struct ctl_lun *)be_lun->ctl_lun;
4696 	softc = lun->ctl_softc;
4697 
4698 	mtx_lock(&softc->ctl_lock);
4699 	mtx_lock(&lun->lun_lock);
4700 	if ((lun->flags & CTL_LUN_DISABLED) == 0) {
4701 		/*
4702 		 * eh?  Why did we get called if the LUN is already
4703 		 * enabled?
4704 		 */
4705 		mtx_unlock(&lun->lun_lock);
4706 		mtx_unlock(&softc->ctl_lock);
4707 		return (0);
4708 	}
4709 	lun->flags &= ~CTL_LUN_DISABLED;
4710 	mtx_unlock(&lun->lun_lock);
4711 
4712 	STAILQ_FOREACH_SAFE(port, &softc->port_list, links, nport) {
4713 		if ((port->status & CTL_PORT_STATUS_ONLINE) == 0 ||
4714 		    port->lun_map != NULL || port->lun_enable == NULL)
4715 			continue;
4716 
4717 		/*
4718 		 * Drop the lock while we call the FETD's enable routine.
4719 		 * This can lead to a callback into CTL (at least in the
4720 		 * case of the internal initiator frontend.
4721 		 */
4722 		mtx_unlock(&softc->ctl_lock);
4723 		retval = port->lun_enable(port->targ_lun_arg, lun->lun);
4724 		mtx_lock(&softc->ctl_lock);
4725 		if (retval != 0) {
4726 			printf("%s: FETD %s port %d returned error "
4727 			       "%d for lun_enable on lun %jd\n",
4728 			       __func__, port->port_name, port->targ_port,
4729 			       retval, (intmax_t)lun->lun);
4730 		}
4731 	}
4732 
4733 	mtx_unlock(&softc->ctl_lock);
4734 	ctl_isc_announce_lun(lun);
4735 
4736 	return (0);
4737 }
4738 
4739 int
4740 ctl_disable_lun(struct ctl_be_lun *be_lun)
4741 {
4742 	struct ctl_softc *softc;
4743 	struct ctl_port *port;
4744 	struct ctl_lun *lun;
4745 	int retval;
4746 
4747 	lun = (struct ctl_lun *)be_lun->ctl_lun;
4748 	softc = lun->ctl_softc;
4749 
4750 	mtx_lock(&softc->ctl_lock);
4751 	mtx_lock(&lun->lun_lock);
4752 	if (lun->flags & CTL_LUN_DISABLED) {
4753 		mtx_unlock(&lun->lun_lock);
4754 		mtx_unlock(&softc->ctl_lock);
4755 		return (0);
4756 	}
4757 	lun->flags |= CTL_LUN_DISABLED;
4758 	mtx_unlock(&lun->lun_lock);
4759 
4760 	STAILQ_FOREACH(port, &softc->port_list, links) {
4761 		if ((port->status & CTL_PORT_STATUS_ONLINE) == 0 ||
4762 		    port->lun_map != NULL || port->lun_disable == NULL)
4763 			continue;
4764 
4765 		/*
4766 		 * Drop the lock before we call the frontend's disable
4767 		 * routine, to avoid lock order reversals.
4768 		 *
4769 		 * XXX KDM what happens if the frontend list changes while
4770 		 * we're traversing it?  It's unlikely, but should be handled.
4771 		 */
4772 		mtx_unlock(&softc->ctl_lock);
4773 		retval = port->lun_disable(port->targ_lun_arg, lun->lun);
4774 		mtx_lock(&softc->ctl_lock);
4775 		if (retval != 0) {
4776 			printf("%s: FETD %s port %d returned error "
4777 			       "%d for lun_disable on lun %jd\n",
4778 			       __func__, port->port_name, port->targ_port,
4779 			       retval, (intmax_t)lun->lun);
4780 		}
4781 	}
4782 
4783 	mtx_unlock(&softc->ctl_lock);
4784 	ctl_isc_announce_lun(lun);
4785 
4786 	return (0);
4787 }
4788 
4789 int
4790 ctl_start_lun(struct ctl_be_lun *be_lun)
4791 {
4792 	struct ctl_lun *lun = (struct ctl_lun *)be_lun->ctl_lun;
4793 
4794 	mtx_lock(&lun->lun_lock);
4795 	lun->flags &= ~CTL_LUN_STOPPED;
4796 	mtx_unlock(&lun->lun_lock);
4797 	return (0);
4798 }
4799 
4800 int
4801 ctl_stop_lun(struct ctl_be_lun *be_lun)
4802 {
4803 	struct ctl_lun *lun = (struct ctl_lun *)be_lun->ctl_lun;
4804 
4805 	mtx_lock(&lun->lun_lock);
4806 	lun->flags |= CTL_LUN_STOPPED;
4807 	mtx_unlock(&lun->lun_lock);
4808 	return (0);
4809 }
4810 
4811 int
4812 ctl_lun_no_media(struct ctl_be_lun *be_lun)
4813 {
4814 	struct ctl_lun *lun = (struct ctl_lun *)be_lun->ctl_lun;
4815 
4816 	mtx_lock(&lun->lun_lock);
4817 	lun->flags |= CTL_LUN_NO_MEDIA;
4818 	mtx_unlock(&lun->lun_lock);
4819 	return (0);
4820 }
4821 
4822 int
4823 ctl_lun_has_media(struct ctl_be_lun *be_lun)
4824 {
4825 	struct ctl_lun *lun = (struct ctl_lun *)be_lun->ctl_lun;
4826 	union ctl_ha_msg msg;
4827 
4828 	mtx_lock(&lun->lun_lock);
4829 	lun->flags &= ~(CTL_LUN_NO_MEDIA | CTL_LUN_EJECTED);
4830 	if (lun->flags & CTL_LUN_REMOVABLE)
4831 		ctl_est_ua_all(lun, -1, CTL_UA_MEDIUM_CHANGE);
4832 	mtx_unlock(&lun->lun_lock);
4833 	if ((lun->flags & CTL_LUN_REMOVABLE) &&
4834 	    lun->ctl_softc->ha_mode == CTL_HA_MODE_XFER) {
4835 		bzero(&msg.ua, sizeof(msg.ua));
4836 		msg.hdr.msg_type = CTL_MSG_UA;
4837 		msg.hdr.nexus.initid = -1;
4838 		msg.hdr.nexus.targ_port = -1;
4839 		msg.hdr.nexus.targ_lun = lun->lun;
4840 		msg.hdr.nexus.targ_mapped_lun = lun->lun;
4841 		msg.ua.ua_all = 1;
4842 		msg.ua.ua_set = 1;
4843 		msg.ua.ua_type = CTL_UA_MEDIUM_CHANGE;
4844 		ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg, sizeof(msg.ua),
4845 		    M_WAITOK);
4846 	}
4847 	return (0);
4848 }
4849 
4850 int
4851 ctl_lun_ejected(struct ctl_be_lun *be_lun)
4852 {
4853 	struct ctl_lun *lun = (struct ctl_lun *)be_lun->ctl_lun;
4854 
4855 	mtx_lock(&lun->lun_lock);
4856 	lun->flags |= CTL_LUN_EJECTED;
4857 	mtx_unlock(&lun->lun_lock);
4858 	return (0);
4859 }
4860 
4861 int
4862 ctl_lun_primary(struct ctl_be_lun *be_lun)
4863 {
4864 	struct ctl_lun *lun = (struct ctl_lun *)be_lun->ctl_lun;
4865 
4866 	mtx_lock(&lun->lun_lock);
4867 	lun->flags |= CTL_LUN_PRIMARY_SC;
4868 	ctl_est_ua_all(lun, -1, CTL_UA_ASYM_ACC_CHANGE);
4869 	mtx_unlock(&lun->lun_lock);
4870 	ctl_isc_announce_lun(lun);
4871 	return (0);
4872 }
4873 
4874 int
4875 ctl_lun_secondary(struct ctl_be_lun *be_lun)
4876 {
4877 	struct ctl_lun *lun = (struct ctl_lun *)be_lun->ctl_lun;
4878 
4879 	mtx_lock(&lun->lun_lock);
4880 	lun->flags &= ~CTL_LUN_PRIMARY_SC;
4881 	ctl_est_ua_all(lun, -1, CTL_UA_ASYM_ACC_CHANGE);
4882 	mtx_unlock(&lun->lun_lock);
4883 	ctl_isc_announce_lun(lun);
4884 	return (0);
4885 }
4886 
4887 int
4888 ctl_invalidate_lun(struct ctl_be_lun *be_lun)
4889 {
4890 	struct ctl_softc *softc;
4891 	struct ctl_lun *lun;
4892 
4893 	lun = (struct ctl_lun *)be_lun->ctl_lun;
4894 	softc = lun->ctl_softc;
4895 
4896 	mtx_lock(&lun->lun_lock);
4897 
4898 	/*
4899 	 * The LUN needs to be disabled before it can be marked invalid.
4900 	 */
4901 	if ((lun->flags & CTL_LUN_DISABLED) == 0) {
4902 		mtx_unlock(&lun->lun_lock);
4903 		return (-1);
4904 	}
4905 	/*
4906 	 * Mark the LUN invalid.
4907 	 */
4908 	lun->flags |= CTL_LUN_INVALID;
4909 
4910 	/*
4911 	 * If there is nothing in the OOA queue, go ahead and free the LUN.
4912 	 * If we have something in the OOA queue, we'll free it when the
4913 	 * last I/O completes.
4914 	 */
4915 	if (TAILQ_EMPTY(&lun->ooa_queue)) {
4916 		mtx_unlock(&lun->lun_lock);
4917 		mtx_lock(&softc->ctl_lock);
4918 		ctl_free_lun(lun);
4919 		mtx_unlock(&softc->ctl_lock);
4920 	} else
4921 		mtx_unlock(&lun->lun_lock);
4922 
4923 	return (0);
4924 }
4925 
4926 void
4927 ctl_lun_capacity_changed(struct ctl_be_lun *be_lun)
4928 {
4929 	struct ctl_lun *lun = (struct ctl_lun *)be_lun->ctl_lun;
4930 	union ctl_ha_msg msg;
4931 
4932 	mtx_lock(&lun->lun_lock);
4933 	ctl_est_ua_all(lun, -1, CTL_UA_CAPACITY_CHANGE);
4934 	mtx_unlock(&lun->lun_lock);
4935 	if (lun->ctl_softc->ha_mode == CTL_HA_MODE_XFER) {
4936 		/* Send msg to other side. */
4937 		bzero(&msg.ua, sizeof(msg.ua));
4938 		msg.hdr.msg_type = CTL_MSG_UA;
4939 		msg.hdr.nexus.initid = -1;
4940 		msg.hdr.nexus.targ_port = -1;
4941 		msg.hdr.nexus.targ_lun = lun->lun;
4942 		msg.hdr.nexus.targ_mapped_lun = lun->lun;
4943 		msg.ua.ua_all = 1;
4944 		msg.ua.ua_set = 1;
4945 		msg.ua.ua_type = CTL_UA_CAPACITY_CHANGE;
4946 		ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg, sizeof(msg.ua),
4947 		    M_WAITOK);
4948 	}
4949 }
4950 
4951 /*
4952  * Backend "memory move is complete" callback for requests that never
4953  * make it down to say RAIDCore's configuration code.
4954  */
4955 int
4956 ctl_config_move_done(union ctl_io *io)
4957 {
4958 	int retval;
4959 
4960 	CTL_DEBUG_PRINT(("ctl_config_move_done\n"));
4961 	KASSERT(io->io_hdr.io_type == CTL_IO_SCSI,
4962 	    ("Config I/O type isn't CTL_IO_SCSI (%d)!", io->io_hdr.io_type));
4963 
4964 	if ((io->io_hdr.port_status != 0) &&
4965 	    ((io->io_hdr.status & CTL_STATUS_MASK) == CTL_STATUS_NONE ||
4966 	     (io->io_hdr.status & CTL_STATUS_MASK) == CTL_SUCCESS)) {
4967 		/*
4968 		 * For hardware error sense keys, the sense key
4969 		 * specific value is defined to be a retry count,
4970 		 * but we use it to pass back an internal FETD
4971 		 * error code.  XXX KDM  Hopefully the FETD is only
4972 		 * using 16 bits for an error code, since that's
4973 		 * all the space we have in the sks field.
4974 		 */
4975 		ctl_set_internal_failure(&io->scsiio,
4976 					 /*sks_valid*/ 1,
4977 					 /*retry_count*/
4978 					 io->io_hdr.port_status);
4979 	}
4980 
4981 	if (ctl_debug & CTL_DEBUG_CDB_DATA)
4982 		ctl_data_print(io);
4983 	if (((io->io_hdr.flags & CTL_FLAG_DATA_MASK) == CTL_FLAG_DATA_IN) ||
4984 	    ((io->io_hdr.status & CTL_STATUS_MASK) != CTL_STATUS_NONE &&
4985 	     (io->io_hdr.status & CTL_STATUS_MASK) != CTL_SUCCESS) ||
4986 	    ((io->io_hdr.flags & CTL_FLAG_ABORT) != 0)) {
4987 		/*
4988 		 * XXX KDM just assuming a single pointer here, and not a
4989 		 * S/G list.  If we start using S/G lists for config data,
4990 		 * we'll need to know how to clean them up here as well.
4991 		 */
4992 		if (io->io_hdr.flags & CTL_FLAG_ALLOCATED)
4993 			free(io->scsiio.kern_data_ptr, M_CTL);
4994 		ctl_done(io);
4995 		retval = CTL_RETVAL_COMPLETE;
4996 	} else {
4997 		/*
4998 		 * XXX KDM now we need to continue data movement.  Some
4999 		 * options:
5000 		 * - call ctl_scsiio() again?  We don't do this for data
5001 		 *   writes, because for those at least we know ahead of
5002 		 *   time where the write will go and how long it is.  For
5003 		 *   config writes, though, that information is largely
5004 		 *   contained within the write itself, thus we need to
5005 		 *   parse out the data again.
5006 		 *
5007 		 * - Call some other function once the data is in?
5008 		 */
5009 
5010 		/*
5011 		 * XXX KDM call ctl_scsiio() again for now, and check flag
5012 		 * bits to see whether we're allocated or not.
5013 		 */
5014 		retval = ctl_scsiio(&io->scsiio);
5015 	}
5016 	return (retval);
5017 }
5018 
5019 /*
5020  * This gets called by a backend driver when it is done with a
5021  * data_submit method.
5022  */
5023 void
5024 ctl_data_submit_done(union ctl_io *io)
5025 {
5026 	/*
5027 	 * If the IO_CONT flag is set, we need to call the supplied
5028 	 * function to continue processing the I/O, instead of completing
5029 	 * the I/O just yet.
5030 	 *
5031 	 * If there is an error, though, we don't want to keep processing.
5032 	 * Instead, just send status back to the initiator.
5033 	 */
5034 	if ((io->io_hdr.flags & CTL_FLAG_IO_CONT) &&
5035 	    (io->io_hdr.flags & CTL_FLAG_ABORT) == 0 &&
5036 	    ((io->io_hdr.status & CTL_STATUS_MASK) == CTL_STATUS_NONE ||
5037 	     (io->io_hdr.status & CTL_STATUS_MASK) == CTL_SUCCESS)) {
5038 		io->scsiio.io_cont(io);
5039 		return;
5040 	}
5041 	ctl_done(io);
5042 }
5043 
5044 /*
5045  * This gets called by a backend driver when it is done with a
5046  * configuration write.
5047  */
5048 void
5049 ctl_config_write_done(union ctl_io *io)
5050 {
5051 	uint8_t *buf;
5052 
5053 	/*
5054 	 * If the IO_CONT flag is set, we need to call the supplied
5055 	 * function to continue processing the I/O, instead of completing
5056 	 * the I/O just yet.
5057 	 *
5058 	 * If there is an error, though, we don't want to keep processing.
5059 	 * Instead, just send status back to the initiator.
5060 	 */
5061 	if ((io->io_hdr.flags & CTL_FLAG_IO_CONT) &&
5062 	    (io->io_hdr.flags & CTL_FLAG_ABORT) == 0 &&
5063 	    ((io->io_hdr.status & CTL_STATUS_MASK) == CTL_STATUS_NONE ||
5064 	     (io->io_hdr.status & CTL_STATUS_MASK) == CTL_SUCCESS)) {
5065 		io->scsiio.io_cont(io);
5066 		return;
5067 	}
5068 	/*
5069 	 * Since a configuration write can be done for commands that actually
5070 	 * have data allocated, like write buffer, and commands that have
5071 	 * no data, like start/stop unit, we need to check here.
5072 	 */
5073 	if (io->io_hdr.flags & CTL_FLAG_ALLOCATED)
5074 		buf = io->scsiio.kern_data_ptr;
5075 	else
5076 		buf = NULL;
5077 	ctl_done(io);
5078 	if (buf)
5079 		free(buf, M_CTL);
5080 }
5081 
5082 void
5083 ctl_config_read_done(union ctl_io *io)
5084 {
5085 	uint8_t *buf;
5086 
5087 	/*
5088 	 * If there is some error -- we are done, skip data transfer.
5089 	 */
5090 	if ((io->io_hdr.flags & CTL_FLAG_ABORT) != 0 ||
5091 	    ((io->io_hdr.status & CTL_STATUS_MASK) != CTL_STATUS_NONE &&
5092 	     (io->io_hdr.status & CTL_STATUS_MASK) != CTL_SUCCESS)) {
5093 		if (io->io_hdr.flags & CTL_FLAG_ALLOCATED)
5094 			buf = io->scsiio.kern_data_ptr;
5095 		else
5096 			buf = NULL;
5097 		ctl_done(io);
5098 		if (buf)
5099 			free(buf, M_CTL);
5100 		return;
5101 	}
5102 
5103 	/*
5104 	 * If the IO_CONT flag is set, we need to call the supplied
5105 	 * function to continue processing the I/O, instead of completing
5106 	 * the I/O just yet.
5107 	 */
5108 	if (io->io_hdr.flags & CTL_FLAG_IO_CONT) {
5109 		io->scsiio.io_cont(io);
5110 		return;
5111 	}
5112 
5113 	ctl_datamove(io);
5114 }
5115 
5116 /*
5117  * SCSI release command.
5118  */
5119 int
5120 ctl_scsi_release(struct ctl_scsiio *ctsio)
5121 {
5122 	struct ctl_lun *lun;
5123 	uint32_t residx;
5124 
5125 	CTL_DEBUG_PRINT(("ctl_scsi_release\n"));
5126 
5127 	residx = ctl_get_initindex(&ctsio->io_hdr.nexus);
5128 	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5129 
5130 	/*
5131 	 * XXX KDM right now, we only support LUN reservation.  We don't
5132 	 * support 3rd party reservations, or extent reservations, which
5133 	 * might actually need the parameter list.  If we've gotten this
5134 	 * far, we've got a LUN reservation.  Anything else got kicked out
5135 	 * above.  So, according to SPC, ignore the length.
5136 	 */
5137 
5138 	mtx_lock(&lun->lun_lock);
5139 
5140 	/*
5141 	 * According to SPC, it is not an error for an intiator to attempt
5142 	 * to release a reservation on a LUN that isn't reserved, or that
5143 	 * is reserved by another initiator.  The reservation can only be
5144 	 * released, though, by the initiator who made it or by one of
5145 	 * several reset type events.
5146 	 */
5147 	if ((lun->flags & CTL_LUN_RESERVED) && (lun->res_idx == residx))
5148 			lun->flags &= ~CTL_LUN_RESERVED;
5149 
5150 	mtx_unlock(&lun->lun_lock);
5151 
5152 	ctl_set_success(ctsio);
5153 	ctl_done((union ctl_io *)ctsio);
5154 	return (CTL_RETVAL_COMPLETE);
5155 }
5156 
5157 int
5158 ctl_scsi_reserve(struct ctl_scsiio *ctsio)
5159 {
5160 	struct ctl_lun *lun;
5161 	uint32_t residx;
5162 
5163 	CTL_DEBUG_PRINT(("ctl_reserve\n"));
5164 
5165 	residx = ctl_get_initindex(&ctsio->io_hdr.nexus);
5166 	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5167 
5168 	/*
5169 	 * XXX KDM right now, we only support LUN reservation.  We don't
5170 	 * support 3rd party reservations, or extent reservations, which
5171 	 * might actually need the parameter list.  If we've gotten this
5172 	 * far, we've got a LUN reservation.  Anything else got kicked out
5173 	 * above.  So, according to SPC, ignore the length.
5174 	 */
5175 
5176 	mtx_lock(&lun->lun_lock);
5177 	if ((lun->flags & CTL_LUN_RESERVED) && (lun->res_idx != residx)) {
5178 		ctl_set_reservation_conflict(ctsio);
5179 		goto bailout;
5180 	}
5181 
5182 	/* SPC-3 exceptions to SPC-2 RESERVE and RELEASE behavior. */
5183 	if (lun->flags & CTL_LUN_PR_RESERVED) {
5184 		ctl_set_success(ctsio);
5185 		goto bailout;
5186 	}
5187 
5188 	lun->flags |= CTL_LUN_RESERVED;
5189 	lun->res_idx = residx;
5190 	ctl_set_success(ctsio);
5191 
5192 bailout:
5193 	mtx_unlock(&lun->lun_lock);
5194 	ctl_done((union ctl_io *)ctsio);
5195 	return (CTL_RETVAL_COMPLETE);
5196 }
5197 
5198 int
5199 ctl_start_stop(struct ctl_scsiio *ctsio)
5200 {
5201 	struct scsi_start_stop_unit *cdb;
5202 	struct ctl_lun *lun;
5203 	int retval;
5204 
5205 	CTL_DEBUG_PRINT(("ctl_start_stop\n"));
5206 
5207 	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5208 	cdb = (struct scsi_start_stop_unit *)ctsio->cdb;
5209 
5210 	if ((cdb->how & SSS_PC_MASK) == 0) {
5211 		if ((lun->flags & CTL_LUN_PR_RESERVED) &&
5212 		    (cdb->how & SSS_START) == 0) {
5213 			uint32_t residx;
5214 
5215 			residx = ctl_get_initindex(&ctsio->io_hdr.nexus);
5216 			if (ctl_get_prkey(lun, residx) == 0 ||
5217 			    (lun->pr_res_idx != residx && lun->pr_res_type < 4)) {
5218 
5219 				ctl_set_reservation_conflict(ctsio);
5220 				ctl_done((union ctl_io *)ctsio);
5221 				return (CTL_RETVAL_COMPLETE);
5222 			}
5223 		}
5224 
5225 		if ((cdb->how & SSS_LOEJ) &&
5226 		    (lun->flags & CTL_LUN_REMOVABLE) == 0) {
5227 			ctl_set_invalid_field(ctsio,
5228 					      /*sks_valid*/ 1,
5229 					      /*command*/ 1,
5230 					      /*field*/ 4,
5231 					      /*bit_valid*/ 1,
5232 					      /*bit*/ 1);
5233 			ctl_done((union ctl_io *)ctsio);
5234 			return (CTL_RETVAL_COMPLETE);
5235 		}
5236 
5237 		if ((cdb->how & SSS_START) == 0 && (cdb->how & SSS_LOEJ) &&
5238 		    lun->prevent_count > 0) {
5239 			/* "Medium removal prevented" */
5240 			ctl_set_sense(ctsio, /*current_error*/ 1,
5241 			    /*sense_key*/(lun->flags & CTL_LUN_NO_MEDIA) ?
5242 			     SSD_KEY_NOT_READY : SSD_KEY_ILLEGAL_REQUEST,
5243 			    /*asc*/ 0x53, /*ascq*/ 0x02, SSD_ELEM_NONE);
5244 			ctl_done((union ctl_io *)ctsio);
5245 			return (CTL_RETVAL_COMPLETE);
5246 		}
5247 	}
5248 
5249 	retval = lun->backend->config_write((union ctl_io *)ctsio);
5250 	return (retval);
5251 }
5252 
5253 int
5254 ctl_prevent_allow(struct ctl_scsiio *ctsio)
5255 {
5256 	struct ctl_lun *lun;
5257 	struct scsi_prevent *cdb;
5258 	int retval;
5259 	uint32_t initidx;
5260 
5261 	CTL_DEBUG_PRINT(("ctl_prevent_allow\n"));
5262 
5263 	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5264 	cdb = (struct scsi_prevent *)ctsio->cdb;
5265 
5266 	if ((lun->flags & CTL_LUN_REMOVABLE) == 0) {
5267 		ctl_set_invalid_opcode(ctsio);
5268 		ctl_done((union ctl_io *)ctsio);
5269 		return (CTL_RETVAL_COMPLETE);
5270 	}
5271 
5272 	initidx = ctl_get_initindex(&ctsio->io_hdr.nexus);
5273 	mtx_lock(&lun->lun_lock);
5274 	if ((cdb->how & PR_PREVENT) &&
5275 	    ctl_is_set(lun->prevent, initidx) == 0) {
5276 		ctl_set_mask(lun->prevent, initidx);
5277 		lun->prevent_count++;
5278 	} else if ((cdb->how & PR_PREVENT) == 0 &&
5279 	    ctl_is_set(lun->prevent, initidx)) {
5280 		ctl_clear_mask(lun->prevent, initidx);
5281 		lun->prevent_count--;
5282 	}
5283 	mtx_unlock(&lun->lun_lock);
5284 	retval = lun->backend->config_write((union ctl_io *)ctsio);
5285 	return (retval);
5286 }
5287 
5288 /*
5289  * We support the SYNCHRONIZE CACHE command (10 and 16 byte versions), but
5290  * we don't really do anything with the LBA and length fields if the user
5291  * passes them in.  Instead we'll just flush out the cache for the entire
5292  * LUN.
5293  */
5294 int
5295 ctl_sync_cache(struct ctl_scsiio *ctsio)
5296 {
5297 	struct ctl_lun *lun;
5298 	struct ctl_softc *softc;
5299 	struct ctl_lba_len_flags *lbalen;
5300 	uint64_t starting_lba;
5301 	uint32_t block_count;
5302 	int retval;
5303 	uint8_t byte2;
5304 
5305 	CTL_DEBUG_PRINT(("ctl_sync_cache\n"));
5306 
5307 	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5308 	softc = lun->ctl_softc;
5309 	retval = 0;
5310 
5311 	switch (ctsio->cdb[0]) {
5312 	case SYNCHRONIZE_CACHE: {
5313 		struct scsi_sync_cache *cdb;
5314 		cdb = (struct scsi_sync_cache *)ctsio->cdb;
5315 
5316 		starting_lba = scsi_4btoul(cdb->begin_lba);
5317 		block_count = scsi_2btoul(cdb->lb_count);
5318 		byte2 = cdb->byte2;
5319 		break;
5320 	}
5321 	case SYNCHRONIZE_CACHE_16: {
5322 		struct scsi_sync_cache_16 *cdb;
5323 		cdb = (struct scsi_sync_cache_16 *)ctsio->cdb;
5324 
5325 		starting_lba = scsi_8btou64(cdb->begin_lba);
5326 		block_count = scsi_4btoul(cdb->lb_count);
5327 		byte2 = cdb->byte2;
5328 		break;
5329 	}
5330 	default:
5331 		ctl_set_invalid_opcode(ctsio);
5332 		ctl_done((union ctl_io *)ctsio);
5333 		goto bailout;
5334 		break; /* NOTREACHED */
5335 	}
5336 
5337 	/*
5338 	 * We check the LBA and length, but don't do anything with them.
5339 	 * A SYNCHRONIZE CACHE will cause the entire cache for this lun to
5340 	 * get flushed.  This check will just help satisfy anyone who wants
5341 	 * to see an error for an out of range LBA.
5342 	 */
5343 	if ((starting_lba + block_count) > (lun->be_lun->maxlba + 1)) {
5344 		ctl_set_lba_out_of_range(ctsio);
5345 		ctl_done((union ctl_io *)ctsio);
5346 		goto bailout;
5347 	}
5348 
5349 	lbalen = (struct ctl_lba_len_flags *)&ctsio->io_hdr.ctl_private[CTL_PRIV_LBA_LEN];
5350 	lbalen->lba = starting_lba;
5351 	lbalen->len = block_count;
5352 	lbalen->flags = byte2;
5353 	retval = lun->backend->config_write((union ctl_io *)ctsio);
5354 
5355 bailout:
5356 	return (retval);
5357 }
5358 
5359 int
5360 ctl_format(struct ctl_scsiio *ctsio)
5361 {
5362 	struct scsi_format *cdb;
5363 	struct ctl_lun *lun;
5364 	int length, defect_list_len;
5365 
5366 	CTL_DEBUG_PRINT(("ctl_format\n"));
5367 
5368 	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5369 
5370 	cdb = (struct scsi_format *)ctsio->cdb;
5371 
5372 	length = 0;
5373 	if (cdb->byte2 & SF_FMTDATA) {
5374 		if (cdb->byte2 & SF_LONGLIST)
5375 			length = sizeof(struct scsi_format_header_long);
5376 		else
5377 			length = sizeof(struct scsi_format_header_short);
5378 	}
5379 
5380 	if (((ctsio->io_hdr.flags & CTL_FLAG_ALLOCATED) == 0)
5381 	 && (length > 0)) {
5382 		ctsio->kern_data_ptr = malloc(length, M_CTL, M_WAITOK);
5383 		ctsio->kern_data_len = length;
5384 		ctsio->kern_total_len = length;
5385 		ctsio->kern_data_resid = 0;
5386 		ctsio->kern_rel_offset = 0;
5387 		ctsio->kern_sg_entries = 0;
5388 		ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
5389 		ctsio->be_move_done = ctl_config_move_done;
5390 		ctl_datamove((union ctl_io *)ctsio);
5391 
5392 		return (CTL_RETVAL_COMPLETE);
5393 	}
5394 
5395 	defect_list_len = 0;
5396 
5397 	if (cdb->byte2 & SF_FMTDATA) {
5398 		if (cdb->byte2 & SF_LONGLIST) {
5399 			struct scsi_format_header_long *header;
5400 
5401 			header = (struct scsi_format_header_long *)
5402 				ctsio->kern_data_ptr;
5403 
5404 			defect_list_len = scsi_4btoul(header->defect_list_len);
5405 			if (defect_list_len != 0) {
5406 				ctl_set_invalid_field(ctsio,
5407 						      /*sks_valid*/ 1,
5408 						      /*command*/ 0,
5409 						      /*field*/ 2,
5410 						      /*bit_valid*/ 0,
5411 						      /*bit*/ 0);
5412 				goto bailout;
5413 			}
5414 		} else {
5415 			struct scsi_format_header_short *header;
5416 
5417 			header = (struct scsi_format_header_short *)
5418 				ctsio->kern_data_ptr;
5419 
5420 			defect_list_len = scsi_2btoul(header->defect_list_len);
5421 			if (defect_list_len != 0) {
5422 				ctl_set_invalid_field(ctsio,
5423 						      /*sks_valid*/ 1,
5424 						      /*command*/ 0,
5425 						      /*field*/ 2,
5426 						      /*bit_valid*/ 0,
5427 						      /*bit*/ 0);
5428 				goto bailout;
5429 			}
5430 		}
5431 	}
5432 
5433 	ctl_set_success(ctsio);
5434 bailout:
5435 
5436 	if (ctsio->io_hdr.flags & CTL_FLAG_ALLOCATED) {
5437 		free(ctsio->kern_data_ptr, M_CTL);
5438 		ctsio->io_hdr.flags &= ~CTL_FLAG_ALLOCATED;
5439 	}
5440 
5441 	ctl_done((union ctl_io *)ctsio);
5442 	return (CTL_RETVAL_COMPLETE);
5443 }
5444 
5445 int
5446 ctl_read_buffer(struct ctl_scsiio *ctsio)
5447 {
5448 	struct ctl_lun *lun;
5449 	uint64_t buffer_offset;
5450 	uint32_t len;
5451 	uint8_t byte2;
5452 	static uint8_t descr[4];
5453 	static uint8_t echo_descr[4] = { 0 };
5454 
5455 	CTL_DEBUG_PRINT(("ctl_read_buffer\n"));
5456 	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5457 	switch (ctsio->cdb[0]) {
5458 	case READ_BUFFER: {
5459 		struct scsi_read_buffer *cdb;
5460 
5461 		cdb = (struct scsi_read_buffer *)ctsio->cdb;
5462 		buffer_offset = scsi_3btoul(cdb->offset);
5463 		len = scsi_3btoul(cdb->length);
5464 		byte2 = cdb->byte2;
5465 		break;
5466 	}
5467 	case READ_BUFFER_16: {
5468 		struct scsi_read_buffer_16 *cdb;
5469 
5470 		cdb = (struct scsi_read_buffer_16 *)ctsio->cdb;
5471 		buffer_offset = scsi_8btou64(cdb->offset);
5472 		len = scsi_4btoul(cdb->length);
5473 		byte2 = cdb->byte2;
5474 		break;
5475 	}
5476 	default: /* This shouldn't happen. */
5477 		ctl_set_invalid_opcode(ctsio);
5478 		ctl_done((union ctl_io *)ctsio);
5479 		return (CTL_RETVAL_COMPLETE);
5480 	}
5481 
5482 	if ((byte2 & RWB_MODE) != RWB_MODE_DATA &&
5483 	    (byte2 & RWB_MODE) != RWB_MODE_ECHO_DESCR &&
5484 	    (byte2 & RWB_MODE) != RWB_MODE_DESCR) {
5485 		ctl_set_invalid_field(ctsio,
5486 				      /*sks_valid*/ 1,
5487 				      /*command*/ 1,
5488 				      /*field*/ 1,
5489 				      /*bit_valid*/ 1,
5490 				      /*bit*/ 4);
5491 		ctl_done((union ctl_io *)ctsio);
5492 		return (CTL_RETVAL_COMPLETE);
5493 	}
5494 
5495 	if (buffer_offset > CTL_WRITE_BUFFER_SIZE ||
5496 	    buffer_offset + len > CTL_WRITE_BUFFER_SIZE) {
5497 		ctl_set_invalid_field(ctsio,
5498 				      /*sks_valid*/ 1,
5499 				      /*command*/ 1,
5500 				      /*field*/ 6,
5501 				      /*bit_valid*/ 0,
5502 				      /*bit*/ 0);
5503 		ctl_done((union ctl_io *)ctsio);
5504 		return (CTL_RETVAL_COMPLETE);
5505 	}
5506 
5507 	if ((byte2 & RWB_MODE) == RWB_MODE_DESCR) {
5508 		descr[0] = 0;
5509 		scsi_ulto3b(CTL_WRITE_BUFFER_SIZE, &descr[1]);
5510 		ctsio->kern_data_ptr = descr;
5511 		len = min(len, sizeof(descr));
5512 	} else if ((byte2 & RWB_MODE) == RWB_MODE_ECHO_DESCR) {
5513 		ctsio->kern_data_ptr = echo_descr;
5514 		len = min(len, sizeof(echo_descr));
5515 	} else {
5516 		if (lun->write_buffer == NULL) {
5517 			lun->write_buffer = malloc(CTL_WRITE_BUFFER_SIZE,
5518 			    M_CTL, M_WAITOK);
5519 		}
5520 		ctsio->kern_data_ptr = lun->write_buffer + buffer_offset;
5521 	}
5522 	ctsio->kern_data_len = len;
5523 	ctsio->kern_total_len = len;
5524 	ctsio->kern_data_resid = 0;
5525 	ctsio->kern_rel_offset = 0;
5526 	ctsio->kern_sg_entries = 0;
5527 	ctl_set_success(ctsio);
5528 	ctsio->be_move_done = ctl_config_move_done;
5529 	ctl_datamove((union ctl_io *)ctsio);
5530 	return (CTL_RETVAL_COMPLETE);
5531 }
5532 
5533 int
5534 ctl_write_buffer(struct ctl_scsiio *ctsio)
5535 {
5536 	struct scsi_write_buffer *cdb;
5537 	struct ctl_lun *lun;
5538 	int buffer_offset, len;
5539 
5540 	CTL_DEBUG_PRINT(("ctl_write_buffer\n"));
5541 
5542 	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5543 	cdb = (struct scsi_write_buffer *)ctsio->cdb;
5544 
5545 	if ((cdb->byte2 & RWB_MODE) != RWB_MODE_DATA) {
5546 		ctl_set_invalid_field(ctsio,
5547 				      /*sks_valid*/ 1,
5548 				      /*command*/ 1,
5549 				      /*field*/ 1,
5550 				      /*bit_valid*/ 1,
5551 				      /*bit*/ 4);
5552 		ctl_done((union ctl_io *)ctsio);
5553 		return (CTL_RETVAL_COMPLETE);
5554 	}
5555 
5556 	len = scsi_3btoul(cdb->length);
5557 	buffer_offset = scsi_3btoul(cdb->offset);
5558 
5559 	if (buffer_offset + len > CTL_WRITE_BUFFER_SIZE) {
5560 		ctl_set_invalid_field(ctsio,
5561 				      /*sks_valid*/ 1,
5562 				      /*command*/ 1,
5563 				      /*field*/ 6,
5564 				      /*bit_valid*/ 0,
5565 				      /*bit*/ 0);
5566 		ctl_done((union ctl_io *)ctsio);
5567 		return (CTL_RETVAL_COMPLETE);
5568 	}
5569 
5570 	/*
5571 	 * If we've got a kernel request that hasn't been malloced yet,
5572 	 * malloc it and tell the caller the data buffer is here.
5573 	 */
5574 	if ((ctsio->io_hdr.flags & CTL_FLAG_ALLOCATED) == 0) {
5575 		if (lun->write_buffer == NULL) {
5576 			lun->write_buffer = malloc(CTL_WRITE_BUFFER_SIZE,
5577 			    M_CTL, M_WAITOK);
5578 		}
5579 		ctsio->kern_data_ptr = lun->write_buffer + buffer_offset;
5580 		ctsio->kern_data_len = len;
5581 		ctsio->kern_total_len = len;
5582 		ctsio->kern_data_resid = 0;
5583 		ctsio->kern_rel_offset = 0;
5584 		ctsio->kern_sg_entries = 0;
5585 		ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
5586 		ctsio->be_move_done = ctl_config_move_done;
5587 		ctl_datamove((union ctl_io *)ctsio);
5588 
5589 		return (CTL_RETVAL_COMPLETE);
5590 	}
5591 
5592 	ctl_set_success(ctsio);
5593 	ctl_done((union ctl_io *)ctsio);
5594 	return (CTL_RETVAL_COMPLETE);
5595 }
5596 
5597 int
5598 ctl_write_same(struct ctl_scsiio *ctsio)
5599 {
5600 	struct ctl_lun *lun;
5601 	struct ctl_lba_len_flags *lbalen;
5602 	uint64_t lba;
5603 	uint32_t num_blocks;
5604 	int len, retval;
5605 	uint8_t byte2;
5606 
5607 	CTL_DEBUG_PRINT(("ctl_write_same\n"));
5608 
5609 	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5610 
5611 	switch (ctsio->cdb[0]) {
5612 	case WRITE_SAME_10: {
5613 		struct scsi_write_same_10 *cdb;
5614 
5615 		cdb = (struct scsi_write_same_10 *)ctsio->cdb;
5616 
5617 		lba = scsi_4btoul(cdb->addr);
5618 		num_blocks = scsi_2btoul(cdb->length);
5619 		byte2 = cdb->byte2;
5620 		break;
5621 	}
5622 	case WRITE_SAME_16: {
5623 		struct scsi_write_same_16 *cdb;
5624 
5625 		cdb = (struct scsi_write_same_16 *)ctsio->cdb;
5626 
5627 		lba = scsi_8btou64(cdb->addr);
5628 		num_blocks = scsi_4btoul(cdb->length);
5629 		byte2 = cdb->byte2;
5630 		break;
5631 	}
5632 	default:
5633 		/*
5634 		 * We got a command we don't support.  This shouldn't
5635 		 * happen, commands should be filtered out above us.
5636 		 */
5637 		ctl_set_invalid_opcode(ctsio);
5638 		ctl_done((union ctl_io *)ctsio);
5639 
5640 		return (CTL_RETVAL_COMPLETE);
5641 		break; /* NOTREACHED */
5642 	}
5643 
5644 	/* ANCHOR flag can be used only together with UNMAP */
5645 	if ((byte2 & SWS_UNMAP) == 0 && (byte2 & SWS_ANCHOR) != 0) {
5646 		ctl_set_invalid_field(ctsio, /*sks_valid*/ 1,
5647 		    /*command*/ 1, /*field*/ 1, /*bit_valid*/ 1, /*bit*/ 0);
5648 		ctl_done((union ctl_io *)ctsio);
5649 		return (CTL_RETVAL_COMPLETE);
5650 	}
5651 
5652 	/*
5653 	 * The first check is to make sure we're in bounds, the second
5654 	 * check is to catch wrap-around problems.  If the lba + num blocks
5655 	 * is less than the lba, then we've wrapped around and the block
5656 	 * range is invalid anyway.
5657 	 */
5658 	if (((lba + num_blocks) > (lun->be_lun->maxlba + 1))
5659 	 || ((lba + num_blocks) < lba)) {
5660 		ctl_set_lba_out_of_range(ctsio);
5661 		ctl_done((union ctl_io *)ctsio);
5662 		return (CTL_RETVAL_COMPLETE);
5663 	}
5664 
5665 	/* Zero number of blocks means "to the last logical block" */
5666 	if (num_blocks == 0) {
5667 		if ((lun->be_lun->maxlba + 1) - lba > UINT32_MAX) {
5668 			ctl_set_invalid_field(ctsio,
5669 					      /*sks_valid*/ 0,
5670 					      /*command*/ 1,
5671 					      /*field*/ 0,
5672 					      /*bit_valid*/ 0,
5673 					      /*bit*/ 0);
5674 			ctl_done((union ctl_io *)ctsio);
5675 			return (CTL_RETVAL_COMPLETE);
5676 		}
5677 		num_blocks = (lun->be_lun->maxlba + 1) - lba;
5678 	}
5679 
5680 	len = lun->be_lun->blocksize;
5681 
5682 	/*
5683 	 * If we've got a kernel request that hasn't been malloced yet,
5684 	 * malloc it and tell the caller the data buffer is here.
5685 	 */
5686 	if ((byte2 & SWS_NDOB) == 0 &&
5687 	    (ctsio->io_hdr.flags & CTL_FLAG_ALLOCATED) == 0) {
5688 		ctsio->kern_data_ptr = malloc(len, M_CTL, M_WAITOK);;
5689 		ctsio->kern_data_len = len;
5690 		ctsio->kern_total_len = len;
5691 		ctsio->kern_data_resid = 0;
5692 		ctsio->kern_rel_offset = 0;
5693 		ctsio->kern_sg_entries = 0;
5694 		ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
5695 		ctsio->be_move_done = ctl_config_move_done;
5696 		ctl_datamove((union ctl_io *)ctsio);
5697 
5698 		return (CTL_RETVAL_COMPLETE);
5699 	}
5700 
5701 	lbalen = (struct ctl_lba_len_flags *)&ctsio->io_hdr.ctl_private[CTL_PRIV_LBA_LEN];
5702 	lbalen->lba = lba;
5703 	lbalen->len = num_blocks;
5704 	lbalen->flags = byte2;
5705 	retval = lun->backend->config_write((union ctl_io *)ctsio);
5706 
5707 	return (retval);
5708 }
5709 
5710 int
5711 ctl_unmap(struct ctl_scsiio *ctsio)
5712 {
5713 	struct ctl_lun *lun;
5714 	struct scsi_unmap *cdb;
5715 	struct ctl_ptr_len_flags *ptrlen;
5716 	struct scsi_unmap_header *hdr;
5717 	struct scsi_unmap_desc *buf, *end, *endnz, *range;
5718 	uint64_t lba;
5719 	uint32_t num_blocks;
5720 	int len, retval;
5721 	uint8_t byte2;
5722 
5723 	CTL_DEBUG_PRINT(("ctl_unmap\n"));
5724 
5725 	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5726 	cdb = (struct scsi_unmap *)ctsio->cdb;
5727 
5728 	len = scsi_2btoul(cdb->length);
5729 	byte2 = cdb->byte2;
5730 
5731 	/*
5732 	 * If we've got a kernel request that hasn't been malloced yet,
5733 	 * malloc it and tell the caller the data buffer is here.
5734 	 */
5735 	if ((ctsio->io_hdr.flags & CTL_FLAG_ALLOCATED) == 0) {
5736 		ctsio->kern_data_ptr = malloc(len, M_CTL, M_WAITOK);;
5737 		ctsio->kern_data_len = len;
5738 		ctsio->kern_total_len = len;
5739 		ctsio->kern_data_resid = 0;
5740 		ctsio->kern_rel_offset = 0;
5741 		ctsio->kern_sg_entries = 0;
5742 		ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
5743 		ctsio->be_move_done = ctl_config_move_done;
5744 		ctl_datamove((union ctl_io *)ctsio);
5745 
5746 		return (CTL_RETVAL_COMPLETE);
5747 	}
5748 
5749 	len = ctsio->kern_total_len - ctsio->kern_data_resid;
5750 	hdr = (struct scsi_unmap_header *)ctsio->kern_data_ptr;
5751 	if (len < sizeof (*hdr) ||
5752 	    len < (scsi_2btoul(hdr->length) + sizeof(hdr->length)) ||
5753 	    len < (scsi_2btoul(hdr->desc_length) + sizeof (*hdr)) ||
5754 	    scsi_2btoul(hdr->desc_length) % sizeof(*buf) != 0) {
5755 		ctl_set_invalid_field(ctsio,
5756 				      /*sks_valid*/ 0,
5757 				      /*command*/ 0,
5758 				      /*field*/ 0,
5759 				      /*bit_valid*/ 0,
5760 				      /*bit*/ 0);
5761 		goto done;
5762 	}
5763 	len = scsi_2btoul(hdr->desc_length);
5764 	buf = (struct scsi_unmap_desc *)(hdr + 1);
5765 	end = buf + len / sizeof(*buf);
5766 
5767 	endnz = buf;
5768 	for (range = buf; range < end; range++) {
5769 		lba = scsi_8btou64(range->lba);
5770 		num_blocks = scsi_4btoul(range->length);
5771 		if (((lba + num_blocks) > (lun->be_lun->maxlba + 1))
5772 		 || ((lba + num_blocks) < lba)) {
5773 			ctl_set_lba_out_of_range(ctsio);
5774 			ctl_done((union ctl_io *)ctsio);
5775 			return (CTL_RETVAL_COMPLETE);
5776 		}
5777 		if (num_blocks != 0)
5778 			endnz = range + 1;
5779 	}
5780 
5781 	/*
5782 	 * Block backend can not handle zero last range.
5783 	 * Filter it out and return if there is nothing left.
5784 	 */
5785 	len = (uint8_t *)endnz - (uint8_t *)buf;
5786 	if (len == 0) {
5787 		ctl_set_success(ctsio);
5788 		goto done;
5789 	}
5790 
5791 	mtx_lock(&lun->lun_lock);
5792 	ptrlen = (struct ctl_ptr_len_flags *)
5793 	    &ctsio->io_hdr.ctl_private[CTL_PRIV_LBA_LEN];
5794 	ptrlen->ptr = (void *)buf;
5795 	ptrlen->len = len;
5796 	ptrlen->flags = byte2;
5797 	ctl_check_blocked(lun);
5798 	mtx_unlock(&lun->lun_lock);
5799 
5800 	retval = lun->backend->config_write((union ctl_io *)ctsio);
5801 	return (retval);
5802 
5803 done:
5804 	if (ctsio->io_hdr.flags & CTL_FLAG_ALLOCATED) {
5805 		free(ctsio->kern_data_ptr, M_CTL);
5806 		ctsio->io_hdr.flags &= ~CTL_FLAG_ALLOCATED;
5807 	}
5808 	ctl_done((union ctl_io *)ctsio);
5809 	return (CTL_RETVAL_COMPLETE);
5810 }
5811 
5812 /*
5813  * Note that this function currently doesn't actually do anything inside
5814  * CTL to enforce things if the DQue bit is turned on.
5815  *
5816  * Also note that this function can't be used in the default case, because
5817  * the DQue bit isn't set in the changeable mask for the control mode page
5818  * anyway.  This is just here as an example for how to implement a page
5819  * handler, and a placeholder in case we want to allow the user to turn
5820  * tagged queueing on and off.
5821  *
5822  * The D_SENSE bit handling is functional, however, and will turn
5823  * descriptor sense on and off for a given LUN.
5824  */
5825 int
5826 ctl_control_page_handler(struct ctl_scsiio *ctsio,
5827 			 struct ctl_page_index *page_index, uint8_t *page_ptr)
5828 {
5829 	struct scsi_control_page *current_cp, *saved_cp, *user_cp;
5830 	struct ctl_lun *lun;
5831 	int set_ua;
5832 	uint32_t initidx;
5833 
5834 	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5835 	initidx = ctl_get_initindex(&ctsio->io_hdr.nexus);
5836 	set_ua = 0;
5837 
5838 	user_cp = (struct scsi_control_page *)page_ptr;
5839 	current_cp = (struct scsi_control_page *)
5840 		(page_index->page_data + (page_index->page_len *
5841 		CTL_PAGE_CURRENT));
5842 	saved_cp = (struct scsi_control_page *)
5843 		(page_index->page_data + (page_index->page_len *
5844 		CTL_PAGE_SAVED));
5845 
5846 	mtx_lock(&lun->lun_lock);
5847 	if (((current_cp->rlec & SCP_DSENSE) == 0)
5848 	 && ((user_cp->rlec & SCP_DSENSE) != 0)) {
5849 		/*
5850 		 * Descriptor sense is currently turned off and the user
5851 		 * wants to turn it on.
5852 		 */
5853 		current_cp->rlec |= SCP_DSENSE;
5854 		saved_cp->rlec |= SCP_DSENSE;
5855 		lun->flags |= CTL_LUN_SENSE_DESC;
5856 		set_ua = 1;
5857 	} else if (((current_cp->rlec & SCP_DSENSE) != 0)
5858 		&& ((user_cp->rlec & SCP_DSENSE) == 0)) {
5859 		/*
5860 		 * Descriptor sense is currently turned on, and the user
5861 		 * wants to turn it off.
5862 		 */
5863 		current_cp->rlec &= ~SCP_DSENSE;
5864 		saved_cp->rlec &= ~SCP_DSENSE;
5865 		lun->flags &= ~CTL_LUN_SENSE_DESC;
5866 		set_ua = 1;
5867 	}
5868 	if ((current_cp->queue_flags & SCP_QUEUE_ALG_MASK) !=
5869 	    (user_cp->queue_flags & SCP_QUEUE_ALG_MASK)) {
5870 		current_cp->queue_flags &= ~SCP_QUEUE_ALG_MASK;
5871 		current_cp->queue_flags |= user_cp->queue_flags & SCP_QUEUE_ALG_MASK;
5872 		saved_cp->queue_flags &= ~SCP_QUEUE_ALG_MASK;
5873 		saved_cp->queue_flags |= user_cp->queue_flags & SCP_QUEUE_ALG_MASK;
5874 		set_ua = 1;
5875 	}
5876 	if ((current_cp->eca_and_aen & SCP_SWP) !=
5877 	    (user_cp->eca_and_aen & SCP_SWP)) {
5878 		current_cp->eca_and_aen &= ~SCP_SWP;
5879 		current_cp->eca_and_aen |= user_cp->eca_and_aen & SCP_SWP;
5880 		saved_cp->eca_and_aen &= ~SCP_SWP;
5881 		saved_cp->eca_and_aen |= user_cp->eca_and_aen & SCP_SWP;
5882 		set_ua = 1;
5883 	}
5884 	if (set_ua != 0)
5885 		ctl_est_ua_all(lun, initidx, CTL_UA_MODE_CHANGE);
5886 	mtx_unlock(&lun->lun_lock);
5887 	if (set_ua) {
5888 		ctl_isc_announce_mode(lun,
5889 		    ctl_get_initindex(&ctsio->io_hdr.nexus),
5890 		    page_index->page_code, page_index->subpage);
5891 	}
5892 	return (0);
5893 }
5894 
5895 int
5896 ctl_caching_sp_handler(struct ctl_scsiio *ctsio,
5897 		     struct ctl_page_index *page_index, uint8_t *page_ptr)
5898 {
5899 	struct scsi_caching_page *current_cp, *saved_cp, *user_cp;
5900 	struct ctl_lun *lun;
5901 	int set_ua;
5902 	uint32_t initidx;
5903 
5904 	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5905 	initidx = ctl_get_initindex(&ctsio->io_hdr.nexus);
5906 	set_ua = 0;
5907 
5908 	user_cp = (struct scsi_caching_page *)page_ptr;
5909 	current_cp = (struct scsi_caching_page *)
5910 		(page_index->page_data + (page_index->page_len *
5911 		CTL_PAGE_CURRENT));
5912 	saved_cp = (struct scsi_caching_page *)
5913 		(page_index->page_data + (page_index->page_len *
5914 		CTL_PAGE_SAVED));
5915 
5916 	mtx_lock(&lun->lun_lock);
5917 	if ((current_cp->flags1 & (SCP_WCE | SCP_RCD)) !=
5918 	    (user_cp->flags1 & (SCP_WCE | SCP_RCD))) {
5919 		current_cp->flags1 &= ~(SCP_WCE | SCP_RCD);
5920 		current_cp->flags1 |= user_cp->flags1 & (SCP_WCE | SCP_RCD);
5921 		saved_cp->flags1 &= ~(SCP_WCE | SCP_RCD);
5922 		saved_cp->flags1 |= user_cp->flags1 & (SCP_WCE | SCP_RCD);
5923 		set_ua = 1;
5924 	}
5925 	if (set_ua != 0)
5926 		ctl_est_ua_all(lun, initidx, CTL_UA_MODE_CHANGE);
5927 	mtx_unlock(&lun->lun_lock);
5928 	if (set_ua) {
5929 		ctl_isc_announce_mode(lun,
5930 		    ctl_get_initindex(&ctsio->io_hdr.nexus),
5931 		    page_index->page_code, page_index->subpage);
5932 	}
5933 	return (0);
5934 }
5935 
5936 int
5937 ctl_debugconf_sp_select_handler(struct ctl_scsiio *ctsio,
5938 				struct ctl_page_index *page_index,
5939 				uint8_t *page_ptr)
5940 {
5941 	uint8_t *c;
5942 	int i;
5943 
5944 	c = ((struct copan_debugconf_subpage *)page_ptr)->ctl_time_io_secs;
5945 	ctl_time_io_secs =
5946 		(c[0] << 8) |
5947 		(c[1] << 0) |
5948 		0;
5949 	CTL_DEBUG_PRINT(("set ctl_time_io_secs to %d\n", ctl_time_io_secs));
5950 	printf("set ctl_time_io_secs to %d\n", ctl_time_io_secs);
5951 	printf("page data:");
5952 	for (i=0; i<8; i++)
5953 		printf(" %.2x",page_ptr[i]);
5954 	printf("\n");
5955 	return (0);
5956 }
5957 
5958 int
5959 ctl_debugconf_sp_sense_handler(struct ctl_scsiio *ctsio,
5960 			       struct ctl_page_index *page_index,
5961 			       int pc)
5962 {
5963 	struct copan_debugconf_subpage *page;
5964 
5965 	page = (struct copan_debugconf_subpage *)page_index->page_data +
5966 		(page_index->page_len * pc);
5967 
5968 	switch (pc) {
5969 	case SMS_PAGE_CTRL_CHANGEABLE >> 6:
5970 	case SMS_PAGE_CTRL_DEFAULT >> 6:
5971 	case SMS_PAGE_CTRL_SAVED >> 6:
5972 		/*
5973 		 * We don't update the changable or default bits for this page.
5974 		 */
5975 		break;
5976 	case SMS_PAGE_CTRL_CURRENT >> 6:
5977 		page->ctl_time_io_secs[0] = ctl_time_io_secs >> 8;
5978 		page->ctl_time_io_secs[1] = ctl_time_io_secs >> 0;
5979 		break;
5980 	default:
5981 		break;
5982 	}
5983 	return (0);
5984 }
5985 
5986 
5987 static int
5988 ctl_do_mode_select(union ctl_io *io)
5989 {
5990 	struct scsi_mode_page_header *page_header;
5991 	struct ctl_page_index *page_index;
5992 	struct ctl_scsiio *ctsio;
5993 	int page_len, page_len_offset, page_len_size;
5994 	union ctl_modepage_info *modepage_info;
5995 	struct ctl_lun *lun;
5996 	int *len_left, *len_used;
5997 	int retval, i;
5998 
5999 	ctsio = &io->scsiio;
6000 	page_index = NULL;
6001 	page_len = 0;
6002 	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
6003 
6004 	modepage_info = (union ctl_modepage_info *)
6005 		ctsio->io_hdr.ctl_private[CTL_PRIV_MODEPAGE].bytes;
6006 	len_left = &modepage_info->header.len_left;
6007 	len_used = &modepage_info->header.len_used;
6008 
6009 do_next_page:
6010 
6011 	page_header = (struct scsi_mode_page_header *)
6012 		(ctsio->kern_data_ptr + *len_used);
6013 
6014 	if (*len_left == 0) {
6015 		free(ctsio->kern_data_ptr, M_CTL);
6016 		ctl_set_success(ctsio);
6017 		ctl_done((union ctl_io *)ctsio);
6018 		return (CTL_RETVAL_COMPLETE);
6019 	} else if (*len_left < sizeof(struct scsi_mode_page_header)) {
6020 
6021 		free(ctsio->kern_data_ptr, M_CTL);
6022 		ctl_set_param_len_error(ctsio);
6023 		ctl_done((union ctl_io *)ctsio);
6024 		return (CTL_RETVAL_COMPLETE);
6025 
6026 	} else if ((page_header->page_code & SMPH_SPF)
6027 		&& (*len_left < sizeof(struct scsi_mode_page_header_sp))) {
6028 
6029 		free(ctsio->kern_data_ptr, M_CTL);
6030 		ctl_set_param_len_error(ctsio);
6031 		ctl_done((union ctl_io *)ctsio);
6032 		return (CTL_RETVAL_COMPLETE);
6033 	}
6034 
6035 
6036 	/*
6037 	 * XXX KDM should we do something with the block descriptor?
6038 	 */
6039 	for (i = 0; i < CTL_NUM_MODE_PAGES; i++) {
6040 		page_index = &lun->mode_pages.index[i];
6041 		if (lun->be_lun->lun_type == T_DIRECT &&
6042 		    (page_index->page_flags & CTL_PAGE_FLAG_DIRECT) == 0)
6043 			continue;
6044 		if (lun->be_lun->lun_type == T_PROCESSOR &&
6045 		    (page_index->page_flags & CTL_PAGE_FLAG_PROC) == 0)
6046 			continue;
6047 		if (lun->be_lun->lun_type == T_CDROM &&
6048 		    (page_index->page_flags & CTL_PAGE_FLAG_CDROM) == 0)
6049 			continue;
6050 
6051 		if ((page_index->page_code & SMPH_PC_MASK) !=
6052 		    (page_header->page_code & SMPH_PC_MASK))
6053 			continue;
6054 
6055 		/*
6056 		 * If neither page has a subpage code, then we've got a
6057 		 * match.
6058 		 */
6059 		if (((page_index->page_code & SMPH_SPF) == 0)
6060 		 && ((page_header->page_code & SMPH_SPF) == 0)) {
6061 			page_len = page_header->page_length;
6062 			break;
6063 		}
6064 
6065 		/*
6066 		 * If both pages have subpages, then the subpage numbers
6067 		 * have to match.
6068 		 */
6069 		if ((page_index->page_code & SMPH_SPF)
6070 		  && (page_header->page_code & SMPH_SPF)) {
6071 			struct scsi_mode_page_header_sp *sph;
6072 
6073 			sph = (struct scsi_mode_page_header_sp *)page_header;
6074 			if (page_index->subpage == sph->subpage) {
6075 				page_len = scsi_2btoul(sph->page_length);
6076 				break;
6077 			}
6078 		}
6079 	}
6080 
6081 	/*
6082 	 * If we couldn't find the page, or if we don't have a mode select
6083 	 * handler for it, send back an error to the user.
6084 	 */
6085 	if ((i >= CTL_NUM_MODE_PAGES)
6086 	 || (page_index->select_handler == NULL)) {
6087 		ctl_set_invalid_field(ctsio,
6088 				      /*sks_valid*/ 1,
6089 				      /*command*/ 0,
6090 				      /*field*/ *len_used,
6091 				      /*bit_valid*/ 0,
6092 				      /*bit*/ 0);
6093 		free(ctsio->kern_data_ptr, M_CTL);
6094 		ctl_done((union ctl_io *)ctsio);
6095 		return (CTL_RETVAL_COMPLETE);
6096 	}
6097 
6098 	if (page_index->page_code & SMPH_SPF) {
6099 		page_len_offset = 2;
6100 		page_len_size = 2;
6101 	} else {
6102 		page_len_size = 1;
6103 		page_len_offset = 1;
6104 	}
6105 
6106 	/*
6107 	 * If the length the initiator gives us isn't the one we specify in
6108 	 * the mode page header, or if they didn't specify enough data in
6109 	 * the CDB to avoid truncating this page, kick out the request.
6110 	 */
6111 	if ((page_len != (page_index->page_len - page_len_offset -
6112 			  page_len_size))
6113 	 || (*len_left < page_index->page_len)) {
6114 
6115 
6116 		ctl_set_invalid_field(ctsio,
6117 				      /*sks_valid*/ 1,
6118 				      /*command*/ 0,
6119 				      /*field*/ *len_used + page_len_offset,
6120 				      /*bit_valid*/ 0,
6121 				      /*bit*/ 0);
6122 		free(ctsio->kern_data_ptr, M_CTL);
6123 		ctl_done((union ctl_io *)ctsio);
6124 		return (CTL_RETVAL_COMPLETE);
6125 	}
6126 
6127 	/*
6128 	 * Run through the mode page, checking to make sure that the bits
6129 	 * the user changed are actually legal for him to change.
6130 	 */
6131 	for (i = 0; i < page_index->page_len; i++) {
6132 		uint8_t *user_byte, *change_mask, *current_byte;
6133 		int bad_bit;
6134 		int j;
6135 
6136 		user_byte = (uint8_t *)page_header + i;
6137 		change_mask = page_index->page_data +
6138 			      (page_index->page_len * CTL_PAGE_CHANGEABLE) + i;
6139 		current_byte = page_index->page_data +
6140 			       (page_index->page_len * CTL_PAGE_CURRENT) + i;
6141 
6142 		/*
6143 		 * Check to see whether the user set any bits in this byte
6144 		 * that he is not allowed to set.
6145 		 */
6146 		if ((*user_byte & ~(*change_mask)) ==
6147 		    (*current_byte & ~(*change_mask)))
6148 			continue;
6149 
6150 		/*
6151 		 * Go through bit by bit to determine which one is illegal.
6152 		 */
6153 		bad_bit = 0;
6154 		for (j = 7; j >= 0; j--) {
6155 			if ((((1 << i) & ~(*change_mask)) & *user_byte) !=
6156 			    (((1 << i) & ~(*change_mask)) & *current_byte)) {
6157 				bad_bit = i;
6158 				break;
6159 			}
6160 		}
6161 		ctl_set_invalid_field(ctsio,
6162 				      /*sks_valid*/ 1,
6163 				      /*command*/ 0,
6164 				      /*field*/ *len_used + i,
6165 				      /*bit_valid*/ 1,
6166 				      /*bit*/ bad_bit);
6167 		free(ctsio->kern_data_ptr, M_CTL);
6168 		ctl_done((union ctl_io *)ctsio);
6169 		return (CTL_RETVAL_COMPLETE);
6170 	}
6171 
6172 	/*
6173 	 * Decrement these before we call the page handler, since we may
6174 	 * end up getting called back one way or another before the handler
6175 	 * returns to this context.
6176 	 */
6177 	*len_left -= page_index->page_len;
6178 	*len_used += page_index->page_len;
6179 
6180 	retval = page_index->select_handler(ctsio, page_index,
6181 					    (uint8_t *)page_header);
6182 
6183 	/*
6184 	 * If the page handler returns CTL_RETVAL_QUEUED, then we need to
6185 	 * wait until this queued command completes to finish processing
6186 	 * the mode page.  If it returns anything other than
6187 	 * CTL_RETVAL_COMPLETE (e.g. CTL_RETVAL_ERROR), then it should have
6188 	 * already set the sense information, freed the data pointer, and
6189 	 * completed the io for us.
6190 	 */
6191 	if (retval != CTL_RETVAL_COMPLETE)
6192 		goto bailout_no_done;
6193 
6194 	/*
6195 	 * If the initiator sent us more than one page, parse the next one.
6196 	 */
6197 	if (*len_left > 0)
6198 		goto do_next_page;
6199 
6200 	ctl_set_success(ctsio);
6201 	free(ctsio->kern_data_ptr, M_CTL);
6202 	ctl_done((union ctl_io *)ctsio);
6203 
6204 bailout_no_done:
6205 
6206 	return (CTL_RETVAL_COMPLETE);
6207 
6208 }
6209 
6210 int
6211 ctl_mode_select(struct ctl_scsiio *ctsio)
6212 {
6213 	int param_len, pf, sp;
6214 	int header_size, bd_len;
6215 	union ctl_modepage_info *modepage_info;
6216 
6217 	switch (ctsio->cdb[0]) {
6218 	case MODE_SELECT_6: {
6219 		struct scsi_mode_select_6 *cdb;
6220 
6221 		cdb = (struct scsi_mode_select_6 *)ctsio->cdb;
6222 
6223 		pf = (cdb->byte2 & SMS_PF) ? 1 : 0;
6224 		sp = (cdb->byte2 & SMS_SP) ? 1 : 0;
6225 		param_len = cdb->length;
6226 		header_size = sizeof(struct scsi_mode_header_6);
6227 		break;
6228 	}
6229 	case MODE_SELECT_10: {
6230 		struct scsi_mode_select_10 *cdb;
6231 
6232 		cdb = (struct scsi_mode_select_10 *)ctsio->cdb;
6233 
6234 		pf = (cdb->byte2 & SMS_PF) ? 1 : 0;
6235 		sp = (cdb->byte2 & SMS_SP) ? 1 : 0;
6236 		param_len = scsi_2btoul(cdb->length);
6237 		header_size = sizeof(struct scsi_mode_header_10);
6238 		break;
6239 	}
6240 	default:
6241 		ctl_set_invalid_opcode(ctsio);
6242 		ctl_done((union ctl_io *)ctsio);
6243 		return (CTL_RETVAL_COMPLETE);
6244 	}
6245 
6246 	/*
6247 	 * From SPC-3:
6248 	 * "A parameter list length of zero indicates that the Data-Out Buffer
6249 	 * shall be empty. This condition shall not be considered as an error."
6250 	 */
6251 	if (param_len == 0) {
6252 		ctl_set_success(ctsio);
6253 		ctl_done((union ctl_io *)ctsio);
6254 		return (CTL_RETVAL_COMPLETE);
6255 	}
6256 
6257 	/*
6258 	 * Since we'll hit this the first time through, prior to
6259 	 * allocation, we don't need to free a data buffer here.
6260 	 */
6261 	if (param_len < header_size) {
6262 		ctl_set_param_len_error(ctsio);
6263 		ctl_done((union ctl_io *)ctsio);
6264 		return (CTL_RETVAL_COMPLETE);
6265 	}
6266 
6267 	/*
6268 	 * Allocate the data buffer and grab the user's data.  In theory,
6269 	 * we shouldn't have to sanity check the parameter list length here
6270 	 * because the maximum size is 64K.  We should be able to malloc
6271 	 * that much without too many problems.
6272 	 */
6273 	if ((ctsio->io_hdr.flags & CTL_FLAG_ALLOCATED) == 0) {
6274 		ctsio->kern_data_ptr = malloc(param_len, M_CTL, M_WAITOK);
6275 		ctsio->kern_data_len = param_len;
6276 		ctsio->kern_total_len = param_len;
6277 		ctsio->kern_data_resid = 0;
6278 		ctsio->kern_rel_offset = 0;
6279 		ctsio->kern_sg_entries = 0;
6280 		ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
6281 		ctsio->be_move_done = ctl_config_move_done;
6282 		ctl_datamove((union ctl_io *)ctsio);
6283 
6284 		return (CTL_RETVAL_COMPLETE);
6285 	}
6286 
6287 	switch (ctsio->cdb[0]) {
6288 	case MODE_SELECT_6: {
6289 		struct scsi_mode_header_6 *mh6;
6290 
6291 		mh6 = (struct scsi_mode_header_6 *)ctsio->kern_data_ptr;
6292 		bd_len = mh6->blk_desc_len;
6293 		break;
6294 	}
6295 	case MODE_SELECT_10: {
6296 		struct scsi_mode_header_10 *mh10;
6297 
6298 		mh10 = (struct scsi_mode_header_10 *)ctsio->kern_data_ptr;
6299 		bd_len = scsi_2btoul(mh10->blk_desc_len);
6300 		break;
6301 	}
6302 	default:
6303 		panic("%s: Invalid CDB type %#x", __func__, ctsio->cdb[0]);
6304 	}
6305 
6306 	if (param_len < (header_size + bd_len)) {
6307 		free(ctsio->kern_data_ptr, M_CTL);
6308 		ctl_set_param_len_error(ctsio);
6309 		ctl_done((union ctl_io *)ctsio);
6310 		return (CTL_RETVAL_COMPLETE);
6311 	}
6312 
6313 	/*
6314 	 * Set the IO_CONT flag, so that if this I/O gets passed to
6315 	 * ctl_config_write_done(), it'll get passed back to
6316 	 * ctl_do_mode_select() for further processing, or completion if
6317 	 * we're all done.
6318 	 */
6319 	ctsio->io_hdr.flags |= CTL_FLAG_IO_CONT;
6320 	ctsio->io_cont = ctl_do_mode_select;
6321 
6322 	modepage_info = (union ctl_modepage_info *)
6323 		ctsio->io_hdr.ctl_private[CTL_PRIV_MODEPAGE].bytes;
6324 	memset(modepage_info, 0, sizeof(*modepage_info));
6325 	modepage_info->header.len_left = param_len - header_size - bd_len;
6326 	modepage_info->header.len_used = header_size + bd_len;
6327 
6328 	return (ctl_do_mode_select((union ctl_io *)ctsio));
6329 }
6330 
6331 int
6332 ctl_mode_sense(struct ctl_scsiio *ctsio)
6333 {
6334 	struct ctl_lun *lun;
6335 	int pc, page_code, dbd, llba, subpage;
6336 	int alloc_len, page_len, header_len, total_len;
6337 	struct scsi_mode_block_descr *block_desc;
6338 	struct ctl_page_index *page_index;
6339 
6340 	dbd = 0;
6341 	llba = 0;
6342 	block_desc = NULL;
6343 
6344 	CTL_DEBUG_PRINT(("ctl_mode_sense\n"));
6345 
6346 	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
6347 	switch (ctsio->cdb[0]) {
6348 	case MODE_SENSE_6: {
6349 		struct scsi_mode_sense_6 *cdb;
6350 
6351 		cdb = (struct scsi_mode_sense_6 *)ctsio->cdb;
6352 
6353 		header_len = sizeof(struct scsi_mode_hdr_6);
6354 		if (cdb->byte2 & SMS_DBD)
6355 			dbd = 1;
6356 		else
6357 			header_len += sizeof(struct scsi_mode_block_descr);
6358 
6359 		pc = (cdb->page & SMS_PAGE_CTRL_MASK) >> 6;
6360 		page_code = cdb->page & SMS_PAGE_CODE;
6361 		subpage = cdb->subpage;
6362 		alloc_len = cdb->length;
6363 		break;
6364 	}
6365 	case MODE_SENSE_10: {
6366 		struct scsi_mode_sense_10 *cdb;
6367 
6368 		cdb = (struct scsi_mode_sense_10 *)ctsio->cdb;
6369 
6370 		header_len = sizeof(struct scsi_mode_hdr_10);
6371 
6372 		if (cdb->byte2 & SMS_DBD)
6373 			dbd = 1;
6374 		else
6375 			header_len += sizeof(struct scsi_mode_block_descr);
6376 		if (cdb->byte2 & SMS10_LLBAA)
6377 			llba = 1;
6378 		pc = (cdb->page & SMS_PAGE_CTRL_MASK) >> 6;
6379 		page_code = cdb->page & SMS_PAGE_CODE;
6380 		subpage = cdb->subpage;
6381 		alloc_len = scsi_2btoul(cdb->length);
6382 		break;
6383 	}
6384 	default:
6385 		ctl_set_invalid_opcode(ctsio);
6386 		ctl_done((union ctl_io *)ctsio);
6387 		return (CTL_RETVAL_COMPLETE);
6388 		break; /* NOTREACHED */
6389 	}
6390 
6391 	/*
6392 	 * We have to make a first pass through to calculate the size of
6393 	 * the pages that match the user's query.  Then we allocate enough
6394 	 * memory to hold it, and actually copy the data into the buffer.
6395 	 */
6396 	switch (page_code) {
6397 	case SMS_ALL_PAGES_PAGE: {
6398 		int i;
6399 
6400 		page_len = 0;
6401 
6402 		/*
6403 		 * At the moment, values other than 0 and 0xff here are
6404 		 * reserved according to SPC-3.
6405 		 */
6406 		if ((subpage != SMS_SUBPAGE_PAGE_0)
6407 		 && (subpage != SMS_SUBPAGE_ALL)) {
6408 			ctl_set_invalid_field(ctsio,
6409 					      /*sks_valid*/ 1,
6410 					      /*command*/ 1,
6411 					      /*field*/ 3,
6412 					      /*bit_valid*/ 0,
6413 					      /*bit*/ 0);
6414 			ctl_done((union ctl_io *)ctsio);
6415 			return (CTL_RETVAL_COMPLETE);
6416 		}
6417 
6418 		for (i = 0; i < CTL_NUM_MODE_PAGES; i++) {
6419 			page_index = &lun->mode_pages.index[i];
6420 
6421 			/* Make sure the page is supported for this dev type */
6422 			if (lun->be_lun->lun_type == T_DIRECT &&
6423 			    (page_index->page_flags & CTL_PAGE_FLAG_DIRECT) == 0)
6424 				continue;
6425 			if (lun->be_lun->lun_type == T_PROCESSOR &&
6426 			    (page_index->page_flags & CTL_PAGE_FLAG_PROC) == 0)
6427 				continue;
6428 			if (lun->be_lun->lun_type == T_CDROM &&
6429 			    (page_index->page_flags & CTL_PAGE_FLAG_CDROM) == 0)
6430 				continue;
6431 
6432 			/*
6433 			 * We don't use this subpage if the user didn't
6434 			 * request all subpages.
6435 			 */
6436 			if ((page_index->subpage != 0)
6437 			 && (subpage == SMS_SUBPAGE_PAGE_0))
6438 				continue;
6439 
6440 #if 0
6441 			printf("found page %#x len %d\n",
6442 			       page_index->page_code & SMPH_PC_MASK,
6443 			       page_index->page_len);
6444 #endif
6445 			page_len += page_index->page_len;
6446 		}
6447 		break;
6448 	}
6449 	default: {
6450 		int i;
6451 
6452 		page_len = 0;
6453 
6454 		for (i = 0; i < CTL_NUM_MODE_PAGES; i++) {
6455 			page_index = &lun->mode_pages.index[i];
6456 
6457 			/* Make sure the page is supported for this dev type */
6458 			if (lun->be_lun->lun_type == T_DIRECT &&
6459 			    (page_index->page_flags & CTL_PAGE_FLAG_DIRECT) == 0)
6460 				continue;
6461 			if (lun->be_lun->lun_type == T_PROCESSOR &&
6462 			    (page_index->page_flags & CTL_PAGE_FLAG_PROC) == 0)
6463 				continue;
6464 			if (lun->be_lun->lun_type == T_CDROM &&
6465 			    (page_index->page_flags & CTL_PAGE_FLAG_CDROM) == 0)
6466 				continue;
6467 
6468 			/* Look for the right page code */
6469 			if ((page_index->page_code & SMPH_PC_MASK) != page_code)
6470 				continue;
6471 
6472 			/* Look for the right subpage or the subpage wildcard*/
6473 			if ((page_index->subpage != subpage)
6474 			 && (subpage != SMS_SUBPAGE_ALL))
6475 				continue;
6476 
6477 #if 0
6478 			printf("found page %#x len %d\n",
6479 			       page_index->page_code & SMPH_PC_MASK,
6480 			       page_index->page_len);
6481 #endif
6482 
6483 			page_len += page_index->page_len;
6484 		}
6485 
6486 		if (page_len == 0) {
6487 			ctl_set_invalid_field(ctsio,
6488 					      /*sks_valid*/ 1,
6489 					      /*command*/ 1,
6490 					      /*field*/ 2,
6491 					      /*bit_valid*/ 1,
6492 					      /*bit*/ 5);
6493 			ctl_done((union ctl_io *)ctsio);
6494 			return (CTL_RETVAL_COMPLETE);
6495 		}
6496 		break;
6497 	}
6498 	}
6499 
6500 	total_len = header_len + page_len;
6501 #if 0
6502 	printf("header_len = %d, page_len = %d, total_len = %d\n",
6503 	       header_len, page_len, total_len);
6504 #endif
6505 
6506 	ctsio->kern_data_ptr = malloc(total_len, M_CTL, M_WAITOK | M_ZERO);
6507 	ctsio->kern_sg_entries = 0;
6508 	ctsio->kern_data_resid = 0;
6509 	ctsio->kern_rel_offset = 0;
6510 	if (total_len < alloc_len) {
6511 		ctsio->residual = alloc_len - total_len;
6512 		ctsio->kern_data_len = total_len;
6513 		ctsio->kern_total_len = total_len;
6514 	} else {
6515 		ctsio->residual = 0;
6516 		ctsio->kern_data_len = alloc_len;
6517 		ctsio->kern_total_len = alloc_len;
6518 	}
6519 
6520 	switch (ctsio->cdb[0]) {
6521 	case MODE_SENSE_6: {
6522 		struct scsi_mode_hdr_6 *header;
6523 
6524 		header = (struct scsi_mode_hdr_6 *)ctsio->kern_data_ptr;
6525 
6526 		header->datalen = MIN(total_len - 1, 254);
6527 		if (lun->be_lun->lun_type == T_DIRECT) {
6528 			header->dev_specific = 0x10; /* DPOFUA */
6529 			if ((lun->be_lun->flags & CTL_LUN_FLAG_READONLY) ||
6530 			    (lun->mode_pages.control_page[CTL_PAGE_CURRENT]
6531 			    .eca_and_aen & SCP_SWP) != 0)
6532 				    header->dev_specific |= 0x80; /* WP */
6533 		}
6534 		if (dbd)
6535 			header->block_descr_len = 0;
6536 		else
6537 			header->block_descr_len =
6538 				sizeof(struct scsi_mode_block_descr);
6539 		block_desc = (struct scsi_mode_block_descr *)&header[1];
6540 		break;
6541 	}
6542 	case MODE_SENSE_10: {
6543 		struct scsi_mode_hdr_10 *header;
6544 		int datalen;
6545 
6546 		header = (struct scsi_mode_hdr_10 *)ctsio->kern_data_ptr;
6547 
6548 		datalen = MIN(total_len - 2, 65533);
6549 		scsi_ulto2b(datalen, header->datalen);
6550 		if (lun->be_lun->lun_type == T_DIRECT) {
6551 			header->dev_specific = 0x10; /* DPOFUA */
6552 			if ((lun->be_lun->flags & CTL_LUN_FLAG_READONLY) ||
6553 			    (lun->mode_pages.control_page[CTL_PAGE_CURRENT]
6554 			    .eca_and_aen & SCP_SWP) != 0)
6555 				    header->dev_specific |= 0x80; /* WP */
6556 		}
6557 		if (dbd)
6558 			scsi_ulto2b(0, header->block_descr_len);
6559 		else
6560 			scsi_ulto2b(sizeof(struct scsi_mode_block_descr),
6561 				    header->block_descr_len);
6562 		block_desc = (struct scsi_mode_block_descr *)&header[1];
6563 		break;
6564 	}
6565 	default:
6566 		panic("%s: Invalid CDB type %#x", __func__, ctsio->cdb[0]);
6567 	}
6568 
6569 	/*
6570 	 * If we've got a disk, use its blocksize in the block
6571 	 * descriptor.  Otherwise, just set it to 0.
6572 	 */
6573 	if (dbd == 0) {
6574 		if (lun->be_lun->lun_type == T_DIRECT)
6575 			scsi_ulto3b(lun->be_lun->blocksize,
6576 				    block_desc->block_len);
6577 		else
6578 			scsi_ulto3b(0, block_desc->block_len);
6579 	}
6580 
6581 	switch (page_code) {
6582 	case SMS_ALL_PAGES_PAGE: {
6583 		int i, data_used;
6584 
6585 		data_used = header_len;
6586 		for (i = 0; i < CTL_NUM_MODE_PAGES; i++) {
6587 			struct ctl_page_index *page_index;
6588 
6589 			page_index = &lun->mode_pages.index[i];
6590 			if (lun->be_lun->lun_type == T_DIRECT &&
6591 			    (page_index->page_flags & CTL_PAGE_FLAG_DIRECT) == 0)
6592 				continue;
6593 			if (lun->be_lun->lun_type == T_PROCESSOR &&
6594 			    (page_index->page_flags & CTL_PAGE_FLAG_PROC) == 0)
6595 				continue;
6596 			if (lun->be_lun->lun_type == T_CDROM &&
6597 			    (page_index->page_flags & CTL_PAGE_FLAG_CDROM) == 0)
6598 				continue;
6599 
6600 			/*
6601 			 * We don't use this subpage if the user didn't
6602 			 * request all subpages.  We already checked (above)
6603 			 * to make sure the user only specified a subpage
6604 			 * of 0 or 0xff in the SMS_ALL_PAGES_PAGE case.
6605 			 */
6606 			if ((page_index->subpage != 0)
6607 			 && (subpage == SMS_SUBPAGE_PAGE_0))
6608 				continue;
6609 
6610 			/*
6611 			 * Call the handler, if it exists, to update the
6612 			 * page to the latest values.
6613 			 */
6614 			if (page_index->sense_handler != NULL)
6615 				page_index->sense_handler(ctsio, page_index,pc);
6616 
6617 			memcpy(ctsio->kern_data_ptr + data_used,
6618 			       page_index->page_data +
6619 			       (page_index->page_len * pc),
6620 			       page_index->page_len);
6621 			data_used += page_index->page_len;
6622 		}
6623 		break;
6624 	}
6625 	default: {
6626 		int i, data_used;
6627 
6628 		data_used = header_len;
6629 
6630 		for (i = 0; i < CTL_NUM_MODE_PAGES; i++) {
6631 			struct ctl_page_index *page_index;
6632 
6633 			page_index = &lun->mode_pages.index[i];
6634 
6635 			/* Look for the right page code */
6636 			if ((page_index->page_code & SMPH_PC_MASK) != page_code)
6637 				continue;
6638 
6639 			/* Look for the right subpage or the subpage wildcard*/
6640 			if ((page_index->subpage != subpage)
6641 			 && (subpage != SMS_SUBPAGE_ALL))
6642 				continue;
6643 
6644 			/* Make sure the page is supported for this dev type */
6645 			if (lun->be_lun->lun_type == T_DIRECT &&
6646 			    (page_index->page_flags & CTL_PAGE_FLAG_DIRECT) == 0)
6647 				continue;
6648 			if (lun->be_lun->lun_type == T_PROCESSOR &&
6649 			    (page_index->page_flags & CTL_PAGE_FLAG_PROC) == 0)
6650 				continue;
6651 			if (lun->be_lun->lun_type == T_CDROM &&
6652 			    (page_index->page_flags & CTL_PAGE_FLAG_CDROM) == 0)
6653 				continue;
6654 
6655 			/*
6656 			 * Call the handler, if it exists, to update the
6657 			 * page to the latest values.
6658 			 */
6659 			if (page_index->sense_handler != NULL)
6660 				page_index->sense_handler(ctsio, page_index,pc);
6661 
6662 			memcpy(ctsio->kern_data_ptr + data_used,
6663 			       page_index->page_data +
6664 			       (page_index->page_len * pc),
6665 			       page_index->page_len);
6666 			data_used += page_index->page_len;
6667 		}
6668 		break;
6669 	}
6670 	}
6671 
6672 	ctl_set_success(ctsio);
6673 	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
6674 	ctsio->be_move_done = ctl_config_move_done;
6675 	ctl_datamove((union ctl_io *)ctsio);
6676 	return (CTL_RETVAL_COMPLETE);
6677 }
6678 
6679 int
6680 ctl_lbp_log_sense_handler(struct ctl_scsiio *ctsio,
6681 			       struct ctl_page_index *page_index,
6682 			       int pc)
6683 {
6684 	struct ctl_lun *lun;
6685 	struct scsi_log_param_header *phdr;
6686 	uint8_t *data;
6687 	uint64_t val;
6688 
6689 	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
6690 	data = page_index->page_data;
6691 
6692 	if (lun->backend->lun_attr != NULL &&
6693 	    (val = lun->backend->lun_attr(lun->be_lun->be_lun, "blocksavail"))
6694 	     != UINT64_MAX) {
6695 		phdr = (struct scsi_log_param_header *)data;
6696 		scsi_ulto2b(0x0001, phdr->param_code);
6697 		phdr->param_control = SLP_LBIN | SLP_LP;
6698 		phdr->param_len = 8;
6699 		data = (uint8_t *)(phdr + 1);
6700 		scsi_ulto4b(val >> CTL_LBP_EXPONENT, data);
6701 		data[4] = 0x02; /* per-pool */
6702 		data += phdr->param_len;
6703 	}
6704 
6705 	if (lun->backend->lun_attr != NULL &&
6706 	    (val = lun->backend->lun_attr(lun->be_lun->be_lun, "blocksused"))
6707 	     != UINT64_MAX) {
6708 		phdr = (struct scsi_log_param_header *)data;
6709 		scsi_ulto2b(0x0002, phdr->param_code);
6710 		phdr->param_control = SLP_LBIN | SLP_LP;
6711 		phdr->param_len = 8;
6712 		data = (uint8_t *)(phdr + 1);
6713 		scsi_ulto4b(val >> CTL_LBP_EXPONENT, data);
6714 		data[4] = 0x01; /* per-LUN */
6715 		data += phdr->param_len;
6716 	}
6717 
6718 	if (lun->backend->lun_attr != NULL &&
6719 	    (val = lun->backend->lun_attr(lun->be_lun->be_lun, "poolblocksavail"))
6720 	     != UINT64_MAX) {
6721 		phdr = (struct scsi_log_param_header *)data;
6722 		scsi_ulto2b(0x00f1, phdr->param_code);
6723 		phdr->param_control = SLP_LBIN | SLP_LP;
6724 		phdr->param_len = 8;
6725 		data = (uint8_t *)(phdr + 1);
6726 		scsi_ulto4b(val >> CTL_LBP_EXPONENT, data);
6727 		data[4] = 0x02; /* per-pool */
6728 		data += phdr->param_len;
6729 	}
6730 
6731 	if (lun->backend->lun_attr != NULL &&
6732 	    (val = lun->backend->lun_attr(lun->be_lun->be_lun, "poolblocksused"))
6733 	     != UINT64_MAX) {
6734 		phdr = (struct scsi_log_param_header *)data;
6735 		scsi_ulto2b(0x00f2, phdr->param_code);
6736 		phdr->param_control = SLP_LBIN | SLP_LP;
6737 		phdr->param_len = 8;
6738 		data = (uint8_t *)(phdr + 1);
6739 		scsi_ulto4b(val >> CTL_LBP_EXPONENT, data);
6740 		data[4] = 0x02; /* per-pool */
6741 		data += phdr->param_len;
6742 	}
6743 
6744 	page_index->page_len = data - page_index->page_data;
6745 	return (0);
6746 }
6747 
6748 int
6749 ctl_sap_log_sense_handler(struct ctl_scsiio *ctsio,
6750 			       struct ctl_page_index *page_index,
6751 			       int pc)
6752 {
6753 	struct ctl_lun *lun;
6754 	struct stat_page *data;
6755 	uint64_t rn, wn, rb, wb;
6756 	struct bintime rt, wt;
6757 	int i;
6758 
6759 	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
6760 	data = (struct stat_page *)page_index->page_data;
6761 
6762 	scsi_ulto2b(SLP_SAP, data->sap.hdr.param_code);
6763 	data->sap.hdr.param_control = SLP_LBIN;
6764 	data->sap.hdr.param_len = sizeof(struct scsi_log_stat_and_perf) -
6765 	    sizeof(struct scsi_log_param_header);
6766 	rn = wn = rb = wb = 0;
6767 	bintime_clear(&rt);
6768 	bintime_clear(&wt);
6769 	for (i = 0; i < CTL_MAX_PORTS; i++) {
6770 		rn += lun->stats.ports[i].operations[CTL_STATS_READ];
6771 		wn += lun->stats.ports[i].operations[CTL_STATS_WRITE];
6772 		rb += lun->stats.ports[i].bytes[CTL_STATS_READ];
6773 		wb += lun->stats.ports[i].bytes[CTL_STATS_WRITE];
6774 		bintime_add(&rt, &lun->stats.ports[i].time[CTL_STATS_READ]);
6775 		bintime_add(&wt, &lun->stats.ports[i].time[CTL_STATS_WRITE]);
6776 	}
6777 	scsi_u64to8b(rn, data->sap.read_num);
6778 	scsi_u64to8b(wn, data->sap.write_num);
6779 	if (lun->stats.blocksize > 0) {
6780 		scsi_u64to8b(wb / lun->stats.blocksize,
6781 		    data->sap.recvieved_lba);
6782 		scsi_u64to8b(rb / lun->stats.blocksize,
6783 		    data->sap.transmitted_lba);
6784 	}
6785 	scsi_u64to8b((uint64_t)rt.sec * 1000 + rt.frac / (UINT64_MAX / 1000),
6786 	    data->sap.read_int);
6787 	scsi_u64to8b((uint64_t)wt.sec * 1000 + wt.frac / (UINT64_MAX / 1000),
6788 	    data->sap.write_int);
6789 	scsi_u64to8b(0, data->sap.weighted_num);
6790 	scsi_u64to8b(0, data->sap.weighted_int);
6791 	scsi_ulto2b(SLP_IT, data->it.hdr.param_code);
6792 	data->it.hdr.param_control = SLP_LBIN;
6793 	data->it.hdr.param_len = sizeof(struct scsi_log_idle_time) -
6794 	    sizeof(struct scsi_log_param_header);
6795 #ifdef CTL_TIME_IO
6796 	scsi_u64to8b(lun->idle_time / SBT_1MS, data->it.idle_int);
6797 #endif
6798 	scsi_ulto2b(SLP_TI, data->ti.hdr.param_code);
6799 	data->it.hdr.param_control = SLP_LBIN;
6800 	data->ti.hdr.param_len = sizeof(struct scsi_log_time_interval) -
6801 	    sizeof(struct scsi_log_param_header);
6802 	scsi_ulto4b(3, data->ti.exponent);
6803 	scsi_ulto4b(1, data->ti.integer);
6804 
6805 	page_index->page_len = sizeof(*data);
6806 	return (0);
6807 }
6808 
6809 int
6810 ctl_log_sense(struct ctl_scsiio *ctsio)
6811 {
6812 	struct ctl_lun *lun;
6813 	int i, pc, page_code, subpage;
6814 	int alloc_len, total_len;
6815 	struct ctl_page_index *page_index;
6816 	struct scsi_log_sense *cdb;
6817 	struct scsi_log_header *header;
6818 
6819 	CTL_DEBUG_PRINT(("ctl_log_sense\n"));
6820 
6821 	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
6822 	cdb = (struct scsi_log_sense *)ctsio->cdb;
6823 	pc = (cdb->page & SLS_PAGE_CTRL_MASK) >> 6;
6824 	page_code = cdb->page & SLS_PAGE_CODE;
6825 	subpage = cdb->subpage;
6826 	alloc_len = scsi_2btoul(cdb->length);
6827 
6828 	page_index = NULL;
6829 	for (i = 0; i < CTL_NUM_LOG_PAGES; i++) {
6830 		page_index = &lun->log_pages.index[i];
6831 
6832 		/* Look for the right page code */
6833 		if ((page_index->page_code & SL_PAGE_CODE) != page_code)
6834 			continue;
6835 
6836 		/* Look for the right subpage or the subpage wildcard*/
6837 		if (page_index->subpage != subpage)
6838 			continue;
6839 
6840 		break;
6841 	}
6842 	if (i >= CTL_NUM_LOG_PAGES) {
6843 		ctl_set_invalid_field(ctsio,
6844 				      /*sks_valid*/ 1,
6845 				      /*command*/ 1,
6846 				      /*field*/ 2,
6847 				      /*bit_valid*/ 0,
6848 				      /*bit*/ 0);
6849 		ctl_done((union ctl_io *)ctsio);
6850 		return (CTL_RETVAL_COMPLETE);
6851 	}
6852 
6853 	total_len = sizeof(struct scsi_log_header) + page_index->page_len;
6854 
6855 	ctsio->kern_data_ptr = malloc(total_len, M_CTL, M_WAITOK | M_ZERO);
6856 	ctsio->kern_sg_entries = 0;
6857 	ctsio->kern_data_resid = 0;
6858 	ctsio->kern_rel_offset = 0;
6859 	if (total_len < alloc_len) {
6860 		ctsio->residual = alloc_len - total_len;
6861 		ctsio->kern_data_len = total_len;
6862 		ctsio->kern_total_len = total_len;
6863 	} else {
6864 		ctsio->residual = 0;
6865 		ctsio->kern_data_len = alloc_len;
6866 		ctsio->kern_total_len = alloc_len;
6867 	}
6868 
6869 	header = (struct scsi_log_header *)ctsio->kern_data_ptr;
6870 	header->page = page_index->page_code;
6871 	if (page_index->page_code == SLS_LOGICAL_BLOCK_PROVISIONING)
6872 		header->page |= SL_DS;
6873 	if (page_index->subpage) {
6874 		header->page |= SL_SPF;
6875 		header->subpage = page_index->subpage;
6876 	}
6877 	scsi_ulto2b(page_index->page_len, header->datalen);
6878 
6879 	/*
6880 	 * Call the handler, if it exists, to update the
6881 	 * page to the latest values.
6882 	 */
6883 	if (page_index->sense_handler != NULL)
6884 		page_index->sense_handler(ctsio, page_index, pc);
6885 
6886 	memcpy(header + 1, page_index->page_data, page_index->page_len);
6887 
6888 	ctl_set_success(ctsio);
6889 	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
6890 	ctsio->be_move_done = ctl_config_move_done;
6891 	ctl_datamove((union ctl_io *)ctsio);
6892 	return (CTL_RETVAL_COMPLETE);
6893 }
6894 
6895 int
6896 ctl_read_capacity(struct ctl_scsiio *ctsio)
6897 {
6898 	struct scsi_read_capacity *cdb;
6899 	struct scsi_read_capacity_data *data;
6900 	struct ctl_lun *lun;
6901 	uint32_t lba;
6902 
6903 	CTL_DEBUG_PRINT(("ctl_read_capacity\n"));
6904 
6905 	cdb = (struct scsi_read_capacity *)ctsio->cdb;
6906 
6907 	lba = scsi_4btoul(cdb->addr);
6908 	if (((cdb->pmi & SRC_PMI) == 0)
6909 	 && (lba != 0)) {
6910 		ctl_set_invalid_field(/*ctsio*/ ctsio,
6911 				      /*sks_valid*/ 1,
6912 				      /*command*/ 1,
6913 				      /*field*/ 2,
6914 				      /*bit_valid*/ 0,
6915 				      /*bit*/ 0);
6916 		ctl_done((union ctl_io *)ctsio);
6917 		return (CTL_RETVAL_COMPLETE);
6918 	}
6919 
6920 	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
6921 
6922 	ctsio->kern_data_ptr = malloc(sizeof(*data), M_CTL, M_WAITOK | M_ZERO);
6923 	data = (struct scsi_read_capacity_data *)ctsio->kern_data_ptr;
6924 	ctsio->residual = 0;
6925 	ctsio->kern_data_len = sizeof(*data);
6926 	ctsio->kern_total_len = sizeof(*data);
6927 	ctsio->kern_data_resid = 0;
6928 	ctsio->kern_rel_offset = 0;
6929 	ctsio->kern_sg_entries = 0;
6930 
6931 	/*
6932 	 * If the maximum LBA is greater than 0xfffffffe, the user must
6933 	 * issue a SERVICE ACTION IN (16) command, with the read capacity
6934 	 * serivce action set.
6935 	 */
6936 	if (lun->be_lun->maxlba > 0xfffffffe)
6937 		scsi_ulto4b(0xffffffff, data->addr);
6938 	else
6939 		scsi_ulto4b(lun->be_lun->maxlba, data->addr);
6940 
6941 	/*
6942 	 * XXX KDM this may not be 512 bytes...
6943 	 */
6944 	scsi_ulto4b(lun->be_lun->blocksize, data->length);
6945 
6946 	ctl_set_success(ctsio);
6947 	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
6948 	ctsio->be_move_done = ctl_config_move_done;
6949 	ctl_datamove((union ctl_io *)ctsio);
6950 	return (CTL_RETVAL_COMPLETE);
6951 }
6952 
6953 int
6954 ctl_read_capacity_16(struct ctl_scsiio *ctsio)
6955 {
6956 	struct scsi_read_capacity_16 *cdb;
6957 	struct scsi_read_capacity_data_long *data;
6958 	struct ctl_lun *lun;
6959 	uint64_t lba;
6960 	uint32_t alloc_len;
6961 
6962 	CTL_DEBUG_PRINT(("ctl_read_capacity_16\n"));
6963 
6964 	cdb = (struct scsi_read_capacity_16 *)ctsio->cdb;
6965 
6966 	alloc_len = scsi_4btoul(cdb->alloc_len);
6967 	lba = scsi_8btou64(cdb->addr);
6968 
6969 	if ((cdb->reladr & SRC16_PMI)
6970 	 && (lba != 0)) {
6971 		ctl_set_invalid_field(/*ctsio*/ ctsio,
6972 				      /*sks_valid*/ 1,
6973 				      /*command*/ 1,
6974 				      /*field*/ 2,
6975 				      /*bit_valid*/ 0,
6976 				      /*bit*/ 0);
6977 		ctl_done((union ctl_io *)ctsio);
6978 		return (CTL_RETVAL_COMPLETE);
6979 	}
6980 
6981 	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
6982 
6983 	ctsio->kern_data_ptr = malloc(sizeof(*data), M_CTL, M_WAITOK | M_ZERO);
6984 	data = (struct scsi_read_capacity_data_long *)ctsio->kern_data_ptr;
6985 
6986 	if (sizeof(*data) < alloc_len) {
6987 		ctsio->residual = alloc_len - sizeof(*data);
6988 		ctsio->kern_data_len = sizeof(*data);
6989 		ctsio->kern_total_len = sizeof(*data);
6990 	} else {
6991 		ctsio->residual = 0;
6992 		ctsio->kern_data_len = alloc_len;
6993 		ctsio->kern_total_len = alloc_len;
6994 	}
6995 	ctsio->kern_data_resid = 0;
6996 	ctsio->kern_rel_offset = 0;
6997 	ctsio->kern_sg_entries = 0;
6998 
6999 	scsi_u64to8b(lun->be_lun->maxlba, data->addr);
7000 	/* XXX KDM this may not be 512 bytes... */
7001 	scsi_ulto4b(lun->be_lun->blocksize, data->length);
7002 	data->prot_lbppbe = lun->be_lun->pblockexp & SRC16_LBPPBE;
7003 	scsi_ulto2b(lun->be_lun->pblockoff & SRC16_LALBA_A, data->lalba_lbp);
7004 	if (lun->be_lun->flags & CTL_LUN_FLAG_UNMAP)
7005 		data->lalba_lbp[0] |= SRC16_LBPME | SRC16_LBPRZ;
7006 
7007 	ctl_set_success(ctsio);
7008 	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
7009 	ctsio->be_move_done = ctl_config_move_done;
7010 	ctl_datamove((union ctl_io *)ctsio);
7011 	return (CTL_RETVAL_COMPLETE);
7012 }
7013 
7014 int
7015 ctl_get_lba_status(struct ctl_scsiio *ctsio)
7016 {
7017 	struct scsi_get_lba_status *cdb;
7018 	struct scsi_get_lba_status_data *data;
7019 	struct ctl_lun *lun;
7020 	struct ctl_lba_len_flags *lbalen;
7021 	uint64_t lba;
7022 	uint32_t alloc_len, total_len;
7023 	int retval;
7024 
7025 	CTL_DEBUG_PRINT(("ctl_get_lba_status\n"));
7026 
7027 	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
7028 	cdb = (struct scsi_get_lba_status *)ctsio->cdb;
7029 	lba = scsi_8btou64(cdb->addr);
7030 	alloc_len = scsi_4btoul(cdb->alloc_len);
7031 
7032 	if (lba > lun->be_lun->maxlba) {
7033 		ctl_set_lba_out_of_range(ctsio);
7034 		ctl_done((union ctl_io *)ctsio);
7035 		return (CTL_RETVAL_COMPLETE);
7036 	}
7037 
7038 	total_len = sizeof(*data) + sizeof(data->descr[0]);
7039 	ctsio->kern_data_ptr = malloc(total_len, M_CTL, M_WAITOK | M_ZERO);
7040 	data = (struct scsi_get_lba_status_data *)ctsio->kern_data_ptr;
7041 
7042 	if (total_len < alloc_len) {
7043 		ctsio->residual = alloc_len - total_len;
7044 		ctsio->kern_data_len = total_len;
7045 		ctsio->kern_total_len = total_len;
7046 	} else {
7047 		ctsio->residual = 0;
7048 		ctsio->kern_data_len = alloc_len;
7049 		ctsio->kern_total_len = alloc_len;
7050 	}
7051 	ctsio->kern_data_resid = 0;
7052 	ctsio->kern_rel_offset = 0;
7053 	ctsio->kern_sg_entries = 0;
7054 
7055 	/* Fill dummy data in case backend can't tell anything. */
7056 	scsi_ulto4b(4 + sizeof(data->descr[0]), data->length);
7057 	scsi_u64to8b(lba, data->descr[0].addr);
7058 	scsi_ulto4b(MIN(UINT32_MAX, lun->be_lun->maxlba + 1 - lba),
7059 	    data->descr[0].length);
7060 	data->descr[0].status = 0; /* Mapped or unknown. */
7061 
7062 	ctl_set_success(ctsio);
7063 	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
7064 	ctsio->be_move_done = ctl_config_move_done;
7065 
7066 	lbalen = (struct ctl_lba_len_flags *)&ctsio->io_hdr.ctl_private[CTL_PRIV_LBA_LEN];
7067 	lbalen->lba = lba;
7068 	lbalen->len = total_len;
7069 	lbalen->flags = 0;
7070 	retval = lun->backend->config_read((union ctl_io *)ctsio);
7071 	return (CTL_RETVAL_COMPLETE);
7072 }
7073 
7074 int
7075 ctl_read_defect(struct ctl_scsiio *ctsio)
7076 {
7077 	struct scsi_read_defect_data_10 *ccb10;
7078 	struct scsi_read_defect_data_12 *ccb12;
7079 	struct scsi_read_defect_data_hdr_10 *data10;
7080 	struct scsi_read_defect_data_hdr_12 *data12;
7081 	uint32_t alloc_len, data_len;
7082 	uint8_t format;
7083 
7084 	CTL_DEBUG_PRINT(("ctl_read_defect\n"));
7085 
7086 	if (ctsio->cdb[0] == READ_DEFECT_DATA_10) {
7087 		ccb10 = (struct scsi_read_defect_data_10 *)&ctsio->cdb;
7088 		format = ccb10->format;
7089 		alloc_len = scsi_2btoul(ccb10->alloc_length);
7090 		data_len = sizeof(*data10);
7091 	} else {
7092 		ccb12 = (struct scsi_read_defect_data_12 *)&ctsio->cdb;
7093 		format = ccb12->format;
7094 		alloc_len = scsi_4btoul(ccb12->alloc_length);
7095 		data_len = sizeof(*data12);
7096 	}
7097 	if (alloc_len == 0) {
7098 		ctl_set_success(ctsio);
7099 		ctl_done((union ctl_io *)ctsio);
7100 		return (CTL_RETVAL_COMPLETE);
7101 	}
7102 
7103 	ctsio->kern_data_ptr = malloc(data_len, M_CTL, M_WAITOK | M_ZERO);
7104 	if (data_len < alloc_len) {
7105 		ctsio->residual = alloc_len - data_len;
7106 		ctsio->kern_data_len = data_len;
7107 		ctsio->kern_total_len = data_len;
7108 	} else {
7109 		ctsio->residual = 0;
7110 		ctsio->kern_data_len = alloc_len;
7111 		ctsio->kern_total_len = alloc_len;
7112 	}
7113 	ctsio->kern_data_resid = 0;
7114 	ctsio->kern_rel_offset = 0;
7115 	ctsio->kern_sg_entries = 0;
7116 
7117 	if (ctsio->cdb[0] == READ_DEFECT_DATA_10) {
7118 		data10 = (struct scsi_read_defect_data_hdr_10 *)
7119 		    ctsio->kern_data_ptr;
7120 		data10->format = format;
7121 		scsi_ulto2b(0, data10->length);
7122 	} else {
7123 		data12 = (struct scsi_read_defect_data_hdr_12 *)
7124 		    ctsio->kern_data_ptr;
7125 		data12->format = format;
7126 		scsi_ulto2b(0, data12->generation);
7127 		scsi_ulto4b(0, data12->length);
7128 	}
7129 
7130 	ctl_set_success(ctsio);
7131 	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
7132 	ctsio->be_move_done = ctl_config_move_done;
7133 	ctl_datamove((union ctl_io *)ctsio);
7134 	return (CTL_RETVAL_COMPLETE);
7135 }
7136 
7137 int
7138 ctl_report_tagret_port_groups(struct ctl_scsiio *ctsio)
7139 {
7140 	struct scsi_maintenance_in *cdb;
7141 	int retval;
7142 	int alloc_len, ext, total_len = 0, g, pc, pg, ts, os;
7143 	int num_ha_groups, num_target_ports, shared_group;
7144 	struct ctl_lun *lun;
7145 	struct ctl_softc *softc;
7146 	struct ctl_port *port;
7147 	struct scsi_target_group_data *rtg_ptr;
7148 	struct scsi_target_group_data_extended *rtg_ext_ptr;
7149 	struct scsi_target_port_group_descriptor *tpg_desc;
7150 
7151 	CTL_DEBUG_PRINT(("ctl_report_tagret_port_groups\n"));
7152 
7153 	cdb = (struct scsi_maintenance_in *)ctsio->cdb;
7154 	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
7155 	softc = lun->ctl_softc;
7156 
7157 	retval = CTL_RETVAL_COMPLETE;
7158 
7159 	switch (cdb->byte2 & STG_PDF_MASK) {
7160 	case STG_PDF_LENGTH:
7161 		ext = 0;
7162 		break;
7163 	case STG_PDF_EXTENDED:
7164 		ext = 1;
7165 		break;
7166 	default:
7167 		ctl_set_invalid_field(/*ctsio*/ ctsio,
7168 				      /*sks_valid*/ 1,
7169 				      /*command*/ 1,
7170 				      /*field*/ 2,
7171 				      /*bit_valid*/ 1,
7172 				      /*bit*/ 5);
7173 		ctl_done((union ctl_io *)ctsio);
7174 		return(retval);
7175 	}
7176 
7177 	num_target_ports = 0;
7178 	shared_group = (softc->is_single != 0);
7179 	mtx_lock(&softc->ctl_lock);
7180 	STAILQ_FOREACH(port, &softc->port_list, links) {
7181 		if ((port->status & CTL_PORT_STATUS_ONLINE) == 0)
7182 			continue;
7183 		if (ctl_lun_map_to_port(port, lun->lun) >= CTL_MAX_LUNS)
7184 			continue;
7185 		num_target_ports++;
7186 		if (port->status & CTL_PORT_STATUS_HA_SHARED)
7187 			shared_group = 1;
7188 	}
7189 	mtx_unlock(&softc->ctl_lock);
7190 	num_ha_groups = (softc->is_single) ? 0 : NUM_HA_SHELVES;
7191 
7192 	if (ext)
7193 		total_len = sizeof(struct scsi_target_group_data_extended);
7194 	else
7195 		total_len = sizeof(struct scsi_target_group_data);
7196 	total_len += sizeof(struct scsi_target_port_group_descriptor) *
7197 		(shared_group + num_ha_groups) +
7198 	    sizeof(struct scsi_target_port_descriptor) * num_target_ports;
7199 
7200 	alloc_len = scsi_4btoul(cdb->length);
7201 
7202 	ctsio->kern_data_ptr = malloc(total_len, M_CTL, M_WAITOK | M_ZERO);
7203 
7204 	ctsio->kern_sg_entries = 0;
7205 
7206 	if (total_len < alloc_len) {
7207 		ctsio->residual = alloc_len - total_len;
7208 		ctsio->kern_data_len = total_len;
7209 		ctsio->kern_total_len = total_len;
7210 	} else {
7211 		ctsio->residual = 0;
7212 		ctsio->kern_data_len = alloc_len;
7213 		ctsio->kern_total_len = alloc_len;
7214 	}
7215 	ctsio->kern_data_resid = 0;
7216 	ctsio->kern_rel_offset = 0;
7217 
7218 	if (ext) {
7219 		rtg_ext_ptr = (struct scsi_target_group_data_extended *)
7220 		    ctsio->kern_data_ptr;
7221 		scsi_ulto4b(total_len - 4, rtg_ext_ptr->length);
7222 		rtg_ext_ptr->format_type = 0x10;
7223 		rtg_ext_ptr->implicit_transition_time = 0;
7224 		tpg_desc = &rtg_ext_ptr->groups[0];
7225 	} else {
7226 		rtg_ptr = (struct scsi_target_group_data *)
7227 		    ctsio->kern_data_ptr;
7228 		scsi_ulto4b(total_len - 4, rtg_ptr->length);
7229 		tpg_desc = &rtg_ptr->groups[0];
7230 	}
7231 
7232 	mtx_lock(&softc->ctl_lock);
7233 	pg = softc->port_min / softc->port_cnt;
7234 	if (lun->flags & (CTL_LUN_PRIMARY_SC | CTL_LUN_PEER_SC_PRIMARY)) {
7235 		/* Some shelf is known to be primary. */
7236 		if (softc->ha_link == CTL_HA_LINK_OFFLINE)
7237 			os = TPG_ASYMMETRIC_ACCESS_UNAVAILABLE;
7238 		else if (softc->ha_link == CTL_HA_LINK_UNKNOWN)
7239 			os = TPG_ASYMMETRIC_ACCESS_TRANSITIONING;
7240 		else if (softc->ha_mode == CTL_HA_MODE_ACT_STBY)
7241 			os = TPG_ASYMMETRIC_ACCESS_STANDBY;
7242 		else
7243 			os = TPG_ASYMMETRIC_ACCESS_NONOPTIMIZED;
7244 		if (lun->flags & CTL_LUN_PRIMARY_SC) {
7245 			ts = TPG_ASYMMETRIC_ACCESS_OPTIMIZED;
7246 		} else {
7247 			ts = os;
7248 			os = TPG_ASYMMETRIC_ACCESS_OPTIMIZED;
7249 		}
7250 	} else {
7251 		/* No known primary shelf. */
7252 		if (softc->ha_link == CTL_HA_LINK_OFFLINE) {
7253 			ts = TPG_ASYMMETRIC_ACCESS_UNAVAILABLE;
7254 			os = TPG_ASYMMETRIC_ACCESS_OPTIMIZED;
7255 		} else if (softc->ha_link == CTL_HA_LINK_UNKNOWN) {
7256 			ts = TPG_ASYMMETRIC_ACCESS_TRANSITIONING;
7257 			os = TPG_ASYMMETRIC_ACCESS_OPTIMIZED;
7258 		} else {
7259 			ts = os = TPG_ASYMMETRIC_ACCESS_TRANSITIONING;
7260 		}
7261 	}
7262 	if (shared_group) {
7263 		tpg_desc->pref_state = ts;
7264 		tpg_desc->support = TPG_AO_SUP | TPG_AN_SUP | TPG_S_SUP |
7265 		    TPG_U_SUP | TPG_T_SUP;
7266 		scsi_ulto2b(1, tpg_desc->target_port_group);
7267 		tpg_desc->status = TPG_IMPLICIT;
7268 		pc = 0;
7269 		STAILQ_FOREACH(port, &softc->port_list, links) {
7270 			if ((port->status & CTL_PORT_STATUS_ONLINE) == 0)
7271 				continue;
7272 			if (!softc->is_single &&
7273 			    (port->status & CTL_PORT_STATUS_HA_SHARED) == 0)
7274 				continue;
7275 			if (ctl_lun_map_to_port(port, lun->lun) >= CTL_MAX_LUNS)
7276 				continue;
7277 			scsi_ulto2b(port->targ_port, tpg_desc->descriptors[pc].
7278 			    relative_target_port_identifier);
7279 			pc++;
7280 		}
7281 		tpg_desc->target_port_count = pc;
7282 		tpg_desc = (struct scsi_target_port_group_descriptor *)
7283 		    &tpg_desc->descriptors[pc];
7284 	}
7285 	for (g = 0; g < num_ha_groups; g++) {
7286 		tpg_desc->pref_state = (g == pg) ? ts : os;
7287 		tpg_desc->support = TPG_AO_SUP | TPG_AN_SUP | TPG_S_SUP |
7288 		    TPG_U_SUP | TPG_T_SUP;
7289 		scsi_ulto2b(2 + g, tpg_desc->target_port_group);
7290 		tpg_desc->status = TPG_IMPLICIT;
7291 		pc = 0;
7292 		STAILQ_FOREACH(port, &softc->port_list, links) {
7293 			if (port->targ_port < g * softc->port_cnt ||
7294 			    port->targ_port >= (g + 1) * softc->port_cnt)
7295 				continue;
7296 			if ((port->status & CTL_PORT_STATUS_ONLINE) == 0)
7297 				continue;
7298 			if (port->status & CTL_PORT_STATUS_HA_SHARED)
7299 				continue;
7300 			if (ctl_lun_map_to_port(port, lun->lun) >= CTL_MAX_LUNS)
7301 				continue;
7302 			scsi_ulto2b(port->targ_port, tpg_desc->descriptors[pc].
7303 			    relative_target_port_identifier);
7304 			pc++;
7305 		}
7306 		tpg_desc->target_port_count = pc;
7307 		tpg_desc = (struct scsi_target_port_group_descriptor *)
7308 		    &tpg_desc->descriptors[pc];
7309 	}
7310 	mtx_unlock(&softc->ctl_lock);
7311 
7312 	ctl_set_success(ctsio);
7313 	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
7314 	ctsio->be_move_done = ctl_config_move_done;
7315 	ctl_datamove((union ctl_io *)ctsio);
7316 	return(retval);
7317 }
7318 
7319 int
7320 ctl_report_supported_opcodes(struct ctl_scsiio *ctsio)
7321 {
7322 	struct ctl_lun *lun;
7323 	struct scsi_report_supported_opcodes *cdb;
7324 	const struct ctl_cmd_entry *entry, *sentry;
7325 	struct scsi_report_supported_opcodes_all *all;
7326 	struct scsi_report_supported_opcodes_descr *descr;
7327 	struct scsi_report_supported_opcodes_one *one;
7328 	int retval;
7329 	int alloc_len, total_len;
7330 	int opcode, service_action, i, j, num;
7331 
7332 	CTL_DEBUG_PRINT(("ctl_report_supported_opcodes\n"));
7333 
7334 	cdb = (struct scsi_report_supported_opcodes *)ctsio->cdb;
7335 	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
7336 
7337 	retval = CTL_RETVAL_COMPLETE;
7338 
7339 	opcode = cdb->requested_opcode;
7340 	service_action = scsi_2btoul(cdb->requested_service_action);
7341 	switch (cdb->options & RSO_OPTIONS_MASK) {
7342 	case RSO_OPTIONS_ALL:
7343 		num = 0;
7344 		for (i = 0; i < 256; i++) {
7345 			entry = &ctl_cmd_table[i];
7346 			if (entry->flags & CTL_CMD_FLAG_SA5) {
7347 				for (j = 0; j < 32; j++) {
7348 					sentry = &((const struct ctl_cmd_entry *)
7349 					    entry->execute)[j];
7350 					if (ctl_cmd_applicable(
7351 					    lun->be_lun->lun_type, sentry))
7352 						num++;
7353 				}
7354 			} else {
7355 				if (ctl_cmd_applicable(lun->be_lun->lun_type,
7356 				    entry))
7357 					num++;
7358 			}
7359 		}
7360 		total_len = sizeof(struct scsi_report_supported_opcodes_all) +
7361 		    num * sizeof(struct scsi_report_supported_opcodes_descr);
7362 		break;
7363 	case RSO_OPTIONS_OC:
7364 		if (ctl_cmd_table[opcode].flags & CTL_CMD_FLAG_SA5) {
7365 			ctl_set_invalid_field(/*ctsio*/ ctsio,
7366 					      /*sks_valid*/ 1,
7367 					      /*command*/ 1,
7368 					      /*field*/ 2,
7369 					      /*bit_valid*/ 1,
7370 					      /*bit*/ 2);
7371 			ctl_done((union ctl_io *)ctsio);
7372 			return (CTL_RETVAL_COMPLETE);
7373 		}
7374 		total_len = sizeof(struct scsi_report_supported_opcodes_one) + 32;
7375 		break;
7376 	case RSO_OPTIONS_OC_SA:
7377 		if ((ctl_cmd_table[opcode].flags & CTL_CMD_FLAG_SA5) == 0 ||
7378 		    service_action >= 32) {
7379 			ctl_set_invalid_field(/*ctsio*/ ctsio,
7380 					      /*sks_valid*/ 1,
7381 					      /*command*/ 1,
7382 					      /*field*/ 2,
7383 					      /*bit_valid*/ 1,
7384 					      /*bit*/ 2);
7385 			ctl_done((union ctl_io *)ctsio);
7386 			return (CTL_RETVAL_COMPLETE);
7387 		}
7388 		total_len = sizeof(struct scsi_report_supported_opcodes_one) + 32;
7389 		break;
7390 	default:
7391 		ctl_set_invalid_field(/*ctsio*/ ctsio,
7392 				      /*sks_valid*/ 1,
7393 				      /*command*/ 1,
7394 				      /*field*/ 2,
7395 				      /*bit_valid*/ 1,
7396 				      /*bit*/ 2);
7397 		ctl_done((union ctl_io *)ctsio);
7398 		return (CTL_RETVAL_COMPLETE);
7399 	}
7400 
7401 	alloc_len = scsi_4btoul(cdb->length);
7402 
7403 	ctsio->kern_data_ptr = malloc(total_len, M_CTL, M_WAITOK | M_ZERO);
7404 
7405 	ctsio->kern_sg_entries = 0;
7406 
7407 	if (total_len < alloc_len) {
7408 		ctsio->residual = alloc_len - total_len;
7409 		ctsio->kern_data_len = total_len;
7410 		ctsio->kern_total_len = total_len;
7411 	} else {
7412 		ctsio->residual = 0;
7413 		ctsio->kern_data_len = alloc_len;
7414 		ctsio->kern_total_len = alloc_len;
7415 	}
7416 	ctsio->kern_data_resid = 0;
7417 	ctsio->kern_rel_offset = 0;
7418 
7419 	switch (cdb->options & RSO_OPTIONS_MASK) {
7420 	case RSO_OPTIONS_ALL:
7421 		all = (struct scsi_report_supported_opcodes_all *)
7422 		    ctsio->kern_data_ptr;
7423 		num = 0;
7424 		for (i = 0; i < 256; i++) {
7425 			entry = &ctl_cmd_table[i];
7426 			if (entry->flags & CTL_CMD_FLAG_SA5) {
7427 				for (j = 0; j < 32; j++) {
7428 					sentry = &((const struct ctl_cmd_entry *)
7429 					    entry->execute)[j];
7430 					if (!ctl_cmd_applicable(
7431 					    lun->be_lun->lun_type, sentry))
7432 						continue;
7433 					descr = &all->descr[num++];
7434 					descr->opcode = i;
7435 					scsi_ulto2b(j, descr->service_action);
7436 					descr->flags = RSO_SERVACTV;
7437 					scsi_ulto2b(sentry->length,
7438 					    descr->cdb_length);
7439 				}
7440 			} else {
7441 				if (!ctl_cmd_applicable(lun->be_lun->lun_type,
7442 				    entry))
7443 					continue;
7444 				descr = &all->descr[num++];
7445 				descr->opcode = i;
7446 				scsi_ulto2b(0, descr->service_action);
7447 				descr->flags = 0;
7448 				scsi_ulto2b(entry->length, descr->cdb_length);
7449 			}
7450 		}
7451 		scsi_ulto4b(
7452 		    num * sizeof(struct scsi_report_supported_opcodes_descr),
7453 		    all->length);
7454 		break;
7455 	case RSO_OPTIONS_OC:
7456 		one = (struct scsi_report_supported_opcodes_one *)
7457 		    ctsio->kern_data_ptr;
7458 		entry = &ctl_cmd_table[opcode];
7459 		goto fill_one;
7460 	case RSO_OPTIONS_OC_SA:
7461 		one = (struct scsi_report_supported_opcodes_one *)
7462 		    ctsio->kern_data_ptr;
7463 		entry = &ctl_cmd_table[opcode];
7464 		entry = &((const struct ctl_cmd_entry *)
7465 		    entry->execute)[service_action];
7466 fill_one:
7467 		if (ctl_cmd_applicable(lun->be_lun->lun_type, entry)) {
7468 			one->support = 3;
7469 			scsi_ulto2b(entry->length, one->cdb_length);
7470 			one->cdb_usage[0] = opcode;
7471 			memcpy(&one->cdb_usage[1], entry->usage,
7472 			    entry->length - 1);
7473 		} else
7474 			one->support = 1;
7475 		break;
7476 	}
7477 
7478 	ctl_set_success(ctsio);
7479 	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
7480 	ctsio->be_move_done = ctl_config_move_done;
7481 	ctl_datamove((union ctl_io *)ctsio);
7482 	return(retval);
7483 }
7484 
7485 int
7486 ctl_report_supported_tmf(struct ctl_scsiio *ctsio)
7487 {
7488 	struct scsi_report_supported_tmf *cdb;
7489 	struct scsi_report_supported_tmf_data *data;
7490 	int retval;
7491 	int alloc_len, total_len;
7492 
7493 	CTL_DEBUG_PRINT(("ctl_report_supported_tmf\n"));
7494 
7495 	cdb = (struct scsi_report_supported_tmf *)ctsio->cdb;
7496 
7497 	retval = CTL_RETVAL_COMPLETE;
7498 
7499 	total_len = sizeof(struct scsi_report_supported_tmf_data);
7500 	alloc_len = scsi_4btoul(cdb->length);
7501 
7502 	ctsio->kern_data_ptr = malloc(total_len, M_CTL, M_WAITOK | M_ZERO);
7503 
7504 	ctsio->kern_sg_entries = 0;
7505 
7506 	if (total_len < alloc_len) {
7507 		ctsio->residual = alloc_len - total_len;
7508 		ctsio->kern_data_len = total_len;
7509 		ctsio->kern_total_len = total_len;
7510 	} else {
7511 		ctsio->residual = 0;
7512 		ctsio->kern_data_len = alloc_len;
7513 		ctsio->kern_total_len = alloc_len;
7514 	}
7515 	ctsio->kern_data_resid = 0;
7516 	ctsio->kern_rel_offset = 0;
7517 
7518 	data = (struct scsi_report_supported_tmf_data *)ctsio->kern_data_ptr;
7519 	data->byte1 |= RST_ATS | RST_ATSS | RST_CTSS | RST_LURS | RST_QTS |
7520 	    RST_TRS;
7521 	data->byte2 |= RST_QAES | RST_QTSS | RST_ITNRS;
7522 
7523 	ctl_set_success(ctsio);
7524 	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
7525 	ctsio->be_move_done = ctl_config_move_done;
7526 	ctl_datamove((union ctl_io *)ctsio);
7527 	return (retval);
7528 }
7529 
7530 int
7531 ctl_report_timestamp(struct ctl_scsiio *ctsio)
7532 {
7533 	struct scsi_report_timestamp *cdb;
7534 	struct scsi_report_timestamp_data *data;
7535 	struct timeval tv;
7536 	int64_t timestamp;
7537 	int retval;
7538 	int alloc_len, total_len;
7539 
7540 	CTL_DEBUG_PRINT(("ctl_report_timestamp\n"));
7541 
7542 	cdb = (struct scsi_report_timestamp *)ctsio->cdb;
7543 
7544 	retval = CTL_RETVAL_COMPLETE;
7545 
7546 	total_len = sizeof(struct scsi_report_timestamp_data);
7547 	alloc_len = scsi_4btoul(cdb->length);
7548 
7549 	ctsio->kern_data_ptr = malloc(total_len, M_CTL, M_WAITOK | M_ZERO);
7550 
7551 	ctsio->kern_sg_entries = 0;
7552 
7553 	if (total_len < alloc_len) {
7554 		ctsio->residual = alloc_len - total_len;
7555 		ctsio->kern_data_len = total_len;
7556 		ctsio->kern_total_len = total_len;
7557 	} else {
7558 		ctsio->residual = 0;
7559 		ctsio->kern_data_len = alloc_len;
7560 		ctsio->kern_total_len = alloc_len;
7561 	}
7562 	ctsio->kern_data_resid = 0;
7563 	ctsio->kern_rel_offset = 0;
7564 
7565 	data = (struct scsi_report_timestamp_data *)ctsio->kern_data_ptr;
7566 	scsi_ulto2b(sizeof(*data) - 2, data->length);
7567 	data->origin = RTS_ORIG_OUTSIDE;
7568 	getmicrotime(&tv);
7569 	timestamp = (int64_t)tv.tv_sec * 1000 + tv.tv_usec / 1000;
7570 	scsi_ulto4b(timestamp >> 16, data->timestamp);
7571 	scsi_ulto2b(timestamp & 0xffff, &data->timestamp[4]);
7572 
7573 	ctl_set_success(ctsio);
7574 	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
7575 	ctsio->be_move_done = ctl_config_move_done;
7576 	ctl_datamove((union ctl_io *)ctsio);
7577 	return (retval);
7578 }
7579 
7580 int
7581 ctl_persistent_reserve_in(struct ctl_scsiio *ctsio)
7582 {
7583 	struct scsi_per_res_in *cdb;
7584 	int alloc_len, total_len = 0;
7585 	/* struct scsi_per_res_in_rsrv in_data; */
7586 	struct ctl_lun *lun;
7587 	struct ctl_softc *softc;
7588 	uint64_t key;
7589 
7590 	CTL_DEBUG_PRINT(("ctl_persistent_reserve_in\n"));
7591 
7592 	cdb = (struct scsi_per_res_in *)ctsio->cdb;
7593 
7594 	alloc_len = scsi_2btoul(cdb->length);
7595 
7596 	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
7597 	softc = lun->ctl_softc;
7598 
7599 retry:
7600 	mtx_lock(&lun->lun_lock);
7601 	switch (cdb->action) {
7602 	case SPRI_RK: /* read keys */
7603 		total_len = sizeof(struct scsi_per_res_in_keys) +
7604 			lun->pr_key_count *
7605 			sizeof(struct scsi_per_res_key);
7606 		break;
7607 	case SPRI_RR: /* read reservation */
7608 		if (lun->flags & CTL_LUN_PR_RESERVED)
7609 			total_len = sizeof(struct scsi_per_res_in_rsrv);
7610 		else
7611 			total_len = sizeof(struct scsi_per_res_in_header);
7612 		break;
7613 	case SPRI_RC: /* report capabilities */
7614 		total_len = sizeof(struct scsi_per_res_cap);
7615 		break;
7616 	case SPRI_RS: /* read full status */
7617 		total_len = sizeof(struct scsi_per_res_in_header) +
7618 		    (sizeof(struct scsi_per_res_in_full_desc) + 256) *
7619 		    lun->pr_key_count;
7620 		break;
7621 	default:
7622 		panic("%s: Invalid PR type %#x", __func__, cdb->action);
7623 	}
7624 	mtx_unlock(&lun->lun_lock);
7625 
7626 	ctsio->kern_data_ptr = malloc(total_len, M_CTL, M_WAITOK | M_ZERO);
7627 
7628 	if (total_len < alloc_len) {
7629 		ctsio->residual = alloc_len - total_len;
7630 		ctsio->kern_data_len = total_len;
7631 		ctsio->kern_total_len = total_len;
7632 	} else {
7633 		ctsio->residual = 0;
7634 		ctsio->kern_data_len = alloc_len;
7635 		ctsio->kern_total_len = alloc_len;
7636 	}
7637 
7638 	ctsio->kern_data_resid = 0;
7639 	ctsio->kern_rel_offset = 0;
7640 	ctsio->kern_sg_entries = 0;
7641 
7642 	mtx_lock(&lun->lun_lock);
7643 	switch (cdb->action) {
7644 	case SPRI_RK: { // read keys
7645         struct scsi_per_res_in_keys *res_keys;
7646 		int i, key_count;
7647 
7648 		res_keys = (struct scsi_per_res_in_keys*)ctsio->kern_data_ptr;
7649 
7650 		/*
7651 		 * We had to drop the lock to allocate our buffer, which
7652 		 * leaves time for someone to come in with another
7653 		 * persistent reservation.  (That is unlikely, though,
7654 		 * since this should be the only persistent reservation
7655 		 * command active right now.)
7656 		 */
7657 		if (total_len != (sizeof(struct scsi_per_res_in_keys) +
7658 		    (lun->pr_key_count *
7659 		     sizeof(struct scsi_per_res_key)))){
7660 			mtx_unlock(&lun->lun_lock);
7661 			free(ctsio->kern_data_ptr, M_CTL);
7662 			printf("%s: reservation length changed, retrying\n",
7663 			       __func__);
7664 			goto retry;
7665 		}
7666 
7667 		scsi_ulto4b(lun->pr_generation, res_keys->header.generation);
7668 
7669 		scsi_ulto4b(sizeof(struct scsi_per_res_key) *
7670 			     lun->pr_key_count, res_keys->header.length);
7671 
7672 		for (i = 0, key_count = 0; i < CTL_MAX_INITIATORS; i++) {
7673 			if ((key = ctl_get_prkey(lun, i)) == 0)
7674 				continue;
7675 
7676 			/*
7677 			 * We used lun->pr_key_count to calculate the
7678 			 * size to allocate.  If it turns out the number of
7679 			 * initiators with the registered flag set is
7680 			 * larger than that (i.e. they haven't been kept in
7681 			 * sync), we've got a problem.
7682 			 */
7683 			if (key_count >= lun->pr_key_count) {
7684 				key_count++;
7685 				continue;
7686 			}
7687 			scsi_u64to8b(key, res_keys->keys[key_count].key);
7688 			key_count++;
7689 		}
7690 		break;
7691 	}
7692 	case SPRI_RR: { // read reservation
7693 		struct scsi_per_res_in_rsrv *res;
7694 		int tmp_len, header_only;
7695 
7696 		res = (struct scsi_per_res_in_rsrv *)ctsio->kern_data_ptr;
7697 
7698 		scsi_ulto4b(lun->pr_generation, res->header.generation);
7699 
7700 		if (lun->flags & CTL_LUN_PR_RESERVED)
7701 		{
7702 			tmp_len = sizeof(struct scsi_per_res_in_rsrv);
7703 			scsi_ulto4b(sizeof(struct scsi_per_res_in_rsrv_data),
7704 				    res->header.length);
7705 			header_only = 0;
7706 		} else {
7707 			tmp_len = sizeof(struct scsi_per_res_in_header);
7708 			scsi_ulto4b(0, res->header.length);
7709 			header_only = 1;
7710 		}
7711 
7712 		/*
7713 		 * We had to drop the lock to allocate our buffer, which
7714 		 * leaves time for someone to come in with another
7715 		 * persistent reservation.  (That is unlikely, though,
7716 		 * since this should be the only persistent reservation
7717 		 * command active right now.)
7718 		 */
7719 		if (tmp_len != total_len) {
7720 			mtx_unlock(&lun->lun_lock);
7721 			free(ctsio->kern_data_ptr, M_CTL);
7722 			printf("%s: reservation status changed, retrying\n",
7723 			       __func__);
7724 			goto retry;
7725 		}
7726 
7727 		/*
7728 		 * No reservation held, so we're done.
7729 		 */
7730 		if (header_only != 0)
7731 			break;
7732 
7733 		/*
7734 		 * If the registration is an All Registrants type, the key
7735 		 * is 0, since it doesn't really matter.
7736 		 */
7737 		if (lun->pr_res_idx != CTL_PR_ALL_REGISTRANTS) {
7738 			scsi_u64to8b(ctl_get_prkey(lun, lun->pr_res_idx),
7739 			    res->data.reservation);
7740 		}
7741 		res->data.scopetype = lun->pr_res_type;
7742 		break;
7743 	}
7744 	case SPRI_RC:     //report capabilities
7745 	{
7746 		struct scsi_per_res_cap *res_cap;
7747 		uint16_t type_mask;
7748 
7749 		res_cap = (struct scsi_per_res_cap *)ctsio->kern_data_ptr;
7750 		scsi_ulto2b(sizeof(*res_cap), res_cap->length);
7751 		res_cap->flags1 = SPRI_CRH;
7752 		res_cap->flags2 = SPRI_TMV | SPRI_ALLOW_5;
7753 		type_mask = SPRI_TM_WR_EX_AR |
7754 			    SPRI_TM_EX_AC_RO |
7755 			    SPRI_TM_WR_EX_RO |
7756 			    SPRI_TM_EX_AC |
7757 			    SPRI_TM_WR_EX |
7758 			    SPRI_TM_EX_AC_AR;
7759 		scsi_ulto2b(type_mask, res_cap->type_mask);
7760 		break;
7761 	}
7762 	case SPRI_RS: { // read full status
7763 		struct scsi_per_res_in_full *res_status;
7764 		struct scsi_per_res_in_full_desc *res_desc;
7765 		struct ctl_port *port;
7766 		int i, len;
7767 
7768 		res_status = (struct scsi_per_res_in_full*)ctsio->kern_data_ptr;
7769 
7770 		/*
7771 		 * We had to drop the lock to allocate our buffer, which
7772 		 * leaves time for someone to come in with another
7773 		 * persistent reservation.  (That is unlikely, though,
7774 		 * since this should be the only persistent reservation
7775 		 * command active right now.)
7776 		 */
7777 		if (total_len < (sizeof(struct scsi_per_res_in_header) +
7778 		    (sizeof(struct scsi_per_res_in_full_desc) + 256) *
7779 		     lun->pr_key_count)){
7780 			mtx_unlock(&lun->lun_lock);
7781 			free(ctsio->kern_data_ptr, M_CTL);
7782 			printf("%s: reservation length changed, retrying\n",
7783 			       __func__);
7784 			goto retry;
7785 		}
7786 
7787 		scsi_ulto4b(lun->pr_generation, res_status->header.generation);
7788 
7789 		res_desc = &res_status->desc[0];
7790 		for (i = 0; i < CTL_MAX_INITIATORS; i++) {
7791 			if ((key = ctl_get_prkey(lun, i)) == 0)
7792 				continue;
7793 
7794 			scsi_u64to8b(key, res_desc->res_key.key);
7795 			if ((lun->flags & CTL_LUN_PR_RESERVED) &&
7796 			    (lun->pr_res_idx == i ||
7797 			     lun->pr_res_idx == CTL_PR_ALL_REGISTRANTS)) {
7798 				res_desc->flags = SPRI_FULL_R_HOLDER;
7799 				res_desc->scopetype = lun->pr_res_type;
7800 			}
7801 			scsi_ulto2b(i / CTL_MAX_INIT_PER_PORT,
7802 			    res_desc->rel_trgt_port_id);
7803 			len = 0;
7804 			port = softc->ctl_ports[i / CTL_MAX_INIT_PER_PORT];
7805 			if (port != NULL)
7806 				len = ctl_create_iid(port,
7807 				    i % CTL_MAX_INIT_PER_PORT,
7808 				    res_desc->transport_id);
7809 			scsi_ulto4b(len, res_desc->additional_length);
7810 			res_desc = (struct scsi_per_res_in_full_desc *)
7811 			    &res_desc->transport_id[len];
7812 		}
7813 		scsi_ulto4b((uint8_t *)res_desc - (uint8_t *)&res_status->desc[0],
7814 		    res_status->header.length);
7815 		break;
7816 	}
7817 	default:
7818 		panic("%s: Invalid PR type %#x", __func__, cdb->action);
7819 	}
7820 	mtx_unlock(&lun->lun_lock);
7821 
7822 	ctl_set_success(ctsio);
7823 	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
7824 	ctsio->be_move_done = ctl_config_move_done;
7825 	ctl_datamove((union ctl_io *)ctsio);
7826 	return (CTL_RETVAL_COMPLETE);
7827 }
7828 
7829 /*
7830  * Returns 0 if ctl_persistent_reserve_out() should continue, non-zero if
7831  * it should return.
7832  */
7833 static int
7834 ctl_pro_preempt(struct ctl_softc *softc, struct ctl_lun *lun, uint64_t res_key,
7835 		uint64_t sa_res_key, uint8_t type, uint32_t residx,
7836 		struct ctl_scsiio *ctsio, struct scsi_per_res_out *cdb,
7837 		struct scsi_per_res_out_parms* param)
7838 {
7839 	union ctl_ha_msg persis_io;
7840 	int i;
7841 
7842 	mtx_lock(&lun->lun_lock);
7843 	if (sa_res_key == 0) {
7844 		if (lun->pr_res_idx == CTL_PR_ALL_REGISTRANTS) {
7845 			/* validate scope and type */
7846 			if ((cdb->scope_type & SPR_SCOPE_MASK) !=
7847 			     SPR_LU_SCOPE) {
7848 				mtx_unlock(&lun->lun_lock);
7849 				ctl_set_invalid_field(/*ctsio*/ ctsio,
7850 						      /*sks_valid*/ 1,
7851 						      /*command*/ 1,
7852 						      /*field*/ 2,
7853 						      /*bit_valid*/ 1,
7854 						      /*bit*/ 4);
7855 				ctl_done((union ctl_io *)ctsio);
7856 				return (1);
7857 			}
7858 
7859 		        if (type>8 || type==2 || type==4 || type==0) {
7860 				mtx_unlock(&lun->lun_lock);
7861 				ctl_set_invalid_field(/*ctsio*/ ctsio,
7862        	           				      /*sks_valid*/ 1,
7863 						      /*command*/ 1,
7864 						      /*field*/ 2,
7865 						      /*bit_valid*/ 1,
7866 						      /*bit*/ 0);
7867 				ctl_done((union ctl_io *)ctsio);
7868 				return (1);
7869 		        }
7870 
7871 			/*
7872 			 * Unregister everybody else and build UA for
7873 			 * them
7874 			 */
7875 			for(i = 0; i < CTL_MAX_INITIATORS; i++) {
7876 				if (i == residx || ctl_get_prkey(lun, i) == 0)
7877 					continue;
7878 
7879 				ctl_clr_prkey(lun, i);
7880 				ctl_est_ua(lun, i, CTL_UA_REG_PREEMPT);
7881 			}
7882 			lun->pr_key_count = 1;
7883 			lun->pr_res_type = type;
7884 			if (lun->pr_res_type != SPR_TYPE_WR_EX_AR &&
7885 			    lun->pr_res_type != SPR_TYPE_EX_AC_AR)
7886 				lun->pr_res_idx = residx;
7887 			lun->pr_generation++;
7888 			mtx_unlock(&lun->lun_lock);
7889 
7890 			/* send msg to other side */
7891 			persis_io.hdr.nexus = ctsio->io_hdr.nexus;
7892 			persis_io.hdr.msg_type = CTL_MSG_PERS_ACTION;
7893 			persis_io.pr.pr_info.action = CTL_PR_PREEMPT;
7894 			persis_io.pr.pr_info.residx = lun->pr_res_idx;
7895 			persis_io.pr.pr_info.res_type = type;
7896 			memcpy(persis_io.pr.pr_info.sa_res_key,
7897 			       param->serv_act_res_key,
7898 			       sizeof(param->serv_act_res_key));
7899 			ctl_ha_msg_send(CTL_HA_CHAN_CTL, &persis_io,
7900 			    sizeof(persis_io.pr), M_WAITOK);
7901 		} else {
7902 			/* not all registrants */
7903 			mtx_unlock(&lun->lun_lock);
7904 			free(ctsio->kern_data_ptr, M_CTL);
7905 			ctl_set_invalid_field(ctsio,
7906 					      /*sks_valid*/ 1,
7907 					      /*command*/ 0,
7908 					      /*field*/ 8,
7909 					      /*bit_valid*/ 0,
7910 					      /*bit*/ 0);
7911 			ctl_done((union ctl_io *)ctsio);
7912 			return (1);
7913 		}
7914 	} else if (lun->pr_res_idx == CTL_PR_ALL_REGISTRANTS
7915 		|| !(lun->flags & CTL_LUN_PR_RESERVED)) {
7916 		int found = 0;
7917 
7918 		if (res_key == sa_res_key) {
7919 			/* special case */
7920 			/*
7921 			 * The spec implies this is not good but doesn't
7922 			 * say what to do. There are two choices either
7923 			 * generate a res conflict or check condition
7924 			 * with illegal field in parameter data. Since
7925 			 * that is what is done when the sa_res_key is
7926 			 * zero I'll take that approach since this has
7927 			 * to do with the sa_res_key.
7928 			 */
7929 			mtx_unlock(&lun->lun_lock);
7930 			free(ctsio->kern_data_ptr, M_CTL);
7931 			ctl_set_invalid_field(ctsio,
7932 					      /*sks_valid*/ 1,
7933 					      /*command*/ 0,
7934 					      /*field*/ 8,
7935 					      /*bit_valid*/ 0,
7936 					      /*bit*/ 0);
7937 			ctl_done((union ctl_io *)ctsio);
7938 			return (1);
7939 		}
7940 
7941 		for (i = 0; i < CTL_MAX_INITIATORS; i++) {
7942 			if (ctl_get_prkey(lun, i) != sa_res_key)
7943 				continue;
7944 
7945 			found = 1;
7946 			ctl_clr_prkey(lun, i);
7947 			lun->pr_key_count--;
7948 			ctl_est_ua(lun, i, CTL_UA_REG_PREEMPT);
7949 		}
7950 		if (!found) {
7951 			mtx_unlock(&lun->lun_lock);
7952 			free(ctsio->kern_data_ptr, M_CTL);
7953 			ctl_set_reservation_conflict(ctsio);
7954 			ctl_done((union ctl_io *)ctsio);
7955 			return (CTL_RETVAL_COMPLETE);
7956 		}
7957 		lun->pr_generation++;
7958 		mtx_unlock(&lun->lun_lock);
7959 
7960 		/* send msg to other side */
7961 		persis_io.hdr.nexus = ctsio->io_hdr.nexus;
7962 		persis_io.hdr.msg_type = CTL_MSG_PERS_ACTION;
7963 		persis_io.pr.pr_info.action = CTL_PR_PREEMPT;
7964 		persis_io.pr.pr_info.residx = lun->pr_res_idx;
7965 		persis_io.pr.pr_info.res_type = type;
7966 		memcpy(persis_io.pr.pr_info.sa_res_key,
7967 		       param->serv_act_res_key,
7968 		       sizeof(param->serv_act_res_key));
7969 		ctl_ha_msg_send(CTL_HA_CHAN_CTL, &persis_io,
7970 		    sizeof(persis_io.pr), M_WAITOK);
7971 	} else {
7972 		/* Reserved but not all registrants */
7973 		/* sa_res_key is res holder */
7974 		if (sa_res_key == ctl_get_prkey(lun, lun->pr_res_idx)) {
7975 			/* validate scope and type */
7976 			if ((cdb->scope_type & SPR_SCOPE_MASK) !=
7977 			     SPR_LU_SCOPE) {
7978 				mtx_unlock(&lun->lun_lock);
7979 				ctl_set_invalid_field(/*ctsio*/ ctsio,
7980 						      /*sks_valid*/ 1,
7981 						      /*command*/ 1,
7982 						      /*field*/ 2,
7983 						      /*bit_valid*/ 1,
7984 						      /*bit*/ 4);
7985 				ctl_done((union ctl_io *)ctsio);
7986 				return (1);
7987 			}
7988 
7989 			if (type>8 || type==2 || type==4 || type==0) {
7990 				mtx_unlock(&lun->lun_lock);
7991 				ctl_set_invalid_field(/*ctsio*/ ctsio,
7992 						      /*sks_valid*/ 1,
7993 						      /*command*/ 1,
7994 						      /*field*/ 2,
7995 						      /*bit_valid*/ 1,
7996 						      /*bit*/ 0);
7997 				ctl_done((union ctl_io *)ctsio);
7998 				return (1);
7999 			}
8000 
8001 			/*
8002 			 * Do the following:
8003 			 * if sa_res_key != res_key remove all
8004 			 * registrants w/sa_res_key and generate UA
8005 			 * for these registrants(Registrations
8006 			 * Preempted) if it wasn't an exclusive
8007 			 * reservation generate UA(Reservations
8008 			 * Preempted) for all other registered nexuses
8009 			 * if the type has changed. Establish the new
8010 			 * reservation and holder. If res_key and
8011 			 * sa_res_key are the same do the above
8012 			 * except don't unregister the res holder.
8013 			 */
8014 
8015 			for(i = 0; i < CTL_MAX_INITIATORS; i++) {
8016 				if (i == residx || ctl_get_prkey(lun, i) == 0)
8017 					continue;
8018 
8019 				if (sa_res_key == ctl_get_prkey(lun, i)) {
8020 					ctl_clr_prkey(lun, i);
8021 					lun->pr_key_count--;
8022 					ctl_est_ua(lun, i, CTL_UA_REG_PREEMPT);
8023 				} else if (type != lun->pr_res_type &&
8024 				    (lun->pr_res_type == SPR_TYPE_WR_EX_RO ||
8025 				     lun->pr_res_type == SPR_TYPE_EX_AC_RO)) {
8026 					ctl_est_ua(lun, i, CTL_UA_RES_RELEASE);
8027 				}
8028 			}
8029 			lun->pr_res_type = type;
8030 			if (lun->pr_res_type != SPR_TYPE_WR_EX_AR &&
8031 			    lun->pr_res_type != SPR_TYPE_EX_AC_AR)
8032 				lun->pr_res_idx = residx;
8033 			else
8034 				lun->pr_res_idx = CTL_PR_ALL_REGISTRANTS;
8035 			lun->pr_generation++;
8036 			mtx_unlock(&lun->lun_lock);
8037 
8038 			persis_io.hdr.nexus = ctsio->io_hdr.nexus;
8039 			persis_io.hdr.msg_type = CTL_MSG_PERS_ACTION;
8040 			persis_io.pr.pr_info.action = CTL_PR_PREEMPT;
8041 			persis_io.pr.pr_info.residx = lun->pr_res_idx;
8042 			persis_io.pr.pr_info.res_type = type;
8043 			memcpy(persis_io.pr.pr_info.sa_res_key,
8044 			       param->serv_act_res_key,
8045 			       sizeof(param->serv_act_res_key));
8046 			ctl_ha_msg_send(CTL_HA_CHAN_CTL, &persis_io,
8047 			    sizeof(persis_io.pr), M_WAITOK);
8048 		} else {
8049 			/*
8050 			 * sa_res_key is not the res holder just
8051 			 * remove registrants
8052 			 */
8053 			int found=0;
8054 
8055 			for (i = 0; i < CTL_MAX_INITIATORS; i++) {
8056 				if (sa_res_key != ctl_get_prkey(lun, i))
8057 					continue;
8058 
8059 				found = 1;
8060 				ctl_clr_prkey(lun, i);
8061 				lun->pr_key_count--;
8062 				ctl_est_ua(lun, i, CTL_UA_REG_PREEMPT);
8063 			}
8064 
8065 			if (!found) {
8066 				mtx_unlock(&lun->lun_lock);
8067 				free(ctsio->kern_data_ptr, M_CTL);
8068 				ctl_set_reservation_conflict(ctsio);
8069 				ctl_done((union ctl_io *)ctsio);
8070 		        	return (1);
8071 			}
8072 			lun->pr_generation++;
8073 			mtx_unlock(&lun->lun_lock);
8074 
8075 			persis_io.hdr.nexus = ctsio->io_hdr.nexus;
8076 			persis_io.hdr.msg_type = CTL_MSG_PERS_ACTION;
8077 			persis_io.pr.pr_info.action = CTL_PR_PREEMPT;
8078 			persis_io.pr.pr_info.residx = lun->pr_res_idx;
8079 			persis_io.pr.pr_info.res_type = type;
8080 			memcpy(persis_io.pr.pr_info.sa_res_key,
8081 			       param->serv_act_res_key,
8082 			       sizeof(param->serv_act_res_key));
8083 			ctl_ha_msg_send(CTL_HA_CHAN_CTL, &persis_io,
8084 			    sizeof(persis_io.pr), M_WAITOK);
8085 		}
8086 	}
8087 	return (0);
8088 }
8089 
8090 static void
8091 ctl_pro_preempt_other(struct ctl_lun *lun, union ctl_ha_msg *msg)
8092 {
8093 	uint64_t sa_res_key;
8094 	int i;
8095 
8096 	sa_res_key = scsi_8btou64(msg->pr.pr_info.sa_res_key);
8097 
8098 	if (lun->pr_res_idx == CTL_PR_ALL_REGISTRANTS
8099 	 || lun->pr_res_idx == CTL_PR_NO_RESERVATION
8100 	 || sa_res_key != ctl_get_prkey(lun, lun->pr_res_idx)) {
8101 		if (sa_res_key == 0) {
8102 			/*
8103 			 * Unregister everybody else and build UA for
8104 			 * them
8105 			 */
8106 			for(i = 0; i < CTL_MAX_INITIATORS; i++) {
8107 				if (i == msg->pr.pr_info.residx ||
8108 				    ctl_get_prkey(lun, i) == 0)
8109 					continue;
8110 
8111 				ctl_clr_prkey(lun, i);
8112 				ctl_est_ua(lun, i, CTL_UA_REG_PREEMPT);
8113 			}
8114 
8115 			lun->pr_key_count = 1;
8116 			lun->pr_res_type = msg->pr.pr_info.res_type;
8117 			if (lun->pr_res_type != SPR_TYPE_WR_EX_AR &&
8118 			    lun->pr_res_type != SPR_TYPE_EX_AC_AR)
8119 				lun->pr_res_idx = msg->pr.pr_info.residx;
8120 		} else {
8121 		        for (i = 0; i < CTL_MAX_INITIATORS; i++) {
8122 				if (sa_res_key == ctl_get_prkey(lun, i))
8123 					continue;
8124 
8125 				ctl_clr_prkey(lun, i);
8126 				lun->pr_key_count--;
8127 				ctl_est_ua(lun, i, CTL_UA_REG_PREEMPT);
8128 			}
8129 		}
8130 	} else {
8131 		for (i = 0; i < CTL_MAX_INITIATORS; i++) {
8132 			if (i == msg->pr.pr_info.residx ||
8133 			    ctl_get_prkey(lun, i) == 0)
8134 				continue;
8135 
8136 			if (sa_res_key == ctl_get_prkey(lun, i)) {
8137 				ctl_clr_prkey(lun, i);
8138 				lun->pr_key_count--;
8139 				ctl_est_ua(lun, i, CTL_UA_REG_PREEMPT);
8140 			} else if (msg->pr.pr_info.res_type != lun->pr_res_type
8141 			    && (lun->pr_res_type == SPR_TYPE_WR_EX_RO ||
8142 			     lun->pr_res_type == SPR_TYPE_EX_AC_RO)) {
8143 				ctl_est_ua(lun, i, CTL_UA_RES_RELEASE);
8144 			}
8145 		}
8146 		lun->pr_res_type = msg->pr.pr_info.res_type;
8147 		if (lun->pr_res_type != SPR_TYPE_WR_EX_AR &&
8148 		    lun->pr_res_type != SPR_TYPE_EX_AC_AR)
8149 			lun->pr_res_idx = msg->pr.pr_info.residx;
8150 		else
8151 			lun->pr_res_idx = CTL_PR_ALL_REGISTRANTS;
8152 	}
8153 	lun->pr_generation++;
8154 
8155 }
8156 
8157 
8158 int
8159 ctl_persistent_reserve_out(struct ctl_scsiio *ctsio)
8160 {
8161 	int retval;
8162 	u_int32_t param_len;
8163 	struct scsi_per_res_out *cdb;
8164 	struct ctl_lun *lun;
8165 	struct scsi_per_res_out_parms* param;
8166 	struct ctl_softc *softc;
8167 	uint32_t residx;
8168 	uint64_t res_key, sa_res_key, key;
8169 	uint8_t type;
8170 	union ctl_ha_msg persis_io;
8171 	int    i;
8172 
8173 	CTL_DEBUG_PRINT(("ctl_persistent_reserve_out\n"));
8174 
8175 	retval = CTL_RETVAL_COMPLETE;
8176 
8177 	cdb = (struct scsi_per_res_out *)ctsio->cdb;
8178 	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
8179 	softc = lun->ctl_softc;
8180 
8181 	/*
8182 	 * We only support whole-LUN scope.  The scope & type are ignored for
8183 	 * register, register and ignore existing key and clear.
8184 	 * We sometimes ignore scope and type on preempts too!!
8185 	 * Verify reservation type here as well.
8186 	 */
8187 	type = cdb->scope_type & SPR_TYPE_MASK;
8188 	if ((cdb->action == SPRO_RESERVE)
8189 	 || (cdb->action == SPRO_RELEASE)) {
8190 		if ((cdb->scope_type & SPR_SCOPE_MASK) != SPR_LU_SCOPE) {
8191 			ctl_set_invalid_field(/*ctsio*/ ctsio,
8192 					      /*sks_valid*/ 1,
8193 					      /*command*/ 1,
8194 					      /*field*/ 2,
8195 					      /*bit_valid*/ 1,
8196 					      /*bit*/ 4);
8197 			ctl_done((union ctl_io *)ctsio);
8198 			return (CTL_RETVAL_COMPLETE);
8199 		}
8200 
8201 		if (type>8 || type==2 || type==4 || type==0) {
8202 			ctl_set_invalid_field(/*ctsio*/ ctsio,
8203 					      /*sks_valid*/ 1,
8204 					      /*command*/ 1,
8205 					      /*field*/ 2,
8206 					      /*bit_valid*/ 1,
8207 					      /*bit*/ 0);
8208 			ctl_done((union ctl_io *)ctsio);
8209 			return (CTL_RETVAL_COMPLETE);
8210 		}
8211 	}
8212 
8213 	param_len = scsi_4btoul(cdb->length);
8214 
8215 	if ((ctsio->io_hdr.flags & CTL_FLAG_ALLOCATED) == 0) {
8216 		ctsio->kern_data_ptr = malloc(param_len, M_CTL, M_WAITOK);
8217 		ctsio->kern_data_len = param_len;
8218 		ctsio->kern_total_len = param_len;
8219 		ctsio->kern_data_resid = 0;
8220 		ctsio->kern_rel_offset = 0;
8221 		ctsio->kern_sg_entries = 0;
8222 		ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
8223 		ctsio->be_move_done = ctl_config_move_done;
8224 		ctl_datamove((union ctl_io *)ctsio);
8225 
8226 		return (CTL_RETVAL_COMPLETE);
8227 	}
8228 
8229 	param = (struct scsi_per_res_out_parms *)ctsio->kern_data_ptr;
8230 
8231 	residx = ctl_get_initindex(&ctsio->io_hdr.nexus);
8232 	res_key = scsi_8btou64(param->res_key.key);
8233 	sa_res_key = scsi_8btou64(param->serv_act_res_key);
8234 
8235 	/*
8236 	 * Validate the reservation key here except for SPRO_REG_IGNO
8237 	 * This must be done for all other service actions
8238 	 */
8239 	if ((cdb->action & SPRO_ACTION_MASK) != SPRO_REG_IGNO) {
8240 		mtx_lock(&lun->lun_lock);
8241 		if ((key = ctl_get_prkey(lun, residx)) != 0) {
8242 			if (res_key != key) {
8243 				/*
8244 				 * The current key passed in doesn't match
8245 				 * the one the initiator previously
8246 				 * registered.
8247 				 */
8248 				mtx_unlock(&lun->lun_lock);
8249 				free(ctsio->kern_data_ptr, M_CTL);
8250 				ctl_set_reservation_conflict(ctsio);
8251 				ctl_done((union ctl_io *)ctsio);
8252 				return (CTL_RETVAL_COMPLETE);
8253 			}
8254 		} else if ((cdb->action & SPRO_ACTION_MASK) != SPRO_REGISTER) {
8255 			/*
8256 			 * We are not registered
8257 			 */
8258 			mtx_unlock(&lun->lun_lock);
8259 			free(ctsio->kern_data_ptr, M_CTL);
8260 			ctl_set_reservation_conflict(ctsio);
8261 			ctl_done((union ctl_io *)ctsio);
8262 			return (CTL_RETVAL_COMPLETE);
8263 		} else if (res_key != 0) {
8264 			/*
8265 			 * We are not registered and trying to register but
8266 			 * the register key isn't zero.
8267 			 */
8268 			mtx_unlock(&lun->lun_lock);
8269 			free(ctsio->kern_data_ptr, M_CTL);
8270 			ctl_set_reservation_conflict(ctsio);
8271 			ctl_done((union ctl_io *)ctsio);
8272 			return (CTL_RETVAL_COMPLETE);
8273 		}
8274 		mtx_unlock(&lun->lun_lock);
8275 	}
8276 
8277 	switch (cdb->action & SPRO_ACTION_MASK) {
8278 	case SPRO_REGISTER:
8279 	case SPRO_REG_IGNO: {
8280 
8281 #if 0
8282 		printf("Registration received\n");
8283 #endif
8284 
8285 		/*
8286 		 * We don't support any of these options, as we report in
8287 		 * the read capabilities request (see
8288 		 * ctl_persistent_reserve_in(), above).
8289 		 */
8290 		if ((param->flags & SPR_SPEC_I_PT)
8291 		 || (param->flags & SPR_ALL_TG_PT)
8292 		 || (param->flags & SPR_APTPL)) {
8293 			int bit_ptr;
8294 
8295 			if (param->flags & SPR_APTPL)
8296 				bit_ptr = 0;
8297 			else if (param->flags & SPR_ALL_TG_PT)
8298 				bit_ptr = 2;
8299 			else /* SPR_SPEC_I_PT */
8300 				bit_ptr = 3;
8301 
8302 			free(ctsio->kern_data_ptr, M_CTL);
8303 			ctl_set_invalid_field(ctsio,
8304 					      /*sks_valid*/ 1,
8305 					      /*command*/ 0,
8306 					      /*field*/ 20,
8307 					      /*bit_valid*/ 1,
8308 					      /*bit*/ bit_ptr);
8309 			ctl_done((union ctl_io *)ctsio);
8310 			return (CTL_RETVAL_COMPLETE);
8311 		}
8312 
8313 		mtx_lock(&lun->lun_lock);
8314 
8315 		/*
8316 		 * The initiator wants to clear the
8317 		 * key/unregister.
8318 		 */
8319 		if (sa_res_key == 0) {
8320 			if ((res_key == 0
8321 			  && (cdb->action & SPRO_ACTION_MASK) == SPRO_REGISTER)
8322 			 || ((cdb->action & SPRO_ACTION_MASK) == SPRO_REG_IGNO
8323 			  && ctl_get_prkey(lun, residx) == 0)) {
8324 				mtx_unlock(&lun->lun_lock);
8325 				goto done;
8326 			}
8327 
8328 			ctl_clr_prkey(lun, residx);
8329 			lun->pr_key_count--;
8330 
8331 			if (residx == lun->pr_res_idx) {
8332 				lun->flags &= ~CTL_LUN_PR_RESERVED;
8333 				lun->pr_res_idx = CTL_PR_NO_RESERVATION;
8334 
8335 				if ((lun->pr_res_type == SPR_TYPE_WR_EX_RO ||
8336 				     lun->pr_res_type == SPR_TYPE_EX_AC_RO) &&
8337 				    lun->pr_key_count) {
8338 					/*
8339 					 * If the reservation is a registrants
8340 					 * only type we need to generate a UA
8341 					 * for other registered inits.  The
8342 					 * sense code should be RESERVATIONS
8343 					 * RELEASED
8344 					 */
8345 
8346 					for (i = softc->init_min; i < softc->init_max; i++){
8347 						if (ctl_get_prkey(lun, i) == 0)
8348 							continue;
8349 						ctl_est_ua(lun, i,
8350 						    CTL_UA_RES_RELEASE);
8351 					}
8352 				}
8353 				lun->pr_res_type = 0;
8354 			} else if (lun->pr_res_idx == CTL_PR_ALL_REGISTRANTS) {
8355 				if (lun->pr_key_count==0) {
8356 					lun->flags &= ~CTL_LUN_PR_RESERVED;
8357 					lun->pr_res_type = 0;
8358 					lun->pr_res_idx = CTL_PR_NO_RESERVATION;
8359 				}
8360 			}
8361 			lun->pr_generation++;
8362 			mtx_unlock(&lun->lun_lock);
8363 
8364 			persis_io.hdr.nexus = ctsio->io_hdr.nexus;
8365 			persis_io.hdr.msg_type = CTL_MSG_PERS_ACTION;
8366 			persis_io.pr.pr_info.action = CTL_PR_UNREG_KEY;
8367 			persis_io.pr.pr_info.residx = residx;
8368 			ctl_ha_msg_send(CTL_HA_CHAN_CTL, &persis_io,
8369 			    sizeof(persis_io.pr), M_WAITOK);
8370 		} else /* sa_res_key != 0 */ {
8371 
8372 			/*
8373 			 * If we aren't registered currently then increment
8374 			 * the key count and set the registered flag.
8375 			 */
8376 			ctl_alloc_prkey(lun, residx);
8377 			if (ctl_get_prkey(lun, residx) == 0)
8378 				lun->pr_key_count++;
8379 			ctl_set_prkey(lun, residx, sa_res_key);
8380 			lun->pr_generation++;
8381 			mtx_unlock(&lun->lun_lock);
8382 
8383 			persis_io.hdr.nexus = ctsio->io_hdr.nexus;
8384 			persis_io.hdr.msg_type = CTL_MSG_PERS_ACTION;
8385 			persis_io.pr.pr_info.action = CTL_PR_REG_KEY;
8386 			persis_io.pr.pr_info.residx = residx;
8387 			memcpy(persis_io.pr.pr_info.sa_res_key,
8388 			       param->serv_act_res_key,
8389 			       sizeof(param->serv_act_res_key));
8390 			ctl_ha_msg_send(CTL_HA_CHAN_CTL, &persis_io,
8391 			    sizeof(persis_io.pr), M_WAITOK);
8392 		}
8393 
8394 		break;
8395 	}
8396 	case SPRO_RESERVE:
8397 #if 0
8398                 printf("Reserve executed type %d\n", type);
8399 #endif
8400 		mtx_lock(&lun->lun_lock);
8401 		if (lun->flags & CTL_LUN_PR_RESERVED) {
8402 			/*
8403 			 * if this isn't the reservation holder and it's
8404 			 * not a "all registrants" type or if the type is
8405 			 * different then we have a conflict
8406 			 */
8407 			if ((lun->pr_res_idx != residx
8408 			  && lun->pr_res_idx != CTL_PR_ALL_REGISTRANTS)
8409 			 || lun->pr_res_type != type) {
8410 				mtx_unlock(&lun->lun_lock);
8411 				free(ctsio->kern_data_ptr, M_CTL);
8412 				ctl_set_reservation_conflict(ctsio);
8413 				ctl_done((union ctl_io *)ctsio);
8414 				return (CTL_RETVAL_COMPLETE);
8415 			}
8416 			mtx_unlock(&lun->lun_lock);
8417 		} else /* create a reservation */ {
8418 			/*
8419 			 * If it's not an "all registrants" type record
8420 			 * reservation holder
8421 			 */
8422 			if (type != SPR_TYPE_WR_EX_AR
8423 			 && type != SPR_TYPE_EX_AC_AR)
8424 				lun->pr_res_idx = residx; /* Res holder */
8425 			else
8426 				lun->pr_res_idx = CTL_PR_ALL_REGISTRANTS;
8427 
8428 			lun->flags |= CTL_LUN_PR_RESERVED;
8429 			lun->pr_res_type = type;
8430 
8431 			mtx_unlock(&lun->lun_lock);
8432 
8433 			/* send msg to other side */
8434 			persis_io.hdr.nexus = ctsio->io_hdr.nexus;
8435 			persis_io.hdr.msg_type = CTL_MSG_PERS_ACTION;
8436 			persis_io.pr.pr_info.action = CTL_PR_RESERVE;
8437 			persis_io.pr.pr_info.residx = lun->pr_res_idx;
8438 			persis_io.pr.pr_info.res_type = type;
8439 			ctl_ha_msg_send(CTL_HA_CHAN_CTL, &persis_io,
8440 			    sizeof(persis_io.pr), M_WAITOK);
8441 		}
8442 		break;
8443 
8444 	case SPRO_RELEASE:
8445 		mtx_lock(&lun->lun_lock);
8446 		if ((lun->flags & CTL_LUN_PR_RESERVED) == 0) {
8447 			/* No reservation exists return good status */
8448 			mtx_unlock(&lun->lun_lock);
8449 			goto done;
8450 		}
8451 		/*
8452 		 * Is this nexus a reservation holder?
8453 		 */
8454 		if (lun->pr_res_idx != residx
8455 		 && lun->pr_res_idx != CTL_PR_ALL_REGISTRANTS) {
8456 			/*
8457 			 * not a res holder return good status but
8458 			 * do nothing
8459 			 */
8460 			mtx_unlock(&lun->lun_lock);
8461 			goto done;
8462 		}
8463 
8464 		if (lun->pr_res_type != type) {
8465 			mtx_unlock(&lun->lun_lock);
8466 			free(ctsio->kern_data_ptr, M_CTL);
8467 			ctl_set_illegal_pr_release(ctsio);
8468 			ctl_done((union ctl_io *)ctsio);
8469 			return (CTL_RETVAL_COMPLETE);
8470 		}
8471 
8472 		/* okay to release */
8473 		lun->flags &= ~CTL_LUN_PR_RESERVED;
8474 		lun->pr_res_idx = CTL_PR_NO_RESERVATION;
8475 		lun->pr_res_type = 0;
8476 
8477 		/*
8478 		 * if this isn't an exclusive access
8479 		 * res generate UA for all other
8480 		 * registrants.
8481 		 */
8482 		if (type != SPR_TYPE_EX_AC
8483 		 && type != SPR_TYPE_WR_EX) {
8484 			for (i = softc->init_min; i < softc->init_max; i++) {
8485 				if (i == residx || ctl_get_prkey(lun, i) == 0)
8486 					continue;
8487 				ctl_est_ua(lun, i, CTL_UA_RES_RELEASE);
8488 			}
8489 		}
8490 		mtx_unlock(&lun->lun_lock);
8491 
8492 		/* Send msg to other side */
8493 		persis_io.hdr.nexus = ctsio->io_hdr.nexus;
8494 		persis_io.hdr.msg_type = CTL_MSG_PERS_ACTION;
8495 		persis_io.pr.pr_info.action = CTL_PR_RELEASE;
8496 		ctl_ha_msg_send(CTL_HA_CHAN_CTL, &persis_io,
8497 		     sizeof(persis_io.pr), M_WAITOK);
8498 		break;
8499 
8500 	case SPRO_CLEAR:
8501 		/* send msg to other side */
8502 
8503 		mtx_lock(&lun->lun_lock);
8504 		lun->flags &= ~CTL_LUN_PR_RESERVED;
8505 		lun->pr_res_type = 0;
8506 		lun->pr_key_count = 0;
8507 		lun->pr_res_idx = CTL_PR_NO_RESERVATION;
8508 
8509 		ctl_clr_prkey(lun, residx);
8510 		for (i = 0; i < CTL_MAX_INITIATORS; i++)
8511 			if (ctl_get_prkey(lun, i) != 0) {
8512 				ctl_clr_prkey(lun, i);
8513 				ctl_est_ua(lun, i, CTL_UA_REG_PREEMPT);
8514 			}
8515 		lun->pr_generation++;
8516 		mtx_unlock(&lun->lun_lock);
8517 
8518 		persis_io.hdr.nexus = ctsio->io_hdr.nexus;
8519 		persis_io.hdr.msg_type = CTL_MSG_PERS_ACTION;
8520 		persis_io.pr.pr_info.action = CTL_PR_CLEAR;
8521 		ctl_ha_msg_send(CTL_HA_CHAN_CTL, &persis_io,
8522 		     sizeof(persis_io.pr), M_WAITOK);
8523 		break;
8524 
8525 	case SPRO_PREEMPT:
8526 	case SPRO_PRE_ABO: {
8527 		int nretval;
8528 
8529 		nretval = ctl_pro_preempt(softc, lun, res_key, sa_res_key, type,
8530 					  residx, ctsio, cdb, param);
8531 		if (nretval != 0)
8532 			return (CTL_RETVAL_COMPLETE);
8533 		break;
8534 	}
8535 	default:
8536 		panic("%s: Invalid PR type %#x", __func__, cdb->action);
8537 	}
8538 
8539 done:
8540 	free(ctsio->kern_data_ptr, M_CTL);
8541 	ctl_set_success(ctsio);
8542 	ctl_done((union ctl_io *)ctsio);
8543 
8544 	return (retval);
8545 }
8546 
8547 /*
8548  * This routine is for handling a message from the other SC pertaining to
8549  * persistent reserve out. All the error checking will have been done
8550  * so only perorming the action need be done here to keep the two
8551  * in sync.
8552  */
8553 static void
8554 ctl_hndl_per_res_out_on_other_sc(union ctl_ha_msg *msg)
8555 {
8556 	struct ctl_softc *softc = control_softc;
8557 	struct ctl_lun *lun;
8558 	int i;
8559 	uint32_t residx, targ_lun;
8560 
8561 	targ_lun = msg->hdr.nexus.targ_mapped_lun;
8562 	mtx_lock(&softc->ctl_lock);
8563 	if ((targ_lun >= CTL_MAX_LUNS) ||
8564 	    ((lun = softc->ctl_luns[targ_lun]) == NULL)) {
8565 		mtx_unlock(&softc->ctl_lock);
8566 		return;
8567 	}
8568 	mtx_lock(&lun->lun_lock);
8569 	mtx_unlock(&softc->ctl_lock);
8570 	if (lun->flags & CTL_LUN_DISABLED) {
8571 		mtx_unlock(&lun->lun_lock);
8572 		return;
8573 	}
8574 	residx = ctl_get_initindex(&msg->hdr.nexus);
8575 	switch(msg->pr.pr_info.action) {
8576 	case CTL_PR_REG_KEY:
8577 		ctl_alloc_prkey(lun, msg->pr.pr_info.residx);
8578 		if (ctl_get_prkey(lun, msg->pr.pr_info.residx) == 0)
8579 			lun->pr_key_count++;
8580 		ctl_set_prkey(lun, msg->pr.pr_info.residx,
8581 		    scsi_8btou64(msg->pr.pr_info.sa_res_key));
8582 		lun->pr_generation++;
8583 		break;
8584 
8585 	case CTL_PR_UNREG_KEY:
8586 		ctl_clr_prkey(lun, msg->pr.pr_info.residx);
8587 		lun->pr_key_count--;
8588 
8589 		/* XXX Need to see if the reservation has been released */
8590 		/* if so do we need to generate UA? */
8591 		if (msg->pr.pr_info.residx == lun->pr_res_idx) {
8592 			lun->flags &= ~CTL_LUN_PR_RESERVED;
8593 			lun->pr_res_idx = CTL_PR_NO_RESERVATION;
8594 
8595 			if ((lun->pr_res_type == SPR_TYPE_WR_EX_RO ||
8596 			     lun->pr_res_type == SPR_TYPE_EX_AC_RO) &&
8597 			    lun->pr_key_count) {
8598 				/*
8599 				 * If the reservation is a registrants
8600 				 * only type we need to generate a UA
8601 				 * for other registered inits.  The
8602 				 * sense code should be RESERVATIONS
8603 				 * RELEASED
8604 				 */
8605 
8606 				for (i = softc->init_min; i < softc->init_max; i++) {
8607 					if (ctl_get_prkey(lun, i) == 0)
8608 						continue;
8609 
8610 					ctl_est_ua(lun, i, CTL_UA_RES_RELEASE);
8611 				}
8612 			}
8613 			lun->pr_res_type = 0;
8614 		} else if (lun->pr_res_idx == CTL_PR_ALL_REGISTRANTS) {
8615 			if (lun->pr_key_count==0) {
8616 				lun->flags &= ~CTL_LUN_PR_RESERVED;
8617 				lun->pr_res_type = 0;
8618 				lun->pr_res_idx = CTL_PR_NO_RESERVATION;
8619 			}
8620 		}
8621 		lun->pr_generation++;
8622 		break;
8623 
8624 	case CTL_PR_RESERVE:
8625 		lun->flags |= CTL_LUN_PR_RESERVED;
8626 		lun->pr_res_type = msg->pr.pr_info.res_type;
8627 		lun->pr_res_idx = msg->pr.pr_info.residx;
8628 
8629 		break;
8630 
8631 	case CTL_PR_RELEASE:
8632 		/*
8633 		 * if this isn't an exclusive access res generate UA for all
8634 		 * other registrants.
8635 		 */
8636 		if (lun->pr_res_type != SPR_TYPE_EX_AC &&
8637 		    lun->pr_res_type != SPR_TYPE_WR_EX) {
8638 			for (i = softc->init_min; i < softc->init_max; i++)
8639 				if (i == residx || ctl_get_prkey(lun, i) == 0)
8640 					continue;
8641 				ctl_est_ua(lun, i, CTL_UA_RES_RELEASE);
8642 		}
8643 
8644 		lun->flags &= ~CTL_LUN_PR_RESERVED;
8645 		lun->pr_res_idx = CTL_PR_NO_RESERVATION;
8646 		lun->pr_res_type = 0;
8647 		break;
8648 
8649 	case CTL_PR_PREEMPT:
8650 		ctl_pro_preempt_other(lun, msg);
8651 		break;
8652 	case CTL_PR_CLEAR:
8653 		lun->flags &= ~CTL_LUN_PR_RESERVED;
8654 		lun->pr_res_type = 0;
8655 		lun->pr_key_count = 0;
8656 		lun->pr_res_idx = CTL_PR_NO_RESERVATION;
8657 
8658 		for (i=0; i < CTL_MAX_INITIATORS; i++) {
8659 			if (ctl_get_prkey(lun, i) == 0)
8660 				continue;
8661 			ctl_clr_prkey(lun, i);
8662 			ctl_est_ua(lun, i, CTL_UA_REG_PREEMPT);
8663 		}
8664 		lun->pr_generation++;
8665 		break;
8666 	}
8667 
8668 	mtx_unlock(&lun->lun_lock);
8669 }
8670 
8671 int
8672 ctl_read_write(struct ctl_scsiio *ctsio)
8673 {
8674 	struct ctl_lun *lun;
8675 	struct ctl_lba_len_flags *lbalen;
8676 	uint64_t lba;
8677 	uint32_t num_blocks;
8678 	int flags, retval;
8679 	int isread;
8680 
8681 	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
8682 
8683 	CTL_DEBUG_PRINT(("ctl_read_write: command: %#x\n", ctsio->cdb[0]));
8684 
8685 	flags = 0;
8686 	isread = ctsio->cdb[0] == READ_6  || ctsio->cdb[0] == READ_10
8687 	      || ctsio->cdb[0] == READ_12 || ctsio->cdb[0] == READ_16;
8688 	switch (ctsio->cdb[0]) {
8689 	case READ_6:
8690 	case WRITE_6: {
8691 		struct scsi_rw_6 *cdb;
8692 
8693 		cdb = (struct scsi_rw_6 *)ctsio->cdb;
8694 
8695 		lba = scsi_3btoul(cdb->addr);
8696 		/* only 5 bits are valid in the most significant address byte */
8697 		lba &= 0x1fffff;
8698 		num_blocks = cdb->length;
8699 		/*
8700 		 * This is correct according to SBC-2.
8701 		 */
8702 		if (num_blocks == 0)
8703 			num_blocks = 256;
8704 		break;
8705 	}
8706 	case READ_10:
8707 	case WRITE_10: {
8708 		struct scsi_rw_10 *cdb;
8709 
8710 		cdb = (struct scsi_rw_10 *)ctsio->cdb;
8711 		if (cdb->byte2 & SRW10_FUA)
8712 			flags |= CTL_LLF_FUA;
8713 		if (cdb->byte2 & SRW10_DPO)
8714 			flags |= CTL_LLF_DPO;
8715 		lba = scsi_4btoul(cdb->addr);
8716 		num_blocks = scsi_2btoul(cdb->length);
8717 		break;
8718 	}
8719 	case WRITE_VERIFY_10: {
8720 		struct scsi_write_verify_10 *cdb;
8721 
8722 		cdb = (struct scsi_write_verify_10 *)ctsio->cdb;
8723 		flags |= CTL_LLF_FUA;
8724 		if (cdb->byte2 & SWV_DPO)
8725 			flags |= CTL_LLF_DPO;
8726 		lba = scsi_4btoul(cdb->addr);
8727 		num_blocks = scsi_2btoul(cdb->length);
8728 		break;
8729 	}
8730 	case READ_12:
8731 	case WRITE_12: {
8732 		struct scsi_rw_12 *cdb;
8733 
8734 		cdb = (struct scsi_rw_12 *)ctsio->cdb;
8735 		if (cdb->byte2 & SRW12_FUA)
8736 			flags |= CTL_LLF_FUA;
8737 		if (cdb->byte2 & SRW12_DPO)
8738 			flags |= CTL_LLF_DPO;
8739 		lba = scsi_4btoul(cdb->addr);
8740 		num_blocks = scsi_4btoul(cdb->length);
8741 		break;
8742 	}
8743 	case WRITE_VERIFY_12: {
8744 		struct scsi_write_verify_12 *cdb;
8745 
8746 		cdb = (struct scsi_write_verify_12 *)ctsio->cdb;
8747 		flags |= CTL_LLF_FUA;
8748 		if (cdb->byte2 & SWV_DPO)
8749 			flags |= CTL_LLF_DPO;
8750 		lba = scsi_4btoul(cdb->addr);
8751 		num_blocks = scsi_4btoul(cdb->length);
8752 		break;
8753 	}
8754 	case READ_16:
8755 	case WRITE_16: {
8756 		struct scsi_rw_16 *cdb;
8757 
8758 		cdb = (struct scsi_rw_16 *)ctsio->cdb;
8759 		if (cdb->byte2 & SRW12_FUA)
8760 			flags |= CTL_LLF_FUA;
8761 		if (cdb->byte2 & SRW12_DPO)
8762 			flags |= CTL_LLF_DPO;
8763 		lba = scsi_8btou64(cdb->addr);
8764 		num_blocks = scsi_4btoul(cdb->length);
8765 		break;
8766 	}
8767 	case WRITE_ATOMIC_16: {
8768 		struct scsi_write_atomic_16 *cdb;
8769 
8770 		if (lun->be_lun->atomicblock == 0) {
8771 			ctl_set_invalid_opcode(ctsio);
8772 			ctl_done((union ctl_io *)ctsio);
8773 			return (CTL_RETVAL_COMPLETE);
8774 		}
8775 
8776 		cdb = (struct scsi_write_atomic_16 *)ctsio->cdb;
8777 		if (cdb->byte2 & SRW12_FUA)
8778 			flags |= CTL_LLF_FUA;
8779 		if (cdb->byte2 & SRW12_DPO)
8780 			flags |= CTL_LLF_DPO;
8781 		lba = scsi_8btou64(cdb->addr);
8782 		num_blocks = scsi_2btoul(cdb->length);
8783 		if (num_blocks > lun->be_lun->atomicblock) {
8784 			ctl_set_invalid_field(ctsio, /*sks_valid*/ 1,
8785 			    /*command*/ 1, /*field*/ 12, /*bit_valid*/ 0,
8786 			    /*bit*/ 0);
8787 			ctl_done((union ctl_io *)ctsio);
8788 			return (CTL_RETVAL_COMPLETE);
8789 		}
8790 		break;
8791 	}
8792 	case WRITE_VERIFY_16: {
8793 		struct scsi_write_verify_16 *cdb;
8794 
8795 		cdb = (struct scsi_write_verify_16 *)ctsio->cdb;
8796 		flags |= CTL_LLF_FUA;
8797 		if (cdb->byte2 & SWV_DPO)
8798 			flags |= CTL_LLF_DPO;
8799 		lba = scsi_8btou64(cdb->addr);
8800 		num_blocks = scsi_4btoul(cdb->length);
8801 		break;
8802 	}
8803 	default:
8804 		/*
8805 		 * We got a command we don't support.  This shouldn't
8806 		 * happen, commands should be filtered out above us.
8807 		 */
8808 		ctl_set_invalid_opcode(ctsio);
8809 		ctl_done((union ctl_io *)ctsio);
8810 
8811 		return (CTL_RETVAL_COMPLETE);
8812 		break; /* NOTREACHED */
8813 	}
8814 
8815 	/*
8816 	 * The first check is to make sure we're in bounds, the second
8817 	 * check is to catch wrap-around problems.  If the lba + num blocks
8818 	 * is less than the lba, then we've wrapped around and the block
8819 	 * range is invalid anyway.
8820 	 */
8821 	if (((lba + num_blocks) > (lun->be_lun->maxlba + 1))
8822 	 || ((lba + num_blocks) < lba)) {
8823 		ctl_set_lba_out_of_range(ctsio);
8824 		ctl_done((union ctl_io *)ctsio);
8825 		return (CTL_RETVAL_COMPLETE);
8826 	}
8827 
8828 	/*
8829 	 * According to SBC-3, a transfer length of 0 is not an error.
8830 	 * Note that this cannot happen with WRITE(6) or READ(6), since 0
8831 	 * translates to 256 blocks for those commands.
8832 	 */
8833 	if (num_blocks == 0) {
8834 		ctl_set_success(ctsio);
8835 		ctl_done((union ctl_io *)ctsio);
8836 		return (CTL_RETVAL_COMPLETE);
8837 	}
8838 
8839 	/* Set FUA and/or DPO if caches are disabled. */
8840 	if (isread) {
8841 		if ((lun->mode_pages.caching_page[CTL_PAGE_CURRENT].flags1 &
8842 		    SCP_RCD) != 0)
8843 			flags |= CTL_LLF_FUA | CTL_LLF_DPO;
8844 	} else {
8845 		if ((lun->mode_pages.caching_page[CTL_PAGE_CURRENT].flags1 &
8846 		    SCP_WCE) == 0)
8847 			flags |= CTL_LLF_FUA;
8848 	}
8849 
8850 	lbalen = (struct ctl_lba_len_flags *)
8851 	    &ctsio->io_hdr.ctl_private[CTL_PRIV_LBA_LEN];
8852 	lbalen->lba = lba;
8853 	lbalen->len = num_blocks;
8854 	lbalen->flags = (isread ? CTL_LLF_READ : CTL_LLF_WRITE) | flags;
8855 
8856 	ctsio->kern_total_len = num_blocks * lun->be_lun->blocksize;
8857 	ctsio->kern_rel_offset = 0;
8858 
8859 	CTL_DEBUG_PRINT(("ctl_read_write: calling data_submit()\n"));
8860 
8861 	retval = lun->backend->data_submit((union ctl_io *)ctsio);
8862 	return (retval);
8863 }
8864 
8865 static int
8866 ctl_cnw_cont(union ctl_io *io)
8867 {
8868 	struct ctl_scsiio *ctsio;
8869 	struct ctl_lun *lun;
8870 	struct ctl_lba_len_flags *lbalen;
8871 	int retval;
8872 
8873 	ctsio = &io->scsiio;
8874 	ctsio->io_hdr.status = CTL_STATUS_NONE;
8875 	ctsio->io_hdr.flags &= ~CTL_FLAG_IO_CONT;
8876 	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
8877 	lbalen = (struct ctl_lba_len_flags *)
8878 	    &ctsio->io_hdr.ctl_private[CTL_PRIV_LBA_LEN];
8879 	lbalen->flags &= ~CTL_LLF_COMPARE;
8880 	lbalen->flags |= CTL_LLF_WRITE;
8881 
8882 	CTL_DEBUG_PRINT(("ctl_cnw_cont: calling data_submit()\n"));
8883 	retval = lun->backend->data_submit((union ctl_io *)ctsio);
8884 	return (retval);
8885 }
8886 
8887 int
8888 ctl_cnw(struct ctl_scsiio *ctsio)
8889 {
8890 	struct ctl_lun *lun;
8891 	struct ctl_lba_len_flags *lbalen;
8892 	uint64_t lba;
8893 	uint32_t num_blocks;
8894 	int flags, retval;
8895 
8896 	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
8897 
8898 	CTL_DEBUG_PRINT(("ctl_cnw: command: %#x\n", ctsio->cdb[0]));
8899 
8900 	flags = 0;
8901 	switch (ctsio->cdb[0]) {
8902 	case COMPARE_AND_WRITE: {
8903 		struct scsi_compare_and_write *cdb;
8904 
8905 		cdb = (struct scsi_compare_and_write *)ctsio->cdb;
8906 		if (cdb->byte2 & SRW10_FUA)
8907 			flags |= CTL_LLF_FUA;
8908 		if (cdb->byte2 & SRW10_DPO)
8909 			flags |= CTL_LLF_DPO;
8910 		lba = scsi_8btou64(cdb->addr);
8911 		num_blocks = cdb->length;
8912 		break;
8913 	}
8914 	default:
8915 		/*
8916 		 * We got a command we don't support.  This shouldn't
8917 		 * happen, commands should be filtered out above us.
8918 		 */
8919 		ctl_set_invalid_opcode(ctsio);
8920 		ctl_done((union ctl_io *)ctsio);
8921 
8922 		return (CTL_RETVAL_COMPLETE);
8923 		break; /* NOTREACHED */
8924 	}
8925 
8926 	/*
8927 	 * The first check is to make sure we're in bounds, the second
8928 	 * check is to catch wrap-around problems.  If the lba + num blocks
8929 	 * is less than the lba, then we've wrapped around and the block
8930 	 * range is invalid anyway.
8931 	 */
8932 	if (((lba + num_blocks) > (lun->be_lun->maxlba + 1))
8933 	 || ((lba + num_blocks) < lba)) {
8934 		ctl_set_lba_out_of_range(ctsio);
8935 		ctl_done((union ctl_io *)ctsio);
8936 		return (CTL_RETVAL_COMPLETE);
8937 	}
8938 
8939 	/*
8940 	 * According to SBC-3, a transfer length of 0 is not an error.
8941 	 */
8942 	if (num_blocks == 0) {
8943 		ctl_set_success(ctsio);
8944 		ctl_done((union ctl_io *)ctsio);
8945 		return (CTL_RETVAL_COMPLETE);
8946 	}
8947 
8948 	/* Set FUA if write cache is disabled. */
8949 	if ((lun->mode_pages.caching_page[CTL_PAGE_CURRENT].flags1 &
8950 	    SCP_WCE) == 0)
8951 		flags |= CTL_LLF_FUA;
8952 
8953 	ctsio->kern_total_len = 2 * num_blocks * lun->be_lun->blocksize;
8954 	ctsio->kern_rel_offset = 0;
8955 
8956 	/*
8957 	 * Set the IO_CONT flag, so that if this I/O gets passed to
8958 	 * ctl_data_submit_done(), it'll get passed back to
8959 	 * ctl_ctl_cnw_cont() for further processing.
8960 	 */
8961 	ctsio->io_hdr.flags |= CTL_FLAG_IO_CONT;
8962 	ctsio->io_cont = ctl_cnw_cont;
8963 
8964 	lbalen = (struct ctl_lba_len_flags *)
8965 	    &ctsio->io_hdr.ctl_private[CTL_PRIV_LBA_LEN];
8966 	lbalen->lba = lba;
8967 	lbalen->len = num_blocks;
8968 	lbalen->flags = CTL_LLF_COMPARE | flags;
8969 
8970 	CTL_DEBUG_PRINT(("ctl_cnw: calling data_submit()\n"));
8971 	retval = lun->backend->data_submit((union ctl_io *)ctsio);
8972 	return (retval);
8973 }
8974 
8975 int
8976 ctl_verify(struct ctl_scsiio *ctsio)
8977 {
8978 	struct ctl_lun *lun;
8979 	struct ctl_lba_len_flags *lbalen;
8980 	uint64_t lba;
8981 	uint32_t num_blocks;
8982 	int bytchk, flags;
8983 	int retval;
8984 
8985 	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
8986 
8987 	CTL_DEBUG_PRINT(("ctl_verify: command: %#x\n", ctsio->cdb[0]));
8988 
8989 	bytchk = 0;
8990 	flags = CTL_LLF_FUA;
8991 	switch (ctsio->cdb[0]) {
8992 	case VERIFY_10: {
8993 		struct scsi_verify_10 *cdb;
8994 
8995 		cdb = (struct scsi_verify_10 *)ctsio->cdb;
8996 		if (cdb->byte2 & SVFY_BYTCHK)
8997 			bytchk = 1;
8998 		if (cdb->byte2 & SVFY_DPO)
8999 			flags |= CTL_LLF_DPO;
9000 		lba = scsi_4btoul(cdb->addr);
9001 		num_blocks = scsi_2btoul(cdb->length);
9002 		break;
9003 	}
9004 	case VERIFY_12: {
9005 		struct scsi_verify_12 *cdb;
9006 
9007 		cdb = (struct scsi_verify_12 *)ctsio->cdb;
9008 		if (cdb->byte2 & SVFY_BYTCHK)
9009 			bytchk = 1;
9010 		if (cdb->byte2 & SVFY_DPO)
9011 			flags |= CTL_LLF_DPO;
9012 		lba = scsi_4btoul(cdb->addr);
9013 		num_blocks = scsi_4btoul(cdb->length);
9014 		break;
9015 	}
9016 	case VERIFY_16: {
9017 		struct scsi_rw_16 *cdb;
9018 
9019 		cdb = (struct scsi_rw_16 *)ctsio->cdb;
9020 		if (cdb->byte2 & SVFY_BYTCHK)
9021 			bytchk = 1;
9022 		if (cdb->byte2 & SVFY_DPO)
9023 			flags |= CTL_LLF_DPO;
9024 		lba = scsi_8btou64(cdb->addr);
9025 		num_blocks = scsi_4btoul(cdb->length);
9026 		break;
9027 	}
9028 	default:
9029 		/*
9030 		 * We got a command we don't support.  This shouldn't
9031 		 * happen, commands should be filtered out above us.
9032 		 */
9033 		ctl_set_invalid_opcode(ctsio);
9034 		ctl_done((union ctl_io *)ctsio);
9035 		return (CTL_RETVAL_COMPLETE);
9036 	}
9037 
9038 	/*
9039 	 * The first check is to make sure we're in bounds, the second
9040 	 * check is to catch wrap-around problems.  If the lba + num blocks
9041 	 * is less than the lba, then we've wrapped around and the block
9042 	 * range is invalid anyway.
9043 	 */
9044 	if (((lba + num_blocks) > (lun->be_lun->maxlba + 1))
9045 	 || ((lba + num_blocks) < lba)) {
9046 		ctl_set_lba_out_of_range(ctsio);
9047 		ctl_done((union ctl_io *)ctsio);
9048 		return (CTL_RETVAL_COMPLETE);
9049 	}
9050 
9051 	/*
9052 	 * According to SBC-3, a transfer length of 0 is not an error.
9053 	 */
9054 	if (num_blocks == 0) {
9055 		ctl_set_success(ctsio);
9056 		ctl_done((union ctl_io *)ctsio);
9057 		return (CTL_RETVAL_COMPLETE);
9058 	}
9059 
9060 	lbalen = (struct ctl_lba_len_flags *)
9061 	    &ctsio->io_hdr.ctl_private[CTL_PRIV_LBA_LEN];
9062 	lbalen->lba = lba;
9063 	lbalen->len = num_blocks;
9064 	if (bytchk) {
9065 		lbalen->flags = CTL_LLF_COMPARE | flags;
9066 		ctsio->kern_total_len = num_blocks * lun->be_lun->blocksize;
9067 	} else {
9068 		lbalen->flags = CTL_LLF_VERIFY | flags;
9069 		ctsio->kern_total_len = 0;
9070 	}
9071 	ctsio->kern_rel_offset = 0;
9072 
9073 	CTL_DEBUG_PRINT(("ctl_verify: calling data_submit()\n"));
9074 	retval = lun->backend->data_submit((union ctl_io *)ctsio);
9075 	return (retval);
9076 }
9077 
9078 int
9079 ctl_report_luns(struct ctl_scsiio *ctsio)
9080 {
9081 	struct ctl_softc *softc;
9082 	struct scsi_report_luns *cdb;
9083 	struct scsi_report_luns_data *lun_data;
9084 	struct ctl_lun *lun, *request_lun;
9085 	struct ctl_port *port;
9086 	int num_luns, retval;
9087 	uint32_t alloc_len, lun_datalen;
9088 	int num_filled;
9089 	uint32_t initidx, targ_lun_id, lun_id;
9090 
9091 	retval = CTL_RETVAL_COMPLETE;
9092 	cdb = (struct scsi_report_luns *)ctsio->cdb;
9093 	port = ctl_io_port(&ctsio->io_hdr);
9094 	softc = port->ctl_softc;
9095 
9096 	CTL_DEBUG_PRINT(("ctl_report_luns\n"));
9097 
9098 	mtx_lock(&softc->ctl_lock);
9099 	num_luns = 0;
9100 	for (targ_lun_id = 0; targ_lun_id < CTL_MAX_LUNS; targ_lun_id++) {
9101 		if (ctl_lun_map_from_port(port, targ_lun_id) < CTL_MAX_LUNS)
9102 			num_luns++;
9103 	}
9104 	mtx_unlock(&softc->ctl_lock);
9105 
9106 	switch (cdb->select_report) {
9107 	case RPL_REPORT_DEFAULT:
9108 	case RPL_REPORT_ALL:
9109 	case RPL_REPORT_NONSUBSID:
9110 		break;
9111 	case RPL_REPORT_WELLKNOWN:
9112 	case RPL_REPORT_ADMIN:
9113 	case RPL_REPORT_CONGLOM:
9114 		num_luns = 0;
9115 		break;
9116 	default:
9117 		ctl_set_invalid_field(ctsio,
9118 				      /*sks_valid*/ 1,
9119 				      /*command*/ 1,
9120 				      /*field*/ 2,
9121 				      /*bit_valid*/ 0,
9122 				      /*bit*/ 0);
9123 		ctl_done((union ctl_io *)ctsio);
9124 		return (retval);
9125 		break; /* NOTREACHED */
9126 	}
9127 
9128 	alloc_len = scsi_4btoul(cdb->length);
9129 	/*
9130 	 * The initiator has to allocate at least 16 bytes for this request,
9131 	 * so he can at least get the header and the first LUN.  Otherwise
9132 	 * we reject the request (per SPC-3 rev 14, section 6.21).
9133 	 */
9134 	if (alloc_len < (sizeof(struct scsi_report_luns_data) +
9135 	    sizeof(struct scsi_report_luns_lundata))) {
9136 		ctl_set_invalid_field(ctsio,
9137 				      /*sks_valid*/ 1,
9138 				      /*command*/ 1,
9139 				      /*field*/ 6,
9140 				      /*bit_valid*/ 0,
9141 				      /*bit*/ 0);
9142 		ctl_done((union ctl_io *)ctsio);
9143 		return (retval);
9144 	}
9145 
9146 	request_lun = (struct ctl_lun *)
9147 		ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
9148 
9149 	lun_datalen = sizeof(*lun_data) +
9150 		(num_luns * sizeof(struct scsi_report_luns_lundata));
9151 
9152 	ctsio->kern_data_ptr = malloc(lun_datalen, M_CTL, M_WAITOK | M_ZERO);
9153 	lun_data = (struct scsi_report_luns_data *)ctsio->kern_data_ptr;
9154 	ctsio->kern_sg_entries = 0;
9155 
9156 	initidx = ctl_get_initindex(&ctsio->io_hdr.nexus);
9157 
9158 	mtx_lock(&softc->ctl_lock);
9159 	for (targ_lun_id = 0, num_filled = 0; targ_lun_id < CTL_MAX_LUNS && num_filled < num_luns; targ_lun_id++) {
9160 		lun_id = ctl_lun_map_from_port(port, targ_lun_id);
9161 		if (lun_id >= CTL_MAX_LUNS)
9162 			continue;
9163 		lun = softc->ctl_luns[lun_id];
9164 		if (lun == NULL)
9165 			continue;
9166 
9167 		be64enc(lun_data->luns[num_filled++].lundata,
9168 		    ctl_encode_lun(targ_lun_id));
9169 
9170 		/*
9171 		 * According to SPC-3, rev 14 section 6.21:
9172 		 *
9173 		 * "The execution of a REPORT LUNS command to any valid and
9174 		 * installed logical unit shall clear the REPORTED LUNS DATA
9175 		 * HAS CHANGED unit attention condition for all logical
9176 		 * units of that target with respect to the requesting
9177 		 * initiator. A valid and installed logical unit is one
9178 		 * having a PERIPHERAL QUALIFIER of 000b in the standard
9179 		 * INQUIRY data (see 6.4.2)."
9180 		 *
9181 		 * If request_lun is NULL, the LUN this report luns command
9182 		 * was issued to is either disabled or doesn't exist. In that
9183 		 * case, we shouldn't clear any pending lun change unit
9184 		 * attention.
9185 		 */
9186 		if (request_lun != NULL) {
9187 			mtx_lock(&lun->lun_lock);
9188 			ctl_clr_ua(lun, initidx, CTL_UA_LUN_CHANGE);
9189 			mtx_unlock(&lun->lun_lock);
9190 		}
9191 	}
9192 	mtx_unlock(&softc->ctl_lock);
9193 
9194 	/*
9195 	 * It's quite possible that we've returned fewer LUNs than we allocated
9196 	 * space for.  Trim it.
9197 	 */
9198 	lun_datalen = sizeof(*lun_data) +
9199 		(num_filled * sizeof(struct scsi_report_luns_lundata));
9200 
9201 	if (lun_datalen < alloc_len) {
9202 		ctsio->residual = alloc_len - lun_datalen;
9203 		ctsio->kern_data_len = lun_datalen;
9204 		ctsio->kern_total_len = lun_datalen;
9205 	} else {
9206 		ctsio->residual = 0;
9207 		ctsio->kern_data_len = alloc_len;
9208 		ctsio->kern_total_len = alloc_len;
9209 	}
9210 	ctsio->kern_data_resid = 0;
9211 	ctsio->kern_rel_offset = 0;
9212 	ctsio->kern_sg_entries = 0;
9213 
9214 	/*
9215 	 * We set this to the actual data length, regardless of how much
9216 	 * space we actually have to return results.  If the user looks at
9217 	 * this value, he'll know whether or not he allocated enough space
9218 	 * and reissue the command if necessary.  We don't support well
9219 	 * known logical units, so if the user asks for that, return none.
9220 	 */
9221 	scsi_ulto4b(lun_datalen - 8, lun_data->length);
9222 
9223 	/*
9224 	 * We can only return SCSI_STATUS_CHECK_COND when we can't satisfy
9225 	 * this request.
9226 	 */
9227 	ctl_set_success(ctsio);
9228 	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
9229 	ctsio->be_move_done = ctl_config_move_done;
9230 	ctl_datamove((union ctl_io *)ctsio);
9231 	return (retval);
9232 }
9233 
9234 int
9235 ctl_request_sense(struct ctl_scsiio *ctsio)
9236 {
9237 	struct scsi_request_sense *cdb;
9238 	struct scsi_sense_data *sense_ptr;
9239 	struct ctl_softc *ctl_softc;
9240 	struct ctl_lun *lun;
9241 	uint32_t initidx;
9242 	int have_error;
9243 	scsi_sense_data_type sense_format;
9244 	ctl_ua_type ua_type;
9245 
9246 	cdb = (struct scsi_request_sense *)ctsio->cdb;
9247 
9248 	ctl_softc = control_softc;
9249 	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
9250 
9251 	CTL_DEBUG_PRINT(("ctl_request_sense\n"));
9252 
9253 	/*
9254 	 * Determine which sense format the user wants.
9255 	 */
9256 	if (cdb->byte2 & SRS_DESC)
9257 		sense_format = SSD_TYPE_DESC;
9258 	else
9259 		sense_format = SSD_TYPE_FIXED;
9260 
9261 	ctsio->kern_data_ptr = malloc(sizeof(*sense_ptr), M_CTL, M_WAITOK);
9262 	sense_ptr = (struct scsi_sense_data *)ctsio->kern_data_ptr;
9263 	ctsio->kern_sg_entries = 0;
9264 
9265 	/*
9266 	 * struct scsi_sense_data, which is currently set to 256 bytes, is
9267 	 * larger than the largest allowed value for the length field in the
9268 	 * REQUEST SENSE CDB, which is 252 bytes as of SPC-4.
9269 	 */
9270 	ctsio->residual = 0;
9271 	ctsio->kern_data_len = cdb->length;
9272 	ctsio->kern_total_len = cdb->length;
9273 
9274 	ctsio->kern_data_resid = 0;
9275 	ctsio->kern_rel_offset = 0;
9276 	ctsio->kern_sg_entries = 0;
9277 
9278 	/*
9279 	 * If we don't have a LUN, we don't have any pending sense.
9280 	 */
9281 	if (lun == NULL)
9282 		goto no_sense;
9283 
9284 	have_error = 0;
9285 	initidx = ctl_get_initindex(&ctsio->io_hdr.nexus);
9286 	/*
9287 	 * Check for pending sense, and then for pending unit attentions.
9288 	 * Pending sense gets returned first, then pending unit attentions.
9289 	 */
9290 	mtx_lock(&lun->lun_lock);
9291 #ifdef CTL_WITH_CA
9292 	if (ctl_is_set(lun->have_ca, initidx)) {
9293 		scsi_sense_data_type stored_format;
9294 
9295 		/*
9296 		 * Check to see which sense format was used for the stored
9297 		 * sense data.
9298 		 */
9299 		stored_format = scsi_sense_type(&lun->pending_sense[initidx]);
9300 
9301 		/*
9302 		 * If the user requested a different sense format than the
9303 		 * one we stored, then we need to convert it to the other
9304 		 * format.  If we're going from descriptor to fixed format
9305 		 * sense data, we may lose things in translation, depending
9306 		 * on what options were used.
9307 		 *
9308 		 * If the stored format is SSD_TYPE_NONE (i.e. invalid),
9309 		 * for some reason we'll just copy it out as-is.
9310 		 */
9311 		if ((stored_format == SSD_TYPE_FIXED)
9312 		 && (sense_format == SSD_TYPE_DESC))
9313 			ctl_sense_to_desc((struct scsi_sense_data_fixed *)
9314 			    &lun->pending_sense[initidx],
9315 			    (struct scsi_sense_data_desc *)sense_ptr);
9316 		else if ((stored_format == SSD_TYPE_DESC)
9317 		      && (sense_format == SSD_TYPE_FIXED))
9318 			ctl_sense_to_fixed((struct scsi_sense_data_desc *)
9319 			    &lun->pending_sense[initidx],
9320 			    (struct scsi_sense_data_fixed *)sense_ptr);
9321 		else
9322 			memcpy(sense_ptr, &lun->pending_sense[initidx],
9323 			       MIN(sizeof(*sense_ptr),
9324 			       sizeof(lun->pending_sense[initidx])));
9325 
9326 		ctl_clear_mask(lun->have_ca, initidx);
9327 		have_error = 1;
9328 	} else
9329 #endif
9330 	{
9331 		ua_type = ctl_build_ua(lun, initidx, sense_ptr, sense_format);
9332 		if (ua_type != CTL_UA_NONE)
9333 			have_error = 1;
9334 		if (ua_type == CTL_UA_LUN_CHANGE) {
9335 			mtx_unlock(&lun->lun_lock);
9336 			mtx_lock(&ctl_softc->ctl_lock);
9337 			ctl_clr_ua_allluns(ctl_softc, initidx, ua_type);
9338 			mtx_unlock(&ctl_softc->ctl_lock);
9339 			mtx_lock(&lun->lun_lock);
9340 		}
9341 
9342 	}
9343 	mtx_unlock(&lun->lun_lock);
9344 
9345 	/*
9346 	 * We already have a pending error, return it.
9347 	 */
9348 	if (have_error != 0) {
9349 		/*
9350 		 * We report the SCSI status as OK, since the status of the
9351 		 * request sense command itself is OK.
9352 		 * We report 0 for the sense length, because we aren't doing
9353 		 * autosense in this case.  We're reporting sense as
9354 		 * parameter data.
9355 		 */
9356 		ctl_set_success(ctsio);
9357 		ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
9358 		ctsio->be_move_done = ctl_config_move_done;
9359 		ctl_datamove((union ctl_io *)ctsio);
9360 		return (CTL_RETVAL_COMPLETE);
9361 	}
9362 
9363 no_sense:
9364 
9365 	/*
9366 	 * No sense information to report, so we report that everything is
9367 	 * okay.
9368 	 */
9369 	ctl_set_sense_data(sense_ptr,
9370 			   lun,
9371 			   sense_format,
9372 			   /*current_error*/ 1,
9373 			   /*sense_key*/ SSD_KEY_NO_SENSE,
9374 			   /*asc*/ 0x00,
9375 			   /*ascq*/ 0x00,
9376 			   SSD_ELEM_NONE);
9377 
9378 	/*
9379 	 * We report 0 for the sense length, because we aren't doing
9380 	 * autosense in this case.  We're reporting sense as parameter data.
9381 	 */
9382 	ctl_set_success(ctsio);
9383 	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
9384 	ctsio->be_move_done = ctl_config_move_done;
9385 	ctl_datamove((union ctl_io *)ctsio);
9386 	return (CTL_RETVAL_COMPLETE);
9387 }
9388 
9389 int
9390 ctl_tur(struct ctl_scsiio *ctsio)
9391 {
9392 
9393 	CTL_DEBUG_PRINT(("ctl_tur\n"));
9394 
9395 	ctl_set_success(ctsio);
9396 	ctl_done((union ctl_io *)ctsio);
9397 
9398 	return (CTL_RETVAL_COMPLETE);
9399 }
9400 
9401 /*
9402  * SCSI VPD page 0x00, the Supported VPD Pages page.
9403  */
9404 static int
9405 ctl_inquiry_evpd_supported(struct ctl_scsiio *ctsio, int alloc_len)
9406 {
9407 	struct scsi_vpd_supported_pages *pages;
9408 	int sup_page_size;
9409 	struct ctl_lun *lun;
9410 	int p;
9411 
9412 	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
9413 
9414 	sup_page_size = sizeof(struct scsi_vpd_supported_pages) *
9415 	    SCSI_EVPD_NUM_SUPPORTED_PAGES;
9416 	ctsio->kern_data_ptr = malloc(sup_page_size, M_CTL, M_WAITOK | M_ZERO);
9417 	pages = (struct scsi_vpd_supported_pages *)ctsio->kern_data_ptr;
9418 	ctsio->kern_sg_entries = 0;
9419 
9420 	if (sup_page_size < alloc_len) {
9421 		ctsio->residual = alloc_len - sup_page_size;
9422 		ctsio->kern_data_len = sup_page_size;
9423 		ctsio->kern_total_len = sup_page_size;
9424 	} else {
9425 		ctsio->residual = 0;
9426 		ctsio->kern_data_len = alloc_len;
9427 		ctsio->kern_total_len = alloc_len;
9428 	}
9429 	ctsio->kern_data_resid = 0;
9430 	ctsio->kern_rel_offset = 0;
9431 	ctsio->kern_sg_entries = 0;
9432 
9433 	/*
9434 	 * The control device is always connected.  The disk device, on the
9435 	 * other hand, may not be online all the time.  Need to change this
9436 	 * to figure out whether the disk device is actually online or not.
9437 	 */
9438 	if (lun != NULL)
9439 		pages->device = (SID_QUAL_LU_CONNECTED << 5) |
9440 				lun->be_lun->lun_type;
9441 	else
9442 		pages->device = (SID_QUAL_LU_OFFLINE << 5) | T_DIRECT;
9443 
9444 	p = 0;
9445 	/* Supported VPD pages */
9446 	pages->page_list[p++] = SVPD_SUPPORTED_PAGES;
9447 	/* Serial Number */
9448 	pages->page_list[p++] = SVPD_UNIT_SERIAL_NUMBER;
9449 	/* Device Identification */
9450 	pages->page_list[p++] = SVPD_DEVICE_ID;
9451 	/* Extended INQUIRY Data */
9452 	pages->page_list[p++] = SVPD_EXTENDED_INQUIRY_DATA;
9453 	/* Mode Page Policy */
9454 	pages->page_list[p++] = SVPD_MODE_PAGE_POLICY;
9455 	/* SCSI Ports */
9456 	pages->page_list[p++] = SVPD_SCSI_PORTS;
9457 	/* Third-party Copy */
9458 	pages->page_list[p++] = SVPD_SCSI_TPC;
9459 	if (lun != NULL && lun->be_lun->lun_type == T_DIRECT) {
9460 		/* Block limits */
9461 		pages->page_list[p++] = SVPD_BLOCK_LIMITS;
9462 		/* Block Device Characteristics */
9463 		pages->page_list[p++] = SVPD_BDC;
9464 		/* Logical Block Provisioning */
9465 		pages->page_list[p++] = SVPD_LBP;
9466 	}
9467 	pages->length = p;
9468 
9469 	ctl_set_success(ctsio);
9470 	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
9471 	ctsio->be_move_done = ctl_config_move_done;
9472 	ctl_datamove((union ctl_io *)ctsio);
9473 	return (CTL_RETVAL_COMPLETE);
9474 }
9475 
9476 /*
9477  * SCSI VPD page 0x80, the Unit Serial Number page.
9478  */
9479 static int
9480 ctl_inquiry_evpd_serial(struct ctl_scsiio *ctsio, int alloc_len)
9481 {
9482 	struct scsi_vpd_unit_serial_number *sn_ptr;
9483 	struct ctl_lun *lun;
9484 	int data_len;
9485 
9486 	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
9487 
9488 	data_len = 4 + CTL_SN_LEN;
9489 	ctsio->kern_data_ptr = malloc(data_len, M_CTL, M_WAITOK | M_ZERO);
9490 	sn_ptr = (struct scsi_vpd_unit_serial_number *)ctsio->kern_data_ptr;
9491 	if (data_len < alloc_len) {
9492 		ctsio->residual = alloc_len - data_len;
9493 		ctsio->kern_data_len = data_len;
9494 		ctsio->kern_total_len = data_len;
9495 	} else {
9496 		ctsio->residual = 0;
9497 		ctsio->kern_data_len = alloc_len;
9498 		ctsio->kern_total_len = alloc_len;
9499 	}
9500 	ctsio->kern_data_resid = 0;
9501 	ctsio->kern_rel_offset = 0;
9502 	ctsio->kern_sg_entries = 0;
9503 
9504 	/*
9505 	 * The control device is always connected.  The disk device, on the
9506 	 * other hand, may not be online all the time.  Need to change this
9507 	 * to figure out whether the disk device is actually online or not.
9508 	 */
9509 	if (lun != NULL)
9510 		sn_ptr->device = (SID_QUAL_LU_CONNECTED << 5) |
9511 				  lun->be_lun->lun_type;
9512 	else
9513 		sn_ptr->device = (SID_QUAL_LU_OFFLINE << 5) | T_DIRECT;
9514 
9515 	sn_ptr->page_code = SVPD_UNIT_SERIAL_NUMBER;
9516 	sn_ptr->length = CTL_SN_LEN;
9517 	/*
9518 	 * If we don't have a LUN, we just leave the serial number as
9519 	 * all spaces.
9520 	 */
9521 	if (lun != NULL) {
9522 		strncpy((char *)sn_ptr->serial_num,
9523 			(char *)lun->be_lun->serial_num, CTL_SN_LEN);
9524 	} else
9525 		memset(sn_ptr->serial_num, 0x20, CTL_SN_LEN);
9526 
9527 	ctl_set_success(ctsio);
9528 	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
9529 	ctsio->be_move_done = ctl_config_move_done;
9530 	ctl_datamove((union ctl_io *)ctsio);
9531 	return (CTL_RETVAL_COMPLETE);
9532 }
9533 
9534 
9535 /*
9536  * SCSI VPD page 0x86, the Extended INQUIRY Data page.
9537  */
9538 static int
9539 ctl_inquiry_evpd_eid(struct ctl_scsiio *ctsio, int alloc_len)
9540 {
9541 	struct scsi_vpd_extended_inquiry_data *eid_ptr;
9542 	struct ctl_lun *lun;
9543 	int data_len;
9544 
9545 	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
9546 
9547 	data_len = sizeof(struct scsi_vpd_extended_inquiry_data);
9548 	ctsio->kern_data_ptr = malloc(data_len, M_CTL, M_WAITOK | M_ZERO);
9549 	eid_ptr = (struct scsi_vpd_extended_inquiry_data *)ctsio->kern_data_ptr;
9550 	ctsio->kern_sg_entries = 0;
9551 
9552 	if (data_len < alloc_len) {
9553 		ctsio->residual = alloc_len - data_len;
9554 		ctsio->kern_data_len = data_len;
9555 		ctsio->kern_total_len = data_len;
9556 	} else {
9557 		ctsio->residual = 0;
9558 		ctsio->kern_data_len = alloc_len;
9559 		ctsio->kern_total_len = alloc_len;
9560 	}
9561 	ctsio->kern_data_resid = 0;
9562 	ctsio->kern_rel_offset = 0;
9563 	ctsio->kern_sg_entries = 0;
9564 
9565 	/*
9566 	 * The control device is always connected.  The disk device, on the
9567 	 * other hand, may not be online all the time.
9568 	 */
9569 	if (lun != NULL)
9570 		eid_ptr->device = (SID_QUAL_LU_CONNECTED << 5) |
9571 				     lun->be_lun->lun_type;
9572 	else
9573 		eid_ptr->device = (SID_QUAL_LU_OFFLINE << 5) | T_DIRECT;
9574 	eid_ptr->page_code = SVPD_EXTENDED_INQUIRY_DATA;
9575 	scsi_ulto2b(data_len - 4, eid_ptr->page_length);
9576 	/*
9577 	 * We support head of queue, ordered and simple tags.
9578 	 */
9579 	eid_ptr->flags2 = SVPD_EID_HEADSUP | SVPD_EID_ORDSUP | SVPD_EID_SIMPSUP;
9580 	/*
9581 	 * Volatile cache supported.
9582 	 */
9583 	eid_ptr->flags3 = SVPD_EID_V_SUP;
9584 
9585 	/*
9586 	 * This means that we clear the REPORTED LUNS DATA HAS CHANGED unit
9587 	 * attention for a particular IT nexus on all LUNs once we report
9588 	 * it to that nexus once.  This bit is required as of SPC-4.
9589 	 */
9590 	eid_ptr->flags4 = SVPD_EID_LUICLT;
9591 
9592 	/*
9593 	 * XXX KDM in order to correctly answer this, we would need
9594 	 * information from the SIM to determine how much sense data it
9595 	 * can send.  So this would really be a path inquiry field, most
9596 	 * likely.  This can be set to a maximum of 252 according to SPC-4,
9597 	 * but the hardware may or may not be able to support that much.
9598 	 * 0 just means that the maximum sense data length is not reported.
9599 	 */
9600 	eid_ptr->max_sense_length = 0;
9601 
9602 	ctl_set_success(ctsio);
9603 	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
9604 	ctsio->be_move_done = ctl_config_move_done;
9605 	ctl_datamove((union ctl_io *)ctsio);
9606 	return (CTL_RETVAL_COMPLETE);
9607 }
9608 
9609 static int
9610 ctl_inquiry_evpd_mpp(struct ctl_scsiio *ctsio, int alloc_len)
9611 {
9612 	struct scsi_vpd_mode_page_policy *mpp_ptr;
9613 	struct ctl_lun *lun;
9614 	int data_len;
9615 
9616 	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
9617 
9618 	data_len = sizeof(struct scsi_vpd_mode_page_policy) +
9619 	    sizeof(struct scsi_vpd_mode_page_policy_descr);
9620 
9621 	ctsio->kern_data_ptr = malloc(data_len, M_CTL, M_WAITOK | M_ZERO);
9622 	mpp_ptr = (struct scsi_vpd_mode_page_policy *)ctsio->kern_data_ptr;
9623 	ctsio->kern_sg_entries = 0;
9624 
9625 	if (data_len < alloc_len) {
9626 		ctsio->residual = alloc_len - data_len;
9627 		ctsio->kern_data_len = data_len;
9628 		ctsio->kern_total_len = data_len;
9629 	} else {
9630 		ctsio->residual = 0;
9631 		ctsio->kern_data_len = alloc_len;
9632 		ctsio->kern_total_len = alloc_len;
9633 	}
9634 	ctsio->kern_data_resid = 0;
9635 	ctsio->kern_rel_offset = 0;
9636 	ctsio->kern_sg_entries = 0;
9637 
9638 	/*
9639 	 * The control device is always connected.  The disk device, on the
9640 	 * other hand, may not be online all the time.
9641 	 */
9642 	if (lun != NULL)
9643 		mpp_ptr->device = (SID_QUAL_LU_CONNECTED << 5) |
9644 				     lun->be_lun->lun_type;
9645 	else
9646 		mpp_ptr->device = (SID_QUAL_LU_OFFLINE << 5) | T_DIRECT;
9647 	mpp_ptr->page_code = SVPD_MODE_PAGE_POLICY;
9648 	scsi_ulto2b(data_len - 4, mpp_ptr->page_length);
9649 	mpp_ptr->descr[0].page_code = 0x3f;
9650 	mpp_ptr->descr[0].subpage_code = 0xff;
9651 	mpp_ptr->descr[0].policy = SVPD_MPP_SHARED;
9652 
9653 	ctl_set_success(ctsio);
9654 	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
9655 	ctsio->be_move_done = ctl_config_move_done;
9656 	ctl_datamove((union ctl_io *)ctsio);
9657 	return (CTL_RETVAL_COMPLETE);
9658 }
9659 
9660 /*
9661  * SCSI VPD page 0x83, the Device Identification page.
9662  */
9663 static int
9664 ctl_inquiry_evpd_devid(struct ctl_scsiio *ctsio, int alloc_len)
9665 {
9666 	struct scsi_vpd_device_id *devid_ptr;
9667 	struct scsi_vpd_id_descriptor *desc;
9668 	struct ctl_softc *softc;
9669 	struct ctl_lun *lun;
9670 	struct ctl_port *port;
9671 	int data_len, g;
9672 	uint8_t proto;
9673 
9674 	softc = control_softc;
9675 
9676 	port = ctl_io_port(&ctsio->io_hdr);
9677 	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
9678 
9679 	data_len = sizeof(struct scsi_vpd_device_id) +
9680 	    sizeof(struct scsi_vpd_id_descriptor) +
9681 		sizeof(struct scsi_vpd_id_rel_trgt_port_id) +
9682 	    sizeof(struct scsi_vpd_id_descriptor) +
9683 		sizeof(struct scsi_vpd_id_trgt_port_grp_id);
9684 	if (lun && lun->lun_devid)
9685 		data_len += lun->lun_devid->len;
9686 	if (port && port->port_devid)
9687 		data_len += port->port_devid->len;
9688 	if (port && port->target_devid)
9689 		data_len += port->target_devid->len;
9690 
9691 	ctsio->kern_data_ptr = malloc(data_len, M_CTL, M_WAITOK | M_ZERO);
9692 	devid_ptr = (struct scsi_vpd_device_id *)ctsio->kern_data_ptr;
9693 	ctsio->kern_sg_entries = 0;
9694 
9695 	if (data_len < alloc_len) {
9696 		ctsio->residual = alloc_len - data_len;
9697 		ctsio->kern_data_len = data_len;
9698 		ctsio->kern_total_len = data_len;
9699 	} else {
9700 		ctsio->residual = 0;
9701 		ctsio->kern_data_len = alloc_len;
9702 		ctsio->kern_total_len = alloc_len;
9703 	}
9704 	ctsio->kern_data_resid = 0;
9705 	ctsio->kern_rel_offset = 0;
9706 	ctsio->kern_sg_entries = 0;
9707 
9708 	/*
9709 	 * The control device is always connected.  The disk device, on the
9710 	 * other hand, may not be online all the time.
9711 	 */
9712 	if (lun != NULL)
9713 		devid_ptr->device = (SID_QUAL_LU_CONNECTED << 5) |
9714 				     lun->be_lun->lun_type;
9715 	else
9716 		devid_ptr->device = (SID_QUAL_LU_OFFLINE << 5) | T_DIRECT;
9717 	devid_ptr->page_code = SVPD_DEVICE_ID;
9718 	scsi_ulto2b(data_len - 4, devid_ptr->length);
9719 
9720 	if (port && port->port_type == CTL_PORT_FC)
9721 		proto = SCSI_PROTO_FC << 4;
9722 	else if (port && port->port_type == CTL_PORT_ISCSI)
9723 		proto = SCSI_PROTO_ISCSI << 4;
9724 	else
9725 		proto = SCSI_PROTO_SPI << 4;
9726 	desc = (struct scsi_vpd_id_descriptor *)devid_ptr->desc_list;
9727 
9728 	/*
9729 	 * We're using a LUN association here.  i.e., this device ID is a
9730 	 * per-LUN identifier.
9731 	 */
9732 	if (lun && lun->lun_devid) {
9733 		memcpy(desc, lun->lun_devid->data, lun->lun_devid->len);
9734 		desc = (struct scsi_vpd_id_descriptor *)((uint8_t *)desc +
9735 		    lun->lun_devid->len);
9736 	}
9737 
9738 	/*
9739 	 * This is for the WWPN which is a port association.
9740 	 */
9741 	if (port && port->port_devid) {
9742 		memcpy(desc, port->port_devid->data, port->port_devid->len);
9743 		desc = (struct scsi_vpd_id_descriptor *)((uint8_t *)desc +
9744 		    port->port_devid->len);
9745 	}
9746 
9747 	/*
9748 	 * This is for the Relative Target Port(type 4h) identifier
9749 	 */
9750 	desc->proto_codeset = proto | SVPD_ID_CODESET_BINARY;
9751 	desc->id_type = SVPD_ID_PIV | SVPD_ID_ASSOC_PORT |
9752 	    SVPD_ID_TYPE_RELTARG;
9753 	desc->length = 4;
9754 	scsi_ulto2b(ctsio->io_hdr.nexus.targ_port, &desc->identifier[2]);
9755 	desc = (struct scsi_vpd_id_descriptor *)(&desc->identifier[0] +
9756 	    sizeof(struct scsi_vpd_id_rel_trgt_port_id));
9757 
9758 	/*
9759 	 * This is for the Target Port Group(type 5h) identifier
9760 	 */
9761 	desc->proto_codeset = proto | SVPD_ID_CODESET_BINARY;
9762 	desc->id_type = SVPD_ID_PIV | SVPD_ID_ASSOC_PORT |
9763 	    SVPD_ID_TYPE_TPORTGRP;
9764 	desc->length = 4;
9765 	if (softc->is_single ||
9766 	    (port && port->status & CTL_PORT_STATUS_HA_SHARED))
9767 		g = 1;
9768 	else
9769 		g = 2 + ctsio->io_hdr.nexus.targ_port / softc->port_cnt;
9770 	scsi_ulto2b(g, &desc->identifier[2]);
9771 	desc = (struct scsi_vpd_id_descriptor *)(&desc->identifier[0] +
9772 	    sizeof(struct scsi_vpd_id_trgt_port_grp_id));
9773 
9774 	/*
9775 	 * This is for the Target identifier
9776 	 */
9777 	if (port && port->target_devid) {
9778 		memcpy(desc, port->target_devid->data, port->target_devid->len);
9779 	}
9780 
9781 	ctl_set_success(ctsio);
9782 	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
9783 	ctsio->be_move_done = ctl_config_move_done;
9784 	ctl_datamove((union ctl_io *)ctsio);
9785 	return (CTL_RETVAL_COMPLETE);
9786 }
9787 
9788 static int
9789 ctl_inquiry_evpd_scsi_ports(struct ctl_scsiio *ctsio, int alloc_len)
9790 {
9791 	struct ctl_softc *softc = control_softc;
9792 	struct scsi_vpd_scsi_ports *sp;
9793 	struct scsi_vpd_port_designation *pd;
9794 	struct scsi_vpd_port_designation_cont *pdc;
9795 	struct ctl_lun *lun;
9796 	struct ctl_port *port;
9797 	int data_len, num_target_ports, iid_len, id_len;
9798 
9799 	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
9800 
9801 	num_target_ports = 0;
9802 	iid_len = 0;
9803 	id_len = 0;
9804 	mtx_lock(&softc->ctl_lock);
9805 	STAILQ_FOREACH(port, &softc->port_list, links) {
9806 		if ((port->status & CTL_PORT_STATUS_ONLINE) == 0)
9807 			continue;
9808 		if (lun != NULL &&
9809 		    ctl_lun_map_to_port(port, lun->lun) >= CTL_MAX_LUNS)
9810 			continue;
9811 		num_target_ports++;
9812 		if (port->init_devid)
9813 			iid_len += port->init_devid->len;
9814 		if (port->port_devid)
9815 			id_len += port->port_devid->len;
9816 	}
9817 	mtx_unlock(&softc->ctl_lock);
9818 
9819 	data_len = sizeof(struct scsi_vpd_scsi_ports) +
9820 	    num_target_ports * (sizeof(struct scsi_vpd_port_designation) +
9821 	     sizeof(struct scsi_vpd_port_designation_cont)) + iid_len + id_len;
9822 	ctsio->kern_data_ptr = malloc(data_len, M_CTL, M_WAITOK | M_ZERO);
9823 	sp = (struct scsi_vpd_scsi_ports *)ctsio->kern_data_ptr;
9824 	ctsio->kern_sg_entries = 0;
9825 
9826 	if (data_len < alloc_len) {
9827 		ctsio->residual = alloc_len - data_len;
9828 		ctsio->kern_data_len = data_len;
9829 		ctsio->kern_total_len = data_len;
9830 	} else {
9831 		ctsio->residual = 0;
9832 		ctsio->kern_data_len = alloc_len;
9833 		ctsio->kern_total_len = alloc_len;
9834 	}
9835 	ctsio->kern_data_resid = 0;
9836 	ctsio->kern_rel_offset = 0;
9837 	ctsio->kern_sg_entries = 0;
9838 
9839 	/*
9840 	 * The control device is always connected.  The disk device, on the
9841 	 * other hand, may not be online all the time.  Need to change this
9842 	 * to figure out whether the disk device is actually online or not.
9843 	 */
9844 	if (lun != NULL)
9845 		sp->device = (SID_QUAL_LU_CONNECTED << 5) |
9846 				  lun->be_lun->lun_type;
9847 	else
9848 		sp->device = (SID_QUAL_LU_OFFLINE << 5) | T_DIRECT;
9849 
9850 	sp->page_code = SVPD_SCSI_PORTS;
9851 	scsi_ulto2b(data_len - sizeof(struct scsi_vpd_scsi_ports),
9852 	    sp->page_length);
9853 	pd = &sp->design[0];
9854 
9855 	mtx_lock(&softc->ctl_lock);
9856 	STAILQ_FOREACH(port, &softc->port_list, links) {
9857 		if ((port->status & CTL_PORT_STATUS_ONLINE) == 0)
9858 			continue;
9859 		if (lun != NULL &&
9860 		    ctl_lun_map_to_port(port, lun->lun) >= CTL_MAX_LUNS)
9861 			continue;
9862 		scsi_ulto2b(port->targ_port, pd->relative_port_id);
9863 		if (port->init_devid) {
9864 			iid_len = port->init_devid->len;
9865 			memcpy(pd->initiator_transportid,
9866 			    port->init_devid->data, port->init_devid->len);
9867 		} else
9868 			iid_len = 0;
9869 		scsi_ulto2b(iid_len, pd->initiator_transportid_length);
9870 		pdc = (struct scsi_vpd_port_designation_cont *)
9871 		    (&pd->initiator_transportid[iid_len]);
9872 		if (port->port_devid) {
9873 			id_len = port->port_devid->len;
9874 			memcpy(pdc->target_port_descriptors,
9875 			    port->port_devid->data, port->port_devid->len);
9876 		} else
9877 			id_len = 0;
9878 		scsi_ulto2b(id_len, pdc->target_port_descriptors_length);
9879 		pd = (struct scsi_vpd_port_designation *)
9880 		    ((uint8_t *)pdc->target_port_descriptors + id_len);
9881 	}
9882 	mtx_unlock(&softc->ctl_lock);
9883 
9884 	ctl_set_success(ctsio);
9885 	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
9886 	ctsio->be_move_done = ctl_config_move_done;
9887 	ctl_datamove((union ctl_io *)ctsio);
9888 	return (CTL_RETVAL_COMPLETE);
9889 }
9890 
9891 static int
9892 ctl_inquiry_evpd_block_limits(struct ctl_scsiio *ctsio, int alloc_len)
9893 {
9894 	struct scsi_vpd_block_limits *bl_ptr;
9895 	struct ctl_lun *lun;
9896 
9897 	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
9898 
9899 	ctsio->kern_data_ptr = malloc(sizeof(*bl_ptr), M_CTL, M_WAITOK | M_ZERO);
9900 	bl_ptr = (struct scsi_vpd_block_limits *)ctsio->kern_data_ptr;
9901 	ctsio->kern_sg_entries = 0;
9902 
9903 	if (sizeof(*bl_ptr) < alloc_len) {
9904 		ctsio->residual = alloc_len - sizeof(*bl_ptr);
9905 		ctsio->kern_data_len = sizeof(*bl_ptr);
9906 		ctsio->kern_total_len = sizeof(*bl_ptr);
9907 	} else {
9908 		ctsio->residual = 0;
9909 		ctsio->kern_data_len = alloc_len;
9910 		ctsio->kern_total_len = alloc_len;
9911 	}
9912 	ctsio->kern_data_resid = 0;
9913 	ctsio->kern_rel_offset = 0;
9914 	ctsio->kern_sg_entries = 0;
9915 
9916 	/*
9917 	 * The control device is always connected.  The disk device, on the
9918 	 * other hand, may not be online all the time.  Need to change this
9919 	 * to figure out whether the disk device is actually online or not.
9920 	 */
9921 	if (lun != NULL)
9922 		bl_ptr->device = (SID_QUAL_LU_CONNECTED << 5) |
9923 				  lun->be_lun->lun_type;
9924 	else
9925 		bl_ptr->device = (SID_QUAL_LU_OFFLINE << 5) | T_DIRECT;
9926 
9927 	bl_ptr->page_code = SVPD_BLOCK_LIMITS;
9928 	scsi_ulto2b(sizeof(*bl_ptr) - 4, bl_ptr->page_length);
9929 	bl_ptr->max_cmp_write_len = 0xff;
9930 	scsi_ulto4b(0xffffffff, bl_ptr->max_txfer_len);
9931 	if (lun != NULL) {
9932 		scsi_ulto4b(lun->be_lun->opttxferlen, bl_ptr->opt_txfer_len);
9933 		if (lun->be_lun->flags & CTL_LUN_FLAG_UNMAP) {
9934 			scsi_ulto4b(0xffffffff, bl_ptr->max_unmap_lba_cnt);
9935 			scsi_ulto4b(0xffffffff, bl_ptr->max_unmap_blk_cnt);
9936 			if (lun->be_lun->ublockexp != 0) {
9937 				scsi_ulto4b((1 << lun->be_lun->ublockexp),
9938 				    bl_ptr->opt_unmap_grain);
9939 				scsi_ulto4b(0x80000000 | lun->be_lun->ublockoff,
9940 				    bl_ptr->unmap_grain_align);
9941 			}
9942 		}
9943 		scsi_ulto4b(lun->be_lun->atomicblock,
9944 		    bl_ptr->max_atomic_transfer_length);
9945 		scsi_ulto4b(0, bl_ptr->atomic_alignment);
9946 		scsi_ulto4b(0, bl_ptr->atomic_transfer_length_granularity);
9947 		scsi_ulto4b(0, bl_ptr->max_atomic_transfer_length_with_atomic_boundary);
9948 		scsi_ulto4b(0, bl_ptr->max_atomic_boundary_size);
9949 	}
9950 	scsi_u64to8b(UINT64_MAX, bl_ptr->max_write_same_length);
9951 
9952 	ctl_set_success(ctsio);
9953 	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
9954 	ctsio->be_move_done = ctl_config_move_done;
9955 	ctl_datamove((union ctl_io *)ctsio);
9956 	return (CTL_RETVAL_COMPLETE);
9957 }
9958 
9959 static int
9960 ctl_inquiry_evpd_bdc(struct ctl_scsiio *ctsio, int alloc_len)
9961 {
9962 	struct scsi_vpd_block_device_characteristics *bdc_ptr;
9963 	struct ctl_lun *lun;
9964 	const char *value;
9965 	u_int i;
9966 
9967 	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
9968 
9969 	ctsio->kern_data_ptr = malloc(sizeof(*bdc_ptr), M_CTL, M_WAITOK | M_ZERO);
9970 	bdc_ptr = (struct scsi_vpd_block_device_characteristics *)ctsio->kern_data_ptr;
9971 	ctsio->kern_sg_entries = 0;
9972 
9973 	if (sizeof(*bdc_ptr) < alloc_len) {
9974 		ctsio->residual = alloc_len - sizeof(*bdc_ptr);
9975 		ctsio->kern_data_len = sizeof(*bdc_ptr);
9976 		ctsio->kern_total_len = sizeof(*bdc_ptr);
9977 	} else {
9978 		ctsio->residual = 0;
9979 		ctsio->kern_data_len = alloc_len;
9980 		ctsio->kern_total_len = alloc_len;
9981 	}
9982 	ctsio->kern_data_resid = 0;
9983 	ctsio->kern_rel_offset = 0;
9984 	ctsio->kern_sg_entries = 0;
9985 
9986 	/*
9987 	 * The control device is always connected.  The disk device, on the
9988 	 * other hand, may not be online all the time.  Need to change this
9989 	 * to figure out whether the disk device is actually online or not.
9990 	 */
9991 	if (lun != NULL)
9992 		bdc_ptr->device = (SID_QUAL_LU_CONNECTED << 5) |
9993 				  lun->be_lun->lun_type;
9994 	else
9995 		bdc_ptr->device = (SID_QUAL_LU_OFFLINE << 5) | T_DIRECT;
9996 	bdc_ptr->page_code = SVPD_BDC;
9997 	scsi_ulto2b(sizeof(*bdc_ptr) - 4, bdc_ptr->page_length);
9998 	if (lun != NULL &&
9999 	    (value = ctl_get_opt(&lun->be_lun->options, "rpm")) != NULL)
10000 		i = strtol(value, NULL, 0);
10001 	else
10002 		i = CTL_DEFAULT_ROTATION_RATE;
10003 	scsi_ulto2b(i, bdc_ptr->medium_rotation_rate);
10004 	if (lun != NULL &&
10005 	    (value = ctl_get_opt(&lun->be_lun->options, "formfactor")) != NULL)
10006 		i = strtol(value, NULL, 0);
10007 	else
10008 		i = 0;
10009 	bdc_ptr->wab_wac_ff = (i & 0x0f);
10010 	bdc_ptr->flags = SVPD_FUAB | SVPD_VBULS;
10011 
10012 	ctl_set_success(ctsio);
10013 	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
10014 	ctsio->be_move_done = ctl_config_move_done;
10015 	ctl_datamove((union ctl_io *)ctsio);
10016 	return (CTL_RETVAL_COMPLETE);
10017 }
10018 
10019 static int
10020 ctl_inquiry_evpd_lbp(struct ctl_scsiio *ctsio, int alloc_len)
10021 {
10022 	struct scsi_vpd_logical_block_prov *lbp_ptr;
10023 	struct ctl_lun *lun;
10024 
10025 	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
10026 
10027 	ctsio->kern_data_ptr = malloc(sizeof(*lbp_ptr), M_CTL, M_WAITOK | M_ZERO);
10028 	lbp_ptr = (struct scsi_vpd_logical_block_prov *)ctsio->kern_data_ptr;
10029 	ctsio->kern_sg_entries = 0;
10030 
10031 	if (sizeof(*lbp_ptr) < alloc_len) {
10032 		ctsio->residual = alloc_len - sizeof(*lbp_ptr);
10033 		ctsio->kern_data_len = sizeof(*lbp_ptr);
10034 		ctsio->kern_total_len = sizeof(*lbp_ptr);
10035 	} else {
10036 		ctsio->residual = 0;
10037 		ctsio->kern_data_len = alloc_len;
10038 		ctsio->kern_total_len = alloc_len;
10039 	}
10040 	ctsio->kern_data_resid = 0;
10041 	ctsio->kern_rel_offset = 0;
10042 	ctsio->kern_sg_entries = 0;
10043 
10044 	/*
10045 	 * The control device is always connected.  The disk device, on the
10046 	 * other hand, may not be online all the time.  Need to change this
10047 	 * to figure out whether the disk device is actually online or not.
10048 	 */
10049 	if (lun != NULL)
10050 		lbp_ptr->device = (SID_QUAL_LU_CONNECTED << 5) |
10051 				  lun->be_lun->lun_type;
10052 	else
10053 		lbp_ptr->device = (SID_QUAL_LU_OFFLINE << 5) | T_DIRECT;
10054 
10055 	lbp_ptr->page_code = SVPD_LBP;
10056 	scsi_ulto2b(sizeof(*lbp_ptr) - 4, lbp_ptr->page_length);
10057 	lbp_ptr->threshold_exponent = CTL_LBP_EXPONENT;
10058 	if (lun != NULL && lun->be_lun->flags & CTL_LUN_FLAG_UNMAP) {
10059 		lbp_ptr->flags = SVPD_LBP_UNMAP | SVPD_LBP_WS16 |
10060 		    SVPD_LBP_WS10 | SVPD_LBP_RZ | SVPD_LBP_ANC_SUP;
10061 		lbp_ptr->prov_type = SVPD_LBP_THIN;
10062 	}
10063 
10064 	ctl_set_success(ctsio);
10065 	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
10066 	ctsio->be_move_done = ctl_config_move_done;
10067 	ctl_datamove((union ctl_io *)ctsio);
10068 	return (CTL_RETVAL_COMPLETE);
10069 }
10070 
10071 /*
10072  * INQUIRY with the EVPD bit set.
10073  */
10074 static int
10075 ctl_inquiry_evpd(struct ctl_scsiio *ctsio)
10076 {
10077 	struct ctl_lun *lun;
10078 	struct scsi_inquiry *cdb;
10079 	int alloc_len, retval;
10080 
10081 	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
10082 	cdb = (struct scsi_inquiry *)ctsio->cdb;
10083 	alloc_len = scsi_2btoul(cdb->length);
10084 
10085 	switch (cdb->page_code) {
10086 	case SVPD_SUPPORTED_PAGES:
10087 		retval = ctl_inquiry_evpd_supported(ctsio, alloc_len);
10088 		break;
10089 	case SVPD_UNIT_SERIAL_NUMBER:
10090 		retval = ctl_inquiry_evpd_serial(ctsio, alloc_len);
10091 		break;
10092 	case SVPD_DEVICE_ID:
10093 		retval = ctl_inquiry_evpd_devid(ctsio, alloc_len);
10094 		break;
10095 	case SVPD_EXTENDED_INQUIRY_DATA:
10096 		retval = ctl_inquiry_evpd_eid(ctsio, alloc_len);
10097 		break;
10098 	case SVPD_MODE_PAGE_POLICY:
10099 		retval = ctl_inquiry_evpd_mpp(ctsio, alloc_len);
10100 		break;
10101 	case SVPD_SCSI_PORTS:
10102 		retval = ctl_inquiry_evpd_scsi_ports(ctsio, alloc_len);
10103 		break;
10104 	case SVPD_SCSI_TPC:
10105 		retval = ctl_inquiry_evpd_tpc(ctsio, alloc_len);
10106 		break;
10107 	case SVPD_BLOCK_LIMITS:
10108 		if (lun == NULL || lun->be_lun->lun_type != T_DIRECT)
10109 			goto err;
10110 		retval = ctl_inquiry_evpd_block_limits(ctsio, alloc_len);
10111 		break;
10112 	case SVPD_BDC:
10113 		if (lun == NULL || lun->be_lun->lun_type != T_DIRECT)
10114 			goto err;
10115 		retval = ctl_inquiry_evpd_bdc(ctsio, alloc_len);
10116 		break;
10117 	case SVPD_LBP:
10118 		if (lun == NULL || lun->be_lun->lun_type != T_DIRECT)
10119 			goto err;
10120 		retval = ctl_inquiry_evpd_lbp(ctsio, alloc_len);
10121 		break;
10122 	default:
10123 err:
10124 		ctl_set_invalid_field(ctsio,
10125 				      /*sks_valid*/ 1,
10126 				      /*command*/ 1,
10127 				      /*field*/ 2,
10128 				      /*bit_valid*/ 0,
10129 				      /*bit*/ 0);
10130 		ctl_done((union ctl_io *)ctsio);
10131 		retval = CTL_RETVAL_COMPLETE;
10132 		break;
10133 	}
10134 
10135 	return (retval);
10136 }
10137 
10138 /*
10139  * Standard INQUIRY data.
10140  */
10141 static int
10142 ctl_inquiry_std(struct ctl_scsiio *ctsio)
10143 {
10144 	struct scsi_inquiry_data *inq_ptr;
10145 	struct scsi_inquiry *cdb;
10146 	struct ctl_softc *softc = control_softc;
10147 	struct ctl_port *port;
10148 	struct ctl_lun *lun;
10149 	char *val;
10150 	uint32_t alloc_len, data_len;
10151 	ctl_port_type port_type;
10152 
10153 	port = ctl_io_port(&ctsio->io_hdr);
10154 	port_type = port->port_type;
10155 	if (port_type == CTL_PORT_IOCTL || port_type == CTL_PORT_INTERNAL)
10156 		port_type = CTL_PORT_SCSI;
10157 
10158 	lun = ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
10159 	cdb = (struct scsi_inquiry *)ctsio->cdb;
10160 	alloc_len = scsi_2btoul(cdb->length);
10161 
10162 	/*
10163 	 * We malloc the full inquiry data size here and fill it
10164 	 * in.  If the user only asks for less, we'll give him
10165 	 * that much.
10166 	 */
10167 	data_len = offsetof(struct scsi_inquiry_data, vendor_specific1);
10168 	ctsio->kern_data_ptr = malloc(data_len, M_CTL, M_WAITOK | M_ZERO);
10169 	inq_ptr = (struct scsi_inquiry_data *)ctsio->kern_data_ptr;
10170 	ctsio->kern_sg_entries = 0;
10171 	ctsio->kern_data_resid = 0;
10172 	ctsio->kern_rel_offset = 0;
10173 
10174 	if (data_len < alloc_len) {
10175 		ctsio->residual = alloc_len - data_len;
10176 		ctsio->kern_data_len = data_len;
10177 		ctsio->kern_total_len = data_len;
10178 	} else {
10179 		ctsio->residual = 0;
10180 		ctsio->kern_data_len = alloc_len;
10181 		ctsio->kern_total_len = alloc_len;
10182 	}
10183 
10184 	if (lun != NULL) {
10185 		if ((lun->flags & CTL_LUN_PRIMARY_SC) ||
10186 		    softc->ha_link >= CTL_HA_LINK_UNKNOWN) {
10187 			inq_ptr->device = (SID_QUAL_LU_CONNECTED << 5) |
10188 			    lun->be_lun->lun_type;
10189 		} else {
10190 			inq_ptr->device = (SID_QUAL_LU_OFFLINE << 5) |
10191 			    lun->be_lun->lun_type;
10192 		}
10193 		if (lun->flags & CTL_LUN_REMOVABLE)
10194 			inq_ptr->dev_qual2 |= SID_RMB;
10195 	} else
10196 		inq_ptr->device = (SID_QUAL_BAD_LU << 5) | T_NODEVICE;
10197 
10198 	/* RMB in byte 2 is 0 */
10199 	inq_ptr->version = SCSI_REV_SPC4;
10200 
10201 	/*
10202 	 * According to SAM-3, even if a device only supports a single
10203 	 * level of LUN addressing, it should still set the HISUP bit:
10204 	 *
10205 	 * 4.9.1 Logical unit numbers overview
10206 	 *
10207 	 * All logical unit number formats described in this standard are
10208 	 * hierarchical in structure even when only a single level in that
10209 	 * hierarchy is used. The HISUP bit shall be set to one in the
10210 	 * standard INQUIRY data (see SPC-2) when any logical unit number
10211 	 * format described in this standard is used.  Non-hierarchical
10212 	 * formats are outside the scope of this standard.
10213 	 *
10214 	 * Therefore we set the HiSup bit here.
10215 	 *
10216 	 * The reponse format is 2, per SPC-3.
10217 	 */
10218 	inq_ptr->response_format = SID_HiSup | 2;
10219 
10220 	inq_ptr->additional_length = data_len -
10221 	    (offsetof(struct scsi_inquiry_data, additional_length) + 1);
10222 	CTL_DEBUG_PRINT(("additional_length = %d\n",
10223 			 inq_ptr->additional_length));
10224 
10225 	inq_ptr->spc3_flags = SPC3_SID_3PC | SPC3_SID_TPGS_IMPLICIT;
10226 	if (port_type == CTL_PORT_SCSI)
10227 		inq_ptr->spc2_flags = SPC2_SID_ADDR16;
10228 	inq_ptr->spc2_flags |= SPC2_SID_MultiP;
10229 	inq_ptr->flags = SID_CmdQue;
10230 	if (port_type == CTL_PORT_SCSI)
10231 		inq_ptr->flags |= SID_WBus16 | SID_Sync;
10232 
10233 	/*
10234 	 * Per SPC-3, unused bytes in ASCII strings are filled with spaces.
10235 	 * We have 8 bytes for the vendor name, and 16 bytes for the device
10236 	 * name and 4 bytes for the revision.
10237 	 */
10238 	if (lun == NULL || (val = ctl_get_opt(&lun->be_lun->options,
10239 	    "vendor")) == NULL) {
10240 		strncpy(inq_ptr->vendor, CTL_VENDOR, sizeof(inq_ptr->vendor));
10241 	} else {
10242 		memset(inq_ptr->vendor, ' ', sizeof(inq_ptr->vendor));
10243 		strncpy(inq_ptr->vendor, val,
10244 		    min(sizeof(inq_ptr->vendor), strlen(val)));
10245 	}
10246 	if (lun == NULL) {
10247 		strncpy(inq_ptr->product, CTL_DIRECT_PRODUCT,
10248 		    sizeof(inq_ptr->product));
10249 	} else if ((val = ctl_get_opt(&lun->be_lun->options, "product")) == NULL) {
10250 		switch (lun->be_lun->lun_type) {
10251 		case T_DIRECT:
10252 			strncpy(inq_ptr->product, CTL_DIRECT_PRODUCT,
10253 			    sizeof(inq_ptr->product));
10254 			break;
10255 		case T_PROCESSOR:
10256 			strncpy(inq_ptr->product, CTL_PROCESSOR_PRODUCT,
10257 			    sizeof(inq_ptr->product));
10258 			break;
10259 		case T_CDROM:
10260 			strncpy(inq_ptr->product, CTL_CDROM_PRODUCT,
10261 			    sizeof(inq_ptr->product));
10262 			break;
10263 		default:
10264 			strncpy(inq_ptr->product, CTL_UNKNOWN_PRODUCT,
10265 			    sizeof(inq_ptr->product));
10266 			break;
10267 		}
10268 	} else {
10269 		memset(inq_ptr->product, ' ', sizeof(inq_ptr->product));
10270 		strncpy(inq_ptr->product, val,
10271 		    min(sizeof(inq_ptr->product), strlen(val)));
10272 	}
10273 
10274 	/*
10275 	 * XXX make this a macro somewhere so it automatically gets
10276 	 * incremented when we make changes.
10277 	 */
10278 	if (lun == NULL || (val = ctl_get_opt(&lun->be_lun->options,
10279 	    "revision")) == NULL) {
10280 		strncpy(inq_ptr->revision, "0001", sizeof(inq_ptr->revision));
10281 	} else {
10282 		memset(inq_ptr->revision, ' ', sizeof(inq_ptr->revision));
10283 		strncpy(inq_ptr->revision, val,
10284 		    min(sizeof(inq_ptr->revision), strlen(val)));
10285 	}
10286 
10287 	/*
10288 	 * For parallel SCSI, we support double transition and single
10289 	 * transition clocking.  We also support QAS (Quick Arbitration
10290 	 * and Selection) and Information Unit transfers on both the
10291 	 * control and array devices.
10292 	 */
10293 	if (port_type == CTL_PORT_SCSI)
10294 		inq_ptr->spi3data = SID_SPI_CLOCK_DT_ST | SID_SPI_QAS |
10295 				    SID_SPI_IUS;
10296 
10297 	/* SAM-5 (no version claimed) */
10298 	scsi_ulto2b(0x00A0, inq_ptr->version1);
10299 	/* SPC-4 (no version claimed) */
10300 	scsi_ulto2b(0x0460, inq_ptr->version2);
10301 	if (port_type == CTL_PORT_FC) {
10302 		/* FCP-2 ANSI INCITS.350:2003 */
10303 		scsi_ulto2b(0x0917, inq_ptr->version3);
10304 	} else if (port_type == CTL_PORT_SCSI) {
10305 		/* SPI-4 ANSI INCITS.362:200x */
10306 		scsi_ulto2b(0x0B56, inq_ptr->version3);
10307 	} else if (port_type == CTL_PORT_ISCSI) {
10308 		/* iSCSI (no version claimed) */
10309 		scsi_ulto2b(0x0960, inq_ptr->version3);
10310 	} else if (port_type == CTL_PORT_SAS) {
10311 		/* SAS (no version claimed) */
10312 		scsi_ulto2b(0x0BE0, inq_ptr->version3);
10313 	}
10314 
10315 	if (lun == NULL) {
10316 		/* SBC-4 (no version claimed) */
10317 		scsi_ulto2b(0x0600, inq_ptr->version4);
10318 	} else {
10319 		switch (lun->be_lun->lun_type) {
10320 		case T_DIRECT:
10321 			/* SBC-4 (no version claimed) */
10322 			scsi_ulto2b(0x0600, inq_ptr->version4);
10323 			break;
10324 		case T_PROCESSOR:
10325 			break;
10326 		case T_CDROM:
10327 			/* MMC-6 (no version claimed) */
10328 			scsi_ulto2b(0x04E0, inq_ptr->version4);
10329 			break;
10330 		default:
10331 			break;
10332 		}
10333 	}
10334 
10335 	ctl_set_success(ctsio);
10336 	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
10337 	ctsio->be_move_done = ctl_config_move_done;
10338 	ctl_datamove((union ctl_io *)ctsio);
10339 	return (CTL_RETVAL_COMPLETE);
10340 }
10341 
10342 int
10343 ctl_inquiry(struct ctl_scsiio *ctsio)
10344 {
10345 	struct scsi_inquiry *cdb;
10346 	int retval;
10347 
10348 	CTL_DEBUG_PRINT(("ctl_inquiry\n"));
10349 
10350 	cdb = (struct scsi_inquiry *)ctsio->cdb;
10351 	if (cdb->byte2 & SI_EVPD)
10352 		retval = ctl_inquiry_evpd(ctsio);
10353 	else if (cdb->page_code == 0)
10354 		retval = ctl_inquiry_std(ctsio);
10355 	else {
10356 		ctl_set_invalid_field(ctsio,
10357 				      /*sks_valid*/ 1,
10358 				      /*command*/ 1,
10359 				      /*field*/ 2,
10360 				      /*bit_valid*/ 0,
10361 				      /*bit*/ 0);
10362 		ctl_done((union ctl_io *)ctsio);
10363 		return (CTL_RETVAL_COMPLETE);
10364 	}
10365 
10366 	return (retval);
10367 }
10368 
10369 int
10370 ctl_get_config(struct ctl_scsiio *ctsio)
10371 {
10372 	struct scsi_get_config_header *hdr;
10373 	struct scsi_get_config_feature *feature;
10374 	struct scsi_get_config *cdb;
10375 	struct ctl_lun *lun;
10376 	uint32_t alloc_len, data_len;
10377 	int rt, starting;
10378 
10379 	lun = ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
10380 	cdb = (struct scsi_get_config *)ctsio->cdb;
10381 	rt = (cdb->rt & SGC_RT_MASK);
10382 	starting = scsi_2btoul(cdb->starting_feature);
10383 	alloc_len = scsi_2btoul(cdb->length);
10384 
10385 	data_len = sizeof(struct scsi_get_config_header) +
10386 	    sizeof(struct scsi_get_config_feature) + 8 +
10387 	    sizeof(struct scsi_get_config_feature) + 8 +
10388 	    sizeof(struct scsi_get_config_feature) + 4 +
10389 	    sizeof(struct scsi_get_config_feature) + 4 +
10390 	    sizeof(struct scsi_get_config_feature) + 8 +
10391 	    sizeof(struct scsi_get_config_feature) +
10392 	    sizeof(struct scsi_get_config_feature) + 4 +
10393 	    sizeof(struct scsi_get_config_feature) + 4 +
10394 	    sizeof(struct scsi_get_config_feature) + 4 +
10395 	    sizeof(struct scsi_get_config_feature) + 4 +
10396 	    sizeof(struct scsi_get_config_feature) + 4 +
10397 	    sizeof(struct scsi_get_config_feature) + 4;
10398 	ctsio->kern_data_ptr = malloc(data_len, M_CTL, M_WAITOK | M_ZERO);
10399 	ctsio->kern_sg_entries = 0;
10400 	ctsio->kern_data_resid = 0;
10401 	ctsio->kern_rel_offset = 0;
10402 
10403 	hdr = (struct scsi_get_config_header *)ctsio->kern_data_ptr;
10404 	if (lun->flags & CTL_LUN_NO_MEDIA)
10405 		scsi_ulto2b(0x0000, hdr->current_profile);
10406 	else
10407 		scsi_ulto2b(0x0010, hdr->current_profile);
10408 	feature = (struct scsi_get_config_feature *)(hdr + 1);
10409 
10410 	if (starting > 0x003b)
10411 		goto done;
10412 	if (starting > 0x003a)
10413 		goto f3b;
10414 	if (starting > 0x002b)
10415 		goto f3a;
10416 	if (starting > 0x002a)
10417 		goto f2b;
10418 	if (starting > 0x001f)
10419 		goto f2a;
10420 	if (starting > 0x001e)
10421 		goto f1f;
10422 	if (starting > 0x001d)
10423 		goto f1e;
10424 	if (starting > 0x0010)
10425 		goto f1d;
10426 	if (starting > 0x0003)
10427 		goto f10;
10428 	if (starting > 0x0002)
10429 		goto f3;
10430 	if (starting > 0x0001)
10431 		goto f2;
10432 	if (starting > 0x0000)
10433 		goto f1;
10434 
10435 	/* Profile List */
10436 	scsi_ulto2b(0x0000, feature->feature_code);
10437 	feature->flags = SGC_F_PERSISTENT | SGC_F_CURRENT;
10438 	feature->add_length = 8;
10439 	scsi_ulto2b(0x0008, &feature->feature_data[0]);	/* CD-ROM */
10440 	feature->feature_data[2] = 0x00;
10441 	scsi_ulto2b(0x0010, &feature->feature_data[4]);	/* DVD-ROM */
10442 	feature->feature_data[6] = 0x01;
10443 	feature = (struct scsi_get_config_feature *)
10444 	    &feature->feature_data[feature->add_length];
10445 
10446 f1:	/* Core */
10447 	scsi_ulto2b(0x0001, feature->feature_code);
10448 	feature->flags = 0x08 | SGC_F_PERSISTENT | SGC_F_CURRENT;
10449 	feature->add_length = 8;
10450 	scsi_ulto4b(0x00000000, &feature->feature_data[0]);
10451 	feature->feature_data[4] = 0x03;
10452 	feature = (struct scsi_get_config_feature *)
10453 	    &feature->feature_data[feature->add_length];
10454 
10455 f2:	/* Morphing */
10456 	scsi_ulto2b(0x0002, feature->feature_code);
10457 	feature->flags = 0x04 | SGC_F_PERSISTENT | SGC_F_CURRENT;
10458 	feature->add_length = 4;
10459 	feature->feature_data[0] = 0x02;
10460 	feature = (struct scsi_get_config_feature *)
10461 	    &feature->feature_data[feature->add_length];
10462 
10463 f3:	/* Removable Medium */
10464 	scsi_ulto2b(0x0003, feature->feature_code);
10465 	feature->flags = 0x04 | SGC_F_PERSISTENT | SGC_F_CURRENT;
10466 	feature->add_length = 4;
10467 	feature->feature_data[0] = 0x39;
10468 	feature = (struct scsi_get_config_feature *)
10469 	    &feature->feature_data[feature->add_length];
10470 
10471 	if (rt == SGC_RT_CURRENT && (lun->flags & CTL_LUN_NO_MEDIA))
10472 		goto done;
10473 
10474 f10:	/* Random Read */
10475 	scsi_ulto2b(0x0010, feature->feature_code);
10476 	feature->flags = 0x00;
10477 	if ((lun->flags & CTL_LUN_NO_MEDIA) == 0)
10478 		feature->flags |= SGC_F_CURRENT;
10479 	feature->add_length = 8;
10480 	scsi_ulto4b(lun->be_lun->blocksize, &feature->feature_data[0]);
10481 	scsi_ulto2b(1, &feature->feature_data[4]);
10482 	feature->feature_data[6] = 0x00;
10483 	feature = (struct scsi_get_config_feature *)
10484 	    &feature->feature_data[feature->add_length];
10485 
10486 f1d:	/* Multi-Read */
10487 	scsi_ulto2b(0x001D, feature->feature_code);
10488 	feature->flags = 0x00;
10489 	if ((lun->flags & CTL_LUN_NO_MEDIA) == 0)
10490 		feature->flags |= SGC_F_CURRENT;
10491 	feature->add_length = 0;
10492 	feature = (struct scsi_get_config_feature *)
10493 	    &feature->feature_data[feature->add_length];
10494 
10495 f1e:	/* CD Read */
10496 	scsi_ulto2b(0x001E, feature->feature_code);
10497 	feature->flags = 0x00;
10498 	if ((lun->flags & CTL_LUN_NO_MEDIA) == 0)
10499 		feature->flags |= SGC_F_CURRENT;
10500 	feature->add_length = 4;
10501 	feature->feature_data[0] = 0x00;
10502 	feature = (struct scsi_get_config_feature *)
10503 	    &feature->feature_data[feature->add_length];
10504 
10505 f1f:	/* DVD Read */
10506 	scsi_ulto2b(0x001F, feature->feature_code);
10507 	feature->flags = 0x08;
10508 	if ((lun->flags & CTL_LUN_NO_MEDIA) == 0)
10509 		feature->flags |= SGC_F_CURRENT;
10510 	feature->add_length = 4;
10511 	feature->feature_data[0] = 0x01;
10512 	feature->feature_data[2] = 0x03;
10513 	feature = (struct scsi_get_config_feature *)
10514 	    &feature->feature_data[feature->add_length];
10515 
10516 f2a:	/* DVD+RW */
10517 	scsi_ulto2b(0x002A, feature->feature_code);
10518 	feature->flags = 0x04;
10519 	if ((lun->flags & CTL_LUN_NO_MEDIA) == 0)
10520 		feature->flags |= SGC_F_CURRENT;
10521 	feature->add_length = 4;
10522 	feature->feature_data[0] = 0x00;
10523 	feature->feature_data[1] = 0x00;
10524 	feature = (struct scsi_get_config_feature *)
10525 	    &feature->feature_data[feature->add_length];
10526 
10527 f2b:	/* DVD+R */
10528 	scsi_ulto2b(0x002B, feature->feature_code);
10529 	feature->flags = 0x00;
10530 	if ((lun->flags & CTL_LUN_NO_MEDIA) == 0)
10531 		feature->flags |= SGC_F_CURRENT;
10532 	feature->add_length = 4;
10533 	feature->feature_data[0] = 0x00;
10534 	feature = (struct scsi_get_config_feature *)
10535 	    &feature->feature_data[feature->add_length];
10536 
10537 f3a:	/* DVD+RW Dual Layer */
10538 	scsi_ulto2b(0x003A, feature->feature_code);
10539 	feature->flags = 0x00;
10540 	if ((lun->flags & CTL_LUN_NO_MEDIA) == 0)
10541 		feature->flags |= SGC_F_CURRENT;
10542 	feature->add_length = 4;
10543 	feature->feature_data[0] = 0x00;
10544 	feature->feature_data[1] = 0x00;
10545 	feature = (struct scsi_get_config_feature *)
10546 	    &feature->feature_data[feature->add_length];
10547 
10548 f3b:	/* DVD+R Dual Layer */
10549 	scsi_ulto2b(0x003B, feature->feature_code);
10550 	feature->flags = 0x00;
10551 	if ((lun->flags & CTL_LUN_NO_MEDIA) == 0)
10552 		feature->flags |= SGC_F_CURRENT;
10553 	feature->add_length = 4;
10554 	feature->feature_data[0] = 0x00;
10555 	feature = (struct scsi_get_config_feature *)
10556 	    &feature->feature_data[feature->add_length];
10557 
10558 done:
10559 	data_len = (uint8_t *)feature - (uint8_t *)hdr;
10560 	if (rt == SGC_RT_SPECIFIC && data_len > 4) {
10561 		feature = (struct scsi_get_config_feature *)(hdr + 1);
10562 		if (scsi_2btoul(feature->feature_code) == starting)
10563 			feature = (struct scsi_get_config_feature *)
10564 			    &feature->feature_data[feature->add_length];
10565 		data_len = (uint8_t *)feature - (uint8_t *)hdr;
10566 	}
10567 	scsi_ulto4b(data_len - 4, hdr->data_length);
10568 	if (data_len < alloc_len) {
10569 		ctsio->residual = alloc_len - data_len;
10570 		ctsio->kern_data_len = data_len;
10571 		ctsio->kern_total_len = data_len;
10572 	} else {
10573 		ctsio->residual = 0;
10574 		ctsio->kern_data_len = alloc_len;
10575 		ctsio->kern_total_len = alloc_len;
10576 	}
10577 
10578 	ctl_set_success(ctsio);
10579 	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
10580 	ctsio->be_move_done = ctl_config_move_done;
10581 	ctl_datamove((union ctl_io *)ctsio);
10582 	return (CTL_RETVAL_COMPLETE);
10583 }
10584 
10585 int
10586 ctl_get_event_status(struct ctl_scsiio *ctsio)
10587 {
10588 	struct scsi_get_event_status_header *hdr;
10589 	struct scsi_get_event_status *cdb;
10590 	struct ctl_lun *lun;
10591 	uint32_t alloc_len, data_len;
10592 	int notif_class;
10593 
10594 	lun = ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
10595 	cdb = (struct scsi_get_event_status *)ctsio->cdb;
10596 	if ((cdb->byte2 & SGESN_POLLED) == 0) {
10597 		ctl_set_invalid_field(ctsio, /*sks_valid*/ 1, /*command*/ 1,
10598 		    /*field*/ 1, /*bit_valid*/ 1, /*bit*/ 0);
10599 		ctl_done((union ctl_io *)ctsio);
10600 		return (CTL_RETVAL_COMPLETE);
10601 	}
10602 	notif_class = cdb->notif_class;
10603 	alloc_len = scsi_2btoul(cdb->length);
10604 
10605 	data_len = sizeof(struct scsi_get_event_status_header);
10606 	ctsio->kern_data_ptr = malloc(data_len, M_CTL, M_WAITOK | M_ZERO);
10607 	ctsio->kern_sg_entries = 0;
10608 	ctsio->kern_data_resid = 0;
10609 	ctsio->kern_rel_offset = 0;
10610 
10611 	if (data_len < alloc_len) {
10612 		ctsio->residual = alloc_len - data_len;
10613 		ctsio->kern_data_len = data_len;
10614 		ctsio->kern_total_len = data_len;
10615 	} else {
10616 		ctsio->residual = 0;
10617 		ctsio->kern_data_len = alloc_len;
10618 		ctsio->kern_total_len = alloc_len;
10619 	}
10620 
10621 	hdr = (struct scsi_get_event_status_header *)ctsio->kern_data_ptr;
10622 	scsi_ulto2b(0, hdr->descr_length);
10623 	hdr->nea_class = SGESN_NEA;
10624 	hdr->supported_class = 0;
10625 
10626 	ctl_set_success(ctsio);
10627 	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
10628 	ctsio->be_move_done = ctl_config_move_done;
10629 	ctl_datamove((union ctl_io *)ctsio);
10630 	return (CTL_RETVAL_COMPLETE);
10631 }
10632 
10633 int
10634 ctl_mechanism_status(struct ctl_scsiio *ctsio)
10635 {
10636 	struct scsi_mechanism_status_header *hdr;
10637 	struct scsi_mechanism_status *cdb;
10638 	struct ctl_lun *lun;
10639 	uint32_t alloc_len, data_len;
10640 
10641 	lun = ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
10642 	cdb = (struct scsi_mechanism_status *)ctsio->cdb;
10643 	alloc_len = scsi_2btoul(cdb->length);
10644 
10645 	data_len = sizeof(struct scsi_mechanism_status_header);
10646 	ctsio->kern_data_ptr = malloc(data_len, M_CTL, M_WAITOK | M_ZERO);
10647 	ctsio->kern_sg_entries = 0;
10648 	ctsio->kern_data_resid = 0;
10649 	ctsio->kern_rel_offset = 0;
10650 
10651 	if (data_len < alloc_len) {
10652 		ctsio->residual = alloc_len - data_len;
10653 		ctsio->kern_data_len = data_len;
10654 		ctsio->kern_total_len = data_len;
10655 	} else {
10656 		ctsio->residual = 0;
10657 		ctsio->kern_data_len = alloc_len;
10658 		ctsio->kern_total_len = alloc_len;
10659 	}
10660 
10661 	hdr = (struct scsi_mechanism_status_header *)ctsio->kern_data_ptr;
10662 	hdr->state1 = 0x00;
10663 	hdr->state2 = 0xe0;
10664 	scsi_ulto3b(0, hdr->lba);
10665 	hdr->slots_num = 0;
10666 	scsi_ulto2b(0, hdr->slots_length);
10667 
10668 	ctl_set_success(ctsio);
10669 	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
10670 	ctsio->be_move_done = ctl_config_move_done;
10671 	ctl_datamove((union ctl_io *)ctsio);
10672 	return (CTL_RETVAL_COMPLETE);
10673 }
10674 
10675 static void
10676 ctl_ultomsf(uint32_t lba, uint8_t *buf)
10677 {
10678 
10679 	lba += 150;
10680 	buf[0] = 0;
10681 	buf[1] = bin2bcd((lba / 75) / 60);
10682 	buf[2] = bin2bcd((lba / 75) % 60);
10683 	buf[3] = bin2bcd(lba % 75);
10684 }
10685 
10686 int
10687 ctl_read_toc(struct ctl_scsiio *ctsio)
10688 {
10689 	struct scsi_read_toc_hdr *hdr;
10690 	struct scsi_read_toc_type01_descr *descr;
10691 	struct scsi_read_toc *cdb;
10692 	struct ctl_lun *lun;
10693 	uint32_t alloc_len, data_len;
10694 	int format, msf;
10695 
10696 	lun = ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
10697 	cdb = (struct scsi_read_toc *)ctsio->cdb;
10698 	msf = (cdb->byte2 & CD_MSF) != 0;
10699 	format = cdb->format;
10700 	alloc_len = scsi_2btoul(cdb->data_len);
10701 
10702 	data_len = sizeof(struct scsi_read_toc_hdr);
10703 	if (format == 0)
10704 		data_len += 2 * sizeof(struct scsi_read_toc_type01_descr);
10705 	else
10706 		data_len += sizeof(struct scsi_read_toc_type01_descr);
10707 	ctsio->kern_data_ptr = malloc(data_len, M_CTL, M_WAITOK | M_ZERO);
10708 	ctsio->kern_sg_entries = 0;
10709 	ctsio->kern_data_resid = 0;
10710 	ctsio->kern_rel_offset = 0;
10711 
10712 	if (data_len < alloc_len) {
10713 		ctsio->residual = alloc_len - data_len;
10714 		ctsio->kern_data_len = data_len;
10715 		ctsio->kern_total_len = data_len;
10716 	} else {
10717 		ctsio->residual = 0;
10718 		ctsio->kern_data_len = alloc_len;
10719 		ctsio->kern_total_len = alloc_len;
10720 	}
10721 
10722 	hdr = (struct scsi_read_toc_hdr *)ctsio->kern_data_ptr;
10723 	if (format == 0) {
10724 		scsi_ulto2b(0x12, hdr->data_length);
10725 		hdr->first = 1;
10726 		hdr->last = 1;
10727 		descr = (struct scsi_read_toc_type01_descr *)(hdr + 1);
10728 		descr->addr_ctl = 0x14;
10729 		descr->track_number = 1;
10730 		if (msf)
10731 			ctl_ultomsf(0, descr->track_start);
10732 		else
10733 			scsi_ulto4b(0, descr->track_start);
10734 		descr++;
10735 		descr->addr_ctl = 0x14;
10736 		descr->track_number = 0xaa;
10737 		if (msf)
10738 			ctl_ultomsf(lun->be_lun->maxlba+1, descr->track_start);
10739 		else
10740 			scsi_ulto4b(lun->be_lun->maxlba+1, descr->track_start);
10741 	} else {
10742 		scsi_ulto2b(0x0a, hdr->data_length);
10743 		hdr->first = 1;
10744 		hdr->last = 1;
10745 		descr = (struct scsi_read_toc_type01_descr *)(hdr + 1);
10746 		descr->addr_ctl = 0x14;
10747 		descr->track_number = 1;
10748 		if (msf)
10749 			ctl_ultomsf(0, descr->track_start);
10750 		else
10751 			scsi_ulto4b(0, descr->track_start);
10752 	}
10753 
10754 	ctl_set_success(ctsio);
10755 	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
10756 	ctsio->be_move_done = ctl_config_move_done;
10757 	ctl_datamove((union ctl_io *)ctsio);
10758 	return (CTL_RETVAL_COMPLETE);
10759 }
10760 
10761 /*
10762  * For known CDB types, parse the LBA and length.
10763  */
10764 static int
10765 ctl_get_lba_len(union ctl_io *io, uint64_t *lba, uint64_t *len)
10766 {
10767 	if (io->io_hdr.io_type != CTL_IO_SCSI)
10768 		return (1);
10769 
10770 	switch (io->scsiio.cdb[0]) {
10771 	case COMPARE_AND_WRITE: {
10772 		struct scsi_compare_and_write *cdb;
10773 
10774 		cdb = (struct scsi_compare_and_write *)io->scsiio.cdb;
10775 
10776 		*lba = scsi_8btou64(cdb->addr);
10777 		*len = cdb->length;
10778 		break;
10779 	}
10780 	case READ_6:
10781 	case WRITE_6: {
10782 		struct scsi_rw_6 *cdb;
10783 
10784 		cdb = (struct scsi_rw_6 *)io->scsiio.cdb;
10785 
10786 		*lba = scsi_3btoul(cdb->addr);
10787 		/* only 5 bits are valid in the most significant address byte */
10788 		*lba &= 0x1fffff;
10789 		*len = cdb->length;
10790 		break;
10791 	}
10792 	case READ_10:
10793 	case WRITE_10: {
10794 		struct scsi_rw_10 *cdb;
10795 
10796 		cdb = (struct scsi_rw_10 *)io->scsiio.cdb;
10797 
10798 		*lba = scsi_4btoul(cdb->addr);
10799 		*len = scsi_2btoul(cdb->length);
10800 		break;
10801 	}
10802 	case WRITE_VERIFY_10: {
10803 		struct scsi_write_verify_10 *cdb;
10804 
10805 		cdb = (struct scsi_write_verify_10 *)io->scsiio.cdb;
10806 
10807 		*lba = scsi_4btoul(cdb->addr);
10808 		*len = scsi_2btoul(cdb->length);
10809 		break;
10810 	}
10811 	case READ_12:
10812 	case WRITE_12: {
10813 		struct scsi_rw_12 *cdb;
10814 
10815 		cdb = (struct scsi_rw_12 *)io->scsiio.cdb;
10816 
10817 		*lba = scsi_4btoul(cdb->addr);
10818 		*len = scsi_4btoul(cdb->length);
10819 		break;
10820 	}
10821 	case WRITE_VERIFY_12: {
10822 		struct scsi_write_verify_12 *cdb;
10823 
10824 		cdb = (struct scsi_write_verify_12 *)io->scsiio.cdb;
10825 
10826 		*lba = scsi_4btoul(cdb->addr);
10827 		*len = scsi_4btoul(cdb->length);
10828 		break;
10829 	}
10830 	case READ_16:
10831 	case WRITE_16: {
10832 		struct scsi_rw_16 *cdb;
10833 
10834 		cdb = (struct scsi_rw_16 *)io->scsiio.cdb;
10835 
10836 		*lba = scsi_8btou64(cdb->addr);
10837 		*len = scsi_4btoul(cdb->length);
10838 		break;
10839 	}
10840 	case WRITE_ATOMIC_16: {
10841 		struct scsi_write_atomic_16 *cdb;
10842 
10843 		cdb = (struct scsi_write_atomic_16 *)io->scsiio.cdb;
10844 
10845 		*lba = scsi_8btou64(cdb->addr);
10846 		*len = scsi_2btoul(cdb->length);
10847 		break;
10848 	}
10849 	case WRITE_VERIFY_16: {
10850 		struct scsi_write_verify_16 *cdb;
10851 
10852 		cdb = (struct scsi_write_verify_16 *)io->scsiio.cdb;
10853 
10854 		*lba = scsi_8btou64(cdb->addr);
10855 		*len = scsi_4btoul(cdb->length);
10856 		break;
10857 	}
10858 	case WRITE_SAME_10: {
10859 		struct scsi_write_same_10 *cdb;
10860 
10861 		cdb = (struct scsi_write_same_10 *)io->scsiio.cdb;
10862 
10863 		*lba = scsi_4btoul(cdb->addr);
10864 		*len = scsi_2btoul(cdb->length);
10865 		break;
10866 	}
10867 	case WRITE_SAME_16: {
10868 		struct scsi_write_same_16 *cdb;
10869 
10870 		cdb = (struct scsi_write_same_16 *)io->scsiio.cdb;
10871 
10872 		*lba = scsi_8btou64(cdb->addr);
10873 		*len = scsi_4btoul(cdb->length);
10874 		break;
10875 	}
10876 	case VERIFY_10: {
10877 		struct scsi_verify_10 *cdb;
10878 
10879 		cdb = (struct scsi_verify_10 *)io->scsiio.cdb;
10880 
10881 		*lba = scsi_4btoul(cdb->addr);
10882 		*len = scsi_2btoul(cdb->length);
10883 		break;
10884 	}
10885 	case VERIFY_12: {
10886 		struct scsi_verify_12 *cdb;
10887 
10888 		cdb = (struct scsi_verify_12 *)io->scsiio.cdb;
10889 
10890 		*lba = scsi_4btoul(cdb->addr);
10891 		*len = scsi_4btoul(cdb->length);
10892 		break;
10893 	}
10894 	case VERIFY_16: {
10895 		struct scsi_verify_16 *cdb;
10896 
10897 		cdb = (struct scsi_verify_16 *)io->scsiio.cdb;
10898 
10899 		*lba = scsi_8btou64(cdb->addr);
10900 		*len = scsi_4btoul(cdb->length);
10901 		break;
10902 	}
10903 	case UNMAP: {
10904 		*lba = 0;
10905 		*len = UINT64_MAX;
10906 		break;
10907 	}
10908 	case SERVICE_ACTION_IN: {	/* GET LBA STATUS */
10909 		struct scsi_get_lba_status *cdb;
10910 
10911 		cdb = (struct scsi_get_lba_status *)io->scsiio.cdb;
10912 		*lba = scsi_8btou64(cdb->addr);
10913 		*len = UINT32_MAX;
10914 		break;
10915 	}
10916 	default:
10917 		return (1);
10918 		break; /* NOTREACHED */
10919 	}
10920 
10921 	return (0);
10922 }
10923 
10924 static ctl_action
10925 ctl_extent_check_lba(uint64_t lba1, uint64_t len1, uint64_t lba2, uint64_t len2,
10926     bool seq)
10927 {
10928 	uint64_t endlba1, endlba2;
10929 
10930 	endlba1 = lba1 + len1 - (seq ? 0 : 1);
10931 	endlba2 = lba2 + len2 - 1;
10932 
10933 	if ((endlba1 < lba2) || (endlba2 < lba1))
10934 		return (CTL_ACTION_PASS);
10935 	else
10936 		return (CTL_ACTION_BLOCK);
10937 }
10938 
10939 static int
10940 ctl_extent_check_unmap(union ctl_io *io, uint64_t lba2, uint64_t len2)
10941 {
10942 	struct ctl_ptr_len_flags *ptrlen;
10943 	struct scsi_unmap_desc *buf, *end, *range;
10944 	uint64_t lba;
10945 	uint32_t len;
10946 
10947 	/* If not UNMAP -- go other way. */
10948 	if (io->io_hdr.io_type != CTL_IO_SCSI ||
10949 	    io->scsiio.cdb[0] != UNMAP)
10950 		return (CTL_ACTION_ERROR);
10951 
10952 	/* If UNMAP without data -- block and wait for data. */
10953 	ptrlen = (struct ctl_ptr_len_flags *)
10954 	    &io->io_hdr.ctl_private[CTL_PRIV_LBA_LEN];
10955 	if ((io->io_hdr.flags & CTL_FLAG_ALLOCATED) == 0 ||
10956 	    ptrlen->ptr == NULL)
10957 		return (CTL_ACTION_BLOCK);
10958 
10959 	/* UNMAP with data -- check for collision. */
10960 	buf = (struct scsi_unmap_desc *)ptrlen->ptr;
10961 	end = buf + ptrlen->len / sizeof(*buf);
10962 	for (range = buf; range < end; range++) {
10963 		lba = scsi_8btou64(range->lba);
10964 		len = scsi_4btoul(range->length);
10965 		if ((lba < lba2 + len2) && (lba + len > lba2))
10966 			return (CTL_ACTION_BLOCK);
10967 	}
10968 	return (CTL_ACTION_PASS);
10969 }
10970 
10971 static ctl_action
10972 ctl_extent_check(union ctl_io *io1, union ctl_io *io2, bool seq)
10973 {
10974 	uint64_t lba1, lba2;
10975 	uint64_t len1, len2;
10976 	int retval;
10977 
10978 	if (ctl_get_lba_len(io2, &lba2, &len2) != 0)
10979 		return (CTL_ACTION_ERROR);
10980 
10981 	retval = ctl_extent_check_unmap(io1, lba2, len2);
10982 	if (retval != CTL_ACTION_ERROR)
10983 		return (retval);
10984 
10985 	if (ctl_get_lba_len(io1, &lba1, &len1) != 0)
10986 		return (CTL_ACTION_ERROR);
10987 
10988 	if (io1->io_hdr.flags & CTL_FLAG_SERSEQ_DONE)
10989 		seq = FALSE;
10990 	return (ctl_extent_check_lba(lba1, len1, lba2, len2, seq));
10991 }
10992 
10993 static ctl_action
10994 ctl_extent_check_seq(union ctl_io *io1, union ctl_io *io2)
10995 {
10996 	uint64_t lba1, lba2;
10997 	uint64_t len1, len2;
10998 
10999 	if (io1->io_hdr.flags & CTL_FLAG_SERSEQ_DONE)
11000 		return (CTL_ACTION_PASS);
11001 	if (ctl_get_lba_len(io1, &lba1, &len1) != 0)
11002 		return (CTL_ACTION_ERROR);
11003 	if (ctl_get_lba_len(io2, &lba2, &len2) != 0)
11004 		return (CTL_ACTION_ERROR);
11005 
11006 	if (lba1 + len1 == lba2)
11007 		return (CTL_ACTION_BLOCK);
11008 	return (CTL_ACTION_PASS);
11009 }
11010 
11011 static ctl_action
11012 ctl_check_for_blockage(struct ctl_lun *lun, union ctl_io *pending_io,
11013     union ctl_io *ooa_io)
11014 {
11015 	const struct ctl_cmd_entry *pending_entry, *ooa_entry;
11016 	const ctl_serialize_action *serialize_row;
11017 
11018 	/*
11019 	 * The initiator attempted multiple untagged commands at the same
11020 	 * time.  Can't do that.
11021 	 */
11022 	if ((pending_io->scsiio.tag_type == CTL_TAG_UNTAGGED)
11023 	 && (ooa_io->scsiio.tag_type == CTL_TAG_UNTAGGED)
11024 	 && ((pending_io->io_hdr.nexus.targ_port ==
11025 	      ooa_io->io_hdr.nexus.targ_port)
11026 	  && (pending_io->io_hdr.nexus.initid ==
11027 	      ooa_io->io_hdr.nexus.initid))
11028 	 && ((ooa_io->io_hdr.flags & (CTL_FLAG_ABORT |
11029 	      CTL_FLAG_STATUS_SENT)) == 0))
11030 		return (CTL_ACTION_OVERLAP);
11031 
11032 	/*
11033 	 * The initiator attempted to send multiple tagged commands with
11034 	 * the same ID.  (It's fine if different initiators have the same
11035 	 * tag ID.)
11036 	 *
11037 	 * Even if all of those conditions are true, we don't kill the I/O
11038 	 * if the command ahead of us has been aborted.  We won't end up
11039 	 * sending it to the FETD, and it's perfectly legal to resend a
11040 	 * command with the same tag number as long as the previous
11041 	 * instance of this tag number has been aborted somehow.
11042 	 */
11043 	if ((pending_io->scsiio.tag_type != CTL_TAG_UNTAGGED)
11044 	 && (ooa_io->scsiio.tag_type != CTL_TAG_UNTAGGED)
11045 	 && (pending_io->scsiio.tag_num == ooa_io->scsiio.tag_num)
11046 	 && ((pending_io->io_hdr.nexus.targ_port ==
11047 	      ooa_io->io_hdr.nexus.targ_port)
11048 	  && (pending_io->io_hdr.nexus.initid ==
11049 	      ooa_io->io_hdr.nexus.initid))
11050 	 && ((ooa_io->io_hdr.flags & (CTL_FLAG_ABORT |
11051 	      CTL_FLAG_STATUS_SENT)) == 0))
11052 		return (CTL_ACTION_OVERLAP_TAG);
11053 
11054 	/*
11055 	 * If we get a head of queue tag, SAM-3 says that we should
11056 	 * immediately execute it.
11057 	 *
11058 	 * What happens if this command would normally block for some other
11059 	 * reason?  e.g. a request sense with a head of queue tag
11060 	 * immediately after a write.  Normally that would block, but this
11061 	 * will result in its getting executed immediately...
11062 	 *
11063 	 * We currently return "pass" instead of "skip", so we'll end up
11064 	 * going through the rest of the queue to check for overlapped tags.
11065 	 *
11066 	 * XXX KDM check for other types of blockage first??
11067 	 */
11068 	if (pending_io->scsiio.tag_type == CTL_TAG_HEAD_OF_QUEUE)
11069 		return (CTL_ACTION_PASS);
11070 
11071 	/*
11072 	 * Ordered tags have to block until all items ahead of them
11073 	 * have completed.  If we get called with an ordered tag, we always
11074 	 * block, if something else is ahead of us in the queue.
11075 	 */
11076 	if (pending_io->scsiio.tag_type == CTL_TAG_ORDERED)
11077 		return (CTL_ACTION_BLOCK);
11078 
11079 	/*
11080 	 * Simple tags get blocked until all head of queue and ordered tags
11081 	 * ahead of them have completed.  I'm lumping untagged commands in
11082 	 * with simple tags here.  XXX KDM is that the right thing to do?
11083 	 */
11084 	if (((pending_io->scsiio.tag_type == CTL_TAG_UNTAGGED)
11085 	  || (pending_io->scsiio.tag_type == CTL_TAG_SIMPLE))
11086 	 && ((ooa_io->scsiio.tag_type == CTL_TAG_HEAD_OF_QUEUE)
11087 	  || (ooa_io->scsiio.tag_type == CTL_TAG_ORDERED)))
11088 		return (CTL_ACTION_BLOCK);
11089 
11090 	pending_entry = ctl_get_cmd_entry(&pending_io->scsiio, NULL);
11091 	KASSERT(pending_entry->seridx < CTL_SERIDX_COUNT,
11092 	    ("%s: Invalid seridx %d for pending CDB %02x %02x @ %p",
11093 	     __func__, pending_entry->seridx, pending_io->scsiio.cdb[0],
11094 	     pending_io->scsiio.cdb[1], pending_io));
11095 	ooa_entry = ctl_get_cmd_entry(&ooa_io->scsiio, NULL);
11096 	if (ooa_entry->seridx == CTL_SERIDX_INVLD)
11097 		return (CTL_ACTION_PASS); /* Unsupported command in OOA queue */
11098 	KASSERT(ooa_entry->seridx < CTL_SERIDX_COUNT,
11099 	    ("%s: Invalid seridx %d for ooa CDB %02x %02x @ %p",
11100 	     __func__, ooa_entry->seridx, ooa_io->scsiio.cdb[0],
11101 	     ooa_io->scsiio.cdb[1], ooa_io));
11102 
11103 	serialize_row = ctl_serialize_table[ooa_entry->seridx];
11104 
11105 	switch (serialize_row[pending_entry->seridx]) {
11106 	case CTL_SER_BLOCK:
11107 		return (CTL_ACTION_BLOCK);
11108 	case CTL_SER_EXTENT:
11109 		return (ctl_extent_check(ooa_io, pending_io,
11110 		    (lun->be_lun && lun->be_lun->serseq == CTL_LUN_SERSEQ_ON)));
11111 	case CTL_SER_EXTENTOPT:
11112 		if ((lun->mode_pages.control_page[CTL_PAGE_CURRENT].queue_flags
11113 		    & SCP_QUEUE_ALG_MASK) != SCP_QUEUE_ALG_UNRESTRICTED)
11114 			return (ctl_extent_check(ooa_io, pending_io,
11115 			    (lun->be_lun &&
11116 			     lun->be_lun->serseq == CTL_LUN_SERSEQ_ON)));
11117 		return (CTL_ACTION_PASS);
11118 	case CTL_SER_EXTENTSEQ:
11119 		if (lun->be_lun && lun->be_lun->serseq != CTL_LUN_SERSEQ_OFF)
11120 			return (ctl_extent_check_seq(ooa_io, pending_io));
11121 		return (CTL_ACTION_PASS);
11122 	case CTL_SER_PASS:
11123 		return (CTL_ACTION_PASS);
11124 	case CTL_SER_BLOCKOPT:
11125 		if ((lun->mode_pages.control_page[CTL_PAGE_CURRENT].queue_flags
11126 		    & SCP_QUEUE_ALG_MASK) != SCP_QUEUE_ALG_UNRESTRICTED)
11127 			return (CTL_ACTION_BLOCK);
11128 		return (CTL_ACTION_PASS);
11129 	case CTL_SER_SKIP:
11130 		return (CTL_ACTION_SKIP);
11131 	default:
11132 		panic("%s: Invalid serialization value %d for %d => %d",
11133 		    __func__, serialize_row[pending_entry->seridx],
11134 		    pending_entry->seridx, ooa_entry->seridx);
11135 	}
11136 
11137 	return (CTL_ACTION_ERROR);
11138 }
11139 
11140 /*
11141  * Check for blockage or overlaps against the OOA (Order Of Arrival) queue.
11142  * Assumptions:
11143  * - pending_io is generally either incoming, or on the blocked queue
11144  * - starting I/O is the I/O we want to start the check with.
11145  */
11146 static ctl_action
11147 ctl_check_ooa(struct ctl_lun *lun, union ctl_io *pending_io,
11148 	      union ctl_io *starting_io)
11149 {
11150 	union ctl_io *ooa_io;
11151 	ctl_action action;
11152 
11153 	mtx_assert(&lun->lun_lock, MA_OWNED);
11154 
11155 	/*
11156 	 * Run back along the OOA queue, starting with the current
11157 	 * blocked I/O and going through every I/O before it on the
11158 	 * queue.  If starting_io is NULL, we'll just end up returning
11159 	 * CTL_ACTION_PASS.
11160 	 */
11161 	for (ooa_io = starting_io; ooa_io != NULL;
11162 	     ooa_io = (union ctl_io *)TAILQ_PREV(&ooa_io->io_hdr, ctl_ooaq,
11163 	     ooa_links)){
11164 
11165 		/*
11166 		 * This routine just checks to see whether
11167 		 * cur_blocked is blocked by ooa_io, which is ahead
11168 		 * of it in the queue.  It doesn't queue/dequeue
11169 		 * cur_blocked.
11170 		 */
11171 		action = ctl_check_for_blockage(lun, pending_io, ooa_io);
11172 		switch (action) {
11173 		case CTL_ACTION_BLOCK:
11174 		case CTL_ACTION_OVERLAP:
11175 		case CTL_ACTION_OVERLAP_TAG:
11176 		case CTL_ACTION_SKIP:
11177 		case CTL_ACTION_ERROR:
11178 			return (action);
11179 			break; /* NOTREACHED */
11180 		case CTL_ACTION_PASS:
11181 			break;
11182 		default:
11183 			panic("%s: Invalid action %d\n", __func__, action);
11184 		}
11185 	}
11186 
11187 	return (CTL_ACTION_PASS);
11188 }
11189 
11190 /*
11191  * Assumptions:
11192  * - An I/O has just completed, and has been removed from the per-LUN OOA
11193  *   queue, so some items on the blocked queue may now be unblocked.
11194  */
11195 static int
11196 ctl_check_blocked(struct ctl_lun *lun)
11197 {
11198 	struct ctl_softc *softc = lun->ctl_softc;
11199 	union ctl_io *cur_blocked, *next_blocked;
11200 
11201 	mtx_assert(&lun->lun_lock, MA_OWNED);
11202 
11203 	/*
11204 	 * Run forward from the head of the blocked queue, checking each
11205 	 * entry against the I/Os prior to it on the OOA queue to see if
11206 	 * there is still any blockage.
11207 	 *
11208 	 * We cannot use the TAILQ_FOREACH() macro, because it can't deal
11209 	 * with our removing a variable on it while it is traversing the
11210 	 * list.
11211 	 */
11212 	for (cur_blocked = (union ctl_io *)TAILQ_FIRST(&lun->blocked_queue);
11213 	     cur_blocked != NULL; cur_blocked = next_blocked) {
11214 		union ctl_io *prev_ooa;
11215 		ctl_action action;
11216 
11217 		next_blocked = (union ctl_io *)TAILQ_NEXT(&cur_blocked->io_hdr,
11218 							  blocked_links);
11219 
11220 		prev_ooa = (union ctl_io *)TAILQ_PREV(&cur_blocked->io_hdr,
11221 						      ctl_ooaq, ooa_links);
11222 
11223 		/*
11224 		 * If cur_blocked happens to be the first item in the OOA
11225 		 * queue now, prev_ooa will be NULL, and the action
11226 		 * returned will just be CTL_ACTION_PASS.
11227 		 */
11228 		action = ctl_check_ooa(lun, cur_blocked, prev_ooa);
11229 
11230 		switch (action) {
11231 		case CTL_ACTION_BLOCK:
11232 			/* Nothing to do here, still blocked */
11233 			break;
11234 		case CTL_ACTION_OVERLAP:
11235 		case CTL_ACTION_OVERLAP_TAG:
11236 			/*
11237 			 * This shouldn't happen!  In theory we've already
11238 			 * checked this command for overlap...
11239 			 */
11240 			break;
11241 		case CTL_ACTION_PASS:
11242 		case CTL_ACTION_SKIP: {
11243 			const struct ctl_cmd_entry *entry;
11244 
11245 			/*
11246 			 * The skip case shouldn't happen, this transaction
11247 			 * should have never made it onto the blocked queue.
11248 			 */
11249 			/*
11250 			 * This I/O is no longer blocked, we can remove it
11251 			 * from the blocked queue.  Since this is a TAILQ
11252 			 * (doubly linked list), we can do O(1) removals
11253 			 * from any place on the list.
11254 			 */
11255 			TAILQ_REMOVE(&lun->blocked_queue, &cur_blocked->io_hdr,
11256 				     blocked_links);
11257 			cur_blocked->io_hdr.flags &= ~CTL_FLAG_BLOCKED;
11258 
11259 			if ((softc->ha_mode != CTL_HA_MODE_XFER) &&
11260 			    (cur_blocked->io_hdr.flags & CTL_FLAG_FROM_OTHER_SC)){
11261 				/*
11262 				 * Need to send IO back to original side to
11263 				 * run
11264 				 */
11265 				union ctl_ha_msg msg_info;
11266 
11267 				cur_blocked->io_hdr.flags &= ~CTL_FLAG_IO_ACTIVE;
11268 				msg_info.hdr.original_sc =
11269 					cur_blocked->io_hdr.original_sc;
11270 				msg_info.hdr.serializing_sc = cur_blocked;
11271 				msg_info.hdr.msg_type = CTL_MSG_R2R;
11272 				ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg_info,
11273 				    sizeof(msg_info.hdr), M_NOWAIT);
11274 				break;
11275 			}
11276 			entry = ctl_get_cmd_entry(&cur_blocked->scsiio, NULL);
11277 
11278 			/*
11279 			 * Check this I/O for LUN state changes that may
11280 			 * have happened while this command was blocked.
11281 			 * The LUN state may have been changed by a command
11282 			 * ahead of us in the queue, so we need to re-check
11283 			 * for any states that can be caused by SCSI
11284 			 * commands.
11285 			 */
11286 			if (ctl_scsiio_lun_check(lun, entry,
11287 						 &cur_blocked->scsiio) == 0) {
11288 				cur_blocked->io_hdr.flags |=
11289 				                      CTL_FLAG_IS_WAS_ON_RTR;
11290 				ctl_enqueue_rtr(cur_blocked);
11291 			} else
11292 				ctl_done(cur_blocked);
11293 			break;
11294 		}
11295 		default:
11296 			/*
11297 			 * This probably shouldn't happen -- we shouldn't
11298 			 * get CTL_ACTION_ERROR, or anything else.
11299 			 */
11300 			break;
11301 		}
11302 	}
11303 
11304 	return (CTL_RETVAL_COMPLETE);
11305 }
11306 
11307 /*
11308  * This routine (with one exception) checks LUN flags that can be set by
11309  * commands ahead of us in the OOA queue.  These flags have to be checked
11310  * when a command initially comes in, and when we pull a command off the
11311  * blocked queue and are preparing to execute it.  The reason we have to
11312  * check these flags for commands on the blocked queue is that the LUN
11313  * state may have been changed by a command ahead of us while we're on the
11314  * blocked queue.
11315  *
11316  * Ordering is somewhat important with these checks, so please pay
11317  * careful attention to the placement of any new checks.
11318  */
11319 static int
11320 ctl_scsiio_lun_check(struct ctl_lun *lun,
11321     const struct ctl_cmd_entry *entry, struct ctl_scsiio *ctsio)
11322 {
11323 	struct ctl_softc *softc = lun->ctl_softc;
11324 	int retval;
11325 	uint32_t residx;
11326 
11327 	retval = 0;
11328 
11329 	mtx_assert(&lun->lun_lock, MA_OWNED);
11330 
11331 	/*
11332 	 * If this shelf is a secondary shelf controller, we may have to
11333 	 * reject some commands disallowed by HA mode and link state.
11334 	 */
11335 	if ((lun->flags & CTL_LUN_PRIMARY_SC) == 0) {
11336 		if (softc->ha_link == CTL_HA_LINK_OFFLINE &&
11337 		    (entry->flags & CTL_CMD_FLAG_OK_ON_UNAVAIL) == 0) {
11338 			ctl_set_lun_unavail(ctsio);
11339 			retval = 1;
11340 			goto bailout;
11341 		}
11342 		if ((lun->flags & CTL_LUN_PEER_SC_PRIMARY) == 0 &&
11343 		    (entry->flags & CTL_CMD_FLAG_OK_ON_UNAVAIL) == 0) {
11344 			ctl_set_lun_transit(ctsio);
11345 			retval = 1;
11346 			goto bailout;
11347 		}
11348 		if (softc->ha_mode == CTL_HA_MODE_ACT_STBY &&
11349 		    (entry->flags & CTL_CMD_FLAG_OK_ON_STANDBY) == 0) {
11350 			ctl_set_lun_standby(ctsio);
11351 			retval = 1;
11352 			goto bailout;
11353 		}
11354 
11355 		/* The rest of checks are only done on executing side */
11356 		if (softc->ha_mode == CTL_HA_MODE_XFER)
11357 			goto bailout;
11358 	}
11359 
11360 	if (entry->pattern & CTL_LUN_PAT_WRITE) {
11361 		if (lun->be_lun &&
11362 		    lun->be_lun->flags & CTL_LUN_FLAG_READONLY) {
11363 			ctl_set_hw_write_protected(ctsio);
11364 			retval = 1;
11365 			goto bailout;
11366 		}
11367 		if ((lun->mode_pages.control_page[CTL_PAGE_CURRENT]
11368 		    .eca_and_aen & SCP_SWP) != 0) {
11369 			ctl_set_sense(ctsio, /*current_error*/ 1,
11370 			    /*sense_key*/ SSD_KEY_DATA_PROTECT,
11371 			    /*asc*/ 0x27, /*ascq*/ 0x02, SSD_ELEM_NONE);
11372 			retval = 1;
11373 			goto bailout;
11374 		}
11375 	}
11376 
11377 	/*
11378 	 * Check for a reservation conflict.  If this command isn't allowed
11379 	 * even on reserved LUNs, and if this initiator isn't the one who
11380 	 * reserved us, reject the command with a reservation conflict.
11381 	 */
11382 	residx = ctl_get_initindex(&ctsio->io_hdr.nexus);
11383 	if ((lun->flags & CTL_LUN_RESERVED)
11384 	 && ((entry->flags & CTL_CMD_FLAG_ALLOW_ON_RESV) == 0)) {
11385 		if (lun->res_idx != residx) {
11386 			ctl_set_reservation_conflict(ctsio);
11387 			retval = 1;
11388 			goto bailout;
11389 		}
11390 	}
11391 
11392 	if ((lun->flags & CTL_LUN_PR_RESERVED) == 0 ||
11393 	    (entry->flags & CTL_CMD_FLAG_ALLOW_ON_PR_RESV)) {
11394 		/* No reservation or command is allowed. */;
11395 	} else if ((entry->flags & CTL_CMD_FLAG_ALLOW_ON_PR_WRESV) &&
11396 	    (lun->pr_res_type == SPR_TYPE_WR_EX ||
11397 	     lun->pr_res_type == SPR_TYPE_WR_EX_RO ||
11398 	     lun->pr_res_type == SPR_TYPE_WR_EX_AR)) {
11399 		/* The command is allowed for Write Exclusive resv. */;
11400 	} else {
11401 		/*
11402 		 * if we aren't registered or it's a res holder type
11403 		 * reservation and this isn't the res holder then set a
11404 		 * conflict.
11405 		 */
11406 		if (ctl_get_prkey(lun, residx) == 0 ||
11407 		    (residx != lun->pr_res_idx && lun->pr_res_type < 4)) {
11408 			ctl_set_reservation_conflict(ctsio);
11409 			retval = 1;
11410 			goto bailout;
11411 		}
11412 	}
11413 
11414 	if ((entry->flags & CTL_CMD_FLAG_OK_ON_NO_MEDIA) == 0) {
11415 		if (lun->flags & CTL_LUN_EJECTED)
11416 			ctl_set_lun_ejected(ctsio);
11417 		else if (lun->flags & CTL_LUN_NO_MEDIA) {
11418 			if (lun->flags & CTL_LUN_REMOVABLE)
11419 				ctl_set_lun_no_media(ctsio);
11420 			else
11421 				ctl_set_lun_int_reqd(ctsio);
11422 		} else if (lun->flags & CTL_LUN_STOPPED)
11423 			ctl_set_lun_stopped(ctsio);
11424 		else
11425 			goto bailout;
11426 		retval = 1;
11427 		goto bailout;
11428 	}
11429 
11430 bailout:
11431 	return (retval);
11432 }
11433 
11434 static void
11435 ctl_failover_io(union ctl_io *io, int have_lock)
11436 {
11437 	ctl_set_busy(&io->scsiio);
11438 	ctl_done(io);
11439 }
11440 
11441 static void
11442 ctl_failover_lun(union ctl_io *rio)
11443 {
11444 	struct ctl_softc *softc = control_softc;
11445 	struct ctl_lun *lun;
11446 	struct ctl_io_hdr *io, *next_io;
11447 	uint32_t targ_lun;
11448 
11449 	targ_lun = rio->io_hdr.nexus.targ_mapped_lun;
11450 	CTL_DEBUG_PRINT(("FAILOVER for lun %ju\n", targ_lun));
11451 
11452 	/* Find and lock the LUN. */
11453 	mtx_lock(&softc->ctl_lock);
11454 	if ((targ_lun < CTL_MAX_LUNS) &&
11455 	    ((lun = softc->ctl_luns[targ_lun]) != NULL)) {
11456 		mtx_lock(&lun->lun_lock);
11457 		mtx_unlock(&softc->ctl_lock);
11458 		if (lun->flags & CTL_LUN_DISABLED) {
11459 			mtx_unlock(&lun->lun_lock);
11460 			return;
11461 		}
11462 	} else {
11463 		mtx_unlock(&softc->ctl_lock);
11464 		return;
11465 	}
11466 
11467 	if (softc->ha_mode == CTL_HA_MODE_XFER) {
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 				if (io->flags & CTL_FLAG_IO_ACTIVE) {
11472 					io->flags |= CTL_FLAG_ABORT;
11473 					io->flags |= CTL_FLAG_FAILOVER;
11474 				} else { /* This can be only due to DATAMOVE */
11475 					io->msg_type = CTL_MSG_DATAMOVE_DONE;
11476 					io->flags &= ~CTL_FLAG_DMA_INPROG;
11477 					io->flags |= CTL_FLAG_IO_ACTIVE;
11478 					io->port_status = 31340;
11479 					ctl_enqueue_isc((union ctl_io *)io);
11480 				}
11481 			}
11482 			/* We are slave */
11483 			if (io->flags & CTL_FLAG_SENT_2OTHER_SC) {
11484 				io->flags &= ~CTL_FLAG_SENT_2OTHER_SC;
11485 				if (io->flags & CTL_FLAG_IO_ACTIVE) {
11486 					io->flags |= CTL_FLAG_FAILOVER;
11487 				} else {
11488 					ctl_set_busy(&((union ctl_io *)io)->
11489 					    scsiio);
11490 					ctl_done((union ctl_io *)io);
11491 				}
11492 			}
11493 		}
11494 	} else { /* SERIALIZE modes */
11495 		TAILQ_FOREACH_SAFE(io, &lun->blocked_queue, blocked_links,
11496 		    next_io) {
11497 			/* We are master */
11498 			if (io->flags & CTL_FLAG_FROM_OTHER_SC) {
11499 				TAILQ_REMOVE(&lun->blocked_queue, io,
11500 				    blocked_links);
11501 				io->flags &= ~CTL_FLAG_BLOCKED;
11502 				TAILQ_REMOVE(&lun->ooa_queue, io, ooa_links);
11503 				ctl_free_io((union ctl_io *)io);
11504 			}
11505 		}
11506 		TAILQ_FOREACH_SAFE(io, &lun->ooa_queue, ooa_links, next_io) {
11507 			/* We are master */
11508 			if (io->flags & CTL_FLAG_FROM_OTHER_SC) {
11509 				TAILQ_REMOVE(&lun->ooa_queue, io, ooa_links);
11510 				ctl_free_io((union ctl_io *)io);
11511 			}
11512 			/* We are slave */
11513 			if (io->flags & CTL_FLAG_SENT_2OTHER_SC) {
11514 				io->flags &= ~CTL_FLAG_SENT_2OTHER_SC;
11515 				if (!(io->flags & CTL_FLAG_IO_ACTIVE)) {
11516 					ctl_set_busy(&((union ctl_io *)io)->
11517 					    scsiio);
11518 					ctl_done((union ctl_io *)io);
11519 				}
11520 			}
11521 		}
11522 		ctl_check_blocked(lun);
11523 	}
11524 	mtx_unlock(&lun->lun_lock);
11525 }
11526 
11527 static int
11528 ctl_scsiio_precheck(struct ctl_softc *softc, struct ctl_scsiio *ctsio)
11529 {
11530 	struct ctl_lun *lun;
11531 	const struct ctl_cmd_entry *entry;
11532 	uint32_t initidx, targ_lun;
11533 	int retval;
11534 
11535 	retval = 0;
11536 
11537 	lun = NULL;
11538 
11539 	targ_lun = ctsio->io_hdr.nexus.targ_mapped_lun;
11540 	if ((targ_lun < CTL_MAX_LUNS)
11541 	 && ((lun = softc->ctl_luns[targ_lun]) != NULL)) {
11542 		/*
11543 		 * If the LUN is invalid, pretend that it doesn't exist.
11544 		 * It will go away as soon as all pending I/O has been
11545 		 * completed.
11546 		 */
11547 		mtx_lock(&lun->lun_lock);
11548 		if (lun->flags & CTL_LUN_DISABLED) {
11549 			mtx_unlock(&lun->lun_lock);
11550 			lun = NULL;
11551 			ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr = NULL;
11552 			ctsio->io_hdr.ctl_private[CTL_PRIV_BACKEND_LUN].ptr = NULL;
11553 		} else {
11554 			ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr = lun;
11555 			ctsio->io_hdr.ctl_private[CTL_PRIV_BACKEND_LUN].ptr =
11556 				lun->be_lun;
11557 
11558 			/*
11559 			 * Every I/O goes into the OOA queue for a
11560 			 * particular LUN, and stays there until completion.
11561 			 */
11562 #ifdef CTL_TIME_IO
11563 			if (TAILQ_EMPTY(&lun->ooa_queue)) {
11564 				lun->idle_time += getsbinuptime() -
11565 				    lun->last_busy;
11566 			}
11567 #endif
11568 			TAILQ_INSERT_TAIL(&lun->ooa_queue, &ctsio->io_hdr,
11569 			    ooa_links);
11570 		}
11571 	} else {
11572 		ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr = NULL;
11573 		ctsio->io_hdr.ctl_private[CTL_PRIV_BACKEND_LUN].ptr = NULL;
11574 	}
11575 
11576 	/* Get command entry and return error if it is unsuppotyed. */
11577 	entry = ctl_validate_command(ctsio);
11578 	if (entry == NULL) {
11579 		if (lun)
11580 			mtx_unlock(&lun->lun_lock);
11581 		return (retval);
11582 	}
11583 
11584 	ctsio->io_hdr.flags &= ~CTL_FLAG_DATA_MASK;
11585 	ctsio->io_hdr.flags |= entry->flags & CTL_FLAG_DATA_MASK;
11586 
11587 	/*
11588 	 * Check to see whether we can send this command to LUNs that don't
11589 	 * exist.  This should pretty much only be the case for inquiry
11590 	 * and request sense.  Further checks, below, really require having
11591 	 * a LUN, so we can't really check the command anymore.  Just put
11592 	 * it on the rtr queue.
11593 	 */
11594 	if (lun == NULL) {
11595 		if (entry->flags & CTL_CMD_FLAG_OK_ON_NO_LUN) {
11596 			ctsio->io_hdr.flags |= CTL_FLAG_IS_WAS_ON_RTR;
11597 			ctl_enqueue_rtr((union ctl_io *)ctsio);
11598 			return (retval);
11599 		}
11600 
11601 		ctl_set_unsupported_lun(ctsio);
11602 		ctl_done((union ctl_io *)ctsio);
11603 		CTL_DEBUG_PRINT(("ctl_scsiio_precheck: bailing out due to invalid LUN\n"));
11604 		return (retval);
11605 	} else {
11606 		/*
11607 		 * Make sure we support this particular command on this LUN.
11608 		 * e.g., we don't support writes to the control LUN.
11609 		 */
11610 		if (!ctl_cmd_applicable(lun->be_lun->lun_type, entry)) {
11611 			mtx_unlock(&lun->lun_lock);
11612 			ctl_set_invalid_opcode(ctsio);
11613 			ctl_done((union ctl_io *)ctsio);
11614 			return (retval);
11615 		}
11616 	}
11617 
11618 	initidx = ctl_get_initindex(&ctsio->io_hdr.nexus);
11619 
11620 #ifdef CTL_WITH_CA
11621 	/*
11622 	 * If we've got a request sense, it'll clear the contingent
11623 	 * allegiance condition.  Otherwise, if we have a CA condition for
11624 	 * this initiator, clear it, because it sent down a command other
11625 	 * than request sense.
11626 	 */
11627 	if ((ctsio->cdb[0] != REQUEST_SENSE)
11628 	 && (ctl_is_set(lun->have_ca, initidx)))
11629 		ctl_clear_mask(lun->have_ca, initidx);
11630 #endif
11631 
11632 	/*
11633 	 * If the command has this flag set, it handles its own unit
11634 	 * attention reporting, we shouldn't do anything.  Otherwise we
11635 	 * check for any pending unit attentions, and send them back to the
11636 	 * initiator.  We only do this when a command initially comes in,
11637 	 * not when we pull it off the blocked queue.
11638 	 *
11639 	 * According to SAM-3, section 5.3.2, the order that things get
11640 	 * presented back to the host is basically unit attentions caused
11641 	 * by some sort of reset event, busy status, reservation conflicts
11642 	 * or task set full, and finally any other status.
11643 	 *
11644 	 * One issue here is that some of the unit attentions we report
11645 	 * don't fall into the "reset" category (e.g. "reported luns data
11646 	 * has changed").  So reporting it here, before the reservation
11647 	 * check, may be technically wrong.  I guess the only thing to do
11648 	 * would be to check for and report the reset events here, and then
11649 	 * check for the other unit attention types after we check for a
11650 	 * reservation conflict.
11651 	 *
11652 	 * XXX KDM need to fix this
11653 	 */
11654 	if ((entry->flags & CTL_CMD_FLAG_NO_SENSE) == 0) {
11655 		ctl_ua_type ua_type;
11656 
11657 		ua_type = ctl_build_ua(lun, initidx, &ctsio->sense_data,
11658 		    SSD_TYPE_NONE);
11659 		if (ua_type != CTL_UA_NONE) {
11660 			mtx_unlock(&lun->lun_lock);
11661 			ctsio->scsi_status = SCSI_STATUS_CHECK_COND;
11662 			ctsio->io_hdr.status = CTL_SCSI_ERROR | CTL_AUTOSENSE;
11663 			ctsio->sense_len = SSD_FULL_SIZE;
11664 			ctl_done((union ctl_io *)ctsio);
11665 			return (retval);
11666 		}
11667 	}
11668 
11669 
11670 	if (ctl_scsiio_lun_check(lun, entry, ctsio) != 0) {
11671 		mtx_unlock(&lun->lun_lock);
11672 		ctl_done((union ctl_io *)ctsio);
11673 		return (retval);
11674 	}
11675 
11676 	/*
11677 	 * XXX CHD this is where we want to send IO to other side if
11678 	 * this LUN is secondary on this SC. We will need to make a copy
11679 	 * of the IO and flag the IO on this side as SENT_2OTHER and the flag
11680 	 * the copy we send as FROM_OTHER.
11681 	 * We also need to stuff the address of the original IO so we can
11682 	 * find it easily. Something similar will need be done on the other
11683 	 * side so when we are done we can find the copy.
11684 	 */
11685 	if ((lun->flags & CTL_LUN_PRIMARY_SC) == 0 &&
11686 	    (lun->flags & CTL_LUN_PEER_SC_PRIMARY) != 0 &&
11687 	    (entry->flags & CTL_CMD_FLAG_RUN_HERE) == 0) {
11688 		union ctl_ha_msg msg_info;
11689 		int isc_retval;
11690 
11691 		ctsio->io_hdr.flags |= CTL_FLAG_SENT_2OTHER_SC;
11692 		ctsio->io_hdr.flags &= ~CTL_FLAG_IO_ACTIVE;
11693 		mtx_unlock(&lun->lun_lock);
11694 
11695 		msg_info.hdr.msg_type = CTL_MSG_SERIALIZE;
11696 		msg_info.hdr.original_sc = (union ctl_io *)ctsio;
11697 		msg_info.hdr.serializing_sc = NULL;
11698 		msg_info.hdr.nexus = ctsio->io_hdr.nexus;
11699 		msg_info.scsi.tag_num = ctsio->tag_num;
11700 		msg_info.scsi.tag_type = ctsio->tag_type;
11701 		msg_info.scsi.cdb_len = ctsio->cdb_len;
11702 		memcpy(msg_info.scsi.cdb, ctsio->cdb, CTL_MAX_CDBLEN);
11703 
11704 		if ((isc_retval = ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg_info,
11705 		    sizeof(msg_info.scsi) - sizeof(msg_info.scsi.sense_data),
11706 		    M_WAITOK)) > CTL_HA_STATUS_SUCCESS) {
11707 			ctl_set_busy(ctsio);
11708 			ctl_done((union ctl_io *)ctsio);
11709 			return (retval);
11710 		}
11711 		return (retval);
11712 	}
11713 
11714 	switch (ctl_check_ooa(lun, (union ctl_io *)ctsio,
11715 			      (union ctl_io *)TAILQ_PREV(&ctsio->io_hdr,
11716 			      ctl_ooaq, ooa_links))) {
11717 	case CTL_ACTION_BLOCK:
11718 		ctsio->io_hdr.flags |= CTL_FLAG_BLOCKED;
11719 		TAILQ_INSERT_TAIL(&lun->blocked_queue, &ctsio->io_hdr,
11720 				  blocked_links);
11721 		mtx_unlock(&lun->lun_lock);
11722 		return (retval);
11723 	case CTL_ACTION_PASS:
11724 	case CTL_ACTION_SKIP:
11725 		ctsio->io_hdr.flags |= CTL_FLAG_IS_WAS_ON_RTR;
11726 		mtx_unlock(&lun->lun_lock);
11727 		ctl_enqueue_rtr((union ctl_io *)ctsio);
11728 		break;
11729 	case CTL_ACTION_OVERLAP:
11730 		mtx_unlock(&lun->lun_lock);
11731 		ctl_set_overlapped_cmd(ctsio);
11732 		ctl_done((union ctl_io *)ctsio);
11733 		break;
11734 	case CTL_ACTION_OVERLAP_TAG:
11735 		mtx_unlock(&lun->lun_lock);
11736 		ctl_set_overlapped_tag(ctsio, ctsio->tag_num & 0xff);
11737 		ctl_done((union ctl_io *)ctsio);
11738 		break;
11739 	case CTL_ACTION_ERROR:
11740 	default:
11741 		mtx_unlock(&lun->lun_lock);
11742 		ctl_set_internal_failure(ctsio,
11743 					 /*sks_valid*/ 0,
11744 					 /*retry_count*/ 0);
11745 		ctl_done((union ctl_io *)ctsio);
11746 		break;
11747 	}
11748 	return (retval);
11749 }
11750 
11751 const struct ctl_cmd_entry *
11752 ctl_get_cmd_entry(struct ctl_scsiio *ctsio, int *sa)
11753 {
11754 	const struct ctl_cmd_entry *entry;
11755 	int service_action;
11756 
11757 	entry = &ctl_cmd_table[ctsio->cdb[0]];
11758 	if (sa)
11759 		*sa = ((entry->flags & CTL_CMD_FLAG_SA5) != 0);
11760 	if (entry->flags & CTL_CMD_FLAG_SA5) {
11761 		service_action = ctsio->cdb[1] & SERVICE_ACTION_MASK;
11762 		entry = &((const struct ctl_cmd_entry *)
11763 		    entry->execute)[service_action];
11764 	}
11765 	return (entry);
11766 }
11767 
11768 const struct ctl_cmd_entry *
11769 ctl_validate_command(struct ctl_scsiio *ctsio)
11770 {
11771 	const struct ctl_cmd_entry *entry;
11772 	int i, sa;
11773 	uint8_t diff;
11774 
11775 	entry = ctl_get_cmd_entry(ctsio, &sa);
11776 	if (entry->execute == NULL) {
11777 		if (sa)
11778 			ctl_set_invalid_field(ctsio,
11779 					      /*sks_valid*/ 1,
11780 					      /*command*/ 1,
11781 					      /*field*/ 1,
11782 					      /*bit_valid*/ 1,
11783 					      /*bit*/ 4);
11784 		else
11785 			ctl_set_invalid_opcode(ctsio);
11786 		ctl_done((union ctl_io *)ctsio);
11787 		return (NULL);
11788 	}
11789 	KASSERT(entry->length > 0,
11790 	    ("Not defined length for command 0x%02x/0x%02x",
11791 	     ctsio->cdb[0], ctsio->cdb[1]));
11792 	for (i = 1; i < entry->length; i++) {
11793 		diff = ctsio->cdb[i] & ~entry->usage[i - 1];
11794 		if (diff == 0)
11795 			continue;
11796 		ctl_set_invalid_field(ctsio,
11797 				      /*sks_valid*/ 1,
11798 				      /*command*/ 1,
11799 				      /*field*/ i,
11800 				      /*bit_valid*/ 1,
11801 				      /*bit*/ fls(diff) - 1);
11802 		ctl_done((union ctl_io *)ctsio);
11803 		return (NULL);
11804 	}
11805 	return (entry);
11806 }
11807 
11808 static int
11809 ctl_cmd_applicable(uint8_t lun_type, const struct ctl_cmd_entry *entry)
11810 {
11811 
11812 	switch (lun_type) {
11813 	case T_DIRECT:
11814 		if ((entry->flags & CTL_CMD_FLAG_OK_ON_DIRECT) == 0)
11815 			return (0);
11816 		break;
11817 	case T_PROCESSOR:
11818 		if ((entry->flags & CTL_CMD_FLAG_OK_ON_PROC) == 0)
11819 			return (0);
11820 		break;
11821 	case T_CDROM:
11822 		if ((entry->flags & CTL_CMD_FLAG_OK_ON_CDROM) == 0)
11823 			return (0);
11824 		break;
11825 	default:
11826 		return (0);
11827 	}
11828 	return (1);
11829 }
11830 
11831 static int
11832 ctl_scsiio(struct ctl_scsiio *ctsio)
11833 {
11834 	int retval;
11835 	const struct ctl_cmd_entry *entry;
11836 
11837 	retval = CTL_RETVAL_COMPLETE;
11838 
11839 	CTL_DEBUG_PRINT(("ctl_scsiio cdb[0]=%02X\n", ctsio->cdb[0]));
11840 
11841 	entry = ctl_get_cmd_entry(ctsio, NULL);
11842 
11843 	/*
11844 	 * If this I/O has been aborted, just send it straight to
11845 	 * ctl_done() without executing it.
11846 	 */
11847 	if (ctsio->io_hdr.flags & CTL_FLAG_ABORT) {
11848 		ctl_done((union ctl_io *)ctsio);
11849 		goto bailout;
11850 	}
11851 
11852 	/*
11853 	 * All the checks should have been handled by ctl_scsiio_precheck().
11854 	 * We should be clear now to just execute the I/O.
11855 	 */
11856 	retval = entry->execute(ctsio);
11857 
11858 bailout:
11859 	return (retval);
11860 }
11861 
11862 /*
11863  * Since we only implement one target right now, a bus reset simply resets
11864  * our single target.
11865  */
11866 static int
11867 ctl_bus_reset(struct ctl_softc *softc, union ctl_io *io)
11868 {
11869 	return(ctl_target_reset(softc, io, CTL_UA_BUS_RESET));
11870 }
11871 
11872 static int
11873 ctl_target_reset(struct ctl_softc *softc, union ctl_io *io,
11874 		 ctl_ua_type ua_type)
11875 {
11876 	struct ctl_port *port;
11877 	struct ctl_lun *lun;
11878 	int retval;
11879 
11880 	if (!(io->io_hdr.flags & CTL_FLAG_FROM_OTHER_SC)) {
11881 		union ctl_ha_msg msg_info;
11882 
11883 		msg_info.hdr.nexus = io->io_hdr.nexus;
11884 		if (ua_type==CTL_UA_TARG_RESET)
11885 			msg_info.task.task_action = CTL_TASK_TARGET_RESET;
11886 		else
11887 			msg_info.task.task_action = CTL_TASK_BUS_RESET;
11888 		msg_info.hdr.msg_type = CTL_MSG_MANAGE_TASKS;
11889 		msg_info.hdr.original_sc = NULL;
11890 		msg_info.hdr.serializing_sc = NULL;
11891 		ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg_info,
11892 		    sizeof(msg_info.task), M_WAITOK);
11893 	}
11894 	retval = 0;
11895 
11896 	mtx_lock(&softc->ctl_lock);
11897 	port = ctl_io_port(&io->io_hdr);
11898 	STAILQ_FOREACH(lun, &softc->lun_list, links) {
11899 		if (port != NULL &&
11900 		    ctl_lun_map_to_port(port, lun->lun) >= CTL_MAX_LUNS)
11901 			continue;
11902 		retval += ctl_do_lun_reset(lun, io, ua_type);
11903 	}
11904 	mtx_unlock(&softc->ctl_lock);
11905 	io->taskio.task_status = CTL_TASK_FUNCTION_COMPLETE;
11906 	return (retval);
11907 }
11908 
11909 /*
11910  * The LUN should always be set.  The I/O is optional, and is used to
11911  * distinguish between I/Os sent by this initiator, and by other
11912  * initiators.  We set unit attention for initiators other than this one.
11913  * SAM-3 is vague on this point.  It does say that a unit attention should
11914  * be established for other initiators when a LUN is reset (see section
11915  * 5.7.3), but it doesn't specifically say that the unit attention should
11916  * be established for this particular initiator when a LUN is reset.  Here
11917  * is the relevant text, from SAM-3 rev 8:
11918  *
11919  * 5.7.2 When a SCSI initiator port aborts its own tasks
11920  *
11921  * When a SCSI initiator port causes its own task(s) to be aborted, no
11922  * notification that the task(s) have been aborted shall be returned to
11923  * the SCSI initiator port other than the completion response for the
11924  * command or task management function action that caused the task(s) to
11925  * be aborted and notification(s) associated with related effects of the
11926  * action (e.g., a reset unit attention condition).
11927  *
11928  * XXX KDM for now, we're setting unit attention for all initiators.
11929  */
11930 static int
11931 ctl_do_lun_reset(struct ctl_lun *lun, union ctl_io *io, ctl_ua_type ua_type)
11932 {
11933 	union ctl_io *xio;
11934 #if 0
11935 	uint32_t initidx;
11936 #endif
11937 	int i;
11938 
11939 	mtx_lock(&lun->lun_lock);
11940 	/*
11941 	 * Run through the OOA queue and abort each I/O.
11942 	 */
11943 	for (xio = (union ctl_io *)TAILQ_FIRST(&lun->ooa_queue); xio != NULL;
11944 	     xio = (union ctl_io *)TAILQ_NEXT(&xio->io_hdr, ooa_links)) {
11945 		xio->io_hdr.flags |= CTL_FLAG_ABORT | CTL_FLAG_ABORT_STATUS;
11946 	}
11947 
11948 	/*
11949 	 * This version sets unit attention for every
11950 	 */
11951 #if 0
11952 	initidx = ctl_get_initindex(&io->io_hdr.nexus);
11953 	ctl_est_ua_all(lun, initidx, ua_type);
11954 #else
11955 	ctl_est_ua_all(lun, -1, ua_type);
11956 #endif
11957 
11958 	/*
11959 	 * A reset (any kind, really) clears reservations established with
11960 	 * RESERVE/RELEASE.  It does not clear reservations established
11961 	 * with PERSISTENT RESERVE OUT, but we don't support that at the
11962 	 * moment anyway.  See SPC-2, section 5.6.  SPC-3 doesn't address
11963 	 * reservations made with the RESERVE/RELEASE commands, because
11964 	 * those commands are obsolete in SPC-3.
11965 	 */
11966 	lun->flags &= ~CTL_LUN_RESERVED;
11967 
11968 #ifdef CTL_WITH_CA
11969 	for (i = 0; i < CTL_MAX_INITIATORS; i++)
11970 		ctl_clear_mask(lun->have_ca, i);
11971 #endif
11972 	lun->prevent_count = 0;
11973 	for (i = 0; i < CTL_MAX_INITIATORS; i++)
11974 		ctl_clear_mask(lun->prevent, i);
11975 	mtx_unlock(&lun->lun_lock);
11976 
11977 	return (0);
11978 }
11979 
11980 static int
11981 ctl_lun_reset(struct ctl_softc *softc, union ctl_io *io)
11982 {
11983 	struct ctl_lun *lun;
11984 	uint32_t targ_lun;
11985 	int retval;
11986 
11987 	targ_lun = io->io_hdr.nexus.targ_mapped_lun;
11988 	mtx_lock(&softc->ctl_lock);
11989 	if ((targ_lun >= CTL_MAX_LUNS) ||
11990 	    (lun = softc->ctl_luns[targ_lun]) == NULL) {
11991 		mtx_unlock(&softc->ctl_lock);
11992 		io->taskio.task_status = CTL_TASK_LUN_DOES_NOT_EXIST;
11993 		return (1);
11994 	}
11995 	retval = ctl_do_lun_reset(lun, io, CTL_UA_LUN_RESET);
11996 	mtx_unlock(&softc->ctl_lock);
11997 	io->taskio.task_status = CTL_TASK_FUNCTION_COMPLETE;
11998 
11999 	if ((io->io_hdr.flags & CTL_FLAG_FROM_OTHER_SC) == 0) {
12000 		union ctl_ha_msg msg_info;
12001 
12002 		msg_info.hdr.msg_type = CTL_MSG_MANAGE_TASKS;
12003 		msg_info.hdr.nexus = io->io_hdr.nexus;
12004 		msg_info.task.task_action = CTL_TASK_LUN_RESET;
12005 		msg_info.hdr.original_sc = NULL;
12006 		msg_info.hdr.serializing_sc = NULL;
12007 		ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg_info,
12008 		    sizeof(msg_info.task), M_WAITOK);
12009 	}
12010 	return (retval);
12011 }
12012 
12013 static void
12014 ctl_abort_tasks_lun(struct ctl_lun *lun, uint32_t targ_port, uint32_t init_id,
12015     int other_sc)
12016 {
12017 	union ctl_io *xio;
12018 
12019 	mtx_assert(&lun->lun_lock, MA_OWNED);
12020 
12021 	/*
12022 	 * Run through the OOA queue and attempt to find the given I/O.
12023 	 * The target port, initiator ID, tag type and tag number have to
12024 	 * match the values that we got from the initiator.  If we have an
12025 	 * untagged command to abort, simply abort the first untagged command
12026 	 * we come to.  We only allow one untagged command at a time of course.
12027 	 */
12028 	for (xio = (union ctl_io *)TAILQ_FIRST(&lun->ooa_queue); xio != NULL;
12029 	     xio = (union ctl_io *)TAILQ_NEXT(&xio->io_hdr, ooa_links)) {
12030 
12031 		if ((targ_port == UINT32_MAX ||
12032 		     targ_port == xio->io_hdr.nexus.targ_port) &&
12033 		    (init_id == UINT32_MAX ||
12034 		     init_id == xio->io_hdr.nexus.initid)) {
12035 			if (targ_port != xio->io_hdr.nexus.targ_port ||
12036 			    init_id != xio->io_hdr.nexus.initid)
12037 				xio->io_hdr.flags |= CTL_FLAG_ABORT_STATUS;
12038 			xio->io_hdr.flags |= CTL_FLAG_ABORT;
12039 			if (!other_sc && !(lun->flags & CTL_LUN_PRIMARY_SC)) {
12040 				union ctl_ha_msg msg_info;
12041 
12042 				msg_info.hdr.nexus = xio->io_hdr.nexus;
12043 				msg_info.task.task_action = CTL_TASK_ABORT_TASK;
12044 				msg_info.task.tag_num = xio->scsiio.tag_num;
12045 				msg_info.task.tag_type = xio->scsiio.tag_type;
12046 				msg_info.hdr.msg_type = CTL_MSG_MANAGE_TASKS;
12047 				msg_info.hdr.original_sc = NULL;
12048 				msg_info.hdr.serializing_sc = NULL;
12049 				ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg_info,
12050 				    sizeof(msg_info.task), M_NOWAIT);
12051 			}
12052 		}
12053 	}
12054 }
12055 
12056 static int
12057 ctl_abort_task_set(union ctl_io *io)
12058 {
12059 	struct ctl_softc *softc = control_softc;
12060 	struct ctl_lun *lun;
12061 	uint32_t targ_lun;
12062 
12063 	/*
12064 	 * Look up the LUN.
12065 	 */
12066 	targ_lun = io->io_hdr.nexus.targ_mapped_lun;
12067 	mtx_lock(&softc->ctl_lock);
12068 	if ((targ_lun >= CTL_MAX_LUNS) ||
12069 	    (lun = softc->ctl_luns[targ_lun]) == NULL) {
12070 		mtx_unlock(&softc->ctl_lock);
12071 		io->taskio.task_status = CTL_TASK_LUN_DOES_NOT_EXIST;
12072 		return (1);
12073 	}
12074 
12075 	mtx_lock(&lun->lun_lock);
12076 	mtx_unlock(&softc->ctl_lock);
12077 	if (io->taskio.task_action == CTL_TASK_ABORT_TASK_SET) {
12078 		ctl_abort_tasks_lun(lun, io->io_hdr.nexus.targ_port,
12079 		    io->io_hdr.nexus.initid,
12080 		    (io->io_hdr.flags & CTL_FLAG_FROM_OTHER_SC) != 0);
12081 	} else { /* CTL_TASK_CLEAR_TASK_SET */
12082 		ctl_abort_tasks_lun(lun, UINT32_MAX, UINT32_MAX,
12083 		    (io->io_hdr.flags & CTL_FLAG_FROM_OTHER_SC) != 0);
12084 	}
12085 	mtx_unlock(&lun->lun_lock);
12086 	io->taskio.task_status = CTL_TASK_FUNCTION_COMPLETE;
12087 	return (0);
12088 }
12089 
12090 static int
12091 ctl_i_t_nexus_reset(union ctl_io *io)
12092 {
12093 	struct ctl_softc *softc = control_softc;
12094 	struct ctl_lun *lun;
12095 	uint32_t initidx;
12096 
12097 	if (!(io->io_hdr.flags & CTL_FLAG_FROM_OTHER_SC)) {
12098 		union ctl_ha_msg msg_info;
12099 
12100 		msg_info.hdr.nexus = io->io_hdr.nexus;
12101 		msg_info.task.task_action = CTL_TASK_I_T_NEXUS_RESET;
12102 		msg_info.hdr.msg_type = CTL_MSG_MANAGE_TASKS;
12103 		msg_info.hdr.original_sc = NULL;
12104 		msg_info.hdr.serializing_sc = NULL;
12105 		ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg_info,
12106 		    sizeof(msg_info.task), M_WAITOK);
12107 	}
12108 
12109 	initidx = ctl_get_initindex(&io->io_hdr.nexus);
12110 	mtx_lock(&softc->ctl_lock);
12111 	STAILQ_FOREACH(lun, &softc->lun_list, links) {
12112 		mtx_lock(&lun->lun_lock);
12113 		ctl_abort_tasks_lun(lun, io->io_hdr.nexus.targ_port,
12114 		    io->io_hdr.nexus.initid, 1);
12115 #ifdef CTL_WITH_CA
12116 		ctl_clear_mask(lun->have_ca, initidx);
12117 #endif
12118 		if ((lun->flags & CTL_LUN_RESERVED) && (lun->res_idx == initidx))
12119 			lun->flags &= ~CTL_LUN_RESERVED;
12120 		if (ctl_is_set(lun->prevent, initidx)) {
12121 			ctl_clear_mask(lun->prevent, initidx);
12122 			lun->prevent_count--;
12123 		}
12124 		ctl_est_ua(lun, initidx, CTL_UA_I_T_NEXUS_LOSS);
12125 		mtx_unlock(&lun->lun_lock);
12126 	}
12127 	mtx_unlock(&softc->ctl_lock);
12128 	io->taskio.task_status = CTL_TASK_FUNCTION_COMPLETE;
12129 	return (0);
12130 }
12131 
12132 static int
12133 ctl_abort_task(union ctl_io *io)
12134 {
12135 	union ctl_io *xio;
12136 	struct ctl_lun *lun;
12137 	struct ctl_softc *softc;
12138 #if 0
12139 	struct sbuf sb;
12140 	char printbuf[128];
12141 #endif
12142 	int found;
12143 	uint32_t targ_lun;
12144 
12145 	softc = control_softc;
12146 	found = 0;
12147 
12148 	/*
12149 	 * Look up the LUN.
12150 	 */
12151 	targ_lun = io->io_hdr.nexus.targ_mapped_lun;
12152 	mtx_lock(&softc->ctl_lock);
12153 	if ((targ_lun >= CTL_MAX_LUNS) ||
12154 	    (lun = softc->ctl_luns[targ_lun]) == NULL) {
12155 		mtx_unlock(&softc->ctl_lock);
12156 		io->taskio.task_status = CTL_TASK_LUN_DOES_NOT_EXIST;
12157 		return (1);
12158 	}
12159 
12160 #if 0
12161 	printf("ctl_abort_task: called for lun %lld, tag %d type %d\n",
12162 	       lun->lun, io->taskio.tag_num, io->taskio.tag_type);
12163 #endif
12164 
12165 	mtx_lock(&lun->lun_lock);
12166 	mtx_unlock(&softc->ctl_lock);
12167 	/*
12168 	 * Run through the OOA queue and attempt to find the given I/O.
12169 	 * The target port, initiator ID, tag type and tag number have to
12170 	 * match the values that we got from the initiator.  If we have an
12171 	 * untagged command to abort, simply abort the first untagged command
12172 	 * we come to.  We only allow one untagged command at a time of course.
12173 	 */
12174 	for (xio = (union ctl_io *)TAILQ_FIRST(&lun->ooa_queue); xio != NULL;
12175 	     xio = (union ctl_io *)TAILQ_NEXT(&xio->io_hdr, ooa_links)) {
12176 #if 0
12177 		sbuf_new(&sb, printbuf, sizeof(printbuf), SBUF_FIXEDLEN);
12178 
12179 		sbuf_printf(&sb, "LUN %lld tag %d type %d%s%s%s%s: ",
12180 			    lun->lun, xio->scsiio.tag_num,
12181 			    xio->scsiio.tag_type,
12182 			    (xio->io_hdr.blocked_links.tqe_prev
12183 			    == NULL) ? "" : " BLOCKED",
12184 			    (xio->io_hdr.flags &
12185 			    CTL_FLAG_DMA_INPROG) ? " DMA" : "",
12186 			    (xio->io_hdr.flags &
12187 			    CTL_FLAG_ABORT) ? " ABORT" : "",
12188 			    (xio->io_hdr.flags &
12189 			    CTL_FLAG_IS_WAS_ON_RTR ? " RTR" : ""));
12190 		ctl_scsi_command_string(&xio->scsiio, NULL, &sb);
12191 		sbuf_finish(&sb);
12192 		printf("%s\n", sbuf_data(&sb));
12193 #endif
12194 
12195 		if ((xio->io_hdr.nexus.targ_port != io->io_hdr.nexus.targ_port)
12196 		 || (xio->io_hdr.nexus.initid != io->io_hdr.nexus.initid)
12197 		 || (xio->io_hdr.flags & CTL_FLAG_ABORT))
12198 			continue;
12199 
12200 		/*
12201 		 * If the abort says that the task is untagged, the
12202 		 * task in the queue must be untagged.  Otherwise,
12203 		 * we just check to see whether the tag numbers
12204 		 * match.  This is because the QLogic firmware
12205 		 * doesn't pass back the tag type in an abort
12206 		 * request.
12207 		 */
12208 #if 0
12209 		if (((xio->scsiio.tag_type == CTL_TAG_UNTAGGED)
12210 		  && (io->taskio.tag_type == CTL_TAG_UNTAGGED))
12211 		 || (xio->scsiio.tag_num == io->taskio.tag_num))
12212 #endif
12213 		/*
12214 		 * XXX KDM we've got problems with FC, because it
12215 		 * doesn't send down a tag type with aborts.  So we
12216 		 * can only really go by the tag number...
12217 		 * This may cause problems with parallel SCSI.
12218 		 * Need to figure that out!!
12219 		 */
12220 		if (xio->scsiio.tag_num == io->taskio.tag_num) {
12221 			xio->io_hdr.flags |= CTL_FLAG_ABORT;
12222 			found = 1;
12223 			if ((io->io_hdr.flags & CTL_FLAG_FROM_OTHER_SC) == 0 &&
12224 			    !(lun->flags & CTL_LUN_PRIMARY_SC)) {
12225 				union ctl_ha_msg msg_info;
12226 
12227 				msg_info.hdr.nexus = io->io_hdr.nexus;
12228 				msg_info.task.task_action = CTL_TASK_ABORT_TASK;
12229 				msg_info.task.tag_num = io->taskio.tag_num;
12230 				msg_info.task.tag_type = io->taskio.tag_type;
12231 				msg_info.hdr.msg_type = CTL_MSG_MANAGE_TASKS;
12232 				msg_info.hdr.original_sc = NULL;
12233 				msg_info.hdr.serializing_sc = NULL;
12234 #if 0
12235 				printf("Sent Abort to other side\n");
12236 #endif
12237 				ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg_info,
12238 				    sizeof(msg_info.task), M_NOWAIT);
12239 			}
12240 #if 0
12241 			printf("ctl_abort_task: found I/O to abort\n");
12242 #endif
12243 		}
12244 	}
12245 	mtx_unlock(&lun->lun_lock);
12246 
12247 	if (found == 0) {
12248 		/*
12249 		 * This isn't really an error.  It's entirely possible for
12250 		 * the abort and command completion to cross on the wire.
12251 		 * This is more of an informative/diagnostic error.
12252 		 */
12253 #if 0
12254 		printf("ctl_abort_task: ABORT sent for nonexistent I/O: "
12255 		       "%u:%u:%u tag %d type %d\n",
12256 		       io->io_hdr.nexus.initid,
12257 		       io->io_hdr.nexus.targ_port,
12258 		       io->io_hdr.nexus.targ_lun, io->taskio.tag_num,
12259 		       io->taskio.tag_type);
12260 #endif
12261 	}
12262 	io->taskio.task_status = CTL_TASK_FUNCTION_COMPLETE;
12263 	return (0);
12264 }
12265 
12266 static int
12267 ctl_query_task(union ctl_io *io, int task_set)
12268 {
12269 	union ctl_io *xio;
12270 	struct ctl_lun *lun;
12271 	struct ctl_softc *softc;
12272 	int found = 0;
12273 	uint32_t targ_lun;
12274 
12275 	softc = control_softc;
12276 	targ_lun = io->io_hdr.nexus.targ_mapped_lun;
12277 	mtx_lock(&softc->ctl_lock);
12278 	if ((targ_lun >= CTL_MAX_LUNS) ||
12279 	    (lun = softc->ctl_luns[targ_lun]) == NULL) {
12280 		mtx_unlock(&softc->ctl_lock);
12281 		io->taskio.task_status = CTL_TASK_LUN_DOES_NOT_EXIST;
12282 		return (1);
12283 	}
12284 	mtx_lock(&lun->lun_lock);
12285 	mtx_unlock(&softc->ctl_lock);
12286 	for (xio = (union ctl_io *)TAILQ_FIRST(&lun->ooa_queue); xio != NULL;
12287 	     xio = (union ctl_io *)TAILQ_NEXT(&xio->io_hdr, ooa_links)) {
12288 
12289 		if ((xio->io_hdr.nexus.targ_port != io->io_hdr.nexus.targ_port)
12290 		 || (xio->io_hdr.nexus.initid != io->io_hdr.nexus.initid)
12291 		 || (xio->io_hdr.flags & CTL_FLAG_ABORT))
12292 			continue;
12293 
12294 		if (task_set || xio->scsiio.tag_num == io->taskio.tag_num) {
12295 			found = 1;
12296 			break;
12297 		}
12298 	}
12299 	mtx_unlock(&lun->lun_lock);
12300 	if (found)
12301 		io->taskio.task_status = CTL_TASK_FUNCTION_SUCCEEDED;
12302 	else
12303 		io->taskio.task_status = CTL_TASK_FUNCTION_COMPLETE;
12304 	return (0);
12305 }
12306 
12307 static int
12308 ctl_query_async_event(union ctl_io *io)
12309 {
12310 	struct ctl_lun *lun;
12311 	struct ctl_softc *softc;
12312 	ctl_ua_type ua;
12313 	uint32_t targ_lun, initidx;
12314 
12315 	softc = control_softc;
12316 	targ_lun = io->io_hdr.nexus.targ_mapped_lun;
12317 	mtx_lock(&softc->ctl_lock);
12318 	if ((targ_lun >= CTL_MAX_LUNS) ||
12319 	    (lun = softc->ctl_luns[targ_lun]) == NULL) {
12320 		mtx_unlock(&softc->ctl_lock);
12321 		io->taskio.task_status = CTL_TASK_LUN_DOES_NOT_EXIST;
12322 		return (1);
12323 	}
12324 	mtx_lock(&lun->lun_lock);
12325 	mtx_unlock(&softc->ctl_lock);
12326 	initidx = ctl_get_initindex(&io->io_hdr.nexus);
12327 	ua = ctl_build_qae(lun, initidx, io->taskio.task_resp);
12328 	mtx_unlock(&lun->lun_lock);
12329 	if (ua != CTL_UA_NONE)
12330 		io->taskio.task_status = CTL_TASK_FUNCTION_SUCCEEDED;
12331 	else
12332 		io->taskio.task_status = CTL_TASK_FUNCTION_COMPLETE;
12333 	return (0);
12334 }
12335 
12336 static void
12337 ctl_run_task(union ctl_io *io)
12338 {
12339 	struct ctl_softc *softc = control_softc;
12340 	int retval = 1;
12341 
12342 	CTL_DEBUG_PRINT(("ctl_run_task\n"));
12343 	KASSERT(io->io_hdr.io_type == CTL_IO_TASK,
12344 	    ("ctl_run_task: Unextected io_type %d\n", io->io_hdr.io_type));
12345 	io->taskio.task_status = CTL_TASK_FUNCTION_NOT_SUPPORTED;
12346 	bzero(io->taskio.task_resp, sizeof(io->taskio.task_resp));
12347 	switch (io->taskio.task_action) {
12348 	case CTL_TASK_ABORT_TASK:
12349 		retval = ctl_abort_task(io);
12350 		break;
12351 	case CTL_TASK_ABORT_TASK_SET:
12352 	case CTL_TASK_CLEAR_TASK_SET:
12353 		retval = ctl_abort_task_set(io);
12354 		break;
12355 	case CTL_TASK_CLEAR_ACA:
12356 		break;
12357 	case CTL_TASK_I_T_NEXUS_RESET:
12358 		retval = ctl_i_t_nexus_reset(io);
12359 		break;
12360 	case CTL_TASK_LUN_RESET:
12361 		retval = ctl_lun_reset(softc, io);
12362 		break;
12363 	case CTL_TASK_TARGET_RESET:
12364 		retval = ctl_target_reset(softc, io, CTL_UA_TARG_RESET);
12365 		break;
12366 	case CTL_TASK_BUS_RESET:
12367 		retval = ctl_bus_reset(softc, io);
12368 		break;
12369 	case CTL_TASK_PORT_LOGIN:
12370 		break;
12371 	case CTL_TASK_PORT_LOGOUT:
12372 		break;
12373 	case CTL_TASK_QUERY_TASK:
12374 		retval = ctl_query_task(io, 0);
12375 		break;
12376 	case CTL_TASK_QUERY_TASK_SET:
12377 		retval = ctl_query_task(io, 1);
12378 		break;
12379 	case CTL_TASK_QUERY_ASYNC_EVENT:
12380 		retval = ctl_query_async_event(io);
12381 		break;
12382 	default:
12383 		printf("%s: got unknown task management event %d\n",
12384 		       __func__, io->taskio.task_action);
12385 		break;
12386 	}
12387 	if (retval == 0)
12388 		io->io_hdr.status = CTL_SUCCESS;
12389 	else
12390 		io->io_hdr.status = CTL_ERROR;
12391 	ctl_done(io);
12392 }
12393 
12394 /*
12395  * For HA operation.  Handle commands that come in from the other
12396  * controller.
12397  */
12398 static void
12399 ctl_handle_isc(union ctl_io *io)
12400 {
12401 	int free_io;
12402 	struct ctl_lun *lun;
12403 	struct ctl_softc *softc = control_softc;
12404 	uint32_t targ_lun;
12405 
12406 	targ_lun = io->io_hdr.nexus.targ_mapped_lun;
12407 	lun = softc->ctl_luns[targ_lun];
12408 
12409 	switch (io->io_hdr.msg_type) {
12410 	case CTL_MSG_SERIALIZE:
12411 		free_io = ctl_serialize_other_sc_cmd(&io->scsiio);
12412 		break;
12413 	case CTL_MSG_R2R: {
12414 		const struct ctl_cmd_entry *entry;
12415 
12416 		/*
12417 		 * This is only used in SER_ONLY mode.
12418 		 */
12419 		free_io = 0;
12420 		entry = ctl_get_cmd_entry(&io->scsiio, NULL);
12421 		mtx_lock(&lun->lun_lock);
12422 		if (ctl_scsiio_lun_check(lun,
12423 		    entry, (struct ctl_scsiio *)io) != 0) {
12424 			mtx_unlock(&lun->lun_lock);
12425 			ctl_done(io);
12426 			break;
12427 		}
12428 		io->io_hdr.flags |= CTL_FLAG_IS_WAS_ON_RTR;
12429 		mtx_unlock(&lun->lun_lock);
12430 		ctl_enqueue_rtr(io);
12431 		break;
12432 	}
12433 	case CTL_MSG_FINISH_IO:
12434 		if (softc->ha_mode == CTL_HA_MODE_XFER) {
12435 			free_io = 0;
12436 			ctl_done(io);
12437 		} else {
12438 			free_io = 1;
12439 			mtx_lock(&lun->lun_lock);
12440 			TAILQ_REMOVE(&lun->ooa_queue, &io->io_hdr,
12441 				     ooa_links);
12442 			ctl_check_blocked(lun);
12443 			mtx_unlock(&lun->lun_lock);
12444 		}
12445 		break;
12446 	case CTL_MSG_PERS_ACTION:
12447 		ctl_hndl_per_res_out_on_other_sc(
12448 			(union ctl_ha_msg *)&io->presio.pr_msg);
12449 		free_io = 1;
12450 		break;
12451 	case CTL_MSG_BAD_JUJU:
12452 		free_io = 0;
12453 		ctl_done(io);
12454 		break;
12455 	case CTL_MSG_DATAMOVE:
12456 		/* Only used in XFER mode */
12457 		free_io = 0;
12458 		ctl_datamove_remote(io);
12459 		break;
12460 	case CTL_MSG_DATAMOVE_DONE:
12461 		/* Only used in XFER mode */
12462 		free_io = 0;
12463 		io->scsiio.be_move_done(io);
12464 		break;
12465 	case CTL_MSG_FAILOVER:
12466 		ctl_failover_lun(io);
12467 		free_io = 1;
12468 		break;
12469 	default:
12470 		free_io = 1;
12471 		printf("%s: Invalid message type %d\n",
12472 		       __func__, io->io_hdr.msg_type);
12473 		break;
12474 	}
12475 	if (free_io)
12476 		ctl_free_io(io);
12477 
12478 }
12479 
12480 
12481 /*
12482  * Returns the match type in the case of a match, or CTL_LUN_PAT_NONE if
12483  * there is no match.
12484  */
12485 static ctl_lun_error_pattern
12486 ctl_cmd_pattern_match(struct ctl_scsiio *ctsio, struct ctl_error_desc *desc)
12487 {
12488 	const struct ctl_cmd_entry *entry;
12489 	ctl_lun_error_pattern filtered_pattern, pattern;
12490 
12491 	pattern = desc->error_pattern;
12492 
12493 	/*
12494 	 * XXX KDM we need more data passed into this function to match a
12495 	 * custom pattern, and we actually need to implement custom pattern
12496 	 * matching.
12497 	 */
12498 	if (pattern & CTL_LUN_PAT_CMD)
12499 		return (CTL_LUN_PAT_CMD);
12500 
12501 	if ((pattern & CTL_LUN_PAT_MASK) == CTL_LUN_PAT_ANY)
12502 		return (CTL_LUN_PAT_ANY);
12503 
12504 	entry = ctl_get_cmd_entry(ctsio, NULL);
12505 
12506 	filtered_pattern = entry->pattern & pattern;
12507 
12508 	/*
12509 	 * If the user requested specific flags in the pattern (e.g.
12510 	 * CTL_LUN_PAT_RANGE), make sure the command supports all of those
12511 	 * flags.
12512 	 *
12513 	 * If the user did not specify any flags, it doesn't matter whether
12514 	 * or not the command supports the flags.
12515 	 */
12516 	if ((filtered_pattern & ~CTL_LUN_PAT_MASK) !=
12517 	     (pattern & ~CTL_LUN_PAT_MASK))
12518 		return (CTL_LUN_PAT_NONE);
12519 
12520 	/*
12521 	 * If the user asked for a range check, see if the requested LBA
12522 	 * range overlaps with this command's LBA range.
12523 	 */
12524 	if (filtered_pattern & CTL_LUN_PAT_RANGE) {
12525 		uint64_t lba1;
12526 		uint64_t len1;
12527 		ctl_action action;
12528 		int retval;
12529 
12530 		retval = ctl_get_lba_len((union ctl_io *)ctsio, &lba1, &len1);
12531 		if (retval != 0)
12532 			return (CTL_LUN_PAT_NONE);
12533 
12534 		action = ctl_extent_check_lba(lba1, len1, desc->lba_range.lba,
12535 					      desc->lba_range.len, FALSE);
12536 		/*
12537 		 * A "pass" means that the LBA ranges don't overlap, so
12538 		 * this doesn't match the user's range criteria.
12539 		 */
12540 		if (action == CTL_ACTION_PASS)
12541 			return (CTL_LUN_PAT_NONE);
12542 	}
12543 
12544 	return (filtered_pattern);
12545 }
12546 
12547 static void
12548 ctl_inject_error(struct ctl_lun *lun, union ctl_io *io)
12549 {
12550 	struct ctl_error_desc *desc, *desc2;
12551 
12552 	mtx_assert(&lun->lun_lock, MA_OWNED);
12553 
12554 	STAILQ_FOREACH_SAFE(desc, &lun->error_list, links, desc2) {
12555 		ctl_lun_error_pattern pattern;
12556 		/*
12557 		 * Check to see whether this particular command matches
12558 		 * the pattern in the descriptor.
12559 		 */
12560 		pattern = ctl_cmd_pattern_match(&io->scsiio, desc);
12561 		if ((pattern & CTL_LUN_PAT_MASK) == CTL_LUN_PAT_NONE)
12562 			continue;
12563 
12564 		switch (desc->lun_error & CTL_LUN_INJ_TYPE) {
12565 		case CTL_LUN_INJ_ABORTED:
12566 			ctl_set_aborted(&io->scsiio);
12567 			break;
12568 		case CTL_LUN_INJ_MEDIUM_ERR:
12569 			ctl_set_medium_error(&io->scsiio,
12570 			    (io->io_hdr.flags & CTL_FLAG_DATA_MASK) !=
12571 			     CTL_FLAG_DATA_OUT);
12572 			break;
12573 		case CTL_LUN_INJ_UA:
12574 			/* 29h/00h  POWER ON, RESET, OR BUS DEVICE RESET
12575 			 * OCCURRED */
12576 			ctl_set_ua(&io->scsiio, 0x29, 0x00);
12577 			break;
12578 		case CTL_LUN_INJ_CUSTOM:
12579 			/*
12580 			 * We're assuming the user knows what he is doing.
12581 			 * Just copy the sense information without doing
12582 			 * checks.
12583 			 */
12584 			bcopy(&desc->custom_sense, &io->scsiio.sense_data,
12585 			      MIN(sizeof(desc->custom_sense),
12586 				  sizeof(io->scsiio.sense_data)));
12587 			io->scsiio.scsi_status = SCSI_STATUS_CHECK_COND;
12588 			io->scsiio.sense_len = SSD_FULL_SIZE;
12589 			io->io_hdr.status = CTL_SCSI_ERROR | CTL_AUTOSENSE;
12590 			break;
12591 		case CTL_LUN_INJ_NONE:
12592 		default:
12593 			/*
12594 			 * If this is an error injection type we don't know
12595 			 * about, clear the continuous flag (if it is set)
12596 			 * so it will get deleted below.
12597 			 */
12598 			desc->lun_error &= ~CTL_LUN_INJ_CONTINUOUS;
12599 			break;
12600 		}
12601 		/*
12602 		 * By default, each error injection action is a one-shot
12603 		 */
12604 		if (desc->lun_error & CTL_LUN_INJ_CONTINUOUS)
12605 			continue;
12606 
12607 		STAILQ_REMOVE(&lun->error_list, desc, ctl_error_desc, links);
12608 
12609 		free(desc, M_CTL);
12610 	}
12611 }
12612 
12613 #ifdef CTL_IO_DELAY
12614 static void
12615 ctl_datamove_timer_wakeup(void *arg)
12616 {
12617 	union ctl_io *io;
12618 
12619 	io = (union ctl_io *)arg;
12620 
12621 	ctl_datamove(io);
12622 }
12623 #endif /* CTL_IO_DELAY */
12624 
12625 void
12626 ctl_datamove(union ctl_io *io)
12627 {
12628 	struct ctl_lun *lun;
12629 	void (*fe_datamove)(union ctl_io *io);
12630 
12631 	mtx_assert(&control_softc->ctl_lock, MA_NOTOWNED);
12632 
12633 	CTL_DEBUG_PRINT(("ctl_datamove\n"));
12634 
12635 	lun = (struct ctl_lun *)io->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
12636 #ifdef CTL_TIME_IO
12637 	if ((time_uptime - io->io_hdr.start_time) > ctl_time_io_secs) {
12638 		char str[256];
12639 		char path_str[64];
12640 		struct sbuf sb;
12641 
12642 		ctl_scsi_path_string(io, path_str, sizeof(path_str));
12643 		sbuf_new(&sb, str, sizeof(str), SBUF_FIXEDLEN);
12644 
12645 		sbuf_cat(&sb, path_str);
12646 		switch (io->io_hdr.io_type) {
12647 		case CTL_IO_SCSI:
12648 			ctl_scsi_command_string(&io->scsiio, NULL, &sb);
12649 			sbuf_printf(&sb, "\n");
12650 			sbuf_cat(&sb, path_str);
12651 			sbuf_printf(&sb, "Tag: 0x%04x, type %d\n",
12652 				    io->scsiio.tag_num, io->scsiio.tag_type);
12653 			break;
12654 		case CTL_IO_TASK:
12655 			sbuf_printf(&sb, "Task I/O type: %d, Tag: 0x%04x, "
12656 				    "Tag Type: %d\n", io->taskio.task_action,
12657 				    io->taskio.tag_num, io->taskio.tag_type);
12658 			break;
12659 		default:
12660 			panic("%s: Invalid CTL I/O type %d\n",
12661 			    __func__, io->io_hdr.io_type);
12662 		}
12663 		sbuf_cat(&sb, path_str);
12664 		sbuf_printf(&sb, "ctl_datamove: %jd seconds\n",
12665 			    (intmax_t)time_uptime - io->io_hdr.start_time);
12666 		sbuf_finish(&sb);
12667 		printf("%s", sbuf_data(&sb));
12668 	}
12669 #endif /* CTL_TIME_IO */
12670 
12671 #ifdef CTL_IO_DELAY
12672 	if (io->io_hdr.flags & CTL_FLAG_DELAY_DONE) {
12673 		io->io_hdr.flags &= ~CTL_FLAG_DELAY_DONE;
12674 	} else {
12675 		if ((lun != NULL)
12676 		 && (lun->delay_info.datamove_delay > 0)) {
12677 
12678 			callout_init(&io->io_hdr.delay_callout, /*mpsafe*/ 1);
12679 			io->io_hdr.flags |= CTL_FLAG_DELAY_DONE;
12680 			callout_reset(&io->io_hdr.delay_callout,
12681 				      lun->delay_info.datamove_delay * hz,
12682 				      ctl_datamove_timer_wakeup, io);
12683 			if (lun->delay_info.datamove_type ==
12684 			    CTL_DELAY_TYPE_ONESHOT)
12685 				lun->delay_info.datamove_delay = 0;
12686 			return;
12687 		}
12688 	}
12689 #endif
12690 
12691 	/*
12692 	 * This command has been aborted.  Set the port status, so we fail
12693 	 * the data move.
12694 	 */
12695 	if (io->io_hdr.flags & CTL_FLAG_ABORT) {
12696 		printf("ctl_datamove: tag 0x%04x on (%u:%u:%u) aborted\n",
12697 		       io->scsiio.tag_num, io->io_hdr.nexus.initid,
12698 		       io->io_hdr.nexus.targ_port,
12699 		       io->io_hdr.nexus.targ_lun);
12700 		io->io_hdr.port_status = 31337;
12701 		/*
12702 		 * Note that the backend, in this case, will get the
12703 		 * callback in its context.  In other cases it may get
12704 		 * called in the frontend's interrupt thread context.
12705 		 */
12706 		io->scsiio.be_move_done(io);
12707 		return;
12708 	}
12709 
12710 	/* Don't confuse frontend with zero length data move. */
12711 	if (io->scsiio.kern_data_len == 0) {
12712 		io->scsiio.be_move_done(io);
12713 		return;
12714 	}
12715 
12716 	fe_datamove = ctl_io_port(&io->io_hdr)->fe_datamove;
12717 	fe_datamove(io);
12718 }
12719 
12720 static void
12721 ctl_send_datamove_done(union ctl_io *io, int have_lock)
12722 {
12723 	union ctl_ha_msg msg;
12724 #ifdef CTL_TIME_IO
12725 	struct bintime cur_bt;
12726 #endif
12727 
12728 	memset(&msg, 0, sizeof(msg));
12729 	msg.hdr.msg_type = CTL_MSG_DATAMOVE_DONE;
12730 	msg.hdr.original_sc = io;
12731 	msg.hdr.serializing_sc = io->io_hdr.serializing_sc;
12732 	msg.hdr.nexus = io->io_hdr.nexus;
12733 	msg.hdr.status = io->io_hdr.status;
12734 	msg.scsi.tag_num = io->scsiio.tag_num;
12735 	msg.scsi.tag_type = io->scsiio.tag_type;
12736 	msg.scsi.scsi_status = io->scsiio.scsi_status;
12737 	memcpy(&msg.scsi.sense_data, &io->scsiio.sense_data,
12738 	       io->scsiio.sense_len);
12739 	msg.scsi.sense_len = io->scsiio.sense_len;
12740 	msg.scsi.sense_residual = io->scsiio.sense_residual;
12741 	msg.scsi.fetd_status = io->io_hdr.port_status;
12742 	msg.scsi.residual = io->scsiio.residual;
12743 	io->io_hdr.flags &= ~CTL_FLAG_IO_ACTIVE;
12744 	if (io->io_hdr.flags & CTL_FLAG_FAILOVER) {
12745 		ctl_failover_io(io, /*have_lock*/ have_lock);
12746 		return;
12747 	}
12748 	ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg,
12749 	    sizeof(msg.scsi) - sizeof(msg.scsi.sense_data) +
12750 	    msg.scsi.sense_len, M_WAITOK);
12751 
12752 #ifdef CTL_TIME_IO
12753 	getbinuptime(&cur_bt);
12754 	bintime_sub(&cur_bt, &io->io_hdr.dma_start_bt);
12755 	bintime_add(&io->io_hdr.dma_bt, &cur_bt);
12756 #endif
12757 	io->io_hdr.num_dmas++;
12758 }
12759 
12760 /*
12761  * The DMA to the remote side is done, now we need to tell the other side
12762  * we're done so it can continue with its data movement.
12763  */
12764 static void
12765 ctl_datamove_remote_write_cb(struct ctl_ha_dt_req *rq)
12766 {
12767 	union ctl_io *io;
12768 	int i;
12769 
12770 	io = rq->context;
12771 
12772 	if (rq->ret != CTL_HA_STATUS_SUCCESS) {
12773 		printf("%s: ISC DMA write failed with error %d", __func__,
12774 		       rq->ret);
12775 		ctl_set_internal_failure(&io->scsiio,
12776 					 /*sks_valid*/ 1,
12777 					 /*retry_count*/ rq->ret);
12778 	}
12779 
12780 	ctl_dt_req_free(rq);
12781 
12782 	for (i = 0; i < io->scsiio.kern_sg_entries; i++)
12783 		free(io->io_hdr.local_sglist[i].addr, M_CTL);
12784 	free(io->io_hdr.remote_sglist, M_CTL);
12785 	io->io_hdr.remote_sglist = NULL;
12786 	io->io_hdr.local_sglist = NULL;
12787 
12788 	/*
12789 	 * The data is in local and remote memory, so now we need to send
12790 	 * status (good or back) back to the other side.
12791 	 */
12792 	ctl_send_datamove_done(io, /*have_lock*/ 0);
12793 }
12794 
12795 /*
12796  * We've moved the data from the host/controller into local memory.  Now we
12797  * need to push it over to the remote controller's memory.
12798  */
12799 static int
12800 ctl_datamove_remote_dm_write_cb(union ctl_io *io)
12801 {
12802 	int retval;
12803 
12804 	retval = ctl_datamove_remote_xfer(io, CTL_HA_DT_CMD_WRITE,
12805 					  ctl_datamove_remote_write_cb);
12806 	return (retval);
12807 }
12808 
12809 static void
12810 ctl_datamove_remote_write(union ctl_io *io)
12811 {
12812 	int retval;
12813 	void (*fe_datamove)(union ctl_io *io);
12814 
12815 	/*
12816 	 * - Get the data from the host/HBA into local memory.
12817 	 * - DMA memory from the local controller to the remote controller.
12818 	 * - Send status back to the remote controller.
12819 	 */
12820 
12821 	retval = ctl_datamove_remote_sgl_setup(io);
12822 	if (retval != 0)
12823 		return;
12824 
12825 	/* Switch the pointer over so the FETD knows what to do */
12826 	io->scsiio.kern_data_ptr = (uint8_t *)io->io_hdr.local_sglist;
12827 
12828 	/*
12829 	 * Use a custom move done callback, since we need to send completion
12830 	 * back to the other controller, not to the backend on this side.
12831 	 */
12832 	io->scsiio.be_move_done = ctl_datamove_remote_dm_write_cb;
12833 
12834 	fe_datamove = ctl_io_port(&io->io_hdr)->fe_datamove;
12835 	fe_datamove(io);
12836 }
12837 
12838 static int
12839 ctl_datamove_remote_dm_read_cb(union ctl_io *io)
12840 {
12841 #if 0
12842 	char str[256];
12843 	char path_str[64];
12844 	struct sbuf sb;
12845 #endif
12846 	int i;
12847 
12848 	for (i = 0; i < io->scsiio.kern_sg_entries; i++)
12849 		free(io->io_hdr.local_sglist[i].addr, M_CTL);
12850 	free(io->io_hdr.remote_sglist, M_CTL);
12851 	io->io_hdr.remote_sglist = NULL;
12852 	io->io_hdr.local_sglist = NULL;
12853 
12854 #if 0
12855 	scsi_path_string(io, path_str, sizeof(path_str));
12856 	sbuf_new(&sb, str, sizeof(str), SBUF_FIXEDLEN);
12857 	sbuf_cat(&sb, path_str);
12858 	scsi_command_string(&io->scsiio, NULL, &sb);
12859 	sbuf_printf(&sb, "\n");
12860 	sbuf_cat(&sb, path_str);
12861 	sbuf_printf(&sb, "Tag: 0x%04x, type %d\n",
12862 		    io->scsiio.tag_num, io->scsiio.tag_type);
12863 	sbuf_cat(&sb, path_str);
12864 	sbuf_printf(&sb, "%s: flags %#x, status %#x\n", __func__,
12865 		    io->io_hdr.flags, io->io_hdr.status);
12866 	sbuf_finish(&sb);
12867 	printk("%s", sbuf_data(&sb));
12868 #endif
12869 
12870 
12871 	/*
12872 	 * The read is done, now we need to send status (good or bad) back
12873 	 * to the other side.
12874 	 */
12875 	ctl_send_datamove_done(io, /*have_lock*/ 0);
12876 
12877 	return (0);
12878 }
12879 
12880 static void
12881 ctl_datamove_remote_read_cb(struct ctl_ha_dt_req *rq)
12882 {
12883 	union ctl_io *io;
12884 	void (*fe_datamove)(union ctl_io *io);
12885 
12886 	io = rq->context;
12887 
12888 	if (rq->ret != CTL_HA_STATUS_SUCCESS) {
12889 		printf("%s: ISC DMA read failed with error %d\n", __func__,
12890 		       rq->ret);
12891 		ctl_set_internal_failure(&io->scsiio,
12892 					 /*sks_valid*/ 1,
12893 					 /*retry_count*/ rq->ret);
12894 	}
12895 
12896 	ctl_dt_req_free(rq);
12897 
12898 	/* Switch the pointer over so the FETD knows what to do */
12899 	io->scsiio.kern_data_ptr = (uint8_t *)io->io_hdr.local_sglist;
12900 
12901 	/*
12902 	 * Use a custom move done callback, since we need to send completion
12903 	 * back to the other controller, not to the backend on this side.
12904 	 */
12905 	io->scsiio.be_move_done = ctl_datamove_remote_dm_read_cb;
12906 
12907 	/* XXX KDM add checks like the ones in ctl_datamove? */
12908 
12909 	fe_datamove = ctl_io_port(&io->io_hdr)->fe_datamove;
12910 	fe_datamove(io);
12911 }
12912 
12913 static int
12914 ctl_datamove_remote_sgl_setup(union ctl_io *io)
12915 {
12916 	struct ctl_sg_entry *local_sglist;
12917 	uint32_t len_to_go;
12918 	int retval;
12919 	int i;
12920 
12921 	retval = 0;
12922 	local_sglist = io->io_hdr.local_sglist;
12923 	len_to_go = io->scsiio.kern_data_len;
12924 
12925 	/*
12926 	 * The difficult thing here is that the size of the various
12927 	 * S/G segments may be different than the size from the
12928 	 * remote controller.  That'll make it harder when DMAing
12929 	 * the data back to the other side.
12930 	 */
12931 	for (i = 0; len_to_go > 0; i++) {
12932 		local_sglist[i].len = MIN(len_to_go, CTL_HA_DATAMOVE_SEGMENT);
12933 		local_sglist[i].addr =
12934 		    malloc(local_sglist[i].len, M_CTL, M_WAITOK);
12935 
12936 		len_to_go -= local_sglist[i].len;
12937 	}
12938 	/*
12939 	 * Reset the number of S/G entries accordingly.  The original
12940 	 * number of S/G entries is available in rem_sg_entries.
12941 	 */
12942 	io->scsiio.kern_sg_entries = i;
12943 
12944 #if 0
12945 	printf("%s: kern_sg_entries = %d\n", __func__,
12946 	       io->scsiio.kern_sg_entries);
12947 	for (i = 0; i < io->scsiio.kern_sg_entries; i++)
12948 		printf("%s: sg[%d] = %p, %lu\n", __func__, i,
12949 		       local_sglist[i].addr, local_sglist[i].len);
12950 #endif
12951 
12952 	return (retval);
12953 }
12954 
12955 static int
12956 ctl_datamove_remote_xfer(union ctl_io *io, unsigned command,
12957 			 ctl_ha_dt_cb callback)
12958 {
12959 	struct ctl_ha_dt_req *rq;
12960 	struct ctl_sg_entry *remote_sglist, *local_sglist;
12961 	uint32_t local_used, remote_used, total_used;
12962 	int i, j, isc_ret;
12963 
12964 	rq = ctl_dt_req_alloc();
12965 
12966 	/*
12967 	 * If we failed to allocate the request, and if the DMA didn't fail
12968 	 * anyway, set busy status.  This is just a resource allocation
12969 	 * failure.
12970 	 */
12971 	if ((rq == NULL)
12972 	 && ((io->io_hdr.status & CTL_STATUS_MASK) != CTL_STATUS_NONE &&
12973 	     (io->io_hdr.status & CTL_STATUS_MASK) != CTL_SUCCESS))
12974 		ctl_set_busy(&io->scsiio);
12975 
12976 	if ((io->io_hdr.status & CTL_STATUS_MASK) != CTL_STATUS_NONE &&
12977 	    (io->io_hdr.status & CTL_STATUS_MASK) != CTL_SUCCESS) {
12978 
12979 		if (rq != NULL)
12980 			ctl_dt_req_free(rq);
12981 
12982 		/*
12983 		 * The data move failed.  We need to return status back
12984 		 * to the other controller.  No point in trying to DMA
12985 		 * data to the remote controller.
12986 		 */
12987 
12988 		ctl_send_datamove_done(io, /*have_lock*/ 0);
12989 
12990 		return (1);
12991 	}
12992 
12993 	local_sglist = io->io_hdr.local_sglist;
12994 	remote_sglist = io->io_hdr.remote_sglist;
12995 	local_used = 0;
12996 	remote_used = 0;
12997 	total_used = 0;
12998 
12999 	/*
13000 	 * Pull/push the data over the wire from/to the other controller.
13001 	 * This takes into account the possibility that the local and
13002 	 * remote sglists may not be identical in terms of the size of
13003 	 * the elements and the number of elements.
13004 	 *
13005 	 * One fundamental assumption here is that the length allocated for
13006 	 * both the local and remote sglists is identical.  Otherwise, we've
13007 	 * essentially got a coding error of some sort.
13008 	 */
13009 	isc_ret = CTL_HA_STATUS_SUCCESS;
13010 	for (i = 0, j = 0; total_used < io->scsiio.kern_data_len; ) {
13011 		uint32_t cur_len;
13012 		uint8_t *tmp_ptr;
13013 
13014 		rq->command = command;
13015 		rq->context = io;
13016 
13017 		/*
13018 		 * Both pointers should be aligned.  But it is possible
13019 		 * that the allocation length is not.  They should both
13020 		 * also have enough slack left over at the end, though,
13021 		 * to round up to the next 8 byte boundary.
13022 		 */
13023 		cur_len = MIN(local_sglist[i].len - local_used,
13024 			      remote_sglist[j].len - remote_used);
13025 		rq->size = cur_len;
13026 
13027 		tmp_ptr = (uint8_t *)local_sglist[i].addr;
13028 		tmp_ptr += local_used;
13029 
13030 #if 0
13031 		/* Use physical addresses when talking to ISC hardware */
13032 		if ((io->io_hdr.flags & CTL_FLAG_BUS_ADDR) == 0) {
13033 			/* XXX KDM use busdma */
13034 			rq->local = vtophys(tmp_ptr);
13035 		} else
13036 			rq->local = tmp_ptr;
13037 #else
13038 		KASSERT((io->io_hdr.flags & CTL_FLAG_BUS_ADDR) == 0,
13039 		    ("HA does not support BUS_ADDR"));
13040 		rq->local = tmp_ptr;
13041 #endif
13042 
13043 		tmp_ptr = (uint8_t *)remote_sglist[j].addr;
13044 		tmp_ptr += remote_used;
13045 		rq->remote = tmp_ptr;
13046 
13047 		rq->callback = NULL;
13048 
13049 		local_used += cur_len;
13050 		if (local_used >= local_sglist[i].len) {
13051 			i++;
13052 			local_used = 0;
13053 		}
13054 
13055 		remote_used += cur_len;
13056 		if (remote_used >= remote_sglist[j].len) {
13057 			j++;
13058 			remote_used = 0;
13059 		}
13060 		total_used += cur_len;
13061 
13062 		if (total_used >= io->scsiio.kern_data_len)
13063 			rq->callback = callback;
13064 
13065 #if 0
13066 		printf("%s: %s: local %p remote %p size %d\n", __func__,
13067 		       (command == CTL_HA_DT_CMD_WRITE) ? "WRITE" : "READ",
13068 		       rq->local, rq->remote, rq->size);
13069 #endif
13070 
13071 		isc_ret = ctl_dt_single(rq);
13072 		if (isc_ret > CTL_HA_STATUS_SUCCESS)
13073 			break;
13074 	}
13075 	if (isc_ret != CTL_HA_STATUS_WAIT) {
13076 		rq->ret = isc_ret;
13077 		callback(rq);
13078 	}
13079 
13080 	return (0);
13081 }
13082 
13083 static void
13084 ctl_datamove_remote_read(union ctl_io *io)
13085 {
13086 	int retval;
13087 	int i;
13088 
13089 	/*
13090 	 * This will send an error to the other controller in the case of a
13091 	 * failure.
13092 	 */
13093 	retval = ctl_datamove_remote_sgl_setup(io);
13094 	if (retval != 0)
13095 		return;
13096 
13097 	retval = ctl_datamove_remote_xfer(io, CTL_HA_DT_CMD_READ,
13098 					  ctl_datamove_remote_read_cb);
13099 	if (retval != 0) {
13100 		/*
13101 		 * Make sure we free memory if there was an error..  The
13102 		 * ctl_datamove_remote_xfer() function will send the
13103 		 * datamove done message, or call the callback with an
13104 		 * error if there is a problem.
13105 		 */
13106 		for (i = 0; i < io->scsiio.kern_sg_entries; i++)
13107 			free(io->io_hdr.local_sglist[i].addr, M_CTL);
13108 		free(io->io_hdr.remote_sglist, M_CTL);
13109 		io->io_hdr.remote_sglist = NULL;
13110 		io->io_hdr.local_sglist = NULL;
13111 	}
13112 }
13113 
13114 /*
13115  * Process a datamove request from the other controller.  This is used for
13116  * XFER mode only, not SER_ONLY mode.  For writes, we DMA into local memory
13117  * first.  Once that is complete, the data gets DMAed into the remote
13118  * controller's memory.  For reads, we DMA from the remote controller's
13119  * memory into our memory first, and then move it out to the FETD.
13120  */
13121 static void
13122 ctl_datamove_remote(union ctl_io *io)
13123 {
13124 
13125 	mtx_assert(&control_softc->ctl_lock, MA_NOTOWNED);
13126 
13127 	if (io->io_hdr.flags & CTL_FLAG_FAILOVER) {
13128 		ctl_failover_io(io, /*have_lock*/ 0);
13129 		return;
13130 	}
13131 
13132 	/*
13133 	 * Note that we look for an aborted I/O here, but don't do some of
13134 	 * the other checks that ctl_datamove() normally does.
13135 	 * We don't need to run the datamove delay code, since that should
13136 	 * have been done if need be on the other controller.
13137 	 */
13138 	if (io->io_hdr.flags & CTL_FLAG_ABORT) {
13139 		printf("%s: tag 0x%04x on (%u:%u:%u) aborted\n", __func__,
13140 		       io->scsiio.tag_num, io->io_hdr.nexus.initid,
13141 		       io->io_hdr.nexus.targ_port,
13142 		       io->io_hdr.nexus.targ_lun);
13143 		io->io_hdr.port_status = 31338;
13144 		ctl_send_datamove_done(io, /*have_lock*/ 0);
13145 		return;
13146 	}
13147 
13148 	if ((io->io_hdr.flags & CTL_FLAG_DATA_MASK) == CTL_FLAG_DATA_OUT)
13149 		ctl_datamove_remote_write(io);
13150 	else if ((io->io_hdr.flags & CTL_FLAG_DATA_MASK) == CTL_FLAG_DATA_IN)
13151 		ctl_datamove_remote_read(io);
13152 	else {
13153 		io->io_hdr.port_status = 31339;
13154 		ctl_send_datamove_done(io, /*have_lock*/ 0);
13155 	}
13156 }
13157 
13158 static void
13159 ctl_process_done(union ctl_io *io)
13160 {
13161 	struct ctl_lun *lun;
13162 	struct ctl_softc *softc = control_softc;
13163 	void (*fe_done)(union ctl_io *io);
13164 	union ctl_ha_msg msg;
13165 	uint32_t targ_port = io->io_hdr.nexus.targ_port;
13166 
13167 	CTL_DEBUG_PRINT(("ctl_process_done\n"));
13168 	fe_done = softc->ctl_ports[targ_port]->fe_done;
13169 
13170 #ifdef CTL_TIME_IO
13171 	if ((time_uptime - io->io_hdr.start_time) > ctl_time_io_secs) {
13172 		char str[256];
13173 		char path_str[64];
13174 		struct sbuf sb;
13175 
13176 		ctl_scsi_path_string(io, path_str, sizeof(path_str));
13177 		sbuf_new(&sb, str, sizeof(str), SBUF_FIXEDLEN);
13178 
13179 		sbuf_cat(&sb, path_str);
13180 		switch (io->io_hdr.io_type) {
13181 		case CTL_IO_SCSI:
13182 			ctl_scsi_command_string(&io->scsiio, NULL, &sb);
13183 			sbuf_printf(&sb, "\n");
13184 			sbuf_cat(&sb, path_str);
13185 			sbuf_printf(&sb, "Tag: 0x%04x, type %d\n",
13186 				    io->scsiio.tag_num, io->scsiio.tag_type);
13187 			break;
13188 		case CTL_IO_TASK:
13189 			sbuf_printf(&sb, "Task I/O type: %d, Tag: 0x%04x, "
13190 				    "Tag Type: %d\n", io->taskio.task_action,
13191 				    io->taskio.tag_num, io->taskio.tag_type);
13192 			break;
13193 		default:
13194 			panic("%s: Invalid CTL I/O type %d\n",
13195 			    __func__, io->io_hdr.io_type);
13196 		}
13197 		sbuf_cat(&sb, path_str);
13198 		sbuf_printf(&sb, "ctl_process_done: %jd seconds\n",
13199 			    (intmax_t)time_uptime - io->io_hdr.start_time);
13200 		sbuf_finish(&sb);
13201 		printf("%s", sbuf_data(&sb));
13202 	}
13203 #endif /* CTL_TIME_IO */
13204 
13205 	switch (io->io_hdr.io_type) {
13206 	case CTL_IO_SCSI:
13207 		break;
13208 	case CTL_IO_TASK:
13209 		if (ctl_debug & CTL_DEBUG_INFO)
13210 			ctl_io_error_print(io, NULL);
13211 		fe_done(io);
13212 		return;
13213 	default:
13214 		panic("%s: Invalid CTL I/O type %d\n",
13215 		    __func__, io->io_hdr.io_type);
13216 	}
13217 
13218 	lun = (struct ctl_lun *)io->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
13219 	if (lun == NULL) {
13220 		CTL_DEBUG_PRINT(("NULL LUN for lun %d\n",
13221 				 io->io_hdr.nexus.targ_mapped_lun));
13222 		goto bailout;
13223 	}
13224 
13225 	mtx_lock(&lun->lun_lock);
13226 
13227 	/*
13228 	 * Check to see if we have any errors to inject here.  We only
13229 	 * inject errors for commands that don't already have errors set.
13230 	 */
13231 	if (!STAILQ_EMPTY(&lun->error_list) &&
13232 	    ((io->io_hdr.status & CTL_STATUS_MASK) == CTL_SUCCESS) &&
13233 	    ((io->io_hdr.flags & CTL_FLAG_STATUS_SENT) == 0))
13234 		ctl_inject_error(lun, io);
13235 
13236 	/*
13237 	 * XXX KDM how do we treat commands that aren't completed
13238 	 * successfully?
13239 	 *
13240 	 * XXX KDM should we also track I/O latency?
13241 	 */
13242 	if ((io->io_hdr.status & CTL_STATUS_MASK) == CTL_SUCCESS &&
13243 	    io->io_hdr.io_type == CTL_IO_SCSI) {
13244 #ifdef CTL_TIME_IO
13245 		struct bintime cur_bt;
13246 #endif
13247 		int type;
13248 
13249 		if ((io->io_hdr.flags & CTL_FLAG_DATA_MASK) ==
13250 		    CTL_FLAG_DATA_IN)
13251 			type = CTL_STATS_READ;
13252 		else if ((io->io_hdr.flags & CTL_FLAG_DATA_MASK) ==
13253 		    CTL_FLAG_DATA_OUT)
13254 			type = CTL_STATS_WRITE;
13255 		else
13256 			type = CTL_STATS_NO_IO;
13257 
13258 		lun->stats.ports[targ_port].bytes[type] +=
13259 		    io->scsiio.kern_total_len;
13260 		lun->stats.ports[targ_port].operations[type]++;
13261 #ifdef CTL_TIME_IO
13262 		bintime_add(&lun->stats.ports[targ_port].dma_time[type],
13263 		   &io->io_hdr.dma_bt);
13264 		getbinuptime(&cur_bt);
13265 		bintime_sub(&cur_bt, &io->io_hdr.start_bt);
13266 		bintime_add(&lun->stats.ports[targ_port].time[type], &cur_bt);
13267 #endif
13268 		lun->stats.ports[targ_port].num_dmas[type] +=
13269 		    io->io_hdr.num_dmas;
13270 	}
13271 
13272 	/*
13273 	 * Remove this from the OOA queue.
13274 	 */
13275 	TAILQ_REMOVE(&lun->ooa_queue, &io->io_hdr, ooa_links);
13276 #ifdef CTL_TIME_IO
13277 	if (TAILQ_EMPTY(&lun->ooa_queue))
13278 		lun->last_busy = getsbinuptime();
13279 #endif
13280 
13281 	/*
13282 	 * Run through the blocked queue on this LUN and see if anything
13283 	 * has become unblocked, now that this transaction is done.
13284 	 */
13285 	ctl_check_blocked(lun);
13286 
13287 	/*
13288 	 * If the LUN has been invalidated, free it if there is nothing
13289 	 * left on its OOA queue.
13290 	 */
13291 	if ((lun->flags & CTL_LUN_INVALID)
13292 	 && TAILQ_EMPTY(&lun->ooa_queue)) {
13293 		mtx_unlock(&lun->lun_lock);
13294 		mtx_lock(&softc->ctl_lock);
13295 		ctl_free_lun(lun);
13296 		mtx_unlock(&softc->ctl_lock);
13297 	} else
13298 		mtx_unlock(&lun->lun_lock);
13299 
13300 bailout:
13301 
13302 	/*
13303 	 * If this command has been aborted, make sure we set the status
13304 	 * properly.  The FETD is responsible for freeing the I/O and doing
13305 	 * whatever it needs to do to clean up its state.
13306 	 */
13307 	if (io->io_hdr.flags & CTL_FLAG_ABORT)
13308 		ctl_set_task_aborted(&io->scsiio);
13309 
13310 	/*
13311 	 * If enabled, print command error status.
13312 	 */
13313 	if ((io->io_hdr.status & CTL_STATUS_MASK) != CTL_SUCCESS &&
13314 	    (ctl_debug & CTL_DEBUG_INFO) != 0)
13315 		ctl_io_error_print(io, NULL);
13316 
13317 	/*
13318 	 * Tell the FETD or the other shelf controller we're done with this
13319 	 * command.  Note that only SCSI commands get to this point.  Task
13320 	 * management commands are completed above.
13321 	 */
13322 	if ((softc->ha_mode != CTL_HA_MODE_XFER) &&
13323 	    (io->io_hdr.flags & CTL_FLAG_SENT_2OTHER_SC)) {
13324 		memset(&msg, 0, sizeof(msg));
13325 		msg.hdr.msg_type = CTL_MSG_FINISH_IO;
13326 		msg.hdr.serializing_sc = io->io_hdr.serializing_sc;
13327 		msg.hdr.nexus = io->io_hdr.nexus;
13328 		ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg,
13329 		    sizeof(msg.scsi) - sizeof(msg.scsi.sense_data),
13330 		    M_WAITOK);
13331 	}
13332 
13333 	fe_done(io);
13334 }
13335 
13336 #ifdef CTL_WITH_CA
13337 /*
13338  * Front end should call this if it doesn't do autosense.  When the request
13339  * sense comes back in from the initiator, we'll dequeue this and send it.
13340  */
13341 int
13342 ctl_queue_sense(union ctl_io *io)
13343 {
13344 	struct ctl_lun *lun;
13345 	struct ctl_port *port;
13346 	struct ctl_softc *softc;
13347 	uint32_t initidx, targ_lun;
13348 
13349 	softc = control_softc;
13350 
13351 	CTL_DEBUG_PRINT(("ctl_queue_sense\n"));
13352 
13353 	/*
13354 	 * LUN lookup will likely move to the ctl_work_thread() once we
13355 	 * have our new queueing infrastructure (that doesn't put things on
13356 	 * a per-LUN queue initially).  That is so that we can handle
13357 	 * things like an INQUIRY to a LUN that we don't have enabled.  We
13358 	 * can't deal with that right now.
13359 	 */
13360 	mtx_lock(&softc->ctl_lock);
13361 
13362 	/*
13363 	 * If we don't have a LUN for this, just toss the sense
13364 	 * information.
13365 	 */
13366 	port = ctl_io_port(&ctsio->io_hdr);
13367 	targ_lun = ctl_lun_map_from_port(port, io->io_hdr.nexus.targ_lun);
13368 	if ((targ_lun < CTL_MAX_LUNS)
13369 	 && (softc->ctl_luns[targ_lun] != NULL))
13370 		lun = softc->ctl_luns[targ_lun];
13371 	else
13372 		goto bailout;
13373 
13374 	initidx = ctl_get_initindex(&io->io_hdr.nexus);
13375 
13376 	mtx_lock(&lun->lun_lock);
13377 	/*
13378 	 * Already have CA set for this LUN...toss the sense information.
13379 	 */
13380 	if (ctl_is_set(lun->have_ca, initidx)) {
13381 		mtx_unlock(&lun->lun_lock);
13382 		goto bailout;
13383 	}
13384 
13385 	memcpy(&lun->pending_sense[initidx], &io->scsiio.sense_data,
13386 	       MIN(sizeof(lun->pending_sense[initidx]),
13387 	       sizeof(io->scsiio.sense_data)));
13388 	ctl_set_mask(lun->have_ca, initidx);
13389 	mtx_unlock(&lun->lun_lock);
13390 
13391 bailout:
13392 	mtx_unlock(&softc->ctl_lock);
13393 
13394 	ctl_free_io(io);
13395 
13396 	return (CTL_RETVAL_COMPLETE);
13397 }
13398 #endif
13399 
13400 /*
13401  * Primary command inlet from frontend ports.  All SCSI and task I/O
13402  * requests must go through this function.
13403  */
13404 int
13405 ctl_queue(union ctl_io *io)
13406 {
13407 	struct ctl_port *port;
13408 
13409 	CTL_DEBUG_PRINT(("ctl_queue cdb[0]=%02X\n", io->scsiio.cdb[0]));
13410 
13411 #ifdef CTL_TIME_IO
13412 	io->io_hdr.start_time = time_uptime;
13413 	getbinuptime(&io->io_hdr.start_bt);
13414 #endif /* CTL_TIME_IO */
13415 
13416 	/* Map FE-specific LUN ID into global one. */
13417 	port = ctl_io_port(&io->io_hdr);
13418 	io->io_hdr.nexus.targ_mapped_lun =
13419 	    ctl_lun_map_from_port(port, io->io_hdr.nexus.targ_lun);
13420 
13421 	switch (io->io_hdr.io_type) {
13422 	case CTL_IO_SCSI:
13423 	case CTL_IO_TASK:
13424 		if (ctl_debug & CTL_DEBUG_CDB)
13425 			ctl_io_print(io);
13426 		ctl_enqueue_incoming(io);
13427 		break;
13428 	default:
13429 		printf("ctl_queue: unknown I/O type %d\n", io->io_hdr.io_type);
13430 		return (EINVAL);
13431 	}
13432 
13433 	return (CTL_RETVAL_COMPLETE);
13434 }
13435 
13436 #ifdef CTL_IO_DELAY
13437 static void
13438 ctl_done_timer_wakeup(void *arg)
13439 {
13440 	union ctl_io *io;
13441 
13442 	io = (union ctl_io *)arg;
13443 	ctl_done(io);
13444 }
13445 #endif /* CTL_IO_DELAY */
13446 
13447 void
13448 ctl_serseq_done(union ctl_io *io)
13449 {
13450 	struct ctl_lun *lun;
13451 
13452 	lun = (struct ctl_lun *)io->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
13453 	if (lun->be_lun == NULL ||
13454 	    lun->be_lun->serseq == CTL_LUN_SERSEQ_OFF)
13455 		return;
13456 	mtx_lock(&lun->lun_lock);
13457 	io->io_hdr.flags |= CTL_FLAG_SERSEQ_DONE;
13458 	ctl_check_blocked(lun);
13459 	mtx_unlock(&lun->lun_lock);
13460 }
13461 
13462 void
13463 ctl_done(union ctl_io *io)
13464 {
13465 
13466 	/*
13467 	 * Enable this to catch duplicate completion issues.
13468 	 */
13469 #if 0
13470 	if (io->io_hdr.flags & CTL_FLAG_ALREADY_DONE) {
13471 		printf("%s: type %d msg %d cdb %x iptl: "
13472 		       "%u:%u:%u tag 0x%04x "
13473 		       "flag %#x status %x\n",
13474 			__func__,
13475 			io->io_hdr.io_type,
13476 			io->io_hdr.msg_type,
13477 			io->scsiio.cdb[0],
13478 			io->io_hdr.nexus.initid,
13479 			io->io_hdr.nexus.targ_port,
13480 			io->io_hdr.nexus.targ_lun,
13481 			(io->io_hdr.io_type ==
13482 			CTL_IO_TASK) ?
13483 			io->taskio.tag_num :
13484 			io->scsiio.tag_num,
13485 		        io->io_hdr.flags,
13486 			io->io_hdr.status);
13487 	} else
13488 		io->io_hdr.flags |= CTL_FLAG_ALREADY_DONE;
13489 #endif
13490 
13491 	/*
13492 	 * This is an internal copy of an I/O, and should not go through
13493 	 * the normal done processing logic.
13494 	 */
13495 	if (io->io_hdr.flags & CTL_FLAG_INT_COPY)
13496 		return;
13497 
13498 #ifdef CTL_IO_DELAY
13499 	if (io->io_hdr.flags & CTL_FLAG_DELAY_DONE) {
13500 		struct ctl_lun *lun;
13501 
13502 		lun =(struct ctl_lun *)io->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
13503 
13504 		io->io_hdr.flags &= ~CTL_FLAG_DELAY_DONE;
13505 	} else {
13506 		struct ctl_lun *lun;
13507 
13508 		lun =(struct ctl_lun *)io->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
13509 
13510 		if ((lun != NULL)
13511 		 && (lun->delay_info.done_delay > 0)) {
13512 
13513 			callout_init(&io->io_hdr.delay_callout, /*mpsafe*/ 1);
13514 			io->io_hdr.flags |= CTL_FLAG_DELAY_DONE;
13515 			callout_reset(&io->io_hdr.delay_callout,
13516 				      lun->delay_info.done_delay * hz,
13517 				      ctl_done_timer_wakeup, io);
13518 			if (lun->delay_info.done_type == CTL_DELAY_TYPE_ONESHOT)
13519 				lun->delay_info.done_delay = 0;
13520 			return;
13521 		}
13522 	}
13523 #endif /* CTL_IO_DELAY */
13524 
13525 	ctl_enqueue_done(io);
13526 }
13527 
13528 static void
13529 ctl_work_thread(void *arg)
13530 {
13531 	struct ctl_thread *thr = (struct ctl_thread *)arg;
13532 	struct ctl_softc *softc = thr->ctl_softc;
13533 	union ctl_io *io;
13534 	int retval;
13535 
13536 	CTL_DEBUG_PRINT(("ctl_work_thread starting\n"));
13537 
13538 	for (;;) {
13539 		/*
13540 		 * We handle the queues in this order:
13541 		 * - ISC
13542 		 * - done queue (to free up resources, unblock other commands)
13543 		 * - RtR queue
13544 		 * - incoming queue
13545 		 *
13546 		 * If those queues are empty, we break out of the loop and
13547 		 * go to sleep.
13548 		 */
13549 		mtx_lock(&thr->queue_lock);
13550 		io = (union ctl_io *)STAILQ_FIRST(&thr->isc_queue);
13551 		if (io != NULL) {
13552 			STAILQ_REMOVE_HEAD(&thr->isc_queue, links);
13553 			mtx_unlock(&thr->queue_lock);
13554 			ctl_handle_isc(io);
13555 			continue;
13556 		}
13557 		io = (union ctl_io *)STAILQ_FIRST(&thr->done_queue);
13558 		if (io != NULL) {
13559 			STAILQ_REMOVE_HEAD(&thr->done_queue, links);
13560 			/* clear any blocked commands, call fe_done */
13561 			mtx_unlock(&thr->queue_lock);
13562 			ctl_process_done(io);
13563 			continue;
13564 		}
13565 		io = (union ctl_io *)STAILQ_FIRST(&thr->incoming_queue);
13566 		if (io != NULL) {
13567 			STAILQ_REMOVE_HEAD(&thr->incoming_queue, links);
13568 			mtx_unlock(&thr->queue_lock);
13569 			if (io->io_hdr.io_type == CTL_IO_TASK)
13570 				ctl_run_task(io);
13571 			else
13572 				ctl_scsiio_precheck(softc, &io->scsiio);
13573 			continue;
13574 		}
13575 		io = (union ctl_io *)STAILQ_FIRST(&thr->rtr_queue);
13576 		if (io != NULL) {
13577 			STAILQ_REMOVE_HEAD(&thr->rtr_queue, links);
13578 			mtx_unlock(&thr->queue_lock);
13579 			retval = ctl_scsiio(&io->scsiio);
13580 			if (retval != CTL_RETVAL_COMPLETE)
13581 				CTL_DEBUG_PRINT(("ctl_scsiio failed\n"));
13582 			continue;
13583 		}
13584 
13585 		/* Sleep until we have something to do. */
13586 		mtx_sleep(thr, &thr->queue_lock, PDROP | PRIBIO, "-", 0);
13587 	}
13588 }
13589 
13590 static void
13591 ctl_lun_thread(void *arg)
13592 {
13593 	struct ctl_softc *softc = (struct ctl_softc *)arg;
13594 	struct ctl_be_lun *be_lun;
13595 
13596 	CTL_DEBUG_PRINT(("ctl_lun_thread starting\n"));
13597 
13598 	for (;;) {
13599 		mtx_lock(&softc->ctl_lock);
13600 		be_lun = STAILQ_FIRST(&softc->pending_lun_queue);
13601 		if (be_lun != NULL) {
13602 			STAILQ_REMOVE_HEAD(&softc->pending_lun_queue, links);
13603 			mtx_unlock(&softc->ctl_lock);
13604 			ctl_create_lun(be_lun);
13605 			continue;
13606 		}
13607 
13608 		/* Sleep until we have something to do. */
13609 		mtx_sleep(&softc->pending_lun_queue, &softc->ctl_lock,
13610 		    PDROP | PRIBIO, "-", 0);
13611 	}
13612 }
13613 
13614 static void
13615 ctl_thresh_thread(void *arg)
13616 {
13617 	struct ctl_softc *softc = (struct ctl_softc *)arg;
13618 	struct ctl_lun *lun;
13619 	struct scsi_da_rw_recovery_page *rwpage;
13620 	struct ctl_logical_block_provisioning_page *page;
13621 	const char *attr;
13622 	union ctl_ha_msg msg;
13623 	uint64_t thres, val;
13624 	int i, e, set;
13625 
13626 	CTL_DEBUG_PRINT(("ctl_thresh_thread starting\n"));
13627 
13628 	for (;;) {
13629 		mtx_lock(&softc->ctl_lock);
13630 		STAILQ_FOREACH(lun, &softc->lun_list, links) {
13631 			if ((lun->flags & CTL_LUN_DISABLED) ||
13632 			    (lun->flags & CTL_LUN_NO_MEDIA) ||
13633 			    lun->backend->lun_attr == NULL)
13634 				continue;
13635 			if ((lun->flags & CTL_LUN_PRIMARY_SC) == 0 &&
13636 			    softc->ha_mode == CTL_HA_MODE_XFER)
13637 				continue;
13638 			rwpage = &lun->mode_pages.rw_er_page[CTL_PAGE_CURRENT];
13639 			if ((rwpage->byte8 & SMS_RWER_LBPERE) == 0)
13640 				continue;
13641 			e = 0;
13642 			page = &lun->mode_pages.lbp_page[CTL_PAGE_CURRENT];
13643 			for (i = 0; i < CTL_NUM_LBP_THRESH; i++) {
13644 				if ((page->descr[i].flags & SLBPPD_ENABLED) == 0)
13645 					continue;
13646 				thres = scsi_4btoul(page->descr[i].count);
13647 				thres <<= CTL_LBP_EXPONENT;
13648 				switch (page->descr[i].resource) {
13649 				case 0x01:
13650 					attr = "blocksavail";
13651 					break;
13652 				case 0x02:
13653 					attr = "blocksused";
13654 					break;
13655 				case 0xf1:
13656 					attr = "poolblocksavail";
13657 					break;
13658 				case 0xf2:
13659 					attr = "poolblocksused";
13660 					break;
13661 				default:
13662 					continue;
13663 				}
13664 				mtx_unlock(&softc->ctl_lock); // XXX
13665 				val = lun->backend->lun_attr(
13666 				    lun->be_lun->be_lun, attr);
13667 				mtx_lock(&softc->ctl_lock);
13668 				if (val == UINT64_MAX)
13669 					continue;
13670 				if ((page->descr[i].flags & SLBPPD_ARMING_MASK)
13671 				    == SLBPPD_ARMING_INC)
13672 					e = (val >= thres);
13673 				else
13674 					e = (val <= thres);
13675 				if (e)
13676 					break;
13677 			}
13678 			mtx_lock(&lun->lun_lock);
13679 			if (e) {
13680 				scsi_u64to8b((uint8_t *)&page->descr[i] -
13681 				    (uint8_t *)page, lun->ua_tpt_info);
13682 				if (lun->lasttpt == 0 ||
13683 				    time_uptime - lun->lasttpt >= CTL_LBP_UA_PERIOD) {
13684 					lun->lasttpt = time_uptime;
13685 					ctl_est_ua_all(lun, -1, CTL_UA_THIN_PROV_THRES);
13686 					set = 1;
13687 				} else
13688 					set = 0;
13689 			} else {
13690 				lun->lasttpt = 0;
13691 				ctl_clr_ua_all(lun, -1, CTL_UA_THIN_PROV_THRES);
13692 				set = -1;
13693 			}
13694 			mtx_unlock(&lun->lun_lock);
13695 			if (set != 0 &&
13696 			    lun->ctl_softc->ha_mode == CTL_HA_MODE_XFER) {
13697 				/* Send msg to other side. */
13698 				bzero(&msg.ua, sizeof(msg.ua));
13699 				msg.hdr.msg_type = CTL_MSG_UA;
13700 				msg.hdr.nexus.initid = -1;
13701 				msg.hdr.nexus.targ_port = -1;
13702 				msg.hdr.nexus.targ_lun = lun->lun;
13703 				msg.hdr.nexus.targ_mapped_lun = lun->lun;
13704 				msg.ua.ua_all = 1;
13705 				msg.ua.ua_set = (set > 0);
13706 				msg.ua.ua_type = CTL_UA_THIN_PROV_THRES;
13707 				memcpy(msg.ua.ua_info, lun->ua_tpt_info, 8);
13708 				mtx_unlock(&softc->ctl_lock); // XXX
13709 				ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg,
13710 				    sizeof(msg.ua), M_WAITOK);
13711 				mtx_lock(&softc->ctl_lock);
13712 			}
13713 		}
13714 		mtx_unlock(&softc->ctl_lock);
13715 		pause("-", CTL_LBP_PERIOD * hz);
13716 	}
13717 }
13718 
13719 static void
13720 ctl_enqueue_incoming(union ctl_io *io)
13721 {
13722 	struct ctl_softc *softc = control_softc;
13723 	struct ctl_thread *thr;
13724 	u_int idx;
13725 
13726 	idx = (io->io_hdr.nexus.targ_port * 127 +
13727 	       io->io_hdr.nexus.initid) % worker_threads;
13728 	thr = &softc->threads[idx];
13729 	mtx_lock(&thr->queue_lock);
13730 	STAILQ_INSERT_TAIL(&thr->incoming_queue, &io->io_hdr, links);
13731 	mtx_unlock(&thr->queue_lock);
13732 	wakeup(thr);
13733 }
13734 
13735 static void
13736 ctl_enqueue_rtr(union ctl_io *io)
13737 {
13738 	struct ctl_softc *softc = control_softc;
13739 	struct ctl_thread *thr;
13740 
13741 	thr = &softc->threads[io->io_hdr.nexus.targ_mapped_lun % worker_threads];
13742 	mtx_lock(&thr->queue_lock);
13743 	STAILQ_INSERT_TAIL(&thr->rtr_queue, &io->io_hdr, links);
13744 	mtx_unlock(&thr->queue_lock);
13745 	wakeup(thr);
13746 }
13747 
13748 static void
13749 ctl_enqueue_done(union ctl_io *io)
13750 {
13751 	struct ctl_softc *softc = control_softc;
13752 	struct ctl_thread *thr;
13753 
13754 	thr = &softc->threads[io->io_hdr.nexus.targ_mapped_lun % worker_threads];
13755 	mtx_lock(&thr->queue_lock);
13756 	STAILQ_INSERT_TAIL(&thr->done_queue, &io->io_hdr, links);
13757 	mtx_unlock(&thr->queue_lock);
13758 	wakeup(thr);
13759 }
13760 
13761 static void
13762 ctl_enqueue_isc(union ctl_io *io)
13763 {
13764 	struct ctl_softc *softc = control_softc;
13765 	struct ctl_thread *thr;
13766 
13767 	thr = &softc->threads[io->io_hdr.nexus.targ_mapped_lun % worker_threads];
13768 	mtx_lock(&thr->queue_lock);
13769 	STAILQ_INSERT_TAIL(&thr->isc_queue, &io->io_hdr, links);
13770 	mtx_unlock(&thr->queue_lock);
13771 	wakeup(thr);
13772 }
13773 
13774 /*
13775  *  vim: ts=8
13776  */
13777