ctl.c revision 311427
1/*-
2 * Copyright (c) 2003-2009 Silicon Graphics International Corp.
3 * Copyright (c) 2012 The FreeBSD Foundation
4 * Copyright (c) 2015 Alexander Motin <mav@FreeBSD.org>
5 * All rights reserved.
6 *
7 * Portions of this software were developed by Edward Tomasz Napierala
8 * under sponsorship from the FreeBSD Foundation.
9 *
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
12 * are met:
13 * 1. Redistributions of source code must retain the above copyright
14 *    notice, this list of conditions, and the following disclaimer,
15 *    without modification.
16 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
17 *    substantially similar to the "NO WARRANTY" disclaimer below
18 *    ("Disclaimer") and any redistribution must be conditioned upon
19 *    including a substantially similar Disclaimer requirement for further
20 *    binary redistribution.
21 *
22 * NO WARRANTY
23 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
24 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
25 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
26 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
27 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
31 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
32 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
33 * POSSIBILITY OF SUCH DAMAGES.
34 *
35 * $Id$
36 */
37/*
38 * CAM Target Layer, a SCSI device emulation subsystem.
39 *
40 * Author: Ken Merry <ken@FreeBSD.org>
41 */
42
43#define _CTL_C
44
45#include <sys/cdefs.h>
46__FBSDID("$FreeBSD: stable/11/sys/cam/ctl/ctl.c 311427 2017-01-05 11:44:56Z mav $");
47
48#include <sys/param.h>
49#include <sys/systm.h>
50#include <sys/ctype.h>
51#include <sys/kernel.h>
52#include <sys/types.h>
53#include <sys/kthread.h>
54#include <sys/bio.h>
55#include <sys/fcntl.h>
56#include <sys/lock.h>
57#include <sys/module.h>
58#include <sys/mutex.h>
59#include <sys/condvar.h>
60#include <sys/malloc.h>
61#include <sys/conf.h>
62#include <sys/ioccom.h>
63#include <sys/queue.h>
64#include <sys/sbuf.h>
65#include <sys/smp.h>
66#include <sys/endian.h>
67#include <sys/sysctl.h>
68#include <vm/uma.h>
69
70#include <cam/cam.h>
71#include <cam/scsi/scsi_all.h>
72#include <cam/scsi/scsi_cd.h>
73#include <cam/scsi/scsi_da.h>
74#include <cam/ctl/ctl_io.h>
75#include <cam/ctl/ctl.h>
76#include <cam/ctl/ctl_frontend.h>
77#include <cam/ctl/ctl_util.h>
78#include <cam/ctl/ctl_backend.h>
79#include <cam/ctl/ctl_ioctl.h>
80#include <cam/ctl/ctl_ha.h>
81#include <cam/ctl/ctl_private.h>
82#include <cam/ctl/ctl_debug.h>
83#include <cam/ctl/ctl_scsi_all.h>
84#include <cam/ctl/ctl_error.h>
85
86struct ctl_softc *control_softc = NULL;
87
88/*
89 * Template mode pages.
90 */
91
92/*
93 * Note that these are default values only.  The actual values will be
94 * filled in when the user does a mode sense.
95 */
96const static struct scsi_da_rw_recovery_page rw_er_page_default = {
97	/*page_code*/SMS_RW_ERROR_RECOVERY_PAGE,
98	/*page_length*/sizeof(struct scsi_da_rw_recovery_page) - 2,
99	/*byte3*/SMS_RWER_AWRE|SMS_RWER_ARRE,
100	/*read_retry_count*/0,
101	/*correction_span*/0,
102	/*head_offset_count*/0,
103	/*data_strobe_offset_cnt*/0,
104	/*byte8*/SMS_RWER_LBPERE,
105	/*write_retry_count*/0,
106	/*reserved2*/0,
107	/*recovery_time_limit*/{0, 0},
108};
109
110const static struct scsi_da_rw_recovery_page rw_er_page_changeable = {
111	/*page_code*/SMS_RW_ERROR_RECOVERY_PAGE,
112	/*page_length*/sizeof(struct scsi_da_rw_recovery_page) - 2,
113	/*byte3*/SMS_RWER_PER,
114	/*read_retry_count*/0,
115	/*correction_span*/0,
116	/*head_offset_count*/0,
117	/*data_strobe_offset_cnt*/0,
118	/*byte8*/SMS_RWER_LBPERE,
119	/*write_retry_count*/0,
120	/*reserved2*/0,
121	/*recovery_time_limit*/{0, 0},
122};
123
124const static struct scsi_format_page format_page_default = {
125	/*page_code*/SMS_FORMAT_DEVICE_PAGE,
126	/*page_length*/sizeof(struct scsi_format_page) - 2,
127	/*tracks_per_zone*/ {0, 0},
128	/*alt_sectors_per_zone*/ {0, 0},
129	/*alt_tracks_per_zone*/ {0, 0},
130	/*alt_tracks_per_lun*/ {0, 0},
131	/*sectors_per_track*/ {(CTL_DEFAULT_SECTORS_PER_TRACK >> 8) & 0xff,
132			        CTL_DEFAULT_SECTORS_PER_TRACK & 0xff},
133	/*bytes_per_sector*/ {0, 0},
134	/*interleave*/ {0, 0},
135	/*track_skew*/ {0, 0},
136	/*cylinder_skew*/ {0, 0},
137	/*flags*/ SFP_HSEC,
138	/*reserved*/ {0, 0, 0}
139};
140
141const static struct scsi_format_page format_page_changeable = {
142	/*page_code*/SMS_FORMAT_DEVICE_PAGE,
143	/*page_length*/sizeof(struct scsi_format_page) - 2,
144	/*tracks_per_zone*/ {0, 0},
145	/*alt_sectors_per_zone*/ {0, 0},
146	/*alt_tracks_per_zone*/ {0, 0},
147	/*alt_tracks_per_lun*/ {0, 0},
148	/*sectors_per_track*/ {0, 0},
149	/*bytes_per_sector*/ {0, 0},
150	/*interleave*/ {0, 0},
151	/*track_skew*/ {0, 0},
152	/*cylinder_skew*/ {0, 0},
153	/*flags*/ 0,
154	/*reserved*/ {0, 0, 0}
155};
156
157const static struct scsi_rigid_disk_page rigid_disk_page_default = {
158	/*page_code*/SMS_RIGID_DISK_PAGE,
159	/*page_length*/sizeof(struct scsi_rigid_disk_page) - 2,
160	/*cylinders*/ {0, 0, 0},
161	/*heads*/ CTL_DEFAULT_HEADS,
162	/*start_write_precomp*/ {0, 0, 0},
163	/*start_reduced_current*/ {0, 0, 0},
164	/*step_rate*/ {0, 0},
165	/*landing_zone_cylinder*/ {0, 0, 0},
166	/*rpl*/ SRDP_RPL_DISABLED,
167	/*rotational_offset*/ 0,
168	/*reserved1*/ 0,
169	/*rotation_rate*/ {(CTL_DEFAULT_ROTATION_RATE >> 8) & 0xff,
170			   CTL_DEFAULT_ROTATION_RATE & 0xff},
171	/*reserved2*/ {0, 0}
172};
173
174const static struct scsi_rigid_disk_page rigid_disk_page_changeable = {
175	/*page_code*/SMS_RIGID_DISK_PAGE,
176	/*page_length*/sizeof(struct scsi_rigid_disk_page) - 2,
177	/*cylinders*/ {0, 0, 0},
178	/*heads*/ 0,
179	/*start_write_precomp*/ {0, 0, 0},
180	/*start_reduced_current*/ {0, 0, 0},
181	/*step_rate*/ {0, 0},
182	/*landing_zone_cylinder*/ {0, 0, 0},
183	/*rpl*/ 0,
184	/*rotational_offset*/ 0,
185	/*reserved1*/ 0,
186	/*rotation_rate*/ {0, 0},
187	/*reserved2*/ {0, 0}
188};
189
190const static struct scsi_da_verify_recovery_page verify_er_page_default = {
191	/*page_code*/SMS_VERIFY_ERROR_RECOVERY_PAGE,
192	/*page_length*/sizeof(struct scsi_da_verify_recovery_page) - 2,
193	/*byte3*/0,
194	/*read_retry_count*/0,
195	/*reserved*/{ 0, 0, 0, 0, 0, 0 },
196	/*recovery_time_limit*/{0, 0},
197};
198
199const static struct scsi_da_verify_recovery_page verify_er_page_changeable = {
200	/*page_code*/SMS_VERIFY_ERROR_RECOVERY_PAGE,
201	/*page_length*/sizeof(struct scsi_da_verify_recovery_page) - 2,
202	/*byte3*/SMS_VER_PER,
203	/*read_retry_count*/0,
204	/*reserved*/{ 0, 0, 0, 0, 0, 0 },
205	/*recovery_time_limit*/{0, 0},
206};
207
208const static struct scsi_caching_page caching_page_default = {
209	/*page_code*/SMS_CACHING_PAGE,
210	/*page_length*/sizeof(struct scsi_caching_page) - 2,
211	/*flags1*/ SCP_DISC | SCP_WCE,
212	/*ret_priority*/ 0,
213	/*disable_pf_transfer_len*/ {0xff, 0xff},
214	/*min_prefetch*/ {0, 0},
215	/*max_prefetch*/ {0xff, 0xff},
216	/*max_pf_ceiling*/ {0xff, 0xff},
217	/*flags2*/ 0,
218	/*cache_segments*/ 0,
219	/*cache_seg_size*/ {0, 0},
220	/*reserved*/ 0,
221	/*non_cache_seg_size*/ {0, 0, 0}
222};
223
224const static struct scsi_caching_page caching_page_changeable = {
225	/*page_code*/SMS_CACHING_PAGE,
226	/*page_length*/sizeof(struct scsi_caching_page) - 2,
227	/*flags1*/ SCP_WCE | SCP_RCD,
228	/*ret_priority*/ 0,
229	/*disable_pf_transfer_len*/ {0, 0},
230	/*min_prefetch*/ {0, 0},
231	/*max_prefetch*/ {0, 0},
232	/*max_pf_ceiling*/ {0, 0},
233	/*flags2*/ 0,
234	/*cache_segments*/ 0,
235	/*cache_seg_size*/ {0, 0},
236	/*reserved*/ 0,
237	/*non_cache_seg_size*/ {0, 0, 0}
238};
239
240const static struct scsi_control_page control_page_default = {
241	/*page_code*/SMS_CONTROL_MODE_PAGE,
242	/*page_length*/sizeof(struct scsi_control_page) - 2,
243	/*rlec*/0,
244	/*queue_flags*/SCP_QUEUE_ALG_RESTRICTED,
245	/*eca_and_aen*/0,
246	/*flags4*/SCP_TAS,
247	/*aen_holdoff_period*/{0, 0},
248	/*busy_timeout_period*/{0, 0},
249	/*extended_selftest_completion_time*/{0, 0}
250};
251
252const static struct scsi_control_page control_page_changeable = {
253	/*page_code*/SMS_CONTROL_MODE_PAGE,
254	/*page_length*/sizeof(struct scsi_control_page) - 2,
255	/*rlec*/SCP_DSENSE,
256	/*queue_flags*/SCP_QUEUE_ALG_MASK | SCP_NUAR,
257	/*eca_and_aen*/SCP_SWP,
258	/*flags4*/0,
259	/*aen_holdoff_period*/{0, 0},
260	/*busy_timeout_period*/{0, 0},
261	/*extended_selftest_completion_time*/{0, 0}
262};
263
264#define CTL_CEM_LEN	(sizeof(struct scsi_control_ext_page) - 4)
265
266const static struct scsi_control_ext_page control_ext_page_default = {
267	/*page_code*/SMS_CONTROL_MODE_PAGE | SMPH_SPF,
268	/*subpage_code*/0x01,
269	/*page_length*/{CTL_CEM_LEN >> 8, CTL_CEM_LEN},
270	/*flags*/0,
271	/*prio*/0,
272	/*max_sense*/0
273};
274
275const static struct scsi_control_ext_page control_ext_page_changeable = {
276	/*page_code*/SMS_CONTROL_MODE_PAGE | SMPH_SPF,
277	/*subpage_code*/0x01,
278	/*page_length*/{CTL_CEM_LEN >> 8, CTL_CEM_LEN},
279	/*flags*/0,
280	/*prio*/0,
281	/*max_sense*/0
282};
283
284const static struct scsi_info_exceptions_page ie_page_default = {
285	/*page_code*/SMS_INFO_EXCEPTIONS_PAGE,
286	/*page_length*/sizeof(struct scsi_info_exceptions_page) - 2,
287	/*info_flags*/SIEP_FLAGS_EWASC,
288	/*mrie*/SIEP_MRIE_NO,
289	/*interval_timer*/{0, 0, 0, 0},
290	/*report_count*/{0, 0, 0, 1}
291};
292
293const static struct scsi_info_exceptions_page ie_page_changeable = {
294	/*page_code*/SMS_INFO_EXCEPTIONS_PAGE,
295	/*page_length*/sizeof(struct scsi_info_exceptions_page) - 2,
296	/*info_flags*/SIEP_FLAGS_EWASC | SIEP_FLAGS_DEXCPT | SIEP_FLAGS_TEST |
297	    SIEP_FLAGS_LOGERR,
298	/*mrie*/0x0f,
299	/*interval_timer*/{0xff, 0xff, 0xff, 0xff},
300	/*report_count*/{0xff, 0xff, 0xff, 0xff}
301};
302
303#define CTL_LBPM_LEN	(sizeof(struct ctl_logical_block_provisioning_page) - 4)
304
305const static struct ctl_logical_block_provisioning_page lbp_page_default = {{
306	/*page_code*/SMS_INFO_EXCEPTIONS_PAGE | SMPH_SPF,
307	/*subpage_code*/0x02,
308	/*page_length*/{CTL_LBPM_LEN >> 8, CTL_LBPM_LEN},
309	/*flags*/0,
310	/*reserved*/{0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0},
311	/*descr*/{}},
312	{{/*flags*/0,
313	  /*resource*/0x01,
314	  /*reserved*/{0, 0},
315	  /*count*/{0, 0, 0, 0}},
316	 {/*flags*/0,
317	  /*resource*/0x02,
318	  /*reserved*/{0, 0},
319	  /*count*/{0, 0, 0, 0}},
320	 {/*flags*/0,
321	  /*resource*/0xf1,
322	  /*reserved*/{0, 0},
323	  /*count*/{0, 0, 0, 0}},
324	 {/*flags*/0,
325	  /*resource*/0xf2,
326	  /*reserved*/{0, 0},
327	  /*count*/{0, 0, 0, 0}}
328	}
329};
330
331const static struct ctl_logical_block_provisioning_page lbp_page_changeable = {{
332	/*page_code*/SMS_INFO_EXCEPTIONS_PAGE | SMPH_SPF,
333	/*subpage_code*/0x02,
334	/*page_length*/{CTL_LBPM_LEN >> 8, CTL_LBPM_LEN},
335	/*flags*/SLBPP_SITUA,
336	/*reserved*/{0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0},
337	/*descr*/{}},
338	{{/*flags*/0,
339	  /*resource*/0,
340	  /*reserved*/{0, 0},
341	  /*count*/{0, 0, 0, 0}},
342	 {/*flags*/0,
343	  /*resource*/0,
344	  /*reserved*/{0, 0},
345	  /*count*/{0, 0, 0, 0}},
346	 {/*flags*/0,
347	  /*resource*/0,
348	  /*reserved*/{0, 0},
349	  /*count*/{0, 0, 0, 0}},
350	 {/*flags*/0,
351	  /*resource*/0,
352	  /*reserved*/{0, 0},
353	  /*count*/{0, 0, 0, 0}}
354	}
355};
356
357const static struct scsi_cddvd_capabilities_page cddvd_page_default = {
358	/*page_code*/SMS_CDDVD_CAPS_PAGE,
359	/*page_length*/sizeof(struct scsi_cddvd_capabilities_page) - 2,
360	/*caps1*/0x3f,
361	/*caps2*/0x00,
362	/*caps3*/0xf0,
363	/*caps4*/0x00,
364	/*caps5*/0x29,
365	/*caps6*/0x00,
366	/*obsolete*/{0, 0},
367	/*nvol_levels*/{0, 0},
368	/*buffer_size*/{8, 0},
369	/*obsolete2*/{0, 0},
370	/*reserved*/0,
371	/*digital*/0,
372	/*obsolete3*/0,
373	/*copy_management*/0,
374	/*reserved2*/0,
375	/*rotation_control*/0,
376	/*cur_write_speed*/0,
377	/*num_speed_descr*/0,
378};
379
380const static struct scsi_cddvd_capabilities_page cddvd_page_changeable = {
381	/*page_code*/SMS_CDDVD_CAPS_PAGE,
382	/*page_length*/sizeof(struct scsi_cddvd_capabilities_page) - 2,
383	/*caps1*/0,
384	/*caps2*/0,
385	/*caps3*/0,
386	/*caps4*/0,
387	/*caps5*/0,
388	/*caps6*/0,
389	/*obsolete*/{0, 0},
390	/*nvol_levels*/{0, 0},
391	/*buffer_size*/{0, 0},
392	/*obsolete2*/{0, 0},
393	/*reserved*/0,
394	/*digital*/0,
395	/*obsolete3*/0,
396	/*copy_management*/0,
397	/*reserved2*/0,
398	/*rotation_control*/0,
399	/*cur_write_speed*/0,
400	/*num_speed_descr*/0,
401};
402
403SYSCTL_NODE(_kern_cam, OID_AUTO, ctl, CTLFLAG_RD, 0, "CAM Target Layer");
404static int worker_threads = -1;
405SYSCTL_INT(_kern_cam_ctl, OID_AUTO, worker_threads, CTLFLAG_RDTUN,
406    &worker_threads, 1, "Number of worker threads");
407static int ctl_debug = CTL_DEBUG_NONE;
408SYSCTL_INT(_kern_cam_ctl, OID_AUTO, debug, CTLFLAG_RWTUN,
409    &ctl_debug, 0, "Enabled debug flags");
410
411/*
412 * Supported pages (0x00), Serial number (0x80), Device ID (0x83),
413 * Extended INQUIRY Data (0x86), Mode Page Policy (0x87),
414 * SCSI Ports (0x88), Third-party Copy (0x8F), Block limits (0xB0),
415 * Block Device Characteristics (0xB1) and Logical Block Provisioning (0xB2)
416 */
417#define SCSI_EVPD_NUM_SUPPORTED_PAGES	10
418
419static void ctl_isc_event_handler(ctl_ha_channel chanel, ctl_ha_event event,
420				  int param);
421static void ctl_copy_sense_data(union ctl_ha_msg *src, union ctl_io *dest);
422static void ctl_copy_sense_data_back(union ctl_io *src, union ctl_ha_msg *dest);
423static int ctl_init(void);
424void ctl_shutdown(void);
425static int ctl_open(struct cdev *dev, int flags, int fmt, struct thread *td);
426static int ctl_close(struct cdev *dev, int flags, int fmt, struct thread *td);
427static int ctl_serialize_other_sc_cmd(struct ctl_scsiio *ctsio);
428static void ctl_ioctl_fill_ooa(struct ctl_lun *lun, uint32_t *cur_fill_num,
429			      struct ctl_ooa *ooa_hdr,
430			      struct ctl_ooa_entry *kern_entries);
431static int ctl_ioctl(struct cdev *dev, u_long cmd, caddr_t addr, int flag,
432		     struct thread *td);
433static int ctl_alloc_lun(struct ctl_softc *ctl_softc, struct ctl_lun *lun,
434			 struct ctl_be_lun *be_lun);
435static int ctl_free_lun(struct ctl_lun *lun);
436static void ctl_create_lun(struct ctl_be_lun *be_lun);
437static struct ctl_port * ctl_io_port(struct ctl_io_hdr *io_hdr);
438
439static int ctl_do_mode_select(union ctl_io *io);
440static int ctl_pro_preempt(struct ctl_softc *softc, struct ctl_lun *lun,
441			   uint64_t res_key, uint64_t sa_res_key,
442			   uint8_t type, uint32_t residx,
443			   struct ctl_scsiio *ctsio,
444			   struct scsi_per_res_out *cdb,
445			   struct scsi_per_res_out_parms* param);
446static void ctl_pro_preempt_other(struct ctl_lun *lun,
447				  union ctl_ha_msg *msg);
448static void ctl_hndl_per_res_out_on_other_sc(union ctl_ha_msg *msg);
449static int ctl_inquiry_evpd_supported(struct ctl_scsiio *ctsio, int alloc_len);
450static int ctl_inquiry_evpd_serial(struct ctl_scsiio *ctsio, int alloc_len);
451static int ctl_inquiry_evpd_devid(struct ctl_scsiio *ctsio, int alloc_len);
452static int ctl_inquiry_evpd_eid(struct ctl_scsiio *ctsio, int alloc_len);
453static int ctl_inquiry_evpd_mpp(struct ctl_scsiio *ctsio, int alloc_len);
454static int ctl_inquiry_evpd_scsi_ports(struct ctl_scsiio *ctsio,
455					 int alloc_len);
456static int ctl_inquiry_evpd_block_limits(struct ctl_scsiio *ctsio,
457					 int alloc_len);
458static int ctl_inquiry_evpd_bdc(struct ctl_scsiio *ctsio, int alloc_len);
459static int ctl_inquiry_evpd_lbp(struct ctl_scsiio *ctsio, int alloc_len);
460static int ctl_inquiry_evpd(struct ctl_scsiio *ctsio);
461static int ctl_inquiry_std(struct ctl_scsiio *ctsio);
462static int ctl_get_lba_len(union ctl_io *io, uint64_t *lba, uint64_t *len);
463static ctl_action ctl_extent_check(union ctl_io *io1, union ctl_io *io2,
464    bool seq);
465static ctl_action ctl_extent_check_seq(union ctl_io *io1, union ctl_io *io2);
466static ctl_action ctl_check_for_blockage(struct ctl_lun *lun,
467    union ctl_io *pending_io, union ctl_io *ooa_io);
468static ctl_action ctl_check_ooa(struct ctl_lun *lun, union ctl_io *pending_io,
469				union ctl_io *starting_io);
470static int ctl_check_blocked(struct ctl_lun *lun);
471static int ctl_scsiio_lun_check(struct ctl_lun *lun,
472				const struct ctl_cmd_entry *entry,
473				struct ctl_scsiio *ctsio);
474static void ctl_failover_lun(union ctl_io *io);
475static int ctl_scsiio_precheck(struct ctl_softc *ctl_softc,
476			       struct ctl_scsiio *ctsio);
477static int ctl_scsiio(struct ctl_scsiio *ctsio);
478
479static int ctl_bus_reset(struct ctl_softc *ctl_softc, union ctl_io *io);
480static int ctl_target_reset(struct ctl_softc *ctl_softc, union ctl_io *io,
481			    ctl_ua_type ua_type);
482static int ctl_do_lun_reset(struct ctl_lun *lun, union ctl_io *io,
483			 ctl_ua_type ua_type);
484static int ctl_lun_reset(struct ctl_softc *ctl_softc, union ctl_io *io);
485static int ctl_abort_task(union ctl_io *io);
486static int ctl_abort_task_set(union ctl_io *io);
487static int ctl_query_task(union ctl_io *io, int task_set);
488static int ctl_i_t_nexus_reset(union ctl_io *io);
489static int ctl_query_async_event(union ctl_io *io);
490static void ctl_run_task(union ctl_io *io);
491#ifdef CTL_IO_DELAY
492static void ctl_datamove_timer_wakeup(void *arg);
493static void ctl_done_timer_wakeup(void *arg);
494#endif /* CTL_IO_DELAY */
495
496static void ctl_send_datamove_done(union ctl_io *io, int have_lock);
497static void ctl_datamove_remote_write_cb(struct ctl_ha_dt_req *rq);
498static int ctl_datamove_remote_dm_write_cb(union ctl_io *io);
499static void ctl_datamove_remote_write(union ctl_io *io);
500static int ctl_datamove_remote_dm_read_cb(union ctl_io *io);
501static void ctl_datamove_remote_read_cb(struct ctl_ha_dt_req *rq);
502static int ctl_datamove_remote_sgl_setup(union ctl_io *io);
503static int ctl_datamove_remote_xfer(union ctl_io *io, unsigned command,
504				    ctl_ha_dt_cb callback);
505static void ctl_datamove_remote_read(union ctl_io *io);
506static void ctl_datamove_remote(union ctl_io *io);
507static void ctl_process_done(union ctl_io *io);
508static void ctl_lun_thread(void *arg);
509static void ctl_thresh_thread(void *arg);
510static void ctl_work_thread(void *arg);
511static void ctl_enqueue_incoming(union ctl_io *io);
512static void ctl_enqueue_rtr(union ctl_io *io);
513static void ctl_enqueue_done(union ctl_io *io);
514static void ctl_enqueue_isc(union ctl_io *io);
515static const struct ctl_cmd_entry *
516    ctl_get_cmd_entry(struct ctl_scsiio *ctsio, int *sa);
517static const struct ctl_cmd_entry *
518    ctl_validate_command(struct ctl_scsiio *ctsio);
519static int ctl_cmd_applicable(uint8_t lun_type,
520    const struct ctl_cmd_entry *entry);
521
522static uint64_t ctl_get_prkey(struct ctl_lun *lun, uint32_t residx);
523static void ctl_clr_prkey(struct ctl_lun *lun, uint32_t residx);
524static void ctl_alloc_prkey(struct ctl_lun *lun, uint32_t residx);
525static void ctl_set_prkey(struct ctl_lun *lun, uint32_t residx, uint64_t key);
526
527/*
528 * Load the serialization table.  This isn't very pretty, but is probably
529 * the easiest way to do it.
530 */
531#include "ctl_ser_table.c"
532
533/*
534 * We only need to define open, close and ioctl routines for this driver.
535 */
536static struct cdevsw ctl_cdevsw = {
537	.d_version =	D_VERSION,
538	.d_flags =	0,
539	.d_open =	ctl_open,
540	.d_close =	ctl_close,
541	.d_ioctl =	ctl_ioctl,
542	.d_name =	"ctl",
543};
544
545
546MALLOC_DEFINE(M_CTL, "ctlmem", "Memory used for CTL");
547
548static int ctl_module_event_handler(module_t, int /*modeventtype_t*/, void *);
549
550static moduledata_t ctl_moduledata = {
551	"ctl",
552	ctl_module_event_handler,
553	NULL
554};
555
556DECLARE_MODULE(ctl, ctl_moduledata, SI_SUB_CONFIGURE, SI_ORDER_THIRD);
557MODULE_VERSION(ctl, 1);
558
559static struct ctl_frontend ha_frontend =
560{
561	.name = "ha",
562};
563
564static void
565ctl_ha_datamove(union ctl_io *io)
566{
567	struct ctl_lun *lun;
568	struct ctl_sg_entry *sgl;
569	union ctl_ha_msg msg;
570	uint32_t sg_entries_sent;
571	int do_sg_copy, i, j;
572
573	lun = (struct ctl_lun *)io->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
574	memset(&msg.dt, 0, sizeof(msg.dt));
575	msg.hdr.msg_type = CTL_MSG_DATAMOVE;
576	msg.hdr.original_sc = io->io_hdr.original_sc;
577	msg.hdr.serializing_sc = io;
578	msg.hdr.nexus = io->io_hdr.nexus;
579	msg.hdr.status = io->io_hdr.status;
580	msg.dt.flags = io->io_hdr.flags;
581
582	/*
583	 * We convert everything into a S/G list here.  We can't
584	 * pass by reference, only by value between controllers.
585	 * So we can't pass a pointer to the S/G list, only as many
586	 * S/G entries as we can fit in here.  If it's possible for
587	 * us to get more than CTL_HA_MAX_SG_ENTRIES S/G entries,
588	 * then we need to break this up into multiple transfers.
589	 */
590	if (io->scsiio.kern_sg_entries == 0) {
591		msg.dt.kern_sg_entries = 1;
592#if 0
593		if (io->io_hdr.flags & CTL_FLAG_BUS_ADDR) {
594			msg.dt.sg_list[0].addr = io->scsiio.kern_data_ptr;
595		} else {
596			/* XXX KDM use busdma here! */
597			msg.dt.sg_list[0].addr =
598			    (void *)vtophys(io->scsiio.kern_data_ptr);
599		}
600#else
601		KASSERT((io->io_hdr.flags & CTL_FLAG_BUS_ADDR) == 0,
602		    ("HA does not support BUS_ADDR"));
603		msg.dt.sg_list[0].addr = io->scsiio.kern_data_ptr;
604#endif
605		msg.dt.sg_list[0].len = io->scsiio.kern_data_len;
606		do_sg_copy = 0;
607	} else {
608		msg.dt.kern_sg_entries = io->scsiio.kern_sg_entries;
609		do_sg_copy = 1;
610	}
611
612	msg.dt.kern_data_len = io->scsiio.kern_data_len;
613	msg.dt.kern_total_len = io->scsiio.kern_total_len;
614	msg.dt.kern_data_resid = io->scsiio.kern_data_resid;
615	msg.dt.kern_rel_offset = io->scsiio.kern_rel_offset;
616	msg.dt.sg_sequence = 0;
617
618	/*
619	 * Loop until we've sent all of the S/G entries.  On the
620	 * other end, we'll recompose these S/G entries into one
621	 * contiguous list before processing.
622	 */
623	for (sg_entries_sent = 0; sg_entries_sent < msg.dt.kern_sg_entries;
624	    msg.dt.sg_sequence++) {
625		msg.dt.cur_sg_entries = MIN((sizeof(msg.dt.sg_list) /
626		    sizeof(msg.dt.sg_list[0])),
627		    msg.dt.kern_sg_entries - sg_entries_sent);
628		if (do_sg_copy != 0) {
629			sgl = (struct ctl_sg_entry *)io->scsiio.kern_data_ptr;
630			for (i = sg_entries_sent, j = 0;
631			     i < msg.dt.cur_sg_entries; i++, j++) {
632#if 0
633				if (io->io_hdr.flags & CTL_FLAG_BUS_ADDR) {
634					msg.dt.sg_list[j].addr = sgl[i].addr;
635				} else {
636					/* XXX KDM use busdma here! */
637					msg.dt.sg_list[j].addr =
638					    (void *)vtophys(sgl[i].addr);
639				}
640#else
641				KASSERT((io->io_hdr.flags &
642				    CTL_FLAG_BUS_ADDR) == 0,
643				    ("HA does not support BUS_ADDR"));
644				msg.dt.sg_list[j].addr = sgl[i].addr;
645#endif
646				msg.dt.sg_list[j].len = sgl[i].len;
647			}
648		}
649
650		sg_entries_sent += msg.dt.cur_sg_entries;
651		msg.dt.sg_last = (sg_entries_sent >= msg.dt.kern_sg_entries);
652		if (ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg,
653		    sizeof(msg.dt) - sizeof(msg.dt.sg_list) +
654		    sizeof(struct ctl_sg_entry) * msg.dt.cur_sg_entries,
655		    M_WAITOK) > CTL_HA_STATUS_SUCCESS) {
656			io->io_hdr.port_status = 31341;
657			io->scsiio.be_move_done(io);
658			return;
659		}
660		msg.dt.sent_sg_entries = sg_entries_sent;
661	}
662
663	/*
664	 * Officially handover the request from us to peer.
665	 * If failover has just happened, then we must return error.
666	 * If failover happen just after, then it is not our problem.
667	 */
668	if (lun)
669		mtx_lock(&lun->lun_lock);
670	if (io->io_hdr.flags & CTL_FLAG_FAILOVER) {
671		if (lun)
672			mtx_unlock(&lun->lun_lock);
673		io->io_hdr.port_status = 31342;
674		io->scsiio.be_move_done(io);
675		return;
676	}
677	io->io_hdr.flags &= ~CTL_FLAG_IO_ACTIVE;
678	io->io_hdr.flags |= CTL_FLAG_DMA_INPROG;
679	if (lun)
680		mtx_unlock(&lun->lun_lock);
681}
682
683static void
684ctl_ha_done(union ctl_io *io)
685{
686	union ctl_ha_msg msg;
687
688	if (io->io_hdr.io_type == CTL_IO_SCSI) {
689		memset(&msg, 0, sizeof(msg));
690		msg.hdr.msg_type = CTL_MSG_FINISH_IO;
691		msg.hdr.original_sc = io->io_hdr.original_sc;
692		msg.hdr.nexus = io->io_hdr.nexus;
693		msg.hdr.status = io->io_hdr.status;
694		msg.scsi.scsi_status = io->scsiio.scsi_status;
695		msg.scsi.tag_num = io->scsiio.tag_num;
696		msg.scsi.tag_type = io->scsiio.tag_type;
697		msg.scsi.sense_len = io->scsiio.sense_len;
698		msg.scsi.sense_residual = io->scsiio.sense_residual;
699		msg.scsi.residual = io->scsiio.residual;
700		memcpy(&msg.scsi.sense_data, &io->scsiio.sense_data,
701		    io->scsiio.sense_len);
702		ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg,
703		    sizeof(msg.scsi) - sizeof(msg.scsi.sense_data) +
704		    msg.scsi.sense_len, M_WAITOK);
705	}
706	ctl_free_io(io);
707}
708
709static void
710ctl_isc_handler_finish_xfer(struct ctl_softc *ctl_softc,
711			    union ctl_ha_msg *msg_info)
712{
713	struct ctl_scsiio *ctsio;
714
715	if (msg_info->hdr.original_sc == NULL) {
716		printf("%s: original_sc == NULL!\n", __func__);
717		/* XXX KDM now what? */
718		return;
719	}
720
721	ctsio = &msg_info->hdr.original_sc->scsiio;
722	ctsio->io_hdr.flags |= CTL_FLAG_IO_ACTIVE;
723	ctsio->io_hdr.msg_type = CTL_MSG_FINISH_IO;
724	ctsio->io_hdr.status = msg_info->hdr.status;
725	ctsio->scsi_status = msg_info->scsi.scsi_status;
726	ctsio->sense_len = msg_info->scsi.sense_len;
727	ctsio->sense_residual = msg_info->scsi.sense_residual;
728	ctsio->residual = msg_info->scsi.residual;
729	memcpy(&ctsio->sense_data, &msg_info->scsi.sense_data,
730	       msg_info->scsi.sense_len);
731	ctl_enqueue_isc((union ctl_io *)ctsio);
732}
733
734static void
735ctl_isc_handler_finish_ser_only(struct ctl_softc *ctl_softc,
736				union ctl_ha_msg *msg_info)
737{
738	struct ctl_scsiio *ctsio;
739
740	if (msg_info->hdr.serializing_sc == NULL) {
741		printf("%s: serializing_sc == NULL!\n", __func__);
742		/* XXX KDM now what? */
743		return;
744	}
745
746	ctsio = &msg_info->hdr.serializing_sc->scsiio;
747	ctsio->io_hdr.msg_type = CTL_MSG_FINISH_IO;
748	ctl_enqueue_isc((union ctl_io *)ctsio);
749}
750
751void
752ctl_isc_announce_lun(struct ctl_lun *lun)
753{
754	struct ctl_softc *softc = lun->ctl_softc;
755	union ctl_ha_msg *msg;
756	struct ctl_ha_msg_lun_pr_key pr_key;
757	int i, k;
758
759	if (softc->ha_link != CTL_HA_LINK_ONLINE)
760		return;
761	mtx_lock(&lun->lun_lock);
762	i = sizeof(msg->lun);
763	if (lun->lun_devid)
764		i += lun->lun_devid->len;
765	i += sizeof(pr_key) * lun->pr_key_count;
766alloc:
767	mtx_unlock(&lun->lun_lock);
768	msg = malloc(i, M_CTL, M_WAITOK);
769	mtx_lock(&lun->lun_lock);
770	k = sizeof(msg->lun);
771	if (lun->lun_devid)
772		k += lun->lun_devid->len;
773	k += sizeof(pr_key) * lun->pr_key_count;
774	if (i < k) {
775		free(msg, M_CTL);
776		i = k;
777		goto alloc;
778	}
779	bzero(&msg->lun, sizeof(msg->lun));
780	msg->hdr.msg_type = CTL_MSG_LUN_SYNC;
781	msg->hdr.nexus.targ_lun = lun->lun;
782	msg->hdr.nexus.targ_mapped_lun = lun->lun;
783	msg->lun.flags = lun->flags;
784	msg->lun.pr_generation = lun->pr_generation;
785	msg->lun.pr_res_idx = lun->pr_res_idx;
786	msg->lun.pr_res_type = lun->pr_res_type;
787	msg->lun.pr_key_count = lun->pr_key_count;
788	i = 0;
789	if (lun->lun_devid) {
790		msg->lun.lun_devid_len = lun->lun_devid->len;
791		memcpy(&msg->lun.data[i], lun->lun_devid->data,
792		    msg->lun.lun_devid_len);
793		i += msg->lun.lun_devid_len;
794	}
795	for (k = 0; k < CTL_MAX_INITIATORS; k++) {
796		if ((pr_key.pr_key = ctl_get_prkey(lun, k)) == 0)
797			continue;
798		pr_key.pr_iid = k;
799		memcpy(&msg->lun.data[i], &pr_key, sizeof(pr_key));
800		i += sizeof(pr_key);
801	}
802	mtx_unlock(&lun->lun_lock);
803	ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg->port, sizeof(msg->port) + i,
804	    M_WAITOK);
805	free(msg, M_CTL);
806
807	if (lun->flags & CTL_LUN_PRIMARY_SC) {
808		for (i = 0; i < CTL_NUM_MODE_PAGES; i++) {
809			ctl_isc_announce_mode(lun, -1,
810			    lun->mode_pages.index[i].page_code & SMPH_PC_MASK,
811			    lun->mode_pages.index[i].subpage);
812		}
813	}
814}
815
816void
817ctl_isc_announce_port(struct ctl_port *port)
818{
819	struct ctl_softc *softc = port->ctl_softc;
820	union ctl_ha_msg *msg;
821	int i;
822
823	if (port->targ_port < softc->port_min ||
824	    port->targ_port >= softc->port_max ||
825	    softc->ha_link != CTL_HA_LINK_ONLINE)
826		return;
827	i = sizeof(msg->port) + strlen(port->port_name) + 1;
828	if (port->lun_map)
829		i += sizeof(uint32_t) * CTL_MAX_LUNS;
830	if (port->port_devid)
831		i += port->port_devid->len;
832	if (port->target_devid)
833		i += port->target_devid->len;
834	if (port->init_devid)
835		i += port->init_devid->len;
836	msg = malloc(i, M_CTL, M_WAITOK);
837	bzero(&msg->port, sizeof(msg->port));
838	msg->hdr.msg_type = CTL_MSG_PORT_SYNC;
839	msg->hdr.nexus.targ_port = port->targ_port;
840	msg->port.port_type = port->port_type;
841	msg->port.physical_port = port->physical_port;
842	msg->port.virtual_port = port->virtual_port;
843	msg->port.status = port->status;
844	i = 0;
845	msg->port.name_len = sprintf(&msg->port.data[i],
846	    "%d:%s", softc->ha_id, port->port_name) + 1;
847	i += msg->port.name_len;
848	if (port->lun_map) {
849		msg->port.lun_map_len = sizeof(uint32_t) * CTL_MAX_LUNS;
850		memcpy(&msg->port.data[i], port->lun_map,
851		    msg->port.lun_map_len);
852		i += msg->port.lun_map_len;
853	}
854	if (port->port_devid) {
855		msg->port.port_devid_len = port->port_devid->len;
856		memcpy(&msg->port.data[i], port->port_devid->data,
857		    msg->port.port_devid_len);
858		i += msg->port.port_devid_len;
859	}
860	if (port->target_devid) {
861		msg->port.target_devid_len = port->target_devid->len;
862		memcpy(&msg->port.data[i], port->target_devid->data,
863		    msg->port.target_devid_len);
864		i += msg->port.target_devid_len;
865	}
866	if (port->init_devid) {
867		msg->port.init_devid_len = port->init_devid->len;
868		memcpy(&msg->port.data[i], port->init_devid->data,
869		    msg->port.init_devid_len);
870		i += msg->port.init_devid_len;
871	}
872	ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg->port, sizeof(msg->port) + i,
873	    M_WAITOK);
874	free(msg, M_CTL);
875}
876
877void
878ctl_isc_announce_iid(struct ctl_port *port, int iid)
879{
880	struct ctl_softc *softc = port->ctl_softc;
881	union ctl_ha_msg *msg;
882	int i, l;
883
884	if (port->targ_port < softc->port_min ||
885	    port->targ_port >= softc->port_max ||
886	    softc->ha_link != CTL_HA_LINK_ONLINE)
887		return;
888	mtx_lock(&softc->ctl_lock);
889	i = sizeof(msg->iid);
890	l = 0;
891	if (port->wwpn_iid[iid].name)
892		l = strlen(port->wwpn_iid[iid].name) + 1;
893	i += l;
894	msg = malloc(i, M_CTL, M_NOWAIT);
895	if (msg == NULL) {
896		mtx_unlock(&softc->ctl_lock);
897		return;
898	}
899	bzero(&msg->iid, sizeof(msg->iid));
900	msg->hdr.msg_type = CTL_MSG_IID_SYNC;
901	msg->hdr.nexus.targ_port = port->targ_port;
902	msg->hdr.nexus.initid = iid;
903	msg->iid.in_use = port->wwpn_iid[iid].in_use;
904	msg->iid.name_len = l;
905	msg->iid.wwpn = port->wwpn_iid[iid].wwpn;
906	if (port->wwpn_iid[iid].name)
907		strlcpy(msg->iid.data, port->wwpn_iid[iid].name, l);
908	mtx_unlock(&softc->ctl_lock);
909	ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg->iid, i, M_NOWAIT);
910	free(msg, M_CTL);
911}
912
913void
914ctl_isc_announce_mode(struct ctl_lun *lun, uint32_t initidx,
915    uint8_t page, uint8_t subpage)
916{
917	struct ctl_softc *softc = lun->ctl_softc;
918	union ctl_ha_msg msg;
919	u_int i;
920
921	if (softc->ha_link != CTL_HA_LINK_ONLINE)
922		return;
923	for (i = 0; i < CTL_NUM_MODE_PAGES; i++) {
924		if ((lun->mode_pages.index[i].page_code & SMPH_PC_MASK) ==
925		    page && lun->mode_pages.index[i].subpage == subpage)
926			break;
927	}
928	if (i == CTL_NUM_MODE_PAGES)
929		return;
930
931	/* Don't try to replicate pages not present on this device. */
932	if (lun->mode_pages.index[i].page_data == NULL)
933		return;
934
935	bzero(&msg.mode, sizeof(msg.mode));
936	msg.hdr.msg_type = CTL_MSG_MODE_SYNC;
937	msg.hdr.nexus.targ_port = initidx / CTL_MAX_INIT_PER_PORT;
938	msg.hdr.nexus.initid = initidx % CTL_MAX_INIT_PER_PORT;
939	msg.hdr.nexus.targ_lun = lun->lun;
940	msg.hdr.nexus.targ_mapped_lun = lun->lun;
941	msg.mode.page_code = page;
942	msg.mode.subpage = subpage;
943	msg.mode.page_len = lun->mode_pages.index[i].page_len;
944	memcpy(msg.mode.data, lun->mode_pages.index[i].page_data,
945	    msg.mode.page_len);
946	ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg.mode, sizeof(msg.mode),
947	    M_WAITOK);
948}
949
950static void
951ctl_isc_ha_link_up(struct ctl_softc *softc)
952{
953	struct ctl_port *port;
954	struct ctl_lun *lun;
955	union ctl_ha_msg msg;
956	int i;
957
958	/* Announce this node parameters to peer for validation. */
959	msg.login.msg_type = CTL_MSG_LOGIN;
960	msg.login.version = CTL_HA_VERSION;
961	msg.login.ha_mode = softc->ha_mode;
962	msg.login.ha_id = softc->ha_id;
963	msg.login.max_luns = CTL_MAX_LUNS;
964	msg.login.max_ports = CTL_MAX_PORTS;
965	msg.login.max_init_per_port = CTL_MAX_INIT_PER_PORT;
966	ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg.login, sizeof(msg.login),
967	    M_WAITOK);
968
969	STAILQ_FOREACH(port, &softc->port_list, links) {
970		ctl_isc_announce_port(port);
971		for (i = 0; i < CTL_MAX_INIT_PER_PORT; i++) {
972			if (port->wwpn_iid[i].in_use)
973				ctl_isc_announce_iid(port, i);
974		}
975	}
976	STAILQ_FOREACH(lun, &softc->lun_list, links)
977		ctl_isc_announce_lun(lun);
978}
979
980static void
981ctl_isc_ha_link_down(struct ctl_softc *softc)
982{
983	struct ctl_port *port;
984	struct ctl_lun *lun;
985	union ctl_io *io;
986	int i;
987
988	mtx_lock(&softc->ctl_lock);
989	STAILQ_FOREACH(lun, &softc->lun_list, links) {
990		mtx_lock(&lun->lun_lock);
991		if (lun->flags & CTL_LUN_PEER_SC_PRIMARY) {
992			lun->flags &= ~CTL_LUN_PEER_SC_PRIMARY;
993			ctl_est_ua_all(lun, -1, CTL_UA_ASYM_ACC_CHANGE);
994		}
995		mtx_unlock(&lun->lun_lock);
996
997		mtx_unlock(&softc->ctl_lock);
998		io = ctl_alloc_io(softc->othersc_pool);
999		mtx_lock(&softc->ctl_lock);
1000		ctl_zero_io(io);
1001		io->io_hdr.msg_type = CTL_MSG_FAILOVER;
1002		io->io_hdr.nexus.targ_mapped_lun = lun->lun;
1003		ctl_enqueue_isc(io);
1004	}
1005
1006	STAILQ_FOREACH(port, &softc->port_list, links) {
1007		if (port->targ_port >= softc->port_min &&
1008		    port->targ_port < softc->port_max)
1009			continue;
1010		port->status &= ~CTL_PORT_STATUS_ONLINE;
1011		for (i = 0; i < CTL_MAX_INIT_PER_PORT; i++) {
1012			port->wwpn_iid[i].in_use = 0;
1013			free(port->wwpn_iid[i].name, M_CTL);
1014			port->wwpn_iid[i].name = NULL;
1015		}
1016	}
1017	mtx_unlock(&softc->ctl_lock);
1018}
1019
1020static void
1021ctl_isc_ua(struct ctl_softc *softc, union ctl_ha_msg *msg, int len)
1022{
1023	struct ctl_lun *lun;
1024	uint32_t iid = ctl_get_initindex(&msg->hdr.nexus);
1025
1026	mtx_lock(&softc->ctl_lock);
1027	if (msg->hdr.nexus.targ_lun < CTL_MAX_LUNS &&
1028	    (lun = softc->ctl_luns[msg->hdr.nexus.targ_mapped_lun]) != NULL) {
1029		mtx_lock(&lun->lun_lock);
1030		mtx_unlock(&softc->ctl_lock);
1031		if (msg->ua.ua_type == CTL_UA_THIN_PROV_THRES &&
1032		    msg->ua.ua_set)
1033			memcpy(lun->ua_tpt_info, msg->ua.ua_info, 8);
1034		if (msg->ua.ua_all) {
1035			if (msg->ua.ua_set)
1036				ctl_est_ua_all(lun, iid, msg->ua.ua_type);
1037			else
1038				ctl_clr_ua_all(lun, iid, msg->ua.ua_type);
1039		} else {
1040			if (msg->ua.ua_set)
1041				ctl_est_ua(lun, iid, msg->ua.ua_type);
1042			else
1043				ctl_clr_ua(lun, iid, msg->ua.ua_type);
1044		}
1045		mtx_unlock(&lun->lun_lock);
1046	} else
1047		mtx_unlock(&softc->ctl_lock);
1048}
1049
1050static void
1051ctl_isc_lun_sync(struct ctl_softc *softc, union ctl_ha_msg *msg, int len)
1052{
1053	struct ctl_lun *lun;
1054	struct ctl_ha_msg_lun_pr_key pr_key;
1055	int i, k;
1056	ctl_lun_flags oflags;
1057	uint32_t targ_lun;
1058
1059	targ_lun = msg->hdr.nexus.targ_mapped_lun;
1060	mtx_lock(&softc->ctl_lock);
1061	if ((targ_lun >= CTL_MAX_LUNS) ||
1062	    ((lun = softc->ctl_luns[targ_lun]) == NULL)) {
1063		mtx_unlock(&softc->ctl_lock);
1064		return;
1065	}
1066	mtx_lock(&lun->lun_lock);
1067	mtx_unlock(&softc->ctl_lock);
1068	if (lun->flags & CTL_LUN_DISABLED) {
1069		mtx_unlock(&lun->lun_lock);
1070		return;
1071	}
1072	i = (lun->lun_devid != NULL) ? lun->lun_devid->len : 0;
1073	if (msg->lun.lun_devid_len != i || (i > 0 &&
1074	    memcmp(&msg->lun.data[0], lun->lun_devid->data, i) != 0)) {
1075		mtx_unlock(&lun->lun_lock);
1076		printf("%s: Received conflicting HA LUN %d\n",
1077		    __func__, msg->hdr.nexus.targ_lun);
1078		return;
1079	} else {
1080		/* Record whether peer is primary. */
1081		oflags = lun->flags;
1082		if ((msg->lun.flags & CTL_LUN_PRIMARY_SC) &&
1083		    (msg->lun.flags & CTL_LUN_DISABLED) == 0)
1084			lun->flags |= CTL_LUN_PEER_SC_PRIMARY;
1085		else
1086			lun->flags &= ~CTL_LUN_PEER_SC_PRIMARY;
1087		if (oflags != lun->flags)
1088			ctl_est_ua_all(lun, -1, CTL_UA_ASYM_ACC_CHANGE);
1089
1090		/* If peer is primary and we are not -- use data */
1091		if ((lun->flags & CTL_LUN_PRIMARY_SC) == 0 &&
1092		    (lun->flags & CTL_LUN_PEER_SC_PRIMARY)) {
1093			lun->pr_generation = msg->lun.pr_generation;
1094			lun->pr_res_idx = msg->lun.pr_res_idx;
1095			lun->pr_res_type = msg->lun.pr_res_type;
1096			lun->pr_key_count = msg->lun.pr_key_count;
1097			for (k = 0; k < CTL_MAX_INITIATORS; k++)
1098				ctl_clr_prkey(lun, k);
1099			for (k = 0; k < msg->lun.pr_key_count; k++) {
1100				memcpy(&pr_key, &msg->lun.data[i],
1101				    sizeof(pr_key));
1102				ctl_alloc_prkey(lun, pr_key.pr_iid);
1103				ctl_set_prkey(lun, pr_key.pr_iid,
1104				    pr_key.pr_key);
1105				i += sizeof(pr_key);
1106			}
1107		}
1108
1109		mtx_unlock(&lun->lun_lock);
1110		CTL_DEBUG_PRINT(("%s: Known LUN %d, peer is %s\n",
1111		    __func__, msg->hdr.nexus.targ_lun,
1112		    (msg->lun.flags & CTL_LUN_PRIMARY_SC) ?
1113		    "primary" : "secondary"));
1114
1115		/* If we are primary but peer doesn't know -- notify */
1116		if ((lun->flags & CTL_LUN_PRIMARY_SC) &&
1117		    (msg->lun.flags & CTL_LUN_PEER_SC_PRIMARY) == 0)
1118			ctl_isc_announce_lun(lun);
1119	}
1120}
1121
1122static void
1123ctl_isc_port_sync(struct ctl_softc *softc, union ctl_ha_msg *msg, int len)
1124{
1125	struct ctl_port *port;
1126	struct ctl_lun *lun;
1127	int i, new;
1128
1129	port = softc->ctl_ports[msg->hdr.nexus.targ_port];
1130	if (port == NULL) {
1131		CTL_DEBUG_PRINT(("%s: New port %d\n", __func__,
1132		    msg->hdr.nexus.targ_port));
1133		new = 1;
1134		port = malloc(sizeof(*port), M_CTL, M_WAITOK | M_ZERO);
1135		port->frontend = &ha_frontend;
1136		port->targ_port = msg->hdr.nexus.targ_port;
1137		port->fe_datamove = ctl_ha_datamove;
1138		port->fe_done = ctl_ha_done;
1139	} else if (port->frontend == &ha_frontend) {
1140		CTL_DEBUG_PRINT(("%s: Updated port %d\n", __func__,
1141		    msg->hdr.nexus.targ_port));
1142		new = 0;
1143	} else {
1144		printf("%s: Received conflicting HA port %d\n",
1145		    __func__, msg->hdr.nexus.targ_port);
1146		return;
1147	}
1148	port->port_type = msg->port.port_type;
1149	port->physical_port = msg->port.physical_port;
1150	port->virtual_port = msg->port.virtual_port;
1151	port->status = msg->port.status;
1152	i = 0;
1153	free(port->port_name, M_CTL);
1154	port->port_name = strndup(&msg->port.data[i], msg->port.name_len,
1155	    M_CTL);
1156	i += msg->port.name_len;
1157	if (msg->port.lun_map_len != 0) {
1158		if (port->lun_map == NULL)
1159			port->lun_map = malloc(sizeof(uint32_t) * CTL_MAX_LUNS,
1160			    M_CTL, M_WAITOK);
1161		memcpy(port->lun_map, &msg->port.data[i],
1162		    sizeof(uint32_t) * CTL_MAX_LUNS);
1163		i += msg->port.lun_map_len;
1164	} else {
1165		free(port->lun_map, M_CTL);
1166		port->lun_map = NULL;
1167	}
1168	if (msg->port.port_devid_len != 0) {
1169		if (port->port_devid == NULL ||
1170		    port->port_devid->len != msg->port.port_devid_len) {
1171			free(port->port_devid, M_CTL);
1172			port->port_devid = malloc(sizeof(struct ctl_devid) +
1173			    msg->port.port_devid_len, M_CTL, M_WAITOK);
1174		}
1175		memcpy(port->port_devid->data, &msg->port.data[i],
1176		    msg->port.port_devid_len);
1177		port->port_devid->len = msg->port.port_devid_len;
1178		i += msg->port.port_devid_len;
1179	} else {
1180		free(port->port_devid, M_CTL);
1181		port->port_devid = NULL;
1182	}
1183	if (msg->port.target_devid_len != 0) {
1184		if (port->target_devid == NULL ||
1185		    port->target_devid->len != msg->port.target_devid_len) {
1186			free(port->target_devid, M_CTL);
1187			port->target_devid = malloc(sizeof(struct ctl_devid) +
1188			    msg->port.target_devid_len, M_CTL, M_WAITOK);
1189		}
1190		memcpy(port->target_devid->data, &msg->port.data[i],
1191		    msg->port.target_devid_len);
1192		port->target_devid->len = msg->port.target_devid_len;
1193		i += msg->port.target_devid_len;
1194	} else {
1195		free(port->target_devid, M_CTL);
1196		port->target_devid = NULL;
1197	}
1198	if (msg->port.init_devid_len != 0) {
1199		if (port->init_devid == NULL ||
1200		    port->init_devid->len != msg->port.init_devid_len) {
1201			free(port->init_devid, M_CTL);
1202			port->init_devid = malloc(sizeof(struct ctl_devid) +
1203			    msg->port.init_devid_len, M_CTL, M_WAITOK);
1204		}
1205		memcpy(port->init_devid->data, &msg->port.data[i],
1206		    msg->port.init_devid_len);
1207		port->init_devid->len = msg->port.init_devid_len;
1208		i += msg->port.init_devid_len;
1209	} else {
1210		free(port->init_devid, M_CTL);
1211		port->init_devid = NULL;
1212	}
1213	if (new) {
1214		if (ctl_port_register(port) != 0) {
1215			printf("%s: ctl_port_register() failed with error\n",
1216			    __func__);
1217		}
1218	}
1219	mtx_lock(&softc->ctl_lock);
1220	STAILQ_FOREACH(lun, &softc->lun_list, links) {
1221		if (ctl_lun_map_to_port(port, lun->lun) >= CTL_MAX_LUNS)
1222			continue;
1223		mtx_lock(&lun->lun_lock);
1224		ctl_est_ua_all(lun, -1, CTL_UA_INQ_CHANGE);
1225		mtx_unlock(&lun->lun_lock);
1226	}
1227	mtx_unlock(&softc->ctl_lock);
1228}
1229
1230static void
1231ctl_isc_iid_sync(struct ctl_softc *softc, union ctl_ha_msg *msg, int len)
1232{
1233	struct ctl_port *port;
1234	int iid;
1235
1236	port = softc->ctl_ports[msg->hdr.nexus.targ_port];
1237	if (port == NULL) {
1238		printf("%s: Received IID for unknown port %d\n",
1239		    __func__, msg->hdr.nexus.targ_port);
1240		return;
1241	}
1242	iid = msg->hdr.nexus.initid;
1243	port->wwpn_iid[iid].in_use = msg->iid.in_use;
1244	port->wwpn_iid[iid].wwpn = msg->iid.wwpn;
1245	free(port->wwpn_iid[iid].name, M_CTL);
1246	if (msg->iid.name_len) {
1247		port->wwpn_iid[iid].name = strndup(&msg->iid.data[0],
1248		    msg->iid.name_len, M_CTL);
1249	} else
1250		port->wwpn_iid[iid].name = NULL;
1251}
1252
1253static void
1254ctl_isc_login(struct ctl_softc *softc, union ctl_ha_msg *msg, int len)
1255{
1256
1257	if (msg->login.version != CTL_HA_VERSION) {
1258		printf("CTL HA peers have different versions %d != %d\n",
1259		    msg->login.version, CTL_HA_VERSION);
1260		ctl_ha_msg_abort(CTL_HA_CHAN_CTL);
1261		return;
1262	}
1263	if (msg->login.ha_mode != softc->ha_mode) {
1264		printf("CTL HA peers have different ha_mode %d != %d\n",
1265		    msg->login.ha_mode, softc->ha_mode);
1266		ctl_ha_msg_abort(CTL_HA_CHAN_CTL);
1267		return;
1268	}
1269	if (msg->login.ha_id == softc->ha_id) {
1270		printf("CTL HA peers have same ha_id %d\n", msg->login.ha_id);
1271		ctl_ha_msg_abort(CTL_HA_CHAN_CTL);
1272		return;
1273	}
1274	if (msg->login.max_luns != CTL_MAX_LUNS ||
1275	    msg->login.max_ports != CTL_MAX_PORTS ||
1276	    msg->login.max_init_per_port != CTL_MAX_INIT_PER_PORT) {
1277		printf("CTL HA peers have different limits\n");
1278		ctl_ha_msg_abort(CTL_HA_CHAN_CTL);
1279		return;
1280	}
1281}
1282
1283static void
1284ctl_isc_mode_sync(struct ctl_softc *softc, union ctl_ha_msg *msg, int len)
1285{
1286	struct ctl_lun *lun;
1287	u_int i;
1288	uint32_t initidx, targ_lun;
1289
1290	targ_lun = msg->hdr.nexus.targ_mapped_lun;
1291	mtx_lock(&softc->ctl_lock);
1292	if ((targ_lun >= CTL_MAX_LUNS) ||
1293	    ((lun = softc->ctl_luns[targ_lun]) == NULL)) {
1294		mtx_unlock(&softc->ctl_lock);
1295		return;
1296	}
1297	mtx_lock(&lun->lun_lock);
1298	mtx_unlock(&softc->ctl_lock);
1299	if (lun->flags & CTL_LUN_DISABLED) {
1300		mtx_unlock(&lun->lun_lock);
1301		return;
1302	}
1303	for (i = 0; i < CTL_NUM_MODE_PAGES; i++) {
1304		if ((lun->mode_pages.index[i].page_code & SMPH_PC_MASK) ==
1305		    msg->mode.page_code &&
1306		    lun->mode_pages.index[i].subpage == msg->mode.subpage)
1307			break;
1308	}
1309	if (i == CTL_NUM_MODE_PAGES) {
1310		mtx_unlock(&lun->lun_lock);
1311		return;
1312	}
1313	memcpy(lun->mode_pages.index[i].page_data, msg->mode.data,
1314	    lun->mode_pages.index[i].page_len);
1315	initidx = ctl_get_initindex(&msg->hdr.nexus);
1316	if (initidx != -1)
1317		ctl_est_ua_all(lun, initidx, CTL_UA_MODE_CHANGE);
1318	mtx_unlock(&lun->lun_lock);
1319}
1320
1321/*
1322 * ISC (Inter Shelf Communication) event handler.  Events from the HA
1323 * subsystem come in here.
1324 */
1325static void
1326ctl_isc_event_handler(ctl_ha_channel channel, ctl_ha_event event, int param)
1327{
1328	struct ctl_softc *softc = control_softc;
1329	union ctl_io *io;
1330	struct ctl_prio *presio;
1331	ctl_ha_status isc_status;
1332
1333	CTL_DEBUG_PRINT(("CTL: Isc Msg event %d\n", event));
1334	if (event == CTL_HA_EVT_MSG_RECV) {
1335		union ctl_ha_msg *msg, msgbuf;
1336
1337		if (param > sizeof(msgbuf))
1338			msg = malloc(param, M_CTL, M_WAITOK);
1339		else
1340			msg = &msgbuf;
1341		isc_status = ctl_ha_msg_recv(CTL_HA_CHAN_CTL, msg, param,
1342		    M_WAITOK);
1343		if (isc_status != CTL_HA_STATUS_SUCCESS) {
1344			printf("%s: Error receiving message: %d\n",
1345			    __func__, isc_status);
1346			if (msg != &msgbuf)
1347				free(msg, M_CTL);
1348			return;
1349		}
1350
1351		CTL_DEBUG_PRINT(("CTL: msg_type %d\n", msg->msg_type));
1352		switch (msg->hdr.msg_type) {
1353		case CTL_MSG_SERIALIZE:
1354			io = ctl_alloc_io(softc->othersc_pool);
1355			ctl_zero_io(io);
1356			// populate ctsio from msg
1357			io->io_hdr.io_type = CTL_IO_SCSI;
1358			io->io_hdr.msg_type = CTL_MSG_SERIALIZE;
1359			io->io_hdr.original_sc = msg->hdr.original_sc;
1360			io->io_hdr.flags |= CTL_FLAG_FROM_OTHER_SC |
1361					    CTL_FLAG_IO_ACTIVE;
1362			/*
1363			 * If we're in serialization-only mode, we don't
1364			 * want to go through full done processing.  Thus
1365			 * the COPY flag.
1366			 *
1367			 * XXX KDM add another flag that is more specific.
1368			 */
1369			if (softc->ha_mode != CTL_HA_MODE_XFER)
1370				io->io_hdr.flags |= CTL_FLAG_INT_COPY;
1371			io->io_hdr.nexus = msg->hdr.nexus;
1372#if 0
1373			printf("port %u, iid %u, lun %u\n",
1374			       io->io_hdr.nexus.targ_port,
1375			       io->io_hdr.nexus.initid,
1376			       io->io_hdr.nexus.targ_lun);
1377#endif
1378			io->scsiio.tag_num = msg->scsi.tag_num;
1379			io->scsiio.tag_type = msg->scsi.tag_type;
1380#ifdef CTL_TIME_IO
1381			io->io_hdr.start_time = time_uptime;
1382			getbinuptime(&io->io_hdr.start_bt);
1383#endif /* CTL_TIME_IO */
1384			io->scsiio.cdb_len = msg->scsi.cdb_len;
1385			memcpy(io->scsiio.cdb, msg->scsi.cdb,
1386			       CTL_MAX_CDBLEN);
1387			if (softc->ha_mode == CTL_HA_MODE_XFER) {
1388				const struct ctl_cmd_entry *entry;
1389
1390				entry = ctl_get_cmd_entry(&io->scsiio, NULL);
1391				io->io_hdr.flags &= ~CTL_FLAG_DATA_MASK;
1392				io->io_hdr.flags |=
1393					entry->flags & CTL_FLAG_DATA_MASK;
1394			}
1395			ctl_enqueue_isc(io);
1396			break;
1397
1398		/* Performed on the Originating SC, XFER mode only */
1399		case CTL_MSG_DATAMOVE: {
1400			struct ctl_sg_entry *sgl;
1401			int i, j;
1402
1403			io = msg->hdr.original_sc;
1404			if (io == NULL) {
1405				printf("%s: original_sc == NULL!\n", __func__);
1406				/* XXX KDM do something here */
1407				break;
1408			}
1409			io->io_hdr.msg_type = CTL_MSG_DATAMOVE;
1410			io->io_hdr.flags |= CTL_FLAG_IO_ACTIVE;
1411			/*
1412			 * Keep track of this, we need to send it back over
1413			 * when the datamove is complete.
1414			 */
1415			io->io_hdr.serializing_sc = msg->hdr.serializing_sc;
1416			if (msg->hdr.status == CTL_SUCCESS)
1417				io->io_hdr.status = msg->hdr.status;
1418
1419			if (msg->dt.sg_sequence == 0) {
1420#ifdef CTL_TIME_IO
1421				getbinuptime(&io->io_hdr.dma_start_bt);
1422#endif
1423				i = msg->dt.kern_sg_entries +
1424				    msg->dt.kern_data_len /
1425				    CTL_HA_DATAMOVE_SEGMENT + 1;
1426				sgl = malloc(sizeof(*sgl) * i, M_CTL,
1427				    M_WAITOK | M_ZERO);
1428				io->io_hdr.remote_sglist = sgl;
1429				io->io_hdr.local_sglist =
1430				    &sgl[msg->dt.kern_sg_entries];
1431
1432				io->scsiio.kern_data_ptr = (uint8_t *)sgl;
1433
1434				io->scsiio.kern_sg_entries =
1435					msg->dt.kern_sg_entries;
1436				io->scsiio.rem_sg_entries =
1437					msg->dt.kern_sg_entries;
1438				io->scsiio.kern_data_len =
1439					msg->dt.kern_data_len;
1440				io->scsiio.kern_total_len =
1441					msg->dt.kern_total_len;
1442				io->scsiio.kern_data_resid =
1443					msg->dt.kern_data_resid;
1444				io->scsiio.kern_rel_offset =
1445					msg->dt.kern_rel_offset;
1446				io->io_hdr.flags &= ~CTL_FLAG_BUS_ADDR;
1447				io->io_hdr.flags |= msg->dt.flags &
1448				    CTL_FLAG_BUS_ADDR;
1449			} else
1450				sgl = (struct ctl_sg_entry *)
1451					io->scsiio.kern_data_ptr;
1452
1453			for (i = msg->dt.sent_sg_entries, j = 0;
1454			     i < (msg->dt.sent_sg_entries +
1455			     msg->dt.cur_sg_entries); i++, j++) {
1456				sgl[i].addr = msg->dt.sg_list[j].addr;
1457				sgl[i].len = msg->dt.sg_list[j].len;
1458
1459#if 0
1460				printf("%s: DATAMOVE: %p,%lu j=%d, i=%d\n",
1461				    __func__, sgl[i].addr, sgl[i].len, j, i);
1462#endif
1463			}
1464
1465			/*
1466			 * If this is the last piece of the I/O, we've got
1467			 * the full S/G list.  Queue processing in the thread.
1468			 * Otherwise wait for the next piece.
1469			 */
1470			if (msg->dt.sg_last != 0)
1471				ctl_enqueue_isc(io);
1472			break;
1473		}
1474		/* Performed on the Serializing (primary) SC, XFER mode only */
1475		case CTL_MSG_DATAMOVE_DONE: {
1476			if (msg->hdr.serializing_sc == NULL) {
1477				printf("%s: serializing_sc == NULL!\n",
1478				       __func__);
1479				/* XXX KDM now what? */
1480				break;
1481			}
1482			/*
1483			 * We grab the sense information here in case
1484			 * there was a failure, so we can return status
1485			 * back to the initiator.
1486			 */
1487			io = msg->hdr.serializing_sc;
1488			io->io_hdr.msg_type = CTL_MSG_DATAMOVE_DONE;
1489			io->io_hdr.flags &= ~CTL_FLAG_DMA_INPROG;
1490			io->io_hdr.flags |= CTL_FLAG_IO_ACTIVE;
1491			io->io_hdr.port_status = msg->scsi.fetd_status;
1492			io->scsiio.residual = msg->scsi.residual;
1493			if (msg->hdr.status != CTL_STATUS_NONE) {
1494				io->io_hdr.status = msg->hdr.status;
1495				io->scsiio.scsi_status = msg->scsi.scsi_status;
1496				io->scsiio.sense_len = msg->scsi.sense_len;
1497				io->scsiio.sense_residual =msg->scsi.sense_residual;
1498				memcpy(&io->scsiio.sense_data,
1499				    &msg->scsi.sense_data,
1500				    msg->scsi.sense_len);
1501				if (msg->hdr.status == CTL_SUCCESS)
1502					io->io_hdr.flags |= CTL_FLAG_STATUS_SENT;
1503			}
1504			ctl_enqueue_isc(io);
1505			break;
1506		}
1507
1508		/* Preformed on Originating SC, SER_ONLY mode */
1509		case CTL_MSG_R2R:
1510			io = msg->hdr.original_sc;
1511			if (io == NULL) {
1512				printf("%s: original_sc == NULL!\n",
1513				    __func__);
1514				break;
1515			}
1516			io->io_hdr.flags |= CTL_FLAG_IO_ACTIVE;
1517			io->io_hdr.msg_type = CTL_MSG_R2R;
1518			io->io_hdr.serializing_sc = msg->hdr.serializing_sc;
1519			ctl_enqueue_isc(io);
1520			break;
1521
1522		/*
1523		 * Performed on Serializing(i.e. primary SC) SC in SER_ONLY
1524		 * mode.
1525		 * Performed on the Originating (i.e. secondary) SC in XFER
1526		 * mode
1527		 */
1528		case CTL_MSG_FINISH_IO:
1529			if (softc->ha_mode == CTL_HA_MODE_XFER)
1530				ctl_isc_handler_finish_xfer(softc, msg);
1531			else
1532				ctl_isc_handler_finish_ser_only(softc, msg);
1533			break;
1534
1535		/* Preformed on Originating SC */
1536		case CTL_MSG_BAD_JUJU:
1537			io = msg->hdr.original_sc;
1538			if (io == NULL) {
1539				printf("%s: Bad JUJU!, original_sc is NULL!\n",
1540				       __func__);
1541				break;
1542			}
1543			ctl_copy_sense_data(msg, io);
1544			/*
1545			 * IO should have already been cleaned up on other
1546			 * SC so clear this flag so we won't send a message
1547			 * back to finish the IO there.
1548			 */
1549			io->io_hdr.flags &= ~CTL_FLAG_SENT_2OTHER_SC;
1550			io->io_hdr.flags |= CTL_FLAG_IO_ACTIVE;
1551
1552			/* io = msg->hdr.serializing_sc; */
1553			io->io_hdr.msg_type = CTL_MSG_BAD_JUJU;
1554			ctl_enqueue_isc(io);
1555			break;
1556
1557		/* Handle resets sent from the other side */
1558		case CTL_MSG_MANAGE_TASKS: {
1559			struct ctl_taskio *taskio;
1560			taskio = (struct ctl_taskio *)ctl_alloc_io(
1561			    softc->othersc_pool);
1562			ctl_zero_io((union ctl_io *)taskio);
1563			taskio->io_hdr.io_type = CTL_IO_TASK;
1564			taskio->io_hdr.flags |= CTL_FLAG_FROM_OTHER_SC;
1565			taskio->io_hdr.nexus = msg->hdr.nexus;
1566			taskio->task_action = msg->task.task_action;
1567			taskio->tag_num = msg->task.tag_num;
1568			taskio->tag_type = msg->task.tag_type;
1569#ifdef CTL_TIME_IO
1570			taskio->io_hdr.start_time = time_uptime;
1571			getbinuptime(&taskio->io_hdr.start_bt);
1572#endif /* CTL_TIME_IO */
1573			ctl_run_task((union ctl_io *)taskio);
1574			break;
1575		}
1576		/* Persistent Reserve action which needs attention */
1577		case CTL_MSG_PERS_ACTION:
1578			presio = (struct ctl_prio *)ctl_alloc_io(
1579			    softc->othersc_pool);
1580			ctl_zero_io((union ctl_io *)presio);
1581			presio->io_hdr.msg_type = CTL_MSG_PERS_ACTION;
1582			presio->io_hdr.flags |= CTL_FLAG_FROM_OTHER_SC;
1583			presio->io_hdr.nexus = msg->hdr.nexus;
1584			presio->pr_msg = msg->pr;
1585			ctl_enqueue_isc((union ctl_io *)presio);
1586			break;
1587		case CTL_MSG_UA:
1588			ctl_isc_ua(softc, msg, param);
1589			break;
1590		case CTL_MSG_PORT_SYNC:
1591			ctl_isc_port_sync(softc, msg, param);
1592			break;
1593		case CTL_MSG_LUN_SYNC:
1594			ctl_isc_lun_sync(softc, msg, param);
1595			break;
1596		case CTL_MSG_IID_SYNC:
1597			ctl_isc_iid_sync(softc, msg, param);
1598			break;
1599		case CTL_MSG_LOGIN:
1600			ctl_isc_login(softc, msg, param);
1601			break;
1602		case CTL_MSG_MODE_SYNC:
1603			ctl_isc_mode_sync(softc, msg, param);
1604			break;
1605		default:
1606			printf("Received HA message of unknown type %d\n",
1607			    msg->hdr.msg_type);
1608			ctl_ha_msg_abort(CTL_HA_CHAN_CTL);
1609			break;
1610		}
1611		if (msg != &msgbuf)
1612			free(msg, M_CTL);
1613	} else if (event == CTL_HA_EVT_LINK_CHANGE) {
1614		printf("CTL: HA link status changed from %d to %d\n",
1615		    softc->ha_link, param);
1616		if (param == softc->ha_link)
1617			return;
1618		if (softc->ha_link == CTL_HA_LINK_ONLINE) {
1619			softc->ha_link = param;
1620			ctl_isc_ha_link_down(softc);
1621		} else {
1622			softc->ha_link = param;
1623			if (softc->ha_link == CTL_HA_LINK_ONLINE)
1624				ctl_isc_ha_link_up(softc);
1625		}
1626		return;
1627	} else {
1628		printf("ctl_isc_event_handler: Unknown event %d\n", event);
1629		return;
1630	}
1631}
1632
1633static void
1634ctl_copy_sense_data(union ctl_ha_msg *src, union ctl_io *dest)
1635{
1636
1637	memcpy(&dest->scsiio.sense_data, &src->scsi.sense_data,
1638	    src->scsi.sense_len);
1639	dest->scsiio.scsi_status = src->scsi.scsi_status;
1640	dest->scsiio.sense_len = src->scsi.sense_len;
1641	dest->io_hdr.status = src->hdr.status;
1642}
1643
1644static void
1645ctl_copy_sense_data_back(union ctl_io *src, union ctl_ha_msg *dest)
1646{
1647
1648	memcpy(&dest->scsi.sense_data, &src->scsiio.sense_data,
1649	    src->scsiio.sense_len);
1650	dest->scsi.scsi_status = src->scsiio.scsi_status;
1651	dest->scsi.sense_len = src->scsiio.sense_len;
1652	dest->hdr.status = src->io_hdr.status;
1653}
1654
1655void
1656ctl_est_ua(struct ctl_lun *lun, uint32_t initidx, ctl_ua_type ua)
1657{
1658	struct ctl_softc *softc = lun->ctl_softc;
1659	ctl_ua_type *pu;
1660
1661	if (initidx < softc->init_min || initidx >= softc->init_max)
1662		return;
1663	mtx_assert(&lun->lun_lock, MA_OWNED);
1664	pu = lun->pending_ua[initidx / CTL_MAX_INIT_PER_PORT];
1665	if (pu == NULL)
1666		return;
1667	pu[initidx % CTL_MAX_INIT_PER_PORT] |= ua;
1668}
1669
1670void
1671ctl_est_ua_port(struct ctl_lun *lun, int port, uint32_t except, ctl_ua_type ua)
1672{
1673	int i;
1674
1675	mtx_assert(&lun->lun_lock, MA_OWNED);
1676	if (lun->pending_ua[port] == NULL)
1677		return;
1678	for (i = 0; i < CTL_MAX_INIT_PER_PORT; i++) {
1679		if (port * CTL_MAX_INIT_PER_PORT + i == except)
1680			continue;
1681		lun->pending_ua[port][i] |= ua;
1682	}
1683}
1684
1685void
1686ctl_est_ua_all(struct ctl_lun *lun, uint32_t except, ctl_ua_type ua)
1687{
1688	struct ctl_softc *softc = lun->ctl_softc;
1689	int i;
1690
1691	mtx_assert(&lun->lun_lock, MA_OWNED);
1692	for (i = softc->port_min; i < softc->port_max; i++)
1693		ctl_est_ua_port(lun, i, except, ua);
1694}
1695
1696void
1697ctl_clr_ua(struct ctl_lun *lun, uint32_t initidx, ctl_ua_type ua)
1698{
1699	struct ctl_softc *softc = lun->ctl_softc;
1700	ctl_ua_type *pu;
1701
1702	if (initidx < softc->init_min || initidx >= softc->init_max)
1703		return;
1704	mtx_assert(&lun->lun_lock, MA_OWNED);
1705	pu = lun->pending_ua[initidx / CTL_MAX_INIT_PER_PORT];
1706	if (pu == NULL)
1707		return;
1708	pu[initidx % CTL_MAX_INIT_PER_PORT] &= ~ua;
1709}
1710
1711void
1712ctl_clr_ua_all(struct ctl_lun *lun, uint32_t except, ctl_ua_type ua)
1713{
1714	struct ctl_softc *softc = lun->ctl_softc;
1715	int i, j;
1716
1717	mtx_assert(&lun->lun_lock, MA_OWNED);
1718	for (i = softc->port_min; i < softc->port_max; i++) {
1719		if (lun->pending_ua[i] == NULL)
1720			continue;
1721		for (j = 0; j < CTL_MAX_INIT_PER_PORT; j++) {
1722			if (i * CTL_MAX_INIT_PER_PORT + j == except)
1723				continue;
1724			lun->pending_ua[i][j] &= ~ua;
1725		}
1726	}
1727}
1728
1729void
1730ctl_clr_ua_allluns(struct ctl_softc *ctl_softc, uint32_t initidx,
1731    ctl_ua_type ua_type)
1732{
1733	struct ctl_lun *lun;
1734
1735	mtx_assert(&ctl_softc->ctl_lock, MA_OWNED);
1736	STAILQ_FOREACH(lun, &ctl_softc->lun_list, links) {
1737		mtx_lock(&lun->lun_lock);
1738		ctl_clr_ua(lun, initidx, ua_type);
1739		mtx_unlock(&lun->lun_lock);
1740	}
1741}
1742
1743static int
1744ctl_ha_role_sysctl(SYSCTL_HANDLER_ARGS)
1745{
1746	struct ctl_softc *softc = (struct ctl_softc *)arg1;
1747	struct ctl_lun *lun;
1748	struct ctl_lun_req ireq;
1749	int error, value;
1750
1751	value = (softc->flags & CTL_FLAG_ACTIVE_SHELF) ? 0 : 1;
1752	error = sysctl_handle_int(oidp, &value, 0, req);
1753	if ((error != 0) || (req->newptr == NULL))
1754		return (error);
1755
1756	mtx_lock(&softc->ctl_lock);
1757	if (value == 0)
1758		softc->flags |= CTL_FLAG_ACTIVE_SHELF;
1759	else
1760		softc->flags &= ~CTL_FLAG_ACTIVE_SHELF;
1761	STAILQ_FOREACH(lun, &softc->lun_list, links) {
1762		mtx_unlock(&softc->ctl_lock);
1763		bzero(&ireq, sizeof(ireq));
1764		ireq.reqtype = CTL_LUNREQ_MODIFY;
1765		ireq.reqdata.modify.lun_id = lun->lun;
1766		lun->backend->ioctl(NULL, CTL_LUN_REQ, (caddr_t)&ireq, 0,
1767		    curthread);
1768		if (ireq.status != CTL_LUN_OK) {
1769			printf("%s: CTL_LUNREQ_MODIFY returned %d '%s'\n",
1770			    __func__, ireq.status, ireq.error_str);
1771		}
1772		mtx_lock(&softc->ctl_lock);
1773	}
1774	mtx_unlock(&softc->ctl_lock);
1775	return (0);
1776}
1777
1778static int
1779ctl_init(void)
1780{
1781	struct make_dev_args args;
1782	struct ctl_softc *softc;
1783	void *other_pool;
1784	int i, error;
1785
1786	softc = control_softc = malloc(sizeof(*control_softc), M_DEVBUF,
1787			       M_WAITOK | M_ZERO);
1788
1789	make_dev_args_init(&args);
1790	args.mda_devsw = &ctl_cdevsw;
1791	args.mda_uid = UID_ROOT;
1792	args.mda_gid = GID_OPERATOR;
1793	args.mda_mode = 0600;
1794	args.mda_si_drv1 = softc;
1795	error = make_dev_s(&args, &softc->dev, "cam/ctl");
1796	if (error != 0) {
1797		free(control_softc, M_DEVBUF);
1798		return (error);
1799	}
1800
1801	sysctl_ctx_init(&softc->sysctl_ctx);
1802	softc->sysctl_tree = SYSCTL_ADD_NODE(&softc->sysctl_ctx,
1803		SYSCTL_STATIC_CHILDREN(_kern_cam), OID_AUTO, "ctl",
1804		CTLFLAG_RD, 0, "CAM Target Layer");
1805
1806	if (softc->sysctl_tree == NULL) {
1807		printf("%s: unable to allocate sysctl tree\n", __func__);
1808		destroy_dev(softc->dev);
1809		free(control_softc, M_DEVBUF);
1810		control_softc = NULL;
1811		return (ENOMEM);
1812	}
1813
1814	mtx_init(&softc->ctl_lock, "CTL mutex", NULL, MTX_DEF);
1815	softc->io_zone = uma_zcreate("CTL IO", sizeof(union ctl_io),
1816	    NULL, NULL, NULL, NULL, UMA_ALIGN_PTR, 0);
1817	softc->flags = 0;
1818
1819	SYSCTL_ADD_INT(&softc->sysctl_ctx, SYSCTL_CHILDREN(softc->sysctl_tree),
1820	    OID_AUTO, "ha_mode", CTLFLAG_RDTUN, (int *)&softc->ha_mode, 0,
1821	    "HA mode (0 - act/stby, 1 - serialize only, 2 - xfer)");
1822
1823	/*
1824	 * In Copan's HA scheme, the "master" and "slave" roles are
1825	 * figured out through the slot the controller is in.  Although it
1826	 * is an active/active system, someone has to be in charge.
1827	 */
1828	SYSCTL_ADD_INT(&softc->sysctl_ctx, SYSCTL_CHILDREN(softc->sysctl_tree),
1829	    OID_AUTO, "ha_id", CTLFLAG_RDTUN, &softc->ha_id, 0,
1830	    "HA head ID (0 - no HA)");
1831	if (softc->ha_id == 0 || softc->ha_id > NUM_HA_SHELVES) {
1832		softc->flags |= CTL_FLAG_ACTIVE_SHELF;
1833		softc->is_single = 1;
1834		softc->port_cnt = CTL_MAX_PORTS;
1835		softc->port_min = 0;
1836	} else {
1837		softc->port_cnt = CTL_MAX_PORTS / NUM_HA_SHELVES;
1838		softc->port_min = (softc->ha_id - 1) * softc->port_cnt;
1839	}
1840	softc->port_max = softc->port_min + softc->port_cnt;
1841	softc->init_min = softc->port_min * CTL_MAX_INIT_PER_PORT;
1842	softc->init_max = softc->port_max * CTL_MAX_INIT_PER_PORT;
1843
1844	SYSCTL_ADD_INT(&softc->sysctl_ctx, SYSCTL_CHILDREN(softc->sysctl_tree),
1845	    OID_AUTO, "ha_link", CTLFLAG_RD, (int *)&softc->ha_link, 0,
1846	    "HA link state (0 - offline, 1 - unknown, 2 - online)");
1847
1848	STAILQ_INIT(&softc->lun_list);
1849	STAILQ_INIT(&softc->pending_lun_queue);
1850	STAILQ_INIT(&softc->fe_list);
1851	STAILQ_INIT(&softc->port_list);
1852	STAILQ_INIT(&softc->be_list);
1853	ctl_tpc_init(softc);
1854
1855	if (ctl_pool_create(softc, "othersc", CTL_POOL_ENTRIES_OTHER_SC,
1856	                    &other_pool) != 0)
1857	{
1858		printf("ctl: can't allocate %d entry other SC pool, "
1859		       "exiting\n", CTL_POOL_ENTRIES_OTHER_SC);
1860		return (ENOMEM);
1861	}
1862	softc->othersc_pool = other_pool;
1863
1864	if (worker_threads <= 0)
1865		worker_threads = max(1, mp_ncpus / 4);
1866	if (worker_threads > CTL_MAX_THREADS)
1867		worker_threads = CTL_MAX_THREADS;
1868
1869	for (i = 0; i < worker_threads; i++) {
1870		struct ctl_thread *thr = &softc->threads[i];
1871
1872		mtx_init(&thr->queue_lock, "CTL queue mutex", NULL, MTX_DEF);
1873		thr->ctl_softc = softc;
1874		STAILQ_INIT(&thr->incoming_queue);
1875		STAILQ_INIT(&thr->rtr_queue);
1876		STAILQ_INIT(&thr->done_queue);
1877		STAILQ_INIT(&thr->isc_queue);
1878
1879		error = kproc_kthread_add(ctl_work_thread, thr,
1880		    &softc->ctl_proc, &thr->thread, 0, 0, "ctl", "work%d", i);
1881		if (error != 0) {
1882			printf("error creating CTL work thread!\n");
1883			ctl_pool_free(other_pool);
1884			return (error);
1885		}
1886	}
1887	error = kproc_kthread_add(ctl_lun_thread, softc,
1888	    &softc->ctl_proc, NULL, 0, 0, "ctl", "lun");
1889	if (error != 0) {
1890		printf("error creating CTL lun thread!\n");
1891		ctl_pool_free(other_pool);
1892		return (error);
1893	}
1894	error = kproc_kthread_add(ctl_thresh_thread, softc,
1895	    &softc->ctl_proc, NULL, 0, 0, "ctl", "thresh");
1896	if (error != 0) {
1897		printf("error creating CTL threshold thread!\n");
1898		ctl_pool_free(other_pool);
1899		return (error);
1900	}
1901
1902	SYSCTL_ADD_PROC(&softc->sysctl_ctx,SYSCTL_CHILDREN(softc->sysctl_tree),
1903	    OID_AUTO, "ha_role", CTLTYPE_INT | CTLFLAG_RWTUN,
1904	    softc, 0, ctl_ha_role_sysctl, "I", "HA role for this head");
1905
1906	if (softc->is_single == 0) {
1907		ctl_frontend_register(&ha_frontend);
1908		if (ctl_ha_msg_init(softc) != CTL_HA_STATUS_SUCCESS) {
1909			printf("ctl_init: ctl_ha_msg_init failed.\n");
1910			softc->is_single = 1;
1911		} else
1912		if (ctl_ha_msg_register(CTL_HA_CHAN_CTL, ctl_isc_event_handler)
1913		    != CTL_HA_STATUS_SUCCESS) {
1914			printf("ctl_init: ctl_ha_msg_register failed.\n");
1915			softc->is_single = 1;
1916		}
1917	}
1918	return (0);
1919}
1920
1921void
1922ctl_shutdown(void)
1923{
1924	struct ctl_softc *softc = control_softc;
1925	struct ctl_lun *lun, *next_lun;
1926
1927	if (softc->is_single == 0) {
1928		ctl_ha_msg_shutdown(softc);
1929		if (ctl_ha_msg_deregister(CTL_HA_CHAN_CTL)
1930		    != CTL_HA_STATUS_SUCCESS)
1931			printf("%s: ctl_ha_msg_deregister failed.\n", __func__);
1932		if (ctl_ha_msg_destroy(softc) != CTL_HA_STATUS_SUCCESS)
1933			printf("%s: ctl_ha_msg_destroy failed.\n", __func__);
1934		ctl_frontend_deregister(&ha_frontend);
1935	}
1936
1937	mtx_lock(&softc->ctl_lock);
1938
1939	STAILQ_FOREACH_SAFE(lun, &softc->lun_list, links, next_lun)
1940		ctl_free_lun(lun);
1941
1942	mtx_unlock(&softc->ctl_lock);
1943
1944#if 0
1945	ctl_shutdown_thread(softc->work_thread);
1946	mtx_destroy(&softc->queue_lock);
1947#endif
1948
1949	ctl_tpc_shutdown(softc);
1950	uma_zdestroy(softc->io_zone);
1951	mtx_destroy(&softc->ctl_lock);
1952
1953	destroy_dev(softc->dev);
1954
1955	sysctl_ctx_free(&softc->sysctl_ctx);
1956
1957	free(control_softc, M_DEVBUF);
1958	control_softc = NULL;
1959}
1960
1961static int
1962ctl_module_event_handler(module_t mod, int what, void *arg)
1963{
1964
1965	switch (what) {
1966	case MOD_LOAD:
1967		return (ctl_init());
1968	case MOD_UNLOAD:
1969		return (EBUSY);
1970	default:
1971		return (EOPNOTSUPP);
1972	}
1973}
1974
1975/*
1976 * XXX KDM should we do some access checks here?  Bump a reference count to
1977 * prevent a CTL module from being unloaded while someone has it open?
1978 */
1979static int
1980ctl_open(struct cdev *dev, int flags, int fmt, struct thread *td)
1981{
1982	return (0);
1983}
1984
1985static int
1986ctl_close(struct cdev *dev, int flags, int fmt, struct thread *td)
1987{
1988	return (0);
1989}
1990
1991/*
1992 * Remove an initiator by port number and initiator ID.
1993 * Returns 0 for success, -1 for failure.
1994 */
1995int
1996ctl_remove_initiator(struct ctl_port *port, int iid)
1997{
1998	struct ctl_softc *softc = port->ctl_softc;
1999
2000	mtx_assert(&softc->ctl_lock, MA_NOTOWNED);
2001
2002	if (iid > CTL_MAX_INIT_PER_PORT) {
2003		printf("%s: initiator ID %u > maximun %u!\n",
2004		       __func__, iid, CTL_MAX_INIT_PER_PORT);
2005		return (-1);
2006	}
2007
2008	mtx_lock(&softc->ctl_lock);
2009	port->wwpn_iid[iid].in_use--;
2010	port->wwpn_iid[iid].last_use = time_uptime;
2011	mtx_unlock(&softc->ctl_lock);
2012	ctl_isc_announce_iid(port, iid);
2013
2014	return (0);
2015}
2016
2017/*
2018 * Add an initiator to the initiator map.
2019 * Returns iid for success, < 0 for failure.
2020 */
2021int
2022ctl_add_initiator(struct ctl_port *port, int iid, uint64_t wwpn, char *name)
2023{
2024	struct ctl_softc *softc = port->ctl_softc;
2025	time_t best_time;
2026	int i, best;
2027
2028	mtx_assert(&softc->ctl_lock, MA_NOTOWNED);
2029
2030	if (iid >= CTL_MAX_INIT_PER_PORT) {
2031		printf("%s: WWPN %#jx initiator ID %u > maximum %u!\n",
2032		       __func__, wwpn, iid, CTL_MAX_INIT_PER_PORT);
2033		free(name, M_CTL);
2034		return (-1);
2035	}
2036
2037	mtx_lock(&softc->ctl_lock);
2038
2039	if (iid < 0 && (wwpn != 0 || name != NULL)) {
2040		for (i = 0; i < CTL_MAX_INIT_PER_PORT; i++) {
2041			if (wwpn != 0 && wwpn == port->wwpn_iid[i].wwpn) {
2042				iid = i;
2043				break;
2044			}
2045			if (name != NULL && port->wwpn_iid[i].name != NULL &&
2046			    strcmp(name, port->wwpn_iid[i].name) == 0) {
2047				iid = i;
2048				break;
2049			}
2050		}
2051	}
2052
2053	if (iid < 0) {
2054		for (i = 0; i < CTL_MAX_INIT_PER_PORT; i++) {
2055			if (port->wwpn_iid[i].in_use == 0 &&
2056			    port->wwpn_iid[i].wwpn == 0 &&
2057			    port->wwpn_iid[i].name == NULL) {
2058				iid = i;
2059				break;
2060			}
2061		}
2062	}
2063
2064	if (iid < 0) {
2065		best = -1;
2066		best_time = INT32_MAX;
2067		for (i = 0; i < CTL_MAX_INIT_PER_PORT; i++) {
2068			if (port->wwpn_iid[i].in_use == 0) {
2069				if (port->wwpn_iid[i].last_use < best_time) {
2070					best = i;
2071					best_time = port->wwpn_iid[i].last_use;
2072				}
2073			}
2074		}
2075		iid = best;
2076	}
2077
2078	if (iid < 0) {
2079		mtx_unlock(&softc->ctl_lock);
2080		free(name, M_CTL);
2081		return (-2);
2082	}
2083
2084	if (port->wwpn_iid[iid].in_use > 0 && (wwpn != 0 || name != NULL)) {
2085		/*
2086		 * This is not an error yet.
2087		 */
2088		if (wwpn != 0 && wwpn == port->wwpn_iid[iid].wwpn) {
2089#if 0
2090			printf("%s: port %d iid %u WWPN %#jx arrived"
2091			    " again\n", __func__, port->targ_port,
2092			    iid, (uintmax_t)wwpn);
2093#endif
2094			goto take;
2095		}
2096		if (name != NULL && port->wwpn_iid[iid].name != NULL &&
2097		    strcmp(name, port->wwpn_iid[iid].name) == 0) {
2098#if 0
2099			printf("%s: port %d iid %u name '%s' arrived"
2100			    " again\n", __func__, port->targ_port,
2101			    iid, name);
2102#endif
2103			goto take;
2104		}
2105
2106		/*
2107		 * This is an error, but what do we do about it?  The
2108		 * driver is telling us we have a new WWPN for this
2109		 * initiator ID, so we pretty much need to use it.
2110		 */
2111		printf("%s: port %d iid %u WWPN %#jx '%s' arrived,"
2112		    " but WWPN %#jx '%s' is still at that address\n",
2113		    __func__, port->targ_port, iid, wwpn, name,
2114		    (uintmax_t)port->wwpn_iid[iid].wwpn,
2115		    port->wwpn_iid[iid].name);
2116
2117		/*
2118		 * XXX KDM clear have_ca and ua_pending on each LUN for
2119		 * this initiator.
2120		 */
2121	}
2122take:
2123	free(port->wwpn_iid[iid].name, M_CTL);
2124	port->wwpn_iid[iid].name = name;
2125	port->wwpn_iid[iid].wwpn = wwpn;
2126	port->wwpn_iid[iid].in_use++;
2127	mtx_unlock(&softc->ctl_lock);
2128	ctl_isc_announce_iid(port, iid);
2129
2130	return (iid);
2131}
2132
2133static int
2134ctl_create_iid(struct ctl_port *port, int iid, uint8_t *buf)
2135{
2136	int len;
2137
2138	switch (port->port_type) {
2139	case CTL_PORT_FC:
2140	{
2141		struct scsi_transportid_fcp *id =
2142		    (struct scsi_transportid_fcp *)buf;
2143		if (port->wwpn_iid[iid].wwpn == 0)
2144			return (0);
2145		memset(id, 0, sizeof(*id));
2146		id->format_protocol = SCSI_PROTO_FC;
2147		scsi_u64to8b(port->wwpn_iid[iid].wwpn, id->n_port_name);
2148		return (sizeof(*id));
2149	}
2150	case CTL_PORT_ISCSI:
2151	{
2152		struct scsi_transportid_iscsi_port *id =
2153		    (struct scsi_transportid_iscsi_port *)buf;
2154		if (port->wwpn_iid[iid].name == NULL)
2155			return (0);
2156		memset(id, 0, 256);
2157		id->format_protocol = SCSI_TRN_ISCSI_FORMAT_PORT |
2158		    SCSI_PROTO_ISCSI;
2159		len = strlcpy(id->iscsi_name, port->wwpn_iid[iid].name, 252) + 1;
2160		len = roundup2(min(len, 252), 4);
2161		scsi_ulto2b(len, id->additional_length);
2162		return (sizeof(*id) + len);
2163	}
2164	case CTL_PORT_SAS:
2165	{
2166		struct scsi_transportid_sas *id =
2167		    (struct scsi_transportid_sas *)buf;
2168		if (port->wwpn_iid[iid].wwpn == 0)
2169			return (0);
2170		memset(id, 0, sizeof(*id));
2171		id->format_protocol = SCSI_PROTO_SAS;
2172		scsi_u64to8b(port->wwpn_iid[iid].wwpn, id->sas_address);
2173		return (sizeof(*id));
2174	}
2175	default:
2176	{
2177		struct scsi_transportid_spi *id =
2178		    (struct scsi_transportid_spi *)buf;
2179		memset(id, 0, sizeof(*id));
2180		id->format_protocol = SCSI_PROTO_SPI;
2181		scsi_ulto2b(iid, id->scsi_addr);
2182		scsi_ulto2b(port->targ_port, id->rel_trgt_port_id);
2183		return (sizeof(*id));
2184	}
2185	}
2186}
2187
2188/*
2189 * Serialize a command that went down the "wrong" side, and so was sent to
2190 * this controller for execution.  The logic is a little different than the
2191 * standard case in ctl_scsiio_precheck().  Errors in this case need to get
2192 * sent back to the other side, but in the success case, we execute the
2193 * command on this side (XFER mode) or tell the other side to execute it
2194 * (SER_ONLY mode).
2195 */
2196static int
2197ctl_serialize_other_sc_cmd(struct ctl_scsiio *ctsio)
2198{
2199	struct ctl_softc *softc = control_softc;
2200	union ctl_ha_msg msg_info;
2201	struct ctl_port *port;
2202	struct ctl_lun *lun;
2203	const struct ctl_cmd_entry *entry;
2204	int retval = 0;
2205	uint32_t targ_lun;
2206
2207	targ_lun = ctsio->io_hdr.nexus.targ_mapped_lun;
2208	mtx_lock(&softc->ctl_lock);
2209
2210	/* Make sure that we know about this port. */
2211	port = ctl_io_port(&ctsio->io_hdr);
2212	if (port == NULL || (port->status & CTL_PORT_STATUS_ONLINE) == 0) {
2213		ctl_set_internal_failure(ctsio, /*sks_valid*/ 0,
2214					 /*retry_count*/ 1);
2215		goto badjuju;
2216	}
2217
2218	/* Make sure that we know about this LUN. */
2219	if ((targ_lun < CTL_MAX_LUNS) &&
2220	    ((lun = softc->ctl_luns[targ_lun]) != NULL)) {
2221		mtx_lock(&lun->lun_lock);
2222		mtx_unlock(&softc->ctl_lock);
2223		/*
2224		 * If the LUN is invalid, pretend that it doesn't exist.
2225		 * It will go away as soon as all pending I/O has been
2226		 * completed.
2227		 */
2228		if (lun->flags & CTL_LUN_DISABLED) {
2229			mtx_unlock(&lun->lun_lock);
2230			lun = NULL;
2231		}
2232	} else {
2233		mtx_unlock(&softc->ctl_lock);
2234		lun = NULL;
2235	}
2236	if (lun == NULL) {
2237		/*
2238		 * The other node would not send this request to us unless
2239		 * received announce that we are primary node for this LUN.
2240		 * If this LUN does not exist now, it is probably result of
2241		 * a race, so respond to initiator in the most opaque way.
2242		 */
2243		ctl_set_busy(ctsio);
2244		goto badjuju;
2245	}
2246
2247	entry = ctl_get_cmd_entry(ctsio, NULL);
2248	if (ctl_scsiio_lun_check(lun, entry, ctsio) != 0) {
2249		mtx_unlock(&lun->lun_lock);
2250		goto badjuju;
2251	}
2252
2253	ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr = lun;
2254	ctsio->io_hdr.ctl_private[CTL_PRIV_BACKEND_LUN].ptr = lun->be_lun;
2255
2256	/*
2257	 * Every I/O goes into the OOA queue for a
2258	 * particular LUN, and stays there until completion.
2259	 */
2260#ifdef CTL_TIME_IO
2261	if (TAILQ_EMPTY(&lun->ooa_queue))
2262		lun->idle_time += getsbinuptime() - lun->last_busy;
2263#endif
2264	TAILQ_INSERT_TAIL(&lun->ooa_queue, &ctsio->io_hdr, ooa_links);
2265
2266	switch (ctl_check_ooa(lun, (union ctl_io *)ctsio,
2267		(union ctl_io *)TAILQ_PREV(&ctsio->io_hdr, ctl_ooaq,
2268		 ooa_links))) {
2269	case CTL_ACTION_BLOCK:
2270		ctsio->io_hdr.flags |= CTL_FLAG_BLOCKED;
2271		TAILQ_INSERT_TAIL(&lun->blocked_queue, &ctsio->io_hdr,
2272				  blocked_links);
2273		mtx_unlock(&lun->lun_lock);
2274		break;
2275	case CTL_ACTION_PASS:
2276	case CTL_ACTION_SKIP:
2277		if (softc->ha_mode == CTL_HA_MODE_XFER) {
2278			ctsio->io_hdr.flags |= CTL_FLAG_IS_WAS_ON_RTR;
2279			ctl_enqueue_rtr((union ctl_io *)ctsio);
2280			mtx_unlock(&lun->lun_lock);
2281		} else {
2282			ctsio->io_hdr.flags &= ~CTL_FLAG_IO_ACTIVE;
2283			mtx_unlock(&lun->lun_lock);
2284
2285			/* send msg back to other side */
2286			msg_info.hdr.original_sc = ctsio->io_hdr.original_sc;
2287			msg_info.hdr.serializing_sc = (union ctl_io *)ctsio;
2288			msg_info.hdr.msg_type = CTL_MSG_R2R;
2289			ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg_info,
2290			    sizeof(msg_info.hdr), M_WAITOK);
2291		}
2292		break;
2293	case CTL_ACTION_OVERLAP:
2294		TAILQ_REMOVE(&lun->ooa_queue, &ctsio->io_hdr, ooa_links);
2295		mtx_unlock(&lun->lun_lock);
2296		ctl_set_overlapped_cmd(ctsio);
2297		goto badjuju;
2298	case CTL_ACTION_OVERLAP_TAG:
2299		TAILQ_REMOVE(&lun->ooa_queue, &ctsio->io_hdr, ooa_links);
2300		mtx_unlock(&lun->lun_lock);
2301		ctl_set_overlapped_tag(ctsio, ctsio->tag_num);
2302		goto badjuju;
2303	case CTL_ACTION_ERROR:
2304	default:
2305		TAILQ_REMOVE(&lun->ooa_queue, &ctsio->io_hdr, ooa_links);
2306		mtx_unlock(&lun->lun_lock);
2307
2308		ctl_set_internal_failure(ctsio, /*sks_valid*/ 0,
2309					 /*retry_count*/ 0);
2310badjuju:
2311		ctl_copy_sense_data_back((union ctl_io *)ctsio, &msg_info);
2312		msg_info.hdr.original_sc = ctsio->io_hdr.original_sc;
2313		msg_info.hdr.serializing_sc = NULL;
2314		msg_info.hdr.msg_type = CTL_MSG_BAD_JUJU;
2315		ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg_info,
2316		    sizeof(msg_info.scsi), M_WAITOK);
2317		retval = 1;
2318		break;
2319	}
2320	return (retval);
2321}
2322
2323/*
2324 * Returns 0 for success, errno for failure.
2325 */
2326static void
2327ctl_ioctl_fill_ooa(struct ctl_lun *lun, uint32_t *cur_fill_num,
2328		   struct ctl_ooa *ooa_hdr, struct ctl_ooa_entry *kern_entries)
2329{
2330	union ctl_io *io;
2331
2332	mtx_lock(&lun->lun_lock);
2333	for (io = (union ctl_io *)TAILQ_FIRST(&lun->ooa_queue); (io != NULL);
2334	     (*cur_fill_num)++, io = (union ctl_io *)TAILQ_NEXT(&io->io_hdr,
2335	     ooa_links)) {
2336		struct ctl_ooa_entry *entry;
2337
2338		/*
2339		 * If we've got more than we can fit, just count the
2340		 * remaining entries.
2341		 */
2342		if (*cur_fill_num >= ooa_hdr->alloc_num)
2343			continue;
2344
2345		entry = &kern_entries[*cur_fill_num];
2346
2347		entry->tag_num = io->scsiio.tag_num;
2348		entry->lun_num = lun->lun;
2349#ifdef CTL_TIME_IO
2350		entry->start_bt = io->io_hdr.start_bt;
2351#endif
2352		bcopy(io->scsiio.cdb, entry->cdb, io->scsiio.cdb_len);
2353		entry->cdb_len = io->scsiio.cdb_len;
2354		if (io->io_hdr.flags & CTL_FLAG_BLOCKED)
2355			entry->cmd_flags |= CTL_OOACMD_FLAG_BLOCKED;
2356
2357		if (io->io_hdr.flags & CTL_FLAG_DMA_INPROG)
2358			entry->cmd_flags |= CTL_OOACMD_FLAG_DMA;
2359
2360		if (io->io_hdr.flags & CTL_FLAG_ABORT)
2361			entry->cmd_flags |= CTL_OOACMD_FLAG_ABORT;
2362
2363		if (io->io_hdr.flags & CTL_FLAG_IS_WAS_ON_RTR)
2364			entry->cmd_flags |= CTL_OOACMD_FLAG_RTR;
2365
2366		if (io->io_hdr.flags & CTL_FLAG_DMA_QUEUED)
2367			entry->cmd_flags |= CTL_OOACMD_FLAG_DMA_QUEUED;
2368	}
2369	mtx_unlock(&lun->lun_lock);
2370}
2371
2372static void *
2373ctl_copyin_alloc(void *user_addr, unsigned int len, char *error_str,
2374		 size_t error_str_len)
2375{
2376	void *kptr;
2377
2378	kptr = malloc(len, M_CTL, M_WAITOK | M_ZERO);
2379
2380	if (copyin(user_addr, kptr, len) != 0) {
2381		snprintf(error_str, error_str_len, "Error copying %d bytes "
2382			 "from user address %p to kernel address %p", len,
2383			 user_addr, kptr);
2384		free(kptr, M_CTL);
2385		return (NULL);
2386	}
2387
2388	return (kptr);
2389}
2390
2391static void
2392ctl_free_args(int num_args, struct ctl_be_arg *args)
2393{
2394	int i;
2395
2396	if (args == NULL)
2397		return;
2398
2399	for (i = 0; i < num_args; i++) {
2400		free(args[i].kname, M_CTL);
2401		free(args[i].kvalue, M_CTL);
2402	}
2403
2404	free(args, M_CTL);
2405}
2406
2407static struct ctl_be_arg *
2408ctl_copyin_args(int num_args, struct ctl_be_arg *uargs,
2409		char *error_str, size_t error_str_len)
2410{
2411	struct ctl_be_arg *args;
2412	int i;
2413
2414	args = ctl_copyin_alloc(uargs, num_args * sizeof(*args),
2415				error_str, error_str_len);
2416
2417	if (args == NULL)
2418		goto bailout;
2419
2420	for (i = 0; i < num_args; i++) {
2421		args[i].kname = NULL;
2422		args[i].kvalue = NULL;
2423	}
2424
2425	for (i = 0; i < num_args; i++) {
2426		uint8_t *tmpptr;
2427
2428		if (args[i].namelen == 0) {
2429			snprintf(error_str, error_str_len, "Argument %d "
2430				 "name length is zero", i);
2431			goto bailout;
2432		}
2433
2434		args[i].kname = ctl_copyin_alloc(args[i].name,
2435			args[i].namelen, error_str, error_str_len);
2436		if (args[i].kname == NULL)
2437			goto bailout;
2438
2439		if (args[i].kname[args[i].namelen - 1] != '\0') {
2440			snprintf(error_str, error_str_len, "Argument %d "
2441				 "name is not NUL-terminated", i);
2442			goto bailout;
2443		}
2444
2445		if (args[i].flags & CTL_BEARG_RD) {
2446			if (args[i].vallen == 0) {
2447				snprintf(error_str, error_str_len, "Argument %d "
2448					 "value length is zero", i);
2449				goto bailout;
2450			}
2451
2452			tmpptr = ctl_copyin_alloc(args[i].value,
2453				args[i].vallen, error_str, error_str_len);
2454			if (tmpptr == NULL)
2455				goto bailout;
2456
2457			if ((args[i].flags & CTL_BEARG_ASCII)
2458			 && (tmpptr[args[i].vallen - 1] != '\0')) {
2459				snprintf(error_str, error_str_len, "Argument "
2460				    "%d value is not NUL-terminated", i);
2461				free(tmpptr, M_CTL);
2462				goto bailout;
2463			}
2464			args[i].kvalue = tmpptr;
2465		} else {
2466			args[i].kvalue = malloc(args[i].vallen,
2467			    M_CTL, M_WAITOK | M_ZERO);
2468		}
2469	}
2470
2471	return (args);
2472bailout:
2473
2474	ctl_free_args(num_args, args);
2475
2476	return (NULL);
2477}
2478
2479static void
2480ctl_copyout_args(int num_args, struct ctl_be_arg *args)
2481{
2482	int i;
2483
2484	for (i = 0; i < num_args; i++) {
2485		if (args[i].flags & CTL_BEARG_WR)
2486			copyout(args[i].kvalue, args[i].value, args[i].vallen);
2487	}
2488}
2489
2490/*
2491 * Escape characters that are illegal or not recommended in XML.
2492 */
2493int
2494ctl_sbuf_printf_esc(struct sbuf *sb, char *str, int size)
2495{
2496	char *end = str + size;
2497	int retval;
2498
2499	retval = 0;
2500
2501	for (; *str && str < end; str++) {
2502		switch (*str) {
2503		case '&':
2504			retval = sbuf_printf(sb, "&amp;");
2505			break;
2506		case '>':
2507			retval = sbuf_printf(sb, "&gt;");
2508			break;
2509		case '<':
2510			retval = sbuf_printf(sb, "&lt;");
2511			break;
2512		default:
2513			retval = sbuf_putc(sb, *str);
2514			break;
2515		}
2516
2517		if (retval != 0)
2518			break;
2519
2520	}
2521
2522	return (retval);
2523}
2524
2525static void
2526ctl_id_sbuf(struct ctl_devid *id, struct sbuf *sb)
2527{
2528	struct scsi_vpd_id_descriptor *desc;
2529	int i;
2530
2531	if (id == NULL || id->len < 4)
2532		return;
2533	desc = (struct scsi_vpd_id_descriptor *)id->data;
2534	switch (desc->id_type & SVPD_ID_TYPE_MASK) {
2535	case SVPD_ID_TYPE_T10:
2536		sbuf_printf(sb, "t10.");
2537		break;
2538	case SVPD_ID_TYPE_EUI64:
2539		sbuf_printf(sb, "eui.");
2540		break;
2541	case SVPD_ID_TYPE_NAA:
2542		sbuf_printf(sb, "naa.");
2543		break;
2544	case SVPD_ID_TYPE_SCSI_NAME:
2545		break;
2546	}
2547	switch (desc->proto_codeset & SVPD_ID_CODESET_MASK) {
2548	case SVPD_ID_CODESET_BINARY:
2549		for (i = 0; i < desc->length; i++)
2550			sbuf_printf(sb, "%02x", desc->identifier[i]);
2551		break;
2552	case SVPD_ID_CODESET_ASCII:
2553		sbuf_printf(sb, "%.*s", (int)desc->length,
2554		    (char *)desc->identifier);
2555		break;
2556	case SVPD_ID_CODESET_UTF8:
2557		sbuf_printf(sb, "%s", (char *)desc->identifier);
2558		break;
2559	}
2560}
2561
2562static int
2563ctl_ioctl(struct cdev *dev, u_long cmd, caddr_t addr, int flag,
2564	  struct thread *td)
2565{
2566	struct ctl_softc *softc = dev->si_drv1;
2567	struct ctl_lun *lun;
2568	int retval;
2569
2570	retval = 0;
2571
2572	switch (cmd) {
2573	case CTL_IO:
2574		retval = ctl_ioctl_io(dev, cmd, addr, flag, td);
2575		break;
2576	case CTL_ENABLE_PORT:
2577	case CTL_DISABLE_PORT:
2578	case CTL_SET_PORT_WWNS: {
2579		struct ctl_port *port;
2580		struct ctl_port_entry *entry;
2581
2582		entry = (struct ctl_port_entry *)addr;
2583
2584		mtx_lock(&softc->ctl_lock);
2585		STAILQ_FOREACH(port, &softc->port_list, links) {
2586			int action, done;
2587
2588			if (port->targ_port < softc->port_min ||
2589			    port->targ_port >= softc->port_max)
2590				continue;
2591
2592			action = 0;
2593			done = 0;
2594			if ((entry->port_type == CTL_PORT_NONE)
2595			 && (entry->targ_port == port->targ_port)) {
2596				/*
2597				 * If the user only wants to enable or
2598				 * disable or set WWNs on a specific port,
2599				 * do the operation and we're done.
2600				 */
2601				action = 1;
2602				done = 1;
2603			} else if (entry->port_type & port->port_type) {
2604				/*
2605				 * Compare the user's type mask with the
2606				 * particular frontend type to see if we
2607				 * have a match.
2608				 */
2609				action = 1;
2610				done = 0;
2611
2612				/*
2613				 * Make sure the user isn't trying to set
2614				 * WWNs on multiple ports at the same time.
2615				 */
2616				if (cmd == CTL_SET_PORT_WWNS) {
2617					printf("%s: Can't set WWNs on "
2618					       "multiple ports\n", __func__);
2619					retval = EINVAL;
2620					break;
2621				}
2622			}
2623			if (action == 0)
2624				continue;
2625
2626			/*
2627			 * XXX KDM we have to drop the lock here, because
2628			 * the online/offline operations can potentially
2629			 * block.  We need to reference count the frontends
2630			 * so they can't go away,
2631			 */
2632			if (cmd == CTL_ENABLE_PORT) {
2633				mtx_unlock(&softc->ctl_lock);
2634				ctl_port_online(port);
2635				mtx_lock(&softc->ctl_lock);
2636			} else if (cmd == CTL_DISABLE_PORT) {
2637				mtx_unlock(&softc->ctl_lock);
2638				ctl_port_offline(port);
2639				mtx_lock(&softc->ctl_lock);
2640			} else if (cmd == CTL_SET_PORT_WWNS) {
2641				ctl_port_set_wwns(port,
2642				    (entry->flags & CTL_PORT_WWNN_VALID) ?
2643				    1 : 0, entry->wwnn,
2644				    (entry->flags & CTL_PORT_WWPN_VALID) ?
2645				    1 : 0, entry->wwpn);
2646			}
2647			if (done != 0)
2648				break;
2649		}
2650		mtx_unlock(&softc->ctl_lock);
2651		break;
2652	}
2653	case CTL_GET_OOA: {
2654		struct ctl_ooa *ooa_hdr;
2655		struct ctl_ooa_entry *entries;
2656		uint32_t cur_fill_num;
2657
2658		ooa_hdr = (struct ctl_ooa *)addr;
2659
2660		if ((ooa_hdr->alloc_len == 0)
2661		 || (ooa_hdr->alloc_num == 0)) {
2662			printf("%s: CTL_GET_OOA: alloc len %u and alloc num %u "
2663			       "must be non-zero\n", __func__,
2664			       ooa_hdr->alloc_len, ooa_hdr->alloc_num);
2665			retval = EINVAL;
2666			break;
2667		}
2668
2669		if (ooa_hdr->alloc_len != (ooa_hdr->alloc_num *
2670		    sizeof(struct ctl_ooa_entry))) {
2671			printf("%s: CTL_GET_OOA: alloc len %u must be alloc "
2672			       "num %d * sizeof(struct ctl_ooa_entry) %zd\n",
2673			       __func__, ooa_hdr->alloc_len,
2674			       ooa_hdr->alloc_num,sizeof(struct ctl_ooa_entry));
2675			retval = EINVAL;
2676			break;
2677		}
2678
2679		entries = malloc(ooa_hdr->alloc_len, M_CTL, M_WAITOK | M_ZERO);
2680		if (entries == NULL) {
2681			printf("%s: could not allocate %d bytes for OOA "
2682			       "dump\n", __func__, ooa_hdr->alloc_len);
2683			retval = ENOMEM;
2684			break;
2685		}
2686
2687		mtx_lock(&softc->ctl_lock);
2688		if (((ooa_hdr->flags & CTL_OOA_FLAG_ALL_LUNS) == 0)
2689		 && ((ooa_hdr->lun_num >= CTL_MAX_LUNS)
2690		  || (softc->ctl_luns[ooa_hdr->lun_num] == NULL))) {
2691			mtx_unlock(&softc->ctl_lock);
2692			free(entries, M_CTL);
2693			printf("%s: CTL_GET_OOA: invalid LUN %ju\n",
2694			       __func__, (uintmax_t)ooa_hdr->lun_num);
2695			retval = EINVAL;
2696			break;
2697		}
2698
2699		cur_fill_num = 0;
2700
2701		if (ooa_hdr->flags & CTL_OOA_FLAG_ALL_LUNS) {
2702			STAILQ_FOREACH(lun, &softc->lun_list, links) {
2703				ctl_ioctl_fill_ooa(lun, &cur_fill_num,
2704				    ooa_hdr, entries);
2705			}
2706		} else {
2707			lun = softc->ctl_luns[ooa_hdr->lun_num];
2708			ctl_ioctl_fill_ooa(lun, &cur_fill_num, ooa_hdr,
2709			    entries);
2710		}
2711		mtx_unlock(&softc->ctl_lock);
2712
2713		ooa_hdr->fill_num = min(cur_fill_num, ooa_hdr->alloc_num);
2714		ooa_hdr->fill_len = ooa_hdr->fill_num *
2715			sizeof(struct ctl_ooa_entry);
2716		retval = copyout(entries, ooa_hdr->entries, ooa_hdr->fill_len);
2717		if (retval != 0) {
2718			printf("%s: error copying out %d bytes for OOA dump\n",
2719			       __func__, ooa_hdr->fill_len);
2720		}
2721
2722		getbinuptime(&ooa_hdr->cur_bt);
2723
2724		if (cur_fill_num > ooa_hdr->alloc_num) {
2725			ooa_hdr->dropped_num = cur_fill_num -ooa_hdr->alloc_num;
2726			ooa_hdr->status = CTL_OOA_NEED_MORE_SPACE;
2727		} else {
2728			ooa_hdr->dropped_num = 0;
2729			ooa_hdr->status = CTL_OOA_OK;
2730		}
2731
2732		free(entries, M_CTL);
2733		break;
2734	}
2735	case CTL_DELAY_IO: {
2736		struct ctl_io_delay_info *delay_info;
2737
2738		delay_info = (struct ctl_io_delay_info *)addr;
2739
2740#ifdef CTL_IO_DELAY
2741		mtx_lock(&softc->ctl_lock);
2742
2743		if ((delay_info->lun_id >= CTL_MAX_LUNS)
2744		 || (softc->ctl_luns[delay_info->lun_id] == NULL)) {
2745			delay_info->status = CTL_DELAY_STATUS_INVALID_LUN;
2746		} else {
2747			lun = softc->ctl_luns[delay_info->lun_id];
2748			mtx_lock(&lun->lun_lock);
2749
2750			delay_info->status = CTL_DELAY_STATUS_OK;
2751
2752			switch (delay_info->delay_type) {
2753			case CTL_DELAY_TYPE_CONT:
2754				break;
2755			case CTL_DELAY_TYPE_ONESHOT:
2756				break;
2757			default:
2758				delay_info->status =
2759					CTL_DELAY_STATUS_INVALID_TYPE;
2760				break;
2761			}
2762
2763			switch (delay_info->delay_loc) {
2764			case CTL_DELAY_LOC_DATAMOVE:
2765				lun->delay_info.datamove_type =
2766					delay_info->delay_type;
2767				lun->delay_info.datamove_delay =
2768					delay_info->delay_secs;
2769				break;
2770			case CTL_DELAY_LOC_DONE:
2771				lun->delay_info.done_type =
2772					delay_info->delay_type;
2773				lun->delay_info.done_delay =
2774					delay_info->delay_secs;
2775				break;
2776			default:
2777				delay_info->status =
2778					CTL_DELAY_STATUS_INVALID_LOC;
2779				break;
2780			}
2781			mtx_unlock(&lun->lun_lock);
2782		}
2783
2784		mtx_unlock(&softc->ctl_lock);
2785#else
2786		delay_info->status = CTL_DELAY_STATUS_NOT_IMPLEMENTED;
2787#endif /* CTL_IO_DELAY */
2788		break;
2789	}
2790	case CTL_GETSTATS: {
2791		struct ctl_stats *stats;
2792		int i;
2793
2794		stats = (struct ctl_stats *)addr;
2795
2796		if ((sizeof(struct ctl_lun_io_stats) * softc->num_luns) >
2797		     stats->alloc_len) {
2798			stats->status = CTL_SS_NEED_MORE_SPACE;
2799			stats->num_luns = softc->num_luns;
2800			break;
2801		}
2802		/*
2803		 * XXX KDM no locking here.  If the LUN list changes,
2804		 * things can blow up.
2805		 */
2806		i = 0;
2807		STAILQ_FOREACH(lun, &softc->lun_list, links) {
2808			retval = copyout(&lun->stats, &stats->lun_stats[i++],
2809					 sizeof(lun->stats));
2810			if (retval != 0)
2811				break;
2812		}
2813		stats->num_luns = softc->num_luns;
2814		stats->fill_len = sizeof(struct ctl_lun_io_stats) *
2815				 softc->num_luns;
2816		stats->status = CTL_SS_OK;
2817#ifdef CTL_TIME_IO
2818		stats->flags = CTL_STATS_FLAG_TIME_VALID;
2819#else
2820		stats->flags = CTL_STATS_FLAG_NONE;
2821#endif
2822		getnanouptime(&stats->timestamp);
2823		break;
2824	}
2825	case CTL_ERROR_INJECT: {
2826		struct ctl_error_desc *err_desc, *new_err_desc;
2827
2828		err_desc = (struct ctl_error_desc *)addr;
2829
2830		new_err_desc = malloc(sizeof(*new_err_desc), M_CTL,
2831				      M_WAITOK | M_ZERO);
2832		bcopy(err_desc, new_err_desc, sizeof(*new_err_desc));
2833
2834		mtx_lock(&softc->ctl_lock);
2835		lun = softc->ctl_luns[err_desc->lun_id];
2836		if (lun == NULL) {
2837			mtx_unlock(&softc->ctl_lock);
2838			free(new_err_desc, M_CTL);
2839			printf("%s: CTL_ERROR_INJECT: invalid LUN %ju\n",
2840			       __func__, (uintmax_t)err_desc->lun_id);
2841			retval = EINVAL;
2842			break;
2843		}
2844		mtx_lock(&lun->lun_lock);
2845		mtx_unlock(&softc->ctl_lock);
2846
2847		/*
2848		 * We could do some checking here to verify the validity
2849		 * of the request, but given the complexity of error
2850		 * injection requests, the checking logic would be fairly
2851		 * complex.
2852		 *
2853		 * For now, if the request is invalid, it just won't get
2854		 * executed and might get deleted.
2855		 */
2856		STAILQ_INSERT_TAIL(&lun->error_list, new_err_desc, links);
2857
2858		/*
2859		 * XXX KDM check to make sure the serial number is unique,
2860		 * in case we somehow manage to wrap.  That shouldn't
2861		 * happen for a very long time, but it's the right thing to
2862		 * do.
2863		 */
2864		new_err_desc->serial = lun->error_serial;
2865		err_desc->serial = lun->error_serial;
2866		lun->error_serial++;
2867
2868		mtx_unlock(&lun->lun_lock);
2869		break;
2870	}
2871	case CTL_ERROR_INJECT_DELETE: {
2872		struct ctl_error_desc *delete_desc, *desc, *desc2;
2873		int delete_done;
2874
2875		delete_desc = (struct ctl_error_desc *)addr;
2876		delete_done = 0;
2877
2878		mtx_lock(&softc->ctl_lock);
2879		lun = softc->ctl_luns[delete_desc->lun_id];
2880		if (lun == NULL) {
2881			mtx_unlock(&softc->ctl_lock);
2882			printf("%s: CTL_ERROR_INJECT_DELETE: invalid LUN %ju\n",
2883			       __func__, (uintmax_t)delete_desc->lun_id);
2884			retval = EINVAL;
2885			break;
2886		}
2887		mtx_lock(&lun->lun_lock);
2888		mtx_unlock(&softc->ctl_lock);
2889		STAILQ_FOREACH_SAFE(desc, &lun->error_list, links, desc2) {
2890			if (desc->serial != delete_desc->serial)
2891				continue;
2892
2893			STAILQ_REMOVE(&lun->error_list, desc, ctl_error_desc,
2894				      links);
2895			free(desc, M_CTL);
2896			delete_done = 1;
2897		}
2898		mtx_unlock(&lun->lun_lock);
2899		if (delete_done == 0) {
2900			printf("%s: CTL_ERROR_INJECT_DELETE: can't find "
2901			       "error serial %ju on LUN %u\n", __func__,
2902			       delete_desc->serial, delete_desc->lun_id);
2903			retval = EINVAL;
2904			break;
2905		}
2906		break;
2907	}
2908	case CTL_DUMP_STRUCTS: {
2909		int i, j, k;
2910		struct ctl_port *port;
2911		struct ctl_frontend *fe;
2912
2913		mtx_lock(&softc->ctl_lock);
2914		printf("CTL Persistent Reservation information start:\n");
2915		for (i = 0; i < CTL_MAX_LUNS; i++) {
2916			lun = softc->ctl_luns[i];
2917
2918			if ((lun == NULL)
2919			 || ((lun->flags & CTL_LUN_DISABLED) != 0))
2920				continue;
2921
2922			for (j = 0; j < CTL_MAX_PORTS; j++) {
2923				if (lun->pr_keys[j] == NULL)
2924					continue;
2925				for (k = 0; k < CTL_MAX_INIT_PER_PORT; k++){
2926					if (lun->pr_keys[j][k] == 0)
2927						continue;
2928					printf("  LUN %d port %d iid %d key "
2929					       "%#jx\n", i, j, k,
2930					       (uintmax_t)lun->pr_keys[j][k]);
2931				}
2932			}
2933		}
2934		printf("CTL Persistent Reservation information end\n");
2935		printf("CTL Ports:\n");
2936		STAILQ_FOREACH(port, &softc->port_list, links) {
2937			printf("  Port %d '%s' Frontend '%s' Type %u pp %d vp %d WWNN "
2938			       "%#jx WWPN %#jx\n", port->targ_port, port->port_name,
2939			       port->frontend->name, port->port_type,
2940			       port->physical_port, port->virtual_port,
2941			       (uintmax_t)port->wwnn, (uintmax_t)port->wwpn);
2942			for (j = 0; j < CTL_MAX_INIT_PER_PORT; j++) {
2943				if (port->wwpn_iid[j].in_use == 0 &&
2944				    port->wwpn_iid[j].wwpn == 0 &&
2945				    port->wwpn_iid[j].name == NULL)
2946					continue;
2947
2948				printf("    iid %u use %d WWPN %#jx '%s'\n",
2949				    j, port->wwpn_iid[j].in_use,
2950				    (uintmax_t)port->wwpn_iid[j].wwpn,
2951				    port->wwpn_iid[j].name);
2952			}
2953		}
2954		printf("CTL Port information end\n");
2955		mtx_unlock(&softc->ctl_lock);
2956		/*
2957		 * XXX KDM calling this without a lock.  We'd likely want
2958		 * to drop the lock before calling the frontend's dump
2959		 * routine anyway.
2960		 */
2961		printf("CTL Frontends:\n");
2962		STAILQ_FOREACH(fe, &softc->fe_list, links) {
2963			printf("  Frontend '%s'\n", fe->name);
2964			if (fe->fe_dump != NULL)
2965				fe->fe_dump();
2966		}
2967		printf("CTL Frontend information end\n");
2968		break;
2969	}
2970	case CTL_LUN_REQ: {
2971		struct ctl_lun_req *lun_req;
2972		struct ctl_backend_driver *backend;
2973
2974		lun_req = (struct ctl_lun_req *)addr;
2975
2976		backend = ctl_backend_find(lun_req->backend);
2977		if (backend == NULL) {
2978			lun_req->status = CTL_LUN_ERROR;
2979			snprintf(lun_req->error_str,
2980				 sizeof(lun_req->error_str),
2981				 "Backend \"%s\" not found.",
2982				 lun_req->backend);
2983			break;
2984		}
2985		if (lun_req->num_be_args > 0) {
2986			lun_req->kern_be_args = ctl_copyin_args(
2987				lun_req->num_be_args,
2988				lun_req->be_args,
2989				lun_req->error_str,
2990				sizeof(lun_req->error_str));
2991			if (lun_req->kern_be_args == NULL) {
2992				lun_req->status = CTL_LUN_ERROR;
2993				break;
2994			}
2995		}
2996
2997		retval = backend->ioctl(dev, cmd, addr, flag, td);
2998
2999		if (lun_req->num_be_args > 0) {
3000			ctl_copyout_args(lun_req->num_be_args,
3001				      lun_req->kern_be_args);
3002			ctl_free_args(lun_req->num_be_args,
3003				      lun_req->kern_be_args);
3004		}
3005		break;
3006	}
3007	case CTL_LUN_LIST: {
3008		struct sbuf *sb;
3009		struct ctl_lun_list *list;
3010		struct ctl_option *opt;
3011
3012		list = (struct ctl_lun_list *)addr;
3013
3014		/*
3015		 * Allocate a fixed length sbuf here, based on the length
3016		 * of the user's buffer.  We could allocate an auto-extending
3017		 * buffer, and then tell the user how much larger our
3018		 * amount of data is than his buffer, but that presents
3019		 * some problems:
3020		 *
3021		 * 1.  The sbuf(9) routines use a blocking malloc, and so
3022		 *     we can't hold a lock while calling them with an
3023		 *     auto-extending buffer.
3024 		 *
3025		 * 2.  There is not currently a LUN reference counting
3026		 *     mechanism, outside of outstanding transactions on
3027		 *     the LUN's OOA queue.  So a LUN could go away on us
3028		 *     while we're getting the LUN number, backend-specific
3029		 *     information, etc.  Thus, given the way things
3030		 *     currently work, we need to hold the CTL lock while
3031		 *     grabbing LUN information.
3032		 *
3033		 * So, from the user's standpoint, the best thing to do is
3034		 * allocate what he thinks is a reasonable buffer length,
3035		 * and then if he gets a CTL_LUN_LIST_NEED_MORE_SPACE error,
3036		 * double the buffer length and try again.  (And repeat
3037		 * that until he succeeds.)
3038		 */
3039		sb = sbuf_new(NULL, NULL, list->alloc_len, SBUF_FIXEDLEN);
3040		if (sb == NULL) {
3041			list->status = CTL_LUN_LIST_ERROR;
3042			snprintf(list->error_str, sizeof(list->error_str),
3043				 "Unable to allocate %d bytes for LUN list",
3044				 list->alloc_len);
3045			break;
3046		}
3047
3048		sbuf_printf(sb, "<ctllunlist>\n");
3049
3050		mtx_lock(&softc->ctl_lock);
3051		STAILQ_FOREACH(lun, &softc->lun_list, links) {
3052			mtx_lock(&lun->lun_lock);
3053			retval = sbuf_printf(sb, "<lun id=\"%ju\">\n",
3054					     (uintmax_t)lun->lun);
3055
3056			/*
3057			 * Bail out as soon as we see that we've overfilled
3058			 * the buffer.
3059			 */
3060			if (retval != 0)
3061				break;
3062
3063			retval = sbuf_printf(sb, "\t<backend_type>%s"
3064					     "</backend_type>\n",
3065					     (lun->backend == NULL) ?  "none" :
3066					     lun->backend->name);
3067
3068			if (retval != 0)
3069				break;
3070
3071			retval = sbuf_printf(sb, "\t<lun_type>%d</lun_type>\n",
3072					     lun->be_lun->lun_type);
3073
3074			if (retval != 0)
3075				break;
3076
3077			if (lun->backend == NULL) {
3078				retval = sbuf_printf(sb, "</lun>\n");
3079				if (retval != 0)
3080					break;
3081				continue;
3082			}
3083
3084			retval = sbuf_printf(sb, "\t<size>%ju</size>\n",
3085					     (lun->be_lun->maxlba > 0) ?
3086					     lun->be_lun->maxlba + 1 : 0);
3087
3088			if (retval != 0)
3089				break;
3090
3091			retval = sbuf_printf(sb, "\t<blocksize>%u</blocksize>\n",
3092					     lun->be_lun->blocksize);
3093
3094			if (retval != 0)
3095				break;
3096
3097			retval = sbuf_printf(sb, "\t<serial_number>");
3098
3099			if (retval != 0)
3100				break;
3101
3102			retval = ctl_sbuf_printf_esc(sb,
3103			    lun->be_lun->serial_num,
3104			    sizeof(lun->be_lun->serial_num));
3105
3106			if (retval != 0)
3107				break;
3108
3109			retval = sbuf_printf(sb, "</serial_number>\n");
3110
3111			if (retval != 0)
3112				break;
3113
3114			retval = sbuf_printf(sb, "\t<device_id>");
3115
3116			if (retval != 0)
3117				break;
3118
3119			retval = ctl_sbuf_printf_esc(sb,
3120			    lun->be_lun->device_id,
3121			    sizeof(lun->be_lun->device_id));
3122
3123			if (retval != 0)
3124				break;
3125
3126			retval = sbuf_printf(sb, "</device_id>\n");
3127
3128			if (retval != 0)
3129				break;
3130
3131			if (lun->backend->lun_info != NULL) {
3132				retval = lun->backend->lun_info(lun->be_lun->be_lun, sb);
3133				if (retval != 0)
3134					break;
3135			}
3136			STAILQ_FOREACH(opt, &lun->be_lun->options, links) {
3137				retval = sbuf_printf(sb, "\t<%s>%s</%s>\n",
3138				    opt->name, opt->value, opt->name);
3139				if (retval != 0)
3140					break;
3141			}
3142
3143			retval = sbuf_printf(sb, "</lun>\n");
3144
3145			if (retval != 0)
3146				break;
3147			mtx_unlock(&lun->lun_lock);
3148		}
3149		if (lun != NULL)
3150			mtx_unlock(&lun->lun_lock);
3151		mtx_unlock(&softc->ctl_lock);
3152
3153		if ((retval != 0)
3154		 || ((retval = sbuf_printf(sb, "</ctllunlist>\n")) != 0)) {
3155			retval = 0;
3156			sbuf_delete(sb);
3157			list->status = CTL_LUN_LIST_NEED_MORE_SPACE;
3158			snprintf(list->error_str, sizeof(list->error_str),
3159				 "Out of space, %d bytes is too small",
3160				 list->alloc_len);
3161			break;
3162		}
3163
3164		sbuf_finish(sb);
3165
3166		retval = copyout(sbuf_data(sb), list->lun_xml,
3167				 sbuf_len(sb) + 1);
3168
3169		list->fill_len = sbuf_len(sb) + 1;
3170		list->status = CTL_LUN_LIST_OK;
3171		sbuf_delete(sb);
3172		break;
3173	}
3174	case CTL_ISCSI: {
3175		struct ctl_iscsi *ci;
3176		struct ctl_frontend *fe;
3177
3178		ci = (struct ctl_iscsi *)addr;
3179
3180		fe = ctl_frontend_find("iscsi");
3181		if (fe == NULL) {
3182			ci->status = CTL_ISCSI_ERROR;
3183			snprintf(ci->error_str, sizeof(ci->error_str),
3184			    "Frontend \"iscsi\" not found.");
3185			break;
3186		}
3187
3188		retval = fe->ioctl(dev, cmd, addr, flag, td);
3189		break;
3190	}
3191	case CTL_PORT_REQ: {
3192		struct ctl_req *req;
3193		struct ctl_frontend *fe;
3194
3195		req = (struct ctl_req *)addr;
3196
3197		fe = ctl_frontend_find(req->driver);
3198		if (fe == NULL) {
3199			req->status = CTL_LUN_ERROR;
3200			snprintf(req->error_str, sizeof(req->error_str),
3201			    "Frontend \"%s\" not found.", req->driver);
3202			break;
3203		}
3204		if (req->num_args > 0) {
3205			req->kern_args = ctl_copyin_args(req->num_args,
3206			    req->args, req->error_str, sizeof(req->error_str));
3207			if (req->kern_args == NULL) {
3208				req->status = CTL_LUN_ERROR;
3209				break;
3210			}
3211		}
3212
3213		if (fe->ioctl)
3214			retval = fe->ioctl(dev, cmd, addr, flag, td);
3215		else
3216			retval = ENODEV;
3217
3218		if (req->num_args > 0) {
3219			ctl_copyout_args(req->num_args, req->kern_args);
3220			ctl_free_args(req->num_args, req->kern_args);
3221		}
3222		break;
3223	}
3224	case CTL_PORT_LIST: {
3225		struct sbuf *sb;
3226		struct ctl_port *port;
3227		struct ctl_lun_list *list;
3228		struct ctl_option *opt;
3229		int j;
3230		uint32_t plun;
3231
3232		list = (struct ctl_lun_list *)addr;
3233
3234		sb = sbuf_new(NULL, NULL, list->alloc_len, SBUF_FIXEDLEN);
3235		if (sb == NULL) {
3236			list->status = CTL_LUN_LIST_ERROR;
3237			snprintf(list->error_str, sizeof(list->error_str),
3238				 "Unable to allocate %d bytes for LUN list",
3239				 list->alloc_len);
3240			break;
3241		}
3242
3243		sbuf_printf(sb, "<ctlportlist>\n");
3244
3245		mtx_lock(&softc->ctl_lock);
3246		STAILQ_FOREACH(port, &softc->port_list, links) {
3247			retval = sbuf_printf(sb, "<targ_port id=\"%ju\">\n",
3248					     (uintmax_t)port->targ_port);
3249
3250			/*
3251			 * Bail out as soon as we see that we've overfilled
3252			 * the buffer.
3253			 */
3254			if (retval != 0)
3255				break;
3256
3257			retval = sbuf_printf(sb, "\t<frontend_type>%s"
3258			    "</frontend_type>\n", port->frontend->name);
3259			if (retval != 0)
3260				break;
3261
3262			retval = sbuf_printf(sb, "\t<port_type>%d</port_type>\n",
3263					     port->port_type);
3264			if (retval != 0)
3265				break;
3266
3267			retval = sbuf_printf(sb, "\t<online>%s</online>\n",
3268			    (port->status & CTL_PORT_STATUS_ONLINE) ? "YES" : "NO");
3269			if (retval != 0)
3270				break;
3271
3272			retval = sbuf_printf(sb, "\t<port_name>%s</port_name>\n",
3273			    port->port_name);
3274			if (retval != 0)
3275				break;
3276
3277			retval = sbuf_printf(sb, "\t<physical_port>%d</physical_port>\n",
3278			    port->physical_port);
3279			if (retval != 0)
3280				break;
3281
3282			retval = sbuf_printf(sb, "\t<virtual_port>%d</virtual_port>\n",
3283			    port->virtual_port);
3284			if (retval != 0)
3285				break;
3286
3287			if (port->target_devid != NULL) {
3288				sbuf_printf(sb, "\t<target>");
3289				ctl_id_sbuf(port->target_devid, sb);
3290				sbuf_printf(sb, "</target>\n");
3291			}
3292
3293			if (port->port_devid != NULL) {
3294				sbuf_printf(sb, "\t<port>");
3295				ctl_id_sbuf(port->port_devid, sb);
3296				sbuf_printf(sb, "</port>\n");
3297			}
3298
3299			if (port->port_info != NULL) {
3300				retval = port->port_info(port->onoff_arg, sb);
3301				if (retval != 0)
3302					break;
3303			}
3304			STAILQ_FOREACH(opt, &port->options, links) {
3305				retval = sbuf_printf(sb, "\t<%s>%s</%s>\n",
3306				    opt->name, opt->value, opt->name);
3307				if (retval != 0)
3308					break;
3309			}
3310
3311			if (port->lun_map != NULL) {
3312				sbuf_printf(sb, "\t<lun_map>on</lun_map>\n");
3313				for (j = 0; j < CTL_MAX_LUNS; j++) {
3314					plun = ctl_lun_map_from_port(port, j);
3315					if (plun >= CTL_MAX_LUNS)
3316						continue;
3317					sbuf_printf(sb,
3318					    "\t<lun id=\"%u\">%u</lun>\n",
3319					    j, plun);
3320				}
3321			}
3322
3323			for (j = 0; j < CTL_MAX_INIT_PER_PORT; j++) {
3324				if (port->wwpn_iid[j].in_use == 0 ||
3325				    (port->wwpn_iid[j].wwpn == 0 &&
3326				     port->wwpn_iid[j].name == NULL))
3327					continue;
3328
3329				if (port->wwpn_iid[j].name != NULL)
3330					retval = sbuf_printf(sb,
3331					    "\t<initiator id=\"%u\">%s</initiator>\n",
3332					    j, port->wwpn_iid[j].name);
3333				else
3334					retval = sbuf_printf(sb,
3335					    "\t<initiator id=\"%u\">naa.%08jx</initiator>\n",
3336					    j, port->wwpn_iid[j].wwpn);
3337				if (retval != 0)
3338					break;
3339			}
3340			if (retval != 0)
3341				break;
3342
3343			retval = sbuf_printf(sb, "</targ_port>\n");
3344			if (retval != 0)
3345				break;
3346		}
3347		mtx_unlock(&softc->ctl_lock);
3348
3349		if ((retval != 0)
3350		 || ((retval = sbuf_printf(sb, "</ctlportlist>\n")) != 0)) {
3351			retval = 0;
3352			sbuf_delete(sb);
3353			list->status = CTL_LUN_LIST_NEED_MORE_SPACE;
3354			snprintf(list->error_str, sizeof(list->error_str),
3355				 "Out of space, %d bytes is too small",
3356				 list->alloc_len);
3357			break;
3358		}
3359
3360		sbuf_finish(sb);
3361
3362		retval = copyout(sbuf_data(sb), list->lun_xml,
3363				 sbuf_len(sb) + 1);
3364
3365		list->fill_len = sbuf_len(sb) + 1;
3366		list->status = CTL_LUN_LIST_OK;
3367		sbuf_delete(sb);
3368		break;
3369	}
3370	case CTL_LUN_MAP: {
3371		struct ctl_lun_map *lm  = (struct ctl_lun_map *)addr;
3372		struct ctl_port *port;
3373
3374		mtx_lock(&softc->ctl_lock);
3375		if (lm->port < softc->port_min ||
3376		    lm->port >= softc->port_max ||
3377		    (port = softc->ctl_ports[lm->port]) == NULL) {
3378			mtx_unlock(&softc->ctl_lock);
3379			return (ENXIO);
3380		}
3381		if (port->status & CTL_PORT_STATUS_ONLINE) {
3382			STAILQ_FOREACH(lun, &softc->lun_list, links) {
3383				if (ctl_lun_map_to_port(port, lun->lun) >=
3384				    CTL_MAX_LUNS)
3385					continue;
3386				mtx_lock(&lun->lun_lock);
3387				ctl_est_ua_port(lun, lm->port, -1,
3388				    CTL_UA_LUN_CHANGE);
3389				mtx_unlock(&lun->lun_lock);
3390			}
3391		}
3392		mtx_unlock(&softc->ctl_lock); // XXX: port_enable sleeps
3393		if (lm->plun < CTL_MAX_LUNS) {
3394			if (lm->lun == UINT32_MAX)
3395				retval = ctl_lun_map_unset(port, lm->plun);
3396			else if (lm->lun < CTL_MAX_LUNS &&
3397			    softc->ctl_luns[lm->lun] != NULL)
3398				retval = ctl_lun_map_set(port, lm->plun, lm->lun);
3399			else
3400				return (ENXIO);
3401		} else if (lm->plun == UINT32_MAX) {
3402			if (lm->lun == UINT32_MAX)
3403				retval = ctl_lun_map_deinit(port);
3404			else
3405				retval = ctl_lun_map_init(port);
3406		} else
3407			return (ENXIO);
3408		if (port->status & CTL_PORT_STATUS_ONLINE)
3409			ctl_isc_announce_port(port);
3410		break;
3411	}
3412	default: {
3413		/* XXX KDM should we fix this? */
3414#if 0
3415		struct ctl_backend_driver *backend;
3416		unsigned int type;
3417		int found;
3418
3419		found = 0;
3420
3421		/*
3422		 * We encode the backend type as the ioctl type for backend
3423		 * ioctls.  So parse it out here, and then search for a
3424		 * backend of this type.
3425		 */
3426		type = _IOC_TYPE(cmd);
3427
3428		STAILQ_FOREACH(backend, &softc->be_list, links) {
3429			if (backend->type == type) {
3430				found = 1;
3431				break;
3432			}
3433		}
3434		if (found == 0) {
3435			printf("ctl: unknown ioctl command %#lx or backend "
3436			       "%d\n", cmd, type);
3437			retval = EINVAL;
3438			break;
3439		}
3440		retval = backend->ioctl(dev, cmd, addr, flag, td);
3441#endif
3442		retval = ENOTTY;
3443		break;
3444	}
3445	}
3446	return (retval);
3447}
3448
3449uint32_t
3450ctl_get_initindex(struct ctl_nexus *nexus)
3451{
3452	return (nexus->initid + (nexus->targ_port * CTL_MAX_INIT_PER_PORT));
3453}
3454
3455int
3456ctl_lun_map_init(struct ctl_port *port)
3457{
3458	struct ctl_softc *softc = port->ctl_softc;
3459	struct ctl_lun *lun;
3460	uint32_t i;
3461
3462	if (port->lun_map == NULL)
3463		port->lun_map = malloc(sizeof(uint32_t) * CTL_MAX_LUNS,
3464		    M_CTL, M_NOWAIT);
3465	if (port->lun_map == NULL)
3466		return (ENOMEM);
3467	for (i = 0; i < CTL_MAX_LUNS; i++)
3468		port->lun_map[i] = UINT32_MAX;
3469	if (port->status & CTL_PORT_STATUS_ONLINE) {
3470		if (port->lun_disable != NULL) {
3471			STAILQ_FOREACH(lun, &softc->lun_list, links)
3472				port->lun_disable(port->targ_lun_arg, lun->lun);
3473		}
3474		ctl_isc_announce_port(port);
3475	}
3476	return (0);
3477}
3478
3479int
3480ctl_lun_map_deinit(struct ctl_port *port)
3481{
3482	struct ctl_softc *softc = port->ctl_softc;
3483	struct ctl_lun *lun;
3484
3485	if (port->lun_map == NULL)
3486		return (0);
3487	free(port->lun_map, M_CTL);
3488	port->lun_map = NULL;
3489	if (port->status & CTL_PORT_STATUS_ONLINE) {
3490		if (port->lun_enable != NULL) {
3491			STAILQ_FOREACH(lun, &softc->lun_list, links)
3492				port->lun_enable(port->targ_lun_arg, lun->lun);
3493		}
3494		ctl_isc_announce_port(port);
3495	}
3496	return (0);
3497}
3498
3499int
3500ctl_lun_map_set(struct ctl_port *port, uint32_t plun, uint32_t glun)
3501{
3502	int status;
3503	uint32_t old;
3504
3505	if (port->lun_map == NULL) {
3506		status = ctl_lun_map_init(port);
3507		if (status != 0)
3508			return (status);
3509	}
3510	old = port->lun_map[plun];
3511	port->lun_map[plun] = glun;
3512	if ((port->status & CTL_PORT_STATUS_ONLINE) && old >= CTL_MAX_LUNS) {
3513		if (port->lun_enable != NULL)
3514			port->lun_enable(port->targ_lun_arg, plun);
3515		ctl_isc_announce_port(port);
3516	}
3517	return (0);
3518}
3519
3520int
3521ctl_lun_map_unset(struct ctl_port *port, uint32_t plun)
3522{
3523	uint32_t old;
3524
3525	if (port->lun_map == NULL)
3526		return (0);
3527	old = port->lun_map[plun];
3528	port->lun_map[plun] = UINT32_MAX;
3529	if ((port->status & CTL_PORT_STATUS_ONLINE) && old < CTL_MAX_LUNS) {
3530		if (port->lun_disable != NULL)
3531			port->lun_disable(port->targ_lun_arg, plun);
3532		ctl_isc_announce_port(port);
3533	}
3534	return (0);
3535}
3536
3537uint32_t
3538ctl_lun_map_from_port(struct ctl_port *port, uint32_t lun_id)
3539{
3540
3541	if (port == NULL)
3542		return (UINT32_MAX);
3543	if (port->lun_map == NULL || lun_id >= CTL_MAX_LUNS)
3544		return (lun_id);
3545	return (port->lun_map[lun_id]);
3546}
3547
3548uint32_t
3549ctl_lun_map_to_port(struct ctl_port *port, uint32_t lun_id)
3550{
3551	uint32_t i;
3552
3553	if (port == NULL)
3554		return (UINT32_MAX);
3555	if (port->lun_map == NULL)
3556		return (lun_id);
3557	for (i = 0; i < CTL_MAX_LUNS; i++) {
3558		if (port->lun_map[i] == lun_id)
3559			return (i);
3560	}
3561	return (UINT32_MAX);
3562}
3563
3564uint32_t
3565ctl_decode_lun(uint64_t encoded)
3566{
3567	uint8_t lun[8];
3568	uint32_t result = 0xffffffff;
3569
3570	be64enc(lun, encoded);
3571	switch (lun[0] & RPL_LUNDATA_ATYP_MASK) {
3572	case RPL_LUNDATA_ATYP_PERIPH:
3573		if ((lun[0] & 0x3f) == 0 && lun[2] == 0 && lun[3] == 0 &&
3574		    lun[4] == 0 && lun[5] == 0 && lun[6] == 0 && lun[7] == 0)
3575			result = lun[1];
3576		break;
3577	case RPL_LUNDATA_ATYP_FLAT:
3578		if (lun[2] == 0 && lun[3] == 0 && lun[4] == 0 && lun[5] == 0 &&
3579		    lun[6] == 0 && lun[7] == 0)
3580			result = ((lun[0] & 0x3f) << 8) + lun[1];
3581		break;
3582	case RPL_LUNDATA_ATYP_EXTLUN:
3583		switch (lun[0] & RPL_LUNDATA_EXT_EAM_MASK) {
3584		case 0x02:
3585			switch (lun[0] & RPL_LUNDATA_EXT_LEN_MASK) {
3586			case 0x00:
3587				result = lun[1];
3588				break;
3589			case 0x10:
3590				result = (lun[1] << 16) + (lun[2] << 8) +
3591				    lun[3];
3592				break;
3593			case 0x20:
3594				if (lun[1] == 0 && lun[6] == 0 && lun[7] == 0)
3595					result = (lun[2] << 24) +
3596					    (lun[3] << 16) + (lun[4] << 8) +
3597					    lun[5];
3598				break;
3599			}
3600			break;
3601		case RPL_LUNDATA_EXT_EAM_NOT_SPEC:
3602			result = 0xffffffff;
3603			break;
3604		}
3605		break;
3606	}
3607	return (result);
3608}
3609
3610uint64_t
3611ctl_encode_lun(uint32_t decoded)
3612{
3613	uint64_t l = decoded;
3614
3615	if (l <= 0xff)
3616		return (((uint64_t)RPL_LUNDATA_ATYP_PERIPH << 56) | (l << 48));
3617	if (l <= 0x3fff)
3618		return (((uint64_t)RPL_LUNDATA_ATYP_FLAT << 56) | (l << 48));
3619	if (l <= 0xffffff)
3620		return (((uint64_t)(RPL_LUNDATA_ATYP_EXTLUN | 0x12) << 56) |
3621		    (l << 32));
3622	return ((((uint64_t)RPL_LUNDATA_ATYP_EXTLUN | 0x22) << 56) | (l << 16));
3623}
3624
3625static struct ctl_port *
3626ctl_io_port(struct ctl_io_hdr *io_hdr)
3627{
3628
3629	return (control_softc->ctl_ports[io_hdr->nexus.targ_port]);
3630}
3631
3632int
3633ctl_ffz(uint32_t *mask, uint32_t first, uint32_t last)
3634{
3635	int i;
3636
3637	for (i = first; i < last; i++) {
3638		if ((mask[i / 32] & (1 << (i % 32))) == 0)
3639			return (i);
3640	}
3641	return (-1);
3642}
3643
3644int
3645ctl_set_mask(uint32_t *mask, uint32_t bit)
3646{
3647	uint32_t chunk, piece;
3648
3649	chunk = bit >> 5;
3650	piece = bit % (sizeof(uint32_t) * 8);
3651
3652	if ((mask[chunk] & (1 << piece)) != 0)
3653		return (-1);
3654	else
3655		mask[chunk] |= (1 << piece);
3656
3657	return (0);
3658}
3659
3660int
3661ctl_clear_mask(uint32_t *mask, uint32_t bit)
3662{
3663	uint32_t chunk, piece;
3664
3665	chunk = bit >> 5;
3666	piece = bit % (sizeof(uint32_t) * 8);
3667
3668	if ((mask[chunk] & (1 << piece)) == 0)
3669		return (-1);
3670	else
3671		mask[chunk] &= ~(1 << piece);
3672
3673	return (0);
3674}
3675
3676int
3677ctl_is_set(uint32_t *mask, uint32_t bit)
3678{
3679	uint32_t chunk, piece;
3680
3681	chunk = bit >> 5;
3682	piece = bit % (sizeof(uint32_t) * 8);
3683
3684	if ((mask[chunk] & (1 << piece)) == 0)
3685		return (0);
3686	else
3687		return (1);
3688}
3689
3690static uint64_t
3691ctl_get_prkey(struct ctl_lun *lun, uint32_t residx)
3692{
3693	uint64_t *t;
3694
3695	t = lun->pr_keys[residx/CTL_MAX_INIT_PER_PORT];
3696	if (t == NULL)
3697		return (0);
3698	return (t[residx % CTL_MAX_INIT_PER_PORT]);
3699}
3700
3701static void
3702ctl_clr_prkey(struct ctl_lun *lun, uint32_t residx)
3703{
3704	uint64_t *t;
3705
3706	t = lun->pr_keys[residx/CTL_MAX_INIT_PER_PORT];
3707	if (t == NULL)
3708		return;
3709	t[residx % CTL_MAX_INIT_PER_PORT] = 0;
3710}
3711
3712static void
3713ctl_alloc_prkey(struct ctl_lun *lun, uint32_t residx)
3714{
3715	uint64_t *p;
3716	u_int i;
3717
3718	i = residx/CTL_MAX_INIT_PER_PORT;
3719	if (lun->pr_keys[i] != NULL)
3720		return;
3721	mtx_unlock(&lun->lun_lock);
3722	p = malloc(sizeof(uint64_t) * CTL_MAX_INIT_PER_PORT, M_CTL,
3723	    M_WAITOK | M_ZERO);
3724	mtx_lock(&lun->lun_lock);
3725	if (lun->pr_keys[i] == NULL)
3726		lun->pr_keys[i] = p;
3727	else
3728		free(p, M_CTL);
3729}
3730
3731static void
3732ctl_set_prkey(struct ctl_lun *lun, uint32_t residx, uint64_t key)
3733{
3734	uint64_t *t;
3735
3736	t = lun->pr_keys[residx/CTL_MAX_INIT_PER_PORT];
3737	KASSERT(t != NULL, ("prkey %d is not allocated", residx));
3738	t[residx % CTL_MAX_INIT_PER_PORT] = key;
3739}
3740
3741/*
3742 * ctl_softc, pool_name, total_ctl_io are passed in.
3743 * npool is passed out.
3744 */
3745int
3746ctl_pool_create(struct ctl_softc *ctl_softc, const char *pool_name,
3747		uint32_t total_ctl_io, void **npool)
3748{
3749#ifdef IO_POOLS
3750	struct ctl_io_pool *pool;
3751
3752	pool = (struct ctl_io_pool *)malloc(sizeof(*pool), M_CTL,
3753					    M_NOWAIT | M_ZERO);
3754	if (pool == NULL)
3755		return (ENOMEM);
3756
3757	snprintf(pool->name, sizeof(pool->name), "CTL IO %s", pool_name);
3758	pool->ctl_softc = ctl_softc;
3759	pool->zone = uma_zsecond_create(pool->name, NULL,
3760	    NULL, NULL, NULL, ctl_softc->io_zone);
3761	/* uma_prealloc(pool->zone, total_ctl_io); */
3762
3763	*npool = pool;
3764#else
3765	*npool = ctl_softc->io_zone;
3766#endif
3767	return (0);
3768}
3769
3770void
3771ctl_pool_free(struct ctl_io_pool *pool)
3772{
3773
3774	if (pool == NULL)
3775		return;
3776
3777#ifdef IO_POOLS
3778	uma_zdestroy(pool->zone);
3779	free(pool, M_CTL);
3780#endif
3781}
3782
3783union ctl_io *
3784ctl_alloc_io(void *pool_ref)
3785{
3786	union ctl_io *io;
3787#ifdef IO_POOLS
3788	struct ctl_io_pool *pool = (struct ctl_io_pool *)pool_ref;
3789
3790	io = uma_zalloc(pool->zone, M_WAITOK);
3791#else
3792	io = uma_zalloc((uma_zone_t)pool_ref, M_WAITOK);
3793#endif
3794	if (io != NULL)
3795		io->io_hdr.pool = pool_ref;
3796	return (io);
3797}
3798
3799union ctl_io *
3800ctl_alloc_io_nowait(void *pool_ref)
3801{
3802	union ctl_io *io;
3803#ifdef IO_POOLS
3804	struct ctl_io_pool *pool = (struct ctl_io_pool *)pool_ref;
3805
3806	io = uma_zalloc(pool->zone, M_NOWAIT);
3807#else
3808	io = uma_zalloc((uma_zone_t)pool_ref, M_NOWAIT);
3809#endif
3810	if (io != NULL)
3811		io->io_hdr.pool = pool_ref;
3812	return (io);
3813}
3814
3815void
3816ctl_free_io(union ctl_io *io)
3817{
3818#ifdef IO_POOLS
3819	struct ctl_io_pool *pool;
3820#endif
3821
3822	if (io == NULL)
3823		return;
3824
3825#ifdef IO_POOLS
3826	pool = (struct ctl_io_pool *)io->io_hdr.pool;
3827	uma_zfree(pool->zone, io);
3828#else
3829	uma_zfree((uma_zone_t)io->io_hdr.pool, io);
3830#endif
3831}
3832
3833void
3834ctl_zero_io(union ctl_io *io)
3835{
3836	void *pool_ref;
3837
3838	if (io == NULL)
3839		return;
3840
3841	/*
3842	 * May need to preserve linked list pointers at some point too.
3843	 */
3844	pool_ref = io->io_hdr.pool;
3845	memset(io, 0, sizeof(*io));
3846	io->io_hdr.pool = pool_ref;
3847}
3848
3849int
3850ctl_expand_number(const char *buf, uint64_t *num)
3851{
3852	char *endptr;
3853	uint64_t number;
3854	unsigned shift;
3855
3856	number = strtoq(buf, &endptr, 0);
3857
3858	switch (tolower((unsigned char)*endptr)) {
3859	case 'e':
3860		shift = 60;
3861		break;
3862	case 'p':
3863		shift = 50;
3864		break;
3865	case 't':
3866		shift = 40;
3867		break;
3868	case 'g':
3869		shift = 30;
3870		break;
3871	case 'm':
3872		shift = 20;
3873		break;
3874	case 'k':
3875		shift = 10;
3876		break;
3877	case 'b':
3878	case '\0': /* No unit. */
3879		*num = number;
3880		return (0);
3881	default:
3882		/* Unrecognized unit. */
3883		return (-1);
3884	}
3885
3886	if ((number << shift) >> shift != number) {
3887		/* Overflow */
3888		return (-1);
3889	}
3890	*num = number << shift;
3891	return (0);
3892}
3893
3894
3895/*
3896 * This routine could be used in the future to load default and/or saved
3897 * mode page parameters for a particuar lun.
3898 */
3899static int
3900ctl_init_page_index(struct ctl_lun *lun)
3901{
3902	int i, page_code;
3903	struct ctl_page_index *page_index;
3904	const char *value;
3905	uint64_t ival;
3906
3907	memcpy(&lun->mode_pages.index, page_index_template,
3908	       sizeof(page_index_template));
3909
3910	for (i = 0; i < CTL_NUM_MODE_PAGES; i++) {
3911
3912		page_index = &lun->mode_pages.index[i];
3913		if (lun->be_lun->lun_type == T_DIRECT &&
3914		    (page_index->page_flags & CTL_PAGE_FLAG_DIRECT) == 0)
3915			continue;
3916		if (lun->be_lun->lun_type == T_PROCESSOR &&
3917		    (page_index->page_flags & CTL_PAGE_FLAG_PROC) == 0)
3918			continue;
3919		if (lun->be_lun->lun_type == T_CDROM &&
3920		    (page_index->page_flags & CTL_PAGE_FLAG_CDROM) == 0)
3921			continue;
3922
3923		page_code = page_index->page_code & SMPH_PC_MASK;
3924		switch (page_code) {
3925		case SMS_RW_ERROR_RECOVERY_PAGE: {
3926			KASSERT(page_index->subpage == SMS_SUBPAGE_PAGE_0,
3927			    ("subpage %#x for page %#x is incorrect!",
3928			    page_index->subpage, page_code));
3929			memcpy(&lun->mode_pages.rw_er_page[CTL_PAGE_CURRENT],
3930			       &rw_er_page_default,
3931			       sizeof(rw_er_page_default));
3932			memcpy(&lun->mode_pages.rw_er_page[CTL_PAGE_CHANGEABLE],
3933			       &rw_er_page_changeable,
3934			       sizeof(rw_er_page_changeable));
3935			memcpy(&lun->mode_pages.rw_er_page[CTL_PAGE_DEFAULT],
3936			       &rw_er_page_default,
3937			       sizeof(rw_er_page_default));
3938			memcpy(&lun->mode_pages.rw_er_page[CTL_PAGE_SAVED],
3939			       &rw_er_page_default,
3940			       sizeof(rw_er_page_default));
3941			page_index->page_data =
3942				(uint8_t *)lun->mode_pages.rw_er_page;
3943			break;
3944		}
3945		case SMS_FORMAT_DEVICE_PAGE: {
3946			struct scsi_format_page *format_page;
3947
3948			KASSERT(page_index->subpage == SMS_SUBPAGE_PAGE_0,
3949			    ("subpage %#x for page %#x is incorrect!",
3950			    page_index->subpage, page_code));
3951
3952			/*
3953			 * Sectors per track are set above.  Bytes per
3954			 * sector need to be set here on a per-LUN basis.
3955			 */
3956			memcpy(&lun->mode_pages.format_page[CTL_PAGE_CURRENT],
3957			       &format_page_default,
3958			       sizeof(format_page_default));
3959			memcpy(&lun->mode_pages.format_page[
3960			       CTL_PAGE_CHANGEABLE], &format_page_changeable,
3961			       sizeof(format_page_changeable));
3962			memcpy(&lun->mode_pages.format_page[CTL_PAGE_DEFAULT],
3963			       &format_page_default,
3964			       sizeof(format_page_default));
3965			memcpy(&lun->mode_pages.format_page[CTL_PAGE_SAVED],
3966			       &format_page_default,
3967			       sizeof(format_page_default));
3968
3969			format_page = &lun->mode_pages.format_page[
3970				CTL_PAGE_CURRENT];
3971			scsi_ulto2b(lun->be_lun->blocksize,
3972				    format_page->bytes_per_sector);
3973
3974			format_page = &lun->mode_pages.format_page[
3975				CTL_PAGE_DEFAULT];
3976			scsi_ulto2b(lun->be_lun->blocksize,
3977				    format_page->bytes_per_sector);
3978
3979			format_page = &lun->mode_pages.format_page[
3980				CTL_PAGE_SAVED];
3981			scsi_ulto2b(lun->be_lun->blocksize,
3982				    format_page->bytes_per_sector);
3983
3984			page_index->page_data =
3985				(uint8_t *)lun->mode_pages.format_page;
3986			break;
3987		}
3988		case SMS_RIGID_DISK_PAGE: {
3989			struct scsi_rigid_disk_page *rigid_disk_page;
3990			uint32_t sectors_per_cylinder;
3991			uint64_t cylinders;
3992#ifndef	__XSCALE__
3993			int shift;
3994#endif /* !__XSCALE__ */
3995
3996			KASSERT(page_index->subpage == SMS_SUBPAGE_PAGE_0,
3997			    ("subpage %#x for page %#x is incorrect!",
3998			    page_index->subpage, page_code));
3999
4000			/*
4001			 * Rotation rate and sectors per track are set
4002			 * above.  We calculate the cylinders here based on
4003			 * capacity.  Due to the number of heads and
4004			 * sectors per track we're using, smaller arrays
4005			 * may turn out to have 0 cylinders.  Linux and
4006			 * FreeBSD don't pay attention to these mode pages
4007			 * to figure out capacity, but Solaris does.  It
4008			 * seems to deal with 0 cylinders just fine, and
4009			 * works out a fake geometry based on the capacity.
4010			 */
4011			memcpy(&lun->mode_pages.rigid_disk_page[
4012			       CTL_PAGE_DEFAULT], &rigid_disk_page_default,
4013			       sizeof(rigid_disk_page_default));
4014			memcpy(&lun->mode_pages.rigid_disk_page[
4015			       CTL_PAGE_CHANGEABLE],&rigid_disk_page_changeable,
4016			       sizeof(rigid_disk_page_changeable));
4017
4018			sectors_per_cylinder = CTL_DEFAULT_SECTORS_PER_TRACK *
4019				CTL_DEFAULT_HEADS;
4020
4021			/*
4022			 * The divide method here will be more accurate,
4023			 * probably, but results in floating point being
4024			 * used in the kernel on i386 (__udivdi3()).  On the
4025			 * XScale, though, __udivdi3() is implemented in
4026			 * software.
4027			 *
4028			 * The shift method for cylinder calculation is
4029			 * accurate if sectors_per_cylinder is a power of
4030			 * 2.  Otherwise it might be slightly off -- you
4031			 * might have a bit of a truncation problem.
4032			 */
4033#ifdef	__XSCALE__
4034			cylinders = (lun->be_lun->maxlba + 1) /
4035				sectors_per_cylinder;
4036#else
4037			for (shift = 31; shift > 0; shift--) {
4038				if (sectors_per_cylinder & (1 << shift))
4039					break;
4040			}
4041			cylinders = (lun->be_lun->maxlba + 1) >> shift;
4042#endif
4043
4044			/*
4045			 * We've basically got 3 bytes, or 24 bits for the
4046			 * cylinder size in the mode page.  If we're over,
4047			 * just round down to 2^24.
4048			 */
4049			if (cylinders > 0xffffff)
4050				cylinders = 0xffffff;
4051
4052			rigid_disk_page = &lun->mode_pages.rigid_disk_page[
4053				CTL_PAGE_DEFAULT];
4054			scsi_ulto3b(cylinders, rigid_disk_page->cylinders);
4055
4056			if ((value = ctl_get_opt(&lun->be_lun->options,
4057			    "rpm")) != NULL) {
4058				scsi_ulto2b(strtol(value, NULL, 0),
4059				     rigid_disk_page->rotation_rate);
4060			}
4061
4062			memcpy(&lun->mode_pages.rigid_disk_page[CTL_PAGE_CURRENT],
4063			       &lun->mode_pages.rigid_disk_page[CTL_PAGE_DEFAULT],
4064			       sizeof(rigid_disk_page_default));
4065			memcpy(&lun->mode_pages.rigid_disk_page[CTL_PAGE_SAVED],
4066			       &lun->mode_pages.rigid_disk_page[CTL_PAGE_DEFAULT],
4067			       sizeof(rigid_disk_page_default));
4068
4069			page_index->page_data =
4070				(uint8_t *)lun->mode_pages.rigid_disk_page;
4071			break;
4072		}
4073		case SMS_VERIFY_ERROR_RECOVERY_PAGE: {
4074			KASSERT(page_index->subpage == SMS_SUBPAGE_PAGE_0,
4075			    ("subpage %#x for page %#x is incorrect!",
4076			    page_index->subpage, page_code));
4077			memcpy(&lun->mode_pages.verify_er_page[CTL_PAGE_CURRENT],
4078			       &verify_er_page_default,
4079			       sizeof(verify_er_page_default));
4080			memcpy(&lun->mode_pages.verify_er_page[CTL_PAGE_CHANGEABLE],
4081			       &verify_er_page_changeable,
4082			       sizeof(verify_er_page_changeable));
4083			memcpy(&lun->mode_pages.verify_er_page[CTL_PAGE_DEFAULT],
4084			       &verify_er_page_default,
4085			       sizeof(verify_er_page_default));
4086			memcpy(&lun->mode_pages.verify_er_page[CTL_PAGE_SAVED],
4087			       &verify_er_page_default,
4088			       sizeof(verify_er_page_default));
4089			page_index->page_data =
4090				(uint8_t *)lun->mode_pages.verify_er_page;
4091			break;
4092		}
4093		case SMS_CACHING_PAGE: {
4094			struct scsi_caching_page *caching_page;
4095
4096			KASSERT(page_index->subpage == SMS_SUBPAGE_PAGE_0,
4097			    ("subpage %#x for page %#x is incorrect!",
4098			    page_index->subpage, page_code));
4099			memcpy(&lun->mode_pages.caching_page[CTL_PAGE_DEFAULT],
4100			       &caching_page_default,
4101			       sizeof(caching_page_default));
4102			memcpy(&lun->mode_pages.caching_page[
4103			       CTL_PAGE_CHANGEABLE], &caching_page_changeable,
4104			       sizeof(caching_page_changeable));
4105			memcpy(&lun->mode_pages.caching_page[CTL_PAGE_SAVED],
4106			       &caching_page_default,
4107			       sizeof(caching_page_default));
4108			caching_page = &lun->mode_pages.caching_page[
4109			    CTL_PAGE_SAVED];
4110			value = ctl_get_opt(&lun->be_lun->options, "writecache");
4111			if (value != NULL && strcmp(value, "off") == 0)
4112				caching_page->flags1 &= ~SCP_WCE;
4113			value = ctl_get_opt(&lun->be_lun->options, "readcache");
4114			if (value != NULL && strcmp(value, "off") == 0)
4115				caching_page->flags1 |= SCP_RCD;
4116			memcpy(&lun->mode_pages.caching_page[CTL_PAGE_CURRENT],
4117			       &lun->mode_pages.caching_page[CTL_PAGE_SAVED],
4118			       sizeof(caching_page_default));
4119			page_index->page_data =
4120				(uint8_t *)lun->mode_pages.caching_page;
4121			break;
4122		}
4123		case SMS_CONTROL_MODE_PAGE: {
4124			switch (page_index->subpage) {
4125			case SMS_SUBPAGE_PAGE_0: {
4126				struct scsi_control_page *control_page;
4127
4128				memcpy(&lun->mode_pages.control_page[
4129				    CTL_PAGE_DEFAULT],
4130				       &control_page_default,
4131				       sizeof(control_page_default));
4132				memcpy(&lun->mode_pages.control_page[
4133				    CTL_PAGE_CHANGEABLE],
4134				       &control_page_changeable,
4135				       sizeof(control_page_changeable));
4136				memcpy(&lun->mode_pages.control_page[
4137				    CTL_PAGE_SAVED],
4138				       &control_page_default,
4139				       sizeof(control_page_default));
4140				control_page = &lun->mode_pages.control_page[
4141				    CTL_PAGE_SAVED];
4142				value = ctl_get_opt(&lun->be_lun->options,
4143				    "reordering");
4144				if (value != NULL &&
4145				    strcmp(value, "unrestricted") == 0) {
4146					control_page->queue_flags &=
4147					    ~SCP_QUEUE_ALG_MASK;
4148					control_page->queue_flags |=
4149					    SCP_QUEUE_ALG_UNRESTRICTED;
4150				}
4151				memcpy(&lun->mode_pages.control_page[
4152				    CTL_PAGE_CURRENT],
4153				       &lun->mode_pages.control_page[
4154				    CTL_PAGE_SAVED],
4155				       sizeof(control_page_default));
4156				page_index->page_data =
4157				    (uint8_t *)lun->mode_pages.control_page;
4158				break;
4159			}
4160			case 0x01:
4161				memcpy(&lun->mode_pages.control_ext_page[
4162				    CTL_PAGE_DEFAULT],
4163				       &control_ext_page_default,
4164				       sizeof(control_ext_page_default));
4165				memcpy(&lun->mode_pages.control_ext_page[
4166				    CTL_PAGE_CHANGEABLE],
4167				       &control_ext_page_changeable,
4168				       sizeof(control_ext_page_changeable));
4169				memcpy(&lun->mode_pages.control_ext_page[
4170				    CTL_PAGE_SAVED],
4171				       &control_ext_page_default,
4172				       sizeof(control_ext_page_default));
4173				memcpy(&lun->mode_pages.control_ext_page[
4174				    CTL_PAGE_CURRENT],
4175				       &lun->mode_pages.control_ext_page[
4176				    CTL_PAGE_SAVED],
4177				       sizeof(control_ext_page_default));
4178				page_index->page_data =
4179				    (uint8_t *)lun->mode_pages.control_ext_page;
4180				break;
4181			default:
4182				panic("subpage %#x for page %#x is incorrect!",
4183				      page_index->subpage, page_code);
4184			}
4185			break;
4186		}
4187		case SMS_INFO_EXCEPTIONS_PAGE: {
4188			switch (page_index->subpage) {
4189			case SMS_SUBPAGE_PAGE_0:
4190				memcpy(&lun->mode_pages.ie_page[CTL_PAGE_CURRENT],
4191				       &ie_page_default,
4192				       sizeof(ie_page_default));
4193				memcpy(&lun->mode_pages.ie_page[
4194				       CTL_PAGE_CHANGEABLE], &ie_page_changeable,
4195				       sizeof(ie_page_changeable));
4196				memcpy(&lun->mode_pages.ie_page[CTL_PAGE_DEFAULT],
4197				       &ie_page_default,
4198				       sizeof(ie_page_default));
4199				memcpy(&lun->mode_pages.ie_page[CTL_PAGE_SAVED],
4200				       &ie_page_default,
4201				       sizeof(ie_page_default));
4202				page_index->page_data =
4203					(uint8_t *)lun->mode_pages.ie_page;
4204				break;
4205			case 0x02: {
4206				struct ctl_logical_block_provisioning_page *page;
4207
4208				memcpy(&lun->mode_pages.lbp_page[CTL_PAGE_DEFAULT],
4209				       &lbp_page_default,
4210				       sizeof(lbp_page_default));
4211				memcpy(&lun->mode_pages.lbp_page[
4212				       CTL_PAGE_CHANGEABLE], &lbp_page_changeable,
4213				       sizeof(lbp_page_changeable));
4214				memcpy(&lun->mode_pages.lbp_page[CTL_PAGE_SAVED],
4215				       &lbp_page_default,
4216				       sizeof(lbp_page_default));
4217				page = &lun->mode_pages.lbp_page[CTL_PAGE_SAVED];
4218				value = ctl_get_opt(&lun->be_lun->options,
4219				    "avail-threshold");
4220				if (value != NULL &&
4221				    ctl_expand_number(value, &ival) == 0) {
4222					page->descr[0].flags |= SLBPPD_ENABLED |
4223					    SLBPPD_ARMING_DEC;
4224					if (lun->be_lun->blocksize)
4225						ival /= lun->be_lun->blocksize;
4226					else
4227						ival /= 512;
4228					scsi_ulto4b(ival >> CTL_LBP_EXPONENT,
4229					    page->descr[0].count);
4230				}
4231				value = ctl_get_opt(&lun->be_lun->options,
4232				    "used-threshold");
4233				if (value != NULL &&
4234				    ctl_expand_number(value, &ival) == 0) {
4235					page->descr[1].flags |= SLBPPD_ENABLED |
4236					    SLBPPD_ARMING_INC;
4237					if (lun->be_lun->blocksize)
4238						ival /= lun->be_lun->blocksize;
4239					else
4240						ival /= 512;
4241					scsi_ulto4b(ival >> CTL_LBP_EXPONENT,
4242					    page->descr[1].count);
4243				}
4244				value = ctl_get_opt(&lun->be_lun->options,
4245				    "pool-avail-threshold");
4246				if (value != NULL &&
4247				    ctl_expand_number(value, &ival) == 0) {
4248					page->descr[2].flags |= SLBPPD_ENABLED |
4249					    SLBPPD_ARMING_DEC;
4250					if (lun->be_lun->blocksize)
4251						ival /= lun->be_lun->blocksize;
4252					else
4253						ival /= 512;
4254					scsi_ulto4b(ival >> CTL_LBP_EXPONENT,
4255					    page->descr[2].count);
4256				}
4257				value = ctl_get_opt(&lun->be_lun->options,
4258				    "pool-used-threshold");
4259				if (value != NULL &&
4260				    ctl_expand_number(value, &ival) == 0) {
4261					page->descr[3].flags |= SLBPPD_ENABLED |
4262					    SLBPPD_ARMING_INC;
4263					if (lun->be_lun->blocksize)
4264						ival /= lun->be_lun->blocksize;
4265					else
4266						ival /= 512;
4267					scsi_ulto4b(ival >> CTL_LBP_EXPONENT,
4268					    page->descr[3].count);
4269				}
4270				memcpy(&lun->mode_pages.lbp_page[CTL_PAGE_CURRENT],
4271				       &lun->mode_pages.lbp_page[CTL_PAGE_SAVED],
4272				       sizeof(lbp_page_default));
4273				page_index->page_data =
4274					(uint8_t *)lun->mode_pages.lbp_page;
4275				break;
4276			}
4277			default:
4278				panic("subpage %#x for page %#x is incorrect!",
4279				      page_index->subpage, page_code);
4280			}
4281			break;
4282		}
4283		case SMS_CDDVD_CAPS_PAGE:{
4284			KASSERT(page_index->subpage == SMS_SUBPAGE_PAGE_0,
4285			    ("subpage %#x for page %#x is incorrect!",
4286			    page_index->subpage, page_code));
4287			memcpy(&lun->mode_pages.cddvd_page[CTL_PAGE_DEFAULT],
4288			       &cddvd_page_default,
4289			       sizeof(cddvd_page_default));
4290			memcpy(&lun->mode_pages.cddvd_page[
4291			       CTL_PAGE_CHANGEABLE], &cddvd_page_changeable,
4292			       sizeof(cddvd_page_changeable));
4293			memcpy(&lun->mode_pages.cddvd_page[CTL_PAGE_SAVED],
4294			       &cddvd_page_default,
4295			       sizeof(cddvd_page_default));
4296			memcpy(&lun->mode_pages.cddvd_page[CTL_PAGE_CURRENT],
4297			       &lun->mode_pages.cddvd_page[CTL_PAGE_SAVED],
4298			       sizeof(cddvd_page_default));
4299			page_index->page_data =
4300				(uint8_t *)lun->mode_pages.cddvd_page;
4301			break;
4302		}
4303		default:
4304			panic("invalid page code value %#x", page_code);
4305		}
4306	}
4307
4308	return (CTL_RETVAL_COMPLETE);
4309}
4310
4311static int
4312ctl_init_log_page_index(struct ctl_lun *lun)
4313{
4314	struct ctl_page_index *page_index;
4315	int i, j, k, prev;
4316
4317	memcpy(&lun->log_pages.index, log_page_index_template,
4318	       sizeof(log_page_index_template));
4319
4320	prev = -1;
4321	for (i = 0, j = 0, k = 0; i < CTL_NUM_LOG_PAGES; i++) {
4322
4323		page_index = &lun->log_pages.index[i];
4324		if (lun->be_lun->lun_type == T_DIRECT &&
4325		    (page_index->page_flags & CTL_PAGE_FLAG_DIRECT) == 0)
4326			continue;
4327		if (lun->be_lun->lun_type == T_PROCESSOR &&
4328		    (page_index->page_flags & CTL_PAGE_FLAG_PROC) == 0)
4329			continue;
4330		if (lun->be_lun->lun_type == T_CDROM &&
4331		    (page_index->page_flags & CTL_PAGE_FLAG_CDROM) == 0)
4332			continue;
4333
4334		if (page_index->page_code == SLS_LOGICAL_BLOCK_PROVISIONING &&
4335		    lun->backend->lun_attr == NULL)
4336			continue;
4337
4338		if (page_index->page_code != prev) {
4339			lun->log_pages.pages_page[j] = page_index->page_code;
4340			prev = page_index->page_code;
4341			j++;
4342		}
4343		lun->log_pages.subpages_page[k*2] = page_index->page_code;
4344		lun->log_pages.subpages_page[k*2+1] = page_index->subpage;
4345		k++;
4346	}
4347	lun->log_pages.index[0].page_data = &lun->log_pages.pages_page[0];
4348	lun->log_pages.index[0].page_len = j;
4349	lun->log_pages.index[1].page_data = &lun->log_pages.subpages_page[0];
4350	lun->log_pages.index[1].page_len = k * 2;
4351	lun->log_pages.index[2].page_data = &lun->log_pages.lbp_page[0];
4352	lun->log_pages.index[2].page_len = 12*CTL_NUM_LBP_PARAMS;
4353	lun->log_pages.index[3].page_data = (uint8_t *)&lun->log_pages.stat_page;
4354	lun->log_pages.index[3].page_len = sizeof(lun->log_pages.stat_page);
4355	lun->log_pages.index[4].page_data = (uint8_t *)&lun->log_pages.ie_page;
4356	lun->log_pages.index[4].page_len = sizeof(lun->log_pages.ie_page);
4357
4358	return (CTL_RETVAL_COMPLETE);
4359}
4360
4361static int
4362hex2bin(const char *str, uint8_t *buf, int buf_size)
4363{
4364	int i;
4365	u_char c;
4366
4367	memset(buf, 0, buf_size);
4368	while (isspace(str[0]))
4369		str++;
4370	if (str[0] == '0' && (str[1] == 'x' || str[1] == 'X'))
4371		str += 2;
4372	buf_size *= 2;
4373	for (i = 0; str[i] != 0 && i < buf_size; i++) {
4374		while (str[i] == '-')	/* Skip dashes in UUIDs. */
4375			str++;
4376		c = str[i];
4377		if (isdigit(c))
4378			c -= '0';
4379		else if (isalpha(c))
4380			c -= isupper(c) ? 'A' - 10 : 'a' - 10;
4381		else
4382			break;
4383		if (c >= 16)
4384			break;
4385		if ((i & 1) == 0)
4386			buf[i / 2] |= (c << 4);
4387		else
4388			buf[i / 2] |= c;
4389	}
4390	return ((i + 1) / 2);
4391}
4392
4393/*
4394 * LUN allocation.
4395 *
4396 * Requirements:
4397 * - caller allocates and zeros LUN storage, or passes in a NULL LUN if he
4398 *   wants us to allocate the LUN and he can block.
4399 * - ctl_softc is always set
4400 * - be_lun is set if the LUN has a backend (needed for disk LUNs)
4401 *
4402 * Returns 0 for success, non-zero (errno) for failure.
4403 */
4404static int
4405ctl_alloc_lun(struct ctl_softc *ctl_softc, struct ctl_lun *ctl_lun,
4406	      struct ctl_be_lun *const be_lun)
4407{
4408	struct ctl_lun *nlun, *lun;
4409	struct scsi_vpd_id_descriptor *desc;
4410	struct scsi_vpd_id_t10 *t10id;
4411	const char *eui, *naa, *scsiname, *uuid, *vendor, *value;
4412	int lun_number, i, lun_malloced;
4413	int devidlen, idlen1, idlen2 = 0, len;
4414
4415	if (be_lun == NULL)
4416		return (EINVAL);
4417
4418	/*
4419	 * We currently only support Direct Access or Processor LUN types.
4420	 */
4421	switch (be_lun->lun_type) {
4422	case T_DIRECT:
4423	case T_PROCESSOR:
4424	case T_CDROM:
4425		break;
4426	case T_SEQUENTIAL:
4427	case T_CHANGER:
4428	default:
4429		be_lun->lun_config_status(be_lun->be_lun,
4430					  CTL_LUN_CONFIG_FAILURE);
4431		break;
4432	}
4433	if (ctl_lun == NULL) {
4434		lun = malloc(sizeof(*lun), M_CTL, M_WAITOK);
4435		lun_malloced = 1;
4436	} else {
4437		lun_malloced = 0;
4438		lun = ctl_lun;
4439	}
4440
4441	memset(lun, 0, sizeof(*lun));
4442	if (lun_malloced)
4443		lun->flags = CTL_LUN_MALLOCED;
4444
4445	/* Generate LUN ID. */
4446	devidlen = max(CTL_DEVID_MIN_LEN,
4447	    strnlen(be_lun->device_id, CTL_DEVID_LEN));
4448	idlen1 = sizeof(*t10id) + devidlen;
4449	len = sizeof(struct scsi_vpd_id_descriptor) + idlen1;
4450	scsiname = ctl_get_opt(&be_lun->options, "scsiname");
4451	if (scsiname != NULL) {
4452		idlen2 = roundup2(strlen(scsiname) + 1, 4);
4453		len += sizeof(struct scsi_vpd_id_descriptor) + idlen2;
4454	}
4455	eui = ctl_get_opt(&be_lun->options, "eui");
4456	if (eui != NULL) {
4457		len += sizeof(struct scsi_vpd_id_descriptor) + 16;
4458	}
4459	naa = ctl_get_opt(&be_lun->options, "naa");
4460	if (naa != NULL) {
4461		len += sizeof(struct scsi_vpd_id_descriptor) + 16;
4462	}
4463	uuid = ctl_get_opt(&be_lun->options, "uuid");
4464	if (uuid != NULL) {
4465		len += sizeof(struct scsi_vpd_id_descriptor) + 18;
4466	}
4467	lun->lun_devid = malloc(sizeof(struct ctl_devid) + len,
4468	    M_CTL, M_WAITOK | M_ZERO);
4469	desc = (struct scsi_vpd_id_descriptor *)lun->lun_devid->data;
4470	desc->proto_codeset = SVPD_ID_CODESET_ASCII;
4471	desc->id_type = SVPD_ID_PIV | SVPD_ID_ASSOC_LUN | SVPD_ID_TYPE_T10;
4472	desc->length = idlen1;
4473	t10id = (struct scsi_vpd_id_t10 *)&desc->identifier[0];
4474	memset(t10id->vendor, ' ', sizeof(t10id->vendor));
4475	if ((vendor = ctl_get_opt(&be_lun->options, "vendor")) == NULL) {
4476		strncpy((char *)t10id->vendor, CTL_VENDOR, sizeof(t10id->vendor));
4477	} else {
4478		strncpy(t10id->vendor, vendor,
4479		    min(sizeof(t10id->vendor), strlen(vendor)));
4480	}
4481	strncpy((char *)t10id->vendor_spec_id,
4482	    (char *)be_lun->device_id, devidlen);
4483	if (scsiname != NULL) {
4484		desc = (struct scsi_vpd_id_descriptor *)(&desc->identifier[0] +
4485		    desc->length);
4486		desc->proto_codeset = SVPD_ID_CODESET_UTF8;
4487		desc->id_type = SVPD_ID_PIV | SVPD_ID_ASSOC_LUN |
4488		    SVPD_ID_TYPE_SCSI_NAME;
4489		desc->length = idlen2;
4490		strlcpy(desc->identifier, scsiname, idlen2);
4491	}
4492	if (eui != NULL) {
4493		desc = (struct scsi_vpd_id_descriptor *)(&desc->identifier[0] +
4494		    desc->length);
4495		desc->proto_codeset = SVPD_ID_CODESET_BINARY;
4496		desc->id_type = SVPD_ID_PIV | SVPD_ID_ASSOC_LUN |
4497		    SVPD_ID_TYPE_EUI64;
4498		desc->length = hex2bin(eui, desc->identifier, 16);
4499		desc->length = desc->length > 12 ? 16 :
4500		    (desc->length > 8 ? 12 : 8);
4501		len -= 16 - desc->length;
4502	}
4503	if (naa != NULL) {
4504		desc = (struct scsi_vpd_id_descriptor *)(&desc->identifier[0] +
4505		    desc->length);
4506		desc->proto_codeset = SVPD_ID_CODESET_BINARY;
4507		desc->id_type = SVPD_ID_PIV | SVPD_ID_ASSOC_LUN |
4508		    SVPD_ID_TYPE_NAA;
4509		desc->length = hex2bin(naa, desc->identifier, 16);
4510		desc->length = desc->length > 8 ? 16 : 8;
4511		len -= 16 - desc->length;
4512	}
4513	if (uuid != NULL) {
4514		desc = (struct scsi_vpd_id_descriptor *)(&desc->identifier[0] +
4515		    desc->length);
4516		desc->proto_codeset = SVPD_ID_CODESET_BINARY;
4517		desc->id_type = SVPD_ID_PIV | SVPD_ID_ASSOC_LUN |
4518		    SVPD_ID_TYPE_UUID;
4519		desc->identifier[0] = 0x10;
4520		hex2bin(uuid, &desc->identifier[2], 16);
4521		desc->length = 18;
4522	}
4523	lun->lun_devid->len = len;
4524
4525	mtx_lock(&ctl_softc->ctl_lock);
4526	/*
4527	 * See if the caller requested a particular LUN number.  If so, see
4528	 * if it is available.  Otherwise, allocate the first available LUN.
4529	 */
4530	if (be_lun->flags & CTL_LUN_FLAG_ID_REQ) {
4531		if ((be_lun->req_lun_id > (CTL_MAX_LUNS - 1))
4532		 || (ctl_is_set(ctl_softc->ctl_lun_mask, be_lun->req_lun_id))) {
4533			mtx_unlock(&ctl_softc->ctl_lock);
4534			if (be_lun->req_lun_id > (CTL_MAX_LUNS - 1)) {
4535				printf("ctl: requested LUN ID %d is higher "
4536				       "than CTL_MAX_LUNS - 1 (%d)\n",
4537				       be_lun->req_lun_id, CTL_MAX_LUNS - 1);
4538			} else {
4539				/*
4540				 * XXX KDM return an error, or just assign
4541				 * another LUN ID in this case??
4542				 */
4543				printf("ctl: requested LUN ID %d is already "
4544				       "in use\n", be_lun->req_lun_id);
4545			}
4546			if (lun->flags & CTL_LUN_MALLOCED)
4547				free(lun, M_CTL);
4548			be_lun->lun_config_status(be_lun->be_lun,
4549						  CTL_LUN_CONFIG_FAILURE);
4550			return (ENOSPC);
4551		}
4552		lun_number = be_lun->req_lun_id;
4553	} else {
4554		lun_number = ctl_ffz(ctl_softc->ctl_lun_mask, 0, CTL_MAX_LUNS);
4555		if (lun_number == -1) {
4556			mtx_unlock(&ctl_softc->ctl_lock);
4557			printf("ctl: can't allocate LUN, out of LUNs\n");
4558			if (lun->flags & CTL_LUN_MALLOCED)
4559				free(lun, M_CTL);
4560			be_lun->lun_config_status(be_lun->be_lun,
4561						  CTL_LUN_CONFIG_FAILURE);
4562			return (ENOSPC);
4563		}
4564	}
4565	ctl_set_mask(ctl_softc->ctl_lun_mask, lun_number);
4566
4567	mtx_init(&lun->lun_lock, "CTL LUN", NULL, MTX_DEF);
4568	lun->lun = lun_number;
4569	lun->be_lun = be_lun;
4570	/*
4571	 * The processor LUN is always enabled.  Disk LUNs come on line
4572	 * disabled, and must be enabled by the backend.
4573	 */
4574	lun->flags |= CTL_LUN_DISABLED;
4575	lun->backend = be_lun->be;
4576	be_lun->ctl_lun = lun;
4577	be_lun->lun_id = lun_number;
4578	atomic_add_int(&be_lun->be->num_luns, 1);
4579	if (be_lun->flags & CTL_LUN_FLAG_EJECTED)
4580		lun->flags |= CTL_LUN_EJECTED;
4581	if (be_lun->flags & CTL_LUN_FLAG_NO_MEDIA)
4582		lun->flags |= CTL_LUN_NO_MEDIA;
4583	if (be_lun->flags & CTL_LUN_FLAG_STOPPED)
4584		lun->flags |= CTL_LUN_STOPPED;
4585
4586	if (be_lun->flags & CTL_LUN_FLAG_PRIMARY)
4587		lun->flags |= CTL_LUN_PRIMARY_SC;
4588
4589	value = ctl_get_opt(&be_lun->options, "removable");
4590	if (value != NULL) {
4591		if (strcmp(value, "on") == 0)
4592			lun->flags |= CTL_LUN_REMOVABLE;
4593	} else if (be_lun->lun_type == T_CDROM)
4594		lun->flags |= CTL_LUN_REMOVABLE;
4595
4596	lun->ctl_softc = ctl_softc;
4597#ifdef CTL_TIME_IO
4598	lun->last_busy = getsbinuptime();
4599#endif
4600	TAILQ_INIT(&lun->ooa_queue);
4601	TAILQ_INIT(&lun->blocked_queue);
4602	STAILQ_INIT(&lun->error_list);
4603	lun->ie_reported = 1;
4604	callout_init_mtx(&lun->ie_callout, &lun->lun_lock, 0);
4605	ctl_tpc_lun_init(lun);
4606
4607	/*
4608	 * Initialize the mode and log page index.
4609	 */
4610	ctl_init_page_index(lun);
4611	ctl_init_log_page_index(lun);
4612
4613	/*
4614	 * Now, before we insert this lun on the lun list, set the lun
4615	 * inventory changed UA for all other luns.
4616	 */
4617	STAILQ_FOREACH(nlun, &ctl_softc->lun_list, links) {
4618		mtx_lock(&nlun->lun_lock);
4619		ctl_est_ua_all(nlun, -1, CTL_UA_LUN_CHANGE);
4620		mtx_unlock(&nlun->lun_lock);
4621	}
4622
4623	STAILQ_INSERT_TAIL(&ctl_softc->lun_list, lun, links);
4624
4625	ctl_softc->ctl_luns[lun_number] = lun;
4626
4627	ctl_softc->num_luns++;
4628
4629	/* Setup statistics gathering */
4630	lun->stats.device_type = be_lun->lun_type;
4631	lun->stats.lun_number = lun_number;
4632	lun->stats.blocksize = be_lun->blocksize;
4633	if (be_lun->blocksize == 0)
4634		lun->stats.flags = CTL_LUN_STATS_NO_BLOCKSIZE;
4635	for (i = 0;i < CTL_MAX_PORTS;i++)
4636		lun->stats.ports[i].targ_port = i;
4637
4638	mtx_unlock(&ctl_softc->ctl_lock);
4639
4640	lun->be_lun->lun_config_status(lun->be_lun->be_lun, CTL_LUN_CONFIG_OK);
4641	return (0);
4642}
4643
4644/*
4645 * Delete a LUN.
4646 * Assumptions:
4647 * - LUN has already been marked invalid and any pending I/O has been taken
4648 *   care of.
4649 */
4650static int
4651ctl_free_lun(struct ctl_lun *lun)
4652{
4653	struct ctl_softc *softc;
4654	struct ctl_lun *nlun;
4655	int i;
4656
4657	softc = lun->ctl_softc;
4658
4659	mtx_assert(&softc->ctl_lock, MA_OWNED);
4660
4661	STAILQ_REMOVE(&softc->lun_list, lun, ctl_lun, links);
4662
4663	ctl_clear_mask(softc->ctl_lun_mask, lun->lun);
4664
4665	softc->ctl_luns[lun->lun] = NULL;
4666
4667	if (!TAILQ_EMPTY(&lun->ooa_queue))
4668		panic("Freeing a LUN %p with outstanding I/O!!\n", lun);
4669
4670	softc->num_luns--;
4671
4672	/*
4673	 * Tell the backend to free resources, if this LUN has a backend.
4674	 */
4675	atomic_subtract_int(&lun->be_lun->be->num_luns, 1);
4676	lun->be_lun->lun_shutdown(lun->be_lun->be_lun);
4677
4678	lun->ie_reportcnt = UINT32_MAX;
4679	callout_drain(&lun->ie_callout);
4680
4681	ctl_tpc_lun_shutdown(lun);
4682	mtx_destroy(&lun->lun_lock);
4683	free(lun->lun_devid, M_CTL);
4684	for (i = 0; i < CTL_MAX_PORTS; i++)
4685		free(lun->pending_ua[i], M_CTL);
4686	for (i = 0; i < CTL_MAX_PORTS; i++)
4687		free(lun->pr_keys[i], M_CTL);
4688	free(lun->write_buffer, M_CTL);
4689	if (lun->flags & CTL_LUN_MALLOCED)
4690		free(lun, M_CTL);
4691
4692	STAILQ_FOREACH(nlun, &softc->lun_list, links) {
4693		mtx_lock(&nlun->lun_lock);
4694		ctl_est_ua_all(nlun, -1, CTL_UA_LUN_CHANGE);
4695		mtx_unlock(&nlun->lun_lock);
4696	}
4697
4698	return (0);
4699}
4700
4701static void
4702ctl_create_lun(struct ctl_be_lun *be_lun)
4703{
4704
4705	/*
4706	 * ctl_alloc_lun() should handle all potential failure cases.
4707	 */
4708	ctl_alloc_lun(control_softc, NULL, be_lun);
4709}
4710
4711int
4712ctl_add_lun(struct ctl_be_lun *be_lun)
4713{
4714	struct ctl_softc *softc = control_softc;
4715
4716	mtx_lock(&softc->ctl_lock);
4717	STAILQ_INSERT_TAIL(&softc->pending_lun_queue, be_lun, links);
4718	mtx_unlock(&softc->ctl_lock);
4719	wakeup(&softc->pending_lun_queue);
4720
4721	return (0);
4722}
4723
4724int
4725ctl_enable_lun(struct ctl_be_lun *be_lun)
4726{
4727	struct ctl_softc *softc;
4728	struct ctl_port *port, *nport;
4729	struct ctl_lun *lun;
4730	int retval;
4731
4732	lun = (struct ctl_lun *)be_lun->ctl_lun;
4733	softc = lun->ctl_softc;
4734
4735	mtx_lock(&softc->ctl_lock);
4736	mtx_lock(&lun->lun_lock);
4737	if ((lun->flags & CTL_LUN_DISABLED) == 0) {
4738		/*
4739		 * eh?  Why did we get called if the LUN is already
4740		 * enabled?
4741		 */
4742		mtx_unlock(&lun->lun_lock);
4743		mtx_unlock(&softc->ctl_lock);
4744		return (0);
4745	}
4746	lun->flags &= ~CTL_LUN_DISABLED;
4747	mtx_unlock(&lun->lun_lock);
4748
4749	STAILQ_FOREACH_SAFE(port, &softc->port_list, links, nport) {
4750		if ((port->status & CTL_PORT_STATUS_ONLINE) == 0 ||
4751		    port->lun_map != NULL || port->lun_enable == NULL)
4752			continue;
4753
4754		/*
4755		 * Drop the lock while we call the FETD's enable routine.
4756		 * This can lead to a callback into CTL (at least in the
4757		 * case of the internal initiator frontend.
4758		 */
4759		mtx_unlock(&softc->ctl_lock);
4760		retval = port->lun_enable(port->targ_lun_arg, lun->lun);
4761		mtx_lock(&softc->ctl_lock);
4762		if (retval != 0) {
4763			printf("%s: FETD %s port %d returned error "
4764			       "%d for lun_enable on lun %jd\n",
4765			       __func__, port->port_name, port->targ_port,
4766			       retval, (intmax_t)lun->lun);
4767		}
4768	}
4769
4770	mtx_unlock(&softc->ctl_lock);
4771	ctl_isc_announce_lun(lun);
4772
4773	return (0);
4774}
4775
4776int
4777ctl_disable_lun(struct ctl_be_lun *be_lun)
4778{
4779	struct ctl_softc *softc;
4780	struct ctl_port *port;
4781	struct ctl_lun *lun;
4782	int retval;
4783
4784	lun = (struct ctl_lun *)be_lun->ctl_lun;
4785	softc = lun->ctl_softc;
4786
4787	mtx_lock(&softc->ctl_lock);
4788	mtx_lock(&lun->lun_lock);
4789	if (lun->flags & CTL_LUN_DISABLED) {
4790		mtx_unlock(&lun->lun_lock);
4791		mtx_unlock(&softc->ctl_lock);
4792		return (0);
4793	}
4794	lun->flags |= CTL_LUN_DISABLED;
4795	mtx_unlock(&lun->lun_lock);
4796
4797	STAILQ_FOREACH(port, &softc->port_list, links) {
4798		if ((port->status & CTL_PORT_STATUS_ONLINE) == 0 ||
4799		    port->lun_map != NULL || port->lun_disable == NULL)
4800			continue;
4801
4802		/*
4803		 * Drop the lock before we call the frontend's disable
4804		 * routine, to avoid lock order reversals.
4805		 *
4806		 * XXX KDM what happens if the frontend list changes while
4807		 * we're traversing it?  It's unlikely, but should be handled.
4808		 */
4809		mtx_unlock(&softc->ctl_lock);
4810		retval = port->lun_disable(port->targ_lun_arg, lun->lun);
4811		mtx_lock(&softc->ctl_lock);
4812		if (retval != 0) {
4813			printf("%s: FETD %s port %d returned error "
4814			       "%d for lun_disable on lun %jd\n",
4815			       __func__, port->port_name, port->targ_port,
4816			       retval, (intmax_t)lun->lun);
4817		}
4818	}
4819
4820	mtx_unlock(&softc->ctl_lock);
4821	ctl_isc_announce_lun(lun);
4822
4823	return (0);
4824}
4825
4826int
4827ctl_start_lun(struct ctl_be_lun *be_lun)
4828{
4829	struct ctl_lun *lun = (struct ctl_lun *)be_lun->ctl_lun;
4830
4831	mtx_lock(&lun->lun_lock);
4832	lun->flags &= ~CTL_LUN_STOPPED;
4833	mtx_unlock(&lun->lun_lock);
4834	return (0);
4835}
4836
4837int
4838ctl_stop_lun(struct ctl_be_lun *be_lun)
4839{
4840	struct ctl_lun *lun = (struct ctl_lun *)be_lun->ctl_lun;
4841
4842	mtx_lock(&lun->lun_lock);
4843	lun->flags |= CTL_LUN_STOPPED;
4844	mtx_unlock(&lun->lun_lock);
4845	return (0);
4846}
4847
4848int
4849ctl_lun_no_media(struct ctl_be_lun *be_lun)
4850{
4851	struct ctl_lun *lun = (struct ctl_lun *)be_lun->ctl_lun;
4852
4853	mtx_lock(&lun->lun_lock);
4854	lun->flags |= CTL_LUN_NO_MEDIA;
4855	mtx_unlock(&lun->lun_lock);
4856	return (0);
4857}
4858
4859int
4860ctl_lun_has_media(struct ctl_be_lun *be_lun)
4861{
4862	struct ctl_lun *lun = (struct ctl_lun *)be_lun->ctl_lun;
4863	union ctl_ha_msg msg;
4864
4865	mtx_lock(&lun->lun_lock);
4866	lun->flags &= ~(CTL_LUN_NO_MEDIA | CTL_LUN_EJECTED);
4867	if (lun->flags & CTL_LUN_REMOVABLE)
4868		ctl_est_ua_all(lun, -1, CTL_UA_MEDIUM_CHANGE);
4869	mtx_unlock(&lun->lun_lock);
4870	if ((lun->flags & CTL_LUN_REMOVABLE) &&
4871	    lun->ctl_softc->ha_mode == CTL_HA_MODE_XFER) {
4872		bzero(&msg.ua, sizeof(msg.ua));
4873		msg.hdr.msg_type = CTL_MSG_UA;
4874		msg.hdr.nexus.initid = -1;
4875		msg.hdr.nexus.targ_port = -1;
4876		msg.hdr.nexus.targ_lun = lun->lun;
4877		msg.hdr.nexus.targ_mapped_lun = lun->lun;
4878		msg.ua.ua_all = 1;
4879		msg.ua.ua_set = 1;
4880		msg.ua.ua_type = CTL_UA_MEDIUM_CHANGE;
4881		ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg, sizeof(msg.ua),
4882		    M_WAITOK);
4883	}
4884	return (0);
4885}
4886
4887int
4888ctl_lun_ejected(struct ctl_be_lun *be_lun)
4889{
4890	struct ctl_lun *lun = (struct ctl_lun *)be_lun->ctl_lun;
4891
4892	mtx_lock(&lun->lun_lock);
4893	lun->flags |= CTL_LUN_EJECTED;
4894	mtx_unlock(&lun->lun_lock);
4895	return (0);
4896}
4897
4898int
4899ctl_lun_primary(struct ctl_be_lun *be_lun)
4900{
4901	struct ctl_lun *lun = (struct ctl_lun *)be_lun->ctl_lun;
4902
4903	mtx_lock(&lun->lun_lock);
4904	lun->flags |= CTL_LUN_PRIMARY_SC;
4905	ctl_est_ua_all(lun, -1, CTL_UA_ASYM_ACC_CHANGE);
4906	mtx_unlock(&lun->lun_lock);
4907	ctl_isc_announce_lun(lun);
4908	return (0);
4909}
4910
4911int
4912ctl_lun_secondary(struct ctl_be_lun *be_lun)
4913{
4914	struct ctl_lun *lun = (struct ctl_lun *)be_lun->ctl_lun;
4915
4916	mtx_lock(&lun->lun_lock);
4917	lun->flags &= ~CTL_LUN_PRIMARY_SC;
4918	ctl_est_ua_all(lun, -1, CTL_UA_ASYM_ACC_CHANGE);
4919	mtx_unlock(&lun->lun_lock);
4920	ctl_isc_announce_lun(lun);
4921	return (0);
4922}
4923
4924int
4925ctl_invalidate_lun(struct ctl_be_lun *be_lun)
4926{
4927	struct ctl_softc *softc;
4928	struct ctl_lun *lun;
4929
4930	lun = (struct ctl_lun *)be_lun->ctl_lun;
4931	softc = lun->ctl_softc;
4932
4933	mtx_lock(&lun->lun_lock);
4934
4935	/*
4936	 * The LUN needs to be disabled before it can be marked invalid.
4937	 */
4938	if ((lun->flags & CTL_LUN_DISABLED) == 0) {
4939		mtx_unlock(&lun->lun_lock);
4940		return (-1);
4941	}
4942	/*
4943	 * Mark the LUN invalid.
4944	 */
4945	lun->flags |= CTL_LUN_INVALID;
4946
4947	/*
4948	 * If there is nothing in the OOA queue, go ahead and free the LUN.
4949	 * If we have something in the OOA queue, we'll free it when the
4950	 * last I/O completes.
4951	 */
4952	if (TAILQ_EMPTY(&lun->ooa_queue)) {
4953		mtx_unlock(&lun->lun_lock);
4954		mtx_lock(&softc->ctl_lock);
4955		ctl_free_lun(lun);
4956		mtx_unlock(&softc->ctl_lock);
4957	} else
4958		mtx_unlock(&lun->lun_lock);
4959
4960	return (0);
4961}
4962
4963void
4964ctl_lun_capacity_changed(struct ctl_be_lun *be_lun)
4965{
4966	struct ctl_lun *lun = (struct ctl_lun *)be_lun->ctl_lun;
4967	union ctl_ha_msg msg;
4968
4969	mtx_lock(&lun->lun_lock);
4970	ctl_est_ua_all(lun, -1, CTL_UA_CAPACITY_CHANGE);
4971	mtx_unlock(&lun->lun_lock);
4972	if (lun->ctl_softc->ha_mode == CTL_HA_MODE_XFER) {
4973		/* Send msg to other side. */
4974		bzero(&msg.ua, sizeof(msg.ua));
4975		msg.hdr.msg_type = CTL_MSG_UA;
4976		msg.hdr.nexus.initid = -1;
4977		msg.hdr.nexus.targ_port = -1;
4978		msg.hdr.nexus.targ_lun = lun->lun;
4979		msg.hdr.nexus.targ_mapped_lun = lun->lun;
4980		msg.ua.ua_all = 1;
4981		msg.ua.ua_set = 1;
4982		msg.ua.ua_type = CTL_UA_CAPACITY_CHANGE;
4983		ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg, sizeof(msg.ua),
4984		    M_WAITOK);
4985	}
4986}
4987
4988/*
4989 * Backend "memory move is complete" callback for requests that never
4990 * make it down to say RAIDCore's configuration code.
4991 */
4992int
4993ctl_config_move_done(union ctl_io *io)
4994{
4995	int retval;
4996
4997	CTL_DEBUG_PRINT(("ctl_config_move_done\n"));
4998	KASSERT(io->io_hdr.io_type == CTL_IO_SCSI,
4999	    ("Config I/O type isn't CTL_IO_SCSI (%d)!", io->io_hdr.io_type));
5000
5001	if ((io->io_hdr.port_status != 0) &&
5002	    ((io->io_hdr.status & CTL_STATUS_MASK) == CTL_STATUS_NONE ||
5003	     (io->io_hdr.status & CTL_STATUS_MASK) == CTL_SUCCESS)) {
5004		/*
5005		 * For hardware error sense keys, the sense key
5006		 * specific value is defined to be a retry count,
5007		 * but we use it to pass back an internal FETD
5008		 * error code.  XXX KDM  Hopefully the FETD is only
5009		 * using 16 bits for an error code, since that's
5010		 * all the space we have in the sks field.
5011		 */
5012		ctl_set_internal_failure(&io->scsiio,
5013					 /*sks_valid*/ 1,
5014					 /*retry_count*/
5015					 io->io_hdr.port_status);
5016	}
5017
5018	if (ctl_debug & CTL_DEBUG_CDB_DATA)
5019		ctl_data_print(io);
5020	if (((io->io_hdr.flags & CTL_FLAG_DATA_MASK) == CTL_FLAG_DATA_IN) ||
5021	    ((io->io_hdr.status & CTL_STATUS_MASK) != CTL_STATUS_NONE &&
5022	     (io->io_hdr.status & CTL_STATUS_MASK) != CTL_SUCCESS) ||
5023	    ((io->io_hdr.flags & CTL_FLAG_ABORT) != 0)) {
5024		/*
5025		 * XXX KDM just assuming a single pointer here, and not a
5026		 * S/G list.  If we start using S/G lists for config data,
5027		 * we'll need to know how to clean them up here as well.
5028		 */
5029		if (io->io_hdr.flags & CTL_FLAG_ALLOCATED)
5030			free(io->scsiio.kern_data_ptr, M_CTL);
5031		ctl_done(io);
5032		retval = CTL_RETVAL_COMPLETE;
5033	} else {
5034		/*
5035		 * XXX KDM now we need to continue data movement.  Some
5036		 * options:
5037		 * - call ctl_scsiio() again?  We don't do this for data
5038		 *   writes, because for those at least we know ahead of
5039		 *   time where the write will go and how long it is.  For
5040		 *   config writes, though, that information is largely
5041		 *   contained within the write itself, thus we need to
5042		 *   parse out the data again.
5043		 *
5044		 * - Call some other function once the data is in?
5045		 */
5046
5047		/*
5048		 * XXX KDM call ctl_scsiio() again for now, and check flag
5049		 * bits to see whether we're allocated or not.
5050		 */
5051		retval = ctl_scsiio(&io->scsiio);
5052	}
5053	return (retval);
5054}
5055
5056/*
5057 * This gets called by a backend driver when it is done with a
5058 * data_submit method.
5059 */
5060void
5061ctl_data_submit_done(union ctl_io *io)
5062{
5063	/*
5064	 * If the IO_CONT flag is set, we need to call the supplied
5065	 * function to continue processing the I/O, instead of completing
5066	 * the I/O just yet.
5067	 *
5068	 * If there is an error, though, we don't want to keep processing.
5069	 * Instead, just send status back to the initiator.
5070	 */
5071	if ((io->io_hdr.flags & CTL_FLAG_IO_CONT) &&
5072	    (io->io_hdr.flags & CTL_FLAG_ABORT) == 0 &&
5073	    ((io->io_hdr.status & CTL_STATUS_MASK) == CTL_STATUS_NONE ||
5074	     (io->io_hdr.status & CTL_STATUS_MASK) == CTL_SUCCESS)) {
5075		io->scsiio.io_cont(io);
5076		return;
5077	}
5078	ctl_done(io);
5079}
5080
5081/*
5082 * This gets called by a backend driver when it is done with a
5083 * configuration write.
5084 */
5085void
5086ctl_config_write_done(union ctl_io *io)
5087{
5088	uint8_t *buf;
5089
5090	/*
5091	 * If the IO_CONT flag is set, we need to call the supplied
5092	 * function to continue processing the I/O, instead of completing
5093	 * the I/O just yet.
5094	 *
5095	 * If there is an error, though, we don't want to keep processing.
5096	 * Instead, just send status back to the initiator.
5097	 */
5098	if ((io->io_hdr.flags & CTL_FLAG_IO_CONT) &&
5099	    (io->io_hdr.flags & CTL_FLAG_ABORT) == 0 &&
5100	    ((io->io_hdr.status & CTL_STATUS_MASK) == CTL_STATUS_NONE ||
5101	     (io->io_hdr.status & CTL_STATUS_MASK) == CTL_SUCCESS)) {
5102		io->scsiio.io_cont(io);
5103		return;
5104	}
5105	/*
5106	 * Since a configuration write can be done for commands that actually
5107	 * have data allocated, like write buffer, and commands that have
5108	 * no data, like start/stop unit, we need to check here.
5109	 */
5110	if (io->io_hdr.flags & CTL_FLAG_ALLOCATED)
5111		buf = io->scsiio.kern_data_ptr;
5112	else
5113		buf = NULL;
5114	ctl_done(io);
5115	if (buf)
5116		free(buf, M_CTL);
5117}
5118
5119void
5120ctl_config_read_done(union ctl_io *io)
5121{
5122	uint8_t *buf;
5123
5124	/*
5125	 * If there is some error -- we are done, skip data transfer.
5126	 */
5127	if ((io->io_hdr.flags & CTL_FLAG_ABORT) != 0 ||
5128	    ((io->io_hdr.status & CTL_STATUS_MASK) != CTL_STATUS_NONE &&
5129	     (io->io_hdr.status & CTL_STATUS_MASK) != CTL_SUCCESS)) {
5130		if (io->io_hdr.flags & CTL_FLAG_ALLOCATED)
5131			buf = io->scsiio.kern_data_ptr;
5132		else
5133			buf = NULL;
5134		ctl_done(io);
5135		if (buf)
5136			free(buf, M_CTL);
5137		return;
5138	}
5139
5140	/*
5141	 * If the IO_CONT flag is set, we need to call the supplied
5142	 * function to continue processing the I/O, instead of completing
5143	 * the I/O just yet.
5144	 */
5145	if (io->io_hdr.flags & CTL_FLAG_IO_CONT) {
5146		io->scsiio.io_cont(io);
5147		return;
5148	}
5149
5150	ctl_datamove(io);
5151}
5152
5153/*
5154 * SCSI release command.
5155 */
5156int
5157ctl_scsi_release(struct ctl_scsiio *ctsio)
5158{
5159	struct ctl_lun *lun;
5160	uint32_t residx;
5161
5162	CTL_DEBUG_PRINT(("ctl_scsi_release\n"));
5163
5164	residx = ctl_get_initindex(&ctsio->io_hdr.nexus);
5165	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5166
5167	/*
5168	 * XXX KDM right now, we only support LUN reservation.  We don't
5169	 * support 3rd party reservations, or extent reservations, which
5170	 * might actually need the parameter list.  If we've gotten this
5171	 * far, we've got a LUN reservation.  Anything else got kicked out
5172	 * above.  So, according to SPC, ignore the length.
5173	 */
5174
5175	mtx_lock(&lun->lun_lock);
5176
5177	/*
5178	 * According to SPC, it is not an error for an intiator to attempt
5179	 * to release a reservation on a LUN that isn't reserved, or that
5180	 * is reserved by another initiator.  The reservation can only be
5181	 * released, though, by the initiator who made it or by one of
5182	 * several reset type events.
5183	 */
5184	if ((lun->flags & CTL_LUN_RESERVED) && (lun->res_idx == residx))
5185			lun->flags &= ~CTL_LUN_RESERVED;
5186
5187	mtx_unlock(&lun->lun_lock);
5188
5189	ctl_set_success(ctsio);
5190	ctl_done((union ctl_io *)ctsio);
5191	return (CTL_RETVAL_COMPLETE);
5192}
5193
5194int
5195ctl_scsi_reserve(struct ctl_scsiio *ctsio)
5196{
5197	struct ctl_lun *lun;
5198	uint32_t residx;
5199
5200	CTL_DEBUG_PRINT(("ctl_reserve\n"));
5201
5202	residx = ctl_get_initindex(&ctsio->io_hdr.nexus);
5203	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5204
5205	/*
5206	 * XXX KDM right now, we only support LUN reservation.  We don't
5207	 * support 3rd party reservations, or extent reservations, which
5208	 * might actually need the parameter list.  If we've gotten this
5209	 * far, we've got a LUN reservation.  Anything else got kicked out
5210	 * above.  So, according to SPC, ignore the length.
5211	 */
5212
5213	mtx_lock(&lun->lun_lock);
5214	if ((lun->flags & CTL_LUN_RESERVED) && (lun->res_idx != residx)) {
5215		ctl_set_reservation_conflict(ctsio);
5216		goto bailout;
5217	}
5218
5219	/* SPC-3 exceptions to SPC-2 RESERVE and RELEASE behavior. */
5220	if (lun->flags & CTL_LUN_PR_RESERVED) {
5221		ctl_set_success(ctsio);
5222		goto bailout;
5223	}
5224
5225	lun->flags |= CTL_LUN_RESERVED;
5226	lun->res_idx = residx;
5227	ctl_set_success(ctsio);
5228
5229bailout:
5230	mtx_unlock(&lun->lun_lock);
5231	ctl_done((union ctl_io *)ctsio);
5232	return (CTL_RETVAL_COMPLETE);
5233}
5234
5235int
5236ctl_start_stop(struct ctl_scsiio *ctsio)
5237{
5238	struct scsi_start_stop_unit *cdb;
5239	struct ctl_lun *lun;
5240	int retval;
5241
5242	CTL_DEBUG_PRINT(("ctl_start_stop\n"));
5243
5244	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5245	cdb = (struct scsi_start_stop_unit *)ctsio->cdb;
5246
5247	if ((cdb->how & SSS_PC_MASK) == 0) {
5248		if ((lun->flags & CTL_LUN_PR_RESERVED) &&
5249		    (cdb->how & SSS_START) == 0) {
5250			uint32_t residx;
5251
5252			residx = ctl_get_initindex(&ctsio->io_hdr.nexus);
5253			if (ctl_get_prkey(lun, residx) == 0 ||
5254			    (lun->pr_res_idx != residx && lun->pr_res_type < 4)) {
5255
5256				ctl_set_reservation_conflict(ctsio);
5257				ctl_done((union ctl_io *)ctsio);
5258				return (CTL_RETVAL_COMPLETE);
5259			}
5260		}
5261
5262		if ((cdb->how & SSS_LOEJ) &&
5263		    (lun->flags & CTL_LUN_REMOVABLE) == 0) {
5264			ctl_set_invalid_field(ctsio,
5265					      /*sks_valid*/ 1,
5266					      /*command*/ 1,
5267					      /*field*/ 4,
5268					      /*bit_valid*/ 1,
5269					      /*bit*/ 1);
5270			ctl_done((union ctl_io *)ctsio);
5271			return (CTL_RETVAL_COMPLETE);
5272		}
5273
5274		if ((cdb->how & SSS_START) == 0 && (cdb->how & SSS_LOEJ) &&
5275		    lun->prevent_count > 0) {
5276			/* "Medium removal prevented" */
5277			ctl_set_sense(ctsio, /*current_error*/ 1,
5278			    /*sense_key*/(lun->flags & CTL_LUN_NO_MEDIA) ?
5279			     SSD_KEY_NOT_READY : SSD_KEY_ILLEGAL_REQUEST,
5280			    /*asc*/ 0x53, /*ascq*/ 0x02, SSD_ELEM_NONE);
5281			ctl_done((union ctl_io *)ctsio);
5282			return (CTL_RETVAL_COMPLETE);
5283		}
5284	}
5285
5286	retval = lun->backend->config_write((union ctl_io *)ctsio);
5287	return (retval);
5288}
5289
5290int
5291ctl_prevent_allow(struct ctl_scsiio *ctsio)
5292{
5293	struct ctl_lun *lun;
5294	struct scsi_prevent *cdb;
5295	int retval;
5296	uint32_t initidx;
5297
5298	CTL_DEBUG_PRINT(("ctl_prevent_allow\n"));
5299
5300	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5301	cdb = (struct scsi_prevent *)ctsio->cdb;
5302
5303	if ((lun->flags & CTL_LUN_REMOVABLE) == 0) {
5304		ctl_set_invalid_opcode(ctsio);
5305		ctl_done((union ctl_io *)ctsio);
5306		return (CTL_RETVAL_COMPLETE);
5307	}
5308
5309	initidx = ctl_get_initindex(&ctsio->io_hdr.nexus);
5310	mtx_lock(&lun->lun_lock);
5311	if ((cdb->how & PR_PREVENT) &&
5312	    ctl_is_set(lun->prevent, initidx) == 0) {
5313		ctl_set_mask(lun->prevent, initidx);
5314		lun->prevent_count++;
5315	} else if ((cdb->how & PR_PREVENT) == 0 &&
5316	    ctl_is_set(lun->prevent, initidx)) {
5317		ctl_clear_mask(lun->prevent, initidx);
5318		lun->prevent_count--;
5319	}
5320	mtx_unlock(&lun->lun_lock);
5321	retval = lun->backend->config_write((union ctl_io *)ctsio);
5322	return (retval);
5323}
5324
5325/*
5326 * We support the SYNCHRONIZE CACHE command (10 and 16 byte versions), but
5327 * we don't really do anything with the LBA and length fields if the user
5328 * passes them in.  Instead we'll just flush out the cache for the entire
5329 * LUN.
5330 */
5331int
5332ctl_sync_cache(struct ctl_scsiio *ctsio)
5333{
5334	struct ctl_lun *lun;
5335	struct ctl_softc *softc;
5336	struct ctl_lba_len_flags *lbalen;
5337	uint64_t starting_lba;
5338	uint32_t block_count;
5339	int retval;
5340	uint8_t byte2;
5341
5342	CTL_DEBUG_PRINT(("ctl_sync_cache\n"));
5343
5344	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5345	softc = lun->ctl_softc;
5346	retval = 0;
5347
5348	switch (ctsio->cdb[0]) {
5349	case SYNCHRONIZE_CACHE: {
5350		struct scsi_sync_cache *cdb;
5351		cdb = (struct scsi_sync_cache *)ctsio->cdb;
5352
5353		starting_lba = scsi_4btoul(cdb->begin_lba);
5354		block_count = scsi_2btoul(cdb->lb_count);
5355		byte2 = cdb->byte2;
5356		break;
5357	}
5358	case SYNCHRONIZE_CACHE_16: {
5359		struct scsi_sync_cache_16 *cdb;
5360		cdb = (struct scsi_sync_cache_16 *)ctsio->cdb;
5361
5362		starting_lba = scsi_8btou64(cdb->begin_lba);
5363		block_count = scsi_4btoul(cdb->lb_count);
5364		byte2 = cdb->byte2;
5365		break;
5366	}
5367	default:
5368		ctl_set_invalid_opcode(ctsio);
5369		ctl_done((union ctl_io *)ctsio);
5370		goto bailout;
5371		break; /* NOTREACHED */
5372	}
5373
5374	/*
5375	 * We check the LBA and length, but don't do anything with them.
5376	 * A SYNCHRONIZE CACHE will cause the entire cache for this lun to
5377	 * get flushed.  This check will just help satisfy anyone who wants
5378	 * to see an error for an out of range LBA.
5379	 */
5380	if ((starting_lba + block_count) > (lun->be_lun->maxlba + 1)) {
5381		ctl_set_lba_out_of_range(ctsio,
5382		    MAX(starting_lba, lun->be_lun->maxlba + 1));
5383		ctl_done((union ctl_io *)ctsio);
5384		goto bailout;
5385	}
5386
5387	lbalen = (struct ctl_lba_len_flags *)&ctsio->io_hdr.ctl_private[CTL_PRIV_LBA_LEN];
5388	lbalen->lba = starting_lba;
5389	lbalen->len = block_count;
5390	lbalen->flags = byte2;
5391	retval = lun->backend->config_write((union ctl_io *)ctsio);
5392
5393bailout:
5394	return (retval);
5395}
5396
5397int
5398ctl_format(struct ctl_scsiio *ctsio)
5399{
5400	struct scsi_format *cdb;
5401	struct ctl_lun *lun;
5402	int length, defect_list_len;
5403
5404	CTL_DEBUG_PRINT(("ctl_format\n"));
5405
5406	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5407
5408	cdb = (struct scsi_format *)ctsio->cdb;
5409
5410	length = 0;
5411	if (cdb->byte2 & SF_FMTDATA) {
5412		if (cdb->byte2 & SF_LONGLIST)
5413			length = sizeof(struct scsi_format_header_long);
5414		else
5415			length = sizeof(struct scsi_format_header_short);
5416	}
5417
5418	if (((ctsio->io_hdr.flags & CTL_FLAG_ALLOCATED) == 0)
5419	 && (length > 0)) {
5420		ctsio->kern_data_ptr = malloc(length, M_CTL, M_WAITOK);
5421		ctsio->kern_data_len = length;
5422		ctsio->kern_total_len = length;
5423		ctsio->kern_data_resid = 0;
5424		ctsio->kern_rel_offset = 0;
5425		ctsio->kern_sg_entries = 0;
5426		ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
5427		ctsio->be_move_done = ctl_config_move_done;
5428		ctl_datamove((union ctl_io *)ctsio);
5429
5430		return (CTL_RETVAL_COMPLETE);
5431	}
5432
5433	defect_list_len = 0;
5434
5435	if (cdb->byte2 & SF_FMTDATA) {
5436		if (cdb->byte2 & SF_LONGLIST) {
5437			struct scsi_format_header_long *header;
5438
5439			header = (struct scsi_format_header_long *)
5440				ctsio->kern_data_ptr;
5441
5442			defect_list_len = scsi_4btoul(header->defect_list_len);
5443			if (defect_list_len != 0) {
5444				ctl_set_invalid_field(ctsio,
5445						      /*sks_valid*/ 1,
5446						      /*command*/ 0,
5447						      /*field*/ 2,
5448						      /*bit_valid*/ 0,
5449						      /*bit*/ 0);
5450				goto bailout;
5451			}
5452		} else {
5453			struct scsi_format_header_short *header;
5454
5455			header = (struct scsi_format_header_short *)
5456				ctsio->kern_data_ptr;
5457
5458			defect_list_len = scsi_2btoul(header->defect_list_len);
5459			if (defect_list_len != 0) {
5460				ctl_set_invalid_field(ctsio,
5461						      /*sks_valid*/ 1,
5462						      /*command*/ 0,
5463						      /*field*/ 2,
5464						      /*bit_valid*/ 0,
5465						      /*bit*/ 0);
5466				goto bailout;
5467			}
5468		}
5469	}
5470
5471	ctl_set_success(ctsio);
5472bailout:
5473
5474	if (ctsio->io_hdr.flags & CTL_FLAG_ALLOCATED) {
5475		free(ctsio->kern_data_ptr, M_CTL);
5476		ctsio->io_hdr.flags &= ~CTL_FLAG_ALLOCATED;
5477	}
5478
5479	ctl_done((union ctl_io *)ctsio);
5480	return (CTL_RETVAL_COMPLETE);
5481}
5482
5483int
5484ctl_read_buffer(struct ctl_scsiio *ctsio)
5485{
5486	struct ctl_lun *lun;
5487	uint64_t buffer_offset;
5488	uint32_t len;
5489	uint8_t byte2;
5490	static uint8_t descr[4];
5491	static uint8_t echo_descr[4] = { 0 };
5492
5493	CTL_DEBUG_PRINT(("ctl_read_buffer\n"));
5494	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5495	switch (ctsio->cdb[0]) {
5496	case READ_BUFFER: {
5497		struct scsi_read_buffer *cdb;
5498
5499		cdb = (struct scsi_read_buffer *)ctsio->cdb;
5500		buffer_offset = scsi_3btoul(cdb->offset);
5501		len = scsi_3btoul(cdb->length);
5502		byte2 = cdb->byte2;
5503		break;
5504	}
5505	case READ_BUFFER_16: {
5506		struct scsi_read_buffer_16 *cdb;
5507
5508		cdb = (struct scsi_read_buffer_16 *)ctsio->cdb;
5509		buffer_offset = scsi_8btou64(cdb->offset);
5510		len = scsi_4btoul(cdb->length);
5511		byte2 = cdb->byte2;
5512		break;
5513	}
5514	default: /* This shouldn't happen. */
5515		ctl_set_invalid_opcode(ctsio);
5516		ctl_done((union ctl_io *)ctsio);
5517		return (CTL_RETVAL_COMPLETE);
5518	}
5519
5520	if ((byte2 & RWB_MODE) != RWB_MODE_DATA &&
5521	    (byte2 & RWB_MODE) != RWB_MODE_ECHO_DESCR &&
5522	    (byte2 & RWB_MODE) != RWB_MODE_DESCR) {
5523		ctl_set_invalid_field(ctsio,
5524				      /*sks_valid*/ 1,
5525				      /*command*/ 1,
5526				      /*field*/ 1,
5527				      /*bit_valid*/ 1,
5528				      /*bit*/ 4);
5529		ctl_done((union ctl_io *)ctsio);
5530		return (CTL_RETVAL_COMPLETE);
5531	}
5532
5533	if (buffer_offset > CTL_WRITE_BUFFER_SIZE ||
5534	    buffer_offset + len > CTL_WRITE_BUFFER_SIZE) {
5535		ctl_set_invalid_field(ctsio,
5536				      /*sks_valid*/ 1,
5537				      /*command*/ 1,
5538				      /*field*/ 6,
5539				      /*bit_valid*/ 0,
5540				      /*bit*/ 0);
5541		ctl_done((union ctl_io *)ctsio);
5542		return (CTL_RETVAL_COMPLETE);
5543	}
5544
5545	if ((byte2 & RWB_MODE) == RWB_MODE_DESCR) {
5546		descr[0] = 0;
5547		scsi_ulto3b(CTL_WRITE_BUFFER_SIZE, &descr[1]);
5548		ctsio->kern_data_ptr = descr;
5549		len = min(len, sizeof(descr));
5550	} else if ((byte2 & RWB_MODE) == RWB_MODE_ECHO_DESCR) {
5551		ctsio->kern_data_ptr = echo_descr;
5552		len = min(len, sizeof(echo_descr));
5553	} else {
5554		if (lun->write_buffer == NULL) {
5555			lun->write_buffer = malloc(CTL_WRITE_BUFFER_SIZE,
5556			    M_CTL, M_WAITOK);
5557		}
5558		ctsio->kern_data_ptr = lun->write_buffer + buffer_offset;
5559	}
5560	ctsio->kern_data_len = len;
5561	ctsio->kern_total_len = len;
5562	ctsio->kern_data_resid = 0;
5563	ctsio->kern_rel_offset = 0;
5564	ctsio->kern_sg_entries = 0;
5565	ctl_set_success(ctsio);
5566	ctsio->be_move_done = ctl_config_move_done;
5567	ctl_datamove((union ctl_io *)ctsio);
5568	return (CTL_RETVAL_COMPLETE);
5569}
5570
5571int
5572ctl_write_buffer(struct ctl_scsiio *ctsio)
5573{
5574	struct scsi_write_buffer *cdb;
5575	struct ctl_lun *lun;
5576	int buffer_offset, len;
5577
5578	CTL_DEBUG_PRINT(("ctl_write_buffer\n"));
5579
5580	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5581	cdb = (struct scsi_write_buffer *)ctsio->cdb;
5582
5583	if ((cdb->byte2 & RWB_MODE) != RWB_MODE_DATA) {
5584		ctl_set_invalid_field(ctsio,
5585				      /*sks_valid*/ 1,
5586				      /*command*/ 1,
5587				      /*field*/ 1,
5588				      /*bit_valid*/ 1,
5589				      /*bit*/ 4);
5590		ctl_done((union ctl_io *)ctsio);
5591		return (CTL_RETVAL_COMPLETE);
5592	}
5593
5594	len = scsi_3btoul(cdb->length);
5595	buffer_offset = scsi_3btoul(cdb->offset);
5596
5597	if (buffer_offset + len > CTL_WRITE_BUFFER_SIZE) {
5598		ctl_set_invalid_field(ctsio,
5599				      /*sks_valid*/ 1,
5600				      /*command*/ 1,
5601				      /*field*/ 6,
5602				      /*bit_valid*/ 0,
5603				      /*bit*/ 0);
5604		ctl_done((union ctl_io *)ctsio);
5605		return (CTL_RETVAL_COMPLETE);
5606	}
5607
5608	/*
5609	 * If we've got a kernel request that hasn't been malloced yet,
5610	 * malloc it and tell the caller the data buffer is here.
5611	 */
5612	if ((ctsio->io_hdr.flags & CTL_FLAG_ALLOCATED) == 0) {
5613		if (lun->write_buffer == NULL) {
5614			lun->write_buffer = malloc(CTL_WRITE_BUFFER_SIZE,
5615			    M_CTL, M_WAITOK);
5616		}
5617		ctsio->kern_data_ptr = lun->write_buffer + buffer_offset;
5618		ctsio->kern_data_len = len;
5619		ctsio->kern_total_len = len;
5620		ctsio->kern_data_resid = 0;
5621		ctsio->kern_rel_offset = 0;
5622		ctsio->kern_sg_entries = 0;
5623		ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
5624		ctsio->be_move_done = ctl_config_move_done;
5625		ctl_datamove((union ctl_io *)ctsio);
5626
5627		return (CTL_RETVAL_COMPLETE);
5628	}
5629
5630	ctl_set_success(ctsio);
5631	ctl_done((union ctl_io *)ctsio);
5632	return (CTL_RETVAL_COMPLETE);
5633}
5634
5635int
5636ctl_write_same(struct ctl_scsiio *ctsio)
5637{
5638	struct ctl_lun *lun;
5639	struct ctl_lba_len_flags *lbalen;
5640	uint64_t lba;
5641	uint32_t num_blocks;
5642	int len, retval;
5643	uint8_t byte2;
5644
5645	CTL_DEBUG_PRINT(("ctl_write_same\n"));
5646
5647	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5648
5649	switch (ctsio->cdb[0]) {
5650	case WRITE_SAME_10: {
5651		struct scsi_write_same_10 *cdb;
5652
5653		cdb = (struct scsi_write_same_10 *)ctsio->cdb;
5654
5655		lba = scsi_4btoul(cdb->addr);
5656		num_blocks = scsi_2btoul(cdb->length);
5657		byte2 = cdb->byte2;
5658		break;
5659	}
5660	case WRITE_SAME_16: {
5661		struct scsi_write_same_16 *cdb;
5662
5663		cdb = (struct scsi_write_same_16 *)ctsio->cdb;
5664
5665		lba = scsi_8btou64(cdb->addr);
5666		num_blocks = scsi_4btoul(cdb->length);
5667		byte2 = cdb->byte2;
5668		break;
5669	}
5670	default:
5671		/*
5672		 * We got a command we don't support.  This shouldn't
5673		 * happen, commands should be filtered out above us.
5674		 */
5675		ctl_set_invalid_opcode(ctsio);
5676		ctl_done((union ctl_io *)ctsio);
5677
5678		return (CTL_RETVAL_COMPLETE);
5679		break; /* NOTREACHED */
5680	}
5681
5682	/* ANCHOR flag can be used only together with UNMAP */
5683	if ((byte2 & SWS_UNMAP) == 0 && (byte2 & SWS_ANCHOR) != 0) {
5684		ctl_set_invalid_field(ctsio, /*sks_valid*/ 1,
5685		    /*command*/ 1, /*field*/ 1, /*bit_valid*/ 1, /*bit*/ 0);
5686		ctl_done((union ctl_io *)ctsio);
5687		return (CTL_RETVAL_COMPLETE);
5688	}
5689
5690	/*
5691	 * The first check is to make sure we're in bounds, the second
5692	 * check is to catch wrap-around problems.  If the lba + num blocks
5693	 * is less than the lba, then we've wrapped around and the block
5694	 * range is invalid anyway.
5695	 */
5696	if (((lba + num_blocks) > (lun->be_lun->maxlba + 1))
5697	 || ((lba + num_blocks) < lba)) {
5698		ctl_set_lba_out_of_range(ctsio,
5699		    MAX(lba, lun->be_lun->maxlba + 1));
5700		ctl_done((union ctl_io *)ctsio);
5701		return (CTL_RETVAL_COMPLETE);
5702	}
5703
5704	/* Zero number of blocks means "to the last logical block" */
5705	if (num_blocks == 0) {
5706		if ((lun->be_lun->maxlba + 1) - lba > UINT32_MAX) {
5707			ctl_set_invalid_field(ctsio,
5708					      /*sks_valid*/ 0,
5709					      /*command*/ 1,
5710					      /*field*/ 0,
5711					      /*bit_valid*/ 0,
5712					      /*bit*/ 0);
5713			ctl_done((union ctl_io *)ctsio);
5714			return (CTL_RETVAL_COMPLETE);
5715		}
5716		num_blocks = (lun->be_lun->maxlba + 1) - lba;
5717	}
5718
5719	len = lun->be_lun->blocksize;
5720
5721	/*
5722	 * If we've got a kernel request that hasn't been malloced yet,
5723	 * malloc it and tell the caller the data buffer is here.
5724	 */
5725	if ((byte2 & SWS_NDOB) == 0 &&
5726	    (ctsio->io_hdr.flags & CTL_FLAG_ALLOCATED) == 0) {
5727		ctsio->kern_data_ptr = malloc(len, M_CTL, M_WAITOK);
5728		ctsio->kern_data_len = len;
5729		ctsio->kern_total_len = len;
5730		ctsio->kern_data_resid = 0;
5731		ctsio->kern_rel_offset = 0;
5732		ctsio->kern_sg_entries = 0;
5733		ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
5734		ctsio->be_move_done = ctl_config_move_done;
5735		ctl_datamove((union ctl_io *)ctsio);
5736
5737		return (CTL_RETVAL_COMPLETE);
5738	}
5739
5740	lbalen = (struct ctl_lba_len_flags *)&ctsio->io_hdr.ctl_private[CTL_PRIV_LBA_LEN];
5741	lbalen->lba = lba;
5742	lbalen->len = num_blocks;
5743	lbalen->flags = byte2;
5744	retval = lun->backend->config_write((union ctl_io *)ctsio);
5745
5746	return (retval);
5747}
5748
5749int
5750ctl_unmap(struct ctl_scsiio *ctsio)
5751{
5752	struct ctl_lun *lun;
5753	struct scsi_unmap *cdb;
5754	struct ctl_ptr_len_flags *ptrlen;
5755	struct scsi_unmap_header *hdr;
5756	struct scsi_unmap_desc *buf, *end, *endnz, *range;
5757	uint64_t lba;
5758	uint32_t num_blocks;
5759	int len, retval;
5760	uint8_t byte2;
5761
5762	CTL_DEBUG_PRINT(("ctl_unmap\n"));
5763
5764	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5765	cdb = (struct scsi_unmap *)ctsio->cdb;
5766
5767	len = scsi_2btoul(cdb->length);
5768	byte2 = cdb->byte2;
5769
5770	/*
5771	 * If we've got a kernel request that hasn't been malloced yet,
5772	 * malloc it and tell the caller the data buffer is here.
5773	 */
5774	if ((ctsio->io_hdr.flags & CTL_FLAG_ALLOCATED) == 0) {
5775		ctsio->kern_data_ptr = malloc(len, M_CTL, M_WAITOK);
5776		ctsio->kern_data_len = len;
5777		ctsio->kern_total_len = len;
5778		ctsio->kern_data_resid = 0;
5779		ctsio->kern_rel_offset = 0;
5780		ctsio->kern_sg_entries = 0;
5781		ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
5782		ctsio->be_move_done = ctl_config_move_done;
5783		ctl_datamove((union ctl_io *)ctsio);
5784
5785		return (CTL_RETVAL_COMPLETE);
5786	}
5787
5788	len = ctsio->kern_total_len - ctsio->kern_data_resid;
5789	hdr = (struct scsi_unmap_header *)ctsio->kern_data_ptr;
5790	if (len < sizeof (*hdr) ||
5791	    len < (scsi_2btoul(hdr->length) + sizeof(hdr->length)) ||
5792	    len < (scsi_2btoul(hdr->desc_length) + sizeof (*hdr)) ||
5793	    scsi_2btoul(hdr->desc_length) % sizeof(*buf) != 0) {
5794		ctl_set_invalid_field(ctsio,
5795				      /*sks_valid*/ 0,
5796				      /*command*/ 0,
5797				      /*field*/ 0,
5798				      /*bit_valid*/ 0,
5799				      /*bit*/ 0);
5800		goto done;
5801	}
5802	len = scsi_2btoul(hdr->desc_length);
5803	buf = (struct scsi_unmap_desc *)(hdr + 1);
5804	end = buf + len / sizeof(*buf);
5805
5806	endnz = buf;
5807	for (range = buf; range < end; range++) {
5808		lba = scsi_8btou64(range->lba);
5809		num_blocks = scsi_4btoul(range->length);
5810		if (((lba + num_blocks) > (lun->be_lun->maxlba + 1))
5811		 || ((lba + num_blocks) < lba)) {
5812			ctl_set_lba_out_of_range(ctsio,
5813			    MAX(lba, lun->be_lun->maxlba + 1));
5814			ctl_done((union ctl_io *)ctsio);
5815			return (CTL_RETVAL_COMPLETE);
5816		}
5817		if (num_blocks != 0)
5818			endnz = range + 1;
5819	}
5820
5821	/*
5822	 * Block backend can not handle zero last range.
5823	 * Filter it out and return if there is nothing left.
5824	 */
5825	len = (uint8_t *)endnz - (uint8_t *)buf;
5826	if (len == 0) {
5827		ctl_set_success(ctsio);
5828		goto done;
5829	}
5830
5831	mtx_lock(&lun->lun_lock);
5832	ptrlen = (struct ctl_ptr_len_flags *)
5833	    &ctsio->io_hdr.ctl_private[CTL_PRIV_LBA_LEN];
5834	ptrlen->ptr = (void *)buf;
5835	ptrlen->len = len;
5836	ptrlen->flags = byte2;
5837	ctl_check_blocked(lun);
5838	mtx_unlock(&lun->lun_lock);
5839
5840	retval = lun->backend->config_write((union ctl_io *)ctsio);
5841	return (retval);
5842
5843done:
5844	if (ctsio->io_hdr.flags & CTL_FLAG_ALLOCATED) {
5845		free(ctsio->kern_data_ptr, M_CTL);
5846		ctsio->io_hdr.flags &= ~CTL_FLAG_ALLOCATED;
5847	}
5848	ctl_done((union ctl_io *)ctsio);
5849	return (CTL_RETVAL_COMPLETE);
5850}
5851
5852int
5853ctl_default_page_handler(struct ctl_scsiio *ctsio,
5854			 struct ctl_page_index *page_index, uint8_t *page_ptr)
5855{
5856	struct ctl_lun *lun;
5857	uint8_t *current_cp, *saved_cp;
5858	int set_ua;
5859	uint32_t initidx;
5860
5861	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5862	initidx = ctl_get_initindex(&ctsio->io_hdr.nexus);
5863	set_ua = 0;
5864
5865	current_cp = (page_index->page_data + (page_index->page_len *
5866	    CTL_PAGE_CURRENT));
5867	saved_cp = (page_index->page_data + (page_index->page_len *
5868	    CTL_PAGE_SAVED));
5869
5870	mtx_lock(&lun->lun_lock);
5871	if (memcmp(current_cp, page_ptr, page_index->page_len)) {
5872		memcpy(current_cp, page_ptr, page_index->page_len);
5873		memcpy(saved_cp, page_ptr, page_index->page_len);
5874		set_ua = 1;
5875	}
5876	if (set_ua != 0)
5877		ctl_est_ua_all(lun, initidx, CTL_UA_MODE_CHANGE);
5878	mtx_unlock(&lun->lun_lock);
5879	if (set_ua) {
5880		ctl_isc_announce_mode(lun,
5881		    ctl_get_initindex(&ctsio->io_hdr.nexus),
5882		    page_index->page_code, page_index->subpage);
5883	}
5884	return (CTL_RETVAL_COMPLETE);
5885}
5886
5887static void
5888ctl_ie_timer(void *arg)
5889{
5890	struct ctl_lun *lun = arg;
5891	uint64_t t;
5892
5893	if (lun->ie_asc == 0)
5894		return;
5895
5896	if (lun->MODE_IE.mrie == SIEP_MRIE_UA)
5897		ctl_est_ua_all(lun, -1, CTL_UA_IE);
5898	else
5899		lun->ie_reported = 0;
5900
5901	if (lun->ie_reportcnt < scsi_4btoul(lun->MODE_IE.report_count)) {
5902		lun->ie_reportcnt++;
5903		t = scsi_4btoul(lun->MODE_IE.interval_timer);
5904		if (t == 0 || t == UINT32_MAX)
5905			t = 3000;  /* 5 min */
5906		callout_schedule(&lun->ie_callout, t * hz / 10);
5907	}
5908}
5909
5910int
5911ctl_ie_page_handler(struct ctl_scsiio *ctsio,
5912			 struct ctl_page_index *page_index, uint8_t *page_ptr)
5913{
5914	struct scsi_info_exceptions_page *pg;
5915	struct ctl_lun *lun;
5916	uint64_t t;
5917
5918	(void)ctl_default_page_handler(ctsio, page_index, page_ptr);
5919
5920	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5921	pg = (struct scsi_info_exceptions_page *)page_ptr;
5922	mtx_lock(&lun->lun_lock);
5923	if (pg->info_flags & SIEP_FLAGS_TEST) {
5924		lun->ie_asc = 0x5d;
5925		lun->ie_ascq = 0xff;
5926		if (pg->mrie == SIEP_MRIE_UA) {
5927			ctl_est_ua_all(lun, -1, CTL_UA_IE);
5928			lun->ie_reported = 1;
5929		} else {
5930			ctl_clr_ua_all(lun, -1, CTL_UA_IE);
5931			lun->ie_reported = -1;
5932		}
5933		lun->ie_reportcnt = 1;
5934		if (lun->ie_reportcnt < scsi_4btoul(pg->report_count)) {
5935			lun->ie_reportcnt++;
5936			t = scsi_4btoul(pg->interval_timer);
5937			if (t == 0 || t == UINT32_MAX)
5938				t = 3000;  /* 5 min */
5939			callout_reset(&lun->ie_callout, t * hz / 10,
5940			    ctl_ie_timer, lun);
5941		}
5942	} else {
5943		lun->ie_asc = 0;
5944		lun->ie_ascq = 0;
5945		lun->ie_reported = 1;
5946		ctl_clr_ua_all(lun, -1, CTL_UA_IE);
5947		lun->ie_reportcnt = UINT32_MAX;
5948		callout_stop(&lun->ie_callout);
5949	}
5950	mtx_unlock(&lun->lun_lock);
5951	return (CTL_RETVAL_COMPLETE);
5952}
5953
5954static int
5955ctl_do_mode_select(union ctl_io *io)
5956{
5957	struct scsi_mode_page_header *page_header;
5958	struct ctl_page_index *page_index;
5959	struct ctl_scsiio *ctsio;
5960	int page_len, page_len_offset, page_len_size;
5961	union ctl_modepage_info *modepage_info;
5962	struct ctl_lun *lun;
5963	int *len_left, *len_used;
5964	int retval, i;
5965
5966	ctsio = &io->scsiio;
5967	page_index = NULL;
5968	page_len = 0;
5969	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5970
5971	modepage_info = (union ctl_modepage_info *)
5972		ctsio->io_hdr.ctl_private[CTL_PRIV_MODEPAGE].bytes;
5973	len_left = &modepage_info->header.len_left;
5974	len_used = &modepage_info->header.len_used;
5975
5976do_next_page:
5977
5978	page_header = (struct scsi_mode_page_header *)
5979		(ctsio->kern_data_ptr + *len_used);
5980
5981	if (*len_left == 0) {
5982		free(ctsio->kern_data_ptr, M_CTL);
5983		ctl_set_success(ctsio);
5984		ctl_done((union ctl_io *)ctsio);
5985		return (CTL_RETVAL_COMPLETE);
5986	} else if (*len_left < sizeof(struct scsi_mode_page_header)) {
5987
5988		free(ctsio->kern_data_ptr, M_CTL);
5989		ctl_set_param_len_error(ctsio);
5990		ctl_done((union ctl_io *)ctsio);
5991		return (CTL_RETVAL_COMPLETE);
5992
5993	} else if ((page_header->page_code & SMPH_SPF)
5994		&& (*len_left < sizeof(struct scsi_mode_page_header_sp))) {
5995
5996		free(ctsio->kern_data_ptr, M_CTL);
5997		ctl_set_param_len_error(ctsio);
5998		ctl_done((union ctl_io *)ctsio);
5999		return (CTL_RETVAL_COMPLETE);
6000	}
6001
6002
6003	/*
6004	 * XXX KDM should we do something with the block descriptor?
6005	 */
6006	for (i = 0; i < CTL_NUM_MODE_PAGES; i++) {
6007		page_index = &lun->mode_pages.index[i];
6008		if (lun->be_lun->lun_type == T_DIRECT &&
6009		    (page_index->page_flags & CTL_PAGE_FLAG_DIRECT) == 0)
6010			continue;
6011		if (lun->be_lun->lun_type == T_PROCESSOR &&
6012		    (page_index->page_flags & CTL_PAGE_FLAG_PROC) == 0)
6013			continue;
6014		if (lun->be_lun->lun_type == T_CDROM &&
6015		    (page_index->page_flags & CTL_PAGE_FLAG_CDROM) == 0)
6016			continue;
6017
6018		if ((page_index->page_code & SMPH_PC_MASK) !=
6019		    (page_header->page_code & SMPH_PC_MASK))
6020			continue;
6021
6022		/*
6023		 * If neither page has a subpage code, then we've got a
6024		 * match.
6025		 */
6026		if (((page_index->page_code & SMPH_SPF) == 0)
6027		 && ((page_header->page_code & SMPH_SPF) == 0)) {
6028			page_len = page_header->page_length;
6029			break;
6030		}
6031
6032		/*
6033		 * If both pages have subpages, then the subpage numbers
6034		 * have to match.
6035		 */
6036		if ((page_index->page_code & SMPH_SPF)
6037		  && (page_header->page_code & SMPH_SPF)) {
6038			struct scsi_mode_page_header_sp *sph;
6039
6040			sph = (struct scsi_mode_page_header_sp *)page_header;
6041			if (page_index->subpage == sph->subpage) {
6042				page_len = scsi_2btoul(sph->page_length);
6043				break;
6044			}
6045		}
6046	}
6047
6048	/*
6049	 * If we couldn't find the page, or if we don't have a mode select
6050	 * handler for it, send back an error to the user.
6051	 */
6052	if ((i >= CTL_NUM_MODE_PAGES)
6053	 || (page_index->select_handler == NULL)) {
6054		ctl_set_invalid_field(ctsio,
6055				      /*sks_valid*/ 1,
6056				      /*command*/ 0,
6057				      /*field*/ *len_used,
6058				      /*bit_valid*/ 0,
6059				      /*bit*/ 0);
6060		free(ctsio->kern_data_ptr, M_CTL);
6061		ctl_done((union ctl_io *)ctsio);
6062		return (CTL_RETVAL_COMPLETE);
6063	}
6064
6065	if (page_index->page_code & SMPH_SPF) {
6066		page_len_offset = 2;
6067		page_len_size = 2;
6068	} else {
6069		page_len_size = 1;
6070		page_len_offset = 1;
6071	}
6072
6073	/*
6074	 * If the length the initiator gives us isn't the one we specify in
6075	 * the mode page header, or if they didn't specify enough data in
6076	 * the CDB to avoid truncating this page, kick out the request.
6077	 */
6078	if (page_len != page_index->page_len - page_len_offset - page_len_size) {
6079		ctl_set_invalid_field(ctsio,
6080				      /*sks_valid*/ 1,
6081				      /*command*/ 0,
6082				      /*field*/ *len_used + page_len_offset,
6083				      /*bit_valid*/ 0,
6084				      /*bit*/ 0);
6085		free(ctsio->kern_data_ptr, M_CTL);
6086		ctl_done((union ctl_io *)ctsio);
6087		return (CTL_RETVAL_COMPLETE);
6088	}
6089	if (*len_left < page_index->page_len) {
6090		free(ctsio->kern_data_ptr, M_CTL);
6091		ctl_set_param_len_error(ctsio);
6092		ctl_done((union ctl_io *)ctsio);
6093		return (CTL_RETVAL_COMPLETE);
6094	}
6095
6096	/*
6097	 * Run through the mode page, checking to make sure that the bits
6098	 * the user changed are actually legal for him to change.
6099	 */
6100	for (i = 0; i < page_index->page_len; i++) {
6101		uint8_t *user_byte, *change_mask, *current_byte;
6102		int bad_bit;
6103		int j;
6104
6105		user_byte = (uint8_t *)page_header + i;
6106		change_mask = page_index->page_data +
6107			      (page_index->page_len * CTL_PAGE_CHANGEABLE) + i;
6108		current_byte = page_index->page_data +
6109			       (page_index->page_len * CTL_PAGE_CURRENT) + i;
6110
6111		/*
6112		 * Check to see whether the user set any bits in this byte
6113		 * that he is not allowed to set.
6114		 */
6115		if ((*user_byte & ~(*change_mask)) ==
6116		    (*current_byte & ~(*change_mask)))
6117			continue;
6118
6119		/*
6120		 * Go through bit by bit to determine which one is illegal.
6121		 */
6122		bad_bit = 0;
6123		for (j = 7; j >= 0; j--) {
6124			if ((((1 << i) & ~(*change_mask)) & *user_byte) !=
6125			    (((1 << i) & ~(*change_mask)) & *current_byte)) {
6126				bad_bit = i;
6127				break;
6128			}
6129		}
6130		ctl_set_invalid_field(ctsio,
6131				      /*sks_valid*/ 1,
6132				      /*command*/ 0,
6133				      /*field*/ *len_used + i,
6134				      /*bit_valid*/ 1,
6135				      /*bit*/ bad_bit);
6136		free(ctsio->kern_data_ptr, M_CTL);
6137		ctl_done((union ctl_io *)ctsio);
6138		return (CTL_RETVAL_COMPLETE);
6139	}
6140
6141	/*
6142	 * Decrement these before we call the page handler, since we may
6143	 * end up getting called back one way or another before the handler
6144	 * returns to this context.
6145	 */
6146	*len_left -= page_index->page_len;
6147	*len_used += page_index->page_len;
6148
6149	retval = page_index->select_handler(ctsio, page_index,
6150					    (uint8_t *)page_header);
6151
6152	/*
6153	 * If the page handler returns CTL_RETVAL_QUEUED, then we need to
6154	 * wait until this queued command completes to finish processing
6155	 * the mode page.  If it returns anything other than
6156	 * CTL_RETVAL_COMPLETE (e.g. CTL_RETVAL_ERROR), then it should have
6157	 * already set the sense information, freed the data pointer, and
6158	 * completed the io for us.
6159	 */
6160	if (retval != CTL_RETVAL_COMPLETE)
6161		goto bailout_no_done;
6162
6163	/*
6164	 * If the initiator sent us more than one page, parse the next one.
6165	 */
6166	if (*len_left > 0)
6167		goto do_next_page;
6168
6169	ctl_set_success(ctsio);
6170	free(ctsio->kern_data_ptr, M_CTL);
6171	ctl_done((union ctl_io *)ctsio);
6172
6173bailout_no_done:
6174
6175	return (CTL_RETVAL_COMPLETE);
6176
6177}
6178
6179int
6180ctl_mode_select(struct ctl_scsiio *ctsio)
6181{
6182	int param_len, pf, sp;
6183	int header_size, bd_len;
6184	union ctl_modepage_info *modepage_info;
6185
6186	switch (ctsio->cdb[0]) {
6187	case MODE_SELECT_6: {
6188		struct scsi_mode_select_6 *cdb;
6189
6190		cdb = (struct scsi_mode_select_6 *)ctsio->cdb;
6191
6192		pf = (cdb->byte2 & SMS_PF) ? 1 : 0;
6193		sp = (cdb->byte2 & SMS_SP) ? 1 : 0;
6194		param_len = cdb->length;
6195		header_size = sizeof(struct scsi_mode_header_6);
6196		break;
6197	}
6198	case MODE_SELECT_10: {
6199		struct scsi_mode_select_10 *cdb;
6200
6201		cdb = (struct scsi_mode_select_10 *)ctsio->cdb;
6202
6203		pf = (cdb->byte2 & SMS_PF) ? 1 : 0;
6204		sp = (cdb->byte2 & SMS_SP) ? 1 : 0;
6205		param_len = scsi_2btoul(cdb->length);
6206		header_size = sizeof(struct scsi_mode_header_10);
6207		break;
6208	}
6209	default:
6210		ctl_set_invalid_opcode(ctsio);
6211		ctl_done((union ctl_io *)ctsio);
6212		return (CTL_RETVAL_COMPLETE);
6213	}
6214
6215	/*
6216	 * From SPC-3:
6217	 * "A parameter list length of zero indicates that the Data-Out Buffer
6218	 * shall be empty. This condition shall not be considered as an error."
6219	 */
6220	if (param_len == 0) {
6221		ctl_set_success(ctsio);
6222		ctl_done((union ctl_io *)ctsio);
6223		return (CTL_RETVAL_COMPLETE);
6224	}
6225
6226	/*
6227	 * Since we'll hit this the first time through, prior to
6228	 * allocation, we don't need to free a data buffer here.
6229	 */
6230	if (param_len < header_size) {
6231		ctl_set_param_len_error(ctsio);
6232		ctl_done((union ctl_io *)ctsio);
6233		return (CTL_RETVAL_COMPLETE);
6234	}
6235
6236	/*
6237	 * Allocate the data buffer and grab the user's data.  In theory,
6238	 * we shouldn't have to sanity check the parameter list length here
6239	 * because the maximum size is 64K.  We should be able to malloc
6240	 * that much without too many problems.
6241	 */
6242	if ((ctsio->io_hdr.flags & CTL_FLAG_ALLOCATED) == 0) {
6243		ctsio->kern_data_ptr = malloc(param_len, M_CTL, M_WAITOK);
6244		ctsio->kern_data_len = param_len;
6245		ctsio->kern_total_len = param_len;
6246		ctsio->kern_data_resid = 0;
6247		ctsio->kern_rel_offset = 0;
6248		ctsio->kern_sg_entries = 0;
6249		ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
6250		ctsio->be_move_done = ctl_config_move_done;
6251		ctl_datamove((union ctl_io *)ctsio);
6252
6253		return (CTL_RETVAL_COMPLETE);
6254	}
6255
6256	switch (ctsio->cdb[0]) {
6257	case MODE_SELECT_6: {
6258		struct scsi_mode_header_6 *mh6;
6259
6260		mh6 = (struct scsi_mode_header_6 *)ctsio->kern_data_ptr;
6261		bd_len = mh6->blk_desc_len;
6262		break;
6263	}
6264	case MODE_SELECT_10: {
6265		struct scsi_mode_header_10 *mh10;
6266
6267		mh10 = (struct scsi_mode_header_10 *)ctsio->kern_data_ptr;
6268		bd_len = scsi_2btoul(mh10->blk_desc_len);
6269		break;
6270	}
6271	default:
6272		panic("%s: Invalid CDB type %#x", __func__, ctsio->cdb[0]);
6273	}
6274
6275	if (param_len < (header_size + bd_len)) {
6276		free(ctsio->kern_data_ptr, M_CTL);
6277		ctl_set_param_len_error(ctsio);
6278		ctl_done((union ctl_io *)ctsio);
6279		return (CTL_RETVAL_COMPLETE);
6280	}
6281
6282	/*
6283	 * Set the IO_CONT flag, so that if this I/O gets passed to
6284	 * ctl_config_write_done(), it'll get passed back to
6285	 * ctl_do_mode_select() for further processing, or completion if
6286	 * we're all done.
6287	 */
6288	ctsio->io_hdr.flags |= CTL_FLAG_IO_CONT;
6289	ctsio->io_cont = ctl_do_mode_select;
6290
6291	modepage_info = (union ctl_modepage_info *)
6292		ctsio->io_hdr.ctl_private[CTL_PRIV_MODEPAGE].bytes;
6293	memset(modepage_info, 0, sizeof(*modepage_info));
6294	modepage_info->header.len_left = param_len - header_size - bd_len;
6295	modepage_info->header.len_used = header_size + bd_len;
6296
6297	return (ctl_do_mode_select((union ctl_io *)ctsio));
6298}
6299
6300int
6301ctl_mode_sense(struct ctl_scsiio *ctsio)
6302{
6303	struct ctl_lun *lun;
6304	int pc, page_code, dbd, llba, subpage;
6305	int alloc_len, page_len, header_len, total_len;
6306	struct scsi_mode_block_descr *block_desc;
6307	struct ctl_page_index *page_index;
6308
6309	dbd = 0;
6310	llba = 0;
6311	block_desc = NULL;
6312
6313	CTL_DEBUG_PRINT(("ctl_mode_sense\n"));
6314
6315	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
6316	switch (ctsio->cdb[0]) {
6317	case MODE_SENSE_6: {
6318		struct scsi_mode_sense_6 *cdb;
6319
6320		cdb = (struct scsi_mode_sense_6 *)ctsio->cdb;
6321
6322		header_len = sizeof(struct scsi_mode_hdr_6);
6323		if (cdb->byte2 & SMS_DBD)
6324			dbd = 1;
6325		else
6326			header_len += sizeof(struct scsi_mode_block_descr);
6327
6328		pc = (cdb->page & SMS_PAGE_CTRL_MASK) >> 6;
6329		page_code = cdb->page & SMS_PAGE_CODE;
6330		subpage = cdb->subpage;
6331		alloc_len = cdb->length;
6332		break;
6333	}
6334	case MODE_SENSE_10: {
6335		struct scsi_mode_sense_10 *cdb;
6336
6337		cdb = (struct scsi_mode_sense_10 *)ctsio->cdb;
6338
6339		header_len = sizeof(struct scsi_mode_hdr_10);
6340
6341		if (cdb->byte2 & SMS_DBD)
6342			dbd = 1;
6343		else
6344			header_len += sizeof(struct scsi_mode_block_descr);
6345		if (cdb->byte2 & SMS10_LLBAA)
6346			llba = 1;
6347		pc = (cdb->page & SMS_PAGE_CTRL_MASK) >> 6;
6348		page_code = cdb->page & SMS_PAGE_CODE;
6349		subpage = cdb->subpage;
6350		alloc_len = scsi_2btoul(cdb->length);
6351		break;
6352	}
6353	default:
6354		ctl_set_invalid_opcode(ctsio);
6355		ctl_done((union ctl_io *)ctsio);
6356		return (CTL_RETVAL_COMPLETE);
6357		break; /* NOTREACHED */
6358	}
6359
6360	/*
6361	 * We have to make a first pass through to calculate the size of
6362	 * the pages that match the user's query.  Then we allocate enough
6363	 * memory to hold it, and actually copy the data into the buffer.
6364	 */
6365	switch (page_code) {
6366	case SMS_ALL_PAGES_PAGE: {
6367		u_int i;
6368
6369		page_len = 0;
6370
6371		/*
6372		 * At the moment, values other than 0 and 0xff here are
6373		 * reserved according to SPC-3.
6374		 */
6375		if ((subpage != SMS_SUBPAGE_PAGE_0)
6376		 && (subpage != SMS_SUBPAGE_ALL)) {
6377			ctl_set_invalid_field(ctsio,
6378					      /*sks_valid*/ 1,
6379					      /*command*/ 1,
6380					      /*field*/ 3,
6381					      /*bit_valid*/ 0,
6382					      /*bit*/ 0);
6383			ctl_done((union ctl_io *)ctsio);
6384			return (CTL_RETVAL_COMPLETE);
6385		}
6386
6387		for (i = 0; i < CTL_NUM_MODE_PAGES; i++) {
6388			page_index = &lun->mode_pages.index[i];
6389
6390			/* Make sure the page is supported for this dev type */
6391			if (lun->be_lun->lun_type == T_DIRECT &&
6392			    (page_index->page_flags & CTL_PAGE_FLAG_DIRECT) == 0)
6393				continue;
6394			if (lun->be_lun->lun_type == T_PROCESSOR &&
6395			    (page_index->page_flags & CTL_PAGE_FLAG_PROC) == 0)
6396				continue;
6397			if (lun->be_lun->lun_type == T_CDROM &&
6398			    (page_index->page_flags & CTL_PAGE_FLAG_CDROM) == 0)
6399				continue;
6400
6401			/*
6402			 * We don't use this subpage if the user didn't
6403			 * request all subpages.
6404			 */
6405			if ((page_index->subpage != 0)
6406			 && (subpage == SMS_SUBPAGE_PAGE_0))
6407				continue;
6408
6409#if 0
6410			printf("found page %#x len %d\n",
6411			       page_index->page_code & SMPH_PC_MASK,
6412			       page_index->page_len);
6413#endif
6414			page_len += page_index->page_len;
6415		}
6416		break;
6417	}
6418	default: {
6419		u_int i;
6420
6421		page_len = 0;
6422
6423		for (i = 0; i < CTL_NUM_MODE_PAGES; i++) {
6424			page_index = &lun->mode_pages.index[i];
6425
6426			/* Make sure the page is supported for this dev type */
6427			if (lun->be_lun->lun_type == T_DIRECT &&
6428			    (page_index->page_flags & CTL_PAGE_FLAG_DIRECT) == 0)
6429				continue;
6430			if (lun->be_lun->lun_type == T_PROCESSOR &&
6431			    (page_index->page_flags & CTL_PAGE_FLAG_PROC) == 0)
6432				continue;
6433			if (lun->be_lun->lun_type == T_CDROM &&
6434			    (page_index->page_flags & CTL_PAGE_FLAG_CDROM) == 0)
6435				continue;
6436
6437			/* Look for the right page code */
6438			if ((page_index->page_code & SMPH_PC_MASK) != page_code)
6439				continue;
6440
6441			/* Look for the right subpage or the subpage wildcard*/
6442			if ((page_index->subpage != subpage)
6443			 && (subpage != SMS_SUBPAGE_ALL))
6444				continue;
6445
6446#if 0
6447			printf("found page %#x len %d\n",
6448			       page_index->page_code & SMPH_PC_MASK,
6449			       page_index->page_len);
6450#endif
6451
6452			page_len += page_index->page_len;
6453		}
6454
6455		if (page_len == 0) {
6456			ctl_set_invalid_field(ctsio,
6457					      /*sks_valid*/ 1,
6458					      /*command*/ 1,
6459					      /*field*/ 2,
6460					      /*bit_valid*/ 1,
6461					      /*bit*/ 5);
6462			ctl_done((union ctl_io *)ctsio);
6463			return (CTL_RETVAL_COMPLETE);
6464		}
6465		break;
6466	}
6467	}
6468
6469	total_len = header_len + page_len;
6470#if 0
6471	printf("header_len = %d, page_len = %d, total_len = %d\n",
6472	       header_len, page_len, total_len);
6473#endif
6474
6475	ctsio->kern_data_ptr = malloc(total_len, M_CTL, M_WAITOK | M_ZERO);
6476	ctsio->kern_sg_entries = 0;
6477	ctsio->kern_data_resid = 0;
6478	ctsio->kern_rel_offset = 0;
6479	if (total_len < alloc_len) {
6480		ctsio->residual = alloc_len - total_len;
6481		ctsio->kern_data_len = total_len;
6482		ctsio->kern_total_len = total_len;
6483	} else {
6484		ctsio->residual = 0;
6485		ctsio->kern_data_len = alloc_len;
6486		ctsio->kern_total_len = alloc_len;
6487	}
6488
6489	switch (ctsio->cdb[0]) {
6490	case MODE_SENSE_6: {
6491		struct scsi_mode_hdr_6 *header;
6492
6493		header = (struct scsi_mode_hdr_6 *)ctsio->kern_data_ptr;
6494
6495		header->datalen = MIN(total_len - 1, 254);
6496		if (lun->be_lun->lun_type == T_DIRECT) {
6497			header->dev_specific = 0x10; /* DPOFUA */
6498			if ((lun->be_lun->flags & CTL_LUN_FLAG_READONLY) ||
6499			    (lun->MODE_CTRL.eca_and_aen & SCP_SWP) != 0)
6500				header->dev_specific |= 0x80; /* WP */
6501		}
6502		if (dbd)
6503			header->block_descr_len = 0;
6504		else
6505			header->block_descr_len =
6506				sizeof(struct scsi_mode_block_descr);
6507		block_desc = (struct scsi_mode_block_descr *)&header[1];
6508		break;
6509	}
6510	case MODE_SENSE_10: {
6511		struct scsi_mode_hdr_10 *header;
6512		int datalen;
6513
6514		header = (struct scsi_mode_hdr_10 *)ctsio->kern_data_ptr;
6515
6516		datalen = MIN(total_len - 2, 65533);
6517		scsi_ulto2b(datalen, header->datalen);
6518		if (lun->be_lun->lun_type == T_DIRECT) {
6519			header->dev_specific = 0x10; /* DPOFUA */
6520			if ((lun->be_lun->flags & CTL_LUN_FLAG_READONLY) ||
6521			    (lun->MODE_CTRL.eca_and_aen & SCP_SWP) != 0)
6522				header->dev_specific |= 0x80; /* WP */
6523		}
6524		if (dbd)
6525			scsi_ulto2b(0, header->block_descr_len);
6526		else
6527			scsi_ulto2b(sizeof(struct scsi_mode_block_descr),
6528				    header->block_descr_len);
6529		block_desc = (struct scsi_mode_block_descr *)&header[1];
6530		break;
6531	}
6532	default:
6533		panic("%s: Invalid CDB type %#x", __func__, ctsio->cdb[0]);
6534	}
6535
6536	/*
6537	 * If we've got a disk, use its blocksize in the block
6538	 * descriptor.  Otherwise, just set it to 0.
6539	 */
6540	if (dbd == 0) {
6541		if (lun->be_lun->lun_type == T_DIRECT)
6542			scsi_ulto3b(lun->be_lun->blocksize,
6543				    block_desc->block_len);
6544		else
6545			scsi_ulto3b(0, block_desc->block_len);
6546	}
6547
6548	switch (page_code) {
6549	case SMS_ALL_PAGES_PAGE: {
6550		int i, data_used;
6551
6552		data_used = header_len;
6553		for (i = 0; i < CTL_NUM_MODE_PAGES; i++) {
6554			struct ctl_page_index *page_index;
6555
6556			page_index = &lun->mode_pages.index[i];
6557			if (lun->be_lun->lun_type == T_DIRECT &&
6558			    (page_index->page_flags & CTL_PAGE_FLAG_DIRECT) == 0)
6559				continue;
6560			if (lun->be_lun->lun_type == T_PROCESSOR &&
6561			    (page_index->page_flags & CTL_PAGE_FLAG_PROC) == 0)
6562				continue;
6563			if (lun->be_lun->lun_type == T_CDROM &&
6564			    (page_index->page_flags & CTL_PAGE_FLAG_CDROM) == 0)
6565				continue;
6566
6567			/*
6568			 * We don't use this subpage if the user didn't
6569			 * request all subpages.  We already checked (above)
6570			 * to make sure the user only specified a subpage
6571			 * of 0 or 0xff in the SMS_ALL_PAGES_PAGE case.
6572			 */
6573			if ((page_index->subpage != 0)
6574			 && (subpage == SMS_SUBPAGE_PAGE_0))
6575				continue;
6576
6577			/*
6578			 * Call the handler, if it exists, to update the
6579			 * page to the latest values.
6580			 */
6581			if (page_index->sense_handler != NULL)
6582				page_index->sense_handler(ctsio, page_index,pc);
6583
6584			memcpy(ctsio->kern_data_ptr + data_used,
6585			       page_index->page_data +
6586			       (page_index->page_len * pc),
6587			       page_index->page_len);
6588			data_used += page_index->page_len;
6589		}
6590		break;
6591	}
6592	default: {
6593		int i, data_used;
6594
6595		data_used = header_len;
6596
6597		for (i = 0; i < CTL_NUM_MODE_PAGES; i++) {
6598			struct ctl_page_index *page_index;
6599
6600			page_index = &lun->mode_pages.index[i];
6601
6602			/* Look for the right page code */
6603			if ((page_index->page_code & SMPH_PC_MASK) != page_code)
6604				continue;
6605
6606			/* Look for the right subpage or the subpage wildcard*/
6607			if ((page_index->subpage != subpage)
6608			 && (subpage != SMS_SUBPAGE_ALL))
6609				continue;
6610
6611			/* Make sure the page is supported for this dev type */
6612			if (lun->be_lun->lun_type == T_DIRECT &&
6613			    (page_index->page_flags & CTL_PAGE_FLAG_DIRECT) == 0)
6614				continue;
6615			if (lun->be_lun->lun_type == T_PROCESSOR &&
6616			    (page_index->page_flags & CTL_PAGE_FLAG_PROC) == 0)
6617				continue;
6618			if (lun->be_lun->lun_type == T_CDROM &&
6619			    (page_index->page_flags & CTL_PAGE_FLAG_CDROM) == 0)
6620				continue;
6621
6622			/*
6623			 * Call the handler, if it exists, to update the
6624			 * page to the latest values.
6625			 */
6626			if (page_index->sense_handler != NULL)
6627				page_index->sense_handler(ctsio, page_index,pc);
6628
6629			memcpy(ctsio->kern_data_ptr + data_used,
6630			       page_index->page_data +
6631			       (page_index->page_len * pc),
6632			       page_index->page_len);
6633			data_used += page_index->page_len;
6634		}
6635		break;
6636	}
6637	}
6638
6639	ctl_set_success(ctsio);
6640	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
6641	ctsio->be_move_done = ctl_config_move_done;
6642	ctl_datamove((union ctl_io *)ctsio);
6643	return (CTL_RETVAL_COMPLETE);
6644}
6645
6646int
6647ctl_lbp_log_sense_handler(struct ctl_scsiio *ctsio,
6648			       struct ctl_page_index *page_index,
6649			       int pc)
6650{
6651	struct ctl_lun *lun;
6652	struct scsi_log_param_header *phdr;
6653	uint8_t *data;
6654	uint64_t val;
6655
6656	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
6657	data = page_index->page_data;
6658
6659	if (lun->backend->lun_attr != NULL &&
6660	    (val = lun->backend->lun_attr(lun->be_lun->be_lun, "blocksavail"))
6661	     != UINT64_MAX) {
6662		phdr = (struct scsi_log_param_header *)data;
6663		scsi_ulto2b(0x0001, phdr->param_code);
6664		phdr->param_control = SLP_LBIN | SLP_LP;
6665		phdr->param_len = 8;
6666		data = (uint8_t *)(phdr + 1);
6667		scsi_ulto4b(val >> CTL_LBP_EXPONENT, data);
6668		data[4] = 0x02; /* per-pool */
6669		data += phdr->param_len;
6670	}
6671
6672	if (lun->backend->lun_attr != NULL &&
6673	    (val = lun->backend->lun_attr(lun->be_lun->be_lun, "blocksused"))
6674	     != UINT64_MAX) {
6675		phdr = (struct scsi_log_param_header *)data;
6676		scsi_ulto2b(0x0002, phdr->param_code);
6677		phdr->param_control = SLP_LBIN | SLP_LP;
6678		phdr->param_len = 8;
6679		data = (uint8_t *)(phdr + 1);
6680		scsi_ulto4b(val >> CTL_LBP_EXPONENT, data);
6681		data[4] = 0x01; /* per-LUN */
6682		data += phdr->param_len;
6683	}
6684
6685	if (lun->backend->lun_attr != NULL &&
6686	    (val = lun->backend->lun_attr(lun->be_lun->be_lun, "poolblocksavail"))
6687	     != UINT64_MAX) {
6688		phdr = (struct scsi_log_param_header *)data;
6689		scsi_ulto2b(0x00f1, phdr->param_code);
6690		phdr->param_control = SLP_LBIN | SLP_LP;
6691		phdr->param_len = 8;
6692		data = (uint8_t *)(phdr + 1);
6693		scsi_ulto4b(val >> CTL_LBP_EXPONENT, data);
6694		data[4] = 0x02; /* per-pool */
6695		data += phdr->param_len;
6696	}
6697
6698	if (lun->backend->lun_attr != NULL &&
6699	    (val = lun->backend->lun_attr(lun->be_lun->be_lun, "poolblocksused"))
6700	     != UINT64_MAX) {
6701		phdr = (struct scsi_log_param_header *)data;
6702		scsi_ulto2b(0x00f2, phdr->param_code);
6703		phdr->param_control = SLP_LBIN | SLP_LP;
6704		phdr->param_len = 8;
6705		data = (uint8_t *)(phdr + 1);
6706		scsi_ulto4b(val >> CTL_LBP_EXPONENT, data);
6707		data[4] = 0x02; /* per-pool */
6708		data += phdr->param_len;
6709	}
6710
6711	page_index->page_len = data - page_index->page_data;
6712	return (0);
6713}
6714
6715int
6716ctl_sap_log_sense_handler(struct ctl_scsiio *ctsio,
6717			       struct ctl_page_index *page_index,
6718			       int pc)
6719{
6720	struct ctl_lun *lun;
6721	struct stat_page *data;
6722	uint64_t rn, wn, rb, wb;
6723	struct bintime rt, wt;
6724	int i;
6725
6726	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
6727	data = (struct stat_page *)page_index->page_data;
6728
6729	scsi_ulto2b(SLP_SAP, data->sap.hdr.param_code);
6730	data->sap.hdr.param_control = SLP_LBIN;
6731	data->sap.hdr.param_len = sizeof(struct scsi_log_stat_and_perf) -
6732	    sizeof(struct scsi_log_param_header);
6733	rn = wn = rb = wb = 0;
6734	bintime_clear(&rt);
6735	bintime_clear(&wt);
6736	for (i = 0; i < CTL_MAX_PORTS; i++) {
6737		rn += lun->stats.ports[i].operations[CTL_STATS_READ];
6738		wn += lun->stats.ports[i].operations[CTL_STATS_WRITE];
6739		rb += lun->stats.ports[i].bytes[CTL_STATS_READ];
6740		wb += lun->stats.ports[i].bytes[CTL_STATS_WRITE];
6741		bintime_add(&rt, &lun->stats.ports[i].time[CTL_STATS_READ]);
6742		bintime_add(&wt, &lun->stats.ports[i].time[CTL_STATS_WRITE]);
6743	}
6744	scsi_u64to8b(rn, data->sap.read_num);
6745	scsi_u64to8b(wn, data->sap.write_num);
6746	if (lun->stats.blocksize > 0) {
6747		scsi_u64to8b(wb / lun->stats.blocksize,
6748		    data->sap.recvieved_lba);
6749		scsi_u64to8b(rb / lun->stats.blocksize,
6750		    data->sap.transmitted_lba);
6751	}
6752	scsi_u64to8b((uint64_t)rt.sec * 1000 + rt.frac / (UINT64_MAX / 1000),
6753	    data->sap.read_int);
6754	scsi_u64to8b((uint64_t)wt.sec * 1000 + wt.frac / (UINT64_MAX / 1000),
6755	    data->sap.write_int);
6756	scsi_u64to8b(0, data->sap.weighted_num);
6757	scsi_u64to8b(0, data->sap.weighted_int);
6758	scsi_ulto2b(SLP_IT, data->it.hdr.param_code);
6759	data->it.hdr.param_control = SLP_LBIN;
6760	data->it.hdr.param_len = sizeof(struct scsi_log_idle_time) -
6761	    sizeof(struct scsi_log_param_header);
6762#ifdef CTL_TIME_IO
6763	scsi_u64to8b(lun->idle_time / SBT_1MS, data->it.idle_int);
6764#endif
6765	scsi_ulto2b(SLP_TI, data->ti.hdr.param_code);
6766	data->it.hdr.param_control = SLP_LBIN;
6767	data->ti.hdr.param_len = sizeof(struct scsi_log_time_interval) -
6768	    sizeof(struct scsi_log_param_header);
6769	scsi_ulto4b(3, data->ti.exponent);
6770	scsi_ulto4b(1, data->ti.integer);
6771	return (0);
6772}
6773
6774int
6775ctl_ie_log_sense_handler(struct ctl_scsiio *ctsio,
6776			       struct ctl_page_index *page_index,
6777			       int pc)
6778{
6779	struct ctl_lun *lun;
6780	struct scsi_log_informational_exceptions *data;
6781
6782	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
6783	data = (struct scsi_log_informational_exceptions *)page_index->page_data;
6784
6785	scsi_ulto2b(SLP_IE_GEN, data->hdr.param_code);
6786	data->hdr.param_control = SLP_LBIN;
6787	data->hdr.param_len = sizeof(struct scsi_log_informational_exceptions) -
6788	    sizeof(struct scsi_log_param_header);
6789	data->ie_asc = lun->ie_asc;
6790	data->ie_ascq = lun->ie_ascq;
6791	data->temperature = 0xff;
6792	return (0);
6793}
6794
6795int
6796ctl_log_sense(struct ctl_scsiio *ctsio)
6797{
6798	struct ctl_lun *lun;
6799	int i, pc, page_code, subpage;
6800	int alloc_len, total_len;
6801	struct ctl_page_index *page_index;
6802	struct scsi_log_sense *cdb;
6803	struct scsi_log_header *header;
6804
6805	CTL_DEBUG_PRINT(("ctl_log_sense\n"));
6806
6807	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
6808	cdb = (struct scsi_log_sense *)ctsio->cdb;
6809	pc = (cdb->page & SLS_PAGE_CTRL_MASK) >> 6;
6810	page_code = cdb->page & SLS_PAGE_CODE;
6811	subpage = cdb->subpage;
6812	alloc_len = scsi_2btoul(cdb->length);
6813
6814	page_index = NULL;
6815	for (i = 0; i < CTL_NUM_LOG_PAGES; i++) {
6816		page_index = &lun->log_pages.index[i];
6817
6818		/* Look for the right page code */
6819		if ((page_index->page_code & SL_PAGE_CODE) != page_code)
6820			continue;
6821
6822		/* Look for the right subpage or the subpage wildcard*/
6823		if (page_index->subpage != subpage)
6824			continue;
6825
6826		break;
6827	}
6828	if (i >= CTL_NUM_LOG_PAGES) {
6829		ctl_set_invalid_field(ctsio,
6830				      /*sks_valid*/ 1,
6831				      /*command*/ 1,
6832				      /*field*/ 2,
6833				      /*bit_valid*/ 0,
6834				      /*bit*/ 0);
6835		ctl_done((union ctl_io *)ctsio);
6836		return (CTL_RETVAL_COMPLETE);
6837	}
6838
6839	total_len = sizeof(struct scsi_log_header) + page_index->page_len;
6840
6841	ctsio->kern_data_ptr = malloc(total_len, M_CTL, M_WAITOK | M_ZERO);
6842	ctsio->kern_sg_entries = 0;
6843	ctsio->kern_data_resid = 0;
6844	ctsio->kern_rel_offset = 0;
6845	if (total_len < alloc_len) {
6846		ctsio->residual = alloc_len - total_len;
6847		ctsio->kern_data_len = total_len;
6848		ctsio->kern_total_len = total_len;
6849	} else {
6850		ctsio->residual = 0;
6851		ctsio->kern_data_len = alloc_len;
6852		ctsio->kern_total_len = alloc_len;
6853	}
6854
6855	header = (struct scsi_log_header *)ctsio->kern_data_ptr;
6856	header->page = page_index->page_code;
6857	if (page_index->page_code == SLS_LOGICAL_BLOCK_PROVISIONING)
6858		header->page |= SL_DS;
6859	if (page_index->subpage) {
6860		header->page |= SL_SPF;
6861		header->subpage = page_index->subpage;
6862	}
6863	scsi_ulto2b(page_index->page_len, header->datalen);
6864
6865	/*
6866	 * Call the handler, if it exists, to update the
6867	 * page to the latest values.
6868	 */
6869	if (page_index->sense_handler != NULL)
6870		page_index->sense_handler(ctsio, page_index, pc);
6871
6872	memcpy(header + 1, page_index->page_data, page_index->page_len);
6873
6874	ctl_set_success(ctsio);
6875	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
6876	ctsio->be_move_done = ctl_config_move_done;
6877	ctl_datamove((union ctl_io *)ctsio);
6878	return (CTL_RETVAL_COMPLETE);
6879}
6880
6881int
6882ctl_read_capacity(struct ctl_scsiio *ctsio)
6883{
6884	struct scsi_read_capacity *cdb;
6885	struct scsi_read_capacity_data *data;
6886	struct ctl_lun *lun;
6887	uint32_t lba;
6888
6889	CTL_DEBUG_PRINT(("ctl_read_capacity\n"));
6890
6891	cdb = (struct scsi_read_capacity *)ctsio->cdb;
6892
6893	lba = scsi_4btoul(cdb->addr);
6894	if (((cdb->pmi & SRC_PMI) == 0)
6895	 && (lba != 0)) {
6896		ctl_set_invalid_field(/*ctsio*/ ctsio,
6897				      /*sks_valid*/ 1,
6898				      /*command*/ 1,
6899				      /*field*/ 2,
6900				      /*bit_valid*/ 0,
6901				      /*bit*/ 0);
6902		ctl_done((union ctl_io *)ctsio);
6903		return (CTL_RETVAL_COMPLETE);
6904	}
6905
6906	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
6907
6908	ctsio->kern_data_ptr = malloc(sizeof(*data), M_CTL, M_WAITOK | M_ZERO);
6909	data = (struct scsi_read_capacity_data *)ctsio->kern_data_ptr;
6910	ctsio->residual = 0;
6911	ctsio->kern_data_len = sizeof(*data);
6912	ctsio->kern_total_len = sizeof(*data);
6913	ctsio->kern_data_resid = 0;
6914	ctsio->kern_rel_offset = 0;
6915	ctsio->kern_sg_entries = 0;
6916
6917	/*
6918	 * If the maximum LBA is greater than 0xfffffffe, the user must
6919	 * issue a SERVICE ACTION IN (16) command, with the read capacity
6920	 * serivce action set.
6921	 */
6922	if (lun->be_lun->maxlba > 0xfffffffe)
6923		scsi_ulto4b(0xffffffff, data->addr);
6924	else
6925		scsi_ulto4b(lun->be_lun->maxlba, data->addr);
6926
6927	/*
6928	 * XXX KDM this may not be 512 bytes...
6929	 */
6930	scsi_ulto4b(lun->be_lun->blocksize, data->length);
6931
6932	ctl_set_success(ctsio);
6933	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
6934	ctsio->be_move_done = ctl_config_move_done;
6935	ctl_datamove((union ctl_io *)ctsio);
6936	return (CTL_RETVAL_COMPLETE);
6937}
6938
6939int
6940ctl_read_capacity_16(struct ctl_scsiio *ctsio)
6941{
6942	struct scsi_read_capacity_16 *cdb;
6943	struct scsi_read_capacity_data_long *data;
6944	struct ctl_lun *lun;
6945	uint64_t lba;
6946	uint32_t alloc_len;
6947
6948	CTL_DEBUG_PRINT(("ctl_read_capacity_16\n"));
6949
6950	cdb = (struct scsi_read_capacity_16 *)ctsio->cdb;
6951
6952	alloc_len = scsi_4btoul(cdb->alloc_len);
6953	lba = scsi_8btou64(cdb->addr);
6954
6955	if ((cdb->reladr & SRC16_PMI)
6956	 && (lba != 0)) {
6957		ctl_set_invalid_field(/*ctsio*/ ctsio,
6958				      /*sks_valid*/ 1,
6959				      /*command*/ 1,
6960				      /*field*/ 2,
6961				      /*bit_valid*/ 0,
6962				      /*bit*/ 0);
6963		ctl_done((union ctl_io *)ctsio);
6964		return (CTL_RETVAL_COMPLETE);
6965	}
6966
6967	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
6968
6969	ctsio->kern_data_ptr = malloc(sizeof(*data), M_CTL, M_WAITOK | M_ZERO);
6970	data = (struct scsi_read_capacity_data_long *)ctsio->kern_data_ptr;
6971
6972	if (sizeof(*data) < alloc_len) {
6973		ctsio->residual = alloc_len - sizeof(*data);
6974		ctsio->kern_data_len = sizeof(*data);
6975		ctsio->kern_total_len = sizeof(*data);
6976	} else {
6977		ctsio->residual = 0;
6978		ctsio->kern_data_len = alloc_len;
6979		ctsio->kern_total_len = alloc_len;
6980	}
6981	ctsio->kern_data_resid = 0;
6982	ctsio->kern_rel_offset = 0;
6983	ctsio->kern_sg_entries = 0;
6984
6985	scsi_u64to8b(lun->be_lun->maxlba, data->addr);
6986	/* XXX KDM this may not be 512 bytes... */
6987	scsi_ulto4b(lun->be_lun->blocksize, data->length);
6988	data->prot_lbppbe = lun->be_lun->pblockexp & SRC16_LBPPBE;
6989	scsi_ulto2b(lun->be_lun->pblockoff & SRC16_LALBA_A, data->lalba_lbp);
6990	if (lun->be_lun->flags & CTL_LUN_FLAG_UNMAP)
6991		data->lalba_lbp[0] |= SRC16_LBPME | SRC16_LBPRZ;
6992
6993	ctl_set_success(ctsio);
6994	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
6995	ctsio->be_move_done = ctl_config_move_done;
6996	ctl_datamove((union ctl_io *)ctsio);
6997	return (CTL_RETVAL_COMPLETE);
6998}
6999
7000int
7001ctl_get_lba_status(struct ctl_scsiio *ctsio)
7002{
7003	struct scsi_get_lba_status *cdb;
7004	struct scsi_get_lba_status_data *data;
7005	struct ctl_lun *lun;
7006	struct ctl_lba_len_flags *lbalen;
7007	uint64_t lba;
7008	uint32_t alloc_len, total_len;
7009	int retval;
7010
7011	CTL_DEBUG_PRINT(("ctl_get_lba_status\n"));
7012
7013	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
7014	cdb = (struct scsi_get_lba_status *)ctsio->cdb;
7015	lba = scsi_8btou64(cdb->addr);
7016	alloc_len = scsi_4btoul(cdb->alloc_len);
7017
7018	if (lba > lun->be_lun->maxlba) {
7019		ctl_set_lba_out_of_range(ctsio, lba);
7020		ctl_done((union ctl_io *)ctsio);
7021		return (CTL_RETVAL_COMPLETE);
7022	}
7023
7024	total_len = sizeof(*data) + sizeof(data->descr[0]);
7025	ctsio->kern_data_ptr = malloc(total_len, M_CTL, M_WAITOK | M_ZERO);
7026	data = (struct scsi_get_lba_status_data *)ctsio->kern_data_ptr;
7027
7028	if (total_len < alloc_len) {
7029		ctsio->residual = alloc_len - total_len;
7030		ctsio->kern_data_len = total_len;
7031		ctsio->kern_total_len = total_len;
7032	} else {
7033		ctsio->residual = 0;
7034		ctsio->kern_data_len = alloc_len;
7035		ctsio->kern_total_len = alloc_len;
7036	}
7037	ctsio->kern_data_resid = 0;
7038	ctsio->kern_rel_offset = 0;
7039	ctsio->kern_sg_entries = 0;
7040
7041	/* Fill dummy data in case backend can't tell anything. */
7042	scsi_ulto4b(4 + sizeof(data->descr[0]), data->length);
7043	scsi_u64to8b(lba, data->descr[0].addr);
7044	scsi_ulto4b(MIN(UINT32_MAX, lun->be_lun->maxlba + 1 - lba),
7045	    data->descr[0].length);
7046	data->descr[0].status = 0; /* Mapped or unknown. */
7047
7048	ctl_set_success(ctsio);
7049	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
7050	ctsio->be_move_done = ctl_config_move_done;
7051
7052	lbalen = (struct ctl_lba_len_flags *)&ctsio->io_hdr.ctl_private[CTL_PRIV_LBA_LEN];
7053	lbalen->lba = lba;
7054	lbalen->len = total_len;
7055	lbalen->flags = 0;
7056	retval = lun->backend->config_read((union ctl_io *)ctsio);
7057	return (CTL_RETVAL_COMPLETE);
7058}
7059
7060int
7061ctl_read_defect(struct ctl_scsiio *ctsio)
7062{
7063	struct scsi_read_defect_data_10 *ccb10;
7064	struct scsi_read_defect_data_12 *ccb12;
7065	struct scsi_read_defect_data_hdr_10 *data10;
7066	struct scsi_read_defect_data_hdr_12 *data12;
7067	uint32_t alloc_len, data_len;
7068	uint8_t format;
7069
7070	CTL_DEBUG_PRINT(("ctl_read_defect\n"));
7071
7072	if (ctsio->cdb[0] == READ_DEFECT_DATA_10) {
7073		ccb10 = (struct scsi_read_defect_data_10 *)&ctsio->cdb;
7074		format = ccb10->format;
7075		alloc_len = scsi_2btoul(ccb10->alloc_length);
7076		data_len = sizeof(*data10);
7077	} else {
7078		ccb12 = (struct scsi_read_defect_data_12 *)&ctsio->cdb;
7079		format = ccb12->format;
7080		alloc_len = scsi_4btoul(ccb12->alloc_length);
7081		data_len = sizeof(*data12);
7082	}
7083	if (alloc_len == 0) {
7084		ctl_set_success(ctsio);
7085		ctl_done((union ctl_io *)ctsio);
7086		return (CTL_RETVAL_COMPLETE);
7087	}
7088
7089	ctsio->kern_data_ptr = malloc(data_len, M_CTL, M_WAITOK | M_ZERO);
7090	if (data_len < alloc_len) {
7091		ctsio->residual = alloc_len - data_len;
7092		ctsio->kern_data_len = data_len;
7093		ctsio->kern_total_len = data_len;
7094	} else {
7095		ctsio->residual = 0;
7096		ctsio->kern_data_len = alloc_len;
7097		ctsio->kern_total_len = alloc_len;
7098	}
7099	ctsio->kern_data_resid = 0;
7100	ctsio->kern_rel_offset = 0;
7101	ctsio->kern_sg_entries = 0;
7102
7103	if (ctsio->cdb[0] == READ_DEFECT_DATA_10) {
7104		data10 = (struct scsi_read_defect_data_hdr_10 *)
7105		    ctsio->kern_data_ptr;
7106		data10->format = format;
7107		scsi_ulto2b(0, data10->length);
7108	} else {
7109		data12 = (struct scsi_read_defect_data_hdr_12 *)
7110		    ctsio->kern_data_ptr;
7111		data12->format = format;
7112		scsi_ulto2b(0, data12->generation);
7113		scsi_ulto4b(0, data12->length);
7114	}
7115
7116	ctl_set_success(ctsio);
7117	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
7118	ctsio->be_move_done = ctl_config_move_done;
7119	ctl_datamove((union ctl_io *)ctsio);
7120	return (CTL_RETVAL_COMPLETE);
7121}
7122
7123int
7124ctl_report_tagret_port_groups(struct ctl_scsiio *ctsio)
7125{
7126	struct scsi_maintenance_in *cdb;
7127	int retval;
7128	int alloc_len, ext, total_len = 0, g, pc, pg, ts, os;
7129	int num_ha_groups, num_target_ports, shared_group;
7130	struct ctl_lun *lun;
7131	struct ctl_softc *softc;
7132	struct ctl_port *port;
7133	struct scsi_target_group_data *rtg_ptr;
7134	struct scsi_target_group_data_extended *rtg_ext_ptr;
7135	struct scsi_target_port_group_descriptor *tpg_desc;
7136
7137	CTL_DEBUG_PRINT(("ctl_report_tagret_port_groups\n"));
7138
7139	cdb = (struct scsi_maintenance_in *)ctsio->cdb;
7140	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
7141	softc = lun->ctl_softc;
7142
7143	retval = CTL_RETVAL_COMPLETE;
7144
7145	switch (cdb->byte2 & STG_PDF_MASK) {
7146	case STG_PDF_LENGTH:
7147		ext = 0;
7148		break;
7149	case STG_PDF_EXTENDED:
7150		ext = 1;
7151		break;
7152	default:
7153		ctl_set_invalid_field(/*ctsio*/ ctsio,
7154				      /*sks_valid*/ 1,
7155				      /*command*/ 1,
7156				      /*field*/ 2,
7157				      /*bit_valid*/ 1,
7158				      /*bit*/ 5);
7159		ctl_done((union ctl_io *)ctsio);
7160		return(retval);
7161	}
7162
7163	num_target_ports = 0;
7164	shared_group = (softc->is_single != 0);
7165	mtx_lock(&softc->ctl_lock);
7166	STAILQ_FOREACH(port, &softc->port_list, links) {
7167		if ((port->status & CTL_PORT_STATUS_ONLINE) == 0)
7168			continue;
7169		if (ctl_lun_map_to_port(port, lun->lun) >= CTL_MAX_LUNS)
7170			continue;
7171		num_target_ports++;
7172		if (port->status & CTL_PORT_STATUS_HA_SHARED)
7173			shared_group = 1;
7174	}
7175	mtx_unlock(&softc->ctl_lock);
7176	num_ha_groups = (softc->is_single) ? 0 : NUM_HA_SHELVES;
7177
7178	if (ext)
7179		total_len = sizeof(struct scsi_target_group_data_extended);
7180	else
7181		total_len = sizeof(struct scsi_target_group_data);
7182	total_len += sizeof(struct scsi_target_port_group_descriptor) *
7183		(shared_group + num_ha_groups) +
7184	    sizeof(struct scsi_target_port_descriptor) * num_target_ports;
7185
7186	alloc_len = scsi_4btoul(cdb->length);
7187
7188	ctsio->kern_data_ptr = malloc(total_len, M_CTL, M_WAITOK | M_ZERO);
7189
7190	ctsio->kern_sg_entries = 0;
7191
7192	if (total_len < alloc_len) {
7193		ctsio->residual = alloc_len - total_len;
7194		ctsio->kern_data_len = total_len;
7195		ctsio->kern_total_len = total_len;
7196	} else {
7197		ctsio->residual = 0;
7198		ctsio->kern_data_len = alloc_len;
7199		ctsio->kern_total_len = alloc_len;
7200	}
7201	ctsio->kern_data_resid = 0;
7202	ctsio->kern_rel_offset = 0;
7203
7204	if (ext) {
7205		rtg_ext_ptr = (struct scsi_target_group_data_extended *)
7206		    ctsio->kern_data_ptr;
7207		scsi_ulto4b(total_len - 4, rtg_ext_ptr->length);
7208		rtg_ext_ptr->format_type = 0x10;
7209		rtg_ext_ptr->implicit_transition_time = 0;
7210		tpg_desc = &rtg_ext_ptr->groups[0];
7211	} else {
7212		rtg_ptr = (struct scsi_target_group_data *)
7213		    ctsio->kern_data_ptr;
7214		scsi_ulto4b(total_len - 4, rtg_ptr->length);
7215		tpg_desc = &rtg_ptr->groups[0];
7216	}
7217
7218	mtx_lock(&softc->ctl_lock);
7219	pg = softc->port_min / softc->port_cnt;
7220	if (lun->flags & (CTL_LUN_PRIMARY_SC | CTL_LUN_PEER_SC_PRIMARY)) {
7221		/* Some shelf is known to be primary. */
7222		if (softc->ha_link == CTL_HA_LINK_OFFLINE)
7223			os = TPG_ASYMMETRIC_ACCESS_UNAVAILABLE;
7224		else if (softc->ha_link == CTL_HA_LINK_UNKNOWN)
7225			os = TPG_ASYMMETRIC_ACCESS_TRANSITIONING;
7226		else if (softc->ha_mode == CTL_HA_MODE_ACT_STBY)
7227			os = TPG_ASYMMETRIC_ACCESS_STANDBY;
7228		else
7229			os = TPG_ASYMMETRIC_ACCESS_NONOPTIMIZED;
7230		if (lun->flags & CTL_LUN_PRIMARY_SC) {
7231			ts = TPG_ASYMMETRIC_ACCESS_OPTIMIZED;
7232		} else {
7233			ts = os;
7234			os = TPG_ASYMMETRIC_ACCESS_OPTIMIZED;
7235		}
7236	} else {
7237		/* No known primary shelf. */
7238		if (softc->ha_link == CTL_HA_LINK_OFFLINE) {
7239			ts = TPG_ASYMMETRIC_ACCESS_UNAVAILABLE;
7240			os = TPG_ASYMMETRIC_ACCESS_OPTIMIZED;
7241		} else if (softc->ha_link == CTL_HA_LINK_UNKNOWN) {
7242			ts = TPG_ASYMMETRIC_ACCESS_TRANSITIONING;
7243			os = TPG_ASYMMETRIC_ACCESS_OPTIMIZED;
7244		} else {
7245			ts = os = TPG_ASYMMETRIC_ACCESS_TRANSITIONING;
7246		}
7247	}
7248	if (shared_group) {
7249		tpg_desc->pref_state = ts;
7250		tpg_desc->support = TPG_AO_SUP | TPG_AN_SUP | TPG_S_SUP |
7251		    TPG_U_SUP | TPG_T_SUP;
7252		scsi_ulto2b(1, tpg_desc->target_port_group);
7253		tpg_desc->status = TPG_IMPLICIT;
7254		pc = 0;
7255		STAILQ_FOREACH(port, &softc->port_list, links) {
7256			if ((port->status & CTL_PORT_STATUS_ONLINE) == 0)
7257				continue;
7258			if (!softc->is_single &&
7259			    (port->status & CTL_PORT_STATUS_HA_SHARED) == 0)
7260				continue;
7261			if (ctl_lun_map_to_port(port, lun->lun) >= CTL_MAX_LUNS)
7262				continue;
7263			scsi_ulto2b(port->targ_port, tpg_desc->descriptors[pc].
7264			    relative_target_port_identifier);
7265			pc++;
7266		}
7267		tpg_desc->target_port_count = pc;
7268		tpg_desc = (struct scsi_target_port_group_descriptor *)
7269		    &tpg_desc->descriptors[pc];
7270	}
7271	for (g = 0; g < num_ha_groups; g++) {
7272		tpg_desc->pref_state = (g == pg) ? ts : os;
7273		tpg_desc->support = TPG_AO_SUP | TPG_AN_SUP | TPG_S_SUP |
7274		    TPG_U_SUP | TPG_T_SUP;
7275		scsi_ulto2b(2 + g, tpg_desc->target_port_group);
7276		tpg_desc->status = TPG_IMPLICIT;
7277		pc = 0;
7278		STAILQ_FOREACH(port, &softc->port_list, links) {
7279			if (port->targ_port < g * softc->port_cnt ||
7280			    port->targ_port >= (g + 1) * softc->port_cnt)
7281				continue;
7282			if ((port->status & CTL_PORT_STATUS_ONLINE) == 0)
7283				continue;
7284			if (port->status & CTL_PORT_STATUS_HA_SHARED)
7285				continue;
7286			if (ctl_lun_map_to_port(port, lun->lun) >= CTL_MAX_LUNS)
7287				continue;
7288			scsi_ulto2b(port->targ_port, tpg_desc->descriptors[pc].
7289			    relative_target_port_identifier);
7290			pc++;
7291		}
7292		tpg_desc->target_port_count = pc;
7293		tpg_desc = (struct scsi_target_port_group_descriptor *)
7294		    &tpg_desc->descriptors[pc];
7295	}
7296	mtx_unlock(&softc->ctl_lock);
7297
7298	ctl_set_success(ctsio);
7299	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
7300	ctsio->be_move_done = ctl_config_move_done;
7301	ctl_datamove((union ctl_io *)ctsio);
7302	return(retval);
7303}
7304
7305int
7306ctl_report_supported_opcodes(struct ctl_scsiio *ctsio)
7307{
7308	struct ctl_lun *lun;
7309	struct scsi_report_supported_opcodes *cdb;
7310	const struct ctl_cmd_entry *entry, *sentry;
7311	struct scsi_report_supported_opcodes_all *all;
7312	struct scsi_report_supported_opcodes_descr *descr;
7313	struct scsi_report_supported_opcodes_one *one;
7314	int retval;
7315	int alloc_len, total_len;
7316	int opcode, service_action, i, j, num;
7317
7318	CTL_DEBUG_PRINT(("ctl_report_supported_opcodes\n"));
7319
7320	cdb = (struct scsi_report_supported_opcodes *)ctsio->cdb;
7321	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
7322
7323	retval = CTL_RETVAL_COMPLETE;
7324
7325	opcode = cdb->requested_opcode;
7326	service_action = scsi_2btoul(cdb->requested_service_action);
7327	switch (cdb->options & RSO_OPTIONS_MASK) {
7328	case RSO_OPTIONS_ALL:
7329		num = 0;
7330		for (i = 0; i < 256; i++) {
7331			entry = &ctl_cmd_table[i];
7332			if (entry->flags & CTL_CMD_FLAG_SA5) {
7333				for (j = 0; j < 32; j++) {
7334					sentry = &((const struct ctl_cmd_entry *)
7335					    entry->execute)[j];
7336					if (ctl_cmd_applicable(
7337					    lun->be_lun->lun_type, sentry))
7338						num++;
7339				}
7340			} else {
7341				if (ctl_cmd_applicable(lun->be_lun->lun_type,
7342				    entry))
7343					num++;
7344			}
7345		}
7346		total_len = sizeof(struct scsi_report_supported_opcodes_all) +
7347		    num * sizeof(struct scsi_report_supported_opcodes_descr);
7348		break;
7349	case RSO_OPTIONS_OC:
7350		if (ctl_cmd_table[opcode].flags & CTL_CMD_FLAG_SA5) {
7351			ctl_set_invalid_field(/*ctsio*/ ctsio,
7352					      /*sks_valid*/ 1,
7353					      /*command*/ 1,
7354					      /*field*/ 2,
7355					      /*bit_valid*/ 1,
7356					      /*bit*/ 2);
7357			ctl_done((union ctl_io *)ctsio);
7358			return (CTL_RETVAL_COMPLETE);
7359		}
7360		total_len = sizeof(struct scsi_report_supported_opcodes_one) + 32;
7361		break;
7362	case RSO_OPTIONS_OC_SA:
7363		if ((ctl_cmd_table[opcode].flags & CTL_CMD_FLAG_SA5) == 0 ||
7364		    service_action >= 32) {
7365			ctl_set_invalid_field(/*ctsio*/ ctsio,
7366					      /*sks_valid*/ 1,
7367					      /*command*/ 1,
7368					      /*field*/ 2,
7369					      /*bit_valid*/ 1,
7370					      /*bit*/ 2);
7371			ctl_done((union ctl_io *)ctsio);
7372			return (CTL_RETVAL_COMPLETE);
7373		}
7374		total_len = sizeof(struct scsi_report_supported_opcodes_one) + 32;
7375		break;
7376	default:
7377		ctl_set_invalid_field(/*ctsio*/ ctsio,
7378				      /*sks_valid*/ 1,
7379				      /*command*/ 1,
7380				      /*field*/ 2,
7381				      /*bit_valid*/ 1,
7382				      /*bit*/ 2);
7383		ctl_done((union ctl_io *)ctsio);
7384		return (CTL_RETVAL_COMPLETE);
7385	}
7386
7387	alloc_len = scsi_4btoul(cdb->length);
7388
7389	ctsio->kern_data_ptr = malloc(total_len, M_CTL, M_WAITOK | M_ZERO);
7390
7391	ctsio->kern_sg_entries = 0;
7392
7393	if (total_len < alloc_len) {
7394		ctsio->residual = alloc_len - total_len;
7395		ctsio->kern_data_len = total_len;
7396		ctsio->kern_total_len = total_len;
7397	} else {
7398		ctsio->residual = 0;
7399		ctsio->kern_data_len = alloc_len;
7400		ctsio->kern_total_len = alloc_len;
7401	}
7402	ctsio->kern_data_resid = 0;
7403	ctsio->kern_rel_offset = 0;
7404
7405	switch (cdb->options & RSO_OPTIONS_MASK) {
7406	case RSO_OPTIONS_ALL:
7407		all = (struct scsi_report_supported_opcodes_all *)
7408		    ctsio->kern_data_ptr;
7409		num = 0;
7410		for (i = 0; i < 256; i++) {
7411			entry = &ctl_cmd_table[i];
7412			if (entry->flags & CTL_CMD_FLAG_SA5) {
7413				for (j = 0; j < 32; j++) {
7414					sentry = &((const struct ctl_cmd_entry *)
7415					    entry->execute)[j];
7416					if (!ctl_cmd_applicable(
7417					    lun->be_lun->lun_type, sentry))
7418						continue;
7419					descr = &all->descr[num++];
7420					descr->opcode = i;
7421					scsi_ulto2b(j, descr->service_action);
7422					descr->flags = RSO_SERVACTV;
7423					scsi_ulto2b(sentry->length,
7424					    descr->cdb_length);
7425				}
7426			} else {
7427				if (!ctl_cmd_applicable(lun->be_lun->lun_type,
7428				    entry))
7429					continue;
7430				descr = &all->descr[num++];
7431				descr->opcode = i;
7432				scsi_ulto2b(0, descr->service_action);
7433				descr->flags = 0;
7434				scsi_ulto2b(entry->length, descr->cdb_length);
7435			}
7436		}
7437		scsi_ulto4b(
7438		    num * sizeof(struct scsi_report_supported_opcodes_descr),
7439		    all->length);
7440		break;
7441	case RSO_OPTIONS_OC:
7442		one = (struct scsi_report_supported_opcodes_one *)
7443		    ctsio->kern_data_ptr;
7444		entry = &ctl_cmd_table[opcode];
7445		goto fill_one;
7446	case RSO_OPTIONS_OC_SA:
7447		one = (struct scsi_report_supported_opcodes_one *)
7448		    ctsio->kern_data_ptr;
7449		entry = &ctl_cmd_table[opcode];
7450		entry = &((const struct ctl_cmd_entry *)
7451		    entry->execute)[service_action];
7452fill_one:
7453		if (ctl_cmd_applicable(lun->be_lun->lun_type, entry)) {
7454			one->support = 3;
7455			scsi_ulto2b(entry->length, one->cdb_length);
7456			one->cdb_usage[0] = opcode;
7457			memcpy(&one->cdb_usage[1], entry->usage,
7458			    entry->length - 1);
7459		} else
7460			one->support = 1;
7461		break;
7462	}
7463
7464	ctl_set_success(ctsio);
7465	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
7466	ctsio->be_move_done = ctl_config_move_done;
7467	ctl_datamove((union ctl_io *)ctsio);
7468	return(retval);
7469}
7470
7471int
7472ctl_report_supported_tmf(struct ctl_scsiio *ctsio)
7473{
7474	struct scsi_report_supported_tmf *cdb;
7475	struct scsi_report_supported_tmf_data *data;
7476	int retval;
7477	int alloc_len, total_len;
7478
7479	CTL_DEBUG_PRINT(("ctl_report_supported_tmf\n"));
7480
7481	cdb = (struct scsi_report_supported_tmf *)ctsio->cdb;
7482
7483	retval = CTL_RETVAL_COMPLETE;
7484
7485	total_len = sizeof(struct scsi_report_supported_tmf_data);
7486	alloc_len = scsi_4btoul(cdb->length);
7487
7488	ctsio->kern_data_ptr = malloc(total_len, M_CTL, M_WAITOK | M_ZERO);
7489
7490	ctsio->kern_sg_entries = 0;
7491
7492	if (total_len < alloc_len) {
7493		ctsio->residual = alloc_len - total_len;
7494		ctsio->kern_data_len = total_len;
7495		ctsio->kern_total_len = total_len;
7496	} else {
7497		ctsio->residual = 0;
7498		ctsio->kern_data_len = alloc_len;
7499		ctsio->kern_total_len = alloc_len;
7500	}
7501	ctsio->kern_data_resid = 0;
7502	ctsio->kern_rel_offset = 0;
7503
7504	data = (struct scsi_report_supported_tmf_data *)ctsio->kern_data_ptr;
7505	data->byte1 |= RST_ATS | RST_ATSS | RST_CTSS | RST_LURS | RST_QTS |
7506	    RST_TRS;
7507	data->byte2 |= RST_QAES | RST_QTSS | RST_ITNRS;
7508
7509	ctl_set_success(ctsio);
7510	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
7511	ctsio->be_move_done = ctl_config_move_done;
7512	ctl_datamove((union ctl_io *)ctsio);
7513	return (retval);
7514}
7515
7516int
7517ctl_report_timestamp(struct ctl_scsiio *ctsio)
7518{
7519	struct scsi_report_timestamp *cdb;
7520	struct scsi_report_timestamp_data *data;
7521	struct timeval tv;
7522	int64_t timestamp;
7523	int retval;
7524	int alloc_len, total_len;
7525
7526	CTL_DEBUG_PRINT(("ctl_report_timestamp\n"));
7527
7528	cdb = (struct scsi_report_timestamp *)ctsio->cdb;
7529
7530	retval = CTL_RETVAL_COMPLETE;
7531
7532	total_len = sizeof(struct scsi_report_timestamp_data);
7533	alloc_len = scsi_4btoul(cdb->length);
7534
7535	ctsio->kern_data_ptr = malloc(total_len, M_CTL, M_WAITOK | M_ZERO);
7536
7537	ctsio->kern_sg_entries = 0;
7538
7539	if (total_len < alloc_len) {
7540		ctsio->residual = alloc_len - total_len;
7541		ctsio->kern_data_len = total_len;
7542		ctsio->kern_total_len = total_len;
7543	} else {
7544		ctsio->residual = 0;
7545		ctsio->kern_data_len = alloc_len;
7546		ctsio->kern_total_len = alloc_len;
7547	}
7548	ctsio->kern_data_resid = 0;
7549	ctsio->kern_rel_offset = 0;
7550
7551	data = (struct scsi_report_timestamp_data *)ctsio->kern_data_ptr;
7552	scsi_ulto2b(sizeof(*data) - 2, data->length);
7553	data->origin = RTS_ORIG_OUTSIDE;
7554	getmicrotime(&tv);
7555	timestamp = (int64_t)tv.tv_sec * 1000 + tv.tv_usec / 1000;
7556	scsi_ulto4b(timestamp >> 16, data->timestamp);
7557	scsi_ulto2b(timestamp & 0xffff, &data->timestamp[4]);
7558
7559	ctl_set_success(ctsio);
7560	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
7561	ctsio->be_move_done = ctl_config_move_done;
7562	ctl_datamove((union ctl_io *)ctsio);
7563	return (retval);
7564}
7565
7566int
7567ctl_persistent_reserve_in(struct ctl_scsiio *ctsio)
7568{
7569	struct scsi_per_res_in *cdb;
7570	int alloc_len, total_len = 0;
7571	/* struct scsi_per_res_in_rsrv in_data; */
7572	struct ctl_lun *lun;
7573	struct ctl_softc *softc;
7574	uint64_t key;
7575
7576	CTL_DEBUG_PRINT(("ctl_persistent_reserve_in\n"));
7577
7578	cdb = (struct scsi_per_res_in *)ctsio->cdb;
7579
7580	alloc_len = scsi_2btoul(cdb->length);
7581
7582	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
7583	softc = lun->ctl_softc;
7584
7585retry:
7586	mtx_lock(&lun->lun_lock);
7587	switch (cdb->action) {
7588	case SPRI_RK: /* read keys */
7589		total_len = sizeof(struct scsi_per_res_in_keys) +
7590			lun->pr_key_count *
7591			sizeof(struct scsi_per_res_key);
7592		break;
7593	case SPRI_RR: /* read reservation */
7594		if (lun->flags & CTL_LUN_PR_RESERVED)
7595			total_len = sizeof(struct scsi_per_res_in_rsrv);
7596		else
7597			total_len = sizeof(struct scsi_per_res_in_header);
7598		break;
7599	case SPRI_RC: /* report capabilities */
7600		total_len = sizeof(struct scsi_per_res_cap);
7601		break;
7602	case SPRI_RS: /* read full status */
7603		total_len = sizeof(struct scsi_per_res_in_header) +
7604		    (sizeof(struct scsi_per_res_in_full_desc) + 256) *
7605		    lun->pr_key_count;
7606		break;
7607	default:
7608		panic("%s: Invalid PR type %#x", __func__, cdb->action);
7609	}
7610	mtx_unlock(&lun->lun_lock);
7611
7612	ctsio->kern_data_ptr = malloc(total_len, M_CTL, M_WAITOK | M_ZERO);
7613
7614	if (total_len < alloc_len) {
7615		ctsio->residual = alloc_len - total_len;
7616		ctsio->kern_data_len = total_len;
7617		ctsio->kern_total_len = total_len;
7618	} else {
7619		ctsio->residual = 0;
7620		ctsio->kern_data_len = alloc_len;
7621		ctsio->kern_total_len = alloc_len;
7622	}
7623
7624	ctsio->kern_data_resid = 0;
7625	ctsio->kern_rel_offset = 0;
7626	ctsio->kern_sg_entries = 0;
7627
7628	mtx_lock(&lun->lun_lock);
7629	switch (cdb->action) {
7630	case SPRI_RK: { // read keys
7631        struct scsi_per_res_in_keys *res_keys;
7632		int i, key_count;
7633
7634		res_keys = (struct scsi_per_res_in_keys*)ctsio->kern_data_ptr;
7635
7636		/*
7637		 * We had to drop the lock to allocate our buffer, which
7638		 * leaves time for someone to come in with another
7639		 * persistent reservation.  (That is unlikely, though,
7640		 * since this should be the only persistent reservation
7641		 * command active right now.)
7642		 */
7643		if (total_len != (sizeof(struct scsi_per_res_in_keys) +
7644		    (lun->pr_key_count *
7645		     sizeof(struct scsi_per_res_key)))){
7646			mtx_unlock(&lun->lun_lock);
7647			free(ctsio->kern_data_ptr, M_CTL);
7648			printf("%s: reservation length changed, retrying\n",
7649			       __func__);
7650			goto retry;
7651		}
7652
7653		scsi_ulto4b(lun->pr_generation, res_keys->header.generation);
7654
7655		scsi_ulto4b(sizeof(struct scsi_per_res_key) *
7656			     lun->pr_key_count, res_keys->header.length);
7657
7658		for (i = 0, key_count = 0; i < CTL_MAX_INITIATORS; i++) {
7659			if ((key = ctl_get_prkey(lun, i)) == 0)
7660				continue;
7661
7662			/*
7663			 * We used lun->pr_key_count to calculate the
7664			 * size to allocate.  If it turns out the number of
7665			 * initiators with the registered flag set is
7666			 * larger than that (i.e. they haven't been kept in
7667			 * sync), we've got a problem.
7668			 */
7669			if (key_count >= lun->pr_key_count) {
7670				key_count++;
7671				continue;
7672			}
7673			scsi_u64to8b(key, res_keys->keys[key_count].key);
7674			key_count++;
7675		}
7676		break;
7677	}
7678	case SPRI_RR: { // read reservation
7679		struct scsi_per_res_in_rsrv *res;
7680		int tmp_len, header_only;
7681
7682		res = (struct scsi_per_res_in_rsrv *)ctsio->kern_data_ptr;
7683
7684		scsi_ulto4b(lun->pr_generation, res->header.generation);
7685
7686		if (lun->flags & CTL_LUN_PR_RESERVED)
7687		{
7688			tmp_len = sizeof(struct scsi_per_res_in_rsrv);
7689			scsi_ulto4b(sizeof(struct scsi_per_res_in_rsrv_data),
7690				    res->header.length);
7691			header_only = 0;
7692		} else {
7693			tmp_len = sizeof(struct scsi_per_res_in_header);
7694			scsi_ulto4b(0, res->header.length);
7695			header_only = 1;
7696		}
7697
7698		/*
7699		 * We had to drop the lock to allocate our buffer, which
7700		 * leaves time for someone to come in with another
7701		 * persistent reservation.  (That is unlikely, though,
7702		 * since this should be the only persistent reservation
7703		 * command active right now.)
7704		 */
7705		if (tmp_len != total_len) {
7706			mtx_unlock(&lun->lun_lock);
7707			free(ctsio->kern_data_ptr, M_CTL);
7708			printf("%s: reservation status changed, retrying\n",
7709			       __func__);
7710			goto retry;
7711		}
7712
7713		/*
7714		 * No reservation held, so we're done.
7715		 */
7716		if (header_only != 0)
7717			break;
7718
7719		/*
7720		 * If the registration is an All Registrants type, the key
7721		 * is 0, since it doesn't really matter.
7722		 */
7723		if (lun->pr_res_idx != CTL_PR_ALL_REGISTRANTS) {
7724			scsi_u64to8b(ctl_get_prkey(lun, lun->pr_res_idx),
7725			    res->data.reservation);
7726		}
7727		res->data.scopetype = lun->pr_res_type;
7728		break;
7729	}
7730	case SPRI_RC:     //report capabilities
7731	{
7732		struct scsi_per_res_cap *res_cap;
7733		uint16_t type_mask;
7734
7735		res_cap = (struct scsi_per_res_cap *)ctsio->kern_data_ptr;
7736		scsi_ulto2b(sizeof(*res_cap), res_cap->length);
7737		res_cap->flags1 = SPRI_CRH;
7738		res_cap->flags2 = SPRI_TMV | SPRI_ALLOW_5;
7739		type_mask = SPRI_TM_WR_EX_AR |
7740			    SPRI_TM_EX_AC_RO |
7741			    SPRI_TM_WR_EX_RO |
7742			    SPRI_TM_EX_AC |
7743			    SPRI_TM_WR_EX |
7744			    SPRI_TM_EX_AC_AR;
7745		scsi_ulto2b(type_mask, res_cap->type_mask);
7746		break;
7747	}
7748	case SPRI_RS: { // read full status
7749		struct scsi_per_res_in_full *res_status;
7750		struct scsi_per_res_in_full_desc *res_desc;
7751		struct ctl_port *port;
7752		int i, len;
7753
7754		res_status = (struct scsi_per_res_in_full*)ctsio->kern_data_ptr;
7755
7756		/*
7757		 * We had to drop the lock to allocate our buffer, which
7758		 * leaves time for someone to come in with another
7759		 * persistent reservation.  (That is unlikely, though,
7760		 * since this should be the only persistent reservation
7761		 * command active right now.)
7762		 */
7763		if (total_len < (sizeof(struct scsi_per_res_in_header) +
7764		    (sizeof(struct scsi_per_res_in_full_desc) + 256) *
7765		     lun->pr_key_count)){
7766			mtx_unlock(&lun->lun_lock);
7767			free(ctsio->kern_data_ptr, M_CTL);
7768			printf("%s: reservation length changed, retrying\n",
7769			       __func__);
7770			goto retry;
7771		}
7772
7773		scsi_ulto4b(lun->pr_generation, res_status->header.generation);
7774
7775		res_desc = &res_status->desc[0];
7776		for (i = 0; i < CTL_MAX_INITIATORS; i++) {
7777			if ((key = ctl_get_prkey(lun, i)) == 0)
7778				continue;
7779
7780			scsi_u64to8b(key, res_desc->res_key.key);
7781			if ((lun->flags & CTL_LUN_PR_RESERVED) &&
7782			    (lun->pr_res_idx == i ||
7783			     lun->pr_res_idx == CTL_PR_ALL_REGISTRANTS)) {
7784				res_desc->flags = SPRI_FULL_R_HOLDER;
7785				res_desc->scopetype = lun->pr_res_type;
7786			}
7787			scsi_ulto2b(i / CTL_MAX_INIT_PER_PORT,
7788			    res_desc->rel_trgt_port_id);
7789			len = 0;
7790			port = softc->ctl_ports[i / CTL_MAX_INIT_PER_PORT];
7791			if (port != NULL)
7792				len = ctl_create_iid(port,
7793				    i % CTL_MAX_INIT_PER_PORT,
7794				    res_desc->transport_id);
7795			scsi_ulto4b(len, res_desc->additional_length);
7796			res_desc = (struct scsi_per_res_in_full_desc *)
7797			    &res_desc->transport_id[len];
7798		}
7799		scsi_ulto4b((uint8_t *)res_desc - (uint8_t *)&res_status->desc[0],
7800		    res_status->header.length);
7801		break;
7802	}
7803	default:
7804		panic("%s: Invalid PR type %#x", __func__, cdb->action);
7805	}
7806	mtx_unlock(&lun->lun_lock);
7807
7808	ctl_set_success(ctsio);
7809	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
7810	ctsio->be_move_done = ctl_config_move_done;
7811	ctl_datamove((union ctl_io *)ctsio);
7812	return (CTL_RETVAL_COMPLETE);
7813}
7814
7815/*
7816 * Returns 0 if ctl_persistent_reserve_out() should continue, non-zero if
7817 * it should return.
7818 */
7819static int
7820ctl_pro_preempt(struct ctl_softc *softc, struct ctl_lun *lun, uint64_t res_key,
7821		uint64_t sa_res_key, uint8_t type, uint32_t residx,
7822		struct ctl_scsiio *ctsio, struct scsi_per_res_out *cdb,
7823		struct scsi_per_res_out_parms* param)
7824{
7825	union ctl_ha_msg persis_io;
7826	int i;
7827
7828	mtx_lock(&lun->lun_lock);
7829	if (sa_res_key == 0) {
7830		if (lun->pr_res_idx == CTL_PR_ALL_REGISTRANTS) {
7831			/* validate scope and type */
7832			if ((cdb->scope_type & SPR_SCOPE_MASK) !=
7833			     SPR_LU_SCOPE) {
7834				mtx_unlock(&lun->lun_lock);
7835				ctl_set_invalid_field(/*ctsio*/ ctsio,
7836						      /*sks_valid*/ 1,
7837						      /*command*/ 1,
7838						      /*field*/ 2,
7839						      /*bit_valid*/ 1,
7840						      /*bit*/ 4);
7841				ctl_done((union ctl_io *)ctsio);
7842				return (1);
7843			}
7844
7845		        if (type>8 || type==2 || type==4 || type==0) {
7846				mtx_unlock(&lun->lun_lock);
7847				ctl_set_invalid_field(/*ctsio*/ ctsio,
7848       	           				      /*sks_valid*/ 1,
7849						      /*command*/ 1,
7850						      /*field*/ 2,
7851						      /*bit_valid*/ 1,
7852						      /*bit*/ 0);
7853				ctl_done((union ctl_io *)ctsio);
7854				return (1);
7855		        }
7856
7857			/*
7858			 * Unregister everybody else and build UA for
7859			 * them
7860			 */
7861			for(i = 0; i < CTL_MAX_INITIATORS; i++) {
7862				if (i == residx || ctl_get_prkey(lun, i) == 0)
7863					continue;
7864
7865				ctl_clr_prkey(lun, i);
7866				ctl_est_ua(lun, i, CTL_UA_REG_PREEMPT);
7867			}
7868			lun->pr_key_count = 1;
7869			lun->pr_res_type = type;
7870			if (lun->pr_res_type != SPR_TYPE_WR_EX_AR &&
7871			    lun->pr_res_type != SPR_TYPE_EX_AC_AR)
7872				lun->pr_res_idx = residx;
7873			lun->pr_generation++;
7874			mtx_unlock(&lun->lun_lock);
7875
7876			/* send msg to other side */
7877			persis_io.hdr.nexus = ctsio->io_hdr.nexus;
7878			persis_io.hdr.msg_type = CTL_MSG_PERS_ACTION;
7879			persis_io.pr.pr_info.action = CTL_PR_PREEMPT;
7880			persis_io.pr.pr_info.residx = lun->pr_res_idx;
7881			persis_io.pr.pr_info.res_type = type;
7882			memcpy(persis_io.pr.pr_info.sa_res_key,
7883			       param->serv_act_res_key,
7884			       sizeof(param->serv_act_res_key));
7885			ctl_ha_msg_send(CTL_HA_CHAN_CTL, &persis_io,
7886			    sizeof(persis_io.pr), M_WAITOK);
7887		} else {
7888			/* not all registrants */
7889			mtx_unlock(&lun->lun_lock);
7890			free(ctsio->kern_data_ptr, M_CTL);
7891			ctl_set_invalid_field(ctsio,
7892					      /*sks_valid*/ 1,
7893					      /*command*/ 0,
7894					      /*field*/ 8,
7895					      /*bit_valid*/ 0,
7896					      /*bit*/ 0);
7897			ctl_done((union ctl_io *)ctsio);
7898			return (1);
7899		}
7900	} else if (lun->pr_res_idx == CTL_PR_ALL_REGISTRANTS
7901		|| !(lun->flags & CTL_LUN_PR_RESERVED)) {
7902		int found = 0;
7903
7904		if (res_key == sa_res_key) {
7905			/* special case */
7906			/*
7907			 * The spec implies this is not good but doesn't
7908			 * say what to do. There are two choices either
7909			 * generate a res conflict or check condition
7910			 * with illegal field in parameter data. Since
7911			 * that is what is done when the sa_res_key is
7912			 * zero I'll take that approach since this has
7913			 * to do with the sa_res_key.
7914			 */
7915			mtx_unlock(&lun->lun_lock);
7916			free(ctsio->kern_data_ptr, M_CTL);
7917			ctl_set_invalid_field(ctsio,
7918					      /*sks_valid*/ 1,
7919					      /*command*/ 0,
7920					      /*field*/ 8,
7921					      /*bit_valid*/ 0,
7922					      /*bit*/ 0);
7923			ctl_done((union ctl_io *)ctsio);
7924			return (1);
7925		}
7926
7927		for (i = 0; i < CTL_MAX_INITIATORS; i++) {
7928			if (ctl_get_prkey(lun, i) != sa_res_key)
7929				continue;
7930
7931			found = 1;
7932			ctl_clr_prkey(lun, i);
7933			lun->pr_key_count--;
7934			ctl_est_ua(lun, i, CTL_UA_REG_PREEMPT);
7935		}
7936		if (!found) {
7937			mtx_unlock(&lun->lun_lock);
7938			free(ctsio->kern_data_ptr, M_CTL);
7939			ctl_set_reservation_conflict(ctsio);
7940			ctl_done((union ctl_io *)ctsio);
7941			return (CTL_RETVAL_COMPLETE);
7942		}
7943		lun->pr_generation++;
7944		mtx_unlock(&lun->lun_lock);
7945
7946		/* send msg to other side */
7947		persis_io.hdr.nexus = ctsio->io_hdr.nexus;
7948		persis_io.hdr.msg_type = CTL_MSG_PERS_ACTION;
7949		persis_io.pr.pr_info.action = CTL_PR_PREEMPT;
7950		persis_io.pr.pr_info.residx = lun->pr_res_idx;
7951		persis_io.pr.pr_info.res_type = type;
7952		memcpy(persis_io.pr.pr_info.sa_res_key,
7953		       param->serv_act_res_key,
7954		       sizeof(param->serv_act_res_key));
7955		ctl_ha_msg_send(CTL_HA_CHAN_CTL, &persis_io,
7956		    sizeof(persis_io.pr), M_WAITOK);
7957	} else {
7958		/* Reserved but not all registrants */
7959		/* sa_res_key is res holder */
7960		if (sa_res_key == ctl_get_prkey(lun, lun->pr_res_idx)) {
7961			/* validate scope and type */
7962			if ((cdb->scope_type & SPR_SCOPE_MASK) !=
7963			     SPR_LU_SCOPE) {
7964				mtx_unlock(&lun->lun_lock);
7965				ctl_set_invalid_field(/*ctsio*/ ctsio,
7966						      /*sks_valid*/ 1,
7967						      /*command*/ 1,
7968						      /*field*/ 2,
7969						      /*bit_valid*/ 1,
7970						      /*bit*/ 4);
7971				ctl_done((union ctl_io *)ctsio);
7972				return (1);
7973			}
7974
7975			if (type>8 || type==2 || type==4 || type==0) {
7976				mtx_unlock(&lun->lun_lock);
7977				ctl_set_invalid_field(/*ctsio*/ ctsio,
7978						      /*sks_valid*/ 1,
7979						      /*command*/ 1,
7980						      /*field*/ 2,
7981						      /*bit_valid*/ 1,
7982						      /*bit*/ 0);
7983				ctl_done((union ctl_io *)ctsio);
7984				return (1);
7985			}
7986
7987			/*
7988			 * Do the following:
7989			 * if sa_res_key != res_key remove all
7990			 * registrants w/sa_res_key and generate UA
7991			 * for these registrants(Registrations
7992			 * Preempted) if it wasn't an exclusive
7993			 * reservation generate UA(Reservations
7994			 * Preempted) for all other registered nexuses
7995			 * if the type has changed. Establish the new
7996			 * reservation and holder. If res_key and
7997			 * sa_res_key are the same do the above
7998			 * except don't unregister the res holder.
7999			 */
8000
8001			for(i = 0; i < CTL_MAX_INITIATORS; i++) {
8002				if (i == residx || ctl_get_prkey(lun, i) == 0)
8003					continue;
8004
8005				if (sa_res_key == ctl_get_prkey(lun, i)) {
8006					ctl_clr_prkey(lun, i);
8007					lun->pr_key_count--;
8008					ctl_est_ua(lun, i, CTL_UA_REG_PREEMPT);
8009				} else if (type != lun->pr_res_type &&
8010				    (lun->pr_res_type == SPR_TYPE_WR_EX_RO ||
8011				     lun->pr_res_type == SPR_TYPE_EX_AC_RO)) {
8012					ctl_est_ua(lun, i, CTL_UA_RES_RELEASE);
8013				}
8014			}
8015			lun->pr_res_type = type;
8016			if (lun->pr_res_type != SPR_TYPE_WR_EX_AR &&
8017			    lun->pr_res_type != SPR_TYPE_EX_AC_AR)
8018				lun->pr_res_idx = residx;
8019			else
8020				lun->pr_res_idx = CTL_PR_ALL_REGISTRANTS;
8021			lun->pr_generation++;
8022			mtx_unlock(&lun->lun_lock);
8023
8024			persis_io.hdr.nexus = ctsio->io_hdr.nexus;
8025			persis_io.hdr.msg_type = CTL_MSG_PERS_ACTION;
8026			persis_io.pr.pr_info.action = CTL_PR_PREEMPT;
8027			persis_io.pr.pr_info.residx = lun->pr_res_idx;
8028			persis_io.pr.pr_info.res_type = type;
8029			memcpy(persis_io.pr.pr_info.sa_res_key,
8030			       param->serv_act_res_key,
8031			       sizeof(param->serv_act_res_key));
8032			ctl_ha_msg_send(CTL_HA_CHAN_CTL, &persis_io,
8033			    sizeof(persis_io.pr), M_WAITOK);
8034		} else {
8035			/*
8036			 * sa_res_key is not the res holder just
8037			 * remove registrants
8038			 */
8039			int found=0;
8040
8041			for (i = 0; i < CTL_MAX_INITIATORS; i++) {
8042				if (sa_res_key != ctl_get_prkey(lun, i))
8043					continue;
8044
8045				found = 1;
8046				ctl_clr_prkey(lun, i);
8047				lun->pr_key_count--;
8048				ctl_est_ua(lun, i, CTL_UA_REG_PREEMPT);
8049			}
8050
8051			if (!found) {
8052				mtx_unlock(&lun->lun_lock);
8053				free(ctsio->kern_data_ptr, M_CTL);
8054				ctl_set_reservation_conflict(ctsio);
8055				ctl_done((union ctl_io *)ctsio);
8056		        	return (1);
8057			}
8058			lun->pr_generation++;
8059			mtx_unlock(&lun->lun_lock);
8060
8061			persis_io.hdr.nexus = ctsio->io_hdr.nexus;
8062			persis_io.hdr.msg_type = CTL_MSG_PERS_ACTION;
8063			persis_io.pr.pr_info.action = CTL_PR_PREEMPT;
8064			persis_io.pr.pr_info.residx = lun->pr_res_idx;
8065			persis_io.pr.pr_info.res_type = type;
8066			memcpy(persis_io.pr.pr_info.sa_res_key,
8067			       param->serv_act_res_key,
8068			       sizeof(param->serv_act_res_key));
8069			ctl_ha_msg_send(CTL_HA_CHAN_CTL, &persis_io,
8070			    sizeof(persis_io.pr), M_WAITOK);
8071		}
8072	}
8073	return (0);
8074}
8075
8076static void
8077ctl_pro_preempt_other(struct ctl_lun *lun, union ctl_ha_msg *msg)
8078{
8079	uint64_t sa_res_key;
8080	int i;
8081
8082	sa_res_key = scsi_8btou64(msg->pr.pr_info.sa_res_key);
8083
8084	if (lun->pr_res_idx == CTL_PR_ALL_REGISTRANTS
8085	 || lun->pr_res_idx == CTL_PR_NO_RESERVATION
8086	 || sa_res_key != ctl_get_prkey(lun, lun->pr_res_idx)) {
8087		if (sa_res_key == 0) {
8088			/*
8089			 * Unregister everybody else and build UA for
8090			 * them
8091			 */
8092			for(i = 0; i < CTL_MAX_INITIATORS; i++) {
8093				if (i == msg->pr.pr_info.residx ||
8094				    ctl_get_prkey(lun, i) == 0)
8095					continue;
8096
8097				ctl_clr_prkey(lun, i);
8098				ctl_est_ua(lun, i, CTL_UA_REG_PREEMPT);
8099			}
8100
8101			lun->pr_key_count = 1;
8102			lun->pr_res_type = msg->pr.pr_info.res_type;
8103			if (lun->pr_res_type != SPR_TYPE_WR_EX_AR &&
8104			    lun->pr_res_type != SPR_TYPE_EX_AC_AR)
8105				lun->pr_res_idx = msg->pr.pr_info.residx;
8106		} else {
8107		        for (i = 0; i < CTL_MAX_INITIATORS; i++) {
8108				if (sa_res_key == ctl_get_prkey(lun, i))
8109					continue;
8110
8111				ctl_clr_prkey(lun, i);
8112				lun->pr_key_count--;
8113				ctl_est_ua(lun, i, CTL_UA_REG_PREEMPT);
8114			}
8115		}
8116	} else {
8117		for (i = 0; i < CTL_MAX_INITIATORS; i++) {
8118			if (i == msg->pr.pr_info.residx ||
8119			    ctl_get_prkey(lun, i) == 0)
8120				continue;
8121
8122			if (sa_res_key == ctl_get_prkey(lun, i)) {
8123				ctl_clr_prkey(lun, i);
8124				lun->pr_key_count--;
8125				ctl_est_ua(lun, i, CTL_UA_REG_PREEMPT);
8126			} else if (msg->pr.pr_info.res_type != lun->pr_res_type
8127			    && (lun->pr_res_type == SPR_TYPE_WR_EX_RO ||
8128			     lun->pr_res_type == SPR_TYPE_EX_AC_RO)) {
8129				ctl_est_ua(lun, i, CTL_UA_RES_RELEASE);
8130			}
8131		}
8132		lun->pr_res_type = msg->pr.pr_info.res_type;
8133		if (lun->pr_res_type != SPR_TYPE_WR_EX_AR &&
8134		    lun->pr_res_type != SPR_TYPE_EX_AC_AR)
8135			lun->pr_res_idx = msg->pr.pr_info.residx;
8136		else
8137			lun->pr_res_idx = CTL_PR_ALL_REGISTRANTS;
8138	}
8139	lun->pr_generation++;
8140
8141}
8142
8143
8144int
8145ctl_persistent_reserve_out(struct ctl_scsiio *ctsio)
8146{
8147	int retval;
8148	u_int32_t param_len;
8149	struct scsi_per_res_out *cdb;
8150	struct ctl_lun *lun;
8151	struct scsi_per_res_out_parms* param;
8152	struct ctl_softc *softc;
8153	uint32_t residx;
8154	uint64_t res_key, sa_res_key, key;
8155	uint8_t type;
8156	union ctl_ha_msg persis_io;
8157	int    i;
8158
8159	CTL_DEBUG_PRINT(("ctl_persistent_reserve_out\n"));
8160
8161	retval = CTL_RETVAL_COMPLETE;
8162
8163	cdb = (struct scsi_per_res_out *)ctsio->cdb;
8164	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
8165	softc = lun->ctl_softc;
8166
8167	/*
8168	 * We only support whole-LUN scope.  The scope & type are ignored for
8169	 * register, register and ignore existing key and clear.
8170	 * We sometimes ignore scope and type on preempts too!!
8171	 * Verify reservation type here as well.
8172	 */
8173	type = cdb->scope_type & SPR_TYPE_MASK;
8174	if ((cdb->action == SPRO_RESERVE)
8175	 || (cdb->action == SPRO_RELEASE)) {
8176		if ((cdb->scope_type & SPR_SCOPE_MASK) != SPR_LU_SCOPE) {
8177			ctl_set_invalid_field(/*ctsio*/ ctsio,
8178					      /*sks_valid*/ 1,
8179					      /*command*/ 1,
8180					      /*field*/ 2,
8181					      /*bit_valid*/ 1,
8182					      /*bit*/ 4);
8183			ctl_done((union ctl_io *)ctsio);
8184			return (CTL_RETVAL_COMPLETE);
8185		}
8186
8187		if (type>8 || type==2 || type==4 || type==0) {
8188			ctl_set_invalid_field(/*ctsio*/ ctsio,
8189					      /*sks_valid*/ 1,
8190					      /*command*/ 1,
8191					      /*field*/ 2,
8192					      /*bit_valid*/ 1,
8193					      /*bit*/ 0);
8194			ctl_done((union ctl_io *)ctsio);
8195			return (CTL_RETVAL_COMPLETE);
8196		}
8197	}
8198
8199	param_len = scsi_4btoul(cdb->length);
8200
8201	if ((ctsio->io_hdr.flags & CTL_FLAG_ALLOCATED) == 0) {
8202		ctsio->kern_data_ptr = malloc(param_len, M_CTL, M_WAITOK);
8203		ctsio->kern_data_len = param_len;
8204		ctsio->kern_total_len = param_len;
8205		ctsio->kern_data_resid = 0;
8206		ctsio->kern_rel_offset = 0;
8207		ctsio->kern_sg_entries = 0;
8208		ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
8209		ctsio->be_move_done = ctl_config_move_done;
8210		ctl_datamove((union ctl_io *)ctsio);
8211
8212		return (CTL_RETVAL_COMPLETE);
8213	}
8214
8215	param = (struct scsi_per_res_out_parms *)ctsio->kern_data_ptr;
8216
8217	residx = ctl_get_initindex(&ctsio->io_hdr.nexus);
8218	res_key = scsi_8btou64(param->res_key.key);
8219	sa_res_key = scsi_8btou64(param->serv_act_res_key);
8220
8221	/*
8222	 * Validate the reservation key here except for SPRO_REG_IGNO
8223	 * This must be done for all other service actions
8224	 */
8225	if ((cdb->action & SPRO_ACTION_MASK) != SPRO_REG_IGNO) {
8226		mtx_lock(&lun->lun_lock);
8227		if ((key = ctl_get_prkey(lun, residx)) != 0) {
8228			if (res_key != key) {
8229				/*
8230				 * The current key passed in doesn't match
8231				 * the one the initiator previously
8232				 * registered.
8233				 */
8234				mtx_unlock(&lun->lun_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		} else if ((cdb->action & SPRO_ACTION_MASK) != SPRO_REGISTER) {
8241			/*
8242			 * We are not registered
8243			 */
8244			mtx_unlock(&lun->lun_lock);
8245			free(ctsio->kern_data_ptr, M_CTL);
8246			ctl_set_reservation_conflict(ctsio);
8247			ctl_done((union ctl_io *)ctsio);
8248			return (CTL_RETVAL_COMPLETE);
8249		} else if (res_key != 0) {
8250			/*
8251			 * We are not registered and trying to register but
8252			 * the register key isn't zero.
8253			 */
8254			mtx_unlock(&lun->lun_lock);
8255			free(ctsio->kern_data_ptr, M_CTL);
8256			ctl_set_reservation_conflict(ctsio);
8257			ctl_done((union ctl_io *)ctsio);
8258			return (CTL_RETVAL_COMPLETE);
8259		}
8260		mtx_unlock(&lun->lun_lock);
8261	}
8262
8263	switch (cdb->action & SPRO_ACTION_MASK) {
8264	case SPRO_REGISTER:
8265	case SPRO_REG_IGNO: {
8266
8267#if 0
8268		printf("Registration received\n");
8269#endif
8270
8271		/*
8272		 * We don't support any of these options, as we report in
8273		 * the read capabilities request (see
8274		 * ctl_persistent_reserve_in(), above).
8275		 */
8276		if ((param->flags & SPR_SPEC_I_PT)
8277		 || (param->flags & SPR_ALL_TG_PT)
8278		 || (param->flags & SPR_APTPL)) {
8279			int bit_ptr;
8280
8281			if (param->flags & SPR_APTPL)
8282				bit_ptr = 0;
8283			else if (param->flags & SPR_ALL_TG_PT)
8284				bit_ptr = 2;
8285			else /* SPR_SPEC_I_PT */
8286				bit_ptr = 3;
8287
8288			free(ctsio->kern_data_ptr, M_CTL);
8289			ctl_set_invalid_field(ctsio,
8290					      /*sks_valid*/ 1,
8291					      /*command*/ 0,
8292					      /*field*/ 20,
8293					      /*bit_valid*/ 1,
8294					      /*bit*/ bit_ptr);
8295			ctl_done((union ctl_io *)ctsio);
8296			return (CTL_RETVAL_COMPLETE);
8297		}
8298
8299		mtx_lock(&lun->lun_lock);
8300
8301		/*
8302		 * The initiator wants to clear the
8303		 * key/unregister.
8304		 */
8305		if (sa_res_key == 0) {
8306			if ((res_key == 0
8307			  && (cdb->action & SPRO_ACTION_MASK) == SPRO_REGISTER)
8308			 || ((cdb->action & SPRO_ACTION_MASK) == SPRO_REG_IGNO
8309			  && ctl_get_prkey(lun, residx) == 0)) {
8310				mtx_unlock(&lun->lun_lock);
8311				goto done;
8312			}
8313
8314			ctl_clr_prkey(lun, residx);
8315			lun->pr_key_count--;
8316
8317			if (residx == lun->pr_res_idx) {
8318				lun->flags &= ~CTL_LUN_PR_RESERVED;
8319				lun->pr_res_idx = CTL_PR_NO_RESERVATION;
8320
8321				if ((lun->pr_res_type == SPR_TYPE_WR_EX_RO ||
8322				     lun->pr_res_type == SPR_TYPE_EX_AC_RO) &&
8323				    lun->pr_key_count) {
8324					/*
8325					 * If the reservation is a registrants
8326					 * only type we need to generate a UA
8327					 * for other registered inits.  The
8328					 * sense code should be RESERVATIONS
8329					 * RELEASED
8330					 */
8331
8332					for (i = softc->init_min; i < softc->init_max; i++){
8333						if (ctl_get_prkey(lun, i) == 0)
8334							continue;
8335						ctl_est_ua(lun, i,
8336						    CTL_UA_RES_RELEASE);
8337					}
8338				}
8339				lun->pr_res_type = 0;
8340			} else if (lun->pr_res_idx == CTL_PR_ALL_REGISTRANTS) {
8341				if (lun->pr_key_count==0) {
8342					lun->flags &= ~CTL_LUN_PR_RESERVED;
8343					lun->pr_res_type = 0;
8344					lun->pr_res_idx = CTL_PR_NO_RESERVATION;
8345				}
8346			}
8347			lun->pr_generation++;
8348			mtx_unlock(&lun->lun_lock);
8349
8350			persis_io.hdr.nexus = ctsio->io_hdr.nexus;
8351			persis_io.hdr.msg_type = CTL_MSG_PERS_ACTION;
8352			persis_io.pr.pr_info.action = CTL_PR_UNREG_KEY;
8353			persis_io.pr.pr_info.residx = residx;
8354			ctl_ha_msg_send(CTL_HA_CHAN_CTL, &persis_io,
8355			    sizeof(persis_io.pr), M_WAITOK);
8356		} else /* sa_res_key != 0 */ {
8357
8358			/*
8359			 * If we aren't registered currently then increment
8360			 * the key count and set the registered flag.
8361			 */
8362			ctl_alloc_prkey(lun, residx);
8363			if (ctl_get_prkey(lun, residx) == 0)
8364				lun->pr_key_count++;
8365			ctl_set_prkey(lun, residx, sa_res_key);
8366			lun->pr_generation++;
8367			mtx_unlock(&lun->lun_lock);
8368
8369			persis_io.hdr.nexus = ctsio->io_hdr.nexus;
8370			persis_io.hdr.msg_type = CTL_MSG_PERS_ACTION;
8371			persis_io.pr.pr_info.action = CTL_PR_REG_KEY;
8372			persis_io.pr.pr_info.residx = residx;
8373			memcpy(persis_io.pr.pr_info.sa_res_key,
8374			       param->serv_act_res_key,
8375			       sizeof(param->serv_act_res_key));
8376			ctl_ha_msg_send(CTL_HA_CHAN_CTL, &persis_io,
8377			    sizeof(persis_io.pr), M_WAITOK);
8378		}
8379
8380		break;
8381	}
8382	case SPRO_RESERVE:
8383#if 0
8384                printf("Reserve executed type %d\n", type);
8385#endif
8386		mtx_lock(&lun->lun_lock);
8387		if (lun->flags & CTL_LUN_PR_RESERVED) {
8388			/*
8389			 * if this isn't the reservation holder and it's
8390			 * not a "all registrants" type or if the type is
8391			 * different then we have a conflict
8392			 */
8393			if ((lun->pr_res_idx != residx
8394			  && lun->pr_res_idx != CTL_PR_ALL_REGISTRANTS)
8395			 || lun->pr_res_type != type) {
8396				mtx_unlock(&lun->lun_lock);
8397				free(ctsio->kern_data_ptr, M_CTL);
8398				ctl_set_reservation_conflict(ctsio);
8399				ctl_done((union ctl_io *)ctsio);
8400				return (CTL_RETVAL_COMPLETE);
8401			}
8402			mtx_unlock(&lun->lun_lock);
8403		} else /* create a reservation */ {
8404			/*
8405			 * If it's not an "all registrants" type record
8406			 * reservation holder
8407			 */
8408			if (type != SPR_TYPE_WR_EX_AR
8409			 && type != SPR_TYPE_EX_AC_AR)
8410				lun->pr_res_idx = residx; /* Res holder */
8411			else
8412				lun->pr_res_idx = CTL_PR_ALL_REGISTRANTS;
8413
8414			lun->flags |= CTL_LUN_PR_RESERVED;
8415			lun->pr_res_type = type;
8416
8417			mtx_unlock(&lun->lun_lock);
8418
8419			/* send msg to other side */
8420			persis_io.hdr.nexus = ctsio->io_hdr.nexus;
8421			persis_io.hdr.msg_type = CTL_MSG_PERS_ACTION;
8422			persis_io.pr.pr_info.action = CTL_PR_RESERVE;
8423			persis_io.pr.pr_info.residx = lun->pr_res_idx;
8424			persis_io.pr.pr_info.res_type = type;
8425			ctl_ha_msg_send(CTL_HA_CHAN_CTL, &persis_io,
8426			    sizeof(persis_io.pr), M_WAITOK);
8427		}
8428		break;
8429
8430	case SPRO_RELEASE:
8431		mtx_lock(&lun->lun_lock);
8432		if ((lun->flags & CTL_LUN_PR_RESERVED) == 0) {
8433			/* No reservation exists return good status */
8434			mtx_unlock(&lun->lun_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(&lun->lun_lock);
8447			goto done;
8448		}
8449
8450		if (lun->pr_res_type != type) {
8451			mtx_unlock(&lun->lun_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->pr_res_type = 0;
8462
8463		/*
8464		 * If this isn't an exclusive access reservation and NUAR
8465		 * is not set, generate UA for all other registrants.
8466		 */
8467		if (type != SPR_TYPE_EX_AC && type != SPR_TYPE_WR_EX &&
8468		    (lun->MODE_CTRL.queue_flags & SCP_NUAR) == 0) {
8469			for (i = softc->init_min; i < softc->init_max; i++) {
8470				if (i == residx || ctl_get_prkey(lun, i) == 0)
8471					continue;
8472				ctl_est_ua(lun, i, CTL_UA_RES_RELEASE);
8473			}
8474		}
8475		mtx_unlock(&lun->lun_lock);
8476
8477		/* Send msg to other side */
8478		persis_io.hdr.nexus = ctsio->io_hdr.nexus;
8479		persis_io.hdr.msg_type = CTL_MSG_PERS_ACTION;
8480		persis_io.pr.pr_info.action = CTL_PR_RELEASE;
8481		ctl_ha_msg_send(CTL_HA_CHAN_CTL, &persis_io,
8482		     sizeof(persis_io.pr), M_WAITOK);
8483		break;
8484
8485	case SPRO_CLEAR:
8486		/* send msg to other side */
8487
8488		mtx_lock(&lun->lun_lock);
8489		lun->flags &= ~CTL_LUN_PR_RESERVED;
8490		lun->pr_res_type = 0;
8491		lun->pr_key_count = 0;
8492		lun->pr_res_idx = CTL_PR_NO_RESERVATION;
8493
8494		ctl_clr_prkey(lun, residx);
8495		for (i = 0; i < CTL_MAX_INITIATORS; i++)
8496			if (ctl_get_prkey(lun, i) != 0) {
8497				ctl_clr_prkey(lun, i);
8498				ctl_est_ua(lun, i, CTL_UA_REG_PREEMPT);
8499			}
8500		lun->pr_generation++;
8501		mtx_unlock(&lun->lun_lock);
8502
8503		persis_io.hdr.nexus = ctsio->io_hdr.nexus;
8504		persis_io.hdr.msg_type = CTL_MSG_PERS_ACTION;
8505		persis_io.pr.pr_info.action = CTL_PR_CLEAR;
8506		ctl_ha_msg_send(CTL_HA_CHAN_CTL, &persis_io,
8507		     sizeof(persis_io.pr), M_WAITOK);
8508		break;
8509
8510	case SPRO_PREEMPT:
8511	case SPRO_PRE_ABO: {
8512		int nretval;
8513
8514		nretval = ctl_pro_preempt(softc, lun, res_key, sa_res_key, type,
8515					  residx, ctsio, cdb, param);
8516		if (nretval != 0)
8517			return (CTL_RETVAL_COMPLETE);
8518		break;
8519	}
8520	default:
8521		panic("%s: Invalid PR type %#x", __func__, cdb->action);
8522	}
8523
8524done:
8525	free(ctsio->kern_data_ptr, M_CTL);
8526	ctl_set_success(ctsio);
8527	ctl_done((union ctl_io *)ctsio);
8528
8529	return (retval);
8530}
8531
8532/*
8533 * This routine is for handling a message from the other SC pertaining to
8534 * persistent reserve out. All the error checking will have been done
8535 * so only perorming the action need be done here to keep the two
8536 * in sync.
8537 */
8538static void
8539ctl_hndl_per_res_out_on_other_sc(union ctl_ha_msg *msg)
8540{
8541	struct ctl_softc *softc = control_softc;
8542	struct ctl_lun *lun;
8543	int i;
8544	uint32_t residx, targ_lun;
8545
8546	targ_lun = msg->hdr.nexus.targ_mapped_lun;
8547	mtx_lock(&softc->ctl_lock);
8548	if ((targ_lun >= CTL_MAX_LUNS) ||
8549	    ((lun = softc->ctl_luns[targ_lun]) == NULL)) {
8550		mtx_unlock(&softc->ctl_lock);
8551		return;
8552	}
8553	mtx_lock(&lun->lun_lock);
8554	mtx_unlock(&softc->ctl_lock);
8555	if (lun->flags & CTL_LUN_DISABLED) {
8556		mtx_unlock(&lun->lun_lock);
8557		return;
8558	}
8559	residx = ctl_get_initindex(&msg->hdr.nexus);
8560	switch(msg->pr.pr_info.action) {
8561	case CTL_PR_REG_KEY:
8562		ctl_alloc_prkey(lun, msg->pr.pr_info.residx);
8563		if (ctl_get_prkey(lun, msg->pr.pr_info.residx) == 0)
8564			lun->pr_key_count++;
8565		ctl_set_prkey(lun, msg->pr.pr_info.residx,
8566		    scsi_8btou64(msg->pr.pr_info.sa_res_key));
8567		lun->pr_generation++;
8568		break;
8569
8570	case CTL_PR_UNREG_KEY:
8571		ctl_clr_prkey(lun, msg->pr.pr_info.residx);
8572		lun->pr_key_count--;
8573
8574		/* XXX Need to see if the reservation has been released */
8575		/* if so do we need to generate UA? */
8576		if (msg->pr.pr_info.residx == lun->pr_res_idx) {
8577			lun->flags &= ~CTL_LUN_PR_RESERVED;
8578			lun->pr_res_idx = CTL_PR_NO_RESERVATION;
8579
8580			if ((lun->pr_res_type == SPR_TYPE_WR_EX_RO ||
8581			     lun->pr_res_type == SPR_TYPE_EX_AC_RO) &&
8582			    lun->pr_key_count) {
8583				/*
8584				 * If the reservation is a registrants
8585				 * only type we need to generate a UA
8586				 * for other registered inits.  The
8587				 * sense code should be RESERVATIONS
8588				 * RELEASED
8589				 */
8590
8591				for (i = softc->init_min; i < softc->init_max; i++) {
8592					if (ctl_get_prkey(lun, i) == 0)
8593						continue;
8594
8595					ctl_est_ua(lun, i, CTL_UA_RES_RELEASE);
8596				}
8597			}
8598			lun->pr_res_type = 0;
8599		} else if (lun->pr_res_idx == CTL_PR_ALL_REGISTRANTS) {
8600			if (lun->pr_key_count==0) {
8601				lun->flags &= ~CTL_LUN_PR_RESERVED;
8602				lun->pr_res_type = 0;
8603				lun->pr_res_idx = CTL_PR_NO_RESERVATION;
8604			}
8605		}
8606		lun->pr_generation++;
8607		break;
8608
8609	case CTL_PR_RESERVE:
8610		lun->flags |= CTL_LUN_PR_RESERVED;
8611		lun->pr_res_type = msg->pr.pr_info.res_type;
8612		lun->pr_res_idx = msg->pr.pr_info.residx;
8613
8614		break;
8615
8616	case CTL_PR_RELEASE:
8617		/*
8618		 * If this isn't an exclusive access reservation and NUAR
8619		 * is not set, generate UA for all other registrants.
8620		 */
8621		if (lun->pr_res_type != SPR_TYPE_EX_AC &&
8622		    lun->pr_res_type != SPR_TYPE_WR_EX &&
8623		    (lun->MODE_CTRL.queue_flags & SCP_NUAR) == 0) {
8624			for (i = softc->init_min; i < softc->init_max; i++)
8625				if (i == residx || ctl_get_prkey(lun, i) == 0)
8626					continue;
8627				ctl_est_ua(lun, i, CTL_UA_RES_RELEASE);
8628		}
8629
8630		lun->flags &= ~CTL_LUN_PR_RESERVED;
8631		lun->pr_res_idx = CTL_PR_NO_RESERVATION;
8632		lun->pr_res_type = 0;
8633		break;
8634
8635	case CTL_PR_PREEMPT:
8636		ctl_pro_preempt_other(lun, msg);
8637		break;
8638	case CTL_PR_CLEAR:
8639		lun->flags &= ~CTL_LUN_PR_RESERVED;
8640		lun->pr_res_type = 0;
8641		lun->pr_key_count = 0;
8642		lun->pr_res_idx = CTL_PR_NO_RESERVATION;
8643
8644		for (i=0; i < CTL_MAX_INITIATORS; i++) {
8645			if (ctl_get_prkey(lun, i) == 0)
8646				continue;
8647			ctl_clr_prkey(lun, i);
8648			ctl_est_ua(lun, i, CTL_UA_REG_PREEMPT);
8649		}
8650		lun->pr_generation++;
8651		break;
8652	}
8653
8654	mtx_unlock(&lun->lun_lock);
8655}
8656
8657int
8658ctl_read_write(struct ctl_scsiio *ctsio)
8659{
8660	struct ctl_lun *lun;
8661	struct ctl_lba_len_flags *lbalen;
8662	uint64_t lba;
8663	uint32_t num_blocks;
8664	int flags, retval;
8665	int isread;
8666
8667	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
8668
8669	CTL_DEBUG_PRINT(("ctl_read_write: command: %#x\n", ctsio->cdb[0]));
8670
8671	flags = 0;
8672	isread = ctsio->cdb[0] == READ_6  || ctsio->cdb[0] == READ_10
8673	      || ctsio->cdb[0] == READ_12 || ctsio->cdb[0] == READ_16;
8674	switch (ctsio->cdb[0]) {
8675	case READ_6:
8676	case WRITE_6: {
8677		struct scsi_rw_6 *cdb;
8678
8679		cdb = (struct scsi_rw_6 *)ctsio->cdb;
8680
8681		lba = scsi_3btoul(cdb->addr);
8682		/* only 5 bits are valid in the most significant address byte */
8683		lba &= 0x1fffff;
8684		num_blocks = cdb->length;
8685		/*
8686		 * This is correct according to SBC-2.
8687		 */
8688		if (num_blocks == 0)
8689			num_blocks = 256;
8690		break;
8691	}
8692	case READ_10:
8693	case WRITE_10: {
8694		struct scsi_rw_10 *cdb;
8695
8696		cdb = (struct scsi_rw_10 *)ctsio->cdb;
8697		if (cdb->byte2 & SRW10_FUA)
8698			flags |= CTL_LLF_FUA;
8699		if (cdb->byte2 & SRW10_DPO)
8700			flags |= CTL_LLF_DPO;
8701		lba = scsi_4btoul(cdb->addr);
8702		num_blocks = scsi_2btoul(cdb->length);
8703		break;
8704	}
8705	case WRITE_VERIFY_10: {
8706		struct scsi_write_verify_10 *cdb;
8707
8708		cdb = (struct scsi_write_verify_10 *)ctsio->cdb;
8709		flags |= CTL_LLF_FUA;
8710		if (cdb->byte2 & SWV_DPO)
8711			flags |= CTL_LLF_DPO;
8712		lba = scsi_4btoul(cdb->addr);
8713		num_blocks = scsi_2btoul(cdb->length);
8714		break;
8715	}
8716	case READ_12:
8717	case WRITE_12: {
8718		struct scsi_rw_12 *cdb;
8719
8720		cdb = (struct scsi_rw_12 *)ctsio->cdb;
8721		if (cdb->byte2 & SRW12_FUA)
8722			flags |= CTL_LLF_FUA;
8723		if (cdb->byte2 & SRW12_DPO)
8724			flags |= CTL_LLF_DPO;
8725		lba = scsi_4btoul(cdb->addr);
8726		num_blocks = scsi_4btoul(cdb->length);
8727		break;
8728	}
8729	case WRITE_VERIFY_12: {
8730		struct scsi_write_verify_12 *cdb;
8731
8732		cdb = (struct scsi_write_verify_12 *)ctsio->cdb;
8733		flags |= CTL_LLF_FUA;
8734		if (cdb->byte2 & SWV_DPO)
8735			flags |= CTL_LLF_DPO;
8736		lba = scsi_4btoul(cdb->addr);
8737		num_blocks = scsi_4btoul(cdb->length);
8738		break;
8739	}
8740	case READ_16:
8741	case WRITE_16: {
8742		struct scsi_rw_16 *cdb;
8743
8744		cdb = (struct scsi_rw_16 *)ctsio->cdb;
8745		if (cdb->byte2 & SRW12_FUA)
8746			flags |= CTL_LLF_FUA;
8747		if (cdb->byte2 & SRW12_DPO)
8748			flags |= CTL_LLF_DPO;
8749		lba = scsi_8btou64(cdb->addr);
8750		num_blocks = scsi_4btoul(cdb->length);
8751		break;
8752	}
8753	case WRITE_ATOMIC_16: {
8754		struct scsi_write_atomic_16 *cdb;
8755
8756		if (lun->be_lun->atomicblock == 0) {
8757			ctl_set_invalid_opcode(ctsio);
8758			ctl_done((union ctl_io *)ctsio);
8759			return (CTL_RETVAL_COMPLETE);
8760		}
8761
8762		cdb = (struct scsi_write_atomic_16 *)ctsio->cdb;
8763		if (cdb->byte2 & SRW12_FUA)
8764			flags |= CTL_LLF_FUA;
8765		if (cdb->byte2 & SRW12_DPO)
8766			flags |= CTL_LLF_DPO;
8767		lba = scsi_8btou64(cdb->addr);
8768		num_blocks = scsi_2btoul(cdb->length);
8769		if (num_blocks > lun->be_lun->atomicblock) {
8770			ctl_set_invalid_field(ctsio, /*sks_valid*/ 1,
8771			    /*command*/ 1, /*field*/ 12, /*bit_valid*/ 0,
8772			    /*bit*/ 0);
8773			ctl_done((union ctl_io *)ctsio);
8774			return (CTL_RETVAL_COMPLETE);
8775		}
8776		break;
8777	}
8778	case WRITE_VERIFY_16: {
8779		struct scsi_write_verify_16 *cdb;
8780
8781		cdb = (struct scsi_write_verify_16 *)ctsio->cdb;
8782		flags |= CTL_LLF_FUA;
8783		if (cdb->byte2 & SWV_DPO)
8784			flags |= CTL_LLF_DPO;
8785		lba = scsi_8btou64(cdb->addr);
8786		num_blocks = scsi_4btoul(cdb->length);
8787		break;
8788	}
8789	default:
8790		/*
8791		 * We got a command we don't support.  This shouldn't
8792		 * happen, commands should be filtered out above us.
8793		 */
8794		ctl_set_invalid_opcode(ctsio);
8795		ctl_done((union ctl_io *)ctsio);
8796
8797		return (CTL_RETVAL_COMPLETE);
8798		break; /* NOTREACHED */
8799	}
8800
8801	/*
8802	 * The first check is to make sure we're in bounds, the second
8803	 * check is to catch wrap-around problems.  If the lba + num blocks
8804	 * is less than the lba, then we've wrapped around and the block
8805	 * range is invalid anyway.
8806	 */
8807	if (((lba + num_blocks) > (lun->be_lun->maxlba + 1))
8808	 || ((lba + num_blocks) < lba)) {
8809		ctl_set_lba_out_of_range(ctsio,
8810		    MAX(lba, lun->be_lun->maxlba + 1));
8811		ctl_done((union ctl_io *)ctsio);
8812		return (CTL_RETVAL_COMPLETE);
8813	}
8814
8815	/*
8816	 * According to SBC-3, a transfer length of 0 is not an error.
8817	 * Note that this cannot happen with WRITE(6) or READ(6), since 0
8818	 * translates to 256 blocks for those commands.
8819	 */
8820	if (num_blocks == 0) {
8821		ctl_set_success(ctsio);
8822		ctl_done((union ctl_io *)ctsio);
8823		return (CTL_RETVAL_COMPLETE);
8824	}
8825
8826	/* Set FUA and/or DPO if caches are disabled. */
8827	if (isread) {
8828		if ((lun->MODE_CACHING.flags1 & SCP_RCD) != 0)
8829			flags |= CTL_LLF_FUA | CTL_LLF_DPO;
8830	} else {
8831		if ((lun->MODE_CACHING.flags1 & SCP_WCE) == 0)
8832			flags |= CTL_LLF_FUA;
8833	}
8834
8835	lbalen = (struct ctl_lba_len_flags *)
8836	    &ctsio->io_hdr.ctl_private[CTL_PRIV_LBA_LEN];
8837	lbalen->lba = lba;
8838	lbalen->len = num_blocks;
8839	lbalen->flags = (isread ? CTL_LLF_READ : CTL_LLF_WRITE) | flags;
8840
8841	ctsio->kern_total_len = num_blocks * lun->be_lun->blocksize;
8842	ctsio->kern_rel_offset = 0;
8843
8844	CTL_DEBUG_PRINT(("ctl_read_write: calling data_submit()\n"));
8845
8846	retval = lun->backend->data_submit((union ctl_io *)ctsio);
8847	return (retval);
8848}
8849
8850static int
8851ctl_cnw_cont(union ctl_io *io)
8852{
8853	struct ctl_scsiio *ctsio;
8854	struct ctl_lun *lun;
8855	struct ctl_lba_len_flags *lbalen;
8856	int retval;
8857
8858	ctsio = &io->scsiio;
8859	ctsio->io_hdr.status = CTL_STATUS_NONE;
8860	ctsio->io_hdr.flags &= ~CTL_FLAG_IO_CONT;
8861	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
8862	lbalen = (struct ctl_lba_len_flags *)
8863	    &ctsio->io_hdr.ctl_private[CTL_PRIV_LBA_LEN];
8864	lbalen->flags &= ~CTL_LLF_COMPARE;
8865	lbalen->flags |= CTL_LLF_WRITE;
8866
8867	CTL_DEBUG_PRINT(("ctl_cnw_cont: calling data_submit()\n"));
8868	retval = lun->backend->data_submit((union ctl_io *)ctsio);
8869	return (retval);
8870}
8871
8872int
8873ctl_cnw(struct ctl_scsiio *ctsio)
8874{
8875	struct ctl_lun *lun;
8876	struct ctl_lba_len_flags *lbalen;
8877	uint64_t lba;
8878	uint32_t num_blocks;
8879	int flags, retval;
8880
8881	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
8882
8883	CTL_DEBUG_PRINT(("ctl_cnw: command: %#x\n", ctsio->cdb[0]));
8884
8885	flags = 0;
8886	switch (ctsio->cdb[0]) {
8887	case COMPARE_AND_WRITE: {
8888		struct scsi_compare_and_write *cdb;
8889
8890		cdb = (struct scsi_compare_and_write *)ctsio->cdb;
8891		if (cdb->byte2 & SRW10_FUA)
8892			flags |= CTL_LLF_FUA;
8893		if (cdb->byte2 & SRW10_DPO)
8894			flags |= CTL_LLF_DPO;
8895		lba = scsi_8btou64(cdb->addr);
8896		num_blocks = cdb->length;
8897		break;
8898	}
8899	default:
8900		/*
8901		 * We got a command we don't support.  This shouldn't
8902		 * happen, commands should be filtered out above us.
8903		 */
8904		ctl_set_invalid_opcode(ctsio);
8905		ctl_done((union ctl_io *)ctsio);
8906
8907		return (CTL_RETVAL_COMPLETE);
8908		break; /* NOTREACHED */
8909	}
8910
8911	/*
8912	 * The first check is to make sure we're in bounds, the second
8913	 * check is to catch wrap-around problems.  If the lba + num blocks
8914	 * is less than the lba, then we've wrapped around and the block
8915	 * range is invalid anyway.
8916	 */
8917	if (((lba + num_blocks) > (lun->be_lun->maxlba + 1))
8918	 || ((lba + num_blocks) < lba)) {
8919		ctl_set_lba_out_of_range(ctsio,
8920		    MAX(lba, lun->be_lun->maxlba + 1));
8921		ctl_done((union ctl_io *)ctsio);
8922		return (CTL_RETVAL_COMPLETE);
8923	}
8924
8925	/*
8926	 * According to SBC-3, a transfer length of 0 is not an error.
8927	 */
8928	if (num_blocks == 0) {
8929		ctl_set_success(ctsio);
8930		ctl_done((union ctl_io *)ctsio);
8931		return (CTL_RETVAL_COMPLETE);
8932	}
8933
8934	/* Set FUA if write cache is disabled. */
8935	if ((lun->MODE_CACHING.flags1 & SCP_WCE) == 0)
8936		flags |= CTL_LLF_FUA;
8937
8938	ctsio->kern_total_len = 2 * num_blocks * lun->be_lun->blocksize;
8939	ctsio->kern_rel_offset = 0;
8940
8941	/*
8942	 * Set the IO_CONT flag, so that if this I/O gets passed to
8943	 * ctl_data_submit_done(), it'll get passed back to
8944	 * ctl_ctl_cnw_cont() for further processing.
8945	 */
8946	ctsio->io_hdr.flags |= CTL_FLAG_IO_CONT;
8947	ctsio->io_cont = ctl_cnw_cont;
8948
8949	lbalen = (struct ctl_lba_len_flags *)
8950	    &ctsio->io_hdr.ctl_private[CTL_PRIV_LBA_LEN];
8951	lbalen->lba = lba;
8952	lbalen->len = num_blocks;
8953	lbalen->flags = CTL_LLF_COMPARE | flags;
8954
8955	CTL_DEBUG_PRINT(("ctl_cnw: calling data_submit()\n"));
8956	retval = lun->backend->data_submit((union ctl_io *)ctsio);
8957	return (retval);
8958}
8959
8960int
8961ctl_verify(struct ctl_scsiio *ctsio)
8962{
8963	struct ctl_lun *lun;
8964	struct ctl_lba_len_flags *lbalen;
8965	uint64_t lba;
8966	uint32_t num_blocks;
8967	int bytchk, flags;
8968	int retval;
8969
8970	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
8971
8972	CTL_DEBUG_PRINT(("ctl_verify: command: %#x\n", ctsio->cdb[0]));
8973
8974	bytchk = 0;
8975	flags = CTL_LLF_FUA;
8976	switch (ctsio->cdb[0]) {
8977	case VERIFY_10: {
8978		struct scsi_verify_10 *cdb;
8979
8980		cdb = (struct scsi_verify_10 *)ctsio->cdb;
8981		if (cdb->byte2 & SVFY_BYTCHK)
8982			bytchk = 1;
8983		if (cdb->byte2 & SVFY_DPO)
8984			flags |= CTL_LLF_DPO;
8985		lba = scsi_4btoul(cdb->addr);
8986		num_blocks = scsi_2btoul(cdb->length);
8987		break;
8988	}
8989	case VERIFY_12: {
8990		struct scsi_verify_12 *cdb;
8991
8992		cdb = (struct scsi_verify_12 *)ctsio->cdb;
8993		if (cdb->byte2 & SVFY_BYTCHK)
8994			bytchk = 1;
8995		if (cdb->byte2 & SVFY_DPO)
8996			flags |= CTL_LLF_DPO;
8997		lba = scsi_4btoul(cdb->addr);
8998		num_blocks = scsi_4btoul(cdb->length);
8999		break;
9000	}
9001	case VERIFY_16: {
9002		struct scsi_rw_16 *cdb;
9003
9004		cdb = (struct scsi_rw_16 *)ctsio->cdb;
9005		if (cdb->byte2 & SVFY_BYTCHK)
9006			bytchk = 1;
9007		if (cdb->byte2 & SVFY_DPO)
9008			flags |= CTL_LLF_DPO;
9009		lba = scsi_8btou64(cdb->addr);
9010		num_blocks = scsi_4btoul(cdb->length);
9011		break;
9012	}
9013	default:
9014		/*
9015		 * We got a command we don't support.  This shouldn't
9016		 * happen, commands should be filtered out above us.
9017		 */
9018		ctl_set_invalid_opcode(ctsio);
9019		ctl_done((union ctl_io *)ctsio);
9020		return (CTL_RETVAL_COMPLETE);
9021	}
9022
9023	/*
9024	 * The first check is to make sure we're in bounds, the second
9025	 * check is to catch wrap-around problems.  If the lba + num blocks
9026	 * is less than the lba, then we've wrapped around and the block
9027	 * range is invalid anyway.
9028	 */
9029	if (((lba + num_blocks) > (lun->be_lun->maxlba + 1))
9030	 || ((lba + num_blocks) < lba)) {
9031		ctl_set_lba_out_of_range(ctsio,
9032		    MAX(lba, lun->be_lun->maxlba + 1));
9033		ctl_done((union ctl_io *)ctsio);
9034		return (CTL_RETVAL_COMPLETE);
9035	}
9036
9037	/*
9038	 * According to SBC-3, a transfer length of 0 is not an error.
9039	 */
9040	if (num_blocks == 0) {
9041		ctl_set_success(ctsio);
9042		ctl_done((union ctl_io *)ctsio);
9043		return (CTL_RETVAL_COMPLETE);
9044	}
9045
9046	lbalen = (struct ctl_lba_len_flags *)
9047	    &ctsio->io_hdr.ctl_private[CTL_PRIV_LBA_LEN];
9048	lbalen->lba = lba;
9049	lbalen->len = num_blocks;
9050	if (bytchk) {
9051		lbalen->flags = CTL_LLF_COMPARE | flags;
9052		ctsio->kern_total_len = num_blocks * lun->be_lun->blocksize;
9053	} else {
9054		lbalen->flags = CTL_LLF_VERIFY | flags;
9055		ctsio->kern_total_len = 0;
9056	}
9057	ctsio->kern_rel_offset = 0;
9058
9059	CTL_DEBUG_PRINT(("ctl_verify: calling data_submit()\n"));
9060	retval = lun->backend->data_submit((union ctl_io *)ctsio);
9061	return (retval);
9062}
9063
9064int
9065ctl_report_luns(struct ctl_scsiio *ctsio)
9066{
9067	struct ctl_softc *softc;
9068	struct scsi_report_luns *cdb;
9069	struct scsi_report_luns_data *lun_data;
9070	struct ctl_lun *lun, *request_lun;
9071	struct ctl_port *port;
9072	int num_luns, retval;
9073	uint32_t alloc_len, lun_datalen;
9074	int num_filled;
9075	uint32_t initidx, targ_lun_id, lun_id;
9076
9077	retval = CTL_RETVAL_COMPLETE;
9078	cdb = (struct scsi_report_luns *)ctsio->cdb;
9079	port = ctl_io_port(&ctsio->io_hdr);
9080	softc = port->ctl_softc;
9081
9082	CTL_DEBUG_PRINT(("ctl_report_luns\n"));
9083
9084	mtx_lock(&softc->ctl_lock);
9085	num_luns = 0;
9086	for (targ_lun_id = 0; targ_lun_id < CTL_MAX_LUNS; targ_lun_id++) {
9087		if (ctl_lun_map_from_port(port, targ_lun_id) < CTL_MAX_LUNS)
9088			num_luns++;
9089	}
9090	mtx_unlock(&softc->ctl_lock);
9091
9092	switch (cdb->select_report) {
9093	case RPL_REPORT_DEFAULT:
9094	case RPL_REPORT_ALL:
9095	case RPL_REPORT_NONSUBSID:
9096		break;
9097	case RPL_REPORT_WELLKNOWN:
9098	case RPL_REPORT_ADMIN:
9099	case RPL_REPORT_CONGLOM:
9100		num_luns = 0;
9101		break;
9102	default:
9103		ctl_set_invalid_field(ctsio,
9104				      /*sks_valid*/ 1,
9105				      /*command*/ 1,
9106				      /*field*/ 2,
9107				      /*bit_valid*/ 0,
9108				      /*bit*/ 0);
9109		ctl_done((union ctl_io *)ctsio);
9110		return (retval);
9111		break; /* NOTREACHED */
9112	}
9113
9114	alloc_len = scsi_4btoul(cdb->length);
9115	/*
9116	 * The initiator has to allocate at least 16 bytes for this request,
9117	 * so he can at least get the header and the first LUN.  Otherwise
9118	 * we reject the request (per SPC-3 rev 14, section 6.21).
9119	 */
9120	if (alloc_len < (sizeof(struct scsi_report_luns_data) +
9121	    sizeof(struct scsi_report_luns_lundata))) {
9122		ctl_set_invalid_field(ctsio,
9123				      /*sks_valid*/ 1,
9124				      /*command*/ 1,
9125				      /*field*/ 6,
9126				      /*bit_valid*/ 0,
9127				      /*bit*/ 0);
9128		ctl_done((union ctl_io *)ctsio);
9129		return (retval);
9130	}
9131
9132	request_lun = (struct ctl_lun *)
9133		ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
9134
9135	lun_datalen = sizeof(*lun_data) +
9136		(num_luns * sizeof(struct scsi_report_luns_lundata));
9137
9138	ctsio->kern_data_ptr = malloc(lun_datalen, M_CTL, M_WAITOK | M_ZERO);
9139	lun_data = (struct scsi_report_luns_data *)ctsio->kern_data_ptr;
9140	ctsio->kern_sg_entries = 0;
9141
9142	initidx = ctl_get_initindex(&ctsio->io_hdr.nexus);
9143
9144	mtx_lock(&softc->ctl_lock);
9145	for (targ_lun_id = 0, num_filled = 0; targ_lun_id < CTL_MAX_LUNS && num_filled < num_luns; targ_lun_id++) {
9146		lun_id = ctl_lun_map_from_port(port, targ_lun_id);
9147		if (lun_id >= CTL_MAX_LUNS)
9148			continue;
9149		lun = softc->ctl_luns[lun_id];
9150		if (lun == NULL)
9151			continue;
9152
9153		be64enc(lun_data->luns[num_filled++].lundata,
9154		    ctl_encode_lun(targ_lun_id));
9155
9156		/*
9157		 * According to SPC-3, rev 14 section 6.21:
9158		 *
9159		 * "The execution of a REPORT LUNS command to any valid and
9160		 * installed logical unit shall clear the REPORTED LUNS DATA
9161		 * HAS CHANGED unit attention condition for all logical
9162		 * units of that target with respect to the requesting
9163		 * initiator. A valid and installed logical unit is one
9164		 * having a PERIPHERAL QUALIFIER of 000b in the standard
9165		 * INQUIRY data (see 6.4.2)."
9166		 *
9167		 * If request_lun is NULL, the LUN this report luns command
9168		 * was issued to is either disabled or doesn't exist. In that
9169		 * case, we shouldn't clear any pending lun change unit
9170		 * attention.
9171		 */
9172		if (request_lun != NULL) {
9173			mtx_lock(&lun->lun_lock);
9174			ctl_clr_ua(lun, initidx, CTL_UA_LUN_CHANGE);
9175			mtx_unlock(&lun->lun_lock);
9176		}
9177	}
9178	mtx_unlock(&softc->ctl_lock);
9179
9180	/*
9181	 * It's quite possible that we've returned fewer LUNs than we allocated
9182	 * space for.  Trim it.
9183	 */
9184	lun_datalen = sizeof(*lun_data) +
9185		(num_filled * sizeof(struct scsi_report_luns_lundata));
9186
9187	if (lun_datalen < alloc_len) {
9188		ctsio->residual = alloc_len - lun_datalen;
9189		ctsio->kern_data_len = lun_datalen;
9190		ctsio->kern_total_len = lun_datalen;
9191	} else {
9192		ctsio->residual = 0;
9193		ctsio->kern_data_len = alloc_len;
9194		ctsio->kern_total_len = alloc_len;
9195	}
9196	ctsio->kern_data_resid = 0;
9197	ctsio->kern_rel_offset = 0;
9198	ctsio->kern_sg_entries = 0;
9199
9200	/*
9201	 * We set this to the actual data length, regardless of how much
9202	 * space we actually have to return results.  If the user looks at
9203	 * this value, he'll know whether or not he allocated enough space
9204	 * and reissue the command if necessary.  We don't support well
9205	 * known logical units, so if the user asks for that, return none.
9206	 */
9207	scsi_ulto4b(lun_datalen - 8, lun_data->length);
9208
9209	/*
9210	 * We can only return SCSI_STATUS_CHECK_COND when we can't satisfy
9211	 * this request.
9212	 */
9213	ctl_set_success(ctsio);
9214	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
9215	ctsio->be_move_done = ctl_config_move_done;
9216	ctl_datamove((union ctl_io *)ctsio);
9217	return (retval);
9218}
9219
9220int
9221ctl_request_sense(struct ctl_scsiio *ctsio)
9222{
9223	struct scsi_request_sense *cdb;
9224	struct scsi_sense_data *sense_ptr;
9225	struct ctl_softc *softc;
9226	struct ctl_lun *lun;
9227	uint32_t initidx;
9228	int have_error;
9229	scsi_sense_data_type sense_format;
9230	ctl_ua_type ua_type;
9231	uint8_t asc = 0, ascq = 0;
9232
9233	cdb = (struct scsi_request_sense *)ctsio->cdb;
9234
9235	softc = control_softc;
9236	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
9237
9238	CTL_DEBUG_PRINT(("ctl_request_sense\n"));
9239
9240	/*
9241	 * Determine which sense format the user wants.
9242	 */
9243	if (cdb->byte2 & SRS_DESC)
9244		sense_format = SSD_TYPE_DESC;
9245	else
9246		sense_format = SSD_TYPE_FIXED;
9247
9248	ctsio->kern_data_ptr = malloc(sizeof(*sense_ptr), M_CTL, M_WAITOK);
9249	sense_ptr = (struct scsi_sense_data *)ctsio->kern_data_ptr;
9250	ctsio->kern_sg_entries = 0;
9251
9252	/*
9253	 * struct scsi_sense_data, which is currently set to 256 bytes, is
9254	 * larger than the largest allowed value for the length field in the
9255	 * REQUEST SENSE CDB, which is 252 bytes as of SPC-4.
9256	 */
9257	ctsio->residual = 0;
9258	ctsio->kern_data_len = cdb->length;
9259	ctsio->kern_total_len = cdb->length;
9260
9261	ctsio->kern_data_resid = 0;
9262	ctsio->kern_rel_offset = 0;
9263	ctsio->kern_sg_entries = 0;
9264
9265	/*
9266	 * If we don't have a LUN, we don't have any pending sense.
9267	 */
9268	if (lun == NULL ||
9269	    ((lun->flags & CTL_LUN_PRIMARY_SC) == 0 &&
9270	     softc->ha_link < CTL_HA_LINK_UNKNOWN)) {
9271		/* "Logical unit not supported" */
9272		ctl_set_sense_data(sense_ptr, NULL, sense_format,
9273		    /*current_error*/ 1,
9274		    /*sense_key*/ SSD_KEY_ILLEGAL_REQUEST,
9275		    /*asc*/ 0x25,
9276		    /*ascq*/ 0x00,
9277		    SSD_ELEM_NONE);
9278		goto send;
9279	}
9280
9281	have_error = 0;
9282	initidx = ctl_get_initindex(&ctsio->io_hdr.nexus);
9283	/*
9284	 * Check for pending sense, and then for pending unit attentions.
9285	 * Pending sense gets returned first, then pending unit attentions.
9286	 */
9287	mtx_lock(&lun->lun_lock);
9288#ifdef CTL_WITH_CA
9289	if (ctl_is_set(lun->have_ca, initidx)) {
9290		scsi_sense_data_type stored_format;
9291
9292		/*
9293		 * Check to see which sense format was used for the stored
9294		 * sense data.
9295		 */
9296		stored_format = scsi_sense_type(&lun->pending_sense[initidx]);
9297
9298		/*
9299		 * If the user requested a different sense format than the
9300		 * one we stored, then we need to convert it to the other
9301		 * format.  If we're going from descriptor to fixed format
9302		 * sense data, we may lose things in translation, depending
9303		 * on what options were used.
9304		 *
9305		 * If the stored format is SSD_TYPE_NONE (i.e. invalid),
9306		 * for some reason we'll just copy it out as-is.
9307		 */
9308		if ((stored_format == SSD_TYPE_FIXED)
9309		 && (sense_format == SSD_TYPE_DESC))
9310			ctl_sense_to_desc((struct scsi_sense_data_fixed *)
9311			    &lun->pending_sense[initidx],
9312			    (struct scsi_sense_data_desc *)sense_ptr);
9313		else if ((stored_format == SSD_TYPE_DESC)
9314		      && (sense_format == SSD_TYPE_FIXED))
9315			ctl_sense_to_fixed((struct scsi_sense_data_desc *)
9316			    &lun->pending_sense[initidx],
9317			    (struct scsi_sense_data_fixed *)sense_ptr);
9318		else
9319			memcpy(sense_ptr, &lun->pending_sense[initidx],
9320			       MIN(sizeof(*sense_ptr),
9321			       sizeof(lun->pending_sense[initidx])));
9322
9323		ctl_clear_mask(lun->have_ca, initidx);
9324		have_error = 1;
9325	} else
9326#endif
9327	if (have_error == 0) {
9328		ua_type = ctl_build_ua(lun, initidx, sense_ptr, sense_format);
9329		if (ua_type != CTL_UA_NONE)
9330			have_error = 1;
9331	}
9332	if (have_error == 0) {
9333		/*
9334		 * Report informational exception if have one and allowed.
9335		 */
9336		if (lun->MODE_IE.mrie != SIEP_MRIE_NO) {
9337			asc = lun->ie_asc;
9338			ascq = lun->ie_ascq;
9339		}
9340		ctl_set_sense_data(sense_ptr, lun, sense_format,
9341		    /*current_error*/ 1,
9342		    /*sense_key*/ SSD_KEY_NO_SENSE,
9343		    /*asc*/ asc,
9344		    /*ascq*/ ascq,
9345		    SSD_ELEM_NONE);
9346	}
9347	mtx_unlock(&lun->lun_lock);
9348
9349send:
9350	/*
9351	 * We report the SCSI status as OK, since the status of the command
9352	 * itself is OK.  We're reporting sense as parameter data.
9353	 */
9354	ctl_set_success(ctsio);
9355	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
9356	ctsio->be_move_done = ctl_config_move_done;
9357	ctl_datamove((union ctl_io *)ctsio);
9358	return (CTL_RETVAL_COMPLETE);
9359}
9360
9361int
9362ctl_tur(struct ctl_scsiio *ctsio)
9363{
9364
9365	CTL_DEBUG_PRINT(("ctl_tur\n"));
9366
9367	ctl_set_success(ctsio);
9368	ctl_done((union ctl_io *)ctsio);
9369
9370	return (CTL_RETVAL_COMPLETE);
9371}
9372
9373/*
9374 * SCSI VPD page 0x00, the Supported VPD Pages page.
9375 */
9376static int
9377ctl_inquiry_evpd_supported(struct ctl_scsiio *ctsio, int alloc_len)
9378{
9379	struct scsi_vpd_supported_pages *pages;
9380	int sup_page_size;
9381	struct ctl_lun *lun;
9382	int p;
9383
9384	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
9385
9386	sup_page_size = sizeof(struct scsi_vpd_supported_pages) *
9387	    SCSI_EVPD_NUM_SUPPORTED_PAGES;
9388	ctsio->kern_data_ptr = malloc(sup_page_size, M_CTL, M_WAITOK | M_ZERO);
9389	pages = (struct scsi_vpd_supported_pages *)ctsio->kern_data_ptr;
9390	ctsio->kern_sg_entries = 0;
9391
9392	if (sup_page_size < alloc_len) {
9393		ctsio->residual = alloc_len - sup_page_size;
9394		ctsio->kern_data_len = sup_page_size;
9395		ctsio->kern_total_len = sup_page_size;
9396	} else {
9397		ctsio->residual = 0;
9398		ctsio->kern_data_len = alloc_len;
9399		ctsio->kern_total_len = alloc_len;
9400	}
9401	ctsio->kern_data_resid = 0;
9402	ctsio->kern_rel_offset = 0;
9403	ctsio->kern_sg_entries = 0;
9404
9405	/*
9406	 * The control device is always connected.  The disk device, on the
9407	 * other hand, may not be online all the time.  Need to change this
9408	 * to figure out whether the disk device is actually online or not.
9409	 */
9410	if (lun != NULL)
9411		pages->device = (SID_QUAL_LU_CONNECTED << 5) |
9412				lun->be_lun->lun_type;
9413	else
9414		pages->device = (SID_QUAL_LU_OFFLINE << 5) | T_DIRECT;
9415
9416	p = 0;
9417	/* Supported VPD pages */
9418	pages->page_list[p++] = SVPD_SUPPORTED_PAGES;
9419	/* Serial Number */
9420	pages->page_list[p++] = SVPD_UNIT_SERIAL_NUMBER;
9421	/* Device Identification */
9422	pages->page_list[p++] = SVPD_DEVICE_ID;
9423	/* Extended INQUIRY Data */
9424	pages->page_list[p++] = SVPD_EXTENDED_INQUIRY_DATA;
9425	/* Mode Page Policy */
9426	pages->page_list[p++] = SVPD_MODE_PAGE_POLICY;
9427	/* SCSI Ports */
9428	pages->page_list[p++] = SVPD_SCSI_PORTS;
9429	/* Third-party Copy */
9430	pages->page_list[p++] = SVPD_SCSI_TPC;
9431	if (lun != NULL && lun->be_lun->lun_type == T_DIRECT) {
9432		/* Block limits */
9433		pages->page_list[p++] = SVPD_BLOCK_LIMITS;
9434		/* Block Device Characteristics */
9435		pages->page_list[p++] = SVPD_BDC;
9436		/* Logical Block Provisioning */
9437		pages->page_list[p++] = SVPD_LBP;
9438	}
9439	pages->length = p;
9440
9441	ctl_set_success(ctsio);
9442	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
9443	ctsio->be_move_done = ctl_config_move_done;
9444	ctl_datamove((union ctl_io *)ctsio);
9445	return (CTL_RETVAL_COMPLETE);
9446}
9447
9448/*
9449 * SCSI VPD page 0x80, the Unit Serial Number page.
9450 */
9451static int
9452ctl_inquiry_evpd_serial(struct ctl_scsiio *ctsio, int alloc_len)
9453{
9454	struct scsi_vpd_unit_serial_number *sn_ptr;
9455	struct ctl_lun *lun;
9456	int data_len;
9457
9458	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
9459
9460	data_len = 4 + CTL_SN_LEN;
9461	ctsio->kern_data_ptr = malloc(data_len, M_CTL, M_WAITOK | M_ZERO);
9462	sn_ptr = (struct scsi_vpd_unit_serial_number *)ctsio->kern_data_ptr;
9463	if (data_len < alloc_len) {
9464		ctsio->residual = alloc_len - data_len;
9465		ctsio->kern_data_len = data_len;
9466		ctsio->kern_total_len = data_len;
9467	} else {
9468		ctsio->residual = 0;
9469		ctsio->kern_data_len = alloc_len;
9470		ctsio->kern_total_len = alloc_len;
9471	}
9472	ctsio->kern_data_resid = 0;
9473	ctsio->kern_rel_offset = 0;
9474	ctsio->kern_sg_entries = 0;
9475
9476	/*
9477	 * The control device is always connected.  The disk device, on the
9478	 * other hand, may not be online all the time.  Need to change this
9479	 * to figure out whether the disk device is actually online or not.
9480	 */
9481	if (lun != NULL)
9482		sn_ptr->device = (SID_QUAL_LU_CONNECTED << 5) |
9483				  lun->be_lun->lun_type;
9484	else
9485		sn_ptr->device = (SID_QUAL_LU_OFFLINE << 5) | T_DIRECT;
9486
9487	sn_ptr->page_code = SVPD_UNIT_SERIAL_NUMBER;
9488	sn_ptr->length = CTL_SN_LEN;
9489	/*
9490	 * If we don't have a LUN, we just leave the serial number as
9491	 * all spaces.
9492	 */
9493	if (lun != NULL) {
9494		strncpy((char *)sn_ptr->serial_num,
9495			(char *)lun->be_lun->serial_num, CTL_SN_LEN);
9496	} else
9497		memset(sn_ptr->serial_num, 0x20, CTL_SN_LEN);
9498
9499	ctl_set_success(ctsio);
9500	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
9501	ctsio->be_move_done = ctl_config_move_done;
9502	ctl_datamove((union ctl_io *)ctsio);
9503	return (CTL_RETVAL_COMPLETE);
9504}
9505
9506
9507/*
9508 * SCSI VPD page 0x86, the Extended INQUIRY Data page.
9509 */
9510static int
9511ctl_inquiry_evpd_eid(struct ctl_scsiio *ctsio, int alloc_len)
9512{
9513	struct scsi_vpd_extended_inquiry_data *eid_ptr;
9514	struct ctl_lun *lun;
9515	int data_len;
9516
9517	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
9518
9519	data_len = sizeof(struct scsi_vpd_extended_inquiry_data);
9520	ctsio->kern_data_ptr = malloc(data_len, M_CTL, M_WAITOK | M_ZERO);
9521	eid_ptr = (struct scsi_vpd_extended_inquiry_data *)ctsio->kern_data_ptr;
9522	ctsio->kern_sg_entries = 0;
9523
9524	if (data_len < alloc_len) {
9525		ctsio->residual = alloc_len - data_len;
9526		ctsio->kern_data_len = data_len;
9527		ctsio->kern_total_len = data_len;
9528	} else {
9529		ctsio->residual = 0;
9530		ctsio->kern_data_len = alloc_len;
9531		ctsio->kern_total_len = alloc_len;
9532	}
9533	ctsio->kern_data_resid = 0;
9534	ctsio->kern_rel_offset = 0;
9535	ctsio->kern_sg_entries = 0;
9536
9537	/*
9538	 * The control device is always connected.  The disk device, on the
9539	 * other hand, may not be online all the time.
9540	 */
9541	if (lun != NULL)
9542		eid_ptr->device = (SID_QUAL_LU_CONNECTED << 5) |
9543				     lun->be_lun->lun_type;
9544	else
9545		eid_ptr->device = (SID_QUAL_LU_OFFLINE << 5) | T_DIRECT;
9546	eid_ptr->page_code = SVPD_EXTENDED_INQUIRY_DATA;
9547	scsi_ulto2b(data_len - 4, eid_ptr->page_length);
9548	/*
9549	 * We support head of queue, ordered and simple tags.
9550	 */
9551	eid_ptr->flags2 = SVPD_EID_HEADSUP | SVPD_EID_ORDSUP | SVPD_EID_SIMPSUP;
9552	/*
9553	 * Volatile cache supported.
9554	 */
9555	eid_ptr->flags3 = SVPD_EID_V_SUP;
9556
9557	/*
9558	 * This means that we clear the REPORTED LUNS DATA HAS CHANGED unit
9559	 * attention for a particular IT nexus on all LUNs once we report
9560	 * it to that nexus once.  This bit is required as of SPC-4.
9561	 */
9562	eid_ptr->flags4 = SVPD_EID_LUICLR;
9563
9564	/*
9565	 * XXX KDM in order to correctly answer this, we would need
9566	 * information from the SIM to determine how much sense data it
9567	 * can send.  So this would really be a path inquiry field, most
9568	 * likely.  This can be set to a maximum of 252 according to SPC-4,
9569	 * but the hardware may or may not be able to support that much.
9570	 * 0 just means that the maximum sense data length is not reported.
9571	 */
9572	eid_ptr->max_sense_length = 0;
9573
9574	ctl_set_success(ctsio);
9575	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
9576	ctsio->be_move_done = ctl_config_move_done;
9577	ctl_datamove((union ctl_io *)ctsio);
9578	return (CTL_RETVAL_COMPLETE);
9579}
9580
9581static int
9582ctl_inquiry_evpd_mpp(struct ctl_scsiio *ctsio, int alloc_len)
9583{
9584	struct scsi_vpd_mode_page_policy *mpp_ptr;
9585	struct ctl_lun *lun;
9586	int data_len;
9587
9588	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
9589
9590	data_len = sizeof(struct scsi_vpd_mode_page_policy) +
9591	    sizeof(struct scsi_vpd_mode_page_policy_descr);
9592
9593	ctsio->kern_data_ptr = malloc(data_len, M_CTL, M_WAITOK | M_ZERO);
9594	mpp_ptr = (struct scsi_vpd_mode_page_policy *)ctsio->kern_data_ptr;
9595	ctsio->kern_sg_entries = 0;
9596
9597	if (data_len < alloc_len) {
9598		ctsio->residual = alloc_len - data_len;
9599		ctsio->kern_data_len = data_len;
9600		ctsio->kern_total_len = data_len;
9601	} else {
9602		ctsio->residual = 0;
9603		ctsio->kern_data_len = alloc_len;
9604		ctsio->kern_total_len = alloc_len;
9605	}
9606	ctsio->kern_data_resid = 0;
9607	ctsio->kern_rel_offset = 0;
9608	ctsio->kern_sg_entries = 0;
9609
9610	/*
9611	 * The control device is always connected.  The disk device, on the
9612	 * other hand, may not be online all the time.
9613	 */
9614	if (lun != NULL)
9615		mpp_ptr->device = (SID_QUAL_LU_CONNECTED << 5) |
9616				     lun->be_lun->lun_type;
9617	else
9618		mpp_ptr->device = (SID_QUAL_LU_OFFLINE << 5) | T_DIRECT;
9619	mpp_ptr->page_code = SVPD_MODE_PAGE_POLICY;
9620	scsi_ulto2b(data_len - 4, mpp_ptr->page_length);
9621	mpp_ptr->descr[0].page_code = 0x3f;
9622	mpp_ptr->descr[0].subpage_code = 0xff;
9623	mpp_ptr->descr[0].policy = SVPD_MPP_SHARED;
9624
9625	ctl_set_success(ctsio);
9626	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
9627	ctsio->be_move_done = ctl_config_move_done;
9628	ctl_datamove((union ctl_io *)ctsio);
9629	return (CTL_RETVAL_COMPLETE);
9630}
9631
9632/*
9633 * SCSI VPD page 0x83, the Device Identification page.
9634 */
9635static int
9636ctl_inquiry_evpd_devid(struct ctl_scsiio *ctsio, int alloc_len)
9637{
9638	struct scsi_vpd_device_id *devid_ptr;
9639	struct scsi_vpd_id_descriptor *desc;
9640	struct ctl_softc *softc;
9641	struct ctl_lun *lun;
9642	struct ctl_port *port;
9643	int data_len, g;
9644	uint8_t proto;
9645
9646	softc = control_softc;
9647
9648	port = ctl_io_port(&ctsio->io_hdr);
9649	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
9650
9651	data_len = sizeof(struct scsi_vpd_device_id) +
9652	    sizeof(struct scsi_vpd_id_descriptor) +
9653		sizeof(struct scsi_vpd_id_rel_trgt_port_id) +
9654	    sizeof(struct scsi_vpd_id_descriptor) +
9655		sizeof(struct scsi_vpd_id_trgt_port_grp_id);
9656	if (lun && lun->lun_devid)
9657		data_len += lun->lun_devid->len;
9658	if (port && port->port_devid)
9659		data_len += port->port_devid->len;
9660	if (port && port->target_devid)
9661		data_len += port->target_devid->len;
9662
9663	ctsio->kern_data_ptr = malloc(data_len, M_CTL, M_WAITOK | M_ZERO);
9664	devid_ptr = (struct scsi_vpd_device_id *)ctsio->kern_data_ptr;
9665	ctsio->kern_sg_entries = 0;
9666
9667	if (data_len < alloc_len) {
9668		ctsio->residual = alloc_len - data_len;
9669		ctsio->kern_data_len = data_len;
9670		ctsio->kern_total_len = data_len;
9671	} else {
9672		ctsio->residual = 0;
9673		ctsio->kern_data_len = alloc_len;
9674		ctsio->kern_total_len = alloc_len;
9675	}
9676	ctsio->kern_data_resid = 0;
9677	ctsio->kern_rel_offset = 0;
9678	ctsio->kern_sg_entries = 0;
9679
9680	/*
9681	 * The control device is always connected.  The disk device, on the
9682	 * other hand, may not be online all the time.
9683	 */
9684	if (lun != NULL)
9685		devid_ptr->device = (SID_QUAL_LU_CONNECTED << 5) |
9686				     lun->be_lun->lun_type;
9687	else
9688		devid_ptr->device = (SID_QUAL_LU_OFFLINE << 5) | T_DIRECT;
9689	devid_ptr->page_code = SVPD_DEVICE_ID;
9690	scsi_ulto2b(data_len - 4, devid_ptr->length);
9691
9692	if (port && port->port_type == CTL_PORT_FC)
9693		proto = SCSI_PROTO_FC << 4;
9694	else if (port && port->port_type == CTL_PORT_ISCSI)
9695		proto = SCSI_PROTO_ISCSI << 4;
9696	else
9697		proto = SCSI_PROTO_SPI << 4;
9698	desc = (struct scsi_vpd_id_descriptor *)devid_ptr->desc_list;
9699
9700	/*
9701	 * We're using a LUN association here.  i.e., this device ID is a
9702	 * per-LUN identifier.
9703	 */
9704	if (lun && lun->lun_devid) {
9705		memcpy(desc, lun->lun_devid->data, lun->lun_devid->len);
9706		desc = (struct scsi_vpd_id_descriptor *)((uint8_t *)desc +
9707		    lun->lun_devid->len);
9708	}
9709
9710	/*
9711	 * This is for the WWPN which is a port association.
9712	 */
9713	if (port && port->port_devid) {
9714		memcpy(desc, port->port_devid->data, port->port_devid->len);
9715		desc = (struct scsi_vpd_id_descriptor *)((uint8_t *)desc +
9716		    port->port_devid->len);
9717	}
9718
9719	/*
9720	 * This is for the Relative Target Port(type 4h) identifier
9721	 */
9722	desc->proto_codeset = proto | SVPD_ID_CODESET_BINARY;
9723	desc->id_type = SVPD_ID_PIV | SVPD_ID_ASSOC_PORT |
9724	    SVPD_ID_TYPE_RELTARG;
9725	desc->length = 4;
9726	scsi_ulto2b(ctsio->io_hdr.nexus.targ_port, &desc->identifier[2]);
9727	desc = (struct scsi_vpd_id_descriptor *)(&desc->identifier[0] +
9728	    sizeof(struct scsi_vpd_id_rel_trgt_port_id));
9729
9730	/*
9731	 * This is for the Target Port Group(type 5h) identifier
9732	 */
9733	desc->proto_codeset = proto | SVPD_ID_CODESET_BINARY;
9734	desc->id_type = SVPD_ID_PIV | SVPD_ID_ASSOC_PORT |
9735	    SVPD_ID_TYPE_TPORTGRP;
9736	desc->length = 4;
9737	if (softc->is_single ||
9738	    (port && port->status & CTL_PORT_STATUS_HA_SHARED))
9739		g = 1;
9740	else
9741		g = 2 + ctsio->io_hdr.nexus.targ_port / softc->port_cnt;
9742	scsi_ulto2b(g, &desc->identifier[2]);
9743	desc = (struct scsi_vpd_id_descriptor *)(&desc->identifier[0] +
9744	    sizeof(struct scsi_vpd_id_trgt_port_grp_id));
9745
9746	/*
9747	 * This is for the Target identifier
9748	 */
9749	if (port && port->target_devid) {
9750		memcpy(desc, port->target_devid->data, port->target_devid->len);
9751	}
9752
9753	ctl_set_success(ctsio);
9754	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
9755	ctsio->be_move_done = ctl_config_move_done;
9756	ctl_datamove((union ctl_io *)ctsio);
9757	return (CTL_RETVAL_COMPLETE);
9758}
9759
9760static int
9761ctl_inquiry_evpd_scsi_ports(struct ctl_scsiio *ctsio, int alloc_len)
9762{
9763	struct ctl_softc *softc = control_softc;
9764	struct scsi_vpd_scsi_ports *sp;
9765	struct scsi_vpd_port_designation *pd;
9766	struct scsi_vpd_port_designation_cont *pdc;
9767	struct ctl_lun *lun;
9768	struct ctl_port *port;
9769	int data_len, num_target_ports, iid_len, id_len;
9770
9771	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
9772
9773	num_target_ports = 0;
9774	iid_len = 0;
9775	id_len = 0;
9776	mtx_lock(&softc->ctl_lock);
9777	STAILQ_FOREACH(port, &softc->port_list, links) {
9778		if ((port->status & CTL_PORT_STATUS_ONLINE) == 0)
9779			continue;
9780		if (lun != NULL &&
9781		    ctl_lun_map_to_port(port, lun->lun) >= CTL_MAX_LUNS)
9782			continue;
9783		num_target_ports++;
9784		if (port->init_devid)
9785			iid_len += port->init_devid->len;
9786		if (port->port_devid)
9787			id_len += port->port_devid->len;
9788	}
9789	mtx_unlock(&softc->ctl_lock);
9790
9791	data_len = sizeof(struct scsi_vpd_scsi_ports) +
9792	    num_target_ports * (sizeof(struct scsi_vpd_port_designation) +
9793	     sizeof(struct scsi_vpd_port_designation_cont)) + iid_len + id_len;
9794	ctsio->kern_data_ptr = malloc(data_len, M_CTL, M_WAITOK | M_ZERO);
9795	sp = (struct scsi_vpd_scsi_ports *)ctsio->kern_data_ptr;
9796	ctsio->kern_sg_entries = 0;
9797
9798	if (data_len < alloc_len) {
9799		ctsio->residual = alloc_len - data_len;
9800		ctsio->kern_data_len = data_len;
9801		ctsio->kern_total_len = data_len;
9802	} else {
9803		ctsio->residual = 0;
9804		ctsio->kern_data_len = alloc_len;
9805		ctsio->kern_total_len = alloc_len;
9806	}
9807	ctsio->kern_data_resid = 0;
9808	ctsio->kern_rel_offset = 0;
9809	ctsio->kern_sg_entries = 0;
9810
9811	/*
9812	 * The control device is always connected.  The disk device, on the
9813	 * other hand, may not be online all the time.  Need to change this
9814	 * to figure out whether the disk device is actually online or not.
9815	 */
9816	if (lun != NULL)
9817		sp->device = (SID_QUAL_LU_CONNECTED << 5) |
9818				  lun->be_lun->lun_type;
9819	else
9820		sp->device = (SID_QUAL_LU_OFFLINE << 5) | T_DIRECT;
9821
9822	sp->page_code = SVPD_SCSI_PORTS;
9823	scsi_ulto2b(data_len - sizeof(struct scsi_vpd_scsi_ports),
9824	    sp->page_length);
9825	pd = &sp->design[0];
9826
9827	mtx_lock(&softc->ctl_lock);
9828	STAILQ_FOREACH(port, &softc->port_list, links) {
9829		if ((port->status & CTL_PORT_STATUS_ONLINE) == 0)
9830			continue;
9831		if (lun != NULL &&
9832		    ctl_lun_map_to_port(port, lun->lun) >= CTL_MAX_LUNS)
9833			continue;
9834		scsi_ulto2b(port->targ_port, pd->relative_port_id);
9835		if (port->init_devid) {
9836			iid_len = port->init_devid->len;
9837			memcpy(pd->initiator_transportid,
9838			    port->init_devid->data, port->init_devid->len);
9839		} else
9840			iid_len = 0;
9841		scsi_ulto2b(iid_len, pd->initiator_transportid_length);
9842		pdc = (struct scsi_vpd_port_designation_cont *)
9843		    (&pd->initiator_transportid[iid_len]);
9844		if (port->port_devid) {
9845			id_len = port->port_devid->len;
9846			memcpy(pdc->target_port_descriptors,
9847			    port->port_devid->data, port->port_devid->len);
9848		} else
9849			id_len = 0;
9850		scsi_ulto2b(id_len, pdc->target_port_descriptors_length);
9851		pd = (struct scsi_vpd_port_designation *)
9852		    ((uint8_t *)pdc->target_port_descriptors + id_len);
9853	}
9854	mtx_unlock(&softc->ctl_lock);
9855
9856	ctl_set_success(ctsio);
9857	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
9858	ctsio->be_move_done = ctl_config_move_done;
9859	ctl_datamove((union ctl_io *)ctsio);
9860	return (CTL_RETVAL_COMPLETE);
9861}
9862
9863static int
9864ctl_inquiry_evpd_block_limits(struct ctl_scsiio *ctsio, int alloc_len)
9865{
9866	struct scsi_vpd_block_limits *bl_ptr;
9867	struct ctl_lun *lun;
9868	uint64_t ival;
9869
9870	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
9871
9872	ctsio->kern_data_ptr = malloc(sizeof(*bl_ptr), M_CTL, M_WAITOK | M_ZERO);
9873	bl_ptr = (struct scsi_vpd_block_limits *)ctsio->kern_data_ptr;
9874	ctsio->kern_sg_entries = 0;
9875
9876	if (sizeof(*bl_ptr) < alloc_len) {
9877		ctsio->residual = alloc_len - sizeof(*bl_ptr);
9878		ctsio->kern_data_len = sizeof(*bl_ptr);
9879		ctsio->kern_total_len = sizeof(*bl_ptr);
9880	} else {
9881		ctsio->residual = 0;
9882		ctsio->kern_data_len = alloc_len;
9883		ctsio->kern_total_len = alloc_len;
9884	}
9885	ctsio->kern_data_resid = 0;
9886	ctsio->kern_rel_offset = 0;
9887	ctsio->kern_sg_entries = 0;
9888
9889	/*
9890	 * The control device is always connected.  The disk device, on the
9891	 * other hand, may not be online all the time.  Need to change this
9892	 * to figure out whether the disk device is actually online or not.
9893	 */
9894	if (lun != NULL)
9895		bl_ptr->device = (SID_QUAL_LU_CONNECTED << 5) |
9896				  lun->be_lun->lun_type;
9897	else
9898		bl_ptr->device = (SID_QUAL_LU_OFFLINE << 5) | T_DIRECT;
9899
9900	bl_ptr->page_code = SVPD_BLOCK_LIMITS;
9901	scsi_ulto2b(sizeof(*bl_ptr) - 4, bl_ptr->page_length);
9902	bl_ptr->max_cmp_write_len = 0xff;
9903	scsi_ulto4b(0xffffffff, bl_ptr->max_txfer_len);
9904	if (lun != NULL) {
9905		scsi_ulto4b(lun->be_lun->opttxferlen, bl_ptr->opt_txfer_len);
9906		if (lun->be_lun->flags & CTL_LUN_FLAG_UNMAP) {
9907			ival = 0xffffffff;
9908			ctl_get_opt_number(&lun->be_lun->options,
9909			    "unmap_max_lba", &ival);
9910			scsi_ulto4b(ival, bl_ptr->max_unmap_lba_cnt);
9911			ival = 0xffffffff;
9912			ctl_get_opt_number(&lun->be_lun->options,
9913			    "unmap_max_descr", &ival);
9914			scsi_ulto4b(ival, bl_ptr->max_unmap_blk_cnt);
9915			if (lun->be_lun->ublockexp != 0) {
9916				scsi_ulto4b((1 << lun->be_lun->ublockexp),
9917				    bl_ptr->opt_unmap_grain);
9918				scsi_ulto4b(0x80000000 | lun->be_lun->ublockoff,
9919				    bl_ptr->unmap_grain_align);
9920			}
9921		}
9922		scsi_ulto4b(lun->be_lun->atomicblock,
9923		    bl_ptr->max_atomic_transfer_length);
9924		scsi_ulto4b(0, bl_ptr->atomic_alignment);
9925		scsi_ulto4b(0, bl_ptr->atomic_transfer_length_granularity);
9926		scsi_ulto4b(0, bl_ptr->max_atomic_transfer_length_with_atomic_boundary);
9927		scsi_ulto4b(0, bl_ptr->max_atomic_boundary_size);
9928		ival = UINT64_MAX;
9929		ctl_get_opt_number(&lun->be_lun->options, "write_same_max_lba", &ival);
9930		scsi_u64to8b(ival, bl_ptr->max_write_same_length);
9931	}
9932
9933	ctl_set_success(ctsio);
9934	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
9935	ctsio->be_move_done = ctl_config_move_done;
9936	ctl_datamove((union ctl_io *)ctsio);
9937	return (CTL_RETVAL_COMPLETE);
9938}
9939
9940static int
9941ctl_inquiry_evpd_bdc(struct ctl_scsiio *ctsio, int alloc_len)
9942{
9943	struct scsi_vpd_block_device_characteristics *bdc_ptr;
9944	struct ctl_lun *lun;
9945	const char *value;
9946	u_int i;
9947
9948	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
9949
9950	ctsio->kern_data_ptr = malloc(sizeof(*bdc_ptr), M_CTL, M_WAITOK | M_ZERO);
9951	bdc_ptr = (struct scsi_vpd_block_device_characteristics *)ctsio->kern_data_ptr;
9952	ctsio->kern_sg_entries = 0;
9953
9954	if (sizeof(*bdc_ptr) < alloc_len) {
9955		ctsio->residual = alloc_len - sizeof(*bdc_ptr);
9956		ctsio->kern_data_len = sizeof(*bdc_ptr);
9957		ctsio->kern_total_len = sizeof(*bdc_ptr);
9958	} else {
9959		ctsio->residual = 0;
9960		ctsio->kern_data_len = alloc_len;
9961		ctsio->kern_total_len = alloc_len;
9962	}
9963	ctsio->kern_data_resid = 0;
9964	ctsio->kern_rel_offset = 0;
9965	ctsio->kern_sg_entries = 0;
9966
9967	/*
9968	 * The control device is always connected.  The disk device, on the
9969	 * other hand, may not be online all the time.  Need to change this
9970	 * to figure out whether the disk device is actually online or not.
9971	 */
9972	if (lun != NULL)
9973		bdc_ptr->device = (SID_QUAL_LU_CONNECTED << 5) |
9974				  lun->be_lun->lun_type;
9975	else
9976		bdc_ptr->device = (SID_QUAL_LU_OFFLINE << 5) | T_DIRECT;
9977	bdc_ptr->page_code = SVPD_BDC;
9978	scsi_ulto2b(sizeof(*bdc_ptr) - 4, bdc_ptr->page_length);
9979	if (lun != NULL &&
9980	    (value = ctl_get_opt(&lun->be_lun->options, "rpm")) != NULL)
9981		i = strtol(value, NULL, 0);
9982	else
9983		i = CTL_DEFAULT_ROTATION_RATE;
9984	scsi_ulto2b(i, bdc_ptr->medium_rotation_rate);
9985	if (lun != NULL &&
9986	    (value = ctl_get_opt(&lun->be_lun->options, "formfactor")) != NULL)
9987		i = strtol(value, NULL, 0);
9988	else
9989		i = 0;
9990	bdc_ptr->wab_wac_ff = (i & 0x0f);
9991	bdc_ptr->flags = SVPD_FUAB | SVPD_VBULS;
9992
9993	ctl_set_success(ctsio);
9994	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
9995	ctsio->be_move_done = ctl_config_move_done;
9996	ctl_datamove((union ctl_io *)ctsio);
9997	return (CTL_RETVAL_COMPLETE);
9998}
9999
10000static int
10001ctl_inquiry_evpd_lbp(struct ctl_scsiio *ctsio, int alloc_len)
10002{
10003	struct scsi_vpd_logical_block_prov *lbp_ptr;
10004	struct ctl_lun *lun;
10005	const char *value;
10006
10007	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
10008
10009	ctsio->kern_data_ptr = malloc(sizeof(*lbp_ptr), M_CTL, M_WAITOK | M_ZERO);
10010	lbp_ptr = (struct scsi_vpd_logical_block_prov *)ctsio->kern_data_ptr;
10011	ctsio->kern_sg_entries = 0;
10012
10013	if (sizeof(*lbp_ptr) < alloc_len) {
10014		ctsio->residual = alloc_len - sizeof(*lbp_ptr);
10015		ctsio->kern_data_len = sizeof(*lbp_ptr);
10016		ctsio->kern_total_len = sizeof(*lbp_ptr);
10017	} else {
10018		ctsio->residual = 0;
10019		ctsio->kern_data_len = alloc_len;
10020		ctsio->kern_total_len = alloc_len;
10021	}
10022	ctsio->kern_data_resid = 0;
10023	ctsio->kern_rel_offset = 0;
10024	ctsio->kern_sg_entries = 0;
10025
10026	/*
10027	 * The control device is always connected.  The disk device, on the
10028	 * other hand, may not be online all the time.  Need to change this
10029	 * to figure out whether the disk device is actually online or not.
10030	 */
10031	if (lun != NULL)
10032		lbp_ptr->device = (SID_QUAL_LU_CONNECTED << 5) |
10033				  lun->be_lun->lun_type;
10034	else
10035		lbp_ptr->device = (SID_QUAL_LU_OFFLINE << 5) | T_DIRECT;
10036
10037	lbp_ptr->page_code = SVPD_LBP;
10038	scsi_ulto2b(sizeof(*lbp_ptr) - 4, lbp_ptr->page_length);
10039	lbp_ptr->threshold_exponent = CTL_LBP_EXPONENT;
10040	if (lun != NULL && lun->be_lun->flags & CTL_LUN_FLAG_UNMAP) {
10041		lbp_ptr->flags = SVPD_LBP_UNMAP | SVPD_LBP_WS16 |
10042		    SVPD_LBP_WS10 | SVPD_LBP_RZ | SVPD_LBP_ANC_SUP;
10043		value = ctl_get_opt(&lun->be_lun->options, "provisioning_type");
10044		if (value != NULL) {
10045			if (strcmp(value, "resource") == 0)
10046				lbp_ptr->prov_type = SVPD_LBP_RESOURCE;
10047			else if (strcmp(value, "thin") == 0)
10048				lbp_ptr->prov_type = SVPD_LBP_THIN;
10049		} else
10050			lbp_ptr->prov_type = SVPD_LBP_THIN;
10051	}
10052
10053	ctl_set_success(ctsio);
10054	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
10055	ctsio->be_move_done = ctl_config_move_done;
10056	ctl_datamove((union ctl_io *)ctsio);
10057	return (CTL_RETVAL_COMPLETE);
10058}
10059
10060/*
10061 * INQUIRY with the EVPD bit set.
10062 */
10063static int
10064ctl_inquiry_evpd(struct ctl_scsiio *ctsio)
10065{
10066	struct ctl_lun *lun;
10067	struct scsi_inquiry *cdb;
10068	int alloc_len, retval;
10069
10070	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
10071	cdb = (struct scsi_inquiry *)ctsio->cdb;
10072	alloc_len = scsi_2btoul(cdb->length);
10073
10074	switch (cdb->page_code) {
10075	case SVPD_SUPPORTED_PAGES:
10076		retval = ctl_inquiry_evpd_supported(ctsio, alloc_len);
10077		break;
10078	case SVPD_UNIT_SERIAL_NUMBER:
10079		retval = ctl_inquiry_evpd_serial(ctsio, alloc_len);
10080		break;
10081	case SVPD_DEVICE_ID:
10082		retval = ctl_inquiry_evpd_devid(ctsio, alloc_len);
10083		break;
10084	case SVPD_EXTENDED_INQUIRY_DATA:
10085		retval = ctl_inquiry_evpd_eid(ctsio, alloc_len);
10086		break;
10087	case SVPD_MODE_PAGE_POLICY:
10088		retval = ctl_inquiry_evpd_mpp(ctsio, alloc_len);
10089		break;
10090	case SVPD_SCSI_PORTS:
10091		retval = ctl_inquiry_evpd_scsi_ports(ctsio, alloc_len);
10092		break;
10093	case SVPD_SCSI_TPC:
10094		retval = ctl_inquiry_evpd_tpc(ctsio, alloc_len);
10095		break;
10096	case SVPD_BLOCK_LIMITS:
10097		if (lun == NULL || lun->be_lun->lun_type != T_DIRECT)
10098			goto err;
10099		retval = ctl_inquiry_evpd_block_limits(ctsio, alloc_len);
10100		break;
10101	case SVPD_BDC:
10102		if (lun == NULL || lun->be_lun->lun_type != T_DIRECT)
10103			goto err;
10104		retval = ctl_inquiry_evpd_bdc(ctsio, alloc_len);
10105		break;
10106	case SVPD_LBP:
10107		if (lun == NULL || lun->be_lun->lun_type != T_DIRECT)
10108			goto err;
10109		retval = ctl_inquiry_evpd_lbp(ctsio, alloc_len);
10110		break;
10111	default:
10112err:
10113		ctl_set_invalid_field(ctsio,
10114				      /*sks_valid*/ 1,
10115				      /*command*/ 1,
10116				      /*field*/ 2,
10117				      /*bit_valid*/ 0,
10118				      /*bit*/ 0);
10119		ctl_done((union ctl_io *)ctsio);
10120		retval = CTL_RETVAL_COMPLETE;
10121		break;
10122	}
10123
10124	return (retval);
10125}
10126
10127/*
10128 * Standard INQUIRY data.
10129 */
10130static int
10131ctl_inquiry_std(struct ctl_scsiio *ctsio)
10132{
10133	struct scsi_inquiry_data *inq_ptr;
10134	struct scsi_inquiry *cdb;
10135	struct ctl_softc *softc = control_softc;
10136	struct ctl_port *port;
10137	struct ctl_lun *lun;
10138	char *val;
10139	uint32_t alloc_len, data_len;
10140	ctl_port_type port_type;
10141
10142	port = ctl_io_port(&ctsio->io_hdr);
10143	port_type = port->port_type;
10144	if (port_type == CTL_PORT_IOCTL || port_type == CTL_PORT_INTERNAL)
10145		port_type = CTL_PORT_SCSI;
10146
10147	lun = ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
10148	cdb = (struct scsi_inquiry *)ctsio->cdb;
10149	alloc_len = scsi_2btoul(cdb->length);
10150
10151	/*
10152	 * We malloc the full inquiry data size here and fill it
10153	 * in.  If the user only asks for less, we'll give him
10154	 * that much.
10155	 */
10156	data_len = offsetof(struct scsi_inquiry_data, vendor_specific1);
10157	ctsio->kern_data_ptr = malloc(data_len, M_CTL, M_WAITOK | M_ZERO);
10158	inq_ptr = (struct scsi_inquiry_data *)ctsio->kern_data_ptr;
10159	ctsio->kern_sg_entries = 0;
10160	ctsio->kern_data_resid = 0;
10161	ctsio->kern_rel_offset = 0;
10162
10163	if (data_len < alloc_len) {
10164		ctsio->residual = alloc_len - data_len;
10165		ctsio->kern_data_len = data_len;
10166		ctsio->kern_total_len = data_len;
10167	} else {
10168		ctsio->residual = 0;
10169		ctsio->kern_data_len = alloc_len;
10170		ctsio->kern_total_len = alloc_len;
10171	}
10172
10173	if (lun != NULL) {
10174		if ((lun->flags & CTL_LUN_PRIMARY_SC) ||
10175		    softc->ha_link >= CTL_HA_LINK_UNKNOWN) {
10176			inq_ptr->device = (SID_QUAL_LU_CONNECTED << 5) |
10177			    lun->be_lun->lun_type;
10178		} else {
10179			inq_ptr->device = (SID_QUAL_LU_OFFLINE << 5) |
10180			    lun->be_lun->lun_type;
10181		}
10182		if (lun->flags & CTL_LUN_REMOVABLE)
10183			inq_ptr->dev_qual2 |= SID_RMB;
10184	} else
10185		inq_ptr->device = (SID_QUAL_BAD_LU << 5) | T_NODEVICE;
10186
10187	/* RMB in byte 2 is 0 */
10188	inq_ptr->version = SCSI_REV_SPC5;
10189
10190	/*
10191	 * According to SAM-3, even if a device only supports a single
10192	 * level of LUN addressing, it should still set the HISUP bit:
10193	 *
10194	 * 4.9.1 Logical unit numbers overview
10195	 *
10196	 * All logical unit number formats described in this standard are
10197	 * hierarchical in structure even when only a single level in that
10198	 * hierarchy is used. The HISUP bit shall be set to one in the
10199	 * standard INQUIRY data (see SPC-2) when any logical unit number
10200	 * format described in this standard is used.  Non-hierarchical
10201	 * formats are outside the scope of this standard.
10202	 *
10203	 * Therefore we set the HiSup bit here.
10204	 *
10205	 * The response format is 2, per SPC-3.
10206	 */
10207	inq_ptr->response_format = SID_HiSup | 2;
10208
10209	inq_ptr->additional_length = data_len -
10210	    (offsetof(struct scsi_inquiry_data, additional_length) + 1);
10211	CTL_DEBUG_PRINT(("additional_length = %d\n",
10212			 inq_ptr->additional_length));
10213
10214	inq_ptr->spc3_flags = SPC3_SID_3PC | SPC3_SID_TPGS_IMPLICIT;
10215	if (port_type == CTL_PORT_SCSI)
10216		inq_ptr->spc2_flags = SPC2_SID_ADDR16;
10217	inq_ptr->spc2_flags |= SPC2_SID_MultiP;
10218	inq_ptr->flags = SID_CmdQue;
10219	if (port_type == CTL_PORT_SCSI)
10220		inq_ptr->flags |= SID_WBus16 | SID_Sync;
10221
10222	/*
10223	 * Per SPC-3, unused bytes in ASCII strings are filled with spaces.
10224	 * We have 8 bytes for the vendor name, and 16 bytes for the device
10225	 * name and 4 bytes for the revision.
10226	 */
10227	if (lun == NULL || (val = ctl_get_opt(&lun->be_lun->options,
10228	    "vendor")) == NULL) {
10229		strncpy(inq_ptr->vendor, CTL_VENDOR, sizeof(inq_ptr->vendor));
10230	} else {
10231		memset(inq_ptr->vendor, ' ', sizeof(inq_ptr->vendor));
10232		strncpy(inq_ptr->vendor, val,
10233		    min(sizeof(inq_ptr->vendor), strlen(val)));
10234	}
10235	if (lun == NULL) {
10236		strncpy(inq_ptr->product, CTL_DIRECT_PRODUCT,
10237		    sizeof(inq_ptr->product));
10238	} else if ((val = ctl_get_opt(&lun->be_lun->options, "product")) == NULL) {
10239		switch (lun->be_lun->lun_type) {
10240		case T_DIRECT:
10241			strncpy(inq_ptr->product, CTL_DIRECT_PRODUCT,
10242			    sizeof(inq_ptr->product));
10243			break;
10244		case T_PROCESSOR:
10245			strncpy(inq_ptr->product, CTL_PROCESSOR_PRODUCT,
10246			    sizeof(inq_ptr->product));
10247			break;
10248		case T_CDROM:
10249			strncpy(inq_ptr->product, CTL_CDROM_PRODUCT,
10250			    sizeof(inq_ptr->product));
10251			break;
10252		default:
10253			strncpy(inq_ptr->product, CTL_UNKNOWN_PRODUCT,
10254			    sizeof(inq_ptr->product));
10255			break;
10256		}
10257	} else {
10258		memset(inq_ptr->product, ' ', sizeof(inq_ptr->product));
10259		strncpy(inq_ptr->product, val,
10260		    min(sizeof(inq_ptr->product), strlen(val)));
10261	}
10262
10263	/*
10264	 * XXX make this a macro somewhere so it automatically gets
10265	 * incremented when we make changes.
10266	 */
10267	if (lun == NULL || (val = ctl_get_opt(&lun->be_lun->options,
10268	    "revision")) == NULL) {
10269		strncpy(inq_ptr->revision, "0001", sizeof(inq_ptr->revision));
10270	} else {
10271		memset(inq_ptr->revision, ' ', sizeof(inq_ptr->revision));
10272		strncpy(inq_ptr->revision, val,
10273		    min(sizeof(inq_ptr->revision), strlen(val)));
10274	}
10275
10276	/*
10277	 * For parallel SCSI, we support double transition and single
10278	 * transition clocking.  We also support QAS (Quick Arbitration
10279	 * and Selection) and Information Unit transfers on both the
10280	 * control and array devices.
10281	 */
10282	if (port_type == CTL_PORT_SCSI)
10283		inq_ptr->spi3data = SID_SPI_CLOCK_DT_ST | SID_SPI_QAS |
10284				    SID_SPI_IUS;
10285
10286	/* SAM-6 (no version claimed) */
10287	scsi_ulto2b(0x00C0, inq_ptr->version1);
10288	/* SPC-5 (no version claimed) */
10289	scsi_ulto2b(0x05C0, inq_ptr->version2);
10290	if (port_type == CTL_PORT_FC) {
10291		/* FCP-2 ANSI INCITS.350:2003 */
10292		scsi_ulto2b(0x0917, inq_ptr->version3);
10293	} else if (port_type == CTL_PORT_SCSI) {
10294		/* SPI-4 ANSI INCITS.362:200x */
10295		scsi_ulto2b(0x0B56, inq_ptr->version3);
10296	} else if (port_type == CTL_PORT_ISCSI) {
10297		/* iSCSI (no version claimed) */
10298		scsi_ulto2b(0x0960, inq_ptr->version3);
10299	} else if (port_type == CTL_PORT_SAS) {
10300		/* SAS (no version claimed) */
10301		scsi_ulto2b(0x0BE0, inq_ptr->version3);
10302	}
10303
10304	if (lun == NULL) {
10305		/* SBC-4 (no version claimed) */
10306		scsi_ulto2b(0x0600, inq_ptr->version4);
10307	} else {
10308		switch (lun->be_lun->lun_type) {
10309		case T_DIRECT:
10310			/* SBC-4 (no version claimed) */
10311			scsi_ulto2b(0x0600, inq_ptr->version4);
10312			break;
10313		case T_PROCESSOR:
10314			break;
10315		case T_CDROM:
10316			/* MMC-6 (no version claimed) */
10317			scsi_ulto2b(0x04E0, inq_ptr->version4);
10318			break;
10319		default:
10320			break;
10321		}
10322	}
10323
10324	ctl_set_success(ctsio);
10325	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
10326	ctsio->be_move_done = ctl_config_move_done;
10327	ctl_datamove((union ctl_io *)ctsio);
10328	return (CTL_RETVAL_COMPLETE);
10329}
10330
10331int
10332ctl_inquiry(struct ctl_scsiio *ctsio)
10333{
10334	struct scsi_inquiry *cdb;
10335	int retval;
10336
10337	CTL_DEBUG_PRINT(("ctl_inquiry\n"));
10338
10339	cdb = (struct scsi_inquiry *)ctsio->cdb;
10340	if (cdb->byte2 & SI_EVPD)
10341		retval = ctl_inquiry_evpd(ctsio);
10342	else if (cdb->page_code == 0)
10343		retval = ctl_inquiry_std(ctsio);
10344	else {
10345		ctl_set_invalid_field(ctsio,
10346				      /*sks_valid*/ 1,
10347				      /*command*/ 1,
10348				      /*field*/ 2,
10349				      /*bit_valid*/ 0,
10350				      /*bit*/ 0);
10351		ctl_done((union ctl_io *)ctsio);
10352		return (CTL_RETVAL_COMPLETE);
10353	}
10354
10355	return (retval);
10356}
10357
10358int
10359ctl_get_config(struct ctl_scsiio *ctsio)
10360{
10361	struct scsi_get_config_header *hdr;
10362	struct scsi_get_config_feature *feature;
10363	struct scsi_get_config *cdb;
10364	struct ctl_lun *lun;
10365	uint32_t alloc_len, data_len;
10366	int rt, starting;
10367
10368	lun = ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
10369	cdb = (struct scsi_get_config *)ctsio->cdb;
10370	rt = (cdb->rt & SGC_RT_MASK);
10371	starting = scsi_2btoul(cdb->starting_feature);
10372	alloc_len = scsi_2btoul(cdb->length);
10373
10374	data_len = sizeof(struct scsi_get_config_header) +
10375	    sizeof(struct scsi_get_config_feature) + 8 +
10376	    sizeof(struct scsi_get_config_feature) + 8 +
10377	    sizeof(struct scsi_get_config_feature) + 4 +
10378	    sizeof(struct scsi_get_config_feature) + 4 +
10379	    sizeof(struct scsi_get_config_feature) + 8 +
10380	    sizeof(struct scsi_get_config_feature) +
10381	    sizeof(struct scsi_get_config_feature) + 4 +
10382	    sizeof(struct scsi_get_config_feature) + 4 +
10383	    sizeof(struct scsi_get_config_feature) + 4 +
10384	    sizeof(struct scsi_get_config_feature) + 4 +
10385	    sizeof(struct scsi_get_config_feature) + 4 +
10386	    sizeof(struct scsi_get_config_feature) + 4;
10387	ctsio->kern_data_ptr = malloc(data_len, M_CTL, M_WAITOK | M_ZERO);
10388	ctsio->kern_sg_entries = 0;
10389	ctsio->kern_data_resid = 0;
10390	ctsio->kern_rel_offset = 0;
10391
10392	hdr = (struct scsi_get_config_header *)ctsio->kern_data_ptr;
10393	if (lun->flags & CTL_LUN_NO_MEDIA)
10394		scsi_ulto2b(0x0000, hdr->current_profile);
10395	else
10396		scsi_ulto2b(0x0010, hdr->current_profile);
10397	feature = (struct scsi_get_config_feature *)(hdr + 1);
10398
10399	if (starting > 0x003b)
10400		goto done;
10401	if (starting > 0x003a)
10402		goto f3b;
10403	if (starting > 0x002b)
10404		goto f3a;
10405	if (starting > 0x002a)
10406		goto f2b;
10407	if (starting > 0x001f)
10408		goto f2a;
10409	if (starting > 0x001e)
10410		goto f1f;
10411	if (starting > 0x001d)
10412		goto f1e;
10413	if (starting > 0x0010)
10414		goto f1d;
10415	if (starting > 0x0003)
10416		goto f10;
10417	if (starting > 0x0002)
10418		goto f3;
10419	if (starting > 0x0001)
10420		goto f2;
10421	if (starting > 0x0000)
10422		goto f1;
10423
10424	/* Profile List */
10425	scsi_ulto2b(0x0000, feature->feature_code);
10426	feature->flags = SGC_F_PERSISTENT | SGC_F_CURRENT;
10427	feature->add_length = 8;
10428	scsi_ulto2b(0x0008, &feature->feature_data[0]);	/* CD-ROM */
10429	feature->feature_data[2] = 0x00;
10430	scsi_ulto2b(0x0010, &feature->feature_data[4]);	/* DVD-ROM */
10431	feature->feature_data[6] = 0x01;
10432	feature = (struct scsi_get_config_feature *)
10433	    &feature->feature_data[feature->add_length];
10434
10435f1:	/* Core */
10436	scsi_ulto2b(0x0001, feature->feature_code);
10437	feature->flags = 0x08 | SGC_F_PERSISTENT | SGC_F_CURRENT;
10438	feature->add_length = 8;
10439	scsi_ulto4b(0x00000000, &feature->feature_data[0]);
10440	feature->feature_data[4] = 0x03;
10441	feature = (struct scsi_get_config_feature *)
10442	    &feature->feature_data[feature->add_length];
10443
10444f2:	/* Morphing */
10445	scsi_ulto2b(0x0002, feature->feature_code);
10446	feature->flags = 0x04 | SGC_F_PERSISTENT | SGC_F_CURRENT;
10447	feature->add_length = 4;
10448	feature->feature_data[0] = 0x02;
10449	feature = (struct scsi_get_config_feature *)
10450	    &feature->feature_data[feature->add_length];
10451
10452f3:	/* Removable Medium */
10453	scsi_ulto2b(0x0003, feature->feature_code);
10454	feature->flags = 0x04 | SGC_F_PERSISTENT | SGC_F_CURRENT;
10455	feature->add_length = 4;
10456	feature->feature_data[0] = 0x39;
10457	feature = (struct scsi_get_config_feature *)
10458	    &feature->feature_data[feature->add_length];
10459
10460	if (rt == SGC_RT_CURRENT && (lun->flags & CTL_LUN_NO_MEDIA))
10461		goto done;
10462
10463f10:	/* Random Read */
10464	scsi_ulto2b(0x0010, feature->feature_code);
10465	feature->flags = 0x00;
10466	if ((lun->flags & CTL_LUN_NO_MEDIA) == 0)
10467		feature->flags |= SGC_F_CURRENT;
10468	feature->add_length = 8;
10469	scsi_ulto4b(lun->be_lun->blocksize, &feature->feature_data[0]);
10470	scsi_ulto2b(1, &feature->feature_data[4]);
10471	feature->feature_data[6] = 0x00;
10472	feature = (struct scsi_get_config_feature *)
10473	    &feature->feature_data[feature->add_length];
10474
10475f1d:	/* Multi-Read */
10476	scsi_ulto2b(0x001D, feature->feature_code);
10477	feature->flags = 0x00;
10478	if ((lun->flags & CTL_LUN_NO_MEDIA) == 0)
10479		feature->flags |= SGC_F_CURRENT;
10480	feature->add_length = 0;
10481	feature = (struct scsi_get_config_feature *)
10482	    &feature->feature_data[feature->add_length];
10483
10484f1e:	/* CD Read */
10485	scsi_ulto2b(0x001E, feature->feature_code);
10486	feature->flags = 0x00;
10487	if ((lun->flags & CTL_LUN_NO_MEDIA) == 0)
10488		feature->flags |= SGC_F_CURRENT;
10489	feature->add_length = 4;
10490	feature->feature_data[0] = 0x00;
10491	feature = (struct scsi_get_config_feature *)
10492	    &feature->feature_data[feature->add_length];
10493
10494f1f:	/* DVD Read */
10495	scsi_ulto2b(0x001F, feature->feature_code);
10496	feature->flags = 0x08;
10497	if ((lun->flags & CTL_LUN_NO_MEDIA) == 0)
10498		feature->flags |= SGC_F_CURRENT;
10499	feature->add_length = 4;
10500	feature->feature_data[0] = 0x01;
10501	feature->feature_data[2] = 0x03;
10502	feature = (struct scsi_get_config_feature *)
10503	    &feature->feature_data[feature->add_length];
10504
10505f2a:	/* DVD+RW */
10506	scsi_ulto2b(0x002A, feature->feature_code);
10507	feature->flags = 0x04;
10508	if ((lun->flags & CTL_LUN_NO_MEDIA) == 0)
10509		feature->flags |= SGC_F_CURRENT;
10510	feature->add_length = 4;
10511	feature->feature_data[0] = 0x00;
10512	feature->feature_data[1] = 0x00;
10513	feature = (struct scsi_get_config_feature *)
10514	    &feature->feature_data[feature->add_length];
10515
10516f2b:	/* DVD+R */
10517	scsi_ulto2b(0x002B, feature->feature_code);
10518	feature->flags = 0x00;
10519	if ((lun->flags & CTL_LUN_NO_MEDIA) == 0)
10520		feature->flags |= SGC_F_CURRENT;
10521	feature->add_length = 4;
10522	feature->feature_data[0] = 0x00;
10523	feature = (struct scsi_get_config_feature *)
10524	    &feature->feature_data[feature->add_length];
10525
10526f3a:	/* DVD+RW Dual Layer */
10527	scsi_ulto2b(0x003A, feature->feature_code);
10528	feature->flags = 0x00;
10529	if ((lun->flags & CTL_LUN_NO_MEDIA) == 0)
10530		feature->flags |= SGC_F_CURRENT;
10531	feature->add_length = 4;
10532	feature->feature_data[0] = 0x00;
10533	feature->feature_data[1] = 0x00;
10534	feature = (struct scsi_get_config_feature *)
10535	    &feature->feature_data[feature->add_length];
10536
10537f3b:	/* DVD+R Dual Layer */
10538	scsi_ulto2b(0x003B, feature->feature_code);
10539	feature->flags = 0x00;
10540	if ((lun->flags & CTL_LUN_NO_MEDIA) == 0)
10541		feature->flags |= SGC_F_CURRENT;
10542	feature->add_length = 4;
10543	feature->feature_data[0] = 0x00;
10544	feature = (struct scsi_get_config_feature *)
10545	    &feature->feature_data[feature->add_length];
10546
10547done:
10548	data_len = (uint8_t *)feature - (uint8_t *)hdr;
10549	if (rt == SGC_RT_SPECIFIC && data_len > 4) {
10550		feature = (struct scsi_get_config_feature *)(hdr + 1);
10551		if (scsi_2btoul(feature->feature_code) == starting)
10552			feature = (struct scsi_get_config_feature *)
10553			    &feature->feature_data[feature->add_length];
10554		data_len = (uint8_t *)feature - (uint8_t *)hdr;
10555	}
10556	scsi_ulto4b(data_len - 4, hdr->data_length);
10557	if (data_len < alloc_len) {
10558		ctsio->residual = alloc_len - data_len;
10559		ctsio->kern_data_len = data_len;
10560		ctsio->kern_total_len = data_len;
10561	} else {
10562		ctsio->residual = 0;
10563		ctsio->kern_data_len = alloc_len;
10564		ctsio->kern_total_len = alloc_len;
10565	}
10566
10567	ctl_set_success(ctsio);
10568	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
10569	ctsio->be_move_done = ctl_config_move_done;
10570	ctl_datamove((union ctl_io *)ctsio);
10571	return (CTL_RETVAL_COMPLETE);
10572}
10573
10574int
10575ctl_get_event_status(struct ctl_scsiio *ctsio)
10576{
10577	struct scsi_get_event_status_header *hdr;
10578	struct scsi_get_event_status *cdb;
10579	struct ctl_lun *lun;
10580	uint32_t alloc_len, data_len;
10581	int notif_class;
10582
10583	lun = ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
10584	cdb = (struct scsi_get_event_status *)ctsio->cdb;
10585	if ((cdb->byte2 & SGESN_POLLED) == 0) {
10586		ctl_set_invalid_field(ctsio, /*sks_valid*/ 1, /*command*/ 1,
10587		    /*field*/ 1, /*bit_valid*/ 1, /*bit*/ 0);
10588		ctl_done((union ctl_io *)ctsio);
10589		return (CTL_RETVAL_COMPLETE);
10590	}
10591	notif_class = cdb->notif_class;
10592	alloc_len = scsi_2btoul(cdb->length);
10593
10594	data_len = sizeof(struct scsi_get_event_status_header);
10595	ctsio->kern_data_ptr = malloc(data_len, M_CTL, M_WAITOK | M_ZERO);
10596	ctsio->kern_sg_entries = 0;
10597	ctsio->kern_data_resid = 0;
10598	ctsio->kern_rel_offset = 0;
10599
10600	if (data_len < alloc_len) {
10601		ctsio->residual = alloc_len - data_len;
10602		ctsio->kern_data_len = data_len;
10603		ctsio->kern_total_len = data_len;
10604	} else {
10605		ctsio->residual = 0;
10606		ctsio->kern_data_len = alloc_len;
10607		ctsio->kern_total_len = alloc_len;
10608	}
10609
10610	hdr = (struct scsi_get_event_status_header *)ctsio->kern_data_ptr;
10611	scsi_ulto2b(0, hdr->descr_length);
10612	hdr->nea_class = SGESN_NEA;
10613	hdr->supported_class = 0;
10614
10615	ctl_set_success(ctsio);
10616	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
10617	ctsio->be_move_done = ctl_config_move_done;
10618	ctl_datamove((union ctl_io *)ctsio);
10619	return (CTL_RETVAL_COMPLETE);
10620}
10621
10622int
10623ctl_mechanism_status(struct ctl_scsiio *ctsio)
10624{
10625	struct scsi_mechanism_status_header *hdr;
10626	struct scsi_mechanism_status *cdb;
10627	struct ctl_lun *lun;
10628	uint32_t alloc_len, data_len;
10629
10630	lun = ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
10631	cdb = (struct scsi_mechanism_status *)ctsio->cdb;
10632	alloc_len = scsi_2btoul(cdb->length);
10633
10634	data_len = sizeof(struct scsi_mechanism_status_header);
10635	ctsio->kern_data_ptr = malloc(data_len, M_CTL, M_WAITOK | M_ZERO);
10636	ctsio->kern_sg_entries = 0;
10637	ctsio->kern_data_resid = 0;
10638	ctsio->kern_rel_offset = 0;
10639
10640	if (data_len < alloc_len) {
10641		ctsio->residual = alloc_len - data_len;
10642		ctsio->kern_data_len = data_len;
10643		ctsio->kern_total_len = data_len;
10644	} else {
10645		ctsio->residual = 0;
10646		ctsio->kern_data_len = alloc_len;
10647		ctsio->kern_total_len = alloc_len;
10648	}
10649
10650	hdr = (struct scsi_mechanism_status_header *)ctsio->kern_data_ptr;
10651	hdr->state1 = 0x00;
10652	hdr->state2 = 0xe0;
10653	scsi_ulto3b(0, hdr->lba);
10654	hdr->slots_num = 0;
10655	scsi_ulto2b(0, hdr->slots_length);
10656
10657	ctl_set_success(ctsio);
10658	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
10659	ctsio->be_move_done = ctl_config_move_done;
10660	ctl_datamove((union ctl_io *)ctsio);
10661	return (CTL_RETVAL_COMPLETE);
10662}
10663
10664static void
10665ctl_ultomsf(uint32_t lba, uint8_t *buf)
10666{
10667
10668	lba += 150;
10669	buf[0] = 0;
10670	buf[1] = bin2bcd((lba / 75) / 60);
10671	buf[2] = bin2bcd((lba / 75) % 60);
10672	buf[3] = bin2bcd(lba % 75);
10673}
10674
10675int
10676ctl_read_toc(struct ctl_scsiio *ctsio)
10677{
10678	struct scsi_read_toc_hdr *hdr;
10679	struct scsi_read_toc_type01_descr *descr;
10680	struct scsi_read_toc *cdb;
10681	struct ctl_lun *lun;
10682	uint32_t alloc_len, data_len;
10683	int format, msf;
10684
10685	lun = ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
10686	cdb = (struct scsi_read_toc *)ctsio->cdb;
10687	msf = (cdb->byte2 & CD_MSF) != 0;
10688	format = cdb->format;
10689	alloc_len = scsi_2btoul(cdb->data_len);
10690
10691	data_len = sizeof(struct scsi_read_toc_hdr);
10692	if (format == 0)
10693		data_len += 2 * sizeof(struct scsi_read_toc_type01_descr);
10694	else
10695		data_len += sizeof(struct scsi_read_toc_type01_descr);
10696	ctsio->kern_data_ptr = malloc(data_len, M_CTL, M_WAITOK | M_ZERO);
10697	ctsio->kern_sg_entries = 0;
10698	ctsio->kern_data_resid = 0;
10699	ctsio->kern_rel_offset = 0;
10700
10701	if (data_len < alloc_len) {
10702		ctsio->residual = alloc_len - data_len;
10703		ctsio->kern_data_len = data_len;
10704		ctsio->kern_total_len = data_len;
10705	} else {
10706		ctsio->residual = 0;
10707		ctsio->kern_data_len = alloc_len;
10708		ctsio->kern_total_len = alloc_len;
10709	}
10710
10711	hdr = (struct scsi_read_toc_hdr *)ctsio->kern_data_ptr;
10712	if (format == 0) {
10713		scsi_ulto2b(0x12, hdr->data_length);
10714		hdr->first = 1;
10715		hdr->last = 1;
10716		descr = (struct scsi_read_toc_type01_descr *)(hdr + 1);
10717		descr->addr_ctl = 0x14;
10718		descr->track_number = 1;
10719		if (msf)
10720			ctl_ultomsf(0, descr->track_start);
10721		else
10722			scsi_ulto4b(0, descr->track_start);
10723		descr++;
10724		descr->addr_ctl = 0x14;
10725		descr->track_number = 0xaa;
10726		if (msf)
10727			ctl_ultomsf(lun->be_lun->maxlba+1, descr->track_start);
10728		else
10729			scsi_ulto4b(lun->be_lun->maxlba+1, descr->track_start);
10730	} else {
10731		scsi_ulto2b(0x0a, hdr->data_length);
10732		hdr->first = 1;
10733		hdr->last = 1;
10734		descr = (struct scsi_read_toc_type01_descr *)(hdr + 1);
10735		descr->addr_ctl = 0x14;
10736		descr->track_number = 1;
10737		if (msf)
10738			ctl_ultomsf(0, descr->track_start);
10739		else
10740			scsi_ulto4b(0, descr->track_start);
10741	}
10742
10743	ctl_set_success(ctsio);
10744	ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
10745	ctsio->be_move_done = ctl_config_move_done;
10746	ctl_datamove((union ctl_io *)ctsio);
10747	return (CTL_RETVAL_COMPLETE);
10748}
10749
10750/*
10751 * For known CDB types, parse the LBA and length.
10752 */
10753static int
10754ctl_get_lba_len(union ctl_io *io, uint64_t *lba, uint64_t *len)
10755{
10756	if (io->io_hdr.io_type != CTL_IO_SCSI)
10757		return (1);
10758
10759	switch (io->scsiio.cdb[0]) {
10760	case COMPARE_AND_WRITE: {
10761		struct scsi_compare_and_write *cdb;
10762
10763		cdb = (struct scsi_compare_and_write *)io->scsiio.cdb;
10764
10765		*lba = scsi_8btou64(cdb->addr);
10766		*len = cdb->length;
10767		break;
10768	}
10769	case READ_6:
10770	case WRITE_6: {
10771		struct scsi_rw_6 *cdb;
10772
10773		cdb = (struct scsi_rw_6 *)io->scsiio.cdb;
10774
10775		*lba = scsi_3btoul(cdb->addr);
10776		/* only 5 bits are valid in the most significant address byte */
10777		*lba &= 0x1fffff;
10778		*len = cdb->length;
10779		break;
10780	}
10781	case READ_10:
10782	case WRITE_10: {
10783		struct scsi_rw_10 *cdb;
10784
10785		cdb = (struct scsi_rw_10 *)io->scsiio.cdb;
10786
10787		*lba = scsi_4btoul(cdb->addr);
10788		*len = scsi_2btoul(cdb->length);
10789		break;
10790	}
10791	case WRITE_VERIFY_10: {
10792		struct scsi_write_verify_10 *cdb;
10793
10794		cdb = (struct scsi_write_verify_10 *)io->scsiio.cdb;
10795
10796		*lba = scsi_4btoul(cdb->addr);
10797		*len = scsi_2btoul(cdb->length);
10798		break;
10799	}
10800	case READ_12:
10801	case WRITE_12: {
10802		struct scsi_rw_12 *cdb;
10803
10804		cdb = (struct scsi_rw_12 *)io->scsiio.cdb;
10805
10806		*lba = scsi_4btoul(cdb->addr);
10807		*len = scsi_4btoul(cdb->length);
10808		break;
10809	}
10810	case WRITE_VERIFY_12: {
10811		struct scsi_write_verify_12 *cdb;
10812
10813		cdb = (struct scsi_write_verify_12 *)io->scsiio.cdb;
10814
10815		*lba = scsi_4btoul(cdb->addr);
10816		*len = scsi_4btoul(cdb->length);
10817		break;
10818	}
10819	case READ_16:
10820	case WRITE_16: {
10821		struct scsi_rw_16 *cdb;
10822
10823		cdb = (struct scsi_rw_16 *)io->scsiio.cdb;
10824
10825		*lba = scsi_8btou64(cdb->addr);
10826		*len = scsi_4btoul(cdb->length);
10827		break;
10828	}
10829	case WRITE_ATOMIC_16: {
10830		struct scsi_write_atomic_16 *cdb;
10831
10832		cdb = (struct scsi_write_atomic_16 *)io->scsiio.cdb;
10833
10834		*lba = scsi_8btou64(cdb->addr);
10835		*len = scsi_2btoul(cdb->length);
10836		break;
10837	}
10838	case WRITE_VERIFY_16: {
10839		struct scsi_write_verify_16 *cdb;
10840
10841		cdb = (struct scsi_write_verify_16 *)io->scsiio.cdb;
10842
10843		*lba = scsi_8btou64(cdb->addr);
10844		*len = scsi_4btoul(cdb->length);
10845		break;
10846	}
10847	case WRITE_SAME_10: {
10848		struct scsi_write_same_10 *cdb;
10849
10850		cdb = (struct scsi_write_same_10 *)io->scsiio.cdb;
10851
10852		*lba = scsi_4btoul(cdb->addr);
10853		*len = scsi_2btoul(cdb->length);
10854		break;
10855	}
10856	case WRITE_SAME_16: {
10857		struct scsi_write_same_16 *cdb;
10858
10859		cdb = (struct scsi_write_same_16 *)io->scsiio.cdb;
10860
10861		*lba = scsi_8btou64(cdb->addr);
10862		*len = scsi_4btoul(cdb->length);
10863		break;
10864	}
10865	case VERIFY_10: {
10866		struct scsi_verify_10 *cdb;
10867
10868		cdb = (struct scsi_verify_10 *)io->scsiio.cdb;
10869
10870		*lba = scsi_4btoul(cdb->addr);
10871		*len = scsi_2btoul(cdb->length);
10872		break;
10873	}
10874	case VERIFY_12: {
10875		struct scsi_verify_12 *cdb;
10876
10877		cdb = (struct scsi_verify_12 *)io->scsiio.cdb;
10878
10879		*lba = scsi_4btoul(cdb->addr);
10880		*len = scsi_4btoul(cdb->length);
10881		break;
10882	}
10883	case VERIFY_16: {
10884		struct scsi_verify_16 *cdb;
10885
10886		cdb = (struct scsi_verify_16 *)io->scsiio.cdb;
10887
10888		*lba = scsi_8btou64(cdb->addr);
10889		*len = scsi_4btoul(cdb->length);
10890		break;
10891	}
10892	case UNMAP: {
10893		*lba = 0;
10894		*len = UINT64_MAX;
10895		break;
10896	}
10897	case SERVICE_ACTION_IN: {	/* GET LBA STATUS */
10898		struct scsi_get_lba_status *cdb;
10899
10900		cdb = (struct scsi_get_lba_status *)io->scsiio.cdb;
10901		*lba = scsi_8btou64(cdb->addr);
10902		*len = UINT32_MAX;
10903		break;
10904	}
10905	default:
10906		return (1);
10907		break; /* NOTREACHED */
10908	}
10909
10910	return (0);
10911}
10912
10913static ctl_action
10914ctl_extent_check_lba(uint64_t lba1, uint64_t len1, uint64_t lba2, uint64_t len2,
10915    bool seq)
10916{
10917	uint64_t endlba1, endlba2;
10918
10919	endlba1 = lba1 + len1 - (seq ? 0 : 1);
10920	endlba2 = lba2 + len2 - 1;
10921
10922	if ((endlba1 < lba2) || (endlba2 < lba1))
10923		return (CTL_ACTION_PASS);
10924	else
10925		return (CTL_ACTION_BLOCK);
10926}
10927
10928static int
10929ctl_extent_check_unmap(union ctl_io *io, uint64_t lba2, uint64_t len2)
10930{
10931	struct ctl_ptr_len_flags *ptrlen;
10932	struct scsi_unmap_desc *buf, *end, *range;
10933	uint64_t lba;
10934	uint32_t len;
10935
10936	/* If not UNMAP -- go other way. */
10937	if (io->io_hdr.io_type != CTL_IO_SCSI ||
10938	    io->scsiio.cdb[0] != UNMAP)
10939		return (CTL_ACTION_ERROR);
10940
10941	/* If UNMAP without data -- block and wait for data. */
10942	ptrlen = (struct ctl_ptr_len_flags *)
10943	    &io->io_hdr.ctl_private[CTL_PRIV_LBA_LEN];
10944	if ((io->io_hdr.flags & CTL_FLAG_ALLOCATED) == 0 ||
10945	    ptrlen->ptr == NULL)
10946		return (CTL_ACTION_BLOCK);
10947
10948	/* UNMAP with data -- check for collision. */
10949	buf = (struct scsi_unmap_desc *)ptrlen->ptr;
10950	end = buf + ptrlen->len / sizeof(*buf);
10951	for (range = buf; range < end; range++) {
10952		lba = scsi_8btou64(range->lba);
10953		len = scsi_4btoul(range->length);
10954		if ((lba < lba2 + len2) && (lba + len > lba2))
10955			return (CTL_ACTION_BLOCK);
10956	}
10957	return (CTL_ACTION_PASS);
10958}
10959
10960static ctl_action
10961ctl_extent_check(union ctl_io *io1, union ctl_io *io2, bool seq)
10962{
10963	uint64_t lba1, lba2;
10964	uint64_t len1, len2;
10965	int retval;
10966
10967	if (ctl_get_lba_len(io2, &lba2, &len2) != 0)
10968		return (CTL_ACTION_ERROR);
10969
10970	retval = ctl_extent_check_unmap(io1, lba2, len2);
10971	if (retval != CTL_ACTION_ERROR)
10972		return (retval);
10973
10974	if (ctl_get_lba_len(io1, &lba1, &len1) != 0)
10975		return (CTL_ACTION_ERROR);
10976
10977	if (io1->io_hdr.flags & CTL_FLAG_SERSEQ_DONE)
10978		seq = FALSE;
10979	return (ctl_extent_check_lba(lba1, len1, lba2, len2, seq));
10980}
10981
10982static ctl_action
10983ctl_extent_check_seq(union ctl_io *io1, union ctl_io *io2)
10984{
10985	uint64_t lba1, lba2;
10986	uint64_t len1, len2;
10987
10988	if (io1->io_hdr.flags & CTL_FLAG_SERSEQ_DONE)
10989		return (CTL_ACTION_PASS);
10990	if (ctl_get_lba_len(io1, &lba1, &len1) != 0)
10991		return (CTL_ACTION_ERROR);
10992	if (ctl_get_lba_len(io2, &lba2, &len2) != 0)
10993		return (CTL_ACTION_ERROR);
10994
10995	if (lba1 + len1 == lba2)
10996		return (CTL_ACTION_BLOCK);
10997	return (CTL_ACTION_PASS);
10998}
10999
11000static ctl_action
11001ctl_check_for_blockage(struct ctl_lun *lun, union ctl_io *pending_io,
11002    union ctl_io *ooa_io)
11003{
11004	const struct ctl_cmd_entry *pending_entry, *ooa_entry;
11005	const ctl_serialize_action *serialize_row;
11006
11007	/*
11008	 * The initiator attempted multiple untagged commands at the same
11009	 * time.  Can't do that.
11010	 */
11011	if ((pending_io->scsiio.tag_type == CTL_TAG_UNTAGGED)
11012	 && (ooa_io->scsiio.tag_type == CTL_TAG_UNTAGGED)
11013	 && ((pending_io->io_hdr.nexus.targ_port ==
11014	      ooa_io->io_hdr.nexus.targ_port)
11015	  && (pending_io->io_hdr.nexus.initid ==
11016	      ooa_io->io_hdr.nexus.initid))
11017	 && ((ooa_io->io_hdr.flags & (CTL_FLAG_ABORT |
11018	      CTL_FLAG_STATUS_SENT)) == 0))
11019		return (CTL_ACTION_OVERLAP);
11020
11021	/*
11022	 * The initiator attempted to send multiple tagged commands with
11023	 * the same ID.  (It's fine if different initiators have the same
11024	 * tag ID.)
11025	 *
11026	 * Even if all of those conditions are true, we don't kill the I/O
11027	 * if the command ahead of us has been aborted.  We won't end up
11028	 * sending it to the FETD, and it's perfectly legal to resend a
11029	 * command with the same tag number as long as the previous
11030	 * instance of this tag number has been aborted somehow.
11031	 */
11032	if ((pending_io->scsiio.tag_type != CTL_TAG_UNTAGGED)
11033	 && (ooa_io->scsiio.tag_type != CTL_TAG_UNTAGGED)
11034	 && (pending_io->scsiio.tag_num == ooa_io->scsiio.tag_num)
11035	 && ((pending_io->io_hdr.nexus.targ_port ==
11036	      ooa_io->io_hdr.nexus.targ_port)
11037	  && (pending_io->io_hdr.nexus.initid ==
11038	      ooa_io->io_hdr.nexus.initid))
11039	 && ((ooa_io->io_hdr.flags & (CTL_FLAG_ABORT |
11040	      CTL_FLAG_STATUS_SENT)) == 0))
11041		return (CTL_ACTION_OVERLAP_TAG);
11042
11043	/*
11044	 * If we get a head of queue tag, SAM-3 says that we should
11045	 * immediately execute it.
11046	 *
11047	 * What happens if this command would normally block for some other
11048	 * reason?  e.g. a request sense with a head of queue tag
11049	 * immediately after a write.  Normally that would block, but this
11050	 * will result in its getting executed immediately...
11051	 *
11052	 * We currently return "pass" instead of "skip", so we'll end up
11053	 * going through the rest of the queue to check for overlapped tags.
11054	 *
11055	 * XXX KDM check for other types of blockage first??
11056	 */
11057	if (pending_io->scsiio.tag_type == CTL_TAG_HEAD_OF_QUEUE)
11058		return (CTL_ACTION_PASS);
11059
11060	/*
11061	 * Ordered tags have to block until all items ahead of them
11062	 * have completed.  If we get called with an ordered tag, we always
11063	 * block, if something else is ahead of us in the queue.
11064	 */
11065	if (pending_io->scsiio.tag_type == CTL_TAG_ORDERED)
11066		return (CTL_ACTION_BLOCK);
11067
11068	/*
11069	 * Simple tags get blocked until all head of queue and ordered tags
11070	 * ahead of them have completed.  I'm lumping untagged commands in
11071	 * with simple tags here.  XXX KDM is that the right thing to do?
11072	 */
11073	if (((pending_io->scsiio.tag_type == CTL_TAG_UNTAGGED)
11074	  || (pending_io->scsiio.tag_type == CTL_TAG_SIMPLE))
11075	 && ((ooa_io->scsiio.tag_type == CTL_TAG_HEAD_OF_QUEUE)
11076	  || (ooa_io->scsiio.tag_type == CTL_TAG_ORDERED)))
11077		return (CTL_ACTION_BLOCK);
11078
11079	pending_entry = ctl_get_cmd_entry(&pending_io->scsiio, NULL);
11080	KASSERT(pending_entry->seridx < CTL_SERIDX_COUNT,
11081	    ("%s: Invalid seridx %d for pending CDB %02x %02x @ %p",
11082	     __func__, pending_entry->seridx, pending_io->scsiio.cdb[0],
11083	     pending_io->scsiio.cdb[1], pending_io));
11084	ooa_entry = ctl_get_cmd_entry(&ooa_io->scsiio, NULL);
11085	if (ooa_entry->seridx == CTL_SERIDX_INVLD)
11086		return (CTL_ACTION_PASS); /* Unsupported command in OOA queue */
11087	KASSERT(ooa_entry->seridx < CTL_SERIDX_COUNT,
11088	    ("%s: Invalid seridx %d for ooa CDB %02x %02x @ %p",
11089	     __func__, ooa_entry->seridx, ooa_io->scsiio.cdb[0],
11090	     ooa_io->scsiio.cdb[1], ooa_io));
11091
11092	serialize_row = ctl_serialize_table[ooa_entry->seridx];
11093
11094	switch (serialize_row[pending_entry->seridx]) {
11095	case CTL_SER_BLOCK:
11096		return (CTL_ACTION_BLOCK);
11097	case CTL_SER_EXTENT:
11098		return (ctl_extent_check(ooa_io, pending_io,
11099		    (lun->be_lun && lun->be_lun->serseq == CTL_LUN_SERSEQ_ON)));
11100	case CTL_SER_EXTENTOPT:
11101		if ((lun->MODE_CTRL.queue_flags & SCP_QUEUE_ALG_MASK) !=
11102		    SCP_QUEUE_ALG_UNRESTRICTED)
11103			return (ctl_extent_check(ooa_io, pending_io,
11104			    (lun->be_lun &&
11105			     lun->be_lun->serseq == CTL_LUN_SERSEQ_ON)));
11106		return (CTL_ACTION_PASS);
11107	case CTL_SER_EXTENTSEQ:
11108		if (lun->be_lun && lun->be_lun->serseq != CTL_LUN_SERSEQ_OFF)
11109			return (ctl_extent_check_seq(ooa_io, pending_io));
11110		return (CTL_ACTION_PASS);
11111	case CTL_SER_PASS:
11112		return (CTL_ACTION_PASS);
11113	case CTL_SER_BLOCKOPT:
11114		if ((lun->MODE_CTRL.queue_flags & SCP_QUEUE_ALG_MASK) !=
11115		    SCP_QUEUE_ALG_UNRESTRICTED)
11116			return (CTL_ACTION_BLOCK);
11117		return (CTL_ACTION_PASS);
11118	case CTL_SER_SKIP:
11119		return (CTL_ACTION_SKIP);
11120	default:
11121		panic("%s: Invalid serialization value %d for %d => %d",
11122		    __func__, serialize_row[pending_entry->seridx],
11123		    pending_entry->seridx, ooa_entry->seridx);
11124	}
11125
11126	return (CTL_ACTION_ERROR);
11127}
11128
11129/*
11130 * Check for blockage or overlaps against the OOA (Order Of Arrival) queue.
11131 * Assumptions:
11132 * - pending_io is generally either incoming, or on the blocked queue
11133 * - starting I/O is the I/O we want to start the check with.
11134 */
11135static ctl_action
11136ctl_check_ooa(struct ctl_lun *lun, union ctl_io *pending_io,
11137	      union ctl_io *starting_io)
11138{
11139	union ctl_io *ooa_io;
11140	ctl_action action;
11141
11142	mtx_assert(&lun->lun_lock, MA_OWNED);
11143
11144	/*
11145	 * Run back along the OOA queue, starting with the current
11146	 * blocked I/O and going through every I/O before it on the
11147	 * queue.  If starting_io is NULL, we'll just end up returning
11148	 * CTL_ACTION_PASS.
11149	 */
11150	for (ooa_io = starting_io; ooa_io != NULL;
11151	     ooa_io = (union ctl_io *)TAILQ_PREV(&ooa_io->io_hdr, ctl_ooaq,
11152	     ooa_links)){
11153
11154		/*
11155		 * This routine just checks to see whether
11156		 * cur_blocked is blocked by ooa_io, which is ahead
11157		 * of it in the queue.  It doesn't queue/dequeue
11158		 * cur_blocked.
11159		 */
11160		action = ctl_check_for_blockage(lun, pending_io, ooa_io);
11161		switch (action) {
11162		case CTL_ACTION_BLOCK:
11163		case CTL_ACTION_OVERLAP:
11164		case CTL_ACTION_OVERLAP_TAG:
11165		case CTL_ACTION_SKIP:
11166		case CTL_ACTION_ERROR:
11167			return (action);
11168			break; /* NOTREACHED */
11169		case CTL_ACTION_PASS:
11170			break;
11171		default:
11172			panic("%s: Invalid action %d\n", __func__, action);
11173		}
11174	}
11175
11176	return (CTL_ACTION_PASS);
11177}
11178
11179/*
11180 * Assumptions:
11181 * - An I/O has just completed, and has been removed from the per-LUN OOA
11182 *   queue, so some items on the blocked queue may now be unblocked.
11183 */
11184static int
11185ctl_check_blocked(struct ctl_lun *lun)
11186{
11187	struct ctl_softc *softc = lun->ctl_softc;
11188	union ctl_io *cur_blocked, *next_blocked;
11189
11190	mtx_assert(&lun->lun_lock, MA_OWNED);
11191
11192	/*
11193	 * Run forward from the head of the blocked queue, checking each
11194	 * entry against the I/Os prior to it on the OOA queue to see if
11195	 * there is still any blockage.
11196	 *
11197	 * We cannot use the TAILQ_FOREACH() macro, because it can't deal
11198	 * with our removing a variable on it while it is traversing the
11199	 * list.
11200	 */
11201	for (cur_blocked = (union ctl_io *)TAILQ_FIRST(&lun->blocked_queue);
11202	     cur_blocked != NULL; cur_blocked = next_blocked) {
11203		union ctl_io *prev_ooa;
11204		ctl_action action;
11205
11206		next_blocked = (union ctl_io *)TAILQ_NEXT(&cur_blocked->io_hdr,
11207							  blocked_links);
11208
11209		prev_ooa = (union ctl_io *)TAILQ_PREV(&cur_blocked->io_hdr,
11210						      ctl_ooaq, ooa_links);
11211
11212		/*
11213		 * If cur_blocked happens to be the first item in the OOA
11214		 * queue now, prev_ooa will be NULL, and the action
11215		 * returned will just be CTL_ACTION_PASS.
11216		 */
11217		action = ctl_check_ooa(lun, cur_blocked, prev_ooa);
11218
11219		switch (action) {
11220		case CTL_ACTION_BLOCK:
11221			/* Nothing to do here, still blocked */
11222			break;
11223		case CTL_ACTION_OVERLAP:
11224		case CTL_ACTION_OVERLAP_TAG:
11225			/*
11226			 * This shouldn't happen!  In theory we've already
11227			 * checked this command for overlap...
11228			 */
11229			break;
11230		case CTL_ACTION_PASS:
11231		case CTL_ACTION_SKIP: {
11232			const struct ctl_cmd_entry *entry;
11233
11234			/*
11235			 * The skip case shouldn't happen, this transaction
11236			 * should have never made it onto the blocked queue.
11237			 */
11238			/*
11239			 * This I/O is no longer blocked, we can remove it
11240			 * from the blocked queue.  Since this is a TAILQ
11241			 * (doubly linked list), we can do O(1) removals
11242			 * from any place on the list.
11243			 */
11244			TAILQ_REMOVE(&lun->blocked_queue, &cur_blocked->io_hdr,
11245				     blocked_links);
11246			cur_blocked->io_hdr.flags &= ~CTL_FLAG_BLOCKED;
11247
11248			if ((softc->ha_mode != CTL_HA_MODE_XFER) &&
11249			    (cur_blocked->io_hdr.flags & CTL_FLAG_FROM_OTHER_SC)){
11250				/*
11251				 * Need to send IO back to original side to
11252				 * run
11253				 */
11254				union ctl_ha_msg msg_info;
11255
11256				cur_blocked->io_hdr.flags &= ~CTL_FLAG_IO_ACTIVE;
11257				msg_info.hdr.original_sc =
11258					cur_blocked->io_hdr.original_sc;
11259				msg_info.hdr.serializing_sc = cur_blocked;
11260				msg_info.hdr.msg_type = CTL_MSG_R2R;
11261				ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg_info,
11262				    sizeof(msg_info.hdr), M_NOWAIT);
11263				break;
11264			}
11265			entry = ctl_get_cmd_entry(&cur_blocked->scsiio, NULL);
11266
11267			/*
11268			 * Check this I/O for LUN state changes that may
11269			 * have happened while this command was blocked.
11270			 * The LUN state may have been changed by a command
11271			 * ahead of us in the queue, so we need to re-check
11272			 * for any states that can be caused by SCSI
11273			 * commands.
11274			 */
11275			if (ctl_scsiio_lun_check(lun, entry,
11276						 &cur_blocked->scsiio) == 0) {
11277				cur_blocked->io_hdr.flags |=
11278				                      CTL_FLAG_IS_WAS_ON_RTR;
11279				ctl_enqueue_rtr(cur_blocked);
11280			} else
11281				ctl_done(cur_blocked);
11282			break;
11283		}
11284		default:
11285			/*
11286			 * This probably shouldn't happen -- we shouldn't
11287			 * get CTL_ACTION_ERROR, or anything else.
11288			 */
11289			break;
11290		}
11291	}
11292
11293	return (CTL_RETVAL_COMPLETE);
11294}
11295
11296/*
11297 * This routine (with one exception) checks LUN flags that can be set by
11298 * commands ahead of us in the OOA queue.  These flags have to be checked
11299 * when a command initially comes in, and when we pull a command off the
11300 * blocked queue and are preparing to execute it.  The reason we have to
11301 * check these flags for commands on the blocked queue is that the LUN
11302 * state may have been changed by a command ahead of us while we're on the
11303 * blocked queue.
11304 *
11305 * Ordering is somewhat important with these checks, so please pay
11306 * careful attention to the placement of any new checks.
11307 */
11308static int
11309ctl_scsiio_lun_check(struct ctl_lun *lun,
11310    const struct ctl_cmd_entry *entry, struct ctl_scsiio *ctsio)
11311{
11312	struct ctl_softc *softc = lun->ctl_softc;
11313	int retval;
11314	uint32_t residx;
11315
11316	retval = 0;
11317
11318	mtx_assert(&lun->lun_lock, MA_OWNED);
11319
11320	/*
11321	 * If this shelf is a secondary shelf controller, we may have to
11322	 * reject some commands disallowed by HA mode and link state.
11323	 */
11324	if ((lun->flags & CTL_LUN_PRIMARY_SC) == 0) {
11325		if (softc->ha_link == CTL_HA_LINK_OFFLINE &&
11326		    (entry->flags & CTL_CMD_FLAG_OK_ON_UNAVAIL) == 0) {
11327			ctl_set_lun_unavail(ctsio);
11328			retval = 1;
11329			goto bailout;
11330		}
11331		if ((lun->flags & CTL_LUN_PEER_SC_PRIMARY) == 0 &&
11332		    (entry->flags & CTL_CMD_FLAG_OK_ON_UNAVAIL) == 0) {
11333			ctl_set_lun_transit(ctsio);
11334			retval = 1;
11335			goto bailout;
11336		}
11337		if (softc->ha_mode == CTL_HA_MODE_ACT_STBY &&
11338		    (entry->flags & CTL_CMD_FLAG_OK_ON_STANDBY) == 0) {
11339			ctl_set_lun_standby(ctsio);
11340			retval = 1;
11341			goto bailout;
11342		}
11343
11344		/* The rest of checks are only done on executing side */
11345		if (softc->ha_mode == CTL_HA_MODE_XFER)
11346			goto bailout;
11347	}
11348
11349	if (entry->pattern & CTL_LUN_PAT_WRITE) {
11350		if (lun->be_lun &&
11351		    lun->be_lun->flags & CTL_LUN_FLAG_READONLY) {
11352			ctl_set_hw_write_protected(ctsio);
11353			retval = 1;
11354			goto bailout;
11355		}
11356		if ((lun->MODE_CTRL.eca_and_aen & SCP_SWP) != 0) {
11357			ctl_set_sense(ctsio, /*current_error*/ 1,
11358			    /*sense_key*/ SSD_KEY_DATA_PROTECT,
11359			    /*asc*/ 0x27, /*ascq*/ 0x02, SSD_ELEM_NONE);
11360			retval = 1;
11361			goto bailout;
11362		}
11363	}
11364
11365	/*
11366	 * Check for a reservation conflict.  If this command isn't allowed
11367	 * even on reserved LUNs, and if this initiator isn't the one who
11368	 * reserved us, reject the command with a reservation conflict.
11369	 */
11370	residx = ctl_get_initindex(&ctsio->io_hdr.nexus);
11371	if ((lun->flags & CTL_LUN_RESERVED)
11372	 && ((entry->flags & CTL_CMD_FLAG_ALLOW_ON_RESV) == 0)) {
11373		if (lun->res_idx != residx) {
11374			ctl_set_reservation_conflict(ctsio);
11375			retval = 1;
11376			goto bailout;
11377		}
11378	}
11379
11380	if ((lun->flags & CTL_LUN_PR_RESERVED) == 0 ||
11381	    (entry->flags & CTL_CMD_FLAG_ALLOW_ON_PR_RESV)) {
11382		/* No reservation or command is allowed. */;
11383	} else if ((entry->flags & CTL_CMD_FLAG_ALLOW_ON_PR_WRESV) &&
11384	    (lun->pr_res_type == SPR_TYPE_WR_EX ||
11385	     lun->pr_res_type == SPR_TYPE_WR_EX_RO ||
11386	     lun->pr_res_type == SPR_TYPE_WR_EX_AR)) {
11387		/* The command is allowed for Write Exclusive resv. */;
11388	} else {
11389		/*
11390		 * if we aren't registered or it's a res holder type
11391		 * reservation and this isn't the res holder then set a
11392		 * conflict.
11393		 */
11394		if (ctl_get_prkey(lun, residx) == 0 ||
11395		    (residx != lun->pr_res_idx && lun->pr_res_type < 4)) {
11396			ctl_set_reservation_conflict(ctsio);
11397			retval = 1;
11398			goto bailout;
11399		}
11400	}
11401
11402	if ((entry->flags & CTL_CMD_FLAG_OK_ON_NO_MEDIA) == 0) {
11403		if (lun->flags & CTL_LUN_EJECTED)
11404			ctl_set_lun_ejected(ctsio);
11405		else if (lun->flags & CTL_LUN_NO_MEDIA) {
11406			if (lun->flags & CTL_LUN_REMOVABLE)
11407				ctl_set_lun_no_media(ctsio);
11408			else
11409				ctl_set_lun_int_reqd(ctsio);
11410		} else if (lun->flags & CTL_LUN_STOPPED)
11411			ctl_set_lun_stopped(ctsio);
11412		else
11413			goto bailout;
11414		retval = 1;
11415		goto bailout;
11416	}
11417
11418bailout:
11419	return (retval);
11420}
11421
11422static void
11423ctl_failover_io(union ctl_io *io, int have_lock)
11424{
11425	ctl_set_busy(&io->scsiio);
11426	ctl_done(io);
11427}
11428
11429static void
11430ctl_failover_lun(union ctl_io *rio)
11431{
11432	struct ctl_softc *softc = control_softc;
11433	struct ctl_lun *lun;
11434	struct ctl_io_hdr *io, *next_io;
11435	uint32_t targ_lun;
11436
11437	targ_lun = rio->io_hdr.nexus.targ_mapped_lun;
11438	CTL_DEBUG_PRINT(("FAILOVER for lun %ju\n", targ_lun));
11439
11440	/* Find and lock the LUN. */
11441	mtx_lock(&softc->ctl_lock);
11442	if ((targ_lun < CTL_MAX_LUNS) &&
11443	    ((lun = softc->ctl_luns[targ_lun]) != NULL)) {
11444		mtx_lock(&lun->lun_lock);
11445		mtx_unlock(&softc->ctl_lock);
11446		if (lun->flags & CTL_LUN_DISABLED) {
11447			mtx_unlock(&lun->lun_lock);
11448			return;
11449		}
11450	} else {
11451		mtx_unlock(&softc->ctl_lock);
11452		return;
11453	}
11454
11455	if (softc->ha_mode == CTL_HA_MODE_XFER) {
11456		TAILQ_FOREACH_SAFE(io, &lun->ooa_queue, ooa_links, next_io) {
11457			/* We are master */
11458			if (io->flags & CTL_FLAG_FROM_OTHER_SC) {
11459				if (io->flags & CTL_FLAG_IO_ACTIVE) {
11460					io->flags |= CTL_FLAG_ABORT;
11461					io->flags |= CTL_FLAG_FAILOVER;
11462				} else { /* This can be only due to DATAMOVE */
11463					io->msg_type = CTL_MSG_DATAMOVE_DONE;
11464					io->flags &= ~CTL_FLAG_DMA_INPROG;
11465					io->flags |= CTL_FLAG_IO_ACTIVE;
11466					io->port_status = 31340;
11467					ctl_enqueue_isc((union ctl_io *)io);
11468				}
11469			}
11470			/* We are slave */
11471			if (io->flags & CTL_FLAG_SENT_2OTHER_SC) {
11472				io->flags &= ~CTL_FLAG_SENT_2OTHER_SC;
11473				if (io->flags & CTL_FLAG_IO_ACTIVE) {
11474					io->flags |= CTL_FLAG_FAILOVER;
11475				} else {
11476					ctl_set_busy(&((union ctl_io *)io)->
11477					    scsiio);
11478					ctl_done((union ctl_io *)io);
11479				}
11480			}
11481		}
11482	} else { /* SERIALIZE modes */
11483		TAILQ_FOREACH_SAFE(io, &lun->blocked_queue, blocked_links,
11484		    next_io) {
11485			/* We are master */
11486			if (io->flags & CTL_FLAG_FROM_OTHER_SC) {
11487				TAILQ_REMOVE(&lun->blocked_queue, io,
11488				    blocked_links);
11489				io->flags &= ~CTL_FLAG_BLOCKED;
11490				TAILQ_REMOVE(&lun->ooa_queue, io, ooa_links);
11491				ctl_free_io((union ctl_io *)io);
11492			}
11493		}
11494		TAILQ_FOREACH_SAFE(io, &lun->ooa_queue, ooa_links, next_io) {
11495			/* We are master */
11496			if (io->flags & CTL_FLAG_FROM_OTHER_SC) {
11497				TAILQ_REMOVE(&lun->ooa_queue, io, ooa_links);
11498				ctl_free_io((union ctl_io *)io);
11499			}
11500			/* We are slave */
11501			if (io->flags & CTL_FLAG_SENT_2OTHER_SC) {
11502				io->flags &= ~CTL_FLAG_SENT_2OTHER_SC;
11503				if (!(io->flags & CTL_FLAG_IO_ACTIVE)) {
11504					ctl_set_busy(&((union ctl_io *)io)->
11505					    scsiio);
11506					ctl_done((union ctl_io *)io);
11507				}
11508			}
11509		}
11510		ctl_check_blocked(lun);
11511	}
11512	mtx_unlock(&lun->lun_lock);
11513}
11514
11515static int
11516ctl_scsiio_precheck(struct ctl_softc *softc, struct ctl_scsiio *ctsio)
11517{
11518	struct ctl_lun *lun;
11519	const struct ctl_cmd_entry *entry;
11520	uint32_t initidx, targ_lun;
11521	int retval;
11522
11523	retval = 0;
11524
11525	lun = NULL;
11526
11527	targ_lun = ctsio->io_hdr.nexus.targ_mapped_lun;
11528	if ((targ_lun < CTL_MAX_LUNS)
11529	 && ((lun = softc->ctl_luns[targ_lun]) != NULL)) {
11530		/*
11531		 * If the LUN is invalid, pretend that it doesn't exist.
11532		 * It will go away as soon as all pending I/O has been
11533		 * completed.
11534		 */
11535		mtx_lock(&lun->lun_lock);
11536		if (lun->flags & CTL_LUN_DISABLED) {
11537			mtx_unlock(&lun->lun_lock);
11538			lun = NULL;
11539			ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr = NULL;
11540			ctsio->io_hdr.ctl_private[CTL_PRIV_BACKEND_LUN].ptr = NULL;
11541		} else {
11542			ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr = lun;
11543			ctsio->io_hdr.ctl_private[CTL_PRIV_BACKEND_LUN].ptr =
11544				lun->be_lun;
11545
11546			/*
11547			 * Every I/O goes into the OOA queue for a
11548			 * particular LUN, and stays there until completion.
11549			 */
11550#ifdef CTL_TIME_IO
11551			if (TAILQ_EMPTY(&lun->ooa_queue)) {
11552				lun->idle_time += getsbinuptime() -
11553				    lun->last_busy;
11554			}
11555#endif
11556			TAILQ_INSERT_TAIL(&lun->ooa_queue, &ctsio->io_hdr,
11557			    ooa_links);
11558		}
11559	} else {
11560		ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr = NULL;
11561		ctsio->io_hdr.ctl_private[CTL_PRIV_BACKEND_LUN].ptr = NULL;
11562	}
11563
11564	/* Get command entry and return error if it is unsuppotyed. */
11565	entry = ctl_validate_command(ctsio);
11566	if (entry == NULL) {
11567		if (lun)
11568			mtx_unlock(&lun->lun_lock);
11569		return (retval);
11570	}
11571
11572	ctsio->io_hdr.flags &= ~CTL_FLAG_DATA_MASK;
11573	ctsio->io_hdr.flags |= entry->flags & CTL_FLAG_DATA_MASK;
11574
11575	/*
11576	 * Check to see whether we can send this command to LUNs that don't
11577	 * exist.  This should pretty much only be the case for inquiry
11578	 * and request sense.  Further checks, below, really require having
11579	 * a LUN, so we can't really check the command anymore.  Just put
11580	 * it on the rtr queue.
11581	 */
11582	if (lun == NULL) {
11583		if (entry->flags & CTL_CMD_FLAG_OK_ON_NO_LUN) {
11584			ctsio->io_hdr.flags |= CTL_FLAG_IS_WAS_ON_RTR;
11585			ctl_enqueue_rtr((union ctl_io *)ctsio);
11586			return (retval);
11587		}
11588
11589		ctl_set_unsupported_lun(ctsio);
11590		ctl_done((union ctl_io *)ctsio);
11591		CTL_DEBUG_PRINT(("ctl_scsiio_precheck: bailing out due to invalid LUN\n"));
11592		return (retval);
11593	} else {
11594		/*
11595		 * Make sure we support this particular command on this LUN.
11596		 * e.g., we don't support writes to the control LUN.
11597		 */
11598		if (!ctl_cmd_applicable(lun->be_lun->lun_type, entry)) {
11599			mtx_unlock(&lun->lun_lock);
11600			ctl_set_invalid_opcode(ctsio);
11601			ctl_done((union ctl_io *)ctsio);
11602			return (retval);
11603		}
11604	}
11605
11606	initidx = ctl_get_initindex(&ctsio->io_hdr.nexus);
11607
11608#ifdef CTL_WITH_CA
11609	/*
11610	 * If we've got a request sense, it'll clear the contingent
11611	 * allegiance condition.  Otherwise, if we have a CA condition for
11612	 * this initiator, clear it, because it sent down a command other
11613	 * than request sense.
11614	 */
11615	if ((ctsio->cdb[0] != REQUEST_SENSE)
11616	 && (ctl_is_set(lun->have_ca, initidx)))
11617		ctl_clear_mask(lun->have_ca, initidx);
11618#endif
11619
11620	/*
11621	 * If the command has this flag set, it handles its own unit
11622	 * attention reporting, we shouldn't do anything.  Otherwise we
11623	 * check for any pending unit attentions, and send them back to the
11624	 * initiator.  We only do this when a command initially comes in,
11625	 * not when we pull it off the blocked queue.
11626	 *
11627	 * According to SAM-3, section 5.3.2, the order that things get
11628	 * presented back to the host is basically unit attentions caused
11629	 * by some sort of reset event, busy status, reservation conflicts
11630	 * or task set full, and finally any other status.
11631	 *
11632	 * One issue here is that some of the unit attentions we report
11633	 * don't fall into the "reset" category (e.g. "reported luns data
11634	 * has changed").  So reporting it here, before the reservation
11635	 * check, may be technically wrong.  I guess the only thing to do
11636	 * would be to check for and report the reset events here, and then
11637	 * check for the other unit attention types after we check for a
11638	 * reservation conflict.
11639	 *
11640	 * XXX KDM need to fix this
11641	 */
11642	if ((entry->flags & CTL_CMD_FLAG_NO_SENSE) == 0) {
11643		ctl_ua_type ua_type;
11644
11645		ua_type = ctl_build_ua(lun, initidx, &ctsio->sense_data,
11646		    SSD_TYPE_NONE);
11647		if (ua_type != CTL_UA_NONE) {
11648			mtx_unlock(&lun->lun_lock);
11649			ctsio->scsi_status = SCSI_STATUS_CHECK_COND;
11650			ctsio->io_hdr.status = CTL_SCSI_ERROR | CTL_AUTOSENSE;
11651			ctsio->sense_len = SSD_FULL_SIZE;
11652			ctl_done((union ctl_io *)ctsio);
11653			return (retval);
11654		}
11655	}
11656
11657
11658	if (ctl_scsiio_lun_check(lun, entry, ctsio) != 0) {
11659		mtx_unlock(&lun->lun_lock);
11660		ctl_done((union ctl_io *)ctsio);
11661		return (retval);
11662	}
11663
11664	/*
11665	 * XXX CHD this is where we want to send IO to other side if
11666	 * this LUN is secondary on this SC. We will need to make a copy
11667	 * of the IO and flag the IO on this side as SENT_2OTHER and the flag
11668	 * the copy we send as FROM_OTHER.
11669	 * We also need to stuff the address of the original IO so we can
11670	 * find it easily. Something similar will need be done on the other
11671	 * side so when we are done we can find the copy.
11672	 */
11673	if ((lun->flags & CTL_LUN_PRIMARY_SC) == 0 &&
11674	    (lun->flags & CTL_LUN_PEER_SC_PRIMARY) != 0 &&
11675	    (entry->flags & CTL_CMD_FLAG_RUN_HERE) == 0) {
11676		union ctl_ha_msg msg_info;
11677		int isc_retval;
11678
11679		ctsio->io_hdr.flags |= CTL_FLAG_SENT_2OTHER_SC;
11680		ctsio->io_hdr.flags &= ~CTL_FLAG_IO_ACTIVE;
11681		mtx_unlock(&lun->lun_lock);
11682
11683		msg_info.hdr.msg_type = CTL_MSG_SERIALIZE;
11684		msg_info.hdr.original_sc = (union ctl_io *)ctsio;
11685		msg_info.hdr.serializing_sc = NULL;
11686		msg_info.hdr.nexus = ctsio->io_hdr.nexus;
11687		msg_info.scsi.tag_num = ctsio->tag_num;
11688		msg_info.scsi.tag_type = ctsio->tag_type;
11689		msg_info.scsi.cdb_len = ctsio->cdb_len;
11690		memcpy(msg_info.scsi.cdb, ctsio->cdb, CTL_MAX_CDBLEN);
11691
11692		if ((isc_retval = ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg_info,
11693		    sizeof(msg_info.scsi) - sizeof(msg_info.scsi.sense_data),
11694		    M_WAITOK)) > CTL_HA_STATUS_SUCCESS) {
11695			ctl_set_busy(ctsio);
11696			ctl_done((union ctl_io *)ctsio);
11697			return (retval);
11698		}
11699		return (retval);
11700	}
11701
11702	switch (ctl_check_ooa(lun, (union ctl_io *)ctsio,
11703			      (union ctl_io *)TAILQ_PREV(&ctsio->io_hdr,
11704			      ctl_ooaq, ooa_links))) {
11705	case CTL_ACTION_BLOCK:
11706		ctsio->io_hdr.flags |= CTL_FLAG_BLOCKED;
11707		TAILQ_INSERT_TAIL(&lun->blocked_queue, &ctsio->io_hdr,
11708				  blocked_links);
11709		mtx_unlock(&lun->lun_lock);
11710		return (retval);
11711	case CTL_ACTION_PASS:
11712	case CTL_ACTION_SKIP:
11713		ctsio->io_hdr.flags |= CTL_FLAG_IS_WAS_ON_RTR;
11714		mtx_unlock(&lun->lun_lock);
11715		ctl_enqueue_rtr((union ctl_io *)ctsio);
11716		break;
11717	case CTL_ACTION_OVERLAP:
11718		mtx_unlock(&lun->lun_lock);
11719		ctl_set_overlapped_cmd(ctsio);
11720		ctl_done((union ctl_io *)ctsio);
11721		break;
11722	case CTL_ACTION_OVERLAP_TAG:
11723		mtx_unlock(&lun->lun_lock);
11724		ctl_set_overlapped_tag(ctsio, ctsio->tag_num & 0xff);
11725		ctl_done((union ctl_io *)ctsio);
11726		break;
11727	case CTL_ACTION_ERROR:
11728	default:
11729		mtx_unlock(&lun->lun_lock);
11730		ctl_set_internal_failure(ctsio,
11731					 /*sks_valid*/ 0,
11732					 /*retry_count*/ 0);
11733		ctl_done((union ctl_io *)ctsio);
11734		break;
11735	}
11736	return (retval);
11737}
11738
11739const struct ctl_cmd_entry *
11740ctl_get_cmd_entry(struct ctl_scsiio *ctsio, int *sa)
11741{
11742	const struct ctl_cmd_entry *entry;
11743	int service_action;
11744
11745	entry = &ctl_cmd_table[ctsio->cdb[0]];
11746	if (sa)
11747		*sa = ((entry->flags & CTL_CMD_FLAG_SA5) != 0);
11748	if (entry->flags & CTL_CMD_FLAG_SA5) {
11749		service_action = ctsio->cdb[1] & SERVICE_ACTION_MASK;
11750		entry = &((const struct ctl_cmd_entry *)
11751		    entry->execute)[service_action];
11752	}
11753	return (entry);
11754}
11755
11756const struct ctl_cmd_entry *
11757ctl_validate_command(struct ctl_scsiio *ctsio)
11758{
11759	const struct ctl_cmd_entry *entry;
11760	int i, sa;
11761	uint8_t diff;
11762
11763	entry = ctl_get_cmd_entry(ctsio, &sa);
11764	if (entry->execute == NULL) {
11765		if (sa)
11766			ctl_set_invalid_field(ctsio,
11767					      /*sks_valid*/ 1,
11768					      /*command*/ 1,
11769					      /*field*/ 1,
11770					      /*bit_valid*/ 1,
11771					      /*bit*/ 4);
11772		else
11773			ctl_set_invalid_opcode(ctsio);
11774		ctl_done((union ctl_io *)ctsio);
11775		return (NULL);
11776	}
11777	KASSERT(entry->length > 0,
11778	    ("Not defined length for command 0x%02x/0x%02x",
11779	     ctsio->cdb[0], ctsio->cdb[1]));
11780	for (i = 1; i < entry->length; i++) {
11781		diff = ctsio->cdb[i] & ~entry->usage[i - 1];
11782		if (diff == 0)
11783			continue;
11784		ctl_set_invalid_field(ctsio,
11785				      /*sks_valid*/ 1,
11786				      /*command*/ 1,
11787				      /*field*/ i,
11788				      /*bit_valid*/ 1,
11789				      /*bit*/ fls(diff) - 1);
11790		ctl_done((union ctl_io *)ctsio);
11791		return (NULL);
11792	}
11793	return (entry);
11794}
11795
11796static int
11797ctl_cmd_applicable(uint8_t lun_type, const struct ctl_cmd_entry *entry)
11798{
11799
11800	switch (lun_type) {
11801	case T_DIRECT:
11802		if ((entry->flags & CTL_CMD_FLAG_OK_ON_DIRECT) == 0)
11803			return (0);
11804		break;
11805	case T_PROCESSOR:
11806		if ((entry->flags & CTL_CMD_FLAG_OK_ON_PROC) == 0)
11807			return (0);
11808		break;
11809	case T_CDROM:
11810		if ((entry->flags & CTL_CMD_FLAG_OK_ON_CDROM) == 0)
11811			return (0);
11812		break;
11813	default:
11814		return (0);
11815	}
11816	return (1);
11817}
11818
11819static int
11820ctl_scsiio(struct ctl_scsiio *ctsio)
11821{
11822	int retval;
11823	const struct ctl_cmd_entry *entry;
11824
11825	retval = CTL_RETVAL_COMPLETE;
11826
11827	CTL_DEBUG_PRINT(("ctl_scsiio cdb[0]=%02X\n", ctsio->cdb[0]));
11828
11829	entry = ctl_get_cmd_entry(ctsio, NULL);
11830
11831	/*
11832	 * If this I/O has been aborted, just send it straight to
11833	 * ctl_done() without executing it.
11834	 */
11835	if (ctsio->io_hdr.flags & CTL_FLAG_ABORT) {
11836		ctl_done((union ctl_io *)ctsio);
11837		goto bailout;
11838	}
11839
11840	/*
11841	 * All the checks should have been handled by ctl_scsiio_precheck().
11842	 * We should be clear now to just execute the I/O.
11843	 */
11844	retval = entry->execute(ctsio);
11845
11846bailout:
11847	return (retval);
11848}
11849
11850/*
11851 * Since we only implement one target right now, a bus reset simply resets
11852 * our single target.
11853 */
11854static int
11855ctl_bus_reset(struct ctl_softc *softc, union ctl_io *io)
11856{
11857	return(ctl_target_reset(softc, io, CTL_UA_BUS_RESET));
11858}
11859
11860static int
11861ctl_target_reset(struct ctl_softc *softc, union ctl_io *io,
11862		 ctl_ua_type ua_type)
11863{
11864	struct ctl_port *port;
11865	struct ctl_lun *lun;
11866	int retval;
11867
11868	if (!(io->io_hdr.flags & CTL_FLAG_FROM_OTHER_SC)) {
11869		union ctl_ha_msg msg_info;
11870
11871		msg_info.hdr.nexus = io->io_hdr.nexus;
11872		if (ua_type==CTL_UA_TARG_RESET)
11873			msg_info.task.task_action = CTL_TASK_TARGET_RESET;
11874		else
11875			msg_info.task.task_action = CTL_TASK_BUS_RESET;
11876		msg_info.hdr.msg_type = CTL_MSG_MANAGE_TASKS;
11877		msg_info.hdr.original_sc = NULL;
11878		msg_info.hdr.serializing_sc = NULL;
11879		ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg_info,
11880		    sizeof(msg_info.task), M_WAITOK);
11881	}
11882	retval = 0;
11883
11884	mtx_lock(&softc->ctl_lock);
11885	port = ctl_io_port(&io->io_hdr);
11886	STAILQ_FOREACH(lun, &softc->lun_list, links) {
11887		if (port != NULL &&
11888		    ctl_lun_map_to_port(port, lun->lun) >= CTL_MAX_LUNS)
11889			continue;
11890		retval += ctl_do_lun_reset(lun, io, ua_type);
11891	}
11892	mtx_unlock(&softc->ctl_lock);
11893	io->taskio.task_status = CTL_TASK_FUNCTION_COMPLETE;
11894	return (retval);
11895}
11896
11897/*
11898 * The LUN should always be set.  The I/O is optional, and is used to
11899 * distinguish between I/Os sent by this initiator, and by other
11900 * initiators.  We set unit attention for initiators other than this one.
11901 * SAM-3 is vague on this point.  It does say that a unit attention should
11902 * be established for other initiators when a LUN is reset (see section
11903 * 5.7.3), but it doesn't specifically say that the unit attention should
11904 * be established for this particular initiator when a LUN is reset.  Here
11905 * is the relevant text, from SAM-3 rev 8:
11906 *
11907 * 5.7.2 When a SCSI initiator port aborts its own tasks
11908 *
11909 * When a SCSI initiator port causes its own task(s) to be aborted, no
11910 * notification that the task(s) have been aborted shall be returned to
11911 * the SCSI initiator port other than the completion response for the
11912 * command or task management function action that caused the task(s) to
11913 * be aborted and notification(s) associated with related effects of the
11914 * action (e.g., a reset unit attention condition).
11915 *
11916 * XXX KDM for now, we're setting unit attention for all initiators.
11917 */
11918static int
11919ctl_do_lun_reset(struct ctl_lun *lun, union ctl_io *io, ctl_ua_type ua_type)
11920{
11921	union ctl_io *xio;
11922#if 0
11923	uint32_t initidx;
11924#endif
11925	int i;
11926
11927	mtx_lock(&lun->lun_lock);
11928	/*
11929	 * Run through the OOA queue and abort each I/O.
11930	 */
11931	for (xio = (union ctl_io *)TAILQ_FIRST(&lun->ooa_queue); xio != NULL;
11932	     xio = (union ctl_io *)TAILQ_NEXT(&xio->io_hdr, ooa_links)) {
11933		xio->io_hdr.flags |= CTL_FLAG_ABORT | CTL_FLAG_ABORT_STATUS;
11934	}
11935
11936	/*
11937	 * This version sets unit attention for every
11938	 */
11939#if 0
11940	initidx = ctl_get_initindex(&io->io_hdr.nexus);
11941	ctl_est_ua_all(lun, initidx, ua_type);
11942#else
11943	ctl_est_ua_all(lun, -1, ua_type);
11944#endif
11945
11946	/*
11947	 * A reset (any kind, really) clears reservations established with
11948	 * RESERVE/RELEASE.  It does not clear reservations established
11949	 * with PERSISTENT RESERVE OUT, but we don't support that at the
11950	 * moment anyway.  See SPC-2, section 5.6.  SPC-3 doesn't address
11951	 * reservations made with the RESERVE/RELEASE commands, because
11952	 * those commands are obsolete in SPC-3.
11953	 */
11954	lun->flags &= ~CTL_LUN_RESERVED;
11955
11956#ifdef CTL_WITH_CA
11957	for (i = 0; i < CTL_MAX_INITIATORS; i++)
11958		ctl_clear_mask(lun->have_ca, i);
11959#endif
11960	lun->prevent_count = 0;
11961	for (i = 0; i < CTL_MAX_INITIATORS; i++)
11962		ctl_clear_mask(lun->prevent, i);
11963	mtx_unlock(&lun->lun_lock);
11964
11965	return (0);
11966}
11967
11968static int
11969ctl_lun_reset(struct ctl_softc *softc, union ctl_io *io)
11970{
11971	struct ctl_lun *lun;
11972	uint32_t targ_lun;
11973	int retval;
11974
11975	targ_lun = io->io_hdr.nexus.targ_mapped_lun;
11976	mtx_lock(&softc->ctl_lock);
11977	if ((targ_lun >= CTL_MAX_LUNS) ||
11978	    (lun = softc->ctl_luns[targ_lun]) == NULL) {
11979		mtx_unlock(&softc->ctl_lock);
11980		io->taskio.task_status = CTL_TASK_LUN_DOES_NOT_EXIST;
11981		return (1);
11982	}
11983	retval = ctl_do_lun_reset(lun, io, CTL_UA_LUN_RESET);
11984	mtx_unlock(&softc->ctl_lock);
11985	io->taskio.task_status = CTL_TASK_FUNCTION_COMPLETE;
11986
11987	if ((io->io_hdr.flags & CTL_FLAG_FROM_OTHER_SC) == 0) {
11988		union ctl_ha_msg msg_info;
11989
11990		msg_info.hdr.msg_type = CTL_MSG_MANAGE_TASKS;
11991		msg_info.hdr.nexus = io->io_hdr.nexus;
11992		msg_info.task.task_action = CTL_TASK_LUN_RESET;
11993		msg_info.hdr.original_sc = NULL;
11994		msg_info.hdr.serializing_sc = NULL;
11995		ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg_info,
11996		    sizeof(msg_info.task), M_WAITOK);
11997	}
11998	return (retval);
11999}
12000
12001static void
12002ctl_abort_tasks_lun(struct ctl_lun *lun, uint32_t targ_port, uint32_t init_id,
12003    int other_sc)
12004{
12005	union ctl_io *xio;
12006
12007	mtx_assert(&lun->lun_lock, MA_OWNED);
12008
12009	/*
12010	 * Run through the OOA queue and attempt to find the given I/O.
12011	 * The target port, initiator ID, tag type and tag number have to
12012	 * match the values that we got from the initiator.  If we have an
12013	 * untagged command to abort, simply abort the first untagged command
12014	 * we come to.  We only allow one untagged command at a time of course.
12015	 */
12016	for (xio = (union ctl_io *)TAILQ_FIRST(&lun->ooa_queue); xio != NULL;
12017	     xio = (union ctl_io *)TAILQ_NEXT(&xio->io_hdr, ooa_links)) {
12018
12019		if ((targ_port == UINT32_MAX ||
12020		     targ_port == xio->io_hdr.nexus.targ_port) &&
12021		    (init_id == UINT32_MAX ||
12022		     init_id == xio->io_hdr.nexus.initid)) {
12023			if (targ_port != xio->io_hdr.nexus.targ_port ||
12024			    init_id != xio->io_hdr.nexus.initid)
12025				xio->io_hdr.flags |= CTL_FLAG_ABORT_STATUS;
12026			xio->io_hdr.flags |= CTL_FLAG_ABORT;
12027			if (!other_sc && !(lun->flags & CTL_LUN_PRIMARY_SC)) {
12028				union ctl_ha_msg msg_info;
12029
12030				msg_info.hdr.nexus = xio->io_hdr.nexus;
12031				msg_info.task.task_action = CTL_TASK_ABORT_TASK;
12032				msg_info.task.tag_num = xio->scsiio.tag_num;
12033				msg_info.task.tag_type = xio->scsiio.tag_type;
12034				msg_info.hdr.msg_type = CTL_MSG_MANAGE_TASKS;
12035				msg_info.hdr.original_sc = NULL;
12036				msg_info.hdr.serializing_sc = NULL;
12037				ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg_info,
12038				    sizeof(msg_info.task), M_NOWAIT);
12039			}
12040		}
12041	}
12042}
12043
12044static int
12045ctl_abort_task_set(union ctl_io *io)
12046{
12047	struct ctl_softc *softc = control_softc;
12048	struct ctl_lun *lun;
12049	uint32_t targ_lun;
12050
12051	/*
12052	 * Look up the LUN.
12053	 */
12054	targ_lun = io->io_hdr.nexus.targ_mapped_lun;
12055	mtx_lock(&softc->ctl_lock);
12056	if ((targ_lun >= CTL_MAX_LUNS) ||
12057	    (lun = softc->ctl_luns[targ_lun]) == NULL) {
12058		mtx_unlock(&softc->ctl_lock);
12059		io->taskio.task_status = CTL_TASK_LUN_DOES_NOT_EXIST;
12060		return (1);
12061	}
12062
12063	mtx_lock(&lun->lun_lock);
12064	mtx_unlock(&softc->ctl_lock);
12065	if (io->taskio.task_action == CTL_TASK_ABORT_TASK_SET) {
12066		ctl_abort_tasks_lun(lun, io->io_hdr.nexus.targ_port,
12067		    io->io_hdr.nexus.initid,
12068		    (io->io_hdr.flags & CTL_FLAG_FROM_OTHER_SC) != 0);
12069	} else { /* CTL_TASK_CLEAR_TASK_SET */
12070		ctl_abort_tasks_lun(lun, UINT32_MAX, UINT32_MAX,
12071		    (io->io_hdr.flags & CTL_FLAG_FROM_OTHER_SC) != 0);
12072	}
12073	mtx_unlock(&lun->lun_lock);
12074	io->taskio.task_status = CTL_TASK_FUNCTION_COMPLETE;
12075	return (0);
12076}
12077
12078static int
12079ctl_i_t_nexus_reset(union ctl_io *io)
12080{
12081	struct ctl_softc *softc = control_softc;
12082	struct ctl_lun *lun;
12083	uint32_t initidx;
12084
12085	if (!(io->io_hdr.flags & CTL_FLAG_FROM_OTHER_SC)) {
12086		union ctl_ha_msg msg_info;
12087
12088		msg_info.hdr.nexus = io->io_hdr.nexus;
12089		msg_info.task.task_action = CTL_TASK_I_T_NEXUS_RESET;
12090		msg_info.hdr.msg_type = CTL_MSG_MANAGE_TASKS;
12091		msg_info.hdr.original_sc = NULL;
12092		msg_info.hdr.serializing_sc = NULL;
12093		ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg_info,
12094		    sizeof(msg_info.task), M_WAITOK);
12095	}
12096
12097	initidx = ctl_get_initindex(&io->io_hdr.nexus);
12098	mtx_lock(&softc->ctl_lock);
12099	STAILQ_FOREACH(lun, &softc->lun_list, links) {
12100		mtx_lock(&lun->lun_lock);
12101		ctl_abort_tasks_lun(lun, io->io_hdr.nexus.targ_port,
12102		    io->io_hdr.nexus.initid, 1);
12103#ifdef CTL_WITH_CA
12104		ctl_clear_mask(lun->have_ca, initidx);
12105#endif
12106		if ((lun->flags & CTL_LUN_RESERVED) && (lun->res_idx == initidx))
12107			lun->flags &= ~CTL_LUN_RESERVED;
12108		if (ctl_is_set(lun->prevent, initidx)) {
12109			ctl_clear_mask(lun->prevent, initidx);
12110			lun->prevent_count--;
12111		}
12112		ctl_est_ua(lun, initidx, CTL_UA_I_T_NEXUS_LOSS);
12113		mtx_unlock(&lun->lun_lock);
12114	}
12115	mtx_unlock(&softc->ctl_lock);
12116	io->taskio.task_status = CTL_TASK_FUNCTION_COMPLETE;
12117	return (0);
12118}
12119
12120static int
12121ctl_abort_task(union ctl_io *io)
12122{
12123	union ctl_io *xio;
12124	struct ctl_lun *lun;
12125	struct ctl_softc *softc;
12126#if 0
12127	struct sbuf sb;
12128	char printbuf[128];
12129#endif
12130	int found;
12131	uint32_t targ_lun;
12132
12133	softc = control_softc;
12134	found = 0;
12135
12136	/*
12137	 * Look up the LUN.
12138	 */
12139	targ_lun = io->io_hdr.nexus.targ_mapped_lun;
12140	mtx_lock(&softc->ctl_lock);
12141	if ((targ_lun >= CTL_MAX_LUNS) ||
12142	    (lun = softc->ctl_luns[targ_lun]) == NULL) {
12143		mtx_unlock(&softc->ctl_lock);
12144		io->taskio.task_status = CTL_TASK_LUN_DOES_NOT_EXIST;
12145		return (1);
12146	}
12147
12148#if 0
12149	printf("ctl_abort_task: called for lun %lld, tag %d type %d\n",
12150	       lun->lun, io->taskio.tag_num, io->taskio.tag_type);
12151#endif
12152
12153	mtx_lock(&lun->lun_lock);
12154	mtx_unlock(&softc->ctl_lock);
12155	/*
12156	 * Run through the OOA queue and attempt to find the given I/O.
12157	 * The target port, initiator ID, tag type and tag number have to
12158	 * match the values that we got from the initiator.  If we have an
12159	 * untagged command to abort, simply abort the first untagged command
12160	 * we come to.  We only allow one untagged command at a time of course.
12161	 */
12162	for (xio = (union ctl_io *)TAILQ_FIRST(&lun->ooa_queue); xio != NULL;
12163	     xio = (union ctl_io *)TAILQ_NEXT(&xio->io_hdr, ooa_links)) {
12164#if 0
12165		sbuf_new(&sb, printbuf, sizeof(printbuf), SBUF_FIXEDLEN);
12166
12167		sbuf_printf(&sb, "LUN %lld tag %d type %d%s%s%s%s: ",
12168			    lun->lun, xio->scsiio.tag_num,
12169			    xio->scsiio.tag_type,
12170			    (xio->io_hdr.blocked_links.tqe_prev
12171			    == NULL) ? "" : " BLOCKED",
12172			    (xio->io_hdr.flags &
12173			    CTL_FLAG_DMA_INPROG) ? " DMA" : "",
12174			    (xio->io_hdr.flags &
12175			    CTL_FLAG_ABORT) ? " ABORT" : "",
12176			    (xio->io_hdr.flags &
12177			    CTL_FLAG_IS_WAS_ON_RTR ? " RTR" : ""));
12178		ctl_scsi_command_string(&xio->scsiio, NULL, &sb);
12179		sbuf_finish(&sb);
12180		printf("%s\n", sbuf_data(&sb));
12181#endif
12182
12183		if ((xio->io_hdr.nexus.targ_port != io->io_hdr.nexus.targ_port)
12184		 || (xio->io_hdr.nexus.initid != io->io_hdr.nexus.initid)
12185		 || (xio->io_hdr.flags & CTL_FLAG_ABORT))
12186			continue;
12187
12188		/*
12189		 * If the abort says that the task is untagged, the
12190		 * task in the queue must be untagged.  Otherwise,
12191		 * we just check to see whether the tag numbers
12192		 * match.  This is because the QLogic firmware
12193		 * doesn't pass back the tag type in an abort
12194		 * request.
12195		 */
12196#if 0
12197		if (((xio->scsiio.tag_type == CTL_TAG_UNTAGGED)
12198		  && (io->taskio.tag_type == CTL_TAG_UNTAGGED))
12199		 || (xio->scsiio.tag_num == io->taskio.tag_num))
12200#endif
12201		/*
12202		 * XXX KDM we've got problems with FC, because it
12203		 * doesn't send down a tag type with aborts.  So we
12204		 * can only really go by the tag number...
12205		 * This may cause problems with parallel SCSI.
12206		 * Need to figure that out!!
12207		 */
12208		if (xio->scsiio.tag_num == io->taskio.tag_num) {
12209			xio->io_hdr.flags |= CTL_FLAG_ABORT;
12210			found = 1;
12211			if ((io->io_hdr.flags & CTL_FLAG_FROM_OTHER_SC) == 0 &&
12212			    !(lun->flags & CTL_LUN_PRIMARY_SC)) {
12213				union ctl_ha_msg msg_info;
12214
12215				msg_info.hdr.nexus = io->io_hdr.nexus;
12216				msg_info.task.task_action = CTL_TASK_ABORT_TASK;
12217				msg_info.task.tag_num = io->taskio.tag_num;
12218				msg_info.task.tag_type = io->taskio.tag_type;
12219				msg_info.hdr.msg_type = CTL_MSG_MANAGE_TASKS;
12220				msg_info.hdr.original_sc = NULL;
12221				msg_info.hdr.serializing_sc = NULL;
12222#if 0
12223				printf("Sent Abort to other side\n");
12224#endif
12225				ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg_info,
12226				    sizeof(msg_info.task), M_NOWAIT);
12227			}
12228#if 0
12229			printf("ctl_abort_task: found I/O to abort\n");
12230#endif
12231		}
12232	}
12233	mtx_unlock(&lun->lun_lock);
12234
12235	if (found == 0) {
12236		/*
12237		 * This isn't really an error.  It's entirely possible for
12238		 * the abort and command completion to cross on the wire.
12239		 * This is more of an informative/diagnostic error.
12240		 */
12241#if 0
12242		printf("ctl_abort_task: ABORT sent for nonexistent I/O: "
12243		       "%u:%u:%u tag %d type %d\n",
12244		       io->io_hdr.nexus.initid,
12245		       io->io_hdr.nexus.targ_port,
12246		       io->io_hdr.nexus.targ_lun, io->taskio.tag_num,
12247		       io->taskio.tag_type);
12248#endif
12249	}
12250	io->taskio.task_status = CTL_TASK_FUNCTION_COMPLETE;
12251	return (0);
12252}
12253
12254static int
12255ctl_query_task(union ctl_io *io, int task_set)
12256{
12257	union ctl_io *xio;
12258	struct ctl_lun *lun;
12259	struct ctl_softc *softc;
12260	int found = 0;
12261	uint32_t targ_lun;
12262
12263	softc = control_softc;
12264	targ_lun = io->io_hdr.nexus.targ_mapped_lun;
12265	mtx_lock(&softc->ctl_lock);
12266	if ((targ_lun >= CTL_MAX_LUNS) ||
12267	    (lun = softc->ctl_luns[targ_lun]) == NULL) {
12268		mtx_unlock(&softc->ctl_lock);
12269		io->taskio.task_status = CTL_TASK_LUN_DOES_NOT_EXIST;
12270		return (1);
12271	}
12272	mtx_lock(&lun->lun_lock);
12273	mtx_unlock(&softc->ctl_lock);
12274	for (xio = (union ctl_io *)TAILQ_FIRST(&lun->ooa_queue); xio != NULL;
12275	     xio = (union ctl_io *)TAILQ_NEXT(&xio->io_hdr, ooa_links)) {
12276
12277		if ((xio->io_hdr.nexus.targ_port != io->io_hdr.nexus.targ_port)
12278		 || (xio->io_hdr.nexus.initid != io->io_hdr.nexus.initid)
12279		 || (xio->io_hdr.flags & CTL_FLAG_ABORT))
12280			continue;
12281
12282		if (task_set || xio->scsiio.tag_num == io->taskio.tag_num) {
12283			found = 1;
12284			break;
12285		}
12286	}
12287	mtx_unlock(&lun->lun_lock);
12288	if (found)
12289		io->taskio.task_status = CTL_TASK_FUNCTION_SUCCEEDED;
12290	else
12291		io->taskio.task_status = CTL_TASK_FUNCTION_COMPLETE;
12292	return (0);
12293}
12294
12295static int
12296ctl_query_async_event(union ctl_io *io)
12297{
12298	struct ctl_lun *lun;
12299	struct ctl_softc *softc;
12300	ctl_ua_type ua;
12301	uint32_t targ_lun, initidx;
12302
12303	softc = control_softc;
12304	targ_lun = io->io_hdr.nexus.targ_mapped_lun;
12305	mtx_lock(&softc->ctl_lock);
12306	if ((targ_lun >= CTL_MAX_LUNS) ||
12307	    (lun = softc->ctl_luns[targ_lun]) == NULL) {
12308		mtx_unlock(&softc->ctl_lock);
12309		io->taskio.task_status = CTL_TASK_LUN_DOES_NOT_EXIST;
12310		return (1);
12311	}
12312	mtx_lock(&lun->lun_lock);
12313	mtx_unlock(&softc->ctl_lock);
12314	initidx = ctl_get_initindex(&io->io_hdr.nexus);
12315	ua = ctl_build_qae(lun, initidx, io->taskio.task_resp);
12316	mtx_unlock(&lun->lun_lock);
12317	if (ua != CTL_UA_NONE)
12318		io->taskio.task_status = CTL_TASK_FUNCTION_SUCCEEDED;
12319	else
12320		io->taskio.task_status = CTL_TASK_FUNCTION_COMPLETE;
12321	return (0);
12322}
12323
12324static void
12325ctl_run_task(union ctl_io *io)
12326{
12327	struct ctl_softc *softc = control_softc;
12328	int retval = 1;
12329
12330	CTL_DEBUG_PRINT(("ctl_run_task\n"));
12331	KASSERT(io->io_hdr.io_type == CTL_IO_TASK,
12332	    ("ctl_run_task: Unextected io_type %d\n", io->io_hdr.io_type));
12333	io->taskio.task_status = CTL_TASK_FUNCTION_NOT_SUPPORTED;
12334	bzero(io->taskio.task_resp, sizeof(io->taskio.task_resp));
12335	switch (io->taskio.task_action) {
12336	case CTL_TASK_ABORT_TASK:
12337		retval = ctl_abort_task(io);
12338		break;
12339	case CTL_TASK_ABORT_TASK_SET:
12340	case CTL_TASK_CLEAR_TASK_SET:
12341		retval = ctl_abort_task_set(io);
12342		break;
12343	case CTL_TASK_CLEAR_ACA:
12344		break;
12345	case CTL_TASK_I_T_NEXUS_RESET:
12346		retval = ctl_i_t_nexus_reset(io);
12347		break;
12348	case CTL_TASK_LUN_RESET:
12349		retval = ctl_lun_reset(softc, io);
12350		break;
12351	case CTL_TASK_TARGET_RESET:
12352		retval = ctl_target_reset(softc, io, CTL_UA_TARG_RESET);
12353		break;
12354	case CTL_TASK_BUS_RESET:
12355		retval = ctl_bus_reset(softc, io);
12356		break;
12357	case CTL_TASK_PORT_LOGIN:
12358		break;
12359	case CTL_TASK_PORT_LOGOUT:
12360		break;
12361	case CTL_TASK_QUERY_TASK:
12362		retval = ctl_query_task(io, 0);
12363		break;
12364	case CTL_TASK_QUERY_TASK_SET:
12365		retval = ctl_query_task(io, 1);
12366		break;
12367	case CTL_TASK_QUERY_ASYNC_EVENT:
12368		retval = ctl_query_async_event(io);
12369		break;
12370	default:
12371		printf("%s: got unknown task management event %d\n",
12372		       __func__, io->taskio.task_action);
12373		break;
12374	}
12375	if (retval == 0)
12376		io->io_hdr.status = CTL_SUCCESS;
12377	else
12378		io->io_hdr.status = CTL_ERROR;
12379	ctl_done(io);
12380}
12381
12382/*
12383 * For HA operation.  Handle commands that come in from the other
12384 * controller.
12385 */
12386static void
12387ctl_handle_isc(union ctl_io *io)
12388{
12389	int free_io;
12390	struct ctl_lun *lun;
12391	struct ctl_softc *softc = control_softc;
12392	uint32_t targ_lun;
12393
12394	targ_lun = io->io_hdr.nexus.targ_mapped_lun;
12395	lun = softc->ctl_luns[targ_lun];
12396
12397	switch (io->io_hdr.msg_type) {
12398	case CTL_MSG_SERIALIZE:
12399		free_io = ctl_serialize_other_sc_cmd(&io->scsiio);
12400		break;
12401	case CTL_MSG_R2R: {
12402		const struct ctl_cmd_entry *entry;
12403
12404		/*
12405		 * This is only used in SER_ONLY mode.
12406		 */
12407		free_io = 0;
12408		entry = ctl_get_cmd_entry(&io->scsiio, NULL);
12409		mtx_lock(&lun->lun_lock);
12410		if (ctl_scsiio_lun_check(lun,
12411		    entry, (struct ctl_scsiio *)io) != 0) {
12412			mtx_unlock(&lun->lun_lock);
12413			ctl_done(io);
12414			break;
12415		}
12416		io->io_hdr.flags |= CTL_FLAG_IS_WAS_ON_RTR;
12417		mtx_unlock(&lun->lun_lock);
12418		ctl_enqueue_rtr(io);
12419		break;
12420	}
12421	case CTL_MSG_FINISH_IO:
12422		if (softc->ha_mode == CTL_HA_MODE_XFER) {
12423			free_io = 0;
12424			ctl_done(io);
12425		} else {
12426			free_io = 1;
12427			mtx_lock(&lun->lun_lock);
12428			TAILQ_REMOVE(&lun->ooa_queue, &io->io_hdr,
12429				     ooa_links);
12430			ctl_check_blocked(lun);
12431			mtx_unlock(&lun->lun_lock);
12432		}
12433		break;
12434	case CTL_MSG_PERS_ACTION:
12435		ctl_hndl_per_res_out_on_other_sc(
12436			(union ctl_ha_msg *)&io->presio.pr_msg);
12437		free_io = 1;
12438		break;
12439	case CTL_MSG_BAD_JUJU:
12440		free_io = 0;
12441		ctl_done(io);
12442		break;
12443	case CTL_MSG_DATAMOVE:
12444		/* Only used in XFER mode */
12445		free_io = 0;
12446		ctl_datamove_remote(io);
12447		break;
12448	case CTL_MSG_DATAMOVE_DONE:
12449		/* Only used in XFER mode */
12450		free_io = 0;
12451		io->scsiio.be_move_done(io);
12452		break;
12453	case CTL_MSG_FAILOVER:
12454		ctl_failover_lun(io);
12455		free_io = 1;
12456		break;
12457	default:
12458		free_io = 1;
12459		printf("%s: Invalid message type %d\n",
12460		       __func__, io->io_hdr.msg_type);
12461		break;
12462	}
12463	if (free_io)
12464		ctl_free_io(io);
12465
12466}
12467
12468
12469/*
12470 * Returns the match type in the case of a match, or CTL_LUN_PAT_NONE if
12471 * there is no match.
12472 */
12473static ctl_lun_error_pattern
12474ctl_cmd_pattern_match(struct ctl_scsiio *ctsio, struct ctl_error_desc *desc)
12475{
12476	const struct ctl_cmd_entry *entry;
12477	ctl_lun_error_pattern filtered_pattern, pattern;
12478
12479	pattern = desc->error_pattern;
12480
12481	/*
12482	 * XXX KDM we need more data passed into this function to match a
12483	 * custom pattern, and we actually need to implement custom pattern
12484	 * matching.
12485	 */
12486	if (pattern & CTL_LUN_PAT_CMD)
12487		return (CTL_LUN_PAT_CMD);
12488
12489	if ((pattern & CTL_LUN_PAT_MASK) == CTL_LUN_PAT_ANY)
12490		return (CTL_LUN_PAT_ANY);
12491
12492	entry = ctl_get_cmd_entry(ctsio, NULL);
12493
12494	filtered_pattern = entry->pattern & pattern;
12495
12496	/*
12497	 * If the user requested specific flags in the pattern (e.g.
12498	 * CTL_LUN_PAT_RANGE), make sure the command supports all of those
12499	 * flags.
12500	 *
12501	 * If the user did not specify any flags, it doesn't matter whether
12502	 * or not the command supports the flags.
12503	 */
12504	if ((filtered_pattern & ~CTL_LUN_PAT_MASK) !=
12505	     (pattern & ~CTL_LUN_PAT_MASK))
12506		return (CTL_LUN_PAT_NONE);
12507
12508	/*
12509	 * If the user asked for a range check, see if the requested LBA
12510	 * range overlaps with this command's LBA range.
12511	 */
12512	if (filtered_pattern & CTL_LUN_PAT_RANGE) {
12513		uint64_t lba1;
12514		uint64_t len1;
12515		ctl_action action;
12516		int retval;
12517
12518		retval = ctl_get_lba_len((union ctl_io *)ctsio, &lba1, &len1);
12519		if (retval != 0)
12520			return (CTL_LUN_PAT_NONE);
12521
12522		action = ctl_extent_check_lba(lba1, len1, desc->lba_range.lba,
12523					      desc->lba_range.len, FALSE);
12524		/*
12525		 * A "pass" means that the LBA ranges don't overlap, so
12526		 * this doesn't match the user's range criteria.
12527		 */
12528		if (action == CTL_ACTION_PASS)
12529			return (CTL_LUN_PAT_NONE);
12530	}
12531
12532	return (filtered_pattern);
12533}
12534
12535static void
12536ctl_inject_error(struct ctl_lun *lun, union ctl_io *io)
12537{
12538	struct ctl_error_desc *desc, *desc2;
12539
12540	mtx_assert(&lun->lun_lock, MA_OWNED);
12541
12542	STAILQ_FOREACH_SAFE(desc, &lun->error_list, links, desc2) {
12543		ctl_lun_error_pattern pattern;
12544		/*
12545		 * Check to see whether this particular command matches
12546		 * the pattern in the descriptor.
12547		 */
12548		pattern = ctl_cmd_pattern_match(&io->scsiio, desc);
12549		if ((pattern & CTL_LUN_PAT_MASK) == CTL_LUN_PAT_NONE)
12550			continue;
12551
12552		switch (desc->lun_error & CTL_LUN_INJ_TYPE) {
12553		case CTL_LUN_INJ_ABORTED:
12554			ctl_set_aborted(&io->scsiio);
12555			break;
12556		case CTL_LUN_INJ_MEDIUM_ERR:
12557			ctl_set_medium_error(&io->scsiio,
12558			    (io->io_hdr.flags & CTL_FLAG_DATA_MASK) !=
12559			     CTL_FLAG_DATA_OUT);
12560			break;
12561		case CTL_LUN_INJ_UA:
12562			/* 29h/00h  POWER ON, RESET, OR BUS DEVICE RESET
12563			 * OCCURRED */
12564			ctl_set_ua(&io->scsiio, 0x29, 0x00);
12565			break;
12566		case CTL_LUN_INJ_CUSTOM:
12567			/*
12568			 * We're assuming the user knows what he is doing.
12569			 * Just copy the sense information without doing
12570			 * checks.
12571			 */
12572			bcopy(&desc->custom_sense, &io->scsiio.sense_data,
12573			      MIN(sizeof(desc->custom_sense),
12574				  sizeof(io->scsiio.sense_data)));
12575			io->scsiio.scsi_status = SCSI_STATUS_CHECK_COND;
12576			io->scsiio.sense_len = SSD_FULL_SIZE;
12577			io->io_hdr.status = CTL_SCSI_ERROR | CTL_AUTOSENSE;
12578			break;
12579		case CTL_LUN_INJ_NONE:
12580		default:
12581			/*
12582			 * If this is an error injection type we don't know
12583			 * about, clear the continuous flag (if it is set)
12584			 * so it will get deleted below.
12585			 */
12586			desc->lun_error &= ~CTL_LUN_INJ_CONTINUOUS;
12587			break;
12588		}
12589		/*
12590		 * By default, each error injection action is a one-shot
12591		 */
12592		if (desc->lun_error & CTL_LUN_INJ_CONTINUOUS)
12593			continue;
12594
12595		STAILQ_REMOVE(&lun->error_list, desc, ctl_error_desc, links);
12596
12597		free(desc, M_CTL);
12598	}
12599}
12600
12601#ifdef CTL_IO_DELAY
12602static void
12603ctl_datamove_timer_wakeup(void *arg)
12604{
12605	union ctl_io *io;
12606
12607	io = (union ctl_io *)arg;
12608
12609	ctl_datamove(io);
12610}
12611#endif /* CTL_IO_DELAY */
12612
12613void
12614ctl_datamove(union ctl_io *io)
12615{
12616	struct ctl_lun *lun;
12617	void (*fe_datamove)(union ctl_io *io);
12618
12619	mtx_assert(&control_softc->ctl_lock, MA_NOTOWNED);
12620
12621	CTL_DEBUG_PRINT(("ctl_datamove\n"));
12622
12623	lun = (struct ctl_lun *)io->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
12624#ifdef CTL_TIME_IO
12625	if ((time_uptime - io->io_hdr.start_time) > ctl_time_io_secs) {
12626		char str[256];
12627		char path_str[64];
12628		struct sbuf sb;
12629
12630		ctl_scsi_path_string(io, path_str, sizeof(path_str));
12631		sbuf_new(&sb, str, sizeof(str), SBUF_FIXEDLEN);
12632
12633		sbuf_cat(&sb, path_str);
12634		switch (io->io_hdr.io_type) {
12635		case CTL_IO_SCSI:
12636			ctl_scsi_command_string(&io->scsiio, NULL, &sb);
12637			sbuf_printf(&sb, "\n");
12638			sbuf_cat(&sb, path_str);
12639			sbuf_printf(&sb, "Tag: 0x%04x, type %d\n",
12640				    io->scsiio.tag_num, io->scsiio.tag_type);
12641			break;
12642		case CTL_IO_TASK:
12643			sbuf_printf(&sb, "Task I/O type: %d, Tag: 0x%04x, "
12644				    "Tag Type: %d\n", io->taskio.task_action,
12645				    io->taskio.tag_num, io->taskio.tag_type);
12646			break;
12647		default:
12648			panic("%s: Invalid CTL I/O type %d\n",
12649			    __func__, io->io_hdr.io_type);
12650		}
12651		sbuf_cat(&sb, path_str);
12652		sbuf_printf(&sb, "ctl_datamove: %jd seconds\n",
12653			    (intmax_t)time_uptime - io->io_hdr.start_time);
12654		sbuf_finish(&sb);
12655		printf("%s", sbuf_data(&sb));
12656	}
12657#endif /* CTL_TIME_IO */
12658
12659#ifdef CTL_IO_DELAY
12660	if (io->io_hdr.flags & CTL_FLAG_DELAY_DONE) {
12661		io->io_hdr.flags &= ~CTL_FLAG_DELAY_DONE;
12662	} else {
12663		if ((lun != NULL)
12664		 && (lun->delay_info.datamove_delay > 0)) {
12665
12666			callout_init(&io->io_hdr.delay_callout, /*mpsafe*/ 1);
12667			io->io_hdr.flags |= CTL_FLAG_DELAY_DONE;
12668			callout_reset(&io->io_hdr.delay_callout,
12669				      lun->delay_info.datamove_delay * hz,
12670				      ctl_datamove_timer_wakeup, io);
12671			if (lun->delay_info.datamove_type ==
12672			    CTL_DELAY_TYPE_ONESHOT)
12673				lun->delay_info.datamove_delay = 0;
12674			return;
12675		}
12676	}
12677#endif
12678
12679	/*
12680	 * This command has been aborted.  Set the port status, so we fail
12681	 * the data move.
12682	 */
12683	if (io->io_hdr.flags & CTL_FLAG_ABORT) {
12684		printf("ctl_datamove: tag 0x%04x on (%u:%u:%u) aborted\n",
12685		       io->scsiio.tag_num, io->io_hdr.nexus.initid,
12686		       io->io_hdr.nexus.targ_port,
12687		       io->io_hdr.nexus.targ_lun);
12688		io->io_hdr.port_status = 31337;
12689		/*
12690		 * Note that the backend, in this case, will get the
12691		 * callback in its context.  In other cases it may get
12692		 * called in the frontend's interrupt thread context.
12693		 */
12694		io->scsiio.be_move_done(io);
12695		return;
12696	}
12697
12698	/* Don't confuse frontend with zero length data move. */
12699	if (io->scsiio.kern_data_len == 0) {
12700		io->scsiio.be_move_done(io);
12701		return;
12702	}
12703
12704	fe_datamove = ctl_io_port(&io->io_hdr)->fe_datamove;
12705	fe_datamove(io);
12706}
12707
12708static void
12709ctl_send_datamove_done(union ctl_io *io, int have_lock)
12710{
12711	union ctl_ha_msg msg;
12712#ifdef CTL_TIME_IO
12713	struct bintime cur_bt;
12714#endif
12715
12716	memset(&msg, 0, sizeof(msg));
12717	msg.hdr.msg_type = CTL_MSG_DATAMOVE_DONE;
12718	msg.hdr.original_sc = io;
12719	msg.hdr.serializing_sc = io->io_hdr.serializing_sc;
12720	msg.hdr.nexus = io->io_hdr.nexus;
12721	msg.hdr.status = io->io_hdr.status;
12722	msg.scsi.tag_num = io->scsiio.tag_num;
12723	msg.scsi.tag_type = io->scsiio.tag_type;
12724	msg.scsi.scsi_status = io->scsiio.scsi_status;
12725	memcpy(&msg.scsi.sense_data, &io->scsiio.sense_data,
12726	       io->scsiio.sense_len);
12727	msg.scsi.sense_len = io->scsiio.sense_len;
12728	msg.scsi.sense_residual = io->scsiio.sense_residual;
12729	msg.scsi.fetd_status = io->io_hdr.port_status;
12730	msg.scsi.residual = io->scsiio.residual;
12731	io->io_hdr.flags &= ~CTL_FLAG_IO_ACTIVE;
12732	if (io->io_hdr.flags & CTL_FLAG_FAILOVER) {
12733		ctl_failover_io(io, /*have_lock*/ have_lock);
12734		return;
12735	}
12736	ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg,
12737	    sizeof(msg.scsi) - sizeof(msg.scsi.sense_data) +
12738	    msg.scsi.sense_len, M_WAITOK);
12739
12740#ifdef CTL_TIME_IO
12741	getbinuptime(&cur_bt);
12742	bintime_sub(&cur_bt, &io->io_hdr.dma_start_bt);
12743	bintime_add(&io->io_hdr.dma_bt, &cur_bt);
12744#endif
12745	io->io_hdr.num_dmas++;
12746}
12747
12748/*
12749 * The DMA to the remote side is done, now we need to tell the other side
12750 * we're done so it can continue with its data movement.
12751 */
12752static void
12753ctl_datamove_remote_write_cb(struct ctl_ha_dt_req *rq)
12754{
12755	union ctl_io *io;
12756	uint32_t i;
12757
12758	io = rq->context;
12759
12760	if (rq->ret != CTL_HA_STATUS_SUCCESS) {
12761		printf("%s: ISC DMA write failed with error %d", __func__,
12762		       rq->ret);
12763		ctl_set_internal_failure(&io->scsiio,
12764					 /*sks_valid*/ 1,
12765					 /*retry_count*/ rq->ret);
12766	}
12767
12768	ctl_dt_req_free(rq);
12769
12770	for (i = 0; i < io->scsiio.kern_sg_entries; i++)
12771		free(io->io_hdr.local_sglist[i].addr, M_CTL);
12772	free(io->io_hdr.remote_sglist, M_CTL);
12773	io->io_hdr.remote_sglist = NULL;
12774	io->io_hdr.local_sglist = NULL;
12775
12776	/*
12777	 * The data is in local and remote memory, so now we need to send
12778	 * status (good or back) back to the other side.
12779	 */
12780	ctl_send_datamove_done(io, /*have_lock*/ 0);
12781}
12782
12783/*
12784 * We've moved the data from the host/controller into local memory.  Now we
12785 * need to push it over to the remote controller's memory.
12786 */
12787static int
12788ctl_datamove_remote_dm_write_cb(union ctl_io *io)
12789{
12790	int retval;
12791
12792	retval = ctl_datamove_remote_xfer(io, CTL_HA_DT_CMD_WRITE,
12793					  ctl_datamove_remote_write_cb);
12794	return (retval);
12795}
12796
12797static void
12798ctl_datamove_remote_write(union ctl_io *io)
12799{
12800	int retval;
12801	void (*fe_datamove)(union ctl_io *io);
12802
12803	/*
12804	 * - Get the data from the host/HBA into local memory.
12805	 * - DMA memory from the local controller to the remote controller.
12806	 * - Send status back to the remote controller.
12807	 */
12808
12809	retval = ctl_datamove_remote_sgl_setup(io);
12810	if (retval != 0)
12811		return;
12812
12813	/* Switch the pointer over so the FETD knows what to do */
12814	io->scsiio.kern_data_ptr = (uint8_t *)io->io_hdr.local_sglist;
12815
12816	/*
12817	 * Use a custom move done callback, since we need to send completion
12818	 * back to the other controller, not to the backend on this side.
12819	 */
12820	io->scsiio.be_move_done = ctl_datamove_remote_dm_write_cb;
12821
12822	fe_datamove = ctl_io_port(&io->io_hdr)->fe_datamove;
12823	fe_datamove(io);
12824}
12825
12826static int
12827ctl_datamove_remote_dm_read_cb(union ctl_io *io)
12828{
12829#if 0
12830	char str[256];
12831	char path_str[64];
12832	struct sbuf sb;
12833#endif
12834	uint32_t i;
12835
12836	for (i = 0; i < io->scsiio.kern_sg_entries; i++)
12837		free(io->io_hdr.local_sglist[i].addr, M_CTL);
12838	free(io->io_hdr.remote_sglist, M_CTL);
12839	io->io_hdr.remote_sglist = NULL;
12840	io->io_hdr.local_sglist = NULL;
12841
12842#if 0
12843	scsi_path_string(io, path_str, sizeof(path_str));
12844	sbuf_new(&sb, str, sizeof(str), SBUF_FIXEDLEN);
12845	sbuf_cat(&sb, path_str);
12846	scsi_command_string(&io->scsiio, NULL, &sb);
12847	sbuf_printf(&sb, "\n");
12848	sbuf_cat(&sb, path_str);
12849	sbuf_printf(&sb, "Tag: 0x%04x, type %d\n",
12850		    io->scsiio.tag_num, io->scsiio.tag_type);
12851	sbuf_cat(&sb, path_str);
12852	sbuf_printf(&sb, "%s: flags %#x, status %#x\n", __func__,
12853		    io->io_hdr.flags, io->io_hdr.status);
12854	sbuf_finish(&sb);
12855	printk("%s", sbuf_data(&sb));
12856#endif
12857
12858
12859	/*
12860	 * The read is done, now we need to send status (good or bad) back
12861	 * to the other side.
12862	 */
12863	ctl_send_datamove_done(io, /*have_lock*/ 0);
12864
12865	return (0);
12866}
12867
12868static void
12869ctl_datamove_remote_read_cb(struct ctl_ha_dt_req *rq)
12870{
12871	union ctl_io *io;
12872	void (*fe_datamove)(union ctl_io *io);
12873
12874	io = rq->context;
12875
12876	if (rq->ret != CTL_HA_STATUS_SUCCESS) {
12877		printf("%s: ISC DMA read failed with error %d\n", __func__,
12878		       rq->ret);
12879		ctl_set_internal_failure(&io->scsiio,
12880					 /*sks_valid*/ 1,
12881					 /*retry_count*/ rq->ret);
12882	}
12883
12884	ctl_dt_req_free(rq);
12885
12886	/* Switch the pointer over so the FETD knows what to do */
12887	io->scsiio.kern_data_ptr = (uint8_t *)io->io_hdr.local_sglist;
12888
12889	/*
12890	 * Use a custom move done callback, since we need to send completion
12891	 * back to the other controller, not to the backend on this side.
12892	 */
12893	io->scsiio.be_move_done = ctl_datamove_remote_dm_read_cb;
12894
12895	/* XXX KDM add checks like the ones in ctl_datamove? */
12896
12897	fe_datamove = ctl_io_port(&io->io_hdr)->fe_datamove;
12898	fe_datamove(io);
12899}
12900
12901static int
12902ctl_datamove_remote_sgl_setup(union ctl_io *io)
12903{
12904	struct ctl_sg_entry *local_sglist;
12905	uint32_t len_to_go;
12906	int retval;
12907	int i;
12908
12909	retval = 0;
12910	local_sglist = io->io_hdr.local_sglist;
12911	len_to_go = io->scsiio.kern_data_len;
12912
12913	/*
12914	 * The difficult thing here is that the size of the various
12915	 * S/G segments may be different than the size from the
12916	 * remote controller.  That'll make it harder when DMAing
12917	 * the data back to the other side.
12918	 */
12919	for (i = 0; len_to_go > 0; i++) {
12920		local_sglist[i].len = MIN(len_to_go, CTL_HA_DATAMOVE_SEGMENT);
12921		local_sglist[i].addr =
12922		    malloc(local_sglist[i].len, M_CTL, M_WAITOK);
12923
12924		len_to_go -= local_sglist[i].len;
12925	}
12926	/*
12927	 * Reset the number of S/G entries accordingly.  The original
12928	 * number of S/G entries is available in rem_sg_entries.
12929	 */
12930	io->scsiio.kern_sg_entries = i;
12931
12932#if 0
12933	printf("%s: kern_sg_entries = %d\n", __func__,
12934	       io->scsiio.kern_sg_entries);
12935	for (i = 0; i < io->scsiio.kern_sg_entries; i++)
12936		printf("%s: sg[%d] = %p, %lu\n", __func__, i,
12937		       local_sglist[i].addr, local_sglist[i].len);
12938#endif
12939
12940	return (retval);
12941}
12942
12943static int
12944ctl_datamove_remote_xfer(union ctl_io *io, unsigned command,
12945			 ctl_ha_dt_cb callback)
12946{
12947	struct ctl_ha_dt_req *rq;
12948	struct ctl_sg_entry *remote_sglist, *local_sglist;
12949	uint32_t local_used, remote_used, total_used;
12950	int i, j, isc_ret;
12951
12952	rq = ctl_dt_req_alloc();
12953
12954	/*
12955	 * If we failed to allocate the request, and if the DMA didn't fail
12956	 * anyway, set busy status.  This is just a resource allocation
12957	 * failure.
12958	 */
12959	if ((rq == NULL)
12960	 && ((io->io_hdr.status & CTL_STATUS_MASK) != CTL_STATUS_NONE &&
12961	     (io->io_hdr.status & CTL_STATUS_MASK) != CTL_SUCCESS))
12962		ctl_set_busy(&io->scsiio);
12963
12964	if ((io->io_hdr.status & CTL_STATUS_MASK) != CTL_STATUS_NONE &&
12965	    (io->io_hdr.status & CTL_STATUS_MASK) != CTL_SUCCESS) {
12966
12967		if (rq != NULL)
12968			ctl_dt_req_free(rq);
12969
12970		/*
12971		 * The data move failed.  We need to return status back
12972		 * to the other controller.  No point in trying to DMA
12973		 * data to the remote controller.
12974		 */
12975
12976		ctl_send_datamove_done(io, /*have_lock*/ 0);
12977
12978		return (1);
12979	}
12980
12981	local_sglist = io->io_hdr.local_sglist;
12982	remote_sglist = io->io_hdr.remote_sglist;
12983	local_used = 0;
12984	remote_used = 0;
12985	total_used = 0;
12986
12987	/*
12988	 * Pull/push the data over the wire from/to the other controller.
12989	 * This takes into account the possibility that the local and
12990	 * remote sglists may not be identical in terms of the size of
12991	 * the elements and the number of elements.
12992	 *
12993	 * One fundamental assumption here is that the length allocated for
12994	 * both the local and remote sglists is identical.  Otherwise, we've
12995	 * essentially got a coding error of some sort.
12996	 */
12997	isc_ret = CTL_HA_STATUS_SUCCESS;
12998	for (i = 0, j = 0; total_used < io->scsiio.kern_data_len; ) {
12999		uint32_t cur_len;
13000		uint8_t *tmp_ptr;
13001
13002		rq->command = command;
13003		rq->context = io;
13004
13005		/*
13006		 * Both pointers should be aligned.  But it is possible
13007		 * that the allocation length is not.  They should both
13008		 * also have enough slack left over at the end, though,
13009		 * to round up to the next 8 byte boundary.
13010		 */
13011		cur_len = MIN(local_sglist[i].len - local_used,
13012			      remote_sglist[j].len - remote_used);
13013		rq->size = cur_len;
13014
13015		tmp_ptr = (uint8_t *)local_sglist[i].addr;
13016		tmp_ptr += local_used;
13017
13018#if 0
13019		/* Use physical addresses when talking to ISC hardware */
13020		if ((io->io_hdr.flags & CTL_FLAG_BUS_ADDR) == 0) {
13021			/* XXX KDM use busdma */
13022			rq->local = vtophys(tmp_ptr);
13023		} else
13024			rq->local = tmp_ptr;
13025#else
13026		KASSERT((io->io_hdr.flags & CTL_FLAG_BUS_ADDR) == 0,
13027		    ("HA does not support BUS_ADDR"));
13028		rq->local = tmp_ptr;
13029#endif
13030
13031		tmp_ptr = (uint8_t *)remote_sglist[j].addr;
13032		tmp_ptr += remote_used;
13033		rq->remote = tmp_ptr;
13034
13035		rq->callback = NULL;
13036
13037		local_used += cur_len;
13038		if (local_used >= local_sglist[i].len) {
13039			i++;
13040			local_used = 0;
13041		}
13042
13043		remote_used += cur_len;
13044		if (remote_used >= remote_sglist[j].len) {
13045			j++;
13046			remote_used = 0;
13047		}
13048		total_used += cur_len;
13049
13050		if (total_used >= io->scsiio.kern_data_len)
13051			rq->callback = callback;
13052
13053#if 0
13054		printf("%s: %s: local %p remote %p size %d\n", __func__,
13055		       (command == CTL_HA_DT_CMD_WRITE) ? "WRITE" : "READ",
13056		       rq->local, rq->remote, rq->size);
13057#endif
13058
13059		isc_ret = ctl_dt_single(rq);
13060		if (isc_ret > CTL_HA_STATUS_SUCCESS)
13061			break;
13062	}
13063	if (isc_ret != CTL_HA_STATUS_WAIT) {
13064		rq->ret = isc_ret;
13065		callback(rq);
13066	}
13067
13068	return (0);
13069}
13070
13071static void
13072ctl_datamove_remote_read(union ctl_io *io)
13073{
13074	int retval;
13075	uint32_t i;
13076
13077	/*
13078	 * This will send an error to the other controller in the case of a
13079	 * failure.
13080	 */
13081	retval = ctl_datamove_remote_sgl_setup(io);
13082	if (retval != 0)
13083		return;
13084
13085	retval = ctl_datamove_remote_xfer(io, CTL_HA_DT_CMD_READ,
13086					  ctl_datamove_remote_read_cb);
13087	if (retval != 0) {
13088		/*
13089		 * Make sure we free memory if there was an error..  The
13090		 * ctl_datamove_remote_xfer() function will send the
13091		 * datamove done message, or call the callback with an
13092		 * error if there is a problem.
13093		 */
13094		for (i = 0; i < io->scsiio.kern_sg_entries; i++)
13095			free(io->io_hdr.local_sglist[i].addr, M_CTL);
13096		free(io->io_hdr.remote_sglist, M_CTL);
13097		io->io_hdr.remote_sglist = NULL;
13098		io->io_hdr.local_sglist = NULL;
13099	}
13100}
13101
13102/*
13103 * Process a datamove request from the other controller.  This is used for
13104 * XFER mode only, not SER_ONLY mode.  For writes, we DMA into local memory
13105 * first.  Once that is complete, the data gets DMAed into the remote
13106 * controller's memory.  For reads, we DMA from the remote controller's
13107 * memory into our memory first, and then move it out to the FETD.
13108 */
13109static void
13110ctl_datamove_remote(union ctl_io *io)
13111{
13112
13113	mtx_assert(&control_softc->ctl_lock, MA_NOTOWNED);
13114
13115	if (io->io_hdr.flags & CTL_FLAG_FAILOVER) {
13116		ctl_failover_io(io, /*have_lock*/ 0);
13117		return;
13118	}
13119
13120	/*
13121	 * Note that we look for an aborted I/O here, but don't do some of
13122	 * the other checks that ctl_datamove() normally does.
13123	 * We don't need to run the datamove delay code, since that should
13124	 * have been done if need be on the other controller.
13125	 */
13126	if (io->io_hdr.flags & CTL_FLAG_ABORT) {
13127		printf("%s: tag 0x%04x on (%u:%u:%u) aborted\n", __func__,
13128		       io->scsiio.tag_num, io->io_hdr.nexus.initid,
13129		       io->io_hdr.nexus.targ_port,
13130		       io->io_hdr.nexus.targ_lun);
13131		io->io_hdr.port_status = 31338;
13132		ctl_send_datamove_done(io, /*have_lock*/ 0);
13133		return;
13134	}
13135
13136	if ((io->io_hdr.flags & CTL_FLAG_DATA_MASK) == CTL_FLAG_DATA_OUT)
13137		ctl_datamove_remote_write(io);
13138	else if ((io->io_hdr.flags & CTL_FLAG_DATA_MASK) == CTL_FLAG_DATA_IN)
13139		ctl_datamove_remote_read(io);
13140	else {
13141		io->io_hdr.port_status = 31339;
13142		ctl_send_datamove_done(io, /*have_lock*/ 0);
13143	}
13144}
13145
13146static void
13147ctl_process_done(union ctl_io *io)
13148{
13149	struct ctl_lun *lun;
13150	struct ctl_softc *softc = control_softc;
13151	void (*fe_done)(union ctl_io *io);
13152	union ctl_ha_msg msg;
13153	uint32_t targ_port = io->io_hdr.nexus.targ_port;
13154
13155	CTL_DEBUG_PRINT(("ctl_process_done\n"));
13156	fe_done = softc->ctl_ports[targ_port]->fe_done;
13157
13158#ifdef CTL_TIME_IO
13159	if ((time_uptime - io->io_hdr.start_time) > ctl_time_io_secs) {
13160		char str[256];
13161		char path_str[64];
13162		struct sbuf sb;
13163
13164		ctl_scsi_path_string(io, path_str, sizeof(path_str));
13165		sbuf_new(&sb, str, sizeof(str), SBUF_FIXEDLEN);
13166
13167		sbuf_cat(&sb, path_str);
13168		switch (io->io_hdr.io_type) {
13169		case CTL_IO_SCSI:
13170			ctl_scsi_command_string(&io->scsiio, NULL, &sb);
13171			sbuf_printf(&sb, "\n");
13172			sbuf_cat(&sb, path_str);
13173			sbuf_printf(&sb, "Tag: 0x%04x, type %d\n",
13174				    io->scsiio.tag_num, io->scsiio.tag_type);
13175			break;
13176		case CTL_IO_TASK:
13177			sbuf_printf(&sb, "Task I/O type: %d, Tag: 0x%04x, "
13178				    "Tag Type: %d\n", io->taskio.task_action,
13179				    io->taskio.tag_num, io->taskio.tag_type);
13180			break;
13181		default:
13182			panic("%s: Invalid CTL I/O type %d\n",
13183			    __func__, io->io_hdr.io_type);
13184		}
13185		sbuf_cat(&sb, path_str);
13186		sbuf_printf(&sb, "ctl_process_done: %jd seconds\n",
13187			    (intmax_t)time_uptime - io->io_hdr.start_time);
13188		sbuf_finish(&sb);
13189		printf("%s", sbuf_data(&sb));
13190	}
13191#endif /* CTL_TIME_IO */
13192
13193	switch (io->io_hdr.io_type) {
13194	case CTL_IO_SCSI:
13195		break;
13196	case CTL_IO_TASK:
13197		if (ctl_debug & CTL_DEBUG_INFO)
13198			ctl_io_error_print(io, NULL);
13199		fe_done(io);
13200		return;
13201	default:
13202		panic("%s: Invalid CTL I/O type %d\n",
13203		    __func__, io->io_hdr.io_type);
13204	}
13205
13206	lun = (struct ctl_lun *)io->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
13207	if (lun == NULL) {
13208		CTL_DEBUG_PRINT(("NULL LUN for lun %d\n",
13209				 io->io_hdr.nexus.targ_mapped_lun));
13210		goto bailout;
13211	}
13212
13213	mtx_lock(&lun->lun_lock);
13214
13215	/*
13216	 * Check to see if we have any informational exception and status
13217	 * of this command can be modified to report it in form of either
13218	 * RECOVERED ERROR or NO SENSE, depending on MRIE mode page field.
13219	 */
13220	if (lun->ie_reported == 0 && lun->ie_asc != 0 &&
13221	    io->io_hdr.status == CTL_SUCCESS &&
13222	    (io->io_hdr.flags & CTL_FLAG_STATUS_SENT) == 0) {
13223		uint8_t mrie = lun->MODE_IE.mrie;
13224		uint8_t per = ((lun->MODE_RWER.byte3 & SMS_RWER_PER) ||
13225		    (lun->MODE_VER.byte3 & SMS_VER_PER));
13226		if (((mrie == SIEP_MRIE_REC_COND && per) ||
13227		     mrie == SIEP_MRIE_REC_UNCOND ||
13228		     mrie == SIEP_MRIE_NO_SENSE) &&
13229		    (ctl_get_cmd_entry(&io->scsiio, NULL)->flags &
13230		     CTL_CMD_FLAG_NO_SENSE) == 0) {
13231			ctl_set_sense(&io->scsiio,
13232			      /*current_error*/ 1,
13233			      /*sense_key*/ (mrie == SIEP_MRIE_NO_SENSE) ?
13234			        SSD_KEY_NO_SENSE : SSD_KEY_RECOVERED_ERROR,
13235			      /*asc*/ lun->ie_asc,
13236			      /*ascq*/ lun->ie_ascq,
13237			      SSD_ELEM_NONE);
13238			lun->ie_reported = 1;
13239		}
13240	} else if (lun->ie_reported < 0)
13241		lun->ie_reported = 0;
13242
13243	/*
13244	 * Check to see if we have any errors to inject here.  We only
13245	 * inject errors for commands that don't already have errors set.
13246	 */
13247	if (!STAILQ_EMPTY(&lun->error_list) &&
13248	    ((io->io_hdr.status & CTL_STATUS_MASK) == CTL_SUCCESS) &&
13249	    ((io->io_hdr.flags & CTL_FLAG_STATUS_SENT) == 0))
13250		ctl_inject_error(lun, io);
13251
13252	/*
13253	 * XXX KDM how do we treat commands that aren't completed
13254	 * successfully?
13255	 *
13256	 * XXX KDM should we also track I/O latency?
13257	 */
13258	if ((io->io_hdr.status & CTL_STATUS_MASK) == CTL_SUCCESS &&
13259	    io->io_hdr.io_type == CTL_IO_SCSI) {
13260#ifdef CTL_TIME_IO
13261		struct bintime cur_bt;
13262#endif
13263		int type;
13264
13265		if ((io->io_hdr.flags & CTL_FLAG_DATA_MASK) ==
13266		    CTL_FLAG_DATA_IN)
13267			type = CTL_STATS_READ;
13268		else if ((io->io_hdr.flags & CTL_FLAG_DATA_MASK) ==
13269		    CTL_FLAG_DATA_OUT)
13270			type = CTL_STATS_WRITE;
13271		else
13272			type = CTL_STATS_NO_IO;
13273
13274		lun->stats.ports[targ_port].bytes[type] +=
13275		    io->scsiio.kern_total_len;
13276		lun->stats.ports[targ_port].operations[type]++;
13277#ifdef CTL_TIME_IO
13278		bintime_add(&lun->stats.ports[targ_port].dma_time[type],
13279		   &io->io_hdr.dma_bt);
13280		getbinuptime(&cur_bt);
13281		bintime_sub(&cur_bt, &io->io_hdr.start_bt);
13282		bintime_add(&lun->stats.ports[targ_port].time[type], &cur_bt);
13283#endif
13284		lun->stats.ports[targ_port].num_dmas[type] +=
13285		    io->io_hdr.num_dmas;
13286	}
13287
13288	/*
13289	 * Remove this from the OOA queue.
13290	 */
13291	TAILQ_REMOVE(&lun->ooa_queue, &io->io_hdr, ooa_links);
13292#ifdef CTL_TIME_IO
13293	if (TAILQ_EMPTY(&lun->ooa_queue))
13294		lun->last_busy = getsbinuptime();
13295#endif
13296
13297	/*
13298	 * Run through the blocked queue on this LUN and see if anything
13299	 * has become unblocked, now that this transaction is done.
13300	 */
13301	ctl_check_blocked(lun);
13302
13303	/*
13304	 * If the LUN has been invalidated, free it if there is nothing
13305	 * left on its OOA queue.
13306	 */
13307	if ((lun->flags & CTL_LUN_INVALID)
13308	 && TAILQ_EMPTY(&lun->ooa_queue)) {
13309		mtx_unlock(&lun->lun_lock);
13310		mtx_lock(&softc->ctl_lock);
13311		ctl_free_lun(lun);
13312		mtx_unlock(&softc->ctl_lock);
13313	} else
13314		mtx_unlock(&lun->lun_lock);
13315
13316bailout:
13317
13318	/*
13319	 * If this command has been aborted, make sure we set the status
13320	 * properly.  The FETD is responsible for freeing the I/O and doing
13321	 * whatever it needs to do to clean up its state.
13322	 */
13323	if (io->io_hdr.flags & CTL_FLAG_ABORT)
13324		ctl_set_task_aborted(&io->scsiio);
13325
13326	/*
13327	 * If enabled, print command error status.
13328	 */
13329	if ((io->io_hdr.status & CTL_STATUS_MASK) != CTL_SUCCESS &&
13330	    (ctl_debug & CTL_DEBUG_INFO) != 0)
13331		ctl_io_error_print(io, NULL);
13332
13333	/*
13334	 * Tell the FETD or the other shelf controller we're done with this
13335	 * command.  Note that only SCSI commands get to this point.  Task
13336	 * management commands are completed above.
13337	 */
13338	if ((softc->ha_mode != CTL_HA_MODE_XFER) &&
13339	    (io->io_hdr.flags & CTL_FLAG_SENT_2OTHER_SC)) {
13340		memset(&msg, 0, sizeof(msg));
13341		msg.hdr.msg_type = CTL_MSG_FINISH_IO;
13342		msg.hdr.serializing_sc = io->io_hdr.serializing_sc;
13343		msg.hdr.nexus = io->io_hdr.nexus;
13344		ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg,
13345		    sizeof(msg.scsi) - sizeof(msg.scsi.sense_data),
13346		    M_WAITOK);
13347	}
13348
13349	fe_done(io);
13350}
13351
13352#ifdef CTL_WITH_CA
13353/*
13354 * Front end should call this if it doesn't do autosense.  When the request
13355 * sense comes back in from the initiator, we'll dequeue this and send it.
13356 */
13357int
13358ctl_queue_sense(union ctl_io *io)
13359{
13360	struct ctl_lun *lun;
13361	struct ctl_port *port;
13362	struct ctl_softc *softc;
13363	uint32_t initidx, targ_lun;
13364
13365	softc = control_softc;
13366
13367	CTL_DEBUG_PRINT(("ctl_queue_sense\n"));
13368
13369	/*
13370	 * LUN lookup will likely move to the ctl_work_thread() once we
13371	 * have our new queueing infrastructure (that doesn't put things on
13372	 * a per-LUN queue initially).  That is so that we can handle
13373	 * things like an INQUIRY to a LUN that we don't have enabled.  We
13374	 * can't deal with that right now.
13375	 */
13376	mtx_lock(&softc->ctl_lock);
13377
13378	/*
13379	 * If we don't have a LUN for this, just toss the sense
13380	 * information.
13381	 */
13382	port = ctl_io_port(&ctsio->io_hdr);
13383	targ_lun = ctl_lun_map_from_port(port, io->io_hdr.nexus.targ_lun);
13384	if ((targ_lun < CTL_MAX_LUNS)
13385	 && (softc->ctl_luns[targ_lun] != NULL))
13386		lun = softc->ctl_luns[targ_lun];
13387	else
13388		goto bailout;
13389
13390	initidx = ctl_get_initindex(&io->io_hdr.nexus);
13391
13392	mtx_lock(&lun->lun_lock);
13393	/*
13394	 * Already have CA set for this LUN...toss the sense information.
13395	 */
13396	if (ctl_is_set(lun->have_ca, initidx)) {
13397		mtx_unlock(&lun->lun_lock);
13398		goto bailout;
13399	}
13400
13401	memcpy(&lun->pending_sense[initidx], &io->scsiio.sense_data,
13402	       MIN(sizeof(lun->pending_sense[initidx]),
13403	       sizeof(io->scsiio.sense_data)));
13404	ctl_set_mask(lun->have_ca, initidx);
13405	mtx_unlock(&lun->lun_lock);
13406
13407bailout:
13408	mtx_unlock(&softc->ctl_lock);
13409
13410	ctl_free_io(io);
13411
13412	return (CTL_RETVAL_COMPLETE);
13413}
13414#endif
13415
13416/*
13417 * Primary command inlet from frontend ports.  All SCSI and task I/O
13418 * requests must go through this function.
13419 */
13420int
13421ctl_queue(union ctl_io *io)
13422{
13423	struct ctl_port *port;
13424
13425	CTL_DEBUG_PRINT(("ctl_queue cdb[0]=%02X\n", io->scsiio.cdb[0]));
13426
13427#ifdef CTL_TIME_IO
13428	io->io_hdr.start_time = time_uptime;
13429	getbinuptime(&io->io_hdr.start_bt);
13430#endif /* CTL_TIME_IO */
13431
13432	/* Map FE-specific LUN ID into global one. */
13433	port = ctl_io_port(&io->io_hdr);
13434	io->io_hdr.nexus.targ_mapped_lun =
13435	    ctl_lun_map_from_port(port, io->io_hdr.nexus.targ_lun);
13436
13437	switch (io->io_hdr.io_type) {
13438	case CTL_IO_SCSI:
13439	case CTL_IO_TASK:
13440		if (ctl_debug & CTL_DEBUG_CDB)
13441			ctl_io_print(io);
13442		ctl_enqueue_incoming(io);
13443		break;
13444	default:
13445		printf("ctl_queue: unknown I/O type %d\n", io->io_hdr.io_type);
13446		return (EINVAL);
13447	}
13448
13449	return (CTL_RETVAL_COMPLETE);
13450}
13451
13452#ifdef CTL_IO_DELAY
13453static void
13454ctl_done_timer_wakeup(void *arg)
13455{
13456	union ctl_io *io;
13457
13458	io = (union ctl_io *)arg;
13459	ctl_done(io);
13460}
13461#endif /* CTL_IO_DELAY */
13462
13463void
13464ctl_serseq_done(union ctl_io *io)
13465{
13466	struct ctl_lun *lun;
13467
13468	lun = (struct ctl_lun *)io->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
13469	if (lun->be_lun == NULL ||
13470	    lun->be_lun->serseq == CTL_LUN_SERSEQ_OFF)
13471		return;
13472	mtx_lock(&lun->lun_lock);
13473	io->io_hdr.flags |= CTL_FLAG_SERSEQ_DONE;
13474	ctl_check_blocked(lun);
13475	mtx_unlock(&lun->lun_lock);
13476}
13477
13478void
13479ctl_done(union ctl_io *io)
13480{
13481
13482	/*
13483	 * Enable this to catch duplicate completion issues.
13484	 */
13485#if 0
13486	if (io->io_hdr.flags & CTL_FLAG_ALREADY_DONE) {
13487		printf("%s: type %d msg %d cdb %x iptl: "
13488		       "%u:%u:%u tag 0x%04x "
13489		       "flag %#x status %x\n",
13490			__func__,
13491			io->io_hdr.io_type,
13492			io->io_hdr.msg_type,
13493			io->scsiio.cdb[0],
13494			io->io_hdr.nexus.initid,
13495			io->io_hdr.nexus.targ_port,
13496			io->io_hdr.nexus.targ_lun,
13497			(io->io_hdr.io_type ==
13498			CTL_IO_TASK) ?
13499			io->taskio.tag_num :
13500			io->scsiio.tag_num,
13501		        io->io_hdr.flags,
13502			io->io_hdr.status);
13503	} else
13504		io->io_hdr.flags |= CTL_FLAG_ALREADY_DONE;
13505#endif
13506
13507	/*
13508	 * This is an internal copy of an I/O, and should not go through
13509	 * the normal done processing logic.
13510	 */
13511	if (io->io_hdr.flags & CTL_FLAG_INT_COPY)
13512		return;
13513
13514#ifdef CTL_IO_DELAY
13515	if (io->io_hdr.flags & CTL_FLAG_DELAY_DONE) {
13516		io->io_hdr.flags &= ~CTL_FLAG_DELAY_DONE;
13517	} else {
13518		struct ctl_lun *lun;
13519
13520		lun =(struct ctl_lun *)io->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
13521
13522		if ((lun != NULL)
13523		 && (lun->delay_info.done_delay > 0)) {
13524
13525			callout_init(&io->io_hdr.delay_callout, /*mpsafe*/ 1);
13526			io->io_hdr.flags |= CTL_FLAG_DELAY_DONE;
13527			callout_reset(&io->io_hdr.delay_callout,
13528				      lun->delay_info.done_delay * hz,
13529				      ctl_done_timer_wakeup, io);
13530			if (lun->delay_info.done_type == CTL_DELAY_TYPE_ONESHOT)
13531				lun->delay_info.done_delay = 0;
13532			return;
13533		}
13534	}
13535#endif /* CTL_IO_DELAY */
13536
13537	ctl_enqueue_done(io);
13538}
13539
13540static void
13541ctl_work_thread(void *arg)
13542{
13543	struct ctl_thread *thr = (struct ctl_thread *)arg;
13544	struct ctl_softc *softc = thr->ctl_softc;
13545	union ctl_io *io;
13546	int retval;
13547
13548	CTL_DEBUG_PRINT(("ctl_work_thread starting\n"));
13549
13550	for (;;) {
13551		/*
13552		 * We handle the queues in this order:
13553		 * - ISC
13554		 * - done queue (to free up resources, unblock other commands)
13555		 * - RtR queue
13556		 * - incoming queue
13557		 *
13558		 * If those queues are empty, we break out of the loop and
13559		 * go to sleep.
13560		 */
13561		mtx_lock(&thr->queue_lock);
13562		io = (union ctl_io *)STAILQ_FIRST(&thr->isc_queue);
13563		if (io != NULL) {
13564			STAILQ_REMOVE_HEAD(&thr->isc_queue, links);
13565			mtx_unlock(&thr->queue_lock);
13566			ctl_handle_isc(io);
13567			continue;
13568		}
13569		io = (union ctl_io *)STAILQ_FIRST(&thr->done_queue);
13570		if (io != NULL) {
13571			STAILQ_REMOVE_HEAD(&thr->done_queue, links);
13572			/* clear any blocked commands, call fe_done */
13573			mtx_unlock(&thr->queue_lock);
13574			ctl_process_done(io);
13575			continue;
13576		}
13577		io = (union ctl_io *)STAILQ_FIRST(&thr->incoming_queue);
13578		if (io != NULL) {
13579			STAILQ_REMOVE_HEAD(&thr->incoming_queue, links);
13580			mtx_unlock(&thr->queue_lock);
13581			if (io->io_hdr.io_type == CTL_IO_TASK)
13582				ctl_run_task(io);
13583			else
13584				ctl_scsiio_precheck(softc, &io->scsiio);
13585			continue;
13586		}
13587		io = (union ctl_io *)STAILQ_FIRST(&thr->rtr_queue);
13588		if (io != NULL) {
13589			STAILQ_REMOVE_HEAD(&thr->rtr_queue, links);
13590			mtx_unlock(&thr->queue_lock);
13591			retval = ctl_scsiio(&io->scsiio);
13592			if (retval != CTL_RETVAL_COMPLETE)
13593				CTL_DEBUG_PRINT(("ctl_scsiio failed\n"));
13594			continue;
13595		}
13596
13597		/* Sleep until we have something to do. */
13598		mtx_sleep(thr, &thr->queue_lock, PDROP | PRIBIO, "-", 0);
13599	}
13600}
13601
13602static void
13603ctl_lun_thread(void *arg)
13604{
13605	struct ctl_softc *softc = (struct ctl_softc *)arg;
13606	struct ctl_be_lun *be_lun;
13607
13608	CTL_DEBUG_PRINT(("ctl_lun_thread starting\n"));
13609
13610	for (;;) {
13611		mtx_lock(&softc->ctl_lock);
13612		be_lun = STAILQ_FIRST(&softc->pending_lun_queue);
13613		if (be_lun != NULL) {
13614			STAILQ_REMOVE_HEAD(&softc->pending_lun_queue, links);
13615			mtx_unlock(&softc->ctl_lock);
13616			ctl_create_lun(be_lun);
13617			continue;
13618		}
13619
13620		/* Sleep until we have something to do. */
13621		mtx_sleep(&softc->pending_lun_queue, &softc->ctl_lock,
13622		    PDROP | PRIBIO, "-", 0);
13623	}
13624}
13625
13626static void
13627ctl_thresh_thread(void *arg)
13628{
13629	struct ctl_softc *softc = (struct ctl_softc *)arg;
13630	struct ctl_lun *lun;
13631	struct ctl_logical_block_provisioning_page *page;
13632	const char *attr;
13633	union ctl_ha_msg msg;
13634	uint64_t thres, val;
13635	int i, e, set;
13636
13637	CTL_DEBUG_PRINT(("ctl_thresh_thread starting\n"));
13638
13639	for (;;) {
13640		mtx_lock(&softc->ctl_lock);
13641		STAILQ_FOREACH(lun, &softc->lun_list, links) {
13642			if ((lun->flags & CTL_LUN_DISABLED) ||
13643			    (lun->flags & CTL_LUN_NO_MEDIA) ||
13644			    lun->backend->lun_attr == NULL)
13645				continue;
13646			if ((lun->flags & CTL_LUN_PRIMARY_SC) == 0 &&
13647			    softc->ha_mode == CTL_HA_MODE_XFER)
13648				continue;
13649			if ((lun->MODE_RWER.byte8 & SMS_RWER_LBPERE) == 0)
13650				continue;
13651			e = 0;
13652			page = &lun->MODE_LBP;
13653			for (i = 0; i < CTL_NUM_LBP_THRESH; i++) {
13654				if ((page->descr[i].flags & SLBPPD_ENABLED) == 0)
13655					continue;
13656				thres = scsi_4btoul(page->descr[i].count);
13657				thres <<= CTL_LBP_EXPONENT;
13658				switch (page->descr[i].resource) {
13659				case 0x01:
13660					attr = "blocksavail";
13661					break;
13662				case 0x02:
13663					attr = "blocksused";
13664					break;
13665				case 0xf1:
13666					attr = "poolblocksavail";
13667					break;
13668				case 0xf2:
13669					attr = "poolblocksused";
13670					break;
13671				default:
13672					continue;
13673				}
13674				mtx_unlock(&softc->ctl_lock); // XXX
13675				val = lun->backend->lun_attr(
13676				    lun->be_lun->be_lun, attr);
13677				mtx_lock(&softc->ctl_lock);
13678				if (val == UINT64_MAX)
13679					continue;
13680				if ((page->descr[i].flags & SLBPPD_ARMING_MASK)
13681				    == SLBPPD_ARMING_INC)
13682					e = (val >= thres);
13683				else
13684					e = (val <= thres);
13685				if (e)
13686					break;
13687			}
13688			mtx_lock(&lun->lun_lock);
13689			if (e) {
13690				scsi_u64to8b((uint8_t *)&page->descr[i] -
13691				    (uint8_t *)page, lun->ua_tpt_info);
13692				if (lun->lasttpt == 0 ||
13693				    time_uptime - lun->lasttpt >= CTL_LBP_UA_PERIOD) {
13694					lun->lasttpt = time_uptime;
13695					ctl_est_ua_all(lun, -1, CTL_UA_THIN_PROV_THRES);
13696					set = 1;
13697				} else
13698					set = 0;
13699			} else {
13700				lun->lasttpt = 0;
13701				ctl_clr_ua_all(lun, -1, CTL_UA_THIN_PROV_THRES);
13702				set = -1;
13703			}
13704			mtx_unlock(&lun->lun_lock);
13705			if (set != 0 &&
13706			    lun->ctl_softc->ha_mode == CTL_HA_MODE_XFER) {
13707				/* Send msg to other side. */
13708				bzero(&msg.ua, sizeof(msg.ua));
13709				msg.hdr.msg_type = CTL_MSG_UA;
13710				msg.hdr.nexus.initid = -1;
13711				msg.hdr.nexus.targ_port = -1;
13712				msg.hdr.nexus.targ_lun = lun->lun;
13713				msg.hdr.nexus.targ_mapped_lun = lun->lun;
13714				msg.ua.ua_all = 1;
13715				msg.ua.ua_set = (set > 0);
13716				msg.ua.ua_type = CTL_UA_THIN_PROV_THRES;
13717				memcpy(msg.ua.ua_info, lun->ua_tpt_info, 8);
13718				mtx_unlock(&softc->ctl_lock); // XXX
13719				ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg,
13720				    sizeof(msg.ua), M_WAITOK);
13721				mtx_lock(&softc->ctl_lock);
13722			}
13723		}
13724		mtx_unlock(&softc->ctl_lock);
13725		pause("-", CTL_LBP_PERIOD * hz);
13726	}
13727}
13728
13729static void
13730ctl_enqueue_incoming(union ctl_io *io)
13731{
13732	struct ctl_softc *softc = control_softc;
13733	struct ctl_thread *thr;
13734	u_int idx;
13735
13736	idx = (io->io_hdr.nexus.targ_port * 127 +
13737	       io->io_hdr.nexus.initid) % worker_threads;
13738	thr = &softc->threads[idx];
13739	mtx_lock(&thr->queue_lock);
13740	STAILQ_INSERT_TAIL(&thr->incoming_queue, &io->io_hdr, links);
13741	mtx_unlock(&thr->queue_lock);
13742	wakeup(thr);
13743}
13744
13745static void
13746ctl_enqueue_rtr(union ctl_io *io)
13747{
13748	struct ctl_softc *softc = control_softc;
13749	struct ctl_thread *thr;
13750
13751	thr = &softc->threads[io->io_hdr.nexus.targ_mapped_lun % worker_threads];
13752	mtx_lock(&thr->queue_lock);
13753	STAILQ_INSERT_TAIL(&thr->rtr_queue, &io->io_hdr, links);
13754	mtx_unlock(&thr->queue_lock);
13755	wakeup(thr);
13756}
13757
13758static void
13759ctl_enqueue_done(union ctl_io *io)
13760{
13761	struct ctl_softc *softc = control_softc;
13762	struct ctl_thread *thr;
13763
13764	thr = &softc->threads[io->io_hdr.nexus.targ_mapped_lun % worker_threads];
13765	mtx_lock(&thr->queue_lock);
13766	STAILQ_INSERT_TAIL(&thr->done_queue, &io->io_hdr, links);
13767	mtx_unlock(&thr->queue_lock);
13768	wakeup(thr);
13769}
13770
13771static void
13772ctl_enqueue_isc(union ctl_io *io)
13773{
13774	struct ctl_softc *softc = control_softc;
13775	struct ctl_thread *thr;
13776
13777	thr = &softc->threads[io->io_hdr.nexus.targ_mapped_lun % worker_threads];
13778	mtx_lock(&thr->queue_lock);
13779	STAILQ_INSERT_TAIL(&thr->isc_queue, &io->io_hdr, links);
13780	mtx_unlock(&thr->queue_lock);
13781	wakeup(thr);
13782}
13783
13784/*
13785 *  vim: ts=8
13786 */
13787