2 * Copyright (c) 2003-2009 Silicon Graphics International Corp.
3 * Copyright (c) 2012 The FreeBSD Foundation
6 * Portions of this software were developed by Edward Tomasz Napierala
7 * under sponsorship from the FreeBSD Foundation.
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions, and the following disclaimer,
14 * without modification.
15 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
16 * substantially similar to the "NO WARRANTY" disclaimer below
17 * ("Disclaimer") and any redistribution must be conditioned upon
18 * including a substantially similar Disclaimer requirement for further
19 * binary redistribution.
22 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
25 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
26 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
30 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
31 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
32 * POSSIBILITY OF SUCH DAMAGES.
34 * $Id: //depot/users/kenm/FreeBSD-test2/sys/cam/ctl/ctl.c#8 $
37 * CAM Target Layer, a SCSI device emulation subsystem.
39 * Author: Ken Merry <ken@FreeBSD.org>
44 #include <sys/cdefs.h>
45 __FBSDID("$FreeBSD$");
47 #include <sys/param.h>
48 #include <sys/systm.h>
49 #include <sys/kernel.h>
50 #include <sys/types.h>
51 #include <sys/kthread.h>
53 #include <sys/fcntl.h>
55 #include <sys/module.h>
56 #include <sys/mutex.h>
57 #include <sys/condvar.h>
58 #include <sys/malloc.h>
60 #include <sys/ioccom.h>
61 #include <sys/queue.h>
64 #include <sys/endian.h>
65 #include <sys/sysctl.h>
68 #include <cam/scsi/scsi_all.h>
69 #include <cam/scsi/scsi_da.h>
70 #include <cam/ctl/ctl_io.h>
71 #include <cam/ctl/ctl.h>
72 #include <cam/ctl/ctl_frontend.h>
73 #include <cam/ctl/ctl_frontend_internal.h>
74 #include <cam/ctl/ctl_util.h>
75 #include <cam/ctl/ctl_backend.h>
76 #include <cam/ctl/ctl_ioctl.h>
77 #include <cam/ctl/ctl_ha.h>
78 #include <cam/ctl/ctl_private.h>
79 #include <cam/ctl/ctl_debug.h>
80 #include <cam/ctl/ctl_scsi_all.h>
81 #include <cam/ctl/ctl_error.h>
83 struct ctl_softc *control_softc = NULL;
86 * The default is to run with CTL_DONE_THREAD turned on. Completed
87 * transactions are queued for processing by the CTL work thread. When
88 * CTL_DONE_THREAD is not defined, completed transactions are processed in
89 * the caller's context.
91 #define CTL_DONE_THREAD
94 * Use the serial number and device ID provided by the backend, rather than
97 #define CTL_USE_BACKEND_SN
100 * Size and alignment macros needed for Copan-specific HA hardware. These
101 * can go away when the HA code is re-written, and uses busdma for any
104 #define CTL_ALIGN_8B(target, source, type) \
105 if (((uint32_t)source & 0x7) != 0) \
106 target = (type)(source + (0x8 - ((uint32_t)source & 0x7)));\
108 target = (type)source;
110 #define CTL_SIZE_8B(target, size) \
111 if ((size & 0x7) != 0) \
112 target = size + (0x8 - (size & 0x7)); \
116 #define CTL_ALIGN_8B_MARGIN 16
119 * Template mode pages.
123 * Note that these are default values only. The actual values will be
124 * filled in when the user does a mode sense.
126 static struct copan_power_subpage power_page_default = {
127 /*page_code*/ PWR_PAGE_CODE | SMPH_SPF,
128 /*subpage*/ PWR_SUBPAGE_CODE,
129 /*page_length*/ {(sizeof(struct copan_power_subpage) - 4) & 0xff00,
130 (sizeof(struct copan_power_subpage) - 4) & 0x00ff},
131 /*page_version*/ PWR_VERSION,
133 /* max_active_luns*/ PWR_DFLT_MAX_LUNS,
134 /*reserved*/ {0, 0, 0, 0, 0, 0, 0, 0, 0,
135 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
139 static struct copan_power_subpage power_page_changeable = {
140 /*page_code*/ PWR_PAGE_CODE | SMPH_SPF,
141 /*subpage*/ PWR_SUBPAGE_CODE,
142 /*page_length*/ {(sizeof(struct copan_power_subpage) - 4) & 0xff00,
143 (sizeof(struct copan_power_subpage) - 4) & 0x00ff},
146 /* max_active_luns*/ 0,
147 /*reserved*/ {0, 0, 0, 0, 0, 0, 0, 0, 0,
148 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
152 static struct copan_aps_subpage aps_page_default = {
153 APS_PAGE_CODE | SMPH_SPF, //page_code
154 APS_SUBPAGE_CODE, //subpage
155 {(sizeof(struct copan_aps_subpage) - 4) & 0xff00,
156 (sizeof(struct copan_aps_subpage) - 4) & 0x00ff}, //page_length
157 APS_VERSION, //page_version
159 {0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
160 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
161 0, 0, 0, 0, 0} //reserved
164 static struct copan_aps_subpage aps_page_changeable = {
165 APS_PAGE_CODE | SMPH_SPF, //page_code
166 APS_SUBPAGE_CODE, //subpage
167 {(sizeof(struct copan_aps_subpage) - 4) & 0xff00,
168 (sizeof(struct copan_aps_subpage) - 4) & 0x00ff}, //page_length
171 {0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
172 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
173 0, 0, 0, 0, 0} //reserved
176 static struct copan_debugconf_subpage debugconf_page_default = {
177 DBGCNF_PAGE_CODE | SMPH_SPF, /* page_code */
178 DBGCNF_SUBPAGE_CODE, /* subpage */
179 {(sizeof(struct copan_debugconf_subpage) - 4) >> 8,
180 (sizeof(struct copan_debugconf_subpage) - 4) >> 0}, /* page_length */
181 DBGCNF_VERSION, /* page_version */
182 {CTL_TIME_IO_DEFAULT_SECS>>8,
183 CTL_TIME_IO_DEFAULT_SECS>>0}, /* ctl_time_io_secs */
186 static struct copan_debugconf_subpage debugconf_page_changeable = {
187 DBGCNF_PAGE_CODE | SMPH_SPF, /* page_code */
188 DBGCNF_SUBPAGE_CODE, /* subpage */
189 {(sizeof(struct copan_debugconf_subpage) - 4) >> 8,
190 (sizeof(struct copan_debugconf_subpage) - 4) >> 0}, /* page_length */
191 0, /* page_version */
192 {0xff,0xff}, /* ctl_time_io_secs */
195 static struct scsi_format_page format_page_default = {
196 /*page_code*/SMS_FORMAT_DEVICE_PAGE,
197 /*page_length*/sizeof(struct scsi_format_page) - 2,
198 /*tracks_per_zone*/ {0, 0},
199 /*alt_sectors_per_zone*/ {0, 0},
200 /*alt_tracks_per_zone*/ {0, 0},
201 /*alt_tracks_per_lun*/ {0, 0},
202 /*sectors_per_track*/ {(CTL_DEFAULT_SECTORS_PER_TRACK >> 8) & 0xff,
203 CTL_DEFAULT_SECTORS_PER_TRACK & 0xff},
204 /*bytes_per_sector*/ {0, 0},
205 /*interleave*/ {0, 0},
206 /*track_skew*/ {0, 0},
207 /*cylinder_skew*/ {0, 0},
209 /*reserved*/ {0, 0, 0}
212 static struct scsi_format_page format_page_changeable = {
213 /*page_code*/SMS_FORMAT_DEVICE_PAGE,
214 /*page_length*/sizeof(struct scsi_format_page) - 2,
215 /*tracks_per_zone*/ {0, 0},
216 /*alt_sectors_per_zone*/ {0, 0},
217 /*alt_tracks_per_zone*/ {0, 0},
218 /*alt_tracks_per_lun*/ {0, 0},
219 /*sectors_per_track*/ {0, 0},
220 /*bytes_per_sector*/ {0, 0},
221 /*interleave*/ {0, 0},
222 /*track_skew*/ {0, 0},
223 /*cylinder_skew*/ {0, 0},
225 /*reserved*/ {0, 0, 0}
228 static struct scsi_rigid_disk_page rigid_disk_page_default = {
229 /*page_code*/SMS_RIGID_DISK_PAGE,
230 /*page_length*/sizeof(struct scsi_rigid_disk_page) - 2,
231 /*cylinders*/ {0, 0, 0},
232 /*heads*/ CTL_DEFAULT_HEADS,
233 /*start_write_precomp*/ {0, 0, 0},
234 /*start_reduced_current*/ {0, 0, 0},
235 /*step_rate*/ {0, 0},
236 /*landing_zone_cylinder*/ {0, 0, 0},
237 /*rpl*/ SRDP_RPL_DISABLED,
238 /*rotational_offset*/ 0,
240 /*rotation_rate*/ {(CTL_DEFAULT_ROTATION_RATE >> 8) & 0xff,
241 CTL_DEFAULT_ROTATION_RATE & 0xff},
245 static struct scsi_rigid_disk_page rigid_disk_page_changeable = {
246 /*page_code*/SMS_RIGID_DISK_PAGE,
247 /*page_length*/sizeof(struct scsi_rigid_disk_page) - 2,
248 /*cylinders*/ {0, 0, 0},
250 /*start_write_precomp*/ {0, 0, 0},
251 /*start_reduced_current*/ {0, 0, 0},
252 /*step_rate*/ {0, 0},
253 /*landing_zone_cylinder*/ {0, 0, 0},
255 /*rotational_offset*/ 0,
257 /*rotation_rate*/ {0, 0},
261 static struct scsi_caching_page caching_page_default = {
262 /*page_code*/SMS_CACHING_PAGE,
263 /*page_length*/sizeof(struct scsi_caching_page) - 2,
264 /*flags1*/ SCP_DISC | SCP_WCE,
266 /*disable_pf_transfer_len*/ {0xff, 0xff},
267 /*min_prefetch*/ {0, 0},
268 /*max_prefetch*/ {0xff, 0xff},
269 /*max_pf_ceiling*/ {0xff, 0xff},
271 /*cache_segments*/ 0,
272 /*cache_seg_size*/ {0, 0},
274 /*non_cache_seg_size*/ {0, 0, 0}
277 static struct scsi_caching_page caching_page_changeable = {
278 /*page_code*/SMS_CACHING_PAGE,
279 /*page_length*/sizeof(struct scsi_caching_page) - 2,
282 /*disable_pf_transfer_len*/ {0, 0},
283 /*min_prefetch*/ {0, 0},
284 /*max_prefetch*/ {0, 0},
285 /*max_pf_ceiling*/ {0, 0},
287 /*cache_segments*/ 0,
288 /*cache_seg_size*/ {0, 0},
290 /*non_cache_seg_size*/ {0, 0, 0}
293 static struct scsi_control_page control_page_default = {
294 /*page_code*/SMS_CONTROL_MODE_PAGE,
295 /*page_length*/sizeof(struct scsi_control_page) - 2,
300 /*aen_holdoff_period*/{0, 0}
303 static struct scsi_control_page control_page_changeable = {
304 /*page_code*/SMS_CONTROL_MODE_PAGE,
305 /*page_length*/sizeof(struct scsi_control_page) - 2,
310 /*aen_holdoff_period*/{0, 0}
315 * XXX KDM move these into the softc.
317 static int rcv_sync_msg;
318 static int persis_offset;
319 static uint8_t ctl_pause_rtr;
320 static int ctl_is_single = 1;
321 static int index_to_aps_page;
323 SYSCTL_NODE(_kern_cam, OID_AUTO, ctl, CTLFLAG_RD, 0, "CAM Target Layer");
324 static int worker_threads = 1;
325 TUNABLE_INT("kern.cam.ctl.worker_threads", &worker_threads);
326 SYSCTL_INT(_kern_cam_ctl, OID_AUTO, worker_threads, CTLFLAG_RDTUN,
327 &worker_threads, 1, "Number of worker threads");
328 static int verbose = 0;
329 TUNABLE_INT("kern.cam.ctl.verbose", &verbose);
330 SYSCTL_INT(_kern_cam_ctl, OID_AUTO, verbose, CTLFLAG_RWTUN,
331 &verbose, 0, "Show SCSI errors returned to initiator");
334 * Serial number (0x80), device id (0x83), supported pages (0x00),
335 * Block limits (0xB0) and Logical Block Provisioning (0xB2)
337 #define SCSI_EVPD_NUM_SUPPORTED_PAGES 5
339 static void ctl_isc_event_handler(ctl_ha_channel chanel, ctl_ha_event event,
341 static void ctl_copy_sense_data(union ctl_ha_msg *src, union ctl_io *dest);
342 static int ctl_init(void);
343 void ctl_shutdown(void);
344 static int ctl_open(struct cdev *dev, int flags, int fmt, struct thread *td);
345 static int ctl_close(struct cdev *dev, int flags, int fmt, struct thread *td);
346 static void ctl_ioctl_online(void *arg);
347 static void ctl_ioctl_offline(void *arg);
348 static int ctl_ioctl_targ_enable(void *arg, struct ctl_id targ_id);
349 static int ctl_ioctl_targ_disable(void *arg, struct ctl_id targ_id);
350 static int ctl_ioctl_lun_enable(void *arg, struct ctl_id targ_id, int lun_id);
351 static int ctl_ioctl_lun_disable(void *arg, struct ctl_id targ_id, int lun_id);
352 static int ctl_ioctl_do_datamove(struct ctl_scsiio *ctsio);
353 static int ctl_serialize_other_sc_cmd(struct ctl_scsiio *ctsio, int have_lock);
354 static int ctl_ioctl_submit_wait(union ctl_io *io);
355 static void ctl_ioctl_datamove(union ctl_io *io);
356 static void ctl_ioctl_done(union ctl_io *io);
357 static void ctl_ioctl_hard_startstop_callback(void *arg,
358 struct cfi_metatask *metatask);
359 static void ctl_ioctl_bbrread_callback(void *arg,struct cfi_metatask *metatask);
360 static int ctl_ioctl_fill_ooa(struct ctl_lun *lun, uint32_t *cur_fill_num,
361 struct ctl_ooa *ooa_hdr,
362 struct ctl_ooa_entry *kern_entries);
363 static int ctl_ioctl(struct cdev *dev, u_long cmd, caddr_t addr, int flag,
365 uint32_t ctl_get_resindex(struct ctl_nexus *nexus);
366 uint32_t ctl_port_idx(int port_num);
368 static union ctl_io *ctl_malloc_io(ctl_io_type io_type, uint32_t targ_port,
369 uint32_t targ_target, uint32_t targ_lun,
371 static void ctl_kfree_io(union ctl_io *io);
373 static int ctl_alloc_lun(struct ctl_softc *ctl_softc, struct ctl_lun *lun,
374 struct ctl_be_lun *be_lun, struct ctl_id target_id);
375 static int ctl_free_lun(struct ctl_lun *lun);
376 static void ctl_create_lun(struct ctl_be_lun *be_lun);
378 static void ctl_failover_change_pages(struct ctl_softc *softc,
379 struct ctl_scsiio *ctsio, int master);
382 static int ctl_do_mode_select(union ctl_io *io);
383 static int ctl_pro_preempt(struct ctl_softc *softc, struct ctl_lun *lun,
384 uint64_t res_key, uint64_t sa_res_key,
385 uint8_t type, uint32_t residx,
386 struct ctl_scsiio *ctsio,
387 struct scsi_per_res_out *cdb,
388 struct scsi_per_res_out_parms* param);
389 static void ctl_pro_preempt_other(struct ctl_lun *lun,
390 union ctl_ha_msg *msg);
391 static void ctl_hndl_per_res_out_on_other_sc(union ctl_ha_msg *msg);
392 static int ctl_inquiry_evpd_supported(struct ctl_scsiio *ctsio, int alloc_len);
393 static int ctl_inquiry_evpd_serial(struct ctl_scsiio *ctsio, int alloc_len);
394 static int ctl_inquiry_evpd_devid(struct ctl_scsiio *ctsio, int alloc_len);
395 static int ctl_inquiry_evpd_block_limits(struct ctl_scsiio *ctsio,
397 static int ctl_inquiry_evpd_lbp(struct ctl_scsiio *ctsio, int alloc_len);
398 static int ctl_inquiry_evpd(struct ctl_scsiio *ctsio);
399 static int ctl_inquiry_std(struct ctl_scsiio *ctsio);
400 static int ctl_get_lba_len(union ctl_io *io, uint64_t *lba, uint32_t *len);
401 static ctl_action ctl_extent_check(union ctl_io *io1, union ctl_io *io2);
402 static ctl_action ctl_check_for_blockage(union ctl_io *pending_io,
403 union ctl_io *ooa_io);
404 static ctl_action ctl_check_ooa(struct ctl_lun *lun, union ctl_io *pending_io,
405 union ctl_io *starting_io);
406 static int ctl_check_blocked(struct ctl_lun *lun);
407 static int ctl_scsiio_lun_check(struct ctl_softc *ctl_softc,
409 struct ctl_cmd_entry *entry,
410 struct ctl_scsiio *ctsio);
411 //static int ctl_check_rtr(union ctl_io *pending_io, struct ctl_softc *softc);
412 static void ctl_failover(void);
413 static int ctl_scsiio_precheck(struct ctl_softc *ctl_softc,
414 struct ctl_scsiio *ctsio);
415 static int ctl_scsiio(struct ctl_scsiio *ctsio);
417 static int ctl_bus_reset(struct ctl_softc *ctl_softc, union ctl_io *io);
418 static int ctl_target_reset(struct ctl_softc *ctl_softc, union ctl_io *io,
419 ctl_ua_type ua_type);
420 static int ctl_lun_reset(struct ctl_lun *lun, union ctl_io *io,
421 ctl_ua_type ua_type);
422 static int ctl_abort_task(union ctl_io *io);
423 static void ctl_run_task_queue(struct ctl_softc *ctl_softc);
425 static void ctl_datamove_timer_wakeup(void *arg);
426 static void ctl_done_timer_wakeup(void *arg);
427 #endif /* CTL_IO_DELAY */
429 static void ctl_send_datamove_done(union ctl_io *io, int have_lock);
430 static void ctl_datamove_remote_write_cb(struct ctl_ha_dt_req *rq);
431 static int ctl_datamove_remote_dm_write_cb(union ctl_io *io);
432 static void ctl_datamove_remote_write(union ctl_io *io);
433 static int ctl_datamove_remote_dm_read_cb(union ctl_io *io);
434 static void ctl_datamove_remote_read_cb(struct ctl_ha_dt_req *rq);
435 static int ctl_datamove_remote_sgl_setup(union ctl_io *io);
436 static int ctl_datamove_remote_xfer(union ctl_io *io, unsigned command,
437 ctl_ha_dt_cb callback);
438 static void ctl_datamove_remote_read(union ctl_io *io);
439 static void ctl_datamove_remote(union ctl_io *io);
440 static int ctl_process_done(union ctl_io *io, int have_lock);
441 static void ctl_work_thread(void *arg);
444 * Load the serialization table. This isn't very pretty, but is probably
445 * the easiest way to do it.
447 #include "ctl_ser_table.c"
450 * We only need to define open, close and ioctl routines for this driver.
452 static struct cdevsw ctl_cdevsw = {
453 .d_version = D_VERSION,
456 .d_close = ctl_close,
457 .d_ioctl = ctl_ioctl,
462 MALLOC_DEFINE(M_CTL, "ctlmem", "Memory used for CTL");
464 static int ctl_module_event_handler(module_t, int /*modeventtype_t*/, void *);
466 static moduledata_t ctl_moduledata = {
468 ctl_module_event_handler,
472 DECLARE_MODULE(ctl, ctl_moduledata, SI_SUB_CONFIGURE, SI_ORDER_THIRD);
473 MODULE_VERSION(ctl, 1);
476 ctl_isc_handler_finish_xfer(struct ctl_softc *ctl_softc,
477 union ctl_ha_msg *msg_info)
479 struct ctl_scsiio *ctsio;
481 if (msg_info->hdr.original_sc == NULL) {
482 printf("%s: original_sc == NULL!\n", __func__);
483 /* XXX KDM now what? */
487 ctsio = &msg_info->hdr.original_sc->scsiio;
488 ctsio->io_hdr.flags |= CTL_FLAG_IO_ACTIVE;
489 ctsio->io_hdr.msg_type = CTL_MSG_FINISH_IO;
490 ctsio->io_hdr.status = msg_info->hdr.status;
491 ctsio->scsi_status = msg_info->scsi.scsi_status;
492 ctsio->sense_len = msg_info->scsi.sense_len;
493 ctsio->sense_residual = msg_info->scsi.sense_residual;
494 ctsio->residual = msg_info->scsi.residual;
495 memcpy(&ctsio->sense_data, &msg_info->scsi.sense_data,
496 sizeof(ctsio->sense_data));
497 memcpy(&ctsio->io_hdr.ctl_private[CTL_PRIV_LBA_LEN].bytes,
498 &msg_info->scsi.lbalen, sizeof(msg_info->scsi.lbalen));
499 STAILQ_INSERT_TAIL(&ctl_softc->isc_queue, &ctsio->io_hdr, links);
504 ctl_isc_handler_finish_ser_only(struct ctl_softc *ctl_softc,
505 union ctl_ha_msg *msg_info)
507 struct ctl_scsiio *ctsio;
509 if (msg_info->hdr.serializing_sc == NULL) {
510 printf("%s: serializing_sc == NULL!\n", __func__);
511 /* XXX KDM now what? */
515 ctsio = &msg_info->hdr.serializing_sc->scsiio;
518 * Attempt to catch the situation where an I/O has
519 * been freed, and we're using it again.
521 if (ctsio->io_hdr.io_type == 0xff) {
522 union ctl_io *tmp_io;
523 tmp_io = (union ctl_io *)ctsio;
524 printf("%s: %p use after free!\n", __func__,
526 printf("%s: type %d msg %d cdb %x iptl: "
527 "%d:%d:%d:%d tag 0x%04x "
528 "flag %#x status %x\n",
530 tmp_io->io_hdr.io_type,
531 tmp_io->io_hdr.msg_type,
532 tmp_io->scsiio.cdb[0],
533 tmp_io->io_hdr.nexus.initid.id,
534 tmp_io->io_hdr.nexus.targ_port,
535 tmp_io->io_hdr.nexus.targ_target.id,
536 tmp_io->io_hdr.nexus.targ_lun,
537 (tmp_io->io_hdr.io_type ==
539 tmp_io->taskio.tag_num :
540 tmp_io->scsiio.tag_num,
541 tmp_io->io_hdr.flags,
542 tmp_io->io_hdr.status);
545 ctsio->io_hdr.msg_type = CTL_MSG_FINISH_IO;
546 STAILQ_INSERT_TAIL(&ctl_softc->isc_queue, &ctsio->io_hdr, links);
551 * ISC (Inter Shelf Communication) event handler. Events from the HA
552 * subsystem come in here.
555 ctl_isc_event_handler(ctl_ha_channel channel, ctl_ha_event event, int param)
557 struct ctl_softc *ctl_softc;
559 struct ctl_prio *presio;
560 ctl_ha_status isc_status;
562 ctl_softc = control_softc;
567 printf("CTL: Isc Msg event %d\n", event);
569 if (event == CTL_HA_EVT_MSG_RECV) {
570 union ctl_ha_msg msg_info;
572 isc_status = ctl_ha_msg_recv(CTL_HA_CHAN_CTL, &msg_info,
573 sizeof(msg_info), /*wait*/ 0);
575 printf("CTL: msg_type %d\n", msg_info.msg_type);
577 if (isc_status != 0) {
578 printf("Error receiving message, status = %d\n",
582 mtx_lock(&ctl_softc->ctl_lock);
584 switch (msg_info.hdr.msg_type) {
585 case CTL_MSG_SERIALIZE:
587 printf("Serialize\n");
589 io = ctl_alloc_io((void *)ctl_softc->othersc_pool);
591 printf("ctl_isc_event_handler: can't allocate "
594 /* Need to set busy and send msg back */
595 mtx_unlock(&ctl_softc->ctl_lock);
596 msg_info.hdr.msg_type = CTL_MSG_BAD_JUJU;
597 msg_info.hdr.status = CTL_SCSI_ERROR;
598 msg_info.scsi.scsi_status = SCSI_STATUS_BUSY;
599 msg_info.scsi.sense_len = 0;
600 if (ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg_info,
601 sizeof(msg_info), 0) > CTL_HA_STATUS_SUCCESS){
606 // populate ctsio from msg_info
607 io->io_hdr.io_type = CTL_IO_SCSI;
608 io->io_hdr.msg_type = CTL_MSG_SERIALIZE;
609 io->io_hdr.original_sc = msg_info.hdr.original_sc;
611 printf("pOrig %x\n", (int)msg_info.original_sc);
613 io->io_hdr.flags |= CTL_FLAG_FROM_OTHER_SC |
616 * If we're in serialization-only mode, we don't
617 * want to go through full done processing. Thus
620 * XXX KDM add another flag that is more specific.
622 if (ctl_softc->ha_mode == CTL_HA_MODE_SER_ONLY)
623 io->io_hdr.flags |= CTL_FLAG_INT_COPY;
624 io->io_hdr.nexus = msg_info.hdr.nexus;
626 printf("targ %d, port %d, iid %d, lun %d\n",
627 io->io_hdr.nexus.targ_target.id,
628 io->io_hdr.nexus.targ_port,
629 io->io_hdr.nexus.initid.id,
630 io->io_hdr.nexus.targ_lun);
632 io->scsiio.tag_num = msg_info.scsi.tag_num;
633 io->scsiio.tag_type = msg_info.scsi.tag_type;
634 memcpy(io->scsiio.cdb, msg_info.scsi.cdb,
636 if (ctl_softc->ha_mode == CTL_HA_MODE_XFER) {
637 struct ctl_cmd_entry *entry;
640 opcode = io->scsiio.cdb[0];
641 entry = &ctl_cmd_table[opcode];
642 io->io_hdr.flags &= ~CTL_FLAG_DATA_MASK;
644 entry->flags & CTL_FLAG_DATA_MASK;
646 STAILQ_INSERT_TAIL(&ctl_softc->isc_queue,
651 /* Performed on the Originating SC, XFER mode only */
652 case CTL_MSG_DATAMOVE: {
653 struct ctl_sg_entry *sgl;
656 io = msg_info.hdr.original_sc;
658 printf("%s: original_sc == NULL!\n", __func__);
659 /* XXX KDM do something here */
662 io->io_hdr.msg_type = CTL_MSG_DATAMOVE;
663 io->io_hdr.flags |= CTL_FLAG_IO_ACTIVE;
665 * Keep track of this, we need to send it back over
666 * when the datamove is complete.
668 io->io_hdr.serializing_sc = msg_info.hdr.serializing_sc;
670 if (msg_info.dt.sg_sequence == 0) {
672 * XXX KDM we use the preallocated S/G list
673 * here, but we'll need to change this to
674 * dynamic allocation if we need larger S/G
677 if (msg_info.dt.kern_sg_entries >
678 sizeof(io->io_hdr.remote_sglist) /
679 sizeof(io->io_hdr.remote_sglist[0])) {
680 printf("%s: number of S/G entries "
681 "needed %u > allocated num %zd\n",
683 msg_info.dt.kern_sg_entries,
684 sizeof(io->io_hdr.remote_sglist)/
685 sizeof(io->io_hdr.remote_sglist[0]));
688 * XXX KDM send a message back to
689 * the other side to shut down the
690 * DMA. The error will come back
691 * through via the normal channel.
695 sgl = io->io_hdr.remote_sglist;
697 sizeof(io->io_hdr.remote_sglist));
699 io->scsiio.kern_data_ptr = (uint8_t *)sgl;
701 io->scsiio.kern_sg_entries =
702 msg_info.dt.kern_sg_entries;
703 io->scsiio.rem_sg_entries =
704 msg_info.dt.kern_sg_entries;
705 io->scsiio.kern_data_len =
706 msg_info.dt.kern_data_len;
707 io->scsiio.kern_total_len =
708 msg_info.dt.kern_total_len;
709 io->scsiio.kern_data_resid =
710 msg_info.dt.kern_data_resid;
711 io->scsiio.kern_rel_offset =
712 msg_info.dt.kern_rel_offset;
714 * Clear out per-DMA flags.
716 io->io_hdr.flags &= ~CTL_FLAG_RDMA_MASK;
718 * Add per-DMA flags that are set for this
719 * particular DMA request.
721 io->io_hdr.flags |= msg_info.dt.flags &
724 sgl = (struct ctl_sg_entry *)
725 io->scsiio.kern_data_ptr;
727 for (i = msg_info.dt.sent_sg_entries, j = 0;
728 i < (msg_info.dt.sent_sg_entries +
729 msg_info.dt.cur_sg_entries); i++, j++) {
730 sgl[i].addr = msg_info.dt.sg_list[j].addr;
731 sgl[i].len = msg_info.dt.sg_list[j].len;
734 printf("%s: L: %p,%d -> %p,%d j=%d, i=%d\n",
736 msg_info.dt.sg_list[j].addr,
737 msg_info.dt.sg_list[j].len,
738 sgl[i].addr, sgl[i].len, j, i);
742 memcpy(&sgl[msg_info.dt.sent_sg_entries],
744 sizeof(*sgl) * msg_info.dt.cur_sg_entries);
748 * If this is the last piece of the I/O, we've got
749 * the full S/G list. Queue processing in the thread.
750 * Otherwise wait for the next piece.
752 if (msg_info.dt.sg_last != 0) {
753 STAILQ_INSERT_TAIL(&ctl_softc->isc_queue,
759 /* Performed on the Serializing (primary) SC, XFER mode only */
760 case CTL_MSG_DATAMOVE_DONE: {
761 if (msg_info.hdr.serializing_sc == NULL) {
762 printf("%s: serializing_sc == NULL!\n",
764 /* XXX KDM now what? */
768 * We grab the sense information here in case
769 * there was a failure, so we can return status
770 * back to the initiator.
772 io = msg_info.hdr.serializing_sc;
773 io->io_hdr.msg_type = CTL_MSG_DATAMOVE_DONE;
774 io->io_hdr.status = msg_info.hdr.status;
775 io->scsiio.scsi_status = msg_info.scsi.scsi_status;
776 io->scsiio.sense_len = msg_info.scsi.sense_len;
777 io->scsiio.sense_residual =msg_info.scsi.sense_residual;
778 io->io_hdr.port_status = msg_info.scsi.fetd_status;
779 io->scsiio.residual = msg_info.scsi.residual;
780 memcpy(&io->scsiio.sense_data,&msg_info.scsi.sense_data,
781 sizeof(io->scsiio.sense_data));
783 STAILQ_INSERT_TAIL(&ctl_softc->isc_queue,
789 /* Preformed on Originating SC, SER_ONLY mode */
791 io = msg_info.hdr.original_sc;
793 printf("%s: Major Bummer\n", __func__);
794 mtx_unlock(&ctl_softc->ctl_lock);
798 printf("pOrig %x\n",(int) ctsio);
801 io->io_hdr.msg_type = CTL_MSG_R2R;
802 io->io_hdr.serializing_sc = msg_info.hdr.serializing_sc;
803 STAILQ_INSERT_TAIL(&ctl_softc->isc_queue,
809 * Performed on Serializing(i.e. primary SC) SC in SER_ONLY
811 * Performed on the Originating (i.e. secondary) SC in XFER
814 case CTL_MSG_FINISH_IO:
815 if (ctl_softc->ha_mode == CTL_HA_MODE_XFER)
816 ctl_isc_handler_finish_xfer(ctl_softc,
819 ctl_isc_handler_finish_ser_only(ctl_softc,
823 /* Preformed on Originating SC */
824 case CTL_MSG_BAD_JUJU:
825 io = msg_info.hdr.original_sc;
827 printf("%s: Bad JUJU!, original_sc is NULL!\n",
831 ctl_copy_sense_data(&msg_info, io);
833 * IO should have already been cleaned up on other
834 * SC so clear this flag so we won't send a message
835 * back to finish the IO there.
837 io->io_hdr.flags &= ~CTL_FLAG_SENT_2OTHER_SC;
838 io->io_hdr.flags |= CTL_FLAG_IO_ACTIVE;
840 /* io = msg_info.hdr.serializing_sc; */
841 io->io_hdr.msg_type = CTL_MSG_BAD_JUJU;
842 STAILQ_INSERT_TAIL(&ctl_softc->isc_queue,
847 /* Handle resets sent from the other side */
848 case CTL_MSG_MANAGE_TASKS: {
849 struct ctl_taskio *taskio;
850 taskio = (struct ctl_taskio *)ctl_alloc_io(
851 (void *)ctl_softc->othersc_pool);
852 if (taskio == NULL) {
853 printf("ctl_isc_event_handler: can't allocate "
856 /* should I just call the proper reset func
858 mtx_unlock(&ctl_softc->ctl_lock);
861 ctl_zero_io((union ctl_io *)taskio);
862 taskio->io_hdr.io_type = CTL_IO_TASK;
863 taskio->io_hdr.flags |= CTL_FLAG_FROM_OTHER_SC;
864 taskio->io_hdr.nexus = msg_info.hdr.nexus;
865 taskio->task_action = msg_info.task.task_action;
866 taskio->tag_num = msg_info.task.tag_num;
867 taskio->tag_type = msg_info.task.tag_type;
869 taskio->io_hdr.start_time = time_uptime;
870 getbintime(&taskio->io_hdr.start_bt);
872 cs_prof_gettime(&taskio->io_hdr.start_ticks);
874 #endif /* CTL_TIME_IO */
875 STAILQ_INSERT_TAIL(&ctl_softc->task_queue,
876 &taskio->io_hdr, links);
877 ctl_softc->flags |= CTL_FLAG_TASK_PENDING;
881 /* Persistent Reserve action which needs attention */
882 case CTL_MSG_PERS_ACTION:
883 presio = (struct ctl_prio *)ctl_alloc_io(
884 (void *)ctl_softc->othersc_pool);
885 if (presio == NULL) {
886 printf("ctl_isc_event_handler: can't allocate "
889 /* Need to set busy and send msg back */
890 mtx_unlock(&ctl_softc->ctl_lock);
893 ctl_zero_io((union ctl_io *)presio);
894 presio->io_hdr.msg_type = CTL_MSG_PERS_ACTION;
895 presio->pr_msg = msg_info.pr;
896 STAILQ_INSERT_TAIL(&ctl_softc->isc_queue,
897 &presio->io_hdr, links);
900 case CTL_MSG_SYNC_FE:
903 case CTL_MSG_APS_LOCK: {
904 // It's quicker to execute this then to
907 struct ctl_page_index *page_index;
908 struct copan_aps_subpage *current_sp;
911 targ_lun = msg_info.hdr.nexus.targ_lun;
912 if (msg_info.hdr.nexus.lun_map_fn != NULL)
913 targ_lun = msg_info.hdr.nexus.lun_map_fn(msg_info.hdr.nexus.lun_map_arg, targ_lun);
915 lun = ctl_softc->ctl_luns[targ_lun];
916 page_index = &lun->mode_pages.index[index_to_aps_page];
917 current_sp = (struct copan_aps_subpage *)
918 (page_index->page_data +
919 (page_index->page_len * CTL_PAGE_CURRENT));
921 current_sp->lock_active = msg_info.aps.lock_flag;
925 printf("How did I get here?\n");
927 mtx_unlock(&ctl_softc->ctl_lock);
928 } else if (event == CTL_HA_EVT_MSG_SENT) {
929 if (param != CTL_HA_STATUS_SUCCESS) {
930 printf("Bad status from ctl_ha_msg_send status %d\n",
934 } else if (event == CTL_HA_EVT_DISCONNECT) {
935 printf("CTL: Got a disconnect from Isc\n");
938 printf("ctl_isc_event_handler: Unknown event %d\n", event);
947 ctl_copy_sense_data(union ctl_ha_msg *src, union ctl_io *dest)
949 struct scsi_sense_data *sense;
951 sense = &dest->scsiio.sense_data;
952 bcopy(&src->scsi.sense_data, sense, sizeof(*sense));
953 dest->scsiio.scsi_status = src->scsi.scsi_status;
954 dest->scsiio.sense_len = src->scsi.sense_len;
955 dest->io_hdr.status = src->hdr.status;
961 struct ctl_softc *softc;
962 struct ctl_io_pool *internal_pool, *emergency_pool, *other_pool;
963 struct ctl_frontend *fe;
965 int i, error, retval;
972 control_softc = malloc(sizeof(*control_softc), M_DEVBUF,
974 softc = control_softc;
976 softc->dev = make_dev(&ctl_cdevsw, 0, UID_ROOT, GID_OPERATOR, 0600,
979 softc->dev->si_drv1 = softc;
982 * By default, return a "bad LUN" peripheral qualifier for unknown
983 * LUNs. The user can override this default using the tunable or
984 * sysctl. See the comment in ctl_inquiry_std() for more details.
986 softc->inquiry_pq_no_lun = 1;
987 TUNABLE_INT_FETCH("kern.cam.ctl.inquiry_pq_no_lun",
988 &softc->inquiry_pq_no_lun);
989 sysctl_ctx_init(&softc->sysctl_ctx);
990 softc->sysctl_tree = SYSCTL_ADD_NODE(&softc->sysctl_ctx,
991 SYSCTL_STATIC_CHILDREN(_kern_cam), OID_AUTO, "ctl",
992 CTLFLAG_RD, 0, "CAM Target Layer");
994 if (softc->sysctl_tree == NULL) {
995 printf("%s: unable to allocate sysctl tree\n", __func__);
996 destroy_dev(softc->dev);
997 free(control_softc, M_DEVBUF);
998 control_softc = NULL;
1002 SYSCTL_ADD_INT(&softc->sysctl_ctx,
1003 SYSCTL_CHILDREN(softc->sysctl_tree), OID_AUTO,
1004 "inquiry_pq_no_lun", CTLFLAG_RW,
1005 &softc->inquiry_pq_no_lun, 0,
1006 "Report no lun possible for invalid LUNs");
1008 mtx_init(&softc->ctl_lock, "CTL mutex", NULL, MTX_DEF);
1009 mtx_init(&softc->pool_lock, "CTL pool mutex", NULL, MTX_DEF);
1010 softc->open_count = 0;
1013 * Default to actually sending a SYNCHRONIZE CACHE command down to
1016 softc->flags = CTL_FLAG_REAL_SYNC;
1019 * In Copan's HA scheme, the "master" and "slave" roles are
1020 * figured out through the slot the controller is in. Although it
1021 * is an active/active system, someone has to be in charge.
1024 scmicro_rw(SCMICRO_GET_SHELF_ID, &sc_id);
1028 softc->flags |= CTL_FLAG_MASTER_SHELF;
1031 persis_offset = CTL_MAX_INITIATORS;
1034 * XXX KDM need to figure out where we want to get our target ID
1035 * and WWID. Is it different on each port?
1037 softc->target.id = 0;
1038 softc->target.wwid[0] = 0x12345678;
1039 softc->target.wwid[1] = 0x87654321;
1040 STAILQ_INIT(&softc->lun_list);
1041 STAILQ_INIT(&softc->pending_lun_queue);
1042 STAILQ_INIT(&softc->task_queue);
1043 STAILQ_INIT(&softc->incoming_queue);
1044 STAILQ_INIT(&softc->rtr_queue);
1045 STAILQ_INIT(&softc->done_queue);
1046 STAILQ_INIT(&softc->isc_queue);
1047 STAILQ_INIT(&softc->fe_list);
1048 STAILQ_INIT(&softc->be_list);
1049 STAILQ_INIT(&softc->io_pools);
1052 * We don't bother calling these with ctl_lock held here, because,
1053 * in theory, no one else can try to do anything while we're in our
1054 * module init routine.
1056 if (ctl_pool_create(softc, CTL_POOL_INTERNAL, CTL_POOL_ENTRIES_INTERNAL,
1057 &internal_pool)!= 0){
1058 printf("ctl: can't allocate %d entry internal pool, "
1059 "exiting\n", CTL_POOL_ENTRIES_INTERNAL);
1063 if (ctl_pool_create(softc, CTL_POOL_EMERGENCY,
1064 CTL_POOL_ENTRIES_EMERGENCY, &emergency_pool) != 0) {
1065 printf("ctl: can't allocate %d entry emergency pool, "
1066 "exiting\n", CTL_POOL_ENTRIES_EMERGENCY);
1067 ctl_pool_free(internal_pool);
1071 if (ctl_pool_create(softc, CTL_POOL_4OTHERSC, CTL_POOL_ENTRIES_OTHER_SC,
1074 printf("ctl: can't allocate %d entry other SC pool, "
1075 "exiting\n", CTL_POOL_ENTRIES_OTHER_SC);
1076 ctl_pool_free(internal_pool);
1077 ctl_pool_free(emergency_pool);
1081 softc->internal_pool = internal_pool;
1082 softc->emergency_pool = emergency_pool;
1083 softc->othersc_pool = other_pool;
1085 if (worker_threads > MAXCPU || worker_threads == 0) {
1086 printf("invalid kern.cam.ctl.worker_threads value; "
1089 } else if (worker_threads < 0) {
1092 * Using more than two worker threads actually hurts
1093 * performance due to lock contention.
1101 for (i = 0; i < worker_threads; i++) {
1102 error = kproc_kthread_add(ctl_work_thread, softc,
1103 &softc->work_thread, NULL, 0, 0, "ctl", "work%d", i);
1105 printf("error creating CTL work thread!\n");
1106 ctl_pool_free(internal_pool);
1107 ctl_pool_free(emergency_pool);
1108 ctl_pool_free(other_pool);
1113 printf("ctl: CAM Target Layer loaded\n");
1116 * Initialize the initiator and portname mappings
1118 memset(softc->wwpn_iid, 0, sizeof(softc->wwpn_iid));
1121 * Initialize the ioctl front end.
1123 fe = &softc->ioctl_info.fe;
1124 sprintf(softc->ioctl_info.port_name, "CTL ioctl");
1125 fe->port_type = CTL_PORT_IOCTL;
1126 fe->num_requested_ctl_io = 100;
1127 fe->port_name = softc->ioctl_info.port_name;
1128 fe->port_online = ctl_ioctl_online;
1129 fe->port_offline = ctl_ioctl_offline;
1130 fe->onoff_arg = &softc->ioctl_info;
1131 fe->targ_enable = ctl_ioctl_targ_enable;
1132 fe->targ_disable = ctl_ioctl_targ_disable;
1133 fe->lun_enable = ctl_ioctl_lun_enable;
1134 fe->lun_disable = ctl_ioctl_lun_disable;
1135 fe->targ_lun_arg = &softc->ioctl_info;
1136 fe->fe_datamove = ctl_ioctl_datamove;
1137 fe->fe_done = ctl_ioctl_done;
1138 fe->max_targets = 15;
1139 fe->max_target_id = 15;
1141 if (ctl_frontend_register(&softc->ioctl_info.fe,
1142 (softc->flags & CTL_FLAG_MASTER_SHELF)) != 0) {
1143 printf("ctl: ioctl front end registration failed, will "
1144 "continue anyway\n");
1148 if (sizeof(struct callout) > CTL_TIMER_BYTES) {
1149 printf("sizeof(struct callout) %zd > CTL_TIMER_BYTES %zd\n",
1150 sizeof(struct callout), CTL_TIMER_BYTES);
1153 #endif /* CTL_IO_DELAY */
1161 struct ctl_softc *softc;
1162 struct ctl_lun *lun, *next_lun;
1163 struct ctl_io_pool *pool;
1165 softc = (struct ctl_softc *)control_softc;
1167 if (ctl_frontend_deregister(&softc->ioctl_info.fe) != 0)
1168 printf("ctl: ioctl front end deregistration failed\n");
1170 mtx_lock(&softc->ctl_lock);
1175 for (lun = STAILQ_FIRST(&softc->lun_list); lun != NULL; lun = next_lun){
1176 next_lun = STAILQ_NEXT(lun, links);
1180 mtx_unlock(&softc->ctl_lock);
1183 * This will rip the rug out from under any FETDs or anyone else
1184 * that has a pool allocated. Since we increment our module
1185 * refcount any time someone outside the main CTL module allocates
1186 * a pool, we shouldn't have any problems here. The user won't be
1187 * able to unload the CTL module until client modules have
1188 * successfully unloaded.
1190 while ((pool = STAILQ_FIRST(&softc->io_pools)) != NULL)
1191 ctl_pool_free(pool);
1194 ctl_shutdown_thread(softc->work_thread);
1197 mtx_destroy(&softc->pool_lock);
1198 mtx_destroy(&softc->ctl_lock);
1200 destroy_dev(softc->dev);
1202 sysctl_ctx_free(&softc->sysctl_ctx);
1204 free(control_softc, M_DEVBUF);
1205 control_softc = NULL;
1208 printf("ctl: CAM Target Layer unloaded\n");
1212 ctl_module_event_handler(module_t mod, int what, void *arg)
1217 return (ctl_init());
1221 return (EOPNOTSUPP);
1226 * XXX KDM should we do some access checks here? Bump a reference count to
1227 * prevent a CTL module from being unloaded while someone has it open?
1230 ctl_open(struct cdev *dev, int flags, int fmt, struct thread *td)
1236 ctl_close(struct cdev *dev, int flags, int fmt, struct thread *td)
1242 ctl_port_enable(ctl_port_type port_type)
1244 struct ctl_softc *softc;
1245 struct ctl_frontend *fe;
1247 if (ctl_is_single == 0) {
1248 union ctl_ha_msg msg_info;
1252 printf("%s: HA mode, synchronizing frontend enable\n",
1255 msg_info.hdr.msg_type = CTL_MSG_SYNC_FE;
1256 if ((isc_retval=ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg_info,
1257 sizeof(msg_info), 1 )) > CTL_HA_STATUS_SUCCESS) {
1258 printf("Sync msg send error retval %d\n", isc_retval);
1260 if (!rcv_sync_msg) {
1261 isc_retval=ctl_ha_msg_recv(CTL_HA_CHAN_CTL, &msg_info,
1262 sizeof(msg_info), 1);
1265 printf("CTL:Frontend Enable\n");
1267 printf("%s: single mode, skipping frontend synchronization\n",
1272 softc = control_softc;
1274 STAILQ_FOREACH(fe, &softc->fe_list, links) {
1275 if (port_type & fe->port_type)
1278 printf("port %d\n", fe->targ_port);
1280 ctl_frontend_online(fe);
1288 ctl_port_disable(ctl_port_type port_type)
1290 struct ctl_softc *softc;
1291 struct ctl_frontend *fe;
1293 softc = control_softc;
1295 STAILQ_FOREACH(fe, &softc->fe_list, links) {
1296 if (port_type & fe->port_type)
1297 ctl_frontend_offline(fe);
1304 * Returns 0 for success, 1 for failure.
1305 * Currently the only failure mode is if there aren't enough entries
1306 * allocated. So, in case of a failure, look at num_entries_dropped,
1307 * reallocate and try again.
1310 ctl_port_list(struct ctl_port_entry *entries, int num_entries_alloced,
1311 int *num_entries_filled, int *num_entries_dropped,
1312 ctl_port_type port_type, int no_virtual)
1314 struct ctl_softc *softc;
1315 struct ctl_frontend *fe;
1316 int entries_dropped, entries_filled;
1320 softc = control_softc;
1324 entries_dropped = 0;
1327 mtx_lock(&softc->ctl_lock);
1328 STAILQ_FOREACH(fe, &softc->fe_list, links) {
1329 struct ctl_port_entry *entry;
1331 if ((fe->port_type & port_type) == 0)
1334 if ((no_virtual != 0)
1335 && (fe->virtual_port != 0))
1338 if (entries_filled >= num_entries_alloced) {
1342 entry = &entries[i];
1344 entry->port_type = fe->port_type;
1345 strlcpy(entry->port_name, fe->port_name,
1346 sizeof(entry->port_name));
1347 entry->physical_port = fe->physical_port;
1348 entry->virtual_port = fe->virtual_port;
1349 entry->wwnn = fe->wwnn;
1350 entry->wwpn = fe->wwpn;
1356 mtx_unlock(&softc->ctl_lock);
1358 if (entries_dropped > 0)
1361 *num_entries_dropped = entries_dropped;
1362 *num_entries_filled = entries_filled;
1368 ctl_ioctl_online(void *arg)
1370 struct ctl_ioctl_info *ioctl_info;
1372 ioctl_info = (struct ctl_ioctl_info *)arg;
1374 ioctl_info->flags |= CTL_IOCTL_FLAG_ENABLED;
1378 ctl_ioctl_offline(void *arg)
1380 struct ctl_ioctl_info *ioctl_info;
1382 ioctl_info = (struct ctl_ioctl_info *)arg;
1384 ioctl_info->flags &= ~CTL_IOCTL_FLAG_ENABLED;
1388 * Remove an initiator by port number and initiator ID.
1389 * Returns 0 for success, 1 for failure.
1392 ctl_remove_initiator(int32_t targ_port, uint32_t iid)
1394 struct ctl_softc *softc;
1396 softc = control_softc;
1398 mtx_assert(&softc->ctl_lock, MA_NOTOWNED);
1401 || (targ_port > CTL_MAX_PORTS)) {
1402 printf("%s: invalid port number %d\n", __func__, targ_port);
1405 if (iid > CTL_MAX_INIT_PER_PORT) {
1406 printf("%s: initiator ID %u > maximun %u!\n",
1407 __func__, iid, CTL_MAX_INIT_PER_PORT);
1411 mtx_lock(&softc->ctl_lock);
1413 softc->wwpn_iid[targ_port][iid].in_use = 0;
1415 mtx_unlock(&softc->ctl_lock);
1421 * Add an initiator to the initiator map.
1422 * Returns 0 for success, 1 for failure.
1425 ctl_add_initiator(uint64_t wwpn, int32_t targ_port, uint32_t iid)
1427 struct ctl_softc *softc;
1430 softc = control_softc;
1432 mtx_assert(&softc->ctl_lock, MA_NOTOWNED);
1437 || (targ_port > CTL_MAX_PORTS)) {
1438 printf("%s: invalid port number %d\n", __func__, targ_port);
1441 if (iid > CTL_MAX_INIT_PER_PORT) {
1442 printf("%s: WWPN %#jx initiator ID %u > maximun %u!\n",
1443 __func__, wwpn, iid, CTL_MAX_INIT_PER_PORT);
1447 mtx_lock(&softc->ctl_lock);
1449 if (softc->wwpn_iid[targ_port][iid].in_use != 0) {
1451 * We don't treat this as an error.
1453 if (softc->wwpn_iid[targ_port][iid].wwpn == wwpn) {
1454 printf("%s: port %d iid %u WWPN %#jx arrived again?\n",
1455 __func__, targ_port, iid, (uintmax_t)wwpn);
1460 * This is an error, but what do we do about it? The
1461 * driver is telling us we have a new WWPN for this
1462 * initiator ID, so we pretty much need to use it.
1464 printf("%s: port %d iid %u WWPN %#jx arrived, WWPN %#jx is "
1465 "still at that address\n", __func__, targ_port, iid,
1467 (uintmax_t)softc->wwpn_iid[targ_port][iid].wwpn);
1470 * XXX KDM clear have_ca and ua_pending on each LUN for
1474 softc->wwpn_iid[targ_port][iid].in_use = 1;
1475 softc->wwpn_iid[targ_port][iid].iid = iid;
1476 softc->wwpn_iid[targ_port][iid].wwpn = wwpn;
1477 softc->wwpn_iid[targ_port][iid].port = targ_port;
1481 mtx_unlock(&softc->ctl_lock);
1487 * XXX KDM should we pretend to do something in the target/lun
1488 * enable/disable functions?
1491 ctl_ioctl_targ_enable(void *arg, struct ctl_id targ_id)
1497 ctl_ioctl_targ_disable(void *arg, struct ctl_id targ_id)
1503 ctl_ioctl_lun_enable(void *arg, struct ctl_id targ_id, int lun_id)
1509 ctl_ioctl_lun_disable(void *arg, struct ctl_id targ_id, int lun_id)
1515 * Data movement routine for the CTL ioctl frontend port.
1518 ctl_ioctl_do_datamove(struct ctl_scsiio *ctsio)
1520 struct ctl_sg_entry *ext_sglist, *kern_sglist;
1521 struct ctl_sg_entry ext_entry, kern_entry;
1522 int ext_sglen, ext_sg_entries, kern_sg_entries;
1523 int ext_sg_start, ext_offset;
1524 int len_to_copy, len_copied;
1525 int kern_watermark, ext_watermark;
1526 int ext_sglist_malloced;
1529 ext_sglist_malloced = 0;
1533 CTL_DEBUG_PRINT(("ctl_ioctl_do_datamove\n"));
1536 * If this flag is set, fake the data transfer.
1538 if (ctsio->io_hdr.flags & CTL_FLAG_NO_DATAMOVE) {
1539 ctsio->ext_data_filled = ctsio->ext_data_len;
1544 * To simplify things here, if we have a single buffer, stick it in
1545 * a S/G entry and just make it a single entry S/G list.
1547 if (ctsio->io_hdr.flags & CTL_FLAG_EDPTR_SGLIST) {
1550 ext_sglen = ctsio->ext_sg_entries * sizeof(*ext_sglist);
1552 ext_sglist = (struct ctl_sg_entry *)malloc(ext_sglen, M_CTL,
1554 ext_sglist_malloced = 1;
1555 if (copyin(ctsio->ext_data_ptr, ext_sglist,
1557 ctl_set_internal_failure(ctsio,
1562 ext_sg_entries = ctsio->ext_sg_entries;
1564 for (i = 0; i < ext_sg_entries; i++) {
1565 if ((len_seen + ext_sglist[i].len) >=
1566 ctsio->ext_data_filled) {
1568 ext_offset = ctsio->ext_data_filled - len_seen;
1571 len_seen += ext_sglist[i].len;
1574 ext_sglist = &ext_entry;
1575 ext_sglist->addr = ctsio->ext_data_ptr;
1576 ext_sglist->len = ctsio->ext_data_len;
1579 ext_offset = ctsio->ext_data_filled;
1582 if (ctsio->kern_sg_entries > 0) {
1583 kern_sglist = (struct ctl_sg_entry *)ctsio->kern_data_ptr;
1584 kern_sg_entries = ctsio->kern_sg_entries;
1586 kern_sglist = &kern_entry;
1587 kern_sglist->addr = ctsio->kern_data_ptr;
1588 kern_sglist->len = ctsio->kern_data_len;
1589 kern_sg_entries = 1;
1594 ext_watermark = ext_offset;
1596 for (i = ext_sg_start, j = 0;
1597 i < ext_sg_entries && j < kern_sg_entries;) {
1598 uint8_t *ext_ptr, *kern_ptr;
1600 len_to_copy = ctl_min(ext_sglist[i].len - ext_watermark,
1601 kern_sglist[j].len - kern_watermark);
1603 ext_ptr = (uint8_t *)ext_sglist[i].addr;
1604 ext_ptr = ext_ptr + ext_watermark;
1605 if (ctsio->io_hdr.flags & CTL_FLAG_BUS_ADDR) {
1609 panic("need to implement bus address support");
1611 kern_ptr = bus_to_virt(kern_sglist[j].addr);
1614 kern_ptr = (uint8_t *)kern_sglist[j].addr;
1615 kern_ptr = kern_ptr + kern_watermark;
1617 kern_watermark += len_to_copy;
1618 ext_watermark += len_to_copy;
1620 if ((ctsio->io_hdr.flags & CTL_FLAG_DATA_MASK) ==
1622 CTL_DEBUG_PRINT(("ctl_ioctl_do_datamove: copying %d "
1623 "bytes to user\n", len_to_copy));
1624 CTL_DEBUG_PRINT(("ctl_ioctl_do_datamove: from %p "
1625 "to %p\n", kern_ptr, ext_ptr));
1626 if (copyout(kern_ptr, ext_ptr, len_to_copy) != 0) {
1627 ctl_set_internal_failure(ctsio,
1633 CTL_DEBUG_PRINT(("ctl_ioctl_do_datamove: copying %d "
1634 "bytes from user\n", len_to_copy));
1635 CTL_DEBUG_PRINT(("ctl_ioctl_do_datamove: from %p "
1636 "to %p\n", ext_ptr, kern_ptr));
1637 if (copyin(ext_ptr, kern_ptr, len_to_copy)!= 0){
1638 ctl_set_internal_failure(ctsio,
1645 len_copied += len_to_copy;
1647 if (ext_sglist[i].len == ext_watermark) {
1652 if (kern_sglist[j].len == kern_watermark) {
1658 ctsio->ext_data_filled += len_copied;
1660 CTL_DEBUG_PRINT(("ctl_ioctl_do_datamove: ext_sg_entries: %d, "
1661 "kern_sg_entries: %d\n", ext_sg_entries,
1663 CTL_DEBUG_PRINT(("ctl_ioctl_do_datamove: ext_data_len = %d, "
1664 "kern_data_len = %d\n", ctsio->ext_data_len,
1665 ctsio->kern_data_len));
1668 /* XXX KDM set residual?? */
1671 if (ext_sglist_malloced != 0)
1672 free(ext_sglist, M_CTL);
1674 return (CTL_RETVAL_COMPLETE);
1678 * Serialize a command that went down the "wrong" side, and so was sent to
1679 * this controller for execution. The logic is a little different than the
1680 * standard case in ctl_scsiio_precheck(). Errors in this case need to get
1681 * sent back to the other side, but in the success case, we execute the
1682 * command on this side (XFER mode) or tell the other side to execute it
1686 ctl_serialize_other_sc_cmd(struct ctl_scsiio *ctsio, int have_lock)
1688 struct ctl_softc *ctl_softc;
1689 union ctl_ha_msg msg_info;
1690 struct ctl_lun *lun;
1694 ctl_softc = control_softc;
1696 mtx_lock(&ctl_softc->ctl_lock);
1698 targ_lun = ctsio->io_hdr.nexus.targ_lun;
1699 if (ctsio->io_hdr.nexus.lun_map_fn != NULL)
1700 targ_lun = ctsio->io_hdr.nexus.lun_map_fn(ctsio->io_hdr.nexus.lun_map_arg, targ_lun);
1701 lun = ctl_softc->ctl_luns[targ_lun];
1705 * Why isn't LUN defined? The other side wouldn't
1706 * send a cmd if the LUN is undefined.
1708 printf("%s: Bad JUJU!, LUN is NULL!\n", __func__);
1710 /* "Logical unit not supported" */
1711 ctl_set_sense_data(&msg_info.scsi.sense_data,
1713 /*sense_format*/SSD_TYPE_NONE,
1714 /*current_error*/ 1,
1715 /*sense_key*/ SSD_KEY_ILLEGAL_REQUEST,
1720 msg_info.scsi.sense_len = SSD_FULL_SIZE;
1721 msg_info.scsi.scsi_status = SCSI_STATUS_CHECK_COND;
1722 msg_info.hdr.status = CTL_SCSI_ERROR | CTL_AUTOSENSE;
1723 msg_info.hdr.original_sc = ctsio->io_hdr.original_sc;
1724 msg_info.hdr.serializing_sc = NULL;
1725 msg_info.hdr.msg_type = CTL_MSG_BAD_JUJU;
1726 if (ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg_info,
1727 sizeof(msg_info), 0 ) > CTL_HA_STATUS_SUCCESS) {
1730 mtx_unlock(&ctl_softc->ctl_lock);
1735 TAILQ_INSERT_TAIL(&lun->ooa_queue, &ctsio->io_hdr, ooa_links);
1737 switch (ctl_check_ooa(lun, (union ctl_io *)ctsio,
1738 (union ctl_io *)TAILQ_PREV(&ctsio->io_hdr, ctl_ooaq,
1740 case CTL_ACTION_BLOCK:
1741 ctsio->io_hdr.flags |= CTL_FLAG_BLOCKED;
1742 TAILQ_INSERT_TAIL(&lun->blocked_queue, &ctsio->io_hdr,
1745 case CTL_ACTION_PASS:
1746 case CTL_ACTION_SKIP:
1747 if (ctl_softc->ha_mode == CTL_HA_MODE_XFER) {
1748 ctsio->io_hdr.flags |= CTL_FLAG_IS_WAS_ON_RTR;
1749 STAILQ_INSERT_TAIL(&ctl_softc->rtr_queue,
1750 &ctsio->io_hdr, links);
1753 /* send msg back to other side */
1754 msg_info.hdr.original_sc = ctsio->io_hdr.original_sc;
1755 msg_info.hdr.serializing_sc = (union ctl_io *)ctsio;
1756 msg_info.hdr.msg_type = CTL_MSG_R2R;
1758 printf("2. pOrig %x\n", (int)msg_info.hdr.original_sc);
1760 if (ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg_info,
1761 sizeof(msg_info), 0 ) > CTL_HA_STATUS_SUCCESS) {
1765 case CTL_ACTION_OVERLAP:
1766 /* OVERLAPPED COMMANDS ATTEMPTED */
1767 ctl_set_sense_data(&msg_info.scsi.sense_data,
1769 /*sense_format*/SSD_TYPE_NONE,
1770 /*current_error*/ 1,
1771 /*sense_key*/ SSD_KEY_ILLEGAL_REQUEST,
1776 msg_info.scsi.sense_len = SSD_FULL_SIZE;
1777 msg_info.scsi.scsi_status = SCSI_STATUS_CHECK_COND;
1778 msg_info.hdr.status = CTL_SCSI_ERROR | CTL_AUTOSENSE;
1779 msg_info.hdr.original_sc = ctsio->io_hdr.original_sc;
1780 msg_info.hdr.serializing_sc = NULL;
1781 msg_info.hdr.msg_type = CTL_MSG_BAD_JUJU;
1783 printf("BAD JUJU:Major Bummer Overlap\n");
1785 TAILQ_REMOVE(&lun->ooa_queue, &ctsio->io_hdr, ooa_links);
1787 if (ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg_info,
1788 sizeof(msg_info), 0 ) > CTL_HA_STATUS_SUCCESS) {
1791 case CTL_ACTION_OVERLAP_TAG:
1792 /* TAGGED OVERLAPPED COMMANDS (NN = QUEUE TAG) */
1793 ctl_set_sense_data(&msg_info.scsi.sense_data,
1795 /*sense_format*/SSD_TYPE_NONE,
1796 /*current_error*/ 1,
1797 /*sense_key*/ SSD_KEY_ILLEGAL_REQUEST,
1799 /*ascq*/ ctsio->tag_num & 0xff,
1802 msg_info.scsi.sense_len = SSD_FULL_SIZE;
1803 msg_info.scsi.scsi_status = SCSI_STATUS_CHECK_COND;
1804 msg_info.hdr.status = CTL_SCSI_ERROR | CTL_AUTOSENSE;
1805 msg_info.hdr.original_sc = ctsio->io_hdr.original_sc;
1806 msg_info.hdr.serializing_sc = NULL;
1807 msg_info.hdr.msg_type = CTL_MSG_BAD_JUJU;
1809 printf("BAD JUJU:Major Bummer Overlap Tag\n");
1811 TAILQ_REMOVE(&lun->ooa_queue, &ctsio->io_hdr, ooa_links);
1813 if (ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg_info,
1814 sizeof(msg_info), 0 ) > CTL_HA_STATUS_SUCCESS) {
1817 case CTL_ACTION_ERROR:
1819 /* "Internal target failure" */
1820 ctl_set_sense_data(&msg_info.scsi.sense_data,
1822 /*sense_format*/SSD_TYPE_NONE,
1823 /*current_error*/ 1,
1824 /*sense_key*/ SSD_KEY_HARDWARE_ERROR,
1829 msg_info.scsi.sense_len = SSD_FULL_SIZE;
1830 msg_info.scsi.scsi_status = SCSI_STATUS_CHECK_COND;
1831 msg_info.hdr.status = CTL_SCSI_ERROR | CTL_AUTOSENSE;
1832 msg_info.hdr.original_sc = ctsio->io_hdr.original_sc;
1833 msg_info.hdr.serializing_sc = NULL;
1834 msg_info.hdr.msg_type = CTL_MSG_BAD_JUJU;
1836 printf("BAD JUJU:Major Bummer HW Error\n");
1838 TAILQ_REMOVE(&lun->ooa_queue, &ctsio->io_hdr, ooa_links);
1840 if (ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg_info,
1841 sizeof(msg_info), 0 ) > CTL_HA_STATUS_SUCCESS) {
1846 mtx_unlock(&ctl_softc->ctl_lock);
1851 ctl_ioctl_submit_wait(union ctl_io *io)
1853 struct ctl_fe_ioctl_params params;
1854 ctl_fe_ioctl_state last_state;
1859 bzero(¶ms, sizeof(params));
1861 mtx_init(¶ms.ioctl_mtx, "ctliocmtx", NULL, MTX_DEF);
1862 cv_init(¶ms.sem, "ctlioccv");
1863 params.state = CTL_IOCTL_INPROG;
1864 last_state = params.state;
1866 io->io_hdr.ctl_private[CTL_PRIV_FRONTEND].ptr = ¶ms;
1868 CTL_DEBUG_PRINT(("ctl_ioctl_submit_wait\n"));
1870 /* This shouldn't happen */
1871 if ((retval = ctl_queue(io)) != CTL_RETVAL_COMPLETE)
1877 mtx_lock(¶ms.ioctl_mtx);
1879 * Check the state here, and don't sleep if the state has
1880 * already changed (i.e. wakeup has already occured, but we
1881 * weren't waiting yet).
1883 if (params.state == last_state) {
1884 /* XXX KDM cv_wait_sig instead? */
1885 cv_wait(¶ms.sem, ¶ms.ioctl_mtx);
1887 last_state = params.state;
1889 switch (params.state) {
1890 case CTL_IOCTL_INPROG:
1891 /* Why did we wake up? */
1892 /* XXX KDM error here? */
1893 mtx_unlock(¶ms.ioctl_mtx);
1895 case CTL_IOCTL_DATAMOVE:
1896 CTL_DEBUG_PRINT(("got CTL_IOCTL_DATAMOVE\n"));
1899 * change last_state back to INPROG to avoid
1900 * deadlock on subsequent data moves.
1902 params.state = last_state = CTL_IOCTL_INPROG;
1904 mtx_unlock(¶ms.ioctl_mtx);
1905 ctl_ioctl_do_datamove(&io->scsiio);
1907 * Note that in some cases, most notably writes,
1908 * this will queue the I/O and call us back later.
1909 * In other cases, generally reads, this routine
1910 * will immediately call back and wake us up,
1911 * probably using our own context.
1913 io->scsiio.be_move_done(io);
1915 case CTL_IOCTL_DONE:
1916 mtx_unlock(¶ms.ioctl_mtx);
1917 CTL_DEBUG_PRINT(("got CTL_IOCTL_DONE\n"));
1921 mtx_unlock(¶ms.ioctl_mtx);
1922 /* XXX KDM error here? */
1925 } while (done == 0);
1927 mtx_destroy(¶ms.ioctl_mtx);
1928 cv_destroy(¶ms.sem);
1930 return (CTL_RETVAL_COMPLETE);
1934 ctl_ioctl_datamove(union ctl_io *io)
1936 struct ctl_fe_ioctl_params *params;
1938 params = (struct ctl_fe_ioctl_params *)
1939 io->io_hdr.ctl_private[CTL_PRIV_FRONTEND].ptr;
1941 mtx_lock(¶ms->ioctl_mtx);
1942 params->state = CTL_IOCTL_DATAMOVE;
1943 cv_broadcast(¶ms->sem);
1944 mtx_unlock(¶ms->ioctl_mtx);
1948 ctl_ioctl_done(union ctl_io *io)
1950 struct ctl_fe_ioctl_params *params;
1952 params = (struct ctl_fe_ioctl_params *)
1953 io->io_hdr.ctl_private[CTL_PRIV_FRONTEND].ptr;
1955 mtx_lock(¶ms->ioctl_mtx);
1956 params->state = CTL_IOCTL_DONE;
1957 cv_broadcast(¶ms->sem);
1958 mtx_unlock(¶ms->ioctl_mtx);
1962 ctl_ioctl_hard_startstop_callback(void *arg, struct cfi_metatask *metatask)
1964 struct ctl_fe_ioctl_startstop_info *sd_info;
1966 sd_info = (struct ctl_fe_ioctl_startstop_info *)arg;
1968 sd_info->hs_info.status = metatask->status;
1969 sd_info->hs_info.total_luns = metatask->taskinfo.startstop.total_luns;
1970 sd_info->hs_info.luns_complete =
1971 metatask->taskinfo.startstop.luns_complete;
1972 sd_info->hs_info.luns_failed = metatask->taskinfo.startstop.luns_failed;
1974 cv_broadcast(&sd_info->sem);
1978 ctl_ioctl_bbrread_callback(void *arg, struct cfi_metatask *metatask)
1980 struct ctl_fe_ioctl_bbrread_info *fe_bbr_info;
1982 fe_bbr_info = (struct ctl_fe_ioctl_bbrread_info *)arg;
1984 mtx_lock(fe_bbr_info->lock);
1985 fe_bbr_info->bbr_info->status = metatask->status;
1986 fe_bbr_info->bbr_info->bbr_status = metatask->taskinfo.bbrread.status;
1987 fe_bbr_info->wakeup_done = 1;
1988 mtx_unlock(fe_bbr_info->lock);
1990 cv_broadcast(&fe_bbr_info->sem);
1994 * Returns 0 for success, errno for failure.
1997 ctl_ioctl_fill_ooa(struct ctl_lun *lun, uint32_t *cur_fill_num,
1998 struct ctl_ooa *ooa_hdr, struct ctl_ooa_entry *kern_entries)
2005 mtx_assert(&control_softc->ctl_lock, MA_OWNED);
2007 for (io = (union ctl_io *)TAILQ_FIRST(&lun->ooa_queue); (io != NULL);
2008 (*cur_fill_num)++, io = (union ctl_io *)TAILQ_NEXT(&io->io_hdr,
2010 struct ctl_ooa_entry *entry;
2013 * If we've got more than we can fit, just count the
2014 * remaining entries.
2016 if (*cur_fill_num >= ooa_hdr->alloc_num)
2019 entry = &kern_entries[*cur_fill_num];
2021 entry->tag_num = io->scsiio.tag_num;
2022 entry->lun_num = lun->lun;
2024 entry->start_bt = io->io_hdr.start_bt;
2026 bcopy(io->scsiio.cdb, entry->cdb, io->scsiio.cdb_len);
2027 entry->cdb_len = io->scsiio.cdb_len;
2028 if (io->io_hdr.flags & CTL_FLAG_BLOCKED)
2029 entry->cmd_flags |= CTL_OOACMD_FLAG_BLOCKED;
2031 if (io->io_hdr.flags & CTL_FLAG_DMA_INPROG)
2032 entry->cmd_flags |= CTL_OOACMD_FLAG_DMA;
2034 if (io->io_hdr.flags & CTL_FLAG_ABORT)
2035 entry->cmd_flags |= CTL_OOACMD_FLAG_ABORT;
2037 if (io->io_hdr.flags & CTL_FLAG_IS_WAS_ON_RTR)
2038 entry->cmd_flags |= CTL_OOACMD_FLAG_RTR;
2040 if (io->io_hdr.flags & CTL_FLAG_DMA_QUEUED)
2041 entry->cmd_flags |= CTL_OOACMD_FLAG_DMA_QUEUED;
2048 ctl_copyin_alloc(void *user_addr, int len, char *error_str,
2049 size_t error_str_len)
2053 kptr = malloc(len, M_CTL, M_WAITOK | M_ZERO);
2055 if (copyin(user_addr, kptr, len) != 0) {
2056 snprintf(error_str, error_str_len, "Error copying %d bytes "
2057 "from user address %p to kernel address %p", len,
2067 ctl_free_args(int num_be_args, struct ctl_be_arg *be_args)
2071 if (be_args == NULL)
2074 for (i = 0; i < num_be_args; i++) {
2075 free(be_args[i].kname, M_CTL);
2076 free(be_args[i].kvalue, M_CTL);
2079 free(be_args, M_CTL);
2082 static struct ctl_be_arg *
2083 ctl_copyin_args(int num_be_args, struct ctl_be_arg *be_args,
2084 char *error_str, size_t error_str_len)
2086 struct ctl_be_arg *args;
2089 args = ctl_copyin_alloc(be_args, num_be_args * sizeof(*be_args),
2090 error_str, error_str_len);
2095 for (i = 0; i < num_be_args; i++) {
2096 args[i].kname = NULL;
2097 args[i].kvalue = NULL;
2100 for (i = 0; i < num_be_args; i++) {
2103 args[i].kname = ctl_copyin_alloc(args[i].name,
2104 args[i].namelen, error_str, error_str_len);
2105 if (args[i].kname == NULL)
2108 if (args[i].kname[args[i].namelen - 1] != '\0') {
2109 snprintf(error_str, error_str_len, "Argument %d "
2110 "name is not NUL-terminated", i);
2114 args[i].kvalue = NULL;
2116 tmpptr = ctl_copyin_alloc(args[i].value,
2117 args[i].vallen, error_str, error_str_len);
2121 args[i].kvalue = tmpptr;
2123 if ((args[i].flags & CTL_BEARG_ASCII)
2124 && (tmpptr[args[i].vallen - 1] != '\0')) {
2125 snprintf(error_str, error_str_len, "Argument %d "
2126 "value is not NUL-terminated", i);
2134 ctl_free_args(num_be_args, args);
2140 * Escape characters that are illegal or not recommended in XML.
2143 ctl_sbuf_printf_esc(struct sbuf *sb, char *str)
2149 for (; *str; str++) {
2152 retval = sbuf_printf(sb, "&");
2155 retval = sbuf_printf(sb, ">");
2158 retval = sbuf_printf(sb, "<");
2161 retval = sbuf_putc(sb, *str);
2174 ctl_ioctl(struct cdev *dev, u_long cmd, caddr_t addr, int flag,
2177 struct ctl_softc *softc;
2180 softc = control_softc;
2190 * If we haven't been "enabled", don't allow any SCSI I/O
2193 if ((softc->ioctl_info.flags & CTL_IOCTL_FLAG_ENABLED) == 0) {
2198 io = ctl_alloc_io(softc->ioctl_info.fe.ctl_pool_ref);
2200 printf("ctl_ioctl: can't allocate ctl_io!\n");
2206 * Need to save the pool reference so it doesn't get
2207 * spammed by the user's ctl_io.
2209 pool_tmp = io->io_hdr.pool;
2211 memcpy(io, (void *)addr, sizeof(*io));
2213 io->io_hdr.pool = pool_tmp;
2215 * No status yet, so make sure the status is set properly.
2217 io->io_hdr.status = CTL_STATUS_NONE;
2220 * The user sets the initiator ID, target and LUN IDs.
2222 io->io_hdr.nexus.targ_port = softc->ioctl_info.fe.targ_port;
2223 io->io_hdr.flags |= CTL_FLAG_USER_REQ;
2224 if ((io->io_hdr.io_type == CTL_IO_SCSI)
2225 && (io->scsiio.tag_type != CTL_TAG_UNTAGGED))
2226 io->scsiio.tag_num = softc->ioctl_info.cur_tag_num++;
2228 retval = ctl_ioctl_submit_wait(io);
2235 memcpy((void *)addr, io, sizeof(*io));
2237 /* return this to our pool */
2242 case CTL_ENABLE_PORT:
2243 case CTL_DISABLE_PORT:
2244 case CTL_SET_PORT_WWNS: {
2245 struct ctl_frontend *fe;
2246 struct ctl_port_entry *entry;
2248 entry = (struct ctl_port_entry *)addr;
2250 mtx_lock(&softc->ctl_lock);
2251 STAILQ_FOREACH(fe, &softc->fe_list, links) {
2257 if ((entry->port_type == CTL_PORT_NONE)
2258 && (entry->targ_port == fe->targ_port)) {
2260 * If the user only wants to enable or
2261 * disable or set WWNs on a specific port,
2262 * do the operation and we're done.
2266 } else if (entry->port_type & fe->port_type) {
2268 * Compare the user's type mask with the
2269 * particular frontend type to see if we
2276 * Make sure the user isn't trying to set
2277 * WWNs on multiple ports at the same time.
2279 if (cmd == CTL_SET_PORT_WWNS) {
2280 printf("%s: Can't set WWNs on "
2281 "multiple ports\n", __func__);
2288 * XXX KDM we have to drop the lock here,
2289 * because the online/offline operations
2290 * can potentially block. We need to
2291 * reference count the frontends so they
2294 mtx_unlock(&softc->ctl_lock);
2296 if (cmd == CTL_ENABLE_PORT) {
2297 struct ctl_lun *lun;
2299 STAILQ_FOREACH(lun, &softc->lun_list,
2301 fe->lun_enable(fe->targ_lun_arg,
2306 ctl_frontend_online(fe);
2307 } else if (cmd == CTL_DISABLE_PORT) {
2308 struct ctl_lun *lun;
2310 ctl_frontend_offline(fe);
2312 STAILQ_FOREACH(lun, &softc->lun_list,
2321 mtx_lock(&softc->ctl_lock);
2323 if (cmd == CTL_SET_PORT_WWNS)
2324 ctl_frontend_set_wwns(fe,
2325 (entry->flags & CTL_PORT_WWNN_VALID) ?
2327 (entry->flags & CTL_PORT_WWPN_VALID) ?
2328 1 : 0, entry->wwpn);
2333 mtx_unlock(&softc->ctl_lock);
2336 case CTL_GET_PORT_LIST: {
2337 struct ctl_frontend *fe;
2338 struct ctl_port_list *list;
2341 list = (struct ctl_port_list *)addr;
2343 if (list->alloc_len != (list->alloc_num *
2344 sizeof(struct ctl_port_entry))) {
2345 printf("%s: CTL_GET_PORT_LIST: alloc_len %u != "
2346 "alloc_num %u * sizeof(struct ctl_port_entry) "
2347 "%zu\n", __func__, list->alloc_len,
2348 list->alloc_num, sizeof(struct ctl_port_entry));
2354 list->dropped_num = 0;
2356 mtx_lock(&softc->ctl_lock);
2357 STAILQ_FOREACH(fe, &softc->fe_list, links) {
2358 struct ctl_port_entry entry, *list_entry;
2360 if (list->fill_num >= list->alloc_num) {
2361 list->dropped_num++;
2365 entry.port_type = fe->port_type;
2366 strlcpy(entry.port_name, fe->port_name,
2367 sizeof(entry.port_name));
2368 entry.targ_port = fe->targ_port;
2369 entry.physical_port = fe->physical_port;
2370 entry.virtual_port = fe->virtual_port;
2371 entry.wwnn = fe->wwnn;
2372 entry.wwpn = fe->wwpn;
2373 if (fe->status & CTL_PORT_STATUS_ONLINE)
2378 list_entry = &list->entries[i];
2380 retval = copyout(&entry, list_entry, sizeof(entry));
2382 printf("%s: CTL_GET_PORT_LIST: copyout "
2383 "returned %d\n", __func__, retval);
2388 list->fill_len += sizeof(entry);
2390 mtx_unlock(&softc->ctl_lock);
2393 * If this is non-zero, we had a copyout fault, so there's
2394 * probably no point in attempting to set the status inside
2400 if (list->dropped_num > 0)
2401 list->status = CTL_PORT_LIST_NEED_MORE_SPACE;
2403 list->status = CTL_PORT_LIST_OK;
2406 case CTL_DUMP_OOA: {
2407 struct ctl_lun *lun;
2412 mtx_lock(&softc->ctl_lock);
2413 printf("Dumping OOA queues:\n");
2414 STAILQ_FOREACH(lun, &softc->lun_list, links) {
2415 for (io = (union ctl_io *)TAILQ_FIRST(
2416 &lun->ooa_queue); io != NULL;
2417 io = (union ctl_io *)TAILQ_NEXT(&io->io_hdr,
2419 sbuf_new(&sb, printbuf, sizeof(printbuf),
2421 sbuf_printf(&sb, "LUN %jd tag 0x%04x%s%s%s%s: ",
2425 CTL_FLAG_BLOCKED) ? "" : " BLOCKED",
2427 CTL_FLAG_DMA_INPROG) ? " DMA" : "",
2429 CTL_FLAG_ABORT) ? " ABORT" : "",
2431 CTL_FLAG_IS_WAS_ON_RTR) ? " RTR" : "");
2432 ctl_scsi_command_string(&io->scsiio, NULL, &sb);
2434 printf("%s\n", sbuf_data(&sb));
2437 printf("OOA queues dump done\n");
2438 mtx_unlock(&softc->ctl_lock);
2442 struct ctl_lun *lun;
2443 struct ctl_ooa *ooa_hdr;
2444 struct ctl_ooa_entry *entries;
2445 uint32_t cur_fill_num;
2447 ooa_hdr = (struct ctl_ooa *)addr;
2449 if ((ooa_hdr->alloc_len == 0)
2450 || (ooa_hdr->alloc_num == 0)) {
2451 printf("%s: CTL_GET_OOA: alloc len %u and alloc num %u "
2452 "must be non-zero\n", __func__,
2453 ooa_hdr->alloc_len, ooa_hdr->alloc_num);
2458 if (ooa_hdr->alloc_len != (ooa_hdr->alloc_num *
2459 sizeof(struct ctl_ooa_entry))) {
2460 printf("%s: CTL_GET_OOA: alloc len %u must be alloc "
2461 "num %d * sizeof(struct ctl_ooa_entry) %zd\n",
2462 __func__, ooa_hdr->alloc_len,
2463 ooa_hdr->alloc_num,sizeof(struct ctl_ooa_entry));
2468 entries = malloc(ooa_hdr->alloc_len, M_CTL, M_WAITOK | M_ZERO);
2469 if (entries == NULL) {
2470 printf("%s: could not allocate %d bytes for OOA "
2471 "dump\n", __func__, ooa_hdr->alloc_len);
2476 mtx_lock(&softc->ctl_lock);
2477 if (((ooa_hdr->flags & CTL_OOA_FLAG_ALL_LUNS) == 0)
2478 && ((ooa_hdr->lun_num > CTL_MAX_LUNS)
2479 || (softc->ctl_luns[ooa_hdr->lun_num] == NULL))) {
2480 mtx_unlock(&softc->ctl_lock);
2481 free(entries, M_CTL);
2482 printf("%s: CTL_GET_OOA: invalid LUN %ju\n",
2483 __func__, (uintmax_t)ooa_hdr->lun_num);
2490 if (ooa_hdr->flags & CTL_OOA_FLAG_ALL_LUNS) {
2491 STAILQ_FOREACH(lun, &softc->lun_list, links) {
2492 retval = ctl_ioctl_fill_ooa(lun, &cur_fill_num,
2498 mtx_unlock(&softc->ctl_lock);
2499 free(entries, M_CTL);
2503 lun = softc->ctl_luns[ooa_hdr->lun_num];
2505 retval = ctl_ioctl_fill_ooa(lun, &cur_fill_num,ooa_hdr,
2508 mtx_unlock(&softc->ctl_lock);
2510 ooa_hdr->fill_num = min(cur_fill_num, ooa_hdr->alloc_num);
2511 ooa_hdr->fill_len = ooa_hdr->fill_num *
2512 sizeof(struct ctl_ooa_entry);
2513 retval = copyout(entries, ooa_hdr->entries, ooa_hdr->fill_len);
2515 printf("%s: error copying out %d bytes for OOA dump\n",
2516 __func__, ooa_hdr->fill_len);
2519 getbintime(&ooa_hdr->cur_bt);
2521 if (cur_fill_num > ooa_hdr->alloc_num) {
2522 ooa_hdr->dropped_num = cur_fill_num -ooa_hdr->alloc_num;
2523 ooa_hdr->status = CTL_OOA_NEED_MORE_SPACE;
2525 ooa_hdr->dropped_num = 0;
2526 ooa_hdr->status = CTL_OOA_OK;
2529 free(entries, M_CTL);
2532 case CTL_CHECK_OOA: {
2534 struct ctl_lun *lun;
2535 struct ctl_ooa_info *ooa_info;
2538 ooa_info = (struct ctl_ooa_info *)addr;
2540 if (ooa_info->lun_id >= CTL_MAX_LUNS) {
2541 ooa_info->status = CTL_OOA_INVALID_LUN;
2544 mtx_lock(&softc->ctl_lock);
2545 lun = softc->ctl_luns[ooa_info->lun_id];
2547 mtx_unlock(&softc->ctl_lock);
2548 ooa_info->status = CTL_OOA_INVALID_LUN;
2552 ooa_info->num_entries = 0;
2553 for (io = (union ctl_io *)TAILQ_FIRST(&lun->ooa_queue);
2554 io != NULL; io = (union ctl_io *)TAILQ_NEXT(
2555 &io->io_hdr, ooa_links)) {
2556 ooa_info->num_entries++;
2559 mtx_unlock(&softc->ctl_lock);
2560 ooa_info->status = CTL_OOA_SUCCESS;
2564 case CTL_HARD_START:
2565 case CTL_HARD_STOP: {
2566 struct ctl_fe_ioctl_startstop_info ss_info;
2567 struct cfi_metatask *metatask;
2570 mtx_init(&hs_mtx, "HS Mutex", NULL, MTX_DEF);
2572 cv_init(&ss_info.sem, "hard start/stop cv" );
2574 metatask = cfi_alloc_metatask(/*can_wait*/ 1);
2575 if (metatask == NULL) {
2577 mtx_destroy(&hs_mtx);
2581 if (cmd == CTL_HARD_START)
2582 metatask->tasktype = CFI_TASK_STARTUP;
2584 metatask->tasktype = CFI_TASK_SHUTDOWN;
2586 metatask->callback = ctl_ioctl_hard_startstop_callback;
2587 metatask->callback_arg = &ss_info;
2589 cfi_action(metatask);
2591 /* Wait for the callback */
2593 cv_wait_sig(&ss_info.sem, &hs_mtx);
2594 mtx_unlock(&hs_mtx);
2597 * All information has been copied from the metatask by the
2598 * time cv_broadcast() is called, so we free the metatask here.
2600 cfi_free_metatask(metatask);
2602 memcpy((void *)addr, &ss_info.hs_info, sizeof(ss_info.hs_info));
2604 mtx_destroy(&hs_mtx);
2608 struct ctl_bbrread_info *bbr_info;
2609 struct ctl_fe_ioctl_bbrread_info fe_bbr_info;
2611 struct cfi_metatask *metatask;
2613 bbr_info = (struct ctl_bbrread_info *)addr;
2615 bzero(&fe_bbr_info, sizeof(fe_bbr_info));
2617 bzero(&bbr_mtx, sizeof(bbr_mtx));
2618 mtx_init(&bbr_mtx, "BBR Mutex", NULL, MTX_DEF);
2620 fe_bbr_info.bbr_info = bbr_info;
2621 fe_bbr_info.lock = &bbr_mtx;
2623 cv_init(&fe_bbr_info.sem, "BBR read cv");
2624 metatask = cfi_alloc_metatask(/*can_wait*/ 1);
2626 if (metatask == NULL) {
2627 mtx_destroy(&bbr_mtx);
2628 cv_destroy(&fe_bbr_info.sem);
2632 metatask->tasktype = CFI_TASK_BBRREAD;
2633 metatask->callback = ctl_ioctl_bbrread_callback;
2634 metatask->callback_arg = &fe_bbr_info;
2635 metatask->taskinfo.bbrread.lun_num = bbr_info->lun_num;
2636 metatask->taskinfo.bbrread.lba = bbr_info->lba;
2637 metatask->taskinfo.bbrread.len = bbr_info->len;
2639 cfi_action(metatask);
2642 while (fe_bbr_info.wakeup_done == 0)
2643 cv_wait_sig(&fe_bbr_info.sem, &bbr_mtx);
2644 mtx_unlock(&bbr_mtx);
2646 bbr_info->status = metatask->status;
2647 bbr_info->bbr_status = metatask->taskinfo.bbrread.status;
2648 bbr_info->scsi_status = metatask->taskinfo.bbrread.scsi_status;
2649 memcpy(&bbr_info->sense_data,
2650 &metatask->taskinfo.bbrread.sense_data,
2651 ctl_min(sizeof(bbr_info->sense_data),
2652 sizeof(metatask->taskinfo.bbrread.sense_data)));
2654 cfi_free_metatask(metatask);
2656 mtx_destroy(&bbr_mtx);
2657 cv_destroy(&fe_bbr_info.sem);
2661 case CTL_DELAY_IO: {
2662 struct ctl_io_delay_info *delay_info;
2664 struct ctl_lun *lun;
2665 #endif /* CTL_IO_DELAY */
2667 delay_info = (struct ctl_io_delay_info *)addr;
2670 mtx_lock(&softc->ctl_lock);
2672 if ((delay_info->lun_id > CTL_MAX_LUNS)
2673 || (softc->ctl_luns[delay_info->lun_id] == NULL)) {
2674 delay_info->status = CTL_DELAY_STATUS_INVALID_LUN;
2676 lun = softc->ctl_luns[delay_info->lun_id];
2678 delay_info->status = CTL_DELAY_STATUS_OK;
2680 switch (delay_info->delay_type) {
2681 case CTL_DELAY_TYPE_CONT:
2683 case CTL_DELAY_TYPE_ONESHOT:
2686 delay_info->status =
2687 CTL_DELAY_STATUS_INVALID_TYPE;
2691 switch (delay_info->delay_loc) {
2692 case CTL_DELAY_LOC_DATAMOVE:
2693 lun->delay_info.datamove_type =
2694 delay_info->delay_type;
2695 lun->delay_info.datamove_delay =
2696 delay_info->delay_secs;
2698 case CTL_DELAY_LOC_DONE:
2699 lun->delay_info.done_type =
2700 delay_info->delay_type;
2701 lun->delay_info.done_delay =
2702 delay_info->delay_secs;
2705 delay_info->status =
2706 CTL_DELAY_STATUS_INVALID_LOC;
2711 mtx_unlock(&softc->ctl_lock);
2713 delay_info->status = CTL_DELAY_STATUS_NOT_IMPLEMENTED;
2714 #endif /* CTL_IO_DELAY */
2717 case CTL_REALSYNC_SET: {
2720 syncstate = (int *)addr;
2722 mtx_lock(&softc->ctl_lock);
2723 switch (*syncstate) {
2725 softc->flags &= ~CTL_FLAG_REAL_SYNC;
2728 softc->flags |= CTL_FLAG_REAL_SYNC;
2734 mtx_unlock(&softc->ctl_lock);
2737 case CTL_REALSYNC_GET: {
2740 syncstate = (int*)addr;
2742 mtx_lock(&softc->ctl_lock);
2743 if (softc->flags & CTL_FLAG_REAL_SYNC)
2747 mtx_unlock(&softc->ctl_lock);
2753 struct ctl_sync_info *sync_info;
2754 struct ctl_lun *lun;
2756 sync_info = (struct ctl_sync_info *)addr;
2758 mtx_lock(&softc->ctl_lock);
2759 lun = softc->ctl_luns[sync_info->lun_id];
2761 mtx_unlock(&softc->ctl_lock);
2762 sync_info->status = CTL_GS_SYNC_NO_LUN;
2765 * Get or set the sync interval. We're not bounds checking
2766 * in the set case, hopefully the user won't do something
2769 if (cmd == CTL_GETSYNC)
2770 sync_info->sync_interval = lun->sync_interval;
2772 lun->sync_interval = sync_info->sync_interval;
2774 mtx_unlock(&softc->ctl_lock);
2776 sync_info->status = CTL_GS_SYNC_OK;
2780 case CTL_GETSTATS: {
2781 struct ctl_stats *stats;
2782 struct ctl_lun *lun;
2785 stats = (struct ctl_stats *)addr;
2787 if ((sizeof(struct ctl_lun_io_stats) * softc->num_luns) >
2789 stats->status = CTL_SS_NEED_MORE_SPACE;
2790 stats->num_luns = softc->num_luns;
2794 * XXX KDM no locking here. If the LUN list changes,
2795 * things can blow up.
2797 for (i = 0, lun = STAILQ_FIRST(&softc->lun_list); lun != NULL;
2798 i++, lun = STAILQ_NEXT(lun, links)) {
2799 retval = copyout(&lun->stats, &stats->lun_stats[i],
2800 sizeof(lun->stats));
2804 stats->num_luns = softc->num_luns;
2805 stats->fill_len = sizeof(struct ctl_lun_io_stats) *
2807 stats->status = CTL_SS_OK;
2809 stats->flags = CTL_STATS_FLAG_TIME_VALID;
2811 stats->flags = CTL_STATS_FLAG_NONE;
2813 getnanouptime(&stats->timestamp);
2816 case CTL_ERROR_INJECT: {
2817 struct ctl_error_desc *err_desc, *new_err_desc;
2818 struct ctl_lun *lun;
2820 err_desc = (struct ctl_error_desc *)addr;
2822 new_err_desc = malloc(sizeof(*new_err_desc), M_CTL,
2824 bcopy(err_desc, new_err_desc, sizeof(*new_err_desc));
2826 mtx_lock(&softc->ctl_lock);
2827 lun = softc->ctl_luns[err_desc->lun_id];
2829 mtx_unlock(&softc->ctl_lock);
2830 printf("%s: CTL_ERROR_INJECT: invalid LUN %ju\n",
2831 __func__, (uintmax_t)err_desc->lun_id);
2837 * We could do some checking here to verify the validity
2838 * of the request, but given the complexity of error
2839 * injection requests, the checking logic would be fairly
2842 * For now, if the request is invalid, it just won't get
2843 * executed and might get deleted.
2845 STAILQ_INSERT_TAIL(&lun->error_list, new_err_desc, links);
2848 * XXX KDM check to make sure the serial number is unique,
2849 * in case we somehow manage to wrap. That shouldn't
2850 * happen for a very long time, but it's the right thing to
2853 new_err_desc->serial = lun->error_serial;
2854 err_desc->serial = lun->error_serial;
2855 lun->error_serial++;
2857 mtx_unlock(&softc->ctl_lock);
2860 case CTL_ERROR_INJECT_DELETE: {
2861 struct ctl_error_desc *delete_desc, *desc, *desc2;
2862 struct ctl_lun *lun;
2865 delete_desc = (struct ctl_error_desc *)addr;
2868 mtx_lock(&softc->ctl_lock);
2869 lun = softc->ctl_luns[delete_desc->lun_id];
2871 mtx_unlock(&softc->ctl_lock);
2872 printf("%s: CTL_ERROR_INJECT_DELETE: invalid LUN %ju\n",
2873 __func__, (uintmax_t)delete_desc->lun_id);
2877 STAILQ_FOREACH_SAFE(desc, &lun->error_list, links, desc2) {
2878 if (desc->serial != delete_desc->serial)
2881 STAILQ_REMOVE(&lun->error_list, desc, ctl_error_desc,
2886 mtx_unlock(&softc->ctl_lock);
2887 if (delete_done == 0) {
2888 printf("%s: CTL_ERROR_INJECT_DELETE: can't find "
2889 "error serial %ju on LUN %u\n", __func__,
2890 delete_desc->serial, delete_desc->lun_id);
2896 case CTL_DUMP_STRUCTS: {
2898 struct ctl_frontend *fe;
2900 printf("CTL IID to WWPN map start:\n");
2901 for (i = 0; i < CTL_MAX_PORTS; i++) {
2902 for (j = 0; j < CTL_MAX_INIT_PER_PORT; j++) {
2903 if (softc->wwpn_iid[i][j].in_use == 0)
2906 printf("port %d iid %u WWPN %#jx\n",
2907 softc->wwpn_iid[i][j].port,
2908 softc->wwpn_iid[i][j].iid,
2909 (uintmax_t)softc->wwpn_iid[i][j].wwpn);
2912 printf("CTL IID to WWPN map end\n");
2913 printf("CTL Persistent Reservation information start:\n");
2914 for (i = 0; i < CTL_MAX_LUNS; i++) {
2915 struct ctl_lun *lun;
2917 lun = softc->ctl_luns[i];
2920 || ((lun->flags & CTL_LUN_DISABLED) != 0))
2923 for (j = 0; j < (CTL_MAX_PORTS * 2); j++) {
2924 for (k = 0; k < CTL_MAX_INIT_PER_PORT; k++){
2925 if (lun->per_res[j+k].registered == 0)
2927 printf("LUN %d port %d iid %d key "
2929 (uintmax_t)scsi_8btou64(
2930 lun->per_res[j+k].res_key.key));
2934 printf("CTL Persistent Reservation information end\n");
2935 printf("CTL Frontends:\n");
2937 * XXX KDM calling this without a lock. We'd likely want
2938 * to drop the lock before calling the frontend's dump
2941 STAILQ_FOREACH(fe, &softc->fe_list, links) {
2942 printf("Frontend %s Type %u pport %d vport %d WWNN "
2943 "%#jx WWPN %#jx\n", fe->port_name, fe->port_type,
2944 fe->physical_port, fe->virtual_port,
2945 (uintmax_t)fe->wwnn, (uintmax_t)fe->wwpn);
2948 * Frontends are not required to support the dump
2951 if (fe->fe_dump == NULL)
2956 printf("CTL Frontend information end\n");
2960 struct ctl_lun_req *lun_req;
2961 struct ctl_backend_driver *backend;
2963 lun_req = (struct ctl_lun_req *)addr;
2965 backend = ctl_backend_find(lun_req->backend);
2966 if (backend == NULL) {
2967 lun_req->status = CTL_LUN_ERROR;
2968 snprintf(lun_req->error_str,
2969 sizeof(lun_req->error_str),
2970 "Backend \"%s\" not found.",
2974 if (lun_req->num_be_args > 0) {
2975 lun_req->kern_be_args = ctl_copyin_args(
2976 lun_req->num_be_args,
2979 sizeof(lun_req->error_str));
2980 if (lun_req->kern_be_args == NULL) {
2981 lun_req->status = CTL_LUN_ERROR;
2986 retval = backend->ioctl(dev, cmd, addr, flag, td);
2988 if (lun_req->num_be_args > 0) {
2989 ctl_free_args(lun_req->num_be_args,
2990 lun_req->kern_be_args);
2994 case CTL_LUN_LIST: {
2996 struct ctl_lun *lun;
2997 struct ctl_lun_list *list;
2998 struct ctl_be_lun_option *opt;
3000 list = (struct ctl_lun_list *)addr;
3003 * Allocate a fixed length sbuf here, based on the length
3004 * of the user's buffer. We could allocate an auto-extending
3005 * buffer, and then tell the user how much larger our
3006 * amount of data is than his buffer, but that presents
3009 * 1. The sbuf(9) routines use a blocking malloc, and so
3010 * we can't hold a lock while calling them with an
3011 * auto-extending buffer.
3013 * 2. There is not currently a LUN reference counting
3014 * mechanism, outside of outstanding transactions on
3015 * the LUN's OOA queue. So a LUN could go away on us
3016 * while we're getting the LUN number, backend-specific
3017 * information, etc. Thus, given the way things
3018 * currently work, we need to hold the CTL lock while
3019 * grabbing LUN information.
3021 * So, from the user's standpoint, the best thing to do is
3022 * allocate what he thinks is a reasonable buffer length,
3023 * and then if he gets a CTL_LUN_LIST_NEED_MORE_SPACE error,
3024 * double the buffer length and try again. (And repeat
3025 * that until he succeeds.)
3027 sb = sbuf_new(NULL, NULL, list->alloc_len, SBUF_FIXEDLEN);
3029 list->status = CTL_LUN_LIST_ERROR;
3030 snprintf(list->error_str, sizeof(list->error_str),
3031 "Unable to allocate %d bytes for LUN list",
3036 sbuf_printf(sb, "<ctllunlist>\n");
3038 mtx_lock(&softc->ctl_lock);
3040 STAILQ_FOREACH(lun, &softc->lun_list, links) {
3041 retval = sbuf_printf(sb, "<lun id=\"%ju\">\n",
3042 (uintmax_t)lun->lun);
3045 * Bail out as soon as we see that we've overfilled
3051 retval = sbuf_printf(sb, "<backend_type>%s"
3052 "</backend_type>\n",
3053 (lun->backend == NULL) ? "none" :
3054 lun->backend->name);
3059 retval = sbuf_printf(sb, "<lun_type>%d</lun_type>\n",
3060 lun->be_lun->lun_type);
3065 if (lun->backend == NULL) {
3066 retval = sbuf_printf(sb, "</lun>\n");
3072 retval = sbuf_printf(sb, "<size>%ju</size>\n",
3073 (lun->be_lun->maxlba > 0) ?
3074 lun->be_lun->maxlba + 1 : 0);
3079 retval = sbuf_printf(sb, "<blocksize>%u</blocksize>\n",
3080 lun->be_lun->blocksize);
3085 retval = sbuf_printf(sb, "<serial_number>");
3090 retval = ctl_sbuf_printf_esc(sb,
3091 lun->be_lun->serial_num);
3096 retval = sbuf_printf(sb, "</serial_number>\n");
3101 retval = sbuf_printf(sb, "<device_id>");
3106 retval = ctl_sbuf_printf_esc(sb,lun->be_lun->device_id);
3111 retval = sbuf_printf(sb, "</device_id>\n");
3116 if (lun->backend->lun_info != NULL) {
3117 retval = lun->backend->lun_info(lun->be_lun->be_lun, sb);
3121 STAILQ_FOREACH(opt, &lun->be_lun->options, links) {
3122 retval = sbuf_printf(sb, "<%s>%s</%s>", opt->name, opt->value, opt->name);
3127 retval = sbuf_printf(sb, "</lun>\n");
3132 mtx_unlock(&softc->ctl_lock);
3135 || ((retval = sbuf_printf(sb, "</ctllunlist>\n")) != 0)) {
3138 list->status = CTL_LUN_LIST_NEED_MORE_SPACE;
3139 snprintf(list->error_str, sizeof(list->error_str),
3140 "Out of space, %d bytes is too small",
3147 retval = copyout(sbuf_data(sb), list->lun_xml,
3150 list->fill_len = sbuf_len(sb) + 1;
3151 list->status = CTL_LUN_LIST_OK;
3156 struct ctl_iscsi *ci;
3157 struct ctl_frontend *fe;
3159 ci = (struct ctl_iscsi *)addr;
3161 mtx_lock(&softc->ctl_lock);
3162 STAILQ_FOREACH(fe, &softc->fe_list, links) {
3163 if (strcmp(fe->port_name, "iscsi") == 0)
3166 mtx_unlock(&softc->ctl_lock);
3169 ci->status = CTL_ISCSI_ERROR;
3170 snprintf(ci->error_str, sizeof(ci->error_str), "Backend \"iscsi\" not found.");
3174 retval = fe->ioctl(dev, cmd, addr, flag, td);
3178 /* XXX KDM should we fix this? */
3180 struct ctl_backend_driver *backend;
3187 * We encode the backend type as the ioctl type for backend
3188 * ioctls. So parse it out here, and then search for a
3189 * backend of this type.
3191 type = _IOC_TYPE(cmd);
3193 STAILQ_FOREACH(backend, &softc->be_list, links) {
3194 if (backend->type == type) {
3200 printf("ctl: unknown ioctl command %#lx or backend "
3205 retval = backend->ioctl(dev, cmd, addr, flag, td);
3215 ctl_get_initindex(struct ctl_nexus *nexus)
3217 if (nexus->targ_port < CTL_MAX_PORTS)
3218 return (nexus->initid.id +
3219 (nexus->targ_port * CTL_MAX_INIT_PER_PORT));
3221 return (nexus->initid.id +
3222 ((nexus->targ_port - CTL_MAX_PORTS) *
3223 CTL_MAX_INIT_PER_PORT));
3227 ctl_get_resindex(struct ctl_nexus *nexus)
3229 return (nexus->initid.id + (nexus->targ_port * CTL_MAX_INIT_PER_PORT));
3233 ctl_port_idx(int port_num)
3235 if (port_num < CTL_MAX_PORTS)
3238 return(port_num - CTL_MAX_PORTS);
3242 * Note: This only works for bitmask sizes that are at least 32 bits, and
3243 * that are a power of 2.
3246 ctl_ffz(uint32_t *mask, uint32_t size)
3248 uint32_t num_chunks, num_pieces;
3251 num_chunks = (size >> 5);
3252 if (num_chunks == 0)
3254 num_pieces = ctl_min((sizeof(uint32_t) * 8), size);
3256 for (i = 0; i < num_chunks; i++) {
3257 for (j = 0; j < num_pieces; j++) {
3258 if ((mask[i] & (1 << j)) == 0)
3259 return ((i << 5) + j);
3267 ctl_set_mask(uint32_t *mask, uint32_t bit)
3269 uint32_t chunk, piece;
3272 piece = bit % (sizeof(uint32_t) * 8);
3274 if ((mask[chunk] & (1 << piece)) != 0)
3277 mask[chunk] |= (1 << piece);
3283 ctl_clear_mask(uint32_t *mask, uint32_t bit)
3285 uint32_t chunk, piece;
3288 piece = bit % (sizeof(uint32_t) * 8);
3290 if ((mask[chunk] & (1 << piece)) == 0)
3293 mask[chunk] &= ~(1 << piece);
3299 ctl_is_set(uint32_t *mask, uint32_t bit)
3301 uint32_t chunk, piece;
3304 piece = bit % (sizeof(uint32_t) * 8);
3306 if ((mask[chunk] & (1 << piece)) == 0)
3314 * The bus, target and lun are optional, they can be filled in later.
3315 * can_wait is used to determine whether we can wait on the malloc or not.
3318 ctl_malloc_io(ctl_io_type io_type, uint32_t targ_port, uint32_t targ_target,
3319 uint32_t targ_lun, int can_wait)
3324 io = (union ctl_io *)malloc(sizeof(*io), M_CTL, M_WAITOK);
3326 io = (union ctl_io *)malloc(sizeof(*io), M_CTL, M_NOWAIT);
3329 io->io_hdr.io_type = io_type;
3330 io->io_hdr.targ_port = targ_port;
3332 * XXX KDM this needs to change/go away. We need to move
3333 * to a preallocated pool of ctl_scsiio structures.
3335 io->io_hdr.nexus.targ_target.id = targ_target;
3336 io->io_hdr.nexus.targ_lun = targ_lun;
3343 ctl_kfree_io(union ctl_io *io)
3350 * ctl_softc, pool_type, total_ctl_io are passed in.
3351 * npool is passed out.
3354 ctl_pool_create(struct ctl_softc *ctl_softc, ctl_pool_type pool_type,
3355 uint32_t total_ctl_io, struct ctl_io_pool **npool)
3358 union ctl_io *cur_io, *next_io;
3359 struct ctl_io_pool *pool;
3364 pool = (struct ctl_io_pool *)malloc(sizeof(*pool), M_CTL,
3371 pool->type = pool_type;
3372 pool->ctl_softc = ctl_softc;
3374 mtx_lock(&ctl_softc->pool_lock);
3375 pool->id = ctl_softc->cur_pool_id++;
3376 mtx_unlock(&ctl_softc->pool_lock);
3378 pool->flags = CTL_POOL_FLAG_NONE;
3379 pool->refcount = 1; /* Reference for validity. */
3380 STAILQ_INIT(&pool->free_queue);
3383 * XXX KDM other options here:
3384 * - allocate a page at a time
3385 * - allocate one big chunk of memory.
3386 * Page allocation might work well, but would take a little more
3389 for (i = 0; i < total_ctl_io; i++) {
3390 cur_io = (union ctl_io *)malloc(sizeof(*cur_io), M_CTL,
3392 if (cur_io == NULL) {
3396 cur_io->io_hdr.pool = pool;
3397 STAILQ_INSERT_TAIL(&pool->free_queue, &cur_io->io_hdr, links);
3398 pool->total_ctl_io++;
3399 pool->free_ctl_io++;
3403 for (cur_io = (union ctl_io *)STAILQ_FIRST(&pool->free_queue);
3404 cur_io != NULL; cur_io = next_io) {
3405 next_io = (union ctl_io *)STAILQ_NEXT(&cur_io->io_hdr,
3407 STAILQ_REMOVE(&pool->free_queue, &cur_io->io_hdr,
3409 free(cur_io, M_CTL);
3415 mtx_lock(&ctl_softc->pool_lock);
3416 ctl_softc->num_pools++;
3417 STAILQ_INSERT_TAIL(&ctl_softc->io_pools, pool, links);
3419 * Increment our usage count if this is an external consumer, so we
3420 * can't get unloaded until the external consumer (most likely a
3421 * FETD) unloads and frees his pool.
3423 * XXX KDM will this increment the caller's module use count, or
3427 if ((pool_type != CTL_POOL_EMERGENCY)
3428 && (pool_type != CTL_POOL_INTERNAL)
3429 && (pool_type != CTL_POOL_IOCTL)
3430 && (pool_type != CTL_POOL_4OTHERSC))
3434 mtx_unlock(&ctl_softc->pool_lock);
3444 ctl_pool_acquire(struct ctl_io_pool *pool)
3447 mtx_assert(&pool->ctl_softc->pool_lock, MA_OWNED);
3449 if (pool->flags & CTL_POOL_FLAG_INVALID)
3458 ctl_pool_release(struct ctl_io_pool *pool)
3460 struct ctl_softc *ctl_softc = pool->ctl_softc;
3463 mtx_assert(&ctl_softc->pool_lock, MA_OWNED);
3465 if (--pool->refcount != 0)
3468 while ((io = (union ctl_io *)STAILQ_FIRST(&pool->free_queue)) != NULL) {
3469 STAILQ_REMOVE(&pool->free_queue, &io->io_hdr, ctl_io_hdr,
3474 STAILQ_REMOVE(&ctl_softc->io_pools, pool, ctl_io_pool, links);
3475 ctl_softc->num_pools--;
3478 * XXX KDM will this decrement the caller's usage count or mine?
3481 if ((pool->type != CTL_POOL_EMERGENCY)
3482 && (pool->type != CTL_POOL_INTERNAL)
3483 && (pool->type != CTL_POOL_IOCTL))
3491 ctl_pool_free(struct ctl_io_pool *pool)
3493 struct ctl_softc *ctl_softc;
3498 ctl_softc = pool->ctl_softc;
3499 mtx_lock(&ctl_softc->pool_lock);
3500 pool->flags |= CTL_POOL_FLAG_INVALID;
3501 ctl_pool_release(pool);
3502 mtx_unlock(&ctl_softc->pool_lock);
3506 * This routine does not block (except for spinlocks of course).
3507 * It tries to allocate a ctl_io union from the caller's pool as quickly as
3511 ctl_alloc_io(void *pool_ref)
3514 struct ctl_softc *ctl_softc;
3515 struct ctl_io_pool *pool, *npool;
3516 struct ctl_io_pool *emergency_pool;
3518 pool = (struct ctl_io_pool *)pool_ref;
3521 printf("%s: pool is NULL\n", __func__);
3525 emergency_pool = NULL;
3527 ctl_softc = pool->ctl_softc;
3529 mtx_lock(&ctl_softc->pool_lock);
3531 * First, try to get the io structure from the user's pool.
3533 if (ctl_pool_acquire(pool) == 0) {
3534 io = (union ctl_io *)STAILQ_FIRST(&pool->free_queue);
3536 STAILQ_REMOVE_HEAD(&pool->free_queue, links);
3537 pool->total_allocated++;
3538 pool->free_ctl_io--;
3539 mtx_unlock(&ctl_softc->pool_lock);
3542 ctl_pool_release(pool);
3545 * If he doesn't have any io structures left, search for an
3546 * emergency pool and grab one from there.
3548 STAILQ_FOREACH(npool, &ctl_softc->io_pools, links) {
3549 if (npool->type != CTL_POOL_EMERGENCY)
3552 if (ctl_pool_acquire(npool) != 0)
3555 emergency_pool = npool;
3557 io = (union ctl_io *)STAILQ_FIRST(&npool->free_queue);
3559 STAILQ_REMOVE_HEAD(&npool->free_queue, links);
3560 npool->total_allocated++;
3561 npool->free_ctl_io--;
3562 mtx_unlock(&ctl_softc->pool_lock);
3565 ctl_pool_release(npool);
3568 /* Drop the spinlock before we malloc */
3569 mtx_unlock(&ctl_softc->pool_lock);
3572 * The emergency pool (if it exists) didn't have one, so try an
3573 * atomic (i.e. nonblocking) malloc and see if we get lucky.
3575 io = (union ctl_io *)malloc(sizeof(*io), M_CTL, M_NOWAIT);
3578 * If the emergency pool exists but is empty, add this
3579 * ctl_io to its list when it gets freed.
3581 if (emergency_pool != NULL) {
3582 mtx_lock(&ctl_softc->pool_lock);
3583 if (ctl_pool_acquire(emergency_pool) == 0) {
3584 io->io_hdr.pool = emergency_pool;
3585 emergency_pool->total_ctl_io++;
3587 * Need to bump this, otherwise
3588 * total_allocated and total_freed won't
3589 * match when we no longer have anything
3592 emergency_pool->total_allocated++;
3594 mtx_unlock(&ctl_softc->pool_lock);
3596 io->io_hdr.pool = NULL;
3603 ctl_free_io(union ctl_io *io)
3609 * If this ctl_io has a pool, return it to that pool.
3611 if (io->io_hdr.pool != NULL) {
3612 struct ctl_io_pool *pool;
3614 struct ctl_softc *ctl_softc;
3615 union ctl_io *tmp_io;
3616 unsigned long xflags;
3619 ctl_softc = control_softc;
3622 pool = (struct ctl_io_pool *)io->io_hdr.pool;
3624 mtx_lock(&pool->ctl_softc->pool_lock);
3628 for (i = 0, tmp_io = (union ctl_io *)STAILQ_FIRST(
3629 &ctl_softc->task_queue); tmp_io != NULL; i++,
3630 tmp_io = (union ctl_io *)STAILQ_NEXT(&tmp_io->io_hdr,
3633 printf("%s: %p is still on the task queue!\n",
3635 printf("%s: (%d): type %d "
3636 "msg %d cdb %x iptl: "
3637 "%d:%d:%d:%d tag 0x%04x "
3640 tmp_io->io_hdr.io_type,
3641 tmp_io->io_hdr.msg_type,
3642 tmp_io->scsiio.cdb[0],
3643 tmp_io->io_hdr.nexus.initid.id,
3644 tmp_io->io_hdr.nexus.targ_port,
3645 tmp_io->io_hdr.nexus.targ_target.id,
3646 tmp_io->io_hdr.nexus.targ_lun,
3647 (tmp_io->io_hdr.io_type ==
3649 tmp_io->taskio.tag_num :
3650 tmp_io->scsiio.tag_num,
3652 panic("I/O still on the task queue!");
3656 io->io_hdr.io_type = 0xff;
3657 STAILQ_INSERT_TAIL(&pool->free_queue, &io->io_hdr, links);
3658 pool->total_freed++;
3659 pool->free_ctl_io++;
3660 ctl_pool_release(pool);
3661 mtx_unlock(&pool->ctl_softc->pool_lock);
3664 * Otherwise, just free it. We probably malloced it and
3665 * the emergency pool wasn't available.
3673 ctl_zero_io(union ctl_io *io)
3681 * May need to preserve linked list pointers at some point too.
3683 pool_ref = io->io_hdr.pool;
3685 memset(io, 0, sizeof(*io));
3687 io->io_hdr.pool = pool_ref;
3691 * This routine is currently used for internal copies of ctl_ios that need
3692 * to persist for some reason after we've already returned status to the
3693 * FETD. (Thus the flag set.)
3696 * Note that this makes a blind copy of all fields in the ctl_io, except
3697 * for the pool reference. This includes any memory that has been
3698 * allocated! That memory will no longer be valid after done has been
3699 * called, so this would be VERY DANGEROUS for command that actually does
3700 * any reads or writes. Right now (11/7/2005), this is only used for immediate
3701 * start and stop commands, which don't transfer any data, so this is not a
3702 * problem. If it is used for anything else, the caller would also need to
3703 * allocate data buffer space and this routine would need to be modified to
3704 * copy the data buffer(s) as well.
3707 ctl_copy_io(union ctl_io *src, union ctl_io *dest)
3716 * May need to preserve linked list pointers at some point too.
3718 pool_ref = dest->io_hdr.pool;
3720 memcpy(dest, src, ctl_min(sizeof(*src), sizeof(*dest)));
3722 dest->io_hdr.pool = pool_ref;
3724 * We need to know that this is an internal copy, and doesn't need
3725 * to get passed back to the FETD that allocated it.
3727 dest->io_hdr.flags |= CTL_FLAG_INT_COPY;
3732 ctl_update_power_subpage(struct copan_power_subpage *page)
3734 int num_luns, num_partitions, config_type;
3735 struct ctl_softc *softc;
3736 cs_BOOL_t aor_present, shelf_50pct_power;
3737 cs_raidset_personality_t rs_type;
3738 int max_active_luns;
3740 softc = control_softc;
3742 /* subtract out the processor LUN */
3743 num_luns = softc->num_luns - 1;
3745 * Default to 7 LUNs active, which was the only number we allowed
3748 max_active_luns = 7;
3750 num_partitions = config_GetRsPartitionInfo();
3751 config_type = config_GetConfigType();
3752 shelf_50pct_power = config_GetShelfPowerMode();
3753 aor_present = config_IsAorRsPresent();
3755 rs_type = ddb_GetRsRaidType(1);
3756 if ((rs_type != CS_RAIDSET_PERSONALITY_RAID5)
3757 && (rs_type != CS_RAIDSET_PERSONALITY_RAID1)) {
3758 EPRINT(0, "Unsupported RS type %d!", rs_type);
3762 page->total_luns = num_luns;
3764 switch (config_type) {
3767 * In a 40 drive configuration, it doesn't matter what DC
3768 * cards we have, whether we have AOR enabled or not,
3769 * partitioning or not, or what type of RAIDset we have.
3770 * In that scenario, we can power up every LUN we present
3773 max_active_luns = num_luns;
3777 if (shelf_50pct_power == CS_FALSE) {
3779 if (aor_present == CS_TRUE) {
3781 CS_RAIDSET_PERSONALITY_RAID5) {
3782 max_active_luns = 7;
3783 } else if (rs_type ==
3784 CS_RAIDSET_PERSONALITY_RAID1){
3785 max_active_luns = 14;
3787 /* XXX KDM now what?? */
3791 CS_RAIDSET_PERSONALITY_RAID5) {
3792 max_active_luns = 8;
3793 } else if (rs_type ==
3794 CS_RAIDSET_PERSONALITY_RAID1){
3795 max_active_luns = 16;
3797 /* XXX KDM now what?? */
3803 * With 50% power in a 64 drive configuration, we
3804 * can power all LUNs we present.
3806 max_active_luns = num_luns;
3810 if (shelf_50pct_power == CS_FALSE) {
3812 if (aor_present == CS_TRUE) {
3814 CS_RAIDSET_PERSONALITY_RAID5) {
3815 max_active_luns = 7;
3816 } else if (rs_type ==
3817 CS_RAIDSET_PERSONALITY_RAID1){
3818 max_active_luns = 14;
3820 /* XXX KDM now what?? */
3824 CS_RAIDSET_PERSONALITY_RAID5) {
3825 max_active_luns = 8;
3826 } else if (rs_type ==
3827 CS_RAIDSET_PERSONALITY_RAID1){
3828 max_active_luns = 16;
3830 /* XXX KDM now what?? */
3835 if (aor_present == CS_TRUE) {
3837 CS_RAIDSET_PERSONALITY_RAID5) {
3838 max_active_luns = 14;
3839 } else if (rs_type ==
3840 CS_RAIDSET_PERSONALITY_RAID1){
3842 * We're assuming here that disk
3843 * caching is enabled, and so we're
3844 * able to power up half of each
3845 * LUN, and cache all writes.
3847 max_active_luns = num_luns;
3849 /* XXX KDM now what?? */
3853 CS_RAIDSET_PERSONALITY_RAID5) {
3854 max_active_luns = 15;
3855 } else if (rs_type ==
3856 CS_RAIDSET_PERSONALITY_RAID1){
3857 max_active_luns = 30;
3859 /* XXX KDM now what?? */
3866 * In this case, we have an unknown configuration, so we
3867 * just use the default from above.
3872 page->max_active_luns = max_active_luns;
3874 printk("%s: total_luns = %d, max_active_luns = %d\n", __func__,
3875 page->total_luns, page->max_active_luns);
3878 #endif /* NEEDTOPORT */
3881 * This routine could be used in the future to load default and/or saved
3882 * mode page parameters for a particuar lun.
3885 ctl_init_page_index(struct ctl_lun *lun)
3888 struct ctl_page_index *page_index;
3889 struct ctl_softc *softc;
3891 memcpy(&lun->mode_pages.index, page_index_template,
3892 sizeof(page_index_template));
3894 softc = lun->ctl_softc;
3896 for (i = 0; i < CTL_NUM_MODE_PAGES; i++) {
3898 page_index = &lun->mode_pages.index[i];
3900 * If this is a disk-only mode page, there's no point in
3901 * setting it up. For some pages, we have to have some
3902 * basic information about the disk in order to calculate the
3905 if ((lun->be_lun->lun_type != T_DIRECT)
3906 && (page_index->page_flags & CTL_PAGE_FLAG_DISK_ONLY))
3909 switch (page_index->page_code & SMPH_PC_MASK) {
3910 case SMS_FORMAT_DEVICE_PAGE: {
3911 struct scsi_format_page *format_page;
3913 if (page_index->subpage != SMS_SUBPAGE_PAGE_0)
3914 panic("subpage is incorrect!");
3917 * Sectors per track are set above. Bytes per
3918 * sector need to be set here on a per-LUN basis.
3920 memcpy(&lun->mode_pages.format_page[CTL_PAGE_CURRENT],
3921 &format_page_default,
3922 sizeof(format_page_default));
3923 memcpy(&lun->mode_pages.format_page[
3924 CTL_PAGE_CHANGEABLE], &format_page_changeable,
3925 sizeof(format_page_changeable));
3926 memcpy(&lun->mode_pages.format_page[CTL_PAGE_DEFAULT],
3927 &format_page_default,
3928 sizeof(format_page_default));
3929 memcpy(&lun->mode_pages.format_page[CTL_PAGE_SAVED],
3930 &format_page_default,
3931 sizeof(format_page_default));
3933 format_page = &lun->mode_pages.format_page[
3935 scsi_ulto2b(lun->be_lun->blocksize,
3936 format_page->bytes_per_sector);
3938 format_page = &lun->mode_pages.format_page[
3940 scsi_ulto2b(lun->be_lun->blocksize,
3941 format_page->bytes_per_sector);
3943 format_page = &lun->mode_pages.format_page[
3945 scsi_ulto2b(lun->be_lun->blocksize,
3946 format_page->bytes_per_sector);
3948 page_index->page_data =
3949 (uint8_t *)lun->mode_pages.format_page;
3952 case SMS_RIGID_DISK_PAGE: {
3953 struct scsi_rigid_disk_page *rigid_disk_page;
3954 uint32_t sectors_per_cylinder;
3958 #endif /* !__XSCALE__ */
3960 if (page_index->subpage != SMS_SUBPAGE_PAGE_0)
3961 panic("invalid subpage value %d",
3962 page_index->subpage);
3965 * Rotation rate and sectors per track are set
3966 * above. We calculate the cylinders here based on
3967 * capacity. Due to the number of heads and
3968 * sectors per track we're using, smaller arrays
3969 * may turn out to have 0 cylinders. Linux and
3970 * FreeBSD don't pay attention to these mode pages
3971 * to figure out capacity, but Solaris does. It
3972 * seems to deal with 0 cylinders just fine, and
3973 * works out a fake geometry based on the capacity.
3975 memcpy(&lun->mode_pages.rigid_disk_page[
3976 CTL_PAGE_CURRENT], &rigid_disk_page_default,
3977 sizeof(rigid_disk_page_default));
3978 memcpy(&lun->mode_pages.rigid_disk_page[
3979 CTL_PAGE_CHANGEABLE],&rigid_disk_page_changeable,
3980 sizeof(rigid_disk_page_changeable));
3981 memcpy(&lun->mode_pages.rigid_disk_page[
3982 CTL_PAGE_DEFAULT], &rigid_disk_page_default,
3983 sizeof(rigid_disk_page_default));
3984 memcpy(&lun->mode_pages.rigid_disk_page[
3985 CTL_PAGE_SAVED], &rigid_disk_page_default,
3986 sizeof(rigid_disk_page_default));
3988 sectors_per_cylinder = CTL_DEFAULT_SECTORS_PER_TRACK *
3992 * The divide method here will be more accurate,
3993 * probably, but results in floating point being
3994 * used in the kernel on i386 (__udivdi3()). On the
3995 * XScale, though, __udivdi3() is implemented in
3998 * The shift method for cylinder calculation is
3999 * accurate if sectors_per_cylinder is a power of
4000 * 2. Otherwise it might be slightly off -- you
4001 * might have a bit of a truncation problem.
4004 cylinders = (lun->be_lun->maxlba + 1) /
4005 sectors_per_cylinder;
4007 for (shift = 31; shift > 0; shift--) {
4008 if (sectors_per_cylinder & (1 << shift))
4011 cylinders = (lun->be_lun->maxlba + 1) >> shift;
4015 * We've basically got 3 bytes, or 24 bits for the
4016 * cylinder size in the mode page. If we're over,
4017 * just round down to 2^24.
4019 if (cylinders > 0xffffff)
4020 cylinders = 0xffffff;
4022 rigid_disk_page = &lun->mode_pages.rigid_disk_page[
4024 scsi_ulto3b(cylinders, rigid_disk_page->cylinders);
4026 rigid_disk_page = &lun->mode_pages.rigid_disk_page[
4028 scsi_ulto3b(cylinders, rigid_disk_page->cylinders);
4030 rigid_disk_page = &lun->mode_pages.rigid_disk_page[
4032 scsi_ulto3b(cylinders, rigid_disk_page->cylinders);
4034 page_index->page_data =
4035 (uint8_t *)lun->mode_pages.rigid_disk_page;
4038 case SMS_CACHING_PAGE: {
4040 if (page_index->subpage != SMS_SUBPAGE_PAGE_0)
4041 panic("invalid subpage value %d",
4042 page_index->subpage);
4044 * Defaults should be okay here, no calculations
4047 memcpy(&lun->mode_pages.caching_page[CTL_PAGE_CURRENT],
4048 &caching_page_default,
4049 sizeof(caching_page_default));
4050 memcpy(&lun->mode_pages.caching_page[
4051 CTL_PAGE_CHANGEABLE], &caching_page_changeable,
4052 sizeof(caching_page_changeable));
4053 memcpy(&lun->mode_pages.caching_page[CTL_PAGE_DEFAULT],
4054 &caching_page_default,
4055 sizeof(caching_page_default));
4056 memcpy(&lun->mode_pages.caching_page[CTL_PAGE_SAVED],
4057 &caching_page_default,
4058 sizeof(caching_page_default));
4059 page_index->page_data =
4060 (uint8_t *)lun->mode_pages.caching_page;
4063 case SMS_CONTROL_MODE_PAGE: {
4065 if (page_index->subpage != SMS_SUBPAGE_PAGE_0)
4066 panic("invalid subpage value %d",
4067 page_index->subpage);
4070 * Defaults should be okay here, no calculations
4073 memcpy(&lun->mode_pages.control_page[CTL_PAGE_CURRENT],
4074 &control_page_default,
4075 sizeof(control_page_default));
4076 memcpy(&lun->mode_pages.control_page[
4077 CTL_PAGE_CHANGEABLE], &control_page_changeable,
4078 sizeof(control_page_changeable));
4079 memcpy(&lun->mode_pages.control_page[CTL_PAGE_DEFAULT],
4080 &control_page_default,
4081 sizeof(control_page_default));
4082 memcpy(&lun->mode_pages.control_page[CTL_PAGE_SAVED],
4083 &control_page_default,
4084 sizeof(control_page_default));
4085 page_index->page_data =
4086 (uint8_t *)lun->mode_pages.control_page;
4090 case SMS_VENDOR_SPECIFIC_PAGE:{
4091 switch (page_index->subpage) {
4092 case PWR_SUBPAGE_CODE: {
4093 struct copan_power_subpage *current_page,
4096 memcpy(&lun->mode_pages.power_subpage[
4098 &power_page_default,
4099 sizeof(power_page_default));
4100 memcpy(&lun->mode_pages.power_subpage[
4101 CTL_PAGE_CHANGEABLE],
4102 &power_page_changeable,
4103 sizeof(power_page_changeable));
4104 memcpy(&lun->mode_pages.power_subpage[
4106 &power_page_default,
4107 sizeof(power_page_default));
4108 memcpy(&lun->mode_pages.power_subpage[
4110 &power_page_default,
4111 sizeof(power_page_default));
4112 page_index->page_data =
4113 (uint8_t *)lun->mode_pages.power_subpage;
4115 current_page = (struct copan_power_subpage *)
4116 (page_index->page_data +
4117 (page_index->page_len *
4119 saved_page = (struct copan_power_subpage *)
4120 (page_index->page_data +
4121 (page_index->page_len *
4125 case APS_SUBPAGE_CODE: {
4126 struct copan_aps_subpage *current_page,
4129 // This gets set multiple times but
4130 // it should always be the same. It's
4131 // only done during init so who cares.
4132 index_to_aps_page = i;
4134 memcpy(&lun->mode_pages.aps_subpage[
4137 sizeof(aps_page_default));
4138 memcpy(&lun->mode_pages.aps_subpage[
4139 CTL_PAGE_CHANGEABLE],
4140 &aps_page_changeable,
4141 sizeof(aps_page_changeable));
4142 memcpy(&lun->mode_pages.aps_subpage[
4145 sizeof(aps_page_default));
4146 memcpy(&lun->mode_pages.aps_subpage[
4149 sizeof(aps_page_default));
4150 page_index->page_data =
4151 (uint8_t *)lun->mode_pages.aps_subpage;
4153 current_page = (struct copan_aps_subpage *)
4154 (page_index->page_data +
4155 (page_index->page_len *
4157 saved_page = (struct copan_aps_subpage *)
4158 (page_index->page_data +
4159 (page_index->page_len *
4163 case DBGCNF_SUBPAGE_CODE: {
4164 struct copan_debugconf_subpage *current_page,
4167 memcpy(&lun->mode_pages.debugconf_subpage[
4169 &debugconf_page_default,
4170 sizeof(debugconf_page_default));
4171 memcpy(&lun->mode_pages.debugconf_subpage[
4172 CTL_PAGE_CHANGEABLE],
4173 &debugconf_page_changeable,
4174 sizeof(debugconf_page_changeable));
4175 memcpy(&lun->mode_pages.debugconf_subpage[
4177 &debugconf_page_default,
4178 sizeof(debugconf_page_default));
4179 memcpy(&lun->mode_pages.debugconf_subpage[
4181 &debugconf_page_default,
4182 sizeof(debugconf_page_default));
4183 page_index->page_data =
4184 (uint8_t *)lun->mode_pages.debugconf_subpage;
4186 current_page = (struct copan_debugconf_subpage *)
4187 (page_index->page_data +
4188 (page_index->page_len *
4190 saved_page = (struct copan_debugconf_subpage *)
4191 (page_index->page_data +
4192 (page_index->page_len *
4197 panic("invalid subpage value %d",
4198 page_index->subpage);
4204 panic("invalid page value %d",
4205 page_index->page_code & SMPH_PC_MASK);
4210 return (CTL_RETVAL_COMPLETE);
4217 * - caller allocates and zeros LUN storage, or passes in a NULL LUN if he
4218 * wants us to allocate the LUN and he can block.
4219 * - ctl_softc is always set
4220 * - be_lun is set if the LUN has a backend (needed for disk LUNs)
4222 * Returns 0 for success, non-zero (errno) for failure.
4225 ctl_alloc_lun(struct ctl_softc *ctl_softc, struct ctl_lun *ctl_lun,
4226 struct ctl_be_lun *const be_lun, struct ctl_id target_id)
4228 struct ctl_lun *nlun, *lun;
4229 struct ctl_frontend *fe;
4230 int lun_number, i, lun_malloced;
4236 * We currently only support Direct Access or Processor LUN types.
4238 switch (be_lun->lun_type) {
4246 be_lun->lun_config_status(be_lun->be_lun,
4247 CTL_LUN_CONFIG_FAILURE);
4250 if (ctl_lun == NULL) {
4251 lun = malloc(sizeof(*lun), M_CTL, M_WAITOK);
4258 memset(lun, 0, sizeof(*lun));
4260 lun->flags = CTL_LUN_MALLOCED;
4262 mtx_lock(&ctl_softc->ctl_lock);
4264 * See if the caller requested a particular LUN number. If so, see
4265 * if it is available. Otherwise, allocate the first available LUN.
4267 if (be_lun->flags & CTL_LUN_FLAG_ID_REQ) {
4268 if ((be_lun->req_lun_id > (CTL_MAX_LUNS - 1))
4269 || (ctl_is_set(ctl_softc->ctl_lun_mask, be_lun->req_lun_id))) {
4270 mtx_unlock(&ctl_softc->ctl_lock);
4271 if (be_lun->req_lun_id > (CTL_MAX_LUNS - 1)) {
4272 printf("ctl: requested LUN ID %d is higher "
4273 "than CTL_MAX_LUNS - 1 (%d)\n",
4274 be_lun->req_lun_id, CTL_MAX_LUNS - 1);
4277 * XXX KDM return an error, or just assign
4278 * another LUN ID in this case??
4280 printf("ctl: requested LUN ID %d is already "
4281 "in use\n", be_lun->req_lun_id);
4283 if (lun->flags & CTL_LUN_MALLOCED)
4285 be_lun->lun_config_status(be_lun->be_lun,
4286 CTL_LUN_CONFIG_FAILURE);
4289 lun_number = be_lun->req_lun_id;
4291 lun_number = ctl_ffz(ctl_softc->ctl_lun_mask, CTL_MAX_LUNS);
4292 if (lun_number == -1) {
4293 mtx_unlock(&ctl_softc->ctl_lock);
4294 printf("ctl: can't allocate LUN on target %ju, out of "
4295 "LUNs\n", (uintmax_t)target_id.id);
4296 if (lun->flags & CTL_LUN_MALLOCED)
4298 be_lun->lun_config_status(be_lun->be_lun,
4299 CTL_LUN_CONFIG_FAILURE);
4303 ctl_set_mask(ctl_softc->ctl_lun_mask, lun_number);
4305 lun->target = target_id;
4306 lun->lun = lun_number;
4307 lun->be_lun = be_lun;
4309 * The processor LUN is always enabled. Disk LUNs come on line
4310 * disabled, and must be enabled by the backend.
4312 lun->flags |= CTL_LUN_DISABLED;
4313 lun->backend = be_lun->be;
4314 be_lun->ctl_lun = lun;
4315 be_lun->lun_id = lun_number;
4316 atomic_add_int(&be_lun->be->num_luns, 1);
4317 if (be_lun->flags & CTL_LUN_FLAG_POWERED_OFF)
4318 lun->flags |= CTL_LUN_STOPPED;
4320 if (be_lun->flags & CTL_LUN_FLAG_INOPERABLE)
4321 lun->flags |= CTL_LUN_INOPERABLE;
4323 if (be_lun->flags & CTL_LUN_FLAG_PRIMARY)
4324 lun->flags |= CTL_LUN_PRIMARY_SC;
4326 lun->ctl_softc = ctl_softc;
4327 TAILQ_INIT(&lun->ooa_queue);
4328 TAILQ_INIT(&lun->blocked_queue);
4329 STAILQ_INIT(&lun->error_list);
4332 * Initialize the mode page index.
4334 ctl_init_page_index(lun);
4337 * Set the poweron UA for all initiators on this LUN only.
4339 for (i = 0; i < CTL_MAX_INITIATORS; i++)
4340 lun->pending_sense[i].ua_pending = CTL_UA_POWERON;
4343 * Now, before we insert this lun on the lun list, set the lun
4344 * inventory changed UA for all other luns.
4346 STAILQ_FOREACH(nlun, &ctl_softc->lun_list, links) {
4347 for (i = 0; i < CTL_MAX_INITIATORS; i++) {
4348 nlun->pending_sense[i].ua_pending |= CTL_UA_LUN_CHANGE;
4352 STAILQ_INSERT_TAIL(&ctl_softc->lun_list, lun, links);
4354 ctl_softc->ctl_luns[lun_number] = lun;
4356 ctl_softc->num_luns++;
4358 /* Setup statistics gathering */
4359 lun->stats.device_type = be_lun->lun_type;
4360 lun->stats.lun_number = lun_number;
4361 if (lun->stats.device_type == T_DIRECT)
4362 lun->stats.blocksize = be_lun->blocksize;
4364 lun->stats.flags = CTL_LUN_STATS_NO_BLOCKSIZE;
4365 for (i = 0;i < CTL_MAX_PORTS;i++)
4366 lun->stats.ports[i].targ_port = i;
4368 mtx_unlock(&ctl_softc->ctl_lock);
4370 lun->be_lun->lun_config_status(lun->be_lun->be_lun, CTL_LUN_CONFIG_OK);
4373 * Run through each registered FETD and bring it online if it isn't
4374 * already. Enable the target ID if it hasn't been enabled, and
4375 * enable this particular LUN.
4377 STAILQ_FOREACH(fe, &ctl_softc->fe_list, links) {
4381 * XXX KDM this only works for ONE TARGET ID. We'll need
4382 * to do things differently if we go to a multiple target
4385 if ((fe->status & CTL_PORT_STATUS_TARG_ONLINE) == 0) {
4387 retval = fe->targ_enable(fe->targ_lun_arg, target_id);
4389 printf("ctl_alloc_lun: FETD %s port %d "
4390 "returned error %d for targ_enable on "
4391 "target %ju\n", fe->port_name,
4392 fe->targ_port, retval,
4393 (uintmax_t)target_id.id);
4395 fe->status |= CTL_PORT_STATUS_TARG_ONLINE;
4398 retval = fe->lun_enable(fe->targ_lun_arg, target_id,lun_number);
4400 printf("ctl_alloc_lun: FETD %s port %d returned error "
4401 "%d for lun_enable on target %ju lun %d\n",
4402 fe->port_name, fe->targ_port, retval,
4403 (uintmax_t)target_id.id, lun_number);
4405 fe->status |= CTL_PORT_STATUS_LUN_ONLINE;
4413 * - LUN has already been marked invalid and any pending I/O has been taken
4417 ctl_free_lun(struct ctl_lun *lun)
4419 struct ctl_softc *softc;
4421 struct ctl_frontend *fe;
4423 struct ctl_lun *nlun;
4424 union ctl_io *io, *next_io;
4427 softc = lun->ctl_softc;
4429 mtx_assert(&softc->ctl_lock, MA_OWNED);
4431 STAILQ_REMOVE(&softc->lun_list, lun, ctl_lun, links);
4433 ctl_clear_mask(softc->ctl_lun_mask, lun->lun);
4435 softc->ctl_luns[lun->lun] = NULL;
4437 if (TAILQ_FIRST(&lun->ooa_queue) != NULL) {
4438 printf("ctl_free_lun: aieee!! freeing a LUN with "
4439 "outstanding I/O!!\n");
4443 * If we have anything pending on the RtR queue, remove it.
4445 for (io = (union ctl_io *)STAILQ_FIRST(&softc->rtr_queue); io != NULL;
4449 next_io = (union ctl_io *)STAILQ_NEXT(&io->io_hdr, links);
4450 targ_lun = io->io_hdr.nexus.targ_lun;
4451 if (io->io_hdr.nexus.lun_map_fn != NULL)
4452 targ_lun = io->io_hdr.nexus.lun_map_fn(io->io_hdr.nexus.lun_map_arg, targ_lun);
4453 if ((io->io_hdr.nexus.targ_target.id == lun->target.id)
4454 && (targ_lun == lun->lun))
4455 STAILQ_REMOVE(&softc->rtr_queue, &io->io_hdr,
4460 * Then remove everything from the blocked queue.
4462 for (io = (union ctl_io *)TAILQ_FIRST(&lun->blocked_queue); io != NULL;
4464 next_io = (union ctl_io *)TAILQ_NEXT(&io->io_hdr,blocked_links);
4465 TAILQ_REMOVE(&lun->blocked_queue, &io->io_hdr, blocked_links);
4466 io->io_hdr.flags &= ~CTL_FLAG_BLOCKED;
4470 * Now clear out the OOA queue, and free all the I/O.
4471 * XXX KDM should we notify the FETD here? We probably need to
4472 * quiesce the LUN before deleting it.
4474 for (io = (union ctl_io *)TAILQ_FIRST(&lun->ooa_queue); io != NULL;
4476 next_io = (union ctl_io *)TAILQ_NEXT(&io->io_hdr, ooa_links);
4477 TAILQ_REMOVE(&lun->ooa_queue, &io->io_hdr, ooa_links);
4484 * XXX KDM this scheme only works for a single target/multiple LUN
4485 * setup. It needs to be revamped for a multiple target scheme.
4487 * XXX KDM this results in fe->lun_disable() getting called twice,
4488 * once when ctl_disable_lun() is called, and a second time here.
4489 * We really need to re-think the LUN disable semantics. There
4490 * should probably be several steps/levels to LUN removal:
4495 * Right now we only have a disable method when communicating to
4496 * the front end ports, at least for individual LUNs.
4499 STAILQ_FOREACH(fe, &softc->fe_list, links) {
4502 retval = fe->lun_disable(fe->targ_lun_arg, lun->target,
4505 printf("ctl_free_lun: FETD %s port %d returned error "
4506 "%d for lun_disable on target %ju lun %jd\n",
4507 fe->port_name, fe->targ_port, retval,
4508 (uintmax_t)lun->target.id, (intmax_t)lun->lun);
4511 if (STAILQ_FIRST(&softc->lun_list) == NULL) {
4512 fe->status &= ~CTL_PORT_STATUS_LUN_ONLINE;
4514 retval = fe->targ_disable(fe->targ_lun_arg,lun->target);
4516 printf("ctl_free_lun: FETD %s port %d "
4517 "returned error %d for targ_disable on "
4518 "target %ju\n", fe->port_name,
4519 fe->targ_port, retval,
4520 (uintmax_t)lun->target.id);
4522 fe->status &= ~CTL_PORT_STATUS_TARG_ONLINE;
4524 if ((fe->status & CTL_PORT_STATUS_TARG_ONLINE) != 0)
4528 fe->port_offline(fe->onoff_arg);
4529 fe->status &= ~CTL_PORT_STATUS_ONLINE;
4536 * Tell the backend to free resources, if this LUN has a backend.
4538 atomic_subtract_int(&lun->be_lun->be->num_luns, 1);
4539 lun->be_lun->lun_shutdown(lun->be_lun->be_lun);
4541 if (lun->flags & CTL_LUN_MALLOCED)
4544 STAILQ_FOREACH(nlun, &softc->lun_list, links) {
4545 for (i = 0; i < CTL_MAX_INITIATORS; i++) {
4546 nlun->pending_sense[i].ua_pending |= CTL_UA_LUN_CHANGE;
4554 ctl_create_lun(struct ctl_be_lun *be_lun)
4556 struct ctl_softc *ctl_softc;
4558 ctl_softc = control_softc;
4561 * ctl_alloc_lun() should handle all potential failure cases.
4563 ctl_alloc_lun(ctl_softc, NULL, be_lun, ctl_softc->target);
4567 ctl_add_lun(struct ctl_be_lun *be_lun)
4569 struct ctl_softc *ctl_softc;
4571 ctl_softc = control_softc;
4573 mtx_lock(&ctl_softc->ctl_lock);
4574 STAILQ_INSERT_TAIL(&ctl_softc->pending_lun_queue, be_lun, links);
4575 mtx_unlock(&ctl_softc->ctl_lock);
4577 ctl_wakeup_thread();
4583 ctl_enable_lun(struct ctl_be_lun *be_lun)
4585 struct ctl_softc *ctl_softc;
4586 struct ctl_frontend *fe, *nfe;
4587 struct ctl_lun *lun;
4590 ctl_softc = control_softc;
4592 lun = (struct ctl_lun *)be_lun->ctl_lun;
4594 mtx_lock(&ctl_softc->ctl_lock);
4595 if ((lun->flags & CTL_LUN_DISABLED) == 0) {
4597 * eh? Why did we get called if the LUN is already
4600 mtx_unlock(&ctl_softc->ctl_lock);
4603 lun->flags &= ~CTL_LUN_DISABLED;
4605 for (fe = STAILQ_FIRST(&ctl_softc->fe_list); fe != NULL; fe = nfe) {
4606 nfe = STAILQ_NEXT(fe, links);
4609 * Drop the lock while we call the FETD's enable routine.
4610 * This can lead to a callback into CTL (at least in the
4611 * case of the internal initiator frontend.
4613 mtx_unlock(&ctl_softc->ctl_lock);
4614 retval = fe->lun_enable(fe->targ_lun_arg, lun->target,lun->lun);
4615 mtx_lock(&ctl_softc->ctl_lock);
4617 printf("%s: FETD %s port %d returned error "
4618 "%d for lun_enable on target %ju lun %jd\n",
4619 __func__, fe->port_name, fe->targ_port, retval,
4620 (uintmax_t)lun->target.id, (intmax_t)lun->lun);
4624 /* NOTE: TODO: why does lun enable affect port status? */
4625 fe->status |= CTL_PORT_STATUS_LUN_ONLINE;
4630 mtx_unlock(&ctl_softc->ctl_lock);
4636 ctl_disable_lun(struct ctl_be_lun *be_lun)
4638 struct ctl_softc *ctl_softc;
4639 struct ctl_frontend *fe;
4640 struct ctl_lun *lun;
4643 ctl_softc = control_softc;
4645 lun = (struct ctl_lun *)be_lun->ctl_lun;
4647 mtx_lock(&ctl_softc->ctl_lock);
4649 if (lun->flags & CTL_LUN_DISABLED) {
4650 mtx_unlock(&ctl_softc->ctl_lock);
4653 lun->flags |= CTL_LUN_DISABLED;
4655 STAILQ_FOREACH(fe, &ctl_softc->fe_list, links) {
4656 mtx_unlock(&ctl_softc->ctl_lock);
4658 * Drop the lock before we call the frontend's disable
4659 * routine, to avoid lock order reversals.
4661 * XXX KDM what happens if the frontend list changes while
4662 * we're traversing it? It's unlikely, but should be handled.
4664 retval = fe->lun_disable(fe->targ_lun_arg, lun->target,
4666 mtx_lock(&ctl_softc->ctl_lock);
4668 printf("ctl_alloc_lun: FETD %s port %d returned error "
4669 "%d for lun_disable on target %ju lun %jd\n",
4670 fe->port_name, fe->targ_port, retval,
4671 (uintmax_t)lun->target.id, (intmax_t)lun->lun);
4675 mtx_unlock(&ctl_softc->ctl_lock);
4681 ctl_start_lun(struct ctl_be_lun *be_lun)
4683 struct ctl_softc *ctl_softc;
4684 struct ctl_lun *lun;
4686 ctl_softc = control_softc;
4688 lun = (struct ctl_lun *)be_lun->ctl_lun;
4690 mtx_lock(&ctl_softc->ctl_lock);
4691 lun->flags &= ~CTL_LUN_STOPPED;
4692 mtx_unlock(&ctl_softc->ctl_lock);
4698 ctl_stop_lun(struct ctl_be_lun *be_lun)
4700 struct ctl_softc *ctl_softc;
4701 struct ctl_lun *lun;
4703 ctl_softc = control_softc;
4705 lun = (struct ctl_lun *)be_lun->ctl_lun;
4707 mtx_lock(&ctl_softc->ctl_lock);
4708 lun->flags |= CTL_LUN_STOPPED;
4709 mtx_unlock(&ctl_softc->ctl_lock);
4715 ctl_lun_offline(struct ctl_be_lun *be_lun)
4717 struct ctl_softc *ctl_softc;
4718 struct ctl_lun *lun;
4720 ctl_softc = control_softc;
4722 lun = (struct ctl_lun *)be_lun->ctl_lun;
4724 mtx_lock(&ctl_softc->ctl_lock);
4725 lun->flags |= CTL_LUN_OFFLINE;
4726 mtx_unlock(&ctl_softc->ctl_lock);
4732 ctl_lun_online(struct ctl_be_lun *be_lun)
4734 struct ctl_softc *ctl_softc;
4735 struct ctl_lun *lun;
4737 ctl_softc = control_softc;
4739 lun = (struct ctl_lun *)be_lun->ctl_lun;
4741 mtx_lock(&ctl_softc->ctl_lock);
4742 lun->flags &= ~CTL_LUN_OFFLINE;
4743 mtx_unlock(&ctl_softc->ctl_lock);
4749 ctl_invalidate_lun(struct ctl_be_lun *be_lun)
4751 struct ctl_softc *ctl_softc;
4752 struct ctl_lun *lun;
4754 ctl_softc = control_softc;
4756 lun = (struct ctl_lun *)be_lun->ctl_lun;
4758 mtx_lock(&ctl_softc->ctl_lock);
4761 * The LUN needs to be disabled before it can be marked invalid.
4763 if ((lun->flags & CTL_LUN_DISABLED) == 0) {
4764 mtx_unlock(&ctl_softc->ctl_lock);
4768 * Mark the LUN invalid.
4770 lun->flags |= CTL_LUN_INVALID;
4773 * If there is nothing in the OOA queue, go ahead and free the LUN.
4774 * If we have something in the OOA queue, we'll free it when the
4775 * last I/O completes.
4777 if (TAILQ_FIRST(&lun->ooa_queue) == NULL)
4779 mtx_unlock(&ctl_softc->ctl_lock);
4785 ctl_lun_inoperable(struct ctl_be_lun *be_lun)
4787 struct ctl_softc *ctl_softc;
4788 struct ctl_lun *lun;
4790 ctl_softc = control_softc;
4791 lun = (struct ctl_lun *)be_lun->ctl_lun;
4793 mtx_lock(&ctl_softc->ctl_lock);
4794 lun->flags |= CTL_LUN_INOPERABLE;
4795 mtx_unlock(&ctl_softc->ctl_lock);
4801 ctl_lun_operable(struct ctl_be_lun *be_lun)
4803 struct ctl_softc *ctl_softc;
4804 struct ctl_lun *lun;
4806 ctl_softc = control_softc;
4807 lun = (struct ctl_lun *)be_lun->ctl_lun;
4809 mtx_lock(&ctl_softc->ctl_lock);
4810 lun->flags &= ~CTL_LUN_INOPERABLE;
4811 mtx_unlock(&ctl_softc->ctl_lock);
4817 ctl_lun_power_lock(struct ctl_be_lun *be_lun, struct ctl_nexus *nexus,
4820 struct ctl_softc *softc;
4821 struct ctl_lun *lun;
4822 struct copan_aps_subpage *current_sp;
4823 struct ctl_page_index *page_index;
4826 softc = control_softc;
4828 mtx_lock(&softc->ctl_lock);
4830 lun = (struct ctl_lun *)be_lun->ctl_lun;
4833 for (i = 0; i < CTL_NUM_MODE_PAGES; i++) {
4834 if ((lun->mode_pages.index[i].page_code & SMPH_PC_MASK) !=
4838 if (lun->mode_pages.index[i].subpage != APS_SUBPAGE_CODE)
4840 page_index = &lun->mode_pages.index[i];
4843 if (page_index == NULL) {
4844 mtx_unlock(&softc->ctl_lock);
4845 printf("%s: APS subpage not found for lun %ju!\n", __func__,
4846 (uintmax_t)lun->lun);
4850 if ((softc->aps_locked_lun != 0)
4851 && (softc->aps_locked_lun != lun->lun)) {
4852 printf("%s: attempt to lock LUN %llu when %llu is already "
4854 mtx_unlock(&softc->ctl_lock);
4859 current_sp = (struct copan_aps_subpage *)(page_index->page_data +
4860 (page_index->page_len * CTL_PAGE_CURRENT));
4863 current_sp->lock_active = APS_LOCK_ACTIVE;
4864 softc->aps_locked_lun = lun->lun;
4866 current_sp->lock_active = 0;
4867 softc->aps_locked_lun = 0;
4872 * If we're in HA mode, try to send the lock message to the other
4875 if (ctl_is_single == 0) {
4877 union ctl_ha_msg lock_msg;
4879 lock_msg.hdr.nexus = *nexus;
4880 lock_msg.hdr.msg_type = CTL_MSG_APS_LOCK;
4882 lock_msg.aps.lock_flag = 1;
4884 lock_msg.aps.lock_flag = 0;
4885 isc_retval = ctl_ha_msg_send(CTL_HA_CHAN_CTL, &lock_msg,
4886 sizeof(lock_msg), 0);
4887 if (isc_retval > CTL_HA_STATUS_SUCCESS) {
4888 printf("%s: APS (lock=%d) error returned from "
4889 "ctl_ha_msg_send: %d\n", __func__, lock, isc_retval);
4890 mtx_unlock(&softc->ctl_lock);
4895 mtx_unlock(&softc->ctl_lock);
4901 ctl_lun_capacity_changed(struct ctl_be_lun *be_lun)
4903 struct ctl_lun *lun;
4904 struct ctl_softc *softc;
4907 softc = control_softc;
4909 mtx_lock(&softc->ctl_lock);
4911 lun = (struct ctl_lun *)be_lun->ctl_lun;
4913 for (i = 0; i < CTL_MAX_INITIATORS; i++)
4914 lun->pending_sense[i].ua_pending |= CTL_UA_CAPACITY_CHANGED;
4916 mtx_unlock(&softc->ctl_lock);
4920 * Backend "memory move is complete" callback for requests that never
4921 * make it down to say RAIDCore's configuration code.
4924 ctl_config_move_done(union ctl_io *io)
4928 retval = CTL_RETVAL_COMPLETE;
4931 CTL_DEBUG_PRINT(("ctl_config_move_done\n"));
4933 * XXX KDM this shouldn't happen, but what if it does?
4935 if (io->io_hdr.io_type != CTL_IO_SCSI)
4936 panic("I/O type isn't CTL_IO_SCSI!");
4938 if ((io->io_hdr.port_status == 0)
4939 && ((io->io_hdr.flags & CTL_FLAG_ABORT) == 0)
4940 && ((io->io_hdr.status & CTL_STATUS_MASK) == CTL_STATUS_NONE))
4941 io->io_hdr.status = CTL_SUCCESS;
4942 else if ((io->io_hdr.port_status != 0)
4943 && ((io->io_hdr.flags & CTL_FLAG_ABORT) == 0)
4944 && ((io->io_hdr.status & CTL_STATUS_MASK) == CTL_STATUS_NONE)){
4946 * For hardware error sense keys, the sense key
4947 * specific value is defined to be a retry count,
4948 * but we use it to pass back an internal FETD
4949 * error code. XXX KDM Hopefully the FETD is only
4950 * using 16 bits for an error code, since that's
4951 * all the space we have in the sks field.
4953 ctl_set_internal_failure(&io->scsiio,
4956 io->io_hdr.port_status);
4957 free(io->scsiio.kern_data_ptr, M_CTL);
4962 if (((io->io_hdr.flags & CTL_FLAG_DATA_MASK) == CTL_FLAG_DATA_IN)
4963 || ((io->io_hdr.status & CTL_STATUS_MASK) != CTL_SUCCESS)
4964 || ((io->io_hdr.flags & CTL_FLAG_ABORT) != 0)) {
4966 * XXX KDM just assuming a single pointer here, and not a
4967 * S/G list. If we start using S/G lists for config data,
4968 * we'll need to know how to clean them up here as well.
4970 free(io->scsiio.kern_data_ptr, M_CTL);
4971 /* Hopefully the user has already set the status... */
4975 * XXX KDM now we need to continue data movement. Some
4977 * - call ctl_scsiio() again? We don't do this for data
4978 * writes, because for those at least we know ahead of
4979 * time where the write will go and how long it is. For
4980 * config writes, though, that information is largely
4981 * contained within the write itself, thus we need to
4982 * parse out the data again.
4984 * - Call some other function once the data is in?
4988 * XXX KDM call ctl_scsiio() again for now, and check flag
4989 * bits to see whether we're allocated or not.
4991 retval = ctl_scsiio(&io->scsiio);
4998 * This gets called by a backend driver when it is done with a
4999 * configuration write.
5002 ctl_config_write_done(union ctl_io *io)
5005 * If the IO_CONT flag is set, we need to call the supplied
5006 * function to continue processing the I/O, instead of completing
5009 * If there is an error, though, we don't want to keep processing.
5010 * Instead, just send status back to the initiator.
5012 if ((io->io_hdr.flags & CTL_FLAG_IO_CONT)
5013 && (((io->io_hdr.status & CTL_STATUS_MASK) == CTL_STATUS_NONE)
5014 || ((io->io_hdr.status & CTL_STATUS_MASK) == CTL_SUCCESS))) {
5015 io->scsiio.io_cont(io);
5019 * Since a configuration write can be done for commands that actually
5020 * have data allocated, like write buffer, and commands that have
5021 * no data, like start/stop unit, we need to check here.
5023 if ((io->io_hdr.flags & CTL_FLAG_DATA_MASK) == CTL_FLAG_DATA_OUT)
5024 free(io->scsiio.kern_data_ptr, M_CTL);
5029 * SCSI release command.
5032 ctl_scsi_release(struct ctl_scsiio *ctsio)
5034 int length, longid, thirdparty_id, resv_id;
5035 struct ctl_softc *ctl_softc;
5036 struct ctl_lun *lun;
5041 CTL_DEBUG_PRINT(("ctl_scsi_release\n"));
5043 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5044 ctl_softc = control_softc;
5046 switch (ctsio->cdb[0]) {
5048 struct scsi_release *cdb;
5050 cdb = (struct scsi_release *)ctsio->cdb;
5051 if ((cdb->byte2 & 0x1f) != 0) {
5052 ctl_set_invalid_field(ctsio,
5058 ctl_done((union ctl_io *)ctsio);
5059 return (CTL_RETVAL_COMPLETE);
5064 struct scsi_release_10 *cdb;
5066 cdb = (struct scsi_release_10 *)ctsio->cdb;
5068 if ((cdb->byte2 & SR10_EXTENT) != 0) {
5069 ctl_set_invalid_field(ctsio,
5075 ctl_done((union ctl_io *)ctsio);
5076 return (CTL_RETVAL_COMPLETE);
5080 if ((cdb->byte2 & SR10_3RDPTY) != 0) {
5081 ctl_set_invalid_field(ctsio,
5087 ctl_done((union ctl_io *)ctsio);
5088 return (CTL_RETVAL_COMPLETE);
5091 if (cdb->byte2 & SR10_LONGID)
5094 thirdparty_id = cdb->thirdparty_id;
5096 resv_id = cdb->resv_id;
5097 length = scsi_2btoul(cdb->length);
5104 * XXX KDM right now, we only support LUN reservation. We don't
5105 * support 3rd party reservations, or extent reservations, which
5106 * might actually need the parameter list. If we've gotten this
5107 * far, we've got a LUN reservation. Anything else got kicked out
5108 * above. So, according to SPC, ignore the length.
5112 if (((ctsio->io_hdr.flags & CTL_FLAG_ALLOCATED) == 0)
5114 ctsio->kern_data_ptr = malloc(length, M_CTL, M_WAITOK);
5115 ctsio->kern_data_len = length;
5116 ctsio->kern_total_len = length;
5117 ctsio->kern_data_resid = 0;
5118 ctsio->kern_rel_offset = 0;
5119 ctsio->kern_sg_entries = 0;
5120 ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
5121 ctsio->be_move_done = ctl_config_move_done;
5122 ctl_datamove((union ctl_io *)ctsio);
5124 return (CTL_RETVAL_COMPLETE);
5128 thirdparty_id = scsi_8btou64(ctsio->kern_data_ptr);
5130 mtx_lock(&ctl_softc->ctl_lock);
5133 * According to SPC, it is not an error for an intiator to attempt
5134 * to release a reservation on a LUN that isn't reserved, or that
5135 * is reserved by another initiator. The reservation can only be
5136 * released, though, by the initiator who made it or by one of
5137 * several reset type events.
5139 if (lun->flags & CTL_LUN_RESERVED) {
5140 if ((ctsio->io_hdr.nexus.initid.id == lun->rsv_nexus.initid.id)
5141 && (ctsio->io_hdr.nexus.targ_port == lun->rsv_nexus.targ_port)
5142 && (ctsio->io_hdr.nexus.targ_target.id ==
5143 lun->rsv_nexus.targ_target.id)) {
5144 lun->flags &= ~CTL_LUN_RESERVED;
5148 ctsio->scsi_status = SCSI_STATUS_OK;
5149 ctsio->io_hdr.status = CTL_SUCCESS;
5151 if (ctsio->io_hdr.flags & CTL_FLAG_ALLOCATED) {
5152 free(ctsio->kern_data_ptr, M_CTL);
5153 ctsio->io_hdr.flags &= ~CTL_FLAG_ALLOCATED;
5156 mtx_unlock(&ctl_softc->ctl_lock);
5158 ctl_done((union ctl_io *)ctsio);
5159 return (CTL_RETVAL_COMPLETE);
5163 ctl_scsi_reserve(struct ctl_scsiio *ctsio)
5165 int extent, thirdparty, longid;
5166 int resv_id, length;
5167 uint64_t thirdparty_id;
5168 struct ctl_softc *ctl_softc;
5169 struct ctl_lun *lun;
5178 CTL_DEBUG_PRINT(("ctl_reserve\n"));
5180 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5181 ctl_softc = control_softc;
5183 switch (ctsio->cdb[0]) {
5185 struct scsi_reserve *cdb;
5187 cdb = (struct scsi_reserve *)ctsio->cdb;
5188 if ((cdb->byte2 & 0x1f) != 0) {
5189 ctl_set_invalid_field(ctsio,
5195 ctl_done((union ctl_io *)ctsio);
5196 return (CTL_RETVAL_COMPLETE);
5198 resv_id = cdb->resv_id;
5199 length = scsi_2btoul(cdb->length);
5203 struct scsi_reserve_10 *cdb;
5205 cdb = (struct scsi_reserve_10 *)ctsio->cdb;
5207 if ((cdb->byte2 & SR10_EXTENT) != 0) {
5208 ctl_set_invalid_field(ctsio,
5214 ctl_done((union ctl_io *)ctsio);
5215 return (CTL_RETVAL_COMPLETE);
5217 if ((cdb->byte2 & SR10_3RDPTY) != 0) {
5218 ctl_set_invalid_field(ctsio,
5224 ctl_done((union ctl_io *)ctsio);
5225 return (CTL_RETVAL_COMPLETE);
5227 if (cdb->byte2 & SR10_LONGID)
5230 thirdparty_id = cdb->thirdparty_id;
5232 resv_id = cdb->resv_id;
5233 length = scsi_2btoul(cdb->length);
5239 * XXX KDM right now, we only support LUN reservation. We don't
5240 * support 3rd party reservations, or extent reservations, which
5241 * might actually need the parameter list. If we've gotten this
5242 * far, we've got a LUN reservation. Anything else got kicked out
5243 * above. So, according to SPC, ignore the length.
5247 if (((ctsio->io_hdr.flags & CTL_FLAG_ALLOCATED) == 0)
5249 ctsio->kern_data_ptr = malloc(length, M_CTL, M_WAITOK);
5250 ctsio->kern_data_len = length;
5251 ctsio->kern_total_len = length;
5252 ctsio->kern_data_resid = 0;
5253 ctsio->kern_rel_offset = 0;
5254 ctsio->kern_sg_entries = 0;
5255 ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
5256 ctsio->be_move_done = ctl_config_move_done;
5257 ctl_datamove((union ctl_io *)ctsio);
5259 return (CTL_RETVAL_COMPLETE);
5263 thirdparty_id = scsi_8btou64(ctsio->kern_data_ptr);
5265 mtx_lock(&ctl_softc->ctl_lock);
5266 if (lun->flags & CTL_LUN_RESERVED) {
5267 if ((ctsio->io_hdr.nexus.initid.id != lun->rsv_nexus.initid.id)
5268 || (ctsio->io_hdr.nexus.targ_port != lun->rsv_nexus.targ_port)
5269 || (ctsio->io_hdr.nexus.targ_target.id !=
5270 lun->rsv_nexus.targ_target.id)) {
5271 ctsio->scsi_status = SCSI_STATUS_RESERV_CONFLICT;
5272 ctsio->io_hdr.status = CTL_SCSI_ERROR;
5277 lun->flags |= CTL_LUN_RESERVED;
5278 lun->rsv_nexus = ctsio->io_hdr.nexus;
5280 ctsio->scsi_status = SCSI_STATUS_OK;
5281 ctsio->io_hdr.status = CTL_SUCCESS;
5284 if (ctsio->io_hdr.flags & CTL_FLAG_ALLOCATED) {
5285 free(ctsio->kern_data_ptr, M_CTL);
5286 ctsio->io_hdr.flags &= ~CTL_FLAG_ALLOCATED;
5289 mtx_unlock(&ctl_softc->ctl_lock);
5291 ctl_done((union ctl_io *)ctsio);
5292 return (CTL_RETVAL_COMPLETE);
5296 ctl_start_stop(struct ctl_scsiio *ctsio)
5298 struct scsi_start_stop_unit *cdb;
5299 struct ctl_lun *lun;
5300 struct ctl_softc *ctl_softc;
5303 CTL_DEBUG_PRINT(("ctl_start_stop\n"));
5305 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5306 ctl_softc = control_softc;
5309 cdb = (struct scsi_start_stop_unit *)ctsio->cdb;
5313 * We don't support the immediate bit on a stop unit. In order to
5314 * do that, we would need to code up a way to know that a stop is
5315 * pending, and hold off any new commands until it completes, one
5316 * way or another. Then we could accept or reject those commands
5317 * depending on its status. We would almost need to do the reverse
5318 * of what we do below for an immediate start -- return the copy of
5319 * the ctl_io to the FETD with status to send to the host (and to
5320 * free the copy!) and then free the original I/O once the stop
5321 * actually completes. That way, the OOA queue mechanism can work
5322 * to block commands that shouldn't proceed. Another alternative
5323 * would be to put the copy in the queue in place of the original,
5324 * and return the original back to the caller. That could be
5327 if ((cdb->byte2 & SSS_IMMED)
5328 && ((cdb->how & SSS_START) == 0)) {
5329 ctl_set_invalid_field(ctsio,
5335 ctl_done((union ctl_io *)ctsio);
5336 return (CTL_RETVAL_COMPLETE);
5340 * We don't support the power conditions field. We need to check
5341 * this prior to checking the load/eject and start/stop bits.
5343 if ((cdb->how & SSS_PC_MASK) != SSS_PC_START_VALID) {
5344 ctl_set_invalid_field(ctsio,
5350 ctl_done((union ctl_io *)ctsio);
5351 return (CTL_RETVAL_COMPLETE);
5355 * Media isn't removable, so we can't load or eject it.
5357 if ((cdb->how & SSS_LOEJ) != 0) {
5358 ctl_set_invalid_field(ctsio,
5364 ctl_done((union ctl_io *)ctsio);
5365 return (CTL_RETVAL_COMPLETE);
5368 if ((lun->flags & CTL_LUN_PR_RESERVED)
5369 && ((cdb->how & SSS_START)==0)) {
5372 residx = ctl_get_resindex(&ctsio->io_hdr.nexus);
5373 if (!lun->per_res[residx].registered
5374 || (lun->pr_res_idx!=residx && lun->res_type < 4)) {
5376 ctl_set_reservation_conflict(ctsio);
5377 ctl_done((union ctl_io *)ctsio);
5378 return (CTL_RETVAL_COMPLETE);
5383 * If there is no backend on this device, we can't start or stop
5384 * it. In theory we shouldn't get any start/stop commands in the
5385 * first place at this level if the LUN doesn't have a backend.
5386 * That should get stopped by the command decode code.
5388 if (lun->backend == NULL) {
5389 ctl_set_invalid_opcode(ctsio);
5390 ctl_done((union ctl_io *)ctsio);
5391 return (CTL_RETVAL_COMPLETE);
5395 * XXX KDM Copan-specific offline behavior.
5396 * Figure out a reasonable way to port this?
5399 mtx_lock(&ctl_softc->ctl_lock);
5401 if (((cdb->byte2 & SSS_ONOFFLINE) == 0)
5402 && (lun->flags & CTL_LUN_OFFLINE)) {
5404 * If the LUN is offline, and the on/offline bit isn't set,
5405 * reject the start or stop. Otherwise, let it through.
5407 mtx_unlock(&ctl_softc->ctl_lock);
5408 ctl_set_lun_not_ready(ctsio);
5409 ctl_done((union ctl_io *)ctsio);
5411 mtx_unlock(&ctl_softc->ctl_lock);
5412 #endif /* NEEDTOPORT */
5414 * This could be a start or a stop when we're online,
5415 * or a stop/offline or start/online. A start or stop when
5416 * we're offline is covered in the case above.
5419 * In the non-immediate case, we send the request to
5420 * the backend and return status to the user when
5423 * In the immediate case, we allocate a new ctl_io
5424 * to hold a copy of the request, and send that to
5425 * the backend. We then set good status on the
5426 * user's request and return it immediately.
5428 if (cdb->byte2 & SSS_IMMED) {
5429 union ctl_io *new_io;
5431 new_io = ctl_alloc_io(ctsio->io_hdr.pool);
5432 if (new_io == NULL) {
5433 ctl_set_busy(ctsio);
5434 ctl_done((union ctl_io *)ctsio);
5436 ctl_copy_io((union ctl_io *)ctsio,
5438 retval = lun->backend->config_write(new_io);
5439 ctl_set_success(ctsio);
5440 ctl_done((union ctl_io *)ctsio);
5443 retval = lun->backend->config_write(
5444 (union ctl_io *)ctsio);
5453 * We support the SYNCHRONIZE CACHE command (10 and 16 byte versions), but
5454 * we don't really do anything with the LBA and length fields if the user
5455 * passes them in. Instead we'll just flush out the cache for the entire
5459 ctl_sync_cache(struct ctl_scsiio *ctsio)
5461 struct ctl_lun *lun;
5462 struct ctl_softc *ctl_softc;
5463 uint64_t starting_lba;
5464 uint32_t block_count;
5468 CTL_DEBUG_PRINT(("ctl_sync_cache\n"));
5470 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5471 ctl_softc = control_softc;
5476 switch (ctsio->cdb[0]) {
5477 case SYNCHRONIZE_CACHE: {
5478 struct scsi_sync_cache *cdb;
5479 cdb = (struct scsi_sync_cache *)ctsio->cdb;
5481 if (cdb->byte2 & SSC_RELADR)
5484 if (cdb->byte2 & SSC_IMMED)
5487 starting_lba = scsi_4btoul(cdb->begin_lba);
5488 block_count = scsi_2btoul(cdb->lb_count);
5491 case SYNCHRONIZE_CACHE_16: {
5492 struct scsi_sync_cache_16 *cdb;
5493 cdb = (struct scsi_sync_cache_16 *)ctsio->cdb;
5495 if (cdb->byte2 & SSC_RELADR)
5498 if (cdb->byte2 & SSC_IMMED)
5501 starting_lba = scsi_8btou64(cdb->begin_lba);
5502 block_count = scsi_4btoul(cdb->lb_count);
5506 ctl_set_invalid_opcode(ctsio);
5507 ctl_done((union ctl_io *)ctsio);
5509 break; /* NOTREACHED */
5514 * We don't support the immediate bit. Since it's in the
5515 * same place for the 10 and 16 byte SYNCHRONIZE CACHE
5516 * commands, we can just return the same error in either
5519 ctl_set_invalid_field(ctsio,
5525 ctl_done((union ctl_io *)ctsio);
5531 * We don't support the reladr bit either. It can only be
5532 * used with linked commands, and we don't support linked
5533 * commands. Since the bit is in the same place for the
5534 * 10 and 16 byte SYNCHRONIZE CACHE * commands, we can
5535 * just return the same error in either case.
5537 ctl_set_invalid_field(ctsio,
5543 ctl_done((union ctl_io *)ctsio);
5548 * We check the LBA and length, but don't do anything with them.
5549 * A SYNCHRONIZE CACHE will cause the entire cache for this lun to
5550 * get flushed. This check will just help satisfy anyone who wants
5551 * to see an error for an out of range LBA.
5553 if ((starting_lba + block_count) > (lun->be_lun->maxlba + 1)) {
5554 ctl_set_lba_out_of_range(ctsio);
5555 ctl_done((union ctl_io *)ctsio);
5560 * If this LUN has no backend, we can't flush the cache anyway.
5562 if (lun->backend == NULL) {
5563 ctl_set_invalid_opcode(ctsio);
5564 ctl_done((union ctl_io *)ctsio);
5569 * Check to see whether we're configured to send the SYNCHRONIZE
5570 * CACHE command directly to the back end.
5572 mtx_lock(&ctl_softc->ctl_lock);
5573 if ((ctl_softc->flags & CTL_FLAG_REAL_SYNC)
5574 && (++(lun->sync_count) >= lun->sync_interval)) {
5575 lun->sync_count = 0;
5576 mtx_unlock(&ctl_softc->ctl_lock);
5577 retval = lun->backend->config_write((union ctl_io *)ctsio);
5579 mtx_unlock(&ctl_softc->ctl_lock);
5580 ctl_set_success(ctsio);
5581 ctl_done((union ctl_io *)ctsio);
5590 ctl_format(struct ctl_scsiio *ctsio)
5592 struct scsi_format *cdb;
5593 struct ctl_lun *lun;
5594 struct ctl_softc *ctl_softc;
5595 int length, defect_list_len;
5597 CTL_DEBUG_PRINT(("ctl_format\n"));
5599 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5600 ctl_softc = control_softc;
5602 cdb = (struct scsi_format *)ctsio->cdb;
5605 if (cdb->byte2 & SF_FMTDATA) {
5606 if (cdb->byte2 & SF_LONGLIST)
5607 length = sizeof(struct scsi_format_header_long);
5609 length = sizeof(struct scsi_format_header_short);
5612 if (((ctsio->io_hdr.flags & CTL_FLAG_ALLOCATED) == 0)
5614 ctsio->kern_data_ptr = malloc(length, M_CTL, M_WAITOK);
5615 ctsio->kern_data_len = length;
5616 ctsio->kern_total_len = length;
5617 ctsio->kern_data_resid = 0;
5618 ctsio->kern_rel_offset = 0;
5619 ctsio->kern_sg_entries = 0;
5620 ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
5621 ctsio->be_move_done = ctl_config_move_done;
5622 ctl_datamove((union ctl_io *)ctsio);
5624 return (CTL_RETVAL_COMPLETE);
5627 defect_list_len = 0;
5629 if (cdb->byte2 & SF_FMTDATA) {
5630 if (cdb->byte2 & SF_LONGLIST) {
5631 struct scsi_format_header_long *header;
5633 header = (struct scsi_format_header_long *)
5634 ctsio->kern_data_ptr;
5636 defect_list_len = scsi_4btoul(header->defect_list_len);
5637 if (defect_list_len != 0) {
5638 ctl_set_invalid_field(ctsio,
5647 struct scsi_format_header_short *header;
5649 header = (struct scsi_format_header_short *)
5650 ctsio->kern_data_ptr;
5652 defect_list_len = scsi_2btoul(header->defect_list_len);
5653 if (defect_list_len != 0) {
5654 ctl_set_invalid_field(ctsio,
5666 * The format command will clear out the "Medium format corrupted"
5667 * status if set by the configuration code. That status is really
5668 * just a way to notify the host that we have lost the media, and
5669 * get them to issue a command that will basically make them think
5670 * they're blowing away the media.
5672 mtx_lock(&ctl_softc->ctl_lock);
5673 lun->flags &= ~CTL_LUN_INOPERABLE;
5674 mtx_unlock(&ctl_softc->ctl_lock);
5676 ctsio->scsi_status = SCSI_STATUS_OK;
5677 ctsio->io_hdr.status = CTL_SUCCESS;
5680 if (ctsio->io_hdr.flags & CTL_FLAG_ALLOCATED) {
5681 free(ctsio->kern_data_ptr, M_CTL);
5682 ctsio->io_hdr.flags &= ~CTL_FLAG_ALLOCATED;
5685 ctl_done((union ctl_io *)ctsio);
5686 return (CTL_RETVAL_COMPLETE);
5690 ctl_write_buffer(struct ctl_scsiio *ctsio)
5692 struct scsi_write_buffer *cdb;
5693 struct copan_page_header *header;
5694 struct ctl_lun *lun;
5695 struct ctl_softc *ctl_softc;
5696 int buffer_offset, len;
5701 retval = CTL_RETVAL_COMPLETE;
5703 CTL_DEBUG_PRINT(("ctl_write_buffer\n"));
5705 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5706 ctl_softc = control_softc;
5707 cdb = (struct scsi_write_buffer *)ctsio->cdb;
5709 if ((cdb->byte2 & RWB_MODE) != RWB_MODE_DATA) {
5710 ctl_set_invalid_field(ctsio,
5716 ctl_done((union ctl_io *)ctsio);
5717 return (CTL_RETVAL_COMPLETE);
5719 if (cdb->buffer_id != 0) {
5720 ctl_set_invalid_field(ctsio,
5726 ctl_done((union ctl_io *)ctsio);
5727 return (CTL_RETVAL_COMPLETE);
5730 len = scsi_3btoul(cdb->length);
5731 buffer_offset = scsi_3btoul(cdb->offset);
5733 if (len > sizeof(lun->write_buffer)) {
5734 ctl_set_invalid_field(ctsio,
5740 ctl_done((union ctl_io *)ctsio);
5741 return (CTL_RETVAL_COMPLETE);
5744 if (buffer_offset != 0) {
5745 ctl_set_invalid_field(ctsio,
5751 ctl_done((union ctl_io *)ctsio);
5752 return (CTL_RETVAL_COMPLETE);
5756 * If we've got a kernel request that hasn't been malloced yet,
5757 * malloc it and tell the caller the data buffer is here.
5759 if ((ctsio->io_hdr.flags & CTL_FLAG_ALLOCATED) == 0) {
5760 ctsio->kern_data_ptr = lun->write_buffer;
5761 ctsio->kern_data_len = len;
5762 ctsio->kern_total_len = len;
5763 ctsio->kern_data_resid = 0;
5764 ctsio->kern_rel_offset = 0;
5765 ctsio->kern_sg_entries = 0;
5766 ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
5767 ctsio->be_move_done = ctl_config_move_done;
5768 ctl_datamove((union ctl_io *)ctsio);
5770 return (CTL_RETVAL_COMPLETE);
5773 ctl_done((union ctl_io *)ctsio);
5775 return (CTL_RETVAL_COMPLETE);
5779 ctl_write_same(struct ctl_scsiio *ctsio)
5781 struct ctl_lun *lun;
5782 struct ctl_lba_len_flags lbalen;
5784 uint32_t num_blocks;
5788 retval = CTL_RETVAL_COMPLETE;
5790 CTL_DEBUG_PRINT(("ctl_write_same\n"));
5792 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5794 switch (ctsio->cdb[0]) {
5795 case WRITE_SAME_10: {
5796 struct scsi_write_same_10 *cdb;
5798 cdb = (struct scsi_write_same_10 *)ctsio->cdb;
5800 lba = scsi_4btoul(cdb->addr);
5801 num_blocks = scsi_2btoul(cdb->length);
5805 case WRITE_SAME_16: {
5806 struct scsi_write_same_16 *cdb;
5808 cdb = (struct scsi_write_same_16 *)ctsio->cdb;
5810 lba = scsi_8btou64(cdb->addr);
5811 num_blocks = scsi_4btoul(cdb->length);
5817 * We got a command we don't support. This shouldn't
5818 * happen, commands should be filtered out above us.
5820 ctl_set_invalid_opcode(ctsio);
5821 ctl_done((union ctl_io *)ctsio);
5823 return (CTL_RETVAL_COMPLETE);
5824 break; /* NOTREACHED */
5828 * The first check is to make sure we're in bounds, the second
5829 * check is to catch wrap-around problems. If the lba + num blocks
5830 * is less than the lba, then we've wrapped around and the block
5831 * range is invalid anyway.
5833 if (((lba + num_blocks) > (lun->be_lun->maxlba + 1))
5834 || ((lba + num_blocks) < lba)) {
5835 ctl_set_lba_out_of_range(ctsio);
5836 ctl_done((union ctl_io *)ctsio);
5837 return (CTL_RETVAL_COMPLETE);
5840 /* Zero number of blocks means "to the last logical block" */
5841 if (num_blocks == 0) {
5842 if ((lun->be_lun->maxlba + 1) - lba > UINT32_MAX) {
5843 ctl_set_invalid_field(ctsio,
5849 ctl_done((union ctl_io *)ctsio);
5850 return (CTL_RETVAL_COMPLETE);
5852 num_blocks = (lun->be_lun->maxlba + 1) - lba;
5855 len = lun->be_lun->blocksize;
5858 * If we've got a kernel request that hasn't been malloced yet,
5859 * malloc it and tell the caller the data buffer is here.
5861 if ((ctsio->io_hdr.flags & CTL_FLAG_ALLOCATED) == 0) {
5862 ctsio->kern_data_ptr = malloc(len, M_CTL, M_WAITOK);;
5863 ctsio->kern_data_len = len;
5864 ctsio->kern_total_len = len;
5865 ctsio->kern_data_resid = 0;
5866 ctsio->kern_rel_offset = 0;
5867 ctsio->kern_sg_entries = 0;
5868 ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
5869 ctsio->be_move_done = ctl_config_move_done;
5870 ctl_datamove((union ctl_io *)ctsio);
5872 return (CTL_RETVAL_COMPLETE);
5876 lbalen.len = num_blocks;
5877 lbalen.flags = byte2;
5878 memcpy(ctsio->io_hdr.ctl_private[CTL_PRIV_LBA_LEN].bytes, &lbalen,
5880 retval = lun->backend->config_write((union ctl_io *)ctsio);
5886 ctl_unmap(struct ctl_scsiio *ctsio)
5888 struct ctl_lun *lun;
5889 struct scsi_unmap *cdb;
5890 struct ctl_ptr_len_flags ptrlen;
5891 struct scsi_unmap_header *hdr;
5892 struct scsi_unmap_desc *buf, *end;
5894 uint32_t num_blocks;
5898 retval = CTL_RETVAL_COMPLETE;
5900 CTL_DEBUG_PRINT(("ctl_unmap\n"));
5902 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5903 cdb = (struct scsi_unmap *)ctsio->cdb;
5905 len = scsi_2btoul(cdb->length);
5909 * If we've got a kernel request that hasn't been malloced yet,
5910 * malloc it and tell the caller the data buffer is here.
5912 if ((ctsio->io_hdr.flags & CTL_FLAG_ALLOCATED) == 0) {
5913 ctsio->kern_data_ptr = malloc(len, M_CTL, M_WAITOK);;
5914 ctsio->kern_data_len = len;
5915 ctsio->kern_total_len = len;
5916 ctsio->kern_data_resid = 0;
5917 ctsio->kern_rel_offset = 0;
5918 ctsio->kern_sg_entries = 0;
5919 ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
5920 ctsio->be_move_done = ctl_config_move_done;
5921 ctl_datamove((union ctl_io *)ctsio);
5923 return (CTL_RETVAL_COMPLETE);
5926 len = ctsio->kern_total_len - ctsio->kern_data_resid;
5927 hdr = (struct scsi_unmap_header *)ctsio->kern_data_ptr;
5928 if (len < sizeof (*hdr) ||
5929 len < (scsi_2btoul(hdr->length) + sizeof(hdr->length)) ||
5930 len < (scsi_2btoul(hdr->desc_length) + sizeof (*hdr)) ||
5931 scsi_2btoul(hdr->desc_length) % sizeof(*buf) != 0) {
5932 ctl_set_invalid_field(ctsio,
5938 ctl_done((union ctl_io *)ctsio);
5939 return (CTL_RETVAL_COMPLETE);
5941 len = scsi_2btoul(hdr->desc_length);
5942 buf = (struct scsi_unmap_desc *)(hdr + 1);
5943 end = buf + len / sizeof(*buf);
5945 ptrlen.ptr = (void *)buf;
5947 ptrlen.flags = byte2;
5948 memcpy(ctsio->io_hdr.ctl_private[CTL_PRIV_LBA_LEN].bytes, &ptrlen,
5951 for (; buf < end; buf++) {
5952 lba = scsi_8btou64(buf->lba);
5953 num_blocks = scsi_4btoul(buf->length);
5954 if (((lba + num_blocks) > (lun->be_lun->maxlba + 1))
5955 || ((lba + num_blocks) < lba)) {
5956 ctl_set_lba_out_of_range(ctsio);
5957 ctl_done((union ctl_io *)ctsio);
5958 return (CTL_RETVAL_COMPLETE);
5962 retval = lun->backend->config_write((union ctl_io *)ctsio);
5968 * Note that this function currently doesn't actually do anything inside
5969 * CTL to enforce things if the DQue bit is turned on.
5971 * Also note that this function can't be used in the default case, because
5972 * the DQue bit isn't set in the changeable mask for the control mode page
5973 * anyway. This is just here as an example for how to implement a page
5974 * handler, and a placeholder in case we want to allow the user to turn
5975 * tagged queueing on and off.
5977 * The D_SENSE bit handling is functional, however, and will turn
5978 * descriptor sense on and off for a given LUN.
5981 ctl_control_page_handler(struct ctl_scsiio *ctsio,
5982 struct ctl_page_index *page_index, uint8_t *page_ptr)
5984 struct scsi_control_page *current_cp, *saved_cp, *user_cp;
5985 struct ctl_lun *lun;
5986 struct ctl_softc *softc;
5990 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5991 initidx = ctl_get_initindex(&ctsio->io_hdr.nexus);
5994 user_cp = (struct scsi_control_page *)page_ptr;
5995 current_cp = (struct scsi_control_page *)
5996 (page_index->page_data + (page_index->page_len *
5998 saved_cp = (struct scsi_control_page *)
5999 (page_index->page_data + (page_index->page_len *
6002 softc = control_softc;
6004 mtx_lock(&softc->ctl_lock);
6005 if (((current_cp->rlec & SCP_DSENSE) == 0)
6006 && ((user_cp->rlec & SCP_DSENSE) != 0)) {
6008 * Descriptor sense is currently turned off and the user
6009 * wants to turn it on.
6011 current_cp->rlec |= SCP_DSENSE;
6012 saved_cp->rlec |= SCP_DSENSE;
6013 lun->flags |= CTL_LUN_SENSE_DESC;
6015 } else if (((current_cp->rlec & SCP_DSENSE) != 0)
6016 && ((user_cp->rlec & SCP_DSENSE) == 0)) {
6018 * Descriptor sense is currently turned on, and the user
6019 * wants to turn it off.
6021 current_cp->rlec &= ~SCP_DSENSE;
6022 saved_cp->rlec &= ~SCP_DSENSE;
6023 lun->flags &= ~CTL_LUN_SENSE_DESC;
6026 if (current_cp->queue_flags & SCP_QUEUE_DQUE) {
6027 if (user_cp->queue_flags & SCP_QUEUE_DQUE) {
6029 csevent_log(CSC_CTL | CSC_SHELF_SW |
6031 csevent_LogType_Trace,
6032 csevent_Severity_Information,
6033 csevent_AlertLevel_Green,
6034 csevent_FRU_Firmware,
6035 csevent_FRU_Unknown,
6036 "Received untagged to untagged transition");
6037 #endif /* NEEDTOPORT */
6040 csevent_log(CSC_CTL | CSC_SHELF_SW |
6042 csevent_LogType_ConfigChange,
6043 csevent_Severity_Information,
6044 csevent_AlertLevel_Green,
6045 csevent_FRU_Firmware,
6046 csevent_FRU_Unknown,
6047 "Received untagged to tagged "
6048 "queueing transition");
6049 #endif /* NEEDTOPORT */
6051 current_cp->queue_flags &= ~SCP_QUEUE_DQUE;
6052 saved_cp->queue_flags &= ~SCP_QUEUE_DQUE;
6056 if (user_cp->queue_flags & SCP_QUEUE_DQUE) {
6058 csevent_log(CSC_CTL | CSC_SHELF_SW |
6060 csevent_LogType_ConfigChange,
6061 csevent_Severity_Warning,
6062 csevent_AlertLevel_Yellow,
6063 csevent_FRU_Firmware,
6064 csevent_FRU_Unknown,
6065 "Received tagged queueing to untagged "
6067 #endif /* NEEDTOPORT */
6069 current_cp->queue_flags |= SCP_QUEUE_DQUE;
6070 saved_cp->queue_flags |= SCP_QUEUE_DQUE;
6074 csevent_log(CSC_CTL | CSC_SHELF_SW |
6076 csevent_LogType_Trace,
6077 csevent_Severity_Information,
6078 csevent_AlertLevel_Green,
6079 csevent_FRU_Firmware,
6080 csevent_FRU_Unknown,
6081 "Received tagged queueing to tagged "
6082 "queueing transition");
6083 #endif /* NEEDTOPORT */
6089 * Let other initiators know that the mode
6090 * parameters for this LUN have changed.
6092 for (i = 0; i < CTL_MAX_INITIATORS; i++) {
6096 lun->pending_sense[i].ua_pending |=
6100 mtx_unlock(&softc->ctl_lock);
6106 ctl_power_sp_handler(struct ctl_scsiio *ctsio,
6107 struct ctl_page_index *page_index, uint8_t *page_ptr)
6113 ctl_power_sp_sense_handler(struct ctl_scsiio *ctsio,
6114 struct ctl_page_index *page_index, int pc)
6116 struct copan_power_subpage *page;
6118 page = (struct copan_power_subpage *)page_index->page_data +
6119 (page_index->page_len * pc);
6122 case SMS_PAGE_CTRL_CHANGEABLE >> 6:
6124 * We don't update the changable bits for this page.
6127 case SMS_PAGE_CTRL_CURRENT >> 6:
6128 case SMS_PAGE_CTRL_DEFAULT >> 6:
6129 case SMS_PAGE_CTRL_SAVED >> 6:
6131 ctl_update_power_subpage(page);
6136 EPRINT(0, "Invalid PC %d!!", pc);
6145 ctl_aps_sp_handler(struct ctl_scsiio *ctsio,
6146 struct ctl_page_index *page_index, uint8_t *page_ptr)
6148 struct copan_aps_subpage *user_sp;
6149 struct copan_aps_subpage *current_sp;
6150 union ctl_modepage_info *modepage_info;
6151 struct ctl_softc *softc;
6152 struct ctl_lun *lun;
6155 retval = CTL_RETVAL_COMPLETE;
6156 current_sp = (struct copan_aps_subpage *)(page_index->page_data +
6157 (page_index->page_len * CTL_PAGE_CURRENT));
6158 softc = control_softc;
6159 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
6161 user_sp = (struct copan_aps_subpage *)page_ptr;
6163 modepage_info = (union ctl_modepage_info *)
6164 ctsio->io_hdr.ctl_private[CTL_PRIV_MODEPAGE].bytes;
6166 modepage_info->header.page_code = page_index->page_code & SMPH_PC_MASK;
6167 modepage_info->header.subpage = page_index->subpage;
6168 modepage_info->aps.lock_active = user_sp->lock_active;
6170 mtx_lock(&softc->ctl_lock);
6173 * If there is a request to lock the LUN and another LUN is locked
6174 * this is an error. If the requested LUN is already locked ignore
6175 * the request. If no LUN is locked attempt to lock it.
6176 * if there is a request to unlock the LUN and the LUN is currently
6177 * locked attempt to unlock it. Otherwise ignore the request. i.e.
6178 * if another LUN is locked or no LUN is locked.
6180 if (user_sp->lock_active & APS_LOCK_ACTIVE) {
6181 if (softc->aps_locked_lun == lun->lun) {
6183 * This LUN is already locked, so we're done.
6185 retval = CTL_RETVAL_COMPLETE;
6186 } else if (softc->aps_locked_lun == 0) {
6188 * No one has the lock, pass the request to the
6191 retval = lun->backend->config_write(
6192 (union ctl_io *)ctsio);
6195 * Someone else has the lock, throw out the request.
6197 ctl_set_already_locked(ctsio);
6198 free(ctsio->kern_data_ptr, M_CTL);
6199 ctl_done((union ctl_io *)ctsio);
6202 * Set the return value so that ctl_do_mode_select()
6203 * won't try to complete the command. We already
6204 * completed it here.
6206 retval = CTL_RETVAL_ERROR;
6208 } else if (softc->aps_locked_lun == lun->lun) {
6210 * This LUN is locked, so pass the unlock request to the
6213 retval = lun->backend->config_write((union ctl_io *)ctsio);
6215 mtx_unlock(&softc->ctl_lock);
6221 ctl_debugconf_sp_select_handler(struct ctl_scsiio *ctsio,
6222 struct ctl_page_index *page_index,
6228 c = ((struct copan_debugconf_subpage *)page_ptr)->ctl_time_io_secs;
6233 CTL_DEBUG_PRINT(("set ctl_time_io_secs to %d\n", ctl_time_io_secs));
6234 printf("set ctl_time_io_secs to %d\n", ctl_time_io_secs);
6235 printf("page data:");
6237 printf(" %.2x",page_ptr[i]);
6243 ctl_debugconf_sp_sense_handler(struct ctl_scsiio *ctsio,
6244 struct ctl_page_index *page_index,
6247 struct copan_debugconf_subpage *page;
6249 page = (struct copan_debugconf_subpage *)page_index->page_data +
6250 (page_index->page_len * pc);
6253 case SMS_PAGE_CTRL_CHANGEABLE >> 6:
6254 case SMS_PAGE_CTRL_DEFAULT >> 6:
6255 case SMS_PAGE_CTRL_SAVED >> 6:
6257 * We don't update the changable or default bits for this page.
6260 case SMS_PAGE_CTRL_CURRENT >> 6:
6261 page->ctl_time_io_secs[0] = ctl_time_io_secs >> 8;
6262 page->ctl_time_io_secs[1] = ctl_time_io_secs >> 0;
6266 EPRINT(0, "Invalid PC %d!!", pc);
6267 #endif /* NEEDTOPORT */
6275 ctl_do_mode_select(union ctl_io *io)
6277 struct scsi_mode_page_header *page_header;
6278 struct ctl_page_index *page_index;
6279 struct ctl_scsiio *ctsio;
6280 int control_dev, page_len;
6281 int page_len_offset, page_len_size;
6282 union ctl_modepage_info *modepage_info;
6283 struct ctl_lun *lun;
6284 int *len_left, *len_used;
6287 ctsio = &io->scsiio;
6290 retval = CTL_RETVAL_COMPLETE;
6292 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
6294 if (lun->be_lun->lun_type != T_DIRECT)
6299 modepage_info = (union ctl_modepage_info *)
6300 ctsio->io_hdr.ctl_private[CTL_PRIV_MODEPAGE].bytes;
6301 len_left = &modepage_info->header.len_left;
6302 len_used = &modepage_info->header.len_used;
6306 page_header = (struct scsi_mode_page_header *)
6307 (ctsio->kern_data_ptr + *len_used);
6309 if (*len_left == 0) {
6310 free(ctsio->kern_data_ptr, M_CTL);
6311 ctl_set_success(ctsio);
6312 ctl_done((union ctl_io *)ctsio);
6313 return (CTL_RETVAL_COMPLETE);
6314 } else if (*len_left < sizeof(struct scsi_mode_page_header)) {
6316 free(ctsio->kern_data_ptr, M_CTL);
6317 ctl_set_param_len_error(ctsio);
6318 ctl_done((union ctl_io *)ctsio);
6319 return (CTL_RETVAL_COMPLETE);
6321 } else if ((page_header->page_code & SMPH_SPF)
6322 && (*len_left < sizeof(struct scsi_mode_page_header_sp))) {
6324 free(ctsio->kern_data_ptr, M_CTL);
6325 ctl_set_param_len_error(ctsio);
6326 ctl_done((union ctl_io *)ctsio);
6327 return (CTL_RETVAL_COMPLETE);
6332 * XXX KDM should we do something with the block descriptor?
6334 for (i = 0; i < CTL_NUM_MODE_PAGES; i++) {
6336 if ((control_dev != 0)
6337 && (lun->mode_pages.index[i].page_flags &
6338 CTL_PAGE_FLAG_DISK_ONLY))
6341 if ((lun->mode_pages.index[i].page_code & SMPH_PC_MASK) !=
6342 (page_header->page_code & SMPH_PC_MASK))
6346 * If neither page has a subpage code, then we've got a
6349 if (((lun->mode_pages.index[i].page_code & SMPH_SPF) == 0)
6350 && ((page_header->page_code & SMPH_SPF) == 0)) {
6351 page_index = &lun->mode_pages.index[i];
6352 page_len = page_header->page_length;
6357 * If both pages have subpages, then the subpage numbers
6360 if ((lun->mode_pages.index[i].page_code & SMPH_SPF)
6361 && (page_header->page_code & SMPH_SPF)) {
6362 struct scsi_mode_page_header_sp *sph;
6364 sph = (struct scsi_mode_page_header_sp *)page_header;
6366 if (lun->mode_pages.index[i].subpage ==
6368 page_index = &lun->mode_pages.index[i];
6369 page_len = scsi_2btoul(sph->page_length);
6376 * If we couldn't find the page, or if we don't have a mode select
6377 * handler for it, send back an error to the user.
6379 if ((page_index == NULL)
6380 || (page_index->select_handler == NULL)) {
6381 ctl_set_invalid_field(ctsio,
6384 /*field*/ *len_used,
6387 free(ctsio->kern_data_ptr, M_CTL);
6388 ctl_done((union ctl_io *)ctsio);
6389 return (CTL_RETVAL_COMPLETE);
6392 if (page_index->page_code & SMPH_SPF) {
6393 page_len_offset = 2;
6397 page_len_offset = 1;
6401 * If the length the initiator gives us isn't the one we specify in
6402 * the mode page header, or if they didn't specify enough data in
6403 * the CDB to avoid truncating this page, kick out the request.
6405 if ((page_len != (page_index->page_len - page_len_offset -
6407 || (*len_left < page_index->page_len)) {
6410 ctl_set_invalid_field(ctsio,
6413 /*field*/ *len_used + page_len_offset,
6416 free(ctsio->kern_data_ptr, M_CTL);
6417 ctl_done((union ctl_io *)ctsio);
6418 return (CTL_RETVAL_COMPLETE);
6422 * Run through the mode page, checking to make sure that the bits
6423 * the user changed are actually legal for him to change.
6425 for (i = 0; i < page_index->page_len; i++) {
6426 uint8_t *user_byte, *change_mask, *current_byte;
6430 user_byte = (uint8_t *)page_header + i;
6431 change_mask = page_index->page_data +
6432 (page_index->page_len * CTL_PAGE_CHANGEABLE) + i;
6433 current_byte = page_index->page_data +
6434 (page_index->page_len * CTL_PAGE_CURRENT) + i;
6437 * Check to see whether the user set any bits in this byte
6438 * that he is not allowed to set.
6440 if ((*user_byte & ~(*change_mask)) ==
6441 (*current_byte & ~(*change_mask)))
6445 * Go through bit by bit to determine which one is illegal.
6448 for (j = 7; j >= 0; j--) {
6449 if ((((1 << i) & ~(*change_mask)) & *user_byte) !=
6450 (((1 << i) & ~(*change_mask)) & *current_byte)) {
6455 ctl_set_invalid_field(ctsio,
6458 /*field*/ *len_used + i,
6461 free(ctsio->kern_data_ptr, M_CTL);
6462 ctl_done((union ctl_io *)ctsio);
6463 return (CTL_RETVAL_COMPLETE);
6467 * Decrement these before we call the page handler, since we may
6468 * end up getting called back one way or another before the handler
6469 * returns to this context.
6471 *len_left -= page_index->page_len;
6472 *len_used += page_index->page_len;
6474 retval = page_index->select_handler(ctsio, page_index,
6475 (uint8_t *)page_header);
6478 * If the page handler returns CTL_RETVAL_QUEUED, then we need to
6479 * wait until this queued command completes to finish processing
6480 * the mode page. If it returns anything other than
6481 * CTL_RETVAL_COMPLETE (e.g. CTL_RETVAL_ERROR), then it should have
6482 * already set the sense information, freed the data pointer, and
6483 * completed the io for us.
6485 if (retval != CTL_RETVAL_COMPLETE)
6486 goto bailout_no_done;
6489 * If the initiator sent us more than one page, parse the next one.
6494 ctl_set_success(ctsio);
6495 free(ctsio->kern_data_ptr, M_CTL);
6496 ctl_done((union ctl_io *)ctsio);
6500 return (CTL_RETVAL_COMPLETE);
6505 ctl_mode_select(struct ctl_scsiio *ctsio)
6507 int param_len, pf, sp;
6508 int header_size, bd_len;
6509 int len_left, len_used;
6510 struct ctl_page_index *page_index;
6511 struct ctl_lun *lun;
6512 int control_dev, page_len;
6513 union ctl_modepage_info *modepage_info;
6525 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
6527 if (lun->be_lun->lun_type != T_DIRECT)
6532 switch (ctsio->cdb[0]) {
6533 case MODE_SELECT_6: {
6534 struct scsi_mode_select_6 *cdb;
6536 cdb = (struct scsi_mode_select_6 *)ctsio->cdb;
6538 pf = (cdb->byte2 & SMS_PF) ? 1 : 0;
6539 sp = (cdb->byte2 & SMS_SP) ? 1 : 0;
6541 param_len = cdb->length;
6542 header_size = sizeof(struct scsi_mode_header_6);
6545 case MODE_SELECT_10: {
6546 struct scsi_mode_select_10 *cdb;
6548 cdb = (struct scsi_mode_select_10 *)ctsio->cdb;
6550 pf = (cdb->byte2 & SMS_PF) ? 1 : 0;
6551 sp = (cdb->byte2 & SMS_SP) ? 1 : 0;
6553 param_len = scsi_2btoul(cdb->length);
6554 header_size = sizeof(struct scsi_mode_header_10);
6558 ctl_set_invalid_opcode(ctsio);
6559 ctl_done((union ctl_io *)ctsio);
6560 return (CTL_RETVAL_COMPLETE);
6561 break; /* NOTREACHED */
6566 * "A parameter list length of zero indicates that the Data-Out Buffer
6567 * shall be empty. This condition shall not be considered as an error."
6569 if (param_len == 0) {
6570 ctl_set_success(ctsio);
6571 ctl_done((union ctl_io *)ctsio);
6572 return (CTL_RETVAL_COMPLETE);
6576 * Since we'll hit this the first time through, prior to
6577 * allocation, we don't need to free a data buffer here.
6579 if (param_len < header_size) {
6580 ctl_set_param_len_error(ctsio);
6581 ctl_done((union ctl_io *)ctsio);
6582 return (CTL_RETVAL_COMPLETE);
6586 * Allocate the data buffer and grab the user's data. In theory,
6587 * we shouldn't have to sanity check the parameter list length here
6588 * because the maximum size is 64K. We should be able to malloc
6589 * that much without too many problems.
6591 if ((ctsio->io_hdr.flags & CTL_FLAG_ALLOCATED) == 0) {
6592 ctsio->kern_data_ptr = malloc(param_len, M_CTL, M_WAITOK);
6593 ctsio->kern_data_len = param_len;
6594 ctsio->kern_total_len = param_len;
6595 ctsio->kern_data_resid = 0;
6596 ctsio->kern_rel_offset = 0;
6597 ctsio->kern_sg_entries = 0;
6598 ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
6599 ctsio->be_move_done = ctl_config_move_done;
6600 ctl_datamove((union ctl_io *)ctsio);
6602 return (CTL_RETVAL_COMPLETE);
6605 switch (ctsio->cdb[0]) {
6606 case MODE_SELECT_6: {
6607 struct scsi_mode_header_6 *mh6;
6609 mh6 = (struct scsi_mode_header_6 *)ctsio->kern_data_ptr;
6610 bd_len = mh6->blk_desc_len;
6613 case MODE_SELECT_10: {
6614 struct scsi_mode_header_10 *mh10;
6616 mh10 = (struct scsi_mode_header_10 *)ctsio->kern_data_ptr;
6617 bd_len = scsi_2btoul(mh10->blk_desc_len);
6621 panic("Invalid CDB type %#x", ctsio->cdb[0]);
6625 if (param_len < (header_size + bd_len)) {
6626 free(ctsio->kern_data_ptr, M_CTL);
6627 ctl_set_param_len_error(ctsio);
6628 ctl_done((union ctl_io *)ctsio);
6629 return (CTL_RETVAL_COMPLETE);
6633 * Set the IO_CONT flag, so that if this I/O gets passed to
6634 * ctl_config_write_done(), it'll get passed back to
6635 * ctl_do_mode_select() for further processing, or completion if
6638 ctsio->io_hdr.flags |= CTL_FLAG_IO_CONT;
6639 ctsio->io_cont = ctl_do_mode_select;
6641 modepage_info = (union ctl_modepage_info *)
6642 ctsio->io_hdr.ctl_private[CTL_PRIV_MODEPAGE].bytes;
6644 memset(modepage_info, 0, sizeof(*modepage_info));
6646 len_left = param_len - header_size - bd_len;
6647 len_used = header_size + bd_len;
6649 modepage_info->header.len_left = len_left;
6650 modepage_info->header.len_used = len_used;
6652 return (ctl_do_mode_select((union ctl_io *)ctsio));
6656 ctl_mode_sense(struct ctl_scsiio *ctsio)
6658 struct ctl_lun *lun;
6659 int pc, page_code, dbd, llba, subpage;
6660 int alloc_len, page_len, header_len, total_len;
6661 struct scsi_mode_block_descr *block_desc;
6662 struct ctl_page_index *page_index;
6670 CTL_DEBUG_PRINT(("ctl_mode_sense\n"));
6672 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
6674 if (lun->be_lun->lun_type != T_DIRECT)
6679 switch (ctsio->cdb[0]) {
6680 case MODE_SENSE_6: {
6681 struct scsi_mode_sense_6 *cdb;
6683 cdb = (struct scsi_mode_sense_6 *)ctsio->cdb;
6685 header_len = sizeof(struct scsi_mode_hdr_6);
6686 if (cdb->byte2 & SMS_DBD)
6689 header_len += sizeof(struct scsi_mode_block_descr);
6691 pc = (cdb->page & SMS_PAGE_CTRL_MASK) >> 6;
6692 page_code = cdb->page & SMS_PAGE_CODE;
6693 subpage = cdb->subpage;
6694 alloc_len = cdb->length;
6697 case MODE_SENSE_10: {
6698 struct scsi_mode_sense_10 *cdb;
6700 cdb = (struct scsi_mode_sense_10 *)ctsio->cdb;
6702 header_len = sizeof(struct scsi_mode_hdr_10);
6704 if (cdb->byte2 & SMS_DBD)
6707 header_len += sizeof(struct scsi_mode_block_descr);
6708 if (cdb->byte2 & SMS10_LLBAA)
6710 pc = (cdb->page & SMS_PAGE_CTRL_MASK) >> 6;
6711 page_code = cdb->page & SMS_PAGE_CODE;
6712 subpage = cdb->subpage;
6713 alloc_len = scsi_2btoul(cdb->length);
6717 ctl_set_invalid_opcode(ctsio);
6718 ctl_done((union ctl_io *)ctsio);
6719 return (CTL_RETVAL_COMPLETE);
6720 break; /* NOTREACHED */
6724 * We have to make a first pass through to calculate the size of
6725 * the pages that match the user's query. Then we allocate enough
6726 * memory to hold it, and actually copy the data into the buffer.
6728 switch (page_code) {
6729 case SMS_ALL_PAGES_PAGE: {
6735 * At the moment, values other than 0 and 0xff here are
6736 * reserved according to SPC-3.
6738 if ((subpage != SMS_SUBPAGE_PAGE_0)
6739 && (subpage != SMS_SUBPAGE_ALL)) {
6740 ctl_set_invalid_field(ctsio,
6746 ctl_done((union ctl_io *)ctsio);
6747 return (CTL_RETVAL_COMPLETE);
6750 for (i = 0; i < CTL_NUM_MODE_PAGES; i++) {
6751 if ((control_dev != 0)
6752 && (lun->mode_pages.index[i].page_flags &
6753 CTL_PAGE_FLAG_DISK_ONLY))
6757 * We don't use this subpage if the user didn't
6758 * request all subpages.
6760 if ((lun->mode_pages.index[i].subpage != 0)
6761 && (subpage == SMS_SUBPAGE_PAGE_0))
6765 printf("found page %#x len %d\n",
6766 lun->mode_pages.index[i].page_code &
6768 lun->mode_pages.index[i].page_len);
6770 page_len += lun->mode_pages.index[i].page_len;
6779 for (i = 0; i < CTL_NUM_MODE_PAGES; i++) {
6780 /* Look for the right page code */
6781 if ((lun->mode_pages.index[i].page_code &
6782 SMPH_PC_MASK) != page_code)
6785 /* Look for the right subpage or the subpage wildcard*/
6786 if ((lun->mode_pages.index[i].subpage != subpage)
6787 && (subpage != SMS_SUBPAGE_ALL))
6790 /* Make sure the page is supported for this dev type */
6791 if ((control_dev != 0)
6792 && (lun->mode_pages.index[i].page_flags &
6793 CTL_PAGE_FLAG_DISK_ONLY))
6797 printf("found page %#x len %d\n",
6798 lun->mode_pages.index[i].page_code &
6800 lun->mode_pages.index[i].page_len);
6803 page_len += lun->mode_pages.index[i].page_len;
6806 if (page_len == 0) {
6807 ctl_set_invalid_field(ctsio,
6813 ctl_done((union ctl_io *)ctsio);
6814 return (CTL_RETVAL_COMPLETE);
6820 total_len = header_len + page_len;
6822 printf("header_len = %d, page_len = %d, total_len = %d\n",
6823 header_len, page_len, total_len);
6826 ctsio->kern_data_ptr = malloc(total_len, M_CTL, M_WAITOK | M_ZERO);
6827 ctsio->kern_sg_entries = 0;
6828 ctsio->kern_data_resid = 0;
6829 ctsio->kern_rel_offset = 0;
6830 if (total_len < alloc_len) {
6831 ctsio->residual = alloc_len - total_len;
6832 ctsio->kern_data_len = total_len;
6833 ctsio->kern_total_len = total_len;
6835 ctsio->residual = 0;
6836 ctsio->kern_data_len = alloc_len;
6837 ctsio->kern_total_len = alloc_len;
6840 switch (ctsio->cdb[0]) {
6841 case MODE_SENSE_6: {
6842 struct scsi_mode_hdr_6 *header;
6844 header = (struct scsi_mode_hdr_6 *)ctsio->kern_data_ptr;
6846 header->datalen = ctl_min(total_len - 1, 254);
6849 header->block_descr_len = 0;
6851 header->block_descr_len =
6852 sizeof(struct scsi_mode_block_descr);
6853 block_desc = (struct scsi_mode_block_descr *)&header[1];
6856 case MODE_SENSE_10: {
6857 struct scsi_mode_hdr_10 *header;
6860 header = (struct scsi_mode_hdr_10 *)ctsio->kern_data_ptr;
6862 datalen = ctl_min(total_len - 2, 65533);
6863 scsi_ulto2b(datalen, header->datalen);
6865 scsi_ulto2b(0, header->block_descr_len);
6867 scsi_ulto2b(sizeof(struct scsi_mode_block_descr),
6868 header->block_descr_len);
6869 block_desc = (struct scsi_mode_block_descr *)&header[1];
6873 panic("invalid CDB type %#x", ctsio->cdb[0]);
6874 break; /* NOTREACHED */
6878 * If we've got a disk, use its blocksize in the block
6879 * descriptor. Otherwise, just set it to 0.
6882 if (control_dev != 0)
6883 scsi_ulto3b(lun->be_lun->blocksize,
6884 block_desc->block_len);
6886 scsi_ulto3b(0, block_desc->block_len);
6889 switch (page_code) {
6890 case SMS_ALL_PAGES_PAGE: {
6893 data_used = header_len;
6894 for (i = 0; i < CTL_NUM_MODE_PAGES; i++) {
6895 struct ctl_page_index *page_index;
6897 page_index = &lun->mode_pages.index[i];
6899 if ((control_dev != 0)
6900 && (page_index->page_flags &
6901 CTL_PAGE_FLAG_DISK_ONLY))
6905 * We don't use this subpage if the user didn't
6906 * request all subpages. We already checked (above)
6907 * to make sure the user only specified a subpage
6908 * of 0 or 0xff in the SMS_ALL_PAGES_PAGE case.
6910 if ((page_index->subpage != 0)
6911 && (subpage == SMS_SUBPAGE_PAGE_0))
6915 * Call the handler, if it exists, to update the
6916 * page to the latest values.
6918 if (page_index->sense_handler != NULL)
6919 page_index->sense_handler(ctsio, page_index,pc);
6921 memcpy(ctsio->kern_data_ptr + data_used,
6922 page_index->page_data +
6923 (page_index->page_len * pc),
6924 page_index->page_len);
6925 data_used += page_index->page_len;
6932 data_used = header_len;
6934 for (i = 0; i < CTL_NUM_MODE_PAGES; i++) {
6935 struct ctl_page_index *page_index;
6937 page_index = &lun->mode_pages.index[i];
6939 /* Look for the right page code */
6940 if ((page_index->page_code & SMPH_PC_MASK) != page_code)
6943 /* Look for the right subpage or the subpage wildcard*/
6944 if ((page_index->subpage != subpage)
6945 && (subpage != SMS_SUBPAGE_ALL))
6948 /* Make sure the page is supported for this dev type */
6949 if ((control_dev != 0)
6950 && (page_index->page_flags &
6951 CTL_PAGE_FLAG_DISK_ONLY))
6955 * Call the handler, if it exists, to update the
6956 * page to the latest values.
6958 if (page_index->sense_handler != NULL)
6959 page_index->sense_handler(ctsio, page_index,pc);
6961 memcpy(ctsio->kern_data_ptr + data_used,
6962 page_index->page_data +
6963 (page_index->page_len * pc),
6964 page_index->page_len);
6965 data_used += page_index->page_len;
6971 ctsio->scsi_status = SCSI_STATUS_OK;
6973 ctsio->be_move_done = ctl_config_move_done;
6974 ctl_datamove((union ctl_io *)ctsio);
6976 return (CTL_RETVAL_COMPLETE);
6980 ctl_read_capacity(struct ctl_scsiio *ctsio)
6982 struct scsi_read_capacity *cdb;
6983 struct scsi_read_capacity_data *data;
6984 struct ctl_lun *lun;
6987 CTL_DEBUG_PRINT(("ctl_read_capacity\n"));
6989 cdb = (struct scsi_read_capacity *)ctsio->cdb;
6991 lba = scsi_4btoul(cdb->addr);
6992 if (((cdb->pmi & SRC_PMI) == 0)
6994 ctl_set_invalid_field(/*ctsio*/ ctsio,
7000 ctl_done((union ctl_io *)ctsio);
7001 return (CTL_RETVAL_COMPLETE);
7004 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
7006 ctsio->kern_data_ptr = malloc(sizeof(*data), M_CTL, M_WAITOK | M_ZERO);
7007 data = (struct scsi_read_capacity_data *)ctsio->kern_data_ptr;
7008 ctsio->residual = 0;
7009 ctsio->kern_data_len = sizeof(*data);
7010 ctsio->kern_total_len = sizeof(*data);
7011 ctsio->kern_data_resid = 0;
7012 ctsio->kern_rel_offset = 0;
7013 ctsio->kern_sg_entries = 0;
7016 * If the maximum LBA is greater than 0xfffffffe, the user must
7017 * issue a SERVICE ACTION IN (16) command, with the read capacity
7018 * serivce action set.
7020 if (lun->be_lun->maxlba > 0xfffffffe)
7021 scsi_ulto4b(0xffffffff, data->addr);
7023 scsi_ulto4b(lun->be_lun->maxlba, data->addr);
7026 * XXX KDM this may not be 512 bytes...
7028 scsi_ulto4b(lun->be_lun->blocksize, data->length);
7030 ctsio->scsi_status = SCSI_STATUS_OK;
7032 ctsio->be_move_done = ctl_config_move_done;
7033 ctl_datamove((union ctl_io *)ctsio);
7035 return (CTL_RETVAL_COMPLETE);
7039 ctl_read_capacity_16(struct ctl_scsiio *ctsio)
7041 struct scsi_read_capacity_16 *cdb;
7042 struct scsi_read_capacity_data_long *data;
7043 struct ctl_lun *lun;
7047 CTL_DEBUG_PRINT(("ctl_read_capacity_16\n"));
7049 cdb = (struct scsi_read_capacity_16 *)ctsio->cdb;
7051 alloc_len = scsi_4btoul(cdb->alloc_len);
7052 lba = scsi_8btou64(cdb->addr);
7054 if ((cdb->reladr & SRC16_PMI)
7056 ctl_set_invalid_field(/*ctsio*/ ctsio,
7062 ctl_done((union ctl_io *)ctsio);
7063 return (CTL_RETVAL_COMPLETE);
7066 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
7068 ctsio->kern_data_ptr = malloc(sizeof(*data), M_CTL, M_WAITOK | M_ZERO);
7069 data = (struct scsi_read_capacity_data_long *)ctsio->kern_data_ptr;
7071 if (sizeof(*data) < alloc_len) {
7072 ctsio->residual = alloc_len - sizeof(*data);
7073 ctsio->kern_data_len = sizeof(*data);
7074 ctsio->kern_total_len = sizeof(*data);
7076 ctsio->residual = 0;
7077 ctsio->kern_data_len = alloc_len;
7078 ctsio->kern_total_len = alloc_len;
7080 ctsio->kern_data_resid = 0;
7081 ctsio->kern_rel_offset = 0;
7082 ctsio->kern_sg_entries = 0;
7084 scsi_u64to8b(lun->be_lun->maxlba, data->addr);
7085 /* XXX KDM this may not be 512 bytes... */
7086 scsi_ulto4b(lun->be_lun->blocksize, data->length);
7087 data->prot_lbppbe = lun->be_lun->pblockexp & SRC16_LBPPBE;
7088 scsi_ulto2b(lun->be_lun->pblockoff & SRC16_LALBA_A, data->lalba_lbp);
7089 if (lun->be_lun->flags & CTL_LUN_FLAG_UNMAP)
7090 data->lalba_lbp[0] |= SRC16_LBPME;
7092 ctsio->scsi_status = SCSI_STATUS_OK;
7094 ctsio->be_move_done = ctl_config_move_done;
7095 ctl_datamove((union ctl_io *)ctsio);
7097 return (CTL_RETVAL_COMPLETE);
7101 ctl_service_action_in(struct ctl_scsiio *ctsio)
7103 struct scsi_service_action_in *cdb;
7106 CTL_DEBUG_PRINT(("ctl_service_action_in\n"));
7108 cdb = (struct scsi_service_action_in *)ctsio->cdb;
7110 retval = CTL_RETVAL_COMPLETE;
7112 switch (cdb->service_action) {
7113 case SRC16_SERVICE_ACTION:
7114 retval = ctl_read_capacity_16(ctsio);
7117 ctl_set_invalid_field(/*ctsio*/ ctsio,
7123 ctl_done((union ctl_io *)ctsio);
7131 ctl_maintenance_in(struct ctl_scsiio *ctsio)
7133 struct scsi_maintenance_in *cdb;
7135 int alloc_len, total_len = 0;
7136 int num_target_port_groups, single;
7137 struct ctl_lun *lun;
7138 struct ctl_softc *softc;
7139 struct scsi_target_group_data *rtg_ptr;
7140 struct scsi_target_port_group_descriptor *tpg_desc_ptr1, *tpg_desc_ptr2;
7141 struct scsi_target_port_descriptor *tp_desc_ptr1_1, *tp_desc_ptr1_2,
7142 *tp_desc_ptr2_1, *tp_desc_ptr2_2;
7144 CTL_DEBUG_PRINT(("ctl_maintenance_in\n"));
7146 cdb = (struct scsi_maintenance_in *)ctsio->cdb;
7147 softc = control_softc;
7148 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
7150 retval = CTL_RETVAL_COMPLETE;
7152 if ((cdb->byte2 & SERVICE_ACTION_MASK) != SA_RPRT_TRGT_GRP) {
7153 ctl_set_invalid_field(/*ctsio*/ ctsio,
7159 ctl_done((union ctl_io *)ctsio);
7163 mtx_lock(&softc->ctl_lock);
7164 single = ctl_is_single;
7165 mtx_unlock(&softc->ctl_lock);
7168 num_target_port_groups = NUM_TARGET_PORT_GROUPS - 1;
7170 num_target_port_groups = NUM_TARGET_PORT_GROUPS;
7172 total_len = sizeof(struct scsi_target_group_data) +
7173 sizeof(struct scsi_target_port_group_descriptor) *
7174 num_target_port_groups +
7175 sizeof(struct scsi_target_port_descriptor) *
7176 NUM_PORTS_PER_GRP * num_target_port_groups;
7178 alloc_len = scsi_4btoul(cdb->length);
7180 ctsio->kern_data_ptr = malloc(total_len, M_CTL, M_WAITOK | M_ZERO);
7182 ctsio->kern_sg_entries = 0;
7184 if (total_len < alloc_len) {
7185 ctsio->residual = alloc_len - total_len;
7186 ctsio->kern_data_len = total_len;
7187 ctsio->kern_total_len = total_len;
7189 ctsio->residual = 0;
7190 ctsio->kern_data_len = alloc_len;
7191 ctsio->kern_total_len = alloc_len;
7193 ctsio->kern_data_resid = 0;
7194 ctsio->kern_rel_offset = 0;
7196 rtg_ptr = (struct scsi_target_group_data *)ctsio->kern_data_ptr;
7198 tpg_desc_ptr1 = &rtg_ptr->groups[0];
7199 tp_desc_ptr1_1 = &tpg_desc_ptr1->descriptors[0];
7200 tp_desc_ptr1_2 = (struct scsi_target_port_descriptor *)
7201 &tp_desc_ptr1_1->desc_list[0];
7204 tpg_desc_ptr2 = (struct scsi_target_port_group_descriptor *)
7205 &tp_desc_ptr1_2->desc_list[0];
7206 tp_desc_ptr2_1 = &tpg_desc_ptr2->descriptors[0];
7207 tp_desc_ptr2_2 = (struct scsi_target_port_descriptor *)
7208 &tp_desc_ptr2_1->desc_list[0];
7210 tpg_desc_ptr2 = NULL;
7211 tp_desc_ptr2_1 = NULL;
7212 tp_desc_ptr2_2 = NULL;
7215 scsi_ulto4b(total_len - 4, rtg_ptr->length);
7217 if (ctsio->io_hdr.nexus.targ_port < CTL_MAX_PORTS) {
7218 if (lun->flags & CTL_LUN_PRIMARY_SC) {
7219 tpg_desc_ptr1->pref_state = TPG_PRIMARY;
7220 tpg_desc_ptr2->pref_state =
7221 TPG_ASYMMETRIC_ACCESS_NONOPTIMIZED;
7223 tpg_desc_ptr1->pref_state =
7224 TPG_ASYMMETRIC_ACCESS_NONOPTIMIZED;
7225 tpg_desc_ptr2->pref_state = TPG_PRIMARY;
7228 if (lun->flags & CTL_LUN_PRIMARY_SC) {
7229 tpg_desc_ptr1->pref_state =
7230 TPG_ASYMMETRIC_ACCESS_NONOPTIMIZED;
7231 tpg_desc_ptr2->pref_state = TPG_PRIMARY;
7233 tpg_desc_ptr1->pref_state = TPG_PRIMARY;
7234 tpg_desc_ptr2->pref_state =
7235 TPG_ASYMMETRIC_ACCESS_NONOPTIMIZED;
7239 tpg_desc_ptr1->pref_state = TPG_PRIMARY;
7241 tpg_desc_ptr1->support = 0;
7242 tpg_desc_ptr1->target_port_group[1] = 1;
7243 tpg_desc_ptr1->status = TPG_IMPLICIT;
7244 tpg_desc_ptr1->target_port_count= NUM_PORTS_PER_GRP;
7247 tpg_desc_ptr2->support = 0;
7248 tpg_desc_ptr2->target_port_group[1] = 2;
7249 tpg_desc_ptr2->status = TPG_IMPLICIT;
7250 tpg_desc_ptr2->target_port_count = NUM_PORTS_PER_GRP;
7252 tp_desc_ptr1_1->relative_target_port_identifier[1] = 1;
7253 tp_desc_ptr1_2->relative_target_port_identifier[1] = 2;
7255 tp_desc_ptr2_1->relative_target_port_identifier[1] = 9;
7256 tp_desc_ptr2_2->relative_target_port_identifier[1] = 10;
7258 if (ctsio->io_hdr.nexus.targ_port < CTL_MAX_PORTS) {
7259 tp_desc_ptr1_1->relative_target_port_identifier[1] = 1;
7260 tp_desc_ptr1_2->relative_target_port_identifier[1] = 2;
7262 tp_desc_ptr1_1->relative_target_port_identifier[1] = 9;
7263 tp_desc_ptr1_2->relative_target_port_identifier[1] = 10;
7267 ctsio->be_move_done = ctl_config_move_done;
7269 CTL_DEBUG_PRINT(("buf = %x %x %x %x %x %x %x %x\n",
7270 ctsio->kern_data_ptr[0], ctsio->kern_data_ptr[1],
7271 ctsio->kern_data_ptr[2], ctsio->kern_data_ptr[3],
7272 ctsio->kern_data_ptr[4], ctsio->kern_data_ptr[5],
7273 ctsio->kern_data_ptr[6], ctsio->kern_data_ptr[7]));
7275 ctl_datamove((union ctl_io *)ctsio);
7280 ctl_persistent_reserve_in(struct ctl_scsiio *ctsio)
7282 struct scsi_per_res_in *cdb;
7283 int alloc_len, total_len = 0;
7284 /* struct scsi_per_res_in_rsrv in_data; */
7285 struct ctl_lun *lun;
7286 struct ctl_softc *softc;
7288 CTL_DEBUG_PRINT(("ctl_persistent_reserve_in\n"));
7290 softc = control_softc;
7292 cdb = (struct scsi_per_res_in *)ctsio->cdb;
7294 alloc_len = scsi_2btoul(cdb->length);
7296 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
7299 mtx_lock(&softc->ctl_lock);
7300 switch (cdb->action) {
7301 case SPRI_RK: /* read keys */
7302 total_len = sizeof(struct scsi_per_res_in_keys) +
7304 sizeof(struct scsi_per_res_key);
7306 case SPRI_RR: /* read reservation */
7307 if (lun->flags & CTL_LUN_PR_RESERVED)
7308 total_len = sizeof(struct scsi_per_res_in_rsrv);
7310 total_len = sizeof(struct scsi_per_res_in_header);
7312 case SPRI_RC: /* report capabilities */
7313 total_len = sizeof(struct scsi_per_res_cap);
7315 case SPRI_RS: /* read full status */
7317 mtx_unlock(&softc->ctl_lock);
7318 ctl_set_invalid_field(ctsio,
7324 ctl_done((union ctl_io *)ctsio);
7325 return (CTL_RETVAL_COMPLETE);
7326 break; /* NOTREACHED */
7328 mtx_unlock(&softc->ctl_lock);
7330 ctsio->kern_data_ptr = malloc(total_len, M_CTL, M_WAITOK | M_ZERO);
7332 if (total_len < alloc_len) {
7333 ctsio->residual = alloc_len - total_len;
7334 ctsio->kern_data_len = total_len;
7335 ctsio->kern_total_len = total_len;
7337 ctsio->residual = 0;
7338 ctsio->kern_data_len = alloc_len;
7339 ctsio->kern_total_len = alloc_len;
7342 ctsio->kern_data_resid = 0;
7343 ctsio->kern_rel_offset = 0;
7344 ctsio->kern_sg_entries = 0;
7346 mtx_lock(&softc->ctl_lock);
7347 switch (cdb->action) {
7348 case SPRI_RK: { // read keys
7349 struct scsi_per_res_in_keys *res_keys;
7352 res_keys = (struct scsi_per_res_in_keys*)ctsio->kern_data_ptr;
7355 * We had to drop the lock to allocate our buffer, which
7356 * leaves time for someone to come in with another
7357 * persistent reservation. (That is unlikely, though,
7358 * since this should be the only persistent reservation
7359 * command active right now.)
7361 if (total_len != (sizeof(struct scsi_per_res_in_keys) +
7362 (lun->pr_key_count *
7363 sizeof(struct scsi_per_res_key)))){
7364 mtx_unlock(&softc->ctl_lock);
7365 free(ctsio->kern_data_ptr, M_CTL);
7366 printf("%s: reservation length changed, retrying\n",
7371 scsi_ulto4b(lun->PRGeneration, res_keys->header.generation);
7373 scsi_ulto4b(sizeof(struct scsi_per_res_key) *
7374 lun->pr_key_count, res_keys->header.length);
7376 for (i = 0, key_count = 0; i < 2*CTL_MAX_INITIATORS; i++) {
7377 if (!lun->per_res[i].registered)
7381 * We used lun->pr_key_count to calculate the
7382 * size to allocate. If it turns out the number of
7383 * initiators with the registered flag set is
7384 * larger than that (i.e. they haven't been kept in
7385 * sync), we've got a problem.
7387 if (key_count >= lun->pr_key_count) {
7389 csevent_log(CSC_CTL | CSC_SHELF_SW |
7391 csevent_LogType_Fault,
7392 csevent_AlertLevel_Yellow,
7393 csevent_FRU_ShelfController,
7394 csevent_FRU_Firmware,
7395 csevent_FRU_Unknown,
7396 "registered keys %d >= key "
7397 "count %d", key_count,
7403 memcpy(res_keys->keys[key_count].key,
7404 lun->per_res[i].res_key.key,
7405 ctl_min(sizeof(res_keys->keys[key_count].key),
7406 sizeof(lun->per_res[i].res_key)));
7411 case SPRI_RR: { // read reservation
7412 struct scsi_per_res_in_rsrv *res;
7413 int tmp_len, header_only;
7415 res = (struct scsi_per_res_in_rsrv *)ctsio->kern_data_ptr;
7417 scsi_ulto4b(lun->PRGeneration, res->header.generation);
7419 if (lun->flags & CTL_LUN_PR_RESERVED)
7421 tmp_len = sizeof(struct scsi_per_res_in_rsrv);
7422 scsi_ulto4b(sizeof(struct scsi_per_res_in_rsrv_data),
7423 res->header.length);
7426 tmp_len = sizeof(struct scsi_per_res_in_header);
7427 scsi_ulto4b(0, res->header.length);
7432 * We had to drop the lock to allocate our buffer, which
7433 * leaves time for someone to come in with another
7434 * persistent reservation. (That is unlikely, though,
7435 * since this should be the only persistent reservation
7436 * command active right now.)
7438 if (tmp_len != total_len) {
7439 mtx_unlock(&softc->ctl_lock);
7440 free(ctsio->kern_data_ptr, M_CTL);
7441 printf("%s: reservation status changed, retrying\n",
7447 * No reservation held, so we're done.
7449 if (header_only != 0)
7453 * If the registration is an All Registrants type, the key
7454 * is 0, since it doesn't really matter.
7456 if (lun->pr_res_idx != CTL_PR_ALL_REGISTRANTS) {
7457 memcpy(res->data.reservation,
7458 &lun->per_res[lun->pr_res_idx].res_key,
7459 sizeof(struct scsi_per_res_key));
7461 res->data.scopetype = lun->res_type;
7464 case SPRI_RC: //report capabilities
7466 struct scsi_per_res_cap *res_cap;
7469 res_cap = (struct scsi_per_res_cap *)ctsio->kern_data_ptr;
7470 scsi_ulto2b(sizeof(*res_cap), res_cap->length);
7471 res_cap->flags2 |= SPRI_TMV;
7472 type_mask = SPRI_TM_WR_EX_AR |
7478 scsi_ulto2b(type_mask, res_cap->type_mask);
7481 case SPRI_RS: //read full status
7484 * This is a bug, because we just checked for this above,
7485 * and should have returned an error.
7487 panic("Invalid PR type %x", cdb->action);
7488 break; /* NOTREACHED */
7490 mtx_unlock(&softc->ctl_lock);
7492 ctsio->be_move_done = ctl_config_move_done;
7494 CTL_DEBUG_PRINT(("buf = %x %x %x %x %x %x %x %x\n",
7495 ctsio->kern_data_ptr[0], ctsio->kern_data_ptr[1],
7496 ctsio->kern_data_ptr[2], ctsio->kern_data_ptr[3],
7497 ctsio->kern_data_ptr[4], ctsio->kern_data_ptr[5],
7498 ctsio->kern_data_ptr[6], ctsio->kern_data_ptr[7]));
7500 ctl_datamove((union ctl_io *)ctsio);
7502 return (CTL_RETVAL_COMPLETE);
7506 * Returns 0 if ctl_persistent_reserve_out() should continue, non-zero if
7510 ctl_pro_preempt(struct ctl_softc *softc, struct ctl_lun *lun, uint64_t res_key,
7511 uint64_t sa_res_key, uint8_t type, uint32_t residx,
7512 struct ctl_scsiio *ctsio, struct scsi_per_res_out *cdb,
7513 struct scsi_per_res_out_parms* param)
7515 union ctl_ha_msg persis_io;
7521 if (sa_res_key == 0) {
7522 mtx_lock(&softc->ctl_lock);
7523 if (lun->pr_res_idx == CTL_PR_ALL_REGISTRANTS) {
7524 /* validate scope and type */
7525 if ((cdb->scope_type & SPR_SCOPE_MASK) !=
7527 mtx_unlock(&softc->ctl_lock);
7528 ctl_set_invalid_field(/*ctsio*/ ctsio,
7534 ctl_done((union ctl_io *)ctsio);
7538 if (type>8 || type==2 || type==4 || type==0) {
7539 mtx_unlock(&softc->ctl_lock);
7540 ctl_set_invalid_field(/*ctsio*/ ctsio,
7546 ctl_done((union ctl_io *)ctsio);
7550 /* temporarily unregister this nexus */
7551 lun->per_res[residx].registered = 0;
7554 * Unregister everybody else and build UA for
7557 for(i=0; i < 2*CTL_MAX_INITIATORS; i++) {
7558 if (lun->per_res[i].registered == 0)
7562 && i <CTL_MAX_INITIATORS)
7563 lun->pending_sense[i].ua_pending |=
7565 else if (persis_offset
7566 && i >= persis_offset)
7567 lun->pending_sense[i-persis_offset
7570 lun->per_res[i].registered = 0;
7571 memset(&lun->per_res[i].res_key, 0,
7572 sizeof(struct scsi_per_res_key));
7574 lun->per_res[residx].registered = 1;
7575 lun->pr_key_count = 1;
7576 lun->res_type = type;
7577 if (lun->res_type != SPR_TYPE_WR_EX_AR
7578 && lun->res_type != SPR_TYPE_EX_AC_AR)
7579 lun->pr_res_idx = residx;
7581 mtx_unlock(&softc->ctl_lock);
7582 /* send msg to other side */
7583 persis_io.hdr.nexus = ctsio->io_hdr.nexus;
7584 persis_io.hdr.msg_type = CTL_MSG_PERS_ACTION;
7585 persis_io.pr.pr_info.action = CTL_PR_PREEMPT;
7586 persis_io.pr.pr_info.residx = lun->pr_res_idx;
7587 persis_io.pr.pr_info.res_type = type;
7588 memcpy(persis_io.pr.pr_info.sa_res_key,
7589 param->serv_act_res_key,
7590 sizeof(param->serv_act_res_key));
7591 if ((isc_retval=ctl_ha_msg_send(CTL_HA_CHAN_CTL,
7592 &persis_io, sizeof(persis_io), 0)) >
7593 CTL_HA_STATUS_SUCCESS) {
7594 printf("CTL:Persis Out error returned "
7595 "from ctl_ha_msg_send %d\n",
7599 /* not all registrants */
7600 mtx_unlock(&softc->ctl_lock);
7601 free(ctsio->kern_data_ptr, M_CTL);
7602 ctl_set_invalid_field(ctsio,
7608 ctl_done((union ctl_io *)ctsio);
7611 } else if (lun->pr_res_idx == CTL_PR_ALL_REGISTRANTS
7612 || !(lun->flags & CTL_LUN_PR_RESERVED)) {
7615 mtx_lock(&softc->ctl_lock);
7616 if (res_key == sa_res_key) {
7619 * The spec implies this is not good but doesn't
7620 * say what to do. There are two choices either
7621 * generate a res conflict or check condition
7622 * with illegal field in parameter data. Since
7623 * that is what is done when the sa_res_key is
7624 * zero I'll take that approach since this has
7625 * to do with the sa_res_key.
7627 mtx_unlock(&softc->ctl_lock);
7628 free(ctsio->kern_data_ptr, M_CTL);
7629 ctl_set_invalid_field(ctsio,
7635 ctl_done((union ctl_io *)ctsio);
7639 for (i=0; i < 2*CTL_MAX_INITIATORS; i++) {
7640 if (lun->per_res[i].registered
7641 && memcmp(param->serv_act_res_key,
7642 lun->per_res[i].res_key.key,
7643 sizeof(struct scsi_per_res_key)) != 0)
7647 lun->per_res[i].registered = 0;
7648 memset(&lun->per_res[i].res_key, 0,
7649 sizeof(struct scsi_per_res_key));
7650 lun->pr_key_count--;
7653 && i < CTL_MAX_INITIATORS)
7654 lun->pending_sense[i].ua_pending |=
7656 else if (persis_offset
7657 && i >= persis_offset)
7658 lun->pending_sense[i-persis_offset].ua_pending|=
7661 mtx_unlock(&softc->ctl_lock);
7663 free(ctsio->kern_data_ptr, M_CTL);
7664 ctl_set_reservation_conflict(ctsio);
7665 ctl_done((union ctl_io *)ctsio);
7666 return (CTL_RETVAL_COMPLETE);
7668 /* send msg to other side */
7669 persis_io.hdr.nexus = ctsio->io_hdr.nexus;
7670 persis_io.hdr.msg_type = CTL_MSG_PERS_ACTION;
7671 persis_io.pr.pr_info.action = CTL_PR_PREEMPT;
7672 persis_io.pr.pr_info.residx = lun->pr_res_idx;
7673 persis_io.pr.pr_info.res_type = type;
7674 memcpy(persis_io.pr.pr_info.sa_res_key,
7675 param->serv_act_res_key,
7676 sizeof(param->serv_act_res_key));
7677 if ((isc_retval=ctl_ha_msg_send(CTL_HA_CHAN_CTL,
7678 &persis_io, sizeof(persis_io), 0)) >
7679 CTL_HA_STATUS_SUCCESS) {
7680 printf("CTL:Persis Out error returned from "
7681 "ctl_ha_msg_send %d\n", isc_retval);
7684 /* Reserved but not all registrants */
7685 /* sa_res_key is res holder */
7686 if (memcmp(param->serv_act_res_key,
7687 lun->per_res[lun->pr_res_idx].res_key.key,
7688 sizeof(struct scsi_per_res_key)) == 0) {
7689 /* validate scope and type */
7690 if ((cdb->scope_type & SPR_SCOPE_MASK) !=
7692 ctl_set_invalid_field(/*ctsio*/ ctsio,
7698 ctl_done((union ctl_io *)ctsio);
7702 if (type>8 || type==2 || type==4 || type==0) {
7703 ctl_set_invalid_field(/*ctsio*/ ctsio,
7709 ctl_done((union ctl_io *)ctsio);
7715 * if sa_res_key != res_key remove all
7716 * registrants w/sa_res_key and generate UA
7717 * for these registrants(Registrations
7718 * Preempted) if it wasn't an exclusive
7719 * reservation generate UA(Reservations
7720 * Preempted) for all other registered nexuses
7721 * if the type has changed. Establish the new
7722 * reservation and holder. If res_key and
7723 * sa_res_key are the same do the above
7724 * except don't unregister the res holder.
7728 * Temporarily unregister so it won't get
7729 * removed or UA generated
7731 lun->per_res[residx].registered = 0;
7732 for(i=0; i < 2*CTL_MAX_INITIATORS; i++) {
7733 if (lun->per_res[i].registered == 0)
7736 if (memcmp(param->serv_act_res_key,
7737 lun->per_res[i].res_key.key,
7738 sizeof(struct scsi_per_res_key)) == 0) {
7739 lun->per_res[i].registered = 0;
7740 memset(&lun->per_res[i].res_key,
7742 sizeof(struct scsi_per_res_key));
7743 lun->pr_key_count--;
7746 && i < CTL_MAX_INITIATORS)
7747 lun->pending_sense[i
7750 else if (persis_offset
7751 && i >= persis_offset)
7753 i-persis_offset].ua_pending |=
7755 } else if (type != lun->res_type
7756 && (lun->res_type == SPR_TYPE_WR_EX_RO
7757 || lun->res_type ==SPR_TYPE_EX_AC_RO)){
7759 && i < CTL_MAX_INITIATORS)
7760 lun->pending_sense[i
7763 else if (persis_offset
7764 && i >= persis_offset)
7771 lun->per_res[residx].registered = 1;
7772 lun->res_type = type;
7773 if (lun->res_type != SPR_TYPE_WR_EX_AR
7774 && lun->res_type != SPR_TYPE_EX_AC_AR)
7775 lun->pr_res_idx = residx;
7778 CTL_PR_ALL_REGISTRANTS;
7780 persis_io.hdr.nexus = ctsio->io_hdr.nexus;
7781 persis_io.hdr.msg_type = CTL_MSG_PERS_ACTION;
7782 persis_io.pr.pr_info.action = CTL_PR_PREEMPT;
7783 persis_io.pr.pr_info.residx = lun->pr_res_idx;
7784 persis_io.pr.pr_info.res_type = type;
7785 memcpy(persis_io.pr.pr_info.sa_res_key,
7786 param->serv_act_res_key,
7787 sizeof(param->serv_act_res_key));
7788 if ((isc_retval=ctl_ha_msg_send(CTL_HA_CHAN_CTL,
7789 &persis_io, sizeof(persis_io), 0)) >
7790 CTL_HA_STATUS_SUCCESS) {
7791 printf("CTL:Persis Out error returned "
7792 "from ctl_ha_msg_send %d\n",
7797 * sa_res_key is not the res holder just
7798 * remove registrants
7801 mtx_lock(&softc->ctl_lock);
7803 for (i=0; i < 2*CTL_MAX_INITIATORS; i++) {
7804 if (memcmp(param->serv_act_res_key,
7805 lun->per_res[i].res_key.key,
7806 sizeof(struct scsi_per_res_key)) != 0)
7810 lun->per_res[i].registered = 0;
7811 memset(&lun->per_res[i].res_key, 0,
7812 sizeof(struct scsi_per_res_key));
7813 lun->pr_key_count--;
7816 && i < CTL_MAX_INITIATORS)
7817 lun->pending_sense[i].ua_pending |=
7819 else if (persis_offset
7820 && i >= persis_offset)
7822 i-persis_offset].ua_pending |=
7827 mtx_unlock(&softc->ctl_lock);
7828 free(ctsio->kern_data_ptr, M_CTL);
7829 ctl_set_reservation_conflict(ctsio);
7830 ctl_done((union ctl_io *)ctsio);
7833 mtx_unlock(&softc->ctl_lock);
7834 persis_io.hdr.nexus = ctsio->io_hdr.nexus;
7835 persis_io.hdr.msg_type = CTL_MSG_PERS_ACTION;
7836 persis_io.pr.pr_info.action = CTL_PR_PREEMPT;
7837 persis_io.pr.pr_info.residx = lun->pr_res_idx;
7838 persis_io.pr.pr_info.res_type = type;
7839 memcpy(persis_io.pr.pr_info.sa_res_key,
7840 param->serv_act_res_key,
7841 sizeof(param->serv_act_res_key));
7842 if ((isc_retval=ctl_ha_msg_send(CTL_HA_CHAN_CTL,
7843 &persis_io, sizeof(persis_io), 0)) >
7844 CTL_HA_STATUS_SUCCESS) {
7845 printf("CTL:Persis Out error returned "
7846 "from ctl_ha_msg_send %d\n",
7852 lun->PRGeneration++;
7858 ctl_pro_preempt_other(struct ctl_lun *lun, union ctl_ha_msg *msg)
7862 if (lun->pr_res_idx == CTL_PR_ALL_REGISTRANTS
7863 || lun->pr_res_idx == CTL_PR_NO_RESERVATION
7864 || memcmp(&lun->per_res[lun->pr_res_idx].res_key,
7865 msg->pr.pr_info.sa_res_key,
7866 sizeof(struct scsi_per_res_key)) != 0) {
7867 uint64_t sa_res_key;
7868 sa_res_key = scsi_8btou64(msg->pr.pr_info.sa_res_key);
7870 if (sa_res_key == 0) {
7871 /* temporarily unregister this nexus */
7872 lun->per_res[msg->pr.pr_info.residx].registered = 0;
7875 * Unregister everybody else and build UA for
7878 for(i=0; i < 2*CTL_MAX_INITIATORS; i++) {
7879 if (lun->per_res[i].registered == 0)
7883 && i < CTL_MAX_INITIATORS)
7884 lun->pending_sense[i].ua_pending |=
7886 else if (persis_offset && i >= persis_offset)
7887 lun->pending_sense[i -
7888 persis_offset].ua_pending |=
7890 lun->per_res[i].registered = 0;
7891 memset(&lun->per_res[i].res_key, 0,
7892 sizeof(struct scsi_per_res_key));
7895 lun->per_res[msg->pr.pr_info.residx].registered = 1;
7896 lun->pr_key_count = 1;
7897 lun->res_type = msg->pr.pr_info.res_type;
7898 if (lun->res_type != SPR_TYPE_WR_EX_AR
7899 && lun->res_type != SPR_TYPE_EX_AC_AR)
7900 lun->pr_res_idx = msg->pr.pr_info.residx;
7902 for (i=0; i < 2*CTL_MAX_INITIATORS; i++) {
7903 if (memcmp(msg->pr.pr_info.sa_res_key,
7904 lun->per_res[i].res_key.key,
7905 sizeof(struct scsi_per_res_key)) != 0)
7908 lun->per_res[i].registered = 0;
7909 memset(&lun->per_res[i].res_key, 0,
7910 sizeof(struct scsi_per_res_key));
7911 lun->pr_key_count--;
7914 && i < persis_offset)
7915 lun->pending_sense[i].ua_pending |=
7917 else if (persis_offset
7918 && i >= persis_offset)
7919 lun->pending_sense[i -
7920 persis_offset].ua_pending |=
7926 * Temporarily unregister so it won't get removed
7929 lun->per_res[msg->pr.pr_info.residx].registered = 0;
7930 for (i=0; i < 2*CTL_MAX_INITIATORS; i++) {
7931 if (lun->per_res[i].registered == 0)
7934 if (memcmp(msg->pr.pr_info.sa_res_key,
7935 lun->per_res[i].res_key.key,
7936 sizeof(struct scsi_per_res_key)) == 0) {
7937 lun->per_res[i].registered = 0;
7938 memset(&lun->per_res[i].res_key, 0,
7939 sizeof(struct scsi_per_res_key));
7940 lun->pr_key_count--;
7942 && i < CTL_MAX_INITIATORS)
7943 lun->pending_sense[i].ua_pending |=
7945 else if (persis_offset
7946 && i >= persis_offset)
7947 lun->pending_sense[i -
7948 persis_offset].ua_pending |=
7950 } else if (msg->pr.pr_info.res_type != lun->res_type
7951 && (lun->res_type == SPR_TYPE_WR_EX_RO
7952 || lun->res_type == SPR_TYPE_EX_AC_RO)) {
7954 && i < persis_offset)
7955 lun->pending_sense[i
7958 else if (persis_offset
7959 && i >= persis_offset)
7960 lun->pending_sense[i -
7961 persis_offset].ua_pending |=
7965 lun->per_res[msg->pr.pr_info.residx].registered = 1;
7966 lun->res_type = msg->pr.pr_info.res_type;
7967 if (lun->res_type != SPR_TYPE_WR_EX_AR
7968 && lun->res_type != SPR_TYPE_EX_AC_AR)
7969 lun->pr_res_idx = msg->pr.pr_info.residx;
7971 lun->pr_res_idx = CTL_PR_ALL_REGISTRANTS;
7973 lun->PRGeneration++;
7979 ctl_persistent_reserve_out(struct ctl_scsiio *ctsio)
7983 u_int32_t param_len;
7984 struct scsi_per_res_out *cdb;
7985 struct ctl_lun *lun;
7986 struct scsi_per_res_out_parms* param;
7987 struct ctl_softc *softc;
7989 uint64_t res_key, sa_res_key;
7991 union ctl_ha_msg persis_io;
7994 CTL_DEBUG_PRINT(("ctl_persistent_reserve_out\n"));
7996 retval = CTL_RETVAL_COMPLETE;
7998 softc = control_softc;
8000 cdb = (struct scsi_per_res_out *)ctsio->cdb;
8001 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
8004 * We only support whole-LUN scope. The scope & type are ignored for
8005 * register, register and ignore existing key and clear.
8006 * We sometimes ignore scope and type on preempts too!!
8007 * Verify reservation type here as well.
8009 type = cdb->scope_type & SPR_TYPE_MASK;
8010 if ((cdb->action == SPRO_RESERVE)
8011 || (cdb->action == SPRO_RELEASE)) {
8012 if ((cdb->scope_type & SPR_SCOPE_MASK) != SPR_LU_SCOPE) {
8013 ctl_set_invalid_field(/*ctsio*/ ctsio,
8019 ctl_done((union ctl_io *)ctsio);
8020 return (CTL_RETVAL_COMPLETE);
8023 if (type>8 || type==2 || type==4 || type==0) {
8024 ctl_set_invalid_field(/*ctsio*/ ctsio,
8030 ctl_done((union ctl_io *)ctsio);
8031 return (CTL_RETVAL_COMPLETE);
8035 switch (cdb->action & SPRO_ACTION_MASK) {
8046 ctl_set_invalid_field(/*ctsio*/ ctsio,
8052 ctl_done((union ctl_io *)ctsio);
8053 return (CTL_RETVAL_COMPLETE);
8054 break; /* NOTREACHED */
8057 param_len = scsi_4btoul(cdb->length);
8059 if ((ctsio->io_hdr.flags & CTL_FLAG_ALLOCATED) == 0) {
8060 ctsio->kern_data_ptr = malloc(param_len, M_CTL, M_WAITOK);
8061 ctsio->kern_data_len = param_len;
8062 ctsio->kern_total_len = param_len;
8063 ctsio->kern_data_resid = 0;
8064 ctsio->kern_rel_offset = 0;
8065 ctsio->kern_sg_entries = 0;
8066 ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
8067 ctsio->be_move_done = ctl_config_move_done;
8068 ctl_datamove((union ctl_io *)ctsio);
8070 return (CTL_RETVAL_COMPLETE);
8073 param = (struct scsi_per_res_out_parms *)ctsio->kern_data_ptr;
8075 residx = ctl_get_resindex(&ctsio->io_hdr.nexus);
8076 res_key = scsi_8btou64(param->res_key.key);
8077 sa_res_key = scsi_8btou64(param->serv_act_res_key);
8080 * Validate the reservation key here except for SPRO_REG_IGNO
8081 * This must be done for all other service actions
8083 if ((cdb->action & SPRO_ACTION_MASK) != SPRO_REG_IGNO) {
8084 mtx_lock(&softc->ctl_lock);
8085 if (lun->per_res[residx].registered) {
8086 if (memcmp(param->res_key.key,
8087 lun->per_res[residx].res_key.key,
8088 ctl_min(sizeof(param->res_key),
8089 sizeof(lun->per_res[residx].res_key))) != 0) {
8091 * The current key passed in doesn't match
8092 * the one the initiator previously
8095 mtx_unlock(&softc->ctl_lock);
8096 free(ctsio->kern_data_ptr, M_CTL);
8097 ctl_set_reservation_conflict(ctsio);
8098 ctl_done((union ctl_io *)ctsio);
8099 return (CTL_RETVAL_COMPLETE);
8101 } else if ((cdb->action & SPRO_ACTION_MASK) != SPRO_REGISTER) {
8103 * We are not registered
8105 mtx_unlock(&softc->ctl_lock);
8106 free(ctsio->kern_data_ptr, M_CTL);
8107 ctl_set_reservation_conflict(ctsio);
8108 ctl_done((union ctl_io *)ctsio);
8109 return (CTL_RETVAL_COMPLETE);
8110 } else if (res_key != 0) {
8112 * We are not registered and trying to register but
8113 * the register key isn't zero.
8115 mtx_unlock(&softc->ctl_lock);
8116 free(ctsio->kern_data_ptr, M_CTL);
8117 ctl_set_reservation_conflict(ctsio);
8118 ctl_done((union ctl_io *)ctsio);
8119 return (CTL_RETVAL_COMPLETE);
8121 mtx_unlock(&softc->ctl_lock);
8124 switch (cdb->action & SPRO_ACTION_MASK) {
8126 case SPRO_REG_IGNO: {
8129 printf("Registration received\n");
8133 * We don't support any of these options, as we report in
8134 * the read capabilities request (see
8135 * ctl_persistent_reserve_in(), above).
8137 if ((param->flags & SPR_SPEC_I_PT)
8138 || (param->flags & SPR_ALL_TG_PT)
8139 || (param->flags & SPR_APTPL)) {
8142 if (param->flags & SPR_APTPL)
8144 else if (param->flags & SPR_ALL_TG_PT)
8146 else /* SPR_SPEC_I_PT */
8149 free(ctsio->kern_data_ptr, M_CTL);
8150 ctl_set_invalid_field(ctsio,
8156 ctl_done((union ctl_io *)ctsio);
8157 return (CTL_RETVAL_COMPLETE);
8160 mtx_lock(&softc->ctl_lock);
8163 * The initiator wants to clear the
8166 if (sa_res_key == 0) {
8168 && (cdb->action & SPRO_ACTION_MASK) == SPRO_REGISTER)
8169 || ((cdb->action & SPRO_ACTION_MASK) == SPRO_REG_IGNO
8170 && !lun->per_res[residx].registered)) {
8171 mtx_unlock(&softc->ctl_lock);
8175 lun->per_res[residx].registered = 0;
8176 memset(&lun->per_res[residx].res_key,
8177 0, sizeof(lun->per_res[residx].res_key));
8178 lun->pr_key_count--;
8180 if (residx == lun->pr_res_idx) {
8181 lun->flags &= ~CTL_LUN_PR_RESERVED;
8182 lun->pr_res_idx = CTL_PR_NO_RESERVATION;
8184 if ((lun->res_type == SPR_TYPE_WR_EX_RO
8185 || lun->res_type == SPR_TYPE_EX_AC_RO)
8186 && lun->pr_key_count) {
8188 * If the reservation is a registrants
8189 * only type we need to generate a UA
8190 * for other registered inits. The
8191 * sense code should be RESERVATIONS
8195 for (i = 0; i < CTL_MAX_INITIATORS;i++){
8197 i+persis_offset].registered
8200 lun->pending_sense[i
8206 } else if (lun->pr_res_idx == CTL_PR_ALL_REGISTRANTS) {
8207 if (lun->pr_key_count==0) {
8208 lun->flags &= ~CTL_LUN_PR_RESERVED;
8210 lun->pr_res_idx = CTL_PR_NO_RESERVATION;
8213 persis_io.hdr.nexus = ctsio->io_hdr.nexus;
8214 persis_io.hdr.msg_type = CTL_MSG_PERS_ACTION;
8215 persis_io.pr.pr_info.action = CTL_PR_UNREG_KEY;
8216 persis_io.pr.pr_info.residx = residx;
8217 if ((isc_retval = ctl_ha_msg_send(CTL_HA_CHAN_CTL,
8218 &persis_io, sizeof(persis_io), 0 )) >
8219 CTL_HA_STATUS_SUCCESS) {
8220 printf("CTL:Persis Out error returned from "
8221 "ctl_ha_msg_send %d\n", isc_retval);
8223 mtx_unlock(&softc->ctl_lock);
8224 } else /* sa_res_key != 0 */ {
8227 * If we aren't registered currently then increment
8228 * the key count and set the registered flag.
8230 if (!lun->per_res[residx].registered) {
8231 lun->pr_key_count++;
8232 lun->per_res[residx].registered = 1;
8235 memcpy(&lun->per_res[residx].res_key,
8236 param->serv_act_res_key,
8237 ctl_min(sizeof(param->serv_act_res_key),
8238 sizeof(lun->per_res[residx].res_key)));
8240 persis_io.hdr.nexus = ctsio->io_hdr.nexus;
8241 persis_io.hdr.msg_type = CTL_MSG_PERS_ACTION;
8242 persis_io.pr.pr_info.action = CTL_PR_REG_KEY;
8243 persis_io.pr.pr_info.residx = residx;
8244 memcpy(persis_io.pr.pr_info.sa_res_key,
8245 param->serv_act_res_key,
8246 sizeof(param->serv_act_res_key));
8247 mtx_unlock(&softc->ctl_lock);
8248 if ((isc_retval=ctl_ha_msg_send(CTL_HA_CHAN_CTL,
8249 &persis_io, sizeof(persis_io), 0)) >
8250 CTL_HA_STATUS_SUCCESS) {
8251 printf("CTL:Persis Out error returned from "
8252 "ctl_ha_msg_send %d\n", isc_retval);
8255 lun->PRGeneration++;
8261 printf("Reserve executed type %d\n", type);
8263 mtx_lock(&softc->ctl_lock);
8264 if (lun->flags & CTL_LUN_PR_RESERVED) {
8266 * if this isn't the reservation holder and it's
8267 * not a "all registrants" type or if the type is
8268 * different then we have a conflict
8270 if ((lun->pr_res_idx != residx
8271 && lun->pr_res_idx != CTL_PR_ALL_REGISTRANTS)
8272 || lun->res_type != type) {
8273 mtx_unlock(&softc->ctl_lock);
8274 free(ctsio->kern_data_ptr, M_CTL);
8275 ctl_set_reservation_conflict(ctsio);
8276 ctl_done((union ctl_io *)ctsio);
8277 return (CTL_RETVAL_COMPLETE);
8279 mtx_unlock(&softc->ctl_lock);
8280 } else /* create a reservation */ {
8282 * If it's not an "all registrants" type record
8283 * reservation holder
8285 if (type != SPR_TYPE_WR_EX_AR
8286 && type != SPR_TYPE_EX_AC_AR)
8287 lun->pr_res_idx = residx; /* Res holder */
8289 lun->pr_res_idx = CTL_PR_ALL_REGISTRANTS;
8291 lun->flags |= CTL_LUN_PR_RESERVED;
8292 lun->res_type = type;
8294 mtx_unlock(&softc->ctl_lock);
8296 /* send msg to other side */
8297 persis_io.hdr.nexus = ctsio->io_hdr.nexus;
8298 persis_io.hdr.msg_type = CTL_MSG_PERS_ACTION;
8299 persis_io.pr.pr_info.action = CTL_PR_RESERVE;
8300 persis_io.pr.pr_info.residx = lun->pr_res_idx;
8301 persis_io.pr.pr_info.res_type = type;
8302 if ((isc_retval=ctl_ha_msg_send(CTL_HA_CHAN_CTL,
8303 &persis_io, sizeof(persis_io), 0)) >
8304 CTL_HA_STATUS_SUCCESS) {
8305 printf("CTL:Persis Out error returned from "
8306 "ctl_ha_msg_send %d\n", isc_retval);
8312 mtx_lock(&softc->ctl_lock);
8313 if ((lun->flags & CTL_LUN_PR_RESERVED) == 0) {
8314 /* No reservation exists return good status */
8315 mtx_unlock(&softc->ctl_lock);
8319 * Is this nexus a reservation holder?
8321 if (lun->pr_res_idx != residx
8322 && lun->pr_res_idx != CTL_PR_ALL_REGISTRANTS) {
8324 * not a res holder return good status but
8327 mtx_unlock(&softc->ctl_lock);
8331 if (lun->res_type != type) {
8332 mtx_unlock(&softc->ctl_lock);
8333 free(ctsio->kern_data_ptr, M_CTL);
8334 ctl_set_illegal_pr_release(ctsio);
8335 ctl_done((union ctl_io *)ctsio);
8336 return (CTL_RETVAL_COMPLETE);
8339 /* okay to release */
8340 lun->flags &= ~CTL_LUN_PR_RESERVED;
8341 lun->pr_res_idx = CTL_PR_NO_RESERVATION;
8345 * if this isn't an exclusive access
8346 * res generate UA for all other
8349 if (type != SPR_TYPE_EX_AC
8350 && type != SPR_TYPE_WR_EX) {
8352 * temporarily unregister so we don't generate UA
8354 lun->per_res[residx].registered = 0;
8356 for (i = 0; i < CTL_MAX_INITIATORS; i++) {
8357 if (lun->per_res[i+persis_offset].registered
8360 lun->pending_sense[i].ua_pending |=
8364 lun->per_res[residx].registered = 1;
8366 mtx_unlock(&softc->ctl_lock);
8367 /* Send msg to other side */
8368 persis_io.hdr.nexus = ctsio->io_hdr.nexus;
8369 persis_io.hdr.msg_type = CTL_MSG_PERS_ACTION;
8370 persis_io.pr.pr_info.action = CTL_PR_RELEASE;
8371 if ((isc_retval=ctl_ha_msg_send( CTL_HA_CHAN_CTL, &persis_io,
8372 sizeof(persis_io), 0)) > CTL_HA_STATUS_SUCCESS) {
8373 printf("CTL:Persis Out error returned from "
8374 "ctl_ha_msg_send %d\n", isc_retval);
8379 /* send msg to other side */
8381 mtx_lock(&softc->ctl_lock);
8382 lun->flags &= ~CTL_LUN_PR_RESERVED;
8384 lun->pr_key_count = 0;
8385 lun->pr_res_idx = CTL_PR_NO_RESERVATION;
8388 memset(&lun->per_res[residx].res_key,
8389 0, sizeof(lun->per_res[residx].res_key));
8390 lun->per_res[residx].registered = 0;
8392 for (i=0; i < 2*CTL_MAX_INITIATORS; i++)
8393 if (lun->per_res[i].registered) {
8394 if (!persis_offset && i < CTL_MAX_INITIATORS)
8395 lun->pending_sense[i].ua_pending |=
8397 else if (persis_offset && i >= persis_offset)
8398 lun->pending_sense[i-persis_offset
8399 ].ua_pending |= CTL_UA_RES_PREEMPT;
8401 memset(&lun->per_res[i].res_key,
8402 0, sizeof(struct scsi_per_res_key));
8403 lun->per_res[i].registered = 0;
8405 lun->PRGeneration++;
8406 mtx_unlock(&softc->ctl_lock);
8407 persis_io.hdr.nexus = ctsio->io_hdr.nexus;
8408 persis_io.hdr.msg_type = CTL_MSG_PERS_ACTION;
8409 persis_io.pr.pr_info.action = CTL_PR_CLEAR;
8410 if ((isc_retval=ctl_ha_msg_send(CTL_HA_CHAN_CTL, &persis_io,
8411 sizeof(persis_io), 0)) > CTL_HA_STATUS_SUCCESS) {
8412 printf("CTL:Persis Out error returned from "
8413 "ctl_ha_msg_send %d\n", isc_retval);
8417 case SPRO_PREEMPT: {
8420 nretval = ctl_pro_preempt(softc, lun, res_key, sa_res_key, type,
8421 residx, ctsio, cdb, param);
8423 return (CTL_RETVAL_COMPLETE);
8429 free(ctsio->kern_data_ptr, M_CTL);
8430 ctl_set_invalid_field(/*ctsio*/ ctsio,
8436 ctl_done((union ctl_io *)ctsio);
8437 return (CTL_RETVAL_COMPLETE);
8438 break; /* NOTREACHED */
8442 free(ctsio->kern_data_ptr, M_CTL);
8443 ctl_set_success(ctsio);
8444 ctl_done((union ctl_io *)ctsio);
8450 * This routine is for handling a message from the other SC pertaining to
8451 * persistent reserve out. All the error checking will have been done
8452 * so only perorming the action need be done here to keep the two
8456 ctl_hndl_per_res_out_on_other_sc(union ctl_ha_msg *msg)
8458 struct ctl_lun *lun;
8459 struct ctl_softc *softc;
8463 softc = control_softc;
8465 mtx_lock(&softc->ctl_lock);
8467 targ_lun = msg->hdr.nexus.targ_lun;
8468 if (msg->hdr.nexus.lun_map_fn != NULL)
8469 targ_lun = msg->hdr.nexus.lun_map_fn(msg->hdr.nexus.lun_map_arg, targ_lun);
8470 lun = softc->ctl_luns[targ_lun];
8471 switch(msg->pr.pr_info.action) {
8472 case CTL_PR_REG_KEY:
8473 if (!lun->per_res[msg->pr.pr_info.residx].registered) {
8474 lun->per_res[msg->pr.pr_info.residx].registered = 1;
8475 lun->pr_key_count++;
8477 lun->PRGeneration++;
8478 memcpy(&lun->per_res[msg->pr.pr_info.residx].res_key,
8479 msg->pr.pr_info.sa_res_key,
8480 sizeof(struct scsi_per_res_key));
8483 case CTL_PR_UNREG_KEY:
8484 lun->per_res[msg->pr.pr_info.residx].registered = 0;
8485 memset(&lun->per_res[msg->pr.pr_info.residx].res_key,
8486 0, sizeof(struct scsi_per_res_key));
8487 lun->pr_key_count--;
8489 /* XXX Need to see if the reservation has been released */
8490 /* if so do we need to generate UA? */
8491 if (msg->pr.pr_info.residx == lun->pr_res_idx) {
8492 lun->flags &= ~CTL_LUN_PR_RESERVED;
8493 lun->pr_res_idx = CTL_PR_NO_RESERVATION;
8495 if ((lun->res_type == SPR_TYPE_WR_EX_RO
8496 || lun->res_type == SPR_TYPE_EX_AC_RO)
8497 && lun->pr_key_count) {
8499 * If the reservation is a registrants
8500 * only type we need to generate a UA
8501 * for other registered inits. The
8502 * sense code should be RESERVATIONS
8506 for (i = 0; i < CTL_MAX_INITIATORS; i++) {
8508 persis_offset].registered == 0)
8511 lun->pending_sense[i
8517 } else if (lun->pr_res_idx == CTL_PR_ALL_REGISTRANTS) {
8518 if (lun->pr_key_count==0) {
8519 lun->flags &= ~CTL_LUN_PR_RESERVED;
8521 lun->pr_res_idx = CTL_PR_NO_RESERVATION;
8524 lun->PRGeneration++;
8527 case CTL_PR_RESERVE:
8528 lun->flags |= CTL_LUN_PR_RESERVED;
8529 lun->res_type = msg->pr.pr_info.res_type;
8530 lun->pr_res_idx = msg->pr.pr_info.residx;
8534 case CTL_PR_RELEASE:
8536 * if this isn't an exclusive access res generate UA for all
8537 * other registrants.
8539 if (lun->res_type != SPR_TYPE_EX_AC
8540 && lun->res_type != SPR_TYPE_WR_EX) {
8541 for (i = 0; i < CTL_MAX_INITIATORS; i++)
8542 if (lun->per_res[i+persis_offset].registered)
8543 lun->pending_sense[i].ua_pending |=
8547 lun->flags &= ~CTL_LUN_PR_RESERVED;
8548 lun->pr_res_idx = CTL_PR_NO_RESERVATION;
8552 case CTL_PR_PREEMPT:
8553 ctl_pro_preempt_other(lun, msg);
8556 lun->flags &= ~CTL_LUN_PR_RESERVED;
8558 lun->pr_key_count = 0;
8559 lun->pr_res_idx = CTL_PR_NO_RESERVATION;
8561 for (i=0; i < 2*CTL_MAX_INITIATORS; i++) {
8562 if (lun->per_res[i].registered == 0)
8565 && i < CTL_MAX_INITIATORS)
8566 lun->pending_sense[i].ua_pending |=
8568 else if (persis_offset
8569 && i >= persis_offset)
8570 lun->pending_sense[i-persis_offset].ua_pending|=
8572 memset(&lun->per_res[i].res_key, 0,
8573 sizeof(struct scsi_per_res_key));
8574 lun->per_res[i].registered = 0;
8576 lun->PRGeneration++;
8580 mtx_unlock(&softc->ctl_lock);
8584 ctl_read_write(struct ctl_scsiio *ctsio)
8586 struct ctl_lun *lun;
8587 struct ctl_lba_len lbalen;
8589 uint32_t num_blocks;
8590 int reladdr, fua, dpo, ebp;
8594 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
8596 CTL_DEBUG_PRINT(("ctl_read_write: command: %#x\n", ctsio->cdb[0]));
8603 retval = CTL_RETVAL_COMPLETE;
8605 isread = ctsio->cdb[0] == READ_6 || ctsio->cdb[0] == READ_10
8606 || ctsio->cdb[0] == READ_12 || ctsio->cdb[0] == READ_16;
8607 if (lun->flags & CTL_LUN_PR_RESERVED && isread) {
8611 * XXX KDM need a lock here.
8613 residx = ctl_get_resindex(&ctsio->io_hdr.nexus);
8614 if ((lun->res_type == SPR_TYPE_EX_AC
8615 && residx != lun->pr_res_idx)
8616 || ((lun->res_type == SPR_TYPE_EX_AC_RO
8617 || lun->res_type == SPR_TYPE_EX_AC_AR)
8618 && !lun->per_res[residx].registered)) {
8619 ctl_set_reservation_conflict(ctsio);
8620 ctl_done((union ctl_io *)ctsio);
8621 return (CTL_RETVAL_COMPLETE);
8625 switch (ctsio->cdb[0]) {
8628 struct scsi_rw_6 *cdb;
8630 cdb = (struct scsi_rw_6 *)ctsio->cdb;
8632 lba = scsi_3btoul(cdb->addr);
8633 /* only 5 bits are valid in the most significant address byte */
8635 num_blocks = cdb->length;
8637 * This is correct according to SBC-2.
8639 if (num_blocks == 0)
8645 struct scsi_rw_10 *cdb;
8647 cdb = (struct scsi_rw_10 *)ctsio->cdb;
8649 if (cdb->byte2 & SRW10_RELADDR)
8651 if (cdb->byte2 & SRW10_FUA)
8653 if (cdb->byte2 & SRW10_DPO)
8656 if ((cdb->opcode == WRITE_10)
8657 && (cdb->byte2 & SRW10_EBP))
8660 lba = scsi_4btoul(cdb->addr);
8661 num_blocks = scsi_2btoul(cdb->length);
8664 case WRITE_VERIFY_10: {
8665 struct scsi_write_verify_10 *cdb;
8667 cdb = (struct scsi_write_verify_10 *)ctsio->cdb;
8670 * XXX KDM we should do actual write verify support at some
8671 * point. This is obviously fake, we're just translating
8672 * things to a write. So we don't even bother checking the
8673 * BYTCHK field, since we don't do any verification. If
8674 * the user asks for it, we'll just pretend we did it.
8676 if (cdb->byte2 & SWV_DPO)
8679 lba = scsi_4btoul(cdb->addr);
8680 num_blocks = scsi_2btoul(cdb->length);
8685 struct scsi_rw_12 *cdb;
8687 cdb = (struct scsi_rw_12 *)ctsio->cdb;
8689 if (cdb->byte2 & SRW12_RELADDR)
8691 if (cdb->byte2 & SRW12_FUA)
8693 if (cdb->byte2 & SRW12_DPO)
8695 lba = scsi_4btoul(cdb->addr);
8696 num_blocks = scsi_4btoul(cdb->length);
8699 case WRITE_VERIFY_12: {
8700 struct scsi_write_verify_12 *cdb;
8702 cdb = (struct scsi_write_verify_12 *)ctsio->cdb;
8704 if (cdb->byte2 & SWV_DPO)
8707 lba = scsi_4btoul(cdb->addr);
8708 num_blocks = scsi_4btoul(cdb->length);
8714 struct scsi_rw_16 *cdb;
8716 cdb = (struct scsi_rw_16 *)ctsio->cdb;
8718 if (cdb->byte2 & SRW12_RELADDR)
8720 if (cdb->byte2 & SRW12_FUA)
8722 if (cdb->byte2 & SRW12_DPO)
8725 lba = scsi_8btou64(cdb->addr);
8726 num_blocks = scsi_4btoul(cdb->length);
8729 case WRITE_VERIFY_16: {
8730 struct scsi_write_verify_16 *cdb;
8732 cdb = (struct scsi_write_verify_16 *)ctsio->cdb;
8734 if (cdb->byte2 & SWV_DPO)
8737 lba = scsi_8btou64(cdb->addr);
8738 num_blocks = scsi_4btoul(cdb->length);
8743 * We got a command we don't support. This shouldn't
8744 * happen, commands should be filtered out above us.
8746 ctl_set_invalid_opcode(ctsio);
8747 ctl_done((union ctl_io *)ctsio);
8749 return (CTL_RETVAL_COMPLETE);
8750 break; /* NOTREACHED */
8754 * XXX KDM what do we do with the DPO and FUA bits? FUA might be
8755 * interesting for us, but if RAIDCore is in write-back mode,
8756 * getting it to do write-through for a particular transaction may
8760 * We don't support relative addressing. That also requires
8761 * supporting linked commands, which we don't do.
8764 ctl_set_invalid_field(ctsio,
8770 ctl_done((union ctl_io *)ctsio);
8771 return (CTL_RETVAL_COMPLETE);
8775 * The first check is to make sure we're in bounds, the second
8776 * check is to catch wrap-around problems. If the lba + num blocks
8777 * is less than the lba, then we've wrapped around and the block
8778 * range is invalid anyway.
8780 if (((lba + num_blocks) > (lun->be_lun->maxlba + 1))
8781 || ((lba + num_blocks) < lba)) {
8782 ctl_set_lba_out_of_range(ctsio);
8783 ctl_done((union ctl_io *)ctsio);
8784 return (CTL_RETVAL_COMPLETE);
8788 * According to SBC-3, a transfer length of 0 is not an error.
8789 * Note that this cannot happen with WRITE(6) or READ(6), since 0
8790 * translates to 256 blocks for those commands.
8792 if (num_blocks == 0) {
8793 ctl_set_success(ctsio);
8794 ctl_done((union ctl_io *)ctsio);
8795 return (CTL_RETVAL_COMPLETE);
8799 lbalen.len = num_blocks;
8800 memcpy(ctsio->io_hdr.ctl_private[CTL_PRIV_LBA_LEN].bytes, &lbalen,
8803 CTL_DEBUG_PRINT(("ctl_read_write: calling data_submit()\n"));
8805 retval = lun->backend->data_submit((union ctl_io *)ctsio);
8811 ctl_report_luns(struct ctl_scsiio *ctsio)
8813 struct scsi_report_luns *cdb;
8814 struct scsi_report_luns_data *lun_data;
8815 struct ctl_lun *lun, *request_lun;
8816 int num_luns, retval;
8817 uint32_t alloc_len, lun_datalen;
8818 int num_filled, well_known;
8819 uint32_t initidx, targ_lun_id, lun_id;
8821 retval = CTL_RETVAL_COMPLETE;
8824 cdb = (struct scsi_report_luns *)ctsio->cdb;
8826 CTL_DEBUG_PRINT(("ctl_report_luns\n"));
8828 mtx_lock(&control_softc->ctl_lock);
8829 num_luns = control_softc->num_luns;
8830 mtx_unlock(&control_softc->ctl_lock);
8832 switch (cdb->select_report) {
8833 case RPL_REPORT_DEFAULT:
8834 case RPL_REPORT_ALL:
8836 case RPL_REPORT_WELLKNOWN:
8841 ctl_set_invalid_field(ctsio,
8847 ctl_done((union ctl_io *)ctsio);
8849 break; /* NOTREACHED */
8852 alloc_len = scsi_4btoul(cdb->length);
8854 * The initiator has to allocate at least 16 bytes for this request,
8855 * so he can at least get the header and the first LUN. Otherwise
8856 * we reject the request (per SPC-3 rev 14, section 6.21).
8858 if (alloc_len < (sizeof(struct scsi_report_luns_data) +
8859 sizeof(struct scsi_report_luns_lundata))) {
8860 ctl_set_invalid_field(ctsio,
8866 ctl_done((union ctl_io *)ctsio);
8870 request_lun = (struct ctl_lun *)
8871 ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
8873 lun_datalen = sizeof(*lun_data) +
8874 (num_luns * sizeof(struct scsi_report_luns_lundata));
8876 ctsio->kern_data_ptr = malloc(lun_datalen, M_CTL, M_WAITOK | M_ZERO);
8877 lun_data = (struct scsi_report_luns_data *)ctsio->kern_data_ptr;
8878 ctsio->kern_sg_entries = 0;
8880 initidx = ctl_get_initindex(&ctsio->io_hdr.nexus);
8882 mtx_lock(&control_softc->ctl_lock);
8883 for (targ_lun_id = 0, num_filled = 0; targ_lun_id < CTL_MAX_LUNS && num_filled < num_luns; targ_lun_id++) {
8884 lun_id = targ_lun_id;
8885 if (ctsio->io_hdr.nexus.lun_map_fn != NULL)
8886 lun_id = ctsio->io_hdr.nexus.lun_map_fn(ctsio->io_hdr.nexus.lun_map_arg, lun_id);
8887 if (lun_id >= CTL_MAX_LUNS)
8889 lun = control_softc->ctl_luns[lun_id];
8893 if (targ_lun_id <= 0xff) {
8895 * Peripheral addressing method, bus number 0.
8897 lun_data->luns[num_filled].lundata[0] =
8898 RPL_LUNDATA_ATYP_PERIPH;
8899 lun_data->luns[num_filled].lundata[1] = targ_lun_id;
8901 } else if (targ_lun_id <= 0x3fff) {
8903 * Flat addressing method.
8905 lun_data->luns[num_filled].lundata[0] =
8906 RPL_LUNDATA_ATYP_FLAT |
8907 (targ_lun_id & RPL_LUNDATA_FLAT_LUN_MASK);
8908 #ifdef OLDCTLHEADERS
8909 (SRLD_ADDR_FLAT << SRLD_ADDR_SHIFT) |
8910 (targ_lun_id & SRLD_BUS_LUN_MASK);
8912 lun_data->luns[num_filled].lundata[1] =
8913 #ifdef OLDCTLHEADERS
8914 targ_lun_id >> SRLD_BUS_LUN_BITS;
8916 targ_lun_id >> RPL_LUNDATA_FLAT_LUN_BITS;
8919 printf("ctl_report_luns: bogus LUN number %jd, "
8920 "skipping\n", (intmax_t)targ_lun_id);
8923 * According to SPC-3, rev 14 section 6.21:
8925 * "The execution of a REPORT LUNS command to any valid and
8926 * installed logical unit shall clear the REPORTED LUNS DATA
8927 * HAS CHANGED unit attention condition for all logical
8928 * units of that target with respect to the requesting
8929 * initiator. A valid and installed logical unit is one
8930 * having a PERIPHERAL QUALIFIER of 000b in the standard
8931 * INQUIRY data (see 6.4.2)."
8933 * If request_lun is NULL, the LUN this report luns command
8934 * was issued to is either disabled or doesn't exist. In that
8935 * case, we shouldn't clear any pending lun change unit
8938 if (request_lun != NULL)
8939 lun->pending_sense[initidx].ua_pending &=
8942 mtx_unlock(&control_softc->ctl_lock);
8945 * It's quite possible that we've returned fewer LUNs than we allocated
8946 * space for. Trim it.
8948 lun_datalen = sizeof(*lun_data) +
8949 (num_filled * sizeof(struct scsi_report_luns_lundata));
8951 if (lun_datalen < alloc_len) {
8952 ctsio->residual = alloc_len - lun_datalen;
8953 ctsio->kern_data_len = lun_datalen;
8954 ctsio->kern_total_len = lun_datalen;
8956 ctsio->residual = 0;
8957 ctsio->kern_data_len = alloc_len;
8958 ctsio->kern_total_len = alloc_len;
8960 ctsio->kern_data_resid = 0;
8961 ctsio->kern_rel_offset = 0;
8962 ctsio->kern_sg_entries = 0;
8965 * We set this to the actual data length, regardless of how much
8966 * space we actually have to return results. If the user looks at
8967 * this value, he'll know whether or not he allocated enough space
8968 * and reissue the command if necessary. We don't support well
8969 * known logical units, so if the user asks for that, return none.
8971 scsi_ulto4b(lun_datalen - 8, lun_data->length);
8974 * We can only return SCSI_STATUS_CHECK_COND when we can't satisfy
8977 ctsio->scsi_status = SCSI_STATUS_OK;
8979 ctsio->be_move_done = ctl_config_move_done;
8980 ctl_datamove((union ctl_io *)ctsio);
8986 ctl_request_sense(struct ctl_scsiio *ctsio)
8988 struct scsi_request_sense *cdb;
8989 struct scsi_sense_data *sense_ptr;
8990 struct ctl_lun *lun;
8993 scsi_sense_data_type sense_format;
8995 cdb = (struct scsi_request_sense *)ctsio->cdb;
8997 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
8999 CTL_DEBUG_PRINT(("ctl_request_sense\n"));
9002 * Determine which sense format the user wants.
9004 if (cdb->byte2 & SRS_DESC)
9005 sense_format = SSD_TYPE_DESC;
9007 sense_format = SSD_TYPE_FIXED;
9009 ctsio->kern_data_ptr = malloc(sizeof(*sense_ptr), M_CTL, M_WAITOK);
9010 sense_ptr = (struct scsi_sense_data *)ctsio->kern_data_ptr;
9011 ctsio->kern_sg_entries = 0;
9014 * struct scsi_sense_data, which is currently set to 256 bytes, is
9015 * larger than the largest allowed value for the length field in the
9016 * REQUEST SENSE CDB, which is 252 bytes as of SPC-4.
9018 ctsio->residual = 0;
9019 ctsio->kern_data_len = cdb->length;
9020 ctsio->kern_total_len = cdb->length;
9022 ctsio->kern_data_resid = 0;
9023 ctsio->kern_rel_offset = 0;
9024 ctsio->kern_sg_entries = 0;
9027 * If we don't have a LUN, we don't have any pending sense.
9033 initidx = ctl_get_initindex(&ctsio->io_hdr.nexus);
9035 * Check for pending sense, and then for pending unit attentions.
9036 * Pending sense gets returned first, then pending unit attentions.
9038 mtx_lock(&lun->ctl_softc->ctl_lock);
9039 if (ctl_is_set(lun->have_ca, initidx)) {
9040 scsi_sense_data_type stored_format;
9043 * Check to see which sense format was used for the stored
9046 stored_format = scsi_sense_type(
9047 &lun->pending_sense[initidx].sense);
9050 * If the user requested a different sense format than the
9051 * one we stored, then we need to convert it to the other
9052 * format. If we're going from descriptor to fixed format
9053 * sense data, we may lose things in translation, depending
9054 * on what options were used.
9056 * If the stored format is SSD_TYPE_NONE (i.e. invalid),
9057 * for some reason we'll just copy it out as-is.
9059 if ((stored_format == SSD_TYPE_FIXED)
9060 && (sense_format == SSD_TYPE_DESC))
9061 ctl_sense_to_desc((struct scsi_sense_data_fixed *)
9062 &lun->pending_sense[initidx].sense,
9063 (struct scsi_sense_data_desc *)sense_ptr);
9064 else if ((stored_format == SSD_TYPE_DESC)
9065 && (sense_format == SSD_TYPE_FIXED))
9066 ctl_sense_to_fixed((struct scsi_sense_data_desc *)
9067 &lun->pending_sense[initidx].sense,
9068 (struct scsi_sense_data_fixed *)sense_ptr);
9070 memcpy(sense_ptr, &lun->pending_sense[initidx].sense,
9071 ctl_min(sizeof(*sense_ptr),
9072 sizeof(lun->pending_sense[initidx].sense)));
9074 ctl_clear_mask(lun->have_ca, initidx);
9076 } else if (lun->pending_sense[initidx].ua_pending != CTL_UA_NONE) {
9077 ctl_ua_type ua_type;
9079 ua_type = ctl_build_ua(lun->pending_sense[initidx].ua_pending,
9080 sense_ptr, sense_format);
9081 if (ua_type != CTL_UA_NONE) {
9083 /* We're reporting this UA, so clear it */
9084 lun->pending_sense[initidx].ua_pending &= ~ua_type;
9087 mtx_unlock(&lun->ctl_softc->ctl_lock);
9090 * We already have a pending error, return it.
9092 if (have_error != 0) {
9094 * We report the SCSI status as OK, since the status of the
9095 * request sense command itself is OK.
9097 ctsio->scsi_status = SCSI_STATUS_OK;
9100 * We report 0 for the sense length, because we aren't doing
9101 * autosense in this case. We're reporting sense as
9104 ctsio->sense_len = 0;
9106 ctsio->be_move_done = ctl_config_move_done;
9107 ctl_datamove((union ctl_io *)ctsio);
9109 return (CTL_RETVAL_COMPLETE);
9115 * No sense information to report, so we report that everything is
9118 ctl_set_sense_data(sense_ptr,
9121 /*current_error*/ 1,
9122 /*sense_key*/ SSD_KEY_NO_SENSE,
9127 ctsio->scsi_status = SCSI_STATUS_OK;
9130 * We report 0 for the sense length, because we aren't doing
9131 * autosense in this case. We're reporting sense as parameter data.
9133 ctsio->sense_len = 0;
9134 ctsio->be_move_done = ctl_config_move_done;
9135 ctl_datamove((union ctl_io *)ctsio);
9137 return (CTL_RETVAL_COMPLETE);
9141 ctl_tur(struct ctl_scsiio *ctsio)
9143 struct ctl_lun *lun;
9145 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
9147 CTL_DEBUG_PRINT(("ctl_tur\n"));
9152 ctsio->scsi_status = SCSI_STATUS_OK;
9153 ctsio->io_hdr.status = CTL_SUCCESS;
9155 ctl_done((union ctl_io *)ctsio);
9157 return (CTL_RETVAL_COMPLETE);
9162 ctl_cmddt_inquiry(struct ctl_scsiio *ctsio)
9169 ctl_inquiry_evpd_supported(struct ctl_scsiio *ctsio, int alloc_len)
9171 struct scsi_vpd_supported_pages *pages;
9173 struct ctl_lun *lun;
9175 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
9177 sup_page_size = sizeof(struct scsi_vpd_supported_pages) *
9178 SCSI_EVPD_NUM_SUPPORTED_PAGES;
9179 ctsio->kern_data_ptr = malloc(sup_page_size, M_CTL, M_WAITOK | M_ZERO);
9180 pages = (struct scsi_vpd_supported_pages *)ctsio->kern_data_ptr;
9181 ctsio->kern_sg_entries = 0;
9183 if (sup_page_size < alloc_len) {
9184 ctsio->residual = alloc_len - sup_page_size;
9185 ctsio->kern_data_len = sup_page_size;
9186 ctsio->kern_total_len = sup_page_size;
9188 ctsio->residual = 0;
9189 ctsio->kern_data_len = alloc_len;
9190 ctsio->kern_total_len = alloc_len;
9192 ctsio->kern_data_resid = 0;
9193 ctsio->kern_rel_offset = 0;
9194 ctsio->kern_sg_entries = 0;
9197 * The control device is always connected. The disk device, on the
9198 * other hand, may not be online all the time. Need to change this
9199 * to figure out whether the disk device is actually online or not.
9202 pages->device = (SID_QUAL_LU_CONNECTED << 5) |
9203 lun->be_lun->lun_type;
9205 pages->device = (SID_QUAL_LU_OFFLINE << 5) | T_DIRECT;
9207 pages->length = SCSI_EVPD_NUM_SUPPORTED_PAGES;
9208 /* Supported VPD pages */
9209 pages->page_list[0] = SVPD_SUPPORTED_PAGES;
9211 pages->page_list[1] = SVPD_UNIT_SERIAL_NUMBER;
9212 /* Device Identification */
9213 pages->page_list[2] = SVPD_DEVICE_ID;
9215 pages->page_list[3] = SVPD_BLOCK_LIMITS;
9216 /* Logical Block Provisioning */
9217 pages->page_list[4] = SVPD_LBP;
9219 ctsio->scsi_status = SCSI_STATUS_OK;
9221 ctsio->be_move_done = ctl_config_move_done;
9222 ctl_datamove((union ctl_io *)ctsio);
9224 return (CTL_RETVAL_COMPLETE);
9228 ctl_inquiry_evpd_serial(struct ctl_scsiio *ctsio, int alloc_len)
9230 struct scsi_vpd_unit_serial_number *sn_ptr;
9231 struct ctl_lun *lun;
9232 #ifndef CTL_USE_BACKEND_SN
9236 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
9238 ctsio->kern_data_ptr = malloc(sizeof(*sn_ptr), M_CTL, M_WAITOK | M_ZERO);
9239 sn_ptr = (struct scsi_vpd_unit_serial_number *)ctsio->kern_data_ptr;
9240 ctsio->kern_sg_entries = 0;
9242 if (sizeof(*sn_ptr) < alloc_len) {
9243 ctsio->residual = alloc_len - sizeof(*sn_ptr);
9244 ctsio->kern_data_len = sizeof(*sn_ptr);
9245 ctsio->kern_total_len = sizeof(*sn_ptr);
9247 ctsio->residual = 0;
9248 ctsio->kern_data_len = alloc_len;
9249 ctsio->kern_total_len = alloc_len;
9251 ctsio->kern_data_resid = 0;
9252 ctsio->kern_rel_offset = 0;
9253 ctsio->kern_sg_entries = 0;
9256 * The control device is always connected. The disk device, on the
9257 * other hand, may not be online all the time. Need to change this
9258 * to figure out whether the disk device is actually online or not.
9261 sn_ptr->device = (SID_QUAL_LU_CONNECTED << 5) |
9262 lun->be_lun->lun_type;
9264 sn_ptr->device = (SID_QUAL_LU_OFFLINE << 5) | T_DIRECT;
9266 sn_ptr->page_code = SVPD_UNIT_SERIAL_NUMBER;
9267 sn_ptr->length = ctl_min(sizeof(*sn_ptr) - 4, CTL_SN_LEN);
9268 #ifdef CTL_USE_BACKEND_SN
9270 * If we don't have a LUN, we just leave the serial number as
9273 memset(sn_ptr->serial_num, 0x20, sizeof(sn_ptr->serial_num));
9275 strncpy((char *)sn_ptr->serial_num,
9276 (char *)lun->be_lun->serial_num, CTL_SN_LEN);
9280 * Note that we're using a non-unique serial number here,
9282 snprintf(tmpstr, sizeof(tmpstr), "MYSERIALNUMIS000");
9283 memset(sn_ptr->serial_num, 0x20, sizeof(sn_ptr->serial_num));
9284 strncpy(sn_ptr->serial_num, tmpstr, ctl_min(CTL_SN_LEN,
9285 ctl_min(sizeof(tmpstr), sizeof(*sn_ptr) - 4)));
9287 ctsio->scsi_status = SCSI_STATUS_OK;
9289 ctsio->be_move_done = ctl_config_move_done;
9290 ctl_datamove((union ctl_io *)ctsio);
9292 return (CTL_RETVAL_COMPLETE);
9297 ctl_inquiry_evpd_devid(struct ctl_scsiio *ctsio, int alloc_len)
9299 struct scsi_vpd_device_id *devid_ptr;
9300 struct scsi_vpd_id_descriptor *desc, *desc1;
9301 struct scsi_vpd_id_descriptor *desc2, *desc3; /* for types 4h and 5h */
9302 struct scsi_vpd_id_t10 *t10id;
9303 struct ctl_softc *ctl_softc;
9304 struct ctl_lun *lun;
9305 struct ctl_frontend *fe;
9307 #ifndef CTL_USE_BACKEND_SN
9309 #endif /* CTL_USE_BACKEND_SN */
9312 ctl_softc = control_softc;
9314 mtx_lock(&ctl_softc->ctl_lock);
9315 fe = ctl_softc->ctl_ports[ctl_port_idx(ctsio->io_hdr.nexus.targ_port)];
9316 mtx_unlock(&ctl_softc->ctl_lock);
9318 if (fe->devid != NULL)
9319 return ((fe->devid)(ctsio, alloc_len));
9321 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
9323 devid_len = sizeof(struct scsi_vpd_device_id) +
9324 sizeof(struct scsi_vpd_id_descriptor) +
9325 sizeof(struct scsi_vpd_id_t10) + CTL_DEVID_LEN +
9326 sizeof(struct scsi_vpd_id_descriptor) + CTL_WWPN_LEN +
9327 sizeof(struct scsi_vpd_id_descriptor) +
9328 sizeof(struct scsi_vpd_id_rel_trgt_port_id) +
9329 sizeof(struct scsi_vpd_id_descriptor) +
9330 sizeof(struct scsi_vpd_id_trgt_port_grp_id);
9332 ctsio->kern_data_ptr = malloc(devid_len, M_CTL, M_WAITOK | M_ZERO);
9333 devid_ptr = (struct scsi_vpd_device_id *)ctsio->kern_data_ptr;
9334 ctsio->kern_sg_entries = 0;
9336 if (devid_len < alloc_len) {
9337 ctsio->residual = alloc_len - devid_len;
9338 ctsio->kern_data_len = devid_len;
9339 ctsio->kern_total_len = devid_len;
9341 ctsio->residual = 0;
9342 ctsio->kern_data_len = alloc_len;
9343 ctsio->kern_total_len = alloc_len;
9345 ctsio->kern_data_resid = 0;
9346 ctsio->kern_rel_offset = 0;
9347 ctsio->kern_sg_entries = 0;
9349 desc = (struct scsi_vpd_id_descriptor *)devid_ptr->desc_list;
9350 t10id = (struct scsi_vpd_id_t10 *)&desc->identifier[0];
9351 desc1 = (struct scsi_vpd_id_descriptor *)(&desc->identifier[0] +
9352 sizeof(struct scsi_vpd_id_t10) + CTL_DEVID_LEN);
9353 desc2 = (struct scsi_vpd_id_descriptor *)(&desc1->identifier[0] +
9355 desc3 = (struct scsi_vpd_id_descriptor *)(&desc2->identifier[0] +
9356 sizeof(struct scsi_vpd_id_rel_trgt_port_id));
9359 * The control device is always connected. The disk device, on the
9360 * other hand, may not be online all the time.
9363 devid_ptr->device = (SID_QUAL_LU_CONNECTED << 5) |
9364 lun->be_lun->lun_type;
9366 devid_ptr->device = (SID_QUAL_LU_OFFLINE << 5) | T_DIRECT;
9368 devid_ptr->page_code = SVPD_DEVICE_ID;
9370 scsi_ulto2b(devid_len - 4, devid_ptr->length);
9372 mtx_lock(&ctl_softc->ctl_lock);
9375 * For Fibre channel,
9377 if (fe->port_type == CTL_PORT_FC)
9379 desc->proto_codeset = (SCSI_PROTO_FC << 4) |
9380 SVPD_ID_CODESET_ASCII;
9381 desc1->proto_codeset = (SCSI_PROTO_FC << 4) |
9382 SVPD_ID_CODESET_BINARY;
9386 desc->proto_codeset = (SCSI_PROTO_SPI << 4) |
9387 SVPD_ID_CODESET_ASCII;
9388 desc1->proto_codeset = (SCSI_PROTO_SPI << 4) |
9389 SVPD_ID_CODESET_BINARY;
9391 desc2->proto_codeset = desc3->proto_codeset = desc1->proto_codeset;
9392 mtx_unlock(&ctl_softc->ctl_lock);
9395 * We're using a LUN association here. i.e., this device ID is a
9396 * per-LUN identifier.
9398 desc->id_type = SVPD_ID_PIV | SVPD_ID_ASSOC_LUN | SVPD_ID_TYPE_T10;
9399 desc->length = sizeof(*t10id) + CTL_DEVID_LEN;
9400 if (lun == NULL || (val = ctl_get_opt(lun->be_lun, "vendor")) == NULL) {
9401 strncpy((char *)t10id->vendor, CTL_VENDOR, sizeof(t10id->vendor));
9403 memset(t10id->vendor, ' ', sizeof(t10id->vendor));
9404 strncpy(t10id->vendor, val,
9405 min(sizeof(t10id->vendor), strlen(val)));
9409 * desc1 is for the WWPN which is a port asscociation.
9411 desc1->id_type = SVPD_ID_PIV | SVPD_ID_ASSOC_PORT | SVPD_ID_TYPE_NAA;
9412 desc1->length = CTL_WWPN_LEN;
9413 /* XXX Call Reggie's get_WWNN func here then add port # to the end */
9414 /* For testing just create the WWPN */
9416 ddb_GetWWNN((char *)desc1->identifier);
9418 /* NOTE: if the port is 0 or 8 we don't want to subtract 1 */
9419 /* This is so Copancontrol will return something sane */
9420 if (ctsio->io_hdr.nexus.targ_port!=0 &&
9421 ctsio->io_hdr.nexus.targ_port!=8)
9422 desc1->identifier[7] += ctsio->io_hdr.nexus.targ_port-1;
9424 desc1->identifier[7] += ctsio->io_hdr.nexus.targ_port;
9427 be64enc(desc1->identifier, fe->wwpn);
9430 * desc2 is for the Relative Target Port(type 4h) identifier
9432 desc2->id_type = SVPD_ID_PIV | SVPD_ID_ASSOC_PORT
9433 | SVPD_ID_TYPE_RELTARG;
9436 /* NOTE: if the port is 0 or 8 we don't want to subtract 1 */
9437 /* This is so Copancontrol will return something sane */
9438 if (ctsio->io_hdr.nexus.targ_port!=0 &&
9439 ctsio->io_hdr.nexus.targ_port!=8)
9440 desc2->identifier[3] = ctsio->io_hdr.nexus.targ_port - 1;
9442 desc2->identifier[3] = ctsio->io_hdr.nexus.targ_port;
9446 * desc3 is for the Target Port Group(type 5h) identifier
9448 desc3->id_type = SVPD_ID_PIV | SVPD_ID_ASSOC_PORT
9449 | SVPD_ID_TYPE_TPORTGRP;
9451 if (ctsio->io_hdr.nexus.targ_port < CTL_MAX_PORTS || ctl_is_single)
9452 desc3->identifier[3] = 1;
9454 desc3->identifier[3] = 2;
9456 #ifdef CTL_USE_BACKEND_SN
9458 * If we've actually got a backend, copy the device id from the
9459 * per-LUN data. Otherwise, set it to all spaces.
9463 * Copy the backend's LUN ID.
9465 strncpy((char *)t10id->vendor_spec_id,
9466 (char *)lun->be_lun->device_id, CTL_DEVID_LEN);
9469 * No backend, set this to spaces.
9471 memset(t10id->vendor_spec_id, 0x20, CTL_DEVID_LEN);
9474 snprintf(tmpstr, sizeof(tmpstr), "MYDEVICEIDIS%4d",
9475 (lun != NULL) ? (int)lun->lun : 0);
9476 strncpy(t10id->vendor_spec_id, tmpstr, ctl_min(CTL_DEVID_LEN,
9480 ctsio->scsi_status = SCSI_STATUS_OK;
9482 ctsio->be_move_done = ctl_config_move_done;
9483 ctl_datamove((union ctl_io *)ctsio);
9485 return (CTL_RETVAL_COMPLETE);
9489 ctl_inquiry_evpd_block_limits(struct ctl_scsiio *ctsio, int alloc_len)
9491 struct scsi_vpd_block_limits *bl_ptr;
9492 struct ctl_lun *lun;
9495 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
9496 bs = lun->be_lun->blocksize;
9498 ctsio->kern_data_ptr = malloc(sizeof(*bl_ptr), M_CTL, M_WAITOK | M_ZERO);
9499 bl_ptr = (struct scsi_vpd_block_limits *)ctsio->kern_data_ptr;
9500 ctsio->kern_sg_entries = 0;
9502 if (sizeof(*bl_ptr) < alloc_len) {
9503 ctsio->residual = alloc_len - sizeof(*bl_ptr);
9504 ctsio->kern_data_len = sizeof(*bl_ptr);
9505 ctsio->kern_total_len = sizeof(*bl_ptr);
9507 ctsio->residual = 0;
9508 ctsio->kern_data_len = alloc_len;
9509 ctsio->kern_total_len = alloc_len;
9511 ctsio->kern_data_resid = 0;
9512 ctsio->kern_rel_offset = 0;
9513 ctsio->kern_sg_entries = 0;
9516 * The control device is always connected. The disk device, on the
9517 * other hand, may not be online all the time. Need to change this
9518 * to figure out whether the disk device is actually online or not.
9521 bl_ptr->device = (SID_QUAL_LU_CONNECTED << 5) |
9522 lun->be_lun->lun_type;
9524 bl_ptr->device = (SID_QUAL_LU_OFFLINE << 5) | T_DIRECT;
9526 bl_ptr->page_code = SVPD_BLOCK_LIMITS;
9527 scsi_ulto2b(sizeof(*bl_ptr), bl_ptr->page_length);
9528 scsi_ulto4b(0xffffffff, bl_ptr->max_txfer_len);
9529 scsi_ulto4b(MAXPHYS / bs, bl_ptr->opt_txfer_len);
9530 if (lun->be_lun->flags & CTL_LUN_FLAG_UNMAP) {
9531 scsi_ulto4b(0xffffffff, bl_ptr->max_unmap_lba_cnt);
9532 scsi_ulto4b(0xffffffff, bl_ptr->max_unmap_blk_cnt);
9534 scsi_u64to8b(UINT64_MAX, bl_ptr->max_write_same_length);
9536 ctsio->scsi_status = SCSI_STATUS_OK;
9537 ctsio->be_move_done = ctl_config_move_done;
9538 ctl_datamove((union ctl_io *)ctsio);
9540 return (CTL_RETVAL_COMPLETE);
9544 ctl_inquiry_evpd_lbp(struct ctl_scsiio *ctsio, int alloc_len)
9546 struct scsi_vpd_logical_block_prov *lbp_ptr;
9547 struct ctl_lun *lun;
9550 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
9551 bs = lun->be_lun->blocksize;
9553 ctsio->kern_data_ptr = malloc(sizeof(*lbp_ptr), M_CTL, M_WAITOK | M_ZERO);
9554 lbp_ptr = (struct scsi_vpd_logical_block_prov *)ctsio->kern_data_ptr;
9555 ctsio->kern_sg_entries = 0;
9557 if (sizeof(*lbp_ptr) < alloc_len) {
9558 ctsio->residual = alloc_len - sizeof(*lbp_ptr);
9559 ctsio->kern_data_len = sizeof(*lbp_ptr);
9560 ctsio->kern_total_len = sizeof(*lbp_ptr);
9562 ctsio->residual = 0;
9563 ctsio->kern_data_len = alloc_len;
9564 ctsio->kern_total_len = alloc_len;
9566 ctsio->kern_data_resid = 0;
9567 ctsio->kern_rel_offset = 0;
9568 ctsio->kern_sg_entries = 0;
9571 * The control device is always connected. The disk device, on the
9572 * other hand, may not be online all the time. Need to change this
9573 * to figure out whether the disk device is actually online or not.
9576 lbp_ptr->device = (SID_QUAL_LU_CONNECTED << 5) |
9577 lun->be_lun->lun_type;
9579 lbp_ptr->device = (SID_QUAL_LU_OFFLINE << 5) | T_DIRECT;
9581 lbp_ptr->page_code = SVPD_LBP;
9582 if (lun->be_lun->flags & CTL_LUN_FLAG_UNMAP)
9583 lbp_ptr->flags = SVPD_LBP_UNMAP | SVPD_LBP_WS16 | SVPD_LBP_WS10;
9585 ctsio->scsi_status = SCSI_STATUS_OK;
9586 ctsio->be_move_done = ctl_config_move_done;
9587 ctl_datamove((union ctl_io *)ctsio);
9589 return (CTL_RETVAL_COMPLETE);
9593 ctl_inquiry_evpd(struct ctl_scsiio *ctsio)
9595 struct scsi_inquiry *cdb;
9596 struct ctl_lun *lun;
9597 int alloc_len, retval;
9599 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
9600 cdb = (struct scsi_inquiry *)ctsio->cdb;
9602 retval = CTL_RETVAL_COMPLETE;
9604 alloc_len = scsi_2btoul(cdb->length);
9606 switch (cdb->page_code) {
9607 case SVPD_SUPPORTED_PAGES:
9608 retval = ctl_inquiry_evpd_supported(ctsio, alloc_len);
9610 case SVPD_UNIT_SERIAL_NUMBER:
9611 retval = ctl_inquiry_evpd_serial(ctsio, alloc_len);
9613 case SVPD_DEVICE_ID:
9614 retval = ctl_inquiry_evpd_devid(ctsio, alloc_len);
9616 case SVPD_BLOCK_LIMITS:
9617 retval = ctl_inquiry_evpd_block_limits(ctsio, alloc_len);
9620 retval = ctl_inquiry_evpd_lbp(ctsio, alloc_len);
9623 ctl_set_invalid_field(ctsio,
9629 ctl_done((union ctl_io *)ctsio);
9630 retval = CTL_RETVAL_COMPLETE;
9638 ctl_inquiry_std(struct ctl_scsiio *ctsio)
9640 struct scsi_inquiry_data *inq_ptr;
9641 struct scsi_inquiry *cdb;
9642 struct ctl_softc *ctl_softc;
9643 struct ctl_lun *lun;
9648 ctl_softc = control_softc;
9651 * Figure out whether we're talking to a Fibre Channel port or not.
9652 * We treat the ioctl front end, and any SCSI adapters, as packetized
9655 mtx_lock(&ctl_softc->ctl_lock);
9656 if (ctl_softc->ctl_ports[ctl_port_idx(ctsio->io_hdr.nexus.targ_port)]->port_type !=
9661 mtx_unlock(&ctl_softc->ctl_lock);
9663 lun = ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
9664 cdb = (struct scsi_inquiry *)ctsio->cdb;
9665 alloc_len = scsi_2btoul(cdb->length);
9668 * We malloc the full inquiry data size here and fill it
9669 * in. If the user only asks for less, we'll give him
9672 ctsio->kern_data_ptr = malloc(sizeof(*inq_ptr), M_CTL, M_WAITOK | M_ZERO);
9673 inq_ptr = (struct scsi_inquiry_data *)ctsio->kern_data_ptr;
9674 ctsio->kern_sg_entries = 0;
9675 ctsio->kern_data_resid = 0;
9676 ctsio->kern_rel_offset = 0;
9678 if (sizeof(*inq_ptr) < alloc_len) {
9679 ctsio->residual = alloc_len - sizeof(*inq_ptr);
9680 ctsio->kern_data_len = sizeof(*inq_ptr);
9681 ctsio->kern_total_len = sizeof(*inq_ptr);
9683 ctsio->residual = 0;
9684 ctsio->kern_data_len = alloc_len;
9685 ctsio->kern_total_len = alloc_len;
9689 * If we have a LUN configured, report it as connected. Otherwise,
9690 * report that it is offline or no device is supported, depending
9691 * on the value of inquiry_pq_no_lun.
9693 * According to the spec (SPC-4 r34), the peripheral qualifier
9694 * SID_QUAL_LU_OFFLINE (001b) is used in the following scenario:
9696 * "A peripheral device having the specified peripheral device type
9697 * is not connected to this logical unit. However, the device
9698 * server is capable of supporting the specified peripheral device
9699 * type on this logical unit."
9701 * According to the same spec, the peripheral qualifier
9702 * SID_QUAL_BAD_LU (011b) is used in this scenario:
9704 * "The device server is not capable of supporting a peripheral
9705 * device on this logical unit. For this peripheral qualifier the
9706 * peripheral device type shall be set to 1Fh. All other peripheral
9707 * device type values are reserved for this peripheral qualifier."
9709 * Given the text, it would seem that we probably want to report that
9710 * the LUN is offline here. There is no LUN connected, but we can
9711 * support a LUN at the given LUN number.
9713 * In the real world, though, it sounds like things are a little
9716 * - Linux, when presented with a LUN with the offline peripheral
9717 * qualifier, will create an sg driver instance for it. So when
9718 * you attach it to CTL, you wind up with a ton of sg driver
9719 * instances. (One for every LUN that Linux bothered to probe.)
9720 * Linux does this despite the fact that it issues a REPORT LUNs
9721 * to LUN 0 to get the inventory of supported LUNs.
9723 * - There is other anecdotal evidence (from Emulex folks) about
9724 * arrays that use the offline peripheral qualifier for LUNs that
9725 * are on the "passive" path in an active/passive array.
9727 * So the solution is provide a hopefully reasonable default
9728 * (return bad/no LUN) and allow the user to change the behavior
9729 * with a tunable/sysctl variable.
9732 inq_ptr->device = (SID_QUAL_LU_CONNECTED << 5) |
9733 lun->be_lun->lun_type;
9734 else if (ctl_softc->inquiry_pq_no_lun == 0)
9735 inq_ptr->device = (SID_QUAL_LU_OFFLINE << 5) | T_DIRECT;
9737 inq_ptr->device = (SID_QUAL_BAD_LU << 5) | T_NODEVICE;
9739 /* RMB in byte 2 is 0 */
9740 inq_ptr->version = SCSI_REV_SPC3;
9743 * According to SAM-3, even if a device only supports a single
9744 * level of LUN addressing, it should still set the HISUP bit:
9746 * 4.9.1 Logical unit numbers overview
9748 * All logical unit number formats described in this standard are
9749 * hierarchical in structure even when only a single level in that
9750 * hierarchy is used. The HISUP bit shall be set to one in the
9751 * standard INQUIRY data (see SPC-2) when any logical unit number
9752 * format described in this standard is used. Non-hierarchical
9753 * formats are outside the scope of this standard.
9755 * Therefore we set the HiSup bit here.
9757 * The reponse format is 2, per SPC-3.
9759 inq_ptr->response_format = SID_HiSup | 2;
9761 inq_ptr->additional_length = sizeof(*inq_ptr) - 4;
9762 CTL_DEBUG_PRINT(("additional_length = %d\n",
9763 inq_ptr->additional_length));
9765 inq_ptr->spc3_flags = SPC3_SID_TPGS_IMPLICIT;
9766 /* 16 bit addressing */
9768 inq_ptr->spc2_flags = SPC2_SID_ADDR16;
9769 /* XXX set the SID_MultiP bit here if we're actually going to
9770 respond on multiple ports */
9771 inq_ptr->spc2_flags |= SPC2_SID_MultiP;
9773 /* 16 bit data bus, synchronous transfers */
9774 /* XXX these flags don't apply for FC */
9776 inq_ptr->flags = SID_WBus16 | SID_Sync;
9778 * XXX KDM do we want to support tagged queueing on the control
9782 || (lun->be_lun->lun_type != T_PROCESSOR))
9783 inq_ptr->flags |= SID_CmdQue;
9785 * Per SPC-3, unused bytes in ASCII strings are filled with spaces.
9786 * We have 8 bytes for the vendor name, and 16 bytes for the device
9787 * name and 4 bytes for the revision.
9789 if (lun == NULL || (val = ctl_get_opt(lun->be_lun, "vendor")) == NULL) {
9790 strcpy(inq_ptr->vendor, CTL_VENDOR);
9792 memset(inq_ptr->vendor, ' ', sizeof(inq_ptr->vendor));
9793 strncpy(inq_ptr->vendor, val,
9794 min(sizeof(inq_ptr->vendor), strlen(val)));
9797 strcpy(inq_ptr->product, CTL_DIRECT_PRODUCT);
9798 } else if ((val = ctl_get_opt(lun->be_lun, "product")) == NULL) {
9799 switch (lun->be_lun->lun_type) {
9801 strcpy(inq_ptr->product, CTL_DIRECT_PRODUCT);
9804 strcpy(inq_ptr->product, CTL_PROCESSOR_PRODUCT);
9807 strcpy(inq_ptr->product, CTL_UNKNOWN_PRODUCT);
9811 memset(inq_ptr->product, ' ', sizeof(inq_ptr->product));
9812 strncpy(inq_ptr->product, val,
9813 min(sizeof(inq_ptr->product), strlen(val)));
9817 * XXX make this a macro somewhere so it automatically gets
9818 * incremented when we make changes.
9820 if (lun == NULL || (val = ctl_get_opt(lun->be_lun, "revision")) == NULL) {
9821 strncpy(inq_ptr->revision, "0001", sizeof(inq_ptr->revision));
9823 memset(inq_ptr->revision, ' ', sizeof(inq_ptr->revision));
9824 strncpy(inq_ptr->revision, val,
9825 min(sizeof(inq_ptr->revision), strlen(val)));
9829 * For parallel SCSI, we support double transition and single
9830 * transition clocking. We also support QAS (Quick Arbitration
9831 * and Selection) and Information Unit transfers on both the
9832 * control and array devices.
9835 inq_ptr->spi3data = SID_SPI_CLOCK_DT_ST | SID_SPI_QAS |
9839 scsi_ulto2b(0x0060, inq_ptr->version1);
9840 /* SPC-3 (no version claimed) XXX should we claim a version? */
9841 scsi_ulto2b(0x0300, inq_ptr->version2);
9843 /* FCP-2 ANSI INCITS.350:2003 */
9844 scsi_ulto2b(0x0917, inq_ptr->version3);
9846 /* SPI-4 ANSI INCITS.362:200x */
9847 scsi_ulto2b(0x0B56, inq_ptr->version3);
9851 /* SBC-2 (no version claimed) XXX should we claim a version? */
9852 scsi_ulto2b(0x0320, inq_ptr->version4);
9854 switch (lun->be_lun->lun_type) {
9857 * SBC-2 (no version claimed) XXX should we claim a
9860 scsi_ulto2b(0x0320, inq_ptr->version4);
9868 ctsio->scsi_status = SCSI_STATUS_OK;
9869 if (ctsio->kern_data_len > 0) {
9870 ctsio->be_move_done = ctl_config_move_done;
9871 ctl_datamove((union ctl_io *)ctsio);
9873 ctsio->io_hdr.status = CTL_SUCCESS;
9874 ctl_done((union ctl_io *)ctsio);
9877 return (CTL_RETVAL_COMPLETE);
9881 ctl_inquiry(struct ctl_scsiio *ctsio)
9883 struct scsi_inquiry *cdb;
9886 cdb = (struct scsi_inquiry *)ctsio->cdb;
9890 CTL_DEBUG_PRINT(("ctl_inquiry\n"));
9893 * Right now, we don't support the CmdDt inquiry information.
9894 * This would be nice to support in the future. When we do
9895 * support it, we should change this test so that it checks to make
9896 * sure SI_EVPD and SI_CMDDT aren't both set at the same time.
9899 if (((cdb->byte2 & SI_EVPD)
9900 && (cdb->byte2 & SI_CMDDT)))
9902 if (cdb->byte2 & SI_CMDDT) {
9904 * Point to the SI_CMDDT bit. We might change this
9905 * when we support SI_CMDDT, but since both bits would be
9906 * "wrong", this should probably just stay as-is then.
9908 ctl_set_invalid_field(ctsio,
9914 ctl_done((union ctl_io *)ctsio);
9915 return (CTL_RETVAL_COMPLETE);
9917 if (cdb->byte2 & SI_EVPD)
9918 retval = ctl_inquiry_evpd(ctsio);
9920 else if (cdb->byte2 & SI_CMDDT)
9921 retval = ctl_inquiry_cmddt(ctsio);
9924 retval = ctl_inquiry_std(ctsio);
9930 * For known CDB types, parse the LBA and length.
9933 ctl_get_lba_len(union ctl_io *io, uint64_t *lba, uint32_t *len)
9935 if (io->io_hdr.io_type != CTL_IO_SCSI)
9938 switch (io->scsiio.cdb[0]) {
9941 struct scsi_rw_6 *cdb;
9943 cdb = (struct scsi_rw_6 *)io->scsiio.cdb;
9945 *lba = scsi_3btoul(cdb->addr);
9946 /* only 5 bits are valid in the most significant address byte */
9953 struct scsi_rw_10 *cdb;
9955 cdb = (struct scsi_rw_10 *)io->scsiio.cdb;
9957 *lba = scsi_4btoul(cdb->addr);
9958 *len = scsi_2btoul(cdb->length);
9961 case WRITE_VERIFY_10: {
9962 struct scsi_write_verify_10 *cdb;
9964 cdb = (struct scsi_write_verify_10 *)io->scsiio.cdb;
9966 *lba = scsi_4btoul(cdb->addr);
9967 *len = scsi_2btoul(cdb->length);
9972 struct scsi_rw_12 *cdb;
9974 cdb = (struct scsi_rw_12 *)io->scsiio.cdb;
9976 *lba = scsi_4btoul(cdb->addr);
9977 *len = scsi_4btoul(cdb->length);
9980 case WRITE_VERIFY_12: {
9981 struct scsi_write_verify_12 *cdb;
9983 cdb = (struct scsi_write_verify_12 *)io->scsiio.cdb;
9985 *lba = scsi_4btoul(cdb->addr);
9986 *len = scsi_4btoul(cdb->length);
9991 struct scsi_rw_16 *cdb;
9993 cdb = (struct scsi_rw_16 *)io->scsiio.cdb;
9995 *lba = scsi_8btou64(cdb->addr);
9996 *len = scsi_4btoul(cdb->length);
9999 case WRITE_VERIFY_16: {
10000 struct scsi_write_verify_16 *cdb;
10002 cdb = (struct scsi_write_verify_16 *)io->scsiio.cdb;
10005 *lba = scsi_8btou64(cdb->addr);
10006 *len = scsi_4btoul(cdb->length);
10009 case WRITE_SAME_10: {
10010 struct scsi_write_same_10 *cdb;
10012 cdb = (struct scsi_write_same_10 *)io->scsiio.cdb;
10014 *lba = scsi_4btoul(cdb->addr);
10015 *len = scsi_2btoul(cdb->length);
10018 case WRITE_SAME_16: {
10019 struct scsi_write_same_16 *cdb;
10021 cdb = (struct scsi_write_same_16 *)io->scsiio.cdb;
10023 *lba = scsi_8btou64(cdb->addr);
10024 *len = scsi_4btoul(cdb->length);
10029 break; /* NOTREACHED */
10036 ctl_extent_check_lba(uint64_t lba1, uint32_t len1, uint64_t lba2, uint32_t len2)
10038 uint64_t endlba1, endlba2;
10040 endlba1 = lba1 + len1 - 1;
10041 endlba2 = lba2 + len2 - 1;
10043 if ((endlba1 < lba2)
10044 || (endlba2 < lba1))
10045 return (CTL_ACTION_PASS);
10047 return (CTL_ACTION_BLOCK);
10051 ctl_extent_check(union ctl_io *io1, union ctl_io *io2)
10053 uint64_t lba1, lba2;
10054 uint32_t len1, len2;
10057 retval = ctl_get_lba_len(io1, &lba1, &len1);
10059 return (CTL_ACTION_ERROR);
10061 retval = ctl_get_lba_len(io2, &lba2, &len2);
10063 return (CTL_ACTION_ERROR);
10065 return (ctl_extent_check_lba(lba1, len1, lba2, len2));
10069 ctl_check_for_blockage(union ctl_io *pending_io, union ctl_io *ooa_io)
10071 struct ctl_cmd_entry *pending_entry, *ooa_entry;
10072 ctl_serialize_action *serialize_row;
10075 * The initiator attempted multiple untagged commands at the same
10076 * time. Can't do that.
10078 if ((pending_io->scsiio.tag_type == CTL_TAG_UNTAGGED)
10079 && (ooa_io->scsiio.tag_type == CTL_TAG_UNTAGGED)
10080 && ((pending_io->io_hdr.nexus.targ_port ==
10081 ooa_io->io_hdr.nexus.targ_port)
10082 && (pending_io->io_hdr.nexus.initid.id ==
10083 ooa_io->io_hdr.nexus.initid.id))
10084 && ((ooa_io->io_hdr.flags & CTL_FLAG_ABORT) == 0))
10085 return (CTL_ACTION_OVERLAP);
10088 * The initiator attempted to send multiple tagged commands with
10089 * the same ID. (It's fine if different initiators have the same
10092 * Even if all of those conditions are true, we don't kill the I/O
10093 * if the command ahead of us has been aborted. We won't end up
10094 * sending it to the FETD, and it's perfectly legal to resend a
10095 * command with the same tag number as long as the previous
10096 * instance of this tag number has been aborted somehow.
10098 if ((pending_io->scsiio.tag_type != CTL_TAG_UNTAGGED)
10099 && (ooa_io->scsiio.tag_type != CTL_TAG_UNTAGGED)
10100 && (pending_io->scsiio.tag_num == ooa_io->scsiio.tag_num)
10101 && ((pending_io->io_hdr.nexus.targ_port ==
10102 ooa_io->io_hdr.nexus.targ_port)
10103 && (pending_io->io_hdr.nexus.initid.id ==
10104 ooa_io->io_hdr.nexus.initid.id))
10105 && ((ooa_io->io_hdr.flags & CTL_FLAG_ABORT) == 0))
10106 return (CTL_ACTION_OVERLAP_TAG);
10109 * If we get a head of queue tag, SAM-3 says that we should
10110 * immediately execute it.
10112 * What happens if this command would normally block for some other
10113 * reason? e.g. a request sense with a head of queue tag
10114 * immediately after a write. Normally that would block, but this
10115 * will result in its getting executed immediately...
10117 * We currently return "pass" instead of "skip", so we'll end up
10118 * going through the rest of the queue to check for overlapped tags.
10120 * XXX KDM check for other types of blockage first??
10122 if (pending_io->scsiio.tag_type == CTL_TAG_HEAD_OF_QUEUE)
10123 return (CTL_ACTION_PASS);
10126 * Ordered tags have to block until all items ahead of them
10127 * have completed. If we get called with an ordered tag, we always
10128 * block, if something else is ahead of us in the queue.
10130 if (pending_io->scsiio.tag_type == CTL_TAG_ORDERED)
10131 return (CTL_ACTION_BLOCK);
10134 * Simple tags get blocked until all head of queue and ordered tags
10135 * ahead of them have completed. I'm lumping untagged commands in
10136 * with simple tags here. XXX KDM is that the right thing to do?
10138 if (((pending_io->scsiio.tag_type == CTL_TAG_UNTAGGED)
10139 || (pending_io->scsiio.tag_type == CTL_TAG_SIMPLE))
10140 && ((ooa_io->scsiio.tag_type == CTL_TAG_HEAD_OF_QUEUE)
10141 || (ooa_io->scsiio.tag_type == CTL_TAG_ORDERED)))
10142 return (CTL_ACTION_BLOCK);
10144 pending_entry = &ctl_cmd_table[pending_io->scsiio.cdb[0]];
10145 ooa_entry = &ctl_cmd_table[ooa_io->scsiio.cdb[0]];
10147 serialize_row = ctl_serialize_table[ooa_entry->seridx];
10149 switch (serialize_row[pending_entry->seridx]) {
10150 case CTL_SER_BLOCK:
10151 return (CTL_ACTION_BLOCK);
10152 break; /* NOTREACHED */
10153 case CTL_SER_EXTENT:
10154 return (ctl_extent_check(pending_io, ooa_io));
10155 break; /* NOTREACHED */
10157 return (CTL_ACTION_PASS);
10158 break; /* NOTREACHED */
10160 return (CTL_ACTION_SKIP);
10163 panic("invalid serialization value %d",
10164 serialize_row[pending_entry->seridx]);
10165 break; /* NOTREACHED */
10168 return (CTL_ACTION_ERROR);
10172 * Check for blockage or overlaps against the OOA (Order Of Arrival) queue.
10174 * - pending_io is generally either incoming, or on the blocked queue
10175 * - starting I/O is the I/O we want to start the check with.
10178 ctl_check_ooa(struct ctl_lun *lun, union ctl_io *pending_io,
10179 union ctl_io *starting_io)
10181 union ctl_io *ooa_io;
10184 mtx_assert(&control_softc->ctl_lock, MA_OWNED);
10187 * Run back along the OOA queue, starting with the current
10188 * blocked I/O and going through every I/O before it on the
10189 * queue. If starting_io is NULL, we'll just end up returning
10192 for (ooa_io = starting_io; ooa_io != NULL;
10193 ooa_io = (union ctl_io *)TAILQ_PREV(&ooa_io->io_hdr, ctl_ooaq,
10197 * This routine just checks to see whether
10198 * cur_blocked is blocked by ooa_io, which is ahead
10199 * of it in the queue. It doesn't queue/dequeue
10202 action = ctl_check_for_blockage(pending_io, ooa_io);
10204 case CTL_ACTION_BLOCK:
10205 case CTL_ACTION_OVERLAP:
10206 case CTL_ACTION_OVERLAP_TAG:
10207 case CTL_ACTION_SKIP:
10208 case CTL_ACTION_ERROR:
10210 break; /* NOTREACHED */
10211 case CTL_ACTION_PASS:
10214 panic("invalid action %d", action);
10215 break; /* NOTREACHED */
10219 return (CTL_ACTION_PASS);
10224 * - An I/O has just completed, and has been removed from the per-LUN OOA
10225 * queue, so some items on the blocked queue may now be unblocked.
10228 ctl_check_blocked(struct ctl_lun *lun)
10230 union ctl_io *cur_blocked, *next_blocked;
10232 mtx_assert(&control_softc->ctl_lock, MA_OWNED);
10235 * Run forward from the head of the blocked queue, checking each
10236 * entry against the I/Os prior to it on the OOA queue to see if
10237 * there is still any blockage.
10239 * We cannot use the TAILQ_FOREACH() macro, because it can't deal
10240 * with our removing a variable on it while it is traversing the
10243 for (cur_blocked = (union ctl_io *)TAILQ_FIRST(&lun->blocked_queue);
10244 cur_blocked != NULL; cur_blocked = next_blocked) {
10245 union ctl_io *prev_ooa;
10248 next_blocked = (union ctl_io *)TAILQ_NEXT(&cur_blocked->io_hdr,
10251 prev_ooa = (union ctl_io *)TAILQ_PREV(&cur_blocked->io_hdr,
10252 ctl_ooaq, ooa_links);
10255 * If cur_blocked happens to be the first item in the OOA
10256 * queue now, prev_ooa will be NULL, and the action
10257 * returned will just be CTL_ACTION_PASS.
10259 action = ctl_check_ooa(lun, cur_blocked, prev_ooa);
10262 case CTL_ACTION_BLOCK:
10263 /* Nothing to do here, still blocked */
10265 case CTL_ACTION_OVERLAP:
10266 case CTL_ACTION_OVERLAP_TAG:
10268 * This shouldn't happen! In theory we've already
10269 * checked this command for overlap...
10272 case CTL_ACTION_PASS:
10273 case CTL_ACTION_SKIP: {
10274 struct ctl_softc *softc;
10275 struct ctl_cmd_entry *entry;
10281 * The skip case shouldn't happen, this transaction
10282 * should have never made it onto the blocked queue.
10285 * This I/O is no longer blocked, we can remove it
10286 * from the blocked queue. Since this is a TAILQ
10287 * (doubly linked list), we can do O(1) removals
10288 * from any place on the list.
10290 TAILQ_REMOVE(&lun->blocked_queue, &cur_blocked->io_hdr,
10292 cur_blocked->io_hdr.flags &= ~CTL_FLAG_BLOCKED;
10294 if (cur_blocked->io_hdr.flags & CTL_FLAG_FROM_OTHER_SC){
10296 * Need to send IO back to original side to
10299 union ctl_ha_msg msg_info;
10301 msg_info.hdr.original_sc =
10302 cur_blocked->io_hdr.original_sc;
10303 msg_info.hdr.serializing_sc = cur_blocked;
10304 msg_info.hdr.msg_type = CTL_MSG_R2R;
10305 if ((isc_retval=ctl_ha_msg_send(CTL_HA_CHAN_CTL,
10306 &msg_info, sizeof(msg_info), 0)) >
10307 CTL_HA_STATUS_SUCCESS) {
10308 printf("CTL:Check Blocked error from "
10309 "ctl_ha_msg_send %d\n",
10314 opcode = cur_blocked->scsiio.cdb[0];
10315 entry = &ctl_cmd_table[opcode];
10316 softc = control_softc;
10318 initidx = ctl_get_initindex(&cur_blocked->io_hdr.nexus);
10321 * Check this I/O for LUN state changes that may
10322 * have happened while this command was blocked.
10323 * The LUN state may have been changed by a command
10324 * ahead of us in the queue, so we need to re-check
10325 * for any states that can be caused by SCSI
10328 if (ctl_scsiio_lun_check(softc, lun, entry,
10329 &cur_blocked->scsiio) == 0) {
10330 cur_blocked->io_hdr.flags |=
10331 CTL_FLAG_IS_WAS_ON_RTR;
10332 STAILQ_INSERT_TAIL(&lun->ctl_softc->rtr_queue,
10333 &cur_blocked->io_hdr, links);
10335 * In the non CTL_DONE_THREAD case, we need
10336 * to wake up the work thread here. When
10337 * we're processing completed requests from
10338 * the work thread context, we'll pop back
10339 * around and end up pulling things off the
10340 * RtR queue. When we aren't processing
10341 * things from the work thread context,
10342 * though, we won't ever check the RtR queue.
10343 * So we need to wake up the thread to clear
10344 * things off the queue. Otherwise this
10345 * transaction will just sit on the RtR queue
10346 * until a new I/O comes in. (Which may or
10347 * may not happen...)
10349 #ifndef CTL_DONE_THREAD
10350 ctl_wakeup_thread();
10353 ctl_done_lock(cur_blocked, /*have_lock*/ 1);
10358 * This probably shouldn't happen -- we shouldn't
10359 * get CTL_ACTION_ERROR, or anything else.
10365 return (CTL_RETVAL_COMPLETE);
10369 * This routine (with one exception) checks LUN flags that can be set by
10370 * commands ahead of us in the OOA queue. These flags have to be checked
10371 * when a command initially comes in, and when we pull a command off the
10372 * blocked queue and are preparing to execute it. The reason we have to
10373 * check these flags for commands on the blocked queue is that the LUN
10374 * state may have been changed by a command ahead of us while we're on the
10377 * Ordering is somewhat important with these checks, so please pay
10378 * careful attention to the placement of any new checks.
10381 ctl_scsiio_lun_check(struct ctl_softc *ctl_softc, struct ctl_lun *lun,
10382 struct ctl_cmd_entry *entry, struct ctl_scsiio *ctsio)
10389 * If this shelf is a secondary shelf controller, we have to reject
10390 * any media access commands.
10393 /* No longer needed for HA */
10394 if (((ctl_softc->flags & CTL_FLAG_MASTER_SHELF) == 0)
10395 && ((entry->flags & CTL_CMD_FLAG_OK_ON_SECONDARY) == 0)) {
10396 ctl_set_lun_standby(ctsio);
10403 * Check for a reservation conflict. If this command isn't allowed
10404 * even on reserved LUNs, and if this initiator isn't the one who
10405 * reserved us, reject the command with a reservation conflict.
10407 if ((lun->flags & CTL_LUN_RESERVED)
10408 && ((entry->flags & CTL_CMD_FLAG_ALLOW_ON_RESV) == 0)) {
10409 if ((ctsio->io_hdr.nexus.initid.id != lun->rsv_nexus.initid.id)
10410 || (ctsio->io_hdr.nexus.targ_port != lun->rsv_nexus.targ_port)
10411 || (ctsio->io_hdr.nexus.targ_target.id !=
10412 lun->rsv_nexus.targ_target.id)) {
10413 ctsio->scsi_status = SCSI_STATUS_RESERV_CONFLICT;
10414 ctsio->io_hdr.status = CTL_SCSI_ERROR;
10420 if ( (lun->flags & CTL_LUN_PR_RESERVED)
10421 && ((entry->flags & CTL_CMD_FLAG_ALLOW_ON_PR_RESV) == 0)) {
10424 residx = ctl_get_resindex(&ctsio->io_hdr.nexus);
10426 * if we aren't registered or it's a res holder type
10427 * reservation and this isn't the res holder then set a
10429 * NOTE: Commands which might be allowed on write exclusive
10430 * type reservations are checked in the particular command
10431 * for a conflict. Read and SSU are the only ones.
10433 if (!lun->per_res[residx].registered
10434 || (residx != lun->pr_res_idx && lun->res_type < 4)) {
10435 ctsio->scsi_status = SCSI_STATUS_RESERV_CONFLICT;
10436 ctsio->io_hdr.status = CTL_SCSI_ERROR;
10443 if ((lun->flags & CTL_LUN_OFFLINE)
10444 && ((entry->flags & CTL_CMD_FLAG_OK_ON_OFFLINE) == 0)) {
10445 ctl_set_lun_not_ready(ctsio);
10451 * If the LUN is stopped, see if this particular command is allowed
10452 * for a stopped lun. Otherwise, reject it with 0x04,0x02.
10454 if ((lun->flags & CTL_LUN_STOPPED)
10455 && ((entry->flags & CTL_CMD_FLAG_OK_ON_STOPPED) == 0)) {
10456 /* "Logical unit not ready, initializing cmd. required" */
10457 ctl_set_lun_stopped(ctsio);
10462 if ((lun->flags & CTL_LUN_INOPERABLE)
10463 && ((entry->flags & CTL_CMD_FLAG_OK_ON_INOPERABLE) == 0)) {
10464 /* "Medium format corrupted" */
10465 ctl_set_medium_format_corrupted(ctsio);
10476 ctl_failover_io(union ctl_io *io, int have_lock)
10478 ctl_set_busy(&io->scsiio);
10479 ctl_done_lock(io, have_lock);
10485 struct ctl_lun *lun;
10486 struct ctl_softc *ctl_softc;
10487 union ctl_io *next_io, *pending_io;
10492 ctl_softc = control_softc;
10494 mtx_lock(&ctl_softc->ctl_lock);
10496 * Remove any cmds from the other SC from the rtr queue. These
10497 * will obviously only be for LUNs for which we're the primary.
10498 * We can't send status or get/send data for these commands.
10499 * Since they haven't been executed yet, we can just remove them.
10500 * We'll either abort them or delete them below, depending on
10501 * which HA mode we're in.
10503 for (io = (union ctl_io *)STAILQ_FIRST(&ctl_softc->rtr_queue);
10504 io != NULL; io = next_io) {
10505 next_io = (union ctl_io *)STAILQ_NEXT(&io->io_hdr, links);
10506 if (io->io_hdr.flags & CTL_FLAG_FROM_OTHER_SC)
10507 STAILQ_REMOVE(&ctl_softc->rtr_queue, &io->io_hdr,
10508 ctl_io_hdr, links);
10511 for (lun_idx=0; lun_idx < ctl_softc->num_luns; lun_idx++) {
10512 lun = ctl_softc->ctl_luns[lun_idx];
10517 * Processor LUNs are primary on both sides.
10518 * XXX will this always be true?
10520 if (lun->be_lun->lun_type == T_PROCESSOR)
10523 if ((lun->flags & CTL_LUN_PRIMARY_SC)
10524 && (ctl_softc->ha_mode == CTL_HA_MODE_SER_ONLY)) {
10525 printf("FAILOVER: primary lun %d\n", lun_idx);
10527 * Remove all commands from the other SC. First from the
10528 * blocked queue then from the ooa queue. Once we have
10529 * removed them. Call ctl_check_blocked to see if there
10530 * is anything that can run.
10532 for (io = (union ctl_io *)TAILQ_FIRST(
10533 &lun->blocked_queue); io != NULL; io = next_io) {
10535 next_io = (union ctl_io *)TAILQ_NEXT(
10536 &io->io_hdr, blocked_links);
10538 if (io->io_hdr.flags & CTL_FLAG_FROM_OTHER_SC) {
10539 TAILQ_REMOVE(&lun->blocked_queue,
10540 &io->io_hdr,blocked_links);
10541 io->io_hdr.flags &= ~CTL_FLAG_BLOCKED;
10542 TAILQ_REMOVE(&lun->ooa_queue,
10543 &io->io_hdr, ooa_links);
10549 for (io = (union ctl_io *)TAILQ_FIRST(&lun->ooa_queue);
10550 io != NULL; io = next_io) {
10552 next_io = (union ctl_io *)TAILQ_NEXT(
10553 &io->io_hdr, ooa_links);
10555 if (io->io_hdr.flags & CTL_FLAG_FROM_OTHER_SC) {
10557 TAILQ_REMOVE(&lun->ooa_queue,
10564 ctl_check_blocked(lun);
10565 } else if ((lun->flags & CTL_LUN_PRIMARY_SC)
10566 && (ctl_softc->ha_mode == CTL_HA_MODE_XFER)) {
10568 printf("FAILOVER: primary lun %d\n", lun_idx);
10570 * Abort all commands from the other SC. We can't
10571 * send status back for them now. These should get
10572 * cleaned up when they are completed or come out
10573 * for a datamove operation.
10575 for (io = (union ctl_io *)TAILQ_FIRST(&lun->ooa_queue);
10576 io != NULL; io = next_io) {
10577 next_io = (union ctl_io *)TAILQ_NEXT(
10578 &io->io_hdr, ooa_links);
10580 if (io->io_hdr.flags & CTL_FLAG_FROM_OTHER_SC)
10581 io->io_hdr.flags |= CTL_FLAG_ABORT;
10583 } else if (((lun->flags & CTL_LUN_PRIMARY_SC) == 0)
10584 && (ctl_softc->ha_mode == CTL_HA_MODE_XFER)) {
10586 printf("FAILOVER: secondary lun %d\n", lun_idx);
10588 lun->flags |= CTL_LUN_PRIMARY_SC;
10591 * We send all I/O that was sent to this controller
10592 * and redirected to the other side back with
10593 * busy status, and have the initiator retry it.
10594 * Figuring out how much data has been transferred,
10595 * etc. and picking up where we left off would be
10598 * XXX KDM need to remove I/O from the blocked
10601 for (pending_io = (union ctl_io *)TAILQ_FIRST(
10602 &lun->ooa_queue); pending_io != NULL;
10603 pending_io = next_io) {
10605 next_io = (union ctl_io *)TAILQ_NEXT(
10606 &pending_io->io_hdr, ooa_links);
10608 pending_io->io_hdr.flags &=
10609 ~CTL_FLAG_SENT_2OTHER_SC;
10611 if (pending_io->io_hdr.flags &
10612 CTL_FLAG_IO_ACTIVE) {
10613 pending_io->io_hdr.flags |=
10616 ctl_set_busy(&pending_io->scsiio);
10617 ctl_done_lock(pending_io,
10623 * Build Unit Attention
10625 for (i = 0; i < CTL_MAX_INITIATORS; i++) {
10626 lun->pending_sense[i].ua_pending |=
10627 CTL_UA_ASYM_ACC_CHANGE;
10629 } else if (((lun->flags & CTL_LUN_PRIMARY_SC) == 0)
10630 && (ctl_softc->ha_mode == CTL_HA_MODE_SER_ONLY)) {
10631 printf("FAILOVER: secondary lun %d\n", lun_idx);
10633 * if the first io on the OOA is not on the RtR queue
10636 lun->flags |= CTL_LUN_PRIMARY_SC;
10638 pending_io = (union ctl_io *)TAILQ_FIRST(
10640 if (pending_io==NULL) {
10641 printf("Nothing on OOA queue\n");
10645 pending_io->io_hdr.flags &= ~CTL_FLAG_SENT_2OTHER_SC;
10646 if ((pending_io->io_hdr.flags &
10647 CTL_FLAG_IS_WAS_ON_RTR) == 0) {
10648 pending_io->io_hdr.flags |=
10649 CTL_FLAG_IS_WAS_ON_RTR;
10650 STAILQ_INSERT_TAIL(&ctl_softc->rtr_queue,
10651 &pending_io->io_hdr, links);
10656 printf("Tag 0x%04x is running\n",
10657 pending_io->scsiio.tag_num);
10661 next_io = (union ctl_io *)TAILQ_NEXT(
10662 &pending_io->io_hdr, ooa_links);
10663 for (pending_io=next_io; pending_io != NULL;
10664 pending_io = next_io) {
10665 pending_io->io_hdr.flags &=
10666 ~CTL_FLAG_SENT_2OTHER_SC;
10667 next_io = (union ctl_io *)TAILQ_NEXT(
10668 &pending_io->io_hdr, ooa_links);
10669 if (pending_io->io_hdr.flags &
10670 CTL_FLAG_IS_WAS_ON_RTR) {
10672 printf("Tag 0x%04x is running\n",
10673 pending_io->scsiio.tag_num);
10678 switch (ctl_check_ooa(lun, pending_io,
10679 (union ctl_io *)TAILQ_PREV(
10680 &pending_io->io_hdr, ctl_ooaq,
10683 case CTL_ACTION_BLOCK:
10684 TAILQ_INSERT_TAIL(&lun->blocked_queue,
10685 &pending_io->io_hdr,
10687 pending_io->io_hdr.flags |=
10690 case CTL_ACTION_PASS:
10691 case CTL_ACTION_SKIP:
10692 pending_io->io_hdr.flags |=
10693 CTL_FLAG_IS_WAS_ON_RTR;
10694 STAILQ_INSERT_TAIL(
10695 &ctl_softc->rtr_queue,
10696 &pending_io->io_hdr, links);
10698 case CTL_ACTION_OVERLAP:
10699 ctl_set_overlapped_cmd(
10700 (struct ctl_scsiio *)pending_io);
10701 ctl_done_lock(pending_io,
10704 case CTL_ACTION_OVERLAP_TAG:
10705 ctl_set_overlapped_tag(
10706 (struct ctl_scsiio *)pending_io,
10707 pending_io->scsiio.tag_num & 0xff);
10708 ctl_done_lock(pending_io,
10711 case CTL_ACTION_ERROR:
10713 ctl_set_internal_failure(
10714 (struct ctl_scsiio *)pending_io,
10717 ctl_done_lock(pending_io,
10724 * Build Unit Attention
10726 for (i = 0; i < CTL_MAX_INITIATORS; i++) {
10727 lun->pending_sense[i].ua_pending |=
10728 CTL_UA_ASYM_ACC_CHANGE;
10731 panic("Unhandled HA mode failover, LUN flags = %#x, "
10732 "ha_mode = #%x", lun->flags, ctl_softc->ha_mode);
10736 mtx_unlock(&ctl_softc->ctl_lock);
10740 ctl_scsiio_precheck(struct ctl_softc *ctl_softc, struct ctl_scsiio *ctsio)
10742 struct ctl_lun *lun;
10743 struct ctl_cmd_entry *entry;
10745 uint32_t initidx, targ_lun;
10752 opcode = ctsio->cdb[0];
10754 mtx_lock(&ctl_softc->ctl_lock);
10756 targ_lun = ctsio->io_hdr.nexus.targ_lun;
10757 if (ctsio->io_hdr.nexus.lun_map_fn != NULL)
10758 targ_lun = ctsio->io_hdr.nexus.lun_map_fn(ctsio->io_hdr.nexus.lun_map_arg, targ_lun);
10759 if ((targ_lun < CTL_MAX_LUNS)
10760 && (ctl_softc->ctl_luns[targ_lun] != NULL)) {
10761 lun = ctl_softc->ctl_luns[targ_lun];
10763 * If the LUN is invalid, pretend that it doesn't exist.
10764 * It will go away as soon as all pending I/O has been
10767 if (lun->flags & CTL_LUN_DISABLED) {
10770 ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr = lun;
10771 ctsio->io_hdr.ctl_private[CTL_PRIV_BACKEND_LUN].ptr =
10773 if (lun->be_lun->lun_type == T_PROCESSOR) {
10774 ctsio->io_hdr.flags |= CTL_FLAG_CONTROL_DEV;
10778 ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr = NULL;
10779 ctsio->io_hdr.ctl_private[CTL_PRIV_BACKEND_LUN].ptr = NULL;
10782 entry = &ctl_cmd_table[opcode];
10784 ctsio->io_hdr.flags &= ~CTL_FLAG_DATA_MASK;
10785 ctsio->io_hdr.flags |= entry->flags & CTL_FLAG_DATA_MASK;
10788 * Check to see whether we can send this command to LUNs that don't
10789 * exist. This should pretty much only be the case for inquiry
10790 * and request sense. Further checks, below, really require having
10791 * a LUN, so we can't really check the command anymore. Just put
10792 * it on the rtr queue.
10795 if (entry->flags & CTL_CMD_FLAG_OK_ON_ALL_LUNS)
10798 ctl_set_unsupported_lun(ctsio);
10799 mtx_unlock(&ctl_softc->ctl_lock);
10800 ctl_done((union ctl_io *)ctsio);
10801 CTL_DEBUG_PRINT(("ctl_scsiio_precheck: bailing out due to invalid LUN\n"));
10805 * Every I/O goes into the OOA queue for a particular LUN, and
10806 * stays there until completion.
10808 TAILQ_INSERT_TAIL(&lun->ooa_queue, &ctsio->io_hdr, ooa_links);
10811 * Make sure we support this particular command on this LUN.
10812 * e.g., we don't support writes to the control LUN.
10814 switch (lun->be_lun->lun_type) {
10816 if (((entry->flags & CTL_CMD_FLAG_OK_ON_PROC) == 0)
10817 && ((entry->flags & CTL_CMD_FLAG_OK_ON_ALL_LUNS)
10819 ctl_set_invalid_opcode(ctsio);
10820 mtx_unlock(&ctl_softc->ctl_lock);
10821 ctl_done((union ctl_io *)ctsio);
10826 if (((entry->flags & CTL_CMD_FLAG_OK_ON_SLUN) == 0)
10827 && ((entry->flags & CTL_CMD_FLAG_OK_ON_ALL_LUNS)
10829 ctl_set_invalid_opcode(ctsio);
10830 mtx_unlock(&ctl_softc->ctl_lock);
10831 ctl_done((union ctl_io *)ctsio);
10836 printf("Unsupported CTL LUN type %d\n",
10837 lun->be_lun->lun_type);
10838 panic("Unsupported CTL LUN type %d\n",
10839 lun->be_lun->lun_type);
10840 break; /* NOTREACHED */
10844 initidx = ctl_get_initindex(&ctsio->io_hdr.nexus);
10847 * If we've got a request sense, it'll clear the contingent
10848 * allegiance condition. Otherwise, if we have a CA condition for
10849 * this initiator, clear it, because it sent down a command other
10850 * than request sense.
10852 if ((opcode != REQUEST_SENSE)
10853 && (ctl_is_set(lun->have_ca, initidx)))
10854 ctl_clear_mask(lun->have_ca, initidx);
10857 * If the command has this flag set, it handles its own unit
10858 * attention reporting, we shouldn't do anything. Otherwise we
10859 * check for any pending unit attentions, and send them back to the
10860 * initiator. We only do this when a command initially comes in,
10861 * not when we pull it off the blocked queue.
10863 * According to SAM-3, section 5.3.2, the order that things get
10864 * presented back to the host is basically unit attentions caused
10865 * by some sort of reset event, busy status, reservation conflicts
10866 * or task set full, and finally any other status.
10868 * One issue here is that some of the unit attentions we report
10869 * don't fall into the "reset" category (e.g. "reported luns data
10870 * has changed"). So reporting it here, before the reservation
10871 * check, may be technically wrong. I guess the only thing to do
10872 * would be to check for and report the reset events here, and then
10873 * check for the other unit attention types after we check for a
10874 * reservation conflict.
10876 * XXX KDM need to fix this
10878 if ((entry->flags & CTL_CMD_FLAG_NO_SENSE) == 0) {
10879 ctl_ua_type ua_type;
10881 ua_type = lun->pending_sense[initidx].ua_pending;
10882 if (ua_type != CTL_UA_NONE) {
10883 scsi_sense_data_type sense_format;
10886 sense_format = (lun->flags &
10887 CTL_LUN_SENSE_DESC) ? SSD_TYPE_DESC :
10890 sense_format = SSD_TYPE_FIXED;
10892 ua_type = ctl_build_ua(ua_type, &ctsio->sense_data,
10894 if (ua_type != CTL_UA_NONE) {
10895 ctsio->scsi_status = SCSI_STATUS_CHECK_COND;
10896 ctsio->io_hdr.status = CTL_SCSI_ERROR |
10898 ctsio->sense_len = SSD_FULL_SIZE;
10899 lun->pending_sense[initidx].ua_pending &=
10901 mtx_unlock(&ctl_softc->ctl_lock);
10902 ctl_done((union ctl_io *)ctsio);
10909 if (ctl_scsiio_lun_check(ctl_softc, lun, entry, ctsio) != 0) {
10910 mtx_unlock(&ctl_softc->ctl_lock);
10911 ctl_done((union ctl_io *)ctsio);
10916 * XXX CHD this is where we want to send IO to other side if
10917 * this LUN is secondary on this SC. We will need to make a copy
10918 * of the IO and flag the IO on this side as SENT_2OTHER and the flag
10919 * the copy we send as FROM_OTHER.
10920 * We also need to stuff the address of the original IO so we can
10921 * find it easily. Something similar will need be done on the other
10922 * side so when we are done we can find the copy.
10924 if ((lun->flags & CTL_LUN_PRIMARY_SC) == 0) {
10925 union ctl_ha_msg msg_info;
10928 ctsio->io_hdr.flags |= CTL_FLAG_SENT_2OTHER_SC;
10930 msg_info.hdr.msg_type = CTL_MSG_SERIALIZE;
10931 msg_info.hdr.original_sc = (union ctl_io *)ctsio;
10933 printf("1. ctsio %p\n", ctsio);
10935 msg_info.hdr.serializing_sc = NULL;
10936 msg_info.hdr.nexus = ctsio->io_hdr.nexus;
10937 msg_info.scsi.tag_num = ctsio->tag_num;
10938 msg_info.scsi.tag_type = ctsio->tag_type;
10939 memcpy(msg_info.scsi.cdb, ctsio->cdb, CTL_MAX_CDBLEN);
10941 ctsio->io_hdr.flags &= ~CTL_FLAG_IO_ACTIVE;
10943 if ((isc_retval=ctl_ha_msg_send(CTL_HA_CHAN_CTL,
10944 (void *)&msg_info, sizeof(msg_info), 0)) >
10945 CTL_HA_STATUS_SUCCESS) {
10946 printf("CTL:precheck, ctl_ha_msg_send returned %d\n",
10948 printf("CTL:opcode is %x\n",opcode);
10951 printf("CTL:Precheck sent msg, opcode is %x\n",opcode);
10956 * XXX KDM this I/O is off the incoming queue, but hasn't
10957 * been inserted on any other queue. We may need to come
10958 * up with a holding queue while we wait for serialization
10959 * so that we have an idea of what we're waiting for from
10962 goto bailout_unlock;
10965 switch (ctl_check_ooa(lun, (union ctl_io *)ctsio,
10966 (union ctl_io *)TAILQ_PREV(&ctsio->io_hdr,
10967 ctl_ooaq, ooa_links))) {
10968 case CTL_ACTION_BLOCK:
10969 ctsio->io_hdr.flags |= CTL_FLAG_BLOCKED;
10970 TAILQ_INSERT_TAIL(&lun->blocked_queue, &ctsio->io_hdr,
10972 goto bailout_unlock;
10973 break; /* NOTREACHED */
10974 case CTL_ACTION_PASS:
10975 case CTL_ACTION_SKIP:
10977 break; /* NOTREACHED */
10978 case CTL_ACTION_OVERLAP:
10979 ctl_set_overlapped_cmd(ctsio);
10980 mtx_unlock(&ctl_softc->ctl_lock);
10981 ctl_done((union ctl_io *)ctsio);
10983 break; /* NOTREACHED */
10984 case CTL_ACTION_OVERLAP_TAG:
10985 ctl_set_overlapped_tag(ctsio, ctsio->tag_num & 0xff);
10986 mtx_unlock(&ctl_softc->ctl_lock);
10987 ctl_done((union ctl_io *)ctsio);
10989 break; /* NOTREACHED */
10990 case CTL_ACTION_ERROR:
10992 ctl_set_internal_failure(ctsio,
10994 /*retry_count*/ 0);
10995 mtx_unlock(&ctl_softc->ctl_lock);
10996 ctl_done((union ctl_io *)ctsio);
10998 break; /* NOTREACHED */
11001 goto bailout_unlock;
11004 ctsio->io_hdr.flags |= CTL_FLAG_IS_WAS_ON_RTR;
11005 STAILQ_INSERT_TAIL(&ctl_softc->rtr_queue, &ctsio->io_hdr, links);
11008 mtx_unlock(&ctl_softc->ctl_lock);
11015 ctl_scsiio(struct ctl_scsiio *ctsio)
11018 struct ctl_cmd_entry *entry;
11020 retval = CTL_RETVAL_COMPLETE;
11022 CTL_DEBUG_PRINT(("ctl_scsiio cdb[0]=%02X\n", ctsio->cdb[0]));
11024 entry = &ctl_cmd_table[ctsio->cdb[0]];
11027 * If this I/O has been aborted, just send it straight to
11028 * ctl_done() without executing it.
11030 if (ctsio->io_hdr.flags & CTL_FLAG_ABORT) {
11031 ctl_done((union ctl_io *)ctsio);
11036 * All the checks should have been handled by ctl_scsiio_precheck().
11037 * We should be clear now to just execute the I/O.
11039 retval = entry->execute(ctsio);
11046 * Since we only implement one target right now, a bus reset simply resets
11047 * our single target.
11050 ctl_bus_reset(struct ctl_softc *ctl_softc, union ctl_io *io)
11052 return(ctl_target_reset(ctl_softc, io, CTL_UA_BUS_RESET));
11056 ctl_target_reset(struct ctl_softc *ctl_softc, union ctl_io *io,
11057 ctl_ua_type ua_type)
11059 struct ctl_lun *lun;
11062 if (!(io->io_hdr.flags & CTL_FLAG_FROM_OTHER_SC)) {
11063 union ctl_ha_msg msg_info;
11065 io->io_hdr.flags |= CTL_FLAG_SENT_2OTHER_SC;
11066 msg_info.hdr.nexus = io->io_hdr.nexus;
11067 if (ua_type==CTL_UA_TARG_RESET)
11068 msg_info.task.task_action = CTL_TASK_TARGET_RESET;
11070 msg_info.task.task_action = CTL_TASK_BUS_RESET;
11071 msg_info.hdr.msg_type = CTL_MSG_MANAGE_TASKS;
11072 msg_info.hdr.original_sc = NULL;
11073 msg_info.hdr.serializing_sc = NULL;
11074 if (CTL_HA_STATUS_SUCCESS != ctl_ha_msg_send(CTL_HA_CHAN_CTL,
11075 (void *)&msg_info, sizeof(msg_info), 0)) {
11080 STAILQ_FOREACH(lun, &ctl_softc->lun_list, links)
11081 retval += ctl_lun_reset(lun, io, ua_type);
11087 * The LUN should always be set. The I/O is optional, and is used to
11088 * distinguish between I/Os sent by this initiator, and by other
11089 * initiators. We set unit attention for initiators other than this one.
11090 * SAM-3 is vague on this point. It does say that a unit attention should
11091 * be established for other initiators when a LUN is reset (see section
11092 * 5.7.3), but it doesn't specifically say that the unit attention should
11093 * be established for this particular initiator when a LUN is reset. Here
11094 * is the relevant text, from SAM-3 rev 8:
11096 * 5.7.2 When a SCSI initiator port aborts its own tasks
11098 * When a SCSI initiator port causes its own task(s) to be aborted, no
11099 * notification that the task(s) have been aborted shall be returned to
11100 * the SCSI initiator port other than the completion response for the
11101 * command or task management function action that caused the task(s) to
11102 * be aborted and notification(s) associated with related effects of the
11103 * action (e.g., a reset unit attention condition).
11105 * XXX KDM for now, we're setting unit attention for all initiators.
11108 ctl_lun_reset(struct ctl_lun *lun, union ctl_io *io, ctl_ua_type ua_type)
11112 uint32_t initindex;
11117 * Run through the OOA queue and abort each I/O.
11120 TAILQ_FOREACH((struct ctl_io_hdr *)xio, &lun->ooa_queue, ooa_links) {
11122 for (xio = (union ctl_io *)TAILQ_FIRST(&lun->ooa_queue); xio != NULL;
11123 xio = (union ctl_io *)TAILQ_NEXT(&xio->io_hdr, ooa_links)) {
11124 xio->io_hdr.flags |= CTL_FLAG_ABORT;
11128 * This version sets unit attention for every
11131 initindex = ctl_get_initindex(&io->io_hdr.nexus);
11132 for (i = 0; i < CTL_MAX_INITIATORS; i++) {
11133 if (initindex == i)
11135 lun->pending_sense[i].ua_pending |= ua_type;
11140 * A reset (any kind, really) clears reservations established with
11141 * RESERVE/RELEASE. It does not clear reservations established
11142 * with PERSISTENT RESERVE OUT, but we don't support that at the
11143 * moment anyway. See SPC-2, section 5.6. SPC-3 doesn't address
11144 * reservations made with the RESERVE/RELEASE commands, because
11145 * those commands are obsolete in SPC-3.
11147 lun->flags &= ~CTL_LUN_RESERVED;
11149 for (i = 0; i < CTL_MAX_INITIATORS; i++) {
11150 ctl_clear_mask(lun->have_ca, i);
11151 lun->pending_sense[i].ua_pending |= ua_type;
11158 ctl_abort_task(union ctl_io *io)
11161 struct ctl_lun *lun;
11162 struct ctl_softc *ctl_softc;
11165 char printbuf[128];
11170 ctl_softc = control_softc;
11176 targ_lun = io->io_hdr.nexus.targ_lun;
11177 if (io->io_hdr.nexus.lun_map_fn != NULL)
11178 targ_lun = io->io_hdr.nexus.lun_map_fn(io->io_hdr.nexus.lun_map_arg, targ_lun);
11179 if ((targ_lun < CTL_MAX_LUNS)
11180 && (ctl_softc->ctl_luns[targ_lun] != NULL))
11181 lun = ctl_softc->ctl_luns[targ_lun];
11186 printf("ctl_abort_task: called for lun %lld, tag %d type %d\n",
11187 lun->lun, io->taskio.tag_num, io->taskio.tag_type);
11191 * Run through the OOA queue and attempt to find the given I/O.
11192 * The target port, initiator ID, tag type and tag number have to
11193 * match the values that we got from the initiator. If we have an
11194 * untagged command to abort, simply abort the first untagged command
11195 * we come to. We only allow one untagged command at a time of course.
11198 TAILQ_FOREACH((struct ctl_io_hdr *)xio, &lun->ooa_queue, ooa_links) {
11200 for (xio = (union ctl_io *)TAILQ_FIRST(&lun->ooa_queue); xio != NULL;
11201 xio = (union ctl_io *)TAILQ_NEXT(&xio->io_hdr, ooa_links)) {
11203 sbuf_new(&sb, printbuf, sizeof(printbuf), SBUF_FIXEDLEN);
11205 sbuf_printf(&sb, "LUN %lld tag %d type %d%s%s%s%s: ",
11206 lun->lun, xio->scsiio.tag_num,
11207 xio->scsiio.tag_type,
11208 (xio->io_hdr.blocked_links.tqe_prev
11209 == NULL) ? "" : " BLOCKED",
11210 (xio->io_hdr.flags &
11211 CTL_FLAG_DMA_INPROG) ? " DMA" : "",
11212 (xio->io_hdr.flags &
11213 CTL_FLAG_ABORT) ? " ABORT" : "",
11214 (xio->io_hdr.flags &
11215 CTL_FLAG_IS_WAS_ON_RTR ? " RTR" : ""));
11216 ctl_scsi_command_string(&xio->scsiio, NULL, &sb);
11218 printf("%s\n", sbuf_data(&sb));
11221 if ((xio->io_hdr.nexus.targ_port == io->io_hdr.nexus.targ_port)
11222 && (xio->io_hdr.nexus.initid.id ==
11223 io->io_hdr.nexus.initid.id)) {
11225 * If the abort says that the task is untagged, the
11226 * task in the queue must be untagged. Otherwise,
11227 * we just check to see whether the tag numbers
11228 * match. This is because the QLogic firmware
11229 * doesn't pass back the tag type in an abort
11233 if (((xio->scsiio.tag_type == CTL_TAG_UNTAGGED)
11234 && (io->taskio.tag_type == CTL_TAG_UNTAGGED))
11235 || (xio->scsiio.tag_num == io->taskio.tag_num)) {
11238 * XXX KDM we've got problems with FC, because it
11239 * doesn't send down a tag type with aborts. So we
11240 * can only really go by the tag number...
11241 * This may cause problems with parallel SCSI.
11242 * Need to figure that out!!
11244 if (xio->scsiio.tag_num == io->taskio.tag_num) {
11245 xio->io_hdr.flags |= CTL_FLAG_ABORT;
11247 if ((io->io_hdr.flags &
11248 CTL_FLAG_FROM_OTHER_SC) == 0 &&
11249 !(lun->flags & CTL_LUN_PRIMARY_SC)) {
11250 union ctl_ha_msg msg_info;
11252 io->io_hdr.flags |=
11253 CTL_FLAG_SENT_2OTHER_SC;
11254 msg_info.hdr.nexus = io->io_hdr.nexus;
11255 msg_info.task.task_action =
11256 CTL_TASK_ABORT_TASK;
11257 msg_info.task.tag_num =
11258 io->taskio.tag_num;
11259 msg_info.task.tag_type =
11260 io->taskio.tag_type;
11261 msg_info.hdr.msg_type =
11262 CTL_MSG_MANAGE_TASKS;
11263 msg_info.hdr.original_sc = NULL;
11264 msg_info.hdr.serializing_sc = NULL;
11266 printf("Sent Abort to other side\n");
11268 if (CTL_HA_STATUS_SUCCESS !=
11269 ctl_ha_msg_send(CTL_HA_CHAN_CTL,
11271 sizeof(msg_info), 0)) {
11275 printf("ctl_abort_task: found I/O to abort\n");
11286 * This isn't really an error. It's entirely possible for
11287 * the abort and command completion to cross on the wire.
11288 * This is more of an informative/diagnostic error.
11291 printf("ctl_abort_task: ABORT sent for nonexistent I/O: "
11292 "%d:%d:%d:%d tag %d type %d\n",
11293 io->io_hdr.nexus.initid.id,
11294 io->io_hdr.nexus.targ_port,
11295 io->io_hdr.nexus.targ_target.id,
11296 io->io_hdr.nexus.targ_lun, io->taskio.tag_num,
11297 io->taskio.tag_type);
11305 * This routine cannot block! It must be callable from an interrupt
11306 * handler as well as from the work thread.
11309 ctl_run_task_queue(struct ctl_softc *ctl_softc)
11311 union ctl_io *io, *next_io;
11313 mtx_assert(&ctl_softc->ctl_lock, MA_OWNED);
11315 CTL_DEBUG_PRINT(("ctl_run_task_queue\n"));
11317 for (io = (union ctl_io *)STAILQ_FIRST(&ctl_softc->task_queue);
11318 io != NULL; io = next_io) {
11320 const char *task_desc;
11322 next_io = (union ctl_io *)STAILQ_NEXT(&io->io_hdr, links);
11326 switch (io->io_hdr.io_type) {
11327 case CTL_IO_TASK: {
11328 task_desc = ctl_scsi_task_string(&io->taskio);
11329 if (task_desc != NULL) {
11331 csevent_log(CSC_CTL | CSC_SHELF_SW |
11333 csevent_LogType_Trace,
11334 csevent_Severity_Information,
11335 csevent_AlertLevel_Green,
11336 csevent_FRU_Firmware,
11337 csevent_FRU_Unknown,
11338 "CTL: received task: %s",task_desc);
11342 csevent_log(CSC_CTL | CSC_SHELF_SW |
11344 csevent_LogType_Trace,
11345 csevent_Severity_Information,
11346 csevent_AlertLevel_Green,
11347 csevent_FRU_Firmware,
11348 csevent_FRU_Unknown,
11349 "CTL: received unknown task "
11351 io->taskio.task_action,
11352 io->taskio.task_action);
11355 switch (io->taskio.task_action) {
11356 case CTL_TASK_ABORT_TASK:
11357 retval = ctl_abort_task(io);
11359 case CTL_TASK_ABORT_TASK_SET:
11361 case CTL_TASK_CLEAR_ACA:
11363 case CTL_TASK_CLEAR_TASK_SET:
11365 case CTL_TASK_LUN_RESET: {
11366 struct ctl_lun *lun;
11370 targ_lun = io->io_hdr.nexus.targ_lun;
11371 if (io->io_hdr.nexus.lun_map_fn != NULL)
11372 targ_lun = io->io_hdr.nexus.lun_map_fn(io->io_hdr.nexus.lun_map_arg, targ_lun);
11374 if ((targ_lun < CTL_MAX_LUNS)
11375 && (ctl_softc->ctl_luns[targ_lun] != NULL))
11376 lun = ctl_softc->ctl_luns[targ_lun];
11382 if (!(io->io_hdr.flags &
11383 CTL_FLAG_FROM_OTHER_SC)) {
11384 union ctl_ha_msg msg_info;
11386 io->io_hdr.flags |=
11387 CTL_FLAG_SENT_2OTHER_SC;
11388 msg_info.hdr.msg_type =
11389 CTL_MSG_MANAGE_TASKS;
11390 msg_info.hdr.nexus = io->io_hdr.nexus;
11391 msg_info.task.task_action =
11392 CTL_TASK_LUN_RESET;
11393 msg_info.hdr.original_sc = NULL;
11394 msg_info.hdr.serializing_sc = NULL;
11395 if (CTL_HA_STATUS_SUCCESS !=
11396 ctl_ha_msg_send(CTL_HA_CHAN_CTL,
11398 sizeof(msg_info), 0)) {
11402 retval = ctl_lun_reset(lun, io,
11406 case CTL_TASK_TARGET_RESET:
11407 retval = ctl_target_reset(ctl_softc, io,
11408 CTL_UA_TARG_RESET);
11410 case CTL_TASK_BUS_RESET:
11411 retval = ctl_bus_reset(ctl_softc, io);
11413 case CTL_TASK_PORT_LOGIN:
11415 case CTL_TASK_PORT_LOGOUT:
11418 printf("ctl_run_task_queue: got unknown task "
11419 "management event %d\n",
11420 io->taskio.task_action);
11424 io->io_hdr.status = CTL_SUCCESS;
11426 io->io_hdr.status = CTL_ERROR;
11428 STAILQ_REMOVE(&ctl_softc->task_queue, &io->io_hdr,
11429 ctl_io_hdr, links);
11431 * This will queue this I/O to the done queue, but the
11432 * work thread won't be able to process it until we
11433 * return and the lock is released.
11435 ctl_done_lock(io, /*have_lock*/ 1);
11440 printf("%s: invalid I/O type %d msg %d cdb %x"
11441 " iptl: %ju:%d:%ju:%d tag 0x%04x\n",
11442 __func__, io->io_hdr.io_type,
11443 io->io_hdr.msg_type, io->scsiio.cdb[0],
11444 (uintmax_t)io->io_hdr.nexus.initid.id,
11445 io->io_hdr.nexus.targ_port,
11446 (uintmax_t)io->io_hdr.nexus.targ_target.id,
11447 io->io_hdr.nexus.targ_lun /* XXX */,
11448 (io->io_hdr.io_type == CTL_IO_TASK) ?
11449 io->taskio.tag_num : io->scsiio.tag_num);
11450 STAILQ_REMOVE(&ctl_softc->task_queue, &io->io_hdr,
11451 ctl_io_hdr, links);
11458 ctl_softc->flags &= ~CTL_FLAG_TASK_PENDING;
11462 * For HA operation. Handle commands that come in from the other
11466 ctl_handle_isc(union ctl_io *io)
11469 struct ctl_lun *lun;
11470 struct ctl_softc *ctl_softc;
11473 ctl_softc = control_softc;
11475 targ_lun = io->io_hdr.nexus.targ_lun;
11476 if (io->io_hdr.nexus.lun_map_fn != NULL)
11477 targ_lun = io->io_hdr.nexus.lun_map_fn(io->io_hdr.nexus.lun_map_arg, targ_lun);
11478 lun = ctl_softc->ctl_luns[targ_lun];
11480 switch (io->io_hdr.msg_type) {
11481 case CTL_MSG_SERIALIZE:
11482 free_io = ctl_serialize_other_sc_cmd(&io->scsiio,
11485 case CTL_MSG_R2R: {
11487 struct ctl_cmd_entry *entry;
11490 * This is only used in SER_ONLY mode.
11493 opcode = io->scsiio.cdb[0];
11494 entry = &ctl_cmd_table[opcode];
11495 mtx_lock(&ctl_softc->ctl_lock);
11496 if (ctl_scsiio_lun_check(ctl_softc, lun,
11497 entry, (struct ctl_scsiio *)io) != 0) {
11498 ctl_done_lock(io, /*have_lock*/ 1);
11499 mtx_unlock(&ctl_softc->ctl_lock);
11502 io->io_hdr.flags |= CTL_FLAG_IS_WAS_ON_RTR;
11503 STAILQ_INSERT_TAIL(&ctl_softc->rtr_queue,
11504 &io->io_hdr, links);
11505 mtx_unlock(&ctl_softc->ctl_lock);
11508 case CTL_MSG_FINISH_IO:
11509 if (ctl_softc->ha_mode == CTL_HA_MODE_XFER) {
11511 ctl_done_lock(io, /*have_lock*/ 0);
11514 mtx_lock(&ctl_softc->ctl_lock);
11515 TAILQ_REMOVE(&lun->ooa_queue, &io->io_hdr,
11517 STAILQ_REMOVE(&ctl_softc->task_queue,
11518 &io->io_hdr, ctl_io_hdr, links);
11519 ctl_check_blocked(lun);
11520 mtx_unlock(&ctl_softc->ctl_lock);
11523 case CTL_MSG_PERS_ACTION:
11524 ctl_hndl_per_res_out_on_other_sc(
11525 (union ctl_ha_msg *)&io->presio.pr_msg);
11528 case CTL_MSG_BAD_JUJU:
11530 ctl_done_lock(io, /*have_lock*/ 0);
11532 case CTL_MSG_DATAMOVE:
11533 /* Only used in XFER mode */
11535 ctl_datamove_remote(io);
11537 case CTL_MSG_DATAMOVE_DONE:
11538 /* Only used in XFER mode */
11540 io->scsiio.be_move_done(io);
11544 printf("%s: Invalid message type %d\n",
11545 __func__, io->io_hdr.msg_type);
11555 * Returns the match type in the case of a match, or CTL_LUN_PAT_NONE if
11556 * there is no match.
11558 static ctl_lun_error_pattern
11559 ctl_cmd_pattern_match(struct ctl_scsiio *ctsio, struct ctl_error_desc *desc)
11561 struct ctl_cmd_entry *entry;
11562 ctl_lun_error_pattern filtered_pattern, pattern;
11565 pattern = desc->error_pattern;
11568 * XXX KDM we need more data passed into this function to match a
11569 * custom pattern, and we actually need to implement custom pattern
11572 if (pattern & CTL_LUN_PAT_CMD)
11573 return (CTL_LUN_PAT_CMD);
11575 if ((pattern & CTL_LUN_PAT_MASK) == CTL_LUN_PAT_ANY)
11576 return (CTL_LUN_PAT_ANY);
11578 opcode = ctsio->cdb[0];
11579 entry = &ctl_cmd_table[opcode];
11581 filtered_pattern = entry->pattern & pattern;
11584 * If the user requested specific flags in the pattern (e.g.
11585 * CTL_LUN_PAT_RANGE), make sure the command supports all of those
11588 * If the user did not specify any flags, it doesn't matter whether
11589 * or not the command supports the flags.
11591 if ((filtered_pattern & ~CTL_LUN_PAT_MASK) !=
11592 (pattern & ~CTL_LUN_PAT_MASK))
11593 return (CTL_LUN_PAT_NONE);
11596 * If the user asked for a range check, see if the requested LBA
11597 * range overlaps with this command's LBA range.
11599 if (filtered_pattern & CTL_LUN_PAT_RANGE) {
11605 retval = ctl_get_lba_len((union ctl_io *)ctsio, &lba1, &len1);
11607 return (CTL_LUN_PAT_NONE);
11609 action = ctl_extent_check_lba(lba1, len1, desc->lba_range.lba,
11610 desc->lba_range.len);
11612 * A "pass" means that the LBA ranges don't overlap, so
11613 * this doesn't match the user's range criteria.
11615 if (action == CTL_ACTION_PASS)
11616 return (CTL_LUN_PAT_NONE);
11619 return (filtered_pattern);
11623 ctl_inject_error(struct ctl_lun *lun, union ctl_io *io)
11625 struct ctl_error_desc *desc, *desc2;
11627 mtx_assert(&control_softc->ctl_lock, MA_OWNED);
11629 STAILQ_FOREACH_SAFE(desc, &lun->error_list, links, desc2) {
11630 ctl_lun_error_pattern pattern;
11632 * Check to see whether this particular command matches
11633 * the pattern in the descriptor.
11635 pattern = ctl_cmd_pattern_match(&io->scsiio, desc);
11636 if ((pattern & CTL_LUN_PAT_MASK) == CTL_LUN_PAT_NONE)
11639 switch (desc->lun_error & CTL_LUN_INJ_TYPE) {
11640 case CTL_LUN_INJ_ABORTED:
11641 ctl_set_aborted(&io->scsiio);
11643 case CTL_LUN_INJ_MEDIUM_ERR:
11644 ctl_set_medium_error(&io->scsiio);
11646 case CTL_LUN_INJ_UA:
11647 /* 29h/00h POWER ON, RESET, OR BUS DEVICE RESET
11649 ctl_set_ua(&io->scsiio, 0x29, 0x00);
11651 case CTL_LUN_INJ_CUSTOM:
11653 * We're assuming the user knows what he is doing.
11654 * Just copy the sense information without doing
11657 bcopy(&desc->custom_sense, &io->scsiio.sense_data,
11658 ctl_min(sizeof(desc->custom_sense),
11659 sizeof(io->scsiio.sense_data)));
11660 io->scsiio.scsi_status = SCSI_STATUS_CHECK_COND;
11661 io->scsiio.sense_len = SSD_FULL_SIZE;
11662 io->io_hdr.status = CTL_SCSI_ERROR | CTL_AUTOSENSE;
11664 case CTL_LUN_INJ_NONE:
11667 * If this is an error injection type we don't know
11668 * about, clear the continuous flag (if it is set)
11669 * so it will get deleted below.
11671 desc->lun_error &= ~CTL_LUN_INJ_CONTINUOUS;
11675 * By default, each error injection action is a one-shot
11677 if (desc->lun_error & CTL_LUN_INJ_CONTINUOUS)
11680 STAILQ_REMOVE(&lun->error_list, desc, ctl_error_desc, links);
11686 #ifdef CTL_IO_DELAY
11688 ctl_datamove_timer_wakeup(void *arg)
11692 io = (union ctl_io *)arg;
11696 #endif /* CTL_IO_DELAY */
11699 ctl_datamove(union ctl_io *io)
11701 void (*fe_datamove)(union ctl_io *io);
11703 mtx_assert(&control_softc->ctl_lock, MA_NOTOWNED);
11705 CTL_DEBUG_PRINT(("ctl_datamove\n"));
11708 if ((time_uptime - io->io_hdr.start_time) > ctl_time_io_secs) {
11713 ctl_scsi_path_string(io, path_str, sizeof(path_str));
11714 sbuf_new(&sb, str, sizeof(str), SBUF_FIXEDLEN);
11716 sbuf_cat(&sb, path_str);
11717 switch (io->io_hdr.io_type) {
11719 ctl_scsi_command_string(&io->scsiio, NULL, &sb);
11720 sbuf_printf(&sb, "\n");
11721 sbuf_cat(&sb, path_str);
11722 sbuf_printf(&sb, "Tag: 0x%04x, type %d\n",
11723 io->scsiio.tag_num, io->scsiio.tag_type);
11726 sbuf_printf(&sb, "Task I/O type: %d, Tag: 0x%04x, "
11727 "Tag Type: %d\n", io->taskio.task_action,
11728 io->taskio.tag_num, io->taskio.tag_type);
11731 printf("Invalid CTL I/O type %d\n", io->io_hdr.io_type);
11732 panic("Invalid CTL I/O type %d\n", io->io_hdr.io_type);
11735 sbuf_cat(&sb, path_str);
11736 sbuf_printf(&sb, "ctl_datamove: %jd seconds\n",
11737 (intmax_t)time_uptime - io->io_hdr.start_time);
11739 printf("%s", sbuf_data(&sb));
11741 #endif /* CTL_TIME_IO */
11743 mtx_lock(&control_softc->ctl_lock);
11744 #ifdef CTL_IO_DELAY
11745 if (io->io_hdr.flags & CTL_FLAG_DELAY_DONE) {
11746 struct ctl_lun *lun;
11748 lun =(struct ctl_lun *)io->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
11750 io->io_hdr.flags &= ~CTL_FLAG_DELAY_DONE;
11752 struct ctl_lun *lun;
11754 lun =(struct ctl_lun *)io->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
11756 && (lun->delay_info.datamove_delay > 0)) {
11757 struct callout *callout;
11759 callout = (struct callout *)&io->io_hdr.timer_bytes;
11760 callout_init(callout, /*mpsafe*/ 1);
11761 io->io_hdr.flags |= CTL_FLAG_DELAY_DONE;
11762 callout_reset(callout,
11763 lun->delay_info.datamove_delay * hz,
11764 ctl_datamove_timer_wakeup, io);
11765 if (lun->delay_info.datamove_type ==
11766 CTL_DELAY_TYPE_ONESHOT)
11767 lun->delay_info.datamove_delay = 0;
11768 mtx_unlock(&control_softc->ctl_lock);
11774 * If we have any pending task management commands, process them
11775 * first. This is necessary to eliminate a race condition with the
11778 * - FETD submits a task management command, like an abort.
11779 * - Back end calls fe_datamove() to move the data for the aborted
11780 * command. The FETD can't really accept it, but if it did, it
11781 * would end up transmitting data for a command that the initiator
11782 * told us to abort.
11784 * We close the race by processing all pending task management
11785 * commands here (we can't block!), and then check this I/O to see
11786 * if it has been aborted. If so, return it to the back end with
11787 * bad status, so the back end can say return an error to the back end
11788 * and then when the back end returns an error, we can return the
11789 * aborted command to the FETD, so it can clean up its resources.
11791 if (control_softc->flags & CTL_FLAG_TASK_PENDING)
11792 ctl_run_task_queue(control_softc);
11795 * This command has been aborted. Set the port status, so we fail
11798 if (io->io_hdr.flags & CTL_FLAG_ABORT) {
11799 printf("ctl_datamove: tag 0x%04x on (%ju:%d:%ju:%d) aborted\n",
11800 io->scsiio.tag_num,(uintmax_t)io->io_hdr.nexus.initid.id,
11801 io->io_hdr.nexus.targ_port,
11802 (uintmax_t)io->io_hdr.nexus.targ_target.id,
11803 io->io_hdr.nexus.targ_lun);
11804 io->io_hdr.status = CTL_CMD_ABORTED;
11805 io->io_hdr.port_status = 31337;
11806 mtx_unlock(&control_softc->ctl_lock);
11808 * Note that the backend, in this case, will get the
11809 * callback in its context. In other cases it may get
11810 * called in the frontend's interrupt thread context.
11812 io->scsiio.be_move_done(io);
11817 * If we're in XFER mode and this I/O is from the other shelf
11818 * controller, we need to send the DMA to the other side to
11819 * actually transfer the data to/from the host. In serialize only
11820 * mode the transfer happens below CTL and ctl_datamove() is only
11821 * called on the machine that originally received the I/O.
11823 if ((control_softc->ha_mode == CTL_HA_MODE_XFER)
11824 && (io->io_hdr.flags & CTL_FLAG_FROM_OTHER_SC)) {
11825 union ctl_ha_msg msg;
11826 uint32_t sg_entries_sent;
11830 memset(&msg, 0, sizeof(msg));
11831 msg.hdr.msg_type = CTL_MSG_DATAMOVE;
11832 msg.hdr.original_sc = io->io_hdr.original_sc;
11833 msg.hdr.serializing_sc = io;
11834 msg.hdr.nexus = io->io_hdr.nexus;
11835 msg.dt.flags = io->io_hdr.flags;
11837 * We convert everything into a S/G list here. We can't
11838 * pass by reference, only by value between controllers.
11839 * So we can't pass a pointer to the S/G list, only as many
11840 * S/G entries as we can fit in here. If it's possible for
11841 * us to get more than CTL_HA_MAX_SG_ENTRIES S/G entries,
11842 * then we need to break this up into multiple transfers.
11844 if (io->scsiio.kern_sg_entries == 0) {
11845 msg.dt.kern_sg_entries = 1;
11847 * If this is in cached memory, flush the cache
11848 * before we send the DMA request to the other
11849 * controller. We want to do this in either the
11850 * read or the write case. The read case is
11851 * straightforward. In the write case, we want to
11852 * make sure nothing is in the local cache that
11853 * could overwrite the DMAed data.
11855 if ((io->io_hdr.flags & CTL_FLAG_NO_DATASYNC) == 0) {
11857 * XXX KDM use bus_dmamap_sync() here.
11862 * Convert to a physical address if this is a
11865 if (io->io_hdr.flags & CTL_FLAG_BUS_ADDR) {
11866 msg.dt.sg_list[0].addr =
11867 io->scsiio.kern_data_ptr;
11870 * XXX KDM use busdma here!
11873 msg.dt.sg_list[0].addr = (void *)
11874 vtophys(io->scsiio.kern_data_ptr);
11878 msg.dt.sg_list[0].len = io->scsiio.kern_data_len;
11881 struct ctl_sg_entry *sgl;
11884 msg.dt.kern_sg_entries = io->scsiio.kern_sg_entries;
11885 sgl = (struct ctl_sg_entry *)io->scsiio.kern_data_ptr;
11886 if ((io->io_hdr.flags & CTL_FLAG_NO_DATASYNC) == 0) {
11888 * XXX KDM use bus_dmamap_sync() here.
11893 msg.dt.kern_data_len = io->scsiio.kern_data_len;
11894 msg.dt.kern_total_len = io->scsiio.kern_total_len;
11895 msg.dt.kern_data_resid = io->scsiio.kern_data_resid;
11896 msg.dt.kern_rel_offset = io->scsiio.kern_rel_offset;
11897 msg.dt.sg_sequence = 0;
11900 * Loop until we've sent all of the S/G entries. On the
11901 * other end, we'll recompose these S/G entries into one
11902 * contiguous list before passing it to the
11904 for (sg_entries_sent = 0; sg_entries_sent <
11905 msg.dt.kern_sg_entries; msg.dt.sg_sequence++) {
11906 msg.dt.cur_sg_entries = ctl_min((sizeof(msg.dt.sg_list)/
11907 sizeof(msg.dt.sg_list[0])),
11908 msg.dt.kern_sg_entries - sg_entries_sent);
11910 if (do_sg_copy != 0) {
11911 struct ctl_sg_entry *sgl;
11914 sgl = (struct ctl_sg_entry *)
11915 io->scsiio.kern_data_ptr;
11917 * If this is in cached memory, flush the cache
11918 * before we send the DMA request to the other
11919 * controller. We want to do this in either
11920 * the * read or the write case. The read
11921 * case is straightforward. In the write
11922 * case, we want to make sure nothing is
11923 * in the local cache that could overwrite
11927 for (i = sg_entries_sent, j = 0;
11928 i < msg.dt.cur_sg_entries; i++, j++) {
11929 if ((io->io_hdr.flags &
11930 CTL_FLAG_NO_DATASYNC) == 0) {
11932 * XXX KDM use bus_dmamap_sync()
11935 if ((io->io_hdr.flags &
11936 CTL_FLAG_BUS_ADDR) == 0) {
11938 * XXX KDM use busdma.
11941 msg.dt.sg_list[j].addr =(void *)
11942 vtophys(sgl[i].addr);
11945 msg.dt.sg_list[j].addr =
11948 msg.dt.sg_list[j].len = sgl[i].len;
11952 sg_entries_sent += msg.dt.cur_sg_entries;
11953 if (sg_entries_sent >= msg.dt.kern_sg_entries)
11954 msg.dt.sg_last = 1;
11956 msg.dt.sg_last = 0;
11959 * XXX KDM drop and reacquire the lock here?
11961 if (ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg,
11962 sizeof(msg), 0) > CTL_HA_STATUS_SUCCESS) {
11964 * XXX do something here.
11968 msg.dt.sent_sg_entries = sg_entries_sent;
11970 io->io_hdr.flags &= ~CTL_FLAG_IO_ACTIVE;
11971 if (io->io_hdr.flags & CTL_FLAG_FAILOVER)
11972 ctl_failover_io(io, /*have_lock*/ 1);
11977 * Lookup the fe_datamove() function for this particular
11981 control_softc->ctl_ports[ctl_port_idx(io->io_hdr.nexus.targ_port)]->fe_datamove;
11982 mtx_unlock(&control_softc->ctl_lock);
11989 ctl_send_datamove_done(union ctl_io *io, int have_lock)
11991 union ctl_ha_msg msg;
11994 memset(&msg, 0, sizeof(msg));
11996 msg.hdr.msg_type = CTL_MSG_DATAMOVE_DONE;
11997 msg.hdr.original_sc = io;
11998 msg.hdr.serializing_sc = io->io_hdr.serializing_sc;
11999 msg.hdr.nexus = io->io_hdr.nexus;
12000 msg.hdr.status = io->io_hdr.status;
12001 msg.scsi.tag_num = io->scsiio.tag_num;
12002 msg.scsi.tag_type = io->scsiio.tag_type;
12003 msg.scsi.scsi_status = io->scsiio.scsi_status;
12004 memcpy(&msg.scsi.sense_data, &io->scsiio.sense_data,
12005 sizeof(io->scsiio.sense_data));
12006 msg.scsi.sense_len = io->scsiio.sense_len;
12007 msg.scsi.sense_residual = io->scsiio.sense_residual;
12008 msg.scsi.fetd_status = io->io_hdr.port_status;
12009 msg.scsi.residual = io->scsiio.residual;
12010 io->io_hdr.flags &= ~CTL_FLAG_IO_ACTIVE;
12012 if (io->io_hdr.flags & CTL_FLAG_FAILOVER) {
12013 ctl_failover_io(io, /*have_lock*/ have_lock);
12017 isc_status = ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg, sizeof(msg), 0);
12018 if (isc_status > CTL_HA_STATUS_SUCCESS) {
12019 /* XXX do something if this fails */
12025 * The DMA to the remote side is done, now we need to tell the other side
12026 * we're done so it can continue with its data movement.
12029 ctl_datamove_remote_write_cb(struct ctl_ha_dt_req *rq)
12035 if (rq->ret != CTL_HA_STATUS_SUCCESS) {
12036 printf("%s: ISC DMA write failed with error %d", __func__,
12038 ctl_set_internal_failure(&io->scsiio,
12040 /*retry_count*/ rq->ret);
12043 ctl_dt_req_free(rq);
12046 * In this case, we had to malloc the memory locally. Free it.
12048 if ((io->io_hdr.flags & CTL_FLAG_AUTO_MIRROR) == 0) {
12050 for (i = 0; i < io->scsiio.kern_sg_entries; i++)
12051 free(io->io_hdr.local_sglist[i].addr, M_CTL);
12054 * The data is in local and remote memory, so now we need to send
12055 * status (good or back) back to the other side.
12057 ctl_send_datamove_done(io, /*have_lock*/ 0);
12061 * We've moved the data from the host/controller into local memory. Now we
12062 * need to push it over to the remote controller's memory.
12065 ctl_datamove_remote_dm_write_cb(union ctl_io *io)
12071 retval = ctl_datamove_remote_xfer(io, CTL_HA_DT_CMD_WRITE,
12072 ctl_datamove_remote_write_cb);
12078 ctl_datamove_remote_write(union ctl_io *io)
12081 void (*fe_datamove)(union ctl_io *io);
12084 * - Get the data from the host/HBA into local memory.
12085 * - DMA memory from the local controller to the remote controller.
12086 * - Send status back to the remote controller.
12089 retval = ctl_datamove_remote_sgl_setup(io);
12093 /* Switch the pointer over so the FETD knows what to do */
12094 io->scsiio.kern_data_ptr = (uint8_t *)io->io_hdr.local_sglist;
12097 * Use a custom move done callback, since we need to send completion
12098 * back to the other controller, not to the backend on this side.
12100 io->scsiio.be_move_done = ctl_datamove_remote_dm_write_cb;
12102 fe_datamove = control_softc->ctl_ports[ctl_port_idx(io->io_hdr.nexus.targ_port)]->fe_datamove;
12111 ctl_datamove_remote_dm_read_cb(union ctl_io *io)
12120 * In this case, we had to malloc the memory locally. Free it.
12122 if ((io->io_hdr.flags & CTL_FLAG_AUTO_MIRROR) == 0) {
12124 for (i = 0; i < io->scsiio.kern_sg_entries; i++)
12125 free(io->io_hdr.local_sglist[i].addr, M_CTL);
12129 scsi_path_string(io, path_str, sizeof(path_str));
12130 sbuf_new(&sb, str, sizeof(str), SBUF_FIXEDLEN);
12131 sbuf_cat(&sb, path_str);
12132 scsi_command_string(&io->scsiio, NULL, &sb);
12133 sbuf_printf(&sb, "\n");
12134 sbuf_cat(&sb, path_str);
12135 sbuf_printf(&sb, "Tag: 0x%04x, type %d\n",
12136 io->scsiio.tag_num, io->scsiio.tag_type);
12137 sbuf_cat(&sb, path_str);
12138 sbuf_printf(&sb, "%s: flags %#x, status %#x\n", __func__,
12139 io->io_hdr.flags, io->io_hdr.status);
12141 printk("%s", sbuf_data(&sb));
12146 * The read is done, now we need to send status (good or bad) back
12147 * to the other side.
12149 ctl_send_datamove_done(io, /*have_lock*/ 0);
12155 ctl_datamove_remote_read_cb(struct ctl_ha_dt_req *rq)
12158 void (*fe_datamove)(union ctl_io *io);
12162 if (rq->ret != CTL_HA_STATUS_SUCCESS) {
12163 printf("%s: ISC DMA read failed with error %d", __func__,
12165 ctl_set_internal_failure(&io->scsiio,
12167 /*retry_count*/ rq->ret);
12170 ctl_dt_req_free(rq);
12172 /* Switch the pointer over so the FETD knows what to do */
12173 io->scsiio.kern_data_ptr = (uint8_t *)io->io_hdr.local_sglist;
12176 * Use a custom move done callback, since we need to send completion
12177 * back to the other controller, not to the backend on this side.
12179 io->scsiio.be_move_done = ctl_datamove_remote_dm_read_cb;
12181 /* XXX KDM add checks like the ones in ctl_datamove? */
12183 fe_datamove = control_softc->ctl_ports[ctl_port_idx(io->io_hdr.nexus.targ_port)]->fe_datamove;
12189 ctl_datamove_remote_sgl_setup(union ctl_io *io)
12191 struct ctl_sg_entry *local_sglist, *remote_sglist;
12192 struct ctl_sg_entry *local_dma_sglist, *remote_dma_sglist;
12193 struct ctl_softc *softc;
12198 softc = control_softc;
12200 local_sglist = io->io_hdr.local_sglist;
12201 local_dma_sglist = io->io_hdr.local_dma_sglist;
12202 remote_sglist = io->io_hdr.remote_sglist;
12203 remote_dma_sglist = io->io_hdr.remote_dma_sglist;
12205 if (io->io_hdr.flags & CTL_FLAG_AUTO_MIRROR) {
12206 for (i = 0; i < io->scsiio.kern_sg_entries; i++) {
12207 local_sglist[i].len = remote_sglist[i].len;
12210 * XXX Detect the situation where the RS-level I/O
12211 * redirector on the other side has already read the
12212 * data off of the AOR RS on this side, and
12213 * transferred it to remote (mirror) memory on the
12214 * other side. Since we already have the data in
12215 * memory here, we just need to use it.
12217 * XXX KDM this can probably be removed once we
12218 * get the cache device code in and take the
12219 * current AOR implementation out.
12222 if ((remote_sglist[i].addr >=
12223 (void *)vtophys(softc->mirr->addr))
12224 && (remote_sglist[i].addr <
12225 ((void *)vtophys(softc->mirr->addr) +
12226 CacheMirrorOffset))) {
12227 local_sglist[i].addr = remote_sglist[i].addr -
12229 if ((io->io_hdr.flags & CTL_FLAG_DATA_MASK) ==
12231 io->io_hdr.flags |= CTL_FLAG_REDIR_DONE;
12233 local_sglist[i].addr = remote_sglist[i].addr +
12238 printf("%s: local %p, remote %p, len %d\n",
12239 __func__, local_sglist[i].addr,
12240 remote_sglist[i].addr, local_sglist[i].len);
12244 uint32_t len_to_go;
12247 * In this case, we don't have automatically allocated
12248 * memory for this I/O on this controller. This typically
12249 * happens with internal CTL I/O -- e.g. inquiry, mode
12250 * sense, etc. Anything coming from RAIDCore will have
12251 * a mirror area available.
12253 len_to_go = io->scsiio.kern_data_len;
12256 * Clear the no datasync flag, we have to use malloced
12259 io->io_hdr.flags &= ~CTL_FLAG_NO_DATASYNC;
12262 * The difficult thing here is that the size of the various
12263 * S/G segments may be different than the size from the
12264 * remote controller. That'll make it harder when DMAing
12265 * the data back to the other side.
12267 for (i = 0; (i < sizeof(io->io_hdr.remote_sglist) /
12268 sizeof(io->io_hdr.remote_sglist[0])) &&
12269 (len_to_go > 0); i++) {
12270 local_sglist[i].len = ctl_min(len_to_go, 131072);
12271 CTL_SIZE_8B(local_dma_sglist[i].len,
12272 local_sglist[i].len);
12273 local_sglist[i].addr =
12274 malloc(local_dma_sglist[i].len, M_CTL,M_WAITOK);
12276 local_dma_sglist[i].addr = local_sglist[i].addr;
12278 if (local_sglist[i].addr == NULL) {
12281 printf("malloc failed for %zd bytes!",
12282 local_dma_sglist[i].len);
12283 for (j = 0; j < i; j++) {
12284 free(local_sglist[j].addr, M_CTL);
12286 ctl_set_internal_failure(&io->scsiio,
12288 /*retry_count*/ 4857);
12290 goto bailout_error;
12293 /* XXX KDM do we need a sync here? */
12295 len_to_go -= local_sglist[i].len;
12298 * Reset the number of S/G entries accordingly. The
12299 * original number of S/G entries is available in
12302 io->scsiio.kern_sg_entries = i;
12305 printf("%s: kern_sg_entries = %d\n", __func__,
12306 io->scsiio.kern_sg_entries);
12307 for (i = 0; i < io->scsiio.kern_sg_entries; i++)
12308 printf("%s: sg[%d] = %p, %d (DMA: %d)\n", __func__, i,
12309 local_sglist[i].addr, local_sglist[i].len,
12310 local_dma_sglist[i].len);
12319 ctl_send_datamove_done(io, /*have_lock*/ 0);
12325 ctl_datamove_remote_xfer(union ctl_io *io, unsigned command,
12326 ctl_ha_dt_cb callback)
12328 struct ctl_ha_dt_req *rq;
12329 struct ctl_sg_entry *remote_sglist, *local_sglist;
12330 struct ctl_sg_entry *remote_dma_sglist, *local_dma_sglist;
12331 uint32_t local_used, remote_used, total_used;
12337 rq = ctl_dt_req_alloc();
12340 * If we failed to allocate the request, and if the DMA didn't fail
12341 * anyway, set busy status. This is just a resource allocation
12345 && ((io->io_hdr.status & CTL_STATUS_MASK) != CTL_STATUS_NONE))
12346 ctl_set_busy(&io->scsiio);
12348 if ((io->io_hdr.status & CTL_STATUS_MASK) != CTL_STATUS_NONE) {
12351 ctl_dt_req_free(rq);
12354 * The data move failed. We need to return status back
12355 * to the other controller. No point in trying to DMA
12356 * data to the remote controller.
12359 ctl_send_datamove_done(io, /*have_lock*/ 0);
12366 local_sglist = io->io_hdr.local_sglist;
12367 local_dma_sglist = io->io_hdr.local_dma_sglist;
12368 remote_sglist = io->io_hdr.remote_sglist;
12369 remote_dma_sglist = io->io_hdr.remote_dma_sglist;
12374 if (io->io_hdr.flags & CTL_FLAG_REDIR_DONE) {
12375 rq->ret = CTL_HA_STATUS_SUCCESS;
12382 * Pull/push the data over the wire from/to the other controller.
12383 * This takes into account the possibility that the local and
12384 * remote sglists may not be identical in terms of the size of
12385 * the elements and the number of elements.
12387 * One fundamental assumption here is that the length allocated for
12388 * both the local and remote sglists is identical. Otherwise, we've
12389 * essentially got a coding error of some sort.
12391 for (i = 0, j = 0; total_used < io->scsiio.kern_data_len; ) {
12393 uint32_t cur_len, dma_length;
12396 rq->id = CTL_HA_DATA_CTL;
12397 rq->command = command;
12401 * Both pointers should be aligned. But it is possible
12402 * that the allocation length is not. They should both
12403 * also have enough slack left over at the end, though,
12404 * to round up to the next 8 byte boundary.
12406 cur_len = ctl_min(local_sglist[i].len - local_used,
12407 remote_sglist[j].len - remote_used);
12410 * In this case, we have a size issue and need to decrease
12411 * the size, except in the case where we actually have less
12412 * than 8 bytes left. In that case, we need to increase
12413 * the DMA length to get the last bit.
12415 if ((cur_len & 0x7) != 0) {
12416 if (cur_len > 0x7) {
12417 cur_len = cur_len - (cur_len & 0x7);
12418 dma_length = cur_len;
12420 CTL_SIZE_8B(dma_length, cur_len);
12424 dma_length = cur_len;
12427 * If we had to allocate memory for this I/O, instead of using
12428 * the non-cached mirror memory, we'll need to flush the cache
12429 * before trying to DMA to the other controller.
12431 * We could end up doing this multiple times for the same
12432 * segment if we have a larger local segment than remote
12433 * segment. That shouldn't be an issue.
12435 if ((io->io_hdr.flags & CTL_FLAG_NO_DATASYNC) == 0) {
12437 * XXX KDM use bus_dmamap_sync() here.
12441 rq->size = dma_length;
12443 tmp_ptr = (uint8_t *)local_sglist[i].addr;
12444 tmp_ptr += local_used;
12446 /* Use physical addresses when talking to ISC hardware */
12447 if ((io->io_hdr.flags & CTL_FLAG_BUS_ADDR) == 0) {
12448 /* XXX KDM use busdma */
12450 rq->local = vtophys(tmp_ptr);
12453 rq->local = tmp_ptr;
12455 tmp_ptr = (uint8_t *)remote_sglist[j].addr;
12456 tmp_ptr += remote_used;
12457 rq->remote = tmp_ptr;
12459 rq->callback = NULL;
12461 local_used += cur_len;
12462 if (local_used >= local_sglist[i].len) {
12467 remote_used += cur_len;
12468 if (remote_used >= remote_sglist[j].len) {
12472 total_used += cur_len;
12474 if (total_used >= io->scsiio.kern_data_len)
12475 rq->callback = callback;
12477 if ((rq->size & 0x7) != 0) {
12478 printf("%s: warning: size %d is not on 8b boundary\n",
12479 __func__, rq->size);
12481 if (((uintptr_t)rq->local & 0x7) != 0) {
12482 printf("%s: warning: local %p not on 8b boundary\n",
12483 __func__, rq->local);
12485 if (((uintptr_t)rq->remote & 0x7) != 0) {
12486 printf("%s: warning: remote %p not on 8b boundary\n",
12487 __func__, rq->local);
12490 printf("%s: %s: local %#x remote %#x size %d\n", __func__,
12491 (command == CTL_HA_DT_CMD_WRITE) ? "WRITE" : "READ",
12492 rq->local, rq->remote, rq->size);
12495 isc_ret = ctl_dt_single(rq);
12496 if (isc_ret == CTL_HA_STATUS_WAIT)
12499 if (isc_ret == CTL_HA_STATUS_DISCONNECT) {
12500 rq->ret = CTL_HA_STATUS_SUCCESS;
12514 ctl_datamove_remote_read(union ctl_io *io)
12520 * This will send an error to the other controller in the case of a
12523 retval = ctl_datamove_remote_sgl_setup(io);
12527 retval = ctl_datamove_remote_xfer(io, CTL_HA_DT_CMD_READ,
12528 ctl_datamove_remote_read_cb);
12530 && ((io->io_hdr.flags & CTL_FLAG_AUTO_MIRROR) == 0)) {
12532 * Make sure we free memory if there was an error.. The
12533 * ctl_datamove_remote_xfer() function will send the
12534 * datamove done message, or call the callback with an
12535 * error if there is a problem.
12537 for (i = 0; i < io->scsiio.kern_sg_entries; i++)
12538 free(io->io_hdr.local_sglist[i].addr, M_CTL);
12545 * Process a datamove request from the other controller. This is used for
12546 * XFER mode only, not SER_ONLY mode. For writes, we DMA into local memory
12547 * first. Once that is complete, the data gets DMAed into the remote
12548 * controller's memory. For reads, we DMA from the remote controller's
12549 * memory into our memory first, and then move it out to the FETD.
12552 ctl_datamove_remote(union ctl_io *io)
12554 struct ctl_softc *softc;
12556 softc = control_softc;
12558 mtx_assert(&softc->ctl_lock, MA_NOTOWNED);
12561 * Note that we look for an aborted I/O here, but don't do some of
12562 * the other checks that ctl_datamove() normally does. We don't
12563 * need to run the task queue, because this I/O is on the ISC
12564 * queue, which is executed by the work thread after the task queue.
12565 * We don't need to run the datamove delay code, since that should
12566 * have been done if need be on the other controller.
12568 mtx_lock(&softc->ctl_lock);
12570 if (io->io_hdr.flags & CTL_FLAG_ABORT) {
12572 printf("%s: tag 0x%04x on (%d:%d:%d:%d) aborted\n", __func__,
12573 io->scsiio.tag_num, io->io_hdr.nexus.initid.id,
12574 io->io_hdr.nexus.targ_port,
12575 io->io_hdr.nexus.targ_target.id,
12576 io->io_hdr.nexus.targ_lun);
12577 io->io_hdr.status = CTL_CMD_ABORTED;
12578 io->io_hdr.port_status = 31338;
12580 mtx_unlock(&softc->ctl_lock);
12582 ctl_send_datamove_done(io, /*have_lock*/ 0);
12587 if ((io->io_hdr.flags & CTL_FLAG_DATA_MASK) == CTL_FLAG_DATA_OUT) {
12588 mtx_unlock(&softc->ctl_lock);
12589 ctl_datamove_remote_write(io);
12590 } else if ((io->io_hdr.flags & CTL_FLAG_DATA_MASK) == CTL_FLAG_DATA_IN){
12591 mtx_unlock(&softc->ctl_lock);
12592 ctl_datamove_remote_read(io);
12594 union ctl_ha_msg msg;
12595 struct scsi_sense_data *sense;
12599 memset(&msg, 0, sizeof(msg));
12601 msg.hdr.msg_type = CTL_MSG_BAD_JUJU;
12602 msg.hdr.status = CTL_SCSI_ERROR;
12603 msg.scsi.scsi_status = SCSI_STATUS_CHECK_COND;
12605 retry_count = 4243;
12607 sense = &msg.scsi.sense_data;
12608 sks[0] = SSD_SCS_VALID;
12609 sks[1] = (retry_count >> 8) & 0xff;
12610 sks[2] = retry_count & 0xff;
12612 /* "Internal target failure" */
12613 scsi_set_sense_data(sense,
12614 /*sense_format*/ SSD_TYPE_NONE,
12615 /*current_error*/ 1,
12616 /*sense_key*/ SSD_KEY_HARDWARE_ERROR,
12619 /*type*/ SSD_ELEM_SKS,
12620 /*size*/ sizeof(sks),
12624 io->io_hdr.flags &= ~CTL_FLAG_IO_ACTIVE;
12625 if (io->io_hdr.flags & CTL_FLAG_FAILOVER) {
12626 ctl_failover_io(io, /*have_lock*/ 1);
12627 mtx_unlock(&softc->ctl_lock);
12631 mtx_unlock(&softc->ctl_lock);
12633 if (ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg, sizeof(msg), 0) >
12634 CTL_HA_STATUS_SUCCESS) {
12635 /* XXX KDM what to do if this fails? */
12643 ctl_process_done(union ctl_io *io, int have_lock)
12645 struct ctl_lun *lun;
12646 struct ctl_softc *ctl_softc;
12647 void (*fe_done)(union ctl_io *io);
12648 uint32_t targ_port = ctl_port_idx(io->io_hdr.nexus.targ_port);
12650 CTL_DEBUG_PRINT(("ctl_process_done\n"));
12653 control_softc->ctl_ports[targ_port]->fe_done;
12656 if ((time_uptime - io->io_hdr.start_time) > ctl_time_io_secs) {
12661 ctl_scsi_path_string(io, path_str, sizeof(path_str));
12662 sbuf_new(&sb, str, sizeof(str), SBUF_FIXEDLEN);
12664 sbuf_cat(&sb, path_str);
12665 switch (io->io_hdr.io_type) {
12667 ctl_scsi_command_string(&io->scsiio, NULL, &sb);
12668 sbuf_printf(&sb, "\n");
12669 sbuf_cat(&sb, path_str);
12670 sbuf_printf(&sb, "Tag: 0x%04x, type %d\n",
12671 io->scsiio.tag_num, io->scsiio.tag_type);
12674 sbuf_printf(&sb, "Task I/O type: %d, Tag: 0x%04x, "
12675 "Tag Type: %d\n", io->taskio.task_action,
12676 io->taskio.tag_num, io->taskio.tag_type);
12679 printf("Invalid CTL I/O type %d\n", io->io_hdr.io_type);
12680 panic("Invalid CTL I/O type %d\n", io->io_hdr.io_type);
12683 sbuf_cat(&sb, path_str);
12684 sbuf_printf(&sb, "ctl_process_done: %jd seconds\n",
12685 (intmax_t)time_uptime - io->io_hdr.start_time);
12687 printf("%s", sbuf_data(&sb));
12689 #endif /* CTL_TIME_IO */
12691 switch (io->io_hdr.io_type) {
12695 if (bootverbose || verbose > 0)
12696 ctl_io_error_print(io, NULL);
12697 if (io->io_hdr.flags & CTL_FLAG_FROM_OTHER_SC)
12701 return (CTL_RETVAL_COMPLETE);
12704 printf("ctl_process_done: invalid io type %d\n",
12705 io->io_hdr.io_type);
12706 panic("ctl_process_done: invalid io type %d\n",
12707 io->io_hdr.io_type);
12708 break; /* NOTREACHED */
12711 lun = (struct ctl_lun *)io->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
12713 CTL_DEBUG_PRINT(("NULL LUN for lun %d\n",
12714 io->io_hdr.nexus.targ_lun));
12718 ctl_softc = lun->ctl_softc;
12721 * Remove this from the OOA queue.
12723 if (have_lock == 0)
12724 mtx_lock(&ctl_softc->ctl_lock);
12727 * Check to see if we have any errors to inject here. We only
12728 * inject errors for commands that don't already have errors set.
12730 if ((STAILQ_FIRST(&lun->error_list) != NULL)
12731 && ((io->io_hdr.status & CTL_STATUS_MASK) == CTL_SUCCESS))
12732 ctl_inject_error(lun, io);
12735 * XXX KDM how do we treat commands that aren't completed
12738 * XXX KDM should we also track I/O latency?
12740 if ((io->io_hdr.status & CTL_STATUS_MASK) == CTL_SUCCESS) {
12741 uint32_t blocksize;
12743 struct bintime cur_bt;
12746 if ((lun->be_lun != NULL)
12747 && (lun->be_lun->blocksize != 0))
12748 blocksize = lun->be_lun->blocksize;
12752 switch (io->io_hdr.io_type) {
12753 case CTL_IO_SCSI: {
12755 struct ctl_lba_len lbalen;
12758 switch (io->scsiio.cdb[0]) {
12769 case WRITE_VERIFY_10:
12770 case WRITE_VERIFY_12:
12771 case WRITE_VERIFY_16:
12772 memcpy(&lbalen, io->io_hdr.ctl_private[
12773 CTL_PRIV_LBA_LEN].bytes, sizeof(lbalen));
12776 lun->stats.ports[targ_port].bytes[CTL_STATS_READ] +=
12777 lbalen.len * blocksize;
12778 lun->stats.ports[targ_port].operations[CTL_STATS_READ]++;
12782 &lun->stats.ports[targ_port].dma_time[CTL_STATS_READ],
12783 &io->io_hdr.dma_bt);
12784 lun->stats.ports[targ_port].num_dmas[CTL_STATS_READ] +=
12785 io->io_hdr.num_dmas;
12786 getbintime(&cur_bt);
12787 bintime_sub(&cur_bt,
12788 &io->io_hdr.start_bt);
12791 &lun->stats.ports[targ_port].time[CTL_STATS_READ],
12795 cs_prof_gettime(&cur_ticks);
12796 lun->stats.time[CTL_STATS_READ] +=
12798 io->io_hdr.start_ticks;
12801 lun->stats.time[CTL_STATS_READ] +=
12802 jiffies - io->io_hdr.start_time;
12804 #endif /* CTL_TIME_IO */
12806 lun->stats.ports[targ_port].bytes[CTL_STATS_WRITE] +=
12807 lbalen.len * blocksize;
12808 lun->stats.ports[targ_port].operations[
12809 CTL_STATS_WRITE]++;
12813 &lun->stats.ports[targ_port].dma_time[CTL_STATS_WRITE],
12814 &io->io_hdr.dma_bt);
12815 lun->stats.ports[targ_port].num_dmas[CTL_STATS_WRITE] +=
12816 io->io_hdr.num_dmas;
12817 getbintime(&cur_bt);
12818 bintime_sub(&cur_bt,
12819 &io->io_hdr.start_bt);
12822 &lun->stats.ports[targ_port].time[CTL_STATS_WRITE],
12825 cs_prof_gettime(&cur_ticks);
12826 lun->stats.ports[targ_port].time[CTL_STATS_WRITE] +=
12828 io->io_hdr.start_ticks;
12829 lun->stats.ports[targ_port].time[CTL_STATS_WRITE] +=
12830 jiffies - io->io_hdr.start_time;
12832 #endif /* CTL_TIME_IO */
12836 lun->stats.ports[targ_port].operations[CTL_STATS_NO_IO]++;
12840 &lun->stats.ports[targ_port].dma_time[CTL_STATS_NO_IO],
12841 &io->io_hdr.dma_bt);
12842 lun->stats.ports[targ_port].num_dmas[CTL_STATS_NO_IO] +=
12843 io->io_hdr.num_dmas;
12844 getbintime(&cur_bt);
12845 bintime_sub(&cur_bt, &io->io_hdr.start_bt);
12847 bintime_add(&lun->stats.ports[targ_port].time[CTL_STATS_NO_IO],
12851 cs_prof_gettime(&cur_ticks);
12852 lun->stats.ports[targ_port].time[CTL_STATS_NO_IO] +=
12854 io->io_hdr.start_ticks;
12855 lun->stats.ports[targ_port].time[CTL_STATS_NO_IO] +=
12856 jiffies - io->io_hdr.start_time;
12858 #endif /* CTL_TIME_IO */
12868 TAILQ_REMOVE(&lun->ooa_queue, &io->io_hdr, ooa_links);
12871 * Run through the blocked queue on this LUN and see if anything
12872 * has become unblocked, now that this transaction is done.
12874 ctl_check_blocked(lun);
12877 * If the LUN has been invalidated, free it if there is nothing
12878 * left on its OOA queue.
12880 if ((lun->flags & CTL_LUN_INVALID)
12881 && (TAILQ_FIRST(&lun->ooa_queue) == NULL))
12885 * If this command has been aborted, make sure we set the status
12886 * properly. The FETD is responsible for freeing the I/O and doing
12887 * whatever it needs to do to clean up its state.
12889 if (io->io_hdr.flags & CTL_FLAG_ABORT)
12890 io->io_hdr.status = CTL_CMD_ABORTED;
12893 * We print out status for every task management command. For SCSI
12894 * commands, we filter out any unit attention errors; they happen
12895 * on every boot, and would clutter up the log. Note: task
12896 * management commands aren't printed here, they are printed above,
12897 * since they should never even make it down here.
12899 switch (io->io_hdr.io_type) {
12900 case CTL_IO_SCSI: {
12901 int error_code, sense_key, asc, ascq;
12905 if (((io->io_hdr.status & CTL_STATUS_MASK) == CTL_SCSI_ERROR)
12906 && (io->scsiio.scsi_status == SCSI_STATUS_CHECK_COND)) {
12908 * Since this is just for printing, no need to
12909 * show errors here.
12911 scsi_extract_sense_len(&io->scsiio.sense_data,
12912 io->scsiio.sense_len,
12917 /*show_errors*/ 0);
12920 if (((io->io_hdr.status & CTL_STATUS_MASK) != CTL_SUCCESS)
12921 && (((io->io_hdr.status & CTL_STATUS_MASK) != CTL_SCSI_ERROR)
12922 || (io->scsiio.scsi_status != SCSI_STATUS_CHECK_COND)
12923 || (sense_key != SSD_KEY_UNIT_ATTENTION))) {
12925 if ((time_uptime - ctl_softc->last_print_jiffies) <= 0){
12926 ctl_softc->skipped_prints++;
12927 if (have_lock == 0)
12928 mtx_unlock(&ctl_softc->ctl_lock);
12930 uint32_t skipped_prints;
12932 skipped_prints = ctl_softc->skipped_prints;
12934 ctl_softc->skipped_prints = 0;
12935 ctl_softc->last_print_jiffies = time_uptime;
12937 if (have_lock == 0)
12938 mtx_unlock(&ctl_softc->ctl_lock);
12939 if (skipped_prints > 0) {
12941 csevent_log(CSC_CTL | CSC_SHELF_SW |
12943 csevent_LogType_Trace,
12944 csevent_Severity_Information,
12945 csevent_AlertLevel_Green,
12946 csevent_FRU_Firmware,
12947 csevent_FRU_Unknown,
12948 "High CTL error volume, %d prints "
12949 "skipped", skipped_prints);
12952 if (bootverbose || verbose > 0)
12953 ctl_io_error_print(io, NULL);
12956 if (have_lock == 0)
12957 mtx_unlock(&ctl_softc->ctl_lock);
12962 if (have_lock == 0)
12963 mtx_unlock(&ctl_softc->ctl_lock);
12964 if (bootverbose || verbose > 0)
12965 ctl_io_error_print(io, NULL);
12968 if (have_lock == 0)
12969 mtx_unlock(&ctl_softc->ctl_lock);
12974 * Tell the FETD or the other shelf controller we're done with this
12975 * command. Note that only SCSI commands get to this point. Task
12976 * management commands are completed above.
12978 * We only send status to the other controller if we're in XFER
12979 * mode. In SER_ONLY mode, the I/O is done on the controller that
12980 * received the I/O (from CTL's perspective), and so the status is
12983 * XXX KDM if we hold the lock here, we could cause a deadlock
12984 * if the frontend comes back in in this context to queue
12987 if ((ctl_softc->ha_mode == CTL_HA_MODE_XFER)
12988 && (io->io_hdr.flags & CTL_FLAG_FROM_OTHER_SC)) {
12989 union ctl_ha_msg msg;
12991 memset(&msg, 0, sizeof(msg));
12992 msg.hdr.msg_type = CTL_MSG_FINISH_IO;
12993 msg.hdr.original_sc = io->io_hdr.original_sc;
12994 msg.hdr.nexus = io->io_hdr.nexus;
12995 msg.hdr.status = io->io_hdr.status;
12996 msg.scsi.scsi_status = io->scsiio.scsi_status;
12997 msg.scsi.tag_num = io->scsiio.tag_num;
12998 msg.scsi.tag_type = io->scsiio.tag_type;
12999 msg.scsi.sense_len = io->scsiio.sense_len;
13000 msg.scsi.sense_residual = io->scsiio.sense_residual;
13001 msg.scsi.residual = io->scsiio.residual;
13002 memcpy(&msg.scsi.sense_data, &io->scsiio.sense_data,
13003 sizeof(io->scsiio.sense_data));
13005 * We copy this whether or not this is an I/O-related
13006 * command. Otherwise, we'd have to go and check to see
13007 * whether it's a read/write command, and it really isn't
13010 memcpy(&msg.scsi.lbalen,
13011 &io->io_hdr.ctl_private[CTL_PRIV_LBA_LEN].bytes,
13012 sizeof(msg.scsi.lbalen));
13014 if (ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg,
13015 sizeof(msg), 0) > CTL_HA_STATUS_SUCCESS) {
13016 /* XXX do something here */
13025 return (CTL_RETVAL_COMPLETE);
13029 * Front end should call this if it doesn't do autosense. When the request
13030 * sense comes back in from the initiator, we'll dequeue this and send it.
13033 ctl_queue_sense(union ctl_io *io)
13035 struct ctl_lun *lun;
13036 struct ctl_softc *ctl_softc;
13037 uint32_t initidx, targ_lun;
13039 ctl_softc = control_softc;
13041 CTL_DEBUG_PRINT(("ctl_queue_sense\n"));
13044 * LUN lookup will likely move to the ctl_work_thread() once we
13045 * have our new queueing infrastructure (that doesn't put things on
13046 * a per-LUN queue initially). That is so that we can handle
13047 * things like an INQUIRY to a LUN that we don't have enabled. We
13048 * can't deal with that right now.
13050 mtx_lock(&ctl_softc->ctl_lock);
13053 * If we don't have a LUN for this, just toss the sense
13056 targ_lun = io->io_hdr.nexus.targ_lun;
13057 if (io->io_hdr.nexus.lun_map_fn != NULL)
13058 targ_lun = io->io_hdr.nexus.lun_map_fn(io->io_hdr.nexus.lun_map_arg, targ_lun);
13059 if ((targ_lun < CTL_MAX_LUNS)
13060 && (ctl_softc->ctl_luns[targ_lun] != NULL))
13061 lun = ctl_softc->ctl_luns[targ_lun];
13065 initidx = ctl_get_initindex(&io->io_hdr.nexus);
13068 * Already have CA set for this LUN...toss the sense information.
13070 if (ctl_is_set(lun->have_ca, initidx))
13073 memcpy(&lun->pending_sense[initidx].sense, &io->scsiio.sense_data,
13074 ctl_min(sizeof(lun->pending_sense[initidx].sense),
13075 sizeof(io->scsiio.sense_data)));
13076 ctl_set_mask(lun->have_ca, initidx);
13079 mtx_unlock(&ctl_softc->ctl_lock);
13083 return (CTL_RETVAL_COMPLETE);
13087 * Primary command inlet from frontend ports. All SCSI and task I/O
13088 * requests must go through this function.
13091 ctl_queue(union ctl_io *io)
13093 struct ctl_softc *ctl_softc;
13095 CTL_DEBUG_PRINT(("ctl_queue cdb[0]=%02X\n", io->scsiio.cdb[0]));
13097 ctl_softc = control_softc;
13100 io->io_hdr.start_time = time_uptime;
13101 getbintime(&io->io_hdr.start_bt);
13102 #endif /* CTL_TIME_IO */
13104 mtx_lock(&ctl_softc->ctl_lock);
13106 switch (io->io_hdr.io_type) {
13108 STAILQ_INSERT_TAIL(&ctl_softc->incoming_queue, &io->io_hdr,
13112 STAILQ_INSERT_TAIL(&ctl_softc->task_queue, &io->io_hdr, links);
13114 * Set the task pending flag. This is necessary to close a
13115 * race condition with the FETD:
13117 * - FETD submits a task management command, like an abort.
13118 * - Back end calls fe_datamove() to move the data for the
13119 * aborted command. The FETD can't really accept it, but
13120 * if it did, it would end up transmitting data for a
13121 * command that the initiator told us to abort.
13123 * We close the race condition by setting the flag here,
13124 * and checking it in ctl_datamove(), before calling the
13125 * FETD's fe_datamove routine. If we've got a task
13126 * pending, we run the task queue and then check to see
13127 * whether our particular I/O has been aborted.
13129 ctl_softc->flags |= CTL_FLAG_TASK_PENDING;
13132 mtx_unlock(&ctl_softc->ctl_lock);
13133 printf("ctl_queue: unknown I/O type %d\n", io->io_hdr.io_type);
13135 break; /* NOTREACHED */
13137 mtx_unlock(&ctl_softc->ctl_lock);
13139 ctl_wakeup_thread();
13141 return (CTL_RETVAL_COMPLETE);
13144 #ifdef CTL_IO_DELAY
13146 ctl_done_timer_wakeup(void *arg)
13150 io = (union ctl_io *)arg;
13151 ctl_done_lock(io, /*have_lock*/ 0);
13153 #endif /* CTL_IO_DELAY */
13156 ctl_done_lock(union ctl_io *io, int have_lock)
13158 struct ctl_softc *ctl_softc;
13159 #ifndef CTL_DONE_THREAD
13161 #endif /* !CTL_DONE_THREAD */
13163 ctl_softc = control_softc;
13165 if (have_lock == 0)
13166 mtx_lock(&ctl_softc->ctl_lock);
13169 * Enable this to catch duplicate completion issues.
13172 if (io->io_hdr.flags & CTL_FLAG_ALREADY_DONE) {
13173 printf("%s: type %d msg %d cdb %x iptl: "
13174 "%d:%d:%d:%d tag 0x%04x "
13175 "flag %#x status %x\n",
13177 io->io_hdr.io_type,
13178 io->io_hdr.msg_type,
13180 io->io_hdr.nexus.initid.id,
13181 io->io_hdr.nexus.targ_port,
13182 io->io_hdr.nexus.targ_target.id,
13183 io->io_hdr.nexus.targ_lun,
13184 (io->io_hdr.io_type ==
13186 io->taskio.tag_num :
13187 io->scsiio.tag_num,
13189 io->io_hdr.status);
13191 io->io_hdr.flags |= CTL_FLAG_ALREADY_DONE;
13195 * This is an internal copy of an I/O, and should not go through
13196 * the normal done processing logic.
13198 if (io->io_hdr.flags & CTL_FLAG_INT_COPY) {
13199 if (have_lock == 0)
13200 mtx_unlock(&ctl_softc->ctl_lock);
13205 * We need to send a msg to the serializing shelf to finish the IO
13206 * as well. We don't send a finish message to the other shelf if
13207 * this is a task management command. Task management commands
13208 * aren't serialized in the OOA queue, but rather just executed on
13209 * both shelf controllers for commands that originated on that
13212 if ((io->io_hdr.flags & CTL_FLAG_SENT_2OTHER_SC)
13213 && (io->io_hdr.io_type != CTL_IO_TASK)) {
13214 union ctl_ha_msg msg_io;
13216 msg_io.hdr.msg_type = CTL_MSG_FINISH_IO;
13217 msg_io.hdr.serializing_sc = io->io_hdr.serializing_sc;
13218 if (ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg_io,
13219 sizeof(msg_io), 0 ) != CTL_HA_STATUS_SUCCESS) {
13221 /* continue on to finish IO */
13223 #ifdef CTL_IO_DELAY
13224 if (io->io_hdr.flags & CTL_FLAG_DELAY_DONE) {
13225 struct ctl_lun *lun;
13227 lun =(struct ctl_lun *)io->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
13229 io->io_hdr.flags &= ~CTL_FLAG_DELAY_DONE;
13231 struct ctl_lun *lun;
13233 lun =(struct ctl_lun *)io->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
13236 && (lun->delay_info.done_delay > 0)) {
13237 struct callout *callout;
13239 callout = (struct callout *)&io->io_hdr.timer_bytes;
13240 callout_init(callout, /*mpsafe*/ 1);
13241 io->io_hdr.flags |= CTL_FLAG_DELAY_DONE;
13242 callout_reset(callout,
13243 lun->delay_info.done_delay * hz,
13244 ctl_done_timer_wakeup, io);
13245 if (lun->delay_info.done_type == CTL_DELAY_TYPE_ONESHOT)
13246 lun->delay_info.done_delay = 0;
13247 if (have_lock == 0)
13248 mtx_unlock(&ctl_softc->ctl_lock);
13252 #endif /* CTL_IO_DELAY */
13254 STAILQ_INSERT_TAIL(&ctl_softc->done_queue, &io->io_hdr, links);
13256 #ifdef CTL_DONE_THREAD
13257 if (have_lock == 0)
13258 mtx_unlock(&ctl_softc->ctl_lock);
13260 ctl_wakeup_thread();
13261 #else /* CTL_DONE_THREAD */
13262 for (xio = (union ctl_io *)STAILQ_FIRST(&ctl_softc->done_queue);
13264 xio =(union ctl_io *)STAILQ_FIRST(&ctl_softc->done_queue)) {
13266 STAILQ_REMOVE_HEAD(&ctl_softc->done_queue, links);
13268 ctl_process_done(xio, /*have_lock*/ 1);
13270 if (have_lock == 0)
13271 mtx_unlock(&ctl_softc->ctl_lock);
13272 #endif /* CTL_DONE_THREAD */
13276 ctl_done(union ctl_io *io)
13278 ctl_done_lock(io, /*have_lock*/ 0);
13282 ctl_isc(struct ctl_scsiio *ctsio)
13284 struct ctl_lun *lun;
13287 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
13289 CTL_DEBUG_PRINT(("ctl_isc: command: %02x\n", ctsio->cdb[0]));
13291 CTL_DEBUG_PRINT(("ctl_isc: calling data_submit()\n"));
13293 retval = lun->backend->data_submit((union ctl_io *)ctsio);
13300 ctl_work_thread(void *arg)
13302 struct ctl_softc *softc;
13304 struct ctl_be_lun *be_lun;
13307 CTL_DEBUG_PRINT(("ctl_work_thread starting\n"));
13309 softc = (struct ctl_softc *)arg;
13313 mtx_lock(&softc->ctl_lock);
13318 * We handle the queues in this order:
13319 * - task management
13321 * - done queue (to free up resources, unblock other commands)
13325 * If those queues are empty, we break out of the loop and
13328 io = (union ctl_io *)STAILQ_FIRST(&softc->task_queue);
13330 ctl_run_task_queue(softc);
13333 io = (union ctl_io *)STAILQ_FIRST(&softc->isc_queue);
13335 STAILQ_REMOVE_HEAD(&softc->isc_queue, links);
13336 ctl_handle_isc(io);
13339 io = (union ctl_io *)STAILQ_FIRST(&softc->done_queue);
13341 STAILQ_REMOVE_HEAD(&softc->done_queue, links);
13342 /* clear any blocked commands, call fe_done */
13343 mtx_unlock(&softc->ctl_lock);
13346 * Call this without a lock for now. This will
13347 * depend on whether there is any way the FETD can
13348 * sleep or deadlock if called with the CTL lock
13351 retval = ctl_process_done(io, /*have_lock*/ 0);
13352 mtx_lock(&softc->ctl_lock);
13355 if (!ctl_pause_rtr) {
13356 io = (union ctl_io *)STAILQ_FIRST(&softc->rtr_queue);
13358 STAILQ_REMOVE_HEAD(&softc->rtr_queue, links);
13359 mtx_unlock(&softc->ctl_lock);
13360 retval = ctl_scsiio(&io->scsiio);
13361 if (retval != CTL_RETVAL_COMPLETE)
13362 CTL_DEBUG_PRINT(("ctl_scsiio failed\n"));
13363 mtx_lock(&softc->ctl_lock);
13367 io = (union ctl_io *)STAILQ_FIRST(&softc->incoming_queue);
13369 STAILQ_REMOVE_HEAD(&softc->incoming_queue, links);
13370 mtx_unlock(&softc->ctl_lock);
13371 ctl_scsiio_precheck(softc, &io->scsiio);
13372 mtx_lock(&softc->ctl_lock);
13376 * We might want to move this to a separate thread, so that
13377 * configuration requests (in this case LUN creations)
13378 * won't impact the I/O path.
13380 be_lun = STAILQ_FIRST(&softc->pending_lun_queue);
13381 if (be_lun != NULL) {
13382 STAILQ_REMOVE_HEAD(&softc->pending_lun_queue, links);
13383 mtx_unlock(&softc->ctl_lock);
13384 ctl_create_lun(be_lun);
13385 mtx_lock(&softc->ctl_lock);
13389 /* XXX KDM use the PDROP flag?? */
13390 /* Sleep until we have something to do. */
13391 mtx_sleep(softc, &softc->ctl_lock, PRIBIO, "-", 0);
13393 /* Back to the top of the loop to see what woke us up. */
13399 ctl_wakeup_thread()
13401 struct ctl_softc *softc;
13403 softc = control_softc;
13408 /* Initialization and failover */
13411 ctl_init_isc_msg(void)
13413 printf("CTL: Still calling this thing\n");
13418 * Initializes component into configuration defined by bootMode
13420 * returns hasc_Status:
13422 * ERROR - fatal error
13424 static ctl_ha_comp_status
13425 ctl_isc_init(struct ctl_ha_component *c)
13427 ctl_ha_comp_status ret = CTL_HA_COMP_STATUS_OK;
13434 * Starts component in state requested. If component starts successfully,
13435 * it must set its own state to the requestrd state
13436 * When requested state is HASC_STATE_HA, the component may refine it
13437 * by adding _SLAVE or _MASTER flags.
13438 * Currently allowed state transitions are:
13439 * UNKNOWN->HA - initial startup
13440 * UNKNOWN->SINGLE - initial startup when no parter detected
13441 * HA->SINGLE - failover
13442 * returns ctl_ha_comp_status:
13443 * OK - component successfully started in requested state
13444 * FAILED - could not start the requested state, failover may
13446 * ERROR - fatal error detected, no future startup possible
13448 static ctl_ha_comp_status
13449 ctl_isc_start(struct ctl_ha_component *c, ctl_ha_state state)
13451 ctl_ha_comp_status ret = CTL_HA_COMP_STATUS_OK;
13453 printf("%s: go\n", __func__);
13455 // UNKNOWN->HA or UNKNOWN->SINGLE (bootstrap)
13456 if (c->state == CTL_HA_STATE_UNKNOWN ) {
13458 if (ctl_ha_msg_create(CTL_HA_CHAN_CTL, ctl_isc_event_handler)
13459 != CTL_HA_STATUS_SUCCESS) {
13460 printf("ctl_isc_start: ctl_ha_msg_create failed.\n");
13461 ret = CTL_HA_COMP_STATUS_ERROR;
13463 } else if (CTL_HA_STATE_IS_HA(c->state)
13464 && CTL_HA_STATE_IS_SINGLE(state)){
13465 // HA->SINGLE transition
13469 printf("ctl_isc_start:Invalid state transition %X->%X\n",
13471 ret = CTL_HA_COMP_STATUS_ERROR;
13473 if (CTL_HA_STATE_IS_SINGLE(state))
13482 * Quiesce component
13483 * The component must clear any error conditions (set status to OK) and
13484 * prepare itself to another Start call
13485 * returns ctl_ha_comp_status:
13489 static ctl_ha_comp_status
13490 ctl_isc_quiesce(struct ctl_ha_component *c)
13492 int ret = CTL_HA_COMP_STATUS_OK;
13499 struct ctl_ha_component ctl_ha_component_ctlisc =
13502 .state = CTL_HA_STATE_UNKNOWN,
13503 .init = ctl_isc_init,
13504 .start = ctl_isc_start,
13505 .quiesce = ctl_isc_quiesce