2 * Copyright (c) 2003-2009 Silicon Graphics International Corp.
3 * Copyright (c) 2012 The FreeBSD Foundation
4 * Copyright (c) 2015 Alexander Motin <mav@FreeBSD.org>
7 * Portions of this software were developed by Edward Tomasz Napierala
8 * under sponsorship from the FreeBSD Foundation.
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions, and the following disclaimer,
15 * without modification.
16 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
17 * substantially similar to the "NO WARRANTY" disclaimer below
18 * ("Disclaimer") and any redistribution must be conditioned upon
19 * including a substantially similar Disclaimer requirement for further
20 * binary redistribution.
23 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
24 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
25 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
26 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
27 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
31 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
32 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
33 * POSSIBILITY OF SUCH DAMAGES.
38 * CAM Target Layer, a SCSI device emulation subsystem.
40 * Author: Ken Merry <ken@FreeBSD.org>
45 #include <sys/cdefs.h>
46 __FBSDID("$FreeBSD$");
48 #include <sys/param.h>
49 #include <sys/systm.h>
50 #include <sys/ctype.h>
51 #include <sys/kernel.h>
52 #include <sys/types.h>
53 #include <sys/kthread.h>
55 #include <sys/fcntl.h>
57 #include <sys/module.h>
58 #include <sys/mutex.h>
59 #include <sys/condvar.h>
60 #include <sys/malloc.h>
62 #include <sys/ioccom.h>
63 #include <sys/queue.h>
66 #include <sys/endian.h>
67 #include <sys/sysctl.h>
71 #include <cam/scsi/scsi_all.h>
72 #include <cam/scsi/scsi_cd.h>
73 #include <cam/scsi/scsi_da.h>
74 #include <cam/ctl/ctl_io.h>
75 #include <cam/ctl/ctl.h>
76 #include <cam/ctl/ctl_frontend.h>
77 #include <cam/ctl/ctl_util.h>
78 #include <cam/ctl/ctl_backend.h>
79 #include <cam/ctl/ctl_ioctl.h>
80 #include <cam/ctl/ctl_ha.h>
81 #include <cam/ctl/ctl_private.h>
82 #include <cam/ctl/ctl_debug.h>
83 #include <cam/ctl/ctl_scsi_all.h>
84 #include <cam/ctl/ctl_error.h>
86 struct ctl_softc *control_softc = NULL;
89 * Template mode pages.
93 * Note that these are default values only. The actual values will be
94 * filled in when the user does a mode sense.
96 const static struct scsi_da_rw_recovery_page rw_er_page_default = {
97 /*page_code*/SMS_RW_ERROR_RECOVERY_PAGE,
98 /*page_length*/sizeof(struct scsi_da_rw_recovery_page) - 2,
99 /*byte3*/SMS_RWER_AWRE|SMS_RWER_ARRE,
100 /*read_retry_count*/0,
101 /*correction_span*/0,
102 /*head_offset_count*/0,
103 /*data_strobe_offset_cnt*/0,
104 /*byte8*/SMS_RWER_LBPERE,
105 /*write_retry_count*/0,
107 /*recovery_time_limit*/{0, 0},
110 const static struct scsi_da_rw_recovery_page rw_er_page_changeable = {
111 /*page_code*/SMS_RW_ERROR_RECOVERY_PAGE,
112 /*page_length*/sizeof(struct scsi_da_rw_recovery_page) - 2,
113 /*byte3*/SMS_RWER_PER,
114 /*read_retry_count*/0,
115 /*correction_span*/0,
116 /*head_offset_count*/0,
117 /*data_strobe_offset_cnt*/0,
118 /*byte8*/SMS_RWER_LBPERE,
119 /*write_retry_count*/0,
121 /*recovery_time_limit*/{0, 0},
124 const static struct scsi_format_page format_page_default = {
125 /*page_code*/SMS_FORMAT_DEVICE_PAGE,
126 /*page_length*/sizeof(struct scsi_format_page) - 2,
127 /*tracks_per_zone*/ {0, 0},
128 /*alt_sectors_per_zone*/ {0, 0},
129 /*alt_tracks_per_zone*/ {0, 0},
130 /*alt_tracks_per_lun*/ {0, 0},
131 /*sectors_per_track*/ {(CTL_DEFAULT_SECTORS_PER_TRACK >> 8) & 0xff,
132 CTL_DEFAULT_SECTORS_PER_TRACK & 0xff},
133 /*bytes_per_sector*/ {0, 0},
134 /*interleave*/ {0, 0},
135 /*track_skew*/ {0, 0},
136 /*cylinder_skew*/ {0, 0},
138 /*reserved*/ {0, 0, 0}
141 const static struct scsi_format_page format_page_changeable = {
142 /*page_code*/SMS_FORMAT_DEVICE_PAGE,
143 /*page_length*/sizeof(struct scsi_format_page) - 2,
144 /*tracks_per_zone*/ {0, 0},
145 /*alt_sectors_per_zone*/ {0, 0},
146 /*alt_tracks_per_zone*/ {0, 0},
147 /*alt_tracks_per_lun*/ {0, 0},
148 /*sectors_per_track*/ {0, 0},
149 /*bytes_per_sector*/ {0, 0},
150 /*interleave*/ {0, 0},
151 /*track_skew*/ {0, 0},
152 /*cylinder_skew*/ {0, 0},
154 /*reserved*/ {0, 0, 0}
157 const static struct scsi_rigid_disk_page rigid_disk_page_default = {
158 /*page_code*/SMS_RIGID_DISK_PAGE,
159 /*page_length*/sizeof(struct scsi_rigid_disk_page) - 2,
160 /*cylinders*/ {0, 0, 0},
161 /*heads*/ CTL_DEFAULT_HEADS,
162 /*start_write_precomp*/ {0, 0, 0},
163 /*start_reduced_current*/ {0, 0, 0},
164 /*step_rate*/ {0, 0},
165 /*landing_zone_cylinder*/ {0, 0, 0},
166 /*rpl*/ SRDP_RPL_DISABLED,
167 /*rotational_offset*/ 0,
169 /*rotation_rate*/ {(CTL_DEFAULT_ROTATION_RATE >> 8) & 0xff,
170 CTL_DEFAULT_ROTATION_RATE & 0xff},
174 const static struct scsi_rigid_disk_page rigid_disk_page_changeable = {
175 /*page_code*/SMS_RIGID_DISK_PAGE,
176 /*page_length*/sizeof(struct scsi_rigid_disk_page) - 2,
177 /*cylinders*/ {0, 0, 0},
179 /*start_write_precomp*/ {0, 0, 0},
180 /*start_reduced_current*/ {0, 0, 0},
181 /*step_rate*/ {0, 0},
182 /*landing_zone_cylinder*/ {0, 0, 0},
184 /*rotational_offset*/ 0,
186 /*rotation_rate*/ {0, 0},
190 const static struct scsi_da_verify_recovery_page verify_er_page_default = {
191 /*page_code*/SMS_VERIFY_ERROR_RECOVERY_PAGE,
192 /*page_length*/sizeof(struct scsi_da_verify_recovery_page) - 2,
194 /*read_retry_count*/0,
195 /*reserved*/{ 0, 0, 0, 0, 0, 0 },
196 /*recovery_time_limit*/{0, 0},
199 const static struct scsi_da_verify_recovery_page verify_er_page_changeable = {
200 /*page_code*/SMS_VERIFY_ERROR_RECOVERY_PAGE,
201 /*page_length*/sizeof(struct scsi_da_verify_recovery_page) - 2,
202 /*byte3*/SMS_VER_PER,
203 /*read_retry_count*/0,
204 /*reserved*/{ 0, 0, 0, 0, 0, 0 },
205 /*recovery_time_limit*/{0, 0},
208 const static struct scsi_caching_page caching_page_default = {
209 /*page_code*/SMS_CACHING_PAGE,
210 /*page_length*/sizeof(struct scsi_caching_page) - 2,
211 /*flags1*/ SCP_DISC | SCP_WCE,
213 /*disable_pf_transfer_len*/ {0xff, 0xff},
214 /*min_prefetch*/ {0, 0},
215 /*max_prefetch*/ {0xff, 0xff},
216 /*max_pf_ceiling*/ {0xff, 0xff},
218 /*cache_segments*/ 0,
219 /*cache_seg_size*/ {0, 0},
221 /*non_cache_seg_size*/ {0, 0, 0}
224 const static struct scsi_caching_page caching_page_changeable = {
225 /*page_code*/SMS_CACHING_PAGE,
226 /*page_length*/sizeof(struct scsi_caching_page) - 2,
227 /*flags1*/ SCP_WCE | SCP_RCD,
229 /*disable_pf_transfer_len*/ {0, 0},
230 /*min_prefetch*/ {0, 0},
231 /*max_prefetch*/ {0, 0},
232 /*max_pf_ceiling*/ {0, 0},
234 /*cache_segments*/ 0,
235 /*cache_seg_size*/ {0, 0},
237 /*non_cache_seg_size*/ {0, 0, 0}
240 const static struct scsi_control_page control_page_default = {
241 /*page_code*/SMS_CONTROL_MODE_PAGE,
242 /*page_length*/sizeof(struct scsi_control_page) - 2,
244 /*queue_flags*/SCP_QUEUE_ALG_RESTRICTED,
247 /*aen_holdoff_period*/{0, 0},
248 /*busy_timeout_period*/{0, 0},
249 /*extended_selftest_completion_time*/{0, 0}
252 const static struct scsi_control_page control_page_changeable = {
253 /*page_code*/SMS_CONTROL_MODE_PAGE,
254 /*page_length*/sizeof(struct scsi_control_page) - 2,
256 /*queue_flags*/SCP_QUEUE_ALG_MASK | SCP_NUAR,
257 /*eca_and_aen*/SCP_SWP,
259 /*aen_holdoff_period*/{0, 0},
260 /*busy_timeout_period*/{0, 0},
261 /*extended_selftest_completion_time*/{0, 0}
264 #define CTL_CEM_LEN (sizeof(struct scsi_control_ext_page) - 4)
266 const static struct scsi_control_ext_page control_ext_page_default = {
267 /*page_code*/SMS_CONTROL_MODE_PAGE | SMPH_SPF,
268 /*subpage_code*/0x01,
269 /*page_length*/{CTL_CEM_LEN >> 8, CTL_CEM_LEN},
275 const static struct scsi_control_ext_page control_ext_page_changeable = {
276 /*page_code*/SMS_CONTROL_MODE_PAGE | SMPH_SPF,
277 /*subpage_code*/0x01,
278 /*page_length*/{CTL_CEM_LEN >> 8, CTL_CEM_LEN},
284 const static struct scsi_info_exceptions_page ie_page_default = {
285 /*page_code*/SMS_INFO_EXCEPTIONS_PAGE,
286 /*page_length*/sizeof(struct scsi_info_exceptions_page) - 2,
287 /*info_flags*/SIEP_FLAGS_EWASC,
288 /*mrie*/SIEP_MRIE_NO,
289 /*interval_timer*/{0, 0, 0, 0},
290 /*report_count*/{0, 0, 0, 1}
293 const static struct scsi_info_exceptions_page ie_page_changeable = {
294 /*page_code*/SMS_INFO_EXCEPTIONS_PAGE,
295 /*page_length*/sizeof(struct scsi_info_exceptions_page) - 2,
296 /*info_flags*/SIEP_FLAGS_EWASC | SIEP_FLAGS_DEXCPT | SIEP_FLAGS_TEST |
299 /*interval_timer*/{0xff, 0xff, 0xff, 0xff},
300 /*report_count*/{0xff, 0xff, 0xff, 0xff}
303 #define CTL_LBPM_LEN (sizeof(struct ctl_logical_block_provisioning_page) - 4)
305 const static struct ctl_logical_block_provisioning_page lbp_page_default = {{
306 /*page_code*/SMS_INFO_EXCEPTIONS_PAGE | SMPH_SPF,
307 /*subpage_code*/0x02,
308 /*page_length*/{CTL_LBPM_LEN >> 8, CTL_LBPM_LEN},
310 /*reserved*/{0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0},
315 /*count*/{0, 0, 0, 0}},
319 /*count*/{0, 0, 0, 0}},
323 /*count*/{0, 0, 0, 0}},
327 /*count*/{0, 0, 0, 0}}
331 const static struct ctl_logical_block_provisioning_page lbp_page_changeable = {{
332 /*page_code*/SMS_INFO_EXCEPTIONS_PAGE | SMPH_SPF,
333 /*subpage_code*/0x02,
334 /*page_length*/{CTL_LBPM_LEN >> 8, CTL_LBPM_LEN},
335 /*flags*/SLBPP_SITUA,
336 /*reserved*/{0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0},
341 /*count*/{0, 0, 0, 0}},
345 /*count*/{0, 0, 0, 0}},
349 /*count*/{0, 0, 0, 0}},
353 /*count*/{0, 0, 0, 0}}
357 const static struct scsi_cddvd_capabilities_page cddvd_page_default = {
358 /*page_code*/SMS_CDDVD_CAPS_PAGE,
359 /*page_length*/sizeof(struct scsi_cddvd_capabilities_page) - 2,
367 /*nvol_levels*/{0, 0},
368 /*buffer_size*/{8, 0},
373 /*copy_management*/0,
375 /*rotation_control*/0,
376 /*cur_write_speed*/0,
377 /*num_speed_descr*/0,
380 const static struct scsi_cddvd_capabilities_page cddvd_page_changeable = {
381 /*page_code*/SMS_CDDVD_CAPS_PAGE,
382 /*page_length*/sizeof(struct scsi_cddvd_capabilities_page) - 2,
390 /*nvol_levels*/{0, 0},
391 /*buffer_size*/{0, 0},
396 /*copy_management*/0,
398 /*rotation_control*/0,
399 /*cur_write_speed*/0,
400 /*num_speed_descr*/0,
403 SYSCTL_NODE(_kern_cam, OID_AUTO, ctl, CTLFLAG_RD, 0, "CAM Target Layer");
404 static int worker_threads = -1;
405 TUNABLE_INT("kern.cam.ctl.worker_threads", &worker_threads);
406 SYSCTL_INT(_kern_cam_ctl, OID_AUTO, worker_threads, CTLFLAG_RDTUN,
407 &worker_threads, 1, "Number of worker threads");
408 static int ctl_debug = CTL_DEBUG_NONE;
409 TUNABLE_INT("kern.cam.ctl.debug", &ctl_debug);
410 SYSCTL_INT(_kern_cam_ctl, OID_AUTO, debug, CTLFLAG_RWTUN,
411 &ctl_debug, 0, "Enabled debug flags");
414 * Supported pages (0x00), Serial number (0x80), Device ID (0x83),
415 * Extended INQUIRY Data (0x86), Mode Page Policy (0x87),
416 * SCSI Ports (0x88), Third-party Copy (0x8F), Block limits (0xB0),
417 * Block Device Characteristics (0xB1) and Logical Block Provisioning (0xB2)
419 #define SCSI_EVPD_NUM_SUPPORTED_PAGES 10
421 static void ctl_isc_event_handler(ctl_ha_channel chanel, ctl_ha_event event,
423 static void ctl_copy_sense_data(union ctl_ha_msg *src, union ctl_io *dest);
424 static void ctl_copy_sense_data_back(union ctl_io *src, union ctl_ha_msg *dest);
425 static int ctl_init(void);
426 void ctl_shutdown(void);
427 static int ctl_open(struct cdev *dev, int flags, int fmt, struct thread *td);
428 static int ctl_close(struct cdev *dev, int flags, int fmt, struct thread *td);
429 static int ctl_serialize_other_sc_cmd(struct ctl_scsiio *ctsio);
430 static void ctl_ioctl_fill_ooa(struct ctl_lun *lun, uint32_t *cur_fill_num,
431 struct ctl_ooa *ooa_hdr,
432 struct ctl_ooa_entry *kern_entries);
433 static int ctl_ioctl(struct cdev *dev, u_long cmd, caddr_t addr, int flag,
435 static int ctl_alloc_lun(struct ctl_softc *ctl_softc, struct ctl_lun *lun,
436 struct ctl_be_lun *be_lun);
437 static int ctl_free_lun(struct ctl_lun *lun);
438 static void ctl_create_lun(struct ctl_be_lun *be_lun);
439 static struct ctl_port * ctl_io_port(struct ctl_io_hdr *io_hdr);
441 static int ctl_do_mode_select(union ctl_io *io);
442 static int ctl_pro_preempt(struct ctl_softc *softc, struct ctl_lun *lun,
443 uint64_t res_key, uint64_t sa_res_key,
444 uint8_t type, uint32_t residx,
445 struct ctl_scsiio *ctsio,
446 struct scsi_per_res_out *cdb,
447 struct scsi_per_res_out_parms* param);
448 static void ctl_pro_preempt_other(struct ctl_lun *lun,
449 union ctl_ha_msg *msg);
450 static void ctl_hndl_per_res_out_on_other_sc(union ctl_ha_msg *msg);
451 static int ctl_inquiry_evpd_supported(struct ctl_scsiio *ctsio, int alloc_len);
452 static int ctl_inquiry_evpd_serial(struct ctl_scsiio *ctsio, int alloc_len);
453 static int ctl_inquiry_evpd_devid(struct ctl_scsiio *ctsio, int alloc_len);
454 static int ctl_inquiry_evpd_eid(struct ctl_scsiio *ctsio, int alloc_len);
455 static int ctl_inquiry_evpd_mpp(struct ctl_scsiio *ctsio, int alloc_len);
456 static int ctl_inquiry_evpd_scsi_ports(struct ctl_scsiio *ctsio,
458 static int ctl_inquiry_evpd_block_limits(struct ctl_scsiio *ctsio,
460 static int ctl_inquiry_evpd_bdc(struct ctl_scsiio *ctsio, int alloc_len);
461 static int ctl_inquiry_evpd_lbp(struct ctl_scsiio *ctsio, int alloc_len);
462 static int ctl_inquiry_evpd(struct ctl_scsiio *ctsio);
463 static int ctl_inquiry_std(struct ctl_scsiio *ctsio);
464 static int ctl_get_lba_len(union ctl_io *io, uint64_t *lba, uint64_t *len);
465 static ctl_action ctl_extent_check(union ctl_io *io1, union ctl_io *io2,
467 static ctl_action ctl_extent_check_seq(union ctl_io *io1, union ctl_io *io2);
468 static ctl_action ctl_check_for_blockage(struct ctl_lun *lun,
469 union ctl_io *pending_io, union ctl_io *ooa_io);
470 static ctl_action ctl_check_ooa(struct ctl_lun *lun, union ctl_io *pending_io,
471 union ctl_io *starting_io);
472 static int ctl_check_blocked(struct ctl_lun *lun);
473 static int ctl_scsiio_lun_check(struct ctl_lun *lun,
474 const struct ctl_cmd_entry *entry,
475 struct ctl_scsiio *ctsio);
476 static void ctl_failover_lun(union ctl_io *io);
477 static int ctl_scsiio_precheck(struct ctl_softc *ctl_softc,
478 struct ctl_scsiio *ctsio);
479 static int ctl_scsiio(struct ctl_scsiio *ctsio);
481 static int ctl_bus_reset(struct ctl_softc *ctl_softc, union ctl_io *io);
482 static int ctl_target_reset(struct ctl_softc *ctl_softc, union ctl_io *io,
483 ctl_ua_type ua_type);
484 static int ctl_do_lun_reset(struct ctl_lun *lun, union ctl_io *io,
485 ctl_ua_type ua_type);
486 static int ctl_lun_reset(struct ctl_softc *ctl_softc, union ctl_io *io);
487 static int ctl_abort_task(union ctl_io *io);
488 static int ctl_abort_task_set(union ctl_io *io);
489 static int ctl_query_task(union ctl_io *io, int task_set);
490 static int ctl_i_t_nexus_reset(union ctl_io *io);
491 static int ctl_query_async_event(union ctl_io *io);
492 static void ctl_run_task(union ctl_io *io);
494 static void ctl_datamove_timer_wakeup(void *arg);
495 static void ctl_done_timer_wakeup(void *arg);
496 #endif /* CTL_IO_DELAY */
498 static void ctl_send_datamove_done(union ctl_io *io, int have_lock);
499 static void ctl_datamove_remote_write_cb(struct ctl_ha_dt_req *rq);
500 static int ctl_datamove_remote_dm_write_cb(union ctl_io *io);
501 static void ctl_datamove_remote_write(union ctl_io *io);
502 static int ctl_datamove_remote_dm_read_cb(union ctl_io *io);
503 static void ctl_datamove_remote_read_cb(struct ctl_ha_dt_req *rq);
504 static int ctl_datamove_remote_sgl_setup(union ctl_io *io);
505 static int ctl_datamove_remote_xfer(union ctl_io *io, unsigned command,
506 ctl_ha_dt_cb callback);
507 static void ctl_datamove_remote_read(union ctl_io *io);
508 static void ctl_datamove_remote(union ctl_io *io);
509 static void ctl_process_done(union ctl_io *io);
510 static void ctl_lun_thread(void *arg);
511 static void ctl_thresh_thread(void *arg);
512 static void ctl_work_thread(void *arg);
513 static void ctl_enqueue_incoming(union ctl_io *io);
514 static void ctl_enqueue_rtr(union ctl_io *io);
515 static void ctl_enqueue_done(union ctl_io *io);
516 static void ctl_enqueue_isc(union ctl_io *io);
517 static const struct ctl_cmd_entry *
518 ctl_get_cmd_entry(struct ctl_scsiio *ctsio, int *sa);
519 static const struct ctl_cmd_entry *
520 ctl_validate_command(struct ctl_scsiio *ctsio);
521 static int ctl_cmd_applicable(uint8_t lun_type,
522 const struct ctl_cmd_entry *entry);
524 static uint64_t ctl_get_prkey(struct ctl_lun *lun, uint32_t residx);
525 static void ctl_clr_prkey(struct ctl_lun *lun, uint32_t residx);
526 static void ctl_alloc_prkey(struct ctl_lun *lun, uint32_t residx);
527 static void ctl_set_prkey(struct ctl_lun *lun, uint32_t residx, uint64_t key);
530 * Load the serialization table. This isn't very pretty, but is probably
531 * the easiest way to do it.
533 #include "ctl_ser_table.c"
536 * We only need to define open, close and ioctl routines for this driver.
538 static struct cdevsw ctl_cdevsw = {
539 .d_version = D_VERSION,
542 .d_close = ctl_close,
543 .d_ioctl = ctl_ioctl,
548 MALLOC_DEFINE(M_CTL, "ctlmem", "Memory used for CTL");
550 static int ctl_module_event_handler(module_t, int /*modeventtype_t*/, void *);
552 static moduledata_t ctl_moduledata = {
554 ctl_module_event_handler,
558 DECLARE_MODULE(ctl, ctl_moduledata, SI_SUB_CONFIGURE, SI_ORDER_THIRD);
559 MODULE_VERSION(ctl, 1);
561 static struct ctl_frontend ha_frontend =
567 ctl_ha_datamove(union ctl_io *io)
570 struct ctl_sg_entry *sgl;
571 union ctl_ha_msg msg;
572 uint32_t sg_entries_sent;
573 int do_sg_copy, i, j;
575 lun = (struct ctl_lun *)io->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
576 memset(&msg.dt, 0, sizeof(msg.dt));
577 msg.hdr.msg_type = CTL_MSG_DATAMOVE;
578 msg.hdr.original_sc = io->io_hdr.original_sc;
579 msg.hdr.serializing_sc = io;
580 msg.hdr.nexus = io->io_hdr.nexus;
581 msg.hdr.status = io->io_hdr.status;
582 msg.dt.flags = io->io_hdr.flags;
585 * We convert everything into a S/G list here. We can't
586 * pass by reference, only by value between controllers.
587 * So we can't pass a pointer to the S/G list, only as many
588 * S/G entries as we can fit in here. If it's possible for
589 * us to get more than CTL_HA_MAX_SG_ENTRIES S/G entries,
590 * then we need to break this up into multiple transfers.
592 if (io->scsiio.kern_sg_entries == 0) {
593 msg.dt.kern_sg_entries = 1;
595 if (io->io_hdr.flags & CTL_FLAG_BUS_ADDR) {
596 msg.dt.sg_list[0].addr = io->scsiio.kern_data_ptr;
598 /* XXX KDM use busdma here! */
599 msg.dt.sg_list[0].addr =
600 (void *)vtophys(io->scsiio.kern_data_ptr);
603 KASSERT((io->io_hdr.flags & CTL_FLAG_BUS_ADDR) == 0,
604 ("HA does not support BUS_ADDR"));
605 msg.dt.sg_list[0].addr = io->scsiio.kern_data_ptr;
607 msg.dt.sg_list[0].len = io->scsiio.kern_data_len;
610 msg.dt.kern_sg_entries = io->scsiio.kern_sg_entries;
614 msg.dt.kern_data_len = io->scsiio.kern_data_len;
615 msg.dt.kern_total_len = io->scsiio.kern_total_len;
616 msg.dt.kern_data_resid = io->scsiio.kern_data_resid;
617 msg.dt.kern_rel_offset = io->scsiio.kern_rel_offset;
618 msg.dt.sg_sequence = 0;
621 * Loop until we've sent all of the S/G entries. On the
622 * other end, we'll recompose these S/G entries into one
623 * contiguous list before processing.
625 for (sg_entries_sent = 0; sg_entries_sent < msg.dt.kern_sg_entries;
626 msg.dt.sg_sequence++) {
627 msg.dt.cur_sg_entries = MIN((sizeof(msg.dt.sg_list) /
628 sizeof(msg.dt.sg_list[0])),
629 msg.dt.kern_sg_entries - sg_entries_sent);
630 if (do_sg_copy != 0) {
631 sgl = (struct ctl_sg_entry *)io->scsiio.kern_data_ptr;
632 for (i = sg_entries_sent, j = 0;
633 i < msg.dt.cur_sg_entries; i++, j++) {
635 if (io->io_hdr.flags & CTL_FLAG_BUS_ADDR) {
636 msg.dt.sg_list[j].addr = sgl[i].addr;
638 /* XXX KDM use busdma here! */
639 msg.dt.sg_list[j].addr =
640 (void *)vtophys(sgl[i].addr);
643 KASSERT((io->io_hdr.flags &
644 CTL_FLAG_BUS_ADDR) == 0,
645 ("HA does not support BUS_ADDR"));
646 msg.dt.sg_list[j].addr = sgl[i].addr;
648 msg.dt.sg_list[j].len = sgl[i].len;
652 sg_entries_sent += msg.dt.cur_sg_entries;
653 msg.dt.sg_last = (sg_entries_sent >= msg.dt.kern_sg_entries);
654 if (ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg,
655 sizeof(msg.dt) - sizeof(msg.dt.sg_list) +
656 sizeof(struct ctl_sg_entry) * msg.dt.cur_sg_entries,
657 M_WAITOK) > CTL_HA_STATUS_SUCCESS) {
658 io->io_hdr.port_status = 31341;
659 io->scsiio.be_move_done(io);
662 msg.dt.sent_sg_entries = sg_entries_sent;
666 * Officially handover the request from us to peer.
667 * If failover has just happened, then we must return error.
668 * If failover happen just after, then it is not our problem.
671 mtx_lock(&lun->lun_lock);
672 if (io->io_hdr.flags & CTL_FLAG_FAILOVER) {
674 mtx_unlock(&lun->lun_lock);
675 io->io_hdr.port_status = 31342;
676 io->scsiio.be_move_done(io);
679 io->io_hdr.flags &= ~CTL_FLAG_IO_ACTIVE;
680 io->io_hdr.flags |= CTL_FLAG_DMA_INPROG;
682 mtx_unlock(&lun->lun_lock);
686 ctl_ha_done(union ctl_io *io)
688 union ctl_ha_msg msg;
690 if (io->io_hdr.io_type == CTL_IO_SCSI) {
691 memset(&msg, 0, sizeof(msg));
692 msg.hdr.msg_type = CTL_MSG_FINISH_IO;
693 msg.hdr.original_sc = io->io_hdr.original_sc;
694 msg.hdr.nexus = io->io_hdr.nexus;
695 msg.hdr.status = io->io_hdr.status;
696 msg.scsi.scsi_status = io->scsiio.scsi_status;
697 msg.scsi.tag_num = io->scsiio.tag_num;
698 msg.scsi.tag_type = io->scsiio.tag_type;
699 msg.scsi.sense_len = io->scsiio.sense_len;
700 msg.scsi.sense_residual = io->scsiio.sense_residual;
701 msg.scsi.residual = io->scsiio.residual;
702 memcpy(&msg.scsi.sense_data, &io->scsiio.sense_data,
703 io->scsiio.sense_len);
704 ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg,
705 sizeof(msg.scsi) - sizeof(msg.scsi.sense_data) +
706 msg.scsi.sense_len, M_WAITOK);
712 ctl_isc_handler_finish_xfer(struct ctl_softc *ctl_softc,
713 union ctl_ha_msg *msg_info)
715 struct ctl_scsiio *ctsio;
717 if (msg_info->hdr.original_sc == NULL) {
718 printf("%s: original_sc == NULL!\n", __func__);
719 /* XXX KDM now what? */
723 ctsio = &msg_info->hdr.original_sc->scsiio;
724 ctsio->io_hdr.flags |= CTL_FLAG_IO_ACTIVE;
725 ctsio->io_hdr.msg_type = CTL_MSG_FINISH_IO;
726 ctsio->io_hdr.status = msg_info->hdr.status;
727 ctsio->scsi_status = msg_info->scsi.scsi_status;
728 ctsio->sense_len = msg_info->scsi.sense_len;
729 ctsio->sense_residual = msg_info->scsi.sense_residual;
730 ctsio->residual = msg_info->scsi.residual;
731 memcpy(&ctsio->sense_data, &msg_info->scsi.sense_data,
732 msg_info->scsi.sense_len);
733 ctl_enqueue_isc((union ctl_io *)ctsio);
737 ctl_isc_handler_finish_ser_only(struct ctl_softc *ctl_softc,
738 union ctl_ha_msg *msg_info)
740 struct ctl_scsiio *ctsio;
742 if (msg_info->hdr.serializing_sc == NULL) {
743 printf("%s: serializing_sc == NULL!\n", __func__);
744 /* XXX KDM now what? */
748 ctsio = &msg_info->hdr.serializing_sc->scsiio;
749 ctsio->io_hdr.msg_type = CTL_MSG_FINISH_IO;
750 ctl_enqueue_isc((union ctl_io *)ctsio);
754 ctl_isc_announce_lun(struct ctl_lun *lun)
756 struct ctl_softc *softc = lun->ctl_softc;
757 union ctl_ha_msg *msg;
758 struct ctl_ha_msg_lun_pr_key pr_key;
761 if (softc->ha_link != CTL_HA_LINK_ONLINE)
763 mtx_lock(&lun->lun_lock);
764 i = sizeof(msg->lun);
766 i += lun->lun_devid->len;
767 i += sizeof(pr_key) * lun->pr_key_count;
769 mtx_unlock(&lun->lun_lock);
770 msg = malloc(i, M_CTL, M_WAITOK);
771 mtx_lock(&lun->lun_lock);
772 k = sizeof(msg->lun);
774 k += lun->lun_devid->len;
775 k += sizeof(pr_key) * lun->pr_key_count;
781 bzero(&msg->lun, sizeof(msg->lun));
782 msg->hdr.msg_type = CTL_MSG_LUN_SYNC;
783 msg->hdr.nexus.targ_lun = lun->lun;
784 msg->hdr.nexus.targ_mapped_lun = lun->lun;
785 msg->lun.flags = lun->flags;
786 msg->lun.pr_generation = lun->pr_generation;
787 msg->lun.pr_res_idx = lun->pr_res_idx;
788 msg->lun.pr_res_type = lun->pr_res_type;
789 msg->lun.pr_key_count = lun->pr_key_count;
791 if (lun->lun_devid) {
792 msg->lun.lun_devid_len = lun->lun_devid->len;
793 memcpy(&msg->lun.data[i], lun->lun_devid->data,
794 msg->lun.lun_devid_len);
795 i += msg->lun.lun_devid_len;
797 for (k = 0; k < CTL_MAX_INITIATORS; k++) {
798 if ((pr_key.pr_key = ctl_get_prkey(lun, k)) == 0)
801 memcpy(&msg->lun.data[i], &pr_key, sizeof(pr_key));
804 mtx_unlock(&lun->lun_lock);
805 ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg->port, sizeof(msg->port) + i,
809 if (lun->flags & CTL_LUN_PRIMARY_SC) {
810 for (i = 0; i < CTL_NUM_MODE_PAGES; i++) {
811 ctl_isc_announce_mode(lun, -1,
812 lun->mode_pages.index[i].page_code & SMPH_PC_MASK,
813 lun->mode_pages.index[i].subpage);
819 ctl_isc_announce_port(struct ctl_port *port)
821 struct ctl_softc *softc = port->ctl_softc;
822 union ctl_ha_msg *msg;
825 if (port->targ_port < softc->port_min ||
826 port->targ_port >= softc->port_max ||
827 softc->ha_link != CTL_HA_LINK_ONLINE)
829 i = sizeof(msg->port) + strlen(port->port_name) + 1;
831 i += sizeof(uint32_t) * CTL_MAX_LUNS;
832 if (port->port_devid)
833 i += port->port_devid->len;
834 if (port->target_devid)
835 i += port->target_devid->len;
836 if (port->init_devid)
837 i += port->init_devid->len;
838 msg = malloc(i, M_CTL, M_WAITOK);
839 bzero(&msg->port, sizeof(msg->port));
840 msg->hdr.msg_type = CTL_MSG_PORT_SYNC;
841 msg->hdr.nexus.targ_port = port->targ_port;
842 msg->port.port_type = port->port_type;
843 msg->port.physical_port = port->physical_port;
844 msg->port.virtual_port = port->virtual_port;
845 msg->port.status = port->status;
847 msg->port.name_len = sprintf(&msg->port.data[i],
848 "%d:%s", softc->ha_id, port->port_name) + 1;
849 i += msg->port.name_len;
851 msg->port.lun_map_len = sizeof(uint32_t) * CTL_MAX_LUNS;
852 memcpy(&msg->port.data[i], port->lun_map,
853 msg->port.lun_map_len);
854 i += msg->port.lun_map_len;
856 if (port->port_devid) {
857 msg->port.port_devid_len = port->port_devid->len;
858 memcpy(&msg->port.data[i], port->port_devid->data,
859 msg->port.port_devid_len);
860 i += msg->port.port_devid_len;
862 if (port->target_devid) {
863 msg->port.target_devid_len = port->target_devid->len;
864 memcpy(&msg->port.data[i], port->target_devid->data,
865 msg->port.target_devid_len);
866 i += msg->port.target_devid_len;
868 if (port->init_devid) {
869 msg->port.init_devid_len = port->init_devid->len;
870 memcpy(&msg->port.data[i], port->init_devid->data,
871 msg->port.init_devid_len);
872 i += msg->port.init_devid_len;
874 ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg->port, sizeof(msg->port) + i,
880 ctl_isc_announce_iid(struct ctl_port *port, int iid)
882 struct ctl_softc *softc = port->ctl_softc;
883 union ctl_ha_msg *msg;
886 if (port->targ_port < softc->port_min ||
887 port->targ_port >= softc->port_max ||
888 softc->ha_link != CTL_HA_LINK_ONLINE)
890 mtx_lock(&softc->ctl_lock);
891 i = sizeof(msg->iid);
893 if (port->wwpn_iid[iid].name)
894 l = strlen(port->wwpn_iid[iid].name) + 1;
896 msg = malloc(i, M_CTL, M_NOWAIT);
898 mtx_unlock(&softc->ctl_lock);
901 bzero(&msg->iid, sizeof(msg->iid));
902 msg->hdr.msg_type = CTL_MSG_IID_SYNC;
903 msg->hdr.nexus.targ_port = port->targ_port;
904 msg->hdr.nexus.initid = iid;
905 msg->iid.in_use = port->wwpn_iid[iid].in_use;
906 msg->iid.name_len = l;
907 msg->iid.wwpn = port->wwpn_iid[iid].wwpn;
908 if (port->wwpn_iid[iid].name)
909 strlcpy(msg->iid.data, port->wwpn_iid[iid].name, l);
910 mtx_unlock(&softc->ctl_lock);
911 ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg->iid, i, M_NOWAIT);
916 ctl_isc_announce_mode(struct ctl_lun *lun, uint32_t initidx,
917 uint8_t page, uint8_t subpage)
919 struct ctl_softc *softc = lun->ctl_softc;
920 union ctl_ha_msg msg;
923 if (softc->ha_link != CTL_HA_LINK_ONLINE)
925 for (i = 0; i < CTL_NUM_MODE_PAGES; i++) {
926 if ((lun->mode_pages.index[i].page_code & SMPH_PC_MASK) ==
927 page && lun->mode_pages.index[i].subpage == subpage)
930 if (i == CTL_NUM_MODE_PAGES)
933 /* Don't try to replicate pages not present on this device. */
934 if (lun->mode_pages.index[i].page_data == NULL)
937 bzero(&msg.mode, sizeof(msg.mode));
938 msg.hdr.msg_type = CTL_MSG_MODE_SYNC;
939 msg.hdr.nexus.targ_port = initidx / CTL_MAX_INIT_PER_PORT;
940 msg.hdr.nexus.initid = initidx % CTL_MAX_INIT_PER_PORT;
941 msg.hdr.nexus.targ_lun = lun->lun;
942 msg.hdr.nexus.targ_mapped_lun = lun->lun;
943 msg.mode.page_code = page;
944 msg.mode.subpage = subpage;
945 msg.mode.page_len = lun->mode_pages.index[i].page_len;
946 memcpy(msg.mode.data, lun->mode_pages.index[i].page_data,
948 ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg.mode, sizeof(msg.mode),
953 ctl_isc_ha_link_up(struct ctl_softc *softc)
955 struct ctl_port *port;
957 union ctl_ha_msg msg;
960 /* Announce this node parameters to peer for validation. */
961 msg.login.msg_type = CTL_MSG_LOGIN;
962 msg.login.version = CTL_HA_VERSION;
963 msg.login.ha_mode = softc->ha_mode;
964 msg.login.ha_id = softc->ha_id;
965 msg.login.max_luns = CTL_MAX_LUNS;
966 msg.login.max_ports = CTL_MAX_PORTS;
967 msg.login.max_init_per_port = CTL_MAX_INIT_PER_PORT;
968 ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg.login, sizeof(msg.login),
971 STAILQ_FOREACH(port, &softc->port_list, links) {
972 ctl_isc_announce_port(port);
973 for (i = 0; i < CTL_MAX_INIT_PER_PORT; i++) {
974 if (port->wwpn_iid[i].in_use)
975 ctl_isc_announce_iid(port, i);
978 STAILQ_FOREACH(lun, &softc->lun_list, links)
979 ctl_isc_announce_lun(lun);
983 ctl_isc_ha_link_down(struct ctl_softc *softc)
985 struct ctl_port *port;
990 mtx_lock(&softc->ctl_lock);
991 STAILQ_FOREACH(lun, &softc->lun_list, links) {
992 mtx_lock(&lun->lun_lock);
993 if (lun->flags & CTL_LUN_PEER_SC_PRIMARY) {
994 lun->flags &= ~CTL_LUN_PEER_SC_PRIMARY;
995 ctl_est_ua_all(lun, -1, CTL_UA_ASYM_ACC_CHANGE);
997 mtx_unlock(&lun->lun_lock);
999 mtx_unlock(&softc->ctl_lock);
1000 io = ctl_alloc_io(softc->othersc_pool);
1001 mtx_lock(&softc->ctl_lock);
1003 io->io_hdr.msg_type = CTL_MSG_FAILOVER;
1004 io->io_hdr.nexus.targ_mapped_lun = lun->lun;
1005 ctl_enqueue_isc(io);
1008 STAILQ_FOREACH(port, &softc->port_list, links) {
1009 if (port->targ_port >= softc->port_min &&
1010 port->targ_port < softc->port_max)
1012 port->status &= ~CTL_PORT_STATUS_ONLINE;
1013 for (i = 0; i < CTL_MAX_INIT_PER_PORT; i++) {
1014 port->wwpn_iid[i].in_use = 0;
1015 free(port->wwpn_iid[i].name, M_CTL);
1016 port->wwpn_iid[i].name = NULL;
1019 mtx_unlock(&softc->ctl_lock);
1023 ctl_isc_ua(struct ctl_softc *softc, union ctl_ha_msg *msg, int len)
1025 struct ctl_lun *lun;
1026 uint32_t iid = ctl_get_initindex(&msg->hdr.nexus);
1028 mtx_lock(&softc->ctl_lock);
1029 if (msg->hdr.nexus.targ_lun < CTL_MAX_LUNS &&
1030 (lun = softc->ctl_luns[msg->hdr.nexus.targ_mapped_lun]) != NULL) {
1031 mtx_lock(&lun->lun_lock);
1032 mtx_unlock(&softc->ctl_lock);
1033 if (msg->ua.ua_type == CTL_UA_THIN_PROV_THRES &&
1035 memcpy(lun->ua_tpt_info, msg->ua.ua_info, 8);
1036 if (msg->ua.ua_all) {
1038 ctl_est_ua_all(lun, iid, msg->ua.ua_type);
1040 ctl_clr_ua_all(lun, iid, msg->ua.ua_type);
1043 ctl_est_ua(lun, iid, msg->ua.ua_type);
1045 ctl_clr_ua(lun, iid, msg->ua.ua_type);
1047 mtx_unlock(&lun->lun_lock);
1049 mtx_unlock(&softc->ctl_lock);
1053 ctl_isc_lun_sync(struct ctl_softc *softc, union ctl_ha_msg *msg, int len)
1055 struct ctl_lun *lun;
1056 struct ctl_ha_msg_lun_pr_key pr_key;
1058 ctl_lun_flags oflags;
1061 targ_lun = msg->hdr.nexus.targ_mapped_lun;
1062 mtx_lock(&softc->ctl_lock);
1063 if ((targ_lun >= CTL_MAX_LUNS) ||
1064 ((lun = softc->ctl_luns[targ_lun]) == NULL)) {
1065 mtx_unlock(&softc->ctl_lock);
1068 mtx_lock(&lun->lun_lock);
1069 mtx_unlock(&softc->ctl_lock);
1070 if (lun->flags & CTL_LUN_DISABLED) {
1071 mtx_unlock(&lun->lun_lock);
1074 i = (lun->lun_devid != NULL) ? lun->lun_devid->len : 0;
1075 if (msg->lun.lun_devid_len != i || (i > 0 &&
1076 memcmp(&msg->lun.data[0], lun->lun_devid->data, i) != 0)) {
1077 mtx_unlock(&lun->lun_lock);
1078 printf("%s: Received conflicting HA LUN %d\n",
1079 __func__, msg->hdr.nexus.targ_lun);
1082 /* Record whether peer is primary. */
1083 oflags = lun->flags;
1084 if ((msg->lun.flags & CTL_LUN_PRIMARY_SC) &&
1085 (msg->lun.flags & CTL_LUN_DISABLED) == 0)
1086 lun->flags |= CTL_LUN_PEER_SC_PRIMARY;
1088 lun->flags &= ~CTL_LUN_PEER_SC_PRIMARY;
1089 if (oflags != lun->flags)
1090 ctl_est_ua_all(lun, -1, CTL_UA_ASYM_ACC_CHANGE);
1092 /* If peer is primary and we are not -- use data */
1093 if ((lun->flags & CTL_LUN_PRIMARY_SC) == 0 &&
1094 (lun->flags & CTL_LUN_PEER_SC_PRIMARY)) {
1095 lun->pr_generation = msg->lun.pr_generation;
1096 lun->pr_res_idx = msg->lun.pr_res_idx;
1097 lun->pr_res_type = msg->lun.pr_res_type;
1098 lun->pr_key_count = msg->lun.pr_key_count;
1099 for (k = 0; k < CTL_MAX_INITIATORS; k++)
1100 ctl_clr_prkey(lun, k);
1101 for (k = 0; k < msg->lun.pr_key_count; k++) {
1102 memcpy(&pr_key, &msg->lun.data[i],
1104 ctl_alloc_prkey(lun, pr_key.pr_iid);
1105 ctl_set_prkey(lun, pr_key.pr_iid,
1107 i += sizeof(pr_key);
1111 mtx_unlock(&lun->lun_lock);
1112 CTL_DEBUG_PRINT(("%s: Known LUN %d, peer is %s\n",
1113 __func__, msg->hdr.nexus.targ_lun,
1114 (msg->lun.flags & CTL_LUN_PRIMARY_SC) ?
1115 "primary" : "secondary"));
1117 /* If we are primary but peer doesn't know -- notify */
1118 if ((lun->flags & CTL_LUN_PRIMARY_SC) &&
1119 (msg->lun.flags & CTL_LUN_PEER_SC_PRIMARY) == 0)
1120 ctl_isc_announce_lun(lun);
1125 ctl_isc_port_sync(struct ctl_softc *softc, union ctl_ha_msg *msg, int len)
1127 struct ctl_port *port;
1128 struct ctl_lun *lun;
1131 port = softc->ctl_ports[msg->hdr.nexus.targ_port];
1133 CTL_DEBUG_PRINT(("%s: New port %d\n", __func__,
1134 msg->hdr.nexus.targ_port));
1136 port = malloc(sizeof(*port), M_CTL, M_WAITOK | M_ZERO);
1137 port->frontend = &ha_frontend;
1138 port->targ_port = msg->hdr.nexus.targ_port;
1139 port->fe_datamove = ctl_ha_datamove;
1140 port->fe_done = ctl_ha_done;
1141 } else if (port->frontend == &ha_frontend) {
1142 CTL_DEBUG_PRINT(("%s: Updated port %d\n", __func__,
1143 msg->hdr.nexus.targ_port));
1146 printf("%s: Received conflicting HA port %d\n",
1147 __func__, msg->hdr.nexus.targ_port);
1150 port->port_type = msg->port.port_type;
1151 port->physical_port = msg->port.physical_port;
1152 port->virtual_port = msg->port.virtual_port;
1153 port->status = msg->port.status;
1155 free(port->port_name, M_CTL);
1156 port->port_name = strndup(&msg->port.data[i], msg->port.name_len,
1158 i += msg->port.name_len;
1159 if (msg->port.lun_map_len != 0) {
1160 if (port->lun_map == NULL)
1161 port->lun_map = malloc(sizeof(uint32_t) * CTL_MAX_LUNS,
1163 memcpy(port->lun_map, &msg->port.data[i],
1164 sizeof(uint32_t) * CTL_MAX_LUNS);
1165 i += msg->port.lun_map_len;
1167 free(port->lun_map, M_CTL);
1168 port->lun_map = NULL;
1170 if (msg->port.port_devid_len != 0) {
1171 if (port->port_devid == NULL ||
1172 port->port_devid->len != msg->port.port_devid_len) {
1173 free(port->port_devid, M_CTL);
1174 port->port_devid = malloc(sizeof(struct ctl_devid) +
1175 msg->port.port_devid_len, M_CTL, M_WAITOK);
1177 memcpy(port->port_devid->data, &msg->port.data[i],
1178 msg->port.port_devid_len);
1179 port->port_devid->len = msg->port.port_devid_len;
1180 i += msg->port.port_devid_len;
1182 free(port->port_devid, M_CTL);
1183 port->port_devid = NULL;
1185 if (msg->port.target_devid_len != 0) {
1186 if (port->target_devid == NULL ||
1187 port->target_devid->len != msg->port.target_devid_len) {
1188 free(port->target_devid, M_CTL);
1189 port->target_devid = malloc(sizeof(struct ctl_devid) +
1190 msg->port.target_devid_len, M_CTL, M_WAITOK);
1192 memcpy(port->target_devid->data, &msg->port.data[i],
1193 msg->port.target_devid_len);
1194 port->target_devid->len = msg->port.target_devid_len;
1195 i += msg->port.target_devid_len;
1197 free(port->target_devid, M_CTL);
1198 port->target_devid = NULL;
1200 if (msg->port.init_devid_len != 0) {
1201 if (port->init_devid == NULL ||
1202 port->init_devid->len != msg->port.init_devid_len) {
1203 free(port->init_devid, M_CTL);
1204 port->init_devid = malloc(sizeof(struct ctl_devid) +
1205 msg->port.init_devid_len, M_CTL, M_WAITOK);
1207 memcpy(port->init_devid->data, &msg->port.data[i],
1208 msg->port.init_devid_len);
1209 port->init_devid->len = msg->port.init_devid_len;
1210 i += msg->port.init_devid_len;
1212 free(port->init_devid, M_CTL);
1213 port->init_devid = NULL;
1216 if (ctl_port_register(port) != 0) {
1217 printf("%s: ctl_port_register() failed with error\n",
1221 mtx_lock(&softc->ctl_lock);
1222 STAILQ_FOREACH(lun, &softc->lun_list, links) {
1223 if (ctl_lun_map_to_port(port, lun->lun) >= CTL_MAX_LUNS)
1225 mtx_lock(&lun->lun_lock);
1226 ctl_est_ua_all(lun, -1, CTL_UA_INQ_CHANGE);
1227 mtx_unlock(&lun->lun_lock);
1229 mtx_unlock(&softc->ctl_lock);
1233 ctl_isc_iid_sync(struct ctl_softc *softc, union ctl_ha_msg *msg, int len)
1235 struct ctl_port *port;
1238 port = softc->ctl_ports[msg->hdr.nexus.targ_port];
1240 printf("%s: Received IID for unknown port %d\n",
1241 __func__, msg->hdr.nexus.targ_port);
1244 iid = msg->hdr.nexus.initid;
1245 port->wwpn_iid[iid].in_use = msg->iid.in_use;
1246 port->wwpn_iid[iid].wwpn = msg->iid.wwpn;
1247 free(port->wwpn_iid[iid].name, M_CTL);
1248 if (msg->iid.name_len) {
1249 port->wwpn_iid[iid].name = strndup(&msg->iid.data[0],
1250 msg->iid.name_len, M_CTL);
1252 port->wwpn_iid[iid].name = NULL;
1256 ctl_isc_login(struct ctl_softc *softc, union ctl_ha_msg *msg, int len)
1259 if (msg->login.version != CTL_HA_VERSION) {
1260 printf("CTL HA peers have different versions %d != %d\n",
1261 msg->login.version, CTL_HA_VERSION);
1262 ctl_ha_msg_abort(CTL_HA_CHAN_CTL);
1265 if (msg->login.ha_mode != softc->ha_mode) {
1266 printf("CTL HA peers have different ha_mode %d != %d\n",
1267 msg->login.ha_mode, softc->ha_mode);
1268 ctl_ha_msg_abort(CTL_HA_CHAN_CTL);
1271 if (msg->login.ha_id == softc->ha_id) {
1272 printf("CTL HA peers have same ha_id %d\n", msg->login.ha_id);
1273 ctl_ha_msg_abort(CTL_HA_CHAN_CTL);
1276 if (msg->login.max_luns != CTL_MAX_LUNS ||
1277 msg->login.max_ports != CTL_MAX_PORTS ||
1278 msg->login.max_init_per_port != CTL_MAX_INIT_PER_PORT) {
1279 printf("CTL HA peers have different limits\n");
1280 ctl_ha_msg_abort(CTL_HA_CHAN_CTL);
1286 ctl_isc_mode_sync(struct ctl_softc *softc, union ctl_ha_msg *msg, int len)
1288 struct ctl_lun *lun;
1290 uint32_t initidx, targ_lun;
1292 targ_lun = msg->hdr.nexus.targ_mapped_lun;
1293 mtx_lock(&softc->ctl_lock);
1294 if ((targ_lun >= CTL_MAX_LUNS) ||
1295 ((lun = softc->ctl_luns[targ_lun]) == NULL)) {
1296 mtx_unlock(&softc->ctl_lock);
1299 mtx_lock(&lun->lun_lock);
1300 mtx_unlock(&softc->ctl_lock);
1301 if (lun->flags & CTL_LUN_DISABLED) {
1302 mtx_unlock(&lun->lun_lock);
1305 for (i = 0; i < CTL_NUM_MODE_PAGES; i++) {
1306 if ((lun->mode_pages.index[i].page_code & SMPH_PC_MASK) ==
1307 msg->mode.page_code &&
1308 lun->mode_pages.index[i].subpage == msg->mode.subpage)
1311 if (i == CTL_NUM_MODE_PAGES) {
1312 mtx_unlock(&lun->lun_lock);
1315 memcpy(lun->mode_pages.index[i].page_data, msg->mode.data,
1316 lun->mode_pages.index[i].page_len);
1317 initidx = ctl_get_initindex(&msg->hdr.nexus);
1319 ctl_est_ua_all(lun, initidx, CTL_UA_MODE_CHANGE);
1320 mtx_unlock(&lun->lun_lock);
1324 * ISC (Inter Shelf Communication) event handler. Events from the HA
1325 * subsystem come in here.
1328 ctl_isc_event_handler(ctl_ha_channel channel, ctl_ha_event event, int param)
1330 struct ctl_softc *softc = control_softc;
1332 struct ctl_prio *presio;
1333 ctl_ha_status isc_status;
1335 CTL_DEBUG_PRINT(("CTL: Isc Msg event %d\n", event));
1336 if (event == CTL_HA_EVT_MSG_RECV) {
1337 union ctl_ha_msg *msg, msgbuf;
1339 if (param > sizeof(msgbuf))
1340 msg = malloc(param, M_CTL, M_WAITOK);
1343 isc_status = ctl_ha_msg_recv(CTL_HA_CHAN_CTL, msg, param,
1345 if (isc_status != CTL_HA_STATUS_SUCCESS) {
1346 printf("%s: Error receiving message: %d\n",
1347 __func__, isc_status);
1353 CTL_DEBUG_PRINT(("CTL: msg_type %d\n", msg->msg_type));
1354 switch (msg->hdr.msg_type) {
1355 case CTL_MSG_SERIALIZE:
1356 io = ctl_alloc_io(softc->othersc_pool);
1358 // populate ctsio from msg
1359 io->io_hdr.io_type = CTL_IO_SCSI;
1360 io->io_hdr.msg_type = CTL_MSG_SERIALIZE;
1361 io->io_hdr.original_sc = msg->hdr.original_sc;
1362 io->io_hdr.flags |= CTL_FLAG_FROM_OTHER_SC |
1365 * If we're in serialization-only mode, we don't
1366 * want to go through full done processing. Thus
1369 * XXX KDM add another flag that is more specific.
1371 if (softc->ha_mode != CTL_HA_MODE_XFER)
1372 io->io_hdr.flags |= CTL_FLAG_INT_COPY;
1373 io->io_hdr.nexus = msg->hdr.nexus;
1375 printf("port %u, iid %u, lun %u\n",
1376 io->io_hdr.nexus.targ_port,
1377 io->io_hdr.nexus.initid,
1378 io->io_hdr.nexus.targ_lun);
1380 io->scsiio.tag_num = msg->scsi.tag_num;
1381 io->scsiio.tag_type = msg->scsi.tag_type;
1383 io->io_hdr.start_time = time_uptime;
1384 getbinuptime(&io->io_hdr.start_bt);
1385 #endif /* CTL_TIME_IO */
1386 io->scsiio.cdb_len = msg->scsi.cdb_len;
1387 memcpy(io->scsiio.cdb, msg->scsi.cdb,
1389 if (softc->ha_mode == CTL_HA_MODE_XFER) {
1390 const struct ctl_cmd_entry *entry;
1392 entry = ctl_get_cmd_entry(&io->scsiio, NULL);
1393 io->io_hdr.flags &= ~CTL_FLAG_DATA_MASK;
1395 entry->flags & CTL_FLAG_DATA_MASK;
1397 ctl_enqueue_isc(io);
1400 /* Performed on the Originating SC, XFER mode only */
1401 case CTL_MSG_DATAMOVE: {
1402 struct ctl_sg_entry *sgl;
1405 io = msg->hdr.original_sc;
1407 printf("%s: original_sc == NULL!\n", __func__);
1408 /* XXX KDM do something here */
1411 io->io_hdr.msg_type = CTL_MSG_DATAMOVE;
1412 io->io_hdr.flags |= CTL_FLAG_IO_ACTIVE;
1414 * Keep track of this, we need to send it back over
1415 * when the datamove is complete.
1417 io->io_hdr.serializing_sc = msg->hdr.serializing_sc;
1418 if (msg->hdr.status == CTL_SUCCESS)
1419 io->io_hdr.status = msg->hdr.status;
1421 if (msg->dt.sg_sequence == 0) {
1423 getbinuptime(&io->io_hdr.dma_start_bt);
1425 i = msg->dt.kern_sg_entries +
1426 msg->dt.kern_data_len /
1427 CTL_HA_DATAMOVE_SEGMENT + 1;
1428 sgl = malloc(sizeof(*sgl) * i, M_CTL,
1430 io->io_hdr.remote_sglist = sgl;
1431 io->io_hdr.local_sglist =
1432 &sgl[msg->dt.kern_sg_entries];
1434 io->scsiio.kern_data_ptr = (uint8_t *)sgl;
1436 io->scsiio.kern_sg_entries =
1437 msg->dt.kern_sg_entries;
1438 io->scsiio.rem_sg_entries =
1439 msg->dt.kern_sg_entries;
1440 io->scsiio.kern_data_len =
1441 msg->dt.kern_data_len;
1442 io->scsiio.kern_total_len =
1443 msg->dt.kern_total_len;
1444 io->scsiio.kern_data_resid =
1445 msg->dt.kern_data_resid;
1446 io->scsiio.kern_rel_offset =
1447 msg->dt.kern_rel_offset;
1448 io->io_hdr.flags &= ~CTL_FLAG_BUS_ADDR;
1449 io->io_hdr.flags |= msg->dt.flags &
1452 sgl = (struct ctl_sg_entry *)
1453 io->scsiio.kern_data_ptr;
1455 for (i = msg->dt.sent_sg_entries, j = 0;
1456 i < (msg->dt.sent_sg_entries +
1457 msg->dt.cur_sg_entries); i++, j++) {
1458 sgl[i].addr = msg->dt.sg_list[j].addr;
1459 sgl[i].len = msg->dt.sg_list[j].len;
1462 printf("%s: DATAMOVE: %p,%lu j=%d, i=%d\n",
1463 __func__, sgl[i].addr, sgl[i].len, j, i);
1468 * If this is the last piece of the I/O, we've got
1469 * the full S/G list. Queue processing in the thread.
1470 * Otherwise wait for the next piece.
1472 if (msg->dt.sg_last != 0)
1473 ctl_enqueue_isc(io);
1476 /* Performed on the Serializing (primary) SC, XFER mode only */
1477 case CTL_MSG_DATAMOVE_DONE: {
1478 if (msg->hdr.serializing_sc == NULL) {
1479 printf("%s: serializing_sc == NULL!\n",
1481 /* XXX KDM now what? */
1485 * We grab the sense information here in case
1486 * there was a failure, so we can return status
1487 * back to the initiator.
1489 io = msg->hdr.serializing_sc;
1490 io->io_hdr.msg_type = CTL_MSG_DATAMOVE_DONE;
1491 io->io_hdr.flags &= ~CTL_FLAG_DMA_INPROG;
1492 io->io_hdr.flags |= CTL_FLAG_IO_ACTIVE;
1493 io->io_hdr.port_status = msg->scsi.fetd_status;
1494 io->scsiio.residual = msg->scsi.residual;
1495 if (msg->hdr.status != CTL_STATUS_NONE) {
1496 io->io_hdr.status = msg->hdr.status;
1497 io->scsiio.scsi_status = msg->scsi.scsi_status;
1498 io->scsiio.sense_len = msg->scsi.sense_len;
1499 io->scsiio.sense_residual =msg->scsi.sense_residual;
1500 memcpy(&io->scsiio.sense_data,
1501 &msg->scsi.sense_data,
1502 msg->scsi.sense_len);
1503 if (msg->hdr.status == CTL_SUCCESS)
1504 io->io_hdr.flags |= CTL_FLAG_STATUS_SENT;
1506 ctl_enqueue_isc(io);
1510 /* Preformed on Originating SC, SER_ONLY mode */
1512 io = msg->hdr.original_sc;
1514 printf("%s: original_sc == NULL!\n",
1518 io->io_hdr.flags |= CTL_FLAG_IO_ACTIVE;
1519 io->io_hdr.msg_type = CTL_MSG_R2R;
1520 io->io_hdr.serializing_sc = msg->hdr.serializing_sc;
1521 ctl_enqueue_isc(io);
1525 * Performed on Serializing(i.e. primary SC) SC in SER_ONLY
1527 * Performed on the Originating (i.e. secondary) SC in XFER
1530 case CTL_MSG_FINISH_IO:
1531 if (softc->ha_mode == CTL_HA_MODE_XFER)
1532 ctl_isc_handler_finish_xfer(softc, msg);
1534 ctl_isc_handler_finish_ser_only(softc, msg);
1537 /* Preformed on Originating SC */
1538 case CTL_MSG_BAD_JUJU:
1539 io = msg->hdr.original_sc;
1541 printf("%s: Bad JUJU!, original_sc is NULL!\n",
1545 ctl_copy_sense_data(msg, io);
1547 * IO should have already been cleaned up on other
1548 * SC so clear this flag so we won't send a message
1549 * back to finish the IO there.
1551 io->io_hdr.flags &= ~CTL_FLAG_SENT_2OTHER_SC;
1552 io->io_hdr.flags |= CTL_FLAG_IO_ACTIVE;
1554 /* io = msg->hdr.serializing_sc; */
1555 io->io_hdr.msg_type = CTL_MSG_BAD_JUJU;
1556 ctl_enqueue_isc(io);
1559 /* Handle resets sent from the other side */
1560 case CTL_MSG_MANAGE_TASKS: {
1561 struct ctl_taskio *taskio;
1562 taskio = (struct ctl_taskio *)ctl_alloc_io(
1563 softc->othersc_pool);
1564 ctl_zero_io((union ctl_io *)taskio);
1565 taskio->io_hdr.io_type = CTL_IO_TASK;
1566 taskio->io_hdr.flags |= CTL_FLAG_FROM_OTHER_SC;
1567 taskio->io_hdr.nexus = msg->hdr.nexus;
1568 taskio->task_action = msg->task.task_action;
1569 taskio->tag_num = msg->task.tag_num;
1570 taskio->tag_type = msg->task.tag_type;
1572 taskio->io_hdr.start_time = time_uptime;
1573 getbinuptime(&taskio->io_hdr.start_bt);
1574 #endif /* CTL_TIME_IO */
1575 ctl_run_task((union ctl_io *)taskio);
1578 /* Persistent Reserve action which needs attention */
1579 case CTL_MSG_PERS_ACTION:
1580 presio = (struct ctl_prio *)ctl_alloc_io(
1581 softc->othersc_pool);
1582 ctl_zero_io((union ctl_io *)presio);
1583 presio->io_hdr.msg_type = CTL_MSG_PERS_ACTION;
1584 presio->io_hdr.flags |= CTL_FLAG_FROM_OTHER_SC;
1585 presio->io_hdr.nexus = msg->hdr.nexus;
1586 presio->pr_msg = msg->pr;
1587 ctl_enqueue_isc((union ctl_io *)presio);
1590 ctl_isc_ua(softc, msg, param);
1592 case CTL_MSG_PORT_SYNC:
1593 ctl_isc_port_sync(softc, msg, param);
1595 case CTL_MSG_LUN_SYNC:
1596 ctl_isc_lun_sync(softc, msg, param);
1598 case CTL_MSG_IID_SYNC:
1599 ctl_isc_iid_sync(softc, msg, param);
1602 ctl_isc_login(softc, msg, param);
1604 case CTL_MSG_MODE_SYNC:
1605 ctl_isc_mode_sync(softc, msg, param);
1608 printf("Received HA message of unknown type %d\n",
1610 ctl_ha_msg_abort(CTL_HA_CHAN_CTL);
1615 } else if (event == CTL_HA_EVT_LINK_CHANGE) {
1616 printf("CTL: HA link status changed from %d to %d\n",
1617 softc->ha_link, param);
1618 if (param == softc->ha_link)
1620 if (softc->ha_link == CTL_HA_LINK_ONLINE) {
1621 softc->ha_link = param;
1622 ctl_isc_ha_link_down(softc);
1624 softc->ha_link = param;
1625 if (softc->ha_link == CTL_HA_LINK_ONLINE)
1626 ctl_isc_ha_link_up(softc);
1630 printf("ctl_isc_event_handler: Unknown event %d\n", event);
1636 ctl_copy_sense_data(union ctl_ha_msg *src, union ctl_io *dest)
1639 memcpy(&dest->scsiio.sense_data, &src->scsi.sense_data,
1640 src->scsi.sense_len);
1641 dest->scsiio.scsi_status = src->scsi.scsi_status;
1642 dest->scsiio.sense_len = src->scsi.sense_len;
1643 dest->io_hdr.status = src->hdr.status;
1647 ctl_copy_sense_data_back(union ctl_io *src, union ctl_ha_msg *dest)
1650 memcpy(&dest->scsi.sense_data, &src->scsiio.sense_data,
1651 src->scsiio.sense_len);
1652 dest->scsi.scsi_status = src->scsiio.scsi_status;
1653 dest->scsi.sense_len = src->scsiio.sense_len;
1654 dest->hdr.status = src->io_hdr.status;
1658 ctl_est_ua(struct ctl_lun *lun, uint32_t initidx, ctl_ua_type ua)
1660 struct ctl_softc *softc = lun->ctl_softc;
1663 if (initidx < softc->init_min || initidx >= softc->init_max)
1665 mtx_assert(&lun->lun_lock, MA_OWNED);
1666 pu = lun->pending_ua[initidx / CTL_MAX_INIT_PER_PORT];
1669 pu[initidx % CTL_MAX_INIT_PER_PORT] |= ua;
1673 ctl_est_ua_port(struct ctl_lun *lun, int port, uint32_t except, ctl_ua_type ua)
1677 mtx_assert(&lun->lun_lock, MA_OWNED);
1678 if (lun->pending_ua[port] == NULL)
1680 for (i = 0; i < CTL_MAX_INIT_PER_PORT; i++) {
1681 if (port * CTL_MAX_INIT_PER_PORT + i == except)
1683 lun->pending_ua[port][i] |= ua;
1688 ctl_est_ua_all(struct ctl_lun *lun, uint32_t except, ctl_ua_type ua)
1690 struct ctl_softc *softc = lun->ctl_softc;
1693 mtx_assert(&lun->lun_lock, MA_OWNED);
1694 for (i = softc->port_min; i < softc->port_max; i++)
1695 ctl_est_ua_port(lun, i, except, ua);
1699 ctl_clr_ua(struct ctl_lun *lun, uint32_t initidx, ctl_ua_type ua)
1701 struct ctl_softc *softc = lun->ctl_softc;
1704 if (initidx < softc->init_min || initidx >= softc->init_max)
1706 mtx_assert(&lun->lun_lock, MA_OWNED);
1707 pu = lun->pending_ua[initidx / CTL_MAX_INIT_PER_PORT];
1710 pu[initidx % CTL_MAX_INIT_PER_PORT] &= ~ua;
1714 ctl_clr_ua_all(struct ctl_lun *lun, uint32_t except, ctl_ua_type ua)
1716 struct ctl_softc *softc = lun->ctl_softc;
1719 mtx_assert(&lun->lun_lock, MA_OWNED);
1720 for (i = softc->port_min; i < softc->port_max; i++) {
1721 if (lun->pending_ua[i] == NULL)
1723 for (j = 0; j < CTL_MAX_INIT_PER_PORT; j++) {
1724 if (i * CTL_MAX_INIT_PER_PORT + j == except)
1726 lun->pending_ua[i][j] &= ~ua;
1732 ctl_clr_ua_allluns(struct ctl_softc *ctl_softc, uint32_t initidx,
1733 ctl_ua_type ua_type)
1735 struct ctl_lun *lun;
1737 mtx_assert(&ctl_softc->ctl_lock, MA_OWNED);
1738 STAILQ_FOREACH(lun, &ctl_softc->lun_list, links) {
1739 mtx_lock(&lun->lun_lock);
1740 ctl_clr_ua(lun, initidx, ua_type);
1741 mtx_unlock(&lun->lun_lock);
1746 ctl_ha_role_sysctl(SYSCTL_HANDLER_ARGS)
1748 struct ctl_softc *softc = (struct ctl_softc *)arg1;
1749 struct ctl_lun *lun;
1750 struct ctl_lun_req ireq;
1753 value = (softc->flags & CTL_FLAG_ACTIVE_SHELF) ? 0 : 1;
1754 error = sysctl_handle_int(oidp, &value, 0, req);
1755 if ((error != 0) || (req->newptr == NULL))
1758 mtx_lock(&softc->ctl_lock);
1760 softc->flags |= CTL_FLAG_ACTIVE_SHELF;
1762 softc->flags &= ~CTL_FLAG_ACTIVE_SHELF;
1763 STAILQ_FOREACH(lun, &softc->lun_list, links) {
1764 mtx_unlock(&softc->ctl_lock);
1765 bzero(&ireq, sizeof(ireq));
1766 ireq.reqtype = CTL_LUNREQ_MODIFY;
1767 ireq.reqdata.modify.lun_id = lun->lun;
1768 lun->backend->ioctl(NULL, CTL_LUN_REQ, (caddr_t)&ireq, 0,
1770 if (ireq.status != CTL_LUN_OK) {
1771 printf("%s: CTL_LUNREQ_MODIFY returned %d '%s'\n",
1772 __func__, ireq.status, ireq.error_str);
1774 mtx_lock(&softc->ctl_lock);
1776 mtx_unlock(&softc->ctl_lock);
1783 struct make_dev_args args;
1784 struct ctl_softc *softc;
1788 softc = control_softc = malloc(sizeof(*control_softc), M_DEVBUF,
1791 make_dev_args_init(&args);
1792 args.mda_devsw = &ctl_cdevsw;
1793 args.mda_uid = UID_ROOT;
1794 args.mda_gid = GID_OPERATOR;
1795 args.mda_mode = 0600;
1796 args.mda_si_drv1 = softc;
1797 error = make_dev_s(&args, &softc->dev, "cam/ctl");
1799 free(control_softc, M_DEVBUF);
1803 sysctl_ctx_init(&softc->sysctl_ctx);
1804 softc->sysctl_tree = SYSCTL_ADD_NODE(&softc->sysctl_ctx,
1805 SYSCTL_STATIC_CHILDREN(_kern_cam), OID_AUTO, "ctl",
1806 CTLFLAG_RD, 0, "CAM Target Layer");
1808 if (softc->sysctl_tree == NULL) {
1809 printf("%s: unable to allocate sysctl tree\n", __func__);
1810 destroy_dev(softc->dev);
1811 free(control_softc, M_DEVBUF);
1812 control_softc = NULL;
1816 mtx_init(&softc->ctl_lock, "CTL mutex", NULL, MTX_DEF);
1817 softc->io_zone = uma_zcreate("CTL IO", sizeof(union ctl_io),
1818 NULL, NULL, NULL, NULL, UMA_ALIGN_PTR, 0);
1821 TUNABLE_INT_FETCH("kern.cam.ctl.ha_mode", (int *)&softc->ha_mode);
1822 SYSCTL_ADD_INT(&softc->sysctl_ctx, SYSCTL_CHILDREN(softc->sysctl_tree),
1823 OID_AUTO, "ha_mode", CTLFLAG_RDTUN, (int *)&softc->ha_mode, 0,
1824 "HA mode (0 - act/stby, 1 - serialize only, 2 - xfer)");
1827 * In Copan's HA scheme, the "master" and "slave" roles are
1828 * figured out through the slot the controller is in. Although it
1829 * is an active/active system, someone has to be in charge.
1831 TUNABLE_INT_FETCH("kern.cam.ctl.ha_id", &softc->ha_id);
1832 SYSCTL_ADD_INT(&softc->sysctl_ctx, SYSCTL_CHILDREN(softc->sysctl_tree),
1833 OID_AUTO, "ha_id", CTLFLAG_RDTUN, &softc->ha_id, 0,
1834 "HA head ID (0 - no HA)");
1835 if (softc->ha_id == 0 || softc->ha_id > NUM_HA_SHELVES) {
1836 softc->flags |= CTL_FLAG_ACTIVE_SHELF;
1837 softc->is_single = 1;
1838 softc->port_cnt = CTL_MAX_PORTS;
1839 softc->port_min = 0;
1841 softc->port_cnt = CTL_MAX_PORTS / NUM_HA_SHELVES;
1842 softc->port_min = (softc->ha_id - 1) * softc->port_cnt;
1844 softc->port_max = softc->port_min + softc->port_cnt;
1845 softc->init_min = softc->port_min * CTL_MAX_INIT_PER_PORT;
1846 softc->init_max = softc->port_max * CTL_MAX_INIT_PER_PORT;
1848 SYSCTL_ADD_INT(&softc->sysctl_ctx, SYSCTL_CHILDREN(softc->sysctl_tree),
1849 OID_AUTO, "ha_link", CTLFLAG_RD, (int *)&softc->ha_link, 0,
1850 "HA link state (0 - offline, 1 - unknown, 2 - online)");
1852 STAILQ_INIT(&softc->lun_list);
1853 STAILQ_INIT(&softc->pending_lun_queue);
1854 STAILQ_INIT(&softc->fe_list);
1855 STAILQ_INIT(&softc->port_list);
1856 STAILQ_INIT(&softc->be_list);
1857 ctl_tpc_init(softc);
1859 if (ctl_pool_create(softc, "othersc", CTL_POOL_ENTRIES_OTHER_SC,
1862 printf("ctl: can't allocate %d entry other SC pool, "
1863 "exiting\n", CTL_POOL_ENTRIES_OTHER_SC);
1866 softc->othersc_pool = other_pool;
1868 if (worker_threads <= 0)
1869 worker_threads = max(1, mp_ncpus / 4);
1870 if (worker_threads > CTL_MAX_THREADS)
1871 worker_threads = CTL_MAX_THREADS;
1873 for (i = 0; i < worker_threads; i++) {
1874 struct ctl_thread *thr = &softc->threads[i];
1876 mtx_init(&thr->queue_lock, "CTL queue mutex", NULL, MTX_DEF);
1877 thr->ctl_softc = softc;
1878 STAILQ_INIT(&thr->incoming_queue);
1879 STAILQ_INIT(&thr->rtr_queue);
1880 STAILQ_INIT(&thr->done_queue);
1881 STAILQ_INIT(&thr->isc_queue);
1883 error = kproc_kthread_add(ctl_work_thread, thr,
1884 &softc->ctl_proc, &thr->thread, 0, 0, "ctl", "work%d", i);
1886 printf("error creating CTL work thread!\n");
1887 ctl_pool_free(other_pool);
1891 error = kproc_kthread_add(ctl_lun_thread, softc,
1892 &softc->ctl_proc, NULL, 0, 0, "ctl", "lun");
1894 printf("error creating CTL lun thread!\n");
1895 ctl_pool_free(other_pool);
1898 error = kproc_kthread_add(ctl_thresh_thread, softc,
1899 &softc->ctl_proc, NULL, 0, 0, "ctl", "thresh");
1901 printf("error creating CTL threshold thread!\n");
1902 ctl_pool_free(other_pool);
1906 SYSCTL_ADD_PROC(&softc->sysctl_ctx,SYSCTL_CHILDREN(softc->sysctl_tree),
1907 OID_AUTO, "ha_role", CTLTYPE_INT | CTLFLAG_RWTUN,
1908 softc, 0, ctl_ha_role_sysctl, "I", "HA role for this head");
1910 if (softc->is_single == 0) {
1911 ctl_frontend_register(&ha_frontend);
1912 if (ctl_ha_msg_init(softc) != CTL_HA_STATUS_SUCCESS) {
1913 printf("ctl_init: ctl_ha_msg_init failed.\n");
1914 softc->is_single = 1;
1916 if (ctl_ha_msg_register(CTL_HA_CHAN_CTL, ctl_isc_event_handler)
1917 != CTL_HA_STATUS_SUCCESS) {
1918 printf("ctl_init: ctl_ha_msg_register failed.\n");
1919 softc->is_single = 1;
1928 struct ctl_softc *softc = control_softc;
1929 struct ctl_lun *lun, *next_lun;
1931 if (softc->is_single == 0) {
1932 ctl_ha_msg_shutdown(softc);
1933 if (ctl_ha_msg_deregister(CTL_HA_CHAN_CTL)
1934 != CTL_HA_STATUS_SUCCESS)
1935 printf("%s: ctl_ha_msg_deregister failed.\n", __func__);
1936 if (ctl_ha_msg_destroy(softc) != CTL_HA_STATUS_SUCCESS)
1937 printf("%s: ctl_ha_msg_destroy failed.\n", __func__);
1938 ctl_frontend_deregister(&ha_frontend);
1941 mtx_lock(&softc->ctl_lock);
1943 STAILQ_FOREACH_SAFE(lun, &softc->lun_list, links, next_lun)
1946 mtx_unlock(&softc->ctl_lock);
1949 ctl_shutdown_thread(softc->work_thread);
1950 mtx_destroy(&softc->queue_lock);
1953 ctl_tpc_shutdown(softc);
1954 uma_zdestroy(softc->io_zone);
1955 mtx_destroy(&softc->ctl_lock);
1957 destroy_dev(softc->dev);
1959 sysctl_ctx_free(&softc->sysctl_ctx);
1961 free(control_softc, M_DEVBUF);
1962 control_softc = NULL;
1966 ctl_module_event_handler(module_t mod, int what, void *arg)
1971 return (ctl_init());
1975 return (EOPNOTSUPP);
1980 * XXX KDM should we do some access checks here? Bump a reference count to
1981 * prevent a CTL module from being unloaded while someone has it open?
1984 ctl_open(struct cdev *dev, int flags, int fmt, struct thread *td)
1990 ctl_close(struct cdev *dev, int flags, int fmt, struct thread *td)
1996 * Remove an initiator by port number and initiator ID.
1997 * Returns 0 for success, -1 for failure.
2000 ctl_remove_initiator(struct ctl_port *port, int iid)
2002 struct ctl_softc *softc = port->ctl_softc;
2004 mtx_assert(&softc->ctl_lock, MA_NOTOWNED);
2006 if (iid > CTL_MAX_INIT_PER_PORT) {
2007 printf("%s: initiator ID %u > maximun %u!\n",
2008 __func__, iid, CTL_MAX_INIT_PER_PORT);
2012 mtx_lock(&softc->ctl_lock);
2013 port->wwpn_iid[iid].in_use--;
2014 port->wwpn_iid[iid].last_use = time_uptime;
2015 mtx_unlock(&softc->ctl_lock);
2016 ctl_isc_announce_iid(port, iid);
2022 * Add an initiator to the initiator map.
2023 * Returns iid for success, < 0 for failure.
2026 ctl_add_initiator(struct ctl_port *port, int iid, uint64_t wwpn, char *name)
2028 struct ctl_softc *softc = port->ctl_softc;
2032 mtx_assert(&softc->ctl_lock, MA_NOTOWNED);
2034 if (iid >= CTL_MAX_INIT_PER_PORT) {
2035 printf("%s: WWPN %#jx initiator ID %u > maximum %u!\n",
2036 __func__, wwpn, iid, CTL_MAX_INIT_PER_PORT);
2041 mtx_lock(&softc->ctl_lock);
2043 if (iid < 0 && (wwpn != 0 || name != NULL)) {
2044 for (i = 0; i < CTL_MAX_INIT_PER_PORT; i++) {
2045 if (wwpn != 0 && wwpn == port->wwpn_iid[i].wwpn) {
2049 if (name != NULL && port->wwpn_iid[i].name != NULL &&
2050 strcmp(name, port->wwpn_iid[i].name) == 0) {
2058 for (i = 0; i < CTL_MAX_INIT_PER_PORT; i++) {
2059 if (port->wwpn_iid[i].in_use == 0 &&
2060 port->wwpn_iid[i].wwpn == 0 &&
2061 port->wwpn_iid[i].name == NULL) {
2070 best_time = INT32_MAX;
2071 for (i = 0; i < CTL_MAX_INIT_PER_PORT; i++) {
2072 if (port->wwpn_iid[i].in_use == 0) {
2073 if (port->wwpn_iid[i].last_use < best_time) {
2075 best_time = port->wwpn_iid[i].last_use;
2083 mtx_unlock(&softc->ctl_lock);
2088 if (port->wwpn_iid[iid].in_use > 0 && (wwpn != 0 || name != NULL)) {
2090 * This is not an error yet.
2092 if (wwpn != 0 && wwpn == port->wwpn_iid[iid].wwpn) {
2094 printf("%s: port %d iid %u WWPN %#jx arrived"
2095 " again\n", __func__, port->targ_port,
2096 iid, (uintmax_t)wwpn);
2100 if (name != NULL && port->wwpn_iid[iid].name != NULL &&
2101 strcmp(name, port->wwpn_iid[iid].name) == 0) {
2103 printf("%s: port %d iid %u name '%s' arrived"
2104 " again\n", __func__, port->targ_port,
2111 * This is an error, but what do we do about it? The
2112 * driver is telling us we have a new WWPN for this
2113 * initiator ID, so we pretty much need to use it.
2115 printf("%s: port %d iid %u WWPN %#jx '%s' arrived,"
2116 " but WWPN %#jx '%s' is still at that address\n",
2117 __func__, port->targ_port, iid, wwpn, name,
2118 (uintmax_t)port->wwpn_iid[iid].wwpn,
2119 port->wwpn_iid[iid].name);
2122 * XXX KDM clear have_ca and ua_pending on each LUN for
2127 free(port->wwpn_iid[iid].name, M_CTL);
2128 port->wwpn_iid[iid].name = name;
2129 port->wwpn_iid[iid].wwpn = wwpn;
2130 port->wwpn_iid[iid].in_use++;
2131 mtx_unlock(&softc->ctl_lock);
2132 ctl_isc_announce_iid(port, iid);
2138 ctl_create_iid(struct ctl_port *port, int iid, uint8_t *buf)
2142 switch (port->port_type) {
2145 struct scsi_transportid_fcp *id =
2146 (struct scsi_transportid_fcp *)buf;
2147 if (port->wwpn_iid[iid].wwpn == 0)
2149 memset(id, 0, sizeof(*id));
2150 id->format_protocol = SCSI_PROTO_FC;
2151 scsi_u64to8b(port->wwpn_iid[iid].wwpn, id->n_port_name);
2152 return (sizeof(*id));
2154 case CTL_PORT_ISCSI:
2156 struct scsi_transportid_iscsi_port *id =
2157 (struct scsi_transportid_iscsi_port *)buf;
2158 if (port->wwpn_iid[iid].name == NULL)
2161 id->format_protocol = SCSI_TRN_ISCSI_FORMAT_PORT |
2163 len = strlcpy(id->iscsi_name, port->wwpn_iid[iid].name, 252) + 1;
2164 len = roundup2(min(len, 252), 4);
2165 scsi_ulto2b(len, id->additional_length);
2166 return (sizeof(*id) + len);
2170 struct scsi_transportid_sas *id =
2171 (struct scsi_transportid_sas *)buf;
2172 if (port->wwpn_iid[iid].wwpn == 0)
2174 memset(id, 0, sizeof(*id));
2175 id->format_protocol = SCSI_PROTO_SAS;
2176 scsi_u64to8b(port->wwpn_iid[iid].wwpn, id->sas_address);
2177 return (sizeof(*id));
2181 struct scsi_transportid_spi *id =
2182 (struct scsi_transportid_spi *)buf;
2183 memset(id, 0, sizeof(*id));
2184 id->format_protocol = SCSI_PROTO_SPI;
2185 scsi_ulto2b(iid, id->scsi_addr);
2186 scsi_ulto2b(port->targ_port, id->rel_trgt_port_id);
2187 return (sizeof(*id));
2193 * Serialize a command that went down the "wrong" side, and so was sent to
2194 * this controller for execution. The logic is a little different than the
2195 * standard case in ctl_scsiio_precheck(). Errors in this case need to get
2196 * sent back to the other side, but in the success case, we execute the
2197 * command on this side (XFER mode) or tell the other side to execute it
2201 ctl_serialize_other_sc_cmd(struct ctl_scsiio *ctsio)
2203 struct ctl_softc *softc = control_softc;
2204 union ctl_ha_msg msg_info;
2205 struct ctl_port *port;
2206 struct ctl_lun *lun;
2207 const struct ctl_cmd_entry *entry;
2211 targ_lun = ctsio->io_hdr.nexus.targ_mapped_lun;
2212 mtx_lock(&softc->ctl_lock);
2214 /* Make sure that we know about this port. */
2215 port = ctl_io_port(&ctsio->io_hdr);
2216 if (port == NULL || (port->status & CTL_PORT_STATUS_ONLINE) == 0) {
2217 ctl_set_internal_failure(ctsio, /*sks_valid*/ 0,
2222 /* Make sure that we know about this LUN. */
2223 if ((targ_lun < CTL_MAX_LUNS) &&
2224 ((lun = softc->ctl_luns[targ_lun]) != NULL)) {
2225 mtx_lock(&lun->lun_lock);
2226 mtx_unlock(&softc->ctl_lock);
2228 * If the LUN is invalid, pretend that it doesn't exist.
2229 * It will go away as soon as all pending I/O has been
2232 if (lun->flags & CTL_LUN_DISABLED) {
2233 mtx_unlock(&lun->lun_lock);
2237 mtx_unlock(&softc->ctl_lock);
2242 * The other node would not send this request to us unless
2243 * received announce that we are primary node for this LUN.
2244 * If this LUN does not exist now, it is probably result of
2245 * a race, so respond to initiator in the most opaque way.
2247 ctl_set_busy(ctsio);
2251 entry = ctl_get_cmd_entry(ctsio, NULL);
2252 if (ctl_scsiio_lun_check(lun, entry, ctsio) != 0) {
2253 mtx_unlock(&lun->lun_lock);
2257 ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr = lun;
2258 ctsio->io_hdr.ctl_private[CTL_PRIV_BACKEND_LUN].ptr = lun->be_lun;
2261 * Every I/O goes into the OOA queue for a
2262 * particular LUN, and stays there until completion.
2265 if (TAILQ_EMPTY(&lun->ooa_queue))
2266 lun->idle_time += getsbinuptime() - lun->last_busy;
2268 TAILQ_INSERT_TAIL(&lun->ooa_queue, &ctsio->io_hdr, ooa_links);
2270 switch (ctl_check_ooa(lun, (union ctl_io *)ctsio,
2271 (union ctl_io *)TAILQ_PREV(&ctsio->io_hdr, ctl_ooaq,
2273 case CTL_ACTION_BLOCK:
2274 ctsio->io_hdr.flags |= CTL_FLAG_BLOCKED;
2275 TAILQ_INSERT_TAIL(&lun->blocked_queue, &ctsio->io_hdr,
2277 mtx_unlock(&lun->lun_lock);
2279 case CTL_ACTION_PASS:
2280 case CTL_ACTION_SKIP:
2281 if (softc->ha_mode == CTL_HA_MODE_XFER) {
2282 ctsio->io_hdr.flags |= CTL_FLAG_IS_WAS_ON_RTR;
2283 ctl_enqueue_rtr((union ctl_io *)ctsio);
2284 mtx_unlock(&lun->lun_lock);
2286 ctsio->io_hdr.flags &= ~CTL_FLAG_IO_ACTIVE;
2287 mtx_unlock(&lun->lun_lock);
2289 /* send msg back to other side */
2290 msg_info.hdr.original_sc = ctsio->io_hdr.original_sc;
2291 msg_info.hdr.serializing_sc = (union ctl_io *)ctsio;
2292 msg_info.hdr.msg_type = CTL_MSG_R2R;
2293 ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg_info,
2294 sizeof(msg_info.hdr), M_WAITOK);
2297 case CTL_ACTION_OVERLAP:
2298 TAILQ_REMOVE(&lun->ooa_queue, &ctsio->io_hdr, ooa_links);
2299 mtx_unlock(&lun->lun_lock);
2300 ctl_set_overlapped_cmd(ctsio);
2302 case CTL_ACTION_OVERLAP_TAG:
2303 TAILQ_REMOVE(&lun->ooa_queue, &ctsio->io_hdr, ooa_links);
2304 mtx_unlock(&lun->lun_lock);
2305 ctl_set_overlapped_tag(ctsio, ctsio->tag_num);
2307 case CTL_ACTION_ERROR:
2309 TAILQ_REMOVE(&lun->ooa_queue, &ctsio->io_hdr, ooa_links);
2310 mtx_unlock(&lun->lun_lock);
2312 ctl_set_internal_failure(ctsio, /*sks_valid*/ 0,
2315 ctl_copy_sense_data_back((union ctl_io *)ctsio, &msg_info);
2316 msg_info.hdr.original_sc = ctsio->io_hdr.original_sc;
2317 msg_info.hdr.serializing_sc = NULL;
2318 msg_info.hdr.msg_type = CTL_MSG_BAD_JUJU;
2319 ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg_info,
2320 sizeof(msg_info.scsi), M_WAITOK);
2328 * Returns 0 for success, errno for failure.
2331 ctl_ioctl_fill_ooa(struct ctl_lun *lun, uint32_t *cur_fill_num,
2332 struct ctl_ooa *ooa_hdr, struct ctl_ooa_entry *kern_entries)
2336 mtx_lock(&lun->lun_lock);
2337 for (io = (union ctl_io *)TAILQ_FIRST(&lun->ooa_queue); (io != NULL);
2338 (*cur_fill_num)++, io = (union ctl_io *)TAILQ_NEXT(&io->io_hdr,
2340 struct ctl_ooa_entry *entry;
2343 * If we've got more than we can fit, just count the
2344 * remaining entries.
2346 if (*cur_fill_num >= ooa_hdr->alloc_num)
2349 entry = &kern_entries[*cur_fill_num];
2351 entry->tag_num = io->scsiio.tag_num;
2352 entry->lun_num = lun->lun;
2354 entry->start_bt = io->io_hdr.start_bt;
2356 bcopy(io->scsiio.cdb, entry->cdb, io->scsiio.cdb_len);
2357 entry->cdb_len = io->scsiio.cdb_len;
2358 if (io->io_hdr.flags & CTL_FLAG_BLOCKED)
2359 entry->cmd_flags |= CTL_OOACMD_FLAG_BLOCKED;
2361 if (io->io_hdr.flags & CTL_FLAG_DMA_INPROG)
2362 entry->cmd_flags |= CTL_OOACMD_FLAG_DMA;
2364 if (io->io_hdr.flags & CTL_FLAG_ABORT)
2365 entry->cmd_flags |= CTL_OOACMD_FLAG_ABORT;
2367 if (io->io_hdr.flags & CTL_FLAG_IS_WAS_ON_RTR)
2368 entry->cmd_flags |= CTL_OOACMD_FLAG_RTR;
2370 if (io->io_hdr.flags & CTL_FLAG_DMA_QUEUED)
2371 entry->cmd_flags |= CTL_OOACMD_FLAG_DMA_QUEUED;
2373 mtx_unlock(&lun->lun_lock);
2377 ctl_copyin_alloc(void *user_addr, int len, char *error_str,
2378 size_t error_str_len)
2382 kptr = malloc(len, M_CTL, M_WAITOK | M_ZERO);
2384 if (copyin(user_addr, kptr, len) != 0) {
2385 snprintf(error_str, error_str_len, "Error copying %d bytes "
2386 "from user address %p to kernel address %p", len,
2396 ctl_free_args(int num_args, struct ctl_be_arg *args)
2403 for (i = 0; i < num_args; i++) {
2404 free(args[i].kname, M_CTL);
2405 free(args[i].kvalue, M_CTL);
2411 static struct ctl_be_arg *
2412 ctl_copyin_args(int num_args, struct ctl_be_arg *uargs,
2413 char *error_str, size_t error_str_len)
2415 struct ctl_be_arg *args;
2418 args = ctl_copyin_alloc(uargs, num_args * sizeof(*args),
2419 error_str, error_str_len);
2424 for (i = 0; i < num_args; i++) {
2425 args[i].kname = NULL;
2426 args[i].kvalue = NULL;
2429 for (i = 0; i < num_args; i++) {
2432 args[i].kname = ctl_copyin_alloc(args[i].name,
2433 args[i].namelen, error_str, error_str_len);
2434 if (args[i].kname == NULL)
2437 if (args[i].kname[args[i].namelen - 1] != '\0') {
2438 snprintf(error_str, error_str_len, "Argument %d "
2439 "name is not NUL-terminated", i);
2443 if (args[i].flags & CTL_BEARG_RD) {
2444 tmpptr = ctl_copyin_alloc(args[i].value,
2445 args[i].vallen, error_str, error_str_len);
2448 if ((args[i].flags & CTL_BEARG_ASCII)
2449 && (tmpptr[args[i].vallen - 1] != '\0')) {
2450 snprintf(error_str, error_str_len, "Argument "
2451 "%d value is not NUL-terminated", i);
2452 free(tmpptr, M_CTL);
2455 args[i].kvalue = tmpptr;
2457 args[i].kvalue = malloc(args[i].vallen,
2458 M_CTL, M_WAITOK | M_ZERO);
2465 ctl_free_args(num_args, args);
2471 ctl_copyout_args(int num_args, struct ctl_be_arg *args)
2475 for (i = 0; i < num_args; i++) {
2476 if (args[i].flags & CTL_BEARG_WR)
2477 copyout(args[i].kvalue, args[i].value, args[i].vallen);
2482 * Escape characters that are illegal or not recommended in XML.
2485 ctl_sbuf_printf_esc(struct sbuf *sb, char *str, int size)
2487 char *end = str + size;
2492 for (; *str && str < end; str++) {
2495 retval = sbuf_printf(sb, "&");
2498 retval = sbuf_printf(sb, ">");
2501 retval = sbuf_printf(sb, "<");
2504 retval = sbuf_putc(sb, *str);
2517 ctl_id_sbuf(struct ctl_devid *id, struct sbuf *sb)
2519 struct scsi_vpd_id_descriptor *desc;
2522 if (id == NULL || id->len < 4)
2524 desc = (struct scsi_vpd_id_descriptor *)id->data;
2525 switch (desc->id_type & SVPD_ID_TYPE_MASK) {
2526 case SVPD_ID_TYPE_T10:
2527 sbuf_printf(sb, "t10.");
2529 case SVPD_ID_TYPE_EUI64:
2530 sbuf_printf(sb, "eui.");
2532 case SVPD_ID_TYPE_NAA:
2533 sbuf_printf(sb, "naa.");
2535 case SVPD_ID_TYPE_SCSI_NAME:
2538 switch (desc->proto_codeset & SVPD_ID_CODESET_MASK) {
2539 case SVPD_ID_CODESET_BINARY:
2540 for (i = 0; i < desc->length; i++)
2541 sbuf_printf(sb, "%02x", desc->identifier[i]);
2543 case SVPD_ID_CODESET_ASCII:
2544 sbuf_printf(sb, "%.*s", (int)desc->length,
2545 (char *)desc->identifier);
2547 case SVPD_ID_CODESET_UTF8:
2548 sbuf_printf(sb, "%s", (char *)desc->identifier);
2554 ctl_ioctl(struct cdev *dev, u_long cmd, caddr_t addr, int flag,
2557 struct ctl_softc *softc = dev->si_drv1;
2558 struct ctl_lun *lun;
2565 retval = ctl_ioctl_io(dev, cmd, addr, flag, td);
2567 case CTL_ENABLE_PORT:
2568 case CTL_DISABLE_PORT:
2569 case CTL_SET_PORT_WWNS: {
2570 struct ctl_port *port;
2571 struct ctl_port_entry *entry;
2573 entry = (struct ctl_port_entry *)addr;
2575 mtx_lock(&softc->ctl_lock);
2576 STAILQ_FOREACH(port, &softc->port_list, links) {
2579 if (port->targ_port < softc->port_min ||
2580 port->targ_port >= softc->port_max)
2585 if ((entry->port_type == CTL_PORT_NONE)
2586 && (entry->targ_port == port->targ_port)) {
2588 * If the user only wants to enable or
2589 * disable or set WWNs on a specific port,
2590 * do the operation and we're done.
2594 } else if (entry->port_type & port->port_type) {
2596 * Compare the user's type mask with the
2597 * particular frontend type to see if we
2604 * Make sure the user isn't trying to set
2605 * WWNs on multiple ports at the same time.
2607 if (cmd == CTL_SET_PORT_WWNS) {
2608 printf("%s: Can't set WWNs on "
2609 "multiple ports\n", __func__);
2618 * XXX KDM we have to drop the lock here, because
2619 * the online/offline operations can potentially
2620 * block. We need to reference count the frontends
2621 * so they can't go away,
2623 if (cmd == CTL_ENABLE_PORT) {
2624 mtx_unlock(&softc->ctl_lock);
2625 ctl_port_online(port);
2626 mtx_lock(&softc->ctl_lock);
2627 } else if (cmd == CTL_DISABLE_PORT) {
2628 mtx_unlock(&softc->ctl_lock);
2629 ctl_port_offline(port);
2630 mtx_lock(&softc->ctl_lock);
2631 } else if (cmd == CTL_SET_PORT_WWNS) {
2632 ctl_port_set_wwns(port,
2633 (entry->flags & CTL_PORT_WWNN_VALID) ?
2635 (entry->flags & CTL_PORT_WWPN_VALID) ?
2636 1 : 0, entry->wwpn);
2641 mtx_unlock(&softc->ctl_lock);
2645 struct ctl_ooa *ooa_hdr;
2646 struct ctl_ooa_entry *entries;
2647 uint32_t cur_fill_num;
2649 ooa_hdr = (struct ctl_ooa *)addr;
2651 if ((ooa_hdr->alloc_len == 0)
2652 || (ooa_hdr->alloc_num == 0)) {
2653 printf("%s: CTL_GET_OOA: alloc len %u and alloc num %u "
2654 "must be non-zero\n", __func__,
2655 ooa_hdr->alloc_len, ooa_hdr->alloc_num);
2660 if (ooa_hdr->alloc_len != (ooa_hdr->alloc_num *
2661 sizeof(struct ctl_ooa_entry))) {
2662 printf("%s: CTL_GET_OOA: alloc len %u must be alloc "
2663 "num %d * sizeof(struct ctl_ooa_entry) %zd\n",
2664 __func__, ooa_hdr->alloc_len,
2665 ooa_hdr->alloc_num,sizeof(struct ctl_ooa_entry));
2670 entries = malloc(ooa_hdr->alloc_len, M_CTL, M_WAITOK | M_ZERO);
2671 if (entries == NULL) {
2672 printf("%s: could not allocate %d bytes for OOA "
2673 "dump\n", __func__, ooa_hdr->alloc_len);
2678 mtx_lock(&softc->ctl_lock);
2679 if (((ooa_hdr->flags & CTL_OOA_FLAG_ALL_LUNS) == 0)
2680 && ((ooa_hdr->lun_num >= CTL_MAX_LUNS)
2681 || (softc->ctl_luns[ooa_hdr->lun_num] == NULL))) {
2682 mtx_unlock(&softc->ctl_lock);
2683 free(entries, M_CTL);
2684 printf("%s: CTL_GET_OOA: invalid LUN %ju\n",
2685 __func__, (uintmax_t)ooa_hdr->lun_num);
2692 if (ooa_hdr->flags & CTL_OOA_FLAG_ALL_LUNS) {
2693 STAILQ_FOREACH(lun, &softc->lun_list, links) {
2694 ctl_ioctl_fill_ooa(lun, &cur_fill_num,
2698 lun = softc->ctl_luns[ooa_hdr->lun_num];
2699 ctl_ioctl_fill_ooa(lun, &cur_fill_num, ooa_hdr,
2702 mtx_unlock(&softc->ctl_lock);
2704 ooa_hdr->fill_num = min(cur_fill_num, ooa_hdr->alloc_num);
2705 ooa_hdr->fill_len = ooa_hdr->fill_num *
2706 sizeof(struct ctl_ooa_entry);
2707 retval = copyout(entries, ooa_hdr->entries, ooa_hdr->fill_len);
2709 printf("%s: error copying out %d bytes for OOA dump\n",
2710 __func__, ooa_hdr->fill_len);
2713 getbinuptime(&ooa_hdr->cur_bt);
2715 if (cur_fill_num > ooa_hdr->alloc_num) {
2716 ooa_hdr->dropped_num = cur_fill_num -ooa_hdr->alloc_num;
2717 ooa_hdr->status = CTL_OOA_NEED_MORE_SPACE;
2719 ooa_hdr->dropped_num = 0;
2720 ooa_hdr->status = CTL_OOA_OK;
2723 free(entries, M_CTL);
2726 case CTL_DELAY_IO: {
2727 struct ctl_io_delay_info *delay_info;
2729 delay_info = (struct ctl_io_delay_info *)addr;
2732 mtx_lock(&softc->ctl_lock);
2734 if ((delay_info->lun_id >= CTL_MAX_LUNS)
2735 || (softc->ctl_luns[delay_info->lun_id] == NULL)) {
2736 delay_info->status = CTL_DELAY_STATUS_INVALID_LUN;
2738 lun = softc->ctl_luns[delay_info->lun_id];
2739 mtx_lock(&lun->lun_lock);
2741 delay_info->status = CTL_DELAY_STATUS_OK;
2743 switch (delay_info->delay_type) {
2744 case CTL_DELAY_TYPE_CONT:
2746 case CTL_DELAY_TYPE_ONESHOT:
2749 delay_info->status =
2750 CTL_DELAY_STATUS_INVALID_TYPE;
2754 switch (delay_info->delay_loc) {
2755 case CTL_DELAY_LOC_DATAMOVE:
2756 lun->delay_info.datamove_type =
2757 delay_info->delay_type;
2758 lun->delay_info.datamove_delay =
2759 delay_info->delay_secs;
2761 case CTL_DELAY_LOC_DONE:
2762 lun->delay_info.done_type =
2763 delay_info->delay_type;
2764 lun->delay_info.done_delay =
2765 delay_info->delay_secs;
2768 delay_info->status =
2769 CTL_DELAY_STATUS_INVALID_LOC;
2772 mtx_unlock(&lun->lun_lock);
2775 mtx_unlock(&softc->ctl_lock);
2777 delay_info->status = CTL_DELAY_STATUS_NOT_IMPLEMENTED;
2778 #endif /* CTL_IO_DELAY */
2781 case CTL_GETSTATS: {
2782 struct ctl_stats *stats;
2785 stats = (struct ctl_stats *)addr;
2787 if ((sizeof(struct ctl_lun_io_stats) * softc->num_luns) >
2789 stats->status = CTL_SS_NEED_MORE_SPACE;
2790 stats->num_luns = softc->num_luns;
2794 * XXX KDM no locking here. If the LUN list changes,
2795 * things can blow up.
2798 STAILQ_FOREACH(lun, &softc->lun_list, links) {
2799 retval = copyout(&lun->stats, &stats->lun_stats[i++],
2800 sizeof(lun->stats));
2804 stats->num_luns = softc->num_luns;
2805 stats->fill_len = sizeof(struct ctl_lun_io_stats) *
2807 stats->status = CTL_SS_OK;
2809 stats->flags = CTL_STATS_FLAG_TIME_VALID;
2811 stats->flags = CTL_STATS_FLAG_NONE;
2813 getnanouptime(&stats->timestamp);
2816 case CTL_ERROR_INJECT: {
2817 struct ctl_error_desc *err_desc, *new_err_desc;
2819 err_desc = (struct ctl_error_desc *)addr;
2821 new_err_desc = malloc(sizeof(*new_err_desc), M_CTL,
2823 bcopy(err_desc, new_err_desc, sizeof(*new_err_desc));
2825 mtx_lock(&softc->ctl_lock);
2826 lun = softc->ctl_luns[err_desc->lun_id];
2828 mtx_unlock(&softc->ctl_lock);
2829 free(new_err_desc, M_CTL);
2830 printf("%s: CTL_ERROR_INJECT: invalid LUN %ju\n",
2831 __func__, (uintmax_t)err_desc->lun_id);
2835 mtx_lock(&lun->lun_lock);
2836 mtx_unlock(&softc->ctl_lock);
2839 * We could do some checking here to verify the validity
2840 * of the request, but given the complexity of error
2841 * injection requests, the checking logic would be fairly
2844 * For now, if the request is invalid, it just won't get
2845 * executed and might get deleted.
2847 STAILQ_INSERT_TAIL(&lun->error_list, new_err_desc, links);
2850 * XXX KDM check to make sure the serial number is unique,
2851 * in case we somehow manage to wrap. That shouldn't
2852 * happen for a very long time, but it's the right thing to
2855 new_err_desc->serial = lun->error_serial;
2856 err_desc->serial = lun->error_serial;
2857 lun->error_serial++;
2859 mtx_unlock(&lun->lun_lock);
2862 case CTL_ERROR_INJECT_DELETE: {
2863 struct ctl_error_desc *delete_desc, *desc, *desc2;
2866 delete_desc = (struct ctl_error_desc *)addr;
2869 mtx_lock(&softc->ctl_lock);
2870 lun = softc->ctl_luns[delete_desc->lun_id];
2872 mtx_unlock(&softc->ctl_lock);
2873 printf("%s: CTL_ERROR_INJECT_DELETE: invalid LUN %ju\n",
2874 __func__, (uintmax_t)delete_desc->lun_id);
2878 mtx_lock(&lun->lun_lock);
2879 mtx_unlock(&softc->ctl_lock);
2880 STAILQ_FOREACH_SAFE(desc, &lun->error_list, links, desc2) {
2881 if (desc->serial != delete_desc->serial)
2884 STAILQ_REMOVE(&lun->error_list, desc, ctl_error_desc,
2889 mtx_unlock(&lun->lun_lock);
2890 if (delete_done == 0) {
2891 printf("%s: CTL_ERROR_INJECT_DELETE: can't find "
2892 "error serial %ju on LUN %u\n", __func__,
2893 delete_desc->serial, delete_desc->lun_id);
2899 case CTL_DUMP_STRUCTS: {
2901 struct ctl_port *port;
2902 struct ctl_frontend *fe;
2904 mtx_lock(&softc->ctl_lock);
2905 printf("CTL Persistent Reservation information start:\n");
2906 for (i = 0; i < CTL_MAX_LUNS; i++) {
2907 lun = softc->ctl_luns[i];
2910 || ((lun->flags & CTL_LUN_DISABLED) != 0))
2913 for (j = 0; j < CTL_MAX_PORTS; j++) {
2914 if (lun->pr_keys[j] == NULL)
2916 for (k = 0; k < CTL_MAX_INIT_PER_PORT; k++){
2917 if (lun->pr_keys[j][k] == 0)
2919 printf(" LUN %d port %d iid %d key "
2921 (uintmax_t)lun->pr_keys[j][k]);
2925 printf("CTL Persistent Reservation information end\n");
2926 printf("CTL Ports:\n");
2927 STAILQ_FOREACH(port, &softc->port_list, links) {
2928 printf(" Port %d '%s' Frontend '%s' Type %u pp %d vp %d WWNN "
2929 "%#jx WWPN %#jx\n", port->targ_port, port->port_name,
2930 port->frontend->name, port->port_type,
2931 port->physical_port, port->virtual_port,
2932 (uintmax_t)port->wwnn, (uintmax_t)port->wwpn);
2933 for (j = 0; j < CTL_MAX_INIT_PER_PORT; j++) {
2934 if (port->wwpn_iid[j].in_use == 0 &&
2935 port->wwpn_iid[j].wwpn == 0 &&
2936 port->wwpn_iid[j].name == NULL)
2939 printf(" iid %u use %d WWPN %#jx '%s'\n",
2940 j, port->wwpn_iid[j].in_use,
2941 (uintmax_t)port->wwpn_iid[j].wwpn,
2942 port->wwpn_iid[j].name);
2945 printf("CTL Port information end\n");
2946 mtx_unlock(&softc->ctl_lock);
2948 * XXX KDM calling this without a lock. We'd likely want
2949 * to drop the lock before calling the frontend's dump
2952 printf("CTL Frontends:\n");
2953 STAILQ_FOREACH(fe, &softc->fe_list, links) {
2954 printf(" Frontend '%s'\n", fe->name);
2955 if (fe->fe_dump != NULL)
2958 printf("CTL Frontend information end\n");
2962 struct ctl_lun_req *lun_req;
2963 struct ctl_backend_driver *backend;
2965 lun_req = (struct ctl_lun_req *)addr;
2967 backend = ctl_backend_find(lun_req->backend);
2968 if (backend == NULL) {
2969 lun_req->status = CTL_LUN_ERROR;
2970 snprintf(lun_req->error_str,
2971 sizeof(lun_req->error_str),
2972 "Backend \"%s\" not found.",
2976 if (lun_req->num_be_args > 0) {
2977 lun_req->kern_be_args = ctl_copyin_args(
2978 lun_req->num_be_args,
2981 sizeof(lun_req->error_str));
2982 if (lun_req->kern_be_args == NULL) {
2983 lun_req->status = CTL_LUN_ERROR;
2988 retval = backend->ioctl(dev, cmd, addr, flag, td);
2990 if (lun_req->num_be_args > 0) {
2991 ctl_copyout_args(lun_req->num_be_args,
2992 lun_req->kern_be_args);
2993 ctl_free_args(lun_req->num_be_args,
2994 lun_req->kern_be_args);
2998 case CTL_LUN_LIST: {
3000 struct ctl_lun_list *list;
3001 struct ctl_option *opt;
3003 list = (struct ctl_lun_list *)addr;
3006 * Allocate a fixed length sbuf here, based on the length
3007 * of the user's buffer. We could allocate an auto-extending
3008 * buffer, and then tell the user how much larger our
3009 * amount of data is than his buffer, but that presents
3012 * 1. The sbuf(9) routines use a blocking malloc, and so
3013 * we can't hold a lock while calling them with an
3014 * auto-extending buffer.
3016 * 2. There is not currently a LUN reference counting
3017 * mechanism, outside of outstanding transactions on
3018 * the LUN's OOA queue. So a LUN could go away on us
3019 * while we're getting the LUN number, backend-specific
3020 * information, etc. Thus, given the way things
3021 * currently work, we need to hold the CTL lock while
3022 * grabbing LUN information.
3024 * So, from the user's standpoint, the best thing to do is
3025 * allocate what he thinks is a reasonable buffer length,
3026 * and then if he gets a CTL_LUN_LIST_NEED_MORE_SPACE error,
3027 * double the buffer length and try again. (And repeat
3028 * that until he succeeds.)
3030 sb = sbuf_new(NULL, NULL, list->alloc_len, SBUF_FIXEDLEN);
3032 list->status = CTL_LUN_LIST_ERROR;
3033 snprintf(list->error_str, sizeof(list->error_str),
3034 "Unable to allocate %d bytes for LUN list",
3039 sbuf_printf(sb, "<ctllunlist>\n");
3041 mtx_lock(&softc->ctl_lock);
3042 STAILQ_FOREACH(lun, &softc->lun_list, links) {
3043 mtx_lock(&lun->lun_lock);
3044 retval = sbuf_printf(sb, "<lun id=\"%ju\">\n",
3045 (uintmax_t)lun->lun);
3048 * Bail out as soon as we see that we've overfilled
3054 retval = sbuf_printf(sb, "\t<backend_type>%s"
3055 "</backend_type>\n",
3056 (lun->backend == NULL) ? "none" :
3057 lun->backend->name);
3062 retval = sbuf_printf(sb, "\t<lun_type>%d</lun_type>\n",
3063 lun->be_lun->lun_type);
3068 if (lun->backend == NULL) {
3069 retval = sbuf_printf(sb, "</lun>\n");
3075 retval = sbuf_printf(sb, "\t<size>%ju</size>\n",
3076 (lun->be_lun->maxlba > 0) ?
3077 lun->be_lun->maxlba + 1 : 0);
3082 retval = sbuf_printf(sb, "\t<blocksize>%u</blocksize>\n",
3083 lun->be_lun->blocksize);
3088 retval = sbuf_printf(sb, "\t<serial_number>");
3093 retval = ctl_sbuf_printf_esc(sb,
3094 lun->be_lun->serial_num,
3095 sizeof(lun->be_lun->serial_num));
3100 retval = sbuf_printf(sb, "</serial_number>\n");
3105 retval = sbuf_printf(sb, "\t<device_id>");
3110 retval = ctl_sbuf_printf_esc(sb,
3111 lun->be_lun->device_id,
3112 sizeof(lun->be_lun->device_id));
3117 retval = sbuf_printf(sb, "</device_id>\n");
3122 if (lun->backend->lun_info != NULL) {
3123 retval = lun->backend->lun_info(lun->be_lun->be_lun, sb);
3127 STAILQ_FOREACH(opt, &lun->be_lun->options, links) {
3128 retval = sbuf_printf(sb, "\t<%s>%s</%s>\n",
3129 opt->name, opt->value, opt->name);
3134 retval = sbuf_printf(sb, "</lun>\n");
3138 mtx_unlock(&lun->lun_lock);
3141 mtx_unlock(&lun->lun_lock);
3142 mtx_unlock(&softc->ctl_lock);
3145 || ((retval = sbuf_printf(sb, "</ctllunlist>\n")) != 0)) {
3148 list->status = CTL_LUN_LIST_NEED_MORE_SPACE;
3149 snprintf(list->error_str, sizeof(list->error_str),
3150 "Out of space, %d bytes is too small",
3157 retval = copyout(sbuf_data(sb), list->lun_xml,
3160 list->fill_len = sbuf_len(sb) + 1;
3161 list->status = CTL_LUN_LIST_OK;
3166 struct ctl_iscsi *ci;
3167 struct ctl_frontend *fe;
3169 ci = (struct ctl_iscsi *)addr;
3171 fe = ctl_frontend_find("iscsi");
3173 ci->status = CTL_ISCSI_ERROR;
3174 snprintf(ci->error_str, sizeof(ci->error_str),
3175 "Frontend \"iscsi\" not found.");
3179 retval = fe->ioctl(dev, cmd, addr, flag, td);
3182 case CTL_PORT_REQ: {
3183 struct ctl_req *req;
3184 struct ctl_frontend *fe;
3186 req = (struct ctl_req *)addr;
3188 fe = ctl_frontend_find(req->driver);
3190 req->status = CTL_LUN_ERROR;
3191 snprintf(req->error_str, sizeof(req->error_str),
3192 "Frontend \"%s\" not found.", req->driver);
3195 if (req->num_args > 0) {
3196 req->kern_args = ctl_copyin_args(req->num_args,
3197 req->args, req->error_str, sizeof(req->error_str));
3198 if (req->kern_args == NULL) {
3199 req->status = CTL_LUN_ERROR;
3205 retval = fe->ioctl(dev, cmd, addr, flag, td);
3209 if (req->num_args > 0) {
3210 ctl_copyout_args(req->num_args, req->kern_args);
3211 ctl_free_args(req->num_args, req->kern_args);
3215 case CTL_PORT_LIST: {
3217 struct ctl_port *port;
3218 struct ctl_lun_list *list;
3219 struct ctl_option *opt;
3223 list = (struct ctl_lun_list *)addr;
3225 sb = sbuf_new(NULL, NULL, list->alloc_len, SBUF_FIXEDLEN);
3227 list->status = CTL_LUN_LIST_ERROR;
3228 snprintf(list->error_str, sizeof(list->error_str),
3229 "Unable to allocate %d bytes for LUN list",
3234 sbuf_printf(sb, "<ctlportlist>\n");
3236 mtx_lock(&softc->ctl_lock);
3237 STAILQ_FOREACH(port, &softc->port_list, links) {
3238 retval = sbuf_printf(sb, "<targ_port id=\"%ju\">\n",
3239 (uintmax_t)port->targ_port);
3242 * Bail out as soon as we see that we've overfilled
3248 retval = sbuf_printf(sb, "\t<frontend_type>%s"
3249 "</frontend_type>\n", port->frontend->name);
3253 retval = sbuf_printf(sb, "\t<port_type>%d</port_type>\n",
3258 retval = sbuf_printf(sb, "\t<online>%s</online>\n",
3259 (port->status & CTL_PORT_STATUS_ONLINE) ? "YES" : "NO");
3263 retval = sbuf_printf(sb, "\t<port_name>%s</port_name>\n",
3268 retval = sbuf_printf(sb, "\t<physical_port>%d</physical_port>\n",
3269 port->physical_port);
3273 retval = sbuf_printf(sb, "\t<virtual_port>%d</virtual_port>\n",
3274 port->virtual_port);
3278 if (port->target_devid != NULL) {
3279 sbuf_printf(sb, "\t<target>");
3280 ctl_id_sbuf(port->target_devid, sb);
3281 sbuf_printf(sb, "</target>\n");
3284 if (port->port_devid != NULL) {
3285 sbuf_printf(sb, "\t<port>");
3286 ctl_id_sbuf(port->port_devid, sb);
3287 sbuf_printf(sb, "</port>\n");
3290 if (port->port_info != NULL) {
3291 retval = port->port_info(port->onoff_arg, sb);
3295 STAILQ_FOREACH(opt, &port->options, links) {
3296 retval = sbuf_printf(sb, "\t<%s>%s</%s>\n",
3297 opt->name, opt->value, opt->name);
3302 if (port->lun_map != NULL) {
3303 sbuf_printf(sb, "\t<lun_map>on</lun_map>\n");
3304 for (j = 0; j < CTL_MAX_LUNS; j++) {
3305 plun = ctl_lun_map_from_port(port, j);
3306 if (plun >= CTL_MAX_LUNS)
3309 "\t<lun id=\"%u\">%u</lun>\n",
3314 for (j = 0; j < CTL_MAX_INIT_PER_PORT; j++) {
3315 if (port->wwpn_iid[j].in_use == 0 ||
3316 (port->wwpn_iid[j].wwpn == 0 &&
3317 port->wwpn_iid[j].name == NULL))
3320 if (port->wwpn_iid[j].name != NULL)
3321 retval = sbuf_printf(sb,
3322 "\t<initiator id=\"%u\">%s</initiator>\n",
3323 j, port->wwpn_iid[j].name);
3325 retval = sbuf_printf(sb,
3326 "\t<initiator id=\"%u\">naa.%08jx</initiator>\n",
3327 j, port->wwpn_iid[j].wwpn);
3334 retval = sbuf_printf(sb, "</targ_port>\n");
3338 mtx_unlock(&softc->ctl_lock);
3341 || ((retval = sbuf_printf(sb, "</ctlportlist>\n")) != 0)) {
3344 list->status = CTL_LUN_LIST_NEED_MORE_SPACE;
3345 snprintf(list->error_str, sizeof(list->error_str),
3346 "Out of space, %d bytes is too small",
3353 retval = copyout(sbuf_data(sb), list->lun_xml,
3356 list->fill_len = sbuf_len(sb) + 1;
3357 list->status = CTL_LUN_LIST_OK;
3362 struct ctl_lun_map *lm = (struct ctl_lun_map *)addr;
3363 struct ctl_port *port;
3365 mtx_lock(&softc->ctl_lock);
3366 if (lm->port < softc->port_min ||
3367 lm->port >= softc->port_max ||
3368 (port = softc->ctl_ports[lm->port]) == NULL) {
3369 mtx_unlock(&softc->ctl_lock);
3372 if (port->status & CTL_PORT_STATUS_ONLINE) {
3373 STAILQ_FOREACH(lun, &softc->lun_list, links) {
3374 if (ctl_lun_map_to_port(port, lun->lun) >=
3377 mtx_lock(&lun->lun_lock);
3378 ctl_est_ua_port(lun, lm->port, -1,
3380 mtx_unlock(&lun->lun_lock);
3383 mtx_unlock(&softc->ctl_lock); // XXX: port_enable sleeps
3384 if (lm->plun < CTL_MAX_LUNS) {
3385 if (lm->lun == UINT32_MAX)
3386 retval = ctl_lun_map_unset(port, lm->plun);
3387 else if (lm->lun < CTL_MAX_LUNS &&
3388 softc->ctl_luns[lm->lun] != NULL)
3389 retval = ctl_lun_map_set(port, lm->plun, lm->lun);
3392 } else if (lm->plun == UINT32_MAX) {
3393 if (lm->lun == UINT32_MAX)
3394 retval = ctl_lun_map_deinit(port);
3396 retval = ctl_lun_map_init(port);
3399 if (port->status & CTL_PORT_STATUS_ONLINE)
3400 ctl_isc_announce_port(port);
3404 /* XXX KDM should we fix this? */
3406 struct ctl_backend_driver *backend;
3413 * We encode the backend type as the ioctl type for backend
3414 * ioctls. So parse it out here, and then search for a
3415 * backend of this type.
3417 type = _IOC_TYPE(cmd);
3419 STAILQ_FOREACH(backend, &softc->be_list, links) {
3420 if (backend->type == type) {
3426 printf("ctl: unknown ioctl command %#lx or backend "
3431 retval = backend->ioctl(dev, cmd, addr, flag, td);
3441 ctl_get_initindex(struct ctl_nexus *nexus)
3443 return (nexus->initid + (nexus->targ_port * CTL_MAX_INIT_PER_PORT));
3447 ctl_lun_map_init(struct ctl_port *port)
3449 struct ctl_softc *softc = port->ctl_softc;
3450 struct ctl_lun *lun;
3453 if (port->lun_map == NULL)
3454 port->lun_map = malloc(sizeof(uint32_t) * CTL_MAX_LUNS,
3456 if (port->lun_map == NULL)
3458 for (i = 0; i < CTL_MAX_LUNS; i++)
3459 port->lun_map[i] = UINT32_MAX;
3460 if (port->status & CTL_PORT_STATUS_ONLINE) {
3461 if (port->lun_disable != NULL) {
3462 STAILQ_FOREACH(lun, &softc->lun_list, links)
3463 port->lun_disable(port->targ_lun_arg, lun->lun);
3465 ctl_isc_announce_port(port);
3471 ctl_lun_map_deinit(struct ctl_port *port)
3473 struct ctl_softc *softc = port->ctl_softc;
3474 struct ctl_lun *lun;
3476 if (port->lun_map == NULL)
3478 free(port->lun_map, M_CTL);
3479 port->lun_map = NULL;
3480 if (port->status & CTL_PORT_STATUS_ONLINE) {
3481 if (port->lun_enable != NULL) {
3482 STAILQ_FOREACH(lun, &softc->lun_list, links)
3483 port->lun_enable(port->targ_lun_arg, lun->lun);
3485 ctl_isc_announce_port(port);
3491 ctl_lun_map_set(struct ctl_port *port, uint32_t plun, uint32_t glun)
3496 if (port->lun_map == NULL) {
3497 status = ctl_lun_map_init(port);
3501 old = port->lun_map[plun];
3502 port->lun_map[plun] = glun;
3503 if ((port->status & CTL_PORT_STATUS_ONLINE) && old >= CTL_MAX_LUNS) {
3504 if (port->lun_enable != NULL)
3505 port->lun_enable(port->targ_lun_arg, plun);
3506 ctl_isc_announce_port(port);
3512 ctl_lun_map_unset(struct ctl_port *port, uint32_t plun)
3516 if (port->lun_map == NULL)
3518 old = port->lun_map[plun];
3519 port->lun_map[plun] = UINT32_MAX;
3520 if ((port->status & CTL_PORT_STATUS_ONLINE) && old < CTL_MAX_LUNS) {
3521 if (port->lun_disable != NULL)
3522 port->lun_disable(port->targ_lun_arg, plun);
3523 ctl_isc_announce_port(port);
3529 ctl_lun_map_from_port(struct ctl_port *port, uint32_t lun_id)
3533 return (UINT32_MAX);
3534 if (port->lun_map == NULL || lun_id >= CTL_MAX_LUNS)
3536 return (port->lun_map[lun_id]);
3540 ctl_lun_map_to_port(struct ctl_port *port, uint32_t lun_id)
3545 return (UINT32_MAX);
3546 if (port->lun_map == NULL)
3548 for (i = 0; i < CTL_MAX_LUNS; i++) {
3549 if (port->lun_map[i] == lun_id)
3552 return (UINT32_MAX);
3556 ctl_decode_lun(uint64_t encoded)
3559 uint32_t result = 0xffffffff;
3561 be64enc(lun, encoded);
3562 switch (lun[0] & RPL_LUNDATA_ATYP_MASK) {
3563 case RPL_LUNDATA_ATYP_PERIPH:
3564 if ((lun[0] & 0x3f) == 0 && lun[2] == 0 && lun[3] == 0 &&
3565 lun[4] == 0 && lun[5] == 0 && lun[6] == 0 && lun[7] == 0)
3568 case RPL_LUNDATA_ATYP_FLAT:
3569 if (lun[2] == 0 && lun[3] == 0 && lun[4] == 0 && lun[5] == 0 &&
3570 lun[6] == 0 && lun[7] == 0)
3571 result = ((lun[0] & 0x3f) << 8) + lun[1];
3573 case RPL_LUNDATA_ATYP_EXTLUN:
3574 switch (lun[0] & RPL_LUNDATA_EXT_EAM_MASK) {
3576 switch (lun[0] & RPL_LUNDATA_EXT_LEN_MASK) {
3581 result = (lun[1] << 16) + (lun[2] << 8) +
3585 if (lun[1] == 0 && lun[6] == 0 && lun[7] == 0)
3586 result = (lun[2] << 24) +
3587 (lun[3] << 16) + (lun[4] << 8) +
3592 case RPL_LUNDATA_EXT_EAM_NOT_SPEC:
3593 result = 0xffffffff;
3602 ctl_encode_lun(uint32_t decoded)
3604 uint64_t l = decoded;
3607 return (((uint64_t)RPL_LUNDATA_ATYP_PERIPH << 56) | (l << 48));
3609 return (((uint64_t)RPL_LUNDATA_ATYP_FLAT << 56) | (l << 48));
3611 return (((uint64_t)(RPL_LUNDATA_ATYP_EXTLUN | 0x12) << 56) |
3613 return ((((uint64_t)RPL_LUNDATA_ATYP_EXTLUN | 0x22) << 56) | (l << 16));
3616 static struct ctl_port *
3617 ctl_io_port(struct ctl_io_hdr *io_hdr)
3620 return (control_softc->ctl_ports[io_hdr->nexus.targ_port]);
3624 ctl_ffz(uint32_t *mask, uint32_t first, uint32_t last)
3628 for (i = first; i < last; i++) {
3629 if ((mask[i / 32] & (1 << (i % 32))) == 0)
3636 ctl_set_mask(uint32_t *mask, uint32_t bit)
3638 uint32_t chunk, piece;
3641 piece = bit % (sizeof(uint32_t) * 8);
3643 if ((mask[chunk] & (1 << piece)) != 0)
3646 mask[chunk] |= (1 << piece);
3652 ctl_clear_mask(uint32_t *mask, uint32_t bit)
3654 uint32_t chunk, piece;
3657 piece = bit % (sizeof(uint32_t) * 8);
3659 if ((mask[chunk] & (1 << piece)) == 0)
3662 mask[chunk] &= ~(1 << piece);
3668 ctl_is_set(uint32_t *mask, uint32_t bit)
3670 uint32_t chunk, piece;
3673 piece = bit % (sizeof(uint32_t) * 8);
3675 if ((mask[chunk] & (1 << piece)) == 0)
3682 ctl_get_prkey(struct ctl_lun *lun, uint32_t residx)
3686 t = lun->pr_keys[residx/CTL_MAX_INIT_PER_PORT];
3689 return (t[residx % CTL_MAX_INIT_PER_PORT]);
3693 ctl_clr_prkey(struct ctl_lun *lun, uint32_t residx)
3697 t = lun->pr_keys[residx/CTL_MAX_INIT_PER_PORT];
3700 t[residx % CTL_MAX_INIT_PER_PORT] = 0;
3704 ctl_alloc_prkey(struct ctl_lun *lun, uint32_t residx)
3709 i = residx/CTL_MAX_INIT_PER_PORT;
3710 if (lun->pr_keys[i] != NULL)
3712 mtx_unlock(&lun->lun_lock);
3713 p = malloc(sizeof(uint64_t) * CTL_MAX_INIT_PER_PORT, M_CTL,
3715 mtx_lock(&lun->lun_lock);
3716 if (lun->pr_keys[i] == NULL)
3717 lun->pr_keys[i] = p;
3723 ctl_set_prkey(struct ctl_lun *lun, uint32_t residx, uint64_t key)
3727 t = lun->pr_keys[residx/CTL_MAX_INIT_PER_PORT];
3728 KASSERT(t != NULL, ("prkey %d is not allocated", residx));
3729 t[residx % CTL_MAX_INIT_PER_PORT] = key;
3733 * ctl_softc, pool_name, total_ctl_io are passed in.
3734 * npool is passed out.
3737 ctl_pool_create(struct ctl_softc *ctl_softc, const char *pool_name,
3738 uint32_t total_ctl_io, void **npool)
3741 struct ctl_io_pool *pool;
3743 pool = (struct ctl_io_pool *)malloc(sizeof(*pool), M_CTL,
3748 snprintf(pool->name, sizeof(pool->name), "CTL IO %s", pool_name);
3749 pool->ctl_softc = ctl_softc;
3750 pool->zone = uma_zsecond_create(pool->name, NULL,
3751 NULL, NULL, NULL, ctl_softc->io_zone);
3752 /* uma_prealloc(pool->zone, total_ctl_io); */
3756 *npool = ctl_softc->io_zone;
3762 ctl_pool_free(struct ctl_io_pool *pool)
3769 uma_zdestroy(pool->zone);
3775 ctl_alloc_io(void *pool_ref)
3779 struct ctl_io_pool *pool = (struct ctl_io_pool *)pool_ref;
3781 io = uma_zalloc(pool->zone, M_WAITOK);
3783 io = uma_zalloc((uma_zone_t)pool_ref, M_WAITOK);
3786 io->io_hdr.pool = pool_ref;
3791 ctl_alloc_io_nowait(void *pool_ref)
3795 struct ctl_io_pool *pool = (struct ctl_io_pool *)pool_ref;
3797 io = uma_zalloc(pool->zone, M_NOWAIT);
3799 io = uma_zalloc((uma_zone_t)pool_ref, M_NOWAIT);
3802 io->io_hdr.pool = pool_ref;
3807 ctl_free_io(union ctl_io *io)
3810 struct ctl_io_pool *pool;
3817 pool = (struct ctl_io_pool *)io->io_hdr.pool;
3818 uma_zfree(pool->zone, io);
3820 uma_zfree((uma_zone_t)io->io_hdr.pool, io);
3825 ctl_zero_io(union ctl_io *io)
3833 * May need to preserve linked list pointers at some point too.
3835 pool_ref = io->io_hdr.pool;
3836 memset(io, 0, sizeof(*io));
3837 io->io_hdr.pool = pool_ref;
3841 ctl_expand_number(const char *buf, uint64_t *num)
3847 number = strtoq(buf, &endptr, 0);
3849 switch (tolower((unsigned char)*endptr)) {
3869 case '\0': /* No unit. */
3873 /* Unrecognized unit. */
3877 if ((number << shift) >> shift != number) {
3881 *num = number << shift;
3887 * This routine could be used in the future to load default and/or saved
3888 * mode page parameters for a particuar lun.
3891 ctl_init_page_index(struct ctl_lun *lun)
3894 struct ctl_page_index *page_index;
3898 memcpy(&lun->mode_pages.index, page_index_template,
3899 sizeof(page_index_template));
3901 for (i = 0; i < CTL_NUM_MODE_PAGES; i++) {
3903 page_index = &lun->mode_pages.index[i];
3904 if (lun->be_lun->lun_type == T_DIRECT &&
3905 (page_index->page_flags & CTL_PAGE_FLAG_DIRECT) == 0)
3907 if (lun->be_lun->lun_type == T_PROCESSOR &&
3908 (page_index->page_flags & CTL_PAGE_FLAG_PROC) == 0)
3910 if (lun->be_lun->lun_type == T_CDROM &&
3911 (page_index->page_flags & CTL_PAGE_FLAG_CDROM) == 0)
3914 page_code = page_index->page_code & SMPH_PC_MASK;
3915 switch (page_code) {
3916 case SMS_RW_ERROR_RECOVERY_PAGE: {
3917 KASSERT(page_index->subpage == SMS_SUBPAGE_PAGE_0,
3918 ("subpage %#x for page %#x is incorrect!",
3919 page_index->subpage, page_code));
3920 memcpy(&lun->mode_pages.rw_er_page[CTL_PAGE_CURRENT],
3921 &rw_er_page_default,
3922 sizeof(rw_er_page_default));
3923 memcpy(&lun->mode_pages.rw_er_page[CTL_PAGE_CHANGEABLE],
3924 &rw_er_page_changeable,
3925 sizeof(rw_er_page_changeable));
3926 memcpy(&lun->mode_pages.rw_er_page[CTL_PAGE_DEFAULT],
3927 &rw_er_page_default,
3928 sizeof(rw_er_page_default));
3929 memcpy(&lun->mode_pages.rw_er_page[CTL_PAGE_SAVED],
3930 &rw_er_page_default,
3931 sizeof(rw_er_page_default));
3932 page_index->page_data =
3933 (uint8_t *)lun->mode_pages.rw_er_page;
3936 case SMS_FORMAT_DEVICE_PAGE: {
3937 struct scsi_format_page *format_page;
3939 KASSERT(page_index->subpage == SMS_SUBPAGE_PAGE_0,
3940 ("subpage %#x for page %#x is incorrect!",
3941 page_index->subpage, page_code));
3944 * Sectors per track are set above. Bytes per
3945 * sector need to be set here on a per-LUN basis.
3947 memcpy(&lun->mode_pages.format_page[CTL_PAGE_CURRENT],
3948 &format_page_default,
3949 sizeof(format_page_default));
3950 memcpy(&lun->mode_pages.format_page[
3951 CTL_PAGE_CHANGEABLE], &format_page_changeable,
3952 sizeof(format_page_changeable));
3953 memcpy(&lun->mode_pages.format_page[CTL_PAGE_DEFAULT],
3954 &format_page_default,
3955 sizeof(format_page_default));
3956 memcpy(&lun->mode_pages.format_page[CTL_PAGE_SAVED],
3957 &format_page_default,
3958 sizeof(format_page_default));
3960 format_page = &lun->mode_pages.format_page[
3962 scsi_ulto2b(lun->be_lun->blocksize,
3963 format_page->bytes_per_sector);
3965 format_page = &lun->mode_pages.format_page[
3967 scsi_ulto2b(lun->be_lun->blocksize,
3968 format_page->bytes_per_sector);
3970 format_page = &lun->mode_pages.format_page[
3972 scsi_ulto2b(lun->be_lun->blocksize,
3973 format_page->bytes_per_sector);
3975 page_index->page_data =
3976 (uint8_t *)lun->mode_pages.format_page;
3979 case SMS_RIGID_DISK_PAGE: {
3980 struct scsi_rigid_disk_page *rigid_disk_page;
3981 uint32_t sectors_per_cylinder;
3985 #endif /* !__XSCALE__ */
3987 KASSERT(page_index->subpage == SMS_SUBPAGE_PAGE_0,
3988 ("subpage %#x for page %#x is incorrect!",
3989 page_index->subpage, page_code));
3992 * Rotation rate and sectors per track are set
3993 * above. We calculate the cylinders here based on
3994 * capacity. Due to the number of heads and
3995 * sectors per track we're using, smaller arrays
3996 * may turn out to have 0 cylinders. Linux and
3997 * FreeBSD don't pay attention to these mode pages
3998 * to figure out capacity, but Solaris does. It
3999 * seems to deal with 0 cylinders just fine, and
4000 * works out a fake geometry based on the capacity.
4002 memcpy(&lun->mode_pages.rigid_disk_page[
4003 CTL_PAGE_DEFAULT], &rigid_disk_page_default,
4004 sizeof(rigid_disk_page_default));
4005 memcpy(&lun->mode_pages.rigid_disk_page[
4006 CTL_PAGE_CHANGEABLE],&rigid_disk_page_changeable,
4007 sizeof(rigid_disk_page_changeable));
4009 sectors_per_cylinder = CTL_DEFAULT_SECTORS_PER_TRACK *
4013 * The divide method here will be more accurate,
4014 * probably, but results in floating point being
4015 * used in the kernel on i386 (__udivdi3()). On the
4016 * XScale, though, __udivdi3() is implemented in
4019 * The shift method for cylinder calculation is
4020 * accurate if sectors_per_cylinder is a power of
4021 * 2. Otherwise it might be slightly off -- you
4022 * might have a bit of a truncation problem.
4025 cylinders = (lun->be_lun->maxlba + 1) /
4026 sectors_per_cylinder;
4028 for (shift = 31; shift > 0; shift--) {
4029 if (sectors_per_cylinder & (1 << shift))
4032 cylinders = (lun->be_lun->maxlba + 1) >> shift;
4036 * We've basically got 3 bytes, or 24 bits for the
4037 * cylinder size in the mode page. If we're over,
4038 * just round down to 2^24.
4040 if (cylinders > 0xffffff)
4041 cylinders = 0xffffff;
4043 rigid_disk_page = &lun->mode_pages.rigid_disk_page[
4045 scsi_ulto3b(cylinders, rigid_disk_page->cylinders);
4047 if ((value = ctl_get_opt(&lun->be_lun->options,
4049 scsi_ulto2b(strtol(value, NULL, 0),
4050 rigid_disk_page->rotation_rate);
4053 memcpy(&lun->mode_pages.rigid_disk_page[CTL_PAGE_CURRENT],
4054 &lun->mode_pages.rigid_disk_page[CTL_PAGE_DEFAULT],
4055 sizeof(rigid_disk_page_default));
4056 memcpy(&lun->mode_pages.rigid_disk_page[CTL_PAGE_SAVED],
4057 &lun->mode_pages.rigid_disk_page[CTL_PAGE_DEFAULT],
4058 sizeof(rigid_disk_page_default));
4060 page_index->page_data =
4061 (uint8_t *)lun->mode_pages.rigid_disk_page;
4064 case SMS_VERIFY_ERROR_RECOVERY_PAGE: {
4065 KASSERT(page_index->subpage == SMS_SUBPAGE_PAGE_0,
4066 ("subpage %#x for page %#x is incorrect!",
4067 page_index->subpage, page_code));
4068 memcpy(&lun->mode_pages.verify_er_page[CTL_PAGE_CURRENT],
4069 &verify_er_page_default,
4070 sizeof(verify_er_page_default));
4071 memcpy(&lun->mode_pages.verify_er_page[CTL_PAGE_CHANGEABLE],
4072 &verify_er_page_changeable,
4073 sizeof(verify_er_page_changeable));
4074 memcpy(&lun->mode_pages.verify_er_page[CTL_PAGE_DEFAULT],
4075 &verify_er_page_default,
4076 sizeof(verify_er_page_default));
4077 memcpy(&lun->mode_pages.verify_er_page[CTL_PAGE_SAVED],
4078 &verify_er_page_default,
4079 sizeof(verify_er_page_default));
4080 page_index->page_data =
4081 (uint8_t *)lun->mode_pages.verify_er_page;
4084 case SMS_CACHING_PAGE: {
4085 struct scsi_caching_page *caching_page;
4087 KASSERT(page_index->subpage == SMS_SUBPAGE_PAGE_0,
4088 ("subpage %#x for page %#x is incorrect!",
4089 page_index->subpage, page_code));
4090 memcpy(&lun->mode_pages.caching_page[CTL_PAGE_DEFAULT],
4091 &caching_page_default,
4092 sizeof(caching_page_default));
4093 memcpy(&lun->mode_pages.caching_page[
4094 CTL_PAGE_CHANGEABLE], &caching_page_changeable,
4095 sizeof(caching_page_changeable));
4096 memcpy(&lun->mode_pages.caching_page[CTL_PAGE_SAVED],
4097 &caching_page_default,
4098 sizeof(caching_page_default));
4099 caching_page = &lun->mode_pages.caching_page[
4101 value = ctl_get_opt(&lun->be_lun->options, "writecache");
4102 if (value != NULL && strcmp(value, "off") == 0)
4103 caching_page->flags1 &= ~SCP_WCE;
4104 value = ctl_get_opt(&lun->be_lun->options, "readcache");
4105 if (value != NULL && strcmp(value, "off") == 0)
4106 caching_page->flags1 |= SCP_RCD;
4107 memcpy(&lun->mode_pages.caching_page[CTL_PAGE_CURRENT],
4108 &lun->mode_pages.caching_page[CTL_PAGE_SAVED],
4109 sizeof(caching_page_default));
4110 page_index->page_data =
4111 (uint8_t *)lun->mode_pages.caching_page;
4114 case SMS_CONTROL_MODE_PAGE: {
4115 switch (page_index->subpage) {
4116 case SMS_SUBPAGE_PAGE_0: {
4117 struct scsi_control_page *control_page;
4119 memcpy(&lun->mode_pages.control_page[
4121 &control_page_default,
4122 sizeof(control_page_default));
4123 memcpy(&lun->mode_pages.control_page[
4124 CTL_PAGE_CHANGEABLE],
4125 &control_page_changeable,
4126 sizeof(control_page_changeable));
4127 memcpy(&lun->mode_pages.control_page[
4129 &control_page_default,
4130 sizeof(control_page_default));
4131 control_page = &lun->mode_pages.control_page[
4133 value = ctl_get_opt(&lun->be_lun->options,
4135 if (value != NULL &&
4136 strcmp(value, "unrestricted") == 0) {
4137 control_page->queue_flags &=
4138 ~SCP_QUEUE_ALG_MASK;
4139 control_page->queue_flags |=
4140 SCP_QUEUE_ALG_UNRESTRICTED;
4142 memcpy(&lun->mode_pages.control_page[
4144 &lun->mode_pages.control_page[
4146 sizeof(control_page_default));
4147 page_index->page_data =
4148 (uint8_t *)lun->mode_pages.control_page;
4152 memcpy(&lun->mode_pages.control_ext_page[
4154 &control_ext_page_default,
4155 sizeof(control_ext_page_default));
4156 memcpy(&lun->mode_pages.control_ext_page[
4157 CTL_PAGE_CHANGEABLE],
4158 &control_ext_page_changeable,
4159 sizeof(control_ext_page_changeable));
4160 memcpy(&lun->mode_pages.control_ext_page[
4162 &control_ext_page_default,
4163 sizeof(control_ext_page_default));
4164 memcpy(&lun->mode_pages.control_ext_page[
4166 &lun->mode_pages.control_ext_page[
4168 sizeof(control_ext_page_default));
4169 page_index->page_data =
4170 (uint8_t *)lun->mode_pages.control_ext_page;
4173 panic("subpage %#x for page %#x is incorrect!",
4174 page_index->subpage, page_code);
4178 case SMS_INFO_EXCEPTIONS_PAGE: {
4179 switch (page_index->subpage) {
4180 case SMS_SUBPAGE_PAGE_0:
4181 memcpy(&lun->mode_pages.ie_page[CTL_PAGE_CURRENT],
4183 sizeof(ie_page_default));
4184 memcpy(&lun->mode_pages.ie_page[
4185 CTL_PAGE_CHANGEABLE], &ie_page_changeable,
4186 sizeof(ie_page_changeable));
4187 memcpy(&lun->mode_pages.ie_page[CTL_PAGE_DEFAULT],
4189 sizeof(ie_page_default));
4190 memcpy(&lun->mode_pages.ie_page[CTL_PAGE_SAVED],
4192 sizeof(ie_page_default));
4193 page_index->page_data =
4194 (uint8_t *)lun->mode_pages.ie_page;
4197 struct ctl_logical_block_provisioning_page *page;
4199 memcpy(&lun->mode_pages.lbp_page[CTL_PAGE_DEFAULT],
4201 sizeof(lbp_page_default));
4202 memcpy(&lun->mode_pages.lbp_page[
4203 CTL_PAGE_CHANGEABLE], &lbp_page_changeable,
4204 sizeof(lbp_page_changeable));
4205 memcpy(&lun->mode_pages.lbp_page[CTL_PAGE_SAVED],
4207 sizeof(lbp_page_default));
4208 page = &lun->mode_pages.lbp_page[CTL_PAGE_SAVED];
4209 value = ctl_get_opt(&lun->be_lun->options,
4211 if (value != NULL &&
4212 ctl_expand_number(value, &ival) == 0) {
4213 page->descr[0].flags |= SLBPPD_ENABLED |
4215 if (lun->be_lun->blocksize)
4216 ival /= lun->be_lun->blocksize;
4219 scsi_ulto4b(ival >> CTL_LBP_EXPONENT,
4220 page->descr[0].count);
4222 value = ctl_get_opt(&lun->be_lun->options,
4224 if (value != NULL &&
4225 ctl_expand_number(value, &ival) == 0) {
4226 page->descr[1].flags |= SLBPPD_ENABLED |
4228 if (lun->be_lun->blocksize)
4229 ival /= lun->be_lun->blocksize;
4232 scsi_ulto4b(ival >> CTL_LBP_EXPONENT,
4233 page->descr[1].count);
4235 value = ctl_get_opt(&lun->be_lun->options,
4236 "pool-avail-threshold");
4237 if (value != NULL &&
4238 ctl_expand_number(value, &ival) == 0) {
4239 page->descr[2].flags |= SLBPPD_ENABLED |
4241 if (lun->be_lun->blocksize)
4242 ival /= lun->be_lun->blocksize;
4245 scsi_ulto4b(ival >> CTL_LBP_EXPONENT,
4246 page->descr[2].count);
4248 value = ctl_get_opt(&lun->be_lun->options,
4249 "pool-used-threshold");
4250 if (value != NULL &&
4251 ctl_expand_number(value, &ival) == 0) {
4252 page->descr[3].flags |= SLBPPD_ENABLED |
4254 if (lun->be_lun->blocksize)
4255 ival /= lun->be_lun->blocksize;
4258 scsi_ulto4b(ival >> CTL_LBP_EXPONENT,
4259 page->descr[3].count);
4261 memcpy(&lun->mode_pages.lbp_page[CTL_PAGE_CURRENT],
4262 &lun->mode_pages.lbp_page[CTL_PAGE_SAVED],
4263 sizeof(lbp_page_default));
4264 page_index->page_data =
4265 (uint8_t *)lun->mode_pages.lbp_page;
4269 panic("subpage %#x for page %#x is incorrect!",
4270 page_index->subpage, page_code);
4274 case SMS_CDDVD_CAPS_PAGE:{
4275 KASSERT(page_index->subpage == SMS_SUBPAGE_PAGE_0,
4276 ("subpage %#x for page %#x is incorrect!",
4277 page_index->subpage, page_code));
4278 memcpy(&lun->mode_pages.cddvd_page[CTL_PAGE_DEFAULT],
4279 &cddvd_page_default,
4280 sizeof(cddvd_page_default));
4281 memcpy(&lun->mode_pages.cddvd_page[
4282 CTL_PAGE_CHANGEABLE], &cddvd_page_changeable,
4283 sizeof(cddvd_page_changeable));
4284 memcpy(&lun->mode_pages.cddvd_page[CTL_PAGE_SAVED],
4285 &cddvd_page_default,
4286 sizeof(cddvd_page_default));
4287 memcpy(&lun->mode_pages.cddvd_page[CTL_PAGE_CURRENT],
4288 &lun->mode_pages.cddvd_page[CTL_PAGE_SAVED],
4289 sizeof(cddvd_page_default));
4290 page_index->page_data =
4291 (uint8_t *)lun->mode_pages.cddvd_page;
4295 panic("invalid page code value %#x", page_code);
4299 return (CTL_RETVAL_COMPLETE);
4303 ctl_init_log_page_index(struct ctl_lun *lun)
4305 struct ctl_page_index *page_index;
4308 memcpy(&lun->log_pages.index, log_page_index_template,
4309 sizeof(log_page_index_template));
4312 for (i = 0, j = 0, k = 0; i < CTL_NUM_LOG_PAGES; i++) {
4314 page_index = &lun->log_pages.index[i];
4315 if (lun->be_lun->lun_type == T_DIRECT &&
4316 (page_index->page_flags & CTL_PAGE_FLAG_DIRECT) == 0)
4318 if (lun->be_lun->lun_type == T_PROCESSOR &&
4319 (page_index->page_flags & CTL_PAGE_FLAG_PROC) == 0)
4321 if (lun->be_lun->lun_type == T_CDROM &&
4322 (page_index->page_flags & CTL_PAGE_FLAG_CDROM) == 0)
4325 if (page_index->page_code == SLS_LOGICAL_BLOCK_PROVISIONING &&
4326 lun->backend->lun_attr == NULL)
4329 if (page_index->page_code != prev) {
4330 lun->log_pages.pages_page[j] = page_index->page_code;
4331 prev = page_index->page_code;
4334 lun->log_pages.subpages_page[k*2] = page_index->page_code;
4335 lun->log_pages.subpages_page[k*2+1] = page_index->subpage;
4338 lun->log_pages.index[0].page_data = &lun->log_pages.pages_page[0];
4339 lun->log_pages.index[0].page_len = j;
4340 lun->log_pages.index[1].page_data = &lun->log_pages.subpages_page[0];
4341 lun->log_pages.index[1].page_len = k * 2;
4342 lun->log_pages.index[2].page_data = &lun->log_pages.lbp_page[0];
4343 lun->log_pages.index[2].page_len = 12*CTL_NUM_LBP_PARAMS;
4344 lun->log_pages.index[3].page_data = (uint8_t *)&lun->log_pages.stat_page;
4345 lun->log_pages.index[3].page_len = sizeof(lun->log_pages.stat_page);
4346 lun->log_pages.index[4].page_data = (uint8_t *)&lun->log_pages.ie_page;
4347 lun->log_pages.index[4].page_len = sizeof(lun->log_pages.ie_page);
4349 return (CTL_RETVAL_COMPLETE);
4353 hex2bin(const char *str, uint8_t *buf, int buf_size)
4358 memset(buf, 0, buf_size);
4359 while (isspace(str[0]))
4361 if (str[0] == '0' && (str[1] == 'x' || str[1] == 'X'))
4364 for (i = 0; str[i] != 0 && i < buf_size; i++) {
4365 while (str[i] == '-') /* Skip dashes in UUIDs. */
4370 else if (isalpha(c))
4371 c -= isupper(c) ? 'A' - 10 : 'a' - 10;
4377 buf[i / 2] |= (c << 4);
4381 return ((i + 1) / 2);
4388 * - caller allocates and zeros LUN storage, or passes in a NULL LUN if he
4389 * wants us to allocate the LUN and he can block.
4390 * - ctl_softc is always set
4391 * - be_lun is set if the LUN has a backend (needed for disk LUNs)
4393 * Returns 0 for success, non-zero (errno) for failure.
4396 ctl_alloc_lun(struct ctl_softc *ctl_softc, struct ctl_lun *ctl_lun,
4397 struct ctl_be_lun *const be_lun)
4399 struct ctl_lun *nlun, *lun;
4400 struct scsi_vpd_id_descriptor *desc;
4401 struct scsi_vpd_id_t10 *t10id;
4402 const char *eui, *naa, *scsiname, *uuid, *vendor, *value;
4403 int lun_number, i, lun_malloced;
4404 int devidlen, idlen1, idlen2 = 0, len;
4410 * We currently only support Direct Access or Processor LUN types.
4412 switch (be_lun->lun_type) {
4420 be_lun->lun_config_status(be_lun->be_lun,
4421 CTL_LUN_CONFIG_FAILURE);
4424 if (ctl_lun == NULL) {
4425 lun = malloc(sizeof(*lun), M_CTL, M_WAITOK);
4432 memset(lun, 0, sizeof(*lun));
4434 lun->flags = CTL_LUN_MALLOCED;
4436 /* Generate LUN ID. */
4437 devidlen = max(CTL_DEVID_MIN_LEN,
4438 strnlen(be_lun->device_id, CTL_DEVID_LEN));
4439 idlen1 = sizeof(*t10id) + devidlen;
4440 len = sizeof(struct scsi_vpd_id_descriptor) + idlen1;
4441 scsiname = ctl_get_opt(&be_lun->options, "scsiname");
4442 if (scsiname != NULL) {
4443 idlen2 = roundup2(strlen(scsiname) + 1, 4);
4444 len += sizeof(struct scsi_vpd_id_descriptor) + idlen2;
4446 eui = ctl_get_opt(&be_lun->options, "eui");
4448 len += sizeof(struct scsi_vpd_id_descriptor) + 16;
4450 naa = ctl_get_opt(&be_lun->options, "naa");
4452 len += sizeof(struct scsi_vpd_id_descriptor) + 16;
4454 uuid = ctl_get_opt(&be_lun->options, "uuid");
4456 len += sizeof(struct scsi_vpd_id_descriptor) + 18;
4458 lun->lun_devid = malloc(sizeof(struct ctl_devid) + len,
4459 M_CTL, M_WAITOK | M_ZERO);
4460 desc = (struct scsi_vpd_id_descriptor *)lun->lun_devid->data;
4461 desc->proto_codeset = SVPD_ID_CODESET_ASCII;
4462 desc->id_type = SVPD_ID_PIV | SVPD_ID_ASSOC_LUN | SVPD_ID_TYPE_T10;
4463 desc->length = idlen1;
4464 t10id = (struct scsi_vpd_id_t10 *)&desc->identifier[0];
4465 memset(t10id->vendor, ' ', sizeof(t10id->vendor));
4466 if ((vendor = ctl_get_opt(&be_lun->options, "vendor")) == NULL) {
4467 strncpy((char *)t10id->vendor, CTL_VENDOR, sizeof(t10id->vendor));
4469 strncpy(t10id->vendor, vendor,
4470 min(sizeof(t10id->vendor), strlen(vendor)));
4472 strncpy((char *)t10id->vendor_spec_id,
4473 (char *)be_lun->device_id, devidlen);
4474 if (scsiname != NULL) {
4475 desc = (struct scsi_vpd_id_descriptor *)(&desc->identifier[0] +
4477 desc->proto_codeset = SVPD_ID_CODESET_UTF8;
4478 desc->id_type = SVPD_ID_PIV | SVPD_ID_ASSOC_LUN |
4479 SVPD_ID_TYPE_SCSI_NAME;
4480 desc->length = idlen2;
4481 strlcpy(desc->identifier, scsiname, idlen2);
4484 desc = (struct scsi_vpd_id_descriptor *)(&desc->identifier[0] +
4486 desc->proto_codeset = SVPD_ID_CODESET_BINARY;
4487 desc->id_type = SVPD_ID_PIV | SVPD_ID_ASSOC_LUN |
4489 desc->length = hex2bin(eui, desc->identifier, 16);
4490 desc->length = desc->length > 12 ? 16 :
4491 (desc->length > 8 ? 12 : 8);
4492 len -= 16 - desc->length;
4495 desc = (struct scsi_vpd_id_descriptor *)(&desc->identifier[0] +
4497 desc->proto_codeset = SVPD_ID_CODESET_BINARY;
4498 desc->id_type = SVPD_ID_PIV | SVPD_ID_ASSOC_LUN |
4500 desc->length = hex2bin(naa, desc->identifier, 16);
4501 desc->length = desc->length > 8 ? 16 : 8;
4502 len -= 16 - desc->length;
4505 desc = (struct scsi_vpd_id_descriptor *)(&desc->identifier[0] +
4507 desc->proto_codeset = SVPD_ID_CODESET_BINARY;
4508 desc->id_type = SVPD_ID_PIV | SVPD_ID_ASSOC_LUN |
4510 desc->identifier[0] = 0x10;
4511 hex2bin(uuid, &desc->identifier[2], 16);
4514 lun->lun_devid->len = len;
4516 mtx_lock(&ctl_softc->ctl_lock);
4518 * See if the caller requested a particular LUN number. If so, see
4519 * if it is available. Otherwise, allocate the first available LUN.
4521 if (be_lun->flags & CTL_LUN_FLAG_ID_REQ) {
4522 if ((be_lun->req_lun_id > (CTL_MAX_LUNS - 1))
4523 || (ctl_is_set(ctl_softc->ctl_lun_mask, be_lun->req_lun_id))) {
4524 mtx_unlock(&ctl_softc->ctl_lock);
4525 if (be_lun->req_lun_id > (CTL_MAX_LUNS - 1)) {
4526 printf("ctl: requested LUN ID %d is higher "
4527 "than CTL_MAX_LUNS - 1 (%d)\n",
4528 be_lun->req_lun_id, CTL_MAX_LUNS - 1);
4531 * XXX KDM return an error, or just assign
4532 * another LUN ID in this case??
4534 printf("ctl: requested LUN ID %d is already "
4535 "in use\n", be_lun->req_lun_id);
4537 if (lun->flags & CTL_LUN_MALLOCED)
4539 be_lun->lun_config_status(be_lun->be_lun,
4540 CTL_LUN_CONFIG_FAILURE);
4543 lun_number = be_lun->req_lun_id;
4545 lun_number = ctl_ffz(ctl_softc->ctl_lun_mask, 0, CTL_MAX_LUNS);
4546 if (lun_number == -1) {
4547 mtx_unlock(&ctl_softc->ctl_lock);
4548 printf("ctl: can't allocate LUN, out of LUNs\n");
4549 if (lun->flags & CTL_LUN_MALLOCED)
4551 be_lun->lun_config_status(be_lun->be_lun,
4552 CTL_LUN_CONFIG_FAILURE);
4556 ctl_set_mask(ctl_softc->ctl_lun_mask, lun_number);
4558 mtx_init(&lun->lun_lock, "CTL LUN", NULL, MTX_DEF);
4559 lun->lun = lun_number;
4560 lun->be_lun = be_lun;
4562 * The processor LUN is always enabled. Disk LUNs come on line
4563 * disabled, and must be enabled by the backend.
4565 lun->flags |= CTL_LUN_DISABLED;
4566 lun->backend = be_lun->be;
4567 be_lun->ctl_lun = lun;
4568 be_lun->lun_id = lun_number;
4569 atomic_add_int(&be_lun->be->num_luns, 1);
4570 if (be_lun->flags & CTL_LUN_FLAG_EJECTED)
4571 lun->flags |= CTL_LUN_EJECTED;
4572 if (be_lun->flags & CTL_LUN_FLAG_NO_MEDIA)
4573 lun->flags |= CTL_LUN_NO_MEDIA;
4574 if (be_lun->flags & CTL_LUN_FLAG_STOPPED)
4575 lun->flags |= CTL_LUN_STOPPED;
4577 if (be_lun->flags & CTL_LUN_FLAG_PRIMARY)
4578 lun->flags |= CTL_LUN_PRIMARY_SC;
4580 value = ctl_get_opt(&be_lun->options, "removable");
4581 if (value != NULL) {
4582 if (strcmp(value, "on") == 0)
4583 lun->flags |= CTL_LUN_REMOVABLE;
4584 } else if (be_lun->lun_type == T_CDROM)
4585 lun->flags |= CTL_LUN_REMOVABLE;
4587 lun->ctl_softc = ctl_softc;
4589 lun->last_busy = getsbinuptime();
4591 TAILQ_INIT(&lun->ooa_queue);
4592 TAILQ_INIT(&lun->blocked_queue);
4593 STAILQ_INIT(&lun->error_list);
4594 lun->ie_reported = 1;
4595 callout_init_mtx(&lun->ie_callout, &lun->lun_lock, 0);
4596 ctl_tpc_lun_init(lun);
4599 * Initialize the mode and log page index.
4601 ctl_init_page_index(lun);
4602 ctl_init_log_page_index(lun);
4605 * Now, before we insert this lun on the lun list, set the lun
4606 * inventory changed UA for all other luns.
4608 STAILQ_FOREACH(nlun, &ctl_softc->lun_list, links) {
4609 mtx_lock(&nlun->lun_lock);
4610 ctl_est_ua_all(nlun, -1, CTL_UA_LUN_CHANGE);
4611 mtx_unlock(&nlun->lun_lock);
4614 STAILQ_INSERT_TAIL(&ctl_softc->lun_list, lun, links);
4616 ctl_softc->ctl_luns[lun_number] = lun;
4618 ctl_softc->num_luns++;
4620 /* Setup statistics gathering */
4621 lun->stats.device_type = be_lun->lun_type;
4622 lun->stats.lun_number = lun_number;
4623 lun->stats.blocksize = be_lun->blocksize;
4624 if (be_lun->blocksize == 0)
4625 lun->stats.flags = CTL_LUN_STATS_NO_BLOCKSIZE;
4626 for (i = 0;i < CTL_MAX_PORTS;i++)
4627 lun->stats.ports[i].targ_port = i;
4629 mtx_unlock(&ctl_softc->ctl_lock);
4631 lun->be_lun->lun_config_status(lun->be_lun->be_lun, CTL_LUN_CONFIG_OK);
4638 * - LUN has already been marked invalid and any pending I/O has been taken
4642 ctl_free_lun(struct ctl_lun *lun)
4644 struct ctl_softc *softc;
4645 struct ctl_lun *nlun;
4648 softc = lun->ctl_softc;
4650 mtx_assert(&softc->ctl_lock, MA_OWNED);
4652 STAILQ_REMOVE(&softc->lun_list, lun, ctl_lun, links);
4654 ctl_clear_mask(softc->ctl_lun_mask, lun->lun);
4656 softc->ctl_luns[lun->lun] = NULL;
4658 if (!TAILQ_EMPTY(&lun->ooa_queue))
4659 panic("Freeing a LUN %p with outstanding I/O!!\n", lun);
4664 * Tell the backend to free resources, if this LUN has a backend.
4666 atomic_subtract_int(&lun->be_lun->be->num_luns, 1);
4667 lun->be_lun->lun_shutdown(lun->be_lun->be_lun);
4669 lun->ie_reportcnt = UINT32_MAX;
4670 callout_drain(&lun->ie_callout);
4672 ctl_tpc_lun_shutdown(lun);
4673 mtx_destroy(&lun->lun_lock);
4674 free(lun->lun_devid, M_CTL);
4675 for (i = 0; i < CTL_MAX_PORTS; i++)
4676 free(lun->pending_ua[i], M_CTL);
4677 for (i = 0; i < CTL_MAX_PORTS; i++)
4678 free(lun->pr_keys[i], M_CTL);
4679 free(lun->write_buffer, M_CTL);
4680 if (lun->flags & CTL_LUN_MALLOCED)
4683 STAILQ_FOREACH(nlun, &softc->lun_list, links) {
4684 mtx_lock(&nlun->lun_lock);
4685 ctl_est_ua_all(nlun, -1, CTL_UA_LUN_CHANGE);
4686 mtx_unlock(&nlun->lun_lock);
4693 ctl_create_lun(struct ctl_be_lun *be_lun)
4697 * ctl_alloc_lun() should handle all potential failure cases.
4699 ctl_alloc_lun(control_softc, NULL, be_lun);
4703 ctl_add_lun(struct ctl_be_lun *be_lun)
4705 struct ctl_softc *softc = control_softc;
4707 mtx_lock(&softc->ctl_lock);
4708 STAILQ_INSERT_TAIL(&softc->pending_lun_queue, be_lun, links);
4709 mtx_unlock(&softc->ctl_lock);
4710 wakeup(&softc->pending_lun_queue);
4716 ctl_enable_lun(struct ctl_be_lun *be_lun)
4718 struct ctl_softc *softc;
4719 struct ctl_port *port, *nport;
4720 struct ctl_lun *lun;
4723 lun = (struct ctl_lun *)be_lun->ctl_lun;
4724 softc = lun->ctl_softc;
4726 mtx_lock(&softc->ctl_lock);
4727 mtx_lock(&lun->lun_lock);
4728 if ((lun->flags & CTL_LUN_DISABLED) == 0) {
4730 * eh? Why did we get called if the LUN is already
4733 mtx_unlock(&lun->lun_lock);
4734 mtx_unlock(&softc->ctl_lock);
4737 lun->flags &= ~CTL_LUN_DISABLED;
4738 mtx_unlock(&lun->lun_lock);
4740 STAILQ_FOREACH_SAFE(port, &softc->port_list, links, nport) {
4741 if ((port->status & CTL_PORT_STATUS_ONLINE) == 0 ||
4742 port->lun_map != NULL || port->lun_enable == NULL)
4746 * Drop the lock while we call the FETD's enable routine.
4747 * This can lead to a callback into CTL (at least in the
4748 * case of the internal initiator frontend.
4750 mtx_unlock(&softc->ctl_lock);
4751 retval = port->lun_enable(port->targ_lun_arg, lun->lun);
4752 mtx_lock(&softc->ctl_lock);
4754 printf("%s: FETD %s port %d returned error "
4755 "%d for lun_enable on lun %jd\n",
4756 __func__, port->port_name, port->targ_port,
4757 retval, (intmax_t)lun->lun);
4761 mtx_unlock(&softc->ctl_lock);
4762 ctl_isc_announce_lun(lun);
4768 ctl_disable_lun(struct ctl_be_lun *be_lun)
4770 struct ctl_softc *softc;
4771 struct ctl_port *port;
4772 struct ctl_lun *lun;
4775 lun = (struct ctl_lun *)be_lun->ctl_lun;
4776 softc = lun->ctl_softc;
4778 mtx_lock(&softc->ctl_lock);
4779 mtx_lock(&lun->lun_lock);
4780 if (lun->flags & CTL_LUN_DISABLED) {
4781 mtx_unlock(&lun->lun_lock);
4782 mtx_unlock(&softc->ctl_lock);
4785 lun->flags |= CTL_LUN_DISABLED;
4786 mtx_unlock(&lun->lun_lock);
4788 STAILQ_FOREACH(port, &softc->port_list, links) {
4789 if ((port->status & CTL_PORT_STATUS_ONLINE) == 0 ||
4790 port->lun_map != NULL || port->lun_disable == NULL)
4794 * Drop the lock before we call the frontend's disable
4795 * routine, to avoid lock order reversals.
4797 * XXX KDM what happens if the frontend list changes while
4798 * we're traversing it? It's unlikely, but should be handled.
4800 mtx_unlock(&softc->ctl_lock);
4801 retval = port->lun_disable(port->targ_lun_arg, lun->lun);
4802 mtx_lock(&softc->ctl_lock);
4804 printf("%s: FETD %s port %d returned error "
4805 "%d for lun_disable on lun %jd\n",
4806 __func__, port->port_name, port->targ_port,
4807 retval, (intmax_t)lun->lun);
4811 mtx_unlock(&softc->ctl_lock);
4812 ctl_isc_announce_lun(lun);
4818 ctl_start_lun(struct ctl_be_lun *be_lun)
4820 struct ctl_lun *lun = (struct ctl_lun *)be_lun->ctl_lun;
4822 mtx_lock(&lun->lun_lock);
4823 lun->flags &= ~CTL_LUN_STOPPED;
4824 mtx_unlock(&lun->lun_lock);
4829 ctl_stop_lun(struct ctl_be_lun *be_lun)
4831 struct ctl_lun *lun = (struct ctl_lun *)be_lun->ctl_lun;
4833 mtx_lock(&lun->lun_lock);
4834 lun->flags |= CTL_LUN_STOPPED;
4835 mtx_unlock(&lun->lun_lock);
4840 ctl_lun_no_media(struct ctl_be_lun *be_lun)
4842 struct ctl_lun *lun = (struct ctl_lun *)be_lun->ctl_lun;
4844 mtx_lock(&lun->lun_lock);
4845 lun->flags |= CTL_LUN_NO_MEDIA;
4846 mtx_unlock(&lun->lun_lock);
4851 ctl_lun_has_media(struct ctl_be_lun *be_lun)
4853 struct ctl_lun *lun = (struct ctl_lun *)be_lun->ctl_lun;
4854 union ctl_ha_msg msg;
4856 mtx_lock(&lun->lun_lock);
4857 lun->flags &= ~(CTL_LUN_NO_MEDIA | CTL_LUN_EJECTED);
4858 if (lun->flags & CTL_LUN_REMOVABLE)
4859 ctl_est_ua_all(lun, -1, CTL_UA_MEDIUM_CHANGE);
4860 mtx_unlock(&lun->lun_lock);
4861 if ((lun->flags & CTL_LUN_REMOVABLE) &&
4862 lun->ctl_softc->ha_mode == CTL_HA_MODE_XFER) {
4863 bzero(&msg.ua, sizeof(msg.ua));
4864 msg.hdr.msg_type = CTL_MSG_UA;
4865 msg.hdr.nexus.initid = -1;
4866 msg.hdr.nexus.targ_port = -1;
4867 msg.hdr.nexus.targ_lun = lun->lun;
4868 msg.hdr.nexus.targ_mapped_lun = lun->lun;
4871 msg.ua.ua_type = CTL_UA_MEDIUM_CHANGE;
4872 ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg, sizeof(msg.ua),
4879 ctl_lun_ejected(struct ctl_be_lun *be_lun)
4881 struct ctl_lun *lun = (struct ctl_lun *)be_lun->ctl_lun;
4883 mtx_lock(&lun->lun_lock);
4884 lun->flags |= CTL_LUN_EJECTED;
4885 mtx_unlock(&lun->lun_lock);
4890 ctl_lun_primary(struct ctl_be_lun *be_lun)
4892 struct ctl_lun *lun = (struct ctl_lun *)be_lun->ctl_lun;
4894 mtx_lock(&lun->lun_lock);
4895 lun->flags |= CTL_LUN_PRIMARY_SC;
4896 ctl_est_ua_all(lun, -1, CTL_UA_ASYM_ACC_CHANGE);
4897 mtx_unlock(&lun->lun_lock);
4898 ctl_isc_announce_lun(lun);
4903 ctl_lun_secondary(struct ctl_be_lun *be_lun)
4905 struct ctl_lun *lun = (struct ctl_lun *)be_lun->ctl_lun;
4907 mtx_lock(&lun->lun_lock);
4908 lun->flags &= ~CTL_LUN_PRIMARY_SC;
4909 ctl_est_ua_all(lun, -1, CTL_UA_ASYM_ACC_CHANGE);
4910 mtx_unlock(&lun->lun_lock);
4911 ctl_isc_announce_lun(lun);
4916 ctl_invalidate_lun(struct ctl_be_lun *be_lun)
4918 struct ctl_softc *softc;
4919 struct ctl_lun *lun;
4921 lun = (struct ctl_lun *)be_lun->ctl_lun;
4922 softc = lun->ctl_softc;
4924 mtx_lock(&lun->lun_lock);
4927 * The LUN needs to be disabled before it can be marked invalid.
4929 if ((lun->flags & CTL_LUN_DISABLED) == 0) {
4930 mtx_unlock(&lun->lun_lock);
4934 * Mark the LUN invalid.
4936 lun->flags |= CTL_LUN_INVALID;
4939 * If there is nothing in the OOA queue, go ahead and free the LUN.
4940 * If we have something in the OOA queue, we'll free it when the
4941 * last I/O completes.
4943 if (TAILQ_EMPTY(&lun->ooa_queue)) {
4944 mtx_unlock(&lun->lun_lock);
4945 mtx_lock(&softc->ctl_lock);
4947 mtx_unlock(&softc->ctl_lock);
4949 mtx_unlock(&lun->lun_lock);
4955 ctl_lun_capacity_changed(struct ctl_be_lun *be_lun)
4957 struct ctl_lun *lun = (struct ctl_lun *)be_lun->ctl_lun;
4958 union ctl_ha_msg msg;
4960 mtx_lock(&lun->lun_lock);
4961 ctl_est_ua_all(lun, -1, CTL_UA_CAPACITY_CHANGE);
4962 mtx_unlock(&lun->lun_lock);
4963 if (lun->ctl_softc->ha_mode == CTL_HA_MODE_XFER) {
4964 /* Send msg to other side. */
4965 bzero(&msg.ua, sizeof(msg.ua));
4966 msg.hdr.msg_type = CTL_MSG_UA;
4967 msg.hdr.nexus.initid = -1;
4968 msg.hdr.nexus.targ_port = -1;
4969 msg.hdr.nexus.targ_lun = lun->lun;
4970 msg.hdr.nexus.targ_mapped_lun = lun->lun;
4973 msg.ua.ua_type = CTL_UA_CAPACITY_CHANGE;
4974 ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg, sizeof(msg.ua),
4980 * Backend "memory move is complete" callback for requests that never
4981 * make it down to say RAIDCore's configuration code.
4984 ctl_config_move_done(union ctl_io *io)
4988 CTL_DEBUG_PRINT(("ctl_config_move_done\n"));
4989 KASSERT(io->io_hdr.io_type == CTL_IO_SCSI,
4990 ("Config I/O type isn't CTL_IO_SCSI (%d)!", io->io_hdr.io_type));
4992 if ((io->io_hdr.port_status != 0) &&
4993 ((io->io_hdr.status & CTL_STATUS_MASK) == CTL_STATUS_NONE ||
4994 (io->io_hdr.status & CTL_STATUS_MASK) == CTL_SUCCESS)) {
4996 * For hardware error sense keys, the sense key
4997 * specific value is defined to be a retry count,
4998 * but we use it to pass back an internal FETD
4999 * error code. XXX KDM Hopefully the FETD is only
5000 * using 16 bits for an error code, since that's
5001 * all the space we have in the sks field.
5003 ctl_set_internal_failure(&io->scsiio,
5006 io->io_hdr.port_status);
5009 if (ctl_debug & CTL_DEBUG_CDB_DATA)
5011 if (((io->io_hdr.flags & CTL_FLAG_DATA_MASK) == CTL_FLAG_DATA_IN) ||
5012 ((io->io_hdr.status & CTL_STATUS_MASK) != CTL_STATUS_NONE &&
5013 (io->io_hdr.status & CTL_STATUS_MASK) != CTL_SUCCESS) ||
5014 ((io->io_hdr.flags & CTL_FLAG_ABORT) != 0)) {
5016 * XXX KDM just assuming a single pointer here, and not a
5017 * S/G list. If we start using S/G lists for config data,
5018 * we'll need to know how to clean them up here as well.
5020 if (io->io_hdr.flags & CTL_FLAG_ALLOCATED)
5021 free(io->scsiio.kern_data_ptr, M_CTL);
5023 retval = CTL_RETVAL_COMPLETE;
5026 * XXX KDM now we need to continue data movement. Some
5028 * - call ctl_scsiio() again? We don't do this for data
5029 * writes, because for those at least we know ahead of
5030 * time where the write will go and how long it is. For
5031 * config writes, though, that information is largely
5032 * contained within the write itself, thus we need to
5033 * parse out the data again.
5035 * - Call some other function once the data is in?
5039 * XXX KDM call ctl_scsiio() again for now, and check flag
5040 * bits to see whether we're allocated or not.
5042 retval = ctl_scsiio(&io->scsiio);
5048 * This gets called by a backend driver when it is done with a
5049 * data_submit method.
5052 ctl_data_submit_done(union ctl_io *io)
5055 * If the IO_CONT flag is set, we need to call the supplied
5056 * function to continue processing the I/O, instead of completing
5059 * If there is an error, though, we don't want to keep processing.
5060 * Instead, just send status back to the initiator.
5062 if ((io->io_hdr.flags & CTL_FLAG_IO_CONT) &&
5063 (io->io_hdr.flags & CTL_FLAG_ABORT) == 0 &&
5064 ((io->io_hdr.status & CTL_STATUS_MASK) == CTL_STATUS_NONE ||
5065 (io->io_hdr.status & CTL_STATUS_MASK) == CTL_SUCCESS)) {
5066 io->scsiio.io_cont(io);
5073 * This gets called by a backend driver when it is done with a
5074 * configuration write.
5077 ctl_config_write_done(union ctl_io *io)
5082 * If the IO_CONT flag is set, we need to call the supplied
5083 * function to continue processing the I/O, instead of completing
5086 * If there is an error, though, we don't want to keep processing.
5087 * Instead, just send status back to the initiator.
5089 if ((io->io_hdr.flags & CTL_FLAG_IO_CONT) &&
5090 (io->io_hdr.flags & CTL_FLAG_ABORT) == 0 &&
5091 ((io->io_hdr.status & CTL_STATUS_MASK) == CTL_STATUS_NONE ||
5092 (io->io_hdr.status & CTL_STATUS_MASK) == CTL_SUCCESS)) {
5093 io->scsiio.io_cont(io);
5097 * Since a configuration write can be done for commands that actually
5098 * have data allocated, like write buffer, and commands that have
5099 * no data, like start/stop unit, we need to check here.
5101 if (io->io_hdr.flags & CTL_FLAG_ALLOCATED)
5102 buf = io->scsiio.kern_data_ptr;
5111 ctl_config_read_done(union ctl_io *io)
5116 * If there is some error -- we are done, skip data transfer.
5118 if ((io->io_hdr.flags & CTL_FLAG_ABORT) != 0 ||
5119 ((io->io_hdr.status & CTL_STATUS_MASK) != CTL_STATUS_NONE &&
5120 (io->io_hdr.status & CTL_STATUS_MASK) != CTL_SUCCESS)) {
5121 if (io->io_hdr.flags & CTL_FLAG_ALLOCATED)
5122 buf = io->scsiio.kern_data_ptr;
5132 * If the IO_CONT flag is set, we need to call the supplied
5133 * function to continue processing the I/O, instead of completing
5136 if (io->io_hdr.flags & CTL_FLAG_IO_CONT) {
5137 io->scsiio.io_cont(io);
5145 * SCSI release command.
5148 ctl_scsi_release(struct ctl_scsiio *ctsio)
5150 struct ctl_lun *lun;
5153 CTL_DEBUG_PRINT(("ctl_scsi_release\n"));
5155 residx = ctl_get_initindex(&ctsio->io_hdr.nexus);
5156 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5159 * XXX KDM right now, we only support LUN reservation. We don't
5160 * support 3rd party reservations, or extent reservations, which
5161 * might actually need the parameter list. If we've gotten this
5162 * far, we've got a LUN reservation. Anything else got kicked out
5163 * above. So, according to SPC, ignore the length.
5166 mtx_lock(&lun->lun_lock);
5169 * According to SPC, it is not an error for an intiator to attempt
5170 * to release a reservation on a LUN that isn't reserved, or that
5171 * is reserved by another initiator. The reservation can only be
5172 * released, though, by the initiator who made it or by one of
5173 * several reset type events.
5175 if ((lun->flags & CTL_LUN_RESERVED) && (lun->res_idx == residx))
5176 lun->flags &= ~CTL_LUN_RESERVED;
5178 mtx_unlock(&lun->lun_lock);
5180 ctl_set_success(ctsio);
5181 ctl_done((union ctl_io *)ctsio);
5182 return (CTL_RETVAL_COMPLETE);
5186 ctl_scsi_reserve(struct ctl_scsiio *ctsio)
5188 struct ctl_lun *lun;
5191 CTL_DEBUG_PRINT(("ctl_reserve\n"));
5193 residx = ctl_get_initindex(&ctsio->io_hdr.nexus);
5194 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5197 * XXX KDM right now, we only support LUN reservation. We don't
5198 * support 3rd party reservations, or extent reservations, which
5199 * might actually need the parameter list. If we've gotten this
5200 * far, we've got a LUN reservation. Anything else got kicked out
5201 * above. So, according to SPC, ignore the length.
5204 mtx_lock(&lun->lun_lock);
5205 if ((lun->flags & CTL_LUN_RESERVED) && (lun->res_idx != residx)) {
5206 ctl_set_reservation_conflict(ctsio);
5210 /* SPC-3 exceptions to SPC-2 RESERVE and RELEASE behavior. */
5211 if (lun->flags & CTL_LUN_PR_RESERVED) {
5212 ctl_set_success(ctsio);
5216 lun->flags |= CTL_LUN_RESERVED;
5217 lun->res_idx = residx;
5218 ctl_set_success(ctsio);
5221 mtx_unlock(&lun->lun_lock);
5222 ctl_done((union ctl_io *)ctsio);
5223 return (CTL_RETVAL_COMPLETE);
5227 ctl_start_stop(struct ctl_scsiio *ctsio)
5229 struct scsi_start_stop_unit *cdb;
5230 struct ctl_lun *lun;
5233 CTL_DEBUG_PRINT(("ctl_start_stop\n"));
5235 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5236 cdb = (struct scsi_start_stop_unit *)ctsio->cdb;
5238 if ((cdb->how & SSS_PC_MASK) == 0) {
5239 if ((lun->flags & CTL_LUN_PR_RESERVED) &&
5240 (cdb->how & SSS_START) == 0) {
5243 residx = ctl_get_initindex(&ctsio->io_hdr.nexus);
5244 if (ctl_get_prkey(lun, residx) == 0 ||
5245 (lun->pr_res_idx != residx && lun->pr_res_type < 4)) {
5247 ctl_set_reservation_conflict(ctsio);
5248 ctl_done((union ctl_io *)ctsio);
5249 return (CTL_RETVAL_COMPLETE);
5253 if ((cdb->how & SSS_LOEJ) &&
5254 (lun->flags & CTL_LUN_REMOVABLE) == 0) {
5255 ctl_set_invalid_field(ctsio,
5261 ctl_done((union ctl_io *)ctsio);
5262 return (CTL_RETVAL_COMPLETE);
5265 if ((cdb->how & SSS_START) == 0 && (cdb->how & SSS_LOEJ) &&
5266 lun->prevent_count > 0) {
5267 /* "Medium removal prevented" */
5268 ctl_set_sense(ctsio, /*current_error*/ 1,
5269 /*sense_key*/(lun->flags & CTL_LUN_NO_MEDIA) ?
5270 SSD_KEY_NOT_READY : SSD_KEY_ILLEGAL_REQUEST,
5271 /*asc*/ 0x53, /*ascq*/ 0x02, SSD_ELEM_NONE);
5272 ctl_done((union ctl_io *)ctsio);
5273 return (CTL_RETVAL_COMPLETE);
5277 retval = lun->backend->config_write((union ctl_io *)ctsio);
5282 ctl_prevent_allow(struct ctl_scsiio *ctsio)
5284 struct ctl_lun *lun;
5285 struct scsi_prevent *cdb;
5289 CTL_DEBUG_PRINT(("ctl_prevent_allow\n"));
5291 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5292 cdb = (struct scsi_prevent *)ctsio->cdb;
5294 if ((lun->flags & CTL_LUN_REMOVABLE) == 0) {
5295 ctl_set_invalid_opcode(ctsio);
5296 ctl_done((union ctl_io *)ctsio);
5297 return (CTL_RETVAL_COMPLETE);
5300 initidx = ctl_get_initindex(&ctsio->io_hdr.nexus);
5301 mtx_lock(&lun->lun_lock);
5302 if ((cdb->how & PR_PREVENT) &&
5303 ctl_is_set(lun->prevent, initidx) == 0) {
5304 ctl_set_mask(lun->prevent, initidx);
5305 lun->prevent_count++;
5306 } else if ((cdb->how & PR_PREVENT) == 0 &&
5307 ctl_is_set(lun->prevent, initidx)) {
5308 ctl_clear_mask(lun->prevent, initidx);
5309 lun->prevent_count--;
5311 mtx_unlock(&lun->lun_lock);
5312 retval = lun->backend->config_write((union ctl_io *)ctsio);
5317 * We support the SYNCHRONIZE CACHE command (10 and 16 byte versions), but
5318 * we don't really do anything with the LBA and length fields if the user
5319 * passes them in. Instead we'll just flush out the cache for the entire
5323 ctl_sync_cache(struct ctl_scsiio *ctsio)
5325 struct ctl_lun *lun;
5326 struct ctl_softc *softc;
5327 struct ctl_lba_len_flags *lbalen;
5328 uint64_t starting_lba;
5329 uint32_t block_count;
5333 CTL_DEBUG_PRINT(("ctl_sync_cache\n"));
5335 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5336 softc = lun->ctl_softc;
5339 switch (ctsio->cdb[0]) {
5340 case SYNCHRONIZE_CACHE: {
5341 struct scsi_sync_cache *cdb;
5342 cdb = (struct scsi_sync_cache *)ctsio->cdb;
5344 starting_lba = scsi_4btoul(cdb->begin_lba);
5345 block_count = scsi_2btoul(cdb->lb_count);
5349 case SYNCHRONIZE_CACHE_16: {
5350 struct scsi_sync_cache_16 *cdb;
5351 cdb = (struct scsi_sync_cache_16 *)ctsio->cdb;
5353 starting_lba = scsi_8btou64(cdb->begin_lba);
5354 block_count = scsi_4btoul(cdb->lb_count);
5359 ctl_set_invalid_opcode(ctsio);
5360 ctl_done((union ctl_io *)ctsio);
5362 break; /* NOTREACHED */
5366 * We check the LBA and length, but don't do anything with them.
5367 * A SYNCHRONIZE CACHE will cause the entire cache for this lun to
5368 * get flushed. This check will just help satisfy anyone who wants
5369 * to see an error for an out of range LBA.
5371 if ((starting_lba + block_count) > (lun->be_lun->maxlba + 1)) {
5372 ctl_set_lba_out_of_range(ctsio,
5373 MAX(starting_lba, lun->be_lun->maxlba + 1));
5374 ctl_done((union ctl_io *)ctsio);
5378 lbalen = (struct ctl_lba_len_flags *)&ctsio->io_hdr.ctl_private[CTL_PRIV_LBA_LEN];
5379 lbalen->lba = starting_lba;
5380 lbalen->len = block_count;
5381 lbalen->flags = byte2;
5382 retval = lun->backend->config_write((union ctl_io *)ctsio);
5389 ctl_format(struct ctl_scsiio *ctsio)
5391 struct scsi_format *cdb;
5392 struct ctl_lun *lun;
5393 int length, defect_list_len;
5395 CTL_DEBUG_PRINT(("ctl_format\n"));
5397 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5399 cdb = (struct scsi_format *)ctsio->cdb;
5402 if (cdb->byte2 & SF_FMTDATA) {
5403 if (cdb->byte2 & SF_LONGLIST)
5404 length = sizeof(struct scsi_format_header_long);
5406 length = sizeof(struct scsi_format_header_short);
5409 if (((ctsio->io_hdr.flags & CTL_FLAG_ALLOCATED) == 0)
5411 ctsio->kern_data_ptr = malloc(length, M_CTL, M_WAITOK);
5412 ctsio->kern_data_len = length;
5413 ctsio->kern_total_len = length;
5414 ctsio->kern_data_resid = 0;
5415 ctsio->kern_rel_offset = 0;
5416 ctsio->kern_sg_entries = 0;
5417 ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
5418 ctsio->be_move_done = ctl_config_move_done;
5419 ctl_datamove((union ctl_io *)ctsio);
5421 return (CTL_RETVAL_COMPLETE);
5424 defect_list_len = 0;
5426 if (cdb->byte2 & SF_FMTDATA) {
5427 if (cdb->byte2 & SF_LONGLIST) {
5428 struct scsi_format_header_long *header;
5430 header = (struct scsi_format_header_long *)
5431 ctsio->kern_data_ptr;
5433 defect_list_len = scsi_4btoul(header->defect_list_len);
5434 if (defect_list_len != 0) {
5435 ctl_set_invalid_field(ctsio,
5444 struct scsi_format_header_short *header;
5446 header = (struct scsi_format_header_short *)
5447 ctsio->kern_data_ptr;
5449 defect_list_len = scsi_2btoul(header->defect_list_len);
5450 if (defect_list_len != 0) {
5451 ctl_set_invalid_field(ctsio,
5462 ctl_set_success(ctsio);
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_read_buffer(struct ctl_scsiio *ctsio)
5477 struct ctl_lun *lun;
5478 uint64_t buffer_offset;
5481 static uint8_t descr[4];
5482 static uint8_t echo_descr[4] = { 0 };
5484 CTL_DEBUG_PRINT(("ctl_read_buffer\n"));
5485 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5486 switch (ctsio->cdb[0]) {
5488 struct scsi_read_buffer *cdb;
5490 cdb = (struct scsi_read_buffer *)ctsio->cdb;
5491 buffer_offset = scsi_3btoul(cdb->offset);
5492 len = scsi_3btoul(cdb->length);
5496 case READ_BUFFER_16: {
5497 struct scsi_read_buffer_16 *cdb;
5499 cdb = (struct scsi_read_buffer_16 *)ctsio->cdb;
5500 buffer_offset = scsi_8btou64(cdb->offset);
5501 len = scsi_4btoul(cdb->length);
5505 default: /* This shouldn't happen. */
5506 ctl_set_invalid_opcode(ctsio);
5507 ctl_done((union ctl_io *)ctsio);
5508 return (CTL_RETVAL_COMPLETE);
5511 if (buffer_offset > CTL_WRITE_BUFFER_SIZE ||
5512 buffer_offset + len > CTL_WRITE_BUFFER_SIZE) {
5513 ctl_set_invalid_field(ctsio,
5519 ctl_done((union ctl_io *)ctsio);
5520 return (CTL_RETVAL_COMPLETE);
5523 if ((byte2 & RWB_MODE) == RWB_MODE_DESCR) {
5525 scsi_ulto3b(CTL_WRITE_BUFFER_SIZE, &descr[1]);
5526 ctsio->kern_data_ptr = descr;
5527 len = min(len, sizeof(descr));
5528 } else if ((byte2 & RWB_MODE) == RWB_MODE_ECHO_DESCR) {
5529 ctsio->kern_data_ptr = echo_descr;
5530 len = min(len, sizeof(echo_descr));
5532 if (lun->write_buffer == NULL) {
5533 lun->write_buffer = malloc(CTL_WRITE_BUFFER_SIZE,
5536 ctsio->kern_data_ptr = lun->write_buffer + buffer_offset;
5538 ctsio->kern_data_len = len;
5539 ctsio->kern_total_len = len;
5540 ctsio->kern_data_resid = 0;
5541 ctsio->kern_rel_offset = 0;
5542 ctsio->kern_sg_entries = 0;
5543 ctl_set_success(ctsio);
5544 ctsio->be_move_done = ctl_config_move_done;
5545 ctl_datamove((union ctl_io *)ctsio);
5546 return (CTL_RETVAL_COMPLETE);
5550 ctl_write_buffer(struct ctl_scsiio *ctsio)
5552 struct scsi_write_buffer *cdb;
5553 struct ctl_lun *lun;
5554 int buffer_offset, len;
5556 CTL_DEBUG_PRINT(("ctl_write_buffer\n"));
5558 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5559 cdb = (struct scsi_write_buffer *)ctsio->cdb;
5561 len = scsi_3btoul(cdb->length);
5562 buffer_offset = scsi_3btoul(cdb->offset);
5564 if (buffer_offset + len > CTL_WRITE_BUFFER_SIZE) {
5565 ctl_set_invalid_field(ctsio,
5571 ctl_done((union ctl_io *)ctsio);
5572 return (CTL_RETVAL_COMPLETE);
5576 * If we've got a kernel request that hasn't been malloced yet,
5577 * malloc it and tell the caller the data buffer is here.
5579 if ((ctsio->io_hdr.flags & CTL_FLAG_ALLOCATED) == 0) {
5580 if (lun->write_buffer == NULL) {
5581 lun->write_buffer = malloc(CTL_WRITE_BUFFER_SIZE,
5584 ctsio->kern_data_ptr = lun->write_buffer + buffer_offset;
5585 ctsio->kern_data_len = len;
5586 ctsio->kern_total_len = len;
5587 ctsio->kern_data_resid = 0;
5588 ctsio->kern_rel_offset = 0;
5589 ctsio->kern_sg_entries = 0;
5590 ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
5591 ctsio->be_move_done = ctl_config_move_done;
5592 ctl_datamove((union ctl_io *)ctsio);
5594 return (CTL_RETVAL_COMPLETE);
5597 ctl_set_success(ctsio);
5598 ctl_done((union ctl_io *)ctsio);
5599 return (CTL_RETVAL_COMPLETE);
5603 ctl_write_same(struct ctl_scsiio *ctsio)
5605 struct ctl_lun *lun;
5606 struct ctl_lba_len_flags *lbalen;
5608 uint32_t num_blocks;
5612 CTL_DEBUG_PRINT(("ctl_write_same\n"));
5614 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5616 switch (ctsio->cdb[0]) {
5617 case WRITE_SAME_10: {
5618 struct scsi_write_same_10 *cdb;
5620 cdb = (struct scsi_write_same_10 *)ctsio->cdb;
5622 lba = scsi_4btoul(cdb->addr);
5623 num_blocks = scsi_2btoul(cdb->length);
5627 case WRITE_SAME_16: {
5628 struct scsi_write_same_16 *cdb;
5630 cdb = (struct scsi_write_same_16 *)ctsio->cdb;
5632 lba = scsi_8btou64(cdb->addr);
5633 num_blocks = scsi_4btoul(cdb->length);
5639 * We got a command we don't support. This shouldn't
5640 * happen, commands should be filtered out above us.
5642 ctl_set_invalid_opcode(ctsio);
5643 ctl_done((union ctl_io *)ctsio);
5645 return (CTL_RETVAL_COMPLETE);
5646 break; /* NOTREACHED */
5649 /* ANCHOR flag can be used only together with UNMAP */
5650 if ((byte2 & SWS_UNMAP) == 0 && (byte2 & SWS_ANCHOR) != 0) {
5651 ctl_set_invalid_field(ctsio, /*sks_valid*/ 1,
5652 /*command*/ 1, /*field*/ 1, /*bit_valid*/ 1, /*bit*/ 0);
5653 ctl_done((union ctl_io *)ctsio);
5654 return (CTL_RETVAL_COMPLETE);
5658 * The first check is to make sure we're in bounds, the second
5659 * check is to catch wrap-around problems. If the lba + num blocks
5660 * is less than the lba, then we've wrapped around and the block
5661 * range is invalid anyway.
5663 if (((lba + num_blocks) > (lun->be_lun->maxlba + 1))
5664 || ((lba + num_blocks) < lba)) {
5665 ctl_set_lba_out_of_range(ctsio,
5666 MAX(lba, lun->be_lun->maxlba + 1));
5667 ctl_done((union ctl_io *)ctsio);
5668 return (CTL_RETVAL_COMPLETE);
5671 /* Zero number of blocks means "to the last logical block" */
5672 if (num_blocks == 0) {
5673 if ((lun->be_lun->maxlba + 1) - lba > UINT32_MAX) {
5674 ctl_set_invalid_field(ctsio,
5680 ctl_done((union ctl_io *)ctsio);
5681 return (CTL_RETVAL_COMPLETE);
5683 num_blocks = (lun->be_lun->maxlba + 1) - lba;
5686 len = lun->be_lun->blocksize;
5689 * If we've got a kernel request that hasn't been malloced yet,
5690 * malloc it and tell the caller the data buffer is here.
5692 if ((byte2 & SWS_NDOB) == 0 &&
5693 (ctsio->io_hdr.flags & CTL_FLAG_ALLOCATED) == 0) {
5694 ctsio->kern_data_ptr = malloc(len, M_CTL, M_WAITOK);
5695 ctsio->kern_data_len = len;
5696 ctsio->kern_total_len = len;
5697 ctsio->kern_data_resid = 0;
5698 ctsio->kern_rel_offset = 0;
5699 ctsio->kern_sg_entries = 0;
5700 ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
5701 ctsio->be_move_done = ctl_config_move_done;
5702 ctl_datamove((union ctl_io *)ctsio);
5704 return (CTL_RETVAL_COMPLETE);
5707 lbalen = (struct ctl_lba_len_flags *)&ctsio->io_hdr.ctl_private[CTL_PRIV_LBA_LEN];
5709 lbalen->len = num_blocks;
5710 lbalen->flags = byte2;
5711 retval = lun->backend->config_write((union ctl_io *)ctsio);
5717 ctl_unmap(struct ctl_scsiio *ctsio)
5719 struct ctl_lun *lun;
5720 struct scsi_unmap *cdb;
5721 struct ctl_ptr_len_flags *ptrlen;
5722 struct scsi_unmap_header *hdr;
5723 struct scsi_unmap_desc *buf, *end, *endnz, *range;
5725 uint32_t num_blocks;
5729 CTL_DEBUG_PRINT(("ctl_unmap\n"));
5731 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5732 cdb = (struct scsi_unmap *)ctsio->cdb;
5734 len = scsi_2btoul(cdb->length);
5738 * If we've got a kernel request that hasn't been malloced yet,
5739 * malloc it and tell the caller the data buffer is here.
5741 if ((ctsio->io_hdr.flags & CTL_FLAG_ALLOCATED) == 0) {
5742 ctsio->kern_data_ptr = malloc(len, M_CTL, M_WAITOK);
5743 ctsio->kern_data_len = len;
5744 ctsio->kern_total_len = len;
5745 ctsio->kern_data_resid = 0;
5746 ctsio->kern_rel_offset = 0;
5747 ctsio->kern_sg_entries = 0;
5748 ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
5749 ctsio->be_move_done = ctl_config_move_done;
5750 ctl_datamove((union ctl_io *)ctsio);
5752 return (CTL_RETVAL_COMPLETE);
5755 len = ctsio->kern_total_len - ctsio->kern_data_resid;
5756 hdr = (struct scsi_unmap_header *)ctsio->kern_data_ptr;
5757 if (len < sizeof (*hdr) ||
5758 len < (scsi_2btoul(hdr->length) + sizeof(hdr->length)) ||
5759 len < (scsi_2btoul(hdr->desc_length) + sizeof (*hdr)) ||
5760 scsi_2btoul(hdr->desc_length) % sizeof(*buf) != 0) {
5761 ctl_set_invalid_field(ctsio,
5769 len = scsi_2btoul(hdr->desc_length);
5770 buf = (struct scsi_unmap_desc *)(hdr + 1);
5771 end = buf + len / sizeof(*buf);
5774 for (range = buf; range < end; range++) {
5775 lba = scsi_8btou64(range->lba);
5776 num_blocks = scsi_4btoul(range->length);
5777 if (((lba + num_blocks) > (lun->be_lun->maxlba + 1))
5778 || ((lba + num_blocks) < lba)) {
5779 ctl_set_lba_out_of_range(ctsio,
5780 MAX(lba, lun->be_lun->maxlba + 1));
5781 ctl_done((union ctl_io *)ctsio);
5782 return (CTL_RETVAL_COMPLETE);
5784 if (num_blocks != 0)
5789 * Block backend can not handle zero last range.
5790 * Filter it out and return if there is nothing left.
5792 len = (uint8_t *)endnz - (uint8_t *)buf;
5794 ctl_set_success(ctsio);
5798 mtx_lock(&lun->lun_lock);
5799 ptrlen = (struct ctl_ptr_len_flags *)
5800 &ctsio->io_hdr.ctl_private[CTL_PRIV_LBA_LEN];
5801 ptrlen->ptr = (void *)buf;
5803 ptrlen->flags = byte2;
5804 ctl_check_blocked(lun);
5805 mtx_unlock(&lun->lun_lock);
5807 retval = lun->backend->config_write((union ctl_io *)ctsio);
5811 if (ctsio->io_hdr.flags & CTL_FLAG_ALLOCATED) {
5812 free(ctsio->kern_data_ptr, M_CTL);
5813 ctsio->io_hdr.flags &= ~CTL_FLAG_ALLOCATED;
5815 ctl_done((union ctl_io *)ctsio);
5816 return (CTL_RETVAL_COMPLETE);
5820 ctl_default_page_handler(struct ctl_scsiio *ctsio,
5821 struct ctl_page_index *page_index, uint8_t *page_ptr)
5823 struct ctl_lun *lun;
5824 uint8_t *current_cp, *saved_cp;
5828 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5829 initidx = ctl_get_initindex(&ctsio->io_hdr.nexus);
5832 current_cp = (page_index->page_data + (page_index->page_len *
5834 saved_cp = (page_index->page_data + (page_index->page_len *
5837 mtx_lock(&lun->lun_lock);
5838 if (memcmp(current_cp, page_ptr, page_index->page_len)) {
5839 memcpy(current_cp, page_ptr, page_index->page_len);
5840 memcpy(saved_cp, page_ptr, page_index->page_len);
5844 ctl_est_ua_all(lun, initidx, CTL_UA_MODE_CHANGE);
5845 mtx_unlock(&lun->lun_lock);
5847 ctl_isc_announce_mode(lun,
5848 ctl_get_initindex(&ctsio->io_hdr.nexus),
5849 page_index->page_code, page_index->subpage);
5851 return (CTL_RETVAL_COMPLETE);
5855 ctl_ie_timer(void *arg)
5857 struct ctl_lun *lun = arg;
5860 if (lun->ie_asc == 0)
5863 if (lun->MODE_IE.mrie == SIEP_MRIE_UA)
5864 ctl_est_ua_all(lun, -1, CTL_UA_IE);
5866 lun->ie_reported = 0;
5868 if (lun->ie_reportcnt < scsi_4btoul(lun->MODE_IE.report_count)) {
5869 lun->ie_reportcnt++;
5870 t = scsi_4btoul(lun->MODE_IE.interval_timer);
5871 if (t == 0 || t == UINT32_MAX)
5872 t = 3000; /* 5 min */
5873 callout_schedule(&lun->ie_callout, t * hz / 10);
5878 ctl_ie_page_handler(struct ctl_scsiio *ctsio,
5879 struct ctl_page_index *page_index, uint8_t *page_ptr)
5881 struct scsi_info_exceptions_page *pg;
5882 struct ctl_lun *lun;
5885 (void)ctl_default_page_handler(ctsio, page_index, page_ptr);
5887 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5888 pg = (struct scsi_info_exceptions_page *)page_ptr;
5889 mtx_lock(&lun->lun_lock);
5890 if (pg->info_flags & SIEP_FLAGS_TEST) {
5892 lun->ie_ascq = 0xff;
5893 if (pg->mrie == SIEP_MRIE_UA) {
5894 ctl_est_ua_all(lun, -1, CTL_UA_IE);
5895 lun->ie_reported = 1;
5897 ctl_clr_ua_all(lun, -1, CTL_UA_IE);
5898 lun->ie_reported = -1;
5900 lun->ie_reportcnt = 1;
5901 if (lun->ie_reportcnt < scsi_4btoul(pg->report_count)) {
5902 lun->ie_reportcnt++;
5903 t = scsi_4btoul(pg->interval_timer);
5904 if (t == 0 || t == UINT32_MAX)
5905 t = 3000; /* 5 min */
5906 callout_reset(&lun->ie_callout, t * hz / 10,
5912 lun->ie_reported = 1;
5913 ctl_clr_ua_all(lun, -1, CTL_UA_IE);
5914 lun->ie_reportcnt = UINT32_MAX;
5915 callout_stop(&lun->ie_callout);
5917 mtx_unlock(&lun->lun_lock);
5918 return (CTL_RETVAL_COMPLETE);
5922 ctl_do_mode_select(union ctl_io *io)
5924 struct scsi_mode_page_header *page_header;
5925 struct ctl_page_index *page_index;
5926 struct ctl_scsiio *ctsio;
5927 int page_len, page_len_offset, page_len_size;
5928 union ctl_modepage_info *modepage_info;
5929 struct ctl_lun *lun;
5930 int *len_left, *len_used;
5933 ctsio = &io->scsiio;
5936 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5938 modepage_info = (union ctl_modepage_info *)
5939 ctsio->io_hdr.ctl_private[CTL_PRIV_MODEPAGE].bytes;
5940 len_left = &modepage_info->header.len_left;
5941 len_used = &modepage_info->header.len_used;
5945 page_header = (struct scsi_mode_page_header *)
5946 (ctsio->kern_data_ptr + *len_used);
5948 if (*len_left == 0) {
5949 free(ctsio->kern_data_ptr, M_CTL);
5950 ctl_set_success(ctsio);
5951 ctl_done((union ctl_io *)ctsio);
5952 return (CTL_RETVAL_COMPLETE);
5953 } else if (*len_left < sizeof(struct scsi_mode_page_header)) {
5955 free(ctsio->kern_data_ptr, M_CTL);
5956 ctl_set_param_len_error(ctsio);
5957 ctl_done((union ctl_io *)ctsio);
5958 return (CTL_RETVAL_COMPLETE);
5960 } else if ((page_header->page_code & SMPH_SPF)
5961 && (*len_left < sizeof(struct scsi_mode_page_header_sp))) {
5963 free(ctsio->kern_data_ptr, M_CTL);
5964 ctl_set_param_len_error(ctsio);
5965 ctl_done((union ctl_io *)ctsio);
5966 return (CTL_RETVAL_COMPLETE);
5971 * XXX KDM should we do something with the block descriptor?
5973 for (i = 0; i < CTL_NUM_MODE_PAGES; i++) {
5974 page_index = &lun->mode_pages.index[i];
5975 if (lun->be_lun->lun_type == T_DIRECT &&
5976 (page_index->page_flags & CTL_PAGE_FLAG_DIRECT) == 0)
5978 if (lun->be_lun->lun_type == T_PROCESSOR &&
5979 (page_index->page_flags & CTL_PAGE_FLAG_PROC) == 0)
5981 if (lun->be_lun->lun_type == T_CDROM &&
5982 (page_index->page_flags & CTL_PAGE_FLAG_CDROM) == 0)
5985 if ((page_index->page_code & SMPH_PC_MASK) !=
5986 (page_header->page_code & SMPH_PC_MASK))
5990 * If neither page has a subpage code, then we've got a
5993 if (((page_index->page_code & SMPH_SPF) == 0)
5994 && ((page_header->page_code & SMPH_SPF) == 0)) {
5995 page_len = page_header->page_length;
6000 * If both pages have subpages, then the subpage numbers
6003 if ((page_index->page_code & SMPH_SPF)
6004 && (page_header->page_code & SMPH_SPF)) {
6005 struct scsi_mode_page_header_sp *sph;
6007 sph = (struct scsi_mode_page_header_sp *)page_header;
6008 if (page_index->subpage == sph->subpage) {
6009 page_len = scsi_2btoul(sph->page_length);
6016 * If we couldn't find the page, or if we don't have a mode select
6017 * handler for it, send back an error to the user.
6019 if ((i >= CTL_NUM_MODE_PAGES)
6020 || (page_index->select_handler == NULL)) {
6021 ctl_set_invalid_field(ctsio,
6024 /*field*/ *len_used,
6027 free(ctsio->kern_data_ptr, M_CTL);
6028 ctl_done((union ctl_io *)ctsio);
6029 return (CTL_RETVAL_COMPLETE);
6032 if (page_index->page_code & SMPH_SPF) {
6033 page_len_offset = 2;
6037 page_len_offset = 1;
6041 * If the length the initiator gives us isn't the one we specify in
6042 * the mode page header, or if they didn't specify enough data in
6043 * the CDB to avoid truncating this page, kick out the request.
6045 if (page_len != page_index->page_len - page_len_offset - page_len_size) {
6046 ctl_set_invalid_field(ctsio,
6049 /*field*/ *len_used + page_len_offset,
6052 free(ctsio->kern_data_ptr, M_CTL);
6053 ctl_done((union ctl_io *)ctsio);
6054 return (CTL_RETVAL_COMPLETE);
6056 if (*len_left < page_index->page_len) {
6057 free(ctsio->kern_data_ptr, M_CTL);
6058 ctl_set_param_len_error(ctsio);
6059 ctl_done((union ctl_io *)ctsio);
6060 return (CTL_RETVAL_COMPLETE);
6064 * Run through the mode page, checking to make sure that the bits
6065 * the user changed are actually legal for him to change.
6067 for (i = 0; i < page_index->page_len; i++) {
6068 uint8_t *user_byte, *change_mask, *current_byte;
6072 user_byte = (uint8_t *)page_header + i;
6073 change_mask = page_index->page_data +
6074 (page_index->page_len * CTL_PAGE_CHANGEABLE) + i;
6075 current_byte = page_index->page_data +
6076 (page_index->page_len * CTL_PAGE_CURRENT) + i;
6079 * Check to see whether the user set any bits in this byte
6080 * that he is not allowed to set.
6082 if ((*user_byte & ~(*change_mask)) ==
6083 (*current_byte & ~(*change_mask)))
6087 * Go through bit by bit to determine which one is illegal.
6090 for (j = 7; j >= 0; j--) {
6091 if ((((1 << i) & ~(*change_mask)) & *user_byte) !=
6092 (((1 << i) & ~(*change_mask)) & *current_byte)) {
6097 ctl_set_invalid_field(ctsio,
6100 /*field*/ *len_used + i,
6103 free(ctsio->kern_data_ptr, M_CTL);
6104 ctl_done((union ctl_io *)ctsio);
6105 return (CTL_RETVAL_COMPLETE);
6109 * Decrement these before we call the page handler, since we may
6110 * end up getting called back one way or another before the handler
6111 * returns to this context.
6113 *len_left -= page_index->page_len;
6114 *len_used += page_index->page_len;
6116 retval = page_index->select_handler(ctsio, page_index,
6117 (uint8_t *)page_header);
6120 * If the page handler returns CTL_RETVAL_QUEUED, then we need to
6121 * wait until this queued command completes to finish processing
6122 * the mode page. If it returns anything other than
6123 * CTL_RETVAL_COMPLETE (e.g. CTL_RETVAL_ERROR), then it should have
6124 * already set the sense information, freed the data pointer, and
6125 * completed the io for us.
6127 if (retval != CTL_RETVAL_COMPLETE)
6128 goto bailout_no_done;
6131 * If the initiator sent us more than one page, parse the next one.
6136 ctl_set_success(ctsio);
6137 free(ctsio->kern_data_ptr, M_CTL);
6138 ctl_done((union ctl_io *)ctsio);
6142 return (CTL_RETVAL_COMPLETE);
6147 ctl_mode_select(struct ctl_scsiio *ctsio)
6149 int param_len, pf, sp;
6150 int header_size, bd_len;
6151 union ctl_modepage_info *modepage_info;
6153 switch (ctsio->cdb[0]) {
6154 case MODE_SELECT_6: {
6155 struct scsi_mode_select_6 *cdb;
6157 cdb = (struct scsi_mode_select_6 *)ctsio->cdb;
6159 pf = (cdb->byte2 & SMS_PF) ? 1 : 0;
6160 sp = (cdb->byte2 & SMS_SP) ? 1 : 0;
6161 param_len = cdb->length;
6162 header_size = sizeof(struct scsi_mode_header_6);
6165 case MODE_SELECT_10: {
6166 struct scsi_mode_select_10 *cdb;
6168 cdb = (struct scsi_mode_select_10 *)ctsio->cdb;
6170 pf = (cdb->byte2 & SMS_PF) ? 1 : 0;
6171 sp = (cdb->byte2 & SMS_SP) ? 1 : 0;
6172 param_len = scsi_2btoul(cdb->length);
6173 header_size = sizeof(struct scsi_mode_header_10);
6177 ctl_set_invalid_opcode(ctsio);
6178 ctl_done((union ctl_io *)ctsio);
6179 return (CTL_RETVAL_COMPLETE);
6184 * "A parameter list length of zero indicates that the Data-Out Buffer
6185 * shall be empty. This condition shall not be considered as an error."
6187 if (param_len == 0) {
6188 ctl_set_success(ctsio);
6189 ctl_done((union ctl_io *)ctsio);
6190 return (CTL_RETVAL_COMPLETE);
6194 * Since we'll hit this the first time through, prior to
6195 * allocation, we don't need to free a data buffer here.
6197 if (param_len < header_size) {
6198 ctl_set_param_len_error(ctsio);
6199 ctl_done((union ctl_io *)ctsio);
6200 return (CTL_RETVAL_COMPLETE);
6204 * Allocate the data buffer and grab the user's data. In theory,
6205 * we shouldn't have to sanity check the parameter list length here
6206 * because the maximum size is 64K. We should be able to malloc
6207 * that much without too many problems.
6209 if ((ctsio->io_hdr.flags & CTL_FLAG_ALLOCATED) == 0) {
6210 ctsio->kern_data_ptr = malloc(param_len, M_CTL, M_WAITOK);
6211 ctsio->kern_data_len = param_len;
6212 ctsio->kern_total_len = param_len;
6213 ctsio->kern_data_resid = 0;
6214 ctsio->kern_rel_offset = 0;
6215 ctsio->kern_sg_entries = 0;
6216 ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
6217 ctsio->be_move_done = ctl_config_move_done;
6218 ctl_datamove((union ctl_io *)ctsio);
6220 return (CTL_RETVAL_COMPLETE);
6223 switch (ctsio->cdb[0]) {
6224 case MODE_SELECT_6: {
6225 struct scsi_mode_header_6 *mh6;
6227 mh6 = (struct scsi_mode_header_6 *)ctsio->kern_data_ptr;
6228 bd_len = mh6->blk_desc_len;
6231 case MODE_SELECT_10: {
6232 struct scsi_mode_header_10 *mh10;
6234 mh10 = (struct scsi_mode_header_10 *)ctsio->kern_data_ptr;
6235 bd_len = scsi_2btoul(mh10->blk_desc_len);
6239 panic("%s: Invalid CDB type %#x", __func__, ctsio->cdb[0]);
6242 if (param_len < (header_size + bd_len)) {
6243 free(ctsio->kern_data_ptr, M_CTL);
6244 ctl_set_param_len_error(ctsio);
6245 ctl_done((union ctl_io *)ctsio);
6246 return (CTL_RETVAL_COMPLETE);
6250 * Set the IO_CONT flag, so that if this I/O gets passed to
6251 * ctl_config_write_done(), it'll get passed back to
6252 * ctl_do_mode_select() for further processing, or completion if
6255 ctsio->io_hdr.flags |= CTL_FLAG_IO_CONT;
6256 ctsio->io_cont = ctl_do_mode_select;
6258 modepage_info = (union ctl_modepage_info *)
6259 ctsio->io_hdr.ctl_private[CTL_PRIV_MODEPAGE].bytes;
6260 memset(modepage_info, 0, sizeof(*modepage_info));
6261 modepage_info->header.len_left = param_len - header_size - bd_len;
6262 modepage_info->header.len_used = header_size + bd_len;
6264 return (ctl_do_mode_select((union ctl_io *)ctsio));
6268 ctl_mode_sense(struct ctl_scsiio *ctsio)
6270 struct ctl_lun *lun;
6271 int pc, page_code, dbd, llba, subpage;
6272 int alloc_len, page_len, header_len, total_len;
6273 struct scsi_mode_block_descr *block_desc;
6274 struct ctl_page_index *page_index;
6280 CTL_DEBUG_PRINT(("ctl_mode_sense\n"));
6282 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
6283 switch (ctsio->cdb[0]) {
6284 case MODE_SENSE_6: {
6285 struct scsi_mode_sense_6 *cdb;
6287 cdb = (struct scsi_mode_sense_6 *)ctsio->cdb;
6289 header_len = sizeof(struct scsi_mode_hdr_6);
6290 if (cdb->byte2 & SMS_DBD)
6293 header_len += sizeof(struct scsi_mode_block_descr);
6295 pc = (cdb->page & SMS_PAGE_CTRL_MASK) >> 6;
6296 page_code = cdb->page & SMS_PAGE_CODE;
6297 subpage = cdb->subpage;
6298 alloc_len = cdb->length;
6301 case MODE_SENSE_10: {
6302 struct scsi_mode_sense_10 *cdb;
6304 cdb = (struct scsi_mode_sense_10 *)ctsio->cdb;
6306 header_len = sizeof(struct scsi_mode_hdr_10);
6308 if (cdb->byte2 & SMS_DBD)
6311 header_len += sizeof(struct scsi_mode_block_descr);
6312 if (cdb->byte2 & SMS10_LLBAA)
6314 pc = (cdb->page & SMS_PAGE_CTRL_MASK) >> 6;
6315 page_code = cdb->page & SMS_PAGE_CODE;
6316 subpage = cdb->subpage;
6317 alloc_len = scsi_2btoul(cdb->length);
6321 ctl_set_invalid_opcode(ctsio);
6322 ctl_done((union ctl_io *)ctsio);
6323 return (CTL_RETVAL_COMPLETE);
6324 break; /* NOTREACHED */
6328 * We have to make a first pass through to calculate the size of
6329 * the pages that match the user's query. Then we allocate enough
6330 * memory to hold it, and actually copy the data into the buffer.
6332 switch (page_code) {
6333 case SMS_ALL_PAGES_PAGE: {
6339 * At the moment, values other than 0 and 0xff here are
6340 * reserved according to SPC-3.
6342 if ((subpage != SMS_SUBPAGE_PAGE_0)
6343 && (subpage != SMS_SUBPAGE_ALL)) {
6344 ctl_set_invalid_field(ctsio,
6350 ctl_done((union ctl_io *)ctsio);
6351 return (CTL_RETVAL_COMPLETE);
6354 for (i = 0; i < CTL_NUM_MODE_PAGES; i++) {
6355 page_index = &lun->mode_pages.index[i];
6357 /* Make sure the page is supported for this dev type */
6358 if (lun->be_lun->lun_type == T_DIRECT &&
6359 (page_index->page_flags & CTL_PAGE_FLAG_DIRECT) == 0)
6361 if (lun->be_lun->lun_type == T_PROCESSOR &&
6362 (page_index->page_flags & CTL_PAGE_FLAG_PROC) == 0)
6364 if (lun->be_lun->lun_type == T_CDROM &&
6365 (page_index->page_flags & CTL_PAGE_FLAG_CDROM) == 0)
6369 * We don't use this subpage if the user didn't
6370 * request all subpages.
6372 if ((page_index->subpage != 0)
6373 && (subpage == SMS_SUBPAGE_PAGE_0))
6377 printf("found page %#x len %d\n",
6378 page_index->page_code & SMPH_PC_MASK,
6379 page_index->page_len);
6381 page_len += page_index->page_len;
6390 for (i = 0; i < CTL_NUM_MODE_PAGES; i++) {
6391 page_index = &lun->mode_pages.index[i];
6393 /* Make sure the page is supported for this dev type */
6394 if (lun->be_lun->lun_type == T_DIRECT &&
6395 (page_index->page_flags & CTL_PAGE_FLAG_DIRECT) == 0)
6397 if (lun->be_lun->lun_type == T_PROCESSOR &&
6398 (page_index->page_flags & CTL_PAGE_FLAG_PROC) == 0)
6400 if (lun->be_lun->lun_type == T_CDROM &&
6401 (page_index->page_flags & CTL_PAGE_FLAG_CDROM) == 0)
6404 /* Look for the right page code */
6405 if ((page_index->page_code & SMPH_PC_MASK) != page_code)
6408 /* Look for the right subpage or the subpage wildcard*/
6409 if ((page_index->subpage != subpage)
6410 && (subpage != SMS_SUBPAGE_ALL))
6414 printf("found page %#x len %d\n",
6415 page_index->page_code & SMPH_PC_MASK,
6416 page_index->page_len);
6419 page_len += page_index->page_len;
6422 if (page_len == 0) {
6423 ctl_set_invalid_field(ctsio,
6429 ctl_done((union ctl_io *)ctsio);
6430 return (CTL_RETVAL_COMPLETE);
6436 total_len = header_len + page_len;
6438 printf("header_len = %d, page_len = %d, total_len = %d\n",
6439 header_len, page_len, total_len);
6442 ctsio->kern_data_ptr = malloc(total_len, M_CTL, M_WAITOK | M_ZERO);
6443 ctsio->kern_sg_entries = 0;
6444 ctsio->kern_data_resid = 0;
6445 ctsio->kern_rel_offset = 0;
6446 if (total_len < alloc_len) {
6447 ctsio->residual = alloc_len - total_len;
6448 ctsio->kern_data_len = total_len;
6449 ctsio->kern_total_len = total_len;
6451 ctsio->residual = 0;
6452 ctsio->kern_data_len = alloc_len;
6453 ctsio->kern_total_len = alloc_len;
6456 switch (ctsio->cdb[0]) {
6457 case MODE_SENSE_6: {
6458 struct scsi_mode_hdr_6 *header;
6460 header = (struct scsi_mode_hdr_6 *)ctsio->kern_data_ptr;
6462 header->datalen = MIN(total_len - 1, 254);
6463 if (lun->be_lun->lun_type == T_DIRECT) {
6464 header->dev_specific = 0x10; /* DPOFUA */
6465 if ((lun->be_lun->flags & CTL_LUN_FLAG_READONLY) ||
6466 (lun->MODE_CTRL.eca_and_aen & SCP_SWP) != 0)
6467 header->dev_specific |= 0x80; /* WP */
6470 header->block_descr_len = 0;
6472 header->block_descr_len =
6473 sizeof(struct scsi_mode_block_descr);
6474 block_desc = (struct scsi_mode_block_descr *)&header[1];
6477 case MODE_SENSE_10: {
6478 struct scsi_mode_hdr_10 *header;
6481 header = (struct scsi_mode_hdr_10 *)ctsio->kern_data_ptr;
6483 datalen = MIN(total_len - 2, 65533);
6484 scsi_ulto2b(datalen, header->datalen);
6485 if (lun->be_lun->lun_type == T_DIRECT) {
6486 header->dev_specific = 0x10; /* DPOFUA */
6487 if ((lun->be_lun->flags & CTL_LUN_FLAG_READONLY) ||
6488 (lun->MODE_CTRL.eca_and_aen & SCP_SWP) != 0)
6489 header->dev_specific |= 0x80; /* WP */
6492 scsi_ulto2b(0, header->block_descr_len);
6494 scsi_ulto2b(sizeof(struct scsi_mode_block_descr),
6495 header->block_descr_len);
6496 block_desc = (struct scsi_mode_block_descr *)&header[1];
6500 panic("%s: Invalid CDB type %#x", __func__, ctsio->cdb[0]);
6504 * If we've got a disk, use its blocksize in the block
6505 * descriptor. Otherwise, just set it to 0.
6508 if (lun->be_lun->lun_type == T_DIRECT)
6509 scsi_ulto3b(lun->be_lun->blocksize,
6510 block_desc->block_len);
6512 scsi_ulto3b(0, block_desc->block_len);
6515 switch (page_code) {
6516 case SMS_ALL_PAGES_PAGE: {
6519 data_used = header_len;
6520 for (i = 0; i < CTL_NUM_MODE_PAGES; i++) {
6521 struct ctl_page_index *page_index;
6523 page_index = &lun->mode_pages.index[i];
6524 if (lun->be_lun->lun_type == T_DIRECT &&
6525 (page_index->page_flags & CTL_PAGE_FLAG_DIRECT) == 0)
6527 if (lun->be_lun->lun_type == T_PROCESSOR &&
6528 (page_index->page_flags & CTL_PAGE_FLAG_PROC) == 0)
6530 if (lun->be_lun->lun_type == T_CDROM &&
6531 (page_index->page_flags & CTL_PAGE_FLAG_CDROM) == 0)
6535 * We don't use this subpage if the user didn't
6536 * request all subpages. We already checked (above)
6537 * to make sure the user only specified a subpage
6538 * of 0 or 0xff in the SMS_ALL_PAGES_PAGE case.
6540 if ((page_index->subpage != 0)
6541 && (subpage == SMS_SUBPAGE_PAGE_0))
6545 * Call the handler, if it exists, to update the
6546 * page to the latest values.
6548 if (page_index->sense_handler != NULL)
6549 page_index->sense_handler(ctsio, page_index,pc);
6551 memcpy(ctsio->kern_data_ptr + data_used,
6552 page_index->page_data +
6553 (page_index->page_len * pc),
6554 page_index->page_len);
6555 data_used += page_index->page_len;
6562 data_used = header_len;
6564 for (i = 0; i < CTL_NUM_MODE_PAGES; i++) {
6565 struct ctl_page_index *page_index;
6567 page_index = &lun->mode_pages.index[i];
6569 /* Look for the right page code */
6570 if ((page_index->page_code & SMPH_PC_MASK) != page_code)
6573 /* Look for the right subpage or the subpage wildcard*/
6574 if ((page_index->subpage != subpage)
6575 && (subpage != SMS_SUBPAGE_ALL))
6578 /* Make sure the page is supported for this dev type */
6579 if (lun->be_lun->lun_type == T_DIRECT &&
6580 (page_index->page_flags & CTL_PAGE_FLAG_DIRECT) == 0)
6582 if (lun->be_lun->lun_type == T_PROCESSOR &&
6583 (page_index->page_flags & CTL_PAGE_FLAG_PROC) == 0)
6585 if (lun->be_lun->lun_type == T_CDROM &&
6586 (page_index->page_flags & CTL_PAGE_FLAG_CDROM) == 0)
6590 * Call the handler, if it exists, to update the
6591 * page to the latest values.
6593 if (page_index->sense_handler != NULL)
6594 page_index->sense_handler(ctsio, page_index,pc);
6596 memcpy(ctsio->kern_data_ptr + data_used,
6597 page_index->page_data +
6598 (page_index->page_len * pc),
6599 page_index->page_len);
6600 data_used += page_index->page_len;
6606 ctl_set_success(ctsio);
6607 ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
6608 ctsio->be_move_done = ctl_config_move_done;
6609 ctl_datamove((union ctl_io *)ctsio);
6610 return (CTL_RETVAL_COMPLETE);
6614 ctl_lbp_log_sense_handler(struct ctl_scsiio *ctsio,
6615 struct ctl_page_index *page_index,
6618 struct ctl_lun *lun;
6619 struct scsi_log_param_header *phdr;
6623 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
6624 data = page_index->page_data;
6626 if (lun->backend->lun_attr != NULL &&
6627 (val = lun->backend->lun_attr(lun->be_lun->be_lun, "blocksavail"))
6629 phdr = (struct scsi_log_param_header *)data;
6630 scsi_ulto2b(0x0001, phdr->param_code);
6631 phdr->param_control = SLP_LBIN | SLP_LP;
6632 phdr->param_len = 8;
6633 data = (uint8_t *)(phdr + 1);
6634 scsi_ulto4b(val >> CTL_LBP_EXPONENT, data);
6635 data[4] = 0x02; /* per-pool */
6636 data += phdr->param_len;
6639 if (lun->backend->lun_attr != NULL &&
6640 (val = lun->backend->lun_attr(lun->be_lun->be_lun, "blocksused"))
6642 phdr = (struct scsi_log_param_header *)data;
6643 scsi_ulto2b(0x0002, phdr->param_code);
6644 phdr->param_control = SLP_LBIN | SLP_LP;
6645 phdr->param_len = 8;
6646 data = (uint8_t *)(phdr + 1);
6647 scsi_ulto4b(val >> CTL_LBP_EXPONENT, data);
6648 data[4] = 0x01; /* per-LUN */
6649 data += phdr->param_len;
6652 if (lun->backend->lun_attr != NULL &&
6653 (val = lun->backend->lun_attr(lun->be_lun->be_lun, "poolblocksavail"))
6655 phdr = (struct scsi_log_param_header *)data;
6656 scsi_ulto2b(0x00f1, phdr->param_code);
6657 phdr->param_control = SLP_LBIN | SLP_LP;
6658 phdr->param_len = 8;
6659 data = (uint8_t *)(phdr + 1);
6660 scsi_ulto4b(val >> CTL_LBP_EXPONENT, data);
6661 data[4] = 0x02; /* per-pool */
6662 data += phdr->param_len;
6665 if (lun->backend->lun_attr != NULL &&
6666 (val = lun->backend->lun_attr(lun->be_lun->be_lun, "poolblocksused"))
6668 phdr = (struct scsi_log_param_header *)data;
6669 scsi_ulto2b(0x00f2, phdr->param_code);
6670 phdr->param_control = SLP_LBIN | SLP_LP;
6671 phdr->param_len = 8;
6672 data = (uint8_t *)(phdr + 1);
6673 scsi_ulto4b(val >> CTL_LBP_EXPONENT, data);
6674 data[4] = 0x02; /* per-pool */
6675 data += phdr->param_len;
6678 page_index->page_len = data - page_index->page_data;
6683 ctl_sap_log_sense_handler(struct ctl_scsiio *ctsio,
6684 struct ctl_page_index *page_index,
6687 struct ctl_lun *lun;
6688 struct stat_page *data;
6689 uint64_t rn, wn, rb, wb;
6690 struct bintime rt, wt;
6693 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
6694 data = (struct stat_page *)page_index->page_data;
6696 scsi_ulto2b(SLP_SAP, data->sap.hdr.param_code);
6697 data->sap.hdr.param_control = SLP_LBIN;
6698 data->sap.hdr.param_len = sizeof(struct scsi_log_stat_and_perf) -
6699 sizeof(struct scsi_log_param_header);
6700 rn = wn = rb = wb = 0;
6703 for (i = 0; i < CTL_MAX_PORTS; i++) {
6704 rn += lun->stats.ports[i].operations[CTL_STATS_READ];
6705 wn += lun->stats.ports[i].operations[CTL_STATS_WRITE];
6706 rb += lun->stats.ports[i].bytes[CTL_STATS_READ];
6707 wb += lun->stats.ports[i].bytes[CTL_STATS_WRITE];
6708 bintime_add(&rt, &lun->stats.ports[i].time[CTL_STATS_READ]);
6709 bintime_add(&wt, &lun->stats.ports[i].time[CTL_STATS_WRITE]);
6711 scsi_u64to8b(rn, data->sap.read_num);
6712 scsi_u64to8b(wn, data->sap.write_num);
6713 if (lun->stats.blocksize > 0) {
6714 scsi_u64to8b(wb / lun->stats.blocksize,
6715 data->sap.recvieved_lba);
6716 scsi_u64to8b(rb / lun->stats.blocksize,
6717 data->sap.transmitted_lba);
6719 scsi_u64to8b((uint64_t)rt.sec * 1000 + rt.frac / (UINT64_MAX / 1000),
6720 data->sap.read_int);
6721 scsi_u64to8b((uint64_t)wt.sec * 1000 + wt.frac / (UINT64_MAX / 1000),
6722 data->sap.write_int);
6723 scsi_u64to8b(0, data->sap.weighted_num);
6724 scsi_u64to8b(0, data->sap.weighted_int);
6725 scsi_ulto2b(SLP_IT, data->it.hdr.param_code);
6726 data->it.hdr.param_control = SLP_LBIN;
6727 data->it.hdr.param_len = sizeof(struct scsi_log_idle_time) -
6728 sizeof(struct scsi_log_param_header);
6730 scsi_u64to8b(lun->idle_time / SBT_1MS, data->it.idle_int);
6732 scsi_ulto2b(SLP_TI, data->ti.hdr.param_code);
6733 data->it.hdr.param_control = SLP_LBIN;
6734 data->ti.hdr.param_len = sizeof(struct scsi_log_time_interval) -
6735 sizeof(struct scsi_log_param_header);
6736 scsi_ulto4b(3, data->ti.exponent);
6737 scsi_ulto4b(1, data->ti.integer);
6742 ctl_ie_log_sense_handler(struct ctl_scsiio *ctsio,
6743 struct ctl_page_index *page_index,
6746 struct ctl_lun *lun;
6747 struct scsi_log_informational_exceptions *data;
6749 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
6750 data = (struct scsi_log_informational_exceptions *)page_index->page_data;
6752 scsi_ulto2b(SLP_IE_GEN, data->hdr.param_code);
6753 data->hdr.param_control = SLP_LBIN;
6754 data->hdr.param_len = sizeof(struct scsi_log_informational_exceptions) -
6755 sizeof(struct scsi_log_param_header);
6756 data->ie_asc = lun->ie_asc;
6757 data->ie_ascq = lun->ie_ascq;
6758 data->temperature = 0xff;
6763 ctl_log_sense(struct ctl_scsiio *ctsio)
6765 struct ctl_lun *lun;
6766 int i, pc, page_code, subpage;
6767 int alloc_len, total_len;
6768 struct ctl_page_index *page_index;
6769 struct scsi_log_sense *cdb;
6770 struct scsi_log_header *header;
6772 CTL_DEBUG_PRINT(("ctl_log_sense\n"));
6774 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
6775 cdb = (struct scsi_log_sense *)ctsio->cdb;
6776 pc = (cdb->page & SLS_PAGE_CTRL_MASK) >> 6;
6777 page_code = cdb->page & SLS_PAGE_CODE;
6778 subpage = cdb->subpage;
6779 alloc_len = scsi_2btoul(cdb->length);
6782 for (i = 0; i < CTL_NUM_LOG_PAGES; i++) {
6783 page_index = &lun->log_pages.index[i];
6785 /* Look for the right page code */
6786 if ((page_index->page_code & SL_PAGE_CODE) != page_code)
6789 /* Look for the right subpage or the subpage wildcard*/
6790 if (page_index->subpage != subpage)
6795 if (i >= CTL_NUM_LOG_PAGES) {
6796 ctl_set_invalid_field(ctsio,
6802 ctl_done((union ctl_io *)ctsio);
6803 return (CTL_RETVAL_COMPLETE);
6806 total_len = sizeof(struct scsi_log_header) + page_index->page_len;
6808 ctsio->kern_data_ptr = malloc(total_len, M_CTL, M_WAITOK | M_ZERO);
6809 ctsio->kern_sg_entries = 0;
6810 ctsio->kern_data_resid = 0;
6811 ctsio->kern_rel_offset = 0;
6812 if (total_len < alloc_len) {
6813 ctsio->residual = alloc_len - total_len;
6814 ctsio->kern_data_len = total_len;
6815 ctsio->kern_total_len = total_len;
6817 ctsio->residual = 0;
6818 ctsio->kern_data_len = alloc_len;
6819 ctsio->kern_total_len = alloc_len;
6822 header = (struct scsi_log_header *)ctsio->kern_data_ptr;
6823 header->page = page_index->page_code;
6824 if (page_index->page_code == SLS_LOGICAL_BLOCK_PROVISIONING)
6825 header->page |= SL_DS;
6826 if (page_index->subpage) {
6827 header->page |= SL_SPF;
6828 header->subpage = page_index->subpage;
6830 scsi_ulto2b(page_index->page_len, header->datalen);
6833 * Call the handler, if it exists, to update the
6834 * page to the latest values.
6836 if (page_index->sense_handler != NULL)
6837 page_index->sense_handler(ctsio, page_index, pc);
6839 memcpy(header + 1, page_index->page_data, page_index->page_len);
6841 ctl_set_success(ctsio);
6842 ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
6843 ctsio->be_move_done = ctl_config_move_done;
6844 ctl_datamove((union ctl_io *)ctsio);
6845 return (CTL_RETVAL_COMPLETE);
6849 ctl_read_capacity(struct ctl_scsiio *ctsio)
6851 struct scsi_read_capacity *cdb;
6852 struct scsi_read_capacity_data *data;
6853 struct ctl_lun *lun;
6856 CTL_DEBUG_PRINT(("ctl_read_capacity\n"));
6858 cdb = (struct scsi_read_capacity *)ctsio->cdb;
6860 lba = scsi_4btoul(cdb->addr);
6861 if (((cdb->pmi & SRC_PMI) == 0)
6863 ctl_set_invalid_field(/*ctsio*/ ctsio,
6869 ctl_done((union ctl_io *)ctsio);
6870 return (CTL_RETVAL_COMPLETE);
6873 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
6875 ctsio->kern_data_ptr = malloc(sizeof(*data), M_CTL, M_WAITOK | M_ZERO);
6876 data = (struct scsi_read_capacity_data *)ctsio->kern_data_ptr;
6877 ctsio->residual = 0;
6878 ctsio->kern_data_len = sizeof(*data);
6879 ctsio->kern_total_len = sizeof(*data);
6880 ctsio->kern_data_resid = 0;
6881 ctsio->kern_rel_offset = 0;
6882 ctsio->kern_sg_entries = 0;
6885 * If the maximum LBA is greater than 0xfffffffe, the user must
6886 * issue a SERVICE ACTION IN (16) command, with the read capacity
6887 * serivce action set.
6889 if (lun->be_lun->maxlba > 0xfffffffe)
6890 scsi_ulto4b(0xffffffff, data->addr);
6892 scsi_ulto4b(lun->be_lun->maxlba, data->addr);
6895 * XXX KDM this may not be 512 bytes...
6897 scsi_ulto4b(lun->be_lun->blocksize, data->length);
6899 ctl_set_success(ctsio);
6900 ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
6901 ctsio->be_move_done = ctl_config_move_done;
6902 ctl_datamove((union ctl_io *)ctsio);
6903 return (CTL_RETVAL_COMPLETE);
6907 ctl_read_capacity_16(struct ctl_scsiio *ctsio)
6909 struct scsi_read_capacity_16 *cdb;
6910 struct scsi_read_capacity_data_long *data;
6911 struct ctl_lun *lun;
6915 CTL_DEBUG_PRINT(("ctl_read_capacity_16\n"));
6917 cdb = (struct scsi_read_capacity_16 *)ctsio->cdb;
6919 alloc_len = scsi_4btoul(cdb->alloc_len);
6920 lba = scsi_8btou64(cdb->addr);
6922 if ((cdb->reladr & SRC16_PMI)
6924 ctl_set_invalid_field(/*ctsio*/ ctsio,
6930 ctl_done((union ctl_io *)ctsio);
6931 return (CTL_RETVAL_COMPLETE);
6934 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
6936 ctsio->kern_data_ptr = malloc(sizeof(*data), M_CTL, M_WAITOK | M_ZERO);
6937 data = (struct scsi_read_capacity_data_long *)ctsio->kern_data_ptr;
6939 if (sizeof(*data) < alloc_len) {
6940 ctsio->residual = alloc_len - sizeof(*data);
6941 ctsio->kern_data_len = sizeof(*data);
6942 ctsio->kern_total_len = sizeof(*data);
6944 ctsio->residual = 0;
6945 ctsio->kern_data_len = alloc_len;
6946 ctsio->kern_total_len = alloc_len;
6948 ctsio->kern_data_resid = 0;
6949 ctsio->kern_rel_offset = 0;
6950 ctsio->kern_sg_entries = 0;
6952 scsi_u64to8b(lun->be_lun->maxlba, data->addr);
6953 /* XXX KDM this may not be 512 bytes... */
6954 scsi_ulto4b(lun->be_lun->blocksize, data->length);
6955 data->prot_lbppbe = lun->be_lun->pblockexp & SRC16_LBPPBE;
6956 scsi_ulto2b(lun->be_lun->pblockoff & SRC16_LALBA_A, data->lalba_lbp);
6957 if (lun->be_lun->flags & CTL_LUN_FLAG_UNMAP)
6958 data->lalba_lbp[0] |= SRC16_LBPME | SRC16_LBPRZ;
6960 ctl_set_success(ctsio);
6961 ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
6962 ctsio->be_move_done = ctl_config_move_done;
6963 ctl_datamove((union ctl_io *)ctsio);
6964 return (CTL_RETVAL_COMPLETE);
6968 ctl_get_lba_status(struct ctl_scsiio *ctsio)
6970 struct scsi_get_lba_status *cdb;
6971 struct scsi_get_lba_status_data *data;
6972 struct ctl_lun *lun;
6973 struct ctl_lba_len_flags *lbalen;
6975 uint32_t alloc_len, total_len;
6978 CTL_DEBUG_PRINT(("ctl_get_lba_status\n"));
6980 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
6981 cdb = (struct scsi_get_lba_status *)ctsio->cdb;
6982 lba = scsi_8btou64(cdb->addr);
6983 alloc_len = scsi_4btoul(cdb->alloc_len);
6985 if (lba > lun->be_lun->maxlba) {
6986 ctl_set_lba_out_of_range(ctsio, lba);
6987 ctl_done((union ctl_io *)ctsio);
6988 return (CTL_RETVAL_COMPLETE);
6991 total_len = sizeof(*data) + sizeof(data->descr[0]);
6992 ctsio->kern_data_ptr = malloc(total_len, M_CTL, M_WAITOK | M_ZERO);
6993 data = (struct scsi_get_lba_status_data *)ctsio->kern_data_ptr;
6995 if (total_len < alloc_len) {
6996 ctsio->residual = alloc_len - total_len;
6997 ctsio->kern_data_len = total_len;
6998 ctsio->kern_total_len = total_len;
7000 ctsio->residual = 0;
7001 ctsio->kern_data_len = alloc_len;
7002 ctsio->kern_total_len = alloc_len;
7004 ctsio->kern_data_resid = 0;
7005 ctsio->kern_rel_offset = 0;
7006 ctsio->kern_sg_entries = 0;
7008 /* Fill dummy data in case backend can't tell anything. */
7009 scsi_ulto4b(4 + sizeof(data->descr[0]), data->length);
7010 scsi_u64to8b(lba, data->descr[0].addr);
7011 scsi_ulto4b(MIN(UINT32_MAX, lun->be_lun->maxlba + 1 - lba),
7012 data->descr[0].length);
7013 data->descr[0].status = 0; /* Mapped or unknown. */
7015 ctl_set_success(ctsio);
7016 ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
7017 ctsio->be_move_done = ctl_config_move_done;
7019 lbalen = (struct ctl_lba_len_flags *)&ctsio->io_hdr.ctl_private[CTL_PRIV_LBA_LEN];
7021 lbalen->len = total_len;
7023 retval = lun->backend->config_read((union ctl_io *)ctsio);
7024 return (CTL_RETVAL_COMPLETE);
7028 ctl_read_defect(struct ctl_scsiio *ctsio)
7030 struct scsi_read_defect_data_10 *ccb10;
7031 struct scsi_read_defect_data_12 *ccb12;
7032 struct scsi_read_defect_data_hdr_10 *data10;
7033 struct scsi_read_defect_data_hdr_12 *data12;
7034 uint32_t alloc_len, data_len;
7037 CTL_DEBUG_PRINT(("ctl_read_defect\n"));
7039 if (ctsio->cdb[0] == READ_DEFECT_DATA_10) {
7040 ccb10 = (struct scsi_read_defect_data_10 *)&ctsio->cdb;
7041 format = ccb10->format;
7042 alloc_len = scsi_2btoul(ccb10->alloc_length);
7043 data_len = sizeof(*data10);
7045 ccb12 = (struct scsi_read_defect_data_12 *)&ctsio->cdb;
7046 format = ccb12->format;
7047 alloc_len = scsi_4btoul(ccb12->alloc_length);
7048 data_len = sizeof(*data12);
7050 if (alloc_len == 0) {
7051 ctl_set_success(ctsio);
7052 ctl_done((union ctl_io *)ctsio);
7053 return (CTL_RETVAL_COMPLETE);
7056 ctsio->kern_data_ptr = malloc(data_len, M_CTL, M_WAITOK | M_ZERO);
7057 if (data_len < alloc_len) {
7058 ctsio->residual = alloc_len - data_len;
7059 ctsio->kern_data_len = data_len;
7060 ctsio->kern_total_len = data_len;
7062 ctsio->residual = 0;
7063 ctsio->kern_data_len = alloc_len;
7064 ctsio->kern_total_len = alloc_len;
7066 ctsio->kern_data_resid = 0;
7067 ctsio->kern_rel_offset = 0;
7068 ctsio->kern_sg_entries = 0;
7070 if (ctsio->cdb[0] == READ_DEFECT_DATA_10) {
7071 data10 = (struct scsi_read_defect_data_hdr_10 *)
7072 ctsio->kern_data_ptr;
7073 data10->format = format;
7074 scsi_ulto2b(0, data10->length);
7076 data12 = (struct scsi_read_defect_data_hdr_12 *)
7077 ctsio->kern_data_ptr;
7078 data12->format = format;
7079 scsi_ulto2b(0, data12->generation);
7080 scsi_ulto4b(0, data12->length);
7083 ctl_set_success(ctsio);
7084 ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
7085 ctsio->be_move_done = ctl_config_move_done;
7086 ctl_datamove((union ctl_io *)ctsio);
7087 return (CTL_RETVAL_COMPLETE);
7091 ctl_report_tagret_port_groups(struct ctl_scsiio *ctsio)
7093 struct scsi_maintenance_in *cdb;
7095 int alloc_len, ext, total_len = 0, g, pc, pg, ts, os;
7096 int num_ha_groups, num_target_ports, shared_group;
7097 struct ctl_lun *lun;
7098 struct ctl_softc *softc;
7099 struct ctl_port *port;
7100 struct scsi_target_group_data *rtg_ptr;
7101 struct scsi_target_group_data_extended *rtg_ext_ptr;
7102 struct scsi_target_port_group_descriptor *tpg_desc;
7104 CTL_DEBUG_PRINT(("ctl_report_tagret_port_groups\n"));
7106 cdb = (struct scsi_maintenance_in *)ctsio->cdb;
7107 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
7108 softc = lun->ctl_softc;
7110 retval = CTL_RETVAL_COMPLETE;
7112 switch (cdb->byte2 & STG_PDF_MASK) {
7113 case STG_PDF_LENGTH:
7116 case STG_PDF_EXTENDED:
7120 ctl_set_invalid_field(/*ctsio*/ ctsio,
7126 ctl_done((union ctl_io *)ctsio);
7130 num_target_ports = 0;
7131 shared_group = (softc->is_single != 0);
7132 mtx_lock(&softc->ctl_lock);
7133 STAILQ_FOREACH(port, &softc->port_list, links) {
7134 if ((port->status & CTL_PORT_STATUS_ONLINE) == 0)
7136 if (ctl_lun_map_to_port(port, lun->lun) >= CTL_MAX_LUNS)
7139 if (port->status & CTL_PORT_STATUS_HA_SHARED)
7142 mtx_unlock(&softc->ctl_lock);
7143 num_ha_groups = (softc->is_single) ? 0 : NUM_HA_SHELVES;
7146 total_len = sizeof(struct scsi_target_group_data_extended);
7148 total_len = sizeof(struct scsi_target_group_data);
7149 total_len += sizeof(struct scsi_target_port_group_descriptor) *
7150 (shared_group + num_ha_groups) +
7151 sizeof(struct scsi_target_port_descriptor) * num_target_ports;
7153 alloc_len = scsi_4btoul(cdb->length);
7155 ctsio->kern_data_ptr = malloc(total_len, M_CTL, M_WAITOK | M_ZERO);
7157 ctsio->kern_sg_entries = 0;
7159 if (total_len < alloc_len) {
7160 ctsio->residual = alloc_len - total_len;
7161 ctsio->kern_data_len = total_len;
7162 ctsio->kern_total_len = total_len;
7164 ctsio->residual = 0;
7165 ctsio->kern_data_len = alloc_len;
7166 ctsio->kern_total_len = alloc_len;
7168 ctsio->kern_data_resid = 0;
7169 ctsio->kern_rel_offset = 0;
7172 rtg_ext_ptr = (struct scsi_target_group_data_extended *)
7173 ctsio->kern_data_ptr;
7174 scsi_ulto4b(total_len - 4, rtg_ext_ptr->length);
7175 rtg_ext_ptr->format_type = 0x10;
7176 rtg_ext_ptr->implicit_transition_time = 0;
7177 tpg_desc = &rtg_ext_ptr->groups[0];
7179 rtg_ptr = (struct scsi_target_group_data *)
7180 ctsio->kern_data_ptr;
7181 scsi_ulto4b(total_len - 4, rtg_ptr->length);
7182 tpg_desc = &rtg_ptr->groups[0];
7185 mtx_lock(&softc->ctl_lock);
7186 pg = softc->port_min / softc->port_cnt;
7187 if (lun->flags & (CTL_LUN_PRIMARY_SC | CTL_LUN_PEER_SC_PRIMARY)) {
7188 /* Some shelf is known to be primary. */
7189 if (softc->ha_link == CTL_HA_LINK_OFFLINE)
7190 os = TPG_ASYMMETRIC_ACCESS_UNAVAILABLE;
7191 else if (softc->ha_link == CTL_HA_LINK_UNKNOWN)
7192 os = TPG_ASYMMETRIC_ACCESS_TRANSITIONING;
7193 else if (softc->ha_mode == CTL_HA_MODE_ACT_STBY)
7194 os = TPG_ASYMMETRIC_ACCESS_STANDBY;
7196 os = TPG_ASYMMETRIC_ACCESS_NONOPTIMIZED;
7197 if (lun->flags & CTL_LUN_PRIMARY_SC) {
7198 ts = TPG_ASYMMETRIC_ACCESS_OPTIMIZED;
7201 os = TPG_ASYMMETRIC_ACCESS_OPTIMIZED;
7204 /* No known primary shelf. */
7205 if (softc->ha_link == CTL_HA_LINK_OFFLINE) {
7206 ts = TPG_ASYMMETRIC_ACCESS_UNAVAILABLE;
7207 os = TPG_ASYMMETRIC_ACCESS_OPTIMIZED;
7208 } else if (softc->ha_link == CTL_HA_LINK_UNKNOWN) {
7209 ts = TPG_ASYMMETRIC_ACCESS_TRANSITIONING;
7210 os = TPG_ASYMMETRIC_ACCESS_OPTIMIZED;
7212 ts = os = TPG_ASYMMETRIC_ACCESS_TRANSITIONING;
7216 tpg_desc->pref_state = ts;
7217 tpg_desc->support = TPG_AO_SUP | TPG_AN_SUP | TPG_S_SUP |
7218 TPG_U_SUP | TPG_T_SUP;
7219 scsi_ulto2b(1, tpg_desc->target_port_group);
7220 tpg_desc->status = TPG_IMPLICIT;
7222 STAILQ_FOREACH(port, &softc->port_list, links) {
7223 if ((port->status & CTL_PORT_STATUS_ONLINE) == 0)
7225 if (!softc->is_single &&
7226 (port->status & CTL_PORT_STATUS_HA_SHARED) == 0)
7228 if (ctl_lun_map_to_port(port, lun->lun) >= CTL_MAX_LUNS)
7230 scsi_ulto2b(port->targ_port, tpg_desc->descriptors[pc].
7231 relative_target_port_identifier);
7234 tpg_desc->target_port_count = pc;
7235 tpg_desc = (struct scsi_target_port_group_descriptor *)
7236 &tpg_desc->descriptors[pc];
7238 for (g = 0; g < num_ha_groups; g++) {
7239 tpg_desc->pref_state = (g == pg) ? ts : os;
7240 tpg_desc->support = TPG_AO_SUP | TPG_AN_SUP | TPG_S_SUP |
7241 TPG_U_SUP | TPG_T_SUP;
7242 scsi_ulto2b(2 + g, tpg_desc->target_port_group);
7243 tpg_desc->status = TPG_IMPLICIT;
7245 STAILQ_FOREACH(port, &softc->port_list, links) {
7246 if (port->targ_port < g * softc->port_cnt ||
7247 port->targ_port >= (g + 1) * softc->port_cnt)
7249 if ((port->status & CTL_PORT_STATUS_ONLINE) == 0)
7251 if (port->status & CTL_PORT_STATUS_HA_SHARED)
7253 if (ctl_lun_map_to_port(port, lun->lun) >= CTL_MAX_LUNS)
7255 scsi_ulto2b(port->targ_port, tpg_desc->descriptors[pc].
7256 relative_target_port_identifier);
7259 tpg_desc->target_port_count = pc;
7260 tpg_desc = (struct scsi_target_port_group_descriptor *)
7261 &tpg_desc->descriptors[pc];
7263 mtx_unlock(&softc->ctl_lock);
7265 ctl_set_success(ctsio);
7266 ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
7267 ctsio->be_move_done = ctl_config_move_done;
7268 ctl_datamove((union ctl_io *)ctsio);
7273 ctl_report_supported_opcodes(struct ctl_scsiio *ctsio)
7275 struct ctl_lun *lun;
7276 struct scsi_report_supported_opcodes *cdb;
7277 const struct ctl_cmd_entry *entry, *sentry;
7278 struct scsi_report_supported_opcodes_all *all;
7279 struct scsi_report_supported_opcodes_descr *descr;
7280 struct scsi_report_supported_opcodes_one *one;
7282 int alloc_len, total_len;
7283 int opcode, service_action, i, j, num;
7285 CTL_DEBUG_PRINT(("ctl_report_supported_opcodes\n"));
7287 cdb = (struct scsi_report_supported_opcodes *)ctsio->cdb;
7288 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
7290 retval = CTL_RETVAL_COMPLETE;
7292 opcode = cdb->requested_opcode;
7293 service_action = scsi_2btoul(cdb->requested_service_action);
7294 switch (cdb->options & RSO_OPTIONS_MASK) {
7295 case RSO_OPTIONS_ALL:
7297 for (i = 0; i < 256; i++) {
7298 entry = &ctl_cmd_table[i];
7299 if (entry->flags & CTL_CMD_FLAG_SA5) {
7300 for (j = 0; j < 32; j++) {
7301 sentry = &((const struct ctl_cmd_entry *)
7303 if (ctl_cmd_applicable(
7304 lun->be_lun->lun_type, sentry))
7308 if (ctl_cmd_applicable(lun->be_lun->lun_type,
7313 total_len = sizeof(struct scsi_report_supported_opcodes_all) +
7314 num * sizeof(struct scsi_report_supported_opcodes_descr);
7316 case RSO_OPTIONS_OC:
7317 if (ctl_cmd_table[opcode].flags & CTL_CMD_FLAG_SA5) {
7318 ctl_set_invalid_field(/*ctsio*/ ctsio,
7324 ctl_done((union ctl_io *)ctsio);
7325 return (CTL_RETVAL_COMPLETE);
7327 total_len = sizeof(struct scsi_report_supported_opcodes_one) + 32;
7329 case RSO_OPTIONS_OC_SA:
7330 if ((ctl_cmd_table[opcode].flags & CTL_CMD_FLAG_SA5) == 0 ||
7331 service_action >= 32) {
7332 ctl_set_invalid_field(/*ctsio*/ ctsio,
7338 ctl_done((union ctl_io *)ctsio);
7339 return (CTL_RETVAL_COMPLETE);
7342 case RSO_OPTIONS_OC_ASA:
7343 total_len = sizeof(struct scsi_report_supported_opcodes_one) + 32;
7346 ctl_set_invalid_field(/*ctsio*/ ctsio,
7352 ctl_done((union ctl_io *)ctsio);
7353 return (CTL_RETVAL_COMPLETE);
7356 alloc_len = scsi_4btoul(cdb->length);
7358 ctsio->kern_data_ptr = malloc(total_len, M_CTL, M_WAITOK | M_ZERO);
7360 ctsio->kern_sg_entries = 0;
7362 if (total_len < alloc_len) {
7363 ctsio->residual = alloc_len - total_len;
7364 ctsio->kern_data_len = total_len;
7365 ctsio->kern_total_len = total_len;
7367 ctsio->residual = 0;
7368 ctsio->kern_data_len = alloc_len;
7369 ctsio->kern_total_len = alloc_len;
7371 ctsio->kern_data_resid = 0;
7372 ctsio->kern_rel_offset = 0;
7374 switch (cdb->options & RSO_OPTIONS_MASK) {
7375 case RSO_OPTIONS_ALL:
7376 all = (struct scsi_report_supported_opcodes_all *)
7377 ctsio->kern_data_ptr;
7379 for (i = 0; i < 256; i++) {
7380 entry = &ctl_cmd_table[i];
7381 if (entry->flags & CTL_CMD_FLAG_SA5) {
7382 for (j = 0; j < 32; j++) {
7383 sentry = &((const struct ctl_cmd_entry *)
7385 if (!ctl_cmd_applicable(
7386 lun->be_lun->lun_type, sentry))
7388 descr = &all->descr[num++];
7390 scsi_ulto2b(j, descr->service_action);
7391 descr->flags = RSO_SERVACTV;
7392 scsi_ulto2b(sentry->length,
7396 if (!ctl_cmd_applicable(lun->be_lun->lun_type,
7399 descr = &all->descr[num++];
7401 scsi_ulto2b(0, descr->service_action);
7403 scsi_ulto2b(entry->length, descr->cdb_length);
7407 num * sizeof(struct scsi_report_supported_opcodes_descr),
7410 case RSO_OPTIONS_OC:
7411 one = (struct scsi_report_supported_opcodes_one *)
7412 ctsio->kern_data_ptr;
7413 entry = &ctl_cmd_table[opcode];
7415 case RSO_OPTIONS_OC_SA:
7416 one = (struct scsi_report_supported_opcodes_one *)
7417 ctsio->kern_data_ptr;
7418 entry = &ctl_cmd_table[opcode];
7419 entry = &((const struct ctl_cmd_entry *)
7420 entry->execute)[service_action];
7422 if (ctl_cmd_applicable(lun->be_lun->lun_type, entry)) {
7424 scsi_ulto2b(entry->length, one->cdb_length);
7425 one->cdb_usage[0] = opcode;
7426 memcpy(&one->cdb_usage[1], entry->usage,
7431 case RSO_OPTIONS_OC_ASA:
7432 one = (struct scsi_report_supported_opcodes_one *)
7433 ctsio->kern_data_ptr;
7434 entry = &ctl_cmd_table[opcode];
7435 if (entry->flags & CTL_CMD_FLAG_SA5) {
7436 entry = &((const struct ctl_cmd_entry *)
7437 entry->execute)[service_action];
7438 } else if (service_action != 0) {
7445 ctl_set_success(ctsio);
7446 ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
7447 ctsio->be_move_done = ctl_config_move_done;
7448 ctl_datamove((union ctl_io *)ctsio);
7453 ctl_report_supported_tmf(struct ctl_scsiio *ctsio)
7455 struct scsi_report_supported_tmf *cdb;
7456 struct scsi_report_supported_tmf_data *data;
7458 int alloc_len, total_len;
7460 CTL_DEBUG_PRINT(("ctl_report_supported_tmf\n"));
7462 cdb = (struct scsi_report_supported_tmf *)ctsio->cdb;
7464 retval = CTL_RETVAL_COMPLETE;
7466 total_len = sizeof(struct scsi_report_supported_tmf_data);
7467 alloc_len = scsi_4btoul(cdb->length);
7469 ctsio->kern_data_ptr = malloc(total_len, M_CTL, M_WAITOK | M_ZERO);
7471 ctsio->kern_sg_entries = 0;
7473 if (total_len < alloc_len) {
7474 ctsio->residual = alloc_len - total_len;
7475 ctsio->kern_data_len = total_len;
7476 ctsio->kern_total_len = total_len;
7478 ctsio->residual = 0;
7479 ctsio->kern_data_len = alloc_len;
7480 ctsio->kern_total_len = alloc_len;
7482 ctsio->kern_data_resid = 0;
7483 ctsio->kern_rel_offset = 0;
7485 data = (struct scsi_report_supported_tmf_data *)ctsio->kern_data_ptr;
7486 data->byte1 |= RST_ATS | RST_ATSS | RST_CTSS | RST_LURS | RST_QTS |
7488 data->byte2 |= RST_QAES | RST_QTSS | RST_ITNRS;
7490 ctl_set_success(ctsio);
7491 ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
7492 ctsio->be_move_done = ctl_config_move_done;
7493 ctl_datamove((union ctl_io *)ctsio);
7498 ctl_report_timestamp(struct ctl_scsiio *ctsio)
7500 struct scsi_report_timestamp *cdb;
7501 struct scsi_report_timestamp_data *data;
7505 int alloc_len, total_len;
7507 CTL_DEBUG_PRINT(("ctl_report_timestamp\n"));
7509 cdb = (struct scsi_report_timestamp *)ctsio->cdb;
7511 retval = CTL_RETVAL_COMPLETE;
7513 total_len = sizeof(struct scsi_report_timestamp_data);
7514 alloc_len = scsi_4btoul(cdb->length);
7516 ctsio->kern_data_ptr = malloc(total_len, M_CTL, M_WAITOK | M_ZERO);
7518 ctsio->kern_sg_entries = 0;
7520 if (total_len < alloc_len) {
7521 ctsio->residual = alloc_len - total_len;
7522 ctsio->kern_data_len = total_len;
7523 ctsio->kern_total_len = total_len;
7525 ctsio->residual = 0;
7526 ctsio->kern_data_len = alloc_len;
7527 ctsio->kern_total_len = alloc_len;
7529 ctsio->kern_data_resid = 0;
7530 ctsio->kern_rel_offset = 0;
7532 data = (struct scsi_report_timestamp_data *)ctsio->kern_data_ptr;
7533 scsi_ulto2b(sizeof(*data) - 2, data->length);
7534 data->origin = RTS_ORIG_OUTSIDE;
7536 timestamp = (int64_t)tv.tv_sec * 1000 + tv.tv_usec / 1000;
7537 scsi_ulto4b(timestamp >> 16, data->timestamp);
7538 scsi_ulto2b(timestamp & 0xffff, &data->timestamp[4]);
7540 ctl_set_success(ctsio);
7541 ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
7542 ctsio->be_move_done = ctl_config_move_done;
7543 ctl_datamove((union ctl_io *)ctsio);
7548 ctl_persistent_reserve_in(struct ctl_scsiio *ctsio)
7550 struct scsi_per_res_in *cdb;
7551 int alloc_len, total_len = 0;
7552 /* struct scsi_per_res_in_rsrv in_data; */
7553 struct ctl_lun *lun;
7554 struct ctl_softc *softc;
7557 CTL_DEBUG_PRINT(("ctl_persistent_reserve_in\n"));
7559 cdb = (struct scsi_per_res_in *)ctsio->cdb;
7561 alloc_len = scsi_2btoul(cdb->length);
7563 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
7564 softc = lun->ctl_softc;
7567 mtx_lock(&lun->lun_lock);
7568 switch (cdb->action) {
7569 case SPRI_RK: /* read keys */
7570 total_len = sizeof(struct scsi_per_res_in_keys) +
7572 sizeof(struct scsi_per_res_key);
7574 case SPRI_RR: /* read reservation */
7575 if (lun->flags & CTL_LUN_PR_RESERVED)
7576 total_len = sizeof(struct scsi_per_res_in_rsrv);
7578 total_len = sizeof(struct scsi_per_res_in_header);
7580 case SPRI_RC: /* report capabilities */
7581 total_len = sizeof(struct scsi_per_res_cap);
7583 case SPRI_RS: /* read full status */
7584 total_len = sizeof(struct scsi_per_res_in_header) +
7585 (sizeof(struct scsi_per_res_in_full_desc) + 256) *
7589 panic("%s: Invalid PR type %#x", __func__, cdb->action);
7591 mtx_unlock(&lun->lun_lock);
7593 ctsio->kern_data_ptr = malloc(total_len, M_CTL, M_WAITOK | M_ZERO);
7595 if (total_len < alloc_len) {
7596 ctsio->residual = alloc_len - total_len;
7597 ctsio->kern_data_len = total_len;
7598 ctsio->kern_total_len = total_len;
7600 ctsio->residual = 0;
7601 ctsio->kern_data_len = alloc_len;
7602 ctsio->kern_total_len = alloc_len;
7605 ctsio->kern_data_resid = 0;
7606 ctsio->kern_rel_offset = 0;
7607 ctsio->kern_sg_entries = 0;
7609 mtx_lock(&lun->lun_lock);
7610 switch (cdb->action) {
7611 case SPRI_RK: { // read keys
7612 struct scsi_per_res_in_keys *res_keys;
7615 res_keys = (struct scsi_per_res_in_keys*)ctsio->kern_data_ptr;
7618 * We had to drop the lock to allocate our buffer, which
7619 * leaves time for someone to come in with another
7620 * persistent reservation. (That is unlikely, though,
7621 * since this should be the only persistent reservation
7622 * command active right now.)
7624 if (total_len != (sizeof(struct scsi_per_res_in_keys) +
7625 (lun->pr_key_count *
7626 sizeof(struct scsi_per_res_key)))){
7627 mtx_unlock(&lun->lun_lock);
7628 free(ctsio->kern_data_ptr, M_CTL);
7629 printf("%s: reservation length changed, retrying\n",
7634 scsi_ulto4b(lun->pr_generation, res_keys->header.generation);
7636 scsi_ulto4b(sizeof(struct scsi_per_res_key) *
7637 lun->pr_key_count, res_keys->header.length);
7639 for (i = 0, key_count = 0; i < CTL_MAX_INITIATORS; i++) {
7640 if ((key = ctl_get_prkey(lun, i)) == 0)
7644 * We used lun->pr_key_count to calculate the
7645 * size to allocate. If it turns out the number of
7646 * initiators with the registered flag set is
7647 * larger than that (i.e. they haven't been kept in
7648 * sync), we've got a problem.
7650 if (key_count >= lun->pr_key_count) {
7654 scsi_u64to8b(key, res_keys->keys[key_count].key);
7659 case SPRI_RR: { // read reservation
7660 struct scsi_per_res_in_rsrv *res;
7661 int tmp_len, header_only;
7663 res = (struct scsi_per_res_in_rsrv *)ctsio->kern_data_ptr;
7665 scsi_ulto4b(lun->pr_generation, res->header.generation);
7667 if (lun->flags & CTL_LUN_PR_RESERVED)
7669 tmp_len = sizeof(struct scsi_per_res_in_rsrv);
7670 scsi_ulto4b(sizeof(struct scsi_per_res_in_rsrv_data),
7671 res->header.length);
7674 tmp_len = sizeof(struct scsi_per_res_in_header);
7675 scsi_ulto4b(0, res->header.length);
7680 * We had to drop the lock to allocate our buffer, which
7681 * leaves time for someone to come in with another
7682 * persistent reservation. (That is unlikely, though,
7683 * since this should be the only persistent reservation
7684 * command active right now.)
7686 if (tmp_len != total_len) {
7687 mtx_unlock(&lun->lun_lock);
7688 free(ctsio->kern_data_ptr, M_CTL);
7689 printf("%s: reservation status changed, retrying\n",
7695 * No reservation held, so we're done.
7697 if (header_only != 0)
7701 * If the registration is an All Registrants type, the key
7702 * is 0, since it doesn't really matter.
7704 if (lun->pr_res_idx != CTL_PR_ALL_REGISTRANTS) {
7705 scsi_u64to8b(ctl_get_prkey(lun, lun->pr_res_idx),
7706 res->data.reservation);
7708 res->data.scopetype = lun->pr_res_type;
7711 case SPRI_RC: //report capabilities
7713 struct scsi_per_res_cap *res_cap;
7716 res_cap = (struct scsi_per_res_cap *)ctsio->kern_data_ptr;
7717 scsi_ulto2b(sizeof(*res_cap), res_cap->length);
7718 res_cap->flags1 = SPRI_CRH;
7719 res_cap->flags2 = SPRI_TMV | SPRI_ALLOW_5;
7720 type_mask = SPRI_TM_WR_EX_AR |
7726 scsi_ulto2b(type_mask, res_cap->type_mask);
7729 case SPRI_RS: { // read full status
7730 struct scsi_per_res_in_full *res_status;
7731 struct scsi_per_res_in_full_desc *res_desc;
7732 struct ctl_port *port;
7735 res_status = (struct scsi_per_res_in_full*)ctsio->kern_data_ptr;
7738 * We had to drop the lock to allocate our buffer, which
7739 * leaves time for someone to come in with another
7740 * persistent reservation. (That is unlikely, though,
7741 * since this should be the only persistent reservation
7742 * command active right now.)
7744 if (total_len < (sizeof(struct scsi_per_res_in_header) +
7745 (sizeof(struct scsi_per_res_in_full_desc) + 256) *
7746 lun->pr_key_count)){
7747 mtx_unlock(&lun->lun_lock);
7748 free(ctsio->kern_data_ptr, M_CTL);
7749 printf("%s: reservation length changed, retrying\n",
7754 scsi_ulto4b(lun->pr_generation, res_status->header.generation);
7756 res_desc = &res_status->desc[0];
7757 for (i = 0; i < CTL_MAX_INITIATORS; i++) {
7758 if ((key = ctl_get_prkey(lun, i)) == 0)
7761 scsi_u64to8b(key, res_desc->res_key.key);
7762 if ((lun->flags & CTL_LUN_PR_RESERVED) &&
7763 (lun->pr_res_idx == i ||
7764 lun->pr_res_idx == CTL_PR_ALL_REGISTRANTS)) {
7765 res_desc->flags = SPRI_FULL_R_HOLDER;
7766 res_desc->scopetype = lun->pr_res_type;
7768 scsi_ulto2b(i / CTL_MAX_INIT_PER_PORT,
7769 res_desc->rel_trgt_port_id);
7771 port = softc->ctl_ports[i / CTL_MAX_INIT_PER_PORT];
7773 len = ctl_create_iid(port,
7774 i % CTL_MAX_INIT_PER_PORT,
7775 res_desc->transport_id);
7776 scsi_ulto4b(len, res_desc->additional_length);
7777 res_desc = (struct scsi_per_res_in_full_desc *)
7778 &res_desc->transport_id[len];
7780 scsi_ulto4b((uint8_t *)res_desc - (uint8_t *)&res_status->desc[0],
7781 res_status->header.length);
7785 panic("%s: Invalid PR type %#x", __func__, cdb->action);
7787 mtx_unlock(&lun->lun_lock);
7789 ctl_set_success(ctsio);
7790 ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
7791 ctsio->be_move_done = ctl_config_move_done;
7792 ctl_datamove((union ctl_io *)ctsio);
7793 return (CTL_RETVAL_COMPLETE);
7797 * Returns 0 if ctl_persistent_reserve_out() should continue, non-zero if
7801 ctl_pro_preempt(struct ctl_softc *softc, struct ctl_lun *lun, uint64_t res_key,
7802 uint64_t sa_res_key, uint8_t type, uint32_t residx,
7803 struct ctl_scsiio *ctsio, struct scsi_per_res_out *cdb,
7804 struct scsi_per_res_out_parms* param)
7806 union ctl_ha_msg persis_io;
7809 mtx_lock(&lun->lun_lock);
7810 if (sa_res_key == 0) {
7811 if (lun->pr_res_idx == CTL_PR_ALL_REGISTRANTS) {
7812 /* validate scope and type */
7813 if ((cdb->scope_type & SPR_SCOPE_MASK) !=
7815 mtx_unlock(&lun->lun_lock);
7816 ctl_set_invalid_field(/*ctsio*/ ctsio,
7822 ctl_done((union ctl_io *)ctsio);
7826 if (type>8 || type==2 || type==4 || type==0) {
7827 mtx_unlock(&lun->lun_lock);
7828 ctl_set_invalid_field(/*ctsio*/ ctsio,
7834 ctl_done((union ctl_io *)ctsio);
7839 * Unregister everybody else and build UA for
7842 for(i = 0; i < CTL_MAX_INITIATORS; i++) {
7843 if (i == residx || ctl_get_prkey(lun, i) == 0)
7846 ctl_clr_prkey(lun, i);
7847 ctl_est_ua(lun, i, CTL_UA_REG_PREEMPT);
7849 lun->pr_key_count = 1;
7850 lun->pr_res_type = type;
7851 if (lun->pr_res_type != SPR_TYPE_WR_EX_AR &&
7852 lun->pr_res_type != SPR_TYPE_EX_AC_AR)
7853 lun->pr_res_idx = residx;
7854 lun->pr_generation++;
7855 mtx_unlock(&lun->lun_lock);
7857 /* send msg to other side */
7858 persis_io.hdr.nexus = ctsio->io_hdr.nexus;
7859 persis_io.hdr.msg_type = CTL_MSG_PERS_ACTION;
7860 persis_io.pr.pr_info.action = CTL_PR_PREEMPT;
7861 persis_io.pr.pr_info.residx = lun->pr_res_idx;
7862 persis_io.pr.pr_info.res_type = type;
7863 memcpy(persis_io.pr.pr_info.sa_res_key,
7864 param->serv_act_res_key,
7865 sizeof(param->serv_act_res_key));
7866 ctl_ha_msg_send(CTL_HA_CHAN_CTL, &persis_io,
7867 sizeof(persis_io.pr), M_WAITOK);
7869 /* not all registrants */
7870 mtx_unlock(&lun->lun_lock);
7871 free(ctsio->kern_data_ptr, M_CTL);
7872 ctl_set_invalid_field(ctsio,
7878 ctl_done((union ctl_io *)ctsio);
7881 } else if (lun->pr_res_idx == CTL_PR_ALL_REGISTRANTS
7882 || !(lun->flags & CTL_LUN_PR_RESERVED)) {
7885 if (res_key == sa_res_key) {
7888 * The spec implies this is not good but doesn't
7889 * say what to do. There are two choices either
7890 * generate a res conflict or check condition
7891 * with illegal field in parameter data. Since
7892 * that is what is done when the sa_res_key is
7893 * zero I'll take that approach since this has
7894 * to do with the sa_res_key.
7896 mtx_unlock(&lun->lun_lock);
7897 free(ctsio->kern_data_ptr, M_CTL);
7898 ctl_set_invalid_field(ctsio,
7904 ctl_done((union ctl_io *)ctsio);
7908 for (i = 0; i < CTL_MAX_INITIATORS; i++) {
7909 if (ctl_get_prkey(lun, i) != sa_res_key)
7913 ctl_clr_prkey(lun, i);
7914 lun->pr_key_count--;
7915 ctl_est_ua(lun, i, CTL_UA_REG_PREEMPT);
7918 mtx_unlock(&lun->lun_lock);
7919 free(ctsio->kern_data_ptr, M_CTL);
7920 ctl_set_reservation_conflict(ctsio);
7921 ctl_done((union ctl_io *)ctsio);
7922 return (CTL_RETVAL_COMPLETE);
7924 lun->pr_generation++;
7925 mtx_unlock(&lun->lun_lock);
7927 /* send msg to other side */
7928 persis_io.hdr.nexus = ctsio->io_hdr.nexus;
7929 persis_io.hdr.msg_type = CTL_MSG_PERS_ACTION;
7930 persis_io.pr.pr_info.action = CTL_PR_PREEMPT;
7931 persis_io.pr.pr_info.residx = lun->pr_res_idx;
7932 persis_io.pr.pr_info.res_type = type;
7933 memcpy(persis_io.pr.pr_info.sa_res_key,
7934 param->serv_act_res_key,
7935 sizeof(param->serv_act_res_key));
7936 ctl_ha_msg_send(CTL_HA_CHAN_CTL, &persis_io,
7937 sizeof(persis_io.pr), M_WAITOK);
7939 /* Reserved but not all registrants */
7940 /* sa_res_key is res holder */
7941 if (sa_res_key == ctl_get_prkey(lun, lun->pr_res_idx)) {
7942 /* validate scope and type */
7943 if ((cdb->scope_type & SPR_SCOPE_MASK) !=
7945 mtx_unlock(&lun->lun_lock);
7946 ctl_set_invalid_field(/*ctsio*/ ctsio,
7952 ctl_done((union ctl_io *)ctsio);
7956 if (type>8 || type==2 || type==4 || type==0) {
7957 mtx_unlock(&lun->lun_lock);
7958 ctl_set_invalid_field(/*ctsio*/ ctsio,
7964 ctl_done((union ctl_io *)ctsio);
7970 * if sa_res_key != res_key remove all
7971 * registrants w/sa_res_key and generate UA
7972 * for these registrants(Registrations
7973 * Preempted) if it wasn't an exclusive
7974 * reservation generate UA(Reservations
7975 * Preempted) for all other registered nexuses
7976 * if the type has changed. Establish the new
7977 * reservation and holder. If res_key and
7978 * sa_res_key are the same do the above
7979 * except don't unregister the res holder.
7982 for(i = 0; i < CTL_MAX_INITIATORS; i++) {
7983 if (i == residx || ctl_get_prkey(lun, i) == 0)
7986 if (sa_res_key == ctl_get_prkey(lun, i)) {
7987 ctl_clr_prkey(lun, i);
7988 lun->pr_key_count--;
7989 ctl_est_ua(lun, i, CTL_UA_REG_PREEMPT);
7990 } else if (type != lun->pr_res_type &&
7991 (lun->pr_res_type == SPR_TYPE_WR_EX_RO ||
7992 lun->pr_res_type == SPR_TYPE_EX_AC_RO)) {
7993 ctl_est_ua(lun, i, CTL_UA_RES_RELEASE);
7996 lun->pr_res_type = type;
7997 if (lun->pr_res_type != SPR_TYPE_WR_EX_AR &&
7998 lun->pr_res_type != SPR_TYPE_EX_AC_AR)
7999 lun->pr_res_idx = residx;
8001 lun->pr_res_idx = CTL_PR_ALL_REGISTRANTS;
8002 lun->pr_generation++;
8003 mtx_unlock(&lun->lun_lock);
8005 persis_io.hdr.nexus = ctsio->io_hdr.nexus;
8006 persis_io.hdr.msg_type = CTL_MSG_PERS_ACTION;
8007 persis_io.pr.pr_info.action = CTL_PR_PREEMPT;
8008 persis_io.pr.pr_info.residx = lun->pr_res_idx;
8009 persis_io.pr.pr_info.res_type = type;
8010 memcpy(persis_io.pr.pr_info.sa_res_key,
8011 param->serv_act_res_key,
8012 sizeof(param->serv_act_res_key));
8013 ctl_ha_msg_send(CTL_HA_CHAN_CTL, &persis_io,
8014 sizeof(persis_io.pr), M_WAITOK);
8017 * sa_res_key is not the res holder just
8018 * remove registrants
8022 for (i = 0; i < CTL_MAX_INITIATORS; i++) {
8023 if (sa_res_key != ctl_get_prkey(lun, i))
8027 ctl_clr_prkey(lun, i);
8028 lun->pr_key_count--;
8029 ctl_est_ua(lun, i, CTL_UA_REG_PREEMPT);
8033 mtx_unlock(&lun->lun_lock);
8034 free(ctsio->kern_data_ptr, M_CTL);
8035 ctl_set_reservation_conflict(ctsio);
8036 ctl_done((union ctl_io *)ctsio);
8039 lun->pr_generation++;
8040 mtx_unlock(&lun->lun_lock);
8042 persis_io.hdr.nexus = ctsio->io_hdr.nexus;
8043 persis_io.hdr.msg_type = CTL_MSG_PERS_ACTION;
8044 persis_io.pr.pr_info.action = CTL_PR_PREEMPT;
8045 persis_io.pr.pr_info.residx = lun->pr_res_idx;
8046 persis_io.pr.pr_info.res_type = type;
8047 memcpy(persis_io.pr.pr_info.sa_res_key,
8048 param->serv_act_res_key,
8049 sizeof(param->serv_act_res_key));
8050 ctl_ha_msg_send(CTL_HA_CHAN_CTL, &persis_io,
8051 sizeof(persis_io.pr), M_WAITOK);
8058 ctl_pro_preempt_other(struct ctl_lun *lun, union ctl_ha_msg *msg)
8060 uint64_t sa_res_key;
8063 sa_res_key = scsi_8btou64(msg->pr.pr_info.sa_res_key);
8065 if (lun->pr_res_idx == CTL_PR_ALL_REGISTRANTS
8066 || lun->pr_res_idx == CTL_PR_NO_RESERVATION
8067 || sa_res_key != ctl_get_prkey(lun, lun->pr_res_idx)) {
8068 if (sa_res_key == 0) {
8070 * Unregister everybody else and build UA for
8073 for(i = 0; i < CTL_MAX_INITIATORS; i++) {
8074 if (i == msg->pr.pr_info.residx ||
8075 ctl_get_prkey(lun, i) == 0)
8078 ctl_clr_prkey(lun, i);
8079 ctl_est_ua(lun, i, CTL_UA_REG_PREEMPT);
8082 lun->pr_key_count = 1;
8083 lun->pr_res_type = msg->pr.pr_info.res_type;
8084 if (lun->pr_res_type != SPR_TYPE_WR_EX_AR &&
8085 lun->pr_res_type != SPR_TYPE_EX_AC_AR)
8086 lun->pr_res_idx = msg->pr.pr_info.residx;
8088 for (i = 0; i < CTL_MAX_INITIATORS; i++) {
8089 if (sa_res_key == ctl_get_prkey(lun, i))
8092 ctl_clr_prkey(lun, i);
8093 lun->pr_key_count--;
8094 ctl_est_ua(lun, i, CTL_UA_REG_PREEMPT);
8098 for (i = 0; i < CTL_MAX_INITIATORS; i++) {
8099 if (i == msg->pr.pr_info.residx ||
8100 ctl_get_prkey(lun, i) == 0)
8103 if (sa_res_key == ctl_get_prkey(lun, i)) {
8104 ctl_clr_prkey(lun, i);
8105 lun->pr_key_count--;
8106 ctl_est_ua(lun, i, CTL_UA_REG_PREEMPT);
8107 } else if (msg->pr.pr_info.res_type != lun->pr_res_type
8108 && (lun->pr_res_type == SPR_TYPE_WR_EX_RO ||
8109 lun->pr_res_type == SPR_TYPE_EX_AC_RO)) {
8110 ctl_est_ua(lun, i, CTL_UA_RES_RELEASE);
8113 lun->pr_res_type = msg->pr.pr_info.res_type;
8114 if (lun->pr_res_type != SPR_TYPE_WR_EX_AR &&
8115 lun->pr_res_type != SPR_TYPE_EX_AC_AR)
8116 lun->pr_res_idx = msg->pr.pr_info.residx;
8118 lun->pr_res_idx = CTL_PR_ALL_REGISTRANTS;
8120 lun->pr_generation++;
8126 ctl_persistent_reserve_out(struct ctl_scsiio *ctsio)
8129 u_int32_t param_len;
8130 struct scsi_per_res_out *cdb;
8131 struct ctl_lun *lun;
8132 struct scsi_per_res_out_parms* param;
8133 struct ctl_softc *softc;
8135 uint64_t res_key, sa_res_key, key;
8137 union ctl_ha_msg persis_io;
8140 CTL_DEBUG_PRINT(("ctl_persistent_reserve_out\n"));
8142 retval = CTL_RETVAL_COMPLETE;
8144 cdb = (struct scsi_per_res_out *)ctsio->cdb;
8145 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
8146 softc = lun->ctl_softc;
8149 * We only support whole-LUN scope. The scope & type are ignored for
8150 * register, register and ignore existing key and clear.
8151 * We sometimes ignore scope and type on preempts too!!
8152 * Verify reservation type here as well.
8154 type = cdb->scope_type & SPR_TYPE_MASK;
8155 if ((cdb->action == SPRO_RESERVE)
8156 || (cdb->action == SPRO_RELEASE)) {
8157 if ((cdb->scope_type & SPR_SCOPE_MASK) != SPR_LU_SCOPE) {
8158 ctl_set_invalid_field(/*ctsio*/ ctsio,
8164 ctl_done((union ctl_io *)ctsio);
8165 return (CTL_RETVAL_COMPLETE);
8168 if (type>8 || type==2 || type==4 || type==0) {
8169 ctl_set_invalid_field(/*ctsio*/ ctsio,
8175 ctl_done((union ctl_io *)ctsio);
8176 return (CTL_RETVAL_COMPLETE);
8180 param_len = scsi_4btoul(cdb->length);
8182 if ((ctsio->io_hdr.flags & CTL_FLAG_ALLOCATED) == 0) {
8183 ctsio->kern_data_ptr = malloc(param_len, M_CTL, M_WAITOK);
8184 ctsio->kern_data_len = param_len;
8185 ctsio->kern_total_len = param_len;
8186 ctsio->kern_data_resid = 0;
8187 ctsio->kern_rel_offset = 0;
8188 ctsio->kern_sg_entries = 0;
8189 ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
8190 ctsio->be_move_done = ctl_config_move_done;
8191 ctl_datamove((union ctl_io *)ctsio);
8193 return (CTL_RETVAL_COMPLETE);
8196 param = (struct scsi_per_res_out_parms *)ctsio->kern_data_ptr;
8198 residx = ctl_get_initindex(&ctsio->io_hdr.nexus);
8199 res_key = scsi_8btou64(param->res_key.key);
8200 sa_res_key = scsi_8btou64(param->serv_act_res_key);
8203 * Validate the reservation key here except for SPRO_REG_IGNO
8204 * This must be done for all other service actions
8206 if ((cdb->action & SPRO_ACTION_MASK) != SPRO_REG_IGNO) {
8207 mtx_lock(&lun->lun_lock);
8208 if ((key = ctl_get_prkey(lun, residx)) != 0) {
8209 if (res_key != key) {
8211 * The current key passed in doesn't match
8212 * the one the initiator previously
8215 mtx_unlock(&lun->lun_lock);
8216 free(ctsio->kern_data_ptr, M_CTL);
8217 ctl_set_reservation_conflict(ctsio);
8218 ctl_done((union ctl_io *)ctsio);
8219 return (CTL_RETVAL_COMPLETE);
8221 } else if ((cdb->action & SPRO_ACTION_MASK) != SPRO_REGISTER) {
8223 * We are not registered
8225 mtx_unlock(&lun->lun_lock);
8226 free(ctsio->kern_data_ptr, M_CTL);
8227 ctl_set_reservation_conflict(ctsio);
8228 ctl_done((union ctl_io *)ctsio);
8229 return (CTL_RETVAL_COMPLETE);
8230 } else if (res_key != 0) {
8232 * We are not registered and trying to register but
8233 * the register key isn't zero.
8235 mtx_unlock(&lun->lun_lock);
8236 free(ctsio->kern_data_ptr, M_CTL);
8237 ctl_set_reservation_conflict(ctsio);
8238 ctl_done((union ctl_io *)ctsio);
8239 return (CTL_RETVAL_COMPLETE);
8241 mtx_unlock(&lun->lun_lock);
8244 switch (cdb->action & SPRO_ACTION_MASK) {
8246 case SPRO_REG_IGNO: {
8249 printf("Registration received\n");
8253 * We don't support any of these options, as we report in
8254 * the read capabilities request (see
8255 * ctl_persistent_reserve_in(), above).
8257 if ((param->flags & SPR_SPEC_I_PT)
8258 || (param->flags & SPR_ALL_TG_PT)
8259 || (param->flags & SPR_APTPL)) {
8262 if (param->flags & SPR_APTPL)
8264 else if (param->flags & SPR_ALL_TG_PT)
8266 else /* SPR_SPEC_I_PT */
8269 free(ctsio->kern_data_ptr, M_CTL);
8270 ctl_set_invalid_field(ctsio,
8276 ctl_done((union ctl_io *)ctsio);
8277 return (CTL_RETVAL_COMPLETE);
8280 mtx_lock(&lun->lun_lock);
8283 * The initiator wants to clear the
8286 if (sa_res_key == 0) {
8288 && (cdb->action & SPRO_ACTION_MASK) == SPRO_REGISTER)
8289 || ((cdb->action & SPRO_ACTION_MASK) == SPRO_REG_IGNO
8290 && ctl_get_prkey(lun, residx) == 0)) {
8291 mtx_unlock(&lun->lun_lock);
8295 ctl_clr_prkey(lun, residx);
8296 lun->pr_key_count--;
8298 if (residx == lun->pr_res_idx) {
8299 lun->flags &= ~CTL_LUN_PR_RESERVED;
8300 lun->pr_res_idx = CTL_PR_NO_RESERVATION;
8302 if ((lun->pr_res_type == SPR_TYPE_WR_EX_RO ||
8303 lun->pr_res_type == SPR_TYPE_EX_AC_RO) &&
8304 lun->pr_key_count) {
8306 * If the reservation is a registrants
8307 * only type we need to generate a UA
8308 * for other registered inits. The
8309 * sense code should be RESERVATIONS
8313 for (i = softc->init_min; i < softc->init_max; i++){
8314 if (ctl_get_prkey(lun, i) == 0)
8317 CTL_UA_RES_RELEASE);
8320 lun->pr_res_type = 0;
8321 } else if (lun->pr_res_idx == CTL_PR_ALL_REGISTRANTS) {
8322 if (lun->pr_key_count==0) {
8323 lun->flags &= ~CTL_LUN_PR_RESERVED;
8324 lun->pr_res_type = 0;
8325 lun->pr_res_idx = CTL_PR_NO_RESERVATION;
8328 lun->pr_generation++;
8329 mtx_unlock(&lun->lun_lock);
8331 persis_io.hdr.nexus = ctsio->io_hdr.nexus;
8332 persis_io.hdr.msg_type = CTL_MSG_PERS_ACTION;
8333 persis_io.pr.pr_info.action = CTL_PR_UNREG_KEY;
8334 persis_io.pr.pr_info.residx = residx;
8335 ctl_ha_msg_send(CTL_HA_CHAN_CTL, &persis_io,
8336 sizeof(persis_io.pr), M_WAITOK);
8337 } else /* sa_res_key != 0 */ {
8340 * If we aren't registered currently then increment
8341 * the key count and set the registered flag.
8343 ctl_alloc_prkey(lun, residx);
8344 if (ctl_get_prkey(lun, residx) == 0)
8345 lun->pr_key_count++;
8346 ctl_set_prkey(lun, residx, sa_res_key);
8347 lun->pr_generation++;
8348 mtx_unlock(&lun->lun_lock);
8350 persis_io.hdr.nexus = ctsio->io_hdr.nexus;
8351 persis_io.hdr.msg_type = CTL_MSG_PERS_ACTION;
8352 persis_io.pr.pr_info.action = CTL_PR_REG_KEY;
8353 persis_io.pr.pr_info.residx = residx;
8354 memcpy(persis_io.pr.pr_info.sa_res_key,
8355 param->serv_act_res_key,
8356 sizeof(param->serv_act_res_key));
8357 ctl_ha_msg_send(CTL_HA_CHAN_CTL, &persis_io,
8358 sizeof(persis_io.pr), M_WAITOK);
8365 printf("Reserve executed type %d\n", type);
8367 mtx_lock(&lun->lun_lock);
8368 if (lun->flags & CTL_LUN_PR_RESERVED) {
8370 * if this isn't the reservation holder and it's
8371 * not a "all registrants" type or if the type is
8372 * different then we have a conflict
8374 if ((lun->pr_res_idx != residx
8375 && lun->pr_res_idx != CTL_PR_ALL_REGISTRANTS)
8376 || lun->pr_res_type != type) {
8377 mtx_unlock(&lun->lun_lock);
8378 free(ctsio->kern_data_ptr, M_CTL);
8379 ctl_set_reservation_conflict(ctsio);
8380 ctl_done((union ctl_io *)ctsio);
8381 return (CTL_RETVAL_COMPLETE);
8383 mtx_unlock(&lun->lun_lock);
8384 } else /* create a reservation */ {
8386 * If it's not an "all registrants" type record
8387 * reservation holder
8389 if (type != SPR_TYPE_WR_EX_AR
8390 && type != SPR_TYPE_EX_AC_AR)
8391 lun->pr_res_idx = residx; /* Res holder */
8393 lun->pr_res_idx = CTL_PR_ALL_REGISTRANTS;
8395 lun->flags |= CTL_LUN_PR_RESERVED;
8396 lun->pr_res_type = type;
8398 mtx_unlock(&lun->lun_lock);
8400 /* send msg to other side */
8401 persis_io.hdr.nexus = ctsio->io_hdr.nexus;
8402 persis_io.hdr.msg_type = CTL_MSG_PERS_ACTION;
8403 persis_io.pr.pr_info.action = CTL_PR_RESERVE;
8404 persis_io.pr.pr_info.residx = lun->pr_res_idx;
8405 persis_io.pr.pr_info.res_type = type;
8406 ctl_ha_msg_send(CTL_HA_CHAN_CTL, &persis_io,
8407 sizeof(persis_io.pr), M_WAITOK);
8412 mtx_lock(&lun->lun_lock);
8413 if ((lun->flags & CTL_LUN_PR_RESERVED) == 0) {
8414 /* No reservation exists return good status */
8415 mtx_unlock(&lun->lun_lock);
8419 * Is this nexus a reservation holder?
8421 if (lun->pr_res_idx != residx
8422 && lun->pr_res_idx != CTL_PR_ALL_REGISTRANTS) {
8424 * not a res holder return good status but
8427 mtx_unlock(&lun->lun_lock);
8431 if (lun->pr_res_type != type) {
8432 mtx_unlock(&lun->lun_lock);
8433 free(ctsio->kern_data_ptr, M_CTL);
8434 ctl_set_illegal_pr_release(ctsio);
8435 ctl_done((union ctl_io *)ctsio);
8436 return (CTL_RETVAL_COMPLETE);
8439 /* okay to release */
8440 lun->flags &= ~CTL_LUN_PR_RESERVED;
8441 lun->pr_res_idx = CTL_PR_NO_RESERVATION;
8442 lun->pr_res_type = 0;
8445 * If this isn't an exclusive access reservation and NUAR
8446 * is not set, generate UA for all other registrants.
8448 if (type != SPR_TYPE_EX_AC && type != SPR_TYPE_WR_EX &&
8449 (lun->MODE_CTRL.queue_flags & SCP_NUAR) == 0) {
8450 for (i = softc->init_min; i < softc->init_max; i++) {
8451 if (i == residx || ctl_get_prkey(lun, i) == 0)
8453 ctl_est_ua(lun, i, CTL_UA_RES_RELEASE);
8456 mtx_unlock(&lun->lun_lock);
8458 /* Send msg to other side */
8459 persis_io.hdr.nexus = ctsio->io_hdr.nexus;
8460 persis_io.hdr.msg_type = CTL_MSG_PERS_ACTION;
8461 persis_io.pr.pr_info.action = CTL_PR_RELEASE;
8462 ctl_ha_msg_send(CTL_HA_CHAN_CTL, &persis_io,
8463 sizeof(persis_io.pr), M_WAITOK);
8467 /* send msg to other side */
8469 mtx_lock(&lun->lun_lock);
8470 lun->flags &= ~CTL_LUN_PR_RESERVED;
8471 lun->pr_res_type = 0;
8472 lun->pr_key_count = 0;
8473 lun->pr_res_idx = CTL_PR_NO_RESERVATION;
8475 ctl_clr_prkey(lun, residx);
8476 for (i = 0; i < CTL_MAX_INITIATORS; i++)
8477 if (ctl_get_prkey(lun, i) != 0) {
8478 ctl_clr_prkey(lun, i);
8479 ctl_est_ua(lun, i, CTL_UA_REG_PREEMPT);
8481 lun->pr_generation++;
8482 mtx_unlock(&lun->lun_lock);
8484 persis_io.hdr.nexus = ctsio->io_hdr.nexus;
8485 persis_io.hdr.msg_type = CTL_MSG_PERS_ACTION;
8486 persis_io.pr.pr_info.action = CTL_PR_CLEAR;
8487 ctl_ha_msg_send(CTL_HA_CHAN_CTL, &persis_io,
8488 sizeof(persis_io.pr), M_WAITOK);
8492 case SPRO_PRE_ABO: {
8495 nretval = ctl_pro_preempt(softc, lun, res_key, sa_res_key, type,
8496 residx, ctsio, cdb, param);
8498 return (CTL_RETVAL_COMPLETE);
8502 panic("%s: Invalid PR type %#x", __func__, cdb->action);
8506 free(ctsio->kern_data_ptr, M_CTL);
8507 ctl_set_success(ctsio);
8508 ctl_done((union ctl_io *)ctsio);
8514 * This routine is for handling a message from the other SC pertaining to
8515 * persistent reserve out. All the error checking will have been done
8516 * so only perorming the action need be done here to keep the two
8520 ctl_hndl_per_res_out_on_other_sc(union ctl_ha_msg *msg)
8522 struct ctl_softc *softc = control_softc;
8523 struct ctl_lun *lun;
8525 uint32_t residx, targ_lun;
8527 targ_lun = msg->hdr.nexus.targ_mapped_lun;
8528 mtx_lock(&softc->ctl_lock);
8529 if ((targ_lun >= CTL_MAX_LUNS) ||
8530 ((lun = softc->ctl_luns[targ_lun]) == NULL)) {
8531 mtx_unlock(&softc->ctl_lock);
8534 mtx_lock(&lun->lun_lock);
8535 mtx_unlock(&softc->ctl_lock);
8536 if (lun->flags & CTL_LUN_DISABLED) {
8537 mtx_unlock(&lun->lun_lock);
8540 residx = ctl_get_initindex(&msg->hdr.nexus);
8541 switch(msg->pr.pr_info.action) {
8542 case CTL_PR_REG_KEY:
8543 ctl_alloc_prkey(lun, msg->pr.pr_info.residx);
8544 if (ctl_get_prkey(lun, msg->pr.pr_info.residx) == 0)
8545 lun->pr_key_count++;
8546 ctl_set_prkey(lun, msg->pr.pr_info.residx,
8547 scsi_8btou64(msg->pr.pr_info.sa_res_key));
8548 lun->pr_generation++;
8551 case CTL_PR_UNREG_KEY:
8552 ctl_clr_prkey(lun, msg->pr.pr_info.residx);
8553 lun->pr_key_count--;
8555 /* XXX Need to see if the reservation has been released */
8556 /* if so do we need to generate UA? */
8557 if (msg->pr.pr_info.residx == lun->pr_res_idx) {
8558 lun->flags &= ~CTL_LUN_PR_RESERVED;
8559 lun->pr_res_idx = CTL_PR_NO_RESERVATION;
8561 if ((lun->pr_res_type == SPR_TYPE_WR_EX_RO ||
8562 lun->pr_res_type == SPR_TYPE_EX_AC_RO) &&
8563 lun->pr_key_count) {
8565 * If the reservation is a registrants
8566 * only type we need to generate a UA
8567 * for other registered inits. The
8568 * sense code should be RESERVATIONS
8572 for (i = softc->init_min; i < softc->init_max; i++) {
8573 if (ctl_get_prkey(lun, i) == 0)
8576 ctl_est_ua(lun, i, CTL_UA_RES_RELEASE);
8579 lun->pr_res_type = 0;
8580 } else if (lun->pr_res_idx == CTL_PR_ALL_REGISTRANTS) {
8581 if (lun->pr_key_count==0) {
8582 lun->flags &= ~CTL_LUN_PR_RESERVED;
8583 lun->pr_res_type = 0;
8584 lun->pr_res_idx = CTL_PR_NO_RESERVATION;
8587 lun->pr_generation++;
8590 case CTL_PR_RESERVE:
8591 lun->flags |= CTL_LUN_PR_RESERVED;
8592 lun->pr_res_type = msg->pr.pr_info.res_type;
8593 lun->pr_res_idx = msg->pr.pr_info.residx;
8597 case CTL_PR_RELEASE:
8599 * If this isn't an exclusive access reservation and NUAR
8600 * is not set, generate UA for all other registrants.
8602 if (lun->pr_res_type != SPR_TYPE_EX_AC &&
8603 lun->pr_res_type != SPR_TYPE_WR_EX &&
8604 (lun->MODE_CTRL.queue_flags & SCP_NUAR) == 0) {
8605 for (i = softc->init_min; i < softc->init_max; i++)
8606 if (i == residx || ctl_get_prkey(lun, i) == 0)
8608 ctl_est_ua(lun, i, CTL_UA_RES_RELEASE);
8611 lun->flags &= ~CTL_LUN_PR_RESERVED;
8612 lun->pr_res_idx = CTL_PR_NO_RESERVATION;
8613 lun->pr_res_type = 0;
8616 case CTL_PR_PREEMPT:
8617 ctl_pro_preempt_other(lun, msg);
8620 lun->flags &= ~CTL_LUN_PR_RESERVED;
8621 lun->pr_res_type = 0;
8622 lun->pr_key_count = 0;
8623 lun->pr_res_idx = CTL_PR_NO_RESERVATION;
8625 for (i=0; i < CTL_MAX_INITIATORS; i++) {
8626 if (ctl_get_prkey(lun, i) == 0)
8628 ctl_clr_prkey(lun, i);
8629 ctl_est_ua(lun, i, CTL_UA_REG_PREEMPT);
8631 lun->pr_generation++;
8635 mtx_unlock(&lun->lun_lock);
8639 ctl_read_write(struct ctl_scsiio *ctsio)
8641 struct ctl_lun *lun;
8642 struct ctl_lba_len_flags *lbalen;
8644 uint32_t num_blocks;
8648 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
8650 CTL_DEBUG_PRINT(("ctl_read_write: command: %#x\n", ctsio->cdb[0]));
8653 isread = ctsio->cdb[0] == READ_6 || ctsio->cdb[0] == READ_10
8654 || ctsio->cdb[0] == READ_12 || ctsio->cdb[0] == READ_16;
8655 switch (ctsio->cdb[0]) {
8658 struct scsi_rw_6 *cdb;
8660 cdb = (struct scsi_rw_6 *)ctsio->cdb;
8662 lba = scsi_3btoul(cdb->addr);
8663 /* only 5 bits are valid in the most significant address byte */
8665 num_blocks = cdb->length;
8667 * This is correct according to SBC-2.
8669 if (num_blocks == 0)
8675 struct scsi_rw_10 *cdb;
8677 cdb = (struct scsi_rw_10 *)ctsio->cdb;
8678 if (cdb->byte2 & SRW10_FUA)
8679 flags |= CTL_LLF_FUA;
8680 if (cdb->byte2 & SRW10_DPO)
8681 flags |= CTL_LLF_DPO;
8682 lba = scsi_4btoul(cdb->addr);
8683 num_blocks = scsi_2btoul(cdb->length);
8686 case WRITE_VERIFY_10: {
8687 struct scsi_write_verify_10 *cdb;
8689 cdb = (struct scsi_write_verify_10 *)ctsio->cdb;
8690 flags |= CTL_LLF_FUA;
8691 if (cdb->byte2 & SWV_DPO)
8692 flags |= CTL_LLF_DPO;
8693 lba = scsi_4btoul(cdb->addr);
8694 num_blocks = scsi_2btoul(cdb->length);
8699 struct scsi_rw_12 *cdb;
8701 cdb = (struct scsi_rw_12 *)ctsio->cdb;
8702 if (cdb->byte2 & SRW12_FUA)
8703 flags |= CTL_LLF_FUA;
8704 if (cdb->byte2 & SRW12_DPO)
8705 flags |= CTL_LLF_DPO;
8706 lba = scsi_4btoul(cdb->addr);
8707 num_blocks = scsi_4btoul(cdb->length);
8710 case WRITE_VERIFY_12: {
8711 struct scsi_write_verify_12 *cdb;
8713 cdb = (struct scsi_write_verify_12 *)ctsio->cdb;
8714 flags |= CTL_LLF_FUA;
8715 if (cdb->byte2 & SWV_DPO)
8716 flags |= CTL_LLF_DPO;
8717 lba = scsi_4btoul(cdb->addr);
8718 num_blocks = scsi_4btoul(cdb->length);
8723 struct scsi_rw_16 *cdb;
8725 cdb = (struct scsi_rw_16 *)ctsio->cdb;
8726 if (cdb->byte2 & SRW12_FUA)
8727 flags |= CTL_LLF_FUA;
8728 if (cdb->byte2 & SRW12_DPO)
8729 flags |= CTL_LLF_DPO;
8730 lba = scsi_8btou64(cdb->addr);
8731 num_blocks = scsi_4btoul(cdb->length);
8734 case WRITE_ATOMIC_16: {
8735 struct scsi_write_atomic_16 *cdb;
8737 if (lun->be_lun->atomicblock == 0) {
8738 ctl_set_invalid_opcode(ctsio);
8739 ctl_done((union ctl_io *)ctsio);
8740 return (CTL_RETVAL_COMPLETE);
8743 cdb = (struct scsi_write_atomic_16 *)ctsio->cdb;
8744 if (cdb->byte2 & SRW12_FUA)
8745 flags |= CTL_LLF_FUA;
8746 if (cdb->byte2 & SRW12_DPO)
8747 flags |= CTL_LLF_DPO;
8748 lba = scsi_8btou64(cdb->addr);
8749 num_blocks = scsi_2btoul(cdb->length);
8750 if (num_blocks > lun->be_lun->atomicblock) {
8751 ctl_set_invalid_field(ctsio, /*sks_valid*/ 1,
8752 /*command*/ 1, /*field*/ 12, /*bit_valid*/ 0,
8754 ctl_done((union ctl_io *)ctsio);
8755 return (CTL_RETVAL_COMPLETE);
8759 case WRITE_VERIFY_16: {
8760 struct scsi_write_verify_16 *cdb;
8762 cdb = (struct scsi_write_verify_16 *)ctsio->cdb;
8763 flags |= CTL_LLF_FUA;
8764 if (cdb->byte2 & SWV_DPO)
8765 flags |= CTL_LLF_DPO;
8766 lba = scsi_8btou64(cdb->addr);
8767 num_blocks = scsi_4btoul(cdb->length);
8772 * We got a command we don't support. This shouldn't
8773 * happen, commands should be filtered out above us.
8775 ctl_set_invalid_opcode(ctsio);
8776 ctl_done((union ctl_io *)ctsio);
8778 return (CTL_RETVAL_COMPLETE);
8779 break; /* NOTREACHED */
8783 * The first check is to make sure we're in bounds, the second
8784 * check is to catch wrap-around problems. If the lba + num blocks
8785 * is less than the lba, then we've wrapped around and the block
8786 * range is invalid anyway.
8788 if (((lba + num_blocks) > (lun->be_lun->maxlba + 1))
8789 || ((lba + num_blocks) < lba)) {
8790 ctl_set_lba_out_of_range(ctsio,
8791 MAX(lba, lun->be_lun->maxlba + 1));
8792 ctl_done((union ctl_io *)ctsio);
8793 return (CTL_RETVAL_COMPLETE);
8797 * According to SBC-3, a transfer length of 0 is not an error.
8798 * Note that this cannot happen with WRITE(6) or READ(6), since 0
8799 * translates to 256 blocks for those commands.
8801 if (num_blocks == 0) {
8802 ctl_set_success(ctsio);
8803 ctl_done((union ctl_io *)ctsio);
8804 return (CTL_RETVAL_COMPLETE);
8807 /* Set FUA and/or DPO if caches are disabled. */
8809 if ((lun->MODE_CACHING.flags1 & SCP_RCD) != 0)
8810 flags |= CTL_LLF_FUA | CTL_LLF_DPO;
8812 if ((lun->MODE_CACHING.flags1 & SCP_WCE) == 0)
8813 flags |= CTL_LLF_FUA;
8816 lbalen = (struct ctl_lba_len_flags *)
8817 &ctsio->io_hdr.ctl_private[CTL_PRIV_LBA_LEN];
8819 lbalen->len = num_blocks;
8820 lbalen->flags = (isread ? CTL_LLF_READ : CTL_LLF_WRITE) | flags;
8822 ctsio->kern_total_len = num_blocks * lun->be_lun->blocksize;
8823 ctsio->kern_rel_offset = 0;
8825 CTL_DEBUG_PRINT(("ctl_read_write: calling data_submit()\n"));
8827 retval = lun->backend->data_submit((union ctl_io *)ctsio);
8832 ctl_cnw_cont(union ctl_io *io)
8834 struct ctl_scsiio *ctsio;
8835 struct ctl_lun *lun;
8836 struct ctl_lba_len_flags *lbalen;
8839 ctsio = &io->scsiio;
8840 ctsio->io_hdr.status = CTL_STATUS_NONE;
8841 ctsio->io_hdr.flags &= ~CTL_FLAG_IO_CONT;
8842 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
8843 lbalen = (struct ctl_lba_len_flags *)
8844 &ctsio->io_hdr.ctl_private[CTL_PRIV_LBA_LEN];
8845 lbalen->flags &= ~CTL_LLF_COMPARE;
8846 lbalen->flags |= CTL_LLF_WRITE;
8848 CTL_DEBUG_PRINT(("ctl_cnw_cont: calling data_submit()\n"));
8849 retval = lun->backend->data_submit((union ctl_io *)ctsio);
8854 ctl_cnw(struct ctl_scsiio *ctsio)
8856 struct ctl_lun *lun;
8857 struct ctl_lba_len_flags *lbalen;
8859 uint32_t num_blocks;
8862 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
8864 CTL_DEBUG_PRINT(("ctl_cnw: command: %#x\n", ctsio->cdb[0]));
8867 switch (ctsio->cdb[0]) {
8868 case COMPARE_AND_WRITE: {
8869 struct scsi_compare_and_write *cdb;
8871 cdb = (struct scsi_compare_and_write *)ctsio->cdb;
8872 if (cdb->byte2 & SRW10_FUA)
8873 flags |= CTL_LLF_FUA;
8874 if (cdb->byte2 & SRW10_DPO)
8875 flags |= CTL_LLF_DPO;
8876 lba = scsi_8btou64(cdb->addr);
8877 num_blocks = cdb->length;
8882 * We got a command we don't support. This shouldn't
8883 * happen, commands should be filtered out above us.
8885 ctl_set_invalid_opcode(ctsio);
8886 ctl_done((union ctl_io *)ctsio);
8888 return (CTL_RETVAL_COMPLETE);
8889 break; /* NOTREACHED */
8893 * The first check is to make sure we're in bounds, the second
8894 * check is to catch wrap-around problems. If the lba + num blocks
8895 * is less than the lba, then we've wrapped around and the block
8896 * range is invalid anyway.
8898 if (((lba + num_blocks) > (lun->be_lun->maxlba + 1))
8899 || ((lba + num_blocks) < lba)) {
8900 ctl_set_lba_out_of_range(ctsio,
8901 MAX(lba, lun->be_lun->maxlba + 1));
8902 ctl_done((union ctl_io *)ctsio);
8903 return (CTL_RETVAL_COMPLETE);
8907 * According to SBC-3, a transfer length of 0 is not an error.
8909 if (num_blocks == 0) {
8910 ctl_set_success(ctsio);
8911 ctl_done((union ctl_io *)ctsio);
8912 return (CTL_RETVAL_COMPLETE);
8915 /* Set FUA if write cache is disabled. */
8916 if ((lun->MODE_CACHING.flags1 & SCP_WCE) == 0)
8917 flags |= CTL_LLF_FUA;
8919 ctsio->kern_total_len = 2 * num_blocks * lun->be_lun->blocksize;
8920 ctsio->kern_rel_offset = 0;
8923 * Set the IO_CONT flag, so that if this I/O gets passed to
8924 * ctl_data_submit_done(), it'll get passed back to
8925 * ctl_ctl_cnw_cont() for further processing.
8927 ctsio->io_hdr.flags |= CTL_FLAG_IO_CONT;
8928 ctsio->io_cont = ctl_cnw_cont;
8930 lbalen = (struct ctl_lba_len_flags *)
8931 &ctsio->io_hdr.ctl_private[CTL_PRIV_LBA_LEN];
8933 lbalen->len = num_blocks;
8934 lbalen->flags = CTL_LLF_COMPARE | flags;
8936 CTL_DEBUG_PRINT(("ctl_cnw: calling data_submit()\n"));
8937 retval = lun->backend->data_submit((union ctl_io *)ctsio);
8942 ctl_verify(struct ctl_scsiio *ctsio)
8944 struct ctl_lun *lun;
8945 struct ctl_lba_len_flags *lbalen;
8947 uint32_t num_blocks;
8951 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
8953 CTL_DEBUG_PRINT(("ctl_verify: command: %#x\n", ctsio->cdb[0]));
8956 flags = CTL_LLF_FUA;
8957 switch (ctsio->cdb[0]) {
8959 struct scsi_verify_10 *cdb;
8961 cdb = (struct scsi_verify_10 *)ctsio->cdb;
8962 if (cdb->byte2 & SVFY_BYTCHK)
8964 if (cdb->byte2 & SVFY_DPO)
8965 flags |= CTL_LLF_DPO;
8966 lba = scsi_4btoul(cdb->addr);
8967 num_blocks = scsi_2btoul(cdb->length);
8971 struct scsi_verify_12 *cdb;
8973 cdb = (struct scsi_verify_12 *)ctsio->cdb;
8974 if (cdb->byte2 & SVFY_BYTCHK)
8976 if (cdb->byte2 & SVFY_DPO)
8977 flags |= CTL_LLF_DPO;
8978 lba = scsi_4btoul(cdb->addr);
8979 num_blocks = scsi_4btoul(cdb->length);
8983 struct scsi_rw_16 *cdb;
8985 cdb = (struct scsi_rw_16 *)ctsio->cdb;
8986 if (cdb->byte2 & SVFY_BYTCHK)
8988 if (cdb->byte2 & SVFY_DPO)
8989 flags |= CTL_LLF_DPO;
8990 lba = scsi_8btou64(cdb->addr);
8991 num_blocks = scsi_4btoul(cdb->length);
8996 * We got a command we don't support. This shouldn't
8997 * happen, commands should be filtered out above us.
8999 ctl_set_invalid_opcode(ctsio);
9000 ctl_done((union ctl_io *)ctsio);
9001 return (CTL_RETVAL_COMPLETE);
9005 * The first check is to make sure we're in bounds, the second
9006 * check is to catch wrap-around problems. If the lba + num blocks
9007 * is less than the lba, then we've wrapped around and the block
9008 * range is invalid anyway.
9010 if (((lba + num_blocks) > (lun->be_lun->maxlba + 1))
9011 || ((lba + num_blocks) < lba)) {
9012 ctl_set_lba_out_of_range(ctsio,
9013 MAX(lba, lun->be_lun->maxlba + 1));
9014 ctl_done((union ctl_io *)ctsio);
9015 return (CTL_RETVAL_COMPLETE);
9019 * According to SBC-3, a transfer length of 0 is not an error.
9021 if (num_blocks == 0) {
9022 ctl_set_success(ctsio);
9023 ctl_done((union ctl_io *)ctsio);
9024 return (CTL_RETVAL_COMPLETE);
9027 lbalen = (struct ctl_lba_len_flags *)
9028 &ctsio->io_hdr.ctl_private[CTL_PRIV_LBA_LEN];
9030 lbalen->len = num_blocks;
9032 lbalen->flags = CTL_LLF_COMPARE | flags;
9033 ctsio->kern_total_len = num_blocks * lun->be_lun->blocksize;
9035 lbalen->flags = CTL_LLF_VERIFY | flags;
9036 ctsio->kern_total_len = 0;
9038 ctsio->kern_rel_offset = 0;
9040 CTL_DEBUG_PRINT(("ctl_verify: calling data_submit()\n"));
9041 retval = lun->backend->data_submit((union ctl_io *)ctsio);
9046 ctl_report_luns(struct ctl_scsiio *ctsio)
9048 struct ctl_softc *softc;
9049 struct scsi_report_luns *cdb;
9050 struct scsi_report_luns_data *lun_data;
9051 struct ctl_lun *lun, *request_lun;
9052 struct ctl_port *port;
9053 int num_luns, retval;
9054 uint32_t alloc_len, lun_datalen;
9056 uint32_t initidx, targ_lun_id, lun_id;
9058 retval = CTL_RETVAL_COMPLETE;
9059 cdb = (struct scsi_report_luns *)ctsio->cdb;
9060 port = ctl_io_port(&ctsio->io_hdr);
9061 softc = port->ctl_softc;
9063 CTL_DEBUG_PRINT(("ctl_report_luns\n"));
9065 mtx_lock(&softc->ctl_lock);
9067 for (targ_lun_id = 0; targ_lun_id < CTL_MAX_LUNS; targ_lun_id++) {
9068 if (ctl_lun_map_from_port(port, targ_lun_id) < CTL_MAX_LUNS)
9071 mtx_unlock(&softc->ctl_lock);
9073 switch (cdb->select_report) {
9074 case RPL_REPORT_DEFAULT:
9075 case RPL_REPORT_ALL:
9076 case RPL_REPORT_NONSUBSID:
9078 case RPL_REPORT_WELLKNOWN:
9079 case RPL_REPORT_ADMIN:
9080 case RPL_REPORT_CONGLOM:
9084 ctl_set_invalid_field(ctsio,
9090 ctl_done((union ctl_io *)ctsio);
9092 break; /* NOTREACHED */
9095 alloc_len = scsi_4btoul(cdb->length);
9097 * The initiator has to allocate at least 16 bytes for this request,
9098 * so he can at least get the header and the first LUN. Otherwise
9099 * we reject the request (per SPC-3 rev 14, section 6.21).
9101 if (alloc_len < (sizeof(struct scsi_report_luns_data) +
9102 sizeof(struct scsi_report_luns_lundata))) {
9103 ctl_set_invalid_field(ctsio,
9109 ctl_done((union ctl_io *)ctsio);
9113 request_lun = (struct ctl_lun *)
9114 ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
9116 lun_datalen = sizeof(*lun_data) +
9117 (num_luns * sizeof(struct scsi_report_luns_lundata));
9119 ctsio->kern_data_ptr = malloc(lun_datalen, M_CTL, M_WAITOK | M_ZERO);
9120 lun_data = (struct scsi_report_luns_data *)ctsio->kern_data_ptr;
9121 ctsio->kern_sg_entries = 0;
9123 initidx = ctl_get_initindex(&ctsio->io_hdr.nexus);
9125 mtx_lock(&softc->ctl_lock);
9126 for (targ_lun_id = 0, num_filled = 0; targ_lun_id < CTL_MAX_LUNS && num_filled < num_luns; targ_lun_id++) {
9127 lun_id = ctl_lun_map_from_port(port, targ_lun_id);
9128 if (lun_id >= CTL_MAX_LUNS)
9130 lun = softc->ctl_luns[lun_id];
9134 be64enc(lun_data->luns[num_filled++].lundata,
9135 ctl_encode_lun(targ_lun_id));
9138 * According to SPC-3, rev 14 section 6.21:
9140 * "The execution of a REPORT LUNS command to any valid and
9141 * installed logical unit shall clear the REPORTED LUNS DATA
9142 * HAS CHANGED unit attention condition for all logical
9143 * units of that target with respect to the requesting
9144 * initiator. A valid and installed logical unit is one
9145 * having a PERIPHERAL QUALIFIER of 000b in the standard
9146 * INQUIRY data (see 6.4.2)."
9148 * If request_lun is NULL, the LUN this report luns command
9149 * was issued to is either disabled or doesn't exist. In that
9150 * case, we shouldn't clear any pending lun change unit
9153 if (request_lun != NULL) {
9154 mtx_lock(&lun->lun_lock);
9155 ctl_clr_ua(lun, initidx, CTL_UA_LUN_CHANGE);
9156 mtx_unlock(&lun->lun_lock);
9159 mtx_unlock(&softc->ctl_lock);
9162 * It's quite possible that we've returned fewer LUNs than we allocated
9163 * space for. Trim it.
9165 lun_datalen = sizeof(*lun_data) +
9166 (num_filled * sizeof(struct scsi_report_luns_lundata));
9168 if (lun_datalen < alloc_len) {
9169 ctsio->residual = alloc_len - lun_datalen;
9170 ctsio->kern_data_len = lun_datalen;
9171 ctsio->kern_total_len = lun_datalen;
9173 ctsio->residual = 0;
9174 ctsio->kern_data_len = alloc_len;
9175 ctsio->kern_total_len = alloc_len;
9177 ctsio->kern_data_resid = 0;
9178 ctsio->kern_rel_offset = 0;
9179 ctsio->kern_sg_entries = 0;
9182 * We set this to the actual data length, regardless of how much
9183 * space we actually have to return results. If the user looks at
9184 * this value, he'll know whether or not he allocated enough space
9185 * and reissue the command if necessary. We don't support well
9186 * known logical units, so if the user asks for that, return none.
9188 scsi_ulto4b(lun_datalen - 8, lun_data->length);
9191 * We can only return SCSI_STATUS_CHECK_COND when we can't satisfy
9194 ctl_set_success(ctsio);
9195 ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
9196 ctsio->be_move_done = ctl_config_move_done;
9197 ctl_datamove((union ctl_io *)ctsio);
9202 ctl_request_sense(struct ctl_scsiio *ctsio)
9204 struct scsi_request_sense *cdb;
9205 struct scsi_sense_data *sense_ptr;
9206 struct ctl_softc *softc;
9207 struct ctl_lun *lun;
9210 scsi_sense_data_type sense_format;
9211 ctl_ua_type ua_type;
9212 uint8_t asc = 0, ascq = 0;
9214 cdb = (struct scsi_request_sense *)ctsio->cdb;
9216 softc = control_softc;
9217 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
9219 CTL_DEBUG_PRINT(("ctl_request_sense\n"));
9222 * Determine which sense format the user wants.
9224 if (cdb->byte2 & SRS_DESC)
9225 sense_format = SSD_TYPE_DESC;
9227 sense_format = SSD_TYPE_FIXED;
9229 ctsio->kern_data_ptr = malloc(sizeof(*sense_ptr), M_CTL, M_WAITOK);
9230 sense_ptr = (struct scsi_sense_data *)ctsio->kern_data_ptr;
9231 ctsio->kern_sg_entries = 0;
9234 * struct scsi_sense_data, which is currently set to 256 bytes, is
9235 * larger than the largest allowed value for the length field in the
9236 * REQUEST SENSE CDB, which is 252 bytes as of SPC-4.
9238 ctsio->residual = 0;
9239 ctsio->kern_data_len = cdb->length;
9240 ctsio->kern_total_len = cdb->length;
9242 ctsio->kern_data_resid = 0;
9243 ctsio->kern_rel_offset = 0;
9244 ctsio->kern_sg_entries = 0;
9247 * If we don't have a LUN, we don't have any pending sense.
9250 ((lun->flags & CTL_LUN_PRIMARY_SC) == 0 &&
9251 softc->ha_link < CTL_HA_LINK_UNKNOWN)) {
9252 /* "Logical unit not supported" */
9253 ctl_set_sense_data(sense_ptr, NULL, sense_format,
9254 /*current_error*/ 1,
9255 /*sense_key*/ SSD_KEY_ILLEGAL_REQUEST,
9263 initidx = ctl_get_initindex(&ctsio->io_hdr.nexus);
9265 * Check for pending sense, and then for pending unit attentions.
9266 * Pending sense gets returned first, then pending unit attentions.
9268 mtx_lock(&lun->lun_lock);
9270 if (ctl_is_set(lun->have_ca, initidx)) {
9271 scsi_sense_data_type stored_format;
9274 * Check to see which sense format was used for the stored
9277 stored_format = scsi_sense_type(&lun->pending_sense[initidx]);
9280 * If the user requested a different sense format than the
9281 * one we stored, then we need to convert it to the other
9282 * format. If we're going from descriptor to fixed format
9283 * sense data, we may lose things in translation, depending
9284 * on what options were used.
9286 * If the stored format is SSD_TYPE_NONE (i.e. invalid),
9287 * for some reason we'll just copy it out as-is.
9289 if ((stored_format == SSD_TYPE_FIXED)
9290 && (sense_format == SSD_TYPE_DESC))
9291 ctl_sense_to_desc((struct scsi_sense_data_fixed *)
9292 &lun->pending_sense[initidx],
9293 (struct scsi_sense_data_desc *)sense_ptr);
9294 else if ((stored_format == SSD_TYPE_DESC)
9295 && (sense_format == SSD_TYPE_FIXED))
9296 ctl_sense_to_fixed((struct scsi_sense_data_desc *)
9297 &lun->pending_sense[initidx],
9298 (struct scsi_sense_data_fixed *)sense_ptr);
9300 memcpy(sense_ptr, &lun->pending_sense[initidx],
9301 MIN(sizeof(*sense_ptr),
9302 sizeof(lun->pending_sense[initidx])));
9304 ctl_clear_mask(lun->have_ca, initidx);
9308 if (have_error == 0) {
9309 ua_type = ctl_build_ua(lun, initidx, sense_ptr, sense_format);
9310 if (ua_type != CTL_UA_NONE)
9313 if (have_error == 0) {
9315 * Report informational exception if have one and allowed.
9317 if (lun->MODE_IE.mrie != SIEP_MRIE_NO) {
9319 ascq = lun->ie_ascq;
9321 ctl_set_sense_data(sense_ptr, lun, sense_format,
9322 /*current_error*/ 1,
9323 /*sense_key*/ SSD_KEY_NO_SENSE,
9328 mtx_unlock(&lun->lun_lock);
9332 * We report the SCSI status as OK, since the status of the command
9333 * itself is OK. We're reporting sense as parameter data.
9335 ctl_set_success(ctsio);
9336 ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
9337 ctsio->be_move_done = ctl_config_move_done;
9338 ctl_datamove((union ctl_io *)ctsio);
9339 return (CTL_RETVAL_COMPLETE);
9343 ctl_tur(struct ctl_scsiio *ctsio)
9346 CTL_DEBUG_PRINT(("ctl_tur\n"));
9348 ctl_set_success(ctsio);
9349 ctl_done((union ctl_io *)ctsio);
9351 return (CTL_RETVAL_COMPLETE);
9355 * SCSI VPD page 0x00, the Supported VPD Pages page.
9358 ctl_inquiry_evpd_supported(struct ctl_scsiio *ctsio, int alloc_len)
9360 struct scsi_vpd_supported_pages *pages;
9362 struct ctl_lun *lun;
9365 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
9367 sup_page_size = sizeof(struct scsi_vpd_supported_pages) *
9368 SCSI_EVPD_NUM_SUPPORTED_PAGES;
9369 ctsio->kern_data_ptr = malloc(sup_page_size, M_CTL, M_WAITOK | M_ZERO);
9370 pages = (struct scsi_vpd_supported_pages *)ctsio->kern_data_ptr;
9371 ctsio->kern_sg_entries = 0;
9373 if (sup_page_size < alloc_len) {
9374 ctsio->residual = alloc_len - sup_page_size;
9375 ctsio->kern_data_len = sup_page_size;
9376 ctsio->kern_total_len = sup_page_size;
9378 ctsio->residual = 0;
9379 ctsio->kern_data_len = alloc_len;
9380 ctsio->kern_total_len = alloc_len;
9382 ctsio->kern_data_resid = 0;
9383 ctsio->kern_rel_offset = 0;
9384 ctsio->kern_sg_entries = 0;
9387 * The control device is always connected. The disk device, on the
9388 * other hand, may not be online all the time. Need to change this
9389 * to figure out whether the disk device is actually online or not.
9392 pages->device = (SID_QUAL_LU_CONNECTED << 5) |
9393 lun->be_lun->lun_type;
9395 pages->device = (SID_QUAL_LU_OFFLINE << 5) | T_DIRECT;
9398 /* Supported VPD pages */
9399 pages->page_list[p++] = SVPD_SUPPORTED_PAGES;
9401 pages->page_list[p++] = SVPD_UNIT_SERIAL_NUMBER;
9402 /* Device Identification */
9403 pages->page_list[p++] = SVPD_DEVICE_ID;
9404 /* Extended INQUIRY Data */
9405 pages->page_list[p++] = SVPD_EXTENDED_INQUIRY_DATA;
9406 /* Mode Page Policy */
9407 pages->page_list[p++] = SVPD_MODE_PAGE_POLICY;
9409 pages->page_list[p++] = SVPD_SCSI_PORTS;
9410 /* Third-party Copy */
9411 pages->page_list[p++] = SVPD_SCSI_TPC;
9412 if (lun != NULL && lun->be_lun->lun_type == T_DIRECT) {
9414 pages->page_list[p++] = SVPD_BLOCK_LIMITS;
9415 /* Block Device Characteristics */
9416 pages->page_list[p++] = SVPD_BDC;
9417 /* Logical Block Provisioning */
9418 pages->page_list[p++] = SVPD_LBP;
9422 ctl_set_success(ctsio);
9423 ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
9424 ctsio->be_move_done = ctl_config_move_done;
9425 ctl_datamove((union ctl_io *)ctsio);
9426 return (CTL_RETVAL_COMPLETE);
9430 * SCSI VPD page 0x80, the Unit Serial Number page.
9433 ctl_inquiry_evpd_serial(struct ctl_scsiio *ctsio, int alloc_len)
9435 struct scsi_vpd_unit_serial_number *sn_ptr;
9436 struct ctl_lun *lun;
9439 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
9441 data_len = 4 + CTL_SN_LEN;
9442 ctsio->kern_data_ptr = malloc(data_len, M_CTL, M_WAITOK | M_ZERO);
9443 sn_ptr = (struct scsi_vpd_unit_serial_number *)ctsio->kern_data_ptr;
9444 if (data_len < alloc_len) {
9445 ctsio->residual = alloc_len - data_len;
9446 ctsio->kern_data_len = data_len;
9447 ctsio->kern_total_len = data_len;
9449 ctsio->residual = 0;
9450 ctsio->kern_data_len = alloc_len;
9451 ctsio->kern_total_len = alloc_len;
9453 ctsio->kern_data_resid = 0;
9454 ctsio->kern_rel_offset = 0;
9455 ctsio->kern_sg_entries = 0;
9458 * The control device is always connected. The disk device, on the
9459 * other hand, may not be online all the time. Need to change this
9460 * to figure out whether the disk device is actually online or not.
9463 sn_ptr->device = (SID_QUAL_LU_CONNECTED << 5) |
9464 lun->be_lun->lun_type;
9466 sn_ptr->device = (SID_QUAL_LU_OFFLINE << 5) | T_DIRECT;
9468 sn_ptr->page_code = SVPD_UNIT_SERIAL_NUMBER;
9469 sn_ptr->length = CTL_SN_LEN;
9471 * If we don't have a LUN, we just leave the serial number as
9475 strncpy((char *)sn_ptr->serial_num,
9476 (char *)lun->be_lun->serial_num, CTL_SN_LEN);
9478 memset(sn_ptr->serial_num, 0x20, CTL_SN_LEN);
9480 ctl_set_success(ctsio);
9481 ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
9482 ctsio->be_move_done = ctl_config_move_done;
9483 ctl_datamove((union ctl_io *)ctsio);
9484 return (CTL_RETVAL_COMPLETE);
9489 * SCSI VPD page 0x86, the Extended INQUIRY Data page.
9492 ctl_inquiry_evpd_eid(struct ctl_scsiio *ctsio, int alloc_len)
9494 struct scsi_vpd_extended_inquiry_data *eid_ptr;
9495 struct ctl_lun *lun;
9498 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
9500 data_len = sizeof(struct scsi_vpd_extended_inquiry_data);
9501 ctsio->kern_data_ptr = malloc(data_len, M_CTL, M_WAITOK | M_ZERO);
9502 eid_ptr = (struct scsi_vpd_extended_inquiry_data *)ctsio->kern_data_ptr;
9503 ctsio->kern_sg_entries = 0;
9505 if (data_len < alloc_len) {
9506 ctsio->residual = alloc_len - data_len;
9507 ctsio->kern_data_len = data_len;
9508 ctsio->kern_total_len = data_len;
9510 ctsio->residual = 0;
9511 ctsio->kern_data_len = alloc_len;
9512 ctsio->kern_total_len = alloc_len;
9514 ctsio->kern_data_resid = 0;
9515 ctsio->kern_rel_offset = 0;
9516 ctsio->kern_sg_entries = 0;
9519 * The control device is always connected. The disk device, on the
9520 * other hand, may not be online all the time.
9523 eid_ptr->device = (SID_QUAL_LU_CONNECTED << 5) |
9524 lun->be_lun->lun_type;
9526 eid_ptr->device = (SID_QUAL_LU_OFFLINE << 5) | T_DIRECT;
9527 eid_ptr->page_code = SVPD_EXTENDED_INQUIRY_DATA;
9528 scsi_ulto2b(data_len - 4, eid_ptr->page_length);
9530 * We support head of queue, ordered and simple tags.
9532 eid_ptr->flags2 = SVPD_EID_HEADSUP | SVPD_EID_ORDSUP | SVPD_EID_SIMPSUP;
9534 * Volatile cache supported.
9536 eid_ptr->flags3 = SVPD_EID_V_SUP;
9539 * This means that we clear the REPORTED LUNS DATA HAS CHANGED unit
9540 * attention for a particular IT nexus on all LUNs once we report
9541 * it to that nexus once. This bit is required as of SPC-4.
9543 eid_ptr->flags4 = SVPD_EID_LUICLR;
9546 * XXX KDM in order to correctly answer this, we would need
9547 * information from the SIM to determine how much sense data it
9548 * can send. So this would really be a path inquiry field, most
9549 * likely. This can be set to a maximum of 252 according to SPC-4,
9550 * but the hardware may or may not be able to support that much.
9551 * 0 just means that the maximum sense data length is not reported.
9553 eid_ptr->max_sense_length = 0;
9555 ctl_set_success(ctsio);
9556 ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
9557 ctsio->be_move_done = ctl_config_move_done;
9558 ctl_datamove((union ctl_io *)ctsio);
9559 return (CTL_RETVAL_COMPLETE);
9563 ctl_inquiry_evpd_mpp(struct ctl_scsiio *ctsio, int alloc_len)
9565 struct scsi_vpd_mode_page_policy *mpp_ptr;
9566 struct ctl_lun *lun;
9569 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
9571 data_len = sizeof(struct scsi_vpd_mode_page_policy) +
9572 sizeof(struct scsi_vpd_mode_page_policy_descr);
9574 ctsio->kern_data_ptr = malloc(data_len, M_CTL, M_WAITOK | M_ZERO);
9575 mpp_ptr = (struct scsi_vpd_mode_page_policy *)ctsio->kern_data_ptr;
9576 ctsio->kern_sg_entries = 0;
9578 if (data_len < alloc_len) {
9579 ctsio->residual = alloc_len - data_len;
9580 ctsio->kern_data_len = data_len;
9581 ctsio->kern_total_len = data_len;
9583 ctsio->residual = 0;
9584 ctsio->kern_data_len = alloc_len;
9585 ctsio->kern_total_len = alloc_len;
9587 ctsio->kern_data_resid = 0;
9588 ctsio->kern_rel_offset = 0;
9589 ctsio->kern_sg_entries = 0;
9592 * The control device is always connected. The disk device, on the
9593 * other hand, may not be online all the time.
9596 mpp_ptr->device = (SID_QUAL_LU_CONNECTED << 5) |
9597 lun->be_lun->lun_type;
9599 mpp_ptr->device = (SID_QUAL_LU_OFFLINE << 5) | T_DIRECT;
9600 mpp_ptr->page_code = SVPD_MODE_PAGE_POLICY;
9601 scsi_ulto2b(data_len - 4, mpp_ptr->page_length);
9602 mpp_ptr->descr[0].page_code = 0x3f;
9603 mpp_ptr->descr[0].subpage_code = 0xff;
9604 mpp_ptr->descr[0].policy = SVPD_MPP_SHARED;
9606 ctl_set_success(ctsio);
9607 ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
9608 ctsio->be_move_done = ctl_config_move_done;
9609 ctl_datamove((union ctl_io *)ctsio);
9610 return (CTL_RETVAL_COMPLETE);
9614 * SCSI VPD page 0x83, the Device Identification page.
9617 ctl_inquiry_evpd_devid(struct ctl_scsiio *ctsio, int alloc_len)
9619 struct scsi_vpd_device_id *devid_ptr;
9620 struct scsi_vpd_id_descriptor *desc;
9621 struct ctl_softc *softc;
9622 struct ctl_lun *lun;
9623 struct ctl_port *port;
9627 softc = control_softc;
9629 port = ctl_io_port(&ctsio->io_hdr);
9630 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
9632 data_len = sizeof(struct scsi_vpd_device_id) +
9633 sizeof(struct scsi_vpd_id_descriptor) +
9634 sizeof(struct scsi_vpd_id_rel_trgt_port_id) +
9635 sizeof(struct scsi_vpd_id_descriptor) +
9636 sizeof(struct scsi_vpd_id_trgt_port_grp_id);
9637 if (lun && lun->lun_devid)
9638 data_len += lun->lun_devid->len;
9639 if (port && port->port_devid)
9640 data_len += port->port_devid->len;
9641 if (port && port->target_devid)
9642 data_len += port->target_devid->len;
9644 ctsio->kern_data_ptr = malloc(data_len, M_CTL, M_WAITOK | M_ZERO);
9645 devid_ptr = (struct scsi_vpd_device_id *)ctsio->kern_data_ptr;
9646 ctsio->kern_sg_entries = 0;
9648 if (data_len < alloc_len) {
9649 ctsio->residual = alloc_len - data_len;
9650 ctsio->kern_data_len = data_len;
9651 ctsio->kern_total_len = data_len;
9653 ctsio->residual = 0;
9654 ctsio->kern_data_len = alloc_len;
9655 ctsio->kern_total_len = alloc_len;
9657 ctsio->kern_data_resid = 0;
9658 ctsio->kern_rel_offset = 0;
9659 ctsio->kern_sg_entries = 0;
9662 * The control device is always connected. The disk device, on the
9663 * other hand, may not be online all the time.
9666 devid_ptr->device = (SID_QUAL_LU_CONNECTED << 5) |
9667 lun->be_lun->lun_type;
9669 devid_ptr->device = (SID_QUAL_LU_OFFLINE << 5) | T_DIRECT;
9670 devid_ptr->page_code = SVPD_DEVICE_ID;
9671 scsi_ulto2b(data_len - 4, devid_ptr->length);
9673 if (port && port->port_type == CTL_PORT_FC)
9674 proto = SCSI_PROTO_FC << 4;
9675 else if (port && port->port_type == CTL_PORT_ISCSI)
9676 proto = SCSI_PROTO_ISCSI << 4;
9678 proto = SCSI_PROTO_SPI << 4;
9679 desc = (struct scsi_vpd_id_descriptor *)devid_ptr->desc_list;
9682 * We're using a LUN association here. i.e., this device ID is a
9683 * per-LUN identifier.
9685 if (lun && lun->lun_devid) {
9686 memcpy(desc, lun->lun_devid->data, lun->lun_devid->len);
9687 desc = (struct scsi_vpd_id_descriptor *)((uint8_t *)desc +
9688 lun->lun_devid->len);
9692 * This is for the WWPN which is a port association.
9694 if (port && port->port_devid) {
9695 memcpy(desc, port->port_devid->data, port->port_devid->len);
9696 desc = (struct scsi_vpd_id_descriptor *)((uint8_t *)desc +
9697 port->port_devid->len);
9701 * This is for the Relative Target Port(type 4h) identifier
9703 desc->proto_codeset = proto | SVPD_ID_CODESET_BINARY;
9704 desc->id_type = SVPD_ID_PIV | SVPD_ID_ASSOC_PORT |
9705 SVPD_ID_TYPE_RELTARG;
9707 scsi_ulto2b(ctsio->io_hdr.nexus.targ_port, &desc->identifier[2]);
9708 desc = (struct scsi_vpd_id_descriptor *)(&desc->identifier[0] +
9709 sizeof(struct scsi_vpd_id_rel_trgt_port_id));
9712 * This is for the Target Port Group(type 5h) identifier
9714 desc->proto_codeset = proto | SVPD_ID_CODESET_BINARY;
9715 desc->id_type = SVPD_ID_PIV | SVPD_ID_ASSOC_PORT |
9716 SVPD_ID_TYPE_TPORTGRP;
9718 if (softc->is_single ||
9719 (port && port->status & CTL_PORT_STATUS_HA_SHARED))
9722 g = 2 + ctsio->io_hdr.nexus.targ_port / softc->port_cnt;
9723 scsi_ulto2b(g, &desc->identifier[2]);
9724 desc = (struct scsi_vpd_id_descriptor *)(&desc->identifier[0] +
9725 sizeof(struct scsi_vpd_id_trgt_port_grp_id));
9728 * This is for the Target identifier
9730 if (port && port->target_devid) {
9731 memcpy(desc, port->target_devid->data, port->target_devid->len);
9734 ctl_set_success(ctsio);
9735 ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
9736 ctsio->be_move_done = ctl_config_move_done;
9737 ctl_datamove((union ctl_io *)ctsio);
9738 return (CTL_RETVAL_COMPLETE);
9742 ctl_inquiry_evpd_scsi_ports(struct ctl_scsiio *ctsio, int alloc_len)
9744 struct ctl_softc *softc = control_softc;
9745 struct scsi_vpd_scsi_ports *sp;
9746 struct scsi_vpd_port_designation *pd;
9747 struct scsi_vpd_port_designation_cont *pdc;
9748 struct ctl_lun *lun;
9749 struct ctl_port *port;
9750 int data_len, num_target_ports, iid_len, id_len;
9752 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
9754 num_target_ports = 0;
9757 mtx_lock(&softc->ctl_lock);
9758 STAILQ_FOREACH(port, &softc->port_list, links) {
9759 if ((port->status & CTL_PORT_STATUS_ONLINE) == 0)
9762 ctl_lun_map_to_port(port, lun->lun) >= CTL_MAX_LUNS)
9765 if (port->init_devid)
9766 iid_len += port->init_devid->len;
9767 if (port->port_devid)
9768 id_len += port->port_devid->len;
9770 mtx_unlock(&softc->ctl_lock);
9772 data_len = sizeof(struct scsi_vpd_scsi_ports) +
9773 num_target_ports * (sizeof(struct scsi_vpd_port_designation) +
9774 sizeof(struct scsi_vpd_port_designation_cont)) + iid_len + id_len;
9775 ctsio->kern_data_ptr = malloc(data_len, M_CTL, M_WAITOK | M_ZERO);
9776 sp = (struct scsi_vpd_scsi_ports *)ctsio->kern_data_ptr;
9777 ctsio->kern_sg_entries = 0;
9779 if (data_len < alloc_len) {
9780 ctsio->residual = alloc_len - data_len;
9781 ctsio->kern_data_len = data_len;
9782 ctsio->kern_total_len = data_len;
9784 ctsio->residual = 0;
9785 ctsio->kern_data_len = alloc_len;
9786 ctsio->kern_total_len = alloc_len;
9788 ctsio->kern_data_resid = 0;
9789 ctsio->kern_rel_offset = 0;
9790 ctsio->kern_sg_entries = 0;
9793 * The control device is always connected. The disk device, on the
9794 * other hand, may not be online all the time. Need to change this
9795 * to figure out whether the disk device is actually online or not.
9798 sp->device = (SID_QUAL_LU_CONNECTED << 5) |
9799 lun->be_lun->lun_type;
9801 sp->device = (SID_QUAL_LU_OFFLINE << 5) | T_DIRECT;
9803 sp->page_code = SVPD_SCSI_PORTS;
9804 scsi_ulto2b(data_len - sizeof(struct scsi_vpd_scsi_ports),
9806 pd = &sp->design[0];
9808 mtx_lock(&softc->ctl_lock);
9809 STAILQ_FOREACH(port, &softc->port_list, links) {
9810 if ((port->status & CTL_PORT_STATUS_ONLINE) == 0)
9813 ctl_lun_map_to_port(port, lun->lun) >= CTL_MAX_LUNS)
9815 scsi_ulto2b(port->targ_port, pd->relative_port_id);
9816 if (port->init_devid) {
9817 iid_len = port->init_devid->len;
9818 memcpy(pd->initiator_transportid,
9819 port->init_devid->data, port->init_devid->len);
9822 scsi_ulto2b(iid_len, pd->initiator_transportid_length);
9823 pdc = (struct scsi_vpd_port_designation_cont *)
9824 (&pd->initiator_transportid[iid_len]);
9825 if (port->port_devid) {
9826 id_len = port->port_devid->len;
9827 memcpy(pdc->target_port_descriptors,
9828 port->port_devid->data, port->port_devid->len);
9831 scsi_ulto2b(id_len, pdc->target_port_descriptors_length);
9832 pd = (struct scsi_vpd_port_designation *)
9833 ((uint8_t *)pdc->target_port_descriptors + id_len);
9835 mtx_unlock(&softc->ctl_lock);
9837 ctl_set_success(ctsio);
9838 ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
9839 ctsio->be_move_done = ctl_config_move_done;
9840 ctl_datamove((union ctl_io *)ctsio);
9841 return (CTL_RETVAL_COMPLETE);
9845 ctl_inquiry_evpd_block_limits(struct ctl_scsiio *ctsio, int alloc_len)
9847 struct scsi_vpd_block_limits *bl_ptr;
9848 struct ctl_lun *lun;
9851 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
9853 ctsio->kern_data_ptr = malloc(sizeof(*bl_ptr), M_CTL, M_WAITOK | M_ZERO);
9854 bl_ptr = (struct scsi_vpd_block_limits *)ctsio->kern_data_ptr;
9855 ctsio->kern_sg_entries = 0;
9857 if (sizeof(*bl_ptr) < alloc_len) {
9858 ctsio->residual = alloc_len - sizeof(*bl_ptr);
9859 ctsio->kern_data_len = sizeof(*bl_ptr);
9860 ctsio->kern_total_len = sizeof(*bl_ptr);
9862 ctsio->residual = 0;
9863 ctsio->kern_data_len = alloc_len;
9864 ctsio->kern_total_len = alloc_len;
9866 ctsio->kern_data_resid = 0;
9867 ctsio->kern_rel_offset = 0;
9868 ctsio->kern_sg_entries = 0;
9871 * The control device is always connected. The disk device, on the
9872 * other hand, may not be online all the time. Need to change this
9873 * to figure out whether the disk device is actually online or not.
9876 bl_ptr->device = (SID_QUAL_LU_CONNECTED << 5) |
9877 lun->be_lun->lun_type;
9879 bl_ptr->device = (SID_QUAL_LU_OFFLINE << 5) | T_DIRECT;
9881 bl_ptr->page_code = SVPD_BLOCK_LIMITS;
9882 scsi_ulto2b(sizeof(*bl_ptr) - 4, bl_ptr->page_length);
9883 bl_ptr->max_cmp_write_len = 0xff;
9884 scsi_ulto4b(0xffffffff, bl_ptr->max_txfer_len);
9886 scsi_ulto4b(lun->be_lun->opttxferlen, bl_ptr->opt_txfer_len);
9887 if (lun->be_lun->flags & CTL_LUN_FLAG_UNMAP) {
9889 ctl_get_opt_number(&lun->be_lun->options,
9890 "unmap_max_lba", &ival);
9891 scsi_ulto4b(ival, bl_ptr->max_unmap_lba_cnt);
9893 ctl_get_opt_number(&lun->be_lun->options,
9894 "unmap_max_descr", &ival);
9895 scsi_ulto4b(ival, bl_ptr->max_unmap_blk_cnt);
9896 if (lun->be_lun->ublockexp != 0) {
9897 scsi_ulto4b((1 << lun->be_lun->ublockexp),
9898 bl_ptr->opt_unmap_grain);
9899 scsi_ulto4b(0x80000000 | lun->be_lun->ublockoff,
9900 bl_ptr->unmap_grain_align);
9903 scsi_ulto4b(lun->be_lun->atomicblock,
9904 bl_ptr->max_atomic_transfer_length);
9905 scsi_ulto4b(0, bl_ptr->atomic_alignment);
9906 scsi_ulto4b(0, bl_ptr->atomic_transfer_length_granularity);
9907 scsi_ulto4b(0, bl_ptr->max_atomic_transfer_length_with_atomic_boundary);
9908 scsi_ulto4b(0, bl_ptr->max_atomic_boundary_size);
9910 ctl_get_opt_number(&lun->be_lun->options, "write_same_max_lba", &ival);
9911 scsi_u64to8b(ival, bl_ptr->max_write_same_length);
9914 ctl_set_success(ctsio);
9915 ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
9916 ctsio->be_move_done = ctl_config_move_done;
9917 ctl_datamove((union ctl_io *)ctsio);
9918 return (CTL_RETVAL_COMPLETE);
9922 ctl_inquiry_evpd_bdc(struct ctl_scsiio *ctsio, int alloc_len)
9924 struct scsi_vpd_block_device_characteristics *bdc_ptr;
9925 struct ctl_lun *lun;
9929 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
9931 ctsio->kern_data_ptr = malloc(sizeof(*bdc_ptr), M_CTL, M_WAITOK | M_ZERO);
9932 bdc_ptr = (struct scsi_vpd_block_device_characteristics *)ctsio->kern_data_ptr;
9933 ctsio->kern_sg_entries = 0;
9935 if (sizeof(*bdc_ptr) < alloc_len) {
9936 ctsio->residual = alloc_len - sizeof(*bdc_ptr);
9937 ctsio->kern_data_len = sizeof(*bdc_ptr);
9938 ctsio->kern_total_len = sizeof(*bdc_ptr);
9940 ctsio->residual = 0;
9941 ctsio->kern_data_len = alloc_len;
9942 ctsio->kern_total_len = alloc_len;
9944 ctsio->kern_data_resid = 0;
9945 ctsio->kern_rel_offset = 0;
9946 ctsio->kern_sg_entries = 0;
9949 * The control device is always connected. The disk device, on the
9950 * other hand, may not be online all the time. Need to change this
9951 * to figure out whether the disk device is actually online or not.
9954 bdc_ptr->device = (SID_QUAL_LU_CONNECTED << 5) |
9955 lun->be_lun->lun_type;
9957 bdc_ptr->device = (SID_QUAL_LU_OFFLINE << 5) | T_DIRECT;
9958 bdc_ptr->page_code = SVPD_BDC;
9959 scsi_ulto2b(sizeof(*bdc_ptr) - 4, bdc_ptr->page_length);
9961 (value = ctl_get_opt(&lun->be_lun->options, "rpm")) != NULL)
9962 i = strtol(value, NULL, 0);
9964 i = CTL_DEFAULT_ROTATION_RATE;
9965 scsi_ulto2b(i, bdc_ptr->medium_rotation_rate);
9967 (value = ctl_get_opt(&lun->be_lun->options, "formfactor")) != NULL)
9968 i = strtol(value, NULL, 0);
9971 bdc_ptr->wab_wac_ff = (i & 0x0f);
9972 bdc_ptr->flags = SVPD_FUAB | SVPD_VBULS;
9974 ctl_set_success(ctsio);
9975 ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
9976 ctsio->be_move_done = ctl_config_move_done;
9977 ctl_datamove((union ctl_io *)ctsio);
9978 return (CTL_RETVAL_COMPLETE);
9982 ctl_inquiry_evpd_lbp(struct ctl_scsiio *ctsio, int alloc_len)
9984 struct scsi_vpd_logical_block_prov *lbp_ptr;
9985 struct ctl_lun *lun;
9988 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
9990 ctsio->kern_data_ptr = malloc(sizeof(*lbp_ptr), M_CTL, M_WAITOK | M_ZERO);
9991 lbp_ptr = (struct scsi_vpd_logical_block_prov *)ctsio->kern_data_ptr;
9992 ctsio->kern_sg_entries = 0;
9994 if (sizeof(*lbp_ptr) < alloc_len) {
9995 ctsio->residual = alloc_len - sizeof(*lbp_ptr);
9996 ctsio->kern_data_len = sizeof(*lbp_ptr);
9997 ctsio->kern_total_len = sizeof(*lbp_ptr);
9999 ctsio->residual = 0;
10000 ctsio->kern_data_len = alloc_len;
10001 ctsio->kern_total_len = alloc_len;
10003 ctsio->kern_data_resid = 0;
10004 ctsio->kern_rel_offset = 0;
10005 ctsio->kern_sg_entries = 0;
10008 * The control device is always connected. The disk device, on the
10009 * other hand, may not be online all the time. Need to change this
10010 * to figure out whether the disk device is actually online or not.
10013 lbp_ptr->device = (SID_QUAL_LU_CONNECTED << 5) |
10014 lun->be_lun->lun_type;
10016 lbp_ptr->device = (SID_QUAL_LU_OFFLINE << 5) | T_DIRECT;
10018 lbp_ptr->page_code = SVPD_LBP;
10019 scsi_ulto2b(sizeof(*lbp_ptr) - 4, lbp_ptr->page_length);
10020 lbp_ptr->threshold_exponent = CTL_LBP_EXPONENT;
10021 if (lun != NULL && lun->be_lun->flags & CTL_LUN_FLAG_UNMAP) {
10022 lbp_ptr->flags = SVPD_LBP_UNMAP | SVPD_LBP_WS16 |
10023 SVPD_LBP_WS10 | SVPD_LBP_RZ | SVPD_LBP_ANC_SUP;
10024 value = ctl_get_opt(&lun->be_lun->options, "provisioning_type");
10025 if (value != NULL) {
10026 if (strcmp(value, "resource") == 0)
10027 lbp_ptr->prov_type = SVPD_LBP_RESOURCE;
10028 else if (strcmp(value, "thin") == 0)
10029 lbp_ptr->prov_type = SVPD_LBP_THIN;
10031 lbp_ptr->prov_type = SVPD_LBP_THIN;
10034 ctl_set_success(ctsio);
10035 ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
10036 ctsio->be_move_done = ctl_config_move_done;
10037 ctl_datamove((union ctl_io *)ctsio);
10038 return (CTL_RETVAL_COMPLETE);
10042 * INQUIRY with the EVPD bit set.
10045 ctl_inquiry_evpd(struct ctl_scsiio *ctsio)
10047 struct ctl_lun *lun;
10048 struct scsi_inquiry *cdb;
10049 int alloc_len, retval;
10051 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
10052 cdb = (struct scsi_inquiry *)ctsio->cdb;
10053 alloc_len = scsi_2btoul(cdb->length);
10055 switch (cdb->page_code) {
10056 case SVPD_SUPPORTED_PAGES:
10057 retval = ctl_inquiry_evpd_supported(ctsio, alloc_len);
10059 case SVPD_UNIT_SERIAL_NUMBER:
10060 retval = ctl_inquiry_evpd_serial(ctsio, alloc_len);
10062 case SVPD_DEVICE_ID:
10063 retval = ctl_inquiry_evpd_devid(ctsio, alloc_len);
10065 case SVPD_EXTENDED_INQUIRY_DATA:
10066 retval = ctl_inquiry_evpd_eid(ctsio, alloc_len);
10068 case SVPD_MODE_PAGE_POLICY:
10069 retval = ctl_inquiry_evpd_mpp(ctsio, alloc_len);
10071 case SVPD_SCSI_PORTS:
10072 retval = ctl_inquiry_evpd_scsi_ports(ctsio, alloc_len);
10074 case SVPD_SCSI_TPC:
10075 retval = ctl_inquiry_evpd_tpc(ctsio, alloc_len);
10077 case SVPD_BLOCK_LIMITS:
10078 if (lun == NULL || lun->be_lun->lun_type != T_DIRECT)
10080 retval = ctl_inquiry_evpd_block_limits(ctsio, alloc_len);
10083 if (lun == NULL || lun->be_lun->lun_type != T_DIRECT)
10085 retval = ctl_inquiry_evpd_bdc(ctsio, alloc_len);
10088 if (lun == NULL || lun->be_lun->lun_type != T_DIRECT)
10090 retval = ctl_inquiry_evpd_lbp(ctsio, alloc_len);
10094 ctl_set_invalid_field(ctsio,
10100 ctl_done((union ctl_io *)ctsio);
10101 retval = CTL_RETVAL_COMPLETE;
10109 * Standard INQUIRY data.
10112 ctl_inquiry_std(struct ctl_scsiio *ctsio)
10114 struct scsi_inquiry_data *inq_ptr;
10115 struct scsi_inquiry *cdb;
10116 struct ctl_softc *softc = control_softc;
10117 struct ctl_port *port;
10118 struct ctl_lun *lun;
10120 uint32_t alloc_len, data_len;
10121 ctl_port_type port_type;
10123 port = ctl_io_port(&ctsio->io_hdr);
10124 port_type = port->port_type;
10125 if (port_type == CTL_PORT_IOCTL || port_type == CTL_PORT_INTERNAL)
10126 port_type = CTL_PORT_SCSI;
10128 lun = ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
10129 cdb = (struct scsi_inquiry *)ctsio->cdb;
10130 alloc_len = scsi_2btoul(cdb->length);
10133 * We malloc the full inquiry data size here and fill it
10134 * in. If the user only asks for less, we'll give him
10137 data_len = offsetof(struct scsi_inquiry_data, vendor_specific1);
10138 ctsio->kern_data_ptr = malloc(data_len, M_CTL, M_WAITOK | M_ZERO);
10139 inq_ptr = (struct scsi_inquiry_data *)ctsio->kern_data_ptr;
10140 ctsio->kern_sg_entries = 0;
10141 ctsio->kern_data_resid = 0;
10142 ctsio->kern_rel_offset = 0;
10144 if (data_len < alloc_len) {
10145 ctsio->residual = alloc_len - data_len;
10146 ctsio->kern_data_len = data_len;
10147 ctsio->kern_total_len = data_len;
10149 ctsio->residual = 0;
10150 ctsio->kern_data_len = alloc_len;
10151 ctsio->kern_total_len = alloc_len;
10155 if ((lun->flags & CTL_LUN_PRIMARY_SC) ||
10156 softc->ha_link >= CTL_HA_LINK_UNKNOWN) {
10157 inq_ptr->device = (SID_QUAL_LU_CONNECTED << 5) |
10158 lun->be_lun->lun_type;
10160 inq_ptr->device = (SID_QUAL_LU_OFFLINE << 5) |
10161 lun->be_lun->lun_type;
10163 if (lun->flags & CTL_LUN_REMOVABLE)
10164 inq_ptr->dev_qual2 |= SID_RMB;
10166 inq_ptr->device = (SID_QUAL_BAD_LU << 5) | T_NODEVICE;
10168 /* RMB in byte 2 is 0 */
10169 inq_ptr->version = SCSI_REV_SPC5;
10172 * According to SAM-3, even if a device only supports a single
10173 * level of LUN addressing, it should still set the HISUP bit:
10175 * 4.9.1 Logical unit numbers overview
10177 * All logical unit number formats described in this standard are
10178 * hierarchical in structure even when only a single level in that
10179 * hierarchy is used. The HISUP bit shall be set to one in the
10180 * standard INQUIRY data (see SPC-2) when any logical unit number
10181 * format described in this standard is used. Non-hierarchical
10182 * formats are outside the scope of this standard.
10184 * Therefore we set the HiSup bit here.
10186 * The response format is 2, per SPC-3.
10188 inq_ptr->response_format = SID_HiSup | 2;
10190 inq_ptr->additional_length = data_len -
10191 (offsetof(struct scsi_inquiry_data, additional_length) + 1);
10192 CTL_DEBUG_PRINT(("additional_length = %d\n",
10193 inq_ptr->additional_length));
10195 inq_ptr->spc3_flags = SPC3_SID_3PC | SPC3_SID_TPGS_IMPLICIT;
10196 if (port_type == CTL_PORT_SCSI)
10197 inq_ptr->spc2_flags = SPC2_SID_ADDR16;
10198 inq_ptr->spc2_flags |= SPC2_SID_MultiP;
10199 inq_ptr->flags = SID_CmdQue;
10200 if (port_type == CTL_PORT_SCSI)
10201 inq_ptr->flags |= SID_WBus16 | SID_Sync;
10204 * Per SPC-3, unused bytes in ASCII strings are filled with spaces.
10205 * We have 8 bytes for the vendor name, and 16 bytes for the device
10206 * name and 4 bytes for the revision.
10208 if (lun == NULL || (val = ctl_get_opt(&lun->be_lun->options,
10209 "vendor")) == NULL) {
10210 strncpy(inq_ptr->vendor, CTL_VENDOR, sizeof(inq_ptr->vendor));
10212 memset(inq_ptr->vendor, ' ', sizeof(inq_ptr->vendor));
10213 strncpy(inq_ptr->vendor, val,
10214 min(sizeof(inq_ptr->vendor), strlen(val)));
10217 strncpy(inq_ptr->product, CTL_DIRECT_PRODUCT,
10218 sizeof(inq_ptr->product));
10219 } else if ((val = ctl_get_opt(&lun->be_lun->options, "product")) == NULL) {
10220 switch (lun->be_lun->lun_type) {
10222 strncpy(inq_ptr->product, CTL_DIRECT_PRODUCT,
10223 sizeof(inq_ptr->product));
10226 strncpy(inq_ptr->product, CTL_PROCESSOR_PRODUCT,
10227 sizeof(inq_ptr->product));
10230 strncpy(inq_ptr->product, CTL_CDROM_PRODUCT,
10231 sizeof(inq_ptr->product));
10234 strncpy(inq_ptr->product, CTL_UNKNOWN_PRODUCT,
10235 sizeof(inq_ptr->product));
10239 memset(inq_ptr->product, ' ', sizeof(inq_ptr->product));
10240 strncpy(inq_ptr->product, val,
10241 min(sizeof(inq_ptr->product), strlen(val)));
10245 * XXX make this a macro somewhere so it automatically gets
10246 * incremented when we make changes.
10248 if (lun == NULL || (val = ctl_get_opt(&lun->be_lun->options,
10249 "revision")) == NULL) {
10250 strncpy(inq_ptr->revision, "0001", sizeof(inq_ptr->revision));
10252 memset(inq_ptr->revision, ' ', sizeof(inq_ptr->revision));
10253 strncpy(inq_ptr->revision, val,
10254 min(sizeof(inq_ptr->revision), strlen(val)));
10258 * For parallel SCSI, we support double transition and single
10259 * transition clocking. We also support QAS (Quick Arbitration
10260 * and Selection) and Information Unit transfers on both the
10261 * control and array devices.
10263 if (port_type == CTL_PORT_SCSI)
10264 inq_ptr->spi3data = SID_SPI_CLOCK_DT_ST | SID_SPI_QAS |
10267 /* SAM-6 (no version claimed) */
10268 scsi_ulto2b(0x00C0, inq_ptr->version1);
10269 /* SPC-5 (no version claimed) */
10270 scsi_ulto2b(0x05C0, inq_ptr->version2);
10271 if (port_type == CTL_PORT_FC) {
10272 /* FCP-2 ANSI INCITS.350:2003 */
10273 scsi_ulto2b(0x0917, inq_ptr->version3);
10274 } else if (port_type == CTL_PORT_SCSI) {
10275 /* SPI-4 ANSI INCITS.362:200x */
10276 scsi_ulto2b(0x0B56, inq_ptr->version3);
10277 } else if (port_type == CTL_PORT_ISCSI) {
10278 /* iSCSI (no version claimed) */
10279 scsi_ulto2b(0x0960, inq_ptr->version3);
10280 } else if (port_type == CTL_PORT_SAS) {
10281 /* SAS (no version claimed) */
10282 scsi_ulto2b(0x0BE0, inq_ptr->version3);
10286 /* SBC-4 (no version claimed) */
10287 scsi_ulto2b(0x0600, inq_ptr->version4);
10289 switch (lun->be_lun->lun_type) {
10291 /* SBC-4 (no version claimed) */
10292 scsi_ulto2b(0x0600, inq_ptr->version4);
10297 /* MMC-6 (no version claimed) */
10298 scsi_ulto2b(0x04E0, inq_ptr->version4);
10305 ctl_set_success(ctsio);
10306 ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
10307 ctsio->be_move_done = ctl_config_move_done;
10308 ctl_datamove((union ctl_io *)ctsio);
10309 return (CTL_RETVAL_COMPLETE);
10313 ctl_inquiry(struct ctl_scsiio *ctsio)
10315 struct scsi_inquiry *cdb;
10318 CTL_DEBUG_PRINT(("ctl_inquiry\n"));
10320 cdb = (struct scsi_inquiry *)ctsio->cdb;
10321 if (cdb->byte2 & SI_EVPD)
10322 retval = ctl_inquiry_evpd(ctsio);
10323 else if (cdb->page_code == 0)
10324 retval = ctl_inquiry_std(ctsio);
10326 ctl_set_invalid_field(ctsio,
10332 ctl_done((union ctl_io *)ctsio);
10333 return (CTL_RETVAL_COMPLETE);
10340 ctl_get_config(struct ctl_scsiio *ctsio)
10342 struct scsi_get_config_header *hdr;
10343 struct scsi_get_config_feature *feature;
10344 struct scsi_get_config *cdb;
10345 struct ctl_lun *lun;
10346 uint32_t alloc_len, data_len;
10349 lun = ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
10350 cdb = (struct scsi_get_config *)ctsio->cdb;
10351 rt = (cdb->rt & SGC_RT_MASK);
10352 starting = scsi_2btoul(cdb->starting_feature);
10353 alloc_len = scsi_2btoul(cdb->length);
10355 data_len = sizeof(struct scsi_get_config_header) +
10356 sizeof(struct scsi_get_config_feature) + 8 +
10357 sizeof(struct scsi_get_config_feature) + 8 +
10358 sizeof(struct scsi_get_config_feature) + 4 +
10359 sizeof(struct scsi_get_config_feature) + 4 +
10360 sizeof(struct scsi_get_config_feature) + 8 +
10361 sizeof(struct scsi_get_config_feature) +
10362 sizeof(struct scsi_get_config_feature) + 4 +
10363 sizeof(struct scsi_get_config_feature) + 4 +
10364 sizeof(struct scsi_get_config_feature) + 4 +
10365 sizeof(struct scsi_get_config_feature) + 4 +
10366 sizeof(struct scsi_get_config_feature) + 4 +
10367 sizeof(struct scsi_get_config_feature) + 4;
10368 ctsio->kern_data_ptr = malloc(data_len, M_CTL, M_WAITOK | M_ZERO);
10369 ctsio->kern_sg_entries = 0;
10370 ctsio->kern_data_resid = 0;
10371 ctsio->kern_rel_offset = 0;
10373 hdr = (struct scsi_get_config_header *)ctsio->kern_data_ptr;
10374 if (lun->flags & CTL_LUN_NO_MEDIA)
10375 scsi_ulto2b(0x0000, hdr->current_profile);
10377 scsi_ulto2b(0x0010, hdr->current_profile);
10378 feature = (struct scsi_get_config_feature *)(hdr + 1);
10380 if (starting > 0x003b)
10382 if (starting > 0x003a)
10384 if (starting > 0x002b)
10386 if (starting > 0x002a)
10388 if (starting > 0x001f)
10390 if (starting > 0x001e)
10392 if (starting > 0x001d)
10394 if (starting > 0x0010)
10396 if (starting > 0x0003)
10398 if (starting > 0x0002)
10400 if (starting > 0x0001)
10402 if (starting > 0x0000)
10406 scsi_ulto2b(0x0000, feature->feature_code);
10407 feature->flags = SGC_F_PERSISTENT | SGC_F_CURRENT;
10408 feature->add_length = 8;
10409 scsi_ulto2b(0x0008, &feature->feature_data[0]); /* CD-ROM */
10410 feature->feature_data[2] = 0x00;
10411 scsi_ulto2b(0x0010, &feature->feature_data[4]); /* DVD-ROM */
10412 feature->feature_data[6] = 0x01;
10413 feature = (struct scsi_get_config_feature *)
10414 &feature->feature_data[feature->add_length];
10417 scsi_ulto2b(0x0001, feature->feature_code);
10418 feature->flags = 0x08 | SGC_F_PERSISTENT | SGC_F_CURRENT;
10419 feature->add_length = 8;
10420 scsi_ulto4b(0x00000000, &feature->feature_data[0]);
10421 feature->feature_data[4] = 0x03;
10422 feature = (struct scsi_get_config_feature *)
10423 &feature->feature_data[feature->add_length];
10426 scsi_ulto2b(0x0002, feature->feature_code);
10427 feature->flags = 0x04 | SGC_F_PERSISTENT | SGC_F_CURRENT;
10428 feature->add_length = 4;
10429 feature->feature_data[0] = 0x02;
10430 feature = (struct scsi_get_config_feature *)
10431 &feature->feature_data[feature->add_length];
10433 f3: /* Removable Medium */
10434 scsi_ulto2b(0x0003, feature->feature_code);
10435 feature->flags = 0x04 | SGC_F_PERSISTENT | SGC_F_CURRENT;
10436 feature->add_length = 4;
10437 feature->feature_data[0] = 0x39;
10438 feature = (struct scsi_get_config_feature *)
10439 &feature->feature_data[feature->add_length];
10441 if (rt == SGC_RT_CURRENT && (lun->flags & CTL_LUN_NO_MEDIA))
10444 f10: /* Random Read */
10445 scsi_ulto2b(0x0010, feature->feature_code);
10446 feature->flags = 0x00;
10447 if ((lun->flags & CTL_LUN_NO_MEDIA) == 0)
10448 feature->flags |= SGC_F_CURRENT;
10449 feature->add_length = 8;
10450 scsi_ulto4b(lun->be_lun->blocksize, &feature->feature_data[0]);
10451 scsi_ulto2b(1, &feature->feature_data[4]);
10452 feature->feature_data[6] = 0x00;
10453 feature = (struct scsi_get_config_feature *)
10454 &feature->feature_data[feature->add_length];
10456 f1d: /* Multi-Read */
10457 scsi_ulto2b(0x001D, feature->feature_code);
10458 feature->flags = 0x00;
10459 if ((lun->flags & CTL_LUN_NO_MEDIA) == 0)
10460 feature->flags |= SGC_F_CURRENT;
10461 feature->add_length = 0;
10462 feature = (struct scsi_get_config_feature *)
10463 &feature->feature_data[feature->add_length];
10466 scsi_ulto2b(0x001E, feature->feature_code);
10467 feature->flags = 0x00;
10468 if ((lun->flags & CTL_LUN_NO_MEDIA) == 0)
10469 feature->flags |= SGC_F_CURRENT;
10470 feature->add_length = 4;
10471 feature->feature_data[0] = 0x00;
10472 feature = (struct scsi_get_config_feature *)
10473 &feature->feature_data[feature->add_length];
10475 f1f: /* DVD Read */
10476 scsi_ulto2b(0x001F, feature->feature_code);
10477 feature->flags = 0x08;
10478 if ((lun->flags & CTL_LUN_NO_MEDIA) == 0)
10479 feature->flags |= SGC_F_CURRENT;
10480 feature->add_length = 4;
10481 feature->feature_data[0] = 0x01;
10482 feature->feature_data[2] = 0x03;
10483 feature = (struct scsi_get_config_feature *)
10484 &feature->feature_data[feature->add_length];
10487 scsi_ulto2b(0x002A, feature->feature_code);
10488 feature->flags = 0x04;
10489 if ((lun->flags & CTL_LUN_NO_MEDIA) == 0)
10490 feature->flags |= SGC_F_CURRENT;
10491 feature->add_length = 4;
10492 feature->feature_data[0] = 0x00;
10493 feature->feature_data[1] = 0x00;
10494 feature = (struct scsi_get_config_feature *)
10495 &feature->feature_data[feature->add_length];
10498 scsi_ulto2b(0x002B, feature->feature_code);
10499 feature->flags = 0x00;
10500 if ((lun->flags & CTL_LUN_NO_MEDIA) == 0)
10501 feature->flags |= SGC_F_CURRENT;
10502 feature->add_length = 4;
10503 feature->feature_data[0] = 0x00;
10504 feature = (struct scsi_get_config_feature *)
10505 &feature->feature_data[feature->add_length];
10507 f3a: /* DVD+RW Dual Layer */
10508 scsi_ulto2b(0x003A, feature->feature_code);
10509 feature->flags = 0x00;
10510 if ((lun->flags & CTL_LUN_NO_MEDIA) == 0)
10511 feature->flags |= SGC_F_CURRENT;
10512 feature->add_length = 4;
10513 feature->feature_data[0] = 0x00;
10514 feature->feature_data[1] = 0x00;
10515 feature = (struct scsi_get_config_feature *)
10516 &feature->feature_data[feature->add_length];
10518 f3b: /* DVD+R Dual Layer */
10519 scsi_ulto2b(0x003B, feature->feature_code);
10520 feature->flags = 0x00;
10521 if ((lun->flags & CTL_LUN_NO_MEDIA) == 0)
10522 feature->flags |= SGC_F_CURRENT;
10523 feature->add_length = 4;
10524 feature->feature_data[0] = 0x00;
10525 feature = (struct scsi_get_config_feature *)
10526 &feature->feature_data[feature->add_length];
10529 data_len = (uint8_t *)feature - (uint8_t *)hdr;
10530 if (rt == SGC_RT_SPECIFIC && data_len > 4) {
10531 feature = (struct scsi_get_config_feature *)(hdr + 1);
10532 if (scsi_2btoul(feature->feature_code) == starting)
10533 feature = (struct scsi_get_config_feature *)
10534 &feature->feature_data[feature->add_length];
10535 data_len = (uint8_t *)feature - (uint8_t *)hdr;
10537 scsi_ulto4b(data_len - 4, hdr->data_length);
10538 if (data_len < alloc_len) {
10539 ctsio->residual = alloc_len - data_len;
10540 ctsio->kern_data_len = data_len;
10541 ctsio->kern_total_len = data_len;
10543 ctsio->residual = 0;
10544 ctsio->kern_data_len = alloc_len;
10545 ctsio->kern_total_len = alloc_len;
10548 ctl_set_success(ctsio);
10549 ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
10550 ctsio->be_move_done = ctl_config_move_done;
10551 ctl_datamove((union ctl_io *)ctsio);
10552 return (CTL_RETVAL_COMPLETE);
10556 ctl_get_event_status(struct ctl_scsiio *ctsio)
10558 struct scsi_get_event_status_header *hdr;
10559 struct scsi_get_event_status *cdb;
10560 struct ctl_lun *lun;
10561 uint32_t alloc_len, data_len;
10564 lun = ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
10565 cdb = (struct scsi_get_event_status *)ctsio->cdb;
10566 if ((cdb->byte2 & SGESN_POLLED) == 0) {
10567 ctl_set_invalid_field(ctsio, /*sks_valid*/ 1, /*command*/ 1,
10568 /*field*/ 1, /*bit_valid*/ 1, /*bit*/ 0);
10569 ctl_done((union ctl_io *)ctsio);
10570 return (CTL_RETVAL_COMPLETE);
10572 notif_class = cdb->notif_class;
10573 alloc_len = scsi_2btoul(cdb->length);
10575 data_len = sizeof(struct scsi_get_event_status_header);
10576 ctsio->kern_data_ptr = malloc(data_len, M_CTL, M_WAITOK | M_ZERO);
10577 ctsio->kern_sg_entries = 0;
10578 ctsio->kern_data_resid = 0;
10579 ctsio->kern_rel_offset = 0;
10581 if (data_len < alloc_len) {
10582 ctsio->residual = alloc_len - data_len;
10583 ctsio->kern_data_len = data_len;
10584 ctsio->kern_total_len = data_len;
10586 ctsio->residual = 0;
10587 ctsio->kern_data_len = alloc_len;
10588 ctsio->kern_total_len = alloc_len;
10591 hdr = (struct scsi_get_event_status_header *)ctsio->kern_data_ptr;
10592 scsi_ulto2b(0, hdr->descr_length);
10593 hdr->nea_class = SGESN_NEA;
10594 hdr->supported_class = 0;
10596 ctl_set_success(ctsio);
10597 ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
10598 ctsio->be_move_done = ctl_config_move_done;
10599 ctl_datamove((union ctl_io *)ctsio);
10600 return (CTL_RETVAL_COMPLETE);
10604 ctl_mechanism_status(struct ctl_scsiio *ctsio)
10606 struct scsi_mechanism_status_header *hdr;
10607 struct scsi_mechanism_status *cdb;
10608 struct ctl_lun *lun;
10609 uint32_t alloc_len, data_len;
10611 lun = ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
10612 cdb = (struct scsi_mechanism_status *)ctsio->cdb;
10613 alloc_len = scsi_2btoul(cdb->length);
10615 data_len = sizeof(struct scsi_mechanism_status_header);
10616 ctsio->kern_data_ptr = malloc(data_len, M_CTL, M_WAITOK | M_ZERO);
10617 ctsio->kern_sg_entries = 0;
10618 ctsio->kern_data_resid = 0;
10619 ctsio->kern_rel_offset = 0;
10621 if (data_len < alloc_len) {
10622 ctsio->residual = alloc_len - data_len;
10623 ctsio->kern_data_len = data_len;
10624 ctsio->kern_total_len = data_len;
10626 ctsio->residual = 0;
10627 ctsio->kern_data_len = alloc_len;
10628 ctsio->kern_total_len = alloc_len;
10631 hdr = (struct scsi_mechanism_status_header *)ctsio->kern_data_ptr;
10632 hdr->state1 = 0x00;
10633 hdr->state2 = 0xe0;
10634 scsi_ulto3b(0, hdr->lba);
10635 hdr->slots_num = 0;
10636 scsi_ulto2b(0, hdr->slots_length);
10638 ctl_set_success(ctsio);
10639 ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
10640 ctsio->be_move_done = ctl_config_move_done;
10641 ctl_datamove((union ctl_io *)ctsio);
10642 return (CTL_RETVAL_COMPLETE);
10646 ctl_ultomsf(uint32_t lba, uint8_t *buf)
10651 buf[1] = bin2bcd((lba / 75) / 60);
10652 buf[2] = bin2bcd((lba / 75) % 60);
10653 buf[3] = bin2bcd(lba % 75);
10657 ctl_read_toc(struct ctl_scsiio *ctsio)
10659 struct scsi_read_toc_hdr *hdr;
10660 struct scsi_read_toc_type01_descr *descr;
10661 struct scsi_read_toc *cdb;
10662 struct ctl_lun *lun;
10663 uint32_t alloc_len, data_len;
10666 lun = ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
10667 cdb = (struct scsi_read_toc *)ctsio->cdb;
10668 msf = (cdb->byte2 & CD_MSF) != 0;
10669 format = cdb->format;
10670 alloc_len = scsi_2btoul(cdb->data_len);
10672 data_len = sizeof(struct scsi_read_toc_hdr);
10674 data_len += 2 * sizeof(struct scsi_read_toc_type01_descr);
10676 data_len += sizeof(struct scsi_read_toc_type01_descr);
10677 ctsio->kern_data_ptr = malloc(data_len, M_CTL, M_WAITOK | M_ZERO);
10678 ctsio->kern_sg_entries = 0;
10679 ctsio->kern_data_resid = 0;
10680 ctsio->kern_rel_offset = 0;
10682 if (data_len < alloc_len) {
10683 ctsio->residual = alloc_len - data_len;
10684 ctsio->kern_data_len = data_len;
10685 ctsio->kern_total_len = data_len;
10687 ctsio->residual = 0;
10688 ctsio->kern_data_len = alloc_len;
10689 ctsio->kern_total_len = alloc_len;
10692 hdr = (struct scsi_read_toc_hdr *)ctsio->kern_data_ptr;
10694 scsi_ulto2b(0x12, hdr->data_length);
10697 descr = (struct scsi_read_toc_type01_descr *)(hdr + 1);
10698 descr->addr_ctl = 0x14;
10699 descr->track_number = 1;
10701 ctl_ultomsf(0, descr->track_start);
10703 scsi_ulto4b(0, descr->track_start);
10705 descr->addr_ctl = 0x14;
10706 descr->track_number = 0xaa;
10708 ctl_ultomsf(lun->be_lun->maxlba+1, descr->track_start);
10710 scsi_ulto4b(lun->be_lun->maxlba+1, descr->track_start);
10712 scsi_ulto2b(0x0a, hdr->data_length);
10715 descr = (struct scsi_read_toc_type01_descr *)(hdr + 1);
10716 descr->addr_ctl = 0x14;
10717 descr->track_number = 1;
10719 ctl_ultomsf(0, descr->track_start);
10721 scsi_ulto4b(0, descr->track_start);
10724 ctl_set_success(ctsio);
10725 ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
10726 ctsio->be_move_done = ctl_config_move_done;
10727 ctl_datamove((union ctl_io *)ctsio);
10728 return (CTL_RETVAL_COMPLETE);
10732 * For known CDB types, parse the LBA and length.
10735 ctl_get_lba_len(union ctl_io *io, uint64_t *lba, uint64_t *len)
10737 if (io->io_hdr.io_type != CTL_IO_SCSI)
10740 switch (io->scsiio.cdb[0]) {
10741 case COMPARE_AND_WRITE: {
10742 struct scsi_compare_and_write *cdb;
10744 cdb = (struct scsi_compare_and_write *)io->scsiio.cdb;
10746 *lba = scsi_8btou64(cdb->addr);
10747 *len = cdb->length;
10752 struct scsi_rw_6 *cdb;
10754 cdb = (struct scsi_rw_6 *)io->scsiio.cdb;
10756 *lba = scsi_3btoul(cdb->addr);
10757 /* only 5 bits are valid in the most significant address byte */
10759 *len = cdb->length;
10764 struct scsi_rw_10 *cdb;
10766 cdb = (struct scsi_rw_10 *)io->scsiio.cdb;
10768 *lba = scsi_4btoul(cdb->addr);
10769 *len = scsi_2btoul(cdb->length);
10772 case WRITE_VERIFY_10: {
10773 struct scsi_write_verify_10 *cdb;
10775 cdb = (struct scsi_write_verify_10 *)io->scsiio.cdb;
10777 *lba = scsi_4btoul(cdb->addr);
10778 *len = scsi_2btoul(cdb->length);
10783 struct scsi_rw_12 *cdb;
10785 cdb = (struct scsi_rw_12 *)io->scsiio.cdb;
10787 *lba = scsi_4btoul(cdb->addr);
10788 *len = scsi_4btoul(cdb->length);
10791 case WRITE_VERIFY_12: {
10792 struct scsi_write_verify_12 *cdb;
10794 cdb = (struct scsi_write_verify_12 *)io->scsiio.cdb;
10796 *lba = scsi_4btoul(cdb->addr);
10797 *len = scsi_4btoul(cdb->length);
10802 struct scsi_rw_16 *cdb;
10804 cdb = (struct scsi_rw_16 *)io->scsiio.cdb;
10806 *lba = scsi_8btou64(cdb->addr);
10807 *len = scsi_4btoul(cdb->length);
10810 case WRITE_ATOMIC_16: {
10811 struct scsi_write_atomic_16 *cdb;
10813 cdb = (struct scsi_write_atomic_16 *)io->scsiio.cdb;
10815 *lba = scsi_8btou64(cdb->addr);
10816 *len = scsi_2btoul(cdb->length);
10819 case WRITE_VERIFY_16: {
10820 struct scsi_write_verify_16 *cdb;
10822 cdb = (struct scsi_write_verify_16 *)io->scsiio.cdb;
10824 *lba = scsi_8btou64(cdb->addr);
10825 *len = scsi_4btoul(cdb->length);
10828 case WRITE_SAME_10: {
10829 struct scsi_write_same_10 *cdb;
10831 cdb = (struct scsi_write_same_10 *)io->scsiio.cdb;
10833 *lba = scsi_4btoul(cdb->addr);
10834 *len = scsi_2btoul(cdb->length);
10837 case WRITE_SAME_16: {
10838 struct scsi_write_same_16 *cdb;
10840 cdb = (struct scsi_write_same_16 *)io->scsiio.cdb;
10842 *lba = scsi_8btou64(cdb->addr);
10843 *len = scsi_4btoul(cdb->length);
10847 struct scsi_verify_10 *cdb;
10849 cdb = (struct scsi_verify_10 *)io->scsiio.cdb;
10851 *lba = scsi_4btoul(cdb->addr);
10852 *len = scsi_2btoul(cdb->length);
10856 struct scsi_verify_12 *cdb;
10858 cdb = (struct scsi_verify_12 *)io->scsiio.cdb;
10860 *lba = scsi_4btoul(cdb->addr);
10861 *len = scsi_4btoul(cdb->length);
10865 struct scsi_verify_16 *cdb;
10867 cdb = (struct scsi_verify_16 *)io->scsiio.cdb;
10869 *lba = scsi_8btou64(cdb->addr);
10870 *len = scsi_4btoul(cdb->length);
10878 case SERVICE_ACTION_IN: { /* GET LBA STATUS */
10879 struct scsi_get_lba_status *cdb;
10881 cdb = (struct scsi_get_lba_status *)io->scsiio.cdb;
10882 *lba = scsi_8btou64(cdb->addr);
10888 break; /* NOTREACHED */
10895 ctl_extent_check_lba(uint64_t lba1, uint64_t len1, uint64_t lba2, uint64_t len2,
10898 uint64_t endlba1, endlba2;
10900 endlba1 = lba1 + len1 - (seq ? 0 : 1);
10901 endlba2 = lba2 + len2 - 1;
10903 if ((endlba1 < lba2) || (endlba2 < lba1))
10904 return (CTL_ACTION_PASS);
10906 return (CTL_ACTION_BLOCK);
10910 ctl_extent_check_unmap(union ctl_io *io, uint64_t lba2, uint64_t len2)
10912 struct ctl_ptr_len_flags *ptrlen;
10913 struct scsi_unmap_desc *buf, *end, *range;
10917 /* If not UNMAP -- go other way. */
10918 if (io->io_hdr.io_type != CTL_IO_SCSI ||
10919 io->scsiio.cdb[0] != UNMAP)
10920 return (CTL_ACTION_ERROR);
10922 /* If UNMAP without data -- block and wait for data. */
10923 ptrlen = (struct ctl_ptr_len_flags *)
10924 &io->io_hdr.ctl_private[CTL_PRIV_LBA_LEN];
10925 if ((io->io_hdr.flags & CTL_FLAG_ALLOCATED) == 0 ||
10926 ptrlen->ptr == NULL)
10927 return (CTL_ACTION_BLOCK);
10929 /* UNMAP with data -- check for collision. */
10930 buf = (struct scsi_unmap_desc *)ptrlen->ptr;
10931 end = buf + ptrlen->len / sizeof(*buf);
10932 for (range = buf; range < end; range++) {
10933 lba = scsi_8btou64(range->lba);
10934 len = scsi_4btoul(range->length);
10935 if ((lba < lba2 + len2) && (lba + len > lba2))
10936 return (CTL_ACTION_BLOCK);
10938 return (CTL_ACTION_PASS);
10942 ctl_extent_check(union ctl_io *io1, union ctl_io *io2, bool seq)
10944 uint64_t lba1, lba2;
10945 uint64_t len1, len2;
10948 if (ctl_get_lba_len(io2, &lba2, &len2) != 0)
10949 return (CTL_ACTION_ERROR);
10951 retval = ctl_extent_check_unmap(io1, lba2, len2);
10952 if (retval != CTL_ACTION_ERROR)
10955 if (ctl_get_lba_len(io1, &lba1, &len1) != 0)
10956 return (CTL_ACTION_ERROR);
10958 if (io1->io_hdr.flags & CTL_FLAG_SERSEQ_DONE)
10960 return (ctl_extent_check_lba(lba1, len1, lba2, len2, seq));
10964 ctl_extent_check_seq(union ctl_io *io1, union ctl_io *io2)
10966 uint64_t lba1, lba2;
10967 uint64_t len1, len2;
10969 if (io1->io_hdr.flags & CTL_FLAG_SERSEQ_DONE)
10970 return (CTL_ACTION_PASS);
10971 if (ctl_get_lba_len(io1, &lba1, &len1) != 0)
10972 return (CTL_ACTION_ERROR);
10973 if (ctl_get_lba_len(io2, &lba2, &len2) != 0)
10974 return (CTL_ACTION_ERROR);
10976 if (lba1 + len1 == lba2)
10977 return (CTL_ACTION_BLOCK);
10978 return (CTL_ACTION_PASS);
10982 ctl_check_for_blockage(struct ctl_lun *lun, union ctl_io *pending_io,
10983 union ctl_io *ooa_io)
10985 const struct ctl_cmd_entry *pending_entry, *ooa_entry;
10986 const ctl_serialize_action *serialize_row;
10989 * The initiator attempted multiple untagged commands at the same
10990 * time. Can't do that.
10992 if ((pending_io->scsiio.tag_type == CTL_TAG_UNTAGGED)
10993 && (ooa_io->scsiio.tag_type == CTL_TAG_UNTAGGED)
10994 && ((pending_io->io_hdr.nexus.targ_port ==
10995 ooa_io->io_hdr.nexus.targ_port)
10996 && (pending_io->io_hdr.nexus.initid ==
10997 ooa_io->io_hdr.nexus.initid))
10998 && ((ooa_io->io_hdr.flags & (CTL_FLAG_ABORT |
10999 CTL_FLAG_STATUS_SENT)) == 0))
11000 return (CTL_ACTION_OVERLAP);
11003 * The initiator attempted to send multiple tagged commands with
11004 * the same ID. (It's fine if different initiators have the same
11007 * Even if all of those conditions are true, we don't kill the I/O
11008 * if the command ahead of us has been aborted. We won't end up
11009 * sending it to the FETD, and it's perfectly legal to resend a
11010 * command with the same tag number as long as the previous
11011 * instance of this tag number has been aborted somehow.
11013 if ((pending_io->scsiio.tag_type != CTL_TAG_UNTAGGED)
11014 && (ooa_io->scsiio.tag_type != CTL_TAG_UNTAGGED)
11015 && (pending_io->scsiio.tag_num == ooa_io->scsiio.tag_num)
11016 && ((pending_io->io_hdr.nexus.targ_port ==
11017 ooa_io->io_hdr.nexus.targ_port)
11018 && (pending_io->io_hdr.nexus.initid ==
11019 ooa_io->io_hdr.nexus.initid))
11020 && ((ooa_io->io_hdr.flags & (CTL_FLAG_ABORT |
11021 CTL_FLAG_STATUS_SENT)) == 0))
11022 return (CTL_ACTION_OVERLAP_TAG);
11025 * If we get a head of queue tag, SAM-3 says that we should
11026 * immediately execute it.
11028 * What happens if this command would normally block for some other
11029 * reason? e.g. a request sense with a head of queue tag
11030 * immediately after a write. Normally that would block, but this
11031 * will result in its getting executed immediately...
11033 * We currently return "pass" instead of "skip", so we'll end up
11034 * going through the rest of the queue to check for overlapped tags.
11036 * XXX KDM check for other types of blockage first??
11038 if (pending_io->scsiio.tag_type == CTL_TAG_HEAD_OF_QUEUE)
11039 return (CTL_ACTION_PASS);
11042 * Ordered tags have to block until all items ahead of them
11043 * have completed. If we get called with an ordered tag, we always
11044 * block, if something else is ahead of us in the queue.
11046 if (pending_io->scsiio.tag_type == CTL_TAG_ORDERED)
11047 return (CTL_ACTION_BLOCK);
11050 * Simple tags get blocked until all head of queue and ordered tags
11051 * ahead of them have completed. I'm lumping untagged commands in
11052 * with simple tags here. XXX KDM is that the right thing to do?
11054 if (((pending_io->scsiio.tag_type == CTL_TAG_UNTAGGED)
11055 || (pending_io->scsiio.tag_type == CTL_TAG_SIMPLE))
11056 && ((ooa_io->scsiio.tag_type == CTL_TAG_HEAD_OF_QUEUE)
11057 || (ooa_io->scsiio.tag_type == CTL_TAG_ORDERED)))
11058 return (CTL_ACTION_BLOCK);
11060 pending_entry = ctl_get_cmd_entry(&pending_io->scsiio, NULL);
11061 KASSERT(pending_entry->seridx < CTL_SERIDX_COUNT,
11062 ("%s: Invalid seridx %d for pending CDB %02x %02x @ %p",
11063 __func__, pending_entry->seridx, pending_io->scsiio.cdb[0],
11064 pending_io->scsiio.cdb[1], pending_io));
11065 ooa_entry = ctl_get_cmd_entry(&ooa_io->scsiio, NULL);
11066 if (ooa_entry->seridx == CTL_SERIDX_INVLD)
11067 return (CTL_ACTION_PASS); /* Unsupported command in OOA queue */
11068 KASSERT(ooa_entry->seridx < CTL_SERIDX_COUNT,
11069 ("%s: Invalid seridx %d for ooa CDB %02x %02x @ %p",
11070 __func__, ooa_entry->seridx, ooa_io->scsiio.cdb[0],
11071 ooa_io->scsiio.cdb[1], ooa_io));
11073 serialize_row = ctl_serialize_table[ooa_entry->seridx];
11075 switch (serialize_row[pending_entry->seridx]) {
11076 case CTL_SER_BLOCK:
11077 return (CTL_ACTION_BLOCK);
11078 case CTL_SER_EXTENT:
11079 return (ctl_extent_check(ooa_io, pending_io,
11080 (lun->be_lun && lun->be_lun->serseq == CTL_LUN_SERSEQ_ON)));
11081 case CTL_SER_EXTENTOPT:
11082 if ((lun->MODE_CTRL.queue_flags & SCP_QUEUE_ALG_MASK) !=
11083 SCP_QUEUE_ALG_UNRESTRICTED)
11084 return (ctl_extent_check(ooa_io, pending_io,
11086 lun->be_lun->serseq == CTL_LUN_SERSEQ_ON)));
11087 return (CTL_ACTION_PASS);
11088 case CTL_SER_EXTENTSEQ:
11089 if (lun->be_lun && lun->be_lun->serseq != CTL_LUN_SERSEQ_OFF)
11090 return (ctl_extent_check_seq(ooa_io, pending_io));
11091 return (CTL_ACTION_PASS);
11093 return (CTL_ACTION_PASS);
11094 case CTL_SER_BLOCKOPT:
11095 if ((lun->MODE_CTRL.queue_flags & SCP_QUEUE_ALG_MASK) !=
11096 SCP_QUEUE_ALG_UNRESTRICTED)
11097 return (CTL_ACTION_BLOCK);
11098 return (CTL_ACTION_PASS);
11100 return (CTL_ACTION_SKIP);
11102 panic("%s: Invalid serialization value %d for %d => %d",
11103 __func__, serialize_row[pending_entry->seridx],
11104 pending_entry->seridx, ooa_entry->seridx);
11107 return (CTL_ACTION_ERROR);
11111 * Check for blockage or overlaps against the OOA (Order Of Arrival) queue.
11113 * - pending_io is generally either incoming, or on the blocked queue
11114 * - starting I/O is the I/O we want to start the check with.
11117 ctl_check_ooa(struct ctl_lun *lun, union ctl_io *pending_io,
11118 union ctl_io *starting_io)
11120 union ctl_io *ooa_io;
11123 mtx_assert(&lun->lun_lock, MA_OWNED);
11126 * Run back along the OOA queue, starting with the current
11127 * blocked I/O and going through every I/O before it on the
11128 * queue. If starting_io is NULL, we'll just end up returning
11131 for (ooa_io = starting_io; ooa_io != NULL;
11132 ooa_io = (union ctl_io *)TAILQ_PREV(&ooa_io->io_hdr, ctl_ooaq,
11136 * This routine just checks to see whether
11137 * cur_blocked is blocked by ooa_io, which is ahead
11138 * of it in the queue. It doesn't queue/dequeue
11141 action = ctl_check_for_blockage(lun, pending_io, ooa_io);
11143 case CTL_ACTION_BLOCK:
11144 case CTL_ACTION_OVERLAP:
11145 case CTL_ACTION_OVERLAP_TAG:
11146 case CTL_ACTION_SKIP:
11147 case CTL_ACTION_ERROR:
11149 break; /* NOTREACHED */
11150 case CTL_ACTION_PASS:
11153 panic("%s: Invalid action %d\n", __func__, action);
11157 return (CTL_ACTION_PASS);
11162 * - An I/O has just completed, and has been removed from the per-LUN OOA
11163 * queue, so some items on the blocked queue may now be unblocked.
11166 ctl_check_blocked(struct ctl_lun *lun)
11168 struct ctl_softc *softc = lun->ctl_softc;
11169 union ctl_io *cur_blocked, *next_blocked;
11171 mtx_assert(&lun->lun_lock, MA_OWNED);
11174 * Run forward from the head of the blocked queue, checking each
11175 * entry against the I/Os prior to it on the OOA queue to see if
11176 * there is still any blockage.
11178 * We cannot use the TAILQ_FOREACH() macro, because it can't deal
11179 * with our removing a variable on it while it is traversing the
11182 for (cur_blocked = (union ctl_io *)TAILQ_FIRST(&lun->blocked_queue);
11183 cur_blocked != NULL; cur_blocked = next_blocked) {
11184 union ctl_io *prev_ooa;
11187 next_blocked = (union ctl_io *)TAILQ_NEXT(&cur_blocked->io_hdr,
11190 prev_ooa = (union ctl_io *)TAILQ_PREV(&cur_blocked->io_hdr,
11191 ctl_ooaq, ooa_links);
11194 * If cur_blocked happens to be the first item in the OOA
11195 * queue now, prev_ooa will be NULL, and the action
11196 * returned will just be CTL_ACTION_PASS.
11198 action = ctl_check_ooa(lun, cur_blocked, prev_ooa);
11201 case CTL_ACTION_BLOCK:
11202 /* Nothing to do here, still blocked */
11204 case CTL_ACTION_OVERLAP:
11205 case CTL_ACTION_OVERLAP_TAG:
11207 * This shouldn't happen! In theory we've already
11208 * checked this command for overlap...
11211 case CTL_ACTION_PASS:
11212 case CTL_ACTION_SKIP: {
11213 const struct ctl_cmd_entry *entry;
11216 * The skip case shouldn't happen, this transaction
11217 * should have never made it onto the blocked queue.
11220 * This I/O is no longer blocked, we can remove it
11221 * from the blocked queue. Since this is a TAILQ
11222 * (doubly linked list), we can do O(1) removals
11223 * from any place on the list.
11225 TAILQ_REMOVE(&lun->blocked_queue, &cur_blocked->io_hdr,
11227 cur_blocked->io_hdr.flags &= ~CTL_FLAG_BLOCKED;
11229 if ((softc->ha_mode != CTL_HA_MODE_XFER) &&
11230 (cur_blocked->io_hdr.flags & CTL_FLAG_FROM_OTHER_SC)){
11232 * Need to send IO back to original side to
11235 union ctl_ha_msg msg_info;
11237 cur_blocked->io_hdr.flags &= ~CTL_FLAG_IO_ACTIVE;
11238 msg_info.hdr.original_sc =
11239 cur_blocked->io_hdr.original_sc;
11240 msg_info.hdr.serializing_sc = cur_blocked;
11241 msg_info.hdr.msg_type = CTL_MSG_R2R;
11242 ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg_info,
11243 sizeof(msg_info.hdr), M_NOWAIT);
11246 entry = ctl_get_cmd_entry(&cur_blocked->scsiio, NULL);
11249 * Check this I/O for LUN state changes that may
11250 * have happened while this command was blocked.
11251 * The LUN state may have been changed by a command
11252 * ahead of us in the queue, so we need to re-check
11253 * for any states that can be caused by SCSI
11256 if (ctl_scsiio_lun_check(lun, entry,
11257 &cur_blocked->scsiio) == 0) {
11258 cur_blocked->io_hdr.flags |=
11259 CTL_FLAG_IS_WAS_ON_RTR;
11260 ctl_enqueue_rtr(cur_blocked);
11262 ctl_done(cur_blocked);
11267 * This probably shouldn't happen -- we shouldn't
11268 * get CTL_ACTION_ERROR, or anything else.
11274 return (CTL_RETVAL_COMPLETE);
11278 * This routine (with one exception) checks LUN flags that can be set by
11279 * commands ahead of us in the OOA queue. These flags have to be checked
11280 * when a command initially comes in, and when we pull a command off the
11281 * blocked queue and are preparing to execute it. The reason we have to
11282 * check these flags for commands on the blocked queue is that the LUN
11283 * state may have been changed by a command ahead of us while we're on the
11286 * Ordering is somewhat important with these checks, so please pay
11287 * careful attention to the placement of any new checks.
11290 ctl_scsiio_lun_check(struct ctl_lun *lun,
11291 const struct ctl_cmd_entry *entry, struct ctl_scsiio *ctsio)
11293 struct ctl_softc *softc = lun->ctl_softc;
11299 mtx_assert(&lun->lun_lock, MA_OWNED);
11302 * If this shelf is a secondary shelf controller, we may have to
11303 * reject some commands disallowed by HA mode and link state.
11305 if ((lun->flags & CTL_LUN_PRIMARY_SC) == 0) {
11306 if (softc->ha_link == CTL_HA_LINK_OFFLINE &&
11307 (entry->flags & CTL_CMD_FLAG_OK_ON_UNAVAIL) == 0) {
11308 ctl_set_lun_unavail(ctsio);
11312 if ((lun->flags & CTL_LUN_PEER_SC_PRIMARY) == 0 &&
11313 (entry->flags & CTL_CMD_FLAG_OK_ON_UNAVAIL) == 0) {
11314 ctl_set_lun_transit(ctsio);
11318 if (softc->ha_mode == CTL_HA_MODE_ACT_STBY &&
11319 (entry->flags & CTL_CMD_FLAG_OK_ON_STANDBY) == 0) {
11320 ctl_set_lun_standby(ctsio);
11325 /* The rest of checks are only done on executing side */
11326 if (softc->ha_mode == CTL_HA_MODE_XFER)
11330 if (entry->pattern & CTL_LUN_PAT_WRITE) {
11332 lun->be_lun->flags & CTL_LUN_FLAG_READONLY) {
11333 ctl_set_hw_write_protected(ctsio);
11337 if ((lun->MODE_CTRL.eca_and_aen & SCP_SWP) != 0) {
11338 ctl_set_sense(ctsio, /*current_error*/ 1,
11339 /*sense_key*/ SSD_KEY_DATA_PROTECT,
11340 /*asc*/ 0x27, /*ascq*/ 0x02, SSD_ELEM_NONE);
11347 * Check for a reservation conflict. If this command isn't allowed
11348 * even on reserved LUNs, and if this initiator isn't the one who
11349 * reserved us, reject the command with a reservation conflict.
11351 residx = ctl_get_initindex(&ctsio->io_hdr.nexus);
11352 if ((lun->flags & CTL_LUN_RESERVED)
11353 && ((entry->flags & CTL_CMD_FLAG_ALLOW_ON_RESV) == 0)) {
11354 if (lun->res_idx != residx) {
11355 ctl_set_reservation_conflict(ctsio);
11361 if ((lun->flags & CTL_LUN_PR_RESERVED) == 0 ||
11362 (entry->flags & CTL_CMD_FLAG_ALLOW_ON_PR_RESV)) {
11363 /* No reservation or command is allowed. */;
11364 } else if ((entry->flags & CTL_CMD_FLAG_ALLOW_ON_PR_WRESV) &&
11365 (lun->pr_res_type == SPR_TYPE_WR_EX ||
11366 lun->pr_res_type == SPR_TYPE_WR_EX_RO ||
11367 lun->pr_res_type == SPR_TYPE_WR_EX_AR)) {
11368 /* The command is allowed for Write Exclusive resv. */;
11371 * if we aren't registered or it's a res holder type
11372 * reservation and this isn't the res holder then set a
11375 if (ctl_get_prkey(lun, residx) == 0 ||
11376 (residx != lun->pr_res_idx && lun->pr_res_type < 4)) {
11377 ctl_set_reservation_conflict(ctsio);
11383 if ((entry->flags & CTL_CMD_FLAG_OK_ON_NO_MEDIA) == 0) {
11384 if (lun->flags & CTL_LUN_EJECTED)
11385 ctl_set_lun_ejected(ctsio);
11386 else if (lun->flags & CTL_LUN_NO_MEDIA) {
11387 if (lun->flags & CTL_LUN_REMOVABLE)
11388 ctl_set_lun_no_media(ctsio);
11390 ctl_set_lun_int_reqd(ctsio);
11391 } else if (lun->flags & CTL_LUN_STOPPED)
11392 ctl_set_lun_stopped(ctsio);
11404 ctl_failover_io(union ctl_io *io, int have_lock)
11406 ctl_set_busy(&io->scsiio);
11411 ctl_failover_lun(union ctl_io *rio)
11413 struct ctl_softc *softc = control_softc;
11414 struct ctl_lun *lun;
11415 struct ctl_io_hdr *io, *next_io;
11418 targ_lun = rio->io_hdr.nexus.targ_mapped_lun;
11419 CTL_DEBUG_PRINT(("FAILOVER for lun %ju\n", targ_lun));
11421 /* Find and lock the LUN. */
11422 mtx_lock(&softc->ctl_lock);
11423 if ((targ_lun < CTL_MAX_LUNS) &&
11424 ((lun = softc->ctl_luns[targ_lun]) != NULL)) {
11425 mtx_lock(&lun->lun_lock);
11426 mtx_unlock(&softc->ctl_lock);
11427 if (lun->flags & CTL_LUN_DISABLED) {
11428 mtx_unlock(&lun->lun_lock);
11432 mtx_unlock(&softc->ctl_lock);
11436 if (softc->ha_mode == CTL_HA_MODE_XFER) {
11437 TAILQ_FOREACH_SAFE(io, &lun->ooa_queue, ooa_links, next_io) {
11438 /* We are master */
11439 if (io->flags & CTL_FLAG_FROM_OTHER_SC) {
11440 if (io->flags & CTL_FLAG_IO_ACTIVE) {
11441 io->flags |= CTL_FLAG_ABORT;
11442 io->flags |= CTL_FLAG_FAILOVER;
11443 } else { /* This can be only due to DATAMOVE */
11444 io->msg_type = CTL_MSG_DATAMOVE_DONE;
11445 io->flags &= ~CTL_FLAG_DMA_INPROG;
11446 io->flags |= CTL_FLAG_IO_ACTIVE;
11447 io->port_status = 31340;
11448 ctl_enqueue_isc((union ctl_io *)io);
11452 if (io->flags & CTL_FLAG_SENT_2OTHER_SC) {
11453 io->flags &= ~CTL_FLAG_SENT_2OTHER_SC;
11454 if (io->flags & CTL_FLAG_IO_ACTIVE) {
11455 io->flags |= CTL_FLAG_FAILOVER;
11457 ctl_set_busy(&((union ctl_io *)io)->
11459 ctl_done((union ctl_io *)io);
11463 } else { /* SERIALIZE modes */
11464 TAILQ_FOREACH_SAFE(io, &lun->blocked_queue, blocked_links,
11466 /* We are master */
11467 if (io->flags & CTL_FLAG_FROM_OTHER_SC) {
11468 TAILQ_REMOVE(&lun->blocked_queue, io,
11470 io->flags &= ~CTL_FLAG_BLOCKED;
11471 TAILQ_REMOVE(&lun->ooa_queue, io, ooa_links);
11472 ctl_free_io((union ctl_io *)io);
11475 TAILQ_FOREACH_SAFE(io, &lun->ooa_queue, ooa_links, next_io) {
11476 /* We are master */
11477 if (io->flags & CTL_FLAG_FROM_OTHER_SC) {
11478 TAILQ_REMOVE(&lun->ooa_queue, io, ooa_links);
11479 ctl_free_io((union ctl_io *)io);
11482 if (io->flags & CTL_FLAG_SENT_2OTHER_SC) {
11483 io->flags &= ~CTL_FLAG_SENT_2OTHER_SC;
11484 if (!(io->flags & CTL_FLAG_IO_ACTIVE)) {
11485 ctl_set_busy(&((union ctl_io *)io)->
11487 ctl_done((union ctl_io *)io);
11491 ctl_check_blocked(lun);
11493 mtx_unlock(&lun->lun_lock);
11497 ctl_scsiio_precheck(struct ctl_softc *softc, struct ctl_scsiio *ctsio)
11499 struct ctl_lun *lun;
11500 const struct ctl_cmd_entry *entry;
11501 uint32_t initidx, targ_lun;
11508 targ_lun = ctsio->io_hdr.nexus.targ_mapped_lun;
11509 if ((targ_lun < CTL_MAX_LUNS)
11510 && ((lun = softc->ctl_luns[targ_lun]) != NULL)) {
11512 * If the LUN is invalid, pretend that it doesn't exist.
11513 * It will go away as soon as all pending I/O has been
11516 mtx_lock(&lun->lun_lock);
11517 if (lun->flags & CTL_LUN_DISABLED) {
11518 mtx_unlock(&lun->lun_lock);
11520 ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr = NULL;
11521 ctsio->io_hdr.ctl_private[CTL_PRIV_BACKEND_LUN].ptr = NULL;
11523 ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr = lun;
11524 ctsio->io_hdr.ctl_private[CTL_PRIV_BACKEND_LUN].ptr =
11528 * Every I/O goes into the OOA queue for a
11529 * particular LUN, and stays there until completion.
11532 if (TAILQ_EMPTY(&lun->ooa_queue)) {
11533 lun->idle_time += getsbinuptime() -
11537 TAILQ_INSERT_TAIL(&lun->ooa_queue, &ctsio->io_hdr,
11541 ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr = NULL;
11542 ctsio->io_hdr.ctl_private[CTL_PRIV_BACKEND_LUN].ptr = NULL;
11545 /* Get command entry and return error if it is unsuppotyed. */
11546 entry = ctl_validate_command(ctsio);
11547 if (entry == NULL) {
11549 mtx_unlock(&lun->lun_lock);
11553 ctsio->io_hdr.flags &= ~CTL_FLAG_DATA_MASK;
11554 ctsio->io_hdr.flags |= entry->flags & CTL_FLAG_DATA_MASK;
11557 * Check to see whether we can send this command to LUNs that don't
11558 * exist. This should pretty much only be the case for inquiry
11559 * and request sense. Further checks, below, really require having
11560 * a LUN, so we can't really check the command anymore. Just put
11561 * it on the rtr queue.
11564 if (entry->flags & CTL_CMD_FLAG_OK_ON_NO_LUN) {
11565 ctsio->io_hdr.flags |= CTL_FLAG_IS_WAS_ON_RTR;
11566 ctl_enqueue_rtr((union ctl_io *)ctsio);
11570 ctl_set_unsupported_lun(ctsio);
11571 ctl_done((union ctl_io *)ctsio);
11572 CTL_DEBUG_PRINT(("ctl_scsiio_precheck: bailing out due to invalid LUN\n"));
11576 * Make sure we support this particular command on this LUN.
11577 * e.g., we don't support writes to the control LUN.
11579 if (!ctl_cmd_applicable(lun->be_lun->lun_type, entry)) {
11580 mtx_unlock(&lun->lun_lock);
11581 ctl_set_invalid_opcode(ctsio);
11582 ctl_done((union ctl_io *)ctsio);
11587 initidx = ctl_get_initindex(&ctsio->io_hdr.nexus);
11591 * If we've got a request sense, it'll clear the contingent
11592 * allegiance condition. Otherwise, if we have a CA condition for
11593 * this initiator, clear it, because it sent down a command other
11594 * than request sense.
11596 if ((ctsio->cdb[0] != REQUEST_SENSE)
11597 && (ctl_is_set(lun->have_ca, initidx)))
11598 ctl_clear_mask(lun->have_ca, initidx);
11602 * If the command has this flag set, it handles its own unit
11603 * attention reporting, we shouldn't do anything. Otherwise we
11604 * check for any pending unit attentions, and send them back to the
11605 * initiator. We only do this when a command initially comes in,
11606 * not when we pull it off the blocked queue.
11608 * According to SAM-3, section 5.3.2, the order that things get
11609 * presented back to the host is basically unit attentions caused
11610 * by some sort of reset event, busy status, reservation conflicts
11611 * or task set full, and finally any other status.
11613 * One issue here is that some of the unit attentions we report
11614 * don't fall into the "reset" category (e.g. "reported luns data
11615 * has changed"). So reporting it here, before the reservation
11616 * check, may be technically wrong. I guess the only thing to do
11617 * would be to check for and report the reset events here, and then
11618 * check for the other unit attention types after we check for a
11619 * reservation conflict.
11621 * XXX KDM need to fix this
11623 if ((entry->flags & CTL_CMD_FLAG_NO_SENSE) == 0) {
11624 ctl_ua_type ua_type;
11626 ua_type = ctl_build_ua(lun, initidx, &ctsio->sense_data,
11628 if (ua_type != CTL_UA_NONE) {
11629 mtx_unlock(&lun->lun_lock);
11630 ctsio->scsi_status = SCSI_STATUS_CHECK_COND;
11631 ctsio->io_hdr.status = CTL_SCSI_ERROR | CTL_AUTOSENSE;
11632 ctsio->sense_len = SSD_FULL_SIZE;
11633 ctl_done((union ctl_io *)ctsio);
11639 if (ctl_scsiio_lun_check(lun, entry, ctsio) != 0) {
11640 mtx_unlock(&lun->lun_lock);
11641 ctl_done((union ctl_io *)ctsio);
11646 * XXX CHD this is where we want to send IO to other side if
11647 * this LUN is secondary on this SC. We will need to make a copy
11648 * of the IO and flag the IO on this side as SENT_2OTHER and the flag
11649 * the copy we send as FROM_OTHER.
11650 * We also need to stuff the address of the original IO so we can
11651 * find it easily. Something similar will need be done on the other
11652 * side so when we are done we can find the copy.
11654 if ((lun->flags & CTL_LUN_PRIMARY_SC) == 0 &&
11655 (lun->flags & CTL_LUN_PEER_SC_PRIMARY) != 0 &&
11656 (entry->flags & CTL_CMD_FLAG_RUN_HERE) == 0) {
11657 union ctl_ha_msg msg_info;
11660 ctsio->io_hdr.flags |= CTL_FLAG_SENT_2OTHER_SC;
11661 ctsio->io_hdr.flags &= ~CTL_FLAG_IO_ACTIVE;
11662 mtx_unlock(&lun->lun_lock);
11664 msg_info.hdr.msg_type = CTL_MSG_SERIALIZE;
11665 msg_info.hdr.original_sc = (union ctl_io *)ctsio;
11666 msg_info.hdr.serializing_sc = NULL;
11667 msg_info.hdr.nexus = ctsio->io_hdr.nexus;
11668 msg_info.scsi.tag_num = ctsio->tag_num;
11669 msg_info.scsi.tag_type = ctsio->tag_type;
11670 msg_info.scsi.cdb_len = ctsio->cdb_len;
11671 memcpy(msg_info.scsi.cdb, ctsio->cdb, CTL_MAX_CDBLEN);
11673 if ((isc_retval = ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg_info,
11674 sizeof(msg_info.scsi) - sizeof(msg_info.scsi.sense_data),
11675 M_WAITOK)) > CTL_HA_STATUS_SUCCESS) {
11676 ctl_set_busy(ctsio);
11677 ctl_done((union ctl_io *)ctsio);
11683 switch (ctl_check_ooa(lun, (union ctl_io *)ctsio,
11684 (union ctl_io *)TAILQ_PREV(&ctsio->io_hdr,
11685 ctl_ooaq, ooa_links))) {
11686 case CTL_ACTION_BLOCK:
11687 ctsio->io_hdr.flags |= CTL_FLAG_BLOCKED;
11688 TAILQ_INSERT_TAIL(&lun->blocked_queue, &ctsio->io_hdr,
11690 mtx_unlock(&lun->lun_lock);
11692 case CTL_ACTION_PASS:
11693 case CTL_ACTION_SKIP:
11694 ctsio->io_hdr.flags |= CTL_FLAG_IS_WAS_ON_RTR;
11695 mtx_unlock(&lun->lun_lock);
11696 ctl_enqueue_rtr((union ctl_io *)ctsio);
11698 case CTL_ACTION_OVERLAP:
11699 mtx_unlock(&lun->lun_lock);
11700 ctl_set_overlapped_cmd(ctsio);
11701 ctl_done((union ctl_io *)ctsio);
11703 case CTL_ACTION_OVERLAP_TAG:
11704 mtx_unlock(&lun->lun_lock);
11705 ctl_set_overlapped_tag(ctsio, ctsio->tag_num & 0xff);
11706 ctl_done((union ctl_io *)ctsio);
11708 case CTL_ACTION_ERROR:
11710 mtx_unlock(&lun->lun_lock);
11711 ctl_set_internal_failure(ctsio,
11713 /*retry_count*/ 0);
11714 ctl_done((union ctl_io *)ctsio);
11720 const struct ctl_cmd_entry *
11721 ctl_get_cmd_entry(struct ctl_scsiio *ctsio, int *sa)
11723 const struct ctl_cmd_entry *entry;
11724 int service_action;
11726 entry = &ctl_cmd_table[ctsio->cdb[0]];
11728 *sa = ((entry->flags & CTL_CMD_FLAG_SA5) != 0);
11729 if (entry->flags & CTL_CMD_FLAG_SA5) {
11730 service_action = ctsio->cdb[1] & SERVICE_ACTION_MASK;
11731 entry = &((const struct ctl_cmd_entry *)
11732 entry->execute)[service_action];
11737 const struct ctl_cmd_entry *
11738 ctl_validate_command(struct ctl_scsiio *ctsio)
11740 const struct ctl_cmd_entry *entry;
11744 entry = ctl_get_cmd_entry(ctsio, &sa);
11745 if (entry->execute == NULL) {
11747 ctl_set_invalid_field(ctsio,
11754 ctl_set_invalid_opcode(ctsio);
11755 ctl_done((union ctl_io *)ctsio);
11758 KASSERT(entry->length > 0,
11759 ("Not defined length for command 0x%02x/0x%02x",
11760 ctsio->cdb[0], ctsio->cdb[1]));
11761 for (i = 1; i < entry->length; i++) {
11762 diff = ctsio->cdb[i] & ~entry->usage[i - 1];
11765 ctl_set_invalid_field(ctsio,
11770 /*bit*/ fls(diff) - 1);
11771 ctl_done((union ctl_io *)ctsio);
11778 ctl_cmd_applicable(uint8_t lun_type, const struct ctl_cmd_entry *entry)
11781 switch (lun_type) {
11783 if ((entry->flags & CTL_CMD_FLAG_OK_ON_DIRECT) == 0)
11787 if ((entry->flags & CTL_CMD_FLAG_OK_ON_PROC) == 0)
11791 if ((entry->flags & CTL_CMD_FLAG_OK_ON_CDROM) == 0)
11801 ctl_scsiio(struct ctl_scsiio *ctsio)
11804 const struct ctl_cmd_entry *entry;
11806 retval = CTL_RETVAL_COMPLETE;
11808 CTL_DEBUG_PRINT(("ctl_scsiio cdb[0]=%02X\n", ctsio->cdb[0]));
11810 entry = ctl_get_cmd_entry(ctsio, NULL);
11813 * If this I/O has been aborted, just send it straight to
11814 * ctl_done() without executing it.
11816 if (ctsio->io_hdr.flags & CTL_FLAG_ABORT) {
11817 ctl_done((union ctl_io *)ctsio);
11822 * All the checks should have been handled by ctl_scsiio_precheck().
11823 * We should be clear now to just execute the I/O.
11825 retval = entry->execute(ctsio);
11832 * Since we only implement one target right now, a bus reset simply resets
11833 * our single target.
11836 ctl_bus_reset(struct ctl_softc *softc, union ctl_io *io)
11838 return(ctl_target_reset(softc, io, CTL_UA_BUS_RESET));
11842 ctl_target_reset(struct ctl_softc *softc, union ctl_io *io,
11843 ctl_ua_type ua_type)
11845 struct ctl_port *port;
11846 struct ctl_lun *lun;
11849 if (!(io->io_hdr.flags & CTL_FLAG_FROM_OTHER_SC)) {
11850 union ctl_ha_msg msg_info;
11852 msg_info.hdr.nexus = io->io_hdr.nexus;
11853 if (ua_type==CTL_UA_TARG_RESET)
11854 msg_info.task.task_action = CTL_TASK_TARGET_RESET;
11856 msg_info.task.task_action = CTL_TASK_BUS_RESET;
11857 msg_info.hdr.msg_type = CTL_MSG_MANAGE_TASKS;
11858 msg_info.hdr.original_sc = NULL;
11859 msg_info.hdr.serializing_sc = NULL;
11860 ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg_info,
11861 sizeof(msg_info.task), M_WAITOK);
11865 mtx_lock(&softc->ctl_lock);
11866 port = ctl_io_port(&io->io_hdr);
11867 STAILQ_FOREACH(lun, &softc->lun_list, links) {
11868 if (port != NULL &&
11869 ctl_lun_map_to_port(port, lun->lun) >= CTL_MAX_LUNS)
11871 retval += ctl_do_lun_reset(lun, io, ua_type);
11873 mtx_unlock(&softc->ctl_lock);
11874 io->taskio.task_status = CTL_TASK_FUNCTION_COMPLETE;
11879 * The LUN should always be set. The I/O is optional, and is used to
11880 * distinguish between I/Os sent by this initiator, and by other
11881 * initiators. We set unit attention for initiators other than this one.
11882 * SAM-3 is vague on this point. It does say that a unit attention should
11883 * be established for other initiators when a LUN is reset (see section
11884 * 5.7.3), but it doesn't specifically say that the unit attention should
11885 * be established for this particular initiator when a LUN is reset. Here
11886 * is the relevant text, from SAM-3 rev 8:
11888 * 5.7.2 When a SCSI initiator port aborts its own tasks
11890 * When a SCSI initiator port causes its own task(s) to be aborted, no
11891 * notification that the task(s) have been aborted shall be returned to
11892 * the SCSI initiator port other than the completion response for the
11893 * command or task management function action that caused the task(s) to
11894 * be aborted and notification(s) associated with related effects of the
11895 * action (e.g., a reset unit attention condition).
11897 * XXX KDM for now, we're setting unit attention for all initiators.
11900 ctl_do_lun_reset(struct ctl_lun *lun, union ctl_io *io, ctl_ua_type ua_type)
11908 mtx_lock(&lun->lun_lock);
11910 * Run through the OOA queue and abort each I/O.
11912 for (xio = (union ctl_io *)TAILQ_FIRST(&lun->ooa_queue); xio != NULL;
11913 xio = (union ctl_io *)TAILQ_NEXT(&xio->io_hdr, ooa_links)) {
11914 xio->io_hdr.flags |= CTL_FLAG_ABORT | CTL_FLAG_ABORT_STATUS;
11918 * This version sets unit attention for every
11921 initidx = ctl_get_initindex(&io->io_hdr.nexus);
11922 ctl_est_ua_all(lun, initidx, ua_type);
11924 ctl_est_ua_all(lun, -1, ua_type);
11928 * A reset (any kind, really) clears reservations established with
11929 * RESERVE/RELEASE. It does not clear reservations established
11930 * with PERSISTENT RESERVE OUT, but we don't support that at the
11931 * moment anyway. See SPC-2, section 5.6. SPC-3 doesn't address
11932 * reservations made with the RESERVE/RELEASE commands, because
11933 * those commands are obsolete in SPC-3.
11935 lun->flags &= ~CTL_LUN_RESERVED;
11938 for (i = 0; i < CTL_MAX_INITIATORS; i++)
11939 ctl_clear_mask(lun->have_ca, i);
11941 lun->prevent_count = 0;
11942 for (i = 0; i < CTL_MAX_INITIATORS; i++)
11943 ctl_clear_mask(lun->prevent, i);
11944 mtx_unlock(&lun->lun_lock);
11950 ctl_lun_reset(struct ctl_softc *softc, union ctl_io *io)
11952 struct ctl_lun *lun;
11956 targ_lun = io->io_hdr.nexus.targ_mapped_lun;
11957 mtx_lock(&softc->ctl_lock);
11958 if ((targ_lun >= CTL_MAX_LUNS) ||
11959 (lun = softc->ctl_luns[targ_lun]) == NULL) {
11960 mtx_unlock(&softc->ctl_lock);
11961 io->taskio.task_status = CTL_TASK_LUN_DOES_NOT_EXIST;
11964 retval = ctl_do_lun_reset(lun, io, CTL_UA_LUN_RESET);
11965 mtx_unlock(&softc->ctl_lock);
11966 io->taskio.task_status = CTL_TASK_FUNCTION_COMPLETE;
11968 if ((io->io_hdr.flags & CTL_FLAG_FROM_OTHER_SC) == 0) {
11969 union ctl_ha_msg msg_info;
11971 msg_info.hdr.msg_type = CTL_MSG_MANAGE_TASKS;
11972 msg_info.hdr.nexus = io->io_hdr.nexus;
11973 msg_info.task.task_action = CTL_TASK_LUN_RESET;
11974 msg_info.hdr.original_sc = NULL;
11975 msg_info.hdr.serializing_sc = NULL;
11976 ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg_info,
11977 sizeof(msg_info.task), M_WAITOK);
11983 ctl_abort_tasks_lun(struct ctl_lun *lun, uint32_t targ_port, uint32_t init_id,
11988 mtx_assert(&lun->lun_lock, MA_OWNED);
11991 * Run through the OOA queue and attempt to find the given I/O.
11992 * The target port, initiator ID, tag type and tag number have to
11993 * match the values that we got from the initiator. If we have an
11994 * untagged command to abort, simply abort the first untagged command
11995 * we come to. We only allow one untagged command at a time of course.
11997 for (xio = (union ctl_io *)TAILQ_FIRST(&lun->ooa_queue); xio != NULL;
11998 xio = (union ctl_io *)TAILQ_NEXT(&xio->io_hdr, ooa_links)) {
12000 if ((targ_port == UINT32_MAX ||
12001 targ_port == xio->io_hdr.nexus.targ_port) &&
12002 (init_id == UINT32_MAX ||
12003 init_id == xio->io_hdr.nexus.initid)) {
12004 if (targ_port != xio->io_hdr.nexus.targ_port ||
12005 init_id != xio->io_hdr.nexus.initid)
12006 xio->io_hdr.flags |= CTL_FLAG_ABORT_STATUS;
12007 xio->io_hdr.flags |= CTL_FLAG_ABORT;
12008 if (!other_sc && !(lun->flags & CTL_LUN_PRIMARY_SC)) {
12009 union ctl_ha_msg msg_info;
12011 msg_info.hdr.nexus = xio->io_hdr.nexus;
12012 msg_info.task.task_action = CTL_TASK_ABORT_TASK;
12013 msg_info.task.tag_num = xio->scsiio.tag_num;
12014 msg_info.task.tag_type = xio->scsiio.tag_type;
12015 msg_info.hdr.msg_type = CTL_MSG_MANAGE_TASKS;
12016 msg_info.hdr.original_sc = NULL;
12017 msg_info.hdr.serializing_sc = NULL;
12018 ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg_info,
12019 sizeof(msg_info.task), M_NOWAIT);
12026 ctl_abort_task_set(union ctl_io *io)
12028 struct ctl_softc *softc = control_softc;
12029 struct ctl_lun *lun;
12035 targ_lun = io->io_hdr.nexus.targ_mapped_lun;
12036 mtx_lock(&softc->ctl_lock);
12037 if ((targ_lun >= CTL_MAX_LUNS) ||
12038 (lun = softc->ctl_luns[targ_lun]) == NULL) {
12039 mtx_unlock(&softc->ctl_lock);
12040 io->taskio.task_status = CTL_TASK_LUN_DOES_NOT_EXIST;
12044 mtx_lock(&lun->lun_lock);
12045 mtx_unlock(&softc->ctl_lock);
12046 if (io->taskio.task_action == CTL_TASK_ABORT_TASK_SET) {
12047 ctl_abort_tasks_lun(lun, io->io_hdr.nexus.targ_port,
12048 io->io_hdr.nexus.initid,
12049 (io->io_hdr.flags & CTL_FLAG_FROM_OTHER_SC) != 0);
12050 } else { /* CTL_TASK_CLEAR_TASK_SET */
12051 ctl_abort_tasks_lun(lun, UINT32_MAX, UINT32_MAX,
12052 (io->io_hdr.flags & CTL_FLAG_FROM_OTHER_SC) != 0);
12054 mtx_unlock(&lun->lun_lock);
12055 io->taskio.task_status = CTL_TASK_FUNCTION_COMPLETE;
12060 ctl_i_t_nexus_reset(union ctl_io *io)
12062 struct ctl_softc *softc = control_softc;
12063 struct ctl_lun *lun;
12066 if (!(io->io_hdr.flags & CTL_FLAG_FROM_OTHER_SC)) {
12067 union ctl_ha_msg msg_info;
12069 msg_info.hdr.nexus = io->io_hdr.nexus;
12070 msg_info.task.task_action = CTL_TASK_I_T_NEXUS_RESET;
12071 msg_info.hdr.msg_type = CTL_MSG_MANAGE_TASKS;
12072 msg_info.hdr.original_sc = NULL;
12073 msg_info.hdr.serializing_sc = NULL;
12074 ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg_info,
12075 sizeof(msg_info.task), M_WAITOK);
12078 initidx = ctl_get_initindex(&io->io_hdr.nexus);
12079 mtx_lock(&softc->ctl_lock);
12080 STAILQ_FOREACH(lun, &softc->lun_list, links) {
12081 mtx_lock(&lun->lun_lock);
12082 ctl_abort_tasks_lun(lun, io->io_hdr.nexus.targ_port,
12083 io->io_hdr.nexus.initid, 1);
12085 ctl_clear_mask(lun->have_ca, initidx);
12087 if ((lun->flags & CTL_LUN_RESERVED) && (lun->res_idx == initidx))
12088 lun->flags &= ~CTL_LUN_RESERVED;
12089 if (ctl_is_set(lun->prevent, initidx)) {
12090 ctl_clear_mask(lun->prevent, initidx);
12091 lun->prevent_count--;
12093 ctl_est_ua(lun, initidx, CTL_UA_I_T_NEXUS_LOSS);
12094 mtx_unlock(&lun->lun_lock);
12096 mtx_unlock(&softc->ctl_lock);
12097 io->taskio.task_status = CTL_TASK_FUNCTION_COMPLETE;
12102 ctl_abort_task(union ctl_io *io)
12105 struct ctl_lun *lun;
12106 struct ctl_softc *softc;
12109 char printbuf[128];
12114 softc = control_softc;
12120 targ_lun = io->io_hdr.nexus.targ_mapped_lun;
12121 mtx_lock(&softc->ctl_lock);
12122 if ((targ_lun >= CTL_MAX_LUNS) ||
12123 (lun = softc->ctl_luns[targ_lun]) == NULL) {
12124 mtx_unlock(&softc->ctl_lock);
12125 io->taskio.task_status = CTL_TASK_LUN_DOES_NOT_EXIST;
12130 printf("ctl_abort_task: called for lun %lld, tag %d type %d\n",
12131 lun->lun, io->taskio.tag_num, io->taskio.tag_type);
12134 mtx_lock(&lun->lun_lock);
12135 mtx_unlock(&softc->ctl_lock);
12137 * Run through the OOA queue and attempt to find the given I/O.
12138 * The target port, initiator ID, tag type and tag number have to
12139 * match the values that we got from the initiator. If we have an
12140 * untagged command to abort, simply abort the first untagged command
12141 * we come to. We only allow one untagged command at a time of course.
12143 for (xio = (union ctl_io *)TAILQ_FIRST(&lun->ooa_queue); xio != NULL;
12144 xio = (union ctl_io *)TAILQ_NEXT(&xio->io_hdr, ooa_links)) {
12146 sbuf_new(&sb, printbuf, sizeof(printbuf), SBUF_FIXEDLEN);
12148 sbuf_printf(&sb, "LUN %lld tag %d type %d%s%s%s%s: ",
12149 lun->lun, xio->scsiio.tag_num,
12150 xio->scsiio.tag_type,
12151 (xio->io_hdr.blocked_links.tqe_prev
12152 == NULL) ? "" : " BLOCKED",
12153 (xio->io_hdr.flags &
12154 CTL_FLAG_DMA_INPROG) ? " DMA" : "",
12155 (xio->io_hdr.flags &
12156 CTL_FLAG_ABORT) ? " ABORT" : "",
12157 (xio->io_hdr.flags &
12158 CTL_FLAG_IS_WAS_ON_RTR ? " RTR" : ""));
12159 ctl_scsi_command_string(&xio->scsiio, NULL, &sb);
12161 printf("%s\n", sbuf_data(&sb));
12164 if ((xio->io_hdr.nexus.targ_port != io->io_hdr.nexus.targ_port)
12165 || (xio->io_hdr.nexus.initid != io->io_hdr.nexus.initid)
12166 || (xio->io_hdr.flags & CTL_FLAG_ABORT))
12170 * If the abort says that the task is untagged, the
12171 * task in the queue must be untagged. Otherwise,
12172 * we just check to see whether the tag numbers
12173 * match. This is because the QLogic firmware
12174 * doesn't pass back the tag type in an abort
12178 if (((xio->scsiio.tag_type == CTL_TAG_UNTAGGED)
12179 && (io->taskio.tag_type == CTL_TAG_UNTAGGED))
12180 || (xio->scsiio.tag_num == io->taskio.tag_num))
12183 * XXX KDM we've got problems with FC, because it
12184 * doesn't send down a tag type with aborts. So we
12185 * can only really go by the tag number...
12186 * This may cause problems with parallel SCSI.
12187 * Need to figure that out!!
12189 if (xio->scsiio.tag_num == io->taskio.tag_num) {
12190 xio->io_hdr.flags |= CTL_FLAG_ABORT;
12192 if ((io->io_hdr.flags & CTL_FLAG_FROM_OTHER_SC) == 0 &&
12193 !(lun->flags & CTL_LUN_PRIMARY_SC)) {
12194 union ctl_ha_msg msg_info;
12196 msg_info.hdr.nexus = io->io_hdr.nexus;
12197 msg_info.task.task_action = CTL_TASK_ABORT_TASK;
12198 msg_info.task.tag_num = io->taskio.tag_num;
12199 msg_info.task.tag_type = io->taskio.tag_type;
12200 msg_info.hdr.msg_type = CTL_MSG_MANAGE_TASKS;
12201 msg_info.hdr.original_sc = NULL;
12202 msg_info.hdr.serializing_sc = NULL;
12204 printf("Sent Abort to other side\n");
12206 ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg_info,
12207 sizeof(msg_info.task), M_NOWAIT);
12210 printf("ctl_abort_task: found I/O to abort\n");
12214 mtx_unlock(&lun->lun_lock);
12218 * This isn't really an error. It's entirely possible for
12219 * the abort and command completion to cross on the wire.
12220 * This is more of an informative/diagnostic error.
12223 printf("ctl_abort_task: ABORT sent for nonexistent I/O: "
12224 "%u:%u:%u tag %d type %d\n",
12225 io->io_hdr.nexus.initid,
12226 io->io_hdr.nexus.targ_port,
12227 io->io_hdr.nexus.targ_lun, io->taskio.tag_num,
12228 io->taskio.tag_type);
12231 io->taskio.task_status = CTL_TASK_FUNCTION_COMPLETE;
12236 ctl_query_task(union ctl_io *io, int task_set)
12239 struct ctl_lun *lun;
12240 struct ctl_softc *softc;
12244 softc = control_softc;
12245 targ_lun = io->io_hdr.nexus.targ_mapped_lun;
12246 mtx_lock(&softc->ctl_lock);
12247 if ((targ_lun >= CTL_MAX_LUNS) ||
12248 (lun = softc->ctl_luns[targ_lun]) == NULL) {
12249 mtx_unlock(&softc->ctl_lock);
12250 io->taskio.task_status = CTL_TASK_LUN_DOES_NOT_EXIST;
12253 mtx_lock(&lun->lun_lock);
12254 mtx_unlock(&softc->ctl_lock);
12255 for (xio = (union ctl_io *)TAILQ_FIRST(&lun->ooa_queue); xio != NULL;
12256 xio = (union ctl_io *)TAILQ_NEXT(&xio->io_hdr, ooa_links)) {
12258 if ((xio->io_hdr.nexus.targ_port != io->io_hdr.nexus.targ_port)
12259 || (xio->io_hdr.nexus.initid != io->io_hdr.nexus.initid)
12260 || (xio->io_hdr.flags & CTL_FLAG_ABORT))
12263 if (task_set || xio->scsiio.tag_num == io->taskio.tag_num) {
12268 mtx_unlock(&lun->lun_lock);
12270 io->taskio.task_status = CTL_TASK_FUNCTION_SUCCEEDED;
12272 io->taskio.task_status = CTL_TASK_FUNCTION_COMPLETE;
12277 ctl_query_async_event(union ctl_io *io)
12279 struct ctl_lun *lun;
12280 struct ctl_softc *softc;
12282 uint32_t targ_lun, initidx;
12284 softc = control_softc;
12285 targ_lun = io->io_hdr.nexus.targ_mapped_lun;
12286 mtx_lock(&softc->ctl_lock);
12287 if ((targ_lun >= CTL_MAX_LUNS) ||
12288 (lun = softc->ctl_luns[targ_lun]) == NULL) {
12289 mtx_unlock(&softc->ctl_lock);
12290 io->taskio.task_status = CTL_TASK_LUN_DOES_NOT_EXIST;
12293 mtx_lock(&lun->lun_lock);
12294 mtx_unlock(&softc->ctl_lock);
12295 initidx = ctl_get_initindex(&io->io_hdr.nexus);
12296 ua = ctl_build_qae(lun, initidx, io->taskio.task_resp);
12297 mtx_unlock(&lun->lun_lock);
12298 if (ua != CTL_UA_NONE)
12299 io->taskio.task_status = CTL_TASK_FUNCTION_SUCCEEDED;
12301 io->taskio.task_status = CTL_TASK_FUNCTION_COMPLETE;
12306 ctl_run_task(union ctl_io *io)
12308 struct ctl_softc *softc = control_softc;
12311 CTL_DEBUG_PRINT(("ctl_run_task\n"));
12312 KASSERT(io->io_hdr.io_type == CTL_IO_TASK,
12313 ("ctl_run_task: Unextected io_type %d\n", io->io_hdr.io_type));
12314 io->taskio.task_status = CTL_TASK_FUNCTION_NOT_SUPPORTED;
12315 bzero(io->taskio.task_resp, sizeof(io->taskio.task_resp));
12316 switch (io->taskio.task_action) {
12317 case CTL_TASK_ABORT_TASK:
12318 retval = ctl_abort_task(io);
12320 case CTL_TASK_ABORT_TASK_SET:
12321 case CTL_TASK_CLEAR_TASK_SET:
12322 retval = ctl_abort_task_set(io);
12324 case CTL_TASK_CLEAR_ACA:
12326 case CTL_TASK_I_T_NEXUS_RESET:
12327 retval = ctl_i_t_nexus_reset(io);
12329 case CTL_TASK_LUN_RESET:
12330 retval = ctl_lun_reset(softc, io);
12332 case CTL_TASK_TARGET_RESET:
12333 retval = ctl_target_reset(softc, io, CTL_UA_TARG_RESET);
12335 case CTL_TASK_BUS_RESET:
12336 retval = ctl_bus_reset(softc, io);
12338 case CTL_TASK_PORT_LOGIN:
12340 case CTL_TASK_PORT_LOGOUT:
12342 case CTL_TASK_QUERY_TASK:
12343 retval = ctl_query_task(io, 0);
12345 case CTL_TASK_QUERY_TASK_SET:
12346 retval = ctl_query_task(io, 1);
12348 case CTL_TASK_QUERY_ASYNC_EVENT:
12349 retval = ctl_query_async_event(io);
12352 printf("%s: got unknown task management event %d\n",
12353 __func__, io->taskio.task_action);
12357 io->io_hdr.status = CTL_SUCCESS;
12359 io->io_hdr.status = CTL_ERROR;
12364 * For HA operation. Handle commands that come in from the other
12368 ctl_handle_isc(union ctl_io *io)
12371 struct ctl_lun *lun;
12372 struct ctl_softc *softc = control_softc;
12375 targ_lun = io->io_hdr.nexus.targ_mapped_lun;
12376 lun = softc->ctl_luns[targ_lun];
12378 switch (io->io_hdr.msg_type) {
12379 case CTL_MSG_SERIALIZE:
12380 free_io = ctl_serialize_other_sc_cmd(&io->scsiio);
12382 case CTL_MSG_R2R: {
12383 const struct ctl_cmd_entry *entry;
12386 * This is only used in SER_ONLY mode.
12389 entry = ctl_get_cmd_entry(&io->scsiio, NULL);
12390 mtx_lock(&lun->lun_lock);
12391 if (ctl_scsiio_lun_check(lun,
12392 entry, (struct ctl_scsiio *)io) != 0) {
12393 mtx_unlock(&lun->lun_lock);
12397 io->io_hdr.flags |= CTL_FLAG_IS_WAS_ON_RTR;
12398 mtx_unlock(&lun->lun_lock);
12399 ctl_enqueue_rtr(io);
12402 case CTL_MSG_FINISH_IO:
12403 if (softc->ha_mode == CTL_HA_MODE_XFER) {
12408 mtx_lock(&lun->lun_lock);
12409 TAILQ_REMOVE(&lun->ooa_queue, &io->io_hdr,
12411 ctl_check_blocked(lun);
12412 mtx_unlock(&lun->lun_lock);
12415 case CTL_MSG_PERS_ACTION:
12416 ctl_hndl_per_res_out_on_other_sc(
12417 (union ctl_ha_msg *)&io->presio.pr_msg);
12420 case CTL_MSG_BAD_JUJU:
12424 case CTL_MSG_DATAMOVE:
12425 /* Only used in XFER mode */
12427 ctl_datamove_remote(io);
12429 case CTL_MSG_DATAMOVE_DONE:
12430 /* Only used in XFER mode */
12432 io->scsiio.be_move_done(io);
12434 case CTL_MSG_FAILOVER:
12435 ctl_failover_lun(io);
12440 printf("%s: Invalid message type %d\n",
12441 __func__, io->io_hdr.msg_type);
12451 * Returns the match type in the case of a match, or CTL_LUN_PAT_NONE if
12452 * there is no match.
12454 static ctl_lun_error_pattern
12455 ctl_cmd_pattern_match(struct ctl_scsiio *ctsio, struct ctl_error_desc *desc)
12457 const struct ctl_cmd_entry *entry;
12458 ctl_lun_error_pattern filtered_pattern, pattern;
12460 pattern = desc->error_pattern;
12463 * XXX KDM we need more data passed into this function to match a
12464 * custom pattern, and we actually need to implement custom pattern
12467 if (pattern & CTL_LUN_PAT_CMD)
12468 return (CTL_LUN_PAT_CMD);
12470 if ((pattern & CTL_LUN_PAT_MASK) == CTL_LUN_PAT_ANY)
12471 return (CTL_LUN_PAT_ANY);
12473 entry = ctl_get_cmd_entry(ctsio, NULL);
12475 filtered_pattern = entry->pattern & pattern;
12478 * If the user requested specific flags in the pattern (e.g.
12479 * CTL_LUN_PAT_RANGE), make sure the command supports all of those
12482 * If the user did not specify any flags, it doesn't matter whether
12483 * or not the command supports the flags.
12485 if ((filtered_pattern & ~CTL_LUN_PAT_MASK) !=
12486 (pattern & ~CTL_LUN_PAT_MASK))
12487 return (CTL_LUN_PAT_NONE);
12490 * If the user asked for a range check, see if the requested LBA
12491 * range overlaps with this command's LBA range.
12493 if (filtered_pattern & CTL_LUN_PAT_RANGE) {
12499 retval = ctl_get_lba_len((union ctl_io *)ctsio, &lba1, &len1);
12501 return (CTL_LUN_PAT_NONE);
12503 action = ctl_extent_check_lba(lba1, len1, desc->lba_range.lba,
12504 desc->lba_range.len, FALSE);
12506 * A "pass" means that the LBA ranges don't overlap, so
12507 * this doesn't match the user's range criteria.
12509 if (action == CTL_ACTION_PASS)
12510 return (CTL_LUN_PAT_NONE);
12513 return (filtered_pattern);
12517 ctl_inject_error(struct ctl_lun *lun, union ctl_io *io)
12519 struct ctl_error_desc *desc, *desc2;
12521 mtx_assert(&lun->lun_lock, MA_OWNED);
12523 STAILQ_FOREACH_SAFE(desc, &lun->error_list, links, desc2) {
12524 ctl_lun_error_pattern pattern;
12526 * Check to see whether this particular command matches
12527 * the pattern in the descriptor.
12529 pattern = ctl_cmd_pattern_match(&io->scsiio, desc);
12530 if ((pattern & CTL_LUN_PAT_MASK) == CTL_LUN_PAT_NONE)
12533 switch (desc->lun_error & CTL_LUN_INJ_TYPE) {
12534 case CTL_LUN_INJ_ABORTED:
12535 ctl_set_aborted(&io->scsiio);
12537 case CTL_LUN_INJ_MEDIUM_ERR:
12538 ctl_set_medium_error(&io->scsiio,
12539 (io->io_hdr.flags & CTL_FLAG_DATA_MASK) !=
12540 CTL_FLAG_DATA_OUT);
12542 case CTL_LUN_INJ_UA:
12543 /* 29h/00h POWER ON, RESET, OR BUS DEVICE RESET
12545 ctl_set_ua(&io->scsiio, 0x29, 0x00);
12547 case CTL_LUN_INJ_CUSTOM:
12549 * We're assuming the user knows what he is doing.
12550 * Just copy the sense information without doing
12553 bcopy(&desc->custom_sense, &io->scsiio.sense_data,
12554 MIN(sizeof(desc->custom_sense),
12555 sizeof(io->scsiio.sense_data)));
12556 io->scsiio.scsi_status = SCSI_STATUS_CHECK_COND;
12557 io->scsiio.sense_len = SSD_FULL_SIZE;
12558 io->io_hdr.status = CTL_SCSI_ERROR | CTL_AUTOSENSE;
12560 case CTL_LUN_INJ_NONE:
12563 * If this is an error injection type we don't know
12564 * about, clear the continuous flag (if it is set)
12565 * so it will get deleted below.
12567 desc->lun_error &= ~CTL_LUN_INJ_CONTINUOUS;
12571 * By default, each error injection action is a one-shot
12573 if (desc->lun_error & CTL_LUN_INJ_CONTINUOUS)
12576 STAILQ_REMOVE(&lun->error_list, desc, ctl_error_desc, links);
12582 #ifdef CTL_IO_DELAY
12584 ctl_datamove_timer_wakeup(void *arg)
12588 io = (union ctl_io *)arg;
12592 #endif /* CTL_IO_DELAY */
12595 ctl_datamove(union ctl_io *io)
12597 struct ctl_lun *lun;
12598 void (*fe_datamove)(union ctl_io *io);
12600 mtx_assert(&control_softc->ctl_lock, MA_NOTOWNED);
12602 CTL_DEBUG_PRINT(("ctl_datamove\n"));
12604 lun = (struct ctl_lun *)io->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
12606 if ((time_uptime - io->io_hdr.start_time) > ctl_time_io_secs) {
12611 ctl_scsi_path_string(io, path_str, sizeof(path_str));
12612 sbuf_new(&sb, str, sizeof(str), SBUF_FIXEDLEN);
12614 sbuf_cat(&sb, path_str);
12615 switch (io->io_hdr.io_type) {
12617 ctl_scsi_command_string(&io->scsiio, NULL, &sb);
12618 sbuf_printf(&sb, "\n");
12619 sbuf_cat(&sb, path_str);
12620 sbuf_printf(&sb, "Tag: 0x%04x, type %d\n",
12621 io->scsiio.tag_num, io->scsiio.tag_type);
12624 sbuf_printf(&sb, "Task I/O type: %d, Tag: 0x%04x, "
12625 "Tag Type: %d\n", io->taskio.task_action,
12626 io->taskio.tag_num, io->taskio.tag_type);
12629 panic("%s: Invalid CTL I/O type %d\n",
12630 __func__, io->io_hdr.io_type);
12632 sbuf_cat(&sb, path_str);
12633 sbuf_printf(&sb, "ctl_datamove: %jd seconds\n",
12634 (intmax_t)time_uptime - io->io_hdr.start_time);
12636 printf("%s", sbuf_data(&sb));
12638 #endif /* CTL_TIME_IO */
12640 #ifdef CTL_IO_DELAY
12641 if (io->io_hdr.flags & CTL_FLAG_DELAY_DONE) {
12642 io->io_hdr.flags &= ~CTL_FLAG_DELAY_DONE;
12645 && (lun->delay_info.datamove_delay > 0)) {
12647 callout_init(&io->io_hdr.delay_callout, /*mpsafe*/ 1);
12648 io->io_hdr.flags |= CTL_FLAG_DELAY_DONE;
12649 callout_reset(&io->io_hdr.delay_callout,
12650 lun->delay_info.datamove_delay * hz,
12651 ctl_datamove_timer_wakeup, io);
12652 if (lun->delay_info.datamove_type ==
12653 CTL_DELAY_TYPE_ONESHOT)
12654 lun->delay_info.datamove_delay = 0;
12661 * This command has been aborted. Set the port status, so we fail
12664 if (io->io_hdr.flags & CTL_FLAG_ABORT) {
12665 printf("ctl_datamove: tag 0x%04x on (%u:%u:%u) aborted\n",
12666 io->scsiio.tag_num, io->io_hdr.nexus.initid,
12667 io->io_hdr.nexus.targ_port,
12668 io->io_hdr.nexus.targ_lun);
12669 io->io_hdr.port_status = 31337;
12671 * Note that the backend, in this case, will get the
12672 * callback in its context. In other cases it may get
12673 * called in the frontend's interrupt thread context.
12675 io->scsiio.be_move_done(io);
12679 /* Don't confuse frontend with zero length data move. */
12680 if (io->scsiio.kern_data_len == 0) {
12681 io->scsiio.be_move_done(io);
12685 fe_datamove = ctl_io_port(&io->io_hdr)->fe_datamove;
12690 ctl_send_datamove_done(union ctl_io *io, int have_lock)
12692 union ctl_ha_msg msg;
12694 struct bintime cur_bt;
12697 memset(&msg, 0, sizeof(msg));
12698 msg.hdr.msg_type = CTL_MSG_DATAMOVE_DONE;
12699 msg.hdr.original_sc = io;
12700 msg.hdr.serializing_sc = io->io_hdr.serializing_sc;
12701 msg.hdr.nexus = io->io_hdr.nexus;
12702 msg.hdr.status = io->io_hdr.status;
12703 msg.scsi.tag_num = io->scsiio.tag_num;
12704 msg.scsi.tag_type = io->scsiio.tag_type;
12705 msg.scsi.scsi_status = io->scsiio.scsi_status;
12706 memcpy(&msg.scsi.sense_data, &io->scsiio.sense_data,
12707 io->scsiio.sense_len);
12708 msg.scsi.sense_len = io->scsiio.sense_len;
12709 msg.scsi.sense_residual = io->scsiio.sense_residual;
12710 msg.scsi.fetd_status = io->io_hdr.port_status;
12711 msg.scsi.residual = io->scsiio.residual;
12712 io->io_hdr.flags &= ~CTL_FLAG_IO_ACTIVE;
12713 if (io->io_hdr.flags & CTL_FLAG_FAILOVER) {
12714 ctl_failover_io(io, /*have_lock*/ have_lock);
12717 ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg,
12718 sizeof(msg.scsi) - sizeof(msg.scsi.sense_data) +
12719 msg.scsi.sense_len, M_WAITOK);
12722 getbinuptime(&cur_bt);
12723 bintime_sub(&cur_bt, &io->io_hdr.dma_start_bt);
12724 bintime_add(&io->io_hdr.dma_bt, &cur_bt);
12726 io->io_hdr.num_dmas++;
12730 * The DMA to the remote side is done, now we need to tell the other side
12731 * we're done so it can continue with its data movement.
12734 ctl_datamove_remote_write_cb(struct ctl_ha_dt_req *rq)
12741 if (rq->ret != CTL_HA_STATUS_SUCCESS) {
12742 printf("%s: ISC DMA write failed with error %d", __func__,
12744 ctl_set_internal_failure(&io->scsiio,
12746 /*retry_count*/ rq->ret);
12749 ctl_dt_req_free(rq);
12751 for (i = 0; i < io->scsiio.kern_sg_entries; i++)
12752 free(io->io_hdr.local_sglist[i].addr, M_CTL);
12753 free(io->io_hdr.remote_sglist, M_CTL);
12754 io->io_hdr.remote_sglist = NULL;
12755 io->io_hdr.local_sglist = NULL;
12758 * The data is in local and remote memory, so now we need to send
12759 * status (good or back) back to the other side.
12761 ctl_send_datamove_done(io, /*have_lock*/ 0);
12765 * We've moved the data from the host/controller into local memory. Now we
12766 * need to push it over to the remote controller's memory.
12769 ctl_datamove_remote_dm_write_cb(union ctl_io *io)
12773 retval = ctl_datamove_remote_xfer(io, CTL_HA_DT_CMD_WRITE,
12774 ctl_datamove_remote_write_cb);
12779 ctl_datamove_remote_write(union ctl_io *io)
12782 void (*fe_datamove)(union ctl_io *io);
12785 * - Get the data from the host/HBA into local memory.
12786 * - DMA memory from the local controller to the remote controller.
12787 * - Send status back to the remote controller.
12790 retval = ctl_datamove_remote_sgl_setup(io);
12794 /* Switch the pointer over so the FETD knows what to do */
12795 io->scsiio.kern_data_ptr = (uint8_t *)io->io_hdr.local_sglist;
12798 * Use a custom move done callback, since we need to send completion
12799 * back to the other controller, not to the backend on this side.
12801 io->scsiio.be_move_done = ctl_datamove_remote_dm_write_cb;
12803 fe_datamove = ctl_io_port(&io->io_hdr)->fe_datamove;
12808 ctl_datamove_remote_dm_read_cb(union ctl_io *io)
12817 for (i = 0; i < io->scsiio.kern_sg_entries; i++)
12818 free(io->io_hdr.local_sglist[i].addr, M_CTL);
12819 free(io->io_hdr.remote_sglist, M_CTL);
12820 io->io_hdr.remote_sglist = NULL;
12821 io->io_hdr.local_sglist = NULL;
12824 scsi_path_string(io, path_str, sizeof(path_str));
12825 sbuf_new(&sb, str, sizeof(str), SBUF_FIXEDLEN);
12826 sbuf_cat(&sb, path_str);
12827 scsi_command_string(&io->scsiio, NULL, &sb);
12828 sbuf_printf(&sb, "\n");
12829 sbuf_cat(&sb, path_str);
12830 sbuf_printf(&sb, "Tag: 0x%04x, type %d\n",
12831 io->scsiio.tag_num, io->scsiio.tag_type);
12832 sbuf_cat(&sb, path_str);
12833 sbuf_printf(&sb, "%s: flags %#x, status %#x\n", __func__,
12834 io->io_hdr.flags, io->io_hdr.status);
12836 printk("%s", sbuf_data(&sb));
12841 * The read is done, now we need to send status (good or bad) back
12842 * to the other side.
12844 ctl_send_datamove_done(io, /*have_lock*/ 0);
12850 ctl_datamove_remote_read_cb(struct ctl_ha_dt_req *rq)
12853 void (*fe_datamove)(union ctl_io *io);
12857 if (rq->ret != CTL_HA_STATUS_SUCCESS) {
12858 printf("%s: ISC DMA read failed with error %d\n", __func__,
12860 ctl_set_internal_failure(&io->scsiio,
12862 /*retry_count*/ rq->ret);
12865 ctl_dt_req_free(rq);
12867 /* Switch the pointer over so the FETD knows what to do */
12868 io->scsiio.kern_data_ptr = (uint8_t *)io->io_hdr.local_sglist;
12871 * Use a custom move done callback, since we need to send completion
12872 * back to the other controller, not to the backend on this side.
12874 io->scsiio.be_move_done = ctl_datamove_remote_dm_read_cb;
12876 /* XXX KDM add checks like the ones in ctl_datamove? */
12878 fe_datamove = ctl_io_port(&io->io_hdr)->fe_datamove;
12883 ctl_datamove_remote_sgl_setup(union ctl_io *io)
12885 struct ctl_sg_entry *local_sglist;
12886 uint32_t len_to_go;
12891 local_sglist = io->io_hdr.local_sglist;
12892 len_to_go = io->scsiio.kern_data_len;
12895 * The difficult thing here is that the size of the various
12896 * S/G segments may be different than the size from the
12897 * remote controller. That'll make it harder when DMAing
12898 * the data back to the other side.
12900 for (i = 0; len_to_go > 0; i++) {
12901 local_sglist[i].len = MIN(len_to_go, CTL_HA_DATAMOVE_SEGMENT);
12902 local_sglist[i].addr =
12903 malloc(local_sglist[i].len, M_CTL, M_WAITOK);
12905 len_to_go -= local_sglist[i].len;
12908 * Reset the number of S/G entries accordingly. The original
12909 * number of S/G entries is available in rem_sg_entries.
12911 io->scsiio.kern_sg_entries = i;
12914 printf("%s: kern_sg_entries = %d\n", __func__,
12915 io->scsiio.kern_sg_entries);
12916 for (i = 0; i < io->scsiio.kern_sg_entries; i++)
12917 printf("%s: sg[%d] = %p, %lu\n", __func__, i,
12918 local_sglist[i].addr, local_sglist[i].len);
12925 ctl_datamove_remote_xfer(union ctl_io *io, unsigned command,
12926 ctl_ha_dt_cb callback)
12928 struct ctl_ha_dt_req *rq;
12929 struct ctl_sg_entry *remote_sglist, *local_sglist;
12930 uint32_t local_used, remote_used, total_used;
12933 rq = ctl_dt_req_alloc();
12936 * If we failed to allocate the request, and if the DMA didn't fail
12937 * anyway, set busy status. This is just a resource allocation
12941 && ((io->io_hdr.status & CTL_STATUS_MASK) != CTL_STATUS_NONE &&
12942 (io->io_hdr.status & CTL_STATUS_MASK) != CTL_SUCCESS))
12943 ctl_set_busy(&io->scsiio);
12945 if ((io->io_hdr.status & CTL_STATUS_MASK) != CTL_STATUS_NONE &&
12946 (io->io_hdr.status & CTL_STATUS_MASK) != CTL_SUCCESS) {
12949 ctl_dt_req_free(rq);
12952 * The data move failed. We need to return status back
12953 * to the other controller. No point in trying to DMA
12954 * data to the remote controller.
12957 ctl_send_datamove_done(io, /*have_lock*/ 0);
12962 local_sglist = io->io_hdr.local_sglist;
12963 remote_sglist = io->io_hdr.remote_sglist;
12969 * Pull/push the data over the wire from/to the other controller.
12970 * This takes into account the possibility that the local and
12971 * remote sglists may not be identical in terms of the size of
12972 * the elements and the number of elements.
12974 * One fundamental assumption here is that the length allocated for
12975 * both the local and remote sglists is identical. Otherwise, we've
12976 * essentially got a coding error of some sort.
12978 isc_ret = CTL_HA_STATUS_SUCCESS;
12979 for (i = 0, j = 0; total_used < io->scsiio.kern_data_len; ) {
12983 rq->command = command;
12987 * Both pointers should be aligned. But it is possible
12988 * that the allocation length is not. They should both
12989 * also have enough slack left over at the end, though,
12990 * to round up to the next 8 byte boundary.
12992 cur_len = MIN(local_sglist[i].len - local_used,
12993 remote_sglist[j].len - remote_used);
12994 rq->size = cur_len;
12996 tmp_ptr = (uint8_t *)local_sglist[i].addr;
12997 tmp_ptr += local_used;
13000 /* Use physical addresses when talking to ISC hardware */
13001 if ((io->io_hdr.flags & CTL_FLAG_BUS_ADDR) == 0) {
13002 /* XXX KDM use busdma */
13003 rq->local = vtophys(tmp_ptr);
13005 rq->local = tmp_ptr;
13007 KASSERT((io->io_hdr.flags & CTL_FLAG_BUS_ADDR) == 0,
13008 ("HA does not support BUS_ADDR"));
13009 rq->local = tmp_ptr;
13012 tmp_ptr = (uint8_t *)remote_sglist[j].addr;
13013 tmp_ptr += remote_used;
13014 rq->remote = tmp_ptr;
13016 rq->callback = NULL;
13018 local_used += cur_len;
13019 if (local_used >= local_sglist[i].len) {
13024 remote_used += cur_len;
13025 if (remote_used >= remote_sglist[j].len) {
13029 total_used += cur_len;
13031 if (total_used >= io->scsiio.kern_data_len)
13032 rq->callback = callback;
13035 printf("%s: %s: local %p remote %p size %d\n", __func__,
13036 (command == CTL_HA_DT_CMD_WRITE) ? "WRITE" : "READ",
13037 rq->local, rq->remote, rq->size);
13040 isc_ret = ctl_dt_single(rq);
13041 if (isc_ret > CTL_HA_STATUS_SUCCESS)
13044 if (isc_ret != CTL_HA_STATUS_WAIT) {
13053 ctl_datamove_remote_read(union ctl_io *io)
13059 * This will send an error to the other controller in the case of a
13062 retval = ctl_datamove_remote_sgl_setup(io);
13066 retval = ctl_datamove_remote_xfer(io, CTL_HA_DT_CMD_READ,
13067 ctl_datamove_remote_read_cb);
13070 * Make sure we free memory if there was an error.. The
13071 * ctl_datamove_remote_xfer() function will send the
13072 * datamove done message, or call the callback with an
13073 * error if there is a problem.
13075 for (i = 0; i < io->scsiio.kern_sg_entries; i++)
13076 free(io->io_hdr.local_sglist[i].addr, M_CTL);
13077 free(io->io_hdr.remote_sglist, M_CTL);
13078 io->io_hdr.remote_sglist = NULL;
13079 io->io_hdr.local_sglist = NULL;
13084 * Process a datamove request from the other controller. This is used for
13085 * XFER mode only, not SER_ONLY mode. For writes, we DMA into local memory
13086 * first. Once that is complete, the data gets DMAed into the remote
13087 * controller's memory. For reads, we DMA from the remote controller's
13088 * memory into our memory first, and then move it out to the FETD.
13091 ctl_datamove_remote(union ctl_io *io)
13094 mtx_assert(&control_softc->ctl_lock, MA_NOTOWNED);
13096 if (io->io_hdr.flags & CTL_FLAG_FAILOVER) {
13097 ctl_failover_io(io, /*have_lock*/ 0);
13102 * Note that we look for an aborted I/O here, but don't do some of
13103 * the other checks that ctl_datamove() normally does.
13104 * We don't need to run the datamove delay code, since that should
13105 * have been done if need be on the other controller.
13107 if (io->io_hdr.flags & CTL_FLAG_ABORT) {
13108 printf("%s: tag 0x%04x on (%u:%u:%u) aborted\n", __func__,
13109 io->scsiio.tag_num, io->io_hdr.nexus.initid,
13110 io->io_hdr.nexus.targ_port,
13111 io->io_hdr.nexus.targ_lun);
13112 io->io_hdr.port_status = 31338;
13113 ctl_send_datamove_done(io, /*have_lock*/ 0);
13117 if ((io->io_hdr.flags & CTL_FLAG_DATA_MASK) == CTL_FLAG_DATA_OUT)
13118 ctl_datamove_remote_write(io);
13119 else if ((io->io_hdr.flags & CTL_FLAG_DATA_MASK) == CTL_FLAG_DATA_IN)
13120 ctl_datamove_remote_read(io);
13122 io->io_hdr.port_status = 31339;
13123 ctl_send_datamove_done(io, /*have_lock*/ 0);
13128 ctl_process_done(union ctl_io *io)
13130 struct ctl_lun *lun;
13131 struct ctl_softc *softc = control_softc;
13132 void (*fe_done)(union ctl_io *io);
13133 union ctl_ha_msg msg;
13134 uint32_t targ_port = io->io_hdr.nexus.targ_port;
13136 CTL_DEBUG_PRINT(("ctl_process_done\n"));
13137 fe_done = softc->ctl_ports[targ_port]->fe_done;
13140 if ((time_uptime - io->io_hdr.start_time) > ctl_time_io_secs) {
13145 ctl_scsi_path_string(io, path_str, sizeof(path_str));
13146 sbuf_new(&sb, str, sizeof(str), SBUF_FIXEDLEN);
13148 sbuf_cat(&sb, path_str);
13149 switch (io->io_hdr.io_type) {
13151 ctl_scsi_command_string(&io->scsiio, NULL, &sb);
13152 sbuf_printf(&sb, "\n");
13153 sbuf_cat(&sb, path_str);
13154 sbuf_printf(&sb, "Tag: 0x%04x, type %d\n",
13155 io->scsiio.tag_num, io->scsiio.tag_type);
13158 sbuf_printf(&sb, "Task I/O type: %d, Tag: 0x%04x, "
13159 "Tag Type: %d\n", io->taskio.task_action,
13160 io->taskio.tag_num, io->taskio.tag_type);
13163 panic("%s: Invalid CTL I/O type %d\n",
13164 __func__, io->io_hdr.io_type);
13166 sbuf_cat(&sb, path_str);
13167 sbuf_printf(&sb, "ctl_process_done: %jd seconds\n",
13168 (intmax_t)time_uptime - io->io_hdr.start_time);
13170 printf("%s", sbuf_data(&sb));
13172 #endif /* CTL_TIME_IO */
13174 switch (io->io_hdr.io_type) {
13178 if (ctl_debug & CTL_DEBUG_INFO)
13179 ctl_io_error_print(io, NULL);
13183 panic("%s: Invalid CTL I/O type %d\n",
13184 __func__, io->io_hdr.io_type);
13187 lun = (struct ctl_lun *)io->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
13189 CTL_DEBUG_PRINT(("NULL LUN for lun %d\n",
13190 io->io_hdr.nexus.targ_mapped_lun));
13194 mtx_lock(&lun->lun_lock);
13197 * Check to see if we have any informational exception and status
13198 * of this command can be modified to report it in form of either
13199 * RECOVERED ERROR or NO SENSE, depending on MRIE mode page field.
13201 if (lun->ie_reported == 0 && lun->ie_asc != 0 &&
13202 io->io_hdr.status == CTL_SUCCESS &&
13203 (io->io_hdr.flags & CTL_FLAG_STATUS_SENT) == 0) {
13204 uint8_t mrie = lun->MODE_IE.mrie;
13205 uint8_t per = ((lun->MODE_RWER.byte3 & SMS_RWER_PER) ||
13206 (lun->MODE_VER.byte3 & SMS_VER_PER));
13207 if (((mrie == SIEP_MRIE_REC_COND && per) ||
13208 mrie == SIEP_MRIE_REC_UNCOND ||
13209 mrie == SIEP_MRIE_NO_SENSE) &&
13210 (ctl_get_cmd_entry(&io->scsiio, NULL)->flags &
13211 CTL_CMD_FLAG_NO_SENSE) == 0) {
13212 ctl_set_sense(&io->scsiio,
13213 /*current_error*/ 1,
13214 /*sense_key*/ (mrie == SIEP_MRIE_NO_SENSE) ?
13215 SSD_KEY_NO_SENSE : SSD_KEY_RECOVERED_ERROR,
13216 /*asc*/ lun->ie_asc,
13217 /*ascq*/ lun->ie_ascq,
13219 lun->ie_reported = 1;
13221 } else if (lun->ie_reported < 0)
13222 lun->ie_reported = 0;
13225 * Check to see if we have any errors to inject here. We only
13226 * inject errors for commands that don't already have errors set.
13228 if (!STAILQ_EMPTY(&lun->error_list) &&
13229 ((io->io_hdr.status & CTL_STATUS_MASK) == CTL_SUCCESS) &&
13230 ((io->io_hdr.flags & CTL_FLAG_STATUS_SENT) == 0))
13231 ctl_inject_error(lun, io);
13234 * XXX KDM how do we treat commands that aren't completed
13237 * XXX KDM should we also track I/O latency?
13239 if ((io->io_hdr.status & CTL_STATUS_MASK) == CTL_SUCCESS &&
13240 io->io_hdr.io_type == CTL_IO_SCSI) {
13242 struct bintime cur_bt;
13246 if ((io->io_hdr.flags & CTL_FLAG_DATA_MASK) ==
13248 type = CTL_STATS_READ;
13249 else if ((io->io_hdr.flags & CTL_FLAG_DATA_MASK) ==
13251 type = CTL_STATS_WRITE;
13253 type = CTL_STATS_NO_IO;
13255 lun->stats.ports[targ_port].bytes[type] +=
13256 io->scsiio.kern_total_len;
13257 lun->stats.ports[targ_port].operations[type]++;
13259 bintime_add(&lun->stats.ports[targ_port].dma_time[type],
13260 &io->io_hdr.dma_bt);
13261 getbinuptime(&cur_bt);
13262 bintime_sub(&cur_bt, &io->io_hdr.start_bt);
13263 bintime_add(&lun->stats.ports[targ_port].time[type], &cur_bt);
13265 lun->stats.ports[targ_port].num_dmas[type] +=
13266 io->io_hdr.num_dmas;
13270 * Remove this from the OOA queue.
13272 TAILQ_REMOVE(&lun->ooa_queue, &io->io_hdr, ooa_links);
13274 if (TAILQ_EMPTY(&lun->ooa_queue))
13275 lun->last_busy = getsbinuptime();
13279 * Run through the blocked queue on this LUN and see if anything
13280 * has become unblocked, now that this transaction is done.
13282 ctl_check_blocked(lun);
13285 * If the LUN has been invalidated, free it if there is nothing
13286 * left on its OOA queue.
13288 if ((lun->flags & CTL_LUN_INVALID)
13289 && TAILQ_EMPTY(&lun->ooa_queue)) {
13290 mtx_unlock(&lun->lun_lock);
13291 mtx_lock(&softc->ctl_lock);
13293 mtx_unlock(&softc->ctl_lock);
13295 mtx_unlock(&lun->lun_lock);
13300 * If this command has been aborted, make sure we set the status
13301 * properly. The FETD is responsible for freeing the I/O and doing
13302 * whatever it needs to do to clean up its state.
13304 if (io->io_hdr.flags & CTL_FLAG_ABORT)
13305 ctl_set_task_aborted(&io->scsiio);
13308 * If enabled, print command error status.
13310 if ((io->io_hdr.status & CTL_STATUS_MASK) != CTL_SUCCESS &&
13311 (ctl_debug & CTL_DEBUG_INFO) != 0)
13312 ctl_io_error_print(io, NULL);
13315 * Tell the FETD or the other shelf controller we're done with this
13316 * command. Note that only SCSI commands get to this point. Task
13317 * management commands are completed above.
13319 if ((softc->ha_mode != CTL_HA_MODE_XFER) &&
13320 (io->io_hdr.flags & CTL_FLAG_SENT_2OTHER_SC)) {
13321 memset(&msg, 0, sizeof(msg));
13322 msg.hdr.msg_type = CTL_MSG_FINISH_IO;
13323 msg.hdr.serializing_sc = io->io_hdr.serializing_sc;
13324 msg.hdr.nexus = io->io_hdr.nexus;
13325 ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg,
13326 sizeof(msg.scsi) - sizeof(msg.scsi.sense_data),
13335 * Front end should call this if it doesn't do autosense. When the request
13336 * sense comes back in from the initiator, we'll dequeue this and send it.
13339 ctl_queue_sense(union ctl_io *io)
13341 struct ctl_lun *lun;
13342 struct ctl_port *port;
13343 struct ctl_softc *softc;
13344 uint32_t initidx, targ_lun;
13346 softc = control_softc;
13348 CTL_DEBUG_PRINT(("ctl_queue_sense\n"));
13351 * LUN lookup will likely move to the ctl_work_thread() once we
13352 * have our new queueing infrastructure (that doesn't put things on
13353 * a per-LUN queue initially). That is so that we can handle
13354 * things like an INQUIRY to a LUN that we don't have enabled. We
13355 * can't deal with that right now.
13357 mtx_lock(&softc->ctl_lock);
13360 * If we don't have a LUN for this, just toss the sense
13363 port = ctl_io_port(&ctsio->io_hdr);
13364 targ_lun = ctl_lun_map_from_port(port, io->io_hdr.nexus.targ_lun);
13365 if ((targ_lun < CTL_MAX_LUNS)
13366 && (softc->ctl_luns[targ_lun] != NULL))
13367 lun = softc->ctl_luns[targ_lun];
13371 initidx = ctl_get_initindex(&io->io_hdr.nexus);
13373 mtx_lock(&lun->lun_lock);
13375 * Already have CA set for this LUN...toss the sense information.
13377 if (ctl_is_set(lun->have_ca, initidx)) {
13378 mtx_unlock(&lun->lun_lock);
13382 memcpy(&lun->pending_sense[initidx], &io->scsiio.sense_data,
13383 MIN(sizeof(lun->pending_sense[initidx]),
13384 sizeof(io->scsiio.sense_data)));
13385 ctl_set_mask(lun->have_ca, initidx);
13386 mtx_unlock(&lun->lun_lock);
13389 mtx_unlock(&softc->ctl_lock);
13393 return (CTL_RETVAL_COMPLETE);
13398 * Primary command inlet from frontend ports. All SCSI and task I/O
13399 * requests must go through this function.
13402 ctl_queue(union ctl_io *io)
13404 struct ctl_port *port;
13406 CTL_DEBUG_PRINT(("ctl_queue cdb[0]=%02X\n", io->scsiio.cdb[0]));
13409 io->io_hdr.start_time = time_uptime;
13410 getbinuptime(&io->io_hdr.start_bt);
13411 #endif /* CTL_TIME_IO */
13413 /* Map FE-specific LUN ID into global one. */
13414 port = ctl_io_port(&io->io_hdr);
13415 io->io_hdr.nexus.targ_mapped_lun =
13416 ctl_lun_map_from_port(port, io->io_hdr.nexus.targ_lun);
13418 switch (io->io_hdr.io_type) {
13421 if (ctl_debug & CTL_DEBUG_CDB)
13423 ctl_enqueue_incoming(io);
13426 printf("ctl_queue: unknown I/O type %d\n", io->io_hdr.io_type);
13430 return (CTL_RETVAL_COMPLETE);
13433 #ifdef CTL_IO_DELAY
13435 ctl_done_timer_wakeup(void *arg)
13439 io = (union ctl_io *)arg;
13442 #endif /* CTL_IO_DELAY */
13445 ctl_serseq_done(union ctl_io *io)
13447 struct ctl_lun *lun;
13449 lun = (struct ctl_lun *)io->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
13450 if (lun->be_lun == NULL ||
13451 lun->be_lun->serseq == CTL_LUN_SERSEQ_OFF)
13453 mtx_lock(&lun->lun_lock);
13454 io->io_hdr.flags |= CTL_FLAG_SERSEQ_DONE;
13455 ctl_check_blocked(lun);
13456 mtx_unlock(&lun->lun_lock);
13460 ctl_done(union ctl_io *io)
13464 * Enable this to catch duplicate completion issues.
13467 if (io->io_hdr.flags & CTL_FLAG_ALREADY_DONE) {
13468 printf("%s: type %d msg %d cdb %x iptl: "
13469 "%u:%u:%u tag 0x%04x "
13470 "flag %#x status %x\n",
13472 io->io_hdr.io_type,
13473 io->io_hdr.msg_type,
13475 io->io_hdr.nexus.initid,
13476 io->io_hdr.nexus.targ_port,
13477 io->io_hdr.nexus.targ_lun,
13478 (io->io_hdr.io_type ==
13480 io->taskio.tag_num :
13481 io->scsiio.tag_num,
13483 io->io_hdr.status);
13485 io->io_hdr.flags |= CTL_FLAG_ALREADY_DONE;
13489 * This is an internal copy of an I/O, and should not go through
13490 * the normal done processing logic.
13492 if (io->io_hdr.flags & CTL_FLAG_INT_COPY)
13495 #ifdef CTL_IO_DELAY
13496 if (io->io_hdr.flags & CTL_FLAG_DELAY_DONE) {
13497 io->io_hdr.flags &= ~CTL_FLAG_DELAY_DONE;
13499 struct ctl_lun *lun;
13501 lun =(struct ctl_lun *)io->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
13504 && (lun->delay_info.done_delay > 0)) {
13506 callout_init(&io->io_hdr.delay_callout, /*mpsafe*/ 1);
13507 io->io_hdr.flags |= CTL_FLAG_DELAY_DONE;
13508 callout_reset(&io->io_hdr.delay_callout,
13509 lun->delay_info.done_delay * hz,
13510 ctl_done_timer_wakeup, io);
13511 if (lun->delay_info.done_type == CTL_DELAY_TYPE_ONESHOT)
13512 lun->delay_info.done_delay = 0;
13516 #endif /* CTL_IO_DELAY */
13518 ctl_enqueue_done(io);
13522 ctl_work_thread(void *arg)
13524 struct ctl_thread *thr = (struct ctl_thread *)arg;
13525 struct ctl_softc *softc = thr->ctl_softc;
13529 CTL_DEBUG_PRINT(("ctl_work_thread starting\n"));
13533 * We handle the queues in this order:
13535 * - done queue (to free up resources, unblock other commands)
13539 * If those queues are empty, we break out of the loop and
13542 mtx_lock(&thr->queue_lock);
13543 io = (union ctl_io *)STAILQ_FIRST(&thr->isc_queue);
13545 STAILQ_REMOVE_HEAD(&thr->isc_queue, links);
13546 mtx_unlock(&thr->queue_lock);
13547 ctl_handle_isc(io);
13550 io = (union ctl_io *)STAILQ_FIRST(&thr->done_queue);
13552 STAILQ_REMOVE_HEAD(&thr->done_queue, links);
13553 /* clear any blocked commands, call fe_done */
13554 mtx_unlock(&thr->queue_lock);
13555 ctl_process_done(io);
13558 io = (union ctl_io *)STAILQ_FIRST(&thr->incoming_queue);
13560 STAILQ_REMOVE_HEAD(&thr->incoming_queue, links);
13561 mtx_unlock(&thr->queue_lock);
13562 if (io->io_hdr.io_type == CTL_IO_TASK)
13565 ctl_scsiio_precheck(softc, &io->scsiio);
13568 io = (union ctl_io *)STAILQ_FIRST(&thr->rtr_queue);
13570 STAILQ_REMOVE_HEAD(&thr->rtr_queue, links);
13571 mtx_unlock(&thr->queue_lock);
13572 retval = ctl_scsiio(&io->scsiio);
13573 if (retval != CTL_RETVAL_COMPLETE)
13574 CTL_DEBUG_PRINT(("ctl_scsiio failed\n"));
13578 /* Sleep until we have something to do. */
13579 mtx_sleep(thr, &thr->queue_lock, PDROP | PRIBIO, "-", 0);
13584 ctl_lun_thread(void *arg)
13586 struct ctl_softc *softc = (struct ctl_softc *)arg;
13587 struct ctl_be_lun *be_lun;
13589 CTL_DEBUG_PRINT(("ctl_lun_thread starting\n"));
13592 mtx_lock(&softc->ctl_lock);
13593 be_lun = STAILQ_FIRST(&softc->pending_lun_queue);
13594 if (be_lun != NULL) {
13595 STAILQ_REMOVE_HEAD(&softc->pending_lun_queue, links);
13596 mtx_unlock(&softc->ctl_lock);
13597 ctl_create_lun(be_lun);
13601 /* Sleep until we have something to do. */
13602 mtx_sleep(&softc->pending_lun_queue, &softc->ctl_lock,
13603 PDROP | PRIBIO, "-", 0);
13608 ctl_thresh_thread(void *arg)
13610 struct ctl_softc *softc = (struct ctl_softc *)arg;
13611 struct ctl_lun *lun;
13612 struct ctl_logical_block_provisioning_page *page;
13614 union ctl_ha_msg msg;
13615 uint64_t thres, val;
13618 CTL_DEBUG_PRINT(("ctl_thresh_thread starting\n"));
13621 mtx_lock(&softc->ctl_lock);
13622 STAILQ_FOREACH(lun, &softc->lun_list, links) {
13623 if ((lun->flags & CTL_LUN_DISABLED) ||
13624 (lun->flags & CTL_LUN_NO_MEDIA) ||
13625 lun->backend->lun_attr == NULL)
13627 if ((lun->flags & CTL_LUN_PRIMARY_SC) == 0 &&
13628 softc->ha_mode == CTL_HA_MODE_XFER)
13630 if ((lun->MODE_RWER.byte8 & SMS_RWER_LBPERE) == 0)
13633 page = &lun->MODE_LBP;
13634 for (i = 0; i < CTL_NUM_LBP_THRESH; i++) {
13635 if ((page->descr[i].flags & SLBPPD_ENABLED) == 0)
13637 thres = scsi_4btoul(page->descr[i].count);
13638 thres <<= CTL_LBP_EXPONENT;
13639 switch (page->descr[i].resource) {
13641 attr = "blocksavail";
13644 attr = "blocksused";
13647 attr = "poolblocksavail";
13650 attr = "poolblocksused";
13655 mtx_unlock(&softc->ctl_lock); // XXX
13656 val = lun->backend->lun_attr(
13657 lun->be_lun->be_lun, attr);
13658 mtx_lock(&softc->ctl_lock);
13659 if (val == UINT64_MAX)
13661 if ((page->descr[i].flags & SLBPPD_ARMING_MASK)
13662 == SLBPPD_ARMING_INC)
13663 e = (val >= thres);
13665 e = (val <= thres);
13669 mtx_lock(&lun->lun_lock);
13671 scsi_u64to8b((uint8_t *)&page->descr[i] -
13672 (uint8_t *)page, lun->ua_tpt_info);
13673 if (lun->lasttpt == 0 ||
13674 time_uptime - lun->lasttpt >= CTL_LBP_UA_PERIOD) {
13675 lun->lasttpt = time_uptime;
13676 ctl_est_ua_all(lun, -1, CTL_UA_THIN_PROV_THRES);
13682 ctl_clr_ua_all(lun, -1, CTL_UA_THIN_PROV_THRES);
13685 mtx_unlock(&lun->lun_lock);
13687 lun->ctl_softc->ha_mode == CTL_HA_MODE_XFER) {
13688 /* Send msg to other side. */
13689 bzero(&msg.ua, sizeof(msg.ua));
13690 msg.hdr.msg_type = CTL_MSG_UA;
13691 msg.hdr.nexus.initid = -1;
13692 msg.hdr.nexus.targ_port = -1;
13693 msg.hdr.nexus.targ_lun = lun->lun;
13694 msg.hdr.nexus.targ_mapped_lun = lun->lun;
13696 msg.ua.ua_set = (set > 0);
13697 msg.ua.ua_type = CTL_UA_THIN_PROV_THRES;
13698 memcpy(msg.ua.ua_info, lun->ua_tpt_info, 8);
13699 mtx_unlock(&softc->ctl_lock); // XXX
13700 ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg,
13701 sizeof(msg.ua), M_WAITOK);
13702 mtx_lock(&softc->ctl_lock);
13705 mtx_unlock(&softc->ctl_lock);
13706 pause("-", CTL_LBP_PERIOD * hz);
13711 ctl_enqueue_incoming(union ctl_io *io)
13713 struct ctl_softc *softc = control_softc;
13714 struct ctl_thread *thr;
13717 idx = (io->io_hdr.nexus.targ_port * 127 +
13718 io->io_hdr.nexus.initid) % worker_threads;
13719 thr = &softc->threads[idx];
13720 mtx_lock(&thr->queue_lock);
13721 STAILQ_INSERT_TAIL(&thr->incoming_queue, &io->io_hdr, links);
13722 mtx_unlock(&thr->queue_lock);
13727 ctl_enqueue_rtr(union ctl_io *io)
13729 struct ctl_softc *softc = control_softc;
13730 struct ctl_thread *thr;
13732 thr = &softc->threads[io->io_hdr.nexus.targ_mapped_lun % worker_threads];
13733 mtx_lock(&thr->queue_lock);
13734 STAILQ_INSERT_TAIL(&thr->rtr_queue, &io->io_hdr, links);
13735 mtx_unlock(&thr->queue_lock);
13740 ctl_enqueue_done(union ctl_io *io)
13742 struct ctl_softc *softc = control_softc;
13743 struct ctl_thread *thr;
13745 thr = &softc->threads[io->io_hdr.nexus.targ_mapped_lun % worker_threads];
13746 mtx_lock(&thr->queue_lock);
13747 STAILQ_INSERT_TAIL(&thr->done_queue, &io->io_hdr, links);
13748 mtx_unlock(&thr->queue_lock);
13753 ctl_enqueue_isc(union ctl_io *io)
13755 struct ctl_softc *softc = control_softc;
13756 struct ctl_thread *thr;
13758 thr = &softc->threads[io->io_hdr.nexus.targ_mapped_lun % worker_threads];
13759 mtx_lock(&thr->queue_lock);
13760 STAILQ_INSERT_TAIL(&thr->isc_queue, &io->io_hdr, links);
13761 mtx_unlock(&thr->queue_lock);