ctl.c revision 311399
1/*-
2 * Copyright (c) 2003-2009 Silicon Graphics International Corp.
3 * Copyright (c) 2012 The FreeBSD Foundation
4 * Copyright (c) 2015 Alexander Motin <mav@FreeBSD.org>
5 * All rights reserved.
6 *
7 * Portions of this software were developed by Edward Tomasz Napierala
8 * under sponsorship from the FreeBSD Foundation.
9 *
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
12 * are met:
13 * 1. Redistributions of source code must retain the above copyright
14 *    notice, this list of conditions, and the following disclaimer,
15 *    without modification.
16 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
17 *    substantially similar to the "NO WARRANTY" disclaimer below
18 *    ("Disclaimer") and any redistribution must be conditioned upon
19 *    including a substantially similar Disclaimer requirement for further
20 *    binary redistribution.
21 *
22 * NO WARRANTY
23 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
24 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
25 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
26 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
27 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
31 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
32 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
33 * POSSIBILITY OF SUCH DAMAGES.
34 *
35 * $Id$
36 */
37/*
38 * CAM Target Layer, a SCSI device emulation subsystem.
39 *
40 * Author: Ken Merry <ken@FreeBSD.org>
41 */
42
43#define _CTL_C
44
45#include <sys/cdefs.h>
46__FBSDID("$FreeBSD: stable/11/sys/cam/ctl/ctl.c 311399 2017-01-05 11:03:58Z mav $");
47
48#include <sys/param.h>
49#include <sys/systm.h>
50#include <sys/ctype.h>
51#include <sys/kernel.h>
52#include <sys/types.h>
53#include <sys/kthread.h>
54#include <sys/bio.h>
55#include <sys/fcntl.h>
56#include <sys/lock.h>
57#include <sys/module.h>
58#include <sys/mutex.h>
59#include <sys/condvar.h>
60#include <sys/malloc.h>
61#include <sys/conf.h>
62#include <sys/ioccom.h>
63#include <sys/queue.h>
64#include <sys/sbuf.h>
65#include <sys/smp.h>
66#include <sys/endian.h>
67#include <sys/sysctl.h>
68#include <vm/uma.h>
69
70#include <cam/cam.h>
71#include <cam/scsi/scsi_all.h>
72#include <cam/scsi/scsi_cd.h>
73#include <cam/scsi/scsi_da.h>
74#include <cam/ctl/ctl_io.h>
75#include <cam/ctl/ctl.h>
76#include <cam/ctl/ctl_frontend.h>
77#include <cam/ctl/ctl_util.h>
78#include <cam/ctl/ctl_backend.h>
79#include <cam/ctl/ctl_ioctl.h>
80#include <cam/ctl/ctl_ha.h>
81#include <cam/ctl/ctl_private.h>
82#include <cam/ctl/ctl_debug.h>
83#include <cam/ctl/ctl_scsi_all.h>
84#include <cam/ctl/ctl_error.h>
85
86struct ctl_softc *control_softc = NULL;
87
88/*
89 * Template mode pages.
90 */
91
92/*
93 * Note that these are default values only.  The actual values will be
94 * filled in when the user does a mode sense.
95 */
96const static struct scsi_da_rw_recovery_page rw_er_page_default = {
97	/*page_code*/SMS_RW_ERROR_RECOVERY_PAGE,
98	/*page_length*/sizeof(struct scsi_da_rw_recovery_page) - 2,
99	/*byte3*/SMS_RWER_AWRE|SMS_RWER_ARRE,
100	/*read_retry_count*/0,
101	/*correction_span*/0,
102	/*head_offset_count*/0,
103	/*data_strobe_offset_cnt*/0,
104	/*byte8*/SMS_RWER_LBPERE,
105	/*write_retry_count*/0,
106	/*reserved2*/0,
107	/*recovery_time_limit*/{0, 0},
108};
109
110const static struct scsi_da_rw_recovery_page rw_er_page_changeable = {
111	/*page_code*/SMS_RW_ERROR_RECOVERY_PAGE,
112	/*page_length*/sizeof(struct scsi_da_rw_recovery_page) - 2,
113	/*byte3*/SMS_RWER_PER,
114	/*read_retry_count*/0,
115	/*correction_span*/0,
116	/*head_offset_count*/0,
117	/*data_strobe_offset_cnt*/0,
118	/*byte8*/SMS_RWER_LBPERE,
119	/*write_retry_count*/0,
120	/*reserved2*/0,
121	/*recovery_time_limit*/{0, 0},
122};
123
124const static struct scsi_format_page format_page_default = {
125	/*page_code*/SMS_FORMAT_DEVICE_PAGE,
126	/*page_length*/sizeof(struct scsi_format_page) - 2,
127	/*tracks_per_zone*/ {0, 0},
128	/*alt_sectors_per_zone*/ {0, 0},
129	/*alt_tracks_per_zone*/ {0, 0},
130	/*alt_tracks_per_lun*/ {0, 0},
131	/*sectors_per_track*/ {(CTL_DEFAULT_SECTORS_PER_TRACK >> 8) & 0xff,
132			        CTL_DEFAULT_SECTORS_PER_TRACK & 0xff},
133	/*bytes_per_sector*/ {0, 0},
134	/*interleave*/ {0, 0},
135	/*track_skew*/ {0, 0},
136	/*cylinder_skew*/ {0, 0},
137	/*flags*/ SFP_HSEC,
138	/*reserved*/ {0, 0, 0}
139};
140
141const static struct scsi_format_page format_page_changeable = {
142	/*page_code*/SMS_FORMAT_DEVICE_PAGE,
143	/*page_length*/sizeof(struct scsi_format_page) - 2,
144	/*tracks_per_zone*/ {0, 0},
145	/*alt_sectors_per_zone*/ {0, 0},
146	/*alt_tracks_per_zone*/ {0, 0},
147	/*alt_tracks_per_lun*/ {0, 0},
148	/*sectors_per_track*/ {0, 0},
149	/*bytes_per_sector*/ {0, 0},
150	/*interleave*/ {0, 0},
151	/*track_skew*/ {0, 0},
152	/*cylinder_skew*/ {0, 0},
153	/*flags*/ 0,
154	/*reserved*/ {0, 0, 0}
155};
156
157const static struct scsi_rigid_disk_page rigid_disk_page_default = {
158	/*page_code*/SMS_RIGID_DISK_PAGE,
159	/*page_length*/sizeof(struct scsi_rigid_disk_page) - 2,
160	/*cylinders*/ {0, 0, 0},
161	/*heads*/ CTL_DEFAULT_HEADS,
162	/*start_write_precomp*/ {0, 0, 0},
163	/*start_reduced_current*/ {0, 0, 0},
164	/*step_rate*/ {0, 0},
165	/*landing_zone_cylinder*/ {0, 0, 0},
166	/*rpl*/ SRDP_RPL_DISABLED,
167	/*rotational_offset*/ 0,
168	/*reserved1*/ 0,
169	/*rotation_rate*/ {(CTL_DEFAULT_ROTATION_RATE >> 8) & 0xff,
170			   CTL_DEFAULT_ROTATION_RATE & 0xff},
171	/*reserved2*/ {0, 0}
172};
173
174const static struct scsi_rigid_disk_page rigid_disk_page_changeable = {
175	/*page_code*/SMS_RIGID_DISK_PAGE,
176	/*page_length*/sizeof(struct scsi_rigid_disk_page) - 2,
177	/*cylinders*/ {0, 0, 0},
178	/*heads*/ 0,
179	/*start_write_precomp*/ {0, 0, 0},
180	/*start_reduced_current*/ {0, 0, 0},
181	/*step_rate*/ {0, 0},
182	/*landing_zone_cylinder*/ {0, 0, 0},
183	/*rpl*/ 0,
184	/*rotational_offset*/ 0,
185	/*reserved1*/ 0,
186	/*rotation_rate*/ {0, 0},
187	/*reserved2*/ {0, 0}
188};
189
190const static struct scsi_da_verify_recovery_page verify_er_page_default = {
191	/*page_code*/SMS_VERIFY_ERROR_RECOVERY_PAGE,
192	/*page_length*/sizeof(struct scsi_da_verify_recovery_page) - 2,
193	/*byte3*/0,
194	/*read_retry_count*/0,
195	/*reserved*/{ 0, 0, 0, 0, 0, 0 },
196	/*recovery_time_limit*/{0, 0},
197};
198
199const static struct scsi_da_verify_recovery_page verify_er_page_changeable = {
200	/*page_code*/SMS_VERIFY_ERROR_RECOVERY_PAGE,
201	/*page_length*/sizeof(struct scsi_da_verify_recovery_page) - 2,
202	/*byte3*/SMS_VER_PER,
203	/*read_retry_count*/0,
204	/*reserved*/{ 0, 0, 0, 0, 0, 0 },
205	/*recovery_time_limit*/{0, 0},
206};
207
208const static struct scsi_caching_page caching_page_default = {
209	/*page_code*/SMS_CACHING_PAGE,
210	/*page_length*/sizeof(struct scsi_caching_page) - 2,
211	/*flags1*/ SCP_DISC | SCP_WCE,
212	/*ret_priority*/ 0,
213	/*disable_pf_transfer_len*/ {0xff, 0xff},
214	/*min_prefetch*/ {0, 0},
215	/*max_prefetch*/ {0xff, 0xff},
216	/*max_pf_ceiling*/ {0xff, 0xff},
217	/*flags2*/ 0,
218	/*cache_segments*/ 0,
219	/*cache_seg_size*/ {0, 0},
220	/*reserved*/ 0,
221	/*non_cache_seg_size*/ {0, 0, 0}
222};
223
224const static struct scsi_caching_page caching_page_changeable = {
225	/*page_code*/SMS_CACHING_PAGE,
226	/*page_length*/sizeof(struct scsi_caching_page) - 2,
227	/*flags1*/ SCP_WCE | SCP_RCD,
228	/*ret_priority*/ 0,
229	/*disable_pf_transfer_len*/ {0, 0},
230	/*min_prefetch*/ {0, 0},
231	/*max_prefetch*/ {0, 0},
232	/*max_pf_ceiling*/ {0, 0},
233	/*flags2*/ 0,
234	/*cache_segments*/ 0,
235	/*cache_seg_size*/ {0, 0},
236	/*reserved*/ 0,
237	/*non_cache_seg_size*/ {0, 0, 0}
238};
239
240const static struct scsi_control_page control_page_default = {
241	/*page_code*/SMS_CONTROL_MODE_PAGE,
242	/*page_length*/sizeof(struct scsi_control_page) - 2,
243	/*rlec*/0,
244	/*queue_flags*/SCP_QUEUE_ALG_RESTRICTED,
245	/*eca_and_aen*/0,
246	/*flags4*/SCP_TAS,
247	/*aen_holdoff_period*/{0, 0},
248	/*busy_timeout_period*/{0, 0},
249	/*extended_selftest_completion_time*/{0, 0}
250};
251
252const static struct scsi_control_page control_page_changeable = {
253	/*page_code*/SMS_CONTROL_MODE_PAGE,
254	/*page_length*/sizeof(struct scsi_control_page) - 2,
255	/*rlec*/SCP_DSENSE,
256	/*queue_flags*/SCP_QUEUE_ALG_MASK,
257	/*eca_and_aen*/SCP_SWP,
258	/*flags4*/0,
259	/*aen_holdoff_period*/{0, 0},
260	/*busy_timeout_period*/{0, 0},
261	/*extended_selftest_completion_time*/{0, 0}
262};
263
264#define CTL_CEM_LEN	(sizeof(struct scsi_control_ext_page) - 4)
265
266const static struct scsi_control_ext_page control_ext_page_default = {
267	/*page_code*/SMS_CONTROL_MODE_PAGE | SMPH_SPF,
268	/*subpage_code*/0x01,
269	/*page_length*/{CTL_CEM_LEN >> 8, CTL_CEM_LEN},
270	/*flags*/0,
271	/*prio*/0,
272	/*max_sense*/0
273};
274
275const static struct scsi_control_ext_page control_ext_page_changeable = {
276	/*page_code*/SMS_CONTROL_MODE_PAGE | SMPH_SPF,
277	/*subpage_code*/0x01,
278	/*page_length*/{CTL_CEM_LEN >> 8, CTL_CEM_LEN},
279	/*flags*/0,
280	/*prio*/0,
281	/*max_sense*/0
282};
283
284const static struct scsi_info_exceptions_page ie_page_default = {
285	/*page_code*/SMS_INFO_EXCEPTIONS_PAGE,
286	/*page_length*/sizeof(struct scsi_info_exceptions_page) - 2,
287	/*info_flags*/SIEP_FLAGS_EWASC,
288	/*mrie*/SIEP_MRIE_NO,
289	/*interval_timer*/{0, 0, 0, 0},
290	/*report_count*/{0, 0, 0, 1}
291};
292
293const static struct scsi_info_exceptions_page ie_page_changeable = {
294	/*page_code*/SMS_INFO_EXCEPTIONS_PAGE,
295	/*page_length*/sizeof(struct scsi_info_exceptions_page) - 2,
296	/*info_flags*/SIEP_FLAGS_EWASC | SIEP_FLAGS_DEXCPT | SIEP_FLAGS_TEST |
297	    SIEP_FLAGS_LOGERR,
298	/*mrie*/0x0f,
299	/*interval_timer*/{0xff, 0xff, 0xff, 0xff},
300	/*report_count*/{0xff, 0xff, 0xff, 0xff}
301};
302
303#define CTL_LBPM_LEN	(sizeof(struct ctl_logical_block_provisioning_page) - 4)
304
305const static struct ctl_logical_block_provisioning_page lbp_page_default = {{
306	/*page_code*/SMS_INFO_EXCEPTIONS_PAGE | SMPH_SPF,
307	/*subpage_code*/0x02,
308	/*page_length*/{CTL_LBPM_LEN >> 8, CTL_LBPM_LEN},
309	/*flags*/0,
310	/*reserved*/{0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0},
311	/*descr*/{}},
312	{{/*flags*/0,
313	  /*resource*/0x01,
314	  /*reserved*/{0, 0},
315	  /*count*/{0, 0, 0, 0}},
316	 {/*flags*/0,
317	  /*resource*/0x02,
318	  /*reserved*/{0, 0},
319	  /*count*/{0, 0, 0, 0}},
320	 {/*flags*/0,
321	  /*resource*/0xf1,
322	  /*reserved*/{0, 0},
323	  /*count*/{0, 0, 0, 0}},
324	 {/*flags*/0,
325	  /*resource*/0xf2,
326	  /*reserved*/{0, 0},
327	  /*count*/{0, 0, 0, 0}}
328	}
329};
330
331const static struct ctl_logical_block_provisioning_page lbp_page_changeable = {{
332	/*page_code*/SMS_INFO_EXCEPTIONS_PAGE | SMPH_SPF,
333	/*subpage_code*/0x02,
334	/*page_length*/{CTL_LBPM_LEN >> 8, CTL_LBPM_LEN},
335	/*flags*/0,
336	/*reserved*/{0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0},
337	/*descr*/{}},
338	{{/*flags*/0,
339	  /*resource*/0,
340	  /*reserved*/{0, 0},
341	  /*count*/{0, 0, 0, 0}},
342	 {/*flags*/0,
343	  /*resource*/0,
344	  /*reserved*/{0, 0},
345	  /*count*/{0, 0, 0, 0}},
346	 {/*flags*/0,
347	  /*resource*/0,
348	  /*reserved*/{0, 0},
349	  /*count*/{0, 0, 0, 0}},
350	 {/*flags*/0,
351	  /*resource*/0,
352	  /*reserved*/{0, 0},
353	  /*count*/{0, 0, 0, 0}}
354	}
355};
356
357const static struct scsi_cddvd_capabilities_page cddvd_page_default = {
358	/*page_code*/SMS_CDDVD_CAPS_PAGE,
359	/*page_length*/sizeof(struct scsi_cddvd_capabilities_page) - 2,
360	/*caps1*/0x3f,
361	/*caps2*/0x00,
362	/*caps3*/0xf0,
363	/*caps4*/0x00,
364	/*caps5*/0x29,
365	/*caps6*/0x00,
366	/*obsolete*/{0, 0},
367	/*nvol_levels*/{0, 0},
368	/*buffer_size*/{8, 0},
369	/*obsolete2*/{0, 0},
370	/*reserved*/0,
371	/*digital*/0,
372	/*obsolete3*/0,
373	/*copy_management*/0,
374	/*reserved2*/0,
375	/*rotation_control*/0,
376	/*cur_write_speed*/0,
377	/*num_speed_descr*/0,
378};
379
380const static struct scsi_cddvd_capabilities_page cddvd_page_changeable = {
381	/*page_code*/SMS_CDDVD_CAPS_PAGE,
382	/*page_length*/sizeof(struct scsi_cddvd_capabilities_page) - 2,
383	/*caps1*/0,
384	/*caps2*/0,
385	/*caps3*/0,
386	/*caps4*/0,
387	/*caps5*/0,
388	/*caps6*/0,
389	/*obsolete*/{0, 0},
390	/*nvol_levels*/{0, 0},
391	/*buffer_size*/{0, 0},
392	/*obsolete2*/{0, 0},
393	/*reserved*/0,
394	/*digital*/0,
395	/*obsolete3*/0,
396	/*copy_management*/0,
397	/*reserved2*/0,
398	/*rotation_control*/0,
399	/*cur_write_speed*/0,
400	/*num_speed_descr*/0,
401};
402
403SYSCTL_NODE(_kern_cam, OID_AUTO, ctl, CTLFLAG_RD, 0, "CAM Target Layer");
404static int worker_threads = -1;
405SYSCTL_INT(_kern_cam_ctl, OID_AUTO, worker_threads, CTLFLAG_RDTUN,
406    &worker_threads, 1, "Number of worker threads");
407static int ctl_debug = CTL_DEBUG_NONE;
408SYSCTL_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
419static void ctl_isc_event_handler(ctl_ha_channel chanel, ctl_ha_event event,
420				  int param);
421static void ctl_copy_sense_data(union ctl_ha_msg *src, union ctl_io *dest);
422static void ctl_copy_sense_data_back(union ctl_io *src, union ctl_ha_msg *dest);
423static int ctl_init(void);
424void ctl_shutdown(void);
425static int ctl_open(struct cdev *dev, int flags, int fmt, struct thread *td);
426static int ctl_close(struct cdev *dev, int flags, int fmt, struct thread *td);
427static int ctl_serialize_other_sc_cmd(struct ctl_scsiio *ctsio);
428static 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);
431static int ctl_ioctl(struct cdev *dev, u_long cmd, caddr_t addr, int flag,
432		     struct thread *td);
433static int ctl_alloc_lun(struct ctl_softc *ctl_softc, struct ctl_lun *lun,
434			 struct ctl_be_lun *be_lun);
435static int ctl_free_lun(struct ctl_lun *lun);
436static void ctl_create_lun(struct ctl_be_lun *be_lun);
437static struct ctl_port * ctl_io_port(struct ctl_io_hdr *io_hdr);
438
439static int ctl_do_mode_select(union ctl_io *io);
440static 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);
446static void ctl_pro_preempt_other(struct ctl_lun *lun,
447				  union ctl_ha_msg *msg);
448static void ctl_hndl_per_res_out_on_other_sc(union ctl_ha_msg *msg);
449static int ctl_inquiry_evpd_supported(struct ctl_scsiio *ctsio, int alloc_len);
450static int ctl_inquiry_evpd_serial(struct ctl_scsiio *ctsio, int alloc_len);
451static int ctl_inquiry_evpd_devid(struct ctl_scsiio *ctsio, int alloc_len);
452static int ctl_inquiry_evpd_eid(struct ctl_scsiio *ctsio, int alloc_len);
453static int ctl_inquiry_evpd_mpp(struct ctl_scsiio *ctsio, int alloc_len);
454static int ctl_inquiry_evpd_scsi_ports(struct ctl_scsiio *ctsio,
455					 int alloc_len);
456static int ctl_inquiry_evpd_block_limits(struct ctl_scsiio *ctsio,
457					 int alloc_len);
458static int ctl_inquiry_evpd_bdc(struct ctl_scsiio *ctsio, int alloc_len);
459static int ctl_inquiry_evpd_lbp(struct ctl_scsiio *ctsio, int alloc_len);
460static int ctl_inquiry_evpd(struct ctl_scsiio *ctsio);
461static int ctl_inquiry_std(struct ctl_scsiio *ctsio);
462static int ctl_get_lba_len(union ctl_io *io, uint64_t *lba, uint64_t *len);
463static ctl_action ctl_extent_check(union ctl_io *io1, union ctl_io *io2,
464    bool seq);
465static ctl_action ctl_extent_check_seq(union ctl_io *io1, union ctl_io *io2);
466static ctl_action ctl_check_for_blockage(struct ctl_lun *lun,
467    union ctl_io *pending_io, union ctl_io *ooa_io);
468static ctl_action ctl_check_ooa(struct ctl_lun *lun, union ctl_io *pending_io,
469				union ctl_io *starting_io);
470static int ctl_check_blocked(struct ctl_lun *lun);
471static int ctl_scsiio_lun_check(struct ctl_lun *lun,
472				const struct ctl_cmd_entry *entry,
473				struct ctl_scsiio *ctsio);
474static void ctl_failover_lun(union ctl_io *io);
475static int ctl_scsiio_precheck(struct ctl_softc *ctl_softc,
476			       struct ctl_scsiio *ctsio);
477static int ctl_scsiio(struct ctl_scsiio *ctsio);
478
479static int ctl_bus_reset(struct ctl_softc *ctl_softc, union ctl_io *io);
480static int ctl_target_reset(struct ctl_softc *ctl_softc, union ctl_io *io,
481			    ctl_ua_type ua_type);
482static int ctl_do_lun_reset(struct ctl_lun *lun, union ctl_io *io,
483			 ctl_ua_type ua_type);
484static int ctl_lun_reset(struct ctl_softc *ctl_softc, union ctl_io *io);
485static int ctl_abort_task(union ctl_io *io);
486static int ctl_abort_task_set(union ctl_io *io);
487static int ctl_query_task(union ctl_io *io, int task_set);
488static int ctl_i_t_nexus_reset(union ctl_io *io);
489static int ctl_query_async_event(union ctl_io *io);
490static void ctl_run_task(union ctl_io *io);
491#ifdef CTL_IO_DELAY
492static void ctl_datamove_timer_wakeup(void *arg);
493static void ctl_done_timer_wakeup(void *arg);
494#endif /* CTL_IO_DELAY */
495
496static void ctl_send_datamove_done(union ctl_io *io, int have_lock);
497static void ctl_datamove_remote_write_cb(struct ctl_ha_dt_req *rq);
498static int ctl_datamove_remote_dm_write_cb(union ctl_io *io);
499static void ctl_datamove_remote_write(union ctl_io *io);
500static int ctl_datamove_remote_dm_read_cb(union ctl_io *io);
501static void ctl_datamove_remote_read_cb(struct ctl_ha_dt_req *rq);
502static int ctl_datamove_remote_sgl_setup(union ctl_io *io);
503static int ctl_datamove_remote_xfer(union ctl_io *io, unsigned command,
504				    ctl_ha_dt_cb callback);
505static void ctl_datamove_remote_read(union ctl_io *io);
506static void ctl_datamove_remote(union ctl_io *io);
507static void ctl_process_done(union ctl_io *io);
508static void ctl_lun_thread(void *arg);
509static void ctl_thresh_thread(void *arg);
510static void ctl_work_thread(void *arg);
511static void ctl_enqueue_incoming(union ctl_io *io);
512static void ctl_enqueue_rtr(union ctl_io *io);
513static void ctl_enqueue_done(union ctl_io *io);
514static void ctl_enqueue_isc(union ctl_io *io);
515static const struct ctl_cmd_entry *
516    ctl_get_cmd_entry(struct ctl_scsiio *ctsio, int *sa);
517static const struct ctl_cmd_entry *
518    ctl_validate_command(struct ctl_scsiio *ctsio);
519static int ctl_cmd_applicable(uint8_t lun_type,
520    const struct ctl_cmd_entry *entry);
521
522static uint64_t ctl_get_prkey(struct ctl_lun *lun, uint32_t residx);
523static void ctl_clr_prkey(struct ctl_lun *lun, uint32_t residx);
524static void ctl_alloc_prkey(struct ctl_lun *lun, uint32_t residx);
525static 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 */
536static 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
546MALLOC_DEFINE(M_CTL, "ctlmem", "Memory used for CTL");
547
548static int ctl_module_event_handler(module_t, int /*modeventtype_t*/, void *);
549
550static moduledata_t ctl_moduledata = {
551	"ctl",
552	ctl_module_event_handler,
553	NULL
554};
555
556DECLARE_MODULE(ctl, ctl_moduledata, SI_SUB_CONFIGURE, SI_ORDER_THIRD);
557MODULE_VERSION(ctl, 1);
558
559static struct ctl_frontend ha_frontend =
560{
561	.name = "ha",
562};
563
564static void
565ctl_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
683static void
684ctl_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
709static void
710ctl_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
734static void
735ctl_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
751void
752ctl_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;
766alloc:
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
816void
817ctl_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
877void
878ctl_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
913void
914ctl_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	u_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
950static void
951ctl_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
980static void
981ctl_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
1020static void
1021ctl_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
1050static void
1051ctl_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
1122static void
1123ctl_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
1230static void
1231ctl_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
1253static void
1254ctl_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
1283static void
1284ctl_isc_mode_sync(struct ctl_softc *softc, union ctl_ha_msg *msg, int len)
1285{
1286	struct ctl_lun *lun;
1287	u_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 */
1325static void
1326ctl_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
1633static void
1634ctl_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
1644static void
1645ctl_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
1655void
1656ctl_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
1670void
1671ctl_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
1685void
1686ctl_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
1696void
1697ctl_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
1711void
1712ctl_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
1729void
1730ctl_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
1743static int
1744ctl_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
1778static int
1779ctl_init(void)
1780{
1781	struct make_dev_args args;
1782	struct ctl_softc *softc;
1783	void *other_pool;
1784	int i, error;
1785
1786	softc = control_softc = malloc(sizeof(*control_softc), M_DEVBUF,
1787			       M_WAITOK | M_ZERO);
1788
1789	make_dev_args_init(&args);
1790	args.mda_devsw = &ctl_cdevsw;
1791	args.mda_uid = UID_ROOT;
1792	args.mda_gid = GID_OPERATOR;
1793	args.mda_mode = 0600;
1794	args.mda_si_drv1 = softc;
1795	error = make_dev_s(&args, &softc->dev, "cam/ctl");
1796	if (error != 0) {
1797		free(control_softc, M_DEVBUF);
1798		return (error);
1799	}
1800
1801	sysctl_ctx_init(&softc->sysctl_ctx);
1802	softc->sysctl_tree = SYSCTL_ADD_NODE(&softc->sysctl_ctx,
1803		SYSCTL_STATIC_CHILDREN(_kern_cam), OID_AUTO, "ctl",
1804		CTLFLAG_RD, 0, "CAM Target Layer");
1805
1806	if (softc->sysctl_tree == NULL) {
1807		printf("%s: unable to allocate sysctl tree\n", __func__);
1808		destroy_dev(softc->dev);
1809		free(control_softc, M_DEVBUF);
1810		control_softc = NULL;
1811		return (ENOMEM);
1812	}
1813
1814	mtx_init(&softc->ctl_lock, "CTL mutex", NULL, MTX_DEF);
1815	softc->io_zone = uma_zcreate("CTL IO", sizeof(union ctl_io),
1816	    NULL, NULL, NULL, NULL, UMA_ALIGN_PTR, 0);
1817	softc->flags = 0;
1818
1819	SYSCTL_ADD_INT(&softc->sysctl_ctx, SYSCTL_CHILDREN(softc->sysctl_tree),
1820	    OID_AUTO, "ha_mode", CTLFLAG_RDTUN, (int *)&softc->ha_mode, 0,
1821	    "HA mode (0 - act/stby, 1 - serialize only, 2 - xfer)");
1822
1823	/*
1824	 * In Copan's HA scheme, the "master" and "slave" roles are
1825	 * figured out through the slot the controller is in.  Although it
1826	 * is an active/active system, someone has to be in charge.
1827	 */
1828	SYSCTL_ADD_INT(&softc->sysctl_ctx, SYSCTL_CHILDREN(softc->sysctl_tree),
1829	    OID_AUTO, "ha_id", CTLFLAG_RDTUN, &softc->ha_id, 0,
1830	    "HA head ID (0 - no HA)");
1831	if (softc->ha_id == 0 || softc->ha_id > NUM_HA_SHELVES) {
1832		softc->flags |= CTL_FLAG_ACTIVE_SHELF;
1833		softc->is_single = 1;
1834		softc->port_cnt = CTL_MAX_PORTS;
1835		softc->port_min = 0;
1836	} else {
1837		softc->port_cnt = CTL_MAX_PORTS / NUM_HA_SHELVES;
1838		softc->port_min = (softc->ha_id - 1) * softc->port_cnt;
1839	}
1840	softc->port_max = softc->port_min + softc->port_cnt;
1841	softc->init_min = softc->port_min * CTL_MAX_INIT_PER_PORT;
1842	softc->init_max = softc->port_max * CTL_MAX_INIT_PER_PORT;
1843
1844	SYSCTL_ADD_INT(&softc->sysctl_ctx, SYSCTL_CHILDREN(softc->sysctl_tree),
1845	    OID_AUTO, "ha_link", CTLFLAG_RD, (int *)&softc->ha_link, 0,
1846	    "HA link state (0 - offline, 1 - unknown, 2 - online)");
1847
1848	STAILQ_INIT(&softc->lun_list);
1849	STAILQ_INIT(&softc->pending_lun_queue);
1850	STAILQ_INIT(&softc->fe_list);
1851	STAILQ_INIT(&softc->port_list);
1852	STAILQ_INIT(&softc->be_list);
1853	ctl_tpc_init(softc);
1854
1855	if (ctl_pool_create(softc, "othersc", CTL_POOL_ENTRIES_OTHER_SC,
1856	                    &other_pool) != 0)
1857	{
1858		printf("ctl: can't allocate %d entry other SC pool, "
1859		       "exiting\n", CTL_POOL_ENTRIES_OTHER_SC);
1860		return (ENOMEM);
1861	}
1862	softc->othersc_pool = other_pool;
1863
1864	if (worker_threads <= 0)
1865		worker_threads = max(1, mp_ncpus / 4);
1866	if (worker_threads > CTL_MAX_THREADS)
1867		worker_threads = CTL_MAX_THREADS;
1868
1869	for (i = 0; i < worker_threads; i++) {
1870		struct ctl_thread *thr = &softc->threads[i];
1871
1872		mtx_init(&thr->queue_lock, "CTL queue mutex", NULL, MTX_DEF);
1873		thr->ctl_softc = softc;
1874		STAILQ_INIT(&thr->incoming_queue);
1875		STAILQ_INIT(&thr->rtr_queue);
1876		STAILQ_INIT(&thr->done_queue);
1877		STAILQ_INIT(&thr->isc_queue);
1878
1879		error = kproc_kthread_add(ctl_work_thread, thr,
1880		    &softc->ctl_proc, &thr->thread, 0, 0, "ctl", "work%d", i);
1881		if (error != 0) {
1882			printf("error creating CTL work thread!\n");
1883			ctl_pool_free(other_pool);
1884			return (error);
1885		}
1886	}
1887	error = kproc_kthread_add(ctl_lun_thread, softc,
1888	    &softc->ctl_proc, NULL, 0, 0, "ctl", "lun");
1889	if (error != 0) {
1890		printf("error creating CTL lun thread!\n");
1891		ctl_pool_free(other_pool);
1892		return (error);
1893	}
1894	error = kproc_kthread_add(ctl_thresh_thread, softc,
1895	    &softc->ctl_proc, NULL, 0, 0, "ctl", "thresh");
1896	if (error != 0) {
1897		printf("error creating CTL threshold thread!\n");
1898		ctl_pool_free(other_pool);
1899		return (error);
1900	}
1901
1902	SYSCTL_ADD_PROC(&softc->sysctl_ctx,SYSCTL_CHILDREN(softc->sysctl_tree),
1903	    OID_AUTO, "ha_role", CTLTYPE_INT | CTLFLAG_RWTUN,
1904	    softc, 0, ctl_ha_role_sysctl, "I", "HA role for this head");
1905
1906	if (softc->is_single == 0) {
1907		ctl_frontend_register(&ha_frontend);
1908		if (ctl_ha_msg_init(softc) != CTL_HA_STATUS_SUCCESS) {
1909			printf("ctl_init: ctl_ha_msg_init failed.\n");
1910			softc->is_single = 1;
1911		} else
1912		if (ctl_ha_msg_register(CTL_HA_CHAN_CTL, ctl_isc_event_handler)
1913		    != CTL_HA_STATUS_SUCCESS) {
1914			printf("ctl_init: ctl_ha_msg_register failed.\n");
1915			softc->is_single = 1;
1916		}
1917	}
1918	return (0);
1919}
1920
1921void
1922ctl_shutdown(void)
1923{
1924	struct ctl_softc *softc = control_softc;
1925	struct ctl_lun *lun, *next_lun;
1926
1927	if (softc->is_single == 0) {
1928		ctl_ha_msg_shutdown(softc);
1929		if (ctl_ha_msg_deregister(CTL_HA_CHAN_CTL)
1930		    != CTL_HA_STATUS_SUCCESS)
1931			printf("%s: ctl_ha_msg_deregister failed.\n", __func__);
1932		if (ctl_ha_msg_destroy(softc) != CTL_HA_STATUS_SUCCESS)
1933			printf("%s: ctl_ha_msg_destroy failed.\n", __func__);
1934		ctl_frontend_deregister(&ha_frontend);
1935	}
1936
1937	mtx_lock(&softc->ctl_lock);
1938
1939	STAILQ_FOREACH_SAFE(lun, &softc->lun_list, links, next_lun)
1940		ctl_free_lun(lun);
1941
1942	mtx_unlock(&softc->ctl_lock);
1943
1944#if 0
1945	ctl_shutdown_thread(softc->work_thread);
1946	mtx_destroy(&softc->queue_lock);
1947#endif
1948
1949	ctl_tpc_shutdown(softc);
1950	uma_zdestroy(softc->io_zone);
1951	mtx_destroy(&softc->ctl_lock);
1952
1953	destroy_dev(softc->dev);
1954
1955	sysctl_ctx_free(&softc->sysctl_ctx);
1956
1957	free(control_softc, M_DEVBUF);
1958	control_softc = NULL;
1959}
1960
1961static int
1962ctl_module_event_handler(module_t mod, int what, void *arg)
1963{
1964
1965	switch (what) {
1966	case MOD_LOAD:
1967		return (ctl_init());
1968	case MOD_UNLOAD:
1969		return (EBUSY);
1970	default:
1971		return (EOPNOTSUPP);
1972	}
1973}
1974
1975/*
1976 * XXX KDM should we do some access checks here?  Bump a reference count to
1977 * prevent a CTL module from being unloaded while someone has it open?
1978 */
1979static int
1980ctl_open(struct cdev *dev, int flags, int fmt, struct thread *td)
1981{
1982	return (0);
1983}
1984
1985static int
1986ctl_close(struct cdev *dev, int flags, int fmt, struct thread *td)
1987{
1988	return (0);
1989}
1990
1991/*
1992 * Remove an initiator by port number and initiator ID.
1993 * Returns 0 for success, -1 for failure.
1994 */
1995int
1996ctl_remove_initiator(struct ctl_port *port, int iid)
1997{
1998	struct ctl_softc *softc = port->ctl_softc;
1999
2000	mtx_assert(&softc->ctl_lock, MA_NOTOWNED);
2001
2002	if (iid > CTL_MAX_INIT_PER_PORT) {
2003		printf("%s: initiator ID %u > maximun %u!\n",
2004		       __func__, iid, CTL_MAX_INIT_PER_PORT);
2005		return (-1);
2006	}
2007
2008	mtx_lock(&softc->ctl_lock);
2009	port->wwpn_iid[iid].in_use--;
2010	port->wwpn_iid[iid].last_use = time_uptime;
2011	mtx_unlock(&softc->ctl_lock);
2012	ctl_isc_announce_iid(port, iid);
2013
2014	return (0);
2015}
2016
2017/*
2018 * Add an initiator to the initiator map.
2019 * Returns iid for success, < 0 for failure.
2020 */
2021int
2022ctl_add_initiator(struct ctl_port *port, int iid, uint64_t wwpn, char *name)
2023{
2024	struct ctl_softc *softc = port->ctl_softc;
2025	time_t best_time;
2026	int i, best;
2027
2028	mtx_assert(&softc->ctl_lock, MA_NOTOWNED);
2029
2030	if (iid >= CTL_MAX_INIT_PER_PORT) {
2031		printf("%s: WWPN %#jx initiator ID %u > maximum %u!\n",
2032		       __func__, wwpn, iid, CTL_MAX_INIT_PER_PORT);
2033		free(name, M_CTL);
2034		return (-1);
2035	}
2036
2037	mtx_lock(&softc->ctl_lock);
2038
2039	if (iid < 0 && (wwpn != 0 || name != NULL)) {
2040		for (i = 0; i < CTL_MAX_INIT_PER_PORT; i++) {
2041			if (wwpn != 0 && wwpn == port->wwpn_iid[i].wwpn) {
2042				iid = i;
2043				break;
2044			}
2045			if (name != NULL && port->wwpn_iid[i].name != NULL &&
2046			    strcmp(name, port->wwpn_iid[i].name) == 0) {
2047				iid = i;
2048				break;
2049			}
2050		}
2051	}
2052
2053	if (iid < 0) {
2054		for (i = 0; i < CTL_MAX_INIT_PER_PORT; i++) {
2055			if (port->wwpn_iid[i].in_use == 0 &&
2056			    port->wwpn_iid[i].wwpn == 0 &&
2057			    port->wwpn_iid[i].name == NULL) {
2058				iid = i;
2059				break;
2060			}
2061		}
2062	}
2063
2064	if (iid < 0) {
2065		best = -1;
2066		best_time = INT32_MAX;
2067		for (i = 0; i < CTL_MAX_INIT_PER_PORT; i++) {
2068			if (port->wwpn_iid[i].in_use == 0) {
2069				if (port->wwpn_iid[i].last_use < best_time) {
2070					best = i;
2071					best_time = port->wwpn_iid[i].last_use;
2072				}
2073			}
2074		}
2075		iid = best;
2076	}
2077
2078	if (iid < 0) {
2079		mtx_unlock(&softc->ctl_lock);
2080		free(name, M_CTL);
2081		return (-2);
2082	}
2083
2084	if (port->wwpn_iid[iid].in_use > 0 && (wwpn != 0 || name != NULL)) {
2085		/*
2086		 * This is not an error yet.
2087		 */
2088		if (wwpn != 0 && wwpn == port->wwpn_iid[iid].wwpn) {
2089#if 0
2090			printf("%s: port %d iid %u WWPN %#jx arrived"
2091			    " again\n", __func__, port->targ_port,
2092			    iid, (uintmax_t)wwpn);
2093#endif
2094			goto take;
2095		}
2096		if (name != NULL && port->wwpn_iid[iid].name != NULL &&
2097		    strcmp(name, port->wwpn_iid[iid].name) == 0) {
2098#if 0
2099			printf("%s: port %d iid %u name '%s' arrived"
2100			    " again\n", __func__, port->targ_port,
2101			    iid, name);
2102#endif
2103			goto take;
2104		}
2105
2106		/*
2107		 * This is an error, but what do we do about it?  The
2108		 * driver is telling us we have a new WWPN for this
2109		 * initiator ID, so we pretty much need to use it.
2110		 */
2111		printf("%s: port %d iid %u WWPN %#jx '%s' arrived,"
2112		    " but WWPN %#jx '%s' is still at that address\n",
2113		    __func__, port->targ_port, iid, wwpn, name,
2114		    (uintmax_t)port->wwpn_iid[iid].wwpn,
2115		    port->wwpn_iid[iid].name);
2116
2117		/*
2118		 * XXX KDM clear have_ca and ua_pending on each LUN for
2119		 * this initiator.
2120		 */
2121	}
2122take:
2123	free(port->wwpn_iid[iid].name, M_CTL);
2124	port->wwpn_iid[iid].name = name;
2125	port->wwpn_iid[iid].wwpn = wwpn;
2126	port->wwpn_iid[iid].in_use++;
2127	mtx_unlock(&softc->ctl_lock);
2128	ctl_isc_announce_iid(port, iid);
2129
2130	return (iid);
2131}
2132
2133static int
2134ctl_create_iid(struct ctl_port *port, int iid, uint8_t *buf)
2135{
2136	int len;
2137
2138	switch (port->port_type) {
2139	case CTL_PORT_FC:
2140	{
2141		struct scsi_transportid_fcp *id =
2142		    (struct scsi_transportid_fcp *)buf;
2143		if (port->wwpn_iid[iid].wwpn == 0)
2144			return (0);
2145		memset(id, 0, sizeof(*id));
2146		id->format_protocol = SCSI_PROTO_FC;
2147		scsi_u64to8b(port->wwpn_iid[iid].wwpn, id->n_port_name);
2148		return (sizeof(*id));
2149	}
2150	case CTL_PORT_ISCSI:
2151	{
2152		struct scsi_transportid_iscsi_port *id =
2153		    (struct scsi_transportid_iscsi_port *)buf;
2154		if (port->wwpn_iid[iid].name == NULL)
2155			return (0);
2156		memset(id, 0, 256);
2157		id->format_protocol = SCSI_TRN_ISCSI_FORMAT_PORT |
2158		    SCSI_PROTO_ISCSI;
2159		len = strlcpy(id->iscsi_name, port->wwpn_iid[iid].name, 252) + 1;
2160		len = roundup2(min(len, 252), 4);
2161		scsi_ulto2b(len, id->additional_length);
2162		return (sizeof(*id) + len);
2163	}
2164	case CTL_PORT_SAS:
2165	{
2166		struct scsi_transportid_sas *id =
2167		    (struct scsi_transportid_sas *)buf;
2168		if (port->wwpn_iid[iid].wwpn == 0)
2169			return (0);
2170		memset(id, 0, sizeof(*id));
2171		id->format_protocol = SCSI_PROTO_SAS;
2172		scsi_u64to8b(port->wwpn_iid[iid].wwpn, id->sas_address);
2173		return (sizeof(*id));
2174	}
2175	default:
2176	{
2177		struct scsi_transportid_spi *id =
2178		    (struct scsi_transportid_spi *)buf;
2179		memset(id, 0, sizeof(*id));
2180		id->format_protocol = SCSI_PROTO_SPI;
2181		scsi_ulto2b(iid, id->scsi_addr);
2182		scsi_ulto2b(port->targ_port, id->rel_trgt_port_id);
2183		return (sizeof(*id));
2184	}
2185	}
2186}
2187
2188/*
2189 * Serialize a command that went down the "wrong" side, and so was sent to
2190 * this controller for execution.  The logic is a little different than the
2191 * standard case in ctl_scsiio_precheck().  Errors in this case need to get
2192 * sent back to the other side, but in the success case, we execute the
2193 * command on this side (XFER mode) or tell the other side to execute it
2194 * (SER_ONLY mode).
2195 */
2196static int
2197ctl_serialize_other_sc_cmd(struct ctl_scsiio *ctsio)
2198{
2199	struct ctl_softc *softc = control_softc;
2200	union ctl_ha_msg msg_info;
2201	struct ctl_port *port;
2202	struct ctl_lun *lun;
2203	const struct ctl_cmd_entry *entry;
2204	int retval = 0;
2205	uint32_t targ_lun;
2206
2207	targ_lun = ctsio->io_hdr.nexus.targ_mapped_lun;
2208	mtx_lock(&softc->ctl_lock);
2209
2210	/* Make sure that we know about this port. */
2211	port = ctl_io_port(&ctsio->io_hdr);
2212	if (port == NULL || (port->status & CTL_PORT_STATUS_ONLINE) == 0) {
2213		ctl_set_internal_failure(ctsio, /*sks_valid*/ 0,
2214					 /*retry_count*/ 1);
2215		goto badjuju;
2216	}
2217
2218	/* Make sure that we know about this LUN. */
2219	if ((targ_lun < CTL_MAX_LUNS) &&
2220	    ((lun = softc->ctl_luns[targ_lun]) != NULL)) {
2221		mtx_lock(&lun->lun_lock);
2222		mtx_unlock(&softc->ctl_lock);
2223		/*
2224		 * If the LUN is invalid, pretend that it doesn't exist.
2225		 * It will go away as soon as all pending I/O has been
2226		 * completed.
2227		 */
2228		if (lun->flags & CTL_LUN_DISABLED) {
2229			mtx_unlock(&lun->lun_lock);
2230			lun = NULL;
2231		}
2232	} else {
2233		mtx_unlock(&softc->ctl_lock);
2234		lun = NULL;
2235	}
2236	if (lun == NULL) {
2237		/*
2238		 * The other node would not send this request to us unless
2239		 * received announce that we are primary node for this LUN.
2240		 * If this LUN does not exist now, it is probably result of
2241		 * a race, so respond to initiator in the most opaque way.
2242		 */
2243		ctl_set_busy(ctsio);
2244		goto badjuju;
2245	}
2246
2247	entry = ctl_get_cmd_entry(ctsio, NULL);
2248	if (ctl_scsiio_lun_check(lun, entry, ctsio) != 0) {
2249		mtx_unlock(&lun->lun_lock);
2250		goto badjuju;
2251	}
2252
2253	ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr = lun;
2254	ctsio->io_hdr.ctl_private[CTL_PRIV_BACKEND_LUN].ptr = lun->be_lun;
2255
2256	/*
2257	 * Every I/O goes into the OOA queue for a
2258	 * particular LUN, and stays there until completion.
2259	 */
2260#ifdef CTL_TIME_IO
2261	if (TAILQ_EMPTY(&lun->ooa_queue))
2262		lun->idle_time += getsbinuptime() - lun->last_busy;
2263#endif
2264	TAILQ_INSERT_TAIL(&lun->ooa_queue, &ctsio->io_hdr, ooa_links);
2265
2266	switch (ctl_check_ooa(lun, (union ctl_io *)ctsio,
2267		(union ctl_io *)TAILQ_PREV(&ctsio->io_hdr, ctl_ooaq,
2268		 ooa_links))) {
2269	case CTL_ACTION_BLOCK:
2270		ctsio->io_hdr.flags |= CTL_FLAG_BLOCKED;
2271		TAILQ_INSERT_TAIL(&lun->blocked_queue, &ctsio->io_hdr,
2272				  blocked_links);
2273		mtx_unlock(&lun->lun_lock);
2274		break;
2275	case CTL_ACTION_PASS:
2276	case CTL_ACTION_SKIP:
2277		if (softc->ha_mode == CTL_HA_MODE_XFER) {
2278			ctsio->io_hdr.flags |= CTL_FLAG_IS_WAS_ON_RTR;
2279			ctl_enqueue_rtr((union ctl_io *)ctsio);
2280			mtx_unlock(&lun->lun_lock);
2281		} else {
2282			ctsio->io_hdr.flags &= ~CTL_FLAG_IO_ACTIVE;
2283			mtx_unlock(&lun->lun_lock);
2284
2285			/* send msg back to other side */
2286			msg_info.hdr.original_sc = ctsio->io_hdr.original_sc;
2287			msg_info.hdr.serializing_sc = (union ctl_io *)ctsio;
2288			msg_info.hdr.msg_type = CTL_MSG_R2R;
2289			ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg_info,
2290			    sizeof(msg_info.hdr), M_WAITOK);
2291		}
2292		break;
2293	case CTL_ACTION_OVERLAP:
2294		TAILQ_REMOVE(&lun->ooa_queue, &ctsio->io_hdr, ooa_links);
2295		mtx_unlock(&lun->lun_lock);
2296		ctl_set_overlapped_cmd(ctsio);
2297		goto badjuju;
2298	case CTL_ACTION_OVERLAP_TAG:
2299		TAILQ_REMOVE(&lun->ooa_queue, &ctsio->io_hdr, ooa_links);
2300		mtx_unlock(&lun->lun_lock);
2301		ctl_set_overlapped_tag(ctsio, ctsio->tag_num);
2302		goto badjuju;
2303	case CTL_ACTION_ERROR:
2304	default:
2305		TAILQ_REMOVE(&lun->ooa_queue, &ctsio->io_hdr, ooa_links);
2306		mtx_unlock(&lun->lun_lock);
2307
2308		ctl_set_internal_failure(ctsio, /*sks_valid*/ 0,
2309					 /*retry_count*/ 0);
2310badjuju:
2311		ctl_copy_sense_data_back((union ctl_io *)ctsio, &msg_info);
2312		msg_info.hdr.original_sc = ctsio->io_hdr.original_sc;
2313		msg_info.hdr.serializing_sc = NULL;
2314		msg_info.hdr.msg_type = CTL_MSG_BAD_JUJU;
2315		ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg_info,
2316		    sizeof(msg_info.scsi), M_WAITOK);
2317		retval = 1;
2318		break;
2319	}
2320	return (retval);
2321}
2322
2323/*
2324 * Returns 0 for success, errno for failure.
2325 */
2326static void
2327ctl_ioctl_fill_ooa(struct ctl_lun *lun, uint32_t *cur_fill_num,
2328		   struct ctl_ooa *ooa_hdr, struct ctl_ooa_entry *kern_entries)
2329{
2330	union ctl_io *io;
2331
2332	mtx_lock(&lun->lun_lock);
2333	for (io = (union ctl_io *)TAILQ_FIRST(&lun->ooa_queue); (io != NULL);
2334	     (*cur_fill_num)++, io = (union ctl_io *)TAILQ_NEXT(&io->io_hdr,
2335	     ooa_links)) {
2336		struct ctl_ooa_entry *entry;
2337
2338		/*
2339		 * If we've got more than we can fit, just count the
2340		 * remaining entries.
2341		 */
2342		if (*cur_fill_num >= ooa_hdr->alloc_num)
2343			continue;
2344
2345		entry = &kern_entries[*cur_fill_num];
2346
2347		entry->tag_num = io->scsiio.tag_num;
2348		entry->lun_num = lun->lun;
2349#ifdef CTL_TIME_IO
2350		entry->start_bt = io->io_hdr.start_bt;
2351#endif
2352		bcopy(io->scsiio.cdb, entry->cdb, io->scsiio.cdb_len);
2353		entry->cdb_len = io->scsiio.cdb_len;
2354		if (io->io_hdr.flags & CTL_FLAG_BLOCKED)
2355			entry->cmd_flags |= CTL_OOACMD_FLAG_BLOCKED;
2356
2357		if (io->io_hdr.flags & CTL_FLAG_DMA_INPROG)
2358			entry->cmd_flags |= CTL_OOACMD_FLAG_DMA;
2359
2360		if (io->io_hdr.flags & CTL_FLAG_ABORT)
2361			entry->cmd_flags |= CTL_OOACMD_FLAG_ABORT;
2362
2363		if (io->io_hdr.flags & CTL_FLAG_IS_WAS_ON_RTR)
2364			entry->cmd_flags |= CTL_OOACMD_FLAG_RTR;
2365
2366		if (io->io_hdr.flags & CTL_FLAG_DMA_QUEUED)
2367			entry->cmd_flags |= CTL_OOACMD_FLAG_DMA_QUEUED;
2368	}
2369	mtx_unlock(&lun->lun_lock);
2370}
2371
2372static void *
2373ctl_copyin_alloc(void *user_addr, unsigned int len, char *error_str,
2374		 size_t error_str_len)
2375{
2376	void *kptr;
2377
2378	kptr = malloc(len, M_CTL, M_WAITOK | M_ZERO);
2379
2380	if (copyin(user_addr, kptr, len) != 0) {
2381		snprintf(error_str, error_str_len, "Error copying %d bytes "
2382			 "from user address %p to kernel address %p", len,
2383			 user_addr, kptr);
2384		free(kptr, M_CTL);
2385		return (NULL);
2386	}
2387
2388	return (kptr);
2389}
2390
2391static void
2392ctl_free_args(int num_args, struct ctl_be_arg *args)
2393{
2394	int i;
2395
2396	if (args == NULL)
2397		return;
2398
2399	for (i = 0; i < num_args; i++) {
2400		free(args[i].kname, M_CTL);
2401		free(args[i].kvalue, M_CTL);
2402	}
2403
2404	free(args, M_CTL);
2405}
2406
2407static struct ctl_be_arg *
2408ctl_copyin_args(int num_args, struct ctl_be_arg *uargs,
2409		char *error_str, size_t error_str_len)
2410{
2411	struct ctl_be_arg *args;
2412	int i;
2413
2414	args = ctl_copyin_alloc(uargs, num_args * sizeof(*args),
2415				error_str, error_str_len);
2416
2417	if (args == NULL)
2418		goto bailout;
2419
2420	for (i = 0; i < num_args; i++) {
2421		args[i].kname = NULL;
2422		args[i].kvalue = NULL;
2423	}
2424
2425	for (i = 0; i < num_args; i++) {
2426		uint8_t *tmpptr;
2427
2428		if (args[i].namelen == 0) {
2429			snprintf(error_str, error_str_len, "Argument %d "
2430				 "name length is zero", i);
2431			goto bailout;
2432		}
2433
2434		args[i].kname = ctl_copyin_alloc(args[i].name,
2435			args[i].namelen, error_str, error_str_len);
2436		if (args[i].kname == NULL)
2437			goto bailout;
2438
2439		if (args[i].kname[args[i].namelen - 1] != '\0') {
2440			snprintf(error_str, error_str_len, "Argument %d "
2441				 "name is not NUL-terminated", i);
2442			goto bailout;
2443		}
2444
2445		if (args[i].flags & CTL_BEARG_RD) {
2446			if (args[i].vallen == 0) {
2447				snprintf(error_str, error_str_len, "Argument %d "
2448					 "value length is zero", i);
2449				goto bailout;
2450			}
2451
2452			tmpptr = ctl_copyin_alloc(args[i].value,
2453				args[i].vallen, error_str, error_str_len);
2454			if (tmpptr == NULL)
2455				goto bailout;
2456
2457			if ((args[i].flags & CTL_BEARG_ASCII)
2458			 && (tmpptr[args[i].vallen - 1] != '\0')) {
2459				snprintf(error_str, error_str_len, "Argument "
2460				    "%d value is not NUL-terminated", i);
2461				free(tmpptr, M_CTL);
2462				goto bailout;
2463			}
2464			args[i].kvalue = tmpptr;
2465		} else {
2466			args[i].kvalue = malloc(args[i].vallen,
2467			    M_CTL, M_WAITOK | M_ZERO);
2468		}
2469	}
2470
2471	return (args);
2472bailout:
2473
2474	ctl_free_args(num_args, args);
2475
2476	return (NULL);
2477}
2478
2479static void
2480ctl_copyout_args(int num_args, struct ctl_be_arg *args)
2481{
2482	int i;
2483
2484	for (i = 0; i < num_args; i++) {
2485		if (args[i].flags & CTL_BEARG_WR)
2486			copyout(args[i].kvalue, args[i].value, args[i].vallen);
2487	}
2488}
2489
2490/*
2491 * Escape characters that are illegal or not recommended in XML.
2492 */
2493int
2494ctl_sbuf_printf_esc(struct sbuf *sb, char *str, int size)
2495{
2496	char *end = str + size;
2497	int retval;
2498
2499	retval = 0;
2500
2501	for (; *str && str < end; str++) {
2502		switch (*str) {
2503		case '&':
2504			retval = sbuf_printf(sb, "&amp;");
2505			break;
2506		case '>':
2507			retval = sbuf_printf(sb, "&gt;");
2508			break;
2509		case '<':
2510			retval = sbuf_printf(sb, "&lt;");
2511			break;
2512		default:
2513			retval = sbuf_putc(sb, *str);
2514			break;
2515		}
2516
2517		if (retval != 0)
2518			break;
2519
2520	}
2521
2522	return (retval);
2523}
2524
2525static void
2526ctl_id_sbuf(struct ctl_devid *id, struct sbuf *sb)
2527{
2528	struct scsi_vpd_id_descriptor *desc;
2529	int i;
2530
2531	if (id == NULL || id->len < 4)
2532		return;
2533	desc = (struct scsi_vpd_id_descriptor *)id->data;
2534	switch (desc->id_type & SVPD_ID_TYPE_MASK) {
2535	case SVPD_ID_TYPE_T10:
2536		sbuf_printf(sb, "t10.");
2537		break;
2538	case SVPD_ID_TYPE_EUI64:
2539		sbuf_printf(sb, "eui.");
2540		break;
2541	case SVPD_ID_TYPE_NAA:
2542		sbuf_printf(sb, "naa.");
2543		break;
2544	case SVPD_ID_TYPE_SCSI_NAME:
2545		break;
2546	}
2547	switch (desc->proto_codeset & SVPD_ID_CODESET_MASK) {
2548	case SVPD_ID_CODESET_BINARY:
2549		for (i = 0; i < desc->length; i++)
2550			sbuf_printf(sb, "%02x", desc->identifier[i]);
2551		break;
2552	case SVPD_ID_CODESET_ASCII:
2553		sbuf_printf(sb, "%.*s", (int)desc->length,
2554		    (char *)desc->identifier);
2555		break;
2556	case SVPD_ID_CODESET_UTF8:
2557		sbuf_printf(sb, "%s", (char *)desc->identifier);
2558		break;
2559	}
2560}
2561
2562static int
2563ctl_ioctl(struct cdev *dev, u_long cmd, caddr_t addr, int flag,
2564	  struct thread *td)
2565{
2566	struct ctl_softc *softc = dev->si_drv1;
2567	struct ctl_lun *lun;
2568	int retval;
2569
2570	retval = 0;
2571
2572	switch (cmd) {
2573	case CTL_IO:
2574		retval = ctl_ioctl_io(dev, cmd, addr, flag, td);
2575		break;
2576	case CTL_ENABLE_PORT:
2577	case CTL_DISABLE_PORT:
2578	case CTL_SET_PORT_WWNS: {
2579		struct ctl_port *port;
2580		struct ctl_port_entry *entry;
2581
2582		entry = (struct ctl_port_entry *)addr;
2583
2584		mtx_lock(&softc->ctl_lock);
2585		STAILQ_FOREACH(port, &softc->port_list, links) {
2586			int action, done;
2587
2588			if (port->targ_port < softc->port_min ||
2589			    port->targ_port >= softc->port_max)
2590				continue;
2591
2592			action = 0;
2593			done = 0;
2594			if ((entry->port_type == CTL_PORT_NONE)
2595			 && (entry->targ_port == port->targ_port)) {
2596				/*
2597				 * If the user only wants to enable or
2598				 * disable or set WWNs on a specific port,
2599				 * do the operation and we're done.
2600				 */
2601				action = 1;
2602				done = 1;
2603			} else if (entry->port_type & port->port_type) {
2604				/*
2605				 * Compare the user's type mask with the
2606				 * particular frontend type to see if we
2607				 * have a match.
2608				 */
2609				action = 1;
2610				done = 0;
2611
2612				/*
2613				 * Make sure the user isn't trying to set
2614				 * WWNs on multiple ports at the same time.
2615				 */
2616				if (cmd == CTL_SET_PORT_WWNS) {
2617					printf("%s: Can't set WWNs on "
2618					       "multiple ports\n", __func__);
2619					retval = EINVAL;
2620					break;
2621				}
2622			}
2623			if (action == 0)
2624				continue;
2625
2626			/*
2627			 * XXX KDM we have to drop the lock here, because
2628			 * the online/offline operations can potentially
2629			 * block.  We need to reference count the frontends
2630			 * so they can't go away,
2631			 */
2632			if (cmd == CTL_ENABLE_PORT) {
2633				mtx_unlock(&softc->ctl_lock);
2634				ctl_port_online(port);
2635				mtx_lock(&softc->ctl_lock);
2636			} else if (cmd == CTL_DISABLE_PORT) {
2637				mtx_unlock(&softc->ctl_lock);
2638				ctl_port_offline(port);
2639				mtx_lock(&softc->ctl_lock);
2640			} else if (cmd == CTL_SET_PORT_WWNS) {
2641				ctl_port_set_wwns(port,
2642				    (entry->flags & CTL_PORT_WWNN_VALID) ?
2643				    1 : 0, entry->wwnn,
2644				    (entry->flags & CTL_PORT_WWPN_VALID) ?
2645				    1 : 0, entry->wwpn);
2646			}
2647			if (done != 0)
2648				break;
2649		}
2650		mtx_unlock(&softc->ctl_lock);
2651		break;
2652	}
2653	case CTL_GET_OOA: {
2654		struct ctl_ooa *ooa_hdr;
2655		struct ctl_ooa_entry *entries;
2656		uint32_t cur_fill_num;
2657
2658		ooa_hdr = (struct ctl_ooa *)addr;
2659
2660		if ((ooa_hdr->alloc_len == 0)
2661		 || (ooa_hdr->alloc_num == 0)) {
2662			printf("%s: CTL_GET_OOA: alloc len %u and alloc num %u "
2663			       "must be non-zero\n", __func__,
2664			       ooa_hdr->alloc_len, ooa_hdr->alloc_num);
2665			retval = EINVAL;
2666			break;
2667		}
2668
2669		if (ooa_hdr->alloc_len != (ooa_hdr->alloc_num *
2670		    sizeof(struct ctl_ooa_entry))) {
2671			printf("%s: CTL_GET_OOA: alloc len %u must be alloc "
2672			       "num %d * sizeof(struct ctl_ooa_entry) %zd\n",
2673			       __func__, ooa_hdr->alloc_len,
2674			       ooa_hdr->alloc_num,sizeof(struct ctl_ooa_entry));
2675			retval = EINVAL;
2676			break;
2677		}
2678
2679		entries = malloc(ooa_hdr->alloc_len, M_CTL, M_WAITOK | M_ZERO);
2680		if (entries == NULL) {
2681			printf("%s: could not allocate %d bytes for OOA "
2682			       "dump\n", __func__, ooa_hdr->alloc_len);
2683			retval = ENOMEM;
2684			break;
2685		}
2686
2687		mtx_lock(&softc->ctl_lock);
2688		if (((ooa_hdr->flags & CTL_OOA_FLAG_ALL_LUNS) == 0)
2689		 && ((ooa_hdr->lun_num >= CTL_MAX_LUNS)
2690		  || (softc->ctl_luns[ooa_hdr->lun_num] == NULL))) {
2691			mtx_unlock(&softc->ctl_lock);
2692			free(entries, M_CTL);
2693			printf("%s: CTL_GET_OOA: invalid LUN %ju\n",
2694			       __func__, (uintmax_t)ooa_hdr->lun_num);
2695			retval = EINVAL;
2696			break;
2697		}
2698
2699		cur_fill_num = 0;
2700
2701		if (ooa_hdr->flags & CTL_OOA_FLAG_ALL_LUNS) {
2702			STAILQ_FOREACH(lun, &softc->lun_list, links) {
2703				ctl_ioctl_fill_ooa(lun, &cur_fill_num,
2704				    ooa_hdr, entries);
2705			}
2706		} else {
2707			lun = softc->ctl_luns[ooa_hdr->lun_num];
2708			ctl_ioctl_fill_ooa(lun, &cur_fill_num, ooa_hdr,
2709			    entries);
2710		}
2711		mtx_unlock(&softc->ctl_lock);
2712
2713		ooa_hdr->fill_num = min(cur_fill_num, ooa_hdr->alloc_num);
2714		ooa_hdr->fill_len = ooa_hdr->fill_num *
2715			sizeof(struct ctl_ooa_entry);
2716		retval = copyout(entries, ooa_hdr->entries, ooa_hdr->fill_len);
2717		if (retval != 0) {
2718			printf("%s: error copying out %d bytes for OOA dump\n",
2719			       __func__, ooa_hdr->fill_len);
2720		}
2721
2722		getbinuptime(&ooa_hdr->cur_bt);
2723
2724		if (cur_fill_num > ooa_hdr->alloc_num) {
2725			ooa_hdr->dropped_num = cur_fill_num -ooa_hdr->alloc_num;
2726			ooa_hdr->status = CTL_OOA_NEED_MORE_SPACE;
2727		} else {
2728			ooa_hdr->dropped_num = 0;
2729			ooa_hdr->status = CTL_OOA_OK;
2730		}
2731
2732		free(entries, M_CTL);
2733		break;
2734	}
2735	case CTL_DELAY_IO: {
2736		struct ctl_io_delay_info *delay_info;
2737
2738		delay_info = (struct ctl_io_delay_info *)addr;
2739
2740#ifdef CTL_IO_DELAY
2741		mtx_lock(&softc->ctl_lock);
2742
2743		if ((delay_info->lun_id >= CTL_MAX_LUNS)
2744		 || (softc->ctl_luns[delay_info->lun_id] == NULL)) {
2745			delay_info->status = CTL_DELAY_STATUS_INVALID_LUN;
2746		} else {
2747			lun = softc->ctl_luns[delay_info->lun_id];
2748			mtx_lock(&lun->lun_lock);
2749
2750			delay_info->status = CTL_DELAY_STATUS_OK;
2751
2752			switch (delay_info->delay_type) {
2753			case CTL_DELAY_TYPE_CONT:
2754				break;
2755			case CTL_DELAY_TYPE_ONESHOT:
2756				break;
2757			default:
2758				delay_info->status =
2759					CTL_DELAY_STATUS_INVALID_TYPE;
2760				break;
2761			}
2762
2763			switch (delay_info->delay_loc) {
2764			case CTL_DELAY_LOC_DATAMOVE:
2765				lun->delay_info.datamove_type =
2766					delay_info->delay_type;
2767				lun->delay_info.datamove_delay =
2768					delay_info->delay_secs;
2769				break;
2770			case CTL_DELAY_LOC_DONE:
2771				lun->delay_info.done_type =
2772					delay_info->delay_type;
2773				lun->delay_info.done_delay =
2774					delay_info->delay_secs;
2775				break;
2776			default:
2777				delay_info->status =
2778					CTL_DELAY_STATUS_INVALID_LOC;
2779				break;
2780			}
2781			mtx_unlock(&lun->lun_lock);
2782		}
2783
2784		mtx_unlock(&softc->ctl_lock);
2785#else
2786		delay_info->status = CTL_DELAY_STATUS_NOT_IMPLEMENTED;
2787#endif /* CTL_IO_DELAY */
2788		break;
2789	}
2790	case CTL_GETSTATS: {
2791		struct ctl_stats *stats;
2792		int i;
2793
2794		stats = (struct ctl_stats *)addr;
2795
2796		if ((sizeof(struct ctl_lun_io_stats) * softc->num_luns) >
2797		     stats->alloc_len) {
2798			stats->status = CTL_SS_NEED_MORE_SPACE;
2799			stats->num_luns = softc->num_luns;
2800			break;
2801		}
2802		/*
2803		 * XXX KDM no locking here.  If the LUN list changes,
2804		 * things can blow up.
2805		 */
2806		i = 0;
2807		STAILQ_FOREACH(lun, &softc->lun_list, links) {
2808			retval = copyout(&lun->stats, &stats->lun_stats[i++],
2809					 sizeof(lun->stats));
2810			if (retval != 0)
2811				break;
2812		}
2813		stats->num_luns = softc->num_luns;
2814		stats->fill_len = sizeof(struct ctl_lun_io_stats) *
2815				 softc->num_luns;
2816		stats->status = CTL_SS_OK;
2817#ifdef CTL_TIME_IO
2818		stats->flags = CTL_STATS_FLAG_TIME_VALID;
2819#else
2820		stats->flags = CTL_STATS_FLAG_NONE;
2821#endif
2822		getnanouptime(&stats->timestamp);
2823		break;
2824	}
2825	case CTL_ERROR_INJECT: {
2826		struct ctl_error_desc *err_desc, *new_err_desc;
2827
2828		err_desc = (struct ctl_error_desc *)addr;
2829
2830		new_err_desc = malloc(sizeof(*new_err_desc), M_CTL,
2831				      M_WAITOK | M_ZERO);
2832		bcopy(err_desc, new_err_desc, sizeof(*new_err_desc));
2833
2834		mtx_lock(&softc->ctl_lock);
2835		lun = softc->ctl_luns[err_desc->lun_id];
2836		if (lun == NULL) {
2837			mtx_unlock(&softc->ctl_lock);
2838			free(new_err_desc, M_CTL);
2839			printf("%s: CTL_ERROR_INJECT: invalid LUN %ju\n",
2840			       __func__, (uintmax_t)err_desc->lun_id);
2841			retval = EINVAL;
2842			break;
2843		}
2844		mtx_lock(&lun->lun_lock);
2845		mtx_unlock(&softc->ctl_lock);
2846
2847		/*
2848		 * We could do some checking here to verify the validity
2849		 * of the request, but given the complexity of error
2850		 * injection requests, the checking logic would be fairly
2851		 * complex.
2852		 *
2853		 * For now, if the request is invalid, it just won't get
2854		 * executed and might get deleted.
2855		 */
2856		STAILQ_INSERT_TAIL(&lun->error_list, new_err_desc, links);
2857
2858		/*
2859		 * XXX KDM check to make sure the serial number is unique,
2860		 * in case we somehow manage to wrap.  That shouldn't
2861		 * happen for a very long time, but it's the right thing to
2862		 * do.
2863		 */
2864		new_err_desc->serial = lun->error_serial;
2865		err_desc->serial = lun->error_serial;
2866		lun->error_serial++;
2867
2868		mtx_unlock(&lun->lun_lock);
2869		break;
2870	}
2871	case CTL_ERROR_INJECT_DELETE: {
2872		struct ctl_error_desc *delete_desc, *desc, *desc2;
2873		int delete_done;
2874
2875		delete_desc = (struct ctl_error_desc *)addr;
2876		delete_done = 0;
2877
2878		mtx_lock(&softc->ctl_lock);
2879		lun = softc->ctl_luns[delete_desc->lun_id];
2880		if (lun == NULL) {
2881			mtx_unlock(&softc->ctl_lock);
2882			printf("%s: CTL_ERROR_INJECT_DELETE: invalid LUN %ju\n",
2883			       __func__, (uintmax_t)delete_desc->lun_id);
2884			retval = EINVAL;
2885			break;
2886		}
2887		mtx_lock(&lun->lun_lock);
2888		mtx_unlock(&softc->ctl_lock);
2889		STAILQ_FOREACH_SAFE(desc, &lun->error_list, links, desc2) {
2890			if (desc->serial != delete_desc->serial)
2891				continue;
2892
2893			STAILQ_REMOVE(&lun->error_list, desc, ctl_error_desc,
2894				      links);
2895			free(desc, M_CTL);
2896			delete_done = 1;
2897		}
2898		mtx_unlock(&lun->lun_lock);
2899		if (delete_done == 0) {
2900			printf("%s: CTL_ERROR_INJECT_DELETE: can't find "
2901			       "error serial %ju on LUN %u\n", __func__,
2902			       delete_desc->serial, delete_desc->lun_id);
2903			retval = EINVAL;
2904			break;
2905		}
2906		break;
2907	}
2908	case CTL_DUMP_STRUCTS: {
2909		int i, j, k;
2910		struct ctl_port *port;
2911		struct ctl_frontend *fe;
2912
2913		mtx_lock(&softc->ctl_lock);
2914		printf("CTL Persistent Reservation information start:\n");
2915		for (i = 0; i < CTL_MAX_LUNS; i++) {
2916			lun = softc->ctl_luns[i];
2917
2918			if ((lun == NULL)
2919			 || ((lun->flags & CTL_LUN_DISABLED) != 0))
2920				continue;
2921
2922			for (j = 0; j < CTL_MAX_PORTS; j++) {
2923				if (lun->pr_keys[j] == NULL)
2924					continue;
2925				for (k = 0; k < CTL_MAX_INIT_PER_PORT; k++){
2926					if (lun->pr_keys[j][k] == 0)
2927						continue;
2928					printf("  LUN %d port %d iid %d key "
2929					       "%#jx\n", i, j, k,
2930					       (uintmax_t)lun->pr_keys[j][k]);
2931				}
2932			}
2933		}
2934		printf("CTL Persistent Reservation information end\n");
2935		printf("CTL Ports:\n");
2936		STAILQ_FOREACH(port, &softc->port_list, links) {
2937			printf("  Port %d '%s' Frontend '%s' Type %u pp %d vp %d WWNN "
2938			       "%#jx WWPN %#jx\n", port->targ_port, port->port_name,
2939			       port->frontend->name, port->port_type,
2940			       port->physical_port, port->virtual_port,
2941			       (uintmax_t)port->wwnn, (uintmax_t)port->wwpn);
2942			for (j = 0; j < CTL_MAX_INIT_PER_PORT; j++) {
2943				if (port->wwpn_iid[j].in_use == 0 &&
2944				    port->wwpn_iid[j].wwpn == 0 &&
2945				    port->wwpn_iid[j].name == NULL)
2946					continue;
2947
2948				printf("    iid %u use %d WWPN %#jx '%s'\n",
2949				    j, port->wwpn_iid[j].in_use,
2950				    (uintmax_t)port->wwpn_iid[j].wwpn,
2951				    port->wwpn_iid[j].name);
2952			}
2953		}
2954		printf("CTL Port information end\n");
2955		mtx_unlock(&softc->ctl_lock);
2956		/*
2957		 * XXX KDM calling this without a lock.  We'd likely want
2958		 * to drop the lock before calling the frontend's dump
2959		 * routine anyway.
2960		 */
2961		printf("CTL Frontends:\n");
2962		STAILQ_FOREACH(fe, &softc->fe_list, links) {
2963			printf("  Frontend '%s'\n", fe->name);
2964			if (fe->fe_dump != NULL)
2965				fe->fe_dump();
2966		}
2967		printf("CTL Frontend information end\n");
2968		break;
2969	}
2970	case CTL_LUN_REQ: {
2971		struct ctl_lun_req *lun_req;
2972		struct ctl_backend_driver *backend;
2973
2974		lun_req = (struct ctl_lun_req *)addr;
2975
2976		backend = ctl_backend_find(lun_req->backend);
2977		if (backend == NULL) {
2978			lun_req->status = CTL_LUN_ERROR;
2979			snprintf(lun_req->error_str,
2980				 sizeof(lun_req->error_str),
2981				 "Backend \"%s\" not found.",
2982				 lun_req->backend);
2983			break;
2984		}
2985		if (lun_req->num_be_args > 0) {
2986			lun_req->kern_be_args = ctl_copyin_args(
2987				lun_req->num_be_args,
2988				lun_req->be_args,
2989				lun_req->error_str,
2990				sizeof(lun_req->error_str));
2991			if (lun_req->kern_be_args == NULL) {
2992				lun_req->status = CTL_LUN_ERROR;
2993				break;
2994			}
2995		}
2996
2997		retval = backend->ioctl(dev, cmd, addr, flag, td);
2998
2999		if (lun_req->num_be_args > 0) {
3000			ctl_copyout_args(lun_req->num_be_args,
3001				      lun_req->kern_be_args);
3002			ctl_free_args(lun_req->num_be_args,
3003				      lun_req->kern_be_args);
3004		}
3005		break;
3006	}
3007	case CTL_LUN_LIST: {
3008		struct sbuf *sb;
3009		struct ctl_lun_list *list;
3010		struct ctl_option *opt;
3011
3012		list = (struct ctl_lun_list *)addr;
3013
3014		/*
3015		 * Allocate a fixed length sbuf here, based on the length
3016		 * of the user's buffer.  We could allocate an auto-extending
3017		 * buffer, and then tell the user how much larger our
3018		 * amount of data is than his buffer, but that presents
3019		 * some problems:
3020		 *
3021		 * 1.  The sbuf(9) routines use a blocking malloc, and so
3022		 *     we can't hold a lock while calling them with an
3023		 *     auto-extending buffer.
3024 		 *
3025		 * 2.  There is not currently a LUN reference counting
3026		 *     mechanism, outside of outstanding transactions on
3027		 *     the LUN's OOA queue.  So a LUN could go away on us
3028		 *     while we're getting the LUN number, backend-specific
3029		 *     information, etc.  Thus, given the way things
3030		 *     currently work, we need to hold the CTL lock while
3031		 *     grabbing LUN information.
3032		 *
3033		 * So, from the user's standpoint, the best thing to do is
3034		 * allocate what he thinks is a reasonable buffer length,
3035		 * and then if he gets a CTL_LUN_LIST_NEED_MORE_SPACE error,
3036		 * double the buffer length and try again.  (And repeat
3037		 * that until he succeeds.)
3038		 */
3039		sb = sbuf_new(NULL, NULL, list->alloc_len, SBUF_FIXEDLEN);
3040		if (sb == NULL) {
3041			list->status = CTL_LUN_LIST_ERROR;
3042			snprintf(list->error_str, sizeof(list->error_str),
3043				 "Unable to allocate %d bytes for LUN list",
3044				 list->alloc_len);
3045			break;
3046		}
3047
3048		sbuf_printf(sb, "<ctllunlist>\n");
3049
3050		mtx_lock(&softc->ctl_lock);
3051		STAILQ_FOREACH(lun, &softc->lun_list, links) {
3052			mtx_lock(&lun->lun_lock);
3053			retval = sbuf_printf(sb, "<lun id=\"%ju\">\n",
3054					     (uintmax_t)lun->lun);
3055
3056			/*
3057			 * Bail out as soon as we see that we've overfilled
3058			 * the buffer.
3059			 */
3060			if (retval != 0)
3061				break;
3062
3063			retval = sbuf_printf(sb, "\t<backend_type>%s"
3064					     "</backend_type>\n",
3065					     (lun->backend == NULL) ?  "none" :
3066					     lun->backend->name);
3067
3068			if (retval != 0)
3069				break;
3070
3071			retval = sbuf_printf(sb, "\t<lun_type>%d</lun_type>\n",
3072					     lun->be_lun->lun_type);
3073
3074			if (retval != 0)
3075				break;
3076
3077			if (lun->backend == NULL) {
3078				retval = sbuf_printf(sb, "</lun>\n");
3079				if (retval != 0)
3080					break;
3081				continue;
3082			}
3083
3084			retval = sbuf_printf(sb, "\t<size>%ju</size>\n",
3085					     (lun->be_lun->maxlba > 0) ?
3086					     lun->be_lun->maxlba + 1 : 0);
3087
3088			if (retval != 0)
3089				break;
3090
3091			retval = sbuf_printf(sb, "\t<blocksize>%u</blocksize>\n",
3092					     lun->be_lun->blocksize);
3093
3094			if (retval != 0)
3095				break;
3096
3097			retval = sbuf_printf(sb, "\t<serial_number>");
3098
3099			if (retval != 0)
3100				break;
3101
3102			retval = ctl_sbuf_printf_esc(sb,
3103			    lun->be_lun->serial_num,
3104			    sizeof(lun->be_lun->serial_num));
3105
3106			if (retval != 0)
3107				break;
3108
3109			retval = sbuf_printf(sb, "</serial_number>\n");
3110
3111			if (retval != 0)
3112				break;
3113
3114			retval = sbuf_printf(sb, "\t<device_id>");
3115
3116			if (retval != 0)
3117				break;
3118
3119			retval = ctl_sbuf_printf_esc(sb,
3120			    lun->be_lun->device_id,
3121			    sizeof(lun->be_lun->device_id));
3122
3123			if (retval != 0)
3124				break;
3125
3126			retval = sbuf_printf(sb, "</device_id>\n");
3127
3128			if (retval != 0)
3129				break;
3130
3131			if (lun->backend->lun_info != NULL) {
3132				retval = lun->backend->lun_info(lun->be_lun->be_lun, sb);
3133				if (retval != 0)
3134					break;
3135			}
3136			STAILQ_FOREACH(opt, &lun->be_lun->options, links) {
3137				retval = sbuf_printf(sb, "\t<%s>%s</%s>\n",
3138				    opt->name, opt->value, opt->name);
3139				if (retval != 0)
3140					break;
3141			}
3142
3143			retval = sbuf_printf(sb, "</lun>\n");
3144
3145			if (retval != 0)
3146				break;
3147			mtx_unlock(&lun->lun_lock);
3148		}
3149		if (lun != NULL)
3150			mtx_unlock(&lun->lun_lock);
3151		mtx_unlock(&softc->ctl_lock);
3152
3153		if ((retval != 0)
3154		 || ((retval = sbuf_printf(sb, "</ctllunlist>\n")) != 0)) {
3155			retval = 0;
3156			sbuf_delete(sb);
3157			list->status = CTL_LUN_LIST_NEED_MORE_SPACE;
3158			snprintf(list->error_str, sizeof(list->error_str),
3159				 "Out of space, %d bytes is too small",
3160				 list->alloc_len);
3161			break;
3162		}
3163
3164		sbuf_finish(sb);
3165
3166		retval = copyout(sbuf_data(sb), list->lun_xml,
3167				 sbuf_len(sb) + 1);
3168
3169		list->fill_len = sbuf_len(sb) + 1;
3170		list->status = CTL_LUN_LIST_OK;
3171		sbuf_delete(sb);
3172		break;
3173	}
3174	case CTL_ISCSI: {
3175		struct ctl_iscsi *ci;
3176		struct ctl_frontend *fe;
3177
3178		ci = (struct ctl_iscsi *)addr;
3179
3180		fe = ctl_frontend_find("iscsi");
3181		if (fe == NULL) {
3182			ci->status = CTL_ISCSI_ERROR;
3183			snprintf(ci->error_str, sizeof(ci->error_str),
3184			    "Frontend \"iscsi\" not found.");
3185			break;
3186		}
3187
3188		retval = fe->ioctl(dev, cmd, addr, flag, td);
3189		break;
3190	}
3191	case CTL_PORT_REQ: {
3192		struct ctl_req *req;
3193		struct ctl_frontend *fe;
3194
3195		req = (struct ctl_req *)addr;
3196
3197		fe = ctl_frontend_find(req->driver);
3198		if (fe == NULL) {
3199			req->status = CTL_LUN_ERROR;
3200			snprintf(req->error_str, sizeof(req->error_str),
3201			    "Frontend \"%s\" not found.", req->driver);
3202			break;
3203		}
3204		if (req->num_args > 0) {
3205			req->kern_args = ctl_copyin_args(req->num_args,
3206			    req->args, req->error_str, sizeof(req->error_str));
3207			if (req->kern_args == NULL) {
3208				req->status = CTL_LUN_ERROR;
3209				break;
3210			}
3211		}
3212
3213		if (fe->ioctl)
3214			retval = fe->ioctl(dev, cmd, addr, flag, td);
3215		else
3216			retval = ENODEV;
3217
3218		if (req->num_args > 0) {
3219			ctl_copyout_args(req->num_args, req->kern_args);
3220			ctl_free_args(req->num_args, req->kern_args);
3221		}
3222		break;
3223	}
3224	case CTL_PORT_LIST: {
3225		struct sbuf *sb;
3226		struct ctl_port *port;
3227		struct ctl_lun_list *list;
3228		struct ctl_option *opt;
3229		int j;
3230		uint32_t plun;
3231
3232		list = (struct ctl_lun_list *)addr;
3233
3234		sb = sbuf_new(NULL, NULL, list->alloc_len, SBUF_FIXEDLEN);
3235		if (sb == NULL) {
3236			list->status = CTL_LUN_LIST_ERROR;
3237			snprintf(list->error_str, sizeof(list->error_str),
3238				 "Unable to allocate %d bytes for LUN list",
3239				 list->alloc_len);
3240			break;
3241		}
3242
3243		sbuf_printf(sb, "<ctlportlist>\n");
3244
3245		mtx_lock(&softc->ctl_lock);
3246		STAILQ_FOREACH(port, &softc->port_list, links) {
3247			retval = sbuf_printf(sb, "<targ_port id=\"%ju\">\n",
3248					     (uintmax_t)port->targ_port);
3249
3250			/*
3251			 * Bail out as soon as we see that we've overfilled
3252			 * the buffer.
3253			 */
3254			if (retval != 0)
3255				break;
3256
3257			retval = sbuf_printf(sb, "\t<frontend_type>%s"
3258			    "</frontend_type>\n", port->frontend->name);
3259			if (retval != 0)
3260				break;
3261
3262			retval = sbuf_printf(sb, "\t<port_type>%d</port_type>\n",
3263					     port->port_type);
3264			if (retval != 0)
3265				break;
3266
3267			retval = sbuf_printf(sb, "\t<online>%s</online>\n",
3268			    (port->status & CTL_PORT_STATUS_ONLINE) ? "YES" : "NO");
3269			if (retval != 0)
3270				break;
3271
3272			retval = sbuf_printf(sb, "\t<port_name>%s</port_name>\n",
3273			    port->port_name);
3274			if (retval != 0)
3275				break;
3276
3277			retval = sbuf_printf(sb, "\t<physical_port>%d</physical_port>\n",
3278			    port->physical_port);
3279			if (retval != 0)
3280				break;
3281
3282			retval = sbuf_printf(sb, "\t<virtual_port>%d</virtual_port>\n",
3283			    port->virtual_port);
3284			if (retval != 0)
3285				break;
3286
3287			if (port->target_devid != NULL) {
3288				sbuf_printf(sb, "\t<target>");
3289				ctl_id_sbuf(port->target_devid, sb);
3290				sbuf_printf(sb, "</target>\n");
3291			}
3292
3293			if (port->port_devid != NULL) {
3294				sbuf_printf(sb, "\t<port>");
3295				ctl_id_sbuf(port->port_devid, sb);
3296				sbuf_printf(sb, "</port>\n");
3297			}
3298
3299			if (port->port_info != NULL) {
3300				retval = port->port_info(port->onoff_arg, sb);
3301				if (retval != 0)
3302					break;
3303			}
3304			STAILQ_FOREACH(opt, &port->options, links) {
3305				retval = sbuf_printf(sb, "\t<%s>%s</%s>\n",
3306				    opt->name, opt->value, opt->name);
3307				if (retval != 0)
3308					break;
3309			}
3310
3311			if (port->lun_map != NULL) {
3312				sbuf_printf(sb, "\t<lun_map>on</lun_map>\n");
3313				for (j = 0; j < CTL_MAX_LUNS; j++) {
3314					plun = ctl_lun_map_from_port(port, j);
3315					if (plun >= CTL_MAX_LUNS)
3316						continue;
3317					sbuf_printf(sb,
3318					    "\t<lun id=\"%u\">%u</lun>\n",
3319					    j, plun);
3320				}
3321			}
3322
3323			for (j = 0; j < CTL_MAX_INIT_PER_PORT; j++) {
3324				if (port->wwpn_iid[j].in_use == 0 ||
3325				    (port->wwpn_iid[j].wwpn == 0 &&
3326				     port->wwpn_iid[j].name == NULL))
3327					continue;
3328
3329				if (port->wwpn_iid[j].name != NULL)
3330					retval = sbuf_printf(sb,
3331					    "\t<initiator id=\"%u\">%s</initiator>\n",
3332					    j, port->wwpn_iid[j].name);
3333				else
3334					retval = sbuf_printf(sb,
3335					    "\t<initiator id=\"%u\">naa.%08jx</initiator>\n",
3336					    j, port->wwpn_iid[j].wwpn);
3337				if (retval != 0)
3338					break;
3339			}
3340			if (retval != 0)
3341				break;
3342
3343			retval = sbuf_printf(sb, "</targ_port>\n");
3344			if (retval != 0)
3345				break;
3346		}
3347		mtx_unlock(&softc->ctl_lock);
3348
3349		if ((retval != 0)
3350		 || ((retval = sbuf_printf(sb, "</ctlportlist>\n")) != 0)) {
3351			retval = 0;
3352			sbuf_delete(sb);
3353			list->status = CTL_LUN_LIST_NEED_MORE_SPACE;
3354			snprintf(list->error_str, sizeof(list->error_str),
3355				 "Out of space, %d bytes is too small",
3356				 list->alloc_len);
3357			break;
3358		}
3359
3360		sbuf_finish(sb);
3361
3362		retval = copyout(sbuf_data(sb), list->lun_xml,
3363				 sbuf_len(sb) + 1);
3364
3365		list->fill_len = sbuf_len(sb) + 1;
3366		list->status = CTL_LUN_LIST_OK;
3367		sbuf_delete(sb);
3368		break;
3369	}
3370	case CTL_LUN_MAP: {
3371		struct ctl_lun_map *lm  = (struct ctl_lun_map *)addr;
3372		struct ctl_port *port;
3373
3374		mtx_lock(&softc->ctl_lock);
3375		if (lm->port < softc->port_min ||
3376		    lm->port >= softc->port_max ||
3377		    (port = softc->ctl_ports[lm->port]) == NULL) {
3378			mtx_unlock(&softc->ctl_lock);
3379			return (ENXIO);
3380		}
3381		if (port->status & CTL_PORT_STATUS_ONLINE) {
3382			STAILQ_FOREACH(lun, &softc->lun_list, links) {
3383				if (ctl_lun_map_to_port(port, lun->lun) >=
3384				    CTL_MAX_LUNS)
3385					continue;
3386				mtx_lock(&lun->lun_lock);
3387				ctl_est_ua_port(lun, lm->port, -1,
3388				    CTL_UA_LUN_CHANGE);
3389				mtx_unlock(&lun->lun_lock);
3390			}
3391		}
3392		mtx_unlock(&softc->ctl_lock); // XXX: port_enable sleeps
3393		if (lm->plun < CTL_MAX_LUNS) {
3394			if (lm->lun == UINT32_MAX)
3395				retval = ctl_lun_map_unset(port, lm->plun);
3396			else if (lm->lun < CTL_MAX_LUNS &&
3397			    softc->ctl_luns[lm->lun] != NULL)
3398				retval = ctl_lun_map_set(port, lm->plun, lm->lun);
3399			else
3400				return (ENXIO);
3401		} else if (lm->plun == UINT32_MAX) {
3402			if (lm->lun == UINT32_MAX)
3403				retval = ctl_lun_map_deinit(port);
3404			else
3405				retval = ctl_lun_map_init(port);
3406		} else
3407			return (ENXIO);
3408		if (port->status & CTL_PORT_STATUS_ONLINE)
3409			ctl_isc_announce_port(port);
3410		break;
3411	}
3412	default: {
3413		/* XXX KDM should we fix this? */
3414#if 0
3415		struct ctl_backend_driver *backend;
3416		unsigned int type;
3417		int found;
3418
3419		found = 0;
3420
3421		/*
3422		 * We encode the backend type as the ioctl type for backend
3423		 * ioctls.  So parse it out here, and then search for a
3424		 * backend of this type.
3425		 */
3426		type = _IOC_TYPE(cmd);
3427
3428		STAILQ_FOREACH(backend, &softc->be_list, links) {
3429			if (backend->type == type) {
3430				found = 1;
3431				break;
3432			}
3433		}
3434		if (found == 0) {
3435			printf("ctl: unknown ioctl command %#lx or backend "
3436			       "%d\n", cmd, type);
3437			retval = EINVAL;
3438			break;
3439		}
3440		retval = backend->ioctl(dev, cmd, addr, flag, td);
3441#endif
3442		retval = ENOTTY;
3443		break;
3444	}
3445	}
3446	return (retval);
3447}
3448
3449uint32_t
3450ctl_get_initindex(struct ctl_nexus *nexus)
3451{
3452	return (nexus->initid + (nexus->targ_port * CTL_MAX_INIT_PER_PORT));
3453}
3454
3455int
3456ctl_lun_map_init(struct ctl_port *port)
3457{
3458	struct ctl_softc *softc = port->ctl_softc;
3459	struct ctl_lun *lun;
3460	uint32_t i;
3461
3462	if (port->lun_map == NULL)
3463		port->lun_map = malloc(sizeof(uint32_t) * CTL_MAX_LUNS,
3464		    M_CTL, M_NOWAIT);
3465	if (port->lun_map == NULL)
3466		return (ENOMEM);
3467	for (i = 0; i < CTL_MAX_LUNS; i++)
3468		port->lun_map[i] = UINT32_MAX;
3469	if (port->status & CTL_PORT_STATUS_ONLINE) {
3470		if (port->lun_disable != NULL) {
3471			STAILQ_FOREACH(lun, &softc->lun_list, links)
3472				port->lun_disable(port->targ_lun_arg, lun->lun);
3473		}
3474		ctl_isc_announce_port(port);
3475	}
3476	return (0);
3477}
3478
3479int
3480ctl_lun_map_deinit(struct ctl_port *port)
3481{
3482	struct ctl_softc *softc = port->ctl_softc;
3483	struct ctl_lun *lun;
3484
3485	if (port->lun_map == NULL)
3486		return (0);
3487	free(port->lun_map, M_CTL);
3488	port->lun_map = NULL;
3489	if (port->status & CTL_PORT_STATUS_ONLINE) {
3490		if (port->lun_enable != NULL) {
3491			STAILQ_FOREACH(lun, &softc->lun_list, links)
3492				port->lun_enable(port->targ_lun_arg, lun->lun);
3493		}
3494		ctl_isc_announce_port(port);
3495	}
3496	return (0);
3497}
3498
3499int
3500ctl_lun_map_set(struct ctl_port *port, uint32_t plun, uint32_t glun)
3501{
3502	int status;
3503	uint32_t old;
3504
3505	if (port->lun_map == NULL) {
3506		status = ctl_lun_map_init(port);
3507		if (status != 0)
3508			return (status);
3509	}
3510	old = port->lun_map[plun];
3511	port->lun_map[plun] = glun;
3512	if ((port->status & CTL_PORT_STATUS_ONLINE) && old >= CTL_MAX_LUNS) {
3513		if (port->lun_enable != NULL)
3514			port->lun_enable(port->targ_lun_arg, plun);
3515		ctl_isc_announce_port(port);
3516	}
3517	return (0);
3518}
3519
3520int
3521ctl_lun_map_unset(struct ctl_port *port, uint32_t plun)
3522{
3523	uint32_t old;
3524
3525	if (port->lun_map == NULL)
3526		return (0);
3527	old = port->lun_map[plun];
3528	port->lun_map[plun] = UINT32_MAX;
3529	if ((port->status & CTL_PORT_STATUS_ONLINE) && old < CTL_MAX_LUNS) {
3530		if (port->lun_disable != NULL)
3531			port->lun_disable(port->targ_lun_arg, plun);
3532		ctl_isc_announce_port(port);
3533	}
3534	return (0);
3535}
3536
3537uint32_t
3538ctl_lun_map_from_port(struct ctl_port *port, uint32_t lun_id)
3539{
3540
3541	if (port == NULL)
3542		return (UINT32_MAX);
3543	if (port->lun_map == NULL || lun_id >= CTL_MAX_LUNS)
3544		return (lun_id);
3545	return (port->lun_map[lun_id]);
3546}
3547
3548uint32_t
3549ctl_lun_map_to_port(struct ctl_port *port, uint32_t lun_id)
3550{
3551	uint32_t i;
3552
3553	if (port == NULL)
3554		return (UINT32_MAX);
3555	if (port->lun_map == NULL)
3556		return (lun_id);
3557	for (i = 0; i < CTL_MAX_LUNS; i++) {
3558		if (port->lun_map[i] == lun_id)
3559			return (i);
3560	}
3561	return (UINT32_MAX);
3562}
3563
3564uint32_t
3565ctl_decode_lun(uint64_t encoded)
3566{
3567	uint8_t lun[8];
3568	uint32_t result = 0xffffffff;
3569
3570	be64enc(lun, encoded);
3571	switch (lun[0] & RPL_LUNDATA_ATYP_MASK) {
3572	case RPL_LUNDATA_ATYP_PERIPH:
3573		if ((lun[0] & 0x3f) == 0 && lun[2] == 0 && lun[3] == 0 &&
3574		    lun[4] == 0 && lun[5] == 0 && lun[6] == 0 && lun[7] == 0)
3575			result = lun[1];
3576		break;
3577	case RPL_LUNDATA_ATYP_FLAT:
3578		if (lun[2] == 0 && lun[3] == 0 && lun[4] == 0 && lun[5] == 0 &&
3579		    lun[6] == 0 && lun[7] == 0)
3580			result = ((lun[0] & 0x3f) << 8) + lun[1];
3581		break;
3582	case RPL_LUNDATA_ATYP_EXTLUN:
3583		switch (lun[0] & RPL_LUNDATA_EXT_EAM_MASK) {
3584		case 0x02:
3585			switch (lun[0] & RPL_LUNDATA_EXT_LEN_MASK) {
3586			case 0x00:
3587				result = lun[1];
3588				break;
3589			case 0x10:
3590				result = (lun[1] << 16) + (lun[2] << 8) +
3591				    lun[3];
3592				break;
3593			case 0x20:
3594				if (lun[1] == 0 && lun[6] == 0 && lun[7] == 0)
3595					result = (lun[2] << 24) +
3596					    (lun[3] << 16) + (lun[4] << 8) +
3597					    lun[5];
3598				break;
3599			}
3600			break;
3601		case RPL_LUNDATA_EXT_EAM_NOT_SPEC:
3602			result = 0xffffffff;
3603			break;
3604		}
3605		break;
3606	}
3607	return (result);
3608}
3609
3610uint64_t
3611ctl_encode_lun(uint32_t decoded)
3612{
3613	uint64_t l = decoded;
3614
3615	if (l <= 0xff)
3616		return (((uint64_t)RPL_LUNDATA_ATYP_PERIPH << 56) | (l << 48));
3617	if (l <= 0x3fff)
3618		return (((uint64_t)RPL_LUNDATA_ATYP_FLAT << 56) | (l << 48));
3619	if (l <= 0xffffff)
3620		return (((uint64_t)(RPL_LUNDATA_ATYP_EXTLUN | 0x12) << 56) |
3621		    (l << 32));
3622	return ((((uint64_t)RPL_LUNDATA_ATYP_EXTLUN | 0x22) << 56) | (l << 16));
3623}
3624
3625static struct ctl_port *
3626ctl_io_port(struct ctl_io_hdr *io_hdr)
3627{
3628
3629	return (control_softc->ctl_ports[io_hdr->nexus.targ_port]);
3630}
3631
3632int
3633ctl_ffz(uint32_t *mask, uint32_t first, uint32_t last)
3634{
3635	int i;
3636
3637	for (i = first; i < last; i++) {
3638		if ((mask[i / 32] & (1 << (i % 32))) == 0)
3639			return (i);
3640	}
3641	return (-1);
3642}
3643
3644int
3645ctl_set_mask(uint32_t *mask, uint32_t bit)
3646{
3647	uint32_t chunk, piece;
3648
3649	chunk = bit >> 5;
3650	piece = bit % (sizeof(uint32_t) * 8);
3651
3652	if ((mask[chunk] & (1 << piece)) != 0)
3653		return (-1);
3654	else
3655		mask[chunk] |= (1 << piece);
3656
3657	return (0);
3658}
3659
3660int
3661ctl_clear_mask(uint32_t *mask, uint32_t bit)
3662{
3663	uint32_t chunk, piece;
3664
3665	chunk = bit >> 5;
3666	piece = bit % (sizeof(uint32_t) * 8);
3667
3668	if ((mask[chunk] & (1 << piece)) == 0)
3669		return (-1);
3670	else
3671		mask[chunk] &= ~(1 << piece);
3672
3673	return (0);
3674}
3675
3676int
3677ctl_is_set(uint32_t *mask, uint32_t bit)
3678{
3679	uint32_t chunk, piece;
3680
3681	chunk = bit >> 5;
3682	piece = bit % (sizeof(uint32_t) * 8);
3683
3684	if ((mask[chunk] & (1 << piece)) == 0)
3685		return (0);
3686	else
3687		return (1);
3688}
3689
3690static uint64_t
3691ctl_get_prkey(struct ctl_lun *lun, uint32_t residx)
3692{
3693	uint64_t *t;
3694
3695	t = lun->pr_keys[residx/CTL_MAX_INIT_PER_PORT];
3696	if (t == NULL)
3697		return (0);
3698	return (t[residx % CTL_MAX_INIT_PER_PORT]);
3699}
3700
3701static void
3702ctl_clr_prkey(struct ctl_lun *lun, uint32_t residx)
3703{
3704	uint64_t *t;
3705
3706	t = lun->pr_keys[residx/CTL_MAX_INIT_PER_PORT];
3707	if (t == NULL)
3708		return;
3709	t[residx % CTL_MAX_INIT_PER_PORT] = 0;
3710}
3711
3712static void
3713ctl_alloc_prkey(struct ctl_lun *lun, uint32_t residx)
3714{
3715	uint64_t *p;
3716	u_int i;
3717
3718	i = residx/CTL_MAX_INIT_PER_PORT;
3719	if (lun->pr_keys[i] != NULL)
3720		return;
3721	mtx_unlock(&lun->lun_lock);
3722	p = malloc(sizeof(uint64_t) * CTL_MAX_INIT_PER_PORT, M_CTL,
3723	    M_WAITOK | M_ZERO);
3724	mtx_lock(&lun->lun_lock);
3725	if (lun->pr_keys[i] == NULL)
3726		lun->pr_keys[i] = p;
3727	else
3728		free(p, M_CTL);
3729}
3730
3731static void
3732ctl_set_prkey(struct ctl_lun *lun, uint32_t residx, uint64_t key)
3733{
3734	uint64_t *t;
3735
3736	t = lun->pr_keys[residx/CTL_MAX_INIT_PER_PORT];
3737	KASSERT(t != NULL, ("prkey %d is not allocated", residx));
3738	t[residx % CTL_MAX_INIT_PER_PORT] = key;
3739}
3740
3741/*
3742 * ctl_softc, pool_name, total_ctl_io are passed in.
3743 * npool is passed out.
3744 */
3745int
3746ctl_pool_create(struct ctl_softc *ctl_softc, const char *pool_name,
3747		uint32_t total_ctl_io, void **npool)
3748{
3749#ifdef IO_POOLS
3750	struct ctl_io_pool *pool;
3751
3752	pool = (struct ctl_io_pool *)malloc(sizeof(*pool), M_CTL,
3753					    M_NOWAIT | M_ZERO);
3754	if (pool == NULL)
3755		return (ENOMEM);
3756
3757	snprintf(pool->name, sizeof(pool->name), "CTL IO %s", pool_name);
3758	pool->ctl_softc = ctl_softc;
3759	pool->zone = uma_zsecond_create(pool->name, NULL,
3760	    NULL, NULL, NULL, ctl_softc->io_zone);
3761	/* uma_prealloc(pool->zone, total_ctl_io); */
3762
3763	*npool = pool;
3764#else
3765	*npool = ctl_softc->io_zone;
3766#endif
3767	return (0);
3768}
3769
3770void
3771ctl_pool_free(struct ctl_io_pool *pool)
3772{
3773
3774	if (pool == NULL)
3775		return;
3776
3777#ifdef IO_POOLS
3778	uma_zdestroy(pool->zone);
3779	free(pool, M_CTL);
3780#endif
3781}
3782
3783union ctl_io *
3784ctl_alloc_io(void *pool_ref)
3785{
3786	union ctl_io *io;
3787#ifdef IO_POOLS
3788	struct ctl_io_pool *pool = (struct ctl_io_pool *)pool_ref;
3789
3790	io = uma_zalloc(pool->zone, M_WAITOK);
3791#else
3792	io = uma_zalloc((uma_zone_t)pool_ref, M_WAITOK);
3793#endif
3794	if (io != NULL)
3795		io->io_hdr.pool = pool_ref;
3796	return (io);
3797}
3798
3799union ctl_io *
3800ctl_alloc_io_nowait(void *pool_ref)
3801{
3802	union ctl_io *io;
3803#ifdef IO_POOLS
3804	struct ctl_io_pool *pool = (struct ctl_io_pool *)pool_ref;
3805
3806	io = uma_zalloc(pool->zone, M_NOWAIT);
3807#else
3808	io = uma_zalloc((uma_zone_t)pool_ref, M_NOWAIT);
3809#endif
3810	if (io != NULL)
3811		io->io_hdr.pool = pool_ref;
3812	return (io);
3813}
3814
3815void
3816ctl_free_io(union ctl_io *io)
3817{
3818#ifdef IO_POOLS
3819	struct ctl_io_pool *pool;
3820#endif
3821
3822	if (io == NULL)
3823		return;
3824
3825#ifdef IO_POOLS
3826	pool = (struct ctl_io_pool *)io->io_hdr.pool;
3827	uma_zfree(pool->zone, io);
3828#else
3829	uma_zfree((uma_zone_t)io->io_hdr.pool, io);
3830#endif
3831}
3832
3833void
3834ctl_zero_io(union ctl_io *io)
3835{
3836	void *pool_ref;
3837
3838	if (io == NULL)
3839		return;
3840
3841	/*
3842	 * May need to preserve linked list pointers at some point too.
3843	 */
3844	pool_ref = io->io_hdr.pool;
3845	memset(io, 0, sizeof(*io));
3846	io->io_hdr.pool = pool_ref;
3847}
3848
3849int
3850ctl_expand_number(const char *buf, uint64_t *num)
3851{
3852	char *endptr;
3853	uint64_t number;
3854	unsigned shift;
3855
3856	number = strtoq(buf, &endptr, 0);
3857
3858	switch (tolower((unsigned char)*endptr)) {
3859	case 'e':
3860		shift = 60;
3861		break;
3862	case 'p':
3863		shift = 50;
3864		break;
3865	case 't':
3866		shift = 40;
3867		break;
3868	case 'g':
3869		shift = 30;
3870		break;
3871	case 'm':
3872		shift = 20;
3873		break;
3874	case 'k':
3875		shift = 10;
3876		break;
3877	case 'b':
3878	case '\0': /* No unit. */
3879		*num = number;
3880		return (0);
3881	default:
3882		/* Unrecognized unit. */
3883		return (-1);
3884	}
3885
3886	if ((number << shift) >> shift != number) {
3887		/* Overflow */
3888		return (-1);
3889	}
3890	*num = number << shift;
3891	return (0);
3892}
3893
3894
3895/*
3896 * This routine could be used in the future to load default and/or saved
3897 * mode page parameters for a particuar lun.
3898 */
3899static int
3900ctl_init_page_index(struct ctl_lun *lun)
3901{
3902	int i, page_code;
3903	struct ctl_page_index *page_index;
3904	const char *value;
3905	uint64_t ival;
3906
3907	memcpy(&lun->mode_pages.index, page_index_template,
3908	       sizeof(page_index_template));
3909
3910	for (i = 0; i < CTL_NUM_MODE_PAGES; i++) {
3911
3912		page_index = &lun->mode_pages.index[i];
3913		if (lun->be_lun->lun_type == T_DIRECT &&
3914		    (page_index->page_flags & CTL_PAGE_FLAG_DIRECT) == 0)
3915			continue;
3916		if (lun->be_lun->lun_type == T_PROCESSOR &&
3917		    (page_index->page_flags & CTL_PAGE_FLAG_PROC) == 0)
3918			continue;
3919		if (lun->be_lun->lun_type == T_CDROM &&
3920		    (page_index->page_flags & CTL_PAGE_FLAG_CDROM) == 0)
3921			continue;
3922
3923		page_code = page_index->page_code & SMPH_PC_MASK;
3924		switch (page_code) {
3925		case SMS_RW_ERROR_RECOVERY_PAGE: {
3926			KASSERT(page_index->subpage == SMS_SUBPAGE_PAGE_0,
3927			    ("subpage %#x for page %#x is incorrect!",
3928			    page_index->subpage, page_code));
3929			memcpy(&lun->mode_pages.rw_er_page[CTL_PAGE_CURRENT],
3930			       &rw_er_page_default,
3931			       sizeof(rw_er_page_default));
3932			memcpy(&lun->mode_pages.rw_er_page[CTL_PAGE_CHANGEABLE],
3933			       &rw_er_page_changeable,
3934			       sizeof(rw_er_page_changeable));
3935			memcpy(&lun->mode_pages.rw_er_page[CTL_PAGE_DEFAULT],
3936			       &rw_er_page_default,
3937			       sizeof(rw_er_page_default));
3938			memcpy(&lun->mode_pages.rw_er_page[CTL_PAGE_SAVED],
3939			       &rw_er_page_default,
3940			       sizeof(rw_er_page_default));
3941			page_index->page_data =
3942				(uint8_t *)lun->mode_pages.rw_er_page;
3943			break;
3944		}
3945		case SMS_FORMAT_DEVICE_PAGE: {
3946			struct scsi_format_page *format_page;
3947
3948			KASSERT(page_index->subpage == SMS_SUBPAGE_PAGE_0,
3949			    ("subpage %#x for page %#x is incorrect!",
3950			    page_index->subpage, page_code));
3951
3952			/*
3953			 * Sectors per track are set above.  Bytes per
3954			 * sector need to be set here on a per-LUN basis.
3955			 */
3956			memcpy(&lun->mode_pages.format_page[CTL_PAGE_CURRENT],
3957			       &format_page_default,
3958			       sizeof(format_page_default));
3959			memcpy(&lun->mode_pages.format_page[
3960			       CTL_PAGE_CHANGEABLE], &format_page_changeable,
3961			       sizeof(format_page_changeable));
3962			memcpy(&lun->mode_pages.format_page[CTL_PAGE_DEFAULT],
3963			       &format_page_default,
3964			       sizeof(format_page_default));
3965			memcpy(&lun->mode_pages.format_page[CTL_PAGE_SAVED],
3966			       &format_page_default,
3967			       sizeof(format_page_default));
3968
3969			format_page = &lun->mode_pages.format_page[
3970				CTL_PAGE_CURRENT];
3971			scsi_ulto2b(lun->be_lun->blocksize,
3972				    format_page->bytes_per_sector);
3973
3974			format_page = &lun->mode_pages.format_page[
3975				CTL_PAGE_DEFAULT];
3976			scsi_ulto2b(lun->be_lun->blocksize,
3977				    format_page->bytes_per_sector);
3978
3979			format_page = &lun->mode_pages.format_page[
3980				CTL_PAGE_SAVED];
3981			scsi_ulto2b(lun->be_lun->blocksize,
3982				    format_page->bytes_per_sector);
3983
3984			page_index->page_data =
3985				(uint8_t *)lun->mode_pages.format_page;
3986			break;
3987		}
3988		case SMS_RIGID_DISK_PAGE: {
3989			struct scsi_rigid_disk_page *rigid_disk_page;
3990			uint32_t sectors_per_cylinder;
3991			uint64_t cylinders;
3992#ifndef	__XSCALE__
3993			int shift;
3994#endif /* !__XSCALE__ */
3995
3996			KASSERT(page_index->subpage == SMS_SUBPAGE_PAGE_0,
3997			    ("subpage %#x for page %#x is incorrect!",
3998			    page_index->subpage, page_code));
3999
4000			/*
4001			 * Rotation rate and sectors per track are set
4002			 * above.  We calculate the cylinders here based on
4003			 * capacity.  Due to the number of heads and
4004			 * sectors per track we're using, smaller arrays
4005			 * may turn out to have 0 cylinders.  Linux and
4006			 * FreeBSD don't pay attention to these mode pages
4007			 * to figure out capacity, but Solaris does.  It
4008			 * seems to deal with 0 cylinders just fine, and
4009			 * works out a fake geometry based on the capacity.
4010			 */
4011			memcpy(&lun->mode_pages.rigid_disk_page[
4012			       CTL_PAGE_DEFAULT], &rigid_disk_page_default,
4013			       sizeof(rigid_disk_page_default));
4014			memcpy(&lun->mode_pages.rigid_disk_page[
4015			       CTL_PAGE_CHANGEABLE],&rigid_disk_page_changeable,
4016			       sizeof(rigid_disk_page_changeable));
4017
4018			sectors_per_cylinder = CTL_DEFAULT_SECTORS_PER_TRACK *
4019				CTL_DEFAULT_HEADS;
4020
4021			/*
4022			 * The divide method here will be more accurate,
4023			 * probably, but results in floating point being
4024			 * used in the kernel on i386 (__udivdi3()).  On the
4025			 * XScale, though, __udivdi3() is implemented in
4026			 * software.
4027			 *
4028			 * The shift method for cylinder calculation is
4029			 * accurate if sectors_per_cylinder is a power of
4030			 * 2.  Otherwise it might be slightly off -- you
4031			 * might have a bit of a truncation problem.
4032			 */
4033#ifdef	__XSCALE__
4034			cylinders = (lun->be_lun->maxlba + 1) /
4035				sectors_per_cylinder;
4036#else
4037			for (shift = 31; shift > 0; shift--) {
4038				if (sectors_per_cylinder & (1 << shift))
4039					break;
4040			}
4041			cylinders = (lun->be_lun->maxlba + 1) >> shift;
4042#endif
4043
4044			/*
4045			 * We've basically got 3 bytes, or 24 bits for the
4046			 * cylinder size in the mode page.  If we're over,
4047			 * just round down to 2^24.
4048			 */
4049			if (cylinders > 0xffffff)
4050				cylinders = 0xffffff;
4051
4052			rigid_disk_page = &lun->mode_pages.rigid_disk_page[
4053				CTL_PAGE_DEFAULT];
4054			scsi_ulto3b(cylinders, rigid_disk_page->cylinders);
4055
4056			if ((value = ctl_get_opt(&lun->be_lun->options,
4057			    "rpm")) != NULL) {
4058				scsi_ulto2b(strtol(value, NULL, 0),
4059				     rigid_disk_page->rotation_rate);
4060			}
4061
4062			memcpy(&lun->mode_pages.rigid_disk_page[CTL_PAGE_CURRENT],
4063			       &lun->mode_pages.rigid_disk_page[CTL_PAGE_DEFAULT],
4064			       sizeof(rigid_disk_page_default));
4065			memcpy(&lun->mode_pages.rigid_disk_page[CTL_PAGE_SAVED],
4066			       &lun->mode_pages.rigid_disk_page[CTL_PAGE_DEFAULT],
4067			       sizeof(rigid_disk_page_default));
4068
4069			page_index->page_data =
4070				(uint8_t *)lun->mode_pages.rigid_disk_page;
4071			break;
4072		}
4073		case SMS_VERIFY_ERROR_RECOVERY_PAGE: {
4074			KASSERT(page_index->subpage == SMS_SUBPAGE_PAGE_0,
4075			    ("subpage %#x for page %#x is incorrect!",
4076			    page_index->subpage, page_code));
4077			memcpy(&lun->mode_pages.verify_er_page[CTL_PAGE_CURRENT],
4078			       &verify_er_page_default,
4079			       sizeof(verify_er_page_default));
4080			memcpy(&lun->mode_pages.verify_er_page[CTL_PAGE_CHANGEABLE],
4081			       &verify_er_page_changeable,
4082			       sizeof(verify_er_page_changeable));
4083			memcpy(&lun->mode_pages.verify_er_page[CTL_PAGE_DEFAULT],
4084			       &verify_er_page_default,
4085			       sizeof(verify_er_page_default));
4086			memcpy(&lun->mode_pages.verify_er_page[CTL_PAGE_SAVED],
4087			       &verify_er_page_default,
4088			       sizeof(verify_er_page_default));
4089			page_index->page_data =
4090				(uint8_t *)lun->mode_pages.verify_er_page;
4091			break;
4092		}
4093		case SMS_CACHING_PAGE: {
4094			struct scsi_caching_page *caching_page;
4095
4096			KASSERT(page_index->subpage == SMS_SUBPAGE_PAGE_0,
4097			    ("subpage %#x for page %#x is incorrect!",
4098			    page_index->subpage, page_code));
4099			memcpy(&lun->mode_pages.caching_page[CTL_PAGE_DEFAULT],
4100			       &caching_page_default,
4101			       sizeof(caching_page_default));
4102			memcpy(&lun->mode_pages.caching_page[
4103			       CTL_PAGE_CHANGEABLE], &caching_page_changeable,
4104			       sizeof(caching_page_changeable));
4105			memcpy(&lun->mode_pages.caching_page[CTL_PAGE_SAVED],
4106			       &caching_page_default,
4107			       sizeof(caching_page_default));
4108			caching_page = &lun->mode_pages.caching_page[
4109			    CTL_PAGE_SAVED];
4110			value = ctl_get_opt(&lun->be_lun->options, "writecache");
4111			if (value != NULL && strcmp(value, "off") == 0)
4112				caching_page->flags1 &= ~SCP_WCE;
4113			value = ctl_get_opt(&lun->be_lun->options, "readcache");
4114			if (value != NULL && strcmp(value, "off") == 0)
4115				caching_page->flags1 |= SCP_RCD;
4116			memcpy(&lun->mode_pages.caching_page[CTL_PAGE_CURRENT],
4117			       &lun->mode_pages.caching_page[CTL_PAGE_SAVED],
4118			       sizeof(caching_page_default));
4119			page_index->page_data =
4120				(uint8_t *)lun->mode_pages.caching_page;
4121			break;
4122		}
4123		case SMS_CONTROL_MODE_PAGE: {
4124			switch (page_index->subpage) {
4125			case SMS_SUBPAGE_PAGE_0: {
4126				struct scsi_control_page *control_page;
4127
4128				memcpy(&lun->mode_pages.control_page[
4129				    CTL_PAGE_DEFAULT],
4130				       &control_page_default,
4131				       sizeof(control_page_default));
4132				memcpy(&lun->mode_pages.control_page[
4133				    CTL_PAGE_CHANGEABLE],
4134				       &control_page_changeable,
4135				       sizeof(control_page_changeable));
4136				memcpy(&lun->mode_pages.control_page[
4137				    CTL_PAGE_SAVED],
4138				       &control_page_default,
4139				       sizeof(control_page_default));
4140				control_page = &lun->mode_pages.control_page[
4141				    CTL_PAGE_SAVED];
4142				value = ctl_get_opt(&lun->be_lun->options,
4143				    "reordering");
4144				if (value != NULL &&
4145				    strcmp(value, "unrestricted") == 0) {
4146					control_page->queue_flags &=
4147					    ~SCP_QUEUE_ALG_MASK;
4148					control_page->queue_flags |=
4149					    SCP_QUEUE_ALG_UNRESTRICTED;
4150				}
4151				memcpy(&lun->mode_pages.control_page[
4152				    CTL_PAGE_CURRENT],
4153				       &lun->mode_pages.control_page[
4154				    CTL_PAGE_SAVED],
4155				       sizeof(control_page_default));
4156				page_index->page_data =
4157				    (uint8_t *)lun->mode_pages.control_page;
4158				break;
4159			}
4160			case 0x01:
4161				memcpy(&lun->mode_pages.control_ext_page[
4162				    CTL_PAGE_DEFAULT],
4163				       &control_ext_page_default,
4164				       sizeof(control_ext_page_default));
4165				memcpy(&lun->mode_pages.control_ext_page[
4166				    CTL_PAGE_CHANGEABLE],
4167				       &control_ext_page_changeable,
4168				       sizeof(control_ext_page_changeable));
4169				memcpy(&lun->mode_pages.control_ext_page[
4170				    CTL_PAGE_SAVED],
4171				       &control_ext_page_default,
4172				       sizeof(control_ext_page_default));
4173				memcpy(&lun->mode_pages.control_ext_page[
4174				    CTL_PAGE_CURRENT],
4175				       &lun->mode_pages.control_ext_page[
4176				    CTL_PAGE_SAVED],
4177				       sizeof(control_ext_page_default));
4178				page_index->page_data =
4179				    (uint8_t *)lun->mode_pages.control_ext_page;
4180				break;
4181			default:
4182				panic("subpage %#x for page %#x is incorrect!",
4183				      page_index->subpage, page_code);
4184			}
4185			break;
4186		}
4187		case SMS_INFO_EXCEPTIONS_PAGE: {
4188			switch (page_index->subpage) {
4189			case SMS_SUBPAGE_PAGE_0:
4190				memcpy(&lun->mode_pages.ie_page[CTL_PAGE_CURRENT],
4191				       &ie_page_default,
4192				       sizeof(ie_page_default));
4193				memcpy(&lun->mode_pages.ie_page[
4194				       CTL_PAGE_CHANGEABLE], &ie_page_changeable,
4195				       sizeof(ie_page_changeable));
4196				memcpy(&lun->mode_pages.ie_page[CTL_PAGE_DEFAULT],
4197				       &ie_page_default,
4198				       sizeof(ie_page_default));
4199				memcpy(&lun->mode_pages.ie_page[CTL_PAGE_SAVED],
4200				       &ie_page_default,
4201				       sizeof(ie_page_default));
4202				page_index->page_data =
4203					(uint8_t *)lun->mode_pages.ie_page;
4204				break;
4205			case 0x02: {
4206				struct ctl_logical_block_provisioning_page *page;
4207
4208				memcpy(&lun->mode_pages.lbp_page[CTL_PAGE_DEFAULT],
4209				       &lbp_page_default,
4210				       sizeof(lbp_page_default));
4211				memcpy(&lun->mode_pages.lbp_page[
4212				       CTL_PAGE_CHANGEABLE], &lbp_page_changeable,
4213				       sizeof(lbp_page_changeable));
4214				memcpy(&lun->mode_pages.lbp_page[CTL_PAGE_SAVED],
4215				       &lbp_page_default,
4216				       sizeof(lbp_page_default));
4217				page = &lun->mode_pages.lbp_page[CTL_PAGE_SAVED];
4218				value = ctl_get_opt(&lun->be_lun->options,
4219				    "avail-threshold");
4220				if (value != NULL &&
4221				    ctl_expand_number(value, &ival) == 0) {
4222					page->descr[0].flags |= SLBPPD_ENABLED |
4223					    SLBPPD_ARMING_DEC;
4224					if (lun->be_lun->blocksize)
4225						ival /= lun->be_lun->blocksize;
4226					else
4227						ival /= 512;
4228					scsi_ulto4b(ival >> CTL_LBP_EXPONENT,
4229					    page->descr[0].count);
4230				}
4231				value = ctl_get_opt(&lun->be_lun->options,
4232				    "used-threshold");
4233				if (value != NULL &&
4234				    ctl_expand_number(value, &ival) == 0) {
4235					page->descr[1].flags |= SLBPPD_ENABLED |
4236					    SLBPPD_ARMING_INC;
4237					if (lun->be_lun->blocksize)
4238						ival /= lun->be_lun->blocksize;
4239					else
4240						ival /= 512;
4241					scsi_ulto4b(ival >> CTL_LBP_EXPONENT,
4242					    page->descr[1].count);
4243				}
4244				value = ctl_get_opt(&lun->be_lun->options,
4245				    "pool-avail-threshold");
4246				if (value != NULL &&
4247				    ctl_expand_number(value, &ival) == 0) {
4248					page->descr[2].flags |= SLBPPD_ENABLED |
4249					    SLBPPD_ARMING_DEC;
4250					if (lun->be_lun->blocksize)
4251						ival /= lun->be_lun->blocksize;
4252					else
4253						ival /= 512;
4254					scsi_ulto4b(ival >> CTL_LBP_EXPONENT,
4255					    page->descr[2].count);
4256				}
4257				value = ctl_get_opt(&lun->be_lun->options,
4258				    "pool-used-threshold");
4259				if (value != NULL &&
4260				    ctl_expand_number(value, &ival) == 0) {
4261					page->descr[3].flags |= SLBPPD_ENABLED |
4262					    SLBPPD_ARMING_INC;
4263					if (lun->be_lun->blocksize)
4264						ival /= lun->be_lun->blocksize;
4265					else
4266						ival /= 512;
4267					scsi_ulto4b(ival >> CTL_LBP_EXPONENT,
4268					    page->descr[3].count);
4269				}
4270				memcpy(&lun->mode_pages.lbp_page[CTL_PAGE_CURRENT],
4271				       &lun->mode_pages.lbp_page[CTL_PAGE_SAVED],
4272				       sizeof(lbp_page_default));
4273				page_index->page_data =
4274					(uint8_t *)lun->mode_pages.lbp_page;
4275				break;
4276			}
4277			default:
4278				panic("subpage %#x for page %#x is incorrect!",
4279				      page_index->subpage, page_code);
4280			}
4281			break;
4282		}
4283		case SMS_CDDVD_CAPS_PAGE:{
4284			KASSERT(page_index->subpage == SMS_SUBPAGE_PAGE_0,
4285			    ("subpage %#x for page %#x is incorrect!",
4286			    page_index->subpage, page_code));
4287			memcpy(&lun->mode_pages.cddvd_page[CTL_PAGE_DEFAULT],
4288			       &cddvd_page_default,
4289			       sizeof(cddvd_page_default));
4290			memcpy(&lun->mode_pages.cddvd_page[
4291			       CTL_PAGE_CHANGEABLE], &cddvd_page_changeable,
4292			       sizeof(cddvd_page_changeable));
4293			memcpy(&lun->mode_pages.cddvd_page[CTL_PAGE_SAVED],
4294			       &cddvd_page_default,
4295			       sizeof(cddvd_page_default));
4296			memcpy(&lun->mode_pages.cddvd_page[CTL_PAGE_CURRENT],
4297			       &lun->mode_pages.cddvd_page[CTL_PAGE_SAVED],
4298			       sizeof(cddvd_page_default));
4299			page_index->page_data =
4300				(uint8_t *)lun->mode_pages.cddvd_page;
4301			break;
4302		}
4303		default:
4304			panic("invalid page code value %#x", page_code);
4305		}
4306	}
4307
4308	return (CTL_RETVAL_COMPLETE);
4309}
4310
4311static int
4312ctl_init_log_page_index(struct ctl_lun *lun)
4313{
4314	struct ctl_page_index *page_index;
4315	int i, j, k, prev;
4316
4317	memcpy(&lun->log_pages.index, log_page_index_template,
4318	       sizeof(log_page_index_template));
4319
4320	prev = -1;
4321	for (i = 0, j = 0, k = 0; i < CTL_NUM_LOG_PAGES; i++) {
4322
4323		page_index = &lun->log_pages.index[i];
4324		if (lun->be_lun->lun_type == T_DIRECT &&
4325		    (page_index->page_flags & CTL_PAGE_FLAG_DIRECT) == 0)
4326			continue;
4327		if (lun->be_lun->lun_type == T_PROCESSOR &&
4328		    (page_index->page_flags & CTL_PAGE_FLAG_PROC) == 0)
4329			continue;
4330		if (lun->be_lun->lun_type == T_CDROM &&
4331		    (page_index->page_flags & CTL_PAGE_FLAG_CDROM) == 0)
4332			continue;
4333
4334		if (page_index->page_code == SLS_LOGICAL_BLOCK_PROVISIONING &&
4335		    lun->backend->lun_attr == NULL)
4336			continue;
4337
4338		if (page_index->page_code != prev) {
4339			lun->log_pages.pages_page[j] = page_index->page_code;
4340			prev = page_index->page_code;
4341			j++;
4342		}
4343		lun->log_pages.subpages_page[k*2] = page_index->page_code;
4344		lun->log_pages.subpages_page[k*2+1] = page_index->subpage;
4345		k++;
4346	}
4347	lun->log_pages.index[0].page_data = &lun->log_pages.pages_page[0];
4348	lun->log_pages.index[0].page_len = j;
4349	lun->log_pages.index[1].page_data = &lun->log_pages.subpages_page[0];
4350	lun->log_pages.index[1].page_len = k * 2;
4351	lun->log_pages.index[2].page_data = &lun->log_pages.lbp_page[0];
4352	lun->log_pages.index[2].page_len = 12*CTL_NUM_LBP_PARAMS;
4353	lun->log_pages.index[3].page_data = (uint8_t *)&lun->log_pages.stat_page;
4354	lun->log_pages.index[3].page_len = sizeof(lun->log_pages.stat_page);
4355	lun->log_pages.index[4].page_data = (uint8_t *)&lun->log_pages.ie_page;
4356	lun->log_pages.index[4].page_len = sizeof(lun->log_pages.ie_page);
4357
4358	return (CTL_RETVAL_COMPLETE);
4359}
4360
4361static int
4362hex2bin(const char *str, uint8_t *buf, int buf_size)
4363{
4364	int i;
4365	u_char c;
4366
4367	memset(buf, 0, buf_size);
4368	while (isspace(str[0]))
4369		str++;
4370	if (str[0] == '0' && (str[1] == 'x' || str[1] == 'X'))
4371		str += 2;
4372	buf_size *= 2;
4373	for (i = 0; str[i] != 0 && i < buf_size; i++) {
4374		c = str[i];
4375		if (isdigit(c))
4376			c -= '0';
4377		else if (isalpha(c))
4378			c -= isupper(c) ? 'A' - 10 : 'a' - 10;
4379		else
4380			break;
4381		if (c >= 16)
4382			break;
4383		if ((i & 1) == 0)
4384			buf[i / 2] |= (c << 4);
4385		else
4386			buf[i / 2] |= c;
4387	}
4388	return ((i + 1) / 2);
4389}
4390
4391/*
4392 * LUN allocation.
4393 *
4394 * Requirements:
4395 * - caller allocates and zeros LUN storage, or passes in a NULL LUN if he
4396 *   wants us to allocate the LUN and he can block.
4397 * - ctl_softc is always set
4398 * - be_lun is set if the LUN has a backend (needed for disk LUNs)
4399 *
4400 * Returns 0 for success, non-zero (errno) for failure.
4401 */
4402static int
4403ctl_alloc_lun(struct ctl_softc *ctl_softc, struct ctl_lun *ctl_lun,
4404	      struct ctl_be_lun *const be_lun)
4405{
4406	struct ctl_lun *nlun, *lun;
4407	struct scsi_vpd_id_descriptor *desc;
4408	struct scsi_vpd_id_t10 *t10id;
4409	const char *eui, *naa, *scsiname, *vendor, *value;
4410	int lun_number, i, lun_malloced;
4411	int devidlen, idlen1, idlen2 = 0, len;
4412
4413	if (be_lun == NULL)
4414		return (EINVAL);
4415
4416	/*
4417	 * We currently only support Direct Access or Processor LUN types.
4418	 */
4419	switch (be_lun->lun_type) {
4420	case T_DIRECT:
4421	case T_PROCESSOR:
4422	case T_CDROM:
4423		break;
4424	case T_SEQUENTIAL:
4425	case T_CHANGER:
4426	default:
4427		be_lun->lun_config_status(be_lun->be_lun,
4428					  CTL_LUN_CONFIG_FAILURE);
4429		break;
4430	}
4431	if (ctl_lun == NULL) {
4432		lun = malloc(sizeof(*lun), M_CTL, M_WAITOK);
4433		lun_malloced = 1;
4434	} else {
4435		lun_malloced = 0;
4436		lun = ctl_lun;
4437	}
4438
4439	memset(lun, 0, sizeof(*lun));
4440	if (lun_malloced)
4441		lun->flags = CTL_LUN_MALLOCED;
4442
4443	/* Generate LUN ID. */
4444	devidlen = max(CTL_DEVID_MIN_LEN,
4445	    strnlen(be_lun->device_id, CTL_DEVID_LEN));
4446	idlen1 = sizeof(*t10id) + devidlen;
4447	len = sizeof(struct scsi_vpd_id_descriptor) + idlen1;
4448	scsiname = ctl_get_opt(&be_lun->options, "scsiname");
4449	if (scsiname != NULL) {
4450		idlen2 = roundup2(strlen(scsiname) + 1, 4);
4451		len += sizeof(struct scsi_vpd_id_descriptor) + idlen2;
4452	}
4453	eui = ctl_get_opt(&be_lun->options, "eui");
4454	if (eui != NULL) {
4455		len += sizeof(struct scsi_vpd_id_descriptor) + 16;
4456	}
4457	naa = ctl_get_opt(&be_lun->options, "naa");
4458	if (naa != NULL) {
4459		len += sizeof(struct scsi_vpd_id_descriptor) + 16;
4460	}
4461	lun->lun_devid = malloc(sizeof(struct ctl_devid) + len,
4462	    M_CTL, M_WAITOK | M_ZERO);
4463	desc = (struct scsi_vpd_id_descriptor *)lun->lun_devid->data;
4464	desc->proto_codeset = SVPD_ID_CODESET_ASCII;
4465	desc->id_type = SVPD_ID_PIV | SVPD_ID_ASSOC_LUN | SVPD_ID_TYPE_T10;
4466	desc->length = idlen1;
4467	t10id = (struct scsi_vpd_id_t10 *)&desc->identifier[0];
4468	memset(t10id->vendor, ' ', sizeof(t10id->vendor));
4469	if ((vendor = ctl_get_opt(&be_lun->options, "vendor")) == NULL) {
4470		strncpy((char *)t10id->vendor, CTL_VENDOR, sizeof(t10id->vendor));
4471	} else {
4472		strncpy(t10id->vendor, vendor,
4473		    min(sizeof(t10id->vendor), strlen(vendor)));
4474	}
4475	strncpy((char *)t10id->vendor_spec_id,
4476	    (char *)be_lun->device_id, devidlen);
4477	if (scsiname != NULL) {
4478		desc = (struct scsi_vpd_id_descriptor *)(&desc->identifier[0] +
4479		    desc->length);
4480		desc->proto_codeset = SVPD_ID_CODESET_UTF8;
4481		desc->id_type = SVPD_ID_PIV | SVPD_ID_ASSOC_LUN |
4482		    SVPD_ID_TYPE_SCSI_NAME;
4483		desc->length = idlen2;
4484		strlcpy(desc->identifier, scsiname, idlen2);
4485	}
4486	if (eui != NULL) {
4487		desc = (struct scsi_vpd_id_descriptor *)(&desc->identifier[0] +
4488		    desc->length);
4489		desc->proto_codeset = SVPD_ID_CODESET_BINARY;
4490		desc->id_type = SVPD_ID_PIV | SVPD_ID_ASSOC_LUN |
4491		    SVPD_ID_TYPE_EUI64;
4492		desc->length = hex2bin(eui, desc->identifier, 16);
4493		desc->length = desc->length > 12 ? 16 :
4494		    (desc->length > 8 ? 12 : 8);
4495		len -= 16 - desc->length;
4496	}
4497	if (naa != NULL) {
4498		desc = (struct scsi_vpd_id_descriptor *)(&desc->identifier[0] +
4499		    desc->length);
4500		desc->proto_codeset = SVPD_ID_CODESET_BINARY;
4501		desc->id_type = SVPD_ID_PIV | SVPD_ID_ASSOC_LUN |
4502		    SVPD_ID_TYPE_NAA;
4503		desc->length = hex2bin(naa, desc->identifier, 16);
4504		desc->length = desc->length > 8 ? 16 : 8;
4505		len -= 16 - desc->length;
4506	}
4507	lun->lun_devid->len = len;
4508
4509	mtx_lock(&ctl_softc->ctl_lock);
4510	/*
4511	 * See if the caller requested a particular LUN number.  If so, see
4512	 * if it is available.  Otherwise, allocate the first available LUN.
4513	 */
4514	if (be_lun->flags & CTL_LUN_FLAG_ID_REQ) {
4515		if ((be_lun->req_lun_id > (CTL_MAX_LUNS - 1))
4516		 || (ctl_is_set(ctl_softc->ctl_lun_mask, be_lun->req_lun_id))) {
4517			mtx_unlock(&ctl_softc->ctl_lock);
4518			if (be_lun->req_lun_id > (CTL_MAX_LUNS - 1)) {
4519				printf("ctl: requested LUN ID %d is higher "
4520				       "than CTL_MAX_LUNS - 1 (%d)\n",
4521				       be_lun->req_lun_id, CTL_MAX_LUNS - 1);
4522			} else {
4523				/*
4524				 * XXX KDM return an error, or just assign
4525				 * another LUN ID in this case??
4526				 */
4527				printf("ctl: requested LUN ID %d is already "
4528				       "in use\n", be_lun->req_lun_id);
4529			}
4530			if (lun->flags & CTL_LUN_MALLOCED)
4531				free(lun, M_CTL);
4532			be_lun->lun_config_status(be_lun->be_lun,
4533						  CTL_LUN_CONFIG_FAILURE);
4534			return (ENOSPC);
4535		}
4536		lun_number = be_lun->req_lun_id;
4537	} else {
4538		lun_number = ctl_ffz(ctl_softc->ctl_lun_mask, 0, CTL_MAX_LUNS);
4539		if (lun_number == -1) {
4540			mtx_unlock(&ctl_softc->ctl_lock);
4541			printf("ctl: can't allocate LUN, out of LUNs\n");
4542			if (lun->flags & CTL_LUN_MALLOCED)
4543				free(lun, M_CTL);
4544			be_lun->lun_config_status(be_lun->be_lun,
4545						  CTL_LUN_CONFIG_FAILURE);
4546			return (ENOSPC);
4547		}
4548	}
4549	ctl_set_mask(ctl_softc->ctl_lun_mask, lun_number);
4550
4551	mtx_init(&lun->lun_lock, "CTL LUN", NULL, MTX_DEF);
4552	lun->lun = lun_number;
4553	lun->be_lun = be_lun;
4554	/*
4555	 * The processor LUN is always enabled.  Disk LUNs come on line
4556	 * disabled, and must be enabled by the backend.
4557	 */
4558	lun->flags |= CTL_LUN_DISABLED;
4559	lun->backend = be_lun->be;
4560	be_lun->ctl_lun = lun;
4561	be_lun->lun_id = lun_number;
4562	atomic_add_int(&be_lun->be->num_luns, 1);
4563	if (be_lun->flags & CTL_LUN_FLAG_EJECTED)
4564		lun->flags |= CTL_LUN_EJECTED;
4565	if (be_lun->flags & CTL_LUN_FLAG_NO_MEDIA)
4566		lun->flags |= CTL_LUN_NO_MEDIA;
4567	if (be_lun->flags & CTL_LUN_FLAG_STOPPED)
4568		lun->flags |= CTL_LUN_STOPPED;
4569
4570	if (be_lun->flags & CTL_LUN_FLAG_PRIMARY)
4571		lun->flags |= CTL_LUN_PRIMARY_SC;
4572
4573	value = ctl_get_opt(&be_lun->options, "removable");
4574	if (value != NULL) {
4575		if (strcmp(value, "on") == 0)
4576			lun->flags |= CTL_LUN_REMOVABLE;
4577	} else if (be_lun->lun_type == T_CDROM)
4578		lun->flags |= CTL_LUN_REMOVABLE;
4579
4580	lun->ctl_softc = ctl_softc;
4581#ifdef CTL_TIME_IO
4582	lun->last_busy = getsbinuptime();
4583#endif
4584	TAILQ_INIT(&lun->ooa_queue);
4585	TAILQ_INIT(&lun->blocked_queue);
4586	STAILQ_INIT(&lun->error_list);
4587	lun->ie_reported = 1;
4588	callout_init_mtx(&lun->ie_callout, &lun->lun_lock, 0);
4589	ctl_tpc_lun_init(lun);
4590
4591	/*
4592	 * Initialize the mode and log page index.
4593	 */
4594	ctl_init_page_index(lun);
4595	ctl_init_log_page_index(lun);
4596
4597	/*
4598	 * Now, before we insert this lun on the lun list, set the lun
4599	 * inventory changed UA for all other luns.
4600	 */
4601	STAILQ_FOREACH(nlun, &ctl_softc->lun_list, links) {
4602		mtx_lock(&nlun->lun_lock);
4603		ctl_est_ua_all(nlun, -1, CTL_UA_LUN_CHANGE);
4604		mtx_unlock(&nlun->lun_lock);
4605	}
4606
4607	STAILQ_INSERT_TAIL(&ctl_softc->lun_list, lun, links);
4608
4609	ctl_softc->ctl_luns[lun_number] = lun;
4610
4611	ctl_softc->num_luns++;
4612
4613	/* Setup statistics gathering */
4614	lun->stats.device_type = be_lun->lun_type;
4615	lun->stats.lun_number = lun_number;
4616	lun->stats.blocksize = be_lun->blocksize;
4617	if (be_lun->blocksize == 0)
4618		lun->stats.flags = CTL_LUN_STATS_NO_BLOCKSIZE;
4619	for (i = 0;i < CTL_MAX_PORTS;i++)
4620		lun->stats.ports[i].targ_port = i;
4621
4622	mtx_unlock(&ctl_softc->ctl_lock);
4623
4624	lun->be_lun->lun_config_status(lun->be_lun->be_lun, CTL_LUN_CONFIG_OK);
4625	return (0);
4626}
4627
4628/*
4629 * Delete a LUN.
4630 * Assumptions:
4631 * - LUN has already been marked invalid and any pending I/O has been taken
4632 *   care of.
4633 */
4634static int
4635ctl_free_lun(struct ctl_lun *lun)
4636{
4637	struct ctl_softc *softc;
4638	struct ctl_lun *nlun;
4639	int i;
4640
4641	softc = lun->ctl_softc;
4642
4643	mtx_assert(&softc->ctl_lock, MA_OWNED);
4644
4645	STAILQ_REMOVE(&softc->lun_list, lun, ctl_lun, links);
4646
4647	ctl_clear_mask(softc->ctl_lun_mask, lun->lun);
4648
4649	softc->ctl_luns[lun->lun] = NULL;
4650
4651	if (!TAILQ_EMPTY(&lun->ooa_queue))
4652		panic("Freeing a LUN %p with outstanding I/O!!\n", lun);
4653
4654	softc->num_luns--;
4655
4656	/*
4657	 * Tell the backend to free resources, if this LUN has a backend.
4658	 */
4659	atomic_subtract_int(&lun->be_lun->be->num_luns, 1);
4660	lun->be_lun->lun_shutdown(lun->be_lun->be_lun);
4661
4662	lun->ie_reportcnt = UINT32_MAX;
4663	callout_drain(&lun->ie_callout);
4664
4665	ctl_tpc_lun_shutdown(lun);
4666	mtx_destroy(&lun->lun_lock);
4667	free(lun->lun_devid, M_CTL);
4668	for (i = 0; i < CTL_MAX_PORTS; i++)
4669		free(lun->pending_ua[i], M_CTL);
4670	for (i = 0; i < CTL_MAX_PORTS; i++)
4671		free(lun->pr_keys[i], M_CTL);
4672	free(lun->write_buffer, M_CTL);
4673	if (lun->flags & CTL_LUN_MALLOCED)
4674		free(lun, M_CTL);
4675
4676	STAILQ_FOREACH(nlun, &softc->lun_list, links) {
4677		mtx_lock(&nlun->lun_lock);
4678		ctl_est_ua_all(nlun, -1, CTL_UA_LUN_CHANGE);
4679		mtx_unlock(&nlun->lun_lock);
4680	}
4681
4682	return (0);
4683}
4684
4685static void
4686ctl_create_lun(struct ctl_be_lun *be_lun)
4687{
4688
4689	/*
4690	 * ctl_alloc_lun() should handle all potential failure cases.
4691	 */
4692	ctl_alloc_lun(control_softc, NULL, be_lun);
4693}
4694
4695int
4696ctl_add_lun(struct ctl_be_lun *be_lun)
4697{
4698	struct ctl_softc *softc = control_softc;
4699
4700	mtx_lock(&softc->ctl_lock);
4701	STAILQ_INSERT_TAIL(&softc->pending_lun_queue, be_lun, links);
4702	mtx_unlock(&softc->ctl_lock);
4703	wakeup(&softc->pending_lun_queue);
4704
4705	return (0);
4706}
4707
4708int
4709ctl_enable_lun(struct ctl_be_lun *be_lun)
4710{
4711	struct ctl_softc *softc;
4712	struct ctl_port *port, *nport;
4713	struct ctl_lun *lun;
4714	int retval;
4715
4716	lun = (struct ctl_lun *)be_lun->ctl_lun;
4717	softc = lun->ctl_softc;
4718
4719	mtx_lock(&softc->ctl_lock);
4720	mtx_lock(&lun->lun_lock);
4721	if ((lun->flags & CTL_LUN_DISABLED) == 0) {
4722		/*
4723		 * eh?  Why did we get called if the LUN is already
4724		 * enabled?
4725		 */
4726		mtx_unlock(&lun->lun_lock);
4727		mtx_unlock(&softc->ctl_lock);
4728		return (0);
4729	}
4730	lun->flags &= ~CTL_LUN_DISABLED;
4731	mtx_unlock(&lun->lun_lock);
4732
4733	STAILQ_FOREACH_SAFE(port, &softc->port_list, links, nport) {
4734		if ((port->status & CTL_PORT_STATUS_ONLINE) == 0 ||
4735		    port->lun_map != NULL || port->lun_enable == NULL)
4736			continue;
4737
4738		/*
4739		 * Drop the lock while we call the FETD's enable routine.
4740		 * This can lead to a callback into CTL (at least in the
4741		 * case of the internal initiator frontend.
4742		 */
4743		mtx_unlock(&softc->ctl_lock);
4744		retval = port->lun_enable(port->targ_lun_arg, lun->lun);
4745		mtx_lock(&softc->ctl_lock);
4746		if (retval != 0) {
4747			printf("%s: FETD %s port %d returned error "
4748			       "%d for lun_enable on lun %jd\n",
4749			       __func__, port->port_name, port->targ_port,
4750			       retval, (intmax_t)lun->lun);
4751		}
4752	}
4753
4754	mtx_unlock(&softc->ctl_lock);
4755	ctl_isc_announce_lun(lun);
4756
4757	return (0);
4758}
4759
4760int
4761ctl_disable_lun(struct ctl_be_lun *be_lun)
4762{
4763	struct ctl_softc *softc;
4764	struct ctl_port *port;
4765	struct ctl_lun *lun;
4766	int retval;
4767
4768	lun = (struct ctl_lun *)be_lun->ctl_lun;
4769	softc = lun->ctl_softc;
4770
4771	mtx_lock(&softc->ctl_lock);
4772	mtx_lock(&lun->lun_lock);
4773	if (lun->flags & CTL_LUN_DISABLED) {
4774		mtx_unlock(&lun->lun_lock);
4775		mtx_unlock(&softc->ctl_lock);
4776		return (0);
4777	}
4778	lun->flags |= CTL_LUN_DISABLED;
4779	mtx_unlock(&lun->lun_lock);
4780
4781	STAILQ_FOREACH(port, &softc->port_list, links) {
4782		if ((port->status & CTL_PORT_STATUS_ONLINE) == 0 ||
4783		    port->lun_map != NULL || port->lun_disable == NULL)
4784			continue;
4785
4786		/*
4787		 * Drop the lock before we call the frontend's disable
4788		 * routine, to avoid lock order reversals.
4789		 *
4790		 * XXX KDM what happens if the frontend list changes while
4791		 * we're traversing it?  It's unlikely, but should be handled.
4792		 */
4793		mtx_unlock(&softc->ctl_lock);
4794		retval = port->lun_disable(port->targ_lun_arg, lun->lun);
4795		mtx_lock(&softc->ctl_lock);
4796		if (retval != 0) {
4797			printf("%s: FETD %s port %d returned error "
4798			       "%d for lun_disable on lun %jd\n",
4799			       __func__, port->port_name, port->targ_port,
4800			       retval, (intmax_t)lun->lun);
4801		}
4802	}
4803
4804	mtx_unlock(&softc->ctl_lock);
4805	ctl_isc_announce_lun(lun);
4806
4807	return (0);
4808}
4809
4810int
4811ctl_start_lun(struct ctl_be_lun *be_lun)
4812{
4813	struct ctl_lun *lun = (struct ctl_lun *)be_lun->ctl_lun;
4814
4815	mtx_lock(&lun->lun_lock);
4816	lun->flags &= ~CTL_LUN_STOPPED;
4817	mtx_unlock(&lun->lun_lock);
4818	return (0);
4819}
4820
4821int
4822ctl_stop_lun(struct ctl_be_lun *be_lun)
4823{
4824	struct ctl_lun *lun = (struct ctl_lun *)be_lun->ctl_lun;
4825
4826	mtx_lock(&lun->lun_lock);
4827	lun->flags |= CTL_LUN_STOPPED;
4828	mtx_unlock(&lun->lun_lock);
4829	return (0);
4830}
4831
4832int
4833ctl_lun_no_media(struct ctl_be_lun *be_lun)
4834{
4835	struct ctl_lun *lun = (struct ctl_lun *)be_lun->ctl_lun;
4836
4837	mtx_lock(&lun->lun_lock);
4838	lun->flags |= CTL_LUN_NO_MEDIA;
4839	mtx_unlock(&lun->lun_lock);
4840	return (0);
4841}
4842
4843int
4844ctl_lun_has_media(struct ctl_be_lun *be_lun)
4845{
4846	struct ctl_lun *lun = (struct ctl_lun *)be_lun->ctl_lun;
4847	union ctl_ha_msg msg;
4848
4849	mtx_lock(&lun->lun_lock);
4850	lun->flags &= ~(CTL_LUN_NO_MEDIA | CTL_LUN_EJECTED);
4851	if (lun->flags & CTL_LUN_REMOVABLE)
4852		ctl_est_ua_all(lun, -1, CTL_UA_MEDIUM_CHANGE);
4853	mtx_unlock(&lun->lun_lock);
4854	if ((lun->flags & CTL_LUN_REMOVABLE) &&
4855	    lun->ctl_softc->ha_mode == CTL_HA_MODE_XFER) {
4856		bzero(&msg.ua, sizeof(msg.ua));
4857		msg.hdr.msg_type = CTL_MSG_UA;
4858		msg.hdr.nexus.initid = -1;
4859		msg.hdr.nexus.targ_port = -1;
4860		msg.hdr.nexus.targ_lun = lun->lun;
4861		msg.hdr.nexus.targ_mapped_lun = lun->lun;
4862		msg.ua.ua_all = 1;
4863		msg.ua.ua_set = 1;
4864		msg.ua.ua_type = CTL_UA_MEDIUM_CHANGE;
4865		ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg, sizeof(msg.ua),
4866		    M_WAITOK);
4867	}
4868	return (0);
4869}
4870
4871int
4872ctl_lun_ejected(struct ctl_be_lun *be_lun)
4873{
4874	struct ctl_lun *lun = (struct ctl_lun *)be_lun->ctl_lun;
4875
4876	mtx_lock(&lun->lun_lock);
4877	lun->flags |= CTL_LUN_EJECTED;
4878	mtx_unlock(&lun->lun_lock);
4879	return (0);
4880}
4881
4882int
4883ctl_lun_primary(struct ctl_be_lun *be_lun)
4884{
4885	struct ctl_lun *lun = (struct ctl_lun *)be_lun->ctl_lun;
4886
4887	mtx_lock(&lun->lun_lock);
4888	lun->flags |= CTL_LUN_PRIMARY_SC;
4889	ctl_est_ua_all(lun, -1, CTL_UA_ASYM_ACC_CHANGE);
4890	mtx_unlock(&lun->lun_lock);
4891	ctl_isc_announce_lun(lun);
4892	return (0);
4893}
4894
4895int
4896ctl_lun_secondary(struct ctl_be_lun *be_lun)
4897{
4898	struct ctl_lun *lun = (struct ctl_lun *)be_lun->ctl_lun;
4899
4900	mtx_lock(&lun->lun_lock);
4901	lun->flags &= ~CTL_LUN_PRIMARY_SC;
4902	ctl_est_ua_all(lun, -1, CTL_UA_ASYM_ACC_CHANGE);
4903	mtx_unlock(&lun->lun_lock);
4904	ctl_isc_announce_lun(lun);
4905	return (0);
4906}
4907
4908int
4909ctl_invalidate_lun(struct ctl_be_lun *be_lun)
4910{
4911	struct ctl_softc *softc;
4912	struct ctl_lun *lun;
4913
4914	lun = (struct ctl_lun *)be_lun->ctl_lun;
4915	softc = lun->ctl_softc;
4916
4917	mtx_lock(&lun->lun_lock);
4918
4919	/*
4920	 * The LUN needs to be disabled before it can be marked invalid.
4921	 */
4922	if ((lun->flags & CTL_LUN_DISABLED) == 0) {
4923		mtx_unlock(&lun->lun_lock);
4924		return (-1);
4925	}
4926	/*
4927	 * Mark the LUN invalid.
4928	 */
4929	lun->flags |= CTL_LUN_INVALID;
4930
4931	/*
4932	 * If there is nothing in the OOA queue, go ahead and free the LUN.
4933	 * If we have something in the OOA queue, we'll free it when the
4934	 * last I/O completes.
4935	 */
4936	if (TAILQ_EMPTY(&lun->ooa_queue)) {
4937		mtx_unlock(&lun->lun_lock);
4938		mtx_lock(&softc->ctl_lock);
4939		ctl_free_lun(lun);
4940		mtx_unlock(&softc->ctl_lock);
4941	} else
4942		mtx_unlock(&lun->lun_lock);
4943
4944	return (0);
4945}
4946
4947void
4948ctl_lun_capacity_changed(struct ctl_be_lun *be_lun)
4949{
4950	struct ctl_lun *lun = (struct ctl_lun *)be_lun->ctl_lun;
4951	union ctl_ha_msg msg;
4952
4953	mtx_lock(&lun->lun_lock);
4954	ctl_est_ua_all(lun, -1, CTL_UA_CAPACITY_CHANGE);
4955	mtx_unlock(&lun->lun_lock);
4956	if (lun->ctl_softc->ha_mode == CTL_HA_MODE_XFER) {
4957		/* Send msg to other side. */
4958		bzero(&msg.ua, sizeof(msg.ua));
4959		msg.hdr.msg_type = CTL_MSG_UA;
4960		msg.hdr.nexus.initid = -1;
4961		msg.hdr.nexus.targ_port = -1;
4962		msg.hdr.nexus.targ_lun = lun->lun;
4963		msg.hdr.nexus.targ_mapped_lun = lun->lun;
4964		msg.ua.ua_all = 1;
4965		msg.ua.ua_set = 1;
4966		msg.ua.ua_type = CTL_UA_CAPACITY_CHANGE;
4967		ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg, sizeof(msg.ua),
4968		    M_WAITOK);
4969	}
4970}
4971
4972/*
4973 * Backend "memory move is complete" callback for requests that never
4974 * make it down to say RAIDCore's configuration code.
4975 */
4976int
4977ctl_config_move_done(union ctl_io *io)
4978{
4979	int retval;
4980
4981	CTL_DEBUG_PRINT(("ctl_config_move_done\n"));
4982	KASSERT(io->io_hdr.io_type == CTL_IO_SCSI,
4983	    ("Config I/O type isn't CTL_IO_SCSI (%d)!", io->io_hdr.io_type));
4984
4985	if ((io->io_hdr.port_status != 0) &&
4986	    ((io->io_hdr.status & CTL_STATUS_MASK) == CTL_STATUS_NONE ||
4987	     (io->io_hdr.status & CTL_STATUS_MASK) == CTL_SUCCESS)) {
4988		/*
4989		 * For hardware error sense keys, the sense key
4990		 * specific value is defined to be a retry count,
4991		 * but we use it to pass back an internal FETD
4992		 * error code.  XXX KDM  Hopefully the FETD is only
4993		 * using 16 bits for an error code, since that's
4994		 * all the space we have in the sks field.
4995		 */
4996		ctl_set_internal_failure(&io->scsiio,
4997					 /*sks_valid*/ 1,
4998					 /*retry_count*/
4999					 io->io_hdr.port_status);
5000	}
5001
5002	if (ctl_debug & CTL_DEBUG_CDB_DATA)
5003		ctl_data_print(io);
5004	if (((io->io_hdr.flags & CTL_FLAG_DATA_MASK) == CTL_FLAG_DATA_IN) ||
5005	    ((io->io_hdr.status & CTL_STATUS_MASK) != CTL_STATUS_NONE &&
5006	     (io->io_hdr.status & CTL_STATUS_MASK) != CTL_SUCCESS) ||
5007	    ((io->io_hdr.flags & CTL_FLAG_ABORT) != 0)) {
5008		/*
5009		 * XXX KDM just assuming a single pointer here, and not a
5010		 * S/G list.  If we start using S/G lists for config data,
5011		 * we'll need to know how to clean them up here as well.
5012		 */
5013		if (io->io_hdr.flags & CTL_FLAG_ALLOCATED)
5014			free(io->scsiio.kern_data_ptr, M_CTL);
5015		ctl_done(io);
5016		retval = CTL_RETVAL_COMPLETE;
5017	} else {
5018		/*
5019		 * XXX KDM now we need to continue data movement.  Some
5020		 * options:
5021		 * - call ctl_scsiio() again?  We don't do this for data
5022		 *   writes, because for those at least we know ahead of
5023		 *   time where the write will go and how long it is.  For
5024		 *   config writes, though, that information is largely
5025		 *   contained within the write itself, thus we need to
5026		 *   parse out the data again.
5027		 *
5028		 * - Call some other function once the data is in?
5029		 */
5030
5031		/*
5032		 * XXX KDM call ctl_scsiio() again for now, and check flag
5033		 * bits to see whether we're allocated or not.
5034		 */
5035		retval = ctl_scsiio(&io->scsiio);
5036	}
5037	return (retval);
5038}
5039
5040/*
5041 * This gets called by a backend driver when it is done with a
5042 * data_submit method.
5043 */
5044void
5045ctl_data_submit_done(union ctl_io *io)
5046{
5047	/*
5048	 * If the IO_CONT flag is set, we need to call the supplied
5049	 * function to continue processing the I/O, instead of completing
5050	 * the I/O just yet.
5051	 *
5052	 * If there is an error, though, we don't want to keep processing.
5053	 * Instead, just send status back to the initiator.
5054	 */
5055	if ((io->io_hdr.flags & CTL_FLAG_IO_CONT) &&
5056	    (io->io_hdr.flags & CTL_FLAG_ABORT) == 0 &&
5057	    ((io->io_hdr.status & CTL_STATUS_MASK) == CTL_STATUS_NONE ||
5058	     (io->io_hdr.status & CTL_STATUS_MASK) == CTL_SUCCESS)) {
5059		io->scsiio.io_cont(io);
5060		return;
5061	}
5062	ctl_done(io);
5063}
5064
5065/*
5066 * This gets called by a backend driver when it is done with a
5067 * configuration write.
5068 */
5069void
5070ctl_config_write_done(union ctl_io *io)
5071{
5072	uint8_t *buf;
5073
5074	/*
5075	 * If the IO_CONT flag is set, we need to call the supplied
5076	 * function to continue processing the I/O, instead of completing
5077	 * the I/O just yet.
5078	 *
5079	 * If there is an error, though, we don't want to keep processing.
5080	 * Instead, just send status back to the initiator.
5081	 */
5082	if ((io->io_hdr.flags & CTL_FLAG_IO_CONT) &&
5083	    (io->io_hdr.flags & CTL_FLAG_ABORT) == 0 &&
5084	    ((io->io_hdr.status & CTL_STATUS_MASK) == CTL_STATUS_NONE ||
5085	     (io->io_hdr.status & CTL_STATUS_MASK) == CTL_SUCCESS)) {
5086		io->scsiio.io_cont(io);
5087		return;
5088	}
5089	/*
5090	 * Since a configuration write can be done for commands that actually
5091	 * have data allocated, like write buffer, and commands that have
5092	 * no data, like start/stop unit, we need to check here.
5093	 */
5094	if (io->io_hdr.flags & CTL_FLAG_ALLOCATED)
5095		buf = io->scsiio.kern_data_ptr;
5096	else
5097		buf = NULL;
5098	ctl_done(io);
5099	if (buf)
5100		free(buf, M_CTL);
5101}
5102
5103void
5104ctl_config_read_done(union ctl_io *io)
5105{
5106	uint8_t *buf;
5107
5108	/*
5109	 * If there is some error -- we are done, skip data transfer.
5110	 */
5111	if ((io->io_hdr.flags & CTL_FLAG_ABORT) != 0 ||
5112	    ((io->io_hdr.status & CTL_STATUS_MASK) != CTL_STATUS_NONE &&
5113	     (io->io_hdr.status & CTL_STATUS_MASK) != CTL_SUCCESS)) {
5114		if (io->io_hdr.flags & CTL_FLAG_ALLOCATED)
5115			buf = io->scsiio.kern_data_ptr;
5116		else
5117			buf = NULL;
5118		ctl_done(io);
5119		if (buf)
5120			free(buf, M_CTL);
5121		return;
5122	}
5123
5124	/*
5125	 * If the IO_CONT flag is set, we need to call the supplied
5126	 * function to continue processing the I/O, instead of completing
5127	 * the I/O just yet.
5128	 */
5129	if (io->io_hdr.flags & CTL_FLAG_IO_CONT) {
5130		io->scsiio.io_cont(io);
5131		return;
5132	}
5133
5134	ctl_datamove(io);
5135}
5136
5137/*
5138 * SCSI release command.
5139 */
5140int
5141ctl_scsi_release(struct ctl_scsiio *ctsio)
5142{
5143	struct ctl_lun *lun;
5144	uint32_t residx;
5145
5146	CTL_DEBUG_PRINT(("ctl_scsi_release\n"));
5147
5148	residx = ctl_get_initindex(&ctsio->io_hdr.nexus);
5149	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5150
5151	/*
5152	 * XXX KDM right now, we only support LUN reservation.  We don't
5153	 * support 3rd party reservations, or extent reservations, which
5154	 * might actually need the parameter list.  If we've gotten this
5155	 * far, we've got a LUN reservation.  Anything else got kicked out
5156	 * above.  So, according to SPC, ignore the length.
5157	 */
5158
5159	mtx_lock(&lun->lun_lock);
5160
5161	/*
5162	 * According to SPC, it is not an error for an intiator to attempt
5163	 * to release a reservation on a LUN that isn't reserved, or that
5164	 * is reserved by another initiator.  The reservation can only be
5165	 * released, though, by the initiator who made it or by one of
5166	 * several reset type events.
5167	 */
5168	if ((lun->flags & CTL_LUN_RESERVED) && (lun->res_idx == residx))
5169			lun->flags &= ~CTL_LUN_RESERVED;
5170
5171	mtx_unlock(&lun->lun_lock);
5172
5173	ctl_set_success(ctsio);
5174	ctl_done((union ctl_io *)ctsio);
5175	return (CTL_RETVAL_COMPLETE);
5176}
5177
5178int
5179ctl_scsi_reserve(struct ctl_scsiio *ctsio)
5180{
5181	struct ctl_lun *lun;
5182	uint32_t residx;
5183
5184	CTL_DEBUG_PRINT(("ctl_reserve\n"));
5185
5186	residx = ctl_get_initindex(&ctsio->io_hdr.nexus);
5187	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5188
5189	/*
5190	 * XXX KDM right now, we only support LUN reservation.  We don't
5191	 * support 3rd party reservations, or extent reservations, which
5192	 * might actually need the parameter list.  If we've gotten this
5193	 * far, we've got a LUN reservation.  Anything else got kicked out
5194	 * above.  So, according to SPC, ignore the length.
5195	 */
5196
5197	mtx_lock(&lun->lun_lock);
5198	if ((lun->flags & CTL_LUN_RESERVED) && (lun->res_idx != residx)) {
5199		ctl_set_reservation_conflict(ctsio);
5200		goto bailout;
5201	}
5202
5203	/* SPC-3 exceptions to SPC-2 RESERVE and RELEASE behavior. */
5204	if (lun->flags & CTL_LUN_PR_RESERVED) {
5205		ctl_set_success(ctsio);
5206		goto bailout;
5207	}
5208
5209	lun->flags |= CTL_LUN_RESERVED;
5210	lun->res_idx = residx;
5211	ctl_set_success(ctsio);
5212
5213bailout:
5214	mtx_unlock(&lun->lun_lock);
5215	ctl_done((union ctl_io *)ctsio);
5216	return (CTL_RETVAL_COMPLETE);
5217}
5218
5219int
5220ctl_start_stop(struct ctl_scsiio *ctsio)
5221{
5222	struct scsi_start_stop_unit *cdb;
5223	struct ctl_lun *lun;
5224	int retval;
5225
5226	CTL_DEBUG_PRINT(("ctl_start_stop\n"));
5227
5228	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5229	cdb = (struct scsi_start_stop_unit *)ctsio->cdb;
5230
5231	if ((cdb->how & SSS_PC_MASK) == 0) {
5232		if ((lun->flags & CTL_LUN_PR_RESERVED) &&
5233		    (cdb->how & SSS_START) == 0) {
5234			uint32_t residx;
5235
5236			residx = ctl_get_initindex(&ctsio->io_hdr.nexus);
5237			if (ctl_get_prkey(lun, residx) == 0 ||
5238			    (lun->pr_res_idx != residx && lun->pr_res_type < 4)) {
5239
5240				ctl_set_reservation_conflict(ctsio);
5241				ctl_done((union ctl_io *)ctsio);
5242				return (CTL_RETVAL_COMPLETE);
5243			}
5244		}
5245
5246		if ((cdb->how & SSS_LOEJ) &&
5247		    (lun->flags & CTL_LUN_REMOVABLE) == 0) {
5248			ctl_set_invalid_field(ctsio,
5249					      /*sks_valid*/ 1,
5250					      /*command*/ 1,
5251					      /*field*/ 4,
5252					      /*bit_valid*/ 1,
5253					      /*bit*/ 1);
5254			ctl_done((union ctl_io *)ctsio);
5255			return (CTL_RETVAL_COMPLETE);
5256		}
5257
5258		if ((cdb->how & SSS_START) == 0 && (cdb->how & SSS_LOEJ) &&
5259		    lun->prevent_count > 0) {
5260			/* "Medium removal prevented" */
5261			ctl_set_sense(ctsio, /*current_error*/ 1,
5262			    /*sense_key*/(lun->flags & CTL_LUN_NO_MEDIA) ?
5263			     SSD_KEY_NOT_READY : SSD_KEY_ILLEGAL_REQUEST,
5264			    /*asc*/ 0x53, /*ascq*/ 0x02, SSD_ELEM_NONE);
5265			ctl_done((union ctl_io *)ctsio);
5266			return (CTL_RETVAL_COMPLETE);
5267		}
5268	}
5269
5270	retval = lun->backend->config_write((union ctl_io *)ctsio);
5271	return (retval);
5272}
5273
5274int
5275ctl_prevent_allow(struct ctl_scsiio *ctsio)
5276{
5277	struct ctl_lun *lun;
5278	struct scsi_prevent *cdb;
5279	int retval;
5280	uint32_t initidx;
5281
5282	CTL_DEBUG_PRINT(("ctl_prevent_allow\n"));
5283
5284	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5285	cdb = (struct scsi_prevent *)ctsio->cdb;
5286
5287	if ((lun->flags & CTL_LUN_REMOVABLE) == 0) {
5288		ctl_set_invalid_opcode(ctsio);
5289		ctl_done((union ctl_io *)ctsio);
5290		return (CTL_RETVAL_COMPLETE);
5291	}
5292
5293	initidx = ctl_get_initindex(&ctsio->io_hdr.nexus);
5294	mtx_lock(&lun->lun_lock);
5295	if ((cdb->how & PR_PREVENT) &&
5296	    ctl_is_set(lun->prevent, initidx) == 0) {
5297		ctl_set_mask(lun->prevent, initidx);
5298		lun->prevent_count++;
5299	} else if ((cdb->how & PR_PREVENT) == 0 &&
5300	    ctl_is_set(lun->prevent, initidx)) {
5301		ctl_clear_mask(lun->prevent, initidx);
5302		lun->prevent_count--;
5303	}
5304	mtx_unlock(&lun->lun_lock);
5305	retval = lun->backend->config_write((union ctl_io *)ctsio);
5306	return (retval);
5307}
5308
5309/*
5310 * We support the SYNCHRONIZE CACHE command (10 and 16 byte versions), but
5311 * we don't really do anything with the LBA and length fields if the user
5312 * passes them in.  Instead we'll just flush out the cache for the entire
5313 * LUN.
5314 */
5315int
5316ctl_sync_cache(struct ctl_scsiio *ctsio)
5317{
5318	struct ctl_lun *lun;
5319	struct ctl_softc *softc;
5320	struct ctl_lba_len_flags *lbalen;
5321	uint64_t starting_lba;
5322	uint32_t block_count;
5323	int retval;
5324	uint8_t byte2;
5325
5326	CTL_DEBUG_PRINT(("ctl_sync_cache\n"));
5327
5328	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5329	softc = lun->ctl_softc;
5330	retval = 0;
5331
5332	switch (ctsio->cdb[0]) {
5333	case SYNCHRONIZE_CACHE: {
5334		struct scsi_sync_cache *cdb;
5335		cdb = (struct scsi_sync_cache *)ctsio->cdb;
5336
5337		starting_lba = scsi_4btoul(cdb->begin_lba);
5338		block_count = scsi_2btoul(cdb->lb_count);
5339		byte2 = cdb->byte2;
5340		break;
5341	}
5342	case SYNCHRONIZE_CACHE_16: {
5343		struct scsi_sync_cache_16 *cdb;
5344		cdb = (struct scsi_sync_cache_16 *)ctsio->cdb;
5345
5346		starting_lba = scsi_8btou64(cdb->begin_lba);
5347		block_count = scsi_4btoul(cdb->lb_count);
5348		byte2 = cdb->byte2;
5349		break;
5350	}
5351	default:
5352		ctl_set_invalid_opcode(ctsio);
5353		ctl_done((union ctl_io *)ctsio);
5354		goto bailout;
5355		break; /* NOTREACHED */
5356	}
5357
5358	/*
5359	 * We check the LBA and length, but don't do anything with them.
5360	 * A SYNCHRONIZE CACHE will cause the entire cache for this lun to
5361	 * get flushed.  This check will just help satisfy anyone who wants
5362	 * to see an error for an out of range LBA.
5363	 */
5364	if ((starting_lba + block_count) > (lun->be_lun->maxlba + 1)) {
5365		ctl_set_lba_out_of_range(ctsio);
5366		ctl_done((union ctl_io *)ctsio);
5367		goto bailout;
5368	}
5369
5370	lbalen = (struct ctl_lba_len_flags *)&ctsio->io_hdr.ctl_private[CTL_PRIV_LBA_LEN];
5371	lbalen->lba = starting_lba;
5372	lbalen->len = block_count;
5373	lbalen->flags = byte2;
5374	retval = lun->backend->config_write((union ctl_io *)ctsio);
5375
5376bailout:
5377	return (retval);
5378}
5379
5380int
5381ctl_format(struct ctl_scsiio *ctsio)
5382{
5383	struct scsi_format *cdb;
5384	struct ctl_lun *lun;
5385	int length, defect_list_len;
5386
5387	CTL_DEBUG_PRINT(("ctl_format\n"));
5388
5389	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5390
5391	cdb = (struct scsi_format *)ctsio->cdb;
5392
5393	length = 0;
5394	if (cdb->byte2 & SF_FMTDATA) {
5395		if (cdb->byte2 & SF_LONGLIST)
5396			length = sizeof(struct scsi_format_header_long);
5397		else
5398			length = sizeof(struct scsi_format_header_short);
5399	}
5400
5401	if (((ctsio->io_hdr.flags & CTL_FLAG_ALLOCATED) == 0)
5402	 && (length > 0)) {
5403		ctsio->kern_data_ptr = malloc(length, M_CTL, M_WAITOK);
5404		ctsio->kern_data_len = length;
5405		ctsio->kern_total_len = length;
5406		ctsio->kern_data_resid = 0;
5407		ctsio->kern_rel_offset = 0;
5408		ctsio->kern_sg_entries = 0;
5409		ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
5410		ctsio->be_move_done = ctl_config_move_done;
5411		ctl_datamove((union ctl_io *)ctsio);
5412
5413		return (CTL_RETVAL_COMPLETE);
5414	}
5415
5416	defect_list_len = 0;
5417
5418	if (cdb->byte2 & SF_FMTDATA) {
5419		if (cdb->byte2 & SF_LONGLIST) {
5420			struct scsi_format_header_long *header;
5421
5422			header = (struct scsi_format_header_long *)
5423				ctsio->kern_data_ptr;
5424
5425			defect_list_len = scsi_4btoul(header->defect_list_len);
5426			if (defect_list_len != 0) {
5427				ctl_set_invalid_field(ctsio,
5428						      /*sks_valid*/ 1,
5429						      /*command*/ 0,
5430						      /*field*/ 2,
5431						      /*bit_valid*/ 0,
5432						      /*bit*/ 0);
5433				goto bailout;
5434			}
5435		} else {
5436			struct scsi_format_header_short *header;
5437
5438			header = (struct scsi_format_header_short *)
5439				ctsio->kern_data_ptr;
5440
5441			defect_list_len = scsi_2btoul(header->defect_list_len);
5442			if (defect_list_len != 0) {
5443				ctl_set_invalid_field(ctsio,
5444						      /*sks_valid*/ 1,
5445						      /*command*/ 0,
5446						      /*field*/ 2,
5447						      /*bit_valid*/ 0,
5448						      /*bit*/ 0);
5449				goto bailout;
5450			}
5451		}
5452	}
5453
5454	ctl_set_success(ctsio);
5455bailout:
5456
5457	if (ctsio->io_hdr.flags & CTL_FLAG_ALLOCATED) {
5458		free(ctsio->kern_data_ptr, M_CTL);
5459		ctsio->io_hdr.flags &= ~CTL_FLAG_ALLOCATED;
5460	}
5461
5462	ctl_done((union ctl_io *)ctsio);
5463	return (CTL_RETVAL_COMPLETE);
5464}
5465
5466int
5467ctl_read_buffer(struct ctl_scsiio *ctsio)
5468{
5469	struct ctl_lun *lun;
5470	uint64_t buffer_offset;
5471	uint32_t len;
5472	uint8_t byte2;
5473	static uint8_t descr[4];
5474	static uint8_t echo_descr[4] = { 0 };
5475
5476	CTL_DEBUG_PRINT(("ctl_read_buffer\n"));
5477	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5478	switch (ctsio->cdb[0]) {
5479	case READ_BUFFER: {
5480		struct scsi_read_buffer *cdb;
5481
5482		cdb = (struct scsi_read_buffer *)ctsio->cdb;
5483		buffer_offset = scsi_3btoul(cdb->offset);
5484		len = scsi_3btoul(cdb->length);
5485		byte2 = cdb->byte2;
5486		break;
5487	}
5488	case READ_BUFFER_16: {
5489		struct scsi_read_buffer_16 *cdb;
5490
5491		cdb = (struct scsi_read_buffer_16 *)ctsio->cdb;
5492		buffer_offset = scsi_8btou64(cdb->offset);
5493		len = scsi_4btoul(cdb->length);
5494		byte2 = cdb->byte2;
5495		break;
5496	}
5497	default: /* This shouldn't happen. */
5498		ctl_set_invalid_opcode(ctsio);
5499		ctl_done((union ctl_io *)ctsio);
5500		return (CTL_RETVAL_COMPLETE);
5501	}
5502
5503	if ((byte2 & RWB_MODE) != RWB_MODE_DATA &&
5504	    (byte2 & RWB_MODE) != RWB_MODE_ECHO_DESCR &&
5505	    (byte2 & RWB_MODE) != RWB_MODE_DESCR) {
5506		ctl_set_invalid_field(ctsio,
5507				      /*sks_valid*/ 1,
5508				      /*command*/ 1,
5509				      /*field*/ 1,
5510				      /*bit_valid*/ 1,
5511				      /*bit*/ 4);
5512		ctl_done((union ctl_io *)ctsio);
5513		return (CTL_RETVAL_COMPLETE);
5514	}
5515
5516	if (buffer_offset > CTL_WRITE_BUFFER_SIZE ||
5517	    buffer_offset + len > CTL_WRITE_BUFFER_SIZE) {
5518		ctl_set_invalid_field(ctsio,
5519				      /*sks_valid*/ 1,
5520				      /*command*/ 1,
5521				      /*field*/ 6,
5522				      /*bit_valid*/ 0,
5523				      /*bit*/ 0);
5524		ctl_done((union ctl_io *)ctsio);
5525		return (CTL_RETVAL_COMPLETE);
5526	}
5527
5528	if ((byte2 & RWB_MODE) == RWB_MODE_DESCR) {
5529		descr[0] = 0;
5530		scsi_ulto3b(CTL_WRITE_BUFFER_SIZE, &descr[1]);
5531		ctsio->kern_data_ptr = descr;
5532		len = min(len, sizeof(descr));
5533	} else if ((byte2 & RWB_MODE) == RWB_MODE_ECHO_DESCR) {
5534		ctsio->kern_data_ptr = echo_descr;
5535		len = min(len, sizeof(echo_descr));
5536	} else {
5537		if (lun->write_buffer == NULL) {
5538			lun->write_buffer = malloc(CTL_WRITE_BUFFER_SIZE,
5539			    M_CTL, M_WAITOK);
5540		}
5541		ctsio->kern_data_ptr = lun->write_buffer + buffer_offset;
5542	}
5543	ctsio->kern_data_len = len;
5544	ctsio->kern_total_len = len;
5545	ctsio->kern_data_resid = 0;
5546	ctsio->kern_rel_offset = 0;
5547	ctsio->kern_sg_entries = 0;
5548	ctl_set_success(ctsio);
5549	ctsio->be_move_done = ctl_config_move_done;
5550	ctl_datamove((union ctl_io *)ctsio);
5551	return (CTL_RETVAL_COMPLETE);
5552}
5553
5554int
5555ctl_write_buffer(struct ctl_scsiio *ctsio)
5556{
5557	struct scsi_write_buffer *cdb;
5558	struct ctl_lun *lun;
5559	int buffer_offset, len;
5560
5561	CTL_DEBUG_PRINT(("ctl_write_buffer\n"));
5562
5563	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5564	cdb = (struct scsi_write_buffer *)ctsio->cdb;
5565
5566	if ((cdb->byte2 & RWB_MODE) != RWB_MODE_DATA) {
5567		ctl_set_invalid_field(ctsio,
5568				      /*sks_valid*/ 1,
5569				      /*command*/ 1,
5570				      /*field*/ 1,
5571				      /*bit_valid*/ 1,
5572				      /*bit*/ 4);
5573		ctl_done((union ctl_io *)ctsio);
5574		return (CTL_RETVAL_COMPLETE);
5575	}
5576
5577	len = scsi_3btoul(cdb->length);
5578	buffer_offset = scsi_3btoul(cdb->offset);
5579
5580	if (buffer_offset + len > CTL_WRITE_BUFFER_SIZE) {
5581		ctl_set_invalid_field(ctsio,
5582				      /*sks_valid*/ 1,
5583				      /*command*/ 1,
5584				      /*field*/ 6,
5585				      /*bit_valid*/ 0,
5586				      /*bit*/ 0);
5587		ctl_done((union ctl_io *)ctsio);
5588		return (CTL_RETVAL_COMPLETE);
5589	}
5590
5591	/*
5592	 * If we've got a kernel request that hasn't been malloced yet,
5593	 * malloc it and tell the caller the data buffer is here.
5594	 */
5595	if ((ctsio->io_hdr.flags & CTL_FLAG_ALLOCATED) == 0) {
5596		if (lun->write_buffer == NULL) {
5597			lun->write_buffer = malloc(CTL_WRITE_BUFFER_SIZE,
5598			    M_CTL, M_WAITOK);
5599		}
5600		ctsio->kern_data_ptr = lun->write_buffer + buffer_offset;
5601		ctsio->kern_data_len = len;
5602		ctsio->kern_total_len = len;
5603		ctsio->kern_data_resid = 0;
5604		ctsio->kern_rel_offset = 0;
5605		ctsio->kern_sg_entries = 0;
5606		ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
5607		ctsio->be_move_done = ctl_config_move_done;
5608		ctl_datamove((union ctl_io *)ctsio);
5609
5610		return (CTL_RETVAL_COMPLETE);
5611	}
5612
5613	ctl_set_success(ctsio);
5614	ctl_done((union ctl_io *)ctsio);
5615	return (CTL_RETVAL_COMPLETE);
5616}
5617
5618int
5619ctl_write_same(struct ctl_scsiio *ctsio)
5620{
5621	struct ctl_lun *lun;
5622	struct ctl_lba_len_flags *lbalen;
5623	uint64_t lba;
5624	uint32_t num_blocks;
5625	int len, retval;
5626	uint8_t byte2;
5627
5628	CTL_DEBUG_PRINT(("ctl_write_same\n"));
5629
5630	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5631
5632	switch (ctsio->cdb[0]) {
5633	case WRITE_SAME_10: {
5634		struct scsi_write_same_10 *cdb;
5635
5636		cdb = (struct scsi_write_same_10 *)ctsio->cdb;
5637
5638		lba = scsi_4btoul(cdb->addr);
5639		num_blocks = scsi_2btoul(cdb->length);
5640		byte2 = cdb->byte2;
5641		break;
5642	}
5643	case WRITE_SAME_16: {
5644		struct scsi_write_same_16 *cdb;
5645
5646		cdb = (struct scsi_write_same_16 *)ctsio->cdb;
5647
5648		lba = scsi_8btou64(cdb->addr);
5649		num_blocks = scsi_4btoul(cdb->length);
5650		byte2 = cdb->byte2;
5651		break;
5652	}
5653	default:
5654		/*
5655		 * We got a command we don't support.  This shouldn't
5656		 * happen, commands should be filtered out above us.
5657		 */
5658		ctl_set_invalid_opcode(ctsio);
5659		ctl_done((union ctl_io *)ctsio);
5660
5661		return (CTL_RETVAL_COMPLETE);
5662		break; /* NOTREACHED */
5663	}
5664
5665	/* ANCHOR flag can be used only together with UNMAP */
5666	if ((byte2 & SWS_UNMAP) == 0 && (byte2 & SWS_ANCHOR) != 0) {
5667		ctl_set_invalid_field(ctsio, /*sks_valid*/ 1,
5668		    /*command*/ 1, /*field*/ 1, /*bit_valid*/ 1, /*bit*/ 0);
5669		ctl_done((union ctl_io *)ctsio);
5670		return (CTL_RETVAL_COMPLETE);
5671	}
5672
5673	/*
5674	 * The first check is to make sure we're in bounds, the second
5675	 * check is to catch wrap-around problems.  If the lba + num blocks
5676	 * is less than the lba, then we've wrapped around and the block
5677	 * range is invalid anyway.
5678	 */
5679	if (((lba + num_blocks) > (lun->be_lun->maxlba + 1))
5680	 || ((lba + num_blocks) < lba)) {
5681		ctl_set_lba_out_of_range(ctsio);
5682		ctl_done((union ctl_io *)ctsio);
5683		return (CTL_RETVAL_COMPLETE);
5684	}
5685
5686	/* Zero number of blocks means "to the last logical block" */
5687	if (num_blocks == 0) {
5688		if ((lun->be_lun->maxlba + 1) - lba > UINT32_MAX) {
5689			ctl_set_invalid_field(ctsio,
5690					      /*sks_valid*/ 0,
5691					      /*command*/ 1,
5692					      /*field*/ 0,
5693					      /*bit_valid*/ 0,
5694					      /*bit*/ 0);
5695			ctl_done((union ctl_io *)ctsio);
5696			return (CTL_RETVAL_COMPLETE);
5697		}
5698		num_blocks = (lun->be_lun->maxlba + 1) - lba;
5699	}
5700
5701	len = lun->be_lun->blocksize;
5702
5703	/*
5704	 * If we've got a kernel request that hasn't been malloced yet,
5705	 * malloc it and tell the caller the data buffer is here.
5706	 */
5707	if ((byte2 & SWS_NDOB) == 0 &&
5708	    (ctsio->io_hdr.flags & CTL_FLAG_ALLOCATED) == 0) {
5709		ctsio->kern_data_ptr = malloc(len, M_CTL, M_WAITOK);
5710		ctsio->kern_data_len = len;
5711		ctsio->kern_total_len = len;
5712		ctsio->kern_data_resid = 0;
5713		ctsio->kern_rel_offset = 0;
5714		ctsio->kern_sg_entries = 0;
5715		ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
5716		ctsio->be_move_done = ctl_config_move_done;
5717		ctl_datamove((union ctl_io *)ctsio);
5718
5719		return (CTL_RETVAL_COMPLETE);
5720	}
5721
5722	lbalen = (struct ctl_lba_len_flags *)&ctsio->io_hdr.ctl_private[CTL_PRIV_LBA_LEN];
5723	lbalen->lba = lba;
5724	lbalen->len = num_blocks;
5725	lbalen->flags = byte2;
5726	retval = lun->backend->config_write((union ctl_io *)ctsio);
5727
5728	return (retval);
5729}
5730
5731int
5732ctl_unmap(struct ctl_scsiio *ctsio)
5733{
5734	struct ctl_lun *lun;
5735	struct scsi_unmap *cdb;
5736	struct ctl_ptr_len_flags *ptrlen;
5737	struct scsi_unmap_header *hdr;
5738	struct scsi_unmap_desc *buf, *end, *endnz, *range;
5739	uint64_t lba;
5740	uint32_t num_blocks;
5741	int len, retval;
5742	uint8_t byte2;
5743
5744	CTL_DEBUG_PRINT(("ctl_unmap\n"));
5745
5746	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5747	cdb = (struct scsi_unmap *)ctsio->cdb;
5748
5749	len = scsi_2btoul(cdb->length);
5750	byte2 = cdb->byte2;
5751
5752	/*
5753	 * If we've got a kernel request that hasn't been malloced yet,
5754	 * malloc it and tell the caller the data buffer is here.
5755	 */
5756	if ((ctsio->io_hdr.flags & CTL_FLAG_ALLOCATED) == 0) {
5757		ctsio->kern_data_ptr = malloc(len, M_CTL, M_WAITOK);
5758		ctsio->kern_data_len = len;
5759		ctsio->kern_total_len = len;
5760		ctsio->kern_data_resid = 0;
5761		ctsio->kern_rel_offset = 0;
5762		ctsio->kern_sg_entries = 0;
5763		ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
5764		ctsio->be_move_done = ctl_config_move_done;
5765		ctl_datamove((union ctl_io *)ctsio);
5766
5767		return (CTL_RETVAL_COMPLETE);
5768	}
5769
5770	len = ctsio->kern_total_len - ctsio->kern_data_resid;
5771	hdr = (struct scsi_unmap_header *)ctsio->kern_data_ptr;
5772	if (len < sizeof (*hdr) ||
5773	    len < (scsi_2btoul(hdr->length) + sizeof(hdr->length)) ||
5774	    len < (scsi_2btoul(hdr->desc_length) + sizeof (*hdr)) ||
5775	    scsi_2btoul(hdr->desc_length) % sizeof(*buf) != 0) {
5776		ctl_set_invalid_field(ctsio,
5777				      /*sks_valid*/ 0,
5778				      /*command*/ 0,
5779				      /*field*/ 0,
5780				      /*bit_valid*/ 0,
5781				      /*bit*/ 0);
5782		goto done;
5783	}
5784	len = scsi_2btoul(hdr->desc_length);
5785	buf = (struct scsi_unmap_desc *)(hdr + 1);
5786	end = buf + len / sizeof(*buf);
5787
5788	endnz = buf;
5789	for (range = buf; range < end; range++) {
5790		lba = scsi_8btou64(range->lba);
5791		num_blocks = scsi_4btoul(range->length);
5792		if (((lba + num_blocks) > (lun->be_lun->maxlba + 1))
5793		 || ((lba + num_blocks) < lba)) {
5794			ctl_set_lba_out_of_range(ctsio);
5795			ctl_done((union ctl_io *)ctsio);
5796			return (CTL_RETVAL_COMPLETE);
5797		}
5798		if (num_blocks != 0)
5799			endnz = range + 1;
5800	}
5801
5802	/*
5803	 * Block backend can not handle zero last range.
5804	 * Filter it out and return if there is nothing left.
5805	 */
5806	len = (uint8_t *)endnz - (uint8_t *)buf;
5807	if (len == 0) {
5808		ctl_set_success(ctsio);
5809		goto done;
5810	}
5811
5812	mtx_lock(&lun->lun_lock);
5813	ptrlen = (struct ctl_ptr_len_flags *)
5814	    &ctsio->io_hdr.ctl_private[CTL_PRIV_LBA_LEN];
5815	ptrlen->ptr = (void *)buf;
5816	ptrlen->len = len;
5817	ptrlen->flags = byte2;
5818	ctl_check_blocked(lun);
5819	mtx_unlock(&lun->lun_lock);
5820
5821	retval = lun->backend->config_write((union ctl_io *)ctsio);
5822	return (retval);
5823
5824done:
5825	if (ctsio->io_hdr.flags & CTL_FLAG_ALLOCATED) {
5826		free(ctsio->kern_data_ptr, M_CTL);
5827		ctsio->io_hdr.flags &= ~CTL_FLAG_ALLOCATED;
5828	}
5829	ctl_done((union ctl_io *)ctsio);
5830	return (CTL_RETVAL_COMPLETE);
5831}
5832
5833int
5834ctl_default_page_handler(struct ctl_scsiio *ctsio,
5835			 struct ctl_page_index *page_index, uint8_t *page_ptr)
5836{
5837	struct ctl_lun *lun;
5838	uint8_t *current_cp, *saved_cp;
5839	int set_ua;
5840	uint32_t initidx;
5841
5842	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5843	initidx = ctl_get_initindex(&ctsio->io_hdr.nexus);
5844	set_ua = 0;
5845
5846	current_cp = (page_index->page_data + (page_index->page_len *
5847	    CTL_PAGE_CURRENT));
5848	saved_cp = (page_index->page_data + (page_index->page_len *
5849	    CTL_PAGE_SAVED));
5850
5851	mtx_lock(&lun->lun_lock);
5852	if (memcmp(current_cp, page_ptr, page_index->page_len)) {
5853		memcpy(current_cp, page_ptr, page_index->page_len);
5854		memcpy(saved_cp, page_ptr, page_index->page_len);
5855		set_ua = 1;
5856	}
5857	if (set_ua != 0)
5858		ctl_est_ua_all(lun, initidx, CTL_UA_MODE_CHANGE);
5859	mtx_unlock(&lun->lun_lock);
5860	if (set_ua) {
5861		ctl_isc_announce_mode(lun,
5862		    ctl_get_initindex(&ctsio->io_hdr.nexus),
5863		    page_index->page_code, page_index->subpage);
5864	}
5865	return (CTL_RETVAL_COMPLETE);
5866}
5867
5868static void
5869ctl_ie_timer(void *arg)
5870{
5871	struct ctl_lun *lun = arg;
5872	struct scsi_info_exceptions_page *pg;
5873	uint64_t t;
5874
5875	if (lun->ie_asc == 0)
5876		return;
5877
5878	pg = &lun->mode_pages.ie_page[CTL_PAGE_CURRENT];
5879	if (pg->mrie == SIEP_MRIE_UA)
5880		ctl_est_ua_all(lun, -1, CTL_UA_IE);
5881	else
5882		lun->ie_reported = 0;
5883
5884	if (lun->ie_reportcnt < scsi_4btoul(pg->report_count)) {
5885		lun->ie_reportcnt++;
5886		t = scsi_4btoul(pg->interval_timer);
5887		if (t == 0 || t == UINT32_MAX)
5888			t = 3000;  /* 5 min */
5889		callout_schedule(&lun->ie_callout, t * hz / 10);
5890	}
5891}
5892
5893int
5894ctl_ie_page_handler(struct ctl_scsiio *ctsio,
5895			 struct ctl_page_index *page_index, uint8_t *page_ptr)
5896{
5897	struct scsi_info_exceptions_page *pg;
5898	struct ctl_lun *lun;
5899	uint64_t t;
5900
5901	(void)ctl_default_page_handler(ctsio, page_index, page_ptr);
5902
5903	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5904	pg = (struct scsi_info_exceptions_page *)page_ptr;
5905	mtx_lock(&lun->lun_lock);
5906	if (pg->info_flags & SIEP_FLAGS_TEST) {
5907		lun->ie_asc = 0x5d;
5908		lun->ie_ascq = 0xff;
5909		if (pg->mrie == SIEP_MRIE_UA) {
5910			ctl_est_ua_all(lun, -1, CTL_UA_IE);
5911			lun->ie_reported = 1;
5912		} else {
5913			ctl_clr_ua_all(lun, -1, CTL_UA_IE);
5914			lun->ie_reported = -1;
5915		}
5916		lun->ie_reportcnt = 1;
5917		if (lun->ie_reportcnt < scsi_4btoul(pg->report_count)) {
5918			lun->ie_reportcnt++;
5919			t = scsi_4btoul(pg->interval_timer);
5920			if (t == 0 || t == UINT32_MAX)
5921				t = 3000;  /* 5 min */
5922			callout_reset(&lun->ie_callout, t * hz / 10,
5923			    ctl_ie_timer, lun);
5924		}
5925	} else {
5926		lun->ie_asc = 0;
5927		lun->ie_ascq = 0;
5928		lun->ie_reported = 1;
5929		ctl_clr_ua_all(lun, -1, CTL_UA_IE);
5930		lun->ie_reportcnt = UINT32_MAX;
5931		callout_stop(&lun->ie_callout);
5932	}
5933	mtx_unlock(&lun->lun_lock);
5934	return (CTL_RETVAL_COMPLETE);
5935}
5936
5937static int
5938ctl_do_mode_select(union ctl_io *io)
5939{
5940	struct scsi_mode_page_header *page_header;
5941	struct ctl_page_index *page_index;
5942	struct ctl_scsiio *ctsio;
5943	int page_len, page_len_offset, page_len_size;
5944	union ctl_modepage_info *modepage_info;
5945	struct ctl_lun *lun;
5946	int *len_left, *len_used;
5947	int retval, i;
5948
5949	ctsio = &io->scsiio;
5950	page_index = NULL;
5951	page_len = 0;
5952	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5953
5954	modepage_info = (union ctl_modepage_info *)
5955		ctsio->io_hdr.ctl_private[CTL_PRIV_MODEPAGE].bytes;
5956	len_left = &modepage_info->header.len_left;
5957	len_used = &modepage_info->header.len_used;
5958
5959do_next_page:
5960
5961	page_header = (struct scsi_mode_page_header *)
5962		(ctsio->kern_data_ptr + *len_used);
5963
5964	if (*len_left == 0) {
5965		free(ctsio->kern_data_ptr, M_CTL);
5966		ctl_set_success(ctsio);
5967		ctl_done((union ctl_io *)ctsio);
5968		return (CTL_RETVAL_COMPLETE);
5969	} else if (*len_left < sizeof(struct scsi_mode_page_header)) {
5970
5971		free(ctsio->kern_data_ptr, M_CTL);
5972		ctl_set_param_len_error(ctsio);
5973		ctl_done((union ctl_io *)ctsio);
5974		return (CTL_RETVAL_COMPLETE);
5975
5976	} else if ((page_header->page_code & SMPH_SPF)
5977		&& (*len_left < sizeof(struct scsi_mode_page_header_sp))) {
5978
5979		free(ctsio->kern_data_ptr, M_CTL);
5980		ctl_set_param_len_error(ctsio);
5981		ctl_done((union ctl_io *)ctsio);
5982		return (CTL_RETVAL_COMPLETE);
5983	}
5984
5985
5986	/*
5987	 * XXX KDM should we do something with the block descriptor?
5988	 */
5989	for (i = 0; i < CTL_NUM_MODE_PAGES; i++) {
5990		page_index = &lun->mode_pages.index[i];
5991		if (lun->be_lun->lun_type == T_DIRECT &&
5992		    (page_index->page_flags & CTL_PAGE_FLAG_DIRECT) == 0)
5993			continue;
5994		if (lun->be_lun->lun_type == T_PROCESSOR &&
5995		    (page_index->page_flags & CTL_PAGE_FLAG_PROC) == 0)
5996			continue;
5997		if (lun->be_lun->lun_type == T_CDROM &&
5998		    (page_index->page_flags & CTL_PAGE_FLAG_CDROM) == 0)
5999			continue;
6000
6001		if ((page_index->page_code & SMPH_PC_MASK) !=
6002		    (page_header->page_code & SMPH_PC_MASK))
6003			continue;
6004
6005		/*
6006		 * If neither page has a subpage code, then we've got a
6007		 * match.
6008		 */
6009		if (((page_index->page_code & SMPH_SPF) == 0)
6010		 && ((page_header->page_code & SMPH_SPF) == 0)) {
6011			page_len = page_header->page_length;
6012			break;
6013		}
6014
6015		/*
6016		 * If both pages have subpages, then the subpage numbers
6017		 * have to match.
6018		 */
6019		if ((page_index->page_code & SMPH_SPF)
6020		  && (page_header->page_code & SMPH_SPF)) {
6021			struct scsi_mode_page_header_sp *sph;
6022
6023			sph = (struct scsi_mode_page_header_sp *)page_header;
6024			if (page_index->subpage == sph->subpage) {
6025				page_len = scsi_2btoul(sph->page_length);
6026				break;
6027			}
6028		}
6029	}
6030
6031	/*
6032	 * If we couldn't find the page, or if we don't have a mode select
6033	 * handler for it, send back an error to the user.
6034	 */
6035	if ((i >= CTL_NUM_MODE_PAGES)
6036	 || (page_index->select_handler == NULL)) {
6037		ctl_set_invalid_field(ctsio,
6038				      /*sks_valid*/ 1,
6039				      /*command*/ 0,
6040				      /*field*/ *len_used,
6041				      /*bit_valid*/ 0,
6042				      /*bit*/ 0);
6043		free(ctsio->kern_data_ptr, M_CTL);
6044		ctl_done((union ctl_io *)ctsio);
6045		return (CTL_RETVAL_COMPLETE);
6046	}
6047
6048	if (page_index->page_code & SMPH_SPF) {
6049		page_len_offset = 2;
6050		page_len_size = 2;
6051	} else {
6052		page_len_size = 1;
6053		page_len_offset = 1;
6054	}
6055
6056	/*
6057	 * If the length the initiator gives us isn't the one we specify in
6058	 * the mode page header, or if they didn't specify enough data in
6059	 * the CDB to avoid truncating this page, kick out the request.
6060	 */
6061	if ((page_len != (page_index->page_len - page_len_offset -
6062			  page_len_size))
6063	 || (*len_left < page_index->page_len)) {
6064
6065
6066		ctl_set_invalid_field(ctsio,
6067				      /*sks_valid*/ 1,
6068				      /*command*/ 0,
6069				      /*field*/ *len_used + page_len_offset,
6070				      /*bit_valid*/ 0,
6071				      /*bit*/ 0);
6072		free(ctsio->kern_data_ptr, M_CTL);
6073		ctl_done((union ctl_io *)ctsio);
6074		return (CTL_RETVAL_COMPLETE);
6075	}
6076
6077	/*
6078	 * Run through the mode page, checking to make sure that the bits
6079	 * the user changed are actually legal for him to change.
6080	 */
6081	for (i = 0; i < page_index->page_len; i++) {
6082		uint8_t *user_byte, *change_mask, *current_byte;
6083		int bad_bit;
6084		int j;
6085
6086		user_byte = (uint8_t *)page_header + i;
6087		change_mask = page_index->page_data +
6088			      (page_index->page_len * CTL_PAGE_CHANGEABLE) + i;
6089		current_byte = page_index->page_data +
6090			       (page_index->page_len * CTL_PAGE_CURRENT) + i;
6091
6092		/*
6093		 * Check to see whether the user set any bits in this byte
6094		 * that he is not allowed to set.
6095		 */
6096		if ((*user_byte & ~(*change_mask)) ==
6097		    (*current_byte & ~(*change_mask)))
6098			continue;
6099
6100		/*
6101		 * Go through bit by bit to determine which one is illegal.
6102		 */
6103		bad_bit = 0;
6104		for (j = 7; j >= 0; j--) {
6105			if ((((1 << i) & ~(*change_mask)) & *user_byte) !=
6106			    (((1 << i) & ~(*change_mask)) & *current_byte)) {
6107				bad_bit = i;
6108				break;
6109			}
6110		}
6111		ctl_set_invalid_field(ctsio,
6112				      /*sks_valid*/ 1,
6113				      /*command*/ 0,
6114				      /*field*/ *len_used + i,
6115				      /*bit_valid*/ 1,
6116				      /*bit*/ bad_bit);
6117		free(ctsio->kern_data_ptr, M_CTL);
6118		ctl_done((union ctl_io *)ctsio);
6119		return (CTL_RETVAL_COMPLETE);
6120	}
6121
6122	/*
6123	 * Decrement these before we call the page handler, since we may
6124	 * end up getting called back one way or another before the handler
6125	 * returns to this context.
6126	 */
6127	*len_left -= page_index->page_len;
6128	*len_used += page_index->page_len;
6129
6130	retval = page_index->select_handler(ctsio, page_index,
6131					    (uint8_t *)page_header);
6132
6133	/*
6134	 * If the page handler returns CTL_RETVAL_QUEUED, then we need to
6135	 * wait until this queued command completes to finish processing
6136	 * the mode page.  If it returns anything other than
6137	 * CTL_RETVAL_COMPLETE (e.g. CTL_RETVAL_ERROR), then it should have
6138	 * already set the sense information, freed the data pointer, and
6139	 * completed the io for us.
6140	 */
6141	if (retval != CTL_RETVAL_COMPLETE)
6142		goto bailout_no_done;
6143
6144	/*
6145	 * If the initiator sent us more than one page, parse the next one.
6146	 */
6147	if (*len_left > 0)
6148		goto do_next_page;
6149
6150	ctl_set_success(ctsio);
6151	free(ctsio->kern_data_ptr, M_CTL);
6152	ctl_done((union ctl_io *)ctsio);
6153
6154bailout_no_done:
6155
6156	return (CTL_RETVAL_COMPLETE);
6157
6158}
6159
6160int
6161ctl_mode_select(struct ctl_scsiio *ctsio)
6162{
6163	int param_len, pf, sp;
6164	int header_size, bd_len;
6165	union ctl_modepage_info *modepage_info;
6166
6167	switch (ctsio->cdb[0]) {
6168	case MODE_SELECT_6: {
6169		struct scsi_mode_select_6 *cdb;
6170
6171		cdb = (struct scsi_mode_select_6 *)ctsio->cdb;
6172
6173		pf = (cdb->byte2 & SMS_PF) ? 1 : 0;
6174		sp = (cdb->byte2 & SMS_SP) ? 1 : 0;
6175		param_len = cdb->length;
6176		header_size = sizeof(struct scsi_mode_header_6);
6177		break;
6178	}
6179	case MODE_SELECT_10: {
6180		struct scsi_mode_select_10 *cdb;
6181
6182		cdb = (struct scsi_mode_select_10 *)ctsio->cdb;
6183
6184		pf = (cdb->byte2 & SMS_PF) ? 1 : 0;
6185		sp = (cdb->byte2 & SMS_SP) ? 1 : 0;
6186		param_len = scsi_2btoul(cdb->length);
6187		header_size = sizeof(struct scsi_mode_header_10);
6188		break;
6189	}
6190	default:
6191		ctl_set_invalid_opcode(ctsio);
6192		ctl_done((union ctl_io *)ctsio);
6193		return (CTL_RETVAL_COMPLETE);
6194	}
6195
6196	/*
6197	 * From SPC-3:
6198	 * "A parameter list length of zero indicates that the Data-Out Buffer
6199	 * shall be empty. This condition shall not be considered as an error."
6200	 */
6201	if (param_len == 0) {
6202		ctl_set_success(ctsio);
6203		ctl_done((union ctl_io *)ctsio);
6204		return (CTL_RETVAL_COMPLETE);
6205	}
6206
6207	/*
6208	 * Since we'll hit this the first time through, prior to
6209	 * allocation, we don't need to free a data buffer here.
6210	 */
6211	if (param_len < header_size) {
6212		ctl_set_param_len_error(ctsio);
6213		ctl_done((union ctl_io *)ctsio);
6214		return (CTL_RETVAL_COMPLETE);
6215	}
6216
6217	/*
6218	 * Allocate the data buffer and grab the user's data.  In theory,
6219	 * we shouldn't have to sanity check the parameter list length here
6220	 * because the maximum size is 64K.  We should be able to malloc
6221	 * that much without too many problems.
6222	 */
6223	if ((ctsio->io_hdr.flags & CTL_FLAG_ALLOCATED) == 0) {
6224		ctsio->kern_data_ptr = malloc(param_len, M_CTL, M_WAITOK);
6225		ctsio->kern_data_len = param_len;
6226		ctsio->kern_total_len = param_len;
6227		ctsio->kern_data_resid = 0;
6228		ctsio->kern_rel_offset = 0;
6229		ctsio->kern_sg_entries = 0;
6230		ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
6231		ctsio->be_move_done = ctl_config_move_done;
6232		ctl_datamove((union ctl_io *)ctsio);
6233
6234		return (CTL_RETVAL_COMPLETE);
6235	}
6236
6237	switch (ctsio->cdb[0]) {
6238	case MODE_SELECT_6: {
6239		struct scsi_mode_header_6 *mh6;
6240
6241		mh6 = (struct scsi_mode_header_6 *)ctsio->kern_data_ptr;
6242		bd_len = mh6->blk_desc_len;
6243		break;
6244	}
6245	case MODE_SELECT_10: {
6246		struct scsi_mode_header_10 *mh10;
6247
6248		mh10 = (struct scsi_mode_header_10 *)ctsio->kern_data_ptr;
6249		bd_len = scsi_2btoul(mh10->blk_desc_len);
6250		break;
6251	}
6252	default:
6253		panic("%s: Invalid CDB type %#x", __func__, ctsio->cdb[0]);
6254	}
6255
6256	if (param_len < (header_size + bd_len)) {
6257		free(ctsio->kern_data_ptr, M_CTL);
6258		ctl_set_param_len_error(ctsio);
6259		ctl_done((union ctl_io *)ctsio);
6260		return (CTL_RETVAL_COMPLETE);
6261	}
6262
6263	/*
6264	 * Set the IO_CONT flag, so that if this I/O gets passed to
6265	 * ctl_config_write_done(), it'll get passed back to
6266	 * ctl_do_mode_select() for further processing, or completion if
6267	 * we're all done.
6268	 */
6269	ctsio->io_hdr.flags |= CTL_FLAG_IO_CONT;
6270	ctsio->io_cont = ctl_do_mode_select;
6271
6272	modepage_info = (union ctl_modepage_info *)
6273		ctsio->io_hdr.ctl_private[CTL_PRIV_MODEPAGE].bytes;
6274	memset(modepage_info, 0, sizeof(*modepage_info));
6275	modepage_info->header.len_left = param_len - header_size - bd_len;
6276	modepage_info->header.len_used = header_size + bd_len;
6277
6278	return (ctl_do_mode_select((union ctl_io *)ctsio));
6279}
6280
6281int
6282ctl_mode_sense(struct ctl_scsiio *ctsio)
6283{
6284	struct ctl_lun *lun;
6285	int pc, page_code, dbd, llba, subpage;
6286	int alloc_len, page_len, header_len, total_len;
6287	struct scsi_mode_block_descr *block_desc;
6288	struct ctl_page_index *page_index;
6289
6290	dbd = 0;
6291	llba = 0;
6292	block_desc = NULL;
6293
6294	CTL_DEBUG_PRINT(("ctl_mode_sense\n"));
6295
6296	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
6297	switch (ctsio->cdb[0]) {
6298	case MODE_SENSE_6: {
6299		struct scsi_mode_sense_6 *cdb;
6300
6301		cdb = (struct scsi_mode_sense_6 *)ctsio->cdb;
6302
6303		header_len = sizeof(struct scsi_mode_hdr_6);
6304		if (cdb->byte2 & SMS_DBD)
6305			dbd = 1;
6306		else
6307			header_len += sizeof(struct scsi_mode_block_descr);
6308
6309		pc = (cdb->page & SMS_PAGE_CTRL_MASK) >> 6;
6310		page_code = cdb->page & SMS_PAGE_CODE;
6311		subpage = cdb->subpage;
6312		alloc_len = cdb->length;
6313		break;
6314	}
6315	case MODE_SENSE_10: {
6316		struct scsi_mode_sense_10 *cdb;
6317
6318		cdb = (struct scsi_mode_sense_10 *)ctsio->cdb;
6319
6320		header_len = sizeof(struct scsi_mode_hdr_10);
6321
6322		if (cdb->byte2 & SMS_DBD)
6323			dbd = 1;
6324		else
6325			header_len += sizeof(struct scsi_mode_block_descr);
6326		if (cdb->byte2 & SMS10_LLBAA)
6327			llba = 1;
6328		pc = (cdb->page & SMS_PAGE_CTRL_MASK) >> 6;
6329		page_code = cdb->page & SMS_PAGE_CODE;
6330		subpage = cdb->subpage;
6331		alloc_len = scsi_2btoul(cdb->length);
6332		break;
6333	}
6334	default:
6335		ctl_set_invalid_opcode(ctsio);
6336		ctl_done((union ctl_io *)ctsio);
6337		return (CTL_RETVAL_COMPLETE);
6338		break; /* NOTREACHED */
6339	}
6340
6341	/*
6342	 * We have to make a first pass through to calculate the size of
6343	 * the pages that match the user's query.  Then we allocate enough
6344	 * memory to hold it, and actually copy the data into the buffer.
6345	 */
6346	switch (page_code) {
6347	case SMS_ALL_PAGES_PAGE: {
6348		u_int i;
6349
6350		page_len = 0;
6351
6352		/*
6353		 * At the moment, values other than 0 and 0xff here are
6354		 * reserved according to SPC-3.
6355		 */
6356		if ((subpage != SMS_SUBPAGE_PAGE_0)
6357		 && (subpage != SMS_SUBPAGE_ALL)) {
6358			ctl_set_invalid_field(ctsio,
6359					      /*sks_valid*/ 1,
6360					      /*command*/ 1,
6361					      /*field*/ 3,
6362					      /*bit_valid*/ 0,
6363					      /*bit*/ 0);
6364			ctl_done((union ctl_io *)ctsio);
6365			return (CTL_RETVAL_COMPLETE);
6366		}
6367
6368		for (i = 0; i < CTL_NUM_MODE_PAGES; i++) {
6369			page_index = &lun->mode_pages.index[i];
6370
6371			/* Make sure the page is supported for this dev type */
6372			if (lun->be_lun->lun_type == T_DIRECT &&
6373			    (page_index->page_flags & CTL_PAGE_FLAG_DIRECT) == 0)
6374				continue;
6375			if (lun->be_lun->lun_type == T_PROCESSOR &&
6376			    (page_index->page_flags & CTL_PAGE_FLAG_PROC) == 0)
6377				continue;
6378			if (lun->be_lun->lun_type == T_CDROM &&
6379			    (page_index->page_flags & CTL_PAGE_FLAG_CDROM) == 0)
6380				continue;
6381
6382			/*
6383			 * We don't use this subpage if the user didn't
6384			 * request all subpages.
6385			 */
6386			if ((page_index->subpage != 0)
6387			 && (subpage == SMS_SUBPAGE_PAGE_0))
6388				continue;
6389
6390#if 0
6391			printf("found page %#x len %d\n",
6392			       page_index->page_code & SMPH_PC_MASK,
6393			       page_index->page_len);
6394#endif
6395			page_len += page_index->page_len;
6396		}
6397		break;
6398	}
6399	default: {
6400		u_int i;
6401
6402		page_len = 0;
6403
6404		for (i = 0; i < CTL_NUM_MODE_PAGES; i++) {
6405			page_index = &lun->mode_pages.index[i];
6406
6407			/* Make sure the page is supported for this dev type */
6408			if (lun->be_lun->lun_type == T_DIRECT &&
6409			    (page_index->page_flags & CTL_PAGE_FLAG_DIRECT) == 0)
6410				continue;
6411			if (lun->be_lun->lun_type == T_PROCESSOR &&
6412			    (page_index->page_flags & CTL_PAGE_FLAG_PROC) == 0)
6413				continue;
6414			if (lun->be_lun->lun_type == T_CDROM &&
6415			    (page_index->page_flags & CTL_PAGE_FLAG_CDROM) == 0)
6416				continue;
6417
6418			/* Look for the right page code */
6419			if ((page_index->page_code & SMPH_PC_MASK) != page_code)
6420				continue;
6421
6422			/* Look for the right subpage or the subpage wildcard*/
6423			if ((page_index->subpage != subpage)
6424			 && (subpage != SMS_SUBPAGE_ALL))
6425				continue;
6426
6427#if 0
6428			printf("found page %#x len %d\n",
6429			       page_index->page_code & SMPH_PC_MASK,
6430			       page_index->page_len);
6431#endif
6432
6433			page_len += page_index->page_len;
6434		}
6435
6436		if (page_len == 0) {
6437			ctl_set_invalid_field(ctsio,
6438					      /*sks_valid*/ 1,
6439					      /*command*/ 1,
6440					      /*field*/ 2,
6441					      /*bit_valid*/ 1,
6442					      /*bit*/ 5);
6443			ctl_done((union ctl_io *)ctsio);
6444			return (CTL_RETVAL_COMPLETE);
6445		}
6446		break;
6447	}
6448	}
6449
6450	total_len = header_len + page_len;
6451#if 0
6452	printf("header_len = %d, page_len = %d, total_len = %d\n",
6453	       header_len, page_len, total_len);
6454#endif
6455
6456	ctsio->kern_data_ptr = malloc(total_len, M_CTL, M_WAITOK | M_ZERO);
6457	ctsio->kern_sg_entries = 0;
6458	ctsio->kern_data_resid = 0;
6459	ctsio->kern_rel_offset = 0;
6460	if (total_len < alloc_len) {
6461		ctsio->residual = alloc_len - total_len;
6462		ctsio->kern_data_len = total_len;
6463		ctsio->kern_total_len = total_len;
6464	} else {
6465		ctsio->residual = 0;
6466		ctsio->kern_data_len = alloc_len;
6467		ctsio->kern_total_len = alloc_len;
6468	}
6469
6470	switch (ctsio->cdb[0]) {
6471	case MODE_SENSE_6: {
6472		struct scsi_mode_hdr_6 *header;
6473
6474		header = (struct scsi_mode_hdr_6 *)ctsio->kern_data_ptr;
6475
6476		header->datalen = MIN(total_len - 1, 254);
6477		if (lun->be_lun->lun_type == T_DIRECT) {
6478			header->dev_specific = 0x10; /* DPOFUA */
6479			if ((lun->be_lun->flags & CTL_LUN_FLAG_READONLY) ||
6480			    (lun->mode_pages.control_page[CTL_PAGE_CURRENT]
6481			    .eca_and_aen & SCP_SWP) != 0)
6482				    header->dev_specific |= 0x80; /* WP */
6483		}
6484		if (dbd)
6485			header->block_descr_len = 0;
6486		else
6487			header->block_descr_len =
6488				sizeof(struct scsi_mode_block_descr);
6489		block_desc = (struct scsi_mode_block_descr *)&header[1];
6490		break;
6491	}
6492	case MODE_SENSE_10: {
6493		struct scsi_mode_hdr_10 *header;
6494		int datalen;
6495
6496		header = (struct scsi_mode_hdr_10 *)ctsio->kern_data_ptr;
6497
6498		datalen = MIN(total_len - 2, 65533);
6499		scsi_ulto2b(datalen, header->datalen);
6500		if (lun->be_lun->lun_type == T_DIRECT) {
6501			header->dev_specific = 0x10; /* DPOFUA */
6502			if ((lun->be_lun->flags & CTL_LUN_FLAG_READONLY) ||
6503			    (lun->mode_pages.control_page[CTL_PAGE_CURRENT]
6504			    .eca_and_aen & SCP_SWP) != 0)
6505				    header->dev_specific |= 0x80; /* WP */
6506		}
6507		if (dbd)
6508			scsi_ulto2b(0, header->block_descr_len);
6509		else
6510			scsi_ulto2b(sizeof(struct scsi_mode_block_descr),
6511				    header->block_descr_len);
6512		block_desc = (struct scsi_mode_block_descr *)&header[1];
6513		break;
6514	}
6515	default:
6516		panic("%s: Invalid CDB type %#x", __func__, ctsio->cdb[0]);
6517	}
6518
6519	/*
6520	 * If we've got a disk, use its blocksize in the block
6521	 * descriptor.  Otherwise, just set it to 0.
6522	 */
6523	if (dbd == 0) {
6524		if (lun->be_lun->lun_type == T_DIRECT)
6525			scsi_ulto3b(lun->be_lun->blocksize,
6526				    block_desc->block_len);
6527		else
6528			scsi_ulto3b(0, block_desc->block_len);
6529	}
6530
6531	switch (page_code) {
6532	case SMS_ALL_PAGES_PAGE: {
6533		int i, data_used;
6534
6535		data_used = header_len;
6536		for (i = 0; i < CTL_NUM_MODE_PAGES; i++) {
6537			struct ctl_page_index *page_index;
6538
6539			page_index = &lun->mode_pages.index[i];
6540			if (lun->be_lun->lun_type == T_DIRECT &&
6541			    (page_index->page_flags & CTL_PAGE_FLAG_DIRECT) == 0)
6542				continue;
6543			if (lun->be_lun->lun_type == T_PROCESSOR &&
6544			    (page_index->page_flags & CTL_PAGE_FLAG_PROC) == 0)
6545				continue;
6546			if (lun->be_lun->lun_type == T_CDROM &&
6547			    (page_index->page_flags & CTL_PAGE_FLAG_CDROM) == 0)
6548				continue;
6549
6550			/*
6551			 * We don't use this subpage if the user didn't
6552			 * request all subpages.  We already checked (above)
6553			 * to make sure the user only specified a subpage
6554			 * of 0 or 0xff in the SMS_ALL_PAGES_PAGE case.
6555			 */
6556			if ((page_index->subpage != 0)
6557			 && (subpage == SMS_SUBPAGE_PAGE_0))
6558				continue;
6559
6560			/*
6561			 * Call the handler, if it exists, to update the
6562			 * page to the latest values.
6563			 */
6564			if (page_index->sense_handler != NULL)
6565				page_index->sense_handler(ctsio, page_index,pc);
6566
6567			memcpy(ctsio->kern_data_ptr + data_used,
6568			       page_index->page_data +
6569			       (page_index->page_len * pc),
6570			       page_index->page_len);
6571			data_used += page_index->page_len;
6572		}
6573		break;
6574	}
6575	default: {
6576		int i, data_used;
6577
6578		data_used = header_len;
6579
6580		for (i = 0; i < CTL_NUM_MODE_PAGES; i++) {
6581			struct ctl_page_index *page_index;
6582
6583			page_index = &lun->mode_pages.index[i];
6584
6585			/* Look for the right page code */
6586			if ((page_index->page_code & SMPH_PC_MASK) != page_code)
6587				continue;
6588
6589			/* Look for the right subpage or the subpage wildcard*/
6590			if ((page_index->subpage != subpage)
6591			 && (subpage != SMS_SUBPAGE_ALL))
6592				continue;
6593
6594			/* Make sure the page is supported for this dev type */
6595			if (lun->be_lun->lun_type == T_DIRECT &&
6596			    (page_index->page_flags & CTL_PAGE_FLAG_DIRECT) == 0)
6597				continue;
6598			if (lun->be_lun->lun_type == T_PROCESSOR &&
6599			    (page_index->page_flags & CTL_PAGE_FLAG_PROC) == 0)
6600				continue;
6601			if (lun->be_lun->lun_type == T_CDROM &&
6602			    (page_index->page_flags & CTL_PAGE_FLAG_CDROM) == 0)
6603				continue;
6604
6605			/*
6606			 * Call the handler, if it exists, to update the
6607			 * page to the latest values.
6608			 */
6609			if (page_index->sense_handler != NULL)
6610				page_index->sense_handler(ctsio, page_index,pc);
6611
6612			memcpy(ctsio->kern_data_ptr + data_used,
6613			       page_index->page_data +
6614			       (page_index->page_len * pc),
6615			       page_index->page_len);
6616			data_used += page_index->page_len;
6617		}
6618		break;
6619	}
6620	}
6621
6622	ctl_set_success(ctsio);
6623	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
6624	ctsio->be_move_done = ctl_config_move_done;
6625	ctl_datamove((union ctl_io *)ctsio);
6626	return (CTL_RETVAL_COMPLETE);
6627}
6628
6629int
6630ctl_lbp_log_sense_handler(struct ctl_scsiio *ctsio,
6631			       struct ctl_page_index *page_index,
6632			       int pc)
6633{
6634	struct ctl_lun *lun;
6635	struct scsi_log_param_header *phdr;
6636	uint8_t *data;
6637	uint64_t val;
6638
6639	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
6640	data = page_index->page_data;
6641
6642	if (lun->backend->lun_attr != NULL &&
6643	    (val = lun->backend->lun_attr(lun->be_lun->be_lun, "blocksavail"))
6644	     != UINT64_MAX) {
6645		phdr = (struct scsi_log_param_header *)data;
6646		scsi_ulto2b(0x0001, phdr->param_code);
6647		phdr->param_control = SLP_LBIN | SLP_LP;
6648		phdr->param_len = 8;
6649		data = (uint8_t *)(phdr + 1);
6650		scsi_ulto4b(val >> CTL_LBP_EXPONENT, data);
6651		data[4] = 0x02; /* per-pool */
6652		data += phdr->param_len;
6653	}
6654
6655	if (lun->backend->lun_attr != NULL &&
6656	    (val = lun->backend->lun_attr(lun->be_lun->be_lun, "blocksused"))
6657	     != UINT64_MAX) {
6658		phdr = (struct scsi_log_param_header *)data;
6659		scsi_ulto2b(0x0002, phdr->param_code);
6660		phdr->param_control = SLP_LBIN | SLP_LP;
6661		phdr->param_len = 8;
6662		data = (uint8_t *)(phdr + 1);
6663		scsi_ulto4b(val >> CTL_LBP_EXPONENT, data);
6664		data[4] = 0x01; /* per-LUN */
6665		data += phdr->param_len;
6666	}
6667
6668	if (lun->backend->lun_attr != NULL &&
6669	    (val = lun->backend->lun_attr(lun->be_lun->be_lun, "poolblocksavail"))
6670	     != UINT64_MAX) {
6671		phdr = (struct scsi_log_param_header *)data;
6672		scsi_ulto2b(0x00f1, phdr->param_code);
6673		phdr->param_control = SLP_LBIN | SLP_LP;
6674		phdr->param_len = 8;
6675		data = (uint8_t *)(phdr + 1);
6676		scsi_ulto4b(val >> CTL_LBP_EXPONENT, data);
6677		data[4] = 0x02; /* per-pool */
6678		data += phdr->param_len;
6679	}
6680
6681	if (lun->backend->lun_attr != NULL &&
6682	    (val = lun->backend->lun_attr(lun->be_lun->be_lun, "poolblocksused"))
6683	     != UINT64_MAX) {
6684		phdr = (struct scsi_log_param_header *)data;
6685		scsi_ulto2b(0x00f2, phdr->param_code);
6686		phdr->param_control = SLP_LBIN | SLP_LP;
6687		phdr->param_len = 8;
6688		data = (uint8_t *)(phdr + 1);
6689		scsi_ulto4b(val >> CTL_LBP_EXPONENT, data);
6690		data[4] = 0x02; /* per-pool */
6691		data += phdr->param_len;
6692	}
6693
6694	page_index->page_len = data - page_index->page_data;
6695	return (0);
6696}
6697
6698int
6699ctl_sap_log_sense_handler(struct ctl_scsiio *ctsio,
6700			       struct ctl_page_index *page_index,
6701			       int pc)
6702{
6703	struct ctl_lun *lun;
6704	struct stat_page *data;
6705	uint64_t rn, wn, rb, wb;
6706	struct bintime rt, wt;
6707	int i;
6708
6709	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
6710	data = (struct stat_page *)page_index->page_data;
6711
6712	scsi_ulto2b(SLP_SAP, data->sap.hdr.param_code);
6713	data->sap.hdr.param_control = SLP_LBIN;
6714	data->sap.hdr.param_len = sizeof(struct scsi_log_stat_and_perf) -
6715	    sizeof(struct scsi_log_param_header);
6716	rn = wn = rb = wb = 0;
6717	bintime_clear(&rt);
6718	bintime_clear(&wt);
6719	for (i = 0; i < CTL_MAX_PORTS; i++) {
6720		rn += lun->stats.ports[i].operations[CTL_STATS_READ];
6721		wn += lun->stats.ports[i].operations[CTL_STATS_WRITE];
6722		rb += lun->stats.ports[i].bytes[CTL_STATS_READ];
6723		wb += lun->stats.ports[i].bytes[CTL_STATS_WRITE];
6724		bintime_add(&rt, &lun->stats.ports[i].time[CTL_STATS_READ]);
6725		bintime_add(&wt, &lun->stats.ports[i].time[CTL_STATS_WRITE]);
6726	}
6727	scsi_u64to8b(rn, data->sap.read_num);
6728	scsi_u64to8b(wn, data->sap.write_num);
6729	if (lun->stats.blocksize > 0) {
6730		scsi_u64to8b(wb / lun->stats.blocksize,
6731		    data->sap.recvieved_lba);
6732		scsi_u64to8b(rb / lun->stats.blocksize,
6733		    data->sap.transmitted_lba);
6734	}
6735	scsi_u64to8b((uint64_t)rt.sec * 1000 + rt.frac / (UINT64_MAX / 1000),
6736	    data->sap.read_int);
6737	scsi_u64to8b((uint64_t)wt.sec * 1000 + wt.frac / (UINT64_MAX / 1000),
6738	    data->sap.write_int);
6739	scsi_u64to8b(0, data->sap.weighted_num);
6740	scsi_u64to8b(0, data->sap.weighted_int);
6741	scsi_ulto2b(SLP_IT, data->it.hdr.param_code);
6742	data->it.hdr.param_control = SLP_LBIN;
6743	data->it.hdr.param_len = sizeof(struct scsi_log_idle_time) -
6744	    sizeof(struct scsi_log_param_header);
6745#ifdef CTL_TIME_IO
6746	scsi_u64to8b(lun->idle_time / SBT_1MS, data->it.idle_int);
6747#endif
6748	scsi_ulto2b(SLP_TI, data->ti.hdr.param_code);
6749	data->it.hdr.param_control = SLP_LBIN;
6750	data->ti.hdr.param_len = sizeof(struct scsi_log_time_interval) -
6751	    sizeof(struct scsi_log_param_header);
6752	scsi_ulto4b(3, data->ti.exponent);
6753	scsi_ulto4b(1, data->ti.integer);
6754	return (0);
6755}
6756
6757int
6758ctl_ie_log_sense_handler(struct ctl_scsiio *ctsio,
6759			       struct ctl_page_index *page_index,
6760			       int pc)
6761{
6762	struct ctl_lun *lun;
6763	struct scsi_log_informational_exceptions *data;
6764
6765	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
6766	data = (struct scsi_log_informational_exceptions *)page_index->page_data;
6767
6768	scsi_ulto2b(SLP_IE_GEN, data->hdr.param_code);
6769	data->hdr.param_control = SLP_LBIN;
6770	data->hdr.param_len = sizeof(struct scsi_log_informational_exceptions) -
6771	    sizeof(struct scsi_log_param_header);
6772	data->ie_asc = lun->ie_asc;
6773	data->ie_ascq = lun->ie_ascq;
6774	data->temperature = 0xff;
6775	return (0);
6776}
6777
6778int
6779ctl_log_sense(struct ctl_scsiio *ctsio)
6780{
6781	struct ctl_lun *lun;
6782	int i, pc, page_code, subpage;
6783	int alloc_len, total_len;
6784	struct ctl_page_index *page_index;
6785	struct scsi_log_sense *cdb;
6786	struct scsi_log_header *header;
6787
6788	CTL_DEBUG_PRINT(("ctl_log_sense\n"));
6789
6790	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
6791	cdb = (struct scsi_log_sense *)ctsio->cdb;
6792	pc = (cdb->page & SLS_PAGE_CTRL_MASK) >> 6;
6793	page_code = cdb->page & SLS_PAGE_CODE;
6794	subpage = cdb->subpage;
6795	alloc_len = scsi_2btoul(cdb->length);
6796
6797	page_index = NULL;
6798	for (i = 0; i < CTL_NUM_LOG_PAGES; i++) {
6799		page_index = &lun->log_pages.index[i];
6800
6801		/* Look for the right page code */
6802		if ((page_index->page_code & SL_PAGE_CODE) != page_code)
6803			continue;
6804
6805		/* Look for the right subpage or the subpage wildcard*/
6806		if (page_index->subpage != subpage)
6807			continue;
6808
6809		break;
6810	}
6811	if (i >= CTL_NUM_LOG_PAGES) {
6812		ctl_set_invalid_field(ctsio,
6813				      /*sks_valid*/ 1,
6814				      /*command*/ 1,
6815				      /*field*/ 2,
6816				      /*bit_valid*/ 0,
6817				      /*bit*/ 0);
6818		ctl_done((union ctl_io *)ctsio);
6819		return (CTL_RETVAL_COMPLETE);
6820	}
6821
6822	total_len = sizeof(struct scsi_log_header) + page_index->page_len;
6823
6824	ctsio->kern_data_ptr = malloc(total_len, M_CTL, M_WAITOK | M_ZERO);
6825	ctsio->kern_sg_entries = 0;
6826	ctsio->kern_data_resid = 0;
6827	ctsio->kern_rel_offset = 0;
6828	if (total_len < alloc_len) {
6829		ctsio->residual = alloc_len - total_len;
6830		ctsio->kern_data_len = total_len;
6831		ctsio->kern_total_len = total_len;
6832	} else {
6833		ctsio->residual = 0;
6834		ctsio->kern_data_len = alloc_len;
6835		ctsio->kern_total_len = alloc_len;
6836	}
6837
6838	header = (struct scsi_log_header *)ctsio->kern_data_ptr;
6839	header->page = page_index->page_code;
6840	if (page_index->page_code == SLS_LOGICAL_BLOCK_PROVISIONING)
6841		header->page |= SL_DS;
6842	if (page_index->subpage) {
6843		header->page |= SL_SPF;
6844		header->subpage = page_index->subpage;
6845	}
6846	scsi_ulto2b(page_index->page_len, header->datalen);
6847
6848	/*
6849	 * Call the handler, if it exists, to update the
6850	 * page to the latest values.
6851	 */
6852	if (page_index->sense_handler != NULL)
6853		page_index->sense_handler(ctsio, page_index, pc);
6854
6855	memcpy(header + 1, page_index->page_data, page_index->page_len);
6856
6857	ctl_set_success(ctsio);
6858	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
6859	ctsio->be_move_done = ctl_config_move_done;
6860	ctl_datamove((union ctl_io *)ctsio);
6861	return (CTL_RETVAL_COMPLETE);
6862}
6863
6864int
6865ctl_read_capacity(struct ctl_scsiio *ctsio)
6866{
6867	struct scsi_read_capacity *cdb;
6868	struct scsi_read_capacity_data *data;
6869	struct ctl_lun *lun;
6870	uint32_t lba;
6871
6872	CTL_DEBUG_PRINT(("ctl_read_capacity\n"));
6873
6874	cdb = (struct scsi_read_capacity *)ctsio->cdb;
6875
6876	lba = scsi_4btoul(cdb->addr);
6877	if (((cdb->pmi & SRC_PMI) == 0)
6878	 && (lba != 0)) {
6879		ctl_set_invalid_field(/*ctsio*/ ctsio,
6880				      /*sks_valid*/ 1,
6881				      /*command*/ 1,
6882				      /*field*/ 2,
6883				      /*bit_valid*/ 0,
6884				      /*bit*/ 0);
6885		ctl_done((union ctl_io *)ctsio);
6886		return (CTL_RETVAL_COMPLETE);
6887	}
6888
6889	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
6890
6891	ctsio->kern_data_ptr = malloc(sizeof(*data), M_CTL, M_WAITOK | M_ZERO);
6892	data = (struct scsi_read_capacity_data *)ctsio->kern_data_ptr;
6893	ctsio->residual = 0;
6894	ctsio->kern_data_len = sizeof(*data);
6895	ctsio->kern_total_len = sizeof(*data);
6896	ctsio->kern_data_resid = 0;
6897	ctsio->kern_rel_offset = 0;
6898	ctsio->kern_sg_entries = 0;
6899
6900	/*
6901	 * If the maximum LBA is greater than 0xfffffffe, the user must
6902	 * issue a SERVICE ACTION IN (16) command, with the read capacity
6903	 * serivce action set.
6904	 */
6905	if (lun->be_lun->maxlba > 0xfffffffe)
6906		scsi_ulto4b(0xffffffff, data->addr);
6907	else
6908		scsi_ulto4b(lun->be_lun->maxlba, data->addr);
6909
6910	/*
6911	 * XXX KDM this may not be 512 bytes...
6912	 */
6913	scsi_ulto4b(lun->be_lun->blocksize, data->length);
6914
6915	ctl_set_success(ctsio);
6916	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
6917	ctsio->be_move_done = ctl_config_move_done;
6918	ctl_datamove((union ctl_io *)ctsio);
6919	return (CTL_RETVAL_COMPLETE);
6920}
6921
6922int
6923ctl_read_capacity_16(struct ctl_scsiio *ctsio)
6924{
6925	struct scsi_read_capacity_16 *cdb;
6926	struct scsi_read_capacity_data_long *data;
6927	struct ctl_lun *lun;
6928	uint64_t lba;
6929	uint32_t alloc_len;
6930
6931	CTL_DEBUG_PRINT(("ctl_read_capacity_16\n"));
6932
6933	cdb = (struct scsi_read_capacity_16 *)ctsio->cdb;
6934
6935	alloc_len = scsi_4btoul(cdb->alloc_len);
6936	lba = scsi_8btou64(cdb->addr);
6937
6938	if ((cdb->reladr & SRC16_PMI)
6939	 && (lba != 0)) {
6940		ctl_set_invalid_field(/*ctsio*/ ctsio,
6941				      /*sks_valid*/ 1,
6942				      /*command*/ 1,
6943				      /*field*/ 2,
6944				      /*bit_valid*/ 0,
6945				      /*bit*/ 0);
6946		ctl_done((union ctl_io *)ctsio);
6947		return (CTL_RETVAL_COMPLETE);
6948	}
6949
6950	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
6951
6952	ctsio->kern_data_ptr = malloc(sizeof(*data), M_CTL, M_WAITOK | M_ZERO);
6953	data = (struct scsi_read_capacity_data_long *)ctsio->kern_data_ptr;
6954
6955	if (sizeof(*data) < alloc_len) {
6956		ctsio->residual = alloc_len - sizeof(*data);
6957		ctsio->kern_data_len = sizeof(*data);
6958		ctsio->kern_total_len = sizeof(*data);
6959	} else {
6960		ctsio->residual = 0;
6961		ctsio->kern_data_len = alloc_len;
6962		ctsio->kern_total_len = alloc_len;
6963	}
6964	ctsio->kern_data_resid = 0;
6965	ctsio->kern_rel_offset = 0;
6966	ctsio->kern_sg_entries = 0;
6967
6968	scsi_u64to8b(lun->be_lun->maxlba, data->addr);
6969	/* XXX KDM this may not be 512 bytes... */
6970	scsi_ulto4b(lun->be_lun->blocksize, data->length);
6971	data->prot_lbppbe = lun->be_lun->pblockexp & SRC16_LBPPBE;
6972	scsi_ulto2b(lun->be_lun->pblockoff & SRC16_LALBA_A, data->lalba_lbp);
6973	if (lun->be_lun->flags & CTL_LUN_FLAG_UNMAP)
6974		data->lalba_lbp[0] |= SRC16_LBPME | SRC16_LBPRZ;
6975
6976	ctl_set_success(ctsio);
6977	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
6978	ctsio->be_move_done = ctl_config_move_done;
6979	ctl_datamove((union ctl_io *)ctsio);
6980	return (CTL_RETVAL_COMPLETE);
6981}
6982
6983int
6984ctl_get_lba_status(struct ctl_scsiio *ctsio)
6985{
6986	struct scsi_get_lba_status *cdb;
6987	struct scsi_get_lba_status_data *data;
6988	struct ctl_lun *lun;
6989	struct ctl_lba_len_flags *lbalen;
6990	uint64_t lba;
6991	uint32_t alloc_len, total_len;
6992	int retval;
6993
6994	CTL_DEBUG_PRINT(("ctl_get_lba_status\n"));
6995
6996	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
6997	cdb = (struct scsi_get_lba_status *)ctsio->cdb;
6998	lba = scsi_8btou64(cdb->addr);
6999	alloc_len = scsi_4btoul(cdb->alloc_len);
7000
7001	if (lba > lun->be_lun->maxlba) {
7002		ctl_set_lba_out_of_range(ctsio);
7003		ctl_done((union ctl_io *)ctsio);
7004		return (CTL_RETVAL_COMPLETE);
7005	}
7006
7007	total_len = sizeof(*data) + sizeof(data->descr[0]);
7008	ctsio->kern_data_ptr = malloc(total_len, M_CTL, M_WAITOK | M_ZERO);
7009	data = (struct scsi_get_lba_status_data *)ctsio->kern_data_ptr;
7010
7011	if (total_len < alloc_len) {
7012		ctsio->residual = alloc_len - total_len;
7013		ctsio->kern_data_len = total_len;
7014		ctsio->kern_total_len = total_len;
7015	} else {
7016		ctsio->residual = 0;
7017		ctsio->kern_data_len = alloc_len;
7018		ctsio->kern_total_len = alloc_len;
7019	}
7020	ctsio->kern_data_resid = 0;
7021	ctsio->kern_rel_offset = 0;
7022	ctsio->kern_sg_entries = 0;
7023
7024	/* Fill dummy data in case backend can't tell anything. */
7025	scsi_ulto4b(4 + sizeof(data->descr[0]), data->length);
7026	scsi_u64to8b(lba, data->descr[0].addr);
7027	scsi_ulto4b(MIN(UINT32_MAX, lun->be_lun->maxlba + 1 - lba),
7028	    data->descr[0].length);
7029	data->descr[0].status = 0; /* Mapped or unknown. */
7030
7031	ctl_set_success(ctsio);
7032	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
7033	ctsio->be_move_done = ctl_config_move_done;
7034
7035	lbalen = (struct ctl_lba_len_flags *)&ctsio->io_hdr.ctl_private[CTL_PRIV_LBA_LEN];
7036	lbalen->lba = lba;
7037	lbalen->len = total_len;
7038	lbalen->flags = 0;
7039	retval = lun->backend->config_read((union ctl_io *)ctsio);
7040	return (CTL_RETVAL_COMPLETE);
7041}
7042
7043int
7044ctl_read_defect(struct ctl_scsiio *ctsio)
7045{
7046	struct scsi_read_defect_data_10 *ccb10;
7047	struct scsi_read_defect_data_12 *ccb12;
7048	struct scsi_read_defect_data_hdr_10 *data10;
7049	struct scsi_read_defect_data_hdr_12 *data12;
7050	uint32_t alloc_len, data_len;
7051	uint8_t format;
7052
7053	CTL_DEBUG_PRINT(("ctl_read_defect\n"));
7054
7055	if (ctsio->cdb[0] == READ_DEFECT_DATA_10) {
7056		ccb10 = (struct scsi_read_defect_data_10 *)&ctsio->cdb;
7057		format = ccb10->format;
7058		alloc_len = scsi_2btoul(ccb10->alloc_length);
7059		data_len = sizeof(*data10);
7060	} else {
7061		ccb12 = (struct scsi_read_defect_data_12 *)&ctsio->cdb;
7062		format = ccb12->format;
7063		alloc_len = scsi_4btoul(ccb12->alloc_length);
7064		data_len = sizeof(*data12);
7065	}
7066	if (alloc_len == 0) {
7067		ctl_set_success(ctsio);
7068		ctl_done((union ctl_io *)ctsio);
7069		return (CTL_RETVAL_COMPLETE);
7070	}
7071
7072	ctsio->kern_data_ptr = malloc(data_len, M_CTL, M_WAITOK | M_ZERO);
7073	if (data_len < alloc_len) {
7074		ctsio->residual = alloc_len - data_len;
7075		ctsio->kern_data_len = data_len;
7076		ctsio->kern_total_len = data_len;
7077	} else {
7078		ctsio->residual = 0;
7079		ctsio->kern_data_len = alloc_len;
7080		ctsio->kern_total_len = alloc_len;
7081	}
7082	ctsio->kern_data_resid = 0;
7083	ctsio->kern_rel_offset = 0;
7084	ctsio->kern_sg_entries = 0;
7085
7086	if (ctsio->cdb[0] == READ_DEFECT_DATA_10) {
7087		data10 = (struct scsi_read_defect_data_hdr_10 *)
7088		    ctsio->kern_data_ptr;
7089		data10->format = format;
7090		scsi_ulto2b(0, data10->length);
7091	} else {
7092		data12 = (struct scsi_read_defect_data_hdr_12 *)
7093		    ctsio->kern_data_ptr;
7094		data12->format = format;
7095		scsi_ulto2b(0, data12->generation);
7096		scsi_ulto4b(0, data12->length);
7097	}
7098
7099	ctl_set_success(ctsio);
7100	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
7101	ctsio->be_move_done = ctl_config_move_done;
7102	ctl_datamove((union ctl_io *)ctsio);
7103	return (CTL_RETVAL_COMPLETE);
7104}
7105
7106int
7107ctl_report_tagret_port_groups(struct ctl_scsiio *ctsio)
7108{
7109	struct scsi_maintenance_in *cdb;
7110	int retval;
7111	int alloc_len, ext, total_len = 0, g, pc, pg, ts, os;
7112	int num_ha_groups, num_target_ports, shared_group;
7113	struct ctl_lun *lun;
7114	struct ctl_softc *softc;
7115	struct ctl_port *port;
7116	struct scsi_target_group_data *rtg_ptr;
7117	struct scsi_target_group_data_extended *rtg_ext_ptr;
7118	struct scsi_target_port_group_descriptor *tpg_desc;
7119
7120	CTL_DEBUG_PRINT(("ctl_report_tagret_port_groups\n"));
7121
7122	cdb = (struct scsi_maintenance_in *)ctsio->cdb;
7123	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
7124	softc = lun->ctl_softc;
7125
7126	retval = CTL_RETVAL_COMPLETE;
7127
7128	switch (cdb->byte2 & STG_PDF_MASK) {
7129	case STG_PDF_LENGTH:
7130		ext = 0;
7131		break;
7132	case STG_PDF_EXTENDED:
7133		ext = 1;
7134		break;
7135	default:
7136		ctl_set_invalid_field(/*ctsio*/ ctsio,
7137				      /*sks_valid*/ 1,
7138				      /*command*/ 1,
7139				      /*field*/ 2,
7140				      /*bit_valid*/ 1,
7141				      /*bit*/ 5);
7142		ctl_done((union ctl_io *)ctsio);
7143		return(retval);
7144	}
7145
7146	num_target_ports = 0;
7147	shared_group = (softc->is_single != 0);
7148	mtx_lock(&softc->ctl_lock);
7149	STAILQ_FOREACH(port, &softc->port_list, links) {
7150		if ((port->status & CTL_PORT_STATUS_ONLINE) == 0)
7151			continue;
7152		if (ctl_lun_map_to_port(port, lun->lun) >= CTL_MAX_LUNS)
7153			continue;
7154		num_target_ports++;
7155		if (port->status & CTL_PORT_STATUS_HA_SHARED)
7156			shared_group = 1;
7157	}
7158	mtx_unlock(&softc->ctl_lock);
7159	num_ha_groups = (softc->is_single) ? 0 : NUM_HA_SHELVES;
7160
7161	if (ext)
7162		total_len = sizeof(struct scsi_target_group_data_extended);
7163	else
7164		total_len = sizeof(struct scsi_target_group_data);
7165	total_len += sizeof(struct scsi_target_port_group_descriptor) *
7166		(shared_group + num_ha_groups) +
7167	    sizeof(struct scsi_target_port_descriptor) * num_target_ports;
7168
7169	alloc_len = scsi_4btoul(cdb->length);
7170
7171	ctsio->kern_data_ptr = malloc(total_len, M_CTL, M_WAITOK | M_ZERO);
7172
7173	ctsio->kern_sg_entries = 0;
7174
7175	if (total_len < alloc_len) {
7176		ctsio->residual = alloc_len - total_len;
7177		ctsio->kern_data_len = total_len;
7178		ctsio->kern_total_len = total_len;
7179	} else {
7180		ctsio->residual = 0;
7181		ctsio->kern_data_len = alloc_len;
7182		ctsio->kern_total_len = alloc_len;
7183	}
7184	ctsio->kern_data_resid = 0;
7185	ctsio->kern_rel_offset = 0;
7186
7187	if (ext) {
7188		rtg_ext_ptr = (struct scsi_target_group_data_extended *)
7189		    ctsio->kern_data_ptr;
7190		scsi_ulto4b(total_len - 4, rtg_ext_ptr->length);
7191		rtg_ext_ptr->format_type = 0x10;
7192		rtg_ext_ptr->implicit_transition_time = 0;
7193		tpg_desc = &rtg_ext_ptr->groups[0];
7194	} else {
7195		rtg_ptr = (struct scsi_target_group_data *)
7196		    ctsio->kern_data_ptr;
7197		scsi_ulto4b(total_len - 4, rtg_ptr->length);
7198		tpg_desc = &rtg_ptr->groups[0];
7199	}
7200
7201	mtx_lock(&softc->ctl_lock);
7202	pg = softc->port_min / softc->port_cnt;
7203	if (lun->flags & (CTL_LUN_PRIMARY_SC | CTL_LUN_PEER_SC_PRIMARY)) {
7204		/* Some shelf is known to be primary. */
7205		if (softc->ha_link == CTL_HA_LINK_OFFLINE)
7206			os = TPG_ASYMMETRIC_ACCESS_UNAVAILABLE;
7207		else if (softc->ha_link == CTL_HA_LINK_UNKNOWN)
7208			os = TPG_ASYMMETRIC_ACCESS_TRANSITIONING;
7209		else if (softc->ha_mode == CTL_HA_MODE_ACT_STBY)
7210			os = TPG_ASYMMETRIC_ACCESS_STANDBY;
7211		else
7212			os = TPG_ASYMMETRIC_ACCESS_NONOPTIMIZED;
7213		if (lun->flags & CTL_LUN_PRIMARY_SC) {
7214			ts = TPG_ASYMMETRIC_ACCESS_OPTIMIZED;
7215		} else {
7216			ts = os;
7217			os = TPG_ASYMMETRIC_ACCESS_OPTIMIZED;
7218		}
7219	} else {
7220		/* No known primary shelf. */
7221		if (softc->ha_link == CTL_HA_LINK_OFFLINE) {
7222			ts = TPG_ASYMMETRIC_ACCESS_UNAVAILABLE;
7223			os = TPG_ASYMMETRIC_ACCESS_OPTIMIZED;
7224		} else if (softc->ha_link == CTL_HA_LINK_UNKNOWN) {
7225			ts = TPG_ASYMMETRIC_ACCESS_TRANSITIONING;
7226			os = TPG_ASYMMETRIC_ACCESS_OPTIMIZED;
7227		} else {
7228			ts = os = TPG_ASYMMETRIC_ACCESS_TRANSITIONING;
7229		}
7230	}
7231	if (shared_group) {
7232		tpg_desc->pref_state = ts;
7233		tpg_desc->support = TPG_AO_SUP | TPG_AN_SUP | TPG_S_SUP |
7234		    TPG_U_SUP | TPG_T_SUP;
7235		scsi_ulto2b(1, tpg_desc->target_port_group);
7236		tpg_desc->status = TPG_IMPLICIT;
7237		pc = 0;
7238		STAILQ_FOREACH(port, &softc->port_list, links) {
7239			if ((port->status & CTL_PORT_STATUS_ONLINE) == 0)
7240				continue;
7241			if (!softc->is_single &&
7242			    (port->status & CTL_PORT_STATUS_HA_SHARED) == 0)
7243				continue;
7244			if (ctl_lun_map_to_port(port, lun->lun) >= CTL_MAX_LUNS)
7245				continue;
7246			scsi_ulto2b(port->targ_port, tpg_desc->descriptors[pc].
7247			    relative_target_port_identifier);
7248			pc++;
7249		}
7250		tpg_desc->target_port_count = pc;
7251		tpg_desc = (struct scsi_target_port_group_descriptor *)
7252		    &tpg_desc->descriptors[pc];
7253	}
7254	for (g = 0; g < num_ha_groups; g++) {
7255		tpg_desc->pref_state = (g == pg) ? ts : os;
7256		tpg_desc->support = TPG_AO_SUP | TPG_AN_SUP | TPG_S_SUP |
7257		    TPG_U_SUP | TPG_T_SUP;
7258		scsi_ulto2b(2 + g, tpg_desc->target_port_group);
7259		tpg_desc->status = TPG_IMPLICIT;
7260		pc = 0;
7261		STAILQ_FOREACH(port, &softc->port_list, links) {
7262			if (port->targ_port < g * softc->port_cnt ||
7263			    port->targ_port >= (g + 1) * softc->port_cnt)
7264				continue;
7265			if ((port->status & CTL_PORT_STATUS_ONLINE) == 0)
7266				continue;
7267			if (port->status & CTL_PORT_STATUS_HA_SHARED)
7268				continue;
7269			if (ctl_lun_map_to_port(port, lun->lun) >= CTL_MAX_LUNS)
7270				continue;
7271			scsi_ulto2b(port->targ_port, tpg_desc->descriptors[pc].
7272			    relative_target_port_identifier);
7273			pc++;
7274		}
7275		tpg_desc->target_port_count = pc;
7276		tpg_desc = (struct scsi_target_port_group_descriptor *)
7277		    &tpg_desc->descriptors[pc];
7278	}
7279	mtx_unlock(&softc->ctl_lock);
7280
7281	ctl_set_success(ctsio);
7282	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
7283	ctsio->be_move_done = ctl_config_move_done;
7284	ctl_datamove((union ctl_io *)ctsio);
7285	return(retval);
7286}
7287
7288int
7289ctl_report_supported_opcodes(struct ctl_scsiio *ctsio)
7290{
7291	struct ctl_lun *lun;
7292	struct scsi_report_supported_opcodes *cdb;
7293	const struct ctl_cmd_entry *entry, *sentry;
7294	struct scsi_report_supported_opcodes_all *all;
7295	struct scsi_report_supported_opcodes_descr *descr;
7296	struct scsi_report_supported_opcodes_one *one;
7297	int retval;
7298	int alloc_len, total_len;
7299	int opcode, service_action, i, j, num;
7300
7301	CTL_DEBUG_PRINT(("ctl_report_supported_opcodes\n"));
7302
7303	cdb = (struct scsi_report_supported_opcodes *)ctsio->cdb;
7304	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
7305
7306	retval = CTL_RETVAL_COMPLETE;
7307
7308	opcode = cdb->requested_opcode;
7309	service_action = scsi_2btoul(cdb->requested_service_action);
7310	switch (cdb->options & RSO_OPTIONS_MASK) {
7311	case RSO_OPTIONS_ALL:
7312		num = 0;
7313		for (i = 0; i < 256; i++) {
7314			entry = &ctl_cmd_table[i];
7315			if (entry->flags & CTL_CMD_FLAG_SA5) {
7316				for (j = 0; j < 32; j++) {
7317					sentry = &((const struct ctl_cmd_entry *)
7318					    entry->execute)[j];
7319					if (ctl_cmd_applicable(
7320					    lun->be_lun->lun_type, sentry))
7321						num++;
7322				}
7323			} else {
7324				if (ctl_cmd_applicable(lun->be_lun->lun_type,
7325				    entry))
7326					num++;
7327			}
7328		}
7329		total_len = sizeof(struct scsi_report_supported_opcodes_all) +
7330		    num * sizeof(struct scsi_report_supported_opcodes_descr);
7331		break;
7332	case RSO_OPTIONS_OC:
7333		if (ctl_cmd_table[opcode].flags & CTL_CMD_FLAG_SA5) {
7334			ctl_set_invalid_field(/*ctsio*/ ctsio,
7335					      /*sks_valid*/ 1,
7336					      /*command*/ 1,
7337					      /*field*/ 2,
7338					      /*bit_valid*/ 1,
7339					      /*bit*/ 2);
7340			ctl_done((union ctl_io *)ctsio);
7341			return (CTL_RETVAL_COMPLETE);
7342		}
7343		total_len = sizeof(struct scsi_report_supported_opcodes_one) + 32;
7344		break;
7345	case RSO_OPTIONS_OC_SA:
7346		if ((ctl_cmd_table[opcode].flags & CTL_CMD_FLAG_SA5) == 0 ||
7347		    service_action >= 32) {
7348			ctl_set_invalid_field(/*ctsio*/ ctsio,
7349					      /*sks_valid*/ 1,
7350					      /*command*/ 1,
7351					      /*field*/ 2,
7352					      /*bit_valid*/ 1,
7353					      /*bit*/ 2);
7354			ctl_done((union ctl_io *)ctsio);
7355			return (CTL_RETVAL_COMPLETE);
7356		}
7357		total_len = sizeof(struct scsi_report_supported_opcodes_one) + 32;
7358		break;
7359	default:
7360		ctl_set_invalid_field(/*ctsio*/ ctsio,
7361				      /*sks_valid*/ 1,
7362				      /*command*/ 1,
7363				      /*field*/ 2,
7364				      /*bit_valid*/ 1,
7365				      /*bit*/ 2);
7366		ctl_done((union ctl_io *)ctsio);
7367		return (CTL_RETVAL_COMPLETE);
7368	}
7369
7370	alloc_len = scsi_4btoul(cdb->length);
7371
7372	ctsio->kern_data_ptr = malloc(total_len, M_CTL, M_WAITOK | M_ZERO);
7373
7374	ctsio->kern_sg_entries = 0;
7375
7376	if (total_len < alloc_len) {
7377		ctsio->residual = alloc_len - total_len;
7378		ctsio->kern_data_len = total_len;
7379		ctsio->kern_total_len = total_len;
7380	} else {
7381		ctsio->residual = 0;
7382		ctsio->kern_data_len = alloc_len;
7383		ctsio->kern_total_len = alloc_len;
7384	}
7385	ctsio->kern_data_resid = 0;
7386	ctsio->kern_rel_offset = 0;
7387
7388	switch (cdb->options & RSO_OPTIONS_MASK) {
7389	case RSO_OPTIONS_ALL:
7390		all = (struct scsi_report_supported_opcodes_all *)
7391		    ctsio->kern_data_ptr;
7392		num = 0;
7393		for (i = 0; i < 256; i++) {
7394			entry = &ctl_cmd_table[i];
7395			if (entry->flags & CTL_CMD_FLAG_SA5) {
7396				for (j = 0; j < 32; j++) {
7397					sentry = &((const struct ctl_cmd_entry *)
7398					    entry->execute)[j];
7399					if (!ctl_cmd_applicable(
7400					    lun->be_lun->lun_type, sentry))
7401						continue;
7402					descr = &all->descr[num++];
7403					descr->opcode = i;
7404					scsi_ulto2b(j, descr->service_action);
7405					descr->flags = RSO_SERVACTV;
7406					scsi_ulto2b(sentry->length,
7407					    descr->cdb_length);
7408				}
7409			} else {
7410				if (!ctl_cmd_applicable(lun->be_lun->lun_type,
7411				    entry))
7412					continue;
7413				descr = &all->descr[num++];
7414				descr->opcode = i;
7415				scsi_ulto2b(0, descr->service_action);
7416				descr->flags = 0;
7417				scsi_ulto2b(entry->length, descr->cdb_length);
7418			}
7419		}
7420		scsi_ulto4b(
7421		    num * sizeof(struct scsi_report_supported_opcodes_descr),
7422		    all->length);
7423		break;
7424	case RSO_OPTIONS_OC:
7425		one = (struct scsi_report_supported_opcodes_one *)
7426		    ctsio->kern_data_ptr;
7427		entry = &ctl_cmd_table[opcode];
7428		goto fill_one;
7429	case RSO_OPTIONS_OC_SA:
7430		one = (struct scsi_report_supported_opcodes_one *)
7431		    ctsio->kern_data_ptr;
7432		entry = &ctl_cmd_table[opcode];
7433		entry = &((const struct ctl_cmd_entry *)
7434		    entry->execute)[service_action];
7435fill_one:
7436		if (ctl_cmd_applicable(lun->be_lun->lun_type, entry)) {
7437			one->support = 3;
7438			scsi_ulto2b(entry->length, one->cdb_length);
7439			one->cdb_usage[0] = opcode;
7440			memcpy(&one->cdb_usage[1], entry->usage,
7441			    entry->length - 1);
7442		} else
7443			one->support = 1;
7444		break;
7445	}
7446
7447	ctl_set_success(ctsio);
7448	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
7449	ctsio->be_move_done = ctl_config_move_done;
7450	ctl_datamove((union ctl_io *)ctsio);
7451	return(retval);
7452}
7453
7454int
7455ctl_report_supported_tmf(struct ctl_scsiio *ctsio)
7456{
7457	struct scsi_report_supported_tmf *cdb;
7458	struct scsi_report_supported_tmf_data *data;
7459	int retval;
7460	int alloc_len, total_len;
7461
7462	CTL_DEBUG_PRINT(("ctl_report_supported_tmf\n"));
7463
7464	cdb = (struct scsi_report_supported_tmf *)ctsio->cdb;
7465
7466	retval = CTL_RETVAL_COMPLETE;
7467
7468	total_len = sizeof(struct scsi_report_supported_tmf_data);
7469	alloc_len = scsi_4btoul(cdb->length);
7470
7471	ctsio->kern_data_ptr = malloc(total_len, M_CTL, M_WAITOK | M_ZERO);
7472
7473	ctsio->kern_sg_entries = 0;
7474
7475	if (total_len < alloc_len) {
7476		ctsio->residual = alloc_len - total_len;
7477		ctsio->kern_data_len = total_len;
7478		ctsio->kern_total_len = total_len;
7479	} else {
7480		ctsio->residual = 0;
7481		ctsio->kern_data_len = alloc_len;
7482		ctsio->kern_total_len = alloc_len;
7483	}
7484	ctsio->kern_data_resid = 0;
7485	ctsio->kern_rel_offset = 0;
7486
7487	data = (struct scsi_report_supported_tmf_data *)ctsio->kern_data_ptr;
7488	data->byte1 |= RST_ATS | RST_ATSS | RST_CTSS | RST_LURS | RST_QTS |
7489	    RST_TRS;
7490	data->byte2 |= RST_QAES | RST_QTSS | RST_ITNRS;
7491
7492	ctl_set_success(ctsio);
7493	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
7494	ctsio->be_move_done = ctl_config_move_done;
7495	ctl_datamove((union ctl_io *)ctsio);
7496	return (retval);
7497}
7498
7499int
7500ctl_report_timestamp(struct ctl_scsiio *ctsio)
7501{
7502	struct scsi_report_timestamp *cdb;
7503	struct scsi_report_timestamp_data *data;
7504	struct timeval tv;
7505	int64_t timestamp;
7506	int retval;
7507	int alloc_len, total_len;
7508
7509	CTL_DEBUG_PRINT(("ctl_report_timestamp\n"));
7510
7511	cdb = (struct scsi_report_timestamp *)ctsio->cdb;
7512
7513	retval = CTL_RETVAL_COMPLETE;
7514
7515	total_len = sizeof(struct scsi_report_timestamp_data);
7516	alloc_len = scsi_4btoul(cdb->length);
7517
7518	ctsio->kern_data_ptr = malloc(total_len, M_CTL, M_WAITOK | M_ZERO);
7519
7520	ctsio->kern_sg_entries = 0;
7521
7522	if (total_len < alloc_len) {
7523		ctsio->residual = alloc_len - total_len;
7524		ctsio->kern_data_len = total_len;
7525		ctsio->kern_total_len = total_len;
7526	} else {
7527		ctsio->residual = 0;
7528		ctsio->kern_data_len = alloc_len;
7529		ctsio->kern_total_len = alloc_len;
7530	}
7531	ctsio->kern_data_resid = 0;
7532	ctsio->kern_rel_offset = 0;
7533
7534	data = (struct scsi_report_timestamp_data *)ctsio->kern_data_ptr;
7535	scsi_ulto2b(sizeof(*data) - 2, data->length);
7536	data->origin = RTS_ORIG_OUTSIDE;
7537	getmicrotime(&tv);
7538	timestamp = (int64_t)tv.tv_sec * 1000 + tv.tv_usec / 1000;
7539	scsi_ulto4b(timestamp >> 16, data->timestamp);
7540	scsi_ulto2b(timestamp & 0xffff, &data->timestamp[4]);
7541
7542	ctl_set_success(ctsio);
7543	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
7544	ctsio->be_move_done = ctl_config_move_done;
7545	ctl_datamove((union ctl_io *)ctsio);
7546	return (retval);
7547}
7548
7549int
7550ctl_persistent_reserve_in(struct ctl_scsiio *ctsio)
7551{
7552	struct scsi_per_res_in *cdb;
7553	int alloc_len, total_len = 0;
7554	/* struct scsi_per_res_in_rsrv in_data; */
7555	struct ctl_lun *lun;
7556	struct ctl_softc *softc;
7557	uint64_t key;
7558
7559	CTL_DEBUG_PRINT(("ctl_persistent_reserve_in\n"));
7560
7561	cdb = (struct scsi_per_res_in *)ctsio->cdb;
7562
7563	alloc_len = scsi_2btoul(cdb->length);
7564
7565	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
7566	softc = lun->ctl_softc;
7567
7568retry:
7569	mtx_lock(&lun->lun_lock);
7570	switch (cdb->action) {
7571	case SPRI_RK: /* read keys */
7572		total_len = sizeof(struct scsi_per_res_in_keys) +
7573			lun->pr_key_count *
7574			sizeof(struct scsi_per_res_key);
7575		break;
7576	case SPRI_RR: /* read reservation */
7577		if (lun->flags & CTL_LUN_PR_RESERVED)
7578			total_len = sizeof(struct scsi_per_res_in_rsrv);
7579		else
7580			total_len = sizeof(struct scsi_per_res_in_header);
7581		break;
7582	case SPRI_RC: /* report capabilities */
7583		total_len = sizeof(struct scsi_per_res_cap);
7584		break;
7585	case SPRI_RS: /* read full status */
7586		total_len = sizeof(struct scsi_per_res_in_header) +
7587		    (sizeof(struct scsi_per_res_in_full_desc) + 256) *
7588		    lun->pr_key_count;
7589		break;
7590	default:
7591		panic("%s: Invalid PR type %#x", __func__, cdb->action);
7592	}
7593	mtx_unlock(&lun->lun_lock);
7594
7595	ctsio->kern_data_ptr = malloc(total_len, M_CTL, M_WAITOK | M_ZERO);
7596
7597	if (total_len < alloc_len) {
7598		ctsio->residual = alloc_len - total_len;
7599		ctsio->kern_data_len = total_len;
7600		ctsio->kern_total_len = total_len;
7601	} else {
7602		ctsio->residual = 0;
7603		ctsio->kern_data_len = alloc_len;
7604		ctsio->kern_total_len = alloc_len;
7605	}
7606
7607	ctsio->kern_data_resid = 0;
7608	ctsio->kern_rel_offset = 0;
7609	ctsio->kern_sg_entries = 0;
7610
7611	mtx_lock(&lun->lun_lock);
7612	switch (cdb->action) {
7613	case SPRI_RK: { // read keys
7614        struct scsi_per_res_in_keys *res_keys;
7615		int i, key_count;
7616
7617		res_keys = (struct scsi_per_res_in_keys*)ctsio->kern_data_ptr;
7618
7619		/*
7620		 * We had to drop the lock to allocate our buffer, which
7621		 * leaves time for someone to come in with another
7622		 * persistent reservation.  (That is unlikely, though,
7623		 * since this should be the only persistent reservation
7624		 * command active right now.)
7625		 */
7626		if (total_len != (sizeof(struct scsi_per_res_in_keys) +
7627		    (lun->pr_key_count *
7628		     sizeof(struct scsi_per_res_key)))){
7629			mtx_unlock(&lun->lun_lock);
7630			free(ctsio->kern_data_ptr, M_CTL);
7631			printf("%s: reservation length changed, retrying\n",
7632			       __func__);
7633			goto retry;
7634		}
7635
7636		scsi_ulto4b(lun->pr_generation, res_keys->header.generation);
7637
7638		scsi_ulto4b(sizeof(struct scsi_per_res_key) *
7639			     lun->pr_key_count, res_keys->header.length);
7640
7641		for (i = 0, key_count = 0; i < CTL_MAX_INITIATORS; i++) {
7642			if ((key = ctl_get_prkey(lun, i)) == 0)
7643				continue;
7644
7645			/*
7646			 * We used lun->pr_key_count to calculate the
7647			 * size to allocate.  If it turns out the number of
7648			 * initiators with the registered flag set is
7649			 * larger than that (i.e. they haven't been kept in
7650			 * sync), we've got a problem.
7651			 */
7652			if (key_count >= lun->pr_key_count) {
7653				key_count++;
7654				continue;
7655			}
7656			scsi_u64to8b(key, res_keys->keys[key_count].key);
7657			key_count++;
7658		}
7659		break;
7660	}
7661	case SPRI_RR: { // read reservation
7662		struct scsi_per_res_in_rsrv *res;
7663		int tmp_len, header_only;
7664
7665		res = (struct scsi_per_res_in_rsrv *)ctsio->kern_data_ptr;
7666
7667		scsi_ulto4b(lun->pr_generation, res->header.generation);
7668
7669		if (lun->flags & CTL_LUN_PR_RESERVED)
7670		{
7671			tmp_len = sizeof(struct scsi_per_res_in_rsrv);
7672			scsi_ulto4b(sizeof(struct scsi_per_res_in_rsrv_data),
7673				    res->header.length);
7674			header_only = 0;
7675		} else {
7676			tmp_len = sizeof(struct scsi_per_res_in_header);
7677			scsi_ulto4b(0, res->header.length);
7678			header_only = 1;
7679		}
7680
7681		/*
7682		 * We had to drop the lock to allocate our buffer, which
7683		 * leaves time for someone to come in with another
7684		 * persistent reservation.  (That is unlikely, though,
7685		 * since this should be the only persistent reservation
7686		 * command active right now.)
7687		 */
7688		if (tmp_len != total_len) {
7689			mtx_unlock(&lun->lun_lock);
7690			free(ctsio->kern_data_ptr, M_CTL);
7691			printf("%s: reservation status changed, retrying\n",
7692			       __func__);
7693			goto retry;
7694		}
7695
7696		/*
7697		 * No reservation held, so we're done.
7698		 */
7699		if (header_only != 0)
7700			break;
7701
7702		/*
7703		 * If the registration is an All Registrants type, the key
7704		 * is 0, since it doesn't really matter.
7705		 */
7706		if (lun->pr_res_idx != CTL_PR_ALL_REGISTRANTS) {
7707			scsi_u64to8b(ctl_get_prkey(lun, lun->pr_res_idx),
7708			    res->data.reservation);
7709		}
7710		res->data.scopetype = lun->pr_res_type;
7711		break;
7712	}
7713	case SPRI_RC:     //report capabilities
7714	{
7715		struct scsi_per_res_cap *res_cap;
7716		uint16_t type_mask;
7717
7718		res_cap = (struct scsi_per_res_cap *)ctsio->kern_data_ptr;
7719		scsi_ulto2b(sizeof(*res_cap), res_cap->length);
7720		res_cap->flags1 = SPRI_CRH;
7721		res_cap->flags2 = SPRI_TMV | SPRI_ALLOW_5;
7722		type_mask = SPRI_TM_WR_EX_AR |
7723			    SPRI_TM_EX_AC_RO |
7724			    SPRI_TM_WR_EX_RO |
7725			    SPRI_TM_EX_AC |
7726			    SPRI_TM_WR_EX |
7727			    SPRI_TM_EX_AC_AR;
7728		scsi_ulto2b(type_mask, res_cap->type_mask);
7729		break;
7730	}
7731	case SPRI_RS: { // read full status
7732		struct scsi_per_res_in_full *res_status;
7733		struct scsi_per_res_in_full_desc *res_desc;
7734		struct ctl_port *port;
7735		int i, len;
7736
7737		res_status = (struct scsi_per_res_in_full*)ctsio->kern_data_ptr;
7738
7739		/*
7740		 * We had to drop the lock to allocate our buffer, which
7741		 * leaves time for someone to come in with another
7742		 * persistent reservation.  (That is unlikely, though,
7743		 * since this should be the only persistent reservation
7744		 * command active right now.)
7745		 */
7746		if (total_len < (sizeof(struct scsi_per_res_in_header) +
7747		    (sizeof(struct scsi_per_res_in_full_desc) + 256) *
7748		     lun->pr_key_count)){
7749			mtx_unlock(&lun->lun_lock);
7750			free(ctsio->kern_data_ptr, M_CTL);
7751			printf("%s: reservation length changed, retrying\n",
7752			       __func__);
7753			goto retry;
7754		}
7755
7756		scsi_ulto4b(lun->pr_generation, res_status->header.generation);
7757
7758		res_desc = &res_status->desc[0];
7759		for (i = 0; i < CTL_MAX_INITIATORS; i++) {
7760			if ((key = ctl_get_prkey(lun, i)) == 0)
7761				continue;
7762
7763			scsi_u64to8b(key, res_desc->res_key.key);
7764			if ((lun->flags & CTL_LUN_PR_RESERVED) &&
7765			    (lun->pr_res_idx == i ||
7766			     lun->pr_res_idx == CTL_PR_ALL_REGISTRANTS)) {
7767				res_desc->flags = SPRI_FULL_R_HOLDER;
7768				res_desc->scopetype = lun->pr_res_type;
7769			}
7770			scsi_ulto2b(i / CTL_MAX_INIT_PER_PORT,
7771			    res_desc->rel_trgt_port_id);
7772			len = 0;
7773			port = softc->ctl_ports[i / CTL_MAX_INIT_PER_PORT];
7774			if (port != NULL)
7775				len = ctl_create_iid(port,
7776				    i % CTL_MAX_INIT_PER_PORT,
7777				    res_desc->transport_id);
7778			scsi_ulto4b(len, res_desc->additional_length);
7779			res_desc = (struct scsi_per_res_in_full_desc *)
7780			    &res_desc->transport_id[len];
7781		}
7782		scsi_ulto4b((uint8_t *)res_desc - (uint8_t *)&res_status->desc[0],
7783		    res_status->header.length);
7784		break;
7785	}
7786	default:
7787		panic("%s: Invalid PR type %#x", __func__, cdb->action);
7788	}
7789	mtx_unlock(&lun->lun_lock);
7790
7791	ctl_set_success(ctsio);
7792	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
7793	ctsio->be_move_done = ctl_config_move_done;
7794	ctl_datamove((union ctl_io *)ctsio);
7795	return (CTL_RETVAL_COMPLETE);
7796}
7797
7798/*
7799 * Returns 0 if ctl_persistent_reserve_out() should continue, non-zero if
7800 * it should return.
7801 */
7802static int
7803ctl_pro_preempt(struct ctl_softc *softc, struct ctl_lun *lun, uint64_t res_key,
7804		uint64_t sa_res_key, uint8_t type, uint32_t residx,
7805		struct ctl_scsiio *ctsio, struct scsi_per_res_out *cdb,
7806		struct scsi_per_res_out_parms* param)
7807{
7808	union ctl_ha_msg persis_io;
7809	int i;
7810
7811	mtx_lock(&lun->lun_lock);
7812	if (sa_res_key == 0) {
7813		if (lun->pr_res_idx == CTL_PR_ALL_REGISTRANTS) {
7814			/* validate scope and type */
7815			if ((cdb->scope_type & SPR_SCOPE_MASK) !=
7816			     SPR_LU_SCOPE) {
7817				mtx_unlock(&lun->lun_lock);
7818				ctl_set_invalid_field(/*ctsio*/ ctsio,
7819						      /*sks_valid*/ 1,
7820						      /*command*/ 1,
7821						      /*field*/ 2,
7822						      /*bit_valid*/ 1,
7823						      /*bit*/ 4);
7824				ctl_done((union ctl_io *)ctsio);
7825				return (1);
7826			}
7827
7828		        if (type>8 || type==2 || type==4 || type==0) {
7829				mtx_unlock(&lun->lun_lock);
7830				ctl_set_invalid_field(/*ctsio*/ ctsio,
7831       	           				      /*sks_valid*/ 1,
7832						      /*command*/ 1,
7833						      /*field*/ 2,
7834						      /*bit_valid*/ 1,
7835						      /*bit*/ 0);
7836				ctl_done((union ctl_io *)ctsio);
7837				return (1);
7838		        }
7839
7840			/*
7841			 * Unregister everybody else and build UA for
7842			 * them
7843			 */
7844			for(i = 0; i < CTL_MAX_INITIATORS; i++) {
7845				if (i == residx || ctl_get_prkey(lun, i) == 0)
7846					continue;
7847
7848				ctl_clr_prkey(lun, i);
7849				ctl_est_ua(lun, i, CTL_UA_REG_PREEMPT);
7850			}
7851			lun->pr_key_count = 1;
7852			lun->pr_res_type = type;
7853			if (lun->pr_res_type != SPR_TYPE_WR_EX_AR &&
7854			    lun->pr_res_type != SPR_TYPE_EX_AC_AR)
7855				lun->pr_res_idx = residx;
7856			lun->pr_generation++;
7857			mtx_unlock(&lun->lun_lock);
7858
7859			/* send msg to other side */
7860			persis_io.hdr.nexus = ctsio->io_hdr.nexus;
7861			persis_io.hdr.msg_type = CTL_MSG_PERS_ACTION;
7862			persis_io.pr.pr_info.action = CTL_PR_PREEMPT;
7863			persis_io.pr.pr_info.residx = lun->pr_res_idx;
7864			persis_io.pr.pr_info.res_type = type;
7865			memcpy(persis_io.pr.pr_info.sa_res_key,
7866			       param->serv_act_res_key,
7867			       sizeof(param->serv_act_res_key));
7868			ctl_ha_msg_send(CTL_HA_CHAN_CTL, &persis_io,
7869			    sizeof(persis_io.pr), M_WAITOK);
7870		} else {
7871			/* not all registrants */
7872			mtx_unlock(&lun->lun_lock);
7873			free(ctsio->kern_data_ptr, M_CTL);
7874			ctl_set_invalid_field(ctsio,
7875					      /*sks_valid*/ 1,
7876					      /*command*/ 0,
7877					      /*field*/ 8,
7878					      /*bit_valid*/ 0,
7879					      /*bit*/ 0);
7880			ctl_done((union ctl_io *)ctsio);
7881			return (1);
7882		}
7883	} else if (lun->pr_res_idx == CTL_PR_ALL_REGISTRANTS
7884		|| !(lun->flags & CTL_LUN_PR_RESERVED)) {
7885		int found = 0;
7886
7887		if (res_key == sa_res_key) {
7888			/* special case */
7889			/*
7890			 * The spec implies this is not good but doesn't
7891			 * say what to do. There are two choices either
7892			 * generate a res conflict or check condition
7893			 * with illegal field in parameter data. Since
7894			 * that is what is done when the sa_res_key is
7895			 * zero I'll take that approach since this has
7896			 * to do with the sa_res_key.
7897			 */
7898			mtx_unlock(&lun->lun_lock);
7899			free(ctsio->kern_data_ptr, M_CTL);
7900			ctl_set_invalid_field(ctsio,
7901					      /*sks_valid*/ 1,
7902					      /*command*/ 0,
7903					      /*field*/ 8,
7904					      /*bit_valid*/ 0,
7905					      /*bit*/ 0);
7906			ctl_done((union ctl_io *)ctsio);
7907			return (1);
7908		}
7909
7910		for (i = 0; i < CTL_MAX_INITIATORS; i++) {
7911			if (ctl_get_prkey(lun, i) != sa_res_key)
7912				continue;
7913
7914			found = 1;
7915			ctl_clr_prkey(lun, i);
7916			lun->pr_key_count--;
7917			ctl_est_ua(lun, i, CTL_UA_REG_PREEMPT);
7918		}
7919		if (!found) {
7920			mtx_unlock(&lun->lun_lock);
7921			free(ctsio->kern_data_ptr, M_CTL);
7922			ctl_set_reservation_conflict(ctsio);
7923			ctl_done((union ctl_io *)ctsio);
7924			return (CTL_RETVAL_COMPLETE);
7925		}
7926		lun->pr_generation++;
7927		mtx_unlock(&lun->lun_lock);
7928
7929		/* send msg to other side */
7930		persis_io.hdr.nexus = ctsio->io_hdr.nexus;
7931		persis_io.hdr.msg_type = CTL_MSG_PERS_ACTION;
7932		persis_io.pr.pr_info.action = CTL_PR_PREEMPT;
7933		persis_io.pr.pr_info.residx = lun->pr_res_idx;
7934		persis_io.pr.pr_info.res_type = type;
7935		memcpy(persis_io.pr.pr_info.sa_res_key,
7936		       param->serv_act_res_key,
7937		       sizeof(param->serv_act_res_key));
7938		ctl_ha_msg_send(CTL_HA_CHAN_CTL, &persis_io,
7939		    sizeof(persis_io.pr), M_WAITOK);
7940	} else {
7941		/* Reserved but not all registrants */
7942		/* sa_res_key is res holder */
7943		if (sa_res_key == ctl_get_prkey(lun, lun->pr_res_idx)) {
7944			/* validate scope and type */
7945			if ((cdb->scope_type & SPR_SCOPE_MASK) !=
7946			     SPR_LU_SCOPE) {
7947				mtx_unlock(&lun->lun_lock);
7948				ctl_set_invalid_field(/*ctsio*/ ctsio,
7949						      /*sks_valid*/ 1,
7950						      /*command*/ 1,
7951						      /*field*/ 2,
7952						      /*bit_valid*/ 1,
7953						      /*bit*/ 4);
7954				ctl_done((union ctl_io *)ctsio);
7955				return (1);
7956			}
7957
7958			if (type>8 || type==2 || type==4 || type==0) {
7959				mtx_unlock(&lun->lun_lock);
7960				ctl_set_invalid_field(/*ctsio*/ ctsio,
7961						      /*sks_valid*/ 1,
7962						      /*command*/ 1,
7963						      /*field*/ 2,
7964						      /*bit_valid*/ 1,
7965						      /*bit*/ 0);
7966				ctl_done((union ctl_io *)ctsio);
7967				return (1);
7968			}
7969
7970			/*
7971			 * Do the following:
7972			 * if sa_res_key != res_key remove all
7973			 * registrants w/sa_res_key and generate UA
7974			 * for these registrants(Registrations
7975			 * Preempted) if it wasn't an exclusive
7976			 * reservation generate UA(Reservations
7977			 * Preempted) for all other registered nexuses
7978			 * if the type has changed. Establish the new
7979			 * reservation and holder. If res_key and
7980			 * sa_res_key are the same do the above
7981			 * except don't unregister the res holder.
7982			 */
7983
7984			for(i = 0; i < CTL_MAX_INITIATORS; i++) {
7985				if (i == residx || ctl_get_prkey(lun, i) == 0)
7986					continue;
7987
7988				if (sa_res_key == ctl_get_prkey(lun, i)) {
7989					ctl_clr_prkey(lun, i);
7990					lun->pr_key_count--;
7991					ctl_est_ua(lun, i, CTL_UA_REG_PREEMPT);
7992				} else if (type != lun->pr_res_type &&
7993				    (lun->pr_res_type == SPR_TYPE_WR_EX_RO ||
7994				     lun->pr_res_type == SPR_TYPE_EX_AC_RO)) {
7995					ctl_est_ua(lun, i, CTL_UA_RES_RELEASE);
7996				}
7997			}
7998			lun->pr_res_type = type;
7999			if (lun->pr_res_type != SPR_TYPE_WR_EX_AR &&
8000			    lun->pr_res_type != SPR_TYPE_EX_AC_AR)
8001				lun->pr_res_idx = residx;
8002			else
8003				lun->pr_res_idx = CTL_PR_ALL_REGISTRANTS;
8004			lun->pr_generation++;
8005			mtx_unlock(&lun->lun_lock);
8006
8007			persis_io.hdr.nexus = ctsio->io_hdr.nexus;
8008			persis_io.hdr.msg_type = CTL_MSG_PERS_ACTION;
8009			persis_io.pr.pr_info.action = CTL_PR_PREEMPT;
8010			persis_io.pr.pr_info.residx = lun->pr_res_idx;
8011			persis_io.pr.pr_info.res_type = type;
8012			memcpy(persis_io.pr.pr_info.sa_res_key,
8013			       param->serv_act_res_key,
8014			       sizeof(param->serv_act_res_key));
8015			ctl_ha_msg_send(CTL_HA_CHAN_CTL, &persis_io,
8016			    sizeof(persis_io.pr), M_WAITOK);
8017		} else {
8018			/*
8019			 * sa_res_key is not the res holder just
8020			 * remove registrants
8021			 */
8022			int found=0;
8023
8024			for (i = 0; i < CTL_MAX_INITIATORS; i++) {
8025				if (sa_res_key != ctl_get_prkey(lun, i))
8026					continue;
8027
8028				found = 1;
8029				ctl_clr_prkey(lun, i);
8030				lun->pr_key_count--;
8031				ctl_est_ua(lun, i, CTL_UA_REG_PREEMPT);
8032			}
8033
8034			if (!found) {
8035				mtx_unlock(&lun->lun_lock);
8036				free(ctsio->kern_data_ptr, M_CTL);
8037				ctl_set_reservation_conflict(ctsio);
8038				ctl_done((union ctl_io *)ctsio);
8039		        	return (1);
8040			}
8041			lun->pr_generation++;
8042			mtx_unlock(&lun->lun_lock);
8043
8044			persis_io.hdr.nexus = ctsio->io_hdr.nexus;
8045			persis_io.hdr.msg_type = CTL_MSG_PERS_ACTION;
8046			persis_io.pr.pr_info.action = CTL_PR_PREEMPT;
8047			persis_io.pr.pr_info.residx = lun->pr_res_idx;
8048			persis_io.pr.pr_info.res_type = type;
8049			memcpy(persis_io.pr.pr_info.sa_res_key,
8050			       param->serv_act_res_key,
8051			       sizeof(param->serv_act_res_key));
8052			ctl_ha_msg_send(CTL_HA_CHAN_CTL, &persis_io,
8053			    sizeof(persis_io.pr), M_WAITOK);
8054		}
8055	}
8056	return (0);
8057}
8058
8059static void
8060ctl_pro_preempt_other(struct ctl_lun *lun, union ctl_ha_msg *msg)
8061{
8062	uint64_t sa_res_key;
8063	int i;
8064
8065	sa_res_key = scsi_8btou64(msg->pr.pr_info.sa_res_key);
8066
8067	if (lun->pr_res_idx == CTL_PR_ALL_REGISTRANTS
8068	 || lun->pr_res_idx == CTL_PR_NO_RESERVATION
8069	 || sa_res_key != ctl_get_prkey(lun, lun->pr_res_idx)) {
8070		if (sa_res_key == 0) {
8071			/*
8072			 * Unregister everybody else and build UA for
8073			 * them
8074			 */
8075			for(i = 0; i < CTL_MAX_INITIATORS; i++) {
8076				if (i == msg->pr.pr_info.residx ||
8077				    ctl_get_prkey(lun, i) == 0)
8078					continue;
8079
8080				ctl_clr_prkey(lun, i);
8081				ctl_est_ua(lun, i, CTL_UA_REG_PREEMPT);
8082			}
8083
8084			lun->pr_key_count = 1;
8085			lun->pr_res_type = msg->pr.pr_info.res_type;
8086			if (lun->pr_res_type != SPR_TYPE_WR_EX_AR &&
8087			    lun->pr_res_type != SPR_TYPE_EX_AC_AR)
8088				lun->pr_res_idx = msg->pr.pr_info.residx;
8089		} else {
8090		        for (i = 0; i < CTL_MAX_INITIATORS; i++) {
8091				if (sa_res_key == ctl_get_prkey(lun, i))
8092					continue;
8093
8094				ctl_clr_prkey(lun, i);
8095				lun->pr_key_count--;
8096				ctl_est_ua(lun, i, CTL_UA_REG_PREEMPT);
8097			}
8098		}
8099	} else {
8100		for (i = 0; i < CTL_MAX_INITIATORS; i++) {
8101			if (i == msg->pr.pr_info.residx ||
8102			    ctl_get_prkey(lun, i) == 0)
8103				continue;
8104
8105			if (sa_res_key == ctl_get_prkey(lun, i)) {
8106				ctl_clr_prkey(lun, i);
8107				lun->pr_key_count--;
8108				ctl_est_ua(lun, i, CTL_UA_REG_PREEMPT);
8109			} else if (msg->pr.pr_info.res_type != lun->pr_res_type
8110			    && (lun->pr_res_type == SPR_TYPE_WR_EX_RO ||
8111			     lun->pr_res_type == SPR_TYPE_EX_AC_RO)) {
8112				ctl_est_ua(lun, i, CTL_UA_RES_RELEASE);
8113			}
8114		}
8115		lun->pr_res_type = msg->pr.pr_info.res_type;
8116		if (lun->pr_res_type != SPR_TYPE_WR_EX_AR &&
8117		    lun->pr_res_type != SPR_TYPE_EX_AC_AR)
8118			lun->pr_res_idx = msg->pr.pr_info.residx;
8119		else
8120			lun->pr_res_idx = CTL_PR_ALL_REGISTRANTS;
8121	}
8122	lun->pr_generation++;
8123
8124}
8125
8126
8127int
8128ctl_persistent_reserve_out(struct ctl_scsiio *ctsio)
8129{
8130	int retval;
8131	u_int32_t param_len;
8132	struct scsi_per_res_out *cdb;
8133	struct ctl_lun *lun;
8134	struct scsi_per_res_out_parms* param;
8135	struct ctl_softc *softc;
8136	uint32_t residx;
8137	uint64_t res_key, sa_res_key, key;
8138	uint8_t type;
8139	union ctl_ha_msg persis_io;
8140	int    i;
8141
8142	CTL_DEBUG_PRINT(("ctl_persistent_reserve_out\n"));
8143
8144	retval = CTL_RETVAL_COMPLETE;
8145
8146	cdb = (struct scsi_per_res_out *)ctsio->cdb;
8147	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
8148	softc = lun->ctl_softc;
8149
8150	/*
8151	 * We only support whole-LUN scope.  The scope & type are ignored for
8152	 * register, register and ignore existing key and clear.
8153	 * We sometimes ignore scope and type on preempts too!!
8154	 * Verify reservation type here as well.
8155	 */
8156	type = cdb->scope_type & SPR_TYPE_MASK;
8157	if ((cdb->action == SPRO_RESERVE)
8158	 || (cdb->action == SPRO_RELEASE)) {
8159		if ((cdb->scope_type & SPR_SCOPE_MASK) != SPR_LU_SCOPE) {
8160			ctl_set_invalid_field(/*ctsio*/ ctsio,
8161					      /*sks_valid*/ 1,
8162					      /*command*/ 1,
8163					      /*field*/ 2,
8164					      /*bit_valid*/ 1,
8165					      /*bit*/ 4);
8166			ctl_done((union ctl_io *)ctsio);
8167			return (CTL_RETVAL_COMPLETE);
8168		}
8169
8170		if (type>8 || type==2 || type==4 || type==0) {
8171			ctl_set_invalid_field(/*ctsio*/ ctsio,
8172					      /*sks_valid*/ 1,
8173					      /*command*/ 1,
8174					      /*field*/ 2,
8175					      /*bit_valid*/ 1,
8176					      /*bit*/ 0);
8177			ctl_done((union ctl_io *)ctsio);
8178			return (CTL_RETVAL_COMPLETE);
8179		}
8180	}
8181
8182	param_len = scsi_4btoul(cdb->length);
8183
8184	if ((ctsio->io_hdr.flags & CTL_FLAG_ALLOCATED) == 0) {
8185		ctsio->kern_data_ptr = malloc(param_len, M_CTL, M_WAITOK);
8186		ctsio->kern_data_len = param_len;
8187		ctsio->kern_total_len = param_len;
8188		ctsio->kern_data_resid = 0;
8189		ctsio->kern_rel_offset = 0;
8190		ctsio->kern_sg_entries = 0;
8191		ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
8192		ctsio->be_move_done = ctl_config_move_done;
8193		ctl_datamove((union ctl_io *)ctsio);
8194
8195		return (CTL_RETVAL_COMPLETE);
8196	}
8197
8198	param = (struct scsi_per_res_out_parms *)ctsio->kern_data_ptr;
8199
8200	residx = ctl_get_initindex(&ctsio->io_hdr.nexus);
8201	res_key = scsi_8btou64(param->res_key.key);
8202	sa_res_key = scsi_8btou64(param->serv_act_res_key);
8203
8204	/*
8205	 * Validate the reservation key here except for SPRO_REG_IGNO
8206	 * This must be done for all other service actions
8207	 */
8208	if ((cdb->action & SPRO_ACTION_MASK) != SPRO_REG_IGNO) {
8209		mtx_lock(&lun->lun_lock);
8210		if ((key = ctl_get_prkey(lun, residx)) != 0) {
8211			if (res_key != key) {
8212				/*
8213				 * The current key passed in doesn't match
8214				 * the one the initiator previously
8215				 * registered.
8216				 */
8217				mtx_unlock(&lun->lun_lock);
8218				free(ctsio->kern_data_ptr, M_CTL);
8219				ctl_set_reservation_conflict(ctsio);
8220				ctl_done((union ctl_io *)ctsio);
8221				return (CTL_RETVAL_COMPLETE);
8222			}
8223		} else if ((cdb->action & SPRO_ACTION_MASK) != SPRO_REGISTER) {
8224			/*
8225			 * We are not registered
8226			 */
8227			mtx_unlock(&lun->lun_lock);
8228			free(ctsio->kern_data_ptr, M_CTL);
8229			ctl_set_reservation_conflict(ctsio);
8230			ctl_done((union ctl_io *)ctsio);
8231			return (CTL_RETVAL_COMPLETE);
8232		} else if (res_key != 0) {
8233			/*
8234			 * We are not registered and trying to register but
8235			 * the register key isn't zero.
8236			 */
8237			mtx_unlock(&lun->lun_lock);
8238			free(ctsio->kern_data_ptr, M_CTL);
8239			ctl_set_reservation_conflict(ctsio);
8240			ctl_done((union ctl_io *)ctsio);
8241			return (CTL_RETVAL_COMPLETE);
8242		}
8243		mtx_unlock(&lun->lun_lock);
8244	}
8245
8246	switch (cdb->action & SPRO_ACTION_MASK) {
8247	case SPRO_REGISTER:
8248	case SPRO_REG_IGNO: {
8249
8250#if 0
8251		printf("Registration received\n");
8252#endif
8253
8254		/*
8255		 * We don't support any of these options, as we report in
8256		 * the read capabilities request (see
8257		 * ctl_persistent_reserve_in(), above).
8258		 */
8259		if ((param->flags & SPR_SPEC_I_PT)
8260		 || (param->flags & SPR_ALL_TG_PT)
8261		 || (param->flags & SPR_APTPL)) {
8262			int bit_ptr;
8263
8264			if (param->flags & SPR_APTPL)
8265				bit_ptr = 0;
8266			else if (param->flags & SPR_ALL_TG_PT)
8267				bit_ptr = 2;
8268			else /* SPR_SPEC_I_PT */
8269				bit_ptr = 3;
8270
8271			free(ctsio->kern_data_ptr, M_CTL);
8272			ctl_set_invalid_field(ctsio,
8273					      /*sks_valid*/ 1,
8274					      /*command*/ 0,
8275					      /*field*/ 20,
8276					      /*bit_valid*/ 1,
8277					      /*bit*/ bit_ptr);
8278			ctl_done((union ctl_io *)ctsio);
8279			return (CTL_RETVAL_COMPLETE);
8280		}
8281
8282		mtx_lock(&lun->lun_lock);
8283
8284		/*
8285		 * The initiator wants to clear the
8286		 * key/unregister.
8287		 */
8288		if (sa_res_key == 0) {
8289			if ((res_key == 0
8290			  && (cdb->action & SPRO_ACTION_MASK) == SPRO_REGISTER)
8291			 || ((cdb->action & SPRO_ACTION_MASK) == SPRO_REG_IGNO
8292			  && ctl_get_prkey(lun, residx) == 0)) {
8293				mtx_unlock(&lun->lun_lock);
8294				goto done;
8295			}
8296
8297			ctl_clr_prkey(lun, residx);
8298			lun->pr_key_count--;
8299
8300			if (residx == lun->pr_res_idx) {
8301				lun->flags &= ~CTL_LUN_PR_RESERVED;
8302				lun->pr_res_idx = CTL_PR_NO_RESERVATION;
8303
8304				if ((lun->pr_res_type == SPR_TYPE_WR_EX_RO ||
8305				     lun->pr_res_type == SPR_TYPE_EX_AC_RO) &&
8306				    lun->pr_key_count) {
8307					/*
8308					 * If the reservation is a registrants
8309					 * only type we need to generate a UA
8310					 * for other registered inits.  The
8311					 * sense code should be RESERVATIONS
8312					 * RELEASED
8313					 */
8314
8315					for (i = softc->init_min; i < softc->init_max; i++){
8316						if (ctl_get_prkey(lun, i) == 0)
8317							continue;
8318						ctl_est_ua(lun, i,
8319						    CTL_UA_RES_RELEASE);
8320					}
8321				}
8322				lun->pr_res_type = 0;
8323			} else if (lun->pr_res_idx == CTL_PR_ALL_REGISTRANTS) {
8324				if (lun->pr_key_count==0) {
8325					lun->flags &= ~CTL_LUN_PR_RESERVED;
8326					lun->pr_res_type = 0;
8327					lun->pr_res_idx = CTL_PR_NO_RESERVATION;
8328				}
8329			}
8330			lun->pr_generation++;
8331			mtx_unlock(&lun->lun_lock);
8332
8333			persis_io.hdr.nexus = ctsio->io_hdr.nexus;
8334			persis_io.hdr.msg_type = CTL_MSG_PERS_ACTION;
8335			persis_io.pr.pr_info.action = CTL_PR_UNREG_KEY;
8336			persis_io.pr.pr_info.residx = residx;
8337			ctl_ha_msg_send(CTL_HA_CHAN_CTL, &persis_io,
8338			    sizeof(persis_io.pr), M_WAITOK);
8339		} else /* sa_res_key != 0 */ {
8340
8341			/*
8342			 * If we aren't registered currently then increment
8343			 * the key count and set the registered flag.
8344			 */
8345			ctl_alloc_prkey(lun, residx);
8346			if (ctl_get_prkey(lun, residx) == 0)
8347				lun->pr_key_count++;
8348			ctl_set_prkey(lun, residx, sa_res_key);
8349			lun->pr_generation++;
8350			mtx_unlock(&lun->lun_lock);
8351
8352			persis_io.hdr.nexus = ctsio->io_hdr.nexus;
8353			persis_io.hdr.msg_type = CTL_MSG_PERS_ACTION;
8354			persis_io.pr.pr_info.action = CTL_PR_REG_KEY;
8355			persis_io.pr.pr_info.residx = residx;
8356			memcpy(persis_io.pr.pr_info.sa_res_key,
8357			       param->serv_act_res_key,
8358			       sizeof(param->serv_act_res_key));
8359			ctl_ha_msg_send(CTL_HA_CHAN_CTL, &persis_io,
8360			    sizeof(persis_io.pr), M_WAITOK);
8361		}
8362
8363		break;
8364	}
8365	case SPRO_RESERVE:
8366#if 0
8367                printf("Reserve executed type %d\n", type);
8368#endif
8369		mtx_lock(&lun->lun_lock);
8370		if (lun->flags & CTL_LUN_PR_RESERVED) {
8371			/*
8372			 * if this isn't the reservation holder and it's
8373			 * not a "all registrants" type or if the type is
8374			 * different then we have a conflict
8375			 */
8376			if ((lun->pr_res_idx != residx
8377			  && lun->pr_res_idx != CTL_PR_ALL_REGISTRANTS)
8378			 || lun->pr_res_type != type) {
8379				mtx_unlock(&lun->lun_lock);
8380				free(ctsio->kern_data_ptr, M_CTL);
8381				ctl_set_reservation_conflict(ctsio);
8382				ctl_done((union ctl_io *)ctsio);
8383				return (CTL_RETVAL_COMPLETE);
8384			}
8385			mtx_unlock(&lun->lun_lock);
8386		} else /* create a reservation */ {
8387			/*
8388			 * If it's not an "all registrants" type record
8389			 * reservation holder
8390			 */
8391			if (type != SPR_TYPE_WR_EX_AR
8392			 && type != SPR_TYPE_EX_AC_AR)
8393				lun->pr_res_idx = residx; /* Res holder */
8394			else
8395				lun->pr_res_idx = CTL_PR_ALL_REGISTRANTS;
8396
8397			lun->flags |= CTL_LUN_PR_RESERVED;
8398			lun->pr_res_type = type;
8399
8400			mtx_unlock(&lun->lun_lock);
8401
8402			/* send msg to other side */
8403			persis_io.hdr.nexus = ctsio->io_hdr.nexus;
8404			persis_io.hdr.msg_type = CTL_MSG_PERS_ACTION;
8405			persis_io.pr.pr_info.action = CTL_PR_RESERVE;
8406			persis_io.pr.pr_info.residx = lun->pr_res_idx;
8407			persis_io.pr.pr_info.res_type = type;
8408			ctl_ha_msg_send(CTL_HA_CHAN_CTL, &persis_io,
8409			    sizeof(persis_io.pr), M_WAITOK);
8410		}
8411		break;
8412
8413	case SPRO_RELEASE:
8414		mtx_lock(&lun->lun_lock);
8415		if ((lun->flags & CTL_LUN_PR_RESERVED) == 0) {
8416			/* No reservation exists return good status */
8417			mtx_unlock(&lun->lun_lock);
8418			goto done;
8419		}
8420		/*
8421		 * Is this nexus a reservation holder?
8422		 */
8423		if (lun->pr_res_idx != residx
8424		 && lun->pr_res_idx != CTL_PR_ALL_REGISTRANTS) {
8425			/*
8426			 * not a res holder return good status but
8427			 * do nothing
8428			 */
8429			mtx_unlock(&lun->lun_lock);
8430			goto done;
8431		}
8432
8433		if (lun->pr_res_type != type) {
8434			mtx_unlock(&lun->lun_lock);
8435			free(ctsio->kern_data_ptr, M_CTL);
8436			ctl_set_illegal_pr_release(ctsio);
8437			ctl_done((union ctl_io *)ctsio);
8438			return (CTL_RETVAL_COMPLETE);
8439		}
8440
8441		/* okay to release */
8442		lun->flags &= ~CTL_LUN_PR_RESERVED;
8443		lun->pr_res_idx = CTL_PR_NO_RESERVATION;
8444		lun->pr_res_type = 0;
8445
8446		/*
8447		 * if this isn't an exclusive access
8448		 * res generate UA for all other
8449		 * registrants.
8450		 */
8451		if (type != SPR_TYPE_EX_AC
8452		 && type != SPR_TYPE_WR_EX) {
8453			for (i = softc->init_min; i < softc->init_max; i++) {
8454				if (i == residx || ctl_get_prkey(lun, i) == 0)
8455					continue;
8456				ctl_est_ua(lun, i, CTL_UA_RES_RELEASE);
8457			}
8458		}
8459		mtx_unlock(&lun->lun_lock);
8460
8461		/* Send msg to other side */
8462		persis_io.hdr.nexus = ctsio->io_hdr.nexus;
8463		persis_io.hdr.msg_type = CTL_MSG_PERS_ACTION;
8464		persis_io.pr.pr_info.action = CTL_PR_RELEASE;
8465		ctl_ha_msg_send(CTL_HA_CHAN_CTL, &persis_io,
8466		     sizeof(persis_io.pr), M_WAITOK);
8467		break;
8468
8469	case SPRO_CLEAR:
8470		/* send msg to other side */
8471
8472		mtx_lock(&lun->lun_lock);
8473		lun->flags &= ~CTL_LUN_PR_RESERVED;
8474		lun->pr_res_type = 0;
8475		lun->pr_key_count = 0;
8476		lun->pr_res_idx = CTL_PR_NO_RESERVATION;
8477
8478		ctl_clr_prkey(lun, residx);
8479		for (i = 0; i < CTL_MAX_INITIATORS; i++)
8480			if (ctl_get_prkey(lun, i) != 0) {
8481				ctl_clr_prkey(lun, i);
8482				ctl_est_ua(lun, i, CTL_UA_REG_PREEMPT);
8483			}
8484		lun->pr_generation++;
8485		mtx_unlock(&lun->lun_lock);
8486
8487		persis_io.hdr.nexus = ctsio->io_hdr.nexus;
8488		persis_io.hdr.msg_type = CTL_MSG_PERS_ACTION;
8489		persis_io.pr.pr_info.action = CTL_PR_CLEAR;
8490		ctl_ha_msg_send(CTL_HA_CHAN_CTL, &persis_io,
8491		     sizeof(persis_io.pr), M_WAITOK);
8492		break;
8493
8494	case SPRO_PREEMPT:
8495	case SPRO_PRE_ABO: {
8496		int nretval;
8497
8498		nretval = ctl_pro_preempt(softc, lun, res_key, sa_res_key, type,
8499					  residx, ctsio, cdb, param);
8500		if (nretval != 0)
8501			return (CTL_RETVAL_COMPLETE);
8502		break;
8503	}
8504	default:
8505		panic("%s: Invalid PR type %#x", __func__, cdb->action);
8506	}
8507
8508done:
8509	free(ctsio->kern_data_ptr, M_CTL);
8510	ctl_set_success(ctsio);
8511	ctl_done((union ctl_io *)ctsio);
8512
8513	return (retval);
8514}
8515
8516/*
8517 * This routine is for handling a message from the other SC pertaining to
8518 * persistent reserve out. All the error checking will have been done
8519 * so only perorming the action need be done here to keep the two
8520 * in sync.
8521 */
8522static void
8523ctl_hndl_per_res_out_on_other_sc(union ctl_ha_msg *msg)
8524{
8525	struct ctl_softc *softc = control_softc;
8526	struct ctl_lun *lun;
8527	int i;
8528	uint32_t residx, targ_lun;
8529
8530	targ_lun = msg->hdr.nexus.targ_mapped_lun;
8531	mtx_lock(&softc->ctl_lock);
8532	if ((targ_lun >= CTL_MAX_LUNS) ||
8533	    ((lun = softc->ctl_luns[targ_lun]) == NULL)) {
8534		mtx_unlock(&softc->ctl_lock);
8535		return;
8536	}
8537	mtx_lock(&lun->lun_lock);
8538	mtx_unlock(&softc->ctl_lock);
8539	if (lun->flags & CTL_LUN_DISABLED) {
8540		mtx_unlock(&lun->lun_lock);
8541		return;
8542	}
8543	residx = ctl_get_initindex(&msg->hdr.nexus);
8544	switch(msg->pr.pr_info.action) {
8545	case CTL_PR_REG_KEY:
8546		ctl_alloc_prkey(lun, msg->pr.pr_info.residx);
8547		if (ctl_get_prkey(lun, msg->pr.pr_info.residx) == 0)
8548			lun->pr_key_count++;
8549		ctl_set_prkey(lun, msg->pr.pr_info.residx,
8550		    scsi_8btou64(msg->pr.pr_info.sa_res_key));
8551		lun->pr_generation++;
8552		break;
8553
8554	case CTL_PR_UNREG_KEY:
8555		ctl_clr_prkey(lun, msg->pr.pr_info.residx);
8556		lun->pr_key_count--;
8557
8558		/* XXX Need to see if the reservation has been released */
8559		/* if so do we need to generate UA? */
8560		if (msg->pr.pr_info.residx == lun->pr_res_idx) {
8561			lun->flags &= ~CTL_LUN_PR_RESERVED;
8562			lun->pr_res_idx = CTL_PR_NO_RESERVATION;
8563
8564			if ((lun->pr_res_type == SPR_TYPE_WR_EX_RO ||
8565			     lun->pr_res_type == SPR_TYPE_EX_AC_RO) &&
8566			    lun->pr_key_count) {
8567				/*
8568				 * If the reservation is a registrants
8569				 * only type we need to generate a UA
8570				 * for other registered inits.  The
8571				 * sense code should be RESERVATIONS
8572				 * RELEASED
8573				 */
8574
8575				for (i = softc->init_min; i < softc->init_max; i++) {
8576					if (ctl_get_prkey(lun, i) == 0)
8577						continue;
8578
8579					ctl_est_ua(lun, i, CTL_UA_RES_RELEASE);
8580				}
8581			}
8582			lun->pr_res_type = 0;
8583		} else if (lun->pr_res_idx == CTL_PR_ALL_REGISTRANTS) {
8584			if (lun->pr_key_count==0) {
8585				lun->flags &= ~CTL_LUN_PR_RESERVED;
8586				lun->pr_res_type = 0;
8587				lun->pr_res_idx = CTL_PR_NO_RESERVATION;
8588			}
8589		}
8590		lun->pr_generation++;
8591		break;
8592
8593	case CTL_PR_RESERVE:
8594		lun->flags |= CTL_LUN_PR_RESERVED;
8595		lun->pr_res_type = msg->pr.pr_info.res_type;
8596		lun->pr_res_idx = msg->pr.pr_info.residx;
8597
8598		break;
8599
8600	case CTL_PR_RELEASE:
8601		/*
8602		 * if this isn't an exclusive access res generate UA for all
8603		 * other registrants.
8604		 */
8605		if (lun->pr_res_type != SPR_TYPE_EX_AC &&
8606		    lun->pr_res_type != SPR_TYPE_WR_EX) {
8607			for (i = softc->init_min; i < softc->init_max; i++)
8608				if (i == residx || ctl_get_prkey(lun, i) == 0)
8609					continue;
8610				ctl_est_ua(lun, i, CTL_UA_RES_RELEASE);
8611		}
8612
8613		lun->flags &= ~CTL_LUN_PR_RESERVED;
8614		lun->pr_res_idx = CTL_PR_NO_RESERVATION;
8615		lun->pr_res_type = 0;
8616		break;
8617
8618	case CTL_PR_PREEMPT:
8619		ctl_pro_preempt_other(lun, msg);
8620		break;
8621	case CTL_PR_CLEAR:
8622		lun->flags &= ~CTL_LUN_PR_RESERVED;
8623		lun->pr_res_type = 0;
8624		lun->pr_key_count = 0;
8625		lun->pr_res_idx = CTL_PR_NO_RESERVATION;
8626
8627		for (i=0; i < CTL_MAX_INITIATORS; i++) {
8628			if (ctl_get_prkey(lun, i) == 0)
8629				continue;
8630			ctl_clr_prkey(lun, i);
8631			ctl_est_ua(lun, i, CTL_UA_REG_PREEMPT);
8632		}
8633		lun->pr_generation++;
8634		break;
8635	}
8636
8637	mtx_unlock(&lun->lun_lock);
8638}
8639
8640int
8641ctl_read_write(struct ctl_scsiio *ctsio)
8642{
8643	struct ctl_lun *lun;
8644	struct ctl_lba_len_flags *lbalen;
8645	uint64_t lba;
8646	uint32_t num_blocks;
8647	int flags, retval;
8648	int isread;
8649
8650	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
8651
8652	CTL_DEBUG_PRINT(("ctl_read_write: command: %#x\n", ctsio->cdb[0]));
8653
8654	flags = 0;
8655	isread = ctsio->cdb[0] == READ_6  || ctsio->cdb[0] == READ_10
8656	      || ctsio->cdb[0] == READ_12 || ctsio->cdb[0] == READ_16;
8657	switch (ctsio->cdb[0]) {
8658	case READ_6:
8659	case WRITE_6: {
8660		struct scsi_rw_6 *cdb;
8661
8662		cdb = (struct scsi_rw_6 *)ctsio->cdb;
8663
8664		lba = scsi_3btoul(cdb->addr);
8665		/* only 5 bits are valid in the most significant address byte */
8666		lba &= 0x1fffff;
8667		num_blocks = cdb->length;
8668		/*
8669		 * This is correct according to SBC-2.
8670		 */
8671		if (num_blocks == 0)
8672			num_blocks = 256;
8673		break;
8674	}
8675	case READ_10:
8676	case WRITE_10: {
8677		struct scsi_rw_10 *cdb;
8678
8679		cdb = (struct scsi_rw_10 *)ctsio->cdb;
8680		if (cdb->byte2 & SRW10_FUA)
8681			flags |= CTL_LLF_FUA;
8682		if (cdb->byte2 & SRW10_DPO)
8683			flags |= CTL_LLF_DPO;
8684		lba = scsi_4btoul(cdb->addr);
8685		num_blocks = scsi_2btoul(cdb->length);
8686		break;
8687	}
8688	case WRITE_VERIFY_10: {
8689		struct scsi_write_verify_10 *cdb;
8690
8691		cdb = (struct scsi_write_verify_10 *)ctsio->cdb;
8692		flags |= CTL_LLF_FUA;
8693		if (cdb->byte2 & SWV_DPO)
8694			flags |= CTL_LLF_DPO;
8695		lba = scsi_4btoul(cdb->addr);
8696		num_blocks = scsi_2btoul(cdb->length);
8697		break;
8698	}
8699	case READ_12:
8700	case WRITE_12: {
8701		struct scsi_rw_12 *cdb;
8702
8703		cdb = (struct scsi_rw_12 *)ctsio->cdb;
8704		if (cdb->byte2 & SRW12_FUA)
8705			flags |= CTL_LLF_FUA;
8706		if (cdb->byte2 & SRW12_DPO)
8707			flags |= CTL_LLF_DPO;
8708		lba = scsi_4btoul(cdb->addr);
8709		num_blocks = scsi_4btoul(cdb->length);
8710		break;
8711	}
8712	case WRITE_VERIFY_12: {
8713		struct scsi_write_verify_12 *cdb;
8714
8715		cdb = (struct scsi_write_verify_12 *)ctsio->cdb;
8716		flags |= CTL_LLF_FUA;
8717		if (cdb->byte2 & SWV_DPO)
8718			flags |= CTL_LLF_DPO;
8719		lba = scsi_4btoul(cdb->addr);
8720		num_blocks = scsi_4btoul(cdb->length);
8721		break;
8722	}
8723	case READ_16:
8724	case WRITE_16: {
8725		struct scsi_rw_16 *cdb;
8726
8727		cdb = (struct scsi_rw_16 *)ctsio->cdb;
8728		if (cdb->byte2 & SRW12_FUA)
8729			flags |= CTL_LLF_FUA;
8730		if (cdb->byte2 & SRW12_DPO)
8731			flags |= CTL_LLF_DPO;
8732		lba = scsi_8btou64(cdb->addr);
8733		num_blocks = scsi_4btoul(cdb->length);
8734		break;
8735	}
8736	case WRITE_ATOMIC_16: {
8737		struct scsi_write_atomic_16 *cdb;
8738
8739		if (lun->be_lun->atomicblock == 0) {
8740			ctl_set_invalid_opcode(ctsio);
8741			ctl_done((union ctl_io *)ctsio);
8742			return (CTL_RETVAL_COMPLETE);
8743		}
8744
8745		cdb = (struct scsi_write_atomic_16 *)ctsio->cdb;
8746		if (cdb->byte2 & SRW12_FUA)
8747			flags |= CTL_LLF_FUA;
8748		if (cdb->byte2 & SRW12_DPO)
8749			flags |= CTL_LLF_DPO;
8750		lba = scsi_8btou64(cdb->addr);
8751		num_blocks = scsi_2btoul(cdb->length);
8752		if (num_blocks > lun->be_lun->atomicblock) {
8753			ctl_set_invalid_field(ctsio, /*sks_valid*/ 1,
8754			    /*command*/ 1, /*field*/ 12, /*bit_valid*/ 0,
8755			    /*bit*/ 0);
8756			ctl_done((union ctl_io *)ctsio);
8757			return (CTL_RETVAL_COMPLETE);
8758		}
8759		break;
8760	}
8761	case WRITE_VERIFY_16: {
8762		struct scsi_write_verify_16 *cdb;
8763
8764		cdb = (struct scsi_write_verify_16 *)ctsio->cdb;
8765		flags |= CTL_LLF_FUA;
8766		if (cdb->byte2 & SWV_DPO)
8767			flags |= CTL_LLF_DPO;
8768		lba = scsi_8btou64(cdb->addr);
8769		num_blocks = scsi_4btoul(cdb->length);
8770		break;
8771	}
8772	default:
8773		/*
8774		 * We got a command we don't support.  This shouldn't
8775		 * happen, commands should be filtered out above us.
8776		 */
8777		ctl_set_invalid_opcode(ctsio);
8778		ctl_done((union ctl_io *)ctsio);
8779
8780		return (CTL_RETVAL_COMPLETE);
8781		break; /* NOTREACHED */
8782	}
8783
8784	/*
8785	 * The first check is to make sure we're in bounds, the second
8786	 * check is to catch wrap-around problems.  If the lba + num blocks
8787	 * is less than the lba, then we've wrapped around and the block
8788	 * range is invalid anyway.
8789	 */
8790	if (((lba + num_blocks) > (lun->be_lun->maxlba + 1))
8791	 || ((lba + num_blocks) < lba)) {
8792		ctl_set_lba_out_of_range(ctsio);
8793		ctl_done((union ctl_io *)ctsio);
8794		return (CTL_RETVAL_COMPLETE);
8795	}
8796
8797	/*
8798	 * According to SBC-3, a transfer length of 0 is not an error.
8799	 * Note that this cannot happen with WRITE(6) or READ(6), since 0
8800	 * translates to 256 blocks for those commands.
8801	 */
8802	if (num_blocks == 0) {
8803		ctl_set_success(ctsio);
8804		ctl_done((union ctl_io *)ctsio);
8805		return (CTL_RETVAL_COMPLETE);
8806	}
8807
8808	/* Set FUA and/or DPO if caches are disabled. */
8809	if (isread) {
8810		if ((lun->mode_pages.caching_page[CTL_PAGE_CURRENT].flags1 &
8811		    SCP_RCD) != 0)
8812			flags |= CTL_LLF_FUA | CTL_LLF_DPO;
8813	} else {
8814		if ((lun->mode_pages.caching_page[CTL_PAGE_CURRENT].flags1 &
8815		    SCP_WCE) == 0)
8816			flags |= CTL_LLF_FUA;
8817	}
8818
8819	lbalen = (struct ctl_lba_len_flags *)
8820	    &ctsio->io_hdr.ctl_private[CTL_PRIV_LBA_LEN];
8821	lbalen->lba = lba;
8822	lbalen->len = num_blocks;
8823	lbalen->flags = (isread ? CTL_LLF_READ : CTL_LLF_WRITE) | flags;
8824
8825	ctsio->kern_total_len = num_blocks * lun->be_lun->blocksize;
8826	ctsio->kern_rel_offset = 0;
8827
8828	CTL_DEBUG_PRINT(("ctl_read_write: calling data_submit()\n"));
8829
8830	retval = lun->backend->data_submit((union ctl_io *)ctsio);
8831	return (retval);
8832}
8833
8834static int
8835ctl_cnw_cont(union ctl_io *io)
8836{
8837	struct ctl_scsiio *ctsio;
8838	struct ctl_lun *lun;
8839	struct ctl_lba_len_flags *lbalen;
8840	int retval;
8841
8842	ctsio = &io->scsiio;
8843	ctsio->io_hdr.status = CTL_STATUS_NONE;
8844	ctsio->io_hdr.flags &= ~CTL_FLAG_IO_CONT;
8845	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
8846	lbalen = (struct ctl_lba_len_flags *)
8847	    &ctsio->io_hdr.ctl_private[CTL_PRIV_LBA_LEN];
8848	lbalen->flags &= ~CTL_LLF_COMPARE;
8849	lbalen->flags |= CTL_LLF_WRITE;
8850
8851	CTL_DEBUG_PRINT(("ctl_cnw_cont: calling data_submit()\n"));
8852	retval = lun->backend->data_submit((union ctl_io *)ctsio);
8853	return (retval);
8854}
8855
8856int
8857ctl_cnw(struct ctl_scsiio *ctsio)
8858{
8859	struct ctl_lun *lun;
8860	struct ctl_lba_len_flags *lbalen;
8861	uint64_t lba;
8862	uint32_t num_blocks;
8863	int flags, retval;
8864
8865	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
8866
8867	CTL_DEBUG_PRINT(("ctl_cnw: command: %#x\n", ctsio->cdb[0]));
8868
8869	flags = 0;
8870	switch (ctsio->cdb[0]) {
8871	case COMPARE_AND_WRITE: {
8872		struct scsi_compare_and_write *cdb;
8873
8874		cdb = (struct scsi_compare_and_write *)ctsio->cdb;
8875		if (cdb->byte2 & SRW10_FUA)
8876			flags |= CTL_LLF_FUA;
8877		if (cdb->byte2 & SRW10_DPO)
8878			flags |= CTL_LLF_DPO;
8879		lba = scsi_8btou64(cdb->addr);
8880		num_blocks = cdb->length;
8881		break;
8882	}
8883	default:
8884		/*
8885		 * We got a command we don't support.  This shouldn't
8886		 * happen, commands should be filtered out above us.
8887		 */
8888		ctl_set_invalid_opcode(ctsio);
8889		ctl_done((union ctl_io *)ctsio);
8890
8891		return (CTL_RETVAL_COMPLETE);
8892		break; /* NOTREACHED */
8893	}
8894
8895	/*
8896	 * The first check is to make sure we're in bounds, the second
8897	 * check is to catch wrap-around problems.  If the lba + num blocks
8898	 * is less than the lba, then we've wrapped around and the block
8899	 * range is invalid anyway.
8900	 */
8901	if (((lba + num_blocks) > (lun->be_lun->maxlba + 1))
8902	 || ((lba + num_blocks) < lba)) {
8903		ctl_set_lba_out_of_range(ctsio);
8904		ctl_done((union ctl_io *)ctsio);
8905		return (CTL_RETVAL_COMPLETE);
8906	}
8907
8908	/*
8909	 * According to SBC-3, a transfer length of 0 is not an error.
8910	 */
8911	if (num_blocks == 0) {
8912		ctl_set_success(ctsio);
8913		ctl_done((union ctl_io *)ctsio);
8914		return (CTL_RETVAL_COMPLETE);
8915	}
8916
8917	/* Set FUA if write cache is disabled. */
8918	if ((lun->mode_pages.caching_page[CTL_PAGE_CURRENT].flags1 &
8919	    SCP_WCE) == 0)
8920		flags |= CTL_LLF_FUA;
8921
8922	ctsio->kern_total_len = 2 * num_blocks * lun->be_lun->blocksize;
8923	ctsio->kern_rel_offset = 0;
8924
8925	/*
8926	 * Set the IO_CONT flag, so that if this I/O gets passed to
8927	 * ctl_data_submit_done(), it'll get passed back to
8928	 * ctl_ctl_cnw_cont() for further processing.
8929	 */
8930	ctsio->io_hdr.flags |= CTL_FLAG_IO_CONT;
8931	ctsio->io_cont = ctl_cnw_cont;
8932
8933	lbalen = (struct ctl_lba_len_flags *)
8934	    &ctsio->io_hdr.ctl_private[CTL_PRIV_LBA_LEN];
8935	lbalen->lba = lba;
8936	lbalen->len = num_blocks;
8937	lbalen->flags = CTL_LLF_COMPARE | flags;
8938
8939	CTL_DEBUG_PRINT(("ctl_cnw: calling data_submit()\n"));
8940	retval = lun->backend->data_submit((union ctl_io *)ctsio);
8941	return (retval);
8942}
8943
8944int
8945ctl_verify(struct ctl_scsiio *ctsio)
8946{
8947	struct ctl_lun *lun;
8948	struct ctl_lba_len_flags *lbalen;
8949	uint64_t lba;
8950	uint32_t num_blocks;
8951	int bytchk, flags;
8952	int retval;
8953
8954	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
8955
8956	CTL_DEBUG_PRINT(("ctl_verify: command: %#x\n", ctsio->cdb[0]));
8957
8958	bytchk = 0;
8959	flags = CTL_LLF_FUA;
8960	switch (ctsio->cdb[0]) {
8961	case VERIFY_10: {
8962		struct scsi_verify_10 *cdb;
8963
8964		cdb = (struct scsi_verify_10 *)ctsio->cdb;
8965		if (cdb->byte2 & SVFY_BYTCHK)
8966			bytchk = 1;
8967		if (cdb->byte2 & SVFY_DPO)
8968			flags |= CTL_LLF_DPO;
8969		lba = scsi_4btoul(cdb->addr);
8970		num_blocks = scsi_2btoul(cdb->length);
8971		break;
8972	}
8973	case VERIFY_12: {
8974		struct scsi_verify_12 *cdb;
8975
8976		cdb = (struct scsi_verify_12 *)ctsio->cdb;
8977		if (cdb->byte2 & SVFY_BYTCHK)
8978			bytchk = 1;
8979		if (cdb->byte2 & SVFY_DPO)
8980			flags |= CTL_LLF_DPO;
8981		lba = scsi_4btoul(cdb->addr);
8982		num_blocks = scsi_4btoul(cdb->length);
8983		break;
8984	}
8985	case VERIFY_16: {
8986		struct scsi_rw_16 *cdb;
8987
8988		cdb = (struct scsi_rw_16 *)ctsio->cdb;
8989		if (cdb->byte2 & SVFY_BYTCHK)
8990			bytchk = 1;
8991		if (cdb->byte2 & SVFY_DPO)
8992			flags |= CTL_LLF_DPO;
8993		lba = scsi_8btou64(cdb->addr);
8994		num_blocks = scsi_4btoul(cdb->length);
8995		break;
8996	}
8997	default:
8998		/*
8999		 * We got a command we don't support.  This shouldn't
9000		 * happen, commands should be filtered out above us.
9001		 */
9002		ctl_set_invalid_opcode(ctsio);
9003		ctl_done((union ctl_io *)ctsio);
9004		return (CTL_RETVAL_COMPLETE);
9005	}
9006
9007	/*
9008	 * The first check is to make sure we're in bounds, the second
9009	 * check is to catch wrap-around problems.  If the lba + num blocks
9010	 * is less than the lba, then we've wrapped around and the block
9011	 * range is invalid anyway.
9012	 */
9013	if (((lba + num_blocks) > (lun->be_lun->maxlba + 1))
9014	 || ((lba + num_blocks) < lba)) {
9015		ctl_set_lba_out_of_range(ctsio);
9016		ctl_done((union ctl_io *)ctsio);
9017		return (CTL_RETVAL_COMPLETE);
9018	}
9019
9020	/*
9021	 * According to SBC-3, a transfer length of 0 is not an error.
9022	 */
9023	if (num_blocks == 0) {
9024		ctl_set_success(ctsio);
9025		ctl_done((union ctl_io *)ctsio);
9026		return (CTL_RETVAL_COMPLETE);
9027	}
9028
9029	lbalen = (struct ctl_lba_len_flags *)
9030	    &ctsio->io_hdr.ctl_private[CTL_PRIV_LBA_LEN];
9031	lbalen->lba = lba;
9032	lbalen->len = num_blocks;
9033	if (bytchk) {
9034		lbalen->flags = CTL_LLF_COMPARE | flags;
9035		ctsio->kern_total_len = num_blocks * lun->be_lun->blocksize;
9036	} else {
9037		lbalen->flags = CTL_LLF_VERIFY | flags;
9038		ctsio->kern_total_len = 0;
9039	}
9040	ctsio->kern_rel_offset = 0;
9041
9042	CTL_DEBUG_PRINT(("ctl_verify: calling data_submit()\n"));
9043	retval = lun->backend->data_submit((union ctl_io *)ctsio);
9044	return (retval);
9045}
9046
9047int
9048ctl_report_luns(struct ctl_scsiio *ctsio)
9049{
9050	struct ctl_softc *softc;
9051	struct scsi_report_luns *cdb;
9052	struct scsi_report_luns_data *lun_data;
9053	struct ctl_lun *lun, *request_lun;
9054	struct ctl_port *port;
9055	int num_luns, retval;
9056	uint32_t alloc_len, lun_datalen;
9057	int num_filled;
9058	uint32_t initidx, targ_lun_id, lun_id;
9059
9060	retval = CTL_RETVAL_COMPLETE;
9061	cdb = (struct scsi_report_luns *)ctsio->cdb;
9062	port = ctl_io_port(&ctsio->io_hdr);
9063	softc = port->ctl_softc;
9064
9065	CTL_DEBUG_PRINT(("ctl_report_luns\n"));
9066
9067	mtx_lock(&softc->ctl_lock);
9068	num_luns = 0;
9069	for (targ_lun_id = 0; targ_lun_id < CTL_MAX_LUNS; targ_lun_id++) {
9070		if (ctl_lun_map_from_port(port, targ_lun_id) < CTL_MAX_LUNS)
9071			num_luns++;
9072	}
9073	mtx_unlock(&softc->ctl_lock);
9074
9075	switch (cdb->select_report) {
9076	case RPL_REPORT_DEFAULT:
9077	case RPL_REPORT_ALL:
9078	case RPL_REPORT_NONSUBSID:
9079		break;
9080	case RPL_REPORT_WELLKNOWN:
9081	case RPL_REPORT_ADMIN:
9082	case RPL_REPORT_CONGLOM:
9083		num_luns = 0;
9084		break;
9085	default:
9086		ctl_set_invalid_field(ctsio,
9087				      /*sks_valid*/ 1,
9088				      /*command*/ 1,
9089				      /*field*/ 2,
9090				      /*bit_valid*/ 0,
9091				      /*bit*/ 0);
9092		ctl_done((union ctl_io *)ctsio);
9093		return (retval);
9094		break; /* NOTREACHED */
9095	}
9096
9097	alloc_len = scsi_4btoul(cdb->length);
9098	/*
9099	 * The initiator has to allocate at least 16 bytes for this request,
9100	 * so he can at least get the header and the first LUN.  Otherwise
9101	 * we reject the request (per SPC-3 rev 14, section 6.21).
9102	 */
9103	if (alloc_len < (sizeof(struct scsi_report_luns_data) +
9104	    sizeof(struct scsi_report_luns_lundata))) {
9105		ctl_set_invalid_field(ctsio,
9106				      /*sks_valid*/ 1,
9107				      /*command*/ 1,
9108				      /*field*/ 6,
9109				      /*bit_valid*/ 0,
9110				      /*bit*/ 0);
9111		ctl_done((union ctl_io *)ctsio);
9112		return (retval);
9113	}
9114
9115	request_lun = (struct ctl_lun *)
9116		ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
9117
9118	lun_datalen = sizeof(*lun_data) +
9119		(num_luns * sizeof(struct scsi_report_luns_lundata));
9120
9121	ctsio->kern_data_ptr = malloc(lun_datalen, M_CTL, M_WAITOK | M_ZERO);
9122	lun_data = (struct scsi_report_luns_data *)ctsio->kern_data_ptr;
9123	ctsio->kern_sg_entries = 0;
9124
9125	initidx = ctl_get_initindex(&ctsio->io_hdr.nexus);
9126
9127	mtx_lock(&softc->ctl_lock);
9128	for (targ_lun_id = 0, num_filled = 0; targ_lun_id < CTL_MAX_LUNS && num_filled < num_luns; targ_lun_id++) {
9129		lun_id = ctl_lun_map_from_port(port, targ_lun_id);
9130		if (lun_id >= CTL_MAX_LUNS)
9131			continue;
9132		lun = softc->ctl_luns[lun_id];
9133		if (lun == NULL)
9134			continue;
9135
9136		be64enc(lun_data->luns[num_filled++].lundata,
9137		    ctl_encode_lun(targ_lun_id));
9138
9139		/*
9140		 * According to SPC-3, rev 14 section 6.21:
9141		 *
9142		 * "The execution of a REPORT LUNS command to any valid and
9143		 * installed logical unit shall clear the REPORTED LUNS DATA
9144		 * HAS CHANGED unit attention condition for all logical
9145		 * units of that target with respect to the requesting
9146		 * initiator. A valid and installed logical unit is one
9147		 * having a PERIPHERAL QUALIFIER of 000b in the standard
9148		 * INQUIRY data (see 6.4.2)."
9149		 *
9150		 * If request_lun is NULL, the LUN this report luns command
9151		 * was issued to is either disabled or doesn't exist. In that
9152		 * case, we shouldn't clear any pending lun change unit
9153		 * attention.
9154		 */
9155		if (request_lun != NULL) {
9156			mtx_lock(&lun->lun_lock);
9157			ctl_clr_ua(lun, initidx, CTL_UA_LUN_CHANGE);
9158			mtx_unlock(&lun->lun_lock);
9159		}
9160	}
9161	mtx_unlock(&softc->ctl_lock);
9162
9163	/*
9164	 * It's quite possible that we've returned fewer LUNs than we allocated
9165	 * space for.  Trim it.
9166	 */
9167	lun_datalen = sizeof(*lun_data) +
9168		(num_filled * sizeof(struct scsi_report_luns_lundata));
9169
9170	if (lun_datalen < alloc_len) {
9171		ctsio->residual = alloc_len - lun_datalen;
9172		ctsio->kern_data_len = lun_datalen;
9173		ctsio->kern_total_len = lun_datalen;
9174	} else {
9175		ctsio->residual = 0;
9176		ctsio->kern_data_len = alloc_len;
9177		ctsio->kern_total_len = alloc_len;
9178	}
9179	ctsio->kern_data_resid = 0;
9180	ctsio->kern_rel_offset = 0;
9181	ctsio->kern_sg_entries = 0;
9182
9183	/*
9184	 * We set this to the actual data length, regardless of how much
9185	 * space we actually have to return results.  If the user looks at
9186	 * this value, he'll know whether or not he allocated enough space
9187	 * and reissue the command if necessary.  We don't support well
9188	 * known logical units, so if the user asks for that, return none.
9189	 */
9190	scsi_ulto4b(lun_datalen - 8, lun_data->length);
9191
9192	/*
9193	 * We can only return SCSI_STATUS_CHECK_COND when we can't satisfy
9194	 * this request.
9195	 */
9196	ctl_set_success(ctsio);
9197	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
9198	ctsio->be_move_done = ctl_config_move_done;
9199	ctl_datamove((union ctl_io *)ctsio);
9200	return (retval);
9201}
9202
9203int
9204ctl_request_sense(struct ctl_scsiio *ctsio)
9205{
9206	struct scsi_request_sense *cdb;
9207	struct scsi_sense_data *sense_ptr;
9208	struct ctl_softc *ctl_softc;
9209	struct ctl_lun *lun;
9210	uint32_t initidx;
9211	int have_error;
9212	scsi_sense_data_type sense_format;
9213	ctl_ua_type ua_type;
9214	uint8_t asc = 0, ascq = 0;
9215
9216	cdb = (struct scsi_request_sense *)ctsio->cdb;
9217
9218	ctl_softc = control_softc;
9219	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
9220
9221	CTL_DEBUG_PRINT(("ctl_request_sense\n"));
9222
9223	/*
9224	 * Determine which sense format the user wants.
9225	 */
9226	if (cdb->byte2 & SRS_DESC)
9227		sense_format = SSD_TYPE_DESC;
9228	else
9229		sense_format = SSD_TYPE_FIXED;
9230
9231	ctsio->kern_data_ptr = malloc(sizeof(*sense_ptr), M_CTL, M_WAITOK);
9232	sense_ptr = (struct scsi_sense_data *)ctsio->kern_data_ptr;
9233	ctsio->kern_sg_entries = 0;
9234
9235	/*
9236	 * struct scsi_sense_data, which is currently set to 256 bytes, is
9237	 * larger than the largest allowed value for the length field in the
9238	 * REQUEST SENSE CDB, which is 252 bytes as of SPC-4.
9239	 */
9240	ctsio->residual = 0;
9241	ctsio->kern_data_len = cdb->length;
9242	ctsio->kern_total_len = cdb->length;
9243
9244	ctsio->kern_data_resid = 0;
9245	ctsio->kern_rel_offset = 0;
9246	ctsio->kern_sg_entries = 0;
9247
9248	/*
9249	 * If we don't have a LUN, we don't have any pending sense.
9250	 */
9251	if (lun == NULL)
9252		goto no_sense;
9253
9254	have_error = 0;
9255	initidx = ctl_get_initindex(&ctsio->io_hdr.nexus);
9256	/*
9257	 * Check for pending sense, and then for pending unit attentions.
9258	 * Pending sense gets returned first, then pending unit attentions.
9259	 */
9260	mtx_lock(&lun->lun_lock);
9261#ifdef CTL_WITH_CA
9262	if (ctl_is_set(lun->have_ca, initidx)) {
9263		scsi_sense_data_type stored_format;
9264
9265		/*
9266		 * Check to see which sense format was used for the stored
9267		 * sense data.
9268		 */
9269		stored_format = scsi_sense_type(&lun->pending_sense[initidx]);
9270
9271		/*
9272		 * If the user requested a different sense format than the
9273		 * one we stored, then we need to convert it to the other
9274		 * format.  If we're going from descriptor to fixed format
9275		 * sense data, we may lose things in translation, depending
9276		 * on what options were used.
9277		 *
9278		 * If the stored format is SSD_TYPE_NONE (i.e. invalid),
9279		 * for some reason we'll just copy it out as-is.
9280		 */
9281		if ((stored_format == SSD_TYPE_FIXED)
9282		 && (sense_format == SSD_TYPE_DESC))
9283			ctl_sense_to_desc((struct scsi_sense_data_fixed *)
9284			    &lun->pending_sense[initidx],
9285			    (struct scsi_sense_data_desc *)sense_ptr);
9286		else if ((stored_format == SSD_TYPE_DESC)
9287		      && (sense_format == SSD_TYPE_FIXED))
9288			ctl_sense_to_fixed((struct scsi_sense_data_desc *)
9289			    &lun->pending_sense[initidx],
9290			    (struct scsi_sense_data_fixed *)sense_ptr);
9291		else
9292			memcpy(sense_ptr, &lun->pending_sense[initidx],
9293			       MIN(sizeof(*sense_ptr),
9294			       sizeof(lun->pending_sense[initidx])));
9295
9296		ctl_clear_mask(lun->have_ca, initidx);
9297		have_error = 1;
9298	} else
9299#endif
9300	{
9301		ua_type = ctl_build_ua(lun, initidx, sense_ptr, sense_format);
9302		if (ua_type != CTL_UA_NONE)
9303			have_error = 1;
9304		if (ua_type == CTL_UA_LUN_CHANGE) {
9305			mtx_unlock(&lun->lun_lock);
9306			mtx_lock(&ctl_softc->ctl_lock);
9307			ctl_clr_ua_allluns(ctl_softc, initidx, ua_type);
9308			mtx_unlock(&ctl_softc->ctl_lock);
9309			mtx_lock(&lun->lun_lock);
9310		}
9311
9312	}
9313	mtx_unlock(&lun->lun_lock);
9314
9315	/*
9316	 * We already have a pending error, return it.
9317	 */
9318	if (have_error != 0) {
9319		/*
9320		 * We report the SCSI status as OK, since the status of the
9321		 * request sense command itself is OK.
9322		 * We report 0 for the sense length, because we aren't doing
9323		 * autosense in this case.  We're reporting sense as
9324		 * parameter data.
9325		 */
9326		ctl_set_success(ctsio);
9327		ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
9328		ctsio->be_move_done = ctl_config_move_done;
9329		ctl_datamove((union ctl_io *)ctsio);
9330		return (CTL_RETVAL_COMPLETE);
9331	}
9332
9333	/*
9334	 * No sense information to report, so we report that everything is
9335	 * okay, unless we have allowed Informational Exception.
9336	 */
9337	if (lun->mode_pages.ie_page[CTL_PAGE_CURRENT].mrie != SIEP_MRIE_NO) {
9338		asc = lun->ie_asc;
9339		ascq = lun->ie_ascq;
9340	}
9341
9342no_sense:
9343	ctl_set_sense_data(sense_ptr,
9344			   lun,
9345			   sense_format,
9346			   /*current_error*/ 1,
9347			   /*sense_key*/ SSD_KEY_NO_SENSE,
9348			   /*asc*/ asc,
9349			   /*ascq*/ ascq,
9350			   SSD_ELEM_NONE);
9351
9352	/*
9353	 * We report 0 for the sense length, because we aren't doing
9354	 * autosense in this case.  We're reporting sense as 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
9363int
9364ctl_tur(struct ctl_scsiio *ctsio)
9365{
9366
9367	CTL_DEBUG_PRINT(("ctl_tur\n"));
9368
9369	ctl_set_success(ctsio);
9370	ctl_done((union ctl_io *)ctsio);
9371
9372	return (CTL_RETVAL_COMPLETE);
9373}
9374
9375/*
9376 * SCSI VPD page 0x00, the Supported VPD Pages page.
9377 */
9378static int
9379ctl_inquiry_evpd_supported(struct ctl_scsiio *ctsio, int alloc_len)
9380{
9381	struct scsi_vpd_supported_pages *pages;
9382	int sup_page_size;
9383	struct ctl_lun *lun;
9384	int p;
9385
9386	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
9387
9388	sup_page_size = sizeof(struct scsi_vpd_supported_pages) *
9389	    SCSI_EVPD_NUM_SUPPORTED_PAGES;
9390	ctsio->kern_data_ptr = malloc(sup_page_size, M_CTL, M_WAITOK | M_ZERO);
9391	pages = (struct scsi_vpd_supported_pages *)ctsio->kern_data_ptr;
9392	ctsio->kern_sg_entries = 0;
9393
9394	if (sup_page_size < alloc_len) {
9395		ctsio->residual = alloc_len - sup_page_size;
9396		ctsio->kern_data_len = sup_page_size;
9397		ctsio->kern_total_len = sup_page_size;
9398	} else {
9399		ctsio->residual = 0;
9400		ctsio->kern_data_len = alloc_len;
9401		ctsio->kern_total_len = alloc_len;
9402	}
9403	ctsio->kern_data_resid = 0;
9404	ctsio->kern_rel_offset = 0;
9405	ctsio->kern_sg_entries = 0;
9406
9407	/*
9408	 * The control device is always connected.  The disk device, on the
9409	 * other hand, may not be online all the time.  Need to change this
9410	 * to figure out whether the disk device is actually online or not.
9411	 */
9412	if (lun != NULL)
9413		pages->device = (SID_QUAL_LU_CONNECTED << 5) |
9414				lun->be_lun->lun_type;
9415	else
9416		pages->device = (SID_QUAL_LU_OFFLINE << 5) | T_DIRECT;
9417
9418	p = 0;
9419	/* Supported VPD pages */
9420	pages->page_list[p++] = SVPD_SUPPORTED_PAGES;
9421	/* Serial Number */
9422	pages->page_list[p++] = SVPD_UNIT_SERIAL_NUMBER;
9423	/* Device Identification */
9424	pages->page_list[p++] = SVPD_DEVICE_ID;
9425	/* Extended INQUIRY Data */
9426	pages->page_list[p++] = SVPD_EXTENDED_INQUIRY_DATA;
9427	/* Mode Page Policy */
9428	pages->page_list[p++] = SVPD_MODE_PAGE_POLICY;
9429	/* SCSI Ports */
9430	pages->page_list[p++] = SVPD_SCSI_PORTS;
9431	/* Third-party Copy */
9432	pages->page_list[p++] = SVPD_SCSI_TPC;
9433	if (lun != NULL && lun->be_lun->lun_type == T_DIRECT) {
9434		/* Block limits */
9435		pages->page_list[p++] = SVPD_BLOCK_LIMITS;
9436		/* Block Device Characteristics */
9437		pages->page_list[p++] = SVPD_BDC;
9438		/* Logical Block Provisioning */
9439		pages->page_list[p++] = SVPD_LBP;
9440	}
9441	pages->length = p;
9442
9443	ctl_set_success(ctsio);
9444	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
9445	ctsio->be_move_done = ctl_config_move_done;
9446	ctl_datamove((union ctl_io *)ctsio);
9447	return (CTL_RETVAL_COMPLETE);
9448}
9449
9450/*
9451 * SCSI VPD page 0x80, the Unit Serial Number page.
9452 */
9453static int
9454ctl_inquiry_evpd_serial(struct ctl_scsiio *ctsio, int alloc_len)
9455{
9456	struct scsi_vpd_unit_serial_number *sn_ptr;
9457	struct ctl_lun *lun;
9458	int data_len;
9459
9460	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
9461
9462	data_len = 4 + CTL_SN_LEN;
9463	ctsio->kern_data_ptr = malloc(data_len, M_CTL, M_WAITOK | M_ZERO);
9464	sn_ptr = (struct scsi_vpd_unit_serial_number *)ctsio->kern_data_ptr;
9465	if (data_len < alloc_len) {
9466		ctsio->residual = alloc_len - data_len;
9467		ctsio->kern_data_len = data_len;
9468		ctsio->kern_total_len = data_len;
9469	} else {
9470		ctsio->residual = 0;
9471		ctsio->kern_data_len = alloc_len;
9472		ctsio->kern_total_len = alloc_len;
9473	}
9474	ctsio->kern_data_resid = 0;
9475	ctsio->kern_rel_offset = 0;
9476	ctsio->kern_sg_entries = 0;
9477
9478	/*
9479	 * The control device is always connected.  The disk device, on the
9480	 * other hand, may not be online all the time.  Need to change this
9481	 * to figure out whether the disk device is actually online or not.
9482	 */
9483	if (lun != NULL)
9484		sn_ptr->device = (SID_QUAL_LU_CONNECTED << 5) |
9485				  lun->be_lun->lun_type;
9486	else
9487		sn_ptr->device = (SID_QUAL_LU_OFFLINE << 5) | T_DIRECT;
9488
9489	sn_ptr->page_code = SVPD_UNIT_SERIAL_NUMBER;
9490	sn_ptr->length = CTL_SN_LEN;
9491	/*
9492	 * If we don't have a LUN, we just leave the serial number as
9493	 * all spaces.
9494	 */
9495	if (lun != NULL) {
9496		strncpy((char *)sn_ptr->serial_num,
9497			(char *)lun->be_lun->serial_num, CTL_SN_LEN);
9498	} else
9499		memset(sn_ptr->serial_num, 0x20, CTL_SN_LEN);
9500
9501	ctl_set_success(ctsio);
9502	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
9503	ctsio->be_move_done = ctl_config_move_done;
9504	ctl_datamove((union ctl_io *)ctsio);
9505	return (CTL_RETVAL_COMPLETE);
9506}
9507
9508
9509/*
9510 * SCSI VPD page 0x86, the Extended INQUIRY Data page.
9511 */
9512static int
9513ctl_inquiry_evpd_eid(struct ctl_scsiio *ctsio, int alloc_len)
9514{
9515	struct scsi_vpd_extended_inquiry_data *eid_ptr;
9516	struct ctl_lun *lun;
9517	int data_len;
9518
9519	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
9520
9521	data_len = sizeof(struct scsi_vpd_extended_inquiry_data);
9522	ctsio->kern_data_ptr = malloc(data_len, M_CTL, M_WAITOK | M_ZERO);
9523	eid_ptr = (struct scsi_vpd_extended_inquiry_data *)ctsio->kern_data_ptr;
9524	ctsio->kern_sg_entries = 0;
9525
9526	if (data_len < alloc_len) {
9527		ctsio->residual = alloc_len - data_len;
9528		ctsio->kern_data_len = data_len;
9529		ctsio->kern_total_len = data_len;
9530	} else {
9531		ctsio->residual = 0;
9532		ctsio->kern_data_len = alloc_len;
9533		ctsio->kern_total_len = alloc_len;
9534	}
9535	ctsio->kern_data_resid = 0;
9536	ctsio->kern_rel_offset = 0;
9537	ctsio->kern_sg_entries = 0;
9538
9539	/*
9540	 * The control device is always connected.  The disk device, on the
9541	 * other hand, may not be online all the time.
9542	 */
9543	if (lun != NULL)
9544		eid_ptr->device = (SID_QUAL_LU_CONNECTED << 5) |
9545				     lun->be_lun->lun_type;
9546	else
9547		eid_ptr->device = (SID_QUAL_LU_OFFLINE << 5) | T_DIRECT;
9548	eid_ptr->page_code = SVPD_EXTENDED_INQUIRY_DATA;
9549	scsi_ulto2b(data_len - 4, eid_ptr->page_length);
9550	/*
9551	 * We support head of queue, ordered and simple tags.
9552	 */
9553	eid_ptr->flags2 = SVPD_EID_HEADSUP | SVPD_EID_ORDSUP | SVPD_EID_SIMPSUP;
9554	/*
9555	 * Volatile cache supported.
9556	 */
9557	eid_ptr->flags3 = SVPD_EID_V_SUP;
9558
9559	/*
9560	 * This means that we clear the REPORTED LUNS DATA HAS CHANGED unit
9561	 * attention for a particular IT nexus on all LUNs once we report
9562	 * it to that nexus once.  This bit is required as of SPC-4.
9563	 */
9564	eid_ptr->flags4 = SVPD_EID_LUICLT;
9565
9566	/*
9567	 * XXX KDM in order to correctly answer this, we would need
9568	 * information from the SIM to determine how much sense data it
9569	 * can send.  So this would really be a path inquiry field, most
9570	 * likely.  This can be set to a maximum of 252 according to SPC-4,
9571	 * but the hardware may or may not be able to support that much.
9572	 * 0 just means that the maximum sense data length is not reported.
9573	 */
9574	eid_ptr->max_sense_length = 0;
9575
9576	ctl_set_success(ctsio);
9577	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
9578	ctsio->be_move_done = ctl_config_move_done;
9579	ctl_datamove((union ctl_io *)ctsio);
9580	return (CTL_RETVAL_COMPLETE);
9581}
9582
9583static int
9584ctl_inquiry_evpd_mpp(struct ctl_scsiio *ctsio, int alloc_len)
9585{
9586	struct scsi_vpd_mode_page_policy *mpp_ptr;
9587	struct ctl_lun *lun;
9588	int data_len;
9589
9590	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
9591
9592	data_len = sizeof(struct scsi_vpd_mode_page_policy) +
9593	    sizeof(struct scsi_vpd_mode_page_policy_descr);
9594
9595	ctsio->kern_data_ptr = malloc(data_len, M_CTL, M_WAITOK | M_ZERO);
9596	mpp_ptr = (struct scsi_vpd_mode_page_policy *)ctsio->kern_data_ptr;
9597	ctsio->kern_sg_entries = 0;
9598
9599	if (data_len < alloc_len) {
9600		ctsio->residual = alloc_len - data_len;
9601		ctsio->kern_data_len = data_len;
9602		ctsio->kern_total_len = data_len;
9603	} else {
9604		ctsio->residual = 0;
9605		ctsio->kern_data_len = alloc_len;
9606		ctsio->kern_total_len = alloc_len;
9607	}
9608	ctsio->kern_data_resid = 0;
9609	ctsio->kern_rel_offset = 0;
9610	ctsio->kern_sg_entries = 0;
9611
9612	/*
9613	 * The control device is always connected.  The disk device, on the
9614	 * other hand, may not be online all the time.
9615	 */
9616	if (lun != NULL)
9617		mpp_ptr->device = (SID_QUAL_LU_CONNECTED << 5) |
9618				     lun->be_lun->lun_type;
9619	else
9620		mpp_ptr->device = (SID_QUAL_LU_OFFLINE << 5) | T_DIRECT;
9621	mpp_ptr->page_code = SVPD_MODE_PAGE_POLICY;
9622	scsi_ulto2b(data_len - 4, mpp_ptr->page_length);
9623	mpp_ptr->descr[0].page_code = 0x3f;
9624	mpp_ptr->descr[0].subpage_code = 0xff;
9625	mpp_ptr->descr[0].policy = SVPD_MPP_SHARED;
9626
9627	ctl_set_success(ctsio);
9628	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
9629	ctsio->be_move_done = ctl_config_move_done;
9630	ctl_datamove((union ctl_io *)ctsio);
9631	return (CTL_RETVAL_COMPLETE);
9632}
9633
9634/*
9635 * SCSI VPD page 0x83, the Device Identification page.
9636 */
9637static int
9638ctl_inquiry_evpd_devid(struct ctl_scsiio *ctsio, int alloc_len)
9639{
9640	struct scsi_vpd_device_id *devid_ptr;
9641	struct scsi_vpd_id_descriptor *desc;
9642	struct ctl_softc *softc;
9643	struct ctl_lun *lun;
9644	struct ctl_port *port;
9645	int data_len, g;
9646	uint8_t proto;
9647
9648	softc = control_softc;
9649
9650	port = ctl_io_port(&ctsio->io_hdr);
9651	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
9652
9653	data_len = sizeof(struct scsi_vpd_device_id) +
9654	    sizeof(struct scsi_vpd_id_descriptor) +
9655		sizeof(struct scsi_vpd_id_rel_trgt_port_id) +
9656	    sizeof(struct scsi_vpd_id_descriptor) +
9657		sizeof(struct scsi_vpd_id_trgt_port_grp_id);
9658	if (lun && lun->lun_devid)
9659		data_len += lun->lun_devid->len;
9660	if (port && port->port_devid)
9661		data_len += port->port_devid->len;
9662	if (port && port->target_devid)
9663		data_len += port->target_devid->len;
9664
9665	ctsio->kern_data_ptr = malloc(data_len, M_CTL, M_WAITOK | M_ZERO);
9666	devid_ptr = (struct scsi_vpd_device_id *)ctsio->kern_data_ptr;
9667	ctsio->kern_sg_entries = 0;
9668
9669	if (data_len < alloc_len) {
9670		ctsio->residual = alloc_len - data_len;
9671		ctsio->kern_data_len = data_len;
9672		ctsio->kern_total_len = data_len;
9673	} else {
9674		ctsio->residual = 0;
9675		ctsio->kern_data_len = alloc_len;
9676		ctsio->kern_total_len = alloc_len;
9677	}
9678	ctsio->kern_data_resid = 0;
9679	ctsio->kern_rel_offset = 0;
9680	ctsio->kern_sg_entries = 0;
9681
9682	/*
9683	 * The control device is always connected.  The disk device, on the
9684	 * other hand, may not be online all the time.
9685	 */
9686	if (lun != NULL)
9687		devid_ptr->device = (SID_QUAL_LU_CONNECTED << 5) |
9688				     lun->be_lun->lun_type;
9689	else
9690		devid_ptr->device = (SID_QUAL_LU_OFFLINE << 5) | T_DIRECT;
9691	devid_ptr->page_code = SVPD_DEVICE_ID;
9692	scsi_ulto2b(data_len - 4, devid_ptr->length);
9693
9694	if (port && port->port_type == CTL_PORT_FC)
9695		proto = SCSI_PROTO_FC << 4;
9696	else if (port && port->port_type == CTL_PORT_ISCSI)
9697		proto = SCSI_PROTO_ISCSI << 4;
9698	else
9699		proto = SCSI_PROTO_SPI << 4;
9700	desc = (struct scsi_vpd_id_descriptor *)devid_ptr->desc_list;
9701
9702	/*
9703	 * We're using a LUN association here.  i.e., this device ID is a
9704	 * per-LUN identifier.
9705	 */
9706	if (lun && lun->lun_devid) {
9707		memcpy(desc, lun->lun_devid->data, lun->lun_devid->len);
9708		desc = (struct scsi_vpd_id_descriptor *)((uint8_t *)desc +
9709		    lun->lun_devid->len);
9710	}
9711
9712	/*
9713	 * This is for the WWPN which is a port association.
9714	 */
9715	if (port && port->port_devid) {
9716		memcpy(desc, port->port_devid->data, port->port_devid->len);
9717		desc = (struct scsi_vpd_id_descriptor *)((uint8_t *)desc +
9718		    port->port_devid->len);
9719	}
9720
9721	/*
9722	 * This is for the Relative Target Port(type 4h) identifier
9723	 */
9724	desc->proto_codeset = proto | SVPD_ID_CODESET_BINARY;
9725	desc->id_type = SVPD_ID_PIV | SVPD_ID_ASSOC_PORT |
9726	    SVPD_ID_TYPE_RELTARG;
9727	desc->length = 4;
9728	scsi_ulto2b(ctsio->io_hdr.nexus.targ_port, &desc->identifier[2]);
9729	desc = (struct scsi_vpd_id_descriptor *)(&desc->identifier[0] +
9730	    sizeof(struct scsi_vpd_id_rel_trgt_port_id));
9731
9732	/*
9733	 * This is for the Target Port Group(type 5h) identifier
9734	 */
9735	desc->proto_codeset = proto | SVPD_ID_CODESET_BINARY;
9736	desc->id_type = SVPD_ID_PIV | SVPD_ID_ASSOC_PORT |
9737	    SVPD_ID_TYPE_TPORTGRP;
9738	desc->length = 4;
9739	if (softc->is_single ||
9740	    (port && port->status & CTL_PORT_STATUS_HA_SHARED))
9741		g = 1;
9742	else
9743		g = 2 + ctsio->io_hdr.nexus.targ_port / softc->port_cnt;
9744	scsi_ulto2b(g, &desc->identifier[2]);
9745	desc = (struct scsi_vpd_id_descriptor *)(&desc->identifier[0] +
9746	    sizeof(struct scsi_vpd_id_trgt_port_grp_id));
9747
9748	/*
9749	 * This is for the Target identifier
9750	 */
9751	if (port && port->target_devid) {
9752		memcpy(desc, port->target_devid->data, port->target_devid->len);
9753	}
9754
9755	ctl_set_success(ctsio);
9756	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
9757	ctsio->be_move_done = ctl_config_move_done;
9758	ctl_datamove((union ctl_io *)ctsio);
9759	return (CTL_RETVAL_COMPLETE);
9760}
9761
9762static int
9763ctl_inquiry_evpd_scsi_ports(struct ctl_scsiio *ctsio, int alloc_len)
9764{
9765	struct ctl_softc *softc = control_softc;
9766	struct scsi_vpd_scsi_ports *sp;
9767	struct scsi_vpd_port_designation *pd;
9768	struct scsi_vpd_port_designation_cont *pdc;
9769	struct ctl_lun *lun;
9770	struct ctl_port *port;
9771	int data_len, num_target_ports, iid_len, id_len;
9772
9773	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
9774
9775	num_target_ports = 0;
9776	iid_len = 0;
9777	id_len = 0;
9778	mtx_lock(&softc->ctl_lock);
9779	STAILQ_FOREACH(port, &softc->port_list, links) {
9780		if ((port->status & CTL_PORT_STATUS_ONLINE) == 0)
9781			continue;
9782		if (lun != NULL &&
9783		    ctl_lun_map_to_port(port, lun->lun) >= CTL_MAX_LUNS)
9784			continue;
9785		num_target_ports++;
9786		if (port->init_devid)
9787			iid_len += port->init_devid->len;
9788		if (port->port_devid)
9789			id_len += port->port_devid->len;
9790	}
9791	mtx_unlock(&softc->ctl_lock);
9792
9793	data_len = sizeof(struct scsi_vpd_scsi_ports) +
9794	    num_target_ports * (sizeof(struct scsi_vpd_port_designation) +
9795	     sizeof(struct scsi_vpd_port_designation_cont)) + iid_len + id_len;
9796	ctsio->kern_data_ptr = malloc(data_len, M_CTL, M_WAITOK | M_ZERO);
9797	sp = (struct scsi_vpd_scsi_ports *)ctsio->kern_data_ptr;
9798	ctsio->kern_sg_entries = 0;
9799
9800	if (data_len < alloc_len) {
9801		ctsio->residual = alloc_len - data_len;
9802		ctsio->kern_data_len = data_len;
9803		ctsio->kern_total_len = data_len;
9804	} else {
9805		ctsio->residual = 0;
9806		ctsio->kern_data_len = alloc_len;
9807		ctsio->kern_total_len = alloc_len;
9808	}
9809	ctsio->kern_data_resid = 0;
9810	ctsio->kern_rel_offset = 0;
9811	ctsio->kern_sg_entries = 0;
9812
9813	/*
9814	 * The control device is always connected.  The disk device, on the
9815	 * other hand, may not be online all the time.  Need to change this
9816	 * to figure out whether the disk device is actually online or not.
9817	 */
9818	if (lun != NULL)
9819		sp->device = (SID_QUAL_LU_CONNECTED << 5) |
9820				  lun->be_lun->lun_type;
9821	else
9822		sp->device = (SID_QUAL_LU_OFFLINE << 5) | T_DIRECT;
9823
9824	sp->page_code = SVPD_SCSI_PORTS;
9825	scsi_ulto2b(data_len - sizeof(struct scsi_vpd_scsi_ports),
9826	    sp->page_length);
9827	pd = &sp->design[0];
9828
9829	mtx_lock(&softc->ctl_lock);
9830	STAILQ_FOREACH(port, &softc->port_list, links) {
9831		if ((port->status & CTL_PORT_STATUS_ONLINE) == 0)
9832			continue;
9833		if (lun != NULL &&
9834		    ctl_lun_map_to_port(port, lun->lun) >= CTL_MAX_LUNS)
9835			continue;
9836		scsi_ulto2b(port->targ_port, pd->relative_port_id);
9837		if (port->init_devid) {
9838			iid_len = port->init_devid->len;
9839			memcpy(pd->initiator_transportid,
9840			    port->init_devid->data, port->init_devid->len);
9841		} else
9842			iid_len = 0;
9843		scsi_ulto2b(iid_len, pd->initiator_transportid_length);
9844		pdc = (struct scsi_vpd_port_designation_cont *)
9845		    (&pd->initiator_transportid[iid_len]);
9846		if (port->port_devid) {
9847			id_len = port->port_devid->len;
9848			memcpy(pdc->target_port_descriptors,
9849			    port->port_devid->data, port->port_devid->len);
9850		} else
9851			id_len = 0;
9852		scsi_ulto2b(id_len, pdc->target_port_descriptors_length);
9853		pd = (struct scsi_vpd_port_designation *)
9854		    ((uint8_t *)pdc->target_port_descriptors + id_len);
9855	}
9856	mtx_unlock(&softc->ctl_lock);
9857
9858	ctl_set_success(ctsio);
9859	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
9860	ctsio->be_move_done = ctl_config_move_done;
9861	ctl_datamove((union ctl_io *)ctsio);
9862	return (CTL_RETVAL_COMPLETE);
9863}
9864
9865static int
9866ctl_inquiry_evpd_block_limits(struct ctl_scsiio *ctsio, int alloc_len)
9867{
9868	struct scsi_vpd_block_limits *bl_ptr;
9869	struct ctl_lun *lun;
9870	uint64_t ival;
9871
9872	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
9873
9874	ctsio->kern_data_ptr = malloc(sizeof(*bl_ptr), M_CTL, M_WAITOK | M_ZERO);
9875	bl_ptr = (struct scsi_vpd_block_limits *)ctsio->kern_data_ptr;
9876	ctsio->kern_sg_entries = 0;
9877
9878	if (sizeof(*bl_ptr) < alloc_len) {
9879		ctsio->residual = alloc_len - sizeof(*bl_ptr);
9880		ctsio->kern_data_len = sizeof(*bl_ptr);
9881		ctsio->kern_total_len = sizeof(*bl_ptr);
9882	} else {
9883		ctsio->residual = 0;
9884		ctsio->kern_data_len = alloc_len;
9885		ctsio->kern_total_len = alloc_len;
9886	}
9887	ctsio->kern_data_resid = 0;
9888	ctsio->kern_rel_offset = 0;
9889	ctsio->kern_sg_entries = 0;
9890
9891	/*
9892	 * The control device is always connected.  The disk device, on the
9893	 * other hand, may not be online all the time.  Need to change this
9894	 * to figure out whether the disk device is actually online or not.
9895	 */
9896	if (lun != NULL)
9897		bl_ptr->device = (SID_QUAL_LU_CONNECTED << 5) |
9898				  lun->be_lun->lun_type;
9899	else
9900		bl_ptr->device = (SID_QUAL_LU_OFFLINE << 5) | T_DIRECT;
9901
9902	bl_ptr->page_code = SVPD_BLOCK_LIMITS;
9903	scsi_ulto2b(sizeof(*bl_ptr) - 4, bl_ptr->page_length);
9904	bl_ptr->max_cmp_write_len = 0xff;
9905	scsi_ulto4b(0xffffffff, bl_ptr->max_txfer_len);
9906	if (lun != NULL) {
9907		scsi_ulto4b(lun->be_lun->opttxferlen, bl_ptr->opt_txfer_len);
9908		if (lun->be_lun->flags & CTL_LUN_FLAG_UNMAP) {
9909			ival = 0xffffffff;
9910			ctl_get_opt_number(&lun->be_lun->options,
9911			    "unmap_max_lba", &ival);
9912			scsi_ulto4b(ival, bl_ptr->max_unmap_lba_cnt);
9913			ival = 0xffffffff;
9914			ctl_get_opt_number(&lun->be_lun->options,
9915			    "unmap_max_descr", &ival);
9916			scsi_ulto4b(ival, bl_ptr->max_unmap_blk_cnt);
9917			if (lun->be_lun->ublockexp != 0) {
9918				scsi_ulto4b((1 << lun->be_lun->ublockexp),
9919				    bl_ptr->opt_unmap_grain);
9920				scsi_ulto4b(0x80000000 | lun->be_lun->ublockoff,
9921				    bl_ptr->unmap_grain_align);
9922			}
9923		}
9924		scsi_ulto4b(lun->be_lun->atomicblock,
9925		    bl_ptr->max_atomic_transfer_length);
9926		scsi_ulto4b(0, bl_ptr->atomic_alignment);
9927		scsi_ulto4b(0, bl_ptr->atomic_transfer_length_granularity);
9928		scsi_ulto4b(0, bl_ptr->max_atomic_transfer_length_with_atomic_boundary);
9929		scsi_ulto4b(0, bl_ptr->max_atomic_boundary_size);
9930		ival = UINT64_MAX;
9931		ctl_get_opt_number(&lun->be_lun->options, "write_same_max_lba", &ival);
9932		scsi_u64to8b(ival, bl_ptr->max_write_same_length);
9933	}
9934
9935	ctl_set_success(ctsio);
9936	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
9937	ctsio->be_move_done = ctl_config_move_done;
9938	ctl_datamove((union ctl_io *)ctsio);
9939	return (CTL_RETVAL_COMPLETE);
9940}
9941
9942static int
9943ctl_inquiry_evpd_bdc(struct ctl_scsiio *ctsio, int alloc_len)
9944{
9945	struct scsi_vpd_block_device_characteristics *bdc_ptr;
9946	struct ctl_lun *lun;
9947	const char *value;
9948	u_int i;
9949
9950	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
9951
9952	ctsio->kern_data_ptr = malloc(sizeof(*bdc_ptr), M_CTL, M_WAITOK | M_ZERO);
9953	bdc_ptr = (struct scsi_vpd_block_device_characteristics *)ctsio->kern_data_ptr;
9954	ctsio->kern_sg_entries = 0;
9955
9956	if (sizeof(*bdc_ptr) < alloc_len) {
9957		ctsio->residual = alloc_len - sizeof(*bdc_ptr);
9958		ctsio->kern_data_len = sizeof(*bdc_ptr);
9959		ctsio->kern_total_len = sizeof(*bdc_ptr);
9960	} else {
9961		ctsio->residual = 0;
9962		ctsio->kern_data_len = alloc_len;
9963		ctsio->kern_total_len = alloc_len;
9964	}
9965	ctsio->kern_data_resid = 0;
9966	ctsio->kern_rel_offset = 0;
9967	ctsio->kern_sg_entries = 0;
9968
9969	/*
9970	 * The control device is always connected.  The disk device, on the
9971	 * other hand, may not be online all the time.  Need to change this
9972	 * to figure out whether the disk device is actually online or not.
9973	 */
9974	if (lun != NULL)
9975		bdc_ptr->device = (SID_QUAL_LU_CONNECTED << 5) |
9976				  lun->be_lun->lun_type;
9977	else
9978		bdc_ptr->device = (SID_QUAL_LU_OFFLINE << 5) | T_DIRECT;
9979	bdc_ptr->page_code = SVPD_BDC;
9980	scsi_ulto2b(sizeof(*bdc_ptr) - 4, bdc_ptr->page_length);
9981	if (lun != NULL &&
9982	    (value = ctl_get_opt(&lun->be_lun->options, "rpm")) != NULL)
9983		i = strtol(value, NULL, 0);
9984	else
9985		i = CTL_DEFAULT_ROTATION_RATE;
9986	scsi_ulto2b(i, bdc_ptr->medium_rotation_rate);
9987	if (lun != NULL &&
9988	    (value = ctl_get_opt(&lun->be_lun->options, "formfactor")) != NULL)
9989		i = strtol(value, NULL, 0);
9990	else
9991		i = 0;
9992	bdc_ptr->wab_wac_ff = (i & 0x0f);
9993	bdc_ptr->flags = SVPD_FUAB | SVPD_VBULS;
9994
9995	ctl_set_success(ctsio);
9996	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
9997	ctsio->be_move_done = ctl_config_move_done;
9998	ctl_datamove((union ctl_io *)ctsio);
9999	return (CTL_RETVAL_COMPLETE);
10000}
10001
10002static int
10003ctl_inquiry_evpd_lbp(struct ctl_scsiio *ctsio, int alloc_len)
10004{
10005	struct scsi_vpd_logical_block_prov *lbp_ptr;
10006	struct ctl_lun *lun;
10007	const char *value;
10008
10009	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
10010
10011	ctsio->kern_data_ptr = malloc(sizeof(*lbp_ptr), M_CTL, M_WAITOK | M_ZERO);
10012	lbp_ptr = (struct scsi_vpd_logical_block_prov *)ctsio->kern_data_ptr;
10013	ctsio->kern_sg_entries = 0;
10014
10015	if (sizeof(*lbp_ptr) < alloc_len) {
10016		ctsio->residual = alloc_len - sizeof(*lbp_ptr);
10017		ctsio->kern_data_len = sizeof(*lbp_ptr);
10018		ctsio->kern_total_len = sizeof(*lbp_ptr);
10019	} else {
10020		ctsio->residual = 0;
10021		ctsio->kern_data_len = alloc_len;
10022		ctsio->kern_total_len = alloc_len;
10023	}
10024	ctsio->kern_data_resid = 0;
10025	ctsio->kern_rel_offset = 0;
10026	ctsio->kern_sg_entries = 0;
10027
10028	/*
10029	 * The control device is always connected.  The disk device, on the
10030	 * other hand, may not be online all the time.  Need to change this
10031	 * to figure out whether the disk device is actually online or not.
10032	 */
10033	if (lun != NULL)
10034		lbp_ptr->device = (SID_QUAL_LU_CONNECTED << 5) |
10035				  lun->be_lun->lun_type;
10036	else
10037		lbp_ptr->device = (SID_QUAL_LU_OFFLINE << 5) | T_DIRECT;
10038
10039	lbp_ptr->page_code = SVPD_LBP;
10040	scsi_ulto2b(sizeof(*lbp_ptr) - 4, lbp_ptr->page_length);
10041	lbp_ptr->threshold_exponent = CTL_LBP_EXPONENT;
10042	if (lun != NULL && lun->be_lun->flags & CTL_LUN_FLAG_UNMAP) {
10043		lbp_ptr->flags = SVPD_LBP_UNMAP | SVPD_LBP_WS16 |
10044		    SVPD_LBP_WS10 | SVPD_LBP_RZ | SVPD_LBP_ANC_SUP;
10045		value = ctl_get_opt(&lun->be_lun->options, "provisioning_type");
10046		if (value != NULL) {
10047			if (strcmp(value, "resource") == 0)
10048				lbp_ptr->prov_type = SVPD_LBP_RESOURCE;
10049			else if (strcmp(value, "thin") == 0)
10050				lbp_ptr->prov_type = SVPD_LBP_THIN;
10051		} else
10052			lbp_ptr->prov_type = SVPD_LBP_THIN;
10053	}
10054
10055	ctl_set_success(ctsio);
10056	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
10057	ctsio->be_move_done = ctl_config_move_done;
10058	ctl_datamove((union ctl_io *)ctsio);
10059	return (CTL_RETVAL_COMPLETE);
10060}
10061
10062/*
10063 * INQUIRY with the EVPD bit set.
10064 */
10065static int
10066ctl_inquiry_evpd(struct ctl_scsiio *ctsio)
10067{
10068	struct ctl_lun *lun;
10069	struct scsi_inquiry *cdb;
10070	int alloc_len, retval;
10071
10072	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
10073	cdb = (struct scsi_inquiry *)ctsio->cdb;
10074	alloc_len = scsi_2btoul(cdb->length);
10075
10076	switch (cdb->page_code) {
10077	case SVPD_SUPPORTED_PAGES:
10078		retval = ctl_inquiry_evpd_supported(ctsio, alloc_len);
10079		break;
10080	case SVPD_UNIT_SERIAL_NUMBER:
10081		retval = ctl_inquiry_evpd_serial(ctsio, alloc_len);
10082		break;
10083	case SVPD_DEVICE_ID:
10084		retval = ctl_inquiry_evpd_devid(ctsio, alloc_len);
10085		break;
10086	case SVPD_EXTENDED_INQUIRY_DATA:
10087		retval = ctl_inquiry_evpd_eid(ctsio, alloc_len);
10088		break;
10089	case SVPD_MODE_PAGE_POLICY:
10090		retval = ctl_inquiry_evpd_mpp(ctsio, alloc_len);
10091		break;
10092	case SVPD_SCSI_PORTS:
10093		retval = ctl_inquiry_evpd_scsi_ports(ctsio, alloc_len);
10094		break;
10095	case SVPD_SCSI_TPC:
10096		retval = ctl_inquiry_evpd_tpc(ctsio, alloc_len);
10097		break;
10098	case SVPD_BLOCK_LIMITS:
10099		if (lun == NULL || lun->be_lun->lun_type != T_DIRECT)
10100			goto err;
10101		retval = ctl_inquiry_evpd_block_limits(ctsio, alloc_len);
10102		break;
10103	case SVPD_BDC:
10104		if (lun == NULL || lun->be_lun->lun_type != T_DIRECT)
10105			goto err;
10106		retval = ctl_inquiry_evpd_bdc(ctsio, alloc_len);
10107		break;
10108	case SVPD_LBP:
10109		if (lun == NULL || lun->be_lun->lun_type != T_DIRECT)
10110			goto err;
10111		retval = ctl_inquiry_evpd_lbp(ctsio, alloc_len);
10112		break;
10113	default:
10114err:
10115		ctl_set_invalid_field(ctsio,
10116				      /*sks_valid*/ 1,
10117				      /*command*/ 1,
10118				      /*field*/ 2,
10119				      /*bit_valid*/ 0,
10120				      /*bit*/ 0);
10121		ctl_done((union ctl_io *)ctsio);
10122		retval = CTL_RETVAL_COMPLETE;
10123		break;
10124	}
10125
10126	return (retval);
10127}
10128
10129/*
10130 * Standard INQUIRY data.
10131 */
10132static int
10133ctl_inquiry_std(struct ctl_scsiio *ctsio)
10134{
10135	struct scsi_inquiry_data *inq_ptr;
10136	struct scsi_inquiry *cdb;
10137	struct ctl_softc *softc = control_softc;
10138	struct ctl_port *port;
10139	struct ctl_lun *lun;
10140	char *val;
10141	uint32_t alloc_len, data_len;
10142	ctl_port_type port_type;
10143
10144	port = ctl_io_port(&ctsio->io_hdr);
10145	port_type = port->port_type;
10146	if (port_type == CTL_PORT_IOCTL || port_type == CTL_PORT_INTERNAL)
10147		port_type = CTL_PORT_SCSI;
10148
10149	lun = ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
10150	cdb = (struct scsi_inquiry *)ctsio->cdb;
10151	alloc_len = scsi_2btoul(cdb->length);
10152
10153	/*
10154	 * We malloc the full inquiry data size here and fill it
10155	 * in.  If the user only asks for less, we'll give him
10156	 * that much.
10157	 */
10158	data_len = offsetof(struct scsi_inquiry_data, vendor_specific1);
10159	ctsio->kern_data_ptr = malloc(data_len, M_CTL, M_WAITOK | M_ZERO);
10160	inq_ptr = (struct scsi_inquiry_data *)ctsio->kern_data_ptr;
10161	ctsio->kern_sg_entries = 0;
10162	ctsio->kern_data_resid = 0;
10163	ctsio->kern_rel_offset = 0;
10164
10165	if (data_len < alloc_len) {
10166		ctsio->residual = alloc_len - data_len;
10167		ctsio->kern_data_len = data_len;
10168		ctsio->kern_total_len = data_len;
10169	} else {
10170		ctsio->residual = 0;
10171		ctsio->kern_data_len = alloc_len;
10172		ctsio->kern_total_len = alloc_len;
10173	}
10174
10175	if (lun != NULL) {
10176		if ((lun->flags & CTL_LUN_PRIMARY_SC) ||
10177		    softc->ha_link >= CTL_HA_LINK_UNKNOWN) {
10178			inq_ptr->device = (SID_QUAL_LU_CONNECTED << 5) |
10179			    lun->be_lun->lun_type;
10180		} else {
10181			inq_ptr->device = (SID_QUAL_LU_OFFLINE << 5) |
10182			    lun->be_lun->lun_type;
10183		}
10184		if (lun->flags & CTL_LUN_REMOVABLE)
10185			inq_ptr->dev_qual2 |= SID_RMB;
10186	} else
10187		inq_ptr->device = (SID_QUAL_BAD_LU << 5) | T_NODEVICE;
10188
10189	/* RMB in byte 2 is 0 */
10190	inq_ptr->version = SCSI_REV_SPC4;
10191
10192	/*
10193	 * According to SAM-3, even if a device only supports a single
10194	 * level of LUN addressing, it should still set the HISUP bit:
10195	 *
10196	 * 4.9.1 Logical unit numbers overview
10197	 *
10198	 * All logical unit number formats described in this standard are
10199	 * hierarchical in structure even when only a single level in that
10200	 * hierarchy is used. The HISUP bit shall be set to one in the
10201	 * standard INQUIRY data (see SPC-2) when any logical unit number
10202	 * format described in this standard is used.  Non-hierarchical
10203	 * formats are outside the scope of this standard.
10204	 *
10205	 * Therefore we set the HiSup bit here.
10206	 *
10207	 * The response format is 2, per SPC-3.
10208	 */
10209	inq_ptr->response_format = SID_HiSup | 2;
10210
10211	inq_ptr->additional_length = data_len -
10212	    (offsetof(struct scsi_inquiry_data, additional_length) + 1);
10213	CTL_DEBUG_PRINT(("additional_length = %d\n",
10214			 inq_ptr->additional_length));
10215
10216	inq_ptr->spc3_flags = SPC3_SID_3PC | SPC3_SID_TPGS_IMPLICIT;
10217	if (port_type == CTL_PORT_SCSI)
10218		inq_ptr->spc2_flags = SPC2_SID_ADDR16;
10219	inq_ptr->spc2_flags |= SPC2_SID_MultiP;
10220	inq_ptr->flags = SID_CmdQue;
10221	if (port_type == CTL_PORT_SCSI)
10222		inq_ptr->flags |= SID_WBus16 | SID_Sync;
10223
10224	/*
10225	 * Per SPC-3, unused bytes in ASCII strings are filled with spaces.
10226	 * We have 8 bytes for the vendor name, and 16 bytes for the device
10227	 * name and 4 bytes for the revision.
10228	 */
10229	if (lun == NULL || (val = ctl_get_opt(&lun->be_lun->options,
10230	    "vendor")) == NULL) {
10231		strncpy(inq_ptr->vendor, CTL_VENDOR, sizeof(inq_ptr->vendor));
10232	} else {
10233		memset(inq_ptr->vendor, ' ', sizeof(inq_ptr->vendor));
10234		strncpy(inq_ptr->vendor, val,
10235		    min(sizeof(inq_ptr->vendor), strlen(val)));
10236	}
10237	if (lun == NULL) {
10238		strncpy(inq_ptr->product, CTL_DIRECT_PRODUCT,
10239		    sizeof(inq_ptr->product));
10240	} else if ((val = ctl_get_opt(&lun->be_lun->options, "product")) == NULL) {
10241		switch (lun->be_lun->lun_type) {
10242		case T_DIRECT:
10243			strncpy(inq_ptr->product, CTL_DIRECT_PRODUCT,
10244			    sizeof(inq_ptr->product));
10245			break;
10246		case T_PROCESSOR:
10247			strncpy(inq_ptr->product, CTL_PROCESSOR_PRODUCT,
10248			    sizeof(inq_ptr->product));
10249			break;
10250		case T_CDROM:
10251			strncpy(inq_ptr->product, CTL_CDROM_PRODUCT,
10252			    sizeof(inq_ptr->product));
10253			break;
10254		default:
10255			strncpy(inq_ptr->product, CTL_UNKNOWN_PRODUCT,
10256			    sizeof(inq_ptr->product));
10257			break;
10258		}
10259	} else {
10260		memset(inq_ptr->product, ' ', sizeof(inq_ptr->product));
10261		strncpy(inq_ptr->product, val,
10262		    min(sizeof(inq_ptr->product), strlen(val)));
10263	}
10264
10265	/*
10266	 * XXX make this a macro somewhere so it automatically gets
10267	 * incremented when we make changes.
10268	 */
10269	if (lun == NULL || (val = ctl_get_opt(&lun->be_lun->options,
10270	    "revision")) == NULL) {
10271		strncpy(inq_ptr->revision, "0001", sizeof(inq_ptr->revision));
10272	} else {
10273		memset(inq_ptr->revision, ' ', sizeof(inq_ptr->revision));
10274		strncpy(inq_ptr->revision, val,
10275		    min(sizeof(inq_ptr->revision), strlen(val)));
10276	}
10277
10278	/*
10279	 * For parallel SCSI, we support double transition and single
10280	 * transition clocking.  We also support QAS (Quick Arbitration
10281	 * and Selection) and Information Unit transfers on both the
10282	 * control and array devices.
10283	 */
10284	if (port_type == CTL_PORT_SCSI)
10285		inq_ptr->spi3data = SID_SPI_CLOCK_DT_ST | SID_SPI_QAS |
10286				    SID_SPI_IUS;
10287
10288	/* SAM-5 (no version claimed) */
10289	scsi_ulto2b(0x00A0, inq_ptr->version1);
10290	/* SPC-4 (no version claimed) */
10291	scsi_ulto2b(0x0460, inq_ptr->version2);
10292	if (port_type == CTL_PORT_FC) {
10293		/* FCP-2 ANSI INCITS.350:2003 */
10294		scsi_ulto2b(0x0917, inq_ptr->version3);
10295	} else if (port_type == CTL_PORT_SCSI) {
10296		/* SPI-4 ANSI INCITS.362:200x */
10297		scsi_ulto2b(0x0B56, inq_ptr->version3);
10298	} else if (port_type == CTL_PORT_ISCSI) {
10299		/* iSCSI (no version claimed) */
10300		scsi_ulto2b(0x0960, inq_ptr->version3);
10301	} else if (port_type == CTL_PORT_SAS) {
10302		/* SAS (no version claimed) */
10303		scsi_ulto2b(0x0BE0, inq_ptr->version3);
10304	}
10305
10306	if (lun == NULL) {
10307		/* SBC-4 (no version claimed) */
10308		scsi_ulto2b(0x0600, inq_ptr->version4);
10309	} else {
10310		switch (lun->be_lun->lun_type) {
10311		case T_DIRECT:
10312			/* SBC-4 (no version claimed) */
10313			scsi_ulto2b(0x0600, inq_ptr->version4);
10314			break;
10315		case T_PROCESSOR:
10316			break;
10317		case T_CDROM:
10318			/* MMC-6 (no version claimed) */
10319			scsi_ulto2b(0x04E0, inq_ptr->version4);
10320			break;
10321		default:
10322			break;
10323		}
10324	}
10325
10326	ctl_set_success(ctsio);
10327	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
10328	ctsio->be_move_done = ctl_config_move_done;
10329	ctl_datamove((union ctl_io *)ctsio);
10330	return (CTL_RETVAL_COMPLETE);
10331}
10332
10333int
10334ctl_inquiry(struct ctl_scsiio *ctsio)
10335{
10336	struct scsi_inquiry *cdb;
10337	int retval;
10338
10339	CTL_DEBUG_PRINT(("ctl_inquiry\n"));
10340
10341	cdb = (struct scsi_inquiry *)ctsio->cdb;
10342	if (cdb->byte2 & SI_EVPD)
10343		retval = ctl_inquiry_evpd(ctsio);
10344	else if (cdb->page_code == 0)
10345		retval = ctl_inquiry_std(ctsio);
10346	else {
10347		ctl_set_invalid_field(ctsio,
10348				      /*sks_valid*/ 1,
10349				      /*command*/ 1,
10350				      /*field*/ 2,
10351				      /*bit_valid*/ 0,
10352				      /*bit*/ 0);
10353		ctl_done((union ctl_io *)ctsio);
10354		return (CTL_RETVAL_COMPLETE);
10355	}
10356
10357	return (retval);
10358}
10359
10360int
10361ctl_get_config(struct ctl_scsiio *ctsio)
10362{
10363	struct scsi_get_config_header *hdr;
10364	struct scsi_get_config_feature *feature;
10365	struct scsi_get_config *cdb;
10366	struct ctl_lun *lun;
10367	uint32_t alloc_len, data_len;
10368	int rt, starting;
10369
10370	lun = ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
10371	cdb = (struct scsi_get_config *)ctsio->cdb;
10372	rt = (cdb->rt & SGC_RT_MASK);
10373	starting = scsi_2btoul(cdb->starting_feature);
10374	alloc_len = scsi_2btoul(cdb->length);
10375
10376	data_len = sizeof(struct scsi_get_config_header) +
10377	    sizeof(struct scsi_get_config_feature) + 8 +
10378	    sizeof(struct scsi_get_config_feature) + 8 +
10379	    sizeof(struct scsi_get_config_feature) + 4 +
10380	    sizeof(struct scsi_get_config_feature) + 4 +
10381	    sizeof(struct scsi_get_config_feature) + 8 +
10382	    sizeof(struct scsi_get_config_feature) +
10383	    sizeof(struct scsi_get_config_feature) + 4 +
10384	    sizeof(struct scsi_get_config_feature) + 4 +
10385	    sizeof(struct scsi_get_config_feature) + 4 +
10386	    sizeof(struct scsi_get_config_feature) + 4 +
10387	    sizeof(struct scsi_get_config_feature) + 4 +
10388	    sizeof(struct scsi_get_config_feature) + 4;
10389	ctsio->kern_data_ptr = malloc(data_len, M_CTL, M_WAITOK | M_ZERO);
10390	ctsio->kern_sg_entries = 0;
10391	ctsio->kern_data_resid = 0;
10392	ctsio->kern_rel_offset = 0;
10393
10394	hdr = (struct scsi_get_config_header *)ctsio->kern_data_ptr;
10395	if (lun->flags & CTL_LUN_NO_MEDIA)
10396		scsi_ulto2b(0x0000, hdr->current_profile);
10397	else
10398		scsi_ulto2b(0x0010, hdr->current_profile);
10399	feature = (struct scsi_get_config_feature *)(hdr + 1);
10400
10401	if (starting > 0x003b)
10402		goto done;
10403	if (starting > 0x003a)
10404		goto f3b;
10405	if (starting > 0x002b)
10406		goto f3a;
10407	if (starting > 0x002a)
10408		goto f2b;
10409	if (starting > 0x001f)
10410		goto f2a;
10411	if (starting > 0x001e)
10412		goto f1f;
10413	if (starting > 0x001d)
10414		goto f1e;
10415	if (starting > 0x0010)
10416		goto f1d;
10417	if (starting > 0x0003)
10418		goto f10;
10419	if (starting > 0x0002)
10420		goto f3;
10421	if (starting > 0x0001)
10422		goto f2;
10423	if (starting > 0x0000)
10424		goto f1;
10425
10426	/* Profile List */
10427	scsi_ulto2b(0x0000, feature->feature_code);
10428	feature->flags = SGC_F_PERSISTENT | SGC_F_CURRENT;
10429	feature->add_length = 8;
10430	scsi_ulto2b(0x0008, &feature->feature_data[0]);	/* CD-ROM */
10431	feature->feature_data[2] = 0x00;
10432	scsi_ulto2b(0x0010, &feature->feature_data[4]);	/* DVD-ROM */
10433	feature->feature_data[6] = 0x01;
10434	feature = (struct scsi_get_config_feature *)
10435	    &feature->feature_data[feature->add_length];
10436
10437f1:	/* Core */
10438	scsi_ulto2b(0x0001, feature->feature_code);
10439	feature->flags = 0x08 | SGC_F_PERSISTENT | SGC_F_CURRENT;
10440	feature->add_length = 8;
10441	scsi_ulto4b(0x00000000, &feature->feature_data[0]);
10442	feature->feature_data[4] = 0x03;
10443	feature = (struct scsi_get_config_feature *)
10444	    &feature->feature_data[feature->add_length];
10445
10446f2:	/* Morphing */
10447	scsi_ulto2b(0x0002, feature->feature_code);
10448	feature->flags = 0x04 | SGC_F_PERSISTENT | SGC_F_CURRENT;
10449	feature->add_length = 4;
10450	feature->feature_data[0] = 0x02;
10451	feature = (struct scsi_get_config_feature *)
10452	    &feature->feature_data[feature->add_length];
10453
10454f3:	/* Removable Medium */
10455	scsi_ulto2b(0x0003, feature->feature_code);
10456	feature->flags = 0x04 | SGC_F_PERSISTENT | SGC_F_CURRENT;
10457	feature->add_length = 4;
10458	feature->feature_data[0] = 0x39;
10459	feature = (struct scsi_get_config_feature *)
10460	    &feature->feature_data[feature->add_length];
10461
10462	if (rt == SGC_RT_CURRENT && (lun->flags & CTL_LUN_NO_MEDIA))
10463		goto done;
10464
10465f10:	/* Random Read */
10466	scsi_ulto2b(0x0010, feature->feature_code);
10467	feature->flags = 0x00;
10468	if ((lun->flags & CTL_LUN_NO_MEDIA) == 0)
10469		feature->flags |= SGC_F_CURRENT;
10470	feature->add_length = 8;
10471	scsi_ulto4b(lun->be_lun->blocksize, &feature->feature_data[0]);
10472	scsi_ulto2b(1, &feature->feature_data[4]);
10473	feature->feature_data[6] = 0x00;
10474	feature = (struct scsi_get_config_feature *)
10475	    &feature->feature_data[feature->add_length];
10476
10477f1d:	/* Multi-Read */
10478	scsi_ulto2b(0x001D, feature->feature_code);
10479	feature->flags = 0x00;
10480	if ((lun->flags & CTL_LUN_NO_MEDIA) == 0)
10481		feature->flags |= SGC_F_CURRENT;
10482	feature->add_length = 0;
10483	feature = (struct scsi_get_config_feature *)
10484	    &feature->feature_data[feature->add_length];
10485
10486f1e:	/* CD Read */
10487	scsi_ulto2b(0x001E, 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 = 4;
10492	feature->feature_data[0] = 0x00;
10493	feature = (struct scsi_get_config_feature *)
10494	    &feature->feature_data[feature->add_length];
10495
10496f1f:	/* DVD Read */
10497	scsi_ulto2b(0x001F, feature->feature_code);
10498	feature->flags = 0x08;
10499	if ((lun->flags & CTL_LUN_NO_MEDIA) == 0)
10500		feature->flags |= SGC_F_CURRENT;
10501	feature->add_length = 4;
10502	feature->feature_data[0] = 0x01;
10503	feature->feature_data[2] = 0x03;
10504	feature = (struct scsi_get_config_feature *)
10505	    &feature->feature_data[feature->add_length];
10506
10507f2a:	/* DVD+RW */
10508	scsi_ulto2b(0x002A, feature->feature_code);
10509	feature->flags = 0x04;
10510	if ((lun->flags & CTL_LUN_NO_MEDIA) == 0)
10511		feature->flags |= SGC_F_CURRENT;
10512	feature->add_length = 4;
10513	feature->feature_data[0] = 0x00;
10514	feature->feature_data[1] = 0x00;
10515	feature = (struct scsi_get_config_feature *)
10516	    &feature->feature_data[feature->add_length];
10517
10518f2b:	/* DVD+R */
10519	scsi_ulto2b(0x002B, feature->feature_code);
10520	feature->flags = 0x00;
10521	if ((lun->flags & CTL_LUN_NO_MEDIA) == 0)
10522		feature->flags |= SGC_F_CURRENT;
10523	feature->add_length = 4;
10524	feature->feature_data[0] = 0x00;
10525	feature = (struct scsi_get_config_feature *)
10526	    &feature->feature_data[feature->add_length];
10527
10528f3a:	/* DVD+RW Dual Layer */
10529	scsi_ulto2b(0x003A, feature->feature_code);
10530	feature->flags = 0x00;
10531	if ((lun->flags & CTL_LUN_NO_MEDIA) == 0)
10532		feature->flags |= SGC_F_CURRENT;
10533	feature->add_length = 4;
10534	feature->feature_data[0] = 0x00;
10535	feature->feature_data[1] = 0x00;
10536	feature = (struct scsi_get_config_feature *)
10537	    &feature->feature_data[feature->add_length];
10538
10539f3b:	/* DVD+R Dual Layer */
10540	scsi_ulto2b(0x003B, feature->feature_code);
10541	feature->flags = 0x00;
10542	if ((lun->flags & CTL_LUN_NO_MEDIA) == 0)
10543		feature->flags |= SGC_F_CURRENT;
10544	feature->add_length = 4;
10545	feature->feature_data[0] = 0x00;
10546	feature = (struct scsi_get_config_feature *)
10547	    &feature->feature_data[feature->add_length];
10548
10549done:
10550	data_len = (uint8_t *)feature - (uint8_t *)hdr;
10551	if (rt == SGC_RT_SPECIFIC && data_len > 4) {
10552		feature = (struct scsi_get_config_feature *)(hdr + 1);
10553		if (scsi_2btoul(feature->feature_code) == starting)
10554			feature = (struct scsi_get_config_feature *)
10555			    &feature->feature_data[feature->add_length];
10556		data_len = (uint8_t *)feature - (uint8_t *)hdr;
10557	}
10558	scsi_ulto4b(data_len - 4, hdr->data_length);
10559	if (data_len < alloc_len) {
10560		ctsio->residual = alloc_len - data_len;
10561		ctsio->kern_data_len = data_len;
10562		ctsio->kern_total_len = data_len;
10563	} else {
10564		ctsio->residual = 0;
10565		ctsio->kern_data_len = alloc_len;
10566		ctsio->kern_total_len = alloc_len;
10567	}
10568
10569	ctl_set_success(ctsio);
10570	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
10571	ctsio->be_move_done = ctl_config_move_done;
10572	ctl_datamove((union ctl_io *)ctsio);
10573	return (CTL_RETVAL_COMPLETE);
10574}
10575
10576int
10577ctl_get_event_status(struct ctl_scsiio *ctsio)
10578{
10579	struct scsi_get_event_status_header *hdr;
10580	struct scsi_get_event_status *cdb;
10581	struct ctl_lun *lun;
10582	uint32_t alloc_len, data_len;
10583	int notif_class;
10584
10585	lun = ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
10586	cdb = (struct scsi_get_event_status *)ctsio->cdb;
10587	if ((cdb->byte2 & SGESN_POLLED) == 0) {
10588		ctl_set_invalid_field(ctsio, /*sks_valid*/ 1, /*command*/ 1,
10589		    /*field*/ 1, /*bit_valid*/ 1, /*bit*/ 0);
10590		ctl_done((union ctl_io *)ctsio);
10591		return (CTL_RETVAL_COMPLETE);
10592	}
10593	notif_class = cdb->notif_class;
10594	alloc_len = scsi_2btoul(cdb->length);
10595
10596	data_len = sizeof(struct scsi_get_event_status_header);
10597	ctsio->kern_data_ptr = malloc(data_len, M_CTL, M_WAITOK | M_ZERO);
10598	ctsio->kern_sg_entries = 0;
10599	ctsio->kern_data_resid = 0;
10600	ctsio->kern_rel_offset = 0;
10601
10602	if (data_len < alloc_len) {
10603		ctsio->residual = alloc_len - data_len;
10604		ctsio->kern_data_len = data_len;
10605		ctsio->kern_total_len = data_len;
10606	} else {
10607		ctsio->residual = 0;
10608		ctsio->kern_data_len = alloc_len;
10609		ctsio->kern_total_len = alloc_len;
10610	}
10611
10612	hdr = (struct scsi_get_event_status_header *)ctsio->kern_data_ptr;
10613	scsi_ulto2b(0, hdr->descr_length);
10614	hdr->nea_class = SGESN_NEA;
10615	hdr->supported_class = 0;
10616
10617	ctl_set_success(ctsio);
10618	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
10619	ctsio->be_move_done = ctl_config_move_done;
10620	ctl_datamove((union ctl_io *)ctsio);
10621	return (CTL_RETVAL_COMPLETE);
10622}
10623
10624int
10625ctl_mechanism_status(struct ctl_scsiio *ctsio)
10626{
10627	struct scsi_mechanism_status_header *hdr;
10628	struct scsi_mechanism_status *cdb;
10629	struct ctl_lun *lun;
10630	uint32_t alloc_len, data_len;
10631
10632	lun = ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
10633	cdb = (struct scsi_mechanism_status *)ctsio->cdb;
10634	alloc_len = scsi_2btoul(cdb->length);
10635
10636	data_len = sizeof(struct scsi_mechanism_status_header);
10637	ctsio->kern_data_ptr = malloc(data_len, M_CTL, M_WAITOK | M_ZERO);
10638	ctsio->kern_sg_entries = 0;
10639	ctsio->kern_data_resid = 0;
10640	ctsio->kern_rel_offset = 0;
10641
10642	if (data_len < alloc_len) {
10643		ctsio->residual = alloc_len - data_len;
10644		ctsio->kern_data_len = data_len;
10645		ctsio->kern_total_len = data_len;
10646	} else {
10647		ctsio->residual = 0;
10648		ctsio->kern_data_len = alloc_len;
10649		ctsio->kern_total_len = alloc_len;
10650	}
10651
10652	hdr = (struct scsi_mechanism_status_header *)ctsio->kern_data_ptr;
10653	hdr->state1 = 0x00;
10654	hdr->state2 = 0xe0;
10655	scsi_ulto3b(0, hdr->lba);
10656	hdr->slots_num = 0;
10657	scsi_ulto2b(0, hdr->slots_length);
10658
10659	ctl_set_success(ctsio);
10660	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
10661	ctsio->be_move_done = ctl_config_move_done;
10662	ctl_datamove((union ctl_io *)ctsio);
10663	return (CTL_RETVAL_COMPLETE);
10664}
10665
10666static void
10667ctl_ultomsf(uint32_t lba, uint8_t *buf)
10668{
10669
10670	lba += 150;
10671	buf[0] = 0;
10672	buf[1] = bin2bcd((lba / 75) / 60);
10673	buf[2] = bin2bcd((lba / 75) % 60);
10674	buf[3] = bin2bcd(lba % 75);
10675}
10676
10677int
10678ctl_read_toc(struct ctl_scsiio *ctsio)
10679{
10680	struct scsi_read_toc_hdr *hdr;
10681	struct scsi_read_toc_type01_descr *descr;
10682	struct scsi_read_toc *cdb;
10683	struct ctl_lun *lun;
10684	uint32_t alloc_len, data_len;
10685	int format, msf;
10686
10687	lun = ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
10688	cdb = (struct scsi_read_toc *)ctsio->cdb;
10689	msf = (cdb->byte2 & CD_MSF) != 0;
10690	format = cdb->format;
10691	alloc_len = scsi_2btoul(cdb->data_len);
10692
10693	data_len = sizeof(struct scsi_read_toc_hdr);
10694	if (format == 0)
10695		data_len += 2 * sizeof(struct scsi_read_toc_type01_descr);
10696	else
10697		data_len += sizeof(struct scsi_read_toc_type01_descr);
10698	ctsio->kern_data_ptr = malloc(data_len, M_CTL, M_WAITOK | M_ZERO);
10699	ctsio->kern_sg_entries = 0;
10700	ctsio->kern_data_resid = 0;
10701	ctsio->kern_rel_offset = 0;
10702
10703	if (data_len < alloc_len) {
10704		ctsio->residual = alloc_len - data_len;
10705		ctsio->kern_data_len = data_len;
10706		ctsio->kern_total_len = data_len;
10707	} else {
10708		ctsio->residual = 0;
10709		ctsio->kern_data_len = alloc_len;
10710		ctsio->kern_total_len = alloc_len;
10711	}
10712
10713	hdr = (struct scsi_read_toc_hdr *)ctsio->kern_data_ptr;
10714	if (format == 0) {
10715		scsi_ulto2b(0x12, hdr->data_length);
10716		hdr->first = 1;
10717		hdr->last = 1;
10718		descr = (struct scsi_read_toc_type01_descr *)(hdr + 1);
10719		descr->addr_ctl = 0x14;
10720		descr->track_number = 1;
10721		if (msf)
10722			ctl_ultomsf(0, descr->track_start);
10723		else
10724			scsi_ulto4b(0, descr->track_start);
10725		descr++;
10726		descr->addr_ctl = 0x14;
10727		descr->track_number = 0xaa;
10728		if (msf)
10729			ctl_ultomsf(lun->be_lun->maxlba+1, descr->track_start);
10730		else
10731			scsi_ulto4b(lun->be_lun->maxlba+1, descr->track_start);
10732	} else {
10733		scsi_ulto2b(0x0a, hdr->data_length);
10734		hdr->first = 1;
10735		hdr->last = 1;
10736		descr = (struct scsi_read_toc_type01_descr *)(hdr + 1);
10737		descr->addr_ctl = 0x14;
10738		descr->track_number = 1;
10739		if (msf)
10740			ctl_ultomsf(0, descr->track_start);
10741		else
10742			scsi_ulto4b(0, descr->track_start);
10743	}
10744
10745	ctl_set_success(ctsio);
10746	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
10747	ctsio->be_move_done = ctl_config_move_done;
10748	ctl_datamove((union ctl_io *)ctsio);
10749	return (CTL_RETVAL_COMPLETE);
10750}
10751
10752/*
10753 * For known CDB types, parse the LBA and length.
10754 */
10755static int
10756ctl_get_lba_len(union ctl_io *io, uint64_t *lba, uint64_t *len)
10757{
10758	if (io->io_hdr.io_type != CTL_IO_SCSI)
10759		return (1);
10760
10761	switch (io->scsiio.cdb[0]) {
10762	case COMPARE_AND_WRITE: {
10763		struct scsi_compare_and_write *cdb;
10764
10765		cdb = (struct scsi_compare_and_write *)io->scsiio.cdb;
10766
10767		*lba = scsi_8btou64(cdb->addr);
10768		*len = cdb->length;
10769		break;
10770	}
10771	case READ_6:
10772	case WRITE_6: {
10773		struct scsi_rw_6 *cdb;
10774
10775		cdb = (struct scsi_rw_6 *)io->scsiio.cdb;
10776
10777		*lba = scsi_3btoul(cdb->addr);
10778		/* only 5 bits are valid in the most significant address byte */
10779		*lba &= 0x1fffff;
10780		*len = cdb->length;
10781		break;
10782	}
10783	case READ_10:
10784	case WRITE_10: {
10785		struct scsi_rw_10 *cdb;
10786
10787		cdb = (struct scsi_rw_10 *)io->scsiio.cdb;
10788
10789		*lba = scsi_4btoul(cdb->addr);
10790		*len = scsi_2btoul(cdb->length);
10791		break;
10792	}
10793	case WRITE_VERIFY_10: {
10794		struct scsi_write_verify_10 *cdb;
10795
10796		cdb = (struct scsi_write_verify_10 *)io->scsiio.cdb;
10797
10798		*lba = scsi_4btoul(cdb->addr);
10799		*len = scsi_2btoul(cdb->length);
10800		break;
10801	}
10802	case READ_12:
10803	case WRITE_12: {
10804		struct scsi_rw_12 *cdb;
10805
10806		cdb = (struct scsi_rw_12 *)io->scsiio.cdb;
10807
10808		*lba = scsi_4btoul(cdb->addr);
10809		*len = scsi_4btoul(cdb->length);
10810		break;
10811	}
10812	case WRITE_VERIFY_12: {
10813		struct scsi_write_verify_12 *cdb;
10814
10815		cdb = (struct scsi_write_verify_12 *)io->scsiio.cdb;
10816
10817		*lba = scsi_4btoul(cdb->addr);
10818		*len = scsi_4btoul(cdb->length);
10819		break;
10820	}
10821	case READ_16:
10822	case WRITE_16: {
10823		struct scsi_rw_16 *cdb;
10824
10825		cdb = (struct scsi_rw_16 *)io->scsiio.cdb;
10826
10827		*lba = scsi_8btou64(cdb->addr);
10828		*len = scsi_4btoul(cdb->length);
10829		break;
10830	}
10831	case WRITE_ATOMIC_16: {
10832		struct scsi_write_atomic_16 *cdb;
10833
10834		cdb = (struct scsi_write_atomic_16 *)io->scsiio.cdb;
10835
10836		*lba = scsi_8btou64(cdb->addr);
10837		*len = scsi_2btoul(cdb->length);
10838		break;
10839	}
10840	case WRITE_VERIFY_16: {
10841		struct scsi_write_verify_16 *cdb;
10842
10843		cdb = (struct scsi_write_verify_16 *)io->scsiio.cdb;
10844
10845		*lba = scsi_8btou64(cdb->addr);
10846		*len = scsi_4btoul(cdb->length);
10847		break;
10848	}
10849	case WRITE_SAME_10: {
10850		struct scsi_write_same_10 *cdb;
10851
10852		cdb = (struct scsi_write_same_10 *)io->scsiio.cdb;
10853
10854		*lba = scsi_4btoul(cdb->addr);
10855		*len = scsi_2btoul(cdb->length);
10856		break;
10857	}
10858	case WRITE_SAME_16: {
10859		struct scsi_write_same_16 *cdb;
10860
10861		cdb = (struct scsi_write_same_16 *)io->scsiio.cdb;
10862
10863		*lba = scsi_8btou64(cdb->addr);
10864		*len = scsi_4btoul(cdb->length);
10865		break;
10866	}
10867	case VERIFY_10: {
10868		struct scsi_verify_10 *cdb;
10869
10870		cdb = (struct scsi_verify_10 *)io->scsiio.cdb;
10871
10872		*lba = scsi_4btoul(cdb->addr);
10873		*len = scsi_2btoul(cdb->length);
10874		break;
10875	}
10876	case VERIFY_12: {
10877		struct scsi_verify_12 *cdb;
10878
10879		cdb = (struct scsi_verify_12 *)io->scsiio.cdb;
10880
10881		*lba = scsi_4btoul(cdb->addr);
10882		*len = scsi_4btoul(cdb->length);
10883		break;
10884	}
10885	case VERIFY_16: {
10886		struct scsi_verify_16 *cdb;
10887
10888		cdb = (struct scsi_verify_16 *)io->scsiio.cdb;
10889
10890		*lba = scsi_8btou64(cdb->addr);
10891		*len = scsi_4btoul(cdb->length);
10892		break;
10893	}
10894	case UNMAP: {
10895		*lba = 0;
10896		*len = UINT64_MAX;
10897		break;
10898	}
10899	case SERVICE_ACTION_IN: {	/* GET LBA STATUS */
10900		struct scsi_get_lba_status *cdb;
10901
10902		cdb = (struct scsi_get_lba_status *)io->scsiio.cdb;
10903		*lba = scsi_8btou64(cdb->addr);
10904		*len = UINT32_MAX;
10905		break;
10906	}
10907	default:
10908		return (1);
10909		break; /* NOTREACHED */
10910	}
10911
10912	return (0);
10913}
10914
10915static ctl_action
10916ctl_extent_check_lba(uint64_t lba1, uint64_t len1, uint64_t lba2, uint64_t len2,
10917    bool seq)
10918{
10919	uint64_t endlba1, endlba2;
10920
10921	endlba1 = lba1 + len1 - (seq ? 0 : 1);
10922	endlba2 = lba2 + len2 - 1;
10923
10924	if ((endlba1 < lba2) || (endlba2 < lba1))
10925		return (CTL_ACTION_PASS);
10926	else
10927		return (CTL_ACTION_BLOCK);
10928}
10929
10930static int
10931ctl_extent_check_unmap(union ctl_io *io, uint64_t lba2, uint64_t len2)
10932{
10933	struct ctl_ptr_len_flags *ptrlen;
10934	struct scsi_unmap_desc *buf, *end, *range;
10935	uint64_t lba;
10936	uint32_t len;
10937
10938	/* If not UNMAP -- go other way. */
10939	if (io->io_hdr.io_type != CTL_IO_SCSI ||
10940	    io->scsiio.cdb[0] != UNMAP)
10941		return (CTL_ACTION_ERROR);
10942
10943	/* If UNMAP without data -- block and wait for data. */
10944	ptrlen = (struct ctl_ptr_len_flags *)
10945	    &io->io_hdr.ctl_private[CTL_PRIV_LBA_LEN];
10946	if ((io->io_hdr.flags & CTL_FLAG_ALLOCATED) == 0 ||
10947	    ptrlen->ptr == NULL)
10948		return (CTL_ACTION_BLOCK);
10949
10950	/* UNMAP with data -- check for collision. */
10951	buf = (struct scsi_unmap_desc *)ptrlen->ptr;
10952	end = buf + ptrlen->len / sizeof(*buf);
10953	for (range = buf; range < end; range++) {
10954		lba = scsi_8btou64(range->lba);
10955		len = scsi_4btoul(range->length);
10956		if ((lba < lba2 + len2) && (lba + len > lba2))
10957			return (CTL_ACTION_BLOCK);
10958	}
10959	return (CTL_ACTION_PASS);
10960}
10961
10962static ctl_action
10963ctl_extent_check(union ctl_io *io1, union ctl_io *io2, bool seq)
10964{
10965	uint64_t lba1, lba2;
10966	uint64_t len1, len2;
10967	int retval;
10968
10969	if (ctl_get_lba_len(io2, &lba2, &len2) != 0)
10970		return (CTL_ACTION_ERROR);
10971
10972	retval = ctl_extent_check_unmap(io1, lba2, len2);
10973	if (retval != CTL_ACTION_ERROR)
10974		return (retval);
10975
10976	if (ctl_get_lba_len(io1, &lba1, &len1) != 0)
10977		return (CTL_ACTION_ERROR);
10978
10979	if (io1->io_hdr.flags & CTL_FLAG_SERSEQ_DONE)
10980		seq = FALSE;
10981	return (ctl_extent_check_lba(lba1, len1, lba2, len2, seq));
10982}
10983
10984static ctl_action
10985ctl_extent_check_seq(union ctl_io *io1, union ctl_io *io2)
10986{
10987	uint64_t lba1, lba2;
10988	uint64_t len1, len2;
10989
10990	if (io1->io_hdr.flags & CTL_FLAG_SERSEQ_DONE)
10991		return (CTL_ACTION_PASS);
10992	if (ctl_get_lba_len(io1, &lba1, &len1) != 0)
10993		return (CTL_ACTION_ERROR);
10994	if (ctl_get_lba_len(io2, &lba2, &len2) != 0)
10995		return (CTL_ACTION_ERROR);
10996
10997	if (lba1 + len1 == lba2)
10998		return (CTL_ACTION_BLOCK);
10999	return (CTL_ACTION_PASS);
11000}
11001
11002static ctl_action
11003ctl_check_for_blockage(struct ctl_lun *lun, union ctl_io *pending_io,
11004    union ctl_io *ooa_io)
11005{
11006	const struct ctl_cmd_entry *pending_entry, *ooa_entry;
11007	const ctl_serialize_action *serialize_row;
11008
11009	/*
11010	 * The initiator attempted multiple untagged commands at the same
11011	 * time.  Can't do that.
11012	 */
11013	if ((pending_io->scsiio.tag_type == CTL_TAG_UNTAGGED)
11014	 && (ooa_io->scsiio.tag_type == CTL_TAG_UNTAGGED)
11015	 && ((pending_io->io_hdr.nexus.targ_port ==
11016	      ooa_io->io_hdr.nexus.targ_port)
11017	  && (pending_io->io_hdr.nexus.initid ==
11018	      ooa_io->io_hdr.nexus.initid))
11019	 && ((ooa_io->io_hdr.flags & (CTL_FLAG_ABORT |
11020	      CTL_FLAG_STATUS_SENT)) == 0))
11021		return (CTL_ACTION_OVERLAP);
11022
11023	/*
11024	 * The initiator attempted to send multiple tagged commands with
11025	 * the same ID.  (It's fine if different initiators have the same
11026	 * tag ID.)
11027	 *
11028	 * Even if all of those conditions are true, we don't kill the I/O
11029	 * if the command ahead of us has been aborted.  We won't end up
11030	 * sending it to the FETD, and it's perfectly legal to resend a
11031	 * command with the same tag number as long as the previous
11032	 * instance of this tag number has been aborted somehow.
11033	 */
11034	if ((pending_io->scsiio.tag_type != CTL_TAG_UNTAGGED)
11035	 && (ooa_io->scsiio.tag_type != CTL_TAG_UNTAGGED)
11036	 && (pending_io->scsiio.tag_num == ooa_io->scsiio.tag_num)
11037	 && ((pending_io->io_hdr.nexus.targ_port ==
11038	      ooa_io->io_hdr.nexus.targ_port)
11039	  && (pending_io->io_hdr.nexus.initid ==
11040	      ooa_io->io_hdr.nexus.initid))
11041	 && ((ooa_io->io_hdr.flags & (CTL_FLAG_ABORT |
11042	      CTL_FLAG_STATUS_SENT)) == 0))
11043		return (CTL_ACTION_OVERLAP_TAG);
11044
11045	/*
11046	 * If we get a head of queue tag, SAM-3 says that we should
11047	 * immediately execute it.
11048	 *
11049	 * What happens if this command would normally block for some other
11050	 * reason?  e.g. a request sense with a head of queue tag
11051	 * immediately after a write.  Normally that would block, but this
11052	 * will result in its getting executed immediately...
11053	 *
11054	 * We currently return "pass" instead of "skip", so we'll end up
11055	 * going through the rest of the queue to check for overlapped tags.
11056	 *
11057	 * XXX KDM check for other types of blockage first??
11058	 */
11059	if (pending_io->scsiio.tag_type == CTL_TAG_HEAD_OF_QUEUE)
11060		return (CTL_ACTION_PASS);
11061
11062	/*
11063	 * Ordered tags have to block until all items ahead of them
11064	 * have completed.  If we get called with an ordered tag, we always
11065	 * block, if something else is ahead of us in the queue.
11066	 */
11067	if (pending_io->scsiio.tag_type == CTL_TAG_ORDERED)
11068		return (CTL_ACTION_BLOCK);
11069
11070	/*
11071	 * Simple tags get blocked until all head of queue and ordered tags
11072	 * ahead of them have completed.  I'm lumping untagged commands in
11073	 * with simple tags here.  XXX KDM is that the right thing to do?
11074	 */
11075	if (((pending_io->scsiio.tag_type == CTL_TAG_UNTAGGED)
11076	  || (pending_io->scsiio.tag_type == CTL_TAG_SIMPLE))
11077	 && ((ooa_io->scsiio.tag_type == CTL_TAG_HEAD_OF_QUEUE)
11078	  || (ooa_io->scsiio.tag_type == CTL_TAG_ORDERED)))
11079		return (CTL_ACTION_BLOCK);
11080
11081	pending_entry = ctl_get_cmd_entry(&pending_io->scsiio, NULL);
11082	KASSERT(pending_entry->seridx < CTL_SERIDX_COUNT,
11083	    ("%s: Invalid seridx %d for pending CDB %02x %02x @ %p",
11084	     __func__, pending_entry->seridx, pending_io->scsiio.cdb[0],
11085	     pending_io->scsiio.cdb[1], pending_io));
11086	ooa_entry = ctl_get_cmd_entry(&ooa_io->scsiio, NULL);
11087	if (ooa_entry->seridx == CTL_SERIDX_INVLD)
11088		return (CTL_ACTION_PASS); /* Unsupported command in OOA queue */
11089	KASSERT(ooa_entry->seridx < CTL_SERIDX_COUNT,
11090	    ("%s: Invalid seridx %d for ooa CDB %02x %02x @ %p",
11091	     __func__, ooa_entry->seridx, ooa_io->scsiio.cdb[0],
11092	     ooa_io->scsiio.cdb[1], ooa_io));
11093
11094	serialize_row = ctl_serialize_table[ooa_entry->seridx];
11095
11096	switch (serialize_row[pending_entry->seridx]) {
11097	case CTL_SER_BLOCK:
11098		return (CTL_ACTION_BLOCK);
11099	case CTL_SER_EXTENT:
11100		return (ctl_extent_check(ooa_io, pending_io,
11101		    (lun->be_lun && lun->be_lun->serseq == CTL_LUN_SERSEQ_ON)));
11102	case CTL_SER_EXTENTOPT:
11103		if ((lun->mode_pages.control_page[CTL_PAGE_CURRENT].queue_flags
11104		    & SCP_QUEUE_ALG_MASK) != SCP_QUEUE_ALG_UNRESTRICTED)
11105			return (ctl_extent_check(ooa_io, pending_io,
11106			    (lun->be_lun &&
11107			     lun->be_lun->serseq == CTL_LUN_SERSEQ_ON)));
11108		return (CTL_ACTION_PASS);
11109	case CTL_SER_EXTENTSEQ:
11110		if (lun->be_lun && lun->be_lun->serseq != CTL_LUN_SERSEQ_OFF)
11111			return (ctl_extent_check_seq(ooa_io, pending_io));
11112		return (CTL_ACTION_PASS);
11113	case CTL_SER_PASS:
11114		return (CTL_ACTION_PASS);
11115	case CTL_SER_BLOCKOPT:
11116		if ((lun->mode_pages.control_page[CTL_PAGE_CURRENT].queue_flags
11117		    & SCP_QUEUE_ALG_MASK) != SCP_QUEUE_ALG_UNRESTRICTED)
11118			return (CTL_ACTION_BLOCK);
11119		return (CTL_ACTION_PASS);
11120	case CTL_SER_SKIP:
11121		return (CTL_ACTION_SKIP);
11122	default:
11123		panic("%s: Invalid serialization value %d for %d => %d",
11124		    __func__, serialize_row[pending_entry->seridx],
11125		    pending_entry->seridx, ooa_entry->seridx);
11126	}
11127
11128	return (CTL_ACTION_ERROR);
11129}
11130
11131/*
11132 * Check for blockage or overlaps against the OOA (Order Of Arrival) queue.
11133 * Assumptions:
11134 * - pending_io is generally either incoming, or on the blocked queue
11135 * - starting I/O is the I/O we want to start the check with.
11136 */
11137static ctl_action
11138ctl_check_ooa(struct ctl_lun *lun, union ctl_io *pending_io,
11139	      union ctl_io *starting_io)
11140{
11141	union ctl_io *ooa_io;
11142	ctl_action action;
11143
11144	mtx_assert(&lun->lun_lock, MA_OWNED);
11145
11146	/*
11147	 * Run back along the OOA queue, starting with the current
11148	 * blocked I/O and going through every I/O before it on the
11149	 * queue.  If starting_io is NULL, we'll just end up returning
11150	 * CTL_ACTION_PASS.
11151	 */
11152	for (ooa_io = starting_io; ooa_io != NULL;
11153	     ooa_io = (union ctl_io *)TAILQ_PREV(&ooa_io->io_hdr, ctl_ooaq,
11154	     ooa_links)){
11155
11156		/*
11157		 * This routine just checks to see whether
11158		 * cur_blocked is blocked by ooa_io, which is ahead
11159		 * of it in the queue.  It doesn't queue/dequeue
11160		 * cur_blocked.
11161		 */
11162		action = ctl_check_for_blockage(lun, pending_io, ooa_io);
11163		switch (action) {
11164		case CTL_ACTION_BLOCK:
11165		case CTL_ACTION_OVERLAP:
11166		case CTL_ACTION_OVERLAP_TAG:
11167		case CTL_ACTION_SKIP:
11168		case CTL_ACTION_ERROR:
11169			return (action);
11170			break; /* NOTREACHED */
11171		case CTL_ACTION_PASS:
11172			break;
11173		default:
11174			panic("%s: Invalid action %d\n", __func__, action);
11175		}
11176	}
11177
11178	return (CTL_ACTION_PASS);
11179}
11180
11181/*
11182 * Assumptions:
11183 * - An I/O has just completed, and has been removed from the per-LUN OOA
11184 *   queue, so some items on the blocked queue may now be unblocked.
11185 */
11186static int
11187ctl_check_blocked(struct ctl_lun *lun)
11188{
11189	struct ctl_softc *softc = lun->ctl_softc;
11190	union ctl_io *cur_blocked, *next_blocked;
11191
11192	mtx_assert(&lun->lun_lock, MA_OWNED);
11193
11194	/*
11195	 * Run forward from the head of the blocked queue, checking each
11196	 * entry against the I/Os prior to it on the OOA queue to see if
11197	 * there is still any blockage.
11198	 *
11199	 * We cannot use the TAILQ_FOREACH() macro, because it can't deal
11200	 * with our removing a variable on it while it is traversing the
11201	 * list.
11202	 */
11203	for (cur_blocked = (union ctl_io *)TAILQ_FIRST(&lun->blocked_queue);
11204	     cur_blocked != NULL; cur_blocked = next_blocked) {
11205		union ctl_io *prev_ooa;
11206		ctl_action action;
11207
11208		next_blocked = (union ctl_io *)TAILQ_NEXT(&cur_blocked->io_hdr,
11209							  blocked_links);
11210
11211		prev_ooa = (union ctl_io *)TAILQ_PREV(&cur_blocked->io_hdr,
11212						      ctl_ooaq, ooa_links);
11213
11214		/*
11215		 * If cur_blocked happens to be the first item in the OOA
11216		 * queue now, prev_ooa will be NULL, and the action
11217		 * returned will just be CTL_ACTION_PASS.
11218		 */
11219		action = ctl_check_ooa(lun, cur_blocked, prev_ooa);
11220
11221		switch (action) {
11222		case CTL_ACTION_BLOCK:
11223			/* Nothing to do here, still blocked */
11224			break;
11225		case CTL_ACTION_OVERLAP:
11226		case CTL_ACTION_OVERLAP_TAG:
11227			/*
11228			 * This shouldn't happen!  In theory we've already
11229			 * checked this command for overlap...
11230			 */
11231			break;
11232		case CTL_ACTION_PASS:
11233		case CTL_ACTION_SKIP: {
11234			const struct ctl_cmd_entry *entry;
11235
11236			/*
11237			 * The skip case shouldn't happen, this transaction
11238			 * should have never made it onto the blocked queue.
11239			 */
11240			/*
11241			 * This I/O is no longer blocked, we can remove it
11242			 * from the blocked queue.  Since this is a TAILQ
11243			 * (doubly linked list), we can do O(1) removals
11244			 * from any place on the list.
11245			 */
11246			TAILQ_REMOVE(&lun->blocked_queue, &cur_blocked->io_hdr,
11247				     blocked_links);
11248			cur_blocked->io_hdr.flags &= ~CTL_FLAG_BLOCKED;
11249
11250			if ((softc->ha_mode != CTL_HA_MODE_XFER) &&
11251			    (cur_blocked->io_hdr.flags & CTL_FLAG_FROM_OTHER_SC)){
11252				/*
11253				 * Need to send IO back to original side to
11254				 * run
11255				 */
11256				union ctl_ha_msg msg_info;
11257
11258				cur_blocked->io_hdr.flags &= ~CTL_FLAG_IO_ACTIVE;
11259				msg_info.hdr.original_sc =
11260					cur_blocked->io_hdr.original_sc;
11261				msg_info.hdr.serializing_sc = cur_blocked;
11262				msg_info.hdr.msg_type = CTL_MSG_R2R;
11263				ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg_info,
11264				    sizeof(msg_info.hdr), M_NOWAIT);
11265				break;
11266			}
11267			entry = ctl_get_cmd_entry(&cur_blocked->scsiio, NULL);
11268
11269			/*
11270			 * Check this I/O for LUN state changes that may
11271			 * have happened while this command was blocked.
11272			 * The LUN state may have been changed by a command
11273			 * ahead of us in the queue, so we need to re-check
11274			 * for any states that can be caused by SCSI
11275			 * commands.
11276			 */
11277			if (ctl_scsiio_lun_check(lun, entry,
11278						 &cur_blocked->scsiio) == 0) {
11279				cur_blocked->io_hdr.flags |=
11280				                      CTL_FLAG_IS_WAS_ON_RTR;
11281				ctl_enqueue_rtr(cur_blocked);
11282			} else
11283				ctl_done(cur_blocked);
11284			break;
11285		}
11286		default:
11287			/*
11288			 * This probably shouldn't happen -- we shouldn't
11289			 * get CTL_ACTION_ERROR, or anything else.
11290			 */
11291			break;
11292		}
11293	}
11294
11295	return (CTL_RETVAL_COMPLETE);
11296}
11297
11298/*
11299 * This routine (with one exception) checks LUN flags that can be set by
11300 * commands ahead of us in the OOA queue.  These flags have to be checked
11301 * when a command initially comes in, and when we pull a command off the
11302 * blocked queue and are preparing to execute it.  The reason we have to
11303 * check these flags for commands on the blocked queue is that the LUN
11304 * state may have been changed by a command ahead of us while we're on the
11305 * blocked queue.
11306 *
11307 * Ordering is somewhat important with these checks, so please pay
11308 * careful attention to the placement of any new checks.
11309 */
11310static int
11311ctl_scsiio_lun_check(struct ctl_lun *lun,
11312    const struct ctl_cmd_entry *entry, struct ctl_scsiio *ctsio)
11313{
11314	struct ctl_softc *softc = lun->ctl_softc;
11315	int retval;
11316	uint32_t residx;
11317
11318	retval = 0;
11319
11320	mtx_assert(&lun->lun_lock, MA_OWNED);
11321
11322	/*
11323	 * If this shelf is a secondary shelf controller, we may have to
11324	 * reject some commands disallowed by HA mode and link state.
11325	 */
11326	if ((lun->flags & CTL_LUN_PRIMARY_SC) == 0) {
11327		if (softc->ha_link == CTL_HA_LINK_OFFLINE &&
11328		    (entry->flags & CTL_CMD_FLAG_OK_ON_UNAVAIL) == 0) {
11329			ctl_set_lun_unavail(ctsio);
11330			retval = 1;
11331			goto bailout;
11332		}
11333		if ((lun->flags & CTL_LUN_PEER_SC_PRIMARY) == 0 &&
11334		    (entry->flags & CTL_CMD_FLAG_OK_ON_UNAVAIL) == 0) {
11335			ctl_set_lun_transit(ctsio);
11336			retval = 1;
11337			goto bailout;
11338		}
11339		if (softc->ha_mode == CTL_HA_MODE_ACT_STBY &&
11340		    (entry->flags & CTL_CMD_FLAG_OK_ON_STANDBY) == 0) {
11341			ctl_set_lun_standby(ctsio);
11342			retval = 1;
11343			goto bailout;
11344		}
11345
11346		/* The rest of checks are only done on executing side */
11347		if (softc->ha_mode == CTL_HA_MODE_XFER)
11348			goto bailout;
11349	}
11350
11351	if (entry->pattern & CTL_LUN_PAT_WRITE) {
11352		if (lun->be_lun &&
11353		    lun->be_lun->flags & CTL_LUN_FLAG_READONLY) {
11354			ctl_set_hw_write_protected(ctsio);
11355			retval = 1;
11356			goto bailout;
11357		}
11358		if ((lun->mode_pages.control_page[CTL_PAGE_CURRENT]
11359		    .eca_and_aen & SCP_SWP) != 0) {
11360			ctl_set_sense(ctsio, /*current_error*/ 1,
11361			    /*sense_key*/ SSD_KEY_DATA_PROTECT,
11362			    /*asc*/ 0x27, /*ascq*/ 0x02, SSD_ELEM_NONE);
11363			retval = 1;
11364			goto bailout;
11365		}
11366	}
11367
11368	/*
11369	 * Check for a reservation conflict.  If this command isn't allowed
11370	 * even on reserved LUNs, and if this initiator isn't the one who
11371	 * reserved us, reject the command with a reservation conflict.
11372	 */
11373	residx = ctl_get_initindex(&ctsio->io_hdr.nexus);
11374	if ((lun->flags & CTL_LUN_RESERVED)
11375	 && ((entry->flags & CTL_CMD_FLAG_ALLOW_ON_RESV) == 0)) {
11376		if (lun->res_idx != residx) {
11377			ctl_set_reservation_conflict(ctsio);
11378			retval = 1;
11379			goto bailout;
11380		}
11381	}
11382
11383	if ((lun->flags & CTL_LUN_PR_RESERVED) == 0 ||
11384	    (entry->flags & CTL_CMD_FLAG_ALLOW_ON_PR_RESV)) {
11385		/* No reservation or command is allowed. */;
11386	} else if ((entry->flags & CTL_CMD_FLAG_ALLOW_ON_PR_WRESV) &&
11387	    (lun->pr_res_type == SPR_TYPE_WR_EX ||
11388	     lun->pr_res_type == SPR_TYPE_WR_EX_RO ||
11389	     lun->pr_res_type == SPR_TYPE_WR_EX_AR)) {
11390		/* The command is allowed for Write Exclusive resv. */;
11391	} else {
11392		/*
11393		 * if we aren't registered or it's a res holder type
11394		 * reservation and this isn't the res holder then set a
11395		 * conflict.
11396		 */
11397		if (ctl_get_prkey(lun, residx) == 0 ||
11398		    (residx != lun->pr_res_idx && lun->pr_res_type < 4)) {
11399			ctl_set_reservation_conflict(ctsio);
11400			retval = 1;
11401			goto bailout;
11402		}
11403	}
11404
11405	if ((entry->flags & CTL_CMD_FLAG_OK_ON_NO_MEDIA) == 0) {
11406		if (lun->flags & CTL_LUN_EJECTED)
11407			ctl_set_lun_ejected(ctsio);
11408		else if (lun->flags & CTL_LUN_NO_MEDIA) {
11409			if (lun->flags & CTL_LUN_REMOVABLE)
11410				ctl_set_lun_no_media(ctsio);
11411			else
11412				ctl_set_lun_int_reqd(ctsio);
11413		} else if (lun->flags & CTL_LUN_STOPPED)
11414			ctl_set_lun_stopped(ctsio);
11415		else
11416			goto bailout;
11417		retval = 1;
11418		goto bailout;
11419	}
11420
11421bailout:
11422	return (retval);
11423}
11424
11425static void
11426ctl_failover_io(union ctl_io *io, int have_lock)
11427{
11428	ctl_set_busy(&io->scsiio);
11429	ctl_done(io);
11430}
11431
11432static void
11433ctl_failover_lun(union ctl_io *rio)
11434{
11435	struct ctl_softc *softc = control_softc;
11436	struct ctl_lun *lun;
11437	struct ctl_io_hdr *io, *next_io;
11438	uint32_t targ_lun;
11439
11440	targ_lun = rio->io_hdr.nexus.targ_mapped_lun;
11441	CTL_DEBUG_PRINT(("FAILOVER for lun %ju\n", targ_lun));
11442
11443	/* Find and lock the LUN. */
11444	mtx_lock(&softc->ctl_lock);
11445	if ((targ_lun < CTL_MAX_LUNS) &&
11446	    ((lun = softc->ctl_luns[targ_lun]) != NULL)) {
11447		mtx_lock(&lun->lun_lock);
11448		mtx_unlock(&softc->ctl_lock);
11449		if (lun->flags & CTL_LUN_DISABLED) {
11450			mtx_unlock(&lun->lun_lock);
11451			return;
11452		}
11453	} else {
11454		mtx_unlock(&softc->ctl_lock);
11455		return;
11456	}
11457
11458	if (softc->ha_mode == CTL_HA_MODE_XFER) {
11459		TAILQ_FOREACH_SAFE(io, &lun->ooa_queue, ooa_links, next_io) {
11460			/* We are master */
11461			if (io->flags & CTL_FLAG_FROM_OTHER_SC) {
11462				if (io->flags & CTL_FLAG_IO_ACTIVE) {
11463					io->flags |= CTL_FLAG_ABORT;
11464					io->flags |= CTL_FLAG_FAILOVER;
11465				} else { /* This can be only due to DATAMOVE */
11466					io->msg_type = CTL_MSG_DATAMOVE_DONE;
11467					io->flags &= ~CTL_FLAG_DMA_INPROG;
11468					io->flags |= CTL_FLAG_IO_ACTIVE;
11469					io->port_status = 31340;
11470					ctl_enqueue_isc((union ctl_io *)io);
11471				}
11472			}
11473			/* We are slave */
11474			if (io->flags & CTL_FLAG_SENT_2OTHER_SC) {
11475				io->flags &= ~CTL_FLAG_SENT_2OTHER_SC;
11476				if (io->flags & CTL_FLAG_IO_ACTIVE) {
11477					io->flags |= CTL_FLAG_FAILOVER;
11478				} else {
11479					ctl_set_busy(&((union ctl_io *)io)->
11480					    scsiio);
11481					ctl_done((union ctl_io *)io);
11482				}
11483			}
11484		}
11485	} else { /* SERIALIZE modes */
11486		TAILQ_FOREACH_SAFE(io, &lun->blocked_queue, blocked_links,
11487		    next_io) {
11488			/* We are master */
11489			if (io->flags & CTL_FLAG_FROM_OTHER_SC) {
11490				TAILQ_REMOVE(&lun->blocked_queue, io,
11491				    blocked_links);
11492				io->flags &= ~CTL_FLAG_BLOCKED;
11493				TAILQ_REMOVE(&lun->ooa_queue, io, ooa_links);
11494				ctl_free_io((union ctl_io *)io);
11495			}
11496		}
11497		TAILQ_FOREACH_SAFE(io, &lun->ooa_queue, ooa_links, next_io) {
11498			/* We are master */
11499			if (io->flags & CTL_FLAG_FROM_OTHER_SC) {
11500				TAILQ_REMOVE(&lun->ooa_queue, io, ooa_links);
11501				ctl_free_io((union ctl_io *)io);
11502			}
11503			/* We are slave */
11504			if (io->flags & CTL_FLAG_SENT_2OTHER_SC) {
11505				io->flags &= ~CTL_FLAG_SENT_2OTHER_SC;
11506				if (!(io->flags & CTL_FLAG_IO_ACTIVE)) {
11507					ctl_set_busy(&((union ctl_io *)io)->
11508					    scsiio);
11509					ctl_done((union ctl_io *)io);
11510				}
11511			}
11512		}
11513		ctl_check_blocked(lun);
11514	}
11515	mtx_unlock(&lun->lun_lock);
11516}
11517
11518static int
11519ctl_scsiio_precheck(struct ctl_softc *softc, struct ctl_scsiio *ctsio)
11520{
11521	struct ctl_lun *lun;
11522	const struct ctl_cmd_entry *entry;
11523	uint32_t initidx, targ_lun;
11524	int retval;
11525
11526	retval = 0;
11527
11528	lun = NULL;
11529
11530	targ_lun = ctsio->io_hdr.nexus.targ_mapped_lun;
11531	if ((targ_lun < CTL_MAX_LUNS)
11532	 && ((lun = softc->ctl_luns[targ_lun]) != NULL)) {
11533		/*
11534		 * If the LUN is invalid, pretend that it doesn't exist.
11535		 * It will go away as soon as all pending I/O has been
11536		 * completed.
11537		 */
11538		mtx_lock(&lun->lun_lock);
11539		if (lun->flags & CTL_LUN_DISABLED) {
11540			mtx_unlock(&lun->lun_lock);
11541			lun = NULL;
11542			ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr = NULL;
11543			ctsio->io_hdr.ctl_private[CTL_PRIV_BACKEND_LUN].ptr = NULL;
11544		} else {
11545			ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr = lun;
11546			ctsio->io_hdr.ctl_private[CTL_PRIV_BACKEND_LUN].ptr =
11547				lun->be_lun;
11548
11549			/*
11550			 * Every I/O goes into the OOA queue for a
11551			 * particular LUN, and stays there until completion.
11552			 */
11553#ifdef CTL_TIME_IO
11554			if (TAILQ_EMPTY(&lun->ooa_queue)) {
11555				lun->idle_time += getsbinuptime() -
11556				    lun->last_busy;
11557			}
11558#endif
11559			TAILQ_INSERT_TAIL(&lun->ooa_queue, &ctsio->io_hdr,
11560			    ooa_links);
11561		}
11562	} else {
11563		ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr = NULL;
11564		ctsio->io_hdr.ctl_private[CTL_PRIV_BACKEND_LUN].ptr = NULL;
11565	}
11566
11567	/* Get command entry and return error if it is unsuppotyed. */
11568	entry = ctl_validate_command(ctsio);
11569	if (entry == NULL) {
11570		if (lun)
11571			mtx_unlock(&lun->lun_lock);
11572		return (retval);
11573	}
11574
11575	ctsio->io_hdr.flags &= ~CTL_FLAG_DATA_MASK;
11576	ctsio->io_hdr.flags |= entry->flags & CTL_FLAG_DATA_MASK;
11577
11578	/*
11579	 * Check to see whether we can send this command to LUNs that don't
11580	 * exist.  This should pretty much only be the case for inquiry
11581	 * and request sense.  Further checks, below, really require having
11582	 * a LUN, so we can't really check the command anymore.  Just put
11583	 * it on the rtr queue.
11584	 */
11585	if (lun == NULL) {
11586		if (entry->flags & CTL_CMD_FLAG_OK_ON_NO_LUN) {
11587			ctsio->io_hdr.flags |= CTL_FLAG_IS_WAS_ON_RTR;
11588			ctl_enqueue_rtr((union ctl_io *)ctsio);
11589			return (retval);
11590		}
11591
11592		ctl_set_unsupported_lun(ctsio);
11593		ctl_done((union ctl_io *)ctsio);
11594		CTL_DEBUG_PRINT(("ctl_scsiio_precheck: bailing out due to invalid LUN\n"));
11595		return (retval);
11596	} else {
11597		/*
11598		 * Make sure we support this particular command on this LUN.
11599		 * e.g., we don't support writes to the control LUN.
11600		 */
11601		if (!ctl_cmd_applicable(lun->be_lun->lun_type, entry)) {
11602			mtx_unlock(&lun->lun_lock);
11603			ctl_set_invalid_opcode(ctsio);
11604			ctl_done((union ctl_io *)ctsio);
11605			return (retval);
11606		}
11607	}
11608
11609	initidx = ctl_get_initindex(&ctsio->io_hdr.nexus);
11610
11611#ifdef CTL_WITH_CA
11612	/*
11613	 * If we've got a request sense, it'll clear the contingent
11614	 * allegiance condition.  Otherwise, if we have a CA condition for
11615	 * this initiator, clear it, because it sent down a command other
11616	 * than request sense.
11617	 */
11618	if ((ctsio->cdb[0] != REQUEST_SENSE)
11619	 && (ctl_is_set(lun->have_ca, initidx)))
11620		ctl_clear_mask(lun->have_ca, initidx);
11621#endif
11622
11623	/*
11624	 * If the command has this flag set, it handles its own unit
11625	 * attention reporting, we shouldn't do anything.  Otherwise we
11626	 * check for any pending unit attentions, and send them back to the
11627	 * initiator.  We only do this when a command initially comes in,
11628	 * not when we pull it off the blocked queue.
11629	 *
11630	 * According to SAM-3, section 5.3.2, the order that things get
11631	 * presented back to the host is basically unit attentions caused
11632	 * by some sort of reset event, busy status, reservation conflicts
11633	 * or task set full, and finally any other status.
11634	 *
11635	 * One issue here is that some of the unit attentions we report
11636	 * don't fall into the "reset" category (e.g. "reported luns data
11637	 * has changed").  So reporting it here, before the reservation
11638	 * check, may be technically wrong.  I guess the only thing to do
11639	 * would be to check for and report the reset events here, and then
11640	 * check for the other unit attention types after we check for a
11641	 * reservation conflict.
11642	 *
11643	 * XXX KDM need to fix this
11644	 */
11645	if ((entry->flags & CTL_CMD_FLAG_NO_SENSE) == 0) {
11646		ctl_ua_type ua_type;
11647
11648		ua_type = ctl_build_ua(lun, initidx, &ctsio->sense_data,
11649		    SSD_TYPE_NONE);
11650		if (ua_type != CTL_UA_NONE) {
11651			mtx_unlock(&lun->lun_lock);
11652			ctsio->scsi_status = SCSI_STATUS_CHECK_COND;
11653			ctsio->io_hdr.status = CTL_SCSI_ERROR | CTL_AUTOSENSE;
11654			ctsio->sense_len = SSD_FULL_SIZE;
11655			ctl_done((union ctl_io *)ctsio);
11656			return (retval);
11657		}
11658	}
11659
11660
11661	if (ctl_scsiio_lun_check(lun, entry, ctsio) != 0) {
11662		mtx_unlock(&lun->lun_lock);
11663		ctl_done((union ctl_io *)ctsio);
11664		return (retval);
11665	}
11666
11667	/*
11668	 * XXX CHD this is where we want to send IO to other side if
11669	 * this LUN is secondary on this SC. We will need to make a copy
11670	 * of the IO and flag the IO on this side as SENT_2OTHER and the flag
11671	 * the copy we send as FROM_OTHER.
11672	 * We also need to stuff the address of the original IO so we can
11673	 * find it easily. Something similar will need be done on the other
11674	 * side so when we are done we can find the copy.
11675	 */
11676	if ((lun->flags & CTL_LUN_PRIMARY_SC) == 0 &&
11677	    (lun->flags & CTL_LUN_PEER_SC_PRIMARY) != 0 &&
11678	    (entry->flags & CTL_CMD_FLAG_RUN_HERE) == 0) {
11679		union ctl_ha_msg msg_info;
11680		int isc_retval;
11681
11682		ctsio->io_hdr.flags |= CTL_FLAG_SENT_2OTHER_SC;
11683		ctsio->io_hdr.flags &= ~CTL_FLAG_IO_ACTIVE;
11684		mtx_unlock(&lun->lun_lock);
11685
11686		msg_info.hdr.msg_type = CTL_MSG_SERIALIZE;
11687		msg_info.hdr.original_sc = (union ctl_io *)ctsio;
11688		msg_info.hdr.serializing_sc = NULL;
11689		msg_info.hdr.nexus = ctsio->io_hdr.nexus;
11690		msg_info.scsi.tag_num = ctsio->tag_num;
11691		msg_info.scsi.tag_type = ctsio->tag_type;
11692		msg_info.scsi.cdb_len = ctsio->cdb_len;
11693		memcpy(msg_info.scsi.cdb, ctsio->cdb, CTL_MAX_CDBLEN);
11694
11695		if ((isc_retval = ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg_info,
11696		    sizeof(msg_info.scsi) - sizeof(msg_info.scsi.sense_data),
11697		    M_WAITOK)) > CTL_HA_STATUS_SUCCESS) {
11698			ctl_set_busy(ctsio);
11699			ctl_done((union ctl_io *)ctsio);
11700			return (retval);
11701		}
11702		return (retval);
11703	}
11704
11705	switch (ctl_check_ooa(lun, (union ctl_io *)ctsio,
11706			      (union ctl_io *)TAILQ_PREV(&ctsio->io_hdr,
11707			      ctl_ooaq, ooa_links))) {
11708	case CTL_ACTION_BLOCK:
11709		ctsio->io_hdr.flags |= CTL_FLAG_BLOCKED;
11710		TAILQ_INSERT_TAIL(&lun->blocked_queue, &ctsio->io_hdr,
11711				  blocked_links);
11712		mtx_unlock(&lun->lun_lock);
11713		return (retval);
11714	case CTL_ACTION_PASS:
11715	case CTL_ACTION_SKIP:
11716		ctsio->io_hdr.flags |= CTL_FLAG_IS_WAS_ON_RTR;
11717		mtx_unlock(&lun->lun_lock);
11718		ctl_enqueue_rtr((union ctl_io *)ctsio);
11719		break;
11720	case CTL_ACTION_OVERLAP:
11721		mtx_unlock(&lun->lun_lock);
11722		ctl_set_overlapped_cmd(ctsio);
11723		ctl_done((union ctl_io *)ctsio);
11724		break;
11725	case CTL_ACTION_OVERLAP_TAG:
11726		mtx_unlock(&lun->lun_lock);
11727		ctl_set_overlapped_tag(ctsio, ctsio->tag_num & 0xff);
11728		ctl_done((union ctl_io *)ctsio);
11729		break;
11730	case CTL_ACTION_ERROR:
11731	default:
11732		mtx_unlock(&lun->lun_lock);
11733		ctl_set_internal_failure(ctsio,
11734					 /*sks_valid*/ 0,
11735					 /*retry_count*/ 0);
11736		ctl_done((union ctl_io *)ctsio);
11737		break;
11738	}
11739	return (retval);
11740}
11741
11742const struct ctl_cmd_entry *
11743ctl_get_cmd_entry(struct ctl_scsiio *ctsio, int *sa)
11744{
11745	const struct ctl_cmd_entry *entry;
11746	int service_action;
11747
11748	entry = &ctl_cmd_table[ctsio->cdb[0]];
11749	if (sa)
11750		*sa = ((entry->flags & CTL_CMD_FLAG_SA5) != 0);
11751	if (entry->flags & CTL_CMD_FLAG_SA5) {
11752		service_action = ctsio->cdb[1] & SERVICE_ACTION_MASK;
11753		entry = &((const struct ctl_cmd_entry *)
11754		    entry->execute)[service_action];
11755	}
11756	return (entry);
11757}
11758
11759const struct ctl_cmd_entry *
11760ctl_validate_command(struct ctl_scsiio *ctsio)
11761{
11762	const struct ctl_cmd_entry *entry;
11763	int i, sa;
11764	uint8_t diff;
11765
11766	entry = ctl_get_cmd_entry(ctsio, &sa);
11767	if (entry->execute == NULL) {
11768		if (sa)
11769			ctl_set_invalid_field(ctsio,
11770					      /*sks_valid*/ 1,
11771					      /*command*/ 1,
11772					      /*field*/ 1,
11773					      /*bit_valid*/ 1,
11774					      /*bit*/ 4);
11775		else
11776			ctl_set_invalid_opcode(ctsio);
11777		ctl_done((union ctl_io *)ctsio);
11778		return (NULL);
11779	}
11780	KASSERT(entry->length > 0,
11781	    ("Not defined length for command 0x%02x/0x%02x",
11782	     ctsio->cdb[0], ctsio->cdb[1]));
11783	for (i = 1; i < entry->length; i++) {
11784		diff = ctsio->cdb[i] & ~entry->usage[i - 1];
11785		if (diff == 0)
11786			continue;
11787		ctl_set_invalid_field(ctsio,
11788				      /*sks_valid*/ 1,
11789				      /*command*/ 1,
11790				      /*field*/ i,
11791				      /*bit_valid*/ 1,
11792				      /*bit*/ fls(diff) - 1);
11793		ctl_done((union ctl_io *)ctsio);
11794		return (NULL);
11795	}
11796	return (entry);
11797}
11798
11799static int
11800ctl_cmd_applicable(uint8_t lun_type, const struct ctl_cmd_entry *entry)
11801{
11802
11803	switch (lun_type) {
11804	case T_DIRECT:
11805		if ((entry->flags & CTL_CMD_FLAG_OK_ON_DIRECT) == 0)
11806			return (0);
11807		break;
11808	case T_PROCESSOR:
11809		if ((entry->flags & CTL_CMD_FLAG_OK_ON_PROC) == 0)
11810			return (0);
11811		break;
11812	case T_CDROM:
11813		if ((entry->flags & CTL_CMD_FLAG_OK_ON_CDROM) == 0)
11814			return (0);
11815		break;
11816	default:
11817		return (0);
11818	}
11819	return (1);
11820}
11821
11822static int
11823ctl_scsiio(struct ctl_scsiio *ctsio)
11824{
11825	int retval;
11826	const struct ctl_cmd_entry *entry;
11827
11828	retval = CTL_RETVAL_COMPLETE;
11829
11830	CTL_DEBUG_PRINT(("ctl_scsiio cdb[0]=%02X\n", ctsio->cdb[0]));
11831
11832	entry = ctl_get_cmd_entry(ctsio, NULL);
11833
11834	/*
11835	 * If this I/O has been aborted, just send it straight to
11836	 * ctl_done() without executing it.
11837	 */
11838	if (ctsio->io_hdr.flags & CTL_FLAG_ABORT) {
11839		ctl_done((union ctl_io *)ctsio);
11840		goto bailout;
11841	}
11842
11843	/*
11844	 * All the checks should have been handled by ctl_scsiio_precheck().
11845	 * We should be clear now to just execute the I/O.
11846	 */
11847	retval = entry->execute(ctsio);
11848
11849bailout:
11850	return (retval);
11851}
11852
11853/*
11854 * Since we only implement one target right now, a bus reset simply resets
11855 * our single target.
11856 */
11857static int
11858ctl_bus_reset(struct ctl_softc *softc, union ctl_io *io)
11859{
11860	return(ctl_target_reset(softc, io, CTL_UA_BUS_RESET));
11861}
11862
11863static int
11864ctl_target_reset(struct ctl_softc *softc, union ctl_io *io,
11865		 ctl_ua_type ua_type)
11866{
11867	struct ctl_port *port;
11868	struct ctl_lun *lun;
11869	int retval;
11870
11871	if (!(io->io_hdr.flags & CTL_FLAG_FROM_OTHER_SC)) {
11872		union ctl_ha_msg msg_info;
11873
11874		msg_info.hdr.nexus = io->io_hdr.nexus;
11875		if (ua_type==CTL_UA_TARG_RESET)
11876			msg_info.task.task_action = CTL_TASK_TARGET_RESET;
11877		else
11878			msg_info.task.task_action = CTL_TASK_BUS_RESET;
11879		msg_info.hdr.msg_type = CTL_MSG_MANAGE_TASKS;
11880		msg_info.hdr.original_sc = NULL;
11881		msg_info.hdr.serializing_sc = NULL;
11882		ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg_info,
11883		    sizeof(msg_info.task), M_WAITOK);
11884	}
11885	retval = 0;
11886
11887	mtx_lock(&softc->ctl_lock);
11888	port = ctl_io_port(&io->io_hdr);
11889	STAILQ_FOREACH(lun, &softc->lun_list, links) {
11890		if (port != NULL &&
11891		    ctl_lun_map_to_port(port, lun->lun) >= CTL_MAX_LUNS)
11892			continue;
11893		retval += ctl_do_lun_reset(lun, io, ua_type);
11894	}
11895	mtx_unlock(&softc->ctl_lock);
11896	io->taskio.task_status = CTL_TASK_FUNCTION_COMPLETE;
11897	return (retval);
11898}
11899
11900/*
11901 * The LUN should always be set.  The I/O is optional, and is used to
11902 * distinguish between I/Os sent by this initiator, and by other
11903 * initiators.  We set unit attention for initiators other than this one.
11904 * SAM-3 is vague on this point.  It does say that a unit attention should
11905 * be established for other initiators when a LUN is reset (see section
11906 * 5.7.3), but it doesn't specifically say that the unit attention should
11907 * be established for this particular initiator when a LUN is reset.  Here
11908 * is the relevant text, from SAM-3 rev 8:
11909 *
11910 * 5.7.2 When a SCSI initiator port aborts its own tasks
11911 *
11912 * When a SCSI initiator port causes its own task(s) to be aborted, no
11913 * notification that the task(s) have been aborted shall be returned to
11914 * the SCSI initiator port other than the completion response for the
11915 * command or task management function action that caused the task(s) to
11916 * be aborted and notification(s) associated with related effects of the
11917 * action (e.g., a reset unit attention condition).
11918 *
11919 * XXX KDM for now, we're setting unit attention for all initiators.
11920 */
11921static int
11922ctl_do_lun_reset(struct ctl_lun *lun, union ctl_io *io, ctl_ua_type ua_type)
11923{
11924	union ctl_io *xio;
11925#if 0
11926	uint32_t initidx;
11927#endif
11928	int i;
11929
11930	mtx_lock(&lun->lun_lock);
11931	/*
11932	 * Run through the OOA queue and abort each I/O.
11933	 */
11934	for (xio = (union ctl_io *)TAILQ_FIRST(&lun->ooa_queue); xio != NULL;
11935	     xio = (union ctl_io *)TAILQ_NEXT(&xio->io_hdr, ooa_links)) {
11936		xio->io_hdr.flags |= CTL_FLAG_ABORT | CTL_FLAG_ABORT_STATUS;
11937	}
11938
11939	/*
11940	 * This version sets unit attention for every
11941	 */
11942#if 0
11943	initidx = ctl_get_initindex(&io->io_hdr.nexus);
11944	ctl_est_ua_all(lun, initidx, ua_type);
11945#else
11946	ctl_est_ua_all(lun, -1, ua_type);
11947#endif
11948
11949	/*
11950	 * A reset (any kind, really) clears reservations established with
11951	 * RESERVE/RELEASE.  It does not clear reservations established
11952	 * with PERSISTENT RESERVE OUT, but we don't support that at the
11953	 * moment anyway.  See SPC-2, section 5.6.  SPC-3 doesn't address
11954	 * reservations made with the RESERVE/RELEASE commands, because
11955	 * those commands are obsolete in SPC-3.
11956	 */
11957	lun->flags &= ~CTL_LUN_RESERVED;
11958
11959#ifdef CTL_WITH_CA
11960	for (i = 0; i < CTL_MAX_INITIATORS; i++)
11961		ctl_clear_mask(lun->have_ca, i);
11962#endif
11963	lun->prevent_count = 0;
11964	for (i = 0; i < CTL_MAX_INITIATORS; i++)
11965		ctl_clear_mask(lun->prevent, i);
11966	mtx_unlock(&lun->lun_lock);
11967
11968	return (0);
11969}
11970
11971static int
11972ctl_lun_reset(struct ctl_softc *softc, union ctl_io *io)
11973{
11974	struct ctl_lun *lun;
11975	uint32_t targ_lun;
11976	int retval;
11977
11978	targ_lun = io->io_hdr.nexus.targ_mapped_lun;
11979	mtx_lock(&softc->ctl_lock);
11980	if ((targ_lun >= CTL_MAX_LUNS) ||
11981	    (lun = softc->ctl_luns[targ_lun]) == NULL) {
11982		mtx_unlock(&softc->ctl_lock);
11983		io->taskio.task_status = CTL_TASK_LUN_DOES_NOT_EXIST;
11984		return (1);
11985	}
11986	retval = ctl_do_lun_reset(lun, io, CTL_UA_LUN_RESET);
11987	mtx_unlock(&softc->ctl_lock);
11988	io->taskio.task_status = CTL_TASK_FUNCTION_COMPLETE;
11989
11990	if ((io->io_hdr.flags & CTL_FLAG_FROM_OTHER_SC) == 0) {
11991		union ctl_ha_msg msg_info;
11992
11993		msg_info.hdr.msg_type = CTL_MSG_MANAGE_TASKS;
11994		msg_info.hdr.nexus = io->io_hdr.nexus;
11995		msg_info.task.task_action = CTL_TASK_LUN_RESET;
11996		msg_info.hdr.original_sc = NULL;
11997		msg_info.hdr.serializing_sc = NULL;
11998		ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg_info,
11999		    sizeof(msg_info.task), M_WAITOK);
12000	}
12001	return (retval);
12002}
12003
12004static void
12005ctl_abort_tasks_lun(struct ctl_lun *lun, uint32_t targ_port, uint32_t init_id,
12006    int other_sc)
12007{
12008	union ctl_io *xio;
12009
12010	mtx_assert(&lun->lun_lock, MA_OWNED);
12011
12012	/*
12013	 * Run through the OOA queue and attempt to find the given I/O.
12014	 * The target port, initiator ID, tag type and tag number have to
12015	 * match the values that we got from the initiator.  If we have an
12016	 * untagged command to abort, simply abort the first untagged command
12017	 * we come to.  We only allow one untagged command at a time of course.
12018	 */
12019	for (xio = (union ctl_io *)TAILQ_FIRST(&lun->ooa_queue); xio != NULL;
12020	     xio = (union ctl_io *)TAILQ_NEXT(&xio->io_hdr, ooa_links)) {
12021
12022		if ((targ_port == UINT32_MAX ||
12023		     targ_port == xio->io_hdr.nexus.targ_port) &&
12024		    (init_id == UINT32_MAX ||
12025		     init_id == xio->io_hdr.nexus.initid)) {
12026			if (targ_port != xio->io_hdr.nexus.targ_port ||
12027			    init_id != xio->io_hdr.nexus.initid)
12028				xio->io_hdr.flags |= CTL_FLAG_ABORT_STATUS;
12029			xio->io_hdr.flags |= CTL_FLAG_ABORT;
12030			if (!other_sc && !(lun->flags & CTL_LUN_PRIMARY_SC)) {
12031				union ctl_ha_msg msg_info;
12032
12033				msg_info.hdr.nexus = xio->io_hdr.nexus;
12034				msg_info.task.task_action = CTL_TASK_ABORT_TASK;
12035				msg_info.task.tag_num = xio->scsiio.tag_num;
12036				msg_info.task.tag_type = xio->scsiio.tag_type;
12037				msg_info.hdr.msg_type = CTL_MSG_MANAGE_TASKS;
12038				msg_info.hdr.original_sc = NULL;
12039				msg_info.hdr.serializing_sc = NULL;
12040				ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg_info,
12041				    sizeof(msg_info.task), M_NOWAIT);
12042			}
12043		}
12044	}
12045}
12046
12047static int
12048ctl_abort_task_set(union ctl_io *io)
12049{
12050	struct ctl_softc *softc = control_softc;
12051	struct ctl_lun *lun;
12052	uint32_t targ_lun;
12053
12054	/*
12055	 * Look up the LUN.
12056	 */
12057	targ_lun = io->io_hdr.nexus.targ_mapped_lun;
12058	mtx_lock(&softc->ctl_lock);
12059	if ((targ_lun >= CTL_MAX_LUNS) ||
12060	    (lun = softc->ctl_luns[targ_lun]) == NULL) {
12061		mtx_unlock(&softc->ctl_lock);
12062		io->taskio.task_status = CTL_TASK_LUN_DOES_NOT_EXIST;
12063		return (1);
12064	}
12065
12066	mtx_lock(&lun->lun_lock);
12067	mtx_unlock(&softc->ctl_lock);
12068	if (io->taskio.task_action == CTL_TASK_ABORT_TASK_SET) {
12069		ctl_abort_tasks_lun(lun, io->io_hdr.nexus.targ_port,
12070		    io->io_hdr.nexus.initid,
12071		    (io->io_hdr.flags & CTL_FLAG_FROM_OTHER_SC) != 0);
12072	} else { /* CTL_TASK_CLEAR_TASK_SET */
12073		ctl_abort_tasks_lun(lun, UINT32_MAX, UINT32_MAX,
12074		    (io->io_hdr.flags & CTL_FLAG_FROM_OTHER_SC) != 0);
12075	}
12076	mtx_unlock(&lun->lun_lock);
12077	io->taskio.task_status = CTL_TASK_FUNCTION_COMPLETE;
12078	return (0);
12079}
12080
12081static int
12082ctl_i_t_nexus_reset(union ctl_io *io)
12083{
12084	struct ctl_softc *softc = control_softc;
12085	struct ctl_lun *lun;
12086	uint32_t initidx;
12087
12088	if (!(io->io_hdr.flags & CTL_FLAG_FROM_OTHER_SC)) {
12089		union ctl_ha_msg msg_info;
12090
12091		msg_info.hdr.nexus = io->io_hdr.nexus;
12092		msg_info.task.task_action = CTL_TASK_I_T_NEXUS_RESET;
12093		msg_info.hdr.msg_type = CTL_MSG_MANAGE_TASKS;
12094		msg_info.hdr.original_sc = NULL;
12095		msg_info.hdr.serializing_sc = NULL;
12096		ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg_info,
12097		    sizeof(msg_info.task), M_WAITOK);
12098	}
12099
12100	initidx = ctl_get_initindex(&io->io_hdr.nexus);
12101	mtx_lock(&softc->ctl_lock);
12102	STAILQ_FOREACH(lun, &softc->lun_list, links) {
12103		mtx_lock(&lun->lun_lock);
12104		ctl_abort_tasks_lun(lun, io->io_hdr.nexus.targ_port,
12105		    io->io_hdr.nexus.initid, 1);
12106#ifdef CTL_WITH_CA
12107		ctl_clear_mask(lun->have_ca, initidx);
12108#endif
12109		if ((lun->flags & CTL_LUN_RESERVED) && (lun->res_idx == initidx))
12110			lun->flags &= ~CTL_LUN_RESERVED;
12111		if (ctl_is_set(lun->prevent, initidx)) {
12112			ctl_clear_mask(lun->prevent, initidx);
12113			lun->prevent_count--;
12114		}
12115		ctl_est_ua(lun, initidx, CTL_UA_I_T_NEXUS_LOSS);
12116		mtx_unlock(&lun->lun_lock);
12117	}
12118	mtx_unlock(&softc->ctl_lock);
12119	io->taskio.task_status = CTL_TASK_FUNCTION_COMPLETE;
12120	return (0);
12121}
12122
12123static int
12124ctl_abort_task(union ctl_io *io)
12125{
12126	union ctl_io *xio;
12127	struct ctl_lun *lun;
12128	struct ctl_softc *softc;
12129#if 0
12130	struct sbuf sb;
12131	char printbuf[128];
12132#endif
12133	int found;
12134	uint32_t targ_lun;
12135
12136	softc = control_softc;
12137	found = 0;
12138
12139	/*
12140	 * Look up the LUN.
12141	 */
12142	targ_lun = io->io_hdr.nexus.targ_mapped_lun;
12143	mtx_lock(&softc->ctl_lock);
12144	if ((targ_lun >= CTL_MAX_LUNS) ||
12145	    (lun = softc->ctl_luns[targ_lun]) == NULL) {
12146		mtx_unlock(&softc->ctl_lock);
12147		io->taskio.task_status = CTL_TASK_LUN_DOES_NOT_EXIST;
12148		return (1);
12149	}
12150
12151#if 0
12152	printf("ctl_abort_task: called for lun %lld, tag %d type %d\n",
12153	       lun->lun, io->taskio.tag_num, io->taskio.tag_type);
12154#endif
12155
12156	mtx_lock(&lun->lun_lock);
12157	mtx_unlock(&softc->ctl_lock);
12158	/*
12159	 * Run through the OOA queue and attempt to find the given I/O.
12160	 * The target port, initiator ID, tag type and tag number have to
12161	 * match the values that we got from the initiator.  If we have an
12162	 * untagged command to abort, simply abort the first untagged command
12163	 * we come to.  We only allow one untagged command at a time of course.
12164	 */
12165	for (xio = (union ctl_io *)TAILQ_FIRST(&lun->ooa_queue); xio != NULL;
12166	     xio = (union ctl_io *)TAILQ_NEXT(&xio->io_hdr, ooa_links)) {
12167#if 0
12168		sbuf_new(&sb, printbuf, sizeof(printbuf), SBUF_FIXEDLEN);
12169
12170		sbuf_printf(&sb, "LUN %lld tag %d type %d%s%s%s%s: ",
12171			    lun->lun, xio->scsiio.tag_num,
12172			    xio->scsiio.tag_type,
12173			    (xio->io_hdr.blocked_links.tqe_prev
12174			    == NULL) ? "" : " BLOCKED",
12175			    (xio->io_hdr.flags &
12176			    CTL_FLAG_DMA_INPROG) ? " DMA" : "",
12177			    (xio->io_hdr.flags &
12178			    CTL_FLAG_ABORT) ? " ABORT" : "",
12179			    (xio->io_hdr.flags &
12180			    CTL_FLAG_IS_WAS_ON_RTR ? " RTR" : ""));
12181		ctl_scsi_command_string(&xio->scsiio, NULL, &sb);
12182		sbuf_finish(&sb);
12183		printf("%s\n", sbuf_data(&sb));
12184#endif
12185
12186		if ((xio->io_hdr.nexus.targ_port != io->io_hdr.nexus.targ_port)
12187		 || (xio->io_hdr.nexus.initid != io->io_hdr.nexus.initid)
12188		 || (xio->io_hdr.flags & CTL_FLAG_ABORT))
12189			continue;
12190
12191		/*
12192		 * If the abort says that the task is untagged, the
12193		 * task in the queue must be untagged.  Otherwise,
12194		 * we just check to see whether the tag numbers
12195		 * match.  This is because the QLogic firmware
12196		 * doesn't pass back the tag type in an abort
12197		 * request.
12198		 */
12199#if 0
12200		if (((xio->scsiio.tag_type == CTL_TAG_UNTAGGED)
12201		  && (io->taskio.tag_type == CTL_TAG_UNTAGGED))
12202		 || (xio->scsiio.tag_num == io->taskio.tag_num))
12203#endif
12204		/*
12205		 * XXX KDM we've got problems with FC, because it
12206		 * doesn't send down a tag type with aborts.  So we
12207		 * can only really go by the tag number...
12208		 * This may cause problems with parallel SCSI.
12209		 * Need to figure that out!!
12210		 */
12211		if (xio->scsiio.tag_num == io->taskio.tag_num) {
12212			xio->io_hdr.flags |= CTL_FLAG_ABORT;
12213			found = 1;
12214			if ((io->io_hdr.flags & CTL_FLAG_FROM_OTHER_SC) == 0 &&
12215			    !(lun->flags & CTL_LUN_PRIMARY_SC)) {
12216				union ctl_ha_msg msg_info;
12217
12218				msg_info.hdr.nexus = io->io_hdr.nexus;
12219				msg_info.task.task_action = CTL_TASK_ABORT_TASK;
12220				msg_info.task.tag_num = io->taskio.tag_num;
12221				msg_info.task.tag_type = io->taskio.tag_type;
12222				msg_info.hdr.msg_type = CTL_MSG_MANAGE_TASKS;
12223				msg_info.hdr.original_sc = NULL;
12224				msg_info.hdr.serializing_sc = NULL;
12225#if 0
12226				printf("Sent Abort to other side\n");
12227#endif
12228				ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg_info,
12229				    sizeof(msg_info.task), M_NOWAIT);
12230			}
12231#if 0
12232			printf("ctl_abort_task: found I/O to abort\n");
12233#endif
12234		}
12235	}
12236	mtx_unlock(&lun->lun_lock);
12237
12238	if (found == 0) {
12239		/*
12240		 * This isn't really an error.  It's entirely possible for
12241		 * the abort and command completion to cross on the wire.
12242		 * This is more of an informative/diagnostic error.
12243		 */
12244#if 0
12245		printf("ctl_abort_task: ABORT sent for nonexistent I/O: "
12246		       "%u:%u:%u tag %d type %d\n",
12247		       io->io_hdr.nexus.initid,
12248		       io->io_hdr.nexus.targ_port,
12249		       io->io_hdr.nexus.targ_lun, io->taskio.tag_num,
12250		       io->taskio.tag_type);
12251#endif
12252	}
12253	io->taskio.task_status = CTL_TASK_FUNCTION_COMPLETE;
12254	return (0);
12255}
12256
12257static int
12258ctl_query_task(union ctl_io *io, int task_set)
12259{
12260	union ctl_io *xio;
12261	struct ctl_lun *lun;
12262	struct ctl_softc *softc;
12263	int found = 0;
12264	uint32_t targ_lun;
12265
12266	softc = control_softc;
12267	targ_lun = io->io_hdr.nexus.targ_mapped_lun;
12268	mtx_lock(&softc->ctl_lock);
12269	if ((targ_lun >= CTL_MAX_LUNS) ||
12270	    (lun = softc->ctl_luns[targ_lun]) == NULL) {
12271		mtx_unlock(&softc->ctl_lock);
12272		io->taskio.task_status = CTL_TASK_LUN_DOES_NOT_EXIST;
12273		return (1);
12274	}
12275	mtx_lock(&lun->lun_lock);
12276	mtx_unlock(&softc->ctl_lock);
12277	for (xio = (union ctl_io *)TAILQ_FIRST(&lun->ooa_queue); xio != NULL;
12278	     xio = (union ctl_io *)TAILQ_NEXT(&xio->io_hdr, ooa_links)) {
12279
12280		if ((xio->io_hdr.nexus.targ_port != io->io_hdr.nexus.targ_port)
12281		 || (xio->io_hdr.nexus.initid != io->io_hdr.nexus.initid)
12282		 || (xio->io_hdr.flags & CTL_FLAG_ABORT))
12283			continue;
12284
12285		if (task_set || xio->scsiio.tag_num == io->taskio.tag_num) {
12286			found = 1;
12287			break;
12288		}
12289	}
12290	mtx_unlock(&lun->lun_lock);
12291	if (found)
12292		io->taskio.task_status = CTL_TASK_FUNCTION_SUCCEEDED;
12293	else
12294		io->taskio.task_status = CTL_TASK_FUNCTION_COMPLETE;
12295	return (0);
12296}
12297
12298static int
12299ctl_query_async_event(union ctl_io *io)
12300{
12301	struct ctl_lun *lun;
12302	struct ctl_softc *softc;
12303	ctl_ua_type ua;
12304	uint32_t targ_lun, initidx;
12305
12306	softc = control_softc;
12307	targ_lun = io->io_hdr.nexus.targ_mapped_lun;
12308	mtx_lock(&softc->ctl_lock);
12309	if ((targ_lun >= CTL_MAX_LUNS) ||
12310	    (lun = softc->ctl_luns[targ_lun]) == NULL) {
12311		mtx_unlock(&softc->ctl_lock);
12312		io->taskio.task_status = CTL_TASK_LUN_DOES_NOT_EXIST;
12313		return (1);
12314	}
12315	mtx_lock(&lun->lun_lock);
12316	mtx_unlock(&softc->ctl_lock);
12317	initidx = ctl_get_initindex(&io->io_hdr.nexus);
12318	ua = ctl_build_qae(lun, initidx, io->taskio.task_resp);
12319	mtx_unlock(&lun->lun_lock);
12320	if (ua != CTL_UA_NONE)
12321		io->taskio.task_status = CTL_TASK_FUNCTION_SUCCEEDED;
12322	else
12323		io->taskio.task_status = CTL_TASK_FUNCTION_COMPLETE;
12324	return (0);
12325}
12326
12327static void
12328ctl_run_task(union ctl_io *io)
12329{
12330	struct ctl_softc *softc = control_softc;
12331	int retval = 1;
12332
12333	CTL_DEBUG_PRINT(("ctl_run_task\n"));
12334	KASSERT(io->io_hdr.io_type == CTL_IO_TASK,
12335	    ("ctl_run_task: Unextected io_type %d\n", io->io_hdr.io_type));
12336	io->taskio.task_status = CTL_TASK_FUNCTION_NOT_SUPPORTED;
12337	bzero(io->taskio.task_resp, sizeof(io->taskio.task_resp));
12338	switch (io->taskio.task_action) {
12339	case CTL_TASK_ABORT_TASK:
12340		retval = ctl_abort_task(io);
12341		break;
12342	case CTL_TASK_ABORT_TASK_SET:
12343	case CTL_TASK_CLEAR_TASK_SET:
12344		retval = ctl_abort_task_set(io);
12345		break;
12346	case CTL_TASK_CLEAR_ACA:
12347		break;
12348	case CTL_TASK_I_T_NEXUS_RESET:
12349		retval = ctl_i_t_nexus_reset(io);
12350		break;
12351	case CTL_TASK_LUN_RESET:
12352		retval = ctl_lun_reset(softc, io);
12353		break;
12354	case CTL_TASK_TARGET_RESET:
12355		retval = ctl_target_reset(softc, io, CTL_UA_TARG_RESET);
12356		break;
12357	case CTL_TASK_BUS_RESET:
12358		retval = ctl_bus_reset(softc, io);
12359		break;
12360	case CTL_TASK_PORT_LOGIN:
12361		break;
12362	case CTL_TASK_PORT_LOGOUT:
12363		break;
12364	case CTL_TASK_QUERY_TASK:
12365		retval = ctl_query_task(io, 0);
12366		break;
12367	case CTL_TASK_QUERY_TASK_SET:
12368		retval = ctl_query_task(io, 1);
12369		break;
12370	case CTL_TASK_QUERY_ASYNC_EVENT:
12371		retval = ctl_query_async_event(io);
12372		break;
12373	default:
12374		printf("%s: got unknown task management event %d\n",
12375		       __func__, io->taskio.task_action);
12376		break;
12377	}
12378	if (retval == 0)
12379		io->io_hdr.status = CTL_SUCCESS;
12380	else
12381		io->io_hdr.status = CTL_ERROR;
12382	ctl_done(io);
12383}
12384
12385/*
12386 * For HA operation.  Handle commands that come in from the other
12387 * controller.
12388 */
12389static void
12390ctl_handle_isc(union ctl_io *io)
12391{
12392	int free_io;
12393	struct ctl_lun *lun;
12394	struct ctl_softc *softc = control_softc;
12395	uint32_t targ_lun;
12396
12397	targ_lun = io->io_hdr.nexus.targ_mapped_lun;
12398	lun = softc->ctl_luns[targ_lun];
12399
12400	switch (io->io_hdr.msg_type) {
12401	case CTL_MSG_SERIALIZE:
12402		free_io = ctl_serialize_other_sc_cmd(&io->scsiio);
12403		break;
12404	case CTL_MSG_R2R: {
12405		const struct ctl_cmd_entry *entry;
12406
12407		/*
12408		 * This is only used in SER_ONLY mode.
12409		 */
12410		free_io = 0;
12411		entry = ctl_get_cmd_entry(&io->scsiio, NULL);
12412		mtx_lock(&lun->lun_lock);
12413		if (ctl_scsiio_lun_check(lun,
12414		    entry, (struct ctl_scsiio *)io) != 0) {
12415			mtx_unlock(&lun->lun_lock);
12416			ctl_done(io);
12417			break;
12418		}
12419		io->io_hdr.flags |= CTL_FLAG_IS_WAS_ON_RTR;
12420		mtx_unlock(&lun->lun_lock);
12421		ctl_enqueue_rtr(io);
12422		break;
12423	}
12424	case CTL_MSG_FINISH_IO:
12425		if (softc->ha_mode == CTL_HA_MODE_XFER) {
12426			free_io = 0;
12427			ctl_done(io);
12428		} else {
12429			free_io = 1;
12430			mtx_lock(&lun->lun_lock);
12431			TAILQ_REMOVE(&lun->ooa_queue, &io->io_hdr,
12432				     ooa_links);
12433			ctl_check_blocked(lun);
12434			mtx_unlock(&lun->lun_lock);
12435		}
12436		break;
12437	case CTL_MSG_PERS_ACTION:
12438		ctl_hndl_per_res_out_on_other_sc(
12439			(union ctl_ha_msg *)&io->presio.pr_msg);
12440		free_io = 1;
12441		break;
12442	case CTL_MSG_BAD_JUJU:
12443		free_io = 0;
12444		ctl_done(io);
12445		break;
12446	case CTL_MSG_DATAMOVE:
12447		/* Only used in XFER mode */
12448		free_io = 0;
12449		ctl_datamove_remote(io);
12450		break;
12451	case CTL_MSG_DATAMOVE_DONE:
12452		/* Only used in XFER mode */
12453		free_io = 0;
12454		io->scsiio.be_move_done(io);
12455		break;
12456	case CTL_MSG_FAILOVER:
12457		ctl_failover_lun(io);
12458		free_io = 1;
12459		break;
12460	default:
12461		free_io = 1;
12462		printf("%s: Invalid message type %d\n",
12463		       __func__, io->io_hdr.msg_type);
12464		break;
12465	}
12466	if (free_io)
12467		ctl_free_io(io);
12468
12469}
12470
12471
12472/*
12473 * Returns the match type in the case of a match, or CTL_LUN_PAT_NONE if
12474 * there is no match.
12475 */
12476static ctl_lun_error_pattern
12477ctl_cmd_pattern_match(struct ctl_scsiio *ctsio, struct ctl_error_desc *desc)
12478{
12479	const struct ctl_cmd_entry *entry;
12480	ctl_lun_error_pattern filtered_pattern, pattern;
12481
12482	pattern = desc->error_pattern;
12483
12484	/*
12485	 * XXX KDM we need more data passed into this function to match a
12486	 * custom pattern, and we actually need to implement custom pattern
12487	 * matching.
12488	 */
12489	if (pattern & CTL_LUN_PAT_CMD)
12490		return (CTL_LUN_PAT_CMD);
12491
12492	if ((pattern & CTL_LUN_PAT_MASK) == CTL_LUN_PAT_ANY)
12493		return (CTL_LUN_PAT_ANY);
12494
12495	entry = ctl_get_cmd_entry(ctsio, NULL);
12496
12497	filtered_pattern = entry->pattern & pattern;
12498
12499	/*
12500	 * If the user requested specific flags in the pattern (e.g.
12501	 * CTL_LUN_PAT_RANGE), make sure the command supports all of those
12502	 * flags.
12503	 *
12504	 * If the user did not specify any flags, it doesn't matter whether
12505	 * or not the command supports the flags.
12506	 */
12507	if ((filtered_pattern & ~CTL_LUN_PAT_MASK) !=
12508	     (pattern & ~CTL_LUN_PAT_MASK))
12509		return (CTL_LUN_PAT_NONE);
12510
12511	/*
12512	 * If the user asked for a range check, see if the requested LBA
12513	 * range overlaps with this command's LBA range.
12514	 */
12515	if (filtered_pattern & CTL_LUN_PAT_RANGE) {
12516		uint64_t lba1;
12517		uint64_t len1;
12518		ctl_action action;
12519		int retval;
12520
12521		retval = ctl_get_lba_len((union ctl_io *)ctsio, &lba1, &len1);
12522		if (retval != 0)
12523			return (CTL_LUN_PAT_NONE);
12524
12525		action = ctl_extent_check_lba(lba1, len1, desc->lba_range.lba,
12526					      desc->lba_range.len, FALSE);
12527		/*
12528		 * A "pass" means that the LBA ranges don't overlap, so
12529		 * this doesn't match the user's range criteria.
12530		 */
12531		if (action == CTL_ACTION_PASS)
12532			return (CTL_LUN_PAT_NONE);
12533	}
12534
12535	return (filtered_pattern);
12536}
12537
12538static void
12539ctl_inject_error(struct ctl_lun *lun, union ctl_io *io)
12540{
12541	struct ctl_error_desc *desc, *desc2;
12542
12543	mtx_assert(&lun->lun_lock, MA_OWNED);
12544
12545	STAILQ_FOREACH_SAFE(desc, &lun->error_list, links, desc2) {
12546		ctl_lun_error_pattern pattern;
12547		/*
12548		 * Check to see whether this particular command matches
12549		 * the pattern in the descriptor.
12550		 */
12551		pattern = ctl_cmd_pattern_match(&io->scsiio, desc);
12552		if ((pattern & CTL_LUN_PAT_MASK) == CTL_LUN_PAT_NONE)
12553			continue;
12554
12555		switch (desc->lun_error & CTL_LUN_INJ_TYPE) {
12556		case CTL_LUN_INJ_ABORTED:
12557			ctl_set_aborted(&io->scsiio);
12558			break;
12559		case CTL_LUN_INJ_MEDIUM_ERR:
12560			ctl_set_medium_error(&io->scsiio,
12561			    (io->io_hdr.flags & CTL_FLAG_DATA_MASK) !=
12562			     CTL_FLAG_DATA_OUT);
12563			break;
12564		case CTL_LUN_INJ_UA:
12565			/* 29h/00h  POWER ON, RESET, OR BUS DEVICE RESET
12566			 * OCCURRED */
12567			ctl_set_ua(&io->scsiio, 0x29, 0x00);
12568			break;
12569		case CTL_LUN_INJ_CUSTOM:
12570			/*
12571			 * We're assuming the user knows what he is doing.
12572			 * Just copy the sense information without doing
12573			 * checks.
12574			 */
12575			bcopy(&desc->custom_sense, &io->scsiio.sense_data,
12576			      MIN(sizeof(desc->custom_sense),
12577				  sizeof(io->scsiio.sense_data)));
12578			io->scsiio.scsi_status = SCSI_STATUS_CHECK_COND;
12579			io->scsiio.sense_len = SSD_FULL_SIZE;
12580			io->io_hdr.status = CTL_SCSI_ERROR | CTL_AUTOSENSE;
12581			break;
12582		case CTL_LUN_INJ_NONE:
12583		default:
12584			/*
12585			 * If this is an error injection type we don't know
12586			 * about, clear the continuous flag (if it is set)
12587			 * so it will get deleted below.
12588			 */
12589			desc->lun_error &= ~CTL_LUN_INJ_CONTINUOUS;
12590			break;
12591		}
12592		/*
12593		 * By default, each error injection action is a one-shot
12594		 */
12595		if (desc->lun_error & CTL_LUN_INJ_CONTINUOUS)
12596			continue;
12597
12598		STAILQ_REMOVE(&lun->error_list, desc, ctl_error_desc, links);
12599
12600		free(desc, M_CTL);
12601	}
12602}
12603
12604#ifdef CTL_IO_DELAY
12605static void
12606ctl_datamove_timer_wakeup(void *arg)
12607{
12608	union ctl_io *io;
12609
12610	io = (union ctl_io *)arg;
12611
12612	ctl_datamove(io);
12613}
12614#endif /* CTL_IO_DELAY */
12615
12616void
12617ctl_datamove(union ctl_io *io)
12618{
12619	struct ctl_lun *lun;
12620	void (*fe_datamove)(union ctl_io *io);
12621
12622	mtx_assert(&control_softc->ctl_lock, MA_NOTOWNED);
12623
12624	CTL_DEBUG_PRINT(("ctl_datamove\n"));
12625
12626	lun = (struct ctl_lun *)io->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
12627#ifdef CTL_TIME_IO
12628	if ((time_uptime - io->io_hdr.start_time) > ctl_time_io_secs) {
12629		char str[256];
12630		char path_str[64];
12631		struct sbuf sb;
12632
12633		ctl_scsi_path_string(io, path_str, sizeof(path_str));
12634		sbuf_new(&sb, str, sizeof(str), SBUF_FIXEDLEN);
12635
12636		sbuf_cat(&sb, path_str);
12637		switch (io->io_hdr.io_type) {
12638		case CTL_IO_SCSI:
12639			ctl_scsi_command_string(&io->scsiio, NULL, &sb);
12640			sbuf_printf(&sb, "\n");
12641			sbuf_cat(&sb, path_str);
12642			sbuf_printf(&sb, "Tag: 0x%04x, type %d\n",
12643				    io->scsiio.tag_num, io->scsiio.tag_type);
12644			break;
12645		case CTL_IO_TASK:
12646			sbuf_printf(&sb, "Task I/O type: %d, Tag: 0x%04x, "
12647				    "Tag Type: %d\n", io->taskio.task_action,
12648				    io->taskio.tag_num, io->taskio.tag_type);
12649			break;
12650		default:
12651			panic("%s: Invalid CTL I/O type %d\n",
12652			    __func__, io->io_hdr.io_type);
12653		}
12654		sbuf_cat(&sb, path_str);
12655		sbuf_printf(&sb, "ctl_datamove: %jd seconds\n",
12656			    (intmax_t)time_uptime - io->io_hdr.start_time);
12657		sbuf_finish(&sb);
12658		printf("%s", sbuf_data(&sb));
12659	}
12660#endif /* CTL_TIME_IO */
12661
12662#ifdef CTL_IO_DELAY
12663	if (io->io_hdr.flags & CTL_FLAG_DELAY_DONE) {
12664		io->io_hdr.flags &= ~CTL_FLAG_DELAY_DONE;
12665	} else {
12666		if ((lun != NULL)
12667		 && (lun->delay_info.datamove_delay > 0)) {
12668
12669			callout_init(&io->io_hdr.delay_callout, /*mpsafe*/ 1);
12670			io->io_hdr.flags |= CTL_FLAG_DELAY_DONE;
12671			callout_reset(&io->io_hdr.delay_callout,
12672				      lun->delay_info.datamove_delay * hz,
12673				      ctl_datamove_timer_wakeup, io);
12674			if (lun->delay_info.datamove_type ==
12675			    CTL_DELAY_TYPE_ONESHOT)
12676				lun->delay_info.datamove_delay = 0;
12677			return;
12678		}
12679	}
12680#endif
12681
12682	/*
12683	 * This command has been aborted.  Set the port status, so we fail
12684	 * the data move.
12685	 */
12686	if (io->io_hdr.flags & CTL_FLAG_ABORT) {
12687		printf("ctl_datamove: tag 0x%04x on (%u:%u:%u) aborted\n",
12688		       io->scsiio.tag_num, io->io_hdr.nexus.initid,
12689		       io->io_hdr.nexus.targ_port,
12690		       io->io_hdr.nexus.targ_lun);
12691		io->io_hdr.port_status = 31337;
12692		/*
12693		 * Note that the backend, in this case, will get the
12694		 * callback in its context.  In other cases it may get
12695		 * called in the frontend's interrupt thread context.
12696		 */
12697		io->scsiio.be_move_done(io);
12698		return;
12699	}
12700
12701	/* Don't confuse frontend with zero length data move. */
12702	if (io->scsiio.kern_data_len == 0) {
12703		io->scsiio.be_move_done(io);
12704		return;
12705	}
12706
12707	fe_datamove = ctl_io_port(&io->io_hdr)->fe_datamove;
12708	fe_datamove(io);
12709}
12710
12711static void
12712ctl_send_datamove_done(union ctl_io *io, int have_lock)
12713{
12714	union ctl_ha_msg msg;
12715#ifdef CTL_TIME_IO
12716	struct bintime cur_bt;
12717#endif
12718
12719	memset(&msg, 0, sizeof(msg));
12720	msg.hdr.msg_type = CTL_MSG_DATAMOVE_DONE;
12721	msg.hdr.original_sc = io;
12722	msg.hdr.serializing_sc = io->io_hdr.serializing_sc;
12723	msg.hdr.nexus = io->io_hdr.nexus;
12724	msg.hdr.status = io->io_hdr.status;
12725	msg.scsi.tag_num = io->scsiio.tag_num;
12726	msg.scsi.tag_type = io->scsiio.tag_type;
12727	msg.scsi.scsi_status = io->scsiio.scsi_status;
12728	memcpy(&msg.scsi.sense_data, &io->scsiio.sense_data,
12729	       io->scsiio.sense_len);
12730	msg.scsi.sense_len = io->scsiio.sense_len;
12731	msg.scsi.sense_residual = io->scsiio.sense_residual;
12732	msg.scsi.fetd_status = io->io_hdr.port_status;
12733	msg.scsi.residual = io->scsiio.residual;
12734	io->io_hdr.flags &= ~CTL_FLAG_IO_ACTIVE;
12735	if (io->io_hdr.flags & CTL_FLAG_FAILOVER) {
12736		ctl_failover_io(io, /*have_lock*/ have_lock);
12737		return;
12738	}
12739	ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg,
12740	    sizeof(msg.scsi) - sizeof(msg.scsi.sense_data) +
12741	    msg.scsi.sense_len, M_WAITOK);
12742
12743#ifdef CTL_TIME_IO
12744	getbinuptime(&cur_bt);
12745	bintime_sub(&cur_bt, &io->io_hdr.dma_start_bt);
12746	bintime_add(&io->io_hdr.dma_bt, &cur_bt);
12747#endif
12748	io->io_hdr.num_dmas++;
12749}
12750
12751/*
12752 * The DMA to the remote side is done, now we need to tell the other side
12753 * we're done so it can continue with its data movement.
12754 */
12755static void
12756ctl_datamove_remote_write_cb(struct ctl_ha_dt_req *rq)
12757{
12758	union ctl_io *io;
12759	uint32_t i;
12760
12761	io = rq->context;
12762
12763	if (rq->ret != CTL_HA_STATUS_SUCCESS) {
12764		printf("%s: ISC DMA write failed with error %d", __func__,
12765		       rq->ret);
12766		ctl_set_internal_failure(&io->scsiio,
12767					 /*sks_valid*/ 1,
12768					 /*retry_count*/ rq->ret);
12769	}
12770
12771	ctl_dt_req_free(rq);
12772
12773	for (i = 0; i < io->scsiio.kern_sg_entries; i++)
12774		free(io->io_hdr.local_sglist[i].addr, M_CTL);
12775	free(io->io_hdr.remote_sglist, M_CTL);
12776	io->io_hdr.remote_sglist = NULL;
12777	io->io_hdr.local_sglist = NULL;
12778
12779	/*
12780	 * The data is in local and remote memory, so now we need to send
12781	 * status (good or back) back to the other side.
12782	 */
12783	ctl_send_datamove_done(io, /*have_lock*/ 0);
12784}
12785
12786/*
12787 * We've moved the data from the host/controller into local memory.  Now we
12788 * need to push it over to the remote controller's memory.
12789 */
12790static int
12791ctl_datamove_remote_dm_write_cb(union ctl_io *io)
12792{
12793	int retval;
12794
12795	retval = ctl_datamove_remote_xfer(io, CTL_HA_DT_CMD_WRITE,
12796					  ctl_datamove_remote_write_cb);
12797	return (retval);
12798}
12799
12800static void
12801ctl_datamove_remote_write(union ctl_io *io)
12802{
12803	int retval;
12804	void (*fe_datamove)(union ctl_io *io);
12805
12806	/*
12807	 * - Get the data from the host/HBA into local memory.
12808	 * - DMA memory from the local controller to the remote controller.
12809	 * - Send status back to the remote controller.
12810	 */
12811
12812	retval = ctl_datamove_remote_sgl_setup(io);
12813	if (retval != 0)
12814		return;
12815
12816	/* Switch the pointer over so the FETD knows what to do */
12817	io->scsiio.kern_data_ptr = (uint8_t *)io->io_hdr.local_sglist;
12818
12819	/*
12820	 * Use a custom move done callback, since we need to send completion
12821	 * back to the other controller, not to the backend on this side.
12822	 */
12823	io->scsiio.be_move_done = ctl_datamove_remote_dm_write_cb;
12824
12825	fe_datamove = ctl_io_port(&io->io_hdr)->fe_datamove;
12826	fe_datamove(io);
12827}
12828
12829static int
12830ctl_datamove_remote_dm_read_cb(union ctl_io *io)
12831{
12832#if 0
12833	char str[256];
12834	char path_str[64];
12835	struct sbuf sb;
12836#endif
12837	uint32_t i;
12838
12839	for (i = 0; i < io->scsiio.kern_sg_entries; i++)
12840		free(io->io_hdr.local_sglist[i].addr, M_CTL);
12841	free(io->io_hdr.remote_sglist, M_CTL);
12842	io->io_hdr.remote_sglist = NULL;
12843	io->io_hdr.local_sglist = NULL;
12844
12845#if 0
12846	scsi_path_string(io, path_str, sizeof(path_str));
12847	sbuf_new(&sb, str, sizeof(str), SBUF_FIXEDLEN);
12848	sbuf_cat(&sb, path_str);
12849	scsi_command_string(&io->scsiio, NULL, &sb);
12850	sbuf_printf(&sb, "\n");
12851	sbuf_cat(&sb, path_str);
12852	sbuf_printf(&sb, "Tag: 0x%04x, type %d\n",
12853		    io->scsiio.tag_num, io->scsiio.tag_type);
12854	sbuf_cat(&sb, path_str);
12855	sbuf_printf(&sb, "%s: flags %#x, status %#x\n", __func__,
12856		    io->io_hdr.flags, io->io_hdr.status);
12857	sbuf_finish(&sb);
12858	printk("%s", sbuf_data(&sb));
12859#endif
12860
12861
12862	/*
12863	 * The read is done, now we need to send status (good or bad) back
12864	 * to the other side.
12865	 */
12866	ctl_send_datamove_done(io, /*have_lock*/ 0);
12867
12868	return (0);
12869}
12870
12871static void
12872ctl_datamove_remote_read_cb(struct ctl_ha_dt_req *rq)
12873{
12874	union ctl_io *io;
12875	void (*fe_datamove)(union ctl_io *io);
12876
12877	io = rq->context;
12878
12879	if (rq->ret != CTL_HA_STATUS_SUCCESS) {
12880		printf("%s: ISC DMA read failed with error %d\n", __func__,
12881		       rq->ret);
12882		ctl_set_internal_failure(&io->scsiio,
12883					 /*sks_valid*/ 1,
12884					 /*retry_count*/ rq->ret);
12885	}
12886
12887	ctl_dt_req_free(rq);
12888
12889	/* Switch the pointer over so the FETD knows what to do */
12890	io->scsiio.kern_data_ptr = (uint8_t *)io->io_hdr.local_sglist;
12891
12892	/*
12893	 * Use a custom move done callback, since we need to send completion
12894	 * back to the other controller, not to the backend on this side.
12895	 */
12896	io->scsiio.be_move_done = ctl_datamove_remote_dm_read_cb;
12897
12898	/* XXX KDM add checks like the ones in ctl_datamove? */
12899
12900	fe_datamove = ctl_io_port(&io->io_hdr)->fe_datamove;
12901	fe_datamove(io);
12902}
12903
12904static int
12905ctl_datamove_remote_sgl_setup(union ctl_io *io)
12906{
12907	struct ctl_sg_entry *local_sglist;
12908	uint32_t len_to_go;
12909	int retval;
12910	int i;
12911
12912	retval = 0;
12913	local_sglist = io->io_hdr.local_sglist;
12914	len_to_go = io->scsiio.kern_data_len;
12915
12916	/*
12917	 * The difficult thing here is that the size of the various
12918	 * S/G segments may be different than the size from the
12919	 * remote controller.  That'll make it harder when DMAing
12920	 * the data back to the other side.
12921	 */
12922	for (i = 0; len_to_go > 0; i++) {
12923		local_sglist[i].len = MIN(len_to_go, CTL_HA_DATAMOVE_SEGMENT);
12924		local_sglist[i].addr =
12925		    malloc(local_sglist[i].len, M_CTL, M_WAITOK);
12926
12927		len_to_go -= local_sglist[i].len;
12928	}
12929	/*
12930	 * Reset the number of S/G entries accordingly.  The original
12931	 * number of S/G entries is available in rem_sg_entries.
12932	 */
12933	io->scsiio.kern_sg_entries = i;
12934
12935#if 0
12936	printf("%s: kern_sg_entries = %d\n", __func__,
12937	       io->scsiio.kern_sg_entries);
12938	for (i = 0; i < io->scsiio.kern_sg_entries; i++)
12939		printf("%s: sg[%d] = %p, %lu\n", __func__, i,
12940		       local_sglist[i].addr, local_sglist[i].len);
12941#endif
12942
12943	return (retval);
12944}
12945
12946static int
12947ctl_datamove_remote_xfer(union ctl_io *io, unsigned command,
12948			 ctl_ha_dt_cb callback)
12949{
12950	struct ctl_ha_dt_req *rq;
12951	struct ctl_sg_entry *remote_sglist, *local_sglist;
12952	uint32_t local_used, remote_used, total_used;
12953	int i, j, isc_ret;
12954
12955	rq = ctl_dt_req_alloc();
12956
12957	/*
12958	 * If we failed to allocate the request, and if the DMA didn't fail
12959	 * anyway, set busy status.  This is just a resource allocation
12960	 * failure.
12961	 */
12962	if ((rq == NULL)
12963	 && ((io->io_hdr.status & CTL_STATUS_MASK) != CTL_STATUS_NONE &&
12964	     (io->io_hdr.status & CTL_STATUS_MASK) != CTL_SUCCESS))
12965		ctl_set_busy(&io->scsiio);
12966
12967	if ((io->io_hdr.status & CTL_STATUS_MASK) != CTL_STATUS_NONE &&
12968	    (io->io_hdr.status & CTL_STATUS_MASK) != CTL_SUCCESS) {
12969
12970		if (rq != NULL)
12971			ctl_dt_req_free(rq);
12972
12973		/*
12974		 * The data move failed.  We need to return status back
12975		 * to the other controller.  No point in trying to DMA
12976		 * data to the remote controller.
12977		 */
12978
12979		ctl_send_datamove_done(io, /*have_lock*/ 0);
12980
12981		return (1);
12982	}
12983
12984	local_sglist = io->io_hdr.local_sglist;
12985	remote_sglist = io->io_hdr.remote_sglist;
12986	local_used = 0;
12987	remote_used = 0;
12988	total_used = 0;
12989
12990	/*
12991	 * Pull/push the data over the wire from/to the other controller.
12992	 * This takes into account the possibility that the local and
12993	 * remote sglists may not be identical in terms of the size of
12994	 * the elements and the number of elements.
12995	 *
12996	 * One fundamental assumption here is that the length allocated for
12997	 * both the local and remote sglists is identical.  Otherwise, we've
12998	 * essentially got a coding error of some sort.
12999	 */
13000	isc_ret = CTL_HA_STATUS_SUCCESS;
13001	for (i = 0, j = 0; total_used < io->scsiio.kern_data_len; ) {
13002		uint32_t cur_len;
13003		uint8_t *tmp_ptr;
13004
13005		rq->command = command;
13006		rq->context = io;
13007
13008		/*
13009		 * Both pointers should be aligned.  But it is possible
13010		 * that the allocation length is not.  They should both
13011		 * also have enough slack left over at the end, though,
13012		 * to round up to the next 8 byte boundary.
13013		 */
13014		cur_len = MIN(local_sglist[i].len - local_used,
13015			      remote_sglist[j].len - remote_used);
13016		rq->size = cur_len;
13017
13018		tmp_ptr = (uint8_t *)local_sglist[i].addr;
13019		tmp_ptr += local_used;
13020
13021#if 0
13022		/* Use physical addresses when talking to ISC hardware */
13023		if ((io->io_hdr.flags & CTL_FLAG_BUS_ADDR) == 0) {
13024			/* XXX KDM use busdma */
13025			rq->local = vtophys(tmp_ptr);
13026		} else
13027			rq->local = tmp_ptr;
13028#else
13029		KASSERT((io->io_hdr.flags & CTL_FLAG_BUS_ADDR) == 0,
13030		    ("HA does not support BUS_ADDR"));
13031		rq->local = tmp_ptr;
13032#endif
13033
13034		tmp_ptr = (uint8_t *)remote_sglist[j].addr;
13035		tmp_ptr += remote_used;
13036		rq->remote = tmp_ptr;
13037
13038		rq->callback = NULL;
13039
13040		local_used += cur_len;
13041		if (local_used >= local_sglist[i].len) {
13042			i++;
13043			local_used = 0;
13044		}
13045
13046		remote_used += cur_len;
13047		if (remote_used >= remote_sglist[j].len) {
13048			j++;
13049			remote_used = 0;
13050		}
13051		total_used += cur_len;
13052
13053		if (total_used >= io->scsiio.kern_data_len)
13054			rq->callback = callback;
13055
13056#if 0
13057		printf("%s: %s: local %p remote %p size %d\n", __func__,
13058		       (command == CTL_HA_DT_CMD_WRITE) ? "WRITE" : "READ",
13059		       rq->local, rq->remote, rq->size);
13060#endif
13061
13062		isc_ret = ctl_dt_single(rq);
13063		if (isc_ret > CTL_HA_STATUS_SUCCESS)
13064			break;
13065	}
13066	if (isc_ret != CTL_HA_STATUS_WAIT) {
13067		rq->ret = isc_ret;
13068		callback(rq);
13069	}
13070
13071	return (0);
13072}
13073
13074static void
13075ctl_datamove_remote_read(union ctl_io *io)
13076{
13077	int retval;
13078	uint32_t i;
13079
13080	/*
13081	 * This will send an error to the other controller in the case of a
13082	 * failure.
13083	 */
13084	retval = ctl_datamove_remote_sgl_setup(io);
13085	if (retval != 0)
13086		return;
13087
13088	retval = ctl_datamove_remote_xfer(io, CTL_HA_DT_CMD_READ,
13089					  ctl_datamove_remote_read_cb);
13090	if (retval != 0) {
13091		/*
13092		 * Make sure we free memory if there was an error..  The
13093		 * ctl_datamove_remote_xfer() function will send the
13094		 * datamove done message, or call the callback with an
13095		 * error if there is a problem.
13096		 */
13097		for (i = 0; i < io->scsiio.kern_sg_entries; i++)
13098			free(io->io_hdr.local_sglist[i].addr, M_CTL);
13099		free(io->io_hdr.remote_sglist, M_CTL);
13100		io->io_hdr.remote_sglist = NULL;
13101		io->io_hdr.local_sglist = NULL;
13102	}
13103}
13104
13105/*
13106 * Process a datamove request from the other controller.  This is used for
13107 * XFER mode only, not SER_ONLY mode.  For writes, we DMA into local memory
13108 * first.  Once that is complete, the data gets DMAed into the remote
13109 * controller's memory.  For reads, we DMA from the remote controller's
13110 * memory into our memory first, and then move it out to the FETD.
13111 */
13112static void
13113ctl_datamove_remote(union ctl_io *io)
13114{
13115
13116	mtx_assert(&control_softc->ctl_lock, MA_NOTOWNED);
13117
13118	if (io->io_hdr.flags & CTL_FLAG_FAILOVER) {
13119		ctl_failover_io(io, /*have_lock*/ 0);
13120		return;
13121	}
13122
13123	/*
13124	 * Note that we look for an aborted I/O here, but don't do some of
13125	 * the other checks that ctl_datamove() normally does.
13126	 * We don't need to run the datamove delay code, since that should
13127	 * have been done if need be on the other controller.
13128	 */
13129	if (io->io_hdr.flags & CTL_FLAG_ABORT) {
13130		printf("%s: tag 0x%04x on (%u:%u:%u) aborted\n", __func__,
13131		       io->scsiio.tag_num, io->io_hdr.nexus.initid,
13132		       io->io_hdr.nexus.targ_port,
13133		       io->io_hdr.nexus.targ_lun);
13134		io->io_hdr.port_status = 31338;
13135		ctl_send_datamove_done(io, /*have_lock*/ 0);
13136		return;
13137	}
13138
13139	if ((io->io_hdr.flags & CTL_FLAG_DATA_MASK) == CTL_FLAG_DATA_OUT)
13140		ctl_datamove_remote_write(io);
13141	else if ((io->io_hdr.flags & CTL_FLAG_DATA_MASK) == CTL_FLAG_DATA_IN)
13142		ctl_datamove_remote_read(io);
13143	else {
13144		io->io_hdr.port_status = 31339;
13145		ctl_send_datamove_done(io, /*have_lock*/ 0);
13146	}
13147}
13148
13149static void
13150ctl_process_done(union ctl_io *io)
13151{
13152	struct ctl_lun *lun;
13153	struct ctl_softc *softc = control_softc;
13154	void (*fe_done)(union ctl_io *io);
13155	union ctl_ha_msg msg;
13156	uint32_t targ_port = io->io_hdr.nexus.targ_port;
13157
13158	CTL_DEBUG_PRINT(("ctl_process_done\n"));
13159	fe_done = softc->ctl_ports[targ_port]->fe_done;
13160
13161#ifdef CTL_TIME_IO
13162	if ((time_uptime - io->io_hdr.start_time) > ctl_time_io_secs) {
13163		char str[256];
13164		char path_str[64];
13165		struct sbuf sb;
13166
13167		ctl_scsi_path_string(io, path_str, sizeof(path_str));
13168		sbuf_new(&sb, str, sizeof(str), SBUF_FIXEDLEN);
13169
13170		sbuf_cat(&sb, path_str);
13171		switch (io->io_hdr.io_type) {
13172		case CTL_IO_SCSI:
13173			ctl_scsi_command_string(&io->scsiio, NULL, &sb);
13174			sbuf_printf(&sb, "\n");
13175			sbuf_cat(&sb, path_str);
13176			sbuf_printf(&sb, "Tag: 0x%04x, type %d\n",
13177				    io->scsiio.tag_num, io->scsiio.tag_type);
13178			break;
13179		case CTL_IO_TASK:
13180			sbuf_printf(&sb, "Task I/O type: %d, Tag: 0x%04x, "
13181				    "Tag Type: %d\n", io->taskio.task_action,
13182				    io->taskio.tag_num, io->taskio.tag_type);
13183			break;
13184		default:
13185			panic("%s: Invalid CTL I/O type %d\n",
13186			    __func__, io->io_hdr.io_type);
13187		}
13188		sbuf_cat(&sb, path_str);
13189		sbuf_printf(&sb, "ctl_process_done: %jd seconds\n",
13190			    (intmax_t)time_uptime - io->io_hdr.start_time);
13191		sbuf_finish(&sb);
13192		printf("%s", sbuf_data(&sb));
13193	}
13194#endif /* CTL_TIME_IO */
13195
13196	switch (io->io_hdr.io_type) {
13197	case CTL_IO_SCSI:
13198		break;
13199	case CTL_IO_TASK:
13200		if (ctl_debug & CTL_DEBUG_INFO)
13201			ctl_io_error_print(io, NULL);
13202		fe_done(io);
13203		return;
13204	default:
13205		panic("%s: Invalid CTL I/O type %d\n",
13206		    __func__, io->io_hdr.io_type);
13207	}
13208
13209	lun = (struct ctl_lun *)io->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
13210	if (lun == NULL) {
13211		CTL_DEBUG_PRINT(("NULL LUN for lun %d\n",
13212				 io->io_hdr.nexus.targ_mapped_lun));
13213		goto bailout;
13214	}
13215
13216	mtx_lock(&lun->lun_lock);
13217
13218	/*
13219	 * Check to see if we have any informational exception and status
13220	 * of this command can be modified to report it in form of either
13221	 * RECOVERED ERROR or NO SENSE, depending on MRIE mode page field.
13222	 */
13223	if (lun->ie_reported == 0 && lun->ie_asc != 0 &&
13224	    io->io_hdr.status == CTL_SUCCESS &&
13225	    (io->io_hdr.flags & CTL_FLAG_STATUS_SENT) == 0) {
13226		uint8_t mrie = lun->mode_pages.ie_page[CTL_PAGE_CURRENT].mrie;
13227		uint8_t per =
13228		    ((lun->mode_pages.rw_er_page[CTL_PAGE_CURRENT].byte3 &
13229		      SMS_RWER_PER) ||
13230		     (lun->mode_pages.verify_er_page[CTL_PAGE_CURRENT].byte3 &
13231		      SMS_VER_PER));
13232		if (((mrie == SIEP_MRIE_REC_COND && per) ||
13233		     mrie == SIEP_MRIE_REC_UNCOND ||
13234		     mrie == SIEP_MRIE_NO_SENSE) &&
13235		    (ctl_get_cmd_entry(&io->scsiio, NULL)->flags &
13236		     CTL_CMD_FLAG_NO_SENSE) == 0) {
13237			ctl_set_sense(&io->scsiio,
13238			      /*current_error*/ 1,
13239			      /*sense_key*/ (mrie == SIEP_MRIE_NO_SENSE) ?
13240			        SSD_KEY_NO_SENSE : SSD_KEY_RECOVERED_ERROR,
13241			      /*asc*/ lun->ie_asc,
13242			      /*ascq*/ lun->ie_ascq,
13243			      SSD_ELEM_NONE);
13244			lun->ie_reported = 1;
13245		}
13246	} else if (lun->ie_reported < 0)
13247		lun->ie_reported = 0;
13248
13249	/*
13250	 * Check to see if we have any errors to inject here.  We only
13251	 * inject errors for commands that don't already have errors set.
13252	 */
13253	if (!STAILQ_EMPTY(&lun->error_list) &&
13254	    ((io->io_hdr.status & CTL_STATUS_MASK) == CTL_SUCCESS) &&
13255	    ((io->io_hdr.flags & CTL_FLAG_STATUS_SENT) == 0))
13256		ctl_inject_error(lun, io);
13257
13258	/*
13259	 * XXX KDM how do we treat commands that aren't completed
13260	 * successfully?
13261	 *
13262	 * XXX KDM should we also track I/O latency?
13263	 */
13264	if ((io->io_hdr.status & CTL_STATUS_MASK) == CTL_SUCCESS &&
13265	    io->io_hdr.io_type == CTL_IO_SCSI) {
13266#ifdef CTL_TIME_IO
13267		struct bintime cur_bt;
13268#endif
13269		int type;
13270
13271		if ((io->io_hdr.flags & CTL_FLAG_DATA_MASK) ==
13272		    CTL_FLAG_DATA_IN)
13273			type = CTL_STATS_READ;
13274		else if ((io->io_hdr.flags & CTL_FLAG_DATA_MASK) ==
13275		    CTL_FLAG_DATA_OUT)
13276			type = CTL_STATS_WRITE;
13277		else
13278			type = CTL_STATS_NO_IO;
13279
13280		lun->stats.ports[targ_port].bytes[type] +=
13281		    io->scsiio.kern_total_len;
13282		lun->stats.ports[targ_port].operations[type]++;
13283#ifdef CTL_TIME_IO
13284		bintime_add(&lun->stats.ports[targ_port].dma_time[type],
13285		   &io->io_hdr.dma_bt);
13286		getbinuptime(&cur_bt);
13287		bintime_sub(&cur_bt, &io->io_hdr.start_bt);
13288		bintime_add(&lun->stats.ports[targ_port].time[type], &cur_bt);
13289#endif
13290		lun->stats.ports[targ_port].num_dmas[type] +=
13291		    io->io_hdr.num_dmas;
13292	}
13293
13294	/*
13295	 * Remove this from the OOA queue.
13296	 */
13297	TAILQ_REMOVE(&lun->ooa_queue, &io->io_hdr, ooa_links);
13298#ifdef CTL_TIME_IO
13299	if (TAILQ_EMPTY(&lun->ooa_queue))
13300		lun->last_busy = getsbinuptime();
13301#endif
13302
13303	/*
13304	 * Run through the blocked queue on this LUN and see if anything
13305	 * has become unblocked, now that this transaction is done.
13306	 */
13307	ctl_check_blocked(lun);
13308
13309	/*
13310	 * If the LUN has been invalidated, free it if there is nothing
13311	 * left on its OOA queue.
13312	 */
13313	if ((lun->flags & CTL_LUN_INVALID)
13314	 && TAILQ_EMPTY(&lun->ooa_queue)) {
13315		mtx_unlock(&lun->lun_lock);
13316		mtx_lock(&softc->ctl_lock);
13317		ctl_free_lun(lun);
13318		mtx_unlock(&softc->ctl_lock);
13319	} else
13320		mtx_unlock(&lun->lun_lock);
13321
13322bailout:
13323
13324	/*
13325	 * If this command has been aborted, make sure we set the status
13326	 * properly.  The FETD is responsible for freeing the I/O and doing
13327	 * whatever it needs to do to clean up its state.
13328	 */
13329	if (io->io_hdr.flags & CTL_FLAG_ABORT)
13330		ctl_set_task_aborted(&io->scsiio);
13331
13332	/*
13333	 * If enabled, print command error status.
13334	 */
13335	if ((io->io_hdr.status & CTL_STATUS_MASK) != CTL_SUCCESS &&
13336	    (ctl_debug & CTL_DEBUG_INFO) != 0)
13337		ctl_io_error_print(io, NULL);
13338
13339	/*
13340	 * Tell the FETD or the other shelf controller we're done with this
13341	 * command.  Note that only SCSI commands get to this point.  Task
13342	 * management commands are completed above.
13343	 */
13344	if ((softc->ha_mode != CTL_HA_MODE_XFER) &&
13345	    (io->io_hdr.flags & CTL_FLAG_SENT_2OTHER_SC)) {
13346		memset(&msg, 0, sizeof(msg));
13347		msg.hdr.msg_type = CTL_MSG_FINISH_IO;
13348		msg.hdr.serializing_sc = io->io_hdr.serializing_sc;
13349		msg.hdr.nexus = io->io_hdr.nexus;
13350		ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg,
13351		    sizeof(msg.scsi) - sizeof(msg.scsi.sense_data),
13352		    M_WAITOK);
13353	}
13354
13355	fe_done(io);
13356}
13357
13358#ifdef CTL_WITH_CA
13359/*
13360 * Front end should call this if it doesn't do autosense.  When the request
13361 * sense comes back in from the initiator, we'll dequeue this and send it.
13362 */
13363int
13364ctl_queue_sense(union ctl_io *io)
13365{
13366	struct ctl_lun *lun;
13367	struct ctl_port *port;
13368	struct ctl_softc *softc;
13369	uint32_t initidx, targ_lun;
13370
13371	softc = control_softc;
13372
13373	CTL_DEBUG_PRINT(("ctl_queue_sense\n"));
13374
13375	/*
13376	 * LUN lookup will likely move to the ctl_work_thread() once we
13377	 * have our new queueing infrastructure (that doesn't put things on
13378	 * a per-LUN queue initially).  That is so that we can handle
13379	 * things like an INQUIRY to a LUN that we don't have enabled.  We
13380	 * can't deal with that right now.
13381	 */
13382	mtx_lock(&softc->ctl_lock);
13383
13384	/*
13385	 * If we don't have a LUN for this, just toss the sense
13386	 * information.
13387	 */
13388	port = ctl_io_port(&ctsio->io_hdr);
13389	targ_lun = ctl_lun_map_from_port(port, io->io_hdr.nexus.targ_lun);
13390	if ((targ_lun < CTL_MAX_LUNS)
13391	 && (softc->ctl_luns[targ_lun] != NULL))
13392		lun = softc->ctl_luns[targ_lun];
13393	else
13394		goto bailout;
13395
13396	initidx = ctl_get_initindex(&io->io_hdr.nexus);
13397
13398	mtx_lock(&lun->lun_lock);
13399	/*
13400	 * Already have CA set for this LUN...toss the sense information.
13401	 */
13402	if (ctl_is_set(lun->have_ca, initidx)) {
13403		mtx_unlock(&lun->lun_lock);
13404		goto bailout;
13405	}
13406
13407	memcpy(&lun->pending_sense[initidx], &io->scsiio.sense_data,
13408	       MIN(sizeof(lun->pending_sense[initidx]),
13409	       sizeof(io->scsiio.sense_data)));
13410	ctl_set_mask(lun->have_ca, initidx);
13411	mtx_unlock(&lun->lun_lock);
13412
13413bailout:
13414	mtx_unlock(&softc->ctl_lock);
13415
13416	ctl_free_io(io);
13417
13418	return (CTL_RETVAL_COMPLETE);
13419}
13420#endif
13421
13422/*
13423 * Primary command inlet from frontend ports.  All SCSI and task I/O
13424 * requests must go through this function.
13425 */
13426int
13427ctl_queue(union ctl_io *io)
13428{
13429	struct ctl_port *port;
13430
13431	CTL_DEBUG_PRINT(("ctl_queue cdb[0]=%02X\n", io->scsiio.cdb[0]));
13432
13433#ifdef CTL_TIME_IO
13434	io->io_hdr.start_time = time_uptime;
13435	getbinuptime(&io->io_hdr.start_bt);
13436#endif /* CTL_TIME_IO */
13437
13438	/* Map FE-specific LUN ID into global one. */
13439	port = ctl_io_port(&io->io_hdr);
13440	io->io_hdr.nexus.targ_mapped_lun =
13441	    ctl_lun_map_from_port(port, io->io_hdr.nexus.targ_lun);
13442
13443	switch (io->io_hdr.io_type) {
13444	case CTL_IO_SCSI:
13445	case CTL_IO_TASK:
13446		if (ctl_debug & CTL_DEBUG_CDB)
13447			ctl_io_print(io);
13448		ctl_enqueue_incoming(io);
13449		break;
13450	default:
13451		printf("ctl_queue: unknown I/O type %d\n", io->io_hdr.io_type);
13452		return (EINVAL);
13453	}
13454
13455	return (CTL_RETVAL_COMPLETE);
13456}
13457
13458#ifdef CTL_IO_DELAY
13459static void
13460ctl_done_timer_wakeup(void *arg)
13461{
13462	union ctl_io *io;
13463
13464	io = (union ctl_io *)arg;
13465	ctl_done(io);
13466}
13467#endif /* CTL_IO_DELAY */
13468
13469void
13470ctl_serseq_done(union ctl_io *io)
13471{
13472	struct ctl_lun *lun;
13473
13474	lun = (struct ctl_lun *)io->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
13475	if (lun->be_lun == NULL ||
13476	    lun->be_lun->serseq == CTL_LUN_SERSEQ_OFF)
13477		return;
13478	mtx_lock(&lun->lun_lock);
13479	io->io_hdr.flags |= CTL_FLAG_SERSEQ_DONE;
13480	ctl_check_blocked(lun);
13481	mtx_unlock(&lun->lun_lock);
13482}
13483
13484void
13485ctl_done(union ctl_io *io)
13486{
13487
13488	/*
13489	 * Enable this to catch duplicate completion issues.
13490	 */
13491#if 0
13492	if (io->io_hdr.flags & CTL_FLAG_ALREADY_DONE) {
13493		printf("%s: type %d msg %d cdb %x iptl: "
13494		       "%u:%u:%u tag 0x%04x "
13495		       "flag %#x status %x\n",
13496			__func__,
13497			io->io_hdr.io_type,
13498			io->io_hdr.msg_type,
13499			io->scsiio.cdb[0],
13500			io->io_hdr.nexus.initid,
13501			io->io_hdr.nexus.targ_port,
13502			io->io_hdr.nexus.targ_lun,
13503			(io->io_hdr.io_type ==
13504			CTL_IO_TASK) ?
13505			io->taskio.tag_num :
13506			io->scsiio.tag_num,
13507		        io->io_hdr.flags,
13508			io->io_hdr.status);
13509	} else
13510		io->io_hdr.flags |= CTL_FLAG_ALREADY_DONE;
13511#endif
13512
13513	/*
13514	 * This is an internal copy of an I/O, and should not go through
13515	 * the normal done processing logic.
13516	 */
13517	if (io->io_hdr.flags & CTL_FLAG_INT_COPY)
13518		return;
13519
13520#ifdef CTL_IO_DELAY
13521	if (io->io_hdr.flags & CTL_FLAG_DELAY_DONE) {
13522		io->io_hdr.flags &= ~CTL_FLAG_DELAY_DONE;
13523	} else {
13524		struct ctl_lun *lun;
13525
13526		lun =(struct ctl_lun *)io->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
13527
13528		if ((lun != NULL)
13529		 && (lun->delay_info.done_delay > 0)) {
13530
13531			callout_init(&io->io_hdr.delay_callout, /*mpsafe*/ 1);
13532			io->io_hdr.flags |= CTL_FLAG_DELAY_DONE;
13533			callout_reset(&io->io_hdr.delay_callout,
13534				      lun->delay_info.done_delay * hz,
13535				      ctl_done_timer_wakeup, io);
13536			if (lun->delay_info.done_type == CTL_DELAY_TYPE_ONESHOT)
13537				lun->delay_info.done_delay = 0;
13538			return;
13539		}
13540	}
13541#endif /* CTL_IO_DELAY */
13542
13543	ctl_enqueue_done(io);
13544}
13545
13546static void
13547ctl_work_thread(void *arg)
13548{
13549	struct ctl_thread *thr = (struct ctl_thread *)arg;
13550	struct ctl_softc *softc = thr->ctl_softc;
13551	union ctl_io *io;
13552	int retval;
13553
13554	CTL_DEBUG_PRINT(("ctl_work_thread starting\n"));
13555
13556	for (;;) {
13557		/*
13558		 * We handle the queues in this order:
13559		 * - ISC
13560		 * - done queue (to free up resources, unblock other commands)
13561		 * - RtR queue
13562		 * - incoming queue
13563		 *
13564		 * If those queues are empty, we break out of the loop and
13565		 * go to sleep.
13566		 */
13567		mtx_lock(&thr->queue_lock);
13568		io = (union ctl_io *)STAILQ_FIRST(&thr->isc_queue);
13569		if (io != NULL) {
13570			STAILQ_REMOVE_HEAD(&thr->isc_queue, links);
13571			mtx_unlock(&thr->queue_lock);
13572			ctl_handle_isc(io);
13573			continue;
13574		}
13575		io = (union ctl_io *)STAILQ_FIRST(&thr->done_queue);
13576		if (io != NULL) {
13577			STAILQ_REMOVE_HEAD(&thr->done_queue, links);
13578			/* clear any blocked commands, call fe_done */
13579			mtx_unlock(&thr->queue_lock);
13580			ctl_process_done(io);
13581			continue;
13582		}
13583		io = (union ctl_io *)STAILQ_FIRST(&thr->incoming_queue);
13584		if (io != NULL) {
13585			STAILQ_REMOVE_HEAD(&thr->incoming_queue, links);
13586			mtx_unlock(&thr->queue_lock);
13587			if (io->io_hdr.io_type == CTL_IO_TASK)
13588				ctl_run_task(io);
13589			else
13590				ctl_scsiio_precheck(softc, &io->scsiio);
13591			continue;
13592		}
13593		io = (union ctl_io *)STAILQ_FIRST(&thr->rtr_queue);
13594		if (io != NULL) {
13595			STAILQ_REMOVE_HEAD(&thr->rtr_queue, links);
13596			mtx_unlock(&thr->queue_lock);
13597			retval = ctl_scsiio(&io->scsiio);
13598			if (retval != CTL_RETVAL_COMPLETE)
13599				CTL_DEBUG_PRINT(("ctl_scsiio failed\n"));
13600			continue;
13601		}
13602
13603		/* Sleep until we have something to do. */
13604		mtx_sleep(thr, &thr->queue_lock, PDROP | PRIBIO, "-", 0);
13605	}
13606}
13607
13608static void
13609ctl_lun_thread(void *arg)
13610{
13611	struct ctl_softc *softc = (struct ctl_softc *)arg;
13612	struct ctl_be_lun *be_lun;
13613
13614	CTL_DEBUG_PRINT(("ctl_lun_thread starting\n"));
13615
13616	for (;;) {
13617		mtx_lock(&softc->ctl_lock);
13618		be_lun = STAILQ_FIRST(&softc->pending_lun_queue);
13619		if (be_lun != NULL) {
13620			STAILQ_REMOVE_HEAD(&softc->pending_lun_queue, links);
13621			mtx_unlock(&softc->ctl_lock);
13622			ctl_create_lun(be_lun);
13623			continue;
13624		}
13625
13626		/* Sleep until we have something to do. */
13627		mtx_sleep(&softc->pending_lun_queue, &softc->ctl_lock,
13628		    PDROP | PRIBIO, "-", 0);
13629	}
13630}
13631
13632static void
13633ctl_thresh_thread(void *arg)
13634{
13635	struct ctl_softc *softc = (struct ctl_softc *)arg;
13636	struct ctl_lun *lun;
13637	struct scsi_da_rw_recovery_page *rwpage;
13638	struct ctl_logical_block_provisioning_page *page;
13639	const char *attr;
13640	union ctl_ha_msg msg;
13641	uint64_t thres, val;
13642	int i, e, set;
13643
13644	CTL_DEBUG_PRINT(("ctl_thresh_thread starting\n"));
13645
13646	for (;;) {
13647		mtx_lock(&softc->ctl_lock);
13648		STAILQ_FOREACH(lun, &softc->lun_list, links) {
13649			if ((lun->flags & CTL_LUN_DISABLED) ||
13650			    (lun->flags & CTL_LUN_NO_MEDIA) ||
13651			    lun->backend->lun_attr == NULL)
13652				continue;
13653			if ((lun->flags & CTL_LUN_PRIMARY_SC) == 0 &&
13654			    softc->ha_mode == CTL_HA_MODE_XFER)
13655				continue;
13656			rwpage = &lun->mode_pages.rw_er_page[CTL_PAGE_CURRENT];
13657			if ((rwpage->byte8 & SMS_RWER_LBPERE) == 0)
13658				continue;
13659			e = 0;
13660			page = &lun->mode_pages.lbp_page[CTL_PAGE_CURRENT];
13661			for (i = 0; i < CTL_NUM_LBP_THRESH; i++) {
13662				if ((page->descr[i].flags & SLBPPD_ENABLED) == 0)
13663					continue;
13664				thres = scsi_4btoul(page->descr[i].count);
13665				thres <<= CTL_LBP_EXPONENT;
13666				switch (page->descr[i].resource) {
13667				case 0x01:
13668					attr = "blocksavail";
13669					break;
13670				case 0x02:
13671					attr = "blocksused";
13672					break;
13673				case 0xf1:
13674					attr = "poolblocksavail";
13675					break;
13676				case 0xf2:
13677					attr = "poolblocksused";
13678					break;
13679				default:
13680					continue;
13681				}
13682				mtx_unlock(&softc->ctl_lock); // XXX
13683				val = lun->backend->lun_attr(
13684				    lun->be_lun->be_lun, attr);
13685				mtx_lock(&softc->ctl_lock);
13686				if (val == UINT64_MAX)
13687					continue;
13688				if ((page->descr[i].flags & SLBPPD_ARMING_MASK)
13689				    == SLBPPD_ARMING_INC)
13690					e = (val >= thres);
13691				else
13692					e = (val <= thres);
13693				if (e)
13694					break;
13695			}
13696			mtx_lock(&lun->lun_lock);
13697			if (e) {
13698				scsi_u64to8b((uint8_t *)&page->descr[i] -
13699				    (uint8_t *)page, lun->ua_tpt_info);
13700				if (lun->lasttpt == 0 ||
13701				    time_uptime - lun->lasttpt >= CTL_LBP_UA_PERIOD) {
13702					lun->lasttpt = time_uptime;
13703					ctl_est_ua_all(lun, -1, CTL_UA_THIN_PROV_THRES);
13704					set = 1;
13705				} else
13706					set = 0;
13707			} else {
13708				lun->lasttpt = 0;
13709				ctl_clr_ua_all(lun, -1, CTL_UA_THIN_PROV_THRES);
13710				set = -1;
13711			}
13712			mtx_unlock(&lun->lun_lock);
13713			if (set != 0 &&
13714			    lun->ctl_softc->ha_mode == CTL_HA_MODE_XFER) {
13715				/* Send msg to other side. */
13716				bzero(&msg.ua, sizeof(msg.ua));
13717				msg.hdr.msg_type = CTL_MSG_UA;
13718				msg.hdr.nexus.initid = -1;
13719				msg.hdr.nexus.targ_port = -1;
13720				msg.hdr.nexus.targ_lun = lun->lun;
13721				msg.hdr.nexus.targ_mapped_lun = lun->lun;
13722				msg.ua.ua_all = 1;
13723				msg.ua.ua_set = (set > 0);
13724				msg.ua.ua_type = CTL_UA_THIN_PROV_THRES;
13725				memcpy(msg.ua.ua_info, lun->ua_tpt_info, 8);
13726				mtx_unlock(&softc->ctl_lock); // XXX
13727				ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg,
13728				    sizeof(msg.ua), M_WAITOK);
13729				mtx_lock(&softc->ctl_lock);
13730			}
13731		}
13732		mtx_unlock(&softc->ctl_lock);
13733		pause("-", CTL_LBP_PERIOD * hz);
13734	}
13735}
13736
13737static void
13738ctl_enqueue_incoming(union ctl_io *io)
13739{
13740	struct ctl_softc *softc = control_softc;
13741	struct ctl_thread *thr;
13742	u_int idx;
13743
13744	idx = (io->io_hdr.nexus.targ_port * 127 +
13745	       io->io_hdr.nexus.initid) % worker_threads;
13746	thr = &softc->threads[idx];
13747	mtx_lock(&thr->queue_lock);
13748	STAILQ_INSERT_TAIL(&thr->incoming_queue, &io->io_hdr, links);
13749	mtx_unlock(&thr->queue_lock);
13750	wakeup(thr);
13751}
13752
13753static void
13754ctl_enqueue_rtr(union ctl_io *io)
13755{
13756	struct ctl_softc *softc = control_softc;
13757	struct ctl_thread *thr;
13758
13759	thr = &softc->threads[io->io_hdr.nexus.targ_mapped_lun % worker_threads];
13760	mtx_lock(&thr->queue_lock);
13761	STAILQ_INSERT_TAIL(&thr->rtr_queue, &io->io_hdr, links);
13762	mtx_unlock(&thr->queue_lock);
13763	wakeup(thr);
13764}
13765
13766static void
13767ctl_enqueue_done(union ctl_io *io)
13768{
13769	struct ctl_softc *softc = control_softc;
13770	struct ctl_thread *thr;
13771
13772	thr = &softc->threads[io->io_hdr.nexus.targ_mapped_lun % worker_threads];
13773	mtx_lock(&thr->queue_lock);
13774	STAILQ_INSERT_TAIL(&thr->done_queue, &io->io_hdr, links);
13775	mtx_unlock(&thr->queue_lock);
13776	wakeup(thr);
13777}
13778
13779static void
13780ctl_enqueue_isc(union ctl_io *io)
13781{
13782	struct ctl_softc *softc = control_softc;
13783	struct ctl_thread *thr;
13784
13785	thr = &softc->threads[io->io_hdr.nexus.targ_mapped_lun % worker_threads];
13786	mtx_lock(&thr->queue_lock);
13787	STAILQ_INSERT_TAIL(&thr->isc_queue, &io->io_hdr, links);
13788	mtx_unlock(&thr->queue_lock);
13789	wakeup(thr);
13790}
13791
13792/*
13793 *  vim: ts=8
13794 */
13795