ctl.c revision 271316
1/*-
2 * Copyright (c) 2003-2009 Silicon Graphics International Corp.
3 * Copyright (c) 2012 The FreeBSD Foundation
4 * All rights reserved.
5 *
6 * Portions of this software were developed by Edward Tomasz Napierala
7 * under sponsorship from the FreeBSD Foundation.
8 *
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
11 * are met:
12 * 1. Redistributions of source code must retain the above copyright
13 *    notice, this list of conditions, and the following disclaimer,
14 *    without modification.
15 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
16 *    substantially similar to the "NO WARRANTY" disclaimer below
17 *    ("Disclaimer") and any redistribution must be conditioned upon
18 *    including a substantially similar Disclaimer requirement for further
19 *    binary redistribution.
20 *
21 * NO WARRANTY
22 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
25 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
26 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
30 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
31 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
32 * POSSIBILITY OF SUCH DAMAGES.
33 *
34 * $Id: //depot/users/kenm/FreeBSD-test2/sys/cam/ctl/ctl.c#8 $
35 */
36/*
37 * CAM Target Layer, a SCSI device emulation subsystem.
38 *
39 * Author: Ken Merry <ken@FreeBSD.org>
40 */
41
42#define _CTL_C
43
44#include <sys/cdefs.h>
45__FBSDID("$FreeBSD: head/sys/cam/ctl/ctl.c 271316 2014-09-09 15:19:38Z mav $");
46
47#include <sys/param.h>
48#include <sys/systm.h>
49#include <sys/kernel.h>
50#include <sys/types.h>
51#include <sys/kthread.h>
52#include <sys/bio.h>
53#include <sys/fcntl.h>
54#include <sys/lock.h>
55#include <sys/module.h>
56#include <sys/mutex.h>
57#include <sys/condvar.h>
58#include <sys/malloc.h>
59#include <sys/conf.h>
60#include <sys/ioccom.h>
61#include <sys/queue.h>
62#include <sys/sbuf.h>
63#include <sys/smp.h>
64#include <sys/endian.h>
65#include <sys/sysctl.h>
66
67#include <cam/cam.h>
68#include <cam/scsi/scsi_all.h>
69#include <cam/scsi/scsi_da.h>
70#include <cam/ctl/ctl_io.h>
71#include <cam/ctl/ctl.h>
72#include <cam/ctl/ctl_frontend.h>
73#include <cam/ctl/ctl_frontend_internal.h>
74#include <cam/ctl/ctl_util.h>
75#include <cam/ctl/ctl_backend.h>
76#include <cam/ctl/ctl_ioctl.h>
77#include <cam/ctl/ctl_ha.h>
78#include <cam/ctl/ctl_private.h>
79#include <cam/ctl/ctl_debug.h>
80#include <cam/ctl/ctl_scsi_all.h>
81#include <cam/ctl/ctl_error.h>
82
83struct ctl_softc *control_softc = NULL;
84
85/*
86 * Size and alignment macros needed for Copan-specific HA hardware.  These
87 * can go away when the HA code is re-written, and uses busdma for any
88 * hardware.
89 */
90#define	CTL_ALIGN_8B(target, source, type)				\
91	if (((uint32_t)source & 0x7) != 0)				\
92		target = (type)(source + (0x8 - ((uint32_t)source & 0x7)));\
93	else								\
94		target = (type)source;
95
96#define	CTL_SIZE_8B(target, size)					\
97	if ((size & 0x7) != 0)						\
98		target = size + (0x8 - (size & 0x7));			\
99	else								\
100		target = size;
101
102#define CTL_ALIGN_8B_MARGIN	16
103
104/*
105 * Template mode pages.
106 */
107
108/*
109 * Note that these are default values only.  The actual values will be
110 * filled in when the user does a mode sense.
111 */
112static struct copan_power_subpage power_page_default = {
113	/*page_code*/ PWR_PAGE_CODE | SMPH_SPF,
114	/*subpage*/ PWR_SUBPAGE_CODE,
115	/*page_length*/ {(sizeof(struct copan_power_subpage) - 4) & 0xff00,
116			 (sizeof(struct copan_power_subpage) - 4) & 0x00ff},
117	/*page_version*/ PWR_VERSION,
118	/* total_luns */ 26,
119	/* max_active_luns*/ PWR_DFLT_MAX_LUNS,
120	/*reserved*/ {0, 0, 0, 0, 0, 0, 0, 0, 0,
121		      0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
122		      0, 0, 0, 0, 0, 0}
123};
124
125static struct copan_power_subpage power_page_changeable = {
126	/*page_code*/ PWR_PAGE_CODE | SMPH_SPF,
127	/*subpage*/ PWR_SUBPAGE_CODE,
128	/*page_length*/ {(sizeof(struct copan_power_subpage) - 4) & 0xff00,
129			 (sizeof(struct copan_power_subpage) - 4) & 0x00ff},
130	/*page_version*/ 0,
131	/* total_luns */ 0,
132	/* max_active_luns*/ 0,
133	/*reserved*/ {0, 0, 0, 0, 0, 0, 0, 0, 0,
134		      0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
135		      0, 0, 0, 0, 0, 0}
136};
137
138static struct copan_aps_subpage aps_page_default = {
139	APS_PAGE_CODE | SMPH_SPF, //page_code
140	APS_SUBPAGE_CODE, //subpage
141	{(sizeof(struct copan_aps_subpage) - 4) & 0xff00,
142	 (sizeof(struct copan_aps_subpage) - 4) & 0x00ff}, //page_length
143	APS_VERSION, //page_version
144	0, //lock_active
145	{0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
146	0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
147	0, 0, 0, 0, 0} //reserved
148};
149
150static struct copan_aps_subpage aps_page_changeable = {
151	APS_PAGE_CODE | SMPH_SPF, //page_code
152	APS_SUBPAGE_CODE, //subpage
153	{(sizeof(struct copan_aps_subpage) - 4) & 0xff00,
154	 (sizeof(struct copan_aps_subpage) - 4) & 0x00ff}, //page_length
155	0, //page_version
156	0, //lock_active
157	{0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
158	0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
159	0, 0, 0, 0, 0} //reserved
160};
161
162static struct copan_debugconf_subpage debugconf_page_default = {
163	DBGCNF_PAGE_CODE | SMPH_SPF,	/* page_code */
164	DBGCNF_SUBPAGE_CODE,		/* subpage */
165	{(sizeof(struct copan_debugconf_subpage) - 4) >> 8,
166	 (sizeof(struct copan_debugconf_subpage) - 4) >> 0}, /* page_length */
167	DBGCNF_VERSION,			/* page_version */
168	{CTL_TIME_IO_DEFAULT_SECS>>8,
169	 CTL_TIME_IO_DEFAULT_SECS>>0},	/* ctl_time_io_secs */
170};
171
172static struct copan_debugconf_subpage debugconf_page_changeable = {
173	DBGCNF_PAGE_CODE | SMPH_SPF,	/* page_code */
174	DBGCNF_SUBPAGE_CODE,		/* subpage */
175	{(sizeof(struct copan_debugconf_subpage) - 4) >> 8,
176	 (sizeof(struct copan_debugconf_subpage) - 4) >> 0}, /* page_length */
177	0,				/* page_version */
178	{0xff,0xff},			/* ctl_time_io_secs */
179};
180
181static struct scsi_format_page format_page_default = {
182	/*page_code*/SMS_FORMAT_DEVICE_PAGE,
183	/*page_length*/sizeof(struct scsi_format_page) - 2,
184	/*tracks_per_zone*/ {0, 0},
185	/*alt_sectors_per_zone*/ {0, 0},
186	/*alt_tracks_per_zone*/ {0, 0},
187	/*alt_tracks_per_lun*/ {0, 0},
188	/*sectors_per_track*/ {(CTL_DEFAULT_SECTORS_PER_TRACK >> 8) & 0xff,
189			        CTL_DEFAULT_SECTORS_PER_TRACK & 0xff},
190	/*bytes_per_sector*/ {0, 0},
191	/*interleave*/ {0, 0},
192	/*track_skew*/ {0, 0},
193	/*cylinder_skew*/ {0, 0},
194	/*flags*/ SFP_HSEC,
195	/*reserved*/ {0, 0, 0}
196};
197
198static struct scsi_format_page format_page_changeable = {
199	/*page_code*/SMS_FORMAT_DEVICE_PAGE,
200	/*page_length*/sizeof(struct scsi_format_page) - 2,
201	/*tracks_per_zone*/ {0, 0},
202	/*alt_sectors_per_zone*/ {0, 0},
203	/*alt_tracks_per_zone*/ {0, 0},
204	/*alt_tracks_per_lun*/ {0, 0},
205	/*sectors_per_track*/ {0, 0},
206	/*bytes_per_sector*/ {0, 0},
207	/*interleave*/ {0, 0},
208	/*track_skew*/ {0, 0},
209	/*cylinder_skew*/ {0, 0},
210	/*flags*/ 0,
211	/*reserved*/ {0, 0, 0}
212};
213
214static struct scsi_rigid_disk_page rigid_disk_page_default = {
215	/*page_code*/SMS_RIGID_DISK_PAGE,
216	/*page_length*/sizeof(struct scsi_rigid_disk_page) - 2,
217	/*cylinders*/ {0, 0, 0},
218	/*heads*/ CTL_DEFAULT_HEADS,
219	/*start_write_precomp*/ {0, 0, 0},
220	/*start_reduced_current*/ {0, 0, 0},
221	/*step_rate*/ {0, 0},
222	/*landing_zone_cylinder*/ {0, 0, 0},
223	/*rpl*/ SRDP_RPL_DISABLED,
224	/*rotational_offset*/ 0,
225	/*reserved1*/ 0,
226	/*rotation_rate*/ {(CTL_DEFAULT_ROTATION_RATE >> 8) & 0xff,
227			   CTL_DEFAULT_ROTATION_RATE & 0xff},
228	/*reserved2*/ {0, 0}
229};
230
231static struct scsi_rigid_disk_page rigid_disk_page_changeable = {
232	/*page_code*/SMS_RIGID_DISK_PAGE,
233	/*page_length*/sizeof(struct scsi_rigid_disk_page) - 2,
234	/*cylinders*/ {0, 0, 0},
235	/*heads*/ 0,
236	/*start_write_precomp*/ {0, 0, 0},
237	/*start_reduced_current*/ {0, 0, 0},
238	/*step_rate*/ {0, 0},
239	/*landing_zone_cylinder*/ {0, 0, 0},
240	/*rpl*/ 0,
241	/*rotational_offset*/ 0,
242	/*reserved1*/ 0,
243	/*rotation_rate*/ {0, 0},
244	/*reserved2*/ {0, 0}
245};
246
247static struct scsi_caching_page caching_page_default = {
248	/*page_code*/SMS_CACHING_PAGE,
249	/*page_length*/sizeof(struct scsi_caching_page) - 2,
250	/*flags1*/ SCP_DISC | SCP_WCE,
251	/*ret_priority*/ 0,
252	/*disable_pf_transfer_len*/ {0xff, 0xff},
253	/*min_prefetch*/ {0, 0},
254	/*max_prefetch*/ {0xff, 0xff},
255	/*max_pf_ceiling*/ {0xff, 0xff},
256	/*flags2*/ 0,
257	/*cache_segments*/ 0,
258	/*cache_seg_size*/ {0, 0},
259	/*reserved*/ 0,
260	/*non_cache_seg_size*/ {0, 0, 0}
261};
262
263static struct scsi_caching_page caching_page_changeable = {
264	/*page_code*/SMS_CACHING_PAGE,
265	/*page_length*/sizeof(struct scsi_caching_page) - 2,
266	/*flags1*/ SCP_WCE | SCP_RCD,
267	/*ret_priority*/ 0,
268	/*disable_pf_transfer_len*/ {0, 0},
269	/*min_prefetch*/ {0, 0},
270	/*max_prefetch*/ {0, 0},
271	/*max_pf_ceiling*/ {0, 0},
272	/*flags2*/ 0,
273	/*cache_segments*/ 0,
274	/*cache_seg_size*/ {0, 0},
275	/*reserved*/ 0,
276	/*non_cache_seg_size*/ {0, 0, 0}
277};
278
279static struct scsi_control_page control_page_default = {
280	/*page_code*/SMS_CONTROL_MODE_PAGE,
281	/*page_length*/sizeof(struct scsi_control_page) - 2,
282	/*rlec*/0,
283	/*queue_flags*/0,
284	/*eca_and_aen*/0,
285	/*flags4*/SCP_TAS,
286	/*aen_holdoff_period*/{0, 0},
287	/*busy_timeout_period*/{0, 0},
288	/*extended_selftest_completion_time*/{0, 0}
289};
290
291static struct scsi_control_page control_page_changeable = {
292	/*page_code*/SMS_CONTROL_MODE_PAGE,
293	/*page_length*/sizeof(struct scsi_control_page) - 2,
294	/*rlec*/SCP_DSENSE,
295	/*queue_flags*/0,
296	/*eca_and_aen*/0,
297	/*flags4*/0,
298	/*aen_holdoff_period*/{0, 0},
299	/*busy_timeout_period*/{0, 0},
300	/*extended_selftest_completion_time*/{0, 0}
301};
302
303
304/*
305 * XXX KDM move these into the softc.
306 */
307static int rcv_sync_msg;
308static int persis_offset;
309static uint8_t ctl_pause_rtr;
310static int     ctl_is_single = 1;
311static int     index_to_aps_page;
312
313SYSCTL_NODE(_kern_cam, OID_AUTO, ctl, CTLFLAG_RD, 0, "CAM Target Layer");
314static int worker_threads = -1;
315SYSCTL_INT(_kern_cam_ctl, OID_AUTO, worker_threads, CTLFLAG_RDTUN,
316    &worker_threads, 1, "Number of worker threads");
317static int verbose = 0;
318SYSCTL_INT(_kern_cam_ctl, OID_AUTO, verbose, CTLFLAG_RWTUN,
319    &verbose, 0, "Show SCSI errors returned to initiator");
320
321/*
322 * Supported pages (0x00), Serial number (0x80), Device ID (0x83),
323 * Mode Page Policy (0x87),
324 * SCSI Ports (0x88), Third-party Copy (0x8F), Block limits (0xB0),
325 * Block Device Characteristics (0xB1) and Logical Block Provisioning (0xB2)
326 */
327#define SCSI_EVPD_NUM_SUPPORTED_PAGES	9
328
329static void ctl_isc_event_handler(ctl_ha_channel chanel, ctl_ha_event event,
330				  int param);
331static void ctl_copy_sense_data(union ctl_ha_msg *src, union ctl_io *dest);
332static int ctl_init(void);
333void ctl_shutdown(void);
334static int ctl_open(struct cdev *dev, int flags, int fmt, struct thread *td);
335static int ctl_close(struct cdev *dev, int flags, int fmt, struct thread *td);
336static void ctl_ioctl_online(void *arg);
337static void ctl_ioctl_offline(void *arg);
338static int ctl_ioctl_lun_enable(void *arg, struct ctl_id targ_id, int lun_id);
339static int ctl_ioctl_lun_disable(void *arg, struct ctl_id targ_id, int lun_id);
340static int ctl_ioctl_do_datamove(struct ctl_scsiio *ctsio);
341static int ctl_serialize_other_sc_cmd(struct ctl_scsiio *ctsio);
342static int ctl_ioctl_submit_wait(union ctl_io *io);
343static void ctl_ioctl_datamove(union ctl_io *io);
344static void ctl_ioctl_done(union ctl_io *io);
345static void ctl_ioctl_hard_startstop_callback(void *arg,
346					      struct cfi_metatask *metatask);
347static void ctl_ioctl_bbrread_callback(void *arg,struct cfi_metatask *metatask);
348static int ctl_ioctl_fill_ooa(struct ctl_lun *lun, uint32_t *cur_fill_num,
349			      struct ctl_ooa *ooa_hdr,
350			      struct ctl_ooa_entry *kern_entries);
351static int ctl_ioctl(struct cdev *dev, u_long cmd, caddr_t addr, int flag,
352		     struct thread *td);
353static uint32_t ctl_map_lun(int port_num, uint32_t lun);
354static uint32_t ctl_map_lun_back(int port_num, uint32_t lun);
355#ifdef unused
356static union ctl_io *ctl_malloc_io(ctl_io_type io_type, uint32_t targ_port,
357				   uint32_t targ_target, uint32_t targ_lun,
358				   int can_wait);
359static void ctl_kfree_io(union ctl_io *io);
360#endif /* unused */
361static int ctl_alloc_lun(struct ctl_softc *ctl_softc, struct ctl_lun *lun,
362			 struct ctl_be_lun *be_lun, struct ctl_id target_id);
363static int ctl_free_lun(struct ctl_lun *lun);
364static void ctl_create_lun(struct ctl_be_lun *be_lun);
365/**
366static void ctl_failover_change_pages(struct ctl_softc *softc,
367				      struct ctl_scsiio *ctsio, int master);
368**/
369
370static int ctl_do_mode_select(union ctl_io *io);
371static int ctl_pro_preempt(struct ctl_softc *softc, struct ctl_lun *lun,
372			   uint64_t res_key, uint64_t sa_res_key,
373			   uint8_t type, uint32_t residx,
374			   struct ctl_scsiio *ctsio,
375			   struct scsi_per_res_out *cdb,
376			   struct scsi_per_res_out_parms* param);
377static void ctl_pro_preempt_other(struct ctl_lun *lun,
378				  union ctl_ha_msg *msg);
379static void ctl_hndl_per_res_out_on_other_sc(union ctl_ha_msg *msg);
380static int ctl_inquiry_evpd_supported(struct ctl_scsiio *ctsio, int alloc_len);
381static int ctl_inquiry_evpd_serial(struct ctl_scsiio *ctsio, int alloc_len);
382static int ctl_inquiry_evpd_devid(struct ctl_scsiio *ctsio, int alloc_len);
383static int ctl_inquiry_evpd_mpp(struct ctl_scsiio *ctsio, int alloc_len);
384static int ctl_inquiry_evpd_scsi_ports(struct ctl_scsiio *ctsio,
385					 int alloc_len);
386static int ctl_inquiry_evpd_block_limits(struct ctl_scsiio *ctsio,
387					 int alloc_len);
388static int ctl_inquiry_evpd_bdc(struct ctl_scsiio *ctsio, int alloc_len);
389static int ctl_inquiry_evpd_lbp(struct ctl_scsiio *ctsio, int alloc_len);
390static int ctl_inquiry_evpd(struct ctl_scsiio *ctsio);
391static int ctl_inquiry_std(struct ctl_scsiio *ctsio);
392static int ctl_get_lba_len(union ctl_io *io, uint64_t *lba, uint32_t *len);
393static ctl_action ctl_extent_check(union ctl_io *io1, union ctl_io *io2);
394static ctl_action ctl_check_for_blockage(union ctl_io *pending_io,
395					 union ctl_io *ooa_io);
396static ctl_action ctl_check_ooa(struct ctl_lun *lun, union ctl_io *pending_io,
397				union ctl_io *starting_io);
398static int ctl_check_blocked(struct ctl_lun *lun);
399static int ctl_scsiio_lun_check(struct ctl_softc *ctl_softc,
400				struct ctl_lun *lun,
401				const struct ctl_cmd_entry *entry,
402				struct ctl_scsiio *ctsio);
403//static int ctl_check_rtr(union ctl_io *pending_io, struct ctl_softc *softc);
404static void ctl_failover(void);
405static int ctl_scsiio_precheck(struct ctl_softc *ctl_softc,
406			       struct ctl_scsiio *ctsio);
407static int ctl_scsiio(struct ctl_scsiio *ctsio);
408
409static int ctl_bus_reset(struct ctl_softc *ctl_softc, union ctl_io *io);
410static int ctl_target_reset(struct ctl_softc *ctl_softc, union ctl_io *io,
411			    ctl_ua_type ua_type);
412static int ctl_lun_reset(struct ctl_lun *lun, union ctl_io *io,
413			 ctl_ua_type ua_type);
414static int ctl_abort_task(union ctl_io *io);
415static int ctl_abort_task_set(union ctl_io *io);
416static int ctl_i_t_nexus_reset(union ctl_io *io);
417static void ctl_run_task(union ctl_io *io);
418#ifdef CTL_IO_DELAY
419static void ctl_datamove_timer_wakeup(void *arg);
420static void ctl_done_timer_wakeup(void *arg);
421#endif /* CTL_IO_DELAY */
422
423static void ctl_send_datamove_done(union ctl_io *io, int have_lock);
424static void ctl_datamove_remote_write_cb(struct ctl_ha_dt_req *rq);
425static int ctl_datamove_remote_dm_write_cb(union ctl_io *io);
426static void ctl_datamove_remote_write(union ctl_io *io);
427static int ctl_datamove_remote_dm_read_cb(union ctl_io *io);
428static void ctl_datamove_remote_read_cb(struct ctl_ha_dt_req *rq);
429static int ctl_datamove_remote_sgl_setup(union ctl_io *io);
430static int ctl_datamove_remote_xfer(union ctl_io *io, unsigned command,
431				    ctl_ha_dt_cb callback);
432static void ctl_datamove_remote_read(union ctl_io *io);
433static void ctl_datamove_remote(union ctl_io *io);
434static int ctl_process_done(union ctl_io *io);
435static void ctl_lun_thread(void *arg);
436static void ctl_work_thread(void *arg);
437static void ctl_enqueue_incoming(union ctl_io *io);
438static void ctl_enqueue_rtr(union ctl_io *io);
439static void ctl_enqueue_done(union ctl_io *io);
440static void ctl_enqueue_isc(union ctl_io *io);
441static const struct ctl_cmd_entry *
442    ctl_get_cmd_entry(struct ctl_scsiio *ctsio);
443static const struct ctl_cmd_entry *
444    ctl_validate_command(struct ctl_scsiio *ctsio);
445static int ctl_cmd_applicable(uint8_t lun_type,
446    const struct ctl_cmd_entry *entry);
447
448/*
449 * Load the serialization table.  This isn't very pretty, but is probably
450 * the easiest way to do it.
451 */
452#include "ctl_ser_table.c"
453
454/*
455 * We only need to define open, close and ioctl routines for this driver.
456 */
457static struct cdevsw ctl_cdevsw = {
458	.d_version =	D_VERSION,
459	.d_flags =	0,
460	.d_open =	ctl_open,
461	.d_close =	ctl_close,
462	.d_ioctl =	ctl_ioctl,
463	.d_name =	"ctl",
464};
465
466
467MALLOC_DEFINE(M_CTL, "ctlmem", "Memory used for CTL");
468MALLOC_DEFINE(M_CTLIO, "ctlio", "Memory used for CTL requests");
469
470static int ctl_module_event_handler(module_t, int /*modeventtype_t*/, void *);
471
472static moduledata_t ctl_moduledata = {
473	"ctl",
474	ctl_module_event_handler,
475	NULL
476};
477
478DECLARE_MODULE(ctl, ctl_moduledata, SI_SUB_CONFIGURE, SI_ORDER_THIRD);
479MODULE_VERSION(ctl, 1);
480
481static struct ctl_frontend ioctl_frontend =
482{
483	.name = "ioctl",
484};
485
486static void
487ctl_isc_handler_finish_xfer(struct ctl_softc *ctl_softc,
488			    union ctl_ha_msg *msg_info)
489{
490	struct ctl_scsiio *ctsio;
491
492	if (msg_info->hdr.original_sc == NULL) {
493		printf("%s: original_sc == NULL!\n", __func__);
494		/* XXX KDM now what? */
495		return;
496	}
497
498	ctsio = &msg_info->hdr.original_sc->scsiio;
499	ctsio->io_hdr.flags |= CTL_FLAG_IO_ACTIVE;
500	ctsio->io_hdr.msg_type = CTL_MSG_FINISH_IO;
501	ctsio->io_hdr.status = msg_info->hdr.status;
502	ctsio->scsi_status = msg_info->scsi.scsi_status;
503	ctsio->sense_len = msg_info->scsi.sense_len;
504	ctsio->sense_residual = msg_info->scsi.sense_residual;
505	ctsio->residual = msg_info->scsi.residual;
506	memcpy(&ctsio->sense_data, &msg_info->scsi.sense_data,
507	       sizeof(ctsio->sense_data));
508	memcpy(&ctsio->io_hdr.ctl_private[CTL_PRIV_LBA_LEN].bytes,
509	       &msg_info->scsi.lbalen, sizeof(msg_info->scsi.lbalen));
510	ctl_enqueue_isc((union ctl_io *)ctsio);
511}
512
513static void
514ctl_isc_handler_finish_ser_only(struct ctl_softc *ctl_softc,
515				union ctl_ha_msg *msg_info)
516{
517	struct ctl_scsiio *ctsio;
518
519	if (msg_info->hdr.serializing_sc == NULL) {
520		printf("%s: serializing_sc == NULL!\n", __func__);
521		/* XXX KDM now what? */
522		return;
523	}
524
525	ctsio = &msg_info->hdr.serializing_sc->scsiio;
526#if 0
527	/*
528	 * Attempt to catch the situation where an I/O has
529	 * been freed, and we're using it again.
530	 */
531	if (ctsio->io_hdr.io_type == 0xff) {
532		union ctl_io *tmp_io;
533		tmp_io = (union ctl_io *)ctsio;
534		printf("%s: %p use after free!\n", __func__,
535		       ctsio);
536		printf("%s: type %d msg %d cdb %x iptl: "
537		       "%d:%d:%d:%d tag 0x%04x "
538		       "flag %#x status %x\n",
539			__func__,
540			tmp_io->io_hdr.io_type,
541			tmp_io->io_hdr.msg_type,
542			tmp_io->scsiio.cdb[0],
543			tmp_io->io_hdr.nexus.initid.id,
544			tmp_io->io_hdr.nexus.targ_port,
545			tmp_io->io_hdr.nexus.targ_target.id,
546			tmp_io->io_hdr.nexus.targ_lun,
547			(tmp_io->io_hdr.io_type ==
548			CTL_IO_TASK) ?
549			tmp_io->taskio.tag_num :
550			tmp_io->scsiio.tag_num,
551		        tmp_io->io_hdr.flags,
552			tmp_io->io_hdr.status);
553	}
554#endif
555	ctsio->io_hdr.msg_type = CTL_MSG_FINISH_IO;
556	ctl_enqueue_isc((union ctl_io *)ctsio);
557}
558
559/*
560 * ISC (Inter Shelf Communication) event handler.  Events from the HA
561 * subsystem come in here.
562 */
563static void
564ctl_isc_event_handler(ctl_ha_channel channel, ctl_ha_event event, int param)
565{
566	struct ctl_softc *ctl_softc;
567	union ctl_io *io;
568	struct ctl_prio *presio;
569	ctl_ha_status isc_status;
570
571	ctl_softc = control_softc;
572	io = NULL;
573
574
575#if 0
576	printf("CTL: Isc Msg event %d\n", event);
577#endif
578	if (event == CTL_HA_EVT_MSG_RECV) {
579		union ctl_ha_msg msg_info;
580
581		isc_status = ctl_ha_msg_recv(CTL_HA_CHAN_CTL, &msg_info,
582					     sizeof(msg_info), /*wait*/ 0);
583#if 0
584		printf("CTL: msg_type %d\n", msg_info.msg_type);
585#endif
586		if (isc_status != 0) {
587			printf("Error receiving message, status = %d\n",
588			       isc_status);
589			return;
590		}
591
592		switch (msg_info.hdr.msg_type) {
593		case CTL_MSG_SERIALIZE:
594#if 0
595			printf("Serialize\n");
596#endif
597			io = ctl_alloc_io((void *)ctl_softc->othersc_pool);
598			if (io == NULL) {
599				printf("ctl_isc_event_handler: can't allocate "
600				       "ctl_io!\n");
601				/* Bad Juju */
602				/* Need to set busy and send msg back */
603				msg_info.hdr.msg_type = CTL_MSG_BAD_JUJU;
604				msg_info.hdr.status = CTL_SCSI_ERROR;
605				msg_info.scsi.scsi_status = SCSI_STATUS_BUSY;
606				msg_info.scsi.sense_len = 0;
607			        if (ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg_info,
608				    sizeof(msg_info), 0) > CTL_HA_STATUS_SUCCESS){
609				}
610				goto bailout;
611			}
612			ctl_zero_io(io);
613			// populate ctsio from msg_info
614			io->io_hdr.io_type = CTL_IO_SCSI;
615			io->io_hdr.msg_type = CTL_MSG_SERIALIZE;
616			io->io_hdr.original_sc = msg_info.hdr.original_sc;
617#if 0
618			printf("pOrig %x\n", (int)msg_info.original_sc);
619#endif
620			io->io_hdr.flags |= CTL_FLAG_FROM_OTHER_SC |
621					    CTL_FLAG_IO_ACTIVE;
622			/*
623			 * If we're in serialization-only mode, we don't
624			 * want to go through full done processing.  Thus
625			 * the COPY flag.
626			 *
627			 * XXX KDM add another flag that is more specific.
628			 */
629			if (ctl_softc->ha_mode == CTL_HA_MODE_SER_ONLY)
630				io->io_hdr.flags |= CTL_FLAG_INT_COPY;
631			io->io_hdr.nexus = msg_info.hdr.nexus;
632#if 0
633			printf("targ %d, port %d, iid %d, lun %d\n",
634			       io->io_hdr.nexus.targ_target.id,
635			       io->io_hdr.nexus.targ_port,
636			       io->io_hdr.nexus.initid.id,
637			       io->io_hdr.nexus.targ_lun);
638#endif
639			io->scsiio.tag_num = msg_info.scsi.tag_num;
640			io->scsiio.tag_type = msg_info.scsi.tag_type;
641			memcpy(io->scsiio.cdb, msg_info.scsi.cdb,
642			       CTL_MAX_CDBLEN);
643			if (ctl_softc->ha_mode == CTL_HA_MODE_XFER) {
644				const struct ctl_cmd_entry *entry;
645
646				entry = ctl_get_cmd_entry(&io->scsiio);
647				io->io_hdr.flags &= ~CTL_FLAG_DATA_MASK;
648				io->io_hdr.flags |=
649					entry->flags & CTL_FLAG_DATA_MASK;
650			}
651			ctl_enqueue_isc(io);
652			break;
653
654		/* Performed on the Originating SC, XFER mode only */
655		case CTL_MSG_DATAMOVE: {
656			struct ctl_sg_entry *sgl;
657			int i, j;
658
659			io = msg_info.hdr.original_sc;
660			if (io == NULL) {
661				printf("%s: original_sc == NULL!\n", __func__);
662				/* XXX KDM do something here */
663				break;
664			}
665			io->io_hdr.msg_type = CTL_MSG_DATAMOVE;
666			io->io_hdr.flags |= CTL_FLAG_IO_ACTIVE;
667			/*
668			 * Keep track of this, we need to send it back over
669			 * when the datamove is complete.
670			 */
671			io->io_hdr.serializing_sc = msg_info.hdr.serializing_sc;
672
673			if (msg_info.dt.sg_sequence == 0) {
674				/*
675				 * XXX KDM we use the preallocated S/G list
676				 * here, but we'll need to change this to
677				 * dynamic allocation if we need larger S/G
678				 * lists.
679				 */
680				if (msg_info.dt.kern_sg_entries >
681				    sizeof(io->io_hdr.remote_sglist) /
682				    sizeof(io->io_hdr.remote_sglist[0])) {
683					printf("%s: number of S/G entries "
684					    "needed %u > allocated num %zd\n",
685					    __func__,
686					    msg_info.dt.kern_sg_entries,
687					    sizeof(io->io_hdr.remote_sglist)/
688					    sizeof(io->io_hdr.remote_sglist[0]));
689
690					/*
691					 * XXX KDM send a message back to
692					 * the other side to shut down the
693					 * DMA.  The error will come back
694					 * through via the normal channel.
695					 */
696					break;
697				}
698				sgl = io->io_hdr.remote_sglist;
699				memset(sgl, 0,
700				       sizeof(io->io_hdr.remote_sglist));
701
702				io->scsiio.kern_data_ptr = (uint8_t *)sgl;
703
704				io->scsiio.kern_sg_entries =
705					msg_info.dt.kern_sg_entries;
706				io->scsiio.rem_sg_entries =
707					msg_info.dt.kern_sg_entries;
708				io->scsiio.kern_data_len =
709					msg_info.dt.kern_data_len;
710				io->scsiio.kern_total_len =
711					msg_info.dt.kern_total_len;
712				io->scsiio.kern_data_resid =
713					msg_info.dt.kern_data_resid;
714				io->scsiio.kern_rel_offset =
715					msg_info.dt.kern_rel_offset;
716				/*
717				 * Clear out per-DMA flags.
718				 */
719				io->io_hdr.flags &= ~CTL_FLAG_RDMA_MASK;
720				/*
721				 * Add per-DMA flags that are set for this
722				 * particular DMA request.
723				 */
724				io->io_hdr.flags |= msg_info.dt.flags &
725						    CTL_FLAG_RDMA_MASK;
726			} else
727				sgl = (struct ctl_sg_entry *)
728					io->scsiio.kern_data_ptr;
729
730			for (i = msg_info.dt.sent_sg_entries, j = 0;
731			     i < (msg_info.dt.sent_sg_entries +
732			     msg_info.dt.cur_sg_entries); i++, j++) {
733				sgl[i].addr = msg_info.dt.sg_list[j].addr;
734				sgl[i].len = msg_info.dt.sg_list[j].len;
735
736#if 0
737				printf("%s: L: %p,%d -> %p,%d j=%d, i=%d\n",
738				       __func__,
739				       msg_info.dt.sg_list[j].addr,
740				       msg_info.dt.sg_list[j].len,
741				       sgl[i].addr, sgl[i].len, j, i);
742#endif
743			}
744#if 0
745			memcpy(&sgl[msg_info.dt.sent_sg_entries],
746			       msg_info.dt.sg_list,
747			       sizeof(*sgl) * msg_info.dt.cur_sg_entries);
748#endif
749
750			/*
751			 * If this is the last piece of the I/O, we've got
752			 * the full S/G list.  Queue processing in the thread.
753			 * Otherwise wait for the next piece.
754			 */
755			if (msg_info.dt.sg_last != 0)
756				ctl_enqueue_isc(io);
757			break;
758		}
759		/* Performed on the Serializing (primary) SC, XFER mode only */
760		case CTL_MSG_DATAMOVE_DONE: {
761			if (msg_info.hdr.serializing_sc == NULL) {
762				printf("%s: serializing_sc == NULL!\n",
763				       __func__);
764				/* XXX KDM now what? */
765				break;
766			}
767			/*
768			 * We grab the sense information here in case
769			 * there was a failure, so we can return status
770			 * back to the initiator.
771			 */
772			io = msg_info.hdr.serializing_sc;
773			io->io_hdr.msg_type = CTL_MSG_DATAMOVE_DONE;
774			io->io_hdr.status = msg_info.hdr.status;
775			io->scsiio.scsi_status = msg_info.scsi.scsi_status;
776			io->scsiio.sense_len = msg_info.scsi.sense_len;
777			io->scsiio.sense_residual =msg_info.scsi.sense_residual;
778			io->io_hdr.port_status = msg_info.scsi.fetd_status;
779			io->scsiio.residual = msg_info.scsi.residual;
780			memcpy(&io->scsiio.sense_data,&msg_info.scsi.sense_data,
781			       sizeof(io->scsiio.sense_data));
782			ctl_enqueue_isc(io);
783			break;
784		}
785
786		/* Preformed on Originating SC, SER_ONLY mode */
787		case CTL_MSG_R2R:
788			io = msg_info.hdr.original_sc;
789			if (io == NULL) {
790				printf("%s: Major Bummer\n", __func__);
791				return;
792			} else {
793#if 0
794				printf("pOrig %x\n",(int) ctsio);
795#endif
796			}
797			io->io_hdr.msg_type = CTL_MSG_R2R;
798			io->io_hdr.serializing_sc = msg_info.hdr.serializing_sc;
799			ctl_enqueue_isc(io);
800			break;
801
802		/*
803		 * Performed on Serializing(i.e. primary SC) SC in SER_ONLY
804		 * mode.
805		 * Performed on the Originating (i.e. secondary) SC in XFER
806		 * mode
807		 */
808		case CTL_MSG_FINISH_IO:
809			if (ctl_softc->ha_mode == CTL_HA_MODE_XFER)
810				ctl_isc_handler_finish_xfer(ctl_softc,
811							    &msg_info);
812			else
813				ctl_isc_handler_finish_ser_only(ctl_softc,
814								&msg_info);
815			break;
816
817		/* Preformed on Originating SC */
818		case CTL_MSG_BAD_JUJU:
819			io = msg_info.hdr.original_sc;
820			if (io == NULL) {
821				printf("%s: Bad JUJU!, original_sc is NULL!\n",
822				       __func__);
823				break;
824			}
825			ctl_copy_sense_data(&msg_info, io);
826			/*
827			 * IO should have already been cleaned up on other
828			 * SC so clear this flag so we won't send a message
829			 * back to finish the IO there.
830			 */
831			io->io_hdr.flags &= ~CTL_FLAG_SENT_2OTHER_SC;
832			io->io_hdr.flags |= CTL_FLAG_IO_ACTIVE;
833
834			/* io = msg_info.hdr.serializing_sc; */
835			io->io_hdr.msg_type = CTL_MSG_BAD_JUJU;
836			ctl_enqueue_isc(io);
837			break;
838
839		/* Handle resets sent from the other side */
840		case CTL_MSG_MANAGE_TASKS: {
841			struct ctl_taskio *taskio;
842			taskio = (struct ctl_taskio *)ctl_alloc_io(
843				(void *)ctl_softc->othersc_pool);
844			if (taskio == NULL) {
845				printf("ctl_isc_event_handler: can't allocate "
846				       "ctl_io!\n");
847				/* Bad Juju */
848				/* should I just call the proper reset func
849				   here??? */
850				goto bailout;
851			}
852			ctl_zero_io((union ctl_io *)taskio);
853			taskio->io_hdr.io_type = CTL_IO_TASK;
854			taskio->io_hdr.flags |= CTL_FLAG_FROM_OTHER_SC;
855			taskio->io_hdr.nexus = msg_info.hdr.nexus;
856			taskio->task_action = msg_info.task.task_action;
857			taskio->tag_num = msg_info.task.tag_num;
858			taskio->tag_type = msg_info.task.tag_type;
859#ifdef CTL_TIME_IO
860			taskio->io_hdr.start_time = time_uptime;
861			getbintime(&taskio->io_hdr.start_bt);
862#if 0
863			cs_prof_gettime(&taskio->io_hdr.start_ticks);
864#endif
865#endif /* CTL_TIME_IO */
866			ctl_run_task((union ctl_io *)taskio);
867			break;
868		}
869		/* Persistent Reserve action which needs attention */
870		case CTL_MSG_PERS_ACTION:
871			presio = (struct ctl_prio *)ctl_alloc_io(
872				(void *)ctl_softc->othersc_pool);
873			if (presio == NULL) {
874				printf("ctl_isc_event_handler: can't allocate "
875				       "ctl_io!\n");
876				/* Bad Juju */
877				/* Need to set busy and send msg back */
878				goto bailout;
879			}
880			ctl_zero_io((union ctl_io *)presio);
881			presio->io_hdr.msg_type = CTL_MSG_PERS_ACTION;
882			presio->pr_msg = msg_info.pr;
883			ctl_enqueue_isc((union ctl_io *)presio);
884			break;
885		case CTL_MSG_SYNC_FE:
886			rcv_sync_msg = 1;
887			break;
888		case CTL_MSG_APS_LOCK: {
889			// It's quicker to execute this then to
890			// queue it.
891			struct ctl_lun *lun;
892			struct ctl_page_index *page_index;
893			struct copan_aps_subpage *current_sp;
894			uint32_t targ_lun;
895
896			targ_lun = msg_info.hdr.nexus.targ_mapped_lun;
897			lun = ctl_softc->ctl_luns[targ_lun];
898			mtx_lock(&lun->lun_lock);
899			page_index = &lun->mode_pages.index[index_to_aps_page];
900			current_sp = (struct copan_aps_subpage *)
901				     (page_index->page_data +
902				     (page_index->page_len * CTL_PAGE_CURRENT));
903
904			current_sp->lock_active = msg_info.aps.lock_flag;
905			mtx_unlock(&lun->lun_lock);
906		        break;
907		}
908		default:
909		        printf("How did I get here?\n");
910		}
911	} else if (event == CTL_HA_EVT_MSG_SENT) {
912		if (param != CTL_HA_STATUS_SUCCESS) {
913			printf("Bad status from ctl_ha_msg_send status %d\n",
914			       param);
915		}
916		return;
917	} else if (event == CTL_HA_EVT_DISCONNECT) {
918		printf("CTL: Got a disconnect from Isc\n");
919		return;
920	} else {
921		printf("ctl_isc_event_handler: Unknown event %d\n", event);
922		return;
923	}
924
925bailout:
926	return;
927}
928
929static void
930ctl_copy_sense_data(union ctl_ha_msg *src, union ctl_io *dest)
931{
932	struct scsi_sense_data *sense;
933
934	sense = &dest->scsiio.sense_data;
935	bcopy(&src->scsi.sense_data, sense, sizeof(*sense));
936	dest->scsiio.scsi_status = src->scsi.scsi_status;
937	dest->scsiio.sense_len = src->scsi.sense_len;
938	dest->io_hdr.status = src->hdr.status;
939}
940
941static int
942ctl_init(void)
943{
944	struct ctl_softc *softc;
945	struct ctl_io_pool *internal_pool, *emergency_pool, *other_pool;
946	struct ctl_port *port;
947        uint8_t sc_id =0;
948	int i, error, retval;
949	//int isc_retval;
950
951	retval = 0;
952	ctl_pause_rtr = 0;
953        rcv_sync_msg = 0;
954
955	control_softc = malloc(sizeof(*control_softc), M_DEVBUF,
956			       M_WAITOK | M_ZERO);
957	softc = control_softc;
958
959	softc->dev = make_dev(&ctl_cdevsw, 0, UID_ROOT, GID_OPERATOR, 0600,
960			      "cam/ctl");
961
962	softc->dev->si_drv1 = softc;
963
964	/*
965	 * By default, return a "bad LUN" peripheral qualifier for unknown
966	 * LUNs.  The user can override this default using the tunable or
967	 * sysctl.  See the comment in ctl_inquiry_std() for more details.
968	 */
969	softc->inquiry_pq_no_lun = 1;
970	TUNABLE_INT_FETCH("kern.cam.ctl.inquiry_pq_no_lun",
971			  &softc->inquiry_pq_no_lun);
972	sysctl_ctx_init(&softc->sysctl_ctx);
973	softc->sysctl_tree = SYSCTL_ADD_NODE(&softc->sysctl_ctx,
974		SYSCTL_STATIC_CHILDREN(_kern_cam), OID_AUTO, "ctl",
975		CTLFLAG_RD, 0, "CAM Target Layer");
976
977	if (softc->sysctl_tree == NULL) {
978		printf("%s: unable to allocate sysctl tree\n", __func__);
979		destroy_dev(softc->dev);
980		free(control_softc, M_DEVBUF);
981		control_softc = NULL;
982		return (ENOMEM);
983	}
984
985	SYSCTL_ADD_INT(&softc->sysctl_ctx,
986		       SYSCTL_CHILDREN(softc->sysctl_tree), OID_AUTO,
987		       "inquiry_pq_no_lun", CTLFLAG_RW,
988		       &softc->inquiry_pq_no_lun, 0,
989		       "Report no lun possible for invalid LUNs");
990
991	mtx_init(&softc->ctl_lock, "CTL mutex", NULL, MTX_DEF);
992	mtx_init(&softc->pool_lock, "CTL pool mutex", NULL, MTX_DEF);
993	softc->open_count = 0;
994
995	/*
996	 * Default to actually sending a SYNCHRONIZE CACHE command down to
997	 * the drive.
998	 */
999	softc->flags = CTL_FLAG_REAL_SYNC;
1000
1001	/*
1002	 * In Copan's HA scheme, the "master" and "slave" roles are
1003	 * figured out through the slot the controller is in.  Although it
1004	 * is an active/active system, someone has to be in charge.
1005 	 */
1006#ifdef NEEDTOPORT
1007        scmicro_rw(SCMICRO_GET_SHELF_ID, &sc_id);
1008#endif
1009
1010        if (sc_id == 0) {
1011		softc->flags |= CTL_FLAG_MASTER_SHELF;
1012		persis_offset = 0;
1013	} else
1014		persis_offset = CTL_MAX_INITIATORS;
1015
1016	/*
1017	 * XXX KDM need to figure out where we want to get our target ID
1018	 * and WWID.  Is it different on each port?
1019	 */
1020	softc->target.id = 0;
1021	softc->target.wwid[0] = 0x12345678;
1022	softc->target.wwid[1] = 0x87654321;
1023	STAILQ_INIT(&softc->lun_list);
1024	STAILQ_INIT(&softc->pending_lun_queue);
1025	STAILQ_INIT(&softc->fe_list);
1026	STAILQ_INIT(&softc->port_list);
1027	STAILQ_INIT(&softc->be_list);
1028	STAILQ_INIT(&softc->io_pools);
1029	ctl_tpc_init(softc);
1030
1031	if (ctl_pool_create(softc, CTL_POOL_INTERNAL, CTL_POOL_ENTRIES_INTERNAL,
1032			    &internal_pool)!= 0){
1033		printf("ctl: can't allocate %d entry internal pool, "
1034		       "exiting\n", CTL_POOL_ENTRIES_INTERNAL);
1035		return (ENOMEM);
1036	}
1037
1038	if (ctl_pool_create(softc, CTL_POOL_EMERGENCY,
1039			    CTL_POOL_ENTRIES_EMERGENCY, &emergency_pool) != 0) {
1040		printf("ctl: can't allocate %d entry emergency pool, "
1041		       "exiting\n", CTL_POOL_ENTRIES_EMERGENCY);
1042		ctl_pool_free(internal_pool);
1043		return (ENOMEM);
1044	}
1045
1046	if (ctl_pool_create(softc, CTL_POOL_4OTHERSC, CTL_POOL_ENTRIES_OTHER_SC,
1047	                    &other_pool) != 0)
1048	{
1049		printf("ctl: can't allocate %d entry other SC pool, "
1050		       "exiting\n", CTL_POOL_ENTRIES_OTHER_SC);
1051		ctl_pool_free(internal_pool);
1052		ctl_pool_free(emergency_pool);
1053		return (ENOMEM);
1054	}
1055
1056	softc->internal_pool = internal_pool;
1057	softc->emergency_pool = emergency_pool;
1058	softc->othersc_pool = other_pool;
1059
1060	if (worker_threads <= 0)
1061		worker_threads = max(1, mp_ncpus / 4);
1062	if (worker_threads > CTL_MAX_THREADS)
1063		worker_threads = CTL_MAX_THREADS;
1064
1065	for (i = 0; i < worker_threads; i++) {
1066		struct ctl_thread *thr = &softc->threads[i];
1067
1068		mtx_init(&thr->queue_lock, "CTL queue mutex", NULL, MTX_DEF);
1069		thr->ctl_softc = softc;
1070		STAILQ_INIT(&thr->incoming_queue);
1071		STAILQ_INIT(&thr->rtr_queue);
1072		STAILQ_INIT(&thr->done_queue);
1073		STAILQ_INIT(&thr->isc_queue);
1074
1075		error = kproc_kthread_add(ctl_work_thread, thr,
1076		    &softc->ctl_proc, &thr->thread, 0, 0, "ctl", "work%d", i);
1077		if (error != 0) {
1078			printf("error creating CTL work thread!\n");
1079			ctl_pool_free(internal_pool);
1080			ctl_pool_free(emergency_pool);
1081			ctl_pool_free(other_pool);
1082			return (error);
1083		}
1084	}
1085	error = kproc_kthread_add(ctl_lun_thread, softc,
1086	    &softc->ctl_proc, NULL, 0, 0, "ctl", "lun");
1087	if (error != 0) {
1088		printf("error creating CTL lun thread!\n");
1089		ctl_pool_free(internal_pool);
1090		ctl_pool_free(emergency_pool);
1091		ctl_pool_free(other_pool);
1092		return (error);
1093	}
1094	if (bootverbose)
1095		printf("ctl: CAM Target Layer loaded\n");
1096
1097	/*
1098	 * Initialize the ioctl front end.
1099	 */
1100	ctl_frontend_register(&ioctl_frontend);
1101	port = &softc->ioctl_info.port;
1102	port->frontend = &ioctl_frontend;
1103	sprintf(softc->ioctl_info.port_name, "ioctl");
1104	port->port_type = CTL_PORT_IOCTL;
1105	port->num_requested_ctl_io = 100;
1106	port->port_name = softc->ioctl_info.port_name;
1107	port->port_online = ctl_ioctl_online;
1108	port->port_offline = ctl_ioctl_offline;
1109	port->onoff_arg = &softc->ioctl_info;
1110	port->lun_enable = ctl_ioctl_lun_enable;
1111	port->lun_disable = ctl_ioctl_lun_disable;
1112	port->targ_lun_arg = &softc->ioctl_info;
1113	port->fe_datamove = ctl_ioctl_datamove;
1114	port->fe_done = ctl_ioctl_done;
1115	port->max_targets = 15;
1116	port->max_target_id = 15;
1117
1118	if (ctl_port_register(&softc->ioctl_info.port,
1119	                  (softc->flags & CTL_FLAG_MASTER_SHELF)) != 0) {
1120		printf("ctl: ioctl front end registration failed, will "
1121		       "continue anyway\n");
1122	}
1123
1124#ifdef CTL_IO_DELAY
1125	if (sizeof(struct callout) > CTL_TIMER_BYTES) {
1126		printf("sizeof(struct callout) %zd > CTL_TIMER_BYTES %zd\n",
1127		       sizeof(struct callout), CTL_TIMER_BYTES);
1128		return (EINVAL);
1129	}
1130#endif /* CTL_IO_DELAY */
1131
1132	return (0);
1133}
1134
1135void
1136ctl_shutdown(void)
1137{
1138	struct ctl_softc *softc;
1139	struct ctl_lun *lun, *next_lun;
1140	struct ctl_io_pool *pool;
1141
1142	softc = (struct ctl_softc *)control_softc;
1143
1144	if (ctl_port_deregister(&softc->ioctl_info.port) != 0)
1145		printf("ctl: ioctl front end deregistration failed\n");
1146
1147	mtx_lock(&softc->ctl_lock);
1148
1149	/*
1150	 * Free up each LUN.
1151	 */
1152	for (lun = STAILQ_FIRST(&softc->lun_list); lun != NULL; lun = next_lun){
1153		next_lun = STAILQ_NEXT(lun, links);
1154		ctl_free_lun(lun);
1155	}
1156
1157	mtx_unlock(&softc->ctl_lock);
1158
1159	ctl_frontend_deregister(&ioctl_frontend);
1160
1161	/*
1162	 * This will rip the rug out from under any FETDs or anyone else
1163	 * that has a pool allocated.  Since we increment our module
1164	 * refcount any time someone outside the main CTL module allocates
1165	 * a pool, we shouldn't have any problems here.  The user won't be
1166	 * able to unload the CTL module until client modules have
1167	 * successfully unloaded.
1168	 */
1169	while ((pool = STAILQ_FIRST(&softc->io_pools)) != NULL)
1170		ctl_pool_free(pool);
1171
1172#if 0
1173	ctl_shutdown_thread(softc->work_thread);
1174	mtx_destroy(&softc->queue_lock);
1175#endif
1176
1177	ctl_tpc_shutdown(softc);
1178	mtx_destroy(&softc->pool_lock);
1179	mtx_destroy(&softc->ctl_lock);
1180
1181	destroy_dev(softc->dev);
1182
1183	sysctl_ctx_free(&softc->sysctl_ctx);
1184
1185	free(control_softc, M_DEVBUF);
1186	control_softc = NULL;
1187
1188	if (bootverbose)
1189		printf("ctl: CAM Target Layer unloaded\n");
1190}
1191
1192static int
1193ctl_module_event_handler(module_t mod, int what, void *arg)
1194{
1195
1196	switch (what) {
1197	case MOD_LOAD:
1198		return (ctl_init());
1199	case MOD_UNLOAD:
1200		return (EBUSY);
1201	default:
1202		return (EOPNOTSUPP);
1203	}
1204}
1205
1206/*
1207 * XXX KDM should we do some access checks here?  Bump a reference count to
1208 * prevent a CTL module from being unloaded while someone has it open?
1209 */
1210static int
1211ctl_open(struct cdev *dev, int flags, int fmt, struct thread *td)
1212{
1213	return (0);
1214}
1215
1216static int
1217ctl_close(struct cdev *dev, int flags, int fmt, struct thread *td)
1218{
1219	return (0);
1220}
1221
1222int
1223ctl_port_enable(ctl_port_type port_type)
1224{
1225	struct ctl_softc *softc;
1226	struct ctl_port *port;
1227
1228	if (ctl_is_single == 0) {
1229		union ctl_ha_msg msg_info;
1230		int isc_retval;
1231
1232#if 0
1233		printf("%s: HA mode, synchronizing frontend enable\n",
1234		        __func__);
1235#endif
1236		msg_info.hdr.msg_type = CTL_MSG_SYNC_FE;
1237	        if ((isc_retval=ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg_info,
1238		        sizeof(msg_info), 1 )) > CTL_HA_STATUS_SUCCESS) {
1239			printf("Sync msg send error retval %d\n", isc_retval);
1240		}
1241		if (!rcv_sync_msg) {
1242			isc_retval=ctl_ha_msg_recv(CTL_HA_CHAN_CTL, &msg_info,
1243			        sizeof(msg_info), 1);
1244		}
1245#if 0
1246        	printf("CTL:Frontend Enable\n");
1247	} else {
1248		printf("%s: single mode, skipping frontend synchronization\n",
1249		        __func__);
1250#endif
1251	}
1252
1253	softc = control_softc;
1254
1255	STAILQ_FOREACH(port, &softc->port_list, links) {
1256		if (port_type & port->port_type)
1257		{
1258#if 0
1259			printf("port %d\n", port->targ_port);
1260#endif
1261			ctl_port_online(port);
1262		}
1263	}
1264
1265	return (0);
1266}
1267
1268int
1269ctl_port_disable(ctl_port_type port_type)
1270{
1271	struct ctl_softc *softc;
1272	struct ctl_port *port;
1273
1274	softc = control_softc;
1275
1276	STAILQ_FOREACH(port, &softc->port_list, links) {
1277		if (port_type & port->port_type)
1278			ctl_port_offline(port);
1279	}
1280
1281	return (0);
1282}
1283
1284/*
1285 * Returns 0 for success, 1 for failure.
1286 * Currently the only failure mode is if there aren't enough entries
1287 * allocated.  So, in case of a failure, look at num_entries_dropped,
1288 * reallocate and try again.
1289 */
1290int
1291ctl_port_list(struct ctl_port_entry *entries, int num_entries_alloced,
1292	      int *num_entries_filled, int *num_entries_dropped,
1293	      ctl_port_type port_type, int no_virtual)
1294{
1295	struct ctl_softc *softc;
1296	struct ctl_port *port;
1297	int entries_dropped, entries_filled;
1298	int retval;
1299	int i;
1300
1301	softc = control_softc;
1302
1303	retval = 0;
1304	entries_filled = 0;
1305	entries_dropped = 0;
1306
1307	i = 0;
1308	mtx_lock(&softc->ctl_lock);
1309	STAILQ_FOREACH(port, &softc->port_list, links) {
1310		struct ctl_port_entry *entry;
1311
1312		if ((port->port_type & port_type) == 0)
1313			continue;
1314
1315		if ((no_virtual != 0)
1316		 && (port->virtual_port != 0))
1317			continue;
1318
1319		if (entries_filled >= num_entries_alloced) {
1320			entries_dropped++;
1321			continue;
1322		}
1323		entry = &entries[i];
1324
1325		entry->port_type = port->port_type;
1326		strlcpy(entry->port_name, port->port_name,
1327			sizeof(entry->port_name));
1328		entry->physical_port = port->physical_port;
1329		entry->virtual_port = port->virtual_port;
1330		entry->wwnn = port->wwnn;
1331		entry->wwpn = port->wwpn;
1332
1333		i++;
1334		entries_filled++;
1335	}
1336
1337	mtx_unlock(&softc->ctl_lock);
1338
1339	if (entries_dropped > 0)
1340		retval = 1;
1341
1342	*num_entries_dropped = entries_dropped;
1343	*num_entries_filled = entries_filled;
1344
1345	return (retval);
1346}
1347
1348static void
1349ctl_ioctl_online(void *arg)
1350{
1351	struct ctl_ioctl_info *ioctl_info;
1352
1353	ioctl_info = (struct ctl_ioctl_info *)arg;
1354
1355	ioctl_info->flags |= CTL_IOCTL_FLAG_ENABLED;
1356}
1357
1358static void
1359ctl_ioctl_offline(void *arg)
1360{
1361	struct ctl_ioctl_info *ioctl_info;
1362
1363	ioctl_info = (struct ctl_ioctl_info *)arg;
1364
1365	ioctl_info->flags &= ~CTL_IOCTL_FLAG_ENABLED;
1366}
1367
1368/*
1369 * Remove an initiator by port number and initiator ID.
1370 * Returns 0 for success, -1 for failure.
1371 */
1372int
1373ctl_remove_initiator(struct ctl_port *port, int iid)
1374{
1375	struct ctl_softc *softc = control_softc;
1376
1377	mtx_assert(&softc->ctl_lock, MA_NOTOWNED);
1378
1379	if (iid > CTL_MAX_INIT_PER_PORT) {
1380		printf("%s: initiator ID %u > maximun %u!\n",
1381		       __func__, iid, CTL_MAX_INIT_PER_PORT);
1382		return (-1);
1383	}
1384
1385	mtx_lock(&softc->ctl_lock);
1386	port->wwpn_iid[iid].in_use--;
1387	port->wwpn_iid[iid].last_use = time_uptime;
1388	mtx_unlock(&softc->ctl_lock);
1389
1390	return (0);
1391}
1392
1393/*
1394 * Add an initiator to the initiator map.
1395 * Returns iid for success, < 0 for failure.
1396 */
1397int
1398ctl_add_initiator(struct ctl_port *port, int iid, uint64_t wwpn, char *name)
1399{
1400	struct ctl_softc *softc = control_softc;
1401	time_t best_time;
1402	int i, best;
1403
1404	mtx_assert(&softc->ctl_lock, MA_NOTOWNED);
1405
1406	if (iid >= CTL_MAX_INIT_PER_PORT) {
1407		printf("%s: WWPN %#jx initiator ID %u > maximum %u!\n",
1408		       __func__, wwpn, iid, CTL_MAX_INIT_PER_PORT);
1409		free(name, M_CTL);
1410		return (-1);
1411	}
1412
1413	mtx_lock(&softc->ctl_lock);
1414
1415	if (iid < 0 && (wwpn != 0 || name != NULL)) {
1416		for (i = 0; i < CTL_MAX_INIT_PER_PORT; i++) {
1417			if (wwpn != 0 && wwpn == port->wwpn_iid[i].wwpn) {
1418				iid = i;
1419				break;
1420			}
1421			if (name != NULL && port->wwpn_iid[i].name != NULL &&
1422			    strcmp(name, port->wwpn_iid[i].name) == 0) {
1423				iid = i;
1424				break;
1425			}
1426		}
1427	}
1428
1429	if (iid < 0) {
1430		for (i = 0; i < CTL_MAX_INIT_PER_PORT; i++) {
1431			if (port->wwpn_iid[i].in_use == 0 &&
1432			    port->wwpn_iid[i].wwpn == 0 &&
1433			    port->wwpn_iid[i].name == NULL) {
1434				iid = i;
1435				break;
1436			}
1437		}
1438	}
1439
1440	if (iid < 0) {
1441		best = -1;
1442		best_time = INT32_MAX;
1443		for (i = 0; i < CTL_MAX_INIT_PER_PORT; i++) {
1444			if (port->wwpn_iid[i].in_use == 0) {
1445				if (port->wwpn_iid[i].last_use < best_time) {
1446					best = i;
1447					best_time = port->wwpn_iid[i].last_use;
1448				}
1449			}
1450		}
1451		iid = best;
1452	}
1453
1454	if (iid < 0) {
1455		mtx_unlock(&softc->ctl_lock);
1456		free(name, M_CTL);
1457		return (-2);
1458	}
1459
1460	if (port->wwpn_iid[iid].in_use > 0 && (wwpn != 0 || name != NULL)) {
1461		/*
1462		 * This is not an error yet.
1463		 */
1464		if (wwpn != 0 && wwpn == port->wwpn_iid[iid].wwpn) {
1465#if 0
1466			printf("%s: port %d iid %u WWPN %#jx arrived"
1467			    " again\n", __func__, port->targ_port,
1468			    iid, (uintmax_t)wwpn);
1469#endif
1470			goto take;
1471		}
1472		if (name != NULL && port->wwpn_iid[iid].name != NULL &&
1473		    strcmp(name, port->wwpn_iid[iid].name) == 0) {
1474#if 0
1475			printf("%s: port %d iid %u name '%s' arrived"
1476			    " again\n", __func__, port->targ_port,
1477			    iid, name);
1478#endif
1479			goto take;
1480		}
1481
1482		/*
1483		 * This is an error, but what do we do about it?  The
1484		 * driver is telling us we have a new WWPN for this
1485		 * initiator ID, so we pretty much need to use it.
1486		 */
1487		printf("%s: port %d iid %u WWPN %#jx '%s' arrived,"
1488		    " but WWPN %#jx '%s' is still at that address\n",
1489		    __func__, port->targ_port, iid, wwpn, name,
1490		    (uintmax_t)port->wwpn_iid[iid].wwpn,
1491		    port->wwpn_iid[iid].name);
1492
1493		/*
1494		 * XXX KDM clear have_ca and ua_pending on each LUN for
1495		 * this initiator.
1496		 */
1497	}
1498take:
1499	free(port->wwpn_iid[iid].name, M_CTL);
1500	port->wwpn_iid[iid].name = name;
1501	port->wwpn_iid[iid].wwpn = wwpn;
1502	port->wwpn_iid[iid].in_use++;
1503	mtx_unlock(&softc->ctl_lock);
1504
1505	return (iid);
1506}
1507
1508static int
1509ctl_create_iid(struct ctl_port *port, int iid, uint8_t *buf)
1510{
1511	int len;
1512
1513	switch (port->port_type) {
1514	case CTL_PORT_FC:
1515	{
1516		struct scsi_transportid_fcp *id =
1517		    (struct scsi_transportid_fcp *)buf;
1518		if (port->wwpn_iid[iid].wwpn == 0)
1519			return (0);
1520		memset(id, 0, sizeof(*id));
1521		id->format_protocol = SCSI_PROTO_FC;
1522		scsi_u64to8b(port->wwpn_iid[iid].wwpn, id->n_port_name);
1523		return (sizeof(*id));
1524	}
1525	case CTL_PORT_ISCSI:
1526	{
1527		struct scsi_transportid_iscsi_port *id =
1528		    (struct scsi_transportid_iscsi_port *)buf;
1529		if (port->wwpn_iid[iid].name == NULL)
1530			return (0);
1531		memset(id, 0, 256);
1532		id->format_protocol = SCSI_TRN_ISCSI_FORMAT_PORT |
1533		    SCSI_PROTO_ISCSI;
1534		len = strlcpy(id->iscsi_name, port->wwpn_iid[iid].name, 252) + 1;
1535		len = roundup2(min(len, 252), 4);
1536		scsi_ulto2b(len, id->additional_length);
1537		return (sizeof(*id) + len);
1538	}
1539	case CTL_PORT_SAS:
1540	{
1541		struct scsi_transportid_sas *id =
1542		    (struct scsi_transportid_sas *)buf;
1543		if (port->wwpn_iid[iid].wwpn == 0)
1544			return (0);
1545		memset(id, 0, sizeof(*id));
1546		id->format_protocol = SCSI_PROTO_SAS;
1547		scsi_u64to8b(port->wwpn_iid[iid].wwpn, id->sas_address);
1548		return (sizeof(*id));
1549	}
1550	default:
1551	{
1552		struct scsi_transportid_spi *id =
1553		    (struct scsi_transportid_spi *)buf;
1554		memset(id, 0, sizeof(*id));
1555		id->format_protocol = SCSI_PROTO_SPI;
1556		scsi_ulto2b(iid, id->scsi_addr);
1557		scsi_ulto2b(port->targ_port, id->rel_trgt_port_id);
1558		return (sizeof(*id));
1559	}
1560	}
1561}
1562
1563static int
1564ctl_ioctl_lun_enable(void *arg, struct ctl_id targ_id, int lun_id)
1565{
1566	return (0);
1567}
1568
1569static int
1570ctl_ioctl_lun_disable(void *arg, struct ctl_id targ_id, int lun_id)
1571{
1572	return (0);
1573}
1574
1575/*
1576 * Data movement routine for the CTL ioctl frontend port.
1577 */
1578static int
1579ctl_ioctl_do_datamove(struct ctl_scsiio *ctsio)
1580{
1581	struct ctl_sg_entry *ext_sglist, *kern_sglist;
1582	struct ctl_sg_entry ext_entry, kern_entry;
1583	int ext_sglen, ext_sg_entries, kern_sg_entries;
1584	int ext_sg_start, ext_offset;
1585	int len_to_copy, len_copied;
1586	int kern_watermark, ext_watermark;
1587	int ext_sglist_malloced;
1588	int i, j;
1589
1590	ext_sglist_malloced = 0;
1591	ext_sg_start = 0;
1592	ext_offset = 0;
1593
1594	CTL_DEBUG_PRINT(("ctl_ioctl_do_datamove\n"));
1595
1596	/*
1597	 * If this flag is set, fake the data transfer.
1598	 */
1599	if (ctsio->io_hdr.flags & CTL_FLAG_NO_DATAMOVE) {
1600		ctsio->ext_data_filled = ctsio->ext_data_len;
1601		goto bailout;
1602	}
1603
1604	/*
1605	 * To simplify things here, if we have a single buffer, stick it in
1606	 * a S/G entry and just make it a single entry S/G list.
1607	 */
1608	if (ctsio->io_hdr.flags & CTL_FLAG_EDPTR_SGLIST) {
1609		int len_seen;
1610
1611		ext_sglen = ctsio->ext_sg_entries * sizeof(*ext_sglist);
1612
1613		ext_sglist = (struct ctl_sg_entry *)malloc(ext_sglen, M_CTL,
1614							   M_WAITOK);
1615		ext_sglist_malloced = 1;
1616		if (copyin(ctsio->ext_data_ptr, ext_sglist,
1617				   ext_sglen) != 0) {
1618			ctl_set_internal_failure(ctsio,
1619						 /*sks_valid*/ 0,
1620						 /*retry_count*/ 0);
1621			goto bailout;
1622		}
1623		ext_sg_entries = ctsio->ext_sg_entries;
1624		len_seen = 0;
1625		for (i = 0; i < ext_sg_entries; i++) {
1626			if ((len_seen + ext_sglist[i].len) >=
1627			     ctsio->ext_data_filled) {
1628				ext_sg_start = i;
1629				ext_offset = ctsio->ext_data_filled - len_seen;
1630				break;
1631			}
1632			len_seen += ext_sglist[i].len;
1633		}
1634	} else {
1635		ext_sglist = &ext_entry;
1636		ext_sglist->addr = ctsio->ext_data_ptr;
1637		ext_sglist->len = ctsio->ext_data_len;
1638		ext_sg_entries = 1;
1639		ext_sg_start = 0;
1640		ext_offset = ctsio->ext_data_filled;
1641	}
1642
1643	if (ctsio->kern_sg_entries > 0) {
1644		kern_sglist = (struct ctl_sg_entry *)ctsio->kern_data_ptr;
1645		kern_sg_entries = ctsio->kern_sg_entries;
1646	} else {
1647		kern_sglist = &kern_entry;
1648		kern_sglist->addr = ctsio->kern_data_ptr;
1649		kern_sglist->len = ctsio->kern_data_len;
1650		kern_sg_entries = 1;
1651	}
1652
1653
1654	kern_watermark = 0;
1655	ext_watermark = ext_offset;
1656	len_copied = 0;
1657	for (i = ext_sg_start, j = 0;
1658	     i < ext_sg_entries && j < kern_sg_entries;) {
1659		uint8_t *ext_ptr, *kern_ptr;
1660
1661		len_to_copy = ctl_min(ext_sglist[i].len - ext_watermark,
1662				      kern_sglist[j].len - kern_watermark);
1663
1664		ext_ptr = (uint8_t *)ext_sglist[i].addr;
1665		ext_ptr = ext_ptr + ext_watermark;
1666		if (ctsio->io_hdr.flags & CTL_FLAG_BUS_ADDR) {
1667			/*
1668			 * XXX KDM fix this!
1669			 */
1670			panic("need to implement bus address support");
1671#if 0
1672			kern_ptr = bus_to_virt(kern_sglist[j].addr);
1673#endif
1674		} else
1675			kern_ptr = (uint8_t *)kern_sglist[j].addr;
1676		kern_ptr = kern_ptr + kern_watermark;
1677
1678		kern_watermark += len_to_copy;
1679		ext_watermark += len_to_copy;
1680
1681		if ((ctsio->io_hdr.flags & CTL_FLAG_DATA_MASK) ==
1682		     CTL_FLAG_DATA_IN) {
1683			CTL_DEBUG_PRINT(("ctl_ioctl_do_datamove: copying %d "
1684					 "bytes to user\n", len_to_copy));
1685			CTL_DEBUG_PRINT(("ctl_ioctl_do_datamove: from %p "
1686					 "to %p\n", kern_ptr, ext_ptr));
1687			if (copyout(kern_ptr, ext_ptr, len_to_copy) != 0) {
1688				ctl_set_internal_failure(ctsio,
1689							 /*sks_valid*/ 0,
1690							 /*retry_count*/ 0);
1691				goto bailout;
1692			}
1693		} else {
1694			CTL_DEBUG_PRINT(("ctl_ioctl_do_datamove: copying %d "
1695					 "bytes from user\n", len_to_copy));
1696			CTL_DEBUG_PRINT(("ctl_ioctl_do_datamove: from %p "
1697					 "to %p\n", ext_ptr, kern_ptr));
1698			if (copyin(ext_ptr, kern_ptr, len_to_copy)!= 0){
1699				ctl_set_internal_failure(ctsio,
1700							 /*sks_valid*/ 0,
1701							 /*retry_count*/0);
1702				goto bailout;
1703			}
1704		}
1705
1706		len_copied += len_to_copy;
1707
1708		if (ext_sglist[i].len == ext_watermark) {
1709			i++;
1710			ext_watermark = 0;
1711		}
1712
1713		if (kern_sglist[j].len == kern_watermark) {
1714			j++;
1715			kern_watermark = 0;
1716		}
1717	}
1718
1719	ctsio->ext_data_filled += len_copied;
1720
1721	CTL_DEBUG_PRINT(("ctl_ioctl_do_datamove: ext_sg_entries: %d, "
1722			 "kern_sg_entries: %d\n", ext_sg_entries,
1723			 kern_sg_entries));
1724	CTL_DEBUG_PRINT(("ctl_ioctl_do_datamove: ext_data_len = %d, "
1725			 "kern_data_len = %d\n", ctsio->ext_data_len,
1726			 ctsio->kern_data_len));
1727
1728
1729	/* XXX KDM set residual?? */
1730bailout:
1731
1732	if (ext_sglist_malloced != 0)
1733		free(ext_sglist, M_CTL);
1734
1735	return (CTL_RETVAL_COMPLETE);
1736}
1737
1738/*
1739 * Serialize a command that went down the "wrong" side, and so was sent to
1740 * this controller for execution.  The logic is a little different than the
1741 * standard case in ctl_scsiio_precheck().  Errors in this case need to get
1742 * sent back to the other side, but in the success case, we execute the
1743 * command on this side (XFER mode) or tell the other side to execute it
1744 * (SER_ONLY mode).
1745 */
1746static int
1747ctl_serialize_other_sc_cmd(struct ctl_scsiio *ctsio)
1748{
1749	struct ctl_softc *ctl_softc;
1750	union ctl_ha_msg msg_info;
1751	struct ctl_lun *lun;
1752	int retval = 0;
1753	uint32_t targ_lun;
1754
1755	ctl_softc = control_softc;
1756
1757	targ_lun = ctsio->io_hdr.nexus.targ_mapped_lun;
1758	lun = ctl_softc->ctl_luns[targ_lun];
1759	if (lun==NULL)
1760	{
1761		/*
1762		 * Why isn't LUN defined? The other side wouldn't
1763		 * send a cmd if the LUN is undefined.
1764		 */
1765		printf("%s: Bad JUJU!, LUN is NULL!\n", __func__);
1766
1767		/* "Logical unit not supported" */
1768		ctl_set_sense_data(&msg_info.scsi.sense_data,
1769				   lun,
1770				   /*sense_format*/SSD_TYPE_NONE,
1771				   /*current_error*/ 1,
1772				   /*sense_key*/ SSD_KEY_ILLEGAL_REQUEST,
1773				   /*asc*/ 0x25,
1774				   /*ascq*/ 0x00,
1775				   SSD_ELEM_NONE);
1776
1777		msg_info.scsi.sense_len = SSD_FULL_SIZE;
1778		msg_info.scsi.scsi_status = SCSI_STATUS_CHECK_COND;
1779		msg_info.hdr.status = CTL_SCSI_ERROR | CTL_AUTOSENSE;
1780		msg_info.hdr.original_sc = ctsio->io_hdr.original_sc;
1781		msg_info.hdr.serializing_sc = NULL;
1782		msg_info.hdr.msg_type = CTL_MSG_BAD_JUJU;
1783	        if (ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg_info,
1784				sizeof(msg_info), 0 ) > CTL_HA_STATUS_SUCCESS) {
1785		}
1786		return(1);
1787
1788	}
1789
1790	mtx_lock(&lun->lun_lock);
1791    	TAILQ_INSERT_TAIL(&lun->ooa_queue, &ctsio->io_hdr, ooa_links);
1792
1793	switch (ctl_check_ooa(lun, (union ctl_io *)ctsio,
1794		(union ctl_io *)TAILQ_PREV(&ctsio->io_hdr, ctl_ooaq,
1795		 ooa_links))) {
1796	case CTL_ACTION_BLOCK:
1797		ctsio->io_hdr.flags |= CTL_FLAG_BLOCKED;
1798		TAILQ_INSERT_TAIL(&lun->blocked_queue, &ctsio->io_hdr,
1799				  blocked_links);
1800		break;
1801	case CTL_ACTION_PASS:
1802	case CTL_ACTION_SKIP:
1803		if (ctl_softc->ha_mode == CTL_HA_MODE_XFER) {
1804			ctsio->io_hdr.flags |= CTL_FLAG_IS_WAS_ON_RTR;
1805			ctl_enqueue_rtr((union ctl_io *)ctsio);
1806		} else {
1807
1808			/* send msg back to other side */
1809			msg_info.hdr.original_sc = ctsio->io_hdr.original_sc;
1810			msg_info.hdr.serializing_sc = (union ctl_io *)ctsio;
1811			msg_info.hdr.msg_type = CTL_MSG_R2R;
1812#if 0
1813			printf("2. pOrig %x\n", (int)msg_info.hdr.original_sc);
1814#endif
1815		        if (ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg_info,
1816			    sizeof(msg_info), 0 ) > CTL_HA_STATUS_SUCCESS) {
1817			}
1818		}
1819		break;
1820	case CTL_ACTION_OVERLAP:
1821		/* OVERLAPPED COMMANDS ATTEMPTED */
1822		ctl_set_sense_data(&msg_info.scsi.sense_data,
1823				   lun,
1824				   /*sense_format*/SSD_TYPE_NONE,
1825				   /*current_error*/ 1,
1826				   /*sense_key*/ SSD_KEY_ILLEGAL_REQUEST,
1827				   /*asc*/ 0x4E,
1828				   /*ascq*/ 0x00,
1829				   SSD_ELEM_NONE);
1830
1831		msg_info.scsi.sense_len = SSD_FULL_SIZE;
1832		msg_info.scsi.scsi_status = SCSI_STATUS_CHECK_COND;
1833		msg_info.hdr.status = CTL_SCSI_ERROR | CTL_AUTOSENSE;
1834		msg_info.hdr.original_sc = ctsio->io_hdr.original_sc;
1835		msg_info.hdr.serializing_sc = NULL;
1836		msg_info.hdr.msg_type = CTL_MSG_BAD_JUJU;
1837#if 0
1838		printf("BAD JUJU:Major Bummer Overlap\n");
1839#endif
1840		TAILQ_REMOVE(&lun->ooa_queue, &ctsio->io_hdr, ooa_links);
1841		retval = 1;
1842		if (ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg_info,
1843		    sizeof(msg_info), 0 ) > CTL_HA_STATUS_SUCCESS) {
1844		}
1845		break;
1846	case CTL_ACTION_OVERLAP_TAG:
1847		/* TAGGED OVERLAPPED COMMANDS (NN = QUEUE TAG) */
1848		ctl_set_sense_data(&msg_info.scsi.sense_data,
1849				   lun,
1850				   /*sense_format*/SSD_TYPE_NONE,
1851				   /*current_error*/ 1,
1852				   /*sense_key*/ SSD_KEY_ILLEGAL_REQUEST,
1853				   /*asc*/ 0x4D,
1854				   /*ascq*/ ctsio->tag_num & 0xff,
1855				   SSD_ELEM_NONE);
1856
1857		msg_info.scsi.sense_len = SSD_FULL_SIZE;
1858		msg_info.scsi.scsi_status = SCSI_STATUS_CHECK_COND;
1859		msg_info.hdr.status = CTL_SCSI_ERROR | CTL_AUTOSENSE;
1860		msg_info.hdr.original_sc = ctsio->io_hdr.original_sc;
1861		msg_info.hdr.serializing_sc = NULL;
1862		msg_info.hdr.msg_type = CTL_MSG_BAD_JUJU;
1863#if 0
1864		printf("BAD JUJU:Major Bummer Overlap Tag\n");
1865#endif
1866		TAILQ_REMOVE(&lun->ooa_queue, &ctsio->io_hdr, ooa_links);
1867		retval = 1;
1868		if (ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg_info,
1869		    sizeof(msg_info), 0 ) > CTL_HA_STATUS_SUCCESS) {
1870		}
1871		break;
1872	case CTL_ACTION_ERROR:
1873	default:
1874		/* "Internal target failure" */
1875		ctl_set_sense_data(&msg_info.scsi.sense_data,
1876				   lun,
1877				   /*sense_format*/SSD_TYPE_NONE,
1878				   /*current_error*/ 1,
1879				   /*sense_key*/ SSD_KEY_HARDWARE_ERROR,
1880				   /*asc*/ 0x44,
1881				   /*ascq*/ 0x00,
1882				   SSD_ELEM_NONE);
1883
1884		msg_info.scsi.sense_len = SSD_FULL_SIZE;
1885		msg_info.scsi.scsi_status = SCSI_STATUS_CHECK_COND;
1886		msg_info.hdr.status = CTL_SCSI_ERROR | CTL_AUTOSENSE;
1887		msg_info.hdr.original_sc = ctsio->io_hdr.original_sc;
1888		msg_info.hdr.serializing_sc = NULL;
1889		msg_info.hdr.msg_type = CTL_MSG_BAD_JUJU;
1890#if 0
1891		printf("BAD JUJU:Major Bummer HW Error\n");
1892#endif
1893		TAILQ_REMOVE(&lun->ooa_queue, &ctsio->io_hdr, ooa_links);
1894		retval = 1;
1895		if (ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg_info,
1896		    sizeof(msg_info), 0 ) > CTL_HA_STATUS_SUCCESS) {
1897		}
1898		break;
1899	}
1900	mtx_unlock(&lun->lun_lock);
1901	return (retval);
1902}
1903
1904static int
1905ctl_ioctl_submit_wait(union ctl_io *io)
1906{
1907	struct ctl_fe_ioctl_params params;
1908	ctl_fe_ioctl_state last_state;
1909	int done, retval;
1910
1911	retval = 0;
1912
1913	bzero(&params, sizeof(params));
1914
1915	mtx_init(&params.ioctl_mtx, "ctliocmtx", NULL, MTX_DEF);
1916	cv_init(&params.sem, "ctlioccv");
1917	params.state = CTL_IOCTL_INPROG;
1918	last_state = params.state;
1919
1920	io->io_hdr.ctl_private[CTL_PRIV_FRONTEND].ptr = &params;
1921
1922	CTL_DEBUG_PRINT(("ctl_ioctl_submit_wait\n"));
1923
1924	/* This shouldn't happen */
1925	if ((retval = ctl_queue(io)) != CTL_RETVAL_COMPLETE)
1926		return (retval);
1927
1928	done = 0;
1929
1930	do {
1931		mtx_lock(&params.ioctl_mtx);
1932		/*
1933		 * Check the state here, and don't sleep if the state has
1934		 * already changed (i.e. wakeup has already occured, but we
1935		 * weren't waiting yet).
1936		 */
1937		if (params.state == last_state) {
1938			/* XXX KDM cv_wait_sig instead? */
1939			cv_wait(&params.sem, &params.ioctl_mtx);
1940		}
1941		last_state = params.state;
1942
1943		switch (params.state) {
1944		case CTL_IOCTL_INPROG:
1945			/* Why did we wake up? */
1946			/* XXX KDM error here? */
1947			mtx_unlock(&params.ioctl_mtx);
1948			break;
1949		case CTL_IOCTL_DATAMOVE:
1950			CTL_DEBUG_PRINT(("got CTL_IOCTL_DATAMOVE\n"));
1951
1952			/*
1953			 * change last_state back to INPROG to avoid
1954			 * deadlock on subsequent data moves.
1955			 */
1956			params.state = last_state = CTL_IOCTL_INPROG;
1957
1958			mtx_unlock(&params.ioctl_mtx);
1959			ctl_ioctl_do_datamove(&io->scsiio);
1960			/*
1961			 * Note that in some cases, most notably writes,
1962			 * this will queue the I/O and call us back later.
1963			 * In other cases, generally reads, this routine
1964			 * will immediately call back and wake us up,
1965			 * probably using our own context.
1966			 */
1967			io->scsiio.be_move_done(io);
1968			break;
1969		case CTL_IOCTL_DONE:
1970			mtx_unlock(&params.ioctl_mtx);
1971			CTL_DEBUG_PRINT(("got CTL_IOCTL_DONE\n"));
1972			done = 1;
1973			break;
1974		default:
1975			mtx_unlock(&params.ioctl_mtx);
1976			/* XXX KDM error here? */
1977			break;
1978		}
1979	} while (done == 0);
1980
1981	mtx_destroy(&params.ioctl_mtx);
1982	cv_destroy(&params.sem);
1983
1984	return (CTL_RETVAL_COMPLETE);
1985}
1986
1987static void
1988ctl_ioctl_datamove(union ctl_io *io)
1989{
1990	struct ctl_fe_ioctl_params *params;
1991
1992	params = (struct ctl_fe_ioctl_params *)
1993		io->io_hdr.ctl_private[CTL_PRIV_FRONTEND].ptr;
1994
1995	mtx_lock(&params->ioctl_mtx);
1996	params->state = CTL_IOCTL_DATAMOVE;
1997	cv_broadcast(&params->sem);
1998	mtx_unlock(&params->ioctl_mtx);
1999}
2000
2001static void
2002ctl_ioctl_done(union ctl_io *io)
2003{
2004	struct ctl_fe_ioctl_params *params;
2005
2006	params = (struct ctl_fe_ioctl_params *)
2007		io->io_hdr.ctl_private[CTL_PRIV_FRONTEND].ptr;
2008
2009	mtx_lock(&params->ioctl_mtx);
2010	params->state = CTL_IOCTL_DONE;
2011	cv_broadcast(&params->sem);
2012	mtx_unlock(&params->ioctl_mtx);
2013}
2014
2015static void
2016ctl_ioctl_hard_startstop_callback(void *arg, struct cfi_metatask *metatask)
2017{
2018	struct ctl_fe_ioctl_startstop_info *sd_info;
2019
2020	sd_info = (struct ctl_fe_ioctl_startstop_info *)arg;
2021
2022	sd_info->hs_info.status = metatask->status;
2023	sd_info->hs_info.total_luns = metatask->taskinfo.startstop.total_luns;
2024	sd_info->hs_info.luns_complete =
2025		metatask->taskinfo.startstop.luns_complete;
2026	sd_info->hs_info.luns_failed = metatask->taskinfo.startstop.luns_failed;
2027
2028	cv_broadcast(&sd_info->sem);
2029}
2030
2031static void
2032ctl_ioctl_bbrread_callback(void *arg, struct cfi_metatask *metatask)
2033{
2034	struct ctl_fe_ioctl_bbrread_info *fe_bbr_info;
2035
2036	fe_bbr_info = (struct ctl_fe_ioctl_bbrread_info *)arg;
2037
2038	mtx_lock(fe_bbr_info->lock);
2039	fe_bbr_info->bbr_info->status = metatask->status;
2040	fe_bbr_info->bbr_info->bbr_status = metatask->taskinfo.bbrread.status;
2041	fe_bbr_info->wakeup_done = 1;
2042	mtx_unlock(fe_bbr_info->lock);
2043
2044	cv_broadcast(&fe_bbr_info->sem);
2045}
2046
2047/*
2048 * Returns 0 for success, errno for failure.
2049 */
2050static int
2051ctl_ioctl_fill_ooa(struct ctl_lun *lun, uint32_t *cur_fill_num,
2052		   struct ctl_ooa *ooa_hdr, struct ctl_ooa_entry *kern_entries)
2053{
2054	union ctl_io *io;
2055	int retval;
2056
2057	retval = 0;
2058
2059	mtx_lock(&lun->lun_lock);
2060	for (io = (union ctl_io *)TAILQ_FIRST(&lun->ooa_queue); (io != NULL);
2061	     (*cur_fill_num)++, io = (union ctl_io *)TAILQ_NEXT(&io->io_hdr,
2062	     ooa_links)) {
2063		struct ctl_ooa_entry *entry;
2064
2065		/*
2066		 * If we've got more than we can fit, just count the
2067		 * remaining entries.
2068		 */
2069		if (*cur_fill_num >= ooa_hdr->alloc_num)
2070			continue;
2071
2072		entry = &kern_entries[*cur_fill_num];
2073
2074		entry->tag_num = io->scsiio.tag_num;
2075		entry->lun_num = lun->lun;
2076#ifdef CTL_TIME_IO
2077		entry->start_bt = io->io_hdr.start_bt;
2078#endif
2079		bcopy(io->scsiio.cdb, entry->cdb, io->scsiio.cdb_len);
2080		entry->cdb_len = io->scsiio.cdb_len;
2081		if (io->io_hdr.flags & CTL_FLAG_BLOCKED)
2082			entry->cmd_flags |= CTL_OOACMD_FLAG_BLOCKED;
2083
2084		if (io->io_hdr.flags & CTL_FLAG_DMA_INPROG)
2085			entry->cmd_flags |= CTL_OOACMD_FLAG_DMA;
2086
2087		if (io->io_hdr.flags & CTL_FLAG_ABORT)
2088			entry->cmd_flags |= CTL_OOACMD_FLAG_ABORT;
2089
2090		if (io->io_hdr.flags & CTL_FLAG_IS_WAS_ON_RTR)
2091			entry->cmd_flags |= CTL_OOACMD_FLAG_RTR;
2092
2093		if (io->io_hdr.flags & CTL_FLAG_DMA_QUEUED)
2094			entry->cmd_flags |= CTL_OOACMD_FLAG_DMA_QUEUED;
2095	}
2096	mtx_unlock(&lun->lun_lock);
2097
2098	return (retval);
2099}
2100
2101static void *
2102ctl_copyin_alloc(void *user_addr, int len, char *error_str,
2103		 size_t error_str_len)
2104{
2105	void *kptr;
2106
2107	kptr = malloc(len, M_CTL, M_WAITOK | M_ZERO);
2108
2109	if (copyin(user_addr, kptr, len) != 0) {
2110		snprintf(error_str, error_str_len, "Error copying %d bytes "
2111			 "from user address %p to kernel address %p", len,
2112			 user_addr, kptr);
2113		free(kptr, M_CTL);
2114		return (NULL);
2115	}
2116
2117	return (kptr);
2118}
2119
2120static void
2121ctl_free_args(int num_args, struct ctl_be_arg *args)
2122{
2123	int i;
2124
2125	if (args == NULL)
2126		return;
2127
2128	for (i = 0; i < num_args; i++) {
2129		free(args[i].kname, M_CTL);
2130		free(args[i].kvalue, M_CTL);
2131	}
2132
2133	free(args, M_CTL);
2134}
2135
2136static struct ctl_be_arg *
2137ctl_copyin_args(int num_args, struct ctl_be_arg *uargs,
2138		char *error_str, size_t error_str_len)
2139{
2140	struct ctl_be_arg *args;
2141	int i;
2142
2143	args = ctl_copyin_alloc(uargs, num_args * sizeof(*args),
2144				error_str, error_str_len);
2145
2146	if (args == NULL)
2147		goto bailout;
2148
2149	for (i = 0; i < num_args; i++) {
2150		args[i].kname = NULL;
2151		args[i].kvalue = NULL;
2152	}
2153
2154	for (i = 0; i < num_args; i++) {
2155		uint8_t *tmpptr;
2156
2157		args[i].kname = ctl_copyin_alloc(args[i].name,
2158			args[i].namelen, error_str, error_str_len);
2159		if (args[i].kname == NULL)
2160			goto bailout;
2161
2162		if (args[i].kname[args[i].namelen - 1] != '\0') {
2163			snprintf(error_str, error_str_len, "Argument %d "
2164				 "name is not NUL-terminated", i);
2165			goto bailout;
2166		}
2167
2168		if (args[i].flags & CTL_BEARG_RD) {
2169			tmpptr = ctl_copyin_alloc(args[i].value,
2170				args[i].vallen, error_str, error_str_len);
2171			if (tmpptr == NULL)
2172				goto bailout;
2173			if ((args[i].flags & CTL_BEARG_ASCII)
2174			 && (tmpptr[args[i].vallen - 1] != '\0')) {
2175				snprintf(error_str, error_str_len, "Argument "
2176				    "%d value is not NUL-terminated", i);
2177				goto bailout;
2178			}
2179			args[i].kvalue = tmpptr;
2180		} else {
2181			args[i].kvalue = malloc(args[i].vallen,
2182			    M_CTL, M_WAITOK | M_ZERO);
2183		}
2184	}
2185
2186	return (args);
2187bailout:
2188
2189	ctl_free_args(num_args, args);
2190
2191	return (NULL);
2192}
2193
2194static void
2195ctl_copyout_args(int num_args, struct ctl_be_arg *args)
2196{
2197	int i;
2198
2199	for (i = 0; i < num_args; i++) {
2200		if (args[i].flags & CTL_BEARG_WR)
2201			copyout(args[i].kvalue, args[i].value, args[i].vallen);
2202	}
2203}
2204
2205/*
2206 * Escape characters that are illegal or not recommended in XML.
2207 */
2208int
2209ctl_sbuf_printf_esc(struct sbuf *sb, char *str)
2210{
2211	int retval;
2212
2213	retval = 0;
2214
2215	for (; *str; str++) {
2216		switch (*str) {
2217		case '&':
2218			retval = sbuf_printf(sb, "&amp;");
2219			break;
2220		case '>':
2221			retval = sbuf_printf(sb, "&gt;");
2222			break;
2223		case '<':
2224			retval = sbuf_printf(sb, "&lt;");
2225			break;
2226		default:
2227			retval = sbuf_putc(sb, *str);
2228			break;
2229		}
2230
2231		if (retval != 0)
2232			break;
2233
2234	}
2235
2236	return (retval);
2237}
2238
2239static int
2240ctl_ioctl(struct cdev *dev, u_long cmd, caddr_t addr, int flag,
2241	  struct thread *td)
2242{
2243	struct ctl_softc *softc;
2244	int retval;
2245
2246	softc = control_softc;
2247
2248	retval = 0;
2249
2250	switch (cmd) {
2251	case CTL_IO: {
2252		union ctl_io *io;
2253		void *pool_tmp;
2254
2255		/*
2256		 * If we haven't been "enabled", don't allow any SCSI I/O
2257		 * to this FETD.
2258		 */
2259		if ((softc->ioctl_info.flags & CTL_IOCTL_FLAG_ENABLED) == 0) {
2260			retval = EPERM;
2261			break;
2262		}
2263
2264		io = ctl_alloc_io(softc->ioctl_info.port.ctl_pool_ref);
2265		if (io == NULL) {
2266			printf("ctl_ioctl: can't allocate ctl_io!\n");
2267			retval = ENOSPC;
2268			break;
2269		}
2270
2271		/*
2272		 * Need to save the pool reference so it doesn't get
2273		 * spammed by the user's ctl_io.
2274		 */
2275		pool_tmp = io->io_hdr.pool;
2276
2277		memcpy(io, (void *)addr, sizeof(*io));
2278
2279		io->io_hdr.pool = pool_tmp;
2280		/*
2281		 * No status yet, so make sure the status is set properly.
2282		 */
2283		io->io_hdr.status = CTL_STATUS_NONE;
2284
2285		/*
2286		 * The user sets the initiator ID, target and LUN IDs.
2287		 */
2288		io->io_hdr.nexus.targ_port = softc->ioctl_info.port.targ_port;
2289		io->io_hdr.flags |= CTL_FLAG_USER_REQ;
2290		if ((io->io_hdr.io_type == CTL_IO_SCSI)
2291		 && (io->scsiio.tag_type != CTL_TAG_UNTAGGED))
2292			io->scsiio.tag_num = softc->ioctl_info.cur_tag_num++;
2293
2294		retval = ctl_ioctl_submit_wait(io);
2295
2296		if (retval != 0) {
2297			ctl_free_io(io);
2298			break;
2299		}
2300
2301		memcpy((void *)addr, io, sizeof(*io));
2302
2303		/* return this to our pool */
2304		ctl_free_io(io);
2305
2306		break;
2307	}
2308	case CTL_ENABLE_PORT:
2309	case CTL_DISABLE_PORT:
2310	case CTL_SET_PORT_WWNS: {
2311		struct ctl_port *port;
2312		struct ctl_port_entry *entry;
2313
2314		entry = (struct ctl_port_entry *)addr;
2315
2316		mtx_lock(&softc->ctl_lock);
2317		STAILQ_FOREACH(port, &softc->port_list, links) {
2318			int action, done;
2319
2320			action = 0;
2321			done = 0;
2322
2323			if ((entry->port_type == CTL_PORT_NONE)
2324			 && (entry->targ_port == port->targ_port)) {
2325				/*
2326				 * If the user only wants to enable or
2327				 * disable or set WWNs on a specific port,
2328				 * do the operation and we're done.
2329				 */
2330				action = 1;
2331				done = 1;
2332			} else if (entry->port_type & port->port_type) {
2333				/*
2334				 * Compare the user's type mask with the
2335				 * particular frontend type to see if we
2336				 * have a match.
2337				 */
2338				action = 1;
2339				done = 0;
2340
2341				/*
2342				 * Make sure the user isn't trying to set
2343				 * WWNs on multiple ports at the same time.
2344				 */
2345				if (cmd == CTL_SET_PORT_WWNS) {
2346					printf("%s: Can't set WWNs on "
2347					       "multiple ports\n", __func__);
2348					retval = EINVAL;
2349					break;
2350				}
2351			}
2352			if (action != 0) {
2353				/*
2354				 * XXX KDM we have to drop the lock here,
2355				 * because the online/offline operations
2356				 * can potentially block.  We need to
2357				 * reference count the frontends so they
2358				 * can't go away,
2359				 */
2360				mtx_unlock(&softc->ctl_lock);
2361
2362				if (cmd == CTL_ENABLE_PORT) {
2363					struct ctl_lun *lun;
2364
2365					STAILQ_FOREACH(lun, &softc->lun_list,
2366						       links) {
2367						port->lun_enable(port->targ_lun_arg,
2368						    lun->target,
2369						    lun->lun);
2370					}
2371
2372					ctl_port_online(port);
2373				} else if (cmd == CTL_DISABLE_PORT) {
2374					struct ctl_lun *lun;
2375
2376					ctl_port_offline(port);
2377
2378					STAILQ_FOREACH(lun, &softc->lun_list,
2379						       links) {
2380						port->lun_disable(
2381						    port->targ_lun_arg,
2382						    lun->target,
2383						    lun->lun);
2384					}
2385				}
2386
2387				mtx_lock(&softc->ctl_lock);
2388
2389				if (cmd == CTL_SET_PORT_WWNS)
2390					ctl_port_set_wwns(port,
2391					    (entry->flags & CTL_PORT_WWNN_VALID) ?
2392					    1 : 0, entry->wwnn,
2393					    (entry->flags & CTL_PORT_WWPN_VALID) ?
2394					    1 : 0, entry->wwpn);
2395			}
2396			if (done != 0)
2397				break;
2398		}
2399		mtx_unlock(&softc->ctl_lock);
2400		break;
2401	}
2402	case CTL_GET_PORT_LIST: {
2403		struct ctl_port *port;
2404		struct ctl_port_list *list;
2405		int i;
2406
2407		list = (struct ctl_port_list *)addr;
2408
2409		if (list->alloc_len != (list->alloc_num *
2410		    sizeof(struct ctl_port_entry))) {
2411			printf("%s: CTL_GET_PORT_LIST: alloc_len %u != "
2412			       "alloc_num %u * sizeof(struct ctl_port_entry) "
2413			       "%zu\n", __func__, list->alloc_len,
2414			       list->alloc_num, sizeof(struct ctl_port_entry));
2415			retval = EINVAL;
2416			break;
2417		}
2418		list->fill_len = 0;
2419		list->fill_num = 0;
2420		list->dropped_num = 0;
2421		i = 0;
2422		mtx_lock(&softc->ctl_lock);
2423		STAILQ_FOREACH(port, &softc->port_list, links) {
2424			struct ctl_port_entry entry, *list_entry;
2425
2426			if (list->fill_num >= list->alloc_num) {
2427				list->dropped_num++;
2428				continue;
2429			}
2430
2431			entry.port_type = port->port_type;
2432			strlcpy(entry.port_name, port->port_name,
2433				sizeof(entry.port_name));
2434			entry.targ_port = port->targ_port;
2435			entry.physical_port = port->physical_port;
2436			entry.virtual_port = port->virtual_port;
2437			entry.wwnn = port->wwnn;
2438			entry.wwpn = port->wwpn;
2439			if (port->status & CTL_PORT_STATUS_ONLINE)
2440				entry.online = 1;
2441			else
2442				entry.online = 0;
2443
2444			list_entry = &list->entries[i];
2445
2446			retval = copyout(&entry, list_entry, sizeof(entry));
2447			if (retval != 0) {
2448				printf("%s: CTL_GET_PORT_LIST: copyout "
2449				       "returned %d\n", __func__, retval);
2450				break;
2451			}
2452			i++;
2453			list->fill_num++;
2454			list->fill_len += sizeof(entry);
2455		}
2456		mtx_unlock(&softc->ctl_lock);
2457
2458		/*
2459		 * If this is non-zero, we had a copyout fault, so there's
2460		 * probably no point in attempting to set the status inside
2461		 * the structure.
2462		 */
2463		if (retval != 0)
2464			break;
2465
2466		if (list->dropped_num > 0)
2467			list->status = CTL_PORT_LIST_NEED_MORE_SPACE;
2468		else
2469			list->status = CTL_PORT_LIST_OK;
2470		break;
2471	}
2472	case CTL_DUMP_OOA: {
2473		struct ctl_lun *lun;
2474		union ctl_io *io;
2475		char printbuf[128];
2476		struct sbuf sb;
2477
2478		mtx_lock(&softc->ctl_lock);
2479		printf("Dumping OOA queues:\n");
2480		STAILQ_FOREACH(lun, &softc->lun_list, links) {
2481			mtx_lock(&lun->lun_lock);
2482			for (io = (union ctl_io *)TAILQ_FIRST(
2483			     &lun->ooa_queue); io != NULL;
2484			     io = (union ctl_io *)TAILQ_NEXT(&io->io_hdr,
2485			     ooa_links)) {
2486				sbuf_new(&sb, printbuf, sizeof(printbuf),
2487					 SBUF_FIXEDLEN);
2488				sbuf_printf(&sb, "LUN %jd tag 0x%04x%s%s%s%s: ",
2489					    (intmax_t)lun->lun,
2490					    io->scsiio.tag_num,
2491					    (io->io_hdr.flags &
2492					    CTL_FLAG_BLOCKED) ? "" : " BLOCKED",
2493					    (io->io_hdr.flags &
2494					    CTL_FLAG_DMA_INPROG) ? " DMA" : "",
2495					    (io->io_hdr.flags &
2496					    CTL_FLAG_ABORT) ? " ABORT" : "",
2497			                    (io->io_hdr.flags &
2498		                        CTL_FLAG_IS_WAS_ON_RTR) ? " RTR" : "");
2499				ctl_scsi_command_string(&io->scsiio, NULL, &sb);
2500				sbuf_finish(&sb);
2501				printf("%s\n", sbuf_data(&sb));
2502			}
2503			mtx_unlock(&lun->lun_lock);
2504		}
2505		printf("OOA queues dump done\n");
2506		mtx_unlock(&softc->ctl_lock);
2507		break;
2508	}
2509	case CTL_GET_OOA: {
2510		struct ctl_lun *lun;
2511		struct ctl_ooa *ooa_hdr;
2512		struct ctl_ooa_entry *entries;
2513		uint32_t cur_fill_num;
2514
2515		ooa_hdr = (struct ctl_ooa *)addr;
2516
2517		if ((ooa_hdr->alloc_len == 0)
2518		 || (ooa_hdr->alloc_num == 0)) {
2519			printf("%s: CTL_GET_OOA: alloc len %u and alloc num %u "
2520			       "must be non-zero\n", __func__,
2521			       ooa_hdr->alloc_len, ooa_hdr->alloc_num);
2522			retval = EINVAL;
2523			break;
2524		}
2525
2526		if (ooa_hdr->alloc_len != (ooa_hdr->alloc_num *
2527		    sizeof(struct ctl_ooa_entry))) {
2528			printf("%s: CTL_GET_OOA: alloc len %u must be alloc "
2529			       "num %d * sizeof(struct ctl_ooa_entry) %zd\n",
2530			       __func__, ooa_hdr->alloc_len,
2531			       ooa_hdr->alloc_num,sizeof(struct ctl_ooa_entry));
2532			retval = EINVAL;
2533			break;
2534		}
2535
2536		entries = malloc(ooa_hdr->alloc_len, M_CTL, M_WAITOK | M_ZERO);
2537		if (entries == NULL) {
2538			printf("%s: could not allocate %d bytes for OOA "
2539			       "dump\n", __func__, ooa_hdr->alloc_len);
2540			retval = ENOMEM;
2541			break;
2542		}
2543
2544		mtx_lock(&softc->ctl_lock);
2545		if (((ooa_hdr->flags & CTL_OOA_FLAG_ALL_LUNS) == 0)
2546		 && ((ooa_hdr->lun_num > CTL_MAX_LUNS)
2547		  || (softc->ctl_luns[ooa_hdr->lun_num] == NULL))) {
2548			mtx_unlock(&softc->ctl_lock);
2549			free(entries, M_CTL);
2550			printf("%s: CTL_GET_OOA: invalid LUN %ju\n",
2551			       __func__, (uintmax_t)ooa_hdr->lun_num);
2552			retval = EINVAL;
2553			break;
2554		}
2555
2556		cur_fill_num = 0;
2557
2558		if (ooa_hdr->flags & CTL_OOA_FLAG_ALL_LUNS) {
2559			STAILQ_FOREACH(lun, &softc->lun_list, links) {
2560				retval = ctl_ioctl_fill_ooa(lun, &cur_fill_num,
2561					ooa_hdr, entries);
2562				if (retval != 0)
2563					break;
2564			}
2565			if (retval != 0) {
2566				mtx_unlock(&softc->ctl_lock);
2567				free(entries, M_CTL);
2568				break;
2569			}
2570		} else {
2571			lun = softc->ctl_luns[ooa_hdr->lun_num];
2572
2573			retval = ctl_ioctl_fill_ooa(lun, &cur_fill_num,ooa_hdr,
2574						    entries);
2575		}
2576		mtx_unlock(&softc->ctl_lock);
2577
2578		ooa_hdr->fill_num = min(cur_fill_num, ooa_hdr->alloc_num);
2579		ooa_hdr->fill_len = ooa_hdr->fill_num *
2580			sizeof(struct ctl_ooa_entry);
2581		retval = copyout(entries, ooa_hdr->entries, ooa_hdr->fill_len);
2582		if (retval != 0) {
2583			printf("%s: error copying out %d bytes for OOA dump\n",
2584			       __func__, ooa_hdr->fill_len);
2585		}
2586
2587		getbintime(&ooa_hdr->cur_bt);
2588
2589		if (cur_fill_num > ooa_hdr->alloc_num) {
2590			ooa_hdr->dropped_num = cur_fill_num -ooa_hdr->alloc_num;
2591			ooa_hdr->status = CTL_OOA_NEED_MORE_SPACE;
2592		} else {
2593			ooa_hdr->dropped_num = 0;
2594			ooa_hdr->status = CTL_OOA_OK;
2595		}
2596
2597		free(entries, M_CTL);
2598		break;
2599	}
2600	case CTL_CHECK_OOA: {
2601		union ctl_io *io;
2602		struct ctl_lun *lun;
2603		struct ctl_ooa_info *ooa_info;
2604
2605
2606		ooa_info = (struct ctl_ooa_info *)addr;
2607
2608		if (ooa_info->lun_id >= CTL_MAX_LUNS) {
2609			ooa_info->status = CTL_OOA_INVALID_LUN;
2610			break;
2611		}
2612		mtx_lock(&softc->ctl_lock);
2613		lun = softc->ctl_luns[ooa_info->lun_id];
2614		if (lun == NULL) {
2615			mtx_unlock(&softc->ctl_lock);
2616			ooa_info->status = CTL_OOA_INVALID_LUN;
2617			break;
2618		}
2619		mtx_lock(&lun->lun_lock);
2620		mtx_unlock(&softc->ctl_lock);
2621		ooa_info->num_entries = 0;
2622		for (io = (union ctl_io *)TAILQ_FIRST(&lun->ooa_queue);
2623		     io != NULL; io = (union ctl_io *)TAILQ_NEXT(
2624		     &io->io_hdr, ooa_links)) {
2625			ooa_info->num_entries++;
2626		}
2627		mtx_unlock(&lun->lun_lock);
2628
2629		ooa_info->status = CTL_OOA_SUCCESS;
2630
2631		break;
2632	}
2633	case CTL_HARD_START:
2634	case CTL_HARD_STOP: {
2635		struct ctl_fe_ioctl_startstop_info ss_info;
2636		struct cfi_metatask *metatask;
2637		struct mtx hs_mtx;
2638
2639		mtx_init(&hs_mtx, "HS Mutex", NULL, MTX_DEF);
2640
2641		cv_init(&ss_info.sem, "hard start/stop cv" );
2642
2643		metatask = cfi_alloc_metatask(/*can_wait*/ 1);
2644		if (metatask == NULL) {
2645			retval = ENOMEM;
2646			mtx_destroy(&hs_mtx);
2647			break;
2648		}
2649
2650		if (cmd == CTL_HARD_START)
2651			metatask->tasktype = CFI_TASK_STARTUP;
2652		else
2653			metatask->tasktype = CFI_TASK_SHUTDOWN;
2654
2655		metatask->callback = ctl_ioctl_hard_startstop_callback;
2656		metatask->callback_arg = &ss_info;
2657
2658		cfi_action(metatask);
2659
2660		/* Wait for the callback */
2661		mtx_lock(&hs_mtx);
2662		cv_wait_sig(&ss_info.sem, &hs_mtx);
2663		mtx_unlock(&hs_mtx);
2664
2665		/*
2666		 * All information has been copied from the metatask by the
2667		 * time cv_broadcast() is called, so we free the metatask here.
2668		 */
2669		cfi_free_metatask(metatask);
2670
2671		memcpy((void *)addr, &ss_info.hs_info, sizeof(ss_info.hs_info));
2672
2673		mtx_destroy(&hs_mtx);
2674		break;
2675	}
2676	case CTL_BBRREAD: {
2677		struct ctl_bbrread_info *bbr_info;
2678		struct ctl_fe_ioctl_bbrread_info fe_bbr_info;
2679		struct mtx bbr_mtx;
2680		struct cfi_metatask *metatask;
2681
2682		bbr_info = (struct ctl_bbrread_info *)addr;
2683
2684		bzero(&fe_bbr_info, sizeof(fe_bbr_info));
2685
2686		bzero(&bbr_mtx, sizeof(bbr_mtx));
2687		mtx_init(&bbr_mtx, "BBR Mutex", NULL, MTX_DEF);
2688
2689		fe_bbr_info.bbr_info = bbr_info;
2690		fe_bbr_info.lock = &bbr_mtx;
2691
2692		cv_init(&fe_bbr_info.sem, "BBR read cv");
2693		metatask = cfi_alloc_metatask(/*can_wait*/ 1);
2694
2695		if (metatask == NULL) {
2696			mtx_destroy(&bbr_mtx);
2697			cv_destroy(&fe_bbr_info.sem);
2698			retval = ENOMEM;
2699			break;
2700		}
2701		metatask->tasktype = CFI_TASK_BBRREAD;
2702		metatask->callback = ctl_ioctl_bbrread_callback;
2703		metatask->callback_arg = &fe_bbr_info;
2704		metatask->taskinfo.bbrread.lun_num = bbr_info->lun_num;
2705		metatask->taskinfo.bbrread.lba = bbr_info->lba;
2706		metatask->taskinfo.bbrread.len = bbr_info->len;
2707
2708		cfi_action(metatask);
2709
2710		mtx_lock(&bbr_mtx);
2711		while (fe_bbr_info.wakeup_done == 0)
2712			cv_wait_sig(&fe_bbr_info.sem, &bbr_mtx);
2713		mtx_unlock(&bbr_mtx);
2714
2715		bbr_info->status = metatask->status;
2716		bbr_info->bbr_status = metatask->taskinfo.bbrread.status;
2717		bbr_info->scsi_status = metatask->taskinfo.bbrread.scsi_status;
2718		memcpy(&bbr_info->sense_data,
2719		       &metatask->taskinfo.bbrread.sense_data,
2720		       ctl_min(sizeof(bbr_info->sense_data),
2721			       sizeof(metatask->taskinfo.bbrread.sense_data)));
2722
2723		cfi_free_metatask(metatask);
2724
2725		mtx_destroy(&bbr_mtx);
2726		cv_destroy(&fe_bbr_info.sem);
2727
2728		break;
2729	}
2730	case CTL_DELAY_IO: {
2731		struct ctl_io_delay_info *delay_info;
2732#ifdef CTL_IO_DELAY
2733		struct ctl_lun *lun;
2734#endif /* CTL_IO_DELAY */
2735
2736		delay_info = (struct ctl_io_delay_info *)addr;
2737
2738#ifdef CTL_IO_DELAY
2739		mtx_lock(&softc->ctl_lock);
2740
2741		if ((delay_info->lun_id > CTL_MAX_LUNS)
2742		 || (softc->ctl_luns[delay_info->lun_id] == NULL)) {
2743			delay_info->status = CTL_DELAY_STATUS_INVALID_LUN;
2744		} else {
2745			lun = softc->ctl_luns[delay_info->lun_id];
2746			mtx_lock(&lun->lun_lock);
2747
2748			delay_info->status = CTL_DELAY_STATUS_OK;
2749
2750			switch (delay_info->delay_type) {
2751			case CTL_DELAY_TYPE_CONT:
2752				break;
2753			case CTL_DELAY_TYPE_ONESHOT:
2754				break;
2755			default:
2756				delay_info->status =
2757					CTL_DELAY_STATUS_INVALID_TYPE;
2758				break;
2759			}
2760
2761			switch (delay_info->delay_loc) {
2762			case CTL_DELAY_LOC_DATAMOVE:
2763				lun->delay_info.datamove_type =
2764					delay_info->delay_type;
2765				lun->delay_info.datamove_delay =
2766					delay_info->delay_secs;
2767				break;
2768			case CTL_DELAY_LOC_DONE:
2769				lun->delay_info.done_type =
2770					delay_info->delay_type;
2771				lun->delay_info.done_delay =
2772					delay_info->delay_secs;
2773				break;
2774			default:
2775				delay_info->status =
2776					CTL_DELAY_STATUS_INVALID_LOC;
2777				break;
2778			}
2779			mtx_unlock(&lun->lun_lock);
2780		}
2781
2782		mtx_unlock(&softc->ctl_lock);
2783#else
2784		delay_info->status = CTL_DELAY_STATUS_NOT_IMPLEMENTED;
2785#endif /* CTL_IO_DELAY */
2786		break;
2787	}
2788	case CTL_REALSYNC_SET: {
2789		int *syncstate;
2790
2791		syncstate = (int *)addr;
2792
2793		mtx_lock(&softc->ctl_lock);
2794		switch (*syncstate) {
2795		case 0:
2796			softc->flags &= ~CTL_FLAG_REAL_SYNC;
2797			break;
2798		case 1:
2799			softc->flags |= CTL_FLAG_REAL_SYNC;
2800			break;
2801		default:
2802			retval = EINVAL;
2803			break;
2804		}
2805		mtx_unlock(&softc->ctl_lock);
2806		break;
2807	}
2808	case CTL_REALSYNC_GET: {
2809		int *syncstate;
2810
2811		syncstate = (int*)addr;
2812
2813		mtx_lock(&softc->ctl_lock);
2814		if (softc->flags & CTL_FLAG_REAL_SYNC)
2815			*syncstate = 1;
2816		else
2817			*syncstate = 0;
2818		mtx_unlock(&softc->ctl_lock);
2819
2820		break;
2821	}
2822	case CTL_SETSYNC:
2823	case CTL_GETSYNC: {
2824		struct ctl_sync_info *sync_info;
2825		struct ctl_lun *lun;
2826
2827		sync_info = (struct ctl_sync_info *)addr;
2828
2829		mtx_lock(&softc->ctl_lock);
2830		lun = softc->ctl_luns[sync_info->lun_id];
2831		if (lun == NULL) {
2832			mtx_unlock(&softc->ctl_lock);
2833			sync_info->status = CTL_GS_SYNC_NO_LUN;
2834		}
2835		/*
2836		 * Get or set the sync interval.  We're not bounds checking
2837		 * in the set case, hopefully the user won't do something
2838		 * silly.
2839		 */
2840		mtx_lock(&lun->lun_lock);
2841		mtx_unlock(&softc->ctl_lock);
2842		if (cmd == CTL_GETSYNC)
2843			sync_info->sync_interval = lun->sync_interval;
2844		else
2845			lun->sync_interval = sync_info->sync_interval;
2846		mtx_unlock(&lun->lun_lock);
2847
2848		sync_info->status = CTL_GS_SYNC_OK;
2849
2850		break;
2851	}
2852	case CTL_GETSTATS: {
2853		struct ctl_stats *stats;
2854		struct ctl_lun *lun;
2855		int i;
2856
2857		stats = (struct ctl_stats *)addr;
2858
2859		if ((sizeof(struct ctl_lun_io_stats) * softc->num_luns) >
2860		     stats->alloc_len) {
2861			stats->status = CTL_SS_NEED_MORE_SPACE;
2862			stats->num_luns = softc->num_luns;
2863			break;
2864		}
2865		/*
2866		 * XXX KDM no locking here.  If the LUN list changes,
2867		 * things can blow up.
2868		 */
2869		for (i = 0, lun = STAILQ_FIRST(&softc->lun_list); lun != NULL;
2870		     i++, lun = STAILQ_NEXT(lun, links)) {
2871			retval = copyout(&lun->stats, &stats->lun_stats[i],
2872					 sizeof(lun->stats));
2873			if (retval != 0)
2874				break;
2875		}
2876		stats->num_luns = softc->num_luns;
2877		stats->fill_len = sizeof(struct ctl_lun_io_stats) *
2878				 softc->num_luns;
2879		stats->status = CTL_SS_OK;
2880#ifdef CTL_TIME_IO
2881		stats->flags = CTL_STATS_FLAG_TIME_VALID;
2882#else
2883		stats->flags = CTL_STATS_FLAG_NONE;
2884#endif
2885		getnanouptime(&stats->timestamp);
2886		break;
2887	}
2888	case CTL_ERROR_INJECT: {
2889		struct ctl_error_desc *err_desc, *new_err_desc;
2890		struct ctl_lun *lun;
2891
2892		err_desc = (struct ctl_error_desc *)addr;
2893
2894		new_err_desc = malloc(sizeof(*new_err_desc), M_CTL,
2895				      M_WAITOK | M_ZERO);
2896		bcopy(err_desc, new_err_desc, sizeof(*new_err_desc));
2897
2898		mtx_lock(&softc->ctl_lock);
2899		lun = softc->ctl_luns[err_desc->lun_id];
2900		if (lun == NULL) {
2901			mtx_unlock(&softc->ctl_lock);
2902			printf("%s: CTL_ERROR_INJECT: invalid LUN %ju\n",
2903			       __func__, (uintmax_t)err_desc->lun_id);
2904			retval = EINVAL;
2905			break;
2906		}
2907		mtx_lock(&lun->lun_lock);
2908		mtx_unlock(&softc->ctl_lock);
2909
2910		/*
2911		 * We could do some checking here to verify the validity
2912		 * of the request, but given the complexity of error
2913		 * injection requests, the checking logic would be fairly
2914		 * complex.
2915		 *
2916		 * For now, if the request is invalid, it just won't get
2917		 * executed and might get deleted.
2918		 */
2919		STAILQ_INSERT_TAIL(&lun->error_list, new_err_desc, links);
2920
2921		/*
2922		 * XXX KDM check to make sure the serial number is unique,
2923		 * in case we somehow manage to wrap.  That shouldn't
2924		 * happen for a very long time, but it's the right thing to
2925		 * do.
2926		 */
2927		new_err_desc->serial = lun->error_serial;
2928		err_desc->serial = lun->error_serial;
2929		lun->error_serial++;
2930
2931		mtx_unlock(&lun->lun_lock);
2932		break;
2933	}
2934	case CTL_ERROR_INJECT_DELETE: {
2935		struct ctl_error_desc *delete_desc, *desc, *desc2;
2936		struct ctl_lun *lun;
2937		int delete_done;
2938
2939		delete_desc = (struct ctl_error_desc *)addr;
2940		delete_done = 0;
2941
2942		mtx_lock(&softc->ctl_lock);
2943		lun = softc->ctl_luns[delete_desc->lun_id];
2944		if (lun == NULL) {
2945			mtx_unlock(&softc->ctl_lock);
2946			printf("%s: CTL_ERROR_INJECT_DELETE: invalid LUN %ju\n",
2947			       __func__, (uintmax_t)delete_desc->lun_id);
2948			retval = EINVAL;
2949			break;
2950		}
2951		mtx_lock(&lun->lun_lock);
2952		mtx_unlock(&softc->ctl_lock);
2953		STAILQ_FOREACH_SAFE(desc, &lun->error_list, links, desc2) {
2954			if (desc->serial != delete_desc->serial)
2955				continue;
2956
2957			STAILQ_REMOVE(&lun->error_list, desc, ctl_error_desc,
2958				      links);
2959			free(desc, M_CTL);
2960			delete_done = 1;
2961		}
2962		mtx_unlock(&lun->lun_lock);
2963		if (delete_done == 0) {
2964			printf("%s: CTL_ERROR_INJECT_DELETE: can't find "
2965			       "error serial %ju on LUN %u\n", __func__,
2966			       delete_desc->serial, delete_desc->lun_id);
2967			retval = EINVAL;
2968			break;
2969		}
2970		break;
2971	}
2972	case CTL_DUMP_STRUCTS: {
2973		int i, j, k, idx;
2974		struct ctl_port *port;
2975		struct ctl_frontend *fe;
2976
2977		mtx_lock(&softc->ctl_lock);
2978		printf("CTL Persistent Reservation information start:\n");
2979		for (i = 0; i < CTL_MAX_LUNS; i++) {
2980			struct ctl_lun *lun;
2981
2982			lun = softc->ctl_luns[i];
2983
2984			if ((lun == NULL)
2985			 || ((lun->flags & CTL_LUN_DISABLED) != 0))
2986				continue;
2987
2988			for (j = 0; j < (CTL_MAX_PORTS * 2); j++) {
2989				for (k = 0; k < CTL_MAX_INIT_PER_PORT; k++){
2990					idx = j * CTL_MAX_INIT_PER_PORT + k;
2991					if (lun->per_res[idx].registered == 0)
2992						continue;
2993					printf("  LUN %d port %d iid %d key "
2994					       "%#jx\n", i, j, k,
2995					       (uintmax_t)scsi_8btou64(
2996					       lun->per_res[idx].res_key.key));
2997				}
2998			}
2999		}
3000		printf("CTL Persistent Reservation information end\n");
3001		printf("CTL Ports:\n");
3002		STAILQ_FOREACH(port, &softc->port_list, links) {
3003			printf("  Port %d '%s' Frontend '%s' Type %u pp %d vp %d WWNN "
3004			       "%#jx WWPN %#jx\n", port->targ_port, port->port_name,
3005			       port->frontend->name, port->port_type,
3006			       port->physical_port, port->virtual_port,
3007			       (uintmax_t)port->wwnn, (uintmax_t)port->wwpn);
3008			for (j = 0; j < CTL_MAX_INIT_PER_PORT; j++) {
3009				if (port->wwpn_iid[j].in_use == 0 &&
3010				    port->wwpn_iid[j].wwpn == 0 &&
3011				    port->wwpn_iid[j].name == NULL)
3012					continue;
3013
3014				printf("    iid %u use %d WWPN %#jx '%s'\n",
3015				    j, port->wwpn_iid[j].in_use,
3016				    (uintmax_t)port->wwpn_iid[j].wwpn,
3017				    port->wwpn_iid[j].name);
3018			}
3019		}
3020		printf("CTL Port information end\n");
3021		mtx_unlock(&softc->ctl_lock);
3022		/*
3023		 * XXX KDM calling this without a lock.  We'd likely want
3024		 * to drop the lock before calling the frontend's dump
3025		 * routine anyway.
3026		 */
3027		printf("CTL Frontends:\n");
3028		STAILQ_FOREACH(fe, &softc->fe_list, links) {
3029			printf("  Frontend '%s'\n", fe->name);
3030			if (fe->fe_dump != NULL)
3031				fe->fe_dump();
3032		}
3033		printf("CTL Frontend information end\n");
3034		break;
3035	}
3036	case CTL_LUN_REQ: {
3037		struct ctl_lun_req *lun_req;
3038		struct ctl_backend_driver *backend;
3039
3040		lun_req = (struct ctl_lun_req *)addr;
3041
3042		backend = ctl_backend_find(lun_req->backend);
3043		if (backend == NULL) {
3044			lun_req->status = CTL_LUN_ERROR;
3045			snprintf(lun_req->error_str,
3046				 sizeof(lun_req->error_str),
3047				 "Backend \"%s\" not found.",
3048				 lun_req->backend);
3049			break;
3050		}
3051		if (lun_req->num_be_args > 0) {
3052			lun_req->kern_be_args = ctl_copyin_args(
3053				lun_req->num_be_args,
3054				lun_req->be_args,
3055				lun_req->error_str,
3056				sizeof(lun_req->error_str));
3057			if (lun_req->kern_be_args == NULL) {
3058				lun_req->status = CTL_LUN_ERROR;
3059				break;
3060			}
3061		}
3062
3063		retval = backend->ioctl(dev, cmd, addr, flag, td);
3064
3065		if (lun_req->num_be_args > 0) {
3066			ctl_copyout_args(lun_req->num_be_args,
3067				      lun_req->kern_be_args);
3068			ctl_free_args(lun_req->num_be_args,
3069				      lun_req->kern_be_args);
3070		}
3071		break;
3072	}
3073	case CTL_LUN_LIST: {
3074		struct sbuf *sb;
3075		struct ctl_lun *lun;
3076		struct ctl_lun_list *list;
3077		struct ctl_option *opt;
3078
3079		list = (struct ctl_lun_list *)addr;
3080
3081		/*
3082		 * Allocate a fixed length sbuf here, based on the length
3083		 * of the user's buffer.  We could allocate an auto-extending
3084		 * buffer, and then tell the user how much larger our
3085		 * amount of data is than his buffer, but that presents
3086		 * some problems:
3087		 *
3088		 * 1.  The sbuf(9) routines use a blocking malloc, and so
3089		 *     we can't hold a lock while calling them with an
3090		 *     auto-extending buffer.
3091 		 *
3092		 * 2.  There is not currently a LUN reference counting
3093		 *     mechanism, outside of outstanding transactions on
3094		 *     the LUN's OOA queue.  So a LUN could go away on us
3095		 *     while we're getting the LUN number, backend-specific
3096		 *     information, etc.  Thus, given the way things
3097		 *     currently work, we need to hold the CTL lock while
3098		 *     grabbing LUN information.
3099		 *
3100		 * So, from the user's standpoint, the best thing to do is
3101		 * allocate what he thinks is a reasonable buffer length,
3102		 * and then if he gets a CTL_LUN_LIST_NEED_MORE_SPACE error,
3103		 * double the buffer length and try again.  (And repeat
3104		 * that until he succeeds.)
3105		 */
3106		sb = sbuf_new(NULL, NULL, list->alloc_len, SBUF_FIXEDLEN);
3107		if (sb == NULL) {
3108			list->status = CTL_LUN_LIST_ERROR;
3109			snprintf(list->error_str, sizeof(list->error_str),
3110				 "Unable to allocate %d bytes for LUN list",
3111				 list->alloc_len);
3112			break;
3113		}
3114
3115		sbuf_printf(sb, "<ctllunlist>\n");
3116
3117		mtx_lock(&softc->ctl_lock);
3118		STAILQ_FOREACH(lun, &softc->lun_list, links) {
3119			mtx_lock(&lun->lun_lock);
3120			retval = sbuf_printf(sb, "<lun id=\"%ju\">\n",
3121					     (uintmax_t)lun->lun);
3122
3123			/*
3124			 * Bail out as soon as we see that we've overfilled
3125			 * the buffer.
3126			 */
3127			if (retval != 0)
3128				break;
3129
3130			retval = sbuf_printf(sb, "\t<backend_type>%s"
3131					     "</backend_type>\n",
3132					     (lun->backend == NULL) ?  "none" :
3133					     lun->backend->name);
3134
3135			if (retval != 0)
3136				break;
3137
3138			retval = sbuf_printf(sb, "\t<lun_type>%d</lun_type>\n",
3139					     lun->be_lun->lun_type);
3140
3141			if (retval != 0)
3142				break;
3143
3144			if (lun->backend == NULL) {
3145				retval = sbuf_printf(sb, "</lun>\n");
3146				if (retval != 0)
3147					break;
3148				continue;
3149			}
3150
3151			retval = sbuf_printf(sb, "\t<size>%ju</size>\n",
3152					     (lun->be_lun->maxlba > 0) ?
3153					     lun->be_lun->maxlba + 1 : 0);
3154
3155			if (retval != 0)
3156				break;
3157
3158			retval = sbuf_printf(sb, "\t<blocksize>%u</blocksize>\n",
3159					     lun->be_lun->blocksize);
3160
3161			if (retval != 0)
3162				break;
3163
3164			retval = sbuf_printf(sb, "\t<serial_number>");
3165
3166			if (retval != 0)
3167				break;
3168
3169			retval = ctl_sbuf_printf_esc(sb,
3170						     lun->be_lun->serial_num);
3171
3172			if (retval != 0)
3173				break;
3174
3175			retval = sbuf_printf(sb, "</serial_number>\n");
3176
3177			if (retval != 0)
3178				break;
3179
3180			retval = sbuf_printf(sb, "\t<device_id>");
3181
3182			if (retval != 0)
3183				break;
3184
3185			retval = ctl_sbuf_printf_esc(sb,lun->be_lun->device_id);
3186
3187			if (retval != 0)
3188				break;
3189
3190			retval = sbuf_printf(sb, "</device_id>\n");
3191
3192			if (retval != 0)
3193				break;
3194
3195			if (lun->backend->lun_info != NULL) {
3196				retval = lun->backend->lun_info(lun->be_lun->be_lun, sb);
3197				if (retval != 0)
3198					break;
3199			}
3200			STAILQ_FOREACH(opt, &lun->be_lun->options, links) {
3201				retval = sbuf_printf(sb, "\t<%s>%s</%s>\n",
3202				    opt->name, opt->value, opt->name);
3203				if (retval != 0)
3204					break;
3205			}
3206
3207			retval = sbuf_printf(sb, "</lun>\n");
3208
3209			if (retval != 0)
3210				break;
3211			mtx_unlock(&lun->lun_lock);
3212		}
3213		if (lun != NULL)
3214			mtx_unlock(&lun->lun_lock);
3215		mtx_unlock(&softc->ctl_lock);
3216
3217		if ((retval != 0)
3218		 || ((retval = sbuf_printf(sb, "</ctllunlist>\n")) != 0)) {
3219			retval = 0;
3220			sbuf_delete(sb);
3221			list->status = CTL_LUN_LIST_NEED_MORE_SPACE;
3222			snprintf(list->error_str, sizeof(list->error_str),
3223				 "Out of space, %d bytes is too small",
3224				 list->alloc_len);
3225			break;
3226		}
3227
3228		sbuf_finish(sb);
3229
3230		retval = copyout(sbuf_data(sb), list->lun_xml,
3231				 sbuf_len(sb) + 1);
3232
3233		list->fill_len = sbuf_len(sb) + 1;
3234		list->status = CTL_LUN_LIST_OK;
3235		sbuf_delete(sb);
3236		break;
3237	}
3238	case CTL_ISCSI: {
3239		struct ctl_iscsi *ci;
3240		struct ctl_frontend *fe;
3241
3242		ci = (struct ctl_iscsi *)addr;
3243
3244		fe = ctl_frontend_find("iscsi");
3245		if (fe == NULL) {
3246			ci->status = CTL_ISCSI_ERROR;
3247			snprintf(ci->error_str, sizeof(ci->error_str),
3248			    "Frontend \"iscsi\" not found.");
3249			break;
3250		}
3251
3252		retval = fe->ioctl(dev, cmd, addr, flag, td);
3253		break;
3254	}
3255	case CTL_PORT_REQ: {
3256		struct ctl_req *req;
3257		struct ctl_frontend *fe;
3258
3259		req = (struct ctl_req *)addr;
3260
3261		fe = ctl_frontend_find(req->driver);
3262		if (fe == NULL) {
3263			req->status = CTL_LUN_ERROR;
3264			snprintf(req->error_str, sizeof(req->error_str),
3265			    "Frontend \"%s\" not found.", req->driver);
3266			break;
3267		}
3268		if (req->num_args > 0) {
3269			req->kern_args = ctl_copyin_args(req->num_args,
3270			    req->args, req->error_str, sizeof(req->error_str));
3271			if (req->kern_args == NULL) {
3272				req->status = CTL_LUN_ERROR;
3273				break;
3274			}
3275		}
3276
3277		retval = fe->ioctl(dev, cmd, addr, flag, td);
3278
3279		if (req->num_args > 0) {
3280			ctl_copyout_args(req->num_args, req->kern_args);
3281			ctl_free_args(req->num_args, req->kern_args);
3282		}
3283		break;
3284	}
3285	case CTL_PORT_LIST: {
3286		struct sbuf *sb;
3287		struct ctl_port *port;
3288		struct ctl_lun_list *list;
3289		struct ctl_option *opt;
3290
3291		list = (struct ctl_lun_list *)addr;
3292
3293		sb = sbuf_new(NULL, NULL, list->alloc_len, SBUF_FIXEDLEN);
3294		if (sb == NULL) {
3295			list->status = CTL_LUN_LIST_ERROR;
3296			snprintf(list->error_str, sizeof(list->error_str),
3297				 "Unable to allocate %d bytes for LUN list",
3298				 list->alloc_len);
3299			break;
3300		}
3301
3302		sbuf_printf(sb, "<ctlportlist>\n");
3303
3304		mtx_lock(&softc->ctl_lock);
3305		STAILQ_FOREACH(port, &softc->port_list, links) {
3306			retval = sbuf_printf(sb, "<targ_port id=\"%ju\">\n",
3307					     (uintmax_t)port->targ_port);
3308
3309			/*
3310			 * Bail out as soon as we see that we've overfilled
3311			 * the buffer.
3312			 */
3313			if (retval != 0)
3314				break;
3315
3316			retval = sbuf_printf(sb, "\t<frontend_type>%s"
3317			    "</frontend_type>\n", port->frontend->name);
3318			if (retval != 0)
3319				break;
3320
3321			retval = sbuf_printf(sb, "\t<port_type>%d</port_type>\n",
3322					     port->port_type);
3323			if (retval != 0)
3324				break;
3325
3326			retval = sbuf_printf(sb, "\t<online>%s</online>\n",
3327			    (port->status & CTL_PORT_STATUS_ONLINE) ? "YES" : "NO");
3328			if (retval != 0)
3329				break;
3330
3331			retval = sbuf_printf(sb, "\t<port_name>%s</port_name>\n",
3332			    port->port_name);
3333			if (retval != 0)
3334				break;
3335
3336			retval = sbuf_printf(sb, "\t<physical_port>%d</physical_port>\n",
3337			    port->physical_port);
3338			if (retval != 0)
3339				break;
3340
3341			retval = sbuf_printf(sb, "\t<virtual_port>%d</virtual_port>\n",
3342			    port->virtual_port);
3343			if (retval != 0)
3344				break;
3345
3346			retval = sbuf_printf(sb, "\t<wwnn>%#jx</wwnn>\n",
3347			    (uintmax_t)port->wwnn);
3348			if (retval != 0)
3349				break;
3350
3351			retval = sbuf_printf(sb, "\t<wwpn>%#jx</wwpn>\n",
3352			    (uintmax_t)port->wwpn);
3353			if (retval != 0)
3354				break;
3355
3356			if (port->port_info != NULL) {
3357				retval = port->port_info(port->onoff_arg, sb);
3358				if (retval != 0)
3359					break;
3360			}
3361			STAILQ_FOREACH(opt, &port->options, links) {
3362				retval = sbuf_printf(sb, "\t<%s>%s</%s>\n",
3363				    opt->name, opt->value, opt->name);
3364				if (retval != 0)
3365					break;
3366			}
3367
3368			retval = sbuf_printf(sb, "</targ_port>\n");
3369			if (retval != 0)
3370				break;
3371		}
3372		mtx_unlock(&softc->ctl_lock);
3373
3374		if ((retval != 0)
3375		 || ((retval = sbuf_printf(sb, "</ctlportlist>\n")) != 0)) {
3376			retval = 0;
3377			sbuf_delete(sb);
3378			list->status = CTL_LUN_LIST_NEED_MORE_SPACE;
3379			snprintf(list->error_str, sizeof(list->error_str),
3380				 "Out of space, %d bytes is too small",
3381				 list->alloc_len);
3382			break;
3383		}
3384
3385		sbuf_finish(sb);
3386
3387		retval = copyout(sbuf_data(sb), list->lun_xml,
3388				 sbuf_len(sb) + 1);
3389
3390		list->fill_len = sbuf_len(sb) + 1;
3391		list->status = CTL_LUN_LIST_OK;
3392		sbuf_delete(sb);
3393		break;
3394	}
3395	default: {
3396		/* XXX KDM should we fix this? */
3397#if 0
3398		struct ctl_backend_driver *backend;
3399		unsigned int type;
3400		int found;
3401
3402		found = 0;
3403
3404		/*
3405		 * We encode the backend type as the ioctl type for backend
3406		 * ioctls.  So parse it out here, and then search for a
3407		 * backend of this type.
3408		 */
3409		type = _IOC_TYPE(cmd);
3410
3411		STAILQ_FOREACH(backend, &softc->be_list, links) {
3412			if (backend->type == type) {
3413				found = 1;
3414				break;
3415			}
3416		}
3417		if (found == 0) {
3418			printf("ctl: unknown ioctl command %#lx or backend "
3419			       "%d\n", cmd, type);
3420			retval = EINVAL;
3421			break;
3422		}
3423		retval = backend->ioctl(dev, cmd, addr, flag, td);
3424#endif
3425		retval = ENOTTY;
3426		break;
3427	}
3428	}
3429	return (retval);
3430}
3431
3432uint32_t
3433ctl_get_initindex(struct ctl_nexus *nexus)
3434{
3435	if (nexus->targ_port < CTL_MAX_PORTS)
3436		return (nexus->initid.id +
3437			(nexus->targ_port * CTL_MAX_INIT_PER_PORT));
3438	else
3439		return (nexus->initid.id +
3440		       ((nexus->targ_port - CTL_MAX_PORTS) *
3441			CTL_MAX_INIT_PER_PORT));
3442}
3443
3444uint32_t
3445ctl_get_resindex(struct ctl_nexus *nexus)
3446{
3447	return (nexus->initid.id + (nexus->targ_port * CTL_MAX_INIT_PER_PORT));
3448}
3449
3450uint32_t
3451ctl_port_idx(int port_num)
3452{
3453	if (port_num < CTL_MAX_PORTS)
3454		return(port_num);
3455	else
3456		return(port_num - CTL_MAX_PORTS);
3457}
3458
3459static uint32_t
3460ctl_map_lun(int port_num, uint32_t lun_id)
3461{
3462	struct ctl_port *port;
3463
3464	port = control_softc->ctl_ports[ctl_port_idx(port_num)];
3465	if (port == NULL)
3466		return (UINT32_MAX);
3467	if (port->lun_map == NULL)
3468		return (lun_id);
3469	return (port->lun_map(port->targ_lun_arg, lun_id));
3470}
3471
3472static uint32_t
3473ctl_map_lun_back(int port_num, uint32_t lun_id)
3474{
3475	struct ctl_port *port;
3476	uint32_t i;
3477
3478	port = control_softc->ctl_ports[ctl_port_idx(port_num)];
3479	if (port->lun_map == NULL)
3480		return (lun_id);
3481	for (i = 0; i < CTL_MAX_LUNS; i++) {
3482		if (port->lun_map(port->targ_lun_arg, i) == lun_id)
3483			return (i);
3484	}
3485	return (UINT32_MAX);
3486}
3487
3488/*
3489 * Note:  This only works for bitmask sizes that are at least 32 bits, and
3490 * that are a power of 2.
3491 */
3492int
3493ctl_ffz(uint32_t *mask, uint32_t size)
3494{
3495	uint32_t num_chunks, num_pieces;
3496	int i, j;
3497
3498	num_chunks = (size >> 5);
3499	if (num_chunks == 0)
3500		num_chunks++;
3501	num_pieces = ctl_min((sizeof(uint32_t) * 8), size);
3502
3503	for (i = 0; i < num_chunks; i++) {
3504		for (j = 0; j < num_pieces; j++) {
3505			if ((mask[i] & (1 << j)) == 0)
3506				return ((i << 5) + j);
3507		}
3508	}
3509
3510	return (-1);
3511}
3512
3513int
3514ctl_set_mask(uint32_t *mask, uint32_t bit)
3515{
3516	uint32_t chunk, piece;
3517
3518	chunk = bit >> 5;
3519	piece = bit % (sizeof(uint32_t) * 8);
3520
3521	if ((mask[chunk] & (1 << piece)) != 0)
3522		return (-1);
3523	else
3524		mask[chunk] |= (1 << piece);
3525
3526	return (0);
3527}
3528
3529int
3530ctl_clear_mask(uint32_t *mask, uint32_t bit)
3531{
3532	uint32_t chunk, piece;
3533
3534	chunk = bit >> 5;
3535	piece = bit % (sizeof(uint32_t) * 8);
3536
3537	if ((mask[chunk] & (1 << piece)) == 0)
3538		return (-1);
3539	else
3540		mask[chunk] &= ~(1 << piece);
3541
3542	return (0);
3543}
3544
3545int
3546ctl_is_set(uint32_t *mask, uint32_t bit)
3547{
3548	uint32_t chunk, piece;
3549
3550	chunk = bit >> 5;
3551	piece = bit % (sizeof(uint32_t) * 8);
3552
3553	if ((mask[chunk] & (1 << piece)) == 0)
3554		return (0);
3555	else
3556		return (1);
3557}
3558
3559#ifdef unused
3560/*
3561 * The bus, target and lun are optional, they can be filled in later.
3562 * can_wait is used to determine whether we can wait on the malloc or not.
3563 */
3564union ctl_io*
3565ctl_malloc_io(ctl_io_type io_type, uint32_t targ_port, uint32_t targ_target,
3566	      uint32_t targ_lun, int can_wait)
3567{
3568	union ctl_io *io;
3569
3570	if (can_wait)
3571		io = (union ctl_io *)malloc(sizeof(*io), M_CTL, M_WAITOK);
3572	else
3573		io = (union ctl_io *)malloc(sizeof(*io), M_CTL, M_NOWAIT);
3574
3575	if (io != NULL) {
3576		io->io_hdr.io_type = io_type;
3577		io->io_hdr.targ_port = targ_port;
3578		/*
3579		 * XXX KDM this needs to change/go away.  We need to move
3580		 * to a preallocated pool of ctl_scsiio structures.
3581		 */
3582		io->io_hdr.nexus.targ_target.id = targ_target;
3583		io->io_hdr.nexus.targ_lun = targ_lun;
3584	}
3585
3586	return (io);
3587}
3588
3589void
3590ctl_kfree_io(union ctl_io *io)
3591{
3592	free(io, M_CTL);
3593}
3594#endif /* unused */
3595
3596/*
3597 * ctl_softc, pool_type, total_ctl_io are passed in.
3598 * npool is passed out.
3599 */
3600int
3601ctl_pool_create(struct ctl_softc *ctl_softc, ctl_pool_type pool_type,
3602		uint32_t total_ctl_io, struct ctl_io_pool **npool)
3603{
3604	uint32_t i;
3605	union ctl_io *cur_io, *next_io;
3606	struct ctl_io_pool *pool;
3607	int retval;
3608
3609	retval = 0;
3610
3611	pool = (struct ctl_io_pool *)malloc(sizeof(*pool), M_CTL,
3612					    M_NOWAIT | M_ZERO);
3613	if (pool == NULL) {
3614		retval = ENOMEM;
3615		goto bailout;
3616	}
3617
3618	pool->type = pool_type;
3619	pool->ctl_softc = ctl_softc;
3620
3621	mtx_lock(&ctl_softc->pool_lock);
3622	pool->id = ctl_softc->cur_pool_id++;
3623	mtx_unlock(&ctl_softc->pool_lock);
3624
3625	pool->flags = CTL_POOL_FLAG_NONE;
3626	pool->refcount = 1;		/* Reference for validity. */
3627	STAILQ_INIT(&pool->free_queue);
3628
3629	/*
3630	 * XXX KDM other options here:
3631	 * - allocate a page at a time
3632	 * - allocate one big chunk of memory.
3633	 * Page allocation might work well, but would take a little more
3634	 * tracking.
3635	 */
3636	for (i = 0; i < total_ctl_io; i++) {
3637		cur_io = (union ctl_io *)malloc(sizeof(*cur_io), M_CTLIO,
3638						M_NOWAIT);
3639		if (cur_io == NULL) {
3640			retval = ENOMEM;
3641			break;
3642		}
3643		cur_io->io_hdr.pool = pool;
3644		STAILQ_INSERT_TAIL(&pool->free_queue, &cur_io->io_hdr, links);
3645		pool->total_ctl_io++;
3646		pool->free_ctl_io++;
3647	}
3648
3649	if (retval != 0) {
3650		for (cur_io = (union ctl_io *)STAILQ_FIRST(&pool->free_queue);
3651		     cur_io != NULL; cur_io = next_io) {
3652			next_io = (union ctl_io *)STAILQ_NEXT(&cur_io->io_hdr,
3653							      links);
3654			STAILQ_REMOVE(&pool->free_queue, &cur_io->io_hdr,
3655				      ctl_io_hdr, links);
3656			free(cur_io, M_CTLIO);
3657		}
3658
3659		free(pool, M_CTL);
3660		goto bailout;
3661	}
3662	mtx_lock(&ctl_softc->pool_lock);
3663	ctl_softc->num_pools++;
3664	STAILQ_INSERT_TAIL(&ctl_softc->io_pools, pool, links);
3665	/*
3666	 * Increment our usage count if this is an external consumer, so we
3667	 * can't get unloaded until the external consumer (most likely a
3668	 * FETD) unloads and frees his pool.
3669	 *
3670	 * XXX KDM will this increment the caller's module use count, or
3671	 * mine?
3672	 */
3673#if 0
3674	if ((pool_type != CTL_POOL_EMERGENCY)
3675	 && (pool_type != CTL_POOL_INTERNAL)
3676	 && (pool_type != CTL_POOL_4OTHERSC))
3677		MOD_INC_USE_COUNT;
3678#endif
3679
3680	mtx_unlock(&ctl_softc->pool_lock);
3681
3682	*npool = pool;
3683
3684bailout:
3685
3686	return (retval);
3687}
3688
3689static int
3690ctl_pool_acquire(struct ctl_io_pool *pool)
3691{
3692
3693	mtx_assert(&pool->ctl_softc->pool_lock, MA_OWNED);
3694
3695	if (pool->flags & CTL_POOL_FLAG_INVALID)
3696		return (EINVAL);
3697
3698	pool->refcount++;
3699
3700	return (0);
3701}
3702
3703static void
3704ctl_pool_release(struct ctl_io_pool *pool)
3705{
3706	struct ctl_softc *ctl_softc = pool->ctl_softc;
3707	union ctl_io *io;
3708
3709	mtx_assert(&ctl_softc->pool_lock, MA_OWNED);
3710
3711	if (--pool->refcount != 0)
3712		return;
3713
3714	while ((io = (union ctl_io *)STAILQ_FIRST(&pool->free_queue)) != NULL) {
3715		STAILQ_REMOVE(&pool->free_queue, &io->io_hdr, ctl_io_hdr,
3716			      links);
3717		free(io, M_CTLIO);
3718	}
3719
3720	STAILQ_REMOVE(&ctl_softc->io_pools, pool, ctl_io_pool, links);
3721	ctl_softc->num_pools--;
3722
3723	/*
3724	 * XXX KDM will this decrement the caller's usage count or mine?
3725	 */
3726#if 0
3727	if ((pool->type != CTL_POOL_EMERGENCY)
3728	 && (pool->type != CTL_POOL_INTERNAL)
3729	 && (pool->type != CTL_POOL_4OTHERSC))
3730		MOD_DEC_USE_COUNT;
3731#endif
3732
3733	free(pool, M_CTL);
3734}
3735
3736void
3737ctl_pool_free(struct ctl_io_pool *pool)
3738{
3739	struct ctl_softc *ctl_softc;
3740
3741	if (pool == NULL)
3742		return;
3743
3744	ctl_softc = pool->ctl_softc;
3745	mtx_lock(&ctl_softc->pool_lock);
3746	pool->flags |= CTL_POOL_FLAG_INVALID;
3747	ctl_pool_release(pool);
3748	mtx_unlock(&ctl_softc->pool_lock);
3749}
3750
3751/*
3752 * This routine does not block (except for spinlocks of course).
3753 * It tries to allocate a ctl_io union from the caller's pool as quickly as
3754 * possible.
3755 */
3756union ctl_io *
3757ctl_alloc_io(void *pool_ref)
3758{
3759	union ctl_io *io;
3760	struct ctl_softc *ctl_softc;
3761	struct ctl_io_pool *pool, *npool;
3762	struct ctl_io_pool *emergency_pool;
3763
3764	pool = (struct ctl_io_pool *)pool_ref;
3765
3766	if (pool == NULL) {
3767		printf("%s: pool is NULL\n", __func__);
3768		return (NULL);
3769	}
3770
3771	emergency_pool = NULL;
3772
3773	ctl_softc = pool->ctl_softc;
3774
3775	mtx_lock(&ctl_softc->pool_lock);
3776	/*
3777	 * First, try to get the io structure from the user's pool.
3778	 */
3779	if (ctl_pool_acquire(pool) == 0) {
3780		io = (union ctl_io *)STAILQ_FIRST(&pool->free_queue);
3781		if (io != NULL) {
3782			STAILQ_REMOVE_HEAD(&pool->free_queue, links);
3783			pool->total_allocated++;
3784			pool->free_ctl_io--;
3785			mtx_unlock(&ctl_softc->pool_lock);
3786			return (io);
3787		} else
3788			ctl_pool_release(pool);
3789	}
3790	/*
3791	 * If he doesn't have any io structures left, search for an
3792	 * emergency pool and grab one from there.
3793	 */
3794	STAILQ_FOREACH(npool, &ctl_softc->io_pools, links) {
3795		if (npool->type != CTL_POOL_EMERGENCY)
3796			continue;
3797
3798		if (ctl_pool_acquire(npool) != 0)
3799			continue;
3800
3801		emergency_pool = npool;
3802
3803		io = (union ctl_io *)STAILQ_FIRST(&npool->free_queue);
3804		if (io != NULL) {
3805			STAILQ_REMOVE_HEAD(&npool->free_queue, links);
3806			npool->total_allocated++;
3807			npool->free_ctl_io--;
3808			mtx_unlock(&ctl_softc->pool_lock);
3809			return (io);
3810		} else
3811			ctl_pool_release(npool);
3812	}
3813
3814	/* Drop the spinlock before we malloc */
3815	mtx_unlock(&ctl_softc->pool_lock);
3816
3817	/*
3818	 * The emergency pool (if it exists) didn't have one, so try an
3819	 * atomic (i.e. nonblocking) malloc and see if we get lucky.
3820	 */
3821	io = (union ctl_io *)malloc(sizeof(*io), M_CTLIO, M_NOWAIT);
3822	if (io != NULL) {
3823		/*
3824		 * If the emergency pool exists but is empty, add this
3825		 * ctl_io to its list when it gets freed.
3826		 */
3827		if (emergency_pool != NULL) {
3828			mtx_lock(&ctl_softc->pool_lock);
3829			if (ctl_pool_acquire(emergency_pool) == 0) {
3830				io->io_hdr.pool = emergency_pool;
3831				emergency_pool->total_ctl_io++;
3832				/*
3833				 * Need to bump this, otherwise
3834				 * total_allocated and total_freed won't
3835				 * match when we no longer have anything
3836				 * outstanding.
3837				 */
3838				emergency_pool->total_allocated++;
3839			}
3840			mtx_unlock(&ctl_softc->pool_lock);
3841		} else
3842			io->io_hdr.pool = NULL;
3843	}
3844
3845	return (io);
3846}
3847
3848void
3849ctl_free_io(union ctl_io *io)
3850{
3851	if (io == NULL)
3852		return;
3853
3854	/*
3855	 * If this ctl_io has a pool, return it to that pool.
3856	 */
3857	if (io->io_hdr.pool != NULL) {
3858		struct ctl_io_pool *pool;
3859
3860		pool = (struct ctl_io_pool *)io->io_hdr.pool;
3861		mtx_lock(&pool->ctl_softc->pool_lock);
3862		io->io_hdr.io_type = 0xff;
3863		STAILQ_INSERT_TAIL(&pool->free_queue, &io->io_hdr, links);
3864		pool->total_freed++;
3865		pool->free_ctl_io++;
3866		ctl_pool_release(pool);
3867		mtx_unlock(&pool->ctl_softc->pool_lock);
3868	} else {
3869		/*
3870		 * Otherwise, just free it.  We probably malloced it and
3871		 * the emergency pool wasn't available.
3872		 */
3873		free(io, M_CTLIO);
3874	}
3875
3876}
3877
3878void
3879ctl_zero_io(union ctl_io *io)
3880{
3881	void *pool_ref;
3882
3883	if (io == NULL)
3884		return;
3885
3886	/*
3887	 * May need to preserve linked list pointers at some point too.
3888	 */
3889	pool_ref = io->io_hdr.pool;
3890
3891	memset(io, 0, sizeof(*io));
3892
3893	io->io_hdr.pool = pool_ref;
3894}
3895
3896/*
3897 * This routine is currently used for internal copies of ctl_ios that need
3898 * to persist for some reason after we've already returned status to the
3899 * FETD.  (Thus the flag set.)
3900 *
3901 * XXX XXX
3902 * Note that this makes a blind copy of all fields in the ctl_io, except
3903 * for the pool reference.  This includes any memory that has been
3904 * allocated!  That memory will no longer be valid after done has been
3905 * called, so this would be VERY DANGEROUS for command that actually does
3906 * any reads or writes.  Right now (11/7/2005), this is only used for immediate
3907 * start and stop commands, which don't transfer any data, so this is not a
3908 * problem.  If it is used for anything else, the caller would also need to
3909 * allocate data buffer space and this routine would need to be modified to
3910 * copy the data buffer(s) as well.
3911 */
3912void
3913ctl_copy_io(union ctl_io *src, union ctl_io *dest)
3914{
3915	void *pool_ref;
3916
3917	if ((src == NULL)
3918	 || (dest == NULL))
3919		return;
3920
3921	/*
3922	 * May need to preserve linked list pointers at some point too.
3923	 */
3924	pool_ref = dest->io_hdr.pool;
3925
3926	memcpy(dest, src, ctl_min(sizeof(*src), sizeof(*dest)));
3927
3928	dest->io_hdr.pool = pool_ref;
3929	/*
3930	 * We need to know that this is an internal copy, and doesn't need
3931	 * to get passed back to the FETD that allocated it.
3932	 */
3933	dest->io_hdr.flags |= CTL_FLAG_INT_COPY;
3934}
3935
3936#ifdef NEEDTOPORT
3937static void
3938ctl_update_power_subpage(struct copan_power_subpage *page)
3939{
3940	int num_luns, num_partitions, config_type;
3941	struct ctl_softc *softc;
3942	cs_BOOL_t aor_present, shelf_50pct_power;
3943	cs_raidset_personality_t rs_type;
3944	int max_active_luns;
3945
3946	softc = control_softc;
3947
3948	/* subtract out the processor LUN */
3949	num_luns = softc->num_luns - 1;
3950	/*
3951	 * Default to 7 LUNs active, which was the only number we allowed
3952	 * in the past.
3953	 */
3954	max_active_luns = 7;
3955
3956	num_partitions = config_GetRsPartitionInfo();
3957	config_type = config_GetConfigType();
3958	shelf_50pct_power = config_GetShelfPowerMode();
3959	aor_present = config_IsAorRsPresent();
3960
3961	rs_type = ddb_GetRsRaidType(1);
3962	if ((rs_type != CS_RAIDSET_PERSONALITY_RAID5)
3963	 && (rs_type != CS_RAIDSET_PERSONALITY_RAID1)) {
3964		EPRINT(0, "Unsupported RS type %d!", rs_type);
3965	}
3966
3967
3968	page->total_luns = num_luns;
3969
3970	switch (config_type) {
3971	case 40:
3972		/*
3973		 * In a 40 drive configuration, it doesn't matter what DC
3974		 * cards we have, whether we have AOR enabled or not,
3975		 * partitioning or not, or what type of RAIDset we have.
3976		 * In that scenario, we can power up every LUN we present
3977		 * to the user.
3978		 */
3979		max_active_luns = num_luns;
3980
3981		break;
3982	case 64:
3983		if (shelf_50pct_power == CS_FALSE) {
3984			/* 25% power */
3985			if (aor_present == CS_TRUE) {
3986				if (rs_type ==
3987				     CS_RAIDSET_PERSONALITY_RAID5) {
3988					max_active_luns = 7;
3989				} else if (rs_type ==
3990					 CS_RAIDSET_PERSONALITY_RAID1){
3991					max_active_luns = 14;
3992				} else {
3993					/* XXX KDM now what?? */
3994				}
3995			} else {
3996				if (rs_type ==
3997				     CS_RAIDSET_PERSONALITY_RAID5) {
3998					max_active_luns = 8;
3999				} else if (rs_type ==
4000					 CS_RAIDSET_PERSONALITY_RAID1){
4001					max_active_luns = 16;
4002				} else {
4003					/* XXX KDM now what?? */
4004				}
4005			}
4006		} else {
4007			/* 50% power */
4008			/*
4009			 * With 50% power in a 64 drive configuration, we
4010			 * can power all LUNs we present.
4011			 */
4012			max_active_luns = num_luns;
4013		}
4014		break;
4015	case 112:
4016		if (shelf_50pct_power == CS_FALSE) {
4017			/* 25% power */
4018			if (aor_present == CS_TRUE) {
4019				if (rs_type ==
4020				     CS_RAIDSET_PERSONALITY_RAID5) {
4021					max_active_luns = 7;
4022				} else if (rs_type ==
4023					 CS_RAIDSET_PERSONALITY_RAID1){
4024					max_active_luns = 14;
4025				} else {
4026					/* XXX KDM now what?? */
4027				}
4028			} else {
4029				if (rs_type ==
4030				     CS_RAIDSET_PERSONALITY_RAID5) {
4031					max_active_luns = 8;
4032				} else if (rs_type ==
4033					 CS_RAIDSET_PERSONALITY_RAID1){
4034					max_active_luns = 16;
4035				} else {
4036					/* XXX KDM now what?? */
4037				}
4038			}
4039		} else {
4040			/* 50% power */
4041			if (aor_present == CS_TRUE) {
4042				if (rs_type ==
4043				     CS_RAIDSET_PERSONALITY_RAID5) {
4044					max_active_luns = 14;
4045				} else if (rs_type ==
4046					 CS_RAIDSET_PERSONALITY_RAID1){
4047					/*
4048					 * We're assuming here that disk
4049					 * caching is enabled, and so we're
4050					 * able to power up half of each
4051					 * LUN, and cache all writes.
4052					 */
4053					max_active_luns = num_luns;
4054				} else {
4055					/* XXX KDM now what?? */
4056				}
4057			} else {
4058				if (rs_type ==
4059				     CS_RAIDSET_PERSONALITY_RAID5) {
4060					max_active_luns = 15;
4061				} else if (rs_type ==
4062					 CS_RAIDSET_PERSONALITY_RAID1){
4063					max_active_luns = 30;
4064				} else {
4065					/* XXX KDM now what?? */
4066				}
4067			}
4068		}
4069		break;
4070	default:
4071		/*
4072		 * In this case, we have an unknown configuration, so we
4073		 * just use the default from above.
4074		 */
4075		break;
4076	}
4077
4078	page->max_active_luns = max_active_luns;
4079#if 0
4080	printk("%s: total_luns = %d, max_active_luns = %d\n", __func__,
4081	       page->total_luns, page->max_active_luns);
4082#endif
4083}
4084#endif /* NEEDTOPORT */
4085
4086/*
4087 * This routine could be used in the future to load default and/or saved
4088 * mode page parameters for a particuar lun.
4089 */
4090static int
4091ctl_init_page_index(struct ctl_lun *lun)
4092{
4093	int i;
4094	struct ctl_page_index *page_index;
4095	struct ctl_softc *softc;
4096
4097	memcpy(&lun->mode_pages.index, page_index_template,
4098	       sizeof(page_index_template));
4099
4100	softc = lun->ctl_softc;
4101
4102	for (i = 0; i < CTL_NUM_MODE_PAGES; i++) {
4103
4104		page_index = &lun->mode_pages.index[i];
4105		/*
4106		 * If this is a disk-only mode page, there's no point in
4107		 * setting it up.  For some pages, we have to have some
4108		 * basic information about the disk in order to calculate the
4109		 * mode page data.
4110		 */
4111		if ((lun->be_lun->lun_type != T_DIRECT)
4112		 && (page_index->page_flags & CTL_PAGE_FLAG_DISK_ONLY))
4113			continue;
4114
4115		switch (page_index->page_code & SMPH_PC_MASK) {
4116		case SMS_FORMAT_DEVICE_PAGE: {
4117			struct scsi_format_page *format_page;
4118
4119			if (page_index->subpage != SMS_SUBPAGE_PAGE_0)
4120				panic("subpage is incorrect!");
4121
4122			/*
4123			 * Sectors per track are set above.  Bytes per
4124			 * sector need to be set here on a per-LUN basis.
4125			 */
4126			memcpy(&lun->mode_pages.format_page[CTL_PAGE_CURRENT],
4127			       &format_page_default,
4128			       sizeof(format_page_default));
4129			memcpy(&lun->mode_pages.format_page[
4130			       CTL_PAGE_CHANGEABLE], &format_page_changeable,
4131			       sizeof(format_page_changeable));
4132			memcpy(&lun->mode_pages.format_page[CTL_PAGE_DEFAULT],
4133			       &format_page_default,
4134			       sizeof(format_page_default));
4135			memcpy(&lun->mode_pages.format_page[CTL_PAGE_SAVED],
4136			       &format_page_default,
4137			       sizeof(format_page_default));
4138
4139			format_page = &lun->mode_pages.format_page[
4140				CTL_PAGE_CURRENT];
4141			scsi_ulto2b(lun->be_lun->blocksize,
4142				    format_page->bytes_per_sector);
4143
4144			format_page = &lun->mode_pages.format_page[
4145				CTL_PAGE_DEFAULT];
4146			scsi_ulto2b(lun->be_lun->blocksize,
4147				    format_page->bytes_per_sector);
4148
4149			format_page = &lun->mode_pages.format_page[
4150				CTL_PAGE_SAVED];
4151			scsi_ulto2b(lun->be_lun->blocksize,
4152				    format_page->bytes_per_sector);
4153
4154			page_index->page_data =
4155				(uint8_t *)lun->mode_pages.format_page;
4156			break;
4157		}
4158		case SMS_RIGID_DISK_PAGE: {
4159			struct scsi_rigid_disk_page *rigid_disk_page;
4160			uint32_t sectors_per_cylinder;
4161			uint64_t cylinders;
4162#ifndef	__XSCALE__
4163			int shift;
4164#endif /* !__XSCALE__ */
4165
4166			if (page_index->subpage != SMS_SUBPAGE_PAGE_0)
4167				panic("invalid subpage value %d",
4168				      page_index->subpage);
4169
4170			/*
4171			 * Rotation rate and sectors per track are set
4172			 * above.  We calculate the cylinders here based on
4173			 * capacity.  Due to the number of heads and
4174			 * sectors per track we're using, smaller arrays
4175			 * may turn out to have 0 cylinders.  Linux and
4176			 * FreeBSD don't pay attention to these mode pages
4177			 * to figure out capacity, but Solaris does.  It
4178			 * seems to deal with 0 cylinders just fine, and
4179			 * works out a fake geometry based on the capacity.
4180			 */
4181			memcpy(&lun->mode_pages.rigid_disk_page[
4182			       CTL_PAGE_CURRENT], &rigid_disk_page_default,
4183			       sizeof(rigid_disk_page_default));
4184			memcpy(&lun->mode_pages.rigid_disk_page[
4185			       CTL_PAGE_CHANGEABLE],&rigid_disk_page_changeable,
4186			       sizeof(rigid_disk_page_changeable));
4187			memcpy(&lun->mode_pages.rigid_disk_page[
4188			       CTL_PAGE_DEFAULT], &rigid_disk_page_default,
4189			       sizeof(rigid_disk_page_default));
4190			memcpy(&lun->mode_pages.rigid_disk_page[
4191			       CTL_PAGE_SAVED], &rigid_disk_page_default,
4192			       sizeof(rigid_disk_page_default));
4193
4194			sectors_per_cylinder = CTL_DEFAULT_SECTORS_PER_TRACK *
4195				CTL_DEFAULT_HEADS;
4196
4197			/*
4198			 * The divide method here will be more accurate,
4199			 * probably, but results in floating point being
4200			 * used in the kernel on i386 (__udivdi3()).  On the
4201			 * XScale, though, __udivdi3() is implemented in
4202			 * software.
4203			 *
4204			 * The shift method for cylinder calculation is
4205			 * accurate if sectors_per_cylinder is a power of
4206			 * 2.  Otherwise it might be slightly off -- you
4207			 * might have a bit of a truncation problem.
4208			 */
4209#ifdef	__XSCALE__
4210			cylinders = (lun->be_lun->maxlba + 1) /
4211				sectors_per_cylinder;
4212#else
4213			for (shift = 31; shift > 0; shift--) {
4214				if (sectors_per_cylinder & (1 << shift))
4215					break;
4216			}
4217			cylinders = (lun->be_lun->maxlba + 1) >> shift;
4218#endif
4219
4220			/*
4221			 * We've basically got 3 bytes, or 24 bits for the
4222			 * cylinder size in the mode page.  If we're over,
4223			 * just round down to 2^24.
4224			 */
4225			if (cylinders > 0xffffff)
4226				cylinders = 0xffffff;
4227
4228			rigid_disk_page = &lun->mode_pages.rigid_disk_page[
4229				CTL_PAGE_CURRENT];
4230			scsi_ulto3b(cylinders, rigid_disk_page->cylinders);
4231
4232			rigid_disk_page = &lun->mode_pages.rigid_disk_page[
4233				CTL_PAGE_DEFAULT];
4234			scsi_ulto3b(cylinders, rigid_disk_page->cylinders);
4235
4236			rigid_disk_page = &lun->mode_pages.rigid_disk_page[
4237				CTL_PAGE_SAVED];
4238			scsi_ulto3b(cylinders, rigid_disk_page->cylinders);
4239
4240			page_index->page_data =
4241				(uint8_t *)lun->mode_pages.rigid_disk_page;
4242			break;
4243		}
4244		case SMS_CACHING_PAGE: {
4245
4246			if (page_index->subpage != SMS_SUBPAGE_PAGE_0)
4247				panic("invalid subpage value %d",
4248				      page_index->subpage);
4249			/*
4250			 * Defaults should be okay here, no calculations
4251			 * needed.
4252			 */
4253			memcpy(&lun->mode_pages.caching_page[CTL_PAGE_CURRENT],
4254			       &caching_page_default,
4255			       sizeof(caching_page_default));
4256			memcpy(&lun->mode_pages.caching_page[
4257			       CTL_PAGE_CHANGEABLE], &caching_page_changeable,
4258			       sizeof(caching_page_changeable));
4259			memcpy(&lun->mode_pages.caching_page[CTL_PAGE_DEFAULT],
4260			       &caching_page_default,
4261			       sizeof(caching_page_default));
4262			memcpy(&lun->mode_pages.caching_page[CTL_PAGE_SAVED],
4263			       &caching_page_default,
4264			       sizeof(caching_page_default));
4265			page_index->page_data =
4266				(uint8_t *)lun->mode_pages.caching_page;
4267			break;
4268		}
4269		case SMS_CONTROL_MODE_PAGE: {
4270
4271			if (page_index->subpage != SMS_SUBPAGE_PAGE_0)
4272				panic("invalid subpage value %d",
4273				      page_index->subpage);
4274
4275			/*
4276			 * Defaults should be okay here, no calculations
4277			 * needed.
4278			 */
4279			memcpy(&lun->mode_pages.control_page[CTL_PAGE_CURRENT],
4280			       &control_page_default,
4281			       sizeof(control_page_default));
4282			memcpy(&lun->mode_pages.control_page[
4283			       CTL_PAGE_CHANGEABLE], &control_page_changeable,
4284			       sizeof(control_page_changeable));
4285			memcpy(&lun->mode_pages.control_page[CTL_PAGE_DEFAULT],
4286			       &control_page_default,
4287			       sizeof(control_page_default));
4288			memcpy(&lun->mode_pages.control_page[CTL_PAGE_SAVED],
4289			       &control_page_default,
4290			       sizeof(control_page_default));
4291			page_index->page_data =
4292				(uint8_t *)lun->mode_pages.control_page;
4293			break;
4294
4295		}
4296		case SMS_VENDOR_SPECIFIC_PAGE:{
4297			switch (page_index->subpage) {
4298			case PWR_SUBPAGE_CODE: {
4299				struct copan_power_subpage *current_page,
4300							   *saved_page;
4301
4302				memcpy(&lun->mode_pages.power_subpage[
4303				       CTL_PAGE_CURRENT],
4304				       &power_page_default,
4305				       sizeof(power_page_default));
4306				memcpy(&lun->mode_pages.power_subpage[
4307				       CTL_PAGE_CHANGEABLE],
4308				       &power_page_changeable,
4309				       sizeof(power_page_changeable));
4310				memcpy(&lun->mode_pages.power_subpage[
4311				       CTL_PAGE_DEFAULT],
4312				       &power_page_default,
4313				       sizeof(power_page_default));
4314				memcpy(&lun->mode_pages.power_subpage[
4315				       CTL_PAGE_SAVED],
4316				       &power_page_default,
4317				       sizeof(power_page_default));
4318				page_index->page_data =
4319				    (uint8_t *)lun->mode_pages.power_subpage;
4320
4321				current_page = (struct copan_power_subpage *)
4322					(page_index->page_data +
4323					 (page_index->page_len *
4324					  CTL_PAGE_CURRENT));
4325			        saved_page = (struct copan_power_subpage *)
4326				        (page_index->page_data +
4327					 (page_index->page_len *
4328					  CTL_PAGE_SAVED));
4329				break;
4330			}
4331			case APS_SUBPAGE_CODE: {
4332				struct copan_aps_subpage *current_page,
4333							 *saved_page;
4334
4335				// This gets set multiple times but
4336				// it should always be the same. It's
4337				// only done during init so who cares.
4338				index_to_aps_page = i;
4339
4340				memcpy(&lun->mode_pages.aps_subpage[
4341				       CTL_PAGE_CURRENT],
4342				       &aps_page_default,
4343				       sizeof(aps_page_default));
4344				memcpy(&lun->mode_pages.aps_subpage[
4345				       CTL_PAGE_CHANGEABLE],
4346				       &aps_page_changeable,
4347				       sizeof(aps_page_changeable));
4348				memcpy(&lun->mode_pages.aps_subpage[
4349				       CTL_PAGE_DEFAULT],
4350				       &aps_page_default,
4351				       sizeof(aps_page_default));
4352				memcpy(&lun->mode_pages.aps_subpage[
4353				       CTL_PAGE_SAVED],
4354				       &aps_page_default,
4355				       sizeof(aps_page_default));
4356				page_index->page_data =
4357					(uint8_t *)lun->mode_pages.aps_subpage;
4358
4359				current_page = (struct copan_aps_subpage *)
4360					(page_index->page_data +
4361					 (page_index->page_len *
4362					  CTL_PAGE_CURRENT));
4363				saved_page = (struct copan_aps_subpage *)
4364					(page_index->page_data +
4365					 (page_index->page_len *
4366					  CTL_PAGE_SAVED));
4367				break;
4368			}
4369			case DBGCNF_SUBPAGE_CODE: {
4370				struct copan_debugconf_subpage *current_page,
4371							       *saved_page;
4372
4373				memcpy(&lun->mode_pages.debugconf_subpage[
4374				       CTL_PAGE_CURRENT],
4375				       &debugconf_page_default,
4376				       sizeof(debugconf_page_default));
4377				memcpy(&lun->mode_pages.debugconf_subpage[
4378				       CTL_PAGE_CHANGEABLE],
4379				       &debugconf_page_changeable,
4380				       sizeof(debugconf_page_changeable));
4381				memcpy(&lun->mode_pages.debugconf_subpage[
4382				       CTL_PAGE_DEFAULT],
4383				       &debugconf_page_default,
4384				       sizeof(debugconf_page_default));
4385				memcpy(&lun->mode_pages.debugconf_subpage[
4386				       CTL_PAGE_SAVED],
4387				       &debugconf_page_default,
4388				       sizeof(debugconf_page_default));
4389				page_index->page_data =
4390					(uint8_t *)lun->mode_pages.debugconf_subpage;
4391
4392				current_page = (struct copan_debugconf_subpage *)
4393					(page_index->page_data +
4394					 (page_index->page_len *
4395					  CTL_PAGE_CURRENT));
4396				saved_page = (struct copan_debugconf_subpage *)
4397					(page_index->page_data +
4398					 (page_index->page_len *
4399					  CTL_PAGE_SAVED));
4400				break;
4401			}
4402			default:
4403				panic("invalid subpage value %d",
4404				      page_index->subpage);
4405				break;
4406			}
4407   			break;
4408		}
4409		default:
4410			panic("invalid page value %d",
4411			      page_index->page_code & SMPH_PC_MASK);
4412			break;
4413    	}
4414	}
4415
4416	return (CTL_RETVAL_COMPLETE);
4417}
4418
4419/*
4420 * LUN allocation.
4421 *
4422 * Requirements:
4423 * - caller allocates and zeros LUN storage, or passes in a NULL LUN if he
4424 *   wants us to allocate the LUN and he can block.
4425 * - ctl_softc is always set
4426 * - be_lun is set if the LUN has a backend (needed for disk LUNs)
4427 *
4428 * Returns 0 for success, non-zero (errno) for failure.
4429 */
4430static int
4431ctl_alloc_lun(struct ctl_softc *ctl_softc, struct ctl_lun *ctl_lun,
4432	      struct ctl_be_lun *const be_lun, struct ctl_id target_id)
4433{
4434	struct ctl_lun *nlun, *lun;
4435	struct ctl_port *port;
4436	struct scsi_vpd_id_descriptor *desc;
4437	struct scsi_vpd_id_t10 *t10id;
4438	const char *eui, *naa, *scsiname, *vendor;
4439	int lun_number, i, lun_malloced;
4440	int devidlen, idlen1, idlen2 = 0, len;
4441
4442	if (be_lun == NULL)
4443		return (EINVAL);
4444
4445	/*
4446	 * We currently only support Direct Access or Processor LUN types.
4447	 */
4448	switch (be_lun->lun_type) {
4449	case T_DIRECT:
4450		break;
4451	case T_PROCESSOR:
4452		break;
4453	case T_SEQUENTIAL:
4454	case T_CHANGER:
4455	default:
4456		be_lun->lun_config_status(be_lun->be_lun,
4457					  CTL_LUN_CONFIG_FAILURE);
4458		break;
4459	}
4460	if (ctl_lun == NULL) {
4461		lun = malloc(sizeof(*lun), M_CTL, M_WAITOK);
4462		lun_malloced = 1;
4463	} else {
4464		lun_malloced = 0;
4465		lun = ctl_lun;
4466	}
4467
4468	memset(lun, 0, sizeof(*lun));
4469	if (lun_malloced)
4470		lun->flags = CTL_LUN_MALLOCED;
4471
4472	/* Generate LUN ID. */
4473	devidlen = max(CTL_DEVID_MIN_LEN,
4474	    strnlen(be_lun->device_id, CTL_DEVID_LEN));
4475	idlen1 = sizeof(*t10id) + devidlen;
4476	len = sizeof(struct scsi_vpd_id_descriptor) + idlen1;
4477	scsiname = ctl_get_opt(&be_lun->options, "scsiname");
4478	if (scsiname != NULL) {
4479		idlen2 = roundup2(strlen(scsiname) + 1, 4);
4480		len += sizeof(struct scsi_vpd_id_descriptor) + idlen2;
4481	}
4482	eui = ctl_get_opt(&be_lun->options, "eui");
4483	if (eui != NULL) {
4484		len += sizeof(struct scsi_vpd_id_descriptor) + 8;
4485	}
4486	naa = ctl_get_opt(&be_lun->options, "naa");
4487	if (naa != NULL) {
4488		len += sizeof(struct scsi_vpd_id_descriptor) + 8;
4489	}
4490	lun->lun_devid = malloc(sizeof(struct ctl_devid) + len,
4491	    M_CTL, M_WAITOK | M_ZERO);
4492	lun->lun_devid->len = len;
4493	desc = (struct scsi_vpd_id_descriptor *)lun->lun_devid->data;
4494	desc->proto_codeset = SVPD_ID_CODESET_ASCII;
4495	desc->id_type = SVPD_ID_PIV | SVPD_ID_ASSOC_LUN | SVPD_ID_TYPE_T10;
4496	desc->length = idlen1;
4497	t10id = (struct scsi_vpd_id_t10 *)&desc->identifier[0];
4498	memset(t10id->vendor, ' ', sizeof(t10id->vendor));
4499	if ((vendor = ctl_get_opt(&be_lun->options, "vendor")) == NULL) {
4500		strncpy((char *)t10id->vendor, CTL_VENDOR, sizeof(t10id->vendor));
4501	} else {
4502		strncpy(t10id->vendor, vendor,
4503		    min(sizeof(t10id->vendor), strlen(vendor)));
4504	}
4505	strncpy((char *)t10id->vendor_spec_id,
4506	    (char *)be_lun->device_id, devidlen);
4507	if (scsiname != NULL) {
4508		desc = (struct scsi_vpd_id_descriptor *)(&desc->identifier[0] +
4509		    desc->length);
4510		desc->proto_codeset = SVPD_ID_CODESET_UTF8;
4511		desc->id_type = SVPD_ID_PIV | SVPD_ID_ASSOC_LUN |
4512		    SVPD_ID_TYPE_SCSI_NAME;
4513		desc->length = idlen2;
4514		strlcpy(desc->identifier, scsiname, idlen2);
4515	}
4516	if (eui != NULL) {
4517		desc = (struct scsi_vpd_id_descriptor *)(&desc->identifier[0] +
4518		    desc->length);
4519		desc->proto_codeset = SVPD_ID_CODESET_BINARY;
4520		desc->id_type = SVPD_ID_PIV | SVPD_ID_ASSOC_LUN |
4521		    SVPD_ID_TYPE_EUI64;
4522		desc->length = 8;
4523		scsi_u64to8b(strtouq(eui, NULL, 0), desc->identifier);
4524	}
4525	if (naa != NULL) {
4526		desc = (struct scsi_vpd_id_descriptor *)(&desc->identifier[0] +
4527		    desc->length);
4528		desc->proto_codeset = SVPD_ID_CODESET_BINARY;
4529		desc->id_type = SVPD_ID_PIV | SVPD_ID_ASSOC_LUN |
4530		    SVPD_ID_TYPE_NAA;
4531		desc->length = 8;
4532		scsi_u64to8b(strtouq(naa, NULL, 0), desc->identifier);
4533	}
4534
4535	mtx_lock(&ctl_softc->ctl_lock);
4536	/*
4537	 * See if the caller requested a particular LUN number.  If so, see
4538	 * if it is available.  Otherwise, allocate the first available LUN.
4539	 */
4540	if (be_lun->flags & CTL_LUN_FLAG_ID_REQ) {
4541		if ((be_lun->req_lun_id > (CTL_MAX_LUNS - 1))
4542		 || (ctl_is_set(ctl_softc->ctl_lun_mask, be_lun->req_lun_id))) {
4543			mtx_unlock(&ctl_softc->ctl_lock);
4544			if (be_lun->req_lun_id > (CTL_MAX_LUNS - 1)) {
4545				printf("ctl: requested LUN ID %d is higher "
4546				       "than CTL_MAX_LUNS - 1 (%d)\n",
4547				       be_lun->req_lun_id, CTL_MAX_LUNS - 1);
4548			} else {
4549				/*
4550				 * XXX KDM return an error, or just assign
4551				 * another LUN ID in this case??
4552				 */
4553				printf("ctl: requested LUN ID %d is already "
4554				       "in use\n", be_lun->req_lun_id);
4555			}
4556			if (lun->flags & CTL_LUN_MALLOCED)
4557				free(lun, M_CTL);
4558			be_lun->lun_config_status(be_lun->be_lun,
4559						  CTL_LUN_CONFIG_FAILURE);
4560			return (ENOSPC);
4561		}
4562		lun_number = be_lun->req_lun_id;
4563	} else {
4564		lun_number = ctl_ffz(ctl_softc->ctl_lun_mask, CTL_MAX_LUNS);
4565		if (lun_number == -1) {
4566			mtx_unlock(&ctl_softc->ctl_lock);
4567			printf("ctl: can't allocate LUN on target %ju, out of "
4568			       "LUNs\n", (uintmax_t)target_id.id);
4569			if (lun->flags & CTL_LUN_MALLOCED)
4570				free(lun, M_CTL);
4571			be_lun->lun_config_status(be_lun->be_lun,
4572						  CTL_LUN_CONFIG_FAILURE);
4573			return (ENOSPC);
4574		}
4575	}
4576	ctl_set_mask(ctl_softc->ctl_lun_mask, lun_number);
4577
4578	mtx_init(&lun->lun_lock, "CTL LUN", NULL, MTX_DEF);
4579	lun->target = target_id;
4580	lun->lun = lun_number;
4581	lun->be_lun = be_lun;
4582	/*
4583	 * The processor LUN is always enabled.  Disk LUNs come on line
4584	 * disabled, and must be enabled by the backend.
4585	 */
4586	lun->flags |= CTL_LUN_DISABLED;
4587	lun->backend = be_lun->be;
4588	be_lun->ctl_lun = lun;
4589	be_lun->lun_id = lun_number;
4590	atomic_add_int(&be_lun->be->num_luns, 1);
4591	if (be_lun->flags & CTL_LUN_FLAG_POWERED_OFF)
4592		lun->flags |= CTL_LUN_STOPPED;
4593
4594	if (be_lun->flags & CTL_LUN_FLAG_INOPERABLE)
4595		lun->flags |= CTL_LUN_INOPERABLE;
4596
4597	if (be_lun->flags & CTL_LUN_FLAG_PRIMARY)
4598		lun->flags |= CTL_LUN_PRIMARY_SC;
4599
4600	lun->ctl_softc = ctl_softc;
4601	TAILQ_INIT(&lun->ooa_queue);
4602	TAILQ_INIT(&lun->blocked_queue);
4603	STAILQ_INIT(&lun->error_list);
4604	ctl_tpc_lun_init(lun);
4605
4606	/*
4607	 * Initialize the mode page index.
4608	 */
4609	ctl_init_page_index(lun);
4610
4611	/*
4612	 * Set the poweron UA for all initiators on this LUN only.
4613	 */
4614	for (i = 0; i < CTL_MAX_INITIATORS; i++)
4615		lun->pending_ua[i] = CTL_UA_POWERON;
4616
4617	/*
4618	 * Now, before we insert this lun on the lun list, set the lun
4619	 * inventory changed UA for all other luns.
4620	 */
4621	STAILQ_FOREACH(nlun, &ctl_softc->lun_list, links) {
4622		for (i = 0; i < CTL_MAX_INITIATORS; i++) {
4623			nlun->pending_ua[i] |= CTL_UA_LUN_CHANGE;
4624		}
4625	}
4626
4627	STAILQ_INSERT_TAIL(&ctl_softc->lun_list, lun, links);
4628
4629	ctl_softc->ctl_luns[lun_number] = lun;
4630
4631	ctl_softc->num_luns++;
4632
4633	/* Setup statistics gathering */
4634	lun->stats.device_type = be_lun->lun_type;
4635	lun->stats.lun_number = lun_number;
4636	if (lun->stats.device_type == T_DIRECT)
4637		lun->stats.blocksize = be_lun->blocksize;
4638	else
4639		lun->stats.flags = CTL_LUN_STATS_NO_BLOCKSIZE;
4640	for (i = 0;i < CTL_MAX_PORTS;i++)
4641		lun->stats.ports[i].targ_port = i;
4642
4643	mtx_unlock(&ctl_softc->ctl_lock);
4644
4645	lun->be_lun->lun_config_status(lun->be_lun->be_lun, CTL_LUN_CONFIG_OK);
4646
4647	/*
4648	 * Run through each registered FETD and bring it online if it isn't
4649	 * already.  Enable the target ID if it hasn't been enabled, and
4650	 * enable this particular LUN.
4651	 */
4652	STAILQ_FOREACH(port, &ctl_softc->port_list, links) {
4653		int retval;
4654
4655		retval = port->lun_enable(port->targ_lun_arg, target_id,lun_number);
4656		if (retval != 0) {
4657			printf("ctl_alloc_lun: FETD %s port %d returned error "
4658			       "%d for lun_enable on target %ju lun %d\n",
4659			       port->port_name, port->targ_port, retval,
4660			       (uintmax_t)target_id.id, lun_number);
4661		} else
4662			port->status |= CTL_PORT_STATUS_LUN_ONLINE;
4663	}
4664	return (0);
4665}
4666
4667/*
4668 * Delete a LUN.
4669 * Assumptions:
4670 * - LUN has already been marked invalid and any pending I/O has been taken
4671 *   care of.
4672 */
4673static int
4674ctl_free_lun(struct ctl_lun *lun)
4675{
4676	struct ctl_softc *softc;
4677#if 0
4678	struct ctl_port *port;
4679#endif
4680	struct ctl_lun *nlun;
4681	int i;
4682
4683	softc = lun->ctl_softc;
4684
4685	mtx_assert(&softc->ctl_lock, MA_OWNED);
4686
4687	STAILQ_REMOVE(&softc->lun_list, lun, ctl_lun, links);
4688
4689	ctl_clear_mask(softc->ctl_lun_mask, lun->lun);
4690
4691	softc->ctl_luns[lun->lun] = NULL;
4692
4693	if (!TAILQ_EMPTY(&lun->ooa_queue))
4694		panic("Freeing a LUN %p with outstanding I/O!!\n", lun);
4695
4696	softc->num_luns--;
4697
4698	/*
4699	 * XXX KDM this scheme only works for a single target/multiple LUN
4700	 * setup.  It needs to be revamped for a multiple target scheme.
4701	 *
4702	 * XXX KDM this results in port->lun_disable() getting called twice,
4703	 * once when ctl_disable_lun() is called, and a second time here.
4704	 * We really need to re-think the LUN disable semantics.  There
4705	 * should probably be several steps/levels to LUN removal:
4706	 *  - disable
4707	 *  - invalidate
4708	 *  - free
4709 	 *
4710	 * Right now we only have a disable method when communicating to
4711	 * the front end ports, at least for individual LUNs.
4712	 */
4713#if 0
4714	STAILQ_FOREACH(port, &softc->port_list, links) {
4715		int retval;
4716
4717		retval = port->lun_disable(port->targ_lun_arg, lun->target,
4718					 lun->lun);
4719		if (retval != 0) {
4720			printf("ctl_free_lun: FETD %s port %d returned error "
4721			       "%d for lun_disable on target %ju lun %jd\n",
4722			       port->port_name, port->targ_port, retval,
4723			       (uintmax_t)lun->target.id, (intmax_t)lun->lun);
4724		}
4725
4726		if (STAILQ_FIRST(&softc->lun_list) == NULL) {
4727			port->status &= ~CTL_PORT_STATUS_LUN_ONLINE;
4728
4729			retval = port->targ_disable(port->targ_lun_arg,lun->target);
4730			if (retval != 0) {
4731				printf("ctl_free_lun: FETD %s port %d "
4732				       "returned error %d for targ_disable on "
4733				       "target %ju\n", port->port_name,
4734				       port->targ_port, retval,
4735				       (uintmax_t)lun->target.id);
4736			} else
4737				port->status &= ~CTL_PORT_STATUS_TARG_ONLINE;
4738
4739			if ((port->status & CTL_PORT_STATUS_TARG_ONLINE) != 0)
4740				continue;
4741
4742#if 0
4743			port->port_offline(port->onoff_arg);
4744			port->status &= ~CTL_PORT_STATUS_ONLINE;
4745#endif
4746		}
4747	}
4748#endif
4749
4750	/*
4751	 * Tell the backend to free resources, if this LUN has a backend.
4752	 */
4753	atomic_subtract_int(&lun->be_lun->be->num_luns, 1);
4754	lun->be_lun->lun_shutdown(lun->be_lun->be_lun);
4755
4756	ctl_tpc_lun_shutdown(lun);
4757	mtx_destroy(&lun->lun_lock);
4758	free(lun->lun_devid, M_CTL);
4759	if (lun->flags & CTL_LUN_MALLOCED)
4760		free(lun, M_CTL);
4761
4762	STAILQ_FOREACH(nlun, &softc->lun_list, links) {
4763		for (i = 0; i < CTL_MAX_INITIATORS; i++) {
4764			nlun->pending_ua[i] |= CTL_UA_LUN_CHANGE;
4765		}
4766	}
4767
4768	return (0);
4769}
4770
4771static void
4772ctl_create_lun(struct ctl_be_lun *be_lun)
4773{
4774	struct ctl_softc *ctl_softc;
4775
4776	ctl_softc = control_softc;
4777
4778	/*
4779	 * ctl_alloc_lun() should handle all potential failure cases.
4780	 */
4781	ctl_alloc_lun(ctl_softc, NULL, be_lun, ctl_softc->target);
4782}
4783
4784int
4785ctl_add_lun(struct ctl_be_lun *be_lun)
4786{
4787	struct ctl_softc *ctl_softc = control_softc;
4788
4789	mtx_lock(&ctl_softc->ctl_lock);
4790	STAILQ_INSERT_TAIL(&ctl_softc->pending_lun_queue, be_lun, links);
4791	mtx_unlock(&ctl_softc->ctl_lock);
4792	wakeup(&ctl_softc->pending_lun_queue);
4793
4794	return (0);
4795}
4796
4797int
4798ctl_enable_lun(struct ctl_be_lun *be_lun)
4799{
4800	struct ctl_softc *ctl_softc;
4801	struct ctl_port *port, *nport;
4802	struct ctl_lun *lun;
4803	int retval;
4804
4805	ctl_softc = control_softc;
4806
4807	lun = (struct ctl_lun *)be_lun->ctl_lun;
4808
4809	mtx_lock(&ctl_softc->ctl_lock);
4810	mtx_lock(&lun->lun_lock);
4811	if ((lun->flags & CTL_LUN_DISABLED) == 0) {
4812		/*
4813		 * eh?  Why did we get called if the LUN is already
4814		 * enabled?
4815		 */
4816		mtx_unlock(&lun->lun_lock);
4817		mtx_unlock(&ctl_softc->ctl_lock);
4818		return (0);
4819	}
4820	lun->flags &= ~CTL_LUN_DISABLED;
4821	mtx_unlock(&lun->lun_lock);
4822
4823	for (port = STAILQ_FIRST(&ctl_softc->port_list); port != NULL; port = nport) {
4824		nport = STAILQ_NEXT(port, links);
4825
4826		/*
4827		 * Drop the lock while we call the FETD's enable routine.
4828		 * This can lead to a callback into CTL (at least in the
4829		 * case of the internal initiator frontend.
4830		 */
4831		mtx_unlock(&ctl_softc->ctl_lock);
4832		retval = port->lun_enable(port->targ_lun_arg, lun->target,lun->lun);
4833		mtx_lock(&ctl_softc->ctl_lock);
4834		if (retval != 0) {
4835			printf("%s: FETD %s port %d returned error "
4836			       "%d for lun_enable on target %ju lun %jd\n",
4837			       __func__, port->port_name, port->targ_port, retval,
4838			       (uintmax_t)lun->target.id, (intmax_t)lun->lun);
4839		}
4840#if 0
4841		 else {
4842            /* NOTE:  TODO:  why does lun enable affect port status? */
4843			port->status |= CTL_PORT_STATUS_LUN_ONLINE;
4844		}
4845#endif
4846	}
4847
4848	mtx_unlock(&ctl_softc->ctl_lock);
4849
4850	return (0);
4851}
4852
4853int
4854ctl_disable_lun(struct ctl_be_lun *be_lun)
4855{
4856	struct ctl_softc *ctl_softc;
4857	struct ctl_port *port;
4858	struct ctl_lun *lun;
4859	int retval;
4860
4861	ctl_softc = control_softc;
4862
4863	lun = (struct ctl_lun *)be_lun->ctl_lun;
4864
4865	mtx_lock(&ctl_softc->ctl_lock);
4866	mtx_lock(&lun->lun_lock);
4867	if (lun->flags & CTL_LUN_DISABLED) {
4868		mtx_unlock(&lun->lun_lock);
4869		mtx_unlock(&ctl_softc->ctl_lock);
4870		return (0);
4871	}
4872	lun->flags |= CTL_LUN_DISABLED;
4873	mtx_unlock(&lun->lun_lock);
4874
4875	STAILQ_FOREACH(port, &ctl_softc->port_list, links) {
4876		mtx_unlock(&ctl_softc->ctl_lock);
4877		/*
4878		 * Drop the lock before we call the frontend's disable
4879		 * routine, to avoid lock order reversals.
4880		 *
4881		 * XXX KDM what happens if the frontend list changes while
4882		 * we're traversing it?  It's unlikely, but should be handled.
4883		 */
4884		retval = port->lun_disable(port->targ_lun_arg, lun->target,
4885					 lun->lun);
4886		mtx_lock(&ctl_softc->ctl_lock);
4887		if (retval != 0) {
4888			printf("ctl_alloc_lun: FETD %s port %d returned error "
4889			       "%d for lun_disable on target %ju lun %jd\n",
4890			       port->port_name, port->targ_port, retval,
4891			       (uintmax_t)lun->target.id, (intmax_t)lun->lun);
4892		}
4893	}
4894
4895	mtx_unlock(&ctl_softc->ctl_lock);
4896
4897	return (0);
4898}
4899
4900int
4901ctl_start_lun(struct ctl_be_lun *be_lun)
4902{
4903	struct ctl_softc *ctl_softc;
4904	struct ctl_lun *lun;
4905
4906	ctl_softc = control_softc;
4907
4908	lun = (struct ctl_lun *)be_lun->ctl_lun;
4909
4910	mtx_lock(&lun->lun_lock);
4911	lun->flags &= ~CTL_LUN_STOPPED;
4912	mtx_unlock(&lun->lun_lock);
4913
4914	return (0);
4915}
4916
4917int
4918ctl_stop_lun(struct ctl_be_lun *be_lun)
4919{
4920	struct ctl_softc *ctl_softc;
4921	struct ctl_lun *lun;
4922
4923	ctl_softc = control_softc;
4924
4925	lun = (struct ctl_lun *)be_lun->ctl_lun;
4926
4927	mtx_lock(&lun->lun_lock);
4928	lun->flags |= CTL_LUN_STOPPED;
4929	mtx_unlock(&lun->lun_lock);
4930
4931	return (0);
4932}
4933
4934int
4935ctl_lun_offline(struct ctl_be_lun *be_lun)
4936{
4937	struct ctl_softc *ctl_softc;
4938	struct ctl_lun *lun;
4939
4940	ctl_softc = control_softc;
4941
4942	lun = (struct ctl_lun *)be_lun->ctl_lun;
4943
4944	mtx_lock(&lun->lun_lock);
4945	lun->flags |= CTL_LUN_OFFLINE;
4946	mtx_unlock(&lun->lun_lock);
4947
4948	return (0);
4949}
4950
4951int
4952ctl_lun_online(struct ctl_be_lun *be_lun)
4953{
4954	struct ctl_softc *ctl_softc;
4955	struct ctl_lun *lun;
4956
4957	ctl_softc = control_softc;
4958
4959	lun = (struct ctl_lun *)be_lun->ctl_lun;
4960
4961	mtx_lock(&lun->lun_lock);
4962	lun->flags &= ~CTL_LUN_OFFLINE;
4963	mtx_unlock(&lun->lun_lock);
4964
4965	return (0);
4966}
4967
4968int
4969ctl_invalidate_lun(struct ctl_be_lun *be_lun)
4970{
4971	struct ctl_softc *ctl_softc;
4972	struct ctl_lun *lun;
4973
4974	ctl_softc = control_softc;
4975
4976	lun = (struct ctl_lun *)be_lun->ctl_lun;
4977
4978	mtx_lock(&lun->lun_lock);
4979
4980	/*
4981	 * The LUN needs to be disabled before it can be marked invalid.
4982	 */
4983	if ((lun->flags & CTL_LUN_DISABLED) == 0) {
4984		mtx_unlock(&lun->lun_lock);
4985		return (-1);
4986	}
4987	/*
4988	 * Mark the LUN invalid.
4989	 */
4990	lun->flags |= CTL_LUN_INVALID;
4991
4992	/*
4993	 * If there is nothing in the OOA queue, go ahead and free the LUN.
4994	 * If we have something in the OOA queue, we'll free it when the
4995	 * last I/O completes.
4996	 */
4997	if (TAILQ_EMPTY(&lun->ooa_queue)) {
4998		mtx_unlock(&lun->lun_lock);
4999		mtx_lock(&ctl_softc->ctl_lock);
5000		ctl_free_lun(lun);
5001		mtx_unlock(&ctl_softc->ctl_lock);
5002	} else
5003		mtx_unlock(&lun->lun_lock);
5004
5005	return (0);
5006}
5007
5008int
5009ctl_lun_inoperable(struct ctl_be_lun *be_lun)
5010{
5011	struct ctl_softc *ctl_softc;
5012	struct ctl_lun *lun;
5013
5014	ctl_softc = control_softc;
5015	lun = (struct ctl_lun *)be_lun->ctl_lun;
5016
5017	mtx_lock(&lun->lun_lock);
5018	lun->flags |= CTL_LUN_INOPERABLE;
5019	mtx_unlock(&lun->lun_lock);
5020
5021	return (0);
5022}
5023
5024int
5025ctl_lun_operable(struct ctl_be_lun *be_lun)
5026{
5027	struct ctl_softc *ctl_softc;
5028	struct ctl_lun *lun;
5029
5030	ctl_softc = control_softc;
5031	lun = (struct ctl_lun *)be_lun->ctl_lun;
5032
5033	mtx_lock(&lun->lun_lock);
5034	lun->flags &= ~CTL_LUN_INOPERABLE;
5035	mtx_unlock(&lun->lun_lock);
5036
5037	return (0);
5038}
5039
5040int
5041ctl_lun_power_lock(struct ctl_be_lun *be_lun, struct ctl_nexus *nexus,
5042		   int lock)
5043{
5044	struct ctl_softc *softc;
5045	struct ctl_lun *lun;
5046	struct copan_aps_subpage *current_sp;
5047	struct ctl_page_index *page_index;
5048	int i;
5049
5050	softc = control_softc;
5051
5052	mtx_lock(&softc->ctl_lock);
5053
5054	lun = (struct ctl_lun *)be_lun->ctl_lun;
5055	mtx_lock(&lun->lun_lock);
5056
5057	page_index = NULL;
5058	for (i = 0; i < CTL_NUM_MODE_PAGES; i++) {
5059		if ((lun->mode_pages.index[i].page_code & SMPH_PC_MASK) !=
5060		     APS_PAGE_CODE)
5061			continue;
5062
5063		if (lun->mode_pages.index[i].subpage != APS_SUBPAGE_CODE)
5064			continue;
5065		page_index = &lun->mode_pages.index[i];
5066	}
5067
5068	if (page_index == NULL) {
5069		mtx_unlock(&lun->lun_lock);
5070		mtx_unlock(&softc->ctl_lock);
5071		printf("%s: APS subpage not found for lun %ju!\n", __func__,
5072		       (uintmax_t)lun->lun);
5073		return (1);
5074	}
5075#if 0
5076	if ((softc->aps_locked_lun != 0)
5077	 && (softc->aps_locked_lun != lun->lun)) {
5078		printf("%s: attempt to lock LUN %llu when %llu is already "
5079		       "locked\n");
5080		mtx_unlock(&lun->lun_lock);
5081		mtx_unlock(&softc->ctl_lock);
5082		return (1);
5083	}
5084#endif
5085
5086	current_sp = (struct copan_aps_subpage *)(page_index->page_data +
5087		(page_index->page_len * CTL_PAGE_CURRENT));
5088
5089	if (lock != 0) {
5090		current_sp->lock_active = APS_LOCK_ACTIVE;
5091		softc->aps_locked_lun = lun->lun;
5092	} else {
5093		current_sp->lock_active = 0;
5094		softc->aps_locked_lun = 0;
5095	}
5096
5097
5098	/*
5099	 * If we're in HA mode, try to send the lock message to the other
5100	 * side.
5101	 */
5102	if (ctl_is_single == 0) {
5103		int isc_retval;
5104		union ctl_ha_msg lock_msg;
5105
5106		lock_msg.hdr.nexus = *nexus;
5107		lock_msg.hdr.msg_type = CTL_MSG_APS_LOCK;
5108		if (lock != 0)
5109			lock_msg.aps.lock_flag = 1;
5110		else
5111			lock_msg.aps.lock_flag = 0;
5112		isc_retval = ctl_ha_msg_send(CTL_HA_CHAN_CTL, &lock_msg,
5113					 sizeof(lock_msg), 0);
5114		if (isc_retval > CTL_HA_STATUS_SUCCESS) {
5115			printf("%s: APS (lock=%d) error returned from "
5116			       "ctl_ha_msg_send: %d\n", __func__, lock, isc_retval);
5117			mtx_unlock(&lun->lun_lock);
5118			mtx_unlock(&softc->ctl_lock);
5119			return (1);
5120		}
5121	}
5122
5123	mtx_unlock(&lun->lun_lock);
5124	mtx_unlock(&softc->ctl_lock);
5125
5126	return (0);
5127}
5128
5129void
5130ctl_lun_capacity_changed(struct ctl_be_lun *be_lun)
5131{
5132	struct ctl_lun *lun;
5133	struct ctl_softc *softc;
5134	int i;
5135
5136	softc = control_softc;
5137
5138	lun = (struct ctl_lun *)be_lun->ctl_lun;
5139
5140	mtx_lock(&lun->lun_lock);
5141
5142	for (i = 0; i < CTL_MAX_INITIATORS; i++)
5143		lun->pending_ua[i] |= CTL_UA_CAPACITY_CHANGED;
5144
5145	mtx_unlock(&lun->lun_lock);
5146}
5147
5148/*
5149 * Backend "memory move is complete" callback for requests that never
5150 * make it down to say RAIDCore's configuration code.
5151 */
5152int
5153ctl_config_move_done(union ctl_io *io)
5154{
5155	int retval;
5156
5157	retval = CTL_RETVAL_COMPLETE;
5158
5159
5160	CTL_DEBUG_PRINT(("ctl_config_move_done\n"));
5161	/*
5162	 * XXX KDM this shouldn't happen, but what if it does?
5163	 */
5164	if (io->io_hdr.io_type != CTL_IO_SCSI)
5165		panic("I/O type isn't CTL_IO_SCSI!");
5166
5167	if ((io->io_hdr.port_status == 0)
5168	 && ((io->io_hdr.flags & CTL_FLAG_ABORT) == 0)
5169	 && ((io->io_hdr.status & CTL_STATUS_MASK) == CTL_STATUS_NONE))
5170		io->io_hdr.status = CTL_SUCCESS;
5171	else if ((io->io_hdr.port_status != 0)
5172	      && ((io->io_hdr.flags & CTL_FLAG_ABORT) == 0)
5173	      && ((io->io_hdr.status & CTL_STATUS_MASK) == CTL_STATUS_NONE)){
5174		/*
5175		 * For hardware error sense keys, the sense key
5176		 * specific value is defined to be a retry count,
5177		 * but we use it to pass back an internal FETD
5178		 * error code.  XXX KDM  Hopefully the FETD is only
5179		 * using 16 bits for an error code, since that's
5180		 * all the space we have in the sks field.
5181		 */
5182		ctl_set_internal_failure(&io->scsiio,
5183					 /*sks_valid*/ 1,
5184					 /*retry_count*/
5185					 io->io_hdr.port_status);
5186		if (io->io_hdr.flags & CTL_FLAG_ALLOCATED)
5187			free(io->scsiio.kern_data_ptr, M_CTL);
5188		ctl_done(io);
5189		goto bailout;
5190	}
5191
5192	if (((io->io_hdr.flags & CTL_FLAG_DATA_MASK) == CTL_FLAG_DATA_IN)
5193	 || ((io->io_hdr.status & CTL_STATUS_MASK) != CTL_SUCCESS)
5194	 || ((io->io_hdr.flags & CTL_FLAG_ABORT) != 0)) {
5195		/*
5196		 * XXX KDM just assuming a single pointer here, and not a
5197		 * S/G list.  If we start using S/G lists for config data,
5198		 * we'll need to know how to clean them up here as well.
5199		 */
5200		if (io->io_hdr.flags & CTL_FLAG_ALLOCATED)
5201			free(io->scsiio.kern_data_ptr, M_CTL);
5202		/* Hopefully the user has already set the status... */
5203		ctl_done(io);
5204	} else {
5205		/*
5206		 * XXX KDM now we need to continue data movement.  Some
5207		 * options:
5208		 * - call ctl_scsiio() again?  We don't do this for data
5209		 *   writes, because for those at least we know ahead of
5210		 *   time where the write will go and how long it is.  For
5211		 *   config writes, though, that information is largely
5212		 *   contained within the write itself, thus we need to
5213		 *   parse out the data again.
5214		 *
5215		 * - Call some other function once the data is in?
5216		 */
5217
5218		/*
5219		 * XXX KDM call ctl_scsiio() again for now, and check flag
5220		 * bits to see whether we're allocated or not.
5221		 */
5222		retval = ctl_scsiio(&io->scsiio);
5223	}
5224bailout:
5225	return (retval);
5226}
5227
5228/*
5229 * This gets called by a backend driver when it is done with a
5230 * data_submit method.
5231 */
5232void
5233ctl_data_submit_done(union ctl_io *io)
5234{
5235	/*
5236	 * If the IO_CONT flag is set, we need to call the supplied
5237	 * function to continue processing the I/O, instead of completing
5238	 * the I/O just yet.
5239	 *
5240	 * If there is an error, though, we don't want to keep processing.
5241	 * Instead, just send status back to the initiator.
5242	 */
5243	if ((io->io_hdr.flags & CTL_FLAG_IO_CONT) &&
5244	    (io->io_hdr.flags & CTL_FLAG_ABORT) == 0 &&
5245	    ((io->io_hdr.status & CTL_STATUS_MASK) == CTL_STATUS_NONE ||
5246	     (io->io_hdr.status & CTL_STATUS_MASK) == CTL_SUCCESS)) {
5247		io->scsiio.io_cont(io);
5248		return;
5249	}
5250	ctl_done(io);
5251}
5252
5253/*
5254 * This gets called by a backend driver when it is done with a
5255 * configuration write.
5256 */
5257void
5258ctl_config_write_done(union ctl_io *io)
5259{
5260	/*
5261	 * If the IO_CONT flag is set, we need to call the supplied
5262	 * function to continue processing the I/O, instead of completing
5263	 * the I/O just yet.
5264	 *
5265	 * If there is an error, though, we don't want to keep processing.
5266	 * Instead, just send status back to the initiator.
5267	 */
5268	if ((io->io_hdr.flags & CTL_FLAG_IO_CONT)
5269	 && (((io->io_hdr.status & CTL_STATUS_MASK) == CTL_STATUS_NONE)
5270	  || ((io->io_hdr.status & CTL_STATUS_MASK) == CTL_SUCCESS))) {
5271		io->scsiio.io_cont(io);
5272		return;
5273	}
5274	/*
5275	 * Since a configuration write can be done for commands that actually
5276	 * have data allocated, like write buffer, and commands that have
5277	 * no data, like start/stop unit, we need to check here.
5278	 */
5279	if ((io->io_hdr.flags & CTL_FLAG_DATA_MASK) == CTL_FLAG_DATA_OUT)
5280		free(io->scsiio.kern_data_ptr, M_CTL);
5281	ctl_done(io);
5282}
5283
5284/*
5285 * SCSI release command.
5286 */
5287int
5288ctl_scsi_release(struct ctl_scsiio *ctsio)
5289{
5290	int length, longid, thirdparty_id, resv_id;
5291	struct ctl_softc *ctl_softc;
5292	struct ctl_lun *lun;
5293
5294	length = 0;
5295	resv_id = 0;
5296
5297	CTL_DEBUG_PRINT(("ctl_scsi_release\n"));
5298
5299	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5300	ctl_softc = control_softc;
5301
5302	switch (ctsio->cdb[0]) {
5303	case RELEASE_10: {
5304		struct scsi_release_10 *cdb;
5305
5306		cdb = (struct scsi_release_10 *)ctsio->cdb;
5307
5308		if (cdb->byte2 & SR10_LONGID)
5309			longid = 1;
5310		else
5311			thirdparty_id = cdb->thirdparty_id;
5312
5313		resv_id = cdb->resv_id;
5314		length = scsi_2btoul(cdb->length);
5315		break;
5316	}
5317	}
5318
5319
5320	/*
5321	 * XXX KDM right now, we only support LUN reservation.  We don't
5322	 * support 3rd party reservations, or extent reservations, which
5323	 * might actually need the parameter list.  If we've gotten this
5324	 * far, we've got a LUN reservation.  Anything else got kicked out
5325	 * above.  So, according to SPC, ignore the length.
5326	 */
5327	length = 0;
5328
5329	if (((ctsio->io_hdr.flags & CTL_FLAG_ALLOCATED) == 0)
5330	 && (length > 0)) {
5331		ctsio->kern_data_ptr = malloc(length, M_CTL, M_WAITOK);
5332		ctsio->kern_data_len = length;
5333		ctsio->kern_total_len = length;
5334		ctsio->kern_data_resid = 0;
5335		ctsio->kern_rel_offset = 0;
5336		ctsio->kern_sg_entries = 0;
5337		ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
5338		ctsio->be_move_done = ctl_config_move_done;
5339		ctl_datamove((union ctl_io *)ctsio);
5340
5341		return (CTL_RETVAL_COMPLETE);
5342	}
5343
5344	if (length > 0)
5345		thirdparty_id = scsi_8btou64(ctsio->kern_data_ptr);
5346
5347	mtx_lock(&lun->lun_lock);
5348
5349	/*
5350	 * According to SPC, it is not an error for an intiator to attempt
5351	 * to release a reservation on a LUN that isn't reserved, or that
5352	 * is reserved by another initiator.  The reservation can only be
5353	 * released, though, by the initiator who made it or by one of
5354	 * several reset type events.
5355	 */
5356	if (lun->flags & CTL_LUN_RESERVED) {
5357		if ((ctsio->io_hdr.nexus.initid.id == lun->rsv_nexus.initid.id)
5358		 && (ctsio->io_hdr.nexus.targ_port == lun->rsv_nexus.targ_port)
5359		 && (ctsio->io_hdr.nexus.targ_target.id ==
5360		     lun->rsv_nexus.targ_target.id)) {
5361			lun->flags &= ~CTL_LUN_RESERVED;
5362		}
5363	}
5364
5365	mtx_unlock(&lun->lun_lock);
5366
5367	ctsio->scsi_status = SCSI_STATUS_OK;
5368	ctsio->io_hdr.status = CTL_SUCCESS;
5369
5370	if (ctsio->io_hdr.flags & CTL_FLAG_ALLOCATED) {
5371		free(ctsio->kern_data_ptr, M_CTL);
5372		ctsio->io_hdr.flags &= ~CTL_FLAG_ALLOCATED;
5373	}
5374
5375	ctl_done((union ctl_io *)ctsio);
5376	return (CTL_RETVAL_COMPLETE);
5377}
5378
5379int
5380ctl_scsi_reserve(struct ctl_scsiio *ctsio)
5381{
5382	int extent, thirdparty, longid;
5383	int resv_id, length;
5384	uint64_t thirdparty_id;
5385	struct ctl_softc *ctl_softc;
5386	struct ctl_lun *lun;
5387
5388	extent = 0;
5389	thirdparty = 0;
5390	longid = 0;
5391	resv_id = 0;
5392	length = 0;
5393	thirdparty_id = 0;
5394
5395	CTL_DEBUG_PRINT(("ctl_reserve\n"));
5396
5397	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5398	ctl_softc = control_softc;
5399
5400	switch (ctsio->cdb[0]) {
5401	case RESERVE_10: {
5402		struct scsi_reserve_10 *cdb;
5403
5404		cdb = (struct scsi_reserve_10 *)ctsio->cdb;
5405
5406		if (cdb->byte2 & SR10_LONGID)
5407			longid = 1;
5408		else
5409			thirdparty_id = cdb->thirdparty_id;
5410
5411		resv_id = cdb->resv_id;
5412		length = scsi_2btoul(cdb->length);
5413		break;
5414	}
5415	}
5416
5417	/*
5418	 * XXX KDM right now, we only support LUN reservation.  We don't
5419	 * support 3rd party reservations, or extent reservations, which
5420	 * might actually need the parameter list.  If we've gotten this
5421	 * far, we've got a LUN reservation.  Anything else got kicked out
5422	 * above.  So, according to SPC, ignore the length.
5423	 */
5424	length = 0;
5425
5426	if (((ctsio->io_hdr.flags & CTL_FLAG_ALLOCATED) == 0)
5427	 && (length > 0)) {
5428		ctsio->kern_data_ptr = malloc(length, M_CTL, M_WAITOK);
5429		ctsio->kern_data_len = length;
5430		ctsio->kern_total_len = length;
5431		ctsio->kern_data_resid = 0;
5432		ctsio->kern_rel_offset = 0;
5433		ctsio->kern_sg_entries = 0;
5434		ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
5435		ctsio->be_move_done = ctl_config_move_done;
5436		ctl_datamove((union ctl_io *)ctsio);
5437
5438		return (CTL_RETVAL_COMPLETE);
5439	}
5440
5441	if (length > 0)
5442		thirdparty_id = scsi_8btou64(ctsio->kern_data_ptr);
5443
5444	mtx_lock(&lun->lun_lock);
5445	if (lun->flags & CTL_LUN_RESERVED) {
5446		if ((ctsio->io_hdr.nexus.initid.id != lun->rsv_nexus.initid.id)
5447		 || (ctsio->io_hdr.nexus.targ_port != lun->rsv_nexus.targ_port)
5448		 || (ctsio->io_hdr.nexus.targ_target.id !=
5449		     lun->rsv_nexus.targ_target.id)) {
5450			ctsio->scsi_status = SCSI_STATUS_RESERV_CONFLICT;
5451			ctsio->io_hdr.status = CTL_SCSI_ERROR;
5452			goto bailout;
5453		}
5454	}
5455
5456	lun->flags |= CTL_LUN_RESERVED;
5457	lun->rsv_nexus = ctsio->io_hdr.nexus;
5458
5459	ctsio->scsi_status = SCSI_STATUS_OK;
5460	ctsio->io_hdr.status = CTL_SUCCESS;
5461
5462bailout:
5463	mtx_unlock(&lun->lun_lock);
5464
5465	if (ctsio->io_hdr.flags & CTL_FLAG_ALLOCATED) {
5466		free(ctsio->kern_data_ptr, M_CTL);
5467		ctsio->io_hdr.flags &= ~CTL_FLAG_ALLOCATED;
5468	}
5469
5470	ctl_done((union ctl_io *)ctsio);
5471	return (CTL_RETVAL_COMPLETE);
5472}
5473
5474int
5475ctl_start_stop(struct ctl_scsiio *ctsio)
5476{
5477	struct scsi_start_stop_unit *cdb;
5478	struct ctl_lun *lun;
5479	struct ctl_softc *ctl_softc;
5480	int retval;
5481
5482	CTL_DEBUG_PRINT(("ctl_start_stop\n"));
5483
5484	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5485	ctl_softc = control_softc;
5486	retval = 0;
5487
5488	cdb = (struct scsi_start_stop_unit *)ctsio->cdb;
5489
5490	/*
5491	 * XXX KDM
5492	 * We don't support the immediate bit on a stop unit.  In order to
5493	 * do that, we would need to code up a way to know that a stop is
5494	 * pending, and hold off any new commands until it completes, one
5495	 * way or another.  Then we could accept or reject those commands
5496	 * depending on its status.  We would almost need to do the reverse
5497	 * of what we do below for an immediate start -- return the copy of
5498	 * the ctl_io to the FETD with status to send to the host (and to
5499	 * free the copy!) and then free the original I/O once the stop
5500	 * actually completes.  That way, the OOA queue mechanism can work
5501	 * to block commands that shouldn't proceed.  Another alternative
5502	 * would be to put the copy in the queue in place of the original,
5503	 * and return the original back to the caller.  That could be
5504	 * slightly safer..
5505	 */
5506	if ((cdb->byte2 & SSS_IMMED)
5507	 && ((cdb->how & SSS_START) == 0)) {
5508		ctl_set_invalid_field(ctsio,
5509				      /*sks_valid*/ 1,
5510				      /*command*/ 1,
5511				      /*field*/ 1,
5512				      /*bit_valid*/ 1,
5513				      /*bit*/ 0);
5514		ctl_done((union ctl_io *)ctsio);
5515		return (CTL_RETVAL_COMPLETE);
5516	}
5517
5518	if ((lun->flags & CTL_LUN_PR_RESERVED)
5519	 && ((cdb->how & SSS_START)==0)) {
5520		uint32_t residx;
5521
5522		residx = ctl_get_resindex(&ctsio->io_hdr.nexus);
5523		if (!lun->per_res[residx].registered
5524		 || (lun->pr_res_idx!=residx && lun->res_type < 4)) {
5525
5526			ctl_set_reservation_conflict(ctsio);
5527			ctl_done((union ctl_io *)ctsio);
5528			return (CTL_RETVAL_COMPLETE);
5529		}
5530	}
5531
5532	/*
5533	 * If there is no backend on this device, we can't start or stop
5534	 * it.  In theory we shouldn't get any start/stop commands in the
5535	 * first place at this level if the LUN doesn't have a backend.
5536	 * That should get stopped by the command decode code.
5537	 */
5538	if (lun->backend == NULL) {
5539		ctl_set_invalid_opcode(ctsio);
5540		ctl_done((union ctl_io *)ctsio);
5541		return (CTL_RETVAL_COMPLETE);
5542	}
5543
5544	/*
5545	 * XXX KDM Copan-specific offline behavior.
5546	 * Figure out a reasonable way to port this?
5547	 */
5548#ifdef NEEDTOPORT
5549	mtx_lock(&lun->lun_lock);
5550
5551	if (((cdb->byte2 & SSS_ONOFFLINE) == 0)
5552	 && (lun->flags & CTL_LUN_OFFLINE)) {
5553		/*
5554		 * If the LUN is offline, and the on/offline bit isn't set,
5555		 * reject the start or stop.  Otherwise, let it through.
5556		 */
5557		mtx_unlock(&lun->lun_lock);
5558		ctl_set_lun_not_ready(ctsio);
5559		ctl_done((union ctl_io *)ctsio);
5560	} else {
5561		mtx_unlock(&lun->lun_lock);
5562#endif /* NEEDTOPORT */
5563		/*
5564		 * This could be a start or a stop when we're online,
5565		 * or a stop/offline or start/online.  A start or stop when
5566		 * we're offline is covered in the case above.
5567		 */
5568		/*
5569		 * In the non-immediate case, we send the request to
5570		 * the backend and return status to the user when
5571		 * it is done.
5572		 *
5573		 * In the immediate case, we allocate a new ctl_io
5574		 * to hold a copy of the request, and send that to
5575		 * the backend.  We then set good status on the
5576		 * user's request and return it immediately.
5577		 */
5578		if (cdb->byte2 & SSS_IMMED) {
5579			union ctl_io *new_io;
5580
5581			new_io = ctl_alloc_io(ctsio->io_hdr.pool);
5582			if (new_io == NULL) {
5583				ctl_set_busy(ctsio);
5584				ctl_done((union ctl_io *)ctsio);
5585			} else {
5586				ctl_copy_io((union ctl_io *)ctsio,
5587					    new_io);
5588				retval = lun->backend->config_write(new_io);
5589				ctl_set_success(ctsio);
5590				ctl_done((union ctl_io *)ctsio);
5591			}
5592		} else {
5593			retval = lun->backend->config_write(
5594				(union ctl_io *)ctsio);
5595		}
5596#ifdef NEEDTOPORT
5597	}
5598#endif
5599	return (retval);
5600}
5601
5602/*
5603 * We support the SYNCHRONIZE CACHE command (10 and 16 byte versions), but
5604 * we don't really do anything with the LBA and length fields if the user
5605 * passes them in.  Instead we'll just flush out the cache for the entire
5606 * LUN.
5607 */
5608int
5609ctl_sync_cache(struct ctl_scsiio *ctsio)
5610{
5611	struct ctl_lun *lun;
5612	struct ctl_softc *ctl_softc;
5613	uint64_t starting_lba;
5614	uint32_t block_count;
5615	int retval;
5616
5617	CTL_DEBUG_PRINT(("ctl_sync_cache\n"));
5618
5619	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5620	ctl_softc = control_softc;
5621	retval = 0;
5622
5623	switch (ctsio->cdb[0]) {
5624	case SYNCHRONIZE_CACHE: {
5625		struct scsi_sync_cache *cdb;
5626		cdb = (struct scsi_sync_cache *)ctsio->cdb;
5627
5628		starting_lba = scsi_4btoul(cdb->begin_lba);
5629		block_count = scsi_2btoul(cdb->lb_count);
5630		break;
5631	}
5632	case SYNCHRONIZE_CACHE_16: {
5633		struct scsi_sync_cache_16 *cdb;
5634		cdb = (struct scsi_sync_cache_16 *)ctsio->cdb;
5635
5636		starting_lba = scsi_8btou64(cdb->begin_lba);
5637		block_count = scsi_4btoul(cdb->lb_count);
5638		break;
5639	}
5640	default:
5641		ctl_set_invalid_opcode(ctsio);
5642		ctl_done((union ctl_io *)ctsio);
5643		goto bailout;
5644		break; /* NOTREACHED */
5645	}
5646
5647	/*
5648	 * We check the LBA and length, but don't do anything with them.
5649	 * A SYNCHRONIZE CACHE will cause the entire cache for this lun to
5650	 * get flushed.  This check will just help satisfy anyone who wants
5651	 * to see an error for an out of range LBA.
5652	 */
5653	if ((starting_lba + block_count) > (lun->be_lun->maxlba + 1)) {
5654		ctl_set_lba_out_of_range(ctsio);
5655		ctl_done((union ctl_io *)ctsio);
5656		goto bailout;
5657	}
5658
5659	/*
5660	 * If this LUN has no backend, we can't flush the cache anyway.
5661	 */
5662	if (lun->backend == NULL) {
5663		ctl_set_invalid_opcode(ctsio);
5664		ctl_done((union ctl_io *)ctsio);
5665		goto bailout;
5666	}
5667
5668	/*
5669	 * Check to see whether we're configured to send the SYNCHRONIZE
5670	 * CACHE command directly to the back end.
5671	 */
5672	mtx_lock(&lun->lun_lock);
5673	if ((ctl_softc->flags & CTL_FLAG_REAL_SYNC)
5674	 && (++(lun->sync_count) >= lun->sync_interval)) {
5675		lun->sync_count = 0;
5676		mtx_unlock(&lun->lun_lock);
5677		retval = lun->backend->config_write((union ctl_io *)ctsio);
5678	} else {
5679		mtx_unlock(&lun->lun_lock);
5680		ctl_set_success(ctsio);
5681		ctl_done((union ctl_io *)ctsio);
5682	}
5683
5684bailout:
5685
5686	return (retval);
5687}
5688
5689int
5690ctl_format(struct ctl_scsiio *ctsio)
5691{
5692	struct scsi_format *cdb;
5693	struct ctl_lun *lun;
5694	struct ctl_softc *ctl_softc;
5695	int length, defect_list_len;
5696
5697	CTL_DEBUG_PRINT(("ctl_format\n"));
5698
5699	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5700	ctl_softc = control_softc;
5701
5702	cdb = (struct scsi_format *)ctsio->cdb;
5703
5704	length = 0;
5705	if (cdb->byte2 & SF_FMTDATA) {
5706		if (cdb->byte2 & SF_LONGLIST)
5707			length = sizeof(struct scsi_format_header_long);
5708		else
5709			length = sizeof(struct scsi_format_header_short);
5710	}
5711
5712	if (((ctsio->io_hdr.flags & CTL_FLAG_ALLOCATED) == 0)
5713	 && (length > 0)) {
5714		ctsio->kern_data_ptr = malloc(length, M_CTL, M_WAITOK);
5715		ctsio->kern_data_len = length;
5716		ctsio->kern_total_len = length;
5717		ctsio->kern_data_resid = 0;
5718		ctsio->kern_rel_offset = 0;
5719		ctsio->kern_sg_entries = 0;
5720		ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
5721		ctsio->be_move_done = ctl_config_move_done;
5722		ctl_datamove((union ctl_io *)ctsio);
5723
5724		return (CTL_RETVAL_COMPLETE);
5725	}
5726
5727	defect_list_len = 0;
5728
5729	if (cdb->byte2 & SF_FMTDATA) {
5730		if (cdb->byte2 & SF_LONGLIST) {
5731			struct scsi_format_header_long *header;
5732
5733			header = (struct scsi_format_header_long *)
5734				ctsio->kern_data_ptr;
5735
5736			defect_list_len = scsi_4btoul(header->defect_list_len);
5737			if (defect_list_len != 0) {
5738				ctl_set_invalid_field(ctsio,
5739						      /*sks_valid*/ 1,
5740						      /*command*/ 0,
5741						      /*field*/ 2,
5742						      /*bit_valid*/ 0,
5743						      /*bit*/ 0);
5744				goto bailout;
5745			}
5746		} else {
5747			struct scsi_format_header_short *header;
5748
5749			header = (struct scsi_format_header_short *)
5750				ctsio->kern_data_ptr;
5751
5752			defect_list_len = scsi_2btoul(header->defect_list_len);
5753			if (defect_list_len != 0) {
5754				ctl_set_invalid_field(ctsio,
5755						      /*sks_valid*/ 1,
5756						      /*command*/ 0,
5757						      /*field*/ 2,
5758						      /*bit_valid*/ 0,
5759						      /*bit*/ 0);
5760				goto bailout;
5761			}
5762		}
5763	}
5764
5765	/*
5766	 * The format command will clear out the "Medium format corrupted"
5767	 * status if set by the configuration code.  That status is really
5768	 * just a way to notify the host that we have lost the media, and
5769	 * get them to issue a command that will basically make them think
5770	 * they're blowing away the media.
5771	 */
5772	mtx_lock(&lun->lun_lock);
5773	lun->flags &= ~CTL_LUN_INOPERABLE;
5774	mtx_unlock(&lun->lun_lock);
5775
5776	ctsio->scsi_status = SCSI_STATUS_OK;
5777	ctsio->io_hdr.status = CTL_SUCCESS;
5778bailout:
5779
5780	if (ctsio->io_hdr.flags & CTL_FLAG_ALLOCATED) {
5781		free(ctsio->kern_data_ptr, M_CTL);
5782		ctsio->io_hdr.flags &= ~CTL_FLAG_ALLOCATED;
5783	}
5784
5785	ctl_done((union ctl_io *)ctsio);
5786	return (CTL_RETVAL_COMPLETE);
5787}
5788
5789int
5790ctl_read_buffer(struct ctl_scsiio *ctsio)
5791{
5792	struct scsi_read_buffer *cdb;
5793	struct ctl_lun *lun;
5794	int buffer_offset, len;
5795	static uint8_t descr[4];
5796	static uint8_t echo_descr[4] = { 0 };
5797
5798	CTL_DEBUG_PRINT(("ctl_read_buffer\n"));
5799
5800	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5801	cdb = (struct scsi_read_buffer *)ctsio->cdb;
5802
5803	if (lun->flags & CTL_LUN_PR_RESERVED) {
5804		uint32_t residx;
5805
5806		/*
5807		 * XXX KDM need a lock here.
5808		 */
5809		residx = ctl_get_resindex(&ctsio->io_hdr.nexus);
5810		if ((lun->res_type == SPR_TYPE_EX_AC
5811		  && residx != lun->pr_res_idx)
5812		 || ((lun->res_type == SPR_TYPE_EX_AC_RO
5813		   || lun->res_type == SPR_TYPE_EX_AC_AR)
5814		  && !lun->per_res[residx].registered)) {
5815			ctl_set_reservation_conflict(ctsio);
5816			ctl_done((union ctl_io *)ctsio);
5817			return (CTL_RETVAL_COMPLETE);
5818	        }
5819	}
5820
5821	if ((cdb->byte2 & RWB_MODE) != RWB_MODE_DATA &&
5822	    (cdb->byte2 & RWB_MODE) != RWB_MODE_ECHO_DESCR &&
5823	    (cdb->byte2 & RWB_MODE) != RWB_MODE_DESCR) {
5824		ctl_set_invalid_field(ctsio,
5825				      /*sks_valid*/ 1,
5826				      /*command*/ 1,
5827				      /*field*/ 1,
5828				      /*bit_valid*/ 1,
5829				      /*bit*/ 4);
5830		ctl_done((union ctl_io *)ctsio);
5831		return (CTL_RETVAL_COMPLETE);
5832	}
5833
5834	len = scsi_3btoul(cdb->length);
5835	buffer_offset = scsi_3btoul(cdb->offset);
5836
5837	if (buffer_offset + len > sizeof(lun->write_buffer)) {
5838		ctl_set_invalid_field(ctsio,
5839				      /*sks_valid*/ 1,
5840				      /*command*/ 1,
5841				      /*field*/ 6,
5842				      /*bit_valid*/ 0,
5843				      /*bit*/ 0);
5844		ctl_done((union ctl_io *)ctsio);
5845		return (CTL_RETVAL_COMPLETE);
5846	}
5847
5848	if ((cdb->byte2 & RWB_MODE) == RWB_MODE_DESCR) {
5849		descr[0] = 0;
5850		scsi_ulto3b(sizeof(lun->write_buffer), &descr[1]);
5851		ctsio->kern_data_ptr = descr;
5852		len = min(len, sizeof(descr));
5853	} else if ((cdb->byte2 & RWB_MODE) == RWB_MODE_ECHO_DESCR) {
5854		ctsio->kern_data_ptr = echo_descr;
5855		len = min(len, sizeof(echo_descr));
5856	} else
5857		ctsio->kern_data_ptr = lun->write_buffer + buffer_offset;
5858	ctsio->kern_data_len = len;
5859	ctsio->kern_total_len = len;
5860	ctsio->kern_data_resid = 0;
5861	ctsio->kern_rel_offset = 0;
5862	ctsio->kern_sg_entries = 0;
5863	ctsio->be_move_done = ctl_config_move_done;
5864	ctl_datamove((union ctl_io *)ctsio);
5865
5866	return (CTL_RETVAL_COMPLETE);
5867}
5868
5869int
5870ctl_write_buffer(struct ctl_scsiio *ctsio)
5871{
5872	struct scsi_write_buffer *cdb;
5873	struct ctl_lun *lun;
5874	int buffer_offset, len;
5875
5876	CTL_DEBUG_PRINT(("ctl_write_buffer\n"));
5877
5878	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5879	cdb = (struct scsi_write_buffer *)ctsio->cdb;
5880
5881	if ((cdb->byte2 & RWB_MODE) != RWB_MODE_DATA) {
5882		ctl_set_invalid_field(ctsio,
5883				      /*sks_valid*/ 1,
5884				      /*command*/ 1,
5885				      /*field*/ 1,
5886				      /*bit_valid*/ 1,
5887				      /*bit*/ 4);
5888		ctl_done((union ctl_io *)ctsio);
5889		return (CTL_RETVAL_COMPLETE);
5890	}
5891
5892	len = scsi_3btoul(cdb->length);
5893	buffer_offset = scsi_3btoul(cdb->offset);
5894
5895	if (buffer_offset + len > sizeof(lun->write_buffer)) {
5896		ctl_set_invalid_field(ctsio,
5897				      /*sks_valid*/ 1,
5898				      /*command*/ 1,
5899				      /*field*/ 6,
5900				      /*bit_valid*/ 0,
5901				      /*bit*/ 0);
5902		ctl_done((union ctl_io *)ctsio);
5903		return (CTL_RETVAL_COMPLETE);
5904	}
5905
5906	/*
5907	 * If we've got a kernel request that hasn't been malloced yet,
5908	 * malloc it and tell the caller the data buffer is here.
5909	 */
5910	if ((ctsio->io_hdr.flags & CTL_FLAG_ALLOCATED) == 0) {
5911		ctsio->kern_data_ptr = lun->write_buffer + buffer_offset;
5912		ctsio->kern_data_len = len;
5913		ctsio->kern_total_len = len;
5914		ctsio->kern_data_resid = 0;
5915		ctsio->kern_rel_offset = 0;
5916		ctsio->kern_sg_entries = 0;
5917		ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
5918		ctsio->be_move_done = ctl_config_move_done;
5919		ctl_datamove((union ctl_io *)ctsio);
5920
5921		return (CTL_RETVAL_COMPLETE);
5922	}
5923
5924	ctl_done((union ctl_io *)ctsio);
5925
5926	return (CTL_RETVAL_COMPLETE);
5927}
5928
5929int
5930ctl_write_same(struct ctl_scsiio *ctsio)
5931{
5932	struct ctl_lun *lun;
5933	struct ctl_lba_len_flags *lbalen;
5934	uint64_t lba;
5935	uint32_t num_blocks;
5936	int len, retval;
5937	uint8_t byte2;
5938
5939	retval = CTL_RETVAL_COMPLETE;
5940
5941	CTL_DEBUG_PRINT(("ctl_write_same\n"));
5942
5943	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5944
5945	switch (ctsio->cdb[0]) {
5946	case WRITE_SAME_10: {
5947		struct scsi_write_same_10 *cdb;
5948
5949		cdb = (struct scsi_write_same_10 *)ctsio->cdb;
5950
5951		lba = scsi_4btoul(cdb->addr);
5952		num_blocks = scsi_2btoul(cdb->length);
5953		byte2 = cdb->byte2;
5954		break;
5955	}
5956	case WRITE_SAME_16: {
5957		struct scsi_write_same_16 *cdb;
5958
5959		cdb = (struct scsi_write_same_16 *)ctsio->cdb;
5960
5961		lba = scsi_8btou64(cdb->addr);
5962		num_blocks = scsi_4btoul(cdb->length);
5963		byte2 = cdb->byte2;
5964		break;
5965	}
5966	default:
5967		/*
5968		 * We got a command we don't support.  This shouldn't
5969		 * happen, commands should be filtered out above us.
5970		 */
5971		ctl_set_invalid_opcode(ctsio);
5972		ctl_done((union ctl_io *)ctsio);
5973
5974		return (CTL_RETVAL_COMPLETE);
5975		break; /* NOTREACHED */
5976	}
5977
5978	/*
5979	 * The first check is to make sure we're in bounds, the second
5980	 * check is to catch wrap-around problems.  If the lba + num blocks
5981	 * is less than the lba, then we've wrapped around and the block
5982	 * range is invalid anyway.
5983	 */
5984	if (((lba + num_blocks) > (lun->be_lun->maxlba + 1))
5985	 || ((lba + num_blocks) < lba)) {
5986		ctl_set_lba_out_of_range(ctsio);
5987		ctl_done((union ctl_io *)ctsio);
5988		return (CTL_RETVAL_COMPLETE);
5989	}
5990
5991	/* Zero number of blocks means "to the last logical block" */
5992	if (num_blocks == 0) {
5993		if ((lun->be_lun->maxlba + 1) - lba > UINT32_MAX) {
5994			ctl_set_invalid_field(ctsio,
5995					      /*sks_valid*/ 0,
5996					      /*command*/ 1,
5997					      /*field*/ 0,
5998					      /*bit_valid*/ 0,
5999					      /*bit*/ 0);
6000			ctl_done((union ctl_io *)ctsio);
6001			return (CTL_RETVAL_COMPLETE);
6002		}
6003		num_blocks = (lun->be_lun->maxlba + 1) - lba;
6004	}
6005
6006	len = lun->be_lun->blocksize;
6007
6008	/*
6009	 * If we've got a kernel request that hasn't been malloced yet,
6010	 * malloc it and tell the caller the data buffer is here.
6011	 */
6012	if ((ctsio->io_hdr.flags & CTL_FLAG_ALLOCATED) == 0) {
6013		ctsio->kern_data_ptr = malloc(len, M_CTL, M_WAITOK);;
6014		ctsio->kern_data_len = len;
6015		ctsio->kern_total_len = len;
6016		ctsio->kern_data_resid = 0;
6017		ctsio->kern_rel_offset = 0;
6018		ctsio->kern_sg_entries = 0;
6019		ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
6020		ctsio->be_move_done = ctl_config_move_done;
6021		ctl_datamove((union ctl_io *)ctsio);
6022
6023		return (CTL_RETVAL_COMPLETE);
6024	}
6025
6026	lbalen = (struct ctl_lba_len_flags *)&ctsio->io_hdr.ctl_private[CTL_PRIV_LBA_LEN];
6027	lbalen->lba = lba;
6028	lbalen->len = num_blocks;
6029	lbalen->flags = byte2;
6030	retval = lun->backend->config_write((union ctl_io *)ctsio);
6031
6032	return (retval);
6033}
6034
6035int
6036ctl_unmap(struct ctl_scsiio *ctsio)
6037{
6038	struct ctl_lun *lun;
6039	struct scsi_unmap *cdb;
6040	struct ctl_ptr_len_flags *ptrlen;
6041	struct scsi_unmap_header *hdr;
6042	struct scsi_unmap_desc *buf, *end;
6043	uint64_t lba;
6044	uint32_t num_blocks;
6045	int len, retval;
6046	uint8_t byte2;
6047
6048	retval = CTL_RETVAL_COMPLETE;
6049
6050	CTL_DEBUG_PRINT(("ctl_unmap\n"));
6051
6052	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
6053	cdb = (struct scsi_unmap *)ctsio->cdb;
6054
6055	len = scsi_2btoul(cdb->length);
6056	byte2 = cdb->byte2;
6057
6058	/*
6059	 * If we've got a kernel request that hasn't been malloced yet,
6060	 * malloc it and tell the caller the data buffer is here.
6061	 */
6062	if ((ctsio->io_hdr.flags & CTL_FLAG_ALLOCATED) == 0) {
6063		ctsio->kern_data_ptr = malloc(len, M_CTL, M_WAITOK);;
6064		ctsio->kern_data_len = len;
6065		ctsio->kern_total_len = len;
6066		ctsio->kern_data_resid = 0;
6067		ctsio->kern_rel_offset = 0;
6068		ctsio->kern_sg_entries = 0;
6069		ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
6070		ctsio->be_move_done = ctl_config_move_done;
6071		ctl_datamove((union ctl_io *)ctsio);
6072
6073		return (CTL_RETVAL_COMPLETE);
6074	}
6075
6076	len = ctsio->kern_total_len - ctsio->kern_data_resid;
6077	hdr = (struct scsi_unmap_header *)ctsio->kern_data_ptr;
6078	if (len < sizeof (*hdr) ||
6079	    len < (scsi_2btoul(hdr->length) + sizeof(hdr->length)) ||
6080	    len < (scsi_2btoul(hdr->desc_length) + sizeof (*hdr)) ||
6081	    scsi_2btoul(hdr->desc_length) % sizeof(*buf) != 0) {
6082		ctl_set_invalid_field(ctsio,
6083				      /*sks_valid*/ 0,
6084				      /*command*/ 0,
6085				      /*field*/ 0,
6086				      /*bit_valid*/ 0,
6087				      /*bit*/ 0);
6088		ctl_done((union ctl_io *)ctsio);
6089		return (CTL_RETVAL_COMPLETE);
6090	}
6091	len = scsi_2btoul(hdr->desc_length);
6092	buf = (struct scsi_unmap_desc *)(hdr + 1);
6093	end = buf + len / sizeof(*buf);
6094
6095	ptrlen = (struct ctl_ptr_len_flags *)&ctsio->io_hdr.ctl_private[CTL_PRIV_LBA_LEN];
6096	ptrlen->ptr = (void *)buf;
6097	ptrlen->len = len;
6098	ptrlen->flags = byte2;
6099
6100	for (; buf < end; buf++) {
6101		lba = scsi_8btou64(buf->lba);
6102		num_blocks = scsi_4btoul(buf->length);
6103		if (((lba + num_blocks) > (lun->be_lun->maxlba + 1))
6104		 || ((lba + num_blocks) < lba)) {
6105			ctl_set_lba_out_of_range(ctsio);
6106			ctl_done((union ctl_io *)ctsio);
6107			return (CTL_RETVAL_COMPLETE);
6108		}
6109	}
6110
6111	retval = lun->backend->config_write((union ctl_io *)ctsio);
6112
6113	return (retval);
6114}
6115
6116/*
6117 * Note that this function currently doesn't actually do anything inside
6118 * CTL to enforce things if the DQue bit is turned on.
6119 *
6120 * Also note that this function can't be used in the default case, because
6121 * the DQue bit isn't set in the changeable mask for the control mode page
6122 * anyway.  This is just here as an example for how to implement a page
6123 * handler, and a placeholder in case we want to allow the user to turn
6124 * tagged queueing on and off.
6125 *
6126 * The D_SENSE bit handling is functional, however, and will turn
6127 * descriptor sense on and off for a given LUN.
6128 */
6129int
6130ctl_control_page_handler(struct ctl_scsiio *ctsio,
6131			 struct ctl_page_index *page_index, uint8_t *page_ptr)
6132{
6133	struct scsi_control_page *current_cp, *saved_cp, *user_cp;
6134	struct ctl_lun *lun;
6135	struct ctl_softc *softc;
6136	int set_ua;
6137	uint32_t initidx;
6138
6139	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
6140	initidx = ctl_get_initindex(&ctsio->io_hdr.nexus);
6141	set_ua = 0;
6142
6143	user_cp = (struct scsi_control_page *)page_ptr;
6144	current_cp = (struct scsi_control_page *)
6145		(page_index->page_data + (page_index->page_len *
6146		CTL_PAGE_CURRENT));
6147	saved_cp = (struct scsi_control_page *)
6148		(page_index->page_data + (page_index->page_len *
6149		CTL_PAGE_SAVED));
6150
6151	softc = control_softc;
6152
6153	mtx_lock(&lun->lun_lock);
6154	if (((current_cp->rlec & SCP_DSENSE) == 0)
6155	 && ((user_cp->rlec & SCP_DSENSE) != 0)) {
6156		/*
6157		 * Descriptor sense is currently turned off and the user
6158		 * wants to turn it on.
6159		 */
6160		current_cp->rlec |= SCP_DSENSE;
6161		saved_cp->rlec |= SCP_DSENSE;
6162		lun->flags |= CTL_LUN_SENSE_DESC;
6163		set_ua = 1;
6164	} else if (((current_cp->rlec & SCP_DSENSE) != 0)
6165		&& ((user_cp->rlec & SCP_DSENSE) == 0)) {
6166		/*
6167		 * Descriptor sense is currently turned on, and the user
6168		 * wants to turn it off.
6169		 */
6170		current_cp->rlec &= ~SCP_DSENSE;
6171		saved_cp->rlec &= ~SCP_DSENSE;
6172		lun->flags &= ~CTL_LUN_SENSE_DESC;
6173		set_ua = 1;
6174	}
6175	if (current_cp->queue_flags & SCP_QUEUE_DQUE) {
6176		if (user_cp->queue_flags & SCP_QUEUE_DQUE) {
6177#ifdef NEEDTOPORT
6178			csevent_log(CSC_CTL | CSC_SHELF_SW |
6179				    CTL_UNTAG_TO_UNTAG,
6180				    csevent_LogType_Trace,
6181				    csevent_Severity_Information,
6182				    csevent_AlertLevel_Green,
6183				    csevent_FRU_Firmware,
6184				    csevent_FRU_Unknown,
6185				    "Received untagged to untagged transition");
6186#endif /* NEEDTOPORT */
6187		} else {
6188#ifdef NEEDTOPORT
6189			csevent_log(CSC_CTL | CSC_SHELF_SW |
6190				    CTL_UNTAG_TO_TAG,
6191				    csevent_LogType_ConfigChange,
6192				    csevent_Severity_Information,
6193				    csevent_AlertLevel_Green,
6194				    csevent_FRU_Firmware,
6195				    csevent_FRU_Unknown,
6196				    "Received untagged to tagged "
6197				    "queueing transition");
6198#endif /* NEEDTOPORT */
6199
6200			current_cp->queue_flags &= ~SCP_QUEUE_DQUE;
6201			saved_cp->queue_flags &= ~SCP_QUEUE_DQUE;
6202			set_ua = 1;
6203		}
6204	} else {
6205		if (user_cp->queue_flags & SCP_QUEUE_DQUE) {
6206#ifdef NEEDTOPORT
6207			csevent_log(CSC_CTL | CSC_SHELF_SW |
6208				    CTL_TAG_TO_UNTAG,
6209				    csevent_LogType_ConfigChange,
6210				    csevent_Severity_Warning,
6211				    csevent_AlertLevel_Yellow,
6212				    csevent_FRU_Firmware,
6213				    csevent_FRU_Unknown,
6214				    "Received tagged queueing to untagged "
6215				    "transition");
6216#endif /* NEEDTOPORT */
6217
6218			current_cp->queue_flags |= SCP_QUEUE_DQUE;
6219			saved_cp->queue_flags |= SCP_QUEUE_DQUE;
6220			set_ua = 1;
6221		} else {
6222#ifdef NEEDTOPORT
6223			csevent_log(CSC_CTL | CSC_SHELF_SW |
6224				    CTL_TAG_TO_TAG,
6225				    csevent_LogType_Trace,
6226				    csevent_Severity_Information,
6227				    csevent_AlertLevel_Green,
6228				    csevent_FRU_Firmware,
6229				    csevent_FRU_Unknown,
6230				    "Received tagged queueing to tagged "
6231				    "queueing transition");
6232#endif /* NEEDTOPORT */
6233		}
6234	}
6235	if (set_ua != 0) {
6236		int i;
6237		/*
6238		 * Let other initiators know that the mode
6239		 * parameters for this LUN have changed.
6240		 */
6241		for (i = 0; i < CTL_MAX_INITIATORS; i++) {
6242			if (i == initidx)
6243				continue;
6244
6245			lun->pending_ua[i] |= CTL_UA_MODE_CHANGE;
6246		}
6247	}
6248	mtx_unlock(&lun->lun_lock);
6249
6250	return (0);
6251}
6252
6253int
6254ctl_caching_sp_handler(struct ctl_scsiio *ctsio,
6255		     struct ctl_page_index *page_index, uint8_t *page_ptr)
6256{
6257	struct scsi_caching_page *current_cp, *saved_cp, *user_cp;
6258	struct ctl_lun *lun;
6259	int set_ua;
6260	uint32_t initidx;
6261
6262	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
6263	initidx = ctl_get_initindex(&ctsio->io_hdr.nexus);
6264	set_ua = 0;
6265
6266	user_cp = (struct scsi_caching_page *)page_ptr;
6267	current_cp = (struct scsi_caching_page *)
6268		(page_index->page_data + (page_index->page_len *
6269		CTL_PAGE_CURRENT));
6270	saved_cp = (struct scsi_caching_page *)
6271		(page_index->page_data + (page_index->page_len *
6272		CTL_PAGE_SAVED));
6273
6274	mtx_lock(&lun->lun_lock);
6275	if ((current_cp->flags1 & (SCP_WCE | SCP_RCD)) !=
6276	    (user_cp->flags1 & (SCP_WCE | SCP_RCD)))
6277		set_ua = 1;
6278	current_cp->flags1 &= ~(SCP_WCE | SCP_RCD);
6279	current_cp->flags1 |= user_cp->flags1 & (SCP_WCE | SCP_RCD);
6280	saved_cp->flags1 &= ~(SCP_WCE | SCP_RCD);
6281	saved_cp->flags1 |= user_cp->flags1 & (SCP_WCE | SCP_RCD);
6282	if (set_ua != 0) {
6283		int i;
6284		/*
6285		 * Let other initiators know that the mode
6286		 * parameters for this LUN have changed.
6287		 */
6288		for (i = 0; i < CTL_MAX_INITIATORS; i++) {
6289			if (i == initidx)
6290				continue;
6291
6292			lun->pending_ua[i] |= CTL_UA_MODE_CHANGE;
6293		}
6294	}
6295	mtx_unlock(&lun->lun_lock);
6296
6297	return (0);
6298}
6299
6300int
6301ctl_power_sp_handler(struct ctl_scsiio *ctsio,
6302		     struct ctl_page_index *page_index, uint8_t *page_ptr)
6303{
6304	return (0);
6305}
6306
6307int
6308ctl_power_sp_sense_handler(struct ctl_scsiio *ctsio,
6309			   struct ctl_page_index *page_index, int pc)
6310{
6311	struct copan_power_subpage *page;
6312
6313	page = (struct copan_power_subpage *)page_index->page_data +
6314		(page_index->page_len * pc);
6315
6316	switch (pc) {
6317	case SMS_PAGE_CTRL_CHANGEABLE >> 6:
6318		/*
6319		 * We don't update the changable bits for this page.
6320		 */
6321		break;
6322	case SMS_PAGE_CTRL_CURRENT >> 6:
6323	case SMS_PAGE_CTRL_DEFAULT >> 6:
6324	case SMS_PAGE_CTRL_SAVED >> 6:
6325#ifdef NEEDTOPORT
6326		ctl_update_power_subpage(page);
6327#endif
6328		break;
6329	default:
6330#ifdef NEEDTOPORT
6331		EPRINT(0, "Invalid PC %d!!", pc);
6332#endif
6333		break;
6334	}
6335	return (0);
6336}
6337
6338
6339int
6340ctl_aps_sp_handler(struct ctl_scsiio *ctsio,
6341		   struct ctl_page_index *page_index, uint8_t *page_ptr)
6342{
6343	struct copan_aps_subpage *user_sp;
6344	struct copan_aps_subpage *current_sp;
6345	union ctl_modepage_info *modepage_info;
6346	struct ctl_softc *softc;
6347	struct ctl_lun *lun;
6348	int retval;
6349
6350	retval = CTL_RETVAL_COMPLETE;
6351	current_sp = (struct copan_aps_subpage *)(page_index->page_data +
6352		     (page_index->page_len * CTL_PAGE_CURRENT));
6353	softc = control_softc;
6354	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
6355
6356	user_sp = (struct copan_aps_subpage *)page_ptr;
6357
6358	modepage_info = (union ctl_modepage_info *)
6359		ctsio->io_hdr.ctl_private[CTL_PRIV_MODEPAGE].bytes;
6360
6361	modepage_info->header.page_code = page_index->page_code & SMPH_PC_MASK;
6362	modepage_info->header.subpage = page_index->subpage;
6363	modepage_info->aps.lock_active = user_sp->lock_active;
6364
6365	mtx_lock(&softc->ctl_lock);
6366
6367	/*
6368	 * If there is a request to lock the LUN and another LUN is locked
6369	 * this is an error. If the requested LUN is already locked ignore
6370	 * the request. If no LUN is locked attempt to lock it.
6371	 * if there is a request to unlock the LUN and the LUN is currently
6372	 * locked attempt to unlock it. Otherwise ignore the request. i.e.
6373	 * if another LUN is locked or no LUN is locked.
6374	 */
6375	if (user_sp->lock_active & APS_LOCK_ACTIVE) {
6376		if (softc->aps_locked_lun == lun->lun) {
6377			/*
6378			 * This LUN is already locked, so we're done.
6379			 */
6380			retval = CTL_RETVAL_COMPLETE;
6381		} else if (softc->aps_locked_lun == 0) {
6382			/*
6383			 * No one has the lock, pass the request to the
6384			 * backend.
6385			 */
6386			retval = lun->backend->config_write(
6387				(union ctl_io *)ctsio);
6388		} else {
6389			/*
6390			 * Someone else has the lock, throw out the request.
6391			 */
6392			ctl_set_already_locked(ctsio);
6393			free(ctsio->kern_data_ptr, M_CTL);
6394			ctl_done((union ctl_io *)ctsio);
6395
6396			/*
6397			 * Set the return value so that ctl_do_mode_select()
6398			 * won't try to complete the command.  We already
6399			 * completed it here.
6400			 */
6401			retval = CTL_RETVAL_ERROR;
6402		}
6403	} else if (softc->aps_locked_lun == lun->lun) {
6404		/*
6405		 * This LUN is locked, so pass the unlock request to the
6406		 * backend.
6407		 */
6408		retval = lun->backend->config_write((union ctl_io *)ctsio);
6409	}
6410	mtx_unlock(&softc->ctl_lock);
6411
6412	return (retval);
6413}
6414
6415int
6416ctl_debugconf_sp_select_handler(struct ctl_scsiio *ctsio,
6417				struct ctl_page_index *page_index,
6418				uint8_t *page_ptr)
6419{
6420	uint8_t *c;
6421	int i;
6422
6423	c = ((struct copan_debugconf_subpage *)page_ptr)->ctl_time_io_secs;
6424	ctl_time_io_secs =
6425		(c[0] << 8) |
6426		(c[1] << 0) |
6427		0;
6428	CTL_DEBUG_PRINT(("set ctl_time_io_secs to %d\n", ctl_time_io_secs));
6429	printf("set ctl_time_io_secs to %d\n", ctl_time_io_secs);
6430	printf("page data:");
6431	for (i=0; i<8; i++)
6432		printf(" %.2x",page_ptr[i]);
6433	printf("\n");
6434	return (0);
6435}
6436
6437int
6438ctl_debugconf_sp_sense_handler(struct ctl_scsiio *ctsio,
6439			       struct ctl_page_index *page_index,
6440			       int pc)
6441{
6442	struct copan_debugconf_subpage *page;
6443
6444	page = (struct copan_debugconf_subpage *)page_index->page_data +
6445		(page_index->page_len * pc);
6446
6447	switch (pc) {
6448	case SMS_PAGE_CTRL_CHANGEABLE >> 6:
6449	case SMS_PAGE_CTRL_DEFAULT >> 6:
6450	case SMS_PAGE_CTRL_SAVED >> 6:
6451		/*
6452		 * We don't update the changable or default bits for this page.
6453		 */
6454		break;
6455	case SMS_PAGE_CTRL_CURRENT >> 6:
6456		page->ctl_time_io_secs[0] = ctl_time_io_secs >> 8;
6457		page->ctl_time_io_secs[1] = ctl_time_io_secs >> 0;
6458		break;
6459	default:
6460#ifdef NEEDTOPORT
6461		EPRINT(0, "Invalid PC %d!!", pc);
6462#endif /* NEEDTOPORT */
6463		break;
6464	}
6465	return (0);
6466}
6467
6468
6469static int
6470ctl_do_mode_select(union ctl_io *io)
6471{
6472	struct scsi_mode_page_header *page_header;
6473	struct ctl_page_index *page_index;
6474	struct ctl_scsiio *ctsio;
6475	int control_dev, page_len;
6476	int page_len_offset, page_len_size;
6477	union ctl_modepage_info *modepage_info;
6478	struct ctl_lun *lun;
6479	int *len_left, *len_used;
6480	int retval, i;
6481
6482	ctsio = &io->scsiio;
6483	page_index = NULL;
6484	page_len = 0;
6485	retval = CTL_RETVAL_COMPLETE;
6486
6487	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
6488
6489	if (lun->be_lun->lun_type != T_DIRECT)
6490		control_dev = 1;
6491	else
6492		control_dev = 0;
6493
6494	modepage_info = (union ctl_modepage_info *)
6495		ctsio->io_hdr.ctl_private[CTL_PRIV_MODEPAGE].bytes;
6496	len_left = &modepage_info->header.len_left;
6497	len_used = &modepage_info->header.len_used;
6498
6499do_next_page:
6500
6501	page_header = (struct scsi_mode_page_header *)
6502		(ctsio->kern_data_ptr + *len_used);
6503
6504	if (*len_left == 0) {
6505		free(ctsio->kern_data_ptr, M_CTL);
6506		ctl_set_success(ctsio);
6507		ctl_done((union ctl_io *)ctsio);
6508		return (CTL_RETVAL_COMPLETE);
6509	} else if (*len_left < sizeof(struct scsi_mode_page_header)) {
6510
6511		free(ctsio->kern_data_ptr, M_CTL);
6512		ctl_set_param_len_error(ctsio);
6513		ctl_done((union ctl_io *)ctsio);
6514		return (CTL_RETVAL_COMPLETE);
6515
6516	} else if ((page_header->page_code & SMPH_SPF)
6517		&& (*len_left < sizeof(struct scsi_mode_page_header_sp))) {
6518
6519		free(ctsio->kern_data_ptr, M_CTL);
6520		ctl_set_param_len_error(ctsio);
6521		ctl_done((union ctl_io *)ctsio);
6522		return (CTL_RETVAL_COMPLETE);
6523	}
6524
6525
6526	/*
6527	 * XXX KDM should we do something with the block descriptor?
6528	 */
6529	for (i = 0; i < CTL_NUM_MODE_PAGES; i++) {
6530
6531		if ((control_dev != 0)
6532		 && (lun->mode_pages.index[i].page_flags &
6533		     CTL_PAGE_FLAG_DISK_ONLY))
6534			continue;
6535
6536		if ((lun->mode_pages.index[i].page_code & SMPH_PC_MASK) !=
6537		    (page_header->page_code & SMPH_PC_MASK))
6538			continue;
6539
6540		/*
6541		 * If neither page has a subpage code, then we've got a
6542		 * match.
6543		 */
6544		if (((lun->mode_pages.index[i].page_code & SMPH_SPF) == 0)
6545		 && ((page_header->page_code & SMPH_SPF) == 0)) {
6546			page_index = &lun->mode_pages.index[i];
6547			page_len = page_header->page_length;
6548			break;
6549		}
6550
6551		/*
6552		 * If both pages have subpages, then the subpage numbers
6553		 * have to match.
6554		 */
6555		if ((lun->mode_pages.index[i].page_code & SMPH_SPF)
6556		  && (page_header->page_code & SMPH_SPF)) {
6557			struct scsi_mode_page_header_sp *sph;
6558
6559			sph = (struct scsi_mode_page_header_sp *)page_header;
6560
6561			if (lun->mode_pages.index[i].subpage ==
6562			    sph->subpage) {
6563				page_index = &lun->mode_pages.index[i];
6564				page_len = scsi_2btoul(sph->page_length);
6565				break;
6566			}
6567		}
6568	}
6569
6570	/*
6571	 * If we couldn't find the page, or if we don't have a mode select
6572	 * handler for it, send back an error to the user.
6573	 */
6574	if ((page_index == NULL)
6575	 || (page_index->select_handler == NULL)) {
6576		ctl_set_invalid_field(ctsio,
6577				      /*sks_valid*/ 1,
6578				      /*command*/ 0,
6579				      /*field*/ *len_used,
6580				      /*bit_valid*/ 0,
6581				      /*bit*/ 0);
6582		free(ctsio->kern_data_ptr, M_CTL);
6583		ctl_done((union ctl_io *)ctsio);
6584		return (CTL_RETVAL_COMPLETE);
6585	}
6586
6587	if (page_index->page_code & SMPH_SPF) {
6588		page_len_offset = 2;
6589		page_len_size = 2;
6590	} else {
6591		page_len_size = 1;
6592		page_len_offset = 1;
6593	}
6594
6595	/*
6596	 * If the length the initiator gives us isn't the one we specify in
6597	 * the mode page header, or if they didn't specify enough data in
6598	 * the CDB to avoid truncating this page, kick out the request.
6599	 */
6600	if ((page_len != (page_index->page_len - page_len_offset -
6601			  page_len_size))
6602	 || (*len_left < page_index->page_len)) {
6603
6604
6605		ctl_set_invalid_field(ctsio,
6606				      /*sks_valid*/ 1,
6607				      /*command*/ 0,
6608				      /*field*/ *len_used + page_len_offset,
6609				      /*bit_valid*/ 0,
6610				      /*bit*/ 0);
6611		free(ctsio->kern_data_ptr, M_CTL);
6612		ctl_done((union ctl_io *)ctsio);
6613		return (CTL_RETVAL_COMPLETE);
6614	}
6615
6616	/*
6617	 * Run through the mode page, checking to make sure that the bits
6618	 * the user changed are actually legal for him to change.
6619	 */
6620	for (i = 0; i < page_index->page_len; i++) {
6621		uint8_t *user_byte, *change_mask, *current_byte;
6622		int bad_bit;
6623		int j;
6624
6625		user_byte = (uint8_t *)page_header + i;
6626		change_mask = page_index->page_data +
6627			      (page_index->page_len * CTL_PAGE_CHANGEABLE) + i;
6628		current_byte = page_index->page_data +
6629			       (page_index->page_len * CTL_PAGE_CURRENT) + i;
6630
6631		/*
6632		 * Check to see whether the user set any bits in this byte
6633		 * that he is not allowed to set.
6634		 */
6635		if ((*user_byte & ~(*change_mask)) ==
6636		    (*current_byte & ~(*change_mask)))
6637			continue;
6638
6639		/*
6640		 * Go through bit by bit to determine which one is illegal.
6641		 */
6642		bad_bit = 0;
6643		for (j = 7; j >= 0; j--) {
6644			if ((((1 << i) & ~(*change_mask)) & *user_byte) !=
6645			    (((1 << i) & ~(*change_mask)) & *current_byte)) {
6646				bad_bit = i;
6647				break;
6648			}
6649		}
6650		ctl_set_invalid_field(ctsio,
6651				      /*sks_valid*/ 1,
6652				      /*command*/ 0,
6653				      /*field*/ *len_used + i,
6654				      /*bit_valid*/ 1,
6655				      /*bit*/ bad_bit);
6656		free(ctsio->kern_data_ptr, M_CTL);
6657		ctl_done((union ctl_io *)ctsio);
6658		return (CTL_RETVAL_COMPLETE);
6659	}
6660
6661	/*
6662	 * Decrement these before we call the page handler, since we may
6663	 * end up getting called back one way or another before the handler
6664	 * returns to this context.
6665	 */
6666	*len_left -= page_index->page_len;
6667	*len_used += page_index->page_len;
6668
6669	retval = page_index->select_handler(ctsio, page_index,
6670					    (uint8_t *)page_header);
6671
6672	/*
6673	 * If the page handler returns CTL_RETVAL_QUEUED, then we need to
6674	 * wait until this queued command completes to finish processing
6675	 * the mode page.  If it returns anything other than
6676	 * CTL_RETVAL_COMPLETE (e.g. CTL_RETVAL_ERROR), then it should have
6677	 * already set the sense information, freed the data pointer, and
6678	 * completed the io for us.
6679	 */
6680	if (retval != CTL_RETVAL_COMPLETE)
6681		goto bailout_no_done;
6682
6683	/*
6684	 * If the initiator sent us more than one page, parse the next one.
6685	 */
6686	if (*len_left > 0)
6687		goto do_next_page;
6688
6689	ctl_set_success(ctsio);
6690	free(ctsio->kern_data_ptr, M_CTL);
6691	ctl_done((union ctl_io *)ctsio);
6692
6693bailout_no_done:
6694
6695	return (CTL_RETVAL_COMPLETE);
6696
6697}
6698
6699int
6700ctl_mode_select(struct ctl_scsiio *ctsio)
6701{
6702	int param_len, pf, sp;
6703	int header_size, bd_len;
6704	int len_left, len_used;
6705	struct ctl_page_index *page_index;
6706	struct ctl_lun *lun;
6707	int control_dev, page_len;
6708	union ctl_modepage_info *modepage_info;
6709	int retval;
6710
6711	pf = 0;
6712	sp = 0;
6713	page_len = 0;
6714	len_used = 0;
6715	len_left = 0;
6716	retval = 0;
6717	bd_len = 0;
6718	page_index = NULL;
6719
6720	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
6721
6722	if (lun->be_lun->lun_type != T_DIRECT)
6723		control_dev = 1;
6724	else
6725		control_dev = 0;
6726
6727	switch (ctsio->cdb[0]) {
6728	case MODE_SELECT_6: {
6729		struct scsi_mode_select_6 *cdb;
6730
6731		cdb = (struct scsi_mode_select_6 *)ctsio->cdb;
6732
6733		pf = (cdb->byte2 & SMS_PF) ? 1 : 0;
6734		sp = (cdb->byte2 & SMS_SP) ? 1 : 0;
6735
6736		param_len = cdb->length;
6737		header_size = sizeof(struct scsi_mode_header_6);
6738		break;
6739	}
6740	case MODE_SELECT_10: {
6741		struct scsi_mode_select_10 *cdb;
6742
6743		cdb = (struct scsi_mode_select_10 *)ctsio->cdb;
6744
6745		pf = (cdb->byte2 & SMS_PF) ? 1 : 0;
6746		sp = (cdb->byte2 & SMS_SP) ? 1 : 0;
6747
6748		param_len = scsi_2btoul(cdb->length);
6749		header_size = sizeof(struct scsi_mode_header_10);
6750		break;
6751	}
6752	default:
6753		ctl_set_invalid_opcode(ctsio);
6754		ctl_done((union ctl_io *)ctsio);
6755		return (CTL_RETVAL_COMPLETE);
6756		break; /* NOTREACHED */
6757	}
6758
6759	/*
6760	 * From SPC-3:
6761	 * "A parameter list length of zero indicates that the Data-Out Buffer
6762	 * shall be empty. This condition shall not be considered as an error."
6763	 */
6764	if (param_len == 0) {
6765		ctl_set_success(ctsio);
6766		ctl_done((union ctl_io *)ctsio);
6767		return (CTL_RETVAL_COMPLETE);
6768	}
6769
6770	/*
6771	 * Since we'll hit this the first time through, prior to
6772	 * allocation, we don't need to free a data buffer here.
6773	 */
6774	if (param_len < header_size) {
6775		ctl_set_param_len_error(ctsio);
6776		ctl_done((union ctl_io *)ctsio);
6777		return (CTL_RETVAL_COMPLETE);
6778	}
6779
6780	/*
6781	 * Allocate the data buffer and grab the user's data.  In theory,
6782	 * we shouldn't have to sanity check the parameter list length here
6783	 * because the maximum size is 64K.  We should be able to malloc
6784	 * that much without too many problems.
6785	 */
6786	if ((ctsio->io_hdr.flags & CTL_FLAG_ALLOCATED) == 0) {
6787		ctsio->kern_data_ptr = malloc(param_len, M_CTL, M_WAITOK);
6788		ctsio->kern_data_len = param_len;
6789		ctsio->kern_total_len = param_len;
6790		ctsio->kern_data_resid = 0;
6791		ctsio->kern_rel_offset = 0;
6792		ctsio->kern_sg_entries = 0;
6793		ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
6794		ctsio->be_move_done = ctl_config_move_done;
6795		ctl_datamove((union ctl_io *)ctsio);
6796
6797		return (CTL_RETVAL_COMPLETE);
6798	}
6799
6800	switch (ctsio->cdb[0]) {
6801	case MODE_SELECT_6: {
6802		struct scsi_mode_header_6 *mh6;
6803
6804		mh6 = (struct scsi_mode_header_6 *)ctsio->kern_data_ptr;
6805		bd_len = mh6->blk_desc_len;
6806		break;
6807	}
6808	case MODE_SELECT_10: {
6809		struct scsi_mode_header_10 *mh10;
6810
6811		mh10 = (struct scsi_mode_header_10 *)ctsio->kern_data_ptr;
6812		bd_len = scsi_2btoul(mh10->blk_desc_len);
6813		break;
6814	}
6815	default:
6816		panic("Invalid CDB type %#x", ctsio->cdb[0]);
6817		break;
6818	}
6819
6820	if (param_len < (header_size + bd_len)) {
6821		free(ctsio->kern_data_ptr, M_CTL);
6822		ctl_set_param_len_error(ctsio);
6823		ctl_done((union ctl_io *)ctsio);
6824		return (CTL_RETVAL_COMPLETE);
6825	}
6826
6827	/*
6828	 * Set the IO_CONT flag, so that if this I/O gets passed to
6829	 * ctl_config_write_done(), it'll get passed back to
6830	 * ctl_do_mode_select() for further processing, or completion if
6831	 * we're all done.
6832	 */
6833	ctsio->io_hdr.flags |= CTL_FLAG_IO_CONT;
6834	ctsio->io_cont = ctl_do_mode_select;
6835
6836	modepage_info = (union ctl_modepage_info *)
6837		ctsio->io_hdr.ctl_private[CTL_PRIV_MODEPAGE].bytes;
6838
6839	memset(modepage_info, 0, sizeof(*modepage_info));
6840
6841	len_left = param_len - header_size - bd_len;
6842	len_used = header_size + bd_len;
6843
6844	modepage_info->header.len_left = len_left;
6845	modepage_info->header.len_used = len_used;
6846
6847	return (ctl_do_mode_select((union ctl_io *)ctsio));
6848}
6849
6850int
6851ctl_mode_sense(struct ctl_scsiio *ctsio)
6852{
6853	struct ctl_lun *lun;
6854	int pc, page_code, dbd, llba, subpage;
6855	int alloc_len, page_len, header_len, total_len;
6856	struct scsi_mode_block_descr *block_desc;
6857	struct ctl_page_index *page_index;
6858	int control_dev;
6859
6860	dbd = 0;
6861	llba = 0;
6862	block_desc = NULL;
6863	page_index = NULL;
6864
6865	CTL_DEBUG_PRINT(("ctl_mode_sense\n"));
6866
6867	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
6868
6869	if (lun->be_lun->lun_type != T_DIRECT)
6870		control_dev = 1;
6871	else
6872		control_dev = 0;
6873
6874	if (lun->flags & CTL_LUN_PR_RESERVED) {
6875		uint32_t residx;
6876
6877		/*
6878		 * XXX KDM need a lock here.
6879		 */
6880		residx = ctl_get_resindex(&ctsio->io_hdr.nexus);
6881		if ((lun->res_type == SPR_TYPE_EX_AC
6882		  && residx != lun->pr_res_idx)
6883		 || ((lun->res_type == SPR_TYPE_EX_AC_RO
6884		   || lun->res_type == SPR_TYPE_EX_AC_AR)
6885		  && !lun->per_res[residx].registered)) {
6886			ctl_set_reservation_conflict(ctsio);
6887			ctl_done((union ctl_io *)ctsio);
6888			return (CTL_RETVAL_COMPLETE);
6889		}
6890	}
6891
6892	switch (ctsio->cdb[0]) {
6893	case MODE_SENSE_6: {
6894		struct scsi_mode_sense_6 *cdb;
6895
6896		cdb = (struct scsi_mode_sense_6 *)ctsio->cdb;
6897
6898		header_len = sizeof(struct scsi_mode_hdr_6);
6899		if (cdb->byte2 & SMS_DBD)
6900			dbd = 1;
6901		else
6902			header_len += sizeof(struct scsi_mode_block_descr);
6903
6904		pc = (cdb->page & SMS_PAGE_CTRL_MASK) >> 6;
6905		page_code = cdb->page & SMS_PAGE_CODE;
6906		subpage = cdb->subpage;
6907		alloc_len = cdb->length;
6908		break;
6909	}
6910	case MODE_SENSE_10: {
6911		struct scsi_mode_sense_10 *cdb;
6912
6913		cdb = (struct scsi_mode_sense_10 *)ctsio->cdb;
6914
6915		header_len = sizeof(struct scsi_mode_hdr_10);
6916
6917		if (cdb->byte2 & SMS_DBD)
6918			dbd = 1;
6919		else
6920			header_len += sizeof(struct scsi_mode_block_descr);
6921		if (cdb->byte2 & SMS10_LLBAA)
6922			llba = 1;
6923		pc = (cdb->page & SMS_PAGE_CTRL_MASK) >> 6;
6924		page_code = cdb->page & SMS_PAGE_CODE;
6925		subpage = cdb->subpage;
6926		alloc_len = scsi_2btoul(cdb->length);
6927		break;
6928	}
6929	default:
6930		ctl_set_invalid_opcode(ctsio);
6931		ctl_done((union ctl_io *)ctsio);
6932		return (CTL_RETVAL_COMPLETE);
6933		break; /* NOTREACHED */
6934	}
6935
6936	/*
6937	 * We have to make a first pass through to calculate the size of
6938	 * the pages that match the user's query.  Then we allocate enough
6939	 * memory to hold it, and actually copy the data into the buffer.
6940	 */
6941	switch (page_code) {
6942	case SMS_ALL_PAGES_PAGE: {
6943		int i;
6944
6945		page_len = 0;
6946
6947		/*
6948		 * At the moment, values other than 0 and 0xff here are
6949		 * reserved according to SPC-3.
6950		 */
6951		if ((subpage != SMS_SUBPAGE_PAGE_0)
6952		 && (subpage != SMS_SUBPAGE_ALL)) {
6953			ctl_set_invalid_field(ctsio,
6954					      /*sks_valid*/ 1,
6955					      /*command*/ 1,
6956					      /*field*/ 3,
6957					      /*bit_valid*/ 0,
6958					      /*bit*/ 0);
6959			ctl_done((union ctl_io *)ctsio);
6960			return (CTL_RETVAL_COMPLETE);
6961		}
6962
6963		for (i = 0; i < CTL_NUM_MODE_PAGES; i++) {
6964			if ((control_dev != 0)
6965			 && (lun->mode_pages.index[i].page_flags &
6966			     CTL_PAGE_FLAG_DISK_ONLY))
6967				continue;
6968
6969			/*
6970			 * We don't use this subpage if the user didn't
6971			 * request all subpages.
6972			 */
6973			if ((lun->mode_pages.index[i].subpage != 0)
6974			 && (subpage == SMS_SUBPAGE_PAGE_0))
6975				continue;
6976
6977#if 0
6978			printf("found page %#x len %d\n",
6979			       lun->mode_pages.index[i].page_code &
6980			       SMPH_PC_MASK,
6981			       lun->mode_pages.index[i].page_len);
6982#endif
6983			page_len += lun->mode_pages.index[i].page_len;
6984		}
6985		break;
6986	}
6987	default: {
6988		int i;
6989
6990		page_len = 0;
6991
6992		for (i = 0; i < CTL_NUM_MODE_PAGES; i++) {
6993			/* Look for the right page code */
6994			if ((lun->mode_pages.index[i].page_code &
6995			     SMPH_PC_MASK) != page_code)
6996				continue;
6997
6998			/* Look for the right subpage or the subpage wildcard*/
6999			if ((lun->mode_pages.index[i].subpage != subpage)
7000			 && (subpage != SMS_SUBPAGE_ALL))
7001				continue;
7002
7003			/* Make sure the page is supported for this dev type */
7004			if ((control_dev != 0)
7005			 && (lun->mode_pages.index[i].page_flags &
7006			     CTL_PAGE_FLAG_DISK_ONLY))
7007				continue;
7008
7009#if 0
7010			printf("found page %#x len %d\n",
7011			       lun->mode_pages.index[i].page_code &
7012			       SMPH_PC_MASK,
7013			       lun->mode_pages.index[i].page_len);
7014#endif
7015
7016			page_len += lun->mode_pages.index[i].page_len;
7017		}
7018
7019		if (page_len == 0) {
7020			ctl_set_invalid_field(ctsio,
7021					      /*sks_valid*/ 1,
7022					      /*command*/ 1,
7023					      /*field*/ 2,
7024					      /*bit_valid*/ 1,
7025					      /*bit*/ 5);
7026			ctl_done((union ctl_io *)ctsio);
7027			return (CTL_RETVAL_COMPLETE);
7028		}
7029		break;
7030	}
7031	}
7032
7033	total_len = header_len + page_len;
7034#if 0
7035	printf("header_len = %d, page_len = %d, total_len = %d\n",
7036	       header_len, page_len, total_len);
7037#endif
7038
7039	ctsio->kern_data_ptr = malloc(total_len, M_CTL, M_WAITOK | M_ZERO);
7040	ctsio->kern_sg_entries = 0;
7041	ctsio->kern_data_resid = 0;
7042	ctsio->kern_rel_offset = 0;
7043	if (total_len < alloc_len) {
7044		ctsio->residual = alloc_len - total_len;
7045		ctsio->kern_data_len = total_len;
7046		ctsio->kern_total_len = total_len;
7047	} else {
7048		ctsio->residual = 0;
7049		ctsio->kern_data_len = alloc_len;
7050		ctsio->kern_total_len = alloc_len;
7051	}
7052
7053	switch (ctsio->cdb[0]) {
7054	case MODE_SENSE_6: {
7055		struct scsi_mode_hdr_6 *header;
7056
7057		header = (struct scsi_mode_hdr_6 *)ctsio->kern_data_ptr;
7058
7059		header->datalen = ctl_min(total_len - 1, 254);
7060		if (control_dev == 0)
7061			header->dev_specific = 0x10; /* DPOFUA */
7062		if (dbd)
7063			header->block_descr_len = 0;
7064		else
7065			header->block_descr_len =
7066				sizeof(struct scsi_mode_block_descr);
7067		block_desc = (struct scsi_mode_block_descr *)&header[1];
7068		break;
7069	}
7070	case MODE_SENSE_10: {
7071		struct scsi_mode_hdr_10 *header;
7072		int datalen;
7073
7074		header = (struct scsi_mode_hdr_10 *)ctsio->kern_data_ptr;
7075
7076		datalen = ctl_min(total_len - 2, 65533);
7077		scsi_ulto2b(datalen, header->datalen);
7078		if (control_dev == 0)
7079			header->dev_specific = 0x10; /* DPOFUA */
7080		if (dbd)
7081			scsi_ulto2b(0, header->block_descr_len);
7082		else
7083			scsi_ulto2b(sizeof(struct scsi_mode_block_descr),
7084				    header->block_descr_len);
7085		block_desc = (struct scsi_mode_block_descr *)&header[1];
7086		break;
7087	}
7088	default:
7089		panic("invalid CDB type %#x", ctsio->cdb[0]);
7090		break; /* NOTREACHED */
7091	}
7092
7093	/*
7094	 * If we've got a disk, use its blocksize in the block
7095	 * descriptor.  Otherwise, just set it to 0.
7096	 */
7097	if (dbd == 0) {
7098		if (control_dev != 0)
7099			scsi_ulto3b(lun->be_lun->blocksize,
7100				    block_desc->block_len);
7101		else
7102			scsi_ulto3b(0, block_desc->block_len);
7103	}
7104
7105	switch (page_code) {
7106	case SMS_ALL_PAGES_PAGE: {
7107		int i, data_used;
7108
7109		data_used = header_len;
7110		for (i = 0; i < CTL_NUM_MODE_PAGES; i++) {
7111			struct ctl_page_index *page_index;
7112
7113			page_index = &lun->mode_pages.index[i];
7114
7115			if ((control_dev != 0)
7116			 && (page_index->page_flags &
7117			    CTL_PAGE_FLAG_DISK_ONLY))
7118				continue;
7119
7120			/*
7121			 * We don't use this subpage if the user didn't
7122			 * request all subpages.  We already checked (above)
7123			 * to make sure the user only specified a subpage
7124			 * of 0 or 0xff in the SMS_ALL_PAGES_PAGE case.
7125			 */
7126			if ((page_index->subpage != 0)
7127			 && (subpage == SMS_SUBPAGE_PAGE_0))
7128				continue;
7129
7130			/*
7131			 * Call the handler, if it exists, to update the
7132			 * page to the latest values.
7133			 */
7134			if (page_index->sense_handler != NULL)
7135				page_index->sense_handler(ctsio, page_index,pc);
7136
7137			memcpy(ctsio->kern_data_ptr + data_used,
7138			       page_index->page_data +
7139			       (page_index->page_len * pc),
7140			       page_index->page_len);
7141			data_used += page_index->page_len;
7142		}
7143		break;
7144	}
7145	default: {
7146		int i, data_used;
7147
7148		data_used = header_len;
7149
7150		for (i = 0; i < CTL_NUM_MODE_PAGES; i++) {
7151			struct ctl_page_index *page_index;
7152
7153			page_index = &lun->mode_pages.index[i];
7154
7155			/* Look for the right page code */
7156			if ((page_index->page_code & SMPH_PC_MASK) != page_code)
7157				continue;
7158
7159			/* Look for the right subpage or the subpage wildcard*/
7160			if ((page_index->subpage != subpage)
7161			 && (subpage != SMS_SUBPAGE_ALL))
7162				continue;
7163
7164			/* Make sure the page is supported for this dev type */
7165			if ((control_dev != 0)
7166			 && (page_index->page_flags &
7167			     CTL_PAGE_FLAG_DISK_ONLY))
7168				continue;
7169
7170			/*
7171			 * Call the handler, if it exists, to update the
7172			 * page to the latest values.
7173			 */
7174			if (page_index->sense_handler != NULL)
7175				page_index->sense_handler(ctsio, page_index,pc);
7176
7177			memcpy(ctsio->kern_data_ptr + data_used,
7178			       page_index->page_data +
7179			       (page_index->page_len * pc),
7180			       page_index->page_len);
7181			data_used += page_index->page_len;
7182		}
7183		break;
7184	}
7185	}
7186
7187	ctsio->scsi_status = SCSI_STATUS_OK;
7188
7189	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
7190	ctsio->be_move_done = ctl_config_move_done;
7191	ctl_datamove((union ctl_io *)ctsio);
7192
7193	return (CTL_RETVAL_COMPLETE);
7194}
7195
7196int
7197ctl_read_capacity(struct ctl_scsiio *ctsio)
7198{
7199	struct scsi_read_capacity *cdb;
7200	struct scsi_read_capacity_data *data;
7201	struct ctl_lun *lun;
7202	uint32_t lba;
7203
7204	CTL_DEBUG_PRINT(("ctl_read_capacity\n"));
7205
7206	cdb = (struct scsi_read_capacity *)ctsio->cdb;
7207
7208	lba = scsi_4btoul(cdb->addr);
7209	if (((cdb->pmi & SRC_PMI) == 0)
7210	 && (lba != 0)) {
7211		ctl_set_invalid_field(/*ctsio*/ ctsio,
7212				      /*sks_valid*/ 1,
7213				      /*command*/ 1,
7214				      /*field*/ 2,
7215				      /*bit_valid*/ 0,
7216				      /*bit*/ 0);
7217		ctl_done((union ctl_io *)ctsio);
7218		return (CTL_RETVAL_COMPLETE);
7219	}
7220
7221	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
7222
7223	ctsio->kern_data_ptr = malloc(sizeof(*data), M_CTL, M_WAITOK | M_ZERO);
7224	data = (struct scsi_read_capacity_data *)ctsio->kern_data_ptr;
7225	ctsio->residual = 0;
7226	ctsio->kern_data_len = sizeof(*data);
7227	ctsio->kern_total_len = sizeof(*data);
7228	ctsio->kern_data_resid = 0;
7229	ctsio->kern_rel_offset = 0;
7230	ctsio->kern_sg_entries = 0;
7231
7232	/*
7233	 * If the maximum LBA is greater than 0xfffffffe, the user must
7234	 * issue a SERVICE ACTION IN (16) command, with the read capacity
7235	 * serivce action set.
7236	 */
7237	if (lun->be_lun->maxlba > 0xfffffffe)
7238		scsi_ulto4b(0xffffffff, data->addr);
7239	else
7240		scsi_ulto4b(lun->be_lun->maxlba, data->addr);
7241
7242	/*
7243	 * XXX KDM this may not be 512 bytes...
7244	 */
7245	scsi_ulto4b(lun->be_lun->blocksize, data->length);
7246
7247	ctsio->scsi_status = SCSI_STATUS_OK;
7248
7249	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
7250	ctsio->be_move_done = ctl_config_move_done;
7251	ctl_datamove((union ctl_io *)ctsio);
7252
7253	return (CTL_RETVAL_COMPLETE);
7254}
7255
7256int
7257ctl_read_capacity_16(struct ctl_scsiio *ctsio)
7258{
7259	struct scsi_read_capacity_16 *cdb;
7260	struct scsi_read_capacity_data_long *data;
7261	struct ctl_lun *lun;
7262	uint64_t lba;
7263	uint32_t alloc_len;
7264
7265	CTL_DEBUG_PRINT(("ctl_read_capacity_16\n"));
7266
7267	cdb = (struct scsi_read_capacity_16 *)ctsio->cdb;
7268
7269	alloc_len = scsi_4btoul(cdb->alloc_len);
7270	lba = scsi_8btou64(cdb->addr);
7271
7272	if ((cdb->reladr & SRC16_PMI)
7273	 && (lba != 0)) {
7274		ctl_set_invalid_field(/*ctsio*/ ctsio,
7275				      /*sks_valid*/ 1,
7276				      /*command*/ 1,
7277				      /*field*/ 2,
7278				      /*bit_valid*/ 0,
7279				      /*bit*/ 0);
7280		ctl_done((union ctl_io *)ctsio);
7281		return (CTL_RETVAL_COMPLETE);
7282	}
7283
7284	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
7285
7286	ctsio->kern_data_ptr = malloc(sizeof(*data), M_CTL, M_WAITOK | M_ZERO);
7287	data = (struct scsi_read_capacity_data_long *)ctsio->kern_data_ptr;
7288
7289	if (sizeof(*data) < alloc_len) {
7290		ctsio->residual = alloc_len - sizeof(*data);
7291		ctsio->kern_data_len = sizeof(*data);
7292		ctsio->kern_total_len = sizeof(*data);
7293	} else {
7294		ctsio->residual = 0;
7295		ctsio->kern_data_len = alloc_len;
7296		ctsio->kern_total_len = alloc_len;
7297	}
7298	ctsio->kern_data_resid = 0;
7299	ctsio->kern_rel_offset = 0;
7300	ctsio->kern_sg_entries = 0;
7301
7302	scsi_u64to8b(lun->be_lun->maxlba, data->addr);
7303	/* XXX KDM this may not be 512 bytes... */
7304	scsi_ulto4b(lun->be_lun->blocksize, data->length);
7305	data->prot_lbppbe = lun->be_lun->pblockexp & SRC16_LBPPBE;
7306	scsi_ulto2b(lun->be_lun->pblockoff & SRC16_LALBA_A, data->lalba_lbp);
7307	if (lun->be_lun->flags & CTL_LUN_FLAG_UNMAP)
7308		data->lalba_lbp[0] |= SRC16_LBPME | SRC16_LBPRZ;
7309
7310	ctsio->scsi_status = SCSI_STATUS_OK;
7311
7312	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
7313	ctsio->be_move_done = ctl_config_move_done;
7314	ctl_datamove((union ctl_io *)ctsio);
7315
7316	return (CTL_RETVAL_COMPLETE);
7317}
7318
7319int
7320ctl_report_tagret_port_groups(struct ctl_scsiio *ctsio)
7321{
7322	struct scsi_maintenance_in *cdb;
7323	int retval;
7324	int alloc_len, ext, total_len = 0, g, p, pc, pg;
7325	int num_target_port_groups, num_target_ports, single;
7326	struct ctl_lun *lun;
7327	struct ctl_softc *softc;
7328	struct ctl_port *port;
7329	struct scsi_target_group_data *rtg_ptr;
7330	struct scsi_target_group_data_extended *rtg_ext_ptr;
7331	struct scsi_target_port_group_descriptor *tpg_desc;
7332
7333	CTL_DEBUG_PRINT(("ctl_report_tagret_port_groups\n"));
7334
7335	cdb = (struct scsi_maintenance_in *)ctsio->cdb;
7336	softc = control_softc;
7337	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
7338
7339	retval = CTL_RETVAL_COMPLETE;
7340
7341	switch (cdb->byte2 & STG_PDF_MASK) {
7342	case STG_PDF_LENGTH:
7343		ext = 0;
7344		break;
7345	case STG_PDF_EXTENDED:
7346		ext = 1;
7347		break;
7348	default:
7349		ctl_set_invalid_field(/*ctsio*/ ctsio,
7350				      /*sks_valid*/ 1,
7351				      /*command*/ 1,
7352				      /*field*/ 2,
7353				      /*bit_valid*/ 1,
7354				      /*bit*/ 5);
7355		ctl_done((union ctl_io *)ctsio);
7356		return(retval);
7357	}
7358
7359	single = ctl_is_single;
7360	if (single)
7361		num_target_port_groups = 1;
7362	else
7363		num_target_port_groups = NUM_TARGET_PORT_GROUPS;
7364	num_target_ports = 0;
7365	mtx_lock(&softc->ctl_lock);
7366	STAILQ_FOREACH(port, &softc->port_list, links) {
7367		if ((port->status & CTL_PORT_STATUS_ONLINE) == 0)
7368			continue;
7369		if (ctl_map_lun_back(port->targ_port, lun->lun) >= CTL_MAX_LUNS)
7370			continue;
7371		num_target_ports++;
7372	}
7373	mtx_unlock(&softc->ctl_lock);
7374
7375	if (ext)
7376		total_len = sizeof(struct scsi_target_group_data_extended);
7377	else
7378		total_len = sizeof(struct scsi_target_group_data);
7379	total_len += sizeof(struct scsi_target_port_group_descriptor) *
7380		num_target_port_groups +
7381	    sizeof(struct scsi_target_port_descriptor) *
7382		num_target_ports * num_target_port_groups;
7383
7384	alloc_len = scsi_4btoul(cdb->length);
7385
7386	ctsio->kern_data_ptr = malloc(total_len, M_CTL, M_WAITOK | M_ZERO);
7387
7388	ctsio->kern_sg_entries = 0;
7389
7390	if (total_len < alloc_len) {
7391		ctsio->residual = alloc_len - total_len;
7392		ctsio->kern_data_len = total_len;
7393		ctsio->kern_total_len = total_len;
7394	} else {
7395		ctsio->residual = 0;
7396		ctsio->kern_data_len = alloc_len;
7397		ctsio->kern_total_len = alloc_len;
7398	}
7399	ctsio->kern_data_resid = 0;
7400	ctsio->kern_rel_offset = 0;
7401
7402	if (ext) {
7403		rtg_ext_ptr = (struct scsi_target_group_data_extended *)
7404		    ctsio->kern_data_ptr;
7405		scsi_ulto4b(total_len - 4, rtg_ext_ptr->length);
7406		rtg_ext_ptr->format_type = 0x10;
7407		rtg_ext_ptr->implicit_transition_time = 0;
7408		tpg_desc = &rtg_ext_ptr->groups[0];
7409	} else {
7410		rtg_ptr = (struct scsi_target_group_data *)
7411		    ctsio->kern_data_ptr;
7412		scsi_ulto4b(total_len - 4, rtg_ptr->length);
7413		tpg_desc = &rtg_ptr->groups[0];
7414	}
7415
7416	pg = ctsio->io_hdr.nexus.targ_port / CTL_MAX_PORTS;
7417	mtx_lock(&softc->ctl_lock);
7418	for (g = 0; g < num_target_port_groups; g++) {
7419		if (g == pg)
7420			tpg_desc->pref_state = TPG_PRIMARY |
7421			    TPG_ASYMMETRIC_ACCESS_OPTIMIZED;
7422		else
7423			tpg_desc->pref_state =
7424			    TPG_ASYMMETRIC_ACCESS_NONOPTIMIZED;
7425		tpg_desc->support = TPG_AO_SUP;
7426		if (!single)
7427			tpg_desc->support |= TPG_AN_SUP;
7428		scsi_ulto2b(g + 1, tpg_desc->target_port_group);
7429		tpg_desc->status = TPG_IMPLICIT;
7430		pc = 0;
7431		STAILQ_FOREACH(port, &softc->port_list, links) {
7432			if ((port->status & CTL_PORT_STATUS_ONLINE) == 0)
7433				continue;
7434			if (ctl_map_lun_back(port->targ_port, lun->lun) >=
7435			    CTL_MAX_LUNS)
7436				continue;
7437			p = port->targ_port % CTL_MAX_PORTS + g * CTL_MAX_PORTS;
7438			scsi_ulto2b(p, tpg_desc->descriptors[pc].
7439			    relative_target_port_identifier);
7440			pc++;
7441		}
7442		tpg_desc->target_port_count = pc;
7443		tpg_desc = (struct scsi_target_port_group_descriptor *)
7444		    &tpg_desc->descriptors[pc];
7445	}
7446	mtx_unlock(&softc->ctl_lock);
7447
7448	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
7449	ctsio->be_move_done = ctl_config_move_done;
7450
7451	CTL_DEBUG_PRINT(("buf = %x %x %x %x %x %x %x %x\n",
7452			 ctsio->kern_data_ptr[0], ctsio->kern_data_ptr[1],
7453			 ctsio->kern_data_ptr[2], ctsio->kern_data_ptr[3],
7454			 ctsio->kern_data_ptr[4], ctsio->kern_data_ptr[5],
7455			 ctsio->kern_data_ptr[6], ctsio->kern_data_ptr[7]));
7456
7457	ctl_datamove((union ctl_io *)ctsio);
7458	return(retval);
7459}
7460
7461int
7462ctl_report_supported_opcodes(struct ctl_scsiio *ctsio)
7463{
7464	struct ctl_lun *lun;
7465	struct scsi_report_supported_opcodes *cdb;
7466	const struct ctl_cmd_entry *entry, *sentry;
7467	struct scsi_report_supported_opcodes_all *all;
7468	struct scsi_report_supported_opcodes_descr *descr;
7469	struct scsi_report_supported_opcodes_one *one;
7470	int retval;
7471	int alloc_len, total_len;
7472	int opcode, service_action, i, j, num;
7473
7474	CTL_DEBUG_PRINT(("ctl_report_supported_opcodes\n"));
7475
7476	cdb = (struct scsi_report_supported_opcodes *)ctsio->cdb;
7477	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
7478
7479	retval = CTL_RETVAL_COMPLETE;
7480
7481	opcode = cdb->requested_opcode;
7482	service_action = scsi_2btoul(cdb->requested_service_action);
7483	switch (cdb->options & RSO_OPTIONS_MASK) {
7484	case RSO_OPTIONS_ALL:
7485		num = 0;
7486		for (i = 0; i < 256; i++) {
7487			entry = &ctl_cmd_table[i];
7488			if (entry->flags & CTL_CMD_FLAG_SA5) {
7489				for (j = 0; j < 32; j++) {
7490					sentry = &((const struct ctl_cmd_entry *)
7491					    entry->execute)[j];
7492					if (ctl_cmd_applicable(
7493					    lun->be_lun->lun_type, sentry))
7494						num++;
7495				}
7496			} else {
7497				if (ctl_cmd_applicable(lun->be_lun->lun_type,
7498				    entry))
7499					num++;
7500			}
7501		}
7502		total_len = sizeof(struct scsi_report_supported_opcodes_all) +
7503		    num * sizeof(struct scsi_report_supported_opcodes_descr);
7504		break;
7505	case RSO_OPTIONS_OC:
7506		if (ctl_cmd_table[opcode].flags & CTL_CMD_FLAG_SA5) {
7507			ctl_set_invalid_field(/*ctsio*/ ctsio,
7508					      /*sks_valid*/ 1,
7509					      /*command*/ 1,
7510					      /*field*/ 2,
7511					      /*bit_valid*/ 1,
7512					      /*bit*/ 2);
7513			ctl_done((union ctl_io *)ctsio);
7514			return (CTL_RETVAL_COMPLETE);
7515		}
7516		total_len = sizeof(struct scsi_report_supported_opcodes_one) + 32;
7517		break;
7518	case RSO_OPTIONS_OC_SA:
7519		if ((ctl_cmd_table[opcode].flags & CTL_CMD_FLAG_SA5) == 0 ||
7520		    service_action >= 32) {
7521			ctl_set_invalid_field(/*ctsio*/ ctsio,
7522					      /*sks_valid*/ 1,
7523					      /*command*/ 1,
7524					      /*field*/ 2,
7525					      /*bit_valid*/ 1,
7526					      /*bit*/ 2);
7527			ctl_done((union ctl_io *)ctsio);
7528			return (CTL_RETVAL_COMPLETE);
7529		}
7530		total_len = sizeof(struct scsi_report_supported_opcodes_one) + 32;
7531		break;
7532	default:
7533		ctl_set_invalid_field(/*ctsio*/ ctsio,
7534				      /*sks_valid*/ 1,
7535				      /*command*/ 1,
7536				      /*field*/ 2,
7537				      /*bit_valid*/ 1,
7538				      /*bit*/ 2);
7539		ctl_done((union ctl_io *)ctsio);
7540		return (CTL_RETVAL_COMPLETE);
7541	}
7542
7543	alloc_len = scsi_4btoul(cdb->length);
7544
7545	ctsio->kern_data_ptr = malloc(total_len, M_CTL, M_WAITOK | M_ZERO);
7546
7547	ctsio->kern_sg_entries = 0;
7548
7549	if (total_len < alloc_len) {
7550		ctsio->residual = alloc_len - total_len;
7551		ctsio->kern_data_len = total_len;
7552		ctsio->kern_total_len = total_len;
7553	} else {
7554		ctsio->residual = 0;
7555		ctsio->kern_data_len = alloc_len;
7556		ctsio->kern_total_len = alloc_len;
7557	}
7558	ctsio->kern_data_resid = 0;
7559	ctsio->kern_rel_offset = 0;
7560
7561	switch (cdb->options & RSO_OPTIONS_MASK) {
7562	case RSO_OPTIONS_ALL:
7563		all = (struct scsi_report_supported_opcodes_all *)
7564		    ctsio->kern_data_ptr;
7565		num = 0;
7566		for (i = 0; i < 256; i++) {
7567			entry = &ctl_cmd_table[i];
7568			if (entry->flags & CTL_CMD_FLAG_SA5) {
7569				for (j = 0; j < 32; j++) {
7570					sentry = &((const struct ctl_cmd_entry *)
7571					    entry->execute)[j];
7572					if (!ctl_cmd_applicable(
7573					    lun->be_lun->lun_type, sentry))
7574						continue;
7575					descr = &all->descr[num++];
7576					descr->opcode = i;
7577					scsi_ulto2b(j, descr->service_action);
7578					descr->flags = RSO_SERVACTV;
7579					scsi_ulto2b(sentry->length,
7580					    descr->cdb_length);
7581				}
7582			} else {
7583				if (!ctl_cmd_applicable(lun->be_lun->lun_type,
7584				    entry))
7585					continue;
7586				descr = &all->descr[num++];
7587				descr->opcode = i;
7588				scsi_ulto2b(0, descr->service_action);
7589				descr->flags = 0;
7590				scsi_ulto2b(entry->length, descr->cdb_length);
7591			}
7592		}
7593		scsi_ulto4b(
7594		    num * sizeof(struct scsi_report_supported_opcodes_descr),
7595		    all->length);
7596		break;
7597	case RSO_OPTIONS_OC:
7598		one = (struct scsi_report_supported_opcodes_one *)
7599		    ctsio->kern_data_ptr;
7600		entry = &ctl_cmd_table[opcode];
7601		goto fill_one;
7602	case RSO_OPTIONS_OC_SA:
7603		one = (struct scsi_report_supported_opcodes_one *)
7604		    ctsio->kern_data_ptr;
7605		entry = &ctl_cmd_table[opcode];
7606		entry = &((const struct ctl_cmd_entry *)
7607		    entry->execute)[service_action];
7608fill_one:
7609		if (ctl_cmd_applicable(lun->be_lun->lun_type, entry)) {
7610			one->support = 3;
7611			scsi_ulto2b(entry->length, one->cdb_length);
7612			one->cdb_usage[0] = opcode;
7613			memcpy(&one->cdb_usage[1], entry->usage,
7614			    entry->length - 1);
7615		} else
7616			one->support = 1;
7617		break;
7618	}
7619
7620	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
7621	ctsio->be_move_done = ctl_config_move_done;
7622
7623	ctl_datamove((union ctl_io *)ctsio);
7624	return(retval);
7625}
7626
7627int
7628ctl_report_supported_tmf(struct ctl_scsiio *ctsio)
7629{
7630	struct ctl_lun *lun;
7631	struct scsi_report_supported_tmf *cdb;
7632	struct scsi_report_supported_tmf_data *data;
7633	int retval;
7634	int alloc_len, total_len;
7635
7636	CTL_DEBUG_PRINT(("ctl_report_supported_tmf\n"));
7637
7638	cdb = (struct scsi_report_supported_tmf *)ctsio->cdb;
7639	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
7640
7641	retval = CTL_RETVAL_COMPLETE;
7642
7643	total_len = sizeof(struct scsi_report_supported_tmf_data);
7644	alloc_len = scsi_4btoul(cdb->length);
7645
7646	ctsio->kern_data_ptr = malloc(total_len, M_CTL, M_WAITOK | M_ZERO);
7647
7648	ctsio->kern_sg_entries = 0;
7649
7650	if (total_len < alloc_len) {
7651		ctsio->residual = alloc_len - total_len;
7652		ctsio->kern_data_len = total_len;
7653		ctsio->kern_total_len = total_len;
7654	} else {
7655		ctsio->residual = 0;
7656		ctsio->kern_data_len = alloc_len;
7657		ctsio->kern_total_len = alloc_len;
7658	}
7659	ctsio->kern_data_resid = 0;
7660	ctsio->kern_rel_offset = 0;
7661
7662	data = (struct scsi_report_supported_tmf_data *)ctsio->kern_data_ptr;
7663	data->byte1 |= RST_ATS | RST_ATSS | RST_CTSS | RST_LURS | RST_TRS;
7664	data->byte2 |= RST_ITNRS;
7665
7666	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
7667	ctsio->be_move_done = ctl_config_move_done;
7668
7669	ctl_datamove((union ctl_io *)ctsio);
7670	return (retval);
7671}
7672
7673int
7674ctl_report_timestamp(struct ctl_scsiio *ctsio)
7675{
7676	struct ctl_lun *lun;
7677	struct scsi_report_timestamp *cdb;
7678	struct scsi_report_timestamp_data *data;
7679	struct timeval tv;
7680	int64_t timestamp;
7681	int retval;
7682	int alloc_len, total_len;
7683
7684	CTL_DEBUG_PRINT(("ctl_report_timestamp\n"));
7685
7686	cdb = (struct scsi_report_timestamp *)ctsio->cdb;
7687	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
7688
7689	retval = CTL_RETVAL_COMPLETE;
7690
7691	total_len = sizeof(struct scsi_report_timestamp_data);
7692	alloc_len = scsi_4btoul(cdb->length);
7693
7694	ctsio->kern_data_ptr = malloc(total_len, M_CTL, M_WAITOK | M_ZERO);
7695
7696	ctsio->kern_sg_entries = 0;
7697
7698	if (total_len < alloc_len) {
7699		ctsio->residual = alloc_len - total_len;
7700		ctsio->kern_data_len = total_len;
7701		ctsio->kern_total_len = total_len;
7702	} else {
7703		ctsio->residual = 0;
7704		ctsio->kern_data_len = alloc_len;
7705		ctsio->kern_total_len = alloc_len;
7706	}
7707	ctsio->kern_data_resid = 0;
7708	ctsio->kern_rel_offset = 0;
7709
7710	data = (struct scsi_report_timestamp_data *)ctsio->kern_data_ptr;
7711	scsi_ulto2b(sizeof(*data) - 2, data->length);
7712	data->origin = RTS_ORIG_OUTSIDE;
7713	getmicrotime(&tv);
7714	timestamp = (int64_t)tv.tv_sec * 1000 + tv.tv_usec / 1000;
7715	scsi_ulto4b(timestamp >> 16, data->timestamp);
7716	scsi_ulto2b(timestamp & 0xffff, &data->timestamp[4]);
7717
7718	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
7719	ctsio->be_move_done = ctl_config_move_done;
7720
7721	ctl_datamove((union ctl_io *)ctsio);
7722	return (retval);
7723}
7724
7725int
7726ctl_persistent_reserve_in(struct ctl_scsiio *ctsio)
7727{
7728	struct scsi_per_res_in *cdb;
7729	int alloc_len, total_len = 0;
7730	/* struct scsi_per_res_in_rsrv in_data; */
7731	struct ctl_lun *lun;
7732	struct ctl_softc *softc;
7733
7734	CTL_DEBUG_PRINT(("ctl_persistent_reserve_in\n"));
7735
7736	softc = control_softc;
7737
7738	cdb = (struct scsi_per_res_in *)ctsio->cdb;
7739
7740	alloc_len = scsi_2btoul(cdb->length);
7741
7742	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
7743
7744retry:
7745	mtx_lock(&lun->lun_lock);
7746	switch (cdb->action) {
7747	case SPRI_RK: /* read keys */
7748		total_len = sizeof(struct scsi_per_res_in_keys) +
7749			lun->pr_key_count *
7750			sizeof(struct scsi_per_res_key);
7751		break;
7752	case SPRI_RR: /* read reservation */
7753		if (lun->flags & CTL_LUN_PR_RESERVED)
7754			total_len = sizeof(struct scsi_per_res_in_rsrv);
7755		else
7756			total_len = sizeof(struct scsi_per_res_in_header);
7757		break;
7758	case SPRI_RC: /* report capabilities */
7759		total_len = sizeof(struct scsi_per_res_cap);
7760		break;
7761	case SPRI_RS: /* read full status */
7762		total_len = sizeof(struct scsi_per_res_in_header) +
7763		    (sizeof(struct scsi_per_res_in_full_desc) + 256) *
7764		    lun->pr_key_count;
7765		break;
7766	default:
7767		panic("Invalid PR type %x", cdb->action);
7768	}
7769	mtx_unlock(&lun->lun_lock);
7770
7771	ctsio->kern_data_ptr = malloc(total_len, M_CTL, M_WAITOK | M_ZERO);
7772
7773	if (total_len < alloc_len) {
7774		ctsio->residual = alloc_len - total_len;
7775		ctsio->kern_data_len = total_len;
7776		ctsio->kern_total_len = total_len;
7777	} else {
7778		ctsio->residual = 0;
7779		ctsio->kern_data_len = alloc_len;
7780		ctsio->kern_total_len = alloc_len;
7781	}
7782
7783	ctsio->kern_data_resid = 0;
7784	ctsio->kern_rel_offset = 0;
7785	ctsio->kern_sg_entries = 0;
7786
7787	mtx_lock(&lun->lun_lock);
7788	switch (cdb->action) {
7789	case SPRI_RK: { // read keys
7790        struct scsi_per_res_in_keys *res_keys;
7791		int i, key_count;
7792
7793		res_keys = (struct scsi_per_res_in_keys*)ctsio->kern_data_ptr;
7794
7795		/*
7796		 * We had to drop the lock to allocate our buffer, which
7797		 * leaves time for someone to come in with another
7798		 * persistent reservation.  (That is unlikely, though,
7799		 * since this should be the only persistent reservation
7800		 * command active right now.)
7801		 */
7802		if (total_len != (sizeof(struct scsi_per_res_in_keys) +
7803		    (lun->pr_key_count *
7804		     sizeof(struct scsi_per_res_key)))){
7805			mtx_unlock(&lun->lun_lock);
7806			free(ctsio->kern_data_ptr, M_CTL);
7807			printf("%s: reservation length changed, retrying\n",
7808			       __func__);
7809			goto retry;
7810		}
7811
7812		scsi_ulto4b(lun->PRGeneration, res_keys->header.generation);
7813
7814		scsi_ulto4b(sizeof(struct scsi_per_res_key) *
7815			     lun->pr_key_count, res_keys->header.length);
7816
7817		for (i = 0, key_count = 0; i < 2*CTL_MAX_INITIATORS; i++) {
7818			if (!lun->per_res[i].registered)
7819				continue;
7820
7821			/*
7822			 * We used lun->pr_key_count to calculate the
7823			 * size to allocate.  If it turns out the number of
7824			 * initiators with the registered flag set is
7825			 * larger than that (i.e. they haven't been kept in
7826			 * sync), we've got a problem.
7827			 */
7828			if (key_count >= lun->pr_key_count) {
7829#ifdef NEEDTOPORT
7830				csevent_log(CSC_CTL | CSC_SHELF_SW |
7831					    CTL_PR_ERROR,
7832					    csevent_LogType_Fault,
7833					    csevent_AlertLevel_Yellow,
7834					    csevent_FRU_ShelfController,
7835					    csevent_FRU_Firmware,
7836				        csevent_FRU_Unknown,
7837					    "registered keys %d >= key "
7838					    "count %d", key_count,
7839					    lun->pr_key_count);
7840#endif
7841				key_count++;
7842				continue;
7843			}
7844			memcpy(res_keys->keys[key_count].key,
7845			       lun->per_res[i].res_key.key,
7846			       ctl_min(sizeof(res_keys->keys[key_count].key),
7847			       sizeof(lun->per_res[i].res_key)));
7848			key_count++;
7849		}
7850		break;
7851	}
7852	case SPRI_RR: { // read reservation
7853		struct scsi_per_res_in_rsrv *res;
7854		int tmp_len, header_only;
7855
7856		res = (struct scsi_per_res_in_rsrv *)ctsio->kern_data_ptr;
7857
7858		scsi_ulto4b(lun->PRGeneration, res->header.generation);
7859
7860		if (lun->flags & CTL_LUN_PR_RESERVED)
7861		{
7862			tmp_len = sizeof(struct scsi_per_res_in_rsrv);
7863			scsi_ulto4b(sizeof(struct scsi_per_res_in_rsrv_data),
7864				    res->header.length);
7865			header_only = 0;
7866		} else {
7867			tmp_len = sizeof(struct scsi_per_res_in_header);
7868			scsi_ulto4b(0, res->header.length);
7869			header_only = 1;
7870		}
7871
7872		/*
7873		 * We had to drop the lock to allocate our buffer, which
7874		 * leaves time for someone to come in with another
7875		 * persistent reservation.  (That is unlikely, though,
7876		 * since this should be the only persistent reservation
7877		 * command active right now.)
7878		 */
7879		if (tmp_len != total_len) {
7880			mtx_unlock(&lun->lun_lock);
7881			free(ctsio->kern_data_ptr, M_CTL);
7882			printf("%s: reservation status changed, retrying\n",
7883			       __func__);
7884			goto retry;
7885		}
7886
7887		/*
7888		 * No reservation held, so we're done.
7889		 */
7890		if (header_only != 0)
7891			break;
7892
7893		/*
7894		 * If the registration is an All Registrants type, the key
7895		 * is 0, since it doesn't really matter.
7896		 */
7897		if (lun->pr_res_idx != CTL_PR_ALL_REGISTRANTS) {
7898			memcpy(res->data.reservation,
7899			       &lun->per_res[lun->pr_res_idx].res_key,
7900			       sizeof(struct scsi_per_res_key));
7901		}
7902		res->data.scopetype = lun->res_type;
7903		break;
7904	}
7905	case SPRI_RC:     //report capabilities
7906	{
7907		struct scsi_per_res_cap *res_cap;
7908		uint16_t type_mask;
7909
7910		res_cap = (struct scsi_per_res_cap *)ctsio->kern_data_ptr;
7911		scsi_ulto2b(sizeof(*res_cap), res_cap->length);
7912		res_cap->flags2 |= SPRI_TMV | SPRI_ALLOW_3;
7913		type_mask = SPRI_TM_WR_EX_AR |
7914			    SPRI_TM_EX_AC_RO |
7915			    SPRI_TM_WR_EX_RO |
7916			    SPRI_TM_EX_AC |
7917			    SPRI_TM_WR_EX |
7918			    SPRI_TM_EX_AC_AR;
7919		scsi_ulto2b(type_mask, res_cap->type_mask);
7920		break;
7921	}
7922	case SPRI_RS: { // read full status
7923		struct scsi_per_res_in_full *res_status;
7924		struct scsi_per_res_in_full_desc *res_desc;
7925		struct ctl_port *port;
7926		int i, len;
7927
7928		res_status = (struct scsi_per_res_in_full*)ctsio->kern_data_ptr;
7929
7930		/*
7931		 * We had to drop the lock to allocate our buffer, which
7932		 * leaves time for someone to come in with another
7933		 * persistent reservation.  (That is unlikely, though,
7934		 * since this should be the only persistent reservation
7935		 * command active right now.)
7936		 */
7937		if (total_len < (sizeof(struct scsi_per_res_in_header) +
7938		    (sizeof(struct scsi_per_res_in_full_desc) + 256) *
7939		     lun->pr_key_count)){
7940			mtx_unlock(&lun->lun_lock);
7941			free(ctsio->kern_data_ptr, M_CTL);
7942			printf("%s: reservation length changed, retrying\n",
7943			       __func__);
7944			goto retry;
7945		}
7946
7947		scsi_ulto4b(lun->PRGeneration, res_status->header.generation);
7948
7949		res_desc = &res_status->desc[0];
7950		for (i = 0; i < 2*CTL_MAX_INITIATORS; i++) {
7951			if (!lun->per_res[i].registered)
7952				continue;
7953
7954			memcpy(&res_desc->res_key, &lun->per_res[i].res_key.key,
7955			    sizeof(res_desc->res_key));
7956			if ((lun->flags & CTL_LUN_PR_RESERVED) &&
7957			    (lun->pr_res_idx == i ||
7958			     lun->pr_res_idx == CTL_PR_ALL_REGISTRANTS)) {
7959				res_desc->flags = SPRI_FULL_R_HOLDER;
7960				res_desc->scopetype = lun->res_type;
7961			}
7962			scsi_ulto2b(i / CTL_MAX_INIT_PER_PORT,
7963			    res_desc->rel_trgt_port_id);
7964			len = 0;
7965			port = softc->ctl_ports[i / CTL_MAX_INIT_PER_PORT];
7966			if (port != NULL)
7967				len = ctl_create_iid(port,
7968				    i % CTL_MAX_INIT_PER_PORT,
7969				    res_desc->transport_id);
7970			scsi_ulto4b(len, res_desc->additional_length);
7971			res_desc = (struct scsi_per_res_in_full_desc *)
7972			    &res_desc->transport_id[len];
7973		}
7974		scsi_ulto4b((uint8_t *)res_desc - (uint8_t *)&res_status->desc[0],
7975		    res_status->header.length);
7976		break;
7977	}
7978	default:
7979		/*
7980		 * This is a bug, because we just checked for this above,
7981		 * and should have returned an error.
7982		 */
7983		panic("Invalid PR type %x", cdb->action);
7984		break; /* NOTREACHED */
7985	}
7986	mtx_unlock(&lun->lun_lock);
7987
7988	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
7989	ctsio->be_move_done = ctl_config_move_done;
7990
7991	CTL_DEBUG_PRINT(("buf = %x %x %x %x %x %x %x %x\n",
7992			 ctsio->kern_data_ptr[0], ctsio->kern_data_ptr[1],
7993			 ctsio->kern_data_ptr[2], ctsio->kern_data_ptr[3],
7994			 ctsio->kern_data_ptr[4], ctsio->kern_data_ptr[5],
7995			 ctsio->kern_data_ptr[6], ctsio->kern_data_ptr[7]));
7996
7997	ctl_datamove((union ctl_io *)ctsio);
7998
7999	return (CTL_RETVAL_COMPLETE);
8000}
8001
8002/*
8003 * Returns 0 if ctl_persistent_reserve_out() should continue, non-zero if
8004 * it should return.
8005 */
8006static int
8007ctl_pro_preempt(struct ctl_softc *softc, struct ctl_lun *lun, uint64_t res_key,
8008		uint64_t sa_res_key, uint8_t type, uint32_t residx,
8009		struct ctl_scsiio *ctsio, struct scsi_per_res_out *cdb,
8010		struct scsi_per_res_out_parms* param)
8011{
8012	union ctl_ha_msg persis_io;
8013	int retval, i;
8014	int isc_retval;
8015
8016	retval = 0;
8017
8018	mtx_lock(&lun->lun_lock);
8019	if (sa_res_key == 0) {
8020		if (lun->pr_res_idx == CTL_PR_ALL_REGISTRANTS) {
8021			/* validate scope and type */
8022			if ((cdb->scope_type & SPR_SCOPE_MASK) !=
8023			     SPR_LU_SCOPE) {
8024				mtx_unlock(&lun->lun_lock);
8025				ctl_set_invalid_field(/*ctsio*/ ctsio,
8026						      /*sks_valid*/ 1,
8027						      /*command*/ 1,
8028						      /*field*/ 2,
8029						      /*bit_valid*/ 1,
8030						      /*bit*/ 4);
8031				ctl_done((union ctl_io *)ctsio);
8032				return (1);
8033			}
8034
8035		        if (type>8 || type==2 || type==4 || type==0) {
8036				mtx_unlock(&lun->lun_lock);
8037				ctl_set_invalid_field(/*ctsio*/ ctsio,
8038       	           				      /*sks_valid*/ 1,
8039						      /*command*/ 1,
8040						      /*field*/ 2,
8041						      /*bit_valid*/ 1,
8042						      /*bit*/ 0);
8043				ctl_done((union ctl_io *)ctsio);
8044				return (1);
8045		        }
8046
8047			/* temporarily unregister this nexus */
8048			lun->per_res[residx].registered = 0;
8049
8050			/*
8051			 * Unregister everybody else and build UA for
8052			 * them
8053			 */
8054			for(i=0; i < 2*CTL_MAX_INITIATORS; i++) {
8055				if (lun->per_res[i].registered == 0)
8056					continue;
8057
8058				if (!persis_offset
8059				 && i <CTL_MAX_INITIATORS)
8060					lun->pending_ua[i] |=
8061						CTL_UA_REG_PREEMPT;
8062				else if (persis_offset
8063				      && i >= persis_offset)
8064					lun->pending_ua[i-persis_offset] |=
8065						CTL_UA_REG_PREEMPT;
8066				lun->per_res[i].registered = 0;
8067				memset(&lun->per_res[i].res_key, 0,
8068				       sizeof(struct scsi_per_res_key));
8069			}
8070			lun->per_res[residx].registered = 1;
8071			lun->pr_key_count = 1;
8072			lun->res_type = type;
8073			if (lun->res_type != SPR_TYPE_WR_EX_AR
8074			 && lun->res_type != SPR_TYPE_EX_AC_AR)
8075				lun->pr_res_idx = residx;
8076
8077			/* send msg to other side */
8078			persis_io.hdr.nexus = ctsio->io_hdr.nexus;
8079			persis_io.hdr.msg_type = CTL_MSG_PERS_ACTION;
8080			persis_io.pr.pr_info.action = CTL_PR_PREEMPT;
8081			persis_io.pr.pr_info.residx = lun->pr_res_idx;
8082			persis_io.pr.pr_info.res_type = type;
8083			memcpy(persis_io.pr.pr_info.sa_res_key,
8084			       param->serv_act_res_key,
8085			       sizeof(param->serv_act_res_key));
8086			if ((isc_retval=ctl_ha_msg_send(CTL_HA_CHAN_CTL,
8087			     &persis_io, sizeof(persis_io), 0)) >
8088			     CTL_HA_STATUS_SUCCESS) {
8089				printf("CTL:Persis Out error returned "
8090				       "from ctl_ha_msg_send %d\n",
8091				       isc_retval);
8092			}
8093		} else {
8094			/* not all registrants */
8095			mtx_unlock(&lun->lun_lock);
8096			free(ctsio->kern_data_ptr, M_CTL);
8097			ctl_set_invalid_field(ctsio,
8098					      /*sks_valid*/ 1,
8099					      /*command*/ 0,
8100					      /*field*/ 8,
8101					      /*bit_valid*/ 0,
8102					      /*bit*/ 0);
8103			ctl_done((union ctl_io *)ctsio);
8104			return (1);
8105		}
8106	} else if (lun->pr_res_idx == CTL_PR_ALL_REGISTRANTS
8107		|| !(lun->flags & CTL_LUN_PR_RESERVED)) {
8108		int found = 0;
8109
8110		if (res_key == sa_res_key) {
8111			/* special case */
8112			/*
8113			 * The spec implies this is not good but doesn't
8114			 * say what to do. There are two choices either
8115			 * generate a res conflict or check condition
8116			 * with illegal field in parameter data. Since
8117			 * that is what is done when the sa_res_key is
8118			 * zero I'll take that approach since this has
8119			 * to do with the sa_res_key.
8120			 */
8121			mtx_unlock(&lun->lun_lock);
8122			free(ctsio->kern_data_ptr, M_CTL);
8123			ctl_set_invalid_field(ctsio,
8124					      /*sks_valid*/ 1,
8125					      /*command*/ 0,
8126					      /*field*/ 8,
8127					      /*bit_valid*/ 0,
8128					      /*bit*/ 0);
8129			ctl_done((union ctl_io *)ctsio);
8130			return (1);
8131		}
8132
8133		for (i=0; i < 2*CTL_MAX_INITIATORS; i++) {
8134			if (lun->per_res[i].registered
8135			 && memcmp(param->serv_act_res_key,
8136			    lun->per_res[i].res_key.key,
8137			    sizeof(struct scsi_per_res_key)) != 0)
8138				continue;
8139
8140			found = 1;
8141			lun->per_res[i].registered = 0;
8142			memset(&lun->per_res[i].res_key, 0,
8143			       sizeof(struct scsi_per_res_key));
8144			lun->pr_key_count--;
8145
8146			if (!persis_offset && i < CTL_MAX_INITIATORS)
8147				lun->pending_ua[i] |= CTL_UA_REG_PREEMPT;
8148			else if (persis_offset && i >= persis_offset)
8149				lun->pending_ua[i-persis_offset] |=
8150					CTL_UA_REG_PREEMPT;
8151		}
8152		if (!found) {
8153			mtx_unlock(&lun->lun_lock);
8154			free(ctsio->kern_data_ptr, M_CTL);
8155			ctl_set_reservation_conflict(ctsio);
8156			ctl_done((union ctl_io *)ctsio);
8157			return (CTL_RETVAL_COMPLETE);
8158		}
8159		/* send msg to other side */
8160		persis_io.hdr.nexus = ctsio->io_hdr.nexus;
8161		persis_io.hdr.msg_type = CTL_MSG_PERS_ACTION;
8162		persis_io.pr.pr_info.action = CTL_PR_PREEMPT;
8163		persis_io.pr.pr_info.residx = lun->pr_res_idx;
8164		persis_io.pr.pr_info.res_type = type;
8165		memcpy(persis_io.pr.pr_info.sa_res_key,
8166		       param->serv_act_res_key,
8167		       sizeof(param->serv_act_res_key));
8168		if ((isc_retval=ctl_ha_msg_send(CTL_HA_CHAN_CTL,
8169		     &persis_io, sizeof(persis_io), 0)) >
8170		     CTL_HA_STATUS_SUCCESS) {
8171			printf("CTL:Persis Out error returned from "
8172			       "ctl_ha_msg_send %d\n", isc_retval);
8173		}
8174	} else {
8175		/* Reserved but not all registrants */
8176		/* sa_res_key is res holder */
8177		if (memcmp(param->serv_act_res_key,
8178                   lun->per_res[lun->pr_res_idx].res_key.key,
8179                   sizeof(struct scsi_per_res_key)) == 0) {
8180			/* validate scope and type */
8181			if ((cdb->scope_type & SPR_SCOPE_MASK) !=
8182			     SPR_LU_SCOPE) {
8183				mtx_unlock(&lun->lun_lock);
8184				ctl_set_invalid_field(/*ctsio*/ ctsio,
8185						      /*sks_valid*/ 1,
8186						      /*command*/ 1,
8187						      /*field*/ 2,
8188						      /*bit_valid*/ 1,
8189						      /*bit*/ 4);
8190				ctl_done((union ctl_io *)ctsio);
8191				return (1);
8192			}
8193
8194			if (type>8 || type==2 || type==4 || type==0) {
8195				mtx_unlock(&lun->lun_lock);
8196				ctl_set_invalid_field(/*ctsio*/ ctsio,
8197						      /*sks_valid*/ 1,
8198						      /*command*/ 1,
8199						      /*field*/ 2,
8200						      /*bit_valid*/ 1,
8201						      /*bit*/ 0);
8202				ctl_done((union ctl_io *)ctsio);
8203				return (1);
8204			}
8205
8206			/*
8207			 * Do the following:
8208			 * if sa_res_key != res_key remove all
8209			 * registrants w/sa_res_key and generate UA
8210			 * for these registrants(Registrations
8211			 * Preempted) if it wasn't an exclusive
8212			 * reservation generate UA(Reservations
8213			 * Preempted) for all other registered nexuses
8214			 * if the type has changed. Establish the new
8215			 * reservation and holder. If res_key and
8216			 * sa_res_key are the same do the above
8217			 * except don't unregister the res holder.
8218			 */
8219
8220			/*
8221			 * Temporarily unregister so it won't get
8222			 * removed or UA generated
8223			 */
8224			lun->per_res[residx].registered = 0;
8225			for(i=0; i < 2*CTL_MAX_INITIATORS; i++) {
8226				if (lun->per_res[i].registered == 0)
8227					continue;
8228
8229				if (memcmp(param->serv_act_res_key,
8230				    lun->per_res[i].res_key.key,
8231				    sizeof(struct scsi_per_res_key)) == 0) {
8232					lun->per_res[i].registered = 0;
8233					memset(&lun->per_res[i].res_key,
8234					       0,
8235					       sizeof(struct scsi_per_res_key));
8236					lun->pr_key_count--;
8237
8238					if (!persis_offset
8239					 && i < CTL_MAX_INITIATORS)
8240						lun->pending_ua[i] |=
8241							CTL_UA_REG_PREEMPT;
8242					else if (persis_offset
8243					      && i >= persis_offset)
8244						lun->pending_ua[i-persis_offset] |=
8245						  CTL_UA_REG_PREEMPT;
8246				} else if (type != lun->res_type
8247					&& (lun->res_type == SPR_TYPE_WR_EX_RO
8248					 || lun->res_type ==SPR_TYPE_EX_AC_RO)){
8249						if (!persis_offset
8250						 && i < CTL_MAX_INITIATORS)
8251							lun->pending_ua[i] |=
8252							CTL_UA_RES_RELEASE;
8253						else if (persis_offset
8254						      && i >= persis_offset)
8255							lun->pending_ua[
8256							i-persis_offset] |=
8257							CTL_UA_RES_RELEASE;
8258				}
8259			}
8260			lun->per_res[residx].registered = 1;
8261			lun->res_type = type;
8262			if (lun->res_type != SPR_TYPE_WR_EX_AR
8263			 && lun->res_type != SPR_TYPE_EX_AC_AR)
8264				lun->pr_res_idx = residx;
8265			else
8266				lun->pr_res_idx = CTL_PR_ALL_REGISTRANTS;
8267
8268			persis_io.hdr.nexus = ctsio->io_hdr.nexus;
8269			persis_io.hdr.msg_type = CTL_MSG_PERS_ACTION;
8270			persis_io.pr.pr_info.action = CTL_PR_PREEMPT;
8271			persis_io.pr.pr_info.residx = lun->pr_res_idx;
8272			persis_io.pr.pr_info.res_type = type;
8273			memcpy(persis_io.pr.pr_info.sa_res_key,
8274			       param->serv_act_res_key,
8275			       sizeof(param->serv_act_res_key));
8276			if ((isc_retval=ctl_ha_msg_send(CTL_HA_CHAN_CTL,
8277			     &persis_io, sizeof(persis_io), 0)) >
8278			     CTL_HA_STATUS_SUCCESS) {
8279				printf("CTL:Persis Out error returned "
8280				       "from ctl_ha_msg_send %d\n",
8281				       isc_retval);
8282			}
8283		} else {
8284			/*
8285			 * sa_res_key is not the res holder just
8286			 * remove registrants
8287			 */
8288			int found=0;
8289
8290			for (i=0; i < 2*CTL_MAX_INITIATORS; i++) {
8291				if (memcmp(param->serv_act_res_key,
8292				    lun->per_res[i].res_key.key,
8293				    sizeof(struct scsi_per_res_key)) != 0)
8294					continue;
8295
8296				found = 1;
8297				lun->per_res[i].registered = 0;
8298				memset(&lun->per_res[i].res_key, 0,
8299				       sizeof(struct scsi_per_res_key));
8300				lun->pr_key_count--;
8301
8302				if (!persis_offset
8303				 && i < CTL_MAX_INITIATORS)
8304					lun->pending_ua[i] |=
8305						CTL_UA_REG_PREEMPT;
8306				else if (persis_offset
8307				      && i >= persis_offset)
8308					lun->pending_ua[i-persis_offset] |=
8309						CTL_UA_REG_PREEMPT;
8310			}
8311
8312			if (!found) {
8313				mtx_unlock(&lun->lun_lock);
8314				free(ctsio->kern_data_ptr, M_CTL);
8315				ctl_set_reservation_conflict(ctsio);
8316				ctl_done((union ctl_io *)ctsio);
8317		        	return (1);
8318			}
8319			persis_io.hdr.nexus = ctsio->io_hdr.nexus;
8320			persis_io.hdr.msg_type = CTL_MSG_PERS_ACTION;
8321			persis_io.pr.pr_info.action = CTL_PR_PREEMPT;
8322			persis_io.pr.pr_info.residx = lun->pr_res_idx;
8323			persis_io.pr.pr_info.res_type = type;
8324			memcpy(persis_io.pr.pr_info.sa_res_key,
8325			       param->serv_act_res_key,
8326			       sizeof(param->serv_act_res_key));
8327			if ((isc_retval=ctl_ha_msg_send(CTL_HA_CHAN_CTL,
8328			     &persis_io, sizeof(persis_io), 0)) >
8329			     CTL_HA_STATUS_SUCCESS) {
8330				printf("CTL:Persis Out error returned "
8331				       "from ctl_ha_msg_send %d\n",
8332				isc_retval);
8333			}
8334		}
8335	}
8336
8337	lun->PRGeneration++;
8338	mtx_unlock(&lun->lun_lock);
8339
8340	return (retval);
8341}
8342
8343static void
8344ctl_pro_preempt_other(struct ctl_lun *lun, union ctl_ha_msg *msg)
8345{
8346	int i;
8347
8348	if (lun->pr_res_idx == CTL_PR_ALL_REGISTRANTS
8349	 || lun->pr_res_idx == CTL_PR_NO_RESERVATION
8350	 || memcmp(&lun->per_res[lun->pr_res_idx].res_key,
8351		   msg->pr.pr_info.sa_res_key,
8352		   sizeof(struct scsi_per_res_key)) != 0) {
8353		uint64_t sa_res_key;
8354		sa_res_key = scsi_8btou64(msg->pr.pr_info.sa_res_key);
8355
8356		if (sa_res_key == 0) {
8357			/* temporarily unregister this nexus */
8358			lun->per_res[msg->pr.pr_info.residx].registered = 0;
8359
8360			/*
8361			 * Unregister everybody else and build UA for
8362			 * them
8363			 */
8364			for(i=0; i < 2*CTL_MAX_INITIATORS; i++) {
8365				if (lun->per_res[i].registered == 0)
8366					continue;
8367
8368				if (!persis_offset
8369				 && i < CTL_MAX_INITIATORS)
8370					lun->pending_ua[i] |=
8371						CTL_UA_REG_PREEMPT;
8372				else if (persis_offset && i >= persis_offset)
8373					lun->pending_ua[i - persis_offset] |=
8374						CTL_UA_REG_PREEMPT;
8375				lun->per_res[i].registered = 0;
8376				memset(&lun->per_res[i].res_key, 0,
8377				       sizeof(struct scsi_per_res_key));
8378			}
8379
8380			lun->per_res[msg->pr.pr_info.residx].registered = 1;
8381			lun->pr_key_count = 1;
8382			lun->res_type = msg->pr.pr_info.res_type;
8383			if (lun->res_type != SPR_TYPE_WR_EX_AR
8384			 && lun->res_type != SPR_TYPE_EX_AC_AR)
8385				lun->pr_res_idx = msg->pr.pr_info.residx;
8386		} else {
8387		        for (i=0; i < 2*CTL_MAX_INITIATORS; i++) {
8388				if (memcmp(msg->pr.pr_info.sa_res_key,
8389		                   lun->per_res[i].res_key.key,
8390		                   sizeof(struct scsi_per_res_key)) != 0)
8391					continue;
8392
8393				lun->per_res[i].registered = 0;
8394				memset(&lun->per_res[i].res_key, 0,
8395				       sizeof(struct scsi_per_res_key));
8396				lun->pr_key_count--;
8397
8398				if (!persis_offset
8399				 && i < persis_offset)
8400					lun->pending_ua[i] |=
8401						CTL_UA_REG_PREEMPT;
8402				else if (persis_offset
8403				      && i >= persis_offset)
8404					lun->pending_ua[i - persis_offset] |=
8405						CTL_UA_REG_PREEMPT;
8406			}
8407		}
8408	} else {
8409		/*
8410		 * Temporarily unregister so it won't get removed
8411		 * or UA generated
8412		 */
8413		lun->per_res[msg->pr.pr_info.residx].registered = 0;
8414		for (i=0; i < 2*CTL_MAX_INITIATORS; i++) {
8415			if (lun->per_res[i].registered == 0)
8416				continue;
8417
8418			if (memcmp(msg->pr.pr_info.sa_res_key,
8419	                   lun->per_res[i].res_key.key,
8420	                   sizeof(struct scsi_per_res_key)) == 0) {
8421				lun->per_res[i].registered = 0;
8422				memset(&lun->per_res[i].res_key, 0,
8423				       sizeof(struct scsi_per_res_key));
8424				lun->pr_key_count--;
8425				if (!persis_offset
8426				 && i < CTL_MAX_INITIATORS)
8427					lun->pending_ua[i] |=
8428						CTL_UA_REG_PREEMPT;
8429				else if (persis_offset
8430				      && i >= persis_offset)
8431					lun->pending_ua[i - persis_offset] |=
8432						CTL_UA_REG_PREEMPT;
8433			} else if (msg->pr.pr_info.res_type != lun->res_type
8434				&& (lun->res_type == SPR_TYPE_WR_EX_RO
8435				 || lun->res_type == SPR_TYPE_EX_AC_RO)) {
8436					if (!persis_offset
8437					 && i < persis_offset)
8438						lun->pending_ua[i] |=
8439							CTL_UA_RES_RELEASE;
8440					else if (persis_offset
8441					      && i >= persis_offset)
8442					lun->pending_ua[i - persis_offset] |=
8443						CTL_UA_RES_RELEASE;
8444			}
8445		}
8446		lun->per_res[msg->pr.pr_info.residx].registered = 1;
8447		lun->res_type = msg->pr.pr_info.res_type;
8448		if (lun->res_type != SPR_TYPE_WR_EX_AR
8449		 && lun->res_type != SPR_TYPE_EX_AC_AR)
8450			lun->pr_res_idx = msg->pr.pr_info.residx;
8451		else
8452			lun->pr_res_idx = CTL_PR_ALL_REGISTRANTS;
8453	}
8454	lun->PRGeneration++;
8455
8456}
8457
8458
8459int
8460ctl_persistent_reserve_out(struct ctl_scsiio *ctsio)
8461{
8462	int retval;
8463	int isc_retval;
8464	u_int32_t param_len;
8465	struct scsi_per_res_out *cdb;
8466	struct ctl_lun *lun;
8467	struct scsi_per_res_out_parms* param;
8468	struct ctl_softc *softc;
8469	uint32_t residx;
8470	uint64_t res_key, sa_res_key;
8471	uint8_t type;
8472	union ctl_ha_msg persis_io;
8473	int    i;
8474
8475	CTL_DEBUG_PRINT(("ctl_persistent_reserve_out\n"));
8476
8477	retval = CTL_RETVAL_COMPLETE;
8478
8479	softc = control_softc;
8480
8481	cdb = (struct scsi_per_res_out *)ctsio->cdb;
8482	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
8483
8484	/*
8485	 * We only support whole-LUN scope.  The scope & type are ignored for
8486	 * register, register and ignore existing key and clear.
8487	 * We sometimes ignore scope and type on preempts too!!
8488	 * Verify reservation type here as well.
8489	 */
8490	type = cdb->scope_type & SPR_TYPE_MASK;
8491	if ((cdb->action == SPRO_RESERVE)
8492	 || (cdb->action == SPRO_RELEASE)) {
8493		if ((cdb->scope_type & SPR_SCOPE_MASK) != SPR_LU_SCOPE) {
8494			ctl_set_invalid_field(/*ctsio*/ ctsio,
8495					      /*sks_valid*/ 1,
8496					      /*command*/ 1,
8497					      /*field*/ 2,
8498					      /*bit_valid*/ 1,
8499					      /*bit*/ 4);
8500			ctl_done((union ctl_io *)ctsio);
8501			return (CTL_RETVAL_COMPLETE);
8502		}
8503
8504		if (type>8 || type==2 || type==4 || type==0) {
8505			ctl_set_invalid_field(/*ctsio*/ ctsio,
8506					      /*sks_valid*/ 1,
8507					      /*command*/ 1,
8508					      /*field*/ 2,
8509					      /*bit_valid*/ 1,
8510					      /*bit*/ 0);
8511			ctl_done((union ctl_io *)ctsio);
8512			return (CTL_RETVAL_COMPLETE);
8513		}
8514	}
8515
8516	param_len = scsi_4btoul(cdb->length);
8517
8518	if ((ctsio->io_hdr.flags & CTL_FLAG_ALLOCATED) == 0) {
8519		ctsio->kern_data_ptr = malloc(param_len, M_CTL, M_WAITOK);
8520		ctsio->kern_data_len = param_len;
8521		ctsio->kern_total_len = param_len;
8522		ctsio->kern_data_resid = 0;
8523		ctsio->kern_rel_offset = 0;
8524		ctsio->kern_sg_entries = 0;
8525		ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
8526		ctsio->be_move_done = ctl_config_move_done;
8527		ctl_datamove((union ctl_io *)ctsio);
8528
8529		return (CTL_RETVAL_COMPLETE);
8530	}
8531
8532	param = (struct scsi_per_res_out_parms *)ctsio->kern_data_ptr;
8533
8534	residx = ctl_get_resindex(&ctsio->io_hdr.nexus);
8535	res_key = scsi_8btou64(param->res_key.key);
8536	sa_res_key = scsi_8btou64(param->serv_act_res_key);
8537
8538	/*
8539	 * Validate the reservation key here except for SPRO_REG_IGNO
8540	 * This must be done for all other service actions
8541	 */
8542	if ((cdb->action & SPRO_ACTION_MASK) != SPRO_REG_IGNO) {
8543		mtx_lock(&lun->lun_lock);
8544		if (lun->per_res[residx].registered) {
8545		    if (memcmp(param->res_key.key,
8546			       lun->per_res[residx].res_key.key,
8547			       ctl_min(sizeof(param->res_key),
8548			       sizeof(lun->per_res[residx].res_key))) != 0) {
8549				/*
8550				 * The current key passed in doesn't match
8551				 * the one the initiator previously
8552				 * registered.
8553				 */
8554				mtx_unlock(&lun->lun_lock);
8555				free(ctsio->kern_data_ptr, M_CTL);
8556				ctl_set_reservation_conflict(ctsio);
8557				ctl_done((union ctl_io *)ctsio);
8558				return (CTL_RETVAL_COMPLETE);
8559			}
8560		} else if ((cdb->action & SPRO_ACTION_MASK) != SPRO_REGISTER) {
8561			/*
8562			 * We are not registered
8563			 */
8564			mtx_unlock(&lun->lun_lock);
8565			free(ctsio->kern_data_ptr, M_CTL);
8566			ctl_set_reservation_conflict(ctsio);
8567			ctl_done((union ctl_io *)ctsio);
8568			return (CTL_RETVAL_COMPLETE);
8569		} else if (res_key != 0) {
8570			/*
8571			 * We are not registered and trying to register but
8572			 * the register key isn't zero.
8573			 */
8574			mtx_unlock(&lun->lun_lock);
8575			free(ctsio->kern_data_ptr, M_CTL);
8576			ctl_set_reservation_conflict(ctsio);
8577			ctl_done((union ctl_io *)ctsio);
8578			return (CTL_RETVAL_COMPLETE);
8579		}
8580		mtx_unlock(&lun->lun_lock);
8581	}
8582
8583	switch (cdb->action & SPRO_ACTION_MASK) {
8584	case SPRO_REGISTER:
8585	case SPRO_REG_IGNO: {
8586
8587#if 0
8588		printf("Registration received\n");
8589#endif
8590
8591		/*
8592		 * We don't support any of these options, as we report in
8593		 * the read capabilities request (see
8594		 * ctl_persistent_reserve_in(), above).
8595		 */
8596		if ((param->flags & SPR_SPEC_I_PT)
8597		 || (param->flags & SPR_ALL_TG_PT)
8598		 || (param->flags & SPR_APTPL)) {
8599			int bit_ptr;
8600
8601			if (param->flags & SPR_APTPL)
8602				bit_ptr = 0;
8603			else if (param->flags & SPR_ALL_TG_PT)
8604				bit_ptr = 2;
8605			else /* SPR_SPEC_I_PT */
8606				bit_ptr = 3;
8607
8608			free(ctsio->kern_data_ptr, M_CTL);
8609			ctl_set_invalid_field(ctsio,
8610					      /*sks_valid*/ 1,
8611					      /*command*/ 0,
8612					      /*field*/ 20,
8613					      /*bit_valid*/ 1,
8614					      /*bit*/ bit_ptr);
8615			ctl_done((union ctl_io *)ctsio);
8616			return (CTL_RETVAL_COMPLETE);
8617		}
8618
8619		mtx_lock(&lun->lun_lock);
8620
8621		/*
8622		 * The initiator wants to clear the
8623		 * key/unregister.
8624		 */
8625		if (sa_res_key == 0) {
8626			if ((res_key == 0
8627			  && (cdb->action & SPRO_ACTION_MASK) == SPRO_REGISTER)
8628			 || ((cdb->action & SPRO_ACTION_MASK) == SPRO_REG_IGNO
8629			  && !lun->per_res[residx].registered)) {
8630				mtx_unlock(&lun->lun_lock);
8631				goto done;
8632			}
8633
8634			lun->per_res[residx].registered = 0;
8635			memset(&lun->per_res[residx].res_key,
8636			       0, sizeof(lun->per_res[residx].res_key));
8637			lun->pr_key_count--;
8638
8639			if (residx == lun->pr_res_idx) {
8640				lun->flags &= ~CTL_LUN_PR_RESERVED;
8641				lun->pr_res_idx = CTL_PR_NO_RESERVATION;
8642
8643				if ((lun->res_type == SPR_TYPE_WR_EX_RO
8644				  || lun->res_type == SPR_TYPE_EX_AC_RO)
8645				 && lun->pr_key_count) {
8646					/*
8647					 * If the reservation is a registrants
8648					 * only type we need to generate a UA
8649					 * for other registered inits.  The
8650					 * sense code should be RESERVATIONS
8651					 * RELEASED
8652					 */
8653
8654					for (i = 0; i < CTL_MAX_INITIATORS;i++){
8655						if (lun->per_res[
8656						    i+persis_offset].registered
8657						    == 0)
8658							continue;
8659						lun->pending_ua[i] |=
8660							CTL_UA_RES_RELEASE;
8661					}
8662				}
8663				lun->res_type = 0;
8664			} else if (lun->pr_res_idx == CTL_PR_ALL_REGISTRANTS) {
8665				if (lun->pr_key_count==0) {
8666					lun->flags &= ~CTL_LUN_PR_RESERVED;
8667					lun->res_type = 0;
8668					lun->pr_res_idx = CTL_PR_NO_RESERVATION;
8669				}
8670			}
8671			persis_io.hdr.nexus = ctsio->io_hdr.nexus;
8672			persis_io.hdr.msg_type = CTL_MSG_PERS_ACTION;
8673			persis_io.pr.pr_info.action = CTL_PR_UNREG_KEY;
8674			persis_io.pr.pr_info.residx = residx;
8675			if ((isc_retval = ctl_ha_msg_send(CTL_HA_CHAN_CTL,
8676			     &persis_io, sizeof(persis_io), 0 )) >
8677			     CTL_HA_STATUS_SUCCESS) {
8678				printf("CTL:Persis Out error returned from "
8679				       "ctl_ha_msg_send %d\n", isc_retval);
8680			}
8681		} else /* sa_res_key != 0 */ {
8682
8683			/*
8684			 * If we aren't registered currently then increment
8685			 * the key count and set the registered flag.
8686			 */
8687			if (!lun->per_res[residx].registered) {
8688				lun->pr_key_count++;
8689				lun->per_res[residx].registered = 1;
8690			}
8691
8692			memcpy(&lun->per_res[residx].res_key,
8693			       param->serv_act_res_key,
8694			       ctl_min(sizeof(param->serv_act_res_key),
8695			       sizeof(lun->per_res[residx].res_key)));
8696
8697			persis_io.hdr.nexus = ctsio->io_hdr.nexus;
8698			persis_io.hdr.msg_type = CTL_MSG_PERS_ACTION;
8699			persis_io.pr.pr_info.action = CTL_PR_REG_KEY;
8700			persis_io.pr.pr_info.residx = residx;
8701			memcpy(persis_io.pr.pr_info.sa_res_key,
8702			       param->serv_act_res_key,
8703			       sizeof(param->serv_act_res_key));
8704			if ((isc_retval=ctl_ha_msg_send(CTL_HA_CHAN_CTL,
8705			     &persis_io, sizeof(persis_io), 0)) >
8706			     CTL_HA_STATUS_SUCCESS) {
8707				printf("CTL:Persis Out error returned from "
8708				       "ctl_ha_msg_send %d\n", isc_retval);
8709			}
8710		}
8711		lun->PRGeneration++;
8712		mtx_unlock(&lun->lun_lock);
8713
8714		break;
8715	}
8716	case SPRO_RESERVE:
8717#if 0
8718                printf("Reserve executed type %d\n", type);
8719#endif
8720		mtx_lock(&lun->lun_lock);
8721		if (lun->flags & CTL_LUN_PR_RESERVED) {
8722			/*
8723			 * if this isn't the reservation holder and it's
8724			 * not a "all registrants" type or if the type is
8725			 * different then we have a conflict
8726			 */
8727			if ((lun->pr_res_idx != residx
8728			  && lun->pr_res_idx != CTL_PR_ALL_REGISTRANTS)
8729			 || lun->res_type != type) {
8730				mtx_unlock(&lun->lun_lock);
8731				free(ctsio->kern_data_ptr, M_CTL);
8732				ctl_set_reservation_conflict(ctsio);
8733				ctl_done((union ctl_io *)ctsio);
8734				return (CTL_RETVAL_COMPLETE);
8735			}
8736			mtx_unlock(&lun->lun_lock);
8737		} else /* create a reservation */ {
8738			/*
8739			 * If it's not an "all registrants" type record
8740			 * reservation holder
8741			 */
8742			if (type != SPR_TYPE_WR_EX_AR
8743			 && type != SPR_TYPE_EX_AC_AR)
8744				lun->pr_res_idx = residx; /* Res holder */
8745			else
8746				lun->pr_res_idx = CTL_PR_ALL_REGISTRANTS;
8747
8748			lun->flags |= CTL_LUN_PR_RESERVED;
8749			lun->res_type = type;
8750
8751			mtx_unlock(&lun->lun_lock);
8752
8753			/* send msg to other side */
8754			persis_io.hdr.nexus = ctsio->io_hdr.nexus;
8755			persis_io.hdr.msg_type = CTL_MSG_PERS_ACTION;
8756			persis_io.pr.pr_info.action = CTL_PR_RESERVE;
8757			persis_io.pr.pr_info.residx = lun->pr_res_idx;
8758			persis_io.pr.pr_info.res_type = type;
8759			if ((isc_retval=ctl_ha_msg_send(CTL_HA_CHAN_CTL,
8760			     &persis_io, sizeof(persis_io), 0)) >
8761			     CTL_HA_STATUS_SUCCESS) {
8762				printf("CTL:Persis Out error returned from "
8763				       "ctl_ha_msg_send %d\n", isc_retval);
8764			}
8765		}
8766		break;
8767
8768	case SPRO_RELEASE:
8769		mtx_lock(&lun->lun_lock);
8770		if ((lun->flags & CTL_LUN_PR_RESERVED) == 0) {
8771			/* No reservation exists return good status */
8772			mtx_unlock(&lun->lun_lock);
8773			goto done;
8774		}
8775		/*
8776		 * Is this nexus a reservation holder?
8777		 */
8778		if (lun->pr_res_idx != residx
8779		 && lun->pr_res_idx != CTL_PR_ALL_REGISTRANTS) {
8780			/*
8781			 * not a res holder return good status but
8782			 * do nothing
8783			 */
8784			mtx_unlock(&lun->lun_lock);
8785			goto done;
8786		}
8787
8788		if (lun->res_type != type) {
8789			mtx_unlock(&lun->lun_lock);
8790			free(ctsio->kern_data_ptr, M_CTL);
8791			ctl_set_illegal_pr_release(ctsio);
8792			ctl_done((union ctl_io *)ctsio);
8793			return (CTL_RETVAL_COMPLETE);
8794		}
8795
8796		/* okay to release */
8797		lun->flags &= ~CTL_LUN_PR_RESERVED;
8798		lun->pr_res_idx = CTL_PR_NO_RESERVATION;
8799		lun->res_type = 0;
8800
8801		/*
8802		 * if this isn't an exclusive access
8803		 * res generate UA for all other
8804		 * registrants.
8805		 */
8806		if (type != SPR_TYPE_EX_AC
8807		 && type != SPR_TYPE_WR_EX) {
8808			/*
8809			 * temporarily unregister so we don't generate UA
8810			 */
8811			lun->per_res[residx].registered = 0;
8812
8813			for (i = 0; i < CTL_MAX_INITIATORS; i++) {
8814				if (lun->per_res[i+persis_offset].registered
8815				    == 0)
8816					continue;
8817				lun->pending_ua[i] |=
8818					CTL_UA_RES_RELEASE;
8819			}
8820
8821			lun->per_res[residx].registered = 1;
8822		}
8823		mtx_unlock(&lun->lun_lock);
8824		/* Send msg to other side */
8825		persis_io.hdr.nexus = ctsio->io_hdr.nexus;
8826		persis_io.hdr.msg_type = CTL_MSG_PERS_ACTION;
8827		persis_io.pr.pr_info.action = CTL_PR_RELEASE;
8828		if ((isc_retval=ctl_ha_msg_send( CTL_HA_CHAN_CTL, &persis_io,
8829		     sizeof(persis_io), 0)) > CTL_HA_STATUS_SUCCESS) {
8830			printf("CTL:Persis Out error returned from "
8831			       "ctl_ha_msg_send %d\n", isc_retval);
8832		}
8833		break;
8834
8835	case SPRO_CLEAR:
8836		/* send msg to other side */
8837
8838		mtx_lock(&lun->lun_lock);
8839		lun->flags &= ~CTL_LUN_PR_RESERVED;
8840		lun->res_type = 0;
8841		lun->pr_key_count = 0;
8842		lun->pr_res_idx = CTL_PR_NO_RESERVATION;
8843
8844
8845		memset(&lun->per_res[residx].res_key,
8846		       0, sizeof(lun->per_res[residx].res_key));
8847		lun->per_res[residx].registered = 0;
8848
8849		for (i=0; i < 2*CTL_MAX_INITIATORS; i++)
8850			if (lun->per_res[i].registered) {
8851				if (!persis_offset && i < CTL_MAX_INITIATORS)
8852					lun->pending_ua[i] |=
8853						CTL_UA_RES_PREEMPT;
8854				else if (persis_offset && i >= persis_offset)
8855					lun->pending_ua[i-persis_offset] |=
8856					    CTL_UA_RES_PREEMPT;
8857
8858				memset(&lun->per_res[i].res_key,
8859				       0, sizeof(struct scsi_per_res_key));
8860				lun->per_res[i].registered = 0;
8861			}
8862		lun->PRGeneration++;
8863		mtx_unlock(&lun->lun_lock);
8864		persis_io.hdr.nexus = ctsio->io_hdr.nexus;
8865		persis_io.hdr.msg_type = CTL_MSG_PERS_ACTION;
8866		persis_io.pr.pr_info.action = CTL_PR_CLEAR;
8867		if ((isc_retval=ctl_ha_msg_send(CTL_HA_CHAN_CTL, &persis_io,
8868		     sizeof(persis_io), 0)) > CTL_HA_STATUS_SUCCESS) {
8869			printf("CTL:Persis Out error returned from "
8870			       "ctl_ha_msg_send %d\n", isc_retval);
8871		}
8872		break;
8873
8874	case SPRO_PREEMPT: {
8875		int nretval;
8876
8877		nretval = ctl_pro_preempt(softc, lun, res_key, sa_res_key, type,
8878					  residx, ctsio, cdb, param);
8879		if (nretval != 0)
8880			return (CTL_RETVAL_COMPLETE);
8881		break;
8882	}
8883	default:
8884		panic("Invalid PR type %x", cdb->action);
8885	}
8886
8887done:
8888	free(ctsio->kern_data_ptr, M_CTL);
8889	ctl_set_success(ctsio);
8890	ctl_done((union ctl_io *)ctsio);
8891
8892	return (retval);
8893}
8894
8895/*
8896 * This routine is for handling a message from the other SC pertaining to
8897 * persistent reserve out. All the error checking will have been done
8898 * so only perorming the action need be done here to keep the two
8899 * in sync.
8900 */
8901static void
8902ctl_hndl_per_res_out_on_other_sc(union ctl_ha_msg *msg)
8903{
8904	struct ctl_lun *lun;
8905	struct ctl_softc *softc;
8906	int i;
8907	uint32_t targ_lun;
8908
8909	softc = control_softc;
8910
8911	targ_lun = msg->hdr.nexus.targ_mapped_lun;
8912	lun = softc->ctl_luns[targ_lun];
8913	mtx_lock(&lun->lun_lock);
8914	switch(msg->pr.pr_info.action) {
8915	case CTL_PR_REG_KEY:
8916		if (!lun->per_res[msg->pr.pr_info.residx].registered) {
8917			lun->per_res[msg->pr.pr_info.residx].registered = 1;
8918			lun->pr_key_count++;
8919		}
8920		lun->PRGeneration++;
8921		memcpy(&lun->per_res[msg->pr.pr_info.residx].res_key,
8922		       msg->pr.pr_info.sa_res_key,
8923		       sizeof(struct scsi_per_res_key));
8924		break;
8925
8926	case CTL_PR_UNREG_KEY:
8927		lun->per_res[msg->pr.pr_info.residx].registered = 0;
8928		memset(&lun->per_res[msg->pr.pr_info.residx].res_key,
8929		       0, sizeof(struct scsi_per_res_key));
8930		lun->pr_key_count--;
8931
8932		/* XXX Need to see if the reservation has been released */
8933		/* if so do we need to generate UA? */
8934		if (msg->pr.pr_info.residx == lun->pr_res_idx) {
8935			lun->flags &= ~CTL_LUN_PR_RESERVED;
8936			lun->pr_res_idx = CTL_PR_NO_RESERVATION;
8937
8938			if ((lun->res_type == SPR_TYPE_WR_EX_RO
8939			  || lun->res_type == SPR_TYPE_EX_AC_RO)
8940			 && lun->pr_key_count) {
8941				/*
8942				 * If the reservation is a registrants
8943				 * only type we need to generate a UA
8944				 * for other registered inits.  The
8945				 * sense code should be RESERVATIONS
8946				 * RELEASED
8947				 */
8948
8949				for (i = 0; i < CTL_MAX_INITIATORS; i++) {
8950					if (lun->per_res[i+
8951					    persis_offset].registered == 0)
8952						continue;
8953
8954					lun->pending_ua[i] |=
8955						CTL_UA_RES_RELEASE;
8956				}
8957			}
8958			lun->res_type = 0;
8959		} else if (lun->pr_res_idx == CTL_PR_ALL_REGISTRANTS) {
8960			if (lun->pr_key_count==0) {
8961				lun->flags &= ~CTL_LUN_PR_RESERVED;
8962				lun->res_type = 0;
8963				lun->pr_res_idx = CTL_PR_NO_RESERVATION;
8964			}
8965		}
8966		lun->PRGeneration++;
8967		break;
8968
8969	case CTL_PR_RESERVE:
8970		lun->flags |= CTL_LUN_PR_RESERVED;
8971		lun->res_type = msg->pr.pr_info.res_type;
8972		lun->pr_res_idx = msg->pr.pr_info.residx;
8973
8974		break;
8975
8976	case CTL_PR_RELEASE:
8977		/*
8978		 * if this isn't an exclusive access res generate UA for all
8979		 * other registrants.
8980		 */
8981		if (lun->res_type != SPR_TYPE_EX_AC
8982		 && lun->res_type != SPR_TYPE_WR_EX) {
8983			for (i = 0; i < CTL_MAX_INITIATORS; i++)
8984				if (lun->per_res[i+persis_offset].registered)
8985					lun->pending_ua[i] |=
8986						CTL_UA_RES_RELEASE;
8987		}
8988
8989		lun->flags &= ~CTL_LUN_PR_RESERVED;
8990		lun->pr_res_idx = CTL_PR_NO_RESERVATION;
8991		lun->res_type = 0;
8992		break;
8993
8994	case CTL_PR_PREEMPT:
8995		ctl_pro_preempt_other(lun, msg);
8996		break;
8997	case CTL_PR_CLEAR:
8998		lun->flags &= ~CTL_LUN_PR_RESERVED;
8999		lun->res_type = 0;
9000		lun->pr_key_count = 0;
9001		lun->pr_res_idx = CTL_PR_NO_RESERVATION;
9002
9003		for (i=0; i < 2*CTL_MAX_INITIATORS; i++) {
9004			if (lun->per_res[i].registered == 0)
9005				continue;
9006			if (!persis_offset
9007			 && i < CTL_MAX_INITIATORS)
9008				lun->pending_ua[i] |= CTL_UA_RES_PREEMPT;
9009			else if (persis_offset
9010			      && i >= persis_offset)
9011				lun->pending_ua[i-persis_offset] |=
9012					CTL_UA_RES_PREEMPT;
9013			memset(&lun->per_res[i].res_key, 0,
9014			       sizeof(struct scsi_per_res_key));
9015			lun->per_res[i].registered = 0;
9016		}
9017		lun->PRGeneration++;
9018		break;
9019	}
9020
9021	mtx_unlock(&lun->lun_lock);
9022}
9023
9024int
9025ctl_read_write(struct ctl_scsiio *ctsio)
9026{
9027	struct ctl_lun *lun;
9028	struct ctl_lba_len_flags *lbalen;
9029	uint64_t lba;
9030	uint32_t num_blocks;
9031	int flags, retval;
9032	int isread;
9033
9034	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
9035
9036	CTL_DEBUG_PRINT(("ctl_read_write: command: %#x\n", ctsio->cdb[0]));
9037
9038	flags = 0;
9039	retval = CTL_RETVAL_COMPLETE;
9040
9041	isread = ctsio->cdb[0] == READ_6  || ctsio->cdb[0] == READ_10
9042	      || ctsio->cdb[0] == READ_12 || ctsio->cdb[0] == READ_16;
9043	if (lun->flags & CTL_LUN_PR_RESERVED && isread) {
9044		uint32_t residx;
9045
9046		/*
9047		 * XXX KDM need a lock here.
9048		 */
9049		residx = ctl_get_resindex(&ctsio->io_hdr.nexus);
9050		if ((lun->res_type == SPR_TYPE_EX_AC
9051		  && residx != lun->pr_res_idx)
9052		 || ((lun->res_type == SPR_TYPE_EX_AC_RO
9053		   || lun->res_type == SPR_TYPE_EX_AC_AR)
9054		  && !lun->per_res[residx].registered)) {
9055			ctl_set_reservation_conflict(ctsio);
9056			ctl_done((union ctl_io *)ctsio);
9057			return (CTL_RETVAL_COMPLETE);
9058	        }
9059	}
9060
9061	switch (ctsio->cdb[0]) {
9062	case READ_6:
9063	case WRITE_6: {
9064		struct scsi_rw_6 *cdb;
9065
9066		cdb = (struct scsi_rw_6 *)ctsio->cdb;
9067
9068		lba = scsi_3btoul(cdb->addr);
9069		/* only 5 bits are valid in the most significant address byte */
9070		lba &= 0x1fffff;
9071		num_blocks = cdb->length;
9072		/*
9073		 * This is correct according to SBC-2.
9074		 */
9075		if (num_blocks == 0)
9076			num_blocks = 256;
9077		break;
9078	}
9079	case READ_10:
9080	case WRITE_10: {
9081		struct scsi_rw_10 *cdb;
9082
9083		cdb = (struct scsi_rw_10 *)ctsio->cdb;
9084		if (cdb->byte2 & SRW10_FUA)
9085			flags |= CTL_LLF_FUA;
9086		if (cdb->byte2 & SRW10_DPO)
9087			flags |= CTL_LLF_DPO;
9088		lba = scsi_4btoul(cdb->addr);
9089		num_blocks = scsi_2btoul(cdb->length);
9090		break;
9091	}
9092	case WRITE_VERIFY_10: {
9093		struct scsi_write_verify_10 *cdb;
9094
9095		cdb = (struct scsi_write_verify_10 *)ctsio->cdb;
9096		flags |= CTL_LLF_FUA;
9097		if (cdb->byte2 & SWV_DPO)
9098			flags |= CTL_LLF_DPO;
9099		lba = scsi_4btoul(cdb->addr);
9100		num_blocks = scsi_2btoul(cdb->length);
9101		break;
9102	}
9103	case READ_12:
9104	case WRITE_12: {
9105		struct scsi_rw_12 *cdb;
9106
9107		cdb = (struct scsi_rw_12 *)ctsio->cdb;
9108		if (cdb->byte2 & SRW12_FUA)
9109			flags |= CTL_LLF_FUA;
9110		if (cdb->byte2 & SRW12_DPO)
9111			flags |= CTL_LLF_DPO;
9112		lba = scsi_4btoul(cdb->addr);
9113		num_blocks = scsi_4btoul(cdb->length);
9114		break;
9115	}
9116	case WRITE_VERIFY_12: {
9117		struct scsi_write_verify_12 *cdb;
9118
9119		cdb = (struct scsi_write_verify_12 *)ctsio->cdb;
9120		flags |= CTL_LLF_FUA;
9121		if (cdb->byte2 & SWV_DPO)
9122			flags |= CTL_LLF_DPO;
9123		lba = scsi_4btoul(cdb->addr);
9124		num_blocks = scsi_4btoul(cdb->length);
9125		break;
9126	}
9127	case READ_16:
9128	case WRITE_16: {
9129		struct scsi_rw_16 *cdb;
9130
9131		cdb = (struct scsi_rw_16 *)ctsio->cdb;
9132		if (cdb->byte2 & SRW12_FUA)
9133			flags |= CTL_LLF_FUA;
9134		if (cdb->byte2 & SRW12_DPO)
9135			flags |= CTL_LLF_DPO;
9136		lba = scsi_8btou64(cdb->addr);
9137		num_blocks = scsi_4btoul(cdb->length);
9138		break;
9139	}
9140	case WRITE_VERIFY_16: {
9141		struct scsi_write_verify_16 *cdb;
9142
9143		cdb = (struct scsi_write_verify_16 *)ctsio->cdb;
9144		flags |= CTL_LLF_FUA;
9145		if (cdb->byte2 & SWV_DPO)
9146			flags |= CTL_LLF_DPO;
9147		lba = scsi_8btou64(cdb->addr);
9148		num_blocks = scsi_4btoul(cdb->length);
9149		break;
9150	}
9151	default:
9152		/*
9153		 * We got a command we don't support.  This shouldn't
9154		 * happen, commands should be filtered out above us.
9155		 */
9156		ctl_set_invalid_opcode(ctsio);
9157		ctl_done((union ctl_io *)ctsio);
9158
9159		return (CTL_RETVAL_COMPLETE);
9160		break; /* NOTREACHED */
9161	}
9162
9163	/*
9164	 * The first check is to make sure we're in bounds, the second
9165	 * check is to catch wrap-around problems.  If the lba + num blocks
9166	 * is less than the lba, then we've wrapped around and the block
9167	 * range is invalid anyway.
9168	 */
9169	if (((lba + num_blocks) > (lun->be_lun->maxlba + 1))
9170	 || ((lba + num_blocks) < lba)) {
9171		ctl_set_lba_out_of_range(ctsio);
9172		ctl_done((union ctl_io *)ctsio);
9173		return (CTL_RETVAL_COMPLETE);
9174	}
9175
9176	/*
9177	 * According to SBC-3, a transfer length of 0 is not an error.
9178	 * Note that this cannot happen with WRITE(6) or READ(6), since 0
9179	 * translates to 256 blocks for those commands.
9180	 */
9181	if (num_blocks == 0) {
9182		ctl_set_success(ctsio);
9183		ctl_done((union ctl_io *)ctsio);
9184		return (CTL_RETVAL_COMPLETE);
9185	}
9186
9187	/* Set FUA and/or DPO if caches are disabled. */
9188	if (isread) {
9189		if ((lun->mode_pages.caching_page[CTL_PAGE_CURRENT].flags1 &
9190		    SCP_RCD) != 0)
9191			flags |= CTL_LLF_FUA | CTL_LLF_DPO;
9192	} else {
9193		if ((lun->mode_pages.caching_page[CTL_PAGE_CURRENT].flags1 &
9194		    SCP_WCE) == 0)
9195			flags |= CTL_LLF_FUA;
9196	}
9197
9198	lbalen = (struct ctl_lba_len_flags *)
9199	    &ctsio->io_hdr.ctl_private[CTL_PRIV_LBA_LEN];
9200	lbalen->lba = lba;
9201	lbalen->len = num_blocks;
9202	lbalen->flags = (isread ? CTL_LLF_READ : CTL_LLF_WRITE) | flags;
9203
9204	ctsio->kern_total_len = num_blocks * lun->be_lun->blocksize;
9205	ctsio->kern_rel_offset = 0;
9206
9207	CTL_DEBUG_PRINT(("ctl_read_write: calling data_submit()\n"));
9208
9209	retval = lun->backend->data_submit((union ctl_io *)ctsio);
9210
9211	return (retval);
9212}
9213
9214static int
9215ctl_cnw_cont(union ctl_io *io)
9216{
9217	struct ctl_scsiio *ctsio;
9218	struct ctl_lun *lun;
9219	struct ctl_lba_len_flags *lbalen;
9220	int retval;
9221
9222	ctsio = &io->scsiio;
9223	ctsio->io_hdr.status = CTL_STATUS_NONE;
9224	ctsio->io_hdr.flags &= ~CTL_FLAG_IO_CONT;
9225	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
9226	lbalen = (struct ctl_lba_len_flags *)
9227	    &ctsio->io_hdr.ctl_private[CTL_PRIV_LBA_LEN];
9228	lbalen->flags &= ~CTL_LLF_COMPARE;
9229	lbalen->flags |= CTL_LLF_WRITE;
9230
9231	CTL_DEBUG_PRINT(("ctl_cnw_cont: calling data_submit()\n"));
9232	retval = lun->backend->data_submit((union ctl_io *)ctsio);
9233	return (retval);
9234}
9235
9236int
9237ctl_cnw(struct ctl_scsiio *ctsio)
9238{
9239	struct ctl_lun *lun;
9240	struct ctl_lba_len_flags *lbalen;
9241	uint64_t lba;
9242	uint32_t num_blocks;
9243	int flags, retval;
9244
9245	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
9246
9247	CTL_DEBUG_PRINT(("ctl_cnw: command: %#x\n", ctsio->cdb[0]));
9248
9249	flags = 0;
9250	retval = CTL_RETVAL_COMPLETE;
9251
9252	switch (ctsio->cdb[0]) {
9253	case COMPARE_AND_WRITE: {
9254		struct scsi_compare_and_write *cdb;
9255
9256		cdb = (struct scsi_compare_and_write *)ctsio->cdb;
9257		if (cdb->byte2 & SRW10_FUA)
9258			flags |= CTL_LLF_FUA;
9259		if (cdb->byte2 & SRW10_DPO)
9260			flags |= CTL_LLF_DPO;
9261		lba = scsi_8btou64(cdb->addr);
9262		num_blocks = cdb->length;
9263		break;
9264	}
9265	default:
9266		/*
9267		 * We got a command we don't support.  This shouldn't
9268		 * happen, commands should be filtered out above us.
9269		 */
9270		ctl_set_invalid_opcode(ctsio);
9271		ctl_done((union ctl_io *)ctsio);
9272
9273		return (CTL_RETVAL_COMPLETE);
9274		break; /* NOTREACHED */
9275	}
9276
9277	/*
9278	 * The first check is to make sure we're in bounds, the second
9279	 * check is to catch wrap-around problems.  If the lba + num blocks
9280	 * is less than the lba, then we've wrapped around and the block
9281	 * range is invalid anyway.
9282	 */
9283	if (((lba + num_blocks) > (lun->be_lun->maxlba + 1))
9284	 || ((lba + num_blocks) < lba)) {
9285		ctl_set_lba_out_of_range(ctsio);
9286		ctl_done((union ctl_io *)ctsio);
9287		return (CTL_RETVAL_COMPLETE);
9288	}
9289
9290	/*
9291	 * According to SBC-3, a transfer length of 0 is not an error.
9292	 */
9293	if (num_blocks == 0) {
9294		ctl_set_success(ctsio);
9295		ctl_done((union ctl_io *)ctsio);
9296		return (CTL_RETVAL_COMPLETE);
9297	}
9298
9299	/* Set FUA if write cache is disabled. */
9300	if ((lun->mode_pages.caching_page[CTL_PAGE_CURRENT].flags1 &
9301	    SCP_WCE) == 0)
9302		flags |= CTL_LLF_FUA;
9303
9304	ctsio->kern_total_len = 2 * num_blocks * lun->be_lun->blocksize;
9305	ctsio->kern_rel_offset = 0;
9306
9307	/*
9308	 * Set the IO_CONT flag, so that if this I/O gets passed to
9309	 * ctl_data_submit_done(), it'll get passed back to
9310	 * ctl_ctl_cnw_cont() for further processing.
9311	 */
9312	ctsio->io_hdr.flags |= CTL_FLAG_IO_CONT;
9313	ctsio->io_cont = ctl_cnw_cont;
9314
9315	lbalen = (struct ctl_lba_len_flags *)
9316	    &ctsio->io_hdr.ctl_private[CTL_PRIV_LBA_LEN];
9317	lbalen->lba = lba;
9318	lbalen->len = num_blocks;
9319	lbalen->flags = CTL_LLF_COMPARE | flags;
9320
9321	CTL_DEBUG_PRINT(("ctl_cnw: calling data_submit()\n"));
9322	retval = lun->backend->data_submit((union ctl_io *)ctsio);
9323	return (retval);
9324}
9325
9326int
9327ctl_verify(struct ctl_scsiio *ctsio)
9328{
9329	struct ctl_lun *lun;
9330	struct ctl_lba_len_flags *lbalen;
9331	uint64_t lba;
9332	uint32_t num_blocks;
9333	int bytchk, flags;
9334	int retval;
9335
9336	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
9337
9338	CTL_DEBUG_PRINT(("ctl_verify: command: %#x\n", ctsio->cdb[0]));
9339
9340	bytchk = 0;
9341	flags = CTL_LLF_FUA;
9342	retval = CTL_RETVAL_COMPLETE;
9343
9344	switch (ctsio->cdb[0]) {
9345	case VERIFY_10: {
9346		struct scsi_verify_10 *cdb;
9347
9348		cdb = (struct scsi_verify_10 *)ctsio->cdb;
9349		if (cdb->byte2 & SVFY_BYTCHK)
9350			bytchk = 1;
9351		if (cdb->byte2 & SVFY_DPO)
9352			flags |= CTL_LLF_DPO;
9353		lba = scsi_4btoul(cdb->addr);
9354		num_blocks = scsi_2btoul(cdb->length);
9355		break;
9356	}
9357	case VERIFY_12: {
9358		struct scsi_verify_12 *cdb;
9359
9360		cdb = (struct scsi_verify_12 *)ctsio->cdb;
9361		if (cdb->byte2 & SVFY_BYTCHK)
9362			bytchk = 1;
9363		if (cdb->byte2 & SVFY_DPO)
9364			flags |= CTL_LLF_DPO;
9365		lba = scsi_4btoul(cdb->addr);
9366		num_blocks = scsi_4btoul(cdb->length);
9367		break;
9368	}
9369	case VERIFY_16: {
9370		struct scsi_rw_16 *cdb;
9371
9372		cdb = (struct scsi_rw_16 *)ctsio->cdb;
9373		if (cdb->byte2 & SVFY_BYTCHK)
9374			bytchk = 1;
9375		if (cdb->byte2 & SVFY_DPO)
9376			flags |= CTL_LLF_DPO;
9377		lba = scsi_8btou64(cdb->addr);
9378		num_blocks = scsi_4btoul(cdb->length);
9379		break;
9380	}
9381	default:
9382		/*
9383		 * We got a command we don't support.  This shouldn't
9384		 * happen, commands should be filtered out above us.
9385		 */
9386		ctl_set_invalid_opcode(ctsio);
9387		ctl_done((union ctl_io *)ctsio);
9388		return (CTL_RETVAL_COMPLETE);
9389	}
9390
9391	/*
9392	 * The first check is to make sure we're in bounds, the second
9393	 * check is to catch wrap-around problems.  If the lba + num blocks
9394	 * is less than the lba, then we've wrapped around and the block
9395	 * range is invalid anyway.
9396	 */
9397	if (((lba + num_blocks) > (lun->be_lun->maxlba + 1))
9398	 || ((lba + num_blocks) < lba)) {
9399		ctl_set_lba_out_of_range(ctsio);
9400		ctl_done((union ctl_io *)ctsio);
9401		return (CTL_RETVAL_COMPLETE);
9402	}
9403
9404	/*
9405	 * According to SBC-3, a transfer length of 0 is not an error.
9406	 */
9407	if (num_blocks == 0) {
9408		ctl_set_success(ctsio);
9409		ctl_done((union ctl_io *)ctsio);
9410		return (CTL_RETVAL_COMPLETE);
9411	}
9412
9413	lbalen = (struct ctl_lba_len_flags *)
9414	    &ctsio->io_hdr.ctl_private[CTL_PRIV_LBA_LEN];
9415	lbalen->lba = lba;
9416	lbalen->len = num_blocks;
9417	if (bytchk) {
9418		lbalen->flags = CTL_LLF_COMPARE | flags;
9419		ctsio->kern_total_len = num_blocks * lun->be_lun->blocksize;
9420	} else {
9421		lbalen->flags = CTL_LLF_VERIFY | flags;
9422		ctsio->kern_total_len = 0;
9423	}
9424	ctsio->kern_rel_offset = 0;
9425
9426	CTL_DEBUG_PRINT(("ctl_verify: calling data_submit()\n"));
9427	retval = lun->backend->data_submit((union ctl_io *)ctsio);
9428	return (retval);
9429}
9430
9431int
9432ctl_report_luns(struct ctl_scsiio *ctsio)
9433{
9434	struct scsi_report_luns *cdb;
9435	struct scsi_report_luns_data *lun_data;
9436	struct ctl_lun *lun, *request_lun;
9437	int num_luns, retval;
9438	uint32_t alloc_len, lun_datalen;
9439	int num_filled, well_known;
9440	uint32_t initidx, targ_lun_id, lun_id;
9441
9442	retval = CTL_RETVAL_COMPLETE;
9443	well_known = 0;
9444
9445	cdb = (struct scsi_report_luns *)ctsio->cdb;
9446
9447	CTL_DEBUG_PRINT(("ctl_report_luns\n"));
9448
9449	mtx_lock(&control_softc->ctl_lock);
9450	num_luns = control_softc->num_luns;
9451	mtx_unlock(&control_softc->ctl_lock);
9452
9453	switch (cdb->select_report) {
9454	case RPL_REPORT_DEFAULT:
9455	case RPL_REPORT_ALL:
9456		break;
9457	case RPL_REPORT_WELLKNOWN:
9458		well_known = 1;
9459		num_luns = 0;
9460		break;
9461	default:
9462		ctl_set_invalid_field(ctsio,
9463				      /*sks_valid*/ 1,
9464				      /*command*/ 1,
9465				      /*field*/ 2,
9466				      /*bit_valid*/ 0,
9467				      /*bit*/ 0);
9468		ctl_done((union ctl_io *)ctsio);
9469		return (retval);
9470		break; /* NOTREACHED */
9471	}
9472
9473	alloc_len = scsi_4btoul(cdb->length);
9474	/*
9475	 * The initiator has to allocate at least 16 bytes for this request,
9476	 * so he can at least get the header and the first LUN.  Otherwise
9477	 * we reject the request (per SPC-3 rev 14, section 6.21).
9478	 */
9479	if (alloc_len < (sizeof(struct scsi_report_luns_data) +
9480	    sizeof(struct scsi_report_luns_lundata))) {
9481		ctl_set_invalid_field(ctsio,
9482				      /*sks_valid*/ 1,
9483				      /*command*/ 1,
9484				      /*field*/ 6,
9485				      /*bit_valid*/ 0,
9486				      /*bit*/ 0);
9487		ctl_done((union ctl_io *)ctsio);
9488		return (retval);
9489	}
9490
9491	request_lun = (struct ctl_lun *)
9492		ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
9493
9494	lun_datalen = sizeof(*lun_data) +
9495		(num_luns * sizeof(struct scsi_report_luns_lundata));
9496
9497	ctsio->kern_data_ptr = malloc(lun_datalen, M_CTL, M_WAITOK | M_ZERO);
9498	lun_data = (struct scsi_report_luns_data *)ctsio->kern_data_ptr;
9499	ctsio->kern_sg_entries = 0;
9500
9501	initidx = ctl_get_initindex(&ctsio->io_hdr.nexus);
9502
9503	mtx_lock(&control_softc->ctl_lock);
9504	for (targ_lun_id = 0, num_filled = 0; targ_lun_id < CTL_MAX_LUNS && num_filled < num_luns; targ_lun_id++) {
9505		lun_id = ctl_map_lun(ctsio->io_hdr.nexus.targ_port, targ_lun_id);
9506		if (lun_id >= CTL_MAX_LUNS)
9507			continue;
9508		lun = control_softc->ctl_luns[lun_id];
9509		if (lun == NULL)
9510			continue;
9511
9512		if (targ_lun_id <= 0xff) {
9513			/*
9514			 * Peripheral addressing method, bus number 0.
9515			 */
9516			lun_data->luns[num_filled].lundata[0] =
9517				RPL_LUNDATA_ATYP_PERIPH;
9518			lun_data->luns[num_filled].lundata[1] = targ_lun_id;
9519			num_filled++;
9520		} else if (targ_lun_id <= 0x3fff) {
9521			/*
9522			 * Flat addressing method.
9523			 */
9524			lun_data->luns[num_filled].lundata[0] =
9525				RPL_LUNDATA_ATYP_FLAT |
9526				(targ_lun_id & RPL_LUNDATA_FLAT_LUN_MASK);
9527#ifdef OLDCTLHEADERS
9528				(SRLD_ADDR_FLAT << SRLD_ADDR_SHIFT) |
9529				(targ_lun_id & SRLD_BUS_LUN_MASK);
9530#endif
9531			lun_data->luns[num_filled].lundata[1] =
9532#ifdef OLDCTLHEADERS
9533				targ_lun_id >> SRLD_BUS_LUN_BITS;
9534#endif
9535				targ_lun_id >> RPL_LUNDATA_FLAT_LUN_BITS;
9536			num_filled++;
9537		} else {
9538			printf("ctl_report_luns: bogus LUN number %jd, "
9539			       "skipping\n", (intmax_t)targ_lun_id);
9540		}
9541		/*
9542		 * According to SPC-3, rev 14 section 6.21:
9543		 *
9544		 * "The execution of a REPORT LUNS command to any valid and
9545		 * installed logical unit shall clear the REPORTED LUNS DATA
9546		 * HAS CHANGED unit attention condition for all logical
9547		 * units of that target with respect to the requesting
9548		 * initiator. A valid and installed logical unit is one
9549		 * having a PERIPHERAL QUALIFIER of 000b in the standard
9550		 * INQUIRY data (see 6.4.2)."
9551		 *
9552		 * If request_lun is NULL, the LUN this report luns command
9553		 * was issued to is either disabled or doesn't exist. In that
9554		 * case, we shouldn't clear any pending lun change unit
9555		 * attention.
9556		 */
9557		if (request_lun != NULL) {
9558			mtx_lock(&lun->lun_lock);
9559			lun->pending_ua[initidx] &= ~CTL_UA_LUN_CHANGE;
9560			mtx_unlock(&lun->lun_lock);
9561		}
9562	}
9563	mtx_unlock(&control_softc->ctl_lock);
9564
9565	/*
9566	 * It's quite possible that we've returned fewer LUNs than we allocated
9567	 * space for.  Trim it.
9568	 */
9569	lun_datalen = sizeof(*lun_data) +
9570		(num_filled * sizeof(struct scsi_report_luns_lundata));
9571
9572	if (lun_datalen < alloc_len) {
9573		ctsio->residual = alloc_len - lun_datalen;
9574		ctsio->kern_data_len = lun_datalen;
9575		ctsio->kern_total_len = lun_datalen;
9576	} else {
9577		ctsio->residual = 0;
9578		ctsio->kern_data_len = alloc_len;
9579		ctsio->kern_total_len = alloc_len;
9580	}
9581	ctsio->kern_data_resid = 0;
9582	ctsio->kern_rel_offset = 0;
9583	ctsio->kern_sg_entries = 0;
9584
9585	/*
9586	 * We set this to the actual data length, regardless of how much
9587	 * space we actually have to return results.  If the user looks at
9588	 * this value, he'll know whether or not he allocated enough space
9589	 * and reissue the command if necessary.  We don't support well
9590	 * known logical units, so if the user asks for that, return none.
9591	 */
9592	scsi_ulto4b(lun_datalen - 8, lun_data->length);
9593
9594	/*
9595	 * We can only return SCSI_STATUS_CHECK_COND when we can't satisfy
9596	 * this request.
9597	 */
9598	ctsio->scsi_status = SCSI_STATUS_OK;
9599
9600	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
9601	ctsio->be_move_done = ctl_config_move_done;
9602	ctl_datamove((union ctl_io *)ctsio);
9603
9604	return (retval);
9605}
9606
9607int
9608ctl_request_sense(struct ctl_scsiio *ctsio)
9609{
9610	struct scsi_request_sense *cdb;
9611	struct scsi_sense_data *sense_ptr;
9612	struct ctl_lun *lun;
9613	uint32_t initidx;
9614	int have_error;
9615	scsi_sense_data_type sense_format;
9616
9617	cdb = (struct scsi_request_sense *)ctsio->cdb;
9618
9619	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
9620
9621	CTL_DEBUG_PRINT(("ctl_request_sense\n"));
9622
9623	/*
9624	 * Determine which sense format the user wants.
9625	 */
9626	if (cdb->byte2 & SRS_DESC)
9627		sense_format = SSD_TYPE_DESC;
9628	else
9629		sense_format = SSD_TYPE_FIXED;
9630
9631	ctsio->kern_data_ptr = malloc(sizeof(*sense_ptr), M_CTL, M_WAITOK);
9632	sense_ptr = (struct scsi_sense_data *)ctsio->kern_data_ptr;
9633	ctsio->kern_sg_entries = 0;
9634
9635	/*
9636	 * struct scsi_sense_data, which is currently set to 256 bytes, is
9637	 * larger than the largest allowed value for the length field in the
9638	 * REQUEST SENSE CDB, which is 252 bytes as of SPC-4.
9639	 */
9640	ctsio->residual = 0;
9641	ctsio->kern_data_len = cdb->length;
9642	ctsio->kern_total_len = cdb->length;
9643
9644	ctsio->kern_data_resid = 0;
9645	ctsio->kern_rel_offset = 0;
9646	ctsio->kern_sg_entries = 0;
9647
9648	/*
9649	 * If we don't have a LUN, we don't have any pending sense.
9650	 */
9651	if (lun == NULL)
9652		goto no_sense;
9653
9654	have_error = 0;
9655	initidx = ctl_get_initindex(&ctsio->io_hdr.nexus);
9656	/*
9657	 * Check for pending sense, and then for pending unit attentions.
9658	 * Pending sense gets returned first, then pending unit attentions.
9659	 */
9660	mtx_lock(&lun->lun_lock);
9661#ifdef CTL_WITH_CA
9662	if (ctl_is_set(lun->have_ca, initidx)) {
9663		scsi_sense_data_type stored_format;
9664
9665		/*
9666		 * Check to see which sense format was used for the stored
9667		 * sense data.
9668		 */
9669		stored_format = scsi_sense_type(&lun->pending_sense[initidx]);
9670
9671		/*
9672		 * If the user requested a different sense format than the
9673		 * one we stored, then we need to convert it to the other
9674		 * format.  If we're going from descriptor to fixed format
9675		 * sense data, we may lose things in translation, depending
9676		 * on what options were used.
9677		 *
9678		 * If the stored format is SSD_TYPE_NONE (i.e. invalid),
9679		 * for some reason we'll just copy it out as-is.
9680		 */
9681		if ((stored_format == SSD_TYPE_FIXED)
9682		 && (sense_format == SSD_TYPE_DESC))
9683			ctl_sense_to_desc((struct scsi_sense_data_fixed *)
9684			    &lun->pending_sense[initidx],
9685			    (struct scsi_sense_data_desc *)sense_ptr);
9686		else if ((stored_format == SSD_TYPE_DESC)
9687		      && (sense_format == SSD_TYPE_FIXED))
9688			ctl_sense_to_fixed((struct scsi_sense_data_desc *)
9689			    &lun->pending_sense[initidx],
9690			    (struct scsi_sense_data_fixed *)sense_ptr);
9691		else
9692			memcpy(sense_ptr, &lun->pending_sense[initidx],
9693			       ctl_min(sizeof(*sense_ptr),
9694			       sizeof(lun->pending_sense[initidx])));
9695
9696		ctl_clear_mask(lun->have_ca, initidx);
9697		have_error = 1;
9698	} else
9699#endif
9700	if (lun->pending_ua[initidx] != CTL_UA_NONE) {
9701		ctl_ua_type ua_type;
9702
9703		ua_type = ctl_build_ua(lun->pending_ua[initidx],
9704				       sense_ptr, sense_format);
9705		if (ua_type != CTL_UA_NONE) {
9706			have_error = 1;
9707			/* We're reporting this UA, so clear it */
9708			lun->pending_ua[initidx] &= ~ua_type;
9709		}
9710	}
9711	mtx_unlock(&lun->lun_lock);
9712
9713	/*
9714	 * We already have a pending error, return it.
9715	 */
9716	if (have_error != 0) {
9717		/*
9718		 * We report the SCSI status as OK, since the status of the
9719		 * request sense command itself is OK.
9720		 */
9721		ctsio->scsi_status = SCSI_STATUS_OK;
9722
9723		/*
9724		 * We report 0 for the sense length, because we aren't doing
9725		 * autosense in this case.  We're reporting sense as
9726		 * parameter data.
9727		 */
9728		ctsio->sense_len = 0;
9729		ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
9730		ctsio->be_move_done = ctl_config_move_done;
9731		ctl_datamove((union ctl_io *)ctsio);
9732
9733		return (CTL_RETVAL_COMPLETE);
9734	}
9735
9736no_sense:
9737
9738	/*
9739	 * No sense information to report, so we report that everything is
9740	 * okay.
9741	 */
9742	ctl_set_sense_data(sense_ptr,
9743			   lun,
9744			   sense_format,
9745			   /*current_error*/ 1,
9746			   /*sense_key*/ SSD_KEY_NO_SENSE,
9747			   /*asc*/ 0x00,
9748			   /*ascq*/ 0x00,
9749			   SSD_ELEM_NONE);
9750
9751	ctsio->scsi_status = SCSI_STATUS_OK;
9752
9753	/*
9754	 * We report 0 for the sense length, because we aren't doing
9755	 * autosense in this case.  We're reporting sense as parameter data.
9756	 */
9757	ctsio->sense_len = 0;
9758	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
9759	ctsio->be_move_done = ctl_config_move_done;
9760	ctl_datamove((union ctl_io *)ctsio);
9761
9762	return (CTL_RETVAL_COMPLETE);
9763}
9764
9765int
9766ctl_tur(struct ctl_scsiio *ctsio)
9767{
9768	struct ctl_lun *lun;
9769
9770	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
9771
9772	CTL_DEBUG_PRINT(("ctl_tur\n"));
9773
9774	if (lun == NULL)
9775		return (EINVAL);
9776
9777	ctsio->scsi_status = SCSI_STATUS_OK;
9778	ctsio->io_hdr.status = CTL_SUCCESS;
9779
9780	ctl_done((union ctl_io *)ctsio);
9781
9782	return (CTL_RETVAL_COMPLETE);
9783}
9784
9785#ifdef notyet
9786static int
9787ctl_cmddt_inquiry(struct ctl_scsiio *ctsio)
9788{
9789
9790}
9791#endif
9792
9793static int
9794ctl_inquiry_evpd_supported(struct ctl_scsiio *ctsio, int alloc_len)
9795{
9796	struct scsi_vpd_supported_pages *pages;
9797	int sup_page_size;
9798	struct ctl_lun *lun;
9799
9800	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
9801
9802	sup_page_size = sizeof(struct scsi_vpd_supported_pages) *
9803	    SCSI_EVPD_NUM_SUPPORTED_PAGES;
9804	ctsio->kern_data_ptr = malloc(sup_page_size, M_CTL, M_WAITOK | M_ZERO);
9805	pages = (struct scsi_vpd_supported_pages *)ctsio->kern_data_ptr;
9806	ctsio->kern_sg_entries = 0;
9807
9808	if (sup_page_size < alloc_len) {
9809		ctsio->residual = alloc_len - sup_page_size;
9810		ctsio->kern_data_len = sup_page_size;
9811		ctsio->kern_total_len = sup_page_size;
9812	} else {
9813		ctsio->residual = 0;
9814		ctsio->kern_data_len = alloc_len;
9815		ctsio->kern_total_len = alloc_len;
9816	}
9817	ctsio->kern_data_resid = 0;
9818	ctsio->kern_rel_offset = 0;
9819	ctsio->kern_sg_entries = 0;
9820
9821	/*
9822	 * The control device is always connected.  The disk device, on the
9823	 * other hand, may not be online all the time.  Need to change this
9824	 * to figure out whether the disk device is actually online or not.
9825	 */
9826	if (lun != NULL)
9827		pages->device = (SID_QUAL_LU_CONNECTED << 5) |
9828				lun->be_lun->lun_type;
9829	else
9830		pages->device = (SID_QUAL_LU_OFFLINE << 5) | T_DIRECT;
9831
9832	pages->length = SCSI_EVPD_NUM_SUPPORTED_PAGES;
9833	/* Supported VPD pages */
9834	pages->page_list[0] = SVPD_SUPPORTED_PAGES;
9835	/* Serial Number */
9836	pages->page_list[1] = SVPD_UNIT_SERIAL_NUMBER;
9837	/* Device Identification */
9838	pages->page_list[2] = SVPD_DEVICE_ID;
9839	/* Mode Page Policy */
9840	pages->page_list[3] = SVPD_MODE_PAGE_POLICY;
9841	/* SCSI Ports */
9842	pages->page_list[4] = SVPD_SCSI_PORTS;
9843	/* Third-party Copy */
9844	pages->page_list[5] = SVPD_SCSI_TPC;
9845	/* Block limits */
9846	pages->page_list[6] = SVPD_BLOCK_LIMITS;
9847	/* Block Device Characteristics */
9848	pages->page_list[7] = SVPD_BDC;
9849	/* Logical Block Provisioning */
9850	pages->page_list[8] = SVPD_LBP;
9851
9852	ctsio->scsi_status = SCSI_STATUS_OK;
9853
9854	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
9855	ctsio->be_move_done = ctl_config_move_done;
9856	ctl_datamove((union ctl_io *)ctsio);
9857
9858	return (CTL_RETVAL_COMPLETE);
9859}
9860
9861static int
9862ctl_inquiry_evpd_serial(struct ctl_scsiio *ctsio, int alloc_len)
9863{
9864	struct scsi_vpd_unit_serial_number *sn_ptr;
9865	struct ctl_lun *lun;
9866
9867	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
9868
9869	ctsio->kern_data_ptr = malloc(sizeof(*sn_ptr), M_CTL, M_WAITOK | M_ZERO);
9870	sn_ptr = (struct scsi_vpd_unit_serial_number *)ctsio->kern_data_ptr;
9871	ctsio->kern_sg_entries = 0;
9872
9873	if (sizeof(*sn_ptr) < alloc_len) {
9874		ctsio->residual = alloc_len - sizeof(*sn_ptr);
9875		ctsio->kern_data_len = sizeof(*sn_ptr);
9876		ctsio->kern_total_len = sizeof(*sn_ptr);
9877	} else {
9878		ctsio->residual = 0;
9879		ctsio->kern_data_len = alloc_len;
9880		ctsio->kern_total_len = alloc_len;
9881	}
9882	ctsio->kern_data_resid = 0;
9883	ctsio->kern_rel_offset = 0;
9884	ctsio->kern_sg_entries = 0;
9885
9886	/*
9887	 * The control device is always connected.  The disk device, on the
9888	 * other hand, may not be online all the time.  Need to change this
9889	 * to figure out whether the disk device is actually online or not.
9890	 */
9891	if (lun != NULL)
9892		sn_ptr->device = (SID_QUAL_LU_CONNECTED << 5) |
9893				  lun->be_lun->lun_type;
9894	else
9895		sn_ptr->device = (SID_QUAL_LU_OFFLINE << 5) | T_DIRECT;
9896
9897	sn_ptr->page_code = SVPD_UNIT_SERIAL_NUMBER;
9898	sn_ptr->length = ctl_min(sizeof(*sn_ptr) - 4, CTL_SN_LEN);
9899	/*
9900	 * If we don't have a LUN, we just leave the serial number as
9901	 * all spaces.
9902	 */
9903	memset(sn_ptr->serial_num, 0x20, sizeof(sn_ptr->serial_num));
9904	if (lun != NULL) {
9905		strncpy((char *)sn_ptr->serial_num,
9906			(char *)lun->be_lun->serial_num, CTL_SN_LEN);
9907	}
9908	ctsio->scsi_status = SCSI_STATUS_OK;
9909
9910	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
9911	ctsio->be_move_done = ctl_config_move_done;
9912	ctl_datamove((union ctl_io *)ctsio);
9913
9914	return (CTL_RETVAL_COMPLETE);
9915}
9916
9917
9918static int
9919ctl_inquiry_evpd_mpp(struct ctl_scsiio *ctsio, int alloc_len)
9920{
9921	struct scsi_vpd_mode_page_policy *mpp_ptr;
9922	struct ctl_lun *lun;
9923	int data_len;
9924
9925	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
9926
9927	data_len = sizeof(struct scsi_vpd_mode_page_policy) +
9928	    sizeof(struct scsi_vpd_mode_page_policy_descr);
9929
9930	ctsio->kern_data_ptr = malloc(data_len, M_CTL, M_WAITOK | M_ZERO);
9931	mpp_ptr = (struct scsi_vpd_mode_page_policy *)ctsio->kern_data_ptr;
9932	ctsio->kern_sg_entries = 0;
9933
9934	if (data_len < alloc_len) {
9935		ctsio->residual = alloc_len - data_len;
9936		ctsio->kern_data_len = data_len;
9937		ctsio->kern_total_len = data_len;
9938	} else {
9939		ctsio->residual = 0;
9940		ctsio->kern_data_len = alloc_len;
9941		ctsio->kern_total_len = alloc_len;
9942	}
9943	ctsio->kern_data_resid = 0;
9944	ctsio->kern_rel_offset = 0;
9945	ctsio->kern_sg_entries = 0;
9946
9947	/*
9948	 * The control device is always connected.  The disk device, on the
9949	 * other hand, may not be online all the time.
9950	 */
9951	if (lun != NULL)
9952		mpp_ptr->device = (SID_QUAL_LU_CONNECTED << 5) |
9953				     lun->be_lun->lun_type;
9954	else
9955		mpp_ptr->device = (SID_QUAL_LU_OFFLINE << 5) | T_DIRECT;
9956	mpp_ptr->page_code = SVPD_MODE_PAGE_POLICY;
9957	scsi_ulto2b(data_len - 4, mpp_ptr->page_length);
9958	mpp_ptr->descr[0].page_code = 0x3f;
9959	mpp_ptr->descr[0].subpage_code = 0xff;
9960	mpp_ptr->descr[0].policy = SVPD_MPP_SHARED;
9961
9962	ctsio->scsi_status = SCSI_STATUS_OK;
9963	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
9964	ctsio->be_move_done = ctl_config_move_done;
9965	ctl_datamove((union ctl_io *)ctsio);
9966
9967	return (CTL_RETVAL_COMPLETE);
9968}
9969
9970static int
9971ctl_inquiry_evpd_devid(struct ctl_scsiio *ctsio, int alloc_len)
9972{
9973	struct scsi_vpd_device_id *devid_ptr;
9974	struct scsi_vpd_id_descriptor *desc;
9975	struct ctl_softc *ctl_softc;
9976	struct ctl_lun *lun;
9977	struct ctl_port *port;
9978	int data_len;
9979	uint8_t proto;
9980
9981	ctl_softc = control_softc;
9982
9983	port = ctl_softc->ctl_ports[ctl_port_idx(ctsio->io_hdr.nexus.targ_port)];
9984	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
9985
9986	data_len = sizeof(struct scsi_vpd_device_id) +
9987	    sizeof(struct scsi_vpd_id_descriptor) +
9988		sizeof(struct scsi_vpd_id_rel_trgt_port_id) +
9989	    sizeof(struct scsi_vpd_id_descriptor) +
9990		sizeof(struct scsi_vpd_id_trgt_port_grp_id);
9991	if (lun && lun->lun_devid)
9992		data_len += lun->lun_devid->len;
9993	if (port->port_devid)
9994		data_len += port->port_devid->len;
9995	if (port->target_devid)
9996		data_len += port->target_devid->len;
9997
9998	ctsio->kern_data_ptr = malloc(data_len, M_CTL, M_WAITOK | M_ZERO);
9999	devid_ptr = (struct scsi_vpd_device_id *)ctsio->kern_data_ptr;
10000	ctsio->kern_sg_entries = 0;
10001
10002	if (data_len < alloc_len) {
10003		ctsio->residual = alloc_len - data_len;
10004		ctsio->kern_data_len = data_len;
10005		ctsio->kern_total_len = data_len;
10006	} else {
10007		ctsio->residual = 0;
10008		ctsio->kern_data_len = alloc_len;
10009		ctsio->kern_total_len = alloc_len;
10010	}
10011	ctsio->kern_data_resid = 0;
10012	ctsio->kern_rel_offset = 0;
10013	ctsio->kern_sg_entries = 0;
10014
10015	/*
10016	 * The control device is always connected.  The disk device, on the
10017	 * other hand, may not be online all the time.
10018	 */
10019	if (lun != NULL)
10020		devid_ptr->device = (SID_QUAL_LU_CONNECTED << 5) |
10021				     lun->be_lun->lun_type;
10022	else
10023		devid_ptr->device = (SID_QUAL_LU_OFFLINE << 5) | T_DIRECT;
10024	devid_ptr->page_code = SVPD_DEVICE_ID;
10025	scsi_ulto2b(data_len - 4, devid_ptr->length);
10026
10027	if (port->port_type == CTL_PORT_FC)
10028		proto = SCSI_PROTO_FC << 4;
10029	else if (port->port_type == CTL_PORT_ISCSI)
10030		proto = SCSI_PROTO_ISCSI << 4;
10031	else
10032		proto = SCSI_PROTO_SPI << 4;
10033	desc = (struct scsi_vpd_id_descriptor *)devid_ptr->desc_list;
10034
10035	/*
10036	 * We're using a LUN association here.  i.e., this device ID is a
10037	 * per-LUN identifier.
10038	 */
10039	if (lun && lun->lun_devid) {
10040		memcpy(desc, lun->lun_devid->data, lun->lun_devid->len);
10041		desc = (struct scsi_vpd_id_descriptor *)((uint8_t *)desc +
10042		    lun->lun_devid->len);
10043	}
10044
10045	/*
10046	 * This is for the WWPN which is a port association.
10047	 */
10048	if (port->port_devid) {
10049		memcpy(desc, port->port_devid->data, port->port_devid->len);
10050		desc = (struct scsi_vpd_id_descriptor *)((uint8_t *)desc +
10051		    port->port_devid->len);
10052	}
10053
10054	/*
10055	 * This is for the Relative Target Port(type 4h) identifier
10056	 */
10057	desc->proto_codeset = proto | SVPD_ID_CODESET_BINARY;
10058	desc->id_type = SVPD_ID_PIV | SVPD_ID_ASSOC_PORT |
10059	    SVPD_ID_TYPE_RELTARG;
10060	desc->length = 4;
10061	scsi_ulto2b(ctsio->io_hdr.nexus.targ_port, &desc->identifier[2]);
10062	desc = (struct scsi_vpd_id_descriptor *)(&desc->identifier[0] +
10063	    sizeof(struct scsi_vpd_id_rel_trgt_port_id));
10064
10065	/*
10066	 * This is for the Target Port Group(type 5h) identifier
10067	 */
10068	desc->proto_codeset = proto | SVPD_ID_CODESET_BINARY;
10069	desc->id_type = SVPD_ID_PIV | SVPD_ID_ASSOC_PORT |
10070	    SVPD_ID_TYPE_TPORTGRP;
10071	desc->length = 4;
10072	scsi_ulto2b(ctsio->io_hdr.nexus.targ_port / CTL_MAX_PORTS + 1,
10073	    &desc->identifier[2]);
10074	desc = (struct scsi_vpd_id_descriptor *)(&desc->identifier[0] +
10075	    sizeof(struct scsi_vpd_id_trgt_port_grp_id));
10076
10077	/*
10078	 * This is for the Target identifier
10079	 */
10080	if (port->target_devid) {
10081		memcpy(desc, port->target_devid->data, port->target_devid->len);
10082	}
10083
10084	ctsio->scsi_status = SCSI_STATUS_OK;
10085	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
10086	ctsio->be_move_done = ctl_config_move_done;
10087	ctl_datamove((union ctl_io *)ctsio);
10088
10089	return (CTL_RETVAL_COMPLETE);
10090}
10091
10092static int
10093ctl_inquiry_evpd_scsi_ports(struct ctl_scsiio *ctsio, int alloc_len)
10094{
10095	struct ctl_softc *softc = control_softc;
10096	struct scsi_vpd_scsi_ports *sp;
10097	struct scsi_vpd_port_designation *pd;
10098	struct scsi_vpd_port_designation_cont *pdc;
10099	struct ctl_lun *lun;
10100	struct ctl_port *port;
10101	int data_len, num_target_ports, iid_len, id_len, g, pg, p;
10102	int num_target_port_groups, single;
10103
10104	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
10105
10106	single = ctl_is_single;
10107	if (single)
10108		num_target_port_groups = 1;
10109	else
10110		num_target_port_groups = NUM_TARGET_PORT_GROUPS;
10111	num_target_ports = 0;
10112	iid_len = 0;
10113	id_len = 0;
10114	mtx_lock(&softc->ctl_lock);
10115	STAILQ_FOREACH(port, &softc->port_list, links) {
10116		if ((port->status & CTL_PORT_STATUS_ONLINE) == 0)
10117			continue;
10118		if (lun != NULL &&
10119		    ctl_map_lun_back(port->targ_port, lun->lun) >=
10120		    CTL_MAX_LUNS)
10121			continue;
10122		num_target_ports++;
10123		if (port->init_devid)
10124			iid_len += port->init_devid->len;
10125		if (port->port_devid)
10126			id_len += port->port_devid->len;
10127	}
10128	mtx_unlock(&softc->ctl_lock);
10129
10130	data_len = sizeof(struct scsi_vpd_scsi_ports) + num_target_port_groups *
10131	    num_target_ports * (sizeof(struct scsi_vpd_port_designation) +
10132	     sizeof(struct scsi_vpd_port_designation_cont)) + iid_len + id_len;
10133	ctsio->kern_data_ptr = malloc(data_len, M_CTL, M_WAITOK | M_ZERO);
10134	sp = (struct scsi_vpd_scsi_ports *)ctsio->kern_data_ptr;
10135	ctsio->kern_sg_entries = 0;
10136
10137	if (data_len < alloc_len) {
10138		ctsio->residual = alloc_len - data_len;
10139		ctsio->kern_data_len = data_len;
10140		ctsio->kern_total_len = data_len;
10141	} else {
10142		ctsio->residual = 0;
10143		ctsio->kern_data_len = alloc_len;
10144		ctsio->kern_total_len = alloc_len;
10145	}
10146	ctsio->kern_data_resid = 0;
10147	ctsio->kern_rel_offset = 0;
10148	ctsio->kern_sg_entries = 0;
10149
10150	/*
10151	 * The control device is always connected.  The disk device, on the
10152	 * other hand, may not be online all the time.  Need to change this
10153	 * to figure out whether the disk device is actually online or not.
10154	 */
10155	if (lun != NULL)
10156		sp->device = (SID_QUAL_LU_CONNECTED << 5) |
10157				  lun->be_lun->lun_type;
10158	else
10159		sp->device = (SID_QUAL_LU_OFFLINE << 5) | T_DIRECT;
10160
10161	sp->page_code = SVPD_SCSI_PORTS;
10162	scsi_ulto2b(data_len - sizeof(struct scsi_vpd_scsi_ports),
10163	    sp->page_length);
10164	pd = &sp->design[0];
10165
10166	mtx_lock(&softc->ctl_lock);
10167	if (softc->flags & CTL_FLAG_MASTER_SHELF)
10168		pg = 0;
10169	else
10170		pg = 1;
10171	for (g = 0; g < num_target_port_groups; g++) {
10172		STAILQ_FOREACH(port, &softc->port_list, links) {
10173			if ((port->status & CTL_PORT_STATUS_ONLINE) == 0)
10174				continue;
10175			if (lun != NULL &&
10176			    ctl_map_lun_back(port->targ_port, lun->lun) >=
10177			    CTL_MAX_LUNS)
10178				continue;
10179			p = port->targ_port % CTL_MAX_PORTS + g * CTL_MAX_PORTS;
10180			scsi_ulto2b(p, pd->relative_port_id);
10181			if (port->init_devid && g == pg) {
10182				iid_len = port->init_devid->len;
10183				memcpy(pd->initiator_transportid,
10184				    port->init_devid->data, port->init_devid->len);
10185			} else
10186				iid_len = 0;
10187			scsi_ulto2b(iid_len, pd->initiator_transportid_length);
10188			pdc = (struct scsi_vpd_port_designation_cont *)
10189			    (&pd->initiator_transportid[iid_len]);
10190			if (port->port_devid && g == pg) {
10191				id_len = port->port_devid->len;
10192				memcpy(pdc->target_port_descriptors,
10193				    port->port_devid->data, port->port_devid->len);
10194			} else
10195				id_len = 0;
10196			scsi_ulto2b(id_len, pdc->target_port_descriptors_length);
10197			pd = (struct scsi_vpd_port_designation *)
10198			    ((uint8_t *)pdc->target_port_descriptors + id_len);
10199		}
10200	}
10201	mtx_unlock(&softc->ctl_lock);
10202
10203	ctsio->scsi_status = SCSI_STATUS_OK;
10204	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
10205	ctsio->be_move_done = ctl_config_move_done;
10206	ctl_datamove((union ctl_io *)ctsio);
10207
10208	return (CTL_RETVAL_COMPLETE);
10209}
10210
10211static int
10212ctl_inquiry_evpd_block_limits(struct ctl_scsiio *ctsio, int alloc_len)
10213{
10214	struct scsi_vpd_block_limits *bl_ptr;
10215	struct ctl_lun *lun;
10216	int bs;
10217
10218	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
10219
10220	ctsio->kern_data_ptr = malloc(sizeof(*bl_ptr), M_CTL, M_WAITOK | M_ZERO);
10221	bl_ptr = (struct scsi_vpd_block_limits *)ctsio->kern_data_ptr;
10222	ctsio->kern_sg_entries = 0;
10223
10224	if (sizeof(*bl_ptr) < alloc_len) {
10225		ctsio->residual = alloc_len - sizeof(*bl_ptr);
10226		ctsio->kern_data_len = sizeof(*bl_ptr);
10227		ctsio->kern_total_len = sizeof(*bl_ptr);
10228	} else {
10229		ctsio->residual = 0;
10230		ctsio->kern_data_len = alloc_len;
10231		ctsio->kern_total_len = alloc_len;
10232	}
10233	ctsio->kern_data_resid = 0;
10234	ctsio->kern_rel_offset = 0;
10235	ctsio->kern_sg_entries = 0;
10236
10237	/*
10238	 * The control device is always connected.  The disk device, on the
10239	 * other hand, may not be online all the time.  Need to change this
10240	 * to figure out whether the disk device is actually online or not.
10241	 */
10242	if (lun != NULL)
10243		bl_ptr->device = (SID_QUAL_LU_CONNECTED << 5) |
10244				  lun->be_lun->lun_type;
10245	else
10246		bl_ptr->device = (SID_QUAL_LU_OFFLINE << 5) | T_DIRECT;
10247
10248	bl_ptr->page_code = SVPD_BLOCK_LIMITS;
10249	scsi_ulto2b(sizeof(*bl_ptr), bl_ptr->page_length);
10250	bl_ptr->max_cmp_write_len = 0xff;
10251	scsi_ulto4b(0xffffffff, bl_ptr->max_txfer_len);
10252	if (lun != NULL) {
10253		bs = lun->be_lun->blocksize;
10254		scsi_ulto4b(MAXPHYS / bs, bl_ptr->opt_txfer_len);
10255		if (lun->be_lun->flags & CTL_LUN_FLAG_UNMAP) {
10256			scsi_ulto4b(0xffffffff, bl_ptr->max_unmap_lba_cnt);
10257			scsi_ulto4b(0xffffffff, bl_ptr->max_unmap_blk_cnt);
10258			if (lun->be_lun->pblockexp != 0) {
10259				scsi_ulto4b((1 << lun->be_lun->pblockexp),
10260				    bl_ptr->opt_unmap_grain);
10261				scsi_ulto4b(0x80000000 | lun->be_lun->pblockoff,
10262				    bl_ptr->unmap_grain_align);
10263			}
10264		}
10265	}
10266	scsi_u64to8b(UINT64_MAX, bl_ptr->max_write_same_length);
10267
10268	ctsio->scsi_status = SCSI_STATUS_OK;
10269	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
10270	ctsio->be_move_done = ctl_config_move_done;
10271	ctl_datamove((union ctl_io *)ctsio);
10272
10273	return (CTL_RETVAL_COMPLETE);
10274}
10275
10276static int
10277ctl_inquiry_evpd_bdc(struct ctl_scsiio *ctsio, int alloc_len)
10278{
10279	struct scsi_vpd_block_device_characteristics *bdc_ptr;
10280	struct ctl_lun *lun;
10281
10282	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
10283
10284	ctsio->kern_data_ptr = malloc(sizeof(*bdc_ptr), M_CTL, M_WAITOK | M_ZERO);
10285	bdc_ptr = (struct scsi_vpd_block_device_characteristics *)ctsio->kern_data_ptr;
10286	ctsio->kern_sg_entries = 0;
10287
10288	if (sizeof(*bdc_ptr) < alloc_len) {
10289		ctsio->residual = alloc_len - sizeof(*bdc_ptr);
10290		ctsio->kern_data_len = sizeof(*bdc_ptr);
10291		ctsio->kern_total_len = sizeof(*bdc_ptr);
10292	} else {
10293		ctsio->residual = 0;
10294		ctsio->kern_data_len = alloc_len;
10295		ctsio->kern_total_len = alloc_len;
10296	}
10297	ctsio->kern_data_resid = 0;
10298	ctsio->kern_rel_offset = 0;
10299	ctsio->kern_sg_entries = 0;
10300
10301	/*
10302	 * The control device is always connected.  The disk device, on the
10303	 * other hand, may not be online all the time.  Need to change this
10304	 * to figure out whether the disk device is actually online or not.
10305	 */
10306	if (lun != NULL)
10307		bdc_ptr->device = (SID_QUAL_LU_CONNECTED << 5) |
10308				  lun->be_lun->lun_type;
10309	else
10310		bdc_ptr->device = (SID_QUAL_LU_OFFLINE << 5) | T_DIRECT;
10311	bdc_ptr->page_code = SVPD_BDC;
10312	scsi_ulto2b(sizeof(*bdc_ptr) - 4, bdc_ptr->page_length);
10313	scsi_ulto2b(SVPD_NON_ROTATING, bdc_ptr->medium_rotation_rate);
10314	bdc_ptr->flags = SVPD_FUAB | SVPD_VBULS;
10315
10316	ctsio->scsi_status = SCSI_STATUS_OK;
10317	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
10318	ctsio->be_move_done = ctl_config_move_done;
10319	ctl_datamove((union ctl_io *)ctsio);
10320
10321	return (CTL_RETVAL_COMPLETE);
10322}
10323
10324static int
10325ctl_inquiry_evpd_lbp(struct ctl_scsiio *ctsio, int alloc_len)
10326{
10327	struct scsi_vpd_logical_block_prov *lbp_ptr;
10328	struct ctl_lun *lun;
10329
10330	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
10331
10332	ctsio->kern_data_ptr = malloc(sizeof(*lbp_ptr), M_CTL, M_WAITOK | M_ZERO);
10333	lbp_ptr = (struct scsi_vpd_logical_block_prov *)ctsio->kern_data_ptr;
10334	ctsio->kern_sg_entries = 0;
10335
10336	if (sizeof(*lbp_ptr) < alloc_len) {
10337		ctsio->residual = alloc_len - sizeof(*lbp_ptr);
10338		ctsio->kern_data_len = sizeof(*lbp_ptr);
10339		ctsio->kern_total_len = sizeof(*lbp_ptr);
10340	} else {
10341		ctsio->residual = 0;
10342		ctsio->kern_data_len = alloc_len;
10343		ctsio->kern_total_len = alloc_len;
10344	}
10345	ctsio->kern_data_resid = 0;
10346	ctsio->kern_rel_offset = 0;
10347	ctsio->kern_sg_entries = 0;
10348
10349	/*
10350	 * The control device is always connected.  The disk device, on the
10351	 * other hand, may not be online all the time.  Need to change this
10352	 * to figure out whether the disk device is actually online or not.
10353	 */
10354	if (lun != NULL)
10355		lbp_ptr->device = (SID_QUAL_LU_CONNECTED << 5) |
10356				  lun->be_lun->lun_type;
10357	else
10358		lbp_ptr->device = (SID_QUAL_LU_OFFLINE << 5) | T_DIRECT;
10359
10360	lbp_ptr->page_code = SVPD_LBP;
10361	scsi_ulto2b(sizeof(*lbp_ptr) - 4, lbp_ptr->page_length);
10362	if (lun != NULL && lun->be_lun->flags & CTL_LUN_FLAG_UNMAP) {
10363		lbp_ptr->flags = SVPD_LBP_UNMAP | SVPD_LBP_WS16 |
10364		    SVPD_LBP_WS10 | SVPD_LBP_RZ | SVPD_LBP_ANC_SUP;
10365		lbp_ptr->prov_type = SVPD_LBP_RESOURCE;
10366	}
10367
10368	ctsio->scsi_status = SCSI_STATUS_OK;
10369	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
10370	ctsio->be_move_done = ctl_config_move_done;
10371	ctl_datamove((union ctl_io *)ctsio);
10372
10373	return (CTL_RETVAL_COMPLETE);
10374}
10375
10376static int
10377ctl_inquiry_evpd(struct ctl_scsiio *ctsio)
10378{
10379	struct scsi_inquiry *cdb;
10380	struct ctl_lun *lun;
10381	int alloc_len, retval;
10382
10383	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
10384	cdb = (struct scsi_inquiry *)ctsio->cdb;
10385
10386	retval = CTL_RETVAL_COMPLETE;
10387
10388	alloc_len = scsi_2btoul(cdb->length);
10389
10390	switch (cdb->page_code) {
10391	case SVPD_SUPPORTED_PAGES:
10392		retval = ctl_inquiry_evpd_supported(ctsio, alloc_len);
10393		break;
10394	case SVPD_UNIT_SERIAL_NUMBER:
10395		retval = ctl_inquiry_evpd_serial(ctsio, alloc_len);
10396		break;
10397	case SVPD_DEVICE_ID:
10398		retval = ctl_inquiry_evpd_devid(ctsio, alloc_len);
10399		break;
10400	case SVPD_MODE_PAGE_POLICY:
10401		retval = ctl_inquiry_evpd_mpp(ctsio, alloc_len);
10402		break;
10403	case SVPD_SCSI_PORTS:
10404		retval = ctl_inquiry_evpd_scsi_ports(ctsio, alloc_len);
10405		break;
10406	case SVPD_SCSI_TPC:
10407		retval = ctl_inquiry_evpd_tpc(ctsio, alloc_len);
10408		break;
10409	case SVPD_BLOCK_LIMITS:
10410		retval = ctl_inquiry_evpd_block_limits(ctsio, alloc_len);
10411		break;
10412	case SVPD_BDC:
10413		retval = ctl_inquiry_evpd_bdc(ctsio, alloc_len);
10414		break;
10415	case SVPD_LBP:
10416		retval = ctl_inquiry_evpd_lbp(ctsio, alloc_len);
10417		break;
10418	default:
10419		ctl_set_invalid_field(ctsio,
10420				      /*sks_valid*/ 1,
10421				      /*command*/ 1,
10422				      /*field*/ 2,
10423				      /*bit_valid*/ 0,
10424				      /*bit*/ 0);
10425		ctl_done((union ctl_io *)ctsio);
10426		retval = CTL_RETVAL_COMPLETE;
10427		break;
10428	}
10429
10430	return (retval);
10431}
10432
10433static int
10434ctl_inquiry_std(struct ctl_scsiio *ctsio)
10435{
10436	struct scsi_inquiry_data *inq_ptr;
10437	struct scsi_inquiry *cdb;
10438	struct ctl_softc *ctl_softc;
10439	struct ctl_lun *lun;
10440	char *val;
10441	uint32_t alloc_len;
10442	ctl_port_type port_type;
10443
10444	ctl_softc = control_softc;
10445
10446	/*
10447	 * Figure out whether we're talking to a Fibre Channel port or not.
10448	 * We treat the ioctl front end, and any SCSI adapters, as packetized
10449	 * SCSI front ends.
10450	 */
10451	port_type = ctl_softc->ctl_ports[
10452	    ctl_port_idx(ctsio->io_hdr.nexus.targ_port)]->port_type;
10453	if (port_type == CTL_PORT_IOCTL || port_type == CTL_PORT_INTERNAL)
10454		port_type = CTL_PORT_SCSI;
10455
10456	lun = ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
10457	cdb = (struct scsi_inquiry *)ctsio->cdb;
10458	alloc_len = scsi_2btoul(cdb->length);
10459
10460	/*
10461	 * We malloc the full inquiry data size here and fill it
10462	 * in.  If the user only asks for less, we'll give him
10463	 * that much.
10464	 */
10465	ctsio->kern_data_ptr = malloc(sizeof(*inq_ptr), M_CTL, M_WAITOK | M_ZERO);
10466	inq_ptr = (struct scsi_inquiry_data *)ctsio->kern_data_ptr;
10467	ctsio->kern_sg_entries = 0;
10468	ctsio->kern_data_resid = 0;
10469	ctsio->kern_rel_offset = 0;
10470
10471	if (sizeof(*inq_ptr) < alloc_len) {
10472		ctsio->residual = alloc_len - sizeof(*inq_ptr);
10473		ctsio->kern_data_len = sizeof(*inq_ptr);
10474		ctsio->kern_total_len = sizeof(*inq_ptr);
10475	} else {
10476		ctsio->residual = 0;
10477		ctsio->kern_data_len = alloc_len;
10478		ctsio->kern_total_len = alloc_len;
10479	}
10480
10481	/*
10482	 * If we have a LUN configured, report it as connected.  Otherwise,
10483	 * report that it is offline or no device is supported, depending
10484	 * on the value of inquiry_pq_no_lun.
10485	 *
10486	 * According to the spec (SPC-4 r34), the peripheral qualifier
10487	 * SID_QUAL_LU_OFFLINE (001b) is used in the following scenario:
10488	 *
10489	 * "A peripheral device having the specified peripheral device type
10490	 * is not connected to this logical unit. However, the device
10491	 * server is capable of supporting the specified peripheral device
10492	 * type on this logical unit."
10493	 *
10494	 * According to the same spec, the peripheral qualifier
10495	 * SID_QUAL_BAD_LU (011b) is used in this scenario:
10496	 *
10497	 * "The device server is not capable of supporting a peripheral
10498	 * device on this logical unit. For this peripheral qualifier the
10499	 * peripheral device type shall be set to 1Fh. All other peripheral
10500	 * device type values are reserved for this peripheral qualifier."
10501	 *
10502	 * Given the text, it would seem that we probably want to report that
10503	 * the LUN is offline here.  There is no LUN connected, but we can
10504	 * support a LUN at the given LUN number.
10505	 *
10506	 * In the real world, though, it sounds like things are a little
10507	 * different:
10508	 *
10509	 * - Linux, when presented with a LUN with the offline peripheral
10510	 *   qualifier, will create an sg driver instance for it.  So when
10511	 *   you attach it to CTL, you wind up with a ton of sg driver
10512	 *   instances.  (One for every LUN that Linux bothered to probe.)
10513	 *   Linux does this despite the fact that it issues a REPORT LUNs
10514	 *   to LUN 0 to get the inventory of supported LUNs.
10515	 *
10516	 * - There is other anecdotal evidence (from Emulex folks) about
10517	 *   arrays that use the offline peripheral qualifier for LUNs that
10518	 *   are on the "passive" path in an active/passive array.
10519	 *
10520	 * So the solution is provide a hopefully reasonable default
10521	 * (return bad/no LUN) and allow the user to change the behavior
10522	 * with a tunable/sysctl variable.
10523	 */
10524	if (lun != NULL)
10525		inq_ptr->device = (SID_QUAL_LU_CONNECTED << 5) |
10526				  lun->be_lun->lun_type;
10527	else if (ctl_softc->inquiry_pq_no_lun == 0)
10528		inq_ptr->device = (SID_QUAL_LU_OFFLINE << 5) | T_DIRECT;
10529	else
10530		inq_ptr->device = (SID_QUAL_BAD_LU << 5) | T_NODEVICE;
10531
10532	/* RMB in byte 2 is 0 */
10533	inq_ptr->version = SCSI_REV_SPC4;
10534
10535	/*
10536	 * According to SAM-3, even if a device only supports a single
10537	 * level of LUN addressing, it should still set the HISUP bit:
10538	 *
10539	 * 4.9.1 Logical unit numbers overview
10540	 *
10541	 * All logical unit number formats described in this standard are
10542	 * hierarchical in structure even when only a single level in that
10543	 * hierarchy is used. The HISUP bit shall be set to one in the
10544	 * standard INQUIRY data (see SPC-2) when any logical unit number
10545	 * format described in this standard is used.  Non-hierarchical
10546	 * formats are outside the scope of this standard.
10547	 *
10548	 * Therefore we set the HiSup bit here.
10549	 *
10550	 * The reponse format is 2, per SPC-3.
10551	 */
10552	inq_ptr->response_format = SID_HiSup | 2;
10553
10554	inq_ptr->additional_length =
10555	    offsetof(struct scsi_inquiry_data, vendor_specific1) -
10556	    (offsetof(struct scsi_inquiry_data, additional_length) + 1);
10557	CTL_DEBUG_PRINT(("additional_length = %d\n",
10558			 inq_ptr->additional_length));
10559
10560	inq_ptr->spc3_flags = SPC3_SID_3PC;
10561	if (!ctl_is_single)
10562		inq_ptr->spc3_flags |= SPC3_SID_TPGS_IMPLICIT;
10563	/* 16 bit addressing */
10564	if (port_type == CTL_PORT_SCSI)
10565		inq_ptr->spc2_flags = SPC2_SID_ADDR16;
10566	/* XXX set the SID_MultiP bit here if we're actually going to
10567	   respond on multiple ports */
10568	inq_ptr->spc2_flags |= SPC2_SID_MultiP;
10569
10570	/* 16 bit data bus, synchronous transfers */
10571	if (port_type == CTL_PORT_SCSI)
10572		inq_ptr->flags = SID_WBus16 | SID_Sync;
10573	/*
10574	 * XXX KDM do we want to support tagged queueing on the control
10575	 * device at all?
10576	 */
10577	if ((lun == NULL)
10578	 || (lun->be_lun->lun_type != T_PROCESSOR))
10579		inq_ptr->flags |= SID_CmdQue;
10580	/*
10581	 * Per SPC-3, unused bytes in ASCII strings are filled with spaces.
10582	 * We have 8 bytes for the vendor name, and 16 bytes for the device
10583	 * name and 4 bytes for the revision.
10584	 */
10585	if (lun == NULL || (val = ctl_get_opt(&lun->be_lun->options,
10586	    "vendor")) == NULL) {
10587		strcpy(inq_ptr->vendor, CTL_VENDOR);
10588	} else {
10589		memset(inq_ptr->vendor, ' ', sizeof(inq_ptr->vendor));
10590		strncpy(inq_ptr->vendor, val,
10591		    min(sizeof(inq_ptr->vendor), strlen(val)));
10592	}
10593	if (lun == NULL) {
10594		strcpy(inq_ptr->product, CTL_DIRECT_PRODUCT);
10595	} else if ((val = ctl_get_opt(&lun->be_lun->options, "product")) == NULL) {
10596		switch (lun->be_lun->lun_type) {
10597		case T_DIRECT:
10598			strcpy(inq_ptr->product, CTL_DIRECT_PRODUCT);
10599			break;
10600		case T_PROCESSOR:
10601			strcpy(inq_ptr->product, CTL_PROCESSOR_PRODUCT);
10602			break;
10603		default:
10604			strcpy(inq_ptr->product, CTL_UNKNOWN_PRODUCT);
10605			break;
10606		}
10607	} else {
10608		memset(inq_ptr->product, ' ', sizeof(inq_ptr->product));
10609		strncpy(inq_ptr->product, val,
10610		    min(sizeof(inq_ptr->product), strlen(val)));
10611	}
10612
10613	/*
10614	 * XXX make this a macro somewhere so it automatically gets
10615	 * incremented when we make changes.
10616	 */
10617	if (lun == NULL || (val = ctl_get_opt(&lun->be_lun->options,
10618	    "revision")) == NULL) {
10619		strncpy(inq_ptr->revision, "0001", sizeof(inq_ptr->revision));
10620	} else {
10621		memset(inq_ptr->revision, ' ', sizeof(inq_ptr->revision));
10622		strncpy(inq_ptr->revision, val,
10623		    min(sizeof(inq_ptr->revision), strlen(val)));
10624	}
10625
10626	/*
10627	 * For parallel SCSI, we support double transition and single
10628	 * transition clocking.  We also support QAS (Quick Arbitration
10629	 * and Selection) and Information Unit transfers on both the
10630	 * control and array devices.
10631	 */
10632	if (port_type == CTL_PORT_SCSI)
10633		inq_ptr->spi3data = SID_SPI_CLOCK_DT_ST | SID_SPI_QAS |
10634				    SID_SPI_IUS;
10635
10636	/* SAM-5 (no version claimed) */
10637	scsi_ulto2b(0x00A0, inq_ptr->version1);
10638	/* SPC-4 (no version claimed) */
10639	scsi_ulto2b(0x0460, inq_ptr->version2);
10640	if (port_type == CTL_PORT_FC) {
10641		/* FCP-2 ANSI INCITS.350:2003 */
10642		scsi_ulto2b(0x0917, inq_ptr->version3);
10643	} else if (port_type == CTL_PORT_SCSI) {
10644		/* SPI-4 ANSI INCITS.362:200x */
10645		scsi_ulto2b(0x0B56, inq_ptr->version3);
10646	} else if (port_type == CTL_PORT_ISCSI) {
10647		/* iSCSI (no version claimed) */
10648		scsi_ulto2b(0x0960, inq_ptr->version3);
10649	} else if (port_type == CTL_PORT_SAS) {
10650		/* SAS (no version claimed) */
10651		scsi_ulto2b(0x0BE0, inq_ptr->version3);
10652	}
10653
10654	if (lun == NULL) {
10655		/* SBC-3 (no version claimed) */
10656		scsi_ulto2b(0x04C0, inq_ptr->version4);
10657	} else {
10658		switch (lun->be_lun->lun_type) {
10659		case T_DIRECT:
10660			/* SBC-3 (no version claimed) */
10661			scsi_ulto2b(0x04C0, inq_ptr->version4);
10662			break;
10663		case T_PROCESSOR:
10664		default:
10665			break;
10666		}
10667	}
10668
10669	ctsio->scsi_status = SCSI_STATUS_OK;
10670	if (ctsio->kern_data_len > 0) {
10671		ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
10672		ctsio->be_move_done = ctl_config_move_done;
10673		ctl_datamove((union ctl_io *)ctsio);
10674	} else {
10675		ctsio->io_hdr.status = CTL_SUCCESS;
10676		ctl_done((union ctl_io *)ctsio);
10677	}
10678
10679	return (CTL_RETVAL_COMPLETE);
10680}
10681
10682int
10683ctl_inquiry(struct ctl_scsiio *ctsio)
10684{
10685	struct scsi_inquiry *cdb;
10686	int retval;
10687
10688	cdb = (struct scsi_inquiry *)ctsio->cdb;
10689
10690	retval = 0;
10691
10692	CTL_DEBUG_PRINT(("ctl_inquiry\n"));
10693
10694	/*
10695	 * Right now, we don't support the CmdDt inquiry information.
10696	 * This would be nice to support in the future.  When we do
10697	 * support it, we should change this test so that it checks to make
10698	 * sure SI_EVPD and SI_CMDDT aren't both set at the same time.
10699	 */
10700#ifdef notyet
10701	if (((cdb->byte2 & SI_EVPD)
10702	 && (cdb->byte2 & SI_CMDDT)))
10703#endif
10704	if (cdb->byte2 & SI_CMDDT) {
10705		/*
10706		 * Point to the SI_CMDDT bit.  We might change this
10707		 * when we support SI_CMDDT, but since both bits would be
10708		 * "wrong", this should probably just stay as-is then.
10709		 */
10710		ctl_set_invalid_field(ctsio,
10711				      /*sks_valid*/ 1,
10712				      /*command*/ 1,
10713				      /*field*/ 1,
10714				      /*bit_valid*/ 1,
10715				      /*bit*/ 1);
10716		ctl_done((union ctl_io *)ctsio);
10717		return (CTL_RETVAL_COMPLETE);
10718	}
10719	if (cdb->byte2 & SI_EVPD)
10720		retval = ctl_inquiry_evpd(ctsio);
10721#ifdef notyet
10722	else if (cdb->byte2 & SI_CMDDT)
10723		retval = ctl_inquiry_cmddt(ctsio);
10724#endif
10725	else
10726		retval = ctl_inquiry_std(ctsio);
10727
10728	return (retval);
10729}
10730
10731/*
10732 * For known CDB types, parse the LBA and length.
10733 */
10734static int
10735ctl_get_lba_len(union ctl_io *io, uint64_t *lba, uint32_t *len)
10736{
10737	if (io->io_hdr.io_type != CTL_IO_SCSI)
10738		return (1);
10739
10740	switch (io->scsiio.cdb[0]) {
10741	case COMPARE_AND_WRITE: {
10742		struct scsi_compare_and_write *cdb;
10743
10744		cdb = (struct scsi_compare_and_write *)io->scsiio.cdb;
10745
10746		*lba = scsi_8btou64(cdb->addr);
10747		*len = cdb->length;
10748		break;
10749	}
10750	case READ_6:
10751	case WRITE_6: {
10752		struct scsi_rw_6 *cdb;
10753
10754		cdb = (struct scsi_rw_6 *)io->scsiio.cdb;
10755
10756		*lba = scsi_3btoul(cdb->addr);
10757		/* only 5 bits are valid in the most significant address byte */
10758		*lba &= 0x1fffff;
10759		*len = cdb->length;
10760		break;
10761	}
10762	case READ_10:
10763	case WRITE_10: {
10764		struct scsi_rw_10 *cdb;
10765
10766		cdb = (struct scsi_rw_10 *)io->scsiio.cdb;
10767
10768		*lba = scsi_4btoul(cdb->addr);
10769		*len = scsi_2btoul(cdb->length);
10770		break;
10771	}
10772	case WRITE_VERIFY_10: {
10773		struct scsi_write_verify_10 *cdb;
10774
10775		cdb = (struct scsi_write_verify_10 *)io->scsiio.cdb;
10776
10777		*lba = scsi_4btoul(cdb->addr);
10778		*len = scsi_2btoul(cdb->length);
10779		break;
10780	}
10781	case READ_12:
10782	case WRITE_12: {
10783		struct scsi_rw_12 *cdb;
10784
10785		cdb = (struct scsi_rw_12 *)io->scsiio.cdb;
10786
10787		*lba = scsi_4btoul(cdb->addr);
10788		*len = scsi_4btoul(cdb->length);
10789		break;
10790	}
10791	case WRITE_VERIFY_12: {
10792		struct scsi_write_verify_12 *cdb;
10793
10794		cdb = (struct scsi_write_verify_12 *)io->scsiio.cdb;
10795
10796		*lba = scsi_4btoul(cdb->addr);
10797		*len = scsi_4btoul(cdb->length);
10798		break;
10799	}
10800	case READ_16:
10801	case WRITE_16: {
10802		struct scsi_rw_16 *cdb;
10803
10804		cdb = (struct scsi_rw_16 *)io->scsiio.cdb;
10805
10806		*lba = scsi_8btou64(cdb->addr);
10807		*len = scsi_4btoul(cdb->length);
10808		break;
10809	}
10810	case WRITE_VERIFY_16: {
10811		struct scsi_write_verify_16 *cdb;
10812
10813		cdb = (struct scsi_write_verify_16 *)io->scsiio.cdb;
10814
10815
10816		*lba = scsi_8btou64(cdb->addr);
10817		*len = scsi_4btoul(cdb->length);
10818		break;
10819	}
10820	case WRITE_SAME_10: {
10821		struct scsi_write_same_10 *cdb;
10822
10823		cdb = (struct scsi_write_same_10 *)io->scsiio.cdb;
10824
10825		*lba = scsi_4btoul(cdb->addr);
10826		*len = scsi_2btoul(cdb->length);
10827		break;
10828	}
10829	case WRITE_SAME_16: {
10830		struct scsi_write_same_16 *cdb;
10831
10832		cdb = (struct scsi_write_same_16 *)io->scsiio.cdb;
10833
10834		*lba = scsi_8btou64(cdb->addr);
10835		*len = scsi_4btoul(cdb->length);
10836		break;
10837	}
10838	case VERIFY_10: {
10839		struct scsi_verify_10 *cdb;
10840
10841		cdb = (struct scsi_verify_10 *)io->scsiio.cdb;
10842
10843		*lba = scsi_4btoul(cdb->addr);
10844		*len = scsi_2btoul(cdb->length);
10845		break;
10846	}
10847	case VERIFY_12: {
10848		struct scsi_verify_12 *cdb;
10849
10850		cdb = (struct scsi_verify_12 *)io->scsiio.cdb;
10851
10852		*lba = scsi_4btoul(cdb->addr);
10853		*len = scsi_4btoul(cdb->length);
10854		break;
10855	}
10856	case VERIFY_16: {
10857		struct scsi_verify_16 *cdb;
10858
10859		cdb = (struct scsi_verify_16 *)io->scsiio.cdb;
10860
10861		*lba = scsi_8btou64(cdb->addr);
10862		*len = scsi_4btoul(cdb->length);
10863		break;
10864	}
10865	default:
10866		return (1);
10867		break; /* NOTREACHED */
10868	}
10869
10870	return (0);
10871}
10872
10873static ctl_action
10874ctl_extent_check_lba(uint64_t lba1, uint32_t len1, uint64_t lba2, uint32_t len2)
10875{
10876	uint64_t endlba1, endlba2;
10877
10878	endlba1 = lba1 + len1 - 1;
10879	endlba2 = lba2 + len2 - 1;
10880
10881	if ((endlba1 < lba2)
10882	 || (endlba2 < lba1))
10883		return (CTL_ACTION_PASS);
10884	else
10885		return (CTL_ACTION_BLOCK);
10886}
10887
10888static ctl_action
10889ctl_extent_check(union ctl_io *io1, union ctl_io *io2)
10890{
10891	uint64_t lba1, lba2;
10892	uint32_t len1, len2;
10893	int retval;
10894
10895	retval = ctl_get_lba_len(io1, &lba1, &len1);
10896	if (retval != 0)
10897		return (CTL_ACTION_ERROR);
10898
10899	retval = ctl_get_lba_len(io2, &lba2, &len2);
10900	if (retval != 0)
10901		return (CTL_ACTION_ERROR);
10902
10903	return (ctl_extent_check_lba(lba1, len1, lba2, len2));
10904}
10905
10906static ctl_action
10907ctl_check_for_blockage(union ctl_io *pending_io, union ctl_io *ooa_io)
10908{
10909	const struct ctl_cmd_entry *pending_entry, *ooa_entry;
10910	ctl_serialize_action *serialize_row;
10911
10912	/*
10913	 * The initiator attempted multiple untagged commands at the same
10914	 * time.  Can't do that.
10915	 */
10916	if ((pending_io->scsiio.tag_type == CTL_TAG_UNTAGGED)
10917	 && (ooa_io->scsiio.tag_type == CTL_TAG_UNTAGGED)
10918	 && ((pending_io->io_hdr.nexus.targ_port ==
10919	      ooa_io->io_hdr.nexus.targ_port)
10920	  && (pending_io->io_hdr.nexus.initid.id ==
10921	      ooa_io->io_hdr.nexus.initid.id))
10922	 && ((ooa_io->io_hdr.flags & CTL_FLAG_ABORT) == 0))
10923		return (CTL_ACTION_OVERLAP);
10924
10925	/*
10926	 * The initiator attempted to send multiple tagged commands with
10927	 * the same ID.  (It's fine if different initiators have the same
10928	 * tag ID.)
10929	 *
10930	 * Even if all of those conditions are true, we don't kill the I/O
10931	 * if the command ahead of us has been aborted.  We won't end up
10932	 * sending it to the FETD, and it's perfectly legal to resend a
10933	 * command with the same tag number as long as the previous
10934	 * instance of this tag number has been aborted somehow.
10935	 */
10936	if ((pending_io->scsiio.tag_type != CTL_TAG_UNTAGGED)
10937	 && (ooa_io->scsiio.tag_type != CTL_TAG_UNTAGGED)
10938	 && (pending_io->scsiio.tag_num == ooa_io->scsiio.tag_num)
10939	 && ((pending_io->io_hdr.nexus.targ_port ==
10940	      ooa_io->io_hdr.nexus.targ_port)
10941	  && (pending_io->io_hdr.nexus.initid.id ==
10942	      ooa_io->io_hdr.nexus.initid.id))
10943	 && ((ooa_io->io_hdr.flags & CTL_FLAG_ABORT) == 0))
10944		return (CTL_ACTION_OVERLAP_TAG);
10945
10946	/*
10947	 * If we get a head of queue tag, SAM-3 says that we should
10948	 * immediately execute it.
10949	 *
10950	 * What happens if this command would normally block for some other
10951	 * reason?  e.g. a request sense with a head of queue tag
10952	 * immediately after a write.  Normally that would block, but this
10953	 * will result in its getting executed immediately...
10954	 *
10955	 * We currently return "pass" instead of "skip", so we'll end up
10956	 * going through the rest of the queue to check for overlapped tags.
10957	 *
10958	 * XXX KDM check for other types of blockage first??
10959	 */
10960	if (pending_io->scsiio.tag_type == CTL_TAG_HEAD_OF_QUEUE)
10961		return (CTL_ACTION_PASS);
10962
10963	/*
10964	 * Ordered tags have to block until all items ahead of them
10965	 * have completed.  If we get called with an ordered tag, we always
10966	 * block, if something else is ahead of us in the queue.
10967	 */
10968	if (pending_io->scsiio.tag_type == CTL_TAG_ORDERED)
10969		return (CTL_ACTION_BLOCK);
10970
10971	/*
10972	 * Simple tags get blocked until all head of queue and ordered tags
10973	 * ahead of them have completed.  I'm lumping untagged commands in
10974	 * with simple tags here.  XXX KDM is that the right thing to do?
10975	 */
10976	if (((pending_io->scsiio.tag_type == CTL_TAG_UNTAGGED)
10977	  || (pending_io->scsiio.tag_type == CTL_TAG_SIMPLE))
10978	 && ((ooa_io->scsiio.tag_type == CTL_TAG_HEAD_OF_QUEUE)
10979	  || (ooa_io->scsiio.tag_type == CTL_TAG_ORDERED)))
10980		return (CTL_ACTION_BLOCK);
10981
10982	pending_entry = ctl_get_cmd_entry(&pending_io->scsiio);
10983	ooa_entry = ctl_get_cmd_entry(&ooa_io->scsiio);
10984
10985	serialize_row = ctl_serialize_table[ooa_entry->seridx];
10986
10987	switch (serialize_row[pending_entry->seridx]) {
10988	case CTL_SER_BLOCK:
10989		return (CTL_ACTION_BLOCK);
10990		break; /* NOTREACHED */
10991	case CTL_SER_EXTENT:
10992		return (ctl_extent_check(pending_io, ooa_io));
10993		break; /* NOTREACHED */
10994	case CTL_SER_PASS:
10995		return (CTL_ACTION_PASS);
10996		break; /* NOTREACHED */
10997	case CTL_SER_SKIP:
10998		return (CTL_ACTION_SKIP);
10999		break;
11000	default:
11001		panic("invalid serialization value %d",
11002		      serialize_row[pending_entry->seridx]);
11003		break; /* NOTREACHED */
11004	}
11005
11006	return (CTL_ACTION_ERROR);
11007}
11008
11009/*
11010 * Check for blockage or overlaps against the OOA (Order Of Arrival) queue.
11011 * Assumptions:
11012 * - pending_io is generally either incoming, or on the blocked queue
11013 * - starting I/O is the I/O we want to start the check with.
11014 */
11015static ctl_action
11016ctl_check_ooa(struct ctl_lun *lun, union ctl_io *pending_io,
11017	      union ctl_io *starting_io)
11018{
11019	union ctl_io *ooa_io;
11020	ctl_action action;
11021
11022	mtx_assert(&lun->lun_lock, MA_OWNED);
11023
11024	/*
11025	 * Run back along the OOA queue, starting with the current
11026	 * blocked I/O and going through every I/O before it on the
11027	 * queue.  If starting_io is NULL, we'll just end up returning
11028	 * CTL_ACTION_PASS.
11029	 */
11030	for (ooa_io = starting_io; ooa_io != NULL;
11031	     ooa_io = (union ctl_io *)TAILQ_PREV(&ooa_io->io_hdr, ctl_ooaq,
11032	     ooa_links)){
11033
11034		/*
11035		 * This routine just checks to see whether
11036		 * cur_blocked is blocked by ooa_io, which is ahead
11037		 * of it in the queue.  It doesn't queue/dequeue
11038		 * cur_blocked.
11039		 */
11040		action = ctl_check_for_blockage(pending_io, ooa_io);
11041		switch (action) {
11042		case CTL_ACTION_BLOCK:
11043		case CTL_ACTION_OVERLAP:
11044		case CTL_ACTION_OVERLAP_TAG:
11045		case CTL_ACTION_SKIP:
11046		case CTL_ACTION_ERROR:
11047			return (action);
11048			break; /* NOTREACHED */
11049		case CTL_ACTION_PASS:
11050			break;
11051		default:
11052			panic("invalid action %d", action);
11053			break;  /* NOTREACHED */
11054		}
11055	}
11056
11057	return (CTL_ACTION_PASS);
11058}
11059
11060/*
11061 * Assumptions:
11062 * - An I/O has just completed, and has been removed from the per-LUN OOA
11063 *   queue, so some items on the blocked queue may now be unblocked.
11064 */
11065static int
11066ctl_check_blocked(struct ctl_lun *lun)
11067{
11068	union ctl_io *cur_blocked, *next_blocked;
11069
11070	mtx_assert(&lun->lun_lock, MA_OWNED);
11071
11072	/*
11073	 * Run forward from the head of the blocked queue, checking each
11074	 * entry against the I/Os prior to it on the OOA queue to see if
11075	 * there is still any blockage.
11076	 *
11077	 * We cannot use the TAILQ_FOREACH() macro, because it can't deal
11078	 * with our removing a variable on it while it is traversing the
11079	 * list.
11080	 */
11081	for (cur_blocked = (union ctl_io *)TAILQ_FIRST(&lun->blocked_queue);
11082	     cur_blocked != NULL; cur_blocked = next_blocked) {
11083		union ctl_io *prev_ooa;
11084		ctl_action action;
11085
11086		next_blocked = (union ctl_io *)TAILQ_NEXT(&cur_blocked->io_hdr,
11087							  blocked_links);
11088
11089		prev_ooa = (union ctl_io *)TAILQ_PREV(&cur_blocked->io_hdr,
11090						      ctl_ooaq, ooa_links);
11091
11092		/*
11093		 * If cur_blocked happens to be the first item in the OOA
11094		 * queue now, prev_ooa will be NULL, and the action
11095		 * returned will just be CTL_ACTION_PASS.
11096		 */
11097		action = ctl_check_ooa(lun, cur_blocked, prev_ooa);
11098
11099		switch (action) {
11100		case CTL_ACTION_BLOCK:
11101			/* Nothing to do here, still blocked */
11102			break;
11103		case CTL_ACTION_OVERLAP:
11104		case CTL_ACTION_OVERLAP_TAG:
11105			/*
11106			 * This shouldn't happen!  In theory we've already
11107			 * checked this command for overlap...
11108			 */
11109			break;
11110		case CTL_ACTION_PASS:
11111		case CTL_ACTION_SKIP: {
11112			struct ctl_softc *softc;
11113			const struct ctl_cmd_entry *entry;
11114			uint32_t initidx;
11115			int isc_retval;
11116
11117			/*
11118			 * The skip case shouldn't happen, this transaction
11119			 * should have never made it onto the blocked queue.
11120			 */
11121			/*
11122			 * This I/O is no longer blocked, we can remove it
11123			 * from the blocked queue.  Since this is a TAILQ
11124			 * (doubly linked list), we can do O(1) removals
11125			 * from any place on the list.
11126			 */
11127			TAILQ_REMOVE(&lun->blocked_queue, &cur_blocked->io_hdr,
11128				     blocked_links);
11129			cur_blocked->io_hdr.flags &= ~CTL_FLAG_BLOCKED;
11130
11131			if (cur_blocked->io_hdr.flags & CTL_FLAG_FROM_OTHER_SC){
11132				/*
11133				 * Need to send IO back to original side to
11134				 * run
11135				 */
11136				union ctl_ha_msg msg_info;
11137
11138				msg_info.hdr.original_sc =
11139					cur_blocked->io_hdr.original_sc;
11140				msg_info.hdr.serializing_sc = cur_blocked;
11141				msg_info.hdr.msg_type = CTL_MSG_R2R;
11142				if ((isc_retval=ctl_ha_msg_send(CTL_HA_CHAN_CTL,
11143				     &msg_info, sizeof(msg_info), 0)) >
11144				     CTL_HA_STATUS_SUCCESS) {
11145					printf("CTL:Check Blocked error from "
11146					       "ctl_ha_msg_send %d\n",
11147					       isc_retval);
11148				}
11149				break;
11150			}
11151			entry = ctl_get_cmd_entry(&cur_blocked->scsiio);
11152			softc = control_softc;
11153
11154			initidx = ctl_get_initindex(&cur_blocked->io_hdr.nexus);
11155
11156			/*
11157			 * Check this I/O for LUN state changes that may
11158			 * have happened while this command was blocked.
11159			 * The LUN state may have been changed by a command
11160			 * ahead of us in the queue, so we need to re-check
11161			 * for any states that can be caused by SCSI
11162			 * commands.
11163			 */
11164			if (ctl_scsiio_lun_check(softc, lun, entry,
11165						 &cur_blocked->scsiio) == 0) {
11166				cur_blocked->io_hdr.flags |=
11167				                      CTL_FLAG_IS_WAS_ON_RTR;
11168				ctl_enqueue_rtr(cur_blocked);
11169			} else
11170				ctl_done(cur_blocked);
11171			break;
11172		}
11173		default:
11174			/*
11175			 * This probably shouldn't happen -- we shouldn't
11176			 * get CTL_ACTION_ERROR, or anything else.
11177			 */
11178			break;
11179		}
11180	}
11181
11182	return (CTL_RETVAL_COMPLETE);
11183}
11184
11185/*
11186 * This routine (with one exception) checks LUN flags that can be set by
11187 * commands ahead of us in the OOA queue.  These flags have to be checked
11188 * when a command initially comes in, and when we pull a command off the
11189 * blocked queue and are preparing to execute it.  The reason we have to
11190 * check these flags for commands on the blocked queue is that the LUN
11191 * state may have been changed by a command ahead of us while we're on the
11192 * blocked queue.
11193 *
11194 * Ordering is somewhat important with these checks, so please pay
11195 * careful attention to the placement of any new checks.
11196 */
11197static int
11198ctl_scsiio_lun_check(struct ctl_softc *ctl_softc, struct ctl_lun *lun,
11199    const struct ctl_cmd_entry *entry, struct ctl_scsiio *ctsio)
11200{
11201	int retval;
11202
11203	retval = 0;
11204
11205	mtx_assert(&lun->lun_lock, MA_OWNED);
11206
11207	/*
11208	 * If this shelf is a secondary shelf controller, we have to reject
11209	 * any media access commands.
11210	 */
11211#if 0
11212	/* No longer needed for HA */
11213	if (((ctl_softc->flags & CTL_FLAG_MASTER_SHELF) == 0)
11214	 && ((entry->flags & CTL_CMD_FLAG_OK_ON_SECONDARY) == 0)) {
11215		ctl_set_lun_standby(ctsio);
11216		retval = 1;
11217		goto bailout;
11218	}
11219#endif
11220
11221	/*
11222	 * Check for a reservation conflict.  If this command isn't allowed
11223	 * even on reserved LUNs, and if this initiator isn't the one who
11224	 * reserved us, reject the command with a reservation conflict.
11225	 */
11226	if ((lun->flags & CTL_LUN_RESERVED)
11227	 && ((entry->flags & CTL_CMD_FLAG_ALLOW_ON_RESV) == 0)) {
11228		if ((ctsio->io_hdr.nexus.initid.id != lun->rsv_nexus.initid.id)
11229		 || (ctsio->io_hdr.nexus.targ_port != lun->rsv_nexus.targ_port)
11230		 || (ctsio->io_hdr.nexus.targ_target.id !=
11231		     lun->rsv_nexus.targ_target.id)) {
11232			ctsio->scsi_status = SCSI_STATUS_RESERV_CONFLICT;
11233			ctsio->io_hdr.status = CTL_SCSI_ERROR;
11234			retval = 1;
11235			goto bailout;
11236		}
11237	}
11238
11239	if ( (lun->flags & CTL_LUN_PR_RESERVED)
11240	 && ((entry->flags & CTL_CMD_FLAG_ALLOW_ON_PR_RESV) == 0)) {
11241		uint32_t residx;
11242
11243		residx = ctl_get_resindex(&ctsio->io_hdr.nexus);
11244		/*
11245		 * if we aren't registered or it's a res holder type
11246		 * reservation and this isn't the res holder then set a
11247		 * conflict.
11248		 * NOTE: Commands which might be allowed on write exclusive
11249		 * type reservations are checked in the particular command
11250		 * for a conflict. Read and SSU are the only ones.
11251		 */
11252		if (!lun->per_res[residx].registered
11253		 || (residx != lun->pr_res_idx && lun->res_type < 4)) {
11254			ctsio->scsi_status = SCSI_STATUS_RESERV_CONFLICT;
11255			ctsio->io_hdr.status = CTL_SCSI_ERROR;
11256			retval = 1;
11257			goto bailout;
11258		}
11259
11260	}
11261
11262	if ((lun->flags & CTL_LUN_OFFLINE)
11263	 && ((entry->flags & CTL_CMD_FLAG_OK_ON_OFFLINE) == 0)) {
11264		ctl_set_lun_not_ready(ctsio);
11265		retval = 1;
11266		goto bailout;
11267	}
11268
11269	/*
11270	 * If the LUN is stopped, see if this particular command is allowed
11271	 * for a stopped lun.  Otherwise, reject it with 0x04,0x02.
11272	 */
11273	if ((lun->flags & CTL_LUN_STOPPED)
11274	 && ((entry->flags & CTL_CMD_FLAG_OK_ON_STOPPED) == 0)) {
11275		/* "Logical unit not ready, initializing cmd. required" */
11276		ctl_set_lun_stopped(ctsio);
11277		retval = 1;
11278		goto bailout;
11279	}
11280
11281	if ((lun->flags & CTL_LUN_INOPERABLE)
11282	 && ((entry->flags & CTL_CMD_FLAG_OK_ON_INOPERABLE) == 0)) {
11283		/* "Medium format corrupted" */
11284		ctl_set_medium_format_corrupted(ctsio);
11285		retval = 1;
11286		goto bailout;
11287	}
11288
11289bailout:
11290	return (retval);
11291
11292}
11293
11294static void
11295ctl_failover_io(union ctl_io *io, int have_lock)
11296{
11297	ctl_set_busy(&io->scsiio);
11298	ctl_done(io);
11299}
11300
11301static void
11302ctl_failover(void)
11303{
11304	struct ctl_lun *lun;
11305	struct ctl_softc *ctl_softc;
11306	union ctl_io *next_io, *pending_io;
11307	union ctl_io *io;
11308	int lun_idx;
11309	int i;
11310
11311	ctl_softc = control_softc;
11312
11313	mtx_lock(&ctl_softc->ctl_lock);
11314	/*
11315	 * Remove any cmds from the other SC from the rtr queue.  These
11316	 * will obviously only be for LUNs for which we're the primary.
11317	 * We can't send status or get/send data for these commands.
11318	 * Since they haven't been executed yet, we can just remove them.
11319	 * We'll either abort them or delete them below, depending on
11320	 * which HA mode we're in.
11321	 */
11322#ifdef notyet
11323	mtx_lock(&ctl_softc->queue_lock);
11324	for (io = (union ctl_io *)STAILQ_FIRST(&ctl_softc->rtr_queue);
11325	     io != NULL; io = next_io) {
11326		next_io = (union ctl_io *)STAILQ_NEXT(&io->io_hdr, links);
11327		if (io->io_hdr.flags & CTL_FLAG_FROM_OTHER_SC)
11328			STAILQ_REMOVE(&ctl_softc->rtr_queue, &io->io_hdr,
11329				      ctl_io_hdr, links);
11330	}
11331	mtx_unlock(&ctl_softc->queue_lock);
11332#endif
11333
11334	for (lun_idx=0; lun_idx < ctl_softc->num_luns; lun_idx++) {
11335		lun = ctl_softc->ctl_luns[lun_idx];
11336		if (lun==NULL)
11337			continue;
11338
11339		/*
11340		 * Processor LUNs are primary on both sides.
11341		 * XXX will this always be true?
11342		 */
11343		if (lun->be_lun->lun_type == T_PROCESSOR)
11344			continue;
11345
11346		if ((lun->flags & CTL_LUN_PRIMARY_SC)
11347		 && (ctl_softc->ha_mode == CTL_HA_MODE_SER_ONLY)) {
11348			printf("FAILOVER: primary lun %d\n", lun_idx);
11349		        /*
11350			 * Remove all commands from the other SC. First from the
11351			 * blocked queue then from the ooa queue. Once we have
11352			 * removed them. Call ctl_check_blocked to see if there
11353			 * is anything that can run.
11354			 */
11355			for (io = (union ctl_io *)TAILQ_FIRST(
11356			     &lun->blocked_queue); io != NULL; io = next_io) {
11357
11358		        	next_io = (union ctl_io *)TAILQ_NEXT(
11359				    &io->io_hdr, blocked_links);
11360
11361				if (io->io_hdr.flags & CTL_FLAG_FROM_OTHER_SC) {
11362					TAILQ_REMOVE(&lun->blocked_queue,
11363						     &io->io_hdr,blocked_links);
11364					io->io_hdr.flags &= ~CTL_FLAG_BLOCKED;
11365					TAILQ_REMOVE(&lun->ooa_queue,
11366						     &io->io_hdr, ooa_links);
11367
11368					ctl_free_io(io);
11369				}
11370			}
11371
11372			for (io = (union ctl_io *)TAILQ_FIRST(&lun->ooa_queue);
11373	     		     io != NULL; io = next_io) {
11374
11375		        	next_io = (union ctl_io *)TAILQ_NEXT(
11376				    &io->io_hdr, ooa_links);
11377
11378				if (io->io_hdr.flags & CTL_FLAG_FROM_OTHER_SC) {
11379
11380					TAILQ_REMOVE(&lun->ooa_queue,
11381						&io->io_hdr,
11382					     	ooa_links);
11383
11384					ctl_free_io(io);
11385				}
11386			}
11387			ctl_check_blocked(lun);
11388		} else if ((lun->flags & CTL_LUN_PRIMARY_SC)
11389			&& (ctl_softc->ha_mode == CTL_HA_MODE_XFER)) {
11390
11391			printf("FAILOVER: primary lun %d\n", lun_idx);
11392			/*
11393			 * Abort all commands from the other SC.  We can't
11394			 * send status back for them now.  These should get
11395			 * cleaned up when they are completed or come out
11396			 * for a datamove operation.
11397			 */
11398			for (io = (union ctl_io *)TAILQ_FIRST(&lun->ooa_queue);
11399	     		     io != NULL; io = next_io) {
11400		        	next_io = (union ctl_io *)TAILQ_NEXT(
11401					&io->io_hdr, ooa_links);
11402
11403				if (io->io_hdr.flags & CTL_FLAG_FROM_OTHER_SC)
11404					io->io_hdr.flags |= CTL_FLAG_ABORT;
11405			}
11406		} else if (((lun->flags & CTL_LUN_PRIMARY_SC) == 0)
11407			&& (ctl_softc->ha_mode == CTL_HA_MODE_XFER)) {
11408
11409			printf("FAILOVER: secondary lun %d\n", lun_idx);
11410
11411			lun->flags |= CTL_LUN_PRIMARY_SC;
11412
11413			/*
11414			 * We send all I/O that was sent to this controller
11415			 * and redirected to the other side back with
11416			 * busy status, and have the initiator retry it.
11417			 * Figuring out how much data has been transferred,
11418			 * etc. and picking up where we left off would be
11419			 * very tricky.
11420			 *
11421			 * XXX KDM need to remove I/O from the blocked
11422			 * queue as well!
11423			 */
11424			for (pending_io = (union ctl_io *)TAILQ_FIRST(
11425			     &lun->ooa_queue); pending_io != NULL;
11426			     pending_io = next_io) {
11427
11428				next_io =  (union ctl_io *)TAILQ_NEXT(
11429					&pending_io->io_hdr, ooa_links);
11430
11431				pending_io->io_hdr.flags &=
11432					~CTL_FLAG_SENT_2OTHER_SC;
11433
11434				if (pending_io->io_hdr.flags &
11435				    CTL_FLAG_IO_ACTIVE) {
11436					pending_io->io_hdr.flags |=
11437						CTL_FLAG_FAILOVER;
11438				} else {
11439					ctl_set_busy(&pending_io->scsiio);
11440					ctl_done(pending_io);
11441				}
11442			}
11443
11444			/*
11445			 * Build Unit Attention
11446			 */
11447			for (i = 0; i < CTL_MAX_INITIATORS; i++) {
11448				lun->pending_ua[i] |=
11449				                     CTL_UA_ASYM_ACC_CHANGE;
11450			}
11451		} else if (((lun->flags & CTL_LUN_PRIMARY_SC) == 0)
11452			&& (ctl_softc->ha_mode == CTL_HA_MODE_SER_ONLY)) {
11453			printf("FAILOVER: secondary lun %d\n", lun_idx);
11454			/*
11455			 * if the first io on the OOA is not on the RtR queue
11456			 * add it.
11457			 */
11458			lun->flags |= CTL_LUN_PRIMARY_SC;
11459
11460			pending_io = (union ctl_io *)TAILQ_FIRST(
11461			    &lun->ooa_queue);
11462			if (pending_io==NULL) {
11463				printf("Nothing on OOA queue\n");
11464				continue;
11465			}
11466
11467			pending_io->io_hdr.flags &= ~CTL_FLAG_SENT_2OTHER_SC;
11468			if ((pending_io->io_hdr.flags &
11469			     CTL_FLAG_IS_WAS_ON_RTR) == 0) {
11470				pending_io->io_hdr.flags |=
11471				    CTL_FLAG_IS_WAS_ON_RTR;
11472				ctl_enqueue_rtr(pending_io);
11473			}
11474#if 0
11475			else
11476			{
11477				printf("Tag 0x%04x is running\n",
11478				      pending_io->scsiio.tag_num);
11479			}
11480#endif
11481
11482			next_io = (union ctl_io *)TAILQ_NEXT(
11483			    &pending_io->io_hdr, ooa_links);
11484			for (pending_io=next_io; pending_io != NULL;
11485			     pending_io = next_io) {
11486				pending_io->io_hdr.flags &=
11487				    ~CTL_FLAG_SENT_2OTHER_SC;
11488				next_io = (union ctl_io *)TAILQ_NEXT(
11489					&pending_io->io_hdr, ooa_links);
11490				if (pending_io->io_hdr.flags &
11491				    CTL_FLAG_IS_WAS_ON_RTR) {
11492#if 0
11493				        printf("Tag 0x%04x is running\n",
11494				      		pending_io->scsiio.tag_num);
11495#endif
11496					continue;
11497				}
11498
11499				switch (ctl_check_ooa(lun, pending_io,
11500			            (union ctl_io *)TAILQ_PREV(
11501				    &pending_io->io_hdr, ctl_ooaq,
11502				    ooa_links))) {
11503
11504				case CTL_ACTION_BLOCK:
11505					TAILQ_INSERT_TAIL(&lun->blocked_queue,
11506							  &pending_io->io_hdr,
11507							  blocked_links);
11508					pending_io->io_hdr.flags |=
11509					    CTL_FLAG_BLOCKED;
11510					break;
11511				case CTL_ACTION_PASS:
11512				case CTL_ACTION_SKIP:
11513					pending_io->io_hdr.flags |=
11514					    CTL_FLAG_IS_WAS_ON_RTR;
11515					ctl_enqueue_rtr(pending_io);
11516					break;
11517				case CTL_ACTION_OVERLAP:
11518					ctl_set_overlapped_cmd(
11519					    (struct ctl_scsiio *)pending_io);
11520					ctl_done(pending_io);
11521					break;
11522				case CTL_ACTION_OVERLAP_TAG:
11523					ctl_set_overlapped_tag(
11524					    (struct ctl_scsiio *)pending_io,
11525					    pending_io->scsiio.tag_num & 0xff);
11526					ctl_done(pending_io);
11527					break;
11528				case CTL_ACTION_ERROR:
11529				default:
11530					ctl_set_internal_failure(
11531						(struct ctl_scsiio *)pending_io,
11532						0,  // sks_valid
11533						0); //retry count
11534					ctl_done(pending_io);
11535					break;
11536				}
11537			}
11538
11539			/*
11540			 * Build Unit Attention
11541			 */
11542			for (i = 0; i < CTL_MAX_INITIATORS; i++) {
11543				lun->pending_ua[i] |=
11544				                     CTL_UA_ASYM_ACC_CHANGE;
11545			}
11546		} else {
11547			panic("Unhandled HA mode failover, LUN flags = %#x, "
11548			      "ha_mode = #%x", lun->flags, ctl_softc->ha_mode);
11549		}
11550	}
11551	ctl_pause_rtr = 0;
11552	mtx_unlock(&ctl_softc->ctl_lock);
11553}
11554
11555static int
11556ctl_scsiio_precheck(struct ctl_softc *ctl_softc, struct ctl_scsiio *ctsio)
11557{
11558	struct ctl_lun *lun;
11559	const struct ctl_cmd_entry *entry;
11560	uint32_t initidx, targ_lun;
11561	int retval;
11562
11563	retval = 0;
11564
11565	lun = NULL;
11566
11567	targ_lun = ctsio->io_hdr.nexus.targ_mapped_lun;
11568	if ((targ_lun < CTL_MAX_LUNS)
11569	 && (ctl_softc->ctl_luns[targ_lun] != NULL)) {
11570		lun = ctl_softc->ctl_luns[targ_lun];
11571		/*
11572		 * If the LUN is invalid, pretend that it doesn't exist.
11573		 * It will go away as soon as all pending I/O has been
11574		 * completed.
11575		 */
11576		if (lun->flags & CTL_LUN_DISABLED) {
11577			lun = NULL;
11578		} else {
11579			ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr = lun;
11580			ctsio->io_hdr.ctl_private[CTL_PRIV_BACKEND_LUN].ptr =
11581				lun->be_lun;
11582			if (lun->be_lun->lun_type == T_PROCESSOR) {
11583				ctsio->io_hdr.flags |= CTL_FLAG_CONTROL_DEV;
11584			}
11585
11586			/*
11587			 * Every I/O goes into the OOA queue for a
11588			 * particular LUN, and stays there until completion.
11589			 */
11590			mtx_lock(&lun->lun_lock);
11591			TAILQ_INSERT_TAIL(&lun->ooa_queue, &ctsio->io_hdr,
11592			    ooa_links);
11593		}
11594	} else {
11595		ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr = NULL;
11596		ctsio->io_hdr.ctl_private[CTL_PRIV_BACKEND_LUN].ptr = NULL;
11597	}
11598
11599	/* Get command entry and return error if it is unsuppotyed. */
11600	entry = ctl_validate_command(ctsio);
11601	if (entry == NULL) {
11602		if (lun)
11603			mtx_unlock(&lun->lun_lock);
11604		return (retval);
11605	}
11606
11607	ctsio->io_hdr.flags &= ~CTL_FLAG_DATA_MASK;
11608	ctsio->io_hdr.flags |= entry->flags & CTL_FLAG_DATA_MASK;
11609
11610	/*
11611	 * Check to see whether we can send this command to LUNs that don't
11612	 * exist.  This should pretty much only be the case for inquiry
11613	 * and request sense.  Further checks, below, really require having
11614	 * a LUN, so we can't really check the command anymore.  Just put
11615	 * it on the rtr queue.
11616	 */
11617	if (lun == NULL) {
11618		if (entry->flags & CTL_CMD_FLAG_OK_ON_ALL_LUNS) {
11619			ctsio->io_hdr.flags |= CTL_FLAG_IS_WAS_ON_RTR;
11620			ctl_enqueue_rtr((union ctl_io *)ctsio);
11621			return (retval);
11622		}
11623
11624		ctl_set_unsupported_lun(ctsio);
11625		ctl_done((union ctl_io *)ctsio);
11626		CTL_DEBUG_PRINT(("ctl_scsiio_precheck: bailing out due to invalid LUN\n"));
11627		return (retval);
11628	} else {
11629		/*
11630		 * Make sure we support this particular command on this LUN.
11631		 * e.g., we don't support writes to the control LUN.
11632		 */
11633		if (!ctl_cmd_applicable(lun->be_lun->lun_type, entry)) {
11634			mtx_unlock(&lun->lun_lock);
11635			ctl_set_invalid_opcode(ctsio);
11636			ctl_done((union ctl_io *)ctsio);
11637			return (retval);
11638		}
11639	}
11640
11641	initidx = ctl_get_initindex(&ctsio->io_hdr.nexus);
11642
11643#ifdef CTL_WITH_CA
11644	/*
11645	 * If we've got a request sense, it'll clear the contingent
11646	 * allegiance condition.  Otherwise, if we have a CA condition for
11647	 * this initiator, clear it, because it sent down a command other
11648	 * than request sense.
11649	 */
11650	if ((ctsio->cdb[0] != REQUEST_SENSE)
11651	 && (ctl_is_set(lun->have_ca, initidx)))
11652		ctl_clear_mask(lun->have_ca, initidx);
11653#endif
11654
11655	/*
11656	 * If the command has this flag set, it handles its own unit
11657	 * attention reporting, we shouldn't do anything.  Otherwise we
11658	 * check for any pending unit attentions, and send them back to the
11659	 * initiator.  We only do this when a command initially comes in,
11660	 * not when we pull it off the blocked queue.
11661	 *
11662	 * According to SAM-3, section 5.3.2, the order that things get
11663	 * presented back to the host is basically unit attentions caused
11664	 * by some sort of reset event, busy status, reservation conflicts
11665	 * or task set full, and finally any other status.
11666	 *
11667	 * One issue here is that some of the unit attentions we report
11668	 * don't fall into the "reset" category (e.g. "reported luns data
11669	 * has changed").  So reporting it here, before the reservation
11670	 * check, may be technically wrong.  I guess the only thing to do
11671	 * would be to check for and report the reset events here, and then
11672	 * check for the other unit attention types after we check for a
11673	 * reservation conflict.
11674	 *
11675	 * XXX KDM need to fix this
11676	 */
11677	if ((entry->flags & CTL_CMD_FLAG_NO_SENSE) == 0) {
11678		ctl_ua_type ua_type;
11679
11680		ua_type = lun->pending_ua[initidx];
11681		if (ua_type != CTL_UA_NONE) {
11682			scsi_sense_data_type sense_format;
11683
11684			if (lun != NULL)
11685				sense_format = (lun->flags &
11686				    CTL_LUN_SENSE_DESC) ? SSD_TYPE_DESC :
11687				    SSD_TYPE_FIXED;
11688			else
11689				sense_format = SSD_TYPE_FIXED;
11690
11691			ua_type = ctl_build_ua(ua_type, &ctsio->sense_data,
11692					       sense_format);
11693			if (ua_type != CTL_UA_NONE) {
11694				ctsio->scsi_status = SCSI_STATUS_CHECK_COND;
11695				ctsio->io_hdr.status = CTL_SCSI_ERROR |
11696						       CTL_AUTOSENSE;
11697				ctsio->sense_len = SSD_FULL_SIZE;
11698				lun->pending_ua[initidx] &= ~ua_type;
11699				mtx_unlock(&lun->lun_lock);
11700				ctl_done((union ctl_io *)ctsio);
11701				return (retval);
11702			}
11703		}
11704	}
11705
11706
11707	if (ctl_scsiio_lun_check(ctl_softc, lun, entry, ctsio) != 0) {
11708		mtx_unlock(&lun->lun_lock);
11709		ctl_done((union ctl_io *)ctsio);
11710		return (retval);
11711	}
11712
11713	/*
11714	 * XXX CHD this is where we want to send IO to other side if
11715	 * this LUN is secondary on this SC. We will need to make a copy
11716	 * of the IO and flag the IO on this side as SENT_2OTHER and the flag
11717	 * the copy we send as FROM_OTHER.
11718	 * We also need to stuff the address of the original IO so we can
11719	 * find it easily. Something similar will need be done on the other
11720	 * side so when we are done we can find the copy.
11721	 */
11722	if ((lun->flags & CTL_LUN_PRIMARY_SC) == 0) {
11723		union ctl_ha_msg msg_info;
11724		int isc_retval;
11725
11726		ctsio->io_hdr.flags |= CTL_FLAG_SENT_2OTHER_SC;
11727
11728		msg_info.hdr.msg_type = CTL_MSG_SERIALIZE;
11729		msg_info.hdr.original_sc = (union ctl_io *)ctsio;
11730#if 0
11731		printf("1. ctsio %p\n", ctsio);
11732#endif
11733		msg_info.hdr.serializing_sc = NULL;
11734		msg_info.hdr.nexus = ctsio->io_hdr.nexus;
11735		msg_info.scsi.tag_num = ctsio->tag_num;
11736		msg_info.scsi.tag_type = ctsio->tag_type;
11737		memcpy(msg_info.scsi.cdb, ctsio->cdb, CTL_MAX_CDBLEN);
11738
11739		ctsio->io_hdr.flags &= ~CTL_FLAG_IO_ACTIVE;
11740
11741		if ((isc_retval=ctl_ha_msg_send(CTL_HA_CHAN_CTL,
11742		    (void *)&msg_info, sizeof(msg_info), 0)) >
11743		    CTL_HA_STATUS_SUCCESS) {
11744			printf("CTL:precheck, ctl_ha_msg_send returned %d\n",
11745			       isc_retval);
11746			printf("CTL:opcode is %x\n", ctsio->cdb[0]);
11747		} else {
11748#if 0
11749			printf("CTL:Precheck sent msg, opcode is %x\n",opcode);
11750#endif
11751		}
11752
11753		/*
11754		 * XXX KDM this I/O is off the incoming queue, but hasn't
11755		 * been inserted on any other queue.  We may need to come
11756		 * up with a holding queue while we wait for serialization
11757		 * so that we have an idea of what we're waiting for from
11758		 * the other side.
11759		 */
11760		mtx_unlock(&lun->lun_lock);
11761		return (retval);
11762	}
11763
11764	switch (ctl_check_ooa(lun, (union ctl_io *)ctsio,
11765			      (union ctl_io *)TAILQ_PREV(&ctsio->io_hdr,
11766			      ctl_ooaq, ooa_links))) {
11767	case CTL_ACTION_BLOCK:
11768		ctsio->io_hdr.flags |= CTL_FLAG_BLOCKED;
11769		TAILQ_INSERT_TAIL(&lun->blocked_queue, &ctsio->io_hdr,
11770				  blocked_links);
11771		mtx_unlock(&lun->lun_lock);
11772		return (retval);
11773	case CTL_ACTION_PASS:
11774	case CTL_ACTION_SKIP:
11775		ctsio->io_hdr.flags |= CTL_FLAG_IS_WAS_ON_RTR;
11776		mtx_unlock(&lun->lun_lock);
11777		ctl_enqueue_rtr((union ctl_io *)ctsio);
11778		break;
11779	case CTL_ACTION_OVERLAP:
11780		mtx_unlock(&lun->lun_lock);
11781		ctl_set_overlapped_cmd(ctsio);
11782		ctl_done((union ctl_io *)ctsio);
11783		break;
11784	case CTL_ACTION_OVERLAP_TAG:
11785		mtx_unlock(&lun->lun_lock);
11786		ctl_set_overlapped_tag(ctsio, ctsio->tag_num & 0xff);
11787		ctl_done((union ctl_io *)ctsio);
11788		break;
11789	case CTL_ACTION_ERROR:
11790	default:
11791		mtx_unlock(&lun->lun_lock);
11792		ctl_set_internal_failure(ctsio,
11793					 /*sks_valid*/ 0,
11794					 /*retry_count*/ 0);
11795		ctl_done((union ctl_io *)ctsio);
11796		break;
11797	}
11798	return (retval);
11799}
11800
11801const struct ctl_cmd_entry *
11802ctl_get_cmd_entry(struct ctl_scsiio *ctsio)
11803{
11804	const struct ctl_cmd_entry *entry;
11805	int service_action;
11806
11807	entry = &ctl_cmd_table[ctsio->cdb[0]];
11808	if (entry->flags & CTL_CMD_FLAG_SA5) {
11809		service_action = ctsio->cdb[1] & SERVICE_ACTION_MASK;
11810		entry = &((const struct ctl_cmd_entry *)
11811		    entry->execute)[service_action];
11812	}
11813	return (entry);
11814}
11815
11816const struct ctl_cmd_entry *
11817ctl_validate_command(struct ctl_scsiio *ctsio)
11818{
11819	const struct ctl_cmd_entry *entry;
11820	int i;
11821	uint8_t diff;
11822
11823	entry = ctl_get_cmd_entry(ctsio);
11824	if (entry->execute == NULL) {
11825		ctl_set_invalid_opcode(ctsio);
11826		ctl_done((union ctl_io *)ctsio);
11827		return (NULL);
11828	}
11829	KASSERT(entry->length > 0,
11830	    ("Not defined length for command 0x%02x/0x%02x",
11831	     ctsio->cdb[0], ctsio->cdb[1]));
11832	for (i = 1; i < entry->length; i++) {
11833		diff = ctsio->cdb[i] & ~entry->usage[i - 1];
11834		if (diff == 0)
11835			continue;
11836		ctl_set_invalid_field(ctsio,
11837				      /*sks_valid*/ 1,
11838				      /*command*/ 1,
11839				      /*field*/ i,
11840				      /*bit_valid*/ 1,
11841				      /*bit*/ fls(diff) - 1);
11842		ctl_done((union ctl_io *)ctsio);
11843		return (NULL);
11844	}
11845	return (entry);
11846}
11847
11848static int
11849ctl_cmd_applicable(uint8_t lun_type, const struct ctl_cmd_entry *entry)
11850{
11851
11852	switch (lun_type) {
11853	case T_PROCESSOR:
11854		if (((entry->flags & CTL_CMD_FLAG_OK_ON_PROC) == 0) &&
11855		    ((entry->flags & CTL_CMD_FLAG_OK_ON_ALL_LUNS) == 0))
11856			return (0);
11857		break;
11858	case T_DIRECT:
11859		if (((entry->flags & CTL_CMD_FLAG_OK_ON_SLUN) == 0) &&
11860		    ((entry->flags & CTL_CMD_FLAG_OK_ON_ALL_LUNS) == 0))
11861			return (0);
11862		break;
11863	default:
11864		return (0);
11865	}
11866	return (1);
11867}
11868
11869static int
11870ctl_scsiio(struct ctl_scsiio *ctsio)
11871{
11872	int retval;
11873	const struct ctl_cmd_entry *entry;
11874
11875	retval = CTL_RETVAL_COMPLETE;
11876
11877	CTL_DEBUG_PRINT(("ctl_scsiio cdb[0]=%02X\n", ctsio->cdb[0]));
11878
11879	entry = ctl_get_cmd_entry(ctsio);
11880
11881	/*
11882	 * If this I/O has been aborted, just send it straight to
11883	 * ctl_done() without executing it.
11884	 */
11885	if (ctsio->io_hdr.flags & CTL_FLAG_ABORT) {
11886		ctl_done((union ctl_io *)ctsio);
11887		goto bailout;
11888	}
11889
11890	/*
11891	 * All the checks should have been handled by ctl_scsiio_precheck().
11892	 * We should be clear now to just execute the I/O.
11893	 */
11894	retval = entry->execute(ctsio);
11895
11896bailout:
11897	return (retval);
11898}
11899
11900/*
11901 * Since we only implement one target right now, a bus reset simply resets
11902 * our single target.
11903 */
11904static int
11905ctl_bus_reset(struct ctl_softc *ctl_softc, union ctl_io *io)
11906{
11907	return(ctl_target_reset(ctl_softc, io, CTL_UA_BUS_RESET));
11908}
11909
11910static int
11911ctl_target_reset(struct ctl_softc *ctl_softc, union ctl_io *io,
11912		 ctl_ua_type ua_type)
11913{
11914	struct ctl_lun *lun;
11915	int retval;
11916
11917	if (!(io->io_hdr.flags & CTL_FLAG_FROM_OTHER_SC)) {
11918		union ctl_ha_msg msg_info;
11919
11920		io->io_hdr.flags |= CTL_FLAG_SENT_2OTHER_SC;
11921		msg_info.hdr.nexus = io->io_hdr.nexus;
11922		if (ua_type==CTL_UA_TARG_RESET)
11923			msg_info.task.task_action = CTL_TASK_TARGET_RESET;
11924		else
11925			msg_info.task.task_action = CTL_TASK_BUS_RESET;
11926		msg_info.hdr.msg_type = CTL_MSG_MANAGE_TASKS;
11927		msg_info.hdr.original_sc = NULL;
11928		msg_info.hdr.serializing_sc = NULL;
11929		if (CTL_HA_STATUS_SUCCESS != ctl_ha_msg_send(CTL_HA_CHAN_CTL,
11930		    (void *)&msg_info, sizeof(msg_info), 0)) {
11931		}
11932	}
11933	retval = 0;
11934
11935	mtx_lock(&ctl_softc->ctl_lock);
11936	STAILQ_FOREACH(lun, &ctl_softc->lun_list, links)
11937		retval += ctl_lun_reset(lun, io, ua_type);
11938	mtx_unlock(&ctl_softc->ctl_lock);
11939
11940	return (retval);
11941}
11942
11943/*
11944 * The LUN should always be set.  The I/O is optional, and is used to
11945 * distinguish between I/Os sent by this initiator, and by other
11946 * initiators.  We set unit attention for initiators other than this one.
11947 * SAM-3 is vague on this point.  It does say that a unit attention should
11948 * be established for other initiators when a LUN is reset (see section
11949 * 5.7.3), but it doesn't specifically say that the unit attention should
11950 * be established for this particular initiator when a LUN is reset.  Here
11951 * is the relevant text, from SAM-3 rev 8:
11952 *
11953 * 5.7.2 When a SCSI initiator port aborts its own tasks
11954 *
11955 * When a SCSI initiator port causes its own task(s) to be aborted, no
11956 * notification that the task(s) have been aborted shall be returned to
11957 * the SCSI initiator port other than the completion response for the
11958 * command or task management function action that caused the task(s) to
11959 * be aborted and notification(s) associated with related effects of the
11960 * action (e.g., a reset unit attention condition).
11961 *
11962 * XXX KDM for now, we're setting unit attention for all initiators.
11963 */
11964static int
11965ctl_lun_reset(struct ctl_lun *lun, union ctl_io *io, ctl_ua_type ua_type)
11966{
11967	union ctl_io *xio;
11968#if 0
11969	uint32_t initindex;
11970#endif
11971	int i;
11972
11973	mtx_lock(&lun->lun_lock);
11974	/*
11975	 * Run through the OOA queue and abort each I/O.
11976	 */
11977#if 0
11978	TAILQ_FOREACH((struct ctl_io_hdr *)xio, &lun->ooa_queue, ooa_links) {
11979#endif
11980	for (xio = (union ctl_io *)TAILQ_FIRST(&lun->ooa_queue); xio != NULL;
11981	     xio = (union ctl_io *)TAILQ_NEXT(&xio->io_hdr, ooa_links)) {
11982		xio->io_hdr.flags |= CTL_FLAG_ABORT | CTL_FLAG_ABORT_STATUS;
11983	}
11984
11985	/*
11986	 * This version sets unit attention for every
11987	 */
11988#if 0
11989	initindex = ctl_get_initindex(&io->io_hdr.nexus);
11990	for (i = 0; i < CTL_MAX_INITIATORS; i++) {
11991		if (initindex == i)
11992			continue;
11993		lun->pending_ua[i] |= ua_type;
11994	}
11995#endif
11996
11997	/*
11998	 * A reset (any kind, really) clears reservations established with
11999	 * RESERVE/RELEASE.  It does not clear reservations established
12000	 * with PERSISTENT RESERVE OUT, but we don't support that at the
12001	 * moment anyway.  See SPC-2, section 5.6.  SPC-3 doesn't address
12002	 * reservations made with the RESERVE/RELEASE commands, because
12003	 * those commands are obsolete in SPC-3.
12004	 */
12005	lun->flags &= ~CTL_LUN_RESERVED;
12006
12007	for (i = 0; i < CTL_MAX_INITIATORS; i++) {
12008#ifdef CTL_WITH_CA
12009		ctl_clear_mask(lun->have_ca, i);
12010#endif
12011		lun->pending_ua[i] |= ua_type;
12012	}
12013	mtx_unlock(&lun->lun_lock);
12014
12015	return (0);
12016}
12017
12018static int
12019ctl_abort_tasks_lun(struct ctl_lun *lun, uint32_t targ_port, uint32_t init_id,
12020    int other_sc)
12021{
12022	union ctl_io *xio;
12023	int found;
12024
12025	mtx_assert(&lun->lun_lock, MA_OWNED);
12026
12027	/*
12028	 * Run through the OOA queue and attempt to find the given I/O.
12029	 * The target port, initiator ID, tag type and tag number have to
12030	 * match the values that we got from the initiator.  If we have an
12031	 * untagged command to abort, simply abort the first untagged command
12032	 * we come to.  We only allow one untagged command at a time of course.
12033	 */
12034	for (xio = (union ctl_io *)TAILQ_FIRST(&lun->ooa_queue); xio != NULL;
12035	     xio = (union ctl_io *)TAILQ_NEXT(&xio->io_hdr, ooa_links)) {
12036
12037		if ((targ_port == UINT32_MAX ||
12038		     targ_port == xio->io_hdr.nexus.targ_port) &&
12039		    (init_id == UINT32_MAX ||
12040		     init_id == xio->io_hdr.nexus.initid.id)) {
12041			if (targ_port != xio->io_hdr.nexus.targ_port ||
12042			    init_id != xio->io_hdr.nexus.initid.id)
12043				xio->io_hdr.flags |= CTL_FLAG_ABORT_STATUS;
12044			xio->io_hdr.flags |= CTL_FLAG_ABORT;
12045			found = 1;
12046			if (!other_sc && !(lun->flags & CTL_LUN_PRIMARY_SC)) {
12047				union ctl_ha_msg msg_info;
12048
12049				msg_info.hdr.nexus = xio->io_hdr.nexus;
12050				msg_info.task.task_action = CTL_TASK_ABORT_TASK;
12051				msg_info.task.tag_num = xio->scsiio.tag_num;
12052				msg_info.task.tag_type = xio->scsiio.tag_type;
12053				msg_info.hdr.msg_type = CTL_MSG_MANAGE_TASKS;
12054				msg_info.hdr.original_sc = NULL;
12055				msg_info.hdr.serializing_sc = NULL;
12056				ctl_ha_msg_send(CTL_HA_CHAN_CTL,
12057				    (void *)&msg_info, sizeof(msg_info), 0);
12058			}
12059		}
12060	}
12061	return (found);
12062}
12063
12064static int
12065ctl_abort_task_set(union ctl_io *io)
12066{
12067	struct ctl_softc *softc = control_softc;
12068	struct ctl_lun *lun;
12069	uint32_t targ_lun;
12070
12071	/*
12072	 * Look up the LUN.
12073	 */
12074	targ_lun = io->io_hdr.nexus.targ_mapped_lun;
12075	mtx_lock(&softc->ctl_lock);
12076	if ((targ_lun < CTL_MAX_LUNS) && (softc->ctl_luns[targ_lun] != NULL))
12077		lun = softc->ctl_luns[targ_lun];
12078	else {
12079		mtx_unlock(&softc->ctl_lock);
12080		return (1);
12081	}
12082
12083	mtx_lock(&lun->lun_lock);
12084	mtx_unlock(&softc->ctl_lock);
12085	if (io->taskio.task_action == CTL_TASK_ABORT_TASK_SET) {
12086		ctl_abort_tasks_lun(lun, io->io_hdr.nexus.targ_port,
12087		    io->io_hdr.nexus.initid.id,
12088		    (io->io_hdr.flags & CTL_FLAG_FROM_OTHER_SC) != 0);
12089	} else { /* CTL_TASK_CLEAR_TASK_SET */
12090		ctl_abort_tasks_lun(lun, UINT32_MAX, UINT32_MAX,
12091		    (io->io_hdr.flags & CTL_FLAG_FROM_OTHER_SC) != 0);
12092	}
12093	mtx_unlock(&lun->lun_lock);
12094	return (0);
12095}
12096
12097static int
12098ctl_i_t_nexus_reset(union ctl_io *io)
12099{
12100	struct ctl_softc *softc = control_softc;
12101	struct ctl_lun *lun;
12102	uint32_t initindex;
12103
12104	initindex = ctl_get_initindex(&io->io_hdr.nexus);
12105	mtx_lock(&softc->ctl_lock);
12106	STAILQ_FOREACH(lun, &softc->lun_list, links) {
12107		mtx_lock(&lun->lun_lock);
12108		ctl_abort_tasks_lun(lun, io->io_hdr.nexus.targ_port,
12109		    io->io_hdr.nexus.initid.id,
12110		    (io->io_hdr.flags & CTL_FLAG_FROM_OTHER_SC) != 0);
12111#ifdef CTL_WITH_CA
12112		ctl_clear_mask(lun->have_ca, initindex);
12113#endif
12114		lun->pending_ua[initindex] |= CTL_UA_I_T_NEXUS_LOSS;
12115		mtx_unlock(&lun->lun_lock);
12116	}
12117	mtx_unlock(&softc->ctl_lock);
12118	return (0);
12119}
12120
12121static int
12122ctl_abort_task(union ctl_io *io)
12123{
12124	union ctl_io *xio;
12125	struct ctl_lun *lun;
12126	struct ctl_softc *ctl_softc;
12127#if 0
12128	struct sbuf sb;
12129	char printbuf[128];
12130#endif
12131	int found;
12132	uint32_t targ_lun;
12133
12134	ctl_softc = control_softc;
12135	found = 0;
12136
12137	/*
12138	 * Look up the LUN.
12139	 */
12140	targ_lun = io->io_hdr.nexus.targ_mapped_lun;
12141	mtx_lock(&ctl_softc->ctl_lock);
12142	if ((targ_lun < CTL_MAX_LUNS)
12143	 && (ctl_softc->ctl_luns[targ_lun] != NULL))
12144		lun = ctl_softc->ctl_luns[targ_lun];
12145	else {
12146		mtx_unlock(&ctl_softc->ctl_lock);
12147		return (1);
12148	}
12149
12150#if 0
12151	printf("ctl_abort_task: called for lun %lld, tag %d type %d\n",
12152	       lun->lun, io->taskio.tag_num, io->taskio.tag_type);
12153#endif
12154
12155	mtx_lock(&lun->lun_lock);
12156	mtx_unlock(&ctl_softc->ctl_lock);
12157	/*
12158	 * Run through the OOA queue and attempt to find the given I/O.
12159	 * The target port, initiator ID, tag type and tag number have to
12160	 * match the values that we got from the initiator.  If we have an
12161	 * untagged command to abort, simply abort the first untagged command
12162	 * we come to.  We only allow one untagged command at a time of course.
12163	 */
12164#if 0
12165	TAILQ_FOREACH((struct ctl_io_hdr *)xio, &lun->ooa_queue, ooa_links) {
12166#endif
12167	for (xio = (union ctl_io *)TAILQ_FIRST(&lun->ooa_queue); xio != NULL;
12168	     xio = (union ctl_io *)TAILQ_NEXT(&xio->io_hdr, ooa_links)) {
12169#if 0
12170		sbuf_new(&sb, printbuf, sizeof(printbuf), SBUF_FIXEDLEN);
12171
12172		sbuf_printf(&sb, "LUN %lld tag %d type %d%s%s%s%s: ",
12173			    lun->lun, xio->scsiio.tag_num,
12174			    xio->scsiio.tag_type,
12175			    (xio->io_hdr.blocked_links.tqe_prev
12176			    == NULL) ? "" : " BLOCKED",
12177			    (xio->io_hdr.flags &
12178			    CTL_FLAG_DMA_INPROG) ? " DMA" : "",
12179			    (xio->io_hdr.flags &
12180			    CTL_FLAG_ABORT) ? " ABORT" : "",
12181			    (xio->io_hdr.flags &
12182			    CTL_FLAG_IS_WAS_ON_RTR ? " RTR" : ""));
12183		ctl_scsi_command_string(&xio->scsiio, NULL, &sb);
12184		sbuf_finish(&sb);
12185		printf("%s\n", sbuf_data(&sb));
12186#endif
12187
12188		if ((xio->io_hdr.nexus.targ_port == io->io_hdr.nexus.targ_port)
12189		 && (xio->io_hdr.nexus.initid.id ==
12190		     io->io_hdr.nexus.initid.id)) {
12191			/*
12192			 * If the abort says that the task is untagged, the
12193			 * task in the queue must be untagged.  Otherwise,
12194			 * we just check to see whether the tag numbers
12195			 * match.  This is because the QLogic firmware
12196			 * doesn't pass back the tag type in an abort
12197			 * request.
12198			 */
12199#if 0
12200			if (((xio->scsiio.tag_type == CTL_TAG_UNTAGGED)
12201			  && (io->taskio.tag_type == CTL_TAG_UNTAGGED))
12202			 || (xio->scsiio.tag_num == io->taskio.tag_num)) {
12203#endif
12204			/*
12205			 * XXX KDM we've got problems with FC, because it
12206			 * doesn't send down a tag type with aborts.  So we
12207			 * can only really go by the tag number...
12208			 * This may cause problems with parallel SCSI.
12209			 * Need to figure that out!!
12210			 */
12211			if (xio->scsiio.tag_num == io->taskio.tag_num) {
12212				xio->io_hdr.flags |= CTL_FLAG_ABORT;
12213				found = 1;
12214				if ((io->io_hdr.flags &
12215				     CTL_FLAG_FROM_OTHER_SC) == 0 &&
12216				    !(lun->flags & CTL_LUN_PRIMARY_SC)) {
12217					union ctl_ha_msg msg_info;
12218
12219					io->io_hdr.flags |=
12220					                CTL_FLAG_SENT_2OTHER_SC;
12221					msg_info.hdr.nexus = io->io_hdr.nexus;
12222					msg_info.task.task_action =
12223						CTL_TASK_ABORT_TASK;
12224					msg_info.task.tag_num =
12225						io->taskio.tag_num;
12226					msg_info.task.tag_type =
12227						io->taskio.tag_type;
12228					msg_info.hdr.msg_type =
12229						CTL_MSG_MANAGE_TASKS;
12230					msg_info.hdr.original_sc = NULL;
12231					msg_info.hdr.serializing_sc = NULL;
12232#if 0
12233					printf("Sent Abort to other side\n");
12234#endif
12235					if (CTL_HA_STATUS_SUCCESS !=
12236					        ctl_ha_msg_send(CTL_HA_CHAN_CTL,
12237		    				(void *)&msg_info,
12238						sizeof(msg_info), 0)) {
12239					}
12240				}
12241#if 0
12242				printf("ctl_abort_task: found I/O to abort\n");
12243#endif
12244				break;
12245			}
12246		}
12247	}
12248	mtx_unlock(&lun->lun_lock);
12249
12250	if (found == 0) {
12251		/*
12252		 * This isn't really an error.  It's entirely possible for
12253		 * the abort and command completion to cross on the wire.
12254		 * This is more of an informative/diagnostic error.
12255		 */
12256#if 0
12257		printf("ctl_abort_task: ABORT sent for nonexistent I/O: "
12258		       "%d:%d:%d:%d tag %d type %d\n",
12259		       io->io_hdr.nexus.initid.id,
12260		       io->io_hdr.nexus.targ_port,
12261		       io->io_hdr.nexus.targ_target.id,
12262		       io->io_hdr.nexus.targ_lun, io->taskio.tag_num,
12263		       io->taskio.tag_type);
12264#endif
12265	}
12266	return (0);
12267}
12268
12269static void
12270ctl_run_task(union ctl_io *io)
12271{
12272	struct ctl_softc *ctl_softc = control_softc;
12273	int retval = 1;
12274	const char *task_desc;
12275
12276	CTL_DEBUG_PRINT(("ctl_run_task\n"));
12277
12278	KASSERT(io->io_hdr.io_type == CTL_IO_TASK,
12279	    ("ctl_run_task: Unextected io_type %d\n",
12280	     io->io_hdr.io_type));
12281
12282	task_desc = ctl_scsi_task_string(&io->taskio);
12283	if (task_desc != NULL) {
12284#ifdef NEEDTOPORT
12285		csevent_log(CSC_CTL | CSC_SHELF_SW |
12286			    CTL_TASK_REPORT,
12287			    csevent_LogType_Trace,
12288			    csevent_Severity_Information,
12289			    csevent_AlertLevel_Green,
12290			    csevent_FRU_Firmware,
12291			    csevent_FRU_Unknown,
12292			    "CTL: received task: %s",task_desc);
12293#endif
12294	} else {
12295#ifdef NEEDTOPORT
12296		csevent_log(CSC_CTL | CSC_SHELF_SW |
12297			    CTL_TASK_REPORT,
12298			    csevent_LogType_Trace,
12299			    csevent_Severity_Information,
12300			    csevent_AlertLevel_Green,
12301			    csevent_FRU_Firmware,
12302			    csevent_FRU_Unknown,
12303			    "CTL: received unknown task "
12304			    "type: %d (%#x)",
12305			    io->taskio.task_action,
12306			    io->taskio.task_action);
12307#endif
12308	}
12309	switch (io->taskio.task_action) {
12310	case CTL_TASK_ABORT_TASK:
12311		retval = ctl_abort_task(io);
12312		break;
12313	case CTL_TASK_ABORT_TASK_SET:
12314	case CTL_TASK_CLEAR_TASK_SET:
12315		retval = ctl_abort_task_set(io);
12316		break;
12317	case CTL_TASK_CLEAR_ACA:
12318		break;
12319	case CTL_TASK_I_T_NEXUS_RESET:
12320		retval = ctl_i_t_nexus_reset(io);
12321		break;
12322	case CTL_TASK_LUN_RESET: {
12323		struct ctl_lun *lun;
12324		uint32_t targ_lun;
12325
12326		targ_lun = io->io_hdr.nexus.targ_mapped_lun;
12327		mtx_lock(&ctl_softc->ctl_lock);
12328		if ((targ_lun < CTL_MAX_LUNS)
12329		 && (ctl_softc->ctl_luns[targ_lun] != NULL))
12330			lun = ctl_softc->ctl_luns[targ_lun];
12331		else {
12332			mtx_unlock(&ctl_softc->ctl_lock);
12333			retval = 1;
12334			break;
12335		}
12336
12337		if (!(io->io_hdr.flags &
12338		    CTL_FLAG_FROM_OTHER_SC)) {
12339			union ctl_ha_msg msg_info;
12340
12341			io->io_hdr.flags |=
12342				CTL_FLAG_SENT_2OTHER_SC;
12343			msg_info.hdr.msg_type =
12344				CTL_MSG_MANAGE_TASKS;
12345			msg_info.hdr.nexus = io->io_hdr.nexus;
12346			msg_info.task.task_action =
12347				CTL_TASK_LUN_RESET;
12348			msg_info.hdr.original_sc = NULL;
12349			msg_info.hdr.serializing_sc = NULL;
12350			if (CTL_HA_STATUS_SUCCESS !=
12351			    ctl_ha_msg_send(CTL_HA_CHAN_CTL,
12352			    (void *)&msg_info,
12353			    sizeof(msg_info), 0)) {
12354			}
12355		}
12356
12357		retval = ctl_lun_reset(lun, io,
12358				       CTL_UA_LUN_RESET);
12359		mtx_unlock(&ctl_softc->ctl_lock);
12360		break;
12361	}
12362	case CTL_TASK_TARGET_RESET:
12363		retval = ctl_target_reset(ctl_softc, io, CTL_UA_TARG_RESET);
12364		break;
12365	case CTL_TASK_BUS_RESET:
12366		retval = ctl_bus_reset(ctl_softc, io);
12367		break;
12368	case CTL_TASK_PORT_LOGIN:
12369		break;
12370	case CTL_TASK_PORT_LOGOUT:
12371		break;
12372	default:
12373		printf("ctl_run_task: got unknown task management event %d\n",
12374		       io->taskio.task_action);
12375		break;
12376	}
12377	if (retval == 0)
12378		io->io_hdr.status = CTL_SUCCESS;
12379	else
12380		io->io_hdr.status = CTL_ERROR;
12381	ctl_done(io);
12382}
12383
12384/*
12385 * For HA operation.  Handle commands that come in from the other
12386 * controller.
12387 */
12388static void
12389ctl_handle_isc(union ctl_io *io)
12390{
12391	int free_io;
12392	struct ctl_lun *lun;
12393	struct ctl_softc *ctl_softc;
12394	uint32_t targ_lun;
12395
12396	ctl_softc = control_softc;
12397
12398	targ_lun = io->io_hdr.nexus.targ_mapped_lun;
12399	lun = ctl_softc->ctl_luns[targ_lun];
12400
12401	switch (io->io_hdr.msg_type) {
12402	case CTL_MSG_SERIALIZE:
12403		free_io = ctl_serialize_other_sc_cmd(&io->scsiio);
12404		break;
12405	case CTL_MSG_R2R: {
12406		const struct ctl_cmd_entry *entry;
12407
12408		/*
12409		 * This is only used in SER_ONLY mode.
12410		 */
12411		free_io = 0;
12412		entry = ctl_get_cmd_entry(&io->scsiio);
12413		mtx_lock(&lun->lun_lock);
12414		if (ctl_scsiio_lun_check(ctl_softc, lun,
12415		    entry, (struct ctl_scsiio *)io) != 0) {
12416			mtx_unlock(&lun->lun_lock);
12417			ctl_done(io);
12418			break;
12419		}
12420		io->io_hdr.flags |= CTL_FLAG_IS_WAS_ON_RTR;
12421		mtx_unlock(&lun->lun_lock);
12422		ctl_enqueue_rtr(io);
12423		break;
12424	}
12425	case CTL_MSG_FINISH_IO:
12426		if (ctl_softc->ha_mode == CTL_HA_MODE_XFER) {
12427			free_io = 0;
12428			ctl_done(io);
12429		} else {
12430			free_io = 1;
12431			mtx_lock(&lun->lun_lock);
12432			TAILQ_REMOVE(&lun->ooa_queue, &io->io_hdr,
12433				     ooa_links);
12434			ctl_check_blocked(lun);
12435			mtx_unlock(&lun->lun_lock);
12436		}
12437		break;
12438	case CTL_MSG_PERS_ACTION:
12439		ctl_hndl_per_res_out_on_other_sc(
12440			(union ctl_ha_msg *)&io->presio.pr_msg);
12441		free_io = 1;
12442		break;
12443	case CTL_MSG_BAD_JUJU:
12444		free_io = 0;
12445		ctl_done(io);
12446		break;
12447	case CTL_MSG_DATAMOVE:
12448		/* Only used in XFER mode */
12449		free_io = 0;
12450		ctl_datamove_remote(io);
12451		break;
12452	case CTL_MSG_DATAMOVE_DONE:
12453		/* Only used in XFER mode */
12454		free_io = 0;
12455		io->scsiio.be_move_done(io);
12456		break;
12457	default:
12458		free_io = 1;
12459		printf("%s: Invalid message type %d\n",
12460		       __func__, io->io_hdr.msg_type);
12461		break;
12462	}
12463	if (free_io)
12464		ctl_free_io(io);
12465
12466}
12467
12468
12469/*
12470 * Returns the match type in the case of a match, or CTL_LUN_PAT_NONE if
12471 * there is no match.
12472 */
12473static ctl_lun_error_pattern
12474ctl_cmd_pattern_match(struct ctl_scsiio *ctsio, struct ctl_error_desc *desc)
12475{
12476	const struct ctl_cmd_entry *entry;
12477	ctl_lun_error_pattern filtered_pattern, pattern;
12478
12479	pattern = desc->error_pattern;
12480
12481	/*
12482	 * XXX KDM we need more data passed into this function to match a
12483	 * custom pattern, and we actually need to implement custom pattern
12484	 * matching.
12485	 */
12486	if (pattern & CTL_LUN_PAT_CMD)
12487		return (CTL_LUN_PAT_CMD);
12488
12489	if ((pattern & CTL_LUN_PAT_MASK) == CTL_LUN_PAT_ANY)
12490		return (CTL_LUN_PAT_ANY);
12491
12492	entry = ctl_get_cmd_entry(ctsio);
12493
12494	filtered_pattern = entry->pattern & pattern;
12495
12496	/*
12497	 * If the user requested specific flags in the pattern (e.g.
12498	 * CTL_LUN_PAT_RANGE), make sure the command supports all of those
12499	 * flags.
12500	 *
12501	 * If the user did not specify any flags, it doesn't matter whether
12502	 * or not the command supports the flags.
12503	 */
12504	if ((filtered_pattern & ~CTL_LUN_PAT_MASK) !=
12505	     (pattern & ~CTL_LUN_PAT_MASK))
12506		return (CTL_LUN_PAT_NONE);
12507
12508	/*
12509	 * If the user asked for a range check, see if the requested LBA
12510	 * range overlaps with this command's LBA range.
12511	 */
12512	if (filtered_pattern & CTL_LUN_PAT_RANGE) {
12513		uint64_t lba1;
12514		uint32_t len1;
12515		ctl_action action;
12516		int retval;
12517
12518		retval = ctl_get_lba_len((union ctl_io *)ctsio, &lba1, &len1);
12519		if (retval != 0)
12520			return (CTL_LUN_PAT_NONE);
12521
12522		action = ctl_extent_check_lba(lba1, len1, desc->lba_range.lba,
12523					      desc->lba_range.len);
12524		/*
12525		 * A "pass" means that the LBA ranges don't overlap, so
12526		 * this doesn't match the user's range criteria.
12527		 */
12528		if (action == CTL_ACTION_PASS)
12529			return (CTL_LUN_PAT_NONE);
12530	}
12531
12532	return (filtered_pattern);
12533}
12534
12535static void
12536ctl_inject_error(struct ctl_lun *lun, union ctl_io *io)
12537{
12538	struct ctl_error_desc *desc, *desc2;
12539
12540	mtx_assert(&lun->lun_lock, MA_OWNED);
12541
12542	STAILQ_FOREACH_SAFE(desc, &lun->error_list, links, desc2) {
12543		ctl_lun_error_pattern pattern;
12544		/*
12545		 * Check to see whether this particular command matches
12546		 * the pattern in the descriptor.
12547		 */
12548		pattern = ctl_cmd_pattern_match(&io->scsiio, desc);
12549		if ((pattern & CTL_LUN_PAT_MASK) == CTL_LUN_PAT_NONE)
12550			continue;
12551
12552		switch (desc->lun_error & CTL_LUN_INJ_TYPE) {
12553		case CTL_LUN_INJ_ABORTED:
12554			ctl_set_aborted(&io->scsiio);
12555			break;
12556		case CTL_LUN_INJ_MEDIUM_ERR:
12557			ctl_set_medium_error(&io->scsiio);
12558			break;
12559		case CTL_LUN_INJ_UA:
12560			/* 29h/00h  POWER ON, RESET, OR BUS DEVICE RESET
12561			 * OCCURRED */
12562			ctl_set_ua(&io->scsiio, 0x29, 0x00);
12563			break;
12564		case CTL_LUN_INJ_CUSTOM:
12565			/*
12566			 * We're assuming the user knows what he is doing.
12567			 * Just copy the sense information without doing
12568			 * checks.
12569			 */
12570			bcopy(&desc->custom_sense, &io->scsiio.sense_data,
12571			      ctl_min(sizeof(desc->custom_sense),
12572				      sizeof(io->scsiio.sense_data)));
12573			io->scsiio.scsi_status = SCSI_STATUS_CHECK_COND;
12574			io->scsiio.sense_len = SSD_FULL_SIZE;
12575			io->io_hdr.status = CTL_SCSI_ERROR | CTL_AUTOSENSE;
12576			break;
12577		case CTL_LUN_INJ_NONE:
12578		default:
12579			/*
12580			 * If this is an error injection type we don't know
12581			 * about, clear the continuous flag (if it is set)
12582			 * so it will get deleted below.
12583			 */
12584			desc->lun_error &= ~CTL_LUN_INJ_CONTINUOUS;
12585			break;
12586		}
12587		/*
12588		 * By default, each error injection action is a one-shot
12589		 */
12590		if (desc->lun_error & CTL_LUN_INJ_CONTINUOUS)
12591			continue;
12592
12593		STAILQ_REMOVE(&lun->error_list, desc, ctl_error_desc, links);
12594
12595		free(desc, M_CTL);
12596	}
12597}
12598
12599#ifdef CTL_IO_DELAY
12600static void
12601ctl_datamove_timer_wakeup(void *arg)
12602{
12603	union ctl_io *io;
12604
12605	io = (union ctl_io *)arg;
12606
12607	ctl_datamove(io);
12608}
12609#endif /* CTL_IO_DELAY */
12610
12611void
12612ctl_datamove(union ctl_io *io)
12613{
12614	void (*fe_datamove)(union ctl_io *io);
12615
12616	mtx_assert(&control_softc->ctl_lock, MA_NOTOWNED);
12617
12618	CTL_DEBUG_PRINT(("ctl_datamove\n"));
12619
12620#ifdef CTL_TIME_IO
12621	if ((time_uptime - io->io_hdr.start_time) > ctl_time_io_secs) {
12622		char str[256];
12623		char path_str[64];
12624		struct sbuf sb;
12625
12626		ctl_scsi_path_string(io, path_str, sizeof(path_str));
12627		sbuf_new(&sb, str, sizeof(str), SBUF_FIXEDLEN);
12628
12629		sbuf_cat(&sb, path_str);
12630		switch (io->io_hdr.io_type) {
12631		case CTL_IO_SCSI:
12632			ctl_scsi_command_string(&io->scsiio, NULL, &sb);
12633			sbuf_printf(&sb, "\n");
12634			sbuf_cat(&sb, path_str);
12635			sbuf_printf(&sb, "Tag: 0x%04x, type %d\n",
12636				    io->scsiio.tag_num, io->scsiio.tag_type);
12637			break;
12638		case CTL_IO_TASK:
12639			sbuf_printf(&sb, "Task I/O type: %d, Tag: 0x%04x, "
12640				    "Tag Type: %d\n", io->taskio.task_action,
12641				    io->taskio.tag_num, io->taskio.tag_type);
12642			break;
12643		default:
12644			printf("Invalid CTL I/O type %d\n", io->io_hdr.io_type);
12645			panic("Invalid CTL I/O type %d\n", io->io_hdr.io_type);
12646			break;
12647		}
12648		sbuf_cat(&sb, path_str);
12649		sbuf_printf(&sb, "ctl_datamove: %jd seconds\n",
12650			    (intmax_t)time_uptime - io->io_hdr.start_time);
12651		sbuf_finish(&sb);
12652		printf("%s", sbuf_data(&sb));
12653	}
12654#endif /* CTL_TIME_IO */
12655
12656#ifdef CTL_IO_DELAY
12657	if (io->io_hdr.flags & CTL_FLAG_DELAY_DONE) {
12658		struct ctl_lun *lun;
12659
12660		lun =(struct ctl_lun *)io->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
12661
12662		io->io_hdr.flags &= ~CTL_FLAG_DELAY_DONE;
12663	} else {
12664		struct ctl_lun *lun;
12665
12666		lun =(struct ctl_lun *)io->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
12667		if ((lun != NULL)
12668		 && (lun->delay_info.datamove_delay > 0)) {
12669			struct callout *callout;
12670
12671			callout = (struct callout *)&io->io_hdr.timer_bytes;
12672			callout_init(callout, /*mpsafe*/ 1);
12673			io->io_hdr.flags |= CTL_FLAG_DELAY_DONE;
12674			callout_reset(callout,
12675				      lun->delay_info.datamove_delay * hz,
12676				      ctl_datamove_timer_wakeup, io);
12677			if (lun->delay_info.datamove_type ==
12678			    CTL_DELAY_TYPE_ONESHOT)
12679				lun->delay_info.datamove_delay = 0;
12680			return;
12681		}
12682	}
12683#endif
12684
12685	/*
12686	 * This command has been aborted.  Set the port status, so we fail
12687	 * the data move.
12688	 */
12689	if (io->io_hdr.flags & CTL_FLAG_ABORT) {
12690		printf("ctl_datamove: tag 0x%04x on (%ju:%d:%ju:%d) aborted\n",
12691		       io->scsiio.tag_num,(uintmax_t)io->io_hdr.nexus.initid.id,
12692		       io->io_hdr.nexus.targ_port,
12693		       (uintmax_t)io->io_hdr.nexus.targ_target.id,
12694		       io->io_hdr.nexus.targ_lun);
12695		io->io_hdr.port_status = 31337;
12696		/*
12697		 * Note that the backend, in this case, will get the
12698		 * callback in its context.  In other cases it may get
12699		 * called in the frontend's interrupt thread context.
12700		 */
12701		io->scsiio.be_move_done(io);
12702		return;
12703	}
12704
12705	/*
12706	 * If we're in XFER mode and this I/O is from the other shelf
12707	 * controller, we need to send the DMA to the other side to
12708	 * actually transfer the data to/from the host.  In serialize only
12709	 * mode the transfer happens below CTL and ctl_datamove() is only
12710	 * called on the machine that originally received the I/O.
12711	 */
12712	if ((control_softc->ha_mode == CTL_HA_MODE_XFER)
12713	 && (io->io_hdr.flags & CTL_FLAG_FROM_OTHER_SC)) {
12714		union ctl_ha_msg msg;
12715		uint32_t sg_entries_sent;
12716		int do_sg_copy;
12717		int i;
12718
12719		memset(&msg, 0, sizeof(msg));
12720		msg.hdr.msg_type = CTL_MSG_DATAMOVE;
12721		msg.hdr.original_sc = io->io_hdr.original_sc;
12722		msg.hdr.serializing_sc = io;
12723		msg.hdr.nexus = io->io_hdr.nexus;
12724		msg.dt.flags = io->io_hdr.flags;
12725		/*
12726		 * We convert everything into a S/G list here.  We can't
12727		 * pass by reference, only by value between controllers.
12728		 * So we can't pass a pointer to the S/G list, only as many
12729		 * S/G entries as we can fit in here.  If it's possible for
12730		 * us to get more than CTL_HA_MAX_SG_ENTRIES S/G entries,
12731		 * then we need to break this up into multiple transfers.
12732		 */
12733		if (io->scsiio.kern_sg_entries == 0) {
12734			msg.dt.kern_sg_entries = 1;
12735			/*
12736			 * If this is in cached memory, flush the cache
12737			 * before we send the DMA request to the other
12738			 * controller.  We want to do this in either the
12739			 * read or the write case.  The read case is
12740			 * straightforward.  In the write case, we want to
12741			 * make sure nothing is in the local cache that
12742			 * could overwrite the DMAed data.
12743			 */
12744			if ((io->io_hdr.flags & CTL_FLAG_NO_DATASYNC) == 0) {
12745				/*
12746				 * XXX KDM use bus_dmamap_sync() here.
12747				 */
12748			}
12749
12750			/*
12751			 * Convert to a physical address if this is a
12752			 * virtual address.
12753			 */
12754			if (io->io_hdr.flags & CTL_FLAG_BUS_ADDR) {
12755				msg.dt.sg_list[0].addr =
12756					io->scsiio.kern_data_ptr;
12757			} else {
12758				/*
12759				 * XXX KDM use busdma here!
12760				 */
12761#if 0
12762				msg.dt.sg_list[0].addr = (void *)
12763					vtophys(io->scsiio.kern_data_ptr);
12764#endif
12765			}
12766
12767			msg.dt.sg_list[0].len = io->scsiio.kern_data_len;
12768			do_sg_copy = 0;
12769		} else {
12770			struct ctl_sg_entry *sgl;
12771
12772			do_sg_copy = 1;
12773			msg.dt.kern_sg_entries = io->scsiio.kern_sg_entries;
12774			sgl = (struct ctl_sg_entry *)io->scsiio.kern_data_ptr;
12775			if ((io->io_hdr.flags & CTL_FLAG_NO_DATASYNC) == 0) {
12776				/*
12777				 * XXX KDM use bus_dmamap_sync() here.
12778				 */
12779			}
12780		}
12781
12782		msg.dt.kern_data_len = io->scsiio.kern_data_len;
12783		msg.dt.kern_total_len = io->scsiio.kern_total_len;
12784		msg.dt.kern_data_resid = io->scsiio.kern_data_resid;
12785		msg.dt.kern_rel_offset = io->scsiio.kern_rel_offset;
12786		msg.dt.sg_sequence = 0;
12787
12788		/*
12789		 * Loop until we've sent all of the S/G entries.  On the
12790		 * other end, we'll recompose these S/G entries into one
12791		 * contiguous list before passing it to the
12792		 */
12793		for (sg_entries_sent = 0; sg_entries_sent <
12794		     msg.dt.kern_sg_entries; msg.dt.sg_sequence++) {
12795			msg.dt.cur_sg_entries = ctl_min((sizeof(msg.dt.sg_list)/
12796				sizeof(msg.dt.sg_list[0])),
12797				msg.dt.kern_sg_entries - sg_entries_sent);
12798
12799			if (do_sg_copy != 0) {
12800				struct ctl_sg_entry *sgl;
12801				int j;
12802
12803				sgl = (struct ctl_sg_entry *)
12804					io->scsiio.kern_data_ptr;
12805				/*
12806				 * If this is in cached memory, flush the cache
12807				 * before we send the DMA request to the other
12808				 * controller.  We want to do this in either
12809				 * the * read or the write case.  The read
12810				 * case is straightforward.  In the write
12811				 * case, we want to make sure nothing is
12812				 * in the local cache that could overwrite
12813				 * the DMAed data.
12814				 */
12815
12816				for (i = sg_entries_sent, j = 0;
12817				     i < msg.dt.cur_sg_entries; i++, j++) {
12818					if ((io->io_hdr.flags &
12819					     CTL_FLAG_NO_DATASYNC) == 0) {
12820						/*
12821						 * XXX KDM use bus_dmamap_sync()
12822						 */
12823					}
12824					if ((io->io_hdr.flags &
12825					     CTL_FLAG_BUS_ADDR) == 0) {
12826						/*
12827						 * XXX KDM use busdma.
12828						 */
12829#if 0
12830						msg.dt.sg_list[j].addr =(void *)
12831						       vtophys(sgl[i].addr);
12832#endif
12833					} else {
12834						msg.dt.sg_list[j].addr =
12835							sgl[i].addr;
12836					}
12837					msg.dt.sg_list[j].len = sgl[i].len;
12838				}
12839			}
12840
12841			sg_entries_sent += msg.dt.cur_sg_entries;
12842			if (sg_entries_sent >= msg.dt.kern_sg_entries)
12843				msg.dt.sg_last = 1;
12844			else
12845				msg.dt.sg_last = 0;
12846
12847			/*
12848			 * XXX KDM drop and reacquire the lock here?
12849			 */
12850			if (ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg,
12851			    sizeof(msg), 0) > CTL_HA_STATUS_SUCCESS) {
12852				/*
12853				 * XXX do something here.
12854				 */
12855			}
12856
12857			msg.dt.sent_sg_entries = sg_entries_sent;
12858		}
12859		io->io_hdr.flags &= ~CTL_FLAG_IO_ACTIVE;
12860		if (io->io_hdr.flags & CTL_FLAG_FAILOVER)
12861			ctl_failover_io(io, /*have_lock*/ 0);
12862
12863	} else {
12864
12865		/*
12866		 * Lookup the fe_datamove() function for this particular
12867		 * front end.
12868		 */
12869		fe_datamove =
12870		    control_softc->ctl_ports[ctl_port_idx(io->io_hdr.nexus.targ_port)]->fe_datamove;
12871
12872		fe_datamove(io);
12873	}
12874}
12875
12876static void
12877ctl_send_datamove_done(union ctl_io *io, int have_lock)
12878{
12879	union ctl_ha_msg msg;
12880	int isc_status;
12881
12882	memset(&msg, 0, sizeof(msg));
12883
12884	msg.hdr.msg_type = CTL_MSG_DATAMOVE_DONE;
12885	msg.hdr.original_sc = io;
12886	msg.hdr.serializing_sc = io->io_hdr.serializing_sc;
12887	msg.hdr.nexus = io->io_hdr.nexus;
12888	msg.hdr.status = io->io_hdr.status;
12889	msg.scsi.tag_num = io->scsiio.tag_num;
12890	msg.scsi.tag_type = io->scsiio.tag_type;
12891	msg.scsi.scsi_status = io->scsiio.scsi_status;
12892	memcpy(&msg.scsi.sense_data, &io->scsiio.sense_data,
12893	       sizeof(io->scsiio.sense_data));
12894	msg.scsi.sense_len = io->scsiio.sense_len;
12895	msg.scsi.sense_residual = io->scsiio.sense_residual;
12896	msg.scsi.fetd_status = io->io_hdr.port_status;
12897	msg.scsi.residual = io->scsiio.residual;
12898	io->io_hdr.flags &= ~CTL_FLAG_IO_ACTIVE;
12899
12900	if (io->io_hdr.flags & CTL_FLAG_FAILOVER) {
12901		ctl_failover_io(io, /*have_lock*/ have_lock);
12902		return;
12903	}
12904
12905	isc_status = ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg, sizeof(msg), 0);
12906	if (isc_status > CTL_HA_STATUS_SUCCESS) {
12907		/* XXX do something if this fails */
12908	}
12909
12910}
12911
12912/*
12913 * The DMA to the remote side is done, now we need to tell the other side
12914 * we're done so it can continue with its data movement.
12915 */
12916static void
12917ctl_datamove_remote_write_cb(struct ctl_ha_dt_req *rq)
12918{
12919	union ctl_io *io;
12920
12921	io = rq->context;
12922
12923	if (rq->ret != CTL_HA_STATUS_SUCCESS) {
12924		printf("%s: ISC DMA write failed with error %d", __func__,
12925		       rq->ret);
12926		ctl_set_internal_failure(&io->scsiio,
12927					 /*sks_valid*/ 1,
12928					 /*retry_count*/ rq->ret);
12929	}
12930
12931	ctl_dt_req_free(rq);
12932
12933	/*
12934	 * In this case, we had to malloc the memory locally.  Free it.
12935	 */
12936	if ((io->io_hdr.flags & CTL_FLAG_AUTO_MIRROR) == 0) {
12937		int i;
12938		for (i = 0; i < io->scsiio.kern_sg_entries; i++)
12939			free(io->io_hdr.local_sglist[i].addr, M_CTL);
12940	}
12941	/*
12942	 * The data is in local and remote memory, so now we need to send
12943	 * status (good or back) back to the other side.
12944	 */
12945	ctl_send_datamove_done(io, /*have_lock*/ 0);
12946}
12947
12948/*
12949 * We've moved the data from the host/controller into local memory.  Now we
12950 * need to push it over to the remote controller's memory.
12951 */
12952static int
12953ctl_datamove_remote_dm_write_cb(union ctl_io *io)
12954{
12955	int retval;
12956
12957	retval = 0;
12958
12959	retval = ctl_datamove_remote_xfer(io, CTL_HA_DT_CMD_WRITE,
12960					  ctl_datamove_remote_write_cb);
12961
12962	return (retval);
12963}
12964
12965static void
12966ctl_datamove_remote_write(union ctl_io *io)
12967{
12968	int retval;
12969	void (*fe_datamove)(union ctl_io *io);
12970
12971	/*
12972	 * - Get the data from the host/HBA into local memory.
12973	 * - DMA memory from the local controller to the remote controller.
12974	 * - Send status back to the remote controller.
12975	 */
12976
12977	retval = ctl_datamove_remote_sgl_setup(io);
12978	if (retval != 0)
12979		return;
12980
12981	/* Switch the pointer over so the FETD knows what to do */
12982	io->scsiio.kern_data_ptr = (uint8_t *)io->io_hdr.local_sglist;
12983
12984	/*
12985	 * Use a custom move done callback, since we need to send completion
12986	 * back to the other controller, not to the backend on this side.
12987	 */
12988	io->scsiio.be_move_done = ctl_datamove_remote_dm_write_cb;
12989
12990	fe_datamove = control_softc->ctl_ports[ctl_port_idx(io->io_hdr.nexus.targ_port)]->fe_datamove;
12991
12992	fe_datamove(io);
12993
12994	return;
12995
12996}
12997
12998static int
12999ctl_datamove_remote_dm_read_cb(union ctl_io *io)
13000{
13001#if 0
13002	char str[256];
13003	char path_str[64];
13004	struct sbuf sb;
13005#endif
13006
13007	/*
13008	 * In this case, we had to malloc the memory locally.  Free it.
13009	 */
13010	if ((io->io_hdr.flags & CTL_FLAG_AUTO_MIRROR) == 0) {
13011		int i;
13012		for (i = 0; i < io->scsiio.kern_sg_entries; i++)
13013			free(io->io_hdr.local_sglist[i].addr, M_CTL);
13014	}
13015
13016#if 0
13017	scsi_path_string(io, path_str, sizeof(path_str));
13018	sbuf_new(&sb, str, sizeof(str), SBUF_FIXEDLEN);
13019	sbuf_cat(&sb, path_str);
13020	scsi_command_string(&io->scsiio, NULL, &sb);
13021	sbuf_printf(&sb, "\n");
13022	sbuf_cat(&sb, path_str);
13023	sbuf_printf(&sb, "Tag: 0x%04x, type %d\n",
13024		    io->scsiio.tag_num, io->scsiio.tag_type);
13025	sbuf_cat(&sb, path_str);
13026	sbuf_printf(&sb, "%s: flags %#x, status %#x\n", __func__,
13027		    io->io_hdr.flags, io->io_hdr.status);
13028	sbuf_finish(&sb);
13029	printk("%s", sbuf_data(&sb));
13030#endif
13031
13032
13033	/*
13034	 * The read is done, now we need to send status (good or bad) back
13035	 * to the other side.
13036	 */
13037	ctl_send_datamove_done(io, /*have_lock*/ 0);
13038
13039	return (0);
13040}
13041
13042static void
13043ctl_datamove_remote_read_cb(struct ctl_ha_dt_req *rq)
13044{
13045	union ctl_io *io;
13046	void (*fe_datamove)(union ctl_io *io);
13047
13048	io = rq->context;
13049
13050	if (rq->ret != CTL_HA_STATUS_SUCCESS) {
13051		printf("%s: ISC DMA read failed with error %d", __func__,
13052		       rq->ret);
13053		ctl_set_internal_failure(&io->scsiio,
13054					 /*sks_valid*/ 1,
13055					 /*retry_count*/ rq->ret);
13056	}
13057
13058	ctl_dt_req_free(rq);
13059
13060	/* Switch the pointer over so the FETD knows what to do */
13061	io->scsiio.kern_data_ptr = (uint8_t *)io->io_hdr.local_sglist;
13062
13063	/*
13064	 * Use a custom move done callback, since we need to send completion
13065	 * back to the other controller, not to the backend on this side.
13066	 */
13067	io->scsiio.be_move_done = ctl_datamove_remote_dm_read_cb;
13068
13069	/* XXX KDM add checks like the ones in ctl_datamove? */
13070
13071	fe_datamove = control_softc->ctl_ports[ctl_port_idx(io->io_hdr.nexus.targ_port)]->fe_datamove;
13072
13073	fe_datamove(io);
13074}
13075
13076static int
13077ctl_datamove_remote_sgl_setup(union ctl_io *io)
13078{
13079	struct ctl_sg_entry *local_sglist, *remote_sglist;
13080	struct ctl_sg_entry *local_dma_sglist, *remote_dma_sglist;
13081	struct ctl_softc *softc;
13082	int retval;
13083	int i;
13084
13085	retval = 0;
13086	softc = control_softc;
13087
13088	local_sglist = io->io_hdr.local_sglist;
13089	local_dma_sglist = io->io_hdr.local_dma_sglist;
13090	remote_sglist = io->io_hdr.remote_sglist;
13091	remote_dma_sglist = io->io_hdr.remote_dma_sglist;
13092
13093	if (io->io_hdr.flags & CTL_FLAG_AUTO_MIRROR) {
13094		for (i = 0; i < io->scsiio.kern_sg_entries; i++) {
13095			local_sglist[i].len = remote_sglist[i].len;
13096
13097			/*
13098			 * XXX Detect the situation where the RS-level I/O
13099			 * redirector on the other side has already read the
13100			 * data off of the AOR RS on this side, and
13101			 * transferred it to remote (mirror) memory on the
13102			 * other side.  Since we already have the data in
13103			 * memory here, we just need to use it.
13104			 *
13105			 * XXX KDM this can probably be removed once we
13106			 * get the cache device code in and take the
13107			 * current AOR implementation out.
13108			 */
13109#ifdef NEEDTOPORT
13110			if ((remote_sglist[i].addr >=
13111			     (void *)vtophys(softc->mirr->addr))
13112			 && (remote_sglist[i].addr <
13113			     ((void *)vtophys(softc->mirr->addr) +
13114			     CacheMirrorOffset))) {
13115				local_sglist[i].addr = remote_sglist[i].addr -
13116					CacheMirrorOffset;
13117				if ((io->io_hdr.flags & CTL_FLAG_DATA_MASK) ==
13118				     CTL_FLAG_DATA_IN)
13119					io->io_hdr.flags |= CTL_FLAG_REDIR_DONE;
13120			} else {
13121				local_sglist[i].addr = remote_sglist[i].addr +
13122					CacheMirrorOffset;
13123			}
13124#endif
13125#if 0
13126			printf("%s: local %p, remote %p, len %d\n",
13127			       __func__, local_sglist[i].addr,
13128			       remote_sglist[i].addr, local_sglist[i].len);
13129#endif
13130		}
13131	} else {
13132		uint32_t len_to_go;
13133
13134		/*
13135		 * In this case, we don't have automatically allocated
13136		 * memory for this I/O on this controller.  This typically
13137		 * happens with internal CTL I/O -- e.g. inquiry, mode
13138		 * sense, etc.  Anything coming from RAIDCore will have
13139		 * a mirror area available.
13140		 */
13141		len_to_go = io->scsiio.kern_data_len;
13142
13143		/*
13144		 * Clear the no datasync flag, we have to use malloced
13145		 * buffers.
13146		 */
13147		io->io_hdr.flags &= ~CTL_FLAG_NO_DATASYNC;
13148
13149		/*
13150		 * The difficult thing here is that the size of the various
13151		 * S/G segments may be different than the size from the
13152		 * remote controller.  That'll make it harder when DMAing
13153		 * the data back to the other side.
13154		 */
13155		for (i = 0; (i < sizeof(io->io_hdr.remote_sglist) /
13156		     sizeof(io->io_hdr.remote_sglist[0])) &&
13157		     (len_to_go > 0); i++) {
13158			local_sglist[i].len = ctl_min(len_to_go, 131072);
13159			CTL_SIZE_8B(local_dma_sglist[i].len,
13160				    local_sglist[i].len);
13161			local_sglist[i].addr =
13162				malloc(local_dma_sglist[i].len, M_CTL,M_WAITOK);
13163
13164			local_dma_sglist[i].addr = local_sglist[i].addr;
13165
13166			if (local_sglist[i].addr == NULL) {
13167				int j;
13168
13169				printf("malloc failed for %zd bytes!",
13170				       local_dma_sglist[i].len);
13171				for (j = 0; j < i; j++) {
13172					free(local_sglist[j].addr, M_CTL);
13173				}
13174				ctl_set_internal_failure(&io->scsiio,
13175							 /*sks_valid*/ 1,
13176							 /*retry_count*/ 4857);
13177				retval = 1;
13178				goto bailout_error;
13179
13180			}
13181			/* XXX KDM do we need a sync here? */
13182
13183			len_to_go -= local_sglist[i].len;
13184		}
13185		/*
13186		 * Reset the number of S/G entries accordingly.  The
13187		 * original number of S/G entries is available in
13188		 * rem_sg_entries.
13189		 */
13190		io->scsiio.kern_sg_entries = i;
13191
13192#if 0
13193		printf("%s: kern_sg_entries = %d\n", __func__,
13194		       io->scsiio.kern_sg_entries);
13195		for (i = 0; i < io->scsiio.kern_sg_entries; i++)
13196			printf("%s: sg[%d] = %p, %d (DMA: %d)\n", __func__, i,
13197			       local_sglist[i].addr, local_sglist[i].len,
13198			       local_dma_sglist[i].len);
13199#endif
13200	}
13201
13202
13203	return (retval);
13204
13205bailout_error:
13206
13207	ctl_send_datamove_done(io, /*have_lock*/ 0);
13208
13209	return (retval);
13210}
13211
13212static int
13213ctl_datamove_remote_xfer(union ctl_io *io, unsigned command,
13214			 ctl_ha_dt_cb callback)
13215{
13216	struct ctl_ha_dt_req *rq;
13217	struct ctl_sg_entry *remote_sglist, *local_sglist;
13218	struct ctl_sg_entry *remote_dma_sglist, *local_dma_sglist;
13219	uint32_t local_used, remote_used, total_used;
13220	int retval;
13221	int i, j;
13222
13223	retval = 0;
13224
13225	rq = ctl_dt_req_alloc();
13226
13227	/*
13228	 * If we failed to allocate the request, and if the DMA didn't fail
13229	 * anyway, set busy status.  This is just a resource allocation
13230	 * failure.
13231	 */
13232	if ((rq == NULL)
13233	 && ((io->io_hdr.status & CTL_STATUS_MASK) != CTL_STATUS_NONE))
13234		ctl_set_busy(&io->scsiio);
13235
13236	if ((io->io_hdr.status & CTL_STATUS_MASK) != CTL_STATUS_NONE) {
13237
13238		if (rq != NULL)
13239			ctl_dt_req_free(rq);
13240
13241		/*
13242		 * The data move failed.  We need to return status back
13243		 * to the other controller.  No point in trying to DMA
13244		 * data to the remote controller.
13245		 */
13246
13247		ctl_send_datamove_done(io, /*have_lock*/ 0);
13248
13249		retval = 1;
13250
13251		goto bailout;
13252	}
13253
13254	local_sglist = io->io_hdr.local_sglist;
13255	local_dma_sglist = io->io_hdr.local_dma_sglist;
13256	remote_sglist = io->io_hdr.remote_sglist;
13257	remote_dma_sglist = io->io_hdr.remote_dma_sglist;
13258	local_used = 0;
13259	remote_used = 0;
13260	total_used = 0;
13261
13262	if (io->io_hdr.flags & CTL_FLAG_REDIR_DONE) {
13263		rq->ret = CTL_HA_STATUS_SUCCESS;
13264		rq->context = io;
13265		callback(rq);
13266		goto bailout;
13267	}
13268
13269	/*
13270	 * Pull/push the data over the wire from/to the other controller.
13271	 * This takes into account the possibility that the local and
13272	 * remote sglists may not be identical in terms of the size of
13273	 * the elements and the number of elements.
13274	 *
13275	 * One fundamental assumption here is that the length allocated for
13276	 * both the local and remote sglists is identical.  Otherwise, we've
13277	 * essentially got a coding error of some sort.
13278	 */
13279	for (i = 0, j = 0; total_used < io->scsiio.kern_data_len; ) {
13280		int isc_ret;
13281		uint32_t cur_len, dma_length;
13282		uint8_t *tmp_ptr;
13283
13284		rq->id = CTL_HA_DATA_CTL;
13285		rq->command = command;
13286		rq->context = io;
13287
13288		/*
13289		 * Both pointers should be aligned.  But it is possible
13290		 * that the allocation length is not.  They should both
13291		 * also have enough slack left over at the end, though,
13292		 * to round up to the next 8 byte boundary.
13293		 */
13294		cur_len = ctl_min(local_sglist[i].len - local_used,
13295				  remote_sglist[j].len - remote_used);
13296
13297		/*
13298		 * In this case, we have a size issue and need to decrease
13299		 * the size, except in the case where we actually have less
13300		 * than 8 bytes left.  In that case, we need to increase
13301		 * the DMA length to get the last bit.
13302		 */
13303		if ((cur_len & 0x7) != 0) {
13304			if (cur_len > 0x7) {
13305				cur_len = cur_len - (cur_len & 0x7);
13306				dma_length = cur_len;
13307			} else {
13308				CTL_SIZE_8B(dma_length, cur_len);
13309			}
13310
13311		} else
13312			dma_length = cur_len;
13313
13314		/*
13315		 * If we had to allocate memory for this I/O, instead of using
13316		 * the non-cached mirror memory, we'll need to flush the cache
13317		 * before trying to DMA to the other controller.
13318		 *
13319		 * We could end up doing this multiple times for the same
13320		 * segment if we have a larger local segment than remote
13321		 * segment.  That shouldn't be an issue.
13322		 */
13323		if ((io->io_hdr.flags & CTL_FLAG_NO_DATASYNC) == 0) {
13324			/*
13325			 * XXX KDM use bus_dmamap_sync() here.
13326			 */
13327		}
13328
13329		rq->size = dma_length;
13330
13331		tmp_ptr = (uint8_t *)local_sglist[i].addr;
13332		tmp_ptr += local_used;
13333
13334		/* Use physical addresses when talking to ISC hardware */
13335		if ((io->io_hdr.flags & CTL_FLAG_BUS_ADDR) == 0) {
13336			/* XXX KDM use busdma */
13337#if 0
13338			rq->local = vtophys(tmp_ptr);
13339#endif
13340		} else
13341			rq->local = tmp_ptr;
13342
13343		tmp_ptr = (uint8_t *)remote_sglist[j].addr;
13344		tmp_ptr += remote_used;
13345		rq->remote = tmp_ptr;
13346
13347		rq->callback = NULL;
13348
13349		local_used += cur_len;
13350		if (local_used >= local_sglist[i].len) {
13351			i++;
13352			local_used = 0;
13353		}
13354
13355		remote_used += cur_len;
13356		if (remote_used >= remote_sglist[j].len) {
13357			j++;
13358			remote_used = 0;
13359		}
13360		total_used += cur_len;
13361
13362		if (total_used >= io->scsiio.kern_data_len)
13363			rq->callback = callback;
13364
13365		if ((rq->size & 0x7) != 0) {
13366			printf("%s: warning: size %d is not on 8b boundary\n",
13367			       __func__, rq->size);
13368		}
13369		if (((uintptr_t)rq->local & 0x7) != 0) {
13370			printf("%s: warning: local %p not on 8b boundary\n",
13371			       __func__, rq->local);
13372		}
13373		if (((uintptr_t)rq->remote & 0x7) != 0) {
13374			printf("%s: warning: remote %p not on 8b boundary\n",
13375			       __func__, rq->local);
13376		}
13377#if 0
13378		printf("%s: %s: local %#x remote %#x size %d\n", __func__,
13379		       (command == CTL_HA_DT_CMD_WRITE) ? "WRITE" : "READ",
13380		       rq->local, rq->remote, rq->size);
13381#endif
13382
13383		isc_ret = ctl_dt_single(rq);
13384		if (isc_ret == CTL_HA_STATUS_WAIT)
13385			continue;
13386
13387		if (isc_ret == CTL_HA_STATUS_DISCONNECT) {
13388			rq->ret = CTL_HA_STATUS_SUCCESS;
13389		} else {
13390			rq->ret = isc_ret;
13391		}
13392		callback(rq);
13393		goto bailout;
13394	}
13395
13396bailout:
13397	return (retval);
13398
13399}
13400
13401static void
13402ctl_datamove_remote_read(union ctl_io *io)
13403{
13404	int retval;
13405	int i;
13406
13407	/*
13408	 * This will send an error to the other controller in the case of a
13409	 * failure.
13410	 */
13411	retval = ctl_datamove_remote_sgl_setup(io);
13412	if (retval != 0)
13413		return;
13414
13415	retval = ctl_datamove_remote_xfer(io, CTL_HA_DT_CMD_READ,
13416					  ctl_datamove_remote_read_cb);
13417	if ((retval != 0)
13418	 && ((io->io_hdr.flags & CTL_FLAG_AUTO_MIRROR) == 0)) {
13419		/*
13420		 * Make sure we free memory if there was an error..  The
13421		 * ctl_datamove_remote_xfer() function will send the
13422		 * datamove done message, or call the callback with an
13423		 * error if there is a problem.
13424		 */
13425		for (i = 0; i < io->scsiio.kern_sg_entries; i++)
13426			free(io->io_hdr.local_sglist[i].addr, M_CTL);
13427	}
13428
13429	return;
13430}
13431
13432/*
13433 * Process a datamove request from the other controller.  This is used for
13434 * XFER mode only, not SER_ONLY mode.  For writes, we DMA into local memory
13435 * first.  Once that is complete, the data gets DMAed into the remote
13436 * controller's memory.  For reads, we DMA from the remote controller's
13437 * memory into our memory first, and then move it out to the FETD.
13438 */
13439static void
13440ctl_datamove_remote(union ctl_io *io)
13441{
13442	struct ctl_softc *softc;
13443
13444	softc = control_softc;
13445
13446	mtx_assert(&softc->ctl_lock, MA_NOTOWNED);
13447
13448	/*
13449	 * Note that we look for an aborted I/O here, but don't do some of
13450	 * the other checks that ctl_datamove() normally does.
13451	 * We don't need to run the datamove delay code, since that should
13452	 * have been done if need be on the other controller.
13453	 */
13454	if (io->io_hdr.flags & CTL_FLAG_ABORT) {
13455		printf("%s: tag 0x%04x on (%d:%d:%d:%d) aborted\n", __func__,
13456		       io->scsiio.tag_num, io->io_hdr.nexus.initid.id,
13457		       io->io_hdr.nexus.targ_port,
13458		       io->io_hdr.nexus.targ_target.id,
13459		       io->io_hdr.nexus.targ_lun);
13460		io->io_hdr.port_status = 31338;
13461		ctl_send_datamove_done(io, /*have_lock*/ 0);
13462		return;
13463	}
13464
13465	if ((io->io_hdr.flags & CTL_FLAG_DATA_MASK) == CTL_FLAG_DATA_OUT) {
13466		ctl_datamove_remote_write(io);
13467	} else if ((io->io_hdr.flags & CTL_FLAG_DATA_MASK) == CTL_FLAG_DATA_IN){
13468		ctl_datamove_remote_read(io);
13469	} else {
13470		union ctl_ha_msg msg;
13471		struct scsi_sense_data *sense;
13472		uint8_t sks[3];
13473		int retry_count;
13474
13475		memset(&msg, 0, sizeof(msg));
13476
13477		msg.hdr.msg_type = CTL_MSG_BAD_JUJU;
13478		msg.hdr.status = CTL_SCSI_ERROR;
13479		msg.scsi.scsi_status = SCSI_STATUS_CHECK_COND;
13480
13481		retry_count = 4243;
13482
13483		sense = &msg.scsi.sense_data;
13484		sks[0] = SSD_SCS_VALID;
13485		sks[1] = (retry_count >> 8) & 0xff;
13486		sks[2] = retry_count & 0xff;
13487
13488		/* "Internal target failure" */
13489		scsi_set_sense_data(sense,
13490				    /*sense_format*/ SSD_TYPE_NONE,
13491				    /*current_error*/ 1,
13492				    /*sense_key*/ SSD_KEY_HARDWARE_ERROR,
13493				    /*asc*/ 0x44,
13494				    /*ascq*/ 0x00,
13495				    /*type*/ SSD_ELEM_SKS,
13496				    /*size*/ sizeof(sks),
13497				    /*data*/ sks,
13498				    SSD_ELEM_NONE);
13499
13500		io->io_hdr.flags &= ~CTL_FLAG_IO_ACTIVE;
13501		if (io->io_hdr.flags & CTL_FLAG_FAILOVER) {
13502			ctl_failover_io(io, /*have_lock*/ 1);
13503			return;
13504		}
13505
13506		if (ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg, sizeof(msg), 0) >
13507		    CTL_HA_STATUS_SUCCESS) {
13508			/* XXX KDM what to do if this fails? */
13509		}
13510		return;
13511	}
13512
13513}
13514
13515static int
13516ctl_process_done(union ctl_io *io)
13517{
13518	struct ctl_lun *lun;
13519	struct ctl_softc *ctl_softc;
13520	void (*fe_done)(union ctl_io *io);
13521	uint32_t targ_port = ctl_port_idx(io->io_hdr.nexus.targ_port);
13522
13523	CTL_DEBUG_PRINT(("ctl_process_done\n"));
13524
13525	fe_done =
13526	    control_softc->ctl_ports[targ_port]->fe_done;
13527
13528#ifdef CTL_TIME_IO
13529	if ((time_uptime - io->io_hdr.start_time) > ctl_time_io_secs) {
13530		char str[256];
13531		char path_str[64];
13532		struct sbuf sb;
13533
13534		ctl_scsi_path_string(io, path_str, sizeof(path_str));
13535		sbuf_new(&sb, str, sizeof(str), SBUF_FIXEDLEN);
13536
13537		sbuf_cat(&sb, path_str);
13538		switch (io->io_hdr.io_type) {
13539		case CTL_IO_SCSI:
13540			ctl_scsi_command_string(&io->scsiio, NULL, &sb);
13541			sbuf_printf(&sb, "\n");
13542			sbuf_cat(&sb, path_str);
13543			sbuf_printf(&sb, "Tag: 0x%04x, type %d\n",
13544				    io->scsiio.tag_num, io->scsiio.tag_type);
13545			break;
13546		case CTL_IO_TASK:
13547			sbuf_printf(&sb, "Task I/O type: %d, Tag: 0x%04x, "
13548				    "Tag Type: %d\n", io->taskio.task_action,
13549				    io->taskio.tag_num, io->taskio.tag_type);
13550			break;
13551		default:
13552			printf("Invalid CTL I/O type %d\n", io->io_hdr.io_type);
13553			panic("Invalid CTL I/O type %d\n", io->io_hdr.io_type);
13554			break;
13555		}
13556		sbuf_cat(&sb, path_str);
13557		sbuf_printf(&sb, "ctl_process_done: %jd seconds\n",
13558			    (intmax_t)time_uptime - io->io_hdr.start_time);
13559		sbuf_finish(&sb);
13560		printf("%s", sbuf_data(&sb));
13561	}
13562#endif /* CTL_TIME_IO */
13563
13564	switch (io->io_hdr.io_type) {
13565	case CTL_IO_SCSI:
13566		break;
13567	case CTL_IO_TASK:
13568		if (bootverbose || verbose > 0)
13569			ctl_io_error_print(io, NULL);
13570		if (io->io_hdr.flags & CTL_FLAG_FROM_OTHER_SC)
13571			ctl_free_io(io);
13572		else
13573			fe_done(io);
13574		return (CTL_RETVAL_COMPLETE);
13575		break;
13576	default:
13577		printf("ctl_process_done: invalid io type %d\n",
13578		       io->io_hdr.io_type);
13579		panic("ctl_process_done: invalid io type %d\n",
13580		      io->io_hdr.io_type);
13581		break; /* NOTREACHED */
13582	}
13583
13584	lun = (struct ctl_lun *)io->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
13585	if (lun == NULL) {
13586		CTL_DEBUG_PRINT(("NULL LUN for lun %d\n",
13587				 io->io_hdr.nexus.targ_mapped_lun));
13588		fe_done(io);
13589		goto bailout;
13590	}
13591	ctl_softc = lun->ctl_softc;
13592
13593	mtx_lock(&lun->lun_lock);
13594
13595	/*
13596	 * Check to see if we have any errors to inject here.  We only
13597	 * inject errors for commands that don't already have errors set.
13598	 */
13599	if ((STAILQ_FIRST(&lun->error_list) != NULL)
13600	 && ((io->io_hdr.status & CTL_STATUS_MASK) == CTL_SUCCESS))
13601		ctl_inject_error(lun, io);
13602
13603	/*
13604	 * XXX KDM how do we treat commands that aren't completed
13605	 * successfully?
13606	 *
13607	 * XXX KDM should we also track I/O latency?
13608	 */
13609	if ((io->io_hdr.status & CTL_STATUS_MASK) == CTL_SUCCESS &&
13610	    io->io_hdr.io_type == CTL_IO_SCSI) {
13611#ifdef CTL_TIME_IO
13612		struct bintime cur_bt;
13613#endif
13614		int type;
13615
13616		if ((io->io_hdr.flags & CTL_FLAG_DATA_MASK) ==
13617		    CTL_FLAG_DATA_IN)
13618			type = CTL_STATS_READ;
13619		else if ((io->io_hdr.flags & CTL_FLAG_DATA_MASK) ==
13620		    CTL_FLAG_DATA_OUT)
13621			type = CTL_STATS_WRITE;
13622		else
13623			type = CTL_STATS_NO_IO;
13624
13625		lun->stats.ports[targ_port].bytes[type] +=
13626		    io->scsiio.kern_total_len;
13627		lun->stats.ports[targ_port].operations[type]++;
13628#ifdef CTL_TIME_IO
13629		bintime_add(&lun->stats.ports[targ_port].dma_time[type],
13630		   &io->io_hdr.dma_bt);
13631		lun->stats.ports[targ_port].num_dmas[type] +=
13632		    io->io_hdr.num_dmas;
13633		getbintime(&cur_bt);
13634		bintime_sub(&cur_bt, &io->io_hdr.start_bt);
13635		bintime_add(&lun->stats.ports[targ_port].time[type], &cur_bt);
13636#endif
13637	}
13638
13639	/*
13640	 * Remove this from the OOA queue.
13641	 */
13642	TAILQ_REMOVE(&lun->ooa_queue, &io->io_hdr, ooa_links);
13643
13644	/*
13645	 * Run through the blocked queue on this LUN and see if anything
13646	 * has become unblocked, now that this transaction is done.
13647	 */
13648	ctl_check_blocked(lun);
13649
13650	/*
13651	 * If the LUN has been invalidated, free it if there is nothing
13652	 * left on its OOA queue.
13653	 */
13654	if ((lun->flags & CTL_LUN_INVALID)
13655	 && TAILQ_EMPTY(&lun->ooa_queue)) {
13656		mtx_unlock(&lun->lun_lock);
13657		mtx_lock(&ctl_softc->ctl_lock);
13658		ctl_free_lun(lun);
13659		mtx_unlock(&ctl_softc->ctl_lock);
13660	} else
13661		mtx_unlock(&lun->lun_lock);
13662
13663	/*
13664	 * If this command has been aborted, make sure we set the status
13665	 * properly.  The FETD is responsible for freeing the I/O and doing
13666	 * whatever it needs to do to clean up its state.
13667	 */
13668	if (io->io_hdr.flags & CTL_FLAG_ABORT)
13669		ctl_set_task_aborted(&io->scsiio);
13670
13671	/*
13672	 * We print out status for every task management command.  For SCSI
13673	 * commands, we filter out any unit attention errors; they happen
13674	 * on every boot, and would clutter up the log.  Note:  task
13675	 * management commands aren't printed here, they are printed above,
13676	 * since they should never even make it down here.
13677	 */
13678	switch (io->io_hdr.io_type) {
13679	case CTL_IO_SCSI: {
13680		int error_code, sense_key, asc, ascq;
13681
13682		sense_key = 0;
13683
13684		if (((io->io_hdr.status & CTL_STATUS_MASK) == CTL_SCSI_ERROR)
13685		 && (io->scsiio.scsi_status == SCSI_STATUS_CHECK_COND)) {
13686			/*
13687			 * Since this is just for printing, no need to
13688			 * show errors here.
13689			 */
13690			scsi_extract_sense_len(&io->scsiio.sense_data,
13691					       io->scsiio.sense_len,
13692					       &error_code,
13693					       &sense_key,
13694					       &asc,
13695					       &ascq,
13696					       /*show_errors*/ 0);
13697		}
13698
13699		if (((io->io_hdr.status & CTL_STATUS_MASK) != CTL_SUCCESS)
13700		 && (((io->io_hdr.status & CTL_STATUS_MASK) != CTL_SCSI_ERROR)
13701		  || (io->scsiio.scsi_status != SCSI_STATUS_CHECK_COND)
13702		  || (sense_key != SSD_KEY_UNIT_ATTENTION))) {
13703
13704			if ((time_uptime - ctl_softc->last_print_jiffies) <= 0){
13705				ctl_softc->skipped_prints++;
13706			} else {
13707				uint32_t skipped_prints;
13708
13709				skipped_prints = ctl_softc->skipped_prints;
13710
13711				ctl_softc->skipped_prints = 0;
13712				ctl_softc->last_print_jiffies = time_uptime;
13713
13714				if (skipped_prints > 0) {
13715#ifdef NEEDTOPORT
13716					csevent_log(CSC_CTL | CSC_SHELF_SW |
13717					    CTL_ERROR_REPORT,
13718					    csevent_LogType_Trace,
13719					    csevent_Severity_Information,
13720					    csevent_AlertLevel_Green,
13721					    csevent_FRU_Firmware,
13722					    csevent_FRU_Unknown,
13723					    "High CTL error volume, %d prints "
13724					    "skipped", skipped_prints);
13725#endif
13726				}
13727				if (bootverbose || verbose > 0)
13728					ctl_io_error_print(io, NULL);
13729			}
13730		}
13731		break;
13732	}
13733	case CTL_IO_TASK:
13734		if (bootverbose || verbose > 0)
13735			ctl_io_error_print(io, NULL);
13736		break;
13737	default:
13738		break;
13739	}
13740
13741	/*
13742	 * Tell the FETD or the other shelf controller we're done with this
13743	 * command.  Note that only SCSI commands get to this point.  Task
13744	 * management commands are completed above.
13745	 *
13746	 * We only send status to the other controller if we're in XFER
13747	 * mode.  In SER_ONLY mode, the I/O is done on the controller that
13748	 * received the I/O (from CTL's perspective), and so the status is
13749	 * generated there.
13750	 *
13751	 * XXX KDM if we hold the lock here, we could cause a deadlock
13752	 * if the frontend comes back in in this context to queue
13753	 * something.
13754	 */
13755	if ((ctl_softc->ha_mode == CTL_HA_MODE_XFER)
13756	 && (io->io_hdr.flags & CTL_FLAG_FROM_OTHER_SC)) {
13757		union ctl_ha_msg msg;
13758
13759		memset(&msg, 0, sizeof(msg));
13760		msg.hdr.msg_type = CTL_MSG_FINISH_IO;
13761		msg.hdr.original_sc = io->io_hdr.original_sc;
13762		msg.hdr.nexus = io->io_hdr.nexus;
13763		msg.hdr.status = io->io_hdr.status;
13764		msg.scsi.scsi_status = io->scsiio.scsi_status;
13765		msg.scsi.tag_num = io->scsiio.tag_num;
13766		msg.scsi.tag_type = io->scsiio.tag_type;
13767		msg.scsi.sense_len = io->scsiio.sense_len;
13768		msg.scsi.sense_residual = io->scsiio.sense_residual;
13769		msg.scsi.residual = io->scsiio.residual;
13770		memcpy(&msg.scsi.sense_data, &io->scsiio.sense_data,
13771		       sizeof(io->scsiio.sense_data));
13772		/*
13773		 * We copy this whether or not this is an I/O-related
13774		 * command.  Otherwise, we'd have to go and check to see
13775		 * whether it's a read/write command, and it really isn't
13776		 * worth it.
13777		 */
13778		memcpy(&msg.scsi.lbalen,
13779		       &io->io_hdr.ctl_private[CTL_PRIV_LBA_LEN].bytes,
13780		       sizeof(msg.scsi.lbalen));
13781
13782		if (ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg,
13783				sizeof(msg), 0) > CTL_HA_STATUS_SUCCESS) {
13784			/* XXX do something here */
13785		}
13786
13787		ctl_free_io(io);
13788	} else
13789		fe_done(io);
13790
13791bailout:
13792
13793	return (CTL_RETVAL_COMPLETE);
13794}
13795
13796#ifdef CTL_WITH_CA
13797/*
13798 * Front end should call this if it doesn't do autosense.  When the request
13799 * sense comes back in from the initiator, we'll dequeue this and send it.
13800 */
13801int
13802ctl_queue_sense(union ctl_io *io)
13803{
13804	struct ctl_lun *lun;
13805	struct ctl_softc *ctl_softc;
13806	uint32_t initidx, targ_lun;
13807
13808	ctl_softc = control_softc;
13809
13810	CTL_DEBUG_PRINT(("ctl_queue_sense\n"));
13811
13812	/*
13813	 * LUN lookup will likely move to the ctl_work_thread() once we
13814	 * have our new queueing infrastructure (that doesn't put things on
13815	 * a per-LUN queue initially).  That is so that we can handle
13816	 * things like an INQUIRY to a LUN that we don't have enabled.  We
13817	 * can't deal with that right now.
13818	 */
13819	mtx_lock(&ctl_softc->ctl_lock);
13820
13821	/*
13822	 * If we don't have a LUN for this, just toss the sense
13823	 * information.
13824	 */
13825	targ_lun = io->io_hdr.nexus.targ_lun;
13826	targ_lun = ctl_map_lun(io->io_hdr.nexus.targ_port, targ_lun);
13827	if ((targ_lun < CTL_MAX_LUNS)
13828	 && (ctl_softc->ctl_luns[targ_lun] != NULL))
13829		lun = ctl_softc->ctl_luns[targ_lun];
13830	else
13831		goto bailout;
13832
13833	initidx = ctl_get_initindex(&io->io_hdr.nexus);
13834
13835	mtx_lock(&lun->lun_lock);
13836	/*
13837	 * Already have CA set for this LUN...toss the sense information.
13838	 */
13839	if (ctl_is_set(lun->have_ca, initidx)) {
13840		mtx_unlock(&lun->lun_lock);
13841		goto bailout;
13842	}
13843
13844	memcpy(&lun->pending_sense[initidx], &io->scsiio.sense_data,
13845	       ctl_min(sizeof(lun->pending_sense[initidx]),
13846	       sizeof(io->scsiio.sense_data)));
13847	ctl_set_mask(lun->have_ca, initidx);
13848	mtx_unlock(&lun->lun_lock);
13849
13850bailout:
13851	mtx_unlock(&ctl_softc->ctl_lock);
13852
13853	ctl_free_io(io);
13854
13855	return (CTL_RETVAL_COMPLETE);
13856}
13857#endif
13858
13859/*
13860 * Primary command inlet from frontend ports.  All SCSI and task I/O
13861 * requests must go through this function.
13862 */
13863int
13864ctl_queue(union ctl_io *io)
13865{
13866	struct ctl_softc *ctl_softc;
13867
13868	CTL_DEBUG_PRINT(("ctl_queue cdb[0]=%02X\n", io->scsiio.cdb[0]));
13869
13870	ctl_softc = control_softc;
13871
13872#ifdef CTL_TIME_IO
13873	io->io_hdr.start_time = time_uptime;
13874	getbintime(&io->io_hdr.start_bt);
13875#endif /* CTL_TIME_IO */
13876
13877	/* Map FE-specific LUN ID into global one. */
13878	io->io_hdr.nexus.targ_mapped_lun =
13879	    ctl_map_lun(io->io_hdr.nexus.targ_port, io->io_hdr.nexus.targ_lun);
13880
13881	switch (io->io_hdr.io_type) {
13882	case CTL_IO_SCSI:
13883	case CTL_IO_TASK:
13884		ctl_enqueue_incoming(io);
13885		break;
13886	default:
13887		printf("ctl_queue: unknown I/O type %d\n", io->io_hdr.io_type);
13888		return (EINVAL);
13889	}
13890
13891	return (CTL_RETVAL_COMPLETE);
13892}
13893
13894#ifdef CTL_IO_DELAY
13895static void
13896ctl_done_timer_wakeup(void *arg)
13897{
13898	union ctl_io *io;
13899
13900	io = (union ctl_io *)arg;
13901	ctl_done(io);
13902}
13903#endif /* CTL_IO_DELAY */
13904
13905void
13906ctl_done(union ctl_io *io)
13907{
13908	struct ctl_softc *ctl_softc;
13909
13910	ctl_softc = control_softc;
13911
13912	/*
13913	 * Enable this to catch duplicate completion issues.
13914	 */
13915#if 0
13916	if (io->io_hdr.flags & CTL_FLAG_ALREADY_DONE) {
13917		printf("%s: type %d msg %d cdb %x iptl: "
13918		       "%d:%d:%d:%d tag 0x%04x "
13919		       "flag %#x status %x\n",
13920			__func__,
13921			io->io_hdr.io_type,
13922			io->io_hdr.msg_type,
13923			io->scsiio.cdb[0],
13924			io->io_hdr.nexus.initid.id,
13925			io->io_hdr.nexus.targ_port,
13926			io->io_hdr.nexus.targ_target.id,
13927			io->io_hdr.nexus.targ_lun,
13928			(io->io_hdr.io_type ==
13929			CTL_IO_TASK) ?
13930			io->taskio.tag_num :
13931			io->scsiio.tag_num,
13932		        io->io_hdr.flags,
13933			io->io_hdr.status);
13934	} else
13935		io->io_hdr.flags |= CTL_FLAG_ALREADY_DONE;
13936#endif
13937
13938	/*
13939	 * This is an internal copy of an I/O, and should not go through
13940	 * the normal done processing logic.
13941	 */
13942	if (io->io_hdr.flags & CTL_FLAG_INT_COPY)
13943		return;
13944
13945	/*
13946	 * We need to send a msg to the serializing shelf to finish the IO
13947	 * as well.  We don't send a finish message to the other shelf if
13948	 * this is a task management command.  Task management commands
13949	 * aren't serialized in the OOA queue, but rather just executed on
13950	 * both shelf controllers for commands that originated on that
13951	 * controller.
13952	 */
13953	if ((io->io_hdr.flags & CTL_FLAG_SENT_2OTHER_SC)
13954	 && (io->io_hdr.io_type != CTL_IO_TASK)) {
13955		union ctl_ha_msg msg_io;
13956
13957		msg_io.hdr.msg_type = CTL_MSG_FINISH_IO;
13958		msg_io.hdr.serializing_sc = io->io_hdr.serializing_sc;
13959		if (ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg_io,
13960		    sizeof(msg_io), 0 ) != CTL_HA_STATUS_SUCCESS) {
13961		}
13962		/* continue on to finish IO */
13963	}
13964#ifdef CTL_IO_DELAY
13965	if (io->io_hdr.flags & CTL_FLAG_DELAY_DONE) {
13966		struct ctl_lun *lun;
13967
13968		lun =(struct ctl_lun *)io->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
13969
13970		io->io_hdr.flags &= ~CTL_FLAG_DELAY_DONE;
13971	} else {
13972		struct ctl_lun *lun;
13973
13974		lun =(struct ctl_lun *)io->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
13975
13976		if ((lun != NULL)
13977		 && (lun->delay_info.done_delay > 0)) {
13978			struct callout *callout;
13979
13980			callout = (struct callout *)&io->io_hdr.timer_bytes;
13981			callout_init(callout, /*mpsafe*/ 1);
13982			io->io_hdr.flags |= CTL_FLAG_DELAY_DONE;
13983			callout_reset(callout,
13984				      lun->delay_info.done_delay * hz,
13985				      ctl_done_timer_wakeup, io);
13986			if (lun->delay_info.done_type == CTL_DELAY_TYPE_ONESHOT)
13987				lun->delay_info.done_delay = 0;
13988			return;
13989		}
13990	}
13991#endif /* CTL_IO_DELAY */
13992
13993	ctl_enqueue_done(io);
13994}
13995
13996int
13997ctl_isc(struct ctl_scsiio *ctsio)
13998{
13999	struct ctl_lun *lun;
14000	int retval;
14001
14002	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
14003
14004	CTL_DEBUG_PRINT(("ctl_isc: command: %02x\n", ctsio->cdb[0]));
14005
14006	CTL_DEBUG_PRINT(("ctl_isc: calling data_submit()\n"));
14007
14008	retval = lun->backend->data_submit((union ctl_io *)ctsio);
14009
14010	return (retval);
14011}
14012
14013
14014static void
14015ctl_work_thread(void *arg)
14016{
14017	struct ctl_thread *thr = (struct ctl_thread *)arg;
14018	struct ctl_softc *softc = thr->ctl_softc;
14019	union ctl_io *io;
14020	int retval;
14021
14022	CTL_DEBUG_PRINT(("ctl_work_thread starting\n"));
14023
14024	for (;;) {
14025		retval = 0;
14026
14027		/*
14028		 * We handle the queues in this order:
14029		 * - ISC
14030		 * - done queue (to free up resources, unblock other commands)
14031		 * - RtR queue
14032		 * - incoming queue
14033		 *
14034		 * If those queues are empty, we break out of the loop and
14035		 * go to sleep.
14036		 */
14037		mtx_lock(&thr->queue_lock);
14038		io = (union ctl_io *)STAILQ_FIRST(&thr->isc_queue);
14039		if (io != NULL) {
14040			STAILQ_REMOVE_HEAD(&thr->isc_queue, links);
14041			mtx_unlock(&thr->queue_lock);
14042			ctl_handle_isc(io);
14043			continue;
14044		}
14045		io = (union ctl_io *)STAILQ_FIRST(&thr->done_queue);
14046		if (io != NULL) {
14047			STAILQ_REMOVE_HEAD(&thr->done_queue, links);
14048			/* clear any blocked commands, call fe_done */
14049			mtx_unlock(&thr->queue_lock);
14050			retval = ctl_process_done(io);
14051			continue;
14052		}
14053		io = (union ctl_io *)STAILQ_FIRST(&thr->incoming_queue);
14054		if (io != NULL) {
14055			STAILQ_REMOVE_HEAD(&thr->incoming_queue, links);
14056			mtx_unlock(&thr->queue_lock);
14057			if (io->io_hdr.io_type == CTL_IO_TASK)
14058				ctl_run_task(io);
14059			else
14060				ctl_scsiio_precheck(softc, &io->scsiio);
14061			continue;
14062		}
14063		if (!ctl_pause_rtr) {
14064			io = (union ctl_io *)STAILQ_FIRST(&thr->rtr_queue);
14065			if (io != NULL) {
14066				STAILQ_REMOVE_HEAD(&thr->rtr_queue, links);
14067				mtx_unlock(&thr->queue_lock);
14068				retval = ctl_scsiio(&io->scsiio);
14069				if (retval != CTL_RETVAL_COMPLETE)
14070					CTL_DEBUG_PRINT(("ctl_scsiio failed\n"));
14071				continue;
14072			}
14073		}
14074
14075		/* Sleep until we have something to do. */
14076		mtx_sleep(thr, &thr->queue_lock, PDROP | PRIBIO, "-", 0);
14077	}
14078}
14079
14080static void
14081ctl_lun_thread(void *arg)
14082{
14083	struct ctl_softc *softc = (struct ctl_softc *)arg;
14084	struct ctl_be_lun *be_lun;
14085	int retval;
14086
14087	CTL_DEBUG_PRINT(("ctl_lun_thread starting\n"));
14088
14089	for (;;) {
14090		retval = 0;
14091		mtx_lock(&softc->ctl_lock);
14092		be_lun = STAILQ_FIRST(&softc->pending_lun_queue);
14093		if (be_lun != NULL) {
14094			STAILQ_REMOVE_HEAD(&softc->pending_lun_queue, links);
14095			mtx_unlock(&softc->ctl_lock);
14096			ctl_create_lun(be_lun);
14097			continue;
14098		}
14099
14100		/* Sleep until we have something to do. */
14101		mtx_sleep(&softc->pending_lun_queue, &softc->ctl_lock,
14102		    PDROP | PRIBIO, "-", 0);
14103	}
14104}
14105
14106static void
14107ctl_enqueue_incoming(union ctl_io *io)
14108{
14109	struct ctl_softc *softc = control_softc;
14110	struct ctl_thread *thr;
14111	u_int idx;
14112
14113	idx = (io->io_hdr.nexus.targ_port * 127 +
14114	       io->io_hdr.nexus.initid.id) % worker_threads;
14115	thr = &softc->threads[idx];
14116	mtx_lock(&thr->queue_lock);
14117	STAILQ_INSERT_TAIL(&thr->incoming_queue, &io->io_hdr, links);
14118	mtx_unlock(&thr->queue_lock);
14119	wakeup(thr);
14120}
14121
14122static void
14123ctl_enqueue_rtr(union ctl_io *io)
14124{
14125	struct ctl_softc *softc = control_softc;
14126	struct ctl_thread *thr;
14127
14128	thr = &softc->threads[io->io_hdr.nexus.targ_mapped_lun % worker_threads];
14129	mtx_lock(&thr->queue_lock);
14130	STAILQ_INSERT_TAIL(&thr->rtr_queue, &io->io_hdr, links);
14131	mtx_unlock(&thr->queue_lock);
14132	wakeup(thr);
14133}
14134
14135static void
14136ctl_enqueue_done(union ctl_io *io)
14137{
14138	struct ctl_softc *softc = control_softc;
14139	struct ctl_thread *thr;
14140
14141	thr = &softc->threads[io->io_hdr.nexus.targ_mapped_lun % worker_threads];
14142	mtx_lock(&thr->queue_lock);
14143	STAILQ_INSERT_TAIL(&thr->done_queue, &io->io_hdr, links);
14144	mtx_unlock(&thr->queue_lock);
14145	wakeup(thr);
14146}
14147
14148static void
14149ctl_enqueue_isc(union ctl_io *io)
14150{
14151	struct ctl_softc *softc = control_softc;
14152	struct ctl_thread *thr;
14153
14154	thr = &softc->threads[io->io_hdr.nexus.targ_mapped_lun % worker_threads];
14155	mtx_lock(&thr->queue_lock);
14156	STAILQ_INSERT_TAIL(&thr->isc_queue, &io->io_hdr, links);
14157	mtx_unlock(&thr->queue_lock);
14158	wakeup(thr);
14159}
14160
14161/* Initialization and failover */
14162
14163void
14164ctl_init_isc_msg(void)
14165{
14166	printf("CTL: Still calling this thing\n");
14167}
14168
14169/*
14170 * Init component
14171 * 	Initializes component into configuration defined by bootMode
14172 *	(see hasc-sv.c)
14173 *  	returns hasc_Status:
14174 * 		OK
14175 *		ERROR - fatal error
14176 */
14177static ctl_ha_comp_status
14178ctl_isc_init(struct ctl_ha_component *c)
14179{
14180	ctl_ha_comp_status ret = CTL_HA_COMP_STATUS_OK;
14181
14182	c->status = ret;
14183	return ret;
14184}
14185
14186/* Start component
14187 * 	Starts component in state requested. If component starts successfully,
14188 *	it must set its own state to the requestrd state
14189 *	When requested state is HASC_STATE_HA, the component may refine it
14190 * 	by adding _SLAVE or _MASTER flags.
14191 *	Currently allowed state transitions are:
14192 *	UNKNOWN->HA		- initial startup
14193 *	UNKNOWN->SINGLE - initial startup when no parter detected
14194 *	HA->SINGLE		- failover
14195 * returns ctl_ha_comp_status:
14196 * 		OK	- component successfully started in requested state
14197 *		FAILED  - could not start the requested state, failover may
14198 * 			  be possible
14199 *		ERROR	- fatal error detected, no future startup possible
14200 */
14201static ctl_ha_comp_status
14202ctl_isc_start(struct ctl_ha_component *c, ctl_ha_state state)
14203{
14204	ctl_ha_comp_status ret = CTL_HA_COMP_STATUS_OK;
14205
14206	printf("%s: go\n", __func__);
14207
14208	// UNKNOWN->HA or UNKNOWN->SINGLE (bootstrap)
14209	if (c->state == CTL_HA_STATE_UNKNOWN ) {
14210		ctl_is_single = 0;
14211		if (ctl_ha_msg_create(CTL_HA_CHAN_CTL, ctl_isc_event_handler)
14212		    != CTL_HA_STATUS_SUCCESS) {
14213			printf("ctl_isc_start: ctl_ha_msg_create failed.\n");
14214			ret = CTL_HA_COMP_STATUS_ERROR;
14215		}
14216	} else if (CTL_HA_STATE_IS_HA(c->state)
14217		&& CTL_HA_STATE_IS_SINGLE(state)){
14218		// HA->SINGLE transition
14219	        ctl_failover();
14220		ctl_is_single = 1;
14221	} else {
14222		printf("ctl_isc_start:Invalid state transition %X->%X\n",
14223		       c->state, state);
14224		ret = CTL_HA_COMP_STATUS_ERROR;
14225	}
14226	if (CTL_HA_STATE_IS_SINGLE(state))
14227		ctl_is_single = 1;
14228
14229	c->state = state;
14230	c->status = ret;
14231	return ret;
14232}
14233
14234/*
14235 * Quiesce component
14236 * The component must clear any error conditions (set status to OK) and
14237 * prepare itself to another Start call
14238 * returns ctl_ha_comp_status:
14239 * 	OK
14240 *	ERROR
14241 */
14242static ctl_ha_comp_status
14243ctl_isc_quiesce(struct ctl_ha_component *c)
14244{
14245	int ret = CTL_HA_COMP_STATUS_OK;
14246
14247	ctl_pause_rtr = 1;
14248	c->status = ret;
14249	return ret;
14250}
14251
14252struct ctl_ha_component ctl_ha_component_ctlisc =
14253{
14254	.name = "CTL ISC",
14255	.state = CTL_HA_STATE_UNKNOWN,
14256	.init = ctl_isc_init,
14257	.start = ctl_isc_start,
14258	.quiesce = ctl_isc_quiesce
14259};
14260
14261/*
14262 *  vim: ts=8
14263 */
14264