ctl.c revision 291388
1/*-
2 * Copyright (c) 2003-2009 Silicon Graphics International Corp.
3 * Copyright (c) 2012 The FreeBSD Foundation
4 * Copyright (c) 2015 Alexander Motin <mav@FreeBSD.org>
5 * All rights reserved.
6 *
7 * Portions of this software were developed by Edward Tomasz Napierala
8 * under sponsorship from the FreeBSD Foundation.
9 *
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
12 * are met:
13 * 1. Redistributions of source code must retain the above copyright
14 *    notice, this list of conditions, and the following disclaimer,
15 *    without modification.
16 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
17 *    substantially similar to the "NO WARRANTY" disclaimer below
18 *    ("Disclaimer") and any redistribution must be conditioned upon
19 *    including a substantially similar Disclaimer requirement for further
20 *    binary redistribution.
21 *
22 * NO WARRANTY
23 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
24 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
25 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
26 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
27 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
31 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
32 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
33 * POSSIBILITY OF SUCH DAMAGES.
34 *
35 * $Id$
36 */
37/*
38 * CAM Target Layer, a SCSI device emulation subsystem.
39 *
40 * Author: Ken Merry <ken@FreeBSD.org>
41 */
42
43#define _CTL_C
44
45#include <sys/cdefs.h>
46__FBSDID("$FreeBSD: stable/10/sys/cam/ctl/ctl.c 291388 2015-11-27 15:26:19Z 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 copan_debugconf_subpage debugconf_page_default = {
97	DBGCNF_PAGE_CODE | SMPH_SPF,	/* page_code */
98	DBGCNF_SUBPAGE_CODE,		/* subpage */
99	{(sizeof(struct copan_debugconf_subpage) - 4) >> 8,
100	 (sizeof(struct copan_debugconf_subpage) - 4) >> 0}, /* page_length */
101	DBGCNF_VERSION,			/* page_version */
102	{CTL_TIME_IO_DEFAULT_SECS>>8,
103	 CTL_TIME_IO_DEFAULT_SECS>>0},	/* ctl_time_io_secs */
104};
105
106const static struct copan_debugconf_subpage debugconf_page_changeable = {
107	DBGCNF_PAGE_CODE | SMPH_SPF,	/* page_code */
108	DBGCNF_SUBPAGE_CODE,		/* subpage */
109	{(sizeof(struct copan_debugconf_subpage) - 4) >> 8,
110	 (sizeof(struct copan_debugconf_subpage) - 4) >> 0}, /* page_length */
111	0,				/* page_version */
112	{0xff,0xff},			/* ctl_time_io_secs */
113};
114
115const static struct scsi_da_rw_recovery_page rw_er_page_default = {
116	/*page_code*/SMS_RW_ERROR_RECOVERY_PAGE,
117	/*page_length*/sizeof(struct scsi_da_rw_recovery_page) - 2,
118	/*byte3*/SMS_RWER_AWRE|SMS_RWER_ARRE,
119	/*read_retry_count*/0,
120	/*correction_span*/0,
121	/*head_offset_count*/0,
122	/*data_strobe_offset_cnt*/0,
123	/*byte8*/SMS_RWER_LBPERE,
124	/*write_retry_count*/0,
125	/*reserved2*/0,
126	/*recovery_time_limit*/{0, 0},
127};
128
129const static struct scsi_da_rw_recovery_page rw_er_page_changeable = {
130	/*page_code*/SMS_RW_ERROR_RECOVERY_PAGE,
131	/*page_length*/sizeof(struct scsi_da_rw_recovery_page) - 2,
132	/*byte3*/0,
133	/*read_retry_count*/0,
134	/*correction_span*/0,
135	/*head_offset_count*/0,
136	/*data_strobe_offset_cnt*/0,
137	/*byte8*/0,
138	/*write_retry_count*/0,
139	/*reserved2*/0,
140	/*recovery_time_limit*/{0, 0},
141};
142
143const static struct scsi_format_page format_page_default = {
144	/*page_code*/SMS_FORMAT_DEVICE_PAGE,
145	/*page_length*/sizeof(struct scsi_format_page) - 2,
146	/*tracks_per_zone*/ {0, 0},
147	/*alt_sectors_per_zone*/ {0, 0},
148	/*alt_tracks_per_zone*/ {0, 0},
149	/*alt_tracks_per_lun*/ {0, 0},
150	/*sectors_per_track*/ {(CTL_DEFAULT_SECTORS_PER_TRACK >> 8) & 0xff,
151			        CTL_DEFAULT_SECTORS_PER_TRACK & 0xff},
152	/*bytes_per_sector*/ {0, 0},
153	/*interleave*/ {0, 0},
154	/*track_skew*/ {0, 0},
155	/*cylinder_skew*/ {0, 0},
156	/*flags*/ SFP_HSEC,
157	/*reserved*/ {0, 0, 0}
158};
159
160const static struct scsi_format_page format_page_changeable = {
161	/*page_code*/SMS_FORMAT_DEVICE_PAGE,
162	/*page_length*/sizeof(struct scsi_format_page) - 2,
163	/*tracks_per_zone*/ {0, 0},
164	/*alt_sectors_per_zone*/ {0, 0},
165	/*alt_tracks_per_zone*/ {0, 0},
166	/*alt_tracks_per_lun*/ {0, 0},
167	/*sectors_per_track*/ {0, 0},
168	/*bytes_per_sector*/ {0, 0},
169	/*interleave*/ {0, 0},
170	/*track_skew*/ {0, 0},
171	/*cylinder_skew*/ {0, 0},
172	/*flags*/ 0,
173	/*reserved*/ {0, 0, 0}
174};
175
176const static struct scsi_rigid_disk_page rigid_disk_page_default = {
177	/*page_code*/SMS_RIGID_DISK_PAGE,
178	/*page_length*/sizeof(struct scsi_rigid_disk_page) - 2,
179	/*cylinders*/ {0, 0, 0},
180	/*heads*/ CTL_DEFAULT_HEADS,
181	/*start_write_precomp*/ {0, 0, 0},
182	/*start_reduced_current*/ {0, 0, 0},
183	/*step_rate*/ {0, 0},
184	/*landing_zone_cylinder*/ {0, 0, 0},
185	/*rpl*/ SRDP_RPL_DISABLED,
186	/*rotational_offset*/ 0,
187	/*reserved1*/ 0,
188	/*rotation_rate*/ {(CTL_DEFAULT_ROTATION_RATE >> 8) & 0xff,
189			   CTL_DEFAULT_ROTATION_RATE & 0xff},
190	/*reserved2*/ {0, 0}
191};
192
193const static struct scsi_rigid_disk_page rigid_disk_page_changeable = {
194	/*page_code*/SMS_RIGID_DISK_PAGE,
195	/*page_length*/sizeof(struct scsi_rigid_disk_page) - 2,
196	/*cylinders*/ {0, 0, 0},
197	/*heads*/ 0,
198	/*start_write_precomp*/ {0, 0, 0},
199	/*start_reduced_current*/ {0, 0, 0},
200	/*step_rate*/ {0, 0},
201	/*landing_zone_cylinder*/ {0, 0, 0},
202	/*rpl*/ 0,
203	/*rotational_offset*/ 0,
204	/*reserved1*/ 0,
205	/*rotation_rate*/ {0, 0},
206	/*reserved2*/ {0, 0}
207};
208
209const static struct scsi_caching_page caching_page_default = {
210	/*page_code*/SMS_CACHING_PAGE,
211	/*page_length*/sizeof(struct scsi_caching_page) - 2,
212	/*flags1*/ SCP_DISC | SCP_WCE,
213	/*ret_priority*/ 0,
214	/*disable_pf_transfer_len*/ {0xff, 0xff},
215	/*min_prefetch*/ {0, 0},
216	/*max_prefetch*/ {0xff, 0xff},
217	/*max_pf_ceiling*/ {0xff, 0xff},
218	/*flags2*/ 0,
219	/*cache_segments*/ 0,
220	/*cache_seg_size*/ {0, 0},
221	/*reserved*/ 0,
222	/*non_cache_seg_size*/ {0, 0, 0}
223};
224
225const static struct scsi_caching_page caching_page_changeable = {
226	/*page_code*/SMS_CACHING_PAGE,
227	/*page_length*/sizeof(struct scsi_caching_page) - 2,
228	/*flags1*/ SCP_WCE | SCP_RCD,
229	/*ret_priority*/ 0,
230	/*disable_pf_transfer_len*/ {0, 0},
231	/*min_prefetch*/ {0, 0},
232	/*max_prefetch*/ {0, 0},
233	/*max_pf_ceiling*/ {0, 0},
234	/*flags2*/ 0,
235	/*cache_segments*/ 0,
236	/*cache_seg_size*/ {0, 0},
237	/*reserved*/ 0,
238	/*non_cache_seg_size*/ {0, 0, 0}
239};
240
241const static struct scsi_control_page control_page_default = {
242	/*page_code*/SMS_CONTROL_MODE_PAGE,
243	/*page_length*/sizeof(struct scsi_control_page) - 2,
244	/*rlec*/0,
245	/*queue_flags*/SCP_QUEUE_ALG_RESTRICTED,
246	/*eca_and_aen*/0,
247	/*flags4*/SCP_TAS,
248	/*aen_holdoff_period*/{0, 0},
249	/*busy_timeout_period*/{0, 0},
250	/*extended_selftest_completion_time*/{0, 0}
251};
252
253const static struct scsi_control_page control_page_changeable = {
254	/*page_code*/SMS_CONTROL_MODE_PAGE,
255	/*page_length*/sizeof(struct scsi_control_page) - 2,
256	/*rlec*/SCP_DSENSE,
257	/*queue_flags*/SCP_QUEUE_ALG_MASK,
258	/*eca_and_aen*/SCP_SWP,
259	/*flags4*/0,
260	/*aen_holdoff_period*/{0, 0},
261	/*busy_timeout_period*/{0, 0},
262	/*extended_selftest_completion_time*/{0, 0}
263};
264
265#define CTL_CEM_LEN	(sizeof(struct scsi_control_ext_page) - 4)
266
267const static struct scsi_control_ext_page control_ext_page_default = {
268	/*page_code*/SMS_CONTROL_MODE_PAGE | SMPH_SPF,
269	/*subpage_code*/0x01,
270	/*page_length*/{CTL_CEM_LEN >> 8, CTL_CEM_LEN},
271	/*flags*/0,
272	/*prio*/0,
273	/*max_sense*/0
274};
275
276const static struct scsi_control_ext_page control_ext_page_changeable = {
277	/*page_code*/SMS_CONTROL_MODE_PAGE | SMPH_SPF,
278	/*subpage_code*/0x01,
279	/*page_length*/{CTL_CEM_LEN >> 8, CTL_CEM_LEN},
280	/*flags*/0,
281	/*prio*/0,
282	/*max_sense*/0
283};
284
285const static struct scsi_info_exceptions_page ie_page_default = {
286	/*page_code*/SMS_INFO_EXCEPTIONS_PAGE,
287	/*page_length*/sizeof(struct scsi_info_exceptions_page) - 2,
288	/*info_flags*/SIEP_FLAGS_DEXCPT,
289	/*mrie*/0,
290	/*interval_timer*/{0, 0, 0, 0},
291	/*report_count*/{0, 0, 0, 0}
292};
293
294const static struct scsi_info_exceptions_page ie_page_changeable = {
295	/*page_code*/SMS_INFO_EXCEPTIONS_PAGE,
296	/*page_length*/sizeof(struct scsi_info_exceptions_page) - 2,
297	/*info_flags*/0,
298	/*mrie*/0,
299	/*interval_timer*/{0, 0, 0, 0},
300	/*report_count*/{0, 0, 0, 0}
301};
302
303#define CTL_LBPM_LEN	(sizeof(struct ctl_logical_block_provisioning_page) - 4)
304
305const static struct ctl_logical_block_provisioning_page lbp_page_default = {{
306	/*page_code*/SMS_INFO_EXCEPTIONS_PAGE | SMPH_SPF,
307	/*subpage_code*/0x02,
308	/*page_length*/{CTL_LBPM_LEN >> 8, CTL_LBPM_LEN},
309	/*flags*/0,
310	/*reserved*/{0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0},
311	/*descr*/{}},
312	{{/*flags*/0,
313	  /*resource*/0x01,
314	  /*reserved*/{0, 0},
315	  /*count*/{0, 0, 0, 0}},
316	 {/*flags*/0,
317	  /*resource*/0x02,
318	  /*reserved*/{0, 0},
319	  /*count*/{0, 0, 0, 0}},
320	 {/*flags*/0,
321	  /*resource*/0xf1,
322	  /*reserved*/{0, 0},
323	  /*count*/{0, 0, 0, 0}},
324	 {/*flags*/0,
325	  /*resource*/0xf2,
326	  /*reserved*/{0, 0},
327	  /*count*/{0, 0, 0, 0}}
328	}
329};
330
331const static struct ctl_logical_block_provisioning_page lbp_page_changeable = {{
332	/*page_code*/SMS_INFO_EXCEPTIONS_PAGE | SMPH_SPF,
333	/*subpage_code*/0x02,
334	/*page_length*/{CTL_LBPM_LEN >> 8, CTL_LBPM_LEN},
335	/*flags*/0,
336	/*reserved*/{0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0},
337	/*descr*/{}},
338	{{/*flags*/0,
339	  /*resource*/0,
340	  /*reserved*/{0, 0},
341	  /*count*/{0, 0, 0, 0}},
342	 {/*flags*/0,
343	  /*resource*/0,
344	  /*reserved*/{0, 0},
345	  /*count*/{0, 0, 0, 0}},
346	 {/*flags*/0,
347	  /*resource*/0,
348	  /*reserved*/{0, 0},
349	  /*count*/{0, 0, 0, 0}},
350	 {/*flags*/0,
351	  /*resource*/0,
352	  /*reserved*/{0, 0},
353	  /*count*/{0, 0, 0, 0}}
354	}
355};
356
357const static struct scsi_cddvd_capabilities_page cddvd_page_default = {
358	/*page_code*/SMS_CDDVD_CAPS_PAGE,
359	/*page_length*/sizeof(struct scsi_cddvd_capabilities_page) - 2,
360	/*caps1*/0x3f,
361	/*caps2*/0x00,
362	/*caps3*/0xf0,
363	/*caps4*/0x00,
364	/*caps5*/0x29,
365	/*caps6*/0x00,
366	/*obsolete*/{0, 0},
367	/*nvol_levels*/{0, 0},
368	/*buffer_size*/{8, 0},
369	/*obsolete2*/{0, 0},
370	/*reserved*/0,
371	/*digital*/0,
372	/*obsolete3*/0,
373	/*copy_management*/0,
374	/*reserved2*/0,
375	/*rotation_control*/0,
376	/*cur_write_speed*/0,
377	/*num_speed_descr*/0,
378};
379
380const static struct scsi_cddvd_capabilities_page cddvd_page_changeable = {
381	/*page_code*/SMS_CDDVD_CAPS_PAGE,
382	/*page_length*/sizeof(struct scsi_cddvd_capabilities_page) - 2,
383	/*caps1*/0,
384	/*caps2*/0,
385	/*caps3*/0,
386	/*caps4*/0,
387	/*caps5*/0,
388	/*caps6*/0,
389	/*obsolete*/{0, 0},
390	/*nvol_levels*/{0, 0},
391	/*buffer_size*/{0, 0},
392	/*obsolete2*/{0, 0},
393	/*reserved*/0,
394	/*digital*/0,
395	/*obsolete3*/0,
396	/*copy_management*/0,
397	/*reserved2*/0,
398	/*rotation_control*/0,
399	/*cur_write_speed*/0,
400	/*num_speed_descr*/0,
401};
402
403SYSCTL_NODE(_kern_cam, OID_AUTO, ctl, CTLFLAG_RD, 0, "CAM Target Layer");
404static int worker_threads = -1;
405TUNABLE_INT("kern.cam.ctl.worker_threads", &worker_threads);
406SYSCTL_INT(_kern_cam_ctl, OID_AUTO, worker_threads, CTLFLAG_RDTUN,
407    &worker_threads, 1, "Number of worker threads");
408static int ctl_debug = CTL_DEBUG_NONE;
409TUNABLE_INT("kern.cam.ctl.debug", &ctl_debug);
410SYSCTL_INT(_kern_cam_ctl, OID_AUTO, debug, CTLFLAG_RWTUN,
411    &ctl_debug, 0, "Enabled debug flags");
412
413/*
414 * Supported pages (0x00), Serial number (0x80), Device ID (0x83),
415 * Extended INQUIRY Data (0x86), Mode Page Policy (0x87),
416 * SCSI Ports (0x88), Third-party Copy (0x8F), Block limits (0xB0),
417 * Block Device Characteristics (0xB1) and Logical Block Provisioning (0xB2)
418 */
419#define SCSI_EVPD_NUM_SUPPORTED_PAGES	10
420
421static void ctl_isc_event_handler(ctl_ha_channel chanel, ctl_ha_event event,
422				  int param);
423static void ctl_copy_sense_data(union ctl_ha_msg *src, union ctl_io *dest);
424static void ctl_copy_sense_data_back(union ctl_io *src, union ctl_ha_msg *dest);
425static int ctl_init(void);
426void ctl_shutdown(void);
427static int ctl_open(struct cdev *dev, int flags, int fmt, struct thread *td);
428static int ctl_close(struct cdev *dev, int flags, int fmt, struct thread *td);
429static int ctl_serialize_other_sc_cmd(struct ctl_scsiio *ctsio);
430static void ctl_ioctl_fill_ooa(struct ctl_lun *lun, uint32_t *cur_fill_num,
431			      struct ctl_ooa *ooa_hdr,
432			      struct ctl_ooa_entry *kern_entries);
433static int ctl_ioctl(struct cdev *dev, u_long cmd, caddr_t addr, int flag,
434		     struct thread *td);
435static int ctl_alloc_lun(struct ctl_softc *ctl_softc, struct ctl_lun *lun,
436			 struct ctl_be_lun *be_lun);
437static int ctl_free_lun(struct ctl_lun *lun);
438static void ctl_create_lun(struct ctl_be_lun *be_lun);
439static struct ctl_port * ctl_io_port(struct ctl_io_hdr *io_hdr);
440
441static int ctl_do_mode_select(union ctl_io *io);
442static int ctl_pro_preempt(struct ctl_softc *softc, struct ctl_lun *lun,
443			   uint64_t res_key, uint64_t sa_res_key,
444			   uint8_t type, uint32_t residx,
445			   struct ctl_scsiio *ctsio,
446			   struct scsi_per_res_out *cdb,
447			   struct scsi_per_res_out_parms* param);
448static void ctl_pro_preempt_other(struct ctl_lun *lun,
449				  union ctl_ha_msg *msg);
450static void ctl_hndl_per_res_out_on_other_sc(union ctl_ha_msg *msg);
451static int ctl_inquiry_evpd_supported(struct ctl_scsiio *ctsio, int alloc_len);
452static int ctl_inquiry_evpd_serial(struct ctl_scsiio *ctsio, int alloc_len);
453static int ctl_inquiry_evpd_devid(struct ctl_scsiio *ctsio, int alloc_len);
454static int ctl_inquiry_evpd_eid(struct ctl_scsiio *ctsio, int alloc_len);
455static int ctl_inquiry_evpd_mpp(struct ctl_scsiio *ctsio, int alloc_len);
456static int ctl_inquiry_evpd_scsi_ports(struct ctl_scsiio *ctsio,
457					 int alloc_len);
458static int ctl_inquiry_evpd_block_limits(struct ctl_scsiio *ctsio,
459					 int alloc_len);
460static int ctl_inquiry_evpd_bdc(struct ctl_scsiio *ctsio, int alloc_len);
461static int ctl_inquiry_evpd_lbp(struct ctl_scsiio *ctsio, int alloc_len);
462static int ctl_inquiry_evpd(struct ctl_scsiio *ctsio);
463static int ctl_inquiry_std(struct ctl_scsiio *ctsio);
464static int ctl_get_lba_len(union ctl_io *io, uint64_t *lba, uint64_t *len);
465static ctl_action ctl_extent_check(union ctl_io *io1, union ctl_io *io2,
466    bool seq);
467static ctl_action ctl_extent_check_seq(union ctl_io *io1, union ctl_io *io2);
468static ctl_action ctl_check_for_blockage(struct ctl_lun *lun,
469    union ctl_io *pending_io, union ctl_io *ooa_io);
470static ctl_action ctl_check_ooa(struct ctl_lun *lun, union ctl_io *pending_io,
471				union ctl_io *starting_io);
472static int ctl_check_blocked(struct ctl_lun *lun);
473static int ctl_scsiio_lun_check(struct ctl_lun *lun,
474				const struct ctl_cmd_entry *entry,
475				struct ctl_scsiio *ctsio);
476static void ctl_failover_lun(union ctl_io *io);
477static int ctl_scsiio_precheck(struct ctl_softc *ctl_softc,
478			       struct ctl_scsiio *ctsio);
479static int ctl_scsiio(struct ctl_scsiio *ctsio);
480
481static int ctl_bus_reset(struct ctl_softc *ctl_softc, union ctl_io *io);
482static int ctl_target_reset(struct ctl_softc *ctl_softc, union ctl_io *io,
483			    ctl_ua_type ua_type);
484static int ctl_do_lun_reset(struct ctl_lun *lun, union ctl_io *io,
485			 ctl_ua_type ua_type);
486static int ctl_lun_reset(struct ctl_softc *ctl_softc, union ctl_io *io);
487static int ctl_abort_task(union ctl_io *io);
488static int ctl_abort_task_set(union ctl_io *io);
489static int ctl_query_task(union ctl_io *io, int task_set);
490static int ctl_i_t_nexus_reset(union ctl_io *io);
491static int ctl_query_async_event(union ctl_io *io);
492static void ctl_run_task(union ctl_io *io);
493#ifdef CTL_IO_DELAY
494static void ctl_datamove_timer_wakeup(void *arg);
495static void ctl_done_timer_wakeup(void *arg);
496#endif /* CTL_IO_DELAY */
497
498static void ctl_send_datamove_done(union ctl_io *io, int have_lock);
499static void ctl_datamove_remote_write_cb(struct ctl_ha_dt_req *rq);
500static int ctl_datamove_remote_dm_write_cb(union ctl_io *io);
501static void ctl_datamove_remote_write(union ctl_io *io);
502static int ctl_datamove_remote_dm_read_cb(union ctl_io *io);
503static void ctl_datamove_remote_read_cb(struct ctl_ha_dt_req *rq);
504static int ctl_datamove_remote_sgl_setup(union ctl_io *io);
505static int ctl_datamove_remote_xfer(union ctl_io *io, unsigned command,
506				    ctl_ha_dt_cb callback);
507static void ctl_datamove_remote_read(union ctl_io *io);
508static void ctl_datamove_remote(union ctl_io *io);
509static void ctl_process_done(union ctl_io *io);
510static void ctl_lun_thread(void *arg);
511static void ctl_thresh_thread(void *arg);
512static void ctl_work_thread(void *arg);
513static void ctl_enqueue_incoming(union ctl_io *io);
514static void ctl_enqueue_rtr(union ctl_io *io);
515static void ctl_enqueue_done(union ctl_io *io);
516static void ctl_enqueue_isc(union ctl_io *io);
517static const struct ctl_cmd_entry *
518    ctl_get_cmd_entry(struct ctl_scsiio *ctsio, int *sa);
519static const struct ctl_cmd_entry *
520    ctl_validate_command(struct ctl_scsiio *ctsio);
521static int ctl_cmd_applicable(uint8_t lun_type,
522    const struct ctl_cmd_entry *entry);
523
524static uint64_t ctl_get_prkey(struct ctl_lun *lun, uint32_t residx);
525static void ctl_clr_prkey(struct ctl_lun *lun, uint32_t residx);
526static void ctl_alloc_prkey(struct ctl_lun *lun, uint32_t residx);
527static void ctl_set_prkey(struct ctl_lun *lun, uint32_t residx, uint64_t key);
528
529/*
530 * Load the serialization table.  This isn't very pretty, but is probably
531 * the easiest way to do it.
532 */
533#include "ctl_ser_table.c"
534
535/*
536 * We only need to define open, close and ioctl routines for this driver.
537 */
538static struct cdevsw ctl_cdevsw = {
539	.d_version =	D_VERSION,
540	.d_flags =	0,
541	.d_open =	ctl_open,
542	.d_close =	ctl_close,
543	.d_ioctl =	ctl_ioctl,
544	.d_name =	"ctl",
545};
546
547
548MALLOC_DEFINE(M_CTL, "ctlmem", "Memory used for CTL");
549
550static int ctl_module_event_handler(module_t, int /*modeventtype_t*/, void *);
551
552static moduledata_t ctl_moduledata = {
553	"ctl",
554	ctl_module_event_handler,
555	NULL
556};
557
558DECLARE_MODULE(ctl, ctl_moduledata, SI_SUB_CONFIGURE, SI_ORDER_THIRD);
559MODULE_VERSION(ctl, 1);
560
561static struct ctl_frontend ha_frontend =
562{
563	.name = "ha",
564};
565
566static void
567ctl_ha_datamove(union ctl_io *io)
568{
569	struct ctl_lun *lun;
570	struct ctl_sg_entry *sgl;
571	union ctl_ha_msg msg;
572	uint32_t sg_entries_sent;
573	int do_sg_copy, i, j;
574
575	lun = (struct ctl_lun *)io->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
576	memset(&msg.dt, 0, sizeof(msg.dt));
577	msg.hdr.msg_type = CTL_MSG_DATAMOVE;
578	msg.hdr.original_sc = io->io_hdr.original_sc;
579	msg.hdr.serializing_sc = io;
580	msg.hdr.nexus = io->io_hdr.nexus;
581	msg.hdr.status = io->io_hdr.status;
582	msg.dt.flags = io->io_hdr.flags;
583
584	/*
585	 * We convert everything into a S/G list here.  We can't
586	 * pass by reference, only by value between controllers.
587	 * So we can't pass a pointer to the S/G list, only as many
588	 * S/G entries as we can fit in here.  If it's possible for
589	 * us to get more than CTL_HA_MAX_SG_ENTRIES S/G entries,
590	 * then we need to break this up into multiple transfers.
591	 */
592	if (io->scsiio.kern_sg_entries == 0) {
593		msg.dt.kern_sg_entries = 1;
594#if 0
595		if (io->io_hdr.flags & CTL_FLAG_BUS_ADDR) {
596			msg.dt.sg_list[0].addr = io->scsiio.kern_data_ptr;
597		} else {
598			/* XXX KDM use busdma here! */
599			msg.dt.sg_list[0].addr =
600			    (void *)vtophys(io->scsiio.kern_data_ptr);
601		}
602#else
603		KASSERT((io->io_hdr.flags & CTL_FLAG_BUS_ADDR) == 0,
604		    ("HA does not support BUS_ADDR"));
605		msg.dt.sg_list[0].addr = io->scsiio.kern_data_ptr;
606#endif
607		msg.dt.sg_list[0].len = io->scsiio.kern_data_len;
608		do_sg_copy = 0;
609	} else {
610		msg.dt.kern_sg_entries = io->scsiio.kern_sg_entries;
611		do_sg_copy = 1;
612	}
613
614	msg.dt.kern_data_len = io->scsiio.kern_data_len;
615	msg.dt.kern_total_len = io->scsiio.kern_total_len;
616	msg.dt.kern_data_resid = io->scsiio.kern_data_resid;
617	msg.dt.kern_rel_offset = io->scsiio.kern_rel_offset;
618	msg.dt.sg_sequence = 0;
619
620	/*
621	 * Loop until we've sent all of the S/G entries.  On the
622	 * other end, we'll recompose these S/G entries into one
623	 * contiguous list before processing.
624	 */
625	for (sg_entries_sent = 0; sg_entries_sent < msg.dt.kern_sg_entries;
626	    msg.dt.sg_sequence++) {
627		msg.dt.cur_sg_entries = MIN((sizeof(msg.dt.sg_list) /
628		    sizeof(msg.dt.sg_list[0])),
629		    msg.dt.kern_sg_entries - sg_entries_sent);
630		if (do_sg_copy != 0) {
631			sgl = (struct ctl_sg_entry *)io->scsiio.kern_data_ptr;
632			for (i = sg_entries_sent, j = 0;
633			     i < msg.dt.cur_sg_entries; i++, j++) {
634#if 0
635				if (io->io_hdr.flags & CTL_FLAG_BUS_ADDR) {
636					msg.dt.sg_list[j].addr = sgl[i].addr;
637				} else {
638					/* XXX KDM use busdma here! */
639					msg.dt.sg_list[j].addr =
640					    (void *)vtophys(sgl[i].addr);
641				}
642#else
643				KASSERT((io->io_hdr.flags &
644				    CTL_FLAG_BUS_ADDR) == 0,
645				    ("HA does not support BUS_ADDR"));
646				msg.dt.sg_list[j].addr = sgl[i].addr;
647#endif
648				msg.dt.sg_list[j].len = sgl[i].len;
649			}
650		}
651
652		sg_entries_sent += msg.dt.cur_sg_entries;
653		msg.dt.sg_last = (sg_entries_sent >= msg.dt.kern_sg_entries);
654		if (ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg,
655		    sizeof(msg.dt) - sizeof(msg.dt.sg_list) +
656		    sizeof(struct ctl_sg_entry) * msg.dt.cur_sg_entries,
657		    M_WAITOK) > CTL_HA_STATUS_SUCCESS) {
658			io->io_hdr.port_status = 31341;
659			io->scsiio.be_move_done(io);
660			return;
661		}
662		msg.dt.sent_sg_entries = sg_entries_sent;
663	}
664
665	/*
666	 * Officially handover the request from us to peer.
667	 * If failover has just happened, then we must return error.
668	 * If failover happen just after, then it is not our problem.
669	 */
670	if (lun)
671		mtx_lock(&lun->lun_lock);
672	if (io->io_hdr.flags & CTL_FLAG_FAILOVER) {
673		if (lun)
674			mtx_unlock(&lun->lun_lock);
675		io->io_hdr.port_status = 31342;
676		io->scsiio.be_move_done(io);
677		return;
678	}
679	io->io_hdr.flags &= ~CTL_FLAG_IO_ACTIVE;
680	io->io_hdr.flags |= CTL_FLAG_DMA_INPROG;
681	if (lun)
682		mtx_unlock(&lun->lun_lock);
683}
684
685static void
686ctl_ha_done(union ctl_io *io)
687{
688	union ctl_ha_msg msg;
689
690	if (io->io_hdr.io_type == CTL_IO_SCSI) {
691		memset(&msg, 0, sizeof(msg));
692		msg.hdr.msg_type = CTL_MSG_FINISH_IO;
693		msg.hdr.original_sc = io->io_hdr.original_sc;
694		msg.hdr.nexus = io->io_hdr.nexus;
695		msg.hdr.status = io->io_hdr.status;
696		msg.scsi.scsi_status = io->scsiio.scsi_status;
697		msg.scsi.tag_num = io->scsiio.tag_num;
698		msg.scsi.tag_type = io->scsiio.tag_type;
699		msg.scsi.sense_len = io->scsiio.sense_len;
700		msg.scsi.sense_residual = io->scsiio.sense_residual;
701		msg.scsi.residual = io->scsiio.residual;
702		memcpy(&msg.scsi.sense_data, &io->scsiio.sense_data,
703		    io->scsiio.sense_len);
704		ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg,
705		    sizeof(msg.scsi) - sizeof(msg.scsi.sense_data) +
706		    msg.scsi.sense_len, M_WAITOK);
707	}
708	ctl_free_io(io);
709}
710
711static void
712ctl_isc_handler_finish_xfer(struct ctl_softc *ctl_softc,
713			    union ctl_ha_msg *msg_info)
714{
715	struct ctl_scsiio *ctsio;
716
717	if (msg_info->hdr.original_sc == NULL) {
718		printf("%s: original_sc == NULL!\n", __func__);
719		/* XXX KDM now what? */
720		return;
721	}
722
723	ctsio = &msg_info->hdr.original_sc->scsiio;
724	ctsio->io_hdr.flags |= CTL_FLAG_IO_ACTIVE;
725	ctsio->io_hdr.msg_type = CTL_MSG_FINISH_IO;
726	ctsio->io_hdr.status = msg_info->hdr.status;
727	ctsio->scsi_status = msg_info->scsi.scsi_status;
728	ctsio->sense_len = msg_info->scsi.sense_len;
729	ctsio->sense_residual = msg_info->scsi.sense_residual;
730	ctsio->residual = msg_info->scsi.residual;
731	memcpy(&ctsio->sense_data, &msg_info->scsi.sense_data,
732	       msg_info->scsi.sense_len);
733	ctl_enqueue_isc((union ctl_io *)ctsio);
734}
735
736static void
737ctl_isc_handler_finish_ser_only(struct ctl_softc *ctl_softc,
738				union ctl_ha_msg *msg_info)
739{
740	struct ctl_scsiio *ctsio;
741
742	if (msg_info->hdr.serializing_sc == NULL) {
743		printf("%s: serializing_sc == NULL!\n", __func__);
744		/* XXX KDM now what? */
745		return;
746	}
747
748	ctsio = &msg_info->hdr.serializing_sc->scsiio;
749	ctsio->io_hdr.msg_type = CTL_MSG_FINISH_IO;
750	ctl_enqueue_isc((union ctl_io *)ctsio);
751}
752
753void
754ctl_isc_announce_lun(struct ctl_lun *lun)
755{
756	struct ctl_softc *softc = lun->ctl_softc;
757	union ctl_ha_msg *msg;
758	struct ctl_ha_msg_lun_pr_key pr_key;
759	int i, k;
760
761	if (softc->ha_link != CTL_HA_LINK_ONLINE)
762		return;
763	mtx_lock(&lun->lun_lock);
764	i = sizeof(msg->lun);
765	if (lun->lun_devid)
766		i += lun->lun_devid->len;
767	i += sizeof(pr_key) * lun->pr_key_count;
768alloc:
769	mtx_unlock(&lun->lun_lock);
770	msg = malloc(i, M_CTL, M_WAITOK);
771	mtx_lock(&lun->lun_lock);
772	k = sizeof(msg->lun);
773	if (lun->lun_devid)
774		k += lun->lun_devid->len;
775	k += sizeof(pr_key) * lun->pr_key_count;
776	if (i < k) {
777		free(msg, M_CTL);
778		i = k;
779		goto alloc;
780	}
781	bzero(&msg->lun, sizeof(msg->lun));
782	msg->hdr.msg_type = CTL_MSG_LUN_SYNC;
783	msg->hdr.nexus.targ_lun = lun->lun;
784	msg->hdr.nexus.targ_mapped_lun = lun->lun;
785	msg->lun.flags = lun->flags;
786	msg->lun.pr_generation = lun->pr_generation;
787	msg->lun.pr_res_idx = lun->pr_res_idx;
788	msg->lun.pr_res_type = lun->pr_res_type;
789	msg->lun.pr_key_count = lun->pr_key_count;
790	i = 0;
791	if (lun->lun_devid) {
792		msg->lun.lun_devid_len = lun->lun_devid->len;
793		memcpy(&msg->lun.data[i], lun->lun_devid->data,
794		    msg->lun.lun_devid_len);
795		i += msg->lun.lun_devid_len;
796	}
797	for (k = 0; k < CTL_MAX_INITIATORS; k++) {
798		if ((pr_key.pr_key = ctl_get_prkey(lun, k)) == 0)
799			continue;
800		pr_key.pr_iid = k;
801		memcpy(&msg->lun.data[i], &pr_key, sizeof(pr_key));
802		i += sizeof(pr_key);
803	}
804	mtx_unlock(&lun->lun_lock);
805	ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg->port, sizeof(msg->port) + i,
806	    M_WAITOK);
807	free(msg, M_CTL);
808
809	if (lun->flags & CTL_LUN_PRIMARY_SC) {
810		for (i = 0; i < CTL_NUM_MODE_PAGES; i++) {
811			ctl_isc_announce_mode(lun, -1,
812			    lun->mode_pages.index[i].page_code & SMPH_PC_MASK,
813			    lun->mode_pages.index[i].subpage);
814		}
815	}
816}
817
818void
819ctl_isc_announce_port(struct ctl_port *port)
820{
821	struct ctl_softc *softc = port->ctl_softc;
822	union ctl_ha_msg *msg;
823	int i;
824
825	if (port->targ_port < softc->port_min ||
826	    port->targ_port >= softc->port_max ||
827	    softc->ha_link != CTL_HA_LINK_ONLINE)
828		return;
829	i = sizeof(msg->port) + strlen(port->port_name) + 1;
830	if (port->lun_map)
831		i += sizeof(uint32_t) * CTL_MAX_LUNS;
832	if (port->port_devid)
833		i += port->port_devid->len;
834	if (port->target_devid)
835		i += port->target_devid->len;
836	if (port->init_devid)
837		i += port->init_devid->len;
838	msg = malloc(i, M_CTL, M_WAITOK);
839	bzero(&msg->port, sizeof(msg->port));
840	msg->hdr.msg_type = CTL_MSG_PORT_SYNC;
841	msg->hdr.nexus.targ_port = port->targ_port;
842	msg->port.port_type = port->port_type;
843	msg->port.physical_port = port->physical_port;
844	msg->port.virtual_port = port->virtual_port;
845	msg->port.status = port->status;
846	i = 0;
847	msg->port.name_len = sprintf(&msg->port.data[i],
848	    "%d:%s", softc->ha_id, port->port_name) + 1;
849	i += msg->port.name_len;
850	if (port->lun_map) {
851		msg->port.lun_map_len = sizeof(uint32_t) * CTL_MAX_LUNS;
852		memcpy(&msg->port.data[i], port->lun_map,
853		    msg->port.lun_map_len);
854		i += msg->port.lun_map_len;
855	}
856	if (port->port_devid) {
857		msg->port.port_devid_len = port->port_devid->len;
858		memcpy(&msg->port.data[i], port->port_devid->data,
859		    msg->port.port_devid_len);
860		i += msg->port.port_devid_len;
861	}
862	if (port->target_devid) {
863		msg->port.target_devid_len = port->target_devid->len;
864		memcpy(&msg->port.data[i], port->target_devid->data,
865		    msg->port.target_devid_len);
866		i += msg->port.target_devid_len;
867	}
868	if (port->init_devid) {
869		msg->port.init_devid_len = port->init_devid->len;
870		memcpy(&msg->port.data[i], port->init_devid->data,
871		    msg->port.init_devid_len);
872		i += msg->port.init_devid_len;
873	}
874	ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg->port, sizeof(msg->port) + i,
875	    M_WAITOK);
876	free(msg, M_CTL);
877}
878
879void
880ctl_isc_announce_iid(struct ctl_port *port, int iid)
881{
882	struct ctl_softc *softc = port->ctl_softc;
883	union ctl_ha_msg *msg;
884	int i, l;
885
886	if (port->targ_port < softc->port_min ||
887	    port->targ_port >= softc->port_max ||
888	    softc->ha_link != CTL_HA_LINK_ONLINE)
889		return;
890	mtx_lock(&softc->ctl_lock);
891	i = sizeof(msg->iid);
892	l = 0;
893	if (port->wwpn_iid[iid].name)
894		l = strlen(port->wwpn_iid[iid].name) + 1;
895	i += l;
896	msg = malloc(i, M_CTL, M_NOWAIT);
897	if (msg == NULL) {
898		mtx_unlock(&softc->ctl_lock);
899		return;
900	}
901	bzero(&msg->iid, sizeof(msg->iid));
902	msg->hdr.msg_type = CTL_MSG_IID_SYNC;
903	msg->hdr.nexus.targ_port = port->targ_port;
904	msg->hdr.nexus.initid = iid;
905	msg->iid.in_use = port->wwpn_iid[iid].in_use;
906	msg->iid.name_len = l;
907	msg->iid.wwpn = port->wwpn_iid[iid].wwpn;
908	if (port->wwpn_iid[iid].name)
909		strlcpy(msg->iid.data, port->wwpn_iid[iid].name, l);
910	mtx_unlock(&softc->ctl_lock);
911	ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg->iid, i, M_NOWAIT);
912	free(msg, M_CTL);
913}
914
915void
916ctl_isc_announce_mode(struct ctl_lun *lun, uint32_t initidx,
917    uint8_t page, uint8_t subpage)
918{
919	struct ctl_softc *softc = lun->ctl_softc;
920	union ctl_ha_msg msg;
921	int i;
922
923	if (softc->ha_link != CTL_HA_LINK_ONLINE)
924		return;
925	for (i = 0; i < CTL_NUM_MODE_PAGES; i++) {
926		if ((lun->mode_pages.index[i].page_code & SMPH_PC_MASK) ==
927		    page && lun->mode_pages.index[i].subpage == subpage)
928			break;
929	}
930	if (i == CTL_NUM_MODE_PAGES)
931		return;
932
933	/* Don't try to replicate pages not present on this device. */
934	if (lun->mode_pages.index[i].page_data == NULL)
935		return;
936
937	bzero(&msg.mode, sizeof(msg.mode));
938	msg.hdr.msg_type = CTL_MSG_MODE_SYNC;
939	msg.hdr.nexus.targ_port = initidx / CTL_MAX_INIT_PER_PORT;
940	msg.hdr.nexus.initid = initidx % CTL_MAX_INIT_PER_PORT;
941	msg.hdr.nexus.targ_lun = lun->lun;
942	msg.hdr.nexus.targ_mapped_lun = lun->lun;
943	msg.mode.page_code = page;
944	msg.mode.subpage = subpage;
945	msg.mode.page_len = lun->mode_pages.index[i].page_len;
946	memcpy(msg.mode.data, lun->mode_pages.index[i].page_data,
947	    msg.mode.page_len);
948	ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg.mode, sizeof(msg.mode),
949	    M_WAITOK);
950}
951
952static void
953ctl_isc_ha_link_up(struct ctl_softc *softc)
954{
955	struct ctl_port *port;
956	struct ctl_lun *lun;
957	union ctl_ha_msg msg;
958	int i;
959
960	/* Announce this node parameters to peer for validation. */
961	msg.login.msg_type = CTL_MSG_LOGIN;
962	msg.login.version = CTL_HA_VERSION;
963	msg.login.ha_mode = softc->ha_mode;
964	msg.login.ha_id = softc->ha_id;
965	msg.login.max_luns = CTL_MAX_LUNS;
966	msg.login.max_ports = CTL_MAX_PORTS;
967	msg.login.max_init_per_port = CTL_MAX_INIT_PER_PORT;
968	ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg.login, sizeof(msg.login),
969	    M_WAITOK);
970
971	STAILQ_FOREACH(port, &softc->port_list, links) {
972		ctl_isc_announce_port(port);
973		for (i = 0; i < CTL_MAX_INIT_PER_PORT; i++) {
974			if (port->wwpn_iid[i].in_use)
975				ctl_isc_announce_iid(port, i);
976		}
977	}
978	STAILQ_FOREACH(lun, &softc->lun_list, links)
979		ctl_isc_announce_lun(lun);
980}
981
982static void
983ctl_isc_ha_link_down(struct ctl_softc *softc)
984{
985	struct ctl_port *port;
986	struct ctl_lun *lun;
987	union ctl_io *io;
988	int i;
989
990	mtx_lock(&softc->ctl_lock);
991	STAILQ_FOREACH(lun, &softc->lun_list, links) {
992		mtx_lock(&lun->lun_lock);
993		if (lun->flags & CTL_LUN_PEER_SC_PRIMARY) {
994			lun->flags &= ~CTL_LUN_PEER_SC_PRIMARY;
995			ctl_est_ua_all(lun, -1, CTL_UA_ASYM_ACC_CHANGE);
996		}
997		mtx_unlock(&lun->lun_lock);
998
999		mtx_unlock(&softc->ctl_lock);
1000		io = ctl_alloc_io(softc->othersc_pool);
1001		mtx_lock(&softc->ctl_lock);
1002		ctl_zero_io(io);
1003		io->io_hdr.msg_type = CTL_MSG_FAILOVER;
1004		io->io_hdr.nexus.targ_mapped_lun = lun->lun;
1005		ctl_enqueue_isc(io);
1006	}
1007
1008	STAILQ_FOREACH(port, &softc->port_list, links) {
1009		if (port->targ_port >= softc->port_min &&
1010		    port->targ_port < softc->port_max)
1011			continue;
1012		port->status &= ~CTL_PORT_STATUS_ONLINE;
1013		for (i = 0; i < CTL_MAX_INIT_PER_PORT; i++) {
1014			port->wwpn_iid[i].in_use = 0;
1015			free(port->wwpn_iid[i].name, M_CTL);
1016			port->wwpn_iid[i].name = NULL;
1017		}
1018	}
1019	mtx_unlock(&softc->ctl_lock);
1020}
1021
1022static void
1023ctl_isc_ua(struct ctl_softc *softc, union ctl_ha_msg *msg, int len)
1024{
1025	struct ctl_lun *lun;
1026	uint32_t iid = ctl_get_initindex(&msg->hdr.nexus);
1027
1028	mtx_lock(&softc->ctl_lock);
1029	if (msg->hdr.nexus.targ_lun < CTL_MAX_LUNS &&
1030	    (lun = softc->ctl_luns[msg->hdr.nexus.targ_mapped_lun]) != NULL) {
1031		mtx_lock(&lun->lun_lock);
1032		mtx_unlock(&softc->ctl_lock);
1033		if (msg->ua.ua_type == CTL_UA_THIN_PROV_THRES &&
1034		    msg->ua.ua_set)
1035			memcpy(lun->ua_tpt_info, msg->ua.ua_info, 8);
1036		if (msg->ua.ua_all) {
1037			if (msg->ua.ua_set)
1038				ctl_est_ua_all(lun, iid, msg->ua.ua_type);
1039			else
1040				ctl_clr_ua_all(lun, iid, msg->ua.ua_type);
1041		} else {
1042			if (msg->ua.ua_set)
1043				ctl_est_ua(lun, iid, msg->ua.ua_type);
1044			else
1045				ctl_clr_ua(lun, iid, msg->ua.ua_type);
1046		}
1047		mtx_unlock(&lun->lun_lock);
1048	} else
1049		mtx_unlock(&softc->ctl_lock);
1050}
1051
1052static void
1053ctl_isc_lun_sync(struct ctl_softc *softc, union ctl_ha_msg *msg, int len)
1054{
1055	struct ctl_lun *lun;
1056	struct ctl_ha_msg_lun_pr_key pr_key;
1057	int i, k;
1058	ctl_lun_flags oflags;
1059	uint32_t targ_lun;
1060
1061	targ_lun = msg->hdr.nexus.targ_mapped_lun;
1062	mtx_lock(&softc->ctl_lock);
1063	if ((targ_lun >= CTL_MAX_LUNS) ||
1064	    ((lun = softc->ctl_luns[targ_lun]) == NULL)) {
1065		mtx_unlock(&softc->ctl_lock);
1066		return;
1067	}
1068	mtx_lock(&lun->lun_lock);
1069	mtx_unlock(&softc->ctl_lock);
1070	if (lun->flags & CTL_LUN_DISABLED) {
1071		mtx_unlock(&lun->lun_lock);
1072		return;
1073	}
1074	i = (lun->lun_devid != NULL) ? lun->lun_devid->len : 0;
1075	if (msg->lun.lun_devid_len != i || (i > 0 &&
1076	    memcmp(&msg->lun.data[0], lun->lun_devid->data, i) != 0)) {
1077		mtx_unlock(&lun->lun_lock);
1078		printf("%s: Received conflicting HA LUN %d\n",
1079		    __func__, msg->hdr.nexus.targ_lun);
1080		return;
1081	} else {
1082		/* Record whether peer is primary. */
1083		oflags = lun->flags;
1084		if ((msg->lun.flags & CTL_LUN_PRIMARY_SC) &&
1085		    (msg->lun.flags & CTL_LUN_DISABLED) == 0)
1086			lun->flags |= CTL_LUN_PEER_SC_PRIMARY;
1087		else
1088			lun->flags &= ~CTL_LUN_PEER_SC_PRIMARY;
1089		if (oflags != lun->flags)
1090			ctl_est_ua_all(lun, -1, CTL_UA_ASYM_ACC_CHANGE);
1091
1092		/* If peer is primary and we are not -- use data */
1093		if ((lun->flags & CTL_LUN_PRIMARY_SC) == 0 &&
1094		    (lun->flags & CTL_LUN_PEER_SC_PRIMARY)) {
1095			lun->pr_generation = msg->lun.pr_generation;
1096			lun->pr_res_idx = msg->lun.pr_res_idx;
1097			lun->pr_res_type = msg->lun.pr_res_type;
1098			lun->pr_key_count = msg->lun.pr_key_count;
1099			for (k = 0; k < CTL_MAX_INITIATORS; k++)
1100				ctl_clr_prkey(lun, k);
1101			for (k = 0; k < msg->lun.pr_key_count; k++) {
1102				memcpy(&pr_key, &msg->lun.data[i],
1103				    sizeof(pr_key));
1104				ctl_alloc_prkey(lun, pr_key.pr_iid);
1105				ctl_set_prkey(lun, pr_key.pr_iid,
1106				    pr_key.pr_key);
1107				i += sizeof(pr_key);
1108			}
1109		}
1110
1111		mtx_unlock(&lun->lun_lock);
1112		CTL_DEBUG_PRINT(("%s: Known LUN %d, peer is %s\n",
1113		    __func__, msg->hdr.nexus.targ_lun,
1114		    (msg->lun.flags & CTL_LUN_PRIMARY_SC) ?
1115		    "primary" : "secondary"));
1116
1117		/* If we are primary but peer doesn't know -- notify */
1118		if ((lun->flags & CTL_LUN_PRIMARY_SC) &&
1119		    (msg->lun.flags & CTL_LUN_PEER_SC_PRIMARY) == 0)
1120			ctl_isc_announce_lun(lun);
1121	}
1122}
1123
1124static void
1125ctl_isc_port_sync(struct ctl_softc *softc, union ctl_ha_msg *msg, int len)
1126{
1127	struct ctl_port *port;
1128	struct ctl_lun *lun;
1129	int i, new;
1130
1131	port = softc->ctl_ports[msg->hdr.nexus.targ_port];
1132	if (port == NULL) {
1133		CTL_DEBUG_PRINT(("%s: New port %d\n", __func__,
1134		    msg->hdr.nexus.targ_port));
1135		new = 1;
1136		port = malloc(sizeof(*port), M_CTL, M_WAITOK | M_ZERO);
1137		port->frontend = &ha_frontend;
1138		port->targ_port = msg->hdr.nexus.targ_port;
1139		port->fe_datamove = ctl_ha_datamove;
1140		port->fe_done = ctl_ha_done;
1141	} else if (port->frontend == &ha_frontend) {
1142		CTL_DEBUG_PRINT(("%s: Updated port %d\n", __func__,
1143		    msg->hdr.nexus.targ_port));
1144		new = 0;
1145	} else {
1146		printf("%s: Received conflicting HA port %d\n",
1147		    __func__, msg->hdr.nexus.targ_port);
1148		return;
1149	}
1150	port->port_type = msg->port.port_type;
1151	port->physical_port = msg->port.physical_port;
1152	port->virtual_port = msg->port.virtual_port;
1153	port->status = msg->port.status;
1154	i = 0;
1155	free(port->port_name, M_CTL);
1156	port->port_name = strndup(&msg->port.data[i], msg->port.name_len,
1157	    M_CTL);
1158	i += msg->port.name_len;
1159	if (msg->port.lun_map_len != 0) {
1160		if (port->lun_map == NULL)
1161			port->lun_map = malloc(sizeof(uint32_t) * CTL_MAX_LUNS,
1162			    M_CTL, M_WAITOK);
1163		memcpy(port->lun_map, &msg->port.data[i],
1164		    sizeof(uint32_t) * CTL_MAX_LUNS);
1165		i += msg->port.lun_map_len;
1166	} else {
1167		free(port->lun_map, M_CTL);
1168		port->lun_map = NULL;
1169	}
1170	if (msg->port.port_devid_len != 0) {
1171		if (port->port_devid == NULL ||
1172		    port->port_devid->len != msg->port.port_devid_len) {
1173			free(port->port_devid, M_CTL);
1174			port->port_devid = malloc(sizeof(struct ctl_devid) +
1175			    msg->port.port_devid_len, M_CTL, M_WAITOK);
1176		}
1177		memcpy(port->port_devid->data, &msg->port.data[i],
1178		    msg->port.port_devid_len);
1179		port->port_devid->len = msg->port.port_devid_len;
1180		i += msg->port.port_devid_len;
1181	} else {
1182		free(port->port_devid, M_CTL);
1183		port->port_devid = NULL;
1184	}
1185	if (msg->port.target_devid_len != 0) {
1186		if (port->target_devid == NULL ||
1187		    port->target_devid->len != msg->port.target_devid_len) {
1188			free(port->target_devid, M_CTL);
1189			port->target_devid = malloc(sizeof(struct ctl_devid) +
1190			    msg->port.target_devid_len, M_CTL, M_WAITOK);
1191		}
1192		memcpy(port->target_devid->data, &msg->port.data[i],
1193		    msg->port.target_devid_len);
1194		port->target_devid->len = msg->port.target_devid_len;
1195		i += msg->port.target_devid_len;
1196	} else {
1197		free(port->target_devid, M_CTL);
1198		port->target_devid = NULL;
1199	}
1200	if (msg->port.init_devid_len != 0) {
1201		if (port->init_devid == NULL ||
1202		    port->init_devid->len != msg->port.init_devid_len) {
1203			free(port->init_devid, M_CTL);
1204			port->init_devid = malloc(sizeof(struct ctl_devid) +
1205			    msg->port.init_devid_len, M_CTL, M_WAITOK);
1206		}
1207		memcpy(port->init_devid->data, &msg->port.data[i],
1208		    msg->port.init_devid_len);
1209		port->init_devid->len = msg->port.init_devid_len;
1210		i += msg->port.init_devid_len;
1211	} else {
1212		free(port->init_devid, M_CTL);
1213		port->init_devid = NULL;
1214	}
1215	if (new) {
1216		if (ctl_port_register(port) != 0) {
1217			printf("%s: ctl_port_register() failed with error\n",
1218			    __func__);
1219		}
1220	}
1221	mtx_lock(&softc->ctl_lock);
1222	STAILQ_FOREACH(lun, &softc->lun_list, links) {
1223		if (ctl_lun_map_to_port(port, lun->lun) >= CTL_MAX_LUNS)
1224			continue;
1225		mtx_lock(&lun->lun_lock);
1226		ctl_est_ua_all(lun, -1, CTL_UA_INQ_CHANGE);
1227		mtx_unlock(&lun->lun_lock);
1228	}
1229	mtx_unlock(&softc->ctl_lock);
1230}
1231
1232static void
1233ctl_isc_iid_sync(struct ctl_softc *softc, union ctl_ha_msg *msg, int len)
1234{
1235	struct ctl_port *port;
1236	int iid;
1237
1238	port = softc->ctl_ports[msg->hdr.nexus.targ_port];
1239	if (port == NULL) {
1240		printf("%s: Received IID for unknown port %d\n",
1241		    __func__, msg->hdr.nexus.targ_port);
1242		return;
1243	}
1244	iid = msg->hdr.nexus.initid;
1245	port->wwpn_iid[iid].in_use = msg->iid.in_use;
1246	port->wwpn_iid[iid].wwpn = msg->iid.wwpn;
1247	free(port->wwpn_iid[iid].name, M_CTL);
1248	if (msg->iid.name_len) {
1249		port->wwpn_iid[iid].name = strndup(&msg->iid.data[0],
1250		    msg->iid.name_len, M_CTL);
1251	} else
1252		port->wwpn_iid[iid].name = NULL;
1253}
1254
1255static void
1256ctl_isc_login(struct ctl_softc *softc, union ctl_ha_msg *msg, int len)
1257{
1258
1259	if (msg->login.version != CTL_HA_VERSION) {
1260		printf("CTL HA peers have different versions %d != %d\n",
1261		    msg->login.version, CTL_HA_VERSION);
1262		ctl_ha_msg_abort(CTL_HA_CHAN_CTL);
1263		return;
1264	}
1265	if (msg->login.ha_mode != softc->ha_mode) {
1266		printf("CTL HA peers have different ha_mode %d != %d\n",
1267		    msg->login.ha_mode, softc->ha_mode);
1268		ctl_ha_msg_abort(CTL_HA_CHAN_CTL);
1269		return;
1270	}
1271	if (msg->login.ha_id == softc->ha_id) {
1272		printf("CTL HA peers have same ha_id %d\n", msg->login.ha_id);
1273		ctl_ha_msg_abort(CTL_HA_CHAN_CTL);
1274		return;
1275	}
1276	if (msg->login.max_luns != CTL_MAX_LUNS ||
1277	    msg->login.max_ports != CTL_MAX_PORTS ||
1278	    msg->login.max_init_per_port != CTL_MAX_INIT_PER_PORT) {
1279		printf("CTL HA peers have different limits\n");
1280		ctl_ha_msg_abort(CTL_HA_CHAN_CTL);
1281		return;
1282	}
1283}
1284
1285static void
1286ctl_isc_mode_sync(struct ctl_softc *softc, union ctl_ha_msg *msg, int len)
1287{
1288	struct ctl_lun *lun;
1289	int i;
1290	uint32_t initidx, targ_lun;
1291
1292	targ_lun = msg->hdr.nexus.targ_mapped_lun;
1293	mtx_lock(&softc->ctl_lock);
1294	if ((targ_lun >= CTL_MAX_LUNS) ||
1295	    ((lun = softc->ctl_luns[targ_lun]) == NULL)) {
1296		mtx_unlock(&softc->ctl_lock);
1297		return;
1298	}
1299	mtx_lock(&lun->lun_lock);
1300	mtx_unlock(&softc->ctl_lock);
1301	if (lun->flags & CTL_LUN_DISABLED) {
1302		mtx_unlock(&lun->lun_lock);
1303		return;
1304	}
1305	for (i = 0; i < CTL_NUM_MODE_PAGES; i++) {
1306		if ((lun->mode_pages.index[i].page_code & SMPH_PC_MASK) ==
1307		    msg->mode.page_code &&
1308		    lun->mode_pages.index[i].subpage == msg->mode.subpage)
1309			break;
1310	}
1311	if (i == CTL_NUM_MODE_PAGES) {
1312		mtx_unlock(&lun->lun_lock);
1313		return;
1314	}
1315	memcpy(lun->mode_pages.index[i].page_data, msg->mode.data,
1316	    lun->mode_pages.index[i].page_len);
1317	initidx = ctl_get_initindex(&msg->hdr.nexus);
1318	if (initidx != -1)
1319		ctl_est_ua_all(lun, initidx, CTL_UA_MODE_CHANGE);
1320	mtx_unlock(&lun->lun_lock);
1321}
1322
1323/*
1324 * ISC (Inter Shelf Communication) event handler.  Events from the HA
1325 * subsystem come in here.
1326 */
1327static void
1328ctl_isc_event_handler(ctl_ha_channel channel, ctl_ha_event event, int param)
1329{
1330	struct ctl_softc *softc = control_softc;
1331	union ctl_io *io;
1332	struct ctl_prio *presio;
1333	ctl_ha_status isc_status;
1334
1335	CTL_DEBUG_PRINT(("CTL: Isc Msg event %d\n", event));
1336	if (event == CTL_HA_EVT_MSG_RECV) {
1337		union ctl_ha_msg *msg, msgbuf;
1338
1339		if (param > sizeof(msgbuf))
1340			msg = malloc(param, M_CTL, M_WAITOK);
1341		else
1342			msg = &msgbuf;
1343		isc_status = ctl_ha_msg_recv(CTL_HA_CHAN_CTL, msg, param,
1344		    M_WAITOK);
1345		if (isc_status != CTL_HA_STATUS_SUCCESS) {
1346			printf("%s: Error receiving message: %d\n",
1347			    __func__, isc_status);
1348			if (msg != &msgbuf)
1349				free(msg, M_CTL);
1350			return;
1351		}
1352
1353		CTL_DEBUG_PRINT(("CTL: msg_type %d\n", msg->msg_type));
1354		switch (msg->hdr.msg_type) {
1355		case CTL_MSG_SERIALIZE:
1356			io = ctl_alloc_io(softc->othersc_pool);
1357			ctl_zero_io(io);
1358			// populate ctsio from msg
1359			io->io_hdr.io_type = CTL_IO_SCSI;
1360			io->io_hdr.msg_type = CTL_MSG_SERIALIZE;
1361			io->io_hdr.original_sc = msg->hdr.original_sc;
1362			io->io_hdr.flags |= CTL_FLAG_FROM_OTHER_SC |
1363					    CTL_FLAG_IO_ACTIVE;
1364			/*
1365			 * If we're in serialization-only mode, we don't
1366			 * want to go through full done processing.  Thus
1367			 * the COPY flag.
1368			 *
1369			 * XXX KDM add another flag that is more specific.
1370			 */
1371			if (softc->ha_mode != CTL_HA_MODE_XFER)
1372				io->io_hdr.flags |= CTL_FLAG_INT_COPY;
1373			io->io_hdr.nexus = msg->hdr.nexus;
1374#if 0
1375			printf("port %u, iid %u, lun %u\n",
1376			       io->io_hdr.nexus.targ_port,
1377			       io->io_hdr.nexus.initid,
1378			       io->io_hdr.nexus.targ_lun);
1379#endif
1380			io->scsiio.tag_num = msg->scsi.tag_num;
1381			io->scsiio.tag_type = msg->scsi.tag_type;
1382#ifdef CTL_TIME_IO
1383			io->io_hdr.start_time = time_uptime;
1384			getbinuptime(&io->io_hdr.start_bt);
1385#endif /* CTL_TIME_IO */
1386			io->scsiio.cdb_len = msg->scsi.cdb_len;
1387			memcpy(io->scsiio.cdb, msg->scsi.cdb,
1388			       CTL_MAX_CDBLEN);
1389			if (softc->ha_mode == CTL_HA_MODE_XFER) {
1390				const struct ctl_cmd_entry *entry;
1391
1392				entry = ctl_get_cmd_entry(&io->scsiio, NULL);
1393				io->io_hdr.flags &= ~CTL_FLAG_DATA_MASK;
1394				io->io_hdr.flags |=
1395					entry->flags & CTL_FLAG_DATA_MASK;
1396			}
1397			ctl_enqueue_isc(io);
1398			break;
1399
1400		/* Performed on the Originating SC, XFER mode only */
1401		case CTL_MSG_DATAMOVE: {
1402			struct ctl_sg_entry *sgl;
1403			int i, j;
1404
1405			io = msg->hdr.original_sc;
1406			if (io == NULL) {
1407				printf("%s: original_sc == NULL!\n", __func__);
1408				/* XXX KDM do something here */
1409				break;
1410			}
1411			io->io_hdr.msg_type = CTL_MSG_DATAMOVE;
1412			io->io_hdr.flags |= CTL_FLAG_IO_ACTIVE;
1413			/*
1414			 * Keep track of this, we need to send it back over
1415			 * when the datamove is complete.
1416			 */
1417			io->io_hdr.serializing_sc = msg->hdr.serializing_sc;
1418			if (msg->hdr.status == CTL_SUCCESS)
1419				io->io_hdr.status = msg->hdr.status;
1420
1421			if (msg->dt.sg_sequence == 0) {
1422#ifdef CTL_TIME_IO
1423				getbinuptime(&io->io_hdr.dma_start_bt);
1424#endif
1425				i = msg->dt.kern_sg_entries +
1426				    msg->dt.kern_data_len /
1427				    CTL_HA_DATAMOVE_SEGMENT + 1;
1428				sgl = malloc(sizeof(*sgl) * i, M_CTL,
1429				    M_WAITOK | M_ZERO);
1430				io->io_hdr.remote_sglist = sgl;
1431				io->io_hdr.local_sglist =
1432				    &sgl[msg->dt.kern_sg_entries];
1433
1434				io->scsiio.kern_data_ptr = (uint8_t *)sgl;
1435
1436				io->scsiio.kern_sg_entries =
1437					msg->dt.kern_sg_entries;
1438				io->scsiio.rem_sg_entries =
1439					msg->dt.kern_sg_entries;
1440				io->scsiio.kern_data_len =
1441					msg->dt.kern_data_len;
1442				io->scsiio.kern_total_len =
1443					msg->dt.kern_total_len;
1444				io->scsiio.kern_data_resid =
1445					msg->dt.kern_data_resid;
1446				io->scsiio.kern_rel_offset =
1447					msg->dt.kern_rel_offset;
1448				io->io_hdr.flags &= ~CTL_FLAG_BUS_ADDR;
1449				io->io_hdr.flags |= msg->dt.flags &
1450				    CTL_FLAG_BUS_ADDR;
1451			} else
1452				sgl = (struct ctl_sg_entry *)
1453					io->scsiio.kern_data_ptr;
1454
1455			for (i = msg->dt.sent_sg_entries, j = 0;
1456			     i < (msg->dt.sent_sg_entries +
1457			     msg->dt.cur_sg_entries); i++, j++) {
1458				sgl[i].addr = msg->dt.sg_list[j].addr;
1459				sgl[i].len = msg->dt.sg_list[j].len;
1460
1461#if 0
1462				printf("%s: DATAMOVE: %p,%lu j=%d, i=%d\n",
1463				    __func__, sgl[i].addr, sgl[i].len, j, i);
1464#endif
1465			}
1466
1467			/*
1468			 * If this is the last piece of the I/O, we've got
1469			 * the full S/G list.  Queue processing in the thread.
1470			 * Otherwise wait for the next piece.
1471			 */
1472			if (msg->dt.sg_last != 0)
1473				ctl_enqueue_isc(io);
1474			break;
1475		}
1476		/* Performed on the Serializing (primary) SC, XFER mode only */
1477		case CTL_MSG_DATAMOVE_DONE: {
1478			if (msg->hdr.serializing_sc == NULL) {
1479				printf("%s: serializing_sc == NULL!\n",
1480				       __func__);
1481				/* XXX KDM now what? */
1482				break;
1483			}
1484			/*
1485			 * We grab the sense information here in case
1486			 * there was a failure, so we can return status
1487			 * back to the initiator.
1488			 */
1489			io = msg->hdr.serializing_sc;
1490			io->io_hdr.msg_type = CTL_MSG_DATAMOVE_DONE;
1491			io->io_hdr.flags &= ~CTL_FLAG_DMA_INPROG;
1492			io->io_hdr.flags |= CTL_FLAG_IO_ACTIVE;
1493			io->io_hdr.port_status = msg->scsi.fetd_status;
1494			io->scsiio.residual = msg->scsi.residual;
1495			if (msg->hdr.status != CTL_STATUS_NONE) {
1496				io->io_hdr.status = msg->hdr.status;
1497				io->scsiio.scsi_status = msg->scsi.scsi_status;
1498				io->scsiio.sense_len = msg->scsi.sense_len;
1499				io->scsiio.sense_residual =msg->scsi.sense_residual;
1500				memcpy(&io->scsiio.sense_data,
1501				    &msg->scsi.sense_data,
1502				    msg->scsi.sense_len);
1503				if (msg->hdr.status == CTL_SUCCESS)
1504					io->io_hdr.flags |= CTL_FLAG_STATUS_SENT;
1505			}
1506			ctl_enqueue_isc(io);
1507			break;
1508		}
1509
1510		/* Preformed on Originating SC, SER_ONLY mode */
1511		case CTL_MSG_R2R:
1512			io = msg->hdr.original_sc;
1513			if (io == NULL) {
1514				printf("%s: original_sc == NULL!\n",
1515				    __func__);
1516				break;
1517			}
1518			io->io_hdr.flags |= CTL_FLAG_IO_ACTIVE;
1519			io->io_hdr.msg_type = CTL_MSG_R2R;
1520			io->io_hdr.serializing_sc = msg->hdr.serializing_sc;
1521			ctl_enqueue_isc(io);
1522			break;
1523
1524		/*
1525		 * Performed on Serializing(i.e. primary SC) SC in SER_ONLY
1526		 * mode.
1527		 * Performed on the Originating (i.e. secondary) SC in XFER
1528		 * mode
1529		 */
1530		case CTL_MSG_FINISH_IO:
1531			if (softc->ha_mode == CTL_HA_MODE_XFER)
1532				ctl_isc_handler_finish_xfer(softc, msg);
1533			else
1534				ctl_isc_handler_finish_ser_only(softc, msg);
1535			break;
1536
1537		/* Preformed on Originating SC */
1538		case CTL_MSG_BAD_JUJU:
1539			io = msg->hdr.original_sc;
1540			if (io == NULL) {
1541				printf("%s: Bad JUJU!, original_sc is NULL!\n",
1542				       __func__);
1543				break;
1544			}
1545			ctl_copy_sense_data(msg, io);
1546			/*
1547			 * IO should have already been cleaned up on other
1548			 * SC so clear this flag so we won't send a message
1549			 * back to finish the IO there.
1550			 */
1551			io->io_hdr.flags &= ~CTL_FLAG_SENT_2OTHER_SC;
1552			io->io_hdr.flags |= CTL_FLAG_IO_ACTIVE;
1553
1554			/* io = msg->hdr.serializing_sc; */
1555			io->io_hdr.msg_type = CTL_MSG_BAD_JUJU;
1556			ctl_enqueue_isc(io);
1557			break;
1558
1559		/* Handle resets sent from the other side */
1560		case CTL_MSG_MANAGE_TASKS: {
1561			struct ctl_taskio *taskio;
1562			taskio = (struct ctl_taskio *)ctl_alloc_io(
1563			    softc->othersc_pool);
1564			ctl_zero_io((union ctl_io *)taskio);
1565			taskio->io_hdr.io_type = CTL_IO_TASK;
1566			taskio->io_hdr.flags |= CTL_FLAG_FROM_OTHER_SC;
1567			taskio->io_hdr.nexus = msg->hdr.nexus;
1568			taskio->task_action = msg->task.task_action;
1569			taskio->tag_num = msg->task.tag_num;
1570			taskio->tag_type = msg->task.tag_type;
1571#ifdef CTL_TIME_IO
1572			taskio->io_hdr.start_time = time_uptime;
1573			getbinuptime(&taskio->io_hdr.start_bt);
1574#endif /* CTL_TIME_IO */
1575			ctl_run_task((union ctl_io *)taskio);
1576			break;
1577		}
1578		/* Persistent Reserve action which needs attention */
1579		case CTL_MSG_PERS_ACTION:
1580			presio = (struct ctl_prio *)ctl_alloc_io(
1581			    softc->othersc_pool);
1582			ctl_zero_io((union ctl_io *)presio);
1583			presio->io_hdr.msg_type = CTL_MSG_PERS_ACTION;
1584			presio->io_hdr.flags |= CTL_FLAG_FROM_OTHER_SC;
1585			presio->io_hdr.nexus = msg->hdr.nexus;
1586			presio->pr_msg = msg->pr;
1587			ctl_enqueue_isc((union ctl_io *)presio);
1588			break;
1589		case CTL_MSG_UA:
1590			ctl_isc_ua(softc, msg, param);
1591			break;
1592		case CTL_MSG_PORT_SYNC:
1593			ctl_isc_port_sync(softc, msg, param);
1594			break;
1595		case CTL_MSG_LUN_SYNC:
1596			ctl_isc_lun_sync(softc, msg, param);
1597			break;
1598		case CTL_MSG_IID_SYNC:
1599			ctl_isc_iid_sync(softc, msg, param);
1600			break;
1601		case CTL_MSG_LOGIN:
1602			ctl_isc_login(softc, msg, param);
1603			break;
1604		case CTL_MSG_MODE_SYNC:
1605			ctl_isc_mode_sync(softc, msg, param);
1606			break;
1607		default:
1608			printf("Received HA message of unknown type %d\n",
1609			    msg->hdr.msg_type);
1610			ctl_ha_msg_abort(CTL_HA_CHAN_CTL);
1611			break;
1612		}
1613		if (msg != &msgbuf)
1614			free(msg, M_CTL);
1615	} else if (event == CTL_HA_EVT_LINK_CHANGE) {
1616		printf("CTL: HA link status changed from %d to %d\n",
1617		    softc->ha_link, param);
1618		if (param == softc->ha_link)
1619			return;
1620		if (softc->ha_link == CTL_HA_LINK_ONLINE) {
1621			softc->ha_link = param;
1622			ctl_isc_ha_link_down(softc);
1623		} else {
1624			softc->ha_link = param;
1625			if (softc->ha_link == CTL_HA_LINK_ONLINE)
1626				ctl_isc_ha_link_up(softc);
1627		}
1628		return;
1629	} else {
1630		printf("ctl_isc_event_handler: Unknown event %d\n", event);
1631		return;
1632	}
1633}
1634
1635static void
1636ctl_copy_sense_data(union ctl_ha_msg *src, union ctl_io *dest)
1637{
1638
1639	memcpy(&dest->scsiio.sense_data, &src->scsi.sense_data,
1640	    src->scsi.sense_len);
1641	dest->scsiio.scsi_status = src->scsi.scsi_status;
1642	dest->scsiio.sense_len = src->scsi.sense_len;
1643	dest->io_hdr.status = src->hdr.status;
1644}
1645
1646static void
1647ctl_copy_sense_data_back(union ctl_io *src, union ctl_ha_msg *dest)
1648{
1649
1650	memcpy(&dest->scsi.sense_data, &src->scsiio.sense_data,
1651	    src->scsiio.sense_len);
1652	dest->scsi.scsi_status = src->scsiio.scsi_status;
1653	dest->scsi.sense_len = src->scsiio.sense_len;
1654	dest->hdr.status = src->io_hdr.status;
1655}
1656
1657void
1658ctl_est_ua(struct ctl_lun *lun, uint32_t initidx, ctl_ua_type ua)
1659{
1660	struct ctl_softc *softc = lun->ctl_softc;
1661	ctl_ua_type *pu;
1662
1663	if (initidx < softc->init_min || initidx >= softc->init_max)
1664		return;
1665	mtx_assert(&lun->lun_lock, MA_OWNED);
1666	pu = lun->pending_ua[initidx / CTL_MAX_INIT_PER_PORT];
1667	if (pu == NULL)
1668		return;
1669	pu[initidx % CTL_MAX_INIT_PER_PORT] |= ua;
1670}
1671
1672void
1673ctl_est_ua_port(struct ctl_lun *lun, int port, uint32_t except, ctl_ua_type ua)
1674{
1675	int i;
1676
1677	mtx_assert(&lun->lun_lock, MA_OWNED);
1678	if (lun->pending_ua[port] == NULL)
1679		return;
1680	for (i = 0; i < CTL_MAX_INIT_PER_PORT; i++) {
1681		if (port * CTL_MAX_INIT_PER_PORT + i == except)
1682			continue;
1683		lun->pending_ua[port][i] |= ua;
1684	}
1685}
1686
1687void
1688ctl_est_ua_all(struct ctl_lun *lun, uint32_t except, ctl_ua_type ua)
1689{
1690	struct ctl_softc *softc = lun->ctl_softc;
1691	int i;
1692
1693	mtx_assert(&lun->lun_lock, MA_OWNED);
1694	for (i = softc->port_min; i < softc->port_max; i++)
1695		ctl_est_ua_port(lun, i, except, ua);
1696}
1697
1698void
1699ctl_clr_ua(struct ctl_lun *lun, uint32_t initidx, ctl_ua_type ua)
1700{
1701	struct ctl_softc *softc = lun->ctl_softc;
1702	ctl_ua_type *pu;
1703
1704	if (initidx < softc->init_min || initidx >= softc->init_max)
1705		return;
1706	mtx_assert(&lun->lun_lock, MA_OWNED);
1707	pu = lun->pending_ua[initidx / CTL_MAX_INIT_PER_PORT];
1708	if (pu == NULL)
1709		return;
1710	pu[initidx % CTL_MAX_INIT_PER_PORT] &= ~ua;
1711}
1712
1713void
1714ctl_clr_ua_all(struct ctl_lun *lun, uint32_t except, ctl_ua_type ua)
1715{
1716	struct ctl_softc *softc = lun->ctl_softc;
1717	int i, j;
1718
1719	mtx_assert(&lun->lun_lock, MA_OWNED);
1720	for (i = softc->port_min; i < softc->port_max; i++) {
1721		if (lun->pending_ua[i] == NULL)
1722			continue;
1723		for (j = 0; j < CTL_MAX_INIT_PER_PORT; j++) {
1724			if (i * CTL_MAX_INIT_PER_PORT + j == except)
1725				continue;
1726			lun->pending_ua[i][j] &= ~ua;
1727		}
1728	}
1729}
1730
1731void
1732ctl_clr_ua_allluns(struct ctl_softc *ctl_softc, uint32_t initidx,
1733    ctl_ua_type ua_type)
1734{
1735	struct ctl_lun *lun;
1736
1737	mtx_assert(&ctl_softc->ctl_lock, MA_OWNED);
1738	STAILQ_FOREACH(lun, &ctl_softc->lun_list, links) {
1739		mtx_lock(&lun->lun_lock);
1740		ctl_clr_ua(lun, initidx, ua_type);
1741		mtx_unlock(&lun->lun_lock);
1742	}
1743}
1744
1745static int
1746ctl_ha_role_sysctl(SYSCTL_HANDLER_ARGS)
1747{
1748	struct ctl_softc *softc = (struct ctl_softc *)arg1;
1749	struct ctl_lun *lun;
1750	struct ctl_lun_req ireq;
1751	int error, value;
1752
1753	value = (softc->flags & CTL_FLAG_ACTIVE_SHELF) ? 0 : 1;
1754	error = sysctl_handle_int(oidp, &value, 0, req);
1755	if ((error != 0) || (req->newptr == NULL))
1756		return (error);
1757
1758	mtx_lock(&softc->ctl_lock);
1759	if (value == 0)
1760		softc->flags |= CTL_FLAG_ACTIVE_SHELF;
1761	else
1762		softc->flags &= ~CTL_FLAG_ACTIVE_SHELF;
1763	STAILQ_FOREACH(lun, &softc->lun_list, links) {
1764		mtx_unlock(&softc->ctl_lock);
1765		bzero(&ireq, sizeof(ireq));
1766		ireq.reqtype = CTL_LUNREQ_MODIFY;
1767		ireq.reqdata.modify.lun_id = lun->lun;
1768		lun->backend->ioctl(NULL, CTL_LUN_REQ, (caddr_t)&ireq, 0,
1769		    curthread);
1770		if (ireq.status != CTL_LUN_OK) {
1771			printf("%s: CTL_LUNREQ_MODIFY returned %d '%s'\n",
1772			    __func__, ireq.status, ireq.error_str);
1773		}
1774		mtx_lock(&softc->ctl_lock);
1775	}
1776	mtx_unlock(&softc->ctl_lock);
1777	return (0);
1778}
1779
1780static int
1781ctl_init(void)
1782{
1783	struct ctl_softc *softc;
1784	void *other_pool;
1785	int i, error;
1786
1787	softc = control_softc = malloc(sizeof(*control_softc), M_DEVBUF,
1788			       M_WAITOK | M_ZERO);
1789
1790	softc->dev = make_dev(&ctl_cdevsw, 0, UID_ROOT, GID_OPERATOR, 0600,
1791			      "cam/ctl");
1792	softc->dev->si_drv1 = softc;
1793
1794	sysctl_ctx_init(&softc->sysctl_ctx);
1795	softc->sysctl_tree = SYSCTL_ADD_NODE(&softc->sysctl_ctx,
1796		SYSCTL_STATIC_CHILDREN(_kern_cam), OID_AUTO, "ctl",
1797		CTLFLAG_RD, 0, "CAM Target Layer");
1798
1799	if (softc->sysctl_tree == NULL) {
1800		printf("%s: unable to allocate sysctl tree\n", __func__);
1801		destroy_dev(softc->dev);
1802		free(control_softc, M_DEVBUF);
1803		control_softc = NULL;
1804		return (ENOMEM);
1805	}
1806
1807	mtx_init(&softc->ctl_lock, "CTL mutex", NULL, MTX_DEF);
1808	softc->io_zone = uma_zcreate("CTL IO", sizeof(union ctl_io),
1809	    NULL, NULL, NULL, NULL, UMA_ALIGN_PTR, 0);
1810	softc->flags = 0;
1811
1812	SYSCTL_ADD_INT(&softc->sysctl_ctx, SYSCTL_CHILDREN(softc->sysctl_tree),
1813	    OID_AUTO, "ha_mode", CTLFLAG_RDTUN, (int *)&softc->ha_mode, 0,
1814	    "HA mode (0 - act/stby, 1 - serialize only, 2 - xfer)");
1815
1816	/*
1817	 * In Copan's HA scheme, the "master" and "slave" roles are
1818	 * figured out through the slot the controller is in.  Although it
1819	 * is an active/active system, someone has to be in charge.
1820	 */
1821	SYSCTL_ADD_INT(&softc->sysctl_ctx, SYSCTL_CHILDREN(softc->sysctl_tree),
1822	    OID_AUTO, "ha_id", CTLFLAG_RDTUN, &softc->ha_id, 0,
1823	    "HA head ID (0 - no HA)");
1824	if (softc->ha_id == 0 || softc->ha_id > NUM_HA_SHELVES) {
1825		softc->flags |= CTL_FLAG_ACTIVE_SHELF;
1826		softc->is_single = 1;
1827		softc->port_cnt = CTL_MAX_PORTS;
1828		softc->port_min = 0;
1829	} else {
1830		softc->port_cnt = CTL_MAX_PORTS / NUM_HA_SHELVES;
1831		softc->port_min = (softc->ha_id - 1) * softc->port_cnt;
1832	}
1833	softc->port_max = softc->port_min + softc->port_cnt;
1834	softc->init_min = softc->port_min * CTL_MAX_INIT_PER_PORT;
1835	softc->init_max = softc->port_max * CTL_MAX_INIT_PER_PORT;
1836
1837	SYSCTL_ADD_INT(&softc->sysctl_ctx, SYSCTL_CHILDREN(softc->sysctl_tree),
1838	    OID_AUTO, "ha_link", CTLFLAG_RD, (int *)&softc->ha_link, 0,
1839	    "HA link state (0 - offline, 1 - unknown, 2 - online)");
1840
1841	STAILQ_INIT(&softc->lun_list);
1842	STAILQ_INIT(&softc->pending_lun_queue);
1843	STAILQ_INIT(&softc->fe_list);
1844	STAILQ_INIT(&softc->port_list);
1845	STAILQ_INIT(&softc->be_list);
1846	ctl_tpc_init(softc);
1847
1848	if (ctl_pool_create(softc, "othersc", CTL_POOL_ENTRIES_OTHER_SC,
1849	                    &other_pool) != 0)
1850	{
1851		printf("ctl: can't allocate %d entry other SC pool, "
1852		       "exiting\n", CTL_POOL_ENTRIES_OTHER_SC);
1853		return (ENOMEM);
1854	}
1855	softc->othersc_pool = other_pool;
1856
1857	if (worker_threads <= 0)
1858		worker_threads = max(1, mp_ncpus / 4);
1859	if (worker_threads > CTL_MAX_THREADS)
1860		worker_threads = CTL_MAX_THREADS;
1861
1862	for (i = 0; i < worker_threads; i++) {
1863		struct ctl_thread *thr = &softc->threads[i];
1864
1865		mtx_init(&thr->queue_lock, "CTL queue mutex", NULL, MTX_DEF);
1866		thr->ctl_softc = softc;
1867		STAILQ_INIT(&thr->incoming_queue);
1868		STAILQ_INIT(&thr->rtr_queue);
1869		STAILQ_INIT(&thr->done_queue);
1870		STAILQ_INIT(&thr->isc_queue);
1871
1872		error = kproc_kthread_add(ctl_work_thread, thr,
1873		    &softc->ctl_proc, &thr->thread, 0, 0, "ctl", "work%d", i);
1874		if (error != 0) {
1875			printf("error creating CTL work thread!\n");
1876			ctl_pool_free(other_pool);
1877			return (error);
1878		}
1879	}
1880	error = kproc_kthread_add(ctl_lun_thread, softc,
1881	    &softc->ctl_proc, NULL, 0, 0, "ctl", "lun");
1882	if (error != 0) {
1883		printf("error creating CTL lun thread!\n");
1884		ctl_pool_free(other_pool);
1885		return (error);
1886	}
1887	error = kproc_kthread_add(ctl_thresh_thread, softc,
1888	    &softc->ctl_proc, NULL, 0, 0, "ctl", "thresh");
1889	if (error != 0) {
1890		printf("error creating CTL threshold thread!\n");
1891		ctl_pool_free(other_pool);
1892		return (error);
1893	}
1894
1895	SYSCTL_ADD_PROC(&softc->sysctl_ctx,SYSCTL_CHILDREN(softc->sysctl_tree),
1896	    OID_AUTO, "ha_role", CTLTYPE_INT | CTLFLAG_RWTUN,
1897	    softc, 0, ctl_ha_role_sysctl, "I", "HA role for this head");
1898
1899	if (softc->is_single == 0) {
1900		ctl_frontend_register(&ha_frontend);
1901		if (ctl_ha_msg_init(softc) != CTL_HA_STATUS_SUCCESS) {
1902			printf("ctl_init: ctl_ha_msg_init failed.\n");
1903			softc->is_single = 1;
1904		} else
1905		if (ctl_ha_msg_register(CTL_HA_CHAN_CTL, ctl_isc_event_handler)
1906		    != CTL_HA_STATUS_SUCCESS) {
1907			printf("ctl_init: ctl_ha_msg_register failed.\n");
1908			softc->is_single = 1;
1909		}
1910	}
1911	return (0);
1912}
1913
1914void
1915ctl_shutdown(void)
1916{
1917	struct ctl_softc *softc = control_softc;
1918	struct ctl_lun *lun, *next_lun;
1919
1920	if (softc->is_single == 0) {
1921		ctl_ha_msg_shutdown(softc);
1922		if (ctl_ha_msg_deregister(CTL_HA_CHAN_CTL)
1923		    != CTL_HA_STATUS_SUCCESS)
1924			printf("%s: ctl_ha_msg_deregister failed.\n", __func__);
1925		if (ctl_ha_msg_destroy(softc) != CTL_HA_STATUS_SUCCESS)
1926			printf("%s: ctl_ha_msg_destroy failed.\n", __func__);
1927		ctl_frontend_deregister(&ha_frontend);
1928	}
1929
1930	mtx_lock(&softc->ctl_lock);
1931
1932	STAILQ_FOREACH_SAFE(lun, &softc->lun_list, links, next_lun)
1933		ctl_free_lun(lun);
1934
1935	mtx_unlock(&softc->ctl_lock);
1936
1937#if 0
1938	ctl_shutdown_thread(softc->work_thread);
1939	mtx_destroy(&softc->queue_lock);
1940#endif
1941
1942	ctl_tpc_shutdown(softc);
1943	uma_zdestroy(softc->io_zone);
1944	mtx_destroy(&softc->ctl_lock);
1945
1946	destroy_dev(softc->dev);
1947
1948	sysctl_ctx_free(&softc->sysctl_ctx);
1949
1950	free(control_softc, M_DEVBUF);
1951	control_softc = NULL;
1952}
1953
1954static int
1955ctl_module_event_handler(module_t mod, int what, void *arg)
1956{
1957
1958	switch (what) {
1959	case MOD_LOAD:
1960		return (ctl_init());
1961	case MOD_UNLOAD:
1962		return (EBUSY);
1963	default:
1964		return (EOPNOTSUPP);
1965	}
1966}
1967
1968/*
1969 * XXX KDM should we do some access checks here?  Bump a reference count to
1970 * prevent a CTL module from being unloaded while someone has it open?
1971 */
1972static int
1973ctl_open(struct cdev *dev, int flags, int fmt, struct thread *td)
1974{
1975	return (0);
1976}
1977
1978static int
1979ctl_close(struct cdev *dev, int flags, int fmt, struct thread *td)
1980{
1981	return (0);
1982}
1983
1984/*
1985 * Remove an initiator by port number and initiator ID.
1986 * Returns 0 for success, -1 for failure.
1987 */
1988int
1989ctl_remove_initiator(struct ctl_port *port, int iid)
1990{
1991	struct ctl_softc *softc = port->ctl_softc;
1992
1993	mtx_assert(&softc->ctl_lock, MA_NOTOWNED);
1994
1995	if (iid > CTL_MAX_INIT_PER_PORT) {
1996		printf("%s: initiator ID %u > maximun %u!\n",
1997		       __func__, iid, CTL_MAX_INIT_PER_PORT);
1998		return (-1);
1999	}
2000
2001	mtx_lock(&softc->ctl_lock);
2002	port->wwpn_iid[iid].in_use--;
2003	port->wwpn_iid[iid].last_use = time_uptime;
2004	mtx_unlock(&softc->ctl_lock);
2005	ctl_isc_announce_iid(port, iid);
2006
2007	return (0);
2008}
2009
2010/*
2011 * Add an initiator to the initiator map.
2012 * Returns iid for success, < 0 for failure.
2013 */
2014int
2015ctl_add_initiator(struct ctl_port *port, int iid, uint64_t wwpn, char *name)
2016{
2017	struct ctl_softc *softc = port->ctl_softc;
2018	time_t best_time;
2019	int i, best;
2020
2021	mtx_assert(&softc->ctl_lock, MA_NOTOWNED);
2022
2023	if (iid >= CTL_MAX_INIT_PER_PORT) {
2024		printf("%s: WWPN %#jx initiator ID %u > maximum %u!\n",
2025		       __func__, wwpn, iid, CTL_MAX_INIT_PER_PORT);
2026		free(name, M_CTL);
2027		return (-1);
2028	}
2029
2030	mtx_lock(&softc->ctl_lock);
2031
2032	if (iid < 0 && (wwpn != 0 || name != NULL)) {
2033		for (i = 0; i < CTL_MAX_INIT_PER_PORT; i++) {
2034			if (wwpn != 0 && wwpn == port->wwpn_iid[i].wwpn) {
2035				iid = i;
2036				break;
2037			}
2038			if (name != NULL && port->wwpn_iid[i].name != NULL &&
2039			    strcmp(name, port->wwpn_iid[i].name) == 0) {
2040				iid = i;
2041				break;
2042			}
2043		}
2044	}
2045
2046	if (iid < 0) {
2047		for (i = 0; i < CTL_MAX_INIT_PER_PORT; i++) {
2048			if (port->wwpn_iid[i].in_use == 0 &&
2049			    port->wwpn_iid[i].wwpn == 0 &&
2050			    port->wwpn_iid[i].name == NULL) {
2051				iid = i;
2052				break;
2053			}
2054		}
2055	}
2056
2057	if (iid < 0) {
2058		best = -1;
2059		best_time = INT32_MAX;
2060		for (i = 0; i < CTL_MAX_INIT_PER_PORT; i++) {
2061			if (port->wwpn_iid[i].in_use == 0) {
2062				if (port->wwpn_iid[i].last_use < best_time) {
2063					best = i;
2064					best_time = port->wwpn_iid[i].last_use;
2065				}
2066			}
2067		}
2068		iid = best;
2069	}
2070
2071	if (iid < 0) {
2072		mtx_unlock(&softc->ctl_lock);
2073		free(name, M_CTL);
2074		return (-2);
2075	}
2076
2077	if (port->wwpn_iid[iid].in_use > 0 && (wwpn != 0 || name != NULL)) {
2078		/*
2079		 * This is not an error yet.
2080		 */
2081		if (wwpn != 0 && wwpn == port->wwpn_iid[iid].wwpn) {
2082#if 0
2083			printf("%s: port %d iid %u WWPN %#jx arrived"
2084			    " again\n", __func__, port->targ_port,
2085			    iid, (uintmax_t)wwpn);
2086#endif
2087			goto take;
2088		}
2089		if (name != NULL && port->wwpn_iid[iid].name != NULL &&
2090		    strcmp(name, port->wwpn_iid[iid].name) == 0) {
2091#if 0
2092			printf("%s: port %d iid %u name '%s' arrived"
2093			    " again\n", __func__, port->targ_port,
2094			    iid, name);
2095#endif
2096			goto take;
2097		}
2098
2099		/*
2100		 * This is an error, but what do we do about it?  The
2101		 * driver is telling us we have a new WWPN for this
2102		 * initiator ID, so we pretty much need to use it.
2103		 */
2104		printf("%s: port %d iid %u WWPN %#jx '%s' arrived,"
2105		    " but WWPN %#jx '%s' is still at that address\n",
2106		    __func__, port->targ_port, iid, wwpn, name,
2107		    (uintmax_t)port->wwpn_iid[iid].wwpn,
2108		    port->wwpn_iid[iid].name);
2109
2110		/*
2111		 * XXX KDM clear have_ca and ua_pending on each LUN for
2112		 * this initiator.
2113		 */
2114	}
2115take:
2116	free(port->wwpn_iid[iid].name, M_CTL);
2117	port->wwpn_iid[iid].name = name;
2118	port->wwpn_iid[iid].wwpn = wwpn;
2119	port->wwpn_iid[iid].in_use++;
2120	mtx_unlock(&softc->ctl_lock);
2121	ctl_isc_announce_iid(port, iid);
2122
2123	return (iid);
2124}
2125
2126static int
2127ctl_create_iid(struct ctl_port *port, int iid, uint8_t *buf)
2128{
2129	int len;
2130
2131	switch (port->port_type) {
2132	case CTL_PORT_FC:
2133	{
2134		struct scsi_transportid_fcp *id =
2135		    (struct scsi_transportid_fcp *)buf;
2136		if (port->wwpn_iid[iid].wwpn == 0)
2137			return (0);
2138		memset(id, 0, sizeof(*id));
2139		id->format_protocol = SCSI_PROTO_FC;
2140		scsi_u64to8b(port->wwpn_iid[iid].wwpn, id->n_port_name);
2141		return (sizeof(*id));
2142	}
2143	case CTL_PORT_ISCSI:
2144	{
2145		struct scsi_transportid_iscsi_port *id =
2146		    (struct scsi_transportid_iscsi_port *)buf;
2147		if (port->wwpn_iid[iid].name == NULL)
2148			return (0);
2149		memset(id, 0, 256);
2150		id->format_protocol = SCSI_TRN_ISCSI_FORMAT_PORT |
2151		    SCSI_PROTO_ISCSI;
2152		len = strlcpy(id->iscsi_name, port->wwpn_iid[iid].name, 252) + 1;
2153		len = roundup2(min(len, 252), 4);
2154		scsi_ulto2b(len, id->additional_length);
2155		return (sizeof(*id) + len);
2156	}
2157	case CTL_PORT_SAS:
2158	{
2159		struct scsi_transportid_sas *id =
2160		    (struct scsi_transportid_sas *)buf;
2161		if (port->wwpn_iid[iid].wwpn == 0)
2162			return (0);
2163		memset(id, 0, sizeof(*id));
2164		id->format_protocol = SCSI_PROTO_SAS;
2165		scsi_u64to8b(port->wwpn_iid[iid].wwpn, id->sas_address);
2166		return (sizeof(*id));
2167	}
2168	default:
2169	{
2170		struct scsi_transportid_spi *id =
2171		    (struct scsi_transportid_spi *)buf;
2172		memset(id, 0, sizeof(*id));
2173		id->format_protocol = SCSI_PROTO_SPI;
2174		scsi_ulto2b(iid, id->scsi_addr);
2175		scsi_ulto2b(port->targ_port, id->rel_trgt_port_id);
2176		return (sizeof(*id));
2177	}
2178	}
2179}
2180
2181/*
2182 * Serialize a command that went down the "wrong" side, and so was sent to
2183 * this controller for execution.  The logic is a little different than the
2184 * standard case in ctl_scsiio_precheck().  Errors in this case need to get
2185 * sent back to the other side, but in the success case, we execute the
2186 * command on this side (XFER mode) or tell the other side to execute it
2187 * (SER_ONLY mode).
2188 */
2189static int
2190ctl_serialize_other_sc_cmd(struct ctl_scsiio *ctsio)
2191{
2192	struct ctl_softc *softc = control_softc;
2193	union ctl_ha_msg msg_info;
2194	struct ctl_port *port;
2195	struct ctl_lun *lun;
2196	const struct ctl_cmd_entry *entry;
2197	int retval = 0;
2198	uint32_t targ_lun;
2199
2200	targ_lun = ctsio->io_hdr.nexus.targ_mapped_lun;
2201	mtx_lock(&softc->ctl_lock);
2202
2203	/* Make sure that we know about this port. */
2204	port = ctl_io_port(&ctsio->io_hdr);
2205	if (port == NULL || (port->status & CTL_PORT_STATUS_ONLINE) == 0) {
2206		ctl_set_internal_failure(ctsio, /*sks_valid*/ 0,
2207					 /*retry_count*/ 1);
2208		goto badjuju;
2209	}
2210
2211	/* Make sure that we know about this LUN. */
2212	if ((targ_lun < CTL_MAX_LUNS) &&
2213	    ((lun = softc->ctl_luns[targ_lun]) != NULL)) {
2214		mtx_lock(&lun->lun_lock);
2215		mtx_unlock(&softc->ctl_lock);
2216		/*
2217		 * If the LUN is invalid, pretend that it doesn't exist.
2218		 * It will go away as soon as all pending I/O has been
2219		 * completed.
2220		 */
2221		if (lun->flags & CTL_LUN_DISABLED) {
2222			mtx_unlock(&lun->lun_lock);
2223			lun = NULL;
2224		}
2225	} else {
2226		mtx_unlock(&softc->ctl_lock);
2227		lun = NULL;
2228	}
2229	if (lun == NULL) {
2230		/*
2231		 * The other node would not send this request to us unless
2232		 * received announce that we are primary node for this LUN.
2233		 * If this LUN does not exist now, it is probably result of
2234		 * a race, so respond to initiator in the most opaque way.
2235		 */
2236		ctl_set_busy(ctsio);
2237		goto badjuju;
2238	}
2239
2240	entry = ctl_get_cmd_entry(ctsio, NULL);
2241	if (ctl_scsiio_lun_check(lun, entry, ctsio) != 0) {
2242		mtx_unlock(&lun->lun_lock);
2243		goto badjuju;
2244	}
2245
2246	ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr = lun;
2247	ctsio->io_hdr.ctl_private[CTL_PRIV_BACKEND_LUN].ptr = lun->be_lun;
2248
2249	/*
2250	 * Every I/O goes into the OOA queue for a
2251	 * particular LUN, and stays there until completion.
2252	 */
2253#ifdef CTL_TIME_IO
2254	if (TAILQ_EMPTY(&lun->ooa_queue))
2255		lun->idle_time += getsbinuptime() - lun->last_busy;
2256#endif
2257	TAILQ_INSERT_TAIL(&lun->ooa_queue, &ctsio->io_hdr, ooa_links);
2258
2259	switch (ctl_check_ooa(lun, (union ctl_io *)ctsio,
2260		(union ctl_io *)TAILQ_PREV(&ctsio->io_hdr, ctl_ooaq,
2261		 ooa_links))) {
2262	case CTL_ACTION_BLOCK:
2263		ctsio->io_hdr.flags |= CTL_FLAG_BLOCKED;
2264		TAILQ_INSERT_TAIL(&lun->blocked_queue, &ctsio->io_hdr,
2265				  blocked_links);
2266		mtx_unlock(&lun->lun_lock);
2267		break;
2268	case CTL_ACTION_PASS:
2269	case CTL_ACTION_SKIP:
2270		if (softc->ha_mode == CTL_HA_MODE_XFER) {
2271			ctsio->io_hdr.flags |= CTL_FLAG_IS_WAS_ON_RTR;
2272			ctl_enqueue_rtr((union ctl_io *)ctsio);
2273			mtx_unlock(&lun->lun_lock);
2274		} else {
2275			ctsio->io_hdr.flags &= ~CTL_FLAG_IO_ACTIVE;
2276			mtx_unlock(&lun->lun_lock);
2277
2278			/* send msg back to other side */
2279			msg_info.hdr.original_sc = ctsio->io_hdr.original_sc;
2280			msg_info.hdr.serializing_sc = (union ctl_io *)ctsio;
2281			msg_info.hdr.msg_type = CTL_MSG_R2R;
2282			ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg_info,
2283			    sizeof(msg_info.hdr), M_WAITOK);
2284		}
2285		break;
2286	case CTL_ACTION_OVERLAP:
2287		TAILQ_REMOVE(&lun->ooa_queue, &ctsio->io_hdr, ooa_links);
2288		mtx_unlock(&lun->lun_lock);
2289		ctl_set_overlapped_cmd(ctsio);
2290		goto badjuju;
2291	case CTL_ACTION_OVERLAP_TAG:
2292		TAILQ_REMOVE(&lun->ooa_queue, &ctsio->io_hdr, ooa_links);
2293		mtx_unlock(&lun->lun_lock);
2294		ctl_set_overlapped_tag(ctsio, ctsio->tag_num);
2295		goto badjuju;
2296	case CTL_ACTION_ERROR:
2297	default:
2298		TAILQ_REMOVE(&lun->ooa_queue, &ctsio->io_hdr, ooa_links);
2299		mtx_unlock(&lun->lun_lock);
2300
2301		ctl_set_internal_failure(ctsio, /*sks_valid*/ 0,
2302					 /*retry_count*/ 0);
2303badjuju:
2304		ctl_copy_sense_data_back((union ctl_io *)ctsio, &msg_info);
2305		msg_info.hdr.original_sc = ctsio->io_hdr.original_sc;
2306		msg_info.hdr.serializing_sc = NULL;
2307		msg_info.hdr.msg_type = CTL_MSG_BAD_JUJU;
2308		ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg_info,
2309		    sizeof(msg_info.scsi), M_WAITOK);
2310		retval = 1;
2311		break;
2312	}
2313	return (retval);
2314}
2315
2316/*
2317 * Returns 0 for success, errno for failure.
2318 */
2319static void
2320ctl_ioctl_fill_ooa(struct ctl_lun *lun, uint32_t *cur_fill_num,
2321		   struct ctl_ooa *ooa_hdr, struct ctl_ooa_entry *kern_entries)
2322{
2323	union ctl_io *io;
2324
2325	mtx_lock(&lun->lun_lock);
2326	for (io = (union ctl_io *)TAILQ_FIRST(&lun->ooa_queue); (io != NULL);
2327	     (*cur_fill_num)++, io = (union ctl_io *)TAILQ_NEXT(&io->io_hdr,
2328	     ooa_links)) {
2329		struct ctl_ooa_entry *entry;
2330
2331		/*
2332		 * If we've got more than we can fit, just count the
2333		 * remaining entries.
2334		 */
2335		if (*cur_fill_num >= ooa_hdr->alloc_num)
2336			continue;
2337
2338		entry = &kern_entries[*cur_fill_num];
2339
2340		entry->tag_num = io->scsiio.tag_num;
2341		entry->lun_num = lun->lun;
2342#ifdef CTL_TIME_IO
2343		entry->start_bt = io->io_hdr.start_bt;
2344#endif
2345		bcopy(io->scsiio.cdb, entry->cdb, io->scsiio.cdb_len);
2346		entry->cdb_len = io->scsiio.cdb_len;
2347		if (io->io_hdr.flags & CTL_FLAG_BLOCKED)
2348			entry->cmd_flags |= CTL_OOACMD_FLAG_BLOCKED;
2349
2350		if (io->io_hdr.flags & CTL_FLAG_DMA_INPROG)
2351			entry->cmd_flags |= CTL_OOACMD_FLAG_DMA;
2352
2353		if (io->io_hdr.flags & CTL_FLAG_ABORT)
2354			entry->cmd_flags |= CTL_OOACMD_FLAG_ABORT;
2355
2356		if (io->io_hdr.flags & CTL_FLAG_IS_WAS_ON_RTR)
2357			entry->cmd_flags |= CTL_OOACMD_FLAG_RTR;
2358
2359		if (io->io_hdr.flags & CTL_FLAG_DMA_QUEUED)
2360			entry->cmd_flags |= CTL_OOACMD_FLAG_DMA_QUEUED;
2361	}
2362	mtx_unlock(&lun->lun_lock);
2363}
2364
2365static void *
2366ctl_copyin_alloc(void *user_addr, int len, char *error_str,
2367		 size_t error_str_len)
2368{
2369	void *kptr;
2370
2371	kptr = malloc(len, M_CTL, M_WAITOK | M_ZERO);
2372
2373	if (copyin(user_addr, kptr, len) != 0) {
2374		snprintf(error_str, error_str_len, "Error copying %d bytes "
2375			 "from user address %p to kernel address %p", len,
2376			 user_addr, kptr);
2377		free(kptr, M_CTL);
2378		return (NULL);
2379	}
2380
2381	return (kptr);
2382}
2383
2384static void
2385ctl_free_args(int num_args, struct ctl_be_arg *args)
2386{
2387	int i;
2388
2389	if (args == NULL)
2390		return;
2391
2392	for (i = 0; i < num_args; i++) {
2393		free(args[i].kname, M_CTL);
2394		free(args[i].kvalue, M_CTL);
2395	}
2396
2397	free(args, M_CTL);
2398}
2399
2400static struct ctl_be_arg *
2401ctl_copyin_args(int num_args, struct ctl_be_arg *uargs,
2402		char *error_str, size_t error_str_len)
2403{
2404	struct ctl_be_arg *args;
2405	int i;
2406
2407	args = ctl_copyin_alloc(uargs, num_args * sizeof(*args),
2408				error_str, error_str_len);
2409
2410	if (args == NULL)
2411		goto bailout;
2412
2413	for (i = 0; i < num_args; i++) {
2414		args[i].kname = NULL;
2415		args[i].kvalue = NULL;
2416	}
2417
2418	for (i = 0; i < num_args; i++) {
2419		uint8_t *tmpptr;
2420
2421		args[i].kname = ctl_copyin_alloc(args[i].name,
2422			args[i].namelen, error_str, error_str_len);
2423		if (args[i].kname == NULL)
2424			goto bailout;
2425
2426		if (args[i].kname[args[i].namelen - 1] != '\0') {
2427			snprintf(error_str, error_str_len, "Argument %d "
2428				 "name is not NUL-terminated", i);
2429			goto bailout;
2430		}
2431
2432		if (args[i].flags & CTL_BEARG_RD) {
2433			tmpptr = ctl_copyin_alloc(args[i].value,
2434				args[i].vallen, error_str, error_str_len);
2435			if (tmpptr == NULL)
2436				goto bailout;
2437			if ((args[i].flags & CTL_BEARG_ASCII)
2438			 && (tmpptr[args[i].vallen - 1] != '\0')) {
2439				snprintf(error_str, error_str_len, "Argument "
2440				    "%d value is not NUL-terminated", i);
2441				goto bailout;
2442			}
2443			args[i].kvalue = tmpptr;
2444		} else {
2445			args[i].kvalue = malloc(args[i].vallen,
2446			    M_CTL, M_WAITOK | M_ZERO);
2447		}
2448	}
2449
2450	return (args);
2451bailout:
2452
2453	ctl_free_args(num_args, args);
2454
2455	return (NULL);
2456}
2457
2458static void
2459ctl_copyout_args(int num_args, struct ctl_be_arg *args)
2460{
2461	int i;
2462
2463	for (i = 0; i < num_args; i++) {
2464		if (args[i].flags & CTL_BEARG_WR)
2465			copyout(args[i].kvalue, args[i].value, args[i].vallen);
2466	}
2467}
2468
2469/*
2470 * Escape characters that are illegal or not recommended in XML.
2471 */
2472int
2473ctl_sbuf_printf_esc(struct sbuf *sb, char *str, int size)
2474{
2475	char *end = str + size;
2476	int retval;
2477
2478	retval = 0;
2479
2480	for (; *str && str < end; str++) {
2481		switch (*str) {
2482		case '&':
2483			retval = sbuf_printf(sb, "&amp;");
2484			break;
2485		case '>':
2486			retval = sbuf_printf(sb, "&gt;");
2487			break;
2488		case '<':
2489			retval = sbuf_printf(sb, "&lt;");
2490			break;
2491		default:
2492			retval = sbuf_putc(sb, *str);
2493			break;
2494		}
2495
2496		if (retval != 0)
2497			break;
2498
2499	}
2500
2501	return (retval);
2502}
2503
2504static void
2505ctl_id_sbuf(struct ctl_devid *id, struct sbuf *sb)
2506{
2507	struct scsi_vpd_id_descriptor *desc;
2508	int i;
2509
2510	if (id == NULL || id->len < 4)
2511		return;
2512	desc = (struct scsi_vpd_id_descriptor *)id->data;
2513	switch (desc->id_type & SVPD_ID_TYPE_MASK) {
2514	case SVPD_ID_TYPE_T10:
2515		sbuf_printf(sb, "t10.");
2516		break;
2517	case SVPD_ID_TYPE_EUI64:
2518		sbuf_printf(sb, "eui.");
2519		break;
2520	case SVPD_ID_TYPE_NAA:
2521		sbuf_printf(sb, "naa.");
2522		break;
2523	case SVPD_ID_TYPE_SCSI_NAME:
2524		break;
2525	}
2526	switch (desc->proto_codeset & SVPD_ID_CODESET_MASK) {
2527	case SVPD_ID_CODESET_BINARY:
2528		for (i = 0; i < desc->length; i++)
2529			sbuf_printf(sb, "%02x", desc->identifier[i]);
2530		break;
2531	case SVPD_ID_CODESET_ASCII:
2532		sbuf_printf(sb, "%.*s", (int)desc->length,
2533		    (char *)desc->identifier);
2534		break;
2535	case SVPD_ID_CODESET_UTF8:
2536		sbuf_printf(sb, "%s", (char *)desc->identifier);
2537		break;
2538	}
2539}
2540
2541static int
2542ctl_ioctl(struct cdev *dev, u_long cmd, caddr_t addr, int flag,
2543	  struct thread *td)
2544{
2545	struct ctl_softc *softc = dev->si_drv1;
2546	struct ctl_lun *lun;
2547	int retval;
2548
2549	retval = 0;
2550
2551	switch (cmd) {
2552	case CTL_IO:
2553		retval = ctl_ioctl_io(dev, cmd, addr, flag, td);
2554		break;
2555	case CTL_ENABLE_PORT:
2556	case CTL_DISABLE_PORT:
2557	case CTL_SET_PORT_WWNS: {
2558		struct ctl_port *port;
2559		struct ctl_port_entry *entry;
2560
2561		entry = (struct ctl_port_entry *)addr;
2562
2563		mtx_lock(&softc->ctl_lock);
2564		STAILQ_FOREACH(port, &softc->port_list, links) {
2565			int action, done;
2566
2567			if (port->targ_port < softc->port_min ||
2568			    port->targ_port >= softc->port_max)
2569				continue;
2570
2571			action = 0;
2572			done = 0;
2573			if ((entry->port_type == CTL_PORT_NONE)
2574			 && (entry->targ_port == port->targ_port)) {
2575				/*
2576				 * If the user only wants to enable or
2577				 * disable or set WWNs on a specific port,
2578				 * do the operation and we're done.
2579				 */
2580				action = 1;
2581				done = 1;
2582			} else if (entry->port_type & port->port_type) {
2583				/*
2584				 * Compare the user's type mask with the
2585				 * particular frontend type to see if we
2586				 * have a match.
2587				 */
2588				action = 1;
2589				done = 0;
2590
2591				/*
2592				 * Make sure the user isn't trying to set
2593				 * WWNs on multiple ports at the same time.
2594				 */
2595				if (cmd == CTL_SET_PORT_WWNS) {
2596					printf("%s: Can't set WWNs on "
2597					       "multiple ports\n", __func__);
2598					retval = EINVAL;
2599					break;
2600				}
2601			}
2602			if (action == 0)
2603				continue;
2604
2605			/*
2606			 * XXX KDM we have to drop the lock here, because
2607			 * the online/offline operations can potentially
2608			 * block.  We need to reference count the frontends
2609			 * so they can't go away,
2610			 */
2611			if (cmd == CTL_ENABLE_PORT) {
2612				mtx_unlock(&softc->ctl_lock);
2613				ctl_port_online(port);
2614				mtx_lock(&softc->ctl_lock);
2615			} else if (cmd == CTL_DISABLE_PORT) {
2616				mtx_unlock(&softc->ctl_lock);
2617				ctl_port_offline(port);
2618				mtx_lock(&softc->ctl_lock);
2619			} else if (cmd == CTL_SET_PORT_WWNS) {
2620				ctl_port_set_wwns(port,
2621				    (entry->flags & CTL_PORT_WWNN_VALID) ?
2622				    1 : 0, entry->wwnn,
2623				    (entry->flags & CTL_PORT_WWPN_VALID) ?
2624				    1 : 0, entry->wwpn);
2625			}
2626			if (done != 0)
2627				break;
2628		}
2629		mtx_unlock(&softc->ctl_lock);
2630		break;
2631	}
2632	case CTL_GET_OOA: {
2633		struct ctl_ooa *ooa_hdr;
2634		struct ctl_ooa_entry *entries;
2635		uint32_t cur_fill_num;
2636
2637		ooa_hdr = (struct ctl_ooa *)addr;
2638
2639		if ((ooa_hdr->alloc_len == 0)
2640		 || (ooa_hdr->alloc_num == 0)) {
2641			printf("%s: CTL_GET_OOA: alloc len %u and alloc num %u "
2642			       "must be non-zero\n", __func__,
2643			       ooa_hdr->alloc_len, ooa_hdr->alloc_num);
2644			retval = EINVAL;
2645			break;
2646		}
2647
2648		if (ooa_hdr->alloc_len != (ooa_hdr->alloc_num *
2649		    sizeof(struct ctl_ooa_entry))) {
2650			printf("%s: CTL_GET_OOA: alloc len %u must be alloc "
2651			       "num %d * sizeof(struct ctl_ooa_entry) %zd\n",
2652			       __func__, ooa_hdr->alloc_len,
2653			       ooa_hdr->alloc_num,sizeof(struct ctl_ooa_entry));
2654			retval = EINVAL;
2655			break;
2656		}
2657
2658		entries = malloc(ooa_hdr->alloc_len, M_CTL, M_WAITOK | M_ZERO);
2659		if (entries == NULL) {
2660			printf("%s: could not allocate %d bytes for OOA "
2661			       "dump\n", __func__, ooa_hdr->alloc_len);
2662			retval = ENOMEM;
2663			break;
2664		}
2665
2666		mtx_lock(&softc->ctl_lock);
2667		if (((ooa_hdr->flags & CTL_OOA_FLAG_ALL_LUNS) == 0)
2668		 && ((ooa_hdr->lun_num >= CTL_MAX_LUNS)
2669		  || (softc->ctl_luns[ooa_hdr->lun_num] == NULL))) {
2670			mtx_unlock(&softc->ctl_lock);
2671			free(entries, M_CTL);
2672			printf("%s: CTL_GET_OOA: invalid LUN %ju\n",
2673			       __func__, (uintmax_t)ooa_hdr->lun_num);
2674			retval = EINVAL;
2675			break;
2676		}
2677
2678		cur_fill_num = 0;
2679
2680		if (ooa_hdr->flags & CTL_OOA_FLAG_ALL_LUNS) {
2681			STAILQ_FOREACH(lun, &softc->lun_list, links) {
2682				ctl_ioctl_fill_ooa(lun, &cur_fill_num,
2683				    ooa_hdr, entries);
2684			}
2685		} else {
2686			lun = softc->ctl_luns[ooa_hdr->lun_num];
2687			ctl_ioctl_fill_ooa(lun, &cur_fill_num, ooa_hdr,
2688			    entries);
2689		}
2690		mtx_unlock(&softc->ctl_lock);
2691
2692		ooa_hdr->fill_num = min(cur_fill_num, ooa_hdr->alloc_num);
2693		ooa_hdr->fill_len = ooa_hdr->fill_num *
2694			sizeof(struct ctl_ooa_entry);
2695		retval = copyout(entries, ooa_hdr->entries, ooa_hdr->fill_len);
2696		if (retval != 0) {
2697			printf("%s: error copying out %d bytes for OOA dump\n",
2698			       __func__, ooa_hdr->fill_len);
2699		}
2700
2701		getbinuptime(&ooa_hdr->cur_bt);
2702
2703		if (cur_fill_num > ooa_hdr->alloc_num) {
2704			ooa_hdr->dropped_num = cur_fill_num -ooa_hdr->alloc_num;
2705			ooa_hdr->status = CTL_OOA_NEED_MORE_SPACE;
2706		} else {
2707			ooa_hdr->dropped_num = 0;
2708			ooa_hdr->status = CTL_OOA_OK;
2709		}
2710
2711		free(entries, M_CTL);
2712		break;
2713	}
2714	case CTL_DELAY_IO: {
2715		struct ctl_io_delay_info *delay_info;
2716
2717		delay_info = (struct ctl_io_delay_info *)addr;
2718
2719#ifdef CTL_IO_DELAY
2720		mtx_lock(&softc->ctl_lock);
2721
2722		if ((delay_info->lun_id >= CTL_MAX_LUNS)
2723		 || (softc->ctl_luns[delay_info->lun_id] == NULL)) {
2724			delay_info->status = CTL_DELAY_STATUS_INVALID_LUN;
2725		} else {
2726			lun = softc->ctl_luns[delay_info->lun_id];
2727			mtx_lock(&lun->lun_lock);
2728
2729			delay_info->status = CTL_DELAY_STATUS_OK;
2730
2731			switch (delay_info->delay_type) {
2732			case CTL_DELAY_TYPE_CONT:
2733				break;
2734			case CTL_DELAY_TYPE_ONESHOT:
2735				break;
2736			default:
2737				delay_info->status =
2738					CTL_DELAY_STATUS_INVALID_TYPE;
2739				break;
2740			}
2741
2742			switch (delay_info->delay_loc) {
2743			case CTL_DELAY_LOC_DATAMOVE:
2744				lun->delay_info.datamove_type =
2745					delay_info->delay_type;
2746				lun->delay_info.datamove_delay =
2747					delay_info->delay_secs;
2748				break;
2749			case CTL_DELAY_LOC_DONE:
2750				lun->delay_info.done_type =
2751					delay_info->delay_type;
2752				lun->delay_info.done_delay =
2753					delay_info->delay_secs;
2754				break;
2755			default:
2756				delay_info->status =
2757					CTL_DELAY_STATUS_INVALID_LOC;
2758				break;
2759			}
2760			mtx_unlock(&lun->lun_lock);
2761		}
2762
2763		mtx_unlock(&softc->ctl_lock);
2764#else
2765		delay_info->status = CTL_DELAY_STATUS_NOT_IMPLEMENTED;
2766#endif /* CTL_IO_DELAY */
2767		break;
2768	}
2769	case CTL_GETSTATS: {
2770		struct ctl_stats *stats;
2771		int i;
2772
2773		stats = (struct ctl_stats *)addr;
2774
2775		if ((sizeof(struct ctl_lun_io_stats) * softc->num_luns) >
2776		     stats->alloc_len) {
2777			stats->status = CTL_SS_NEED_MORE_SPACE;
2778			stats->num_luns = softc->num_luns;
2779			break;
2780		}
2781		/*
2782		 * XXX KDM no locking here.  If the LUN list changes,
2783		 * things can blow up.
2784		 */
2785		i = 0;
2786		STAILQ_FOREACH(lun, &softc->lun_list, links) {
2787			retval = copyout(&lun->stats, &stats->lun_stats[i++],
2788					 sizeof(lun->stats));
2789			if (retval != 0)
2790				break;
2791		}
2792		stats->num_luns = softc->num_luns;
2793		stats->fill_len = sizeof(struct ctl_lun_io_stats) *
2794				 softc->num_luns;
2795		stats->status = CTL_SS_OK;
2796#ifdef CTL_TIME_IO
2797		stats->flags = CTL_STATS_FLAG_TIME_VALID;
2798#else
2799		stats->flags = CTL_STATS_FLAG_NONE;
2800#endif
2801		getnanouptime(&stats->timestamp);
2802		break;
2803	}
2804	case CTL_ERROR_INJECT: {
2805		struct ctl_error_desc *err_desc, *new_err_desc;
2806
2807		err_desc = (struct ctl_error_desc *)addr;
2808
2809		new_err_desc = malloc(sizeof(*new_err_desc), M_CTL,
2810				      M_WAITOK | M_ZERO);
2811		bcopy(err_desc, new_err_desc, sizeof(*new_err_desc));
2812
2813		mtx_lock(&softc->ctl_lock);
2814		lun = softc->ctl_luns[err_desc->lun_id];
2815		if (lun == NULL) {
2816			mtx_unlock(&softc->ctl_lock);
2817			free(new_err_desc, M_CTL);
2818			printf("%s: CTL_ERROR_INJECT: invalid LUN %ju\n",
2819			       __func__, (uintmax_t)err_desc->lun_id);
2820			retval = EINVAL;
2821			break;
2822		}
2823		mtx_lock(&lun->lun_lock);
2824		mtx_unlock(&softc->ctl_lock);
2825
2826		/*
2827		 * We could do some checking here to verify the validity
2828		 * of the request, but given the complexity of error
2829		 * injection requests, the checking logic would be fairly
2830		 * complex.
2831		 *
2832		 * For now, if the request is invalid, it just won't get
2833		 * executed and might get deleted.
2834		 */
2835		STAILQ_INSERT_TAIL(&lun->error_list, new_err_desc, links);
2836
2837		/*
2838		 * XXX KDM check to make sure the serial number is unique,
2839		 * in case we somehow manage to wrap.  That shouldn't
2840		 * happen for a very long time, but it's the right thing to
2841		 * do.
2842		 */
2843		new_err_desc->serial = lun->error_serial;
2844		err_desc->serial = lun->error_serial;
2845		lun->error_serial++;
2846
2847		mtx_unlock(&lun->lun_lock);
2848		break;
2849	}
2850	case CTL_ERROR_INJECT_DELETE: {
2851		struct ctl_error_desc *delete_desc, *desc, *desc2;
2852		int delete_done;
2853
2854		delete_desc = (struct ctl_error_desc *)addr;
2855		delete_done = 0;
2856
2857		mtx_lock(&softc->ctl_lock);
2858		lun = softc->ctl_luns[delete_desc->lun_id];
2859		if (lun == NULL) {
2860			mtx_unlock(&softc->ctl_lock);
2861			printf("%s: CTL_ERROR_INJECT_DELETE: invalid LUN %ju\n",
2862			       __func__, (uintmax_t)delete_desc->lun_id);
2863			retval = EINVAL;
2864			break;
2865		}
2866		mtx_lock(&lun->lun_lock);
2867		mtx_unlock(&softc->ctl_lock);
2868		STAILQ_FOREACH_SAFE(desc, &lun->error_list, links, desc2) {
2869			if (desc->serial != delete_desc->serial)
2870				continue;
2871
2872			STAILQ_REMOVE(&lun->error_list, desc, ctl_error_desc,
2873				      links);
2874			free(desc, M_CTL);
2875			delete_done = 1;
2876		}
2877		mtx_unlock(&lun->lun_lock);
2878		if (delete_done == 0) {
2879			printf("%s: CTL_ERROR_INJECT_DELETE: can't find "
2880			       "error serial %ju on LUN %u\n", __func__,
2881			       delete_desc->serial, delete_desc->lun_id);
2882			retval = EINVAL;
2883			break;
2884		}
2885		break;
2886	}
2887	case CTL_DUMP_STRUCTS: {
2888		int i, j, k;
2889		struct ctl_port *port;
2890		struct ctl_frontend *fe;
2891
2892		mtx_lock(&softc->ctl_lock);
2893		printf("CTL Persistent Reservation information start:\n");
2894		for (i = 0; i < CTL_MAX_LUNS; i++) {
2895			lun = softc->ctl_luns[i];
2896
2897			if ((lun == NULL)
2898			 || ((lun->flags & CTL_LUN_DISABLED) != 0))
2899				continue;
2900
2901			for (j = 0; j < CTL_MAX_PORTS; j++) {
2902				if (lun->pr_keys[j] == NULL)
2903					continue;
2904				for (k = 0; k < CTL_MAX_INIT_PER_PORT; k++){
2905					if (lun->pr_keys[j][k] == 0)
2906						continue;
2907					printf("  LUN %d port %d iid %d key "
2908					       "%#jx\n", i, j, k,
2909					       (uintmax_t)lun->pr_keys[j][k]);
2910				}
2911			}
2912		}
2913		printf("CTL Persistent Reservation information end\n");
2914		printf("CTL Ports:\n");
2915		STAILQ_FOREACH(port, &softc->port_list, links) {
2916			printf("  Port %d '%s' Frontend '%s' Type %u pp %d vp %d WWNN "
2917			       "%#jx WWPN %#jx\n", port->targ_port, port->port_name,
2918			       port->frontend->name, port->port_type,
2919			       port->physical_port, port->virtual_port,
2920			       (uintmax_t)port->wwnn, (uintmax_t)port->wwpn);
2921			for (j = 0; j < CTL_MAX_INIT_PER_PORT; j++) {
2922				if (port->wwpn_iid[j].in_use == 0 &&
2923				    port->wwpn_iid[j].wwpn == 0 &&
2924				    port->wwpn_iid[j].name == NULL)
2925					continue;
2926
2927				printf("    iid %u use %d WWPN %#jx '%s'\n",
2928				    j, port->wwpn_iid[j].in_use,
2929				    (uintmax_t)port->wwpn_iid[j].wwpn,
2930				    port->wwpn_iid[j].name);
2931			}
2932		}
2933		printf("CTL Port information end\n");
2934		mtx_unlock(&softc->ctl_lock);
2935		/*
2936		 * XXX KDM calling this without a lock.  We'd likely want
2937		 * to drop the lock before calling the frontend's dump
2938		 * routine anyway.
2939		 */
2940		printf("CTL Frontends:\n");
2941		STAILQ_FOREACH(fe, &softc->fe_list, links) {
2942			printf("  Frontend '%s'\n", fe->name);
2943			if (fe->fe_dump != NULL)
2944				fe->fe_dump();
2945		}
2946		printf("CTL Frontend information end\n");
2947		break;
2948	}
2949	case CTL_LUN_REQ: {
2950		struct ctl_lun_req *lun_req;
2951		struct ctl_backend_driver *backend;
2952
2953		lun_req = (struct ctl_lun_req *)addr;
2954
2955		backend = ctl_backend_find(lun_req->backend);
2956		if (backend == NULL) {
2957			lun_req->status = CTL_LUN_ERROR;
2958			snprintf(lun_req->error_str,
2959				 sizeof(lun_req->error_str),
2960				 "Backend \"%s\" not found.",
2961				 lun_req->backend);
2962			break;
2963		}
2964		if (lun_req->num_be_args > 0) {
2965			lun_req->kern_be_args = ctl_copyin_args(
2966				lun_req->num_be_args,
2967				lun_req->be_args,
2968				lun_req->error_str,
2969				sizeof(lun_req->error_str));
2970			if (lun_req->kern_be_args == NULL) {
2971				lun_req->status = CTL_LUN_ERROR;
2972				break;
2973			}
2974		}
2975
2976		retval = backend->ioctl(dev, cmd, addr, flag, td);
2977
2978		if (lun_req->num_be_args > 0) {
2979			ctl_copyout_args(lun_req->num_be_args,
2980				      lun_req->kern_be_args);
2981			ctl_free_args(lun_req->num_be_args,
2982				      lun_req->kern_be_args);
2983		}
2984		break;
2985	}
2986	case CTL_LUN_LIST: {
2987		struct sbuf *sb;
2988		struct ctl_lun_list *list;
2989		struct ctl_option *opt;
2990
2991		list = (struct ctl_lun_list *)addr;
2992
2993		/*
2994		 * Allocate a fixed length sbuf here, based on the length
2995		 * of the user's buffer.  We could allocate an auto-extending
2996		 * buffer, and then tell the user how much larger our
2997		 * amount of data is than his buffer, but that presents
2998		 * some problems:
2999		 *
3000		 * 1.  The sbuf(9) routines use a blocking malloc, and so
3001		 *     we can't hold a lock while calling them with an
3002		 *     auto-extending buffer.
3003 		 *
3004		 * 2.  There is not currently a LUN reference counting
3005		 *     mechanism, outside of outstanding transactions on
3006		 *     the LUN's OOA queue.  So a LUN could go away on us
3007		 *     while we're getting the LUN number, backend-specific
3008		 *     information, etc.  Thus, given the way things
3009		 *     currently work, we need to hold the CTL lock while
3010		 *     grabbing LUN information.
3011		 *
3012		 * So, from the user's standpoint, the best thing to do is
3013		 * allocate what he thinks is a reasonable buffer length,
3014		 * and then if he gets a CTL_LUN_LIST_NEED_MORE_SPACE error,
3015		 * double the buffer length and try again.  (And repeat
3016		 * that until he succeeds.)
3017		 */
3018		sb = sbuf_new(NULL, NULL, list->alloc_len, SBUF_FIXEDLEN);
3019		if (sb == NULL) {
3020			list->status = CTL_LUN_LIST_ERROR;
3021			snprintf(list->error_str, sizeof(list->error_str),
3022				 "Unable to allocate %d bytes for LUN list",
3023				 list->alloc_len);
3024			break;
3025		}
3026
3027		sbuf_printf(sb, "<ctllunlist>\n");
3028
3029		mtx_lock(&softc->ctl_lock);
3030		STAILQ_FOREACH(lun, &softc->lun_list, links) {
3031			mtx_lock(&lun->lun_lock);
3032			retval = sbuf_printf(sb, "<lun id=\"%ju\">\n",
3033					     (uintmax_t)lun->lun);
3034
3035			/*
3036			 * Bail out as soon as we see that we've overfilled
3037			 * the buffer.
3038			 */
3039			if (retval != 0)
3040				break;
3041
3042			retval = sbuf_printf(sb, "\t<backend_type>%s"
3043					     "</backend_type>\n",
3044					     (lun->backend == NULL) ?  "none" :
3045					     lun->backend->name);
3046
3047			if (retval != 0)
3048				break;
3049
3050			retval = sbuf_printf(sb, "\t<lun_type>%d</lun_type>\n",
3051					     lun->be_lun->lun_type);
3052
3053			if (retval != 0)
3054				break;
3055
3056			if (lun->backend == NULL) {
3057				retval = sbuf_printf(sb, "</lun>\n");
3058				if (retval != 0)
3059					break;
3060				continue;
3061			}
3062
3063			retval = sbuf_printf(sb, "\t<size>%ju</size>\n",
3064					     (lun->be_lun->maxlba > 0) ?
3065					     lun->be_lun->maxlba + 1 : 0);
3066
3067			if (retval != 0)
3068				break;
3069
3070			retval = sbuf_printf(sb, "\t<blocksize>%u</blocksize>\n",
3071					     lun->be_lun->blocksize);
3072
3073			if (retval != 0)
3074				break;
3075
3076			retval = sbuf_printf(sb, "\t<serial_number>");
3077
3078			if (retval != 0)
3079				break;
3080
3081			retval = ctl_sbuf_printf_esc(sb,
3082			    lun->be_lun->serial_num,
3083			    sizeof(lun->be_lun->serial_num));
3084
3085			if (retval != 0)
3086				break;
3087
3088			retval = sbuf_printf(sb, "</serial_number>\n");
3089
3090			if (retval != 0)
3091				break;
3092
3093			retval = sbuf_printf(sb, "\t<device_id>");
3094
3095			if (retval != 0)
3096				break;
3097
3098			retval = ctl_sbuf_printf_esc(sb,
3099			    lun->be_lun->device_id,
3100			    sizeof(lun->be_lun->device_id));
3101
3102			if (retval != 0)
3103				break;
3104
3105			retval = sbuf_printf(sb, "</device_id>\n");
3106
3107			if (retval != 0)
3108				break;
3109
3110			if (lun->backend->lun_info != NULL) {
3111				retval = lun->backend->lun_info(lun->be_lun->be_lun, sb);
3112				if (retval != 0)
3113					break;
3114			}
3115			STAILQ_FOREACH(opt, &lun->be_lun->options, links) {
3116				retval = sbuf_printf(sb, "\t<%s>%s</%s>\n",
3117				    opt->name, opt->value, opt->name);
3118				if (retval != 0)
3119					break;
3120			}
3121
3122			retval = sbuf_printf(sb, "</lun>\n");
3123
3124			if (retval != 0)
3125				break;
3126			mtx_unlock(&lun->lun_lock);
3127		}
3128		if (lun != NULL)
3129			mtx_unlock(&lun->lun_lock);
3130		mtx_unlock(&softc->ctl_lock);
3131
3132		if ((retval != 0)
3133		 || ((retval = sbuf_printf(sb, "</ctllunlist>\n")) != 0)) {
3134			retval = 0;
3135			sbuf_delete(sb);
3136			list->status = CTL_LUN_LIST_NEED_MORE_SPACE;
3137			snprintf(list->error_str, sizeof(list->error_str),
3138				 "Out of space, %d bytes is too small",
3139				 list->alloc_len);
3140			break;
3141		}
3142
3143		sbuf_finish(sb);
3144
3145		retval = copyout(sbuf_data(sb), list->lun_xml,
3146				 sbuf_len(sb) + 1);
3147
3148		list->fill_len = sbuf_len(sb) + 1;
3149		list->status = CTL_LUN_LIST_OK;
3150		sbuf_delete(sb);
3151		break;
3152	}
3153	case CTL_ISCSI: {
3154		struct ctl_iscsi *ci;
3155		struct ctl_frontend *fe;
3156
3157		ci = (struct ctl_iscsi *)addr;
3158
3159		fe = ctl_frontend_find("iscsi");
3160		if (fe == NULL) {
3161			ci->status = CTL_ISCSI_ERROR;
3162			snprintf(ci->error_str, sizeof(ci->error_str),
3163			    "Frontend \"iscsi\" not found.");
3164			break;
3165		}
3166
3167		retval = fe->ioctl(dev, cmd, addr, flag, td);
3168		break;
3169	}
3170	case CTL_PORT_REQ: {
3171		struct ctl_req *req;
3172		struct ctl_frontend *fe;
3173
3174		req = (struct ctl_req *)addr;
3175
3176		fe = ctl_frontend_find(req->driver);
3177		if (fe == NULL) {
3178			req->status = CTL_LUN_ERROR;
3179			snprintf(req->error_str, sizeof(req->error_str),
3180			    "Frontend \"%s\" not found.", req->driver);
3181			break;
3182		}
3183		if (req->num_args > 0) {
3184			req->kern_args = ctl_copyin_args(req->num_args,
3185			    req->args, req->error_str, sizeof(req->error_str));
3186			if (req->kern_args == NULL) {
3187				req->status = CTL_LUN_ERROR;
3188				break;
3189			}
3190		}
3191
3192		if (fe->ioctl)
3193			retval = fe->ioctl(dev, cmd, addr, flag, td);
3194		else
3195			retval = ENODEV;
3196
3197		if (req->num_args > 0) {
3198			ctl_copyout_args(req->num_args, req->kern_args);
3199			ctl_free_args(req->num_args, req->kern_args);
3200		}
3201		break;
3202	}
3203	case CTL_PORT_LIST: {
3204		struct sbuf *sb;
3205		struct ctl_port *port;
3206		struct ctl_lun_list *list;
3207		struct ctl_option *opt;
3208		int j;
3209		uint32_t plun;
3210
3211		list = (struct ctl_lun_list *)addr;
3212
3213		sb = sbuf_new(NULL, NULL, list->alloc_len, SBUF_FIXEDLEN);
3214		if (sb == NULL) {
3215			list->status = CTL_LUN_LIST_ERROR;
3216			snprintf(list->error_str, sizeof(list->error_str),
3217				 "Unable to allocate %d bytes for LUN list",
3218				 list->alloc_len);
3219			break;
3220		}
3221
3222		sbuf_printf(sb, "<ctlportlist>\n");
3223
3224		mtx_lock(&softc->ctl_lock);
3225		STAILQ_FOREACH(port, &softc->port_list, links) {
3226			retval = sbuf_printf(sb, "<targ_port id=\"%ju\">\n",
3227					     (uintmax_t)port->targ_port);
3228
3229			/*
3230			 * Bail out as soon as we see that we've overfilled
3231			 * the buffer.
3232			 */
3233			if (retval != 0)
3234				break;
3235
3236			retval = sbuf_printf(sb, "\t<frontend_type>%s"
3237			    "</frontend_type>\n", port->frontend->name);
3238			if (retval != 0)
3239				break;
3240
3241			retval = sbuf_printf(sb, "\t<port_type>%d</port_type>\n",
3242					     port->port_type);
3243			if (retval != 0)
3244				break;
3245
3246			retval = sbuf_printf(sb, "\t<online>%s</online>\n",
3247			    (port->status & CTL_PORT_STATUS_ONLINE) ? "YES" : "NO");
3248			if (retval != 0)
3249				break;
3250
3251			retval = sbuf_printf(sb, "\t<port_name>%s</port_name>\n",
3252			    port->port_name);
3253			if (retval != 0)
3254				break;
3255
3256			retval = sbuf_printf(sb, "\t<physical_port>%d</physical_port>\n",
3257			    port->physical_port);
3258			if (retval != 0)
3259				break;
3260
3261			retval = sbuf_printf(sb, "\t<virtual_port>%d</virtual_port>\n",
3262			    port->virtual_port);
3263			if (retval != 0)
3264				break;
3265
3266			if (port->target_devid != NULL) {
3267				sbuf_printf(sb, "\t<target>");
3268				ctl_id_sbuf(port->target_devid, sb);
3269				sbuf_printf(sb, "</target>\n");
3270			}
3271
3272			if (port->port_devid != NULL) {
3273				sbuf_printf(sb, "\t<port>");
3274				ctl_id_sbuf(port->port_devid, sb);
3275				sbuf_printf(sb, "</port>\n");
3276			}
3277
3278			if (port->port_info != NULL) {
3279				retval = port->port_info(port->onoff_arg, sb);
3280				if (retval != 0)
3281					break;
3282			}
3283			STAILQ_FOREACH(opt, &port->options, links) {
3284				retval = sbuf_printf(sb, "\t<%s>%s</%s>\n",
3285				    opt->name, opt->value, opt->name);
3286				if (retval != 0)
3287					break;
3288			}
3289
3290			if (port->lun_map != NULL) {
3291				sbuf_printf(sb, "\t<lun_map>on</lun_map>\n");
3292				for (j = 0; j < CTL_MAX_LUNS; j++) {
3293					plun = ctl_lun_map_from_port(port, j);
3294					if (plun >= CTL_MAX_LUNS)
3295						continue;
3296					sbuf_printf(sb,
3297					    "\t<lun id=\"%u\">%u</lun>\n",
3298					    j, plun);
3299				}
3300			}
3301
3302			for (j = 0; j < CTL_MAX_INIT_PER_PORT; j++) {
3303				if (port->wwpn_iid[j].in_use == 0 ||
3304				    (port->wwpn_iid[j].wwpn == 0 &&
3305				     port->wwpn_iid[j].name == NULL))
3306					continue;
3307
3308				if (port->wwpn_iid[j].name != NULL)
3309					retval = sbuf_printf(sb,
3310					    "\t<initiator id=\"%u\">%s</initiator>\n",
3311					    j, port->wwpn_iid[j].name);
3312				else
3313					retval = sbuf_printf(sb,
3314					    "\t<initiator id=\"%u\">naa.%08jx</initiator>\n",
3315					    j, port->wwpn_iid[j].wwpn);
3316				if (retval != 0)
3317					break;
3318			}
3319			if (retval != 0)
3320				break;
3321
3322			retval = sbuf_printf(sb, "</targ_port>\n");
3323			if (retval != 0)
3324				break;
3325		}
3326		mtx_unlock(&softc->ctl_lock);
3327
3328		if ((retval != 0)
3329		 || ((retval = sbuf_printf(sb, "</ctlportlist>\n")) != 0)) {
3330			retval = 0;
3331			sbuf_delete(sb);
3332			list->status = CTL_LUN_LIST_NEED_MORE_SPACE;
3333			snprintf(list->error_str, sizeof(list->error_str),
3334				 "Out of space, %d bytes is too small",
3335				 list->alloc_len);
3336			break;
3337		}
3338
3339		sbuf_finish(sb);
3340
3341		retval = copyout(sbuf_data(sb), list->lun_xml,
3342				 sbuf_len(sb) + 1);
3343
3344		list->fill_len = sbuf_len(sb) + 1;
3345		list->status = CTL_LUN_LIST_OK;
3346		sbuf_delete(sb);
3347		break;
3348	}
3349	case CTL_LUN_MAP: {
3350		struct ctl_lun_map *lm  = (struct ctl_lun_map *)addr;
3351		struct ctl_port *port;
3352
3353		mtx_lock(&softc->ctl_lock);
3354		if (lm->port < softc->port_min ||
3355		    lm->port >= softc->port_max ||
3356		    (port = softc->ctl_ports[lm->port]) == NULL) {
3357			mtx_unlock(&softc->ctl_lock);
3358			return (ENXIO);
3359		}
3360		if (port->status & CTL_PORT_STATUS_ONLINE) {
3361			STAILQ_FOREACH(lun, &softc->lun_list, links) {
3362				if (ctl_lun_map_to_port(port, lun->lun) >=
3363				    CTL_MAX_LUNS)
3364					continue;
3365				mtx_lock(&lun->lun_lock);
3366				ctl_est_ua_port(lun, lm->port, -1,
3367				    CTL_UA_LUN_CHANGE);
3368				mtx_unlock(&lun->lun_lock);
3369			}
3370		}
3371		mtx_unlock(&softc->ctl_lock); // XXX: port_enable sleeps
3372		if (lm->plun < CTL_MAX_LUNS) {
3373			if (lm->lun == UINT32_MAX)
3374				retval = ctl_lun_map_unset(port, lm->plun);
3375			else if (lm->lun < CTL_MAX_LUNS &&
3376			    softc->ctl_luns[lm->lun] != NULL)
3377				retval = ctl_lun_map_set(port, lm->plun, lm->lun);
3378			else
3379				return (ENXIO);
3380		} else if (lm->plun == UINT32_MAX) {
3381			if (lm->lun == UINT32_MAX)
3382				retval = ctl_lun_map_deinit(port);
3383			else
3384				retval = ctl_lun_map_init(port);
3385		} else
3386			return (ENXIO);
3387		if (port->status & CTL_PORT_STATUS_ONLINE)
3388			ctl_isc_announce_port(port);
3389		break;
3390	}
3391	default: {
3392		/* XXX KDM should we fix this? */
3393#if 0
3394		struct ctl_backend_driver *backend;
3395		unsigned int type;
3396		int found;
3397
3398		found = 0;
3399
3400		/*
3401		 * We encode the backend type as the ioctl type for backend
3402		 * ioctls.  So parse it out here, and then search for a
3403		 * backend of this type.
3404		 */
3405		type = _IOC_TYPE(cmd);
3406
3407		STAILQ_FOREACH(backend, &softc->be_list, links) {
3408			if (backend->type == type) {
3409				found = 1;
3410				break;
3411			}
3412		}
3413		if (found == 0) {
3414			printf("ctl: unknown ioctl command %#lx or backend "
3415			       "%d\n", cmd, type);
3416			retval = EINVAL;
3417			break;
3418		}
3419		retval = backend->ioctl(dev, cmd, addr, flag, td);
3420#endif
3421		retval = ENOTTY;
3422		break;
3423	}
3424	}
3425	return (retval);
3426}
3427
3428uint32_t
3429ctl_get_initindex(struct ctl_nexus *nexus)
3430{
3431	return (nexus->initid + (nexus->targ_port * CTL_MAX_INIT_PER_PORT));
3432}
3433
3434int
3435ctl_lun_map_init(struct ctl_port *port)
3436{
3437	struct ctl_softc *softc = port->ctl_softc;
3438	struct ctl_lun *lun;
3439	uint32_t i;
3440
3441	if (port->lun_map == NULL)
3442		port->lun_map = malloc(sizeof(uint32_t) * CTL_MAX_LUNS,
3443		    M_CTL, M_NOWAIT);
3444	if (port->lun_map == NULL)
3445		return (ENOMEM);
3446	for (i = 0; i < CTL_MAX_LUNS; i++)
3447		port->lun_map[i] = UINT32_MAX;
3448	if (port->status & CTL_PORT_STATUS_ONLINE) {
3449		if (port->lun_disable != NULL) {
3450			STAILQ_FOREACH(lun, &softc->lun_list, links)
3451				port->lun_disable(port->targ_lun_arg, lun->lun);
3452		}
3453		ctl_isc_announce_port(port);
3454	}
3455	return (0);
3456}
3457
3458int
3459ctl_lun_map_deinit(struct ctl_port *port)
3460{
3461	struct ctl_softc *softc = port->ctl_softc;
3462	struct ctl_lun *lun;
3463
3464	if (port->lun_map == NULL)
3465		return (0);
3466	free(port->lun_map, M_CTL);
3467	port->lun_map = NULL;
3468	if (port->status & CTL_PORT_STATUS_ONLINE) {
3469		if (port->lun_enable != NULL) {
3470			STAILQ_FOREACH(lun, &softc->lun_list, links)
3471				port->lun_enable(port->targ_lun_arg, lun->lun);
3472		}
3473		ctl_isc_announce_port(port);
3474	}
3475	return (0);
3476}
3477
3478int
3479ctl_lun_map_set(struct ctl_port *port, uint32_t plun, uint32_t glun)
3480{
3481	int status;
3482	uint32_t old;
3483
3484	if (port->lun_map == NULL) {
3485		status = ctl_lun_map_init(port);
3486		if (status != 0)
3487			return (status);
3488	}
3489	old = port->lun_map[plun];
3490	port->lun_map[plun] = glun;
3491	if ((port->status & CTL_PORT_STATUS_ONLINE) && old >= CTL_MAX_LUNS) {
3492		if (port->lun_enable != NULL)
3493			port->lun_enable(port->targ_lun_arg, plun);
3494		ctl_isc_announce_port(port);
3495	}
3496	return (0);
3497}
3498
3499int
3500ctl_lun_map_unset(struct ctl_port *port, uint32_t plun)
3501{
3502	uint32_t old;
3503
3504	if (port->lun_map == NULL)
3505		return (0);
3506	old = port->lun_map[plun];
3507	port->lun_map[plun] = UINT32_MAX;
3508	if ((port->status & CTL_PORT_STATUS_ONLINE) && old < CTL_MAX_LUNS) {
3509		if (port->lun_disable != NULL)
3510			port->lun_disable(port->targ_lun_arg, plun);
3511		ctl_isc_announce_port(port);
3512	}
3513	return (0);
3514}
3515
3516uint32_t
3517ctl_lun_map_from_port(struct ctl_port *port, uint32_t lun_id)
3518{
3519
3520	if (port == NULL)
3521		return (UINT32_MAX);
3522	if (port->lun_map == NULL || lun_id >= CTL_MAX_LUNS)
3523		return (lun_id);
3524	return (port->lun_map[lun_id]);
3525}
3526
3527uint32_t
3528ctl_lun_map_to_port(struct ctl_port *port, uint32_t lun_id)
3529{
3530	uint32_t i;
3531
3532	if (port == NULL)
3533		return (UINT32_MAX);
3534	if (port->lun_map == NULL)
3535		return (lun_id);
3536	for (i = 0; i < CTL_MAX_LUNS; i++) {
3537		if (port->lun_map[i] == lun_id)
3538			return (i);
3539	}
3540	return (UINT32_MAX);
3541}
3542
3543uint32_t
3544ctl_decode_lun(uint64_t encoded)
3545{
3546	uint8_t lun[8];
3547	uint32_t result = 0xffffffff;
3548
3549	be64enc(lun, encoded);
3550	switch (lun[0] & RPL_LUNDATA_ATYP_MASK) {
3551	case RPL_LUNDATA_ATYP_PERIPH:
3552		if ((lun[0] & 0x3f) == 0 && lun[2] == 0 && lun[3] == 0 &&
3553		    lun[4] == 0 && lun[5] == 0 && lun[6] == 0 && lun[7] == 0)
3554			result = lun[1];
3555		break;
3556	case RPL_LUNDATA_ATYP_FLAT:
3557		if (lun[2] == 0 && lun[3] == 0 && lun[4] == 0 && lun[5] == 0 &&
3558		    lun[6] == 0 && lun[7] == 0)
3559			result = ((lun[0] & 0x3f) << 8) + lun[1];
3560		break;
3561	case RPL_LUNDATA_ATYP_EXTLUN:
3562		switch (lun[0] & RPL_LUNDATA_EXT_EAM_MASK) {
3563		case 0x02:
3564			switch (lun[0] & RPL_LUNDATA_EXT_LEN_MASK) {
3565			case 0x00:
3566				result = lun[1];
3567				break;
3568			case 0x10:
3569				result = (lun[1] << 16) + (lun[2] << 8) +
3570				    lun[3];
3571				break;
3572			case 0x20:
3573				if (lun[1] == 0 && lun[6] == 0 && lun[7] == 0)
3574					result = (lun[2] << 24) +
3575					    (lun[3] << 16) + (lun[4] << 8) +
3576					    lun[5];
3577				break;
3578			}
3579			break;
3580		case RPL_LUNDATA_EXT_EAM_NOT_SPEC:
3581			result = 0xffffffff;
3582			break;
3583		}
3584		break;
3585	}
3586	return (result);
3587}
3588
3589uint64_t
3590ctl_encode_lun(uint32_t decoded)
3591{
3592	uint64_t l = decoded;
3593
3594	if (l <= 0xff)
3595		return (((uint64_t)RPL_LUNDATA_ATYP_PERIPH << 56) | (l << 48));
3596	if (l <= 0x3fff)
3597		return (((uint64_t)RPL_LUNDATA_ATYP_FLAT << 56) | (l << 48));
3598	if (l <= 0xffffff)
3599		return (((uint64_t)(RPL_LUNDATA_ATYP_EXTLUN | 0x12) << 56) |
3600		    (l << 32));
3601	return ((((uint64_t)RPL_LUNDATA_ATYP_EXTLUN | 0x22) << 56) | (l << 16));
3602}
3603
3604static struct ctl_port *
3605ctl_io_port(struct ctl_io_hdr *io_hdr)
3606{
3607
3608	return (control_softc->ctl_ports[io_hdr->nexus.targ_port]);
3609}
3610
3611int
3612ctl_ffz(uint32_t *mask, uint32_t first, uint32_t last)
3613{
3614	int i;
3615
3616	for (i = first; i < last; i++) {
3617		if ((mask[i / 32] & (1 << (i % 32))) == 0)
3618			return (i);
3619	}
3620	return (-1);
3621}
3622
3623int
3624ctl_set_mask(uint32_t *mask, uint32_t bit)
3625{
3626	uint32_t chunk, piece;
3627
3628	chunk = bit >> 5;
3629	piece = bit % (sizeof(uint32_t) * 8);
3630
3631	if ((mask[chunk] & (1 << piece)) != 0)
3632		return (-1);
3633	else
3634		mask[chunk] |= (1 << piece);
3635
3636	return (0);
3637}
3638
3639int
3640ctl_clear_mask(uint32_t *mask, uint32_t bit)
3641{
3642	uint32_t chunk, piece;
3643
3644	chunk = bit >> 5;
3645	piece = bit % (sizeof(uint32_t) * 8);
3646
3647	if ((mask[chunk] & (1 << piece)) == 0)
3648		return (-1);
3649	else
3650		mask[chunk] &= ~(1 << piece);
3651
3652	return (0);
3653}
3654
3655int
3656ctl_is_set(uint32_t *mask, uint32_t bit)
3657{
3658	uint32_t chunk, piece;
3659
3660	chunk = bit >> 5;
3661	piece = bit % (sizeof(uint32_t) * 8);
3662
3663	if ((mask[chunk] & (1 << piece)) == 0)
3664		return (0);
3665	else
3666		return (1);
3667}
3668
3669static uint64_t
3670ctl_get_prkey(struct ctl_lun *lun, uint32_t residx)
3671{
3672	uint64_t *t;
3673
3674	t = lun->pr_keys[residx/CTL_MAX_INIT_PER_PORT];
3675	if (t == NULL)
3676		return (0);
3677	return (t[residx % CTL_MAX_INIT_PER_PORT]);
3678}
3679
3680static void
3681ctl_clr_prkey(struct ctl_lun *lun, uint32_t residx)
3682{
3683	uint64_t *t;
3684
3685	t = lun->pr_keys[residx/CTL_MAX_INIT_PER_PORT];
3686	if (t == NULL)
3687		return;
3688	t[residx % CTL_MAX_INIT_PER_PORT] = 0;
3689}
3690
3691static void
3692ctl_alloc_prkey(struct ctl_lun *lun, uint32_t residx)
3693{
3694	uint64_t *p;
3695	u_int i;
3696
3697	i = residx/CTL_MAX_INIT_PER_PORT;
3698	if (lun->pr_keys[i] != NULL)
3699		return;
3700	mtx_unlock(&lun->lun_lock);
3701	p = malloc(sizeof(uint64_t) * CTL_MAX_INIT_PER_PORT, M_CTL,
3702	    M_WAITOK | M_ZERO);
3703	mtx_lock(&lun->lun_lock);
3704	if (lun->pr_keys[i] == NULL)
3705		lun->pr_keys[i] = p;
3706	else
3707		free(p, M_CTL);
3708}
3709
3710static void
3711ctl_set_prkey(struct ctl_lun *lun, uint32_t residx, uint64_t key)
3712{
3713	uint64_t *t;
3714
3715	t = lun->pr_keys[residx/CTL_MAX_INIT_PER_PORT];
3716	KASSERT(t != NULL, ("prkey %d is not allocated", residx));
3717	t[residx % CTL_MAX_INIT_PER_PORT] = key;
3718}
3719
3720/*
3721 * ctl_softc, pool_name, total_ctl_io are passed in.
3722 * npool is passed out.
3723 */
3724int
3725ctl_pool_create(struct ctl_softc *ctl_softc, const char *pool_name,
3726		uint32_t total_ctl_io, void **npool)
3727{
3728#ifdef IO_POOLS
3729	struct ctl_io_pool *pool;
3730
3731	pool = (struct ctl_io_pool *)malloc(sizeof(*pool), M_CTL,
3732					    M_NOWAIT | M_ZERO);
3733	if (pool == NULL)
3734		return (ENOMEM);
3735
3736	snprintf(pool->name, sizeof(pool->name), "CTL IO %s", pool_name);
3737	pool->ctl_softc = ctl_softc;
3738	pool->zone = uma_zsecond_create(pool->name, NULL,
3739	    NULL, NULL, NULL, ctl_softc->io_zone);
3740	/* uma_prealloc(pool->zone, total_ctl_io); */
3741
3742	*npool = pool;
3743#else
3744	*npool = ctl_softc->io_zone;
3745#endif
3746	return (0);
3747}
3748
3749void
3750ctl_pool_free(struct ctl_io_pool *pool)
3751{
3752
3753	if (pool == NULL)
3754		return;
3755
3756#ifdef IO_POOLS
3757	uma_zdestroy(pool->zone);
3758	free(pool, M_CTL);
3759#endif
3760}
3761
3762union ctl_io *
3763ctl_alloc_io(void *pool_ref)
3764{
3765	union ctl_io *io;
3766#ifdef IO_POOLS
3767	struct ctl_io_pool *pool = (struct ctl_io_pool *)pool_ref;
3768
3769	io = uma_zalloc(pool->zone, M_WAITOK);
3770#else
3771	io = uma_zalloc((uma_zone_t)pool_ref, M_WAITOK);
3772#endif
3773	if (io != NULL)
3774		io->io_hdr.pool = pool_ref;
3775	return (io);
3776}
3777
3778union ctl_io *
3779ctl_alloc_io_nowait(void *pool_ref)
3780{
3781	union ctl_io *io;
3782#ifdef IO_POOLS
3783	struct ctl_io_pool *pool = (struct ctl_io_pool *)pool_ref;
3784
3785	io = uma_zalloc(pool->zone, M_NOWAIT);
3786#else
3787	io = uma_zalloc((uma_zone_t)pool_ref, M_NOWAIT);
3788#endif
3789	if (io != NULL)
3790		io->io_hdr.pool = pool_ref;
3791	return (io);
3792}
3793
3794void
3795ctl_free_io(union ctl_io *io)
3796{
3797#ifdef IO_POOLS
3798	struct ctl_io_pool *pool;
3799#endif
3800
3801	if (io == NULL)
3802		return;
3803
3804#ifdef IO_POOLS
3805	pool = (struct ctl_io_pool *)io->io_hdr.pool;
3806	uma_zfree(pool->zone, io);
3807#else
3808	uma_zfree((uma_zone_t)io->io_hdr.pool, io);
3809#endif
3810}
3811
3812void
3813ctl_zero_io(union ctl_io *io)
3814{
3815	void *pool_ref;
3816
3817	if (io == NULL)
3818		return;
3819
3820	/*
3821	 * May need to preserve linked list pointers at some point too.
3822	 */
3823	pool_ref = io->io_hdr.pool;
3824	memset(io, 0, sizeof(*io));
3825	io->io_hdr.pool = pool_ref;
3826}
3827
3828int
3829ctl_expand_number(const char *buf, uint64_t *num)
3830{
3831	char *endptr;
3832	uint64_t number;
3833	unsigned shift;
3834
3835	number = strtoq(buf, &endptr, 0);
3836
3837	switch (tolower((unsigned char)*endptr)) {
3838	case 'e':
3839		shift = 60;
3840		break;
3841	case 'p':
3842		shift = 50;
3843		break;
3844	case 't':
3845		shift = 40;
3846		break;
3847	case 'g':
3848		shift = 30;
3849		break;
3850	case 'm':
3851		shift = 20;
3852		break;
3853	case 'k':
3854		shift = 10;
3855		break;
3856	case 'b':
3857	case '\0': /* No unit. */
3858		*num = number;
3859		return (0);
3860	default:
3861		/* Unrecognized unit. */
3862		return (-1);
3863	}
3864
3865	if ((number << shift) >> shift != number) {
3866		/* Overflow */
3867		return (-1);
3868	}
3869	*num = number << shift;
3870	return (0);
3871}
3872
3873
3874/*
3875 * This routine could be used in the future to load default and/or saved
3876 * mode page parameters for a particuar lun.
3877 */
3878static int
3879ctl_init_page_index(struct ctl_lun *lun)
3880{
3881	int i, page_code;
3882	struct ctl_page_index *page_index;
3883	const char *value;
3884	uint64_t ival;
3885
3886	memcpy(&lun->mode_pages.index, page_index_template,
3887	       sizeof(page_index_template));
3888
3889	for (i = 0; i < CTL_NUM_MODE_PAGES; i++) {
3890
3891		page_index = &lun->mode_pages.index[i];
3892		if (lun->be_lun->lun_type == T_DIRECT &&
3893		    (page_index->page_flags & CTL_PAGE_FLAG_DIRECT) == 0)
3894			continue;
3895		if (lun->be_lun->lun_type == T_PROCESSOR &&
3896		    (page_index->page_flags & CTL_PAGE_FLAG_PROC) == 0)
3897			continue;
3898		if (lun->be_lun->lun_type == T_CDROM &&
3899		    (page_index->page_flags & CTL_PAGE_FLAG_CDROM) == 0)
3900			continue;
3901
3902		page_code = page_index->page_code & SMPH_PC_MASK;
3903		switch (page_code) {
3904		case SMS_RW_ERROR_RECOVERY_PAGE: {
3905			KASSERT(page_index->subpage == SMS_SUBPAGE_PAGE_0,
3906			    ("subpage %#x for page %#x is incorrect!",
3907			    page_index->subpage, page_code));
3908			memcpy(&lun->mode_pages.rw_er_page[CTL_PAGE_CURRENT],
3909			       &rw_er_page_default,
3910			       sizeof(rw_er_page_default));
3911			memcpy(&lun->mode_pages.rw_er_page[CTL_PAGE_CHANGEABLE],
3912			       &rw_er_page_changeable,
3913			       sizeof(rw_er_page_changeable));
3914			memcpy(&lun->mode_pages.rw_er_page[CTL_PAGE_DEFAULT],
3915			       &rw_er_page_default,
3916			       sizeof(rw_er_page_default));
3917			memcpy(&lun->mode_pages.rw_er_page[CTL_PAGE_SAVED],
3918			       &rw_er_page_default,
3919			       sizeof(rw_er_page_default));
3920			page_index->page_data =
3921				(uint8_t *)lun->mode_pages.rw_er_page;
3922			break;
3923		}
3924		case SMS_FORMAT_DEVICE_PAGE: {
3925			struct scsi_format_page *format_page;
3926
3927			KASSERT(page_index->subpage == SMS_SUBPAGE_PAGE_0,
3928			    ("subpage %#x for page %#x is incorrect!",
3929			    page_index->subpage, page_code));
3930
3931			/*
3932			 * Sectors per track are set above.  Bytes per
3933			 * sector need to be set here on a per-LUN basis.
3934			 */
3935			memcpy(&lun->mode_pages.format_page[CTL_PAGE_CURRENT],
3936			       &format_page_default,
3937			       sizeof(format_page_default));
3938			memcpy(&lun->mode_pages.format_page[
3939			       CTL_PAGE_CHANGEABLE], &format_page_changeable,
3940			       sizeof(format_page_changeable));
3941			memcpy(&lun->mode_pages.format_page[CTL_PAGE_DEFAULT],
3942			       &format_page_default,
3943			       sizeof(format_page_default));
3944			memcpy(&lun->mode_pages.format_page[CTL_PAGE_SAVED],
3945			       &format_page_default,
3946			       sizeof(format_page_default));
3947
3948			format_page = &lun->mode_pages.format_page[
3949				CTL_PAGE_CURRENT];
3950			scsi_ulto2b(lun->be_lun->blocksize,
3951				    format_page->bytes_per_sector);
3952
3953			format_page = &lun->mode_pages.format_page[
3954				CTL_PAGE_DEFAULT];
3955			scsi_ulto2b(lun->be_lun->blocksize,
3956				    format_page->bytes_per_sector);
3957
3958			format_page = &lun->mode_pages.format_page[
3959				CTL_PAGE_SAVED];
3960			scsi_ulto2b(lun->be_lun->blocksize,
3961				    format_page->bytes_per_sector);
3962
3963			page_index->page_data =
3964				(uint8_t *)lun->mode_pages.format_page;
3965			break;
3966		}
3967		case SMS_RIGID_DISK_PAGE: {
3968			struct scsi_rigid_disk_page *rigid_disk_page;
3969			uint32_t sectors_per_cylinder;
3970			uint64_t cylinders;
3971#ifndef	__XSCALE__
3972			int shift;
3973#endif /* !__XSCALE__ */
3974
3975			KASSERT(page_index->subpage == SMS_SUBPAGE_PAGE_0,
3976			    ("subpage %#x for page %#x is incorrect!",
3977			    page_index->subpage, page_code));
3978
3979			/*
3980			 * Rotation rate and sectors per track are set
3981			 * above.  We calculate the cylinders here based on
3982			 * capacity.  Due to the number of heads and
3983			 * sectors per track we're using, smaller arrays
3984			 * may turn out to have 0 cylinders.  Linux and
3985			 * FreeBSD don't pay attention to these mode pages
3986			 * to figure out capacity, but Solaris does.  It
3987			 * seems to deal with 0 cylinders just fine, and
3988			 * works out a fake geometry based on the capacity.
3989			 */
3990			memcpy(&lun->mode_pages.rigid_disk_page[
3991			       CTL_PAGE_DEFAULT], &rigid_disk_page_default,
3992			       sizeof(rigid_disk_page_default));
3993			memcpy(&lun->mode_pages.rigid_disk_page[
3994			       CTL_PAGE_CHANGEABLE],&rigid_disk_page_changeable,
3995			       sizeof(rigid_disk_page_changeable));
3996
3997			sectors_per_cylinder = CTL_DEFAULT_SECTORS_PER_TRACK *
3998				CTL_DEFAULT_HEADS;
3999
4000			/*
4001			 * The divide method here will be more accurate,
4002			 * probably, but results in floating point being
4003			 * used in the kernel on i386 (__udivdi3()).  On the
4004			 * XScale, though, __udivdi3() is implemented in
4005			 * software.
4006			 *
4007			 * The shift method for cylinder calculation is
4008			 * accurate if sectors_per_cylinder is a power of
4009			 * 2.  Otherwise it might be slightly off -- you
4010			 * might have a bit of a truncation problem.
4011			 */
4012#ifdef	__XSCALE__
4013			cylinders = (lun->be_lun->maxlba + 1) /
4014				sectors_per_cylinder;
4015#else
4016			for (shift = 31; shift > 0; shift--) {
4017				if (sectors_per_cylinder & (1 << shift))
4018					break;
4019			}
4020			cylinders = (lun->be_lun->maxlba + 1) >> shift;
4021#endif
4022
4023			/*
4024			 * We've basically got 3 bytes, or 24 bits for the
4025			 * cylinder size in the mode page.  If we're over,
4026			 * just round down to 2^24.
4027			 */
4028			if (cylinders > 0xffffff)
4029				cylinders = 0xffffff;
4030
4031			rigid_disk_page = &lun->mode_pages.rigid_disk_page[
4032				CTL_PAGE_DEFAULT];
4033			scsi_ulto3b(cylinders, rigid_disk_page->cylinders);
4034
4035			if ((value = ctl_get_opt(&lun->be_lun->options,
4036			    "rpm")) != NULL) {
4037				scsi_ulto2b(strtol(value, NULL, 0),
4038				     rigid_disk_page->rotation_rate);
4039			}
4040
4041			memcpy(&lun->mode_pages.rigid_disk_page[CTL_PAGE_CURRENT],
4042			       &lun->mode_pages.rigid_disk_page[CTL_PAGE_DEFAULT],
4043			       sizeof(rigid_disk_page_default));
4044			memcpy(&lun->mode_pages.rigid_disk_page[CTL_PAGE_SAVED],
4045			       &lun->mode_pages.rigid_disk_page[CTL_PAGE_DEFAULT],
4046			       sizeof(rigid_disk_page_default));
4047
4048			page_index->page_data =
4049				(uint8_t *)lun->mode_pages.rigid_disk_page;
4050			break;
4051		}
4052		case SMS_CACHING_PAGE: {
4053			struct scsi_caching_page *caching_page;
4054
4055			KASSERT(page_index->subpage == SMS_SUBPAGE_PAGE_0,
4056			    ("subpage %#x for page %#x is incorrect!",
4057			    page_index->subpage, page_code));
4058			memcpy(&lun->mode_pages.caching_page[CTL_PAGE_DEFAULT],
4059			       &caching_page_default,
4060			       sizeof(caching_page_default));
4061			memcpy(&lun->mode_pages.caching_page[
4062			       CTL_PAGE_CHANGEABLE], &caching_page_changeable,
4063			       sizeof(caching_page_changeable));
4064			memcpy(&lun->mode_pages.caching_page[CTL_PAGE_SAVED],
4065			       &caching_page_default,
4066			       sizeof(caching_page_default));
4067			caching_page = &lun->mode_pages.caching_page[
4068			    CTL_PAGE_SAVED];
4069			value = ctl_get_opt(&lun->be_lun->options, "writecache");
4070			if (value != NULL && strcmp(value, "off") == 0)
4071				caching_page->flags1 &= ~SCP_WCE;
4072			value = ctl_get_opt(&lun->be_lun->options, "readcache");
4073			if (value != NULL && strcmp(value, "off") == 0)
4074				caching_page->flags1 |= SCP_RCD;
4075			memcpy(&lun->mode_pages.caching_page[CTL_PAGE_CURRENT],
4076			       &lun->mode_pages.caching_page[CTL_PAGE_SAVED],
4077			       sizeof(caching_page_default));
4078			page_index->page_data =
4079				(uint8_t *)lun->mode_pages.caching_page;
4080			break;
4081		}
4082		case SMS_CONTROL_MODE_PAGE: {
4083			switch (page_index->subpage) {
4084			case SMS_SUBPAGE_PAGE_0: {
4085				struct scsi_control_page *control_page;
4086
4087				memcpy(&lun->mode_pages.control_page[
4088				    CTL_PAGE_DEFAULT],
4089				       &control_page_default,
4090				       sizeof(control_page_default));
4091				memcpy(&lun->mode_pages.control_page[
4092				    CTL_PAGE_CHANGEABLE],
4093				       &control_page_changeable,
4094				       sizeof(control_page_changeable));
4095				memcpy(&lun->mode_pages.control_page[
4096				    CTL_PAGE_SAVED],
4097				       &control_page_default,
4098				       sizeof(control_page_default));
4099				control_page = &lun->mode_pages.control_page[
4100				    CTL_PAGE_SAVED];
4101				value = ctl_get_opt(&lun->be_lun->options,
4102				    "reordering");
4103				if (value != NULL &&
4104				    strcmp(value, "unrestricted") == 0) {
4105					control_page->queue_flags &=
4106					    ~SCP_QUEUE_ALG_MASK;
4107					control_page->queue_flags |=
4108					    SCP_QUEUE_ALG_UNRESTRICTED;
4109				}
4110				memcpy(&lun->mode_pages.control_page[
4111				    CTL_PAGE_CURRENT],
4112				       &lun->mode_pages.control_page[
4113				    CTL_PAGE_SAVED],
4114				       sizeof(control_page_default));
4115				page_index->page_data =
4116				    (uint8_t *)lun->mode_pages.control_page;
4117				break;
4118			}
4119			case 0x01:
4120				memcpy(&lun->mode_pages.control_ext_page[
4121				    CTL_PAGE_DEFAULT],
4122				       &control_ext_page_default,
4123				       sizeof(control_ext_page_default));
4124				memcpy(&lun->mode_pages.control_ext_page[
4125				    CTL_PAGE_CHANGEABLE],
4126				       &control_ext_page_changeable,
4127				       sizeof(control_ext_page_changeable));
4128				memcpy(&lun->mode_pages.control_ext_page[
4129				    CTL_PAGE_SAVED],
4130				       &control_ext_page_default,
4131				       sizeof(control_ext_page_default));
4132				memcpy(&lun->mode_pages.control_ext_page[
4133				    CTL_PAGE_CURRENT],
4134				       &lun->mode_pages.control_ext_page[
4135				    CTL_PAGE_SAVED],
4136				       sizeof(control_ext_page_default));
4137				page_index->page_data =
4138				    (uint8_t *)lun->mode_pages.control_ext_page;
4139				break;
4140			default:
4141				panic("subpage %#x for page %#x is incorrect!",
4142				      page_index->subpage, page_code);
4143			}
4144			break;
4145		}
4146		case SMS_INFO_EXCEPTIONS_PAGE: {
4147			switch (page_index->subpage) {
4148			case SMS_SUBPAGE_PAGE_0:
4149				memcpy(&lun->mode_pages.ie_page[CTL_PAGE_CURRENT],
4150				       &ie_page_default,
4151				       sizeof(ie_page_default));
4152				memcpy(&lun->mode_pages.ie_page[
4153				       CTL_PAGE_CHANGEABLE], &ie_page_changeable,
4154				       sizeof(ie_page_changeable));
4155				memcpy(&lun->mode_pages.ie_page[CTL_PAGE_DEFAULT],
4156				       &ie_page_default,
4157				       sizeof(ie_page_default));
4158				memcpy(&lun->mode_pages.ie_page[CTL_PAGE_SAVED],
4159				       &ie_page_default,
4160				       sizeof(ie_page_default));
4161				page_index->page_data =
4162					(uint8_t *)lun->mode_pages.ie_page;
4163				break;
4164			case 0x02: {
4165				struct ctl_logical_block_provisioning_page *page;
4166
4167				memcpy(&lun->mode_pages.lbp_page[CTL_PAGE_DEFAULT],
4168				       &lbp_page_default,
4169				       sizeof(lbp_page_default));
4170				memcpy(&lun->mode_pages.lbp_page[
4171				       CTL_PAGE_CHANGEABLE], &lbp_page_changeable,
4172				       sizeof(lbp_page_changeable));
4173				memcpy(&lun->mode_pages.lbp_page[CTL_PAGE_SAVED],
4174				       &lbp_page_default,
4175				       sizeof(lbp_page_default));
4176				page = &lun->mode_pages.lbp_page[CTL_PAGE_SAVED];
4177				value = ctl_get_opt(&lun->be_lun->options,
4178				    "avail-threshold");
4179				if (value != NULL &&
4180				    ctl_expand_number(value, &ival) == 0) {
4181					page->descr[0].flags |= SLBPPD_ENABLED |
4182					    SLBPPD_ARMING_DEC;
4183					if (lun->be_lun->blocksize)
4184						ival /= lun->be_lun->blocksize;
4185					else
4186						ival /= 512;
4187					scsi_ulto4b(ival >> CTL_LBP_EXPONENT,
4188					    page->descr[0].count);
4189				}
4190				value = ctl_get_opt(&lun->be_lun->options,
4191				    "used-threshold");
4192				if (value != NULL &&
4193				    ctl_expand_number(value, &ival) == 0) {
4194					page->descr[1].flags |= SLBPPD_ENABLED |
4195					    SLBPPD_ARMING_INC;
4196					if (lun->be_lun->blocksize)
4197						ival /= lun->be_lun->blocksize;
4198					else
4199						ival /= 512;
4200					scsi_ulto4b(ival >> CTL_LBP_EXPONENT,
4201					    page->descr[1].count);
4202				}
4203				value = ctl_get_opt(&lun->be_lun->options,
4204				    "pool-avail-threshold");
4205				if (value != NULL &&
4206				    ctl_expand_number(value, &ival) == 0) {
4207					page->descr[2].flags |= SLBPPD_ENABLED |
4208					    SLBPPD_ARMING_DEC;
4209					if (lun->be_lun->blocksize)
4210						ival /= lun->be_lun->blocksize;
4211					else
4212						ival /= 512;
4213					scsi_ulto4b(ival >> CTL_LBP_EXPONENT,
4214					    page->descr[2].count);
4215				}
4216				value = ctl_get_opt(&lun->be_lun->options,
4217				    "pool-used-threshold");
4218				if (value != NULL &&
4219				    ctl_expand_number(value, &ival) == 0) {
4220					page->descr[3].flags |= SLBPPD_ENABLED |
4221					    SLBPPD_ARMING_INC;
4222					if (lun->be_lun->blocksize)
4223						ival /= lun->be_lun->blocksize;
4224					else
4225						ival /= 512;
4226					scsi_ulto4b(ival >> CTL_LBP_EXPONENT,
4227					    page->descr[3].count);
4228				}
4229				memcpy(&lun->mode_pages.lbp_page[CTL_PAGE_CURRENT],
4230				       &lun->mode_pages.lbp_page[CTL_PAGE_SAVED],
4231				       sizeof(lbp_page_default));
4232				page_index->page_data =
4233					(uint8_t *)lun->mode_pages.lbp_page;
4234				break;
4235			}
4236			default:
4237				panic("subpage %#x for page %#x is incorrect!",
4238				      page_index->subpage, page_code);
4239			}
4240			break;
4241		}
4242		case SMS_CDDVD_CAPS_PAGE:{
4243			KASSERT(page_index->subpage == SMS_SUBPAGE_PAGE_0,
4244			    ("subpage %#x for page %#x is incorrect!",
4245			    page_index->subpage, page_code));
4246			memcpy(&lun->mode_pages.cddvd_page[CTL_PAGE_DEFAULT],
4247			       &cddvd_page_default,
4248			       sizeof(cddvd_page_default));
4249			memcpy(&lun->mode_pages.cddvd_page[
4250			       CTL_PAGE_CHANGEABLE], &cddvd_page_changeable,
4251			       sizeof(cddvd_page_changeable));
4252			memcpy(&lun->mode_pages.cddvd_page[CTL_PAGE_SAVED],
4253			       &cddvd_page_default,
4254			       sizeof(cddvd_page_default));
4255			memcpy(&lun->mode_pages.cddvd_page[CTL_PAGE_CURRENT],
4256			       &lun->mode_pages.cddvd_page[CTL_PAGE_SAVED],
4257			       sizeof(cddvd_page_default));
4258			page_index->page_data =
4259				(uint8_t *)lun->mode_pages.cddvd_page;
4260			break;
4261		}
4262		case SMS_VENDOR_SPECIFIC_PAGE:{
4263			switch (page_index->subpage) {
4264			case DBGCNF_SUBPAGE_CODE: {
4265				memcpy(&lun->mode_pages.debugconf_subpage[
4266				       CTL_PAGE_CURRENT],
4267				       &debugconf_page_default,
4268				       sizeof(debugconf_page_default));
4269				memcpy(&lun->mode_pages.debugconf_subpage[
4270				       CTL_PAGE_CHANGEABLE],
4271				       &debugconf_page_changeable,
4272				       sizeof(debugconf_page_changeable));
4273				memcpy(&lun->mode_pages.debugconf_subpage[
4274				       CTL_PAGE_DEFAULT],
4275				       &debugconf_page_default,
4276				       sizeof(debugconf_page_default));
4277				memcpy(&lun->mode_pages.debugconf_subpage[
4278				       CTL_PAGE_SAVED],
4279				       &debugconf_page_default,
4280				       sizeof(debugconf_page_default));
4281				page_index->page_data =
4282				    (uint8_t *)lun->mode_pages.debugconf_subpage;
4283				break;
4284			}
4285			default:
4286				panic("subpage %#x for page %#x is incorrect!",
4287				      page_index->subpage, page_code);
4288			}
4289			break;
4290		}
4291		default:
4292			panic("invalid page code value %#x", page_code);
4293		}
4294	}
4295
4296	return (CTL_RETVAL_COMPLETE);
4297}
4298
4299static int
4300ctl_init_log_page_index(struct ctl_lun *lun)
4301{
4302	struct ctl_page_index *page_index;
4303	int i, j, k, prev;
4304
4305	memcpy(&lun->log_pages.index, log_page_index_template,
4306	       sizeof(log_page_index_template));
4307
4308	prev = -1;
4309	for (i = 0, j = 0, k = 0; i < CTL_NUM_LOG_PAGES; i++) {
4310
4311		page_index = &lun->log_pages.index[i];
4312		if (lun->be_lun->lun_type == T_DIRECT &&
4313		    (page_index->page_flags & CTL_PAGE_FLAG_DIRECT) == 0)
4314			continue;
4315		if (lun->be_lun->lun_type == T_PROCESSOR &&
4316		    (page_index->page_flags & CTL_PAGE_FLAG_PROC) == 0)
4317			continue;
4318		if (lun->be_lun->lun_type == T_CDROM &&
4319		    (page_index->page_flags & CTL_PAGE_FLAG_CDROM) == 0)
4320			continue;
4321
4322		if (page_index->page_code == SLS_LOGICAL_BLOCK_PROVISIONING &&
4323		    lun->backend->lun_attr == NULL)
4324			continue;
4325
4326		if (page_index->page_code != prev) {
4327			lun->log_pages.pages_page[j] = page_index->page_code;
4328			prev = page_index->page_code;
4329			j++;
4330		}
4331		lun->log_pages.subpages_page[k*2] = page_index->page_code;
4332		lun->log_pages.subpages_page[k*2+1] = page_index->subpage;
4333		k++;
4334	}
4335	lun->log_pages.index[0].page_data = &lun->log_pages.pages_page[0];
4336	lun->log_pages.index[0].page_len = j;
4337	lun->log_pages.index[1].page_data = &lun->log_pages.subpages_page[0];
4338	lun->log_pages.index[1].page_len = k * 2;
4339	lun->log_pages.index[2].page_data = &lun->log_pages.lbp_page[0];
4340	lun->log_pages.index[2].page_len = 12*CTL_NUM_LBP_PARAMS;
4341	lun->log_pages.index[3].page_data = (uint8_t *)&lun->log_pages.stat_page;
4342	lun->log_pages.index[3].page_len = sizeof(lun->log_pages.stat_page);
4343
4344	return (CTL_RETVAL_COMPLETE);
4345}
4346
4347static int
4348hex2bin(const char *str, uint8_t *buf, int buf_size)
4349{
4350	int i;
4351	u_char c;
4352
4353	memset(buf, 0, buf_size);
4354	while (isspace(str[0]))
4355		str++;
4356	if (str[0] == '0' && (str[1] == 'x' || str[1] == 'X'))
4357		str += 2;
4358	buf_size *= 2;
4359	for (i = 0; str[i] != 0 && i < buf_size; i++) {
4360		c = str[i];
4361		if (isdigit(c))
4362			c -= '0';
4363		else if (isalpha(c))
4364			c -= isupper(c) ? 'A' - 10 : 'a' - 10;
4365		else
4366			break;
4367		if (c >= 16)
4368			break;
4369		if ((i & 1) == 0)
4370			buf[i / 2] |= (c << 4);
4371		else
4372			buf[i / 2] |= c;
4373	}
4374	return ((i + 1) / 2);
4375}
4376
4377/*
4378 * LUN allocation.
4379 *
4380 * Requirements:
4381 * - caller allocates and zeros LUN storage, or passes in a NULL LUN if he
4382 *   wants us to allocate the LUN and he can block.
4383 * - ctl_softc is always set
4384 * - be_lun is set if the LUN has a backend (needed for disk LUNs)
4385 *
4386 * Returns 0 for success, non-zero (errno) for failure.
4387 */
4388static int
4389ctl_alloc_lun(struct ctl_softc *ctl_softc, struct ctl_lun *ctl_lun,
4390	      struct ctl_be_lun *const be_lun)
4391{
4392	struct ctl_lun *nlun, *lun;
4393	struct scsi_vpd_id_descriptor *desc;
4394	struct scsi_vpd_id_t10 *t10id;
4395	const char *eui, *naa, *scsiname, *vendor, *value;
4396	int lun_number, i, lun_malloced;
4397	int devidlen, idlen1, idlen2 = 0, len;
4398
4399	if (be_lun == NULL)
4400		return (EINVAL);
4401
4402	/*
4403	 * We currently only support Direct Access or Processor LUN types.
4404	 */
4405	switch (be_lun->lun_type) {
4406	case T_DIRECT:
4407	case T_PROCESSOR:
4408	case T_CDROM:
4409		break;
4410	case T_SEQUENTIAL:
4411	case T_CHANGER:
4412	default:
4413		be_lun->lun_config_status(be_lun->be_lun,
4414					  CTL_LUN_CONFIG_FAILURE);
4415		break;
4416	}
4417	if (ctl_lun == NULL) {
4418		lun = malloc(sizeof(*lun), M_CTL, M_WAITOK);
4419		lun_malloced = 1;
4420	} else {
4421		lun_malloced = 0;
4422		lun = ctl_lun;
4423	}
4424
4425	memset(lun, 0, sizeof(*lun));
4426	if (lun_malloced)
4427		lun->flags = CTL_LUN_MALLOCED;
4428
4429	/* Generate LUN ID. */
4430	devidlen = max(CTL_DEVID_MIN_LEN,
4431	    strnlen(be_lun->device_id, CTL_DEVID_LEN));
4432	idlen1 = sizeof(*t10id) + devidlen;
4433	len = sizeof(struct scsi_vpd_id_descriptor) + idlen1;
4434	scsiname = ctl_get_opt(&be_lun->options, "scsiname");
4435	if (scsiname != NULL) {
4436		idlen2 = roundup2(strlen(scsiname) + 1, 4);
4437		len += sizeof(struct scsi_vpd_id_descriptor) + idlen2;
4438	}
4439	eui = ctl_get_opt(&be_lun->options, "eui");
4440	if (eui != NULL) {
4441		len += sizeof(struct scsi_vpd_id_descriptor) + 16;
4442	}
4443	naa = ctl_get_opt(&be_lun->options, "naa");
4444	if (naa != NULL) {
4445		len += sizeof(struct scsi_vpd_id_descriptor) + 16;
4446	}
4447	lun->lun_devid = malloc(sizeof(struct ctl_devid) + len,
4448	    M_CTL, M_WAITOK | M_ZERO);
4449	desc = (struct scsi_vpd_id_descriptor *)lun->lun_devid->data;
4450	desc->proto_codeset = SVPD_ID_CODESET_ASCII;
4451	desc->id_type = SVPD_ID_PIV | SVPD_ID_ASSOC_LUN | SVPD_ID_TYPE_T10;
4452	desc->length = idlen1;
4453	t10id = (struct scsi_vpd_id_t10 *)&desc->identifier[0];
4454	memset(t10id->vendor, ' ', sizeof(t10id->vendor));
4455	if ((vendor = ctl_get_opt(&be_lun->options, "vendor")) == NULL) {
4456		strncpy((char *)t10id->vendor, CTL_VENDOR, sizeof(t10id->vendor));
4457	} else {
4458		strncpy(t10id->vendor, vendor,
4459		    min(sizeof(t10id->vendor), strlen(vendor)));
4460	}
4461	strncpy((char *)t10id->vendor_spec_id,
4462	    (char *)be_lun->device_id, devidlen);
4463	if (scsiname != NULL) {
4464		desc = (struct scsi_vpd_id_descriptor *)(&desc->identifier[0] +
4465		    desc->length);
4466		desc->proto_codeset = SVPD_ID_CODESET_UTF8;
4467		desc->id_type = SVPD_ID_PIV | SVPD_ID_ASSOC_LUN |
4468		    SVPD_ID_TYPE_SCSI_NAME;
4469		desc->length = idlen2;
4470		strlcpy(desc->identifier, scsiname, idlen2);
4471	}
4472	if (eui != NULL) {
4473		desc = (struct scsi_vpd_id_descriptor *)(&desc->identifier[0] +
4474		    desc->length);
4475		desc->proto_codeset = SVPD_ID_CODESET_BINARY;
4476		desc->id_type = SVPD_ID_PIV | SVPD_ID_ASSOC_LUN |
4477		    SVPD_ID_TYPE_EUI64;
4478		desc->length = hex2bin(eui, desc->identifier, 16);
4479		desc->length = desc->length > 12 ? 16 :
4480		    (desc->length > 8 ? 12 : 8);
4481		len -= 16 - desc->length;
4482	}
4483	if (naa != NULL) {
4484		desc = (struct scsi_vpd_id_descriptor *)(&desc->identifier[0] +
4485		    desc->length);
4486		desc->proto_codeset = SVPD_ID_CODESET_BINARY;
4487		desc->id_type = SVPD_ID_PIV | SVPD_ID_ASSOC_LUN |
4488		    SVPD_ID_TYPE_NAA;
4489		desc->length = hex2bin(naa, desc->identifier, 16);
4490		desc->length = desc->length > 8 ? 16 : 8;
4491		len -= 16 - desc->length;
4492	}
4493	lun->lun_devid->len = len;
4494
4495	mtx_lock(&ctl_softc->ctl_lock);
4496	/*
4497	 * See if the caller requested a particular LUN number.  If so, see
4498	 * if it is available.  Otherwise, allocate the first available LUN.
4499	 */
4500	if (be_lun->flags & CTL_LUN_FLAG_ID_REQ) {
4501		if ((be_lun->req_lun_id > (CTL_MAX_LUNS - 1))
4502		 || (ctl_is_set(ctl_softc->ctl_lun_mask, be_lun->req_lun_id))) {
4503			mtx_unlock(&ctl_softc->ctl_lock);
4504			if (be_lun->req_lun_id > (CTL_MAX_LUNS - 1)) {
4505				printf("ctl: requested LUN ID %d is higher "
4506				       "than CTL_MAX_LUNS - 1 (%d)\n",
4507				       be_lun->req_lun_id, CTL_MAX_LUNS - 1);
4508			} else {
4509				/*
4510				 * XXX KDM return an error, or just assign
4511				 * another LUN ID in this case??
4512				 */
4513				printf("ctl: requested LUN ID %d is already "
4514				       "in use\n", be_lun->req_lun_id);
4515			}
4516			if (lun->flags & CTL_LUN_MALLOCED)
4517				free(lun, M_CTL);
4518			be_lun->lun_config_status(be_lun->be_lun,
4519						  CTL_LUN_CONFIG_FAILURE);
4520			return (ENOSPC);
4521		}
4522		lun_number = be_lun->req_lun_id;
4523	} else {
4524		lun_number = ctl_ffz(ctl_softc->ctl_lun_mask, 0, CTL_MAX_LUNS);
4525		if (lun_number == -1) {
4526			mtx_unlock(&ctl_softc->ctl_lock);
4527			printf("ctl: can't allocate LUN, out of LUNs\n");
4528			if (lun->flags & CTL_LUN_MALLOCED)
4529				free(lun, M_CTL);
4530			be_lun->lun_config_status(be_lun->be_lun,
4531						  CTL_LUN_CONFIG_FAILURE);
4532			return (ENOSPC);
4533		}
4534	}
4535	ctl_set_mask(ctl_softc->ctl_lun_mask, lun_number);
4536
4537	mtx_init(&lun->lun_lock, "CTL LUN", NULL, MTX_DEF);
4538	lun->lun = lun_number;
4539	lun->be_lun = be_lun;
4540	/*
4541	 * The processor LUN is always enabled.  Disk LUNs come on line
4542	 * disabled, and must be enabled by the backend.
4543	 */
4544	lun->flags |= CTL_LUN_DISABLED;
4545	lun->backend = be_lun->be;
4546	be_lun->ctl_lun = lun;
4547	be_lun->lun_id = lun_number;
4548	atomic_add_int(&be_lun->be->num_luns, 1);
4549	if (be_lun->flags & CTL_LUN_FLAG_EJECTED)
4550		lun->flags |= CTL_LUN_EJECTED;
4551	if (be_lun->flags & CTL_LUN_FLAG_NO_MEDIA)
4552		lun->flags |= CTL_LUN_NO_MEDIA;
4553	if (be_lun->flags & CTL_LUN_FLAG_STOPPED)
4554		lun->flags |= CTL_LUN_STOPPED;
4555
4556	if (be_lun->flags & CTL_LUN_FLAG_PRIMARY)
4557		lun->flags |= CTL_LUN_PRIMARY_SC;
4558
4559	value = ctl_get_opt(&be_lun->options, "removable");
4560	if (value != NULL) {
4561		if (strcmp(value, "on") == 0)
4562			lun->flags |= CTL_LUN_REMOVABLE;
4563	} else if (be_lun->lun_type == T_CDROM)
4564		lun->flags |= CTL_LUN_REMOVABLE;
4565
4566	lun->ctl_softc = ctl_softc;
4567#ifdef CTL_TIME_IO
4568	lun->last_busy = getsbinuptime();
4569#endif
4570	TAILQ_INIT(&lun->ooa_queue);
4571	TAILQ_INIT(&lun->blocked_queue);
4572	STAILQ_INIT(&lun->error_list);
4573	ctl_tpc_lun_init(lun);
4574
4575	/*
4576	 * Initialize the mode and log page index.
4577	 */
4578	ctl_init_page_index(lun);
4579	ctl_init_log_page_index(lun);
4580
4581	/*
4582	 * Now, before we insert this lun on the lun list, set the lun
4583	 * inventory changed UA for all other luns.
4584	 */
4585	STAILQ_FOREACH(nlun, &ctl_softc->lun_list, links) {
4586		mtx_lock(&nlun->lun_lock);
4587		ctl_est_ua_all(nlun, -1, CTL_UA_LUN_CHANGE);
4588		mtx_unlock(&nlun->lun_lock);
4589	}
4590
4591	STAILQ_INSERT_TAIL(&ctl_softc->lun_list, lun, links);
4592
4593	ctl_softc->ctl_luns[lun_number] = lun;
4594
4595	ctl_softc->num_luns++;
4596
4597	/* Setup statistics gathering */
4598	lun->stats.device_type = be_lun->lun_type;
4599	lun->stats.lun_number = lun_number;
4600	lun->stats.blocksize = be_lun->blocksize;
4601	if (be_lun->blocksize == 0)
4602		lun->stats.flags = CTL_LUN_STATS_NO_BLOCKSIZE;
4603	for (i = 0;i < CTL_MAX_PORTS;i++)
4604		lun->stats.ports[i].targ_port = i;
4605
4606	mtx_unlock(&ctl_softc->ctl_lock);
4607
4608	lun->be_lun->lun_config_status(lun->be_lun->be_lun, CTL_LUN_CONFIG_OK);
4609	return (0);
4610}
4611
4612/*
4613 * Delete a LUN.
4614 * Assumptions:
4615 * - LUN has already been marked invalid and any pending I/O has been taken
4616 *   care of.
4617 */
4618static int
4619ctl_free_lun(struct ctl_lun *lun)
4620{
4621	struct ctl_softc *softc;
4622	struct ctl_lun *nlun;
4623	int i;
4624
4625	softc = lun->ctl_softc;
4626
4627	mtx_assert(&softc->ctl_lock, MA_OWNED);
4628
4629	STAILQ_REMOVE(&softc->lun_list, lun, ctl_lun, links);
4630
4631	ctl_clear_mask(softc->ctl_lun_mask, lun->lun);
4632
4633	softc->ctl_luns[lun->lun] = NULL;
4634
4635	if (!TAILQ_EMPTY(&lun->ooa_queue))
4636		panic("Freeing a LUN %p with outstanding I/O!!\n", lun);
4637
4638	softc->num_luns--;
4639
4640	/*
4641	 * Tell the backend to free resources, if this LUN has a backend.
4642	 */
4643	atomic_subtract_int(&lun->be_lun->be->num_luns, 1);
4644	lun->be_lun->lun_shutdown(lun->be_lun->be_lun);
4645
4646	ctl_tpc_lun_shutdown(lun);
4647	mtx_destroy(&lun->lun_lock);
4648	free(lun->lun_devid, M_CTL);
4649	for (i = 0; i < CTL_MAX_PORTS; i++)
4650		free(lun->pending_ua[i], M_CTL);
4651	for (i = 0; i < CTL_MAX_PORTS; i++)
4652		free(lun->pr_keys[i], M_CTL);
4653	free(lun->write_buffer, M_CTL);
4654	if (lun->flags & CTL_LUN_MALLOCED)
4655		free(lun, M_CTL);
4656
4657	STAILQ_FOREACH(nlun, &softc->lun_list, links) {
4658		mtx_lock(&nlun->lun_lock);
4659		ctl_est_ua_all(nlun, -1, CTL_UA_LUN_CHANGE);
4660		mtx_unlock(&nlun->lun_lock);
4661	}
4662
4663	return (0);
4664}
4665
4666static void
4667ctl_create_lun(struct ctl_be_lun *be_lun)
4668{
4669
4670	/*
4671	 * ctl_alloc_lun() should handle all potential failure cases.
4672	 */
4673	ctl_alloc_lun(control_softc, NULL, be_lun);
4674}
4675
4676int
4677ctl_add_lun(struct ctl_be_lun *be_lun)
4678{
4679	struct ctl_softc *softc = control_softc;
4680
4681	mtx_lock(&softc->ctl_lock);
4682	STAILQ_INSERT_TAIL(&softc->pending_lun_queue, be_lun, links);
4683	mtx_unlock(&softc->ctl_lock);
4684	wakeup(&softc->pending_lun_queue);
4685
4686	return (0);
4687}
4688
4689int
4690ctl_enable_lun(struct ctl_be_lun *be_lun)
4691{
4692	struct ctl_softc *softc;
4693	struct ctl_port *port, *nport;
4694	struct ctl_lun *lun;
4695	int retval;
4696
4697	lun = (struct ctl_lun *)be_lun->ctl_lun;
4698	softc = lun->ctl_softc;
4699
4700	mtx_lock(&softc->ctl_lock);
4701	mtx_lock(&lun->lun_lock);
4702	if ((lun->flags & CTL_LUN_DISABLED) == 0) {
4703		/*
4704		 * eh?  Why did we get called if the LUN is already
4705		 * enabled?
4706		 */
4707		mtx_unlock(&lun->lun_lock);
4708		mtx_unlock(&softc->ctl_lock);
4709		return (0);
4710	}
4711	lun->flags &= ~CTL_LUN_DISABLED;
4712	mtx_unlock(&lun->lun_lock);
4713
4714	STAILQ_FOREACH_SAFE(port, &softc->port_list, links, nport) {
4715		if ((port->status & CTL_PORT_STATUS_ONLINE) == 0 ||
4716		    port->lun_map != NULL || port->lun_enable == NULL)
4717			continue;
4718
4719		/*
4720		 * Drop the lock while we call the FETD's enable routine.
4721		 * This can lead to a callback into CTL (at least in the
4722		 * case of the internal initiator frontend.
4723		 */
4724		mtx_unlock(&softc->ctl_lock);
4725		retval = port->lun_enable(port->targ_lun_arg, lun->lun);
4726		mtx_lock(&softc->ctl_lock);
4727		if (retval != 0) {
4728			printf("%s: FETD %s port %d returned error "
4729			       "%d for lun_enable on lun %jd\n",
4730			       __func__, port->port_name, port->targ_port,
4731			       retval, (intmax_t)lun->lun);
4732		}
4733	}
4734
4735	mtx_unlock(&softc->ctl_lock);
4736	ctl_isc_announce_lun(lun);
4737
4738	return (0);
4739}
4740
4741int
4742ctl_disable_lun(struct ctl_be_lun *be_lun)
4743{
4744	struct ctl_softc *softc;
4745	struct ctl_port *port;
4746	struct ctl_lun *lun;
4747	int retval;
4748
4749	lun = (struct ctl_lun *)be_lun->ctl_lun;
4750	softc = lun->ctl_softc;
4751
4752	mtx_lock(&softc->ctl_lock);
4753	mtx_lock(&lun->lun_lock);
4754	if (lun->flags & CTL_LUN_DISABLED) {
4755		mtx_unlock(&lun->lun_lock);
4756		mtx_unlock(&softc->ctl_lock);
4757		return (0);
4758	}
4759	lun->flags |= CTL_LUN_DISABLED;
4760	mtx_unlock(&lun->lun_lock);
4761
4762	STAILQ_FOREACH(port, &softc->port_list, links) {
4763		if ((port->status & CTL_PORT_STATUS_ONLINE) == 0 ||
4764		    port->lun_map != NULL || port->lun_disable == NULL)
4765			continue;
4766
4767		/*
4768		 * Drop the lock before we call the frontend's disable
4769		 * routine, to avoid lock order reversals.
4770		 *
4771		 * XXX KDM what happens if the frontend list changes while
4772		 * we're traversing it?  It's unlikely, but should be handled.
4773		 */
4774		mtx_unlock(&softc->ctl_lock);
4775		retval = port->lun_disable(port->targ_lun_arg, lun->lun);
4776		mtx_lock(&softc->ctl_lock);
4777		if (retval != 0) {
4778			printf("%s: FETD %s port %d returned error "
4779			       "%d for lun_disable on lun %jd\n",
4780			       __func__, port->port_name, port->targ_port,
4781			       retval, (intmax_t)lun->lun);
4782		}
4783	}
4784
4785	mtx_unlock(&softc->ctl_lock);
4786	ctl_isc_announce_lun(lun);
4787
4788	return (0);
4789}
4790
4791int
4792ctl_start_lun(struct ctl_be_lun *be_lun)
4793{
4794	struct ctl_lun *lun = (struct ctl_lun *)be_lun->ctl_lun;
4795
4796	mtx_lock(&lun->lun_lock);
4797	lun->flags &= ~CTL_LUN_STOPPED;
4798	mtx_unlock(&lun->lun_lock);
4799	return (0);
4800}
4801
4802int
4803ctl_stop_lun(struct ctl_be_lun *be_lun)
4804{
4805	struct ctl_lun *lun = (struct ctl_lun *)be_lun->ctl_lun;
4806
4807	mtx_lock(&lun->lun_lock);
4808	lun->flags |= CTL_LUN_STOPPED;
4809	mtx_unlock(&lun->lun_lock);
4810	return (0);
4811}
4812
4813int
4814ctl_lun_no_media(struct ctl_be_lun *be_lun)
4815{
4816	struct ctl_lun *lun = (struct ctl_lun *)be_lun->ctl_lun;
4817
4818	mtx_lock(&lun->lun_lock);
4819	lun->flags |= CTL_LUN_NO_MEDIA;
4820	mtx_unlock(&lun->lun_lock);
4821	return (0);
4822}
4823
4824int
4825ctl_lun_has_media(struct ctl_be_lun *be_lun)
4826{
4827	struct ctl_lun *lun = (struct ctl_lun *)be_lun->ctl_lun;
4828	union ctl_ha_msg msg;
4829
4830	mtx_lock(&lun->lun_lock);
4831	lun->flags &= ~(CTL_LUN_NO_MEDIA | CTL_LUN_EJECTED);
4832	if (lun->flags & CTL_LUN_REMOVABLE)
4833		ctl_est_ua_all(lun, -1, CTL_UA_MEDIUM_CHANGE);
4834	mtx_unlock(&lun->lun_lock);
4835	if ((lun->flags & CTL_LUN_REMOVABLE) &&
4836	    lun->ctl_softc->ha_mode == CTL_HA_MODE_XFER) {
4837		bzero(&msg.ua, sizeof(msg.ua));
4838		msg.hdr.msg_type = CTL_MSG_UA;
4839		msg.hdr.nexus.initid = -1;
4840		msg.hdr.nexus.targ_port = -1;
4841		msg.hdr.nexus.targ_lun = lun->lun;
4842		msg.hdr.nexus.targ_mapped_lun = lun->lun;
4843		msg.ua.ua_all = 1;
4844		msg.ua.ua_set = 1;
4845		msg.ua.ua_type = CTL_UA_MEDIUM_CHANGE;
4846		ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg, sizeof(msg.ua),
4847		    M_WAITOK);
4848	}
4849	return (0);
4850}
4851
4852int
4853ctl_lun_ejected(struct ctl_be_lun *be_lun)
4854{
4855	struct ctl_lun *lun = (struct ctl_lun *)be_lun->ctl_lun;
4856
4857	mtx_lock(&lun->lun_lock);
4858	lun->flags |= CTL_LUN_EJECTED;
4859	mtx_unlock(&lun->lun_lock);
4860	return (0);
4861}
4862
4863int
4864ctl_lun_primary(struct ctl_be_lun *be_lun)
4865{
4866	struct ctl_lun *lun = (struct ctl_lun *)be_lun->ctl_lun;
4867
4868	mtx_lock(&lun->lun_lock);
4869	lun->flags |= CTL_LUN_PRIMARY_SC;
4870	ctl_est_ua_all(lun, -1, CTL_UA_ASYM_ACC_CHANGE);
4871	mtx_unlock(&lun->lun_lock);
4872	ctl_isc_announce_lun(lun);
4873	return (0);
4874}
4875
4876int
4877ctl_lun_secondary(struct ctl_be_lun *be_lun)
4878{
4879	struct ctl_lun *lun = (struct ctl_lun *)be_lun->ctl_lun;
4880
4881	mtx_lock(&lun->lun_lock);
4882	lun->flags &= ~CTL_LUN_PRIMARY_SC;
4883	ctl_est_ua_all(lun, -1, CTL_UA_ASYM_ACC_CHANGE);
4884	mtx_unlock(&lun->lun_lock);
4885	ctl_isc_announce_lun(lun);
4886	return (0);
4887}
4888
4889int
4890ctl_invalidate_lun(struct ctl_be_lun *be_lun)
4891{
4892	struct ctl_softc *softc;
4893	struct ctl_lun *lun;
4894
4895	lun = (struct ctl_lun *)be_lun->ctl_lun;
4896	softc = lun->ctl_softc;
4897
4898	mtx_lock(&lun->lun_lock);
4899
4900	/*
4901	 * The LUN needs to be disabled before it can be marked invalid.
4902	 */
4903	if ((lun->flags & CTL_LUN_DISABLED) == 0) {
4904		mtx_unlock(&lun->lun_lock);
4905		return (-1);
4906	}
4907	/*
4908	 * Mark the LUN invalid.
4909	 */
4910	lun->flags |= CTL_LUN_INVALID;
4911
4912	/*
4913	 * If there is nothing in the OOA queue, go ahead and free the LUN.
4914	 * If we have something in the OOA queue, we'll free it when the
4915	 * last I/O completes.
4916	 */
4917	if (TAILQ_EMPTY(&lun->ooa_queue)) {
4918		mtx_unlock(&lun->lun_lock);
4919		mtx_lock(&softc->ctl_lock);
4920		ctl_free_lun(lun);
4921		mtx_unlock(&softc->ctl_lock);
4922	} else
4923		mtx_unlock(&lun->lun_lock);
4924
4925	return (0);
4926}
4927
4928void
4929ctl_lun_capacity_changed(struct ctl_be_lun *be_lun)
4930{
4931	struct ctl_lun *lun = (struct ctl_lun *)be_lun->ctl_lun;
4932	union ctl_ha_msg msg;
4933
4934	mtx_lock(&lun->lun_lock);
4935	ctl_est_ua_all(lun, -1, CTL_UA_CAPACITY_CHANGE);
4936	mtx_unlock(&lun->lun_lock);
4937	if (lun->ctl_softc->ha_mode == CTL_HA_MODE_XFER) {
4938		/* Send msg to other side. */
4939		bzero(&msg.ua, sizeof(msg.ua));
4940		msg.hdr.msg_type = CTL_MSG_UA;
4941		msg.hdr.nexus.initid = -1;
4942		msg.hdr.nexus.targ_port = -1;
4943		msg.hdr.nexus.targ_lun = lun->lun;
4944		msg.hdr.nexus.targ_mapped_lun = lun->lun;
4945		msg.ua.ua_all = 1;
4946		msg.ua.ua_set = 1;
4947		msg.ua.ua_type = CTL_UA_CAPACITY_CHANGE;
4948		ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg, sizeof(msg.ua),
4949		    M_WAITOK);
4950	}
4951}
4952
4953/*
4954 * Backend "memory move is complete" callback for requests that never
4955 * make it down to say RAIDCore's configuration code.
4956 */
4957int
4958ctl_config_move_done(union ctl_io *io)
4959{
4960	int retval;
4961
4962	CTL_DEBUG_PRINT(("ctl_config_move_done\n"));
4963	KASSERT(io->io_hdr.io_type == CTL_IO_SCSI,
4964	    ("Config I/O type isn't CTL_IO_SCSI (%d)!", io->io_hdr.io_type));
4965
4966	if ((io->io_hdr.port_status != 0) &&
4967	    ((io->io_hdr.status & CTL_STATUS_MASK) == CTL_STATUS_NONE ||
4968	     (io->io_hdr.status & CTL_STATUS_MASK) == CTL_SUCCESS)) {
4969		/*
4970		 * For hardware error sense keys, the sense key
4971		 * specific value is defined to be a retry count,
4972		 * but we use it to pass back an internal FETD
4973		 * error code.  XXX KDM  Hopefully the FETD is only
4974		 * using 16 bits for an error code, since that's
4975		 * all the space we have in the sks field.
4976		 */
4977		ctl_set_internal_failure(&io->scsiio,
4978					 /*sks_valid*/ 1,
4979					 /*retry_count*/
4980					 io->io_hdr.port_status);
4981	}
4982
4983	if (ctl_debug & CTL_DEBUG_CDB_DATA)
4984		ctl_data_print(io);
4985	if (((io->io_hdr.flags & CTL_FLAG_DATA_MASK) == CTL_FLAG_DATA_IN) ||
4986	    ((io->io_hdr.status & CTL_STATUS_MASK) != CTL_STATUS_NONE &&
4987	     (io->io_hdr.status & CTL_STATUS_MASK) != CTL_SUCCESS) ||
4988	    ((io->io_hdr.flags & CTL_FLAG_ABORT) != 0)) {
4989		/*
4990		 * XXX KDM just assuming a single pointer here, and not a
4991		 * S/G list.  If we start using S/G lists for config data,
4992		 * we'll need to know how to clean them up here as well.
4993		 */
4994		if (io->io_hdr.flags & CTL_FLAG_ALLOCATED)
4995			free(io->scsiio.kern_data_ptr, M_CTL);
4996		ctl_done(io);
4997		retval = CTL_RETVAL_COMPLETE;
4998	} else {
4999		/*
5000		 * XXX KDM now we need to continue data movement.  Some
5001		 * options:
5002		 * - call ctl_scsiio() again?  We don't do this for data
5003		 *   writes, because for those at least we know ahead of
5004		 *   time where the write will go and how long it is.  For
5005		 *   config writes, though, that information is largely
5006		 *   contained within the write itself, thus we need to
5007		 *   parse out the data again.
5008		 *
5009		 * - Call some other function once the data is in?
5010		 */
5011
5012		/*
5013		 * XXX KDM call ctl_scsiio() again for now, and check flag
5014		 * bits to see whether we're allocated or not.
5015		 */
5016		retval = ctl_scsiio(&io->scsiio);
5017	}
5018	return (retval);
5019}
5020
5021/*
5022 * This gets called by a backend driver when it is done with a
5023 * data_submit method.
5024 */
5025void
5026ctl_data_submit_done(union ctl_io *io)
5027{
5028	/*
5029	 * If the IO_CONT flag is set, we need to call the supplied
5030	 * function to continue processing the I/O, instead of completing
5031	 * the I/O just yet.
5032	 *
5033	 * If there is an error, though, we don't want to keep processing.
5034	 * Instead, just send status back to the initiator.
5035	 */
5036	if ((io->io_hdr.flags & CTL_FLAG_IO_CONT) &&
5037	    (io->io_hdr.flags & CTL_FLAG_ABORT) == 0 &&
5038	    ((io->io_hdr.status & CTL_STATUS_MASK) == CTL_STATUS_NONE ||
5039	     (io->io_hdr.status & CTL_STATUS_MASK) == CTL_SUCCESS)) {
5040		io->scsiio.io_cont(io);
5041		return;
5042	}
5043	ctl_done(io);
5044}
5045
5046/*
5047 * This gets called by a backend driver when it is done with a
5048 * configuration write.
5049 */
5050void
5051ctl_config_write_done(union ctl_io *io)
5052{
5053	uint8_t *buf;
5054
5055	/*
5056	 * If the IO_CONT flag is set, we need to call the supplied
5057	 * function to continue processing the I/O, instead of completing
5058	 * the I/O just yet.
5059	 *
5060	 * If there is an error, though, we don't want to keep processing.
5061	 * Instead, just send status back to the initiator.
5062	 */
5063	if ((io->io_hdr.flags & CTL_FLAG_IO_CONT) &&
5064	    (io->io_hdr.flags & CTL_FLAG_ABORT) == 0 &&
5065	    ((io->io_hdr.status & CTL_STATUS_MASK) == CTL_STATUS_NONE ||
5066	     (io->io_hdr.status & CTL_STATUS_MASK) == CTL_SUCCESS)) {
5067		io->scsiio.io_cont(io);
5068		return;
5069	}
5070	/*
5071	 * Since a configuration write can be done for commands that actually
5072	 * have data allocated, like write buffer, and commands that have
5073	 * no data, like start/stop unit, we need to check here.
5074	 */
5075	if (io->io_hdr.flags & CTL_FLAG_ALLOCATED)
5076		buf = io->scsiio.kern_data_ptr;
5077	else
5078		buf = NULL;
5079	ctl_done(io);
5080	if (buf)
5081		free(buf, M_CTL);
5082}
5083
5084void
5085ctl_config_read_done(union ctl_io *io)
5086{
5087	uint8_t *buf;
5088
5089	/*
5090	 * If there is some error -- we are done, skip data transfer.
5091	 */
5092	if ((io->io_hdr.flags & CTL_FLAG_ABORT) != 0 ||
5093	    ((io->io_hdr.status & CTL_STATUS_MASK) != CTL_STATUS_NONE &&
5094	     (io->io_hdr.status & CTL_STATUS_MASK) != CTL_SUCCESS)) {
5095		if (io->io_hdr.flags & CTL_FLAG_ALLOCATED)
5096			buf = io->scsiio.kern_data_ptr;
5097		else
5098			buf = NULL;
5099		ctl_done(io);
5100		if (buf)
5101			free(buf, M_CTL);
5102		return;
5103	}
5104
5105	/*
5106	 * If the IO_CONT flag is set, we need to call the supplied
5107	 * function to continue processing the I/O, instead of completing
5108	 * the I/O just yet.
5109	 */
5110	if (io->io_hdr.flags & CTL_FLAG_IO_CONT) {
5111		io->scsiio.io_cont(io);
5112		return;
5113	}
5114
5115	ctl_datamove(io);
5116}
5117
5118/*
5119 * SCSI release command.
5120 */
5121int
5122ctl_scsi_release(struct ctl_scsiio *ctsio)
5123{
5124	struct ctl_lun *lun;
5125	uint32_t residx;
5126
5127	CTL_DEBUG_PRINT(("ctl_scsi_release\n"));
5128
5129	residx = ctl_get_initindex(&ctsio->io_hdr.nexus);
5130	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5131
5132	/*
5133	 * XXX KDM right now, we only support LUN reservation.  We don't
5134	 * support 3rd party reservations, or extent reservations, which
5135	 * might actually need the parameter list.  If we've gotten this
5136	 * far, we've got a LUN reservation.  Anything else got kicked out
5137	 * above.  So, according to SPC, ignore the length.
5138	 */
5139
5140	mtx_lock(&lun->lun_lock);
5141
5142	/*
5143	 * According to SPC, it is not an error for an intiator to attempt
5144	 * to release a reservation on a LUN that isn't reserved, or that
5145	 * is reserved by another initiator.  The reservation can only be
5146	 * released, though, by the initiator who made it or by one of
5147	 * several reset type events.
5148	 */
5149	if ((lun->flags & CTL_LUN_RESERVED) && (lun->res_idx == residx))
5150			lun->flags &= ~CTL_LUN_RESERVED;
5151
5152	mtx_unlock(&lun->lun_lock);
5153
5154	ctl_set_success(ctsio);
5155	ctl_done((union ctl_io *)ctsio);
5156	return (CTL_RETVAL_COMPLETE);
5157}
5158
5159int
5160ctl_scsi_reserve(struct ctl_scsiio *ctsio)
5161{
5162	struct ctl_lun *lun;
5163	uint32_t residx;
5164
5165	CTL_DEBUG_PRINT(("ctl_reserve\n"));
5166
5167	residx = ctl_get_initindex(&ctsio->io_hdr.nexus);
5168	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5169
5170	/*
5171	 * XXX KDM right now, we only support LUN reservation.  We don't
5172	 * support 3rd party reservations, or extent reservations, which
5173	 * might actually need the parameter list.  If we've gotten this
5174	 * far, we've got a LUN reservation.  Anything else got kicked out
5175	 * above.  So, according to SPC, ignore the length.
5176	 */
5177
5178	mtx_lock(&lun->lun_lock);
5179	if ((lun->flags & CTL_LUN_RESERVED) && (lun->res_idx != residx)) {
5180		ctl_set_reservation_conflict(ctsio);
5181		goto bailout;
5182	}
5183
5184	/* SPC-3 exceptions to SPC-2 RESERVE and RELEASE behavior. */
5185	if (lun->flags & CTL_LUN_PR_RESERVED) {
5186		ctl_set_success(ctsio);
5187		goto bailout;
5188	}
5189
5190	lun->flags |= CTL_LUN_RESERVED;
5191	lun->res_idx = residx;
5192	ctl_set_success(ctsio);
5193
5194bailout:
5195	mtx_unlock(&lun->lun_lock);
5196	ctl_done((union ctl_io *)ctsio);
5197	return (CTL_RETVAL_COMPLETE);
5198}
5199
5200int
5201ctl_start_stop(struct ctl_scsiio *ctsio)
5202{
5203	struct scsi_start_stop_unit *cdb;
5204	struct ctl_lun *lun;
5205	int retval;
5206
5207	CTL_DEBUG_PRINT(("ctl_start_stop\n"));
5208
5209	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5210	cdb = (struct scsi_start_stop_unit *)ctsio->cdb;
5211
5212	if ((cdb->how & SSS_PC_MASK) == 0) {
5213		if ((lun->flags & CTL_LUN_PR_RESERVED) &&
5214		    (cdb->how & SSS_START) == 0) {
5215			uint32_t residx;
5216
5217			residx = ctl_get_initindex(&ctsio->io_hdr.nexus);
5218			if (ctl_get_prkey(lun, residx) == 0 ||
5219			    (lun->pr_res_idx != residx && lun->pr_res_type < 4)) {
5220
5221				ctl_set_reservation_conflict(ctsio);
5222				ctl_done((union ctl_io *)ctsio);
5223				return (CTL_RETVAL_COMPLETE);
5224			}
5225		}
5226
5227		if ((cdb->how & SSS_LOEJ) &&
5228		    (lun->flags & CTL_LUN_REMOVABLE) == 0) {
5229			ctl_set_invalid_field(ctsio,
5230					      /*sks_valid*/ 1,
5231					      /*command*/ 1,
5232					      /*field*/ 4,
5233					      /*bit_valid*/ 1,
5234					      /*bit*/ 1);
5235			ctl_done((union ctl_io *)ctsio);
5236			return (CTL_RETVAL_COMPLETE);
5237		}
5238
5239		if ((cdb->how & SSS_START) == 0 && (cdb->how & SSS_LOEJ) &&
5240		    lun->prevent_count > 0) {
5241			/* "Medium removal prevented" */
5242			ctl_set_sense(ctsio, /*current_error*/ 1,
5243			    /*sense_key*/(lun->flags & CTL_LUN_NO_MEDIA) ?
5244			     SSD_KEY_NOT_READY : SSD_KEY_ILLEGAL_REQUEST,
5245			    /*asc*/ 0x53, /*ascq*/ 0x02, SSD_ELEM_NONE);
5246			ctl_done((union ctl_io *)ctsio);
5247			return (CTL_RETVAL_COMPLETE);
5248		}
5249	}
5250
5251	retval = lun->backend->config_write((union ctl_io *)ctsio);
5252	return (retval);
5253}
5254
5255int
5256ctl_prevent_allow(struct ctl_scsiio *ctsio)
5257{
5258	struct ctl_lun *lun;
5259	struct scsi_prevent *cdb;
5260	int retval;
5261	uint32_t initidx;
5262
5263	CTL_DEBUG_PRINT(("ctl_prevent_allow\n"));
5264
5265	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5266	cdb = (struct scsi_prevent *)ctsio->cdb;
5267
5268	if ((lun->flags & CTL_LUN_REMOVABLE) == 0) {
5269		ctl_set_invalid_opcode(ctsio);
5270		ctl_done((union ctl_io *)ctsio);
5271		return (CTL_RETVAL_COMPLETE);
5272	}
5273
5274	initidx = ctl_get_initindex(&ctsio->io_hdr.nexus);
5275	mtx_lock(&lun->lun_lock);
5276	if ((cdb->how & PR_PREVENT) &&
5277	    ctl_is_set(lun->prevent, initidx) == 0) {
5278		ctl_set_mask(lun->prevent, initidx);
5279		lun->prevent_count++;
5280	} else if ((cdb->how & PR_PREVENT) == 0 &&
5281	    ctl_is_set(lun->prevent, initidx)) {
5282		ctl_clear_mask(lun->prevent, initidx);
5283		lun->prevent_count--;
5284	}
5285	mtx_unlock(&lun->lun_lock);
5286	retval = lun->backend->config_write((union ctl_io *)ctsio);
5287	return (retval);
5288}
5289
5290/*
5291 * We support the SYNCHRONIZE CACHE command (10 and 16 byte versions), but
5292 * we don't really do anything with the LBA and length fields if the user
5293 * passes them in.  Instead we'll just flush out the cache for the entire
5294 * LUN.
5295 */
5296int
5297ctl_sync_cache(struct ctl_scsiio *ctsio)
5298{
5299	struct ctl_lun *lun;
5300	struct ctl_softc *softc;
5301	struct ctl_lba_len_flags *lbalen;
5302	uint64_t starting_lba;
5303	uint32_t block_count;
5304	int retval;
5305	uint8_t byte2;
5306
5307	CTL_DEBUG_PRINT(("ctl_sync_cache\n"));
5308
5309	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5310	softc = lun->ctl_softc;
5311	retval = 0;
5312
5313	switch (ctsio->cdb[0]) {
5314	case SYNCHRONIZE_CACHE: {
5315		struct scsi_sync_cache *cdb;
5316		cdb = (struct scsi_sync_cache *)ctsio->cdb;
5317
5318		starting_lba = scsi_4btoul(cdb->begin_lba);
5319		block_count = scsi_2btoul(cdb->lb_count);
5320		byte2 = cdb->byte2;
5321		break;
5322	}
5323	case SYNCHRONIZE_CACHE_16: {
5324		struct scsi_sync_cache_16 *cdb;
5325		cdb = (struct scsi_sync_cache_16 *)ctsio->cdb;
5326
5327		starting_lba = scsi_8btou64(cdb->begin_lba);
5328		block_count = scsi_4btoul(cdb->lb_count);
5329		byte2 = cdb->byte2;
5330		break;
5331	}
5332	default:
5333		ctl_set_invalid_opcode(ctsio);
5334		ctl_done((union ctl_io *)ctsio);
5335		goto bailout;
5336		break; /* NOTREACHED */
5337	}
5338
5339	/*
5340	 * We check the LBA and length, but don't do anything with them.
5341	 * A SYNCHRONIZE CACHE will cause the entire cache for this lun to
5342	 * get flushed.  This check will just help satisfy anyone who wants
5343	 * to see an error for an out of range LBA.
5344	 */
5345	if ((starting_lba + block_count) > (lun->be_lun->maxlba + 1)) {
5346		ctl_set_lba_out_of_range(ctsio);
5347		ctl_done((union ctl_io *)ctsio);
5348		goto bailout;
5349	}
5350
5351	lbalen = (struct ctl_lba_len_flags *)&ctsio->io_hdr.ctl_private[CTL_PRIV_LBA_LEN];
5352	lbalen->lba = starting_lba;
5353	lbalen->len = block_count;
5354	lbalen->flags = byte2;
5355	retval = lun->backend->config_write((union ctl_io *)ctsio);
5356
5357bailout:
5358	return (retval);
5359}
5360
5361int
5362ctl_format(struct ctl_scsiio *ctsio)
5363{
5364	struct scsi_format *cdb;
5365	struct ctl_lun *lun;
5366	int length, defect_list_len;
5367
5368	CTL_DEBUG_PRINT(("ctl_format\n"));
5369
5370	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5371
5372	cdb = (struct scsi_format *)ctsio->cdb;
5373
5374	length = 0;
5375	if (cdb->byte2 & SF_FMTDATA) {
5376		if (cdb->byte2 & SF_LONGLIST)
5377			length = sizeof(struct scsi_format_header_long);
5378		else
5379			length = sizeof(struct scsi_format_header_short);
5380	}
5381
5382	if (((ctsio->io_hdr.flags & CTL_FLAG_ALLOCATED) == 0)
5383	 && (length > 0)) {
5384		ctsio->kern_data_ptr = malloc(length, M_CTL, M_WAITOK);
5385		ctsio->kern_data_len = length;
5386		ctsio->kern_total_len = length;
5387		ctsio->kern_data_resid = 0;
5388		ctsio->kern_rel_offset = 0;
5389		ctsio->kern_sg_entries = 0;
5390		ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
5391		ctsio->be_move_done = ctl_config_move_done;
5392		ctl_datamove((union ctl_io *)ctsio);
5393
5394		return (CTL_RETVAL_COMPLETE);
5395	}
5396
5397	defect_list_len = 0;
5398
5399	if (cdb->byte2 & SF_FMTDATA) {
5400		if (cdb->byte2 & SF_LONGLIST) {
5401			struct scsi_format_header_long *header;
5402
5403			header = (struct scsi_format_header_long *)
5404				ctsio->kern_data_ptr;
5405
5406			defect_list_len = scsi_4btoul(header->defect_list_len);
5407			if (defect_list_len != 0) {
5408				ctl_set_invalid_field(ctsio,
5409						      /*sks_valid*/ 1,
5410						      /*command*/ 0,
5411						      /*field*/ 2,
5412						      /*bit_valid*/ 0,
5413						      /*bit*/ 0);
5414				goto bailout;
5415			}
5416		} else {
5417			struct scsi_format_header_short *header;
5418
5419			header = (struct scsi_format_header_short *)
5420				ctsio->kern_data_ptr;
5421
5422			defect_list_len = scsi_2btoul(header->defect_list_len);
5423			if (defect_list_len != 0) {
5424				ctl_set_invalid_field(ctsio,
5425						      /*sks_valid*/ 1,
5426						      /*command*/ 0,
5427						      /*field*/ 2,
5428						      /*bit_valid*/ 0,
5429						      /*bit*/ 0);
5430				goto bailout;
5431			}
5432		}
5433	}
5434
5435	ctl_set_success(ctsio);
5436bailout:
5437
5438	if (ctsio->io_hdr.flags & CTL_FLAG_ALLOCATED) {
5439		free(ctsio->kern_data_ptr, M_CTL);
5440		ctsio->io_hdr.flags &= ~CTL_FLAG_ALLOCATED;
5441	}
5442
5443	ctl_done((union ctl_io *)ctsio);
5444	return (CTL_RETVAL_COMPLETE);
5445}
5446
5447int
5448ctl_read_buffer(struct ctl_scsiio *ctsio)
5449{
5450	struct ctl_lun *lun;
5451	uint64_t buffer_offset;
5452	uint32_t len;
5453	uint8_t byte2;
5454	static uint8_t descr[4];
5455	static uint8_t echo_descr[4] = { 0 };
5456
5457	CTL_DEBUG_PRINT(("ctl_read_buffer\n"));
5458	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5459	switch (ctsio->cdb[0]) {
5460	case READ_BUFFER: {
5461		struct scsi_read_buffer *cdb;
5462
5463		cdb = (struct scsi_read_buffer *)ctsio->cdb;
5464		buffer_offset = scsi_3btoul(cdb->offset);
5465		len = scsi_3btoul(cdb->length);
5466		byte2 = cdb->byte2;
5467		break;
5468	}
5469	case READ_BUFFER_16: {
5470		struct scsi_read_buffer_16 *cdb;
5471
5472		cdb = (struct scsi_read_buffer_16 *)ctsio->cdb;
5473		buffer_offset = scsi_8btou64(cdb->offset);
5474		len = scsi_4btoul(cdb->length);
5475		byte2 = cdb->byte2;
5476		break;
5477	}
5478	default: /* This shouldn't happen. */
5479		ctl_set_invalid_opcode(ctsio);
5480		ctl_done((union ctl_io *)ctsio);
5481		return (CTL_RETVAL_COMPLETE);
5482	}
5483
5484	if ((byte2 & RWB_MODE) != RWB_MODE_DATA &&
5485	    (byte2 & RWB_MODE) != RWB_MODE_ECHO_DESCR &&
5486	    (byte2 & RWB_MODE) != RWB_MODE_DESCR) {
5487		ctl_set_invalid_field(ctsio,
5488				      /*sks_valid*/ 1,
5489				      /*command*/ 1,
5490				      /*field*/ 1,
5491				      /*bit_valid*/ 1,
5492				      /*bit*/ 4);
5493		ctl_done((union ctl_io *)ctsio);
5494		return (CTL_RETVAL_COMPLETE);
5495	}
5496
5497	if (buffer_offset > CTL_WRITE_BUFFER_SIZE ||
5498	    buffer_offset + len > CTL_WRITE_BUFFER_SIZE) {
5499		ctl_set_invalid_field(ctsio,
5500				      /*sks_valid*/ 1,
5501				      /*command*/ 1,
5502				      /*field*/ 6,
5503				      /*bit_valid*/ 0,
5504				      /*bit*/ 0);
5505		ctl_done((union ctl_io *)ctsio);
5506		return (CTL_RETVAL_COMPLETE);
5507	}
5508
5509	if ((byte2 & RWB_MODE) == RWB_MODE_DESCR) {
5510		descr[0] = 0;
5511		scsi_ulto3b(CTL_WRITE_BUFFER_SIZE, &descr[1]);
5512		ctsio->kern_data_ptr = descr;
5513		len = min(len, sizeof(descr));
5514	} else if ((byte2 & RWB_MODE) == RWB_MODE_ECHO_DESCR) {
5515		ctsio->kern_data_ptr = echo_descr;
5516		len = min(len, sizeof(echo_descr));
5517	} else {
5518		if (lun->write_buffer == NULL) {
5519			lun->write_buffer = malloc(CTL_WRITE_BUFFER_SIZE,
5520			    M_CTL, M_WAITOK);
5521		}
5522		ctsio->kern_data_ptr = lun->write_buffer + buffer_offset;
5523	}
5524	ctsio->kern_data_len = len;
5525	ctsio->kern_total_len = len;
5526	ctsio->kern_data_resid = 0;
5527	ctsio->kern_rel_offset = 0;
5528	ctsio->kern_sg_entries = 0;
5529	ctl_set_success(ctsio);
5530	ctsio->be_move_done = ctl_config_move_done;
5531	ctl_datamove((union ctl_io *)ctsio);
5532	return (CTL_RETVAL_COMPLETE);
5533}
5534
5535int
5536ctl_write_buffer(struct ctl_scsiio *ctsio)
5537{
5538	struct scsi_write_buffer *cdb;
5539	struct ctl_lun *lun;
5540	int buffer_offset, len;
5541
5542	CTL_DEBUG_PRINT(("ctl_write_buffer\n"));
5543
5544	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5545	cdb = (struct scsi_write_buffer *)ctsio->cdb;
5546
5547	if ((cdb->byte2 & RWB_MODE) != RWB_MODE_DATA) {
5548		ctl_set_invalid_field(ctsio,
5549				      /*sks_valid*/ 1,
5550				      /*command*/ 1,
5551				      /*field*/ 1,
5552				      /*bit_valid*/ 1,
5553				      /*bit*/ 4);
5554		ctl_done((union ctl_io *)ctsio);
5555		return (CTL_RETVAL_COMPLETE);
5556	}
5557
5558	len = scsi_3btoul(cdb->length);
5559	buffer_offset = scsi_3btoul(cdb->offset);
5560
5561	if (buffer_offset + len > CTL_WRITE_BUFFER_SIZE) {
5562		ctl_set_invalid_field(ctsio,
5563				      /*sks_valid*/ 1,
5564				      /*command*/ 1,
5565				      /*field*/ 6,
5566				      /*bit_valid*/ 0,
5567				      /*bit*/ 0);
5568		ctl_done((union ctl_io *)ctsio);
5569		return (CTL_RETVAL_COMPLETE);
5570	}
5571
5572	/*
5573	 * If we've got a kernel request that hasn't been malloced yet,
5574	 * malloc it and tell the caller the data buffer is here.
5575	 */
5576	if ((ctsio->io_hdr.flags & CTL_FLAG_ALLOCATED) == 0) {
5577		if (lun->write_buffer == NULL) {
5578			lun->write_buffer = malloc(CTL_WRITE_BUFFER_SIZE,
5579			    M_CTL, M_WAITOK);
5580		}
5581		ctsio->kern_data_ptr = lun->write_buffer + buffer_offset;
5582		ctsio->kern_data_len = len;
5583		ctsio->kern_total_len = len;
5584		ctsio->kern_data_resid = 0;
5585		ctsio->kern_rel_offset = 0;
5586		ctsio->kern_sg_entries = 0;
5587		ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
5588		ctsio->be_move_done = ctl_config_move_done;
5589		ctl_datamove((union ctl_io *)ctsio);
5590
5591		return (CTL_RETVAL_COMPLETE);
5592	}
5593
5594	ctl_set_success(ctsio);
5595	ctl_done((union ctl_io *)ctsio);
5596	return (CTL_RETVAL_COMPLETE);
5597}
5598
5599int
5600ctl_write_same(struct ctl_scsiio *ctsio)
5601{
5602	struct ctl_lun *lun;
5603	struct ctl_lba_len_flags *lbalen;
5604	uint64_t lba;
5605	uint32_t num_blocks;
5606	int len, retval;
5607	uint8_t byte2;
5608
5609	CTL_DEBUG_PRINT(("ctl_write_same\n"));
5610
5611	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5612
5613	switch (ctsio->cdb[0]) {
5614	case WRITE_SAME_10: {
5615		struct scsi_write_same_10 *cdb;
5616
5617		cdb = (struct scsi_write_same_10 *)ctsio->cdb;
5618
5619		lba = scsi_4btoul(cdb->addr);
5620		num_blocks = scsi_2btoul(cdb->length);
5621		byte2 = cdb->byte2;
5622		break;
5623	}
5624	case WRITE_SAME_16: {
5625		struct scsi_write_same_16 *cdb;
5626
5627		cdb = (struct scsi_write_same_16 *)ctsio->cdb;
5628
5629		lba = scsi_8btou64(cdb->addr);
5630		num_blocks = scsi_4btoul(cdb->length);
5631		byte2 = cdb->byte2;
5632		break;
5633	}
5634	default:
5635		/*
5636		 * We got a command we don't support.  This shouldn't
5637		 * happen, commands should be filtered out above us.
5638		 */
5639		ctl_set_invalid_opcode(ctsio);
5640		ctl_done((union ctl_io *)ctsio);
5641
5642		return (CTL_RETVAL_COMPLETE);
5643		break; /* NOTREACHED */
5644	}
5645
5646	/* ANCHOR flag can be used only together with UNMAP */
5647	if ((byte2 & SWS_UNMAP) == 0 && (byte2 & SWS_ANCHOR) != 0) {
5648		ctl_set_invalid_field(ctsio, /*sks_valid*/ 1,
5649		    /*command*/ 1, /*field*/ 1, /*bit_valid*/ 1, /*bit*/ 0);
5650		ctl_done((union ctl_io *)ctsio);
5651		return (CTL_RETVAL_COMPLETE);
5652	}
5653
5654	/*
5655	 * The first check is to make sure we're in bounds, the second
5656	 * check is to catch wrap-around problems.  If the lba + num blocks
5657	 * is less than the lba, then we've wrapped around and the block
5658	 * range is invalid anyway.
5659	 */
5660	if (((lba + num_blocks) > (lun->be_lun->maxlba + 1))
5661	 || ((lba + num_blocks) < lba)) {
5662		ctl_set_lba_out_of_range(ctsio);
5663		ctl_done((union ctl_io *)ctsio);
5664		return (CTL_RETVAL_COMPLETE);
5665	}
5666
5667	/* Zero number of blocks means "to the last logical block" */
5668	if (num_blocks == 0) {
5669		if ((lun->be_lun->maxlba + 1) - lba > UINT32_MAX) {
5670			ctl_set_invalid_field(ctsio,
5671					      /*sks_valid*/ 0,
5672					      /*command*/ 1,
5673					      /*field*/ 0,
5674					      /*bit_valid*/ 0,
5675					      /*bit*/ 0);
5676			ctl_done((union ctl_io *)ctsio);
5677			return (CTL_RETVAL_COMPLETE);
5678		}
5679		num_blocks = (lun->be_lun->maxlba + 1) - lba;
5680	}
5681
5682	len = lun->be_lun->blocksize;
5683
5684	/*
5685	 * If we've got a kernel request that hasn't been malloced yet,
5686	 * malloc it and tell the caller the data buffer is here.
5687	 */
5688	if ((byte2 & SWS_NDOB) == 0 &&
5689	    (ctsio->io_hdr.flags & CTL_FLAG_ALLOCATED) == 0) {
5690		ctsio->kern_data_ptr = malloc(len, M_CTL, M_WAITOK);;
5691		ctsio->kern_data_len = len;
5692		ctsio->kern_total_len = len;
5693		ctsio->kern_data_resid = 0;
5694		ctsio->kern_rel_offset = 0;
5695		ctsio->kern_sg_entries = 0;
5696		ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
5697		ctsio->be_move_done = ctl_config_move_done;
5698		ctl_datamove((union ctl_io *)ctsio);
5699
5700		return (CTL_RETVAL_COMPLETE);
5701	}
5702
5703	lbalen = (struct ctl_lba_len_flags *)&ctsio->io_hdr.ctl_private[CTL_PRIV_LBA_LEN];
5704	lbalen->lba = lba;
5705	lbalen->len = num_blocks;
5706	lbalen->flags = byte2;
5707	retval = lun->backend->config_write((union ctl_io *)ctsio);
5708
5709	return (retval);
5710}
5711
5712int
5713ctl_unmap(struct ctl_scsiio *ctsio)
5714{
5715	struct ctl_lun *lun;
5716	struct scsi_unmap *cdb;
5717	struct ctl_ptr_len_flags *ptrlen;
5718	struct scsi_unmap_header *hdr;
5719	struct scsi_unmap_desc *buf, *end, *endnz, *range;
5720	uint64_t lba;
5721	uint32_t num_blocks;
5722	int len, retval;
5723	uint8_t byte2;
5724
5725	CTL_DEBUG_PRINT(("ctl_unmap\n"));
5726
5727	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5728	cdb = (struct scsi_unmap *)ctsio->cdb;
5729
5730	len = scsi_2btoul(cdb->length);
5731	byte2 = cdb->byte2;
5732
5733	/*
5734	 * If we've got a kernel request that hasn't been malloced yet,
5735	 * malloc it and tell the caller the data buffer is here.
5736	 */
5737	if ((ctsio->io_hdr.flags & CTL_FLAG_ALLOCATED) == 0) {
5738		ctsio->kern_data_ptr = malloc(len, M_CTL, M_WAITOK);;
5739		ctsio->kern_data_len = len;
5740		ctsio->kern_total_len = len;
5741		ctsio->kern_data_resid = 0;
5742		ctsio->kern_rel_offset = 0;
5743		ctsio->kern_sg_entries = 0;
5744		ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
5745		ctsio->be_move_done = ctl_config_move_done;
5746		ctl_datamove((union ctl_io *)ctsio);
5747
5748		return (CTL_RETVAL_COMPLETE);
5749	}
5750
5751	len = ctsio->kern_total_len - ctsio->kern_data_resid;
5752	hdr = (struct scsi_unmap_header *)ctsio->kern_data_ptr;
5753	if (len < sizeof (*hdr) ||
5754	    len < (scsi_2btoul(hdr->length) + sizeof(hdr->length)) ||
5755	    len < (scsi_2btoul(hdr->desc_length) + sizeof (*hdr)) ||
5756	    scsi_2btoul(hdr->desc_length) % sizeof(*buf) != 0) {
5757		ctl_set_invalid_field(ctsio,
5758				      /*sks_valid*/ 0,
5759				      /*command*/ 0,
5760				      /*field*/ 0,
5761				      /*bit_valid*/ 0,
5762				      /*bit*/ 0);
5763		goto done;
5764	}
5765	len = scsi_2btoul(hdr->desc_length);
5766	buf = (struct scsi_unmap_desc *)(hdr + 1);
5767	end = buf + len / sizeof(*buf);
5768
5769	endnz = buf;
5770	for (range = buf; range < end; range++) {
5771		lba = scsi_8btou64(range->lba);
5772		num_blocks = scsi_4btoul(range->length);
5773		if (((lba + num_blocks) > (lun->be_lun->maxlba + 1))
5774		 || ((lba + num_blocks) < lba)) {
5775			ctl_set_lba_out_of_range(ctsio);
5776			ctl_done((union ctl_io *)ctsio);
5777			return (CTL_RETVAL_COMPLETE);
5778		}
5779		if (num_blocks != 0)
5780			endnz = range + 1;
5781	}
5782
5783	/*
5784	 * Block backend can not handle zero last range.
5785	 * Filter it out and return if there is nothing left.
5786	 */
5787	len = (uint8_t *)endnz - (uint8_t *)buf;
5788	if (len == 0) {
5789		ctl_set_success(ctsio);
5790		goto done;
5791	}
5792
5793	mtx_lock(&lun->lun_lock);
5794	ptrlen = (struct ctl_ptr_len_flags *)
5795	    &ctsio->io_hdr.ctl_private[CTL_PRIV_LBA_LEN];
5796	ptrlen->ptr = (void *)buf;
5797	ptrlen->len = len;
5798	ptrlen->flags = byte2;
5799	ctl_check_blocked(lun);
5800	mtx_unlock(&lun->lun_lock);
5801
5802	retval = lun->backend->config_write((union ctl_io *)ctsio);
5803	return (retval);
5804
5805done:
5806	if (ctsio->io_hdr.flags & CTL_FLAG_ALLOCATED) {
5807		free(ctsio->kern_data_ptr, M_CTL);
5808		ctsio->io_hdr.flags &= ~CTL_FLAG_ALLOCATED;
5809	}
5810	ctl_done((union ctl_io *)ctsio);
5811	return (CTL_RETVAL_COMPLETE);
5812}
5813
5814/*
5815 * Note that this function currently doesn't actually do anything inside
5816 * CTL to enforce things if the DQue bit is turned on.
5817 *
5818 * Also note that this function can't be used in the default case, because
5819 * the DQue bit isn't set in the changeable mask for the control mode page
5820 * anyway.  This is just here as an example for how to implement a page
5821 * handler, and a placeholder in case we want to allow the user to turn
5822 * tagged queueing on and off.
5823 *
5824 * The D_SENSE bit handling is functional, however, and will turn
5825 * descriptor sense on and off for a given LUN.
5826 */
5827int
5828ctl_control_page_handler(struct ctl_scsiio *ctsio,
5829			 struct ctl_page_index *page_index, uint8_t *page_ptr)
5830{
5831	struct scsi_control_page *current_cp, *saved_cp, *user_cp;
5832	struct ctl_lun *lun;
5833	int set_ua;
5834	uint32_t initidx;
5835
5836	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5837	initidx = ctl_get_initindex(&ctsio->io_hdr.nexus);
5838	set_ua = 0;
5839
5840	user_cp = (struct scsi_control_page *)page_ptr;
5841	current_cp = (struct scsi_control_page *)
5842		(page_index->page_data + (page_index->page_len *
5843		CTL_PAGE_CURRENT));
5844	saved_cp = (struct scsi_control_page *)
5845		(page_index->page_data + (page_index->page_len *
5846		CTL_PAGE_SAVED));
5847
5848	mtx_lock(&lun->lun_lock);
5849	if (((current_cp->rlec & SCP_DSENSE) == 0)
5850	 && ((user_cp->rlec & SCP_DSENSE) != 0)) {
5851		/*
5852		 * Descriptor sense is currently turned off and the user
5853		 * wants to turn it on.
5854		 */
5855		current_cp->rlec |= SCP_DSENSE;
5856		saved_cp->rlec |= SCP_DSENSE;
5857		lun->flags |= CTL_LUN_SENSE_DESC;
5858		set_ua = 1;
5859	} else if (((current_cp->rlec & SCP_DSENSE) != 0)
5860		&& ((user_cp->rlec & SCP_DSENSE) == 0)) {
5861		/*
5862		 * Descriptor sense is currently turned on, and the user
5863		 * wants to turn it off.
5864		 */
5865		current_cp->rlec &= ~SCP_DSENSE;
5866		saved_cp->rlec &= ~SCP_DSENSE;
5867		lun->flags &= ~CTL_LUN_SENSE_DESC;
5868		set_ua = 1;
5869	}
5870	if ((current_cp->queue_flags & SCP_QUEUE_ALG_MASK) !=
5871	    (user_cp->queue_flags & SCP_QUEUE_ALG_MASK)) {
5872		current_cp->queue_flags &= ~SCP_QUEUE_ALG_MASK;
5873		current_cp->queue_flags |= user_cp->queue_flags & SCP_QUEUE_ALG_MASK;
5874		saved_cp->queue_flags &= ~SCP_QUEUE_ALG_MASK;
5875		saved_cp->queue_flags |= user_cp->queue_flags & SCP_QUEUE_ALG_MASK;
5876		set_ua = 1;
5877	}
5878	if ((current_cp->eca_and_aen & SCP_SWP) !=
5879	    (user_cp->eca_and_aen & SCP_SWP)) {
5880		current_cp->eca_and_aen &= ~SCP_SWP;
5881		current_cp->eca_and_aen |= user_cp->eca_and_aen & SCP_SWP;
5882		saved_cp->eca_and_aen &= ~SCP_SWP;
5883		saved_cp->eca_and_aen |= user_cp->eca_and_aen & SCP_SWP;
5884		set_ua = 1;
5885	}
5886	if (set_ua != 0)
5887		ctl_est_ua_all(lun, initidx, CTL_UA_MODE_CHANGE);
5888	mtx_unlock(&lun->lun_lock);
5889	if (set_ua) {
5890		ctl_isc_announce_mode(lun,
5891		    ctl_get_initindex(&ctsio->io_hdr.nexus),
5892		    page_index->page_code, page_index->subpage);
5893	}
5894	return (0);
5895}
5896
5897int
5898ctl_caching_sp_handler(struct ctl_scsiio *ctsio,
5899		     struct ctl_page_index *page_index, uint8_t *page_ptr)
5900{
5901	struct scsi_caching_page *current_cp, *saved_cp, *user_cp;
5902	struct ctl_lun *lun;
5903	int set_ua;
5904	uint32_t initidx;
5905
5906	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5907	initidx = ctl_get_initindex(&ctsio->io_hdr.nexus);
5908	set_ua = 0;
5909
5910	user_cp = (struct scsi_caching_page *)page_ptr;
5911	current_cp = (struct scsi_caching_page *)
5912		(page_index->page_data + (page_index->page_len *
5913		CTL_PAGE_CURRENT));
5914	saved_cp = (struct scsi_caching_page *)
5915		(page_index->page_data + (page_index->page_len *
5916		CTL_PAGE_SAVED));
5917
5918	mtx_lock(&lun->lun_lock);
5919	if ((current_cp->flags1 & (SCP_WCE | SCP_RCD)) !=
5920	    (user_cp->flags1 & (SCP_WCE | SCP_RCD))) {
5921		current_cp->flags1 &= ~(SCP_WCE | SCP_RCD);
5922		current_cp->flags1 |= user_cp->flags1 & (SCP_WCE | SCP_RCD);
5923		saved_cp->flags1 &= ~(SCP_WCE | SCP_RCD);
5924		saved_cp->flags1 |= user_cp->flags1 & (SCP_WCE | SCP_RCD);
5925		set_ua = 1;
5926	}
5927	if (set_ua != 0)
5928		ctl_est_ua_all(lun, initidx, CTL_UA_MODE_CHANGE);
5929	mtx_unlock(&lun->lun_lock);
5930	if (set_ua) {
5931		ctl_isc_announce_mode(lun,
5932		    ctl_get_initindex(&ctsio->io_hdr.nexus),
5933		    page_index->page_code, page_index->subpage);
5934	}
5935	return (0);
5936}
5937
5938int
5939ctl_debugconf_sp_select_handler(struct ctl_scsiio *ctsio,
5940				struct ctl_page_index *page_index,
5941				uint8_t *page_ptr)
5942{
5943	uint8_t *c;
5944	int i;
5945
5946	c = ((struct copan_debugconf_subpage *)page_ptr)->ctl_time_io_secs;
5947	ctl_time_io_secs =
5948		(c[0] << 8) |
5949		(c[1] << 0) |
5950		0;
5951	CTL_DEBUG_PRINT(("set ctl_time_io_secs to %d\n", ctl_time_io_secs));
5952	printf("set ctl_time_io_secs to %d\n", ctl_time_io_secs);
5953	printf("page data:");
5954	for (i=0; i<8; i++)
5955		printf(" %.2x",page_ptr[i]);
5956	printf("\n");
5957	return (0);
5958}
5959
5960int
5961ctl_debugconf_sp_sense_handler(struct ctl_scsiio *ctsio,
5962			       struct ctl_page_index *page_index,
5963			       int pc)
5964{
5965	struct copan_debugconf_subpage *page;
5966
5967	page = (struct copan_debugconf_subpage *)page_index->page_data +
5968		(page_index->page_len * pc);
5969
5970	switch (pc) {
5971	case SMS_PAGE_CTRL_CHANGEABLE >> 6:
5972	case SMS_PAGE_CTRL_DEFAULT >> 6:
5973	case SMS_PAGE_CTRL_SAVED >> 6:
5974		/*
5975		 * We don't update the changable or default bits for this page.
5976		 */
5977		break;
5978	case SMS_PAGE_CTRL_CURRENT >> 6:
5979		page->ctl_time_io_secs[0] = ctl_time_io_secs >> 8;
5980		page->ctl_time_io_secs[1] = ctl_time_io_secs >> 0;
5981		break;
5982	default:
5983		break;
5984	}
5985	return (0);
5986}
5987
5988
5989static int
5990ctl_do_mode_select(union ctl_io *io)
5991{
5992	struct scsi_mode_page_header *page_header;
5993	struct ctl_page_index *page_index;
5994	struct ctl_scsiio *ctsio;
5995	int page_len, page_len_offset, page_len_size;
5996	union ctl_modepage_info *modepage_info;
5997	struct ctl_lun *lun;
5998	int *len_left, *len_used;
5999	int retval, i;
6000
6001	ctsio = &io->scsiio;
6002	page_index = NULL;
6003	page_len = 0;
6004	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
6005
6006	modepage_info = (union ctl_modepage_info *)
6007		ctsio->io_hdr.ctl_private[CTL_PRIV_MODEPAGE].bytes;
6008	len_left = &modepage_info->header.len_left;
6009	len_used = &modepage_info->header.len_used;
6010
6011do_next_page:
6012
6013	page_header = (struct scsi_mode_page_header *)
6014		(ctsio->kern_data_ptr + *len_used);
6015
6016	if (*len_left == 0) {
6017		free(ctsio->kern_data_ptr, M_CTL);
6018		ctl_set_success(ctsio);
6019		ctl_done((union ctl_io *)ctsio);
6020		return (CTL_RETVAL_COMPLETE);
6021	} else if (*len_left < sizeof(struct scsi_mode_page_header)) {
6022
6023		free(ctsio->kern_data_ptr, M_CTL);
6024		ctl_set_param_len_error(ctsio);
6025		ctl_done((union ctl_io *)ctsio);
6026		return (CTL_RETVAL_COMPLETE);
6027
6028	} else if ((page_header->page_code & SMPH_SPF)
6029		&& (*len_left < sizeof(struct scsi_mode_page_header_sp))) {
6030
6031		free(ctsio->kern_data_ptr, M_CTL);
6032		ctl_set_param_len_error(ctsio);
6033		ctl_done((union ctl_io *)ctsio);
6034		return (CTL_RETVAL_COMPLETE);
6035	}
6036
6037
6038	/*
6039	 * XXX KDM should we do something with the block descriptor?
6040	 */
6041	for (i = 0; i < CTL_NUM_MODE_PAGES; i++) {
6042		page_index = &lun->mode_pages.index[i];
6043		if (lun->be_lun->lun_type == T_DIRECT &&
6044		    (page_index->page_flags & CTL_PAGE_FLAG_DIRECT) == 0)
6045			continue;
6046		if (lun->be_lun->lun_type == T_PROCESSOR &&
6047		    (page_index->page_flags & CTL_PAGE_FLAG_PROC) == 0)
6048			continue;
6049		if (lun->be_lun->lun_type == T_CDROM &&
6050		    (page_index->page_flags & CTL_PAGE_FLAG_CDROM) == 0)
6051			continue;
6052
6053		if ((page_index->page_code & SMPH_PC_MASK) !=
6054		    (page_header->page_code & SMPH_PC_MASK))
6055			continue;
6056
6057		/*
6058		 * If neither page has a subpage code, then we've got a
6059		 * match.
6060		 */
6061		if (((page_index->page_code & SMPH_SPF) == 0)
6062		 && ((page_header->page_code & SMPH_SPF) == 0)) {
6063			page_len = page_header->page_length;
6064			break;
6065		}
6066
6067		/*
6068		 * If both pages have subpages, then the subpage numbers
6069		 * have to match.
6070		 */
6071		if ((page_index->page_code & SMPH_SPF)
6072		  && (page_header->page_code & SMPH_SPF)) {
6073			struct scsi_mode_page_header_sp *sph;
6074
6075			sph = (struct scsi_mode_page_header_sp *)page_header;
6076			if (page_index->subpage == sph->subpage) {
6077				page_len = scsi_2btoul(sph->page_length);
6078				break;
6079			}
6080		}
6081	}
6082
6083	/*
6084	 * If we couldn't find the page, or if we don't have a mode select
6085	 * handler for it, send back an error to the user.
6086	 */
6087	if ((i >= CTL_NUM_MODE_PAGES)
6088	 || (page_index->select_handler == NULL)) {
6089		ctl_set_invalid_field(ctsio,
6090				      /*sks_valid*/ 1,
6091				      /*command*/ 0,
6092				      /*field*/ *len_used,
6093				      /*bit_valid*/ 0,
6094				      /*bit*/ 0);
6095		free(ctsio->kern_data_ptr, M_CTL);
6096		ctl_done((union ctl_io *)ctsio);
6097		return (CTL_RETVAL_COMPLETE);
6098	}
6099
6100	if (page_index->page_code & SMPH_SPF) {
6101		page_len_offset = 2;
6102		page_len_size = 2;
6103	} else {
6104		page_len_size = 1;
6105		page_len_offset = 1;
6106	}
6107
6108	/*
6109	 * If the length the initiator gives us isn't the one we specify in
6110	 * the mode page header, or if they didn't specify enough data in
6111	 * the CDB to avoid truncating this page, kick out the request.
6112	 */
6113	if ((page_len != (page_index->page_len - page_len_offset -
6114			  page_len_size))
6115	 || (*len_left < page_index->page_len)) {
6116
6117
6118		ctl_set_invalid_field(ctsio,
6119				      /*sks_valid*/ 1,
6120				      /*command*/ 0,
6121				      /*field*/ *len_used + page_len_offset,
6122				      /*bit_valid*/ 0,
6123				      /*bit*/ 0);
6124		free(ctsio->kern_data_ptr, M_CTL);
6125		ctl_done((union ctl_io *)ctsio);
6126		return (CTL_RETVAL_COMPLETE);
6127	}
6128
6129	/*
6130	 * Run through the mode page, checking to make sure that the bits
6131	 * the user changed are actually legal for him to change.
6132	 */
6133	for (i = 0; i < page_index->page_len; i++) {
6134		uint8_t *user_byte, *change_mask, *current_byte;
6135		int bad_bit;
6136		int j;
6137
6138		user_byte = (uint8_t *)page_header + i;
6139		change_mask = page_index->page_data +
6140			      (page_index->page_len * CTL_PAGE_CHANGEABLE) + i;
6141		current_byte = page_index->page_data +
6142			       (page_index->page_len * CTL_PAGE_CURRENT) + i;
6143
6144		/*
6145		 * Check to see whether the user set any bits in this byte
6146		 * that he is not allowed to set.
6147		 */
6148		if ((*user_byte & ~(*change_mask)) ==
6149		    (*current_byte & ~(*change_mask)))
6150			continue;
6151
6152		/*
6153		 * Go through bit by bit to determine which one is illegal.
6154		 */
6155		bad_bit = 0;
6156		for (j = 7; j >= 0; j--) {
6157			if ((((1 << i) & ~(*change_mask)) & *user_byte) !=
6158			    (((1 << i) & ~(*change_mask)) & *current_byte)) {
6159				bad_bit = i;
6160				break;
6161			}
6162		}
6163		ctl_set_invalid_field(ctsio,
6164				      /*sks_valid*/ 1,
6165				      /*command*/ 0,
6166				      /*field*/ *len_used + i,
6167				      /*bit_valid*/ 1,
6168				      /*bit*/ bad_bit);
6169		free(ctsio->kern_data_ptr, M_CTL);
6170		ctl_done((union ctl_io *)ctsio);
6171		return (CTL_RETVAL_COMPLETE);
6172	}
6173
6174	/*
6175	 * Decrement these before we call the page handler, since we may
6176	 * end up getting called back one way or another before the handler
6177	 * returns to this context.
6178	 */
6179	*len_left -= page_index->page_len;
6180	*len_used += page_index->page_len;
6181
6182	retval = page_index->select_handler(ctsio, page_index,
6183					    (uint8_t *)page_header);
6184
6185	/*
6186	 * If the page handler returns CTL_RETVAL_QUEUED, then we need to
6187	 * wait until this queued command completes to finish processing
6188	 * the mode page.  If it returns anything other than
6189	 * CTL_RETVAL_COMPLETE (e.g. CTL_RETVAL_ERROR), then it should have
6190	 * already set the sense information, freed the data pointer, and
6191	 * completed the io for us.
6192	 */
6193	if (retval != CTL_RETVAL_COMPLETE)
6194		goto bailout_no_done;
6195
6196	/*
6197	 * If the initiator sent us more than one page, parse the next one.
6198	 */
6199	if (*len_left > 0)
6200		goto do_next_page;
6201
6202	ctl_set_success(ctsio);
6203	free(ctsio->kern_data_ptr, M_CTL);
6204	ctl_done((union ctl_io *)ctsio);
6205
6206bailout_no_done:
6207
6208	return (CTL_RETVAL_COMPLETE);
6209
6210}
6211
6212int
6213ctl_mode_select(struct ctl_scsiio *ctsio)
6214{
6215	int param_len, pf, sp;
6216	int header_size, bd_len;
6217	union ctl_modepage_info *modepage_info;
6218
6219	switch (ctsio->cdb[0]) {
6220	case MODE_SELECT_6: {
6221		struct scsi_mode_select_6 *cdb;
6222
6223		cdb = (struct scsi_mode_select_6 *)ctsio->cdb;
6224
6225		pf = (cdb->byte2 & SMS_PF) ? 1 : 0;
6226		sp = (cdb->byte2 & SMS_SP) ? 1 : 0;
6227		param_len = cdb->length;
6228		header_size = sizeof(struct scsi_mode_header_6);
6229		break;
6230	}
6231	case MODE_SELECT_10: {
6232		struct scsi_mode_select_10 *cdb;
6233
6234		cdb = (struct scsi_mode_select_10 *)ctsio->cdb;
6235
6236		pf = (cdb->byte2 & SMS_PF) ? 1 : 0;
6237		sp = (cdb->byte2 & SMS_SP) ? 1 : 0;
6238		param_len = scsi_2btoul(cdb->length);
6239		header_size = sizeof(struct scsi_mode_header_10);
6240		break;
6241	}
6242	default:
6243		ctl_set_invalid_opcode(ctsio);
6244		ctl_done((union ctl_io *)ctsio);
6245		return (CTL_RETVAL_COMPLETE);
6246	}
6247
6248	/*
6249	 * From SPC-3:
6250	 * "A parameter list length of zero indicates that the Data-Out Buffer
6251	 * shall be empty. This condition shall not be considered as an error."
6252	 */
6253	if (param_len == 0) {
6254		ctl_set_success(ctsio);
6255		ctl_done((union ctl_io *)ctsio);
6256		return (CTL_RETVAL_COMPLETE);
6257	}
6258
6259	/*
6260	 * Since we'll hit this the first time through, prior to
6261	 * allocation, we don't need to free a data buffer here.
6262	 */
6263	if (param_len < header_size) {
6264		ctl_set_param_len_error(ctsio);
6265		ctl_done((union ctl_io *)ctsio);
6266		return (CTL_RETVAL_COMPLETE);
6267	}
6268
6269	/*
6270	 * Allocate the data buffer and grab the user's data.  In theory,
6271	 * we shouldn't have to sanity check the parameter list length here
6272	 * because the maximum size is 64K.  We should be able to malloc
6273	 * that much without too many problems.
6274	 */
6275	if ((ctsio->io_hdr.flags & CTL_FLAG_ALLOCATED) == 0) {
6276		ctsio->kern_data_ptr = malloc(param_len, M_CTL, M_WAITOK);
6277		ctsio->kern_data_len = param_len;
6278		ctsio->kern_total_len = param_len;
6279		ctsio->kern_data_resid = 0;
6280		ctsio->kern_rel_offset = 0;
6281		ctsio->kern_sg_entries = 0;
6282		ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
6283		ctsio->be_move_done = ctl_config_move_done;
6284		ctl_datamove((union ctl_io *)ctsio);
6285
6286		return (CTL_RETVAL_COMPLETE);
6287	}
6288
6289	switch (ctsio->cdb[0]) {
6290	case MODE_SELECT_6: {
6291		struct scsi_mode_header_6 *mh6;
6292
6293		mh6 = (struct scsi_mode_header_6 *)ctsio->kern_data_ptr;
6294		bd_len = mh6->blk_desc_len;
6295		break;
6296	}
6297	case MODE_SELECT_10: {
6298		struct scsi_mode_header_10 *mh10;
6299
6300		mh10 = (struct scsi_mode_header_10 *)ctsio->kern_data_ptr;
6301		bd_len = scsi_2btoul(mh10->blk_desc_len);
6302		break;
6303	}
6304	default:
6305		panic("%s: Invalid CDB type %#x", __func__, ctsio->cdb[0]);
6306	}
6307
6308	if (param_len < (header_size + bd_len)) {
6309		free(ctsio->kern_data_ptr, M_CTL);
6310		ctl_set_param_len_error(ctsio);
6311		ctl_done((union ctl_io *)ctsio);
6312		return (CTL_RETVAL_COMPLETE);
6313	}
6314
6315	/*
6316	 * Set the IO_CONT flag, so that if this I/O gets passed to
6317	 * ctl_config_write_done(), it'll get passed back to
6318	 * ctl_do_mode_select() for further processing, or completion if
6319	 * we're all done.
6320	 */
6321	ctsio->io_hdr.flags |= CTL_FLAG_IO_CONT;
6322	ctsio->io_cont = ctl_do_mode_select;
6323
6324	modepage_info = (union ctl_modepage_info *)
6325		ctsio->io_hdr.ctl_private[CTL_PRIV_MODEPAGE].bytes;
6326	memset(modepage_info, 0, sizeof(*modepage_info));
6327	modepage_info->header.len_left = param_len - header_size - bd_len;
6328	modepage_info->header.len_used = header_size + bd_len;
6329
6330	return (ctl_do_mode_select((union ctl_io *)ctsio));
6331}
6332
6333int
6334ctl_mode_sense(struct ctl_scsiio *ctsio)
6335{
6336	struct ctl_lun *lun;
6337	int pc, page_code, dbd, llba, subpage;
6338	int alloc_len, page_len, header_len, total_len;
6339	struct scsi_mode_block_descr *block_desc;
6340	struct ctl_page_index *page_index;
6341
6342	dbd = 0;
6343	llba = 0;
6344	block_desc = NULL;
6345
6346	CTL_DEBUG_PRINT(("ctl_mode_sense\n"));
6347
6348	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
6349	switch (ctsio->cdb[0]) {
6350	case MODE_SENSE_6: {
6351		struct scsi_mode_sense_6 *cdb;
6352
6353		cdb = (struct scsi_mode_sense_6 *)ctsio->cdb;
6354
6355		header_len = sizeof(struct scsi_mode_hdr_6);
6356		if (cdb->byte2 & SMS_DBD)
6357			dbd = 1;
6358		else
6359			header_len += sizeof(struct scsi_mode_block_descr);
6360
6361		pc = (cdb->page & SMS_PAGE_CTRL_MASK) >> 6;
6362		page_code = cdb->page & SMS_PAGE_CODE;
6363		subpage = cdb->subpage;
6364		alloc_len = cdb->length;
6365		break;
6366	}
6367	case MODE_SENSE_10: {
6368		struct scsi_mode_sense_10 *cdb;
6369
6370		cdb = (struct scsi_mode_sense_10 *)ctsio->cdb;
6371
6372		header_len = sizeof(struct scsi_mode_hdr_10);
6373
6374		if (cdb->byte2 & SMS_DBD)
6375			dbd = 1;
6376		else
6377			header_len += sizeof(struct scsi_mode_block_descr);
6378		if (cdb->byte2 & SMS10_LLBAA)
6379			llba = 1;
6380		pc = (cdb->page & SMS_PAGE_CTRL_MASK) >> 6;
6381		page_code = cdb->page & SMS_PAGE_CODE;
6382		subpage = cdb->subpage;
6383		alloc_len = scsi_2btoul(cdb->length);
6384		break;
6385	}
6386	default:
6387		ctl_set_invalid_opcode(ctsio);
6388		ctl_done((union ctl_io *)ctsio);
6389		return (CTL_RETVAL_COMPLETE);
6390		break; /* NOTREACHED */
6391	}
6392
6393	/*
6394	 * We have to make a first pass through to calculate the size of
6395	 * the pages that match the user's query.  Then we allocate enough
6396	 * memory to hold it, and actually copy the data into the buffer.
6397	 */
6398	switch (page_code) {
6399	case SMS_ALL_PAGES_PAGE: {
6400		int i;
6401
6402		page_len = 0;
6403
6404		/*
6405		 * At the moment, values other than 0 and 0xff here are
6406		 * reserved according to SPC-3.
6407		 */
6408		if ((subpage != SMS_SUBPAGE_PAGE_0)
6409		 && (subpage != SMS_SUBPAGE_ALL)) {
6410			ctl_set_invalid_field(ctsio,
6411					      /*sks_valid*/ 1,
6412					      /*command*/ 1,
6413					      /*field*/ 3,
6414					      /*bit_valid*/ 0,
6415					      /*bit*/ 0);
6416			ctl_done((union ctl_io *)ctsio);
6417			return (CTL_RETVAL_COMPLETE);
6418		}
6419
6420		for (i = 0; i < CTL_NUM_MODE_PAGES; i++) {
6421			page_index = &lun->mode_pages.index[i];
6422
6423			/* Make sure the page is supported for this dev type */
6424			if (lun->be_lun->lun_type == T_DIRECT &&
6425			    (page_index->page_flags & CTL_PAGE_FLAG_DIRECT) == 0)
6426				continue;
6427			if (lun->be_lun->lun_type == T_PROCESSOR &&
6428			    (page_index->page_flags & CTL_PAGE_FLAG_PROC) == 0)
6429				continue;
6430			if (lun->be_lun->lun_type == T_CDROM &&
6431			    (page_index->page_flags & CTL_PAGE_FLAG_CDROM) == 0)
6432				continue;
6433
6434			/*
6435			 * We don't use this subpage if the user didn't
6436			 * request all subpages.
6437			 */
6438			if ((page_index->subpage != 0)
6439			 && (subpage == SMS_SUBPAGE_PAGE_0))
6440				continue;
6441
6442#if 0
6443			printf("found page %#x len %d\n",
6444			       page_index->page_code & SMPH_PC_MASK,
6445			       page_index->page_len);
6446#endif
6447			page_len += page_index->page_len;
6448		}
6449		break;
6450	}
6451	default: {
6452		int i;
6453
6454		page_len = 0;
6455
6456		for (i = 0; i < CTL_NUM_MODE_PAGES; i++) {
6457			page_index = &lun->mode_pages.index[i];
6458
6459			/* Make sure the page is supported for this dev type */
6460			if (lun->be_lun->lun_type == T_DIRECT &&
6461			    (page_index->page_flags & CTL_PAGE_FLAG_DIRECT) == 0)
6462				continue;
6463			if (lun->be_lun->lun_type == T_PROCESSOR &&
6464			    (page_index->page_flags & CTL_PAGE_FLAG_PROC) == 0)
6465				continue;
6466			if (lun->be_lun->lun_type == T_CDROM &&
6467			    (page_index->page_flags & CTL_PAGE_FLAG_CDROM) == 0)
6468				continue;
6469
6470			/* Look for the right page code */
6471			if ((page_index->page_code & SMPH_PC_MASK) != page_code)
6472				continue;
6473
6474			/* Look for the right subpage or the subpage wildcard*/
6475			if ((page_index->subpage != subpage)
6476			 && (subpage != SMS_SUBPAGE_ALL))
6477				continue;
6478
6479#if 0
6480			printf("found page %#x len %d\n",
6481			       page_index->page_code & SMPH_PC_MASK,
6482			       page_index->page_len);
6483#endif
6484
6485			page_len += page_index->page_len;
6486		}
6487
6488		if (page_len == 0) {
6489			ctl_set_invalid_field(ctsio,
6490					      /*sks_valid*/ 1,
6491					      /*command*/ 1,
6492					      /*field*/ 2,
6493					      /*bit_valid*/ 1,
6494					      /*bit*/ 5);
6495			ctl_done((union ctl_io *)ctsio);
6496			return (CTL_RETVAL_COMPLETE);
6497		}
6498		break;
6499	}
6500	}
6501
6502	total_len = header_len + page_len;
6503#if 0
6504	printf("header_len = %d, page_len = %d, total_len = %d\n",
6505	       header_len, page_len, total_len);
6506#endif
6507
6508	ctsio->kern_data_ptr = malloc(total_len, M_CTL, M_WAITOK | M_ZERO);
6509	ctsio->kern_sg_entries = 0;
6510	ctsio->kern_data_resid = 0;
6511	ctsio->kern_rel_offset = 0;
6512	if (total_len < alloc_len) {
6513		ctsio->residual = alloc_len - total_len;
6514		ctsio->kern_data_len = total_len;
6515		ctsio->kern_total_len = total_len;
6516	} else {
6517		ctsio->residual = 0;
6518		ctsio->kern_data_len = alloc_len;
6519		ctsio->kern_total_len = alloc_len;
6520	}
6521
6522	switch (ctsio->cdb[0]) {
6523	case MODE_SENSE_6: {
6524		struct scsi_mode_hdr_6 *header;
6525
6526		header = (struct scsi_mode_hdr_6 *)ctsio->kern_data_ptr;
6527
6528		header->datalen = MIN(total_len - 1, 254);
6529		if (lun->be_lun->lun_type == T_DIRECT) {
6530			header->dev_specific = 0x10; /* DPOFUA */
6531			if ((lun->be_lun->flags & CTL_LUN_FLAG_READONLY) ||
6532			    (lun->mode_pages.control_page[CTL_PAGE_CURRENT]
6533			    .eca_and_aen & SCP_SWP) != 0)
6534				    header->dev_specific |= 0x80; /* WP */
6535		}
6536		if (dbd)
6537			header->block_descr_len = 0;
6538		else
6539			header->block_descr_len =
6540				sizeof(struct scsi_mode_block_descr);
6541		block_desc = (struct scsi_mode_block_descr *)&header[1];
6542		break;
6543	}
6544	case MODE_SENSE_10: {
6545		struct scsi_mode_hdr_10 *header;
6546		int datalen;
6547
6548		header = (struct scsi_mode_hdr_10 *)ctsio->kern_data_ptr;
6549
6550		datalen = MIN(total_len - 2, 65533);
6551		scsi_ulto2b(datalen, header->datalen);
6552		if (lun->be_lun->lun_type == T_DIRECT) {
6553			header->dev_specific = 0x10; /* DPOFUA */
6554			if ((lun->be_lun->flags & CTL_LUN_FLAG_READONLY) ||
6555			    (lun->mode_pages.control_page[CTL_PAGE_CURRENT]
6556			    .eca_and_aen & SCP_SWP) != 0)
6557				    header->dev_specific |= 0x80; /* WP */
6558		}
6559		if (dbd)
6560			scsi_ulto2b(0, header->block_descr_len);
6561		else
6562			scsi_ulto2b(sizeof(struct scsi_mode_block_descr),
6563				    header->block_descr_len);
6564		block_desc = (struct scsi_mode_block_descr *)&header[1];
6565		break;
6566	}
6567	default:
6568		panic("%s: Invalid CDB type %#x", __func__, ctsio->cdb[0]);
6569	}
6570
6571	/*
6572	 * If we've got a disk, use its blocksize in the block
6573	 * descriptor.  Otherwise, just set it to 0.
6574	 */
6575	if (dbd == 0) {
6576		if (lun->be_lun->lun_type == T_DIRECT)
6577			scsi_ulto3b(lun->be_lun->blocksize,
6578				    block_desc->block_len);
6579		else
6580			scsi_ulto3b(0, block_desc->block_len);
6581	}
6582
6583	switch (page_code) {
6584	case SMS_ALL_PAGES_PAGE: {
6585		int i, data_used;
6586
6587		data_used = header_len;
6588		for (i = 0; i < CTL_NUM_MODE_PAGES; i++) {
6589			struct ctl_page_index *page_index;
6590
6591			page_index = &lun->mode_pages.index[i];
6592			if (lun->be_lun->lun_type == T_DIRECT &&
6593			    (page_index->page_flags & CTL_PAGE_FLAG_DIRECT) == 0)
6594				continue;
6595			if (lun->be_lun->lun_type == T_PROCESSOR &&
6596			    (page_index->page_flags & CTL_PAGE_FLAG_PROC) == 0)
6597				continue;
6598			if (lun->be_lun->lun_type == T_CDROM &&
6599			    (page_index->page_flags & CTL_PAGE_FLAG_CDROM) == 0)
6600				continue;
6601
6602			/*
6603			 * We don't use this subpage if the user didn't
6604			 * request all subpages.  We already checked (above)
6605			 * to make sure the user only specified a subpage
6606			 * of 0 or 0xff in the SMS_ALL_PAGES_PAGE case.
6607			 */
6608			if ((page_index->subpage != 0)
6609			 && (subpage == SMS_SUBPAGE_PAGE_0))
6610				continue;
6611
6612			/*
6613			 * Call the handler, if it exists, to update the
6614			 * page to the latest values.
6615			 */
6616			if (page_index->sense_handler != NULL)
6617				page_index->sense_handler(ctsio, page_index,pc);
6618
6619			memcpy(ctsio->kern_data_ptr + data_used,
6620			       page_index->page_data +
6621			       (page_index->page_len * pc),
6622			       page_index->page_len);
6623			data_used += page_index->page_len;
6624		}
6625		break;
6626	}
6627	default: {
6628		int i, data_used;
6629
6630		data_used = header_len;
6631
6632		for (i = 0; i < CTL_NUM_MODE_PAGES; i++) {
6633			struct ctl_page_index *page_index;
6634
6635			page_index = &lun->mode_pages.index[i];
6636
6637			/* Look for the right page code */
6638			if ((page_index->page_code & SMPH_PC_MASK) != page_code)
6639				continue;
6640
6641			/* Look for the right subpage or the subpage wildcard*/
6642			if ((page_index->subpage != subpage)
6643			 && (subpage != SMS_SUBPAGE_ALL))
6644				continue;
6645
6646			/* Make sure the page is supported for this dev type */
6647			if (lun->be_lun->lun_type == T_DIRECT &&
6648			    (page_index->page_flags & CTL_PAGE_FLAG_DIRECT) == 0)
6649				continue;
6650			if (lun->be_lun->lun_type == T_PROCESSOR &&
6651			    (page_index->page_flags & CTL_PAGE_FLAG_PROC) == 0)
6652				continue;
6653			if (lun->be_lun->lun_type == T_CDROM &&
6654			    (page_index->page_flags & CTL_PAGE_FLAG_CDROM) == 0)
6655				continue;
6656
6657			/*
6658			 * Call the handler, if it exists, to update the
6659			 * page to the latest values.
6660			 */
6661			if (page_index->sense_handler != NULL)
6662				page_index->sense_handler(ctsio, page_index,pc);
6663
6664			memcpy(ctsio->kern_data_ptr + data_used,
6665			       page_index->page_data +
6666			       (page_index->page_len * pc),
6667			       page_index->page_len);
6668			data_used += page_index->page_len;
6669		}
6670		break;
6671	}
6672	}
6673
6674	ctl_set_success(ctsio);
6675	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
6676	ctsio->be_move_done = ctl_config_move_done;
6677	ctl_datamove((union ctl_io *)ctsio);
6678	return (CTL_RETVAL_COMPLETE);
6679}
6680
6681int
6682ctl_lbp_log_sense_handler(struct ctl_scsiio *ctsio,
6683			       struct ctl_page_index *page_index,
6684			       int pc)
6685{
6686	struct ctl_lun *lun;
6687	struct scsi_log_param_header *phdr;
6688	uint8_t *data;
6689	uint64_t val;
6690
6691	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
6692	data = page_index->page_data;
6693
6694	if (lun->backend->lun_attr != NULL &&
6695	    (val = lun->backend->lun_attr(lun->be_lun->be_lun, "blocksavail"))
6696	     != UINT64_MAX) {
6697		phdr = (struct scsi_log_param_header *)data;
6698		scsi_ulto2b(0x0001, phdr->param_code);
6699		phdr->param_control = SLP_LBIN | SLP_LP;
6700		phdr->param_len = 8;
6701		data = (uint8_t *)(phdr + 1);
6702		scsi_ulto4b(val >> CTL_LBP_EXPONENT, data);
6703		data[4] = 0x02; /* per-pool */
6704		data += phdr->param_len;
6705	}
6706
6707	if (lun->backend->lun_attr != NULL &&
6708	    (val = lun->backend->lun_attr(lun->be_lun->be_lun, "blocksused"))
6709	     != UINT64_MAX) {
6710		phdr = (struct scsi_log_param_header *)data;
6711		scsi_ulto2b(0x0002, phdr->param_code);
6712		phdr->param_control = SLP_LBIN | SLP_LP;
6713		phdr->param_len = 8;
6714		data = (uint8_t *)(phdr + 1);
6715		scsi_ulto4b(val >> CTL_LBP_EXPONENT, data);
6716		data[4] = 0x01; /* per-LUN */
6717		data += phdr->param_len;
6718	}
6719
6720	if (lun->backend->lun_attr != NULL &&
6721	    (val = lun->backend->lun_attr(lun->be_lun->be_lun, "poolblocksavail"))
6722	     != UINT64_MAX) {
6723		phdr = (struct scsi_log_param_header *)data;
6724		scsi_ulto2b(0x00f1, phdr->param_code);
6725		phdr->param_control = SLP_LBIN | SLP_LP;
6726		phdr->param_len = 8;
6727		data = (uint8_t *)(phdr + 1);
6728		scsi_ulto4b(val >> CTL_LBP_EXPONENT, data);
6729		data[4] = 0x02; /* per-pool */
6730		data += phdr->param_len;
6731	}
6732
6733	if (lun->backend->lun_attr != NULL &&
6734	    (val = lun->backend->lun_attr(lun->be_lun->be_lun, "poolblocksused"))
6735	     != UINT64_MAX) {
6736		phdr = (struct scsi_log_param_header *)data;
6737		scsi_ulto2b(0x00f2, phdr->param_code);
6738		phdr->param_control = SLP_LBIN | SLP_LP;
6739		phdr->param_len = 8;
6740		data = (uint8_t *)(phdr + 1);
6741		scsi_ulto4b(val >> CTL_LBP_EXPONENT, data);
6742		data[4] = 0x02; /* per-pool */
6743		data += phdr->param_len;
6744	}
6745
6746	page_index->page_len = data - page_index->page_data;
6747	return (0);
6748}
6749
6750int
6751ctl_sap_log_sense_handler(struct ctl_scsiio *ctsio,
6752			       struct ctl_page_index *page_index,
6753			       int pc)
6754{
6755	struct ctl_lun *lun;
6756	struct stat_page *data;
6757	uint64_t rn, wn, rb, wb;
6758	struct bintime rt, wt;
6759	int i;
6760
6761	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
6762	data = (struct stat_page *)page_index->page_data;
6763
6764	scsi_ulto2b(SLP_SAP, data->sap.hdr.param_code);
6765	data->sap.hdr.param_control = SLP_LBIN;
6766	data->sap.hdr.param_len = sizeof(struct scsi_log_stat_and_perf) -
6767	    sizeof(struct scsi_log_param_header);
6768	rn = wn = rb = wb = 0;
6769	bintime_clear(&rt);
6770	bintime_clear(&wt);
6771	for (i = 0; i < CTL_MAX_PORTS; i++) {
6772		rn += lun->stats.ports[i].operations[CTL_STATS_READ];
6773		wn += lun->stats.ports[i].operations[CTL_STATS_WRITE];
6774		rb += lun->stats.ports[i].bytes[CTL_STATS_READ];
6775		wb += lun->stats.ports[i].bytes[CTL_STATS_WRITE];
6776		bintime_add(&rt, &lun->stats.ports[i].time[CTL_STATS_READ]);
6777		bintime_add(&wt, &lun->stats.ports[i].time[CTL_STATS_WRITE]);
6778	}
6779	scsi_u64to8b(rn, data->sap.read_num);
6780	scsi_u64to8b(wn, data->sap.write_num);
6781	if (lun->stats.blocksize > 0) {
6782		scsi_u64to8b(wb / lun->stats.blocksize,
6783		    data->sap.recvieved_lba);
6784		scsi_u64to8b(rb / lun->stats.blocksize,
6785		    data->sap.transmitted_lba);
6786	}
6787	scsi_u64to8b((uint64_t)rt.sec * 1000 + rt.frac / (UINT64_MAX / 1000),
6788	    data->sap.read_int);
6789	scsi_u64to8b((uint64_t)wt.sec * 1000 + wt.frac / (UINT64_MAX / 1000),
6790	    data->sap.write_int);
6791	scsi_u64to8b(0, data->sap.weighted_num);
6792	scsi_u64to8b(0, data->sap.weighted_int);
6793	scsi_ulto2b(SLP_IT, data->it.hdr.param_code);
6794	data->it.hdr.param_control = SLP_LBIN;
6795	data->it.hdr.param_len = sizeof(struct scsi_log_idle_time) -
6796	    sizeof(struct scsi_log_param_header);
6797#ifdef CTL_TIME_IO
6798	scsi_u64to8b(lun->idle_time / SBT_1MS, data->it.idle_int);
6799#endif
6800	scsi_ulto2b(SLP_TI, data->ti.hdr.param_code);
6801	data->it.hdr.param_control = SLP_LBIN;
6802	data->ti.hdr.param_len = sizeof(struct scsi_log_time_interval) -
6803	    sizeof(struct scsi_log_param_header);
6804	scsi_ulto4b(3, data->ti.exponent);
6805	scsi_ulto4b(1, data->ti.integer);
6806
6807	page_index->page_len = sizeof(*data);
6808	return (0);
6809}
6810
6811int
6812ctl_log_sense(struct ctl_scsiio *ctsio)
6813{
6814	struct ctl_lun *lun;
6815	int i, pc, page_code, subpage;
6816	int alloc_len, total_len;
6817	struct ctl_page_index *page_index;
6818	struct scsi_log_sense *cdb;
6819	struct scsi_log_header *header;
6820
6821	CTL_DEBUG_PRINT(("ctl_log_sense\n"));
6822
6823	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
6824	cdb = (struct scsi_log_sense *)ctsio->cdb;
6825	pc = (cdb->page & SLS_PAGE_CTRL_MASK) >> 6;
6826	page_code = cdb->page & SLS_PAGE_CODE;
6827	subpage = cdb->subpage;
6828	alloc_len = scsi_2btoul(cdb->length);
6829
6830	page_index = NULL;
6831	for (i = 0; i < CTL_NUM_LOG_PAGES; i++) {
6832		page_index = &lun->log_pages.index[i];
6833
6834		/* Look for the right page code */
6835		if ((page_index->page_code & SL_PAGE_CODE) != page_code)
6836			continue;
6837
6838		/* Look for the right subpage or the subpage wildcard*/
6839		if (page_index->subpage != subpage)
6840			continue;
6841
6842		break;
6843	}
6844	if (i >= CTL_NUM_LOG_PAGES) {
6845		ctl_set_invalid_field(ctsio,
6846				      /*sks_valid*/ 1,
6847				      /*command*/ 1,
6848				      /*field*/ 2,
6849				      /*bit_valid*/ 0,
6850				      /*bit*/ 0);
6851		ctl_done((union ctl_io *)ctsio);
6852		return (CTL_RETVAL_COMPLETE);
6853	}
6854
6855	total_len = sizeof(struct scsi_log_header) + page_index->page_len;
6856
6857	ctsio->kern_data_ptr = malloc(total_len, M_CTL, M_WAITOK | M_ZERO);
6858	ctsio->kern_sg_entries = 0;
6859	ctsio->kern_data_resid = 0;
6860	ctsio->kern_rel_offset = 0;
6861	if (total_len < alloc_len) {
6862		ctsio->residual = alloc_len - total_len;
6863		ctsio->kern_data_len = total_len;
6864		ctsio->kern_total_len = total_len;
6865	} else {
6866		ctsio->residual = 0;
6867		ctsio->kern_data_len = alloc_len;
6868		ctsio->kern_total_len = alloc_len;
6869	}
6870
6871	header = (struct scsi_log_header *)ctsio->kern_data_ptr;
6872	header->page = page_index->page_code;
6873	if (page_index->subpage) {
6874		header->page |= SL_SPF;
6875		header->subpage = page_index->subpage;
6876	}
6877	scsi_ulto2b(page_index->page_len, header->datalen);
6878
6879	/*
6880	 * Call the handler, if it exists, to update the
6881	 * page to the latest values.
6882	 */
6883	if (page_index->sense_handler != NULL)
6884		page_index->sense_handler(ctsio, page_index, pc);
6885
6886	memcpy(header + 1, page_index->page_data, page_index->page_len);
6887
6888	ctl_set_success(ctsio);
6889	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
6890	ctsio->be_move_done = ctl_config_move_done;
6891	ctl_datamove((union ctl_io *)ctsio);
6892	return (CTL_RETVAL_COMPLETE);
6893}
6894
6895int
6896ctl_read_capacity(struct ctl_scsiio *ctsio)
6897{
6898	struct scsi_read_capacity *cdb;
6899	struct scsi_read_capacity_data *data;
6900	struct ctl_lun *lun;
6901	uint32_t lba;
6902
6903	CTL_DEBUG_PRINT(("ctl_read_capacity\n"));
6904
6905	cdb = (struct scsi_read_capacity *)ctsio->cdb;
6906
6907	lba = scsi_4btoul(cdb->addr);
6908	if (((cdb->pmi & SRC_PMI) == 0)
6909	 && (lba != 0)) {
6910		ctl_set_invalid_field(/*ctsio*/ ctsio,
6911				      /*sks_valid*/ 1,
6912				      /*command*/ 1,
6913				      /*field*/ 2,
6914				      /*bit_valid*/ 0,
6915				      /*bit*/ 0);
6916		ctl_done((union ctl_io *)ctsio);
6917		return (CTL_RETVAL_COMPLETE);
6918	}
6919
6920	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
6921
6922	ctsio->kern_data_ptr = malloc(sizeof(*data), M_CTL, M_WAITOK | M_ZERO);
6923	data = (struct scsi_read_capacity_data *)ctsio->kern_data_ptr;
6924	ctsio->residual = 0;
6925	ctsio->kern_data_len = sizeof(*data);
6926	ctsio->kern_total_len = sizeof(*data);
6927	ctsio->kern_data_resid = 0;
6928	ctsio->kern_rel_offset = 0;
6929	ctsio->kern_sg_entries = 0;
6930
6931	/*
6932	 * If the maximum LBA is greater than 0xfffffffe, the user must
6933	 * issue a SERVICE ACTION IN (16) command, with the read capacity
6934	 * serivce action set.
6935	 */
6936	if (lun->be_lun->maxlba > 0xfffffffe)
6937		scsi_ulto4b(0xffffffff, data->addr);
6938	else
6939		scsi_ulto4b(lun->be_lun->maxlba, data->addr);
6940
6941	/*
6942	 * XXX KDM this may not be 512 bytes...
6943	 */
6944	scsi_ulto4b(lun->be_lun->blocksize, data->length);
6945
6946	ctl_set_success(ctsio);
6947	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
6948	ctsio->be_move_done = ctl_config_move_done;
6949	ctl_datamove((union ctl_io *)ctsio);
6950	return (CTL_RETVAL_COMPLETE);
6951}
6952
6953int
6954ctl_read_capacity_16(struct ctl_scsiio *ctsio)
6955{
6956	struct scsi_read_capacity_16 *cdb;
6957	struct scsi_read_capacity_data_long *data;
6958	struct ctl_lun *lun;
6959	uint64_t lba;
6960	uint32_t alloc_len;
6961
6962	CTL_DEBUG_PRINT(("ctl_read_capacity_16\n"));
6963
6964	cdb = (struct scsi_read_capacity_16 *)ctsio->cdb;
6965
6966	alloc_len = scsi_4btoul(cdb->alloc_len);
6967	lba = scsi_8btou64(cdb->addr);
6968
6969	if ((cdb->reladr & SRC16_PMI)
6970	 && (lba != 0)) {
6971		ctl_set_invalid_field(/*ctsio*/ ctsio,
6972				      /*sks_valid*/ 1,
6973				      /*command*/ 1,
6974				      /*field*/ 2,
6975				      /*bit_valid*/ 0,
6976				      /*bit*/ 0);
6977		ctl_done((union ctl_io *)ctsio);
6978		return (CTL_RETVAL_COMPLETE);
6979	}
6980
6981	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
6982
6983	ctsio->kern_data_ptr = malloc(sizeof(*data), M_CTL, M_WAITOK | M_ZERO);
6984	data = (struct scsi_read_capacity_data_long *)ctsio->kern_data_ptr;
6985
6986	if (sizeof(*data) < alloc_len) {
6987		ctsio->residual = alloc_len - sizeof(*data);
6988		ctsio->kern_data_len = sizeof(*data);
6989		ctsio->kern_total_len = sizeof(*data);
6990	} else {
6991		ctsio->residual = 0;
6992		ctsio->kern_data_len = alloc_len;
6993		ctsio->kern_total_len = alloc_len;
6994	}
6995	ctsio->kern_data_resid = 0;
6996	ctsio->kern_rel_offset = 0;
6997	ctsio->kern_sg_entries = 0;
6998
6999	scsi_u64to8b(lun->be_lun->maxlba, data->addr);
7000	/* XXX KDM this may not be 512 bytes... */
7001	scsi_ulto4b(lun->be_lun->blocksize, data->length);
7002	data->prot_lbppbe = lun->be_lun->pblockexp & SRC16_LBPPBE;
7003	scsi_ulto2b(lun->be_lun->pblockoff & SRC16_LALBA_A, data->lalba_lbp);
7004	if (lun->be_lun->flags & CTL_LUN_FLAG_UNMAP)
7005		data->lalba_lbp[0] |= SRC16_LBPME | SRC16_LBPRZ;
7006
7007	ctl_set_success(ctsio);
7008	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
7009	ctsio->be_move_done = ctl_config_move_done;
7010	ctl_datamove((union ctl_io *)ctsio);
7011	return (CTL_RETVAL_COMPLETE);
7012}
7013
7014int
7015ctl_get_lba_status(struct ctl_scsiio *ctsio)
7016{
7017	struct scsi_get_lba_status *cdb;
7018	struct scsi_get_lba_status_data *data;
7019	struct ctl_lun *lun;
7020	struct ctl_lba_len_flags *lbalen;
7021	uint64_t lba;
7022	uint32_t alloc_len, total_len;
7023	int retval;
7024
7025	CTL_DEBUG_PRINT(("ctl_get_lba_status\n"));
7026
7027	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
7028	cdb = (struct scsi_get_lba_status *)ctsio->cdb;
7029	lba = scsi_8btou64(cdb->addr);
7030	alloc_len = scsi_4btoul(cdb->alloc_len);
7031
7032	if (lba > lun->be_lun->maxlba) {
7033		ctl_set_lba_out_of_range(ctsio);
7034		ctl_done((union ctl_io *)ctsio);
7035		return (CTL_RETVAL_COMPLETE);
7036	}
7037
7038	total_len = sizeof(*data) + sizeof(data->descr[0]);
7039	ctsio->kern_data_ptr = malloc(total_len, M_CTL, M_WAITOK | M_ZERO);
7040	data = (struct scsi_get_lba_status_data *)ctsio->kern_data_ptr;
7041
7042	if (total_len < alloc_len) {
7043		ctsio->residual = alloc_len - total_len;
7044		ctsio->kern_data_len = total_len;
7045		ctsio->kern_total_len = total_len;
7046	} else {
7047		ctsio->residual = 0;
7048		ctsio->kern_data_len = alloc_len;
7049		ctsio->kern_total_len = alloc_len;
7050	}
7051	ctsio->kern_data_resid = 0;
7052	ctsio->kern_rel_offset = 0;
7053	ctsio->kern_sg_entries = 0;
7054
7055	/* Fill dummy data in case backend can't tell anything. */
7056	scsi_ulto4b(4 + sizeof(data->descr[0]), data->length);
7057	scsi_u64to8b(lba, data->descr[0].addr);
7058	scsi_ulto4b(MIN(UINT32_MAX, lun->be_lun->maxlba + 1 - lba),
7059	    data->descr[0].length);
7060	data->descr[0].status = 0; /* Mapped or unknown. */
7061
7062	ctl_set_success(ctsio);
7063	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
7064	ctsio->be_move_done = ctl_config_move_done;
7065
7066	lbalen = (struct ctl_lba_len_flags *)&ctsio->io_hdr.ctl_private[CTL_PRIV_LBA_LEN];
7067	lbalen->lba = lba;
7068	lbalen->len = total_len;
7069	lbalen->flags = 0;
7070	retval = lun->backend->config_read((union ctl_io *)ctsio);
7071	return (CTL_RETVAL_COMPLETE);
7072}
7073
7074int
7075ctl_read_defect(struct ctl_scsiio *ctsio)
7076{
7077	struct scsi_read_defect_data_10 *ccb10;
7078	struct scsi_read_defect_data_12 *ccb12;
7079	struct scsi_read_defect_data_hdr_10 *data10;
7080	struct scsi_read_defect_data_hdr_12 *data12;
7081	uint32_t alloc_len, data_len;
7082	uint8_t format;
7083
7084	CTL_DEBUG_PRINT(("ctl_read_defect\n"));
7085
7086	if (ctsio->cdb[0] == READ_DEFECT_DATA_10) {
7087		ccb10 = (struct scsi_read_defect_data_10 *)&ctsio->cdb;
7088		format = ccb10->format;
7089		alloc_len = scsi_2btoul(ccb10->alloc_length);
7090		data_len = sizeof(*data10);
7091	} else {
7092		ccb12 = (struct scsi_read_defect_data_12 *)&ctsio->cdb;
7093		format = ccb12->format;
7094		alloc_len = scsi_4btoul(ccb12->alloc_length);
7095		data_len = sizeof(*data12);
7096	}
7097	if (alloc_len == 0) {
7098		ctl_set_success(ctsio);
7099		ctl_done((union ctl_io *)ctsio);
7100		return (CTL_RETVAL_COMPLETE);
7101	}
7102
7103	ctsio->kern_data_ptr = malloc(data_len, M_CTL, M_WAITOK | M_ZERO);
7104	if (data_len < alloc_len) {
7105		ctsio->residual = alloc_len - data_len;
7106		ctsio->kern_data_len = data_len;
7107		ctsio->kern_total_len = data_len;
7108	} else {
7109		ctsio->residual = 0;
7110		ctsio->kern_data_len = alloc_len;
7111		ctsio->kern_total_len = alloc_len;
7112	}
7113	ctsio->kern_data_resid = 0;
7114	ctsio->kern_rel_offset = 0;
7115	ctsio->kern_sg_entries = 0;
7116
7117	if (ctsio->cdb[0] == READ_DEFECT_DATA_10) {
7118		data10 = (struct scsi_read_defect_data_hdr_10 *)
7119		    ctsio->kern_data_ptr;
7120		data10->format = format;
7121		scsi_ulto2b(0, data10->length);
7122	} else {
7123		data12 = (struct scsi_read_defect_data_hdr_12 *)
7124		    ctsio->kern_data_ptr;
7125		data12->format = format;
7126		scsi_ulto2b(0, data12->generation);
7127		scsi_ulto4b(0, data12->length);
7128	}
7129
7130	ctl_set_success(ctsio);
7131	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
7132	ctsio->be_move_done = ctl_config_move_done;
7133	ctl_datamove((union ctl_io *)ctsio);
7134	return (CTL_RETVAL_COMPLETE);
7135}
7136
7137int
7138ctl_report_tagret_port_groups(struct ctl_scsiio *ctsio)
7139{
7140	struct scsi_maintenance_in *cdb;
7141	int retval;
7142	int alloc_len, ext, total_len = 0, g, pc, pg, ts, os;
7143	int num_ha_groups, num_target_ports, shared_group;
7144	struct ctl_lun *lun;
7145	struct ctl_softc *softc;
7146	struct ctl_port *port;
7147	struct scsi_target_group_data *rtg_ptr;
7148	struct scsi_target_group_data_extended *rtg_ext_ptr;
7149	struct scsi_target_port_group_descriptor *tpg_desc;
7150
7151	CTL_DEBUG_PRINT(("ctl_report_tagret_port_groups\n"));
7152
7153	cdb = (struct scsi_maintenance_in *)ctsio->cdb;
7154	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
7155	softc = lun->ctl_softc;
7156
7157	retval = CTL_RETVAL_COMPLETE;
7158
7159	switch (cdb->byte2 & STG_PDF_MASK) {
7160	case STG_PDF_LENGTH:
7161		ext = 0;
7162		break;
7163	case STG_PDF_EXTENDED:
7164		ext = 1;
7165		break;
7166	default:
7167		ctl_set_invalid_field(/*ctsio*/ ctsio,
7168				      /*sks_valid*/ 1,
7169				      /*command*/ 1,
7170				      /*field*/ 2,
7171				      /*bit_valid*/ 1,
7172				      /*bit*/ 5);
7173		ctl_done((union ctl_io *)ctsio);
7174		return(retval);
7175	}
7176
7177	num_target_ports = 0;
7178	shared_group = (softc->is_single != 0);
7179	mtx_lock(&softc->ctl_lock);
7180	STAILQ_FOREACH(port, &softc->port_list, links) {
7181		if ((port->status & CTL_PORT_STATUS_ONLINE) == 0)
7182			continue;
7183		if (ctl_lun_map_to_port(port, lun->lun) >= CTL_MAX_LUNS)
7184			continue;
7185		num_target_ports++;
7186		if (port->status & CTL_PORT_STATUS_HA_SHARED)
7187			shared_group = 1;
7188	}
7189	mtx_unlock(&softc->ctl_lock);
7190	num_ha_groups = (softc->is_single) ? 0 : NUM_HA_SHELVES;
7191
7192	if (ext)
7193		total_len = sizeof(struct scsi_target_group_data_extended);
7194	else
7195		total_len = sizeof(struct scsi_target_group_data);
7196	total_len += sizeof(struct scsi_target_port_group_descriptor) *
7197		(shared_group + num_ha_groups) +
7198	    sizeof(struct scsi_target_port_descriptor) * num_target_ports;
7199
7200	alloc_len = scsi_4btoul(cdb->length);
7201
7202	ctsio->kern_data_ptr = malloc(total_len, M_CTL, M_WAITOK | M_ZERO);
7203
7204	ctsio->kern_sg_entries = 0;
7205
7206	if (total_len < alloc_len) {
7207		ctsio->residual = alloc_len - total_len;
7208		ctsio->kern_data_len = total_len;
7209		ctsio->kern_total_len = total_len;
7210	} else {
7211		ctsio->residual = 0;
7212		ctsio->kern_data_len = alloc_len;
7213		ctsio->kern_total_len = alloc_len;
7214	}
7215	ctsio->kern_data_resid = 0;
7216	ctsio->kern_rel_offset = 0;
7217
7218	if (ext) {
7219		rtg_ext_ptr = (struct scsi_target_group_data_extended *)
7220		    ctsio->kern_data_ptr;
7221		scsi_ulto4b(total_len - 4, rtg_ext_ptr->length);
7222		rtg_ext_ptr->format_type = 0x10;
7223		rtg_ext_ptr->implicit_transition_time = 0;
7224		tpg_desc = &rtg_ext_ptr->groups[0];
7225	} else {
7226		rtg_ptr = (struct scsi_target_group_data *)
7227		    ctsio->kern_data_ptr;
7228		scsi_ulto4b(total_len - 4, rtg_ptr->length);
7229		tpg_desc = &rtg_ptr->groups[0];
7230	}
7231
7232	mtx_lock(&softc->ctl_lock);
7233	pg = softc->port_min / softc->port_cnt;
7234	if (lun->flags & (CTL_LUN_PRIMARY_SC | CTL_LUN_PEER_SC_PRIMARY)) {
7235		/* Some shelf is known to be primary. */
7236		if (softc->ha_link == CTL_HA_LINK_OFFLINE)
7237			os = TPG_ASYMMETRIC_ACCESS_UNAVAILABLE;
7238		else if (softc->ha_link == CTL_HA_LINK_UNKNOWN)
7239			os = TPG_ASYMMETRIC_ACCESS_TRANSITIONING;
7240		else if (softc->ha_mode == CTL_HA_MODE_ACT_STBY)
7241			os = TPG_ASYMMETRIC_ACCESS_STANDBY;
7242		else
7243			os = TPG_ASYMMETRIC_ACCESS_NONOPTIMIZED;
7244		if (lun->flags & CTL_LUN_PRIMARY_SC) {
7245			ts = TPG_ASYMMETRIC_ACCESS_OPTIMIZED;
7246		} else {
7247			ts = os;
7248			os = TPG_ASYMMETRIC_ACCESS_OPTIMIZED;
7249		}
7250	} else {
7251		/* No known primary shelf. */
7252		if (softc->ha_link == CTL_HA_LINK_OFFLINE) {
7253			ts = TPG_ASYMMETRIC_ACCESS_UNAVAILABLE;
7254			os = TPG_ASYMMETRIC_ACCESS_OPTIMIZED;
7255		} else if (softc->ha_link == CTL_HA_LINK_UNKNOWN) {
7256			ts = TPG_ASYMMETRIC_ACCESS_TRANSITIONING;
7257			os = TPG_ASYMMETRIC_ACCESS_OPTIMIZED;
7258		} else {
7259			ts = os = TPG_ASYMMETRIC_ACCESS_TRANSITIONING;
7260		}
7261	}
7262	if (shared_group) {
7263		tpg_desc->pref_state = ts;
7264		tpg_desc->support = TPG_AO_SUP | TPG_AN_SUP | TPG_S_SUP |
7265		    TPG_U_SUP | TPG_T_SUP;
7266		scsi_ulto2b(1, tpg_desc->target_port_group);
7267		tpg_desc->status = TPG_IMPLICIT;
7268		pc = 0;
7269		STAILQ_FOREACH(port, &softc->port_list, links) {
7270			if ((port->status & CTL_PORT_STATUS_ONLINE) == 0)
7271				continue;
7272			if (!softc->is_single &&
7273			    (port->status & CTL_PORT_STATUS_HA_SHARED) == 0)
7274				continue;
7275			if (ctl_lun_map_to_port(port, lun->lun) >= CTL_MAX_LUNS)
7276				continue;
7277			scsi_ulto2b(port->targ_port, tpg_desc->descriptors[pc].
7278			    relative_target_port_identifier);
7279			pc++;
7280		}
7281		tpg_desc->target_port_count = pc;
7282		tpg_desc = (struct scsi_target_port_group_descriptor *)
7283		    &tpg_desc->descriptors[pc];
7284	}
7285	for (g = 0; g < num_ha_groups; g++) {
7286		tpg_desc->pref_state = (g == pg) ? ts : os;
7287		tpg_desc->support = TPG_AO_SUP | TPG_AN_SUP | TPG_S_SUP |
7288		    TPG_U_SUP | TPG_T_SUP;
7289		scsi_ulto2b(2 + g, tpg_desc->target_port_group);
7290		tpg_desc->status = TPG_IMPLICIT;
7291		pc = 0;
7292		STAILQ_FOREACH(port, &softc->port_list, links) {
7293			if (port->targ_port < g * softc->port_cnt ||
7294			    port->targ_port >= (g + 1) * softc->port_cnt)
7295				continue;
7296			if ((port->status & CTL_PORT_STATUS_ONLINE) == 0)
7297				continue;
7298			if (port->status & CTL_PORT_STATUS_HA_SHARED)
7299				continue;
7300			if (ctl_lun_map_to_port(port, lun->lun) >= CTL_MAX_LUNS)
7301				continue;
7302			scsi_ulto2b(port->targ_port, tpg_desc->descriptors[pc].
7303			    relative_target_port_identifier);
7304			pc++;
7305		}
7306		tpg_desc->target_port_count = pc;
7307		tpg_desc = (struct scsi_target_port_group_descriptor *)
7308		    &tpg_desc->descriptors[pc];
7309	}
7310	mtx_unlock(&softc->ctl_lock);
7311
7312	ctl_set_success(ctsio);
7313	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
7314	ctsio->be_move_done = ctl_config_move_done;
7315	ctl_datamove((union ctl_io *)ctsio);
7316	return(retval);
7317}
7318
7319int
7320ctl_report_supported_opcodes(struct ctl_scsiio *ctsio)
7321{
7322	struct ctl_lun *lun;
7323	struct scsi_report_supported_opcodes *cdb;
7324	const struct ctl_cmd_entry *entry, *sentry;
7325	struct scsi_report_supported_opcodes_all *all;
7326	struct scsi_report_supported_opcodes_descr *descr;
7327	struct scsi_report_supported_opcodes_one *one;
7328	int retval;
7329	int alloc_len, total_len;
7330	int opcode, service_action, i, j, num;
7331
7332	CTL_DEBUG_PRINT(("ctl_report_supported_opcodes\n"));
7333
7334	cdb = (struct scsi_report_supported_opcodes *)ctsio->cdb;
7335	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
7336
7337	retval = CTL_RETVAL_COMPLETE;
7338
7339	opcode = cdb->requested_opcode;
7340	service_action = scsi_2btoul(cdb->requested_service_action);
7341	switch (cdb->options & RSO_OPTIONS_MASK) {
7342	case RSO_OPTIONS_ALL:
7343		num = 0;
7344		for (i = 0; i < 256; i++) {
7345			entry = &ctl_cmd_table[i];
7346			if (entry->flags & CTL_CMD_FLAG_SA5) {
7347				for (j = 0; j < 32; j++) {
7348					sentry = &((const struct ctl_cmd_entry *)
7349					    entry->execute)[j];
7350					if (ctl_cmd_applicable(
7351					    lun->be_lun->lun_type, sentry))
7352						num++;
7353				}
7354			} else {
7355				if (ctl_cmd_applicable(lun->be_lun->lun_type,
7356				    entry))
7357					num++;
7358			}
7359		}
7360		total_len = sizeof(struct scsi_report_supported_opcodes_all) +
7361		    num * sizeof(struct scsi_report_supported_opcodes_descr);
7362		break;
7363	case RSO_OPTIONS_OC:
7364		if (ctl_cmd_table[opcode].flags & CTL_CMD_FLAG_SA5) {
7365			ctl_set_invalid_field(/*ctsio*/ ctsio,
7366					      /*sks_valid*/ 1,
7367					      /*command*/ 1,
7368					      /*field*/ 2,
7369					      /*bit_valid*/ 1,
7370					      /*bit*/ 2);
7371			ctl_done((union ctl_io *)ctsio);
7372			return (CTL_RETVAL_COMPLETE);
7373		}
7374		total_len = sizeof(struct scsi_report_supported_opcodes_one) + 32;
7375		break;
7376	case RSO_OPTIONS_OC_SA:
7377		if ((ctl_cmd_table[opcode].flags & CTL_CMD_FLAG_SA5) == 0 ||
7378		    service_action >= 32) {
7379			ctl_set_invalid_field(/*ctsio*/ ctsio,
7380					      /*sks_valid*/ 1,
7381					      /*command*/ 1,
7382					      /*field*/ 2,
7383					      /*bit_valid*/ 1,
7384					      /*bit*/ 2);
7385			ctl_done((union ctl_io *)ctsio);
7386			return (CTL_RETVAL_COMPLETE);
7387		}
7388		total_len = sizeof(struct scsi_report_supported_opcodes_one) + 32;
7389		break;
7390	default:
7391		ctl_set_invalid_field(/*ctsio*/ ctsio,
7392				      /*sks_valid*/ 1,
7393				      /*command*/ 1,
7394				      /*field*/ 2,
7395				      /*bit_valid*/ 1,
7396				      /*bit*/ 2);
7397		ctl_done((union ctl_io *)ctsio);
7398		return (CTL_RETVAL_COMPLETE);
7399	}
7400
7401	alloc_len = scsi_4btoul(cdb->length);
7402
7403	ctsio->kern_data_ptr = malloc(total_len, M_CTL, M_WAITOK | M_ZERO);
7404
7405	ctsio->kern_sg_entries = 0;
7406
7407	if (total_len < alloc_len) {
7408		ctsio->residual = alloc_len - total_len;
7409		ctsio->kern_data_len = total_len;
7410		ctsio->kern_total_len = total_len;
7411	} else {
7412		ctsio->residual = 0;
7413		ctsio->kern_data_len = alloc_len;
7414		ctsio->kern_total_len = alloc_len;
7415	}
7416	ctsio->kern_data_resid = 0;
7417	ctsio->kern_rel_offset = 0;
7418
7419	switch (cdb->options & RSO_OPTIONS_MASK) {
7420	case RSO_OPTIONS_ALL:
7421		all = (struct scsi_report_supported_opcodes_all *)
7422		    ctsio->kern_data_ptr;
7423		num = 0;
7424		for (i = 0; i < 256; i++) {
7425			entry = &ctl_cmd_table[i];
7426			if (entry->flags & CTL_CMD_FLAG_SA5) {
7427				for (j = 0; j < 32; j++) {
7428					sentry = &((const struct ctl_cmd_entry *)
7429					    entry->execute)[j];
7430					if (!ctl_cmd_applicable(
7431					    lun->be_lun->lun_type, sentry))
7432						continue;
7433					descr = &all->descr[num++];
7434					descr->opcode = i;
7435					scsi_ulto2b(j, descr->service_action);
7436					descr->flags = RSO_SERVACTV;
7437					scsi_ulto2b(sentry->length,
7438					    descr->cdb_length);
7439				}
7440			} else {
7441				if (!ctl_cmd_applicable(lun->be_lun->lun_type,
7442				    entry))
7443					continue;
7444				descr = &all->descr[num++];
7445				descr->opcode = i;
7446				scsi_ulto2b(0, descr->service_action);
7447				descr->flags = 0;
7448				scsi_ulto2b(entry->length, descr->cdb_length);
7449			}
7450		}
7451		scsi_ulto4b(
7452		    num * sizeof(struct scsi_report_supported_opcodes_descr),
7453		    all->length);
7454		break;
7455	case RSO_OPTIONS_OC:
7456		one = (struct scsi_report_supported_opcodes_one *)
7457		    ctsio->kern_data_ptr;
7458		entry = &ctl_cmd_table[opcode];
7459		goto fill_one;
7460	case RSO_OPTIONS_OC_SA:
7461		one = (struct scsi_report_supported_opcodes_one *)
7462		    ctsio->kern_data_ptr;
7463		entry = &ctl_cmd_table[opcode];
7464		entry = &((const struct ctl_cmd_entry *)
7465		    entry->execute)[service_action];
7466fill_one:
7467		if (ctl_cmd_applicable(lun->be_lun->lun_type, entry)) {
7468			one->support = 3;
7469			scsi_ulto2b(entry->length, one->cdb_length);
7470			one->cdb_usage[0] = opcode;
7471			memcpy(&one->cdb_usage[1], entry->usage,
7472			    entry->length - 1);
7473		} else
7474			one->support = 1;
7475		break;
7476	}
7477
7478	ctl_set_success(ctsio);
7479	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
7480	ctsio->be_move_done = ctl_config_move_done;
7481	ctl_datamove((union ctl_io *)ctsio);
7482	return(retval);
7483}
7484
7485int
7486ctl_report_supported_tmf(struct ctl_scsiio *ctsio)
7487{
7488	struct scsi_report_supported_tmf *cdb;
7489	struct scsi_report_supported_tmf_data *data;
7490	int retval;
7491	int alloc_len, total_len;
7492
7493	CTL_DEBUG_PRINT(("ctl_report_supported_tmf\n"));
7494
7495	cdb = (struct scsi_report_supported_tmf *)ctsio->cdb;
7496
7497	retval = CTL_RETVAL_COMPLETE;
7498
7499	total_len = sizeof(struct scsi_report_supported_tmf_data);
7500	alloc_len = scsi_4btoul(cdb->length);
7501
7502	ctsio->kern_data_ptr = malloc(total_len, M_CTL, M_WAITOK | M_ZERO);
7503
7504	ctsio->kern_sg_entries = 0;
7505
7506	if (total_len < alloc_len) {
7507		ctsio->residual = alloc_len - total_len;
7508		ctsio->kern_data_len = total_len;
7509		ctsio->kern_total_len = total_len;
7510	} else {
7511		ctsio->residual = 0;
7512		ctsio->kern_data_len = alloc_len;
7513		ctsio->kern_total_len = alloc_len;
7514	}
7515	ctsio->kern_data_resid = 0;
7516	ctsio->kern_rel_offset = 0;
7517
7518	data = (struct scsi_report_supported_tmf_data *)ctsio->kern_data_ptr;
7519	data->byte1 |= RST_ATS | RST_ATSS | RST_CTSS | RST_LURS | RST_QTS |
7520	    RST_TRS;
7521	data->byte2 |= RST_QAES | RST_QTSS | RST_ITNRS;
7522
7523	ctl_set_success(ctsio);
7524	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
7525	ctsio->be_move_done = ctl_config_move_done;
7526	ctl_datamove((union ctl_io *)ctsio);
7527	return (retval);
7528}
7529
7530int
7531ctl_report_timestamp(struct ctl_scsiio *ctsio)
7532{
7533	struct scsi_report_timestamp *cdb;
7534	struct scsi_report_timestamp_data *data;
7535	struct timeval tv;
7536	int64_t timestamp;
7537	int retval;
7538	int alloc_len, total_len;
7539
7540	CTL_DEBUG_PRINT(("ctl_report_timestamp\n"));
7541
7542	cdb = (struct scsi_report_timestamp *)ctsio->cdb;
7543
7544	retval = CTL_RETVAL_COMPLETE;
7545
7546	total_len = sizeof(struct scsi_report_timestamp_data);
7547	alloc_len = scsi_4btoul(cdb->length);
7548
7549	ctsio->kern_data_ptr = malloc(total_len, M_CTL, M_WAITOK | M_ZERO);
7550
7551	ctsio->kern_sg_entries = 0;
7552
7553	if (total_len < alloc_len) {
7554		ctsio->residual = alloc_len - total_len;
7555		ctsio->kern_data_len = total_len;
7556		ctsio->kern_total_len = total_len;
7557	} else {
7558		ctsio->residual = 0;
7559		ctsio->kern_data_len = alloc_len;
7560		ctsio->kern_total_len = alloc_len;
7561	}
7562	ctsio->kern_data_resid = 0;
7563	ctsio->kern_rel_offset = 0;
7564
7565	data = (struct scsi_report_timestamp_data *)ctsio->kern_data_ptr;
7566	scsi_ulto2b(sizeof(*data) - 2, data->length);
7567	data->origin = RTS_ORIG_OUTSIDE;
7568	getmicrotime(&tv);
7569	timestamp = (int64_t)tv.tv_sec * 1000 + tv.tv_usec / 1000;
7570	scsi_ulto4b(timestamp >> 16, data->timestamp);
7571	scsi_ulto2b(timestamp & 0xffff, &data->timestamp[4]);
7572
7573	ctl_set_success(ctsio);
7574	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
7575	ctsio->be_move_done = ctl_config_move_done;
7576	ctl_datamove((union ctl_io *)ctsio);
7577	return (retval);
7578}
7579
7580int
7581ctl_persistent_reserve_in(struct ctl_scsiio *ctsio)
7582{
7583	struct scsi_per_res_in *cdb;
7584	int alloc_len, total_len = 0;
7585	/* struct scsi_per_res_in_rsrv in_data; */
7586	struct ctl_lun *lun;
7587	struct ctl_softc *softc;
7588	uint64_t key;
7589
7590	CTL_DEBUG_PRINT(("ctl_persistent_reserve_in\n"));
7591
7592	cdb = (struct scsi_per_res_in *)ctsio->cdb;
7593
7594	alloc_len = scsi_2btoul(cdb->length);
7595
7596	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
7597	softc = lun->ctl_softc;
7598
7599retry:
7600	mtx_lock(&lun->lun_lock);
7601	switch (cdb->action) {
7602	case SPRI_RK: /* read keys */
7603		total_len = sizeof(struct scsi_per_res_in_keys) +
7604			lun->pr_key_count *
7605			sizeof(struct scsi_per_res_key);
7606		break;
7607	case SPRI_RR: /* read reservation */
7608		if (lun->flags & CTL_LUN_PR_RESERVED)
7609			total_len = sizeof(struct scsi_per_res_in_rsrv);
7610		else
7611			total_len = sizeof(struct scsi_per_res_in_header);
7612		break;
7613	case SPRI_RC: /* report capabilities */
7614		total_len = sizeof(struct scsi_per_res_cap);
7615		break;
7616	case SPRI_RS: /* read full status */
7617		total_len = sizeof(struct scsi_per_res_in_header) +
7618		    (sizeof(struct scsi_per_res_in_full_desc) + 256) *
7619		    lun->pr_key_count;
7620		break;
7621	default:
7622		panic("%s: Invalid PR type %#x", __func__, cdb->action);
7623	}
7624	mtx_unlock(&lun->lun_lock);
7625
7626	ctsio->kern_data_ptr = malloc(total_len, M_CTL, M_WAITOK | M_ZERO);
7627
7628	if (total_len < alloc_len) {
7629		ctsio->residual = alloc_len - total_len;
7630		ctsio->kern_data_len = total_len;
7631		ctsio->kern_total_len = total_len;
7632	} else {
7633		ctsio->residual = 0;
7634		ctsio->kern_data_len = alloc_len;
7635		ctsio->kern_total_len = alloc_len;
7636	}
7637
7638	ctsio->kern_data_resid = 0;
7639	ctsio->kern_rel_offset = 0;
7640	ctsio->kern_sg_entries = 0;
7641
7642	mtx_lock(&lun->lun_lock);
7643	switch (cdb->action) {
7644	case SPRI_RK: { // read keys
7645        struct scsi_per_res_in_keys *res_keys;
7646		int i, key_count;
7647
7648		res_keys = (struct scsi_per_res_in_keys*)ctsio->kern_data_ptr;
7649
7650		/*
7651		 * We had to drop the lock to allocate our buffer, which
7652		 * leaves time for someone to come in with another
7653		 * persistent reservation.  (That is unlikely, though,
7654		 * since this should be the only persistent reservation
7655		 * command active right now.)
7656		 */
7657		if (total_len != (sizeof(struct scsi_per_res_in_keys) +
7658		    (lun->pr_key_count *
7659		     sizeof(struct scsi_per_res_key)))){
7660			mtx_unlock(&lun->lun_lock);
7661			free(ctsio->kern_data_ptr, M_CTL);
7662			printf("%s: reservation length changed, retrying\n",
7663			       __func__);
7664			goto retry;
7665		}
7666
7667		scsi_ulto4b(lun->pr_generation, res_keys->header.generation);
7668
7669		scsi_ulto4b(sizeof(struct scsi_per_res_key) *
7670			     lun->pr_key_count, res_keys->header.length);
7671
7672		for (i = 0, key_count = 0; i < CTL_MAX_INITIATORS; i++) {
7673			if ((key = ctl_get_prkey(lun, i)) == 0)
7674				continue;
7675
7676			/*
7677			 * We used lun->pr_key_count to calculate the
7678			 * size to allocate.  If it turns out the number of
7679			 * initiators with the registered flag set is
7680			 * larger than that (i.e. they haven't been kept in
7681			 * sync), we've got a problem.
7682			 */
7683			if (key_count >= lun->pr_key_count) {
7684				key_count++;
7685				continue;
7686			}
7687			scsi_u64to8b(key, res_keys->keys[key_count].key);
7688			key_count++;
7689		}
7690		break;
7691	}
7692	case SPRI_RR: { // read reservation
7693		struct scsi_per_res_in_rsrv *res;
7694		int tmp_len, header_only;
7695
7696		res = (struct scsi_per_res_in_rsrv *)ctsio->kern_data_ptr;
7697
7698		scsi_ulto4b(lun->pr_generation, res->header.generation);
7699
7700		if (lun->flags & CTL_LUN_PR_RESERVED)
7701		{
7702			tmp_len = sizeof(struct scsi_per_res_in_rsrv);
7703			scsi_ulto4b(sizeof(struct scsi_per_res_in_rsrv_data),
7704				    res->header.length);
7705			header_only = 0;
7706		} else {
7707			tmp_len = sizeof(struct scsi_per_res_in_header);
7708			scsi_ulto4b(0, res->header.length);
7709			header_only = 1;
7710		}
7711
7712		/*
7713		 * We had to drop the lock to allocate our buffer, which
7714		 * leaves time for someone to come in with another
7715		 * persistent reservation.  (That is unlikely, though,
7716		 * since this should be the only persistent reservation
7717		 * command active right now.)
7718		 */
7719		if (tmp_len != total_len) {
7720			mtx_unlock(&lun->lun_lock);
7721			free(ctsio->kern_data_ptr, M_CTL);
7722			printf("%s: reservation status changed, retrying\n",
7723			       __func__);
7724			goto retry;
7725		}
7726
7727		/*
7728		 * No reservation held, so we're done.
7729		 */
7730		if (header_only != 0)
7731			break;
7732
7733		/*
7734		 * If the registration is an All Registrants type, the key
7735		 * is 0, since it doesn't really matter.
7736		 */
7737		if (lun->pr_res_idx != CTL_PR_ALL_REGISTRANTS) {
7738			scsi_u64to8b(ctl_get_prkey(lun, lun->pr_res_idx),
7739			    res->data.reservation);
7740		}
7741		res->data.scopetype = lun->pr_res_type;
7742		break;
7743	}
7744	case SPRI_RC:     //report capabilities
7745	{
7746		struct scsi_per_res_cap *res_cap;
7747		uint16_t type_mask;
7748
7749		res_cap = (struct scsi_per_res_cap *)ctsio->kern_data_ptr;
7750		scsi_ulto2b(sizeof(*res_cap), res_cap->length);
7751		res_cap->flags1 = SPRI_CRH;
7752		res_cap->flags2 = SPRI_TMV | SPRI_ALLOW_5;
7753		type_mask = SPRI_TM_WR_EX_AR |
7754			    SPRI_TM_EX_AC_RO |
7755			    SPRI_TM_WR_EX_RO |
7756			    SPRI_TM_EX_AC |
7757			    SPRI_TM_WR_EX |
7758			    SPRI_TM_EX_AC_AR;
7759		scsi_ulto2b(type_mask, res_cap->type_mask);
7760		break;
7761	}
7762	case SPRI_RS: { // read full status
7763		struct scsi_per_res_in_full *res_status;
7764		struct scsi_per_res_in_full_desc *res_desc;
7765		struct ctl_port *port;
7766		int i, len;
7767
7768		res_status = (struct scsi_per_res_in_full*)ctsio->kern_data_ptr;
7769
7770		/*
7771		 * We had to drop the lock to allocate our buffer, which
7772		 * leaves time for someone to come in with another
7773		 * persistent reservation.  (That is unlikely, though,
7774		 * since this should be the only persistent reservation
7775		 * command active right now.)
7776		 */
7777		if (total_len < (sizeof(struct scsi_per_res_in_header) +
7778		    (sizeof(struct scsi_per_res_in_full_desc) + 256) *
7779		     lun->pr_key_count)){
7780			mtx_unlock(&lun->lun_lock);
7781			free(ctsio->kern_data_ptr, M_CTL);
7782			printf("%s: reservation length changed, retrying\n",
7783			       __func__);
7784			goto retry;
7785		}
7786
7787		scsi_ulto4b(lun->pr_generation, res_status->header.generation);
7788
7789		res_desc = &res_status->desc[0];
7790		for (i = 0; i < CTL_MAX_INITIATORS; i++) {
7791			if ((key = ctl_get_prkey(lun, i)) == 0)
7792				continue;
7793
7794			scsi_u64to8b(key, res_desc->res_key.key);
7795			if ((lun->flags & CTL_LUN_PR_RESERVED) &&
7796			    (lun->pr_res_idx == i ||
7797			     lun->pr_res_idx == CTL_PR_ALL_REGISTRANTS)) {
7798				res_desc->flags = SPRI_FULL_R_HOLDER;
7799				res_desc->scopetype = lun->pr_res_type;
7800			}
7801			scsi_ulto2b(i / CTL_MAX_INIT_PER_PORT,
7802			    res_desc->rel_trgt_port_id);
7803			len = 0;
7804			port = softc->ctl_ports[i / CTL_MAX_INIT_PER_PORT];
7805			if (port != NULL)
7806				len = ctl_create_iid(port,
7807				    i % CTL_MAX_INIT_PER_PORT,
7808				    res_desc->transport_id);
7809			scsi_ulto4b(len, res_desc->additional_length);
7810			res_desc = (struct scsi_per_res_in_full_desc *)
7811			    &res_desc->transport_id[len];
7812		}
7813		scsi_ulto4b((uint8_t *)res_desc - (uint8_t *)&res_status->desc[0],
7814		    res_status->header.length);
7815		break;
7816	}
7817	default:
7818		panic("%s: Invalid PR type %#x", __func__, cdb->action);
7819	}
7820	mtx_unlock(&lun->lun_lock);
7821
7822	ctl_set_success(ctsio);
7823	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
7824	ctsio->be_move_done = ctl_config_move_done;
7825	ctl_datamove((union ctl_io *)ctsio);
7826	return (CTL_RETVAL_COMPLETE);
7827}
7828
7829/*
7830 * Returns 0 if ctl_persistent_reserve_out() should continue, non-zero if
7831 * it should return.
7832 */
7833static int
7834ctl_pro_preempt(struct ctl_softc *softc, struct ctl_lun *lun, uint64_t res_key,
7835		uint64_t sa_res_key, uint8_t type, uint32_t residx,
7836		struct ctl_scsiio *ctsio, struct scsi_per_res_out *cdb,
7837		struct scsi_per_res_out_parms* param)
7838{
7839	union ctl_ha_msg persis_io;
7840	int i;
7841
7842	mtx_lock(&lun->lun_lock);
7843	if (sa_res_key == 0) {
7844		if (lun->pr_res_idx == CTL_PR_ALL_REGISTRANTS) {
7845			/* validate scope and type */
7846			if ((cdb->scope_type & SPR_SCOPE_MASK) !=
7847			     SPR_LU_SCOPE) {
7848				mtx_unlock(&lun->lun_lock);
7849				ctl_set_invalid_field(/*ctsio*/ ctsio,
7850						      /*sks_valid*/ 1,
7851						      /*command*/ 1,
7852						      /*field*/ 2,
7853						      /*bit_valid*/ 1,
7854						      /*bit*/ 4);
7855				ctl_done((union ctl_io *)ctsio);
7856				return (1);
7857			}
7858
7859		        if (type>8 || type==2 || type==4 || type==0) {
7860				mtx_unlock(&lun->lun_lock);
7861				ctl_set_invalid_field(/*ctsio*/ ctsio,
7862       	           				      /*sks_valid*/ 1,
7863						      /*command*/ 1,
7864						      /*field*/ 2,
7865						      /*bit_valid*/ 1,
7866						      /*bit*/ 0);
7867				ctl_done((union ctl_io *)ctsio);
7868				return (1);
7869		        }
7870
7871			/*
7872			 * Unregister everybody else and build UA for
7873			 * them
7874			 */
7875			for(i = 0; i < CTL_MAX_INITIATORS; i++) {
7876				if (i == residx || ctl_get_prkey(lun, i) == 0)
7877					continue;
7878
7879				ctl_clr_prkey(lun, i);
7880				ctl_est_ua(lun, i, CTL_UA_REG_PREEMPT);
7881			}
7882			lun->pr_key_count = 1;
7883			lun->pr_res_type = type;
7884			if (lun->pr_res_type != SPR_TYPE_WR_EX_AR &&
7885			    lun->pr_res_type != SPR_TYPE_EX_AC_AR)
7886				lun->pr_res_idx = residx;
7887			lun->pr_generation++;
7888			mtx_unlock(&lun->lun_lock);
7889
7890			/* send msg to other side */
7891			persis_io.hdr.nexus = ctsio->io_hdr.nexus;
7892			persis_io.hdr.msg_type = CTL_MSG_PERS_ACTION;
7893			persis_io.pr.pr_info.action = CTL_PR_PREEMPT;
7894			persis_io.pr.pr_info.residx = lun->pr_res_idx;
7895			persis_io.pr.pr_info.res_type = type;
7896			memcpy(persis_io.pr.pr_info.sa_res_key,
7897			       param->serv_act_res_key,
7898			       sizeof(param->serv_act_res_key));
7899			ctl_ha_msg_send(CTL_HA_CHAN_CTL, &persis_io,
7900			    sizeof(persis_io.pr), M_WAITOK);
7901		} else {
7902			/* not all registrants */
7903			mtx_unlock(&lun->lun_lock);
7904			free(ctsio->kern_data_ptr, M_CTL);
7905			ctl_set_invalid_field(ctsio,
7906					      /*sks_valid*/ 1,
7907					      /*command*/ 0,
7908					      /*field*/ 8,
7909					      /*bit_valid*/ 0,
7910					      /*bit*/ 0);
7911			ctl_done((union ctl_io *)ctsio);
7912			return (1);
7913		}
7914	} else if (lun->pr_res_idx == CTL_PR_ALL_REGISTRANTS
7915		|| !(lun->flags & CTL_LUN_PR_RESERVED)) {
7916		int found = 0;
7917
7918		if (res_key == sa_res_key) {
7919			/* special case */
7920			/*
7921			 * The spec implies this is not good but doesn't
7922			 * say what to do. There are two choices either
7923			 * generate a res conflict or check condition
7924			 * with illegal field in parameter data. Since
7925			 * that is what is done when the sa_res_key is
7926			 * zero I'll take that approach since this has
7927			 * to do with the sa_res_key.
7928			 */
7929			mtx_unlock(&lun->lun_lock);
7930			free(ctsio->kern_data_ptr, M_CTL);
7931			ctl_set_invalid_field(ctsio,
7932					      /*sks_valid*/ 1,
7933					      /*command*/ 0,
7934					      /*field*/ 8,
7935					      /*bit_valid*/ 0,
7936					      /*bit*/ 0);
7937			ctl_done((union ctl_io *)ctsio);
7938			return (1);
7939		}
7940
7941		for (i = 0; i < CTL_MAX_INITIATORS; i++) {
7942			if (ctl_get_prkey(lun, i) != sa_res_key)
7943				continue;
7944
7945			found = 1;
7946			ctl_clr_prkey(lun, i);
7947			lun->pr_key_count--;
7948			ctl_est_ua(lun, i, CTL_UA_REG_PREEMPT);
7949		}
7950		if (!found) {
7951			mtx_unlock(&lun->lun_lock);
7952			free(ctsio->kern_data_ptr, M_CTL);
7953			ctl_set_reservation_conflict(ctsio);
7954			ctl_done((union ctl_io *)ctsio);
7955			return (CTL_RETVAL_COMPLETE);
7956		}
7957		lun->pr_generation++;
7958		mtx_unlock(&lun->lun_lock);
7959
7960		/* send msg to other side */
7961		persis_io.hdr.nexus = ctsio->io_hdr.nexus;
7962		persis_io.hdr.msg_type = CTL_MSG_PERS_ACTION;
7963		persis_io.pr.pr_info.action = CTL_PR_PREEMPT;
7964		persis_io.pr.pr_info.residx = lun->pr_res_idx;
7965		persis_io.pr.pr_info.res_type = type;
7966		memcpy(persis_io.pr.pr_info.sa_res_key,
7967		       param->serv_act_res_key,
7968		       sizeof(param->serv_act_res_key));
7969		ctl_ha_msg_send(CTL_HA_CHAN_CTL, &persis_io,
7970		    sizeof(persis_io.pr), M_WAITOK);
7971	} else {
7972		/* Reserved but not all registrants */
7973		/* sa_res_key is res holder */
7974		if (sa_res_key == ctl_get_prkey(lun, lun->pr_res_idx)) {
7975			/* validate scope and type */
7976			if ((cdb->scope_type & SPR_SCOPE_MASK) !=
7977			     SPR_LU_SCOPE) {
7978				mtx_unlock(&lun->lun_lock);
7979				ctl_set_invalid_field(/*ctsio*/ ctsio,
7980						      /*sks_valid*/ 1,
7981						      /*command*/ 1,
7982						      /*field*/ 2,
7983						      /*bit_valid*/ 1,
7984						      /*bit*/ 4);
7985				ctl_done((union ctl_io *)ctsio);
7986				return (1);
7987			}
7988
7989			if (type>8 || type==2 || type==4 || type==0) {
7990				mtx_unlock(&lun->lun_lock);
7991				ctl_set_invalid_field(/*ctsio*/ ctsio,
7992						      /*sks_valid*/ 1,
7993						      /*command*/ 1,
7994						      /*field*/ 2,
7995						      /*bit_valid*/ 1,
7996						      /*bit*/ 0);
7997				ctl_done((union ctl_io *)ctsio);
7998				return (1);
7999			}
8000
8001			/*
8002			 * Do the following:
8003			 * if sa_res_key != res_key remove all
8004			 * registrants w/sa_res_key and generate UA
8005			 * for these registrants(Registrations
8006			 * Preempted) if it wasn't an exclusive
8007			 * reservation generate UA(Reservations
8008			 * Preempted) for all other registered nexuses
8009			 * if the type has changed. Establish the new
8010			 * reservation and holder. If res_key and
8011			 * sa_res_key are the same do the above
8012			 * except don't unregister the res holder.
8013			 */
8014
8015			for(i = 0; i < CTL_MAX_INITIATORS; i++) {
8016				if (i == residx || ctl_get_prkey(lun, i) == 0)
8017					continue;
8018
8019				if (sa_res_key == ctl_get_prkey(lun, i)) {
8020					ctl_clr_prkey(lun, i);
8021					lun->pr_key_count--;
8022					ctl_est_ua(lun, i, CTL_UA_REG_PREEMPT);
8023				} else if (type != lun->pr_res_type &&
8024				    (lun->pr_res_type == SPR_TYPE_WR_EX_RO ||
8025				     lun->pr_res_type == SPR_TYPE_EX_AC_RO)) {
8026					ctl_est_ua(lun, i, CTL_UA_RES_RELEASE);
8027				}
8028			}
8029			lun->pr_res_type = type;
8030			if (lun->pr_res_type != SPR_TYPE_WR_EX_AR &&
8031			    lun->pr_res_type != SPR_TYPE_EX_AC_AR)
8032				lun->pr_res_idx = residx;
8033			else
8034				lun->pr_res_idx = CTL_PR_ALL_REGISTRANTS;
8035			lun->pr_generation++;
8036			mtx_unlock(&lun->lun_lock);
8037
8038			persis_io.hdr.nexus = ctsio->io_hdr.nexus;
8039			persis_io.hdr.msg_type = CTL_MSG_PERS_ACTION;
8040			persis_io.pr.pr_info.action = CTL_PR_PREEMPT;
8041			persis_io.pr.pr_info.residx = lun->pr_res_idx;
8042			persis_io.pr.pr_info.res_type = type;
8043			memcpy(persis_io.pr.pr_info.sa_res_key,
8044			       param->serv_act_res_key,
8045			       sizeof(param->serv_act_res_key));
8046			ctl_ha_msg_send(CTL_HA_CHAN_CTL, &persis_io,
8047			    sizeof(persis_io.pr), M_WAITOK);
8048		} else {
8049			/*
8050			 * sa_res_key is not the res holder just
8051			 * remove registrants
8052			 */
8053			int found=0;
8054
8055			for (i = 0; i < CTL_MAX_INITIATORS; i++) {
8056				if (sa_res_key != ctl_get_prkey(lun, i))
8057					continue;
8058
8059				found = 1;
8060				ctl_clr_prkey(lun, i);
8061				lun->pr_key_count--;
8062				ctl_est_ua(lun, i, CTL_UA_REG_PREEMPT);
8063			}
8064
8065			if (!found) {
8066				mtx_unlock(&lun->lun_lock);
8067				free(ctsio->kern_data_ptr, M_CTL);
8068				ctl_set_reservation_conflict(ctsio);
8069				ctl_done((union ctl_io *)ctsio);
8070		        	return (1);
8071			}
8072			lun->pr_generation++;
8073			mtx_unlock(&lun->lun_lock);
8074
8075			persis_io.hdr.nexus = ctsio->io_hdr.nexus;
8076			persis_io.hdr.msg_type = CTL_MSG_PERS_ACTION;
8077			persis_io.pr.pr_info.action = CTL_PR_PREEMPT;
8078			persis_io.pr.pr_info.residx = lun->pr_res_idx;
8079			persis_io.pr.pr_info.res_type = type;
8080			memcpy(persis_io.pr.pr_info.sa_res_key,
8081			       param->serv_act_res_key,
8082			       sizeof(param->serv_act_res_key));
8083			ctl_ha_msg_send(CTL_HA_CHAN_CTL, &persis_io,
8084			    sizeof(persis_io.pr), M_WAITOK);
8085		}
8086	}
8087	return (0);
8088}
8089
8090static void
8091ctl_pro_preempt_other(struct ctl_lun *lun, union ctl_ha_msg *msg)
8092{
8093	uint64_t sa_res_key;
8094	int i;
8095
8096	sa_res_key = scsi_8btou64(msg->pr.pr_info.sa_res_key);
8097
8098	if (lun->pr_res_idx == CTL_PR_ALL_REGISTRANTS
8099	 || lun->pr_res_idx == CTL_PR_NO_RESERVATION
8100	 || sa_res_key != ctl_get_prkey(lun, lun->pr_res_idx)) {
8101		if (sa_res_key == 0) {
8102			/*
8103			 * Unregister everybody else and build UA for
8104			 * them
8105			 */
8106			for(i = 0; i < CTL_MAX_INITIATORS; i++) {
8107				if (i == msg->pr.pr_info.residx ||
8108				    ctl_get_prkey(lun, i) == 0)
8109					continue;
8110
8111				ctl_clr_prkey(lun, i);
8112				ctl_est_ua(lun, i, CTL_UA_REG_PREEMPT);
8113			}
8114
8115			lun->pr_key_count = 1;
8116			lun->pr_res_type = msg->pr.pr_info.res_type;
8117			if (lun->pr_res_type != SPR_TYPE_WR_EX_AR &&
8118			    lun->pr_res_type != SPR_TYPE_EX_AC_AR)
8119				lun->pr_res_idx = msg->pr.pr_info.residx;
8120		} else {
8121		        for (i = 0; i < CTL_MAX_INITIATORS; i++) {
8122				if (sa_res_key == ctl_get_prkey(lun, i))
8123					continue;
8124
8125				ctl_clr_prkey(lun, i);
8126				lun->pr_key_count--;
8127				ctl_est_ua(lun, i, CTL_UA_REG_PREEMPT);
8128			}
8129		}
8130	} else {
8131		for (i = 0; i < CTL_MAX_INITIATORS; i++) {
8132			if (i == msg->pr.pr_info.residx ||
8133			    ctl_get_prkey(lun, i) == 0)
8134				continue;
8135
8136			if (sa_res_key == ctl_get_prkey(lun, i)) {
8137				ctl_clr_prkey(lun, i);
8138				lun->pr_key_count--;
8139				ctl_est_ua(lun, i, CTL_UA_REG_PREEMPT);
8140			} else if (msg->pr.pr_info.res_type != lun->pr_res_type
8141			    && (lun->pr_res_type == SPR_TYPE_WR_EX_RO ||
8142			     lun->pr_res_type == SPR_TYPE_EX_AC_RO)) {
8143				ctl_est_ua(lun, i, CTL_UA_RES_RELEASE);
8144			}
8145		}
8146		lun->pr_res_type = msg->pr.pr_info.res_type;
8147		if (lun->pr_res_type != SPR_TYPE_WR_EX_AR &&
8148		    lun->pr_res_type != SPR_TYPE_EX_AC_AR)
8149			lun->pr_res_idx = msg->pr.pr_info.residx;
8150		else
8151			lun->pr_res_idx = CTL_PR_ALL_REGISTRANTS;
8152	}
8153	lun->pr_generation++;
8154
8155}
8156
8157
8158int
8159ctl_persistent_reserve_out(struct ctl_scsiio *ctsio)
8160{
8161	int retval;
8162	u_int32_t param_len;
8163	struct scsi_per_res_out *cdb;
8164	struct ctl_lun *lun;
8165	struct scsi_per_res_out_parms* param;
8166	struct ctl_softc *softc;
8167	uint32_t residx;
8168	uint64_t res_key, sa_res_key, key;
8169	uint8_t type;
8170	union ctl_ha_msg persis_io;
8171	int    i;
8172
8173	CTL_DEBUG_PRINT(("ctl_persistent_reserve_out\n"));
8174
8175	retval = CTL_RETVAL_COMPLETE;
8176
8177	cdb = (struct scsi_per_res_out *)ctsio->cdb;
8178	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
8179	softc = lun->ctl_softc;
8180
8181	/*
8182	 * We only support whole-LUN scope.  The scope & type are ignored for
8183	 * register, register and ignore existing key and clear.
8184	 * We sometimes ignore scope and type on preempts too!!
8185	 * Verify reservation type here as well.
8186	 */
8187	type = cdb->scope_type & SPR_TYPE_MASK;
8188	if ((cdb->action == SPRO_RESERVE)
8189	 || (cdb->action == SPRO_RELEASE)) {
8190		if ((cdb->scope_type & SPR_SCOPE_MASK) != SPR_LU_SCOPE) {
8191			ctl_set_invalid_field(/*ctsio*/ ctsio,
8192					      /*sks_valid*/ 1,
8193					      /*command*/ 1,
8194					      /*field*/ 2,
8195					      /*bit_valid*/ 1,
8196					      /*bit*/ 4);
8197			ctl_done((union ctl_io *)ctsio);
8198			return (CTL_RETVAL_COMPLETE);
8199		}
8200
8201		if (type>8 || type==2 || type==4 || type==0) {
8202			ctl_set_invalid_field(/*ctsio*/ ctsio,
8203					      /*sks_valid*/ 1,
8204					      /*command*/ 1,
8205					      /*field*/ 2,
8206					      /*bit_valid*/ 1,
8207					      /*bit*/ 0);
8208			ctl_done((union ctl_io *)ctsio);
8209			return (CTL_RETVAL_COMPLETE);
8210		}
8211	}
8212
8213	param_len = scsi_4btoul(cdb->length);
8214
8215	if ((ctsio->io_hdr.flags & CTL_FLAG_ALLOCATED) == 0) {
8216		ctsio->kern_data_ptr = malloc(param_len, M_CTL, M_WAITOK);
8217		ctsio->kern_data_len = param_len;
8218		ctsio->kern_total_len = param_len;
8219		ctsio->kern_data_resid = 0;
8220		ctsio->kern_rel_offset = 0;
8221		ctsio->kern_sg_entries = 0;
8222		ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
8223		ctsio->be_move_done = ctl_config_move_done;
8224		ctl_datamove((union ctl_io *)ctsio);
8225
8226		return (CTL_RETVAL_COMPLETE);
8227	}
8228
8229	param = (struct scsi_per_res_out_parms *)ctsio->kern_data_ptr;
8230
8231	residx = ctl_get_initindex(&ctsio->io_hdr.nexus);
8232	res_key = scsi_8btou64(param->res_key.key);
8233	sa_res_key = scsi_8btou64(param->serv_act_res_key);
8234
8235	/*
8236	 * Validate the reservation key here except for SPRO_REG_IGNO
8237	 * This must be done for all other service actions
8238	 */
8239	if ((cdb->action & SPRO_ACTION_MASK) != SPRO_REG_IGNO) {
8240		mtx_lock(&lun->lun_lock);
8241		if ((key = ctl_get_prkey(lun, residx)) != 0) {
8242			if (res_key != key) {
8243				/*
8244				 * The current key passed in doesn't match
8245				 * the one the initiator previously
8246				 * registered.
8247				 */
8248				mtx_unlock(&lun->lun_lock);
8249				free(ctsio->kern_data_ptr, M_CTL);
8250				ctl_set_reservation_conflict(ctsio);
8251				ctl_done((union ctl_io *)ctsio);
8252				return (CTL_RETVAL_COMPLETE);
8253			}
8254		} else if ((cdb->action & SPRO_ACTION_MASK) != SPRO_REGISTER) {
8255			/*
8256			 * We are not registered
8257			 */
8258			mtx_unlock(&lun->lun_lock);
8259			free(ctsio->kern_data_ptr, M_CTL);
8260			ctl_set_reservation_conflict(ctsio);
8261			ctl_done((union ctl_io *)ctsio);
8262			return (CTL_RETVAL_COMPLETE);
8263		} else if (res_key != 0) {
8264			/*
8265			 * We are not registered and trying to register but
8266			 * the register key isn't zero.
8267			 */
8268			mtx_unlock(&lun->lun_lock);
8269			free(ctsio->kern_data_ptr, M_CTL);
8270			ctl_set_reservation_conflict(ctsio);
8271			ctl_done((union ctl_io *)ctsio);
8272			return (CTL_RETVAL_COMPLETE);
8273		}
8274		mtx_unlock(&lun->lun_lock);
8275	}
8276
8277	switch (cdb->action & SPRO_ACTION_MASK) {
8278	case SPRO_REGISTER:
8279	case SPRO_REG_IGNO: {
8280
8281#if 0
8282		printf("Registration received\n");
8283#endif
8284
8285		/*
8286		 * We don't support any of these options, as we report in
8287		 * the read capabilities request (see
8288		 * ctl_persistent_reserve_in(), above).
8289		 */
8290		if ((param->flags & SPR_SPEC_I_PT)
8291		 || (param->flags & SPR_ALL_TG_PT)
8292		 || (param->flags & SPR_APTPL)) {
8293			int bit_ptr;
8294
8295			if (param->flags & SPR_APTPL)
8296				bit_ptr = 0;
8297			else if (param->flags & SPR_ALL_TG_PT)
8298				bit_ptr = 2;
8299			else /* SPR_SPEC_I_PT */
8300				bit_ptr = 3;
8301
8302			free(ctsio->kern_data_ptr, M_CTL);
8303			ctl_set_invalid_field(ctsio,
8304					      /*sks_valid*/ 1,
8305					      /*command*/ 0,
8306					      /*field*/ 20,
8307					      /*bit_valid*/ 1,
8308					      /*bit*/ bit_ptr);
8309			ctl_done((union ctl_io *)ctsio);
8310			return (CTL_RETVAL_COMPLETE);
8311		}
8312
8313		mtx_lock(&lun->lun_lock);
8314
8315		/*
8316		 * The initiator wants to clear the
8317		 * key/unregister.
8318		 */
8319		if (sa_res_key == 0) {
8320			if ((res_key == 0
8321			  && (cdb->action & SPRO_ACTION_MASK) == SPRO_REGISTER)
8322			 || ((cdb->action & SPRO_ACTION_MASK) == SPRO_REG_IGNO
8323			  && ctl_get_prkey(lun, residx) == 0)) {
8324				mtx_unlock(&lun->lun_lock);
8325				goto done;
8326			}
8327
8328			ctl_clr_prkey(lun, residx);
8329			lun->pr_key_count--;
8330
8331			if (residx == lun->pr_res_idx) {
8332				lun->flags &= ~CTL_LUN_PR_RESERVED;
8333				lun->pr_res_idx = CTL_PR_NO_RESERVATION;
8334
8335				if ((lun->pr_res_type == SPR_TYPE_WR_EX_RO ||
8336				     lun->pr_res_type == SPR_TYPE_EX_AC_RO) &&
8337				    lun->pr_key_count) {
8338					/*
8339					 * If the reservation is a registrants
8340					 * only type we need to generate a UA
8341					 * for other registered inits.  The
8342					 * sense code should be RESERVATIONS
8343					 * RELEASED
8344					 */
8345
8346					for (i = softc->init_min; i < softc->init_max; i++){
8347						if (ctl_get_prkey(lun, i) == 0)
8348							continue;
8349						ctl_est_ua(lun, i,
8350						    CTL_UA_RES_RELEASE);
8351					}
8352				}
8353				lun->pr_res_type = 0;
8354			} else if (lun->pr_res_idx == CTL_PR_ALL_REGISTRANTS) {
8355				if (lun->pr_key_count==0) {
8356					lun->flags &= ~CTL_LUN_PR_RESERVED;
8357					lun->pr_res_type = 0;
8358					lun->pr_res_idx = CTL_PR_NO_RESERVATION;
8359				}
8360			}
8361			lun->pr_generation++;
8362			mtx_unlock(&lun->lun_lock);
8363
8364			persis_io.hdr.nexus = ctsio->io_hdr.nexus;
8365			persis_io.hdr.msg_type = CTL_MSG_PERS_ACTION;
8366			persis_io.pr.pr_info.action = CTL_PR_UNREG_KEY;
8367			persis_io.pr.pr_info.residx = residx;
8368			ctl_ha_msg_send(CTL_HA_CHAN_CTL, &persis_io,
8369			    sizeof(persis_io.pr), M_WAITOK);
8370		} else /* sa_res_key != 0 */ {
8371
8372			/*
8373			 * If we aren't registered currently then increment
8374			 * the key count and set the registered flag.
8375			 */
8376			ctl_alloc_prkey(lun, residx);
8377			if (ctl_get_prkey(lun, residx) == 0)
8378				lun->pr_key_count++;
8379			ctl_set_prkey(lun, residx, sa_res_key);
8380			lun->pr_generation++;
8381			mtx_unlock(&lun->lun_lock);
8382
8383			persis_io.hdr.nexus = ctsio->io_hdr.nexus;
8384			persis_io.hdr.msg_type = CTL_MSG_PERS_ACTION;
8385			persis_io.pr.pr_info.action = CTL_PR_REG_KEY;
8386			persis_io.pr.pr_info.residx = residx;
8387			memcpy(persis_io.pr.pr_info.sa_res_key,
8388			       param->serv_act_res_key,
8389			       sizeof(param->serv_act_res_key));
8390			ctl_ha_msg_send(CTL_HA_CHAN_CTL, &persis_io,
8391			    sizeof(persis_io.pr), M_WAITOK);
8392		}
8393
8394		break;
8395	}
8396	case SPRO_RESERVE:
8397#if 0
8398                printf("Reserve executed type %d\n", type);
8399#endif
8400		mtx_lock(&lun->lun_lock);
8401		if (lun->flags & CTL_LUN_PR_RESERVED) {
8402			/*
8403			 * if this isn't the reservation holder and it's
8404			 * not a "all registrants" type or if the type is
8405			 * different then we have a conflict
8406			 */
8407			if ((lun->pr_res_idx != residx
8408			  && lun->pr_res_idx != CTL_PR_ALL_REGISTRANTS)
8409			 || lun->pr_res_type != type) {
8410				mtx_unlock(&lun->lun_lock);
8411				free(ctsio->kern_data_ptr, M_CTL);
8412				ctl_set_reservation_conflict(ctsio);
8413				ctl_done((union ctl_io *)ctsio);
8414				return (CTL_RETVAL_COMPLETE);
8415			}
8416			mtx_unlock(&lun->lun_lock);
8417		} else /* create a reservation */ {
8418			/*
8419			 * If it's not an "all registrants" type record
8420			 * reservation holder
8421			 */
8422			if (type != SPR_TYPE_WR_EX_AR
8423			 && type != SPR_TYPE_EX_AC_AR)
8424				lun->pr_res_idx = residx; /* Res holder */
8425			else
8426				lun->pr_res_idx = CTL_PR_ALL_REGISTRANTS;
8427
8428			lun->flags |= CTL_LUN_PR_RESERVED;
8429			lun->pr_res_type = type;
8430
8431			mtx_unlock(&lun->lun_lock);
8432
8433			/* send msg to other side */
8434			persis_io.hdr.nexus = ctsio->io_hdr.nexus;
8435			persis_io.hdr.msg_type = CTL_MSG_PERS_ACTION;
8436			persis_io.pr.pr_info.action = CTL_PR_RESERVE;
8437			persis_io.pr.pr_info.residx = lun->pr_res_idx;
8438			persis_io.pr.pr_info.res_type = type;
8439			ctl_ha_msg_send(CTL_HA_CHAN_CTL, &persis_io,
8440			    sizeof(persis_io.pr), M_WAITOK);
8441		}
8442		break;
8443
8444	case SPRO_RELEASE:
8445		mtx_lock(&lun->lun_lock);
8446		if ((lun->flags & CTL_LUN_PR_RESERVED) == 0) {
8447			/* No reservation exists return good status */
8448			mtx_unlock(&lun->lun_lock);
8449			goto done;
8450		}
8451		/*
8452		 * Is this nexus a reservation holder?
8453		 */
8454		if (lun->pr_res_idx != residx
8455		 && lun->pr_res_idx != CTL_PR_ALL_REGISTRANTS) {
8456			/*
8457			 * not a res holder return good status but
8458			 * do nothing
8459			 */
8460			mtx_unlock(&lun->lun_lock);
8461			goto done;
8462		}
8463
8464		if (lun->pr_res_type != type) {
8465			mtx_unlock(&lun->lun_lock);
8466			free(ctsio->kern_data_ptr, M_CTL);
8467			ctl_set_illegal_pr_release(ctsio);
8468			ctl_done((union ctl_io *)ctsio);
8469			return (CTL_RETVAL_COMPLETE);
8470		}
8471
8472		/* okay to release */
8473		lun->flags &= ~CTL_LUN_PR_RESERVED;
8474		lun->pr_res_idx = CTL_PR_NO_RESERVATION;
8475		lun->pr_res_type = 0;
8476
8477		/*
8478		 * if this isn't an exclusive access
8479		 * res generate UA for all other
8480		 * registrants.
8481		 */
8482		if (type != SPR_TYPE_EX_AC
8483		 && type != SPR_TYPE_WR_EX) {
8484			for (i = softc->init_min; i < softc->init_max; i++) {
8485				if (i == residx || ctl_get_prkey(lun, i) == 0)
8486					continue;
8487				ctl_est_ua(lun, i, CTL_UA_RES_RELEASE);
8488			}
8489		}
8490		mtx_unlock(&lun->lun_lock);
8491
8492		/* Send msg to other side */
8493		persis_io.hdr.nexus = ctsio->io_hdr.nexus;
8494		persis_io.hdr.msg_type = CTL_MSG_PERS_ACTION;
8495		persis_io.pr.pr_info.action = CTL_PR_RELEASE;
8496		ctl_ha_msg_send(CTL_HA_CHAN_CTL, &persis_io,
8497		     sizeof(persis_io.pr), M_WAITOK);
8498		break;
8499
8500	case SPRO_CLEAR:
8501		/* send msg to other side */
8502
8503		mtx_lock(&lun->lun_lock);
8504		lun->flags &= ~CTL_LUN_PR_RESERVED;
8505		lun->pr_res_type = 0;
8506		lun->pr_key_count = 0;
8507		lun->pr_res_idx = CTL_PR_NO_RESERVATION;
8508
8509		ctl_clr_prkey(lun, residx);
8510		for (i = 0; i < CTL_MAX_INITIATORS; i++)
8511			if (ctl_get_prkey(lun, i) != 0) {
8512				ctl_clr_prkey(lun, i);
8513				ctl_est_ua(lun, i, CTL_UA_REG_PREEMPT);
8514			}
8515		lun->pr_generation++;
8516		mtx_unlock(&lun->lun_lock);
8517
8518		persis_io.hdr.nexus = ctsio->io_hdr.nexus;
8519		persis_io.hdr.msg_type = CTL_MSG_PERS_ACTION;
8520		persis_io.pr.pr_info.action = CTL_PR_CLEAR;
8521		ctl_ha_msg_send(CTL_HA_CHAN_CTL, &persis_io,
8522		     sizeof(persis_io.pr), M_WAITOK);
8523		break;
8524
8525	case SPRO_PREEMPT:
8526	case SPRO_PRE_ABO: {
8527		int nretval;
8528
8529		nretval = ctl_pro_preempt(softc, lun, res_key, sa_res_key, type,
8530					  residx, ctsio, cdb, param);
8531		if (nretval != 0)
8532			return (CTL_RETVAL_COMPLETE);
8533		break;
8534	}
8535	default:
8536		panic("%s: Invalid PR type %#x", __func__, cdb->action);
8537	}
8538
8539done:
8540	free(ctsio->kern_data_ptr, M_CTL);
8541	ctl_set_success(ctsio);
8542	ctl_done((union ctl_io *)ctsio);
8543
8544	return (retval);
8545}
8546
8547/*
8548 * This routine is for handling a message from the other SC pertaining to
8549 * persistent reserve out. All the error checking will have been done
8550 * so only perorming the action need be done here to keep the two
8551 * in sync.
8552 */
8553static void
8554ctl_hndl_per_res_out_on_other_sc(union ctl_ha_msg *msg)
8555{
8556	struct ctl_softc *softc = control_softc;
8557	struct ctl_lun *lun;
8558	int i;
8559	uint32_t residx, targ_lun;
8560
8561	targ_lun = msg->hdr.nexus.targ_mapped_lun;
8562	mtx_lock(&softc->ctl_lock);
8563	if ((targ_lun >= CTL_MAX_LUNS) ||
8564	    ((lun = softc->ctl_luns[targ_lun]) == NULL)) {
8565		mtx_unlock(&softc->ctl_lock);
8566		return;
8567	}
8568	mtx_lock(&lun->lun_lock);
8569	mtx_unlock(&softc->ctl_lock);
8570	if (lun->flags & CTL_LUN_DISABLED) {
8571		mtx_unlock(&lun->lun_lock);
8572		return;
8573	}
8574	residx = ctl_get_initindex(&msg->hdr.nexus);
8575	switch(msg->pr.pr_info.action) {
8576	case CTL_PR_REG_KEY:
8577		ctl_alloc_prkey(lun, msg->pr.pr_info.residx);
8578		if (ctl_get_prkey(lun, msg->pr.pr_info.residx) == 0)
8579			lun->pr_key_count++;
8580		ctl_set_prkey(lun, msg->pr.pr_info.residx,
8581		    scsi_8btou64(msg->pr.pr_info.sa_res_key));
8582		lun->pr_generation++;
8583		break;
8584
8585	case CTL_PR_UNREG_KEY:
8586		ctl_clr_prkey(lun, msg->pr.pr_info.residx);
8587		lun->pr_key_count--;
8588
8589		/* XXX Need to see if the reservation has been released */
8590		/* if so do we need to generate UA? */
8591		if (msg->pr.pr_info.residx == lun->pr_res_idx) {
8592			lun->flags &= ~CTL_LUN_PR_RESERVED;
8593			lun->pr_res_idx = CTL_PR_NO_RESERVATION;
8594
8595			if ((lun->pr_res_type == SPR_TYPE_WR_EX_RO ||
8596			     lun->pr_res_type == SPR_TYPE_EX_AC_RO) &&
8597			    lun->pr_key_count) {
8598				/*
8599				 * If the reservation is a registrants
8600				 * only type we need to generate a UA
8601				 * for other registered inits.  The
8602				 * sense code should be RESERVATIONS
8603				 * RELEASED
8604				 */
8605
8606				for (i = softc->init_min; i < softc->init_max; i++) {
8607					if (ctl_get_prkey(lun, i) == 0)
8608						continue;
8609
8610					ctl_est_ua(lun, i, CTL_UA_RES_RELEASE);
8611				}
8612			}
8613			lun->pr_res_type = 0;
8614		} else if (lun->pr_res_idx == CTL_PR_ALL_REGISTRANTS) {
8615			if (lun->pr_key_count==0) {
8616				lun->flags &= ~CTL_LUN_PR_RESERVED;
8617				lun->pr_res_type = 0;
8618				lun->pr_res_idx = CTL_PR_NO_RESERVATION;
8619			}
8620		}
8621		lun->pr_generation++;
8622		break;
8623
8624	case CTL_PR_RESERVE:
8625		lun->flags |= CTL_LUN_PR_RESERVED;
8626		lun->pr_res_type = msg->pr.pr_info.res_type;
8627		lun->pr_res_idx = msg->pr.pr_info.residx;
8628
8629		break;
8630
8631	case CTL_PR_RELEASE:
8632		/*
8633		 * if this isn't an exclusive access res generate UA for all
8634		 * other registrants.
8635		 */
8636		if (lun->pr_res_type != SPR_TYPE_EX_AC &&
8637		    lun->pr_res_type != SPR_TYPE_WR_EX) {
8638			for (i = softc->init_min; i < softc->init_max; i++)
8639				if (i == residx || ctl_get_prkey(lun, i) == 0)
8640					continue;
8641				ctl_est_ua(lun, i, CTL_UA_RES_RELEASE);
8642		}
8643
8644		lun->flags &= ~CTL_LUN_PR_RESERVED;
8645		lun->pr_res_idx = CTL_PR_NO_RESERVATION;
8646		lun->pr_res_type = 0;
8647		break;
8648
8649	case CTL_PR_PREEMPT:
8650		ctl_pro_preempt_other(lun, msg);
8651		break;
8652	case CTL_PR_CLEAR:
8653		lun->flags &= ~CTL_LUN_PR_RESERVED;
8654		lun->pr_res_type = 0;
8655		lun->pr_key_count = 0;
8656		lun->pr_res_idx = CTL_PR_NO_RESERVATION;
8657
8658		for (i=0; i < CTL_MAX_INITIATORS; i++) {
8659			if (ctl_get_prkey(lun, i) == 0)
8660				continue;
8661			ctl_clr_prkey(lun, i);
8662			ctl_est_ua(lun, i, CTL_UA_REG_PREEMPT);
8663		}
8664		lun->pr_generation++;
8665		break;
8666	}
8667
8668	mtx_unlock(&lun->lun_lock);
8669}
8670
8671int
8672ctl_read_write(struct ctl_scsiio *ctsio)
8673{
8674	struct ctl_lun *lun;
8675	struct ctl_lba_len_flags *lbalen;
8676	uint64_t lba;
8677	uint32_t num_blocks;
8678	int flags, retval;
8679	int isread;
8680
8681	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
8682
8683	CTL_DEBUG_PRINT(("ctl_read_write: command: %#x\n", ctsio->cdb[0]));
8684
8685	flags = 0;
8686	isread = ctsio->cdb[0] == READ_6  || ctsio->cdb[0] == READ_10
8687	      || ctsio->cdb[0] == READ_12 || ctsio->cdb[0] == READ_16;
8688	switch (ctsio->cdb[0]) {
8689	case READ_6:
8690	case WRITE_6: {
8691		struct scsi_rw_6 *cdb;
8692
8693		cdb = (struct scsi_rw_6 *)ctsio->cdb;
8694
8695		lba = scsi_3btoul(cdb->addr);
8696		/* only 5 bits are valid in the most significant address byte */
8697		lba &= 0x1fffff;
8698		num_blocks = cdb->length;
8699		/*
8700		 * This is correct according to SBC-2.
8701		 */
8702		if (num_blocks == 0)
8703			num_blocks = 256;
8704		break;
8705	}
8706	case READ_10:
8707	case WRITE_10: {
8708		struct scsi_rw_10 *cdb;
8709
8710		cdb = (struct scsi_rw_10 *)ctsio->cdb;
8711		if (cdb->byte2 & SRW10_FUA)
8712			flags |= CTL_LLF_FUA;
8713		if (cdb->byte2 & SRW10_DPO)
8714			flags |= CTL_LLF_DPO;
8715		lba = scsi_4btoul(cdb->addr);
8716		num_blocks = scsi_2btoul(cdb->length);
8717		break;
8718	}
8719	case WRITE_VERIFY_10: {
8720		struct scsi_write_verify_10 *cdb;
8721
8722		cdb = (struct scsi_write_verify_10 *)ctsio->cdb;
8723		flags |= CTL_LLF_FUA;
8724		if (cdb->byte2 & SWV_DPO)
8725			flags |= CTL_LLF_DPO;
8726		lba = scsi_4btoul(cdb->addr);
8727		num_blocks = scsi_2btoul(cdb->length);
8728		break;
8729	}
8730	case READ_12:
8731	case WRITE_12: {
8732		struct scsi_rw_12 *cdb;
8733
8734		cdb = (struct scsi_rw_12 *)ctsio->cdb;
8735		if (cdb->byte2 & SRW12_FUA)
8736			flags |= CTL_LLF_FUA;
8737		if (cdb->byte2 & SRW12_DPO)
8738			flags |= CTL_LLF_DPO;
8739		lba = scsi_4btoul(cdb->addr);
8740		num_blocks = scsi_4btoul(cdb->length);
8741		break;
8742	}
8743	case WRITE_VERIFY_12: {
8744		struct scsi_write_verify_12 *cdb;
8745
8746		cdb = (struct scsi_write_verify_12 *)ctsio->cdb;
8747		flags |= CTL_LLF_FUA;
8748		if (cdb->byte2 & SWV_DPO)
8749			flags |= CTL_LLF_DPO;
8750		lba = scsi_4btoul(cdb->addr);
8751		num_blocks = scsi_4btoul(cdb->length);
8752		break;
8753	}
8754	case READ_16:
8755	case WRITE_16: {
8756		struct scsi_rw_16 *cdb;
8757
8758		cdb = (struct scsi_rw_16 *)ctsio->cdb;
8759		if (cdb->byte2 & SRW12_FUA)
8760			flags |= CTL_LLF_FUA;
8761		if (cdb->byte2 & SRW12_DPO)
8762			flags |= CTL_LLF_DPO;
8763		lba = scsi_8btou64(cdb->addr);
8764		num_blocks = scsi_4btoul(cdb->length);
8765		break;
8766	}
8767	case WRITE_ATOMIC_16: {
8768		struct scsi_write_atomic_16 *cdb;
8769
8770		if (lun->be_lun->atomicblock == 0) {
8771			ctl_set_invalid_opcode(ctsio);
8772			ctl_done((union ctl_io *)ctsio);
8773			return (CTL_RETVAL_COMPLETE);
8774		}
8775
8776		cdb = (struct scsi_write_atomic_16 *)ctsio->cdb;
8777		if (cdb->byte2 & SRW12_FUA)
8778			flags |= CTL_LLF_FUA;
8779		if (cdb->byte2 & SRW12_DPO)
8780			flags |= CTL_LLF_DPO;
8781		lba = scsi_8btou64(cdb->addr);
8782		num_blocks = scsi_2btoul(cdb->length);
8783		if (num_blocks > lun->be_lun->atomicblock) {
8784			ctl_set_invalid_field(ctsio, /*sks_valid*/ 1,
8785			    /*command*/ 1, /*field*/ 12, /*bit_valid*/ 0,
8786			    /*bit*/ 0);
8787			ctl_done((union ctl_io *)ctsio);
8788			return (CTL_RETVAL_COMPLETE);
8789		}
8790		break;
8791	}
8792	case WRITE_VERIFY_16: {
8793		struct scsi_write_verify_16 *cdb;
8794
8795		cdb = (struct scsi_write_verify_16 *)ctsio->cdb;
8796		flags |= CTL_LLF_FUA;
8797		if (cdb->byte2 & SWV_DPO)
8798			flags |= CTL_LLF_DPO;
8799		lba = scsi_8btou64(cdb->addr);
8800		num_blocks = scsi_4btoul(cdb->length);
8801		break;
8802	}
8803	default:
8804		/*
8805		 * We got a command we don't support.  This shouldn't
8806		 * happen, commands should be filtered out above us.
8807		 */
8808		ctl_set_invalid_opcode(ctsio);
8809		ctl_done((union ctl_io *)ctsio);
8810
8811		return (CTL_RETVAL_COMPLETE);
8812		break; /* NOTREACHED */
8813	}
8814
8815	/*
8816	 * The first check is to make sure we're in bounds, the second
8817	 * check is to catch wrap-around problems.  If the lba + num blocks
8818	 * is less than the lba, then we've wrapped around and the block
8819	 * range is invalid anyway.
8820	 */
8821	if (((lba + num_blocks) > (lun->be_lun->maxlba + 1))
8822	 || ((lba + num_blocks) < lba)) {
8823		ctl_set_lba_out_of_range(ctsio);
8824		ctl_done((union ctl_io *)ctsio);
8825		return (CTL_RETVAL_COMPLETE);
8826	}
8827
8828	/*
8829	 * According to SBC-3, a transfer length of 0 is not an error.
8830	 * Note that this cannot happen with WRITE(6) or READ(6), since 0
8831	 * translates to 256 blocks for those commands.
8832	 */
8833	if (num_blocks == 0) {
8834		ctl_set_success(ctsio);
8835		ctl_done((union ctl_io *)ctsio);
8836		return (CTL_RETVAL_COMPLETE);
8837	}
8838
8839	/* Set FUA and/or DPO if caches are disabled. */
8840	if (isread) {
8841		if ((lun->mode_pages.caching_page[CTL_PAGE_CURRENT].flags1 &
8842		    SCP_RCD) != 0)
8843			flags |= CTL_LLF_FUA | CTL_LLF_DPO;
8844	} else {
8845		if ((lun->mode_pages.caching_page[CTL_PAGE_CURRENT].flags1 &
8846		    SCP_WCE) == 0)
8847			flags |= CTL_LLF_FUA;
8848	}
8849
8850	lbalen = (struct ctl_lba_len_flags *)
8851	    &ctsio->io_hdr.ctl_private[CTL_PRIV_LBA_LEN];
8852	lbalen->lba = lba;
8853	lbalen->len = num_blocks;
8854	lbalen->flags = (isread ? CTL_LLF_READ : CTL_LLF_WRITE) | flags;
8855
8856	ctsio->kern_total_len = num_blocks * lun->be_lun->blocksize;
8857	ctsio->kern_rel_offset = 0;
8858
8859	CTL_DEBUG_PRINT(("ctl_read_write: calling data_submit()\n"));
8860
8861	retval = lun->backend->data_submit((union ctl_io *)ctsio);
8862	return (retval);
8863}
8864
8865static int
8866ctl_cnw_cont(union ctl_io *io)
8867{
8868	struct ctl_scsiio *ctsio;
8869	struct ctl_lun *lun;
8870	struct ctl_lba_len_flags *lbalen;
8871	int retval;
8872
8873	ctsio = &io->scsiio;
8874	ctsio->io_hdr.status = CTL_STATUS_NONE;
8875	ctsio->io_hdr.flags &= ~CTL_FLAG_IO_CONT;
8876	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
8877	lbalen = (struct ctl_lba_len_flags *)
8878	    &ctsio->io_hdr.ctl_private[CTL_PRIV_LBA_LEN];
8879	lbalen->flags &= ~CTL_LLF_COMPARE;
8880	lbalen->flags |= CTL_LLF_WRITE;
8881
8882	CTL_DEBUG_PRINT(("ctl_cnw_cont: calling data_submit()\n"));
8883	retval = lun->backend->data_submit((union ctl_io *)ctsio);
8884	return (retval);
8885}
8886
8887int
8888ctl_cnw(struct ctl_scsiio *ctsio)
8889{
8890	struct ctl_lun *lun;
8891	struct ctl_lba_len_flags *lbalen;
8892	uint64_t lba;
8893	uint32_t num_blocks;
8894	int flags, retval;
8895
8896	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
8897
8898	CTL_DEBUG_PRINT(("ctl_cnw: command: %#x\n", ctsio->cdb[0]));
8899
8900	flags = 0;
8901	switch (ctsio->cdb[0]) {
8902	case COMPARE_AND_WRITE: {
8903		struct scsi_compare_and_write *cdb;
8904
8905		cdb = (struct scsi_compare_and_write *)ctsio->cdb;
8906		if (cdb->byte2 & SRW10_FUA)
8907			flags |= CTL_LLF_FUA;
8908		if (cdb->byte2 & SRW10_DPO)
8909			flags |= CTL_LLF_DPO;
8910		lba = scsi_8btou64(cdb->addr);
8911		num_blocks = cdb->length;
8912		break;
8913	}
8914	default:
8915		/*
8916		 * We got a command we don't support.  This shouldn't
8917		 * happen, commands should be filtered out above us.
8918		 */
8919		ctl_set_invalid_opcode(ctsio);
8920		ctl_done((union ctl_io *)ctsio);
8921
8922		return (CTL_RETVAL_COMPLETE);
8923		break; /* NOTREACHED */
8924	}
8925
8926	/*
8927	 * The first check is to make sure we're in bounds, the second
8928	 * check is to catch wrap-around problems.  If the lba + num blocks
8929	 * is less than the lba, then we've wrapped around and the block
8930	 * range is invalid anyway.
8931	 */
8932	if (((lba + num_blocks) > (lun->be_lun->maxlba + 1))
8933	 || ((lba + num_blocks) < lba)) {
8934		ctl_set_lba_out_of_range(ctsio);
8935		ctl_done((union ctl_io *)ctsio);
8936		return (CTL_RETVAL_COMPLETE);
8937	}
8938
8939	/*
8940	 * According to SBC-3, a transfer length of 0 is not an error.
8941	 */
8942	if (num_blocks == 0) {
8943		ctl_set_success(ctsio);
8944		ctl_done((union ctl_io *)ctsio);
8945		return (CTL_RETVAL_COMPLETE);
8946	}
8947
8948	/* Set FUA if write cache is disabled. */
8949	if ((lun->mode_pages.caching_page[CTL_PAGE_CURRENT].flags1 &
8950	    SCP_WCE) == 0)
8951		flags |= CTL_LLF_FUA;
8952
8953	ctsio->kern_total_len = 2 * num_blocks * lun->be_lun->blocksize;
8954	ctsio->kern_rel_offset = 0;
8955
8956	/*
8957	 * Set the IO_CONT flag, so that if this I/O gets passed to
8958	 * ctl_data_submit_done(), it'll get passed back to
8959	 * ctl_ctl_cnw_cont() for further processing.
8960	 */
8961	ctsio->io_hdr.flags |= CTL_FLAG_IO_CONT;
8962	ctsio->io_cont = ctl_cnw_cont;
8963
8964	lbalen = (struct ctl_lba_len_flags *)
8965	    &ctsio->io_hdr.ctl_private[CTL_PRIV_LBA_LEN];
8966	lbalen->lba = lba;
8967	lbalen->len = num_blocks;
8968	lbalen->flags = CTL_LLF_COMPARE | flags;
8969
8970	CTL_DEBUG_PRINT(("ctl_cnw: calling data_submit()\n"));
8971	retval = lun->backend->data_submit((union ctl_io *)ctsio);
8972	return (retval);
8973}
8974
8975int
8976ctl_verify(struct ctl_scsiio *ctsio)
8977{
8978	struct ctl_lun *lun;
8979	struct ctl_lba_len_flags *lbalen;
8980	uint64_t lba;
8981	uint32_t num_blocks;
8982	int bytchk, flags;
8983	int retval;
8984
8985	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
8986
8987	CTL_DEBUG_PRINT(("ctl_verify: command: %#x\n", ctsio->cdb[0]));
8988
8989	bytchk = 0;
8990	flags = CTL_LLF_FUA;
8991	switch (ctsio->cdb[0]) {
8992	case VERIFY_10: {
8993		struct scsi_verify_10 *cdb;
8994
8995		cdb = (struct scsi_verify_10 *)ctsio->cdb;
8996		if (cdb->byte2 & SVFY_BYTCHK)
8997			bytchk = 1;
8998		if (cdb->byte2 & SVFY_DPO)
8999			flags |= CTL_LLF_DPO;
9000		lba = scsi_4btoul(cdb->addr);
9001		num_blocks = scsi_2btoul(cdb->length);
9002		break;
9003	}
9004	case VERIFY_12: {
9005		struct scsi_verify_12 *cdb;
9006
9007		cdb = (struct scsi_verify_12 *)ctsio->cdb;
9008		if (cdb->byte2 & SVFY_BYTCHK)
9009			bytchk = 1;
9010		if (cdb->byte2 & SVFY_DPO)
9011			flags |= CTL_LLF_DPO;
9012		lba = scsi_4btoul(cdb->addr);
9013		num_blocks = scsi_4btoul(cdb->length);
9014		break;
9015	}
9016	case VERIFY_16: {
9017		struct scsi_rw_16 *cdb;
9018
9019		cdb = (struct scsi_rw_16 *)ctsio->cdb;
9020		if (cdb->byte2 & SVFY_BYTCHK)
9021			bytchk = 1;
9022		if (cdb->byte2 & SVFY_DPO)
9023			flags |= CTL_LLF_DPO;
9024		lba = scsi_8btou64(cdb->addr);
9025		num_blocks = scsi_4btoul(cdb->length);
9026		break;
9027	}
9028	default:
9029		/*
9030		 * We got a command we don't support.  This shouldn't
9031		 * happen, commands should be filtered out above us.
9032		 */
9033		ctl_set_invalid_opcode(ctsio);
9034		ctl_done((union ctl_io *)ctsio);
9035		return (CTL_RETVAL_COMPLETE);
9036	}
9037
9038	/*
9039	 * The first check is to make sure we're in bounds, the second
9040	 * check is to catch wrap-around problems.  If the lba + num blocks
9041	 * is less than the lba, then we've wrapped around and the block
9042	 * range is invalid anyway.
9043	 */
9044	if (((lba + num_blocks) > (lun->be_lun->maxlba + 1))
9045	 || ((lba + num_blocks) < lba)) {
9046		ctl_set_lba_out_of_range(ctsio);
9047		ctl_done((union ctl_io *)ctsio);
9048		return (CTL_RETVAL_COMPLETE);
9049	}
9050
9051	/*
9052	 * According to SBC-3, a transfer length of 0 is not an error.
9053	 */
9054	if (num_blocks == 0) {
9055		ctl_set_success(ctsio);
9056		ctl_done((union ctl_io *)ctsio);
9057		return (CTL_RETVAL_COMPLETE);
9058	}
9059
9060	lbalen = (struct ctl_lba_len_flags *)
9061	    &ctsio->io_hdr.ctl_private[CTL_PRIV_LBA_LEN];
9062	lbalen->lba = lba;
9063	lbalen->len = num_blocks;
9064	if (bytchk) {
9065		lbalen->flags = CTL_LLF_COMPARE | flags;
9066		ctsio->kern_total_len = num_blocks * lun->be_lun->blocksize;
9067	} else {
9068		lbalen->flags = CTL_LLF_VERIFY | flags;
9069		ctsio->kern_total_len = 0;
9070	}
9071	ctsio->kern_rel_offset = 0;
9072
9073	CTL_DEBUG_PRINT(("ctl_verify: calling data_submit()\n"));
9074	retval = lun->backend->data_submit((union ctl_io *)ctsio);
9075	return (retval);
9076}
9077
9078int
9079ctl_report_luns(struct ctl_scsiio *ctsio)
9080{
9081	struct ctl_softc *softc;
9082	struct scsi_report_luns *cdb;
9083	struct scsi_report_luns_data *lun_data;
9084	struct ctl_lun *lun, *request_lun;
9085	struct ctl_port *port;
9086	int num_luns, retval;
9087	uint32_t alloc_len, lun_datalen;
9088	int num_filled;
9089	uint32_t initidx, targ_lun_id, lun_id;
9090
9091	retval = CTL_RETVAL_COMPLETE;
9092	cdb = (struct scsi_report_luns *)ctsio->cdb;
9093	port = ctl_io_port(&ctsio->io_hdr);
9094	softc = port->ctl_softc;
9095
9096	CTL_DEBUG_PRINT(("ctl_report_luns\n"));
9097
9098	mtx_lock(&softc->ctl_lock);
9099	num_luns = 0;
9100	for (targ_lun_id = 0; targ_lun_id < CTL_MAX_LUNS; targ_lun_id++) {
9101		if (ctl_lun_map_from_port(port, targ_lun_id) < CTL_MAX_LUNS)
9102			num_luns++;
9103	}
9104	mtx_unlock(&softc->ctl_lock);
9105
9106	switch (cdb->select_report) {
9107	case RPL_REPORT_DEFAULT:
9108	case RPL_REPORT_ALL:
9109	case RPL_REPORT_NONSUBSID:
9110		break;
9111	case RPL_REPORT_WELLKNOWN:
9112	case RPL_REPORT_ADMIN:
9113	case RPL_REPORT_CONGLOM:
9114		num_luns = 0;
9115		break;
9116	default:
9117		ctl_set_invalid_field(ctsio,
9118				      /*sks_valid*/ 1,
9119				      /*command*/ 1,
9120				      /*field*/ 2,
9121				      /*bit_valid*/ 0,
9122				      /*bit*/ 0);
9123		ctl_done((union ctl_io *)ctsio);
9124		return (retval);
9125		break; /* NOTREACHED */
9126	}
9127
9128	alloc_len = scsi_4btoul(cdb->length);
9129	/*
9130	 * The initiator has to allocate at least 16 bytes for this request,
9131	 * so he can at least get the header and the first LUN.  Otherwise
9132	 * we reject the request (per SPC-3 rev 14, section 6.21).
9133	 */
9134	if (alloc_len < (sizeof(struct scsi_report_luns_data) +
9135	    sizeof(struct scsi_report_luns_lundata))) {
9136		ctl_set_invalid_field(ctsio,
9137				      /*sks_valid*/ 1,
9138				      /*command*/ 1,
9139				      /*field*/ 6,
9140				      /*bit_valid*/ 0,
9141				      /*bit*/ 0);
9142		ctl_done((union ctl_io *)ctsio);
9143		return (retval);
9144	}
9145
9146	request_lun = (struct ctl_lun *)
9147		ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
9148
9149	lun_datalen = sizeof(*lun_data) +
9150		(num_luns * sizeof(struct scsi_report_luns_lundata));
9151
9152	ctsio->kern_data_ptr = malloc(lun_datalen, M_CTL, M_WAITOK | M_ZERO);
9153	lun_data = (struct scsi_report_luns_data *)ctsio->kern_data_ptr;
9154	ctsio->kern_sg_entries = 0;
9155
9156	initidx = ctl_get_initindex(&ctsio->io_hdr.nexus);
9157
9158	mtx_lock(&softc->ctl_lock);
9159	for (targ_lun_id = 0, num_filled = 0; targ_lun_id < CTL_MAX_LUNS && num_filled < num_luns; targ_lun_id++) {
9160		lun_id = ctl_lun_map_from_port(port, targ_lun_id);
9161		if (lun_id >= CTL_MAX_LUNS)
9162			continue;
9163		lun = softc->ctl_luns[lun_id];
9164		if (lun == NULL)
9165			continue;
9166
9167		be64enc(lun_data->luns[num_filled++].lundata,
9168		    ctl_encode_lun(targ_lun_id));
9169
9170		/*
9171		 * According to SPC-3, rev 14 section 6.21:
9172		 *
9173		 * "The execution of a REPORT LUNS command to any valid and
9174		 * installed logical unit shall clear the REPORTED LUNS DATA
9175		 * HAS CHANGED unit attention condition for all logical
9176		 * units of that target with respect to the requesting
9177		 * initiator. A valid and installed logical unit is one
9178		 * having a PERIPHERAL QUALIFIER of 000b in the standard
9179		 * INQUIRY data (see 6.4.2)."
9180		 *
9181		 * If request_lun is NULL, the LUN this report luns command
9182		 * was issued to is either disabled or doesn't exist. In that
9183		 * case, we shouldn't clear any pending lun change unit
9184		 * attention.
9185		 */
9186		if (request_lun != NULL) {
9187			mtx_lock(&lun->lun_lock);
9188			ctl_clr_ua(lun, initidx, CTL_UA_LUN_CHANGE);
9189			mtx_unlock(&lun->lun_lock);
9190		}
9191	}
9192	mtx_unlock(&softc->ctl_lock);
9193
9194	/*
9195	 * It's quite possible that we've returned fewer LUNs than we allocated
9196	 * space for.  Trim it.
9197	 */
9198	lun_datalen = sizeof(*lun_data) +
9199		(num_filled * sizeof(struct scsi_report_luns_lundata));
9200
9201	if (lun_datalen < alloc_len) {
9202		ctsio->residual = alloc_len - lun_datalen;
9203		ctsio->kern_data_len = lun_datalen;
9204		ctsio->kern_total_len = lun_datalen;
9205	} else {
9206		ctsio->residual = 0;
9207		ctsio->kern_data_len = alloc_len;
9208		ctsio->kern_total_len = alloc_len;
9209	}
9210	ctsio->kern_data_resid = 0;
9211	ctsio->kern_rel_offset = 0;
9212	ctsio->kern_sg_entries = 0;
9213
9214	/*
9215	 * We set this to the actual data length, regardless of how much
9216	 * space we actually have to return results.  If the user looks at
9217	 * this value, he'll know whether or not he allocated enough space
9218	 * and reissue the command if necessary.  We don't support well
9219	 * known logical units, so if the user asks for that, return none.
9220	 */
9221	scsi_ulto4b(lun_datalen - 8, lun_data->length);
9222
9223	/*
9224	 * We can only return SCSI_STATUS_CHECK_COND when we can't satisfy
9225	 * this request.
9226	 */
9227	ctl_set_success(ctsio);
9228	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
9229	ctsio->be_move_done = ctl_config_move_done;
9230	ctl_datamove((union ctl_io *)ctsio);
9231	return (retval);
9232}
9233
9234int
9235ctl_request_sense(struct ctl_scsiio *ctsio)
9236{
9237	struct scsi_request_sense *cdb;
9238	struct scsi_sense_data *sense_ptr;
9239	struct ctl_softc *ctl_softc;
9240	struct ctl_lun *lun;
9241	uint32_t initidx;
9242	int have_error;
9243	scsi_sense_data_type sense_format;
9244	ctl_ua_type ua_type;
9245
9246	cdb = (struct scsi_request_sense *)ctsio->cdb;
9247
9248	ctl_softc = control_softc;
9249	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
9250
9251	CTL_DEBUG_PRINT(("ctl_request_sense\n"));
9252
9253	/*
9254	 * Determine which sense format the user wants.
9255	 */
9256	if (cdb->byte2 & SRS_DESC)
9257		sense_format = SSD_TYPE_DESC;
9258	else
9259		sense_format = SSD_TYPE_FIXED;
9260
9261	ctsio->kern_data_ptr = malloc(sizeof(*sense_ptr), M_CTL, M_WAITOK);
9262	sense_ptr = (struct scsi_sense_data *)ctsio->kern_data_ptr;
9263	ctsio->kern_sg_entries = 0;
9264
9265	/*
9266	 * struct scsi_sense_data, which is currently set to 256 bytes, is
9267	 * larger than the largest allowed value for the length field in the
9268	 * REQUEST SENSE CDB, which is 252 bytes as of SPC-4.
9269	 */
9270	ctsio->residual = 0;
9271	ctsio->kern_data_len = cdb->length;
9272	ctsio->kern_total_len = cdb->length;
9273
9274	ctsio->kern_data_resid = 0;
9275	ctsio->kern_rel_offset = 0;
9276	ctsio->kern_sg_entries = 0;
9277
9278	/*
9279	 * If we don't have a LUN, we don't have any pending sense.
9280	 */
9281	if (lun == NULL)
9282		goto no_sense;
9283
9284	have_error = 0;
9285	initidx = ctl_get_initindex(&ctsio->io_hdr.nexus);
9286	/*
9287	 * Check for pending sense, and then for pending unit attentions.
9288	 * Pending sense gets returned first, then pending unit attentions.
9289	 */
9290	mtx_lock(&lun->lun_lock);
9291#ifdef CTL_WITH_CA
9292	if (ctl_is_set(lun->have_ca, initidx)) {
9293		scsi_sense_data_type stored_format;
9294
9295		/*
9296		 * Check to see which sense format was used for the stored
9297		 * sense data.
9298		 */
9299		stored_format = scsi_sense_type(&lun->pending_sense[initidx]);
9300
9301		/*
9302		 * If the user requested a different sense format than the
9303		 * one we stored, then we need to convert it to the other
9304		 * format.  If we're going from descriptor to fixed format
9305		 * sense data, we may lose things in translation, depending
9306		 * on what options were used.
9307		 *
9308		 * If the stored format is SSD_TYPE_NONE (i.e. invalid),
9309		 * for some reason we'll just copy it out as-is.
9310		 */
9311		if ((stored_format == SSD_TYPE_FIXED)
9312		 && (sense_format == SSD_TYPE_DESC))
9313			ctl_sense_to_desc((struct scsi_sense_data_fixed *)
9314			    &lun->pending_sense[initidx],
9315			    (struct scsi_sense_data_desc *)sense_ptr);
9316		else if ((stored_format == SSD_TYPE_DESC)
9317		      && (sense_format == SSD_TYPE_FIXED))
9318			ctl_sense_to_fixed((struct scsi_sense_data_desc *)
9319			    &lun->pending_sense[initidx],
9320			    (struct scsi_sense_data_fixed *)sense_ptr);
9321		else
9322			memcpy(sense_ptr, &lun->pending_sense[initidx],
9323			       MIN(sizeof(*sense_ptr),
9324			       sizeof(lun->pending_sense[initidx])));
9325
9326		ctl_clear_mask(lun->have_ca, initidx);
9327		have_error = 1;
9328	} else
9329#endif
9330	{
9331		ua_type = ctl_build_ua(lun, initidx, sense_ptr, sense_format);
9332		if (ua_type != CTL_UA_NONE)
9333			have_error = 1;
9334		if (ua_type == CTL_UA_LUN_CHANGE) {
9335			mtx_unlock(&lun->lun_lock);
9336			mtx_lock(&ctl_softc->ctl_lock);
9337			ctl_clr_ua_allluns(ctl_softc, initidx, ua_type);
9338			mtx_unlock(&ctl_softc->ctl_lock);
9339			mtx_lock(&lun->lun_lock);
9340		}
9341
9342	}
9343	mtx_unlock(&lun->lun_lock);
9344
9345	/*
9346	 * We already have a pending error, return it.
9347	 */
9348	if (have_error != 0) {
9349		/*
9350		 * We report the SCSI status as OK, since the status of the
9351		 * request sense command itself is OK.
9352		 * We report 0 for the sense length, because we aren't doing
9353		 * autosense in this case.  We're reporting sense as
9354		 * parameter data.
9355		 */
9356		ctl_set_success(ctsio);
9357		ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
9358		ctsio->be_move_done = ctl_config_move_done;
9359		ctl_datamove((union ctl_io *)ctsio);
9360		return (CTL_RETVAL_COMPLETE);
9361	}
9362
9363no_sense:
9364
9365	/*
9366	 * No sense information to report, so we report that everything is
9367	 * okay.
9368	 */
9369	ctl_set_sense_data(sense_ptr,
9370			   lun,
9371			   sense_format,
9372			   /*current_error*/ 1,
9373			   /*sense_key*/ SSD_KEY_NO_SENSE,
9374			   /*asc*/ 0x00,
9375			   /*ascq*/ 0x00,
9376			   SSD_ELEM_NONE);
9377
9378	/*
9379	 * We report 0 for the sense length, because we aren't doing
9380	 * autosense in this case.  We're reporting sense as parameter data.
9381	 */
9382	ctl_set_success(ctsio);
9383	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
9384	ctsio->be_move_done = ctl_config_move_done;
9385	ctl_datamove((union ctl_io *)ctsio);
9386	return (CTL_RETVAL_COMPLETE);
9387}
9388
9389int
9390ctl_tur(struct ctl_scsiio *ctsio)
9391{
9392
9393	CTL_DEBUG_PRINT(("ctl_tur\n"));
9394
9395	ctl_set_success(ctsio);
9396	ctl_done((union ctl_io *)ctsio);
9397
9398	return (CTL_RETVAL_COMPLETE);
9399}
9400
9401/*
9402 * SCSI VPD page 0x00, the Supported VPD Pages page.
9403 */
9404static int
9405ctl_inquiry_evpd_supported(struct ctl_scsiio *ctsio, int alloc_len)
9406{
9407	struct scsi_vpd_supported_pages *pages;
9408	int sup_page_size;
9409	struct ctl_lun *lun;
9410	int p;
9411
9412	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
9413
9414	sup_page_size = sizeof(struct scsi_vpd_supported_pages) *
9415	    SCSI_EVPD_NUM_SUPPORTED_PAGES;
9416	ctsio->kern_data_ptr = malloc(sup_page_size, M_CTL, M_WAITOK | M_ZERO);
9417	pages = (struct scsi_vpd_supported_pages *)ctsio->kern_data_ptr;
9418	ctsio->kern_sg_entries = 0;
9419
9420	if (sup_page_size < alloc_len) {
9421		ctsio->residual = alloc_len - sup_page_size;
9422		ctsio->kern_data_len = sup_page_size;
9423		ctsio->kern_total_len = sup_page_size;
9424	} else {
9425		ctsio->residual = 0;
9426		ctsio->kern_data_len = alloc_len;
9427		ctsio->kern_total_len = alloc_len;
9428	}
9429	ctsio->kern_data_resid = 0;
9430	ctsio->kern_rel_offset = 0;
9431	ctsio->kern_sg_entries = 0;
9432
9433	/*
9434	 * The control device is always connected.  The disk device, on the
9435	 * other hand, may not be online all the time.  Need to change this
9436	 * to figure out whether the disk device is actually online or not.
9437	 */
9438	if (lun != NULL)
9439		pages->device = (SID_QUAL_LU_CONNECTED << 5) |
9440				lun->be_lun->lun_type;
9441	else
9442		pages->device = (SID_QUAL_LU_OFFLINE << 5) | T_DIRECT;
9443
9444	p = 0;
9445	/* Supported VPD pages */
9446	pages->page_list[p++] = SVPD_SUPPORTED_PAGES;
9447	/* Serial Number */
9448	pages->page_list[p++] = SVPD_UNIT_SERIAL_NUMBER;
9449	/* Device Identification */
9450	pages->page_list[p++] = SVPD_DEVICE_ID;
9451	/* Extended INQUIRY Data */
9452	pages->page_list[p++] = SVPD_EXTENDED_INQUIRY_DATA;
9453	/* Mode Page Policy */
9454	pages->page_list[p++] = SVPD_MODE_PAGE_POLICY;
9455	/* SCSI Ports */
9456	pages->page_list[p++] = SVPD_SCSI_PORTS;
9457	/* Third-party Copy */
9458	pages->page_list[p++] = SVPD_SCSI_TPC;
9459	if (lun != NULL && lun->be_lun->lun_type == T_DIRECT) {
9460		/* Block limits */
9461		pages->page_list[p++] = SVPD_BLOCK_LIMITS;
9462		/* Block Device Characteristics */
9463		pages->page_list[p++] = SVPD_BDC;
9464		/* Logical Block Provisioning */
9465		pages->page_list[p++] = SVPD_LBP;
9466	}
9467	pages->length = p;
9468
9469	ctl_set_success(ctsio);
9470	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
9471	ctsio->be_move_done = ctl_config_move_done;
9472	ctl_datamove((union ctl_io *)ctsio);
9473	return (CTL_RETVAL_COMPLETE);
9474}
9475
9476/*
9477 * SCSI VPD page 0x80, the Unit Serial Number page.
9478 */
9479static int
9480ctl_inquiry_evpd_serial(struct ctl_scsiio *ctsio, int alloc_len)
9481{
9482	struct scsi_vpd_unit_serial_number *sn_ptr;
9483	struct ctl_lun *lun;
9484	int data_len;
9485
9486	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
9487
9488	data_len = 4 + CTL_SN_LEN;
9489	ctsio->kern_data_ptr = malloc(data_len, M_CTL, M_WAITOK | M_ZERO);
9490	sn_ptr = (struct scsi_vpd_unit_serial_number *)ctsio->kern_data_ptr;
9491	if (data_len < alloc_len) {
9492		ctsio->residual = alloc_len - data_len;
9493		ctsio->kern_data_len = data_len;
9494		ctsio->kern_total_len = data_len;
9495	} else {
9496		ctsio->residual = 0;
9497		ctsio->kern_data_len = alloc_len;
9498		ctsio->kern_total_len = alloc_len;
9499	}
9500	ctsio->kern_data_resid = 0;
9501	ctsio->kern_rel_offset = 0;
9502	ctsio->kern_sg_entries = 0;
9503
9504	/*
9505	 * The control device is always connected.  The disk device, on the
9506	 * other hand, may not be online all the time.  Need to change this
9507	 * to figure out whether the disk device is actually online or not.
9508	 */
9509	if (lun != NULL)
9510		sn_ptr->device = (SID_QUAL_LU_CONNECTED << 5) |
9511				  lun->be_lun->lun_type;
9512	else
9513		sn_ptr->device = (SID_QUAL_LU_OFFLINE << 5) | T_DIRECT;
9514
9515	sn_ptr->page_code = SVPD_UNIT_SERIAL_NUMBER;
9516	sn_ptr->length = CTL_SN_LEN;
9517	/*
9518	 * If we don't have a LUN, we just leave the serial number as
9519	 * all spaces.
9520	 */
9521	if (lun != NULL) {
9522		strncpy((char *)sn_ptr->serial_num,
9523			(char *)lun->be_lun->serial_num, CTL_SN_LEN);
9524	} else
9525		memset(sn_ptr->serial_num, 0x20, CTL_SN_LEN);
9526
9527	ctl_set_success(ctsio);
9528	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
9529	ctsio->be_move_done = ctl_config_move_done;
9530	ctl_datamove((union ctl_io *)ctsio);
9531	return (CTL_RETVAL_COMPLETE);
9532}
9533
9534
9535/*
9536 * SCSI VPD page 0x86, the Extended INQUIRY Data page.
9537 */
9538static int
9539ctl_inquiry_evpd_eid(struct ctl_scsiio *ctsio, int alloc_len)
9540{
9541	struct scsi_vpd_extended_inquiry_data *eid_ptr;
9542	struct ctl_lun *lun;
9543	int data_len;
9544
9545	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
9546
9547	data_len = sizeof(struct scsi_vpd_extended_inquiry_data);
9548	ctsio->kern_data_ptr = malloc(data_len, M_CTL, M_WAITOK | M_ZERO);
9549	eid_ptr = (struct scsi_vpd_extended_inquiry_data *)ctsio->kern_data_ptr;
9550	ctsio->kern_sg_entries = 0;
9551
9552	if (data_len < alloc_len) {
9553		ctsio->residual = alloc_len - data_len;
9554		ctsio->kern_data_len = data_len;
9555		ctsio->kern_total_len = data_len;
9556	} else {
9557		ctsio->residual = 0;
9558		ctsio->kern_data_len = alloc_len;
9559		ctsio->kern_total_len = alloc_len;
9560	}
9561	ctsio->kern_data_resid = 0;
9562	ctsio->kern_rel_offset = 0;
9563	ctsio->kern_sg_entries = 0;
9564
9565	/*
9566	 * The control device is always connected.  The disk device, on the
9567	 * other hand, may not be online all the time.
9568	 */
9569	if (lun != NULL)
9570		eid_ptr->device = (SID_QUAL_LU_CONNECTED << 5) |
9571				     lun->be_lun->lun_type;
9572	else
9573		eid_ptr->device = (SID_QUAL_LU_OFFLINE << 5) | T_DIRECT;
9574	eid_ptr->page_code = SVPD_EXTENDED_INQUIRY_DATA;
9575	scsi_ulto2b(data_len - 4, eid_ptr->page_length);
9576	/*
9577	 * We support head of queue, ordered and simple tags.
9578	 */
9579	eid_ptr->flags2 = SVPD_EID_HEADSUP | SVPD_EID_ORDSUP | SVPD_EID_SIMPSUP;
9580	/*
9581	 * Volatile cache supported.
9582	 */
9583	eid_ptr->flags3 = SVPD_EID_V_SUP;
9584
9585	/*
9586	 * This means that we clear the REPORTED LUNS DATA HAS CHANGED unit
9587	 * attention for a particular IT nexus on all LUNs once we report
9588	 * it to that nexus once.  This bit is required as of SPC-4.
9589	 */
9590	eid_ptr->flags4 = SVPD_EID_LUICLT;
9591
9592	/*
9593	 * XXX KDM in order to correctly answer this, we would need
9594	 * information from the SIM to determine how much sense data it
9595	 * can send.  So this would really be a path inquiry field, most
9596	 * likely.  This can be set to a maximum of 252 according to SPC-4,
9597	 * but the hardware may or may not be able to support that much.
9598	 * 0 just means that the maximum sense data length is not reported.
9599	 */
9600	eid_ptr->max_sense_length = 0;
9601
9602	ctl_set_success(ctsio);
9603	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
9604	ctsio->be_move_done = ctl_config_move_done;
9605	ctl_datamove((union ctl_io *)ctsio);
9606	return (CTL_RETVAL_COMPLETE);
9607}
9608
9609static int
9610ctl_inquiry_evpd_mpp(struct ctl_scsiio *ctsio, int alloc_len)
9611{
9612	struct scsi_vpd_mode_page_policy *mpp_ptr;
9613	struct ctl_lun *lun;
9614	int data_len;
9615
9616	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
9617
9618	data_len = sizeof(struct scsi_vpd_mode_page_policy) +
9619	    sizeof(struct scsi_vpd_mode_page_policy_descr);
9620
9621	ctsio->kern_data_ptr = malloc(data_len, M_CTL, M_WAITOK | M_ZERO);
9622	mpp_ptr = (struct scsi_vpd_mode_page_policy *)ctsio->kern_data_ptr;
9623	ctsio->kern_sg_entries = 0;
9624
9625	if (data_len < alloc_len) {
9626		ctsio->residual = alloc_len - data_len;
9627		ctsio->kern_data_len = data_len;
9628		ctsio->kern_total_len = data_len;
9629	} else {
9630		ctsio->residual = 0;
9631		ctsio->kern_data_len = alloc_len;
9632		ctsio->kern_total_len = alloc_len;
9633	}
9634	ctsio->kern_data_resid = 0;
9635	ctsio->kern_rel_offset = 0;
9636	ctsio->kern_sg_entries = 0;
9637
9638	/*
9639	 * The control device is always connected.  The disk device, on the
9640	 * other hand, may not be online all the time.
9641	 */
9642	if (lun != NULL)
9643		mpp_ptr->device = (SID_QUAL_LU_CONNECTED << 5) |
9644				     lun->be_lun->lun_type;
9645	else
9646		mpp_ptr->device = (SID_QUAL_LU_OFFLINE << 5) | T_DIRECT;
9647	mpp_ptr->page_code = SVPD_MODE_PAGE_POLICY;
9648	scsi_ulto2b(data_len - 4, mpp_ptr->page_length);
9649	mpp_ptr->descr[0].page_code = 0x3f;
9650	mpp_ptr->descr[0].subpage_code = 0xff;
9651	mpp_ptr->descr[0].policy = SVPD_MPP_SHARED;
9652
9653	ctl_set_success(ctsio);
9654	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
9655	ctsio->be_move_done = ctl_config_move_done;
9656	ctl_datamove((union ctl_io *)ctsio);
9657	return (CTL_RETVAL_COMPLETE);
9658}
9659
9660/*
9661 * SCSI VPD page 0x83, the Device Identification page.
9662 */
9663static int
9664ctl_inquiry_evpd_devid(struct ctl_scsiio *ctsio, int alloc_len)
9665{
9666	struct scsi_vpd_device_id *devid_ptr;
9667	struct scsi_vpd_id_descriptor *desc;
9668	struct ctl_softc *softc;
9669	struct ctl_lun *lun;
9670	struct ctl_port *port;
9671	int data_len, g;
9672	uint8_t proto;
9673
9674	softc = control_softc;
9675
9676	port = ctl_io_port(&ctsio->io_hdr);
9677	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
9678
9679	data_len = sizeof(struct scsi_vpd_device_id) +
9680	    sizeof(struct scsi_vpd_id_descriptor) +
9681		sizeof(struct scsi_vpd_id_rel_trgt_port_id) +
9682	    sizeof(struct scsi_vpd_id_descriptor) +
9683		sizeof(struct scsi_vpd_id_trgt_port_grp_id);
9684	if (lun && lun->lun_devid)
9685		data_len += lun->lun_devid->len;
9686	if (port && port->port_devid)
9687		data_len += port->port_devid->len;
9688	if (port && port->target_devid)
9689		data_len += port->target_devid->len;
9690
9691	ctsio->kern_data_ptr = malloc(data_len, M_CTL, M_WAITOK | M_ZERO);
9692	devid_ptr = (struct scsi_vpd_device_id *)ctsio->kern_data_ptr;
9693	ctsio->kern_sg_entries = 0;
9694
9695	if (data_len < alloc_len) {
9696		ctsio->residual = alloc_len - data_len;
9697		ctsio->kern_data_len = data_len;
9698		ctsio->kern_total_len = data_len;
9699	} else {
9700		ctsio->residual = 0;
9701		ctsio->kern_data_len = alloc_len;
9702		ctsio->kern_total_len = alloc_len;
9703	}
9704	ctsio->kern_data_resid = 0;
9705	ctsio->kern_rel_offset = 0;
9706	ctsio->kern_sg_entries = 0;
9707
9708	/*
9709	 * The control device is always connected.  The disk device, on the
9710	 * other hand, may not be online all the time.
9711	 */
9712	if (lun != NULL)
9713		devid_ptr->device = (SID_QUAL_LU_CONNECTED << 5) |
9714				     lun->be_lun->lun_type;
9715	else
9716		devid_ptr->device = (SID_QUAL_LU_OFFLINE << 5) | T_DIRECT;
9717	devid_ptr->page_code = SVPD_DEVICE_ID;
9718	scsi_ulto2b(data_len - 4, devid_ptr->length);
9719
9720	if (port && port->port_type == CTL_PORT_FC)
9721		proto = SCSI_PROTO_FC << 4;
9722	else if (port && port->port_type == CTL_PORT_ISCSI)
9723		proto = SCSI_PROTO_ISCSI << 4;
9724	else
9725		proto = SCSI_PROTO_SPI << 4;
9726	desc = (struct scsi_vpd_id_descriptor *)devid_ptr->desc_list;
9727
9728	/*
9729	 * We're using a LUN association here.  i.e., this device ID is a
9730	 * per-LUN identifier.
9731	 */
9732	if (lun && lun->lun_devid) {
9733		memcpy(desc, lun->lun_devid->data, lun->lun_devid->len);
9734		desc = (struct scsi_vpd_id_descriptor *)((uint8_t *)desc +
9735		    lun->lun_devid->len);
9736	}
9737
9738	/*
9739	 * This is for the WWPN which is a port association.
9740	 */
9741	if (port && port->port_devid) {
9742		memcpy(desc, port->port_devid->data, port->port_devid->len);
9743		desc = (struct scsi_vpd_id_descriptor *)((uint8_t *)desc +
9744		    port->port_devid->len);
9745	}
9746
9747	/*
9748	 * This is for the Relative Target Port(type 4h) identifier
9749	 */
9750	desc->proto_codeset = proto | SVPD_ID_CODESET_BINARY;
9751	desc->id_type = SVPD_ID_PIV | SVPD_ID_ASSOC_PORT |
9752	    SVPD_ID_TYPE_RELTARG;
9753	desc->length = 4;
9754	scsi_ulto2b(ctsio->io_hdr.nexus.targ_port, &desc->identifier[2]);
9755	desc = (struct scsi_vpd_id_descriptor *)(&desc->identifier[0] +
9756	    sizeof(struct scsi_vpd_id_rel_trgt_port_id));
9757
9758	/*
9759	 * This is for the Target Port Group(type 5h) identifier
9760	 */
9761	desc->proto_codeset = proto | SVPD_ID_CODESET_BINARY;
9762	desc->id_type = SVPD_ID_PIV | SVPD_ID_ASSOC_PORT |
9763	    SVPD_ID_TYPE_TPORTGRP;
9764	desc->length = 4;
9765	if (softc->is_single || port->status & CTL_PORT_STATUS_HA_SHARED)
9766		g = 1;
9767	else
9768		g = 2 + ctsio->io_hdr.nexus.targ_port / softc->port_cnt;
9769	scsi_ulto2b(g, &desc->identifier[2]);
9770	desc = (struct scsi_vpd_id_descriptor *)(&desc->identifier[0] +
9771	    sizeof(struct scsi_vpd_id_trgt_port_grp_id));
9772
9773	/*
9774	 * This is for the Target identifier
9775	 */
9776	if (port && port->target_devid) {
9777		memcpy(desc, port->target_devid->data, port->target_devid->len);
9778	}
9779
9780	ctl_set_success(ctsio);
9781	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
9782	ctsio->be_move_done = ctl_config_move_done;
9783	ctl_datamove((union ctl_io *)ctsio);
9784	return (CTL_RETVAL_COMPLETE);
9785}
9786
9787static int
9788ctl_inquiry_evpd_scsi_ports(struct ctl_scsiio *ctsio, int alloc_len)
9789{
9790	struct ctl_softc *softc = control_softc;
9791	struct scsi_vpd_scsi_ports *sp;
9792	struct scsi_vpd_port_designation *pd;
9793	struct scsi_vpd_port_designation_cont *pdc;
9794	struct ctl_lun *lun;
9795	struct ctl_port *port;
9796	int data_len, num_target_ports, iid_len, id_len;
9797
9798	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
9799
9800	num_target_ports = 0;
9801	iid_len = 0;
9802	id_len = 0;
9803	mtx_lock(&softc->ctl_lock);
9804	STAILQ_FOREACH(port, &softc->port_list, links) {
9805		if ((port->status & CTL_PORT_STATUS_ONLINE) == 0)
9806			continue;
9807		if (lun != NULL &&
9808		    ctl_lun_map_to_port(port, lun->lun) >= CTL_MAX_LUNS)
9809			continue;
9810		num_target_ports++;
9811		if (port->init_devid)
9812			iid_len += port->init_devid->len;
9813		if (port->port_devid)
9814			id_len += port->port_devid->len;
9815	}
9816	mtx_unlock(&softc->ctl_lock);
9817
9818	data_len = sizeof(struct scsi_vpd_scsi_ports) +
9819	    num_target_ports * (sizeof(struct scsi_vpd_port_designation) +
9820	     sizeof(struct scsi_vpd_port_designation_cont)) + iid_len + id_len;
9821	ctsio->kern_data_ptr = malloc(data_len, M_CTL, M_WAITOK | M_ZERO);
9822	sp = (struct scsi_vpd_scsi_ports *)ctsio->kern_data_ptr;
9823	ctsio->kern_sg_entries = 0;
9824
9825	if (data_len < alloc_len) {
9826		ctsio->residual = alloc_len - data_len;
9827		ctsio->kern_data_len = data_len;
9828		ctsio->kern_total_len = data_len;
9829	} else {
9830		ctsio->residual = 0;
9831		ctsio->kern_data_len = alloc_len;
9832		ctsio->kern_total_len = alloc_len;
9833	}
9834	ctsio->kern_data_resid = 0;
9835	ctsio->kern_rel_offset = 0;
9836	ctsio->kern_sg_entries = 0;
9837
9838	/*
9839	 * The control device is always connected.  The disk device, on the
9840	 * other hand, may not be online all the time.  Need to change this
9841	 * to figure out whether the disk device is actually online or not.
9842	 */
9843	if (lun != NULL)
9844		sp->device = (SID_QUAL_LU_CONNECTED << 5) |
9845				  lun->be_lun->lun_type;
9846	else
9847		sp->device = (SID_QUAL_LU_OFFLINE << 5) | T_DIRECT;
9848
9849	sp->page_code = SVPD_SCSI_PORTS;
9850	scsi_ulto2b(data_len - sizeof(struct scsi_vpd_scsi_ports),
9851	    sp->page_length);
9852	pd = &sp->design[0];
9853
9854	mtx_lock(&softc->ctl_lock);
9855	STAILQ_FOREACH(port, &softc->port_list, links) {
9856		if ((port->status & CTL_PORT_STATUS_ONLINE) == 0)
9857			continue;
9858		if (lun != NULL &&
9859		    ctl_lun_map_to_port(port, lun->lun) >= CTL_MAX_LUNS)
9860			continue;
9861		scsi_ulto2b(port->targ_port, pd->relative_port_id);
9862		if (port->init_devid) {
9863			iid_len = port->init_devid->len;
9864			memcpy(pd->initiator_transportid,
9865			    port->init_devid->data, port->init_devid->len);
9866		} else
9867			iid_len = 0;
9868		scsi_ulto2b(iid_len, pd->initiator_transportid_length);
9869		pdc = (struct scsi_vpd_port_designation_cont *)
9870		    (&pd->initiator_transportid[iid_len]);
9871		if (port->port_devid) {
9872			id_len = port->port_devid->len;
9873			memcpy(pdc->target_port_descriptors,
9874			    port->port_devid->data, port->port_devid->len);
9875		} else
9876			id_len = 0;
9877		scsi_ulto2b(id_len, pdc->target_port_descriptors_length);
9878		pd = (struct scsi_vpd_port_designation *)
9879		    ((uint8_t *)pdc->target_port_descriptors + id_len);
9880	}
9881	mtx_unlock(&softc->ctl_lock);
9882
9883	ctl_set_success(ctsio);
9884	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
9885	ctsio->be_move_done = ctl_config_move_done;
9886	ctl_datamove((union ctl_io *)ctsio);
9887	return (CTL_RETVAL_COMPLETE);
9888}
9889
9890static int
9891ctl_inquiry_evpd_block_limits(struct ctl_scsiio *ctsio, int alloc_len)
9892{
9893	struct scsi_vpd_block_limits *bl_ptr;
9894	struct ctl_lun *lun;
9895
9896	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
9897
9898	ctsio->kern_data_ptr = malloc(sizeof(*bl_ptr), M_CTL, M_WAITOK | M_ZERO);
9899	bl_ptr = (struct scsi_vpd_block_limits *)ctsio->kern_data_ptr;
9900	ctsio->kern_sg_entries = 0;
9901
9902	if (sizeof(*bl_ptr) < alloc_len) {
9903		ctsio->residual = alloc_len - sizeof(*bl_ptr);
9904		ctsio->kern_data_len = sizeof(*bl_ptr);
9905		ctsio->kern_total_len = sizeof(*bl_ptr);
9906	} else {
9907		ctsio->residual = 0;
9908		ctsio->kern_data_len = alloc_len;
9909		ctsio->kern_total_len = alloc_len;
9910	}
9911	ctsio->kern_data_resid = 0;
9912	ctsio->kern_rel_offset = 0;
9913	ctsio->kern_sg_entries = 0;
9914
9915	/*
9916	 * The control device is always connected.  The disk device, on the
9917	 * other hand, may not be online all the time.  Need to change this
9918	 * to figure out whether the disk device is actually online or not.
9919	 */
9920	if (lun != NULL)
9921		bl_ptr->device = (SID_QUAL_LU_CONNECTED << 5) |
9922				  lun->be_lun->lun_type;
9923	else
9924		bl_ptr->device = (SID_QUAL_LU_OFFLINE << 5) | T_DIRECT;
9925
9926	bl_ptr->page_code = SVPD_BLOCK_LIMITS;
9927	scsi_ulto2b(sizeof(*bl_ptr) - 4, bl_ptr->page_length);
9928	bl_ptr->max_cmp_write_len = 0xff;
9929	scsi_ulto4b(0xffffffff, bl_ptr->max_txfer_len);
9930	if (lun != NULL) {
9931		scsi_ulto4b(lun->be_lun->opttxferlen, bl_ptr->opt_txfer_len);
9932		if (lun->be_lun->flags & CTL_LUN_FLAG_UNMAP) {
9933			scsi_ulto4b(0xffffffff, bl_ptr->max_unmap_lba_cnt);
9934			scsi_ulto4b(0xffffffff, bl_ptr->max_unmap_blk_cnt);
9935			if (lun->be_lun->ublockexp != 0) {
9936				scsi_ulto4b((1 << lun->be_lun->ublockexp),
9937				    bl_ptr->opt_unmap_grain);
9938				scsi_ulto4b(0x80000000 | lun->be_lun->ublockoff,
9939				    bl_ptr->unmap_grain_align);
9940			}
9941		}
9942		scsi_ulto4b(lun->be_lun->atomicblock,
9943		    bl_ptr->max_atomic_transfer_length);
9944		scsi_ulto4b(0, bl_ptr->atomic_alignment);
9945		scsi_ulto4b(0, bl_ptr->atomic_transfer_length_granularity);
9946		scsi_ulto4b(0, bl_ptr->max_atomic_transfer_length_with_atomic_boundary);
9947		scsi_ulto4b(0, bl_ptr->max_atomic_boundary_size);
9948	}
9949	scsi_u64to8b(UINT64_MAX, bl_ptr->max_write_same_length);
9950
9951	ctl_set_success(ctsio);
9952	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
9953	ctsio->be_move_done = ctl_config_move_done;
9954	ctl_datamove((union ctl_io *)ctsio);
9955	return (CTL_RETVAL_COMPLETE);
9956}
9957
9958static int
9959ctl_inquiry_evpd_bdc(struct ctl_scsiio *ctsio, int alloc_len)
9960{
9961	struct scsi_vpd_block_device_characteristics *bdc_ptr;
9962	struct ctl_lun *lun;
9963	const char *value;
9964	u_int i;
9965
9966	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
9967
9968	ctsio->kern_data_ptr = malloc(sizeof(*bdc_ptr), M_CTL, M_WAITOK | M_ZERO);
9969	bdc_ptr = (struct scsi_vpd_block_device_characteristics *)ctsio->kern_data_ptr;
9970	ctsio->kern_sg_entries = 0;
9971
9972	if (sizeof(*bdc_ptr) < alloc_len) {
9973		ctsio->residual = alloc_len - sizeof(*bdc_ptr);
9974		ctsio->kern_data_len = sizeof(*bdc_ptr);
9975		ctsio->kern_total_len = sizeof(*bdc_ptr);
9976	} else {
9977		ctsio->residual = 0;
9978		ctsio->kern_data_len = alloc_len;
9979		ctsio->kern_total_len = alloc_len;
9980	}
9981	ctsio->kern_data_resid = 0;
9982	ctsio->kern_rel_offset = 0;
9983	ctsio->kern_sg_entries = 0;
9984
9985	/*
9986	 * The control device is always connected.  The disk device, on the
9987	 * other hand, may not be online all the time.  Need to change this
9988	 * to figure out whether the disk device is actually online or not.
9989	 */
9990	if (lun != NULL)
9991		bdc_ptr->device = (SID_QUAL_LU_CONNECTED << 5) |
9992				  lun->be_lun->lun_type;
9993	else
9994		bdc_ptr->device = (SID_QUAL_LU_OFFLINE << 5) | T_DIRECT;
9995	bdc_ptr->page_code = SVPD_BDC;
9996	scsi_ulto2b(sizeof(*bdc_ptr) - 4, bdc_ptr->page_length);
9997	if (lun != NULL &&
9998	    (value = ctl_get_opt(&lun->be_lun->options, "rpm")) != NULL)
9999		i = strtol(value, NULL, 0);
10000	else
10001		i = CTL_DEFAULT_ROTATION_RATE;
10002	scsi_ulto2b(i, bdc_ptr->medium_rotation_rate);
10003	if (lun != NULL &&
10004	    (value = ctl_get_opt(&lun->be_lun->options, "formfactor")) != NULL)
10005		i = strtol(value, NULL, 0);
10006	else
10007		i = 0;
10008	bdc_ptr->wab_wac_ff = (i & 0x0f);
10009	bdc_ptr->flags = SVPD_FUAB | SVPD_VBULS;
10010
10011	ctl_set_success(ctsio);
10012	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
10013	ctsio->be_move_done = ctl_config_move_done;
10014	ctl_datamove((union ctl_io *)ctsio);
10015	return (CTL_RETVAL_COMPLETE);
10016}
10017
10018static int
10019ctl_inquiry_evpd_lbp(struct ctl_scsiio *ctsio, int alloc_len)
10020{
10021	struct scsi_vpd_logical_block_prov *lbp_ptr;
10022	struct ctl_lun *lun;
10023
10024	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
10025
10026	ctsio->kern_data_ptr = malloc(sizeof(*lbp_ptr), M_CTL, M_WAITOK | M_ZERO);
10027	lbp_ptr = (struct scsi_vpd_logical_block_prov *)ctsio->kern_data_ptr;
10028	ctsio->kern_sg_entries = 0;
10029
10030	if (sizeof(*lbp_ptr) < alloc_len) {
10031		ctsio->residual = alloc_len - sizeof(*lbp_ptr);
10032		ctsio->kern_data_len = sizeof(*lbp_ptr);
10033		ctsio->kern_total_len = sizeof(*lbp_ptr);
10034	} else {
10035		ctsio->residual = 0;
10036		ctsio->kern_data_len = alloc_len;
10037		ctsio->kern_total_len = alloc_len;
10038	}
10039	ctsio->kern_data_resid = 0;
10040	ctsio->kern_rel_offset = 0;
10041	ctsio->kern_sg_entries = 0;
10042
10043	/*
10044	 * The control device is always connected.  The disk device, on the
10045	 * other hand, may not be online all the time.  Need to change this
10046	 * to figure out whether the disk device is actually online or not.
10047	 */
10048	if (lun != NULL)
10049		lbp_ptr->device = (SID_QUAL_LU_CONNECTED << 5) |
10050				  lun->be_lun->lun_type;
10051	else
10052		lbp_ptr->device = (SID_QUAL_LU_OFFLINE << 5) | T_DIRECT;
10053
10054	lbp_ptr->page_code = SVPD_LBP;
10055	scsi_ulto2b(sizeof(*lbp_ptr) - 4, lbp_ptr->page_length);
10056	lbp_ptr->threshold_exponent = CTL_LBP_EXPONENT;
10057	if (lun != NULL && lun->be_lun->flags & CTL_LUN_FLAG_UNMAP) {
10058		lbp_ptr->flags = SVPD_LBP_UNMAP | SVPD_LBP_WS16 |
10059		    SVPD_LBP_WS10 | SVPD_LBP_RZ | SVPD_LBP_ANC_SUP;
10060		lbp_ptr->prov_type = SVPD_LBP_THIN;
10061	}
10062
10063	ctl_set_success(ctsio);
10064	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
10065	ctsio->be_move_done = ctl_config_move_done;
10066	ctl_datamove((union ctl_io *)ctsio);
10067	return (CTL_RETVAL_COMPLETE);
10068}
10069
10070/*
10071 * INQUIRY with the EVPD bit set.
10072 */
10073static int
10074ctl_inquiry_evpd(struct ctl_scsiio *ctsio)
10075{
10076	struct ctl_lun *lun;
10077	struct scsi_inquiry *cdb;
10078	int alloc_len, retval;
10079
10080	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
10081	cdb = (struct scsi_inquiry *)ctsio->cdb;
10082	alloc_len = scsi_2btoul(cdb->length);
10083
10084	switch (cdb->page_code) {
10085	case SVPD_SUPPORTED_PAGES:
10086		retval = ctl_inquiry_evpd_supported(ctsio, alloc_len);
10087		break;
10088	case SVPD_UNIT_SERIAL_NUMBER:
10089		retval = ctl_inquiry_evpd_serial(ctsio, alloc_len);
10090		break;
10091	case SVPD_DEVICE_ID:
10092		retval = ctl_inquiry_evpd_devid(ctsio, alloc_len);
10093		break;
10094	case SVPD_EXTENDED_INQUIRY_DATA:
10095		retval = ctl_inquiry_evpd_eid(ctsio, alloc_len);
10096		break;
10097	case SVPD_MODE_PAGE_POLICY:
10098		retval = ctl_inquiry_evpd_mpp(ctsio, alloc_len);
10099		break;
10100	case SVPD_SCSI_PORTS:
10101		retval = ctl_inquiry_evpd_scsi_ports(ctsio, alloc_len);
10102		break;
10103	case SVPD_SCSI_TPC:
10104		retval = ctl_inquiry_evpd_tpc(ctsio, alloc_len);
10105		break;
10106	case SVPD_BLOCK_LIMITS:
10107		if (lun == NULL || lun->be_lun->lun_type != T_DIRECT)
10108			goto err;
10109		retval = ctl_inquiry_evpd_block_limits(ctsio, alloc_len);
10110		break;
10111	case SVPD_BDC:
10112		if (lun == NULL || lun->be_lun->lun_type != T_DIRECT)
10113			goto err;
10114		retval = ctl_inquiry_evpd_bdc(ctsio, alloc_len);
10115		break;
10116	case SVPD_LBP:
10117		if (lun == NULL || lun->be_lun->lun_type != T_DIRECT)
10118			goto err;
10119		retval = ctl_inquiry_evpd_lbp(ctsio, alloc_len);
10120		break;
10121	default:
10122err:
10123		ctl_set_invalid_field(ctsio,
10124				      /*sks_valid*/ 1,
10125				      /*command*/ 1,
10126				      /*field*/ 2,
10127				      /*bit_valid*/ 0,
10128				      /*bit*/ 0);
10129		ctl_done((union ctl_io *)ctsio);
10130		retval = CTL_RETVAL_COMPLETE;
10131		break;
10132	}
10133
10134	return (retval);
10135}
10136
10137/*
10138 * Standard INQUIRY data.
10139 */
10140static int
10141ctl_inquiry_std(struct ctl_scsiio *ctsio)
10142{
10143	struct scsi_inquiry_data *inq_ptr;
10144	struct scsi_inquiry *cdb;
10145	struct ctl_softc *softc = control_softc;
10146	struct ctl_port *port;
10147	struct ctl_lun *lun;
10148	char *val;
10149	uint32_t alloc_len, data_len;
10150	ctl_port_type port_type;
10151
10152	port = ctl_io_port(&ctsio->io_hdr);
10153	port_type = port->port_type;
10154	if (port_type == CTL_PORT_IOCTL || port_type == CTL_PORT_INTERNAL)
10155		port_type = CTL_PORT_SCSI;
10156
10157	lun = ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
10158	cdb = (struct scsi_inquiry *)ctsio->cdb;
10159	alloc_len = scsi_2btoul(cdb->length);
10160
10161	/*
10162	 * We malloc the full inquiry data size here and fill it
10163	 * in.  If the user only asks for less, we'll give him
10164	 * that much.
10165	 */
10166	data_len = offsetof(struct scsi_inquiry_data, vendor_specific1);
10167	ctsio->kern_data_ptr = malloc(data_len, M_CTL, M_WAITOK | M_ZERO);
10168	inq_ptr = (struct scsi_inquiry_data *)ctsio->kern_data_ptr;
10169	ctsio->kern_sg_entries = 0;
10170	ctsio->kern_data_resid = 0;
10171	ctsio->kern_rel_offset = 0;
10172
10173	if (data_len < alloc_len) {
10174		ctsio->residual = alloc_len - data_len;
10175		ctsio->kern_data_len = data_len;
10176		ctsio->kern_total_len = data_len;
10177	} else {
10178		ctsio->residual = 0;
10179		ctsio->kern_data_len = alloc_len;
10180		ctsio->kern_total_len = alloc_len;
10181	}
10182
10183	if (lun != NULL) {
10184		if ((lun->flags & CTL_LUN_PRIMARY_SC) ||
10185		    softc->ha_link >= CTL_HA_LINK_UNKNOWN) {
10186			inq_ptr->device = (SID_QUAL_LU_CONNECTED << 5) |
10187			    lun->be_lun->lun_type;
10188		} else {
10189			inq_ptr->device = (SID_QUAL_LU_OFFLINE << 5) |
10190			    lun->be_lun->lun_type;
10191		}
10192		if (lun->flags & CTL_LUN_REMOVABLE)
10193			inq_ptr->dev_qual2 |= SID_RMB;
10194	} else
10195		inq_ptr->device = (SID_QUAL_BAD_LU << 5) | T_NODEVICE;
10196
10197	/* RMB in byte 2 is 0 */
10198	inq_ptr->version = SCSI_REV_SPC4;
10199
10200	/*
10201	 * According to SAM-3, even if a device only supports a single
10202	 * level of LUN addressing, it should still set the HISUP bit:
10203	 *
10204	 * 4.9.1 Logical unit numbers overview
10205	 *
10206	 * All logical unit number formats described in this standard are
10207	 * hierarchical in structure even when only a single level in that
10208	 * hierarchy is used. The HISUP bit shall be set to one in the
10209	 * standard INQUIRY data (see SPC-2) when any logical unit number
10210	 * format described in this standard is used.  Non-hierarchical
10211	 * formats are outside the scope of this standard.
10212	 *
10213	 * Therefore we set the HiSup bit here.
10214	 *
10215	 * The reponse format is 2, per SPC-3.
10216	 */
10217	inq_ptr->response_format = SID_HiSup | 2;
10218
10219	inq_ptr->additional_length = data_len -
10220	    (offsetof(struct scsi_inquiry_data, additional_length) + 1);
10221	CTL_DEBUG_PRINT(("additional_length = %d\n",
10222			 inq_ptr->additional_length));
10223
10224	inq_ptr->spc3_flags = SPC3_SID_3PC | SPC3_SID_TPGS_IMPLICIT;
10225	if (port_type == CTL_PORT_SCSI)
10226		inq_ptr->spc2_flags = SPC2_SID_ADDR16;
10227	inq_ptr->spc2_flags |= SPC2_SID_MultiP;
10228	inq_ptr->flags = SID_CmdQue;
10229	if (port_type == CTL_PORT_SCSI)
10230		inq_ptr->flags |= SID_WBus16 | SID_Sync;
10231
10232	/*
10233	 * Per SPC-3, unused bytes in ASCII strings are filled with spaces.
10234	 * We have 8 bytes for the vendor name, and 16 bytes for the device
10235	 * name and 4 bytes for the revision.
10236	 */
10237	if (lun == NULL || (val = ctl_get_opt(&lun->be_lun->options,
10238	    "vendor")) == NULL) {
10239		strncpy(inq_ptr->vendor, CTL_VENDOR, sizeof(inq_ptr->vendor));
10240	} else {
10241		memset(inq_ptr->vendor, ' ', sizeof(inq_ptr->vendor));
10242		strncpy(inq_ptr->vendor, val,
10243		    min(sizeof(inq_ptr->vendor), strlen(val)));
10244	}
10245	if (lun == NULL) {
10246		strncpy(inq_ptr->product, CTL_DIRECT_PRODUCT,
10247		    sizeof(inq_ptr->product));
10248	} else if ((val = ctl_get_opt(&lun->be_lun->options, "product")) == NULL) {
10249		switch (lun->be_lun->lun_type) {
10250		case T_DIRECT:
10251			strncpy(inq_ptr->product, CTL_DIRECT_PRODUCT,
10252			    sizeof(inq_ptr->product));
10253			break;
10254		case T_PROCESSOR:
10255			strncpy(inq_ptr->product, CTL_PROCESSOR_PRODUCT,
10256			    sizeof(inq_ptr->product));
10257			break;
10258		case T_CDROM:
10259			strncpy(inq_ptr->product, CTL_CDROM_PRODUCT,
10260			    sizeof(inq_ptr->product));
10261			break;
10262		default:
10263			strncpy(inq_ptr->product, CTL_UNKNOWN_PRODUCT,
10264			    sizeof(inq_ptr->product));
10265			break;
10266		}
10267	} else {
10268		memset(inq_ptr->product, ' ', sizeof(inq_ptr->product));
10269		strncpy(inq_ptr->product, val,
10270		    min(sizeof(inq_ptr->product), strlen(val)));
10271	}
10272
10273	/*
10274	 * XXX make this a macro somewhere so it automatically gets
10275	 * incremented when we make changes.
10276	 */
10277	if (lun == NULL || (val = ctl_get_opt(&lun->be_lun->options,
10278	    "revision")) == NULL) {
10279		strncpy(inq_ptr->revision, "0001", sizeof(inq_ptr->revision));
10280	} else {
10281		memset(inq_ptr->revision, ' ', sizeof(inq_ptr->revision));
10282		strncpy(inq_ptr->revision, val,
10283		    min(sizeof(inq_ptr->revision), strlen(val)));
10284	}
10285
10286	/*
10287	 * For parallel SCSI, we support double transition and single
10288	 * transition clocking.  We also support QAS (Quick Arbitration
10289	 * and Selection) and Information Unit transfers on both the
10290	 * control and array devices.
10291	 */
10292	if (port_type == CTL_PORT_SCSI)
10293		inq_ptr->spi3data = SID_SPI_CLOCK_DT_ST | SID_SPI_QAS |
10294				    SID_SPI_IUS;
10295
10296	/* SAM-5 (no version claimed) */
10297	scsi_ulto2b(0x00A0, inq_ptr->version1);
10298	/* SPC-4 (no version claimed) */
10299	scsi_ulto2b(0x0460, inq_ptr->version2);
10300	if (port_type == CTL_PORT_FC) {
10301		/* FCP-2 ANSI INCITS.350:2003 */
10302		scsi_ulto2b(0x0917, inq_ptr->version3);
10303	} else if (port_type == CTL_PORT_SCSI) {
10304		/* SPI-4 ANSI INCITS.362:200x */
10305		scsi_ulto2b(0x0B56, inq_ptr->version3);
10306	} else if (port_type == CTL_PORT_ISCSI) {
10307		/* iSCSI (no version claimed) */
10308		scsi_ulto2b(0x0960, inq_ptr->version3);
10309	} else if (port_type == CTL_PORT_SAS) {
10310		/* SAS (no version claimed) */
10311		scsi_ulto2b(0x0BE0, inq_ptr->version3);
10312	}
10313
10314	if (lun == NULL) {
10315		/* SBC-4 (no version claimed) */
10316		scsi_ulto2b(0x0600, inq_ptr->version4);
10317	} else {
10318		switch (lun->be_lun->lun_type) {
10319		case T_DIRECT:
10320			/* SBC-4 (no version claimed) */
10321			scsi_ulto2b(0x0600, inq_ptr->version4);
10322			break;
10323		case T_PROCESSOR:
10324			break;
10325		case T_CDROM:
10326			/* MMC-6 (no version claimed) */
10327			scsi_ulto2b(0x04E0, inq_ptr->version4);
10328			break;
10329		default:
10330			break;
10331		}
10332	}
10333
10334	ctl_set_success(ctsio);
10335	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
10336	ctsio->be_move_done = ctl_config_move_done;
10337	ctl_datamove((union ctl_io *)ctsio);
10338	return (CTL_RETVAL_COMPLETE);
10339}
10340
10341int
10342ctl_inquiry(struct ctl_scsiio *ctsio)
10343{
10344	struct scsi_inquiry *cdb;
10345	int retval;
10346
10347	CTL_DEBUG_PRINT(("ctl_inquiry\n"));
10348
10349	cdb = (struct scsi_inquiry *)ctsio->cdb;
10350	if (cdb->byte2 & SI_EVPD)
10351		retval = ctl_inquiry_evpd(ctsio);
10352	else if (cdb->page_code == 0)
10353		retval = ctl_inquiry_std(ctsio);
10354	else {
10355		ctl_set_invalid_field(ctsio,
10356				      /*sks_valid*/ 1,
10357				      /*command*/ 1,
10358				      /*field*/ 2,
10359				      /*bit_valid*/ 0,
10360				      /*bit*/ 0);
10361		ctl_done((union ctl_io *)ctsio);
10362		return (CTL_RETVAL_COMPLETE);
10363	}
10364
10365	return (retval);
10366}
10367
10368int
10369ctl_get_config(struct ctl_scsiio *ctsio)
10370{
10371	struct scsi_get_config_header *hdr;
10372	struct scsi_get_config_feature *feature;
10373	struct scsi_get_config *cdb;
10374	struct ctl_lun *lun;
10375	uint32_t alloc_len, data_len;
10376	int rt, starting;
10377
10378	lun = ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
10379	cdb = (struct scsi_get_config *)ctsio->cdb;
10380	rt = (cdb->rt & SGC_RT_MASK);
10381	starting = scsi_2btoul(cdb->starting_feature);
10382	alloc_len = scsi_2btoul(cdb->length);
10383
10384	data_len = sizeof(struct scsi_get_config_header) +
10385	    sizeof(struct scsi_get_config_feature) + 8 +
10386	    sizeof(struct scsi_get_config_feature) + 8 +
10387	    sizeof(struct scsi_get_config_feature) + 4 +
10388	    sizeof(struct scsi_get_config_feature) + 4 +
10389	    sizeof(struct scsi_get_config_feature) + 8 +
10390	    sizeof(struct scsi_get_config_feature) +
10391	    sizeof(struct scsi_get_config_feature) + 4 +
10392	    sizeof(struct scsi_get_config_feature) + 4 +
10393	    sizeof(struct scsi_get_config_feature) + 4 +
10394	    sizeof(struct scsi_get_config_feature) + 4 +
10395	    sizeof(struct scsi_get_config_feature) + 4 +
10396	    sizeof(struct scsi_get_config_feature) + 4;
10397	ctsio->kern_data_ptr = malloc(data_len, M_CTL, M_WAITOK | M_ZERO);
10398	ctsio->kern_sg_entries = 0;
10399	ctsio->kern_data_resid = 0;
10400	ctsio->kern_rel_offset = 0;
10401
10402	hdr = (struct scsi_get_config_header *)ctsio->kern_data_ptr;
10403	if (lun->flags & CTL_LUN_NO_MEDIA)
10404		scsi_ulto2b(0x0000, hdr->current_profile);
10405	else
10406		scsi_ulto2b(0x0010, hdr->current_profile);
10407	feature = (struct scsi_get_config_feature *)(hdr + 1);
10408
10409	if (starting > 0x003b)
10410		goto done;
10411	if (starting > 0x003a)
10412		goto f3b;
10413	if (starting > 0x002b)
10414		goto f3a;
10415	if (starting > 0x002a)
10416		goto f2b;
10417	if (starting > 0x001f)
10418		goto f2a;
10419	if (starting > 0x001e)
10420		goto f1f;
10421	if (starting > 0x001d)
10422		goto f1e;
10423	if (starting > 0x0010)
10424		goto f1d;
10425	if (starting > 0x0003)
10426		goto f10;
10427	if (starting > 0x0002)
10428		goto f3;
10429	if (starting > 0x0001)
10430		goto f2;
10431	if (starting > 0x0000)
10432		goto f1;
10433
10434	/* Profile List */
10435	scsi_ulto2b(0x0000, feature->feature_code);
10436	feature->flags = SGC_F_PERSISTENT | SGC_F_CURRENT;
10437	feature->add_length = 8;
10438	scsi_ulto2b(0x0008, &feature->feature_data[0]);	/* CD-ROM */
10439	feature->feature_data[2] = 0x00;
10440	scsi_ulto2b(0x0010, &feature->feature_data[4]);	/* DVD-ROM */
10441	feature->feature_data[6] = 0x01;
10442	feature = (struct scsi_get_config_feature *)
10443	    &feature->feature_data[feature->add_length];
10444
10445f1:	/* Core */
10446	scsi_ulto2b(0x0001, feature->feature_code);
10447	feature->flags = 0x08 | SGC_F_PERSISTENT | SGC_F_CURRENT;
10448	feature->add_length = 8;
10449	scsi_ulto4b(0x00000000, &feature->feature_data[0]);
10450	feature->feature_data[4] = 0x03;
10451	feature = (struct scsi_get_config_feature *)
10452	    &feature->feature_data[feature->add_length];
10453
10454f2:	/* Morphing */
10455	scsi_ulto2b(0x0002, feature->feature_code);
10456	feature->flags = 0x04 | SGC_F_PERSISTENT | SGC_F_CURRENT;
10457	feature->add_length = 4;
10458	feature->feature_data[0] = 0x02;
10459	feature = (struct scsi_get_config_feature *)
10460	    &feature->feature_data[feature->add_length];
10461
10462f3:	/* Removable Medium */
10463	scsi_ulto2b(0x0003, feature->feature_code);
10464	feature->flags = 0x04 | SGC_F_PERSISTENT | SGC_F_CURRENT;
10465	feature->add_length = 4;
10466	feature->feature_data[0] = 0x39;
10467	feature = (struct scsi_get_config_feature *)
10468	    &feature->feature_data[feature->add_length];
10469
10470	if (rt == SGC_RT_CURRENT && (lun->flags & CTL_LUN_NO_MEDIA))
10471		goto done;
10472
10473f10:	/* Random Read */
10474	scsi_ulto2b(0x0010, feature->feature_code);
10475	feature->flags = 0x00;
10476	if ((lun->flags & CTL_LUN_NO_MEDIA) == 0)
10477		feature->flags |= SGC_F_CURRENT;
10478	feature->add_length = 8;
10479	scsi_ulto4b(lun->be_lun->blocksize, &feature->feature_data[0]);
10480	scsi_ulto2b(1, &feature->feature_data[4]);
10481	feature->feature_data[6] = 0x00;
10482	feature = (struct scsi_get_config_feature *)
10483	    &feature->feature_data[feature->add_length];
10484
10485f1d:	/* Multi-Read */
10486	scsi_ulto2b(0x001D, feature->feature_code);
10487	feature->flags = 0x00;
10488	if ((lun->flags & CTL_LUN_NO_MEDIA) == 0)
10489		feature->flags |= SGC_F_CURRENT;
10490	feature->add_length = 0;
10491	feature = (struct scsi_get_config_feature *)
10492	    &feature->feature_data[feature->add_length];
10493
10494f1e:	/* CD Read */
10495	scsi_ulto2b(0x001E, feature->feature_code);
10496	feature->flags = 0x00;
10497	if ((lun->flags & CTL_LUN_NO_MEDIA) == 0)
10498		feature->flags |= SGC_F_CURRENT;
10499	feature->add_length = 4;
10500	feature->feature_data[0] = 0x00;
10501	feature = (struct scsi_get_config_feature *)
10502	    &feature->feature_data[feature->add_length];
10503
10504f1f:	/* DVD Read */
10505	scsi_ulto2b(0x001F, feature->feature_code);
10506	feature->flags = 0x08;
10507	if ((lun->flags & CTL_LUN_NO_MEDIA) == 0)
10508		feature->flags |= SGC_F_CURRENT;
10509	feature->add_length = 4;
10510	feature->feature_data[0] = 0x01;
10511	feature->feature_data[2] = 0x03;
10512	feature = (struct scsi_get_config_feature *)
10513	    &feature->feature_data[feature->add_length];
10514
10515f2a:	/* DVD+RW */
10516	scsi_ulto2b(0x002A, feature->feature_code);
10517	feature->flags = 0x04;
10518	if ((lun->flags & CTL_LUN_NO_MEDIA) == 0)
10519		feature->flags |= SGC_F_CURRENT;
10520	feature->add_length = 4;
10521	feature->feature_data[0] = 0x00;
10522	feature->feature_data[1] = 0x00;
10523	feature = (struct scsi_get_config_feature *)
10524	    &feature->feature_data[feature->add_length];
10525
10526f2b:	/* DVD+R */
10527	scsi_ulto2b(0x002B, feature->feature_code);
10528	feature->flags = 0x00;
10529	if ((lun->flags & CTL_LUN_NO_MEDIA) == 0)
10530		feature->flags |= SGC_F_CURRENT;
10531	feature->add_length = 4;
10532	feature->feature_data[0] = 0x00;
10533	feature = (struct scsi_get_config_feature *)
10534	    &feature->feature_data[feature->add_length];
10535
10536f3a:	/* DVD+RW Dual Layer */
10537	scsi_ulto2b(0x003A, feature->feature_code);
10538	feature->flags = 0x00;
10539	if ((lun->flags & CTL_LUN_NO_MEDIA) == 0)
10540		feature->flags |= SGC_F_CURRENT;
10541	feature->add_length = 4;
10542	feature->feature_data[0] = 0x00;
10543	feature->feature_data[1] = 0x00;
10544	feature = (struct scsi_get_config_feature *)
10545	    &feature->feature_data[feature->add_length];
10546
10547f3b:	/* DVD+R Dual Layer */
10548	scsi_ulto2b(0x003B, feature->feature_code);
10549	feature->flags = 0x00;
10550	if ((lun->flags & CTL_LUN_NO_MEDIA) == 0)
10551		feature->flags |= SGC_F_CURRENT;
10552	feature->add_length = 4;
10553	feature->feature_data[0] = 0x00;
10554	feature = (struct scsi_get_config_feature *)
10555	    &feature->feature_data[feature->add_length];
10556
10557done:
10558	data_len = (uint8_t *)feature - (uint8_t *)hdr;
10559	if (rt == SGC_RT_SPECIFIC && data_len > 4) {
10560		feature = (struct scsi_get_config_feature *)(hdr + 1);
10561		if (scsi_2btoul(feature->feature_code) == starting)
10562			feature = (struct scsi_get_config_feature *)
10563			    &feature->feature_data[feature->add_length];
10564		data_len = (uint8_t *)feature - (uint8_t *)hdr;
10565	}
10566	scsi_ulto4b(data_len - 4, hdr->data_length);
10567	if (data_len < alloc_len) {
10568		ctsio->residual = alloc_len - data_len;
10569		ctsio->kern_data_len = data_len;
10570		ctsio->kern_total_len = data_len;
10571	} else {
10572		ctsio->residual = 0;
10573		ctsio->kern_data_len = alloc_len;
10574		ctsio->kern_total_len = alloc_len;
10575	}
10576
10577	ctl_set_success(ctsio);
10578	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
10579	ctsio->be_move_done = ctl_config_move_done;
10580	ctl_datamove((union ctl_io *)ctsio);
10581	return (CTL_RETVAL_COMPLETE);
10582}
10583
10584int
10585ctl_get_event_status(struct ctl_scsiio *ctsio)
10586{
10587	struct scsi_get_event_status_header *hdr;
10588	struct scsi_get_event_status *cdb;
10589	struct ctl_lun *lun;
10590	uint32_t alloc_len, data_len;
10591	int notif_class;
10592
10593	lun = ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
10594	cdb = (struct scsi_get_event_status *)ctsio->cdb;
10595	if ((cdb->byte2 & SGESN_POLLED) == 0) {
10596		ctl_set_invalid_field(ctsio, /*sks_valid*/ 1, /*command*/ 1,
10597		    /*field*/ 1, /*bit_valid*/ 1, /*bit*/ 0);
10598		ctl_done((union ctl_io *)ctsio);
10599		return (CTL_RETVAL_COMPLETE);
10600	}
10601	notif_class = cdb->notif_class;
10602	alloc_len = scsi_2btoul(cdb->length);
10603
10604	data_len = sizeof(struct scsi_get_event_status_header);
10605	ctsio->kern_data_ptr = malloc(data_len, M_CTL, M_WAITOK | M_ZERO);
10606	ctsio->kern_sg_entries = 0;
10607	ctsio->kern_data_resid = 0;
10608	ctsio->kern_rel_offset = 0;
10609
10610	if (data_len < alloc_len) {
10611		ctsio->residual = alloc_len - data_len;
10612		ctsio->kern_data_len = data_len;
10613		ctsio->kern_total_len = data_len;
10614	} else {
10615		ctsio->residual = 0;
10616		ctsio->kern_data_len = alloc_len;
10617		ctsio->kern_total_len = alloc_len;
10618	}
10619
10620	hdr = (struct scsi_get_event_status_header *)ctsio->kern_data_ptr;
10621	scsi_ulto2b(0, hdr->descr_length);
10622	hdr->nea_class = SGESN_NEA;
10623	hdr->supported_class = 0;
10624
10625	ctl_set_success(ctsio);
10626	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
10627	ctsio->be_move_done = ctl_config_move_done;
10628	ctl_datamove((union ctl_io *)ctsio);
10629	return (CTL_RETVAL_COMPLETE);
10630}
10631
10632int
10633ctl_mechanism_status(struct ctl_scsiio *ctsio)
10634{
10635	struct scsi_mechanism_status_header *hdr;
10636	struct scsi_mechanism_status *cdb;
10637	struct ctl_lun *lun;
10638	uint32_t alloc_len, data_len;
10639
10640	lun = ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
10641	cdb = (struct scsi_mechanism_status *)ctsio->cdb;
10642	alloc_len = scsi_2btoul(cdb->length);
10643
10644	data_len = sizeof(struct scsi_mechanism_status_header);
10645	ctsio->kern_data_ptr = malloc(data_len, M_CTL, M_WAITOK | M_ZERO);
10646	ctsio->kern_sg_entries = 0;
10647	ctsio->kern_data_resid = 0;
10648	ctsio->kern_rel_offset = 0;
10649
10650	if (data_len < alloc_len) {
10651		ctsio->residual = alloc_len - data_len;
10652		ctsio->kern_data_len = data_len;
10653		ctsio->kern_total_len = data_len;
10654	} else {
10655		ctsio->residual = 0;
10656		ctsio->kern_data_len = alloc_len;
10657		ctsio->kern_total_len = alloc_len;
10658	}
10659
10660	hdr = (struct scsi_mechanism_status_header *)ctsio->kern_data_ptr;
10661	hdr->state1 = 0x00;
10662	hdr->state2 = 0xe0;
10663	scsi_ulto3b(0, hdr->lba);
10664	hdr->slots_num = 0;
10665	scsi_ulto2b(0, hdr->slots_length);
10666
10667	ctl_set_success(ctsio);
10668	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
10669	ctsio->be_move_done = ctl_config_move_done;
10670	ctl_datamove((union ctl_io *)ctsio);
10671	return (CTL_RETVAL_COMPLETE);
10672}
10673
10674static void
10675ctl_ultomsf(uint32_t lba, uint8_t *buf)
10676{
10677
10678	lba += 150;
10679	buf[0] = 0;
10680	buf[1] = bin2bcd((lba / 75) / 60);
10681	buf[2] = bin2bcd((lba / 75) % 60);
10682	buf[3] = bin2bcd(lba % 75);
10683}
10684
10685int
10686ctl_read_toc(struct ctl_scsiio *ctsio)
10687{
10688	struct scsi_read_toc_hdr *hdr;
10689	struct scsi_read_toc_type01_descr *descr;
10690	struct scsi_read_toc *cdb;
10691	struct ctl_lun *lun;
10692	uint32_t alloc_len, data_len;
10693	int format, msf;
10694
10695	lun = ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
10696	cdb = (struct scsi_read_toc *)ctsio->cdb;
10697	msf = (cdb->byte2 & CD_MSF) != 0;
10698	format = cdb->format;
10699	alloc_len = scsi_2btoul(cdb->data_len);
10700
10701	data_len = sizeof(struct scsi_read_toc_hdr);
10702	if (format == 0)
10703		data_len += 2 * sizeof(struct scsi_read_toc_type01_descr);
10704	else
10705		data_len += sizeof(struct scsi_read_toc_type01_descr);
10706	ctsio->kern_data_ptr = malloc(data_len, M_CTL, M_WAITOK | M_ZERO);
10707	ctsio->kern_sg_entries = 0;
10708	ctsio->kern_data_resid = 0;
10709	ctsio->kern_rel_offset = 0;
10710
10711	if (data_len < alloc_len) {
10712		ctsio->residual = alloc_len - data_len;
10713		ctsio->kern_data_len = data_len;
10714		ctsio->kern_total_len = data_len;
10715	} else {
10716		ctsio->residual = 0;
10717		ctsio->kern_data_len = alloc_len;
10718		ctsio->kern_total_len = alloc_len;
10719	}
10720
10721	hdr = (struct scsi_read_toc_hdr *)ctsio->kern_data_ptr;
10722	if (format == 0) {
10723		scsi_ulto2b(0x12, hdr->data_length);
10724		hdr->first = 1;
10725		hdr->last = 1;
10726		descr = (struct scsi_read_toc_type01_descr *)(hdr + 1);
10727		descr->addr_ctl = 0x14;
10728		descr->track_number = 1;
10729		if (msf)
10730			ctl_ultomsf(0, descr->track_start);
10731		else
10732			scsi_ulto4b(0, descr->track_start);
10733		descr++;
10734		descr->addr_ctl = 0x14;
10735		descr->track_number = 0xaa;
10736		if (msf)
10737			ctl_ultomsf(lun->be_lun->maxlba+1, descr->track_start);
10738		else
10739			scsi_ulto4b(lun->be_lun->maxlba+1, descr->track_start);
10740	} else {
10741		scsi_ulto2b(0x0a, hdr->data_length);
10742		hdr->first = 1;
10743		hdr->last = 1;
10744		descr = (struct scsi_read_toc_type01_descr *)(hdr + 1);
10745		descr->addr_ctl = 0x14;
10746		descr->track_number = 1;
10747		if (msf)
10748			ctl_ultomsf(0, descr->track_start);
10749		else
10750			scsi_ulto4b(0, descr->track_start);
10751	}
10752
10753	ctl_set_success(ctsio);
10754	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
10755	ctsio->be_move_done = ctl_config_move_done;
10756	ctl_datamove((union ctl_io *)ctsio);
10757	return (CTL_RETVAL_COMPLETE);
10758}
10759
10760/*
10761 * For known CDB types, parse the LBA and length.
10762 */
10763static int
10764ctl_get_lba_len(union ctl_io *io, uint64_t *lba, uint64_t *len)
10765{
10766	if (io->io_hdr.io_type != CTL_IO_SCSI)
10767		return (1);
10768
10769	switch (io->scsiio.cdb[0]) {
10770	case COMPARE_AND_WRITE: {
10771		struct scsi_compare_and_write *cdb;
10772
10773		cdb = (struct scsi_compare_and_write *)io->scsiio.cdb;
10774
10775		*lba = scsi_8btou64(cdb->addr);
10776		*len = cdb->length;
10777		break;
10778	}
10779	case READ_6:
10780	case WRITE_6: {
10781		struct scsi_rw_6 *cdb;
10782
10783		cdb = (struct scsi_rw_6 *)io->scsiio.cdb;
10784
10785		*lba = scsi_3btoul(cdb->addr);
10786		/* only 5 bits are valid in the most significant address byte */
10787		*lba &= 0x1fffff;
10788		*len = cdb->length;
10789		break;
10790	}
10791	case READ_10:
10792	case WRITE_10: {
10793		struct scsi_rw_10 *cdb;
10794
10795		cdb = (struct scsi_rw_10 *)io->scsiio.cdb;
10796
10797		*lba = scsi_4btoul(cdb->addr);
10798		*len = scsi_2btoul(cdb->length);
10799		break;
10800	}
10801	case WRITE_VERIFY_10: {
10802		struct scsi_write_verify_10 *cdb;
10803
10804		cdb = (struct scsi_write_verify_10 *)io->scsiio.cdb;
10805
10806		*lba = scsi_4btoul(cdb->addr);
10807		*len = scsi_2btoul(cdb->length);
10808		break;
10809	}
10810	case READ_12:
10811	case WRITE_12: {
10812		struct scsi_rw_12 *cdb;
10813
10814		cdb = (struct scsi_rw_12 *)io->scsiio.cdb;
10815
10816		*lba = scsi_4btoul(cdb->addr);
10817		*len = scsi_4btoul(cdb->length);
10818		break;
10819	}
10820	case WRITE_VERIFY_12: {
10821		struct scsi_write_verify_12 *cdb;
10822
10823		cdb = (struct scsi_write_verify_12 *)io->scsiio.cdb;
10824
10825		*lba = scsi_4btoul(cdb->addr);
10826		*len = scsi_4btoul(cdb->length);
10827		break;
10828	}
10829	case READ_16:
10830	case WRITE_16: {
10831		struct scsi_rw_16 *cdb;
10832
10833		cdb = (struct scsi_rw_16 *)io->scsiio.cdb;
10834
10835		*lba = scsi_8btou64(cdb->addr);
10836		*len = scsi_4btoul(cdb->length);
10837		break;
10838	}
10839	case WRITE_ATOMIC_16: {
10840		struct scsi_write_atomic_16 *cdb;
10841
10842		cdb = (struct scsi_write_atomic_16 *)io->scsiio.cdb;
10843
10844		*lba = scsi_8btou64(cdb->addr);
10845		*len = scsi_2btoul(cdb->length);
10846		break;
10847	}
10848	case WRITE_VERIFY_16: {
10849		struct scsi_write_verify_16 *cdb;
10850
10851		cdb = (struct scsi_write_verify_16 *)io->scsiio.cdb;
10852
10853		*lba = scsi_8btou64(cdb->addr);
10854		*len = scsi_4btoul(cdb->length);
10855		break;
10856	}
10857	case WRITE_SAME_10: {
10858		struct scsi_write_same_10 *cdb;
10859
10860		cdb = (struct scsi_write_same_10 *)io->scsiio.cdb;
10861
10862		*lba = scsi_4btoul(cdb->addr);
10863		*len = scsi_2btoul(cdb->length);
10864		break;
10865	}
10866	case WRITE_SAME_16: {
10867		struct scsi_write_same_16 *cdb;
10868
10869		cdb = (struct scsi_write_same_16 *)io->scsiio.cdb;
10870
10871		*lba = scsi_8btou64(cdb->addr);
10872		*len = scsi_4btoul(cdb->length);
10873		break;
10874	}
10875	case VERIFY_10: {
10876		struct scsi_verify_10 *cdb;
10877
10878		cdb = (struct scsi_verify_10 *)io->scsiio.cdb;
10879
10880		*lba = scsi_4btoul(cdb->addr);
10881		*len = scsi_2btoul(cdb->length);
10882		break;
10883	}
10884	case VERIFY_12: {
10885		struct scsi_verify_12 *cdb;
10886
10887		cdb = (struct scsi_verify_12 *)io->scsiio.cdb;
10888
10889		*lba = scsi_4btoul(cdb->addr);
10890		*len = scsi_4btoul(cdb->length);
10891		break;
10892	}
10893	case VERIFY_16: {
10894		struct scsi_verify_16 *cdb;
10895
10896		cdb = (struct scsi_verify_16 *)io->scsiio.cdb;
10897
10898		*lba = scsi_8btou64(cdb->addr);
10899		*len = scsi_4btoul(cdb->length);
10900		break;
10901	}
10902	case UNMAP: {
10903		*lba = 0;
10904		*len = UINT64_MAX;
10905		break;
10906	}
10907	case SERVICE_ACTION_IN: {	/* GET LBA STATUS */
10908		struct scsi_get_lba_status *cdb;
10909
10910		cdb = (struct scsi_get_lba_status *)io->scsiio.cdb;
10911		*lba = scsi_8btou64(cdb->addr);
10912		*len = UINT32_MAX;
10913		break;
10914	}
10915	default:
10916		return (1);
10917		break; /* NOTREACHED */
10918	}
10919
10920	return (0);
10921}
10922
10923static ctl_action
10924ctl_extent_check_lba(uint64_t lba1, uint64_t len1, uint64_t lba2, uint64_t len2,
10925    bool seq)
10926{
10927	uint64_t endlba1, endlba2;
10928
10929	endlba1 = lba1 + len1 - (seq ? 0 : 1);
10930	endlba2 = lba2 + len2 - 1;
10931
10932	if ((endlba1 < lba2) || (endlba2 < lba1))
10933		return (CTL_ACTION_PASS);
10934	else
10935		return (CTL_ACTION_BLOCK);
10936}
10937
10938static int
10939ctl_extent_check_unmap(union ctl_io *io, uint64_t lba2, uint64_t len2)
10940{
10941	struct ctl_ptr_len_flags *ptrlen;
10942	struct scsi_unmap_desc *buf, *end, *range;
10943	uint64_t lba;
10944	uint32_t len;
10945
10946	/* If not UNMAP -- go other way. */
10947	if (io->io_hdr.io_type != CTL_IO_SCSI ||
10948	    io->scsiio.cdb[0] != UNMAP)
10949		return (CTL_ACTION_ERROR);
10950
10951	/* If UNMAP without data -- block and wait for data. */
10952	ptrlen = (struct ctl_ptr_len_flags *)
10953	    &io->io_hdr.ctl_private[CTL_PRIV_LBA_LEN];
10954	if ((io->io_hdr.flags & CTL_FLAG_ALLOCATED) == 0 ||
10955	    ptrlen->ptr == NULL)
10956		return (CTL_ACTION_BLOCK);
10957
10958	/* UNMAP with data -- check for collision. */
10959	buf = (struct scsi_unmap_desc *)ptrlen->ptr;
10960	end = buf + ptrlen->len / sizeof(*buf);
10961	for (range = buf; range < end; range++) {
10962		lba = scsi_8btou64(range->lba);
10963		len = scsi_4btoul(range->length);
10964		if ((lba < lba2 + len2) && (lba + len > lba2))
10965			return (CTL_ACTION_BLOCK);
10966	}
10967	return (CTL_ACTION_PASS);
10968}
10969
10970static ctl_action
10971ctl_extent_check(union ctl_io *io1, union ctl_io *io2, bool seq)
10972{
10973	uint64_t lba1, lba2;
10974	uint64_t len1, len2;
10975	int retval;
10976
10977	if (ctl_get_lba_len(io2, &lba2, &len2) != 0)
10978		return (CTL_ACTION_ERROR);
10979
10980	retval = ctl_extent_check_unmap(io1, lba2, len2);
10981	if (retval != CTL_ACTION_ERROR)
10982		return (retval);
10983
10984	if (ctl_get_lba_len(io1, &lba1, &len1) != 0)
10985		return (CTL_ACTION_ERROR);
10986
10987	if (io1->io_hdr.flags & CTL_FLAG_SERSEQ_DONE)
10988		seq = FALSE;
10989	return (ctl_extent_check_lba(lba1, len1, lba2, len2, seq));
10990}
10991
10992static ctl_action
10993ctl_extent_check_seq(union ctl_io *io1, union ctl_io *io2)
10994{
10995	uint64_t lba1, lba2;
10996	uint64_t len1, len2;
10997
10998	if (io1->io_hdr.flags & CTL_FLAG_SERSEQ_DONE)
10999		return (CTL_ACTION_PASS);
11000	if (ctl_get_lba_len(io1, &lba1, &len1) != 0)
11001		return (CTL_ACTION_ERROR);
11002	if (ctl_get_lba_len(io2, &lba2, &len2) != 0)
11003		return (CTL_ACTION_ERROR);
11004
11005	if (lba1 + len1 == lba2)
11006		return (CTL_ACTION_BLOCK);
11007	return (CTL_ACTION_PASS);
11008}
11009
11010static ctl_action
11011ctl_check_for_blockage(struct ctl_lun *lun, union ctl_io *pending_io,
11012    union ctl_io *ooa_io)
11013{
11014	const struct ctl_cmd_entry *pending_entry, *ooa_entry;
11015	const ctl_serialize_action *serialize_row;
11016
11017	/*
11018	 * The initiator attempted multiple untagged commands at the same
11019	 * time.  Can't do that.
11020	 */
11021	if ((pending_io->scsiio.tag_type == CTL_TAG_UNTAGGED)
11022	 && (ooa_io->scsiio.tag_type == CTL_TAG_UNTAGGED)
11023	 && ((pending_io->io_hdr.nexus.targ_port ==
11024	      ooa_io->io_hdr.nexus.targ_port)
11025	  && (pending_io->io_hdr.nexus.initid ==
11026	      ooa_io->io_hdr.nexus.initid))
11027	 && ((ooa_io->io_hdr.flags & (CTL_FLAG_ABORT |
11028	      CTL_FLAG_STATUS_SENT)) == 0))
11029		return (CTL_ACTION_OVERLAP);
11030
11031	/*
11032	 * The initiator attempted to send multiple tagged commands with
11033	 * the same ID.  (It's fine if different initiators have the same
11034	 * tag ID.)
11035	 *
11036	 * Even if all of those conditions are true, we don't kill the I/O
11037	 * if the command ahead of us has been aborted.  We won't end up
11038	 * sending it to the FETD, and it's perfectly legal to resend a
11039	 * command with the same tag number as long as the previous
11040	 * instance of this tag number has been aborted somehow.
11041	 */
11042	if ((pending_io->scsiio.tag_type != CTL_TAG_UNTAGGED)
11043	 && (ooa_io->scsiio.tag_type != CTL_TAG_UNTAGGED)
11044	 && (pending_io->scsiio.tag_num == ooa_io->scsiio.tag_num)
11045	 && ((pending_io->io_hdr.nexus.targ_port ==
11046	      ooa_io->io_hdr.nexus.targ_port)
11047	  && (pending_io->io_hdr.nexus.initid ==
11048	      ooa_io->io_hdr.nexus.initid))
11049	 && ((ooa_io->io_hdr.flags & (CTL_FLAG_ABORT |
11050	      CTL_FLAG_STATUS_SENT)) == 0))
11051		return (CTL_ACTION_OVERLAP_TAG);
11052
11053	/*
11054	 * If we get a head of queue tag, SAM-3 says that we should
11055	 * immediately execute it.
11056	 *
11057	 * What happens if this command would normally block for some other
11058	 * reason?  e.g. a request sense with a head of queue tag
11059	 * immediately after a write.  Normally that would block, but this
11060	 * will result in its getting executed immediately...
11061	 *
11062	 * We currently return "pass" instead of "skip", so we'll end up
11063	 * going through the rest of the queue to check for overlapped tags.
11064	 *
11065	 * XXX KDM check for other types of blockage first??
11066	 */
11067	if (pending_io->scsiio.tag_type == CTL_TAG_HEAD_OF_QUEUE)
11068		return (CTL_ACTION_PASS);
11069
11070	/*
11071	 * Ordered tags have to block until all items ahead of them
11072	 * have completed.  If we get called with an ordered tag, we always
11073	 * block, if something else is ahead of us in the queue.
11074	 */
11075	if (pending_io->scsiio.tag_type == CTL_TAG_ORDERED)
11076		return (CTL_ACTION_BLOCK);
11077
11078	/*
11079	 * Simple tags get blocked until all head of queue and ordered tags
11080	 * ahead of them have completed.  I'm lumping untagged commands in
11081	 * with simple tags here.  XXX KDM is that the right thing to do?
11082	 */
11083	if (((pending_io->scsiio.tag_type == CTL_TAG_UNTAGGED)
11084	  || (pending_io->scsiio.tag_type == CTL_TAG_SIMPLE))
11085	 && ((ooa_io->scsiio.tag_type == CTL_TAG_HEAD_OF_QUEUE)
11086	  || (ooa_io->scsiio.tag_type == CTL_TAG_ORDERED)))
11087		return (CTL_ACTION_BLOCK);
11088
11089	pending_entry = ctl_get_cmd_entry(&pending_io->scsiio, NULL);
11090	KASSERT(pending_entry->seridx < CTL_SERIDX_COUNT,
11091	    ("%s: Invalid seridx %d for pending CDB %02x %02x @ %p",
11092	     __func__, pending_entry->seridx, pending_io->scsiio.cdb[0],
11093	     pending_io->scsiio.cdb[1], pending_io));
11094	ooa_entry = ctl_get_cmd_entry(&ooa_io->scsiio, NULL);
11095	KASSERT(ooa_entry->seridx < CTL_SERIDX_COUNT,
11096	    ("%s: Invalid seridx %d for ooa CDB %02x %02x @ %p",
11097	     __func__, ooa_entry->seridx, ooa_io->scsiio.cdb[0],
11098	     ooa_io->scsiio.cdb[1], ooa_io));
11099
11100	serialize_row = ctl_serialize_table[ooa_entry->seridx];
11101
11102	switch (serialize_row[pending_entry->seridx]) {
11103	case CTL_SER_BLOCK:
11104		return (CTL_ACTION_BLOCK);
11105	case CTL_SER_EXTENT:
11106		return (ctl_extent_check(ooa_io, pending_io,
11107		    (lun->be_lun && lun->be_lun->serseq == CTL_LUN_SERSEQ_ON)));
11108	case CTL_SER_EXTENTOPT:
11109		if ((lun->mode_pages.control_page[CTL_PAGE_CURRENT].queue_flags
11110		    & SCP_QUEUE_ALG_MASK) != SCP_QUEUE_ALG_UNRESTRICTED)
11111			return (ctl_extent_check(ooa_io, pending_io,
11112			    (lun->be_lun &&
11113			     lun->be_lun->serseq == CTL_LUN_SERSEQ_ON)));
11114		return (CTL_ACTION_PASS);
11115	case CTL_SER_EXTENTSEQ:
11116		if (lun->be_lun && lun->be_lun->serseq != CTL_LUN_SERSEQ_OFF)
11117			return (ctl_extent_check_seq(ooa_io, pending_io));
11118		return (CTL_ACTION_PASS);
11119	case CTL_SER_PASS:
11120		return (CTL_ACTION_PASS);
11121	case CTL_SER_BLOCKOPT:
11122		if ((lun->mode_pages.control_page[CTL_PAGE_CURRENT].queue_flags
11123		    & SCP_QUEUE_ALG_MASK) != SCP_QUEUE_ALG_UNRESTRICTED)
11124			return (CTL_ACTION_BLOCK);
11125		return (CTL_ACTION_PASS);
11126	case CTL_SER_SKIP:
11127		return (CTL_ACTION_SKIP);
11128	default:
11129		panic("%s: Invalid serialization value %d for %d => %d",
11130		    __func__, serialize_row[pending_entry->seridx],
11131		    pending_entry->seridx, ooa_entry->seridx);
11132	}
11133
11134	return (CTL_ACTION_ERROR);
11135}
11136
11137/*
11138 * Check for blockage or overlaps against the OOA (Order Of Arrival) queue.
11139 * Assumptions:
11140 * - pending_io is generally either incoming, or on the blocked queue
11141 * - starting I/O is the I/O we want to start the check with.
11142 */
11143static ctl_action
11144ctl_check_ooa(struct ctl_lun *lun, union ctl_io *pending_io,
11145	      union ctl_io *starting_io)
11146{
11147	union ctl_io *ooa_io;
11148	ctl_action action;
11149
11150	mtx_assert(&lun->lun_lock, MA_OWNED);
11151
11152	/*
11153	 * Run back along the OOA queue, starting with the current
11154	 * blocked I/O and going through every I/O before it on the
11155	 * queue.  If starting_io is NULL, we'll just end up returning
11156	 * CTL_ACTION_PASS.
11157	 */
11158	for (ooa_io = starting_io; ooa_io != NULL;
11159	     ooa_io = (union ctl_io *)TAILQ_PREV(&ooa_io->io_hdr, ctl_ooaq,
11160	     ooa_links)){
11161
11162		/*
11163		 * This routine just checks to see whether
11164		 * cur_blocked is blocked by ooa_io, which is ahead
11165		 * of it in the queue.  It doesn't queue/dequeue
11166		 * cur_blocked.
11167		 */
11168		action = ctl_check_for_blockage(lun, pending_io, ooa_io);
11169		switch (action) {
11170		case CTL_ACTION_BLOCK:
11171		case CTL_ACTION_OVERLAP:
11172		case CTL_ACTION_OVERLAP_TAG:
11173		case CTL_ACTION_SKIP:
11174		case CTL_ACTION_ERROR:
11175			return (action);
11176			break; /* NOTREACHED */
11177		case CTL_ACTION_PASS:
11178			break;
11179		default:
11180			panic("%s: Invalid action %d\n", __func__, action);
11181		}
11182	}
11183
11184	return (CTL_ACTION_PASS);
11185}
11186
11187/*
11188 * Assumptions:
11189 * - An I/O has just completed, and has been removed from the per-LUN OOA
11190 *   queue, so some items on the blocked queue may now be unblocked.
11191 */
11192static int
11193ctl_check_blocked(struct ctl_lun *lun)
11194{
11195	struct ctl_softc *softc = lun->ctl_softc;
11196	union ctl_io *cur_blocked, *next_blocked;
11197
11198	mtx_assert(&lun->lun_lock, MA_OWNED);
11199
11200	/*
11201	 * Run forward from the head of the blocked queue, checking each
11202	 * entry against the I/Os prior to it on the OOA queue to see if
11203	 * there is still any blockage.
11204	 *
11205	 * We cannot use the TAILQ_FOREACH() macro, because it can't deal
11206	 * with our removing a variable on it while it is traversing the
11207	 * list.
11208	 */
11209	for (cur_blocked = (union ctl_io *)TAILQ_FIRST(&lun->blocked_queue);
11210	     cur_blocked != NULL; cur_blocked = next_blocked) {
11211		union ctl_io *prev_ooa;
11212		ctl_action action;
11213
11214		next_blocked = (union ctl_io *)TAILQ_NEXT(&cur_blocked->io_hdr,
11215							  blocked_links);
11216
11217		prev_ooa = (union ctl_io *)TAILQ_PREV(&cur_blocked->io_hdr,
11218						      ctl_ooaq, ooa_links);
11219
11220		/*
11221		 * If cur_blocked happens to be the first item in the OOA
11222		 * queue now, prev_ooa will be NULL, and the action
11223		 * returned will just be CTL_ACTION_PASS.
11224		 */
11225		action = ctl_check_ooa(lun, cur_blocked, prev_ooa);
11226
11227		switch (action) {
11228		case CTL_ACTION_BLOCK:
11229			/* Nothing to do here, still blocked */
11230			break;
11231		case CTL_ACTION_OVERLAP:
11232		case CTL_ACTION_OVERLAP_TAG:
11233			/*
11234			 * This shouldn't happen!  In theory we've already
11235			 * checked this command for overlap...
11236			 */
11237			break;
11238		case CTL_ACTION_PASS:
11239		case CTL_ACTION_SKIP: {
11240			const struct ctl_cmd_entry *entry;
11241
11242			/*
11243			 * The skip case shouldn't happen, this transaction
11244			 * should have never made it onto the blocked queue.
11245			 */
11246			/*
11247			 * This I/O is no longer blocked, we can remove it
11248			 * from the blocked queue.  Since this is a TAILQ
11249			 * (doubly linked list), we can do O(1) removals
11250			 * from any place on the list.
11251			 */
11252			TAILQ_REMOVE(&lun->blocked_queue, &cur_blocked->io_hdr,
11253				     blocked_links);
11254			cur_blocked->io_hdr.flags &= ~CTL_FLAG_BLOCKED;
11255
11256			if ((softc->ha_mode != CTL_HA_MODE_XFER) &&
11257			    (cur_blocked->io_hdr.flags & CTL_FLAG_FROM_OTHER_SC)){
11258				/*
11259				 * Need to send IO back to original side to
11260				 * run
11261				 */
11262				union ctl_ha_msg msg_info;
11263
11264				cur_blocked->io_hdr.flags &= ~CTL_FLAG_IO_ACTIVE;
11265				msg_info.hdr.original_sc =
11266					cur_blocked->io_hdr.original_sc;
11267				msg_info.hdr.serializing_sc = cur_blocked;
11268				msg_info.hdr.msg_type = CTL_MSG_R2R;
11269				ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg_info,
11270				    sizeof(msg_info.hdr), M_NOWAIT);
11271				break;
11272			}
11273			entry = ctl_get_cmd_entry(&cur_blocked->scsiio, NULL);
11274
11275			/*
11276			 * Check this I/O for LUN state changes that may
11277			 * have happened while this command was blocked.
11278			 * The LUN state may have been changed by a command
11279			 * ahead of us in the queue, so we need to re-check
11280			 * for any states that can be caused by SCSI
11281			 * commands.
11282			 */
11283			if (ctl_scsiio_lun_check(lun, entry,
11284						 &cur_blocked->scsiio) == 0) {
11285				cur_blocked->io_hdr.flags |=
11286				                      CTL_FLAG_IS_WAS_ON_RTR;
11287				ctl_enqueue_rtr(cur_blocked);
11288			} else
11289				ctl_done(cur_blocked);
11290			break;
11291		}
11292		default:
11293			/*
11294			 * This probably shouldn't happen -- we shouldn't
11295			 * get CTL_ACTION_ERROR, or anything else.
11296			 */
11297			break;
11298		}
11299	}
11300
11301	return (CTL_RETVAL_COMPLETE);
11302}
11303
11304/*
11305 * This routine (with one exception) checks LUN flags that can be set by
11306 * commands ahead of us in the OOA queue.  These flags have to be checked
11307 * when a command initially comes in, and when we pull a command off the
11308 * blocked queue and are preparing to execute it.  The reason we have to
11309 * check these flags for commands on the blocked queue is that the LUN
11310 * state may have been changed by a command ahead of us while we're on the
11311 * blocked queue.
11312 *
11313 * Ordering is somewhat important with these checks, so please pay
11314 * careful attention to the placement of any new checks.
11315 */
11316static int
11317ctl_scsiio_lun_check(struct ctl_lun *lun,
11318    const struct ctl_cmd_entry *entry, struct ctl_scsiio *ctsio)
11319{
11320	struct ctl_softc *softc = lun->ctl_softc;
11321	int retval;
11322	uint32_t residx;
11323
11324	retval = 0;
11325
11326	mtx_assert(&lun->lun_lock, MA_OWNED);
11327
11328	/*
11329	 * If this shelf is a secondary shelf controller, we may have to
11330	 * reject some commands disallowed by HA mode and link state.
11331	 */
11332	if ((lun->flags & CTL_LUN_PRIMARY_SC) == 0) {
11333		if (softc->ha_link == CTL_HA_LINK_OFFLINE &&
11334		    (entry->flags & CTL_CMD_FLAG_OK_ON_UNAVAIL) == 0) {
11335			ctl_set_lun_unavail(ctsio);
11336			retval = 1;
11337			goto bailout;
11338		}
11339		if ((lun->flags & CTL_LUN_PEER_SC_PRIMARY) == 0 &&
11340		    (entry->flags & CTL_CMD_FLAG_OK_ON_UNAVAIL) == 0) {
11341			ctl_set_lun_transit(ctsio);
11342			retval = 1;
11343			goto bailout;
11344		}
11345		if (softc->ha_mode == CTL_HA_MODE_ACT_STBY &&
11346		    (entry->flags & CTL_CMD_FLAG_OK_ON_STANDBY) == 0) {
11347			ctl_set_lun_standby(ctsio);
11348			retval = 1;
11349			goto bailout;
11350		}
11351
11352		/* The rest of checks are only done on executing side */
11353		if (softc->ha_mode == CTL_HA_MODE_XFER)
11354			goto bailout;
11355	}
11356
11357	if (entry->pattern & CTL_LUN_PAT_WRITE) {
11358		if (lun->be_lun &&
11359		    lun->be_lun->flags & CTL_LUN_FLAG_READONLY) {
11360			ctl_set_hw_write_protected(ctsio);
11361			retval = 1;
11362			goto bailout;
11363		}
11364		if ((lun->mode_pages.control_page[CTL_PAGE_CURRENT]
11365		    .eca_and_aen & SCP_SWP) != 0) {
11366			ctl_set_sense(ctsio, /*current_error*/ 1,
11367			    /*sense_key*/ SSD_KEY_DATA_PROTECT,
11368			    /*asc*/ 0x27, /*ascq*/ 0x02, SSD_ELEM_NONE);
11369			retval = 1;
11370			goto bailout;
11371		}
11372	}
11373
11374	/*
11375	 * Check for a reservation conflict.  If this command isn't allowed
11376	 * even on reserved LUNs, and if this initiator isn't the one who
11377	 * reserved us, reject the command with a reservation conflict.
11378	 */
11379	residx = ctl_get_initindex(&ctsio->io_hdr.nexus);
11380	if ((lun->flags & CTL_LUN_RESERVED)
11381	 && ((entry->flags & CTL_CMD_FLAG_ALLOW_ON_RESV) == 0)) {
11382		if (lun->res_idx != residx) {
11383			ctl_set_reservation_conflict(ctsio);
11384			retval = 1;
11385			goto bailout;
11386		}
11387	}
11388
11389	if ((lun->flags & CTL_LUN_PR_RESERVED) == 0 ||
11390	    (entry->flags & CTL_CMD_FLAG_ALLOW_ON_PR_RESV)) {
11391		/* No reservation or command is allowed. */;
11392	} else if ((entry->flags & CTL_CMD_FLAG_ALLOW_ON_PR_WRESV) &&
11393	    (lun->pr_res_type == SPR_TYPE_WR_EX ||
11394	     lun->pr_res_type == SPR_TYPE_WR_EX_RO ||
11395	     lun->pr_res_type == SPR_TYPE_WR_EX_AR)) {
11396		/* The command is allowed for Write Exclusive resv. */;
11397	} else {
11398		/*
11399		 * if we aren't registered or it's a res holder type
11400		 * reservation and this isn't the res holder then set a
11401		 * conflict.
11402		 */
11403		if (ctl_get_prkey(lun, residx) == 0 ||
11404		    (residx != lun->pr_res_idx && lun->pr_res_type < 4)) {
11405			ctl_set_reservation_conflict(ctsio);
11406			retval = 1;
11407			goto bailout;
11408		}
11409	}
11410
11411	if ((entry->flags & CTL_CMD_FLAG_OK_ON_NO_MEDIA) == 0) {
11412		if (lun->flags & CTL_LUN_EJECTED)
11413			ctl_set_lun_ejected(ctsio);
11414		else if (lun->flags & CTL_LUN_NO_MEDIA) {
11415			if (lun->flags & CTL_LUN_REMOVABLE)
11416				ctl_set_lun_no_media(ctsio);
11417			else
11418				ctl_set_lun_int_reqd(ctsio);
11419		} else if (lun->flags & CTL_LUN_STOPPED)
11420			ctl_set_lun_stopped(ctsio);
11421		else
11422			goto bailout;
11423		retval = 1;
11424		goto bailout;
11425	}
11426
11427bailout:
11428	return (retval);
11429}
11430
11431static void
11432ctl_failover_io(union ctl_io *io, int have_lock)
11433{
11434	ctl_set_busy(&io->scsiio);
11435	ctl_done(io);
11436}
11437
11438static void
11439ctl_failover_lun(union ctl_io *rio)
11440{
11441	struct ctl_softc *softc = control_softc;
11442	struct ctl_lun *lun;
11443	struct ctl_io_hdr *io, *next_io;
11444	uint32_t targ_lun;
11445
11446	targ_lun = rio->io_hdr.nexus.targ_mapped_lun;
11447	CTL_DEBUG_PRINT(("FAILOVER for lun %ju\n", targ_lun));
11448
11449	/* Find and lock the LUN. */
11450	mtx_lock(&softc->ctl_lock);
11451	if ((targ_lun < CTL_MAX_LUNS) &&
11452	    ((lun = softc->ctl_luns[targ_lun]) != NULL)) {
11453		mtx_lock(&lun->lun_lock);
11454		mtx_unlock(&softc->ctl_lock);
11455		if (lun->flags & CTL_LUN_DISABLED) {
11456			mtx_unlock(&lun->lun_lock);
11457			return;
11458		}
11459	} else {
11460		mtx_unlock(&softc->ctl_lock);
11461		return;
11462	}
11463
11464	if (softc->ha_mode == CTL_HA_MODE_XFER) {
11465		TAILQ_FOREACH_SAFE(io, &lun->ooa_queue, ooa_links, next_io) {
11466			/* We are master */
11467			if (io->flags & CTL_FLAG_FROM_OTHER_SC) {
11468				if (io->flags & CTL_FLAG_IO_ACTIVE) {
11469					io->flags |= CTL_FLAG_ABORT;
11470					io->flags |= CTL_FLAG_FAILOVER;
11471				} else { /* This can be only due to DATAMOVE */
11472					io->msg_type = CTL_MSG_DATAMOVE_DONE;
11473					io->flags &= ~CTL_FLAG_DMA_INPROG;
11474					io->flags |= CTL_FLAG_IO_ACTIVE;
11475					io->port_status = 31340;
11476					ctl_enqueue_isc((union ctl_io *)io);
11477				}
11478			}
11479			/* We are slave */
11480			if (io->flags & CTL_FLAG_SENT_2OTHER_SC) {
11481				io->flags &= ~CTL_FLAG_SENT_2OTHER_SC;
11482				if (io->flags & CTL_FLAG_IO_ACTIVE) {
11483					io->flags |= CTL_FLAG_FAILOVER;
11484				} else {
11485					ctl_set_busy(&((union ctl_io *)io)->
11486					    scsiio);
11487					ctl_done((union ctl_io *)io);
11488				}
11489			}
11490		}
11491	} else { /* SERIALIZE modes */
11492		TAILQ_FOREACH_SAFE(io, &lun->blocked_queue, blocked_links,
11493		    next_io) {
11494			/* We are master */
11495			if (io->flags & CTL_FLAG_FROM_OTHER_SC) {
11496				TAILQ_REMOVE(&lun->blocked_queue, io,
11497				    blocked_links);
11498				io->flags &= ~CTL_FLAG_BLOCKED;
11499				TAILQ_REMOVE(&lun->ooa_queue, io, ooa_links);
11500				ctl_free_io((union ctl_io *)io);
11501			}
11502		}
11503		TAILQ_FOREACH_SAFE(io, &lun->ooa_queue, ooa_links, next_io) {
11504			/* We are master */
11505			if (io->flags & CTL_FLAG_FROM_OTHER_SC) {
11506				TAILQ_REMOVE(&lun->ooa_queue, io, ooa_links);
11507				ctl_free_io((union ctl_io *)io);
11508			}
11509			/* We are slave */
11510			if (io->flags & CTL_FLAG_SENT_2OTHER_SC) {
11511				io->flags &= ~CTL_FLAG_SENT_2OTHER_SC;
11512				if (!(io->flags & CTL_FLAG_IO_ACTIVE)) {
11513					ctl_set_busy(&((union ctl_io *)io)->
11514					    scsiio);
11515					ctl_done((union ctl_io *)io);
11516				}
11517			}
11518		}
11519		ctl_check_blocked(lun);
11520	}
11521	mtx_unlock(&lun->lun_lock);
11522}
11523
11524static int
11525ctl_scsiio_precheck(struct ctl_softc *softc, struct ctl_scsiio *ctsio)
11526{
11527	struct ctl_lun *lun;
11528	const struct ctl_cmd_entry *entry;
11529	uint32_t initidx, targ_lun;
11530	int retval;
11531
11532	retval = 0;
11533
11534	lun = NULL;
11535
11536	targ_lun = ctsio->io_hdr.nexus.targ_mapped_lun;
11537	if ((targ_lun < CTL_MAX_LUNS)
11538	 && ((lun = softc->ctl_luns[targ_lun]) != NULL)) {
11539		/*
11540		 * If the LUN is invalid, pretend that it doesn't exist.
11541		 * It will go away as soon as all pending I/O has been
11542		 * completed.
11543		 */
11544		mtx_lock(&lun->lun_lock);
11545		if (lun->flags & CTL_LUN_DISABLED) {
11546			mtx_unlock(&lun->lun_lock);
11547			lun = NULL;
11548			ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr = NULL;
11549			ctsio->io_hdr.ctl_private[CTL_PRIV_BACKEND_LUN].ptr = NULL;
11550		} else {
11551			ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr = lun;
11552			ctsio->io_hdr.ctl_private[CTL_PRIV_BACKEND_LUN].ptr =
11553				lun->be_lun;
11554
11555			/*
11556			 * Every I/O goes into the OOA queue for a
11557			 * particular LUN, and stays there until completion.
11558			 */
11559#ifdef CTL_TIME_IO
11560			if (TAILQ_EMPTY(&lun->ooa_queue)) {
11561				lun->idle_time += getsbinuptime() -
11562				    lun->last_busy;
11563			}
11564#endif
11565			TAILQ_INSERT_TAIL(&lun->ooa_queue, &ctsio->io_hdr,
11566			    ooa_links);
11567		}
11568	} else {
11569		ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr = NULL;
11570		ctsio->io_hdr.ctl_private[CTL_PRIV_BACKEND_LUN].ptr = NULL;
11571	}
11572
11573	/* Get command entry and return error if it is unsuppotyed. */
11574	entry = ctl_validate_command(ctsio);
11575	if (entry == NULL) {
11576		if (lun)
11577			mtx_unlock(&lun->lun_lock);
11578		return (retval);
11579	}
11580
11581	ctsio->io_hdr.flags &= ~CTL_FLAG_DATA_MASK;
11582	ctsio->io_hdr.flags |= entry->flags & CTL_FLAG_DATA_MASK;
11583
11584	/*
11585	 * Check to see whether we can send this command to LUNs that don't
11586	 * exist.  This should pretty much only be the case for inquiry
11587	 * and request sense.  Further checks, below, really require having
11588	 * a LUN, so we can't really check the command anymore.  Just put
11589	 * it on the rtr queue.
11590	 */
11591	if (lun == NULL) {
11592		if (entry->flags & CTL_CMD_FLAG_OK_ON_NO_LUN) {
11593			ctsio->io_hdr.flags |= CTL_FLAG_IS_WAS_ON_RTR;
11594			ctl_enqueue_rtr((union ctl_io *)ctsio);
11595			return (retval);
11596		}
11597
11598		ctl_set_unsupported_lun(ctsio);
11599		ctl_done((union ctl_io *)ctsio);
11600		CTL_DEBUG_PRINT(("ctl_scsiio_precheck: bailing out due to invalid LUN\n"));
11601		return (retval);
11602	} else {
11603		/*
11604		 * Make sure we support this particular command on this LUN.
11605		 * e.g., we don't support writes to the control LUN.
11606		 */
11607		if (!ctl_cmd_applicable(lun->be_lun->lun_type, entry)) {
11608			mtx_unlock(&lun->lun_lock);
11609			ctl_set_invalid_opcode(ctsio);
11610			ctl_done((union ctl_io *)ctsio);
11611			return (retval);
11612		}
11613	}
11614
11615	initidx = ctl_get_initindex(&ctsio->io_hdr.nexus);
11616
11617#ifdef CTL_WITH_CA
11618	/*
11619	 * If we've got a request sense, it'll clear the contingent
11620	 * allegiance condition.  Otherwise, if we have a CA condition for
11621	 * this initiator, clear it, because it sent down a command other
11622	 * than request sense.
11623	 */
11624	if ((ctsio->cdb[0] != REQUEST_SENSE)
11625	 && (ctl_is_set(lun->have_ca, initidx)))
11626		ctl_clear_mask(lun->have_ca, initidx);
11627#endif
11628
11629	/*
11630	 * If the command has this flag set, it handles its own unit
11631	 * attention reporting, we shouldn't do anything.  Otherwise we
11632	 * check for any pending unit attentions, and send them back to the
11633	 * initiator.  We only do this when a command initially comes in,
11634	 * not when we pull it off the blocked queue.
11635	 *
11636	 * According to SAM-3, section 5.3.2, the order that things get
11637	 * presented back to the host is basically unit attentions caused
11638	 * by some sort of reset event, busy status, reservation conflicts
11639	 * or task set full, and finally any other status.
11640	 *
11641	 * One issue here is that some of the unit attentions we report
11642	 * don't fall into the "reset" category (e.g. "reported luns data
11643	 * has changed").  So reporting it here, before the reservation
11644	 * check, may be technically wrong.  I guess the only thing to do
11645	 * would be to check for and report the reset events here, and then
11646	 * check for the other unit attention types after we check for a
11647	 * reservation conflict.
11648	 *
11649	 * XXX KDM need to fix this
11650	 */
11651	if ((entry->flags & CTL_CMD_FLAG_NO_SENSE) == 0) {
11652		ctl_ua_type ua_type;
11653
11654		ua_type = ctl_build_ua(lun, initidx, &ctsio->sense_data,
11655		    SSD_TYPE_NONE);
11656		if (ua_type != CTL_UA_NONE) {
11657			mtx_unlock(&lun->lun_lock);
11658			ctsio->scsi_status = SCSI_STATUS_CHECK_COND;
11659			ctsio->io_hdr.status = CTL_SCSI_ERROR | CTL_AUTOSENSE;
11660			ctsio->sense_len = SSD_FULL_SIZE;
11661			ctl_done((union ctl_io *)ctsio);
11662			return (retval);
11663		}
11664	}
11665
11666
11667	if (ctl_scsiio_lun_check(lun, entry, ctsio) != 0) {
11668		mtx_unlock(&lun->lun_lock);
11669		ctl_done((union ctl_io *)ctsio);
11670		return (retval);
11671	}
11672
11673	/*
11674	 * XXX CHD this is where we want to send IO to other side if
11675	 * this LUN is secondary on this SC. We will need to make a copy
11676	 * of the IO and flag the IO on this side as SENT_2OTHER and the flag
11677	 * the copy we send as FROM_OTHER.
11678	 * We also need to stuff the address of the original IO so we can
11679	 * find it easily. Something similar will need be done on the other
11680	 * side so when we are done we can find the copy.
11681	 */
11682	if ((lun->flags & CTL_LUN_PRIMARY_SC) == 0 &&
11683	    (lun->flags & CTL_LUN_PEER_SC_PRIMARY) != 0 &&
11684	    (entry->flags & CTL_CMD_FLAG_RUN_HERE) == 0) {
11685		union ctl_ha_msg msg_info;
11686		int isc_retval;
11687
11688		ctsio->io_hdr.flags |= CTL_FLAG_SENT_2OTHER_SC;
11689		ctsio->io_hdr.flags &= ~CTL_FLAG_IO_ACTIVE;
11690		mtx_unlock(&lun->lun_lock);
11691
11692		msg_info.hdr.msg_type = CTL_MSG_SERIALIZE;
11693		msg_info.hdr.original_sc = (union ctl_io *)ctsio;
11694		msg_info.hdr.serializing_sc = NULL;
11695		msg_info.hdr.nexus = ctsio->io_hdr.nexus;
11696		msg_info.scsi.tag_num = ctsio->tag_num;
11697		msg_info.scsi.tag_type = ctsio->tag_type;
11698		msg_info.scsi.cdb_len = ctsio->cdb_len;
11699		memcpy(msg_info.scsi.cdb, ctsio->cdb, CTL_MAX_CDBLEN);
11700
11701		if ((isc_retval = ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg_info,
11702		    sizeof(msg_info.scsi) - sizeof(msg_info.scsi.sense_data),
11703		    M_WAITOK)) > CTL_HA_STATUS_SUCCESS) {
11704			ctl_set_busy(ctsio);
11705			ctl_done((union ctl_io *)ctsio);
11706			return (retval);
11707		}
11708		return (retval);
11709	}
11710
11711	switch (ctl_check_ooa(lun, (union ctl_io *)ctsio,
11712			      (union ctl_io *)TAILQ_PREV(&ctsio->io_hdr,
11713			      ctl_ooaq, ooa_links))) {
11714	case CTL_ACTION_BLOCK:
11715		ctsio->io_hdr.flags |= CTL_FLAG_BLOCKED;
11716		TAILQ_INSERT_TAIL(&lun->blocked_queue, &ctsio->io_hdr,
11717				  blocked_links);
11718		mtx_unlock(&lun->lun_lock);
11719		return (retval);
11720	case CTL_ACTION_PASS:
11721	case CTL_ACTION_SKIP:
11722		ctsio->io_hdr.flags |= CTL_FLAG_IS_WAS_ON_RTR;
11723		mtx_unlock(&lun->lun_lock);
11724		ctl_enqueue_rtr((union ctl_io *)ctsio);
11725		break;
11726	case CTL_ACTION_OVERLAP:
11727		mtx_unlock(&lun->lun_lock);
11728		ctl_set_overlapped_cmd(ctsio);
11729		ctl_done((union ctl_io *)ctsio);
11730		break;
11731	case CTL_ACTION_OVERLAP_TAG:
11732		mtx_unlock(&lun->lun_lock);
11733		ctl_set_overlapped_tag(ctsio, ctsio->tag_num & 0xff);
11734		ctl_done((union ctl_io *)ctsio);
11735		break;
11736	case CTL_ACTION_ERROR:
11737	default:
11738		mtx_unlock(&lun->lun_lock);
11739		ctl_set_internal_failure(ctsio,
11740					 /*sks_valid*/ 0,
11741					 /*retry_count*/ 0);
11742		ctl_done((union ctl_io *)ctsio);
11743		break;
11744	}
11745	return (retval);
11746}
11747
11748const struct ctl_cmd_entry *
11749ctl_get_cmd_entry(struct ctl_scsiio *ctsio, int *sa)
11750{
11751	const struct ctl_cmd_entry *entry;
11752	int service_action;
11753
11754	entry = &ctl_cmd_table[ctsio->cdb[0]];
11755	if (sa)
11756		*sa = ((entry->flags & CTL_CMD_FLAG_SA5) != 0);
11757	if (entry->flags & CTL_CMD_FLAG_SA5) {
11758		service_action = ctsio->cdb[1] & SERVICE_ACTION_MASK;
11759		entry = &((const struct ctl_cmd_entry *)
11760		    entry->execute)[service_action];
11761	}
11762	return (entry);
11763}
11764
11765const struct ctl_cmd_entry *
11766ctl_validate_command(struct ctl_scsiio *ctsio)
11767{
11768	const struct ctl_cmd_entry *entry;
11769	int i, sa;
11770	uint8_t diff;
11771
11772	entry = ctl_get_cmd_entry(ctsio, &sa);
11773	if (entry->execute == NULL) {
11774		if (sa)
11775			ctl_set_invalid_field(ctsio,
11776					      /*sks_valid*/ 1,
11777					      /*command*/ 1,
11778					      /*field*/ 1,
11779					      /*bit_valid*/ 1,
11780					      /*bit*/ 4);
11781		else
11782			ctl_set_invalid_opcode(ctsio);
11783		ctl_done((union ctl_io *)ctsio);
11784		return (NULL);
11785	}
11786	KASSERT(entry->length > 0,
11787	    ("Not defined length for command 0x%02x/0x%02x",
11788	     ctsio->cdb[0], ctsio->cdb[1]));
11789	for (i = 1; i < entry->length; i++) {
11790		diff = ctsio->cdb[i] & ~entry->usage[i - 1];
11791		if (diff == 0)
11792			continue;
11793		ctl_set_invalid_field(ctsio,
11794				      /*sks_valid*/ 1,
11795				      /*command*/ 1,
11796				      /*field*/ i,
11797				      /*bit_valid*/ 1,
11798				      /*bit*/ fls(diff) - 1);
11799		ctl_done((union ctl_io *)ctsio);
11800		return (NULL);
11801	}
11802	return (entry);
11803}
11804
11805static int
11806ctl_cmd_applicable(uint8_t lun_type, const struct ctl_cmd_entry *entry)
11807{
11808
11809	switch (lun_type) {
11810	case T_DIRECT:
11811		if ((entry->flags & CTL_CMD_FLAG_OK_ON_DIRECT) == 0)
11812			return (0);
11813		break;
11814	case T_PROCESSOR:
11815		if ((entry->flags & CTL_CMD_FLAG_OK_ON_PROC) == 0)
11816			return (0);
11817		break;
11818	case T_CDROM:
11819		if ((entry->flags & CTL_CMD_FLAG_OK_ON_CDROM) == 0)
11820			return (0);
11821		break;
11822	default:
11823		return (0);
11824	}
11825	return (1);
11826}
11827
11828static int
11829ctl_scsiio(struct ctl_scsiio *ctsio)
11830{
11831	int retval;
11832	const struct ctl_cmd_entry *entry;
11833
11834	retval = CTL_RETVAL_COMPLETE;
11835
11836	CTL_DEBUG_PRINT(("ctl_scsiio cdb[0]=%02X\n", ctsio->cdb[0]));
11837
11838	entry = ctl_get_cmd_entry(ctsio, NULL);
11839
11840	/*
11841	 * If this I/O has been aborted, just send it straight to
11842	 * ctl_done() without executing it.
11843	 */
11844	if (ctsio->io_hdr.flags & CTL_FLAG_ABORT) {
11845		ctl_done((union ctl_io *)ctsio);
11846		goto bailout;
11847	}
11848
11849	/*
11850	 * All the checks should have been handled by ctl_scsiio_precheck().
11851	 * We should be clear now to just execute the I/O.
11852	 */
11853	retval = entry->execute(ctsio);
11854
11855bailout:
11856	return (retval);
11857}
11858
11859/*
11860 * Since we only implement one target right now, a bus reset simply resets
11861 * our single target.
11862 */
11863static int
11864ctl_bus_reset(struct ctl_softc *softc, union ctl_io *io)
11865{
11866	return(ctl_target_reset(softc, io, CTL_UA_BUS_RESET));
11867}
11868
11869static int
11870ctl_target_reset(struct ctl_softc *softc, union ctl_io *io,
11871		 ctl_ua_type ua_type)
11872{
11873	struct ctl_port *port;
11874	struct ctl_lun *lun;
11875	int retval;
11876
11877	if (!(io->io_hdr.flags & CTL_FLAG_FROM_OTHER_SC)) {
11878		union ctl_ha_msg msg_info;
11879
11880		msg_info.hdr.nexus = io->io_hdr.nexus;
11881		if (ua_type==CTL_UA_TARG_RESET)
11882			msg_info.task.task_action = CTL_TASK_TARGET_RESET;
11883		else
11884			msg_info.task.task_action = CTL_TASK_BUS_RESET;
11885		msg_info.hdr.msg_type = CTL_MSG_MANAGE_TASKS;
11886		msg_info.hdr.original_sc = NULL;
11887		msg_info.hdr.serializing_sc = NULL;
11888		ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg_info,
11889		    sizeof(msg_info.task), M_WAITOK);
11890	}
11891	retval = 0;
11892
11893	mtx_lock(&softc->ctl_lock);
11894	port = ctl_io_port(&io->io_hdr);
11895	STAILQ_FOREACH(lun, &softc->lun_list, links) {
11896		if (port != NULL &&
11897		    ctl_lun_map_to_port(port, lun->lun) >= CTL_MAX_LUNS)
11898			continue;
11899		retval += ctl_do_lun_reset(lun, io, ua_type);
11900	}
11901	mtx_unlock(&softc->ctl_lock);
11902	io->taskio.task_status = CTL_TASK_FUNCTION_COMPLETE;
11903	return (retval);
11904}
11905
11906/*
11907 * The LUN should always be set.  The I/O is optional, and is used to
11908 * distinguish between I/Os sent by this initiator, and by other
11909 * initiators.  We set unit attention for initiators other than this one.
11910 * SAM-3 is vague on this point.  It does say that a unit attention should
11911 * be established for other initiators when a LUN is reset (see section
11912 * 5.7.3), but it doesn't specifically say that the unit attention should
11913 * be established for this particular initiator when a LUN is reset.  Here
11914 * is the relevant text, from SAM-3 rev 8:
11915 *
11916 * 5.7.2 When a SCSI initiator port aborts its own tasks
11917 *
11918 * When a SCSI initiator port causes its own task(s) to be aborted, no
11919 * notification that the task(s) have been aborted shall be returned to
11920 * the SCSI initiator port other than the completion response for the
11921 * command or task management function action that caused the task(s) to
11922 * be aborted and notification(s) associated with related effects of the
11923 * action (e.g., a reset unit attention condition).
11924 *
11925 * XXX KDM for now, we're setting unit attention for all initiators.
11926 */
11927static int
11928ctl_do_lun_reset(struct ctl_lun *lun, union ctl_io *io, ctl_ua_type ua_type)
11929{
11930	union ctl_io *xio;
11931#if 0
11932	uint32_t initidx;
11933#endif
11934	int i;
11935
11936	mtx_lock(&lun->lun_lock);
11937	/*
11938	 * Run through the OOA queue and abort each I/O.
11939	 */
11940	for (xio = (union ctl_io *)TAILQ_FIRST(&lun->ooa_queue); xio != NULL;
11941	     xio = (union ctl_io *)TAILQ_NEXT(&xio->io_hdr, ooa_links)) {
11942		xio->io_hdr.flags |= CTL_FLAG_ABORT | CTL_FLAG_ABORT_STATUS;
11943	}
11944
11945	/*
11946	 * This version sets unit attention for every
11947	 */
11948#if 0
11949	initidx = ctl_get_initindex(&io->io_hdr.nexus);
11950	ctl_est_ua_all(lun, initidx, ua_type);
11951#else
11952	ctl_est_ua_all(lun, -1, ua_type);
11953#endif
11954
11955	/*
11956	 * A reset (any kind, really) clears reservations established with
11957	 * RESERVE/RELEASE.  It does not clear reservations established
11958	 * with PERSISTENT RESERVE OUT, but we don't support that at the
11959	 * moment anyway.  See SPC-2, section 5.6.  SPC-3 doesn't address
11960	 * reservations made with the RESERVE/RELEASE commands, because
11961	 * those commands are obsolete in SPC-3.
11962	 */
11963	lun->flags &= ~CTL_LUN_RESERVED;
11964
11965#ifdef CTL_WITH_CA
11966	for (i = 0; i < CTL_MAX_INITIATORS; i++)
11967		ctl_clear_mask(lun->have_ca, i);
11968#endif
11969	lun->prevent_count = 0;
11970	for (i = 0; i < CTL_MAX_INITIATORS; i++)
11971		ctl_clear_mask(lun->prevent, i);
11972	mtx_unlock(&lun->lun_lock);
11973
11974	return (0);
11975}
11976
11977static int
11978ctl_lun_reset(struct ctl_softc *softc, union ctl_io *io)
11979{
11980	struct ctl_lun *lun;
11981	uint32_t targ_lun;
11982	int retval;
11983
11984	targ_lun = io->io_hdr.nexus.targ_mapped_lun;
11985	mtx_lock(&softc->ctl_lock);
11986	if ((targ_lun >= CTL_MAX_LUNS) ||
11987	    (lun = softc->ctl_luns[targ_lun]) == NULL) {
11988		mtx_unlock(&softc->ctl_lock);
11989		io->taskio.task_status = CTL_TASK_LUN_DOES_NOT_EXIST;
11990		return (1);
11991	}
11992	retval = ctl_do_lun_reset(lun, io, CTL_UA_LUN_RESET);
11993	mtx_unlock(&softc->ctl_lock);
11994	io->taskio.task_status = CTL_TASK_FUNCTION_COMPLETE;
11995
11996	if ((io->io_hdr.flags & CTL_FLAG_FROM_OTHER_SC) == 0) {
11997		union ctl_ha_msg msg_info;
11998
11999		msg_info.hdr.msg_type = CTL_MSG_MANAGE_TASKS;
12000		msg_info.hdr.nexus = io->io_hdr.nexus;
12001		msg_info.task.task_action = CTL_TASK_LUN_RESET;
12002		msg_info.hdr.original_sc = NULL;
12003		msg_info.hdr.serializing_sc = NULL;
12004		ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg_info,
12005		    sizeof(msg_info.task), M_WAITOK);
12006	}
12007	return (retval);
12008}
12009
12010static void
12011ctl_abort_tasks_lun(struct ctl_lun *lun, uint32_t targ_port, uint32_t init_id,
12012    int other_sc)
12013{
12014	union ctl_io *xio;
12015
12016	mtx_assert(&lun->lun_lock, MA_OWNED);
12017
12018	/*
12019	 * Run through the OOA queue and attempt to find the given I/O.
12020	 * The target port, initiator ID, tag type and tag number have to
12021	 * match the values that we got from the initiator.  If we have an
12022	 * untagged command to abort, simply abort the first untagged command
12023	 * we come to.  We only allow one untagged command at a time of course.
12024	 */
12025	for (xio = (union ctl_io *)TAILQ_FIRST(&lun->ooa_queue); xio != NULL;
12026	     xio = (union ctl_io *)TAILQ_NEXT(&xio->io_hdr, ooa_links)) {
12027
12028		if ((targ_port == UINT32_MAX ||
12029		     targ_port == xio->io_hdr.nexus.targ_port) &&
12030		    (init_id == UINT32_MAX ||
12031		     init_id == xio->io_hdr.nexus.initid)) {
12032			if (targ_port != xio->io_hdr.nexus.targ_port ||
12033			    init_id != xio->io_hdr.nexus.initid)
12034				xio->io_hdr.flags |= CTL_FLAG_ABORT_STATUS;
12035			xio->io_hdr.flags |= CTL_FLAG_ABORT;
12036			if (!other_sc && !(lun->flags & CTL_LUN_PRIMARY_SC)) {
12037				union ctl_ha_msg msg_info;
12038
12039				msg_info.hdr.nexus = xio->io_hdr.nexus;
12040				msg_info.task.task_action = CTL_TASK_ABORT_TASK;
12041				msg_info.task.tag_num = xio->scsiio.tag_num;
12042				msg_info.task.tag_type = xio->scsiio.tag_type;
12043				msg_info.hdr.msg_type = CTL_MSG_MANAGE_TASKS;
12044				msg_info.hdr.original_sc = NULL;
12045				msg_info.hdr.serializing_sc = NULL;
12046				ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg_info,
12047				    sizeof(msg_info.task), M_NOWAIT);
12048			}
12049		}
12050	}
12051}
12052
12053static int
12054ctl_abort_task_set(union ctl_io *io)
12055{
12056	struct ctl_softc *softc = control_softc;
12057	struct ctl_lun *lun;
12058	uint32_t targ_lun;
12059
12060	/*
12061	 * Look up the LUN.
12062	 */
12063	targ_lun = io->io_hdr.nexus.targ_mapped_lun;
12064	mtx_lock(&softc->ctl_lock);
12065	if ((targ_lun >= CTL_MAX_LUNS) ||
12066	    (lun = softc->ctl_luns[targ_lun]) == NULL) {
12067		mtx_unlock(&softc->ctl_lock);
12068		io->taskio.task_status = CTL_TASK_LUN_DOES_NOT_EXIST;
12069		return (1);
12070	}
12071
12072	mtx_lock(&lun->lun_lock);
12073	mtx_unlock(&softc->ctl_lock);
12074	if (io->taskio.task_action == CTL_TASK_ABORT_TASK_SET) {
12075		ctl_abort_tasks_lun(lun, io->io_hdr.nexus.targ_port,
12076		    io->io_hdr.nexus.initid,
12077		    (io->io_hdr.flags & CTL_FLAG_FROM_OTHER_SC) != 0);
12078	} else { /* CTL_TASK_CLEAR_TASK_SET */
12079		ctl_abort_tasks_lun(lun, UINT32_MAX, UINT32_MAX,
12080		    (io->io_hdr.flags & CTL_FLAG_FROM_OTHER_SC) != 0);
12081	}
12082	mtx_unlock(&lun->lun_lock);
12083	io->taskio.task_status = CTL_TASK_FUNCTION_COMPLETE;
12084	return (0);
12085}
12086
12087static int
12088ctl_i_t_nexus_reset(union ctl_io *io)
12089{
12090	struct ctl_softc *softc = control_softc;
12091	struct ctl_lun *lun;
12092	uint32_t initidx;
12093
12094	if (!(io->io_hdr.flags & CTL_FLAG_FROM_OTHER_SC)) {
12095		union ctl_ha_msg msg_info;
12096
12097		msg_info.hdr.nexus = io->io_hdr.nexus;
12098		msg_info.task.task_action = CTL_TASK_I_T_NEXUS_RESET;
12099		msg_info.hdr.msg_type = CTL_MSG_MANAGE_TASKS;
12100		msg_info.hdr.original_sc = NULL;
12101		msg_info.hdr.serializing_sc = NULL;
12102		ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg_info,
12103		    sizeof(msg_info.task), M_WAITOK);
12104	}
12105
12106	initidx = ctl_get_initindex(&io->io_hdr.nexus);
12107	mtx_lock(&softc->ctl_lock);
12108	STAILQ_FOREACH(lun, &softc->lun_list, links) {
12109		mtx_lock(&lun->lun_lock);
12110		ctl_abort_tasks_lun(lun, io->io_hdr.nexus.targ_port,
12111		    io->io_hdr.nexus.initid, 1);
12112#ifdef CTL_WITH_CA
12113		ctl_clear_mask(lun->have_ca, initidx);
12114#endif
12115		if ((lun->flags & CTL_LUN_RESERVED) && (lun->res_idx == initidx))
12116			lun->flags &= ~CTL_LUN_RESERVED;
12117		if (ctl_is_set(lun->prevent, initidx)) {
12118			ctl_clear_mask(lun->prevent, initidx);
12119			lun->prevent_count--;
12120		}
12121		ctl_est_ua(lun, initidx, CTL_UA_I_T_NEXUS_LOSS);
12122		mtx_unlock(&lun->lun_lock);
12123	}
12124	mtx_unlock(&softc->ctl_lock);
12125	io->taskio.task_status = CTL_TASK_FUNCTION_COMPLETE;
12126	return (0);
12127}
12128
12129static int
12130ctl_abort_task(union ctl_io *io)
12131{
12132	union ctl_io *xio;
12133	struct ctl_lun *lun;
12134	struct ctl_softc *softc;
12135#if 0
12136	struct sbuf sb;
12137	char printbuf[128];
12138#endif
12139	int found;
12140	uint32_t targ_lun;
12141
12142	softc = control_softc;
12143	found = 0;
12144
12145	/*
12146	 * Look up the LUN.
12147	 */
12148	targ_lun = io->io_hdr.nexus.targ_mapped_lun;
12149	mtx_lock(&softc->ctl_lock);
12150	if ((targ_lun >= CTL_MAX_LUNS) ||
12151	    (lun = softc->ctl_luns[targ_lun]) == NULL) {
12152		mtx_unlock(&softc->ctl_lock);
12153		io->taskio.task_status = CTL_TASK_LUN_DOES_NOT_EXIST;
12154		return (1);
12155	}
12156
12157#if 0
12158	printf("ctl_abort_task: called for lun %lld, tag %d type %d\n",
12159	       lun->lun, io->taskio.tag_num, io->taskio.tag_type);
12160#endif
12161
12162	mtx_lock(&lun->lun_lock);
12163	mtx_unlock(&softc->ctl_lock);
12164	/*
12165	 * Run through the OOA queue and attempt to find the given I/O.
12166	 * The target port, initiator ID, tag type and tag number have to
12167	 * match the values that we got from the initiator.  If we have an
12168	 * untagged command to abort, simply abort the first untagged command
12169	 * we come to.  We only allow one untagged command at a time of course.
12170	 */
12171	for (xio = (union ctl_io *)TAILQ_FIRST(&lun->ooa_queue); xio != NULL;
12172	     xio = (union ctl_io *)TAILQ_NEXT(&xio->io_hdr, ooa_links)) {
12173#if 0
12174		sbuf_new(&sb, printbuf, sizeof(printbuf), SBUF_FIXEDLEN);
12175
12176		sbuf_printf(&sb, "LUN %lld tag %d type %d%s%s%s%s: ",
12177			    lun->lun, xio->scsiio.tag_num,
12178			    xio->scsiio.tag_type,
12179			    (xio->io_hdr.blocked_links.tqe_prev
12180			    == NULL) ? "" : " BLOCKED",
12181			    (xio->io_hdr.flags &
12182			    CTL_FLAG_DMA_INPROG) ? " DMA" : "",
12183			    (xio->io_hdr.flags &
12184			    CTL_FLAG_ABORT) ? " ABORT" : "",
12185			    (xio->io_hdr.flags &
12186			    CTL_FLAG_IS_WAS_ON_RTR ? " RTR" : ""));
12187		ctl_scsi_command_string(&xio->scsiio, NULL, &sb);
12188		sbuf_finish(&sb);
12189		printf("%s\n", sbuf_data(&sb));
12190#endif
12191
12192		if ((xio->io_hdr.nexus.targ_port != io->io_hdr.nexus.targ_port)
12193		 || (xio->io_hdr.nexus.initid != io->io_hdr.nexus.initid)
12194		 || (xio->io_hdr.flags & CTL_FLAG_ABORT))
12195			continue;
12196
12197		/*
12198		 * If the abort says that the task is untagged, the
12199		 * task in the queue must be untagged.  Otherwise,
12200		 * we just check to see whether the tag numbers
12201		 * match.  This is because the QLogic firmware
12202		 * doesn't pass back the tag type in an abort
12203		 * request.
12204		 */
12205#if 0
12206		if (((xio->scsiio.tag_type == CTL_TAG_UNTAGGED)
12207		  && (io->taskio.tag_type == CTL_TAG_UNTAGGED))
12208		 || (xio->scsiio.tag_num == io->taskio.tag_num))
12209#endif
12210		/*
12211		 * XXX KDM we've got problems with FC, because it
12212		 * doesn't send down a tag type with aborts.  So we
12213		 * can only really go by the tag number...
12214		 * This may cause problems with parallel SCSI.
12215		 * Need to figure that out!!
12216		 */
12217		if (xio->scsiio.tag_num == io->taskio.tag_num) {
12218			xio->io_hdr.flags |= CTL_FLAG_ABORT;
12219			found = 1;
12220			if ((io->io_hdr.flags & CTL_FLAG_FROM_OTHER_SC) == 0 &&
12221			    !(lun->flags & CTL_LUN_PRIMARY_SC)) {
12222				union ctl_ha_msg msg_info;
12223
12224				msg_info.hdr.nexus = io->io_hdr.nexus;
12225				msg_info.task.task_action = CTL_TASK_ABORT_TASK;
12226				msg_info.task.tag_num = io->taskio.tag_num;
12227				msg_info.task.tag_type = io->taskio.tag_type;
12228				msg_info.hdr.msg_type = CTL_MSG_MANAGE_TASKS;
12229				msg_info.hdr.original_sc = NULL;
12230				msg_info.hdr.serializing_sc = NULL;
12231#if 0
12232				printf("Sent Abort to other side\n");
12233#endif
12234				ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg_info,
12235				    sizeof(msg_info.task), M_NOWAIT);
12236			}
12237#if 0
12238			printf("ctl_abort_task: found I/O to abort\n");
12239#endif
12240		}
12241	}
12242	mtx_unlock(&lun->lun_lock);
12243
12244	if (found == 0) {
12245		/*
12246		 * This isn't really an error.  It's entirely possible for
12247		 * the abort and command completion to cross on the wire.
12248		 * This is more of an informative/diagnostic error.
12249		 */
12250#if 0
12251		printf("ctl_abort_task: ABORT sent for nonexistent I/O: "
12252		       "%u:%u:%u tag %d type %d\n",
12253		       io->io_hdr.nexus.initid,
12254		       io->io_hdr.nexus.targ_port,
12255		       io->io_hdr.nexus.targ_lun, io->taskio.tag_num,
12256		       io->taskio.tag_type);
12257#endif
12258	}
12259	io->taskio.task_status = CTL_TASK_FUNCTION_COMPLETE;
12260	return (0);
12261}
12262
12263static int
12264ctl_query_task(union ctl_io *io, int task_set)
12265{
12266	union ctl_io *xio;
12267	struct ctl_lun *lun;
12268	struct ctl_softc *softc;
12269	int found = 0;
12270	uint32_t targ_lun;
12271
12272	softc = control_softc;
12273	targ_lun = io->io_hdr.nexus.targ_mapped_lun;
12274	mtx_lock(&softc->ctl_lock);
12275	if ((targ_lun >= CTL_MAX_LUNS) ||
12276	    (lun = softc->ctl_luns[targ_lun]) == NULL) {
12277		mtx_unlock(&softc->ctl_lock);
12278		io->taskio.task_status = CTL_TASK_LUN_DOES_NOT_EXIST;
12279		return (1);
12280	}
12281	mtx_lock(&lun->lun_lock);
12282	mtx_unlock(&softc->ctl_lock);
12283	for (xio = (union ctl_io *)TAILQ_FIRST(&lun->ooa_queue); xio != NULL;
12284	     xio = (union ctl_io *)TAILQ_NEXT(&xio->io_hdr, ooa_links)) {
12285
12286		if ((xio->io_hdr.nexus.targ_port != io->io_hdr.nexus.targ_port)
12287		 || (xio->io_hdr.nexus.initid != io->io_hdr.nexus.initid)
12288		 || (xio->io_hdr.flags & CTL_FLAG_ABORT))
12289			continue;
12290
12291		if (task_set || xio->scsiio.tag_num == io->taskio.tag_num) {
12292			found = 1;
12293			break;
12294		}
12295	}
12296	mtx_unlock(&lun->lun_lock);
12297	if (found)
12298		io->taskio.task_status = CTL_TASK_FUNCTION_SUCCEEDED;
12299	else
12300		io->taskio.task_status = CTL_TASK_FUNCTION_COMPLETE;
12301	return (0);
12302}
12303
12304static int
12305ctl_query_async_event(union ctl_io *io)
12306{
12307	struct ctl_lun *lun;
12308	struct ctl_softc *softc;
12309	ctl_ua_type ua;
12310	uint32_t targ_lun, initidx;
12311
12312	softc = control_softc;
12313	targ_lun = io->io_hdr.nexus.targ_mapped_lun;
12314	mtx_lock(&softc->ctl_lock);
12315	if ((targ_lun >= CTL_MAX_LUNS) ||
12316	    (lun = softc->ctl_luns[targ_lun]) == NULL) {
12317		mtx_unlock(&softc->ctl_lock);
12318		io->taskio.task_status = CTL_TASK_LUN_DOES_NOT_EXIST;
12319		return (1);
12320	}
12321	mtx_lock(&lun->lun_lock);
12322	mtx_unlock(&softc->ctl_lock);
12323	initidx = ctl_get_initindex(&io->io_hdr.nexus);
12324	ua = ctl_build_qae(lun, initidx, io->taskio.task_resp);
12325	mtx_unlock(&lun->lun_lock);
12326	if (ua != CTL_UA_NONE)
12327		io->taskio.task_status = CTL_TASK_FUNCTION_SUCCEEDED;
12328	else
12329		io->taskio.task_status = CTL_TASK_FUNCTION_COMPLETE;
12330	return (0);
12331}
12332
12333static void
12334ctl_run_task(union ctl_io *io)
12335{
12336	struct ctl_softc *softc = control_softc;
12337	int retval = 1;
12338
12339	CTL_DEBUG_PRINT(("ctl_run_task\n"));
12340	KASSERT(io->io_hdr.io_type == CTL_IO_TASK,
12341	    ("ctl_run_task: Unextected io_type %d\n", io->io_hdr.io_type));
12342	io->taskio.task_status = CTL_TASK_FUNCTION_NOT_SUPPORTED;
12343	bzero(io->taskio.task_resp, sizeof(io->taskio.task_resp));
12344	switch (io->taskio.task_action) {
12345	case CTL_TASK_ABORT_TASK:
12346		retval = ctl_abort_task(io);
12347		break;
12348	case CTL_TASK_ABORT_TASK_SET:
12349	case CTL_TASK_CLEAR_TASK_SET:
12350		retval = ctl_abort_task_set(io);
12351		break;
12352	case CTL_TASK_CLEAR_ACA:
12353		break;
12354	case CTL_TASK_I_T_NEXUS_RESET:
12355		retval = ctl_i_t_nexus_reset(io);
12356		break;
12357	case CTL_TASK_LUN_RESET:
12358		retval = ctl_lun_reset(softc, io);
12359		break;
12360	case CTL_TASK_TARGET_RESET:
12361		retval = ctl_target_reset(softc, io, CTL_UA_TARG_RESET);
12362		break;
12363	case CTL_TASK_BUS_RESET:
12364		retval = ctl_bus_reset(softc, io);
12365		break;
12366	case CTL_TASK_PORT_LOGIN:
12367		break;
12368	case CTL_TASK_PORT_LOGOUT:
12369		break;
12370	case CTL_TASK_QUERY_TASK:
12371		retval = ctl_query_task(io, 0);
12372		break;
12373	case CTL_TASK_QUERY_TASK_SET:
12374		retval = ctl_query_task(io, 1);
12375		break;
12376	case CTL_TASK_QUERY_ASYNC_EVENT:
12377		retval = ctl_query_async_event(io);
12378		break;
12379	default:
12380		printf("%s: got unknown task management event %d\n",
12381		       __func__, io->taskio.task_action);
12382		break;
12383	}
12384	if (retval == 0)
12385		io->io_hdr.status = CTL_SUCCESS;
12386	else
12387		io->io_hdr.status = CTL_ERROR;
12388	ctl_done(io);
12389}
12390
12391/*
12392 * For HA operation.  Handle commands that come in from the other
12393 * controller.
12394 */
12395static void
12396ctl_handle_isc(union ctl_io *io)
12397{
12398	int free_io;
12399	struct ctl_lun *lun;
12400	struct ctl_softc *softc = control_softc;
12401	uint32_t targ_lun;
12402
12403	targ_lun = io->io_hdr.nexus.targ_mapped_lun;
12404	lun = softc->ctl_luns[targ_lun];
12405
12406	switch (io->io_hdr.msg_type) {
12407	case CTL_MSG_SERIALIZE:
12408		free_io = ctl_serialize_other_sc_cmd(&io->scsiio);
12409		break;
12410	case CTL_MSG_R2R: {
12411		const struct ctl_cmd_entry *entry;
12412
12413		/*
12414		 * This is only used in SER_ONLY mode.
12415		 */
12416		free_io = 0;
12417		entry = ctl_get_cmd_entry(&io->scsiio, NULL);
12418		mtx_lock(&lun->lun_lock);
12419		if (ctl_scsiio_lun_check(lun,
12420		    entry, (struct ctl_scsiio *)io) != 0) {
12421			mtx_unlock(&lun->lun_lock);
12422			ctl_done(io);
12423			break;
12424		}
12425		io->io_hdr.flags |= CTL_FLAG_IS_WAS_ON_RTR;
12426		mtx_unlock(&lun->lun_lock);
12427		ctl_enqueue_rtr(io);
12428		break;
12429	}
12430	case CTL_MSG_FINISH_IO:
12431		if (softc->ha_mode == CTL_HA_MODE_XFER) {
12432			free_io = 0;
12433			ctl_done(io);
12434		} else {
12435			free_io = 1;
12436			mtx_lock(&lun->lun_lock);
12437			TAILQ_REMOVE(&lun->ooa_queue, &io->io_hdr,
12438				     ooa_links);
12439			ctl_check_blocked(lun);
12440			mtx_unlock(&lun->lun_lock);
12441		}
12442		break;
12443	case CTL_MSG_PERS_ACTION:
12444		ctl_hndl_per_res_out_on_other_sc(
12445			(union ctl_ha_msg *)&io->presio.pr_msg);
12446		free_io = 1;
12447		break;
12448	case CTL_MSG_BAD_JUJU:
12449		free_io = 0;
12450		ctl_done(io);
12451		break;
12452	case CTL_MSG_DATAMOVE:
12453		/* Only used in XFER mode */
12454		free_io = 0;
12455		ctl_datamove_remote(io);
12456		break;
12457	case CTL_MSG_DATAMOVE_DONE:
12458		/* Only used in XFER mode */
12459		free_io = 0;
12460		io->scsiio.be_move_done(io);
12461		break;
12462	case CTL_MSG_FAILOVER:
12463		ctl_failover_lun(io);
12464		free_io = 1;
12465		break;
12466	default:
12467		free_io = 1;
12468		printf("%s: Invalid message type %d\n",
12469		       __func__, io->io_hdr.msg_type);
12470		break;
12471	}
12472	if (free_io)
12473		ctl_free_io(io);
12474
12475}
12476
12477
12478/*
12479 * Returns the match type in the case of a match, or CTL_LUN_PAT_NONE if
12480 * there is no match.
12481 */
12482static ctl_lun_error_pattern
12483ctl_cmd_pattern_match(struct ctl_scsiio *ctsio, struct ctl_error_desc *desc)
12484{
12485	const struct ctl_cmd_entry *entry;
12486	ctl_lun_error_pattern filtered_pattern, pattern;
12487
12488	pattern = desc->error_pattern;
12489
12490	/*
12491	 * XXX KDM we need more data passed into this function to match a
12492	 * custom pattern, and we actually need to implement custom pattern
12493	 * matching.
12494	 */
12495	if (pattern & CTL_LUN_PAT_CMD)
12496		return (CTL_LUN_PAT_CMD);
12497
12498	if ((pattern & CTL_LUN_PAT_MASK) == CTL_LUN_PAT_ANY)
12499		return (CTL_LUN_PAT_ANY);
12500
12501	entry = ctl_get_cmd_entry(ctsio, NULL);
12502
12503	filtered_pattern = entry->pattern & pattern;
12504
12505	/*
12506	 * If the user requested specific flags in the pattern (e.g.
12507	 * CTL_LUN_PAT_RANGE), make sure the command supports all of those
12508	 * flags.
12509	 *
12510	 * If the user did not specify any flags, it doesn't matter whether
12511	 * or not the command supports the flags.
12512	 */
12513	if ((filtered_pattern & ~CTL_LUN_PAT_MASK) !=
12514	     (pattern & ~CTL_LUN_PAT_MASK))
12515		return (CTL_LUN_PAT_NONE);
12516
12517	/*
12518	 * If the user asked for a range check, see if the requested LBA
12519	 * range overlaps with this command's LBA range.
12520	 */
12521	if (filtered_pattern & CTL_LUN_PAT_RANGE) {
12522		uint64_t lba1;
12523		uint64_t len1;
12524		ctl_action action;
12525		int retval;
12526
12527		retval = ctl_get_lba_len((union ctl_io *)ctsio, &lba1, &len1);
12528		if (retval != 0)
12529			return (CTL_LUN_PAT_NONE);
12530
12531		action = ctl_extent_check_lba(lba1, len1, desc->lba_range.lba,
12532					      desc->lba_range.len, FALSE);
12533		/*
12534		 * A "pass" means that the LBA ranges don't overlap, so
12535		 * this doesn't match the user's range criteria.
12536		 */
12537		if (action == CTL_ACTION_PASS)
12538			return (CTL_LUN_PAT_NONE);
12539	}
12540
12541	return (filtered_pattern);
12542}
12543
12544static void
12545ctl_inject_error(struct ctl_lun *lun, union ctl_io *io)
12546{
12547	struct ctl_error_desc *desc, *desc2;
12548
12549	mtx_assert(&lun->lun_lock, MA_OWNED);
12550
12551	STAILQ_FOREACH_SAFE(desc, &lun->error_list, links, desc2) {
12552		ctl_lun_error_pattern pattern;
12553		/*
12554		 * Check to see whether this particular command matches
12555		 * the pattern in the descriptor.
12556		 */
12557		pattern = ctl_cmd_pattern_match(&io->scsiio, desc);
12558		if ((pattern & CTL_LUN_PAT_MASK) == CTL_LUN_PAT_NONE)
12559			continue;
12560
12561		switch (desc->lun_error & CTL_LUN_INJ_TYPE) {
12562		case CTL_LUN_INJ_ABORTED:
12563			ctl_set_aborted(&io->scsiio);
12564			break;
12565		case CTL_LUN_INJ_MEDIUM_ERR:
12566			ctl_set_medium_error(&io->scsiio,
12567			    (io->io_hdr.flags & CTL_FLAG_DATA_MASK) !=
12568			     CTL_FLAG_DATA_OUT);
12569			break;
12570		case CTL_LUN_INJ_UA:
12571			/* 29h/00h  POWER ON, RESET, OR BUS DEVICE RESET
12572			 * OCCURRED */
12573			ctl_set_ua(&io->scsiio, 0x29, 0x00);
12574			break;
12575		case CTL_LUN_INJ_CUSTOM:
12576			/*
12577			 * We're assuming the user knows what he is doing.
12578			 * Just copy the sense information without doing
12579			 * checks.
12580			 */
12581			bcopy(&desc->custom_sense, &io->scsiio.sense_data,
12582			      MIN(sizeof(desc->custom_sense),
12583				  sizeof(io->scsiio.sense_data)));
12584			io->scsiio.scsi_status = SCSI_STATUS_CHECK_COND;
12585			io->scsiio.sense_len = SSD_FULL_SIZE;
12586			io->io_hdr.status = CTL_SCSI_ERROR | CTL_AUTOSENSE;
12587			break;
12588		case CTL_LUN_INJ_NONE:
12589		default:
12590			/*
12591			 * If this is an error injection type we don't know
12592			 * about, clear the continuous flag (if it is set)
12593			 * so it will get deleted below.
12594			 */
12595			desc->lun_error &= ~CTL_LUN_INJ_CONTINUOUS;
12596			break;
12597		}
12598		/*
12599		 * By default, each error injection action is a one-shot
12600		 */
12601		if (desc->lun_error & CTL_LUN_INJ_CONTINUOUS)
12602			continue;
12603
12604		STAILQ_REMOVE(&lun->error_list, desc, ctl_error_desc, links);
12605
12606		free(desc, M_CTL);
12607	}
12608}
12609
12610#ifdef CTL_IO_DELAY
12611static void
12612ctl_datamove_timer_wakeup(void *arg)
12613{
12614	union ctl_io *io;
12615
12616	io = (union ctl_io *)arg;
12617
12618	ctl_datamove(io);
12619}
12620#endif /* CTL_IO_DELAY */
12621
12622void
12623ctl_datamove(union ctl_io *io)
12624{
12625	struct ctl_lun *lun;
12626	void (*fe_datamove)(union ctl_io *io);
12627
12628	mtx_assert(&control_softc->ctl_lock, MA_NOTOWNED);
12629
12630	CTL_DEBUG_PRINT(("ctl_datamove\n"));
12631
12632	lun = (struct ctl_lun *)io->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
12633#ifdef CTL_TIME_IO
12634	if ((time_uptime - io->io_hdr.start_time) > ctl_time_io_secs) {
12635		char str[256];
12636		char path_str[64];
12637		struct sbuf sb;
12638
12639		ctl_scsi_path_string(io, path_str, sizeof(path_str));
12640		sbuf_new(&sb, str, sizeof(str), SBUF_FIXEDLEN);
12641
12642		sbuf_cat(&sb, path_str);
12643		switch (io->io_hdr.io_type) {
12644		case CTL_IO_SCSI:
12645			ctl_scsi_command_string(&io->scsiio, NULL, &sb);
12646			sbuf_printf(&sb, "\n");
12647			sbuf_cat(&sb, path_str);
12648			sbuf_printf(&sb, "Tag: 0x%04x, type %d\n",
12649				    io->scsiio.tag_num, io->scsiio.tag_type);
12650			break;
12651		case CTL_IO_TASK:
12652			sbuf_printf(&sb, "Task I/O type: %d, Tag: 0x%04x, "
12653				    "Tag Type: %d\n", io->taskio.task_action,
12654				    io->taskio.tag_num, io->taskio.tag_type);
12655			break;
12656		default:
12657			panic("%s: Invalid CTL I/O type %d\n",
12658			    __func__, io->io_hdr.io_type);
12659		}
12660		sbuf_cat(&sb, path_str);
12661		sbuf_printf(&sb, "ctl_datamove: %jd seconds\n",
12662			    (intmax_t)time_uptime - io->io_hdr.start_time);
12663		sbuf_finish(&sb);
12664		printf("%s", sbuf_data(&sb));
12665	}
12666#endif /* CTL_TIME_IO */
12667
12668#ifdef CTL_IO_DELAY
12669	if (io->io_hdr.flags & CTL_FLAG_DELAY_DONE) {
12670		io->io_hdr.flags &= ~CTL_FLAG_DELAY_DONE;
12671	} else {
12672		if ((lun != NULL)
12673		 && (lun->delay_info.datamove_delay > 0)) {
12674
12675			callout_init(&io->io_hdr.delay_callout, /*mpsafe*/ 1);
12676			io->io_hdr.flags |= CTL_FLAG_DELAY_DONE;
12677			callout_reset(&io->io_hdr.delay_callout,
12678				      lun->delay_info.datamove_delay * hz,
12679				      ctl_datamove_timer_wakeup, io);
12680			if (lun->delay_info.datamove_type ==
12681			    CTL_DELAY_TYPE_ONESHOT)
12682				lun->delay_info.datamove_delay = 0;
12683			return;
12684		}
12685	}
12686#endif
12687
12688	/*
12689	 * This command has been aborted.  Set the port status, so we fail
12690	 * the data move.
12691	 */
12692	if (io->io_hdr.flags & CTL_FLAG_ABORT) {
12693		printf("ctl_datamove: tag 0x%04x on (%u:%u:%u) aborted\n",
12694		       io->scsiio.tag_num, io->io_hdr.nexus.initid,
12695		       io->io_hdr.nexus.targ_port,
12696		       io->io_hdr.nexus.targ_lun);
12697		io->io_hdr.port_status = 31337;
12698		/*
12699		 * Note that the backend, in this case, will get the
12700		 * callback in its context.  In other cases it may get
12701		 * called in the frontend's interrupt thread context.
12702		 */
12703		io->scsiio.be_move_done(io);
12704		return;
12705	}
12706
12707	/* Don't confuse frontend with zero length data move. */
12708	if (io->scsiio.kern_data_len == 0) {
12709		io->scsiio.be_move_done(io);
12710		return;
12711	}
12712
12713	fe_datamove = ctl_io_port(&io->io_hdr)->fe_datamove;
12714	fe_datamove(io);
12715}
12716
12717static void
12718ctl_send_datamove_done(union ctl_io *io, int have_lock)
12719{
12720	union ctl_ha_msg msg;
12721#ifdef CTL_TIME_IO
12722	struct bintime cur_bt;
12723#endif
12724
12725	memset(&msg, 0, sizeof(msg));
12726	msg.hdr.msg_type = CTL_MSG_DATAMOVE_DONE;
12727	msg.hdr.original_sc = io;
12728	msg.hdr.serializing_sc = io->io_hdr.serializing_sc;
12729	msg.hdr.nexus = io->io_hdr.nexus;
12730	msg.hdr.status = io->io_hdr.status;
12731	msg.scsi.tag_num = io->scsiio.tag_num;
12732	msg.scsi.tag_type = io->scsiio.tag_type;
12733	msg.scsi.scsi_status = io->scsiio.scsi_status;
12734	memcpy(&msg.scsi.sense_data, &io->scsiio.sense_data,
12735	       io->scsiio.sense_len);
12736	msg.scsi.sense_len = io->scsiio.sense_len;
12737	msg.scsi.sense_residual = io->scsiio.sense_residual;
12738	msg.scsi.fetd_status = io->io_hdr.port_status;
12739	msg.scsi.residual = io->scsiio.residual;
12740	io->io_hdr.flags &= ~CTL_FLAG_IO_ACTIVE;
12741	if (io->io_hdr.flags & CTL_FLAG_FAILOVER) {
12742		ctl_failover_io(io, /*have_lock*/ have_lock);
12743		return;
12744	}
12745	ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg,
12746	    sizeof(msg.scsi) - sizeof(msg.scsi.sense_data) +
12747	    msg.scsi.sense_len, M_WAITOK);
12748
12749#ifdef CTL_TIME_IO
12750	getbinuptime(&cur_bt);
12751	bintime_sub(&cur_bt, &io->io_hdr.dma_start_bt);
12752	bintime_add(&io->io_hdr.dma_bt, &cur_bt);
12753#endif
12754	io->io_hdr.num_dmas++;
12755}
12756
12757/*
12758 * The DMA to the remote side is done, now we need to tell the other side
12759 * we're done so it can continue with its data movement.
12760 */
12761static void
12762ctl_datamove_remote_write_cb(struct ctl_ha_dt_req *rq)
12763{
12764	union ctl_io *io;
12765	int i;
12766
12767	io = rq->context;
12768
12769	if (rq->ret != CTL_HA_STATUS_SUCCESS) {
12770		printf("%s: ISC DMA write failed with error %d", __func__,
12771		       rq->ret);
12772		ctl_set_internal_failure(&io->scsiio,
12773					 /*sks_valid*/ 1,
12774					 /*retry_count*/ rq->ret);
12775	}
12776
12777	ctl_dt_req_free(rq);
12778
12779	for (i = 0; i < io->scsiio.kern_sg_entries; i++)
12780		free(io->io_hdr.local_sglist[i].addr, M_CTL);
12781	free(io->io_hdr.remote_sglist, M_CTL);
12782	io->io_hdr.remote_sglist = NULL;
12783	io->io_hdr.local_sglist = NULL;
12784
12785	/*
12786	 * The data is in local and remote memory, so now we need to send
12787	 * status (good or back) back to the other side.
12788	 */
12789	ctl_send_datamove_done(io, /*have_lock*/ 0);
12790}
12791
12792/*
12793 * We've moved the data from the host/controller into local memory.  Now we
12794 * need to push it over to the remote controller's memory.
12795 */
12796static int
12797ctl_datamove_remote_dm_write_cb(union ctl_io *io)
12798{
12799	int retval;
12800
12801	retval = ctl_datamove_remote_xfer(io, CTL_HA_DT_CMD_WRITE,
12802					  ctl_datamove_remote_write_cb);
12803	return (retval);
12804}
12805
12806static void
12807ctl_datamove_remote_write(union ctl_io *io)
12808{
12809	int retval;
12810	void (*fe_datamove)(union ctl_io *io);
12811
12812	/*
12813	 * - Get the data from the host/HBA into local memory.
12814	 * - DMA memory from the local controller to the remote controller.
12815	 * - Send status back to the remote controller.
12816	 */
12817
12818	retval = ctl_datamove_remote_sgl_setup(io);
12819	if (retval != 0)
12820		return;
12821
12822	/* Switch the pointer over so the FETD knows what to do */
12823	io->scsiio.kern_data_ptr = (uint8_t *)io->io_hdr.local_sglist;
12824
12825	/*
12826	 * Use a custom move done callback, since we need to send completion
12827	 * back to the other controller, not to the backend on this side.
12828	 */
12829	io->scsiio.be_move_done = ctl_datamove_remote_dm_write_cb;
12830
12831	fe_datamove = ctl_io_port(&io->io_hdr)->fe_datamove;
12832	fe_datamove(io);
12833}
12834
12835static int
12836ctl_datamove_remote_dm_read_cb(union ctl_io *io)
12837{
12838#if 0
12839	char str[256];
12840	char path_str[64];
12841	struct sbuf sb;
12842#endif
12843	int i;
12844
12845	for (i = 0; i < io->scsiio.kern_sg_entries; i++)
12846		free(io->io_hdr.local_sglist[i].addr, M_CTL);
12847	free(io->io_hdr.remote_sglist, M_CTL);
12848	io->io_hdr.remote_sglist = NULL;
12849	io->io_hdr.local_sglist = NULL;
12850
12851#if 0
12852	scsi_path_string(io, path_str, sizeof(path_str));
12853	sbuf_new(&sb, str, sizeof(str), SBUF_FIXEDLEN);
12854	sbuf_cat(&sb, path_str);
12855	scsi_command_string(&io->scsiio, NULL, &sb);
12856	sbuf_printf(&sb, "\n");
12857	sbuf_cat(&sb, path_str);
12858	sbuf_printf(&sb, "Tag: 0x%04x, type %d\n",
12859		    io->scsiio.tag_num, io->scsiio.tag_type);
12860	sbuf_cat(&sb, path_str);
12861	sbuf_printf(&sb, "%s: flags %#x, status %#x\n", __func__,
12862		    io->io_hdr.flags, io->io_hdr.status);
12863	sbuf_finish(&sb);
12864	printk("%s", sbuf_data(&sb));
12865#endif
12866
12867
12868	/*
12869	 * The read is done, now we need to send status (good or bad) back
12870	 * to the other side.
12871	 */
12872	ctl_send_datamove_done(io, /*have_lock*/ 0);
12873
12874	return (0);
12875}
12876
12877static void
12878ctl_datamove_remote_read_cb(struct ctl_ha_dt_req *rq)
12879{
12880	union ctl_io *io;
12881	void (*fe_datamove)(union ctl_io *io);
12882
12883	io = rq->context;
12884
12885	if (rq->ret != CTL_HA_STATUS_SUCCESS) {
12886		printf("%s: ISC DMA read failed with error %d\n", __func__,
12887		       rq->ret);
12888		ctl_set_internal_failure(&io->scsiio,
12889					 /*sks_valid*/ 1,
12890					 /*retry_count*/ rq->ret);
12891	}
12892
12893	ctl_dt_req_free(rq);
12894
12895	/* Switch the pointer over so the FETD knows what to do */
12896	io->scsiio.kern_data_ptr = (uint8_t *)io->io_hdr.local_sglist;
12897
12898	/*
12899	 * Use a custom move done callback, since we need to send completion
12900	 * back to the other controller, not to the backend on this side.
12901	 */
12902	io->scsiio.be_move_done = ctl_datamove_remote_dm_read_cb;
12903
12904	/* XXX KDM add checks like the ones in ctl_datamove? */
12905
12906	fe_datamove = ctl_io_port(&io->io_hdr)->fe_datamove;
12907	fe_datamove(io);
12908}
12909
12910static int
12911ctl_datamove_remote_sgl_setup(union ctl_io *io)
12912{
12913	struct ctl_sg_entry *local_sglist;
12914	uint32_t len_to_go;
12915	int retval;
12916	int i;
12917
12918	retval = 0;
12919	local_sglist = io->io_hdr.local_sglist;
12920	len_to_go = io->scsiio.kern_data_len;
12921
12922	/*
12923	 * The difficult thing here is that the size of the various
12924	 * S/G segments may be different than the size from the
12925	 * remote controller.  That'll make it harder when DMAing
12926	 * the data back to the other side.
12927	 */
12928	for (i = 0; len_to_go > 0; i++) {
12929		local_sglist[i].len = MIN(len_to_go, CTL_HA_DATAMOVE_SEGMENT);
12930		local_sglist[i].addr =
12931		    malloc(local_sglist[i].len, M_CTL, M_WAITOK);
12932
12933		len_to_go -= local_sglist[i].len;
12934	}
12935	/*
12936	 * Reset the number of S/G entries accordingly.  The original
12937	 * number of S/G entries is available in rem_sg_entries.
12938	 */
12939	io->scsiio.kern_sg_entries = i;
12940
12941#if 0
12942	printf("%s: kern_sg_entries = %d\n", __func__,
12943	       io->scsiio.kern_sg_entries);
12944	for (i = 0; i < io->scsiio.kern_sg_entries; i++)
12945		printf("%s: sg[%d] = %p, %lu\n", __func__, i,
12946		       local_sglist[i].addr, local_sglist[i].len);
12947#endif
12948
12949	return (retval);
12950}
12951
12952static int
12953ctl_datamove_remote_xfer(union ctl_io *io, unsigned command,
12954			 ctl_ha_dt_cb callback)
12955{
12956	struct ctl_ha_dt_req *rq;
12957	struct ctl_sg_entry *remote_sglist, *local_sglist;
12958	uint32_t local_used, remote_used, total_used;
12959	int i, j, isc_ret;
12960
12961	rq = ctl_dt_req_alloc();
12962
12963	/*
12964	 * If we failed to allocate the request, and if the DMA didn't fail
12965	 * anyway, set busy status.  This is just a resource allocation
12966	 * failure.
12967	 */
12968	if ((rq == NULL)
12969	 && ((io->io_hdr.status & CTL_STATUS_MASK) != CTL_STATUS_NONE &&
12970	     (io->io_hdr.status & CTL_STATUS_MASK) != CTL_SUCCESS))
12971		ctl_set_busy(&io->scsiio);
12972
12973	if ((io->io_hdr.status & CTL_STATUS_MASK) != CTL_STATUS_NONE &&
12974	    (io->io_hdr.status & CTL_STATUS_MASK) != CTL_SUCCESS) {
12975
12976		if (rq != NULL)
12977			ctl_dt_req_free(rq);
12978
12979		/*
12980		 * The data move failed.  We need to return status back
12981		 * to the other controller.  No point in trying to DMA
12982		 * data to the remote controller.
12983		 */
12984
12985		ctl_send_datamove_done(io, /*have_lock*/ 0);
12986
12987		return (1);
12988	}
12989
12990	local_sglist = io->io_hdr.local_sglist;
12991	remote_sglist = io->io_hdr.remote_sglist;
12992	local_used = 0;
12993	remote_used = 0;
12994	total_used = 0;
12995
12996	/*
12997	 * Pull/push the data over the wire from/to the other controller.
12998	 * This takes into account the possibility that the local and
12999	 * remote sglists may not be identical in terms of the size of
13000	 * the elements and the number of elements.
13001	 *
13002	 * One fundamental assumption here is that the length allocated for
13003	 * both the local and remote sglists is identical.  Otherwise, we've
13004	 * essentially got a coding error of some sort.
13005	 */
13006	isc_ret = CTL_HA_STATUS_SUCCESS;
13007	for (i = 0, j = 0; total_used < io->scsiio.kern_data_len; ) {
13008		uint32_t cur_len;
13009		uint8_t *tmp_ptr;
13010
13011		rq->command = command;
13012		rq->context = io;
13013
13014		/*
13015		 * Both pointers should be aligned.  But it is possible
13016		 * that the allocation length is not.  They should both
13017		 * also have enough slack left over at the end, though,
13018		 * to round up to the next 8 byte boundary.
13019		 */
13020		cur_len = MIN(local_sglist[i].len - local_used,
13021			      remote_sglist[j].len - remote_used);
13022		rq->size = cur_len;
13023
13024		tmp_ptr = (uint8_t *)local_sglist[i].addr;
13025		tmp_ptr += local_used;
13026
13027#if 0
13028		/* Use physical addresses when talking to ISC hardware */
13029		if ((io->io_hdr.flags & CTL_FLAG_BUS_ADDR) == 0) {
13030			/* XXX KDM use busdma */
13031			rq->local = vtophys(tmp_ptr);
13032		} else
13033			rq->local = tmp_ptr;
13034#else
13035		KASSERT((io->io_hdr.flags & CTL_FLAG_BUS_ADDR) == 0,
13036		    ("HA does not support BUS_ADDR"));
13037		rq->local = tmp_ptr;
13038#endif
13039
13040		tmp_ptr = (uint8_t *)remote_sglist[j].addr;
13041		tmp_ptr += remote_used;
13042		rq->remote = tmp_ptr;
13043
13044		rq->callback = NULL;
13045
13046		local_used += cur_len;
13047		if (local_used >= local_sglist[i].len) {
13048			i++;
13049			local_used = 0;
13050		}
13051
13052		remote_used += cur_len;
13053		if (remote_used >= remote_sglist[j].len) {
13054			j++;
13055			remote_used = 0;
13056		}
13057		total_used += cur_len;
13058
13059		if (total_used >= io->scsiio.kern_data_len)
13060			rq->callback = callback;
13061
13062#if 0
13063		printf("%s: %s: local %p remote %p size %d\n", __func__,
13064		       (command == CTL_HA_DT_CMD_WRITE) ? "WRITE" : "READ",
13065		       rq->local, rq->remote, rq->size);
13066#endif
13067
13068		isc_ret = ctl_dt_single(rq);
13069		if (isc_ret > CTL_HA_STATUS_SUCCESS)
13070			break;
13071	}
13072	if (isc_ret != CTL_HA_STATUS_WAIT) {
13073		rq->ret = isc_ret;
13074		callback(rq);
13075	}
13076
13077	return (0);
13078}
13079
13080static void
13081ctl_datamove_remote_read(union ctl_io *io)
13082{
13083	int retval;
13084	int i;
13085
13086	/*
13087	 * This will send an error to the other controller in the case of a
13088	 * failure.
13089	 */
13090	retval = ctl_datamove_remote_sgl_setup(io);
13091	if (retval != 0)
13092		return;
13093
13094	retval = ctl_datamove_remote_xfer(io, CTL_HA_DT_CMD_READ,
13095					  ctl_datamove_remote_read_cb);
13096	if (retval != 0) {
13097		/*
13098		 * Make sure we free memory if there was an error..  The
13099		 * ctl_datamove_remote_xfer() function will send the
13100		 * datamove done message, or call the callback with an
13101		 * error if there is a problem.
13102		 */
13103		for (i = 0; i < io->scsiio.kern_sg_entries; i++)
13104			free(io->io_hdr.local_sglist[i].addr, M_CTL);
13105		free(io->io_hdr.remote_sglist, M_CTL);
13106		io->io_hdr.remote_sglist = NULL;
13107		io->io_hdr.local_sglist = NULL;
13108	}
13109}
13110
13111/*
13112 * Process a datamove request from the other controller.  This is used for
13113 * XFER mode only, not SER_ONLY mode.  For writes, we DMA into local memory
13114 * first.  Once that is complete, the data gets DMAed into the remote
13115 * controller's memory.  For reads, we DMA from the remote controller's
13116 * memory into our memory first, and then move it out to the FETD.
13117 */
13118static void
13119ctl_datamove_remote(union ctl_io *io)
13120{
13121
13122	mtx_assert(&control_softc->ctl_lock, MA_NOTOWNED);
13123
13124	if (io->io_hdr.flags & CTL_FLAG_FAILOVER) {
13125		ctl_failover_io(io, /*have_lock*/ 0);
13126		return;
13127	}
13128
13129	/*
13130	 * Note that we look for an aborted I/O here, but don't do some of
13131	 * the other checks that ctl_datamove() normally does.
13132	 * We don't need to run the datamove delay code, since that should
13133	 * have been done if need be on the other controller.
13134	 */
13135	if (io->io_hdr.flags & CTL_FLAG_ABORT) {
13136		printf("%s: tag 0x%04x on (%u:%u:%u) aborted\n", __func__,
13137		       io->scsiio.tag_num, io->io_hdr.nexus.initid,
13138		       io->io_hdr.nexus.targ_port,
13139		       io->io_hdr.nexus.targ_lun);
13140		io->io_hdr.port_status = 31338;
13141		ctl_send_datamove_done(io, /*have_lock*/ 0);
13142		return;
13143	}
13144
13145	if ((io->io_hdr.flags & CTL_FLAG_DATA_MASK) == CTL_FLAG_DATA_OUT)
13146		ctl_datamove_remote_write(io);
13147	else if ((io->io_hdr.flags & CTL_FLAG_DATA_MASK) == CTL_FLAG_DATA_IN)
13148		ctl_datamove_remote_read(io);
13149	else {
13150		io->io_hdr.port_status = 31339;
13151		ctl_send_datamove_done(io, /*have_lock*/ 0);
13152	}
13153}
13154
13155static void
13156ctl_process_done(union ctl_io *io)
13157{
13158	struct ctl_lun *lun;
13159	struct ctl_softc *softc = control_softc;
13160	void (*fe_done)(union ctl_io *io);
13161	union ctl_ha_msg msg;
13162	uint32_t targ_port = io->io_hdr.nexus.targ_port;
13163
13164	CTL_DEBUG_PRINT(("ctl_process_done\n"));
13165	fe_done = softc->ctl_ports[targ_port]->fe_done;
13166
13167#ifdef CTL_TIME_IO
13168	if ((time_uptime - io->io_hdr.start_time) > ctl_time_io_secs) {
13169		char str[256];
13170		char path_str[64];
13171		struct sbuf sb;
13172
13173		ctl_scsi_path_string(io, path_str, sizeof(path_str));
13174		sbuf_new(&sb, str, sizeof(str), SBUF_FIXEDLEN);
13175
13176		sbuf_cat(&sb, path_str);
13177		switch (io->io_hdr.io_type) {
13178		case CTL_IO_SCSI:
13179			ctl_scsi_command_string(&io->scsiio, NULL, &sb);
13180			sbuf_printf(&sb, "\n");
13181			sbuf_cat(&sb, path_str);
13182			sbuf_printf(&sb, "Tag: 0x%04x, type %d\n",
13183				    io->scsiio.tag_num, io->scsiio.tag_type);
13184			break;
13185		case CTL_IO_TASK:
13186			sbuf_printf(&sb, "Task I/O type: %d, Tag: 0x%04x, "
13187				    "Tag Type: %d\n", io->taskio.task_action,
13188				    io->taskio.tag_num, io->taskio.tag_type);
13189			break;
13190		default:
13191			panic("%s: Invalid CTL I/O type %d\n",
13192			    __func__, io->io_hdr.io_type);
13193		}
13194		sbuf_cat(&sb, path_str);
13195		sbuf_printf(&sb, "ctl_process_done: %jd seconds\n",
13196			    (intmax_t)time_uptime - io->io_hdr.start_time);
13197		sbuf_finish(&sb);
13198		printf("%s", sbuf_data(&sb));
13199	}
13200#endif /* CTL_TIME_IO */
13201
13202	switch (io->io_hdr.io_type) {
13203	case CTL_IO_SCSI:
13204		break;
13205	case CTL_IO_TASK:
13206		if (ctl_debug & CTL_DEBUG_INFO)
13207			ctl_io_error_print(io, NULL);
13208		fe_done(io);
13209		return;
13210	default:
13211		panic("%s: Invalid CTL I/O type %d\n",
13212		    __func__, io->io_hdr.io_type);
13213	}
13214
13215	lun = (struct ctl_lun *)io->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
13216	if (lun == NULL) {
13217		CTL_DEBUG_PRINT(("NULL LUN for lun %d\n",
13218				 io->io_hdr.nexus.targ_mapped_lun));
13219		goto bailout;
13220	}
13221
13222	mtx_lock(&lun->lun_lock);
13223
13224	/*
13225	 * Check to see if we have any errors to inject here.  We only
13226	 * inject errors for commands that don't already have errors set.
13227	 */
13228	if (!STAILQ_EMPTY(&lun->error_list) &&
13229	    ((io->io_hdr.status & CTL_STATUS_MASK) == CTL_SUCCESS) &&
13230	    ((io->io_hdr.flags & CTL_FLAG_STATUS_SENT) == 0))
13231		ctl_inject_error(lun, io);
13232
13233	/*
13234	 * XXX KDM how do we treat commands that aren't completed
13235	 * successfully?
13236	 *
13237	 * XXX KDM should we also track I/O latency?
13238	 */
13239	if ((io->io_hdr.status & CTL_STATUS_MASK) == CTL_SUCCESS &&
13240	    io->io_hdr.io_type == CTL_IO_SCSI) {
13241#ifdef CTL_TIME_IO
13242		struct bintime cur_bt;
13243#endif
13244		int type;
13245
13246		if ((io->io_hdr.flags & CTL_FLAG_DATA_MASK) ==
13247		    CTL_FLAG_DATA_IN)
13248			type = CTL_STATS_READ;
13249		else if ((io->io_hdr.flags & CTL_FLAG_DATA_MASK) ==
13250		    CTL_FLAG_DATA_OUT)
13251			type = CTL_STATS_WRITE;
13252		else
13253			type = CTL_STATS_NO_IO;
13254
13255		lun->stats.ports[targ_port].bytes[type] +=
13256		    io->scsiio.kern_total_len;
13257		lun->stats.ports[targ_port].operations[type]++;
13258#ifdef CTL_TIME_IO
13259		bintime_add(&lun->stats.ports[targ_port].dma_time[type],
13260		   &io->io_hdr.dma_bt);
13261		getbinuptime(&cur_bt);
13262		bintime_sub(&cur_bt, &io->io_hdr.start_bt);
13263		bintime_add(&lun->stats.ports[targ_port].time[type], &cur_bt);
13264#endif
13265		lun->stats.ports[targ_port].num_dmas[type] +=
13266		    io->io_hdr.num_dmas;
13267	}
13268
13269	/*
13270	 * Remove this from the OOA queue.
13271	 */
13272	TAILQ_REMOVE(&lun->ooa_queue, &io->io_hdr, ooa_links);
13273#ifdef CTL_TIME_IO
13274	if (TAILQ_EMPTY(&lun->ooa_queue))
13275		lun->last_busy = getsbinuptime();
13276#endif
13277
13278	/*
13279	 * Run through the blocked queue on this LUN and see if anything
13280	 * has become unblocked, now that this transaction is done.
13281	 */
13282	ctl_check_blocked(lun);
13283
13284	/*
13285	 * If the LUN has been invalidated, free it if there is nothing
13286	 * left on its OOA queue.
13287	 */
13288	if ((lun->flags & CTL_LUN_INVALID)
13289	 && TAILQ_EMPTY(&lun->ooa_queue)) {
13290		mtx_unlock(&lun->lun_lock);
13291		mtx_lock(&softc->ctl_lock);
13292		ctl_free_lun(lun);
13293		mtx_unlock(&softc->ctl_lock);
13294	} else
13295		mtx_unlock(&lun->lun_lock);
13296
13297bailout:
13298
13299	/*
13300	 * If this command has been aborted, make sure we set the status
13301	 * properly.  The FETD is responsible for freeing the I/O and doing
13302	 * whatever it needs to do to clean up its state.
13303	 */
13304	if (io->io_hdr.flags & CTL_FLAG_ABORT)
13305		ctl_set_task_aborted(&io->scsiio);
13306
13307	/*
13308	 * If enabled, print command error status.
13309	 */
13310	if ((io->io_hdr.status & CTL_STATUS_MASK) != CTL_SUCCESS &&
13311	    (ctl_debug & CTL_DEBUG_INFO) != 0)
13312		ctl_io_error_print(io, NULL);
13313
13314	/*
13315	 * Tell the FETD or the other shelf controller we're done with this
13316	 * command.  Note that only SCSI commands get to this point.  Task
13317	 * management commands are completed above.
13318	 */
13319	if ((softc->ha_mode != CTL_HA_MODE_XFER) &&
13320	    (io->io_hdr.flags & CTL_FLAG_SENT_2OTHER_SC)) {
13321		memset(&msg, 0, sizeof(msg));
13322		msg.hdr.msg_type = CTL_MSG_FINISH_IO;
13323		msg.hdr.serializing_sc = io->io_hdr.serializing_sc;
13324		msg.hdr.nexus = io->io_hdr.nexus;
13325		ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg,
13326		    sizeof(msg.scsi) - sizeof(msg.scsi.sense_data),
13327		    M_WAITOK);
13328	}
13329
13330	fe_done(io);
13331}
13332
13333#ifdef CTL_WITH_CA
13334/*
13335 * Front end should call this if it doesn't do autosense.  When the request
13336 * sense comes back in from the initiator, we'll dequeue this and send it.
13337 */
13338int
13339ctl_queue_sense(union ctl_io *io)
13340{
13341	struct ctl_lun *lun;
13342	struct ctl_port *port;
13343	struct ctl_softc *softc;
13344	uint32_t initidx, targ_lun;
13345
13346	softc = control_softc;
13347
13348	CTL_DEBUG_PRINT(("ctl_queue_sense\n"));
13349
13350	/*
13351	 * LUN lookup will likely move to the ctl_work_thread() once we
13352	 * have our new queueing infrastructure (that doesn't put things on
13353	 * a per-LUN queue initially).  That is so that we can handle
13354	 * things like an INQUIRY to a LUN that we don't have enabled.  We
13355	 * can't deal with that right now.
13356	 */
13357	mtx_lock(&softc->ctl_lock);
13358
13359	/*
13360	 * If we don't have a LUN for this, just toss the sense
13361	 * information.
13362	 */
13363	port = ctl_io_port(&ctsio->io_hdr);
13364	targ_lun = ctl_lun_map_from_port(port, io->io_hdr.nexus.targ_lun);
13365	if ((targ_lun < CTL_MAX_LUNS)
13366	 && (softc->ctl_luns[targ_lun] != NULL))
13367		lun = softc->ctl_luns[targ_lun];
13368	else
13369		goto bailout;
13370
13371	initidx = ctl_get_initindex(&io->io_hdr.nexus);
13372
13373	mtx_lock(&lun->lun_lock);
13374	/*
13375	 * Already have CA set for this LUN...toss the sense information.
13376	 */
13377	if (ctl_is_set(lun->have_ca, initidx)) {
13378		mtx_unlock(&lun->lun_lock);
13379		goto bailout;
13380	}
13381
13382	memcpy(&lun->pending_sense[initidx], &io->scsiio.sense_data,
13383	       MIN(sizeof(lun->pending_sense[initidx]),
13384	       sizeof(io->scsiio.sense_data)));
13385	ctl_set_mask(lun->have_ca, initidx);
13386	mtx_unlock(&lun->lun_lock);
13387
13388bailout:
13389	mtx_unlock(&softc->ctl_lock);
13390
13391	ctl_free_io(io);
13392
13393	return (CTL_RETVAL_COMPLETE);
13394}
13395#endif
13396
13397/*
13398 * Primary command inlet from frontend ports.  All SCSI and task I/O
13399 * requests must go through this function.
13400 */
13401int
13402ctl_queue(union ctl_io *io)
13403{
13404	struct ctl_port *port;
13405
13406	CTL_DEBUG_PRINT(("ctl_queue cdb[0]=%02X\n", io->scsiio.cdb[0]));
13407
13408#ifdef CTL_TIME_IO
13409	io->io_hdr.start_time = time_uptime;
13410	getbinuptime(&io->io_hdr.start_bt);
13411#endif /* CTL_TIME_IO */
13412
13413	/* Map FE-specific LUN ID into global one. */
13414	port = ctl_io_port(&io->io_hdr);
13415	io->io_hdr.nexus.targ_mapped_lun =
13416	    ctl_lun_map_from_port(port, io->io_hdr.nexus.targ_lun);
13417
13418	switch (io->io_hdr.io_type) {
13419	case CTL_IO_SCSI:
13420	case CTL_IO_TASK:
13421		if (ctl_debug & CTL_DEBUG_CDB)
13422			ctl_io_print(io);
13423		ctl_enqueue_incoming(io);
13424		break;
13425	default:
13426		printf("ctl_queue: unknown I/O type %d\n", io->io_hdr.io_type);
13427		return (EINVAL);
13428	}
13429
13430	return (CTL_RETVAL_COMPLETE);
13431}
13432
13433#ifdef CTL_IO_DELAY
13434static void
13435ctl_done_timer_wakeup(void *arg)
13436{
13437	union ctl_io *io;
13438
13439	io = (union ctl_io *)arg;
13440	ctl_done(io);
13441}
13442#endif /* CTL_IO_DELAY */
13443
13444void
13445ctl_serseq_done(union ctl_io *io)
13446{
13447	struct ctl_lun *lun;
13448
13449	lun = (struct ctl_lun *)io->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
13450	if (lun->be_lun == NULL ||
13451	    lun->be_lun->serseq == CTL_LUN_SERSEQ_OFF)
13452		return;
13453	mtx_lock(&lun->lun_lock);
13454	io->io_hdr.flags |= CTL_FLAG_SERSEQ_DONE;
13455	ctl_check_blocked(lun);
13456	mtx_unlock(&lun->lun_lock);
13457}
13458
13459void
13460ctl_done(union ctl_io *io)
13461{
13462
13463	/*
13464	 * Enable this to catch duplicate completion issues.
13465	 */
13466#if 0
13467	if (io->io_hdr.flags & CTL_FLAG_ALREADY_DONE) {
13468		printf("%s: type %d msg %d cdb %x iptl: "
13469		       "%u:%u:%u tag 0x%04x "
13470		       "flag %#x status %x\n",
13471			__func__,
13472			io->io_hdr.io_type,
13473			io->io_hdr.msg_type,
13474			io->scsiio.cdb[0],
13475			io->io_hdr.nexus.initid,
13476			io->io_hdr.nexus.targ_port,
13477			io->io_hdr.nexus.targ_lun,
13478			(io->io_hdr.io_type ==
13479			CTL_IO_TASK) ?
13480			io->taskio.tag_num :
13481			io->scsiio.tag_num,
13482		        io->io_hdr.flags,
13483			io->io_hdr.status);
13484	} else
13485		io->io_hdr.flags |= CTL_FLAG_ALREADY_DONE;
13486#endif
13487
13488	/*
13489	 * This is an internal copy of an I/O, and should not go through
13490	 * the normal done processing logic.
13491	 */
13492	if (io->io_hdr.flags & CTL_FLAG_INT_COPY)
13493		return;
13494
13495#ifdef CTL_IO_DELAY
13496	if (io->io_hdr.flags & CTL_FLAG_DELAY_DONE) {
13497		struct ctl_lun *lun;
13498
13499		lun =(struct ctl_lun *)io->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
13500
13501		io->io_hdr.flags &= ~CTL_FLAG_DELAY_DONE;
13502	} else {
13503		struct ctl_lun *lun;
13504
13505		lun =(struct ctl_lun *)io->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
13506
13507		if ((lun != NULL)
13508		 && (lun->delay_info.done_delay > 0)) {
13509
13510			callout_init(&io->io_hdr.delay_callout, /*mpsafe*/ 1);
13511			io->io_hdr.flags |= CTL_FLAG_DELAY_DONE;
13512			callout_reset(&io->io_hdr.delay_callout,
13513				      lun->delay_info.done_delay * hz,
13514				      ctl_done_timer_wakeup, io);
13515			if (lun->delay_info.done_type == CTL_DELAY_TYPE_ONESHOT)
13516				lun->delay_info.done_delay = 0;
13517			return;
13518		}
13519	}
13520#endif /* CTL_IO_DELAY */
13521
13522	ctl_enqueue_done(io);
13523}
13524
13525static void
13526ctl_work_thread(void *arg)
13527{
13528	struct ctl_thread *thr = (struct ctl_thread *)arg;
13529	struct ctl_softc *softc = thr->ctl_softc;
13530	union ctl_io *io;
13531	int retval;
13532
13533	CTL_DEBUG_PRINT(("ctl_work_thread starting\n"));
13534
13535	for (;;) {
13536		/*
13537		 * We handle the queues in this order:
13538		 * - ISC
13539		 * - done queue (to free up resources, unblock other commands)
13540		 * - RtR queue
13541		 * - incoming queue
13542		 *
13543		 * If those queues are empty, we break out of the loop and
13544		 * go to sleep.
13545		 */
13546		mtx_lock(&thr->queue_lock);
13547		io = (union ctl_io *)STAILQ_FIRST(&thr->isc_queue);
13548		if (io != NULL) {
13549			STAILQ_REMOVE_HEAD(&thr->isc_queue, links);
13550			mtx_unlock(&thr->queue_lock);
13551			ctl_handle_isc(io);
13552			continue;
13553		}
13554		io = (union ctl_io *)STAILQ_FIRST(&thr->done_queue);
13555		if (io != NULL) {
13556			STAILQ_REMOVE_HEAD(&thr->done_queue, links);
13557			/* clear any blocked commands, call fe_done */
13558			mtx_unlock(&thr->queue_lock);
13559			ctl_process_done(io);
13560			continue;
13561		}
13562		io = (union ctl_io *)STAILQ_FIRST(&thr->incoming_queue);
13563		if (io != NULL) {
13564			STAILQ_REMOVE_HEAD(&thr->incoming_queue, links);
13565			mtx_unlock(&thr->queue_lock);
13566			if (io->io_hdr.io_type == CTL_IO_TASK)
13567				ctl_run_task(io);
13568			else
13569				ctl_scsiio_precheck(softc, &io->scsiio);
13570			continue;
13571		}
13572		io = (union ctl_io *)STAILQ_FIRST(&thr->rtr_queue);
13573		if (io != NULL) {
13574			STAILQ_REMOVE_HEAD(&thr->rtr_queue, links);
13575			mtx_unlock(&thr->queue_lock);
13576			retval = ctl_scsiio(&io->scsiio);
13577			if (retval != CTL_RETVAL_COMPLETE)
13578				CTL_DEBUG_PRINT(("ctl_scsiio failed\n"));
13579			continue;
13580		}
13581
13582		/* Sleep until we have something to do. */
13583		mtx_sleep(thr, &thr->queue_lock, PDROP | PRIBIO, "-", 0);
13584	}
13585}
13586
13587static void
13588ctl_lun_thread(void *arg)
13589{
13590	struct ctl_softc *softc = (struct ctl_softc *)arg;
13591	struct ctl_be_lun *be_lun;
13592
13593	CTL_DEBUG_PRINT(("ctl_lun_thread starting\n"));
13594
13595	for (;;) {
13596		mtx_lock(&softc->ctl_lock);
13597		be_lun = STAILQ_FIRST(&softc->pending_lun_queue);
13598		if (be_lun != NULL) {
13599			STAILQ_REMOVE_HEAD(&softc->pending_lun_queue, links);
13600			mtx_unlock(&softc->ctl_lock);
13601			ctl_create_lun(be_lun);
13602			continue;
13603		}
13604
13605		/* Sleep until we have something to do. */
13606		mtx_sleep(&softc->pending_lun_queue, &softc->ctl_lock,
13607		    PDROP | PRIBIO, "-", 0);
13608	}
13609}
13610
13611static void
13612ctl_thresh_thread(void *arg)
13613{
13614	struct ctl_softc *softc = (struct ctl_softc *)arg;
13615	struct ctl_lun *lun;
13616	struct scsi_da_rw_recovery_page *rwpage;
13617	struct ctl_logical_block_provisioning_page *page;
13618	const char *attr;
13619	union ctl_ha_msg msg;
13620	uint64_t thres, val;
13621	int i, e, set;
13622
13623	CTL_DEBUG_PRINT(("ctl_thresh_thread starting\n"));
13624
13625	for (;;) {
13626		mtx_lock(&softc->ctl_lock);
13627		STAILQ_FOREACH(lun, &softc->lun_list, links) {
13628			if ((lun->flags & CTL_LUN_DISABLED) ||
13629			    (lun->flags & CTL_LUN_NO_MEDIA) ||
13630			    lun->backend->lun_attr == NULL)
13631				continue;
13632			if ((lun->flags & CTL_LUN_PRIMARY_SC) == 0 &&
13633			    softc->ha_mode == CTL_HA_MODE_XFER)
13634				continue;
13635			rwpage = &lun->mode_pages.rw_er_page[CTL_PAGE_CURRENT];
13636			if ((rwpage->byte8 & SMS_RWER_LBPERE) == 0)
13637				continue;
13638			e = 0;
13639			page = &lun->mode_pages.lbp_page[CTL_PAGE_CURRENT];
13640			for (i = 0; i < CTL_NUM_LBP_THRESH; i++) {
13641				if ((page->descr[i].flags & SLBPPD_ENABLED) == 0)
13642					continue;
13643				thres = scsi_4btoul(page->descr[i].count);
13644				thres <<= CTL_LBP_EXPONENT;
13645				switch (page->descr[i].resource) {
13646				case 0x01:
13647					attr = "blocksavail";
13648					break;
13649				case 0x02:
13650					attr = "blocksused";
13651					break;
13652				case 0xf1:
13653					attr = "poolblocksavail";
13654					break;
13655				case 0xf2:
13656					attr = "poolblocksused";
13657					break;
13658				default:
13659					continue;
13660				}
13661				mtx_unlock(&softc->ctl_lock); // XXX
13662				val = lun->backend->lun_attr(
13663				    lun->be_lun->be_lun, attr);
13664				mtx_lock(&softc->ctl_lock);
13665				if (val == UINT64_MAX)
13666					continue;
13667				if ((page->descr[i].flags & SLBPPD_ARMING_MASK)
13668				    == SLBPPD_ARMING_INC)
13669					e = (val >= thres);
13670				else
13671					e = (val <= thres);
13672				if (e)
13673					break;
13674			}
13675			mtx_lock(&lun->lun_lock);
13676			if (e) {
13677				scsi_u64to8b((uint8_t *)&page->descr[i] -
13678				    (uint8_t *)page, lun->ua_tpt_info);
13679				if (lun->lasttpt == 0 ||
13680				    time_uptime - lun->lasttpt >= CTL_LBP_UA_PERIOD) {
13681					lun->lasttpt = time_uptime;
13682					ctl_est_ua_all(lun, -1, CTL_UA_THIN_PROV_THRES);
13683					set = 1;
13684				} else
13685					set = 0;
13686			} else {
13687				lun->lasttpt = 0;
13688				ctl_clr_ua_all(lun, -1, CTL_UA_THIN_PROV_THRES);
13689				set = -1;
13690			}
13691			mtx_unlock(&lun->lun_lock);
13692			if (set != 0 &&
13693			    lun->ctl_softc->ha_mode == CTL_HA_MODE_XFER) {
13694				/* Send msg to other side. */
13695				bzero(&msg.ua, sizeof(msg.ua));
13696				msg.hdr.msg_type = CTL_MSG_UA;
13697				msg.hdr.nexus.initid = -1;
13698				msg.hdr.nexus.targ_port = -1;
13699				msg.hdr.nexus.targ_lun = lun->lun;
13700				msg.hdr.nexus.targ_mapped_lun = lun->lun;
13701				msg.ua.ua_all = 1;
13702				msg.ua.ua_set = (set > 0);
13703				msg.ua.ua_type = CTL_UA_THIN_PROV_THRES;
13704				memcpy(msg.ua.ua_info, lun->ua_tpt_info, 8);
13705				mtx_unlock(&softc->ctl_lock); // XXX
13706				ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg,
13707				    sizeof(msg.ua), M_WAITOK);
13708				mtx_lock(&softc->ctl_lock);
13709			}
13710		}
13711		mtx_unlock(&softc->ctl_lock);
13712		pause("-", CTL_LBP_PERIOD * hz);
13713	}
13714}
13715
13716static void
13717ctl_enqueue_incoming(union ctl_io *io)
13718{
13719	struct ctl_softc *softc = control_softc;
13720	struct ctl_thread *thr;
13721	u_int idx;
13722
13723	idx = (io->io_hdr.nexus.targ_port * 127 +
13724	       io->io_hdr.nexus.initid) % worker_threads;
13725	thr = &softc->threads[idx];
13726	mtx_lock(&thr->queue_lock);
13727	STAILQ_INSERT_TAIL(&thr->incoming_queue, &io->io_hdr, links);
13728	mtx_unlock(&thr->queue_lock);
13729	wakeup(thr);
13730}
13731
13732static void
13733ctl_enqueue_rtr(union ctl_io *io)
13734{
13735	struct ctl_softc *softc = control_softc;
13736	struct ctl_thread *thr;
13737
13738	thr = &softc->threads[io->io_hdr.nexus.targ_mapped_lun % worker_threads];
13739	mtx_lock(&thr->queue_lock);
13740	STAILQ_INSERT_TAIL(&thr->rtr_queue, &io->io_hdr, links);
13741	mtx_unlock(&thr->queue_lock);
13742	wakeup(thr);
13743}
13744
13745static void
13746ctl_enqueue_done(union ctl_io *io)
13747{
13748	struct ctl_softc *softc = control_softc;
13749	struct ctl_thread *thr;
13750
13751	thr = &softc->threads[io->io_hdr.nexus.targ_mapped_lun % worker_threads];
13752	mtx_lock(&thr->queue_lock);
13753	STAILQ_INSERT_TAIL(&thr->done_queue, &io->io_hdr, links);
13754	mtx_unlock(&thr->queue_lock);
13755	wakeup(thr);
13756}
13757
13758static void
13759ctl_enqueue_isc(union ctl_io *io)
13760{
13761	struct ctl_softc *softc = control_softc;
13762	struct ctl_thread *thr;
13763
13764	thr = &softc->threads[io->io_hdr.nexus.targ_mapped_lun % worker_threads];
13765	mtx_lock(&thr->queue_lock);
13766	STAILQ_INSERT_TAIL(&thr->isc_queue, &io->io_hdr, links);
13767	mtx_unlock(&thr->queue_lock);
13768	wakeup(thr);
13769}
13770
13771/*
13772 *  vim: ts=8
13773 */
13774