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 * Size and alignment macros needed for Copan-specific HA hardware. These
87 * can go away when the HA code is re-written, and uses busdma for any
90 #define CTL_ALIGN_8B(target, source, type) \
91 if (((uint32_t)source & 0x7) != 0) \
92 target = (type)(source + (0x8 - ((uint32_t)source & 0x7)));\
94 target = (type)source;
96 #define CTL_SIZE_8B(target, size) \
97 if ((size & 0x7) != 0) \
98 target = size + (0x8 - (size & 0x7)); \
102 #define CTL_ALIGN_8B_MARGIN 16
105 * Template mode pages.
109 * Note that these are default values only. The actual values will be
110 * filled in when the user does a mode sense.
112 static struct copan_power_subpage power_page_default = {
113 /*page_code*/ PWR_PAGE_CODE | SMPH_SPF,
114 /*subpage*/ PWR_SUBPAGE_CODE,
115 /*page_length*/ {(sizeof(struct copan_power_subpage) - 4) & 0xff00,
116 (sizeof(struct copan_power_subpage) - 4) & 0x00ff},
117 /*page_version*/ PWR_VERSION,
119 /* max_active_luns*/ PWR_DFLT_MAX_LUNS,
120 /*reserved*/ {0, 0, 0, 0, 0, 0, 0, 0, 0,
121 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
125 static struct copan_power_subpage power_page_changeable = {
126 /*page_code*/ PWR_PAGE_CODE | SMPH_SPF,
127 /*subpage*/ PWR_SUBPAGE_CODE,
128 /*page_length*/ {(sizeof(struct copan_power_subpage) - 4) & 0xff00,
129 (sizeof(struct copan_power_subpage) - 4) & 0x00ff},
132 /* max_active_luns*/ 0,
133 /*reserved*/ {0, 0, 0, 0, 0, 0, 0, 0, 0,
134 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
138 static struct copan_aps_subpage aps_page_default = {
139 APS_PAGE_CODE | SMPH_SPF, //page_code
140 APS_SUBPAGE_CODE, //subpage
141 {(sizeof(struct copan_aps_subpage) - 4) & 0xff00,
142 (sizeof(struct copan_aps_subpage) - 4) & 0x00ff}, //page_length
143 APS_VERSION, //page_version
145 {0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
146 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
147 0, 0, 0, 0, 0} //reserved
150 static struct copan_aps_subpage aps_page_changeable = {
151 APS_PAGE_CODE | SMPH_SPF, //page_code
152 APS_SUBPAGE_CODE, //subpage
153 {(sizeof(struct copan_aps_subpage) - 4) & 0xff00,
154 (sizeof(struct copan_aps_subpage) - 4) & 0x00ff}, //page_length
157 {0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
158 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
159 0, 0, 0, 0, 0} //reserved
162 static struct copan_debugconf_subpage debugconf_page_default = {
163 DBGCNF_PAGE_CODE | SMPH_SPF, /* page_code */
164 DBGCNF_SUBPAGE_CODE, /* subpage */
165 {(sizeof(struct copan_debugconf_subpage) - 4) >> 8,
166 (sizeof(struct copan_debugconf_subpage) - 4) >> 0}, /* page_length */
167 DBGCNF_VERSION, /* page_version */
168 {CTL_TIME_IO_DEFAULT_SECS>>8,
169 CTL_TIME_IO_DEFAULT_SECS>>0}, /* ctl_time_io_secs */
172 static struct copan_debugconf_subpage debugconf_page_changeable = {
173 DBGCNF_PAGE_CODE | SMPH_SPF, /* page_code */
174 DBGCNF_SUBPAGE_CODE, /* subpage */
175 {(sizeof(struct copan_debugconf_subpage) - 4) >> 8,
176 (sizeof(struct copan_debugconf_subpage) - 4) >> 0}, /* page_length */
177 0, /* page_version */
178 {0xff,0xff}, /* ctl_time_io_secs */
181 static struct scsi_format_page format_page_default = {
182 /*page_code*/SMS_FORMAT_DEVICE_PAGE,
183 /*page_length*/sizeof(struct scsi_format_page) - 2,
184 /*tracks_per_zone*/ {0, 0},
185 /*alt_sectors_per_zone*/ {0, 0},
186 /*alt_tracks_per_zone*/ {0, 0},
187 /*alt_tracks_per_lun*/ {0, 0},
188 /*sectors_per_track*/ {(CTL_DEFAULT_SECTORS_PER_TRACK >> 8) & 0xff,
189 CTL_DEFAULT_SECTORS_PER_TRACK & 0xff},
190 /*bytes_per_sector*/ {0, 0},
191 /*interleave*/ {0, 0},
192 /*track_skew*/ {0, 0},
193 /*cylinder_skew*/ {0, 0},
195 /*reserved*/ {0, 0, 0}
198 static struct scsi_format_page format_page_changeable = {
199 /*page_code*/SMS_FORMAT_DEVICE_PAGE,
200 /*page_length*/sizeof(struct scsi_format_page) - 2,
201 /*tracks_per_zone*/ {0, 0},
202 /*alt_sectors_per_zone*/ {0, 0},
203 /*alt_tracks_per_zone*/ {0, 0},
204 /*alt_tracks_per_lun*/ {0, 0},
205 /*sectors_per_track*/ {0, 0},
206 /*bytes_per_sector*/ {0, 0},
207 /*interleave*/ {0, 0},
208 /*track_skew*/ {0, 0},
209 /*cylinder_skew*/ {0, 0},
211 /*reserved*/ {0, 0, 0}
214 static struct scsi_rigid_disk_page rigid_disk_page_default = {
215 /*page_code*/SMS_RIGID_DISK_PAGE,
216 /*page_length*/sizeof(struct scsi_rigid_disk_page) - 2,
217 /*cylinders*/ {0, 0, 0},
218 /*heads*/ CTL_DEFAULT_HEADS,
219 /*start_write_precomp*/ {0, 0, 0},
220 /*start_reduced_current*/ {0, 0, 0},
221 /*step_rate*/ {0, 0},
222 /*landing_zone_cylinder*/ {0, 0, 0},
223 /*rpl*/ SRDP_RPL_DISABLED,
224 /*rotational_offset*/ 0,
226 /*rotation_rate*/ {(CTL_DEFAULT_ROTATION_RATE >> 8) & 0xff,
227 CTL_DEFAULT_ROTATION_RATE & 0xff},
231 static struct scsi_rigid_disk_page rigid_disk_page_changeable = {
232 /*page_code*/SMS_RIGID_DISK_PAGE,
233 /*page_length*/sizeof(struct scsi_rigid_disk_page) - 2,
234 /*cylinders*/ {0, 0, 0},
236 /*start_write_precomp*/ {0, 0, 0},
237 /*start_reduced_current*/ {0, 0, 0},
238 /*step_rate*/ {0, 0},
239 /*landing_zone_cylinder*/ {0, 0, 0},
241 /*rotational_offset*/ 0,
243 /*rotation_rate*/ {0, 0},
247 static struct scsi_caching_page caching_page_default = {
248 /*page_code*/SMS_CACHING_PAGE,
249 /*page_length*/sizeof(struct scsi_caching_page) - 2,
250 /*flags1*/ SCP_DISC | SCP_WCE,
252 /*disable_pf_transfer_len*/ {0xff, 0xff},
253 /*min_prefetch*/ {0, 0},
254 /*max_prefetch*/ {0xff, 0xff},
255 /*max_pf_ceiling*/ {0xff, 0xff},
257 /*cache_segments*/ 0,
258 /*cache_seg_size*/ {0, 0},
260 /*non_cache_seg_size*/ {0, 0, 0}
263 static struct scsi_caching_page caching_page_changeable = {
264 /*page_code*/SMS_CACHING_PAGE,
265 /*page_length*/sizeof(struct scsi_caching_page) - 2,
268 /*disable_pf_transfer_len*/ {0, 0},
269 /*min_prefetch*/ {0, 0},
270 /*max_prefetch*/ {0, 0},
271 /*max_pf_ceiling*/ {0, 0},
273 /*cache_segments*/ 0,
274 /*cache_seg_size*/ {0, 0},
276 /*non_cache_seg_size*/ {0, 0, 0}
279 static struct scsi_control_page control_page_default = {
280 /*page_code*/SMS_CONTROL_MODE_PAGE,
281 /*page_length*/sizeof(struct scsi_control_page) - 2,
286 /*aen_holdoff_period*/{0, 0},
287 /*busy_timeout_period*/{0, 0},
288 /*extended_selftest_completion_time*/{0, 0}
291 static struct scsi_control_page control_page_changeable = {
292 /*page_code*/SMS_CONTROL_MODE_PAGE,
293 /*page_length*/sizeof(struct scsi_control_page) - 2,
298 /*aen_holdoff_period*/{0, 0},
299 /*busy_timeout_period*/{0, 0},
300 /*extended_selftest_completion_time*/{0, 0}
305 * XXX KDM move these into the softc.
307 static int rcv_sync_msg;
308 static int persis_offset;
309 static uint8_t ctl_pause_rtr;
310 static int ctl_is_single = 1;
311 static int index_to_aps_page;
313 SYSCTL_NODE(_kern_cam, OID_AUTO, ctl, CTLFLAG_RD, 0, "CAM Target Layer");
314 static int worker_threads = -1;
315 TUNABLE_INT("kern.cam.ctl.worker_threads", &worker_threads);
316 SYSCTL_INT(_kern_cam_ctl, OID_AUTO, worker_threads, CTLFLAG_RDTUN,
317 &worker_threads, 1, "Number of worker threads");
318 static int verbose = 0;
319 TUNABLE_INT("kern.cam.ctl.verbose", &verbose);
320 SYSCTL_INT(_kern_cam_ctl, OID_AUTO, verbose, CTLFLAG_RWTUN,
321 &verbose, 0, "Show SCSI errors returned to initiator");
324 * Supported pages (0x00), Serial number (0x80), Device ID (0x83),
325 * SCSI Ports (0x88), Third-party Copy (0x8F), Block limits (0xB0),
326 * Block Device Characteristics (0xB1) and Logical Block Provisioning (0xB2)
328 #define SCSI_EVPD_NUM_SUPPORTED_PAGES 8
330 static void ctl_isc_event_handler(ctl_ha_channel chanel, ctl_ha_event event,
332 static void ctl_copy_sense_data(union ctl_ha_msg *src, union ctl_io *dest);
333 static int ctl_init(void);
334 void ctl_shutdown(void);
335 static int ctl_open(struct cdev *dev, int flags, int fmt, struct thread *td);
336 static int ctl_close(struct cdev *dev, int flags, int fmt, struct thread *td);
337 static void ctl_ioctl_online(void *arg);
338 static void ctl_ioctl_offline(void *arg);
339 static int ctl_ioctl_lun_enable(void *arg, struct ctl_id targ_id, int lun_id);
340 static int ctl_ioctl_lun_disable(void *arg, struct ctl_id targ_id, int lun_id);
341 static int ctl_ioctl_do_datamove(struct ctl_scsiio *ctsio);
342 static int ctl_serialize_other_sc_cmd(struct ctl_scsiio *ctsio);
343 static int ctl_ioctl_submit_wait(union ctl_io *io);
344 static void ctl_ioctl_datamove(union ctl_io *io);
345 static void ctl_ioctl_done(union ctl_io *io);
346 static void ctl_ioctl_hard_startstop_callback(void *arg,
347 struct cfi_metatask *metatask);
348 static void ctl_ioctl_bbrread_callback(void *arg,struct cfi_metatask *metatask);
349 static int ctl_ioctl_fill_ooa(struct ctl_lun *lun, uint32_t *cur_fill_num,
350 struct ctl_ooa *ooa_hdr,
351 struct ctl_ooa_entry *kern_entries);
352 static int ctl_ioctl(struct cdev *dev, u_long cmd, caddr_t addr, int flag,
354 static uint32_t ctl_map_lun(int port_num, uint32_t lun);
355 static uint32_t ctl_map_lun_back(int port_num, uint32_t lun);
357 static union ctl_io *ctl_malloc_io(ctl_io_type io_type, uint32_t targ_port,
358 uint32_t targ_target, uint32_t targ_lun,
360 static void ctl_kfree_io(union ctl_io *io);
362 static int ctl_alloc_lun(struct ctl_softc *ctl_softc, struct ctl_lun *lun,
363 struct ctl_be_lun *be_lun, struct ctl_id target_id);
364 static int ctl_free_lun(struct ctl_lun *lun);
365 static void ctl_create_lun(struct ctl_be_lun *be_lun);
367 static void ctl_failover_change_pages(struct ctl_softc *softc,
368 struct ctl_scsiio *ctsio, int master);
371 static int ctl_do_mode_select(union ctl_io *io);
372 static int ctl_pro_preempt(struct ctl_softc *softc, struct ctl_lun *lun,
373 uint64_t res_key, uint64_t sa_res_key,
374 uint8_t type, uint32_t residx,
375 struct ctl_scsiio *ctsio,
376 struct scsi_per_res_out *cdb,
377 struct scsi_per_res_out_parms* param);
378 static void ctl_pro_preempt_other(struct ctl_lun *lun,
379 union ctl_ha_msg *msg);
380 static void ctl_hndl_per_res_out_on_other_sc(union ctl_ha_msg *msg);
381 static int ctl_inquiry_evpd_supported(struct ctl_scsiio *ctsio, int alloc_len);
382 static int ctl_inquiry_evpd_serial(struct ctl_scsiio *ctsio, int alloc_len);
383 static int ctl_inquiry_evpd_devid(struct ctl_scsiio *ctsio, int alloc_len);
384 static int ctl_inquiry_evpd_scsi_ports(struct ctl_scsiio *ctsio,
386 static int ctl_inquiry_evpd_block_limits(struct ctl_scsiio *ctsio,
388 static int ctl_inquiry_evpd_bdc(struct ctl_scsiio *ctsio, int alloc_len);
389 static int ctl_inquiry_evpd_lbp(struct ctl_scsiio *ctsio, int alloc_len);
390 static int ctl_inquiry_evpd(struct ctl_scsiio *ctsio);
391 static int ctl_inquiry_std(struct ctl_scsiio *ctsio);
392 static int ctl_get_lba_len(union ctl_io *io, uint64_t *lba, uint32_t *len);
393 static ctl_action ctl_extent_check(union ctl_io *io1, union ctl_io *io2);
394 static ctl_action ctl_check_for_blockage(union ctl_io *pending_io,
395 union ctl_io *ooa_io);
396 static ctl_action ctl_check_ooa(struct ctl_lun *lun, union ctl_io *pending_io,
397 union ctl_io *starting_io);
398 static int ctl_check_blocked(struct ctl_lun *lun);
399 static int ctl_scsiio_lun_check(struct ctl_softc *ctl_softc,
401 const struct ctl_cmd_entry *entry,
402 struct ctl_scsiio *ctsio);
403 //static int ctl_check_rtr(union ctl_io *pending_io, struct ctl_softc *softc);
404 static void ctl_failover(void);
405 static int ctl_scsiio_precheck(struct ctl_softc *ctl_softc,
406 struct ctl_scsiio *ctsio);
407 static int ctl_scsiio(struct ctl_scsiio *ctsio);
409 static int ctl_bus_reset(struct ctl_softc *ctl_softc, union ctl_io *io);
410 static int ctl_target_reset(struct ctl_softc *ctl_softc, union ctl_io *io,
411 ctl_ua_type ua_type);
412 static int ctl_lun_reset(struct ctl_lun *lun, union ctl_io *io,
413 ctl_ua_type ua_type);
414 static int ctl_abort_task(union ctl_io *io);
415 static int ctl_abort_task_set(union ctl_io *io);
416 static int ctl_i_t_nexus_reset(union ctl_io *io);
417 static void ctl_run_task(union ctl_io *io);
419 static void ctl_datamove_timer_wakeup(void *arg);
420 static void ctl_done_timer_wakeup(void *arg);
421 #endif /* CTL_IO_DELAY */
423 static void ctl_send_datamove_done(union ctl_io *io, int have_lock);
424 static void ctl_datamove_remote_write_cb(struct ctl_ha_dt_req *rq);
425 static int ctl_datamove_remote_dm_write_cb(union ctl_io *io);
426 static void ctl_datamove_remote_write(union ctl_io *io);
427 static int ctl_datamove_remote_dm_read_cb(union ctl_io *io);
428 static void ctl_datamove_remote_read_cb(struct ctl_ha_dt_req *rq);
429 static int ctl_datamove_remote_sgl_setup(union ctl_io *io);
430 static int ctl_datamove_remote_xfer(union ctl_io *io, unsigned command,
431 ctl_ha_dt_cb callback);
432 static void ctl_datamove_remote_read(union ctl_io *io);
433 static void ctl_datamove_remote(union ctl_io *io);
434 static int ctl_process_done(union ctl_io *io);
435 static void ctl_lun_thread(void *arg);
436 static void ctl_work_thread(void *arg);
437 static void ctl_enqueue_incoming(union ctl_io *io);
438 static void ctl_enqueue_rtr(union ctl_io *io);
439 static void ctl_enqueue_done(union ctl_io *io);
440 static void ctl_enqueue_isc(union ctl_io *io);
441 static const struct ctl_cmd_entry *
442 ctl_get_cmd_entry(struct ctl_scsiio *ctsio);
443 static const struct ctl_cmd_entry *
444 ctl_validate_command(struct ctl_scsiio *ctsio);
445 static int ctl_cmd_applicable(uint8_t lun_type,
446 const struct ctl_cmd_entry *entry);
449 * Load the serialization table. This isn't very pretty, but is probably
450 * the easiest way to do it.
452 #include "ctl_ser_table.c"
455 * We only need to define open, close and ioctl routines for this driver.
457 static struct cdevsw ctl_cdevsw = {
458 .d_version = D_VERSION,
461 .d_close = ctl_close,
462 .d_ioctl = ctl_ioctl,
467 MALLOC_DEFINE(M_CTL, "ctlmem", "Memory used for CTL");
468 MALLOC_DEFINE(M_CTLIO, "ctlio", "Memory used for CTL requests");
470 static int ctl_module_event_handler(module_t, int /*modeventtype_t*/, void *);
472 static moduledata_t ctl_moduledata = {
474 ctl_module_event_handler,
478 DECLARE_MODULE(ctl, ctl_moduledata, SI_SUB_CONFIGURE, SI_ORDER_THIRD);
479 MODULE_VERSION(ctl, 1);
481 static struct ctl_frontend ioctl_frontend =
487 ctl_isc_handler_finish_xfer(struct ctl_softc *ctl_softc,
488 union ctl_ha_msg *msg_info)
490 struct ctl_scsiio *ctsio;
492 if (msg_info->hdr.original_sc == NULL) {
493 printf("%s: original_sc == NULL!\n", __func__);
494 /* XXX KDM now what? */
498 ctsio = &msg_info->hdr.original_sc->scsiio;
499 ctsio->io_hdr.flags |= CTL_FLAG_IO_ACTIVE;
500 ctsio->io_hdr.msg_type = CTL_MSG_FINISH_IO;
501 ctsio->io_hdr.status = msg_info->hdr.status;
502 ctsio->scsi_status = msg_info->scsi.scsi_status;
503 ctsio->sense_len = msg_info->scsi.sense_len;
504 ctsio->sense_residual = msg_info->scsi.sense_residual;
505 ctsio->residual = msg_info->scsi.residual;
506 memcpy(&ctsio->sense_data, &msg_info->scsi.sense_data,
507 sizeof(ctsio->sense_data));
508 memcpy(&ctsio->io_hdr.ctl_private[CTL_PRIV_LBA_LEN].bytes,
509 &msg_info->scsi.lbalen, sizeof(msg_info->scsi.lbalen));
510 ctl_enqueue_isc((union ctl_io *)ctsio);
514 ctl_isc_handler_finish_ser_only(struct ctl_softc *ctl_softc,
515 union ctl_ha_msg *msg_info)
517 struct ctl_scsiio *ctsio;
519 if (msg_info->hdr.serializing_sc == NULL) {
520 printf("%s: serializing_sc == NULL!\n", __func__);
521 /* XXX KDM now what? */
525 ctsio = &msg_info->hdr.serializing_sc->scsiio;
528 * Attempt to catch the situation where an I/O has
529 * been freed, and we're using it again.
531 if (ctsio->io_hdr.io_type == 0xff) {
532 union ctl_io *tmp_io;
533 tmp_io = (union ctl_io *)ctsio;
534 printf("%s: %p use after free!\n", __func__,
536 printf("%s: type %d msg %d cdb %x iptl: "
537 "%d:%d:%d:%d tag 0x%04x "
538 "flag %#x status %x\n",
540 tmp_io->io_hdr.io_type,
541 tmp_io->io_hdr.msg_type,
542 tmp_io->scsiio.cdb[0],
543 tmp_io->io_hdr.nexus.initid.id,
544 tmp_io->io_hdr.nexus.targ_port,
545 tmp_io->io_hdr.nexus.targ_target.id,
546 tmp_io->io_hdr.nexus.targ_lun,
547 (tmp_io->io_hdr.io_type ==
549 tmp_io->taskio.tag_num :
550 tmp_io->scsiio.tag_num,
551 tmp_io->io_hdr.flags,
552 tmp_io->io_hdr.status);
555 ctsio->io_hdr.msg_type = CTL_MSG_FINISH_IO;
556 ctl_enqueue_isc((union ctl_io *)ctsio);
560 * ISC (Inter Shelf Communication) event handler. Events from the HA
561 * subsystem come in here.
564 ctl_isc_event_handler(ctl_ha_channel channel, ctl_ha_event event, int param)
566 struct ctl_softc *ctl_softc;
568 struct ctl_prio *presio;
569 ctl_ha_status isc_status;
571 ctl_softc = control_softc;
576 printf("CTL: Isc Msg event %d\n", event);
578 if (event == CTL_HA_EVT_MSG_RECV) {
579 union ctl_ha_msg msg_info;
581 isc_status = ctl_ha_msg_recv(CTL_HA_CHAN_CTL, &msg_info,
582 sizeof(msg_info), /*wait*/ 0);
584 printf("CTL: msg_type %d\n", msg_info.msg_type);
586 if (isc_status != 0) {
587 printf("Error receiving message, status = %d\n",
592 switch (msg_info.hdr.msg_type) {
593 case CTL_MSG_SERIALIZE:
595 printf("Serialize\n");
597 io = ctl_alloc_io((void *)ctl_softc->othersc_pool);
599 printf("ctl_isc_event_handler: can't allocate "
602 /* Need to set busy and send msg back */
603 msg_info.hdr.msg_type = CTL_MSG_BAD_JUJU;
604 msg_info.hdr.status = CTL_SCSI_ERROR;
605 msg_info.scsi.scsi_status = SCSI_STATUS_BUSY;
606 msg_info.scsi.sense_len = 0;
607 if (ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg_info,
608 sizeof(msg_info), 0) > CTL_HA_STATUS_SUCCESS){
613 // populate ctsio from msg_info
614 io->io_hdr.io_type = CTL_IO_SCSI;
615 io->io_hdr.msg_type = CTL_MSG_SERIALIZE;
616 io->io_hdr.original_sc = msg_info.hdr.original_sc;
618 printf("pOrig %x\n", (int)msg_info.original_sc);
620 io->io_hdr.flags |= CTL_FLAG_FROM_OTHER_SC |
623 * If we're in serialization-only mode, we don't
624 * want to go through full done processing. Thus
627 * XXX KDM add another flag that is more specific.
629 if (ctl_softc->ha_mode == CTL_HA_MODE_SER_ONLY)
630 io->io_hdr.flags |= CTL_FLAG_INT_COPY;
631 io->io_hdr.nexus = msg_info.hdr.nexus;
633 printf("targ %d, port %d, iid %d, lun %d\n",
634 io->io_hdr.nexus.targ_target.id,
635 io->io_hdr.nexus.targ_port,
636 io->io_hdr.nexus.initid.id,
637 io->io_hdr.nexus.targ_lun);
639 io->scsiio.tag_num = msg_info.scsi.tag_num;
640 io->scsiio.tag_type = msg_info.scsi.tag_type;
641 memcpy(io->scsiio.cdb, msg_info.scsi.cdb,
643 if (ctl_softc->ha_mode == CTL_HA_MODE_XFER) {
644 const struct ctl_cmd_entry *entry;
646 entry = ctl_get_cmd_entry(&io->scsiio);
647 io->io_hdr.flags &= ~CTL_FLAG_DATA_MASK;
649 entry->flags & CTL_FLAG_DATA_MASK;
654 /* Performed on the Originating SC, XFER mode only */
655 case CTL_MSG_DATAMOVE: {
656 struct ctl_sg_entry *sgl;
659 io = msg_info.hdr.original_sc;
661 printf("%s: original_sc == NULL!\n", __func__);
662 /* XXX KDM do something here */
665 io->io_hdr.msg_type = CTL_MSG_DATAMOVE;
666 io->io_hdr.flags |= CTL_FLAG_IO_ACTIVE;
668 * Keep track of this, we need to send it back over
669 * when the datamove is complete.
671 io->io_hdr.serializing_sc = msg_info.hdr.serializing_sc;
673 if (msg_info.dt.sg_sequence == 0) {
675 * XXX KDM we use the preallocated S/G list
676 * here, but we'll need to change this to
677 * dynamic allocation if we need larger S/G
680 if (msg_info.dt.kern_sg_entries >
681 sizeof(io->io_hdr.remote_sglist) /
682 sizeof(io->io_hdr.remote_sglist[0])) {
683 printf("%s: number of S/G entries "
684 "needed %u > allocated num %zd\n",
686 msg_info.dt.kern_sg_entries,
687 sizeof(io->io_hdr.remote_sglist)/
688 sizeof(io->io_hdr.remote_sglist[0]));
691 * XXX KDM send a message back to
692 * the other side to shut down the
693 * DMA. The error will come back
694 * through via the normal channel.
698 sgl = io->io_hdr.remote_sglist;
700 sizeof(io->io_hdr.remote_sglist));
702 io->scsiio.kern_data_ptr = (uint8_t *)sgl;
704 io->scsiio.kern_sg_entries =
705 msg_info.dt.kern_sg_entries;
706 io->scsiio.rem_sg_entries =
707 msg_info.dt.kern_sg_entries;
708 io->scsiio.kern_data_len =
709 msg_info.dt.kern_data_len;
710 io->scsiio.kern_total_len =
711 msg_info.dt.kern_total_len;
712 io->scsiio.kern_data_resid =
713 msg_info.dt.kern_data_resid;
714 io->scsiio.kern_rel_offset =
715 msg_info.dt.kern_rel_offset;
717 * Clear out per-DMA flags.
719 io->io_hdr.flags &= ~CTL_FLAG_RDMA_MASK;
721 * Add per-DMA flags that are set for this
722 * particular DMA request.
724 io->io_hdr.flags |= msg_info.dt.flags &
727 sgl = (struct ctl_sg_entry *)
728 io->scsiio.kern_data_ptr;
730 for (i = msg_info.dt.sent_sg_entries, j = 0;
731 i < (msg_info.dt.sent_sg_entries +
732 msg_info.dt.cur_sg_entries); i++, j++) {
733 sgl[i].addr = msg_info.dt.sg_list[j].addr;
734 sgl[i].len = msg_info.dt.sg_list[j].len;
737 printf("%s: L: %p,%d -> %p,%d j=%d, i=%d\n",
739 msg_info.dt.sg_list[j].addr,
740 msg_info.dt.sg_list[j].len,
741 sgl[i].addr, sgl[i].len, j, i);
745 memcpy(&sgl[msg_info.dt.sent_sg_entries],
747 sizeof(*sgl) * msg_info.dt.cur_sg_entries);
751 * If this is the last piece of the I/O, we've got
752 * the full S/G list. Queue processing in the thread.
753 * Otherwise wait for the next piece.
755 if (msg_info.dt.sg_last != 0)
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));
786 /* Preformed on Originating SC, SER_ONLY mode */
788 io = msg_info.hdr.original_sc;
790 printf("%s: Major Bummer\n", __func__);
794 printf("pOrig %x\n",(int) ctsio);
797 io->io_hdr.msg_type = CTL_MSG_R2R;
798 io->io_hdr.serializing_sc = msg_info.hdr.serializing_sc;
803 * Performed on Serializing(i.e. primary SC) SC in SER_ONLY
805 * Performed on the Originating (i.e. secondary) SC in XFER
808 case CTL_MSG_FINISH_IO:
809 if (ctl_softc->ha_mode == CTL_HA_MODE_XFER)
810 ctl_isc_handler_finish_xfer(ctl_softc,
813 ctl_isc_handler_finish_ser_only(ctl_softc,
817 /* Preformed on Originating SC */
818 case CTL_MSG_BAD_JUJU:
819 io = msg_info.hdr.original_sc;
821 printf("%s: Bad JUJU!, original_sc is NULL!\n",
825 ctl_copy_sense_data(&msg_info, io);
827 * IO should have already been cleaned up on other
828 * SC so clear this flag so we won't send a message
829 * back to finish the IO there.
831 io->io_hdr.flags &= ~CTL_FLAG_SENT_2OTHER_SC;
832 io->io_hdr.flags |= CTL_FLAG_IO_ACTIVE;
834 /* io = msg_info.hdr.serializing_sc; */
835 io->io_hdr.msg_type = CTL_MSG_BAD_JUJU;
839 /* Handle resets sent from the other side */
840 case CTL_MSG_MANAGE_TASKS: {
841 struct ctl_taskio *taskio;
842 taskio = (struct ctl_taskio *)ctl_alloc_io(
843 (void *)ctl_softc->othersc_pool);
844 if (taskio == NULL) {
845 printf("ctl_isc_event_handler: can't allocate "
848 /* should I just call the proper reset func
852 ctl_zero_io((union ctl_io *)taskio);
853 taskio->io_hdr.io_type = CTL_IO_TASK;
854 taskio->io_hdr.flags |= CTL_FLAG_FROM_OTHER_SC;
855 taskio->io_hdr.nexus = msg_info.hdr.nexus;
856 taskio->task_action = msg_info.task.task_action;
857 taskio->tag_num = msg_info.task.tag_num;
858 taskio->tag_type = msg_info.task.tag_type;
860 taskio->io_hdr.start_time = time_uptime;
861 getbintime(&taskio->io_hdr.start_bt);
863 cs_prof_gettime(&taskio->io_hdr.start_ticks);
865 #endif /* CTL_TIME_IO */
866 ctl_run_task((union ctl_io *)taskio);
869 /* Persistent Reserve action which needs attention */
870 case CTL_MSG_PERS_ACTION:
871 presio = (struct ctl_prio *)ctl_alloc_io(
872 (void *)ctl_softc->othersc_pool);
873 if (presio == NULL) {
874 printf("ctl_isc_event_handler: can't allocate "
877 /* Need to set busy and send msg back */
880 ctl_zero_io((union ctl_io *)presio);
881 presio->io_hdr.msg_type = CTL_MSG_PERS_ACTION;
882 presio->pr_msg = msg_info.pr;
883 ctl_enqueue_isc((union ctl_io *)presio);
885 case CTL_MSG_SYNC_FE:
888 case CTL_MSG_APS_LOCK: {
889 // It's quicker to execute this then to
892 struct ctl_page_index *page_index;
893 struct copan_aps_subpage *current_sp;
896 targ_lun = msg_info.hdr.nexus.targ_mapped_lun;
897 lun = ctl_softc->ctl_luns[targ_lun];
898 mtx_lock(&lun->lun_lock);
899 page_index = &lun->mode_pages.index[index_to_aps_page];
900 current_sp = (struct copan_aps_subpage *)
901 (page_index->page_data +
902 (page_index->page_len * CTL_PAGE_CURRENT));
904 current_sp->lock_active = msg_info.aps.lock_flag;
905 mtx_unlock(&lun->lun_lock);
909 printf("How did I get here?\n");
911 } else if (event == CTL_HA_EVT_MSG_SENT) {
912 if (param != CTL_HA_STATUS_SUCCESS) {
913 printf("Bad status from ctl_ha_msg_send status %d\n",
917 } else if (event == CTL_HA_EVT_DISCONNECT) {
918 printf("CTL: Got a disconnect from Isc\n");
921 printf("ctl_isc_event_handler: Unknown event %d\n", event);
930 ctl_copy_sense_data(union ctl_ha_msg *src, union ctl_io *dest)
932 struct scsi_sense_data *sense;
934 sense = &dest->scsiio.sense_data;
935 bcopy(&src->scsi.sense_data, sense, sizeof(*sense));
936 dest->scsiio.scsi_status = src->scsi.scsi_status;
937 dest->scsiio.sense_len = src->scsi.sense_len;
938 dest->io_hdr.status = src->hdr.status;
944 struct ctl_softc *softc;
945 struct ctl_io_pool *internal_pool, *emergency_pool, *other_pool;
946 struct ctl_port *port;
948 int i, error, retval;
955 control_softc = malloc(sizeof(*control_softc), M_DEVBUF,
957 softc = control_softc;
959 softc->dev = make_dev(&ctl_cdevsw, 0, UID_ROOT, GID_OPERATOR, 0600,
962 softc->dev->si_drv1 = softc;
965 * By default, return a "bad LUN" peripheral qualifier for unknown
966 * LUNs. The user can override this default using the tunable or
967 * sysctl. See the comment in ctl_inquiry_std() for more details.
969 softc->inquiry_pq_no_lun = 1;
970 TUNABLE_INT_FETCH("kern.cam.ctl.inquiry_pq_no_lun",
971 &softc->inquiry_pq_no_lun);
972 sysctl_ctx_init(&softc->sysctl_ctx);
973 softc->sysctl_tree = SYSCTL_ADD_NODE(&softc->sysctl_ctx,
974 SYSCTL_STATIC_CHILDREN(_kern_cam), OID_AUTO, "ctl",
975 CTLFLAG_RD, 0, "CAM Target Layer");
977 if (softc->sysctl_tree == NULL) {
978 printf("%s: unable to allocate sysctl tree\n", __func__);
979 destroy_dev(softc->dev);
980 free(control_softc, M_DEVBUF);
981 control_softc = NULL;
985 SYSCTL_ADD_INT(&softc->sysctl_ctx,
986 SYSCTL_CHILDREN(softc->sysctl_tree), OID_AUTO,
987 "inquiry_pq_no_lun", CTLFLAG_RW,
988 &softc->inquiry_pq_no_lun, 0,
989 "Report no lun possible for invalid LUNs");
991 mtx_init(&softc->ctl_lock, "CTL mutex", NULL, MTX_DEF);
992 mtx_init(&softc->pool_lock, "CTL pool mutex", NULL, MTX_DEF);
993 softc->open_count = 0;
996 * Default to actually sending a SYNCHRONIZE CACHE command down to
999 softc->flags = CTL_FLAG_REAL_SYNC;
1002 * In Copan's HA scheme, the "master" and "slave" roles are
1003 * figured out through the slot the controller is in. Although it
1004 * is an active/active system, someone has to be in charge.
1007 scmicro_rw(SCMICRO_GET_SHELF_ID, &sc_id);
1011 softc->flags |= CTL_FLAG_MASTER_SHELF;
1014 persis_offset = CTL_MAX_INITIATORS;
1017 * XXX KDM need to figure out where we want to get our target ID
1018 * and WWID. Is it different on each port?
1020 softc->target.id = 0;
1021 softc->target.wwid[0] = 0x12345678;
1022 softc->target.wwid[1] = 0x87654321;
1023 STAILQ_INIT(&softc->lun_list);
1024 STAILQ_INIT(&softc->pending_lun_queue);
1025 STAILQ_INIT(&softc->fe_list);
1026 STAILQ_INIT(&softc->port_list);
1027 STAILQ_INIT(&softc->be_list);
1028 STAILQ_INIT(&softc->io_pools);
1029 ctl_tpc_init(softc);
1031 if (ctl_pool_create(softc, CTL_POOL_INTERNAL, CTL_POOL_ENTRIES_INTERNAL,
1032 &internal_pool)!= 0){
1033 printf("ctl: can't allocate %d entry internal pool, "
1034 "exiting\n", CTL_POOL_ENTRIES_INTERNAL);
1038 if (ctl_pool_create(softc, CTL_POOL_EMERGENCY,
1039 CTL_POOL_ENTRIES_EMERGENCY, &emergency_pool) != 0) {
1040 printf("ctl: can't allocate %d entry emergency pool, "
1041 "exiting\n", CTL_POOL_ENTRIES_EMERGENCY);
1042 ctl_pool_free(internal_pool);
1046 if (ctl_pool_create(softc, CTL_POOL_4OTHERSC, CTL_POOL_ENTRIES_OTHER_SC,
1049 printf("ctl: can't allocate %d entry other SC pool, "
1050 "exiting\n", CTL_POOL_ENTRIES_OTHER_SC);
1051 ctl_pool_free(internal_pool);
1052 ctl_pool_free(emergency_pool);
1056 softc->internal_pool = internal_pool;
1057 softc->emergency_pool = emergency_pool;
1058 softc->othersc_pool = other_pool;
1060 if (worker_threads <= 0)
1061 worker_threads = max(1, mp_ncpus / 4);
1062 if (worker_threads > CTL_MAX_THREADS)
1063 worker_threads = CTL_MAX_THREADS;
1065 for (i = 0; i < worker_threads; i++) {
1066 struct ctl_thread *thr = &softc->threads[i];
1068 mtx_init(&thr->queue_lock, "CTL queue mutex", NULL, MTX_DEF);
1069 thr->ctl_softc = softc;
1070 STAILQ_INIT(&thr->incoming_queue);
1071 STAILQ_INIT(&thr->rtr_queue);
1072 STAILQ_INIT(&thr->done_queue);
1073 STAILQ_INIT(&thr->isc_queue);
1075 error = kproc_kthread_add(ctl_work_thread, thr,
1076 &softc->ctl_proc, &thr->thread, 0, 0, "ctl", "work%d", i);
1078 printf("error creating CTL work thread!\n");
1079 ctl_pool_free(internal_pool);
1080 ctl_pool_free(emergency_pool);
1081 ctl_pool_free(other_pool);
1085 error = kproc_kthread_add(ctl_lun_thread, softc,
1086 &softc->ctl_proc, NULL, 0, 0, "ctl", "lun");
1088 printf("error creating CTL lun thread!\n");
1089 ctl_pool_free(internal_pool);
1090 ctl_pool_free(emergency_pool);
1091 ctl_pool_free(other_pool);
1095 printf("ctl: CAM Target Layer loaded\n");
1098 * Initialize the ioctl front end.
1100 ctl_frontend_register(&ioctl_frontend);
1101 port = &softc->ioctl_info.port;
1102 port->frontend = &ioctl_frontend;
1103 sprintf(softc->ioctl_info.port_name, "ioctl");
1104 port->port_type = CTL_PORT_IOCTL;
1105 port->num_requested_ctl_io = 100;
1106 port->port_name = softc->ioctl_info.port_name;
1107 port->port_online = ctl_ioctl_online;
1108 port->port_offline = ctl_ioctl_offline;
1109 port->onoff_arg = &softc->ioctl_info;
1110 port->lun_enable = ctl_ioctl_lun_enable;
1111 port->lun_disable = ctl_ioctl_lun_disable;
1112 port->targ_lun_arg = &softc->ioctl_info;
1113 port->fe_datamove = ctl_ioctl_datamove;
1114 port->fe_done = ctl_ioctl_done;
1115 port->max_targets = 15;
1116 port->max_target_id = 15;
1118 if (ctl_port_register(&softc->ioctl_info.port,
1119 (softc->flags & CTL_FLAG_MASTER_SHELF)) != 0) {
1120 printf("ctl: ioctl front end registration failed, will "
1121 "continue anyway\n");
1125 if (sizeof(struct callout) > CTL_TIMER_BYTES) {
1126 printf("sizeof(struct callout) %zd > CTL_TIMER_BYTES %zd\n",
1127 sizeof(struct callout), CTL_TIMER_BYTES);
1130 #endif /* CTL_IO_DELAY */
1138 struct ctl_softc *softc;
1139 struct ctl_lun *lun, *next_lun;
1140 struct ctl_io_pool *pool;
1142 softc = (struct ctl_softc *)control_softc;
1144 if (ctl_port_deregister(&softc->ioctl_info.port) != 0)
1145 printf("ctl: ioctl front end deregistration failed\n");
1147 mtx_lock(&softc->ctl_lock);
1152 for (lun = STAILQ_FIRST(&softc->lun_list); lun != NULL; lun = next_lun){
1153 next_lun = STAILQ_NEXT(lun, links);
1157 mtx_unlock(&softc->ctl_lock);
1159 ctl_frontend_deregister(&ioctl_frontend);
1162 * This will rip the rug out from under any FETDs or anyone else
1163 * that has a pool allocated. Since we increment our module
1164 * refcount any time someone outside the main CTL module allocates
1165 * a pool, we shouldn't have any problems here. The user won't be
1166 * able to unload the CTL module until client modules have
1167 * successfully unloaded.
1169 while ((pool = STAILQ_FIRST(&softc->io_pools)) != NULL)
1170 ctl_pool_free(pool);
1173 ctl_shutdown_thread(softc->work_thread);
1174 mtx_destroy(&softc->queue_lock);
1177 ctl_tpc_shutdown(softc);
1178 mtx_destroy(&softc->pool_lock);
1179 mtx_destroy(&softc->ctl_lock);
1181 destroy_dev(softc->dev);
1183 sysctl_ctx_free(&softc->sysctl_ctx);
1185 free(control_softc, M_DEVBUF);
1186 control_softc = NULL;
1189 printf("ctl: CAM Target Layer unloaded\n");
1193 ctl_module_event_handler(module_t mod, int what, void *arg)
1198 return (ctl_init());
1202 return (EOPNOTSUPP);
1207 * XXX KDM should we do some access checks here? Bump a reference count to
1208 * prevent a CTL module from being unloaded while someone has it open?
1211 ctl_open(struct cdev *dev, int flags, int fmt, struct thread *td)
1217 ctl_close(struct cdev *dev, int flags, int fmt, struct thread *td)
1223 ctl_port_enable(ctl_port_type port_type)
1225 struct ctl_softc *softc;
1226 struct ctl_port *port;
1228 if (ctl_is_single == 0) {
1229 union ctl_ha_msg msg_info;
1233 printf("%s: HA mode, synchronizing frontend enable\n",
1236 msg_info.hdr.msg_type = CTL_MSG_SYNC_FE;
1237 if ((isc_retval=ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg_info,
1238 sizeof(msg_info), 1 )) > CTL_HA_STATUS_SUCCESS) {
1239 printf("Sync msg send error retval %d\n", isc_retval);
1241 if (!rcv_sync_msg) {
1242 isc_retval=ctl_ha_msg_recv(CTL_HA_CHAN_CTL, &msg_info,
1243 sizeof(msg_info), 1);
1246 printf("CTL:Frontend Enable\n");
1248 printf("%s: single mode, skipping frontend synchronization\n",
1253 softc = control_softc;
1255 STAILQ_FOREACH(port, &softc->port_list, links) {
1256 if (port_type & port->port_type)
1259 printf("port %d\n", port->targ_port);
1261 ctl_port_online(port);
1269 ctl_port_disable(ctl_port_type port_type)
1271 struct ctl_softc *softc;
1272 struct ctl_port *port;
1274 softc = control_softc;
1276 STAILQ_FOREACH(port, &softc->port_list, links) {
1277 if (port_type & port->port_type)
1278 ctl_port_offline(port);
1285 * Returns 0 for success, 1 for failure.
1286 * Currently the only failure mode is if there aren't enough entries
1287 * allocated. So, in case of a failure, look at num_entries_dropped,
1288 * reallocate and try again.
1291 ctl_port_list(struct ctl_port_entry *entries, int num_entries_alloced,
1292 int *num_entries_filled, int *num_entries_dropped,
1293 ctl_port_type port_type, int no_virtual)
1295 struct ctl_softc *softc;
1296 struct ctl_port *port;
1297 int entries_dropped, entries_filled;
1301 softc = control_softc;
1305 entries_dropped = 0;
1308 mtx_lock(&softc->ctl_lock);
1309 STAILQ_FOREACH(port, &softc->port_list, links) {
1310 struct ctl_port_entry *entry;
1312 if ((port->port_type & port_type) == 0)
1315 if ((no_virtual != 0)
1316 && (port->virtual_port != 0))
1319 if (entries_filled >= num_entries_alloced) {
1323 entry = &entries[i];
1325 entry->port_type = port->port_type;
1326 strlcpy(entry->port_name, port->port_name,
1327 sizeof(entry->port_name));
1328 entry->physical_port = port->physical_port;
1329 entry->virtual_port = port->virtual_port;
1330 entry->wwnn = port->wwnn;
1331 entry->wwpn = port->wwpn;
1337 mtx_unlock(&softc->ctl_lock);
1339 if (entries_dropped > 0)
1342 *num_entries_dropped = entries_dropped;
1343 *num_entries_filled = entries_filled;
1349 ctl_ioctl_online(void *arg)
1351 struct ctl_ioctl_info *ioctl_info;
1353 ioctl_info = (struct ctl_ioctl_info *)arg;
1355 ioctl_info->flags |= CTL_IOCTL_FLAG_ENABLED;
1359 ctl_ioctl_offline(void *arg)
1361 struct ctl_ioctl_info *ioctl_info;
1363 ioctl_info = (struct ctl_ioctl_info *)arg;
1365 ioctl_info->flags &= ~CTL_IOCTL_FLAG_ENABLED;
1369 * Remove an initiator by port number and initiator ID.
1370 * Returns 0 for success, -1 for failure.
1373 ctl_remove_initiator(struct ctl_port *port, int iid)
1375 struct ctl_softc *softc = control_softc;
1377 mtx_assert(&softc->ctl_lock, MA_NOTOWNED);
1379 if (iid > CTL_MAX_INIT_PER_PORT) {
1380 printf("%s: initiator ID %u > maximun %u!\n",
1381 __func__, iid, CTL_MAX_INIT_PER_PORT);
1385 mtx_lock(&softc->ctl_lock);
1386 port->wwpn_iid[iid].in_use--;
1387 port->wwpn_iid[iid].last_use = time_uptime;
1388 mtx_unlock(&softc->ctl_lock);
1394 * Add an initiator to the initiator map.
1395 * Returns iid for success, < 0 for failure.
1398 ctl_add_initiator(struct ctl_port *port, int iid, uint64_t wwpn, char *name)
1400 struct ctl_softc *softc = control_softc;
1404 mtx_assert(&softc->ctl_lock, MA_NOTOWNED);
1406 if (iid >= CTL_MAX_INIT_PER_PORT) {
1407 printf("%s: WWPN %#jx initiator ID %u > maximum %u!\n",
1408 __func__, wwpn, iid, CTL_MAX_INIT_PER_PORT);
1413 mtx_lock(&softc->ctl_lock);
1415 if (iid < 0 && (wwpn != 0 || name != NULL)) {
1416 for (i = 0; i < CTL_MAX_INIT_PER_PORT; i++) {
1417 if (wwpn != 0 && wwpn == port->wwpn_iid[i].wwpn) {
1421 if (name != NULL && port->wwpn_iid[i].name != NULL &&
1422 strcmp(name, port->wwpn_iid[i].name) == 0) {
1430 for (i = 0; i < CTL_MAX_INIT_PER_PORT; i++) {
1431 if (port->wwpn_iid[i].in_use == 0 &&
1432 port->wwpn_iid[i].wwpn == 0 &&
1433 port->wwpn_iid[i].name == NULL) {
1442 best_time = INT32_MAX;
1443 for (i = 0; i < CTL_MAX_INIT_PER_PORT; i++) {
1444 if (port->wwpn_iid[i].in_use == 0) {
1445 if (port->wwpn_iid[i].last_use < best_time) {
1447 best_time = port->wwpn_iid[i].last_use;
1455 mtx_unlock(&softc->ctl_lock);
1460 if (port->wwpn_iid[iid].in_use > 0 && (wwpn != 0 || name != NULL)) {
1462 * This is not an error yet.
1464 if (wwpn != 0 && wwpn == port->wwpn_iid[iid].wwpn) {
1466 printf("%s: port %d iid %u WWPN %#jx arrived"
1467 " again\n", __func__, port->targ_port,
1468 iid, (uintmax_t)wwpn);
1472 if (name != NULL && port->wwpn_iid[iid].name != NULL &&
1473 strcmp(name, port->wwpn_iid[iid].name) == 0) {
1475 printf("%s: port %d iid %u name '%s' arrived"
1476 " again\n", __func__, port->targ_port,
1483 * This is an error, but what do we do about it? The
1484 * driver is telling us we have a new WWPN for this
1485 * initiator ID, so we pretty much need to use it.
1487 printf("%s: port %d iid %u WWPN %#jx '%s' arrived,"
1488 " but WWPN %#jx '%s' is still at that address\n",
1489 __func__, port->targ_port, iid, wwpn, name,
1490 (uintmax_t)port->wwpn_iid[iid].wwpn,
1491 port->wwpn_iid[iid].name);
1494 * XXX KDM clear have_ca and ua_pending on each LUN for
1499 free(port->wwpn_iid[iid].name, M_CTL);
1500 port->wwpn_iid[iid].name = name;
1501 port->wwpn_iid[iid].wwpn = wwpn;
1502 port->wwpn_iid[iid].in_use++;
1503 mtx_unlock(&softc->ctl_lock);
1509 ctl_create_iid(struct ctl_port *port, int iid, uint8_t *buf)
1513 switch (port->port_type) {
1516 struct scsi_transportid_fcp *id =
1517 (struct scsi_transportid_fcp *)buf;
1518 if (port->wwpn_iid[iid].wwpn == 0)
1520 memset(id, 0, sizeof(*id));
1521 id->format_protocol = SCSI_PROTO_FC;
1522 scsi_u64to8b(port->wwpn_iid[iid].wwpn, id->n_port_name);
1523 return (sizeof(*id));
1525 case CTL_PORT_ISCSI:
1527 struct scsi_transportid_iscsi_port *id =
1528 (struct scsi_transportid_iscsi_port *)buf;
1529 if (port->wwpn_iid[iid].name == NULL)
1532 id->format_protocol = SCSI_TRN_ISCSI_FORMAT_PORT |
1534 len = strlcpy(id->iscsi_name, port->wwpn_iid[iid].name, 252) + 1;
1535 len = roundup2(min(len, 252), 4);
1536 scsi_ulto2b(len, id->additional_length);
1537 return (sizeof(*id) + len);
1541 struct scsi_transportid_sas *id =
1542 (struct scsi_transportid_sas *)buf;
1543 if (port->wwpn_iid[iid].wwpn == 0)
1545 memset(id, 0, sizeof(*id));
1546 id->format_protocol = SCSI_PROTO_SAS;
1547 scsi_u64to8b(port->wwpn_iid[iid].wwpn, id->sas_address);
1548 return (sizeof(*id));
1552 struct scsi_transportid_spi *id =
1553 (struct scsi_transportid_spi *)buf;
1554 memset(id, 0, sizeof(*id));
1555 id->format_protocol = SCSI_PROTO_SPI;
1556 scsi_ulto2b(iid, id->scsi_addr);
1557 scsi_ulto2b(port->targ_port, id->rel_trgt_port_id);
1558 return (sizeof(*id));
1564 ctl_ioctl_lun_enable(void *arg, struct ctl_id targ_id, int lun_id)
1570 ctl_ioctl_lun_disable(void *arg, struct ctl_id targ_id, int lun_id)
1576 * Data movement routine for the CTL ioctl frontend port.
1579 ctl_ioctl_do_datamove(struct ctl_scsiio *ctsio)
1581 struct ctl_sg_entry *ext_sglist, *kern_sglist;
1582 struct ctl_sg_entry ext_entry, kern_entry;
1583 int ext_sglen, ext_sg_entries, kern_sg_entries;
1584 int ext_sg_start, ext_offset;
1585 int len_to_copy, len_copied;
1586 int kern_watermark, ext_watermark;
1587 int ext_sglist_malloced;
1590 ext_sglist_malloced = 0;
1594 CTL_DEBUG_PRINT(("ctl_ioctl_do_datamove\n"));
1597 * If this flag is set, fake the data transfer.
1599 if (ctsio->io_hdr.flags & CTL_FLAG_NO_DATAMOVE) {
1600 ctsio->ext_data_filled = ctsio->ext_data_len;
1605 * To simplify things here, if we have a single buffer, stick it in
1606 * a S/G entry and just make it a single entry S/G list.
1608 if (ctsio->io_hdr.flags & CTL_FLAG_EDPTR_SGLIST) {
1611 ext_sglen = ctsio->ext_sg_entries * sizeof(*ext_sglist);
1613 ext_sglist = (struct ctl_sg_entry *)malloc(ext_sglen, M_CTL,
1615 ext_sglist_malloced = 1;
1616 if (copyin(ctsio->ext_data_ptr, ext_sglist,
1618 ctl_set_internal_failure(ctsio,
1623 ext_sg_entries = ctsio->ext_sg_entries;
1625 for (i = 0; i < ext_sg_entries; i++) {
1626 if ((len_seen + ext_sglist[i].len) >=
1627 ctsio->ext_data_filled) {
1629 ext_offset = ctsio->ext_data_filled - len_seen;
1632 len_seen += ext_sglist[i].len;
1635 ext_sglist = &ext_entry;
1636 ext_sglist->addr = ctsio->ext_data_ptr;
1637 ext_sglist->len = ctsio->ext_data_len;
1640 ext_offset = ctsio->ext_data_filled;
1643 if (ctsio->kern_sg_entries > 0) {
1644 kern_sglist = (struct ctl_sg_entry *)ctsio->kern_data_ptr;
1645 kern_sg_entries = ctsio->kern_sg_entries;
1647 kern_sglist = &kern_entry;
1648 kern_sglist->addr = ctsio->kern_data_ptr;
1649 kern_sglist->len = ctsio->kern_data_len;
1650 kern_sg_entries = 1;
1655 ext_watermark = ext_offset;
1657 for (i = ext_sg_start, j = 0;
1658 i < ext_sg_entries && j < kern_sg_entries;) {
1659 uint8_t *ext_ptr, *kern_ptr;
1661 len_to_copy = ctl_min(ext_sglist[i].len - ext_watermark,
1662 kern_sglist[j].len - kern_watermark);
1664 ext_ptr = (uint8_t *)ext_sglist[i].addr;
1665 ext_ptr = ext_ptr + ext_watermark;
1666 if (ctsio->io_hdr.flags & CTL_FLAG_BUS_ADDR) {
1670 panic("need to implement bus address support");
1672 kern_ptr = bus_to_virt(kern_sglist[j].addr);
1675 kern_ptr = (uint8_t *)kern_sglist[j].addr;
1676 kern_ptr = kern_ptr + kern_watermark;
1678 kern_watermark += len_to_copy;
1679 ext_watermark += len_to_copy;
1681 if ((ctsio->io_hdr.flags & CTL_FLAG_DATA_MASK) ==
1683 CTL_DEBUG_PRINT(("ctl_ioctl_do_datamove: copying %d "
1684 "bytes to user\n", len_to_copy));
1685 CTL_DEBUG_PRINT(("ctl_ioctl_do_datamove: from %p "
1686 "to %p\n", kern_ptr, ext_ptr));
1687 if (copyout(kern_ptr, ext_ptr, len_to_copy) != 0) {
1688 ctl_set_internal_failure(ctsio,
1694 CTL_DEBUG_PRINT(("ctl_ioctl_do_datamove: copying %d "
1695 "bytes from user\n", len_to_copy));
1696 CTL_DEBUG_PRINT(("ctl_ioctl_do_datamove: from %p "
1697 "to %p\n", ext_ptr, kern_ptr));
1698 if (copyin(ext_ptr, kern_ptr, len_to_copy)!= 0){
1699 ctl_set_internal_failure(ctsio,
1706 len_copied += len_to_copy;
1708 if (ext_sglist[i].len == ext_watermark) {
1713 if (kern_sglist[j].len == kern_watermark) {
1719 ctsio->ext_data_filled += len_copied;
1721 CTL_DEBUG_PRINT(("ctl_ioctl_do_datamove: ext_sg_entries: %d, "
1722 "kern_sg_entries: %d\n", ext_sg_entries,
1724 CTL_DEBUG_PRINT(("ctl_ioctl_do_datamove: ext_data_len = %d, "
1725 "kern_data_len = %d\n", ctsio->ext_data_len,
1726 ctsio->kern_data_len));
1729 /* XXX KDM set residual?? */
1732 if (ext_sglist_malloced != 0)
1733 free(ext_sglist, M_CTL);
1735 return (CTL_RETVAL_COMPLETE);
1739 * Serialize a command that went down the "wrong" side, and so was sent to
1740 * this controller for execution. The logic is a little different than the
1741 * standard case in ctl_scsiio_precheck(). Errors in this case need to get
1742 * sent back to the other side, but in the success case, we execute the
1743 * command on this side (XFER mode) or tell the other side to execute it
1747 ctl_serialize_other_sc_cmd(struct ctl_scsiio *ctsio)
1749 struct ctl_softc *ctl_softc;
1750 union ctl_ha_msg msg_info;
1751 struct ctl_lun *lun;
1755 ctl_softc = control_softc;
1757 targ_lun = ctsio->io_hdr.nexus.targ_mapped_lun;
1758 lun = ctl_softc->ctl_luns[targ_lun];
1762 * Why isn't LUN defined? The other side wouldn't
1763 * send a cmd if the LUN is undefined.
1765 printf("%s: Bad JUJU!, LUN is NULL!\n", __func__);
1767 /* "Logical unit not supported" */
1768 ctl_set_sense_data(&msg_info.scsi.sense_data,
1770 /*sense_format*/SSD_TYPE_NONE,
1771 /*current_error*/ 1,
1772 /*sense_key*/ SSD_KEY_ILLEGAL_REQUEST,
1777 msg_info.scsi.sense_len = SSD_FULL_SIZE;
1778 msg_info.scsi.scsi_status = SCSI_STATUS_CHECK_COND;
1779 msg_info.hdr.status = CTL_SCSI_ERROR | CTL_AUTOSENSE;
1780 msg_info.hdr.original_sc = ctsio->io_hdr.original_sc;
1781 msg_info.hdr.serializing_sc = NULL;
1782 msg_info.hdr.msg_type = CTL_MSG_BAD_JUJU;
1783 if (ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg_info,
1784 sizeof(msg_info), 0 ) > CTL_HA_STATUS_SUCCESS) {
1790 mtx_lock(&lun->lun_lock);
1791 TAILQ_INSERT_TAIL(&lun->ooa_queue, &ctsio->io_hdr, ooa_links);
1793 switch (ctl_check_ooa(lun, (union ctl_io *)ctsio,
1794 (union ctl_io *)TAILQ_PREV(&ctsio->io_hdr, ctl_ooaq,
1796 case CTL_ACTION_BLOCK:
1797 ctsio->io_hdr.flags |= CTL_FLAG_BLOCKED;
1798 TAILQ_INSERT_TAIL(&lun->blocked_queue, &ctsio->io_hdr,
1801 case CTL_ACTION_PASS:
1802 case CTL_ACTION_SKIP:
1803 if (ctl_softc->ha_mode == CTL_HA_MODE_XFER) {
1804 ctsio->io_hdr.flags |= CTL_FLAG_IS_WAS_ON_RTR;
1805 ctl_enqueue_rtr((union ctl_io *)ctsio);
1808 /* send msg back to other side */
1809 msg_info.hdr.original_sc = ctsio->io_hdr.original_sc;
1810 msg_info.hdr.serializing_sc = (union ctl_io *)ctsio;
1811 msg_info.hdr.msg_type = CTL_MSG_R2R;
1813 printf("2. pOrig %x\n", (int)msg_info.hdr.original_sc);
1815 if (ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg_info,
1816 sizeof(msg_info), 0 ) > CTL_HA_STATUS_SUCCESS) {
1820 case CTL_ACTION_OVERLAP:
1821 /* OVERLAPPED COMMANDS ATTEMPTED */
1822 ctl_set_sense_data(&msg_info.scsi.sense_data,
1824 /*sense_format*/SSD_TYPE_NONE,
1825 /*current_error*/ 1,
1826 /*sense_key*/ SSD_KEY_ILLEGAL_REQUEST,
1831 msg_info.scsi.sense_len = SSD_FULL_SIZE;
1832 msg_info.scsi.scsi_status = SCSI_STATUS_CHECK_COND;
1833 msg_info.hdr.status = CTL_SCSI_ERROR | CTL_AUTOSENSE;
1834 msg_info.hdr.original_sc = ctsio->io_hdr.original_sc;
1835 msg_info.hdr.serializing_sc = NULL;
1836 msg_info.hdr.msg_type = CTL_MSG_BAD_JUJU;
1838 printf("BAD JUJU:Major Bummer Overlap\n");
1840 TAILQ_REMOVE(&lun->ooa_queue, &ctsio->io_hdr, ooa_links);
1842 if (ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg_info,
1843 sizeof(msg_info), 0 ) > CTL_HA_STATUS_SUCCESS) {
1846 case CTL_ACTION_OVERLAP_TAG:
1847 /* TAGGED OVERLAPPED COMMANDS (NN = QUEUE TAG) */
1848 ctl_set_sense_data(&msg_info.scsi.sense_data,
1850 /*sense_format*/SSD_TYPE_NONE,
1851 /*current_error*/ 1,
1852 /*sense_key*/ SSD_KEY_ILLEGAL_REQUEST,
1854 /*ascq*/ ctsio->tag_num & 0xff,
1857 msg_info.scsi.sense_len = SSD_FULL_SIZE;
1858 msg_info.scsi.scsi_status = SCSI_STATUS_CHECK_COND;
1859 msg_info.hdr.status = CTL_SCSI_ERROR | CTL_AUTOSENSE;
1860 msg_info.hdr.original_sc = ctsio->io_hdr.original_sc;
1861 msg_info.hdr.serializing_sc = NULL;
1862 msg_info.hdr.msg_type = CTL_MSG_BAD_JUJU;
1864 printf("BAD JUJU:Major Bummer Overlap Tag\n");
1866 TAILQ_REMOVE(&lun->ooa_queue, &ctsio->io_hdr, ooa_links);
1868 if (ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg_info,
1869 sizeof(msg_info), 0 ) > CTL_HA_STATUS_SUCCESS) {
1872 case CTL_ACTION_ERROR:
1874 /* "Internal target failure" */
1875 ctl_set_sense_data(&msg_info.scsi.sense_data,
1877 /*sense_format*/SSD_TYPE_NONE,
1878 /*current_error*/ 1,
1879 /*sense_key*/ SSD_KEY_HARDWARE_ERROR,
1884 msg_info.scsi.sense_len = SSD_FULL_SIZE;
1885 msg_info.scsi.scsi_status = SCSI_STATUS_CHECK_COND;
1886 msg_info.hdr.status = CTL_SCSI_ERROR | CTL_AUTOSENSE;
1887 msg_info.hdr.original_sc = ctsio->io_hdr.original_sc;
1888 msg_info.hdr.serializing_sc = NULL;
1889 msg_info.hdr.msg_type = CTL_MSG_BAD_JUJU;
1891 printf("BAD JUJU:Major Bummer HW Error\n");
1893 TAILQ_REMOVE(&lun->ooa_queue, &ctsio->io_hdr, ooa_links);
1895 if (ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg_info,
1896 sizeof(msg_info), 0 ) > CTL_HA_STATUS_SUCCESS) {
1900 mtx_unlock(&lun->lun_lock);
1905 ctl_ioctl_submit_wait(union ctl_io *io)
1907 struct ctl_fe_ioctl_params params;
1908 ctl_fe_ioctl_state last_state;
1913 bzero(¶ms, sizeof(params));
1915 mtx_init(¶ms.ioctl_mtx, "ctliocmtx", NULL, MTX_DEF);
1916 cv_init(¶ms.sem, "ctlioccv");
1917 params.state = CTL_IOCTL_INPROG;
1918 last_state = params.state;
1920 io->io_hdr.ctl_private[CTL_PRIV_FRONTEND].ptr = ¶ms;
1922 CTL_DEBUG_PRINT(("ctl_ioctl_submit_wait\n"));
1924 /* This shouldn't happen */
1925 if ((retval = ctl_queue(io)) != CTL_RETVAL_COMPLETE)
1931 mtx_lock(¶ms.ioctl_mtx);
1933 * Check the state here, and don't sleep if the state has
1934 * already changed (i.e. wakeup has already occured, but we
1935 * weren't waiting yet).
1937 if (params.state == last_state) {
1938 /* XXX KDM cv_wait_sig instead? */
1939 cv_wait(¶ms.sem, ¶ms.ioctl_mtx);
1941 last_state = params.state;
1943 switch (params.state) {
1944 case CTL_IOCTL_INPROG:
1945 /* Why did we wake up? */
1946 /* XXX KDM error here? */
1947 mtx_unlock(¶ms.ioctl_mtx);
1949 case CTL_IOCTL_DATAMOVE:
1950 CTL_DEBUG_PRINT(("got CTL_IOCTL_DATAMOVE\n"));
1953 * change last_state back to INPROG to avoid
1954 * deadlock on subsequent data moves.
1956 params.state = last_state = CTL_IOCTL_INPROG;
1958 mtx_unlock(¶ms.ioctl_mtx);
1959 ctl_ioctl_do_datamove(&io->scsiio);
1961 * Note that in some cases, most notably writes,
1962 * this will queue the I/O and call us back later.
1963 * In other cases, generally reads, this routine
1964 * will immediately call back and wake us up,
1965 * probably using our own context.
1967 io->scsiio.be_move_done(io);
1969 case CTL_IOCTL_DONE:
1970 mtx_unlock(¶ms.ioctl_mtx);
1971 CTL_DEBUG_PRINT(("got CTL_IOCTL_DONE\n"));
1975 mtx_unlock(¶ms.ioctl_mtx);
1976 /* XXX KDM error here? */
1979 } while (done == 0);
1981 mtx_destroy(¶ms.ioctl_mtx);
1982 cv_destroy(¶ms.sem);
1984 return (CTL_RETVAL_COMPLETE);
1988 ctl_ioctl_datamove(union ctl_io *io)
1990 struct ctl_fe_ioctl_params *params;
1992 params = (struct ctl_fe_ioctl_params *)
1993 io->io_hdr.ctl_private[CTL_PRIV_FRONTEND].ptr;
1995 mtx_lock(¶ms->ioctl_mtx);
1996 params->state = CTL_IOCTL_DATAMOVE;
1997 cv_broadcast(¶ms->sem);
1998 mtx_unlock(¶ms->ioctl_mtx);
2002 ctl_ioctl_done(union ctl_io *io)
2004 struct ctl_fe_ioctl_params *params;
2006 params = (struct ctl_fe_ioctl_params *)
2007 io->io_hdr.ctl_private[CTL_PRIV_FRONTEND].ptr;
2009 mtx_lock(¶ms->ioctl_mtx);
2010 params->state = CTL_IOCTL_DONE;
2011 cv_broadcast(¶ms->sem);
2012 mtx_unlock(¶ms->ioctl_mtx);
2016 ctl_ioctl_hard_startstop_callback(void *arg, struct cfi_metatask *metatask)
2018 struct ctl_fe_ioctl_startstop_info *sd_info;
2020 sd_info = (struct ctl_fe_ioctl_startstop_info *)arg;
2022 sd_info->hs_info.status = metatask->status;
2023 sd_info->hs_info.total_luns = metatask->taskinfo.startstop.total_luns;
2024 sd_info->hs_info.luns_complete =
2025 metatask->taskinfo.startstop.luns_complete;
2026 sd_info->hs_info.luns_failed = metatask->taskinfo.startstop.luns_failed;
2028 cv_broadcast(&sd_info->sem);
2032 ctl_ioctl_bbrread_callback(void *arg, struct cfi_metatask *metatask)
2034 struct ctl_fe_ioctl_bbrread_info *fe_bbr_info;
2036 fe_bbr_info = (struct ctl_fe_ioctl_bbrread_info *)arg;
2038 mtx_lock(fe_bbr_info->lock);
2039 fe_bbr_info->bbr_info->status = metatask->status;
2040 fe_bbr_info->bbr_info->bbr_status = metatask->taskinfo.bbrread.status;
2041 fe_bbr_info->wakeup_done = 1;
2042 mtx_unlock(fe_bbr_info->lock);
2044 cv_broadcast(&fe_bbr_info->sem);
2048 * Returns 0 for success, errno for failure.
2051 ctl_ioctl_fill_ooa(struct ctl_lun *lun, uint32_t *cur_fill_num,
2052 struct ctl_ooa *ooa_hdr, struct ctl_ooa_entry *kern_entries)
2059 mtx_lock(&lun->lun_lock);
2060 for (io = (union ctl_io *)TAILQ_FIRST(&lun->ooa_queue); (io != NULL);
2061 (*cur_fill_num)++, io = (union ctl_io *)TAILQ_NEXT(&io->io_hdr,
2063 struct ctl_ooa_entry *entry;
2066 * If we've got more than we can fit, just count the
2067 * remaining entries.
2069 if (*cur_fill_num >= ooa_hdr->alloc_num)
2072 entry = &kern_entries[*cur_fill_num];
2074 entry->tag_num = io->scsiio.tag_num;
2075 entry->lun_num = lun->lun;
2077 entry->start_bt = io->io_hdr.start_bt;
2079 bcopy(io->scsiio.cdb, entry->cdb, io->scsiio.cdb_len);
2080 entry->cdb_len = io->scsiio.cdb_len;
2081 if (io->io_hdr.flags & CTL_FLAG_BLOCKED)
2082 entry->cmd_flags |= CTL_OOACMD_FLAG_BLOCKED;
2084 if (io->io_hdr.flags & CTL_FLAG_DMA_INPROG)
2085 entry->cmd_flags |= CTL_OOACMD_FLAG_DMA;
2087 if (io->io_hdr.flags & CTL_FLAG_ABORT)
2088 entry->cmd_flags |= CTL_OOACMD_FLAG_ABORT;
2090 if (io->io_hdr.flags & CTL_FLAG_IS_WAS_ON_RTR)
2091 entry->cmd_flags |= CTL_OOACMD_FLAG_RTR;
2093 if (io->io_hdr.flags & CTL_FLAG_DMA_QUEUED)
2094 entry->cmd_flags |= CTL_OOACMD_FLAG_DMA_QUEUED;
2096 mtx_unlock(&lun->lun_lock);
2102 ctl_copyin_alloc(void *user_addr, int len, char *error_str,
2103 size_t error_str_len)
2107 kptr = malloc(len, M_CTL, M_WAITOK | M_ZERO);
2109 if (copyin(user_addr, kptr, len) != 0) {
2110 snprintf(error_str, error_str_len, "Error copying %d bytes "
2111 "from user address %p to kernel address %p", len,
2121 ctl_free_args(int num_args, struct ctl_be_arg *args)
2128 for (i = 0; i < num_args; i++) {
2129 free(args[i].kname, M_CTL);
2130 free(args[i].kvalue, M_CTL);
2136 static struct ctl_be_arg *
2137 ctl_copyin_args(int num_args, struct ctl_be_arg *uargs,
2138 char *error_str, size_t error_str_len)
2140 struct ctl_be_arg *args;
2143 args = ctl_copyin_alloc(uargs, num_args * sizeof(*args),
2144 error_str, error_str_len);
2149 for (i = 0; i < num_args; i++) {
2150 args[i].kname = NULL;
2151 args[i].kvalue = NULL;
2154 for (i = 0; i < num_args; i++) {
2157 args[i].kname = ctl_copyin_alloc(args[i].name,
2158 args[i].namelen, error_str, error_str_len);
2159 if (args[i].kname == NULL)
2162 if (args[i].kname[args[i].namelen - 1] != '\0') {
2163 snprintf(error_str, error_str_len, "Argument %d "
2164 "name is not NUL-terminated", i);
2168 if (args[i].flags & CTL_BEARG_RD) {
2169 tmpptr = ctl_copyin_alloc(args[i].value,
2170 args[i].vallen, error_str, error_str_len);
2173 if ((args[i].flags & CTL_BEARG_ASCII)
2174 && (tmpptr[args[i].vallen - 1] != '\0')) {
2175 snprintf(error_str, error_str_len, "Argument "
2176 "%d value is not NUL-terminated", i);
2179 args[i].kvalue = tmpptr;
2181 args[i].kvalue = malloc(args[i].vallen,
2182 M_CTL, M_WAITOK | M_ZERO);
2189 ctl_free_args(num_args, args);
2195 ctl_copyout_args(int num_args, struct ctl_be_arg *args)
2199 for (i = 0; i < num_args; i++) {
2200 if (args[i].flags & CTL_BEARG_WR)
2201 copyout(args[i].kvalue, args[i].value, args[i].vallen);
2206 * Escape characters that are illegal or not recommended in XML.
2209 ctl_sbuf_printf_esc(struct sbuf *sb, char *str)
2215 for (; *str; str++) {
2218 retval = sbuf_printf(sb, "&");
2221 retval = sbuf_printf(sb, ">");
2224 retval = sbuf_printf(sb, "<");
2227 retval = sbuf_putc(sb, *str);
2240 ctl_ioctl(struct cdev *dev, u_long cmd, caddr_t addr, int flag,
2243 struct ctl_softc *softc;
2246 softc = control_softc;
2256 * If we haven't been "enabled", don't allow any SCSI I/O
2259 if ((softc->ioctl_info.flags & CTL_IOCTL_FLAG_ENABLED) == 0) {
2264 io = ctl_alloc_io(softc->ioctl_info.port.ctl_pool_ref);
2266 printf("ctl_ioctl: can't allocate ctl_io!\n");
2272 * Need to save the pool reference so it doesn't get
2273 * spammed by the user's ctl_io.
2275 pool_tmp = io->io_hdr.pool;
2277 memcpy(io, (void *)addr, sizeof(*io));
2279 io->io_hdr.pool = pool_tmp;
2281 * No status yet, so make sure the status is set properly.
2283 io->io_hdr.status = CTL_STATUS_NONE;
2286 * The user sets the initiator ID, target and LUN IDs.
2288 io->io_hdr.nexus.targ_port = softc->ioctl_info.port.targ_port;
2289 io->io_hdr.flags |= CTL_FLAG_USER_REQ;
2290 if ((io->io_hdr.io_type == CTL_IO_SCSI)
2291 && (io->scsiio.tag_type != CTL_TAG_UNTAGGED))
2292 io->scsiio.tag_num = softc->ioctl_info.cur_tag_num++;
2294 retval = ctl_ioctl_submit_wait(io);
2301 memcpy((void *)addr, io, sizeof(*io));
2303 /* return this to our pool */
2308 case CTL_ENABLE_PORT:
2309 case CTL_DISABLE_PORT:
2310 case CTL_SET_PORT_WWNS: {
2311 struct ctl_port *port;
2312 struct ctl_port_entry *entry;
2314 entry = (struct ctl_port_entry *)addr;
2316 mtx_lock(&softc->ctl_lock);
2317 STAILQ_FOREACH(port, &softc->port_list, links) {
2323 if ((entry->port_type == CTL_PORT_NONE)
2324 && (entry->targ_port == port->targ_port)) {
2326 * If the user only wants to enable or
2327 * disable or set WWNs on a specific port,
2328 * do the operation and we're done.
2332 } else if (entry->port_type & port->port_type) {
2334 * Compare the user's type mask with the
2335 * particular frontend type to see if we
2342 * Make sure the user isn't trying to set
2343 * WWNs on multiple ports at the same time.
2345 if (cmd == CTL_SET_PORT_WWNS) {
2346 printf("%s: Can't set WWNs on "
2347 "multiple ports\n", __func__);
2354 * XXX KDM we have to drop the lock here,
2355 * because the online/offline operations
2356 * can potentially block. We need to
2357 * reference count the frontends so they
2360 mtx_unlock(&softc->ctl_lock);
2362 if (cmd == CTL_ENABLE_PORT) {
2363 struct ctl_lun *lun;
2365 STAILQ_FOREACH(lun, &softc->lun_list,
2367 port->lun_enable(port->targ_lun_arg,
2372 ctl_port_online(port);
2373 } else if (cmd == CTL_DISABLE_PORT) {
2374 struct ctl_lun *lun;
2376 ctl_port_offline(port);
2378 STAILQ_FOREACH(lun, &softc->lun_list,
2387 mtx_lock(&softc->ctl_lock);
2389 if (cmd == CTL_SET_PORT_WWNS)
2390 ctl_port_set_wwns(port,
2391 (entry->flags & CTL_PORT_WWNN_VALID) ?
2393 (entry->flags & CTL_PORT_WWPN_VALID) ?
2394 1 : 0, entry->wwpn);
2399 mtx_unlock(&softc->ctl_lock);
2402 case CTL_GET_PORT_LIST: {
2403 struct ctl_port *port;
2404 struct ctl_port_list *list;
2407 list = (struct ctl_port_list *)addr;
2409 if (list->alloc_len != (list->alloc_num *
2410 sizeof(struct ctl_port_entry))) {
2411 printf("%s: CTL_GET_PORT_LIST: alloc_len %u != "
2412 "alloc_num %u * sizeof(struct ctl_port_entry) "
2413 "%zu\n", __func__, list->alloc_len,
2414 list->alloc_num, sizeof(struct ctl_port_entry));
2420 list->dropped_num = 0;
2422 mtx_lock(&softc->ctl_lock);
2423 STAILQ_FOREACH(port, &softc->port_list, links) {
2424 struct ctl_port_entry entry, *list_entry;
2426 if (list->fill_num >= list->alloc_num) {
2427 list->dropped_num++;
2431 entry.port_type = port->port_type;
2432 strlcpy(entry.port_name, port->port_name,
2433 sizeof(entry.port_name));
2434 entry.targ_port = port->targ_port;
2435 entry.physical_port = port->physical_port;
2436 entry.virtual_port = port->virtual_port;
2437 entry.wwnn = port->wwnn;
2438 entry.wwpn = port->wwpn;
2439 if (port->status & CTL_PORT_STATUS_ONLINE)
2444 list_entry = &list->entries[i];
2446 retval = copyout(&entry, list_entry, sizeof(entry));
2448 printf("%s: CTL_GET_PORT_LIST: copyout "
2449 "returned %d\n", __func__, retval);
2454 list->fill_len += sizeof(entry);
2456 mtx_unlock(&softc->ctl_lock);
2459 * If this is non-zero, we had a copyout fault, so there's
2460 * probably no point in attempting to set the status inside
2466 if (list->dropped_num > 0)
2467 list->status = CTL_PORT_LIST_NEED_MORE_SPACE;
2469 list->status = CTL_PORT_LIST_OK;
2472 case CTL_DUMP_OOA: {
2473 struct ctl_lun *lun;
2478 mtx_lock(&softc->ctl_lock);
2479 printf("Dumping OOA queues:\n");
2480 STAILQ_FOREACH(lun, &softc->lun_list, links) {
2481 mtx_lock(&lun->lun_lock);
2482 for (io = (union ctl_io *)TAILQ_FIRST(
2483 &lun->ooa_queue); io != NULL;
2484 io = (union ctl_io *)TAILQ_NEXT(&io->io_hdr,
2486 sbuf_new(&sb, printbuf, sizeof(printbuf),
2488 sbuf_printf(&sb, "LUN %jd tag 0x%04x%s%s%s%s: ",
2492 CTL_FLAG_BLOCKED) ? "" : " BLOCKED",
2494 CTL_FLAG_DMA_INPROG) ? " DMA" : "",
2496 CTL_FLAG_ABORT) ? " ABORT" : "",
2498 CTL_FLAG_IS_WAS_ON_RTR) ? " RTR" : "");
2499 ctl_scsi_command_string(&io->scsiio, NULL, &sb);
2501 printf("%s\n", sbuf_data(&sb));
2503 mtx_unlock(&lun->lun_lock);
2505 printf("OOA queues dump done\n");
2506 mtx_unlock(&softc->ctl_lock);
2510 struct ctl_lun *lun;
2511 struct ctl_ooa *ooa_hdr;
2512 struct ctl_ooa_entry *entries;
2513 uint32_t cur_fill_num;
2515 ooa_hdr = (struct ctl_ooa *)addr;
2517 if ((ooa_hdr->alloc_len == 0)
2518 || (ooa_hdr->alloc_num == 0)) {
2519 printf("%s: CTL_GET_OOA: alloc len %u and alloc num %u "
2520 "must be non-zero\n", __func__,
2521 ooa_hdr->alloc_len, ooa_hdr->alloc_num);
2526 if (ooa_hdr->alloc_len != (ooa_hdr->alloc_num *
2527 sizeof(struct ctl_ooa_entry))) {
2528 printf("%s: CTL_GET_OOA: alloc len %u must be alloc "
2529 "num %d * sizeof(struct ctl_ooa_entry) %zd\n",
2530 __func__, ooa_hdr->alloc_len,
2531 ooa_hdr->alloc_num,sizeof(struct ctl_ooa_entry));
2536 entries = malloc(ooa_hdr->alloc_len, M_CTL, M_WAITOK | M_ZERO);
2537 if (entries == NULL) {
2538 printf("%s: could not allocate %d bytes for OOA "
2539 "dump\n", __func__, ooa_hdr->alloc_len);
2544 mtx_lock(&softc->ctl_lock);
2545 if (((ooa_hdr->flags & CTL_OOA_FLAG_ALL_LUNS) == 0)
2546 && ((ooa_hdr->lun_num > CTL_MAX_LUNS)
2547 || (softc->ctl_luns[ooa_hdr->lun_num] == NULL))) {
2548 mtx_unlock(&softc->ctl_lock);
2549 free(entries, M_CTL);
2550 printf("%s: CTL_GET_OOA: invalid LUN %ju\n",
2551 __func__, (uintmax_t)ooa_hdr->lun_num);
2558 if (ooa_hdr->flags & CTL_OOA_FLAG_ALL_LUNS) {
2559 STAILQ_FOREACH(lun, &softc->lun_list, links) {
2560 retval = ctl_ioctl_fill_ooa(lun, &cur_fill_num,
2566 mtx_unlock(&softc->ctl_lock);
2567 free(entries, M_CTL);
2571 lun = softc->ctl_luns[ooa_hdr->lun_num];
2573 retval = ctl_ioctl_fill_ooa(lun, &cur_fill_num,ooa_hdr,
2576 mtx_unlock(&softc->ctl_lock);
2578 ooa_hdr->fill_num = min(cur_fill_num, ooa_hdr->alloc_num);
2579 ooa_hdr->fill_len = ooa_hdr->fill_num *
2580 sizeof(struct ctl_ooa_entry);
2581 retval = copyout(entries, ooa_hdr->entries, ooa_hdr->fill_len);
2583 printf("%s: error copying out %d bytes for OOA dump\n",
2584 __func__, ooa_hdr->fill_len);
2587 getbintime(&ooa_hdr->cur_bt);
2589 if (cur_fill_num > ooa_hdr->alloc_num) {
2590 ooa_hdr->dropped_num = cur_fill_num -ooa_hdr->alloc_num;
2591 ooa_hdr->status = CTL_OOA_NEED_MORE_SPACE;
2593 ooa_hdr->dropped_num = 0;
2594 ooa_hdr->status = CTL_OOA_OK;
2597 free(entries, M_CTL);
2600 case CTL_CHECK_OOA: {
2602 struct ctl_lun *lun;
2603 struct ctl_ooa_info *ooa_info;
2606 ooa_info = (struct ctl_ooa_info *)addr;
2608 if (ooa_info->lun_id >= CTL_MAX_LUNS) {
2609 ooa_info->status = CTL_OOA_INVALID_LUN;
2612 mtx_lock(&softc->ctl_lock);
2613 lun = softc->ctl_luns[ooa_info->lun_id];
2615 mtx_unlock(&softc->ctl_lock);
2616 ooa_info->status = CTL_OOA_INVALID_LUN;
2619 mtx_lock(&lun->lun_lock);
2620 mtx_unlock(&softc->ctl_lock);
2621 ooa_info->num_entries = 0;
2622 for (io = (union ctl_io *)TAILQ_FIRST(&lun->ooa_queue);
2623 io != NULL; io = (union ctl_io *)TAILQ_NEXT(
2624 &io->io_hdr, ooa_links)) {
2625 ooa_info->num_entries++;
2627 mtx_unlock(&lun->lun_lock);
2629 ooa_info->status = CTL_OOA_SUCCESS;
2633 case CTL_HARD_START:
2634 case CTL_HARD_STOP: {
2635 struct ctl_fe_ioctl_startstop_info ss_info;
2636 struct cfi_metatask *metatask;
2639 mtx_init(&hs_mtx, "HS Mutex", NULL, MTX_DEF);
2641 cv_init(&ss_info.sem, "hard start/stop cv" );
2643 metatask = cfi_alloc_metatask(/*can_wait*/ 1);
2644 if (metatask == NULL) {
2646 mtx_destroy(&hs_mtx);
2650 if (cmd == CTL_HARD_START)
2651 metatask->tasktype = CFI_TASK_STARTUP;
2653 metatask->tasktype = CFI_TASK_SHUTDOWN;
2655 metatask->callback = ctl_ioctl_hard_startstop_callback;
2656 metatask->callback_arg = &ss_info;
2658 cfi_action(metatask);
2660 /* Wait for the callback */
2662 cv_wait_sig(&ss_info.sem, &hs_mtx);
2663 mtx_unlock(&hs_mtx);
2666 * All information has been copied from the metatask by the
2667 * time cv_broadcast() is called, so we free the metatask here.
2669 cfi_free_metatask(metatask);
2671 memcpy((void *)addr, &ss_info.hs_info, sizeof(ss_info.hs_info));
2673 mtx_destroy(&hs_mtx);
2677 struct ctl_bbrread_info *bbr_info;
2678 struct ctl_fe_ioctl_bbrread_info fe_bbr_info;
2680 struct cfi_metatask *metatask;
2682 bbr_info = (struct ctl_bbrread_info *)addr;
2684 bzero(&fe_bbr_info, sizeof(fe_bbr_info));
2686 bzero(&bbr_mtx, sizeof(bbr_mtx));
2687 mtx_init(&bbr_mtx, "BBR Mutex", NULL, MTX_DEF);
2689 fe_bbr_info.bbr_info = bbr_info;
2690 fe_bbr_info.lock = &bbr_mtx;
2692 cv_init(&fe_bbr_info.sem, "BBR read cv");
2693 metatask = cfi_alloc_metatask(/*can_wait*/ 1);
2695 if (metatask == NULL) {
2696 mtx_destroy(&bbr_mtx);
2697 cv_destroy(&fe_bbr_info.sem);
2701 metatask->tasktype = CFI_TASK_BBRREAD;
2702 metatask->callback = ctl_ioctl_bbrread_callback;
2703 metatask->callback_arg = &fe_bbr_info;
2704 metatask->taskinfo.bbrread.lun_num = bbr_info->lun_num;
2705 metatask->taskinfo.bbrread.lba = bbr_info->lba;
2706 metatask->taskinfo.bbrread.len = bbr_info->len;
2708 cfi_action(metatask);
2711 while (fe_bbr_info.wakeup_done == 0)
2712 cv_wait_sig(&fe_bbr_info.sem, &bbr_mtx);
2713 mtx_unlock(&bbr_mtx);
2715 bbr_info->status = metatask->status;
2716 bbr_info->bbr_status = metatask->taskinfo.bbrread.status;
2717 bbr_info->scsi_status = metatask->taskinfo.bbrread.scsi_status;
2718 memcpy(&bbr_info->sense_data,
2719 &metatask->taskinfo.bbrread.sense_data,
2720 ctl_min(sizeof(bbr_info->sense_data),
2721 sizeof(metatask->taskinfo.bbrread.sense_data)));
2723 cfi_free_metatask(metatask);
2725 mtx_destroy(&bbr_mtx);
2726 cv_destroy(&fe_bbr_info.sem);
2730 case CTL_DELAY_IO: {
2731 struct ctl_io_delay_info *delay_info;
2733 struct ctl_lun *lun;
2734 #endif /* CTL_IO_DELAY */
2736 delay_info = (struct ctl_io_delay_info *)addr;
2739 mtx_lock(&softc->ctl_lock);
2741 if ((delay_info->lun_id > CTL_MAX_LUNS)
2742 || (softc->ctl_luns[delay_info->lun_id] == NULL)) {
2743 delay_info->status = CTL_DELAY_STATUS_INVALID_LUN;
2745 lun = softc->ctl_luns[delay_info->lun_id];
2746 mtx_lock(&lun->lun_lock);
2748 delay_info->status = CTL_DELAY_STATUS_OK;
2750 switch (delay_info->delay_type) {
2751 case CTL_DELAY_TYPE_CONT:
2753 case CTL_DELAY_TYPE_ONESHOT:
2756 delay_info->status =
2757 CTL_DELAY_STATUS_INVALID_TYPE;
2761 switch (delay_info->delay_loc) {
2762 case CTL_DELAY_LOC_DATAMOVE:
2763 lun->delay_info.datamove_type =
2764 delay_info->delay_type;
2765 lun->delay_info.datamove_delay =
2766 delay_info->delay_secs;
2768 case CTL_DELAY_LOC_DONE:
2769 lun->delay_info.done_type =
2770 delay_info->delay_type;
2771 lun->delay_info.done_delay =
2772 delay_info->delay_secs;
2775 delay_info->status =
2776 CTL_DELAY_STATUS_INVALID_LOC;
2779 mtx_unlock(&lun->lun_lock);
2782 mtx_unlock(&softc->ctl_lock);
2784 delay_info->status = CTL_DELAY_STATUS_NOT_IMPLEMENTED;
2785 #endif /* CTL_IO_DELAY */
2788 case CTL_REALSYNC_SET: {
2791 syncstate = (int *)addr;
2793 mtx_lock(&softc->ctl_lock);
2794 switch (*syncstate) {
2796 softc->flags &= ~CTL_FLAG_REAL_SYNC;
2799 softc->flags |= CTL_FLAG_REAL_SYNC;
2805 mtx_unlock(&softc->ctl_lock);
2808 case CTL_REALSYNC_GET: {
2811 syncstate = (int*)addr;
2813 mtx_lock(&softc->ctl_lock);
2814 if (softc->flags & CTL_FLAG_REAL_SYNC)
2818 mtx_unlock(&softc->ctl_lock);
2824 struct ctl_sync_info *sync_info;
2825 struct ctl_lun *lun;
2827 sync_info = (struct ctl_sync_info *)addr;
2829 mtx_lock(&softc->ctl_lock);
2830 lun = softc->ctl_luns[sync_info->lun_id];
2832 mtx_unlock(&softc->ctl_lock);
2833 sync_info->status = CTL_GS_SYNC_NO_LUN;
2836 * Get or set the sync interval. We're not bounds checking
2837 * in the set case, hopefully the user won't do something
2840 mtx_lock(&lun->lun_lock);
2841 mtx_unlock(&softc->ctl_lock);
2842 if (cmd == CTL_GETSYNC)
2843 sync_info->sync_interval = lun->sync_interval;
2845 lun->sync_interval = sync_info->sync_interval;
2846 mtx_unlock(&lun->lun_lock);
2848 sync_info->status = CTL_GS_SYNC_OK;
2852 case CTL_GETSTATS: {
2853 struct ctl_stats *stats;
2854 struct ctl_lun *lun;
2857 stats = (struct ctl_stats *)addr;
2859 if ((sizeof(struct ctl_lun_io_stats) * softc->num_luns) >
2861 stats->status = CTL_SS_NEED_MORE_SPACE;
2862 stats->num_luns = softc->num_luns;
2866 * XXX KDM no locking here. If the LUN list changes,
2867 * things can blow up.
2869 for (i = 0, lun = STAILQ_FIRST(&softc->lun_list); lun != NULL;
2870 i++, lun = STAILQ_NEXT(lun, links)) {
2871 retval = copyout(&lun->stats, &stats->lun_stats[i],
2872 sizeof(lun->stats));
2876 stats->num_luns = softc->num_luns;
2877 stats->fill_len = sizeof(struct ctl_lun_io_stats) *
2879 stats->status = CTL_SS_OK;
2881 stats->flags = CTL_STATS_FLAG_TIME_VALID;
2883 stats->flags = CTL_STATS_FLAG_NONE;
2885 getnanouptime(&stats->timestamp);
2888 case CTL_ERROR_INJECT: {
2889 struct ctl_error_desc *err_desc, *new_err_desc;
2890 struct ctl_lun *lun;
2892 err_desc = (struct ctl_error_desc *)addr;
2894 new_err_desc = malloc(sizeof(*new_err_desc), M_CTL,
2896 bcopy(err_desc, new_err_desc, sizeof(*new_err_desc));
2898 mtx_lock(&softc->ctl_lock);
2899 lun = softc->ctl_luns[err_desc->lun_id];
2901 mtx_unlock(&softc->ctl_lock);
2902 printf("%s: CTL_ERROR_INJECT: invalid LUN %ju\n",
2903 __func__, (uintmax_t)err_desc->lun_id);
2907 mtx_lock(&lun->lun_lock);
2908 mtx_unlock(&softc->ctl_lock);
2911 * We could do some checking here to verify the validity
2912 * of the request, but given the complexity of error
2913 * injection requests, the checking logic would be fairly
2916 * For now, if the request is invalid, it just won't get
2917 * executed and might get deleted.
2919 STAILQ_INSERT_TAIL(&lun->error_list, new_err_desc, links);
2922 * XXX KDM check to make sure the serial number is unique,
2923 * in case we somehow manage to wrap. That shouldn't
2924 * happen for a very long time, but it's the right thing to
2927 new_err_desc->serial = lun->error_serial;
2928 err_desc->serial = lun->error_serial;
2929 lun->error_serial++;
2931 mtx_unlock(&lun->lun_lock);
2934 case CTL_ERROR_INJECT_DELETE: {
2935 struct ctl_error_desc *delete_desc, *desc, *desc2;
2936 struct ctl_lun *lun;
2939 delete_desc = (struct ctl_error_desc *)addr;
2942 mtx_lock(&softc->ctl_lock);
2943 lun = softc->ctl_luns[delete_desc->lun_id];
2945 mtx_unlock(&softc->ctl_lock);
2946 printf("%s: CTL_ERROR_INJECT_DELETE: invalid LUN %ju\n",
2947 __func__, (uintmax_t)delete_desc->lun_id);
2951 mtx_lock(&lun->lun_lock);
2952 mtx_unlock(&softc->ctl_lock);
2953 STAILQ_FOREACH_SAFE(desc, &lun->error_list, links, desc2) {
2954 if (desc->serial != delete_desc->serial)
2957 STAILQ_REMOVE(&lun->error_list, desc, ctl_error_desc,
2962 mtx_unlock(&lun->lun_lock);
2963 if (delete_done == 0) {
2964 printf("%s: CTL_ERROR_INJECT_DELETE: can't find "
2965 "error serial %ju on LUN %u\n", __func__,
2966 delete_desc->serial, delete_desc->lun_id);
2972 case CTL_DUMP_STRUCTS: {
2974 struct ctl_port *port;
2975 struct ctl_frontend *fe;
2977 mtx_lock(&softc->ctl_lock);
2978 printf("CTL Persistent Reservation information start:\n");
2979 for (i = 0; i < CTL_MAX_LUNS; i++) {
2980 struct ctl_lun *lun;
2982 lun = softc->ctl_luns[i];
2985 || ((lun->flags & CTL_LUN_DISABLED) != 0))
2988 for (j = 0; j < (CTL_MAX_PORTS * 2); j++) {
2989 for (k = 0; k < CTL_MAX_INIT_PER_PORT; k++){
2990 idx = j * CTL_MAX_INIT_PER_PORT + k;
2991 if (lun->per_res[idx].registered == 0)
2993 printf(" LUN %d port %d iid %d key "
2995 (uintmax_t)scsi_8btou64(
2996 lun->per_res[idx].res_key.key));
3000 printf("CTL Persistent Reservation information end\n");
3001 printf("CTL Ports:\n");
3002 STAILQ_FOREACH(port, &softc->port_list, links) {
3003 printf(" Port %d '%s' Frontend '%s' Type %u pp %d vp %d WWNN "
3004 "%#jx WWPN %#jx\n", port->targ_port, port->port_name,
3005 port->frontend->name, port->port_type,
3006 port->physical_port, port->virtual_port,
3007 (uintmax_t)port->wwnn, (uintmax_t)port->wwpn);
3008 for (j = 0; j < CTL_MAX_INIT_PER_PORT; j++) {
3009 if (port->wwpn_iid[j].in_use == 0 &&
3010 port->wwpn_iid[j].wwpn == 0 &&
3011 port->wwpn_iid[j].name == NULL)
3014 printf(" iid %u use %d WWPN %#jx '%s'\n",
3015 j, port->wwpn_iid[j].in_use,
3016 (uintmax_t)port->wwpn_iid[j].wwpn,
3017 port->wwpn_iid[j].name);
3020 printf("CTL Port information end\n");
3021 mtx_unlock(&softc->ctl_lock);
3023 * XXX KDM calling this without a lock. We'd likely want
3024 * to drop the lock before calling the frontend's dump
3027 printf("CTL Frontends:\n");
3028 STAILQ_FOREACH(fe, &softc->fe_list, links) {
3029 printf(" Frontend '%s'\n", fe->name);
3030 if (fe->fe_dump != NULL)
3033 printf("CTL Frontend information end\n");
3037 struct ctl_lun_req *lun_req;
3038 struct ctl_backend_driver *backend;
3040 lun_req = (struct ctl_lun_req *)addr;
3042 backend = ctl_backend_find(lun_req->backend);
3043 if (backend == NULL) {
3044 lun_req->status = CTL_LUN_ERROR;
3045 snprintf(lun_req->error_str,
3046 sizeof(lun_req->error_str),
3047 "Backend \"%s\" not found.",
3051 if (lun_req->num_be_args > 0) {
3052 lun_req->kern_be_args = ctl_copyin_args(
3053 lun_req->num_be_args,
3056 sizeof(lun_req->error_str));
3057 if (lun_req->kern_be_args == NULL) {
3058 lun_req->status = CTL_LUN_ERROR;
3063 retval = backend->ioctl(dev, cmd, addr, flag, td);
3065 if (lun_req->num_be_args > 0) {
3066 ctl_copyout_args(lun_req->num_be_args,
3067 lun_req->kern_be_args);
3068 ctl_free_args(lun_req->num_be_args,
3069 lun_req->kern_be_args);
3073 case CTL_LUN_LIST: {
3075 struct ctl_lun *lun;
3076 struct ctl_lun_list *list;
3077 struct ctl_option *opt;
3079 list = (struct ctl_lun_list *)addr;
3082 * Allocate a fixed length sbuf here, based on the length
3083 * of the user's buffer. We could allocate an auto-extending
3084 * buffer, and then tell the user how much larger our
3085 * amount of data is than his buffer, but that presents
3088 * 1. The sbuf(9) routines use a blocking malloc, and so
3089 * we can't hold a lock while calling them with an
3090 * auto-extending buffer.
3092 * 2. There is not currently a LUN reference counting
3093 * mechanism, outside of outstanding transactions on
3094 * the LUN's OOA queue. So a LUN could go away on us
3095 * while we're getting the LUN number, backend-specific
3096 * information, etc. Thus, given the way things
3097 * currently work, we need to hold the CTL lock while
3098 * grabbing LUN information.
3100 * So, from the user's standpoint, the best thing to do is
3101 * allocate what he thinks is a reasonable buffer length,
3102 * and then if he gets a CTL_LUN_LIST_NEED_MORE_SPACE error,
3103 * double the buffer length and try again. (And repeat
3104 * that until he succeeds.)
3106 sb = sbuf_new(NULL, NULL, list->alloc_len, SBUF_FIXEDLEN);
3108 list->status = CTL_LUN_LIST_ERROR;
3109 snprintf(list->error_str, sizeof(list->error_str),
3110 "Unable to allocate %d bytes for LUN list",
3115 sbuf_printf(sb, "<ctllunlist>\n");
3117 mtx_lock(&softc->ctl_lock);
3118 STAILQ_FOREACH(lun, &softc->lun_list, links) {
3119 mtx_lock(&lun->lun_lock);
3120 retval = sbuf_printf(sb, "<lun id=\"%ju\">\n",
3121 (uintmax_t)lun->lun);
3124 * Bail out as soon as we see that we've overfilled
3130 retval = sbuf_printf(sb, "\t<backend_type>%s"
3131 "</backend_type>\n",
3132 (lun->backend == NULL) ? "none" :
3133 lun->backend->name);
3138 retval = sbuf_printf(sb, "\t<lun_type>%d</lun_type>\n",
3139 lun->be_lun->lun_type);
3144 if (lun->backend == NULL) {
3145 retval = sbuf_printf(sb, "</lun>\n");
3151 retval = sbuf_printf(sb, "\t<size>%ju</size>\n",
3152 (lun->be_lun->maxlba > 0) ?
3153 lun->be_lun->maxlba + 1 : 0);
3158 retval = sbuf_printf(sb, "\t<blocksize>%u</blocksize>\n",
3159 lun->be_lun->blocksize);
3164 retval = sbuf_printf(sb, "\t<serial_number>");
3169 retval = ctl_sbuf_printf_esc(sb,
3170 lun->be_lun->serial_num);
3175 retval = sbuf_printf(sb, "</serial_number>\n");
3180 retval = sbuf_printf(sb, "\t<device_id>");
3185 retval = ctl_sbuf_printf_esc(sb,lun->be_lun->device_id);
3190 retval = sbuf_printf(sb, "</device_id>\n");
3195 if (lun->backend->lun_info != NULL) {
3196 retval = lun->backend->lun_info(lun->be_lun->be_lun, sb);
3200 STAILQ_FOREACH(opt, &lun->be_lun->options, links) {
3201 retval = sbuf_printf(sb, "\t<%s>%s</%s>\n",
3202 opt->name, opt->value, opt->name);
3207 retval = sbuf_printf(sb, "</lun>\n");
3211 mtx_unlock(&lun->lun_lock);
3214 mtx_unlock(&lun->lun_lock);
3215 mtx_unlock(&softc->ctl_lock);
3218 || ((retval = sbuf_printf(sb, "</ctllunlist>\n")) != 0)) {
3221 list->status = CTL_LUN_LIST_NEED_MORE_SPACE;
3222 snprintf(list->error_str, sizeof(list->error_str),
3223 "Out of space, %d bytes is too small",
3230 retval = copyout(sbuf_data(sb), list->lun_xml,
3233 list->fill_len = sbuf_len(sb) + 1;
3234 list->status = CTL_LUN_LIST_OK;
3239 struct ctl_iscsi *ci;
3240 struct ctl_frontend *fe;
3242 ci = (struct ctl_iscsi *)addr;
3244 fe = ctl_frontend_find("iscsi");
3246 ci->status = CTL_ISCSI_ERROR;
3247 snprintf(ci->error_str, sizeof(ci->error_str),
3248 "Frontend \"iscsi\" not found.");
3252 retval = fe->ioctl(dev, cmd, addr, flag, td);
3255 case CTL_PORT_REQ: {
3256 struct ctl_req *req;
3257 struct ctl_frontend *fe;
3259 req = (struct ctl_req *)addr;
3261 fe = ctl_frontend_find(req->driver);
3263 req->status = CTL_LUN_ERROR;
3264 snprintf(req->error_str, sizeof(req->error_str),
3265 "Frontend \"%s\" not found.", req->driver);
3268 if (req->num_args > 0) {
3269 req->kern_args = ctl_copyin_args(req->num_args,
3270 req->args, req->error_str, sizeof(req->error_str));
3271 if (req->kern_args == NULL) {
3272 req->status = CTL_LUN_ERROR;
3277 retval = fe->ioctl(dev, cmd, addr, flag, td);
3279 if (req->num_args > 0) {
3280 ctl_copyout_args(req->num_args, req->kern_args);
3281 ctl_free_args(req->num_args, req->kern_args);
3285 case CTL_PORT_LIST: {
3287 struct ctl_port *port;
3288 struct ctl_lun_list *list;
3289 struct ctl_option *opt;
3291 list = (struct ctl_lun_list *)addr;
3293 sb = sbuf_new(NULL, NULL, list->alloc_len, SBUF_FIXEDLEN);
3295 list->status = CTL_LUN_LIST_ERROR;
3296 snprintf(list->error_str, sizeof(list->error_str),
3297 "Unable to allocate %d bytes for LUN list",
3302 sbuf_printf(sb, "<ctlportlist>\n");
3304 mtx_lock(&softc->ctl_lock);
3305 STAILQ_FOREACH(port, &softc->port_list, links) {
3306 retval = sbuf_printf(sb, "<targ_port id=\"%ju\">\n",
3307 (uintmax_t)port->targ_port);
3310 * Bail out as soon as we see that we've overfilled
3316 retval = sbuf_printf(sb, "\t<frontend_type>%s"
3317 "</frontend_type>\n", port->frontend->name);
3321 retval = sbuf_printf(sb, "\t<port_type>%d</port_type>\n",
3326 retval = sbuf_printf(sb, "\t<online>%s</online>\n",
3327 (port->status & CTL_PORT_STATUS_ONLINE) ? "YES" : "NO");
3331 retval = sbuf_printf(sb, "\t<port_name>%s</port_name>\n",
3336 retval = sbuf_printf(sb, "\t<physical_port>%d</physical_port>\n",
3337 port->physical_port);
3341 retval = sbuf_printf(sb, "\t<virtual_port>%d</virtual_port>\n",
3342 port->virtual_port);
3346 retval = sbuf_printf(sb, "\t<wwnn>%#jx</wwnn>\n",
3347 (uintmax_t)port->wwnn);
3351 retval = sbuf_printf(sb, "\t<wwpn>%#jx</wwpn>\n",
3352 (uintmax_t)port->wwpn);
3356 if (port->port_info != NULL) {
3357 retval = port->port_info(port->onoff_arg, sb);
3361 STAILQ_FOREACH(opt, &port->options, links) {
3362 retval = sbuf_printf(sb, "\t<%s>%s</%s>\n",
3363 opt->name, opt->value, opt->name);
3368 retval = sbuf_printf(sb, "</targ_port>\n");
3372 mtx_unlock(&softc->ctl_lock);
3375 || ((retval = sbuf_printf(sb, "</ctlportlist>\n")) != 0)) {
3378 list->status = CTL_LUN_LIST_NEED_MORE_SPACE;
3379 snprintf(list->error_str, sizeof(list->error_str),
3380 "Out of space, %d bytes is too small",
3387 retval = copyout(sbuf_data(sb), list->lun_xml,
3390 list->fill_len = sbuf_len(sb) + 1;
3391 list->status = CTL_LUN_LIST_OK;
3396 /* XXX KDM should we fix this? */
3398 struct ctl_backend_driver *backend;
3405 * We encode the backend type as the ioctl type for backend
3406 * ioctls. So parse it out here, and then search for a
3407 * backend of this type.
3409 type = _IOC_TYPE(cmd);
3411 STAILQ_FOREACH(backend, &softc->be_list, links) {
3412 if (backend->type == type) {
3418 printf("ctl: unknown ioctl command %#lx or backend "
3423 retval = backend->ioctl(dev, cmd, addr, flag, td);
3433 ctl_get_initindex(struct ctl_nexus *nexus)
3435 if (nexus->targ_port < CTL_MAX_PORTS)
3436 return (nexus->initid.id +
3437 (nexus->targ_port * CTL_MAX_INIT_PER_PORT));
3439 return (nexus->initid.id +
3440 ((nexus->targ_port - CTL_MAX_PORTS) *
3441 CTL_MAX_INIT_PER_PORT));
3445 ctl_get_resindex(struct ctl_nexus *nexus)
3447 return (nexus->initid.id + (nexus->targ_port * CTL_MAX_INIT_PER_PORT));
3451 ctl_port_idx(int port_num)
3453 if (port_num < CTL_MAX_PORTS)
3456 return(port_num - CTL_MAX_PORTS);
3460 ctl_map_lun(int port_num, uint32_t lun_id)
3462 struct ctl_port *port;
3464 port = control_softc->ctl_ports[ctl_port_idx(port_num)];
3466 return (UINT32_MAX);
3467 if (port->lun_map == NULL)
3469 return (port->lun_map(port->targ_lun_arg, lun_id));
3473 ctl_map_lun_back(int port_num, uint32_t lun_id)
3475 struct ctl_port *port;
3478 port = control_softc->ctl_ports[ctl_port_idx(port_num)];
3479 if (port->lun_map == NULL)
3481 for (i = 0; i < CTL_MAX_LUNS; i++) {
3482 if (port->lun_map(port->targ_lun_arg, i) == lun_id)
3485 return (UINT32_MAX);
3489 * Note: This only works for bitmask sizes that are at least 32 bits, and
3490 * that are a power of 2.
3493 ctl_ffz(uint32_t *mask, uint32_t size)
3495 uint32_t num_chunks, num_pieces;
3498 num_chunks = (size >> 5);
3499 if (num_chunks == 0)
3501 num_pieces = ctl_min((sizeof(uint32_t) * 8), size);
3503 for (i = 0; i < num_chunks; i++) {
3504 for (j = 0; j < num_pieces; j++) {
3505 if ((mask[i] & (1 << j)) == 0)
3506 return ((i << 5) + j);
3514 ctl_set_mask(uint32_t *mask, uint32_t bit)
3516 uint32_t chunk, piece;
3519 piece = bit % (sizeof(uint32_t) * 8);
3521 if ((mask[chunk] & (1 << piece)) != 0)
3524 mask[chunk] |= (1 << piece);
3530 ctl_clear_mask(uint32_t *mask, uint32_t bit)
3532 uint32_t chunk, piece;
3535 piece = bit % (sizeof(uint32_t) * 8);
3537 if ((mask[chunk] & (1 << piece)) == 0)
3540 mask[chunk] &= ~(1 << piece);
3546 ctl_is_set(uint32_t *mask, uint32_t bit)
3548 uint32_t chunk, piece;
3551 piece = bit % (sizeof(uint32_t) * 8);
3553 if ((mask[chunk] & (1 << piece)) == 0)
3561 * The bus, target and lun are optional, they can be filled in later.
3562 * can_wait is used to determine whether we can wait on the malloc or not.
3565 ctl_malloc_io(ctl_io_type io_type, uint32_t targ_port, uint32_t targ_target,
3566 uint32_t targ_lun, int can_wait)
3571 io = (union ctl_io *)malloc(sizeof(*io), M_CTL, M_WAITOK);
3573 io = (union ctl_io *)malloc(sizeof(*io), M_CTL, M_NOWAIT);
3576 io->io_hdr.io_type = io_type;
3577 io->io_hdr.targ_port = targ_port;
3579 * XXX KDM this needs to change/go away. We need to move
3580 * to a preallocated pool of ctl_scsiio structures.
3582 io->io_hdr.nexus.targ_target.id = targ_target;
3583 io->io_hdr.nexus.targ_lun = targ_lun;
3590 ctl_kfree_io(union ctl_io *io)
3597 * ctl_softc, pool_type, total_ctl_io are passed in.
3598 * npool is passed out.
3601 ctl_pool_create(struct ctl_softc *ctl_softc, ctl_pool_type pool_type,
3602 uint32_t total_ctl_io, struct ctl_io_pool **npool)
3605 union ctl_io *cur_io, *next_io;
3606 struct ctl_io_pool *pool;
3611 pool = (struct ctl_io_pool *)malloc(sizeof(*pool), M_CTL,
3618 pool->type = pool_type;
3619 pool->ctl_softc = ctl_softc;
3621 mtx_lock(&ctl_softc->pool_lock);
3622 pool->id = ctl_softc->cur_pool_id++;
3623 mtx_unlock(&ctl_softc->pool_lock);
3625 pool->flags = CTL_POOL_FLAG_NONE;
3626 pool->refcount = 1; /* Reference for validity. */
3627 STAILQ_INIT(&pool->free_queue);
3630 * XXX KDM other options here:
3631 * - allocate a page at a time
3632 * - allocate one big chunk of memory.
3633 * Page allocation might work well, but would take a little more
3636 for (i = 0; i < total_ctl_io; i++) {
3637 cur_io = (union ctl_io *)malloc(sizeof(*cur_io), M_CTLIO,
3639 if (cur_io == NULL) {
3643 cur_io->io_hdr.pool = pool;
3644 STAILQ_INSERT_TAIL(&pool->free_queue, &cur_io->io_hdr, links);
3645 pool->total_ctl_io++;
3646 pool->free_ctl_io++;
3650 for (cur_io = (union ctl_io *)STAILQ_FIRST(&pool->free_queue);
3651 cur_io != NULL; cur_io = next_io) {
3652 next_io = (union ctl_io *)STAILQ_NEXT(&cur_io->io_hdr,
3654 STAILQ_REMOVE(&pool->free_queue, &cur_io->io_hdr,
3656 free(cur_io, M_CTLIO);
3662 mtx_lock(&ctl_softc->pool_lock);
3663 ctl_softc->num_pools++;
3664 STAILQ_INSERT_TAIL(&ctl_softc->io_pools, pool, links);
3666 * Increment our usage count if this is an external consumer, so we
3667 * can't get unloaded until the external consumer (most likely a
3668 * FETD) unloads and frees his pool.
3670 * XXX KDM will this increment the caller's module use count, or
3674 if ((pool_type != CTL_POOL_EMERGENCY)
3675 && (pool_type != CTL_POOL_INTERNAL)
3676 && (pool_type != CTL_POOL_4OTHERSC))
3680 mtx_unlock(&ctl_softc->pool_lock);
3690 ctl_pool_acquire(struct ctl_io_pool *pool)
3693 mtx_assert(&pool->ctl_softc->pool_lock, MA_OWNED);
3695 if (pool->flags & CTL_POOL_FLAG_INVALID)
3704 ctl_pool_release(struct ctl_io_pool *pool)
3706 struct ctl_softc *ctl_softc = pool->ctl_softc;
3709 mtx_assert(&ctl_softc->pool_lock, MA_OWNED);
3711 if (--pool->refcount != 0)
3714 while ((io = (union ctl_io *)STAILQ_FIRST(&pool->free_queue)) != NULL) {
3715 STAILQ_REMOVE(&pool->free_queue, &io->io_hdr, ctl_io_hdr,
3720 STAILQ_REMOVE(&ctl_softc->io_pools, pool, ctl_io_pool, links);
3721 ctl_softc->num_pools--;
3724 * XXX KDM will this decrement the caller's usage count or mine?
3727 if ((pool->type != CTL_POOL_EMERGENCY)
3728 && (pool->type != CTL_POOL_INTERNAL)
3729 && (pool->type != CTL_POOL_4OTHERSC))
3737 ctl_pool_free(struct ctl_io_pool *pool)
3739 struct ctl_softc *ctl_softc;
3744 ctl_softc = pool->ctl_softc;
3745 mtx_lock(&ctl_softc->pool_lock);
3746 pool->flags |= CTL_POOL_FLAG_INVALID;
3747 ctl_pool_release(pool);
3748 mtx_unlock(&ctl_softc->pool_lock);
3752 * This routine does not block (except for spinlocks of course).
3753 * It tries to allocate a ctl_io union from the caller's pool as quickly as
3757 ctl_alloc_io(void *pool_ref)
3760 struct ctl_softc *ctl_softc;
3761 struct ctl_io_pool *pool, *npool;
3762 struct ctl_io_pool *emergency_pool;
3764 pool = (struct ctl_io_pool *)pool_ref;
3767 printf("%s: pool is NULL\n", __func__);
3771 emergency_pool = NULL;
3773 ctl_softc = pool->ctl_softc;
3775 mtx_lock(&ctl_softc->pool_lock);
3777 * First, try to get the io structure from the user's pool.
3779 if (ctl_pool_acquire(pool) == 0) {
3780 io = (union ctl_io *)STAILQ_FIRST(&pool->free_queue);
3782 STAILQ_REMOVE_HEAD(&pool->free_queue, links);
3783 pool->total_allocated++;
3784 pool->free_ctl_io--;
3785 mtx_unlock(&ctl_softc->pool_lock);
3788 ctl_pool_release(pool);
3791 * If he doesn't have any io structures left, search for an
3792 * emergency pool and grab one from there.
3794 STAILQ_FOREACH(npool, &ctl_softc->io_pools, links) {
3795 if (npool->type != CTL_POOL_EMERGENCY)
3798 if (ctl_pool_acquire(npool) != 0)
3801 emergency_pool = npool;
3803 io = (union ctl_io *)STAILQ_FIRST(&npool->free_queue);
3805 STAILQ_REMOVE_HEAD(&npool->free_queue, links);
3806 npool->total_allocated++;
3807 npool->free_ctl_io--;
3808 mtx_unlock(&ctl_softc->pool_lock);
3811 ctl_pool_release(npool);
3814 /* Drop the spinlock before we malloc */
3815 mtx_unlock(&ctl_softc->pool_lock);
3818 * The emergency pool (if it exists) didn't have one, so try an
3819 * atomic (i.e. nonblocking) malloc and see if we get lucky.
3821 io = (union ctl_io *)malloc(sizeof(*io), M_CTLIO, M_NOWAIT);
3824 * If the emergency pool exists but is empty, add this
3825 * ctl_io to its list when it gets freed.
3827 if (emergency_pool != NULL) {
3828 mtx_lock(&ctl_softc->pool_lock);
3829 if (ctl_pool_acquire(emergency_pool) == 0) {
3830 io->io_hdr.pool = emergency_pool;
3831 emergency_pool->total_ctl_io++;
3833 * Need to bump this, otherwise
3834 * total_allocated and total_freed won't
3835 * match when we no longer have anything
3838 emergency_pool->total_allocated++;
3840 mtx_unlock(&ctl_softc->pool_lock);
3842 io->io_hdr.pool = NULL;
3849 ctl_free_io(union ctl_io *io)
3855 * If this ctl_io has a pool, return it to that pool.
3857 if (io->io_hdr.pool != NULL) {
3858 struct ctl_io_pool *pool;
3860 pool = (struct ctl_io_pool *)io->io_hdr.pool;
3861 mtx_lock(&pool->ctl_softc->pool_lock);
3862 io->io_hdr.io_type = 0xff;
3863 STAILQ_INSERT_TAIL(&pool->free_queue, &io->io_hdr, links);
3864 pool->total_freed++;
3865 pool->free_ctl_io++;
3866 ctl_pool_release(pool);
3867 mtx_unlock(&pool->ctl_softc->pool_lock);
3870 * Otherwise, just free it. We probably malloced it and
3871 * the emergency pool wasn't available.
3879 ctl_zero_io(union ctl_io *io)
3887 * May need to preserve linked list pointers at some point too.
3889 pool_ref = io->io_hdr.pool;
3891 memset(io, 0, sizeof(*io));
3893 io->io_hdr.pool = pool_ref;
3897 * This routine is currently used for internal copies of ctl_ios that need
3898 * to persist for some reason after we've already returned status to the
3899 * FETD. (Thus the flag set.)
3902 * Note that this makes a blind copy of all fields in the ctl_io, except
3903 * for the pool reference. This includes any memory that has been
3904 * allocated! That memory will no longer be valid after done has been
3905 * called, so this would be VERY DANGEROUS for command that actually does
3906 * any reads or writes. Right now (11/7/2005), this is only used for immediate
3907 * start and stop commands, which don't transfer any data, so this is not a
3908 * problem. If it is used for anything else, the caller would also need to
3909 * allocate data buffer space and this routine would need to be modified to
3910 * copy the data buffer(s) as well.
3913 ctl_copy_io(union ctl_io *src, union ctl_io *dest)
3922 * May need to preserve linked list pointers at some point too.
3924 pool_ref = dest->io_hdr.pool;
3926 memcpy(dest, src, ctl_min(sizeof(*src), sizeof(*dest)));
3928 dest->io_hdr.pool = pool_ref;
3930 * We need to know that this is an internal copy, and doesn't need
3931 * to get passed back to the FETD that allocated it.
3933 dest->io_hdr.flags |= CTL_FLAG_INT_COPY;
3938 ctl_update_power_subpage(struct copan_power_subpage *page)
3940 int num_luns, num_partitions, config_type;
3941 struct ctl_softc *softc;
3942 cs_BOOL_t aor_present, shelf_50pct_power;
3943 cs_raidset_personality_t rs_type;
3944 int max_active_luns;
3946 softc = control_softc;
3948 /* subtract out the processor LUN */
3949 num_luns = softc->num_luns - 1;
3951 * Default to 7 LUNs active, which was the only number we allowed
3954 max_active_luns = 7;
3956 num_partitions = config_GetRsPartitionInfo();
3957 config_type = config_GetConfigType();
3958 shelf_50pct_power = config_GetShelfPowerMode();
3959 aor_present = config_IsAorRsPresent();
3961 rs_type = ddb_GetRsRaidType(1);
3962 if ((rs_type != CS_RAIDSET_PERSONALITY_RAID5)
3963 && (rs_type != CS_RAIDSET_PERSONALITY_RAID1)) {
3964 EPRINT(0, "Unsupported RS type %d!", rs_type);
3968 page->total_luns = num_luns;
3970 switch (config_type) {
3973 * In a 40 drive configuration, it doesn't matter what DC
3974 * cards we have, whether we have AOR enabled or not,
3975 * partitioning or not, or what type of RAIDset we have.
3976 * In that scenario, we can power up every LUN we present
3979 max_active_luns = num_luns;
3983 if (shelf_50pct_power == CS_FALSE) {
3985 if (aor_present == CS_TRUE) {
3987 CS_RAIDSET_PERSONALITY_RAID5) {
3988 max_active_luns = 7;
3989 } else if (rs_type ==
3990 CS_RAIDSET_PERSONALITY_RAID1){
3991 max_active_luns = 14;
3993 /* XXX KDM now what?? */
3997 CS_RAIDSET_PERSONALITY_RAID5) {
3998 max_active_luns = 8;
3999 } else if (rs_type ==
4000 CS_RAIDSET_PERSONALITY_RAID1){
4001 max_active_luns = 16;
4003 /* XXX KDM now what?? */
4009 * With 50% power in a 64 drive configuration, we
4010 * can power all LUNs we present.
4012 max_active_luns = num_luns;
4016 if (shelf_50pct_power == CS_FALSE) {
4018 if (aor_present == CS_TRUE) {
4020 CS_RAIDSET_PERSONALITY_RAID5) {
4021 max_active_luns = 7;
4022 } else if (rs_type ==
4023 CS_RAIDSET_PERSONALITY_RAID1){
4024 max_active_luns = 14;
4026 /* XXX KDM now what?? */
4030 CS_RAIDSET_PERSONALITY_RAID5) {
4031 max_active_luns = 8;
4032 } else if (rs_type ==
4033 CS_RAIDSET_PERSONALITY_RAID1){
4034 max_active_luns = 16;
4036 /* XXX KDM now what?? */
4041 if (aor_present == CS_TRUE) {
4043 CS_RAIDSET_PERSONALITY_RAID5) {
4044 max_active_luns = 14;
4045 } else if (rs_type ==
4046 CS_RAIDSET_PERSONALITY_RAID1){
4048 * We're assuming here that disk
4049 * caching is enabled, and so we're
4050 * able to power up half of each
4051 * LUN, and cache all writes.
4053 max_active_luns = num_luns;
4055 /* XXX KDM now what?? */
4059 CS_RAIDSET_PERSONALITY_RAID5) {
4060 max_active_luns = 15;
4061 } else if (rs_type ==
4062 CS_RAIDSET_PERSONALITY_RAID1){
4063 max_active_luns = 30;
4065 /* XXX KDM now what?? */
4072 * In this case, we have an unknown configuration, so we
4073 * just use the default from above.
4078 page->max_active_luns = max_active_luns;
4080 printk("%s: total_luns = %d, max_active_luns = %d\n", __func__,
4081 page->total_luns, page->max_active_luns);
4084 #endif /* NEEDTOPORT */
4087 * This routine could be used in the future to load default and/or saved
4088 * mode page parameters for a particuar lun.
4091 ctl_init_page_index(struct ctl_lun *lun)
4094 struct ctl_page_index *page_index;
4095 struct ctl_softc *softc;
4097 memcpy(&lun->mode_pages.index, page_index_template,
4098 sizeof(page_index_template));
4100 softc = lun->ctl_softc;
4102 for (i = 0; i < CTL_NUM_MODE_PAGES; i++) {
4104 page_index = &lun->mode_pages.index[i];
4106 * If this is a disk-only mode page, there's no point in
4107 * setting it up. For some pages, we have to have some
4108 * basic information about the disk in order to calculate the
4111 if ((lun->be_lun->lun_type != T_DIRECT)
4112 && (page_index->page_flags & CTL_PAGE_FLAG_DISK_ONLY))
4115 switch (page_index->page_code & SMPH_PC_MASK) {
4116 case SMS_FORMAT_DEVICE_PAGE: {
4117 struct scsi_format_page *format_page;
4119 if (page_index->subpage != SMS_SUBPAGE_PAGE_0)
4120 panic("subpage is incorrect!");
4123 * Sectors per track are set above. Bytes per
4124 * sector need to be set here on a per-LUN basis.
4126 memcpy(&lun->mode_pages.format_page[CTL_PAGE_CURRENT],
4127 &format_page_default,
4128 sizeof(format_page_default));
4129 memcpy(&lun->mode_pages.format_page[
4130 CTL_PAGE_CHANGEABLE], &format_page_changeable,
4131 sizeof(format_page_changeable));
4132 memcpy(&lun->mode_pages.format_page[CTL_PAGE_DEFAULT],
4133 &format_page_default,
4134 sizeof(format_page_default));
4135 memcpy(&lun->mode_pages.format_page[CTL_PAGE_SAVED],
4136 &format_page_default,
4137 sizeof(format_page_default));
4139 format_page = &lun->mode_pages.format_page[
4141 scsi_ulto2b(lun->be_lun->blocksize,
4142 format_page->bytes_per_sector);
4144 format_page = &lun->mode_pages.format_page[
4146 scsi_ulto2b(lun->be_lun->blocksize,
4147 format_page->bytes_per_sector);
4149 format_page = &lun->mode_pages.format_page[
4151 scsi_ulto2b(lun->be_lun->blocksize,
4152 format_page->bytes_per_sector);
4154 page_index->page_data =
4155 (uint8_t *)lun->mode_pages.format_page;
4158 case SMS_RIGID_DISK_PAGE: {
4159 struct scsi_rigid_disk_page *rigid_disk_page;
4160 uint32_t sectors_per_cylinder;
4164 #endif /* !__XSCALE__ */
4166 if (page_index->subpage != SMS_SUBPAGE_PAGE_0)
4167 panic("invalid subpage value %d",
4168 page_index->subpage);
4171 * Rotation rate and sectors per track are set
4172 * above. We calculate the cylinders here based on
4173 * capacity. Due to the number of heads and
4174 * sectors per track we're using, smaller arrays
4175 * may turn out to have 0 cylinders. Linux and
4176 * FreeBSD don't pay attention to these mode pages
4177 * to figure out capacity, but Solaris does. It
4178 * seems to deal with 0 cylinders just fine, and
4179 * works out a fake geometry based on the capacity.
4181 memcpy(&lun->mode_pages.rigid_disk_page[
4182 CTL_PAGE_CURRENT], &rigid_disk_page_default,
4183 sizeof(rigid_disk_page_default));
4184 memcpy(&lun->mode_pages.rigid_disk_page[
4185 CTL_PAGE_CHANGEABLE],&rigid_disk_page_changeable,
4186 sizeof(rigid_disk_page_changeable));
4187 memcpy(&lun->mode_pages.rigid_disk_page[
4188 CTL_PAGE_DEFAULT], &rigid_disk_page_default,
4189 sizeof(rigid_disk_page_default));
4190 memcpy(&lun->mode_pages.rigid_disk_page[
4191 CTL_PAGE_SAVED], &rigid_disk_page_default,
4192 sizeof(rigid_disk_page_default));
4194 sectors_per_cylinder = CTL_DEFAULT_SECTORS_PER_TRACK *
4198 * The divide method here will be more accurate,
4199 * probably, but results in floating point being
4200 * used in the kernel on i386 (__udivdi3()). On the
4201 * XScale, though, __udivdi3() is implemented in
4204 * The shift method for cylinder calculation is
4205 * accurate if sectors_per_cylinder is a power of
4206 * 2. Otherwise it might be slightly off -- you
4207 * might have a bit of a truncation problem.
4210 cylinders = (lun->be_lun->maxlba + 1) /
4211 sectors_per_cylinder;
4213 for (shift = 31; shift > 0; shift--) {
4214 if (sectors_per_cylinder & (1 << shift))
4217 cylinders = (lun->be_lun->maxlba + 1) >> shift;
4221 * We've basically got 3 bytes, or 24 bits for the
4222 * cylinder size in the mode page. If we're over,
4223 * just round down to 2^24.
4225 if (cylinders > 0xffffff)
4226 cylinders = 0xffffff;
4228 rigid_disk_page = &lun->mode_pages.rigid_disk_page[
4230 scsi_ulto3b(cylinders, rigid_disk_page->cylinders);
4232 rigid_disk_page = &lun->mode_pages.rigid_disk_page[
4234 scsi_ulto3b(cylinders, rigid_disk_page->cylinders);
4236 rigid_disk_page = &lun->mode_pages.rigid_disk_page[
4238 scsi_ulto3b(cylinders, rigid_disk_page->cylinders);
4240 page_index->page_data =
4241 (uint8_t *)lun->mode_pages.rigid_disk_page;
4244 case SMS_CACHING_PAGE: {
4246 if (page_index->subpage != SMS_SUBPAGE_PAGE_0)
4247 panic("invalid subpage value %d",
4248 page_index->subpage);
4250 * Defaults should be okay here, no calculations
4253 memcpy(&lun->mode_pages.caching_page[CTL_PAGE_CURRENT],
4254 &caching_page_default,
4255 sizeof(caching_page_default));
4256 memcpy(&lun->mode_pages.caching_page[
4257 CTL_PAGE_CHANGEABLE], &caching_page_changeable,
4258 sizeof(caching_page_changeable));
4259 memcpy(&lun->mode_pages.caching_page[CTL_PAGE_DEFAULT],
4260 &caching_page_default,
4261 sizeof(caching_page_default));
4262 memcpy(&lun->mode_pages.caching_page[CTL_PAGE_SAVED],
4263 &caching_page_default,
4264 sizeof(caching_page_default));
4265 page_index->page_data =
4266 (uint8_t *)lun->mode_pages.caching_page;
4269 case SMS_CONTROL_MODE_PAGE: {
4271 if (page_index->subpage != SMS_SUBPAGE_PAGE_0)
4272 panic("invalid subpage value %d",
4273 page_index->subpage);
4276 * Defaults should be okay here, no calculations
4279 memcpy(&lun->mode_pages.control_page[CTL_PAGE_CURRENT],
4280 &control_page_default,
4281 sizeof(control_page_default));
4282 memcpy(&lun->mode_pages.control_page[
4283 CTL_PAGE_CHANGEABLE], &control_page_changeable,
4284 sizeof(control_page_changeable));
4285 memcpy(&lun->mode_pages.control_page[CTL_PAGE_DEFAULT],
4286 &control_page_default,
4287 sizeof(control_page_default));
4288 memcpy(&lun->mode_pages.control_page[CTL_PAGE_SAVED],
4289 &control_page_default,
4290 sizeof(control_page_default));
4291 page_index->page_data =
4292 (uint8_t *)lun->mode_pages.control_page;
4296 case SMS_VENDOR_SPECIFIC_PAGE:{
4297 switch (page_index->subpage) {
4298 case PWR_SUBPAGE_CODE: {
4299 struct copan_power_subpage *current_page,
4302 memcpy(&lun->mode_pages.power_subpage[
4304 &power_page_default,
4305 sizeof(power_page_default));
4306 memcpy(&lun->mode_pages.power_subpage[
4307 CTL_PAGE_CHANGEABLE],
4308 &power_page_changeable,
4309 sizeof(power_page_changeable));
4310 memcpy(&lun->mode_pages.power_subpage[
4312 &power_page_default,
4313 sizeof(power_page_default));
4314 memcpy(&lun->mode_pages.power_subpage[
4316 &power_page_default,
4317 sizeof(power_page_default));
4318 page_index->page_data =
4319 (uint8_t *)lun->mode_pages.power_subpage;
4321 current_page = (struct copan_power_subpage *)
4322 (page_index->page_data +
4323 (page_index->page_len *
4325 saved_page = (struct copan_power_subpage *)
4326 (page_index->page_data +
4327 (page_index->page_len *
4331 case APS_SUBPAGE_CODE: {
4332 struct copan_aps_subpage *current_page,
4335 // This gets set multiple times but
4336 // it should always be the same. It's
4337 // only done during init so who cares.
4338 index_to_aps_page = i;
4340 memcpy(&lun->mode_pages.aps_subpage[
4343 sizeof(aps_page_default));
4344 memcpy(&lun->mode_pages.aps_subpage[
4345 CTL_PAGE_CHANGEABLE],
4346 &aps_page_changeable,
4347 sizeof(aps_page_changeable));
4348 memcpy(&lun->mode_pages.aps_subpage[
4351 sizeof(aps_page_default));
4352 memcpy(&lun->mode_pages.aps_subpage[
4355 sizeof(aps_page_default));
4356 page_index->page_data =
4357 (uint8_t *)lun->mode_pages.aps_subpage;
4359 current_page = (struct copan_aps_subpage *)
4360 (page_index->page_data +
4361 (page_index->page_len *
4363 saved_page = (struct copan_aps_subpage *)
4364 (page_index->page_data +
4365 (page_index->page_len *
4369 case DBGCNF_SUBPAGE_CODE: {
4370 struct copan_debugconf_subpage *current_page,
4373 memcpy(&lun->mode_pages.debugconf_subpage[
4375 &debugconf_page_default,
4376 sizeof(debugconf_page_default));
4377 memcpy(&lun->mode_pages.debugconf_subpage[
4378 CTL_PAGE_CHANGEABLE],
4379 &debugconf_page_changeable,
4380 sizeof(debugconf_page_changeable));
4381 memcpy(&lun->mode_pages.debugconf_subpage[
4383 &debugconf_page_default,
4384 sizeof(debugconf_page_default));
4385 memcpy(&lun->mode_pages.debugconf_subpage[
4387 &debugconf_page_default,
4388 sizeof(debugconf_page_default));
4389 page_index->page_data =
4390 (uint8_t *)lun->mode_pages.debugconf_subpage;
4392 current_page = (struct copan_debugconf_subpage *)
4393 (page_index->page_data +
4394 (page_index->page_len *
4396 saved_page = (struct copan_debugconf_subpage *)
4397 (page_index->page_data +
4398 (page_index->page_len *
4403 panic("invalid subpage value %d",
4404 page_index->subpage);
4410 panic("invalid page value %d",
4411 page_index->page_code & SMPH_PC_MASK);
4416 return (CTL_RETVAL_COMPLETE);
4423 * - caller allocates and zeros LUN storage, or passes in a NULL LUN if he
4424 * wants us to allocate the LUN and he can block.
4425 * - ctl_softc is always set
4426 * - be_lun is set if the LUN has a backend (needed for disk LUNs)
4428 * Returns 0 for success, non-zero (errno) for failure.
4431 ctl_alloc_lun(struct ctl_softc *ctl_softc, struct ctl_lun *ctl_lun,
4432 struct ctl_be_lun *const be_lun, struct ctl_id target_id)
4434 struct ctl_lun *nlun, *lun;
4435 struct ctl_port *port;
4436 struct scsi_vpd_id_descriptor *desc;
4437 struct scsi_vpd_id_t10 *t10id;
4438 const char *eui, *naa, *scsiname, *vendor;
4439 int lun_number, i, lun_malloced;
4440 int devidlen, idlen1, idlen2 = 0, len;
4446 * We currently only support Direct Access or Processor LUN types.
4448 switch (be_lun->lun_type) {
4456 be_lun->lun_config_status(be_lun->be_lun,
4457 CTL_LUN_CONFIG_FAILURE);
4460 if (ctl_lun == NULL) {
4461 lun = malloc(sizeof(*lun), M_CTL, M_WAITOK);
4468 memset(lun, 0, sizeof(*lun));
4470 lun->flags = CTL_LUN_MALLOCED;
4472 /* Generate LUN ID. */
4473 devidlen = max(CTL_DEVID_MIN_LEN,
4474 strnlen(be_lun->device_id, CTL_DEVID_LEN));
4475 idlen1 = sizeof(*t10id) + devidlen;
4476 len = sizeof(struct scsi_vpd_id_descriptor) + idlen1;
4477 scsiname = ctl_get_opt(&be_lun->options, "scsiname");
4478 if (scsiname != NULL) {
4479 idlen2 = roundup2(strlen(scsiname) + 1, 4);
4480 len += sizeof(struct scsi_vpd_id_descriptor) + idlen2;
4482 eui = ctl_get_opt(&be_lun->options, "eui");
4484 len += sizeof(struct scsi_vpd_id_descriptor) + 8;
4486 naa = ctl_get_opt(&be_lun->options, "naa");
4488 len += sizeof(struct scsi_vpd_id_descriptor) + 8;
4490 lun->lun_devid = malloc(sizeof(struct ctl_devid) + len,
4491 M_CTL, M_WAITOK | M_ZERO);
4492 lun->lun_devid->len = len;
4493 desc = (struct scsi_vpd_id_descriptor *)lun->lun_devid->data;
4494 desc->proto_codeset = SVPD_ID_CODESET_ASCII;
4495 desc->id_type = SVPD_ID_PIV | SVPD_ID_ASSOC_LUN | SVPD_ID_TYPE_T10;
4496 desc->length = idlen1;
4497 t10id = (struct scsi_vpd_id_t10 *)&desc->identifier[0];
4498 memset(t10id->vendor, ' ', sizeof(t10id->vendor));
4499 if ((vendor = ctl_get_opt(&be_lun->options, "vendor")) == NULL) {
4500 strncpy((char *)t10id->vendor, CTL_VENDOR, sizeof(t10id->vendor));
4502 strncpy(t10id->vendor, vendor,
4503 min(sizeof(t10id->vendor), strlen(vendor)));
4505 strncpy((char *)t10id->vendor_spec_id,
4506 (char *)be_lun->device_id, devidlen);
4507 if (scsiname != NULL) {
4508 desc = (struct scsi_vpd_id_descriptor *)(&desc->identifier[0] +
4510 desc->proto_codeset = SVPD_ID_CODESET_UTF8;
4511 desc->id_type = SVPD_ID_PIV | SVPD_ID_ASSOC_LUN |
4512 SVPD_ID_TYPE_SCSI_NAME;
4513 desc->length = idlen2;
4514 strlcpy(desc->identifier, scsiname, idlen2);
4517 desc = (struct scsi_vpd_id_descriptor *)(&desc->identifier[0] +
4519 desc->proto_codeset = SVPD_ID_CODESET_BINARY;
4520 desc->id_type = SVPD_ID_PIV | SVPD_ID_ASSOC_LUN |
4523 scsi_u64to8b(strtouq(eui, NULL, 0), desc->identifier);
4526 desc = (struct scsi_vpd_id_descriptor *)(&desc->identifier[0] +
4528 desc->proto_codeset = SVPD_ID_CODESET_BINARY;
4529 desc->id_type = SVPD_ID_PIV | SVPD_ID_ASSOC_LUN |
4532 scsi_u64to8b(strtouq(naa, NULL, 0), desc->identifier);
4535 mtx_lock(&ctl_softc->ctl_lock);
4537 * See if the caller requested a particular LUN number. If so, see
4538 * if it is available. Otherwise, allocate the first available LUN.
4540 if (be_lun->flags & CTL_LUN_FLAG_ID_REQ) {
4541 if ((be_lun->req_lun_id > (CTL_MAX_LUNS - 1))
4542 || (ctl_is_set(ctl_softc->ctl_lun_mask, be_lun->req_lun_id))) {
4543 mtx_unlock(&ctl_softc->ctl_lock);
4544 if (be_lun->req_lun_id > (CTL_MAX_LUNS - 1)) {
4545 printf("ctl: requested LUN ID %d is higher "
4546 "than CTL_MAX_LUNS - 1 (%d)\n",
4547 be_lun->req_lun_id, CTL_MAX_LUNS - 1);
4550 * XXX KDM return an error, or just assign
4551 * another LUN ID in this case??
4553 printf("ctl: requested LUN ID %d is already "
4554 "in use\n", be_lun->req_lun_id);
4556 if (lun->flags & CTL_LUN_MALLOCED)
4558 be_lun->lun_config_status(be_lun->be_lun,
4559 CTL_LUN_CONFIG_FAILURE);
4562 lun_number = be_lun->req_lun_id;
4564 lun_number = ctl_ffz(ctl_softc->ctl_lun_mask, CTL_MAX_LUNS);
4565 if (lun_number == -1) {
4566 mtx_unlock(&ctl_softc->ctl_lock);
4567 printf("ctl: can't allocate LUN on target %ju, out of "
4568 "LUNs\n", (uintmax_t)target_id.id);
4569 if (lun->flags & CTL_LUN_MALLOCED)
4571 be_lun->lun_config_status(be_lun->be_lun,
4572 CTL_LUN_CONFIG_FAILURE);
4576 ctl_set_mask(ctl_softc->ctl_lun_mask, lun_number);
4578 mtx_init(&lun->lun_lock, "CTL LUN", NULL, MTX_DEF);
4579 lun->target = target_id;
4580 lun->lun = lun_number;
4581 lun->be_lun = be_lun;
4583 * The processor LUN is always enabled. Disk LUNs come on line
4584 * disabled, and must be enabled by the backend.
4586 lun->flags |= CTL_LUN_DISABLED;
4587 lun->backend = be_lun->be;
4588 be_lun->ctl_lun = lun;
4589 be_lun->lun_id = lun_number;
4590 atomic_add_int(&be_lun->be->num_luns, 1);
4591 if (be_lun->flags & CTL_LUN_FLAG_POWERED_OFF)
4592 lun->flags |= CTL_LUN_STOPPED;
4594 if (be_lun->flags & CTL_LUN_FLAG_INOPERABLE)
4595 lun->flags |= CTL_LUN_INOPERABLE;
4597 if (be_lun->flags & CTL_LUN_FLAG_PRIMARY)
4598 lun->flags |= CTL_LUN_PRIMARY_SC;
4600 lun->ctl_softc = ctl_softc;
4601 TAILQ_INIT(&lun->ooa_queue);
4602 TAILQ_INIT(&lun->blocked_queue);
4603 STAILQ_INIT(&lun->error_list);
4604 ctl_tpc_lun_init(lun);
4607 * Initialize the mode page index.
4609 ctl_init_page_index(lun);
4612 * Set the poweron UA for all initiators on this LUN only.
4614 for (i = 0; i < CTL_MAX_INITIATORS; i++)
4615 lun->pending_ua[i] = CTL_UA_POWERON;
4618 * Now, before we insert this lun on the lun list, set the lun
4619 * inventory changed UA for all other luns.
4621 STAILQ_FOREACH(nlun, &ctl_softc->lun_list, links) {
4622 for (i = 0; i < CTL_MAX_INITIATORS; i++) {
4623 nlun->pending_ua[i] |= CTL_UA_LUN_CHANGE;
4627 STAILQ_INSERT_TAIL(&ctl_softc->lun_list, lun, links);
4629 ctl_softc->ctl_luns[lun_number] = lun;
4631 ctl_softc->num_luns++;
4633 /* Setup statistics gathering */
4634 lun->stats.device_type = be_lun->lun_type;
4635 lun->stats.lun_number = lun_number;
4636 if (lun->stats.device_type == T_DIRECT)
4637 lun->stats.blocksize = be_lun->blocksize;
4639 lun->stats.flags = CTL_LUN_STATS_NO_BLOCKSIZE;
4640 for (i = 0;i < CTL_MAX_PORTS;i++)
4641 lun->stats.ports[i].targ_port = i;
4643 mtx_unlock(&ctl_softc->ctl_lock);
4645 lun->be_lun->lun_config_status(lun->be_lun->be_lun, CTL_LUN_CONFIG_OK);
4648 * Run through each registered FETD and bring it online if it isn't
4649 * already. Enable the target ID if it hasn't been enabled, and
4650 * enable this particular LUN.
4652 STAILQ_FOREACH(port, &ctl_softc->port_list, links) {
4655 retval = port->lun_enable(port->targ_lun_arg, target_id,lun_number);
4657 printf("ctl_alloc_lun: FETD %s port %d returned error "
4658 "%d for lun_enable on target %ju lun %d\n",
4659 port->port_name, port->targ_port, retval,
4660 (uintmax_t)target_id.id, lun_number);
4662 port->status |= CTL_PORT_STATUS_LUN_ONLINE;
4670 * - LUN has already been marked invalid and any pending I/O has been taken
4674 ctl_free_lun(struct ctl_lun *lun)
4676 struct ctl_softc *softc;
4678 struct ctl_port *port;
4680 struct ctl_lun *nlun;
4683 softc = lun->ctl_softc;
4685 mtx_assert(&softc->ctl_lock, MA_OWNED);
4687 STAILQ_REMOVE(&softc->lun_list, lun, ctl_lun, links);
4689 ctl_clear_mask(softc->ctl_lun_mask, lun->lun);
4691 softc->ctl_luns[lun->lun] = NULL;
4693 if (!TAILQ_EMPTY(&lun->ooa_queue))
4694 panic("Freeing a LUN %p with outstanding I/O!!\n", lun);
4699 * XXX KDM this scheme only works for a single target/multiple LUN
4700 * setup. It needs to be revamped for a multiple target scheme.
4702 * XXX KDM this results in port->lun_disable() getting called twice,
4703 * once when ctl_disable_lun() is called, and a second time here.
4704 * We really need to re-think the LUN disable semantics. There
4705 * should probably be several steps/levels to LUN removal:
4710 * Right now we only have a disable method when communicating to
4711 * the front end ports, at least for individual LUNs.
4714 STAILQ_FOREACH(port, &softc->port_list, links) {
4717 retval = port->lun_disable(port->targ_lun_arg, lun->target,
4720 printf("ctl_free_lun: FETD %s port %d returned error "
4721 "%d for lun_disable on target %ju lun %jd\n",
4722 port->port_name, port->targ_port, retval,
4723 (uintmax_t)lun->target.id, (intmax_t)lun->lun);
4726 if (STAILQ_FIRST(&softc->lun_list) == NULL) {
4727 port->status &= ~CTL_PORT_STATUS_LUN_ONLINE;
4729 retval = port->targ_disable(port->targ_lun_arg,lun->target);
4731 printf("ctl_free_lun: FETD %s port %d "
4732 "returned error %d for targ_disable on "
4733 "target %ju\n", port->port_name,
4734 port->targ_port, retval,
4735 (uintmax_t)lun->target.id);
4737 port->status &= ~CTL_PORT_STATUS_TARG_ONLINE;
4739 if ((port->status & CTL_PORT_STATUS_TARG_ONLINE) != 0)
4743 port->port_offline(port->onoff_arg);
4744 port->status &= ~CTL_PORT_STATUS_ONLINE;
4751 * Tell the backend to free resources, if this LUN has a backend.
4753 atomic_subtract_int(&lun->be_lun->be->num_luns, 1);
4754 lun->be_lun->lun_shutdown(lun->be_lun->be_lun);
4756 ctl_tpc_lun_shutdown(lun);
4757 mtx_destroy(&lun->lun_lock);
4758 free(lun->lun_devid, M_CTL);
4759 if (lun->flags & CTL_LUN_MALLOCED)
4762 STAILQ_FOREACH(nlun, &softc->lun_list, links) {
4763 for (i = 0; i < CTL_MAX_INITIATORS; i++) {
4764 nlun->pending_ua[i] |= CTL_UA_LUN_CHANGE;
4772 ctl_create_lun(struct ctl_be_lun *be_lun)
4774 struct ctl_softc *ctl_softc;
4776 ctl_softc = control_softc;
4779 * ctl_alloc_lun() should handle all potential failure cases.
4781 ctl_alloc_lun(ctl_softc, NULL, be_lun, ctl_softc->target);
4785 ctl_add_lun(struct ctl_be_lun *be_lun)
4787 struct ctl_softc *ctl_softc = control_softc;
4789 mtx_lock(&ctl_softc->ctl_lock);
4790 STAILQ_INSERT_TAIL(&ctl_softc->pending_lun_queue, be_lun, links);
4791 mtx_unlock(&ctl_softc->ctl_lock);
4792 wakeup(&ctl_softc->pending_lun_queue);
4798 ctl_enable_lun(struct ctl_be_lun *be_lun)
4800 struct ctl_softc *ctl_softc;
4801 struct ctl_port *port, *nport;
4802 struct ctl_lun *lun;
4805 ctl_softc = control_softc;
4807 lun = (struct ctl_lun *)be_lun->ctl_lun;
4809 mtx_lock(&ctl_softc->ctl_lock);
4810 mtx_lock(&lun->lun_lock);
4811 if ((lun->flags & CTL_LUN_DISABLED) == 0) {
4813 * eh? Why did we get called if the LUN is already
4816 mtx_unlock(&lun->lun_lock);
4817 mtx_unlock(&ctl_softc->ctl_lock);
4820 lun->flags &= ~CTL_LUN_DISABLED;
4821 mtx_unlock(&lun->lun_lock);
4823 for (port = STAILQ_FIRST(&ctl_softc->port_list); port != NULL; port = nport) {
4824 nport = STAILQ_NEXT(port, links);
4827 * Drop the lock while we call the FETD's enable routine.
4828 * This can lead to a callback into CTL (at least in the
4829 * case of the internal initiator frontend.
4831 mtx_unlock(&ctl_softc->ctl_lock);
4832 retval = port->lun_enable(port->targ_lun_arg, lun->target,lun->lun);
4833 mtx_lock(&ctl_softc->ctl_lock);
4835 printf("%s: FETD %s port %d returned error "
4836 "%d for lun_enable on target %ju lun %jd\n",
4837 __func__, port->port_name, port->targ_port, retval,
4838 (uintmax_t)lun->target.id, (intmax_t)lun->lun);
4842 /* NOTE: TODO: why does lun enable affect port status? */
4843 port->status |= CTL_PORT_STATUS_LUN_ONLINE;
4848 mtx_unlock(&ctl_softc->ctl_lock);
4854 ctl_disable_lun(struct ctl_be_lun *be_lun)
4856 struct ctl_softc *ctl_softc;
4857 struct ctl_port *port;
4858 struct ctl_lun *lun;
4861 ctl_softc = control_softc;
4863 lun = (struct ctl_lun *)be_lun->ctl_lun;
4865 mtx_lock(&ctl_softc->ctl_lock);
4866 mtx_lock(&lun->lun_lock);
4867 if (lun->flags & CTL_LUN_DISABLED) {
4868 mtx_unlock(&lun->lun_lock);
4869 mtx_unlock(&ctl_softc->ctl_lock);
4872 lun->flags |= CTL_LUN_DISABLED;
4873 mtx_unlock(&lun->lun_lock);
4875 STAILQ_FOREACH(port, &ctl_softc->port_list, links) {
4876 mtx_unlock(&ctl_softc->ctl_lock);
4878 * Drop the lock before we call the frontend's disable
4879 * routine, to avoid lock order reversals.
4881 * XXX KDM what happens if the frontend list changes while
4882 * we're traversing it? It's unlikely, but should be handled.
4884 retval = port->lun_disable(port->targ_lun_arg, lun->target,
4886 mtx_lock(&ctl_softc->ctl_lock);
4888 printf("ctl_alloc_lun: FETD %s port %d returned error "
4889 "%d for lun_disable on target %ju lun %jd\n",
4890 port->port_name, port->targ_port, retval,
4891 (uintmax_t)lun->target.id, (intmax_t)lun->lun);
4895 mtx_unlock(&ctl_softc->ctl_lock);
4901 ctl_start_lun(struct ctl_be_lun *be_lun)
4903 struct ctl_softc *ctl_softc;
4904 struct ctl_lun *lun;
4906 ctl_softc = control_softc;
4908 lun = (struct ctl_lun *)be_lun->ctl_lun;
4910 mtx_lock(&lun->lun_lock);
4911 lun->flags &= ~CTL_LUN_STOPPED;
4912 mtx_unlock(&lun->lun_lock);
4918 ctl_stop_lun(struct ctl_be_lun *be_lun)
4920 struct ctl_softc *ctl_softc;
4921 struct ctl_lun *lun;
4923 ctl_softc = control_softc;
4925 lun = (struct ctl_lun *)be_lun->ctl_lun;
4927 mtx_lock(&lun->lun_lock);
4928 lun->flags |= CTL_LUN_STOPPED;
4929 mtx_unlock(&lun->lun_lock);
4935 ctl_lun_offline(struct ctl_be_lun *be_lun)
4937 struct ctl_softc *ctl_softc;
4938 struct ctl_lun *lun;
4940 ctl_softc = control_softc;
4942 lun = (struct ctl_lun *)be_lun->ctl_lun;
4944 mtx_lock(&lun->lun_lock);
4945 lun->flags |= CTL_LUN_OFFLINE;
4946 mtx_unlock(&lun->lun_lock);
4952 ctl_lun_online(struct ctl_be_lun *be_lun)
4954 struct ctl_softc *ctl_softc;
4955 struct ctl_lun *lun;
4957 ctl_softc = control_softc;
4959 lun = (struct ctl_lun *)be_lun->ctl_lun;
4961 mtx_lock(&lun->lun_lock);
4962 lun->flags &= ~CTL_LUN_OFFLINE;
4963 mtx_unlock(&lun->lun_lock);
4969 ctl_invalidate_lun(struct ctl_be_lun *be_lun)
4971 struct ctl_softc *ctl_softc;
4972 struct ctl_lun *lun;
4974 ctl_softc = control_softc;
4976 lun = (struct ctl_lun *)be_lun->ctl_lun;
4978 mtx_lock(&lun->lun_lock);
4981 * The LUN needs to be disabled before it can be marked invalid.
4983 if ((lun->flags & CTL_LUN_DISABLED) == 0) {
4984 mtx_unlock(&lun->lun_lock);
4988 * Mark the LUN invalid.
4990 lun->flags |= CTL_LUN_INVALID;
4993 * If there is nothing in the OOA queue, go ahead and free the LUN.
4994 * If we have something in the OOA queue, we'll free it when the
4995 * last I/O completes.
4997 if (TAILQ_EMPTY(&lun->ooa_queue)) {
4998 mtx_unlock(&lun->lun_lock);
4999 mtx_lock(&ctl_softc->ctl_lock);
5001 mtx_unlock(&ctl_softc->ctl_lock);
5003 mtx_unlock(&lun->lun_lock);
5009 ctl_lun_inoperable(struct ctl_be_lun *be_lun)
5011 struct ctl_softc *ctl_softc;
5012 struct ctl_lun *lun;
5014 ctl_softc = control_softc;
5015 lun = (struct ctl_lun *)be_lun->ctl_lun;
5017 mtx_lock(&lun->lun_lock);
5018 lun->flags |= CTL_LUN_INOPERABLE;
5019 mtx_unlock(&lun->lun_lock);
5025 ctl_lun_operable(struct ctl_be_lun *be_lun)
5027 struct ctl_softc *ctl_softc;
5028 struct ctl_lun *lun;
5030 ctl_softc = control_softc;
5031 lun = (struct ctl_lun *)be_lun->ctl_lun;
5033 mtx_lock(&lun->lun_lock);
5034 lun->flags &= ~CTL_LUN_INOPERABLE;
5035 mtx_unlock(&lun->lun_lock);
5041 ctl_lun_power_lock(struct ctl_be_lun *be_lun, struct ctl_nexus *nexus,
5044 struct ctl_softc *softc;
5045 struct ctl_lun *lun;
5046 struct copan_aps_subpage *current_sp;
5047 struct ctl_page_index *page_index;
5050 softc = control_softc;
5052 mtx_lock(&softc->ctl_lock);
5054 lun = (struct ctl_lun *)be_lun->ctl_lun;
5055 mtx_lock(&lun->lun_lock);
5058 for (i = 0; i < CTL_NUM_MODE_PAGES; i++) {
5059 if ((lun->mode_pages.index[i].page_code & SMPH_PC_MASK) !=
5063 if (lun->mode_pages.index[i].subpage != APS_SUBPAGE_CODE)
5065 page_index = &lun->mode_pages.index[i];
5068 if (page_index == NULL) {
5069 mtx_unlock(&lun->lun_lock);
5070 mtx_unlock(&softc->ctl_lock);
5071 printf("%s: APS subpage not found for lun %ju!\n", __func__,
5072 (uintmax_t)lun->lun);
5076 if ((softc->aps_locked_lun != 0)
5077 && (softc->aps_locked_lun != lun->lun)) {
5078 printf("%s: attempt to lock LUN %llu when %llu is already "
5080 mtx_unlock(&lun->lun_lock);
5081 mtx_unlock(&softc->ctl_lock);
5086 current_sp = (struct copan_aps_subpage *)(page_index->page_data +
5087 (page_index->page_len * CTL_PAGE_CURRENT));
5090 current_sp->lock_active = APS_LOCK_ACTIVE;
5091 softc->aps_locked_lun = lun->lun;
5093 current_sp->lock_active = 0;
5094 softc->aps_locked_lun = 0;
5099 * If we're in HA mode, try to send the lock message to the other
5102 if (ctl_is_single == 0) {
5104 union ctl_ha_msg lock_msg;
5106 lock_msg.hdr.nexus = *nexus;
5107 lock_msg.hdr.msg_type = CTL_MSG_APS_LOCK;
5109 lock_msg.aps.lock_flag = 1;
5111 lock_msg.aps.lock_flag = 0;
5112 isc_retval = ctl_ha_msg_send(CTL_HA_CHAN_CTL, &lock_msg,
5113 sizeof(lock_msg), 0);
5114 if (isc_retval > CTL_HA_STATUS_SUCCESS) {
5115 printf("%s: APS (lock=%d) error returned from "
5116 "ctl_ha_msg_send: %d\n", __func__, lock, isc_retval);
5117 mtx_unlock(&lun->lun_lock);
5118 mtx_unlock(&softc->ctl_lock);
5123 mtx_unlock(&lun->lun_lock);
5124 mtx_unlock(&softc->ctl_lock);
5130 ctl_lun_capacity_changed(struct ctl_be_lun *be_lun)
5132 struct ctl_lun *lun;
5133 struct ctl_softc *softc;
5136 softc = control_softc;
5138 lun = (struct ctl_lun *)be_lun->ctl_lun;
5140 mtx_lock(&lun->lun_lock);
5142 for (i = 0; i < CTL_MAX_INITIATORS; i++)
5143 lun->pending_ua[i] |= CTL_UA_CAPACITY_CHANGED;
5145 mtx_unlock(&lun->lun_lock);
5149 * Backend "memory move is complete" callback for requests that never
5150 * make it down to say RAIDCore's configuration code.
5153 ctl_config_move_done(union ctl_io *io)
5157 retval = CTL_RETVAL_COMPLETE;
5160 CTL_DEBUG_PRINT(("ctl_config_move_done\n"));
5162 * XXX KDM this shouldn't happen, but what if it does?
5164 if (io->io_hdr.io_type != CTL_IO_SCSI)
5165 panic("I/O type isn't CTL_IO_SCSI!");
5167 if ((io->io_hdr.port_status == 0)
5168 && ((io->io_hdr.flags & CTL_FLAG_ABORT) == 0)
5169 && ((io->io_hdr.status & CTL_STATUS_MASK) == CTL_STATUS_NONE))
5170 io->io_hdr.status = CTL_SUCCESS;
5171 else if ((io->io_hdr.port_status != 0)
5172 && ((io->io_hdr.flags & CTL_FLAG_ABORT) == 0)
5173 && ((io->io_hdr.status & CTL_STATUS_MASK) == CTL_STATUS_NONE)){
5175 * For hardware error sense keys, the sense key
5176 * specific value is defined to be a retry count,
5177 * but we use it to pass back an internal FETD
5178 * error code. XXX KDM Hopefully the FETD is only
5179 * using 16 bits for an error code, since that's
5180 * all the space we have in the sks field.
5182 ctl_set_internal_failure(&io->scsiio,
5185 io->io_hdr.port_status);
5186 if (io->io_hdr.flags & CTL_FLAG_ALLOCATED)
5187 free(io->scsiio.kern_data_ptr, M_CTL);
5192 if (((io->io_hdr.flags & CTL_FLAG_DATA_MASK) == CTL_FLAG_DATA_IN)
5193 || ((io->io_hdr.status & CTL_STATUS_MASK) != CTL_SUCCESS)
5194 || ((io->io_hdr.flags & CTL_FLAG_ABORT) != 0)) {
5196 * XXX KDM just assuming a single pointer here, and not a
5197 * S/G list. If we start using S/G lists for config data,
5198 * we'll need to know how to clean them up here as well.
5200 if (io->io_hdr.flags & CTL_FLAG_ALLOCATED)
5201 free(io->scsiio.kern_data_ptr, M_CTL);
5202 /* Hopefully the user has already set the status... */
5206 * XXX KDM now we need to continue data movement. Some
5208 * - call ctl_scsiio() again? We don't do this for data
5209 * writes, because for those at least we know ahead of
5210 * time where the write will go and how long it is. For
5211 * config writes, though, that information is largely
5212 * contained within the write itself, thus we need to
5213 * parse out the data again.
5215 * - Call some other function once the data is in?
5219 * XXX KDM call ctl_scsiio() again for now, and check flag
5220 * bits to see whether we're allocated or not.
5222 retval = ctl_scsiio(&io->scsiio);
5229 * This gets called by a backend driver when it is done with a
5230 * data_submit method.
5233 ctl_data_submit_done(union ctl_io *io)
5236 * If the IO_CONT flag is set, we need to call the supplied
5237 * function to continue processing the I/O, instead of completing
5240 * If there is an error, though, we don't want to keep processing.
5241 * Instead, just send status back to the initiator.
5243 if ((io->io_hdr.flags & CTL_FLAG_IO_CONT) &&
5244 (io->io_hdr.flags & CTL_FLAG_ABORT) == 0 &&
5245 ((io->io_hdr.status & CTL_STATUS_MASK) == CTL_STATUS_NONE ||
5246 (io->io_hdr.status & CTL_STATUS_MASK) == CTL_SUCCESS)) {
5247 io->scsiio.io_cont(io);
5254 * This gets called by a backend driver when it is done with a
5255 * configuration write.
5258 ctl_config_write_done(union ctl_io *io)
5261 * If the IO_CONT flag is set, we need to call the supplied
5262 * function to continue processing the I/O, instead of completing
5265 * If there is an error, though, we don't want to keep processing.
5266 * Instead, just send status back to the initiator.
5268 if ((io->io_hdr.flags & CTL_FLAG_IO_CONT)
5269 && (((io->io_hdr.status & CTL_STATUS_MASK) == CTL_STATUS_NONE)
5270 || ((io->io_hdr.status & CTL_STATUS_MASK) == CTL_SUCCESS))) {
5271 io->scsiio.io_cont(io);
5275 * Since a configuration write can be done for commands that actually
5276 * have data allocated, like write buffer, and commands that have
5277 * no data, like start/stop unit, we need to check here.
5279 if ((io->io_hdr.flags & CTL_FLAG_DATA_MASK) == CTL_FLAG_DATA_OUT)
5280 free(io->scsiio.kern_data_ptr, M_CTL);
5285 * SCSI release command.
5288 ctl_scsi_release(struct ctl_scsiio *ctsio)
5290 int length, longid, thirdparty_id, resv_id;
5291 struct ctl_softc *ctl_softc;
5292 struct ctl_lun *lun;
5297 CTL_DEBUG_PRINT(("ctl_scsi_release\n"));
5299 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5300 ctl_softc = control_softc;
5302 switch (ctsio->cdb[0]) {
5304 struct scsi_release_10 *cdb;
5306 cdb = (struct scsi_release_10 *)ctsio->cdb;
5308 if (cdb->byte2 & SR10_LONGID)
5311 thirdparty_id = cdb->thirdparty_id;
5313 resv_id = cdb->resv_id;
5314 length = scsi_2btoul(cdb->length);
5321 * XXX KDM right now, we only support LUN reservation. We don't
5322 * support 3rd party reservations, or extent reservations, which
5323 * might actually need the parameter list. If we've gotten this
5324 * far, we've got a LUN reservation. Anything else got kicked out
5325 * above. So, according to SPC, ignore the length.
5329 if (((ctsio->io_hdr.flags & CTL_FLAG_ALLOCATED) == 0)
5331 ctsio->kern_data_ptr = malloc(length, M_CTL, M_WAITOK);
5332 ctsio->kern_data_len = length;
5333 ctsio->kern_total_len = length;
5334 ctsio->kern_data_resid = 0;
5335 ctsio->kern_rel_offset = 0;
5336 ctsio->kern_sg_entries = 0;
5337 ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
5338 ctsio->be_move_done = ctl_config_move_done;
5339 ctl_datamove((union ctl_io *)ctsio);
5341 return (CTL_RETVAL_COMPLETE);
5345 thirdparty_id = scsi_8btou64(ctsio->kern_data_ptr);
5347 mtx_lock(&lun->lun_lock);
5350 * According to SPC, it is not an error for an intiator to attempt
5351 * to release a reservation on a LUN that isn't reserved, or that
5352 * is reserved by another initiator. The reservation can only be
5353 * released, though, by the initiator who made it or by one of
5354 * several reset type events.
5356 if (lun->flags & CTL_LUN_RESERVED) {
5357 if ((ctsio->io_hdr.nexus.initid.id == lun->rsv_nexus.initid.id)
5358 && (ctsio->io_hdr.nexus.targ_port == lun->rsv_nexus.targ_port)
5359 && (ctsio->io_hdr.nexus.targ_target.id ==
5360 lun->rsv_nexus.targ_target.id)) {
5361 lun->flags &= ~CTL_LUN_RESERVED;
5365 mtx_unlock(&lun->lun_lock);
5367 ctsio->scsi_status = SCSI_STATUS_OK;
5368 ctsio->io_hdr.status = CTL_SUCCESS;
5370 if (ctsio->io_hdr.flags & CTL_FLAG_ALLOCATED) {
5371 free(ctsio->kern_data_ptr, M_CTL);
5372 ctsio->io_hdr.flags &= ~CTL_FLAG_ALLOCATED;
5375 ctl_done((union ctl_io *)ctsio);
5376 return (CTL_RETVAL_COMPLETE);
5380 ctl_scsi_reserve(struct ctl_scsiio *ctsio)
5382 int extent, thirdparty, longid;
5383 int resv_id, length;
5384 uint64_t thirdparty_id;
5385 struct ctl_softc *ctl_softc;
5386 struct ctl_lun *lun;
5395 CTL_DEBUG_PRINT(("ctl_reserve\n"));
5397 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5398 ctl_softc = control_softc;
5400 switch (ctsio->cdb[0]) {
5402 struct scsi_reserve_10 *cdb;
5404 cdb = (struct scsi_reserve_10 *)ctsio->cdb;
5406 if (cdb->byte2 & SR10_LONGID)
5409 thirdparty_id = cdb->thirdparty_id;
5411 resv_id = cdb->resv_id;
5412 length = scsi_2btoul(cdb->length);
5418 * XXX KDM right now, we only support LUN reservation. We don't
5419 * support 3rd party reservations, or extent reservations, which
5420 * might actually need the parameter list. If we've gotten this
5421 * far, we've got a LUN reservation. Anything else got kicked out
5422 * above. So, according to SPC, ignore the length.
5426 if (((ctsio->io_hdr.flags & CTL_FLAG_ALLOCATED) == 0)
5428 ctsio->kern_data_ptr = malloc(length, M_CTL, M_WAITOK);
5429 ctsio->kern_data_len = length;
5430 ctsio->kern_total_len = length;
5431 ctsio->kern_data_resid = 0;
5432 ctsio->kern_rel_offset = 0;
5433 ctsio->kern_sg_entries = 0;
5434 ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
5435 ctsio->be_move_done = ctl_config_move_done;
5436 ctl_datamove((union ctl_io *)ctsio);
5438 return (CTL_RETVAL_COMPLETE);
5442 thirdparty_id = scsi_8btou64(ctsio->kern_data_ptr);
5444 mtx_lock(&lun->lun_lock);
5445 if (lun->flags & CTL_LUN_RESERVED) {
5446 if ((ctsio->io_hdr.nexus.initid.id != lun->rsv_nexus.initid.id)
5447 || (ctsio->io_hdr.nexus.targ_port != lun->rsv_nexus.targ_port)
5448 || (ctsio->io_hdr.nexus.targ_target.id !=
5449 lun->rsv_nexus.targ_target.id)) {
5450 ctsio->scsi_status = SCSI_STATUS_RESERV_CONFLICT;
5451 ctsio->io_hdr.status = CTL_SCSI_ERROR;
5456 lun->flags |= CTL_LUN_RESERVED;
5457 lun->rsv_nexus = ctsio->io_hdr.nexus;
5459 ctsio->scsi_status = SCSI_STATUS_OK;
5460 ctsio->io_hdr.status = CTL_SUCCESS;
5463 mtx_unlock(&lun->lun_lock);
5465 if (ctsio->io_hdr.flags & CTL_FLAG_ALLOCATED) {
5466 free(ctsio->kern_data_ptr, M_CTL);
5467 ctsio->io_hdr.flags &= ~CTL_FLAG_ALLOCATED;
5470 ctl_done((union ctl_io *)ctsio);
5471 return (CTL_RETVAL_COMPLETE);
5475 ctl_start_stop(struct ctl_scsiio *ctsio)
5477 struct scsi_start_stop_unit *cdb;
5478 struct ctl_lun *lun;
5479 struct ctl_softc *ctl_softc;
5482 CTL_DEBUG_PRINT(("ctl_start_stop\n"));
5484 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5485 ctl_softc = control_softc;
5488 cdb = (struct scsi_start_stop_unit *)ctsio->cdb;
5492 * We don't support the immediate bit on a stop unit. In order to
5493 * do that, we would need to code up a way to know that a stop is
5494 * pending, and hold off any new commands until it completes, one
5495 * way or another. Then we could accept or reject those commands
5496 * depending on its status. We would almost need to do the reverse
5497 * of what we do below for an immediate start -- return the copy of
5498 * the ctl_io to the FETD with status to send to the host (and to
5499 * free the copy!) and then free the original I/O once the stop
5500 * actually completes. That way, the OOA queue mechanism can work
5501 * to block commands that shouldn't proceed. Another alternative
5502 * would be to put the copy in the queue in place of the original,
5503 * and return the original back to the caller. That could be
5506 if ((cdb->byte2 & SSS_IMMED)
5507 && ((cdb->how & SSS_START) == 0)) {
5508 ctl_set_invalid_field(ctsio,
5514 ctl_done((union ctl_io *)ctsio);
5515 return (CTL_RETVAL_COMPLETE);
5518 if ((lun->flags & CTL_LUN_PR_RESERVED)
5519 && ((cdb->how & SSS_START)==0)) {
5522 residx = ctl_get_resindex(&ctsio->io_hdr.nexus);
5523 if (!lun->per_res[residx].registered
5524 || (lun->pr_res_idx!=residx && lun->res_type < 4)) {
5526 ctl_set_reservation_conflict(ctsio);
5527 ctl_done((union ctl_io *)ctsio);
5528 return (CTL_RETVAL_COMPLETE);
5533 * If there is no backend on this device, we can't start or stop
5534 * it. In theory we shouldn't get any start/stop commands in the
5535 * first place at this level if the LUN doesn't have a backend.
5536 * That should get stopped by the command decode code.
5538 if (lun->backend == NULL) {
5539 ctl_set_invalid_opcode(ctsio);
5540 ctl_done((union ctl_io *)ctsio);
5541 return (CTL_RETVAL_COMPLETE);
5545 * XXX KDM Copan-specific offline behavior.
5546 * Figure out a reasonable way to port this?
5549 mtx_lock(&lun->lun_lock);
5551 if (((cdb->byte2 & SSS_ONOFFLINE) == 0)
5552 && (lun->flags & CTL_LUN_OFFLINE)) {
5554 * If the LUN is offline, and the on/offline bit isn't set,
5555 * reject the start or stop. Otherwise, let it through.
5557 mtx_unlock(&lun->lun_lock);
5558 ctl_set_lun_not_ready(ctsio);
5559 ctl_done((union ctl_io *)ctsio);
5561 mtx_unlock(&lun->lun_lock);
5562 #endif /* NEEDTOPORT */
5564 * This could be a start or a stop when we're online,
5565 * or a stop/offline or start/online. A start or stop when
5566 * we're offline is covered in the case above.
5569 * In the non-immediate case, we send the request to
5570 * the backend and return status to the user when
5573 * In the immediate case, we allocate a new ctl_io
5574 * to hold a copy of the request, and send that to
5575 * the backend. We then set good status on the
5576 * user's request and return it immediately.
5578 if (cdb->byte2 & SSS_IMMED) {
5579 union ctl_io *new_io;
5581 new_io = ctl_alloc_io(ctsio->io_hdr.pool);
5582 if (new_io == NULL) {
5583 ctl_set_busy(ctsio);
5584 ctl_done((union ctl_io *)ctsio);
5586 ctl_copy_io((union ctl_io *)ctsio,
5588 retval = lun->backend->config_write(new_io);
5589 ctl_set_success(ctsio);
5590 ctl_done((union ctl_io *)ctsio);
5593 retval = lun->backend->config_write(
5594 (union ctl_io *)ctsio);
5603 * We support the SYNCHRONIZE CACHE command (10 and 16 byte versions), but
5604 * we don't really do anything with the LBA and length fields if the user
5605 * passes them in. Instead we'll just flush out the cache for the entire
5609 ctl_sync_cache(struct ctl_scsiio *ctsio)
5611 struct ctl_lun *lun;
5612 struct ctl_softc *ctl_softc;
5613 uint64_t starting_lba;
5614 uint32_t block_count;
5617 CTL_DEBUG_PRINT(("ctl_sync_cache\n"));
5619 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5620 ctl_softc = control_softc;
5623 switch (ctsio->cdb[0]) {
5624 case SYNCHRONIZE_CACHE: {
5625 struct scsi_sync_cache *cdb;
5626 cdb = (struct scsi_sync_cache *)ctsio->cdb;
5628 starting_lba = scsi_4btoul(cdb->begin_lba);
5629 block_count = scsi_2btoul(cdb->lb_count);
5632 case SYNCHRONIZE_CACHE_16: {
5633 struct scsi_sync_cache_16 *cdb;
5634 cdb = (struct scsi_sync_cache_16 *)ctsio->cdb;
5636 starting_lba = scsi_8btou64(cdb->begin_lba);
5637 block_count = scsi_4btoul(cdb->lb_count);
5641 ctl_set_invalid_opcode(ctsio);
5642 ctl_done((union ctl_io *)ctsio);
5644 break; /* NOTREACHED */
5648 * We check the LBA and length, but don't do anything with them.
5649 * A SYNCHRONIZE CACHE will cause the entire cache for this lun to
5650 * get flushed. This check will just help satisfy anyone who wants
5651 * to see an error for an out of range LBA.
5653 if ((starting_lba + block_count) > (lun->be_lun->maxlba + 1)) {
5654 ctl_set_lba_out_of_range(ctsio);
5655 ctl_done((union ctl_io *)ctsio);
5660 * If this LUN has no backend, we can't flush the cache anyway.
5662 if (lun->backend == NULL) {
5663 ctl_set_invalid_opcode(ctsio);
5664 ctl_done((union ctl_io *)ctsio);
5669 * Check to see whether we're configured to send the SYNCHRONIZE
5670 * CACHE command directly to the back end.
5672 mtx_lock(&lun->lun_lock);
5673 if ((ctl_softc->flags & CTL_FLAG_REAL_SYNC)
5674 && (++(lun->sync_count) >= lun->sync_interval)) {
5675 lun->sync_count = 0;
5676 mtx_unlock(&lun->lun_lock);
5677 retval = lun->backend->config_write((union ctl_io *)ctsio);
5679 mtx_unlock(&lun->lun_lock);
5680 ctl_set_success(ctsio);
5681 ctl_done((union ctl_io *)ctsio);
5690 ctl_format(struct ctl_scsiio *ctsio)
5692 struct scsi_format *cdb;
5693 struct ctl_lun *lun;
5694 struct ctl_softc *ctl_softc;
5695 int length, defect_list_len;
5697 CTL_DEBUG_PRINT(("ctl_format\n"));
5699 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5700 ctl_softc = control_softc;
5702 cdb = (struct scsi_format *)ctsio->cdb;
5705 if (cdb->byte2 & SF_FMTDATA) {
5706 if (cdb->byte2 & SF_LONGLIST)
5707 length = sizeof(struct scsi_format_header_long);
5709 length = sizeof(struct scsi_format_header_short);
5712 if (((ctsio->io_hdr.flags & CTL_FLAG_ALLOCATED) == 0)
5714 ctsio->kern_data_ptr = malloc(length, M_CTL, M_WAITOK);
5715 ctsio->kern_data_len = length;
5716 ctsio->kern_total_len = length;
5717 ctsio->kern_data_resid = 0;
5718 ctsio->kern_rel_offset = 0;
5719 ctsio->kern_sg_entries = 0;
5720 ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
5721 ctsio->be_move_done = ctl_config_move_done;
5722 ctl_datamove((union ctl_io *)ctsio);
5724 return (CTL_RETVAL_COMPLETE);
5727 defect_list_len = 0;
5729 if (cdb->byte2 & SF_FMTDATA) {
5730 if (cdb->byte2 & SF_LONGLIST) {
5731 struct scsi_format_header_long *header;
5733 header = (struct scsi_format_header_long *)
5734 ctsio->kern_data_ptr;
5736 defect_list_len = scsi_4btoul(header->defect_list_len);
5737 if (defect_list_len != 0) {
5738 ctl_set_invalid_field(ctsio,
5747 struct scsi_format_header_short *header;
5749 header = (struct scsi_format_header_short *)
5750 ctsio->kern_data_ptr;
5752 defect_list_len = scsi_2btoul(header->defect_list_len);
5753 if (defect_list_len != 0) {
5754 ctl_set_invalid_field(ctsio,
5766 * The format command will clear out the "Medium format corrupted"
5767 * status if set by the configuration code. That status is really
5768 * just a way to notify the host that we have lost the media, and
5769 * get them to issue a command that will basically make them think
5770 * they're blowing away the media.
5772 mtx_lock(&lun->lun_lock);
5773 lun->flags &= ~CTL_LUN_INOPERABLE;
5774 mtx_unlock(&lun->lun_lock);
5776 ctsio->scsi_status = SCSI_STATUS_OK;
5777 ctsio->io_hdr.status = CTL_SUCCESS;
5780 if (ctsio->io_hdr.flags & CTL_FLAG_ALLOCATED) {
5781 free(ctsio->kern_data_ptr, M_CTL);
5782 ctsio->io_hdr.flags &= ~CTL_FLAG_ALLOCATED;
5785 ctl_done((union ctl_io *)ctsio);
5786 return (CTL_RETVAL_COMPLETE);
5790 ctl_read_buffer(struct ctl_scsiio *ctsio)
5792 struct scsi_read_buffer *cdb;
5793 struct ctl_lun *lun;
5794 int buffer_offset, len;
5795 static uint8_t descr[4];
5796 static uint8_t echo_descr[4] = { 0 };
5798 CTL_DEBUG_PRINT(("ctl_read_buffer\n"));
5800 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5801 cdb = (struct scsi_read_buffer *)ctsio->cdb;
5803 if (lun->flags & CTL_LUN_PR_RESERVED) {
5807 * XXX KDM need a lock here.
5809 residx = ctl_get_resindex(&ctsio->io_hdr.nexus);
5810 if ((lun->res_type == SPR_TYPE_EX_AC
5811 && residx != lun->pr_res_idx)
5812 || ((lun->res_type == SPR_TYPE_EX_AC_RO
5813 || lun->res_type == SPR_TYPE_EX_AC_AR)
5814 && !lun->per_res[residx].registered)) {
5815 ctl_set_reservation_conflict(ctsio);
5816 ctl_done((union ctl_io *)ctsio);
5817 return (CTL_RETVAL_COMPLETE);
5821 if ((cdb->byte2 & RWB_MODE) != RWB_MODE_DATA &&
5822 (cdb->byte2 & RWB_MODE) != RWB_MODE_ECHO_DESCR &&
5823 (cdb->byte2 & RWB_MODE) != RWB_MODE_DESCR) {
5824 ctl_set_invalid_field(ctsio,
5830 ctl_done((union ctl_io *)ctsio);
5831 return (CTL_RETVAL_COMPLETE);
5834 len = scsi_3btoul(cdb->length);
5835 buffer_offset = scsi_3btoul(cdb->offset);
5837 if (buffer_offset + len > sizeof(lun->write_buffer)) {
5838 ctl_set_invalid_field(ctsio,
5844 ctl_done((union ctl_io *)ctsio);
5845 return (CTL_RETVAL_COMPLETE);
5848 if ((cdb->byte2 & RWB_MODE) == RWB_MODE_DESCR) {
5850 scsi_ulto3b(sizeof(lun->write_buffer), &descr[1]);
5851 ctsio->kern_data_ptr = descr;
5852 len = min(len, sizeof(descr));
5853 } else if ((cdb->byte2 & RWB_MODE) == RWB_MODE_ECHO_DESCR) {
5854 ctsio->kern_data_ptr = echo_descr;
5855 len = min(len, sizeof(echo_descr));
5857 ctsio->kern_data_ptr = lun->write_buffer + buffer_offset;
5858 ctsio->kern_data_len = len;
5859 ctsio->kern_total_len = len;
5860 ctsio->kern_data_resid = 0;
5861 ctsio->kern_rel_offset = 0;
5862 ctsio->kern_sg_entries = 0;
5863 ctsio->be_move_done = ctl_config_move_done;
5864 ctl_datamove((union ctl_io *)ctsio);
5866 return (CTL_RETVAL_COMPLETE);
5870 ctl_write_buffer(struct ctl_scsiio *ctsio)
5872 struct scsi_write_buffer *cdb;
5873 struct ctl_lun *lun;
5874 int buffer_offset, len;
5876 CTL_DEBUG_PRINT(("ctl_write_buffer\n"));
5878 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5879 cdb = (struct scsi_write_buffer *)ctsio->cdb;
5881 if ((cdb->byte2 & RWB_MODE) != RWB_MODE_DATA) {
5882 ctl_set_invalid_field(ctsio,
5888 ctl_done((union ctl_io *)ctsio);
5889 return (CTL_RETVAL_COMPLETE);
5892 len = scsi_3btoul(cdb->length);
5893 buffer_offset = scsi_3btoul(cdb->offset);
5895 if (buffer_offset + len > sizeof(lun->write_buffer)) {
5896 ctl_set_invalid_field(ctsio,
5902 ctl_done((union ctl_io *)ctsio);
5903 return (CTL_RETVAL_COMPLETE);
5907 * If we've got a kernel request that hasn't been malloced yet,
5908 * malloc it and tell the caller the data buffer is here.
5910 if ((ctsio->io_hdr.flags & CTL_FLAG_ALLOCATED) == 0) {
5911 ctsio->kern_data_ptr = lun->write_buffer + buffer_offset;
5912 ctsio->kern_data_len = len;
5913 ctsio->kern_total_len = len;
5914 ctsio->kern_data_resid = 0;
5915 ctsio->kern_rel_offset = 0;
5916 ctsio->kern_sg_entries = 0;
5917 ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
5918 ctsio->be_move_done = ctl_config_move_done;
5919 ctl_datamove((union ctl_io *)ctsio);
5921 return (CTL_RETVAL_COMPLETE);
5924 ctl_done((union ctl_io *)ctsio);
5926 return (CTL_RETVAL_COMPLETE);
5930 ctl_write_same(struct ctl_scsiio *ctsio)
5932 struct ctl_lun *lun;
5933 struct ctl_lba_len_flags *lbalen;
5935 uint32_t num_blocks;
5939 retval = CTL_RETVAL_COMPLETE;
5941 CTL_DEBUG_PRINT(("ctl_write_same\n"));
5943 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5945 switch (ctsio->cdb[0]) {
5946 case WRITE_SAME_10: {
5947 struct scsi_write_same_10 *cdb;
5949 cdb = (struct scsi_write_same_10 *)ctsio->cdb;
5951 lba = scsi_4btoul(cdb->addr);
5952 num_blocks = scsi_2btoul(cdb->length);
5956 case WRITE_SAME_16: {
5957 struct scsi_write_same_16 *cdb;
5959 cdb = (struct scsi_write_same_16 *)ctsio->cdb;
5961 lba = scsi_8btou64(cdb->addr);
5962 num_blocks = scsi_4btoul(cdb->length);
5968 * We got a command we don't support. This shouldn't
5969 * happen, commands should be filtered out above us.
5971 ctl_set_invalid_opcode(ctsio);
5972 ctl_done((union ctl_io *)ctsio);
5974 return (CTL_RETVAL_COMPLETE);
5975 break; /* NOTREACHED */
5979 * The first check is to make sure we're in bounds, the second
5980 * check is to catch wrap-around problems. If the lba + num blocks
5981 * is less than the lba, then we've wrapped around and the block
5982 * range is invalid anyway.
5984 if (((lba + num_blocks) > (lun->be_lun->maxlba + 1))
5985 || ((lba + num_blocks) < lba)) {
5986 ctl_set_lba_out_of_range(ctsio);
5987 ctl_done((union ctl_io *)ctsio);
5988 return (CTL_RETVAL_COMPLETE);
5991 /* Zero number of blocks means "to the last logical block" */
5992 if (num_blocks == 0) {
5993 if ((lun->be_lun->maxlba + 1) - lba > UINT32_MAX) {
5994 ctl_set_invalid_field(ctsio,
6000 ctl_done((union ctl_io *)ctsio);
6001 return (CTL_RETVAL_COMPLETE);
6003 num_blocks = (lun->be_lun->maxlba + 1) - lba;
6006 len = lun->be_lun->blocksize;
6009 * If we've got a kernel request that hasn't been malloced yet,
6010 * malloc it and tell the caller the data buffer is here.
6012 if ((ctsio->io_hdr.flags & CTL_FLAG_ALLOCATED) == 0) {
6013 ctsio->kern_data_ptr = malloc(len, M_CTL, M_WAITOK);;
6014 ctsio->kern_data_len = len;
6015 ctsio->kern_total_len = len;
6016 ctsio->kern_data_resid = 0;
6017 ctsio->kern_rel_offset = 0;
6018 ctsio->kern_sg_entries = 0;
6019 ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
6020 ctsio->be_move_done = ctl_config_move_done;
6021 ctl_datamove((union ctl_io *)ctsio);
6023 return (CTL_RETVAL_COMPLETE);
6026 lbalen = (struct ctl_lba_len_flags *)&ctsio->io_hdr.ctl_private[CTL_PRIV_LBA_LEN];
6028 lbalen->len = num_blocks;
6029 lbalen->flags = byte2;
6030 retval = lun->backend->config_write((union ctl_io *)ctsio);
6036 ctl_unmap(struct ctl_scsiio *ctsio)
6038 struct ctl_lun *lun;
6039 struct scsi_unmap *cdb;
6040 struct ctl_ptr_len_flags *ptrlen;
6041 struct scsi_unmap_header *hdr;
6042 struct scsi_unmap_desc *buf, *end;
6044 uint32_t num_blocks;
6048 retval = CTL_RETVAL_COMPLETE;
6050 CTL_DEBUG_PRINT(("ctl_unmap\n"));
6052 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
6053 cdb = (struct scsi_unmap *)ctsio->cdb;
6055 len = scsi_2btoul(cdb->length);
6059 * If we've got a kernel request that hasn't been malloced yet,
6060 * malloc it and tell the caller the data buffer is here.
6062 if ((ctsio->io_hdr.flags & CTL_FLAG_ALLOCATED) == 0) {
6063 ctsio->kern_data_ptr = malloc(len, M_CTL, M_WAITOK);;
6064 ctsio->kern_data_len = len;
6065 ctsio->kern_total_len = len;
6066 ctsio->kern_data_resid = 0;
6067 ctsio->kern_rel_offset = 0;
6068 ctsio->kern_sg_entries = 0;
6069 ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
6070 ctsio->be_move_done = ctl_config_move_done;
6071 ctl_datamove((union ctl_io *)ctsio);
6073 return (CTL_RETVAL_COMPLETE);
6076 len = ctsio->kern_total_len - ctsio->kern_data_resid;
6077 hdr = (struct scsi_unmap_header *)ctsio->kern_data_ptr;
6078 if (len < sizeof (*hdr) ||
6079 len < (scsi_2btoul(hdr->length) + sizeof(hdr->length)) ||
6080 len < (scsi_2btoul(hdr->desc_length) + sizeof (*hdr)) ||
6081 scsi_2btoul(hdr->desc_length) % sizeof(*buf) != 0) {
6082 ctl_set_invalid_field(ctsio,
6088 ctl_done((union ctl_io *)ctsio);
6089 return (CTL_RETVAL_COMPLETE);
6091 len = scsi_2btoul(hdr->desc_length);
6092 buf = (struct scsi_unmap_desc *)(hdr + 1);
6093 end = buf + len / sizeof(*buf);
6095 ptrlen = (struct ctl_ptr_len_flags *)&ctsio->io_hdr.ctl_private[CTL_PRIV_LBA_LEN];
6096 ptrlen->ptr = (void *)buf;
6098 ptrlen->flags = byte2;
6100 for (; buf < end; buf++) {
6101 lba = scsi_8btou64(buf->lba);
6102 num_blocks = scsi_4btoul(buf->length);
6103 if (((lba + num_blocks) > (lun->be_lun->maxlba + 1))
6104 || ((lba + num_blocks) < lba)) {
6105 ctl_set_lba_out_of_range(ctsio);
6106 ctl_done((union ctl_io *)ctsio);
6107 return (CTL_RETVAL_COMPLETE);
6111 retval = lun->backend->config_write((union ctl_io *)ctsio);
6117 * Note that this function currently doesn't actually do anything inside
6118 * CTL to enforce things if the DQue bit is turned on.
6120 * Also note that this function can't be used in the default case, because
6121 * the DQue bit isn't set in the changeable mask for the control mode page
6122 * anyway. This is just here as an example for how to implement a page
6123 * handler, and a placeholder in case we want to allow the user to turn
6124 * tagged queueing on and off.
6126 * The D_SENSE bit handling is functional, however, and will turn
6127 * descriptor sense on and off for a given LUN.
6130 ctl_control_page_handler(struct ctl_scsiio *ctsio,
6131 struct ctl_page_index *page_index, uint8_t *page_ptr)
6133 struct scsi_control_page *current_cp, *saved_cp, *user_cp;
6134 struct ctl_lun *lun;
6135 struct ctl_softc *softc;
6139 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
6140 initidx = ctl_get_initindex(&ctsio->io_hdr.nexus);
6143 user_cp = (struct scsi_control_page *)page_ptr;
6144 current_cp = (struct scsi_control_page *)
6145 (page_index->page_data + (page_index->page_len *
6147 saved_cp = (struct scsi_control_page *)
6148 (page_index->page_data + (page_index->page_len *
6151 softc = control_softc;
6153 mtx_lock(&lun->lun_lock);
6154 if (((current_cp->rlec & SCP_DSENSE) == 0)
6155 && ((user_cp->rlec & SCP_DSENSE) != 0)) {
6157 * Descriptor sense is currently turned off and the user
6158 * wants to turn it on.
6160 current_cp->rlec |= SCP_DSENSE;
6161 saved_cp->rlec |= SCP_DSENSE;
6162 lun->flags |= CTL_LUN_SENSE_DESC;
6164 } else if (((current_cp->rlec & SCP_DSENSE) != 0)
6165 && ((user_cp->rlec & SCP_DSENSE) == 0)) {
6167 * Descriptor sense is currently turned on, and the user
6168 * wants to turn it off.
6170 current_cp->rlec &= ~SCP_DSENSE;
6171 saved_cp->rlec &= ~SCP_DSENSE;
6172 lun->flags &= ~CTL_LUN_SENSE_DESC;
6175 if (current_cp->queue_flags & SCP_QUEUE_DQUE) {
6176 if (user_cp->queue_flags & SCP_QUEUE_DQUE) {
6178 csevent_log(CSC_CTL | CSC_SHELF_SW |
6180 csevent_LogType_Trace,
6181 csevent_Severity_Information,
6182 csevent_AlertLevel_Green,
6183 csevent_FRU_Firmware,
6184 csevent_FRU_Unknown,
6185 "Received untagged to untagged transition");
6186 #endif /* NEEDTOPORT */
6189 csevent_log(CSC_CTL | CSC_SHELF_SW |
6191 csevent_LogType_ConfigChange,
6192 csevent_Severity_Information,
6193 csevent_AlertLevel_Green,
6194 csevent_FRU_Firmware,
6195 csevent_FRU_Unknown,
6196 "Received untagged to tagged "
6197 "queueing transition");
6198 #endif /* NEEDTOPORT */
6200 current_cp->queue_flags &= ~SCP_QUEUE_DQUE;
6201 saved_cp->queue_flags &= ~SCP_QUEUE_DQUE;
6205 if (user_cp->queue_flags & SCP_QUEUE_DQUE) {
6207 csevent_log(CSC_CTL | CSC_SHELF_SW |
6209 csevent_LogType_ConfigChange,
6210 csevent_Severity_Warning,
6211 csevent_AlertLevel_Yellow,
6212 csevent_FRU_Firmware,
6213 csevent_FRU_Unknown,
6214 "Received tagged queueing to untagged "
6216 #endif /* NEEDTOPORT */
6218 current_cp->queue_flags |= SCP_QUEUE_DQUE;
6219 saved_cp->queue_flags |= SCP_QUEUE_DQUE;
6223 csevent_log(CSC_CTL | CSC_SHELF_SW |
6225 csevent_LogType_Trace,
6226 csevent_Severity_Information,
6227 csevent_AlertLevel_Green,
6228 csevent_FRU_Firmware,
6229 csevent_FRU_Unknown,
6230 "Received tagged queueing to tagged "
6231 "queueing transition");
6232 #endif /* NEEDTOPORT */
6238 * Let other initiators know that the mode
6239 * parameters for this LUN have changed.
6241 for (i = 0; i < CTL_MAX_INITIATORS; i++) {
6245 lun->pending_ua[i] |= CTL_UA_MODE_CHANGE;
6248 mtx_unlock(&lun->lun_lock);
6254 ctl_power_sp_handler(struct ctl_scsiio *ctsio,
6255 struct ctl_page_index *page_index, uint8_t *page_ptr)
6261 ctl_power_sp_sense_handler(struct ctl_scsiio *ctsio,
6262 struct ctl_page_index *page_index, int pc)
6264 struct copan_power_subpage *page;
6266 page = (struct copan_power_subpage *)page_index->page_data +
6267 (page_index->page_len * pc);
6270 case SMS_PAGE_CTRL_CHANGEABLE >> 6:
6272 * We don't update the changable bits for this page.
6275 case SMS_PAGE_CTRL_CURRENT >> 6:
6276 case SMS_PAGE_CTRL_DEFAULT >> 6:
6277 case SMS_PAGE_CTRL_SAVED >> 6:
6279 ctl_update_power_subpage(page);
6284 EPRINT(0, "Invalid PC %d!!", pc);
6293 ctl_aps_sp_handler(struct ctl_scsiio *ctsio,
6294 struct ctl_page_index *page_index, uint8_t *page_ptr)
6296 struct copan_aps_subpage *user_sp;
6297 struct copan_aps_subpage *current_sp;
6298 union ctl_modepage_info *modepage_info;
6299 struct ctl_softc *softc;
6300 struct ctl_lun *lun;
6303 retval = CTL_RETVAL_COMPLETE;
6304 current_sp = (struct copan_aps_subpage *)(page_index->page_data +
6305 (page_index->page_len * CTL_PAGE_CURRENT));
6306 softc = control_softc;
6307 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
6309 user_sp = (struct copan_aps_subpage *)page_ptr;
6311 modepage_info = (union ctl_modepage_info *)
6312 ctsio->io_hdr.ctl_private[CTL_PRIV_MODEPAGE].bytes;
6314 modepage_info->header.page_code = page_index->page_code & SMPH_PC_MASK;
6315 modepage_info->header.subpage = page_index->subpage;
6316 modepage_info->aps.lock_active = user_sp->lock_active;
6318 mtx_lock(&softc->ctl_lock);
6321 * If there is a request to lock the LUN and another LUN is locked
6322 * this is an error. If the requested LUN is already locked ignore
6323 * the request. If no LUN is locked attempt to lock it.
6324 * if there is a request to unlock the LUN and the LUN is currently
6325 * locked attempt to unlock it. Otherwise ignore the request. i.e.
6326 * if another LUN is locked or no LUN is locked.
6328 if (user_sp->lock_active & APS_LOCK_ACTIVE) {
6329 if (softc->aps_locked_lun == lun->lun) {
6331 * This LUN is already locked, so we're done.
6333 retval = CTL_RETVAL_COMPLETE;
6334 } else if (softc->aps_locked_lun == 0) {
6336 * No one has the lock, pass the request to the
6339 retval = lun->backend->config_write(
6340 (union ctl_io *)ctsio);
6343 * Someone else has the lock, throw out the request.
6345 ctl_set_already_locked(ctsio);
6346 free(ctsio->kern_data_ptr, M_CTL);
6347 ctl_done((union ctl_io *)ctsio);
6350 * Set the return value so that ctl_do_mode_select()
6351 * won't try to complete the command. We already
6352 * completed it here.
6354 retval = CTL_RETVAL_ERROR;
6356 } else if (softc->aps_locked_lun == lun->lun) {
6358 * This LUN is locked, so pass the unlock request to the
6361 retval = lun->backend->config_write((union ctl_io *)ctsio);
6363 mtx_unlock(&softc->ctl_lock);
6369 ctl_debugconf_sp_select_handler(struct ctl_scsiio *ctsio,
6370 struct ctl_page_index *page_index,
6376 c = ((struct copan_debugconf_subpage *)page_ptr)->ctl_time_io_secs;
6381 CTL_DEBUG_PRINT(("set ctl_time_io_secs to %d\n", ctl_time_io_secs));
6382 printf("set ctl_time_io_secs to %d\n", ctl_time_io_secs);
6383 printf("page data:");
6385 printf(" %.2x",page_ptr[i]);
6391 ctl_debugconf_sp_sense_handler(struct ctl_scsiio *ctsio,
6392 struct ctl_page_index *page_index,
6395 struct copan_debugconf_subpage *page;
6397 page = (struct copan_debugconf_subpage *)page_index->page_data +
6398 (page_index->page_len * pc);
6401 case SMS_PAGE_CTRL_CHANGEABLE >> 6:
6402 case SMS_PAGE_CTRL_DEFAULT >> 6:
6403 case SMS_PAGE_CTRL_SAVED >> 6:
6405 * We don't update the changable or default bits for this page.
6408 case SMS_PAGE_CTRL_CURRENT >> 6:
6409 page->ctl_time_io_secs[0] = ctl_time_io_secs >> 8;
6410 page->ctl_time_io_secs[1] = ctl_time_io_secs >> 0;
6414 EPRINT(0, "Invalid PC %d!!", pc);
6415 #endif /* NEEDTOPORT */
6423 ctl_do_mode_select(union ctl_io *io)
6425 struct scsi_mode_page_header *page_header;
6426 struct ctl_page_index *page_index;
6427 struct ctl_scsiio *ctsio;
6428 int control_dev, page_len;
6429 int page_len_offset, page_len_size;
6430 union ctl_modepage_info *modepage_info;
6431 struct ctl_lun *lun;
6432 int *len_left, *len_used;
6435 ctsio = &io->scsiio;
6438 retval = CTL_RETVAL_COMPLETE;
6440 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
6442 if (lun->be_lun->lun_type != T_DIRECT)
6447 modepage_info = (union ctl_modepage_info *)
6448 ctsio->io_hdr.ctl_private[CTL_PRIV_MODEPAGE].bytes;
6449 len_left = &modepage_info->header.len_left;
6450 len_used = &modepage_info->header.len_used;
6454 page_header = (struct scsi_mode_page_header *)
6455 (ctsio->kern_data_ptr + *len_used);
6457 if (*len_left == 0) {
6458 free(ctsio->kern_data_ptr, M_CTL);
6459 ctl_set_success(ctsio);
6460 ctl_done((union ctl_io *)ctsio);
6461 return (CTL_RETVAL_COMPLETE);
6462 } else if (*len_left < sizeof(struct scsi_mode_page_header)) {
6464 free(ctsio->kern_data_ptr, M_CTL);
6465 ctl_set_param_len_error(ctsio);
6466 ctl_done((union ctl_io *)ctsio);
6467 return (CTL_RETVAL_COMPLETE);
6469 } else if ((page_header->page_code & SMPH_SPF)
6470 && (*len_left < sizeof(struct scsi_mode_page_header_sp))) {
6472 free(ctsio->kern_data_ptr, M_CTL);
6473 ctl_set_param_len_error(ctsio);
6474 ctl_done((union ctl_io *)ctsio);
6475 return (CTL_RETVAL_COMPLETE);
6480 * XXX KDM should we do something with the block descriptor?
6482 for (i = 0; i < CTL_NUM_MODE_PAGES; i++) {
6484 if ((control_dev != 0)
6485 && (lun->mode_pages.index[i].page_flags &
6486 CTL_PAGE_FLAG_DISK_ONLY))
6489 if ((lun->mode_pages.index[i].page_code & SMPH_PC_MASK) !=
6490 (page_header->page_code & SMPH_PC_MASK))
6494 * If neither page has a subpage code, then we've got a
6497 if (((lun->mode_pages.index[i].page_code & SMPH_SPF) == 0)
6498 && ((page_header->page_code & SMPH_SPF) == 0)) {
6499 page_index = &lun->mode_pages.index[i];
6500 page_len = page_header->page_length;
6505 * If both pages have subpages, then the subpage numbers
6508 if ((lun->mode_pages.index[i].page_code & SMPH_SPF)
6509 && (page_header->page_code & SMPH_SPF)) {
6510 struct scsi_mode_page_header_sp *sph;
6512 sph = (struct scsi_mode_page_header_sp *)page_header;
6514 if (lun->mode_pages.index[i].subpage ==
6516 page_index = &lun->mode_pages.index[i];
6517 page_len = scsi_2btoul(sph->page_length);
6524 * If we couldn't find the page, or if we don't have a mode select
6525 * handler for it, send back an error to the user.
6527 if ((page_index == NULL)
6528 || (page_index->select_handler == NULL)) {
6529 ctl_set_invalid_field(ctsio,
6532 /*field*/ *len_used,
6535 free(ctsio->kern_data_ptr, M_CTL);
6536 ctl_done((union ctl_io *)ctsio);
6537 return (CTL_RETVAL_COMPLETE);
6540 if (page_index->page_code & SMPH_SPF) {
6541 page_len_offset = 2;
6545 page_len_offset = 1;
6549 * If the length the initiator gives us isn't the one we specify in
6550 * the mode page header, or if they didn't specify enough data in
6551 * the CDB to avoid truncating this page, kick out the request.
6553 if ((page_len != (page_index->page_len - page_len_offset -
6555 || (*len_left < page_index->page_len)) {
6558 ctl_set_invalid_field(ctsio,
6561 /*field*/ *len_used + page_len_offset,
6564 free(ctsio->kern_data_ptr, M_CTL);
6565 ctl_done((union ctl_io *)ctsio);
6566 return (CTL_RETVAL_COMPLETE);
6570 * Run through the mode page, checking to make sure that the bits
6571 * the user changed are actually legal for him to change.
6573 for (i = 0; i < page_index->page_len; i++) {
6574 uint8_t *user_byte, *change_mask, *current_byte;
6578 user_byte = (uint8_t *)page_header + i;
6579 change_mask = page_index->page_data +
6580 (page_index->page_len * CTL_PAGE_CHANGEABLE) + i;
6581 current_byte = page_index->page_data +
6582 (page_index->page_len * CTL_PAGE_CURRENT) + i;
6585 * Check to see whether the user set any bits in this byte
6586 * that he is not allowed to set.
6588 if ((*user_byte & ~(*change_mask)) ==
6589 (*current_byte & ~(*change_mask)))
6593 * Go through bit by bit to determine which one is illegal.
6596 for (j = 7; j >= 0; j--) {
6597 if ((((1 << i) & ~(*change_mask)) & *user_byte) !=
6598 (((1 << i) & ~(*change_mask)) & *current_byte)) {
6603 ctl_set_invalid_field(ctsio,
6606 /*field*/ *len_used + i,
6609 free(ctsio->kern_data_ptr, M_CTL);
6610 ctl_done((union ctl_io *)ctsio);
6611 return (CTL_RETVAL_COMPLETE);
6615 * Decrement these before we call the page handler, since we may
6616 * end up getting called back one way or another before the handler
6617 * returns to this context.
6619 *len_left -= page_index->page_len;
6620 *len_used += page_index->page_len;
6622 retval = page_index->select_handler(ctsio, page_index,
6623 (uint8_t *)page_header);
6626 * If the page handler returns CTL_RETVAL_QUEUED, then we need to
6627 * wait until this queued command completes to finish processing
6628 * the mode page. If it returns anything other than
6629 * CTL_RETVAL_COMPLETE (e.g. CTL_RETVAL_ERROR), then it should have
6630 * already set the sense information, freed the data pointer, and
6631 * completed the io for us.
6633 if (retval != CTL_RETVAL_COMPLETE)
6634 goto bailout_no_done;
6637 * If the initiator sent us more than one page, parse the next one.
6642 ctl_set_success(ctsio);
6643 free(ctsio->kern_data_ptr, M_CTL);
6644 ctl_done((union ctl_io *)ctsio);
6648 return (CTL_RETVAL_COMPLETE);
6653 ctl_mode_select(struct ctl_scsiio *ctsio)
6655 int param_len, pf, sp;
6656 int header_size, bd_len;
6657 int len_left, len_used;
6658 struct ctl_page_index *page_index;
6659 struct ctl_lun *lun;
6660 int control_dev, page_len;
6661 union ctl_modepage_info *modepage_info;
6673 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
6675 if (lun->be_lun->lun_type != T_DIRECT)
6680 switch (ctsio->cdb[0]) {
6681 case MODE_SELECT_6: {
6682 struct scsi_mode_select_6 *cdb;
6684 cdb = (struct scsi_mode_select_6 *)ctsio->cdb;
6686 pf = (cdb->byte2 & SMS_PF) ? 1 : 0;
6687 sp = (cdb->byte2 & SMS_SP) ? 1 : 0;
6689 param_len = cdb->length;
6690 header_size = sizeof(struct scsi_mode_header_6);
6693 case MODE_SELECT_10: {
6694 struct scsi_mode_select_10 *cdb;
6696 cdb = (struct scsi_mode_select_10 *)ctsio->cdb;
6698 pf = (cdb->byte2 & SMS_PF) ? 1 : 0;
6699 sp = (cdb->byte2 & SMS_SP) ? 1 : 0;
6701 param_len = scsi_2btoul(cdb->length);
6702 header_size = sizeof(struct scsi_mode_header_10);
6706 ctl_set_invalid_opcode(ctsio);
6707 ctl_done((union ctl_io *)ctsio);
6708 return (CTL_RETVAL_COMPLETE);
6709 break; /* NOTREACHED */
6714 * "A parameter list length of zero indicates that the Data-Out Buffer
6715 * shall be empty. This condition shall not be considered as an error."
6717 if (param_len == 0) {
6718 ctl_set_success(ctsio);
6719 ctl_done((union ctl_io *)ctsio);
6720 return (CTL_RETVAL_COMPLETE);
6724 * Since we'll hit this the first time through, prior to
6725 * allocation, we don't need to free a data buffer here.
6727 if (param_len < header_size) {
6728 ctl_set_param_len_error(ctsio);
6729 ctl_done((union ctl_io *)ctsio);
6730 return (CTL_RETVAL_COMPLETE);
6734 * Allocate the data buffer and grab the user's data. In theory,
6735 * we shouldn't have to sanity check the parameter list length here
6736 * because the maximum size is 64K. We should be able to malloc
6737 * that much without too many problems.
6739 if ((ctsio->io_hdr.flags & CTL_FLAG_ALLOCATED) == 0) {
6740 ctsio->kern_data_ptr = malloc(param_len, M_CTL, M_WAITOK);
6741 ctsio->kern_data_len = param_len;
6742 ctsio->kern_total_len = param_len;
6743 ctsio->kern_data_resid = 0;
6744 ctsio->kern_rel_offset = 0;
6745 ctsio->kern_sg_entries = 0;
6746 ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
6747 ctsio->be_move_done = ctl_config_move_done;
6748 ctl_datamove((union ctl_io *)ctsio);
6750 return (CTL_RETVAL_COMPLETE);
6753 switch (ctsio->cdb[0]) {
6754 case MODE_SELECT_6: {
6755 struct scsi_mode_header_6 *mh6;
6757 mh6 = (struct scsi_mode_header_6 *)ctsio->kern_data_ptr;
6758 bd_len = mh6->blk_desc_len;
6761 case MODE_SELECT_10: {
6762 struct scsi_mode_header_10 *mh10;
6764 mh10 = (struct scsi_mode_header_10 *)ctsio->kern_data_ptr;
6765 bd_len = scsi_2btoul(mh10->blk_desc_len);
6769 panic("Invalid CDB type %#x", ctsio->cdb[0]);
6773 if (param_len < (header_size + bd_len)) {
6774 free(ctsio->kern_data_ptr, M_CTL);
6775 ctl_set_param_len_error(ctsio);
6776 ctl_done((union ctl_io *)ctsio);
6777 return (CTL_RETVAL_COMPLETE);
6781 * Set the IO_CONT flag, so that if this I/O gets passed to
6782 * ctl_config_write_done(), it'll get passed back to
6783 * ctl_do_mode_select() for further processing, or completion if
6786 ctsio->io_hdr.flags |= CTL_FLAG_IO_CONT;
6787 ctsio->io_cont = ctl_do_mode_select;
6789 modepage_info = (union ctl_modepage_info *)
6790 ctsio->io_hdr.ctl_private[CTL_PRIV_MODEPAGE].bytes;
6792 memset(modepage_info, 0, sizeof(*modepage_info));
6794 len_left = param_len - header_size - bd_len;
6795 len_used = header_size + bd_len;
6797 modepage_info->header.len_left = len_left;
6798 modepage_info->header.len_used = len_used;
6800 return (ctl_do_mode_select((union ctl_io *)ctsio));
6804 ctl_mode_sense(struct ctl_scsiio *ctsio)
6806 struct ctl_lun *lun;
6807 int pc, page_code, dbd, llba, subpage;
6808 int alloc_len, page_len, header_len, total_len;
6809 struct scsi_mode_block_descr *block_desc;
6810 struct ctl_page_index *page_index;
6818 CTL_DEBUG_PRINT(("ctl_mode_sense\n"));
6820 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
6822 if (lun->be_lun->lun_type != T_DIRECT)
6827 if (lun->flags & CTL_LUN_PR_RESERVED) {
6831 * XXX KDM need a lock here.
6833 residx = ctl_get_resindex(&ctsio->io_hdr.nexus);
6834 if ((lun->res_type == SPR_TYPE_EX_AC
6835 && residx != lun->pr_res_idx)
6836 || ((lun->res_type == SPR_TYPE_EX_AC_RO
6837 || lun->res_type == SPR_TYPE_EX_AC_AR)
6838 && !lun->per_res[residx].registered)) {
6839 ctl_set_reservation_conflict(ctsio);
6840 ctl_done((union ctl_io *)ctsio);
6841 return (CTL_RETVAL_COMPLETE);
6845 switch (ctsio->cdb[0]) {
6846 case MODE_SENSE_6: {
6847 struct scsi_mode_sense_6 *cdb;
6849 cdb = (struct scsi_mode_sense_6 *)ctsio->cdb;
6851 header_len = sizeof(struct scsi_mode_hdr_6);
6852 if (cdb->byte2 & SMS_DBD)
6855 header_len += sizeof(struct scsi_mode_block_descr);
6857 pc = (cdb->page & SMS_PAGE_CTRL_MASK) >> 6;
6858 page_code = cdb->page & SMS_PAGE_CODE;
6859 subpage = cdb->subpage;
6860 alloc_len = cdb->length;
6863 case MODE_SENSE_10: {
6864 struct scsi_mode_sense_10 *cdb;
6866 cdb = (struct scsi_mode_sense_10 *)ctsio->cdb;
6868 header_len = sizeof(struct scsi_mode_hdr_10);
6870 if (cdb->byte2 & SMS_DBD)
6873 header_len += sizeof(struct scsi_mode_block_descr);
6874 if (cdb->byte2 & SMS10_LLBAA)
6876 pc = (cdb->page & SMS_PAGE_CTRL_MASK) >> 6;
6877 page_code = cdb->page & SMS_PAGE_CODE;
6878 subpage = cdb->subpage;
6879 alloc_len = scsi_2btoul(cdb->length);
6883 ctl_set_invalid_opcode(ctsio);
6884 ctl_done((union ctl_io *)ctsio);
6885 return (CTL_RETVAL_COMPLETE);
6886 break; /* NOTREACHED */
6890 * We have to make a first pass through to calculate the size of
6891 * the pages that match the user's query. Then we allocate enough
6892 * memory to hold it, and actually copy the data into the buffer.
6894 switch (page_code) {
6895 case SMS_ALL_PAGES_PAGE: {
6901 * At the moment, values other than 0 and 0xff here are
6902 * reserved according to SPC-3.
6904 if ((subpage != SMS_SUBPAGE_PAGE_0)
6905 && (subpage != SMS_SUBPAGE_ALL)) {
6906 ctl_set_invalid_field(ctsio,
6912 ctl_done((union ctl_io *)ctsio);
6913 return (CTL_RETVAL_COMPLETE);
6916 for (i = 0; i < CTL_NUM_MODE_PAGES; i++) {
6917 if ((control_dev != 0)
6918 && (lun->mode_pages.index[i].page_flags &
6919 CTL_PAGE_FLAG_DISK_ONLY))
6923 * We don't use this subpage if the user didn't
6924 * request all subpages.
6926 if ((lun->mode_pages.index[i].subpage != 0)
6927 && (subpage == SMS_SUBPAGE_PAGE_0))
6931 printf("found page %#x len %d\n",
6932 lun->mode_pages.index[i].page_code &
6934 lun->mode_pages.index[i].page_len);
6936 page_len += lun->mode_pages.index[i].page_len;
6945 for (i = 0; i < CTL_NUM_MODE_PAGES; i++) {
6946 /* Look for the right page code */
6947 if ((lun->mode_pages.index[i].page_code &
6948 SMPH_PC_MASK) != page_code)
6951 /* Look for the right subpage or the subpage wildcard*/
6952 if ((lun->mode_pages.index[i].subpage != subpage)
6953 && (subpage != SMS_SUBPAGE_ALL))
6956 /* Make sure the page is supported for this dev type */
6957 if ((control_dev != 0)
6958 && (lun->mode_pages.index[i].page_flags &
6959 CTL_PAGE_FLAG_DISK_ONLY))
6963 printf("found page %#x len %d\n",
6964 lun->mode_pages.index[i].page_code &
6966 lun->mode_pages.index[i].page_len);
6969 page_len += lun->mode_pages.index[i].page_len;
6972 if (page_len == 0) {
6973 ctl_set_invalid_field(ctsio,
6979 ctl_done((union ctl_io *)ctsio);
6980 return (CTL_RETVAL_COMPLETE);
6986 total_len = header_len + page_len;
6988 printf("header_len = %d, page_len = %d, total_len = %d\n",
6989 header_len, page_len, total_len);
6992 ctsio->kern_data_ptr = malloc(total_len, M_CTL, M_WAITOK | M_ZERO);
6993 ctsio->kern_sg_entries = 0;
6994 ctsio->kern_data_resid = 0;
6995 ctsio->kern_rel_offset = 0;
6996 if (total_len < alloc_len) {
6997 ctsio->residual = alloc_len - total_len;
6998 ctsio->kern_data_len = total_len;
6999 ctsio->kern_total_len = total_len;
7001 ctsio->residual = 0;
7002 ctsio->kern_data_len = alloc_len;
7003 ctsio->kern_total_len = alloc_len;
7006 switch (ctsio->cdb[0]) {
7007 case MODE_SENSE_6: {
7008 struct scsi_mode_hdr_6 *header;
7010 header = (struct scsi_mode_hdr_6 *)ctsio->kern_data_ptr;
7012 header->datalen = ctl_min(total_len - 1, 254);
7015 header->block_descr_len = 0;
7017 header->block_descr_len =
7018 sizeof(struct scsi_mode_block_descr);
7019 block_desc = (struct scsi_mode_block_descr *)&header[1];
7022 case MODE_SENSE_10: {
7023 struct scsi_mode_hdr_10 *header;
7026 header = (struct scsi_mode_hdr_10 *)ctsio->kern_data_ptr;
7028 datalen = ctl_min(total_len - 2, 65533);
7029 scsi_ulto2b(datalen, header->datalen);
7031 scsi_ulto2b(0, header->block_descr_len);
7033 scsi_ulto2b(sizeof(struct scsi_mode_block_descr),
7034 header->block_descr_len);
7035 block_desc = (struct scsi_mode_block_descr *)&header[1];
7039 panic("invalid CDB type %#x", ctsio->cdb[0]);
7040 break; /* NOTREACHED */
7044 * If we've got a disk, use its blocksize in the block
7045 * descriptor. Otherwise, just set it to 0.
7048 if (control_dev != 0)
7049 scsi_ulto3b(lun->be_lun->blocksize,
7050 block_desc->block_len);
7052 scsi_ulto3b(0, block_desc->block_len);
7055 switch (page_code) {
7056 case SMS_ALL_PAGES_PAGE: {
7059 data_used = header_len;
7060 for (i = 0; i < CTL_NUM_MODE_PAGES; i++) {
7061 struct ctl_page_index *page_index;
7063 page_index = &lun->mode_pages.index[i];
7065 if ((control_dev != 0)
7066 && (page_index->page_flags &
7067 CTL_PAGE_FLAG_DISK_ONLY))
7071 * We don't use this subpage if the user didn't
7072 * request all subpages. We already checked (above)
7073 * to make sure the user only specified a subpage
7074 * of 0 or 0xff in the SMS_ALL_PAGES_PAGE case.
7076 if ((page_index->subpage != 0)
7077 && (subpage == SMS_SUBPAGE_PAGE_0))
7081 * Call the handler, if it exists, to update the
7082 * page to the latest values.
7084 if (page_index->sense_handler != NULL)
7085 page_index->sense_handler(ctsio, page_index,pc);
7087 memcpy(ctsio->kern_data_ptr + data_used,
7088 page_index->page_data +
7089 (page_index->page_len * pc),
7090 page_index->page_len);
7091 data_used += page_index->page_len;
7098 data_used = header_len;
7100 for (i = 0; i < CTL_NUM_MODE_PAGES; i++) {
7101 struct ctl_page_index *page_index;
7103 page_index = &lun->mode_pages.index[i];
7105 /* Look for the right page code */
7106 if ((page_index->page_code & SMPH_PC_MASK) != page_code)
7109 /* Look for the right subpage or the subpage wildcard*/
7110 if ((page_index->subpage != subpage)
7111 && (subpage != SMS_SUBPAGE_ALL))
7114 /* Make sure the page is supported for this dev type */
7115 if ((control_dev != 0)
7116 && (page_index->page_flags &
7117 CTL_PAGE_FLAG_DISK_ONLY))
7121 * Call the handler, if it exists, to update the
7122 * page to the latest values.
7124 if (page_index->sense_handler != NULL)
7125 page_index->sense_handler(ctsio, page_index,pc);
7127 memcpy(ctsio->kern_data_ptr + data_used,
7128 page_index->page_data +
7129 (page_index->page_len * pc),
7130 page_index->page_len);
7131 data_used += page_index->page_len;
7137 ctsio->scsi_status = SCSI_STATUS_OK;
7139 ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
7140 ctsio->be_move_done = ctl_config_move_done;
7141 ctl_datamove((union ctl_io *)ctsio);
7143 return (CTL_RETVAL_COMPLETE);
7147 ctl_read_capacity(struct ctl_scsiio *ctsio)
7149 struct scsi_read_capacity *cdb;
7150 struct scsi_read_capacity_data *data;
7151 struct ctl_lun *lun;
7154 CTL_DEBUG_PRINT(("ctl_read_capacity\n"));
7156 cdb = (struct scsi_read_capacity *)ctsio->cdb;
7158 lba = scsi_4btoul(cdb->addr);
7159 if (((cdb->pmi & SRC_PMI) == 0)
7161 ctl_set_invalid_field(/*ctsio*/ ctsio,
7167 ctl_done((union ctl_io *)ctsio);
7168 return (CTL_RETVAL_COMPLETE);
7171 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
7173 ctsio->kern_data_ptr = malloc(sizeof(*data), M_CTL, M_WAITOK | M_ZERO);
7174 data = (struct scsi_read_capacity_data *)ctsio->kern_data_ptr;
7175 ctsio->residual = 0;
7176 ctsio->kern_data_len = sizeof(*data);
7177 ctsio->kern_total_len = sizeof(*data);
7178 ctsio->kern_data_resid = 0;
7179 ctsio->kern_rel_offset = 0;
7180 ctsio->kern_sg_entries = 0;
7183 * If the maximum LBA is greater than 0xfffffffe, the user must
7184 * issue a SERVICE ACTION IN (16) command, with the read capacity
7185 * serivce action set.
7187 if (lun->be_lun->maxlba > 0xfffffffe)
7188 scsi_ulto4b(0xffffffff, data->addr);
7190 scsi_ulto4b(lun->be_lun->maxlba, data->addr);
7193 * XXX KDM this may not be 512 bytes...
7195 scsi_ulto4b(lun->be_lun->blocksize, data->length);
7197 ctsio->scsi_status = SCSI_STATUS_OK;
7199 ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
7200 ctsio->be_move_done = ctl_config_move_done;
7201 ctl_datamove((union ctl_io *)ctsio);
7203 return (CTL_RETVAL_COMPLETE);
7207 ctl_read_capacity_16(struct ctl_scsiio *ctsio)
7209 struct scsi_read_capacity_16 *cdb;
7210 struct scsi_read_capacity_data_long *data;
7211 struct ctl_lun *lun;
7215 CTL_DEBUG_PRINT(("ctl_read_capacity_16\n"));
7217 cdb = (struct scsi_read_capacity_16 *)ctsio->cdb;
7219 alloc_len = scsi_4btoul(cdb->alloc_len);
7220 lba = scsi_8btou64(cdb->addr);
7222 if ((cdb->reladr & SRC16_PMI)
7224 ctl_set_invalid_field(/*ctsio*/ ctsio,
7230 ctl_done((union ctl_io *)ctsio);
7231 return (CTL_RETVAL_COMPLETE);
7234 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
7236 ctsio->kern_data_ptr = malloc(sizeof(*data), M_CTL, M_WAITOK | M_ZERO);
7237 data = (struct scsi_read_capacity_data_long *)ctsio->kern_data_ptr;
7239 if (sizeof(*data) < alloc_len) {
7240 ctsio->residual = alloc_len - sizeof(*data);
7241 ctsio->kern_data_len = sizeof(*data);
7242 ctsio->kern_total_len = sizeof(*data);
7244 ctsio->residual = 0;
7245 ctsio->kern_data_len = alloc_len;
7246 ctsio->kern_total_len = alloc_len;
7248 ctsio->kern_data_resid = 0;
7249 ctsio->kern_rel_offset = 0;
7250 ctsio->kern_sg_entries = 0;
7252 scsi_u64to8b(lun->be_lun->maxlba, data->addr);
7253 /* XXX KDM this may not be 512 bytes... */
7254 scsi_ulto4b(lun->be_lun->blocksize, data->length);
7255 data->prot_lbppbe = lun->be_lun->pblockexp & SRC16_LBPPBE;
7256 scsi_ulto2b(lun->be_lun->pblockoff & SRC16_LALBA_A, data->lalba_lbp);
7257 if (lun->be_lun->flags & CTL_LUN_FLAG_UNMAP)
7258 data->lalba_lbp[0] |= SRC16_LBPME | SRC16_LBPRZ;
7260 ctsio->scsi_status = SCSI_STATUS_OK;
7262 ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
7263 ctsio->be_move_done = ctl_config_move_done;
7264 ctl_datamove((union ctl_io *)ctsio);
7266 return (CTL_RETVAL_COMPLETE);
7270 ctl_report_tagret_port_groups(struct ctl_scsiio *ctsio)
7272 struct scsi_maintenance_in *cdb;
7274 int alloc_len, ext, total_len = 0, g, p, pc, pg;
7275 int num_target_port_groups, num_target_ports, single;
7276 struct ctl_lun *lun;
7277 struct ctl_softc *softc;
7278 struct ctl_port *port;
7279 struct scsi_target_group_data *rtg_ptr;
7280 struct scsi_target_group_data_extended *rtg_ext_ptr;
7281 struct scsi_target_port_group_descriptor *tpg_desc;
7283 CTL_DEBUG_PRINT(("ctl_report_tagret_port_groups\n"));
7285 cdb = (struct scsi_maintenance_in *)ctsio->cdb;
7286 softc = control_softc;
7287 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
7289 retval = CTL_RETVAL_COMPLETE;
7291 switch (cdb->byte2 & STG_PDF_MASK) {
7292 case STG_PDF_LENGTH:
7295 case STG_PDF_EXTENDED:
7299 ctl_set_invalid_field(/*ctsio*/ ctsio,
7305 ctl_done((union ctl_io *)ctsio);
7309 single = ctl_is_single;
7311 num_target_port_groups = 1;
7313 num_target_port_groups = NUM_TARGET_PORT_GROUPS;
7314 num_target_ports = 0;
7315 mtx_lock(&softc->ctl_lock);
7316 STAILQ_FOREACH(port, &softc->port_list, links) {
7317 if ((port->status & CTL_PORT_STATUS_ONLINE) == 0)
7319 if (ctl_map_lun_back(port->targ_port, lun->lun) >= CTL_MAX_LUNS)
7323 mtx_unlock(&softc->ctl_lock);
7326 total_len = sizeof(struct scsi_target_group_data_extended);
7328 total_len = sizeof(struct scsi_target_group_data);
7329 total_len += sizeof(struct scsi_target_port_group_descriptor) *
7330 num_target_port_groups +
7331 sizeof(struct scsi_target_port_descriptor) *
7332 num_target_ports * num_target_port_groups;
7334 alloc_len = scsi_4btoul(cdb->length);
7336 ctsio->kern_data_ptr = malloc(total_len, M_CTL, M_WAITOK | M_ZERO);
7338 ctsio->kern_sg_entries = 0;
7340 if (total_len < alloc_len) {
7341 ctsio->residual = alloc_len - total_len;
7342 ctsio->kern_data_len = total_len;
7343 ctsio->kern_total_len = total_len;
7345 ctsio->residual = 0;
7346 ctsio->kern_data_len = alloc_len;
7347 ctsio->kern_total_len = alloc_len;
7349 ctsio->kern_data_resid = 0;
7350 ctsio->kern_rel_offset = 0;
7353 rtg_ext_ptr = (struct scsi_target_group_data_extended *)
7354 ctsio->kern_data_ptr;
7355 scsi_ulto4b(total_len - 4, rtg_ext_ptr->length);
7356 rtg_ext_ptr->format_type = 0x10;
7357 rtg_ext_ptr->implicit_transition_time = 0;
7358 tpg_desc = &rtg_ext_ptr->groups[0];
7360 rtg_ptr = (struct scsi_target_group_data *)
7361 ctsio->kern_data_ptr;
7362 scsi_ulto4b(total_len - 4, rtg_ptr->length);
7363 tpg_desc = &rtg_ptr->groups[0];
7366 pg = ctsio->io_hdr.nexus.targ_port / CTL_MAX_PORTS;
7367 mtx_lock(&softc->ctl_lock);
7368 for (g = 0; g < num_target_port_groups; g++) {
7370 tpg_desc->pref_state = TPG_PRIMARY |
7371 TPG_ASYMMETRIC_ACCESS_OPTIMIZED;
7373 tpg_desc->pref_state =
7374 TPG_ASYMMETRIC_ACCESS_NONOPTIMIZED;
7375 tpg_desc->support = TPG_AO_SUP;
7377 tpg_desc->support |= TPG_AN_SUP;
7378 scsi_ulto2b(g + 1, tpg_desc->target_port_group);
7379 tpg_desc->status = TPG_IMPLICIT;
7381 STAILQ_FOREACH(port, &softc->port_list, links) {
7382 if ((port->status & CTL_PORT_STATUS_ONLINE) == 0)
7384 if (ctl_map_lun_back(port->targ_port, lun->lun) >=
7387 p = port->targ_port % CTL_MAX_PORTS + g * CTL_MAX_PORTS;
7388 scsi_ulto2b(p, tpg_desc->descriptors[pc].
7389 relative_target_port_identifier);
7392 tpg_desc->target_port_count = pc;
7393 tpg_desc = (struct scsi_target_port_group_descriptor *)
7394 &tpg_desc->descriptors[pc];
7396 mtx_unlock(&softc->ctl_lock);
7398 ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
7399 ctsio->be_move_done = ctl_config_move_done;
7401 CTL_DEBUG_PRINT(("buf = %x %x %x %x %x %x %x %x\n",
7402 ctsio->kern_data_ptr[0], ctsio->kern_data_ptr[1],
7403 ctsio->kern_data_ptr[2], ctsio->kern_data_ptr[3],
7404 ctsio->kern_data_ptr[4], ctsio->kern_data_ptr[5],
7405 ctsio->kern_data_ptr[6], ctsio->kern_data_ptr[7]));
7407 ctl_datamove((union ctl_io *)ctsio);
7412 ctl_report_supported_opcodes(struct ctl_scsiio *ctsio)
7414 struct ctl_lun *lun;
7415 struct scsi_report_supported_opcodes *cdb;
7416 const struct ctl_cmd_entry *entry, *sentry;
7417 struct scsi_report_supported_opcodes_all *all;
7418 struct scsi_report_supported_opcodes_descr *descr;
7419 struct scsi_report_supported_opcodes_one *one;
7421 int alloc_len, total_len;
7422 int opcode, service_action, i, j, num;
7424 CTL_DEBUG_PRINT(("ctl_report_supported_opcodes\n"));
7426 cdb = (struct scsi_report_supported_opcodes *)ctsio->cdb;
7427 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
7429 retval = CTL_RETVAL_COMPLETE;
7431 opcode = cdb->requested_opcode;
7432 service_action = scsi_2btoul(cdb->requested_service_action);
7433 switch (cdb->options & RSO_OPTIONS_MASK) {
7434 case RSO_OPTIONS_ALL:
7436 for (i = 0; i < 256; i++) {
7437 entry = &ctl_cmd_table[i];
7438 if (entry->flags & CTL_CMD_FLAG_SA5) {
7439 for (j = 0; j < 32; j++) {
7440 sentry = &((const struct ctl_cmd_entry *)
7442 if (ctl_cmd_applicable(
7443 lun->be_lun->lun_type, sentry))
7447 if (ctl_cmd_applicable(lun->be_lun->lun_type,
7452 total_len = sizeof(struct scsi_report_supported_opcodes_all) +
7453 num * sizeof(struct scsi_report_supported_opcodes_descr);
7455 case RSO_OPTIONS_OC:
7456 if (ctl_cmd_table[opcode].flags & CTL_CMD_FLAG_SA5) {
7457 ctl_set_invalid_field(/*ctsio*/ ctsio,
7463 ctl_done((union ctl_io *)ctsio);
7464 return (CTL_RETVAL_COMPLETE);
7466 total_len = sizeof(struct scsi_report_supported_opcodes_one) + 32;
7468 case RSO_OPTIONS_OC_SA:
7469 if ((ctl_cmd_table[opcode].flags & CTL_CMD_FLAG_SA5) == 0 ||
7470 service_action >= 32) {
7471 ctl_set_invalid_field(/*ctsio*/ ctsio,
7477 ctl_done((union ctl_io *)ctsio);
7478 return (CTL_RETVAL_COMPLETE);
7480 total_len = sizeof(struct scsi_report_supported_opcodes_one) + 32;
7483 ctl_set_invalid_field(/*ctsio*/ ctsio,
7489 ctl_done((union ctl_io *)ctsio);
7490 return (CTL_RETVAL_COMPLETE);
7493 alloc_len = scsi_4btoul(cdb->length);
7495 ctsio->kern_data_ptr = malloc(total_len, M_CTL, M_WAITOK | M_ZERO);
7497 ctsio->kern_sg_entries = 0;
7499 if (total_len < alloc_len) {
7500 ctsio->residual = alloc_len - total_len;
7501 ctsio->kern_data_len = total_len;
7502 ctsio->kern_total_len = total_len;
7504 ctsio->residual = 0;
7505 ctsio->kern_data_len = alloc_len;
7506 ctsio->kern_total_len = alloc_len;
7508 ctsio->kern_data_resid = 0;
7509 ctsio->kern_rel_offset = 0;
7511 switch (cdb->options & RSO_OPTIONS_MASK) {
7512 case RSO_OPTIONS_ALL:
7513 all = (struct scsi_report_supported_opcodes_all *)
7514 ctsio->kern_data_ptr;
7516 for (i = 0; i < 256; i++) {
7517 entry = &ctl_cmd_table[i];
7518 if (entry->flags & CTL_CMD_FLAG_SA5) {
7519 for (j = 0; j < 32; j++) {
7520 sentry = &((const struct ctl_cmd_entry *)
7522 if (!ctl_cmd_applicable(
7523 lun->be_lun->lun_type, sentry))
7525 descr = &all->descr[num++];
7527 scsi_ulto2b(j, descr->service_action);
7528 descr->flags = RSO_SERVACTV;
7529 scsi_ulto2b(sentry->length,
7533 if (!ctl_cmd_applicable(lun->be_lun->lun_type,
7536 descr = &all->descr[num++];
7538 scsi_ulto2b(0, descr->service_action);
7540 scsi_ulto2b(entry->length, descr->cdb_length);
7544 num * sizeof(struct scsi_report_supported_opcodes_descr),
7547 case RSO_OPTIONS_OC:
7548 one = (struct scsi_report_supported_opcodes_one *)
7549 ctsio->kern_data_ptr;
7550 entry = &ctl_cmd_table[opcode];
7552 case RSO_OPTIONS_OC_SA:
7553 one = (struct scsi_report_supported_opcodes_one *)
7554 ctsio->kern_data_ptr;
7555 entry = &ctl_cmd_table[opcode];
7556 entry = &((const struct ctl_cmd_entry *)
7557 entry->execute)[service_action];
7559 if (ctl_cmd_applicable(lun->be_lun->lun_type, entry)) {
7561 scsi_ulto2b(entry->length, one->cdb_length);
7562 one->cdb_usage[0] = opcode;
7563 memcpy(&one->cdb_usage[1], entry->usage,
7570 ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
7571 ctsio->be_move_done = ctl_config_move_done;
7573 ctl_datamove((union ctl_io *)ctsio);
7578 ctl_report_supported_tmf(struct ctl_scsiio *ctsio)
7580 struct ctl_lun *lun;
7581 struct scsi_report_supported_tmf *cdb;
7582 struct scsi_report_supported_tmf_data *data;
7584 int alloc_len, total_len;
7586 CTL_DEBUG_PRINT(("ctl_report_supported_tmf\n"));
7588 cdb = (struct scsi_report_supported_tmf *)ctsio->cdb;
7589 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
7591 retval = CTL_RETVAL_COMPLETE;
7593 total_len = sizeof(struct scsi_report_supported_tmf_data);
7594 alloc_len = scsi_4btoul(cdb->length);
7596 ctsio->kern_data_ptr = malloc(total_len, M_CTL, M_WAITOK | M_ZERO);
7598 ctsio->kern_sg_entries = 0;
7600 if (total_len < alloc_len) {
7601 ctsio->residual = alloc_len - total_len;
7602 ctsio->kern_data_len = total_len;
7603 ctsio->kern_total_len = total_len;
7605 ctsio->residual = 0;
7606 ctsio->kern_data_len = alloc_len;
7607 ctsio->kern_total_len = alloc_len;
7609 ctsio->kern_data_resid = 0;
7610 ctsio->kern_rel_offset = 0;
7612 data = (struct scsi_report_supported_tmf_data *)ctsio->kern_data_ptr;
7613 data->byte1 |= RST_ATS | RST_ATSS | RST_CTSS | RST_LURS | RST_TRS;
7614 data->byte2 |= RST_ITNRS;
7616 ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
7617 ctsio->be_move_done = ctl_config_move_done;
7619 ctl_datamove((union ctl_io *)ctsio);
7624 ctl_report_timestamp(struct ctl_scsiio *ctsio)
7626 struct ctl_lun *lun;
7627 struct scsi_report_timestamp *cdb;
7628 struct scsi_report_timestamp_data *data;
7632 int alloc_len, total_len;
7634 CTL_DEBUG_PRINT(("ctl_report_timestamp\n"));
7636 cdb = (struct scsi_report_timestamp *)ctsio->cdb;
7637 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
7639 retval = CTL_RETVAL_COMPLETE;
7641 total_len = sizeof(struct scsi_report_timestamp_data);
7642 alloc_len = scsi_4btoul(cdb->length);
7644 ctsio->kern_data_ptr = malloc(total_len, M_CTL, M_WAITOK | M_ZERO);
7646 ctsio->kern_sg_entries = 0;
7648 if (total_len < alloc_len) {
7649 ctsio->residual = alloc_len - total_len;
7650 ctsio->kern_data_len = total_len;
7651 ctsio->kern_total_len = total_len;
7653 ctsio->residual = 0;
7654 ctsio->kern_data_len = alloc_len;
7655 ctsio->kern_total_len = alloc_len;
7657 ctsio->kern_data_resid = 0;
7658 ctsio->kern_rel_offset = 0;
7660 data = (struct scsi_report_timestamp_data *)ctsio->kern_data_ptr;
7661 scsi_ulto2b(sizeof(*data) - 2, data->length);
7662 data->origin = RTS_ORIG_OUTSIDE;
7664 timestamp = (int64_t)tv.tv_sec * 1000 + tv.tv_usec / 1000;
7665 scsi_ulto4b(timestamp >> 16, data->timestamp);
7666 scsi_ulto2b(timestamp & 0xffff, &data->timestamp[4]);
7668 ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
7669 ctsio->be_move_done = ctl_config_move_done;
7671 ctl_datamove((union ctl_io *)ctsio);
7676 ctl_persistent_reserve_in(struct ctl_scsiio *ctsio)
7678 struct scsi_per_res_in *cdb;
7679 int alloc_len, total_len = 0;
7680 /* struct scsi_per_res_in_rsrv in_data; */
7681 struct ctl_lun *lun;
7682 struct ctl_softc *softc;
7684 CTL_DEBUG_PRINT(("ctl_persistent_reserve_in\n"));
7686 softc = control_softc;
7688 cdb = (struct scsi_per_res_in *)ctsio->cdb;
7690 alloc_len = scsi_2btoul(cdb->length);
7692 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
7695 mtx_lock(&lun->lun_lock);
7696 switch (cdb->action) {
7697 case SPRI_RK: /* read keys */
7698 total_len = sizeof(struct scsi_per_res_in_keys) +
7700 sizeof(struct scsi_per_res_key);
7702 case SPRI_RR: /* read reservation */
7703 if (lun->flags & CTL_LUN_PR_RESERVED)
7704 total_len = sizeof(struct scsi_per_res_in_rsrv);
7706 total_len = sizeof(struct scsi_per_res_in_header);
7708 case SPRI_RC: /* report capabilities */
7709 total_len = sizeof(struct scsi_per_res_cap);
7711 case SPRI_RS: /* read full status */
7712 total_len = sizeof(struct scsi_per_res_in_header) +
7713 (sizeof(struct scsi_per_res_in_full_desc) + 256) *
7717 panic("Invalid PR type %x", cdb->action);
7719 mtx_unlock(&lun->lun_lock);
7721 ctsio->kern_data_ptr = malloc(total_len, M_CTL, M_WAITOK | M_ZERO);
7723 if (total_len < alloc_len) {
7724 ctsio->residual = alloc_len - total_len;
7725 ctsio->kern_data_len = total_len;
7726 ctsio->kern_total_len = total_len;
7728 ctsio->residual = 0;
7729 ctsio->kern_data_len = alloc_len;
7730 ctsio->kern_total_len = alloc_len;
7733 ctsio->kern_data_resid = 0;
7734 ctsio->kern_rel_offset = 0;
7735 ctsio->kern_sg_entries = 0;
7737 mtx_lock(&lun->lun_lock);
7738 switch (cdb->action) {
7739 case SPRI_RK: { // read keys
7740 struct scsi_per_res_in_keys *res_keys;
7743 res_keys = (struct scsi_per_res_in_keys*)ctsio->kern_data_ptr;
7746 * We had to drop the lock to allocate our buffer, which
7747 * leaves time for someone to come in with another
7748 * persistent reservation. (That is unlikely, though,
7749 * since this should be the only persistent reservation
7750 * command active right now.)
7752 if (total_len != (sizeof(struct scsi_per_res_in_keys) +
7753 (lun->pr_key_count *
7754 sizeof(struct scsi_per_res_key)))){
7755 mtx_unlock(&lun->lun_lock);
7756 free(ctsio->kern_data_ptr, M_CTL);
7757 printf("%s: reservation length changed, retrying\n",
7762 scsi_ulto4b(lun->PRGeneration, res_keys->header.generation);
7764 scsi_ulto4b(sizeof(struct scsi_per_res_key) *
7765 lun->pr_key_count, res_keys->header.length);
7767 for (i = 0, key_count = 0; i < 2*CTL_MAX_INITIATORS; i++) {
7768 if (!lun->per_res[i].registered)
7772 * We used lun->pr_key_count to calculate the
7773 * size to allocate. If it turns out the number of
7774 * initiators with the registered flag set is
7775 * larger than that (i.e. they haven't been kept in
7776 * sync), we've got a problem.
7778 if (key_count >= lun->pr_key_count) {
7780 csevent_log(CSC_CTL | CSC_SHELF_SW |
7782 csevent_LogType_Fault,
7783 csevent_AlertLevel_Yellow,
7784 csevent_FRU_ShelfController,
7785 csevent_FRU_Firmware,
7786 csevent_FRU_Unknown,
7787 "registered keys %d >= key "
7788 "count %d", key_count,
7794 memcpy(res_keys->keys[key_count].key,
7795 lun->per_res[i].res_key.key,
7796 ctl_min(sizeof(res_keys->keys[key_count].key),
7797 sizeof(lun->per_res[i].res_key)));
7802 case SPRI_RR: { // read reservation
7803 struct scsi_per_res_in_rsrv *res;
7804 int tmp_len, header_only;
7806 res = (struct scsi_per_res_in_rsrv *)ctsio->kern_data_ptr;
7808 scsi_ulto4b(lun->PRGeneration, res->header.generation);
7810 if (lun->flags & CTL_LUN_PR_RESERVED)
7812 tmp_len = sizeof(struct scsi_per_res_in_rsrv);
7813 scsi_ulto4b(sizeof(struct scsi_per_res_in_rsrv_data),
7814 res->header.length);
7817 tmp_len = sizeof(struct scsi_per_res_in_header);
7818 scsi_ulto4b(0, res->header.length);
7823 * We had to drop the lock to allocate our buffer, which
7824 * leaves time for someone to come in with another
7825 * persistent reservation. (That is unlikely, though,
7826 * since this should be the only persistent reservation
7827 * command active right now.)
7829 if (tmp_len != total_len) {
7830 mtx_unlock(&lun->lun_lock);
7831 free(ctsio->kern_data_ptr, M_CTL);
7832 printf("%s: reservation status changed, retrying\n",
7838 * No reservation held, so we're done.
7840 if (header_only != 0)
7844 * If the registration is an All Registrants type, the key
7845 * is 0, since it doesn't really matter.
7847 if (lun->pr_res_idx != CTL_PR_ALL_REGISTRANTS) {
7848 memcpy(res->data.reservation,
7849 &lun->per_res[lun->pr_res_idx].res_key,
7850 sizeof(struct scsi_per_res_key));
7852 res->data.scopetype = lun->res_type;
7855 case SPRI_RC: //report capabilities
7857 struct scsi_per_res_cap *res_cap;
7860 res_cap = (struct scsi_per_res_cap *)ctsio->kern_data_ptr;
7861 scsi_ulto2b(sizeof(*res_cap), res_cap->length);
7862 res_cap->flags2 |= SPRI_TMV | SPRI_ALLOW_3;
7863 type_mask = SPRI_TM_WR_EX_AR |
7869 scsi_ulto2b(type_mask, res_cap->type_mask);
7872 case SPRI_RS: { // read full status
7873 struct scsi_per_res_in_full *res_status;
7874 struct scsi_per_res_in_full_desc *res_desc;
7875 struct ctl_port *port;
7878 res_status = (struct scsi_per_res_in_full*)ctsio->kern_data_ptr;
7881 * We had to drop the lock to allocate our buffer, which
7882 * leaves time for someone to come in with another
7883 * persistent reservation. (That is unlikely, though,
7884 * since this should be the only persistent reservation
7885 * command active right now.)
7887 if (total_len < (sizeof(struct scsi_per_res_in_header) +
7888 (sizeof(struct scsi_per_res_in_full_desc) + 256) *
7889 lun->pr_key_count)){
7890 mtx_unlock(&lun->lun_lock);
7891 free(ctsio->kern_data_ptr, M_CTL);
7892 printf("%s: reservation length changed, retrying\n",
7897 scsi_ulto4b(lun->PRGeneration, res_status->header.generation);
7899 res_desc = &res_status->desc[0];
7900 for (i = 0; i < 2*CTL_MAX_INITIATORS; i++) {
7901 if (!lun->per_res[i].registered)
7904 memcpy(&res_desc->res_key, &lun->per_res[i].res_key.key,
7905 sizeof(res_desc->res_key));
7906 if ((lun->flags & CTL_LUN_PR_RESERVED) &&
7907 (lun->pr_res_idx == i ||
7908 lun->pr_res_idx == CTL_PR_ALL_REGISTRANTS)) {
7909 res_desc->flags = SPRI_FULL_R_HOLDER;
7910 res_desc->scopetype = lun->res_type;
7912 scsi_ulto2b(i / CTL_MAX_INIT_PER_PORT,
7913 res_desc->rel_trgt_port_id);
7915 port = softc->ctl_ports[i / CTL_MAX_INIT_PER_PORT];
7917 len = ctl_create_iid(port,
7918 i % CTL_MAX_INIT_PER_PORT,
7919 res_desc->transport_id);
7920 scsi_ulto4b(len, res_desc->additional_length);
7921 res_desc = (struct scsi_per_res_in_full_desc *)
7922 &res_desc->transport_id[len];
7924 scsi_ulto4b((uint8_t *)res_desc - (uint8_t *)&res_status->desc[0],
7925 res_status->header.length);
7930 * This is a bug, because we just checked for this above,
7931 * and should have returned an error.
7933 panic("Invalid PR type %x", cdb->action);
7934 break; /* NOTREACHED */
7936 mtx_unlock(&lun->lun_lock);
7938 ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
7939 ctsio->be_move_done = ctl_config_move_done;
7941 CTL_DEBUG_PRINT(("buf = %x %x %x %x %x %x %x %x\n",
7942 ctsio->kern_data_ptr[0], ctsio->kern_data_ptr[1],
7943 ctsio->kern_data_ptr[2], ctsio->kern_data_ptr[3],
7944 ctsio->kern_data_ptr[4], ctsio->kern_data_ptr[5],
7945 ctsio->kern_data_ptr[6], ctsio->kern_data_ptr[7]));
7947 ctl_datamove((union ctl_io *)ctsio);
7949 return (CTL_RETVAL_COMPLETE);
7953 * Returns 0 if ctl_persistent_reserve_out() should continue, non-zero if
7957 ctl_pro_preempt(struct ctl_softc *softc, struct ctl_lun *lun, uint64_t res_key,
7958 uint64_t sa_res_key, uint8_t type, uint32_t residx,
7959 struct ctl_scsiio *ctsio, struct scsi_per_res_out *cdb,
7960 struct scsi_per_res_out_parms* param)
7962 union ctl_ha_msg persis_io;
7968 mtx_lock(&lun->lun_lock);
7969 if (sa_res_key == 0) {
7970 if (lun->pr_res_idx == CTL_PR_ALL_REGISTRANTS) {
7971 /* validate scope and type */
7972 if ((cdb->scope_type & SPR_SCOPE_MASK) !=
7974 mtx_unlock(&lun->lun_lock);
7975 ctl_set_invalid_field(/*ctsio*/ ctsio,
7981 ctl_done((union ctl_io *)ctsio);
7985 if (type>8 || type==2 || type==4 || type==0) {
7986 mtx_unlock(&lun->lun_lock);
7987 ctl_set_invalid_field(/*ctsio*/ ctsio,
7993 ctl_done((union ctl_io *)ctsio);
7997 /* temporarily unregister this nexus */
7998 lun->per_res[residx].registered = 0;
8001 * Unregister everybody else and build UA for
8004 for(i=0; i < 2*CTL_MAX_INITIATORS; i++) {
8005 if (lun->per_res[i].registered == 0)
8009 && i <CTL_MAX_INITIATORS)
8010 lun->pending_ua[i] |=
8012 else if (persis_offset
8013 && i >= persis_offset)
8014 lun->pending_ua[i-persis_offset] |=
8016 lun->per_res[i].registered = 0;
8017 memset(&lun->per_res[i].res_key, 0,
8018 sizeof(struct scsi_per_res_key));
8020 lun->per_res[residx].registered = 1;
8021 lun->pr_key_count = 1;
8022 lun->res_type = type;
8023 if (lun->res_type != SPR_TYPE_WR_EX_AR
8024 && lun->res_type != SPR_TYPE_EX_AC_AR)
8025 lun->pr_res_idx = residx;
8027 /* send msg to other side */
8028 persis_io.hdr.nexus = ctsio->io_hdr.nexus;
8029 persis_io.hdr.msg_type = CTL_MSG_PERS_ACTION;
8030 persis_io.pr.pr_info.action = CTL_PR_PREEMPT;
8031 persis_io.pr.pr_info.residx = lun->pr_res_idx;
8032 persis_io.pr.pr_info.res_type = type;
8033 memcpy(persis_io.pr.pr_info.sa_res_key,
8034 param->serv_act_res_key,
8035 sizeof(param->serv_act_res_key));
8036 if ((isc_retval=ctl_ha_msg_send(CTL_HA_CHAN_CTL,
8037 &persis_io, sizeof(persis_io), 0)) >
8038 CTL_HA_STATUS_SUCCESS) {
8039 printf("CTL:Persis Out error returned "
8040 "from ctl_ha_msg_send %d\n",
8044 /* not all registrants */
8045 mtx_unlock(&lun->lun_lock);
8046 free(ctsio->kern_data_ptr, M_CTL);
8047 ctl_set_invalid_field(ctsio,
8053 ctl_done((union ctl_io *)ctsio);
8056 } else if (lun->pr_res_idx == CTL_PR_ALL_REGISTRANTS
8057 || !(lun->flags & CTL_LUN_PR_RESERVED)) {
8060 if (res_key == sa_res_key) {
8063 * The spec implies this is not good but doesn't
8064 * say what to do. There are two choices either
8065 * generate a res conflict or check condition
8066 * with illegal field in parameter data. Since
8067 * that is what is done when the sa_res_key is
8068 * zero I'll take that approach since this has
8069 * to do with the sa_res_key.
8071 mtx_unlock(&lun->lun_lock);
8072 free(ctsio->kern_data_ptr, M_CTL);
8073 ctl_set_invalid_field(ctsio,
8079 ctl_done((union ctl_io *)ctsio);
8083 for (i=0; i < 2*CTL_MAX_INITIATORS; i++) {
8084 if (lun->per_res[i].registered
8085 && memcmp(param->serv_act_res_key,
8086 lun->per_res[i].res_key.key,
8087 sizeof(struct scsi_per_res_key)) != 0)
8091 lun->per_res[i].registered = 0;
8092 memset(&lun->per_res[i].res_key, 0,
8093 sizeof(struct scsi_per_res_key));
8094 lun->pr_key_count--;
8096 if (!persis_offset && i < CTL_MAX_INITIATORS)
8097 lun->pending_ua[i] |= CTL_UA_REG_PREEMPT;
8098 else if (persis_offset && i >= persis_offset)
8099 lun->pending_ua[i-persis_offset] |=
8103 mtx_unlock(&lun->lun_lock);
8104 free(ctsio->kern_data_ptr, M_CTL);
8105 ctl_set_reservation_conflict(ctsio);
8106 ctl_done((union ctl_io *)ctsio);
8107 return (CTL_RETVAL_COMPLETE);
8109 /* send msg to other side */
8110 persis_io.hdr.nexus = ctsio->io_hdr.nexus;
8111 persis_io.hdr.msg_type = CTL_MSG_PERS_ACTION;
8112 persis_io.pr.pr_info.action = CTL_PR_PREEMPT;
8113 persis_io.pr.pr_info.residx = lun->pr_res_idx;
8114 persis_io.pr.pr_info.res_type = type;
8115 memcpy(persis_io.pr.pr_info.sa_res_key,
8116 param->serv_act_res_key,
8117 sizeof(param->serv_act_res_key));
8118 if ((isc_retval=ctl_ha_msg_send(CTL_HA_CHAN_CTL,
8119 &persis_io, sizeof(persis_io), 0)) >
8120 CTL_HA_STATUS_SUCCESS) {
8121 printf("CTL:Persis Out error returned from "
8122 "ctl_ha_msg_send %d\n", isc_retval);
8125 /* Reserved but not all registrants */
8126 /* sa_res_key is res holder */
8127 if (memcmp(param->serv_act_res_key,
8128 lun->per_res[lun->pr_res_idx].res_key.key,
8129 sizeof(struct scsi_per_res_key)) == 0) {
8130 /* validate scope and type */
8131 if ((cdb->scope_type & SPR_SCOPE_MASK) !=
8133 mtx_unlock(&lun->lun_lock);
8134 ctl_set_invalid_field(/*ctsio*/ ctsio,
8140 ctl_done((union ctl_io *)ctsio);
8144 if (type>8 || type==2 || type==4 || type==0) {
8145 mtx_unlock(&lun->lun_lock);
8146 ctl_set_invalid_field(/*ctsio*/ ctsio,
8152 ctl_done((union ctl_io *)ctsio);
8158 * if sa_res_key != res_key remove all
8159 * registrants w/sa_res_key and generate UA
8160 * for these registrants(Registrations
8161 * Preempted) if it wasn't an exclusive
8162 * reservation generate UA(Reservations
8163 * Preempted) for all other registered nexuses
8164 * if the type has changed. Establish the new
8165 * reservation and holder. If res_key and
8166 * sa_res_key are the same do the above
8167 * except don't unregister the res holder.
8171 * Temporarily unregister so it won't get
8172 * removed or UA generated
8174 lun->per_res[residx].registered = 0;
8175 for(i=0; i < 2*CTL_MAX_INITIATORS; i++) {
8176 if (lun->per_res[i].registered == 0)
8179 if (memcmp(param->serv_act_res_key,
8180 lun->per_res[i].res_key.key,
8181 sizeof(struct scsi_per_res_key)) == 0) {
8182 lun->per_res[i].registered = 0;
8183 memset(&lun->per_res[i].res_key,
8185 sizeof(struct scsi_per_res_key));
8186 lun->pr_key_count--;
8189 && i < CTL_MAX_INITIATORS)
8190 lun->pending_ua[i] |=
8192 else if (persis_offset
8193 && i >= persis_offset)
8194 lun->pending_ua[i-persis_offset] |=
8196 } else if (type != lun->res_type
8197 && (lun->res_type == SPR_TYPE_WR_EX_RO
8198 || lun->res_type ==SPR_TYPE_EX_AC_RO)){
8200 && i < CTL_MAX_INITIATORS)
8201 lun->pending_ua[i] |=
8203 else if (persis_offset
8204 && i >= persis_offset)
8210 lun->per_res[residx].registered = 1;
8211 lun->res_type = type;
8212 if (lun->res_type != SPR_TYPE_WR_EX_AR
8213 && lun->res_type != SPR_TYPE_EX_AC_AR)
8214 lun->pr_res_idx = residx;
8216 lun->pr_res_idx = CTL_PR_ALL_REGISTRANTS;
8218 persis_io.hdr.nexus = ctsio->io_hdr.nexus;
8219 persis_io.hdr.msg_type = CTL_MSG_PERS_ACTION;
8220 persis_io.pr.pr_info.action = CTL_PR_PREEMPT;
8221 persis_io.pr.pr_info.residx = lun->pr_res_idx;
8222 persis_io.pr.pr_info.res_type = type;
8223 memcpy(persis_io.pr.pr_info.sa_res_key,
8224 param->serv_act_res_key,
8225 sizeof(param->serv_act_res_key));
8226 if ((isc_retval=ctl_ha_msg_send(CTL_HA_CHAN_CTL,
8227 &persis_io, sizeof(persis_io), 0)) >
8228 CTL_HA_STATUS_SUCCESS) {
8229 printf("CTL:Persis Out error returned "
8230 "from ctl_ha_msg_send %d\n",
8235 * sa_res_key is not the res holder just
8236 * remove registrants
8240 for (i=0; i < 2*CTL_MAX_INITIATORS; i++) {
8241 if (memcmp(param->serv_act_res_key,
8242 lun->per_res[i].res_key.key,
8243 sizeof(struct scsi_per_res_key)) != 0)
8247 lun->per_res[i].registered = 0;
8248 memset(&lun->per_res[i].res_key, 0,
8249 sizeof(struct scsi_per_res_key));
8250 lun->pr_key_count--;
8253 && i < CTL_MAX_INITIATORS)
8254 lun->pending_ua[i] |=
8256 else if (persis_offset
8257 && i >= persis_offset)
8258 lun->pending_ua[i-persis_offset] |=
8263 mtx_unlock(&lun->lun_lock);
8264 free(ctsio->kern_data_ptr, M_CTL);
8265 ctl_set_reservation_conflict(ctsio);
8266 ctl_done((union ctl_io *)ctsio);
8269 persis_io.hdr.nexus = ctsio->io_hdr.nexus;
8270 persis_io.hdr.msg_type = CTL_MSG_PERS_ACTION;
8271 persis_io.pr.pr_info.action = CTL_PR_PREEMPT;
8272 persis_io.pr.pr_info.residx = lun->pr_res_idx;
8273 persis_io.pr.pr_info.res_type = type;
8274 memcpy(persis_io.pr.pr_info.sa_res_key,
8275 param->serv_act_res_key,
8276 sizeof(param->serv_act_res_key));
8277 if ((isc_retval=ctl_ha_msg_send(CTL_HA_CHAN_CTL,
8278 &persis_io, sizeof(persis_io), 0)) >
8279 CTL_HA_STATUS_SUCCESS) {
8280 printf("CTL:Persis Out error returned "
8281 "from ctl_ha_msg_send %d\n",
8287 lun->PRGeneration++;
8288 mtx_unlock(&lun->lun_lock);
8294 ctl_pro_preempt_other(struct ctl_lun *lun, union ctl_ha_msg *msg)
8298 if (lun->pr_res_idx == CTL_PR_ALL_REGISTRANTS
8299 || lun->pr_res_idx == CTL_PR_NO_RESERVATION
8300 || memcmp(&lun->per_res[lun->pr_res_idx].res_key,
8301 msg->pr.pr_info.sa_res_key,
8302 sizeof(struct scsi_per_res_key)) != 0) {
8303 uint64_t sa_res_key;
8304 sa_res_key = scsi_8btou64(msg->pr.pr_info.sa_res_key);
8306 if (sa_res_key == 0) {
8307 /* temporarily unregister this nexus */
8308 lun->per_res[msg->pr.pr_info.residx].registered = 0;
8311 * Unregister everybody else and build UA for
8314 for(i=0; i < 2*CTL_MAX_INITIATORS; i++) {
8315 if (lun->per_res[i].registered == 0)
8319 && i < CTL_MAX_INITIATORS)
8320 lun->pending_ua[i] |=
8322 else if (persis_offset && i >= persis_offset)
8323 lun->pending_ua[i - persis_offset] |=
8325 lun->per_res[i].registered = 0;
8326 memset(&lun->per_res[i].res_key, 0,
8327 sizeof(struct scsi_per_res_key));
8330 lun->per_res[msg->pr.pr_info.residx].registered = 1;
8331 lun->pr_key_count = 1;
8332 lun->res_type = msg->pr.pr_info.res_type;
8333 if (lun->res_type != SPR_TYPE_WR_EX_AR
8334 && lun->res_type != SPR_TYPE_EX_AC_AR)
8335 lun->pr_res_idx = msg->pr.pr_info.residx;
8337 for (i=0; i < 2*CTL_MAX_INITIATORS; i++) {
8338 if (memcmp(msg->pr.pr_info.sa_res_key,
8339 lun->per_res[i].res_key.key,
8340 sizeof(struct scsi_per_res_key)) != 0)
8343 lun->per_res[i].registered = 0;
8344 memset(&lun->per_res[i].res_key, 0,
8345 sizeof(struct scsi_per_res_key));
8346 lun->pr_key_count--;
8349 && i < persis_offset)
8350 lun->pending_ua[i] |=
8352 else if (persis_offset
8353 && i >= persis_offset)
8354 lun->pending_ua[i - persis_offset] |=
8360 * Temporarily unregister so it won't get removed
8363 lun->per_res[msg->pr.pr_info.residx].registered = 0;
8364 for (i=0; i < 2*CTL_MAX_INITIATORS; i++) {
8365 if (lun->per_res[i].registered == 0)
8368 if (memcmp(msg->pr.pr_info.sa_res_key,
8369 lun->per_res[i].res_key.key,
8370 sizeof(struct scsi_per_res_key)) == 0) {
8371 lun->per_res[i].registered = 0;
8372 memset(&lun->per_res[i].res_key, 0,
8373 sizeof(struct scsi_per_res_key));
8374 lun->pr_key_count--;
8376 && i < CTL_MAX_INITIATORS)
8377 lun->pending_ua[i] |=
8379 else if (persis_offset
8380 && i >= persis_offset)
8381 lun->pending_ua[i - persis_offset] |=
8383 } else if (msg->pr.pr_info.res_type != lun->res_type
8384 && (lun->res_type == SPR_TYPE_WR_EX_RO
8385 || lun->res_type == SPR_TYPE_EX_AC_RO)) {
8387 && i < persis_offset)
8388 lun->pending_ua[i] |=
8390 else if (persis_offset
8391 && i >= persis_offset)
8392 lun->pending_ua[i - persis_offset] |=
8396 lun->per_res[msg->pr.pr_info.residx].registered = 1;
8397 lun->res_type = msg->pr.pr_info.res_type;
8398 if (lun->res_type != SPR_TYPE_WR_EX_AR
8399 && lun->res_type != SPR_TYPE_EX_AC_AR)
8400 lun->pr_res_idx = msg->pr.pr_info.residx;
8402 lun->pr_res_idx = CTL_PR_ALL_REGISTRANTS;
8404 lun->PRGeneration++;
8410 ctl_persistent_reserve_out(struct ctl_scsiio *ctsio)
8414 u_int32_t param_len;
8415 struct scsi_per_res_out *cdb;
8416 struct ctl_lun *lun;
8417 struct scsi_per_res_out_parms* param;
8418 struct ctl_softc *softc;
8420 uint64_t res_key, sa_res_key;
8422 union ctl_ha_msg persis_io;
8425 CTL_DEBUG_PRINT(("ctl_persistent_reserve_out\n"));
8427 retval = CTL_RETVAL_COMPLETE;
8429 softc = control_softc;
8431 cdb = (struct scsi_per_res_out *)ctsio->cdb;
8432 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
8435 * We only support whole-LUN scope. The scope & type are ignored for
8436 * register, register and ignore existing key and clear.
8437 * We sometimes ignore scope and type on preempts too!!
8438 * Verify reservation type here as well.
8440 type = cdb->scope_type & SPR_TYPE_MASK;
8441 if ((cdb->action == SPRO_RESERVE)
8442 || (cdb->action == SPRO_RELEASE)) {
8443 if ((cdb->scope_type & SPR_SCOPE_MASK) != SPR_LU_SCOPE) {
8444 ctl_set_invalid_field(/*ctsio*/ ctsio,
8450 ctl_done((union ctl_io *)ctsio);
8451 return (CTL_RETVAL_COMPLETE);
8454 if (type>8 || type==2 || type==4 || type==0) {
8455 ctl_set_invalid_field(/*ctsio*/ ctsio,
8461 ctl_done((union ctl_io *)ctsio);
8462 return (CTL_RETVAL_COMPLETE);
8466 param_len = scsi_4btoul(cdb->length);
8468 if ((ctsio->io_hdr.flags & CTL_FLAG_ALLOCATED) == 0) {
8469 ctsio->kern_data_ptr = malloc(param_len, M_CTL, M_WAITOK);
8470 ctsio->kern_data_len = param_len;
8471 ctsio->kern_total_len = param_len;
8472 ctsio->kern_data_resid = 0;
8473 ctsio->kern_rel_offset = 0;
8474 ctsio->kern_sg_entries = 0;
8475 ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
8476 ctsio->be_move_done = ctl_config_move_done;
8477 ctl_datamove((union ctl_io *)ctsio);
8479 return (CTL_RETVAL_COMPLETE);
8482 param = (struct scsi_per_res_out_parms *)ctsio->kern_data_ptr;
8484 residx = ctl_get_resindex(&ctsio->io_hdr.nexus);
8485 res_key = scsi_8btou64(param->res_key.key);
8486 sa_res_key = scsi_8btou64(param->serv_act_res_key);
8489 * Validate the reservation key here except for SPRO_REG_IGNO
8490 * This must be done for all other service actions
8492 if ((cdb->action & SPRO_ACTION_MASK) != SPRO_REG_IGNO) {
8493 mtx_lock(&lun->lun_lock);
8494 if (lun->per_res[residx].registered) {
8495 if (memcmp(param->res_key.key,
8496 lun->per_res[residx].res_key.key,
8497 ctl_min(sizeof(param->res_key),
8498 sizeof(lun->per_res[residx].res_key))) != 0) {
8500 * The current key passed in doesn't match
8501 * the one the initiator previously
8504 mtx_unlock(&lun->lun_lock);
8505 free(ctsio->kern_data_ptr, M_CTL);
8506 ctl_set_reservation_conflict(ctsio);
8507 ctl_done((union ctl_io *)ctsio);
8508 return (CTL_RETVAL_COMPLETE);
8510 } else if ((cdb->action & SPRO_ACTION_MASK) != SPRO_REGISTER) {
8512 * We are not registered
8514 mtx_unlock(&lun->lun_lock);
8515 free(ctsio->kern_data_ptr, M_CTL);
8516 ctl_set_reservation_conflict(ctsio);
8517 ctl_done((union ctl_io *)ctsio);
8518 return (CTL_RETVAL_COMPLETE);
8519 } else if (res_key != 0) {
8521 * We are not registered and trying to register but
8522 * the register key isn't zero.
8524 mtx_unlock(&lun->lun_lock);
8525 free(ctsio->kern_data_ptr, M_CTL);
8526 ctl_set_reservation_conflict(ctsio);
8527 ctl_done((union ctl_io *)ctsio);
8528 return (CTL_RETVAL_COMPLETE);
8530 mtx_unlock(&lun->lun_lock);
8533 switch (cdb->action & SPRO_ACTION_MASK) {
8535 case SPRO_REG_IGNO: {
8538 printf("Registration received\n");
8542 * We don't support any of these options, as we report in
8543 * the read capabilities request (see
8544 * ctl_persistent_reserve_in(), above).
8546 if ((param->flags & SPR_SPEC_I_PT)
8547 || (param->flags & SPR_ALL_TG_PT)
8548 || (param->flags & SPR_APTPL)) {
8551 if (param->flags & SPR_APTPL)
8553 else if (param->flags & SPR_ALL_TG_PT)
8555 else /* SPR_SPEC_I_PT */
8558 free(ctsio->kern_data_ptr, M_CTL);
8559 ctl_set_invalid_field(ctsio,
8565 ctl_done((union ctl_io *)ctsio);
8566 return (CTL_RETVAL_COMPLETE);
8569 mtx_lock(&lun->lun_lock);
8572 * The initiator wants to clear the
8575 if (sa_res_key == 0) {
8577 && (cdb->action & SPRO_ACTION_MASK) == SPRO_REGISTER)
8578 || ((cdb->action & SPRO_ACTION_MASK) == SPRO_REG_IGNO
8579 && !lun->per_res[residx].registered)) {
8580 mtx_unlock(&lun->lun_lock);
8584 lun->per_res[residx].registered = 0;
8585 memset(&lun->per_res[residx].res_key,
8586 0, sizeof(lun->per_res[residx].res_key));
8587 lun->pr_key_count--;
8589 if (residx == lun->pr_res_idx) {
8590 lun->flags &= ~CTL_LUN_PR_RESERVED;
8591 lun->pr_res_idx = CTL_PR_NO_RESERVATION;
8593 if ((lun->res_type == SPR_TYPE_WR_EX_RO
8594 || lun->res_type == SPR_TYPE_EX_AC_RO)
8595 && lun->pr_key_count) {
8597 * If the reservation is a registrants
8598 * only type we need to generate a UA
8599 * for other registered inits. The
8600 * sense code should be RESERVATIONS
8604 for (i = 0; i < CTL_MAX_INITIATORS;i++){
8606 i+persis_offset].registered
8609 lun->pending_ua[i] |=
8614 } else if (lun->pr_res_idx == CTL_PR_ALL_REGISTRANTS) {
8615 if (lun->pr_key_count==0) {
8616 lun->flags &= ~CTL_LUN_PR_RESERVED;
8618 lun->pr_res_idx = CTL_PR_NO_RESERVATION;
8621 persis_io.hdr.nexus = ctsio->io_hdr.nexus;
8622 persis_io.hdr.msg_type = CTL_MSG_PERS_ACTION;
8623 persis_io.pr.pr_info.action = CTL_PR_UNREG_KEY;
8624 persis_io.pr.pr_info.residx = residx;
8625 if ((isc_retval = ctl_ha_msg_send(CTL_HA_CHAN_CTL,
8626 &persis_io, sizeof(persis_io), 0 )) >
8627 CTL_HA_STATUS_SUCCESS) {
8628 printf("CTL:Persis Out error returned from "
8629 "ctl_ha_msg_send %d\n", isc_retval);
8631 } else /* sa_res_key != 0 */ {
8634 * If we aren't registered currently then increment
8635 * the key count and set the registered flag.
8637 if (!lun->per_res[residx].registered) {
8638 lun->pr_key_count++;
8639 lun->per_res[residx].registered = 1;
8642 memcpy(&lun->per_res[residx].res_key,
8643 param->serv_act_res_key,
8644 ctl_min(sizeof(param->serv_act_res_key),
8645 sizeof(lun->per_res[residx].res_key)));
8647 persis_io.hdr.nexus = ctsio->io_hdr.nexus;
8648 persis_io.hdr.msg_type = CTL_MSG_PERS_ACTION;
8649 persis_io.pr.pr_info.action = CTL_PR_REG_KEY;
8650 persis_io.pr.pr_info.residx = residx;
8651 memcpy(persis_io.pr.pr_info.sa_res_key,
8652 param->serv_act_res_key,
8653 sizeof(param->serv_act_res_key));
8654 if ((isc_retval=ctl_ha_msg_send(CTL_HA_CHAN_CTL,
8655 &persis_io, sizeof(persis_io), 0)) >
8656 CTL_HA_STATUS_SUCCESS) {
8657 printf("CTL:Persis Out error returned from "
8658 "ctl_ha_msg_send %d\n", isc_retval);
8661 lun->PRGeneration++;
8662 mtx_unlock(&lun->lun_lock);
8668 printf("Reserve executed type %d\n", type);
8670 mtx_lock(&lun->lun_lock);
8671 if (lun->flags & CTL_LUN_PR_RESERVED) {
8673 * if this isn't the reservation holder and it's
8674 * not a "all registrants" type or if the type is
8675 * different then we have a conflict
8677 if ((lun->pr_res_idx != residx
8678 && lun->pr_res_idx != CTL_PR_ALL_REGISTRANTS)
8679 || lun->res_type != type) {
8680 mtx_unlock(&lun->lun_lock);
8681 free(ctsio->kern_data_ptr, M_CTL);
8682 ctl_set_reservation_conflict(ctsio);
8683 ctl_done((union ctl_io *)ctsio);
8684 return (CTL_RETVAL_COMPLETE);
8686 mtx_unlock(&lun->lun_lock);
8687 } else /* create a reservation */ {
8689 * If it's not an "all registrants" type record
8690 * reservation holder
8692 if (type != SPR_TYPE_WR_EX_AR
8693 && type != SPR_TYPE_EX_AC_AR)
8694 lun->pr_res_idx = residx; /* Res holder */
8696 lun->pr_res_idx = CTL_PR_ALL_REGISTRANTS;
8698 lun->flags |= CTL_LUN_PR_RESERVED;
8699 lun->res_type = type;
8701 mtx_unlock(&lun->lun_lock);
8703 /* send msg to other side */
8704 persis_io.hdr.nexus = ctsio->io_hdr.nexus;
8705 persis_io.hdr.msg_type = CTL_MSG_PERS_ACTION;
8706 persis_io.pr.pr_info.action = CTL_PR_RESERVE;
8707 persis_io.pr.pr_info.residx = lun->pr_res_idx;
8708 persis_io.pr.pr_info.res_type = type;
8709 if ((isc_retval=ctl_ha_msg_send(CTL_HA_CHAN_CTL,
8710 &persis_io, sizeof(persis_io), 0)) >
8711 CTL_HA_STATUS_SUCCESS) {
8712 printf("CTL:Persis Out error returned from "
8713 "ctl_ha_msg_send %d\n", isc_retval);
8719 mtx_lock(&lun->lun_lock);
8720 if ((lun->flags & CTL_LUN_PR_RESERVED) == 0) {
8721 /* No reservation exists return good status */
8722 mtx_unlock(&lun->lun_lock);
8726 * Is this nexus a reservation holder?
8728 if (lun->pr_res_idx != residx
8729 && lun->pr_res_idx != CTL_PR_ALL_REGISTRANTS) {
8731 * not a res holder return good status but
8734 mtx_unlock(&lun->lun_lock);
8738 if (lun->res_type != type) {
8739 mtx_unlock(&lun->lun_lock);
8740 free(ctsio->kern_data_ptr, M_CTL);
8741 ctl_set_illegal_pr_release(ctsio);
8742 ctl_done((union ctl_io *)ctsio);
8743 return (CTL_RETVAL_COMPLETE);
8746 /* okay to release */
8747 lun->flags &= ~CTL_LUN_PR_RESERVED;
8748 lun->pr_res_idx = CTL_PR_NO_RESERVATION;
8752 * if this isn't an exclusive access
8753 * res generate UA for all other
8756 if (type != SPR_TYPE_EX_AC
8757 && type != SPR_TYPE_WR_EX) {
8759 * temporarily unregister so we don't generate UA
8761 lun->per_res[residx].registered = 0;
8763 for (i = 0; i < CTL_MAX_INITIATORS; i++) {
8764 if (lun->per_res[i+persis_offset].registered
8767 lun->pending_ua[i] |=
8771 lun->per_res[residx].registered = 1;
8773 mtx_unlock(&lun->lun_lock);
8774 /* Send msg to other side */
8775 persis_io.hdr.nexus = ctsio->io_hdr.nexus;
8776 persis_io.hdr.msg_type = CTL_MSG_PERS_ACTION;
8777 persis_io.pr.pr_info.action = CTL_PR_RELEASE;
8778 if ((isc_retval=ctl_ha_msg_send( CTL_HA_CHAN_CTL, &persis_io,
8779 sizeof(persis_io), 0)) > CTL_HA_STATUS_SUCCESS) {
8780 printf("CTL:Persis Out error returned from "
8781 "ctl_ha_msg_send %d\n", isc_retval);
8786 /* send msg to other side */
8788 mtx_lock(&lun->lun_lock);
8789 lun->flags &= ~CTL_LUN_PR_RESERVED;
8791 lun->pr_key_count = 0;
8792 lun->pr_res_idx = CTL_PR_NO_RESERVATION;
8795 memset(&lun->per_res[residx].res_key,
8796 0, sizeof(lun->per_res[residx].res_key));
8797 lun->per_res[residx].registered = 0;
8799 for (i=0; i < 2*CTL_MAX_INITIATORS; i++)
8800 if (lun->per_res[i].registered) {
8801 if (!persis_offset && i < CTL_MAX_INITIATORS)
8802 lun->pending_ua[i] |=
8804 else if (persis_offset && i >= persis_offset)
8805 lun->pending_ua[i-persis_offset] |=
8808 memset(&lun->per_res[i].res_key,
8809 0, sizeof(struct scsi_per_res_key));
8810 lun->per_res[i].registered = 0;
8812 lun->PRGeneration++;
8813 mtx_unlock(&lun->lun_lock);
8814 persis_io.hdr.nexus = ctsio->io_hdr.nexus;
8815 persis_io.hdr.msg_type = CTL_MSG_PERS_ACTION;
8816 persis_io.pr.pr_info.action = CTL_PR_CLEAR;
8817 if ((isc_retval=ctl_ha_msg_send(CTL_HA_CHAN_CTL, &persis_io,
8818 sizeof(persis_io), 0)) > CTL_HA_STATUS_SUCCESS) {
8819 printf("CTL:Persis Out error returned from "
8820 "ctl_ha_msg_send %d\n", isc_retval);
8824 case SPRO_PREEMPT: {
8827 nretval = ctl_pro_preempt(softc, lun, res_key, sa_res_key, type,
8828 residx, ctsio, cdb, param);
8830 return (CTL_RETVAL_COMPLETE);
8834 panic("Invalid PR type %x", cdb->action);
8838 free(ctsio->kern_data_ptr, M_CTL);
8839 ctl_set_success(ctsio);
8840 ctl_done((union ctl_io *)ctsio);
8846 * This routine is for handling a message from the other SC pertaining to
8847 * persistent reserve out. All the error checking will have been done
8848 * so only perorming the action need be done here to keep the two
8852 ctl_hndl_per_res_out_on_other_sc(union ctl_ha_msg *msg)
8854 struct ctl_lun *lun;
8855 struct ctl_softc *softc;
8859 softc = control_softc;
8861 targ_lun = msg->hdr.nexus.targ_mapped_lun;
8862 lun = softc->ctl_luns[targ_lun];
8863 mtx_lock(&lun->lun_lock);
8864 switch(msg->pr.pr_info.action) {
8865 case CTL_PR_REG_KEY:
8866 if (!lun->per_res[msg->pr.pr_info.residx].registered) {
8867 lun->per_res[msg->pr.pr_info.residx].registered = 1;
8868 lun->pr_key_count++;
8870 lun->PRGeneration++;
8871 memcpy(&lun->per_res[msg->pr.pr_info.residx].res_key,
8872 msg->pr.pr_info.sa_res_key,
8873 sizeof(struct scsi_per_res_key));
8876 case CTL_PR_UNREG_KEY:
8877 lun->per_res[msg->pr.pr_info.residx].registered = 0;
8878 memset(&lun->per_res[msg->pr.pr_info.residx].res_key,
8879 0, sizeof(struct scsi_per_res_key));
8880 lun->pr_key_count--;
8882 /* XXX Need to see if the reservation has been released */
8883 /* if so do we need to generate UA? */
8884 if (msg->pr.pr_info.residx == lun->pr_res_idx) {
8885 lun->flags &= ~CTL_LUN_PR_RESERVED;
8886 lun->pr_res_idx = CTL_PR_NO_RESERVATION;
8888 if ((lun->res_type == SPR_TYPE_WR_EX_RO
8889 || lun->res_type == SPR_TYPE_EX_AC_RO)
8890 && lun->pr_key_count) {
8892 * If the reservation is a registrants
8893 * only type we need to generate a UA
8894 * for other registered inits. The
8895 * sense code should be RESERVATIONS
8899 for (i = 0; i < CTL_MAX_INITIATORS; i++) {
8901 persis_offset].registered == 0)
8904 lun->pending_ua[i] |=
8909 } else if (lun->pr_res_idx == CTL_PR_ALL_REGISTRANTS) {
8910 if (lun->pr_key_count==0) {
8911 lun->flags &= ~CTL_LUN_PR_RESERVED;
8913 lun->pr_res_idx = CTL_PR_NO_RESERVATION;
8916 lun->PRGeneration++;
8919 case CTL_PR_RESERVE:
8920 lun->flags |= CTL_LUN_PR_RESERVED;
8921 lun->res_type = msg->pr.pr_info.res_type;
8922 lun->pr_res_idx = msg->pr.pr_info.residx;
8926 case CTL_PR_RELEASE:
8928 * if this isn't an exclusive access res generate UA for all
8929 * other registrants.
8931 if (lun->res_type != SPR_TYPE_EX_AC
8932 && lun->res_type != SPR_TYPE_WR_EX) {
8933 for (i = 0; i < CTL_MAX_INITIATORS; i++)
8934 if (lun->per_res[i+persis_offset].registered)
8935 lun->pending_ua[i] |=
8939 lun->flags &= ~CTL_LUN_PR_RESERVED;
8940 lun->pr_res_idx = CTL_PR_NO_RESERVATION;
8944 case CTL_PR_PREEMPT:
8945 ctl_pro_preempt_other(lun, msg);
8948 lun->flags &= ~CTL_LUN_PR_RESERVED;
8950 lun->pr_key_count = 0;
8951 lun->pr_res_idx = CTL_PR_NO_RESERVATION;
8953 for (i=0; i < 2*CTL_MAX_INITIATORS; i++) {
8954 if (lun->per_res[i].registered == 0)
8957 && i < CTL_MAX_INITIATORS)
8958 lun->pending_ua[i] |= CTL_UA_RES_PREEMPT;
8959 else if (persis_offset
8960 && i >= persis_offset)
8961 lun->pending_ua[i-persis_offset] |=
8963 memset(&lun->per_res[i].res_key, 0,
8964 sizeof(struct scsi_per_res_key));
8965 lun->per_res[i].registered = 0;
8967 lun->PRGeneration++;
8971 mtx_unlock(&lun->lun_lock);
8975 ctl_read_write(struct ctl_scsiio *ctsio)
8977 struct ctl_lun *lun;
8978 struct ctl_lba_len_flags *lbalen;
8980 uint32_t num_blocks;
8985 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
8987 CTL_DEBUG_PRINT(("ctl_read_write: command: %#x\n", ctsio->cdb[0]));
8992 retval = CTL_RETVAL_COMPLETE;
8994 isread = ctsio->cdb[0] == READ_6 || ctsio->cdb[0] == READ_10
8995 || ctsio->cdb[0] == READ_12 || ctsio->cdb[0] == READ_16;
8996 if (lun->flags & CTL_LUN_PR_RESERVED && isread) {
9000 * XXX KDM need a lock here.
9002 residx = ctl_get_resindex(&ctsio->io_hdr.nexus);
9003 if ((lun->res_type == SPR_TYPE_EX_AC
9004 && residx != lun->pr_res_idx)
9005 || ((lun->res_type == SPR_TYPE_EX_AC_RO
9006 || lun->res_type == SPR_TYPE_EX_AC_AR)
9007 && !lun->per_res[residx].registered)) {
9008 ctl_set_reservation_conflict(ctsio);
9009 ctl_done((union ctl_io *)ctsio);
9010 return (CTL_RETVAL_COMPLETE);
9014 switch (ctsio->cdb[0]) {
9017 struct scsi_rw_6 *cdb;
9019 cdb = (struct scsi_rw_6 *)ctsio->cdb;
9021 lba = scsi_3btoul(cdb->addr);
9022 /* only 5 bits are valid in the most significant address byte */
9024 num_blocks = cdb->length;
9026 * This is correct according to SBC-2.
9028 if (num_blocks == 0)
9034 struct scsi_rw_10 *cdb;
9036 cdb = (struct scsi_rw_10 *)ctsio->cdb;
9038 if (cdb->byte2 & SRW10_FUA)
9040 if (cdb->byte2 & SRW10_DPO)
9043 lba = scsi_4btoul(cdb->addr);
9044 num_blocks = scsi_2btoul(cdb->length);
9047 case WRITE_VERIFY_10: {
9048 struct scsi_write_verify_10 *cdb;
9050 cdb = (struct scsi_write_verify_10 *)ctsio->cdb;
9053 * XXX KDM we should do actual write verify support at some
9054 * point. This is obviously fake, we're just translating
9055 * things to a write. So we don't even bother checking the
9056 * BYTCHK field, since we don't do any verification. If
9057 * the user asks for it, we'll just pretend we did it.
9059 if (cdb->byte2 & SWV_DPO)
9062 lba = scsi_4btoul(cdb->addr);
9063 num_blocks = scsi_2btoul(cdb->length);
9068 struct scsi_rw_12 *cdb;
9070 cdb = (struct scsi_rw_12 *)ctsio->cdb;
9072 if (cdb->byte2 & SRW12_FUA)
9074 if (cdb->byte2 & SRW12_DPO)
9076 lba = scsi_4btoul(cdb->addr);
9077 num_blocks = scsi_4btoul(cdb->length);
9080 case WRITE_VERIFY_12: {
9081 struct scsi_write_verify_12 *cdb;
9083 cdb = (struct scsi_write_verify_12 *)ctsio->cdb;
9085 if (cdb->byte2 & SWV_DPO)
9088 lba = scsi_4btoul(cdb->addr);
9089 num_blocks = scsi_4btoul(cdb->length);
9095 struct scsi_rw_16 *cdb;
9097 cdb = (struct scsi_rw_16 *)ctsio->cdb;
9099 if (cdb->byte2 & SRW12_FUA)
9101 if (cdb->byte2 & SRW12_DPO)
9104 lba = scsi_8btou64(cdb->addr);
9105 num_blocks = scsi_4btoul(cdb->length);
9108 case WRITE_VERIFY_16: {
9109 struct scsi_write_verify_16 *cdb;
9111 cdb = (struct scsi_write_verify_16 *)ctsio->cdb;
9113 if (cdb->byte2 & SWV_DPO)
9116 lba = scsi_8btou64(cdb->addr);
9117 num_blocks = scsi_4btoul(cdb->length);
9122 * We got a command we don't support. This shouldn't
9123 * happen, commands should be filtered out above us.
9125 ctl_set_invalid_opcode(ctsio);
9126 ctl_done((union ctl_io *)ctsio);
9128 return (CTL_RETVAL_COMPLETE);
9129 break; /* NOTREACHED */
9133 * XXX KDM what do we do with the DPO and FUA bits? FUA might be
9134 * interesting for us, but if RAIDCore is in write-back mode,
9135 * getting it to do write-through for a particular transaction may
9140 * The first check is to make sure we're in bounds, the second
9141 * check is to catch wrap-around problems. If the lba + num blocks
9142 * is less than the lba, then we've wrapped around and the block
9143 * range is invalid anyway.
9145 if (((lba + num_blocks) > (lun->be_lun->maxlba + 1))
9146 || ((lba + num_blocks) < lba)) {
9147 ctl_set_lba_out_of_range(ctsio);
9148 ctl_done((union ctl_io *)ctsio);
9149 return (CTL_RETVAL_COMPLETE);
9153 * According to SBC-3, a transfer length of 0 is not an error.
9154 * Note that this cannot happen with WRITE(6) or READ(6), since 0
9155 * translates to 256 blocks for those commands.
9157 if (num_blocks == 0) {
9158 ctl_set_success(ctsio);
9159 ctl_done((union ctl_io *)ctsio);
9160 return (CTL_RETVAL_COMPLETE);
9163 lbalen = (struct ctl_lba_len_flags *)
9164 &ctsio->io_hdr.ctl_private[CTL_PRIV_LBA_LEN];
9166 lbalen->len = num_blocks;
9167 lbalen->flags = isread ? CTL_LLF_READ : CTL_LLF_WRITE;
9169 ctsio->kern_total_len = num_blocks * lun->be_lun->blocksize;
9170 ctsio->kern_rel_offset = 0;
9172 CTL_DEBUG_PRINT(("ctl_read_write: calling data_submit()\n"));
9174 retval = lun->backend->data_submit((union ctl_io *)ctsio);
9180 ctl_cnw_cont(union ctl_io *io)
9182 struct ctl_scsiio *ctsio;
9183 struct ctl_lun *lun;
9184 struct ctl_lba_len_flags *lbalen;
9187 ctsio = &io->scsiio;
9188 ctsio->io_hdr.status = CTL_STATUS_NONE;
9189 ctsio->io_hdr.flags &= ~CTL_FLAG_IO_CONT;
9190 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
9191 lbalen = (struct ctl_lba_len_flags *)
9192 &ctsio->io_hdr.ctl_private[CTL_PRIV_LBA_LEN];
9193 lbalen->flags = CTL_LLF_WRITE;
9195 CTL_DEBUG_PRINT(("ctl_cnw_cont: calling data_submit()\n"));
9196 retval = lun->backend->data_submit((union ctl_io *)ctsio);
9201 ctl_cnw(struct ctl_scsiio *ctsio)
9203 struct ctl_lun *lun;
9204 struct ctl_lba_len_flags *lbalen;
9206 uint32_t num_blocks;
9210 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
9212 CTL_DEBUG_PRINT(("ctl_cnw: command: %#x\n", ctsio->cdb[0]));
9217 retval = CTL_RETVAL_COMPLETE;
9219 switch (ctsio->cdb[0]) {
9220 case COMPARE_AND_WRITE: {
9221 struct scsi_compare_and_write *cdb;
9223 cdb = (struct scsi_compare_and_write *)ctsio->cdb;
9225 if (cdb->byte2 & SRW10_FUA)
9227 if (cdb->byte2 & SRW10_DPO)
9229 lba = scsi_8btou64(cdb->addr);
9230 num_blocks = cdb->length;
9235 * We got a command we don't support. This shouldn't
9236 * happen, commands should be filtered out above us.
9238 ctl_set_invalid_opcode(ctsio);
9239 ctl_done((union ctl_io *)ctsio);
9241 return (CTL_RETVAL_COMPLETE);
9242 break; /* NOTREACHED */
9246 * XXX KDM what do we do with the DPO and FUA bits? FUA might be
9247 * interesting for us, but if RAIDCore is in write-back mode,
9248 * getting it to do write-through for a particular transaction may
9253 * The first check is to make sure we're in bounds, the second
9254 * check is to catch wrap-around problems. If the lba + num blocks
9255 * is less than the lba, then we've wrapped around and the block
9256 * range is invalid anyway.
9258 if (((lba + num_blocks) > (lun->be_lun->maxlba + 1))
9259 || ((lba + num_blocks) < lba)) {
9260 ctl_set_lba_out_of_range(ctsio);
9261 ctl_done((union ctl_io *)ctsio);
9262 return (CTL_RETVAL_COMPLETE);
9266 * According to SBC-3, a transfer length of 0 is not an error.
9268 if (num_blocks == 0) {
9269 ctl_set_success(ctsio);
9270 ctl_done((union ctl_io *)ctsio);
9271 return (CTL_RETVAL_COMPLETE);
9274 ctsio->kern_total_len = 2 * num_blocks * lun->be_lun->blocksize;
9275 ctsio->kern_rel_offset = 0;
9278 * Set the IO_CONT flag, so that if this I/O gets passed to
9279 * ctl_data_submit_done(), it'll get passed back to
9280 * ctl_ctl_cnw_cont() for further processing.
9282 ctsio->io_hdr.flags |= CTL_FLAG_IO_CONT;
9283 ctsio->io_cont = ctl_cnw_cont;
9285 lbalen = (struct ctl_lba_len_flags *)
9286 &ctsio->io_hdr.ctl_private[CTL_PRIV_LBA_LEN];
9288 lbalen->len = num_blocks;
9289 lbalen->flags = CTL_LLF_COMPARE;
9291 CTL_DEBUG_PRINT(("ctl_cnw: calling data_submit()\n"));
9292 retval = lun->backend->data_submit((union ctl_io *)ctsio);
9297 ctl_verify(struct ctl_scsiio *ctsio)
9299 struct ctl_lun *lun;
9300 struct ctl_lba_len_flags *lbalen;
9302 uint32_t num_blocks;
9306 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
9308 CTL_DEBUG_PRINT(("ctl_verify: command: %#x\n", ctsio->cdb[0]));
9312 retval = CTL_RETVAL_COMPLETE;
9314 switch (ctsio->cdb[0]) {
9316 struct scsi_verify_10 *cdb;
9318 cdb = (struct scsi_verify_10 *)ctsio->cdb;
9319 if (cdb->byte2 & SVFY_BYTCHK)
9321 if (cdb->byte2 & SVFY_DPO)
9323 lba = scsi_4btoul(cdb->addr);
9324 num_blocks = scsi_2btoul(cdb->length);
9328 struct scsi_verify_12 *cdb;
9330 cdb = (struct scsi_verify_12 *)ctsio->cdb;
9331 if (cdb->byte2 & SVFY_BYTCHK)
9333 if (cdb->byte2 & SVFY_DPO)
9335 lba = scsi_4btoul(cdb->addr);
9336 num_blocks = scsi_4btoul(cdb->length);
9340 struct scsi_rw_16 *cdb;
9342 cdb = (struct scsi_rw_16 *)ctsio->cdb;
9343 if (cdb->byte2 & SVFY_BYTCHK)
9345 if (cdb->byte2 & SVFY_DPO)
9347 lba = scsi_8btou64(cdb->addr);
9348 num_blocks = scsi_4btoul(cdb->length);
9353 * We got a command we don't support. This shouldn't
9354 * happen, commands should be filtered out above us.
9356 ctl_set_invalid_opcode(ctsio);
9357 ctl_done((union ctl_io *)ctsio);
9358 return (CTL_RETVAL_COMPLETE);
9362 * The first check is to make sure we're in bounds, the second
9363 * check is to catch wrap-around problems. If the lba + num blocks
9364 * is less than the lba, then we've wrapped around and the block
9365 * range is invalid anyway.
9367 if (((lba + num_blocks) > (lun->be_lun->maxlba + 1))
9368 || ((lba + num_blocks) < lba)) {
9369 ctl_set_lba_out_of_range(ctsio);
9370 ctl_done((union ctl_io *)ctsio);
9371 return (CTL_RETVAL_COMPLETE);
9375 * According to SBC-3, a transfer length of 0 is not an error.
9377 if (num_blocks == 0) {
9378 ctl_set_success(ctsio);
9379 ctl_done((union ctl_io *)ctsio);
9380 return (CTL_RETVAL_COMPLETE);
9383 lbalen = (struct ctl_lba_len_flags *)
9384 &ctsio->io_hdr.ctl_private[CTL_PRIV_LBA_LEN];
9386 lbalen->len = num_blocks;
9388 lbalen->flags = CTL_LLF_COMPARE;
9389 ctsio->kern_total_len = num_blocks * lun->be_lun->blocksize;
9391 lbalen->flags = CTL_LLF_VERIFY;
9392 ctsio->kern_total_len = 0;
9394 ctsio->kern_rel_offset = 0;
9396 CTL_DEBUG_PRINT(("ctl_verify: calling data_submit()\n"));
9397 retval = lun->backend->data_submit((union ctl_io *)ctsio);
9402 ctl_report_luns(struct ctl_scsiio *ctsio)
9404 struct scsi_report_luns *cdb;
9405 struct scsi_report_luns_data *lun_data;
9406 struct ctl_lun *lun, *request_lun;
9407 int num_luns, retval;
9408 uint32_t alloc_len, lun_datalen;
9409 int num_filled, well_known;
9410 uint32_t initidx, targ_lun_id, lun_id;
9412 retval = CTL_RETVAL_COMPLETE;
9415 cdb = (struct scsi_report_luns *)ctsio->cdb;
9417 CTL_DEBUG_PRINT(("ctl_report_luns\n"));
9419 mtx_lock(&control_softc->ctl_lock);
9420 num_luns = control_softc->num_luns;
9421 mtx_unlock(&control_softc->ctl_lock);
9423 switch (cdb->select_report) {
9424 case RPL_REPORT_DEFAULT:
9425 case RPL_REPORT_ALL:
9427 case RPL_REPORT_WELLKNOWN:
9432 ctl_set_invalid_field(ctsio,
9438 ctl_done((union ctl_io *)ctsio);
9440 break; /* NOTREACHED */
9443 alloc_len = scsi_4btoul(cdb->length);
9445 * The initiator has to allocate at least 16 bytes for this request,
9446 * so he can at least get the header and the first LUN. Otherwise
9447 * we reject the request (per SPC-3 rev 14, section 6.21).
9449 if (alloc_len < (sizeof(struct scsi_report_luns_data) +
9450 sizeof(struct scsi_report_luns_lundata))) {
9451 ctl_set_invalid_field(ctsio,
9457 ctl_done((union ctl_io *)ctsio);
9461 request_lun = (struct ctl_lun *)
9462 ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
9464 lun_datalen = sizeof(*lun_data) +
9465 (num_luns * sizeof(struct scsi_report_luns_lundata));
9467 ctsio->kern_data_ptr = malloc(lun_datalen, M_CTL, M_WAITOK | M_ZERO);
9468 lun_data = (struct scsi_report_luns_data *)ctsio->kern_data_ptr;
9469 ctsio->kern_sg_entries = 0;
9471 initidx = ctl_get_initindex(&ctsio->io_hdr.nexus);
9473 mtx_lock(&control_softc->ctl_lock);
9474 for (targ_lun_id = 0, num_filled = 0; targ_lun_id < CTL_MAX_LUNS && num_filled < num_luns; targ_lun_id++) {
9475 lun_id = ctl_map_lun(ctsio->io_hdr.nexus.targ_port, targ_lun_id);
9476 if (lun_id >= CTL_MAX_LUNS)
9478 lun = control_softc->ctl_luns[lun_id];
9482 if (targ_lun_id <= 0xff) {
9484 * Peripheral addressing method, bus number 0.
9486 lun_data->luns[num_filled].lundata[0] =
9487 RPL_LUNDATA_ATYP_PERIPH;
9488 lun_data->luns[num_filled].lundata[1] = targ_lun_id;
9490 } else if (targ_lun_id <= 0x3fff) {
9492 * Flat addressing method.
9494 lun_data->luns[num_filled].lundata[0] =
9495 RPL_LUNDATA_ATYP_FLAT |
9496 (targ_lun_id & RPL_LUNDATA_FLAT_LUN_MASK);
9497 #ifdef OLDCTLHEADERS
9498 (SRLD_ADDR_FLAT << SRLD_ADDR_SHIFT) |
9499 (targ_lun_id & SRLD_BUS_LUN_MASK);
9501 lun_data->luns[num_filled].lundata[1] =
9502 #ifdef OLDCTLHEADERS
9503 targ_lun_id >> SRLD_BUS_LUN_BITS;
9505 targ_lun_id >> RPL_LUNDATA_FLAT_LUN_BITS;
9508 printf("ctl_report_luns: bogus LUN number %jd, "
9509 "skipping\n", (intmax_t)targ_lun_id);
9512 * According to SPC-3, rev 14 section 6.21:
9514 * "The execution of a REPORT LUNS command to any valid and
9515 * installed logical unit shall clear the REPORTED LUNS DATA
9516 * HAS CHANGED unit attention condition for all logical
9517 * units of that target with respect to the requesting
9518 * initiator. A valid and installed logical unit is one
9519 * having a PERIPHERAL QUALIFIER of 000b in the standard
9520 * INQUIRY data (see 6.4.2)."
9522 * If request_lun is NULL, the LUN this report luns command
9523 * was issued to is either disabled or doesn't exist. In that
9524 * case, we shouldn't clear any pending lun change unit
9527 if (request_lun != NULL) {
9528 mtx_lock(&lun->lun_lock);
9529 lun->pending_ua[initidx] &= ~CTL_UA_LUN_CHANGE;
9530 mtx_unlock(&lun->lun_lock);
9533 mtx_unlock(&control_softc->ctl_lock);
9536 * It's quite possible that we've returned fewer LUNs than we allocated
9537 * space for. Trim it.
9539 lun_datalen = sizeof(*lun_data) +
9540 (num_filled * sizeof(struct scsi_report_luns_lundata));
9542 if (lun_datalen < alloc_len) {
9543 ctsio->residual = alloc_len - lun_datalen;
9544 ctsio->kern_data_len = lun_datalen;
9545 ctsio->kern_total_len = lun_datalen;
9547 ctsio->residual = 0;
9548 ctsio->kern_data_len = alloc_len;
9549 ctsio->kern_total_len = alloc_len;
9551 ctsio->kern_data_resid = 0;
9552 ctsio->kern_rel_offset = 0;
9553 ctsio->kern_sg_entries = 0;
9556 * We set this to the actual data length, regardless of how much
9557 * space we actually have to return results. If the user looks at
9558 * this value, he'll know whether or not he allocated enough space
9559 * and reissue the command if necessary. We don't support well
9560 * known logical units, so if the user asks for that, return none.
9562 scsi_ulto4b(lun_datalen - 8, lun_data->length);
9565 * We can only return SCSI_STATUS_CHECK_COND when we can't satisfy
9568 ctsio->scsi_status = SCSI_STATUS_OK;
9570 ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
9571 ctsio->be_move_done = ctl_config_move_done;
9572 ctl_datamove((union ctl_io *)ctsio);
9578 ctl_request_sense(struct ctl_scsiio *ctsio)
9580 struct scsi_request_sense *cdb;
9581 struct scsi_sense_data *sense_ptr;
9582 struct ctl_lun *lun;
9585 scsi_sense_data_type sense_format;
9587 cdb = (struct scsi_request_sense *)ctsio->cdb;
9589 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
9591 CTL_DEBUG_PRINT(("ctl_request_sense\n"));
9594 * Determine which sense format the user wants.
9596 if (cdb->byte2 & SRS_DESC)
9597 sense_format = SSD_TYPE_DESC;
9599 sense_format = SSD_TYPE_FIXED;
9601 ctsio->kern_data_ptr = malloc(sizeof(*sense_ptr), M_CTL, M_WAITOK);
9602 sense_ptr = (struct scsi_sense_data *)ctsio->kern_data_ptr;
9603 ctsio->kern_sg_entries = 0;
9606 * struct scsi_sense_data, which is currently set to 256 bytes, is
9607 * larger than the largest allowed value for the length field in the
9608 * REQUEST SENSE CDB, which is 252 bytes as of SPC-4.
9610 ctsio->residual = 0;
9611 ctsio->kern_data_len = cdb->length;
9612 ctsio->kern_total_len = cdb->length;
9614 ctsio->kern_data_resid = 0;
9615 ctsio->kern_rel_offset = 0;
9616 ctsio->kern_sg_entries = 0;
9619 * If we don't have a LUN, we don't have any pending sense.
9625 initidx = ctl_get_initindex(&ctsio->io_hdr.nexus);
9627 * Check for pending sense, and then for pending unit attentions.
9628 * Pending sense gets returned first, then pending unit attentions.
9630 mtx_lock(&lun->lun_lock);
9632 if (ctl_is_set(lun->have_ca, initidx)) {
9633 scsi_sense_data_type stored_format;
9636 * Check to see which sense format was used for the stored
9639 stored_format = scsi_sense_type(&lun->pending_sense[initidx]);
9642 * If the user requested a different sense format than the
9643 * one we stored, then we need to convert it to the other
9644 * format. If we're going from descriptor to fixed format
9645 * sense data, we may lose things in translation, depending
9646 * on what options were used.
9648 * If the stored format is SSD_TYPE_NONE (i.e. invalid),
9649 * for some reason we'll just copy it out as-is.
9651 if ((stored_format == SSD_TYPE_FIXED)
9652 && (sense_format == SSD_TYPE_DESC))
9653 ctl_sense_to_desc((struct scsi_sense_data_fixed *)
9654 &lun->pending_sense[initidx],
9655 (struct scsi_sense_data_desc *)sense_ptr);
9656 else if ((stored_format == SSD_TYPE_DESC)
9657 && (sense_format == SSD_TYPE_FIXED))
9658 ctl_sense_to_fixed((struct scsi_sense_data_desc *)
9659 &lun->pending_sense[initidx],
9660 (struct scsi_sense_data_fixed *)sense_ptr);
9662 memcpy(sense_ptr, &lun->pending_sense[initidx],
9663 ctl_min(sizeof(*sense_ptr),
9664 sizeof(lun->pending_sense[initidx])));
9666 ctl_clear_mask(lun->have_ca, initidx);
9670 if (lun->pending_ua[initidx] != CTL_UA_NONE) {
9671 ctl_ua_type ua_type;
9673 ua_type = ctl_build_ua(lun->pending_ua[initidx],
9674 sense_ptr, sense_format);
9675 if (ua_type != CTL_UA_NONE) {
9677 /* We're reporting this UA, so clear it */
9678 lun->pending_ua[initidx] &= ~ua_type;
9681 mtx_unlock(&lun->lun_lock);
9684 * We already have a pending error, return it.
9686 if (have_error != 0) {
9688 * We report the SCSI status as OK, since the status of the
9689 * request sense command itself is OK.
9691 ctsio->scsi_status = SCSI_STATUS_OK;
9694 * We report 0 for the sense length, because we aren't doing
9695 * autosense in this case. We're reporting sense as
9698 ctsio->sense_len = 0;
9699 ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
9700 ctsio->be_move_done = ctl_config_move_done;
9701 ctl_datamove((union ctl_io *)ctsio);
9703 return (CTL_RETVAL_COMPLETE);
9709 * No sense information to report, so we report that everything is
9712 ctl_set_sense_data(sense_ptr,
9715 /*current_error*/ 1,
9716 /*sense_key*/ SSD_KEY_NO_SENSE,
9721 ctsio->scsi_status = SCSI_STATUS_OK;
9724 * We report 0 for the sense length, because we aren't doing
9725 * autosense in this case. We're reporting sense as parameter data.
9727 ctsio->sense_len = 0;
9728 ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
9729 ctsio->be_move_done = ctl_config_move_done;
9730 ctl_datamove((union ctl_io *)ctsio);
9732 return (CTL_RETVAL_COMPLETE);
9736 ctl_tur(struct ctl_scsiio *ctsio)
9738 struct ctl_lun *lun;
9740 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
9742 CTL_DEBUG_PRINT(("ctl_tur\n"));
9747 ctsio->scsi_status = SCSI_STATUS_OK;
9748 ctsio->io_hdr.status = CTL_SUCCESS;
9750 ctl_done((union ctl_io *)ctsio);
9752 return (CTL_RETVAL_COMPLETE);
9757 ctl_cmddt_inquiry(struct ctl_scsiio *ctsio)
9764 ctl_inquiry_evpd_supported(struct ctl_scsiio *ctsio, int alloc_len)
9766 struct scsi_vpd_supported_pages *pages;
9768 struct ctl_lun *lun;
9770 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
9772 sup_page_size = sizeof(struct scsi_vpd_supported_pages) *
9773 SCSI_EVPD_NUM_SUPPORTED_PAGES;
9774 ctsio->kern_data_ptr = malloc(sup_page_size, M_CTL, M_WAITOK | M_ZERO);
9775 pages = (struct scsi_vpd_supported_pages *)ctsio->kern_data_ptr;
9776 ctsio->kern_sg_entries = 0;
9778 if (sup_page_size < alloc_len) {
9779 ctsio->residual = alloc_len - sup_page_size;
9780 ctsio->kern_data_len = sup_page_size;
9781 ctsio->kern_total_len = sup_page_size;
9783 ctsio->residual = 0;
9784 ctsio->kern_data_len = alloc_len;
9785 ctsio->kern_total_len = alloc_len;
9787 ctsio->kern_data_resid = 0;
9788 ctsio->kern_rel_offset = 0;
9789 ctsio->kern_sg_entries = 0;
9792 * The control device is always connected. The disk device, on the
9793 * other hand, may not be online all the time. Need to change this
9794 * to figure out whether the disk device is actually online or not.
9797 pages->device = (SID_QUAL_LU_CONNECTED << 5) |
9798 lun->be_lun->lun_type;
9800 pages->device = (SID_QUAL_LU_OFFLINE << 5) | T_DIRECT;
9802 pages->length = SCSI_EVPD_NUM_SUPPORTED_PAGES;
9803 /* Supported VPD pages */
9804 pages->page_list[0] = SVPD_SUPPORTED_PAGES;
9806 pages->page_list[1] = SVPD_UNIT_SERIAL_NUMBER;
9807 /* Device Identification */
9808 pages->page_list[2] = SVPD_DEVICE_ID;
9810 pages->page_list[3] = SVPD_SCSI_PORTS;
9811 /* Third-party Copy */
9812 pages->page_list[4] = SVPD_SCSI_TPC;
9814 pages->page_list[5] = SVPD_BLOCK_LIMITS;
9815 /* Block Device Characteristics */
9816 pages->page_list[6] = SVPD_BDC;
9817 /* Logical Block Provisioning */
9818 pages->page_list[7] = SVPD_LBP;
9820 ctsio->scsi_status = SCSI_STATUS_OK;
9822 ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
9823 ctsio->be_move_done = ctl_config_move_done;
9824 ctl_datamove((union ctl_io *)ctsio);
9826 return (CTL_RETVAL_COMPLETE);
9830 ctl_inquiry_evpd_serial(struct ctl_scsiio *ctsio, int alloc_len)
9832 struct scsi_vpd_unit_serial_number *sn_ptr;
9833 struct ctl_lun *lun;
9835 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
9837 ctsio->kern_data_ptr = malloc(sizeof(*sn_ptr), M_CTL, M_WAITOK | M_ZERO);
9838 sn_ptr = (struct scsi_vpd_unit_serial_number *)ctsio->kern_data_ptr;
9839 ctsio->kern_sg_entries = 0;
9841 if (sizeof(*sn_ptr) < alloc_len) {
9842 ctsio->residual = alloc_len - sizeof(*sn_ptr);
9843 ctsio->kern_data_len = sizeof(*sn_ptr);
9844 ctsio->kern_total_len = sizeof(*sn_ptr);
9846 ctsio->residual = 0;
9847 ctsio->kern_data_len = alloc_len;
9848 ctsio->kern_total_len = alloc_len;
9850 ctsio->kern_data_resid = 0;
9851 ctsio->kern_rel_offset = 0;
9852 ctsio->kern_sg_entries = 0;
9855 * The control device is always connected. The disk device, on the
9856 * other hand, may not be online all the time. Need to change this
9857 * to figure out whether the disk device is actually online or not.
9860 sn_ptr->device = (SID_QUAL_LU_CONNECTED << 5) |
9861 lun->be_lun->lun_type;
9863 sn_ptr->device = (SID_QUAL_LU_OFFLINE << 5) | T_DIRECT;
9865 sn_ptr->page_code = SVPD_UNIT_SERIAL_NUMBER;
9866 sn_ptr->length = ctl_min(sizeof(*sn_ptr) - 4, CTL_SN_LEN);
9868 * If we don't have a LUN, we just leave the serial number as
9871 memset(sn_ptr->serial_num, 0x20, sizeof(sn_ptr->serial_num));
9873 strncpy((char *)sn_ptr->serial_num,
9874 (char *)lun->be_lun->serial_num, CTL_SN_LEN);
9876 ctsio->scsi_status = SCSI_STATUS_OK;
9878 ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
9879 ctsio->be_move_done = ctl_config_move_done;
9880 ctl_datamove((union ctl_io *)ctsio);
9882 return (CTL_RETVAL_COMPLETE);
9887 ctl_inquiry_evpd_devid(struct ctl_scsiio *ctsio, int alloc_len)
9889 struct scsi_vpd_device_id *devid_ptr;
9890 struct scsi_vpd_id_descriptor *desc;
9891 struct ctl_softc *ctl_softc;
9892 struct ctl_lun *lun;
9893 struct ctl_port *port;
9897 ctl_softc = control_softc;
9899 port = ctl_softc->ctl_ports[ctl_port_idx(ctsio->io_hdr.nexus.targ_port)];
9900 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
9902 data_len = sizeof(struct scsi_vpd_device_id) +
9903 sizeof(struct scsi_vpd_id_descriptor) +
9904 sizeof(struct scsi_vpd_id_rel_trgt_port_id) +
9905 sizeof(struct scsi_vpd_id_descriptor) +
9906 sizeof(struct scsi_vpd_id_trgt_port_grp_id);
9907 if (lun && lun->lun_devid)
9908 data_len += lun->lun_devid->len;
9909 if (port->port_devid)
9910 data_len += port->port_devid->len;
9911 if (port->target_devid)
9912 data_len += port->target_devid->len;
9914 ctsio->kern_data_ptr = malloc(data_len, M_CTL, M_WAITOK | M_ZERO);
9915 devid_ptr = (struct scsi_vpd_device_id *)ctsio->kern_data_ptr;
9916 ctsio->kern_sg_entries = 0;
9918 if (data_len < alloc_len) {
9919 ctsio->residual = alloc_len - data_len;
9920 ctsio->kern_data_len = data_len;
9921 ctsio->kern_total_len = data_len;
9923 ctsio->residual = 0;
9924 ctsio->kern_data_len = alloc_len;
9925 ctsio->kern_total_len = alloc_len;
9927 ctsio->kern_data_resid = 0;
9928 ctsio->kern_rel_offset = 0;
9929 ctsio->kern_sg_entries = 0;
9932 * The control device is always connected. The disk device, on the
9933 * other hand, may not be online all the time.
9936 devid_ptr->device = (SID_QUAL_LU_CONNECTED << 5) |
9937 lun->be_lun->lun_type;
9939 devid_ptr->device = (SID_QUAL_LU_OFFLINE << 5) | T_DIRECT;
9940 devid_ptr->page_code = SVPD_DEVICE_ID;
9941 scsi_ulto2b(data_len - 4, devid_ptr->length);
9943 if (port->port_type == CTL_PORT_FC)
9944 proto = SCSI_PROTO_FC << 4;
9945 else if (port->port_type == CTL_PORT_ISCSI)
9946 proto = SCSI_PROTO_ISCSI << 4;
9948 proto = SCSI_PROTO_SPI << 4;
9949 desc = (struct scsi_vpd_id_descriptor *)devid_ptr->desc_list;
9952 * We're using a LUN association here. i.e., this device ID is a
9953 * per-LUN identifier.
9955 if (lun && lun->lun_devid) {
9956 memcpy(desc, lun->lun_devid->data, lun->lun_devid->len);
9957 desc = (struct scsi_vpd_id_descriptor *)((uint8_t *)desc +
9958 lun->lun_devid->len);
9962 * This is for the WWPN which is a port association.
9964 if (port->port_devid) {
9965 memcpy(desc, port->port_devid->data, port->port_devid->len);
9966 desc = (struct scsi_vpd_id_descriptor *)((uint8_t *)desc +
9967 port->port_devid->len);
9971 * This is for the Relative Target Port(type 4h) identifier
9973 desc->proto_codeset = proto | SVPD_ID_CODESET_BINARY;
9974 desc->id_type = SVPD_ID_PIV | SVPD_ID_ASSOC_PORT |
9975 SVPD_ID_TYPE_RELTARG;
9977 scsi_ulto2b(ctsio->io_hdr.nexus.targ_port, &desc->identifier[2]);
9978 desc = (struct scsi_vpd_id_descriptor *)(&desc->identifier[0] +
9979 sizeof(struct scsi_vpd_id_rel_trgt_port_id));
9982 * This is for the Target Port Group(type 5h) identifier
9984 desc->proto_codeset = proto | SVPD_ID_CODESET_BINARY;
9985 desc->id_type = SVPD_ID_PIV | SVPD_ID_ASSOC_PORT |
9986 SVPD_ID_TYPE_TPORTGRP;
9988 scsi_ulto2b(ctsio->io_hdr.nexus.targ_port / CTL_MAX_PORTS + 1,
9989 &desc->identifier[2]);
9990 desc = (struct scsi_vpd_id_descriptor *)(&desc->identifier[0] +
9991 sizeof(struct scsi_vpd_id_trgt_port_grp_id));
9994 * This is for the Target identifier
9996 if (port->target_devid) {
9997 memcpy(desc, port->target_devid->data, port->target_devid->len);
10000 ctsio->scsi_status = SCSI_STATUS_OK;
10001 ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
10002 ctsio->be_move_done = ctl_config_move_done;
10003 ctl_datamove((union ctl_io *)ctsio);
10005 return (CTL_RETVAL_COMPLETE);
10009 ctl_inquiry_evpd_scsi_ports(struct ctl_scsiio *ctsio, int alloc_len)
10011 struct ctl_softc *softc = control_softc;
10012 struct scsi_vpd_scsi_ports *sp;
10013 struct scsi_vpd_port_designation *pd;
10014 struct scsi_vpd_port_designation_cont *pdc;
10015 struct ctl_lun *lun;
10016 struct ctl_port *port;
10017 int data_len, num_target_ports, iid_len, id_len, g, pg, p;
10018 int num_target_port_groups, single;
10020 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
10022 single = ctl_is_single;
10024 num_target_port_groups = 1;
10026 num_target_port_groups = NUM_TARGET_PORT_GROUPS;
10027 num_target_ports = 0;
10030 mtx_lock(&softc->ctl_lock);
10031 STAILQ_FOREACH(port, &softc->port_list, links) {
10032 if ((port->status & CTL_PORT_STATUS_ONLINE) == 0)
10035 ctl_map_lun_back(port->targ_port, lun->lun) >=
10038 num_target_ports++;
10039 if (port->init_devid)
10040 iid_len += port->init_devid->len;
10041 if (port->port_devid)
10042 id_len += port->port_devid->len;
10044 mtx_unlock(&softc->ctl_lock);
10046 data_len = sizeof(struct scsi_vpd_scsi_ports) + num_target_port_groups *
10047 num_target_ports * (sizeof(struct scsi_vpd_port_designation) +
10048 sizeof(struct scsi_vpd_port_designation_cont)) + iid_len + id_len;
10049 ctsio->kern_data_ptr = malloc(data_len, M_CTL, M_WAITOK | M_ZERO);
10050 sp = (struct scsi_vpd_scsi_ports *)ctsio->kern_data_ptr;
10051 ctsio->kern_sg_entries = 0;
10053 if (data_len < alloc_len) {
10054 ctsio->residual = alloc_len - data_len;
10055 ctsio->kern_data_len = data_len;
10056 ctsio->kern_total_len = data_len;
10058 ctsio->residual = 0;
10059 ctsio->kern_data_len = alloc_len;
10060 ctsio->kern_total_len = alloc_len;
10062 ctsio->kern_data_resid = 0;
10063 ctsio->kern_rel_offset = 0;
10064 ctsio->kern_sg_entries = 0;
10067 * The control device is always connected. The disk device, on the
10068 * other hand, may not be online all the time. Need to change this
10069 * to figure out whether the disk device is actually online or not.
10072 sp->device = (SID_QUAL_LU_CONNECTED << 5) |
10073 lun->be_lun->lun_type;
10075 sp->device = (SID_QUAL_LU_OFFLINE << 5) | T_DIRECT;
10077 sp->page_code = SVPD_SCSI_PORTS;
10078 scsi_ulto2b(data_len - sizeof(struct scsi_vpd_scsi_ports),
10080 pd = &sp->design[0];
10082 mtx_lock(&softc->ctl_lock);
10083 if (softc->flags & CTL_FLAG_MASTER_SHELF)
10087 for (g = 0; g < num_target_port_groups; g++) {
10088 STAILQ_FOREACH(port, &softc->port_list, links) {
10089 if ((port->status & CTL_PORT_STATUS_ONLINE) == 0)
10092 ctl_map_lun_back(port->targ_port, lun->lun) >=
10095 p = port->targ_port % CTL_MAX_PORTS + g * CTL_MAX_PORTS;
10096 scsi_ulto2b(p, pd->relative_port_id);
10097 if (port->init_devid && g == pg) {
10098 iid_len = port->init_devid->len;
10099 memcpy(pd->initiator_transportid,
10100 port->init_devid->data, port->init_devid->len);
10103 scsi_ulto2b(iid_len, pd->initiator_transportid_length);
10104 pdc = (struct scsi_vpd_port_designation_cont *)
10105 (&pd->initiator_transportid[iid_len]);
10106 if (port->port_devid && g == pg) {
10107 id_len = port->port_devid->len;
10108 memcpy(pdc->target_port_descriptors,
10109 port->port_devid->data, port->port_devid->len);
10112 scsi_ulto2b(id_len, pdc->target_port_descriptors_length);
10113 pd = (struct scsi_vpd_port_designation *)
10114 ((uint8_t *)pdc->target_port_descriptors + id_len);
10117 mtx_unlock(&softc->ctl_lock);
10119 ctsio->scsi_status = SCSI_STATUS_OK;
10120 ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
10121 ctsio->be_move_done = ctl_config_move_done;
10122 ctl_datamove((union ctl_io *)ctsio);
10124 return (CTL_RETVAL_COMPLETE);
10128 ctl_inquiry_evpd_block_limits(struct ctl_scsiio *ctsio, int alloc_len)
10130 struct scsi_vpd_block_limits *bl_ptr;
10131 struct ctl_lun *lun;
10134 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
10136 ctsio->kern_data_ptr = malloc(sizeof(*bl_ptr), M_CTL, M_WAITOK | M_ZERO);
10137 bl_ptr = (struct scsi_vpd_block_limits *)ctsio->kern_data_ptr;
10138 ctsio->kern_sg_entries = 0;
10140 if (sizeof(*bl_ptr) < alloc_len) {
10141 ctsio->residual = alloc_len - sizeof(*bl_ptr);
10142 ctsio->kern_data_len = sizeof(*bl_ptr);
10143 ctsio->kern_total_len = sizeof(*bl_ptr);
10145 ctsio->residual = 0;
10146 ctsio->kern_data_len = alloc_len;
10147 ctsio->kern_total_len = alloc_len;
10149 ctsio->kern_data_resid = 0;
10150 ctsio->kern_rel_offset = 0;
10151 ctsio->kern_sg_entries = 0;
10154 * The control device is always connected. The disk device, on the
10155 * other hand, may not be online all the time. Need to change this
10156 * to figure out whether the disk device is actually online or not.
10159 bl_ptr->device = (SID_QUAL_LU_CONNECTED << 5) |
10160 lun->be_lun->lun_type;
10162 bl_ptr->device = (SID_QUAL_LU_OFFLINE << 5) | T_DIRECT;
10164 bl_ptr->page_code = SVPD_BLOCK_LIMITS;
10165 scsi_ulto2b(sizeof(*bl_ptr), bl_ptr->page_length);
10166 bl_ptr->max_cmp_write_len = 0xff;
10167 scsi_ulto4b(0xffffffff, bl_ptr->max_txfer_len);
10169 bs = lun->be_lun->blocksize;
10170 scsi_ulto4b(MAXPHYS / bs, bl_ptr->opt_txfer_len);
10171 if (lun->be_lun->flags & CTL_LUN_FLAG_UNMAP) {
10172 scsi_ulto4b(0xffffffff, bl_ptr->max_unmap_lba_cnt);
10173 scsi_ulto4b(0xffffffff, bl_ptr->max_unmap_blk_cnt);
10174 if (lun->be_lun->pblockexp != 0) {
10175 scsi_ulto4b((1 << lun->be_lun->pblockexp),
10176 bl_ptr->opt_unmap_grain);
10177 scsi_ulto4b(0x80000000 | lun->be_lun->pblockoff,
10178 bl_ptr->unmap_grain_align);
10182 scsi_u64to8b(UINT64_MAX, bl_ptr->max_write_same_length);
10184 ctsio->scsi_status = SCSI_STATUS_OK;
10185 ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
10186 ctsio->be_move_done = ctl_config_move_done;
10187 ctl_datamove((union ctl_io *)ctsio);
10189 return (CTL_RETVAL_COMPLETE);
10193 ctl_inquiry_evpd_bdc(struct ctl_scsiio *ctsio, int alloc_len)
10195 struct scsi_vpd_block_device_characteristics *bdc_ptr;
10196 struct ctl_lun *lun;
10198 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
10200 ctsio->kern_data_ptr = malloc(sizeof(*bdc_ptr), M_CTL, M_WAITOK | M_ZERO);
10201 bdc_ptr = (struct scsi_vpd_block_device_characteristics *)ctsio->kern_data_ptr;
10202 ctsio->kern_sg_entries = 0;
10204 if (sizeof(*bdc_ptr) < alloc_len) {
10205 ctsio->residual = alloc_len - sizeof(*bdc_ptr);
10206 ctsio->kern_data_len = sizeof(*bdc_ptr);
10207 ctsio->kern_total_len = sizeof(*bdc_ptr);
10209 ctsio->residual = 0;
10210 ctsio->kern_data_len = alloc_len;
10211 ctsio->kern_total_len = alloc_len;
10213 ctsio->kern_data_resid = 0;
10214 ctsio->kern_rel_offset = 0;
10215 ctsio->kern_sg_entries = 0;
10218 * The control device is always connected. The disk device, on the
10219 * other hand, may not be online all the time. Need to change this
10220 * to figure out whether the disk device is actually online or not.
10223 bdc_ptr->device = (SID_QUAL_LU_CONNECTED << 5) |
10224 lun->be_lun->lun_type;
10226 bdc_ptr->device = (SID_QUAL_LU_OFFLINE << 5) | T_DIRECT;
10227 bdc_ptr->page_code = SVPD_BDC;
10228 scsi_ulto2b(sizeof(*bdc_ptr) - 4, bdc_ptr->page_length);
10229 scsi_ulto2b(SVPD_NON_ROTATING, bdc_ptr->medium_rotation_rate);
10230 bdc_ptr->flags = SVPD_FUAB | SVPD_VBULS;
10232 ctsio->scsi_status = SCSI_STATUS_OK;
10233 ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
10234 ctsio->be_move_done = ctl_config_move_done;
10235 ctl_datamove((union ctl_io *)ctsio);
10237 return (CTL_RETVAL_COMPLETE);
10241 ctl_inquiry_evpd_lbp(struct ctl_scsiio *ctsio, int alloc_len)
10243 struct scsi_vpd_logical_block_prov *lbp_ptr;
10244 struct ctl_lun *lun;
10246 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
10248 ctsio->kern_data_ptr = malloc(sizeof(*lbp_ptr), M_CTL, M_WAITOK | M_ZERO);
10249 lbp_ptr = (struct scsi_vpd_logical_block_prov *)ctsio->kern_data_ptr;
10250 ctsio->kern_sg_entries = 0;
10252 if (sizeof(*lbp_ptr) < alloc_len) {
10253 ctsio->residual = alloc_len - sizeof(*lbp_ptr);
10254 ctsio->kern_data_len = sizeof(*lbp_ptr);
10255 ctsio->kern_total_len = sizeof(*lbp_ptr);
10257 ctsio->residual = 0;
10258 ctsio->kern_data_len = alloc_len;
10259 ctsio->kern_total_len = alloc_len;
10261 ctsio->kern_data_resid = 0;
10262 ctsio->kern_rel_offset = 0;
10263 ctsio->kern_sg_entries = 0;
10266 * The control device is always connected. The disk device, on the
10267 * other hand, may not be online all the time. Need to change this
10268 * to figure out whether the disk device is actually online or not.
10271 lbp_ptr->device = (SID_QUAL_LU_CONNECTED << 5) |
10272 lun->be_lun->lun_type;
10274 lbp_ptr->device = (SID_QUAL_LU_OFFLINE << 5) | T_DIRECT;
10276 lbp_ptr->page_code = SVPD_LBP;
10277 scsi_ulto2b(sizeof(*lbp_ptr) - 4, lbp_ptr->page_length);
10278 if (lun != NULL && lun->be_lun->flags & CTL_LUN_FLAG_UNMAP) {
10279 lbp_ptr->flags = SVPD_LBP_UNMAP | SVPD_LBP_WS16 |
10280 SVPD_LBP_WS10 | SVPD_LBP_RZ | SVPD_LBP_ANC_SUP;
10281 lbp_ptr->prov_type = SVPD_LBP_RESOURCE;
10284 ctsio->scsi_status = SCSI_STATUS_OK;
10285 ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
10286 ctsio->be_move_done = ctl_config_move_done;
10287 ctl_datamove((union ctl_io *)ctsio);
10289 return (CTL_RETVAL_COMPLETE);
10293 ctl_inquiry_evpd(struct ctl_scsiio *ctsio)
10295 struct scsi_inquiry *cdb;
10296 struct ctl_lun *lun;
10297 int alloc_len, retval;
10299 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
10300 cdb = (struct scsi_inquiry *)ctsio->cdb;
10302 retval = CTL_RETVAL_COMPLETE;
10304 alloc_len = scsi_2btoul(cdb->length);
10306 switch (cdb->page_code) {
10307 case SVPD_SUPPORTED_PAGES:
10308 retval = ctl_inquiry_evpd_supported(ctsio, alloc_len);
10310 case SVPD_UNIT_SERIAL_NUMBER:
10311 retval = ctl_inquiry_evpd_serial(ctsio, alloc_len);
10313 case SVPD_DEVICE_ID:
10314 retval = ctl_inquiry_evpd_devid(ctsio, alloc_len);
10316 case SVPD_SCSI_PORTS:
10317 retval = ctl_inquiry_evpd_scsi_ports(ctsio, alloc_len);
10319 case SVPD_SCSI_TPC:
10320 retval = ctl_inquiry_evpd_tpc(ctsio, alloc_len);
10322 case SVPD_BLOCK_LIMITS:
10323 retval = ctl_inquiry_evpd_block_limits(ctsio, alloc_len);
10326 retval = ctl_inquiry_evpd_bdc(ctsio, alloc_len);
10329 retval = ctl_inquiry_evpd_lbp(ctsio, alloc_len);
10332 ctl_set_invalid_field(ctsio,
10338 ctl_done((union ctl_io *)ctsio);
10339 retval = CTL_RETVAL_COMPLETE;
10347 ctl_inquiry_std(struct ctl_scsiio *ctsio)
10349 struct scsi_inquiry_data *inq_ptr;
10350 struct scsi_inquiry *cdb;
10351 struct ctl_softc *ctl_softc;
10352 struct ctl_lun *lun;
10354 uint32_t alloc_len;
10355 ctl_port_type port_type;
10357 ctl_softc = control_softc;
10360 * Figure out whether we're talking to a Fibre Channel port or not.
10361 * We treat the ioctl front end, and any SCSI adapters, as packetized
10364 port_type = ctl_softc->ctl_ports[
10365 ctl_port_idx(ctsio->io_hdr.nexus.targ_port)]->port_type;
10366 if (port_type == CTL_PORT_IOCTL || port_type == CTL_PORT_INTERNAL)
10367 port_type = CTL_PORT_SCSI;
10369 lun = ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
10370 cdb = (struct scsi_inquiry *)ctsio->cdb;
10371 alloc_len = scsi_2btoul(cdb->length);
10374 * We malloc the full inquiry data size here and fill it
10375 * in. If the user only asks for less, we'll give him
10378 ctsio->kern_data_ptr = malloc(sizeof(*inq_ptr), M_CTL, M_WAITOK | M_ZERO);
10379 inq_ptr = (struct scsi_inquiry_data *)ctsio->kern_data_ptr;
10380 ctsio->kern_sg_entries = 0;
10381 ctsio->kern_data_resid = 0;
10382 ctsio->kern_rel_offset = 0;
10384 if (sizeof(*inq_ptr) < alloc_len) {
10385 ctsio->residual = alloc_len - sizeof(*inq_ptr);
10386 ctsio->kern_data_len = sizeof(*inq_ptr);
10387 ctsio->kern_total_len = sizeof(*inq_ptr);
10389 ctsio->residual = 0;
10390 ctsio->kern_data_len = alloc_len;
10391 ctsio->kern_total_len = alloc_len;
10395 * If we have a LUN configured, report it as connected. Otherwise,
10396 * report that it is offline or no device is supported, depending
10397 * on the value of inquiry_pq_no_lun.
10399 * According to the spec (SPC-4 r34), the peripheral qualifier
10400 * SID_QUAL_LU_OFFLINE (001b) is used in the following scenario:
10402 * "A peripheral device having the specified peripheral device type
10403 * is not connected to this logical unit. However, the device
10404 * server is capable of supporting the specified peripheral device
10405 * type on this logical unit."
10407 * According to the same spec, the peripheral qualifier
10408 * SID_QUAL_BAD_LU (011b) is used in this scenario:
10410 * "The device server is not capable of supporting a peripheral
10411 * device on this logical unit. For this peripheral qualifier the
10412 * peripheral device type shall be set to 1Fh. All other peripheral
10413 * device type values are reserved for this peripheral qualifier."
10415 * Given the text, it would seem that we probably want to report that
10416 * the LUN is offline here. There is no LUN connected, but we can
10417 * support a LUN at the given LUN number.
10419 * In the real world, though, it sounds like things are a little
10422 * - Linux, when presented with a LUN with the offline peripheral
10423 * qualifier, will create an sg driver instance for it. So when
10424 * you attach it to CTL, you wind up with a ton of sg driver
10425 * instances. (One for every LUN that Linux bothered to probe.)
10426 * Linux does this despite the fact that it issues a REPORT LUNs
10427 * to LUN 0 to get the inventory of supported LUNs.
10429 * - There is other anecdotal evidence (from Emulex folks) about
10430 * arrays that use the offline peripheral qualifier for LUNs that
10431 * are on the "passive" path in an active/passive array.
10433 * So the solution is provide a hopefully reasonable default
10434 * (return bad/no LUN) and allow the user to change the behavior
10435 * with a tunable/sysctl variable.
10438 inq_ptr->device = (SID_QUAL_LU_CONNECTED << 5) |
10439 lun->be_lun->lun_type;
10440 else if (ctl_softc->inquiry_pq_no_lun == 0)
10441 inq_ptr->device = (SID_QUAL_LU_OFFLINE << 5) | T_DIRECT;
10443 inq_ptr->device = (SID_QUAL_BAD_LU << 5) | T_NODEVICE;
10445 /* RMB in byte 2 is 0 */
10446 inq_ptr->version = SCSI_REV_SPC4;
10449 * According to SAM-3, even if a device only supports a single
10450 * level of LUN addressing, it should still set the HISUP bit:
10452 * 4.9.1 Logical unit numbers overview
10454 * All logical unit number formats described in this standard are
10455 * hierarchical in structure even when only a single level in that
10456 * hierarchy is used. The HISUP bit shall be set to one in the
10457 * standard INQUIRY data (see SPC-2) when any logical unit number
10458 * format described in this standard is used. Non-hierarchical
10459 * formats are outside the scope of this standard.
10461 * Therefore we set the HiSup bit here.
10463 * The reponse format is 2, per SPC-3.
10465 inq_ptr->response_format = SID_HiSup | 2;
10467 inq_ptr->additional_length = sizeof(*inq_ptr) - 4;
10468 CTL_DEBUG_PRINT(("additional_length = %d\n",
10469 inq_ptr->additional_length));
10471 inq_ptr->spc3_flags = SPC3_SID_3PC;
10472 if (!ctl_is_single)
10473 inq_ptr->spc3_flags |= SPC3_SID_TPGS_IMPLICIT;
10474 /* 16 bit addressing */
10475 if (port_type == CTL_PORT_SCSI)
10476 inq_ptr->spc2_flags = SPC2_SID_ADDR16;
10477 /* XXX set the SID_MultiP bit here if we're actually going to
10478 respond on multiple ports */
10479 inq_ptr->spc2_flags |= SPC2_SID_MultiP;
10481 /* 16 bit data bus, synchronous transfers */
10482 if (port_type == CTL_PORT_SCSI)
10483 inq_ptr->flags = SID_WBus16 | SID_Sync;
10485 * XXX KDM do we want to support tagged queueing on the control
10489 || (lun->be_lun->lun_type != T_PROCESSOR))
10490 inq_ptr->flags |= SID_CmdQue;
10492 * Per SPC-3, unused bytes in ASCII strings are filled with spaces.
10493 * We have 8 bytes for the vendor name, and 16 bytes for the device
10494 * name and 4 bytes for the revision.
10496 if (lun == NULL || (val = ctl_get_opt(&lun->be_lun->options,
10497 "vendor")) == NULL) {
10498 strcpy(inq_ptr->vendor, CTL_VENDOR);
10500 memset(inq_ptr->vendor, ' ', sizeof(inq_ptr->vendor));
10501 strncpy(inq_ptr->vendor, val,
10502 min(sizeof(inq_ptr->vendor), strlen(val)));
10505 strcpy(inq_ptr->product, CTL_DIRECT_PRODUCT);
10506 } else if ((val = ctl_get_opt(&lun->be_lun->options, "product")) == NULL) {
10507 switch (lun->be_lun->lun_type) {
10509 strcpy(inq_ptr->product, CTL_DIRECT_PRODUCT);
10512 strcpy(inq_ptr->product, CTL_PROCESSOR_PRODUCT);
10515 strcpy(inq_ptr->product, CTL_UNKNOWN_PRODUCT);
10519 memset(inq_ptr->product, ' ', sizeof(inq_ptr->product));
10520 strncpy(inq_ptr->product, val,
10521 min(sizeof(inq_ptr->product), strlen(val)));
10525 * XXX make this a macro somewhere so it automatically gets
10526 * incremented when we make changes.
10528 if (lun == NULL || (val = ctl_get_opt(&lun->be_lun->options,
10529 "revision")) == NULL) {
10530 strncpy(inq_ptr->revision, "0001", sizeof(inq_ptr->revision));
10532 memset(inq_ptr->revision, ' ', sizeof(inq_ptr->revision));
10533 strncpy(inq_ptr->revision, val,
10534 min(sizeof(inq_ptr->revision), strlen(val)));
10538 * For parallel SCSI, we support double transition and single
10539 * transition clocking. We also support QAS (Quick Arbitration
10540 * and Selection) and Information Unit transfers on both the
10541 * control and array devices.
10543 if (port_type == CTL_PORT_SCSI)
10544 inq_ptr->spi3data = SID_SPI_CLOCK_DT_ST | SID_SPI_QAS |
10547 /* SAM-5 (no version claimed) */
10548 scsi_ulto2b(0x00A0, inq_ptr->version1);
10549 /* SPC-4 (no version claimed) */
10550 scsi_ulto2b(0x0460, inq_ptr->version2);
10551 if (port_type == CTL_PORT_FC) {
10552 /* FCP-2 ANSI INCITS.350:2003 */
10553 scsi_ulto2b(0x0917, inq_ptr->version3);
10554 } else if (port_type == CTL_PORT_SCSI) {
10555 /* SPI-4 ANSI INCITS.362:200x */
10556 scsi_ulto2b(0x0B56, inq_ptr->version3);
10557 } else if (port_type == CTL_PORT_ISCSI) {
10558 /* iSCSI (no version claimed) */
10559 scsi_ulto2b(0x0960, inq_ptr->version3);
10560 } else if (port_type == CTL_PORT_SAS) {
10561 /* SAS (no version claimed) */
10562 scsi_ulto2b(0x0BE0, inq_ptr->version3);
10566 /* SBC-3 (no version claimed) */
10567 scsi_ulto2b(0x04C0, inq_ptr->version4);
10569 switch (lun->be_lun->lun_type) {
10571 /* SBC-3 (no version claimed) */
10572 scsi_ulto2b(0x04C0, inq_ptr->version4);
10580 ctsio->scsi_status = SCSI_STATUS_OK;
10581 if (ctsio->kern_data_len > 0) {
10582 ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
10583 ctsio->be_move_done = ctl_config_move_done;
10584 ctl_datamove((union ctl_io *)ctsio);
10586 ctsio->io_hdr.status = CTL_SUCCESS;
10587 ctl_done((union ctl_io *)ctsio);
10590 return (CTL_RETVAL_COMPLETE);
10594 ctl_inquiry(struct ctl_scsiio *ctsio)
10596 struct scsi_inquiry *cdb;
10599 cdb = (struct scsi_inquiry *)ctsio->cdb;
10603 CTL_DEBUG_PRINT(("ctl_inquiry\n"));
10606 * Right now, we don't support the CmdDt inquiry information.
10607 * This would be nice to support in the future. When we do
10608 * support it, we should change this test so that it checks to make
10609 * sure SI_EVPD and SI_CMDDT aren't both set at the same time.
10612 if (((cdb->byte2 & SI_EVPD)
10613 && (cdb->byte2 & SI_CMDDT)))
10615 if (cdb->byte2 & SI_CMDDT) {
10617 * Point to the SI_CMDDT bit. We might change this
10618 * when we support SI_CMDDT, but since both bits would be
10619 * "wrong", this should probably just stay as-is then.
10621 ctl_set_invalid_field(ctsio,
10627 ctl_done((union ctl_io *)ctsio);
10628 return (CTL_RETVAL_COMPLETE);
10630 if (cdb->byte2 & SI_EVPD)
10631 retval = ctl_inquiry_evpd(ctsio);
10633 else if (cdb->byte2 & SI_CMDDT)
10634 retval = ctl_inquiry_cmddt(ctsio);
10637 retval = ctl_inquiry_std(ctsio);
10643 * For known CDB types, parse the LBA and length.
10646 ctl_get_lba_len(union ctl_io *io, uint64_t *lba, uint32_t *len)
10648 if (io->io_hdr.io_type != CTL_IO_SCSI)
10651 switch (io->scsiio.cdb[0]) {
10652 case COMPARE_AND_WRITE: {
10653 struct scsi_compare_and_write *cdb;
10655 cdb = (struct scsi_compare_and_write *)io->scsiio.cdb;
10657 *lba = scsi_8btou64(cdb->addr);
10658 *len = cdb->length;
10663 struct scsi_rw_6 *cdb;
10665 cdb = (struct scsi_rw_6 *)io->scsiio.cdb;
10667 *lba = scsi_3btoul(cdb->addr);
10668 /* only 5 bits are valid in the most significant address byte */
10670 *len = cdb->length;
10675 struct scsi_rw_10 *cdb;
10677 cdb = (struct scsi_rw_10 *)io->scsiio.cdb;
10679 *lba = scsi_4btoul(cdb->addr);
10680 *len = scsi_2btoul(cdb->length);
10683 case WRITE_VERIFY_10: {
10684 struct scsi_write_verify_10 *cdb;
10686 cdb = (struct scsi_write_verify_10 *)io->scsiio.cdb;
10688 *lba = scsi_4btoul(cdb->addr);
10689 *len = scsi_2btoul(cdb->length);
10694 struct scsi_rw_12 *cdb;
10696 cdb = (struct scsi_rw_12 *)io->scsiio.cdb;
10698 *lba = scsi_4btoul(cdb->addr);
10699 *len = scsi_4btoul(cdb->length);
10702 case WRITE_VERIFY_12: {
10703 struct scsi_write_verify_12 *cdb;
10705 cdb = (struct scsi_write_verify_12 *)io->scsiio.cdb;
10707 *lba = scsi_4btoul(cdb->addr);
10708 *len = scsi_4btoul(cdb->length);
10713 struct scsi_rw_16 *cdb;
10715 cdb = (struct scsi_rw_16 *)io->scsiio.cdb;
10717 *lba = scsi_8btou64(cdb->addr);
10718 *len = scsi_4btoul(cdb->length);
10721 case WRITE_VERIFY_16: {
10722 struct scsi_write_verify_16 *cdb;
10724 cdb = (struct scsi_write_verify_16 *)io->scsiio.cdb;
10727 *lba = scsi_8btou64(cdb->addr);
10728 *len = scsi_4btoul(cdb->length);
10731 case WRITE_SAME_10: {
10732 struct scsi_write_same_10 *cdb;
10734 cdb = (struct scsi_write_same_10 *)io->scsiio.cdb;
10736 *lba = scsi_4btoul(cdb->addr);
10737 *len = scsi_2btoul(cdb->length);
10740 case WRITE_SAME_16: {
10741 struct scsi_write_same_16 *cdb;
10743 cdb = (struct scsi_write_same_16 *)io->scsiio.cdb;
10745 *lba = scsi_8btou64(cdb->addr);
10746 *len = scsi_4btoul(cdb->length);
10750 struct scsi_verify_10 *cdb;
10752 cdb = (struct scsi_verify_10 *)io->scsiio.cdb;
10754 *lba = scsi_4btoul(cdb->addr);
10755 *len = scsi_2btoul(cdb->length);
10759 struct scsi_verify_12 *cdb;
10761 cdb = (struct scsi_verify_12 *)io->scsiio.cdb;
10763 *lba = scsi_4btoul(cdb->addr);
10764 *len = scsi_4btoul(cdb->length);
10768 struct scsi_verify_16 *cdb;
10770 cdb = (struct scsi_verify_16 *)io->scsiio.cdb;
10772 *lba = scsi_8btou64(cdb->addr);
10773 *len = scsi_4btoul(cdb->length);
10778 break; /* NOTREACHED */
10785 ctl_extent_check_lba(uint64_t lba1, uint32_t len1, uint64_t lba2, uint32_t len2)
10787 uint64_t endlba1, endlba2;
10789 endlba1 = lba1 + len1 - 1;
10790 endlba2 = lba2 + len2 - 1;
10792 if ((endlba1 < lba2)
10793 || (endlba2 < lba1))
10794 return (CTL_ACTION_PASS);
10796 return (CTL_ACTION_BLOCK);
10800 ctl_extent_check(union ctl_io *io1, union ctl_io *io2)
10802 uint64_t lba1, lba2;
10803 uint32_t len1, len2;
10806 retval = ctl_get_lba_len(io1, &lba1, &len1);
10808 return (CTL_ACTION_ERROR);
10810 retval = ctl_get_lba_len(io2, &lba2, &len2);
10812 return (CTL_ACTION_ERROR);
10814 return (ctl_extent_check_lba(lba1, len1, lba2, len2));
10818 ctl_check_for_blockage(union ctl_io *pending_io, union ctl_io *ooa_io)
10820 const struct ctl_cmd_entry *pending_entry, *ooa_entry;
10821 ctl_serialize_action *serialize_row;
10824 * The initiator attempted multiple untagged commands at the same
10825 * time. Can't do that.
10827 if ((pending_io->scsiio.tag_type == CTL_TAG_UNTAGGED)
10828 && (ooa_io->scsiio.tag_type == CTL_TAG_UNTAGGED)
10829 && ((pending_io->io_hdr.nexus.targ_port ==
10830 ooa_io->io_hdr.nexus.targ_port)
10831 && (pending_io->io_hdr.nexus.initid.id ==
10832 ooa_io->io_hdr.nexus.initid.id))
10833 && ((ooa_io->io_hdr.flags & CTL_FLAG_ABORT) == 0))
10834 return (CTL_ACTION_OVERLAP);
10837 * The initiator attempted to send multiple tagged commands with
10838 * the same ID. (It's fine if different initiators have the same
10841 * Even if all of those conditions are true, we don't kill the I/O
10842 * if the command ahead of us has been aborted. We won't end up
10843 * sending it to the FETD, and it's perfectly legal to resend a
10844 * command with the same tag number as long as the previous
10845 * instance of this tag number has been aborted somehow.
10847 if ((pending_io->scsiio.tag_type != CTL_TAG_UNTAGGED)
10848 && (ooa_io->scsiio.tag_type != CTL_TAG_UNTAGGED)
10849 && (pending_io->scsiio.tag_num == ooa_io->scsiio.tag_num)
10850 && ((pending_io->io_hdr.nexus.targ_port ==
10851 ooa_io->io_hdr.nexus.targ_port)
10852 && (pending_io->io_hdr.nexus.initid.id ==
10853 ooa_io->io_hdr.nexus.initid.id))
10854 && ((ooa_io->io_hdr.flags & CTL_FLAG_ABORT) == 0))
10855 return (CTL_ACTION_OVERLAP_TAG);
10858 * If we get a head of queue tag, SAM-3 says that we should
10859 * immediately execute it.
10861 * What happens if this command would normally block for some other
10862 * reason? e.g. a request sense with a head of queue tag
10863 * immediately after a write. Normally that would block, but this
10864 * will result in its getting executed immediately...
10866 * We currently return "pass" instead of "skip", so we'll end up
10867 * going through the rest of the queue to check for overlapped tags.
10869 * XXX KDM check for other types of blockage first??
10871 if (pending_io->scsiio.tag_type == CTL_TAG_HEAD_OF_QUEUE)
10872 return (CTL_ACTION_PASS);
10875 * Ordered tags have to block until all items ahead of them
10876 * have completed. If we get called with an ordered tag, we always
10877 * block, if something else is ahead of us in the queue.
10879 if (pending_io->scsiio.tag_type == CTL_TAG_ORDERED)
10880 return (CTL_ACTION_BLOCK);
10883 * Simple tags get blocked until all head of queue and ordered tags
10884 * ahead of them have completed. I'm lumping untagged commands in
10885 * with simple tags here. XXX KDM is that the right thing to do?
10887 if (((pending_io->scsiio.tag_type == CTL_TAG_UNTAGGED)
10888 || (pending_io->scsiio.tag_type == CTL_TAG_SIMPLE))
10889 && ((ooa_io->scsiio.tag_type == CTL_TAG_HEAD_OF_QUEUE)
10890 || (ooa_io->scsiio.tag_type == CTL_TAG_ORDERED)))
10891 return (CTL_ACTION_BLOCK);
10893 pending_entry = ctl_get_cmd_entry(&pending_io->scsiio);
10894 ooa_entry = ctl_get_cmd_entry(&ooa_io->scsiio);
10896 serialize_row = ctl_serialize_table[ooa_entry->seridx];
10898 switch (serialize_row[pending_entry->seridx]) {
10899 case CTL_SER_BLOCK:
10900 return (CTL_ACTION_BLOCK);
10901 break; /* NOTREACHED */
10902 case CTL_SER_EXTENT:
10903 return (ctl_extent_check(pending_io, ooa_io));
10904 break; /* NOTREACHED */
10906 return (CTL_ACTION_PASS);
10907 break; /* NOTREACHED */
10909 return (CTL_ACTION_SKIP);
10912 panic("invalid serialization value %d",
10913 serialize_row[pending_entry->seridx]);
10914 break; /* NOTREACHED */
10917 return (CTL_ACTION_ERROR);
10921 * Check for blockage or overlaps against the OOA (Order Of Arrival) queue.
10923 * - pending_io is generally either incoming, or on the blocked queue
10924 * - starting I/O is the I/O we want to start the check with.
10927 ctl_check_ooa(struct ctl_lun *lun, union ctl_io *pending_io,
10928 union ctl_io *starting_io)
10930 union ctl_io *ooa_io;
10933 mtx_assert(&lun->lun_lock, MA_OWNED);
10936 * Run back along the OOA queue, starting with the current
10937 * blocked I/O and going through every I/O before it on the
10938 * queue. If starting_io is NULL, we'll just end up returning
10941 for (ooa_io = starting_io; ooa_io != NULL;
10942 ooa_io = (union ctl_io *)TAILQ_PREV(&ooa_io->io_hdr, ctl_ooaq,
10946 * This routine just checks to see whether
10947 * cur_blocked is blocked by ooa_io, which is ahead
10948 * of it in the queue. It doesn't queue/dequeue
10951 action = ctl_check_for_blockage(pending_io, ooa_io);
10953 case CTL_ACTION_BLOCK:
10954 case CTL_ACTION_OVERLAP:
10955 case CTL_ACTION_OVERLAP_TAG:
10956 case CTL_ACTION_SKIP:
10957 case CTL_ACTION_ERROR:
10959 break; /* NOTREACHED */
10960 case CTL_ACTION_PASS:
10963 panic("invalid action %d", action);
10964 break; /* NOTREACHED */
10968 return (CTL_ACTION_PASS);
10973 * - An I/O has just completed, and has been removed from the per-LUN OOA
10974 * queue, so some items on the blocked queue may now be unblocked.
10977 ctl_check_blocked(struct ctl_lun *lun)
10979 union ctl_io *cur_blocked, *next_blocked;
10981 mtx_assert(&lun->lun_lock, MA_OWNED);
10984 * Run forward from the head of the blocked queue, checking each
10985 * entry against the I/Os prior to it on the OOA queue to see if
10986 * there is still any blockage.
10988 * We cannot use the TAILQ_FOREACH() macro, because it can't deal
10989 * with our removing a variable on it while it is traversing the
10992 for (cur_blocked = (union ctl_io *)TAILQ_FIRST(&lun->blocked_queue);
10993 cur_blocked != NULL; cur_blocked = next_blocked) {
10994 union ctl_io *prev_ooa;
10997 next_blocked = (union ctl_io *)TAILQ_NEXT(&cur_blocked->io_hdr,
11000 prev_ooa = (union ctl_io *)TAILQ_PREV(&cur_blocked->io_hdr,
11001 ctl_ooaq, ooa_links);
11004 * If cur_blocked happens to be the first item in the OOA
11005 * queue now, prev_ooa will be NULL, and the action
11006 * returned will just be CTL_ACTION_PASS.
11008 action = ctl_check_ooa(lun, cur_blocked, prev_ooa);
11011 case CTL_ACTION_BLOCK:
11012 /* Nothing to do here, still blocked */
11014 case CTL_ACTION_OVERLAP:
11015 case CTL_ACTION_OVERLAP_TAG:
11017 * This shouldn't happen! In theory we've already
11018 * checked this command for overlap...
11021 case CTL_ACTION_PASS:
11022 case CTL_ACTION_SKIP: {
11023 struct ctl_softc *softc;
11024 const struct ctl_cmd_entry *entry;
11029 * The skip case shouldn't happen, this transaction
11030 * should have never made it onto the blocked queue.
11033 * This I/O is no longer blocked, we can remove it
11034 * from the blocked queue. Since this is a TAILQ
11035 * (doubly linked list), we can do O(1) removals
11036 * from any place on the list.
11038 TAILQ_REMOVE(&lun->blocked_queue, &cur_blocked->io_hdr,
11040 cur_blocked->io_hdr.flags &= ~CTL_FLAG_BLOCKED;
11042 if (cur_blocked->io_hdr.flags & CTL_FLAG_FROM_OTHER_SC){
11044 * Need to send IO back to original side to
11047 union ctl_ha_msg msg_info;
11049 msg_info.hdr.original_sc =
11050 cur_blocked->io_hdr.original_sc;
11051 msg_info.hdr.serializing_sc = cur_blocked;
11052 msg_info.hdr.msg_type = CTL_MSG_R2R;
11053 if ((isc_retval=ctl_ha_msg_send(CTL_HA_CHAN_CTL,
11054 &msg_info, sizeof(msg_info), 0)) >
11055 CTL_HA_STATUS_SUCCESS) {
11056 printf("CTL:Check Blocked error from "
11057 "ctl_ha_msg_send %d\n",
11062 entry = ctl_get_cmd_entry(&cur_blocked->scsiio);
11063 softc = control_softc;
11065 initidx = ctl_get_initindex(&cur_blocked->io_hdr.nexus);
11068 * Check this I/O for LUN state changes that may
11069 * have happened while this command was blocked.
11070 * The LUN state may have been changed by a command
11071 * ahead of us in the queue, so we need to re-check
11072 * for any states that can be caused by SCSI
11075 if (ctl_scsiio_lun_check(softc, lun, entry,
11076 &cur_blocked->scsiio) == 0) {
11077 cur_blocked->io_hdr.flags |=
11078 CTL_FLAG_IS_WAS_ON_RTR;
11079 ctl_enqueue_rtr(cur_blocked);
11081 ctl_done(cur_blocked);
11086 * This probably shouldn't happen -- we shouldn't
11087 * get CTL_ACTION_ERROR, or anything else.
11093 return (CTL_RETVAL_COMPLETE);
11097 * This routine (with one exception) checks LUN flags that can be set by
11098 * commands ahead of us in the OOA queue. These flags have to be checked
11099 * when a command initially comes in, and when we pull a command off the
11100 * blocked queue and are preparing to execute it. The reason we have to
11101 * check these flags for commands on the blocked queue is that the LUN
11102 * state may have been changed by a command ahead of us while we're on the
11105 * Ordering is somewhat important with these checks, so please pay
11106 * careful attention to the placement of any new checks.
11109 ctl_scsiio_lun_check(struct ctl_softc *ctl_softc, struct ctl_lun *lun,
11110 const struct ctl_cmd_entry *entry, struct ctl_scsiio *ctsio)
11116 mtx_assert(&lun->lun_lock, MA_OWNED);
11119 * If this shelf is a secondary shelf controller, we have to reject
11120 * any media access commands.
11123 /* No longer needed for HA */
11124 if (((ctl_softc->flags & CTL_FLAG_MASTER_SHELF) == 0)
11125 && ((entry->flags & CTL_CMD_FLAG_OK_ON_SECONDARY) == 0)) {
11126 ctl_set_lun_standby(ctsio);
11133 * Check for a reservation conflict. If this command isn't allowed
11134 * even on reserved LUNs, and if this initiator isn't the one who
11135 * reserved us, reject the command with a reservation conflict.
11137 if ((lun->flags & CTL_LUN_RESERVED)
11138 && ((entry->flags & CTL_CMD_FLAG_ALLOW_ON_RESV) == 0)) {
11139 if ((ctsio->io_hdr.nexus.initid.id != lun->rsv_nexus.initid.id)
11140 || (ctsio->io_hdr.nexus.targ_port != lun->rsv_nexus.targ_port)
11141 || (ctsio->io_hdr.nexus.targ_target.id !=
11142 lun->rsv_nexus.targ_target.id)) {
11143 ctsio->scsi_status = SCSI_STATUS_RESERV_CONFLICT;
11144 ctsio->io_hdr.status = CTL_SCSI_ERROR;
11150 if ( (lun->flags & CTL_LUN_PR_RESERVED)
11151 && ((entry->flags & CTL_CMD_FLAG_ALLOW_ON_PR_RESV) == 0)) {
11154 residx = ctl_get_resindex(&ctsio->io_hdr.nexus);
11156 * if we aren't registered or it's a res holder type
11157 * reservation and this isn't the res holder then set a
11159 * NOTE: Commands which might be allowed on write exclusive
11160 * type reservations are checked in the particular command
11161 * for a conflict. Read and SSU are the only ones.
11163 if (!lun->per_res[residx].registered
11164 || (residx != lun->pr_res_idx && lun->res_type < 4)) {
11165 ctsio->scsi_status = SCSI_STATUS_RESERV_CONFLICT;
11166 ctsio->io_hdr.status = CTL_SCSI_ERROR;
11173 if ((lun->flags & CTL_LUN_OFFLINE)
11174 && ((entry->flags & CTL_CMD_FLAG_OK_ON_OFFLINE) == 0)) {
11175 ctl_set_lun_not_ready(ctsio);
11181 * If the LUN is stopped, see if this particular command is allowed
11182 * for a stopped lun. Otherwise, reject it with 0x04,0x02.
11184 if ((lun->flags & CTL_LUN_STOPPED)
11185 && ((entry->flags & CTL_CMD_FLAG_OK_ON_STOPPED) == 0)) {
11186 /* "Logical unit not ready, initializing cmd. required" */
11187 ctl_set_lun_stopped(ctsio);
11192 if ((lun->flags & CTL_LUN_INOPERABLE)
11193 && ((entry->flags & CTL_CMD_FLAG_OK_ON_INOPERABLE) == 0)) {
11194 /* "Medium format corrupted" */
11195 ctl_set_medium_format_corrupted(ctsio);
11206 ctl_failover_io(union ctl_io *io, int have_lock)
11208 ctl_set_busy(&io->scsiio);
11215 struct ctl_lun *lun;
11216 struct ctl_softc *ctl_softc;
11217 union ctl_io *next_io, *pending_io;
11222 ctl_softc = control_softc;
11224 mtx_lock(&ctl_softc->ctl_lock);
11226 * Remove any cmds from the other SC from the rtr queue. These
11227 * will obviously only be for LUNs for which we're the primary.
11228 * We can't send status or get/send data for these commands.
11229 * Since they haven't been executed yet, we can just remove them.
11230 * We'll either abort them or delete them below, depending on
11231 * which HA mode we're in.
11234 mtx_lock(&ctl_softc->queue_lock);
11235 for (io = (union ctl_io *)STAILQ_FIRST(&ctl_softc->rtr_queue);
11236 io != NULL; io = next_io) {
11237 next_io = (union ctl_io *)STAILQ_NEXT(&io->io_hdr, links);
11238 if (io->io_hdr.flags & CTL_FLAG_FROM_OTHER_SC)
11239 STAILQ_REMOVE(&ctl_softc->rtr_queue, &io->io_hdr,
11240 ctl_io_hdr, links);
11242 mtx_unlock(&ctl_softc->queue_lock);
11245 for (lun_idx=0; lun_idx < ctl_softc->num_luns; lun_idx++) {
11246 lun = ctl_softc->ctl_luns[lun_idx];
11251 * Processor LUNs are primary on both sides.
11252 * XXX will this always be true?
11254 if (lun->be_lun->lun_type == T_PROCESSOR)
11257 if ((lun->flags & CTL_LUN_PRIMARY_SC)
11258 && (ctl_softc->ha_mode == CTL_HA_MODE_SER_ONLY)) {
11259 printf("FAILOVER: primary lun %d\n", lun_idx);
11261 * Remove all commands from the other SC. First from the
11262 * blocked queue then from the ooa queue. Once we have
11263 * removed them. Call ctl_check_blocked to see if there
11264 * is anything that can run.
11266 for (io = (union ctl_io *)TAILQ_FIRST(
11267 &lun->blocked_queue); io != NULL; io = next_io) {
11269 next_io = (union ctl_io *)TAILQ_NEXT(
11270 &io->io_hdr, blocked_links);
11272 if (io->io_hdr.flags & CTL_FLAG_FROM_OTHER_SC) {
11273 TAILQ_REMOVE(&lun->blocked_queue,
11274 &io->io_hdr,blocked_links);
11275 io->io_hdr.flags &= ~CTL_FLAG_BLOCKED;
11276 TAILQ_REMOVE(&lun->ooa_queue,
11277 &io->io_hdr, ooa_links);
11283 for (io = (union ctl_io *)TAILQ_FIRST(&lun->ooa_queue);
11284 io != NULL; io = next_io) {
11286 next_io = (union ctl_io *)TAILQ_NEXT(
11287 &io->io_hdr, ooa_links);
11289 if (io->io_hdr.flags & CTL_FLAG_FROM_OTHER_SC) {
11291 TAILQ_REMOVE(&lun->ooa_queue,
11298 ctl_check_blocked(lun);
11299 } else if ((lun->flags & CTL_LUN_PRIMARY_SC)
11300 && (ctl_softc->ha_mode == CTL_HA_MODE_XFER)) {
11302 printf("FAILOVER: primary lun %d\n", lun_idx);
11304 * Abort all commands from the other SC. We can't
11305 * send status back for them now. These should get
11306 * cleaned up when they are completed or come out
11307 * for a datamove operation.
11309 for (io = (union ctl_io *)TAILQ_FIRST(&lun->ooa_queue);
11310 io != NULL; io = next_io) {
11311 next_io = (union ctl_io *)TAILQ_NEXT(
11312 &io->io_hdr, ooa_links);
11314 if (io->io_hdr.flags & CTL_FLAG_FROM_OTHER_SC)
11315 io->io_hdr.flags |= CTL_FLAG_ABORT;
11317 } else if (((lun->flags & CTL_LUN_PRIMARY_SC) == 0)
11318 && (ctl_softc->ha_mode == CTL_HA_MODE_XFER)) {
11320 printf("FAILOVER: secondary lun %d\n", lun_idx);
11322 lun->flags |= CTL_LUN_PRIMARY_SC;
11325 * We send all I/O that was sent to this controller
11326 * and redirected to the other side back with
11327 * busy status, and have the initiator retry it.
11328 * Figuring out how much data has been transferred,
11329 * etc. and picking up where we left off would be
11332 * XXX KDM need to remove I/O from the blocked
11335 for (pending_io = (union ctl_io *)TAILQ_FIRST(
11336 &lun->ooa_queue); pending_io != NULL;
11337 pending_io = next_io) {
11339 next_io = (union ctl_io *)TAILQ_NEXT(
11340 &pending_io->io_hdr, ooa_links);
11342 pending_io->io_hdr.flags &=
11343 ~CTL_FLAG_SENT_2OTHER_SC;
11345 if (pending_io->io_hdr.flags &
11346 CTL_FLAG_IO_ACTIVE) {
11347 pending_io->io_hdr.flags |=
11350 ctl_set_busy(&pending_io->scsiio);
11351 ctl_done(pending_io);
11356 * Build Unit Attention
11358 for (i = 0; i < CTL_MAX_INITIATORS; i++) {
11359 lun->pending_ua[i] |=
11360 CTL_UA_ASYM_ACC_CHANGE;
11362 } else if (((lun->flags & CTL_LUN_PRIMARY_SC) == 0)
11363 && (ctl_softc->ha_mode == CTL_HA_MODE_SER_ONLY)) {
11364 printf("FAILOVER: secondary lun %d\n", lun_idx);
11366 * if the first io on the OOA is not on the RtR queue
11369 lun->flags |= CTL_LUN_PRIMARY_SC;
11371 pending_io = (union ctl_io *)TAILQ_FIRST(
11373 if (pending_io==NULL) {
11374 printf("Nothing on OOA queue\n");
11378 pending_io->io_hdr.flags &= ~CTL_FLAG_SENT_2OTHER_SC;
11379 if ((pending_io->io_hdr.flags &
11380 CTL_FLAG_IS_WAS_ON_RTR) == 0) {
11381 pending_io->io_hdr.flags |=
11382 CTL_FLAG_IS_WAS_ON_RTR;
11383 ctl_enqueue_rtr(pending_io);
11388 printf("Tag 0x%04x is running\n",
11389 pending_io->scsiio.tag_num);
11393 next_io = (union ctl_io *)TAILQ_NEXT(
11394 &pending_io->io_hdr, ooa_links);
11395 for (pending_io=next_io; pending_io != NULL;
11396 pending_io = next_io) {
11397 pending_io->io_hdr.flags &=
11398 ~CTL_FLAG_SENT_2OTHER_SC;
11399 next_io = (union ctl_io *)TAILQ_NEXT(
11400 &pending_io->io_hdr, ooa_links);
11401 if (pending_io->io_hdr.flags &
11402 CTL_FLAG_IS_WAS_ON_RTR) {
11404 printf("Tag 0x%04x is running\n",
11405 pending_io->scsiio.tag_num);
11410 switch (ctl_check_ooa(lun, pending_io,
11411 (union ctl_io *)TAILQ_PREV(
11412 &pending_io->io_hdr, ctl_ooaq,
11415 case CTL_ACTION_BLOCK:
11416 TAILQ_INSERT_TAIL(&lun->blocked_queue,
11417 &pending_io->io_hdr,
11419 pending_io->io_hdr.flags |=
11422 case CTL_ACTION_PASS:
11423 case CTL_ACTION_SKIP:
11424 pending_io->io_hdr.flags |=
11425 CTL_FLAG_IS_WAS_ON_RTR;
11426 ctl_enqueue_rtr(pending_io);
11428 case CTL_ACTION_OVERLAP:
11429 ctl_set_overlapped_cmd(
11430 (struct ctl_scsiio *)pending_io);
11431 ctl_done(pending_io);
11433 case CTL_ACTION_OVERLAP_TAG:
11434 ctl_set_overlapped_tag(
11435 (struct ctl_scsiio *)pending_io,
11436 pending_io->scsiio.tag_num & 0xff);
11437 ctl_done(pending_io);
11439 case CTL_ACTION_ERROR:
11441 ctl_set_internal_failure(
11442 (struct ctl_scsiio *)pending_io,
11445 ctl_done(pending_io);
11451 * Build Unit Attention
11453 for (i = 0; i < CTL_MAX_INITIATORS; i++) {
11454 lun->pending_ua[i] |=
11455 CTL_UA_ASYM_ACC_CHANGE;
11458 panic("Unhandled HA mode failover, LUN flags = %#x, "
11459 "ha_mode = #%x", lun->flags, ctl_softc->ha_mode);
11463 mtx_unlock(&ctl_softc->ctl_lock);
11467 ctl_scsiio_precheck(struct ctl_softc *ctl_softc, struct ctl_scsiio *ctsio)
11469 struct ctl_lun *lun;
11470 const struct ctl_cmd_entry *entry;
11471 uint32_t initidx, targ_lun;
11478 targ_lun = ctsio->io_hdr.nexus.targ_mapped_lun;
11479 if ((targ_lun < CTL_MAX_LUNS)
11480 && (ctl_softc->ctl_luns[targ_lun] != NULL)) {
11481 lun = ctl_softc->ctl_luns[targ_lun];
11483 * If the LUN is invalid, pretend that it doesn't exist.
11484 * It will go away as soon as all pending I/O has been
11487 if (lun->flags & CTL_LUN_DISABLED) {
11490 ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr = lun;
11491 ctsio->io_hdr.ctl_private[CTL_PRIV_BACKEND_LUN].ptr =
11493 if (lun->be_lun->lun_type == T_PROCESSOR) {
11494 ctsio->io_hdr.flags |= CTL_FLAG_CONTROL_DEV;
11498 * Every I/O goes into the OOA queue for a
11499 * particular LUN, and stays there until completion.
11501 mtx_lock(&lun->lun_lock);
11502 TAILQ_INSERT_TAIL(&lun->ooa_queue, &ctsio->io_hdr,
11506 ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr = NULL;
11507 ctsio->io_hdr.ctl_private[CTL_PRIV_BACKEND_LUN].ptr = NULL;
11510 /* Get command entry and return error if it is unsuppotyed. */
11511 entry = ctl_validate_command(ctsio);
11512 if (entry == NULL) {
11514 mtx_unlock(&lun->lun_lock);
11518 ctsio->io_hdr.flags &= ~CTL_FLAG_DATA_MASK;
11519 ctsio->io_hdr.flags |= entry->flags & CTL_FLAG_DATA_MASK;
11522 * Check to see whether we can send this command to LUNs that don't
11523 * exist. This should pretty much only be the case for inquiry
11524 * and request sense. Further checks, below, really require having
11525 * a LUN, so we can't really check the command anymore. Just put
11526 * it on the rtr queue.
11529 if (entry->flags & CTL_CMD_FLAG_OK_ON_ALL_LUNS) {
11530 ctsio->io_hdr.flags |= CTL_FLAG_IS_WAS_ON_RTR;
11531 ctl_enqueue_rtr((union ctl_io *)ctsio);
11535 ctl_set_unsupported_lun(ctsio);
11536 ctl_done((union ctl_io *)ctsio);
11537 CTL_DEBUG_PRINT(("ctl_scsiio_precheck: bailing out due to invalid LUN\n"));
11541 * Make sure we support this particular command on this LUN.
11542 * e.g., we don't support writes to the control LUN.
11544 if (!ctl_cmd_applicable(lun->be_lun->lun_type, entry)) {
11545 mtx_unlock(&lun->lun_lock);
11546 ctl_set_invalid_opcode(ctsio);
11547 ctl_done((union ctl_io *)ctsio);
11552 initidx = ctl_get_initindex(&ctsio->io_hdr.nexus);
11556 * If we've got a request sense, it'll clear the contingent
11557 * allegiance condition. Otherwise, if we have a CA condition for
11558 * this initiator, clear it, because it sent down a command other
11559 * than request sense.
11561 if ((ctsio->cdb[0] != REQUEST_SENSE)
11562 && (ctl_is_set(lun->have_ca, initidx)))
11563 ctl_clear_mask(lun->have_ca, initidx);
11567 * If the command has this flag set, it handles its own unit
11568 * attention reporting, we shouldn't do anything. Otherwise we
11569 * check for any pending unit attentions, and send them back to the
11570 * initiator. We only do this when a command initially comes in,
11571 * not when we pull it off the blocked queue.
11573 * According to SAM-3, section 5.3.2, the order that things get
11574 * presented back to the host is basically unit attentions caused
11575 * by some sort of reset event, busy status, reservation conflicts
11576 * or task set full, and finally any other status.
11578 * One issue here is that some of the unit attentions we report
11579 * don't fall into the "reset" category (e.g. "reported luns data
11580 * has changed"). So reporting it here, before the reservation
11581 * check, may be technically wrong. I guess the only thing to do
11582 * would be to check for and report the reset events here, and then
11583 * check for the other unit attention types after we check for a
11584 * reservation conflict.
11586 * XXX KDM need to fix this
11588 if ((entry->flags & CTL_CMD_FLAG_NO_SENSE) == 0) {
11589 ctl_ua_type ua_type;
11591 ua_type = lun->pending_ua[initidx];
11592 if (ua_type != CTL_UA_NONE) {
11593 scsi_sense_data_type sense_format;
11596 sense_format = (lun->flags &
11597 CTL_LUN_SENSE_DESC) ? SSD_TYPE_DESC :
11600 sense_format = SSD_TYPE_FIXED;
11602 ua_type = ctl_build_ua(ua_type, &ctsio->sense_data,
11604 if (ua_type != CTL_UA_NONE) {
11605 ctsio->scsi_status = SCSI_STATUS_CHECK_COND;
11606 ctsio->io_hdr.status = CTL_SCSI_ERROR |
11608 ctsio->sense_len = SSD_FULL_SIZE;
11609 lun->pending_ua[initidx] &= ~ua_type;
11610 mtx_unlock(&lun->lun_lock);
11611 ctl_done((union ctl_io *)ctsio);
11618 if (ctl_scsiio_lun_check(ctl_softc, lun, entry, ctsio) != 0) {
11619 mtx_unlock(&lun->lun_lock);
11620 ctl_done((union ctl_io *)ctsio);
11625 * XXX CHD this is where we want to send IO to other side if
11626 * this LUN is secondary on this SC. We will need to make a copy
11627 * of the IO and flag the IO on this side as SENT_2OTHER and the flag
11628 * the copy we send as FROM_OTHER.
11629 * We also need to stuff the address of the original IO so we can
11630 * find it easily. Something similar will need be done on the other
11631 * side so when we are done we can find the copy.
11633 if ((lun->flags & CTL_LUN_PRIMARY_SC) == 0) {
11634 union ctl_ha_msg msg_info;
11637 ctsio->io_hdr.flags |= CTL_FLAG_SENT_2OTHER_SC;
11639 msg_info.hdr.msg_type = CTL_MSG_SERIALIZE;
11640 msg_info.hdr.original_sc = (union ctl_io *)ctsio;
11642 printf("1. ctsio %p\n", ctsio);
11644 msg_info.hdr.serializing_sc = NULL;
11645 msg_info.hdr.nexus = ctsio->io_hdr.nexus;
11646 msg_info.scsi.tag_num = ctsio->tag_num;
11647 msg_info.scsi.tag_type = ctsio->tag_type;
11648 memcpy(msg_info.scsi.cdb, ctsio->cdb, CTL_MAX_CDBLEN);
11650 ctsio->io_hdr.flags &= ~CTL_FLAG_IO_ACTIVE;
11652 if ((isc_retval=ctl_ha_msg_send(CTL_HA_CHAN_CTL,
11653 (void *)&msg_info, sizeof(msg_info), 0)) >
11654 CTL_HA_STATUS_SUCCESS) {
11655 printf("CTL:precheck, ctl_ha_msg_send returned %d\n",
11657 printf("CTL:opcode is %x\n", ctsio->cdb[0]);
11660 printf("CTL:Precheck sent msg, opcode is %x\n",opcode);
11665 * XXX KDM this I/O is off the incoming queue, but hasn't
11666 * been inserted on any other queue. We may need to come
11667 * up with a holding queue while we wait for serialization
11668 * so that we have an idea of what we're waiting for from
11671 mtx_unlock(&lun->lun_lock);
11675 switch (ctl_check_ooa(lun, (union ctl_io *)ctsio,
11676 (union ctl_io *)TAILQ_PREV(&ctsio->io_hdr,
11677 ctl_ooaq, ooa_links))) {
11678 case CTL_ACTION_BLOCK:
11679 ctsio->io_hdr.flags |= CTL_FLAG_BLOCKED;
11680 TAILQ_INSERT_TAIL(&lun->blocked_queue, &ctsio->io_hdr,
11682 mtx_unlock(&lun->lun_lock);
11684 case CTL_ACTION_PASS:
11685 case CTL_ACTION_SKIP:
11686 ctsio->io_hdr.flags |= CTL_FLAG_IS_WAS_ON_RTR;
11687 mtx_unlock(&lun->lun_lock);
11688 ctl_enqueue_rtr((union ctl_io *)ctsio);
11690 case CTL_ACTION_OVERLAP:
11691 mtx_unlock(&lun->lun_lock);
11692 ctl_set_overlapped_cmd(ctsio);
11693 ctl_done((union ctl_io *)ctsio);
11695 case CTL_ACTION_OVERLAP_TAG:
11696 mtx_unlock(&lun->lun_lock);
11697 ctl_set_overlapped_tag(ctsio, ctsio->tag_num & 0xff);
11698 ctl_done((union ctl_io *)ctsio);
11700 case CTL_ACTION_ERROR:
11702 mtx_unlock(&lun->lun_lock);
11703 ctl_set_internal_failure(ctsio,
11705 /*retry_count*/ 0);
11706 ctl_done((union ctl_io *)ctsio);
11712 const struct ctl_cmd_entry *
11713 ctl_get_cmd_entry(struct ctl_scsiio *ctsio)
11715 const struct ctl_cmd_entry *entry;
11716 int service_action;
11718 entry = &ctl_cmd_table[ctsio->cdb[0]];
11719 if (entry->flags & CTL_CMD_FLAG_SA5) {
11720 service_action = ctsio->cdb[1] & SERVICE_ACTION_MASK;
11721 entry = &((const struct ctl_cmd_entry *)
11722 entry->execute)[service_action];
11727 const struct ctl_cmd_entry *
11728 ctl_validate_command(struct ctl_scsiio *ctsio)
11730 const struct ctl_cmd_entry *entry;
11734 entry = ctl_get_cmd_entry(ctsio);
11735 if (entry->execute == NULL) {
11736 ctl_set_invalid_opcode(ctsio);
11737 ctl_done((union ctl_io *)ctsio);
11740 KASSERT(entry->length > 0,
11741 ("Not defined length for command 0x%02x/0x%02x",
11742 ctsio->cdb[0], ctsio->cdb[1]));
11743 for (i = 1; i < entry->length; i++) {
11744 diff = ctsio->cdb[i] & ~entry->usage[i - 1];
11747 ctl_set_invalid_field(ctsio,
11752 /*bit*/ fls(diff) - 1);
11753 ctl_done((union ctl_io *)ctsio);
11760 ctl_cmd_applicable(uint8_t lun_type, const struct ctl_cmd_entry *entry)
11763 switch (lun_type) {
11765 if (((entry->flags & CTL_CMD_FLAG_OK_ON_PROC) == 0) &&
11766 ((entry->flags & CTL_CMD_FLAG_OK_ON_ALL_LUNS) == 0))
11770 if (((entry->flags & CTL_CMD_FLAG_OK_ON_SLUN) == 0) &&
11771 ((entry->flags & CTL_CMD_FLAG_OK_ON_ALL_LUNS) == 0))
11781 ctl_scsiio(struct ctl_scsiio *ctsio)
11784 const struct ctl_cmd_entry *entry;
11786 retval = CTL_RETVAL_COMPLETE;
11788 CTL_DEBUG_PRINT(("ctl_scsiio cdb[0]=%02X\n", ctsio->cdb[0]));
11790 entry = ctl_get_cmd_entry(ctsio);
11793 * If this I/O has been aborted, just send it straight to
11794 * ctl_done() without executing it.
11796 if (ctsio->io_hdr.flags & CTL_FLAG_ABORT) {
11797 ctl_done((union ctl_io *)ctsio);
11802 * All the checks should have been handled by ctl_scsiio_precheck().
11803 * We should be clear now to just execute the I/O.
11805 retval = entry->execute(ctsio);
11812 * Since we only implement one target right now, a bus reset simply resets
11813 * our single target.
11816 ctl_bus_reset(struct ctl_softc *ctl_softc, union ctl_io *io)
11818 return(ctl_target_reset(ctl_softc, io, CTL_UA_BUS_RESET));
11822 ctl_target_reset(struct ctl_softc *ctl_softc, union ctl_io *io,
11823 ctl_ua_type ua_type)
11825 struct ctl_lun *lun;
11828 if (!(io->io_hdr.flags & CTL_FLAG_FROM_OTHER_SC)) {
11829 union ctl_ha_msg msg_info;
11831 io->io_hdr.flags |= CTL_FLAG_SENT_2OTHER_SC;
11832 msg_info.hdr.nexus = io->io_hdr.nexus;
11833 if (ua_type==CTL_UA_TARG_RESET)
11834 msg_info.task.task_action = CTL_TASK_TARGET_RESET;
11836 msg_info.task.task_action = CTL_TASK_BUS_RESET;
11837 msg_info.hdr.msg_type = CTL_MSG_MANAGE_TASKS;
11838 msg_info.hdr.original_sc = NULL;
11839 msg_info.hdr.serializing_sc = NULL;
11840 if (CTL_HA_STATUS_SUCCESS != ctl_ha_msg_send(CTL_HA_CHAN_CTL,
11841 (void *)&msg_info, sizeof(msg_info), 0)) {
11846 mtx_lock(&ctl_softc->ctl_lock);
11847 STAILQ_FOREACH(lun, &ctl_softc->lun_list, links)
11848 retval += ctl_lun_reset(lun, io, ua_type);
11849 mtx_unlock(&ctl_softc->ctl_lock);
11855 * The LUN should always be set. The I/O is optional, and is used to
11856 * distinguish between I/Os sent by this initiator, and by other
11857 * initiators. We set unit attention for initiators other than this one.
11858 * SAM-3 is vague on this point. It does say that a unit attention should
11859 * be established for other initiators when a LUN is reset (see section
11860 * 5.7.3), but it doesn't specifically say that the unit attention should
11861 * be established for this particular initiator when a LUN is reset. Here
11862 * is the relevant text, from SAM-3 rev 8:
11864 * 5.7.2 When a SCSI initiator port aborts its own tasks
11866 * When a SCSI initiator port causes its own task(s) to be aborted, no
11867 * notification that the task(s) have been aborted shall be returned to
11868 * the SCSI initiator port other than the completion response for the
11869 * command or task management function action that caused the task(s) to
11870 * be aborted and notification(s) associated with related effects of the
11871 * action (e.g., a reset unit attention condition).
11873 * XXX KDM for now, we're setting unit attention for all initiators.
11876 ctl_lun_reset(struct ctl_lun *lun, union ctl_io *io, ctl_ua_type ua_type)
11880 uint32_t initindex;
11884 mtx_lock(&lun->lun_lock);
11886 * Run through the OOA queue and abort each I/O.
11889 TAILQ_FOREACH((struct ctl_io_hdr *)xio, &lun->ooa_queue, ooa_links) {
11891 for (xio = (union ctl_io *)TAILQ_FIRST(&lun->ooa_queue); xio != NULL;
11892 xio = (union ctl_io *)TAILQ_NEXT(&xio->io_hdr, ooa_links)) {
11893 xio->io_hdr.flags |= CTL_FLAG_ABORT | CTL_FLAG_ABORT_STATUS;
11897 * This version sets unit attention for every
11900 initindex = ctl_get_initindex(&io->io_hdr.nexus);
11901 for (i = 0; i < CTL_MAX_INITIATORS; i++) {
11902 if (initindex == i)
11904 lun->pending_ua[i] |= ua_type;
11909 * A reset (any kind, really) clears reservations established with
11910 * RESERVE/RELEASE. It does not clear reservations established
11911 * with PERSISTENT RESERVE OUT, but we don't support that at the
11912 * moment anyway. See SPC-2, section 5.6. SPC-3 doesn't address
11913 * reservations made with the RESERVE/RELEASE commands, because
11914 * those commands are obsolete in SPC-3.
11916 lun->flags &= ~CTL_LUN_RESERVED;
11918 for (i = 0; i < CTL_MAX_INITIATORS; i++) {
11920 ctl_clear_mask(lun->have_ca, i);
11922 lun->pending_ua[i] |= ua_type;
11924 mtx_unlock(&lun->lun_lock);
11930 ctl_abort_tasks_lun(struct ctl_lun *lun, uint32_t targ_port, uint32_t init_id,
11936 mtx_assert(&lun->lun_lock, MA_OWNED);
11939 * Run through the OOA queue and attempt to find the given I/O.
11940 * The target port, initiator ID, tag type and tag number have to
11941 * match the values that we got from the initiator. If we have an
11942 * untagged command to abort, simply abort the first untagged command
11943 * we come to. We only allow one untagged command at a time of course.
11945 for (xio = (union ctl_io *)TAILQ_FIRST(&lun->ooa_queue); xio != NULL;
11946 xio = (union ctl_io *)TAILQ_NEXT(&xio->io_hdr, ooa_links)) {
11948 if ((targ_port == UINT32_MAX ||
11949 targ_port == xio->io_hdr.nexus.targ_port) &&
11950 (init_id == UINT32_MAX ||
11951 init_id == xio->io_hdr.nexus.initid.id)) {
11952 if (targ_port != xio->io_hdr.nexus.targ_port ||
11953 init_id != xio->io_hdr.nexus.initid.id)
11954 xio->io_hdr.flags |= CTL_FLAG_ABORT_STATUS;
11955 xio->io_hdr.flags |= CTL_FLAG_ABORT;
11957 if (!other_sc && !(lun->flags & CTL_LUN_PRIMARY_SC)) {
11958 union ctl_ha_msg msg_info;
11960 msg_info.hdr.nexus = xio->io_hdr.nexus;
11961 msg_info.task.task_action = CTL_TASK_ABORT_TASK;
11962 msg_info.task.tag_num = xio->scsiio.tag_num;
11963 msg_info.task.tag_type = xio->scsiio.tag_type;
11964 msg_info.hdr.msg_type = CTL_MSG_MANAGE_TASKS;
11965 msg_info.hdr.original_sc = NULL;
11966 msg_info.hdr.serializing_sc = NULL;
11967 ctl_ha_msg_send(CTL_HA_CHAN_CTL,
11968 (void *)&msg_info, sizeof(msg_info), 0);
11976 ctl_abort_task_set(union ctl_io *io)
11978 struct ctl_softc *softc = control_softc;
11979 struct ctl_lun *lun;
11985 targ_lun = io->io_hdr.nexus.targ_mapped_lun;
11986 mtx_lock(&softc->ctl_lock);
11987 if ((targ_lun < CTL_MAX_LUNS) && (softc->ctl_luns[targ_lun] != NULL))
11988 lun = softc->ctl_luns[targ_lun];
11990 mtx_unlock(&softc->ctl_lock);
11994 mtx_lock(&lun->lun_lock);
11995 mtx_unlock(&softc->ctl_lock);
11996 if (io->taskio.task_action == CTL_TASK_ABORT_TASK_SET) {
11997 ctl_abort_tasks_lun(lun, io->io_hdr.nexus.targ_port,
11998 io->io_hdr.nexus.initid.id,
11999 (io->io_hdr.flags & CTL_FLAG_FROM_OTHER_SC) != 0);
12000 } else { /* CTL_TASK_CLEAR_TASK_SET */
12001 ctl_abort_tasks_lun(lun, UINT32_MAX, UINT32_MAX,
12002 (io->io_hdr.flags & CTL_FLAG_FROM_OTHER_SC) != 0);
12004 mtx_unlock(&lun->lun_lock);
12009 ctl_i_t_nexus_reset(union ctl_io *io)
12011 struct ctl_softc *softc = control_softc;
12012 struct ctl_lun *lun;
12013 uint32_t initindex;
12015 initindex = ctl_get_initindex(&io->io_hdr.nexus);
12016 mtx_lock(&softc->ctl_lock);
12017 STAILQ_FOREACH(lun, &softc->lun_list, links) {
12018 mtx_lock(&lun->lun_lock);
12019 ctl_abort_tasks_lun(lun, io->io_hdr.nexus.targ_port,
12020 io->io_hdr.nexus.initid.id,
12021 (io->io_hdr.flags & CTL_FLAG_FROM_OTHER_SC) != 0);
12023 ctl_clear_mask(lun->have_ca, initindex);
12025 lun->pending_ua[initindex] |= CTL_UA_I_T_NEXUS_LOSS;
12026 mtx_unlock(&lun->lun_lock);
12028 mtx_unlock(&softc->ctl_lock);
12033 ctl_abort_task(union ctl_io *io)
12036 struct ctl_lun *lun;
12037 struct ctl_softc *ctl_softc;
12040 char printbuf[128];
12045 ctl_softc = control_softc;
12051 targ_lun = io->io_hdr.nexus.targ_mapped_lun;
12052 mtx_lock(&ctl_softc->ctl_lock);
12053 if ((targ_lun < CTL_MAX_LUNS)
12054 && (ctl_softc->ctl_luns[targ_lun] != NULL))
12055 lun = ctl_softc->ctl_luns[targ_lun];
12057 mtx_unlock(&ctl_softc->ctl_lock);
12062 printf("ctl_abort_task: called for lun %lld, tag %d type %d\n",
12063 lun->lun, io->taskio.tag_num, io->taskio.tag_type);
12066 mtx_lock(&lun->lun_lock);
12067 mtx_unlock(&ctl_softc->ctl_lock);
12069 * Run through the OOA queue and attempt to find the given I/O.
12070 * The target port, initiator ID, tag type and tag number have to
12071 * match the values that we got from the initiator. If we have an
12072 * untagged command to abort, simply abort the first untagged command
12073 * we come to. We only allow one untagged command at a time of course.
12076 TAILQ_FOREACH((struct ctl_io_hdr *)xio, &lun->ooa_queue, ooa_links) {
12078 for (xio = (union ctl_io *)TAILQ_FIRST(&lun->ooa_queue); xio != NULL;
12079 xio = (union ctl_io *)TAILQ_NEXT(&xio->io_hdr, ooa_links)) {
12081 sbuf_new(&sb, printbuf, sizeof(printbuf), SBUF_FIXEDLEN);
12083 sbuf_printf(&sb, "LUN %lld tag %d type %d%s%s%s%s: ",
12084 lun->lun, xio->scsiio.tag_num,
12085 xio->scsiio.tag_type,
12086 (xio->io_hdr.blocked_links.tqe_prev
12087 == NULL) ? "" : " BLOCKED",
12088 (xio->io_hdr.flags &
12089 CTL_FLAG_DMA_INPROG) ? " DMA" : "",
12090 (xio->io_hdr.flags &
12091 CTL_FLAG_ABORT) ? " ABORT" : "",
12092 (xio->io_hdr.flags &
12093 CTL_FLAG_IS_WAS_ON_RTR ? " RTR" : ""));
12094 ctl_scsi_command_string(&xio->scsiio, NULL, &sb);
12096 printf("%s\n", sbuf_data(&sb));
12099 if ((xio->io_hdr.nexus.targ_port == io->io_hdr.nexus.targ_port)
12100 && (xio->io_hdr.nexus.initid.id ==
12101 io->io_hdr.nexus.initid.id)) {
12103 * If the abort says that the task is untagged, the
12104 * task in the queue must be untagged. Otherwise,
12105 * we just check to see whether the tag numbers
12106 * match. This is because the QLogic firmware
12107 * doesn't pass back the tag type in an abort
12111 if (((xio->scsiio.tag_type == CTL_TAG_UNTAGGED)
12112 && (io->taskio.tag_type == CTL_TAG_UNTAGGED))
12113 || (xio->scsiio.tag_num == io->taskio.tag_num)) {
12116 * XXX KDM we've got problems with FC, because it
12117 * doesn't send down a tag type with aborts. So we
12118 * can only really go by the tag number...
12119 * This may cause problems with parallel SCSI.
12120 * Need to figure that out!!
12122 if (xio->scsiio.tag_num == io->taskio.tag_num) {
12123 xio->io_hdr.flags |= CTL_FLAG_ABORT;
12125 if ((io->io_hdr.flags &
12126 CTL_FLAG_FROM_OTHER_SC) == 0 &&
12127 !(lun->flags & CTL_LUN_PRIMARY_SC)) {
12128 union ctl_ha_msg msg_info;
12130 io->io_hdr.flags |=
12131 CTL_FLAG_SENT_2OTHER_SC;
12132 msg_info.hdr.nexus = io->io_hdr.nexus;
12133 msg_info.task.task_action =
12134 CTL_TASK_ABORT_TASK;
12135 msg_info.task.tag_num =
12136 io->taskio.tag_num;
12137 msg_info.task.tag_type =
12138 io->taskio.tag_type;
12139 msg_info.hdr.msg_type =
12140 CTL_MSG_MANAGE_TASKS;
12141 msg_info.hdr.original_sc = NULL;
12142 msg_info.hdr.serializing_sc = NULL;
12144 printf("Sent Abort to other side\n");
12146 if (CTL_HA_STATUS_SUCCESS !=
12147 ctl_ha_msg_send(CTL_HA_CHAN_CTL,
12149 sizeof(msg_info), 0)) {
12153 printf("ctl_abort_task: found I/O to abort\n");
12159 mtx_unlock(&lun->lun_lock);
12163 * This isn't really an error. It's entirely possible for
12164 * the abort and command completion to cross on the wire.
12165 * This is more of an informative/diagnostic error.
12168 printf("ctl_abort_task: ABORT sent for nonexistent I/O: "
12169 "%d:%d:%d:%d tag %d type %d\n",
12170 io->io_hdr.nexus.initid.id,
12171 io->io_hdr.nexus.targ_port,
12172 io->io_hdr.nexus.targ_target.id,
12173 io->io_hdr.nexus.targ_lun, io->taskio.tag_num,
12174 io->taskio.tag_type);
12181 ctl_run_task(union ctl_io *io)
12183 struct ctl_softc *ctl_softc = control_softc;
12185 const char *task_desc;
12187 CTL_DEBUG_PRINT(("ctl_run_task\n"));
12189 KASSERT(io->io_hdr.io_type == CTL_IO_TASK,
12190 ("ctl_run_task: Unextected io_type %d\n",
12191 io->io_hdr.io_type));
12193 task_desc = ctl_scsi_task_string(&io->taskio);
12194 if (task_desc != NULL) {
12196 csevent_log(CSC_CTL | CSC_SHELF_SW |
12198 csevent_LogType_Trace,
12199 csevent_Severity_Information,
12200 csevent_AlertLevel_Green,
12201 csevent_FRU_Firmware,
12202 csevent_FRU_Unknown,
12203 "CTL: received task: %s",task_desc);
12207 csevent_log(CSC_CTL | CSC_SHELF_SW |
12209 csevent_LogType_Trace,
12210 csevent_Severity_Information,
12211 csevent_AlertLevel_Green,
12212 csevent_FRU_Firmware,
12213 csevent_FRU_Unknown,
12214 "CTL: received unknown task "
12216 io->taskio.task_action,
12217 io->taskio.task_action);
12220 switch (io->taskio.task_action) {
12221 case CTL_TASK_ABORT_TASK:
12222 retval = ctl_abort_task(io);
12224 case CTL_TASK_ABORT_TASK_SET:
12225 case CTL_TASK_CLEAR_TASK_SET:
12226 retval = ctl_abort_task_set(io);
12228 case CTL_TASK_CLEAR_ACA:
12230 case CTL_TASK_I_T_NEXUS_RESET:
12231 retval = ctl_i_t_nexus_reset(io);
12233 case CTL_TASK_LUN_RESET: {
12234 struct ctl_lun *lun;
12237 targ_lun = io->io_hdr.nexus.targ_mapped_lun;
12238 mtx_lock(&ctl_softc->ctl_lock);
12239 if ((targ_lun < CTL_MAX_LUNS)
12240 && (ctl_softc->ctl_luns[targ_lun] != NULL))
12241 lun = ctl_softc->ctl_luns[targ_lun];
12243 mtx_unlock(&ctl_softc->ctl_lock);
12248 if (!(io->io_hdr.flags &
12249 CTL_FLAG_FROM_OTHER_SC)) {
12250 union ctl_ha_msg msg_info;
12252 io->io_hdr.flags |=
12253 CTL_FLAG_SENT_2OTHER_SC;
12254 msg_info.hdr.msg_type =
12255 CTL_MSG_MANAGE_TASKS;
12256 msg_info.hdr.nexus = io->io_hdr.nexus;
12257 msg_info.task.task_action =
12258 CTL_TASK_LUN_RESET;
12259 msg_info.hdr.original_sc = NULL;
12260 msg_info.hdr.serializing_sc = NULL;
12261 if (CTL_HA_STATUS_SUCCESS !=
12262 ctl_ha_msg_send(CTL_HA_CHAN_CTL,
12264 sizeof(msg_info), 0)) {
12268 retval = ctl_lun_reset(lun, io,
12270 mtx_unlock(&ctl_softc->ctl_lock);
12273 case CTL_TASK_TARGET_RESET:
12274 retval = ctl_target_reset(ctl_softc, io, CTL_UA_TARG_RESET);
12276 case CTL_TASK_BUS_RESET:
12277 retval = ctl_bus_reset(ctl_softc, io);
12279 case CTL_TASK_PORT_LOGIN:
12281 case CTL_TASK_PORT_LOGOUT:
12284 printf("ctl_run_task: got unknown task management event %d\n",
12285 io->taskio.task_action);
12289 io->io_hdr.status = CTL_SUCCESS;
12291 io->io_hdr.status = CTL_ERROR;
12296 * For HA operation. Handle commands that come in from the other
12300 ctl_handle_isc(union ctl_io *io)
12303 struct ctl_lun *lun;
12304 struct ctl_softc *ctl_softc;
12307 ctl_softc = control_softc;
12309 targ_lun = io->io_hdr.nexus.targ_mapped_lun;
12310 lun = ctl_softc->ctl_luns[targ_lun];
12312 switch (io->io_hdr.msg_type) {
12313 case CTL_MSG_SERIALIZE:
12314 free_io = ctl_serialize_other_sc_cmd(&io->scsiio);
12316 case CTL_MSG_R2R: {
12317 const struct ctl_cmd_entry *entry;
12320 * This is only used in SER_ONLY mode.
12323 entry = ctl_get_cmd_entry(&io->scsiio);
12324 mtx_lock(&lun->lun_lock);
12325 if (ctl_scsiio_lun_check(ctl_softc, lun,
12326 entry, (struct ctl_scsiio *)io) != 0) {
12327 mtx_unlock(&lun->lun_lock);
12331 io->io_hdr.flags |= CTL_FLAG_IS_WAS_ON_RTR;
12332 mtx_unlock(&lun->lun_lock);
12333 ctl_enqueue_rtr(io);
12336 case CTL_MSG_FINISH_IO:
12337 if (ctl_softc->ha_mode == CTL_HA_MODE_XFER) {
12342 mtx_lock(&lun->lun_lock);
12343 TAILQ_REMOVE(&lun->ooa_queue, &io->io_hdr,
12345 ctl_check_blocked(lun);
12346 mtx_unlock(&lun->lun_lock);
12349 case CTL_MSG_PERS_ACTION:
12350 ctl_hndl_per_res_out_on_other_sc(
12351 (union ctl_ha_msg *)&io->presio.pr_msg);
12354 case CTL_MSG_BAD_JUJU:
12358 case CTL_MSG_DATAMOVE:
12359 /* Only used in XFER mode */
12361 ctl_datamove_remote(io);
12363 case CTL_MSG_DATAMOVE_DONE:
12364 /* Only used in XFER mode */
12366 io->scsiio.be_move_done(io);
12370 printf("%s: Invalid message type %d\n",
12371 __func__, io->io_hdr.msg_type);
12381 * Returns the match type in the case of a match, or CTL_LUN_PAT_NONE if
12382 * there is no match.
12384 static ctl_lun_error_pattern
12385 ctl_cmd_pattern_match(struct ctl_scsiio *ctsio, struct ctl_error_desc *desc)
12387 const struct ctl_cmd_entry *entry;
12388 ctl_lun_error_pattern filtered_pattern, pattern;
12390 pattern = desc->error_pattern;
12393 * XXX KDM we need more data passed into this function to match a
12394 * custom pattern, and we actually need to implement custom pattern
12397 if (pattern & CTL_LUN_PAT_CMD)
12398 return (CTL_LUN_PAT_CMD);
12400 if ((pattern & CTL_LUN_PAT_MASK) == CTL_LUN_PAT_ANY)
12401 return (CTL_LUN_PAT_ANY);
12403 entry = ctl_get_cmd_entry(ctsio);
12405 filtered_pattern = entry->pattern & pattern;
12408 * If the user requested specific flags in the pattern (e.g.
12409 * CTL_LUN_PAT_RANGE), make sure the command supports all of those
12412 * If the user did not specify any flags, it doesn't matter whether
12413 * or not the command supports the flags.
12415 if ((filtered_pattern & ~CTL_LUN_PAT_MASK) !=
12416 (pattern & ~CTL_LUN_PAT_MASK))
12417 return (CTL_LUN_PAT_NONE);
12420 * If the user asked for a range check, see if the requested LBA
12421 * range overlaps with this command's LBA range.
12423 if (filtered_pattern & CTL_LUN_PAT_RANGE) {
12429 retval = ctl_get_lba_len((union ctl_io *)ctsio, &lba1, &len1);
12431 return (CTL_LUN_PAT_NONE);
12433 action = ctl_extent_check_lba(lba1, len1, desc->lba_range.lba,
12434 desc->lba_range.len);
12436 * A "pass" means that the LBA ranges don't overlap, so
12437 * this doesn't match the user's range criteria.
12439 if (action == CTL_ACTION_PASS)
12440 return (CTL_LUN_PAT_NONE);
12443 return (filtered_pattern);
12447 ctl_inject_error(struct ctl_lun *lun, union ctl_io *io)
12449 struct ctl_error_desc *desc, *desc2;
12451 mtx_assert(&lun->lun_lock, MA_OWNED);
12453 STAILQ_FOREACH_SAFE(desc, &lun->error_list, links, desc2) {
12454 ctl_lun_error_pattern pattern;
12456 * Check to see whether this particular command matches
12457 * the pattern in the descriptor.
12459 pattern = ctl_cmd_pattern_match(&io->scsiio, desc);
12460 if ((pattern & CTL_LUN_PAT_MASK) == CTL_LUN_PAT_NONE)
12463 switch (desc->lun_error & CTL_LUN_INJ_TYPE) {
12464 case CTL_LUN_INJ_ABORTED:
12465 ctl_set_aborted(&io->scsiio);
12467 case CTL_LUN_INJ_MEDIUM_ERR:
12468 ctl_set_medium_error(&io->scsiio);
12470 case CTL_LUN_INJ_UA:
12471 /* 29h/00h POWER ON, RESET, OR BUS DEVICE RESET
12473 ctl_set_ua(&io->scsiio, 0x29, 0x00);
12475 case CTL_LUN_INJ_CUSTOM:
12477 * We're assuming the user knows what he is doing.
12478 * Just copy the sense information without doing
12481 bcopy(&desc->custom_sense, &io->scsiio.sense_data,
12482 ctl_min(sizeof(desc->custom_sense),
12483 sizeof(io->scsiio.sense_data)));
12484 io->scsiio.scsi_status = SCSI_STATUS_CHECK_COND;
12485 io->scsiio.sense_len = SSD_FULL_SIZE;
12486 io->io_hdr.status = CTL_SCSI_ERROR | CTL_AUTOSENSE;
12488 case CTL_LUN_INJ_NONE:
12491 * If this is an error injection type we don't know
12492 * about, clear the continuous flag (if it is set)
12493 * so it will get deleted below.
12495 desc->lun_error &= ~CTL_LUN_INJ_CONTINUOUS;
12499 * By default, each error injection action is a one-shot
12501 if (desc->lun_error & CTL_LUN_INJ_CONTINUOUS)
12504 STAILQ_REMOVE(&lun->error_list, desc, ctl_error_desc, links);
12510 #ifdef CTL_IO_DELAY
12512 ctl_datamove_timer_wakeup(void *arg)
12516 io = (union ctl_io *)arg;
12520 #endif /* CTL_IO_DELAY */
12523 ctl_datamove(union ctl_io *io)
12525 void (*fe_datamove)(union ctl_io *io);
12527 mtx_assert(&control_softc->ctl_lock, MA_NOTOWNED);
12529 CTL_DEBUG_PRINT(("ctl_datamove\n"));
12532 if ((time_uptime - io->io_hdr.start_time) > ctl_time_io_secs) {
12537 ctl_scsi_path_string(io, path_str, sizeof(path_str));
12538 sbuf_new(&sb, str, sizeof(str), SBUF_FIXEDLEN);
12540 sbuf_cat(&sb, path_str);
12541 switch (io->io_hdr.io_type) {
12543 ctl_scsi_command_string(&io->scsiio, NULL, &sb);
12544 sbuf_printf(&sb, "\n");
12545 sbuf_cat(&sb, path_str);
12546 sbuf_printf(&sb, "Tag: 0x%04x, type %d\n",
12547 io->scsiio.tag_num, io->scsiio.tag_type);
12550 sbuf_printf(&sb, "Task I/O type: %d, Tag: 0x%04x, "
12551 "Tag Type: %d\n", io->taskio.task_action,
12552 io->taskio.tag_num, io->taskio.tag_type);
12555 printf("Invalid CTL I/O type %d\n", io->io_hdr.io_type);
12556 panic("Invalid CTL I/O type %d\n", io->io_hdr.io_type);
12559 sbuf_cat(&sb, path_str);
12560 sbuf_printf(&sb, "ctl_datamove: %jd seconds\n",
12561 (intmax_t)time_uptime - io->io_hdr.start_time);
12563 printf("%s", sbuf_data(&sb));
12565 #endif /* CTL_TIME_IO */
12567 #ifdef CTL_IO_DELAY
12568 if (io->io_hdr.flags & CTL_FLAG_DELAY_DONE) {
12569 struct ctl_lun *lun;
12571 lun =(struct ctl_lun *)io->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
12573 io->io_hdr.flags &= ~CTL_FLAG_DELAY_DONE;
12575 struct ctl_lun *lun;
12577 lun =(struct ctl_lun *)io->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
12579 && (lun->delay_info.datamove_delay > 0)) {
12580 struct callout *callout;
12582 callout = (struct callout *)&io->io_hdr.timer_bytes;
12583 callout_init(callout, /*mpsafe*/ 1);
12584 io->io_hdr.flags |= CTL_FLAG_DELAY_DONE;
12585 callout_reset(callout,
12586 lun->delay_info.datamove_delay * hz,
12587 ctl_datamove_timer_wakeup, io);
12588 if (lun->delay_info.datamove_type ==
12589 CTL_DELAY_TYPE_ONESHOT)
12590 lun->delay_info.datamove_delay = 0;
12597 * This command has been aborted. Set the port status, so we fail
12600 if (io->io_hdr.flags & CTL_FLAG_ABORT) {
12601 printf("ctl_datamove: tag 0x%04x on (%ju:%d:%ju:%d) aborted\n",
12602 io->scsiio.tag_num,(uintmax_t)io->io_hdr.nexus.initid.id,
12603 io->io_hdr.nexus.targ_port,
12604 (uintmax_t)io->io_hdr.nexus.targ_target.id,
12605 io->io_hdr.nexus.targ_lun);
12606 io->io_hdr.port_status = 31337;
12608 * Note that the backend, in this case, will get the
12609 * callback in its context. In other cases it may get
12610 * called in the frontend's interrupt thread context.
12612 io->scsiio.be_move_done(io);
12617 * If we're in XFER mode and this I/O is from the other shelf
12618 * controller, we need to send the DMA to the other side to
12619 * actually transfer the data to/from the host. In serialize only
12620 * mode the transfer happens below CTL and ctl_datamove() is only
12621 * called on the machine that originally received the I/O.
12623 if ((control_softc->ha_mode == CTL_HA_MODE_XFER)
12624 && (io->io_hdr.flags & CTL_FLAG_FROM_OTHER_SC)) {
12625 union ctl_ha_msg msg;
12626 uint32_t sg_entries_sent;
12630 memset(&msg, 0, sizeof(msg));
12631 msg.hdr.msg_type = CTL_MSG_DATAMOVE;
12632 msg.hdr.original_sc = io->io_hdr.original_sc;
12633 msg.hdr.serializing_sc = io;
12634 msg.hdr.nexus = io->io_hdr.nexus;
12635 msg.dt.flags = io->io_hdr.flags;
12637 * We convert everything into a S/G list here. We can't
12638 * pass by reference, only by value between controllers.
12639 * So we can't pass a pointer to the S/G list, only as many
12640 * S/G entries as we can fit in here. If it's possible for
12641 * us to get more than CTL_HA_MAX_SG_ENTRIES S/G entries,
12642 * then we need to break this up into multiple transfers.
12644 if (io->scsiio.kern_sg_entries == 0) {
12645 msg.dt.kern_sg_entries = 1;
12647 * If this is in cached memory, flush the cache
12648 * before we send the DMA request to the other
12649 * controller. We want to do this in either the
12650 * read or the write case. The read case is
12651 * straightforward. In the write case, we want to
12652 * make sure nothing is in the local cache that
12653 * could overwrite the DMAed data.
12655 if ((io->io_hdr.flags & CTL_FLAG_NO_DATASYNC) == 0) {
12657 * XXX KDM use bus_dmamap_sync() here.
12662 * Convert to a physical address if this is a
12665 if (io->io_hdr.flags & CTL_FLAG_BUS_ADDR) {
12666 msg.dt.sg_list[0].addr =
12667 io->scsiio.kern_data_ptr;
12670 * XXX KDM use busdma here!
12673 msg.dt.sg_list[0].addr = (void *)
12674 vtophys(io->scsiio.kern_data_ptr);
12678 msg.dt.sg_list[0].len = io->scsiio.kern_data_len;
12681 struct ctl_sg_entry *sgl;
12684 msg.dt.kern_sg_entries = io->scsiio.kern_sg_entries;
12685 sgl = (struct ctl_sg_entry *)io->scsiio.kern_data_ptr;
12686 if ((io->io_hdr.flags & CTL_FLAG_NO_DATASYNC) == 0) {
12688 * XXX KDM use bus_dmamap_sync() here.
12693 msg.dt.kern_data_len = io->scsiio.kern_data_len;
12694 msg.dt.kern_total_len = io->scsiio.kern_total_len;
12695 msg.dt.kern_data_resid = io->scsiio.kern_data_resid;
12696 msg.dt.kern_rel_offset = io->scsiio.kern_rel_offset;
12697 msg.dt.sg_sequence = 0;
12700 * Loop until we've sent all of the S/G entries. On the
12701 * other end, we'll recompose these S/G entries into one
12702 * contiguous list before passing it to the
12704 for (sg_entries_sent = 0; sg_entries_sent <
12705 msg.dt.kern_sg_entries; msg.dt.sg_sequence++) {
12706 msg.dt.cur_sg_entries = ctl_min((sizeof(msg.dt.sg_list)/
12707 sizeof(msg.dt.sg_list[0])),
12708 msg.dt.kern_sg_entries - sg_entries_sent);
12710 if (do_sg_copy != 0) {
12711 struct ctl_sg_entry *sgl;
12714 sgl = (struct ctl_sg_entry *)
12715 io->scsiio.kern_data_ptr;
12717 * If this is in cached memory, flush the cache
12718 * before we send the DMA request to the other
12719 * controller. We want to do this in either
12720 * the * read or the write case. The read
12721 * case is straightforward. In the write
12722 * case, we want to make sure nothing is
12723 * in the local cache that could overwrite
12727 for (i = sg_entries_sent, j = 0;
12728 i < msg.dt.cur_sg_entries; i++, j++) {
12729 if ((io->io_hdr.flags &
12730 CTL_FLAG_NO_DATASYNC) == 0) {
12732 * XXX KDM use bus_dmamap_sync()
12735 if ((io->io_hdr.flags &
12736 CTL_FLAG_BUS_ADDR) == 0) {
12738 * XXX KDM use busdma.
12741 msg.dt.sg_list[j].addr =(void *)
12742 vtophys(sgl[i].addr);
12745 msg.dt.sg_list[j].addr =
12748 msg.dt.sg_list[j].len = sgl[i].len;
12752 sg_entries_sent += msg.dt.cur_sg_entries;
12753 if (sg_entries_sent >= msg.dt.kern_sg_entries)
12754 msg.dt.sg_last = 1;
12756 msg.dt.sg_last = 0;
12759 * XXX KDM drop and reacquire the lock here?
12761 if (ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg,
12762 sizeof(msg), 0) > CTL_HA_STATUS_SUCCESS) {
12764 * XXX do something here.
12768 msg.dt.sent_sg_entries = sg_entries_sent;
12770 io->io_hdr.flags &= ~CTL_FLAG_IO_ACTIVE;
12771 if (io->io_hdr.flags & CTL_FLAG_FAILOVER)
12772 ctl_failover_io(io, /*have_lock*/ 0);
12777 * Lookup the fe_datamove() function for this particular
12781 control_softc->ctl_ports[ctl_port_idx(io->io_hdr.nexus.targ_port)]->fe_datamove;
12788 ctl_send_datamove_done(union ctl_io *io, int have_lock)
12790 union ctl_ha_msg msg;
12793 memset(&msg, 0, sizeof(msg));
12795 msg.hdr.msg_type = CTL_MSG_DATAMOVE_DONE;
12796 msg.hdr.original_sc = io;
12797 msg.hdr.serializing_sc = io->io_hdr.serializing_sc;
12798 msg.hdr.nexus = io->io_hdr.nexus;
12799 msg.hdr.status = io->io_hdr.status;
12800 msg.scsi.tag_num = io->scsiio.tag_num;
12801 msg.scsi.tag_type = io->scsiio.tag_type;
12802 msg.scsi.scsi_status = io->scsiio.scsi_status;
12803 memcpy(&msg.scsi.sense_data, &io->scsiio.sense_data,
12804 sizeof(io->scsiio.sense_data));
12805 msg.scsi.sense_len = io->scsiio.sense_len;
12806 msg.scsi.sense_residual = io->scsiio.sense_residual;
12807 msg.scsi.fetd_status = io->io_hdr.port_status;
12808 msg.scsi.residual = io->scsiio.residual;
12809 io->io_hdr.flags &= ~CTL_FLAG_IO_ACTIVE;
12811 if (io->io_hdr.flags & CTL_FLAG_FAILOVER) {
12812 ctl_failover_io(io, /*have_lock*/ have_lock);
12816 isc_status = ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg, sizeof(msg), 0);
12817 if (isc_status > CTL_HA_STATUS_SUCCESS) {
12818 /* XXX do something if this fails */
12824 * The DMA to the remote side is done, now we need to tell the other side
12825 * we're done so it can continue with its data movement.
12828 ctl_datamove_remote_write_cb(struct ctl_ha_dt_req *rq)
12834 if (rq->ret != CTL_HA_STATUS_SUCCESS) {
12835 printf("%s: ISC DMA write failed with error %d", __func__,
12837 ctl_set_internal_failure(&io->scsiio,
12839 /*retry_count*/ rq->ret);
12842 ctl_dt_req_free(rq);
12845 * In this case, we had to malloc the memory locally. Free it.
12847 if ((io->io_hdr.flags & CTL_FLAG_AUTO_MIRROR) == 0) {
12849 for (i = 0; i < io->scsiio.kern_sg_entries; i++)
12850 free(io->io_hdr.local_sglist[i].addr, M_CTL);
12853 * The data is in local and remote memory, so now we need to send
12854 * status (good or back) back to the other side.
12856 ctl_send_datamove_done(io, /*have_lock*/ 0);
12860 * We've moved the data from the host/controller into local memory. Now we
12861 * need to push it over to the remote controller's memory.
12864 ctl_datamove_remote_dm_write_cb(union ctl_io *io)
12870 retval = ctl_datamove_remote_xfer(io, CTL_HA_DT_CMD_WRITE,
12871 ctl_datamove_remote_write_cb);
12877 ctl_datamove_remote_write(union ctl_io *io)
12880 void (*fe_datamove)(union ctl_io *io);
12883 * - Get the data from the host/HBA into local memory.
12884 * - DMA memory from the local controller to the remote controller.
12885 * - Send status back to the remote controller.
12888 retval = ctl_datamove_remote_sgl_setup(io);
12892 /* Switch the pointer over so the FETD knows what to do */
12893 io->scsiio.kern_data_ptr = (uint8_t *)io->io_hdr.local_sglist;
12896 * Use a custom move done callback, since we need to send completion
12897 * back to the other controller, not to the backend on this side.
12899 io->scsiio.be_move_done = ctl_datamove_remote_dm_write_cb;
12901 fe_datamove = control_softc->ctl_ports[ctl_port_idx(io->io_hdr.nexus.targ_port)]->fe_datamove;
12910 ctl_datamove_remote_dm_read_cb(union ctl_io *io)
12919 * In this case, we had to malloc the memory locally. Free it.
12921 if ((io->io_hdr.flags & CTL_FLAG_AUTO_MIRROR) == 0) {
12923 for (i = 0; i < io->scsiio.kern_sg_entries; i++)
12924 free(io->io_hdr.local_sglist[i].addr, M_CTL);
12928 scsi_path_string(io, path_str, sizeof(path_str));
12929 sbuf_new(&sb, str, sizeof(str), SBUF_FIXEDLEN);
12930 sbuf_cat(&sb, path_str);
12931 scsi_command_string(&io->scsiio, NULL, &sb);
12932 sbuf_printf(&sb, "\n");
12933 sbuf_cat(&sb, path_str);
12934 sbuf_printf(&sb, "Tag: 0x%04x, type %d\n",
12935 io->scsiio.tag_num, io->scsiio.tag_type);
12936 sbuf_cat(&sb, path_str);
12937 sbuf_printf(&sb, "%s: flags %#x, status %#x\n", __func__,
12938 io->io_hdr.flags, io->io_hdr.status);
12940 printk("%s", sbuf_data(&sb));
12945 * The read is done, now we need to send status (good or bad) back
12946 * to the other side.
12948 ctl_send_datamove_done(io, /*have_lock*/ 0);
12954 ctl_datamove_remote_read_cb(struct ctl_ha_dt_req *rq)
12957 void (*fe_datamove)(union ctl_io *io);
12961 if (rq->ret != CTL_HA_STATUS_SUCCESS) {
12962 printf("%s: ISC DMA read failed with error %d", __func__,
12964 ctl_set_internal_failure(&io->scsiio,
12966 /*retry_count*/ rq->ret);
12969 ctl_dt_req_free(rq);
12971 /* Switch the pointer over so the FETD knows what to do */
12972 io->scsiio.kern_data_ptr = (uint8_t *)io->io_hdr.local_sglist;
12975 * Use a custom move done callback, since we need to send completion
12976 * back to the other controller, not to the backend on this side.
12978 io->scsiio.be_move_done = ctl_datamove_remote_dm_read_cb;
12980 /* XXX KDM add checks like the ones in ctl_datamove? */
12982 fe_datamove = control_softc->ctl_ports[ctl_port_idx(io->io_hdr.nexus.targ_port)]->fe_datamove;
12988 ctl_datamove_remote_sgl_setup(union ctl_io *io)
12990 struct ctl_sg_entry *local_sglist, *remote_sglist;
12991 struct ctl_sg_entry *local_dma_sglist, *remote_dma_sglist;
12992 struct ctl_softc *softc;
12997 softc = control_softc;
12999 local_sglist = io->io_hdr.local_sglist;
13000 local_dma_sglist = io->io_hdr.local_dma_sglist;
13001 remote_sglist = io->io_hdr.remote_sglist;
13002 remote_dma_sglist = io->io_hdr.remote_dma_sglist;
13004 if (io->io_hdr.flags & CTL_FLAG_AUTO_MIRROR) {
13005 for (i = 0; i < io->scsiio.kern_sg_entries; i++) {
13006 local_sglist[i].len = remote_sglist[i].len;
13009 * XXX Detect the situation where the RS-level I/O
13010 * redirector on the other side has already read the
13011 * data off of the AOR RS on this side, and
13012 * transferred it to remote (mirror) memory on the
13013 * other side. Since we already have the data in
13014 * memory here, we just need to use it.
13016 * XXX KDM this can probably be removed once we
13017 * get the cache device code in and take the
13018 * current AOR implementation out.
13021 if ((remote_sglist[i].addr >=
13022 (void *)vtophys(softc->mirr->addr))
13023 && (remote_sglist[i].addr <
13024 ((void *)vtophys(softc->mirr->addr) +
13025 CacheMirrorOffset))) {
13026 local_sglist[i].addr = remote_sglist[i].addr -
13028 if ((io->io_hdr.flags & CTL_FLAG_DATA_MASK) ==
13030 io->io_hdr.flags |= CTL_FLAG_REDIR_DONE;
13032 local_sglist[i].addr = remote_sglist[i].addr +
13037 printf("%s: local %p, remote %p, len %d\n",
13038 __func__, local_sglist[i].addr,
13039 remote_sglist[i].addr, local_sglist[i].len);
13043 uint32_t len_to_go;
13046 * In this case, we don't have automatically allocated
13047 * memory for this I/O on this controller. This typically
13048 * happens with internal CTL I/O -- e.g. inquiry, mode
13049 * sense, etc. Anything coming from RAIDCore will have
13050 * a mirror area available.
13052 len_to_go = io->scsiio.kern_data_len;
13055 * Clear the no datasync flag, we have to use malloced
13058 io->io_hdr.flags &= ~CTL_FLAG_NO_DATASYNC;
13061 * The difficult thing here is that the size of the various
13062 * S/G segments may be different than the size from the
13063 * remote controller. That'll make it harder when DMAing
13064 * the data back to the other side.
13066 for (i = 0; (i < sizeof(io->io_hdr.remote_sglist) /
13067 sizeof(io->io_hdr.remote_sglist[0])) &&
13068 (len_to_go > 0); i++) {
13069 local_sglist[i].len = ctl_min(len_to_go, 131072);
13070 CTL_SIZE_8B(local_dma_sglist[i].len,
13071 local_sglist[i].len);
13072 local_sglist[i].addr =
13073 malloc(local_dma_sglist[i].len, M_CTL,M_WAITOK);
13075 local_dma_sglist[i].addr = local_sglist[i].addr;
13077 if (local_sglist[i].addr == NULL) {
13080 printf("malloc failed for %zd bytes!",
13081 local_dma_sglist[i].len);
13082 for (j = 0; j < i; j++) {
13083 free(local_sglist[j].addr, M_CTL);
13085 ctl_set_internal_failure(&io->scsiio,
13087 /*retry_count*/ 4857);
13089 goto bailout_error;
13092 /* XXX KDM do we need a sync here? */
13094 len_to_go -= local_sglist[i].len;
13097 * Reset the number of S/G entries accordingly. The
13098 * original number of S/G entries is available in
13101 io->scsiio.kern_sg_entries = i;
13104 printf("%s: kern_sg_entries = %d\n", __func__,
13105 io->scsiio.kern_sg_entries);
13106 for (i = 0; i < io->scsiio.kern_sg_entries; i++)
13107 printf("%s: sg[%d] = %p, %d (DMA: %d)\n", __func__, i,
13108 local_sglist[i].addr, local_sglist[i].len,
13109 local_dma_sglist[i].len);
13118 ctl_send_datamove_done(io, /*have_lock*/ 0);
13124 ctl_datamove_remote_xfer(union ctl_io *io, unsigned command,
13125 ctl_ha_dt_cb callback)
13127 struct ctl_ha_dt_req *rq;
13128 struct ctl_sg_entry *remote_sglist, *local_sglist;
13129 struct ctl_sg_entry *remote_dma_sglist, *local_dma_sglist;
13130 uint32_t local_used, remote_used, total_used;
13136 rq = ctl_dt_req_alloc();
13139 * If we failed to allocate the request, and if the DMA didn't fail
13140 * anyway, set busy status. This is just a resource allocation
13144 && ((io->io_hdr.status & CTL_STATUS_MASK) != CTL_STATUS_NONE))
13145 ctl_set_busy(&io->scsiio);
13147 if ((io->io_hdr.status & CTL_STATUS_MASK) != CTL_STATUS_NONE) {
13150 ctl_dt_req_free(rq);
13153 * The data move failed. We need to return status back
13154 * to the other controller. No point in trying to DMA
13155 * data to the remote controller.
13158 ctl_send_datamove_done(io, /*have_lock*/ 0);
13165 local_sglist = io->io_hdr.local_sglist;
13166 local_dma_sglist = io->io_hdr.local_dma_sglist;
13167 remote_sglist = io->io_hdr.remote_sglist;
13168 remote_dma_sglist = io->io_hdr.remote_dma_sglist;
13173 if (io->io_hdr.flags & CTL_FLAG_REDIR_DONE) {
13174 rq->ret = CTL_HA_STATUS_SUCCESS;
13181 * Pull/push the data over the wire from/to the other controller.
13182 * This takes into account the possibility that the local and
13183 * remote sglists may not be identical in terms of the size of
13184 * the elements and the number of elements.
13186 * One fundamental assumption here is that the length allocated for
13187 * both the local and remote sglists is identical. Otherwise, we've
13188 * essentially got a coding error of some sort.
13190 for (i = 0, j = 0; total_used < io->scsiio.kern_data_len; ) {
13192 uint32_t cur_len, dma_length;
13195 rq->id = CTL_HA_DATA_CTL;
13196 rq->command = command;
13200 * Both pointers should be aligned. But it is possible
13201 * that the allocation length is not. They should both
13202 * also have enough slack left over at the end, though,
13203 * to round up to the next 8 byte boundary.
13205 cur_len = ctl_min(local_sglist[i].len - local_used,
13206 remote_sglist[j].len - remote_used);
13209 * In this case, we have a size issue and need to decrease
13210 * the size, except in the case where we actually have less
13211 * than 8 bytes left. In that case, we need to increase
13212 * the DMA length to get the last bit.
13214 if ((cur_len & 0x7) != 0) {
13215 if (cur_len > 0x7) {
13216 cur_len = cur_len - (cur_len & 0x7);
13217 dma_length = cur_len;
13219 CTL_SIZE_8B(dma_length, cur_len);
13223 dma_length = cur_len;
13226 * If we had to allocate memory for this I/O, instead of using
13227 * the non-cached mirror memory, we'll need to flush the cache
13228 * before trying to DMA to the other controller.
13230 * We could end up doing this multiple times for the same
13231 * segment if we have a larger local segment than remote
13232 * segment. That shouldn't be an issue.
13234 if ((io->io_hdr.flags & CTL_FLAG_NO_DATASYNC) == 0) {
13236 * XXX KDM use bus_dmamap_sync() here.
13240 rq->size = dma_length;
13242 tmp_ptr = (uint8_t *)local_sglist[i].addr;
13243 tmp_ptr += local_used;
13245 /* Use physical addresses when talking to ISC hardware */
13246 if ((io->io_hdr.flags & CTL_FLAG_BUS_ADDR) == 0) {
13247 /* XXX KDM use busdma */
13249 rq->local = vtophys(tmp_ptr);
13252 rq->local = tmp_ptr;
13254 tmp_ptr = (uint8_t *)remote_sglist[j].addr;
13255 tmp_ptr += remote_used;
13256 rq->remote = tmp_ptr;
13258 rq->callback = NULL;
13260 local_used += cur_len;
13261 if (local_used >= local_sglist[i].len) {
13266 remote_used += cur_len;
13267 if (remote_used >= remote_sglist[j].len) {
13271 total_used += cur_len;
13273 if (total_used >= io->scsiio.kern_data_len)
13274 rq->callback = callback;
13276 if ((rq->size & 0x7) != 0) {
13277 printf("%s: warning: size %d is not on 8b boundary\n",
13278 __func__, rq->size);
13280 if (((uintptr_t)rq->local & 0x7) != 0) {
13281 printf("%s: warning: local %p not on 8b boundary\n",
13282 __func__, rq->local);
13284 if (((uintptr_t)rq->remote & 0x7) != 0) {
13285 printf("%s: warning: remote %p not on 8b boundary\n",
13286 __func__, rq->local);
13289 printf("%s: %s: local %#x remote %#x size %d\n", __func__,
13290 (command == CTL_HA_DT_CMD_WRITE) ? "WRITE" : "READ",
13291 rq->local, rq->remote, rq->size);
13294 isc_ret = ctl_dt_single(rq);
13295 if (isc_ret == CTL_HA_STATUS_WAIT)
13298 if (isc_ret == CTL_HA_STATUS_DISCONNECT) {
13299 rq->ret = CTL_HA_STATUS_SUCCESS;
13313 ctl_datamove_remote_read(union ctl_io *io)
13319 * This will send an error to the other controller in the case of a
13322 retval = ctl_datamove_remote_sgl_setup(io);
13326 retval = ctl_datamove_remote_xfer(io, CTL_HA_DT_CMD_READ,
13327 ctl_datamove_remote_read_cb);
13329 && ((io->io_hdr.flags & CTL_FLAG_AUTO_MIRROR) == 0)) {
13331 * Make sure we free memory if there was an error.. The
13332 * ctl_datamove_remote_xfer() function will send the
13333 * datamove done message, or call the callback with an
13334 * error if there is a problem.
13336 for (i = 0; i < io->scsiio.kern_sg_entries; i++)
13337 free(io->io_hdr.local_sglist[i].addr, M_CTL);
13344 * Process a datamove request from the other controller. This is used for
13345 * XFER mode only, not SER_ONLY mode. For writes, we DMA into local memory
13346 * first. Once that is complete, the data gets DMAed into the remote
13347 * controller's memory. For reads, we DMA from the remote controller's
13348 * memory into our memory first, and then move it out to the FETD.
13351 ctl_datamove_remote(union ctl_io *io)
13353 struct ctl_softc *softc;
13355 softc = control_softc;
13357 mtx_assert(&softc->ctl_lock, MA_NOTOWNED);
13360 * Note that we look for an aborted I/O here, but don't do some of
13361 * the other checks that ctl_datamove() normally does.
13362 * We don't need to run the datamove delay code, since that should
13363 * have been done if need be on the other controller.
13365 if (io->io_hdr.flags & CTL_FLAG_ABORT) {
13366 printf("%s: tag 0x%04x on (%d:%d:%d:%d) aborted\n", __func__,
13367 io->scsiio.tag_num, io->io_hdr.nexus.initid.id,
13368 io->io_hdr.nexus.targ_port,
13369 io->io_hdr.nexus.targ_target.id,
13370 io->io_hdr.nexus.targ_lun);
13371 io->io_hdr.port_status = 31338;
13372 ctl_send_datamove_done(io, /*have_lock*/ 0);
13376 if ((io->io_hdr.flags & CTL_FLAG_DATA_MASK) == CTL_FLAG_DATA_OUT) {
13377 ctl_datamove_remote_write(io);
13378 } else if ((io->io_hdr.flags & CTL_FLAG_DATA_MASK) == CTL_FLAG_DATA_IN){
13379 ctl_datamove_remote_read(io);
13381 union ctl_ha_msg msg;
13382 struct scsi_sense_data *sense;
13386 memset(&msg, 0, sizeof(msg));
13388 msg.hdr.msg_type = CTL_MSG_BAD_JUJU;
13389 msg.hdr.status = CTL_SCSI_ERROR;
13390 msg.scsi.scsi_status = SCSI_STATUS_CHECK_COND;
13392 retry_count = 4243;
13394 sense = &msg.scsi.sense_data;
13395 sks[0] = SSD_SCS_VALID;
13396 sks[1] = (retry_count >> 8) & 0xff;
13397 sks[2] = retry_count & 0xff;
13399 /* "Internal target failure" */
13400 scsi_set_sense_data(sense,
13401 /*sense_format*/ SSD_TYPE_NONE,
13402 /*current_error*/ 1,
13403 /*sense_key*/ SSD_KEY_HARDWARE_ERROR,
13406 /*type*/ SSD_ELEM_SKS,
13407 /*size*/ sizeof(sks),
13411 io->io_hdr.flags &= ~CTL_FLAG_IO_ACTIVE;
13412 if (io->io_hdr.flags & CTL_FLAG_FAILOVER) {
13413 ctl_failover_io(io, /*have_lock*/ 1);
13417 if (ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg, sizeof(msg), 0) >
13418 CTL_HA_STATUS_SUCCESS) {
13419 /* XXX KDM what to do if this fails? */
13427 ctl_process_done(union ctl_io *io)
13429 struct ctl_lun *lun;
13430 struct ctl_softc *ctl_softc;
13431 void (*fe_done)(union ctl_io *io);
13432 uint32_t targ_port = ctl_port_idx(io->io_hdr.nexus.targ_port);
13434 CTL_DEBUG_PRINT(("ctl_process_done\n"));
13437 control_softc->ctl_ports[targ_port]->fe_done;
13440 if ((time_uptime - io->io_hdr.start_time) > ctl_time_io_secs) {
13445 ctl_scsi_path_string(io, path_str, sizeof(path_str));
13446 sbuf_new(&sb, str, sizeof(str), SBUF_FIXEDLEN);
13448 sbuf_cat(&sb, path_str);
13449 switch (io->io_hdr.io_type) {
13451 ctl_scsi_command_string(&io->scsiio, NULL, &sb);
13452 sbuf_printf(&sb, "\n");
13453 sbuf_cat(&sb, path_str);
13454 sbuf_printf(&sb, "Tag: 0x%04x, type %d\n",
13455 io->scsiio.tag_num, io->scsiio.tag_type);
13458 sbuf_printf(&sb, "Task I/O type: %d, Tag: 0x%04x, "
13459 "Tag Type: %d\n", io->taskio.task_action,
13460 io->taskio.tag_num, io->taskio.tag_type);
13463 printf("Invalid CTL I/O type %d\n", io->io_hdr.io_type);
13464 panic("Invalid CTL I/O type %d\n", io->io_hdr.io_type);
13467 sbuf_cat(&sb, path_str);
13468 sbuf_printf(&sb, "ctl_process_done: %jd seconds\n",
13469 (intmax_t)time_uptime - io->io_hdr.start_time);
13471 printf("%s", sbuf_data(&sb));
13473 #endif /* CTL_TIME_IO */
13475 switch (io->io_hdr.io_type) {
13479 if (bootverbose || verbose > 0)
13480 ctl_io_error_print(io, NULL);
13481 if (io->io_hdr.flags & CTL_FLAG_FROM_OTHER_SC)
13485 return (CTL_RETVAL_COMPLETE);
13488 printf("ctl_process_done: invalid io type %d\n",
13489 io->io_hdr.io_type);
13490 panic("ctl_process_done: invalid io type %d\n",
13491 io->io_hdr.io_type);
13492 break; /* NOTREACHED */
13495 lun = (struct ctl_lun *)io->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
13497 CTL_DEBUG_PRINT(("NULL LUN for lun %d\n",
13498 io->io_hdr.nexus.targ_mapped_lun));
13502 ctl_softc = lun->ctl_softc;
13504 mtx_lock(&lun->lun_lock);
13507 * Check to see if we have any errors to inject here. We only
13508 * inject errors for commands that don't already have errors set.
13510 if ((STAILQ_FIRST(&lun->error_list) != NULL)
13511 && ((io->io_hdr.status & CTL_STATUS_MASK) == CTL_SUCCESS))
13512 ctl_inject_error(lun, io);
13515 * XXX KDM how do we treat commands that aren't completed
13518 * XXX KDM should we also track I/O latency?
13520 if ((io->io_hdr.status & CTL_STATUS_MASK) == CTL_SUCCESS &&
13521 io->io_hdr.io_type == CTL_IO_SCSI) {
13523 struct bintime cur_bt;
13527 if ((io->io_hdr.flags & CTL_FLAG_DATA_MASK) ==
13529 type = CTL_STATS_READ;
13530 else if ((io->io_hdr.flags & CTL_FLAG_DATA_MASK) ==
13532 type = CTL_STATS_WRITE;
13534 type = CTL_STATS_NO_IO;
13536 lun->stats.ports[targ_port].bytes[type] +=
13537 io->scsiio.kern_total_len;
13538 lun->stats.ports[targ_port].operations[type]++;
13540 bintime_add(&lun->stats.ports[targ_port].dma_time[type],
13541 &io->io_hdr.dma_bt);
13542 lun->stats.ports[targ_port].num_dmas[type] +=
13543 io->io_hdr.num_dmas;
13544 getbintime(&cur_bt);
13545 bintime_sub(&cur_bt, &io->io_hdr.start_bt);
13546 bintime_add(&lun->stats.ports[targ_port].time[type], &cur_bt);
13551 * Remove this from the OOA queue.
13553 TAILQ_REMOVE(&lun->ooa_queue, &io->io_hdr, ooa_links);
13556 * Run through the blocked queue on this LUN and see if anything
13557 * has become unblocked, now that this transaction is done.
13559 ctl_check_blocked(lun);
13562 * If the LUN has been invalidated, free it if there is nothing
13563 * left on its OOA queue.
13565 if ((lun->flags & CTL_LUN_INVALID)
13566 && TAILQ_EMPTY(&lun->ooa_queue)) {
13567 mtx_unlock(&lun->lun_lock);
13568 mtx_lock(&ctl_softc->ctl_lock);
13570 mtx_unlock(&ctl_softc->ctl_lock);
13572 mtx_unlock(&lun->lun_lock);
13575 * If this command has been aborted, make sure we set the status
13576 * properly. The FETD is responsible for freeing the I/O and doing
13577 * whatever it needs to do to clean up its state.
13579 if (io->io_hdr.flags & CTL_FLAG_ABORT)
13580 ctl_set_task_aborted(&io->scsiio);
13583 * We print out status for every task management command. For SCSI
13584 * commands, we filter out any unit attention errors; they happen
13585 * on every boot, and would clutter up the log. Note: task
13586 * management commands aren't printed here, they are printed above,
13587 * since they should never even make it down here.
13589 switch (io->io_hdr.io_type) {
13590 case CTL_IO_SCSI: {
13591 int error_code, sense_key, asc, ascq;
13595 if (((io->io_hdr.status & CTL_STATUS_MASK) == CTL_SCSI_ERROR)
13596 && (io->scsiio.scsi_status == SCSI_STATUS_CHECK_COND)) {
13598 * Since this is just for printing, no need to
13599 * show errors here.
13601 scsi_extract_sense_len(&io->scsiio.sense_data,
13602 io->scsiio.sense_len,
13607 /*show_errors*/ 0);
13610 if (((io->io_hdr.status & CTL_STATUS_MASK) != CTL_SUCCESS)
13611 && (((io->io_hdr.status & CTL_STATUS_MASK) != CTL_SCSI_ERROR)
13612 || (io->scsiio.scsi_status != SCSI_STATUS_CHECK_COND)
13613 || (sense_key != SSD_KEY_UNIT_ATTENTION))) {
13615 if ((time_uptime - ctl_softc->last_print_jiffies) <= 0){
13616 ctl_softc->skipped_prints++;
13618 uint32_t skipped_prints;
13620 skipped_prints = ctl_softc->skipped_prints;
13622 ctl_softc->skipped_prints = 0;
13623 ctl_softc->last_print_jiffies = time_uptime;
13625 if (skipped_prints > 0) {
13627 csevent_log(CSC_CTL | CSC_SHELF_SW |
13629 csevent_LogType_Trace,
13630 csevent_Severity_Information,
13631 csevent_AlertLevel_Green,
13632 csevent_FRU_Firmware,
13633 csevent_FRU_Unknown,
13634 "High CTL error volume, %d prints "
13635 "skipped", skipped_prints);
13638 if (bootverbose || verbose > 0)
13639 ctl_io_error_print(io, NULL);
13645 if (bootverbose || verbose > 0)
13646 ctl_io_error_print(io, NULL);
13653 * Tell the FETD or the other shelf controller we're done with this
13654 * command. Note that only SCSI commands get to this point. Task
13655 * management commands are completed above.
13657 * We only send status to the other controller if we're in XFER
13658 * mode. In SER_ONLY mode, the I/O is done on the controller that
13659 * received the I/O (from CTL's perspective), and so the status is
13662 * XXX KDM if we hold the lock here, we could cause a deadlock
13663 * if the frontend comes back in in this context to queue
13666 if ((ctl_softc->ha_mode == CTL_HA_MODE_XFER)
13667 && (io->io_hdr.flags & CTL_FLAG_FROM_OTHER_SC)) {
13668 union ctl_ha_msg msg;
13670 memset(&msg, 0, sizeof(msg));
13671 msg.hdr.msg_type = CTL_MSG_FINISH_IO;
13672 msg.hdr.original_sc = io->io_hdr.original_sc;
13673 msg.hdr.nexus = io->io_hdr.nexus;
13674 msg.hdr.status = io->io_hdr.status;
13675 msg.scsi.scsi_status = io->scsiio.scsi_status;
13676 msg.scsi.tag_num = io->scsiio.tag_num;
13677 msg.scsi.tag_type = io->scsiio.tag_type;
13678 msg.scsi.sense_len = io->scsiio.sense_len;
13679 msg.scsi.sense_residual = io->scsiio.sense_residual;
13680 msg.scsi.residual = io->scsiio.residual;
13681 memcpy(&msg.scsi.sense_data, &io->scsiio.sense_data,
13682 sizeof(io->scsiio.sense_data));
13684 * We copy this whether or not this is an I/O-related
13685 * command. Otherwise, we'd have to go and check to see
13686 * whether it's a read/write command, and it really isn't
13689 memcpy(&msg.scsi.lbalen,
13690 &io->io_hdr.ctl_private[CTL_PRIV_LBA_LEN].bytes,
13691 sizeof(msg.scsi.lbalen));
13693 if (ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg,
13694 sizeof(msg), 0) > CTL_HA_STATUS_SUCCESS) {
13695 /* XXX do something here */
13704 return (CTL_RETVAL_COMPLETE);
13709 * Front end should call this if it doesn't do autosense. When the request
13710 * sense comes back in from the initiator, we'll dequeue this and send it.
13713 ctl_queue_sense(union ctl_io *io)
13715 struct ctl_lun *lun;
13716 struct ctl_softc *ctl_softc;
13717 uint32_t initidx, targ_lun;
13719 ctl_softc = control_softc;
13721 CTL_DEBUG_PRINT(("ctl_queue_sense\n"));
13724 * LUN lookup will likely move to the ctl_work_thread() once we
13725 * have our new queueing infrastructure (that doesn't put things on
13726 * a per-LUN queue initially). That is so that we can handle
13727 * things like an INQUIRY to a LUN that we don't have enabled. We
13728 * can't deal with that right now.
13730 mtx_lock(&ctl_softc->ctl_lock);
13733 * If we don't have a LUN for this, just toss the sense
13736 targ_lun = io->io_hdr.nexus.targ_lun;
13737 targ_lun = ctl_map_lun(io->io_hdr.nexus.targ_port, targ_lun);
13738 if ((targ_lun < CTL_MAX_LUNS)
13739 && (ctl_softc->ctl_luns[targ_lun] != NULL))
13740 lun = ctl_softc->ctl_luns[targ_lun];
13744 initidx = ctl_get_initindex(&io->io_hdr.nexus);
13746 mtx_lock(&lun->lun_lock);
13748 * Already have CA set for this LUN...toss the sense information.
13750 if (ctl_is_set(lun->have_ca, initidx)) {
13751 mtx_unlock(&lun->lun_lock);
13755 memcpy(&lun->pending_sense[initidx], &io->scsiio.sense_data,
13756 ctl_min(sizeof(lun->pending_sense[initidx]),
13757 sizeof(io->scsiio.sense_data)));
13758 ctl_set_mask(lun->have_ca, initidx);
13759 mtx_unlock(&lun->lun_lock);
13762 mtx_unlock(&ctl_softc->ctl_lock);
13766 return (CTL_RETVAL_COMPLETE);
13771 * Primary command inlet from frontend ports. All SCSI and task I/O
13772 * requests must go through this function.
13775 ctl_queue(union ctl_io *io)
13777 struct ctl_softc *ctl_softc;
13779 CTL_DEBUG_PRINT(("ctl_queue cdb[0]=%02X\n", io->scsiio.cdb[0]));
13781 ctl_softc = control_softc;
13784 io->io_hdr.start_time = time_uptime;
13785 getbintime(&io->io_hdr.start_bt);
13786 #endif /* CTL_TIME_IO */
13788 /* Map FE-specific LUN ID into global one. */
13789 io->io_hdr.nexus.targ_mapped_lun =
13790 ctl_map_lun(io->io_hdr.nexus.targ_port, io->io_hdr.nexus.targ_lun);
13792 switch (io->io_hdr.io_type) {
13795 ctl_enqueue_incoming(io);
13798 printf("ctl_queue: unknown I/O type %d\n", io->io_hdr.io_type);
13802 return (CTL_RETVAL_COMPLETE);
13805 #ifdef CTL_IO_DELAY
13807 ctl_done_timer_wakeup(void *arg)
13811 io = (union ctl_io *)arg;
13814 #endif /* CTL_IO_DELAY */
13817 ctl_done(union ctl_io *io)
13819 struct ctl_softc *ctl_softc;
13821 ctl_softc = control_softc;
13824 * Enable this to catch duplicate completion issues.
13827 if (io->io_hdr.flags & CTL_FLAG_ALREADY_DONE) {
13828 printf("%s: type %d msg %d cdb %x iptl: "
13829 "%d:%d:%d:%d tag 0x%04x "
13830 "flag %#x status %x\n",
13832 io->io_hdr.io_type,
13833 io->io_hdr.msg_type,
13835 io->io_hdr.nexus.initid.id,
13836 io->io_hdr.nexus.targ_port,
13837 io->io_hdr.nexus.targ_target.id,
13838 io->io_hdr.nexus.targ_lun,
13839 (io->io_hdr.io_type ==
13841 io->taskio.tag_num :
13842 io->scsiio.tag_num,
13844 io->io_hdr.status);
13846 io->io_hdr.flags |= CTL_FLAG_ALREADY_DONE;
13850 * This is an internal copy of an I/O, and should not go through
13851 * the normal done processing logic.
13853 if (io->io_hdr.flags & CTL_FLAG_INT_COPY)
13857 * We need to send a msg to the serializing shelf to finish the IO
13858 * as well. We don't send a finish message to the other shelf if
13859 * this is a task management command. Task management commands
13860 * aren't serialized in the OOA queue, but rather just executed on
13861 * both shelf controllers for commands that originated on that
13864 if ((io->io_hdr.flags & CTL_FLAG_SENT_2OTHER_SC)
13865 && (io->io_hdr.io_type != CTL_IO_TASK)) {
13866 union ctl_ha_msg msg_io;
13868 msg_io.hdr.msg_type = CTL_MSG_FINISH_IO;
13869 msg_io.hdr.serializing_sc = io->io_hdr.serializing_sc;
13870 if (ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg_io,
13871 sizeof(msg_io), 0 ) != CTL_HA_STATUS_SUCCESS) {
13873 /* continue on to finish IO */
13875 #ifdef CTL_IO_DELAY
13876 if (io->io_hdr.flags & CTL_FLAG_DELAY_DONE) {
13877 struct ctl_lun *lun;
13879 lun =(struct ctl_lun *)io->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
13881 io->io_hdr.flags &= ~CTL_FLAG_DELAY_DONE;
13883 struct ctl_lun *lun;
13885 lun =(struct ctl_lun *)io->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
13888 && (lun->delay_info.done_delay > 0)) {
13889 struct callout *callout;
13891 callout = (struct callout *)&io->io_hdr.timer_bytes;
13892 callout_init(callout, /*mpsafe*/ 1);
13893 io->io_hdr.flags |= CTL_FLAG_DELAY_DONE;
13894 callout_reset(callout,
13895 lun->delay_info.done_delay * hz,
13896 ctl_done_timer_wakeup, io);
13897 if (lun->delay_info.done_type == CTL_DELAY_TYPE_ONESHOT)
13898 lun->delay_info.done_delay = 0;
13902 #endif /* CTL_IO_DELAY */
13904 ctl_enqueue_done(io);
13908 ctl_isc(struct ctl_scsiio *ctsio)
13910 struct ctl_lun *lun;
13913 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
13915 CTL_DEBUG_PRINT(("ctl_isc: command: %02x\n", ctsio->cdb[0]));
13917 CTL_DEBUG_PRINT(("ctl_isc: calling data_submit()\n"));
13919 retval = lun->backend->data_submit((union ctl_io *)ctsio);
13926 ctl_work_thread(void *arg)
13928 struct ctl_thread *thr = (struct ctl_thread *)arg;
13929 struct ctl_softc *softc = thr->ctl_softc;
13933 CTL_DEBUG_PRINT(("ctl_work_thread starting\n"));
13939 * We handle the queues in this order:
13941 * - done queue (to free up resources, unblock other commands)
13945 * If those queues are empty, we break out of the loop and
13948 mtx_lock(&thr->queue_lock);
13949 io = (union ctl_io *)STAILQ_FIRST(&thr->isc_queue);
13951 STAILQ_REMOVE_HEAD(&thr->isc_queue, links);
13952 mtx_unlock(&thr->queue_lock);
13953 ctl_handle_isc(io);
13956 io = (union ctl_io *)STAILQ_FIRST(&thr->done_queue);
13958 STAILQ_REMOVE_HEAD(&thr->done_queue, links);
13959 /* clear any blocked commands, call fe_done */
13960 mtx_unlock(&thr->queue_lock);
13961 retval = ctl_process_done(io);
13964 io = (union ctl_io *)STAILQ_FIRST(&thr->incoming_queue);
13966 STAILQ_REMOVE_HEAD(&thr->incoming_queue, links);
13967 mtx_unlock(&thr->queue_lock);
13968 if (io->io_hdr.io_type == CTL_IO_TASK)
13971 ctl_scsiio_precheck(softc, &io->scsiio);
13974 if (!ctl_pause_rtr) {
13975 io = (union ctl_io *)STAILQ_FIRST(&thr->rtr_queue);
13977 STAILQ_REMOVE_HEAD(&thr->rtr_queue, links);
13978 mtx_unlock(&thr->queue_lock);
13979 retval = ctl_scsiio(&io->scsiio);
13980 if (retval != CTL_RETVAL_COMPLETE)
13981 CTL_DEBUG_PRINT(("ctl_scsiio failed\n"));
13986 /* Sleep until we have something to do. */
13987 mtx_sleep(thr, &thr->queue_lock, PDROP | PRIBIO, "-", 0);
13992 ctl_lun_thread(void *arg)
13994 struct ctl_softc *softc = (struct ctl_softc *)arg;
13995 struct ctl_be_lun *be_lun;
13998 CTL_DEBUG_PRINT(("ctl_lun_thread starting\n"));
14002 mtx_lock(&softc->ctl_lock);
14003 be_lun = STAILQ_FIRST(&softc->pending_lun_queue);
14004 if (be_lun != NULL) {
14005 STAILQ_REMOVE_HEAD(&softc->pending_lun_queue, links);
14006 mtx_unlock(&softc->ctl_lock);
14007 ctl_create_lun(be_lun);
14011 /* Sleep until we have something to do. */
14012 mtx_sleep(&softc->pending_lun_queue, &softc->ctl_lock,
14013 PDROP | PRIBIO, "-", 0);
14018 ctl_enqueue_incoming(union ctl_io *io)
14020 struct ctl_softc *softc = control_softc;
14021 struct ctl_thread *thr;
14024 idx = (io->io_hdr.nexus.targ_port * 127 +
14025 io->io_hdr.nexus.initid.id) % worker_threads;
14026 thr = &softc->threads[idx];
14027 mtx_lock(&thr->queue_lock);
14028 STAILQ_INSERT_TAIL(&thr->incoming_queue, &io->io_hdr, links);
14029 mtx_unlock(&thr->queue_lock);
14034 ctl_enqueue_rtr(union ctl_io *io)
14036 struct ctl_softc *softc = control_softc;
14037 struct ctl_thread *thr;
14039 thr = &softc->threads[io->io_hdr.nexus.targ_mapped_lun % worker_threads];
14040 mtx_lock(&thr->queue_lock);
14041 STAILQ_INSERT_TAIL(&thr->rtr_queue, &io->io_hdr, links);
14042 mtx_unlock(&thr->queue_lock);
14047 ctl_enqueue_done(union ctl_io *io)
14049 struct ctl_softc *softc = control_softc;
14050 struct ctl_thread *thr;
14052 thr = &softc->threads[io->io_hdr.nexus.targ_mapped_lun % worker_threads];
14053 mtx_lock(&thr->queue_lock);
14054 STAILQ_INSERT_TAIL(&thr->done_queue, &io->io_hdr, links);
14055 mtx_unlock(&thr->queue_lock);
14060 ctl_enqueue_isc(union ctl_io *io)
14062 struct ctl_softc *softc = control_softc;
14063 struct ctl_thread *thr;
14065 thr = &softc->threads[io->io_hdr.nexus.targ_mapped_lun % worker_threads];
14066 mtx_lock(&thr->queue_lock);
14067 STAILQ_INSERT_TAIL(&thr->isc_queue, &io->io_hdr, links);
14068 mtx_unlock(&thr->queue_lock);
14072 /* Initialization and failover */
14075 ctl_init_isc_msg(void)
14077 printf("CTL: Still calling this thing\n");
14082 * Initializes component into configuration defined by bootMode
14084 * returns hasc_Status:
14086 * ERROR - fatal error
14088 static ctl_ha_comp_status
14089 ctl_isc_init(struct ctl_ha_component *c)
14091 ctl_ha_comp_status ret = CTL_HA_COMP_STATUS_OK;
14098 * Starts component in state requested. If component starts successfully,
14099 * it must set its own state to the requestrd state
14100 * When requested state is HASC_STATE_HA, the component may refine it
14101 * by adding _SLAVE or _MASTER flags.
14102 * Currently allowed state transitions are:
14103 * UNKNOWN->HA - initial startup
14104 * UNKNOWN->SINGLE - initial startup when no parter detected
14105 * HA->SINGLE - failover
14106 * returns ctl_ha_comp_status:
14107 * OK - component successfully started in requested state
14108 * FAILED - could not start the requested state, failover may
14110 * ERROR - fatal error detected, no future startup possible
14112 static ctl_ha_comp_status
14113 ctl_isc_start(struct ctl_ha_component *c, ctl_ha_state state)
14115 ctl_ha_comp_status ret = CTL_HA_COMP_STATUS_OK;
14117 printf("%s: go\n", __func__);
14119 // UNKNOWN->HA or UNKNOWN->SINGLE (bootstrap)
14120 if (c->state == CTL_HA_STATE_UNKNOWN ) {
14122 if (ctl_ha_msg_create(CTL_HA_CHAN_CTL, ctl_isc_event_handler)
14123 != CTL_HA_STATUS_SUCCESS) {
14124 printf("ctl_isc_start: ctl_ha_msg_create failed.\n");
14125 ret = CTL_HA_COMP_STATUS_ERROR;
14127 } else if (CTL_HA_STATE_IS_HA(c->state)
14128 && CTL_HA_STATE_IS_SINGLE(state)){
14129 // HA->SINGLE transition
14133 printf("ctl_isc_start:Invalid state transition %X->%X\n",
14135 ret = CTL_HA_COMP_STATUS_ERROR;
14137 if (CTL_HA_STATE_IS_SINGLE(state))
14146 * Quiesce component
14147 * The component must clear any error conditions (set status to OK) and
14148 * prepare itself to another Start call
14149 * returns ctl_ha_comp_status:
14153 static ctl_ha_comp_status
14154 ctl_isc_quiesce(struct ctl_ha_component *c)
14156 int ret = CTL_HA_COMP_STATUS_OK;
14163 struct ctl_ha_component ctl_ha_component_ctlisc =
14166 .state = CTL_HA_STATE_UNKNOWN,
14167 .init = ctl_isc_init,
14168 .start = ctl_isc_start,
14169 .quiesce = ctl_isc_quiesce