ctl.c revision 268551
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: stable/10/sys/cam/ctl/ctl.c 268551 2014-07-12 02:26:11Z 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 * The default is to run with CTL_DONE_THREAD turned on.  Completed
87 * transactions are queued for processing by the CTL work thread.  When
88 * CTL_DONE_THREAD is not defined, completed transactions are processed in
89 * the caller's context.
90 */
91#define CTL_DONE_THREAD
92
93/*
94 * Use the serial number and device ID provided by the backend, rather than
95 * making up our own.
96 */
97#define CTL_USE_BACKEND_SN
98
99/*
100 * Size and alignment macros needed for Copan-specific HA hardware.  These
101 * can go away when the HA code is re-written, and uses busdma for any
102 * hardware.
103 */
104#define	CTL_ALIGN_8B(target, source, type)				\
105	if (((uint32_t)source & 0x7) != 0)				\
106		target = (type)(source + (0x8 - ((uint32_t)source & 0x7)));\
107	else								\
108		target = (type)source;
109
110#define	CTL_SIZE_8B(target, size)					\
111	if ((size & 0x7) != 0)						\
112		target = size + (0x8 - (size & 0x7));			\
113	else								\
114		target = size;
115
116#define CTL_ALIGN_8B_MARGIN	16
117
118/*
119 * Template mode pages.
120 */
121
122/*
123 * Note that these are default values only.  The actual values will be
124 * filled in when the user does a mode sense.
125 */
126static struct copan_power_subpage power_page_default = {
127	/*page_code*/ PWR_PAGE_CODE | SMPH_SPF,
128	/*subpage*/ PWR_SUBPAGE_CODE,
129	/*page_length*/ {(sizeof(struct copan_power_subpage) - 4) & 0xff00,
130			 (sizeof(struct copan_power_subpage) - 4) & 0x00ff},
131	/*page_version*/ PWR_VERSION,
132	/* total_luns */ 26,
133	/* max_active_luns*/ PWR_DFLT_MAX_LUNS,
134	/*reserved*/ {0, 0, 0, 0, 0, 0, 0, 0, 0,
135		      0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
136		      0, 0, 0, 0, 0, 0}
137};
138
139static struct copan_power_subpage power_page_changeable = {
140	/*page_code*/ PWR_PAGE_CODE | SMPH_SPF,
141	/*subpage*/ PWR_SUBPAGE_CODE,
142	/*page_length*/ {(sizeof(struct copan_power_subpage) - 4) & 0xff00,
143			 (sizeof(struct copan_power_subpage) - 4) & 0x00ff},
144	/*page_version*/ 0,
145	/* total_luns */ 0,
146	/* max_active_luns*/ 0,
147	/*reserved*/ {0, 0, 0, 0, 0, 0, 0, 0, 0,
148		      0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
149		      0, 0, 0, 0, 0, 0}
150};
151
152static struct copan_aps_subpage aps_page_default = {
153	APS_PAGE_CODE | SMPH_SPF, //page_code
154	APS_SUBPAGE_CODE, //subpage
155	{(sizeof(struct copan_aps_subpage) - 4) & 0xff00,
156	 (sizeof(struct copan_aps_subpage) - 4) & 0x00ff}, //page_length
157	APS_VERSION, //page_version
158	0, //lock_active
159	{0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
160	0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
161	0, 0, 0, 0, 0} //reserved
162};
163
164static struct copan_aps_subpage aps_page_changeable = {
165	APS_PAGE_CODE | SMPH_SPF, //page_code
166	APS_SUBPAGE_CODE, //subpage
167	{(sizeof(struct copan_aps_subpage) - 4) & 0xff00,
168	 (sizeof(struct copan_aps_subpage) - 4) & 0x00ff}, //page_length
169	0, //page_version
170	0, //lock_active
171	{0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
172	0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
173	0, 0, 0, 0, 0} //reserved
174};
175
176static struct copan_debugconf_subpage debugconf_page_default = {
177	DBGCNF_PAGE_CODE | SMPH_SPF,	/* page_code */
178	DBGCNF_SUBPAGE_CODE,		/* subpage */
179	{(sizeof(struct copan_debugconf_subpage) - 4) >> 8,
180	 (sizeof(struct copan_debugconf_subpage) - 4) >> 0}, /* page_length */
181	DBGCNF_VERSION,			/* page_version */
182	{CTL_TIME_IO_DEFAULT_SECS>>8,
183	 CTL_TIME_IO_DEFAULT_SECS>>0},	/* ctl_time_io_secs */
184};
185
186static struct copan_debugconf_subpage debugconf_page_changeable = {
187	DBGCNF_PAGE_CODE | SMPH_SPF,	/* page_code */
188	DBGCNF_SUBPAGE_CODE,		/* subpage */
189	{(sizeof(struct copan_debugconf_subpage) - 4) >> 8,
190	 (sizeof(struct copan_debugconf_subpage) - 4) >> 0}, /* page_length */
191	0,				/* page_version */
192	{0xff,0xff},			/* ctl_time_io_secs */
193};
194
195static struct scsi_format_page format_page_default = {
196	/*page_code*/SMS_FORMAT_DEVICE_PAGE,
197	/*page_length*/sizeof(struct scsi_format_page) - 2,
198	/*tracks_per_zone*/ {0, 0},
199	/*alt_sectors_per_zone*/ {0, 0},
200	/*alt_tracks_per_zone*/ {0, 0},
201	/*alt_tracks_per_lun*/ {0, 0},
202	/*sectors_per_track*/ {(CTL_DEFAULT_SECTORS_PER_TRACK >> 8) & 0xff,
203			        CTL_DEFAULT_SECTORS_PER_TRACK & 0xff},
204	/*bytes_per_sector*/ {0, 0},
205	/*interleave*/ {0, 0},
206	/*track_skew*/ {0, 0},
207	/*cylinder_skew*/ {0, 0},
208	/*flags*/ SFP_HSEC,
209	/*reserved*/ {0, 0, 0}
210};
211
212static struct scsi_format_page format_page_changeable = {
213	/*page_code*/SMS_FORMAT_DEVICE_PAGE,
214	/*page_length*/sizeof(struct scsi_format_page) - 2,
215	/*tracks_per_zone*/ {0, 0},
216	/*alt_sectors_per_zone*/ {0, 0},
217	/*alt_tracks_per_zone*/ {0, 0},
218	/*alt_tracks_per_lun*/ {0, 0},
219	/*sectors_per_track*/ {0, 0},
220	/*bytes_per_sector*/ {0, 0},
221	/*interleave*/ {0, 0},
222	/*track_skew*/ {0, 0},
223	/*cylinder_skew*/ {0, 0},
224	/*flags*/ 0,
225	/*reserved*/ {0, 0, 0}
226};
227
228static struct scsi_rigid_disk_page rigid_disk_page_default = {
229	/*page_code*/SMS_RIGID_DISK_PAGE,
230	/*page_length*/sizeof(struct scsi_rigid_disk_page) - 2,
231	/*cylinders*/ {0, 0, 0},
232	/*heads*/ CTL_DEFAULT_HEADS,
233	/*start_write_precomp*/ {0, 0, 0},
234	/*start_reduced_current*/ {0, 0, 0},
235	/*step_rate*/ {0, 0},
236	/*landing_zone_cylinder*/ {0, 0, 0},
237	/*rpl*/ SRDP_RPL_DISABLED,
238	/*rotational_offset*/ 0,
239	/*reserved1*/ 0,
240	/*rotation_rate*/ {(CTL_DEFAULT_ROTATION_RATE >> 8) & 0xff,
241			   CTL_DEFAULT_ROTATION_RATE & 0xff},
242	/*reserved2*/ {0, 0}
243};
244
245static struct scsi_rigid_disk_page rigid_disk_page_changeable = {
246	/*page_code*/SMS_RIGID_DISK_PAGE,
247	/*page_length*/sizeof(struct scsi_rigid_disk_page) - 2,
248	/*cylinders*/ {0, 0, 0},
249	/*heads*/ 0,
250	/*start_write_precomp*/ {0, 0, 0},
251	/*start_reduced_current*/ {0, 0, 0},
252	/*step_rate*/ {0, 0},
253	/*landing_zone_cylinder*/ {0, 0, 0},
254	/*rpl*/ 0,
255	/*rotational_offset*/ 0,
256	/*reserved1*/ 0,
257	/*rotation_rate*/ {0, 0},
258	/*reserved2*/ {0, 0}
259};
260
261static struct scsi_caching_page caching_page_default = {
262	/*page_code*/SMS_CACHING_PAGE,
263	/*page_length*/sizeof(struct scsi_caching_page) - 2,
264	/*flags1*/ SCP_DISC | SCP_WCE,
265	/*ret_priority*/ 0,
266	/*disable_pf_transfer_len*/ {0xff, 0xff},
267	/*min_prefetch*/ {0, 0},
268	/*max_prefetch*/ {0xff, 0xff},
269	/*max_pf_ceiling*/ {0xff, 0xff},
270	/*flags2*/ 0,
271	/*cache_segments*/ 0,
272	/*cache_seg_size*/ {0, 0},
273	/*reserved*/ 0,
274	/*non_cache_seg_size*/ {0, 0, 0}
275};
276
277static struct scsi_caching_page caching_page_changeable = {
278	/*page_code*/SMS_CACHING_PAGE,
279	/*page_length*/sizeof(struct scsi_caching_page) - 2,
280	/*flags1*/ 0,
281	/*ret_priority*/ 0,
282	/*disable_pf_transfer_len*/ {0, 0},
283	/*min_prefetch*/ {0, 0},
284	/*max_prefetch*/ {0, 0},
285	/*max_pf_ceiling*/ {0, 0},
286	/*flags2*/ 0,
287	/*cache_segments*/ 0,
288	/*cache_seg_size*/ {0, 0},
289	/*reserved*/ 0,
290	/*non_cache_seg_size*/ {0, 0, 0}
291};
292
293static struct scsi_control_page control_page_default = {
294	/*page_code*/SMS_CONTROL_MODE_PAGE,
295	/*page_length*/sizeof(struct scsi_control_page) - 2,
296	/*rlec*/0,
297	/*queue_flags*/0,
298	/*eca_and_aen*/0,
299	/*reserved*/0,
300	/*aen_holdoff_period*/{0, 0}
301};
302
303static struct scsi_control_page control_page_changeable = {
304	/*page_code*/SMS_CONTROL_MODE_PAGE,
305	/*page_length*/sizeof(struct scsi_control_page) - 2,
306	/*rlec*/SCP_DSENSE,
307	/*queue_flags*/0,
308	/*eca_and_aen*/0,
309	/*reserved*/0,
310	/*aen_holdoff_period*/{0, 0}
311};
312
313
314/*
315 * XXX KDM move these into the softc.
316 */
317static int rcv_sync_msg;
318static int persis_offset;
319static uint8_t ctl_pause_rtr;
320static int     ctl_is_single = 1;
321static int     index_to_aps_page;
322
323SYSCTL_NODE(_kern_cam, OID_AUTO, ctl, CTLFLAG_RD, 0, "CAM Target Layer");
324static int worker_threads = 1;
325TUNABLE_INT("kern.cam.ctl.worker_threads", &worker_threads);
326SYSCTL_INT(_kern_cam_ctl, OID_AUTO, worker_threads, CTLFLAG_RDTUN,
327    &worker_threads, 1, "Number of worker threads");
328static int verbose = 0;
329TUNABLE_INT("kern.cam.ctl.verbose", &verbose);
330SYSCTL_INT(_kern_cam_ctl, OID_AUTO, verbose, CTLFLAG_RWTUN,
331    &verbose, 0, "Show SCSI errors returned to initiator");
332
333/*
334 * Serial number (0x80), device id (0x83), supported pages (0x00),
335 * Block limits (0xB0) and Logical Block Provisioning (0xB2)
336 */
337#define SCSI_EVPD_NUM_SUPPORTED_PAGES	5
338
339static void ctl_isc_event_handler(ctl_ha_channel chanel, ctl_ha_event event,
340				  int param);
341static void ctl_copy_sense_data(union ctl_ha_msg *src, union ctl_io *dest);
342static int ctl_init(void);
343void ctl_shutdown(void);
344static int ctl_open(struct cdev *dev, int flags, int fmt, struct thread *td);
345static int ctl_close(struct cdev *dev, int flags, int fmt, struct thread *td);
346static void ctl_ioctl_online(void *arg);
347static void ctl_ioctl_offline(void *arg);
348static int ctl_ioctl_targ_enable(void *arg, struct ctl_id targ_id);
349static int ctl_ioctl_targ_disable(void *arg, struct ctl_id targ_id);
350static int ctl_ioctl_lun_enable(void *arg, struct ctl_id targ_id, int lun_id);
351static int ctl_ioctl_lun_disable(void *arg, struct ctl_id targ_id, int lun_id);
352static int ctl_ioctl_do_datamove(struct ctl_scsiio *ctsio);
353static int ctl_serialize_other_sc_cmd(struct ctl_scsiio *ctsio, int have_lock);
354static int ctl_ioctl_submit_wait(union ctl_io *io);
355static void ctl_ioctl_datamove(union ctl_io *io);
356static void ctl_ioctl_done(union ctl_io *io);
357static void ctl_ioctl_hard_startstop_callback(void *arg,
358					      struct cfi_metatask *metatask);
359static void ctl_ioctl_bbrread_callback(void *arg,struct cfi_metatask *metatask);
360static int ctl_ioctl_fill_ooa(struct ctl_lun *lun, uint32_t *cur_fill_num,
361			      struct ctl_ooa *ooa_hdr,
362			      struct ctl_ooa_entry *kern_entries);
363static int ctl_ioctl(struct cdev *dev, u_long cmd, caddr_t addr, int flag,
364		     struct thread *td);
365uint32_t ctl_get_resindex(struct ctl_nexus *nexus);
366uint32_t ctl_port_idx(int port_num);
367#ifdef unused
368static union ctl_io *ctl_malloc_io(ctl_io_type io_type, uint32_t targ_port,
369				   uint32_t targ_target, uint32_t targ_lun,
370				   int can_wait);
371static void ctl_kfree_io(union ctl_io *io);
372#endif /* unused */
373static int ctl_alloc_lun(struct ctl_softc *ctl_softc, struct ctl_lun *lun,
374			 struct ctl_be_lun *be_lun, struct ctl_id target_id);
375static int ctl_free_lun(struct ctl_lun *lun);
376static void ctl_create_lun(struct ctl_be_lun *be_lun);
377/**
378static void ctl_failover_change_pages(struct ctl_softc *softc,
379				      struct ctl_scsiio *ctsio, int master);
380**/
381
382static int ctl_do_mode_select(union ctl_io *io);
383static int ctl_pro_preempt(struct ctl_softc *softc, struct ctl_lun *lun,
384			   uint64_t res_key, uint64_t sa_res_key,
385			   uint8_t type, uint32_t residx,
386			   struct ctl_scsiio *ctsio,
387			   struct scsi_per_res_out *cdb,
388			   struct scsi_per_res_out_parms* param);
389static void ctl_pro_preempt_other(struct ctl_lun *lun,
390				  union ctl_ha_msg *msg);
391static void ctl_hndl_per_res_out_on_other_sc(union ctl_ha_msg *msg);
392static int ctl_inquiry_evpd_supported(struct ctl_scsiio *ctsio, int alloc_len);
393static int ctl_inquiry_evpd_serial(struct ctl_scsiio *ctsio, int alloc_len);
394static int ctl_inquiry_evpd_devid(struct ctl_scsiio *ctsio, int alloc_len);
395static int ctl_inquiry_evpd_block_limits(struct ctl_scsiio *ctsio,
396					 int alloc_len);
397static int ctl_inquiry_evpd_lbp(struct ctl_scsiio *ctsio, int alloc_len);
398static int ctl_inquiry_evpd(struct ctl_scsiio *ctsio);
399static int ctl_inquiry_std(struct ctl_scsiio *ctsio);
400static int ctl_get_lba_len(union ctl_io *io, uint64_t *lba, uint32_t *len);
401static ctl_action ctl_extent_check(union ctl_io *io1, union ctl_io *io2);
402static ctl_action ctl_check_for_blockage(union ctl_io *pending_io,
403					 union ctl_io *ooa_io);
404static ctl_action ctl_check_ooa(struct ctl_lun *lun, union ctl_io *pending_io,
405				union ctl_io *starting_io);
406static int ctl_check_blocked(struct ctl_lun *lun);
407static int ctl_scsiio_lun_check(struct ctl_softc *ctl_softc,
408				struct ctl_lun *lun,
409				struct ctl_cmd_entry *entry,
410				struct ctl_scsiio *ctsio);
411//static int ctl_check_rtr(union ctl_io *pending_io, struct ctl_softc *softc);
412static void ctl_failover(void);
413static int ctl_scsiio_precheck(struct ctl_softc *ctl_softc,
414			       struct ctl_scsiio *ctsio);
415static int ctl_scsiio(struct ctl_scsiio *ctsio);
416
417static int ctl_bus_reset(struct ctl_softc *ctl_softc, union ctl_io *io);
418static int ctl_target_reset(struct ctl_softc *ctl_softc, union ctl_io *io,
419			    ctl_ua_type ua_type);
420static int ctl_lun_reset(struct ctl_lun *lun, union ctl_io *io,
421			 ctl_ua_type ua_type);
422static int ctl_abort_task(union ctl_io *io);
423static void ctl_run_task_queue(struct ctl_softc *ctl_softc);
424#ifdef CTL_IO_DELAY
425static void ctl_datamove_timer_wakeup(void *arg);
426static void ctl_done_timer_wakeup(void *arg);
427#endif /* CTL_IO_DELAY */
428
429static void ctl_send_datamove_done(union ctl_io *io, int have_lock);
430static void ctl_datamove_remote_write_cb(struct ctl_ha_dt_req *rq);
431static int ctl_datamove_remote_dm_write_cb(union ctl_io *io);
432static void ctl_datamove_remote_write(union ctl_io *io);
433static int ctl_datamove_remote_dm_read_cb(union ctl_io *io);
434static void ctl_datamove_remote_read_cb(struct ctl_ha_dt_req *rq);
435static int ctl_datamove_remote_sgl_setup(union ctl_io *io);
436static int ctl_datamove_remote_xfer(union ctl_io *io, unsigned command,
437				    ctl_ha_dt_cb callback);
438static void ctl_datamove_remote_read(union ctl_io *io);
439static void ctl_datamove_remote(union ctl_io *io);
440static int ctl_process_done(union ctl_io *io, int have_lock);
441static void ctl_work_thread(void *arg);
442
443/*
444 * Load the serialization table.  This isn't very pretty, but is probably
445 * the easiest way to do it.
446 */
447#include "ctl_ser_table.c"
448
449/*
450 * We only need to define open, close and ioctl routines for this driver.
451 */
452static struct cdevsw ctl_cdevsw = {
453	.d_version =	D_VERSION,
454	.d_flags =	0,
455	.d_open =	ctl_open,
456	.d_close =	ctl_close,
457	.d_ioctl =	ctl_ioctl,
458	.d_name =	"ctl",
459};
460
461
462MALLOC_DEFINE(M_CTL, "ctlmem", "Memory used for CTL");
463
464static int ctl_module_event_handler(module_t, int /*modeventtype_t*/, void *);
465
466static moduledata_t ctl_moduledata = {
467	"ctl",
468	ctl_module_event_handler,
469	NULL
470};
471
472DECLARE_MODULE(ctl, ctl_moduledata, SI_SUB_CONFIGURE, SI_ORDER_THIRD);
473MODULE_VERSION(ctl, 1);
474
475static void
476ctl_isc_handler_finish_xfer(struct ctl_softc *ctl_softc,
477			    union ctl_ha_msg *msg_info)
478{
479	struct ctl_scsiio *ctsio;
480
481	if (msg_info->hdr.original_sc == NULL) {
482		printf("%s: original_sc == NULL!\n", __func__);
483		/* XXX KDM now what? */
484		return;
485	}
486
487	ctsio = &msg_info->hdr.original_sc->scsiio;
488	ctsio->io_hdr.flags |= CTL_FLAG_IO_ACTIVE;
489	ctsio->io_hdr.msg_type = CTL_MSG_FINISH_IO;
490	ctsio->io_hdr.status = msg_info->hdr.status;
491	ctsio->scsi_status = msg_info->scsi.scsi_status;
492	ctsio->sense_len = msg_info->scsi.sense_len;
493	ctsio->sense_residual = msg_info->scsi.sense_residual;
494	ctsio->residual = msg_info->scsi.residual;
495	memcpy(&ctsio->sense_data, &msg_info->scsi.sense_data,
496	       sizeof(ctsio->sense_data));
497	memcpy(&ctsio->io_hdr.ctl_private[CTL_PRIV_LBA_LEN].bytes,
498	       &msg_info->scsi.lbalen, sizeof(msg_info->scsi.lbalen));
499	STAILQ_INSERT_TAIL(&ctl_softc->isc_queue, &ctsio->io_hdr, links);
500	ctl_wakeup_thread();
501}
502
503static void
504ctl_isc_handler_finish_ser_only(struct ctl_softc *ctl_softc,
505				union ctl_ha_msg *msg_info)
506{
507	struct ctl_scsiio *ctsio;
508
509	if (msg_info->hdr.serializing_sc == NULL) {
510		printf("%s: serializing_sc == NULL!\n", __func__);
511		/* XXX KDM now what? */
512		return;
513	}
514
515	ctsio = &msg_info->hdr.serializing_sc->scsiio;
516#if 0
517	/*
518	 * Attempt to catch the situation where an I/O has
519	 * been freed, and we're using it again.
520	 */
521	if (ctsio->io_hdr.io_type == 0xff) {
522		union ctl_io *tmp_io;
523		tmp_io = (union ctl_io *)ctsio;
524		printf("%s: %p use after free!\n", __func__,
525		       ctsio);
526		printf("%s: type %d msg %d cdb %x iptl: "
527		       "%d:%d:%d:%d tag 0x%04x "
528		       "flag %#x status %x\n",
529			__func__,
530			tmp_io->io_hdr.io_type,
531			tmp_io->io_hdr.msg_type,
532			tmp_io->scsiio.cdb[0],
533			tmp_io->io_hdr.nexus.initid.id,
534			tmp_io->io_hdr.nexus.targ_port,
535			tmp_io->io_hdr.nexus.targ_target.id,
536			tmp_io->io_hdr.nexus.targ_lun,
537			(tmp_io->io_hdr.io_type ==
538			CTL_IO_TASK) ?
539			tmp_io->taskio.tag_num :
540			tmp_io->scsiio.tag_num,
541		        tmp_io->io_hdr.flags,
542			tmp_io->io_hdr.status);
543	}
544#endif
545	ctsio->io_hdr.msg_type = CTL_MSG_FINISH_IO;
546	STAILQ_INSERT_TAIL(&ctl_softc->isc_queue, &ctsio->io_hdr, links);
547	ctl_wakeup_thread();
548}
549
550/*
551 * ISC (Inter Shelf Communication) event handler.  Events from the HA
552 * subsystem come in here.
553 */
554static void
555ctl_isc_event_handler(ctl_ha_channel channel, ctl_ha_event event, int param)
556{
557	struct ctl_softc *ctl_softc;
558	union ctl_io *io;
559	struct ctl_prio *presio;
560	ctl_ha_status isc_status;
561
562	ctl_softc = control_softc;
563	io = NULL;
564
565
566#if 0
567	printf("CTL: Isc Msg event %d\n", event);
568#endif
569	if (event == CTL_HA_EVT_MSG_RECV) {
570		union ctl_ha_msg msg_info;
571
572		isc_status = ctl_ha_msg_recv(CTL_HA_CHAN_CTL, &msg_info,
573					     sizeof(msg_info), /*wait*/ 0);
574#if 0
575		printf("CTL: msg_type %d\n", msg_info.msg_type);
576#endif
577		if (isc_status != 0) {
578			printf("Error receiving message, status = %d\n",
579			       isc_status);
580			return;
581		}
582		mtx_lock(&ctl_softc->ctl_lock);
583
584		switch (msg_info.hdr.msg_type) {
585		case CTL_MSG_SERIALIZE:
586#if 0
587			printf("Serialize\n");
588#endif
589			io = ctl_alloc_io((void *)ctl_softc->othersc_pool);
590			if (io == NULL) {
591				printf("ctl_isc_event_handler: can't allocate "
592				       "ctl_io!\n");
593				/* Bad Juju */
594				/* Need to set busy and send msg back */
595				mtx_unlock(&ctl_softc->ctl_lock);
596				msg_info.hdr.msg_type = CTL_MSG_BAD_JUJU;
597				msg_info.hdr.status = CTL_SCSI_ERROR;
598				msg_info.scsi.scsi_status = SCSI_STATUS_BUSY;
599				msg_info.scsi.sense_len = 0;
600			        if (ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg_info,
601				    sizeof(msg_info), 0) > CTL_HA_STATUS_SUCCESS){
602				}
603				goto bailout;
604			}
605			ctl_zero_io(io);
606			// populate ctsio from msg_info
607			io->io_hdr.io_type = CTL_IO_SCSI;
608			io->io_hdr.msg_type = CTL_MSG_SERIALIZE;
609			io->io_hdr.original_sc = msg_info.hdr.original_sc;
610#if 0
611			printf("pOrig %x\n", (int)msg_info.original_sc);
612#endif
613			io->io_hdr.flags |= CTL_FLAG_FROM_OTHER_SC |
614					    CTL_FLAG_IO_ACTIVE;
615			/*
616			 * If we're in serialization-only mode, we don't
617			 * want to go through full done processing.  Thus
618			 * the COPY flag.
619			 *
620			 * XXX KDM add another flag that is more specific.
621			 */
622			if (ctl_softc->ha_mode == CTL_HA_MODE_SER_ONLY)
623				io->io_hdr.flags |= CTL_FLAG_INT_COPY;
624			io->io_hdr.nexus = msg_info.hdr.nexus;
625#if 0
626			printf("targ %d, port %d, iid %d, lun %d\n",
627			       io->io_hdr.nexus.targ_target.id,
628			       io->io_hdr.nexus.targ_port,
629			       io->io_hdr.nexus.initid.id,
630			       io->io_hdr.nexus.targ_lun);
631#endif
632			io->scsiio.tag_num = msg_info.scsi.tag_num;
633			io->scsiio.tag_type = msg_info.scsi.tag_type;
634			memcpy(io->scsiio.cdb, msg_info.scsi.cdb,
635			       CTL_MAX_CDBLEN);
636			if (ctl_softc->ha_mode == CTL_HA_MODE_XFER) {
637				struct ctl_cmd_entry *entry;
638				uint8_t opcode;
639
640				opcode = io->scsiio.cdb[0];
641				entry = &ctl_cmd_table[opcode];
642				io->io_hdr.flags &= ~CTL_FLAG_DATA_MASK;
643				io->io_hdr.flags |=
644					entry->flags & CTL_FLAG_DATA_MASK;
645			}
646			STAILQ_INSERT_TAIL(&ctl_softc->isc_queue,
647					   &io->io_hdr, links);
648			ctl_wakeup_thread();
649			break;
650
651		/* Performed on the Originating SC, XFER mode only */
652		case CTL_MSG_DATAMOVE: {
653			struct ctl_sg_entry *sgl;
654			int i, j;
655
656			io = msg_info.hdr.original_sc;
657			if (io == NULL) {
658				printf("%s: original_sc == NULL!\n", __func__);
659				/* XXX KDM do something here */
660				break;
661			}
662			io->io_hdr.msg_type = CTL_MSG_DATAMOVE;
663			io->io_hdr.flags |= CTL_FLAG_IO_ACTIVE;
664			/*
665			 * Keep track of this, we need to send it back over
666			 * when the datamove is complete.
667			 */
668			io->io_hdr.serializing_sc = msg_info.hdr.serializing_sc;
669
670			if (msg_info.dt.sg_sequence == 0) {
671				/*
672				 * XXX KDM we use the preallocated S/G list
673				 * here, but we'll need to change this to
674				 * dynamic allocation if we need larger S/G
675				 * lists.
676				 */
677				if (msg_info.dt.kern_sg_entries >
678				    sizeof(io->io_hdr.remote_sglist) /
679				    sizeof(io->io_hdr.remote_sglist[0])) {
680					printf("%s: number of S/G entries "
681					    "needed %u > allocated num %zd\n",
682					    __func__,
683					    msg_info.dt.kern_sg_entries,
684					    sizeof(io->io_hdr.remote_sglist)/
685					    sizeof(io->io_hdr.remote_sglist[0]));
686
687					/*
688					 * XXX KDM send a message back to
689					 * the other side to shut down the
690					 * DMA.  The error will come back
691					 * through via the normal channel.
692					 */
693					break;
694				}
695				sgl = io->io_hdr.remote_sglist;
696				memset(sgl, 0,
697				       sizeof(io->io_hdr.remote_sglist));
698
699				io->scsiio.kern_data_ptr = (uint8_t *)sgl;
700
701				io->scsiio.kern_sg_entries =
702					msg_info.dt.kern_sg_entries;
703				io->scsiio.rem_sg_entries =
704					msg_info.dt.kern_sg_entries;
705				io->scsiio.kern_data_len =
706					msg_info.dt.kern_data_len;
707				io->scsiio.kern_total_len =
708					msg_info.dt.kern_total_len;
709				io->scsiio.kern_data_resid =
710					msg_info.dt.kern_data_resid;
711				io->scsiio.kern_rel_offset =
712					msg_info.dt.kern_rel_offset;
713				/*
714				 * Clear out per-DMA flags.
715				 */
716				io->io_hdr.flags &= ~CTL_FLAG_RDMA_MASK;
717				/*
718				 * Add per-DMA flags that are set for this
719				 * particular DMA request.
720				 */
721				io->io_hdr.flags |= msg_info.dt.flags &
722						    CTL_FLAG_RDMA_MASK;
723			} else
724				sgl = (struct ctl_sg_entry *)
725					io->scsiio.kern_data_ptr;
726
727			for (i = msg_info.dt.sent_sg_entries, j = 0;
728			     i < (msg_info.dt.sent_sg_entries +
729			     msg_info.dt.cur_sg_entries); i++, j++) {
730				sgl[i].addr = msg_info.dt.sg_list[j].addr;
731				sgl[i].len = msg_info.dt.sg_list[j].len;
732
733#if 0
734				printf("%s: L: %p,%d -> %p,%d j=%d, i=%d\n",
735				       __func__,
736				       msg_info.dt.sg_list[j].addr,
737				       msg_info.dt.sg_list[j].len,
738				       sgl[i].addr, sgl[i].len, j, i);
739#endif
740			}
741#if 0
742			memcpy(&sgl[msg_info.dt.sent_sg_entries],
743			       msg_info.dt.sg_list,
744			       sizeof(*sgl) * msg_info.dt.cur_sg_entries);
745#endif
746
747			/*
748			 * If this is the last piece of the I/O, we've got
749			 * the full S/G list.  Queue processing in the thread.
750			 * Otherwise wait for the next piece.
751			 */
752			if (msg_info.dt.sg_last != 0) {
753				STAILQ_INSERT_TAIL(&ctl_softc->isc_queue,
754						   &io->io_hdr, links);
755				ctl_wakeup_thread();
756			}
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
783			STAILQ_INSERT_TAIL(&ctl_softc->isc_queue,
784					   &io->io_hdr, links);
785			ctl_wakeup_thread();
786			break;
787		}
788
789		/* Preformed on Originating SC, SER_ONLY mode */
790		case CTL_MSG_R2R:
791			io = msg_info.hdr.original_sc;
792			if (io == NULL) {
793				printf("%s: Major Bummer\n", __func__);
794				mtx_unlock(&ctl_softc->ctl_lock);
795				return;
796			} else {
797#if 0
798				printf("pOrig %x\n",(int) ctsio);
799#endif
800			}
801			io->io_hdr.msg_type = CTL_MSG_R2R;
802			io->io_hdr.serializing_sc = msg_info.hdr.serializing_sc;
803			STAILQ_INSERT_TAIL(&ctl_softc->isc_queue,
804					   &io->io_hdr, links);
805			ctl_wakeup_thread();
806			break;
807
808		/*
809		 * Performed on Serializing(i.e. primary SC) SC in SER_ONLY
810		 * mode.
811		 * Performed on the Originating (i.e. secondary) SC in XFER
812		 * mode
813		 */
814		case CTL_MSG_FINISH_IO:
815			if (ctl_softc->ha_mode == CTL_HA_MODE_XFER)
816				ctl_isc_handler_finish_xfer(ctl_softc,
817							    &msg_info);
818			else
819				ctl_isc_handler_finish_ser_only(ctl_softc,
820								&msg_info);
821			break;
822
823		/* Preformed on Originating SC */
824		case CTL_MSG_BAD_JUJU:
825			io = msg_info.hdr.original_sc;
826			if (io == NULL) {
827				printf("%s: Bad JUJU!, original_sc is NULL!\n",
828				       __func__);
829				break;
830			}
831			ctl_copy_sense_data(&msg_info, io);
832			/*
833			 * IO should have already been cleaned up on other
834			 * SC so clear this flag so we won't send a message
835			 * back to finish the IO there.
836			 */
837			io->io_hdr.flags &= ~CTL_FLAG_SENT_2OTHER_SC;
838			io->io_hdr.flags |= CTL_FLAG_IO_ACTIVE;
839
840			/* io = msg_info.hdr.serializing_sc; */
841			io->io_hdr.msg_type = CTL_MSG_BAD_JUJU;
842		        STAILQ_INSERT_TAIL(&ctl_softc->isc_queue,
843					   &io->io_hdr, links);
844			ctl_wakeup_thread();
845			break;
846
847		/* Handle resets sent from the other side */
848		case CTL_MSG_MANAGE_TASKS: {
849			struct ctl_taskio *taskio;
850			taskio = (struct ctl_taskio *)ctl_alloc_io(
851				(void *)ctl_softc->othersc_pool);
852			if (taskio == NULL) {
853				printf("ctl_isc_event_handler: can't allocate "
854				       "ctl_io!\n");
855				/* Bad Juju */
856				/* should I just call the proper reset func
857				   here??? */
858				mtx_unlock(&ctl_softc->ctl_lock);
859				goto bailout;
860			}
861			ctl_zero_io((union ctl_io *)taskio);
862			taskio->io_hdr.io_type = CTL_IO_TASK;
863			taskio->io_hdr.flags |= CTL_FLAG_FROM_OTHER_SC;
864			taskio->io_hdr.nexus = msg_info.hdr.nexus;
865			taskio->task_action = msg_info.task.task_action;
866			taskio->tag_num = msg_info.task.tag_num;
867			taskio->tag_type = msg_info.task.tag_type;
868#ifdef CTL_TIME_IO
869			taskio->io_hdr.start_time = time_uptime;
870			getbintime(&taskio->io_hdr.start_bt);
871#if 0
872			cs_prof_gettime(&taskio->io_hdr.start_ticks);
873#endif
874#endif /* CTL_TIME_IO */
875		        STAILQ_INSERT_TAIL(&ctl_softc->task_queue,
876					   &taskio->io_hdr, links);
877			ctl_softc->flags |= CTL_FLAG_TASK_PENDING;
878			ctl_wakeup_thread();
879			break;
880		}
881		/* Persistent Reserve action which needs attention */
882		case CTL_MSG_PERS_ACTION:
883			presio = (struct ctl_prio *)ctl_alloc_io(
884				(void *)ctl_softc->othersc_pool);
885			if (presio == NULL) {
886				printf("ctl_isc_event_handler: can't allocate "
887				       "ctl_io!\n");
888				/* Bad Juju */
889				/* Need to set busy and send msg back */
890				mtx_unlock(&ctl_softc->ctl_lock);
891				goto bailout;
892			}
893			ctl_zero_io((union ctl_io *)presio);
894			presio->io_hdr.msg_type = CTL_MSG_PERS_ACTION;
895			presio->pr_msg = msg_info.pr;
896		        STAILQ_INSERT_TAIL(&ctl_softc->isc_queue,
897					   &presio->io_hdr, links);
898			ctl_wakeup_thread();
899			break;
900		case CTL_MSG_SYNC_FE:
901			rcv_sync_msg = 1;
902			break;
903		case CTL_MSG_APS_LOCK: {
904			// It's quicker to execute this then to
905			// queue it.
906			struct ctl_lun *lun;
907			struct ctl_page_index *page_index;
908			struct copan_aps_subpage *current_sp;
909			uint32_t targ_lun;
910
911			targ_lun = msg_info.hdr.nexus.targ_lun;
912			if (msg_info.hdr.nexus.lun_map_fn != NULL)
913				targ_lun = msg_info.hdr.nexus.lun_map_fn(msg_info.hdr.nexus.lun_map_arg, targ_lun);
914
915			lun = ctl_softc->ctl_luns[targ_lun];
916			page_index = &lun->mode_pages.index[index_to_aps_page];
917			current_sp = (struct copan_aps_subpage *)
918				     (page_index->page_data +
919				     (page_index->page_len * CTL_PAGE_CURRENT));
920
921			current_sp->lock_active = msg_info.aps.lock_flag;
922		        break;
923		}
924		default:
925		        printf("How did I get here?\n");
926		}
927		mtx_unlock(&ctl_softc->ctl_lock);
928	} else if (event == CTL_HA_EVT_MSG_SENT) {
929		if (param != CTL_HA_STATUS_SUCCESS) {
930			printf("Bad status from ctl_ha_msg_send status %d\n",
931			       param);
932		}
933		return;
934	} else if (event == CTL_HA_EVT_DISCONNECT) {
935		printf("CTL: Got a disconnect from Isc\n");
936		return;
937	} else {
938		printf("ctl_isc_event_handler: Unknown event %d\n", event);
939		return;
940	}
941
942bailout:
943	return;
944}
945
946static void
947ctl_copy_sense_data(union ctl_ha_msg *src, union ctl_io *dest)
948{
949	struct scsi_sense_data *sense;
950
951	sense = &dest->scsiio.sense_data;
952	bcopy(&src->scsi.sense_data, sense, sizeof(*sense));
953	dest->scsiio.scsi_status = src->scsi.scsi_status;
954	dest->scsiio.sense_len = src->scsi.sense_len;
955	dest->io_hdr.status = src->hdr.status;
956}
957
958static int
959ctl_init(void)
960{
961	struct ctl_softc *softc;
962	struct ctl_io_pool *internal_pool, *emergency_pool, *other_pool;
963	struct ctl_frontend *fe;
964        uint8_t sc_id =0;
965	int i, error, retval;
966	//int isc_retval;
967
968	retval = 0;
969	ctl_pause_rtr = 0;
970        rcv_sync_msg = 0;
971
972	control_softc = malloc(sizeof(*control_softc), M_DEVBUF,
973			       M_WAITOK | M_ZERO);
974	softc = control_softc;
975
976	softc->dev = make_dev(&ctl_cdevsw, 0, UID_ROOT, GID_OPERATOR, 0600,
977			      "cam/ctl");
978
979	softc->dev->si_drv1 = softc;
980
981	/*
982	 * By default, return a "bad LUN" peripheral qualifier for unknown
983	 * LUNs.  The user can override this default using the tunable or
984	 * sysctl.  See the comment in ctl_inquiry_std() for more details.
985	 */
986	softc->inquiry_pq_no_lun = 1;
987	TUNABLE_INT_FETCH("kern.cam.ctl.inquiry_pq_no_lun",
988			  &softc->inquiry_pq_no_lun);
989	sysctl_ctx_init(&softc->sysctl_ctx);
990	softc->sysctl_tree = SYSCTL_ADD_NODE(&softc->sysctl_ctx,
991		SYSCTL_STATIC_CHILDREN(_kern_cam), OID_AUTO, "ctl",
992		CTLFLAG_RD, 0, "CAM Target Layer");
993
994	if (softc->sysctl_tree == NULL) {
995		printf("%s: unable to allocate sysctl tree\n", __func__);
996		destroy_dev(softc->dev);
997		free(control_softc, M_DEVBUF);
998		control_softc = NULL;
999		return (ENOMEM);
1000	}
1001
1002	SYSCTL_ADD_INT(&softc->sysctl_ctx,
1003		       SYSCTL_CHILDREN(softc->sysctl_tree), OID_AUTO,
1004		       "inquiry_pq_no_lun", CTLFLAG_RW,
1005		       &softc->inquiry_pq_no_lun, 0,
1006		       "Report no lun possible for invalid LUNs");
1007
1008	mtx_init(&softc->ctl_lock, "CTL mutex", NULL, MTX_DEF);
1009	mtx_init(&softc->pool_lock, "CTL pool mutex", NULL, MTX_DEF);
1010	softc->open_count = 0;
1011
1012	/*
1013	 * Default to actually sending a SYNCHRONIZE CACHE command down to
1014	 * the drive.
1015	 */
1016	softc->flags = CTL_FLAG_REAL_SYNC;
1017
1018	/*
1019	 * In Copan's HA scheme, the "master" and "slave" roles are
1020	 * figured out through the slot the controller is in.  Although it
1021	 * is an active/active system, someone has to be in charge.
1022 	 */
1023#ifdef NEEDTOPORT
1024        scmicro_rw(SCMICRO_GET_SHELF_ID, &sc_id);
1025#endif
1026
1027        if (sc_id == 0) {
1028		softc->flags |= CTL_FLAG_MASTER_SHELF;
1029		persis_offset = 0;
1030	} else
1031		persis_offset = CTL_MAX_INITIATORS;
1032
1033	/*
1034	 * XXX KDM need to figure out where we want to get our target ID
1035	 * and WWID.  Is it different on each port?
1036	 */
1037	softc->target.id = 0;
1038	softc->target.wwid[0] = 0x12345678;
1039	softc->target.wwid[1] = 0x87654321;
1040	STAILQ_INIT(&softc->lun_list);
1041	STAILQ_INIT(&softc->pending_lun_queue);
1042	STAILQ_INIT(&softc->task_queue);
1043	STAILQ_INIT(&softc->incoming_queue);
1044	STAILQ_INIT(&softc->rtr_queue);
1045	STAILQ_INIT(&softc->done_queue);
1046	STAILQ_INIT(&softc->isc_queue);
1047	STAILQ_INIT(&softc->fe_list);
1048	STAILQ_INIT(&softc->be_list);
1049	STAILQ_INIT(&softc->io_pools);
1050
1051	/*
1052	 * We don't bother calling these with ctl_lock held here, because,
1053	 * in theory, no one else can try to do anything while we're in our
1054	 * module init routine.
1055	 */
1056	if (ctl_pool_create(softc, CTL_POOL_INTERNAL, CTL_POOL_ENTRIES_INTERNAL,
1057			    &internal_pool)!= 0){
1058		printf("ctl: can't allocate %d entry internal pool, "
1059		       "exiting\n", CTL_POOL_ENTRIES_INTERNAL);
1060		return (ENOMEM);
1061	}
1062
1063	if (ctl_pool_create(softc, CTL_POOL_EMERGENCY,
1064			    CTL_POOL_ENTRIES_EMERGENCY, &emergency_pool) != 0) {
1065		printf("ctl: can't allocate %d entry emergency pool, "
1066		       "exiting\n", CTL_POOL_ENTRIES_EMERGENCY);
1067		ctl_pool_free(internal_pool);
1068		return (ENOMEM);
1069	}
1070
1071	if (ctl_pool_create(softc, CTL_POOL_4OTHERSC, CTL_POOL_ENTRIES_OTHER_SC,
1072	                    &other_pool) != 0)
1073	{
1074		printf("ctl: can't allocate %d entry other SC pool, "
1075		       "exiting\n", CTL_POOL_ENTRIES_OTHER_SC);
1076		ctl_pool_free(internal_pool);
1077		ctl_pool_free(emergency_pool);
1078		return (ENOMEM);
1079	}
1080
1081	softc->internal_pool = internal_pool;
1082	softc->emergency_pool = emergency_pool;
1083	softc->othersc_pool = other_pool;
1084
1085	if (worker_threads > MAXCPU || worker_threads == 0) {
1086		printf("invalid kern.cam.ctl.worker_threads value; "
1087		    "setting to 1");
1088		worker_threads = 1;
1089	} else if (worker_threads < 0) {
1090		if (mp_ncpus > 2) {
1091			/*
1092			 * Using more than two worker threads actually hurts
1093			 * performance due to lock contention.
1094			 */
1095			worker_threads = 2;
1096		} else {
1097			worker_threads = 1;
1098		}
1099	}
1100
1101	for (i = 0; i < worker_threads; i++) {
1102		error = kproc_kthread_add(ctl_work_thread, softc,
1103		    &softc->work_thread, NULL, 0, 0, "ctl", "work%d", i);
1104		if (error != 0) {
1105			printf("error creating CTL work thread!\n");
1106			ctl_pool_free(internal_pool);
1107			ctl_pool_free(emergency_pool);
1108			ctl_pool_free(other_pool);
1109			return (error);
1110		}
1111	}
1112	if (bootverbose)
1113		printf("ctl: CAM Target Layer loaded\n");
1114
1115	/*
1116	 * Initialize the initiator and portname mappings
1117	 */
1118	memset(softc->wwpn_iid, 0, sizeof(softc->wwpn_iid));
1119
1120	/*
1121	 * Initialize the ioctl front end.
1122	 */
1123	fe = &softc->ioctl_info.fe;
1124	sprintf(softc->ioctl_info.port_name, "CTL ioctl");
1125	fe->port_type = CTL_PORT_IOCTL;
1126	fe->num_requested_ctl_io = 100;
1127	fe->port_name = softc->ioctl_info.port_name;
1128	fe->port_online = ctl_ioctl_online;
1129	fe->port_offline = ctl_ioctl_offline;
1130	fe->onoff_arg = &softc->ioctl_info;
1131	fe->targ_enable = ctl_ioctl_targ_enable;
1132	fe->targ_disable = ctl_ioctl_targ_disable;
1133	fe->lun_enable = ctl_ioctl_lun_enable;
1134	fe->lun_disable = ctl_ioctl_lun_disable;
1135	fe->targ_lun_arg = &softc->ioctl_info;
1136	fe->fe_datamove = ctl_ioctl_datamove;
1137	fe->fe_done = ctl_ioctl_done;
1138	fe->max_targets = 15;
1139	fe->max_target_id = 15;
1140
1141	if (ctl_frontend_register(&softc->ioctl_info.fe,
1142	                  (softc->flags & CTL_FLAG_MASTER_SHELF)) != 0) {
1143		printf("ctl: ioctl front end registration failed, will "
1144		       "continue anyway\n");
1145	}
1146
1147#ifdef CTL_IO_DELAY
1148	if (sizeof(struct callout) > CTL_TIMER_BYTES) {
1149		printf("sizeof(struct callout) %zd > CTL_TIMER_BYTES %zd\n",
1150		       sizeof(struct callout), CTL_TIMER_BYTES);
1151		return (EINVAL);
1152	}
1153#endif /* CTL_IO_DELAY */
1154
1155	return (0);
1156}
1157
1158void
1159ctl_shutdown(void)
1160{
1161	struct ctl_softc *softc;
1162	struct ctl_lun *lun, *next_lun;
1163	struct ctl_io_pool *pool;
1164
1165	softc = (struct ctl_softc *)control_softc;
1166
1167	if (ctl_frontend_deregister(&softc->ioctl_info.fe) != 0)
1168		printf("ctl: ioctl front end deregistration failed\n");
1169
1170	mtx_lock(&softc->ctl_lock);
1171
1172	/*
1173	 * Free up each LUN.
1174	 */
1175	for (lun = STAILQ_FIRST(&softc->lun_list); lun != NULL; lun = next_lun){
1176		next_lun = STAILQ_NEXT(lun, links);
1177		ctl_free_lun(lun);
1178	}
1179
1180	mtx_unlock(&softc->ctl_lock);
1181
1182	/*
1183	 * This will rip the rug out from under any FETDs or anyone else
1184	 * that has a pool allocated.  Since we increment our module
1185	 * refcount any time someone outside the main CTL module allocates
1186	 * a pool, we shouldn't have any problems here.  The user won't be
1187	 * able to unload the CTL module until client modules have
1188	 * successfully unloaded.
1189	 */
1190	while ((pool = STAILQ_FIRST(&softc->io_pools)) != NULL)
1191		ctl_pool_free(pool);
1192
1193#if 0
1194	ctl_shutdown_thread(softc->work_thread);
1195#endif
1196
1197	mtx_destroy(&softc->pool_lock);
1198	mtx_destroy(&softc->ctl_lock);
1199
1200	destroy_dev(softc->dev);
1201
1202	sysctl_ctx_free(&softc->sysctl_ctx);
1203
1204	free(control_softc, M_DEVBUF);
1205	control_softc = NULL;
1206
1207	if (bootverbose)
1208		printf("ctl: CAM Target Layer unloaded\n");
1209}
1210
1211static int
1212ctl_module_event_handler(module_t mod, int what, void *arg)
1213{
1214
1215	switch (what) {
1216	case MOD_LOAD:
1217		return (ctl_init());
1218	case MOD_UNLOAD:
1219		return (EBUSY);
1220	default:
1221		return (EOPNOTSUPP);
1222	}
1223}
1224
1225/*
1226 * XXX KDM should we do some access checks here?  Bump a reference count to
1227 * prevent a CTL module from being unloaded while someone has it open?
1228 */
1229static int
1230ctl_open(struct cdev *dev, int flags, int fmt, struct thread *td)
1231{
1232	return (0);
1233}
1234
1235static int
1236ctl_close(struct cdev *dev, int flags, int fmt, struct thread *td)
1237{
1238	return (0);
1239}
1240
1241int
1242ctl_port_enable(ctl_port_type port_type)
1243{
1244	struct ctl_softc *softc;
1245	struct ctl_frontend *fe;
1246
1247	if (ctl_is_single == 0) {
1248		union ctl_ha_msg msg_info;
1249		int isc_retval;
1250
1251#if 0
1252		printf("%s: HA mode, synchronizing frontend enable\n",
1253		        __func__);
1254#endif
1255		msg_info.hdr.msg_type = CTL_MSG_SYNC_FE;
1256	        if ((isc_retval=ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg_info,
1257		        sizeof(msg_info), 1 )) > CTL_HA_STATUS_SUCCESS) {
1258			printf("Sync msg send error retval %d\n", isc_retval);
1259		}
1260		if (!rcv_sync_msg) {
1261			isc_retval=ctl_ha_msg_recv(CTL_HA_CHAN_CTL, &msg_info,
1262			        sizeof(msg_info), 1);
1263		}
1264#if 0
1265        	printf("CTL:Frontend Enable\n");
1266	} else {
1267		printf("%s: single mode, skipping frontend synchronization\n",
1268		        __func__);
1269#endif
1270	}
1271
1272	softc = control_softc;
1273
1274	STAILQ_FOREACH(fe, &softc->fe_list, links) {
1275		if (port_type & fe->port_type)
1276		{
1277#if 0
1278			printf("port %d\n", fe->targ_port);
1279#endif
1280			ctl_frontend_online(fe);
1281		}
1282	}
1283
1284	return (0);
1285}
1286
1287int
1288ctl_port_disable(ctl_port_type port_type)
1289{
1290	struct ctl_softc *softc;
1291	struct ctl_frontend *fe;
1292
1293	softc = control_softc;
1294
1295	STAILQ_FOREACH(fe, &softc->fe_list, links) {
1296		if (port_type & fe->port_type)
1297			ctl_frontend_offline(fe);
1298	}
1299
1300	return (0);
1301}
1302
1303/*
1304 * Returns 0 for success, 1 for failure.
1305 * Currently the only failure mode is if there aren't enough entries
1306 * allocated.  So, in case of a failure, look at num_entries_dropped,
1307 * reallocate and try again.
1308 */
1309int
1310ctl_port_list(struct ctl_port_entry *entries, int num_entries_alloced,
1311	      int *num_entries_filled, int *num_entries_dropped,
1312	      ctl_port_type port_type, int no_virtual)
1313{
1314	struct ctl_softc *softc;
1315	struct ctl_frontend *fe;
1316	int entries_dropped, entries_filled;
1317	int retval;
1318	int i;
1319
1320	softc = control_softc;
1321
1322	retval = 0;
1323	entries_filled = 0;
1324	entries_dropped = 0;
1325
1326	i = 0;
1327	mtx_lock(&softc->ctl_lock);
1328	STAILQ_FOREACH(fe, &softc->fe_list, links) {
1329		struct ctl_port_entry *entry;
1330
1331		if ((fe->port_type & port_type) == 0)
1332			continue;
1333
1334		if ((no_virtual != 0)
1335		 && (fe->virtual_port != 0))
1336			continue;
1337
1338		if (entries_filled >= num_entries_alloced) {
1339			entries_dropped++;
1340			continue;
1341		}
1342		entry = &entries[i];
1343
1344		entry->port_type = fe->port_type;
1345		strlcpy(entry->port_name, fe->port_name,
1346			sizeof(entry->port_name));
1347		entry->physical_port = fe->physical_port;
1348		entry->virtual_port = fe->virtual_port;
1349		entry->wwnn = fe->wwnn;
1350		entry->wwpn = fe->wwpn;
1351
1352		i++;
1353		entries_filled++;
1354	}
1355
1356	mtx_unlock(&softc->ctl_lock);
1357
1358	if (entries_dropped > 0)
1359		retval = 1;
1360
1361	*num_entries_dropped = entries_dropped;
1362	*num_entries_filled = entries_filled;
1363
1364	return (retval);
1365}
1366
1367static void
1368ctl_ioctl_online(void *arg)
1369{
1370	struct ctl_ioctl_info *ioctl_info;
1371
1372	ioctl_info = (struct ctl_ioctl_info *)arg;
1373
1374	ioctl_info->flags |= CTL_IOCTL_FLAG_ENABLED;
1375}
1376
1377static void
1378ctl_ioctl_offline(void *arg)
1379{
1380	struct ctl_ioctl_info *ioctl_info;
1381
1382	ioctl_info = (struct ctl_ioctl_info *)arg;
1383
1384	ioctl_info->flags &= ~CTL_IOCTL_FLAG_ENABLED;
1385}
1386
1387/*
1388 * Remove an initiator by port number and initiator ID.
1389 * Returns 0 for success, 1 for failure.
1390 */
1391int
1392ctl_remove_initiator(int32_t targ_port, uint32_t iid)
1393{
1394	struct ctl_softc *softc;
1395
1396	softc = control_softc;
1397
1398	mtx_assert(&softc->ctl_lock, MA_NOTOWNED);
1399
1400	if ((targ_port < 0)
1401	 || (targ_port > CTL_MAX_PORTS)) {
1402		printf("%s: invalid port number %d\n", __func__, targ_port);
1403		return (1);
1404	}
1405	if (iid > CTL_MAX_INIT_PER_PORT) {
1406		printf("%s: initiator ID %u > maximun %u!\n",
1407		       __func__, iid, CTL_MAX_INIT_PER_PORT);
1408		return (1);
1409	}
1410
1411	mtx_lock(&softc->ctl_lock);
1412
1413	softc->wwpn_iid[targ_port][iid].in_use = 0;
1414
1415	mtx_unlock(&softc->ctl_lock);
1416
1417	return (0);
1418}
1419
1420/*
1421 * Add an initiator to the initiator map.
1422 * Returns 0 for success, 1 for failure.
1423 */
1424int
1425ctl_add_initiator(uint64_t wwpn, int32_t targ_port, uint32_t iid)
1426{
1427	struct ctl_softc *softc;
1428	int retval;
1429
1430	softc = control_softc;
1431
1432	mtx_assert(&softc->ctl_lock, MA_NOTOWNED);
1433
1434	retval = 0;
1435
1436	if ((targ_port < 0)
1437	 || (targ_port > CTL_MAX_PORTS)) {
1438		printf("%s: invalid port number %d\n", __func__, targ_port);
1439		return (1);
1440	}
1441	if (iid > CTL_MAX_INIT_PER_PORT) {
1442		printf("%s: WWPN %#jx initiator ID %u > maximun %u!\n",
1443		       __func__, wwpn, iid, CTL_MAX_INIT_PER_PORT);
1444		return (1);
1445	}
1446
1447	mtx_lock(&softc->ctl_lock);
1448
1449	if (softc->wwpn_iid[targ_port][iid].in_use != 0) {
1450		/*
1451		 * We don't treat this as an error.
1452		 */
1453		if (softc->wwpn_iid[targ_port][iid].wwpn == wwpn) {
1454			printf("%s: port %d iid %u WWPN %#jx arrived again?\n",
1455			       __func__, targ_port, iid, (uintmax_t)wwpn);
1456			goto bailout;
1457		}
1458
1459		/*
1460		 * This is an error, but what do we do about it?  The
1461		 * driver is telling us we have a new WWPN for this
1462		 * initiator ID, so we pretty much need to use it.
1463		 */
1464		printf("%s: port %d iid %u WWPN %#jx arrived, WWPN %#jx is "
1465		       "still at that address\n", __func__, targ_port, iid,
1466		       (uintmax_t)wwpn,
1467		       (uintmax_t)softc->wwpn_iid[targ_port][iid].wwpn);
1468
1469		/*
1470		 * XXX KDM clear have_ca and ua_pending on each LUN for
1471		 * this initiator.
1472		 */
1473	}
1474	softc->wwpn_iid[targ_port][iid].in_use = 1;
1475	softc->wwpn_iid[targ_port][iid].iid = iid;
1476	softc->wwpn_iid[targ_port][iid].wwpn = wwpn;
1477	softc->wwpn_iid[targ_port][iid].port = targ_port;
1478
1479bailout:
1480
1481	mtx_unlock(&softc->ctl_lock);
1482
1483	return (retval);
1484}
1485
1486/*
1487 * XXX KDM should we pretend to do something in the target/lun
1488 * enable/disable functions?
1489 */
1490static int
1491ctl_ioctl_targ_enable(void *arg, struct ctl_id targ_id)
1492{
1493	return (0);
1494}
1495
1496static int
1497ctl_ioctl_targ_disable(void *arg, struct ctl_id targ_id)
1498{
1499	return (0);
1500}
1501
1502static int
1503ctl_ioctl_lun_enable(void *arg, struct ctl_id targ_id, int lun_id)
1504{
1505	return (0);
1506}
1507
1508static int
1509ctl_ioctl_lun_disable(void *arg, struct ctl_id targ_id, int lun_id)
1510{
1511	return (0);
1512}
1513
1514/*
1515 * Data movement routine for the CTL ioctl frontend port.
1516 */
1517static int
1518ctl_ioctl_do_datamove(struct ctl_scsiio *ctsio)
1519{
1520	struct ctl_sg_entry *ext_sglist, *kern_sglist;
1521	struct ctl_sg_entry ext_entry, kern_entry;
1522	int ext_sglen, ext_sg_entries, kern_sg_entries;
1523	int ext_sg_start, ext_offset;
1524	int len_to_copy, len_copied;
1525	int kern_watermark, ext_watermark;
1526	int ext_sglist_malloced;
1527	int i, j;
1528
1529	ext_sglist_malloced = 0;
1530	ext_sg_start = 0;
1531	ext_offset = 0;
1532
1533	CTL_DEBUG_PRINT(("ctl_ioctl_do_datamove\n"));
1534
1535	/*
1536	 * If this flag is set, fake the data transfer.
1537	 */
1538	if (ctsio->io_hdr.flags & CTL_FLAG_NO_DATAMOVE) {
1539		ctsio->ext_data_filled = ctsio->ext_data_len;
1540		goto bailout;
1541	}
1542
1543	/*
1544	 * To simplify things here, if we have a single buffer, stick it in
1545	 * a S/G entry and just make it a single entry S/G list.
1546	 */
1547	if (ctsio->io_hdr.flags & CTL_FLAG_EDPTR_SGLIST) {
1548		int len_seen;
1549
1550		ext_sglen = ctsio->ext_sg_entries * sizeof(*ext_sglist);
1551
1552		ext_sglist = (struct ctl_sg_entry *)malloc(ext_sglen, M_CTL,
1553							   M_WAITOK);
1554		ext_sglist_malloced = 1;
1555		if (copyin(ctsio->ext_data_ptr, ext_sglist,
1556				   ext_sglen) != 0) {
1557			ctl_set_internal_failure(ctsio,
1558						 /*sks_valid*/ 0,
1559						 /*retry_count*/ 0);
1560			goto bailout;
1561		}
1562		ext_sg_entries = ctsio->ext_sg_entries;
1563		len_seen = 0;
1564		for (i = 0; i < ext_sg_entries; i++) {
1565			if ((len_seen + ext_sglist[i].len) >=
1566			     ctsio->ext_data_filled) {
1567				ext_sg_start = i;
1568				ext_offset = ctsio->ext_data_filled - len_seen;
1569				break;
1570			}
1571			len_seen += ext_sglist[i].len;
1572		}
1573	} else {
1574		ext_sglist = &ext_entry;
1575		ext_sglist->addr = ctsio->ext_data_ptr;
1576		ext_sglist->len = ctsio->ext_data_len;
1577		ext_sg_entries = 1;
1578		ext_sg_start = 0;
1579		ext_offset = ctsio->ext_data_filled;
1580	}
1581
1582	if (ctsio->kern_sg_entries > 0) {
1583		kern_sglist = (struct ctl_sg_entry *)ctsio->kern_data_ptr;
1584		kern_sg_entries = ctsio->kern_sg_entries;
1585	} else {
1586		kern_sglist = &kern_entry;
1587		kern_sglist->addr = ctsio->kern_data_ptr;
1588		kern_sglist->len = ctsio->kern_data_len;
1589		kern_sg_entries = 1;
1590	}
1591
1592
1593	kern_watermark = 0;
1594	ext_watermark = ext_offset;
1595	len_copied = 0;
1596	for (i = ext_sg_start, j = 0;
1597	     i < ext_sg_entries && j < kern_sg_entries;) {
1598		uint8_t *ext_ptr, *kern_ptr;
1599
1600		len_to_copy = ctl_min(ext_sglist[i].len - ext_watermark,
1601				      kern_sglist[j].len - kern_watermark);
1602
1603		ext_ptr = (uint8_t *)ext_sglist[i].addr;
1604		ext_ptr = ext_ptr + ext_watermark;
1605		if (ctsio->io_hdr.flags & CTL_FLAG_BUS_ADDR) {
1606			/*
1607			 * XXX KDM fix this!
1608			 */
1609			panic("need to implement bus address support");
1610#if 0
1611			kern_ptr = bus_to_virt(kern_sglist[j].addr);
1612#endif
1613		} else
1614			kern_ptr = (uint8_t *)kern_sglist[j].addr;
1615		kern_ptr = kern_ptr + kern_watermark;
1616
1617		kern_watermark += len_to_copy;
1618		ext_watermark += len_to_copy;
1619
1620		if ((ctsio->io_hdr.flags & CTL_FLAG_DATA_MASK) ==
1621		     CTL_FLAG_DATA_IN) {
1622			CTL_DEBUG_PRINT(("ctl_ioctl_do_datamove: copying %d "
1623					 "bytes to user\n", len_to_copy));
1624			CTL_DEBUG_PRINT(("ctl_ioctl_do_datamove: from %p "
1625					 "to %p\n", kern_ptr, ext_ptr));
1626			if (copyout(kern_ptr, ext_ptr, len_to_copy) != 0) {
1627				ctl_set_internal_failure(ctsio,
1628							 /*sks_valid*/ 0,
1629							 /*retry_count*/ 0);
1630				goto bailout;
1631			}
1632		} else {
1633			CTL_DEBUG_PRINT(("ctl_ioctl_do_datamove: copying %d "
1634					 "bytes from user\n", len_to_copy));
1635			CTL_DEBUG_PRINT(("ctl_ioctl_do_datamove: from %p "
1636					 "to %p\n", ext_ptr, kern_ptr));
1637			if (copyin(ext_ptr, kern_ptr, len_to_copy)!= 0){
1638				ctl_set_internal_failure(ctsio,
1639							 /*sks_valid*/ 0,
1640							 /*retry_count*/0);
1641				goto bailout;
1642			}
1643		}
1644
1645		len_copied += len_to_copy;
1646
1647		if (ext_sglist[i].len == ext_watermark) {
1648			i++;
1649			ext_watermark = 0;
1650		}
1651
1652		if (kern_sglist[j].len == kern_watermark) {
1653			j++;
1654			kern_watermark = 0;
1655		}
1656	}
1657
1658	ctsio->ext_data_filled += len_copied;
1659
1660	CTL_DEBUG_PRINT(("ctl_ioctl_do_datamove: ext_sg_entries: %d, "
1661			 "kern_sg_entries: %d\n", ext_sg_entries,
1662			 kern_sg_entries));
1663	CTL_DEBUG_PRINT(("ctl_ioctl_do_datamove: ext_data_len = %d, "
1664			 "kern_data_len = %d\n", ctsio->ext_data_len,
1665			 ctsio->kern_data_len));
1666
1667
1668	/* XXX KDM set residual?? */
1669bailout:
1670
1671	if (ext_sglist_malloced != 0)
1672		free(ext_sglist, M_CTL);
1673
1674	return (CTL_RETVAL_COMPLETE);
1675}
1676
1677/*
1678 * Serialize a command that went down the "wrong" side, and so was sent to
1679 * this controller for execution.  The logic is a little different than the
1680 * standard case in ctl_scsiio_precheck().  Errors in this case need to get
1681 * sent back to the other side, but in the success case, we execute the
1682 * command on this side (XFER mode) or tell the other side to execute it
1683 * (SER_ONLY mode).
1684 */
1685static int
1686ctl_serialize_other_sc_cmd(struct ctl_scsiio *ctsio, int have_lock)
1687{
1688	struct ctl_softc *ctl_softc;
1689	union ctl_ha_msg msg_info;
1690	struct ctl_lun *lun;
1691	int retval = 0;
1692	uint32_t targ_lun;
1693
1694	ctl_softc = control_softc;
1695	if (have_lock == 0)
1696		mtx_lock(&ctl_softc->ctl_lock);
1697
1698	targ_lun = ctsio->io_hdr.nexus.targ_lun;
1699	if (ctsio->io_hdr.nexus.lun_map_fn != NULL)
1700		targ_lun = ctsio->io_hdr.nexus.lun_map_fn(ctsio->io_hdr.nexus.lun_map_arg, targ_lun);
1701	lun = ctl_softc->ctl_luns[targ_lun];
1702	if (lun==NULL)
1703	{
1704		/*
1705		 * Why isn't LUN defined? The other side wouldn't
1706		 * send a cmd if the LUN is undefined.
1707		 */
1708		printf("%s: Bad JUJU!, LUN is NULL!\n", __func__);
1709
1710		/* "Logical unit not supported" */
1711		ctl_set_sense_data(&msg_info.scsi.sense_data,
1712				   lun,
1713				   /*sense_format*/SSD_TYPE_NONE,
1714				   /*current_error*/ 1,
1715				   /*sense_key*/ SSD_KEY_ILLEGAL_REQUEST,
1716				   /*asc*/ 0x25,
1717				   /*ascq*/ 0x00,
1718				   SSD_ELEM_NONE);
1719
1720		msg_info.scsi.sense_len = SSD_FULL_SIZE;
1721		msg_info.scsi.scsi_status = SCSI_STATUS_CHECK_COND;
1722		msg_info.hdr.status = CTL_SCSI_ERROR | CTL_AUTOSENSE;
1723		msg_info.hdr.original_sc = ctsio->io_hdr.original_sc;
1724		msg_info.hdr.serializing_sc = NULL;
1725		msg_info.hdr.msg_type = CTL_MSG_BAD_JUJU;
1726	        if (ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg_info,
1727				sizeof(msg_info), 0 ) > CTL_HA_STATUS_SUCCESS) {
1728		}
1729		if (have_lock == 0)
1730			mtx_unlock(&ctl_softc->ctl_lock);
1731		return(1);
1732
1733	}
1734
1735    	TAILQ_INSERT_TAIL(&lun->ooa_queue, &ctsio->io_hdr, ooa_links);
1736
1737	switch (ctl_check_ooa(lun, (union ctl_io *)ctsio,
1738		(union ctl_io *)TAILQ_PREV(&ctsio->io_hdr, ctl_ooaq,
1739		 ooa_links))) {
1740	case CTL_ACTION_BLOCK:
1741		ctsio->io_hdr.flags |= CTL_FLAG_BLOCKED;
1742		TAILQ_INSERT_TAIL(&lun->blocked_queue, &ctsio->io_hdr,
1743				  blocked_links);
1744		break;
1745	case CTL_ACTION_PASS:
1746	case CTL_ACTION_SKIP:
1747		if (ctl_softc->ha_mode == CTL_HA_MODE_XFER) {
1748			ctsio->io_hdr.flags |= CTL_FLAG_IS_WAS_ON_RTR;
1749			STAILQ_INSERT_TAIL(&ctl_softc->rtr_queue,
1750					   &ctsio->io_hdr, links);
1751		} else {
1752
1753			/* send msg back to other side */
1754			msg_info.hdr.original_sc = ctsio->io_hdr.original_sc;
1755			msg_info.hdr.serializing_sc = (union ctl_io *)ctsio;
1756			msg_info.hdr.msg_type = CTL_MSG_R2R;
1757#if 0
1758			printf("2. pOrig %x\n", (int)msg_info.hdr.original_sc);
1759#endif
1760		        if (ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg_info,
1761			    sizeof(msg_info), 0 ) > CTL_HA_STATUS_SUCCESS) {
1762			}
1763		}
1764		break;
1765	case CTL_ACTION_OVERLAP:
1766		/* OVERLAPPED COMMANDS ATTEMPTED */
1767		ctl_set_sense_data(&msg_info.scsi.sense_data,
1768				   lun,
1769				   /*sense_format*/SSD_TYPE_NONE,
1770				   /*current_error*/ 1,
1771				   /*sense_key*/ SSD_KEY_ILLEGAL_REQUEST,
1772				   /*asc*/ 0x4E,
1773				   /*ascq*/ 0x00,
1774				   SSD_ELEM_NONE);
1775
1776		msg_info.scsi.sense_len = SSD_FULL_SIZE;
1777		msg_info.scsi.scsi_status = SCSI_STATUS_CHECK_COND;
1778		msg_info.hdr.status = CTL_SCSI_ERROR | CTL_AUTOSENSE;
1779		msg_info.hdr.original_sc = ctsio->io_hdr.original_sc;
1780		msg_info.hdr.serializing_sc = NULL;
1781		msg_info.hdr.msg_type = CTL_MSG_BAD_JUJU;
1782#if 0
1783		printf("BAD JUJU:Major Bummer Overlap\n");
1784#endif
1785		TAILQ_REMOVE(&lun->ooa_queue, &ctsio->io_hdr, ooa_links);
1786		retval = 1;
1787		if (ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg_info,
1788		    sizeof(msg_info), 0 ) > CTL_HA_STATUS_SUCCESS) {
1789		}
1790		break;
1791	case CTL_ACTION_OVERLAP_TAG:
1792		/* TAGGED OVERLAPPED COMMANDS (NN = QUEUE TAG) */
1793		ctl_set_sense_data(&msg_info.scsi.sense_data,
1794				   lun,
1795				   /*sense_format*/SSD_TYPE_NONE,
1796				   /*current_error*/ 1,
1797				   /*sense_key*/ SSD_KEY_ILLEGAL_REQUEST,
1798				   /*asc*/ 0x4D,
1799				   /*ascq*/ ctsio->tag_num & 0xff,
1800				   SSD_ELEM_NONE);
1801
1802		msg_info.scsi.sense_len = SSD_FULL_SIZE;
1803		msg_info.scsi.scsi_status = SCSI_STATUS_CHECK_COND;
1804		msg_info.hdr.status = CTL_SCSI_ERROR | CTL_AUTOSENSE;
1805		msg_info.hdr.original_sc = ctsio->io_hdr.original_sc;
1806		msg_info.hdr.serializing_sc = NULL;
1807		msg_info.hdr.msg_type = CTL_MSG_BAD_JUJU;
1808#if 0
1809		printf("BAD JUJU:Major Bummer Overlap Tag\n");
1810#endif
1811		TAILQ_REMOVE(&lun->ooa_queue, &ctsio->io_hdr, ooa_links);
1812		retval = 1;
1813		if (ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg_info,
1814		    sizeof(msg_info), 0 ) > CTL_HA_STATUS_SUCCESS) {
1815		}
1816		break;
1817	case CTL_ACTION_ERROR:
1818	default:
1819		/* "Internal target failure" */
1820		ctl_set_sense_data(&msg_info.scsi.sense_data,
1821				   lun,
1822				   /*sense_format*/SSD_TYPE_NONE,
1823				   /*current_error*/ 1,
1824				   /*sense_key*/ SSD_KEY_HARDWARE_ERROR,
1825				   /*asc*/ 0x44,
1826				   /*ascq*/ 0x00,
1827				   SSD_ELEM_NONE);
1828
1829		msg_info.scsi.sense_len = SSD_FULL_SIZE;
1830		msg_info.scsi.scsi_status = SCSI_STATUS_CHECK_COND;
1831		msg_info.hdr.status = CTL_SCSI_ERROR | CTL_AUTOSENSE;
1832		msg_info.hdr.original_sc = ctsio->io_hdr.original_sc;
1833		msg_info.hdr.serializing_sc = NULL;
1834		msg_info.hdr.msg_type = CTL_MSG_BAD_JUJU;
1835#if 0
1836		printf("BAD JUJU:Major Bummer HW Error\n");
1837#endif
1838		TAILQ_REMOVE(&lun->ooa_queue, &ctsio->io_hdr, ooa_links);
1839		retval = 1;
1840		if (ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg_info,
1841		    sizeof(msg_info), 0 ) > CTL_HA_STATUS_SUCCESS) {
1842		}
1843		break;
1844	}
1845	if (have_lock == 0)
1846		mtx_unlock(&ctl_softc->ctl_lock);
1847	return (retval);
1848}
1849
1850static int
1851ctl_ioctl_submit_wait(union ctl_io *io)
1852{
1853	struct ctl_fe_ioctl_params params;
1854	ctl_fe_ioctl_state last_state;
1855	int done, retval;
1856
1857	retval = 0;
1858
1859	bzero(&params, sizeof(params));
1860
1861	mtx_init(&params.ioctl_mtx, "ctliocmtx", NULL, MTX_DEF);
1862	cv_init(&params.sem, "ctlioccv");
1863	params.state = CTL_IOCTL_INPROG;
1864	last_state = params.state;
1865
1866	io->io_hdr.ctl_private[CTL_PRIV_FRONTEND].ptr = &params;
1867
1868	CTL_DEBUG_PRINT(("ctl_ioctl_submit_wait\n"));
1869
1870	/* This shouldn't happen */
1871	if ((retval = ctl_queue(io)) != CTL_RETVAL_COMPLETE)
1872		return (retval);
1873
1874	done = 0;
1875
1876	do {
1877		mtx_lock(&params.ioctl_mtx);
1878		/*
1879		 * Check the state here, and don't sleep if the state has
1880		 * already changed (i.e. wakeup has already occured, but we
1881		 * weren't waiting yet).
1882		 */
1883		if (params.state == last_state) {
1884			/* XXX KDM cv_wait_sig instead? */
1885			cv_wait(&params.sem, &params.ioctl_mtx);
1886		}
1887		last_state = params.state;
1888
1889		switch (params.state) {
1890		case CTL_IOCTL_INPROG:
1891			/* Why did we wake up? */
1892			/* XXX KDM error here? */
1893			mtx_unlock(&params.ioctl_mtx);
1894			break;
1895		case CTL_IOCTL_DATAMOVE:
1896			CTL_DEBUG_PRINT(("got CTL_IOCTL_DATAMOVE\n"));
1897
1898			/*
1899			 * change last_state back to INPROG to avoid
1900			 * deadlock on subsequent data moves.
1901			 */
1902			params.state = last_state = CTL_IOCTL_INPROG;
1903
1904			mtx_unlock(&params.ioctl_mtx);
1905			ctl_ioctl_do_datamove(&io->scsiio);
1906			/*
1907			 * Note that in some cases, most notably writes,
1908			 * this will queue the I/O and call us back later.
1909			 * In other cases, generally reads, this routine
1910			 * will immediately call back and wake us up,
1911			 * probably using our own context.
1912			 */
1913			io->scsiio.be_move_done(io);
1914			break;
1915		case CTL_IOCTL_DONE:
1916			mtx_unlock(&params.ioctl_mtx);
1917			CTL_DEBUG_PRINT(("got CTL_IOCTL_DONE\n"));
1918			done = 1;
1919			break;
1920		default:
1921			mtx_unlock(&params.ioctl_mtx);
1922			/* XXX KDM error here? */
1923			break;
1924		}
1925	} while (done == 0);
1926
1927	mtx_destroy(&params.ioctl_mtx);
1928	cv_destroy(&params.sem);
1929
1930	return (CTL_RETVAL_COMPLETE);
1931}
1932
1933static void
1934ctl_ioctl_datamove(union ctl_io *io)
1935{
1936	struct ctl_fe_ioctl_params *params;
1937
1938	params = (struct ctl_fe_ioctl_params *)
1939		io->io_hdr.ctl_private[CTL_PRIV_FRONTEND].ptr;
1940
1941	mtx_lock(&params->ioctl_mtx);
1942	params->state = CTL_IOCTL_DATAMOVE;
1943	cv_broadcast(&params->sem);
1944	mtx_unlock(&params->ioctl_mtx);
1945}
1946
1947static void
1948ctl_ioctl_done(union ctl_io *io)
1949{
1950	struct ctl_fe_ioctl_params *params;
1951
1952	params = (struct ctl_fe_ioctl_params *)
1953		io->io_hdr.ctl_private[CTL_PRIV_FRONTEND].ptr;
1954
1955	mtx_lock(&params->ioctl_mtx);
1956	params->state = CTL_IOCTL_DONE;
1957	cv_broadcast(&params->sem);
1958	mtx_unlock(&params->ioctl_mtx);
1959}
1960
1961static void
1962ctl_ioctl_hard_startstop_callback(void *arg, struct cfi_metatask *metatask)
1963{
1964	struct ctl_fe_ioctl_startstop_info *sd_info;
1965
1966	sd_info = (struct ctl_fe_ioctl_startstop_info *)arg;
1967
1968	sd_info->hs_info.status = metatask->status;
1969	sd_info->hs_info.total_luns = metatask->taskinfo.startstop.total_luns;
1970	sd_info->hs_info.luns_complete =
1971		metatask->taskinfo.startstop.luns_complete;
1972	sd_info->hs_info.luns_failed = metatask->taskinfo.startstop.luns_failed;
1973
1974	cv_broadcast(&sd_info->sem);
1975}
1976
1977static void
1978ctl_ioctl_bbrread_callback(void *arg, struct cfi_metatask *metatask)
1979{
1980	struct ctl_fe_ioctl_bbrread_info *fe_bbr_info;
1981
1982	fe_bbr_info = (struct ctl_fe_ioctl_bbrread_info *)arg;
1983
1984	mtx_lock(fe_bbr_info->lock);
1985	fe_bbr_info->bbr_info->status = metatask->status;
1986	fe_bbr_info->bbr_info->bbr_status = metatask->taskinfo.bbrread.status;
1987	fe_bbr_info->wakeup_done = 1;
1988	mtx_unlock(fe_bbr_info->lock);
1989
1990	cv_broadcast(&fe_bbr_info->sem);
1991}
1992
1993/*
1994 * Returns 0 for success, errno for failure.
1995 */
1996static int
1997ctl_ioctl_fill_ooa(struct ctl_lun *lun, uint32_t *cur_fill_num,
1998		   struct ctl_ooa *ooa_hdr, struct ctl_ooa_entry *kern_entries)
1999{
2000	union ctl_io *io;
2001	int retval;
2002
2003	retval = 0;
2004
2005	mtx_assert(&control_softc->ctl_lock, MA_OWNED);
2006
2007	for (io = (union ctl_io *)TAILQ_FIRST(&lun->ooa_queue); (io != NULL);
2008	     (*cur_fill_num)++, io = (union ctl_io *)TAILQ_NEXT(&io->io_hdr,
2009	     ooa_links)) {
2010		struct ctl_ooa_entry *entry;
2011
2012		/*
2013		 * If we've got more than we can fit, just count the
2014		 * remaining entries.
2015		 */
2016		if (*cur_fill_num >= ooa_hdr->alloc_num)
2017			continue;
2018
2019		entry = &kern_entries[*cur_fill_num];
2020
2021		entry->tag_num = io->scsiio.tag_num;
2022		entry->lun_num = lun->lun;
2023#ifdef CTL_TIME_IO
2024		entry->start_bt = io->io_hdr.start_bt;
2025#endif
2026		bcopy(io->scsiio.cdb, entry->cdb, io->scsiio.cdb_len);
2027		entry->cdb_len = io->scsiio.cdb_len;
2028		if (io->io_hdr.flags & CTL_FLAG_BLOCKED)
2029			entry->cmd_flags |= CTL_OOACMD_FLAG_BLOCKED;
2030
2031		if (io->io_hdr.flags & CTL_FLAG_DMA_INPROG)
2032			entry->cmd_flags |= CTL_OOACMD_FLAG_DMA;
2033
2034		if (io->io_hdr.flags & CTL_FLAG_ABORT)
2035			entry->cmd_flags |= CTL_OOACMD_FLAG_ABORT;
2036
2037		if (io->io_hdr.flags & CTL_FLAG_IS_WAS_ON_RTR)
2038			entry->cmd_flags |= CTL_OOACMD_FLAG_RTR;
2039
2040		if (io->io_hdr.flags & CTL_FLAG_DMA_QUEUED)
2041			entry->cmd_flags |= CTL_OOACMD_FLAG_DMA_QUEUED;
2042	}
2043
2044	return (retval);
2045}
2046
2047static void *
2048ctl_copyin_alloc(void *user_addr, int len, char *error_str,
2049		 size_t error_str_len)
2050{
2051	void *kptr;
2052
2053	kptr = malloc(len, M_CTL, M_WAITOK | M_ZERO);
2054
2055	if (copyin(user_addr, kptr, len) != 0) {
2056		snprintf(error_str, error_str_len, "Error copying %d bytes "
2057			 "from user address %p to kernel address %p", len,
2058			 user_addr, kptr);
2059		free(kptr, M_CTL);
2060		return (NULL);
2061	}
2062
2063	return (kptr);
2064}
2065
2066static void
2067ctl_free_args(int num_be_args, struct ctl_be_arg *be_args)
2068{
2069	int i;
2070
2071	if (be_args == NULL)
2072		return;
2073
2074	for (i = 0; i < num_be_args; i++) {
2075		free(be_args[i].kname, M_CTL);
2076		free(be_args[i].kvalue, M_CTL);
2077	}
2078
2079	free(be_args, M_CTL);
2080}
2081
2082static struct ctl_be_arg *
2083ctl_copyin_args(int num_be_args, struct ctl_be_arg *be_args,
2084		char *error_str, size_t error_str_len)
2085{
2086	struct ctl_be_arg *args;
2087	int i;
2088
2089	args = ctl_copyin_alloc(be_args, num_be_args * sizeof(*be_args),
2090				error_str, error_str_len);
2091
2092	if (args == NULL)
2093		goto bailout;
2094
2095	for (i = 0; i < num_be_args; i++) {
2096		args[i].kname = NULL;
2097		args[i].kvalue = NULL;
2098	}
2099
2100	for (i = 0; i < num_be_args; i++) {
2101		uint8_t *tmpptr;
2102
2103		args[i].kname = ctl_copyin_alloc(args[i].name,
2104			args[i].namelen, error_str, error_str_len);
2105		if (args[i].kname == NULL)
2106			goto bailout;
2107
2108		if (args[i].kname[args[i].namelen - 1] != '\0') {
2109			snprintf(error_str, error_str_len, "Argument %d "
2110				 "name is not NUL-terminated", i);
2111			goto bailout;
2112		}
2113
2114		args[i].kvalue = NULL;
2115
2116		tmpptr = ctl_copyin_alloc(args[i].value,
2117			args[i].vallen, error_str, error_str_len);
2118		if (tmpptr == NULL)
2119			goto bailout;
2120
2121		args[i].kvalue = tmpptr;
2122
2123		if ((args[i].flags & CTL_BEARG_ASCII)
2124		 && (tmpptr[args[i].vallen - 1] != '\0')) {
2125			snprintf(error_str, error_str_len, "Argument %d "
2126				 "value is not NUL-terminated", i);
2127			goto bailout;
2128		}
2129	}
2130
2131	return (args);
2132bailout:
2133
2134	ctl_free_args(num_be_args, args);
2135
2136	return (NULL);
2137}
2138
2139/*
2140 * Escape characters that are illegal or not recommended in XML.
2141 */
2142int
2143ctl_sbuf_printf_esc(struct sbuf *sb, char *str)
2144{
2145	int retval;
2146
2147	retval = 0;
2148
2149	for (; *str; str++) {
2150		switch (*str) {
2151		case '&':
2152			retval = sbuf_printf(sb, "&amp;");
2153			break;
2154		case '>':
2155			retval = sbuf_printf(sb, "&gt;");
2156			break;
2157		case '<':
2158			retval = sbuf_printf(sb, "&lt;");
2159			break;
2160		default:
2161			retval = sbuf_putc(sb, *str);
2162			break;
2163		}
2164
2165		if (retval != 0)
2166			break;
2167
2168	}
2169
2170	return (retval);
2171}
2172
2173static int
2174ctl_ioctl(struct cdev *dev, u_long cmd, caddr_t addr, int flag,
2175	  struct thread *td)
2176{
2177	struct ctl_softc *softc;
2178	int retval;
2179
2180	softc = control_softc;
2181
2182	retval = 0;
2183
2184	switch (cmd) {
2185	case CTL_IO: {
2186		union ctl_io *io;
2187		void *pool_tmp;
2188
2189		/*
2190		 * If we haven't been "enabled", don't allow any SCSI I/O
2191		 * to this FETD.
2192		 */
2193		if ((softc->ioctl_info.flags & CTL_IOCTL_FLAG_ENABLED) == 0) {
2194			retval = EPERM;
2195			break;
2196		}
2197
2198		io = ctl_alloc_io(softc->ioctl_info.fe.ctl_pool_ref);
2199		if (io == NULL) {
2200			printf("ctl_ioctl: can't allocate ctl_io!\n");
2201			retval = ENOSPC;
2202			break;
2203		}
2204
2205		/*
2206		 * Need to save the pool reference so it doesn't get
2207		 * spammed by the user's ctl_io.
2208		 */
2209		pool_tmp = io->io_hdr.pool;
2210
2211		memcpy(io, (void *)addr, sizeof(*io));
2212
2213		io->io_hdr.pool = pool_tmp;
2214		/*
2215		 * No status yet, so make sure the status is set properly.
2216		 */
2217		io->io_hdr.status = CTL_STATUS_NONE;
2218
2219		/*
2220		 * The user sets the initiator ID, target and LUN IDs.
2221		 */
2222		io->io_hdr.nexus.targ_port = softc->ioctl_info.fe.targ_port;
2223		io->io_hdr.flags |= CTL_FLAG_USER_REQ;
2224		if ((io->io_hdr.io_type == CTL_IO_SCSI)
2225		 && (io->scsiio.tag_type != CTL_TAG_UNTAGGED))
2226			io->scsiio.tag_num = softc->ioctl_info.cur_tag_num++;
2227
2228		retval = ctl_ioctl_submit_wait(io);
2229
2230		if (retval != 0) {
2231			ctl_free_io(io);
2232			break;
2233		}
2234
2235		memcpy((void *)addr, io, sizeof(*io));
2236
2237		/* return this to our pool */
2238		ctl_free_io(io);
2239
2240		break;
2241	}
2242	case CTL_ENABLE_PORT:
2243	case CTL_DISABLE_PORT:
2244	case CTL_SET_PORT_WWNS: {
2245		struct ctl_frontend *fe;
2246		struct ctl_port_entry *entry;
2247
2248		entry = (struct ctl_port_entry *)addr;
2249
2250		mtx_lock(&softc->ctl_lock);
2251		STAILQ_FOREACH(fe, &softc->fe_list, links) {
2252			int action, done;
2253
2254			action = 0;
2255			done = 0;
2256
2257			if ((entry->port_type == CTL_PORT_NONE)
2258			 && (entry->targ_port == fe->targ_port)) {
2259				/*
2260				 * If the user only wants to enable or
2261				 * disable or set WWNs on a specific port,
2262				 * do the operation and we're done.
2263				 */
2264				action = 1;
2265				done = 1;
2266			} else if (entry->port_type & fe->port_type) {
2267				/*
2268				 * Compare the user's type mask with the
2269				 * particular frontend type to see if we
2270				 * have a match.
2271				 */
2272				action = 1;
2273				done = 0;
2274
2275				/*
2276				 * Make sure the user isn't trying to set
2277				 * WWNs on multiple ports at the same time.
2278				 */
2279				if (cmd == CTL_SET_PORT_WWNS) {
2280					printf("%s: Can't set WWNs on "
2281					       "multiple ports\n", __func__);
2282					retval = EINVAL;
2283					break;
2284				}
2285			}
2286			if (action != 0) {
2287				/*
2288				 * XXX KDM we have to drop the lock here,
2289				 * because the online/offline operations
2290				 * can potentially block.  We need to
2291				 * reference count the frontends so they
2292				 * can't go away,
2293				 */
2294				mtx_unlock(&softc->ctl_lock);
2295
2296				if (cmd == CTL_ENABLE_PORT) {
2297					struct ctl_lun *lun;
2298
2299					STAILQ_FOREACH(lun, &softc->lun_list,
2300						       links) {
2301						fe->lun_enable(fe->targ_lun_arg,
2302						    lun->target,
2303						    lun->lun);
2304					}
2305
2306					ctl_frontend_online(fe);
2307				} else if (cmd == CTL_DISABLE_PORT) {
2308					struct ctl_lun *lun;
2309
2310					ctl_frontend_offline(fe);
2311
2312					STAILQ_FOREACH(lun, &softc->lun_list,
2313						       links) {
2314						fe->lun_disable(
2315						    fe->targ_lun_arg,
2316						    lun->target,
2317						    lun->lun);
2318					}
2319				}
2320
2321				mtx_lock(&softc->ctl_lock);
2322
2323				if (cmd == CTL_SET_PORT_WWNS)
2324					ctl_frontend_set_wwns(fe,
2325					    (entry->flags & CTL_PORT_WWNN_VALID) ?
2326					    1 : 0, entry->wwnn,
2327					    (entry->flags & CTL_PORT_WWPN_VALID) ?
2328					    1 : 0, entry->wwpn);
2329			}
2330			if (done != 0)
2331				break;
2332		}
2333		mtx_unlock(&softc->ctl_lock);
2334		break;
2335	}
2336	case CTL_GET_PORT_LIST: {
2337		struct ctl_frontend *fe;
2338		struct ctl_port_list *list;
2339		int i;
2340
2341		list = (struct ctl_port_list *)addr;
2342
2343		if (list->alloc_len != (list->alloc_num *
2344		    sizeof(struct ctl_port_entry))) {
2345			printf("%s: CTL_GET_PORT_LIST: alloc_len %u != "
2346			       "alloc_num %u * sizeof(struct ctl_port_entry) "
2347			       "%zu\n", __func__, list->alloc_len,
2348			       list->alloc_num, sizeof(struct ctl_port_entry));
2349			retval = EINVAL;
2350			break;
2351		}
2352		list->fill_len = 0;
2353		list->fill_num = 0;
2354		list->dropped_num = 0;
2355		i = 0;
2356		mtx_lock(&softc->ctl_lock);
2357		STAILQ_FOREACH(fe, &softc->fe_list, links) {
2358			struct ctl_port_entry entry, *list_entry;
2359
2360			if (list->fill_num >= list->alloc_num) {
2361				list->dropped_num++;
2362				continue;
2363			}
2364
2365			entry.port_type = fe->port_type;
2366			strlcpy(entry.port_name, fe->port_name,
2367				sizeof(entry.port_name));
2368			entry.targ_port = fe->targ_port;
2369			entry.physical_port = fe->physical_port;
2370			entry.virtual_port = fe->virtual_port;
2371			entry.wwnn = fe->wwnn;
2372			entry.wwpn = fe->wwpn;
2373			if (fe->status & CTL_PORT_STATUS_ONLINE)
2374				entry.online = 1;
2375			else
2376				entry.online = 0;
2377
2378			list_entry = &list->entries[i];
2379
2380			retval = copyout(&entry, list_entry, sizeof(entry));
2381			if (retval != 0) {
2382				printf("%s: CTL_GET_PORT_LIST: copyout "
2383				       "returned %d\n", __func__, retval);
2384				break;
2385			}
2386			i++;
2387			list->fill_num++;
2388			list->fill_len += sizeof(entry);
2389		}
2390		mtx_unlock(&softc->ctl_lock);
2391
2392		/*
2393		 * If this is non-zero, we had a copyout fault, so there's
2394		 * probably no point in attempting to set the status inside
2395		 * the structure.
2396		 */
2397		if (retval != 0)
2398			break;
2399
2400		if (list->dropped_num > 0)
2401			list->status = CTL_PORT_LIST_NEED_MORE_SPACE;
2402		else
2403			list->status = CTL_PORT_LIST_OK;
2404		break;
2405	}
2406	case CTL_DUMP_OOA: {
2407		struct ctl_lun *lun;
2408		union ctl_io *io;
2409		char printbuf[128];
2410		struct sbuf sb;
2411
2412		mtx_lock(&softc->ctl_lock);
2413		printf("Dumping OOA queues:\n");
2414		STAILQ_FOREACH(lun, &softc->lun_list, links) {
2415			for (io = (union ctl_io *)TAILQ_FIRST(
2416			     &lun->ooa_queue); io != NULL;
2417			     io = (union ctl_io *)TAILQ_NEXT(&io->io_hdr,
2418			     ooa_links)) {
2419				sbuf_new(&sb, printbuf, sizeof(printbuf),
2420					 SBUF_FIXEDLEN);
2421				sbuf_printf(&sb, "LUN %jd tag 0x%04x%s%s%s%s: ",
2422					    (intmax_t)lun->lun,
2423					    io->scsiio.tag_num,
2424					    (io->io_hdr.flags &
2425					    CTL_FLAG_BLOCKED) ? "" : " BLOCKED",
2426					    (io->io_hdr.flags &
2427					    CTL_FLAG_DMA_INPROG) ? " DMA" : "",
2428					    (io->io_hdr.flags &
2429					    CTL_FLAG_ABORT) ? " ABORT" : "",
2430			                    (io->io_hdr.flags &
2431		                        CTL_FLAG_IS_WAS_ON_RTR) ? " RTR" : "");
2432				ctl_scsi_command_string(&io->scsiio, NULL, &sb);
2433				sbuf_finish(&sb);
2434				printf("%s\n", sbuf_data(&sb));
2435			}
2436		}
2437		printf("OOA queues dump done\n");
2438		mtx_unlock(&softc->ctl_lock);
2439		break;
2440	}
2441	case CTL_GET_OOA: {
2442		struct ctl_lun *lun;
2443		struct ctl_ooa *ooa_hdr;
2444		struct ctl_ooa_entry *entries;
2445		uint32_t cur_fill_num;
2446
2447		ooa_hdr = (struct ctl_ooa *)addr;
2448
2449		if ((ooa_hdr->alloc_len == 0)
2450		 || (ooa_hdr->alloc_num == 0)) {
2451			printf("%s: CTL_GET_OOA: alloc len %u and alloc num %u "
2452			       "must be non-zero\n", __func__,
2453			       ooa_hdr->alloc_len, ooa_hdr->alloc_num);
2454			retval = EINVAL;
2455			break;
2456		}
2457
2458		if (ooa_hdr->alloc_len != (ooa_hdr->alloc_num *
2459		    sizeof(struct ctl_ooa_entry))) {
2460			printf("%s: CTL_GET_OOA: alloc len %u must be alloc "
2461			       "num %d * sizeof(struct ctl_ooa_entry) %zd\n",
2462			       __func__, ooa_hdr->alloc_len,
2463			       ooa_hdr->alloc_num,sizeof(struct ctl_ooa_entry));
2464			retval = EINVAL;
2465			break;
2466		}
2467
2468		entries = malloc(ooa_hdr->alloc_len, M_CTL, M_WAITOK | M_ZERO);
2469		if (entries == NULL) {
2470			printf("%s: could not allocate %d bytes for OOA "
2471			       "dump\n", __func__, ooa_hdr->alloc_len);
2472			retval = ENOMEM;
2473			break;
2474		}
2475
2476		mtx_lock(&softc->ctl_lock);
2477		if (((ooa_hdr->flags & CTL_OOA_FLAG_ALL_LUNS) == 0)
2478		 && ((ooa_hdr->lun_num > CTL_MAX_LUNS)
2479		  || (softc->ctl_luns[ooa_hdr->lun_num] == NULL))) {
2480			mtx_unlock(&softc->ctl_lock);
2481			free(entries, M_CTL);
2482			printf("%s: CTL_GET_OOA: invalid LUN %ju\n",
2483			       __func__, (uintmax_t)ooa_hdr->lun_num);
2484			retval = EINVAL;
2485			break;
2486		}
2487
2488		cur_fill_num = 0;
2489
2490		if (ooa_hdr->flags & CTL_OOA_FLAG_ALL_LUNS) {
2491			STAILQ_FOREACH(lun, &softc->lun_list, links) {
2492				retval = ctl_ioctl_fill_ooa(lun, &cur_fill_num,
2493					ooa_hdr, entries);
2494				if (retval != 0)
2495					break;
2496			}
2497			if (retval != 0) {
2498				mtx_unlock(&softc->ctl_lock);
2499				free(entries, M_CTL);
2500				break;
2501			}
2502		} else {
2503			lun = softc->ctl_luns[ooa_hdr->lun_num];
2504
2505			retval = ctl_ioctl_fill_ooa(lun, &cur_fill_num,ooa_hdr,
2506						    entries);
2507		}
2508		mtx_unlock(&softc->ctl_lock);
2509
2510		ooa_hdr->fill_num = min(cur_fill_num, ooa_hdr->alloc_num);
2511		ooa_hdr->fill_len = ooa_hdr->fill_num *
2512			sizeof(struct ctl_ooa_entry);
2513		retval = copyout(entries, ooa_hdr->entries, ooa_hdr->fill_len);
2514		if (retval != 0) {
2515			printf("%s: error copying out %d bytes for OOA dump\n",
2516			       __func__, ooa_hdr->fill_len);
2517		}
2518
2519		getbintime(&ooa_hdr->cur_bt);
2520
2521		if (cur_fill_num > ooa_hdr->alloc_num) {
2522			ooa_hdr->dropped_num = cur_fill_num -ooa_hdr->alloc_num;
2523			ooa_hdr->status = CTL_OOA_NEED_MORE_SPACE;
2524		} else {
2525			ooa_hdr->dropped_num = 0;
2526			ooa_hdr->status = CTL_OOA_OK;
2527		}
2528
2529		free(entries, M_CTL);
2530		break;
2531	}
2532	case CTL_CHECK_OOA: {
2533		union ctl_io *io;
2534		struct ctl_lun *lun;
2535		struct ctl_ooa_info *ooa_info;
2536
2537
2538		ooa_info = (struct ctl_ooa_info *)addr;
2539
2540		if (ooa_info->lun_id >= CTL_MAX_LUNS) {
2541			ooa_info->status = CTL_OOA_INVALID_LUN;
2542			break;
2543		}
2544		mtx_lock(&softc->ctl_lock);
2545		lun = softc->ctl_luns[ooa_info->lun_id];
2546		if (lun == NULL) {
2547			mtx_unlock(&softc->ctl_lock);
2548			ooa_info->status = CTL_OOA_INVALID_LUN;
2549			break;
2550		}
2551
2552		ooa_info->num_entries = 0;
2553		for (io = (union ctl_io *)TAILQ_FIRST(&lun->ooa_queue);
2554		     io != NULL; io = (union ctl_io *)TAILQ_NEXT(
2555		     &io->io_hdr, ooa_links)) {
2556			ooa_info->num_entries++;
2557		}
2558
2559		mtx_unlock(&softc->ctl_lock);
2560		ooa_info->status = CTL_OOA_SUCCESS;
2561
2562		break;
2563	}
2564	case CTL_HARD_START:
2565	case CTL_HARD_STOP: {
2566		struct ctl_fe_ioctl_startstop_info ss_info;
2567		struct cfi_metatask *metatask;
2568		struct mtx hs_mtx;
2569
2570		mtx_init(&hs_mtx, "HS Mutex", NULL, MTX_DEF);
2571
2572		cv_init(&ss_info.sem, "hard start/stop cv" );
2573
2574		metatask = cfi_alloc_metatask(/*can_wait*/ 1);
2575		if (metatask == NULL) {
2576			retval = ENOMEM;
2577			mtx_destroy(&hs_mtx);
2578			break;
2579		}
2580
2581		if (cmd == CTL_HARD_START)
2582			metatask->tasktype = CFI_TASK_STARTUP;
2583		else
2584			metatask->tasktype = CFI_TASK_SHUTDOWN;
2585
2586		metatask->callback = ctl_ioctl_hard_startstop_callback;
2587		metatask->callback_arg = &ss_info;
2588
2589		cfi_action(metatask);
2590
2591		/* Wait for the callback */
2592		mtx_lock(&hs_mtx);
2593		cv_wait_sig(&ss_info.sem, &hs_mtx);
2594		mtx_unlock(&hs_mtx);
2595
2596		/*
2597		 * All information has been copied from the metatask by the
2598		 * time cv_broadcast() is called, so we free the metatask here.
2599		 */
2600		cfi_free_metatask(metatask);
2601
2602		memcpy((void *)addr, &ss_info.hs_info, sizeof(ss_info.hs_info));
2603
2604		mtx_destroy(&hs_mtx);
2605		break;
2606	}
2607	case CTL_BBRREAD: {
2608		struct ctl_bbrread_info *bbr_info;
2609		struct ctl_fe_ioctl_bbrread_info fe_bbr_info;
2610		struct mtx bbr_mtx;
2611		struct cfi_metatask *metatask;
2612
2613		bbr_info = (struct ctl_bbrread_info *)addr;
2614
2615		bzero(&fe_bbr_info, sizeof(fe_bbr_info));
2616
2617		bzero(&bbr_mtx, sizeof(bbr_mtx));
2618		mtx_init(&bbr_mtx, "BBR Mutex", NULL, MTX_DEF);
2619
2620		fe_bbr_info.bbr_info = bbr_info;
2621		fe_bbr_info.lock = &bbr_mtx;
2622
2623		cv_init(&fe_bbr_info.sem, "BBR read cv");
2624		metatask = cfi_alloc_metatask(/*can_wait*/ 1);
2625
2626		if (metatask == NULL) {
2627			mtx_destroy(&bbr_mtx);
2628			cv_destroy(&fe_bbr_info.sem);
2629			retval = ENOMEM;
2630			break;
2631		}
2632		metatask->tasktype = CFI_TASK_BBRREAD;
2633		metatask->callback = ctl_ioctl_bbrread_callback;
2634		metatask->callback_arg = &fe_bbr_info;
2635		metatask->taskinfo.bbrread.lun_num = bbr_info->lun_num;
2636		metatask->taskinfo.bbrread.lba = bbr_info->lba;
2637		metatask->taskinfo.bbrread.len = bbr_info->len;
2638
2639		cfi_action(metatask);
2640
2641		mtx_lock(&bbr_mtx);
2642		while (fe_bbr_info.wakeup_done == 0)
2643			cv_wait_sig(&fe_bbr_info.sem, &bbr_mtx);
2644		mtx_unlock(&bbr_mtx);
2645
2646		bbr_info->status = metatask->status;
2647		bbr_info->bbr_status = metatask->taskinfo.bbrread.status;
2648		bbr_info->scsi_status = metatask->taskinfo.bbrread.scsi_status;
2649		memcpy(&bbr_info->sense_data,
2650		       &metatask->taskinfo.bbrread.sense_data,
2651		       ctl_min(sizeof(bbr_info->sense_data),
2652			       sizeof(metatask->taskinfo.bbrread.sense_data)));
2653
2654		cfi_free_metatask(metatask);
2655
2656		mtx_destroy(&bbr_mtx);
2657		cv_destroy(&fe_bbr_info.sem);
2658
2659		break;
2660	}
2661	case CTL_DELAY_IO: {
2662		struct ctl_io_delay_info *delay_info;
2663#ifdef CTL_IO_DELAY
2664		struct ctl_lun *lun;
2665#endif /* CTL_IO_DELAY */
2666
2667		delay_info = (struct ctl_io_delay_info *)addr;
2668
2669#ifdef CTL_IO_DELAY
2670		mtx_lock(&softc->ctl_lock);
2671
2672		if ((delay_info->lun_id > CTL_MAX_LUNS)
2673		 || (softc->ctl_luns[delay_info->lun_id] == NULL)) {
2674			delay_info->status = CTL_DELAY_STATUS_INVALID_LUN;
2675		} else {
2676			lun = softc->ctl_luns[delay_info->lun_id];
2677
2678			delay_info->status = CTL_DELAY_STATUS_OK;
2679
2680			switch (delay_info->delay_type) {
2681			case CTL_DELAY_TYPE_CONT:
2682				break;
2683			case CTL_DELAY_TYPE_ONESHOT:
2684				break;
2685			default:
2686				delay_info->status =
2687					CTL_DELAY_STATUS_INVALID_TYPE;
2688				break;
2689			}
2690
2691			switch (delay_info->delay_loc) {
2692			case CTL_DELAY_LOC_DATAMOVE:
2693				lun->delay_info.datamove_type =
2694					delay_info->delay_type;
2695				lun->delay_info.datamove_delay =
2696					delay_info->delay_secs;
2697				break;
2698			case CTL_DELAY_LOC_DONE:
2699				lun->delay_info.done_type =
2700					delay_info->delay_type;
2701				lun->delay_info.done_delay =
2702					delay_info->delay_secs;
2703				break;
2704			default:
2705				delay_info->status =
2706					CTL_DELAY_STATUS_INVALID_LOC;
2707				break;
2708			}
2709		}
2710
2711		mtx_unlock(&softc->ctl_lock);
2712#else
2713		delay_info->status = CTL_DELAY_STATUS_NOT_IMPLEMENTED;
2714#endif /* CTL_IO_DELAY */
2715		break;
2716	}
2717	case CTL_REALSYNC_SET: {
2718		int *syncstate;
2719
2720		syncstate = (int *)addr;
2721
2722		mtx_lock(&softc->ctl_lock);
2723		switch (*syncstate) {
2724		case 0:
2725			softc->flags &= ~CTL_FLAG_REAL_SYNC;
2726			break;
2727		case 1:
2728			softc->flags |= CTL_FLAG_REAL_SYNC;
2729			break;
2730		default:
2731			retval = EINVAL;
2732			break;
2733		}
2734		mtx_unlock(&softc->ctl_lock);
2735		break;
2736	}
2737	case CTL_REALSYNC_GET: {
2738		int *syncstate;
2739
2740		syncstate = (int*)addr;
2741
2742		mtx_lock(&softc->ctl_lock);
2743		if (softc->flags & CTL_FLAG_REAL_SYNC)
2744			*syncstate = 1;
2745		else
2746			*syncstate = 0;
2747		mtx_unlock(&softc->ctl_lock);
2748
2749		break;
2750	}
2751	case CTL_SETSYNC:
2752	case CTL_GETSYNC: {
2753		struct ctl_sync_info *sync_info;
2754		struct ctl_lun *lun;
2755
2756		sync_info = (struct ctl_sync_info *)addr;
2757
2758		mtx_lock(&softc->ctl_lock);
2759		lun = softc->ctl_luns[sync_info->lun_id];
2760		if (lun == NULL) {
2761			mtx_unlock(&softc->ctl_lock);
2762			sync_info->status = CTL_GS_SYNC_NO_LUN;
2763		}
2764		/*
2765		 * Get or set the sync interval.  We're not bounds checking
2766		 * in the set case, hopefully the user won't do something
2767		 * silly.
2768		 */
2769		if (cmd == CTL_GETSYNC)
2770			sync_info->sync_interval = lun->sync_interval;
2771		else
2772			lun->sync_interval = sync_info->sync_interval;
2773
2774		mtx_unlock(&softc->ctl_lock);
2775
2776		sync_info->status = CTL_GS_SYNC_OK;
2777
2778		break;
2779	}
2780	case CTL_GETSTATS: {
2781		struct ctl_stats *stats;
2782		struct ctl_lun *lun;
2783		int i;
2784
2785		stats = (struct ctl_stats *)addr;
2786
2787		if ((sizeof(struct ctl_lun_io_stats) * softc->num_luns) >
2788		     stats->alloc_len) {
2789			stats->status = CTL_SS_NEED_MORE_SPACE;
2790			stats->num_luns = softc->num_luns;
2791			break;
2792		}
2793		/*
2794		 * XXX KDM no locking here.  If the LUN list changes,
2795		 * things can blow up.
2796		 */
2797		for (i = 0, lun = STAILQ_FIRST(&softc->lun_list); lun != NULL;
2798		     i++, lun = STAILQ_NEXT(lun, links)) {
2799			retval = copyout(&lun->stats, &stats->lun_stats[i],
2800					 sizeof(lun->stats));
2801			if (retval != 0)
2802				break;
2803		}
2804		stats->num_luns = softc->num_luns;
2805		stats->fill_len = sizeof(struct ctl_lun_io_stats) *
2806				 softc->num_luns;
2807		stats->status = CTL_SS_OK;
2808#ifdef CTL_TIME_IO
2809		stats->flags = CTL_STATS_FLAG_TIME_VALID;
2810#else
2811		stats->flags = CTL_STATS_FLAG_NONE;
2812#endif
2813		getnanouptime(&stats->timestamp);
2814		break;
2815	}
2816	case CTL_ERROR_INJECT: {
2817		struct ctl_error_desc *err_desc, *new_err_desc;
2818		struct ctl_lun *lun;
2819
2820		err_desc = (struct ctl_error_desc *)addr;
2821
2822		new_err_desc = malloc(sizeof(*new_err_desc), M_CTL,
2823				      M_WAITOK | M_ZERO);
2824		bcopy(err_desc, new_err_desc, sizeof(*new_err_desc));
2825
2826		mtx_lock(&softc->ctl_lock);
2827		lun = softc->ctl_luns[err_desc->lun_id];
2828		if (lun == NULL) {
2829			mtx_unlock(&softc->ctl_lock);
2830			printf("%s: CTL_ERROR_INJECT: invalid LUN %ju\n",
2831			       __func__, (uintmax_t)err_desc->lun_id);
2832			retval = EINVAL;
2833			break;
2834		}
2835
2836		/*
2837		 * We could do some checking here to verify the validity
2838		 * of the request, but given the complexity of error
2839		 * injection requests, the checking logic would be fairly
2840		 * complex.
2841		 *
2842		 * For now, if the request is invalid, it just won't get
2843		 * executed and might get deleted.
2844		 */
2845		STAILQ_INSERT_TAIL(&lun->error_list, new_err_desc, links);
2846
2847		/*
2848		 * XXX KDM check to make sure the serial number is unique,
2849		 * in case we somehow manage to wrap.  That shouldn't
2850		 * happen for a very long time, but it's the right thing to
2851		 * do.
2852		 */
2853		new_err_desc->serial = lun->error_serial;
2854		err_desc->serial = lun->error_serial;
2855		lun->error_serial++;
2856
2857		mtx_unlock(&softc->ctl_lock);
2858		break;
2859	}
2860	case CTL_ERROR_INJECT_DELETE: {
2861		struct ctl_error_desc *delete_desc, *desc, *desc2;
2862		struct ctl_lun *lun;
2863		int delete_done;
2864
2865		delete_desc = (struct ctl_error_desc *)addr;
2866		delete_done = 0;
2867
2868		mtx_lock(&softc->ctl_lock);
2869		lun = softc->ctl_luns[delete_desc->lun_id];
2870		if (lun == NULL) {
2871			mtx_unlock(&softc->ctl_lock);
2872			printf("%s: CTL_ERROR_INJECT_DELETE: invalid LUN %ju\n",
2873			       __func__, (uintmax_t)delete_desc->lun_id);
2874			retval = EINVAL;
2875			break;
2876		}
2877		STAILQ_FOREACH_SAFE(desc, &lun->error_list, links, desc2) {
2878			if (desc->serial != delete_desc->serial)
2879				continue;
2880
2881			STAILQ_REMOVE(&lun->error_list, desc, ctl_error_desc,
2882				      links);
2883			free(desc, M_CTL);
2884			delete_done = 1;
2885		}
2886		mtx_unlock(&softc->ctl_lock);
2887		if (delete_done == 0) {
2888			printf("%s: CTL_ERROR_INJECT_DELETE: can't find "
2889			       "error serial %ju on LUN %u\n", __func__,
2890			       delete_desc->serial, delete_desc->lun_id);
2891			retval = EINVAL;
2892			break;
2893		}
2894		break;
2895	}
2896	case CTL_DUMP_STRUCTS: {
2897		int i, j, k;
2898		struct ctl_frontend *fe;
2899
2900		printf("CTL IID to WWPN map start:\n");
2901		for (i = 0; i < CTL_MAX_PORTS; i++) {
2902			for (j = 0; j < CTL_MAX_INIT_PER_PORT; j++) {
2903				if (softc->wwpn_iid[i][j].in_use == 0)
2904					continue;
2905
2906				printf("port %d iid %u WWPN %#jx\n",
2907				       softc->wwpn_iid[i][j].port,
2908				       softc->wwpn_iid[i][j].iid,
2909				       (uintmax_t)softc->wwpn_iid[i][j].wwpn);
2910			}
2911		}
2912		printf("CTL IID to WWPN map end\n");
2913		printf("CTL Persistent Reservation information start:\n");
2914		for (i = 0; i < CTL_MAX_LUNS; i++) {
2915			struct ctl_lun *lun;
2916
2917			lun = softc->ctl_luns[i];
2918
2919			if ((lun == NULL)
2920			 || ((lun->flags & CTL_LUN_DISABLED) != 0))
2921				continue;
2922
2923			for (j = 0; j < (CTL_MAX_PORTS * 2); j++) {
2924				for (k = 0; k < CTL_MAX_INIT_PER_PORT; k++){
2925					if (lun->per_res[j+k].registered == 0)
2926						continue;
2927					printf("LUN %d port %d iid %d key "
2928					       "%#jx\n", i, j, k,
2929					       (uintmax_t)scsi_8btou64(
2930					       lun->per_res[j+k].res_key.key));
2931				}
2932			}
2933		}
2934		printf("CTL Persistent Reservation information end\n");
2935		printf("CTL Frontends:\n");
2936		/*
2937		 * XXX KDM calling this without a lock.  We'd likely want
2938		 * to drop the lock before calling the frontend's dump
2939		 * routine anyway.
2940		 */
2941		STAILQ_FOREACH(fe, &softc->fe_list, links) {
2942			printf("Frontend %s Type %u pport %d vport %d WWNN "
2943			       "%#jx WWPN %#jx\n", fe->port_name, fe->port_type,
2944			       fe->physical_port, fe->virtual_port,
2945			       (uintmax_t)fe->wwnn, (uintmax_t)fe->wwpn);
2946
2947			/*
2948			 * Frontends are not required to support the dump
2949			 * routine.
2950			 */
2951			if (fe->fe_dump == NULL)
2952				continue;
2953
2954			fe->fe_dump();
2955		}
2956		printf("CTL Frontend information end\n");
2957		break;
2958	}
2959	case CTL_LUN_REQ: {
2960		struct ctl_lun_req *lun_req;
2961		struct ctl_backend_driver *backend;
2962
2963		lun_req = (struct ctl_lun_req *)addr;
2964
2965		backend = ctl_backend_find(lun_req->backend);
2966		if (backend == NULL) {
2967			lun_req->status = CTL_LUN_ERROR;
2968			snprintf(lun_req->error_str,
2969				 sizeof(lun_req->error_str),
2970				 "Backend \"%s\" not found.",
2971				 lun_req->backend);
2972			break;
2973		}
2974		if (lun_req->num_be_args > 0) {
2975			lun_req->kern_be_args = ctl_copyin_args(
2976				lun_req->num_be_args,
2977				lun_req->be_args,
2978				lun_req->error_str,
2979				sizeof(lun_req->error_str));
2980			if (lun_req->kern_be_args == NULL) {
2981				lun_req->status = CTL_LUN_ERROR;
2982				break;
2983			}
2984		}
2985
2986		retval = backend->ioctl(dev, cmd, addr, flag, td);
2987
2988		if (lun_req->num_be_args > 0) {
2989			ctl_free_args(lun_req->num_be_args,
2990				      lun_req->kern_be_args);
2991		}
2992		break;
2993	}
2994	case CTL_LUN_LIST: {
2995		struct sbuf *sb;
2996		struct ctl_lun *lun;
2997		struct ctl_lun_list *list;
2998		struct ctl_be_lun_option *opt;
2999
3000		list = (struct ctl_lun_list *)addr;
3001
3002		/*
3003		 * Allocate a fixed length sbuf here, based on the length
3004		 * of the user's buffer.  We could allocate an auto-extending
3005		 * buffer, and then tell the user how much larger our
3006		 * amount of data is than his buffer, but that presents
3007		 * some problems:
3008		 *
3009		 * 1.  The sbuf(9) routines use a blocking malloc, and so
3010		 *     we can't hold a lock while calling them with an
3011		 *     auto-extending buffer.
3012 		 *
3013		 * 2.  There is not currently a LUN reference counting
3014		 *     mechanism, outside of outstanding transactions on
3015		 *     the LUN's OOA queue.  So a LUN could go away on us
3016		 *     while we're getting the LUN number, backend-specific
3017		 *     information, etc.  Thus, given the way things
3018		 *     currently work, we need to hold the CTL lock while
3019		 *     grabbing LUN information.
3020		 *
3021		 * So, from the user's standpoint, the best thing to do is
3022		 * allocate what he thinks is a reasonable buffer length,
3023		 * and then if he gets a CTL_LUN_LIST_NEED_MORE_SPACE error,
3024		 * double the buffer length and try again.  (And repeat
3025		 * that until he succeeds.)
3026		 */
3027		sb = sbuf_new(NULL, NULL, list->alloc_len, SBUF_FIXEDLEN);
3028		if (sb == NULL) {
3029			list->status = CTL_LUN_LIST_ERROR;
3030			snprintf(list->error_str, sizeof(list->error_str),
3031				 "Unable to allocate %d bytes for LUN list",
3032				 list->alloc_len);
3033			break;
3034		}
3035
3036		sbuf_printf(sb, "<ctllunlist>\n");
3037
3038		mtx_lock(&softc->ctl_lock);
3039
3040		STAILQ_FOREACH(lun, &softc->lun_list, links) {
3041			retval = sbuf_printf(sb, "<lun id=\"%ju\">\n",
3042					     (uintmax_t)lun->lun);
3043
3044			/*
3045			 * Bail out as soon as we see that we've overfilled
3046			 * the buffer.
3047			 */
3048			if (retval != 0)
3049				break;
3050
3051			retval = sbuf_printf(sb, "<backend_type>%s"
3052					     "</backend_type>\n",
3053					     (lun->backend == NULL) ?  "none" :
3054					     lun->backend->name);
3055
3056			if (retval != 0)
3057				break;
3058
3059			retval = sbuf_printf(sb, "<lun_type>%d</lun_type>\n",
3060					     lun->be_lun->lun_type);
3061
3062			if (retval != 0)
3063				break;
3064
3065			if (lun->backend == NULL) {
3066				retval = sbuf_printf(sb, "</lun>\n");
3067				if (retval != 0)
3068					break;
3069				continue;
3070			}
3071
3072			retval = sbuf_printf(sb, "<size>%ju</size>\n",
3073					     (lun->be_lun->maxlba > 0) ?
3074					     lun->be_lun->maxlba + 1 : 0);
3075
3076			if (retval != 0)
3077				break;
3078
3079			retval = sbuf_printf(sb, "<blocksize>%u</blocksize>\n",
3080					     lun->be_lun->blocksize);
3081
3082			if (retval != 0)
3083				break;
3084
3085			retval = sbuf_printf(sb, "<serial_number>");
3086
3087			if (retval != 0)
3088				break;
3089
3090			retval = ctl_sbuf_printf_esc(sb,
3091						     lun->be_lun->serial_num);
3092
3093			if (retval != 0)
3094				break;
3095
3096			retval = sbuf_printf(sb, "</serial_number>\n");
3097
3098			if (retval != 0)
3099				break;
3100
3101			retval = sbuf_printf(sb, "<device_id>");
3102
3103			if (retval != 0)
3104				break;
3105
3106			retval = ctl_sbuf_printf_esc(sb,lun->be_lun->device_id);
3107
3108			if (retval != 0)
3109				break;
3110
3111			retval = sbuf_printf(sb, "</device_id>\n");
3112
3113			if (retval != 0)
3114				break;
3115
3116			if (lun->backend->lun_info != NULL) {
3117				retval = lun->backend->lun_info(lun->be_lun->be_lun, sb);
3118				if (retval != 0)
3119					break;
3120			}
3121			STAILQ_FOREACH(opt, &lun->be_lun->options, links) {
3122				retval = sbuf_printf(sb, "<%s>%s</%s>", opt->name, opt->value, opt->name);
3123				if (retval != 0)
3124					break;
3125			}
3126
3127			retval = sbuf_printf(sb, "</lun>\n");
3128
3129			if (retval != 0)
3130				break;
3131		}
3132		mtx_unlock(&softc->ctl_lock);
3133
3134		if ((retval != 0)
3135		 || ((retval = sbuf_printf(sb, "</ctllunlist>\n")) != 0)) {
3136			retval = 0;
3137			sbuf_delete(sb);
3138			list->status = CTL_LUN_LIST_NEED_MORE_SPACE;
3139			snprintf(list->error_str, sizeof(list->error_str),
3140				 "Out of space, %d bytes is too small",
3141				 list->alloc_len);
3142			break;
3143		}
3144
3145		sbuf_finish(sb);
3146
3147		retval = copyout(sbuf_data(sb), list->lun_xml,
3148				 sbuf_len(sb) + 1);
3149
3150		list->fill_len = sbuf_len(sb) + 1;
3151		list->status = CTL_LUN_LIST_OK;
3152		sbuf_delete(sb);
3153		break;
3154	}
3155	case CTL_ISCSI: {
3156		struct ctl_iscsi *ci;
3157		struct ctl_frontend *fe;
3158
3159		ci = (struct ctl_iscsi *)addr;
3160
3161		mtx_lock(&softc->ctl_lock);
3162		STAILQ_FOREACH(fe, &softc->fe_list, links) {
3163			if (strcmp(fe->port_name, "iscsi") == 0)
3164				break;
3165		}
3166		mtx_unlock(&softc->ctl_lock);
3167
3168		if (fe == NULL) {
3169			ci->status = CTL_ISCSI_ERROR;
3170			snprintf(ci->error_str, sizeof(ci->error_str), "Backend \"iscsi\" not found.");
3171			break;
3172		}
3173
3174		retval = fe->ioctl(dev, cmd, addr, flag, td);
3175		break;
3176	}
3177	default: {
3178		/* XXX KDM should we fix this? */
3179#if 0
3180		struct ctl_backend_driver *backend;
3181		unsigned int type;
3182		int found;
3183
3184		found = 0;
3185
3186		/*
3187		 * We encode the backend type as the ioctl type for backend
3188		 * ioctls.  So parse it out here, and then search for a
3189		 * backend of this type.
3190		 */
3191		type = _IOC_TYPE(cmd);
3192
3193		STAILQ_FOREACH(backend, &softc->be_list, links) {
3194			if (backend->type == type) {
3195				found = 1;
3196				break;
3197			}
3198		}
3199		if (found == 0) {
3200			printf("ctl: unknown ioctl command %#lx or backend "
3201			       "%d\n", cmd, type);
3202			retval = EINVAL;
3203			break;
3204		}
3205		retval = backend->ioctl(dev, cmd, addr, flag, td);
3206#endif
3207		retval = ENOTTY;
3208		break;
3209	}
3210	}
3211	return (retval);
3212}
3213
3214uint32_t
3215ctl_get_initindex(struct ctl_nexus *nexus)
3216{
3217	if (nexus->targ_port < CTL_MAX_PORTS)
3218		return (nexus->initid.id +
3219			(nexus->targ_port * CTL_MAX_INIT_PER_PORT));
3220	else
3221		return (nexus->initid.id +
3222		       ((nexus->targ_port - CTL_MAX_PORTS) *
3223			CTL_MAX_INIT_PER_PORT));
3224}
3225
3226uint32_t
3227ctl_get_resindex(struct ctl_nexus *nexus)
3228{
3229	return (nexus->initid.id + (nexus->targ_port * CTL_MAX_INIT_PER_PORT));
3230}
3231
3232uint32_t
3233ctl_port_idx(int port_num)
3234{
3235	if (port_num < CTL_MAX_PORTS)
3236		return(port_num);
3237	else
3238		return(port_num - CTL_MAX_PORTS);
3239}
3240
3241/*
3242 * Note:  This only works for bitmask sizes that are at least 32 bits, and
3243 * that are a power of 2.
3244 */
3245int
3246ctl_ffz(uint32_t *mask, uint32_t size)
3247{
3248	uint32_t num_chunks, num_pieces;
3249	int i, j;
3250
3251	num_chunks = (size >> 5);
3252	if (num_chunks == 0)
3253		num_chunks++;
3254	num_pieces = ctl_min((sizeof(uint32_t) * 8), size);
3255
3256	for (i = 0; i < num_chunks; i++) {
3257		for (j = 0; j < num_pieces; j++) {
3258			if ((mask[i] & (1 << j)) == 0)
3259				return ((i << 5) + j);
3260		}
3261	}
3262
3263	return (-1);
3264}
3265
3266int
3267ctl_set_mask(uint32_t *mask, uint32_t bit)
3268{
3269	uint32_t chunk, piece;
3270
3271	chunk = bit >> 5;
3272	piece = bit % (sizeof(uint32_t) * 8);
3273
3274	if ((mask[chunk] & (1 << piece)) != 0)
3275		return (-1);
3276	else
3277		mask[chunk] |= (1 << piece);
3278
3279	return (0);
3280}
3281
3282int
3283ctl_clear_mask(uint32_t *mask, uint32_t bit)
3284{
3285	uint32_t chunk, piece;
3286
3287	chunk = bit >> 5;
3288	piece = bit % (sizeof(uint32_t) * 8);
3289
3290	if ((mask[chunk] & (1 << piece)) == 0)
3291		return (-1);
3292	else
3293		mask[chunk] &= ~(1 << piece);
3294
3295	return (0);
3296}
3297
3298int
3299ctl_is_set(uint32_t *mask, uint32_t bit)
3300{
3301	uint32_t chunk, piece;
3302
3303	chunk = bit >> 5;
3304	piece = bit % (sizeof(uint32_t) * 8);
3305
3306	if ((mask[chunk] & (1 << piece)) == 0)
3307		return (0);
3308	else
3309		return (1);
3310}
3311
3312#ifdef unused
3313/*
3314 * The bus, target and lun are optional, they can be filled in later.
3315 * can_wait is used to determine whether we can wait on the malloc or not.
3316 */
3317union ctl_io*
3318ctl_malloc_io(ctl_io_type io_type, uint32_t targ_port, uint32_t targ_target,
3319	      uint32_t targ_lun, int can_wait)
3320{
3321	union ctl_io *io;
3322
3323	if (can_wait)
3324		io = (union ctl_io *)malloc(sizeof(*io), M_CTL, M_WAITOK);
3325	else
3326		io = (union ctl_io *)malloc(sizeof(*io), M_CTL, M_NOWAIT);
3327
3328	if (io != NULL) {
3329		io->io_hdr.io_type = io_type;
3330		io->io_hdr.targ_port = targ_port;
3331		/*
3332		 * XXX KDM this needs to change/go away.  We need to move
3333		 * to a preallocated pool of ctl_scsiio structures.
3334		 */
3335		io->io_hdr.nexus.targ_target.id = targ_target;
3336		io->io_hdr.nexus.targ_lun = targ_lun;
3337	}
3338
3339	return (io);
3340}
3341
3342void
3343ctl_kfree_io(union ctl_io *io)
3344{
3345	free(io, M_CTL);
3346}
3347#endif /* unused */
3348
3349/*
3350 * ctl_softc, pool_type, total_ctl_io are passed in.
3351 * npool is passed out.
3352 */
3353int
3354ctl_pool_create(struct ctl_softc *ctl_softc, ctl_pool_type pool_type,
3355		uint32_t total_ctl_io, struct ctl_io_pool **npool)
3356{
3357	uint32_t i;
3358	union ctl_io *cur_io, *next_io;
3359	struct ctl_io_pool *pool;
3360	int retval;
3361
3362	retval = 0;
3363
3364	pool = (struct ctl_io_pool *)malloc(sizeof(*pool), M_CTL,
3365					    M_NOWAIT | M_ZERO);
3366	if (pool == NULL) {
3367		retval = ENOMEM;
3368		goto bailout;
3369	}
3370
3371	pool->type = pool_type;
3372	pool->ctl_softc = ctl_softc;
3373
3374	mtx_lock(&ctl_softc->pool_lock);
3375	pool->id = ctl_softc->cur_pool_id++;
3376	mtx_unlock(&ctl_softc->pool_lock);
3377
3378	pool->flags = CTL_POOL_FLAG_NONE;
3379	pool->refcount = 1;		/* Reference for validity. */
3380	STAILQ_INIT(&pool->free_queue);
3381
3382	/*
3383	 * XXX KDM other options here:
3384	 * - allocate a page at a time
3385	 * - allocate one big chunk of memory.
3386	 * Page allocation might work well, but would take a little more
3387	 * tracking.
3388	 */
3389	for (i = 0; i < total_ctl_io; i++) {
3390		cur_io = (union ctl_io *)malloc(sizeof(*cur_io), M_CTL,
3391						M_NOWAIT);
3392		if (cur_io == NULL) {
3393			retval = ENOMEM;
3394			break;
3395		}
3396		cur_io->io_hdr.pool = pool;
3397		STAILQ_INSERT_TAIL(&pool->free_queue, &cur_io->io_hdr, links);
3398		pool->total_ctl_io++;
3399		pool->free_ctl_io++;
3400	}
3401
3402	if (retval != 0) {
3403		for (cur_io = (union ctl_io *)STAILQ_FIRST(&pool->free_queue);
3404		     cur_io != NULL; cur_io = next_io) {
3405			next_io = (union ctl_io *)STAILQ_NEXT(&cur_io->io_hdr,
3406							      links);
3407			STAILQ_REMOVE(&pool->free_queue, &cur_io->io_hdr,
3408				      ctl_io_hdr, links);
3409			free(cur_io, M_CTL);
3410		}
3411
3412		free(pool, M_CTL);
3413		goto bailout;
3414	}
3415	mtx_lock(&ctl_softc->pool_lock);
3416	ctl_softc->num_pools++;
3417	STAILQ_INSERT_TAIL(&ctl_softc->io_pools, pool, links);
3418	/*
3419	 * Increment our usage count if this is an external consumer, so we
3420	 * can't get unloaded until the external consumer (most likely a
3421	 * FETD) unloads and frees his pool.
3422	 *
3423	 * XXX KDM will this increment the caller's module use count, or
3424	 * mine?
3425	 */
3426#if 0
3427	if ((pool_type != CTL_POOL_EMERGENCY)
3428	 && (pool_type != CTL_POOL_INTERNAL)
3429	 && (pool_type != CTL_POOL_IOCTL)
3430	 && (pool_type != CTL_POOL_4OTHERSC))
3431		MOD_INC_USE_COUNT;
3432#endif
3433
3434	mtx_unlock(&ctl_softc->pool_lock);
3435
3436	*npool = pool;
3437
3438bailout:
3439
3440	return (retval);
3441}
3442
3443static int
3444ctl_pool_acquire(struct ctl_io_pool *pool)
3445{
3446
3447	mtx_assert(&pool->ctl_softc->pool_lock, MA_OWNED);
3448
3449	if (pool->flags & CTL_POOL_FLAG_INVALID)
3450		return (EINVAL);
3451
3452	pool->refcount++;
3453
3454	return (0);
3455}
3456
3457static void
3458ctl_pool_release(struct ctl_io_pool *pool)
3459{
3460	struct ctl_softc *ctl_softc = pool->ctl_softc;
3461	union ctl_io *io;
3462
3463	mtx_assert(&ctl_softc->pool_lock, MA_OWNED);
3464
3465	if (--pool->refcount != 0)
3466		return;
3467
3468	while ((io = (union ctl_io *)STAILQ_FIRST(&pool->free_queue)) != NULL) {
3469		STAILQ_REMOVE(&pool->free_queue, &io->io_hdr, ctl_io_hdr,
3470			      links);
3471		free(io, M_CTL);
3472	}
3473
3474	STAILQ_REMOVE(&ctl_softc->io_pools, pool, ctl_io_pool, links);
3475	ctl_softc->num_pools--;
3476
3477	/*
3478	 * XXX KDM will this decrement the caller's usage count or mine?
3479	 */
3480#if 0
3481	if ((pool->type != CTL_POOL_EMERGENCY)
3482	 && (pool->type != CTL_POOL_INTERNAL)
3483	 && (pool->type != CTL_POOL_IOCTL))
3484		MOD_DEC_USE_COUNT;
3485#endif
3486
3487	free(pool, M_CTL);
3488}
3489
3490void
3491ctl_pool_free(struct ctl_io_pool *pool)
3492{
3493	struct ctl_softc *ctl_softc;
3494
3495	if (pool == NULL)
3496		return;
3497
3498	ctl_softc = pool->ctl_softc;
3499	mtx_lock(&ctl_softc->pool_lock);
3500	pool->flags |= CTL_POOL_FLAG_INVALID;
3501	ctl_pool_release(pool);
3502	mtx_unlock(&ctl_softc->pool_lock);
3503}
3504
3505/*
3506 * This routine does not block (except for spinlocks of course).
3507 * It tries to allocate a ctl_io union from the caller's pool as quickly as
3508 * possible.
3509 */
3510union ctl_io *
3511ctl_alloc_io(void *pool_ref)
3512{
3513	union ctl_io *io;
3514	struct ctl_softc *ctl_softc;
3515	struct ctl_io_pool *pool, *npool;
3516	struct ctl_io_pool *emergency_pool;
3517
3518	pool = (struct ctl_io_pool *)pool_ref;
3519
3520	if (pool == NULL) {
3521		printf("%s: pool is NULL\n", __func__);
3522		return (NULL);
3523	}
3524
3525	emergency_pool = NULL;
3526
3527	ctl_softc = pool->ctl_softc;
3528
3529	mtx_lock(&ctl_softc->pool_lock);
3530	/*
3531	 * First, try to get the io structure from the user's pool.
3532	 */
3533	if (ctl_pool_acquire(pool) == 0) {
3534		io = (union ctl_io *)STAILQ_FIRST(&pool->free_queue);
3535		if (io != NULL) {
3536			STAILQ_REMOVE_HEAD(&pool->free_queue, links);
3537			pool->total_allocated++;
3538			pool->free_ctl_io--;
3539			mtx_unlock(&ctl_softc->pool_lock);
3540			return (io);
3541		} else
3542			ctl_pool_release(pool);
3543	}
3544	/*
3545	 * If he doesn't have any io structures left, search for an
3546	 * emergency pool and grab one from there.
3547	 */
3548	STAILQ_FOREACH(npool, &ctl_softc->io_pools, links) {
3549		if (npool->type != CTL_POOL_EMERGENCY)
3550			continue;
3551
3552		if (ctl_pool_acquire(npool) != 0)
3553			continue;
3554
3555		emergency_pool = npool;
3556
3557		io = (union ctl_io *)STAILQ_FIRST(&npool->free_queue);
3558		if (io != NULL) {
3559			STAILQ_REMOVE_HEAD(&npool->free_queue, links);
3560			npool->total_allocated++;
3561			npool->free_ctl_io--;
3562			mtx_unlock(&ctl_softc->pool_lock);
3563			return (io);
3564		} else
3565			ctl_pool_release(npool);
3566	}
3567
3568	/* Drop the spinlock before we malloc */
3569	mtx_unlock(&ctl_softc->pool_lock);
3570
3571	/*
3572	 * The emergency pool (if it exists) didn't have one, so try an
3573	 * atomic (i.e. nonblocking) malloc and see if we get lucky.
3574	 */
3575	io = (union ctl_io *)malloc(sizeof(*io), M_CTL, M_NOWAIT);
3576	if (io != NULL) {
3577		/*
3578		 * If the emergency pool exists but is empty, add this
3579		 * ctl_io to its list when it gets freed.
3580		 */
3581		if (emergency_pool != NULL) {
3582			mtx_lock(&ctl_softc->pool_lock);
3583			if (ctl_pool_acquire(emergency_pool) == 0) {
3584				io->io_hdr.pool = emergency_pool;
3585				emergency_pool->total_ctl_io++;
3586				/*
3587				 * Need to bump this, otherwise
3588				 * total_allocated and total_freed won't
3589				 * match when we no longer have anything
3590				 * outstanding.
3591				 */
3592				emergency_pool->total_allocated++;
3593			}
3594			mtx_unlock(&ctl_softc->pool_lock);
3595		} else
3596			io->io_hdr.pool = NULL;
3597	}
3598
3599	return (io);
3600}
3601
3602void
3603ctl_free_io(union ctl_io *io)
3604{
3605	if (io == NULL)
3606		return;
3607
3608	/*
3609	 * If this ctl_io has a pool, return it to that pool.
3610	 */
3611	if (io->io_hdr.pool != NULL) {
3612		struct ctl_io_pool *pool;
3613#if 0
3614		struct ctl_softc *ctl_softc;
3615		union ctl_io *tmp_io;
3616		unsigned long xflags;
3617		int i;
3618
3619		ctl_softc = control_softc;
3620#endif
3621
3622		pool = (struct ctl_io_pool *)io->io_hdr.pool;
3623
3624		mtx_lock(&pool->ctl_softc->pool_lock);
3625#if 0
3626		save_flags(xflags);
3627
3628		for (i = 0, tmp_io = (union ctl_io *)STAILQ_FIRST(
3629		     &ctl_softc->task_queue); tmp_io != NULL; i++,
3630		     tmp_io = (union ctl_io *)STAILQ_NEXT(&tmp_io->io_hdr,
3631		     links)) {
3632			if (tmp_io == io) {
3633				printf("%s: %p is still on the task queue!\n",
3634				       __func__, tmp_io);
3635				printf("%s: (%d): type %d "
3636				       "msg %d cdb %x iptl: "
3637				       "%d:%d:%d:%d tag 0x%04x "
3638				       "flg %#lx\n",
3639					__func__, i,
3640					tmp_io->io_hdr.io_type,
3641					tmp_io->io_hdr.msg_type,
3642					tmp_io->scsiio.cdb[0],
3643					tmp_io->io_hdr.nexus.initid.id,
3644					tmp_io->io_hdr.nexus.targ_port,
3645					tmp_io->io_hdr.nexus.targ_target.id,
3646					tmp_io->io_hdr.nexus.targ_lun,
3647					(tmp_io->io_hdr.io_type ==
3648					CTL_IO_TASK) ?
3649					tmp_io->taskio.tag_num :
3650					tmp_io->scsiio.tag_num,
3651					xflags);
3652				panic("I/O still on the task queue!");
3653			}
3654		}
3655#endif
3656		io->io_hdr.io_type = 0xff;
3657		STAILQ_INSERT_TAIL(&pool->free_queue, &io->io_hdr, links);
3658		pool->total_freed++;
3659		pool->free_ctl_io++;
3660		ctl_pool_release(pool);
3661		mtx_unlock(&pool->ctl_softc->pool_lock);
3662	} else {
3663		/*
3664		 * Otherwise, just free it.  We probably malloced it and
3665		 * the emergency pool wasn't available.
3666		 */
3667		free(io, M_CTL);
3668	}
3669
3670}
3671
3672void
3673ctl_zero_io(union ctl_io *io)
3674{
3675	void *pool_ref;
3676
3677	if (io == NULL)
3678		return;
3679
3680	/*
3681	 * May need to preserve linked list pointers at some point too.
3682	 */
3683	pool_ref = io->io_hdr.pool;
3684
3685	memset(io, 0, sizeof(*io));
3686
3687	io->io_hdr.pool = pool_ref;
3688}
3689
3690/*
3691 * This routine is currently used for internal copies of ctl_ios that need
3692 * to persist for some reason after we've already returned status to the
3693 * FETD.  (Thus the flag set.)
3694 *
3695 * XXX XXX
3696 * Note that this makes a blind copy of all fields in the ctl_io, except
3697 * for the pool reference.  This includes any memory that has been
3698 * allocated!  That memory will no longer be valid after done has been
3699 * called, so this would be VERY DANGEROUS for command that actually does
3700 * any reads or writes.  Right now (11/7/2005), this is only used for immediate
3701 * start and stop commands, which don't transfer any data, so this is not a
3702 * problem.  If it is used for anything else, the caller would also need to
3703 * allocate data buffer space and this routine would need to be modified to
3704 * copy the data buffer(s) as well.
3705 */
3706void
3707ctl_copy_io(union ctl_io *src, union ctl_io *dest)
3708{
3709	void *pool_ref;
3710
3711	if ((src == NULL)
3712	 || (dest == NULL))
3713		return;
3714
3715	/*
3716	 * May need to preserve linked list pointers at some point too.
3717	 */
3718	pool_ref = dest->io_hdr.pool;
3719
3720	memcpy(dest, src, ctl_min(sizeof(*src), sizeof(*dest)));
3721
3722	dest->io_hdr.pool = pool_ref;
3723	/*
3724	 * We need to know that this is an internal copy, and doesn't need
3725	 * to get passed back to the FETD that allocated it.
3726	 */
3727	dest->io_hdr.flags |= CTL_FLAG_INT_COPY;
3728}
3729
3730#ifdef NEEDTOPORT
3731static void
3732ctl_update_power_subpage(struct copan_power_subpage *page)
3733{
3734	int num_luns, num_partitions, config_type;
3735	struct ctl_softc *softc;
3736	cs_BOOL_t aor_present, shelf_50pct_power;
3737	cs_raidset_personality_t rs_type;
3738	int max_active_luns;
3739
3740	softc = control_softc;
3741
3742	/* subtract out the processor LUN */
3743	num_luns = softc->num_luns - 1;
3744	/*
3745	 * Default to 7 LUNs active, which was the only number we allowed
3746	 * in the past.
3747	 */
3748	max_active_luns = 7;
3749
3750	num_partitions = config_GetRsPartitionInfo();
3751	config_type = config_GetConfigType();
3752	shelf_50pct_power = config_GetShelfPowerMode();
3753	aor_present = config_IsAorRsPresent();
3754
3755	rs_type = ddb_GetRsRaidType(1);
3756	if ((rs_type != CS_RAIDSET_PERSONALITY_RAID5)
3757	 && (rs_type != CS_RAIDSET_PERSONALITY_RAID1)) {
3758		EPRINT(0, "Unsupported RS type %d!", rs_type);
3759	}
3760
3761
3762	page->total_luns = num_luns;
3763
3764	switch (config_type) {
3765	case 40:
3766		/*
3767		 * In a 40 drive configuration, it doesn't matter what DC
3768		 * cards we have, whether we have AOR enabled or not,
3769		 * partitioning or not, or what type of RAIDset we have.
3770		 * In that scenario, we can power up every LUN we present
3771		 * to the user.
3772		 */
3773		max_active_luns = num_luns;
3774
3775		break;
3776	case 64:
3777		if (shelf_50pct_power == CS_FALSE) {
3778			/* 25% power */
3779			if (aor_present == CS_TRUE) {
3780				if (rs_type ==
3781				     CS_RAIDSET_PERSONALITY_RAID5) {
3782					max_active_luns = 7;
3783				} else if (rs_type ==
3784					 CS_RAIDSET_PERSONALITY_RAID1){
3785					max_active_luns = 14;
3786				} else {
3787					/* XXX KDM now what?? */
3788				}
3789			} else {
3790				if (rs_type ==
3791				     CS_RAIDSET_PERSONALITY_RAID5) {
3792					max_active_luns = 8;
3793				} else if (rs_type ==
3794					 CS_RAIDSET_PERSONALITY_RAID1){
3795					max_active_luns = 16;
3796				} else {
3797					/* XXX KDM now what?? */
3798				}
3799			}
3800		} else {
3801			/* 50% power */
3802			/*
3803			 * With 50% power in a 64 drive configuration, we
3804			 * can power all LUNs we present.
3805			 */
3806			max_active_luns = num_luns;
3807		}
3808		break;
3809	case 112:
3810		if (shelf_50pct_power == CS_FALSE) {
3811			/* 25% power */
3812			if (aor_present == CS_TRUE) {
3813				if (rs_type ==
3814				     CS_RAIDSET_PERSONALITY_RAID5) {
3815					max_active_luns = 7;
3816				} else if (rs_type ==
3817					 CS_RAIDSET_PERSONALITY_RAID1){
3818					max_active_luns = 14;
3819				} else {
3820					/* XXX KDM now what?? */
3821				}
3822			} else {
3823				if (rs_type ==
3824				     CS_RAIDSET_PERSONALITY_RAID5) {
3825					max_active_luns = 8;
3826				} else if (rs_type ==
3827					 CS_RAIDSET_PERSONALITY_RAID1){
3828					max_active_luns = 16;
3829				} else {
3830					/* XXX KDM now what?? */
3831				}
3832			}
3833		} else {
3834			/* 50% power */
3835			if (aor_present == CS_TRUE) {
3836				if (rs_type ==
3837				     CS_RAIDSET_PERSONALITY_RAID5) {
3838					max_active_luns = 14;
3839				} else if (rs_type ==
3840					 CS_RAIDSET_PERSONALITY_RAID1){
3841					/*
3842					 * We're assuming here that disk
3843					 * caching is enabled, and so we're
3844					 * able to power up half of each
3845					 * LUN, and cache all writes.
3846					 */
3847					max_active_luns = num_luns;
3848				} else {
3849					/* XXX KDM now what?? */
3850				}
3851			} else {
3852				if (rs_type ==
3853				     CS_RAIDSET_PERSONALITY_RAID5) {
3854					max_active_luns = 15;
3855				} else if (rs_type ==
3856					 CS_RAIDSET_PERSONALITY_RAID1){
3857					max_active_luns = 30;
3858				} else {
3859					/* XXX KDM now what?? */
3860				}
3861			}
3862		}
3863		break;
3864	default:
3865		/*
3866		 * In this case, we have an unknown configuration, so we
3867		 * just use the default from above.
3868		 */
3869		break;
3870	}
3871
3872	page->max_active_luns = max_active_luns;
3873#if 0
3874	printk("%s: total_luns = %d, max_active_luns = %d\n", __func__,
3875	       page->total_luns, page->max_active_luns);
3876#endif
3877}
3878#endif /* NEEDTOPORT */
3879
3880/*
3881 * This routine could be used in the future to load default and/or saved
3882 * mode page parameters for a particuar lun.
3883 */
3884static int
3885ctl_init_page_index(struct ctl_lun *lun)
3886{
3887	int i;
3888	struct ctl_page_index *page_index;
3889	struct ctl_softc *softc;
3890
3891	memcpy(&lun->mode_pages.index, page_index_template,
3892	       sizeof(page_index_template));
3893
3894	softc = lun->ctl_softc;
3895
3896	for (i = 0; i < CTL_NUM_MODE_PAGES; i++) {
3897
3898		page_index = &lun->mode_pages.index[i];
3899		/*
3900		 * If this is a disk-only mode page, there's no point in
3901		 * setting it up.  For some pages, we have to have some
3902		 * basic information about the disk in order to calculate the
3903		 * mode page data.
3904		 */
3905		if ((lun->be_lun->lun_type != T_DIRECT)
3906		 && (page_index->page_flags & CTL_PAGE_FLAG_DISK_ONLY))
3907			continue;
3908
3909		switch (page_index->page_code & SMPH_PC_MASK) {
3910		case SMS_FORMAT_DEVICE_PAGE: {
3911			struct scsi_format_page *format_page;
3912
3913			if (page_index->subpage != SMS_SUBPAGE_PAGE_0)
3914				panic("subpage is incorrect!");
3915
3916			/*
3917			 * Sectors per track are set above.  Bytes per
3918			 * sector need to be set here on a per-LUN basis.
3919			 */
3920			memcpy(&lun->mode_pages.format_page[CTL_PAGE_CURRENT],
3921			       &format_page_default,
3922			       sizeof(format_page_default));
3923			memcpy(&lun->mode_pages.format_page[
3924			       CTL_PAGE_CHANGEABLE], &format_page_changeable,
3925			       sizeof(format_page_changeable));
3926			memcpy(&lun->mode_pages.format_page[CTL_PAGE_DEFAULT],
3927			       &format_page_default,
3928			       sizeof(format_page_default));
3929			memcpy(&lun->mode_pages.format_page[CTL_PAGE_SAVED],
3930			       &format_page_default,
3931			       sizeof(format_page_default));
3932
3933			format_page = &lun->mode_pages.format_page[
3934				CTL_PAGE_CURRENT];
3935			scsi_ulto2b(lun->be_lun->blocksize,
3936				    format_page->bytes_per_sector);
3937
3938			format_page = &lun->mode_pages.format_page[
3939				CTL_PAGE_DEFAULT];
3940			scsi_ulto2b(lun->be_lun->blocksize,
3941				    format_page->bytes_per_sector);
3942
3943			format_page = &lun->mode_pages.format_page[
3944				CTL_PAGE_SAVED];
3945			scsi_ulto2b(lun->be_lun->blocksize,
3946				    format_page->bytes_per_sector);
3947
3948			page_index->page_data =
3949				(uint8_t *)lun->mode_pages.format_page;
3950			break;
3951		}
3952		case SMS_RIGID_DISK_PAGE: {
3953			struct scsi_rigid_disk_page *rigid_disk_page;
3954			uint32_t sectors_per_cylinder;
3955			uint64_t cylinders;
3956#ifndef	__XSCALE__
3957			int shift;
3958#endif /* !__XSCALE__ */
3959
3960			if (page_index->subpage != SMS_SUBPAGE_PAGE_0)
3961				panic("invalid subpage value %d",
3962				      page_index->subpage);
3963
3964			/*
3965			 * Rotation rate and sectors per track are set
3966			 * above.  We calculate the cylinders here based on
3967			 * capacity.  Due to the number of heads and
3968			 * sectors per track we're using, smaller arrays
3969			 * may turn out to have 0 cylinders.  Linux and
3970			 * FreeBSD don't pay attention to these mode pages
3971			 * to figure out capacity, but Solaris does.  It
3972			 * seems to deal with 0 cylinders just fine, and
3973			 * works out a fake geometry based on the capacity.
3974			 */
3975			memcpy(&lun->mode_pages.rigid_disk_page[
3976			       CTL_PAGE_CURRENT], &rigid_disk_page_default,
3977			       sizeof(rigid_disk_page_default));
3978			memcpy(&lun->mode_pages.rigid_disk_page[
3979			       CTL_PAGE_CHANGEABLE],&rigid_disk_page_changeable,
3980			       sizeof(rigid_disk_page_changeable));
3981			memcpy(&lun->mode_pages.rigid_disk_page[
3982			       CTL_PAGE_DEFAULT], &rigid_disk_page_default,
3983			       sizeof(rigid_disk_page_default));
3984			memcpy(&lun->mode_pages.rigid_disk_page[
3985			       CTL_PAGE_SAVED], &rigid_disk_page_default,
3986			       sizeof(rigid_disk_page_default));
3987
3988			sectors_per_cylinder = CTL_DEFAULT_SECTORS_PER_TRACK *
3989				CTL_DEFAULT_HEADS;
3990
3991			/*
3992			 * The divide method here will be more accurate,
3993			 * probably, but results in floating point being
3994			 * used in the kernel on i386 (__udivdi3()).  On the
3995			 * XScale, though, __udivdi3() is implemented in
3996			 * software.
3997			 *
3998			 * The shift method for cylinder calculation is
3999			 * accurate if sectors_per_cylinder is a power of
4000			 * 2.  Otherwise it might be slightly off -- you
4001			 * might have a bit of a truncation problem.
4002			 */
4003#ifdef	__XSCALE__
4004			cylinders = (lun->be_lun->maxlba + 1) /
4005				sectors_per_cylinder;
4006#else
4007			for (shift = 31; shift > 0; shift--) {
4008				if (sectors_per_cylinder & (1 << shift))
4009					break;
4010			}
4011			cylinders = (lun->be_lun->maxlba + 1) >> shift;
4012#endif
4013
4014			/*
4015			 * We've basically got 3 bytes, or 24 bits for the
4016			 * cylinder size in the mode page.  If we're over,
4017			 * just round down to 2^24.
4018			 */
4019			if (cylinders > 0xffffff)
4020				cylinders = 0xffffff;
4021
4022			rigid_disk_page = &lun->mode_pages.rigid_disk_page[
4023				CTL_PAGE_CURRENT];
4024			scsi_ulto3b(cylinders, rigid_disk_page->cylinders);
4025
4026			rigid_disk_page = &lun->mode_pages.rigid_disk_page[
4027				CTL_PAGE_DEFAULT];
4028			scsi_ulto3b(cylinders, rigid_disk_page->cylinders);
4029
4030			rigid_disk_page = &lun->mode_pages.rigid_disk_page[
4031				CTL_PAGE_SAVED];
4032			scsi_ulto3b(cylinders, rigid_disk_page->cylinders);
4033
4034			page_index->page_data =
4035				(uint8_t *)lun->mode_pages.rigid_disk_page;
4036			break;
4037		}
4038		case SMS_CACHING_PAGE: {
4039
4040			if (page_index->subpage != SMS_SUBPAGE_PAGE_0)
4041				panic("invalid subpage value %d",
4042				      page_index->subpage);
4043			/*
4044			 * Defaults should be okay here, no calculations
4045			 * needed.
4046			 */
4047			memcpy(&lun->mode_pages.caching_page[CTL_PAGE_CURRENT],
4048			       &caching_page_default,
4049			       sizeof(caching_page_default));
4050			memcpy(&lun->mode_pages.caching_page[
4051			       CTL_PAGE_CHANGEABLE], &caching_page_changeable,
4052			       sizeof(caching_page_changeable));
4053			memcpy(&lun->mode_pages.caching_page[CTL_PAGE_DEFAULT],
4054			       &caching_page_default,
4055			       sizeof(caching_page_default));
4056			memcpy(&lun->mode_pages.caching_page[CTL_PAGE_SAVED],
4057			       &caching_page_default,
4058			       sizeof(caching_page_default));
4059			page_index->page_data =
4060				(uint8_t *)lun->mode_pages.caching_page;
4061			break;
4062		}
4063		case SMS_CONTROL_MODE_PAGE: {
4064
4065			if (page_index->subpage != SMS_SUBPAGE_PAGE_0)
4066				panic("invalid subpage value %d",
4067				      page_index->subpage);
4068
4069			/*
4070			 * Defaults should be okay here, no calculations
4071			 * needed.
4072			 */
4073			memcpy(&lun->mode_pages.control_page[CTL_PAGE_CURRENT],
4074			       &control_page_default,
4075			       sizeof(control_page_default));
4076			memcpy(&lun->mode_pages.control_page[
4077			       CTL_PAGE_CHANGEABLE], &control_page_changeable,
4078			       sizeof(control_page_changeable));
4079			memcpy(&lun->mode_pages.control_page[CTL_PAGE_DEFAULT],
4080			       &control_page_default,
4081			       sizeof(control_page_default));
4082			memcpy(&lun->mode_pages.control_page[CTL_PAGE_SAVED],
4083			       &control_page_default,
4084			       sizeof(control_page_default));
4085			page_index->page_data =
4086				(uint8_t *)lun->mode_pages.control_page;
4087			break;
4088
4089		}
4090		case SMS_VENDOR_SPECIFIC_PAGE:{
4091			switch (page_index->subpage) {
4092			case PWR_SUBPAGE_CODE: {
4093				struct copan_power_subpage *current_page,
4094							   *saved_page;
4095
4096				memcpy(&lun->mode_pages.power_subpage[
4097				       CTL_PAGE_CURRENT],
4098				       &power_page_default,
4099				       sizeof(power_page_default));
4100				memcpy(&lun->mode_pages.power_subpage[
4101				       CTL_PAGE_CHANGEABLE],
4102				       &power_page_changeable,
4103				       sizeof(power_page_changeable));
4104				memcpy(&lun->mode_pages.power_subpage[
4105				       CTL_PAGE_DEFAULT],
4106				       &power_page_default,
4107				       sizeof(power_page_default));
4108				memcpy(&lun->mode_pages.power_subpage[
4109				       CTL_PAGE_SAVED],
4110				       &power_page_default,
4111				       sizeof(power_page_default));
4112				page_index->page_data =
4113				    (uint8_t *)lun->mode_pages.power_subpage;
4114
4115				current_page = (struct copan_power_subpage *)
4116					(page_index->page_data +
4117					 (page_index->page_len *
4118					  CTL_PAGE_CURRENT));
4119			        saved_page = (struct copan_power_subpage *)
4120				        (page_index->page_data +
4121					 (page_index->page_len *
4122					  CTL_PAGE_SAVED));
4123				break;
4124			}
4125			case APS_SUBPAGE_CODE: {
4126				struct copan_aps_subpage *current_page,
4127							 *saved_page;
4128
4129				// This gets set multiple times but
4130				// it should always be the same. It's
4131				// only done during init so who cares.
4132				index_to_aps_page = i;
4133
4134				memcpy(&lun->mode_pages.aps_subpage[
4135				       CTL_PAGE_CURRENT],
4136				       &aps_page_default,
4137				       sizeof(aps_page_default));
4138				memcpy(&lun->mode_pages.aps_subpage[
4139				       CTL_PAGE_CHANGEABLE],
4140				       &aps_page_changeable,
4141				       sizeof(aps_page_changeable));
4142				memcpy(&lun->mode_pages.aps_subpage[
4143				       CTL_PAGE_DEFAULT],
4144				       &aps_page_default,
4145				       sizeof(aps_page_default));
4146				memcpy(&lun->mode_pages.aps_subpage[
4147				       CTL_PAGE_SAVED],
4148				       &aps_page_default,
4149				       sizeof(aps_page_default));
4150				page_index->page_data =
4151					(uint8_t *)lun->mode_pages.aps_subpage;
4152
4153				current_page = (struct copan_aps_subpage *)
4154					(page_index->page_data +
4155					 (page_index->page_len *
4156					  CTL_PAGE_CURRENT));
4157				saved_page = (struct copan_aps_subpage *)
4158					(page_index->page_data +
4159					 (page_index->page_len *
4160					  CTL_PAGE_SAVED));
4161				break;
4162			}
4163			case DBGCNF_SUBPAGE_CODE: {
4164				struct copan_debugconf_subpage *current_page,
4165							       *saved_page;
4166
4167				memcpy(&lun->mode_pages.debugconf_subpage[
4168				       CTL_PAGE_CURRENT],
4169				       &debugconf_page_default,
4170				       sizeof(debugconf_page_default));
4171				memcpy(&lun->mode_pages.debugconf_subpage[
4172				       CTL_PAGE_CHANGEABLE],
4173				       &debugconf_page_changeable,
4174				       sizeof(debugconf_page_changeable));
4175				memcpy(&lun->mode_pages.debugconf_subpage[
4176				       CTL_PAGE_DEFAULT],
4177				       &debugconf_page_default,
4178				       sizeof(debugconf_page_default));
4179				memcpy(&lun->mode_pages.debugconf_subpage[
4180				       CTL_PAGE_SAVED],
4181				       &debugconf_page_default,
4182				       sizeof(debugconf_page_default));
4183				page_index->page_data =
4184					(uint8_t *)lun->mode_pages.debugconf_subpage;
4185
4186				current_page = (struct copan_debugconf_subpage *)
4187					(page_index->page_data +
4188					 (page_index->page_len *
4189					  CTL_PAGE_CURRENT));
4190				saved_page = (struct copan_debugconf_subpage *)
4191					(page_index->page_data +
4192					 (page_index->page_len *
4193					  CTL_PAGE_SAVED));
4194				break;
4195			}
4196			default:
4197				panic("invalid subpage value %d",
4198				      page_index->subpage);
4199				break;
4200			}
4201   			break;
4202		}
4203		default:
4204			panic("invalid page value %d",
4205			      page_index->page_code & SMPH_PC_MASK);
4206			break;
4207    	}
4208	}
4209
4210	return (CTL_RETVAL_COMPLETE);
4211}
4212
4213/*
4214 * LUN allocation.
4215 *
4216 * Requirements:
4217 * - caller allocates and zeros LUN storage, or passes in a NULL LUN if he
4218 *   wants us to allocate the LUN and he can block.
4219 * - ctl_softc is always set
4220 * - be_lun is set if the LUN has a backend (needed for disk LUNs)
4221 *
4222 * Returns 0 for success, non-zero (errno) for failure.
4223 */
4224static int
4225ctl_alloc_lun(struct ctl_softc *ctl_softc, struct ctl_lun *ctl_lun,
4226	      struct ctl_be_lun *const be_lun, struct ctl_id target_id)
4227{
4228	struct ctl_lun *nlun, *lun;
4229	struct ctl_frontend *fe;
4230	int lun_number, i, lun_malloced;
4231
4232	if (be_lun == NULL)
4233		return (EINVAL);
4234
4235	/*
4236	 * We currently only support Direct Access or Processor LUN types.
4237	 */
4238	switch (be_lun->lun_type) {
4239	case T_DIRECT:
4240		break;
4241	case T_PROCESSOR:
4242		break;
4243	case T_SEQUENTIAL:
4244	case T_CHANGER:
4245	default:
4246		be_lun->lun_config_status(be_lun->be_lun,
4247					  CTL_LUN_CONFIG_FAILURE);
4248		break;
4249	}
4250	if (ctl_lun == NULL) {
4251		lun = malloc(sizeof(*lun), M_CTL, M_WAITOK);
4252		lun_malloced = 1;
4253	} else {
4254		lun_malloced = 0;
4255		lun = ctl_lun;
4256	}
4257
4258	memset(lun, 0, sizeof(*lun));
4259	if (lun_malloced)
4260		lun->flags = CTL_LUN_MALLOCED;
4261
4262	mtx_lock(&ctl_softc->ctl_lock);
4263	/*
4264	 * See if the caller requested a particular LUN number.  If so, see
4265	 * if it is available.  Otherwise, allocate the first available LUN.
4266	 */
4267	if (be_lun->flags & CTL_LUN_FLAG_ID_REQ) {
4268		if ((be_lun->req_lun_id > (CTL_MAX_LUNS - 1))
4269		 || (ctl_is_set(ctl_softc->ctl_lun_mask, be_lun->req_lun_id))) {
4270			mtx_unlock(&ctl_softc->ctl_lock);
4271			if (be_lun->req_lun_id > (CTL_MAX_LUNS - 1)) {
4272				printf("ctl: requested LUN ID %d is higher "
4273				       "than CTL_MAX_LUNS - 1 (%d)\n",
4274				       be_lun->req_lun_id, CTL_MAX_LUNS - 1);
4275			} else {
4276				/*
4277				 * XXX KDM return an error, or just assign
4278				 * another LUN ID in this case??
4279				 */
4280				printf("ctl: requested LUN ID %d is already "
4281				       "in use\n", be_lun->req_lun_id);
4282			}
4283			if (lun->flags & CTL_LUN_MALLOCED)
4284				free(lun, M_CTL);
4285			be_lun->lun_config_status(be_lun->be_lun,
4286						  CTL_LUN_CONFIG_FAILURE);
4287			return (ENOSPC);
4288		}
4289		lun_number = be_lun->req_lun_id;
4290	} else {
4291		lun_number = ctl_ffz(ctl_softc->ctl_lun_mask, CTL_MAX_LUNS);
4292		if (lun_number == -1) {
4293			mtx_unlock(&ctl_softc->ctl_lock);
4294			printf("ctl: can't allocate LUN on target %ju, out of "
4295			       "LUNs\n", (uintmax_t)target_id.id);
4296			if (lun->flags & CTL_LUN_MALLOCED)
4297				free(lun, M_CTL);
4298			be_lun->lun_config_status(be_lun->be_lun,
4299						  CTL_LUN_CONFIG_FAILURE);
4300			return (ENOSPC);
4301		}
4302	}
4303	ctl_set_mask(ctl_softc->ctl_lun_mask, lun_number);
4304
4305	lun->target = target_id;
4306	lun->lun = lun_number;
4307	lun->be_lun = be_lun;
4308	/*
4309	 * The processor LUN is always enabled.  Disk LUNs come on line
4310	 * disabled, and must be enabled by the backend.
4311	 */
4312	lun->flags |= CTL_LUN_DISABLED;
4313	lun->backend = be_lun->be;
4314	be_lun->ctl_lun = lun;
4315	be_lun->lun_id = lun_number;
4316	atomic_add_int(&be_lun->be->num_luns, 1);
4317	if (be_lun->flags & CTL_LUN_FLAG_POWERED_OFF)
4318		lun->flags |= CTL_LUN_STOPPED;
4319
4320	if (be_lun->flags & CTL_LUN_FLAG_INOPERABLE)
4321		lun->flags |= CTL_LUN_INOPERABLE;
4322
4323	if (be_lun->flags & CTL_LUN_FLAG_PRIMARY)
4324		lun->flags |= CTL_LUN_PRIMARY_SC;
4325
4326	lun->ctl_softc = ctl_softc;
4327	TAILQ_INIT(&lun->ooa_queue);
4328	TAILQ_INIT(&lun->blocked_queue);
4329	STAILQ_INIT(&lun->error_list);
4330
4331	/*
4332	 * Initialize the mode page index.
4333	 */
4334	ctl_init_page_index(lun);
4335
4336	/*
4337	 * Set the poweron UA for all initiators on this LUN only.
4338	 */
4339	for (i = 0; i < CTL_MAX_INITIATORS; i++)
4340		lun->pending_sense[i].ua_pending = CTL_UA_POWERON;
4341
4342	/*
4343	 * Now, before we insert this lun on the lun list, set the lun
4344	 * inventory changed UA for all other luns.
4345	 */
4346	STAILQ_FOREACH(nlun, &ctl_softc->lun_list, links) {
4347		for (i = 0; i < CTL_MAX_INITIATORS; i++) {
4348			nlun->pending_sense[i].ua_pending |= CTL_UA_LUN_CHANGE;
4349		}
4350	}
4351
4352	STAILQ_INSERT_TAIL(&ctl_softc->lun_list, lun, links);
4353
4354	ctl_softc->ctl_luns[lun_number] = lun;
4355
4356	ctl_softc->num_luns++;
4357
4358	/* Setup statistics gathering */
4359	lun->stats.device_type = be_lun->lun_type;
4360	lun->stats.lun_number = lun_number;
4361	if (lun->stats.device_type == T_DIRECT)
4362		lun->stats.blocksize = be_lun->blocksize;
4363	else
4364		lun->stats.flags = CTL_LUN_STATS_NO_BLOCKSIZE;
4365	for (i = 0;i < CTL_MAX_PORTS;i++)
4366		lun->stats.ports[i].targ_port = i;
4367
4368	mtx_unlock(&ctl_softc->ctl_lock);
4369
4370	lun->be_lun->lun_config_status(lun->be_lun->be_lun, CTL_LUN_CONFIG_OK);
4371
4372	/*
4373	 * Run through each registered FETD and bring it online if it isn't
4374	 * already.  Enable the target ID if it hasn't been enabled, and
4375	 * enable this particular LUN.
4376	 */
4377	STAILQ_FOREACH(fe, &ctl_softc->fe_list, links) {
4378		int retval;
4379
4380		/*
4381		 * XXX KDM this only works for ONE TARGET ID.  We'll need
4382		 * to do things differently if we go to a multiple target
4383		 * ID scheme.
4384		 */
4385		if ((fe->status & CTL_PORT_STATUS_TARG_ONLINE) == 0) {
4386
4387			retval = fe->targ_enable(fe->targ_lun_arg, target_id);
4388			if (retval != 0) {
4389				printf("ctl_alloc_lun: FETD %s port %d "
4390				       "returned error %d for targ_enable on "
4391				       "target %ju\n", fe->port_name,
4392				       fe->targ_port, retval,
4393				       (uintmax_t)target_id.id);
4394			} else
4395				fe->status |= CTL_PORT_STATUS_TARG_ONLINE;
4396		}
4397
4398		retval = fe->lun_enable(fe->targ_lun_arg, target_id,lun_number);
4399		if (retval != 0) {
4400			printf("ctl_alloc_lun: FETD %s port %d returned error "
4401			       "%d for lun_enable on target %ju lun %d\n",
4402			       fe->port_name, fe->targ_port, retval,
4403			       (uintmax_t)target_id.id, lun_number);
4404		} else
4405			fe->status |= CTL_PORT_STATUS_LUN_ONLINE;
4406	}
4407	return (0);
4408}
4409
4410/*
4411 * Delete a LUN.
4412 * Assumptions:
4413 * - LUN has already been marked invalid and any pending I/O has been taken
4414 *   care of.
4415 */
4416static int
4417ctl_free_lun(struct ctl_lun *lun)
4418{
4419	struct ctl_softc *softc;
4420#if 0
4421	struct ctl_frontend *fe;
4422#endif
4423	struct ctl_lun *nlun;
4424	union ctl_io *io, *next_io;
4425	int i;
4426
4427	softc = lun->ctl_softc;
4428
4429	mtx_assert(&softc->ctl_lock, MA_OWNED);
4430
4431	STAILQ_REMOVE(&softc->lun_list, lun, ctl_lun, links);
4432
4433	ctl_clear_mask(softc->ctl_lun_mask, lun->lun);
4434
4435	softc->ctl_luns[lun->lun] = NULL;
4436
4437	if (TAILQ_FIRST(&lun->ooa_queue) != NULL) {
4438		printf("ctl_free_lun: aieee!! freeing a LUN with "
4439		       "outstanding I/O!!\n");
4440	}
4441
4442	/*
4443	 * If we have anything pending on the RtR queue, remove it.
4444	 */
4445	for (io = (union ctl_io *)STAILQ_FIRST(&softc->rtr_queue); io != NULL;
4446	     io = next_io) {
4447		uint32_t targ_lun;
4448
4449		next_io = (union ctl_io *)STAILQ_NEXT(&io->io_hdr, links);
4450		targ_lun = io->io_hdr.nexus.targ_lun;
4451		if (io->io_hdr.nexus.lun_map_fn != NULL)
4452			targ_lun = io->io_hdr.nexus.lun_map_fn(io->io_hdr.nexus.lun_map_arg, targ_lun);
4453		if ((io->io_hdr.nexus.targ_target.id == lun->target.id)
4454		 && (targ_lun == lun->lun))
4455			STAILQ_REMOVE(&softc->rtr_queue, &io->io_hdr,
4456				      ctl_io_hdr, links);
4457	}
4458
4459	/*
4460	 * Then remove everything from the blocked queue.
4461	 */
4462	for (io = (union ctl_io *)TAILQ_FIRST(&lun->blocked_queue); io != NULL;
4463	     io = next_io) {
4464		next_io = (union ctl_io *)TAILQ_NEXT(&io->io_hdr,blocked_links);
4465		TAILQ_REMOVE(&lun->blocked_queue, &io->io_hdr, blocked_links);
4466		io->io_hdr.flags &= ~CTL_FLAG_BLOCKED;
4467	}
4468
4469	/*
4470	 * Now clear out the OOA queue, and free all the I/O.
4471	 * XXX KDM should we notify the FETD here?  We probably need to
4472	 * quiesce the LUN before deleting it.
4473	 */
4474	for (io = (union ctl_io *)TAILQ_FIRST(&lun->ooa_queue); io != NULL;
4475	     io = next_io) {
4476		next_io = (union ctl_io *)TAILQ_NEXT(&io->io_hdr, ooa_links);
4477		TAILQ_REMOVE(&lun->ooa_queue, &io->io_hdr, ooa_links);
4478		ctl_free_io(io);
4479	}
4480
4481	softc->num_luns--;
4482
4483	/*
4484	 * XXX KDM this scheme only works for a single target/multiple LUN
4485	 * setup.  It needs to be revamped for a multiple target scheme.
4486	 *
4487	 * XXX KDM this results in fe->lun_disable() getting called twice,
4488	 * once when ctl_disable_lun() is called, and a second time here.
4489	 * We really need to re-think the LUN disable semantics.  There
4490	 * should probably be several steps/levels to LUN removal:
4491	 *  - disable
4492	 *  - invalidate
4493	 *  - free
4494 	 *
4495	 * Right now we only have a disable method when communicating to
4496	 * the front end ports, at least for individual LUNs.
4497	 */
4498#if 0
4499	STAILQ_FOREACH(fe, &softc->fe_list, links) {
4500		int retval;
4501
4502		retval = fe->lun_disable(fe->targ_lun_arg, lun->target,
4503					 lun->lun);
4504		if (retval != 0) {
4505			printf("ctl_free_lun: FETD %s port %d returned error "
4506			       "%d for lun_disable on target %ju lun %jd\n",
4507			       fe->port_name, fe->targ_port, retval,
4508			       (uintmax_t)lun->target.id, (intmax_t)lun->lun);
4509		}
4510
4511		if (STAILQ_FIRST(&softc->lun_list) == NULL) {
4512			fe->status &= ~CTL_PORT_STATUS_LUN_ONLINE;
4513
4514			retval = fe->targ_disable(fe->targ_lun_arg,lun->target);
4515			if (retval != 0) {
4516				printf("ctl_free_lun: FETD %s port %d "
4517				       "returned error %d for targ_disable on "
4518				       "target %ju\n", fe->port_name,
4519				       fe->targ_port, retval,
4520				       (uintmax_t)lun->target.id);
4521			} else
4522				fe->status &= ~CTL_PORT_STATUS_TARG_ONLINE;
4523
4524			if ((fe->status & CTL_PORT_STATUS_TARG_ONLINE) != 0)
4525				continue;
4526
4527#if 0
4528			fe->port_offline(fe->onoff_arg);
4529			fe->status &= ~CTL_PORT_STATUS_ONLINE;
4530#endif
4531		}
4532	}
4533#endif
4534
4535	/*
4536	 * Tell the backend to free resources, if this LUN has a backend.
4537	 */
4538	atomic_subtract_int(&lun->be_lun->be->num_luns, 1);
4539	lun->be_lun->lun_shutdown(lun->be_lun->be_lun);
4540
4541	if (lun->flags & CTL_LUN_MALLOCED)
4542		free(lun, M_CTL);
4543
4544	STAILQ_FOREACH(nlun, &softc->lun_list, links) {
4545		for (i = 0; i < CTL_MAX_INITIATORS; i++) {
4546			nlun->pending_sense[i].ua_pending |= CTL_UA_LUN_CHANGE;
4547		}
4548	}
4549
4550	return (0);
4551}
4552
4553static void
4554ctl_create_lun(struct ctl_be_lun *be_lun)
4555{
4556	struct ctl_softc *ctl_softc;
4557
4558	ctl_softc = control_softc;
4559
4560	/*
4561	 * ctl_alloc_lun() should handle all potential failure cases.
4562	 */
4563	ctl_alloc_lun(ctl_softc, NULL, be_lun, ctl_softc->target);
4564}
4565
4566int
4567ctl_add_lun(struct ctl_be_lun *be_lun)
4568{
4569	struct ctl_softc *ctl_softc;
4570
4571	ctl_softc = control_softc;
4572
4573	mtx_lock(&ctl_softc->ctl_lock);
4574	STAILQ_INSERT_TAIL(&ctl_softc->pending_lun_queue, be_lun, links);
4575	mtx_unlock(&ctl_softc->ctl_lock);
4576
4577	ctl_wakeup_thread();
4578
4579	return (0);
4580}
4581
4582int
4583ctl_enable_lun(struct ctl_be_lun *be_lun)
4584{
4585	struct ctl_softc *ctl_softc;
4586	struct ctl_frontend *fe, *nfe;
4587	struct ctl_lun *lun;
4588	int retval;
4589
4590	ctl_softc = control_softc;
4591
4592	lun = (struct ctl_lun *)be_lun->ctl_lun;
4593
4594	mtx_lock(&ctl_softc->ctl_lock);
4595	if ((lun->flags & CTL_LUN_DISABLED) == 0) {
4596		/*
4597		 * eh?  Why did we get called if the LUN is already
4598		 * enabled?
4599		 */
4600		mtx_unlock(&ctl_softc->ctl_lock);
4601		return (0);
4602	}
4603	lun->flags &= ~CTL_LUN_DISABLED;
4604
4605	for (fe = STAILQ_FIRST(&ctl_softc->fe_list); fe != NULL; fe = nfe) {
4606		nfe = STAILQ_NEXT(fe, links);
4607
4608		/*
4609		 * Drop the lock while we call the FETD's enable routine.
4610		 * This can lead to a callback into CTL (at least in the
4611		 * case of the internal initiator frontend.
4612		 */
4613		mtx_unlock(&ctl_softc->ctl_lock);
4614		retval = fe->lun_enable(fe->targ_lun_arg, lun->target,lun->lun);
4615		mtx_lock(&ctl_softc->ctl_lock);
4616		if (retval != 0) {
4617			printf("%s: FETD %s port %d returned error "
4618			       "%d for lun_enable on target %ju lun %jd\n",
4619			       __func__, fe->port_name, fe->targ_port, retval,
4620			       (uintmax_t)lun->target.id, (intmax_t)lun->lun);
4621		}
4622#if 0
4623		 else {
4624            /* NOTE:  TODO:  why does lun enable affect port status? */
4625			fe->status |= CTL_PORT_STATUS_LUN_ONLINE;
4626		}
4627#endif
4628	}
4629
4630	mtx_unlock(&ctl_softc->ctl_lock);
4631
4632	return (0);
4633}
4634
4635int
4636ctl_disable_lun(struct ctl_be_lun *be_lun)
4637{
4638	struct ctl_softc *ctl_softc;
4639	struct ctl_frontend *fe;
4640	struct ctl_lun *lun;
4641	int retval;
4642
4643	ctl_softc = control_softc;
4644
4645	lun = (struct ctl_lun *)be_lun->ctl_lun;
4646
4647	mtx_lock(&ctl_softc->ctl_lock);
4648
4649	if (lun->flags & CTL_LUN_DISABLED) {
4650		mtx_unlock(&ctl_softc->ctl_lock);
4651		return (0);
4652	}
4653	lun->flags |= CTL_LUN_DISABLED;
4654
4655	STAILQ_FOREACH(fe, &ctl_softc->fe_list, links) {
4656		mtx_unlock(&ctl_softc->ctl_lock);
4657		/*
4658		 * Drop the lock before we call the frontend's disable
4659		 * routine, to avoid lock order reversals.
4660		 *
4661		 * XXX KDM what happens if the frontend list changes while
4662		 * we're traversing it?  It's unlikely, but should be handled.
4663		 */
4664		retval = fe->lun_disable(fe->targ_lun_arg, lun->target,
4665					 lun->lun);
4666		mtx_lock(&ctl_softc->ctl_lock);
4667		if (retval != 0) {
4668			printf("ctl_alloc_lun: FETD %s port %d returned error "
4669			       "%d for lun_disable on target %ju lun %jd\n",
4670			       fe->port_name, fe->targ_port, retval,
4671			       (uintmax_t)lun->target.id, (intmax_t)lun->lun);
4672		}
4673	}
4674
4675	mtx_unlock(&ctl_softc->ctl_lock);
4676
4677	return (0);
4678}
4679
4680int
4681ctl_start_lun(struct ctl_be_lun *be_lun)
4682{
4683	struct ctl_softc *ctl_softc;
4684	struct ctl_lun *lun;
4685
4686	ctl_softc = control_softc;
4687
4688	lun = (struct ctl_lun *)be_lun->ctl_lun;
4689
4690	mtx_lock(&ctl_softc->ctl_lock);
4691	lun->flags &= ~CTL_LUN_STOPPED;
4692	mtx_unlock(&ctl_softc->ctl_lock);
4693
4694	return (0);
4695}
4696
4697int
4698ctl_stop_lun(struct ctl_be_lun *be_lun)
4699{
4700	struct ctl_softc *ctl_softc;
4701	struct ctl_lun *lun;
4702
4703	ctl_softc = control_softc;
4704
4705	lun = (struct ctl_lun *)be_lun->ctl_lun;
4706
4707	mtx_lock(&ctl_softc->ctl_lock);
4708	lun->flags |= CTL_LUN_STOPPED;
4709	mtx_unlock(&ctl_softc->ctl_lock);
4710
4711	return (0);
4712}
4713
4714int
4715ctl_lun_offline(struct ctl_be_lun *be_lun)
4716{
4717	struct ctl_softc *ctl_softc;
4718	struct ctl_lun *lun;
4719
4720	ctl_softc = control_softc;
4721
4722	lun = (struct ctl_lun *)be_lun->ctl_lun;
4723
4724	mtx_lock(&ctl_softc->ctl_lock);
4725	lun->flags |= CTL_LUN_OFFLINE;
4726	mtx_unlock(&ctl_softc->ctl_lock);
4727
4728	return (0);
4729}
4730
4731int
4732ctl_lun_online(struct ctl_be_lun *be_lun)
4733{
4734	struct ctl_softc *ctl_softc;
4735	struct ctl_lun *lun;
4736
4737	ctl_softc = control_softc;
4738
4739	lun = (struct ctl_lun *)be_lun->ctl_lun;
4740
4741	mtx_lock(&ctl_softc->ctl_lock);
4742	lun->flags &= ~CTL_LUN_OFFLINE;
4743	mtx_unlock(&ctl_softc->ctl_lock);
4744
4745	return (0);
4746}
4747
4748int
4749ctl_invalidate_lun(struct ctl_be_lun *be_lun)
4750{
4751	struct ctl_softc *ctl_softc;
4752	struct ctl_lun *lun;
4753
4754	ctl_softc = control_softc;
4755
4756	lun = (struct ctl_lun *)be_lun->ctl_lun;
4757
4758	mtx_lock(&ctl_softc->ctl_lock);
4759
4760	/*
4761	 * The LUN needs to be disabled before it can be marked invalid.
4762	 */
4763	if ((lun->flags & CTL_LUN_DISABLED) == 0) {
4764		mtx_unlock(&ctl_softc->ctl_lock);
4765		return (-1);
4766	}
4767	/*
4768	 * Mark the LUN invalid.
4769	 */
4770	lun->flags |= CTL_LUN_INVALID;
4771
4772	/*
4773	 * If there is nothing in the OOA queue, go ahead and free the LUN.
4774	 * If we have something in the OOA queue, we'll free it when the
4775	 * last I/O completes.
4776	 */
4777	if (TAILQ_FIRST(&lun->ooa_queue) == NULL)
4778		ctl_free_lun(lun);
4779	mtx_unlock(&ctl_softc->ctl_lock);
4780
4781	return (0);
4782}
4783
4784int
4785ctl_lun_inoperable(struct ctl_be_lun *be_lun)
4786{
4787	struct ctl_softc *ctl_softc;
4788	struct ctl_lun *lun;
4789
4790	ctl_softc = control_softc;
4791	lun = (struct ctl_lun *)be_lun->ctl_lun;
4792
4793	mtx_lock(&ctl_softc->ctl_lock);
4794	lun->flags |= CTL_LUN_INOPERABLE;
4795	mtx_unlock(&ctl_softc->ctl_lock);
4796
4797	return (0);
4798}
4799
4800int
4801ctl_lun_operable(struct ctl_be_lun *be_lun)
4802{
4803	struct ctl_softc *ctl_softc;
4804	struct ctl_lun *lun;
4805
4806	ctl_softc = control_softc;
4807	lun = (struct ctl_lun *)be_lun->ctl_lun;
4808
4809	mtx_lock(&ctl_softc->ctl_lock);
4810	lun->flags &= ~CTL_LUN_INOPERABLE;
4811	mtx_unlock(&ctl_softc->ctl_lock);
4812
4813	return (0);
4814}
4815
4816int
4817ctl_lun_power_lock(struct ctl_be_lun *be_lun, struct ctl_nexus *nexus,
4818		   int lock)
4819{
4820	struct ctl_softc *softc;
4821	struct ctl_lun *lun;
4822	struct copan_aps_subpage *current_sp;
4823	struct ctl_page_index *page_index;
4824	int i;
4825
4826	softc = control_softc;
4827
4828	mtx_lock(&softc->ctl_lock);
4829
4830	lun = (struct ctl_lun *)be_lun->ctl_lun;
4831
4832	page_index = NULL;
4833	for (i = 0; i < CTL_NUM_MODE_PAGES; i++) {
4834		if ((lun->mode_pages.index[i].page_code & SMPH_PC_MASK) !=
4835		     APS_PAGE_CODE)
4836			continue;
4837
4838		if (lun->mode_pages.index[i].subpage != APS_SUBPAGE_CODE)
4839			continue;
4840		page_index = &lun->mode_pages.index[i];
4841	}
4842
4843	if (page_index == NULL) {
4844		mtx_unlock(&softc->ctl_lock);
4845		printf("%s: APS subpage not found for lun %ju!\n", __func__,
4846		       (uintmax_t)lun->lun);
4847		return (1);
4848	}
4849#if 0
4850	if ((softc->aps_locked_lun != 0)
4851	 && (softc->aps_locked_lun != lun->lun)) {
4852		printf("%s: attempt to lock LUN %llu when %llu is already "
4853		       "locked\n");
4854		mtx_unlock(&softc->ctl_lock);
4855		return (1);
4856	}
4857#endif
4858
4859	current_sp = (struct copan_aps_subpage *)(page_index->page_data +
4860		(page_index->page_len * CTL_PAGE_CURRENT));
4861
4862	if (lock != 0) {
4863		current_sp->lock_active = APS_LOCK_ACTIVE;
4864		softc->aps_locked_lun = lun->lun;
4865	} else {
4866		current_sp->lock_active = 0;
4867		softc->aps_locked_lun = 0;
4868	}
4869
4870
4871	/*
4872	 * If we're in HA mode, try to send the lock message to the other
4873	 * side.
4874	 */
4875	if (ctl_is_single == 0) {
4876		int isc_retval;
4877		union ctl_ha_msg lock_msg;
4878
4879		lock_msg.hdr.nexus = *nexus;
4880		lock_msg.hdr.msg_type = CTL_MSG_APS_LOCK;
4881		if (lock != 0)
4882			lock_msg.aps.lock_flag = 1;
4883		else
4884			lock_msg.aps.lock_flag = 0;
4885		isc_retval = ctl_ha_msg_send(CTL_HA_CHAN_CTL, &lock_msg,
4886					 sizeof(lock_msg), 0);
4887		if (isc_retval > CTL_HA_STATUS_SUCCESS) {
4888			printf("%s: APS (lock=%d) error returned from "
4889			       "ctl_ha_msg_send: %d\n", __func__, lock, isc_retval);
4890			mtx_unlock(&softc->ctl_lock);
4891			return (1);
4892		}
4893	}
4894
4895	mtx_unlock(&softc->ctl_lock);
4896
4897	return (0);
4898}
4899
4900void
4901ctl_lun_capacity_changed(struct ctl_be_lun *be_lun)
4902{
4903	struct ctl_lun *lun;
4904	struct ctl_softc *softc;
4905	int i;
4906
4907	softc = control_softc;
4908
4909	mtx_lock(&softc->ctl_lock);
4910
4911	lun = (struct ctl_lun *)be_lun->ctl_lun;
4912
4913	for (i = 0; i < CTL_MAX_INITIATORS; i++)
4914		lun->pending_sense[i].ua_pending |= CTL_UA_CAPACITY_CHANGED;
4915
4916	mtx_unlock(&softc->ctl_lock);
4917}
4918
4919/*
4920 * Backend "memory move is complete" callback for requests that never
4921 * make it down to say RAIDCore's configuration code.
4922 */
4923int
4924ctl_config_move_done(union ctl_io *io)
4925{
4926	int retval;
4927
4928	retval = CTL_RETVAL_COMPLETE;
4929
4930
4931	CTL_DEBUG_PRINT(("ctl_config_move_done\n"));
4932	/*
4933	 * XXX KDM this shouldn't happen, but what if it does?
4934	 */
4935	if (io->io_hdr.io_type != CTL_IO_SCSI)
4936		panic("I/O type isn't CTL_IO_SCSI!");
4937
4938	if ((io->io_hdr.port_status == 0)
4939	 && ((io->io_hdr.flags & CTL_FLAG_ABORT) == 0)
4940	 && ((io->io_hdr.status & CTL_STATUS_MASK) == CTL_STATUS_NONE))
4941		io->io_hdr.status = CTL_SUCCESS;
4942	else if ((io->io_hdr.port_status != 0)
4943	      && ((io->io_hdr.flags & CTL_FLAG_ABORT) == 0)
4944	      && ((io->io_hdr.status & CTL_STATUS_MASK) == CTL_STATUS_NONE)){
4945		/*
4946		 * For hardware error sense keys, the sense key
4947		 * specific value is defined to be a retry count,
4948		 * but we use it to pass back an internal FETD
4949		 * error code.  XXX KDM  Hopefully the FETD is only
4950		 * using 16 bits for an error code, since that's
4951		 * all the space we have in the sks field.
4952		 */
4953		ctl_set_internal_failure(&io->scsiio,
4954					 /*sks_valid*/ 1,
4955					 /*retry_count*/
4956					 io->io_hdr.port_status);
4957		if (io->io_hdr.flags & CTL_FLAG_ALLOCATED)
4958			free(io->scsiio.kern_data_ptr, M_CTL);
4959		ctl_done(io);
4960		goto bailout;
4961	}
4962
4963	if (((io->io_hdr.flags & CTL_FLAG_DATA_MASK) == CTL_FLAG_DATA_IN)
4964	 || ((io->io_hdr.status & CTL_STATUS_MASK) != CTL_SUCCESS)
4965	 || ((io->io_hdr.flags & CTL_FLAG_ABORT) != 0)) {
4966		/*
4967		 * XXX KDM just assuming a single pointer here, and not a
4968		 * S/G list.  If we start using S/G lists for config data,
4969		 * we'll need to know how to clean them up here as well.
4970		 */
4971		if (io->io_hdr.flags & CTL_FLAG_ALLOCATED)
4972			free(io->scsiio.kern_data_ptr, M_CTL);
4973		/* Hopefully the user has already set the status... */
4974		ctl_done(io);
4975	} else {
4976		/*
4977		 * XXX KDM now we need to continue data movement.  Some
4978		 * options:
4979		 * - call ctl_scsiio() again?  We don't do this for data
4980		 *   writes, because for those at least we know ahead of
4981		 *   time where the write will go and how long it is.  For
4982		 *   config writes, though, that information is largely
4983		 *   contained within the write itself, thus we need to
4984		 *   parse out the data again.
4985		 *
4986		 * - Call some other function once the data is in?
4987		 */
4988
4989		/*
4990		 * XXX KDM call ctl_scsiio() again for now, and check flag
4991		 * bits to see whether we're allocated or not.
4992		 */
4993		retval = ctl_scsiio(&io->scsiio);
4994	}
4995bailout:
4996	return (retval);
4997}
4998
4999/*
5000 * This gets called by a backend driver when it is done with a
5001 * data_submit method.
5002 */
5003void
5004ctl_data_submit_done(union ctl_io *io)
5005{
5006	/*
5007	 * If the IO_CONT flag is set, we need to call the supplied
5008	 * function to continue processing the I/O, instead of completing
5009	 * the I/O just yet.
5010	 *
5011	 * If there is an error, though, we don't want to keep processing.
5012	 * Instead, just send status back to the initiator.
5013	 */
5014	if ((io->io_hdr.flags & CTL_FLAG_IO_CONT) &&
5015	    (io->io_hdr.flags & CTL_FLAG_ABORT) == 0 &&
5016	    ((io->io_hdr.status & CTL_STATUS_MASK) == CTL_STATUS_NONE ||
5017	     (io->io_hdr.status & CTL_STATUS_MASK) == CTL_SUCCESS)) {
5018		io->scsiio.io_cont(io);
5019		return;
5020	}
5021	ctl_done(io);
5022}
5023
5024/*
5025 * This gets called by a backend driver when it is done with a
5026 * configuration write.
5027 */
5028void
5029ctl_config_write_done(union ctl_io *io)
5030{
5031	/*
5032	 * If the IO_CONT flag is set, we need to call the supplied
5033	 * function to continue processing the I/O, instead of completing
5034	 * the I/O just yet.
5035	 *
5036	 * If there is an error, though, we don't want to keep processing.
5037	 * Instead, just send status back to the initiator.
5038	 */
5039	if ((io->io_hdr.flags & CTL_FLAG_IO_CONT)
5040	 && (((io->io_hdr.status & CTL_STATUS_MASK) == CTL_STATUS_NONE)
5041	  || ((io->io_hdr.status & CTL_STATUS_MASK) == CTL_SUCCESS))) {
5042		io->scsiio.io_cont(io);
5043		return;
5044	}
5045	/*
5046	 * Since a configuration write can be done for commands that actually
5047	 * have data allocated, like write buffer, and commands that have
5048	 * no data, like start/stop unit, we need to check here.
5049	 */
5050	if ((io->io_hdr.flags & CTL_FLAG_DATA_MASK) == CTL_FLAG_DATA_OUT)
5051		free(io->scsiio.kern_data_ptr, M_CTL);
5052	ctl_done(io);
5053}
5054
5055/*
5056 * SCSI release command.
5057 */
5058int
5059ctl_scsi_release(struct ctl_scsiio *ctsio)
5060{
5061	int length, longid, thirdparty_id, resv_id;
5062	struct ctl_softc *ctl_softc;
5063	struct ctl_lun *lun;
5064
5065	length = 0;
5066	resv_id = 0;
5067
5068	CTL_DEBUG_PRINT(("ctl_scsi_release\n"));
5069
5070	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5071	ctl_softc = control_softc;
5072
5073	switch (ctsio->cdb[0]) {
5074	case RELEASE: {
5075		struct scsi_release *cdb;
5076
5077		cdb = (struct scsi_release *)ctsio->cdb;
5078		if ((cdb->byte2 & 0x1f) != 0) {
5079			ctl_set_invalid_field(ctsio,
5080					      /*sks_valid*/ 1,
5081					      /*command*/ 1,
5082					      /*field*/ 1,
5083					      /*bit_valid*/ 0,
5084					      /*bit*/ 0);
5085			ctl_done((union ctl_io *)ctsio);
5086			return (CTL_RETVAL_COMPLETE);
5087		}
5088		break;
5089	}
5090	case RELEASE_10: {
5091		struct scsi_release_10 *cdb;
5092
5093		cdb = (struct scsi_release_10 *)ctsio->cdb;
5094
5095		if ((cdb->byte2 & SR10_EXTENT) != 0) {
5096			ctl_set_invalid_field(ctsio,
5097					      /*sks_valid*/ 1,
5098					      /*command*/ 1,
5099					      /*field*/ 1,
5100					      /*bit_valid*/ 1,
5101					      /*bit*/ 0);
5102			ctl_done((union ctl_io *)ctsio);
5103			return (CTL_RETVAL_COMPLETE);
5104
5105		}
5106
5107		if ((cdb->byte2 & SR10_3RDPTY) != 0) {
5108			ctl_set_invalid_field(ctsio,
5109					      /*sks_valid*/ 1,
5110					      /*command*/ 1,
5111					      /*field*/ 1,
5112					      /*bit_valid*/ 1,
5113					      /*bit*/ 4);
5114			ctl_done((union ctl_io *)ctsio);
5115			return (CTL_RETVAL_COMPLETE);
5116		}
5117
5118		if (cdb->byte2 & SR10_LONGID)
5119			longid = 1;
5120		else
5121			thirdparty_id = cdb->thirdparty_id;
5122
5123		resv_id = cdb->resv_id;
5124		length = scsi_2btoul(cdb->length);
5125		break;
5126	}
5127	}
5128
5129
5130	/*
5131	 * XXX KDM right now, we only support LUN reservation.  We don't
5132	 * support 3rd party reservations, or extent reservations, which
5133	 * might actually need the parameter list.  If we've gotten this
5134	 * far, we've got a LUN reservation.  Anything else got kicked out
5135	 * above.  So, according to SPC, ignore the length.
5136	 */
5137	length = 0;
5138
5139	if (((ctsio->io_hdr.flags & CTL_FLAG_ALLOCATED) == 0)
5140	 && (length > 0)) {
5141		ctsio->kern_data_ptr = malloc(length, M_CTL, M_WAITOK);
5142		ctsio->kern_data_len = length;
5143		ctsio->kern_total_len = length;
5144		ctsio->kern_data_resid = 0;
5145		ctsio->kern_rel_offset = 0;
5146		ctsio->kern_sg_entries = 0;
5147		ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
5148		ctsio->be_move_done = ctl_config_move_done;
5149		ctl_datamove((union ctl_io *)ctsio);
5150
5151		return (CTL_RETVAL_COMPLETE);
5152	}
5153
5154	if (length > 0)
5155		thirdparty_id = scsi_8btou64(ctsio->kern_data_ptr);
5156
5157	mtx_lock(&ctl_softc->ctl_lock);
5158
5159	/*
5160	 * According to SPC, it is not an error for an intiator to attempt
5161	 * to release a reservation on a LUN that isn't reserved, or that
5162	 * is reserved by another initiator.  The reservation can only be
5163	 * released, though, by the initiator who made it or by one of
5164	 * several reset type events.
5165	 */
5166	if (lun->flags & CTL_LUN_RESERVED) {
5167		if ((ctsio->io_hdr.nexus.initid.id == lun->rsv_nexus.initid.id)
5168		 && (ctsio->io_hdr.nexus.targ_port == lun->rsv_nexus.targ_port)
5169		 && (ctsio->io_hdr.nexus.targ_target.id ==
5170		     lun->rsv_nexus.targ_target.id)) {
5171			lun->flags &= ~CTL_LUN_RESERVED;
5172		}
5173	}
5174
5175	ctsio->scsi_status = SCSI_STATUS_OK;
5176	ctsio->io_hdr.status = CTL_SUCCESS;
5177
5178	if (ctsio->io_hdr.flags & CTL_FLAG_ALLOCATED) {
5179		free(ctsio->kern_data_ptr, M_CTL);
5180		ctsio->io_hdr.flags &= ~CTL_FLAG_ALLOCATED;
5181	}
5182
5183	mtx_unlock(&ctl_softc->ctl_lock);
5184
5185	ctl_done((union ctl_io *)ctsio);
5186	return (CTL_RETVAL_COMPLETE);
5187}
5188
5189int
5190ctl_scsi_reserve(struct ctl_scsiio *ctsio)
5191{
5192	int extent, thirdparty, longid;
5193	int resv_id, length;
5194	uint64_t thirdparty_id;
5195	struct ctl_softc *ctl_softc;
5196	struct ctl_lun *lun;
5197
5198	extent = 0;
5199	thirdparty = 0;
5200	longid = 0;
5201	resv_id = 0;
5202	length = 0;
5203	thirdparty_id = 0;
5204
5205	CTL_DEBUG_PRINT(("ctl_reserve\n"));
5206
5207	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5208	ctl_softc = control_softc;
5209
5210	switch (ctsio->cdb[0]) {
5211	case RESERVE: {
5212		struct scsi_reserve *cdb;
5213
5214		cdb = (struct scsi_reserve *)ctsio->cdb;
5215		if ((cdb->byte2 & 0x1f) != 0) {
5216			ctl_set_invalid_field(ctsio,
5217					      /*sks_valid*/ 1,
5218					      /*command*/ 1,
5219					      /*field*/ 1,
5220					      /*bit_valid*/ 0,
5221					      /*bit*/ 0);
5222			ctl_done((union ctl_io *)ctsio);
5223			return (CTL_RETVAL_COMPLETE);
5224		}
5225		resv_id = cdb->resv_id;
5226		length = scsi_2btoul(cdb->length);
5227		break;
5228	}
5229	case RESERVE_10: {
5230		struct scsi_reserve_10 *cdb;
5231
5232		cdb = (struct scsi_reserve_10 *)ctsio->cdb;
5233
5234		if ((cdb->byte2 & SR10_EXTENT) != 0) {
5235			ctl_set_invalid_field(ctsio,
5236					      /*sks_valid*/ 1,
5237					      /*command*/ 1,
5238					      /*field*/ 1,
5239					      /*bit_valid*/ 1,
5240					      /*bit*/ 0);
5241			ctl_done((union ctl_io *)ctsio);
5242			return (CTL_RETVAL_COMPLETE);
5243		}
5244		if ((cdb->byte2 & SR10_3RDPTY) != 0) {
5245			ctl_set_invalid_field(ctsio,
5246					      /*sks_valid*/ 1,
5247					      /*command*/ 1,
5248					      /*field*/ 1,
5249					      /*bit_valid*/ 1,
5250					      /*bit*/ 4);
5251			ctl_done((union ctl_io *)ctsio);
5252			return (CTL_RETVAL_COMPLETE);
5253		}
5254		if (cdb->byte2 & SR10_LONGID)
5255			longid = 1;
5256		else
5257			thirdparty_id = cdb->thirdparty_id;
5258
5259		resv_id = cdb->resv_id;
5260		length = scsi_2btoul(cdb->length);
5261		break;
5262	}
5263	}
5264
5265	/*
5266	 * XXX KDM right now, we only support LUN reservation.  We don't
5267	 * support 3rd party reservations, or extent reservations, which
5268	 * might actually need the parameter list.  If we've gotten this
5269	 * far, we've got a LUN reservation.  Anything else got kicked out
5270	 * above.  So, according to SPC, ignore the length.
5271	 */
5272	length = 0;
5273
5274	if (((ctsio->io_hdr.flags & CTL_FLAG_ALLOCATED) == 0)
5275	 && (length > 0)) {
5276		ctsio->kern_data_ptr = malloc(length, M_CTL, M_WAITOK);
5277		ctsio->kern_data_len = length;
5278		ctsio->kern_total_len = length;
5279		ctsio->kern_data_resid = 0;
5280		ctsio->kern_rel_offset = 0;
5281		ctsio->kern_sg_entries = 0;
5282		ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
5283		ctsio->be_move_done = ctl_config_move_done;
5284		ctl_datamove((union ctl_io *)ctsio);
5285
5286		return (CTL_RETVAL_COMPLETE);
5287	}
5288
5289	if (length > 0)
5290		thirdparty_id = scsi_8btou64(ctsio->kern_data_ptr);
5291
5292	mtx_lock(&ctl_softc->ctl_lock);
5293	if (lun->flags & CTL_LUN_RESERVED) {
5294		if ((ctsio->io_hdr.nexus.initid.id != lun->rsv_nexus.initid.id)
5295		 || (ctsio->io_hdr.nexus.targ_port != lun->rsv_nexus.targ_port)
5296		 || (ctsio->io_hdr.nexus.targ_target.id !=
5297		     lun->rsv_nexus.targ_target.id)) {
5298			ctsio->scsi_status = SCSI_STATUS_RESERV_CONFLICT;
5299			ctsio->io_hdr.status = CTL_SCSI_ERROR;
5300			goto bailout;
5301		}
5302	}
5303
5304	lun->flags |= CTL_LUN_RESERVED;
5305	lun->rsv_nexus = ctsio->io_hdr.nexus;
5306
5307	ctsio->scsi_status = SCSI_STATUS_OK;
5308	ctsio->io_hdr.status = CTL_SUCCESS;
5309
5310bailout:
5311	if (ctsio->io_hdr.flags & CTL_FLAG_ALLOCATED) {
5312		free(ctsio->kern_data_ptr, M_CTL);
5313		ctsio->io_hdr.flags &= ~CTL_FLAG_ALLOCATED;
5314	}
5315
5316	mtx_unlock(&ctl_softc->ctl_lock);
5317
5318	ctl_done((union ctl_io *)ctsio);
5319	return (CTL_RETVAL_COMPLETE);
5320}
5321
5322int
5323ctl_start_stop(struct ctl_scsiio *ctsio)
5324{
5325	struct scsi_start_stop_unit *cdb;
5326	struct ctl_lun *lun;
5327	struct ctl_softc *ctl_softc;
5328	int retval;
5329
5330	CTL_DEBUG_PRINT(("ctl_start_stop\n"));
5331
5332	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5333	ctl_softc = control_softc;
5334	retval = 0;
5335
5336	cdb = (struct scsi_start_stop_unit *)ctsio->cdb;
5337
5338	/*
5339	 * XXX KDM
5340	 * We don't support the immediate bit on a stop unit.  In order to
5341	 * do that, we would need to code up a way to know that a stop is
5342	 * pending, and hold off any new commands until it completes, one
5343	 * way or another.  Then we could accept or reject those commands
5344	 * depending on its status.  We would almost need to do the reverse
5345	 * of what we do below for an immediate start -- return the copy of
5346	 * the ctl_io to the FETD with status to send to the host (and to
5347	 * free the copy!) and then free the original I/O once the stop
5348	 * actually completes.  That way, the OOA queue mechanism can work
5349	 * to block commands that shouldn't proceed.  Another alternative
5350	 * would be to put the copy in the queue in place of the original,
5351	 * and return the original back to the caller.  That could be
5352	 * slightly safer..
5353	 */
5354	if ((cdb->byte2 & SSS_IMMED)
5355	 && ((cdb->how & SSS_START) == 0)) {
5356		ctl_set_invalid_field(ctsio,
5357				      /*sks_valid*/ 1,
5358				      /*command*/ 1,
5359				      /*field*/ 1,
5360				      /*bit_valid*/ 1,
5361				      /*bit*/ 0);
5362		ctl_done((union ctl_io *)ctsio);
5363		return (CTL_RETVAL_COMPLETE);
5364	}
5365
5366	/*
5367	 * We don't support the power conditions field.  We need to check
5368	 * this prior to checking the load/eject and start/stop bits.
5369	 */
5370	if ((cdb->how & SSS_PC_MASK) != SSS_PC_START_VALID) {
5371		ctl_set_invalid_field(ctsio,
5372				      /*sks_valid*/ 1,
5373				      /*command*/ 1,
5374				      /*field*/ 4,
5375				      /*bit_valid*/ 1,
5376				      /*bit*/ 4);
5377		ctl_done((union ctl_io *)ctsio);
5378		return (CTL_RETVAL_COMPLETE);
5379	}
5380
5381	/*
5382	 * Media isn't removable, so we can't load or eject it.
5383	 */
5384	if ((cdb->how & SSS_LOEJ) != 0) {
5385		ctl_set_invalid_field(ctsio,
5386				      /*sks_valid*/ 1,
5387				      /*command*/ 1,
5388				      /*field*/ 4,
5389				      /*bit_valid*/ 1,
5390				      /*bit*/ 1);
5391		ctl_done((union ctl_io *)ctsio);
5392		return (CTL_RETVAL_COMPLETE);
5393	}
5394
5395	if ((lun->flags & CTL_LUN_PR_RESERVED)
5396	 && ((cdb->how & SSS_START)==0)) {
5397		uint32_t residx;
5398
5399		residx = ctl_get_resindex(&ctsio->io_hdr.nexus);
5400		if (!lun->per_res[residx].registered
5401		 || (lun->pr_res_idx!=residx && lun->res_type < 4)) {
5402
5403			ctl_set_reservation_conflict(ctsio);
5404			ctl_done((union ctl_io *)ctsio);
5405			return (CTL_RETVAL_COMPLETE);
5406		}
5407	}
5408
5409	/*
5410	 * If there is no backend on this device, we can't start or stop
5411	 * it.  In theory we shouldn't get any start/stop commands in the
5412	 * first place at this level if the LUN doesn't have a backend.
5413	 * That should get stopped by the command decode code.
5414	 */
5415	if (lun->backend == NULL) {
5416		ctl_set_invalid_opcode(ctsio);
5417		ctl_done((union ctl_io *)ctsio);
5418		return (CTL_RETVAL_COMPLETE);
5419	}
5420
5421	/*
5422	 * XXX KDM Copan-specific offline behavior.
5423	 * Figure out a reasonable way to port this?
5424	 */
5425#ifdef NEEDTOPORT
5426	mtx_lock(&ctl_softc->ctl_lock);
5427
5428	if (((cdb->byte2 & SSS_ONOFFLINE) == 0)
5429	 && (lun->flags & CTL_LUN_OFFLINE)) {
5430		/*
5431		 * If the LUN is offline, and the on/offline bit isn't set,
5432		 * reject the start or stop.  Otherwise, let it through.
5433		 */
5434		mtx_unlock(&ctl_softc->ctl_lock);
5435		ctl_set_lun_not_ready(ctsio);
5436		ctl_done((union ctl_io *)ctsio);
5437	} else {
5438		mtx_unlock(&ctl_softc->ctl_lock);
5439#endif /* NEEDTOPORT */
5440		/*
5441		 * This could be a start or a stop when we're online,
5442		 * or a stop/offline or start/online.  A start or stop when
5443		 * we're offline is covered in the case above.
5444		 */
5445		/*
5446		 * In the non-immediate case, we send the request to
5447		 * the backend and return status to the user when
5448		 * it is done.
5449		 *
5450		 * In the immediate case, we allocate a new ctl_io
5451		 * to hold a copy of the request, and send that to
5452		 * the backend.  We then set good status on the
5453		 * user's request and return it immediately.
5454		 */
5455		if (cdb->byte2 & SSS_IMMED) {
5456			union ctl_io *new_io;
5457
5458			new_io = ctl_alloc_io(ctsio->io_hdr.pool);
5459			if (new_io == NULL) {
5460				ctl_set_busy(ctsio);
5461				ctl_done((union ctl_io *)ctsio);
5462			} else {
5463				ctl_copy_io((union ctl_io *)ctsio,
5464					    new_io);
5465				retval = lun->backend->config_write(new_io);
5466				ctl_set_success(ctsio);
5467				ctl_done((union ctl_io *)ctsio);
5468			}
5469		} else {
5470			retval = lun->backend->config_write(
5471				(union ctl_io *)ctsio);
5472		}
5473#ifdef NEEDTOPORT
5474	}
5475#endif
5476	return (retval);
5477}
5478
5479/*
5480 * We support the SYNCHRONIZE CACHE command (10 and 16 byte versions), but
5481 * we don't really do anything with the LBA and length fields if the user
5482 * passes them in.  Instead we'll just flush out the cache for the entire
5483 * LUN.
5484 */
5485int
5486ctl_sync_cache(struct ctl_scsiio *ctsio)
5487{
5488	struct ctl_lun *lun;
5489	struct ctl_softc *ctl_softc;
5490	uint64_t starting_lba;
5491	uint32_t block_count;
5492	int reladr, immed;
5493	int retval;
5494
5495	CTL_DEBUG_PRINT(("ctl_sync_cache\n"));
5496
5497	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5498	ctl_softc = control_softc;
5499	retval = 0;
5500	reladr = 0;
5501	immed = 0;
5502
5503	switch (ctsio->cdb[0]) {
5504	case SYNCHRONIZE_CACHE: {
5505		struct scsi_sync_cache *cdb;
5506		cdb = (struct scsi_sync_cache *)ctsio->cdb;
5507
5508		if (cdb->byte2 & SSC_RELADR)
5509			reladr = 1;
5510
5511		if (cdb->byte2 & SSC_IMMED)
5512			immed = 1;
5513
5514		starting_lba = scsi_4btoul(cdb->begin_lba);
5515		block_count = scsi_2btoul(cdb->lb_count);
5516		break;
5517	}
5518	case SYNCHRONIZE_CACHE_16: {
5519		struct scsi_sync_cache_16 *cdb;
5520		cdb = (struct scsi_sync_cache_16 *)ctsio->cdb;
5521
5522		if (cdb->byte2 & SSC_RELADR)
5523			reladr = 1;
5524
5525		if (cdb->byte2 & SSC_IMMED)
5526			immed = 1;
5527
5528		starting_lba = scsi_8btou64(cdb->begin_lba);
5529		block_count = scsi_4btoul(cdb->lb_count);
5530		break;
5531	}
5532	default:
5533		ctl_set_invalid_opcode(ctsio);
5534		ctl_done((union ctl_io *)ctsio);
5535		goto bailout;
5536		break; /* NOTREACHED */
5537	}
5538
5539	if (immed) {
5540		/*
5541		 * We don't support the immediate bit.  Since it's in the
5542		 * same place for the 10 and 16 byte SYNCHRONIZE CACHE
5543		 * commands, we can just return the same error in either
5544		 * case.
5545		 */
5546		ctl_set_invalid_field(ctsio,
5547				      /*sks_valid*/ 1,
5548				      /*command*/ 1,
5549				      /*field*/ 1,
5550				      /*bit_valid*/ 1,
5551				      /*bit*/ 1);
5552		ctl_done((union ctl_io *)ctsio);
5553		goto bailout;
5554	}
5555
5556	if (reladr) {
5557		/*
5558		 * We don't support the reladr bit either.  It can only be
5559		 * used with linked commands, and we don't support linked
5560		 * commands.  Since the bit is in the same place for the
5561		 * 10 and 16 byte SYNCHRONIZE CACHE * commands, we can
5562		 * just return the same error in either case.
5563		 */
5564		ctl_set_invalid_field(ctsio,
5565				      /*sks_valid*/ 1,
5566				      /*command*/ 1,
5567				      /*field*/ 1,
5568				      /*bit_valid*/ 1,
5569				      /*bit*/ 0);
5570		ctl_done((union ctl_io *)ctsio);
5571		goto bailout;
5572	}
5573
5574	/*
5575	 * We check the LBA and length, but don't do anything with them.
5576	 * A SYNCHRONIZE CACHE will cause the entire cache for this lun to
5577	 * get flushed.  This check will just help satisfy anyone who wants
5578	 * to see an error for an out of range LBA.
5579	 */
5580	if ((starting_lba + block_count) > (lun->be_lun->maxlba + 1)) {
5581		ctl_set_lba_out_of_range(ctsio);
5582		ctl_done((union ctl_io *)ctsio);
5583		goto bailout;
5584	}
5585
5586	/*
5587	 * If this LUN has no backend, we can't flush the cache anyway.
5588	 */
5589	if (lun->backend == NULL) {
5590		ctl_set_invalid_opcode(ctsio);
5591		ctl_done((union ctl_io *)ctsio);
5592		goto bailout;
5593	}
5594
5595	/*
5596	 * Check to see whether we're configured to send the SYNCHRONIZE
5597	 * CACHE command directly to the back end.
5598	 */
5599	mtx_lock(&ctl_softc->ctl_lock);
5600	if ((ctl_softc->flags & CTL_FLAG_REAL_SYNC)
5601	 && (++(lun->sync_count) >= lun->sync_interval)) {
5602		lun->sync_count = 0;
5603		mtx_unlock(&ctl_softc->ctl_lock);
5604		retval = lun->backend->config_write((union ctl_io *)ctsio);
5605	} else {
5606		mtx_unlock(&ctl_softc->ctl_lock);
5607		ctl_set_success(ctsio);
5608		ctl_done((union ctl_io *)ctsio);
5609	}
5610
5611bailout:
5612
5613	return (retval);
5614}
5615
5616int
5617ctl_format(struct ctl_scsiio *ctsio)
5618{
5619	struct scsi_format *cdb;
5620	struct ctl_lun *lun;
5621	struct ctl_softc *ctl_softc;
5622	int length, defect_list_len;
5623
5624	CTL_DEBUG_PRINT(("ctl_format\n"));
5625
5626	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5627	ctl_softc = control_softc;
5628
5629	cdb = (struct scsi_format *)ctsio->cdb;
5630
5631	length = 0;
5632	if (cdb->byte2 & SF_FMTDATA) {
5633		if (cdb->byte2 & SF_LONGLIST)
5634			length = sizeof(struct scsi_format_header_long);
5635		else
5636			length = sizeof(struct scsi_format_header_short);
5637	}
5638
5639	if (((ctsio->io_hdr.flags & CTL_FLAG_ALLOCATED) == 0)
5640	 && (length > 0)) {
5641		ctsio->kern_data_ptr = malloc(length, M_CTL, M_WAITOK);
5642		ctsio->kern_data_len = length;
5643		ctsio->kern_total_len = length;
5644		ctsio->kern_data_resid = 0;
5645		ctsio->kern_rel_offset = 0;
5646		ctsio->kern_sg_entries = 0;
5647		ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
5648		ctsio->be_move_done = ctl_config_move_done;
5649		ctl_datamove((union ctl_io *)ctsio);
5650
5651		return (CTL_RETVAL_COMPLETE);
5652	}
5653
5654	defect_list_len = 0;
5655
5656	if (cdb->byte2 & SF_FMTDATA) {
5657		if (cdb->byte2 & SF_LONGLIST) {
5658			struct scsi_format_header_long *header;
5659
5660			header = (struct scsi_format_header_long *)
5661				ctsio->kern_data_ptr;
5662
5663			defect_list_len = scsi_4btoul(header->defect_list_len);
5664			if (defect_list_len != 0) {
5665				ctl_set_invalid_field(ctsio,
5666						      /*sks_valid*/ 1,
5667						      /*command*/ 0,
5668						      /*field*/ 2,
5669						      /*bit_valid*/ 0,
5670						      /*bit*/ 0);
5671				goto bailout;
5672			}
5673		} else {
5674			struct scsi_format_header_short *header;
5675
5676			header = (struct scsi_format_header_short *)
5677				ctsio->kern_data_ptr;
5678
5679			defect_list_len = scsi_2btoul(header->defect_list_len);
5680			if (defect_list_len != 0) {
5681				ctl_set_invalid_field(ctsio,
5682						      /*sks_valid*/ 1,
5683						      /*command*/ 0,
5684						      /*field*/ 2,
5685						      /*bit_valid*/ 0,
5686						      /*bit*/ 0);
5687				goto bailout;
5688			}
5689		}
5690	}
5691
5692	/*
5693	 * The format command will clear out the "Medium format corrupted"
5694	 * status if set by the configuration code.  That status is really
5695	 * just a way to notify the host that we have lost the media, and
5696	 * get them to issue a command that will basically make them think
5697	 * they're blowing away the media.
5698	 */
5699	mtx_lock(&ctl_softc->ctl_lock);
5700	lun->flags &= ~CTL_LUN_INOPERABLE;
5701	mtx_unlock(&ctl_softc->ctl_lock);
5702
5703	ctsio->scsi_status = SCSI_STATUS_OK;
5704	ctsio->io_hdr.status = CTL_SUCCESS;
5705bailout:
5706
5707	if (ctsio->io_hdr.flags & CTL_FLAG_ALLOCATED) {
5708		free(ctsio->kern_data_ptr, M_CTL);
5709		ctsio->io_hdr.flags &= ~CTL_FLAG_ALLOCATED;
5710	}
5711
5712	ctl_done((union ctl_io *)ctsio);
5713	return (CTL_RETVAL_COMPLETE);
5714}
5715
5716int
5717ctl_read_buffer(struct ctl_scsiio *ctsio)
5718{
5719	struct scsi_read_buffer *cdb;
5720	struct ctl_lun *lun;
5721	int buffer_offset, len;
5722	static uint8_t descr[4];
5723	static uint8_t echo_descr[4] = { 0 };
5724
5725	CTL_DEBUG_PRINT(("ctl_read_buffer\n"));
5726
5727	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5728	cdb = (struct scsi_read_buffer *)ctsio->cdb;
5729
5730	if (lun->flags & CTL_LUN_PR_RESERVED) {
5731		uint32_t residx;
5732
5733		/*
5734		 * XXX KDM need a lock here.
5735		 */
5736		residx = ctl_get_resindex(&ctsio->io_hdr.nexus);
5737		if ((lun->res_type == SPR_TYPE_EX_AC
5738		  && residx != lun->pr_res_idx)
5739		 || ((lun->res_type == SPR_TYPE_EX_AC_RO
5740		   || lun->res_type == SPR_TYPE_EX_AC_AR)
5741		  && !lun->per_res[residx].registered)) {
5742			ctl_set_reservation_conflict(ctsio);
5743			ctl_done((union ctl_io *)ctsio);
5744			return (CTL_RETVAL_COMPLETE);
5745	        }
5746	}
5747
5748	if ((cdb->byte2 & RWB_MODE) != RWB_MODE_DATA &&
5749	    (cdb->byte2 & RWB_MODE) != RWB_MODE_ECHO_DESCR &&
5750	    (cdb->byte2 & RWB_MODE) != RWB_MODE_DESCR) {
5751		ctl_set_invalid_field(ctsio,
5752				      /*sks_valid*/ 1,
5753				      /*command*/ 1,
5754				      /*field*/ 1,
5755				      /*bit_valid*/ 1,
5756				      /*bit*/ 4);
5757		ctl_done((union ctl_io *)ctsio);
5758		return (CTL_RETVAL_COMPLETE);
5759	}
5760	if (cdb->buffer_id != 0) {
5761		ctl_set_invalid_field(ctsio,
5762				      /*sks_valid*/ 1,
5763				      /*command*/ 1,
5764				      /*field*/ 2,
5765				      /*bit_valid*/ 0,
5766				      /*bit*/ 0);
5767		ctl_done((union ctl_io *)ctsio);
5768		return (CTL_RETVAL_COMPLETE);
5769	}
5770
5771	len = scsi_3btoul(cdb->length);
5772	buffer_offset = scsi_3btoul(cdb->offset);
5773
5774	if (buffer_offset + len > sizeof(lun->write_buffer)) {
5775		ctl_set_invalid_field(ctsio,
5776				      /*sks_valid*/ 1,
5777				      /*command*/ 1,
5778				      /*field*/ 6,
5779				      /*bit_valid*/ 0,
5780				      /*bit*/ 0);
5781		ctl_done((union ctl_io *)ctsio);
5782		return (CTL_RETVAL_COMPLETE);
5783	}
5784
5785	if ((cdb->byte2 & RWB_MODE) == RWB_MODE_DESCR) {
5786		descr[0] = 0;
5787		scsi_ulto3b(sizeof(lun->write_buffer), &descr[1]);
5788		ctsio->kern_data_ptr = descr;
5789		len = min(len, sizeof(descr));
5790	} else if ((cdb->byte2 & RWB_MODE) == RWB_MODE_ECHO_DESCR) {
5791		ctsio->kern_data_ptr = echo_descr;
5792		len = min(len, sizeof(echo_descr));
5793	} else
5794		ctsio->kern_data_ptr = lun->write_buffer + buffer_offset;
5795	ctsio->kern_data_len = len;
5796	ctsio->kern_total_len = len;
5797	ctsio->kern_data_resid = 0;
5798	ctsio->kern_rel_offset = 0;
5799	ctsio->kern_sg_entries = 0;
5800	ctsio->be_move_done = ctl_config_move_done;
5801	ctl_datamove((union ctl_io *)ctsio);
5802
5803	return (CTL_RETVAL_COMPLETE);
5804}
5805
5806int
5807ctl_write_buffer(struct ctl_scsiio *ctsio)
5808{
5809	struct scsi_write_buffer *cdb;
5810	struct ctl_lun *lun;
5811	int buffer_offset, len;
5812
5813	CTL_DEBUG_PRINT(("ctl_write_buffer\n"));
5814
5815	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5816	cdb = (struct scsi_write_buffer *)ctsio->cdb;
5817
5818	if ((cdb->byte2 & RWB_MODE) != RWB_MODE_DATA) {
5819		ctl_set_invalid_field(ctsio,
5820				      /*sks_valid*/ 1,
5821				      /*command*/ 1,
5822				      /*field*/ 1,
5823				      /*bit_valid*/ 1,
5824				      /*bit*/ 4);
5825		ctl_done((union ctl_io *)ctsio);
5826		return (CTL_RETVAL_COMPLETE);
5827	}
5828	if (cdb->buffer_id != 0) {
5829		ctl_set_invalid_field(ctsio,
5830				      /*sks_valid*/ 1,
5831				      /*command*/ 1,
5832				      /*field*/ 2,
5833				      /*bit_valid*/ 0,
5834				      /*bit*/ 0);
5835		ctl_done((union ctl_io *)ctsio);
5836		return (CTL_RETVAL_COMPLETE);
5837	}
5838
5839	len = scsi_3btoul(cdb->length);
5840	buffer_offset = scsi_3btoul(cdb->offset);
5841
5842	if (buffer_offset + len > sizeof(lun->write_buffer)) {
5843		ctl_set_invalid_field(ctsio,
5844				      /*sks_valid*/ 1,
5845				      /*command*/ 1,
5846				      /*field*/ 6,
5847				      /*bit_valid*/ 0,
5848				      /*bit*/ 0);
5849		ctl_done((union ctl_io *)ctsio);
5850		return (CTL_RETVAL_COMPLETE);
5851	}
5852
5853	/*
5854	 * If we've got a kernel request that hasn't been malloced yet,
5855	 * malloc it and tell the caller the data buffer is here.
5856	 */
5857	if ((ctsio->io_hdr.flags & CTL_FLAG_ALLOCATED) == 0) {
5858		ctsio->kern_data_ptr = lun->write_buffer + buffer_offset;
5859		ctsio->kern_data_len = len;
5860		ctsio->kern_total_len = len;
5861		ctsio->kern_data_resid = 0;
5862		ctsio->kern_rel_offset = 0;
5863		ctsio->kern_sg_entries = 0;
5864		ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
5865		ctsio->be_move_done = ctl_config_move_done;
5866		ctl_datamove((union ctl_io *)ctsio);
5867
5868		return (CTL_RETVAL_COMPLETE);
5869	}
5870
5871	ctl_done((union ctl_io *)ctsio);
5872
5873	return (CTL_RETVAL_COMPLETE);
5874}
5875
5876int
5877ctl_write_same(struct ctl_scsiio *ctsio)
5878{
5879	struct ctl_lun *lun;
5880	struct ctl_lba_len_flags *lbalen;
5881	uint64_t lba;
5882	uint32_t num_blocks;
5883	int len, retval;
5884	uint8_t byte2;
5885
5886	retval = CTL_RETVAL_COMPLETE;
5887
5888	CTL_DEBUG_PRINT(("ctl_write_same\n"));
5889
5890	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5891
5892	switch (ctsio->cdb[0]) {
5893	case WRITE_SAME_10: {
5894		struct scsi_write_same_10 *cdb;
5895
5896		cdb = (struct scsi_write_same_10 *)ctsio->cdb;
5897
5898		lba = scsi_4btoul(cdb->addr);
5899		num_blocks = scsi_2btoul(cdb->length);
5900		byte2 = cdb->byte2;
5901		break;
5902	}
5903	case WRITE_SAME_16: {
5904		struct scsi_write_same_16 *cdb;
5905
5906		cdb = (struct scsi_write_same_16 *)ctsio->cdb;
5907
5908		lba = scsi_8btou64(cdb->addr);
5909		num_blocks = scsi_4btoul(cdb->length);
5910		byte2 = cdb->byte2;
5911		break;
5912	}
5913	default:
5914		/*
5915		 * We got a command we don't support.  This shouldn't
5916		 * happen, commands should be filtered out above us.
5917		 */
5918		ctl_set_invalid_opcode(ctsio);
5919		ctl_done((union ctl_io *)ctsio);
5920
5921		return (CTL_RETVAL_COMPLETE);
5922		break; /* NOTREACHED */
5923	}
5924
5925	/*
5926	 * The first check is to make sure we're in bounds, the second
5927	 * check is to catch wrap-around problems.  If the lba + num blocks
5928	 * is less than the lba, then we've wrapped around and the block
5929	 * range is invalid anyway.
5930	 */
5931	if (((lba + num_blocks) > (lun->be_lun->maxlba + 1))
5932	 || ((lba + num_blocks) < lba)) {
5933		ctl_set_lba_out_of_range(ctsio);
5934		ctl_done((union ctl_io *)ctsio);
5935		return (CTL_RETVAL_COMPLETE);
5936	}
5937
5938	/* Zero number of blocks means "to the last logical block" */
5939	if (num_blocks == 0) {
5940		if ((lun->be_lun->maxlba + 1) - lba > UINT32_MAX) {
5941			ctl_set_invalid_field(ctsio,
5942					      /*sks_valid*/ 0,
5943					      /*command*/ 1,
5944					      /*field*/ 0,
5945					      /*bit_valid*/ 0,
5946					      /*bit*/ 0);
5947			ctl_done((union ctl_io *)ctsio);
5948			return (CTL_RETVAL_COMPLETE);
5949		}
5950		num_blocks = (lun->be_lun->maxlba + 1) - lba;
5951	}
5952
5953	len = lun->be_lun->blocksize;
5954
5955	/*
5956	 * If we've got a kernel request that hasn't been malloced yet,
5957	 * malloc it and tell the caller the data buffer is here.
5958	 */
5959	if ((ctsio->io_hdr.flags & CTL_FLAG_ALLOCATED) == 0) {
5960		ctsio->kern_data_ptr = malloc(len, M_CTL, M_WAITOK);;
5961		ctsio->kern_data_len = len;
5962		ctsio->kern_total_len = len;
5963		ctsio->kern_data_resid = 0;
5964		ctsio->kern_rel_offset = 0;
5965		ctsio->kern_sg_entries = 0;
5966		ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
5967		ctsio->be_move_done = ctl_config_move_done;
5968		ctl_datamove((union ctl_io *)ctsio);
5969
5970		return (CTL_RETVAL_COMPLETE);
5971	}
5972
5973	lbalen = (struct ctl_lba_len_flags *)&ctsio->io_hdr.ctl_private[CTL_PRIV_LBA_LEN];
5974	lbalen->lba = lba;
5975	lbalen->len = num_blocks;
5976	lbalen->flags = byte2;
5977	retval = lun->backend->config_write((union ctl_io *)ctsio);
5978
5979	return (retval);
5980}
5981
5982int
5983ctl_unmap(struct ctl_scsiio *ctsio)
5984{
5985	struct ctl_lun *lun;
5986	struct scsi_unmap *cdb;
5987	struct ctl_ptr_len_flags *ptrlen;
5988	struct scsi_unmap_header *hdr;
5989	struct scsi_unmap_desc *buf, *end;
5990	uint64_t lba;
5991	uint32_t num_blocks;
5992	int len, retval;
5993	uint8_t byte2;
5994
5995	retval = CTL_RETVAL_COMPLETE;
5996
5997	CTL_DEBUG_PRINT(("ctl_unmap\n"));
5998
5999	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
6000	cdb = (struct scsi_unmap *)ctsio->cdb;
6001
6002	len = scsi_2btoul(cdb->length);
6003	byte2 = cdb->byte2;
6004
6005	/*
6006	 * If we've got a kernel request that hasn't been malloced yet,
6007	 * malloc it and tell the caller the data buffer is here.
6008	 */
6009	if ((ctsio->io_hdr.flags & CTL_FLAG_ALLOCATED) == 0) {
6010		ctsio->kern_data_ptr = malloc(len, M_CTL, M_WAITOK);;
6011		ctsio->kern_data_len = len;
6012		ctsio->kern_total_len = len;
6013		ctsio->kern_data_resid = 0;
6014		ctsio->kern_rel_offset = 0;
6015		ctsio->kern_sg_entries = 0;
6016		ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
6017		ctsio->be_move_done = ctl_config_move_done;
6018		ctl_datamove((union ctl_io *)ctsio);
6019
6020		return (CTL_RETVAL_COMPLETE);
6021	}
6022
6023	len = ctsio->kern_total_len - ctsio->kern_data_resid;
6024	hdr = (struct scsi_unmap_header *)ctsio->kern_data_ptr;
6025	if (len < sizeof (*hdr) ||
6026	    len < (scsi_2btoul(hdr->length) + sizeof(hdr->length)) ||
6027	    len < (scsi_2btoul(hdr->desc_length) + sizeof (*hdr)) ||
6028	    scsi_2btoul(hdr->desc_length) % sizeof(*buf) != 0) {
6029		ctl_set_invalid_field(ctsio,
6030				      /*sks_valid*/ 0,
6031				      /*command*/ 0,
6032				      /*field*/ 0,
6033				      /*bit_valid*/ 0,
6034				      /*bit*/ 0);
6035		ctl_done((union ctl_io *)ctsio);
6036		return (CTL_RETVAL_COMPLETE);
6037	}
6038	len = scsi_2btoul(hdr->desc_length);
6039	buf = (struct scsi_unmap_desc *)(hdr + 1);
6040	end = buf + len / sizeof(*buf);
6041
6042	ptrlen = (struct ctl_ptr_len_flags *)&ctsio->io_hdr.ctl_private[CTL_PRIV_LBA_LEN];
6043	ptrlen->ptr = (void *)buf;
6044	ptrlen->len = len;
6045	ptrlen->flags = byte2;
6046
6047	for (; buf < end; buf++) {
6048		lba = scsi_8btou64(buf->lba);
6049		num_blocks = scsi_4btoul(buf->length);
6050		if (((lba + num_blocks) > (lun->be_lun->maxlba + 1))
6051		 || ((lba + num_blocks) < lba)) {
6052			ctl_set_lba_out_of_range(ctsio);
6053			ctl_done((union ctl_io *)ctsio);
6054			return (CTL_RETVAL_COMPLETE);
6055		}
6056	}
6057
6058	retval = lun->backend->config_write((union ctl_io *)ctsio);
6059
6060	return (retval);
6061}
6062
6063/*
6064 * Note that this function currently doesn't actually do anything inside
6065 * CTL to enforce things if the DQue bit is turned on.
6066 *
6067 * Also note that this function can't be used in the default case, because
6068 * the DQue bit isn't set in the changeable mask for the control mode page
6069 * anyway.  This is just here as an example for how to implement a page
6070 * handler, and a placeholder in case we want to allow the user to turn
6071 * tagged queueing on and off.
6072 *
6073 * The D_SENSE bit handling is functional, however, and will turn
6074 * descriptor sense on and off for a given LUN.
6075 */
6076int
6077ctl_control_page_handler(struct ctl_scsiio *ctsio,
6078			 struct ctl_page_index *page_index, uint8_t *page_ptr)
6079{
6080	struct scsi_control_page *current_cp, *saved_cp, *user_cp;
6081	struct ctl_lun *lun;
6082	struct ctl_softc *softc;
6083	int set_ua;
6084	uint32_t initidx;
6085
6086	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
6087	initidx = ctl_get_initindex(&ctsio->io_hdr.nexus);
6088	set_ua = 0;
6089
6090	user_cp = (struct scsi_control_page *)page_ptr;
6091	current_cp = (struct scsi_control_page *)
6092		(page_index->page_data + (page_index->page_len *
6093		CTL_PAGE_CURRENT));
6094	saved_cp = (struct scsi_control_page *)
6095		(page_index->page_data + (page_index->page_len *
6096		CTL_PAGE_SAVED));
6097
6098	softc = control_softc;
6099
6100	mtx_lock(&softc->ctl_lock);
6101	if (((current_cp->rlec & SCP_DSENSE) == 0)
6102	 && ((user_cp->rlec & SCP_DSENSE) != 0)) {
6103		/*
6104		 * Descriptor sense is currently turned off and the user
6105		 * wants to turn it on.
6106		 */
6107		current_cp->rlec |= SCP_DSENSE;
6108		saved_cp->rlec |= SCP_DSENSE;
6109		lun->flags |= CTL_LUN_SENSE_DESC;
6110		set_ua = 1;
6111	} else if (((current_cp->rlec & SCP_DSENSE) != 0)
6112		&& ((user_cp->rlec & SCP_DSENSE) == 0)) {
6113		/*
6114		 * Descriptor sense is currently turned on, and the user
6115		 * wants to turn it off.
6116		 */
6117		current_cp->rlec &= ~SCP_DSENSE;
6118		saved_cp->rlec &= ~SCP_DSENSE;
6119		lun->flags &= ~CTL_LUN_SENSE_DESC;
6120		set_ua = 1;
6121	}
6122	if (current_cp->queue_flags & SCP_QUEUE_DQUE) {
6123		if (user_cp->queue_flags & SCP_QUEUE_DQUE) {
6124#ifdef NEEDTOPORT
6125			csevent_log(CSC_CTL | CSC_SHELF_SW |
6126				    CTL_UNTAG_TO_UNTAG,
6127				    csevent_LogType_Trace,
6128				    csevent_Severity_Information,
6129				    csevent_AlertLevel_Green,
6130				    csevent_FRU_Firmware,
6131				    csevent_FRU_Unknown,
6132				    "Received untagged to untagged transition");
6133#endif /* NEEDTOPORT */
6134		} else {
6135#ifdef NEEDTOPORT
6136			csevent_log(CSC_CTL | CSC_SHELF_SW |
6137				    CTL_UNTAG_TO_TAG,
6138				    csevent_LogType_ConfigChange,
6139				    csevent_Severity_Information,
6140				    csevent_AlertLevel_Green,
6141				    csevent_FRU_Firmware,
6142				    csevent_FRU_Unknown,
6143				    "Received untagged to tagged "
6144				    "queueing transition");
6145#endif /* NEEDTOPORT */
6146
6147			current_cp->queue_flags &= ~SCP_QUEUE_DQUE;
6148			saved_cp->queue_flags &= ~SCP_QUEUE_DQUE;
6149			set_ua = 1;
6150		}
6151	} else {
6152		if (user_cp->queue_flags & SCP_QUEUE_DQUE) {
6153#ifdef NEEDTOPORT
6154			csevent_log(CSC_CTL | CSC_SHELF_SW |
6155				    CTL_TAG_TO_UNTAG,
6156				    csevent_LogType_ConfigChange,
6157				    csevent_Severity_Warning,
6158				    csevent_AlertLevel_Yellow,
6159				    csevent_FRU_Firmware,
6160				    csevent_FRU_Unknown,
6161				    "Received tagged queueing to untagged "
6162				    "transition");
6163#endif /* NEEDTOPORT */
6164
6165			current_cp->queue_flags |= SCP_QUEUE_DQUE;
6166			saved_cp->queue_flags |= SCP_QUEUE_DQUE;
6167			set_ua = 1;
6168		} else {
6169#ifdef NEEDTOPORT
6170			csevent_log(CSC_CTL | CSC_SHELF_SW |
6171				    CTL_TAG_TO_TAG,
6172				    csevent_LogType_Trace,
6173				    csevent_Severity_Information,
6174				    csevent_AlertLevel_Green,
6175				    csevent_FRU_Firmware,
6176				    csevent_FRU_Unknown,
6177				    "Received tagged queueing to tagged "
6178				    "queueing transition");
6179#endif /* NEEDTOPORT */
6180		}
6181	}
6182	if (set_ua != 0) {
6183		int i;
6184		/*
6185		 * Let other initiators know that the mode
6186		 * parameters for this LUN have changed.
6187		 */
6188		for (i = 0; i < CTL_MAX_INITIATORS; i++) {
6189			if (i == initidx)
6190				continue;
6191
6192			lun->pending_sense[i].ua_pending |=
6193				CTL_UA_MODE_CHANGE;
6194		}
6195	}
6196	mtx_unlock(&softc->ctl_lock);
6197
6198	return (0);
6199}
6200
6201int
6202ctl_power_sp_handler(struct ctl_scsiio *ctsio,
6203		     struct ctl_page_index *page_index, uint8_t *page_ptr)
6204{
6205	return (0);
6206}
6207
6208int
6209ctl_power_sp_sense_handler(struct ctl_scsiio *ctsio,
6210			   struct ctl_page_index *page_index, int pc)
6211{
6212	struct copan_power_subpage *page;
6213
6214	page = (struct copan_power_subpage *)page_index->page_data +
6215		(page_index->page_len * pc);
6216
6217	switch (pc) {
6218	case SMS_PAGE_CTRL_CHANGEABLE >> 6:
6219		/*
6220		 * We don't update the changable bits for this page.
6221		 */
6222		break;
6223	case SMS_PAGE_CTRL_CURRENT >> 6:
6224	case SMS_PAGE_CTRL_DEFAULT >> 6:
6225	case SMS_PAGE_CTRL_SAVED >> 6:
6226#ifdef NEEDTOPORT
6227		ctl_update_power_subpage(page);
6228#endif
6229		break;
6230	default:
6231#ifdef NEEDTOPORT
6232		EPRINT(0, "Invalid PC %d!!", pc);
6233#endif
6234		break;
6235	}
6236	return (0);
6237}
6238
6239
6240int
6241ctl_aps_sp_handler(struct ctl_scsiio *ctsio,
6242		   struct ctl_page_index *page_index, uint8_t *page_ptr)
6243{
6244	struct copan_aps_subpage *user_sp;
6245	struct copan_aps_subpage *current_sp;
6246	union ctl_modepage_info *modepage_info;
6247	struct ctl_softc *softc;
6248	struct ctl_lun *lun;
6249	int retval;
6250
6251	retval = CTL_RETVAL_COMPLETE;
6252	current_sp = (struct copan_aps_subpage *)(page_index->page_data +
6253		     (page_index->page_len * CTL_PAGE_CURRENT));
6254	softc = control_softc;
6255	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
6256
6257	user_sp = (struct copan_aps_subpage *)page_ptr;
6258
6259	modepage_info = (union ctl_modepage_info *)
6260		ctsio->io_hdr.ctl_private[CTL_PRIV_MODEPAGE].bytes;
6261
6262	modepage_info->header.page_code = page_index->page_code & SMPH_PC_MASK;
6263	modepage_info->header.subpage = page_index->subpage;
6264	modepage_info->aps.lock_active = user_sp->lock_active;
6265
6266	mtx_lock(&softc->ctl_lock);
6267
6268	/*
6269	 * If there is a request to lock the LUN and another LUN is locked
6270	 * this is an error. If the requested LUN is already locked ignore
6271	 * the request. If no LUN is locked attempt to lock it.
6272	 * if there is a request to unlock the LUN and the LUN is currently
6273	 * locked attempt to unlock it. Otherwise ignore the request. i.e.
6274	 * if another LUN is locked or no LUN is locked.
6275	 */
6276	if (user_sp->lock_active & APS_LOCK_ACTIVE) {
6277		if (softc->aps_locked_lun == lun->lun) {
6278			/*
6279			 * This LUN is already locked, so we're done.
6280			 */
6281			retval = CTL_RETVAL_COMPLETE;
6282		} else if (softc->aps_locked_lun == 0) {
6283			/*
6284			 * No one has the lock, pass the request to the
6285			 * backend.
6286			 */
6287			retval = lun->backend->config_write(
6288				(union ctl_io *)ctsio);
6289		} else {
6290			/*
6291			 * Someone else has the lock, throw out the request.
6292			 */
6293			ctl_set_already_locked(ctsio);
6294			free(ctsio->kern_data_ptr, M_CTL);
6295			ctl_done((union ctl_io *)ctsio);
6296
6297			/*
6298			 * Set the return value so that ctl_do_mode_select()
6299			 * won't try to complete the command.  We already
6300			 * completed it here.
6301			 */
6302			retval = CTL_RETVAL_ERROR;
6303		}
6304	} else if (softc->aps_locked_lun == lun->lun) {
6305		/*
6306		 * This LUN is locked, so pass the unlock request to the
6307		 * backend.
6308		 */
6309		retval = lun->backend->config_write((union ctl_io *)ctsio);
6310	}
6311	mtx_unlock(&softc->ctl_lock);
6312
6313	return (retval);
6314}
6315
6316int
6317ctl_debugconf_sp_select_handler(struct ctl_scsiio *ctsio,
6318				struct ctl_page_index *page_index,
6319				uint8_t *page_ptr)
6320{
6321	uint8_t *c;
6322	int i;
6323
6324	c = ((struct copan_debugconf_subpage *)page_ptr)->ctl_time_io_secs;
6325	ctl_time_io_secs =
6326		(c[0] << 8) |
6327		(c[1] << 0) |
6328		0;
6329	CTL_DEBUG_PRINT(("set ctl_time_io_secs to %d\n", ctl_time_io_secs));
6330	printf("set ctl_time_io_secs to %d\n", ctl_time_io_secs);
6331	printf("page data:");
6332	for (i=0; i<8; i++)
6333		printf(" %.2x",page_ptr[i]);
6334	printf("\n");
6335	return (0);
6336}
6337
6338int
6339ctl_debugconf_sp_sense_handler(struct ctl_scsiio *ctsio,
6340			       struct ctl_page_index *page_index,
6341			       int pc)
6342{
6343	struct copan_debugconf_subpage *page;
6344
6345	page = (struct copan_debugconf_subpage *)page_index->page_data +
6346		(page_index->page_len * pc);
6347
6348	switch (pc) {
6349	case SMS_PAGE_CTRL_CHANGEABLE >> 6:
6350	case SMS_PAGE_CTRL_DEFAULT >> 6:
6351	case SMS_PAGE_CTRL_SAVED >> 6:
6352		/*
6353		 * We don't update the changable or default bits for this page.
6354		 */
6355		break;
6356	case SMS_PAGE_CTRL_CURRENT >> 6:
6357		page->ctl_time_io_secs[0] = ctl_time_io_secs >> 8;
6358		page->ctl_time_io_secs[1] = ctl_time_io_secs >> 0;
6359		break;
6360	default:
6361#ifdef NEEDTOPORT
6362		EPRINT(0, "Invalid PC %d!!", pc);
6363#endif /* NEEDTOPORT */
6364		break;
6365	}
6366	return (0);
6367}
6368
6369
6370static int
6371ctl_do_mode_select(union ctl_io *io)
6372{
6373	struct scsi_mode_page_header *page_header;
6374	struct ctl_page_index *page_index;
6375	struct ctl_scsiio *ctsio;
6376	int control_dev, page_len;
6377	int page_len_offset, page_len_size;
6378	union ctl_modepage_info *modepage_info;
6379	struct ctl_lun *lun;
6380	int *len_left, *len_used;
6381	int retval, i;
6382
6383	ctsio = &io->scsiio;
6384	page_index = NULL;
6385	page_len = 0;
6386	retval = CTL_RETVAL_COMPLETE;
6387
6388	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
6389
6390	if (lun->be_lun->lun_type != T_DIRECT)
6391		control_dev = 1;
6392	else
6393		control_dev = 0;
6394
6395	modepage_info = (union ctl_modepage_info *)
6396		ctsio->io_hdr.ctl_private[CTL_PRIV_MODEPAGE].bytes;
6397	len_left = &modepage_info->header.len_left;
6398	len_used = &modepage_info->header.len_used;
6399
6400do_next_page:
6401
6402	page_header = (struct scsi_mode_page_header *)
6403		(ctsio->kern_data_ptr + *len_used);
6404
6405	if (*len_left == 0) {
6406		free(ctsio->kern_data_ptr, M_CTL);
6407		ctl_set_success(ctsio);
6408		ctl_done((union ctl_io *)ctsio);
6409		return (CTL_RETVAL_COMPLETE);
6410	} else if (*len_left < sizeof(struct scsi_mode_page_header)) {
6411
6412		free(ctsio->kern_data_ptr, M_CTL);
6413		ctl_set_param_len_error(ctsio);
6414		ctl_done((union ctl_io *)ctsio);
6415		return (CTL_RETVAL_COMPLETE);
6416
6417	} else if ((page_header->page_code & SMPH_SPF)
6418		&& (*len_left < sizeof(struct scsi_mode_page_header_sp))) {
6419
6420		free(ctsio->kern_data_ptr, M_CTL);
6421		ctl_set_param_len_error(ctsio);
6422		ctl_done((union ctl_io *)ctsio);
6423		return (CTL_RETVAL_COMPLETE);
6424	}
6425
6426
6427	/*
6428	 * XXX KDM should we do something with the block descriptor?
6429	 */
6430	for (i = 0; i < CTL_NUM_MODE_PAGES; i++) {
6431
6432		if ((control_dev != 0)
6433		 && (lun->mode_pages.index[i].page_flags &
6434		     CTL_PAGE_FLAG_DISK_ONLY))
6435			continue;
6436
6437		if ((lun->mode_pages.index[i].page_code & SMPH_PC_MASK) !=
6438		    (page_header->page_code & SMPH_PC_MASK))
6439			continue;
6440
6441		/*
6442		 * If neither page has a subpage code, then we've got a
6443		 * match.
6444		 */
6445		if (((lun->mode_pages.index[i].page_code & SMPH_SPF) == 0)
6446		 && ((page_header->page_code & SMPH_SPF) == 0)) {
6447			page_index = &lun->mode_pages.index[i];
6448			page_len = page_header->page_length;
6449			break;
6450		}
6451
6452		/*
6453		 * If both pages have subpages, then the subpage numbers
6454		 * have to match.
6455		 */
6456		if ((lun->mode_pages.index[i].page_code & SMPH_SPF)
6457		  && (page_header->page_code & SMPH_SPF)) {
6458			struct scsi_mode_page_header_sp *sph;
6459
6460			sph = (struct scsi_mode_page_header_sp *)page_header;
6461
6462			if (lun->mode_pages.index[i].subpage ==
6463			    sph->subpage) {
6464				page_index = &lun->mode_pages.index[i];
6465				page_len = scsi_2btoul(sph->page_length);
6466				break;
6467			}
6468		}
6469	}
6470
6471	/*
6472	 * If we couldn't find the page, or if we don't have a mode select
6473	 * handler for it, send back an error to the user.
6474	 */
6475	if ((page_index == NULL)
6476	 || (page_index->select_handler == NULL)) {
6477		ctl_set_invalid_field(ctsio,
6478				      /*sks_valid*/ 1,
6479				      /*command*/ 0,
6480				      /*field*/ *len_used,
6481				      /*bit_valid*/ 0,
6482				      /*bit*/ 0);
6483		free(ctsio->kern_data_ptr, M_CTL);
6484		ctl_done((union ctl_io *)ctsio);
6485		return (CTL_RETVAL_COMPLETE);
6486	}
6487
6488	if (page_index->page_code & SMPH_SPF) {
6489		page_len_offset = 2;
6490		page_len_size = 2;
6491	} else {
6492		page_len_size = 1;
6493		page_len_offset = 1;
6494	}
6495
6496	/*
6497	 * If the length the initiator gives us isn't the one we specify in
6498	 * the mode page header, or if they didn't specify enough data in
6499	 * the CDB to avoid truncating this page, kick out the request.
6500	 */
6501	if ((page_len != (page_index->page_len - page_len_offset -
6502			  page_len_size))
6503	 || (*len_left < page_index->page_len)) {
6504
6505
6506		ctl_set_invalid_field(ctsio,
6507				      /*sks_valid*/ 1,
6508				      /*command*/ 0,
6509				      /*field*/ *len_used + page_len_offset,
6510				      /*bit_valid*/ 0,
6511				      /*bit*/ 0);
6512		free(ctsio->kern_data_ptr, M_CTL);
6513		ctl_done((union ctl_io *)ctsio);
6514		return (CTL_RETVAL_COMPLETE);
6515	}
6516
6517	/*
6518	 * Run through the mode page, checking to make sure that the bits
6519	 * the user changed are actually legal for him to change.
6520	 */
6521	for (i = 0; i < page_index->page_len; i++) {
6522		uint8_t *user_byte, *change_mask, *current_byte;
6523		int bad_bit;
6524		int j;
6525
6526		user_byte = (uint8_t *)page_header + i;
6527		change_mask = page_index->page_data +
6528			      (page_index->page_len * CTL_PAGE_CHANGEABLE) + i;
6529		current_byte = page_index->page_data +
6530			       (page_index->page_len * CTL_PAGE_CURRENT) + i;
6531
6532		/*
6533		 * Check to see whether the user set any bits in this byte
6534		 * that he is not allowed to set.
6535		 */
6536		if ((*user_byte & ~(*change_mask)) ==
6537		    (*current_byte & ~(*change_mask)))
6538			continue;
6539
6540		/*
6541		 * Go through bit by bit to determine which one is illegal.
6542		 */
6543		bad_bit = 0;
6544		for (j = 7; j >= 0; j--) {
6545			if ((((1 << i) & ~(*change_mask)) & *user_byte) !=
6546			    (((1 << i) & ~(*change_mask)) & *current_byte)) {
6547				bad_bit = i;
6548				break;
6549			}
6550		}
6551		ctl_set_invalid_field(ctsio,
6552				      /*sks_valid*/ 1,
6553				      /*command*/ 0,
6554				      /*field*/ *len_used + i,
6555				      /*bit_valid*/ 1,
6556				      /*bit*/ bad_bit);
6557		free(ctsio->kern_data_ptr, M_CTL);
6558		ctl_done((union ctl_io *)ctsio);
6559		return (CTL_RETVAL_COMPLETE);
6560	}
6561
6562	/*
6563	 * Decrement these before we call the page handler, since we may
6564	 * end up getting called back one way or another before the handler
6565	 * returns to this context.
6566	 */
6567	*len_left -= page_index->page_len;
6568	*len_used += page_index->page_len;
6569
6570	retval = page_index->select_handler(ctsio, page_index,
6571					    (uint8_t *)page_header);
6572
6573	/*
6574	 * If the page handler returns CTL_RETVAL_QUEUED, then we need to
6575	 * wait until this queued command completes to finish processing
6576	 * the mode page.  If it returns anything other than
6577	 * CTL_RETVAL_COMPLETE (e.g. CTL_RETVAL_ERROR), then it should have
6578	 * already set the sense information, freed the data pointer, and
6579	 * completed the io for us.
6580	 */
6581	if (retval != CTL_RETVAL_COMPLETE)
6582		goto bailout_no_done;
6583
6584	/*
6585	 * If the initiator sent us more than one page, parse the next one.
6586	 */
6587	if (*len_left > 0)
6588		goto do_next_page;
6589
6590	ctl_set_success(ctsio);
6591	free(ctsio->kern_data_ptr, M_CTL);
6592	ctl_done((union ctl_io *)ctsio);
6593
6594bailout_no_done:
6595
6596	return (CTL_RETVAL_COMPLETE);
6597
6598}
6599
6600int
6601ctl_mode_select(struct ctl_scsiio *ctsio)
6602{
6603	int param_len, pf, sp;
6604	int header_size, bd_len;
6605	int len_left, len_used;
6606	struct ctl_page_index *page_index;
6607	struct ctl_lun *lun;
6608	int control_dev, page_len;
6609	union ctl_modepage_info *modepage_info;
6610	int retval;
6611
6612	pf = 0;
6613	sp = 0;
6614	page_len = 0;
6615	len_used = 0;
6616	len_left = 0;
6617	retval = 0;
6618	bd_len = 0;
6619	page_index = NULL;
6620
6621	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
6622
6623	if (lun->be_lun->lun_type != T_DIRECT)
6624		control_dev = 1;
6625	else
6626		control_dev = 0;
6627
6628	switch (ctsio->cdb[0]) {
6629	case MODE_SELECT_6: {
6630		struct scsi_mode_select_6 *cdb;
6631
6632		cdb = (struct scsi_mode_select_6 *)ctsio->cdb;
6633
6634		pf = (cdb->byte2 & SMS_PF) ? 1 : 0;
6635		sp = (cdb->byte2 & SMS_SP) ? 1 : 0;
6636
6637		param_len = cdb->length;
6638		header_size = sizeof(struct scsi_mode_header_6);
6639		break;
6640	}
6641	case MODE_SELECT_10: {
6642		struct scsi_mode_select_10 *cdb;
6643
6644		cdb = (struct scsi_mode_select_10 *)ctsio->cdb;
6645
6646		pf = (cdb->byte2 & SMS_PF) ? 1 : 0;
6647		sp = (cdb->byte2 & SMS_SP) ? 1 : 0;
6648
6649		param_len = scsi_2btoul(cdb->length);
6650		header_size = sizeof(struct scsi_mode_header_10);
6651		break;
6652	}
6653	default:
6654		ctl_set_invalid_opcode(ctsio);
6655		ctl_done((union ctl_io *)ctsio);
6656		return (CTL_RETVAL_COMPLETE);
6657		break; /* NOTREACHED */
6658	}
6659
6660	/*
6661	 * From SPC-3:
6662	 * "A parameter list length of zero indicates that the Data-Out Buffer
6663	 * shall be empty. This condition shall not be considered as an error."
6664	 */
6665	if (param_len == 0) {
6666		ctl_set_success(ctsio);
6667		ctl_done((union ctl_io *)ctsio);
6668		return (CTL_RETVAL_COMPLETE);
6669	}
6670
6671	/*
6672	 * Since we'll hit this the first time through, prior to
6673	 * allocation, we don't need to free a data buffer here.
6674	 */
6675	if (param_len < header_size) {
6676		ctl_set_param_len_error(ctsio);
6677		ctl_done((union ctl_io *)ctsio);
6678		return (CTL_RETVAL_COMPLETE);
6679	}
6680
6681	/*
6682	 * Allocate the data buffer and grab the user's data.  In theory,
6683	 * we shouldn't have to sanity check the parameter list length here
6684	 * because the maximum size is 64K.  We should be able to malloc
6685	 * that much without too many problems.
6686	 */
6687	if ((ctsio->io_hdr.flags & CTL_FLAG_ALLOCATED) == 0) {
6688		ctsio->kern_data_ptr = malloc(param_len, M_CTL, M_WAITOK);
6689		ctsio->kern_data_len = param_len;
6690		ctsio->kern_total_len = param_len;
6691		ctsio->kern_data_resid = 0;
6692		ctsio->kern_rel_offset = 0;
6693		ctsio->kern_sg_entries = 0;
6694		ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
6695		ctsio->be_move_done = ctl_config_move_done;
6696		ctl_datamove((union ctl_io *)ctsio);
6697
6698		return (CTL_RETVAL_COMPLETE);
6699	}
6700
6701	switch (ctsio->cdb[0]) {
6702	case MODE_SELECT_6: {
6703		struct scsi_mode_header_6 *mh6;
6704
6705		mh6 = (struct scsi_mode_header_6 *)ctsio->kern_data_ptr;
6706		bd_len = mh6->blk_desc_len;
6707		break;
6708	}
6709	case MODE_SELECT_10: {
6710		struct scsi_mode_header_10 *mh10;
6711
6712		mh10 = (struct scsi_mode_header_10 *)ctsio->kern_data_ptr;
6713		bd_len = scsi_2btoul(mh10->blk_desc_len);
6714		break;
6715	}
6716	default:
6717		panic("Invalid CDB type %#x", ctsio->cdb[0]);
6718		break;
6719	}
6720
6721	if (param_len < (header_size + bd_len)) {
6722		free(ctsio->kern_data_ptr, M_CTL);
6723		ctl_set_param_len_error(ctsio);
6724		ctl_done((union ctl_io *)ctsio);
6725		return (CTL_RETVAL_COMPLETE);
6726	}
6727
6728	/*
6729	 * Set the IO_CONT flag, so that if this I/O gets passed to
6730	 * ctl_config_write_done(), it'll get passed back to
6731	 * ctl_do_mode_select() for further processing, or completion if
6732	 * we're all done.
6733	 */
6734	ctsio->io_hdr.flags |= CTL_FLAG_IO_CONT;
6735	ctsio->io_cont = ctl_do_mode_select;
6736
6737	modepage_info = (union ctl_modepage_info *)
6738		ctsio->io_hdr.ctl_private[CTL_PRIV_MODEPAGE].bytes;
6739
6740	memset(modepage_info, 0, sizeof(*modepage_info));
6741
6742	len_left = param_len - header_size - bd_len;
6743	len_used = header_size + bd_len;
6744
6745	modepage_info->header.len_left = len_left;
6746	modepage_info->header.len_used = len_used;
6747
6748	return (ctl_do_mode_select((union ctl_io *)ctsio));
6749}
6750
6751int
6752ctl_mode_sense(struct ctl_scsiio *ctsio)
6753{
6754	struct ctl_lun *lun;
6755	int pc, page_code, dbd, llba, subpage;
6756	int alloc_len, page_len, header_len, total_len;
6757	struct scsi_mode_block_descr *block_desc;
6758	struct ctl_page_index *page_index;
6759	int control_dev;
6760
6761	dbd = 0;
6762	llba = 0;
6763	block_desc = NULL;
6764	page_index = NULL;
6765
6766	CTL_DEBUG_PRINT(("ctl_mode_sense\n"));
6767
6768	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
6769
6770	if (lun->be_lun->lun_type != T_DIRECT)
6771		control_dev = 1;
6772	else
6773		control_dev = 0;
6774
6775	if (lun->flags & CTL_LUN_PR_RESERVED) {
6776		uint32_t residx;
6777
6778		/*
6779		 * XXX KDM need a lock here.
6780		 */
6781		residx = ctl_get_resindex(&ctsio->io_hdr.nexus);
6782		if ((lun->res_type == SPR_TYPE_EX_AC
6783		  && residx != lun->pr_res_idx)
6784		 || ((lun->res_type == SPR_TYPE_EX_AC_RO
6785		   || lun->res_type == SPR_TYPE_EX_AC_AR)
6786		  && !lun->per_res[residx].registered)) {
6787			ctl_set_reservation_conflict(ctsio);
6788			ctl_done((union ctl_io *)ctsio);
6789			return (CTL_RETVAL_COMPLETE);
6790		}
6791	}
6792
6793	switch (ctsio->cdb[0]) {
6794	case MODE_SENSE_6: {
6795		struct scsi_mode_sense_6 *cdb;
6796
6797		cdb = (struct scsi_mode_sense_6 *)ctsio->cdb;
6798
6799		header_len = sizeof(struct scsi_mode_hdr_6);
6800		if (cdb->byte2 & SMS_DBD)
6801			dbd = 1;
6802		else
6803			header_len += sizeof(struct scsi_mode_block_descr);
6804
6805		pc = (cdb->page & SMS_PAGE_CTRL_MASK) >> 6;
6806		page_code = cdb->page & SMS_PAGE_CODE;
6807		subpage = cdb->subpage;
6808		alloc_len = cdb->length;
6809		break;
6810	}
6811	case MODE_SENSE_10: {
6812		struct scsi_mode_sense_10 *cdb;
6813
6814		cdb = (struct scsi_mode_sense_10 *)ctsio->cdb;
6815
6816		header_len = sizeof(struct scsi_mode_hdr_10);
6817
6818		if (cdb->byte2 & SMS_DBD)
6819			dbd = 1;
6820		else
6821			header_len += sizeof(struct scsi_mode_block_descr);
6822		if (cdb->byte2 & SMS10_LLBAA)
6823			llba = 1;
6824		pc = (cdb->page & SMS_PAGE_CTRL_MASK) >> 6;
6825		page_code = cdb->page & SMS_PAGE_CODE;
6826		subpage = cdb->subpage;
6827		alloc_len = scsi_2btoul(cdb->length);
6828		break;
6829	}
6830	default:
6831		ctl_set_invalid_opcode(ctsio);
6832		ctl_done((union ctl_io *)ctsio);
6833		return (CTL_RETVAL_COMPLETE);
6834		break; /* NOTREACHED */
6835	}
6836
6837	/*
6838	 * We have to make a first pass through to calculate the size of
6839	 * the pages that match the user's query.  Then we allocate enough
6840	 * memory to hold it, and actually copy the data into the buffer.
6841	 */
6842	switch (page_code) {
6843	case SMS_ALL_PAGES_PAGE: {
6844		int i;
6845
6846		page_len = 0;
6847
6848		/*
6849		 * At the moment, values other than 0 and 0xff here are
6850		 * reserved according to SPC-3.
6851		 */
6852		if ((subpage != SMS_SUBPAGE_PAGE_0)
6853		 && (subpage != SMS_SUBPAGE_ALL)) {
6854			ctl_set_invalid_field(ctsio,
6855					      /*sks_valid*/ 1,
6856					      /*command*/ 1,
6857					      /*field*/ 3,
6858					      /*bit_valid*/ 0,
6859					      /*bit*/ 0);
6860			ctl_done((union ctl_io *)ctsio);
6861			return (CTL_RETVAL_COMPLETE);
6862		}
6863
6864		for (i = 0; i < CTL_NUM_MODE_PAGES; i++) {
6865			if ((control_dev != 0)
6866			 && (lun->mode_pages.index[i].page_flags &
6867			     CTL_PAGE_FLAG_DISK_ONLY))
6868				continue;
6869
6870			/*
6871			 * We don't use this subpage if the user didn't
6872			 * request all subpages.
6873			 */
6874			if ((lun->mode_pages.index[i].subpage != 0)
6875			 && (subpage == SMS_SUBPAGE_PAGE_0))
6876				continue;
6877
6878#if 0
6879			printf("found page %#x len %d\n",
6880			       lun->mode_pages.index[i].page_code &
6881			       SMPH_PC_MASK,
6882			       lun->mode_pages.index[i].page_len);
6883#endif
6884			page_len += lun->mode_pages.index[i].page_len;
6885		}
6886		break;
6887	}
6888	default: {
6889		int i;
6890
6891		page_len = 0;
6892
6893		for (i = 0; i < CTL_NUM_MODE_PAGES; i++) {
6894			/* Look for the right page code */
6895			if ((lun->mode_pages.index[i].page_code &
6896			     SMPH_PC_MASK) != page_code)
6897				continue;
6898
6899			/* Look for the right subpage or the subpage wildcard*/
6900			if ((lun->mode_pages.index[i].subpage != subpage)
6901			 && (subpage != SMS_SUBPAGE_ALL))
6902				continue;
6903
6904			/* Make sure the page is supported for this dev type */
6905			if ((control_dev != 0)
6906			 && (lun->mode_pages.index[i].page_flags &
6907			     CTL_PAGE_FLAG_DISK_ONLY))
6908				continue;
6909
6910#if 0
6911			printf("found page %#x len %d\n",
6912			       lun->mode_pages.index[i].page_code &
6913			       SMPH_PC_MASK,
6914			       lun->mode_pages.index[i].page_len);
6915#endif
6916
6917			page_len += lun->mode_pages.index[i].page_len;
6918		}
6919
6920		if (page_len == 0) {
6921			ctl_set_invalid_field(ctsio,
6922					      /*sks_valid*/ 1,
6923					      /*command*/ 1,
6924					      /*field*/ 2,
6925					      /*bit_valid*/ 1,
6926					      /*bit*/ 5);
6927			ctl_done((union ctl_io *)ctsio);
6928			return (CTL_RETVAL_COMPLETE);
6929		}
6930		break;
6931	}
6932	}
6933
6934	total_len = header_len + page_len;
6935#if 0
6936	printf("header_len = %d, page_len = %d, total_len = %d\n",
6937	       header_len, page_len, total_len);
6938#endif
6939
6940	ctsio->kern_data_ptr = malloc(total_len, M_CTL, M_WAITOK | M_ZERO);
6941	ctsio->kern_sg_entries = 0;
6942	ctsio->kern_data_resid = 0;
6943	ctsio->kern_rel_offset = 0;
6944	if (total_len < alloc_len) {
6945		ctsio->residual = alloc_len - total_len;
6946		ctsio->kern_data_len = total_len;
6947		ctsio->kern_total_len = total_len;
6948	} else {
6949		ctsio->residual = 0;
6950		ctsio->kern_data_len = alloc_len;
6951		ctsio->kern_total_len = alloc_len;
6952	}
6953
6954	switch (ctsio->cdb[0]) {
6955	case MODE_SENSE_6: {
6956		struct scsi_mode_hdr_6 *header;
6957
6958		header = (struct scsi_mode_hdr_6 *)ctsio->kern_data_ptr;
6959
6960		header->datalen = ctl_min(total_len - 1, 254);
6961
6962		if (dbd)
6963			header->block_descr_len = 0;
6964		else
6965			header->block_descr_len =
6966				sizeof(struct scsi_mode_block_descr);
6967		block_desc = (struct scsi_mode_block_descr *)&header[1];
6968		break;
6969	}
6970	case MODE_SENSE_10: {
6971		struct scsi_mode_hdr_10 *header;
6972		int datalen;
6973
6974		header = (struct scsi_mode_hdr_10 *)ctsio->kern_data_ptr;
6975
6976		datalen = ctl_min(total_len - 2, 65533);
6977		scsi_ulto2b(datalen, header->datalen);
6978		if (dbd)
6979			scsi_ulto2b(0, header->block_descr_len);
6980		else
6981			scsi_ulto2b(sizeof(struct scsi_mode_block_descr),
6982				    header->block_descr_len);
6983		block_desc = (struct scsi_mode_block_descr *)&header[1];
6984		break;
6985	}
6986	default:
6987		panic("invalid CDB type %#x", ctsio->cdb[0]);
6988		break; /* NOTREACHED */
6989	}
6990
6991	/*
6992	 * If we've got a disk, use its blocksize in the block
6993	 * descriptor.  Otherwise, just set it to 0.
6994	 */
6995	if (dbd == 0) {
6996		if (control_dev != 0)
6997			scsi_ulto3b(lun->be_lun->blocksize,
6998				    block_desc->block_len);
6999		else
7000			scsi_ulto3b(0, block_desc->block_len);
7001	}
7002
7003	switch (page_code) {
7004	case SMS_ALL_PAGES_PAGE: {
7005		int i, data_used;
7006
7007		data_used = header_len;
7008		for (i = 0; i < CTL_NUM_MODE_PAGES; i++) {
7009			struct ctl_page_index *page_index;
7010
7011			page_index = &lun->mode_pages.index[i];
7012
7013			if ((control_dev != 0)
7014			 && (page_index->page_flags &
7015			    CTL_PAGE_FLAG_DISK_ONLY))
7016				continue;
7017
7018			/*
7019			 * We don't use this subpage if the user didn't
7020			 * request all subpages.  We already checked (above)
7021			 * to make sure the user only specified a subpage
7022			 * of 0 or 0xff in the SMS_ALL_PAGES_PAGE case.
7023			 */
7024			if ((page_index->subpage != 0)
7025			 && (subpage == SMS_SUBPAGE_PAGE_0))
7026				continue;
7027
7028			/*
7029			 * Call the handler, if it exists, to update the
7030			 * page to the latest values.
7031			 */
7032			if (page_index->sense_handler != NULL)
7033				page_index->sense_handler(ctsio, page_index,pc);
7034
7035			memcpy(ctsio->kern_data_ptr + data_used,
7036			       page_index->page_data +
7037			       (page_index->page_len * pc),
7038			       page_index->page_len);
7039			data_used += page_index->page_len;
7040		}
7041		break;
7042	}
7043	default: {
7044		int i, data_used;
7045
7046		data_used = header_len;
7047
7048		for (i = 0; i < CTL_NUM_MODE_PAGES; i++) {
7049			struct ctl_page_index *page_index;
7050
7051			page_index = &lun->mode_pages.index[i];
7052
7053			/* Look for the right page code */
7054			if ((page_index->page_code & SMPH_PC_MASK) != page_code)
7055				continue;
7056
7057			/* Look for the right subpage or the subpage wildcard*/
7058			if ((page_index->subpage != subpage)
7059			 && (subpage != SMS_SUBPAGE_ALL))
7060				continue;
7061
7062			/* Make sure the page is supported for this dev type */
7063			if ((control_dev != 0)
7064			 && (page_index->page_flags &
7065			     CTL_PAGE_FLAG_DISK_ONLY))
7066				continue;
7067
7068			/*
7069			 * Call the handler, if it exists, to update the
7070			 * page to the latest values.
7071			 */
7072			if (page_index->sense_handler != NULL)
7073				page_index->sense_handler(ctsio, page_index,pc);
7074
7075			memcpy(ctsio->kern_data_ptr + data_used,
7076			       page_index->page_data +
7077			       (page_index->page_len * pc),
7078			       page_index->page_len);
7079			data_used += page_index->page_len;
7080		}
7081		break;
7082	}
7083	}
7084
7085	ctsio->scsi_status = SCSI_STATUS_OK;
7086
7087	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
7088	ctsio->be_move_done = ctl_config_move_done;
7089	ctl_datamove((union ctl_io *)ctsio);
7090
7091	return (CTL_RETVAL_COMPLETE);
7092}
7093
7094int
7095ctl_read_capacity(struct ctl_scsiio *ctsio)
7096{
7097	struct scsi_read_capacity *cdb;
7098	struct scsi_read_capacity_data *data;
7099	struct ctl_lun *lun;
7100	uint32_t lba;
7101
7102	CTL_DEBUG_PRINT(("ctl_read_capacity\n"));
7103
7104	cdb = (struct scsi_read_capacity *)ctsio->cdb;
7105
7106	lba = scsi_4btoul(cdb->addr);
7107	if (((cdb->pmi & SRC_PMI) == 0)
7108	 && (lba != 0)) {
7109		ctl_set_invalid_field(/*ctsio*/ ctsio,
7110				      /*sks_valid*/ 1,
7111				      /*command*/ 1,
7112				      /*field*/ 2,
7113				      /*bit_valid*/ 0,
7114				      /*bit*/ 0);
7115		ctl_done((union ctl_io *)ctsio);
7116		return (CTL_RETVAL_COMPLETE);
7117	}
7118
7119	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
7120
7121	ctsio->kern_data_ptr = malloc(sizeof(*data), M_CTL, M_WAITOK | M_ZERO);
7122	data = (struct scsi_read_capacity_data *)ctsio->kern_data_ptr;
7123	ctsio->residual = 0;
7124	ctsio->kern_data_len = sizeof(*data);
7125	ctsio->kern_total_len = sizeof(*data);
7126	ctsio->kern_data_resid = 0;
7127	ctsio->kern_rel_offset = 0;
7128	ctsio->kern_sg_entries = 0;
7129
7130	/*
7131	 * If the maximum LBA is greater than 0xfffffffe, the user must
7132	 * issue a SERVICE ACTION IN (16) command, with the read capacity
7133	 * serivce action set.
7134	 */
7135	if (lun->be_lun->maxlba > 0xfffffffe)
7136		scsi_ulto4b(0xffffffff, data->addr);
7137	else
7138		scsi_ulto4b(lun->be_lun->maxlba, data->addr);
7139
7140	/*
7141	 * XXX KDM this may not be 512 bytes...
7142	 */
7143	scsi_ulto4b(lun->be_lun->blocksize, data->length);
7144
7145	ctsio->scsi_status = SCSI_STATUS_OK;
7146
7147	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
7148	ctsio->be_move_done = ctl_config_move_done;
7149	ctl_datamove((union ctl_io *)ctsio);
7150
7151	return (CTL_RETVAL_COMPLETE);
7152}
7153
7154static int
7155ctl_read_capacity_16(struct ctl_scsiio *ctsio)
7156{
7157	struct scsi_read_capacity_16 *cdb;
7158	struct scsi_read_capacity_data_long *data;
7159	struct ctl_lun *lun;
7160	uint64_t lba;
7161	uint32_t alloc_len;
7162
7163	CTL_DEBUG_PRINT(("ctl_read_capacity_16\n"));
7164
7165	cdb = (struct scsi_read_capacity_16 *)ctsio->cdb;
7166
7167	alloc_len = scsi_4btoul(cdb->alloc_len);
7168	lba = scsi_8btou64(cdb->addr);
7169
7170	if ((cdb->reladr & SRC16_PMI)
7171	 && (lba != 0)) {
7172		ctl_set_invalid_field(/*ctsio*/ ctsio,
7173				      /*sks_valid*/ 1,
7174				      /*command*/ 1,
7175				      /*field*/ 2,
7176				      /*bit_valid*/ 0,
7177				      /*bit*/ 0);
7178		ctl_done((union ctl_io *)ctsio);
7179		return (CTL_RETVAL_COMPLETE);
7180	}
7181
7182	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
7183
7184	ctsio->kern_data_ptr = malloc(sizeof(*data), M_CTL, M_WAITOK | M_ZERO);
7185	data = (struct scsi_read_capacity_data_long *)ctsio->kern_data_ptr;
7186
7187	if (sizeof(*data) < alloc_len) {
7188		ctsio->residual = alloc_len - sizeof(*data);
7189		ctsio->kern_data_len = sizeof(*data);
7190		ctsio->kern_total_len = sizeof(*data);
7191	} else {
7192		ctsio->residual = 0;
7193		ctsio->kern_data_len = alloc_len;
7194		ctsio->kern_total_len = alloc_len;
7195	}
7196	ctsio->kern_data_resid = 0;
7197	ctsio->kern_rel_offset = 0;
7198	ctsio->kern_sg_entries = 0;
7199
7200	scsi_u64to8b(lun->be_lun->maxlba, data->addr);
7201	/* XXX KDM this may not be 512 bytes... */
7202	scsi_ulto4b(lun->be_lun->blocksize, data->length);
7203	data->prot_lbppbe = lun->be_lun->pblockexp & SRC16_LBPPBE;
7204	scsi_ulto2b(lun->be_lun->pblockoff & SRC16_LALBA_A, data->lalba_lbp);
7205	if (lun->be_lun->flags & CTL_LUN_FLAG_UNMAP)
7206		data->lalba_lbp[0] |= SRC16_LBPME;
7207
7208	ctsio->scsi_status = SCSI_STATUS_OK;
7209
7210	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
7211	ctsio->be_move_done = ctl_config_move_done;
7212	ctl_datamove((union ctl_io *)ctsio);
7213
7214	return (CTL_RETVAL_COMPLETE);
7215}
7216
7217int
7218ctl_service_action_in(struct ctl_scsiio *ctsio)
7219{
7220	struct scsi_service_action_in *cdb;
7221	int retval;
7222
7223	CTL_DEBUG_PRINT(("ctl_service_action_in\n"));
7224
7225	cdb = (struct scsi_service_action_in *)ctsio->cdb;
7226
7227	retval = CTL_RETVAL_COMPLETE;
7228
7229	switch (cdb->service_action) {
7230	case SRC16_SERVICE_ACTION:
7231		retval = ctl_read_capacity_16(ctsio);
7232		break;
7233	default:
7234		ctl_set_invalid_field(/*ctsio*/ ctsio,
7235				      /*sks_valid*/ 1,
7236				      /*command*/ 1,
7237				      /*field*/ 1,
7238				      /*bit_valid*/ 1,
7239				      /*bit*/ 4);
7240		ctl_done((union ctl_io *)ctsio);
7241		break;
7242	}
7243
7244	return (retval);
7245}
7246
7247int
7248ctl_maintenance_in(struct ctl_scsiio *ctsio)
7249{
7250	struct scsi_maintenance_in *cdb;
7251	int retval;
7252	int alloc_len, total_len = 0;
7253	int num_target_port_groups, single;
7254	struct ctl_lun *lun;
7255	struct ctl_softc *softc;
7256	struct scsi_target_group_data *rtg_ptr;
7257	struct scsi_target_port_group_descriptor *tpg_desc_ptr1, *tpg_desc_ptr2;
7258	struct scsi_target_port_descriptor  *tp_desc_ptr1_1, *tp_desc_ptr1_2,
7259	                                    *tp_desc_ptr2_1, *tp_desc_ptr2_2;
7260
7261	CTL_DEBUG_PRINT(("ctl_maintenance_in\n"));
7262
7263	cdb = (struct scsi_maintenance_in *)ctsio->cdb;
7264	softc = control_softc;
7265	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
7266
7267	retval = CTL_RETVAL_COMPLETE;
7268
7269	if ((cdb->byte2 & SERVICE_ACTION_MASK) != SA_RPRT_TRGT_GRP) {
7270		ctl_set_invalid_field(/*ctsio*/ ctsio,
7271				      /*sks_valid*/ 1,
7272				      /*command*/ 1,
7273				      /*field*/ 1,
7274				      /*bit_valid*/ 1,
7275				      /*bit*/ 4);
7276		ctl_done((union ctl_io *)ctsio);
7277		return(retval);
7278	}
7279
7280	mtx_lock(&softc->ctl_lock);
7281	single = ctl_is_single;
7282	mtx_unlock(&softc->ctl_lock);
7283
7284	if (single)
7285        	num_target_port_groups = NUM_TARGET_PORT_GROUPS - 1;
7286	else
7287        	num_target_port_groups = NUM_TARGET_PORT_GROUPS;
7288
7289	total_len = sizeof(struct scsi_target_group_data) +
7290		sizeof(struct scsi_target_port_group_descriptor) *
7291		num_target_port_groups +
7292		sizeof(struct scsi_target_port_descriptor) *
7293		NUM_PORTS_PER_GRP * num_target_port_groups;
7294
7295	alloc_len = scsi_4btoul(cdb->length);
7296
7297	ctsio->kern_data_ptr = malloc(total_len, M_CTL, M_WAITOK | M_ZERO);
7298
7299	ctsio->kern_sg_entries = 0;
7300
7301	if (total_len < alloc_len) {
7302		ctsio->residual = alloc_len - total_len;
7303		ctsio->kern_data_len = total_len;
7304		ctsio->kern_total_len = total_len;
7305	} else {
7306		ctsio->residual = 0;
7307		ctsio->kern_data_len = alloc_len;
7308		ctsio->kern_total_len = alloc_len;
7309	}
7310	ctsio->kern_data_resid = 0;
7311	ctsio->kern_rel_offset = 0;
7312
7313	rtg_ptr = (struct scsi_target_group_data *)ctsio->kern_data_ptr;
7314
7315	tpg_desc_ptr1 = &rtg_ptr->groups[0];
7316	tp_desc_ptr1_1 = &tpg_desc_ptr1->descriptors[0];
7317	tp_desc_ptr1_2 = (struct scsi_target_port_descriptor *)
7318	        &tp_desc_ptr1_1->desc_list[0];
7319
7320	if (single == 0) {
7321		tpg_desc_ptr2 = (struct scsi_target_port_group_descriptor *)
7322	                &tp_desc_ptr1_2->desc_list[0];
7323		tp_desc_ptr2_1 = &tpg_desc_ptr2->descriptors[0];
7324		tp_desc_ptr2_2 = (struct scsi_target_port_descriptor *)
7325	        	&tp_desc_ptr2_1->desc_list[0];
7326        } else {
7327		tpg_desc_ptr2 = NULL;
7328		tp_desc_ptr2_1 = NULL;
7329		tp_desc_ptr2_2 = NULL;
7330	}
7331
7332	scsi_ulto4b(total_len - 4, rtg_ptr->length);
7333	if (single == 0) {
7334        	if (ctsio->io_hdr.nexus.targ_port < CTL_MAX_PORTS) {
7335			if (lun->flags & CTL_LUN_PRIMARY_SC) {
7336				tpg_desc_ptr1->pref_state = TPG_PRIMARY;
7337				tpg_desc_ptr2->pref_state =
7338					TPG_ASYMMETRIC_ACCESS_NONOPTIMIZED;
7339			} else {
7340				tpg_desc_ptr1->pref_state =
7341					TPG_ASYMMETRIC_ACCESS_NONOPTIMIZED;
7342				tpg_desc_ptr2->pref_state = TPG_PRIMARY;
7343			}
7344		} else {
7345			if (lun->flags & CTL_LUN_PRIMARY_SC) {
7346				tpg_desc_ptr1->pref_state =
7347					TPG_ASYMMETRIC_ACCESS_NONOPTIMIZED;
7348				tpg_desc_ptr2->pref_state = TPG_PRIMARY;
7349			} else {
7350				tpg_desc_ptr1->pref_state = TPG_PRIMARY;
7351				tpg_desc_ptr2->pref_state =
7352					TPG_ASYMMETRIC_ACCESS_NONOPTIMIZED;
7353			}
7354		}
7355	} else {
7356		tpg_desc_ptr1->pref_state = TPG_PRIMARY;
7357	}
7358	tpg_desc_ptr1->support = 0;
7359	tpg_desc_ptr1->target_port_group[1] = 1;
7360	tpg_desc_ptr1->status = TPG_IMPLICIT;
7361	tpg_desc_ptr1->target_port_count= NUM_PORTS_PER_GRP;
7362
7363	if (single == 0) {
7364		tpg_desc_ptr2->support = 0;
7365		tpg_desc_ptr2->target_port_group[1] = 2;
7366		tpg_desc_ptr2->status = TPG_IMPLICIT;
7367		tpg_desc_ptr2->target_port_count = NUM_PORTS_PER_GRP;
7368
7369		tp_desc_ptr1_1->relative_target_port_identifier[1] = 1;
7370		tp_desc_ptr1_2->relative_target_port_identifier[1] = 2;
7371
7372		tp_desc_ptr2_1->relative_target_port_identifier[1] = 9;
7373		tp_desc_ptr2_2->relative_target_port_identifier[1] = 10;
7374	} else {
7375        	if (ctsio->io_hdr.nexus.targ_port < CTL_MAX_PORTS) {
7376			tp_desc_ptr1_1->relative_target_port_identifier[1] = 1;
7377			tp_desc_ptr1_2->relative_target_port_identifier[1] = 2;
7378		} else {
7379			tp_desc_ptr1_1->relative_target_port_identifier[1] = 9;
7380			tp_desc_ptr1_2->relative_target_port_identifier[1] = 10;
7381		}
7382	}
7383
7384	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
7385	ctsio->be_move_done = ctl_config_move_done;
7386
7387	CTL_DEBUG_PRINT(("buf = %x %x %x %x %x %x %x %x\n",
7388			 ctsio->kern_data_ptr[0], ctsio->kern_data_ptr[1],
7389			 ctsio->kern_data_ptr[2], ctsio->kern_data_ptr[3],
7390			 ctsio->kern_data_ptr[4], ctsio->kern_data_ptr[5],
7391			 ctsio->kern_data_ptr[6], ctsio->kern_data_ptr[7]));
7392
7393	ctl_datamove((union ctl_io *)ctsio);
7394	return(retval);
7395}
7396
7397int
7398ctl_persistent_reserve_in(struct ctl_scsiio *ctsio)
7399{
7400	struct scsi_per_res_in *cdb;
7401	int alloc_len, total_len = 0;
7402	/* struct scsi_per_res_in_rsrv in_data; */
7403	struct ctl_lun *lun;
7404	struct ctl_softc *softc;
7405
7406	CTL_DEBUG_PRINT(("ctl_persistent_reserve_in\n"));
7407
7408	softc = control_softc;
7409
7410	cdb = (struct scsi_per_res_in *)ctsio->cdb;
7411
7412	alloc_len = scsi_2btoul(cdb->length);
7413
7414	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
7415
7416retry:
7417	mtx_lock(&softc->ctl_lock);
7418	switch (cdb->action) {
7419	case SPRI_RK: /* read keys */
7420		total_len = sizeof(struct scsi_per_res_in_keys) +
7421			lun->pr_key_count *
7422			sizeof(struct scsi_per_res_key);
7423		break;
7424	case SPRI_RR: /* read reservation */
7425		if (lun->flags & CTL_LUN_PR_RESERVED)
7426			total_len = sizeof(struct scsi_per_res_in_rsrv);
7427		else
7428			total_len = sizeof(struct scsi_per_res_in_header);
7429		break;
7430	case SPRI_RC: /* report capabilities */
7431		total_len = sizeof(struct scsi_per_res_cap);
7432		break;
7433	case SPRI_RS: /* read full status */
7434	default:
7435		mtx_unlock(&softc->ctl_lock);
7436		ctl_set_invalid_field(ctsio,
7437				      /*sks_valid*/ 1,
7438				      /*command*/ 1,
7439				      /*field*/ 1,
7440				      /*bit_valid*/ 1,
7441				      /*bit*/ 0);
7442		ctl_done((union ctl_io *)ctsio);
7443		return (CTL_RETVAL_COMPLETE);
7444		break; /* NOTREACHED */
7445	}
7446	mtx_unlock(&softc->ctl_lock);
7447
7448	ctsio->kern_data_ptr = malloc(total_len, M_CTL, M_WAITOK | M_ZERO);
7449
7450	if (total_len < alloc_len) {
7451		ctsio->residual = alloc_len - total_len;
7452		ctsio->kern_data_len = total_len;
7453		ctsio->kern_total_len = total_len;
7454	} else {
7455		ctsio->residual = 0;
7456		ctsio->kern_data_len = alloc_len;
7457		ctsio->kern_total_len = alloc_len;
7458	}
7459
7460	ctsio->kern_data_resid = 0;
7461	ctsio->kern_rel_offset = 0;
7462	ctsio->kern_sg_entries = 0;
7463
7464	mtx_lock(&softc->ctl_lock);
7465	switch (cdb->action) {
7466	case SPRI_RK: { // read keys
7467        struct scsi_per_res_in_keys *res_keys;
7468		int i, key_count;
7469
7470		res_keys = (struct scsi_per_res_in_keys*)ctsio->kern_data_ptr;
7471
7472		/*
7473		 * We had to drop the lock to allocate our buffer, which
7474		 * leaves time for someone to come in with another
7475		 * persistent reservation.  (That is unlikely, though,
7476		 * since this should be the only persistent reservation
7477		 * command active right now.)
7478		 */
7479		if (total_len != (sizeof(struct scsi_per_res_in_keys) +
7480		    (lun->pr_key_count *
7481		     sizeof(struct scsi_per_res_key)))){
7482			mtx_unlock(&softc->ctl_lock);
7483			free(ctsio->kern_data_ptr, M_CTL);
7484			printf("%s: reservation length changed, retrying\n",
7485			       __func__);
7486			goto retry;
7487		}
7488
7489		scsi_ulto4b(lun->PRGeneration, res_keys->header.generation);
7490
7491		scsi_ulto4b(sizeof(struct scsi_per_res_key) *
7492			     lun->pr_key_count, res_keys->header.length);
7493
7494		for (i = 0, key_count = 0; i < 2*CTL_MAX_INITIATORS; i++) {
7495			if (!lun->per_res[i].registered)
7496				continue;
7497
7498			/*
7499			 * We used lun->pr_key_count to calculate the
7500			 * size to allocate.  If it turns out the number of
7501			 * initiators with the registered flag set is
7502			 * larger than that (i.e. they haven't been kept in
7503			 * sync), we've got a problem.
7504			 */
7505			if (key_count >= lun->pr_key_count) {
7506#ifdef NEEDTOPORT
7507				csevent_log(CSC_CTL | CSC_SHELF_SW |
7508					    CTL_PR_ERROR,
7509					    csevent_LogType_Fault,
7510					    csevent_AlertLevel_Yellow,
7511					    csevent_FRU_ShelfController,
7512					    csevent_FRU_Firmware,
7513				        csevent_FRU_Unknown,
7514					    "registered keys %d >= key "
7515					    "count %d", key_count,
7516					    lun->pr_key_count);
7517#endif
7518				key_count++;
7519				continue;
7520			}
7521			memcpy(res_keys->keys[key_count].key,
7522			       lun->per_res[i].res_key.key,
7523			       ctl_min(sizeof(res_keys->keys[key_count].key),
7524			       sizeof(lun->per_res[i].res_key)));
7525			key_count++;
7526		}
7527		break;
7528	}
7529	case SPRI_RR: { // read reservation
7530		struct scsi_per_res_in_rsrv *res;
7531		int tmp_len, header_only;
7532
7533		res = (struct scsi_per_res_in_rsrv *)ctsio->kern_data_ptr;
7534
7535		scsi_ulto4b(lun->PRGeneration, res->header.generation);
7536
7537		if (lun->flags & CTL_LUN_PR_RESERVED)
7538		{
7539			tmp_len = sizeof(struct scsi_per_res_in_rsrv);
7540			scsi_ulto4b(sizeof(struct scsi_per_res_in_rsrv_data),
7541				    res->header.length);
7542			header_only = 0;
7543		} else {
7544			tmp_len = sizeof(struct scsi_per_res_in_header);
7545			scsi_ulto4b(0, res->header.length);
7546			header_only = 1;
7547		}
7548
7549		/*
7550		 * We had to drop the lock to allocate our buffer, which
7551		 * leaves time for someone to come in with another
7552		 * persistent reservation.  (That is unlikely, though,
7553		 * since this should be the only persistent reservation
7554		 * command active right now.)
7555		 */
7556		if (tmp_len != total_len) {
7557			mtx_unlock(&softc->ctl_lock);
7558			free(ctsio->kern_data_ptr, M_CTL);
7559			printf("%s: reservation status changed, retrying\n",
7560			       __func__);
7561			goto retry;
7562		}
7563
7564		/*
7565		 * No reservation held, so we're done.
7566		 */
7567		if (header_only != 0)
7568			break;
7569
7570		/*
7571		 * If the registration is an All Registrants type, the key
7572		 * is 0, since it doesn't really matter.
7573		 */
7574		if (lun->pr_res_idx != CTL_PR_ALL_REGISTRANTS) {
7575			memcpy(res->data.reservation,
7576			       &lun->per_res[lun->pr_res_idx].res_key,
7577			       sizeof(struct scsi_per_res_key));
7578		}
7579		res->data.scopetype = lun->res_type;
7580		break;
7581	}
7582	case SPRI_RC:     //report capabilities
7583	{
7584		struct scsi_per_res_cap *res_cap;
7585		uint16_t type_mask;
7586
7587		res_cap = (struct scsi_per_res_cap *)ctsio->kern_data_ptr;
7588		scsi_ulto2b(sizeof(*res_cap), res_cap->length);
7589		res_cap->flags2 |= SPRI_TMV | SPRI_ALLOW_3;
7590		type_mask = SPRI_TM_WR_EX_AR |
7591			    SPRI_TM_EX_AC_RO |
7592			    SPRI_TM_WR_EX_RO |
7593			    SPRI_TM_EX_AC |
7594			    SPRI_TM_WR_EX |
7595			    SPRI_TM_EX_AC_AR;
7596		scsi_ulto2b(type_mask, res_cap->type_mask);
7597		break;
7598	}
7599	case SPRI_RS: //read full status
7600	default:
7601		/*
7602		 * This is a bug, because we just checked for this above,
7603		 * and should have returned an error.
7604		 */
7605		panic("Invalid PR type %x", cdb->action);
7606		break; /* NOTREACHED */
7607	}
7608	mtx_unlock(&softc->ctl_lock);
7609
7610	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
7611	ctsio->be_move_done = ctl_config_move_done;
7612
7613	CTL_DEBUG_PRINT(("buf = %x %x %x %x %x %x %x %x\n",
7614			 ctsio->kern_data_ptr[0], ctsio->kern_data_ptr[1],
7615			 ctsio->kern_data_ptr[2], ctsio->kern_data_ptr[3],
7616			 ctsio->kern_data_ptr[4], ctsio->kern_data_ptr[5],
7617			 ctsio->kern_data_ptr[6], ctsio->kern_data_ptr[7]));
7618
7619	ctl_datamove((union ctl_io *)ctsio);
7620
7621	return (CTL_RETVAL_COMPLETE);
7622}
7623
7624/*
7625 * Returns 0 if ctl_persistent_reserve_out() should continue, non-zero if
7626 * it should return.
7627 */
7628static int
7629ctl_pro_preempt(struct ctl_softc *softc, struct ctl_lun *lun, uint64_t res_key,
7630		uint64_t sa_res_key, uint8_t type, uint32_t residx,
7631		struct ctl_scsiio *ctsio, struct scsi_per_res_out *cdb,
7632		struct scsi_per_res_out_parms* param)
7633{
7634	union ctl_ha_msg persis_io;
7635	int retval, i;
7636	int isc_retval;
7637
7638	retval = 0;
7639
7640	if (sa_res_key == 0) {
7641		mtx_lock(&softc->ctl_lock);
7642		if (lun->pr_res_idx == CTL_PR_ALL_REGISTRANTS) {
7643			/* validate scope and type */
7644			if ((cdb->scope_type & SPR_SCOPE_MASK) !=
7645			     SPR_LU_SCOPE) {
7646				mtx_unlock(&softc->ctl_lock);
7647				ctl_set_invalid_field(/*ctsio*/ ctsio,
7648						      /*sks_valid*/ 1,
7649						      /*command*/ 1,
7650						      /*field*/ 2,
7651						      /*bit_valid*/ 1,
7652						      /*bit*/ 4);
7653				ctl_done((union ctl_io *)ctsio);
7654				return (1);
7655			}
7656
7657		        if (type>8 || type==2 || type==4 || type==0) {
7658				mtx_unlock(&softc->ctl_lock);
7659				ctl_set_invalid_field(/*ctsio*/ ctsio,
7660       	           				      /*sks_valid*/ 1,
7661						      /*command*/ 1,
7662						      /*field*/ 2,
7663						      /*bit_valid*/ 1,
7664						      /*bit*/ 0);
7665				ctl_done((union ctl_io *)ctsio);
7666				return (1);
7667		        }
7668
7669			/* temporarily unregister this nexus */
7670			lun->per_res[residx].registered = 0;
7671
7672			/*
7673			 * Unregister everybody else and build UA for
7674			 * them
7675			 */
7676			for(i=0; i < 2*CTL_MAX_INITIATORS; i++) {
7677				if (lun->per_res[i].registered == 0)
7678					continue;
7679
7680				if (!persis_offset
7681				 && i <CTL_MAX_INITIATORS)
7682					lun->pending_sense[i].ua_pending |=
7683						CTL_UA_REG_PREEMPT;
7684				else if (persis_offset
7685				      && i >= persis_offset)
7686					lun->pending_sense[i-persis_offset
7687						].ua_pending |=
7688						CTL_UA_REG_PREEMPT;
7689				lun->per_res[i].registered = 0;
7690				memset(&lun->per_res[i].res_key, 0,
7691				       sizeof(struct scsi_per_res_key));
7692			}
7693			lun->per_res[residx].registered = 1;
7694			lun->pr_key_count = 1;
7695			lun->res_type = type;
7696			if (lun->res_type != SPR_TYPE_WR_EX_AR
7697			 && lun->res_type != SPR_TYPE_EX_AC_AR)
7698				lun->pr_res_idx = residx;
7699
7700			mtx_unlock(&softc->ctl_lock);
7701			/* send msg to other side */
7702			persis_io.hdr.nexus = ctsio->io_hdr.nexus;
7703			persis_io.hdr.msg_type = CTL_MSG_PERS_ACTION;
7704			persis_io.pr.pr_info.action = CTL_PR_PREEMPT;
7705			persis_io.pr.pr_info.residx = lun->pr_res_idx;
7706			persis_io.pr.pr_info.res_type = type;
7707			memcpy(persis_io.pr.pr_info.sa_res_key,
7708			       param->serv_act_res_key,
7709			       sizeof(param->serv_act_res_key));
7710			if ((isc_retval=ctl_ha_msg_send(CTL_HA_CHAN_CTL,
7711			     &persis_io, sizeof(persis_io), 0)) >
7712			     CTL_HA_STATUS_SUCCESS) {
7713				printf("CTL:Persis Out error returned "
7714				       "from ctl_ha_msg_send %d\n",
7715				       isc_retval);
7716			}
7717		} else {
7718			/* not all registrants */
7719			mtx_unlock(&softc->ctl_lock);
7720			free(ctsio->kern_data_ptr, M_CTL);
7721			ctl_set_invalid_field(ctsio,
7722					      /*sks_valid*/ 1,
7723					      /*command*/ 0,
7724					      /*field*/ 8,
7725					      /*bit_valid*/ 0,
7726					      /*bit*/ 0);
7727			ctl_done((union ctl_io *)ctsio);
7728			return (1);
7729		}
7730	} else if (lun->pr_res_idx == CTL_PR_ALL_REGISTRANTS
7731		|| !(lun->flags & CTL_LUN_PR_RESERVED)) {
7732		int found = 0;
7733
7734		mtx_lock(&softc->ctl_lock);
7735		if (res_key == sa_res_key) {
7736			/* special case */
7737			/*
7738			 * The spec implies this is not good but doesn't
7739			 * say what to do. There are two choices either
7740			 * generate a res conflict or check condition
7741			 * with illegal field in parameter data. Since
7742			 * that is what is done when the sa_res_key is
7743			 * zero I'll take that approach since this has
7744			 * to do with the sa_res_key.
7745			 */
7746			mtx_unlock(&softc->ctl_lock);
7747			free(ctsio->kern_data_ptr, M_CTL);
7748			ctl_set_invalid_field(ctsio,
7749					      /*sks_valid*/ 1,
7750					      /*command*/ 0,
7751					      /*field*/ 8,
7752					      /*bit_valid*/ 0,
7753					      /*bit*/ 0);
7754			ctl_done((union ctl_io *)ctsio);
7755			return (1);
7756		}
7757
7758		for (i=0; i < 2*CTL_MAX_INITIATORS; i++) {
7759			if (lun->per_res[i].registered
7760			 && memcmp(param->serv_act_res_key,
7761			    lun->per_res[i].res_key.key,
7762			    sizeof(struct scsi_per_res_key)) != 0)
7763				continue;
7764
7765			found = 1;
7766			lun->per_res[i].registered = 0;
7767			memset(&lun->per_res[i].res_key, 0,
7768			       sizeof(struct scsi_per_res_key));
7769			lun->pr_key_count--;
7770
7771			if (!persis_offset
7772			 && i < CTL_MAX_INITIATORS)
7773				lun->pending_sense[i].ua_pending |=
7774					CTL_UA_REG_PREEMPT;
7775			else if (persis_offset
7776			      && i >= persis_offset)
7777				lun->pending_sense[i-persis_offset].ua_pending|=
7778					CTL_UA_REG_PREEMPT;
7779		}
7780		mtx_unlock(&softc->ctl_lock);
7781		if (!found) {
7782			free(ctsio->kern_data_ptr, M_CTL);
7783			ctl_set_reservation_conflict(ctsio);
7784			ctl_done((union ctl_io *)ctsio);
7785			return (CTL_RETVAL_COMPLETE);
7786		}
7787		/* send msg to other side */
7788		persis_io.hdr.nexus = ctsio->io_hdr.nexus;
7789		persis_io.hdr.msg_type = CTL_MSG_PERS_ACTION;
7790		persis_io.pr.pr_info.action = CTL_PR_PREEMPT;
7791		persis_io.pr.pr_info.residx = lun->pr_res_idx;
7792		persis_io.pr.pr_info.res_type = type;
7793		memcpy(persis_io.pr.pr_info.sa_res_key,
7794		       param->serv_act_res_key,
7795		       sizeof(param->serv_act_res_key));
7796		if ((isc_retval=ctl_ha_msg_send(CTL_HA_CHAN_CTL,
7797		     &persis_io, sizeof(persis_io), 0)) >
7798		     CTL_HA_STATUS_SUCCESS) {
7799			printf("CTL:Persis Out error returned from "
7800			       "ctl_ha_msg_send %d\n", isc_retval);
7801		}
7802	} else {
7803		/* Reserved but not all registrants */
7804		/* sa_res_key is res holder */
7805		if (memcmp(param->serv_act_res_key,
7806                   lun->per_res[lun->pr_res_idx].res_key.key,
7807                   sizeof(struct scsi_per_res_key)) == 0) {
7808			/* validate scope and type */
7809			if ((cdb->scope_type & SPR_SCOPE_MASK) !=
7810			     SPR_LU_SCOPE) {
7811				ctl_set_invalid_field(/*ctsio*/ ctsio,
7812						      /*sks_valid*/ 1,
7813						      /*command*/ 1,
7814						      /*field*/ 2,
7815						      /*bit_valid*/ 1,
7816						      /*bit*/ 4);
7817				ctl_done((union ctl_io *)ctsio);
7818				return (1);
7819			}
7820
7821			if (type>8 || type==2 || type==4 || type==0) {
7822				ctl_set_invalid_field(/*ctsio*/ ctsio,
7823						      /*sks_valid*/ 1,
7824						      /*command*/ 1,
7825						      /*field*/ 2,
7826						      /*bit_valid*/ 1,
7827						      /*bit*/ 0);
7828				ctl_done((union ctl_io *)ctsio);
7829				return (1);
7830			}
7831
7832			/*
7833			 * Do the following:
7834			 * if sa_res_key != res_key remove all
7835			 * registrants w/sa_res_key and generate UA
7836			 * for these registrants(Registrations
7837			 * Preempted) if it wasn't an exclusive
7838			 * reservation generate UA(Reservations
7839			 * Preempted) for all other registered nexuses
7840			 * if the type has changed. Establish the new
7841			 * reservation and holder. If res_key and
7842			 * sa_res_key are the same do the above
7843			 * except don't unregister the res holder.
7844			 */
7845
7846			/*
7847			 * Temporarily unregister so it won't get
7848			 * removed or UA generated
7849			 */
7850			lun->per_res[residx].registered = 0;
7851			for(i=0; i < 2*CTL_MAX_INITIATORS; i++) {
7852				if (lun->per_res[i].registered == 0)
7853					continue;
7854
7855				if (memcmp(param->serv_act_res_key,
7856				    lun->per_res[i].res_key.key,
7857				    sizeof(struct scsi_per_res_key)) == 0) {
7858					lun->per_res[i].registered = 0;
7859					memset(&lun->per_res[i].res_key,
7860					       0,
7861					       sizeof(struct scsi_per_res_key));
7862					lun->pr_key_count--;
7863
7864					if (!persis_offset
7865					 && i < CTL_MAX_INITIATORS)
7866						lun->pending_sense[i
7867							].ua_pending |=
7868							CTL_UA_REG_PREEMPT;
7869					else if (persis_offset
7870					      && i >= persis_offset)
7871						lun->pending_sense[
7872						  i-persis_offset].ua_pending |=
7873						  CTL_UA_REG_PREEMPT;
7874				} else if (type != lun->res_type
7875					&& (lun->res_type == SPR_TYPE_WR_EX_RO
7876					 || lun->res_type ==SPR_TYPE_EX_AC_RO)){
7877						if (!persis_offset
7878						 && i < CTL_MAX_INITIATORS)
7879							lun->pending_sense[i
7880							].ua_pending |=
7881							CTL_UA_RES_RELEASE;
7882						else if (persis_offset
7883						      && i >= persis_offset)
7884							lun->pending_sense[
7885							i-persis_offset
7886							].ua_pending |=
7887							CTL_UA_RES_RELEASE;
7888				}
7889			}
7890			lun->per_res[residx].registered = 1;
7891			lun->res_type = type;
7892			if (lun->res_type != SPR_TYPE_WR_EX_AR
7893			 && lun->res_type != SPR_TYPE_EX_AC_AR)
7894				lun->pr_res_idx = residx;
7895			else
7896				lun->pr_res_idx =
7897					CTL_PR_ALL_REGISTRANTS;
7898
7899			persis_io.hdr.nexus = ctsio->io_hdr.nexus;
7900			persis_io.hdr.msg_type = CTL_MSG_PERS_ACTION;
7901			persis_io.pr.pr_info.action = CTL_PR_PREEMPT;
7902			persis_io.pr.pr_info.residx = lun->pr_res_idx;
7903			persis_io.pr.pr_info.res_type = type;
7904			memcpy(persis_io.pr.pr_info.sa_res_key,
7905			       param->serv_act_res_key,
7906			       sizeof(param->serv_act_res_key));
7907			if ((isc_retval=ctl_ha_msg_send(CTL_HA_CHAN_CTL,
7908			     &persis_io, sizeof(persis_io), 0)) >
7909			     CTL_HA_STATUS_SUCCESS) {
7910				printf("CTL:Persis Out error returned "
7911				       "from ctl_ha_msg_send %d\n",
7912				       isc_retval);
7913			}
7914		} else {
7915			/*
7916			 * sa_res_key is not the res holder just
7917			 * remove registrants
7918			 */
7919			int found=0;
7920			mtx_lock(&softc->ctl_lock);
7921
7922			for (i=0; i < 2*CTL_MAX_INITIATORS; i++) {
7923				if (memcmp(param->serv_act_res_key,
7924				    lun->per_res[i].res_key.key,
7925				    sizeof(struct scsi_per_res_key)) != 0)
7926					continue;
7927
7928				found = 1;
7929				lun->per_res[i].registered = 0;
7930				memset(&lun->per_res[i].res_key, 0,
7931				       sizeof(struct scsi_per_res_key));
7932				lun->pr_key_count--;
7933
7934				if (!persis_offset
7935				 && i < CTL_MAX_INITIATORS)
7936					lun->pending_sense[i].ua_pending |=
7937						CTL_UA_REG_PREEMPT;
7938				else if (persis_offset
7939				      && i >= persis_offset)
7940					lun->pending_sense[
7941						i-persis_offset].ua_pending |=
7942						CTL_UA_REG_PREEMPT;
7943			}
7944
7945			if (!found) {
7946				mtx_unlock(&softc->ctl_lock);
7947				free(ctsio->kern_data_ptr, M_CTL);
7948				ctl_set_reservation_conflict(ctsio);
7949				ctl_done((union ctl_io *)ctsio);
7950		        	return (1);
7951			}
7952			mtx_unlock(&softc->ctl_lock);
7953			persis_io.hdr.nexus = ctsio->io_hdr.nexus;
7954			persis_io.hdr.msg_type = CTL_MSG_PERS_ACTION;
7955			persis_io.pr.pr_info.action = CTL_PR_PREEMPT;
7956			persis_io.pr.pr_info.residx = lun->pr_res_idx;
7957			persis_io.pr.pr_info.res_type = type;
7958			memcpy(persis_io.pr.pr_info.sa_res_key,
7959			       param->serv_act_res_key,
7960			       sizeof(param->serv_act_res_key));
7961			if ((isc_retval=ctl_ha_msg_send(CTL_HA_CHAN_CTL,
7962			     &persis_io, sizeof(persis_io), 0)) >
7963			     CTL_HA_STATUS_SUCCESS) {
7964				printf("CTL:Persis Out error returned "
7965				       "from ctl_ha_msg_send %d\n",
7966				isc_retval);
7967			}
7968		}
7969	}
7970
7971	lun->PRGeneration++;
7972
7973	return (retval);
7974}
7975
7976static void
7977ctl_pro_preempt_other(struct ctl_lun *lun, union ctl_ha_msg *msg)
7978{
7979	int i;
7980
7981	if (lun->pr_res_idx == CTL_PR_ALL_REGISTRANTS
7982	 || lun->pr_res_idx == CTL_PR_NO_RESERVATION
7983	 || memcmp(&lun->per_res[lun->pr_res_idx].res_key,
7984		   msg->pr.pr_info.sa_res_key,
7985		   sizeof(struct scsi_per_res_key)) != 0) {
7986		uint64_t sa_res_key;
7987		sa_res_key = scsi_8btou64(msg->pr.pr_info.sa_res_key);
7988
7989		if (sa_res_key == 0) {
7990			/* temporarily unregister this nexus */
7991			lun->per_res[msg->pr.pr_info.residx].registered = 0;
7992
7993			/*
7994			 * Unregister everybody else and build UA for
7995			 * them
7996			 */
7997			for(i=0; i < 2*CTL_MAX_INITIATORS; i++) {
7998				if (lun->per_res[i].registered == 0)
7999					continue;
8000
8001				if (!persis_offset
8002				 && i < CTL_MAX_INITIATORS)
8003					lun->pending_sense[i].ua_pending |=
8004						CTL_UA_REG_PREEMPT;
8005				else if (persis_offset && i >= persis_offset)
8006					lun->pending_sense[i -
8007						persis_offset].ua_pending |=
8008						CTL_UA_REG_PREEMPT;
8009				lun->per_res[i].registered = 0;
8010				memset(&lun->per_res[i].res_key, 0,
8011				       sizeof(struct scsi_per_res_key));
8012			}
8013
8014			lun->per_res[msg->pr.pr_info.residx].registered = 1;
8015			lun->pr_key_count = 1;
8016			lun->res_type = msg->pr.pr_info.res_type;
8017			if (lun->res_type != SPR_TYPE_WR_EX_AR
8018			 && lun->res_type != SPR_TYPE_EX_AC_AR)
8019				lun->pr_res_idx = msg->pr.pr_info.residx;
8020		} else {
8021		        for (i=0; i < 2*CTL_MAX_INITIATORS; i++) {
8022				if (memcmp(msg->pr.pr_info.sa_res_key,
8023		                   lun->per_res[i].res_key.key,
8024		                   sizeof(struct scsi_per_res_key)) != 0)
8025					continue;
8026
8027				lun->per_res[i].registered = 0;
8028				memset(&lun->per_res[i].res_key, 0,
8029				       sizeof(struct scsi_per_res_key));
8030				lun->pr_key_count--;
8031
8032				if (!persis_offset
8033				 && i < persis_offset)
8034					lun->pending_sense[i].ua_pending |=
8035						CTL_UA_REG_PREEMPT;
8036				else if (persis_offset
8037				      && i >= persis_offset)
8038					lun->pending_sense[i -
8039						persis_offset].ua_pending |=
8040						CTL_UA_REG_PREEMPT;
8041			}
8042		}
8043	} else {
8044		/*
8045		 * Temporarily unregister so it won't get removed
8046		 * or UA generated
8047		 */
8048		lun->per_res[msg->pr.pr_info.residx].registered = 0;
8049		for (i=0; i < 2*CTL_MAX_INITIATORS; i++) {
8050			if (lun->per_res[i].registered == 0)
8051				continue;
8052
8053			if (memcmp(msg->pr.pr_info.sa_res_key,
8054	                   lun->per_res[i].res_key.key,
8055	                   sizeof(struct scsi_per_res_key)) == 0) {
8056				lun->per_res[i].registered = 0;
8057				memset(&lun->per_res[i].res_key, 0,
8058				       sizeof(struct scsi_per_res_key));
8059				lun->pr_key_count--;
8060				if (!persis_offset
8061				 && i < CTL_MAX_INITIATORS)
8062					lun->pending_sense[i].ua_pending |=
8063						CTL_UA_REG_PREEMPT;
8064				else if (persis_offset
8065				      && i >= persis_offset)
8066					lun->pending_sense[i -
8067						persis_offset].ua_pending |=
8068						CTL_UA_REG_PREEMPT;
8069			} else if (msg->pr.pr_info.res_type != lun->res_type
8070				&& (lun->res_type == SPR_TYPE_WR_EX_RO
8071				 || lun->res_type == SPR_TYPE_EX_AC_RO)) {
8072					if (!persis_offset
8073					 && i < persis_offset)
8074						lun->pending_sense[i
8075							].ua_pending |=
8076							CTL_UA_RES_RELEASE;
8077					else if (persis_offset
8078					      && i >= persis_offset)
8079					lun->pending_sense[i -
8080						persis_offset].ua_pending |=
8081						CTL_UA_RES_RELEASE;
8082			}
8083		}
8084		lun->per_res[msg->pr.pr_info.residx].registered = 1;
8085		lun->res_type = msg->pr.pr_info.res_type;
8086		if (lun->res_type != SPR_TYPE_WR_EX_AR
8087		 && lun->res_type != SPR_TYPE_EX_AC_AR)
8088			lun->pr_res_idx = msg->pr.pr_info.residx;
8089		else
8090			lun->pr_res_idx = CTL_PR_ALL_REGISTRANTS;
8091	}
8092	lun->PRGeneration++;
8093
8094}
8095
8096
8097int
8098ctl_persistent_reserve_out(struct ctl_scsiio *ctsio)
8099{
8100	int retval;
8101	int isc_retval;
8102	u_int32_t param_len;
8103	struct scsi_per_res_out *cdb;
8104	struct ctl_lun *lun;
8105	struct scsi_per_res_out_parms* param;
8106	struct ctl_softc *softc;
8107	uint32_t residx;
8108	uint64_t res_key, sa_res_key;
8109	uint8_t type;
8110	union ctl_ha_msg persis_io;
8111	int    i;
8112
8113	CTL_DEBUG_PRINT(("ctl_persistent_reserve_out\n"));
8114
8115	retval = CTL_RETVAL_COMPLETE;
8116
8117	softc = control_softc;
8118
8119	cdb = (struct scsi_per_res_out *)ctsio->cdb;
8120	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
8121
8122	/*
8123	 * We only support whole-LUN scope.  The scope & type are ignored for
8124	 * register, register and ignore existing key and clear.
8125	 * We sometimes ignore scope and type on preempts too!!
8126	 * Verify reservation type here as well.
8127	 */
8128	type = cdb->scope_type & SPR_TYPE_MASK;
8129	if ((cdb->action == SPRO_RESERVE)
8130	 || (cdb->action == SPRO_RELEASE)) {
8131		if ((cdb->scope_type & SPR_SCOPE_MASK) != SPR_LU_SCOPE) {
8132			ctl_set_invalid_field(/*ctsio*/ ctsio,
8133					      /*sks_valid*/ 1,
8134					      /*command*/ 1,
8135					      /*field*/ 2,
8136					      /*bit_valid*/ 1,
8137					      /*bit*/ 4);
8138			ctl_done((union ctl_io *)ctsio);
8139			return (CTL_RETVAL_COMPLETE);
8140		}
8141
8142		if (type>8 || type==2 || type==4 || type==0) {
8143			ctl_set_invalid_field(/*ctsio*/ ctsio,
8144					      /*sks_valid*/ 1,
8145					      /*command*/ 1,
8146					      /*field*/ 2,
8147					      /*bit_valid*/ 1,
8148					      /*bit*/ 0);
8149			ctl_done((union ctl_io *)ctsio);
8150			return (CTL_RETVAL_COMPLETE);
8151		}
8152	}
8153
8154	switch (cdb->action & SPRO_ACTION_MASK) {
8155	case SPRO_REGISTER:
8156	case SPRO_RESERVE:
8157	case SPRO_RELEASE:
8158	case SPRO_CLEAR:
8159	case SPRO_PREEMPT:
8160	case SPRO_REG_IGNO:
8161		break;
8162	case SPRO_REG_MOVE:
8163	case SPRO_PRE_ABO:
8164	default:
8165		ctl_set_invalid_field(/*ctsio*/ ctsio,
8166				      /*sks_valid*/ 1,
8167				      /*command*/ 1,
8168				      /*field*/ 1,
8169				      /*bit_valid*/ 1,
8170				      /*bit*/ 0);
8171		ctl_done((union ctl_io *)ctsio);
8172		return (CTL_RETVAL_COMPLETE);
8173		break; /* NOTREACHED */
8174	}
8175
8176	param_len = scsi_4btoul(cdb->length);
8177
8178	if ((ctsio->io_hdr.flags & CTL_FLAG_ALLOCATED) == 0) {
8179		ctsio->kern_data_ptr = malloc(param_len, M_CTL, M_WAITOK);
8180		ctsio->kern_data_len = param_len;
8181		ctsio->kern_total_len = param_len;
8182		ctsio->kern_data_resid = 0;
8183		ctsio->kern_rel_offset = 0;
8184		ctsio->kern_sg_entries = 0;
8185		ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
8186		ctsio->be_move_done = ctl_config_move_done;
8187		ctl_datamove((union ctl_io *)ctsio);
8188
8189		return (CTL_RETVAL_COMPLETE);
8190	}
8191
8192	param = (struct scsi_per_res_out_parms *)ctsio->kern_data_ptr;
8193
8194	residx = ctl_get_resindex(&ctsio->io_hdr.nexus);
8195	res_key = scsi_8btou64(param->res_key.key);
8196	sa_res_key = scsi_8btou64(param->serv_act_res_key);
8197
8198	/*
8199	 * Validate the reservation key here except for SPRO_REG_IGNO
8200	 * This must be done for all other service actions
8201	 */
8202	if ((cdb->action & SPRO_ACTION_MASK) != SPRO_REG_IGNO) {
8203		mtx_lock(&softc->ctl_lock);
8204		if (lun->per_res[residx].registered) {
8205		    if (memcmp(param->res_key.key,
8206			       lun->per_res[residx].res_key.key,
8207			       ctl_min(sizeof(param->res_key),
8208			       sizeof(lun->per_res[residx].res_key))) != 0) {
8209				/*
8210				 * The current key passed in doesn't match
8211				 * the one the initiator previously
8212				 * registered.
8213				 */
8214				mtx_unlock(&softc->ctl_lock);
8215				free(ctsio->kern_data_ptr, M_CTL);
8216				ctl_set_reservation_conflict(ctsio);
8217				ctl_done((union ctl_io *)ctsio);
8218				return (CTL_RETVAL_COMPLETE);
8219			}
8220		} else if ((cdb->action & SPRO_ACTION_MASK) != SPRO_REGISTER) {
8221			/*
8222			 * We are not registered
8223			 */
8224			mtx_unlock(&softc->ctl_lock);
8225			free(ctsio->kern_data_ptr, M_CTL);
8226			ctl_set_reservation_conflict(ctsio);
8227			ctl_done((union ctl_io *)ctsio);
8228			return (CTL_RETVAL_COMPLETE);
8229		} else if (res_key != 0) {
8230			/*
8231			 * We are not registered and trying to register but
8232			 * the register key isn't zero.
8233			 */
8234			mtx_unlock(&softc->ctl_lock);
8235			free(ctsio->kern_data_ptr, M_CTL);
8236			ctl_set_reservation_conflict(ctsio);
8237			ctl_done((union ctl_io *)ctsio);
8238			return (CTL_RETVAL_COMPLETE);
8239		}
8240		mtx_unlock(&softc->ctl_lock);
8241	}
8242
8243	switch (cdb->action & SPRO_ACTION_MASK) {
8244	case SPRO_REGISTER:
8245	case SPRO_REG_IGNO: {
8246
8247#if 0
8248		printf("Registration received\n");
8249#endif
8250
8251		/*
8252		 * We don't support any of these options, as we report in
8253		 * the read capabilities request (see
8254		 * ctl_persistent_reserve_in(), above).
8255		 */
8256		if ((param->flags & SPR_SPEC_I_PT)
8257		 || (param->flags & SPR_ALL_TG_PT)
8258		 || (param->flags & SPR_APTPL)) {
8259			int bit_ptr;
8260
8261			if (param->flags & SPR_APTPL)
8262				bit_ptr = 0;
8263			else if (param->flags & SPR_ALL_TG_PT)
8264				bit_ptr = 2;
8265			else /* SPR_SPEC_I_PT */
8266				bit_ptr = 3;
8267
8268			free(ctsio->kern_data_ptr, M_CTL);
8269			ctl_set_invalid_field(ctsio,
8270					      /*sks_valid*/ 1,
8271					      /*command*/ 0,
8272					      /*field*/ 20,
8273					      /*bit_valid*/ 1,
8274					      /*bit*/ bit_ptr);
8275			ctl_done((union ctl_io *)ctsio);
8276			return (CTL_RETVAL_COMPLETE);
8277		}
8278
8279		mtx_lock(&softc->ctl_lock);
8280
8281		/*
8282		 * The initiator wants to clear the
8283		 * key/unregister.
8284		 */
8285		if (sa_res_key == 0) {
8286			if ((res_key == 0
8287			  && (cdb->action & SPRO_ACTION_MASK) == SPRO_REGISTER)
8288			 || ((cdb->action & SPRO_ACTION_MASK) == SPRO_REG_IGNO
8289			  && !lun->per_res[residx].registered)) {
8290				mtx_unlock(&softc->ctl_lock);
8291				goto done;
8292			}
8293
8294			lun->per_res[residx].registered = 0;
8295			memset(&lun->per_res[residx].res_key,
8296			       0, sizeof(lun->per_res[residx].res_key));
8297			lun->pr_key_count--;
8298
8299			if (residx == lun->pr_res_idx) {
8300				lun->flags &= ~CTL_LUN_PR_RESERVED;
8301				lun->pr_res_idx = CTL_PR_NO_RESERVATION;
8302
8303				if ((lun->res_type == SPR_TYPE_WR_EX_RO
8304				  || lun->res_type == SPR_TYPE_EX_AC_RO)
8305				 && lun->pr_key_count) {
8306					/*
8307					 * If the reservation is a registrants
8308					 * only type we need to generate a UA
8309					 * for other registered inits.  The
8310					 * sense code should be RESERVATIONS
8311					 * RELEASED
8312					 */
8313
8314					for (i = 0; i < CTL_MAX_INITIATORS;i++){
8315						if (lun->per_res[
8316						    i+persis_offset].registered
8317						    == 0)
8318							continue;
8319						lun->pending_sense[i
8320							].ua_pending |=
8321							CTL_UA_RES_RELEASE;
8322					}
8323				}
8324				lun->res_type = 0;
8325			} else if (lun->pr_res_idx == CTL_PR_ALL_REGISTRANTS) {
8326				if (lun->pr_key_count==0) {
8327					lun->flags &= ~CTL_LUN_PR_RESERVED;
8328					lun->res_type = 0;
8329					lun->pr_res_idx = CTL_PR_NO_RESERVATION;
8330				}
8331			}
8332			persis_io.hdr.nexus = ctsio->io_hdr.nexus;
8333			persis_io.hdr.msg_type = CTL_MSG_PERS_ACTION;
8334			persis_io.pr.pr_info.action = CTL_PR_UNREG_KEY;
8335			persis_io.pr.pr_info.residx = residx;
8336			if ((isc_retval = ctl_ha_msg_send(CTL_HA_CHAN_CTL,
8337			     &persis_io, sizeof(persis_io), 0 )) >
8338			     CTL_HA_STATUS_SUCCESS) {
8339				printf("CTL:Persis Out error returned from "
8340				       "ctl_ha_msg_send %d\n", isc_retval);
8341			}
8342			mtx_unlock(&softc->ctl_lock);
8343		} else /* sa_res_key != 0 */ {
8344
8345			/*
8346			 * If we aren't registered currently then increment
8347			 * the key count and set the registered flag.
8348			 */
8349			if (!lun->per_res[residx].registered) {
8350				lun->pr_key_count++;
8351				lun->per_res[residx].registered = 1;
8352			}
8353
8354			memcpy(&lun->per_res[residx].res_key,
8355			       param->serv_act_res_key,
8356			       ctl_min(sizeof(param->serv_act_res_key),
8357			       sizeof(lun->per_res[residx].res_key)));
8358
8359			persis_io.hdr.nexus = ctsio->io_hdr.nexus;
8360			persis_io.hdr.msg_type = CTL_MSG_PERS_ACTION;
8361			persis_io.pr.pr_info.action = CTL_PR_REG_KEY;
8362			persis_io.pr.pr_info.residx = residx;
8363			memcpy(persis_io.pr.pr_info.sa_res_key,
8364			       param->serv_act_res_key,
8365			       sizeof(param->serv_act_res_key));
8366			mtx_unlock(&softc->ctl_lock);
8367			if ((isc_retval=ctl_ha_msg_send(CTL_HA_CHAN_CTL,
8368			     &persis_io, sizeof(persis_io), 0)) >
8369			     CTL_HA_STATUS_SUCCESS) {
8370				printf("CTL:Persis Out error returned from "
8371				       "ctl_ha_msg_send %d\n", isc_retval);
8372			}
8373		}
8374		lun->PRGeneration++;
8375
8376		break;
8377	}
8378	case SPRO_RESERVE:
8379#if 0
8380                printf("Reserve executed type %d\n", type);
8381#endif
8382		mtx_lock(&softc->ctl_lock);
8383		if (lun->flags & CTL_LUN_PR_RESERVED) {
8384			/*
8385			 * if this isn't the reservation holder and it's
8386			 * not a "all registrants" type or if the type is
8387			 * different then we have a conflict
8388			 */
8389			if ((lun->pr_res_idx != residx
8390			  && lun->pr_res_idx != CTL_PR_ALL_REGISTRANTS)
8391			 || lun->res_type != type) {
8392				mtx_unlock(&softc->ctl_lock);
8393				free(ctsio->kern_data_ptr, M_CTL);
8394				ctl_set_reservation_conflict(ctsio);
8395				ctl_done((union ctl_io *)ctsio);
8396				return (CTL_RETVAL_COMPLETE);
8397			}
8398			mtx_unlock(&softc->ctl_lock);
8399		} else /* create a reservation */ {
8400			/*
8401			 * If it's not an "all registrants" type record
8402			 * reservation holder
8403			 */
8404			if (type != SPR_TYPE_WR_EX_AR
8405			 && type != SPR_TYPE_EX_AC_AR)
8406				lun->pr_res_idx = residx; /* Res holder */
8407			else
8408				lun->pr_res_idx = CTL_PR_ALL_REGISTRANTS;
8409
8410			lun->flags |= CTL_LUN_PR_RESERVED;
8411			lun->res_type = type;
8412
8413			mtx_unlock(&softc->ctl_lock);
8414
8415			/* send msg to other side */
8416			persis_io.hdr.nexus = ctsio->io_hdr.nexus;
8417			persis_io.hdr.msg_type = CTL_MSG_PERS_ACTION;
8418			persis_io.pr.pr_info.action = CTL_PR_RESERVE;
8419			persis_io.pr.pr_info.residx = lun->pr_res_idx;
8420			persis_io.pr.pr_info.res_type = type;
8421			if ((isc_retval=ctl_ha_msg_send(CTL_HA_CHAN_CTL,
8422			     &persis_io, sizeof(persis_io), 0)) >
8423			     CTL_HA_STATUS_SUCCESS) {
8424				printf("CTL:Persis Out error returned from "
8425				       "ctl_ha_msg_send %d\n", isc_retval);
8426			}
8427		}
8428		break;
8429
8430	case SPRO_RELEASE:
8431		mtx_lock(&softc->ctl_lock);
8432		if ((lun->flags & CTL_LUN_PR_RESERVED) == 0) {
8433			/* No reservation exists return good status */
8434			mtx_unlock(&softc->ctl_lock);
8435			goto done;
8436		}
8437		/*
8438		 * Is this nexus a reservation holder?
8439		 */
8440		if (lun->pr_res_idx != residx
8441		 && lun->pr_res_idx != CTL_PR_ALL_REGISTRANTS) {
8442			/*
8443			 * not a res holder return good status but
8444			 * do nothing
8445			 */
8446			mtx_unlock(&softc->ctl_lock);
8447			goto done;
8448		}
8449
8450		if (lun->res_type != type) {
8451			mtx_unlock(&softc->ctl_lock);
8452			free(ctsio->kern_data_ptr, M_CTL);
8453			ctl_set_illegal_pr_release(ctsio);
8454			ctl_done((union ctl_io *)ctsio);
8455			return (CTL_RETVAL_COMPLETE);
8456		}
8457
8458		/* okay to release */
8459		lun->flags &= ~CTL_LUN_PR_RESERVED;
8460		lun->pr_res_idx = CTL_PR_NO_RESERVATION;
8461		lun->res_type = 0;
8462
8463		/*
8464		 * if this isn't an exclusive access
8465		 * res generate UA for all other
8466		 * registrants.
8467		 */
8468		if (type != SPR_TYPE_EX_AC
8469		 && type != SPR_TYPE_WR_EX) {
8470			/*
8471			 * temporarily unregister so we don't generate UA
8472			 */
8473			lun->per_res[residx].registered = 0;
8474
8475			for (i = 0; i < CTL_MAX_INITIATORS; i++) {
8476				if (lun->per_res[i+persis_offset].registered
8477				    == 0)
8478					continue;
8479				lun->pending_sense[i].ua_pending |=
8480					CTL_UA_RES_RELEASE;
8481			}
8482
8483			lun->per_res[residx].registered = 1;
8484		}
8485		mtx_unlock(&softc->ctl_lock);
8486		/* Send msg to other side */
8487		persis_io.hdr.nexus = ctsio->io_hdr.nexus;
8488		persis_io.hdr.msg_type = CTL_MSG_PERS_ACTION;
8489		persis_io.pr.pr_info.action = CTL_PR_RELEASE;
8490		if ((isc_retval=ctl_ha_msg_send( CTL_HA_CHAN_CTL, &persis_io,
8491		     sizeof(persis_io), 0)) > CTL_HA_STATUS_SUCCESS) {
8492			printf("CTL:Persis Out error returned from "
8493			       "ctl_ha_msg_send %d\n", isc_retval);
8494		}
8495		break;
8496
8497	case SPRO_CLEAR:
8498		/* send msg to other side */
8499
8500		mtx_lock(&softc->ctl_lock);
8501		lun->flags &= ~CTL_LUN_PR_RESERVED;
8502		lun->res_type = 0;
8503		lun->pr_key_count = 0;
8504		lun->pr_res_idx = CTL_PR_NO_RESERVATION;
8505
8506
8507		memset(&lun->per_res[residx].res_key,
8508		       0, sizeof(lun->per_res[residx].res_key));
8509		lun->per_res[residx].registered = 0;
8510
8511		for (i=0; i < 2*CTL_MAX_INITIATORS; i++)
8512			if (lun->per_res[i].registered) {
8513				if (!persis_offset && i < CTL_MAX_INITIATORS)
8514					lun->pending_sense[i].ua_pending |=
8515						CTL_UA_RES_PREEMPT;
8516				else if (persis_offset && i >= persis_offset)
8517					lun->pending_sense[i-persis_offset
8518					    ].ua_pending |= CTL_UA_RES_PREEMPT;
8519
8520				memset(&lun->per_res[i].res_key,
8521				       0, sizeof(struct scsi_per_res_key));
8522				lun->per_res[i].registered = 0;
8523			}
8524		lun->PRGeneration++;
8525		mtx_unlock(&softc->ctl_lock);
8526		persis_io.hdr.nexus = ctsio->io_hdr.nexus;
8527		persis_io.hdr.msg_type = CTL_MSG_PERS_ACTION;
8528		persis_io.pr.pr_info.action = CTL_PR_CLEAR;
8529		if ((isc_retval=ctl_ha_msg_send(CTL_HA_CHAN_CTL, &persis_io,
8530		     sizeof(persis_io), 0)) > CTL_HA_STATUS_SUCCESS) {
8531			printf("CTL:Persis Out error returned from "
8532			       "ctl_ha_msg_send %d\n", isc_retval);
8533		}
8534		break;
8535
8536	case SPRO_PREEMPT: {
8537		int nretval;
8538
8539		nretval = ctl_pro_preempt(softc, lun, res_key, sa_res_key, type,
8540					  residx, ctsio, cdb, param);
8541		if (nretval != 0)
8542			return (CTL_RETVAL_COMPLETE);
8543		break;
8544	}
8545	case SPRO_REG_MOVE:
8546	case SPRO_PRE_ABO:
8547	default:
8548		free(ctsio->kern_data_ptr, M_CTL);
8549		ctl_set_invalid_field(/*ctsio*/ ctsio,
8550				      /*sks_valid*/ 1,
8551				      /*command*/ 1,
8552				      /*field*/ 1,
8553				      /*bit_valid*/ 1,
8554				      /*bit*/ 0);
8555		ctl_done((union ctl_io *)ctsio);
8556		return (CTL_RETVAL_COMPLETE);
8557		break; /* NOTREACHED */
8558	}
8559
8560done:
8561	free(ctsio->kern_data_ptr, M_CTL);
8562	ctl_set_success(ctsio);
8563	ctl_done((union ctl_io *)ctsio);
8564
8565	return (retval);
8566}
8567
8568/*
8569 * This routine is for handling a message from the other SC pertaining to
8570 * persistent reserve out. All the error checking will have been done
8571 * so only perorming the action need be done here to keep the two
8572 * in sync.
8573 */
8574static void
8575ctl_hndl_per_res_out_on_other_sc(union ctl_ha_msg *msg)
8576{
8577	struct ctl_lun *lun;
8578	struct ctl_softc *softc;
8579	int i;
8580	uint32_t targ_lun;
8581
8582	softc = control_softc;
8583
8584	mtx_lock(&softc->ctl_lock);
8585
8586	targ_lun = msg->hdr.nexus.targ_lun;
8587	if (msg->hdr.nexus.lun_map_fn != NULL)
8588		targ_lun = msg->hdr.nexus.lun_map_fn(msg->hdr.nexus.lun_map_arg, targ_lun);
8589	lun = softc->ctl_luns[targ_lun];
8590	switch(msg->pr.pr_info.action) {
8591	case CTL_PR_REG_KEY:
8592		if (!lun->per_res[msg->pr.pr_info.residx].registered) {
8593			lun->per_res[msg->pr.pr_info.residx].registered = 1;
8594			lun->pr_key_count++;
8595		}
8596		lun->PRGeneration++;
8597		memcpy(&lun->per_res[msg->pr.pr_info.residx].res_key,
8598		       msg->pr.pr_info.sa_res_key,
8599		       sizeof(struct scsi_per_res_key));
8600		break;
8601
8602	case CTL_PR_UNREG_KEY:
8603		lun->per_res[msg->pr.pr_info.residx].registered = 0;
8604		memset(&lun->per_res[msg->pr.pr_info.residx].res_key,
8605		       0, sizeof(struct scsi_per_res_key));
8606		lun->pr_key_count--;
8607
8608		/* XXX Need to see if the reservation has been released */
8609		/* if so do we need to generate UA? */
8610		if (msg->pr.pr_info.residx == lun->pr_res_idx) {
8611			lun->flags &= ~CTL_LUN_PR_RESERVED;
8612			lun->pr_res_idx = CTL_PR_NO_RESERVATION;
8613
8614			if ((lun->res_type == SPR_TYPE_WR_EX_RO
8615			  || lun->res_type == SPR_TYPE_EX_AC_RO)
8616			 && lun->pr_key_count) {
8617				/*
8618				 * If the reservation is a registrants
8619				 * only type we need to generate a UA
8620				 * for other registered inits.  The
8621				 * sense code should be RESERVATIONS
8622				 * RELEASED
8623				 */
8624
8625				for (i = 0; i < CTL_MAX_INITIATORS; i++) {
8626					if (lun->per_res[i+
8627					    persis_offset].registered == 0)
8628						continue;
8629
8630					lun->pending_sense[i
8631						].ua_pending |=
8632						CTL_UA_RES_RELEASE;
8633				}
8634			}
8635			lun->res_type = 0;
8636		} else if (lun->pr_res_idx == CTL_PR_ALL_REGISTRANTS) {
8637			if (lun->pr_key_count==0) {
8638				lun->flags &= ~CTL_LUN_PR_RESERVED;
8639				lun->res_type = 0;
8640				lun->pr_res_idx = CTL_PR_NO_RESERVATION;
8641			}
8642		}
8643		lun->PRGeneration++;
8644		break;
8645
8646	case CTL_PR_RESERVE:
8647		lun->flags |= CTL_LUN_PR_RESERVED;
8648		lun->res_type = msg->pr.pr_info.res_type;
8649		lun->pr_res_idx = msg->pr.pr_info.residx;
8650
8651		break;
8652
8653	case CTL_PR_RELEASE:
8654		/*
8655		 * if this isn't an exclusive access res generate UA for all
8656		 * other registrants.
8657		 */
8658		if (lun->res_type != SPR_TYPE_EX_AC
8659		 && lun->res_type != SPR_TYPE_WR_EX) {
8660			for (i = 0; i < CTL_MAX_INITIATORS; i++)
8661				if (lun->per_res[i+persis_offset].registered)
8662					lun->pending_sense[i].ua_pending |=
8663						CTL_UA_RES_RELEASE;
8664		}
8665
8666		lun->flags &= ~CTL_LUN_PR_RESERVED;
8667		lun->pr_res_idx = CTL_PR_NO_RESERVATION;
8668		lun->res_type = 0;
8669		break;
8670
8671	case CTL_PR_PREEMPT:
8672		ctl_pro_preempt_other(lun, msg);
8673		break;
8674	case CTL_PR_CLEAR:
8675		lun->flags &= ~CTL_LUN_PR_RESERVED;
8676		lun->res_type = 0;
8677		lun->pr_key_count = 0;
8678		lun->pr_res_idx = CTL_PR_NO_RESERVATION;
8679
8680		for (i=0; i < 2*CTL_MAX_INITIATORS; i++) {
8681			if (lun->per_res[i].registered == 0)
8682				continue;
8683			if (!persis_offset
8684			 && i < CTL_MAX_INITIATORS)
8685				lun->pending_sense[i].ua_pending |=
8686					CTL_UA_RES_PREEMPT;
8687			else if (persis_offset
8688			      && i >= persis_offset)
8689   				lun->pending_sense[i-persis_offset].ua_pending|=
8690					CTL_UA_RES_PREEMPT;
8691			memset(&lun->per_res[i].res_key, 0,
8692			       sizeof(struct scsi_per_res_key));
8693			lun->per_res[i].registered = 0;
8694		}
8695		lun->PRGeneration++;
8696		break;
8697	}
8698
8699	mtx_unlock(&softc->ctl_lock);
8700}
8701
8702int
8703ctl_read_write(struct ctl_scsiio *ctsio)
8704{
8705	struct ctl_lun *lun;
8706	struct ctl_lba_len_flags *lbalen;
8707	uint64_t lba;
8708	uint32_t num_blocks;
8709	int reladdr, fua, dpo, ebp;
8710	int retval;
8711	int isread;
8712
8713	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
8714
8715	CTL_DEBUG_PRINT(("ctl_read_write: command: %#x\n", ctsio->cdb[0]));
8716
8717	reladdr = 0;
8718	fua = 0;
8719	dpo = 0;
8720	ebp = 0;
8721
8722	retval = CTL_RETVAL_COMPLETE;
8723
8724	isread = ctsio->cdb[0] == READ_6  || ctsio->cdb[0] == READ_10
8725	      || ctsio->cdb[0] == READ_12 || ctsio->cdb[0] == READ_16;
8726	if (lun->flags & CTL_LUN_PR_RESERVED && isread) {
8727		uint32_t residx;
8728
8729		/*
8730		 * XXX KDM need a lock here.
8731		 */
8732		residx = ctl_get_resindex(&ctsio->io_hdr.nexus);
8733		if ((lun->res_type == SPR_TYPE_EX_AC
8734		  && residx != lun->pr_res_idx)
8735		 || ((lun->res_type == SPR_TYPE_EX_AC_RO
8736		   || lun->res_type == SPR_TYPE_EX_AC_AR)
8737		  && !lun->per_res[residx].registered)) {
8738			ctl_set_reservation_conflict(ctsio);
8739			ctl_done((union ctl_io *)ctsio);
8740			return (CTL_RETVAL_COMPLETE);
8741	        }
8742	}
8743
8744	switch (ctsio->cdb[0]) {
8745	case READ_6:
8746	case WRITE_6: {
8747		struct scsi_rw_6 *cdb;
8748
8749		cdb = (struct scsi_rw_6 *)ctsio->cdb;
8750
8751		lba = scsi_3btoul(cdb->addr);
8752		/* only 5 bits are valid in the most significant address byte */
8753		lba &= 0x1fffff;
8754		num_blocks = cdb->length;
8755		/*
8756		 * This is correct according to SBC-2.
8757		 */
8758		if (num_blocks == 0)
8759			num_blocks = 256;
8760		break;
8761	}
8762	case READ_10:
8763	case WRITE_10: {
8764		struct scsi_rw_10 *cdb;
8765
8766		cdb = (struct scsi_rw_10 *)ctsio->cdb;
8767
8768		if (cdb->byte2 & SRW10_RELADDR)
8769			reladdr = 1;
8770		if (cdb->byte2 & SRW10_FUA)
8771			fua = 1;
8772		if (cdb->byte2 & SRW10_DPO)
8773			dpo = 1;
8774
8775		if ((cdb->opcode == WRITE_10)
8776		 && (cdb->byte2 & SRW10_EBP))
8777			ebp = 1;
8778
8779		lba = scsi_4btoul(cdb->addr);
8780		num_blocks = scsi_2btoul(cdb->length);
8781		break;
8782	}
8783	case WRITE_VERIFY_10: {
8784		struct scsi_write_verify_10 *cdb;
8785
8786		cdb = (struct scsi_write_verify_10 *)ctsio->cdb;
8787
8788		/*
8789		 * XXX KDM we should do actual write verify support at some
8790		 * point.  This is obviously fake, we're just translating
8791		 * things to a write.  So we don't even bother checking the
8792		 * BYTCHK field, since we don't do any verification.  If
8793		 * the user asks for it, we'll just pretend we did it.
8794		 */
8795		if (cdb->byte2 & SWV_DPO)
8796			dpo = 1;
8797
8798		lba = scsi_4btoul(cdb->addr);
8799		num_blocks = scsi_2btoul(cdb->length);
8800		break;
8801	}
8802	case READ_12:
8803	case WRITE_12: {
8804		struct scsi_rw_12 *cdb;
8805
8806		cdb = (struct scsi_rw_12 *)ctsio->cdb;
8807
8808		if (cdb->byte2 & SRW12_RELADDR)
8809			reladdr = 1;
8810		if (cdb->byte2 & SRW12_FUA)
8811			fua = 1;
8812		if (cdb->byte2 & SRW12_DPO)
8813			dpo = 1;
8814		lba = scsi_4btoul(cdb->addr);
8815		num_blocks = scsi_4btoul(cdb->length);
8816		break;
8817	}
8818	case WRITE_VERIFY_12: {
8819		struct scsi_write_verify_12 *cdb;
8820
8821		cdb = (struct scsi_write_verify_12 *)ctsio->cdb;
8822
8823		if (cdb->byte2 & SWV_DPO)
8824			dpo = 1;
8825
8826		lba = scsi_4btoul(cdb->addr);
8827		num_blocks = scsi_4btoul(cdb->length);
8828
8829		break;
8830	}
8831	case READ_16:
8832	case WRITE_16: {
8833		struct scsi_rw_16 *cdb;
8834
8835		cdb = (struct scsi_rw_16 *)ctsio->cdb;
8836
8837		if (cdb->byte2 & SRW12_RELADDR)
8838			reladdr = 1;
8839		if (cdb->byte2 & SRW12_FUA)
8840			fua = 1;
8841		if (cdb->byte2 & SRW12_DPO)
8842			dpo = 1;
8843
8844		lba = scsi_8btou64(cdb->addr);
8845		num_blocks = scsi_4btoul(cdb->length);
8846		break;
8847	}
8848	case WRITE_VERIFY_16: {
8849		struct scsi_write_verify_16 *cdb;
8850
8851		cdb = (struct scsi_write_verify_16 *)ctsio->cdb;
8852
8853		if (cdb->byte2 & SWV_DPO)
8854			dpo = 1;
8855
8856		lba = scsi_8btou64(cdb->addr);
8857		num_blocks = scsi_4btoul(cdb->length);
8858		break;
8859	}
8860	default:
8861		/*
8862		 * We got a command we don't support.  This shouldn't
8863		 * happen, commands should be filtered out above us.
8864		 */
8865		ctl_set_invalid_opcode(ctsio);
8866		ctl_done((union ctl_io *)ctsio);
8867
8868		return (CTL_RETVAL_COMPLETE);
8869		break; /* NOTREACHED */
8870	}
8871
8872	/*
8873	 * XXX KDM what do we do with the DPO and FUA bits?  FUA might be
8874	 * interesting for us, but if RAIDCore is in write-back mode,
8875	 * getting it to do write-through for a particular transaction may
8876	 * not be possible.
8877	 */
8878	/*
8879	 * We don't support relative addressing.  That also requires
8880	 * supporting linked commands, which we don't do.
8881	 */
8882	if (reladdr != 0) {
8883		ctl_set_invalid_field(ctsio,
8884				      /*sks_valid*/ 1,
8885				      /*command*/ 1,
8886				      /*field*/ 1,
8887				      /*bit_valid*/ 1,
8888				      /*bit*/ 0);
8889		ctl_done((union ctl_io *)ctsio);
8890		return (CTL_RETVAL_COMPLETE);
8891	}
8892
8893	/*
8894	 * The first check is to make sure we're in bounds, the second
8895	 * check is to catch wrap-around problems.  If the lba + num blocks
8896	 * is less than the lba, then we've wrapped around and the block
8897	 * range is invalid anyway.
8898	 */
8899	if (((lba + num_blocks) > (lun->be_lun->maxlba + 1))
8900	 || ((lba + num_blocks) < lba)) {
8901		ctl_set_lba_out_of_range(ctsio);
8902		ctl_done((union ctl_io *)ctsio);
8903		return (CTL_RETVAL_COMPLETE);
8904	}
8905
8906	/*
8907	 * According to SBC-3, a transfer length of 0 is not an error.
8908	 * Note that this cannot happen with WRITE(6) or READ(6), since 0
8909	 * translates to 256 blocks for those commands.
8910	 */
8911	if (num_blocks == 0) {
8912		ctl_set_success(ctsio);
8913		ctl_done((union ctl_io *)ctsio);
8914		return (CTL_RETVAL_COMPLETE);
8915	}
8916
8917	lbalen = (struct ctl_lba_len_flags *)
8918	    &ctsio->io_hdr.ctl_private[CTL_PRIV_LBA_LEN];
8919	lbalen->lba = lba;
8920	lbalen->len = num_blocks;
8921	lbalen->flags = isread ? CTL_LLF_READ : CTL_LLF_WRITE;
8922
8923	ctsio->kern_total_len = num_blocks * lun->be_lun->blocksize;
8924	ctsio->kern_rel_offset = 0;
8925
8926	CTL_DEBUG_PRINT(("ctl_read_write: calling data_submit()\n"));
8927
8928	retval = lun->backend->data_submit((union ctl_io *)ctsio);
8929
8930	return (retval);
8931}
8932
8933static int
8934ctl_cnw_cont(union ctl_io *io)
8935{
8936	struct ctl_scsiio *ctsio;
8937	struct ctl_lun *lun;
8938	struct ctl_lba_len_flags *lbalen;
8939	int retval;
8940
8941	ctsio = &io->scsiio;
8942	ctsio->io_hdr.status = CTL_STATUS_NONE;
8943	ctsio->io_hdr.flags &= ~CTL_FLAG_IO_CONT;
8944	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
8945	lbalen = (struct ctl_lba_len_flags *)
8946	    &ctsio->io_hdr.ctl_private[CTL_PRIV_LBA_LEN];
8947	lbalen->flags = CTL_LLF_WRITE;
8948
8949	CTL_DEBUG_PRINT(("ctl_cnw_cont: calling data_submit()\n"));
8950	retval = lun->backend->data_submit((union ctl_io *)ctsio);
8951	return (retval);
8952}
8953
8954int
8955ctl_cnw(struct ctl_scsiio *ctsio)
8956{
8957	struct ctl_lun *lun;
8958	struct ctl_lba_len_flags *lbalen;
8959	uint64_t lba;
8960	uint32_t num_blocks;
8961	int fua, dpo;
8962	int retval;
8963
8964	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
8965
8966	CTL_DEBUG_PRINT(("ctl_cnw: command: %#x\n", ctsio->cdb[0]));
8967
8968	fua = 0;
8969	dpo = 0;
8970
8971	retval = CTL_RETVAL_COMPLETE;
8972
8973	switch (ctsio->cdb[0]) {
8974	case COMPARE_AND_WRITE: {
8975		struct scsi_compare_and_write *cdb;
8976
8977		cdb = (struct scsi_compare_and_write *)ctsio->cdb;
8978
8979		if (cdb->byte2 & SRW10_FUA)
8980			fua = 1;
8981		if (cdb->byte2 & SRW10_DPO)
8982			dpo = 1;
8983		lba = scsi_8btou64(cdb->addr);
8984		num_blocks = cdb->length;
8985		break;
8986	}
8987	default:
8988		/*
8989		 * We got a command we don't support.  This shouldn't
8990		 * happen, commands should be filtered out above us.
8991		 */
8992		ctl_set_invalid_opcode(ctsio);
8993		ctl_done((union ctl_io *)ctsio);
8994
8995		return (CTL_RETVAL_COMPLETE);
8996		break; /* NOTREACHED */
8997	}
8998
8999	/*
9000	 * XXX KDM what do we do with the DPO and FUA bits?  FUA might be
9001	 * interesting for us, but if RAIDCore is in write-back mode,
9002	 * getting it to do write-through for a particular transaction may
9003	 * not be possible.
9004	 */
9005
9006	/*
9007	 * The first check is to make sure we're in bounds, the second
9008	 * check is to catch wrap-around problems.  If the lba + num blocks
9009	 * is less than the lba, then we've wrapped around and the block
9010	 * range is invalid anyway.
9011	 */
9012	if (((lba + num_blocks) > (lun->be_lun->maxlba + 1))
9013	 || ((lba + num_blocks) < lba)) {
9014		ctl_set_lba_out_of_range(ctsio);
9015		ctl_done((union ctl_io *)ctsio);
9016		return (CTL_RETVAL_COMPLETE);
9017	}
9018
9019	/*
9020	 * According to SBC-3, a transfer length of 0 is not an error.
9021	 */
9022	if (num_blocks == 0) {
9023		ctl_set_success(ctsio);
9024		ctl_done((union ctl_io *)ctsio);
9025		return (CTL_RETVAL_COMPLETE);
9026	}
9027
9028	ctsio->kern_total_len = 2 * num_blocks * lun->be_lun->blocksize;
9029	ctsio->kern_rel_offset = 0;
9030
9031	/*
9032	 * Set the IO_CONT flag, so that if this I/O gets passed to
9033	 * ctl_data_submit_done(), it'll get passed back to
9034	 * ctl_ctl_cnw_cont() for further processing.
9035	 */
9036	ctsio->io_hdr.flags |= CTL_FLAG_IO_CONT;
9037	ctsio->io_cont = ctl_cnw_cont;
9038
9039	lbalen = (struct ctl_lba_len_flags *)
9040	    &ctsio->io_hdr.ctl_private[CTL_PRIV_LBA_LEN];
9041	lbalen->lba = lba;
9042	lbalen->len = num_blocks;
9043	lbalen->flags = CTL_LLF_COMPARE;
9044
9045	CTL_DEBUG_PRINT(("ctl_cnw: calling data_submit()\n"));
9046	retval = lun->backend->data_submit((union ctl_io *)ctsio);
9047	return (retval);
9048}
9049
9050int
9051ctl_verify(struct ctl_scsiio *ctsio)
9052{
9053	struct ctl_lun *lun;
9054	struct ctl_lba_len_flags *lbalen;
9055	uint64_t lba;
9056	uint32_t num_blocks;
9057	int bytchk, dpo;
9058	int retval;
9059
9060	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
9061
9062	CTL_DEBUG_PRINT(("ctl_verify: command: %#x\n", ctsio->cdb[0]));
9063
9064	bytchk = 0;
9065	dpo = 0;
9066	retval = CTL_RETVAL_COMPLETE;
9067
9068	switch (ctsio->cdb[0]) {
9069	case VERIFY_10: {
9070		struct scsi_verify_10 *cdb;
9071
9072		cdb = (struct scsi_verify_10 *)ctsio->cdb;
9073		if (cdb->byte2 & SVFY_BYTCHK)
9074			bytchk = 1;
9075		if (cdb->byte2 & SVFY_DPO)
9076			dpo = 1;
9077		lba = scsi_4btoul(cdb->addr);
9078		num_blocks = scsi_2btoul(cdb->length);
9079		break;
9080	}
9081	case VERIFY_12: {
9082		struct scsi_verify_12 *cdb;
9083
9084		cdb = (struct scsi_verify_12 *)ctsio->cdb;
9085		if (cdb->byte2 & SVFY_BYTCHK)
9086			bytchk = 1;
9087		if (cdb->byte2 & SVFY_DPO)
9088			dpo = 1;
9089		lba = scsi_4btoul(cdb->addr);
9090		num_blocks = scsi_4btoul(cdb->length);
9091		break;
9092	}
9093	case VERIFY_16: {
9094		struct scsi_rw_16 *cdb;
9095
9096		cdb = (struct scsi_rw_16 *)ctsio->cdb;
9097		if (cdb->byte2 & SVFY_BYTCHK)
9098			bytchk = 1;
9099		if (cdb->byte2 & SVFY_DPO)
9100			dpo = 1;
9101		lba = scsi_8btou64(cdb->addr);
9102		num_blocks = scsi_4btoul(cdb->length);
9103		break;
9104	}
9105	default:
9106		/*
9107		 * We got a command we don't support.  This shouldn't
9108		 * happen, commands should be filtered out above us.
9109		 */
9110		ctl_set_invalid_opcode(ctsio);
9111		ctl_done((union ctl_io *)ctsio);
9112		return (CTL_RETVAL_COMPLETE);
9113	}
9114
9115	/*
9116	 * The first check is to make sure we're in bounds, the second
9117	 * check is to catch wrap-around problems.  If the lba + num blocks
9118	 * is less than the lba, then we've wrapped around and the block
9119	 * range is invalid anyway.
9120	 */
9121	if (((lba + num_blocks) > (lun->be_lun->maxlba + 1))
9122	 || ((lba + num_blocks) < lba)) {
9123		ctl_set_lba_out_of_range(ctsio);
9124		ctl_done((union ctl_io *)ctsio);
9125		return (CTL_RETVAL_COMPLETE);
9126	}
9127
9128	/*
9129	 * According to SBC-3, a transfer length of 0 is not an error.
9130	 */
9131	if (num_blocks == 0) {
9132		ctl_set_success(ctsio);
9133		ctl_done((union ctl_io *)ctsio);
9134		return (CTL_RETVAL_COMPLETE);
9135	}
9136
9137	lbalen = (struct ctl_lba_len_flags *)
9138	    &ctsio->io_hdr.ctl_private[CTL_PRIV_LBA_LEN];
9139	lbalen->lba = lba;
9140	lbalen->len = num_blocks;
9141	if (bytchk) {
9142		lbalen->flags = CTL_LLF_COMPARE;
9143		ctsio->kern_total_len = num_blocks * lun->be_lun->blocksize;
9144	} else {
9145		lbalen->flags = CTL_LLF_VERIFY;
9146		ctsio->kern_total_len = 0;
9147	}
9148	ctsio->kern_rel_offset = 0;
9149
9150	CTL_DEBUG_PRINT(("ctl_verify: calling data_submit()\n"));
9151	retval = lun->backend->data_submit((union ctl_io *)ctsio);
9152	return (retval);
9153}
9154
9155int
9156ctl_report_luns(struct ctl_scsiio *ctsio)
9157{
9158	struct scsi_report_luns *cdb;
9159	struct scsi_report_luns_data *lun_data;
9160	struct ctl_lun *lun, *request_lun;
9161	int num_luns, retval;
9162	uint32_t alloc_len, lun_datalen;
9163	int num_filled, well_known;
9164	uint32_t initidx, targ_lun_id, lun_id;
9165
9166	retval = CTL_RETVAL_COMPLETE;
9167	well_known = 0;
9168
9169	cdb = (struct scsi_report_luns *)ctsio->cdb;
9170
9171	CTL_DEBUG_PRINT(("ctl_report_luns\n"));
9172
9173	mtx_lock(&control_softc->ctl_lock);
9174	num_luns = control_softc->num_luns;
9175	mtx_unlock(&control_softc->ctl_lock);
9176
9177	switch (cdb->select_report) {
9178	case RPL_REPORT_DEFAULT:
9179	case RPL_REPORT_ALL:
9180		break;
9181	case RPL_REPORT_WELLKNOWN:
9182		well_known = 1;
9183		num_luns = 0;
9184		break;
9185	default:
9186		ctl_set_invalid_field(ctsio,
9187				      /*sks_valid*/ 1,
9188				      /*command*/ 1,
9189				      /*field*/ 2,
9190				      /*bit_valid*/ 0,
9191				      /*bit*/ 0);
9192		ctl_done((union ctl_io *)ctsio);
9193		return (retval);
9194		break; /* NOTREACHED */
9195	}
9196
9197	alloc_len = scsi_4btoul(cdb->length);
9198	/*
9199	 * The initiator has to allocate at least 16 bytes for this request,
9200	 * so he can at least get the header and the first LUN.  Otherwise
9201	 * we reject the request (per SPC-3 rev 14, section 6.21).
9202	 */
9203	if (alloc_len < (sizeof(struct scsi_report_luns_data) +
9204	    sizeof(struct scsi_report_luns_lundata))) {
9205		ctl_set_invalid_field(ctsio,
9206				      /*sks_valid*/ 1,
9207				      /*command*/ 1,
9208				      /*field*/ 6,
9209				      /*bit_valid*/ 0,
9210				      /*bit*/ 0);
9211		ctl_done((union ctl_io *)ctsio);
9212		return (retval);
9213	}
9214
9215	request_lun = (struct ctl_lun *)
9216		ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
9217
9218	lun_datalen = sizeof(*lun_data) +
9219		(num_luns * sizeof(struct scsi_report_luns_lundata));
9220
9221	ctsio->kern_data_ptr = malloc(lun_datalen, M_CTL, M_WAITOK | M_ZERO);
9222	lun_data = (struct scsi_report_luns_data *)ctsio->kern_data_ptr;
9223	ctsio->kern_sg_entries = 0;
9224
9225	initidx = ctl_get_initindex(&ctsio->io_hdr.nexus);
9226
9227	mtx_lock(&control_softc->ctl_lock);
9228	for (targ_lun_id = 0, num_filled = 0; targ_lun_id < CTL_MAX_LUNS && num_filled < num_luns; targ_lun_id++) {
9229		lun_id = targ_lun_id;
9230		if (ctsio->io_hdr.nexus.lun_map_fn != NULL)
9231			lun_id = ctsio->io_hdr.nexus.lun_map_fn(ctsio->io_hdr.nexus.lun_map_arg, lun_id);
9232		if (lun_id >= CTL_MAX_LUNS)
9233			continue;
9234		lun = control_softc->ctl_luns[lun_id];
9235		if (lun == NULL)
9236			continue;
9237
9238		if (targ_lun_id <= 0xff) {
9239			/*
9240			 * Peripheral addressing method, bus number 0.
9241			 */
9242			lun_data->luns[num_filled].lundata[0] =
9243				RPL_LUNDATA_ATYP_PERIPH;
9244			lun_data->luns[num_filled].lundata[1] = targ_lun_id;
9245			num_filled++;
9246		} else if (targ_lun_id <= 0x3fff) {
9247			/*
9248			 * Flat addressing method.
9249			 */
9250			lun_data->luns[num_filled].lundata[0] =
9251				RPL_LUNDATA_ATYP_FLAT |
9252				(targ_lun_id & RPL_LUNDATA_FLAT_LUN_MASK);
9253#ifdef OLDCTLHEADERS
9254				(SRLD_ADDR_FLAT << SRLD_ADDR_SHIFT) |
9255				(targ_lun_id & SRLD_BUS_LUN_MASK);
9256#endif
9257			lun_data->luns[num_filled].lundata[1] =
9258#ifdef OLDCTLHEADERS
9259				targ_lun_id >> SRLD_BUS_LUN_BITS;
9260#endif
9261				targ_lun_id >> RPL_LUNDATA_FLAT_LUN_BITS;
9262			num_filled++;
9263		} else {
9264			printf("ctl_report_luns: bogus LUN number %jd, "
9265			       "skipping\n", (intmax_t)targ_lun_id);
9266		}
9267		/*
9268		 * According to SPC-3, rev 14 section 6.21:
9269		 *
9270		 * "The execution of a REPORT LUNS command to any valid and
9271		 * installed logical unit shall clear the REPORTED LUNS DATA
9272		 * HAS CHANGED unit attention condition for all logical
9273		 * units of that target with respect to the requesting
9274		 * initiator. A valid and installed logical unit is one
9275		 * having a PERIPHERAL QUALIFIER of 000b in the standard
9276		 * INQUIRY data (see 6.4.2)."
9277		 *
9278		 * If request_lun is NULL, the LUN this report luns command
9279		 * was issued to is either disabled or doesn't exist. In that
9280		 * case, we shouldn't clear any pending lun change unit
9281		 * attention.
9282		 */
9283		if (request_lun != NULL)
9284			lun->pending_sense[initidx].ua_pending &=
9285				~CTL_UA_LUN_CHANGE;
9286	}
9287	mtx_unlock(&control_softc->ctl_lock);
9288
9289	/*
9290	 * It's quite possible that we've returned fewer LUNs than we allocated
9291	 * space for.  Trim it.
9292	 */
9293	lun_datalen = sizeof(*lun_data) +
9294		(num_filled * sizeof(struct scsi_report_luns_lundata));
9295
9296	if (lun_datalen < alloc_len) {
9297		ctsio->residual = alloc_len - lun_datalen;
9298		ctsio->kern_data_len = lun_datalen;
9299		ctsio->kern_total_len = lun_datalen;
9300	} else {
9301		ctsio->residual = 0;
9302		ctsio->kern_data_len = alloc_len;
9303		ctsio->kern_total_len = alloc_len;
9304	}
9305	ctsio->kern_data_resid = 0;
9306	ctsio->kern_rel_offset = 0;
9307	ctsio->kern_sg_entries = 0;
9308
9309	/*
9310	 * We set this to the actual data length, regardless of how much
9311	 * space we actually have to return results.  If the user looks at
9312	 * this value, he'll know whether or not he allocated enough space
9313	 * and reissue the command if necessary.  We don't support well
9314	 * known logical units, so if the user asks for that, return none.
9315	 */
9316	scsi_ulto4b(lun_datalen - 8, lun_data->length);
9317
9318	/*
9319	 * We can only return SCSI_STATUS_CHECK_COND when we can't satisfy
9320	 * this request.
9321	 */
9322	ctsio->scsi_status = SCSI_STATUS_OK;
9323
9324	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
9325	ctsio->be_move_done = ctl_config_move_done;
9326	ctl_datamove((union ctl_io *)ctsio);
9327
9328	return (retval);
9329}
9330
9331int
9332ctl_request_sense(struct ctl_scsiio *ctsio)
9333{
9334	struct scsi_request_sense *cdb;
9335	struct scsi_sense_data *sense_ptr;
9336	struct ctl_lun *lun;
9337	uint32_t initidx;
9338	int have_error;
9339	scsi_sense_data_type sense_format;
9340
9341	cdb = (struct scsi_request_sense *)ctsio->cdb;
9342
9343	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
9344
9345	CTL_DEBUG_PRINT(("ctl_request_sense\n"));
9346
9347	/*
9348	 * Determine which sense format the user wants.
9349	 */
9350	if (cdb->byte2 & SRS_DESC)
9351		sense_format = SSD_TYPE_DESC;
9352	else
9353		sense_format = SSD_TYPE_FIXED;
9354
9355	ctsio->kern_data_ptr = malloc(sizeof(*sense_ptr), M_CTL, M_WAITOK);
9356	sense_ptr = (struct scsi_sense_data *)ctsio->kern_data_ptr;
9357	ctsio->kern_sg_entries = 0;
9358
9359	/*
9360	 * struct scsi_sense_data, which is currently set to 256 bytes, is
9361	 * larger than the largest allowed value for the length field in the
9362	 * REQUEST SENSE CDB, which is 252 bytes as of SPC-4.
9363	 */
9364	ctsio->residual = 0;
9365	ctsio->kern_data_len = cdb->length;
9366	ctsio->kern_total_len = cdb->length;
9367
9368	ctsio->kern_data_resid = 0;
9369	ctsio->kern_rel_offset = 0;
9370	ctsio->kern_sg_entries = 0;
9371
9372	/*
9373	 * If we don't have a LUN, we don't have any pending sense.
9374	 */
9375	if (lun == NULL)
9376		goto no_sense;
9377
9378	have_error = 0;
9379	initidx = ctl_get_initindex(&ctsio->io_hdr.nexus);
9380	/*
9381	 * Check for pending sense, and then for pending unit attentions.
9382	 * Pending sense gets returned first, then pending unit attentions.
9383	 */
9384	mtx_lock(&lun->ctl_softc->ctl_lock);
9385	if (ctl_is_set(lun->have_ca, initidx)) {
9386		scsi_sense_data_type stored_format;
9387
9388		/*
9389		 * Check to see which sense format was used for the stored
9390		 * sense data.
9391		 */
9392		stored_format = scsi_sense_type(
9393		    &lun->pending_sense[initidx].sense);
9394
9395		/*
9396		 * If the user requested a different sense format than the
9397		 * one we stored, then we need to convert it to the other
9398		 * format.  If we're going from descriptor to fixed format
9399		 * sense data, we may lose things in translation, depending
9400		 * on what options were used.
9401		 *
9402		 * If the stored format is SSD_TYPE_NONE (i.e. invalid),
9403		 * for some reason we'll just copy it out as-is.
9404		 */
9405		if ((stored_format == SSD_TYPE_FIXED)
9406		 && (sense_format == SSD_TYPE_DESC))
9407			ctl_sense_to_desc((struct scsi_sense_data_fixed *)
9408			    &lun->pending_sense[initidx].sense,
9409			    (struct scsi_sense_data_desc *)sense_ptr);
9410		else if ((stored_format == SSD_TYPE_DESC)
9411		      && (sense_format == SSD_TYPE_FIXED))
9412			ctl_sense_to_fixed((struct scsi_sense_data_desc *)
9413			    &lun->pending_sense[initidx].sense,
9414			    (struct scsi_sense_data_fixed *)sense_ptr);
9415		else
9416			memcpy(sense_ptr, &lun->pending_sense[initidx].sense,
9417			       ctl_min(sizeof(*sense_ptr),
9418			       sizeof(lun->pending_sense[initidx].sense)));
9419
9420		ctl_clear_mask(lun->have_ca, initidx);
9421		have_error = 1;
9422	} else if (lun->pending_sense[initidx].ua_pending != CTL_UA_NONE) {
9423		ctl_ua_type ua_type;
9424
9425		ua_type = ctl_build_ua(lun->pending_sense[initidx].ua_pending,
9426				       sense_ptr, sense_format);
9427		if (ua_type != CTL_UA_NONE) {
9428			have_error = 1;
9429			/* We're reporting this UA, so clear it */
9430			lun->pending_sense[initidx].ua_pending &= ~ua_type;
9431		}
9432	}
9433	mtx_unlock(&lun->ctl_softc->ctl_lock);
9434
9435	/*
9436	 * We already have a pending error, return it.
9437	 */
9438	if (have_error != 0) {
9439		/*
9440		 * We report the SCSI status as OK, since the status of the
9441		 * request sense command itself is OK.
9442		 */
9443		ctsio->scsi_status = SCSI_STATUS_OK;
9444
9445		/*
9446		 * We report 0 for the sense length, because we aren't doing
9447		 * autosense in this case.  We're reporting sense as
9448		 * parameter data.
9449		 */
9450		ctsio->sense_len = 0;
9451		ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
9452		ctsio->be_move_done = ctl_config_move_done;
9453		ctl_datamove((union ctl_io *)ctsio);
9454
9455		return (CTL_RETVAL_COMPLETE);
9456	}
9457
9458no_sense:
9459
9460	/*
9461	 * No sense information to report, so we report that everything is
9462	 * okay.
9463	 */
9464	ctl_set_sense_data(sense_ptr,
9465			   lun,
9466			   sense_format,
9467			   /*current_error*/ 1,
9468			   /*sense_key*/ SSD_KEY_NO_SENSE,
9469			   /*asc*/ 0x00,
9470			   /*ascq*/ 0x00,
9471			   SSD_ELEM_NONE);
9472
9473	ctsio->scsi_status = SCSI_STATUS_OK;
9474
9475	/*
9476	 * We report 0 for the sense length, because we aren't doing
9477	 * autosense in this case.  We're reporting sense as parameter data.
9478	 */
9479	ctsio->sense_len = 0;
9480	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
9481	ctsio->be_move_done = ctl_config_move_done;
9482	ctl_datamove((union ctl_io *)ctsio);
9483
9484	return (CTL_RETVAL_COMPLETE);
9485}
9486
9487int
9488ctl_tur(struct ctl_scsiio *ctsio)
9489{
9490	struct ctl_lun *lun;
9491
9492	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
9493
9494	CTL_DEBUG_PRINT(("ctl_tur\n"));
9495
9496	if (lun == NULL)
9497		return (EINVAL);
9498
9499	ctsio->scsi_status = SCSI_STATUS_OK;
9500	ctsio->io_hdr.status = CTL_SUCCESS;
9501
9502	ctl_done((union ctl_io *)ctsio);
9503
9504	return (CTL_RETVAL_COMPLETE);
9505}
9506
9507#ifdef notyet
9508static int
9509ctl_cmddt_inquiry(struct ctl_scsiio *ctsio)
9510{
9511
9512}
9513#endif
9514
9515static int
9516ctl_inquiry_evpd_supported(struct ctl_scsiio *ctsio, int alloc_len)
9517{
9518	struct scsi_vpd_supported_pages *pages;
9519	int sup_page_size;
9520	struct ctl_lun *lun;
9521
9522	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
9523
9524	sup_page_size = sizeof(struct scsi_vpd_supported_pages) *
9525	    SCSI_EVPD_NUM_SUPPORTED_PAGES;
9526	ctsio->kern_data_ptr = malloc(sup_page_size, M_CTL, M_WAITOK | M_ZERO);
9527	pages = (struct scsi_vpd_supported_pages *)ctsio->kern_data_ptr;
9528	ctsio->kern_sg_entries = 0;
9529
9530	if (sup_page_size < alloc_len) {
9531		ctsio->residual = alloc_len - sup_page_size;
9532		ctsio->kern_data_len = sup_page_size;
9533		ctsio->kern_total_len = sup_page_size;
9534	} else {
9535		ctsio->residual = 0;
9536		ctsio->kern_data_len = alloc_len;
9537		ctsio->kern_total_len = alloc_len;
9538	}
9539	ctsio->kern_data_resid = 0;
9540	ctsio->kern_rel_offset = 0;
9541	ctsio->kern_sg_entries = 0;
9542
9543	/*
9544	 * The control device is always connected.  The disk device, on the
9545	 * other hand, may not be online all the time.  Need to change this
9546	 * to figure out whether the disk device is actually online or not.
9547	 */
9548	if (lun != NULL)
9549		pages->device = (SID_QUAL_LU_CONNECTED << 5) |
9550				lun->be_lun->lun_type;
9551	else
9552		pages->device = (SID_QUAL_LU_OFFLINE << 5) | T_DIRECT;
9553
9554	pages->length = SCSI_EVPD_NUM_SUPPORTED_PAGES;
9555	/* Supported VPD pages */
9556	pages->page_list[0] = SVPD_SUPPORTED_PAGES;
9557	/* Serial Number */
9558	pages->page_list[1] = SVPD_UNIT_SERIAL_NUMBER;
9559	/* Device Identification */
9560	pages->page_list[2] = SVPD_DEVICE_ID;
9561	/* Block limits */
9562	pages->page_list[3] = SVPD_BLOCK_LIMITS;
9563	/* Logical Block Provisioning */
9564	pages->page_list[4] = SVPD_LBP;
9565
9566	ctsio->scsi_status = SCSI_STATUS_OK;
9567
9568	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
9569	ctsio->be_move_done = ctl_config_move_done;
9570	ctl_datamove((union ctl_io *)ctsio);
9571
9572	return (CTL_RETVAL_COMPLETE);
9573}
9574
9575static int
9576ctl_inquiry_evpd_serial(struct ctl_scsiio *ctsio, int alloc_len)
9577{
9578	struct scsi_vpd_unit_serial_number *sn_ptr;
9579	struct ctl_lun *lun;
9580#ifndef CTL_USE_BACKEND_SN
9581	char tmpstr[32];
9582#endif
9583
9584	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
9585
9586	ctsio->kern_data_ptr = malloc(sizeof(*sn_ptr), M_CTL, M_WAITOK | M_ZERO);
9587	sn_ptr = (struct scsi_vpd_unit_serial_number *)ctsio->kern_data_ptr;
9588	ctsio->kern_sg_entries = 0;
9589
9590	if (sizeof(*sn_ptr) < alloc_len) {
9591		ctsio->residual = alloc_len - sizeof(*sn_ptr);
9592		ctsio->kern_data_len = sizeof(*sn_ptr);
9593		ctsio->kern_total_len = sizeof(*sn_ptr);
9594	} else {
9595		ctsio->residual = 0;
9596		ctsio->kern_data_len = alloc_len;
9597		ctsio->kern_total_len = alloc_len;
9598	}
9599	ctsio->kern_data_resid = 0;
9600	ctsio->kern_rel_offset = 0;
9601	ctsio->kern_sg_entries = 0;
9602
9603	/*
9604	 * The control device is always connected.  The disk device, on the
9605	 * other hand, may not be online all the time.  Need to change this
9606	 * to figure out whether the disk device is actually online or not.
9607	 */
9608	if (lun != NULL)
9609		sn_ptr->device = (SID_QUAL_LU_CONNECTED << 5) |
9610				  lun->be_lun->lun_type;
9611	else
9612		sn_ptr->device = (SID_QUAL_LU_OFFLINE << 5) | T_DIRECT;
9613
9614	sn_ptr->page_code = SVPD_UNIT_SERIAL_NUMBER;
9615	sn_ptr->length = ctl_min(sizeof(*sn_ptr) - 4, CTL_SN_LEN);
9616#ifdef CTL_USE_BACKEND_SN
9617	/*
9618	 * If we don't have a LUN, we just leave the serial number as
9619	 * all spaces.
9620	 */
9621	memset(sn_ptr->serial_num, 0x20, sizeof(sn_ptr->serial_num));
9622	if (lun != NULL) {
9623		strncpy((char *)sn_ptr->serial_num,
9624			(char *)lun->be_lun->serial_num, CTL_SN_LEN);
9625	}
9626#else
9627	/*
9628	 * Note that we're using a non-unique serial number here,
9629	 */
9630	snprintf(tmpstr, sizeof(tmpstr), "MYSERIALNUMIS000");
9631	memset(sn_ptr->serial_num, 0x20, sizeof(sn_ptr->serial_num));
9632	strncpy(sn_ptr->serial_num, tmpstr, ctl_min(CTL_SN_LEN,
9633		ctl_min(sizeof(tmpstr), sizeof(*sn_ptr) - 4)));
9634#endif
9635	ctsio->scsi_status = SCSI_STATUS_OK;
9636
9637	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
9638	ctsio->be_move_done = ctl_config_move_done;
9639	ctl_datamove((union ctl_io *)ctsio);
9640
9641	return (CTL_RETVAL_COMPLETE);
9642}
9643
9644
9645static int
9646ctl_inquiry_evpd_devid(struct ctl_scsiio *ctsio, int alloc_len)
9647{
9648	struct scsi_vpd_device_id *devid_ptr;
9649	struct scsi_vpd_id_descriptor *desc, *desc1;
9650	struct scsi_vpd_id_descriptor *desc2, *desc3; /* for types 4h and 5h */
9651	struct scsi_vpd_id_t10 *t10id;
9652	struct ctl_softc *ctl_softc;
9653	struct ctl_lun *lun;
9654	struct ctl_frontend *fe;
9655	char *val;
9656#ifndef CTL_USE_BACKEND_SN
9657	char tmpstr[32];
9658#endif /* CTL_USE_BACKEND_SN */
9659	int devid_len;
9660
9661	ctl_softc = control_softc;
9662
9663	mtx_lock(&ctl_softc->ctl_lock);
9664	fe = ctl_softc->ctl_ports[ctl_port_idx(ctsio->io_hdr.nexus.targ_port)];
9665	mtx_unlock(&ctl_softc->ctl_lock);
9666
9667	if (fe->devid != NULL)
9668		return ((fe->devid)(ctsio, alloc_len));
9669
9670	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
9671
9672	devid_len = sizeof(struct scsi_vpd_device_id) +
9673		sizeof(struct scsi_vpd_id_descriptor) +
9674		sizeof(struct scsi_vpd_id_t10) + CTL_DEVID_LEN +
9675		sizeof(struct scsi_vpd_id_descriptor) + CTL_WWPN_LEN +
9676		sizeof(struct scsi_vpd_id_descriptor) +
9677		sizeof(struct scsi_vpd_id_rel_trgt_port_id) +
9678		sizeof(struct scsi_vpd_id_descriptor) +
9679		sizeof(struct scsi_vpd_id_trgt_port_grp_id);
9680
9681	ctsio->kern_data_ptr = malloc(devid_len, M_CTL, M_WAITOK | M_ZERO);
9682	devid_ptr = (struct scsi_vpd_device_id *)ctsio->kern_data_ptr;
9683	ctsio->kern_sg_entries = 0;
9684
9685	if (devid_len < alloc_len) {
9686		ctsio->residual = alloc_len - devid_len;
9687		ctsio->kern_data_len = devid_len;
9688		ctsio->kern_total_len = devid_len;
9689	} else {
9690		ctsio->residual = 0;
9691		ctsio->kern_data_len = alloc_len;
9692		ctsio->kern_total_len = alloc_len;
9693	}
9694	ctsio->kern_data_resid = 0;
9695	ctsio->kern_rel_offset = 0;
9696	ctsio->kern_sg_entries = 0;
9697
9698	desc = (struct scsi_vpd_id_descriptor *)devid_ptr->desc_list;
9699	t10id = (struct scsi_vpd_id_t10 *)&desc->identifier[0];
9700	desc1 = (struct scsi_vpd_id_descriptor *)(&desc->identifier[0] +
9701		sizeof(struct scsi_vpd_id_t10) + CTL_DEVID_LEN);
9702	desc2 = (struct scsi_vpd_id_descriptor *)(&desc1->identifier[0] +
9703	          CTL_WWPN_LEN);
9704	desc3 = (struct scsi_vpd_id_descriptor *)(&desc2->identifier[0] +
9705	         sizeof(struct scsi_vpd_id_rel_trgt_port_id));
9706
9707	/*
9708	 * The control device is always connected.  The disk device, on the
9709	 * other hand, may not be online all the time.
9710	 */
9711	if (lun != NULL)
9712		devid_ptr->device = (SID_QUAL_LU_CONNECTED << 5) |
9713				     lun->be_lun->lun_type;
9714	else
9715		devid_ptr->device = (SID_QUAL_LU_OFFLINE << 5) | T_DIRECT;
9716
9717	devid_ptr->page_code = SVPD_DEVICE_ID;
9718
9719	scsi_ulto2b(devid_len - 4, devid_ptr->length);
9720
9721	mtx_lock(&ctl_softc->ctl_lock);
9722
9723	/*
9724	 * For Fibre channel,
9725	 */
9726	if (fe->port_type == CTL_PORT_FC)
9727	{
9728		desc->proto_codeset = (SCSI_PROTO_FC << 4) |
9729				      SVPD_ID_CODESET_ASCII;
9730        	desc1->proto_codeset = (SCSI_PROTO_FC << 4) |
9731		              SVPD_ID_CODESET_BINARY;
9732	}
9733	else
9734	{
9735		desc->proto_codeset = (SCSI_PROTO_SPI << 4) |
9736				      SVPD_ID_CODESET_ASCII;
9737        	desc1->proto_codeset = (SCSI_PROTO_SPI << 4) |
9738		              SVPD_ID_CODESET_BINARY;
9739	}
9740	desc2->proto_codeset = desc3->proto_codeset = desc1->proto_codeset;
9741	mtx_unlock(&ctl_softc->ctl_lock);
9742
9743	/*
9744	 * We're using a LUN association here.  i.e., this device ID is a
9745	 * per-LUN identifier.
9746	 */
9747	desc->id_type = SVPD_ID_PIV | SVPD_ID_ASSOC_LUN | SVPD_ID_TYPE_T10;
9748	desc->length = sizeof(*t10id) + CTL_DEVID_LEN;
9749	if (lun == NULL || (val = ctl_get_opt(lun->be_lun, "vendor")) == NULL) {
9750		strncpy((char *)t10id->vendor, CTL_VENDOR, sizeof(t10id->vendor));
9751	} else {
9752		memset(t10id->vendor, ' ', sizeof(t10id->vendor));
9753		strncpy(t10id->vendor, val,
9754		    min(sizeof(t10id->vendor), strlen(val)));
9755	}
9756
9757	/*
9758	 * desc1 is for the WWPN which is a port asscociation.
9759	 */
9760	desc1->id_type = SVPD_ID_PIV | SVPD_ID_ASSOC_PORT | SVPD_ID_TYPE_NAA;
9761	desc1->length = CTL_WWPN_LEN;
9762	/* XXX Call Reggie's get_WWNN func here then add port # to the end */
9763	/* For testing just create the WWPN */
9764#if 0
9765	ddb_GetWWNN((char *)desc1->identifier);
9766
9767	/* NOTE: if the port is 0 or 8 we don't want to subtract 1 */
9768	/* This is so Copancontrol will return something sane */
9769	if (ctsio->io_hdr.nexus.targ_port!=0 &&
9770	    ctsio->io_hdr.nexus.targ_port!=8)
9771		desc1->identifier[7] += ctsio->io_hdr.nexus.targ_port-1;
9772	else
9773		desc1->identifier[7] += ctsio->io_hdr.nexus.targ_port;
9774#endif
9775
9776	be64enc(desc1->identifier, fe->wwpn);
9777
9778	/*
9779	 * desc2 is for the Relative Target Port(type 4h) identifier
9780	 */
9781	desc2->id_type = SVPD_ID_PIV | SVPD_ID_ASSOC_PORT
9782	                 | SVPD_ID_TYPE_RELTARG;
9783	desc2->length = 4;
9784//#if 0
9785	/* NOTE: if the port is 0 or 8 we don't want to subtract 1 */
9786	/* This is so Copancontrol will return something sane */
9787	if (ctsio->io_hdr.nexus.targ_port!=0 &&
9788	    ctsio->io_hdr.nexus.targ_port!=8)
9789		desc2->identifier[3] = ctsio->io_hdr.nexus.targ_port - 1;
9790	else
9791	        desc2->identifier[3] = ctsio->io_hdr.nexus.targ_port;
9792//#endif
9793
9794	/*
9795	 * desc3 is for the Target Port Group(type 5h) identifier
9796	 */
9797	desc3->id_type = SVPD_ID_PIV | SVPD_ID_ASSOC_PORT
9798	                 | SVPD_ID_TYPE_TPORTGRP;
9799	desc3->length = 4;
9800	if (ctsio->io_hdr.nexus.targ_port < CTL_MAX_PORTS || ctl_is_single)
9801		desc3->identifier[3] = 1;
9802	else
9803		desc3->identifier[3] = 2;
9804
9805#ifdef CTL_USE_BACKEND_SN
9806	/*
9807	 * If we've actually got a backend, copy the device id from the
9808	 * per-LUN data.  Otherwise, set it to all spaces.
9809	 */
9810	if (lun != NULL) {
9811		/*
9812		 * Copy the backend's LUN ID.
9813		 */
9814		strncpy((char *)t10id->vendor_spec_id,
9815			(char *)lun->be_lun->device_id, CTL_DEVID_LEN);
9816	} else {
9817		/*
9818		 * No backend, set this to spaces.
9819		 */
9820		memset(t10id->vendor_spec_id, 0x20, CTL_DEVID_LEN);
9821	}
9822#else
9823	snprintf(tmpstr, sizeof(tmpstr), "MYDEVICEIDIS%4d",
9824		 (lun != NULL) ?  (int)lun->lun : 0);
9825	strncpy(t10id->vendor_spec_id, tmpstr, ctl_min(CTL_DEVID_LEN,
9826		sizeof(tmpstr)));
9827#endif
9828
9829	ctsio->scsi_status = SCSI_STATUS_OK;
9830
9831	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
9832	ctsio->be_move_done = ctl_config_move_done;
9833	ctl_datamove((union ctl_io *)ctsio);
9834
9835	return (CTL_RETVAL_COMPLETE);
9836}
9837
9838static int
9839ctl_inquiry_evpd_block_limits(struct ctl_scsiio *ctsio, int alloc_len)
9840{
9841	struct scsi_vpd_block_limits *bl_ptr;
9842	struct ctl_lun *lun;
9843	int bs;
9844
9845	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
9846	bs = lun->be_lun->blocksize;
9847
9848	ctsio->kern_data_ptr = malloc(sizeof(*bl_ptr), M_CTL, M_WAITOK | M_ZERO);
9849	bl_ptr = (struct scsi_vpd_block_limits *)ctsio->kern_data_ptr;
9850	ctsio->kern_sg_entries = 0;
9851
9852	if (sizeof(*bl_ptr) < alloc_len) {
9853		ctsio->residual = alloc_len - sizeof(*bl_ptr);
9854		ctsio->kern_data_len = sizeof(*bl_ptr);
9855		ctsio->kern_total_len = sizeof(*bl_ptr);
9856	} else {
9857		ctsio->residual = 0;
9858		ctsio->kern_data_len = alloc_len;
9859		ctsio->kern_total_len = alloc_len;
9860	}
9861	ctsio->kern_data_resid = 0;
9862	ctsio->kern_rel_offset = 0;
9863	ctsio->kern_sg_entries = 0;
9864
9865	/*
9866	 * The control device is always connected.  The disk device, on the
9867	 * other hand, may not be online all the time.  Need to change this
9868	 * to figure out whether the disk device is actually online or not.
9869	 */
9870	if (lun != NULL)
9871		bl_ptr->device = (SID_QUAL_LU_CONNECTED << 5) |
9872				  lun->be_lun->lun_type;
9873	else
9874		bl_ptr->device = (SID_QUAL_LU_OFFLINE << 5) | T_DIRECT;
9875
9876	bl_ptr->page_code = SVPD_BLOCK_LIMITS;
9877	scsi_ulto2b(sizeof(*bl_ptr), bl_ptr->page_length);
9878	bl_ptr->max_cmp_write_len = 0xff;
9879	scsi_ulto4b(0xffffffff, bl_ptr->max_txfer_len);
9880	scsi_ulto4b(MAXPHYS / bs, bl_ptr->opt_txfer_len);
9881	if (lun->be_lun->flags & CTL_LUN_FLAG_UNMAP) {
9882		scsi_ulto4b(0xffffffff, bl_ptr->max_unmap_lba_cnt);
9883		scsi_ulto4b(0xffffffff, bl_ptr->max_unmap_blk_cnt);
9884	}
9885	scsi_u64to8b(UINT64_MAX, bl_ptr->max_write_same_length);
9886
9887	ctsio->scsi_status = SCSI_STATUS_OK;
9888	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
9889	ctsio->be_move_done = ctl_config_move_done;
9890	ctl_datamove((union ctl_io *)ctsio);
9891
9892	return (CTL_RETVAL_COMPLETE);
9893}
9894
9895static int
9896ctl_inquiry_evpd_lbp(struct ctl_scsiio *ctsio, int alloc_len)
9897{
9898	struct scsi_vpd_logical_block_prov *lbp_ptr;
9899	struct ctl_lun *lun;
9900	int bs;
9901
9902	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
9903	bs = lun->be_lun->blocksize;
9904
9905	ctsio->kern_data_ptr = malloc(sizeof(*lbp_ptr), M_CTL, M_WAITOK | M_ZERO);
9906	lbp_ptr = (struct scsi_vpd_logical_block_prov *)ctsio->kern_data_ptr;
9907	ctsio->kern_sg_entries = 0;
9908
9909	if (sizeof(*lbp_ptr) < alloc_len) {
9910		ctsio->residual = alloc_len - sizeof(*lbp_ptr);
9911		ctsio->kern_data_len = sizeof(*lbp_ptr);
9912		ctsio->kern_total_len = sizeof(*lbp_ptr);
9913	} else {
9914		ctsio->residual = 0;
9915		ctsio->kern_data_len = alloc_len;
9916		ctsio->kern_total_len = alloc_len;
9917	}
9918	ctsio->kern_data_resid = 0;
9919	ctsio->kern_rel_offset = 0;
9920	ctsio->kern_sg_entries = 0;
9921
9922	/*
9923	 * The control device is always connected.  The disk device, on the
9924	 * other hand, may not be online all the time.  Need to change this
9925	 * to figure out whether the disk device is actually online or not.
9926	 */
9927	if (lun != NULL)
9928		lbp_ptr->device = (SID_QUAL_LU_CONNECTED << 5) |
9929				  lun->be_lun->lun_type;
9930	else
9931		lbp_ptr->device = (SID_QUAL_LU_OFFLINE << 5) | T_DIRECT;
9932
9933	lbp_ptr->page_code = SVPD_LBP;
9934	if (lun->be_lun->flags & CTL_LUN_FLAG_UNMAP)
9935		lbp_ptr->flags = SVPD_LBP_UNMAP | SVPD_LBP_WS16 | SVPD_LBP_WS10;
9936
9937	ctsio->scsi_status = SCSI_STATUS_OK;
9938	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
9939	ctsio->be_move_done = ctl_config_move_done;
9940	ctl_datamove((union ctl_io *)ctsio);
9941
9942	return (CTL_RETVAL_COMPLETE);
9943}
9944
9945static int
9946ctl_inquiry_evpd(struct ctl_scsiio *ctsio)
9947{
9948	struct scsi_inquiry *cdb;
9949	struct ctl_lun *lun;
9950	int alloc_len, retval;
9951
9952	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
9953	cdb = (struct scsi_inquiry *)ctsio->cdb;
9954
9955	retval = CTL_RETVAL_COMPLETE;
9956
9957	alloc_len = scsi_2btoul(cdb->length);
9958
9959	switch (cdb->page_code) {
9960	case SVPD_SUPPORTED_PAGES:
9961		retval = ctl_inquiry_evpd_supported(ctsio, alloc_len);
9962		break;
9963	case SVPD_UNIT_SERIAL_NUMBER:
9964		retval = ctl_inquiry_evpd_serial(ctsio, alloc_len);
9965		break;
9966	case SVPD_DEVICE_ID:
9967		retval = ctl_inquiry_evpd_devid(ctsio, alloc_len);
9968		break;
9969	case SVPD_BLOCK_LIMITS:
9970		retval = ctl_inquiry_evpd_block_limits(ctsio, alloc_len);
9971		break;
9972	case SVPD_LBP:
9973		retval = ctl_inquiry_evpd_lbp(ctsio, alloc_len);
9974		break;
9975	default:
9976		ctl_set_invalid_field(ctsio,
9977				      /*sks_valid*/ 1,
9978				      /*command*/ 1,
9979				      /*field*/ 2,
9980				      /*bit_valid*/ 0,
9981				      /*bit*/ 0);
9982		ctl_done((union ctl_io *)ctsio);
9983		retval = CTL_RETVAL_COMPLETE;
9984		break;
9985	}
9986
9987	return (retval);
9988}
9989
9990static int
9991ctl_inquiry_std(struct ctl_scsiio *ctsio)
9992{
9993	struct scsi_inquiry_data *inq_ptr;
9994	struct scsi_inquiry *cdb;
9995	struct ctl_softc *ctl_softc;
9996	struct ctl_lun *lun;
9997	char *val;
9998	uint32_t alloc_len;
9999	int is_fc;
10000
10001	ctl_softc = control_softc;
10002
10003	/*
10004	 * Figure out whether we're talking to a Fibre Channel port or not.
10005	 * We treat the ioctl front end, and any SCSI adapters, as packetized
10006	 * SCSI front ends.
10007	 */
10008	mtx_lock(&ctl_softc->ctl_lock);
10009	if (ctl_softc->ctl_ports[ctl_port_idx(ctsio->io_hdr.nexus.targ_port)]->port_type !=
10010	    CTL_PORT_FC)
10011		is_fc = 0;
10012	else
10013		is_fc = 1;
10014	mtx_unlock(&ctl_softc->ctl_lock);
10015
10016	lun = ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
10017	cdb = (struct scsi_inquiry *)ctsio->cdb;
10018	alloc_len = scsi_2btoul(cdb->length);
10019
10020	/*
10021	 * We malloc the full inquiry data size here and fill it
10022	 * in.  If the user only asks for less, we'll give him
10023	 * that much.
10024	 */
10025	ctsio->kern_data_ptr = malloc(sizeof(*inq_ptr), M_CTL, M_WAITOK | M_ZERO);
10026	inq_ptr = (struct scsi_inquiry_data *)ctsio->kern_data_ptr;
10027	ctsio->kern_sg_entries = 0;
10028	ctsio->kern_data_resid = 0;
10029	ctsio->kern_rel_offset = 0;
10030
10031	if (sizeof(*inq_ptr) < alloc_len) {
10032		ctsio->residual = alloc_len - sizeof(*inq_ptr);
10033		ctsio->kern_data_len = sizeof(*inq_ptr);
10034		ctsio->kern_total_len = sizeof(*inq_ptr);
10035	} else {
10036		ctsio->residual = 0;
10037		ctsio->kern_data_len = alloc_len;
10038		ctsio->kern_total_len = alloc_len;
10039	}
10040
10041	/*
10042	 * If we have a LUN configured, report it as connected.  Otherwise,
10043	 * report that it is offline or no device is supported, depending
10044	 * on the value of inquiry_pq_no_lun.
10045	 *
10046	 * According to the spec (SPC-4 r34), the peripheral qualifier
10047	 * SID_QUAL_LU_OFFLINE (001b) is used in the following scenario:
10048	 *
10049	 * "A peripheral device having the specified peripheral device type
10050	 * is not connected to this logical unit. However, the device
10051	 * server is capable of supporting the specified peripheral device
10052	 * type on this logical unit."
10053	 *
10054	 * According to the same spec, the peripheral qualifier
10055	 * SID_QUAL_BAD_LU (011b) is used in this scenario:
10056	 *
10057	 * "The device server is not capable of supporting a peripheral
10058	 * device on this logical unit. For this peripheral qualifier the
10059	 * peripheral device type shall be set to 1Fh. All other peripheral
10060	 * device type values are reserved for this peripheral qualifier."
10061	 *
10062	 * Given the text, it would seem that we probably want to report that
10063	 * the LUN is offline here.  There is no LUN connected, but we can
10064	 * support a LUN at the given LUN number.
10065	 *
10066	 * In the real world, though, it sounds like things are a little
10067	 * different:
10068	 *
10069	 * - Linux, when presented with a LUN with the offline peripheral
10070	 *   qualifier, will create an sg driver instance for it.  So when
10071	 *   you attach it to CTL, you wind up with a ton of sg driver
10072	 *   instances.  (One for every LUN that Linux bothered to probe.)
10073	 *   Linux does this despite the fact that it issues a REPORT LUNs
10074	 *   to LUN 0 to get the inventory of supported LUNs.
10075	 *
10076	 * - There is other anecdotal evidence (from Emulex folks) about
10077	 *   arrays that use the offline peripheral qualifier for LUNs that
10078	 *   are on the "passive" path in an active/passive array.
10079	 *
10080	 * So the solution is provide a hopefully reasonable default
10081	 * (return bad/no LUN) and allow the user to change the behavior
10082	 * with a tunable/sysctl variable.
10083	 */
10084	if (lun != NULL)
10085		inq_ptr->device = (SID_QUAL_LU_CONNECTED << 5) |
10086				  lun->be_lun->lun_type;
10087	else if (ctl_softc->inquiry_pq_no_lun == 0)
10088		inq_ptr->device = (SID_QUAL_LU_OFFLINE << 5) | T_DIRECT;
10089	else
10090		inq_ptr->device = (SID_QUAL_BAD_LU << 5) | T_NODEVICE;
10091
10092	/* RMB in byte 2 is 0 */
10093	inq_ptr->version = SCSI_REV_SPC3;
10094
10095	/*
10096	 * According to SAM-3, even if a device only supports a single
10097	 * level of LUN addressing, it should still set the HISUP bit:
10098	 *
10099	 * 4.9.1 Logical unit numbers overview
10100	 *
10101	 * All logical unit number formats described in this standard are
10102	 * hierarchical in structure even when only a single level in that
10103	 * hierarchy is used. The HISUP bit shall be set to one in the
10104	 * standard INQUIRY data (see SPC-2) when any logical unit number
10105	 * format described in this standard is used.  Non-hierarchical
10106	 * formats are outside the scope of this standard.
10107	 *
10108	 * Therefore we set the HiSup bit here.
10109	 *
10110	 * The reponse format is 2, per SPC-3.
10111	 */
10112	inq_ptr->response_format = SID_HiSup | 2;
10113
10114	inq_ptr->additional_length = sizeof(*inq_ptr) - 4;
10115	CTL_DEBUG_PRINT(("additional_length = %d\n",
10116			 inq_ptr->additional_length));
10117
10118	inq_ptr->spc3_flags = SPC3_SID_TPGS_IMPLICIT;
10119	/* 16 bit addressing */
10120	if (is_fc == 0)
10121		inq_ptr->spc2_flags = SPC2_SID_ADDR16;
10122	/* XXX set the SID_MultiP bit here if we're actually going to
10123	   respond on multiple ports */
10124	inq_ptr->spc2_flags |= SPC2_SID_MultiP;
10125
10126	/* 16 bit data bus, synchronous transfers */
10127	/* XXX these flags don't apply for FC */
10128	if (is_fc == 0)
10129		inq_ptr->flags = SID_WBus16 | SID_Sync;
10130	/*
10131	 * XXX KDM do we want to support tagged queueing on the control
10132	 * device at all?
10133	 */
10134	if ((lun == NULL)
10135	 || (lun->be_lun->lun_type != T_PROCESSOR))
10136		inq_ptr->flags |= SID_CmdQue;
10137	/*
10138	 * Per SPC-3, unused bytes in ASCII strings are filled with spaces.
10139	 * We have 8 bytes for the vendor name, and 16 bytes for the device
10140	 * name and 4 bytes for the revision.
10141	 */
10142	if (lun == NULL || (val = ctl_get_opt(lun->be_lun, "vendor")) == NULL) {
10143		strcpy(inq_ptr->vendor, CTL_VENDOR);
10144	} else {
10145		memset(inq_ptr->vendor, ' ', sizeof(inq_ptr->vendor));
10146		strncpy(inq_ptr->vendor, val,
10147		    min(sizeof(inq_ptr->vendor), strlen(val)));
10148	}
10149	if (lun == NULL) {
10150		strcpy(inq_ptr->product, CTL_DIRECT_PRODUCT);
10151	} else if ((val = ctl_get_opt(lun->be_lun, "product")) == NULL) {
10152		switch (lun->be_lun->lun_type) {
10153		case T_DIRECT:
10154			strcpy(inq_ptr->product, CTL_DIRECT_PRODUCT);
10155			break;
10156		case T_PROCESSOR:
10157			strcpy(inq_ptr->product, CTL_PROCESSOR_PRODUCT);
10158			break;
10159		default:
10160			strcpy(inq_ptr->product, CTL_UNKNOWN_PRODUCT);
10161			break;
10162		}
10163	} else {
10164		memset(inq_ptr->product, ' ', sizeof(inq_ptr->product));
10165		strncpy(inq_ptr->product, val,
10166		    min(sizeof(inq_ptr->product), strlen(val)));
10167	}
10168
10169	/*
10170	 * XXX make this a macro somewhere so it automatically gets
10171	 * incremented when we make changes.
10172	 */
10173	if (lun == NULL || (val = ctl_get_opt(lun->be_lun, "revision")) == NULL) {
10174		strncpy(inq_ptr->revision, "0001", sizeof(inq_ptr->revision));
10175	} else {
10176		memset(inq_ptr->revision, ' ', sizeof(inq_ptr->revision));
10177		strncpy(inq_ptr->revision, val,
10178		    min(sizeof(inq_ptr->revision), strlen(val)));
10179	}
10180
10181	/*
10182	 * For parallel SCSI, we support double transition and single
10183	 * transition clocking.  We also support QAS (Quick Arbitration
10184	 * and Selection) and Information Unit transfers on both the
10185	 * control and array devices.
10186	 */
10187	if (is_fc == 0)
10188		inq_ptr->spi3data = SID_SPI_CLOCK_DT_ST | SID_SPI_QAS |
10189				    SID_SPI_IUS;
10190
10191	/* SAM-3 */
10192	scsi_ulto2b(0x0060, inq_ptr->version1);
10193	/* SPC-3 (no version claimed) XXX should we claim a version? */
10194	scsi_ulto2b(0x0300, inq_ptr->version2);
10195	if (is_fc) {
10196		/* FCP-2 ANSI INCITS.350:2003 */
10197		scsi_ulto2b(0x0917, inq_ptr->version3);
10198	} else {
10199		/* SPI-4 ANSI INCITS.362:200x */
10200		scsi_ulto2b(0x0B56, inq_ptr->version3);
10201	}
10202
10203	if (lun == NULL) {
10204		/* SBC-2 (no version claimed) XXX should we claim a version? */
10205		scsi_ulto2b(0x0320, inq_ptr->version4);
10206	} else {
10207		switch (lun->be_lun->lun_type) {
10208		case T_DIRECT:
10209			/*
10210			 * SBC-2 (no version claimed) XXX should we claim a
10211			 * version?
10212			 */
10213			scsi_ulto2b(0x0320, inq_ptr->version4);
10214			break;
10215		case T_PROCESSOR:
10216		default:
10217			break;
10218		}
10219	}
10220
10221	ctsio->scsi_status = SCSI_STATUS_OK;
10222	if (ctsio->kern_data_len > 0) {
10223		ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
10224		ctsio->be_move_done = ctl_config_move_done;
10225		ctl_datamove((union ctl_io *)ctsio);
10226	} else {
10227		ctsio->io_hdr.status = CTL_SUCCESS;
10228		ctl_done((union ctl_io *)ctsio);
10229	}
10230
10231	return (CTL_RETVAL_COMPLETE);
10232}
10233
10234int
10235ctl_inquiry(struct ctl_scsiio *ctsio)
10236{
10237	struct scsi_inquiry *cdb;
10238	int retval;
10239
10240	cdb = (struct scsi_inquiry *)ctsio->cdb;
10241
10242	retval = 0;
10243
10244	CTL_DEBUG_PRINT(("ctl_inquiry\n"));
10245
10246	/*
10247	 * Right now, we don't support the CmdDt inquiry information.
10248	 * This would be nice to support in the future.  When we do
10249	 * support it, we should change this test so that it checks to make
10250	 * sure SI_EVPD and SI_CMDDT aren't both set at the same time.
10251	 */
10252#ifdef notyet
10253	if (((cdb->byte2 & SI_EVPD)
10254	 && (cdb->byte2 & SI_CMDDT)))
10255#endif
10256	if (cdb->byte2 & SI_CMDDT) {
10257		/*
10258		 * Point to the SI_CMDDT bit.  We might change this
10259		 * when we support SI_CMDDT, but since both bits would be
10260		 * "wrong", this should probably just stay as-is then.
10261		 */
10262		ctl_set_invalid_field(ctsio,
10263				      /*sks_valid*/ 1,
10264				      /*command*/ 1,
10265				      /*field*/ 1,
10266				      /*bit_valid*/ 1,
10267				      /*bit*/ 1);
10268		ctl_done((union ctl_io *)ctsio);
10269		return (CTL_RETVAL_COMPLETE);
10270	}
10271	if (cdb->byte2 & SI_EVPD)
10272		retval = ctl_inquiry_evpd(ctsio);
10273#ifdef notyet
10274	else if (cdb->byte2 & SI_CMDDT)
10275		retval = ctl_inquiry_cmddt(ctsio);
10276#endif
10277	else
10278		retval = ctl_inquiry_std(ctsio);
10279
10280	return (retval);
10281}
10282
10283/*
10284 * For known CDB types, parse the LBA and length.
10285 */
10286static int
10287ctl_get_lba_len(union ctl_io *io, uint64_t *lba, uint32_t *len)
10288{
10289	if (io->io_hdr.io_type != CTL_IO_SCSI)
10290		return (1);
10291
10292	switch (io->scsiio.cdb[0]) {
10293	case COMPARE_AND_WRITE: {
10294		struct scsi_compare_and_write *cdb;
10295
10296		cdb = (struct scsi_compare_and_write *)io->scsiio.cdb;
10297
10298		*lba = scsi_8btou64(cdb->addr);
10299		*len = cdb->length;
10300		break;
10301	}
10302	case READ_6:
10303	case WRITE_6: {
10304		struct scsi_rw_6 *cdb;
10305
10306		cdb = (struct scsi_rw_6 *)io->scsiio.cdb;
10307
10308		*lba = scsi_3btoul(cdb->addr);
10309		/* only 5 bits are valid in the most significant address byte */
10310		*lba &= 0x1fffff;
10311		*len = cdb->length;
10312		break;
10313	}
10314	case READ_10:
10315	case WRITE_10: {
10316		struct scsi_rw_10 *cdb;
10317
10318		cdb = (struct scsi_rw_10 *)io->scsiio.cdb;
10319
10320		*lba = scsi_4btoul(cdb->addr);
10321		*len = scsi_2btoul(cdb->length);
10322		break;
10323	}
10324	case WRITE_VERIFY_10: {
10325		struct scsi_write_verify_10 *cdb;
10326
10327		cdb = (struct scsi_write_verify_10 *)io->scsiio.cdb;
10328
10329		*lba = scsi_4btoul(cdb->addr);
10330		*len = scsi_2btoul(cdb->length);
10331		break;
10332	}
10333	case READ_12:
10334	case WRITE_12: {
10335		struct scsi_rw_12 *cdb;
10336
10337		cdb = (struct scsi_rw_12 *)io->scsiio.cdb;
10338
10339		*lba = scsi_4btoul(cdb->addr);
10340		*len = scsi_4btoul(cdb->length);
10341		break;
10342	}
10343	case WRITE_VERIFY_12: {
10344		struct scsi_write_verify_12 *cdb;
10345
10346		cdb = (struct scsi_write_verify_12 *)io->scsiio.cdb;
10347
10348		*lba = scsi_4btoul(cdb->addr);
10349		*len = scsi_4btoul(cdb->length);
10350		break;
10351	}
10352	case READ_16:
10353	case WRITE_16: {
10354		struct scsi_rw_16 *cdb;
10355
10356		cdb = (struct scsi_rw_16 *)io->scsiio.cdb;
10357
10358		*lba = scsi_8btou64(cdb->addr);
10359		*len = scsi_4btoul(cdb->length);
10360		break;
10361	}
10362	case WRITE_VERIFY_16: {
10363		struct scsi_write_verify_16 *cdb;
10364
10365		cdb = (struct scsi_write_verify_16 *)io->scsiio.cdb;
10366
10367
10368		*lba = scsi_8btou64(cdb->addr);
10369		*len = scsi_4btoul(cdb->length);
10370		break;
10371	}
10372	case WRITE_SAME_10: {
10373		struct scsi_write_same_10 *cdb;
10374
10375		cdb = (struct scsi_write_same_10 *)io->scsiio.cdb;
10376
10377		*lba = scsi_4btoul(cdb->addr);
10378		*len = scsi_2btoul(cdb->length);
10379		break;
10380	}
10381	case WRITE_SAME_16: {
10382		struct scsi_write_same_16 *cdb;
10383
10384		cdb = (struct scsi_write_same_16 *)io->scsiio.cdb;
10385
10386		*lba = scsi_8btou64(cdb->addr);
10387		*len = scsi_4btoul(cdb->length);
10388		break;
10389	}
10390	case VERIFY_10: {
10391		struct scsi_verify_10 *cdb;
10392
10393		cdb = (struct scsi_verify_10 *)io->scsiio.cdb;
10394
10395		*lba = scsi_4btoul(cdb->addr);
10396		*len = scsi_2btoul(cdb->length);
10397		break;
10398	}
10399	case VERIFY_12: {
10400		struct scsi_verify_12 *cdb;
10401
10402		cdb = (struct scsi_verify_12 *)io->scsiio.cdb;
10403
10404		*lba = scsi_4btoul(cdb->addr);
10405		*len = scsi_4btoul(cdb->length);
10406		break;
10407	}
10408	case VERIFY_16: {
10409		struct scsi_verify_16 *cdb;
10410
10411		cdb = (struct scsi_verify_16 *)io->scsiio.cdb;
10412
10413		*lba = scsi_8btou64(cdb->addr);
10414		*len = scsi_4btoul(cdb->length);
10415		break;
10416	}
10417	default:
10418		return (1);
10419		break; /* NOTREACHED */
10420	}
10421
10422	return (0);
10423}
10424
10425static ctl_action
10426ctl_extent_check_lba(uint64_t lba1, uint32_t len1, uint64_t lba2, uint32_t len2)
10427{
10428	uint64_t endlba1, endlba2;
10429
10430	endlba1 = lba1 + len1 - 1;
10431	endlba2 = lba2 + len2 - 1;
10432
10433	if ((endlba1 < lba2)
10434	 || (endlba2 < lba1))
10435		return (CTL_ACTION_PASS);
10436	else
10437		return (CTL_ACTION_BLOCK);
10438}
10439
10440static ctl_action
10441ctl_extent_check(union ctl_io *io1, union ctl_io *io2)
10442{
10443	uint64_t lba1, lba2;
10444	uint32_t len1, len2;
10445	int retval;
10446
10447	retval = ctl_get_lba_len(io1, &lba1, &len1);
10448	if (retval != 0)
10449		return (CTL_ACTION_ERROR);
10450
10451	retval = ctl_get_lba_len(io2, &lba2, &len2);
10452	if (retval != 0)
10453		return (CTL_ACTION_ERROR);
10454
10455	return (ctl_extent_check_lba(lba1, len1, lba2, len2));
10456}
10457
10458static ctl_action
10459ctl_check_for_blockage(union ctl_io *pending_io, union ctl_io *ooa_io)
10460{
10461	struct ctl_cmd_entry *pending_entry, *ooa_entry;
10462	ctl_serialize_action *serialize_row;
10463
10464	/*
10465	 * The initiator attempted multiple untagged commands at the same
10466	 * time.  Can't do that.
10467	 */
10468	if ((pending_io->scsiio.tag_type == CTL_TAG_UNTAGGED)
10469	 && (ooa_io->scsiio.tag_type == CTL_TAG_UNTAGGED)
10470	 && ((pending_io->io_hdr.nexus.targ_port ==
10471	      ooa_io->io_hdr.nexus.targ_port)
10472	  && (pending_io->io_hdr.nexus.initid.id ==
10473	      ooa_io->io_hdr.nexus.initid.id))
10474	 && ((ooa_io->io_hdr.flags & CTL_FLAG_ABORT) == 0))
10475		return (CTL_ACTION_OVERLAP);
10476
10477	/*
10478	 * The initiator attempted to send multiple tagged commands with
10479	 * the same ID.  (It's fine if different initiators have the same
10480	 * tag ID.)
10481	 *
10482	 * Even if all of those conditions are true, we don't kill the I/O
10483	 * if the command ahead of us has been aborted.  We won't end up
10484	 * sending it to the FETD, and it's perfectly legal to resend a
10485	 * command with the same tag number as long as the previous
10486	 * instance of this tag number has been aborted somehow.
10487	 */
10488	if ((pending_io->scsiio.tag_type != CTL_TAG_UNTAGGED)
10489	 && (ooa_io->scsiio.tag_type != CTL_TAG_UNTAGGED)
10490	 && (pending_io->scsiio.tag_num == ooa_io->scsiio.tag_num)
10491	 && ((pending_io->io_hdr.nexus.targ_port ==
10492	      ooa_io->io_hdr.nexus.targ_port)
10493	  && (pending_io->io_hdr.nexus.initid.id ==
10494	      ooa_io->io_hdr.nexus.initid.id))
10495	 && ((ooa_io->io_hdr.flags & CTL_FLAG_ABORT) == 0))
10496		return (CTL_ACTION_OVERLAP_TAG);
10497
10498	/*
10499	 * If we get a head of queue tag, SAM-3 says that we should
10500	 * immediately execute it.
10501	 *
10502	 * What happens if this command would normally block for some other
10503	 * reason?  e.g. a request sense with a head of queue tag
10504	 * immediately after a write.  Normally that would block, but this
10505	 * will result in its getting executed immediately...
10506	 *
10507	 * We currently return "pass" instead of "skip", so we'll end up
10508	 * going through the rest of the queue to check for overlapped tags.
10509	 *
10510	 * XXX KDM check for other types of blockage first??
10511	 */
10512	if (pending_io->scsiio.tag_type == CTL_TAG_HEAD_OF_QUEUE)
10513		return (CTL_ACTION_PASS);
10514
10515	/*
10516	 * Ordered tags have to block until all items ahead of them
10517	 * have completed.  If we get called with an ordered tag, we always
10518	 * block, if something else is ahead of us in the queue.
10519	 */
10520	if (pending_io->scsiio.tag_type == CTL_TAG_ORDERED)
10521		return (CTL_ACTION_BLOCK);
10522
10523	/*
10524	 * Simple tags get blocked until all head of queue and ordered tags
10525	 * ahead of them have completed.  I'm lumping untagged commands in
10526	 * with simple tags here.  XXX KDM is that the right thing to do?
10527	 */
10528	if (((pending_io->scsiio.tag_type == CTL_TAG_UNTAGGED)
10529	  || (pending_io->scsiio.tag_type == CTL_TAG_SIMPLE))
10530	 && ((ooa_io->scsiio.tag_type == CTL_TAG_HEAD_OF_QUEUE)
10531	  || (ooa_io->scsiio.tag_type == CTL_TAG_ORDERED)))
10532		return (CTL_ACTION_BLOCK);
10533
10534	pending_entry = &ctl_cmd_table[pending_io->scsiio.cdb[0]];
10535	ooa_entry = &ctl_cmd_table[ooa_io->scsiio.cdb[0]];
10536
10537	serialize_row = ctl_serialize_table[ooa_entry->seridx];
10538
10539	switch (serialize_row[pending_entry->seridx]) {
10540	case CTL_SER_BLOCK:
10541		return (CTL_ACTION_BLOCK);
10542		break; /* NOTREACHED */
10543	case CTL_SER_EXTENT:
10544		return (ctl_extent_check(pending_io, ooa_io));
10545		break; /* NOTREACHED */
10546	case CTL_SER_PASS:
10547		return (CTL_ACTION_PASS);
10548		break; /* NOTREACHED */
10549	case CTL_SER_SKIP:
10550		return (CTL_ACTION_SKIP);
10551		break;
10552	default:
10553		panic("invalid serialization value %d",
10554		      serialize_row[pending_entry->seridx]);
10555		break; /* NOTREACHED */
10556	}
10557
10558	return (CTL_ACTION_ERROR);
10559}
10560
10561/*
10562 * Check for blockage or overlaps against the OOA (Order Of Arrival) queue.
10563 * Assumptions:
10564 * - pending_io is generally either incoming, or on the blocked queue
10565 * - starting I/O is the I/O we want to start the check with.
10566 */
10567static ctl_action
10568ctl_check_ooa(struct ctl_lun *lun, union ctl_io *pending_io,
10569	      union ctl_io *starting_io)
10570{
10571	union ctl_io *ooa_io;
10572	ctl_action action;
10573
10574	mtx_assert(&control_softc->ctl_lock, MA_OWNED);
10575
10576	/*
10577	 * Run back along the OOA queue, starting with the current
10578	 * blocked I/O and going through every I/O before it on the
10579	 * queue.  If starting_io is NULL, we'll just end up returning
10580	 * CTL_ACTION_PASS.
10581	 */
10582	for (ooa_io = starting_io; ooa_io != NULL;
10583	     ooa_io = (union ctl_io *)TAILQ_PREV(&ooa_io->io_hdr, ctl_ooaq,
10584	     ooa_links)){
10585
10586		/*
10587		 * This routine just checks to see whether
10588		 * cur_blocked is blocked by ooa_io, which is ahead
10589		 * of it in the queue.  It doesn't queue/dequeue
10590		 * cur_blocked.
10591		 */
10592		action = ctl_check_for_blockage(pending_io, ooa_io);
10593		switch (action) {
10594		case CTL_ACTION_BLOCK:
10595		case CTL_ACTION_OVERLAP:
10596		case CTL_ACTION_OVERLAP_TAG:
10597		case CTL_ACTION_SKIP:
10598		case CTL_ACTION_ERROR:
10599			return (action);
10600			break; /* NOTREACHED */
10601		case CTL_ACTION_PASS:
10602			break;
10603		default:
10604			panic("invalid action %d", action);
10605			break;  /* NOTREACHED */
10606		}
10607	}
10608
10609	return (CTL_ACTION_PASS);
10610}
10611
10612/*
10613 * Assumptions:
10614 * - An I/O has just completed, and has been removed from the per-LUN OOA
10615 *   queue, so some items on the blocked queue may now be unblocked.
10616 */
10617static int
10618ctl_check_blocked(struct ctl_lun *lun)
10619{
10620	union ctl_io *cur_blocked, *next_blocked;
10621
10622	mtx_assert(&control_softc->ctl_lock, MA_OWNED);
10623
10624	/*
10625	 * Run forward from the head of the blocked queue, checking each
10626	 * entry against the I/Os prior to it on the OOA queue to see if
10627	 * there is still any blockage.
10628	 *
10629	 * We cannot use the TAILQ_FOREACH() macro, because it can't deal
10630	 * with our removing a variable on it while it is traversing the
10631	 * list.
10632	 */
10633	for (cur_blocked = (union ctl_io *)TAILQ_FIRST(&lun->blocked_queue);
10634	     cur_blocked != NULL; cur_blocked = next_blocked) {
10635		union ctl_io *prev_ooa;
10636		ctl_action action;
10637
10638		next_blocked = (union ctl_io *)TAILQ_NEXT(&cur_blocked->io_hdr,
10639							  blocked_links);
10640
10641		prev_ooa = (union ctl_io *)TAILQ_PREV(&cur_blocked->io_hdr,
10642						      ctl_ooaq, ooa_links);
10643
10644		/*
10645		 * If cur_blocked happens to be the first item in the OOA
10646		 * queue now, prev_ooa will be NULL, and the action
10647		 * returned will just be CTL_ACTION_PASS.
10648		 */
10649		action = ctl_check_ooa(lun, cur_blocked, prev_ooa);
10650
10651		switch (action) {
10652		case CTL_ACTION_BLOCK:
10653			/* Nothing to do here, still blocked */
10654			break;
10655		case CTL_ACTION_OVERLAP:
10656		case CTL_ACTION_OVERLAP_TAG:
10657			/*
10658			 * This shouldn't happen!  In theory we've already
10659			 * checked this command for overlap...
10660			 */
10661			break;
10662		case CTL_ACTION_PASS:
10663		case CTL_ACTION_SKIP: {
10664			struct ctl_softc *softc;
10665			struct ctl_cmd_entry *entry;
10666			uint32_t initidx;
10667			uint8_t opcode;
10668			int isc_retval;
10669
10670			/*
10671			 * The skip case shouldn't happen, this transaction
10672			 * should have never made it onto the blocked queue.
10673			 */
10674			/*
10675			 * This I/O is no longer blocked, we can remove it
10676			 * from the blocked queue.  Since this is a TAILQ
10677			 * (doubly linked list), we can do O(1) removals
10678			 * from any place on the list.
10679			 */
10680			TAILQ_REMOVE(&lun->blocked_queue, &cur_blocked->io_hdr,
10681				     blocked_links);
10682			cur_blocked->io_hdr.flags &= ~CTL_FLAG_BLOCKED;
10683
10684			if (cur_blocked->io_hdr.flags & CTL_FLAG_FROM_OTHER_SC){
10685				/*
10686				 * Need to send IO back to original side to
10687				 * run
10688				 */
10689				union ctl_ha_msg msg_info;
10690
10691				msg_info.hdr.original_sc =
10692					cur_blocked->io_hdr.original_sc;
10693				msg_info.hdr.serializing_sc = cur_blocked;
10694				msg_info.hdr.msg_type = CTL_MSG_R2R;
10695				if ((isc_retval=ctl_ha_msg_send(CTL_HA_CHAN_CTL,
10696				     &msg_info, sizeof(msg_info), 0)) >
10697				     CTL_HA_STATUS_SUCCESS) {
10698					printf("CTL:Check Blocked error from "
10699					       "ctl_ha_msg_send %d\n",
10700					       isc_retval);
10701				}
10702				break;
10703			}
10704			opcode = cur_blocked->scsiio.cdb[0];
10705			entry = &ctl_cmd_table[opcode];
10706			softc = control_softc;
10707
10708			initidx = ctl_get_initindex(&cur_blocked->io_hdr.nexus);
10709
10710			/*
10711			 * Check this I/O for LUN state changes that may
10712			 * have happened while this command was blocked.
10713			 * The LUN state may have been changed by a command
10714			 * ahead of us in the queue, so we need to re-check
10715			 * for any states that can be caused by SCSI
10716			 * commands.
10717			 */
10718			if (ctl_scsiio_lun_check(softc, lun, entry,
10719						 &cur_blocked->scsiio) == 0) {
10720				cur_blocked->io_hdr.flags |=
10721				                      CTL_FLAG_IS_WAS_ON_RTR;
10722				STAILQ_INSERT_TAIL(&lun->ctl_softc->rtr_queue,
10723						   &cur_blocked->io_hdr, links);
10724				/*
10725				 * In the non CTL_DONE_THREAD case, we need
10726				 * to wake up the work thread here.  When
10727				 * we're processing completed requests from
10728				 * the work thread context, we'll pop back
10729				 * around and end up pulling things off the
10730				 * RtR queue.  When we aren't processing
10731				 * things from the work thread context,
10732				 * though, we won't ever check the RtR queue.
10733				 * So we need to wake up the thread to clear
10734				 * things off the queue.  Otherwise this
10735				 * transaction will just sit on the RtR queue
10736				 * until a new I/O comes in.  (Which may or
10737				 * may not happen...)
10738				 */
10739#ifndef CTL_DONE_THREAD
10740				ctl_wakeup_thread();
10741#endif
10742			} else
10743				ctl_done_lock(cur_blocked, /*have_lock*/ 1);
10744			break;
10745		}
10746		default:
10747			/*
10748			 * This probably shouldn't happen -- we shouldn't
10749			 * get CTL_ACTION_ERROR, or anything else.
10750			 */
10751			break;
10752		}
10753	}
10754
10755	return (CTL_RETVAL_COMPLETE);
10756}
10757
10758/*
10759 * This routine (with one exception) checks LUN flags that can be set by
10760 * commands ahead of us in the OOA queue.  These flags have to be checked
10761 * when a command initially comes in, and when we pull a command off the
10762 * blocked queue and are preparing to execute it.  The reason we have to
10763 * check these flags for commands on the blocked queue is that the LUN
10764 * state may have been changed by a command ahead of us while we're on the
10765 * blocked queue.
10766 *
10767 * Ordering is somewhat important with these checks, so please pay
10768 * careful attention to the placement of any new checks.
10769 */
10770static int
10771ctl_scsiio_lun_check(struct ctl_softc *ctl_softc, struct ctl_lun *lun,
10772		     struct ctl_cmd_entry *entry, struct ctl_scsiio *ctsio)
10773{
10774	int retval;
10775
10776	retval = 0;
10777
10778	/*
10779	 * If this shelf is a secondary shelf controller, we have to reject
10780	 * any media access commands.
10781	 */
10782#if 0
10783	/* No longer needed for HA */
10784	if (((ctl_softc->flags & CTL_FLAG_MASTER_SHELF) == 0)
10785	 && ((entry->flags & CTL_CMD_FLAG_OK_ON_SECONDARY) == 0)) {
10786		ctl_set_lun_standby(ctsio);
10787		retval = 1;
10788		goto bailout;
10789	}
10790#endif
10791
10792	/*
10793	 * Check for a reservation conflict.  If this command isn't allowed
10794	 * even on reserved LUNs, and if this initiator isn't the one who
10795	 * reserved us, reject the command with a reservation conflict.
10796	 */
10797	if ((lun->flags & CTL_LUN_RESERVED)
10798	 && ((entry->flags & CTL_CMD_FLAG_ALLOW_ON_RESV) == 0)) {
10799		if ((ctsio->io_hdr.nexus.initid.id != lun->rsv_nexus.initid.id)
10800		 || (ctsio->io_hdr.nexus.targ_port != lun->rsv_nexus.targ_port)
10801		 || (ctsio->io_hdr.nexus.targ_target.id !=
10802		     lun->rsv_nexus.targ_target.id)) {
10803			ctsio->scsi_status = SCSI_STATUS_RESERV_CONFLICT;
10804			ctsio->io_hdr.status = CTL_SCSI_ERROR;
10805			retval = 1;
10806			goto bailout;
10807		}
10808	}
10809
10810	if ( (lun->flags & CTL_LUN_PR_RESERVED)
10811	 && ((entry->flags & CTL_CMD_FLAG_ALLOW_ON_PR_RESV) == 0)) {
10812		uint32_t residx;
10813
10814		residx = ctl_get_resindex(&ctsio->io_hdr.nexus);
10815		/*
10816		 * if we aren't registered or it's a res holder type
10817		 * reservation and this isn't the res holder then set a
10818		 * conflict.
10819		 * NOTE: Commands which might be allowed on write exclusive
10820		 * type reservations are checked in the particular command
10821		 * for a conflict. Read and SSU are the only ones.
10822		 */
10823		if (!lun->per_res[residx].registered
10824		 || (residx != lun->pr_res_idx && lun->res_type < 4)) {
10825			ctsio->scsi_status = SCSI_STATUS_RESERV_CONFLICT;
10826			ctsio->io_hdr.status = CTL_SCSI_ERROR;
10827			retval = 1;
10828			goto bailout;
10829		}
10830
10831	}
10832
10833	if ((lun->flags & CTL_LUN_OFFLINE)
10834	 && ((entry->flags & CTL_CMD_FLAG_OK_ON_OFFLINE) == 0)) {
10835		ctl_set_lun_not_ready(ctsio);
10836		retval = 1;
10837		goto bailout;
10838	}
10839
10840	/*
10841	 * If the LUN is stopped, see if this particular command is allowed
10842	 * for a stopped lun.  Otherwise, reject it with 0x04,0x02.
10843	 */
10844	if ((lun->flags & CTL_LUN_STOPPED)
10845	 && ((entry->flags & CTL_CMD_FLAG_OK_ON_STOPPED) == 0)) {
10846		/* "Logical unit not ready, initializing cmd. required" */
10847		ctl_set_lun_stopped(ctsio);
10848		retval = 1;
10849		goto bailout;
10850	}
10851
10852	if ((lun->flags & CTL_LUN_INOPERABLE)
10853	 && ((entry->flags & CTL_CMD_FLAG_OK_ON_INOPERABLE) == 0)) {
10854		/* "Medium format corrupted" */
10855		ctl_set_medium_format_corrupted(ctsio);
10856		retval = 1;
10857		goto bailout;
10858	}
10859
10860bailout:
10861	return (retval);
10862
10863}
10864
10865static void
10866ctl_failover_io(union ctl_io *io, int have_lock)
10867{
10868	ctl_set_busy(&io->scsiio);
10869	ctl_done_lock(io, have_lock);
10870}
10871
10872static void
10873ctl_failover(void)
10874{
10875	struct ctl_lun *lun;
10876	struct ctl_softc *ctl_softc;
10877	union ctl_io *next_io, *pending_io;
10878	union ctl_io *io;
10879	int lun_idx;
10880	int i;
10881
10882	ctl_softc = control_softc;
10883
10884	mtx_lock(&ctl_softc->ctl_lock);
10885	/*
10886	 * Remove any cmds from the other SC from the rtr queue.  These
10887	 * will obviously only be for LUNs for which we're the primary.
10888	 * We can't send status or get/send data for these commands.
10889	 * Since they haven't been executed yet, we can just remove them.
10890	 * We'll either abort them or delete them below, depending on
10891	 * which HA mode we're in.
10892	 */
10893	for (io = (union ctl_io *)STAILQ_FIRST(&ctl_softc->rtr_queue);
10894	     io != NULL; io = next_io) {
10895		next_io = (union ctl_io *)STAILQ_NEXT(&io->io_hdr, links);
10896		if (io->io_hdr.flags & CTL_FLAG_FROM_OTHER_SC)
10897			STAILQ_REMOVE(&ctl_softc->rtr_queue, &io->io_hdr,
10898				      ctl_io_hdr, links);
10899	}
10900
10901	for (lun_idx=0; lun_idx < ctl_softc->num_luns; lun_idx++) {
10902		lun = ctl_softc->ctl_luns[lun_idx];
10903		if (lun==NULL)
10904			continue;
10905
10906		/*
10907		 * Processor LUNs are primary on both sides.
10908		 * XXX will this always be true?
10909		 */
10910		if (lun->be_lun->lun_type == T_PROCESSOR)
10911			continue;
10912
10913		if ((lun->flags & CTL_LUN_PRIMARY_SC)
10914		 && (ctl_softc->ha_mode == CTL_HA_MODE_SER_ONLY)) {
10915			printf("FAILOVER: primary lun %d\n", lun_idx);
10916		        /*
10917			 * Remove all commands from the other SC. First from the
10918			 * blocked queue then from the ooa queue. Once we have
10919			 * removed them. Call ctl_check_blocked to see if there
10920			 * is anything that can run.
10921			 */
10922			for (io = (union ctl_io *)TAILQ_FIRST(
10923			     &lun->blocked_queue); io != NULL; io = next_io) {
10924
10925		        	next_io = (union ctl_io *)TAILQ_NEXT(
10926				    &io->io_hdr, blocked_links);
10927
10928				if (io->io_hdr.flags & CTL_FLAG_FROM_OTHER_SC) {
10929					TAILQ_REMOVE(&lun->blocked_queue,
10930						     &io->io_hdr,blocked_links);
10931					io->io_hdr.flags &= ~CTL_FLAG_BLOCKED;
10932					TAILQ_REMOVE(&lun->ooa_queue,
10933						     &io->io_hdr, ooa_links);
10934
10935					ctl_free_io(io);
10936				}
10937			}
10938
10939			for (io = (union ctl_io *)TAILQ_FIRST(&lun->ooa_queue);
10940	     		     io != NULL; io = next_io) {
10941
10942		        	next_io = (union ctl_io *)TAILQ_NEXT(
10943				    &io->io_hdr, ooa_links);
10944
10945				if (io->io_hdr.flags & CTL_FLAG_FROM_OTHER_SC) {
10946
10947					TAILQ_REMOVE(&lun->ooa_queue,
10948						&io->io_hdr,
10949					     	ooa_links);
10950
10951					ctl_free_io(io);
10952				}
10953			}
10954			ctl_check_blocked(lun);
10955		} else if ((lun->flags & CTL_LUN_PRIMARY_SC)
10956			&& (ctl_softc->ha_mode == CTL_HA_MODE_XFER)) {
10957
10958			printf("FAILOVER: primary lun %d\n", lun_idx);
10959			/*
10960			 * Abort all commands from the other SC.  We can't
10961			 * send status back for them now.  These should get
10962			 * cleaned up when they are completed or come out
10963			 * for a datamove operation.
10964			 */
10965			for (io = (union ctl_io *)TAILQ_FIRST(&lun->ooa_queue);
10966	     		     io != NULL; io = next_io) {
10967		        	next_io = (union ctl_io *)TAILQ_NEXT(
10968					&io->io_hdr, ooa_links);
10969
10970				if (io->io_hdr.flags & CTL_FLAG_FROM_OTHER_SC)
10971					io->io_hdr.flags |= CTL_FLAG_ABORT;
10972			}
10973		} else if (((lun->flags & CTL_LUN_PRIMARY_SC) == 0)
10974			&& (ctl_softc->ha_mode == CTL_HA_MODE_XFER)) {
10975
10976			printf("FAILOVER: secondary lun %d\n", lun_idx);
10977
10978			lun->flags |= CTL_LUN_PRIMARY_SC;
10979
10980			/*
10981			 * We send all I/O that was sent to this controller
10982			 * and redirected to the other side back with
10983			 * busy status, and have the initiator retry it.
10984			 * Figuring out how much data has been transferred,
10985			 * etc. and picking up where we left off would be
10986			 * very tricky.
10987			 *
10988			 * XXX KDM need to remove I/O from the blocked
10989			 * queue as well!
10990			 */
10991			for (pending_io = (union ctl_io *)TAILQ_FIRST(
10992			     &lun->ooa_queue); pending_io != NULL;
10993			     pending_io = next_io) {
10994
10995				next_io =  (union ctl_io *)TAILQ_NEXT(
10996					&pending_io->io_hdr, ooa_links);
10997
10998				pending_io->io_hdr.flags &=
10999					~CTL_FLAG_SENT_2OTHER_SC;
11000
11001				if (pending_io->io_hdr.flags &
11002				    CTL_FLAG_IO_ACTIVE) {
11003					pending_io->io_hdr.flags |=
11004						CTL_FLAG_FAILOVER;
11005				} else {
11006					ctl_set_busy(&pending_io->scsiio);
11007					ctl_done_lock(pending_io,
11008						      /*have_lock*/1);
11009				}
11010			}
11011
11012			/*
11013			 * Build Unit Attention
11014			 */
11015			for (i = 0; i < CTL_MAX_INITIATORS; i++) {
11016				lun->pending_sense[i].ua_pending |=
11017				                     CTL_UA_ASYM_ACC_CHANGE;
11018			}
11019		} else if (((lun->flags & CTL_LUN_PRIMARY_SC) == 0)
11020			&& (ctl_softc->ha_mode == CTL_HA_MODE_SER_ONLY)) {
11021			printf("FAILOVER: secondary lun %d\n", lun_idx);
11022			/*
11023			 * if the first io on the OOA is not on the RtR queue
11024			 * add it.
11025			 */
11026			lun->flags |= CTL_LUN_PRIMARY_SC;
11027
11028			pending_io = (union ctl_io *)TAILQ_FIRST(
11029			    &lun->ooa_queue);
11030			if (pending_io==NULL) {
11031				printf("Nothing on OOA queue\n");
11032				continue;
11033			}
11034
11035			pending_io->io_hdr.flags &= ~CTL_FLAG_SENT_2OTHER_SC;
11036			if ((pending_io->io_hdr.flags &
11037			     CTL_FLAG_IS_WAS_ON_RTR) == 0) {
11038				pending_io->io_hdr.flags |=
11039				    CTL_FLAG_IS_WAS_ON_RTR;
11040				STAILQ_INSERT_TAIL(&ctl_softc->rtr_queue,
11041						   &pending_io->io_hdr, links);
11042			}
11043#if 0
11044			else
11045			{
11046				printf("Tag 0x%04x is running\n",
11047				      pending_io->scsiio.tag_num);
11048			}
11049#endif
11050
11051			next_io = (union ctl_io *)TAILQ_NEXT(
11052			    &pending_io->io_hdr, ooa_links);
11053			for (pending_io=next_io; pending_io != NULL;
11054			     pending_io = next_io) {
11055				pending_io->io_hdr.flags &=
11056				    ~CTL_FLAG_SENT_2OTHER_SC;
11057				next_io = (union ctl_io *)TAILQ_NEXT(
11058					&pending_io->io_hdr, ooa_links);
11059				if (pending_io->io_hdr.flags &
11060				    CTL_FLAG_IS_WAS_ON_RTR) {
11061#if 0
11062				        printf("Tag 0x%04x is running\n",
11063				      		pending_io->scsiio.tag_num);
11064#endif
11065					continue;
11066				}
11067
11068				switch (ctl_check_ooa(lun, pending_io,
11069			            (union ctl_io *)TAILQ_PREV(
11070				    &pending_io->io_hdr, ctl_ooaq,
11071				    ooa_links))) {
11072
11073				case CTL_ACTION_BLOCK:
11074					TAILQ_INSERT_TAIL(&lun->blocked_queue,
11075							  &pending_io->io_hdr,
11076							  blocked_links);
11077					pending_io->io_hdr.flags |=
11078					    CTL_FLAG_BLOCKED;
11079					break;
11080				case CTL_ACTION_PASS:
11081				case CTL_ACTION_SKIP:
11082					pending_io->io_hdr.flags |=
11083					    CTL_FLAG_IS_WAS_ON_RTR;
11084					STAILQ_INSERT_TAIL(
11085					    &ctl_softc->rtr_queue,
11086					    &pending_io->io_hdr, links);
11087					break;
11088				case CTL_ACTION_OVERLAP:
11089					ctl_set_overlapped_cmd(
11090					    (struct ctl_scsiio *)pending_io);
11091					ctl_done_lock(pending_io,
11092						      /*have_lock*/ 1);
11093					break;
11094				case CTL_ACTION_OVERLAP_TAG:
11095					ctl_set_overlapped_tag(
11096					    (struct ctl_scsiio *)pending_io,
11097					    pending_io->scsiio.tag_num & 0xff);
11098					ctl_done_lock(pending_io,
11099						      /*have_lock*/ 1);
11100					break;
11101				case CTL_ACTION_ERROR:
11102				default:
11103					ctl_set_internal_failure(
11104						(struct ctl_scsiio *)pending_io,
11105						0,  // sks_valid
11106						0); //retry count
11107					ctl_done_lock(pending_io,
11108						      /*have_lock*/ 1);
11109					break;
11110				}
11111			}
11112
11113			/*
11114			 * Build Unit Attention
11115			 */
11116			for (i = 0; i < CTL_MAX_INITIATORS; i++) {
11117				lun->pending_sense[i].ua_pending |=
11118				                     CTL_UA_ASYM_ACC_CHANGE;
11119			}
11120		} else {
11121			panic("Unhandled HA mode failover, LUN flags = %#x, "
11122			      "ha_mode = #%x", lun->flags, ctl_softc->ha_mode);
11123		}
11124	}
11125	ctl_pause_rtr = 0;
11126	mtx_unlock(&ctl_softc->ctl_lock);
11127}
11128
11129static int
11130ctl_scsiio_precheck(struct ctl_softc *ctl_softc, struct ctl_scsiio *ctsio)
11131{
11132	struct ctl_lun *lun;
11133	struct ctl_cmd_entry *entry;
11134	uint8_t opcode;
11135	uint32_t initidx, targ_lun;
11136	int retval;
11137
11138	retval = 0;
11139
11140	lun = NULL;
11141
11142	opcode = ctsio->cdb[0];
11143
11144	mtx_lock(&ctl_softc->ctl_lock);
11145
11146	targ_lun = ctsio->io_hdr.nexus.targ_lun;
11147	if (ctsio->io_hdr.nexus.lun_map_fn != NULL)
11148		targ_lun = ctsio->io_hdr.nexus.lun_map_fn(ctsio->io_hdr.nexus.lun_map_arg, targ_lun);
11149	if ((targ_lun < CTL_MAX_LUNS)
11150	 && (ctl_softc->ctl_luns[targ_lun] != NULL)) {
11151		lun = ctl_softc->ctl_luns[targ_lun];
11152		/*
11153		 * If the LUN is invalid, pretend that it doesn't exist.
11154		 * It will go away as soon as all pending I/O has been
11155		 * completed.
11156		 */
11157		if (lun->flags & CTL_LUN_DISABLED) {
11158			lun = NULL;
11159		} else {
11160			ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr = lun;
11161			ctsio->io_hdr.ctl_private[CTL_PRIV_BACKEND_LUN].ptr =
11162				lun->be_lun;
11163			if (lun->be_lun->lun_type == T_PROCESSOR) {
11164				ctsio->io_hdr.flags |= CTL_FLAG_CONTROL_DEV;
11165			}
11166		}
11167	} else {
11168		ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr = NULL;
11169		ctsio->io_hdr.ctl_private[CTL_PRIV_BACKEND_LUN].ptr = NULL;
11170	}
11171
11172	entry = &ctl_cmd_table[opcode];
11173
11174	ctsio->io_hdr.flags &= ~CTL_FLAG_DATA_MASK;
11175	ctsio->io_hdr.flags |= entry->flags & CTL_FLAG_DATA_MASK;
11176
11177	/*
11178	 * Check to see whether we can send this command to LUNs that don't
11179	 * exist.  This should pretty much only be the case for inquiry
11180	 * and request sense.  Further checks, below, really require having
11181	 * a LUN, so we can't really check the command anymore.  Just put
11182	 * it on the rtr queue.
11183	 */
11184	if (lun == NULL) {
11185		if (entry->flags & CTL_CMD_FLAG_OK_ON_ALL_LUNS)
11186			goto queue_rtr;
11187
11188		ctl_set_unsupported_lun(ctsio);
11189		mtx_unlock(&ctl_softc->ctl_lock);
11190		ctl_done((union ctl_io *)ctsio);
11191		CTL_DEBUG_PRINT(("ctl_scsiio_precheck: bailing out due to invalid LUN\n"));
11192		goto bailout;
11193	} else {
11194		/*
11195		 * Every I/O goes into the OOA queue for a particular LUN, and
11196		 * stays there until completion.
11197		 */
11198		TAILQ_INSERT_TAIL(&lun->ooa_queue, &ctsio->io_hdr, ooa_links);
11199
11200		/*
11201		 * Make sure we support this particular command on this LUN.
11202		 * e.g., we don't support writes to the control LUN.
11203		 */
11204		switch (lun->be_lun->lun_type) {
11205		case T_PROCESSOR:
11206		 	if (((entry->flags & CTL_CMD_FLAG_OK_ON_PROC) == 0)
11207			 && ((entry->flags & CTL_CMD_FLAG_OK_ON_ALL_LUNS)
11208			      == 0)) {
11209				ctl_set_invalid_opcode(ctsio);
11210				mtx_unlock(&ctl_softc->ctl_lock);
11211				ctl_done((union ctl_io *)ctsio);
11212				goto bailout;
11213			}
11214			break;
11215		case T_DIRECT:
11216			if (((entry->flags & CTL_CMD_FLAG_OK_ON_SLUN) == 0)
11217			 && ((entry->flags & CTL_CMD_FLAG_OK_ON_ALL_LUNS)
11218			      == 0)){
11219				ctl_set_invalid_opcode(ctsio);
11220				mtx_unlock(&ctl_softc->ctl_lock);
11221				ctl_done((union ctl_io *)ctsio);
11222				goto bailout;
11223			}
11224			break;
11225		default:
11226			printf("Unsupported CTL LUN type %d\n",
11227			       lun->be_lun->lun_type);
11228			panic("Unsupported CTL LUN type %d\n",
11229			      lun->be_lun->lun_type);
11230			break; /* NOTREACHED */
11231		}
11232	}
11233
11234	initidx = ctl_get_initindex(&ctsio->io_hdr.nexus);
11235
11236	/*
11237	 * If we've got a request sense, it'll clear the contingent
11238	 * allegiance condition.  Otherwise, if we have a CA condition for
11239	 * this initiator, clear it, because it sent down a command other
11240	 * than request sense.
11241	 */
11242	if ((opcode != REQUEST_SENSE)
11243	 && (ctl_is_set(lun->have_ca, initidx)))
11244		ctl_clear_mask(lun->have_ca, initidx);
11245
11246	/*
11247	 * If the command has this flag set, it handles its own unit
11248	 * attention reporting, we shouldn't do anything.  Otherwise we
11249	 * check for any pending unit attentions, and send them back to the
11250	 * initiator.  We only do this when a command initially comes in,
11251	 * not when we pull it off the blocked queue.
11252	 *
11253	 * According to SAM-3, section 5.3.2, the order that things get
11254	 * presented back to the host is basically unit attentions caused
11255	 * by some sort of reset event, busy status, reservation conflicts
11256	 * or task set full, and finally any other status.
11257	 *
11258	 * One issue here is that some of the unit attentions we report
11259	 * don't fall into the "reset" category (e.g. "reported luns data
11260	 * has changed").  So reporting it here, before the reservation
11261	 * check, may be technically wrong.  I guess the only thing to do
11262	 * would be to check for and report the reset events here, and then
11263	 * check for the other unit attention types after we check for a
11264	 * reservation conflict.
11265	 *
11266	 * XXX KDM need to fix this
11267	 */
11268	if ((entry->flags & CTL_CMD_FLAG_NO_SENSE) == 0) {
11269		ctl_ua_type ua_type;
11270
11271		ua_type = lun->pending_sense[initidx].ua_pending;
11272		if (ua_type != CTL_UA_NONE) {
11273			scsi_sense_data_type sense_format;
11274
11275			if (lun != NULL)
11276				sense_format = (lun->flags &
11277				    CTL_LUN_SENSE_DESC) ? SSD_TYPE_DESC :
11278				    SSD_TYPE_FIXED;
11279			else
11280				sense_format = SSD_TYPE_FIXED;
11281
11282			ua_type = ctl_build_ua(ua_type, &ctsio->sense_data,
11283					       sense_format);
11284			if (ua_type != CTL_UA_NONE) {
11285				ctsio->scsi_status = SCSI_STATUS_CHECK_COND;
11286				ctsio->io_hdr.status = CTL_SCSI_ERROR |
11287						       CTL_AUTOSENSE;
11288				ctsio->sense_len = SSD_FULL_SIZE;
11289				lun->pending_sense[initidx].ua_pending &=
11290					~ua_type;
11291				mtx_unlock(&ctl_softc->ctl_lock);
11292				ctl_done((union ctl_io *)ctsio);
11293				goto bailout;
11294			}
11295		}
11296	}
11297
11298
11299	if (ctl_scsiio_lun_check(ctl_softc, lun, entry, ctsio) != 0) {
11300		mtx_unlock(&ctl_softc->ctl_lock);
11301		ctl_done((union ctl_io *)ctsio);
11302		goto bailout;
11303	}
11304
11305	/*
11306	 * XXX CHD this is where we want to send IO to other side if
11307	 * this LUN is secondary on this SC. We will need to make a copy
11308	 * of the IO and flag the IO on this side as SENT_2OTHER and the flag
11309	 * the copy we send as FROM_OTHER.
11310	 * We also need to stuff the address of the original IO so we can
11311	 * find it easily. Something similar will need be done on the other
11312	 * side so when we are done we can find the copy.
11313	 */
11314	if ((lun->flags & CTL_LUN_PRIMARY_SC) == 0) {
11315		union ctl_ha_msg msg_info;
11316		int isc_retval;
11317
11318		ctsio->io_hdr.flags |= CTL_FLAG_SENT_2OTHER_SC;
11319
11320		msg_info.hdr.msg_type = CTL_MSG_SERIALIZE;
11321		msg_info.hdr.original_sc = (union ctl_io *)ctsio;
11322#if 0
11323		printf("1. ctsio %p\n", ctsio);
11324#endif
11325		msg_info.hdr.serializing_sc = NULL;
11326		msg_info.hdr.nexus = ctsio->io_hdr.nexus;
11327		msg_info.scsi.tag_num = ctsio->tag_num;
11328		msg_info.scsi.tag_type = ctsio->tag_type;
11329		memcpy(msg_info.scsi.cdb, ctsio->cdb, CTL_MAX_CDBLEN);
11330
11331		ctsio->io_hdr.flags &= ~CTL_FLAG_IO_ACTIVE;
11332
11333		if ((isc_retval=ctl_ha_msg_send(CTL_HA_CHAN_CTL,
11334		    (void *)&msg_info, sizeof(msg_info), 0)) >
11335		    CTL_HA_STATUS_SUCCESS) {
11336			printf("CTL:precheck, ctl_ha_msg_send returned %d\n",
11337			       isc_retval);
11338			printf("CTL:opcode is %x\n",opcode);
11339		} else {
11340#if 0
11341			printf("CTL:Precheck sent msg, opcode is %x\n",opcode);
11342#endif
11343		}
11344
11345		/*
11346		 * XXX KDM this I/O is off the incoming queue, but hasn't
11347		 * been inserted on any other queue.  We may need to come
11348		 * up with a holding queue while we wait for serialization
11349		 * so that we have an idea of what we're waiting for from
11350		 * the other side.
11351		 */
11352		goto bailout_unlock;
11353	}
11354
11355	switch (ctl_check_ooa(lun, (union ctl_io *)ctsio,
11356			      (union ctl_io *)TAILQ_PREV(&ctsio->io_hdr,
11357			      ctl_ooaq, ooa_links))) {
11358	case CTL_ACTION_BLOCK:
11359		ctsio->io_hdr.flags |= CTL_FLAG_BLOCKED;
11360		TAILQ_INSERT_TAIL(&lun->blocked_queue, &ctsio->io_hdr,
11361				  blocked_links);
11362		goto bailout_unlock;
11363		break; /* NOTREACHED */
11364	case CTL_ACTION_PASS:
11365	case CTL_ACTION_SKIP:
11366		goto queue_rtr;
11367		break; /* NOTREACHED */
11368	case CTL_ACTION_OVERLAP:
11369		ctl_set_overlapped_cmd(ctsio);
11370		mtx_unlock(&ctl_softc->ctl_lock);
11371		ctl_done((union ctl_io *)ctsio);
11372		goto bailout;
11373		break; /* NOTREACHED */
11374	case CTL_ACTION_OVERLAP_TAG:
11375		ctl_set_overlapped_tag(ctsio, ctsio->tag_num & 0xff);
11376		mtx_unlock(&ctl_softc->ctl_lock);
11377		ctl_done((union ctl_io *)ctsio);
11378		goto bailout;
11379		break; /* NOTREACHED */
11380	case CTL_ACTION_ERROR:
11381	default:
11382		ctl_set_internal_failure(ctsio,
11383					 /*sks_valid*/ 0,
11384					 /*retry_count*/ 0);
11385		mtx_unlock(&ctl_softc->ctl_lock);
11386		ctl_done((union ctl_io *)ctsio);
11387		goto bailout;
11388		break; /* NOTREACHED */
11389	}
11390
11391	goto bailout_unlock;
11392
11393queue_rtr:
11394	ctsio->io_hdr.flags |= CTL_FLAG_IS_WAS_ON_RTR;
11395	STAILQ_INSERT_TAIL(&ctl_softc->rtr_queue, &ctsio->io_hdr, links);
11396
11397bailout_unlock:
11398	mtx_unlock(&ctl_softc->ctl_lock);
11399
11400bailout:
11401	return (retval);
11402}
11403
11404static int
11405ctl_scsiio(struct ctl_scsiio *ctsio)
11406{
11407	int retval;
11408	struct ctl_cmd_entry *entry;
11409
11410	retval = CTL_RETVAL_COMPLETE;
11411
11412	CTL_DEBUG_PRINT(("ctl_scsiio cdb[0]=%02X\n", ctsio->cdb[0]));
11413
11414	entry = &ctl_cmd_table[ctsio->cdb[0]];
11415
11416	/*
11417	 * If this I/O has been aborted, just send it straight to
11418	 * ctl_done() without executing it.
11419	 */
11420	if (ctsio->io_hdr.flags & CTL_FLAG_ABORT) {
11421		ctl_done((union ctl_io *)ctsio);
11422		goto bailout;
11423	}
11424
11425	/*
11426	 * All the checks should have been handled by ctl_scsiio_precheck().
11427	 * We should be clear now to just execute the I/O.
11428	 */
11429	retval = entry->execute(ctsio);
11430
11431bailout:
11432	return (retval);
11433}
11434
11435/*
11436 * Since we only implement one target right now, a bus reset simply resets
11437 * our single target.
11438 */
11439static int
11440ctl_bus_reset(struct ctl_softc *ctl_softc, union ctl_io *io)
11441{
11442	return(ctl_target_reset(ctl_softc, io, CTL_UA_BUS_RESET));
11443}
11444
11445static int
11446ctl_target_reset(struct ctl_softc *ctl_softc, union ctl_io *io,
11447		 ctl_ua_type ua_type)
11448{
11449	struct ctl_lun *lun;
11450	int retval;
11451
11452	if (!(io->io_hdr.flags & CTL_FLAG_FROM_OTHER_SC)) {
11453		union ctl_ha_msg msg_info;
11454
11455		io->io_hdr.flags |= CTL_FLAG_SENT_2OTHER_SC;
11456		msg_info.hdr.nexus = io->io_hdr.nexus;
11457		if (ua_type==CTL_UA_TARG_RESET)
11458			msg_info.task.task_action = CTL_TASK_TARGET_RESET;
11459		else
11460			msg_info.task.task_action = CTL_TASK_BUS_RESET;
11461		msg_info.hdr.msg_type = CTL_MSG_MANAGE_TASKS;
11462		msg_info.hdr.original_sc = NULL;
11463		msg_info.hdr.serializing_sc = NULL;
11464		if (CTL_HA_STATUS_SUCCESS != ctl_ha_msg_send(CTL_HA_CHAN_CTL,
11465		    (void *)&msg_info, sizeof(msg_info), 0)) {
11466		}
11467	}
11468	retval = 0;
11469
11470	STAILQ_FOREACH(lun, &ctl_softc->lun_list, links)
11471		retval += ctl_lun_reset(lun, io, ua_type);
11472
11473	return (retval);
11474}
11475
11476/*
11477 * The LUN should always be set.  The I/O is optional, and is used to
11478 * distinguish between I/Os sent by this initiator, and by other
11479 * initiators.  We set unit attention for initiators other than this one.
11480 * SAM-3 is vague on this point.  It does say that a unit attention should
11481 * be established for other initiators when a LUN is reset (see section
11482 * 5.7.3), but it doesn't specifically say that the unit attention should
11483 * be established for this particular initiator when a LUN is reset.  Here
11484 * is the relevant text, from SAM-3 rev 8:
11485 *
11486 * 5.7.2 When a SCSI initiator port aborts its own tasks
11487 *
11488 * When a SCSI initiator port causes its own task(s) to be aborted, no
11489 * notification that the task(s) have been aborted shall be returned to
11490 * the SCSI initiator port other than the completion response for the
11491 * command or task management function action that caused the task(s) to
11492 * be aborted and notification(s) associated with related effects of the
11493 * action (e.g., a reset unit attention condition).
11494 *
11495 * XXX KDM for now, we're setting unit attention for all initiators.
11496 */
11497static int
11498ctl_lun_reset(struct ctl_lun *lun, union ctl_io *io, ctl_ua_type ua_type)
11499{
11500	union ctl_io *xio;
11501#if 0
11502	uint32_t initindex;
11503#endif
11504	int i;
11505
11506	/*
11507	 * Run through the OOA queue and abort each I/O.
11508	 */
11509#if 0
11510	TAILQ_FOREACH((struct ctl_io_hdr *)xio, &lun->ooa_queue, ooa_links) {
11511#endif
11512	for (xio = (union ctl_io *)TAILQ_FIRST(&lun->ooa_queue); xio != NULL;
11513	     xio = (union ctl_io *)TAILQ_NEXT(&xio->io_hdr, ooa_links)) {
11514		xio->io_hdr.flags |= CTL_FLAG_ABORT;
11515	}
11516
11517	/*
11518	 * This version sets unit attention for every
11519	 */
11520#if 0
11521	initindex = ctl_get_initindex(&io->io_hdr.nexus);
11522	for (i = 0; i < CTL_MAX_INITIATORS; i++) {
11523		if (initindex == i)
11524			continue;
11525		lun->pending_sense[i].ua_pending |= ua_type;
11526	}
11527#endif
11528
11529	/*
11530	 * A reset (any kind, really) clears reservations established with
11531	 * RESERVE/RELEASE.  It does not clear reservations established
11532	 * with PERSISTENT RESERVE OUT, but we don't support that at the
11533	 * moment anyway.  See SPC-2, section 5.6.  SPC-3 doesn't address
11534	 * reservations made with the RESERVE/RELEASE commands, because
11535	 * those commands are obsolete in SPC-3.
11536	 */
11537	lun->flags &= ~CTL_LUN_RESERVED;
11538
11539	for (i = 0; i < CTL_MAX_INITIATORS; i++) {
11540		ctl_clear_mask(lun->have_ca, i);
11541		lun->pending_sense[i].ua_pending |= ua_type;
11542	}
11543
11544	return (0);
11545}
11546
11547static int
11548ctl_abort_task(union ctl_io *io)
11549{
11550	union ctl_io *xio;
11551	struct ctl_lun *lun;
11552	struct ctl_softc *ctl_softc;
11553#if 0
11554	struct sbuf sb;
11555	char printbuf[128];
11556#endif
11557	int found;
11558	uint32_t targ_lun;
11559
11560	ctl_softc = control_softc;
11561	found = 0;
11562
11563	/*
11564	 * Look up the LUN.
11565	 */
11566	targ_lun = io->io_hdr.nexus.targ_lun;
11567	if (io->io_hdr.nexus.lun_map_fn != NULL)
11568		targ_lun = io->io_hdr.nexus.lun_map_fn(io->io_hdr.nexus.lun_map_arg, targ_lun);
11569	if ((targ_lun < CTL_MAX_LUNS)
11570	 && (ctl_softc->ctl_luns[targ_lun] != NULL))
11571		lun = ctl_softc->ctl_luns[targ_lun];
11572	else
11573		goto bailout;
11574
11575#if 0
11576	printf("ctl_abort_task: called for lun %lld, tag %d type %d\n",
11577	       lun->lun, io->taskio.tag_num, io->taskio.tag_type);
11578#endif
11579
11580	/*
11581	 * Run through the OOA queue and attempt to find the given I/O.
11582	 * The target port, initiator ID, tag type and tag number have to
11583	 * match the values that we got from the initiator.  If we have an
11584	 * untagged command to abort, simply abort the first untagged command
11585	 * we come to.  We only allow one untagged command at a time of course.
11586	 */
11587#if 0
11588	TAILQ_FOREACH((struct ctl_io_hdr *)xio, &lun->ooa_queue, ooa_links) {
11589#endif
11590	for (xio = (union ctl_io *)TAILQ_FIRST(&lun->ooa_queue); xio != NULL;
11591	     xio = (union ctl_io *)TAILQ_NEXT(&xio->io_hdr, ooa_links)) {
11592#if 0
11593		sbuf_new(&sb, printbuf, sizeof(printbuf), SBUF_FIXEDLEN);
11594
11595		sbuf_printf(&sb, "LUN %lld tag %d type %d%s%s%s%s: ",
11596			    lun->lun, xio->scsiio.tag_num,
11597			    xio->scsiio.tag_type,
11598			    (xio->io_hdr.blocked_links.tqe_prev
11599			    == NULL) ? "" : " BLOCKED",
11600			    (xio->io_hdr.flags &
11601			    CTL_FLAG_DMA_INPROG) ? " DMA" : "",
11602			    (xio->io_hdr.flags &
11603			    CTL_FLAG_ABORT) ? " ABORT" : "",
11604			    (xio->io_hdr.flags &
11605			    CTL_FLAG_IS_WAS_ON_RTR ? " RTR" : ""));
11606		ctl_scsi_command_string(&xio->scsiio, NULL, &sb);
11607		sbuf_finish(&sb);
11608		printf("%s\n", sbuf_data(&sb));
11609#endif
11610
11611		if ((xio->io_hdr.nexus.targ_port == io->io_hdr.nexus.targ_port)
11612		 && (xio->io_hdr.nexus.initid.id ==
11613		     io->io_hdr.nexus.initid.id)) {
11614			/*
11615			 * If the abort says that the task is untagged, the
11616			 * task in the queue must be untagged.  Otherwise,
11617			 * we just check to see whether the tag numbers
11618			 * match.  This is because the QLogic firmware
11619			 * doesn't pass back the tag type in an abort
11620			 * request.
11621			 */
11622#if 0
11623			if (((xio->scsiio.tag_type == CTL_TAG_UNTAGGED)
11624			  && (io->taskio.tag_type == CTL_TAG_UNTAGGED))
11625			 || (xio->scsiio.tag_num == io->taskio.tag_num)) {
11626#endif
11627			/*
11628			 * XXX KDM we've got problems with FC, because it
11629			 * doesn't send down a tag type with aborts.  So we
11630			 * can only really go by the tag number...
11631			 * This may cause problems with parallel SCSI.
11632			 * Need to figure that out!!
11633			 */
11634			if (xio->scsiio.tag_num == io->taskio.tag_num) {
11635				xio->io_hdr.flags |= CTL_FLAG_ABORT;
11636				found = 1;
11637				if ((io->io_hdr.flags &
11638				     CTL_FLAG_FROM_OTHER_SC) == 0 &&
11639				    !(lun->flags & CTL_LUN_PRIMARY_SC)) {
11640					union ctl_ha_msg msg_info;
11641
11642					io->io_hdr.flags |=
11643					                CTL_FLAG_SENT_2OTHER_SC;
11644					msg_info.hdr.nexus = io->io_hdr.nexus;
11645					msg_info.task.task_action =
11646						CTL_TASK_ABORT_TASK;
11647					msg_info.task.tag_num =
11648						io->taskio.tag_num;
11649					msg_info.task.tag_type =
11650						io->taskio.tag_type;
11651					msg_info.hdr.msg_type =
11652						CTL_MSG_MANAGE_TASKS;
11653					msg_info.hdr.original_sc = NULL;
11654					msg_info.hdr.serializing_sc = NULL;
11655#if 0
11656					printf("Sent Abort to other side\n");
11657#endif
11658					if (CTL_HA_STATUS_SUCCESS !=
11659					        ctl_ha_msg_send(CTL_HA_CHAN_CTL,
11660		    				(void *)&msg_info,
11661						sizeof(msg_info), 0)) {
11662					}
11663				}
11664#if 0
11665				printf("ctl_abort_task: found I/O to abort\n");
11666#endif
11667				break;
11668			}
11669		}
11670	}
11671
11672bailout:
11673
11674	if (found == 0) {
11675		/*
11676		 * This isn't really an error.  It's entirely possible for
11677		 * the abort and command completion to cross on the wire.
11678		 * This is more of an informative/diagnostic error.
11679		 */
11680#if 0
11681		printf("ctl_abort_task: ABORT sent for nonexistent I/O: "
11682		       "%d:%d:%d:%d tag %d type %d\n",
11683		       io->io_hdr.nexus.initid.id,
11684		       io->io_hdr.nexus.targ_port,
11685		       io->io_hdr.nexus.targ_target.id,
11686		       io->io_hdr.nexus.targ_lun, io->taskio.tag_num,
11687		       io->taskio.tag_type);
11688#endif
11689		return (1);
11690	} else
11691		return (0);
11692}
11693
11694/*
11695 * This routine cannot block!  It must be callable from an interrupt
11696 * handler as well as from the work thread.
11697 */
11698static void
11699ctl_run_task_queue(struct ctl_softc *ctl_softc)
11700{
11701	union ctl_io *io, *next_io;
11702
11703	mtx_assert(&ctl_softc->ctl_lock, MA_OWNED);
11704
11705	CTL_DEBUG_PRINT(("ctl_run_task_queue\n"));
11706
11707	for (io = (union ctl_io *)STAILQ_FIRST(&ctl_softc->task_queue);
11708	     io != NULL; io = next_io) {
11709		int retval;
11710		const char *task_desc;
11711
11712		next_io = (union ctl_io *)STAILQ_NEXT(&io->io_hdr, links);
11713
11714		retval = 0;
11715
11716		switch (io->io_hdr.io_type) {
11717		case CTL_IO_TASK: {
11718			task_desc = ctl_scsi_task_string(&io->taskio);
11719			if (task_desc != NULL) {
11720#ifdef NEEDTOPORT
11721				csevent_log(CSC_CTL | CSC_SHELF_SW |
11722					    CTL_TASK_REPORT,
11723					    csevent_LogType_Trace,
11724					    csevent_Severity_Information,
11725					    csevent_AlertLevel_Green,
11726					    csevent_FRU_Firmware,
11727					    csevent_FRU_Unknown,
11728					    "CTL: received task: %s",task_desc);
11729#endif
11730			} else {
11731#ifdef NEEDTOPORT
11732				csevent_log(CSC_CTL | CSC_SHELF_SW |
11733					    CTL_TASK_REPORT,
11734					    csevent_LogType_Trace,
11735					    csevent_Severity_Information,
11736					    csevent_AlertLevel_Green,
11737					    csevent_FRU_Firmware,
11738					    csevent_FRU_Unknown,
11739					    "CTL: received unknown task "
11740					    "type: %d (%#x)",
11741					    io->taskio.task_action,
11742					    io->taskio.task_action);
11743#endif
11744			}
11745			switch (io->taskio.task_action) {
11746			case CTL_TASK_ABORT_TASK:
11747				retval = ctl_abort_task(io);
11748				break;
11749			case CTL_TASK_ABORT_TASK_SET:
11750				break;
11751			case CTL_TASK_CLEAR_ACA:
11752				break;
11753			case CTL_TASK_CLEAR_TASK_SET:
11754				break;
11755			case CTL_TASK_LUN_RESET: {
11756				struct ctl_lun *lun;
11757				uint32_t targ_lun;
11758				int retval;
11759
11760				targ_lun = io->io_hdr.nexus.targ_lun;
11761				if (io->io_hdr.nexus.lun_map_fn != NULL)
11762					targ_lun = io->io_hdr.nexus.lun_map_fn(io->io_hdr.nexus.lun_map_arg, targ_lun);
11763
11764				if ((targ_lun < CTL_MAX_LUNS)
11765				 && (ctl_softc->ctl_luns[targ_lun] != NULL))
11766					lun = ctl_softc->ctl_luns[targ_lun];
11767				else {
11768					retval = 1;
11769					break;
11770				}
11771
11772				if (!(io->io_hdr.flags &
11773				    CTL_FLAG_FROM_OTHER_SC)) {
11774					union ctl_ha_msg msg_info;
11775
11776					io->io_hdr.flags |=
11777						CTL_FLAG_SENT_2OTHER_SC;
11778					msg_info.hdr.msg_type =
11779						CTL_MSG_MANAGE_TASKS;
11780					msg_info.hdr.nexus = io->io_hdr.nexus;
11781					msg_info.task.task_action =
11782						CTL_TASK_LUN_RESET;
11783					msg_info.hdr.original_sc = NULL;
11784					msg_info.hdr.serializing_sc = NULL;
11785					if (CTL_HA_STATUS_SUCCESS !=
11786					    ctl_ha_msg_send(CTL_HA_CHAN_CTL,
11787					    (void *)&msg_info,
11788					    sizeof(msg_info), 0)) {
11789					}
11790				}
11791
11792				retval = ctl_lun_reset(lun, io,
11793						       CTL_UA_LUN_RESET);
11794				break;
11795			}
11796			case CTL_TASK_TARGET_RESET:
11797				retval = ctl_target_reset(ctl_softc, io,
11798							  CTL_UA_TARG_RESET);
11799				break;
11800			case CTL_TASK_BUS_RESET:
11801				retval = ctl_bus_reset(ctl_softc, io);
11802				break;
11803			case CTL_TASK_PORT_LOGIN:
11804				break;
11805			case CTL_TASK_PORT_LOGOUT:
11806				break;
11807			default:
11808				printf("ctl_run_task_queue: got unknown task "
11809				       "management event %d\n",
11810				       io->taskio.task_action);
11811				break;
11812			}
11813			if (retval == 0)
11814				io->io_hdr.status = CTL_SUCCESS;
11815			else
11816				io->io_hdr.status = CTL_ERROR;
11817
11818			STAILQ_REMOVE(&ctl_softc->task_queue, &io->io_hdr,
11819				      ctl_io_hdr, links);
11820			/*
11821			 * This will queue this I/O to the done queue, but the
11822			 * work thread won't be able to process it until we
11823			 * return and the lock is released.
11824			 */
11825			ctl_done_lock(io, /*have_lock*/ 1);
11826			break;
11827		}
11828		default: {
11829
11830			printf("%s: invalid I/O type %d msg %d cdb %x"
11831			       " iptl: %ju:%d:%ju:%d tag 0x%04x\n",
11832			       __func__, io->io_hdr.io_type,
11833			       io->io_hdr.msg_type, io->scsiio.cdb[0],
11834			       (uintmax_t)io->io_hdr.nexus.initid.id,
11835			       io->io_hdr.nexus.targ_port,
11836			       (uintmax_t)io->io_hdr.nexus.targ_target.id,
11837			       io->io_hdr.nexus.targ_lun /* XXX */,
11838			       (io->io_hdr.io_type == CTL_IO_TASK) ?
11839			       io->taskio.tag_num : io->scsiio.tag_num);
11840			STAILQ_REMOVE(&ctl_softc->task_queue, &io->io_hdr,
11841				      ctl_io_hdr, links);
11842			ctl_free_io(io);
11843			break;
11844		}
11845		}
11846	}
11847
11848	ctl_softc->flags &= ~CTL_FLAG_TASK_PENDING;
11849}
11850
11851/*
11852 * For HA operation.  Handle commands that come in from the other
11853 * controller.
11854 */
11855static void
11856ctl_handle_isc(union ctl_io *io)
11857{
11858	int free_io;
11859	struct ctl_lun *lun;
11860	struct ctl_softc *ctl_softc;
11861	uint32_t targ_lun;
11862
11863	ctl_softc = control_softc;
11864
11865	targ_lun = io->io_hdr.nexus.targ_lun;
11866	if (io->io_hdr.nexus.lun_map_fn != NULL)
11867		targ_lun = io->io_hdr.nexus.lun_map_fn(io->io_hdr.nexus.lun_map_arg, targ_lun);
11868	lun = ctl_softc->ctl_luns[targ_lun];
11869
11870	switch (io->io_hdr.msg_type) {
11871	case CTL_MSG_SERIALIZE:
11872		free_io = ctl_serialize_other_sc_cmd(&io->scsiio,
11873						     /*have_lock*/ 0);
11874		break;
11875	case CTL_MSG_R2R: {
11876		uint8_t opcode;
11877		struct ctl_cmd_entry *entry;
11878
11879		/*
11880		 * This is only used in SER_ONLY mode.
11881		 */
11882		free_io = 0;
11883		opcode = io->scsiio.cdb[0];
11884		entry = &ctl_cmd_table[opcode];
11885		mtx_lock(&ctl_softc->ctl_lock);
11886		if (ctl_scsiio_lun_check(ctl_softc, lun,
11887		    entry, (struct ctl_scsiio *)io) != 0) {
11888			ctl_done_lock(io, /*have_lock*/ 1);
11889			mtx_unlock(&ctl_softc->ctl_lock);
11890			break;
11891		}
11892		io->io_hdr.flags |= CTL_FLAG_IS_WAS_ON_RTR;
11893		STAILQ_INSERT_TAIL(&ctl_softc->rtr_queue,
11894				   &io->io_hdr, links);
11895		mtx_unlock(&ctl_softc->ctl_lock);
11896		break;
11897	}
11898	case CTL_MSG_FINISH_IO:
11899		if (ctl_softc->ha_mode == CTL_HA_MODE_XFER) {
11900			free_io = 0;
11901			ctl_done_lock(io, /*have_lock*/ 0);
11902		} else {
11903			free_io = 1;
11904			mtx_lock(&ctl_softc->ctl_lock);
11905			TAILQ_REMOVE(&lun->ooa_queue, &io->io_hdr,
11906				     ooa_links);
11907			STAILQ_REMOVE(&ctl_softc->task_queue,
11908				      &io->io_hdr, ctl_io_hdr, links);
11909			ctl_check_blocked(lun);
11910			mtx_unlock(&ctl_softc->ctl_lock);
11911		}
11912		break;
11913	case CTL_MSG_PERS_ACTION:
11914		ctl_hndl_per_res_out_on_other_sc(
11915			(union ctl_ha_msg *)&io->presio.pr_msg);
11916		free_io = 1;
11917		break;
11918	case CTL_MSG_BAD_JUJU:
11919		free_io = 0;
11920		ctl_done_lock(io, /*have_lock*/ 0);
11921		break;
11922	case CTL_MSG_DATAMOVE:
11923		/* Only used in XFER mode */
11924		free_io = 0;
11925		ctl_datamove_remote(io);
11926		break;
11927	case CTL_MSG_DATAMOVE_DONE:
11928		/* Only used in XFER mode */
11929		free_io = 0;
11930		io->scsiio.be_move_done(io);
11931		break;
11932	default:
11933		free_io = 1;
11934		printf("%s: Invalid message type %d\n",
11935		       __func__, io->io_hdr.msg_type);
11936		break;
11937	}
11938	if (free_io)
11939		ctl_free_io(io);
11940
11941}
11942
11943
11944/*
11945 * Returns the match type in the case of a match, or CTL_LUN_PAT_NONE if
11946 * there is no match.
11947 */
11948static ctl_lun_error_pattern
11949ctl_cmd_pattern_match(struct ctl_scsiio *ctsio, struct ctl_error_desc *desc)
11950{
11951	struct ctl_cmd_entry *entry;
11952	ctl_lun_error_pattern filtered_pattern, pattern;
11953	uint8_t opcode;
11954
11955	pattern = desc->error_pattern;
11956
11957	/*
11958	 * XXX KDM we need more data passed into this function to match a
11959	 * custom pattern, and we actually need to implement custom pattern
11960	 * matching.
11961	 */
11962	if (pattern & CTL_LUN_PAT_CMD)
11963		return (CTL_LUN_PAT_CMD);
11964
11965	if ((pattern & CTL_LUN_PAT_MASK) == CTL_LUN_PAT_ANY)
11966		return (CTL_LUN_PAT_ANY);
11967
11968	opcode = ctsio->cdb[0];
11969	entry = &ctl_cmd_table[opcode];
11970
11971	filtered_pattern = entry->pattern & pattern;
11972
11973	/*
11974	 * If the user requested specific flags in the pattern (e.g.
11975	 * CTL_LUN_PAT_RANGE), make sure the command supports all of those
11976	 * flags.
11977	 *
11978	 * If the user did not specify any flags, it doesn't matter whether
11979	 * or not the command supports the flags.
11980	 */
11981	if ((filtered_pattern & ~CTL_LUN_PAT_MASK) !=
11982	     (pattern & ~CTL_LUN_PAT_MASK))
11983		return (CTL_LUN_PAT_NONE);
11984
11985	/*
11986	 * If the user asked for a range check, see if the requested LBA
11987	 * range overlaps with this command's LBA range.
11988	 */
11989	if (filtered_pattern & CTL_LUN_PAT_RANGE) {
11990		uint64_t lba1;
11991		uint32_t len1;
11992		ctl_action action;
11993		int retval;
11994
11995		retval = ctl_get_lba_len((union ctl_io *)ctsio, &lba1, &len1);
11996		if (retval != 0)
11997			return (CTL_LUN_PAT_NONE);
11998
11999		action = ctl_extent_check_lba(lba1, len1, desc->lba_range.lba,
12000					      desc->lba_range.len);
12001		/*
12002		 * A "pass" means that the LBA ranges don't overlap, so
12003		 * this doesn't match the user's range criteria.
12004		 */
12005		if (action == CTL_ACTION_PASS)
12006			return (CTL_LUN_PAT_NONE);
12007	}
12008
12009	return (filtered_pattern);
12010}
12011
12012static void
12013ctl_inject_error(struct ctl_lun *lun, union ctl_io *io)
12014{
12015	struct ctl_error_desc *desc, *desc2;
12016
12017	mtx_assert(&control_softc->ctl_lock, MA_OWNED);
12018
12019	STAILQ_FOREACH_SAFE(desc, &lun->error_list, links, desc2) {
12020		ctl_lun_error_pattern pattern;
12021		/*
12022		 * Check to see whether this particular command matches
12023		 * the pattern in the descriptor.
12024		 */
12025		pattern = ctl_cmd_pattern_match(&io->scsiio, desc);
12026		if ((pattern & CTL_LUN_PAT_MASK) == CTL_LUN_PAT_NONE)
12027			continue;
12028
12029		switch (desc->lun_error & CTL_LUN_INJ_TYPE) {
12030		case CTL_LUN_INJ_ABORTED:
12031			ctl_set_aborted(&io->scsiio);
12032			break;
12033		case CTL_LUN_INJ_MEDIUM_ERR:
12034			ctl_set_medium_error(&io->scsiio);
12035			break;
12036		case CTL_LUN_INJ_UA:
12037			/* 29h/00h  POWER ON, RESET, OR BUS DEVICE RESET
12038			 * OCCURRED */
12039			ctl_set_ua(&io->scsiio, 0x29, 0x00);
12040			break;
12041		case CTL_LUN_INJ_CUSTOM:
12042			/*
12043			 * We're assuming the user knows what he is doing.
12044			 * Just copy the sense information without doing
12045			 * checks.
12046			 */
12047			bcopy(&desc->custom_sense, &io->scsiio.sense_data,
12048			      ctl_min(sizeof(desc->custom_sense),
12049				      sizeof(io->scsiio.sense_data)));
12050			io->scsiio.scsi_status = SCSI_STATUS_CHECK_COND;
12051			io->scsiio.sense_len = SSD_FULL_SIZE;
12052			io->io_hdr.status = CTL_SCSI_ERROR | CTL_AUTOSENSE;
12053			break;
12054		case CTL_LUN_INJ_NONE:
12055		default:
12056			/*
12057			 * If this is an error injection type we don't know
12058			 * about, clear the continuous flag (if it is set)
12059			 * so it will get deleted below.
12060			 */
12061			desc->lun_error &= ~CTL_LUN_INJ_CONTINUOUS;
12062			break;
12063		}
12064		/*
12065		 * By default, each error injection action is a one-shot
12066		 */
12067		if (desc->lun_error & CTL_LUN_INJ_CONTINUOUS)
12068			continue;
12069
12070		STAILQ_REMOVE(&lun->error_list, desc, ctl_error_desc, links);
12071
12072		free(desc, M_CTL);
12073	}
12074}
12075
12076#ifdef CTL_IO_DELAY
12077static void
12078ctl_datamove_timer_wakeup(void *arg)
12079{
12080	union ctl_io *io;
12081
12082	io = (union ctl_io *)arg;
12083
12084	ctl_datamove(io);
12085}
12086#endif /* CTL_IO_DELAY */
12087
12088void
12089ctl_datamove(union ctl_io *io)
12090{
12091	void (*fe_datamove)(union ctl_io *io);
12092
12093	mtx_assert(&control_softc->ctl_lock, MA_NOTOWNED);
12094
12095	CTL_DEBUG_PRINT(("ctl_datamove\n"));
12096
12097#ifdef CTL_TIME_IO
12098	if ((time_uptime - io->io_hdr.start_time) > ctl_time_io_secs) {
12099		char str[256];
12100		char path_str[64];
12101		struct sbuf sb;
12102
12103		ctl_scsi_path_string(io, path_str, sizeof(path_str));
12104		sbuf_new(&sb, str, sizeof(str), SBUF_FIXEDLEN);
12105
12106		sbuf_cat(&sb, path_str);
12107		switch (io->io_hdr.io_type) {
12108		case CTL_IO_SCSI:
12109			ctl_scsi_command_string(&io->scsiio, NULL, &sb);
12110			sbuf_printf(&sb, "\n");
12111			sbuf_cat(&sb, path_str);
12112			sbuf_printf(&sb, "Tag: 0x%04x, type %d\n",
12113				    io->scsiio.tag_num, io->scsiio.tag_type);
12114			break;
12115		case CTL_IO_TASK:
12116			sbuf_printf(&sb, "Task I/O type: %d, Tag: 0x%04x, "
12117				    "Tag Type: %d\n", io->taskio.task_action,
12118				    io->taskio.tag_num, io->taskio.tag_type);
12119			break;
12120		default:
12121			printf("Invalid CTL I/O type %d\n", io->io_hdr.io_type);
12122			panic("Invalid CTL I/O type %d\n", io->io_hdr.io_type);
12123			break;
12124		}
12125		sbuf_cat(&sb, path_str);
12126		sbuf_printf(&sb, "ctl_datamove: %jd seconds\n",
12127			    (intmax_t)time_uptime - io->io_hdr.start_time);
12128		sbuf_finish(&sb);
12129		printf("%s", sbuf_data(&sb));
12130	}
12131#endif /* CTL_TIME_IO */
12132
12133	mtx_lock(&control_softc->ctl_lock);
12134#ifdef CTL_IO_DELAY
12135	if (io->io_hdr.flags & CTL_FLAG_DELAY_DONE) {
12136		struct ctl_lun *lun;
12137
12138		lun =(struct ctl_lun *)io->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
12139
12140		io->io_hdr.flags &= ~CTL_FLAG_DELAY_DONE;
12141	} else {
12142		struct ctl_lun *lun;
12143
12144		lun =(struct ctl_lun *)io->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
12145		if ((lun != NULL)
12146		 && (lun->delay_info.datamove_delay > 0)) {
12147			struct callout *callout;
12148
12149			callout = (struct callout *)&io->io_hdr.timer_bytes;
12150			callout_init(callout, /*mpsafe*/ 1);
12151			io->io_hdr.flags |= CTL_FLAG_DELAY_DONE;
12152			callout_reset(callout,
12153				      lun->delay_info.datamove_delay * hz,
12154				      ctl_datamove_timer_wakeup, io);
12155			if (lun->delay_info.datamove_type ==
12156			    CTL_DELAY_TYPE_ONESHOT)
12157				lun->delay_info.datamove_delay = 0;
12158			mtx_unlock(&control_softc->ctl_lock);
12159			return;
12160		}
12161	}
12162#endif
12163	/*
12164	 * If we have any pending task management commands, process them
12165	 * first.  This is necessary to eliminate a race condition with the
12166	 * FETD:
12167	 *
12168	 * - FETD submits a task management command, like an abort.
12169	 * - Back end calls fe_datamove() to move the data for the aborted
12170	 *   command.  The FETD can't really accept it, but if it did, it
12171	 *   would end up transmitting data for a command that the initiator
12172	 *   told us to abort.
12173	 *
12174	 * We close the race by processing all pending task management
12175	 * commands here (we can't block!), and then check this I/O to see
12176	 * if it has been aborted.  If so, return it to the back end with
12177	 * bad status, so the back end can say return an error to the back end
12178	 * and then when the back end returns an error, we can return the
12179	 * aborted command to the FETD, so it can clean up its resources.
12180	 */
12181	if (control_softc->flags & CTL_FLAG_TASK_PENDING)
12182		ctl_run_task_queue(control_softc);
12183
12184	/*
12185	 * This command has been aborted.  Set the port status, so we fail
12186	 * the data move.
12187	 */
12188	if (io->io_hdr.flags & CTL_FLAG_ABORT) {
12189		printf("ctl_datamove: tag 0x%04x on (%ju:%d:%ju:%d) aborted\n",
12190		       io->scsiio.tag_num,(uintmax_t)io->io_hdr.nexus.initid.id,
12191		       io->io_hdr.nexus.targ_port,
12192		       (uintmax_t)io->io_hdr.nexus.targ_target.id,
12193		       io->io_hdr.nexus.targ_lun);
12194		io->io_hdr.status = CTL_CMD_ABORTED;
12195		io->io_hdr.port_status = 31337;
12196		mtx_unlock(&control_softc->ctl_lock);
12197		/*
12198		 * Note that the backend, in this case, will get the
12199		 * callback in its context.  In other cases it may get
12200		 * called in the frontend's interrupt thread context.
12201		 */
12202		io->scsiio.be_move_done(io);
12203		return;
12204	}
12205
12206	/*
12207	 * If we're in XFER mode and this I/O is from the other shelf
12208	 * controller, we need to send the DMA to the other side to
12209	 * actually transfer the data to/from the host.  In serialize only
12210	 * mode the transfer happens below CTL and ctl_datamove() is only
12211	 * called on the machine that originally received the I/O.
12212	 */
12213	if ((control_softc->ha_mode == CTL_HA_MODE_XFER)
12214	 && (io->io_hdr.flags & CTL_FLAG_FROM_OTHER_SC)) {
12215		union ctl_ha_msg msg;
12216		uint32_t sg_entries_sent;
12217		int do_sg_copy;
12218		int i;
12219
12220		memset(&msg, 0, sizeof(msg));
12221		msg.hdr.msg_type = CTL_MSG_DATAMOVE;
12222		msg.hdr.original_sc = io->io_hdr.original_sc;
12223		msg.hdr.serializing_sc = io;
12224		msg.hdr.nexus = io->io_hdr.nexus;
12225		msg.dt.flags = io->io_hdr.flags;
12226		/*
12227		 * We convert everything into a S/G list here.  We can't
12228		 * pass by reference, only by value between controllers.
12229		 * So we can't pass a pointer to the S/G list, only as many
12230		 * S/G entries as we can fit in here.  If it's possible for
12231		 * us to get more than CTL_HA_MAX_SG_ENTRIES S/G entries,
12232		 * then we need to break this up into multiple transfers.
12233		 */
12234		if (io->scsiio.kern_sg_entries == 0) {
12235			msg.dt.kern_sg_entries = 1;
12236			/*
12237			 * If this is in cached memory, flush the cache
12238			 * before we send the DMA request to the other
12239			 * controller.  We want to do this in either the
12240			 * read or the write case.  The read case is
12241			 * straightforward.  In the write case, we want to
12242			 * make sure nothing is in the local cache that
12243			 * could overwrite the DMAed data.
12244			 */
12245			if ((io->io_hdr.flags & CTL_FLAG_NO_DATASYNC) == 0) {
12246				/*
12247				 * XXX KDM use bus_dmamap_sync() here.
12248				 */
12249			}
12250
12251			/*
12252			 * Convert to a physical address if this is a
12253			 * virtual address.
12254			 */
12255			if (io->io_hdr.flags & CTL_FLAG_BUS_ADDR) {
12256				msg.dt.sg_list[0].addr =
12257					io->scsiio.kern_data_ptr;
12258			} else {
12259				/*
12260				 * XXX KDM use busdma here!
12261				 */
12262#if 0
12263				msg.dt.sg_list[0].addr = (void *)
12264					vtophys(io->scsiio.kern_data_ptr);
12265#endif
12266			}
12267
12268			msg.dt.sg_list[0].len = io->scsiio.kern_data_len;
12269			do_sg_copy = 0;
12270		} else {
12271			struct ctl_sg_entry *sgl;
12272
12273			do_sg_copy = 1;
12274			msg.dt.kern_sg_entries = io->scsiio.kern_sg_entries;
12275			sgl = (struct ctl_sg_entry *)io->scsiio.kern_data_ptr;
12276			if ((io->io_hdr.flags & CTL_FLAG_NO_DATASYNC) == 0) {
12277				/*
12278				 * XXX KDM use bus_dmamap_sync() here.
12279				 */
12280			}
12281		}
12282
12283		msg.dt.kern_data_len = io->scsiio.kern_data_len;
12284		msg.dt.kern_total_len = io->scsiio.kern_total_len;
12285		msg.dt.kern_data_resid = io->scsiio.kern_data_resid;
12286		msg.dt.kern_rel_offset = io->scsiio.kern_rel_offset;
12287		msg.dt.sg_sequence = 0;
12288
12289		/*
12290		 * Loop until we've sent all of the S/G entries.  On the
12291		 * other end, we'll recompose these S/G entries into one
12292		 * contiguous list before passing it to the
12293		 */
12294		for (sg_entries_sent = 0; sg_entries_sent <
12295		     msg.dt.kern_sg_entries; msg.dt.sg_sequence++) {
12296			msg.dt.cur_sg_entries = ctl_min((sizeof(msg.dt.sg_list)/
12297				sizeof(msg.dt.sg_list[0])),
12298				msg.dt.kern_sg_entries - sg_entries_sent);
12299
12300			if (do_sg_copy != 0) {
12301				struct ctl_sg_entry *sgl;
12302				int j;
12303
12304				sgl = (struct ctl_sg_entry *)
12305					io->scsiio.kern_data_ptr;
12306				/*
12307				 * If this is in cached memory, flush the cache
12308				 * before we send the DMA request to the other
12309				 * controller.  We want to do this in either
12310				 * the * read or the write case.  The read
12311				 * case is straightforward.  In the write
12312				 * case, we want to make sure nothing is
12313				 * in the local cache that could overwrite
12314				 * the DMAed data.
12315				 */
12316
12317				for (i = sg_entries_sent, j = 0;
12318				     i < msg.dt.cur_sg_entries; i++, j++) {
12319					if ((io->io_hdr.flags &
12320					     CTL_FLAG_NO_DATASYNC) == 0) {
12321						/*
12322						 * XXX KDM use bus_dmamap_sync()
12323						 */
12324					}
12325					if ((io->io_hdr.flags &
12326					     CTL_FLAG_BUS_ADDR) == 0) {
12327						/*
12328						 * XXX KDM use busdma.
12329						 */
12330#if 0
12331						msg.dt.sg_list[j].addr =(void *)
12332						       vtophys(sgl[i].addr);
12333#endif
12334					} else {
12335						msg.dt.sg_list[j].addr =
12336							sgl[i].addr;
12337					}
12338					msg.dt.sg_list[j].len = sgl[i].len;
12339				}
12340			}
12341
12342			sg_entries_sent += msg.dt.cur_sg_entries;
12343			if (sg_entries_sent >= msg.dt.kern_sg_entries)
12344				msg.dt.sg_last = 1;
12345			else
12346				msg.dt.sg_last = 0;
12347
12348			/*
12349			 * XXX KDM drop and reacquire the lock here?
12350			 */
12351			if (ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg,
12352			    sizeof(msg), 0) > CTL_HA_STATUS_SUCCESS) {
12353				/*
12354				 * XXX do something here.
12355				 */
12356			}
12357
12358			msg.dt.sent_sg_entries = sg_entries_sent;
12359		}
12360		io->io_hdr.flags &= ~CTL_FLAG_IO_ACTIVE;
12361		if (io->io_hdr.flags & CTL_FLAG_FAILOVER)
12362			ctl_failover_io(io, /*have_lock*/ 1);
12363
12364	} else {
12365
12366		/*
12367		 * Lookup the fe_datamove() function for this particular
12368		 * front end.
12369		 */
12370		fe_datamove =
12371		    control_softc->ctl_ports[ctl_port_idx(io->io_hdr.nexus.targ_port)]->fe_datamove;
12372		mtx_unlock(&control_softc->ctl_lock);
12373
12374		fe_datamove(io);
12375	}
12376}
12377
12378static void
12379ctl_send_datamove_done(union ctl_io *io, int have_lock)
12380{
12381	union ctl_ha_msg msg;
12382	int isc_status;
12383
12384	memset(&msg, 0, sizeof(msg));
12385
12386	msg.hdr.msg_type = CTL_MSG_DATAMOVE_DONE;
12387	msg.hdr.original_sc = io;
12388	msg.hdr.serializing_sc = io->io_hdr.serializing_sc;
12389	msg.hdr.nexus = io->io_hdr.nexus;
12390	msg.hdr.status = io->io_hdr.status;
12391	msg.scsi.tag_num = io->scsiio.tag_num;
12392	msg.scsi.tag_type = io->scsiio.tag_type;
12393	msg.scsi.scsi_status = io->scsiio.scsi_status;
12394	memcpy(&msg.scsi.sense_data, &io->scsiio.sense_data,
12395	       sizeof(io->scsiio.sense_data));
12396	msg.scsi.sense_len = io->scsiio.sense_len;
12397	msg.scsi.sense_residual = io->scsiio.sense_residual;
12398	msg.scsi.fetd_status = io->io_hdr.port_status;
12399	msg.scsi.residual = io->scsiio.residual;
12400	io->io_hdr.flags &= ~CTL_FLAG_IO_ACTIVE;
12401
12402	if (io->io_hdr.flags & CTL_FLAG_FAILOVER) {
12403		ctl_failover_io(io, /*have_lock*/ have_lock);
12404		return;
12405	}
12406
12407	isc_status = ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg, sizeof(msg), 0);
12408	if (isc_status > CTL_HA_STATUS_SUCCESS) {
12409		/* XXX do something if this fails */
12410	}
12411
12412}
12413
12414/*
12415 * The DMA to the remote side is done, now we need to tell the other side
12416 * we're done so it can continue with its data movement.
12417 */
12418static void
12419ctl_datamove_remote_write_cb(struct ctl_ha_dt_req *rq)
12420{
12421	union ctl_io *io;
12422
12423	io = rq->context;
12424
12425	if (rq->ret != CTL_HA_STATUS_SUCCESS) {
12426		printf("%s: ISC DMA write failed with error %d", __func__,
12427		       rq->ret);
12428		ctl_set_internal_failure(&io->scsiio,
12429					 /*sks_valid*/ 1,
12430					 /*retry_count*/ rq->ret);
12431	}
12432
12433	ctl_dt_req_free(rq);
12434
12435	/*
12436	 * In this case, we had to malloc the memory locally.  Free it.
12437	 */
12438	if ((io->io_hdr.flags & CTL_FLAG_AUTO_MIRROR) == 0) {
12439		int i;
12440		for (i = 0; i < io->scsiio.kern_sg_entries; i++)
12441			free(io->io_hdr.local_sglist[i].addr, M_CTL);
12442	}
12443	/*
12444	 * The data is in local and remote memory, so now we need to send
12445	 * status (good or back) back to the other side.
12446	 */
12447	ctl_send_datamove_done(io, /*have_lock*/ 0);
12448}
12449
12450/*
12451 * We've moved the data from the host/controller into local memory.  Now we
12452 * need to push it over to the remote controller's memory.
12453 */
12454static int
12455ctl_datamove_remote_dm_write_cb(union ctl_io *io)
12456{
12457	int retval;
12458
12459	retval = 0;
12460
12461	retval = ctl_datamove_remote_xfer(io, CTL_HA_DT_CMD_WRITE,
12462					  ctl_datamove_remote_write_cb);
12463
12464	return (retval);
12465}
12466
12467static void
12468ctl_datamove_remote_write(union ctl_io *io)
12469{
12470	int retval;
12471	void (*fe_datamove)(union ctl_io *io);
12472
12473	/*
12474	 * - Get the data from the host/HBA into local memory.
12475	 * - DMA memory from the local controller to the remote controller.
12476	 * - Send status back to the remote controller.
12477	 */
12478
12479	retval = ctl_datamove_remote_sgl_setup(io);
12480	if (retval != 0)
12481		return;
12482
12483	/* Switch the pointer over so the FETD knows what to do */
12484	io->scsiio.kern_data_ptr = (uint8_t *)io->io_hdr.local_sglist;
12485
12486	/*
12487	 * Use a custom move done callback, since we need to send completion
12488	 * back to the other controller, not to the backend on this side.
12489	 */
12490	io->scsiio.be_move_done = ctl_datamove_remote_dm_write_cb;
12491
12492	fe_datamove = control_softc->ctl_ports[ctl_port_idx(io->io_hdr.nexus.targ_port)]->fe_datamove;
12493
12494	fe_datamove(io);
12495
12496	return;
12497
12498}
12499
12500static int
12501ctl_datamove_remote_dm_read_cb(union ctl_io *io)
12502{
12503#if 0
12504	char str[256];
12505	char path_str[64];
12506	struct sbuf sb;
12507#endif
12508
12509	/*
12510	 * In this case, we had to malloc the memory locally.  Free it.
12511	 */
12512	if ((io->io_hdr.flags & CTL_FLAG_AUTO_MIRROR) == 0) {
12513		int i;
12514		for (i = 0; i < io->scsiio.kern_sg_entries; i++)
12515			free(io->io_hdr.local_sglist[i].addr, M_CTL);
12516	}
12517
12518#if 0
12519	scsi_path_string(io, path_str, sizeof(path_str));
12520	sbuf_new(&sb, str, sizeof(str), SBUF_FIXEDLEN);
12521	sbuf_cat(&sb, path_str);
12522	scsi_command_string(&io->scsiio, NULL, &sb);
12523	sbuf_printf(&sb, "\n");
12524	sbuf_cat(&sb, path_str);
12525	sbuf_printf(&sb, "Tag: 0x%04x, type %d\n",
12526		    io->scsiio.tag_num, io->scsiio.tag_type);
12527	sbuf_cat(&sb, path_str);
12528	sbuf_printf(&sb, "%s: flags %#x, status %#x\n", __func__,
12529		    io->io_hdr.flags, io->io_hdr.status);
12530	sbuf_finish(&sb);
12531	printk("%s", sbuf_data(&sb));
12532#endif
12533
12534
12535	/*
12536	 * The read is done, now we need to send status (good or bad) back
12537	 * to the other side.
12538	 */
12539	ctl_send_datamove_done(io, /*have_lock*/ 0);
12540
12541	return (0);
12542}
12543
12544static void
12545ctl_datamove_remote_read_cb(struct ctl_ha_dt_req *rq)
12546{
12547	union ctl_io *io;
12548	void (*fe_datamove)(union ctl_io *io);
12549
12550	io = rq->context;
12551
12552	if (rq->ret != CTL_HA_STATUS_SUCCESS) {
12553		printf("%s: ISC DMA read failed with error %d", __func__,
12554		       rq->ret);
12555		ctl_set_internal_failure(&io->scsiio,
12556					 /*sks_valid*/ 1,
12557					 /*retry_count*/ rq->ret);
12558	}
12559
12560	ctl_dt_req_free(rq);
12561
12562	/* Switch the pointer over so the FETD knows what to do */
12563	io->scsiio.kern_data_ptr = (uint8_t *)io->io_hdr.local_sglist;
12564
12565	/*
12566	 * Use a custom move done callback, since we need to send completion
12567	 * back to the other controller, not to the backend on this side.
12568	 */
12569	io->scsiio.be_move_done = ctl_datamove_remote_dm_read_cb;
12570
12571	/* XXX KDM add checks like the ones in ctl_datamove? */
12572
12573	fe_datamove = control_softc->ctl_ports[ctl_port_idx(io->io_hdr.nexus.targ_port)]->fe_datamove;
12574
12575	fe_datamove(io);
12576}
12577
12578static int
12579ctl_datamove_remote_sgl_setup(union ctl_io *io)
12580{
12581	struct ctl_sg_entry *local_sglist, *remote_sglist;
12582	struct ctl_sg_entry *local_dma_sglist, *remote_dma_sglist;
12583	struct ctl_softc *softc;
12584	int retval;
12585	int i;
12586
12587	retval = 0;
12588	softc = control_softc;
12589
12590	local_sglist = io->io_hdr.local_sglist;
12591	local_dma_sglist = io->io_hdr.local_dma_sglist;
12592	remote_sglist = io->io_hdr.remote_sglist;
12593	remote_dma_sglist = io->io_hdr.remote_dma_sglist;
12594
12595	if (io->io_hdr.flags & CTL_FLAG_AUTO_MIRROR) {
12596		for (i = 0; i < io->scsiio.kern_sg_entries; i++) {
12597			local_sglist[i].len = remote_sglist[i].len;
12598
12599			/*
12600			 * XXX Detect the situation where the RS-level I/O
12601			 * redirector on the other side has already read the
12602			 * data off of the AOR RS on this side, and
12603			 * transferred it to remote (mirror) memory on the
12604			 * other side.  Since we already have the data in
12605			 * memory here, we just need to use it.
12606			 *
12607			 * XXX KDM this can probably be removed once we
12608			 * get the cache device code in and take the
12609			 * current AOR implementation out.
12610			 */
12611#ifdef NEEDTOPORT
12612			if ((remote_sglist[i].addr >=
12613			     (void *)vtophys(softc->mirr->addr))
12614			 && (remote_sglist[i].addr <
12615			     ((void *)vtophys(softc->mirr->addr) +
12616			     CacheMirrorOffset))) {
12617				local_sglist[i].addr = remote_sglist[i].addr -
12618					CacheMirrorOffset;
12619				if ((io->io_hdr.flags & CTL_FLAG_DATA_MASK) ==
12620				     CTL_FLAG_DATA_IN)
12621					io->io_hdr.flags |= CTL_FLAG_REDIR_DONE;
12622			} else {
12623				local_sglist[i].addr = remote_sglist[i].addr +
12624					CacheMirrorOffset;
12625			}
12626#endif
12627#if 0
12628			printf("%s: local %p, remote %p, len %d\n",
12629			       __func__, local_sglist[i].addr,
12630			       remote_sglist[i].addr, local_sglist[i].len);
12631#endif
12632		}
12633	} else {
12634		uint32_t len_to_go;
12635
12636		/*
12637		 * In this case, we don't have automatically allocated
12638		 * memory for this I/O on this controller.  This typically
12639		 * happens with internal CTL I/O -- e.g. inquiry, mode
12640		 * sense, etc.  Anything coming from RAIDCore will have
12641		 * a mirror area available.
12642		 */
12643		len_to_go = io->scsiio.kern_data_len;
12644
12645		/*
12646		 * Clear the no datasync flag, we have to use malloced
12647		 * buffers.
12648		 */
12649		io->io_hdr.flags &= ~CTL_FLAG_NO_DATASYNC;
12650
12651		/*
12652		 * The difficult thing here is that the size of the various
12653		 * S/G segments may be different than the size from the
12654		 * remote controller.  That'll make it harder when DMAing
12655		 * the data back to the other side.
12656		 */
12657		for (i = 0; (i < sizeof(io->io_hdr.remote_sglist) /
12658		     sizeof(io->io_hdr.remote_sglist[0])) &&
12659		     (len_to_go > 0); i++) {
12660			local_sglist[i].len = ctl_min(len_to_go, 131072);
12661			CTL_SIZE_8B(local_dma_sglist[i].len,
12662				    local_sglist[i].len);
12663			local_sglist[i].addr =
12664				malloc(local_dma_sglist[i].len, M_CTL,M_WAITOK);
12665
12666			local_dma_sglist[i].addr = local_sglist[i].addr;
12667
12668			if (local_sglist[i].addr == NULL) {
12669				int j;
12670
12671				printf("malloc failed for %zd bytes!",
12672				       local_dma_sglist[i].len);
12673				for (j = 0; j < i; j++) {
12674					free(local_sglist[j].addr, M_CTL);
12675				}
12676				ctl_set_internal_failure(&io->scsiio,
12677							 /*sks_valid*/ 1,
12678							 /*retry_count*/ 4857);
12679				retval = 1;
12680				goto bailout_error;
12681
12682			}
12683			/* XXX KDM do we need a sync here? */
12684
12685			len_to_go -= local_sglist[i].len;
12686		}
12687		/*
12688		 * Reset the number of S/G entries accordingly.  The
12689		 * original number of S/G entries is available in
12690		 * rem_sg_entries.
12691		 */
12692		io->scsiio.kern_sg_entries = i;
12693
12694#if 0
12695		printf("%s: kern_sg_entries = %d\n", __func__,
12696		       io->scsiio.kern_sg_entries);
12697		for (i = 0; i < io->scsiio.kern_sg_entries; i++)
12698			printf("%s: sg[%d] = %p, %d (DMA: %d)\n", __func__, i,
12699			       local_sglist[i].addr, local_sglist[i].len,
12700			       local_dma_sglist[i].len);
12701#endif
12702	}
12703
12704
12705	return (retval);
12706
12707bailout_error:
12708
12709	ctl_send_datamove_done(io, /*have_lock*/ 0);
12710
12711	return (retval);
12712}
12713
12714static int
12715ctl_datamove_remote_xfer(union ctl_io *io, unsigned command,
12716			 ctl_ha_dt_cb callback)
12717{
12718	struct ctl_ha_dt_req *rq;
12719	struct ctl_sg_entry *remote_sglist, *local_sglist;
12720	struct ctl_sg_entry *remote_dma_sglist, *local_dma_sglist;
12721	uint32_t local_used, remote_used, total_used;
12722	int retval;
12723	int i, j;
12724
12725	retval = 0;
12726
12727	rq = ctl_dt_req_alloc();
12728
12729	/*
12730	 * If we failed to allocate the request, and if the DMA didn't fail
12731	 * anyway, set busy status.  This is just a resource allocation
12732	 * failure.
12733	 */
12734	if ((rq == NULL)
12735	 && ((io->io_hdr.status & CTL_STATUS_MASK) != CTL_STATUS_NONE))
12736		ctl_set_busy(&io->scsiio);
12737
12738	if ((io->io_hdr.status & CTL_STATUS_MASK) != CTL_STATUS_NONE) {
12739
12740		if (rq != NULL)
12741			ctl_dt_req_free(rq);
12742
12743		/*
12744		 * The data move failed.  We need to return status back
12745		 * to the other controller.  No point in trying to DMA
12746		 * data to the remote controller.
12747		 */
12748
12749		ctl_send_datamove_done(io, /*have_lock*/ 0);
12750
12751		retval = 1;
12752
12753		goto bailout;
12754	}
12755
12756	local_sglist = io->io_hdr.local_sglist;
12757	local_dma_sglist = io->io_hdr.local_dma_sglist;
12758	remote_sglist = io->io_hdr.remote_sglist;
12759	remote_dma_sglist = io->io_hdr.remote_dma_sglist;
12760	local_used = 0;
12761	remote_used = 0;
12762	total_used = 0;
12763
12764	if (io->io_hdr.flags & CTL_FLAG_REDIR_DONE) {
12765		rq->ret = CTL_HA_STATUS_SUCCESS;
12766		rq->context = io;
12767		callback(rq);
12768		goto bailout;
12769	}
12770
12771	/*
12772	 * Pull/push the data over the wire from/to the other controller.
12773	 * This takes into account the possibility that the local and
12774	 * remote sglists may not be identical in terms of the size of
12775	 * the elements and the number of elements.
12776	 *
12777	 * One fundamental assumption here is that the length allocated for
12778	 * both the local and remote sglists is identical.  Otherwise, we've
12779	 * essentially got a coding error of some sort.
12780	 */
12781	for (i = 0, j = 0; total_used < io->scsiio.kern_data_len; ) {
12782		int isc_ret;
12783		uint32_t cur_len, dma_length;
12784		uint8_t *tmp_ptr;
12785
12786		rq->id = CTL_HA_DATA_CTL;
12787		rq->command = command;
12788		rq->context = io;
12789
12790		/*
12791		 * Both pointers should be aligned.  But it is possible
12792		 * that the allocation length is not.  They should both
12793		 * also have enough slack left over at the end, though,
12794		 * to round up to the next 8 byte boundary.
12795		 */
12796		cur_len = ctl_min(local_sglist[i].len - local_used,
12797				  remote_sglist[j].len - remote_used);
12798
12799		/*
12800		 * In this case, we have a size issue and need to decrease
12801		 * the size, except in the case where we actually have less
12802		 * than 8 bytes left.  In that case, we need to increase
12803		 * the DMA length to get the last bit.
12804		 */
12805		if ((cur_len & 0x7) != 0) {
12806			if (cur_len > 0x7) {
12807				cur_len = cur_len - (cur_len & 0x7);
12808				dma_length = cur_len;
12809			} else {
12810				CTL_SIZE_8B(dma_length, cur_len);
12811			}
12812
12813		} else
12814			dma_length = cur_len;
12815
12816		/*
12817		 * If we had to allocate memory for this I/O, instead of using
12818		 * the non-cached mirror memory, we'll need to flush the cache
12819		 * before trying to DMA to the other controller.
12820		 *
12821		 * We could end up doing this multiple times for the same
12822		 * segment if we have a larger local segment than remote
12823		 * segment.  That shouldn't be an issue.
12824		 */
12825		if ((io->io_hdr.flags & CTL_FLAG_NO_DATASYNC) == 0) {
12826			/*
12827			 * XXX KDM use bus_dmamap_sync() here.
12828			 */
12829		}
12830
12831		rq->size = dma_length;
12832
12833		tmp_ptr = (uint8_t *)local_sglist[i].addr;
12834		tmp_ptr += local_used;
12835
12836		/* Use physical addresses when talking to ISC hardware */
12837		if ((io->io_hdr.flags & CTL_FLAG_BUS_ADDR) == 0) {
12838			/* XXX KDM use busdma */
12839#if 0
12840			rq->local = vtophys(tmp_ptr);
12841#endif
12842		} else
12843			rq->local = tmp_ptr;
12844
12845		tmp_ptr = (uint8_t *)remote_sglist[j].addr;
12846		tmp_ptr += remote_used;
12847		rq->remote = tmp_ptr;
12848
12849		rq->callback = NULL;
12850
12851		local_used += cur_len;
12852		if (local_used >= local_sglist[i].len) {
12853			i++;
12854			local_used = 0;
12855		}
12856
12857		remote_used += cur_len;
12858		if (remote_used >= remote_sglist[j].len) {
12859			j++;
12860			remote_used = 0;
12861		}
12862		total_used += cur_len;
12863
12864		if (total_used >= io->scsiio.kern_data_len)
12865			rq->callback = callback;
12866
12867		if ((rq->size & 0x7) != 0) {
12868			printf("%s: warning: size %d is not on 8b boundary\n",
12869			       __func__, rq->size);
12870		}
12871		if (((uintptr_t)rq->local & 0x7) != 0) {
12872			printf("%s: warning: local %p not on 8b boundary\n",
12873			       __func__, rq->local);
12874		}
12875		if (((uintptr_t)rq->remote & 0x7) != 0) {
12876			printf("%s: warning: remote %p not on 8b boundary\n",
12877			       __func__, rq->local);
12878		}
12879#if 0
12880		printf("%s: %s: local %#x remote %#x size %d\n", __func__,
12881		       (command == CTL_HA_DT_CMD_WRITE) ? "WRITE" : "READ",
12882		       rq->local, rq->remote, rq->size);
12883#endif
12884
12885		isc_ret = ctl_dt_single(rq);
12886		if (isc_ret == CTL_HA_STATUS_WAIT)
12887			continue;
12888
12889		if (isc_ret == CTL_HA_STATUS_DISCONNECT) {
12890			rq->ret = CTL_HA_STATUS_SUCCESS;
12891		} else {
12892			rq->ret = isc_ret;
12893		}
12894		callback(rq);
12895		goto bailout;
12896	}
12897
12898bailout:
12899	return (retval);
12900
12901}
12902
12903static void
12904ctl_datamove_remote_read(union ctl_io *io)
12905{
12906	int retval;
12907	int i;
12908
12909	/*
12910	 * This will send an error to the other controller in the case of a
12911	 * failure.
12912	 */
12913	retval = ctl_datamove_remote_sgl_setup(io);
12914	if (retval != 0)
12915		return;
12916
12917	retval = ctl_datamove_remote_xfer(io, CTL_HA_DT_CMD_READ,
12918					  ctl_datamove_remote_read_cb);
12919	if ((retval != 0)
12920	 && ((io->io_hdr.flags & CTL_FLAG_AUTO_MIRROR) == 0)) {
12921		/*
12922		 * Make sure we free memory if there was an error..  The
12923		 * ctl_datamove_remote_xfer() function will send the
12924		 * datamove done message, or call the callback with an
12925		 * error if there is a problem.
12926		 */
12927		for (i = 0; i < io->scsiio.kern_sg_entries; i++)
12928			free(io->io_hdr.local_sglist[i].addr, M_CTL);
12929	}
12930
12931	return;
12932}
12933
12934/*
12935 * Process a datamove request from the other controller.  This is used for
12936 * XFER mode only, not SER_ONLY mode.  For writes, we DMA into local memory
12937 * first.  Once that is complete, the data gets DMAed into the remote
12938 * controller's memory.  For reads, we DMA from the remote controller's
12939 * memory into our memory first, and then move it out to the FETD.
12940 */
12941static void
12942ctl_datamove_remote(union ctl_io *io)
12943{
12944	struct ctl_softc *softc;
12945
12946	softc = control_softc;
12947
12948	mtx_assert(&softc->ctl_lock, MA_NOTOWNED);
12949
12950	/*
12951	 * Note that we look for an aborted I/O here, but don't do some of
12952	 * the other checks that ctl_datamove() normally does.  We don't
12953	 * need to run the task queue, because this I/O is on the ISC
12954	 * queue, which is executed by the work thread after the task queue.
12955	 * We don't need to run the datamove delay code, since that should
12956	 * have been done if need be on the other controller.
12957	 */
12958	mtx_lock(&softc->ctl_lock);
12959
12960	if (io->io_hdr.flags & CTL_FLAG_ABORT) {
12961
12962		printf("%s: tag 0x%04x on (%d:%d:%d:%d) aborted\n", __func__,
12963		       io->scsiio.tag_num, io->io_hdr.nexus.initid.id,
12964		       io->io_hdr.nexus.targ_port,
12965		       io->io_hdr.nexus.targ_target.id,
12966		       io->io_hdr.nexus.targ_lun);
12967		io->io_hdr.status = CTL_CMD_ABORTED;
12968		io->io_hdr.port_status = 31338;
12969
12970		mtx_unlock(&softc->ctl_lock);
12971
12972		ctl_send_datamove_done(io, /*have_lock*/ 0);
12973
12974		return;
12975	}
12976
12977	if ((io->io_hdr.flags & CTL_FLAG_DATA_MASK) == CTL_FLAG_DATA_OUT) {
12978		mtx_unlock(&softc->ctl_lock);
12979		ctl_datamove_remote_write(io);
12980	} else if ((io->io_hdr.flags & CTL_FLAG_DATA_MASK) == CTL_FLAG_DATA_IN){
12981		mtx_unlock(&softc->ctl_lock);
12982		ctl_datamove_remote_read(io);
12983	} else {
12984		union ctl_ha_msg msg;
12985		struct scsi_sense_data *sense;
12986		uint8_t sks[3];
12987		int retry_count;
12988
12989		memset(&msg, 0, sizeof(msg));
12990
12991		msg.hdr.msg_type = CTL_MSG_BAD_JUJU;
12992		msg.hdr.status = CTL_SCSI_ERROR;
12993		msg.scsi.scsi_status = SCSI_STATUS_CHECK_COND;
12994
12995		retry_count = 4243;
12996
12997		sense = &msg.scsi.sense_data;
12998		sks[0] = SSD_SCS_VALID;
12999		sks[1] = (retry_count >> 8) & 0xff;
13000		sks[2] = retry_count & 0xff;
13001
13002		/* "Internal target failure" */
13003		scsi_set_sense_data(sense,
13004				    /*sense_format*/ SSD_TYPE_NONE,
13005				    /*current_error*/ 1,
13006				    /*sense_key*/ SSD_KEY_HARDWARE_ERROR,
13007				    /*asc*/ 0x44,
13008				    /*ascq*/ 0x00,
13009				    /*type*/ SSD_ELEM_SKS,
13010				    /*size*/ sizeof(sks),
13011				    /*data*/ sks,
13012				    SSD_ELEM_NONE);
13013
13014		io->io_hdr.flags &= ~CTL_FLAG_IO_ACTIVE;
13015		if (io->io_hdr.flags & CTL_FLAG_FAILOVER) {
13016			ctl_failover_io(io, /*have_lock*/ 1);
13017			mtx_unlock(&softc->ctl_lock);
13018			return;
13019		}
13020
13021		mtx_unlock(&softc->ctl_lock);
13022
13023		if (ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg, sizeof(msg), 0) >
13024		    CTL_HA_STATUS_SUCCESS) {
13025			/* XXX KDM what to do if this fails? */
13026		}
13027		return;
13028	}
13029
13030}
13031
13032static int
13033ctl_process_done(union ctl_io *io, int have_lock)
13034{
13035	struct ctl_lun *lun;
13036	struct ctl_softc *ctl_softc;
13037	void (*fe_done)(union ctl_io *io);
13038	uint32_t targ_port = ctl_port_idx(io->io_hdr.nexus.targ_port);
13039
13040	CTL_DEBUG_PRINT(("ctl_process_done\n"));
13041
13042	fe_done =
13043	    control_softc->ctl_ports[targ_port]->fe_done;
13044
13045#ifdef CTL_TIME_IO
13046	if ((time_uptime - io->io_hdr.start_time) > ctl_time_io_secs) {
13047		char str[256];
13048		char path_str[64];
13049		struct sbuf sb;
13050
13051		ctl_scsi_path_string(io, path_str, sizeof(path_str));
13052		sbuf_new(&sb, str, sizeof(str), SBUF_FIXEDLEN);
13053
13054		sbuf_cat(&sb, path_str);
13055		switch (io->io_hdr.io_type) {
13056		case CTL_IO_SCSI:
13057			ctl_scsi_command_string(&io->scsiio, NULL, &sb);
13058			sbuf_printf(&sb, "\n");
13059			sbuf_cat(&sb, path_str);
13060			sbuf_printf(&sb, "Tag: 0x%04x, type %d\n",
13061				    io->scsiio.tag_num, io->scsiio.tag_type);
13062			break;
13063		case CTL_IO_TASK:
13064			sbuf_printf(&sb, "Task I/O type: %d, Tag: 0x%04x, "
13065				    "Tag Type: %d\n", io->taskio.task_action,
13066				    io->taskio.tag_num, io->taskio.tag_type);
13067			break;
13068		default:
13069			printf("Invalid CTL I/O type %d\n", io->io_hdr.io_type);
13070			panic("Invalid CTL I/O type %d\n", io->io_hdr.io_type);
13071			break;
13072		}
13073		sbuf_cat(&sb, path_str);
13074		sbuf_printf(&sb, "ctl_process_done: %jd seconds\n",
13075			    (intmax_t)time_uptime - io->io_hdr.start_time);
13076		sbuf_finish(&sb);
13077		printf("%s", sbuf_data(&sb));
13078	}
13079#endif /* CTL_TIME_IO */
13080
13081	switch (io->io_hdr.io_type) {
13082	case CTL_IO_SCSI:
13083		break;
13084	case CTL_IO_TASK:
13085		if (bootverbose || verbose > 0)
13086			ctl_io_error_print(io, NULL);
13087		if (io->io_hdr.flags & CTL_FLAG_FROM_OTHER_SC)
13088			ctl_free_io(io);
13089		else
13090			fe_done(io);
13091		return (CTL_RETVAL_COMPLETE);
13092		break;
13093	default:
13094		printf("ctl_process_done: invalid io type %d\n",
13095		       io->io_hdr.io_type);
13096		panic("ctl_process_done: invalid io type %d\n",
13097		      io->io_hdr.io_type);
13098		break; /* NOTREACHED */
13099	}
13100
13101	lun = (struct ctl_lun *)io->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
13102	if (lun == NULL) {
13103		CTL_DEBUG_PRINT(("NULL LUN for lun %d\n",
13104				 io->io_hdr.nexus.targ_lun));
13105		fe_done(io);
13106		goto bailout;
13107	}
13108	ctl_softc = lun->ctl_softc;
13109
13110	/*
13111	 * Remove this from the OOA queue.
13112	 */
13113	if (have_lock == 0)
13114		mtx_lock(&ctl_softc->ctl_lock);
13115
13116	/*
13117	 * Check to see if we have any errors to inject here.  We only
13118	 * inject errors for commands that don't already have errors set.
13119	 */
13120	if ((STAILQ_FIRST(&lun->error_list) != NULL)
13121	 && ((io->io_hdr.status & CTL_STATUS_MASK) == CTL_SUCCESS))
13122		ctl_inject_error(lun, io);
13123
13124	/*
13125	 * XXX KDM how do we treat commands that aren't completed
13126	 * successfully?
13127	 *
13128	 * XXX KDM should we also track I/O latency?
13129	 */
13130	if ((io->io_hdr.status & CTL_STATUS_MASK) == CTL_SUCCESS) {
13131		uint32_t blocksize;
13132#ifdef CTL_TIME_IO
13133		struct bintime cur_bt;
13134#endif
13135
13136		if ((lun->be_lun != NULL)
13137		 && (lun->be_lun->blocksize != 0))
13138			blocksize = lun->be_lun->blocksize;
13139		else
13140			blocksize = 512;
13141
13142		switch (io->io_hdr.io_type) {
13143		case CTL_IO_SCSI: {
13144			int isread;
13145			struct ctl_lba_len_flags *lbalen;
13146
13147			isread = 0;
13148			switch (io->scsiio.cdb[0]) {
13149			case READ_6:
13150			case READ_10:
13151			case READ_12:
13152			case READ_16:
13153				isread = 1;
13154				/* FALLTHROUGH */
13155			case WRITE_6:
13156			case WRITE_10:
13157			case WRITE_12:
13158			case WRITE_16:
13159			case WRITE_VERIFY_10:
13160			case WRITE_VERIFY_12:
13161			case WRITE_VERIFY_16:
13162				lbalen = (struct ctl_lba_len_flags *)
13163				    &io->io_hdr.ctl_private[CTL_PRIV_LBA_LEN];
13164
13165				if (isread) {
13166					lun->stats.ports[targ_port].bytes[CTL_STATS_READ] +=
13167					    lbalen->len * blocksize;
13168					lun->stats.ports[targ_port].operations[CTL_STATS_READ]++;
13169
13170#ifdef CTL_TIME_IO
13171					bintime_add(
13172					   &lun->stats.ports[targ_port].dma_time[CTL_STATS_READ],
13173					   &io->io_hdr.dma_bt);
13174					lun->stats.ports[targ_port].num_dmas[CTL_STATS_READ] +=
13175						io->io_hdr.num_dmas;
13176					getbintime(&cur_bt);
13177					bintime_sub(&cur_bt,
13178						    &io->io_hdr.start_bt);
13179
13180					bintime_add(
13181					    &lun->stats.ports[targ_port].time[CTL_STATS_READ],
13182					    &cur_bt);
13183
13184#if 0
13185					cs_prof_gettime(&cur_ticks);
13186					lun->stats.time[CTL_STATS_READ] +=
13187						cur_ticks -
13188						io->io_hdr.start_ticks;
13189#endif
13190#if 0
13191					lun->stats.time[CTL_STATS_READ] +=
13192						jiffies - io->io_hdr.start_time;
13193#endif
13194#endif /* CTL_TIME_IO */
13195				} else {
13196					lun->stats.ports[targ_port].bytes[CTL_STATS_WRITE] +=
13197					    lbalen->len * blocksize;
13198					lun->stats.ports[targ_port].operations[
13199						CTL_STATS_WRITE]++;
13200
13201#ifdef CTL_TIME_IO
13202					bintime_add(
13203					  &lun->stats.ports[targ_port].dma_time[CTL_STATS_WRITE],
13204					  &io->io_hdr.dma_bt);
13205					lun->stats.ports[targ_port].num_dmas[CTL_STATS_WRITE] +=
13206						io->io_hdr.num_dmas;
13207					getbintime(&cur_bt);
13208					bintime_sub(&cur_bt,
13209						    &io->io_hdr.start_bt);
13210
13211					bintime_add(
13212					    &lun->stats.ports[targ_port].time[CTL_STATS_WRITE],
13213					    &cur_bt);
13214#if 0
13215					cs_prof_gettime(&cur_ticks);
13216					lun->stats.ports[targ_port].time[CTL_STATS_WRITE] +=
13217						cur_ticks -
13218						io->io_hdr.start_ticks;
13219					lun->stats.ports[targ_port].time[CTL_STATS_WRITE] +=
13220						jiffies - io->io_hdr.start_time;
13221#endif
13222#endif /* CTL_TIME_IO */
13223				}
13224				break;
13225			default:
13226				lun->stats.ports[targ_port].operations[CTL_STATS_NO_IO]++;
13227
13228#ifdef CTL_TIME_IO
13229				bintime_add(
13230				  &lun->stats.ports[targ_port].dma_time[CTL_STATS_NO_IO],
13231				  &io->io_hdr.dma_bt);
13232				lun->stats.ports[targ_port].num_dmas[CTL_STATS_NO_IO] +=
13233					io->io_hdr.num_dmas;
13234				getbintime(&cur_bt);
13235				bintime_sub(&cur_bt, &io->io_hdr.start_bt);
13236
13237				bintime_add(&lun->stats.ports[targ_port].time[CTL_STATS_NO_IO],
13238					    &cur_bt);
13239
13240#if 0
13241				cs_prof_gettime(&cur_ticks);
13242				lun->stats.ports[targ_port].time[CTL_STATS_NO_IO] +=
13243					cur_ticks -
13244					io->io_hdr.start_ticks;
13245				lun->stats.ports[targ_port].time[CTL_STATS_NO_IO] +=
13246					jiffies - io->io_hdr.start_time;
13247#endif
13248#endif /* CTL_TIME_IO */
13249				break;
13250			}
13251			break;
13252		}
13253		default:
13254			break;
13255		}
13256	}
13257
13258	TAILQ_REMOVE(&lun->ooa_queue, &io->io_hdr, ooa_links);
13259
13260	/*
13261	 * Run through the blocked queue on this LUN and see if anything
13262	 * has become unblocked, now that this transaction is done.
13263	 */
13264	ctl_check_blocked(lun);
13265
13266	/*
13267	 * If the LUN has been invalidated, free it if there is nothing
13268	 * left on its OOA queue.
13269	 */
13270	if ((lun->flags & CTL_LUN_INVALID)
13271	 && (TAILQ_FIRST(&lun->ooa_queue) == NULL))
13272		ctl_free_lun(lun);
13273
13274	/*
13275	 * If this command has been aborted, make sure we set the status
13276	 * properly.  The FETD is responsible for freeing the I/O and doing
13277	 * whatever it needs to do to clean up its state.
13278	 */
13279	if (io->io_hdr.flags & CTL_FLAG_ABORT)
13280		io->io_hdr.status = CTL_CMD_ABORTED;
13281
13282	/*
13283	 * We print out status for every task management command.  For SCSI
13284	 * commands, we filter out any unit attention errors; they happen
13285	 * on every boot, and would clutter up the log.  Note:  task
13286	 * management commands aren't printed here, they are printed above,
13287	 * since they should never even make it down here.
13288	 */
13289	switch (io->io_hdr.io_type) {
13290	case CTL_IO_SCSI: {
13291		int error_code, sense_key, asc, ascq;
13292
13293		sense_key = 0;
13294
13295		if (((io->io_hdr.status & CTL_STATUS_MASK) == CTL_SCSI_ERROR)
13296		 && (io->scsiio.scsi_status == SCSI_STATUS_CHECK_COND)) {
13297			/*
13298			 * Since this is just for printing, no need to
13299			 * show errors here.
13300			 */
13301			scsi_extract_sense_len(&io->scsiio.sense_data,
13302					       io->scsiio.sense_len,
13303					       &error_code,
13304					       &sense_key,
13305					       &asc,
13306					       &ascq,
13307					       /*show_errors*/ 0);
13308		}
13309
13310		if (((io->io_hdr.status & CTL_STATUS_MASK) != CTL_SUCCESS)
13311		 && (((io->io_hdr.status & CTL_STATUS_MASK) != CTL_SCSI_ERROR)
13312		  || (io->scsiio.scsi_status != SCSI_STATUS_CHECK_COND)
13313		  || (sense_key != SSD_KEY_UNIT_ATTENTION))) {
13314
13315			if ((time_uptime - ctl_softc->last_print_jiffies) <= 0){
13316				ctl_softc->skipped_prints++;
13317				if (have_lock == 0)
13318					mtx_unlock(&ctl_softc->ctl_lock);
13319			} else {
13320				uint32_t skipped_prints;
13321
13322				skipped_prints = ctl_softc->skipped_prints;
13323
13324				ctl_softc->skipped_prints = 0;
13325				ctl_softc->last_print_jiffies = time_uptime;
13326
13327				if (have_lock == 0)
13328					mtx_unlock(&ctl_softc->ctl_lock);
13329				if (skipped_prints > 0) {
13330#ifdef NEEDTOPORT
13331					csevent_log(CSC_CTL | CSC_SHELF_SW |
13332					    CTL_ERROR_REPORT,
13333					    csevent_LogType_Trace,
13334					    csevent_Severity_Information,
13335					    csevent_AlertLevel_Green,
13336					    csevent_FRU_Firmware,
13337					    csevent_FRU_Unknown,
13338					    "High CTL error volume, %d prints "
13339					    "skipped", skipped_prints);
13340#endif
13341				}
13342				if (bootverbose || verbose > 0)
13343					ctl_io_error_print(io, NULL);
13344			}
13345		} else {
13346			if (have_lock == 0)
13347				mtx_unlock(&ctl_softc->ctl_lock);
13348		}
13349		break;
13350	}
13351	case CTL_IO_TASK:
13352		if (have_lock == 0)
13353			mtx_unlock(&ctl_softc->ctl_lock);
13354		if (bootverbose || verbose > 0)
13355			ctl_io_error_print(io, NULL);
13356		break;
13357	default:
13358		if (have_lock == 0)
13359			mtx_unlock(&ctl_softc->ctl_lock);
13360		break;
13361	}
13362
13363	/*
13364	 * Tell the FETD or the other shelf controller we're done with this
13365	 * command.  Note that only SCSI commands get to this point.  Task
13366	 * management commands are completed above.
13367	 *
13368	 * We only send status to the other controller if we're in XFER
13369	 * mode.  In SER_ONLY mode, the I/O is done on the controller that
13370	 * received the I/O (from CTL's perspective), and so the status is
13371	 * generated there.
13372	 *
13373	 * XXX KDM if we hold the lock here, we could cause a deadlock
13374	 * if the frontend comes back in in this context to queue
13375	 * something.
13376	 */
13377	if ((ctl_softc->ha_mode == CTL_HA_MODE_XFER)
13378	 && (io->io_hdr.flags & CTL_FLAG_FROM_OTHER_SC)) {
13379		union ctl_ha_msg msg;
13380
13381		memset(&msg, 0, sizeof(msg));
13382		msg.hdr.msg_type = CTL_MSG_FINISH_IO;
13383		msg.hdr.original_sc = io->io_hdr.original_sc;
13384		msg.hdr.nexus = io->io_hdr.nexus;
13385		msg.hdr.status = io->io_hdr.status;
13386		msg.scsi.scsi_status = io->scsiio.scsi_status;
13387		msg.scsi.tag_num = io->scsiio.tag_num;
13388		msg.scsi.tag_type = io->scsiio.tag_type;
13389		msg.scsi.sense_len = io->scsiio.sense_len;
13390		msg.scsi.sense_residual = io->scsiio.sense_residual;
13391		msg.scsi.residual = io->scsiio.residual;
13392		memcpy(&msg.scsi.sense_data, &io->scsiio.sense_data,
13393		       sizeof(io->scsiio.sense_data));
13394		/*
13395		 * We copy this whether or not this is an I/O-related
13396		 * command.  Otherwise, we'd have to go and check to see
13397		 * whether it's a read/write command, and it really isn't
13398		 * worth it.
13399		 */
13400		memcpy(&msg.scsi.lbalen,
13401		       &io->io_hdr.ctl_private[CTL_PRIV_LBA_LEN].bytes,
13402		       sizeof(msg.scsi.lbalen));
13403
13404		if (ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg,
13405				sizeof(msg), 0) > CTL_HA_STATUS_SUCCESS) {
13406			/* XXX do something here */
13407		}
13408
13409		ctl_free_io(io);
13410	} else
13411		fe_done(io);
13412
13413bailout:
13414
13415	return (CTL_RETVAL_COMPLETE);
13416}
13417
13418/*
13419 * Front end should call this if it doesn't do autosense.  When the request
13420 * sense comes back in from the initiator, we'll dequeue this and send it.
13421 */
13422int
13423ctl_queue_sense(union ctl_io *io)
13424{
13425	struct ctl_lun *lun;
13426	struct ctl_softc *ctl_softc;
13427	uint32_t initidx, targ_lun;
13428
13429	ctl_softc = control_softc;
13430
13431	CTL_DEBUG_PRINT(("ctl_queue_sense\n"));
13432
13433	/*
13434	 * LUN lookup will likely move to the ctl_work_thread() once we
13435	 * have our new queueing infrastructure (that doesn't put things on
13436	 * a per-LUN queue initially).  That is so that we can handle
13437	 * things like an INQUIRY to a LUN that we don't have enabled.  We
13438	 * can't deal with that right now.
13439	 */
13440	mtx_lock(&ctl_softc->ctl_lock);
13441
13442	/*
13443	 * If we don't have a LUN for this, just toss the sense
13444	 * information.
13445	 */
13446	targ_lun = io->io_hdr.nexus.targ_lun;
13447	if (io->io_hdr.nexus.lun_map_fn != NULL)
13448		targ_lun = io->io_hdr.nexus.lun_map_fn(io->io_hdr.nexus.lun_map_arg, targ_lun);
13449	if ((targ_lun < CTL_MAX_LUNS)
13450	 && (ctl_softc->ctl_luns[targ_lun] != NULL))
13451		lun = ctl_softc->ctl_luns[targ_lun];
13452	else
13453		goto bailout;
13454
13455	initidx = ctl_get_initindex(&io->io_hdr.nexus);
13456
13457	/*
13458	 * Already have CA set for this LUN...toss the sense information.
13459	 */
13460	if (ctl_is_set(lun->have_ca, initidx))
13461		goto bailout;
13462
13463	memcpy(&lun->pending_sense[initidx].sense, &io->scsiio.sense_data,
13464	       ctl_min(sizeof(lun->pending_sense[initidx].sense),
13465	       sizeof(io->scsiio.sense_data)));
13466	ctl_set_mask(lun->have_ca, initidx);
13467
13468bailout:
13469	mtx_unlock(&ctl_softc->ctl_lock);
13470
13471	ctl_free_io(io);
13472
13473	return (CTL_RETVAL_COMPLETE);
13474}
13475
13476/*
13477 * Primary command inlet from frontend ports.  All SCSI and task I/O
13478 * requests must go through this function.
13479 */
13480int
13481ctl_queue(union ctl_io *io)
13482{
13483	struct ctl_softc *ctl_softc;
13484
13485	CTL_DEBUG_PRINT(("ctl_queue cdb[0]=%02X\n", io->scsiio.cdb[0]));
13486
13487	ctl_softc = control_softc;
13488
13489#ifdef CTL_TIME_IO
13490	io->io_hdr.start_time = time_uptime;
13491	getbintime(&io->io_hdr.start_bt);
13492#endif /* CTL_TIME_IO */
13493
13494	mtx_lock(&ctl_softc->ctl_lock);
13495
13496	switch (io->io_hdr.io_type) {
13497	case CTL_IO_SCSI:
13498		STAILQ_INSERT_TAIL(&ctl_softc->incoming_queue, &io->io_hdr,
13499				   links);
13500		break;
13501	case CTL_IO_TASK:
13502		STAILQ_INSERT_TAIL(&ctl_softc->task_queue, &io->io_hdr, links);
13503		/*
13504		 * Set the task pending flag.  This is necessary to close a
13505		 * race condition with the FETD:
13506		 *
13507		 * - FETD submits a task management command, like an abort.
13508		 * - Back end calls fe_datamove() to move the data for the
13509		 *   aborted command.  The FETD can't really accept it, but
13510		 *   if it did, it would end up transmitting data for a
13511		 *   command that the initiator told us to abort.
13512		 *
13513		 * We close the race condition by setting the flag here,
13514		 * and checking it in ctl_datamove(), before calling the
13515		 * FETD's fe_datamove routine.  If we've got a task
13516		 * pending, we run the task queue and then check to see
13517		 * whether our particular I/O has been aborted.
13518		 */
13519		ctl_softc->flags |= CTL_FLAG_TASK_PENDING;
13520		break;
13521	default:
13522		mtx_unlock(&ctl_softc->ctl_lock);
13523		printf("ctl_queue: unknown I/O type %d\n", io->io_hdr.io_type);
13524		return (EINVAL);
13525		break; /* NOTREACHED */
13526	}
13527	mtx_unlock(&ctl_softc->ctl_lock);
13528
13529	ctl_wakeup_thread();
13530
13531	return (CTL_RETVAL_COMPLETE);
13532}
13533
13534#ifdef CTL_IO_DELAY
13535static void
13536ctl_done_timer_wakeup(void *arg)
13537{
13538	union ctl_io *io;
13539
13540	io = (union ctl_io *)arg;
13541	ctl_done_lock(io, /*have_lock*/ 0);
13542}
13543#endif /* CTL_IO_DELAY */
13544
13545void
13546ctl_done_lock(union ctl_io *io, int have_lock)
13547{
13548	struct ctl_softc *ctl_softc;
13549#ifndef CTL_DONE_THREAD
13550	union ctl_io *xio;
13551#endif /* !CTL_DONE_THREAD */
13552
13553	ctl_softc = control_softc;
13554
13555	if (have_lock == 0)
13556		mtx_lock(&ctl_softc->ctl_lock);
13557
13558	/*
13559	 * Enable this to catch duplicate completion issues.
13560	 */
13561#if 0
13562	if (io->io_hdr.flags & CTL_FLAG_ALREADY_DONE) {
13563		printf("%s: type %d msg %d cdb %x iptl: "
13564		       "%d:%d:%d:%d tag 0x%04x "
13565		       "flag %#x status %x\n",
13566			__func__,
13567			io->io_hdr.io_type,
13568			io->io_hdr.msg_type,
13569			io->scsiio.cdb[0],
13570			io->io_hdr.nexus.initid.id,
13571			io->io_hdr.nexus.targ_port,
13572			io->io_hdr.nexus.targ_target.id,
13573			io->io_hdr.nexus.targ_lun,
13574			(io->io_hdr.io_type ==
13575			CTL_IO_TASK) ?
13576			io->taskio.tag_num :
13577			io->scsiio.tag_num,
13578		        io->io_hdr.flags,
13579			io->io_hdr.status);
13580	} else
13581		io->io_hdr.flags |= CTL_FLAG_ALREADY_DONE;
13582#endif
13583
13584	/*
13585	 * This is an internal copy of an I/O, and should not go through
13586	 * the normal done processing logic.
13587	 */
13588	if (io->io_hdr.flags & CTL_FLAG_INT_COPY) {
13589		if (have_lock == 0)
13590			mtx_unlock(&ctl_softc->ctl_lock);
13591		return;
13592	}
13593
13594	/*
13595	 * We need to send a msg to the serializing shelf to finish the IO
13596	 * as well.  We don't send a finish message to the other shelf if
13597	 * this is a task management command.  Task management commands
13598	 * aren't serialized in the OOA queue, but rather just executed on
13599	 * both shelf controllers for commands that originated on that
13600	 * controller.
13601	 */
13602	if ((io->io_hdr.flags & CTL_FLAG_SENT_2OTHER_SC)
13603	 && (io->io_hdr.io_type != CTL_IO_TASK)) {
13604		union ctl_ha_msg msg_io;
13605
13606		msg_io.hdr.msg_type = CTL_MSG_FINISH_IO;
13607		msg_io.hdr.serializing_sc = io->io_hdr.serializing_sc;
13608		if (ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg_io,
13609		    sizeof(msg_io), 0 ) != CTL_HA_STATUS_SUCCESS) {
13610		}
13611		/* continue on to finish IO */
13612	}
13613#ifdef CTL_IO_DELAY
13614	if (io->io_hdr.flags & CTL_FLAG_DELAY_DONE) {
13615		struct ctl_lun *lun;
13616
13617		lun =(struct ctl_lun *)io->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
13618
13619		io->io_hdr.flags &= ~CTL_FLAG_DELAY_DONE;
13620	} else {
13621		struct ctl_lun *lun;
13622
13623		lun =(struct ctl_lun *)io->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
13624
13625		if ((lun != NULL)
13626		 && (lun->delay_info.done_delay > 0)) {
13627			struct callout *callout;
13628
13629			callout = (struct callout *)&io->io_hdr.timer_bytes;
13630			callout_init(callout, /*mpsafe*/ 1);
13631			io->io_hdr.flags |= CTL_FLAG_DELAY_DONE;
13632			callout_reset(callout,
13633				      lun->delay_info.done_delay * hz,
13634				      ctl_done_timer_wakeup, io);
13635			if (lun->delay_info.done_type == CTL_DELAY_TYPE_ONESHOT)
13636				lun->delay_info.done_delay = 0;
13637			if (have_lock == 0)
13638				mtx_unlock(&ctl_softc->ctl_lock);
13639			return;
13640		}
13641	}
13642#endif /* CTL_IO_DELAY */
13643
13644	STAILQ_INSERT_TAIL(&ctl_softc->done_queue, &io->io_hdr, links);
13645
13646#ifdef CTL_DONE_THREAD
13647	if (have_lock == 0)
13648		mtx_unlock(&ctl_softc->ctl_lock);
13649
13650	ctl_wakeup_thread();
13651#else /* CTL_DONE_THREAD */
13652	for (xio = (union ctl_io *)STAILQ_FIRST(&ctl_softc->done_queue);
13653	     xio != NULL;
13654	     xio =(union ctl_io *)STAILQ_FIRST(&ctl_softc->done_queue)) {
13655
13656		STAILQ_REMOVE_HEAD(&ctl_softc->done_queue, links);
13657
13658		ctl_process_done(xio, /*have_lock*/ 1);
13659	}
13660	if (have_lock == 0)
13661		mtx_unlock(&ctl_softc->ctl_lock);
13662#endif /* CTL_DONE_THREAD */
13663}
13664
13665void
13666ctl_done(union ctl_io *io)
13667{
13668	ctl_done_lock(io, /*have_lock*/ 0);
13669}
13670
13671int
13672ctl_isc(struct ctl_scsiio *ctsio)
13673{
13674	struct ctl_lun *lun;
13675	int retval;
13676
13677	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
13678
13679	CTL_DEBUG_PRINT(("ctl_isc: command: %02x\n", ctsio->cdb[0]));
13680
13681	CTL_DEBUG_PRINT(("ctl_isc: calling data_submit()\n"));
13682
13683	retval = lun->backend->data_submit((union ctl_io *)ctsio);
13684
13685	return (retval);
13686}
13687
13688
13689static void
13690ctl_work_thread(void *arg)
13691{
13692	struct ctl_softc *softc;
13693	union ctl_io *io;
13694	struct ctl_be_lun *be_lun;
13695	int retval;
13696
13697	CTL_DEBUG_PRINT(("ctl_work_thread starting\n"));
13698
13699	softc = (struct ctl_softc *)arg;
13700	if (softc == NULL)
13701		return;
13702
13703	mtx_lock(&softc->ctl_lock);
13704	for (;;) {
13705		retval = 0;
13706
13707		/*
13708		 * We handle the queues in this order:
13709		 * - task management
13710		 * - ISC
13711		 * - done queue (to free up resources, unblock other commands)
13712		 * - RtR queue
13713		 * - incoming queue
13714		 *
13715		 * If those queues are empty, we break out of the loop and
13716		 * go to sleep.
13717		 */
13718		io = (union ctl_io *)STAILQ_FIRST(&softc->task_queue);
13719		if (io != NULL) {
13720			ctl_run_task_queue(softc);
13721			continue;
13722		}
13723		io = (union ctl_io *)STAILQ_FIRST(&softc->isc_queue);
13724		if (io != NULL) {
13725			STAILQ_REMOVE_HEAD(&softc->isc_queue, links);
13726			ctl_handle_isc(io);
13727			continue;
13728		}
13729		io = (union ctl_io *)STAILQ_FIRST(&softc->done_queue);
13730		if (io != NULL) {
13731			STAILQ_REMOVE_HEAD(&softc->done_queue, links);
13732			/* clear any blocked commands, call fe_done */
13733			mtx_unlock(&softc->ctl_lock);
13734			/*
13735			 * XXX KDM
13736			 * Call this without a lock for now.  This will
13737			 * depend on whether there is any way the FETD can
13738			 * sleep or deadlock if called with the CTL lock
13739			 * held.
13740			 */
13741			retval = ctl_process_done(io, /*have_lock*/ 0);
13742			mtx_lock(&softc->ctl_lock);
13743			continue;
13744		}
13745		if (!ctl_pause_rtr) {
13746			io = (union ctl_io *)STAILQ_FIRST(&softc->rtr_queue);
13747			if (io != NULL) {
13748				STAILQ_REMOVE_HEAD(&softc->rtr_queue, links);
13749				mtx_unlock(&softc->ctl_lock);
13750				retval = ctl_scsiio(&io->scsiio);
13751				if (retval != CTL_RETVAL_COMPLETE)
13752					CTL_DEBUG_PRINT(("ctl_scsiio failed\n"));
13753				mtx_lock(&softc->ctl_lock);
13754				continue;
13755			}
13756		}
13757		io = (union ctl_io *)STAILQ_FIRST(&softc->incoming_queue);
13758		if (io != NULL) {
13759			STAILQ_REMOVE_HEAD(&softc->incoming_queue, links);
13760			mtx_unlock(&softc->ctl_lock);
13761			ctl_scsiio_precheck(softc, &io->scsiio);
13762			mtx_lock(&softc->ctl_lock);
13763			continue;
13764		}
13765		/*
13766		 * We might want to move this to a separate thread, so that
13767		 * configuration requests (in this case LUN creations)
13768		 * won't impact the I/O path.
13769		 */
13770		be_lun = STAILQ_FIRST(&softc->pending_lun_queue);
13771		if (be_lun != NULL) {
13772			STAILQ_REMOVE_HEAD(&softc->pending_lun_queue, links);
13773			mtx_unlock(&softc->ctl_lock);
13774			ctl_create_lun(be_lun);
13775			mtx_lock(&softc->ctl_lock);
13776			continue;
13777		}
13778
13779		/* XXX KDM use the PDROP flag?? */
13780		/* Sleep until we have something to do. */
13781		mtx_sleep(softc, &softc->ctl_lock, PRIBIO, "-", 0);
13782
13783		/* Back to the top of the loop to see what woke us up. */
13784		continue;
13785	}
13786}
13787
13788void
13789ctl_wakeup_thread()
13790{
13791	struct ctl_softc *softc;
13792
13793	softc = control_softc;
13794
13795	wakeup_one(softc);
13796}
13797
13798/* Initialization and failover */
13799
13800void
13801ctl_init_isc_msg(void)
13802{
13803	printf("CTL: Still calling this thing\n");
13804}
13805
13806/*
13807 * Init component
13808 * 	Initializes component into configuration defined by bootMode
13809 *	(see hasc-sv.c)
13810 *  	returns hasc_Status:
13811 * 		OK
13812 *		ERROR - fatal error
13813 */
13814static ctl_ha_comp_status
13815ctl_isc_init(struct ctl_ha_component *c)
13816{
13817	ctl_ha_comp_status ret = CTL_HA_COMP_STATUS_OK;
13818
13819	c->status = ret;
13820	return ret;
13821}
13822
13823/* Start component
13824 * 	Starts component in state requested. If component starts successfully,
13825 *	it must set its own state to the requestrd state
13826 *	When requested state is HASC_STATE_HA, the component may refine it
13827 * 	by adding _SLAVE or _MASTER flags.
13828 *	Currently allowed state transitions are:
13829 *	UNKNOWN->HA		- initial startup
13830 *	UNKNOWN->SINGLE - initial startup when no parter detected
13831 *	HA->SINGLE		- failover
13832 * returns ctl_ha_comp_status:
13833 * 		OK	- component successfully started in requested state
13834 *		FAILED  - could not start the requested state, failover may
13835 * 			  be possible
13836 *		ERROR	- fatal error detected, no future startup possible
13837 */
13838static ctl_ha_comp_status
13839ctl_isc_start(struct ctl_ha_component *c, ctl_ha_state state)
13840{
13841	ctl_ha_comp_status ret = CTL_HA_COMP_STATUS_OK;
13842
13843	printf("%s: go\n", __func__);
13844
13845	// UNKNOWN->HA or UNKNOWN->SINGLE (bootstrap)
13846	if (c->state == CTL_HA_STATE_UNKNOWN ) {
13847		ctl_is_single = 0;
13848		if (ctl_ha_msg_create(CTL_HA_CHAN_CTL, ctl_isc_event_handler)
13849		    != CTL_HA_STATUS_SUCCESS) {
13850			printf("ctl_isc_start: ctl_ha_msg_create failed.\n");
13851			ret = CTL_HA_COMP_STATUS_ERROR;
13852		}
13853	} else if (CTL_HA_STATE_IS_HA(c->state)
13854		&& CTL_HA_STATE_IS_SINGLE(state)){
13855		// HA->SINGLE transition
13856	        ctl_failover();
13857		ctl_is_single = 1;
13858	} else {
13859		printf("ctl_isc_start:Invalid state transition %X->%X\n",
13860		       c->state, state);
13861		ret = CTL_HA_COMP_STATUS_ERROR;
13862	}
13863	if (CTL_HA_STATE_IS_SINGLE(state))
13864		ctl_is_single = 1;
13865
13866	c->state = state;
13867	c->status = ret;
13868	return ret;
13869}
13870
13871/*
13872 * Quiesce component
13873 * The component must clear any error conditions (set status to OK) and
13874 * prepare itself to another Start call
13875 * returns ctl_ha_comp_status:
13876 * 	OK
13877 *	ERROR
13878 */
13879static ctl_ha_comp_status
13880ctl_isc_quiesce(struct ctl_ha_component *c)
13881{
13882	int ret = CTL_HA_COMP_STATUS_OK;
13883
13884	ctl_pause_rtr = 1;
13885	c->status = ret;
13886	return ret;
13887}
13888
13889struct ctl_ha_component ctl_ha_component_ctlisc =
13890{
13891	.name = "CTL ISC",
13892	.state = CTL_HA_STATE_UNKNOWN,
13893	.init = ctl_isc_init,
13894	.start = ctl_isc_start,
13895	.quiesce = ctl_isc_quiesce
13896};
13897
13898/*
13899 *  vim: ts=8
13900 */
13901