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 copan_debugconf_subpage debugconf_page_default = {
97 DBGCNF_PAGE_CODE | SMPH_SPF, /* page_code */
98 DBGCNF_SUBPAGE_CODE, /* subpage */
99 {(sizeof(struct copan_debugconf_subpage) - 4) >> 8,
100 (sizeof(struct copan_debugconf_subpage) - 4) >> 0}, /* page_length */
101 DBGCNF_VERSION, /* page_version */
102 {CTL_TIME_IO_DEFAULT_SECS>>8,
103 CTL_TIME_IO_DEFAULT_SECS>>0}, /* ctl_time_io_secs */
106 const static struct copan_debugconf_subpage debugconf_page_changeable = {
107 DBGCNF_PAGE_CODE | SMPH_SPF, /* page_code */
108 DBGCNF_SUBPAGE_CODE, /* subpage */
109 {(sizeof(struct copan_debugconf_subpage) - 4) >> 8,
110 (sizeof(struct copan_debugconf_subpage) - 4) >> 0}, /* page_length */
111 0, /* page_version */
112 {0xff,0xff}, /* ctl_time_io_secs */
115 const static struct scsi_da_rw_recovery_page rw_er_page_default = {
116 /*page_code*/SMS_RW_ERROR_RECOVERY_PAGE,
117 /*page_length*/sizeof(struct scsi_da_rw_recovery_page) - 2,
118 /*byte3*/SMS_RWER_AWRE|SMS_RWER_ARRE,
119 /*read_retry_count*/0,
120 /*correction_span*/0,
121 /*head_offset_count*/0,
122 /*data_strobe_offset_cnt*/0,
123 /*byte8*/SMS_RWER_LBPERE,
124 /*write_retry_count*/0,
126 /*recovery_time_limit*/{0, 0},
129 const static struct scsi_da_rw_recovery_page rw_er_page_changeable = {
130 /*page_code*/SMS_RW_ERROR_RECOVERY_PAGE,
131 /*page_length*/sizeof(struct scsi_da_rw_recovery_page) - 2,
133 /*read_retry_count*/0,
134 /*correction_span*/0,
135 /*head_offset_count*/0,
136 /*data_strobe_offset_cnt*/0,
138 /*write_retry_count*/0,
140 /*recovery_time_limit*/{0, 0},
143 const static struct scsi_format_page format_page_default = {
144 /*page_code*/SMS_FORMAT_DEVICE_PAGE,
145 /*page_length*/sizeof(struct scsi_format_page) - 2,
146 /*tracks_per_zone*/ {0, 0},
147 /*alt_sectors_per_zone*/ {0, 0},
148 /*alt_tracks_per_zone*/ {0, 0},
149 /*alt_tracks_per_lun*/ {0, 0},
150 /*sectors_per_track*/ {(CTL_DEFAULT_SECTORS_PER_TRACK >> 8) & 0xff,
151 CTL_DEFAULT_SECTORS_PER_TRACK & 0xff},
152 /*bytes_per_sector*/ {0, 0},
153 /*interleave*/ {0, 0},
154 /*track_skew*/ {0, 0},
155 /*cylinder_skew*/ {0, 0},
157 /*reserved*/ {0, 0, 0}
160 const static struct scsi_format_page format_page_changeable = {
161 /*page_code*/SMS_FORMAT_DEVICE_PAGE,
162 /*page_length*/sizeof(struct scsi_format_page) - 2,
163 /*tracks_per_zone*/ {0, 0},
164 /*alt_sectors_per_zone*/ {0, 0},
165 /*alt_tracks_per_zone*/ {0, 0},
166 /*alt_tracks_per_lun*/ {0, 0},
167 /*sectors_per_track*/ {0, 0},
168 /*bytes_per_sector*/ {0, 0},
169 /*interleave*/ {0, 0},
170 /*track_skew*/ {0, 0},
171 /*cylinder_skew*/ {0, 0},
173 /*reserved*/ {0, 0, 0}
176 const static struct scsi_rigid_disk_page rigid_disk_page_default = {
177 /*page_code*/SMS_RIGID_DISK_PAGE,
178 /*page_length*/sizeof(struct scsi_rigid_disk_page) - 2,
179 /*cylinders*/ {0, 0, 0},
180 /*heads*/ CTL_DEFAULT_HEADS,
181 /*start_write_precomp*/ {0, 0, 0},
182 /*start_reduced_current*/ {0, 0, 0},
183 /*step_rate*/ {0, 0},
184 /*landing_zone_cylinder*/ {0, 0, 0},
185 /*rpl*/ SRDP_RPL_DISABLED,
186 /*rotational_offset*/ 0,
188 /*rotation_rate*/ {(CTL_DEFAULT_ROTATION_RATE >> 8) & 0xff,
189 CTL_DEFAULT_ROTATION_RATE & 0xff},
193 const static struct scsi_rigid_disk_page rigid_disk_page_changeable = {
194 /*page_code*/SMS_RIGID_DISK_PAGE,
195 /*page_length*/sizeof(struct scsi_rigid_disk_page) - 2,
196 /*cylinders*/ {0, 0, 0},
198 /*start_write_precomp*/ {0, 0, 0},
199 /*start_reduced_current*/ {0, 0, 0},
200 /*step_rate*/ {0, 0},
201 /*landing_zone_cylinder*/ {0, 0, 0},
203 /*rotational_offset*/ 0,
205 /*rotation_rate*/ {0, 0},
209 const static struct scsi_caching_page caching_page_default = {
210 /*page_code*/SMS_CACHING_PAGE,
211 /*page_length*/sizeof(struct scsi_caching_page) - 2,
212 /*flags1*/ SCP_DISC | SCP_WCE,
214 /*disable_pf_transfer_len*/ {0xff, 0xff},
215 /*min_prefetch*/ {0, 0},
216 /*max_prefetch*/ {0xff, 0xff},
217 /*max_pf_ceiling*/ {0xff, 0xff},
219 /*cache_segments*/ 0,
220 /*cache_seg_size*/ {0, 0},
222 /*non_cache_seg_size*/ {0, 0, 0}
225 const static struct scsi_caching_page caching_page_changeable = {
226 /*page_code*/SMS_CACHING_PAGE,
227 /*page_length*/sizeof(struct scsi_caching_page) - 2,
228 /*flags1*/ SCP_WCE | SCP_RCD,
230 /*disable_pf_transfer_len*/ {0, 0},
231 /*min_prefetch*/ {0, 0},
232 /*max_prefetch*/ {0, 0},
233 /*max_pf_ceiling*/ {0, 0},
235 /*cache_segments*/ 0,
236 /*cache_seg_size*/ {0, 0},
238 /*non_cache_seg_size*/ {0, 0, 0}
241 const static struct scsi_control_page control_page_default = {
242 /*page_code*/SMS_CONTROL_MODE_PAGE,
243 /*page_length*/sizeof(struct scsi_control_page) - 2,
245 /*queue_flags*/SCP_QUEUE_ALG_RESTRICTED,
248 /*aen_holdoff_period*/{0, 0},
249 /*busy_timeout_period*/{0, 0},
250 /*extended_selftest_completion_time*/{0, 0}
253 const static struct scsi_control_page control_page_changeable = {
254 /*page_code*/SMS_CONTROL_MODE_PAGE,
255 /*page_length*/sizeof(struct scsi_control_page) - 2,
257 /*queue_flags*/SCP_QUEUE_ALG_MASK,
258 /*eca_and_aen*/SCP_SWP,
260 /*aen_holdoff_period*/{0, 0},
261 /*busy_timeout_period*/{0, 0},
262 /*extended_selftest_completion_time*/{0, 0}
265 #define CTL_CEM_LEN (sizeof(struct scsi_control_ext_page) - 4)
267 const static struct scsi_control_ext_page control_ext_page_default = {
268 /*page_code*/SMS_CONTROL_MODE_PAGE | SMPH_SPF,
269 /*subpage_code*/0x01,
270 /*page_length*/{CTL_CEM_LEN >> 8, CTL_CEM_LEN},
276 const static struct scsi_control_ext_page control_ext_page_changeable = {
277 /*page_code*/SMS_CONTROL_MODE_PAGE | SMPH_SPF,
278 /*subpage_code*/0x01,
279 /*page_length*/{CTL_CEM_LEN >> 8, CTL_CEM_LEN},
285 const static struct scsi_info_exceptions_page ie_page_default = {
286 /*page_code*/SMS_INFO_EXCEPTIONS_PAGE,
287 /*page_length*/sizeof(struct scsi_info_exceptions_page) - 2,
288 /*info_flags*/SIEP_FLAGS_DEXCPT,
290 /*interval_timer*/{0, 0, 0, 0},
291 /*report_count*/{0, 0, 0, 0}
294 const static struct scsi_info_exceptions_page ie_page_changeable = {
295 /*page_code*/SMS_INFO_EXCEPTIONS_PAGE,
296 /*page_length*/sizeof(struct scsi_info_exceptions_page) - 2,
299 /*interval_timer*/{0, 0, 0, 0},
300 /*report_count*/{0, 0, 0, 0}
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},
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 SYSCTL_INT(_kern_cam_ctl, OID_AUTO, worker_threads, CTLFLAG_RDTUN,
406 &worker_threads, 1, "Number of worker threads");
407 static int ctl_debug = CTL_DEBUG_NONE;
408 SYSCTL_INT(_kern_cam_ctl, OID_AUTO, debug, CTLFLAG_RWTUN,
409 &ctl_debug, 0, "Enabled debug flags");
412 * Supported pages (0x00), Serial number (0x80), Device ID (0x83),
413 * Extended INQUIRY Data (0x86), Mode Page Policy (0x87),
414 * SCSI Ports (0x88), Third-party Copy (0x8F), Block limits (0xB0),
415 * Block Device Characteristics (0xB1) and Logical Block Provisioning (0xB2)
417 #define SCSI_EVPD_NUM_SUPPORTED_PAGES 10
419 static void ctl_isc_event_handler(ctl_ha_channel chanel, ctl_ha_event event,
421 static void ctl_copy_sense_data(union ctl_ha_msg *src, union ctl_io *dest);
422 static void ctl_copy_sense_data_back(union ctl_io *src, union ctl_ha_msg *dest);
423 static int ctl_init(void);
424 void ctl_shutdown(void);
425 static int ctl_open(struct cdev *dev, int flags, int fmt, struct thread *td);
426 static int ctl_close(struct cdev *dev, int flags, int fmt, struct thread *td);
427 static int ctl_serialize_other_sc_cmd(struct ctl_scsiio *ctsio);
428 static void ctl_ioctl_fill_ooa(struct ctl_lun *lun, uint32_t *cur_fill_num,
429 struct ctl_ooa *ooa_hdr,
430 struct ctl_ooa_entry *kern_entries);
431 static int ctl_ioctl(struct cdev *dev, u_long cmd, caddr_t addr, int flag,
433 static int ctl_alloc_lun(struct ctl_softc *ctl_softc, struct ctl_lun *lun,
434 struct ctl_be_lun *be_lun);
435 static int ctl_free_lun(struct ctl_lun *lun);
436 static void ctl_create_lun(struct ctl_be_lun *be_lun);
437 static struct ctl_port * ctl_io_port(struct ctl_io_hdr *io_hdr);
439 static int ctl_do_mode_select(union ctl_io *io);
440 static int ctl_pro_preempt(struct ctl_softc *softc, struct ctl_lun *lun,
441 uint64_t res_key, uint64_t sa_res_key,
442 uint8_t type, uint32_t residx,
443 struct ctl_scsiio *ctsio,
444 struct scsi_per_res_out *cdb,
445 struct scsi_per_res_out_parms* param);
446 static void ctl_pro_preempt_other(struct ctl_lun *lun,
447 union ctl_ha_msg *msg);
448 static void ctl_hndl_per_res_out_on_other_sc(union ctl_ha_msg *msg);
449 static int ctl_inquiry_evpd_supported(struct ctl_scsiio *ctsio, int alloc_len);
450 static int ctl_inquiry_evpd_serial(struct ctl_scsiio *ctsio, int alloc_len);
451 static int ctl_inquiry_evpd_devid(struct ctl_scsiio *ctsio, int alloc_len);
452 static int ctl_inquiry_evpd_eid(struct ctl_scsiio *ctsio, int alloc_len);
453 static int ctl_inquiry_evpd_mpp(struct ctl_scsiio *ctsio, int alloc_len);
454 static int ctl_inquiry_evpd_scsi_ports(struct ctl_scsiio *ctsio,
456 static int ctl_inquiry_evpd_block_limits(struct ctl_scsiio *ctsio,
458 static int ctl_inquiry_evpd_bdc(struct ctl_scsiio *ctsio, int alloc_len);
459 static int ctl_inquiry_evpd_lbp(struct ctl_scsiio *ctsio, int alloc_len);
460 static int ctl_inquiry_evpd(struct ctl_scsiio *ctsio);
461 static int ctl_inquiry_std(struct ctl_scsiio *ctsio);
462 static int ctl_get_lba_len(union ctl_io *io, uint64_t *lba, uint64_t *len);
463 static ctl_action ctl_extent_check(union ctl_io *io1, union ctl_io *io2,
465 static ctl_action ctl_extent_check_seq(union ctl_io *io1, union ctl_io *io2);
466 static ctl_action ctl_check_for_blockage(struct ctl_lun *lun,
467 union ctl_io *pending_io, union ctl_io *ooa_io);
468 static ctl_action ctl_check_ooa(struct ctl_lun *lun, union ctl_io *pending_io,
469 union ctl_io *starting_io);
470 static int ctl_check_blocked(struct ctl_lun *lun);
471 static int ctl_scsiio_lun_check(struct ctl_lun *lun,
472 const struct ctl_cmd_entry *entry,
473 struct ctl_scsiio *ctsio);
474 static void ctl_failover_lun(union ctl_io *io);
475 static int ctl_scsiio_precheck(struct ctl_softc *ctl_softc,
476 struct ctl_scsiio *ctsio);
477 static int ctl_scsiio(struct ctl_scsiio *ctsio);
479 static int ctl_bus_reset(struct ctl_softc *ctl_softc, union ctl_io *io);
480 static int ctl_target_reset(struct ctl_softc *ctl_softc, union ctl_io *io,
481 ctl_ua_type ua_type);
482 static int ctl_do_lun_reset(struct ctl_lun *lun, union ctl_io *io,
483 ctl_ua_type ua_type);
484 static int ctl_lun_reset(struct ctl_softc *ctl_softc, union ctl_io *io);
485 static int ctl_abort_task(union ctl_io *io);
486 static int ctl_abort_task_set(union ctl_io *io);
487 static int ctl_query_task(union ctl_io *io, int task_set);
488 static int ctl_i_t_nexus_reset(union ctl_io *io);
489 static int ctl_query_async_event(union ctl_io *io);
490 static void ctl_run_task(union ctl_io *io);
492 static void ctl_datamove_timer_wakeup(void *arg);
493 static void ctl_done_timer_wakeup(void *arg);
494 #endif /* CTL_IO_DELAY */
496 static void ctl_send_datamove_done(union ctl_io *io, int have_lock);
497 static void ctl_datamove_remote_write_cb(struct ctl_ha_dt_req *rq);
498 static int ctl_datamove_remote_dm_write_cb(union ctl_io *io);
499 static void ctl_datamove_remote_write(union ctl_io *io);
500 static int ctl_datamove_remote_dm_read_cb(union ctl_io *io);
501 static void ctl_datamove_remote_read_cb(struct ctl_ha_dt_req *rq);
502 static int ctl_datamove_remote_sgl_setup(union ctl_io *io);
503 static int ctl_datamove_remote_xfer(union ctl_io *io, unsigned command,
504 ctl_ha_dt_cb callback);
505 static void ctl_datamove_remote_read(union ctl_io *io);
506 static void ctl_datamove_remote(union ctl_io *io);
507 static void ctl_process_done(union ctl_io *io);
508 static void ctl_lun_thread(void *arg);
509 static void ctl_thresh_thread(void *arg);
510 static void ctl_work_thread(void *arg);
511 static void ctl_enqueue_incoming(union ctl_io *io);
512 static void ctl_enqueue_rtr(union ctl_io *io);
513 static void ctl_enqueue_done(union ctl_io *io);
514 static void ctl_enqueue_isc(union ctl_io *io);
515 static const struct ctl_cmd_entry *
516 ctl_get_cmd_entry(struct ctl_scsiio *ctsio, int *sa);
517 static const struct ctl_cmd_entry *
518 ctl_validate_command(struct ctl_scsiio *ctsio);
519 static int ctl_cmd_applicable(uint8_t lun_type,
520 const struct ctl_cmd_entry *entry);
522 static uint64_t ctl_get_prkey(struct ctl_lun *lun, uint32_t residx);
523 static void ctl_clr_prkey(struct ctl_lun *lun, uint32_t residx);
524 static void ctl_alloc_prkey(struct ctl_lun *lun, uint32_t residx);
525 static void ctl_set_prkey(struct ctl_lun *lun, uint32_t residx, uint64_t key);
528 * Load the serialization table. This isn't very pretty, but is probably
529 * the easiest way to do it.
531 #include "ctl_ser_table.c"
534 * We only need to define open, close and ioctl routines for this driver.
536 static struct cdevsw ctl_cdevsw = {
537 .d_version = D_VERSION,
540 .d_close = ctl_close,
541 .d_ioctl = ctl_ioctl,
546 MALLOC_DEFINE(M_CTL, "ctlmem", "Memory used for CTL");
548 static int ctl_module_event_handler(module_t, int /*modeventtype_t*/, void *);
550 static moduledata_t ctl_moduledata = {
552 ctl_module_event_handler,
556 DECLARE_MODULE(ctl, ctl_moduledata, SI_SUB_CONFIGURE, SI_ORDER_THIRD);
557 MODULE_VERSION(ctl, 1);
559 static struct ctl_frontend ha_frontend =
565 ctl_ha_datamove(union ctl_io *io)
568 struct ctl_sg_entry *sgl;
569 union ctl_ha_msg msg;
570 uint32_t sg_entries_sent;
571 int do_sg_copy, i, j;
573 lun = (struct ctl_lun *)io->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
574 memset(&msg.dt, 0, sizeof(msg.dt));
575 msg.hdr.msg_type = CTL_MSG_DATAMOVE;
576 msg.hdr.original_sc = io->io_hdr.original_sc;
577 msg.hdr.serializing_sc = io;
578 msg.hdr.nexus = io->io_hdr.nexus;
579 msg.hdr.status = io->io_hdr.status;
580 msg.dt.flags = io->io_hdr.flags;
583 * We convert everything into a S/G list here. We can't
584 * pass by reference, only by value between controllers.
585 * So we can't pass a pointer to the S/G list, only as many
586 * S/G entries as we can fit in here. If it's possible for
587 * us to get more than CTL_HA_MAX_SG_ENTRIES S/G entries,
588 * then we need to break this up into multiple transfers.
590 if (io->scsiio.kern_sg_entries == 0) {
591 msg.dt.kern_sg_entries = 1;
593 if (io->io_hdr.flags & CTL_FLAG_BUS_ADDR) {
594 msg.dt.sg_list[0].addr = io->scsiio.kern_data_ptr;
596 /* XXX KDM use busdma here! */
597 msg.dt.sg_list[0].addr =
598 (void *)vtophys(io->scsiio.kern_data_ptr);
601 KASSERT((io->io_hdr.flags & CTL_FLAG_BUS_ADDR) == 0,
602 ("HA does not support BUS_ADDR"));
603 msg.dt.sg_list[0].addr = io->scsiio.kern_data_ptr;
605 msg.dt.sg_list[0].len = io->scsiio.kern_data_len;
608 msg.dt.kern_sg_entries = io->scsiio.kern_sg_entries;
612 msg.dt.kern_data_len = io->scsiio.kern_data_len;
613 msg.dt.kern_total_len = io->scsiio.kern_total_len;
614 msg.dt.kern_data_resid = io->scsiio.kern_data_resid;
615 msg.dt.kern_rel_offset = io->scsiio.kern_rel_offset;
616 msg.dt.sg_sequence = 0;
619 * Loop until we've sent all of the S/G entries. On the
620 * other end, we'll recompose these S/G entries into one
621 * contiguous list before processing.
623 for (sg_entries_sent = 0; sg_entries_sent < msg.dt.kern_sg_entries;
624 msg.dt.sg_sequence++) {
625 msg.dt.cur_sg_entries = MIN((sizeof(msg.dt.sg_list) /
626 sizeof(msg.dt.sg_list[0])),
627 msg.dt.kern_sg_entries - sg_entries_sent);
628 if (do_sg_copy != 0) {
629 sgl = (struct ctl_sg_entry *)io->scsiio.kern_data_ptr;
630 for (i = sg_entries_sent, j = 0;
631 i < msg.dt.cur_sg_entries; i++, j++) {
633 if (io->io_hdr.flags & CTL_FLAG_BUS_ADDR) {
634 msg.dt.sg_list[j].addr = sgl[i].addr;
636 /* XXX KDM use busdma here! */
637 msg.dt.sg_list[j].addr =
638 (void *)vtophys(sgl[i].addr);
641 KASSERT((io->io_hdr.flags &
642 CTL_FLAG_BUS_ADDR) == 0,
643 ("HA does not support BUS_ADDR"));
644 msg.dt.sg_list[j].addr = sgl[i].addr;
646 msg.dt.sg_list[j].len = sgl[i].len;
650 sg_entries_sent += msg.dt.cur_sg_entries;
651 msg.dt.sg_last = (sg_entries_sent >= msg.dt.kern_sg_entries);
652 if (ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg,
653 sizeof(msg.dt) - sizeof(msg.dt.sg_list) +
654 sizeof(struct ctl_sg_entry) * msg.dt.cur_sg_entries,
655 M_WAITOK) > CTL_HA_STATUS_SUCCESS) {
656 io->io_hdr.port_status = 31341;
657 io->scsiio.be_move_done(io);
660 msg.dt.sent_sg_entries = sg_entries_sent;
664 * Officially handover the request from us to peer.
665 * If failover has just happened, then we must return error.
666 * If failover happen just after, then it is not our problem.
669 mtx_lock(&lun->lun_lock);
670 if (io->io_hdr.flags & CTL_FLAG_FAILOVER) {
672 mtx_unlock(&lun->lun_lock);
673 io->io_hdr.port_status = 31342;
674 io->scsiio.be_move_done(io);
677 io->io_hdr.flags &= ~CTL_FLAG_IO_ACTIVE;
678 io->io_hdr.flags |= CTL_FLAG_DMA_INPROG;
680 mtx_unlock(&lun->lun_lock);
684 ctl_ha_done(union ctl_io *io)
686 union ctl_ha_msg msg;
688 if (io->io_hdr.io_type == CTL_IO_SCSI) {
689 memset(&msg, 0, sizeof(msg));
690 msg.hdr.msg_type = CTL_MSG_FINISH_IO;
691 msg.hdr.original_sc = io->io_hdr.original_sc;
692 msg.hdr.nexus = io->io_hdr.nexus;
693 msg.hdr.status = io->io_hdr.status;
694 msg.scsi.scsi_status = io->scsiio.scsi_status;
695 msg.scsi.tag_num = io->scsiio.tag_num;
696 msg.scsi.tag_type = io->scsiio.tag_type;
697 msg.scsi.sense_len = io->scsiio.sense_len;
698 msg.scsi.sense_residual = io->scsiio.sense_residual;
699 msg.scsi.residual = io->scsiio.residual;
700 memcpy(&msg.scsi.sense_data, &io->scsiio.sense_data,
701 io->scsiio.sense_len);
702 ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg,
703 sizeof(msg.scsi) - sizeof(msg.scsi.sense_data) +
704 msg.scsi.sense_len, M_WAITOK);
710 ctl_isc_handler_finish_xfer(struct ctl_softc *ctl_softc,
711 union ctl_ha_msg *msg_info)
713 struct ctl_scsiio *ctsio;
715 if (msg_info->hdr.original_sc == NULL) {
716 printf("%s: original_sc == NULL!\n", __func__);
717 /* XXX KDM now what? */
721 ctsio = &msg_info->hdr.original_sc->scsiio;
722 ctsio->io_hdr.flags |= CTL_FLAG_IO_ACTIVE;
723 ctsio->io_hdr.msg_type = CTL_MSG_FINISH_IO;
724 ctsio->io_hdr.status = msg_info->hdr.status;
725 ctsio->scsi_status = msg_info->scsi.scsi_status;
726 ctsio->sense_len = msg_info->scsi.sense_len;
727 ctsio->sense_residual = msg_info->scsi.sense_residual;
728 ctsio->residual = msg_info->scsi.residual;
729 memcpy(&ctsio->sense_data, &msg_info->scsi.sense_data,
730 msg_info->scsi.sense_len);
731 ctl_enqueue_isc((union ctl_io *)ctsio);
735 ctl_isc_handler_finish_ser_only(struct ctl_softc *ctl_softc,
736 union ctl_ha_msg *msg_info)
738 struct ctl_scsiio *ctsio;
740 if (msg_info->hdr.serializing_sc == NULL) {
741 printf("%s: serializing_sc == NULL!\n", __func__);
742 /* XXX KDM now what? */
746 ctsio = &msg_info->hdr.serializing_sc->scsiio;
747 ctsio->io_hdr.msg_type = CTL_MSG_FINISH_IO;
748 ctl_enqueue_isc((union ctl_io *)ctsio);
752 ctl_isc_announce_lun(struct ctl_lun *lun)
754 struct ctl_softc *softc = lun->ctl_softc;
755 union ctl_ha_msg *msg;
756 struct ctl_ha_msg_lun_pr_key pr_key;
759 if (softc->ha_link != CTL_HA_LINK_ONLINE)
761 mtx_lock(&lun->lun_lock);
762 i = sizeof(msg->lun);
764 i += lun->lun_devid->len;
765 i += sizeof(pr_key) * lun->pr_key_count;
767 mtx_unlock(&lun->lun_lock);
768 msg = malloc(i, M_CTL, M_WAITOK);
769 mtx_lock(&lun->lun_lock);
770 k = sizeof(msg->lun);
772 k += lun->lun_devid->len;
773 k += sizeof(pr_key) * lun->pr_key_count;
779 bzero(&msg->lun, sizeof(msg->lun));
780 msg->hdr.msg_type = CTL_MSG_LUN_SYNC;
781 msg->hdr.nexus.targ_lun = lun->lun;
782 msg->hdr.nexus.targ_mapped_lun = lun->lun;
783 msg->lun.flags = lun->flags;
784 msg->lun.pr_generation = lun->pr_generation;
785 msg->lun.pr_res_idx = lun->pr_res_idx;
786 msg->lun.pr_res_type = lun->pr_res_type;
787 msg->lun.pr_key_count = lun->pr_key_count;
789 if (lun->lun_devid) {
790 msg->lun.lun_devid_len = lun->lun_devid->len;
791 memcpy(&msg->lun.data[i], lun->lun_devid->data,
792 msg->lun.lun_devid_len);
793 i += msg->lun.lun_devid_len;
795 for (k = 0; k < CTL_MAX_INITIATORS; k++) {
796 if ((pr_key.pr_key = ctl_get_prkey(lun, k)) == 0)
799 memcpy(&msg->lun.data[i], &pr_key, sizeof(pr_key));
802 mtx_unlock(&lun->lun_lock);
803 ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg->port, sizeof(msg->port) + i,
807 if (lun->flags & CTL_LUN_PRIMARY_SC) {
808 for (i = 0; i < CTL_NUM_MODE_PAGES; i++) {
809 ctl_isc_announce_mode(lun, -1,
810 lun->mode_pages.index[i].page_code & SMPH_PC_MASK,
811 lun->mode_pages.index[i].subpage);
817 ctl_isc_announce_port(struct ctl_port *port)
819 struct ctl_softc *softc = port->ctl_softc;
820 union ctl_ha_msg *msg;
823 if (port->targ_port < softc->port_min ||
824 port->targ_port >= softc->port_max ||
825 softc->ha_link != CTL_HA_LINK_ONLINE)
827 i = sizeof(msg->port) + strlen(port->port_name) + 1;
829 i += sizeof(uint32_t) * CTL_MAX_LUNS;
830 if (port->port_devid)
831 i += port->port_devid->len;
832 if (port->target_devid)
833 i += port->target_devid->len;
834 if (port->init_devid)
835 i += port->init_devid->len;
836 msg = malloc(i, M_CTL, M_WAITOK);
837 bzero(&msg->port, sizeof(msg->port));
838 msg->hdr.msg_type = CTL_MSG_PORT_SYNC;
839 msg->hdr.nexus.targ_port = port->targ_port;
840 msg->port.port_type = port->port_type;
841 msg->port.physical_port = port->physical_port;
842 msg->port.virtual_port = port->virtual_port;
843 msg->port.status = port->status;
845 msg->port.name_len = sprintf(&msg->port.data[i],
846 "%d:%s", softc->ha_id, port->port_name) + 1;
847 i += msg->port.name_len;
849 msg->port.lun_map_len = sizeof(uint32_t) * CTL_MAX_LUNS;
850 memcpy(&msg->port.data[i], port->lun_map,
851 msg->port.lun_map_len);
852 i += msg->port.lun_map_len;
854 if (port->port_devid) {
855 msg->port.port_devid_len = port->port_devid->len;
856 memcpy(&msg->port.data[i], port->port_devid->data,
857 msg->port.port_devid_len);
858 i += msg->port.port_devid_len;
860 if (port->target_devid) {
861 msg->port.target_devid_len = port->target_devid->len;
862 memcpy(&msg->port.data[i], port->target_devid->data,
863 msg->port.target_devid_len);
864 i += msg->port.target_devid_len;
866 if (port->init_devid) {
867 msg->port.init_devid_len = port->init_devid->len;
868 memcpy(&msg->port.data[i], port->init_devid->data,
869 msg->port.init_devid_len);
870 i += msg->port.init_devid_len;
872 ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg->port, sizeof(msg->port) + i,
878 ctl_isc_announce_iid(struct ctl_port *port, int iid)
880 struct ctl_softc *softc = port->ctl_softc;
881 union ctl_ha_msg *msg;
884 if (port->targ_port < softc->port_min ||
885 port->targ_port >= softc->port_max ||
886 softc->ha_link != CTL_HA_LINK_ONLINE)
888 mtx_lock(&softc->ctl_lock);
889 i = sizeof(msg->iid);
891 if (port->wwpn_iid[iid].name)
892 l = strlen(port->wwpn_iid[iid].name) + 1;
894 msg = malloc(i, M_CTL, M_NOWAIT);
896 mtx_unlock(&softc->ctl_lock);
899 bzero(&msg->iid, sizeof(msg->iid));
900 msg->hdr.msg_type = CTL_MSG_IID_SYNC;
901 msg->hdr.nexus.targ_port = port->targ_port;
902 msg->hdr.nexus.initid = iid;
903 msg->iid.in_use = port->wwpn_iid[iid].in_use;
904 msg->iid.name_len = l;
905 msg->iid.wwpn = port->wwpn_iid[iid].wwpn;
906 if (port->wwpn_iid[iid].name)
907 strlcpy(msg->iid.data, port->wwpn_iid[iid].name, l);
908 mtx_unlock(&softc->ctl_lock);
909 ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg->iid, i, M_NOWAIT);
914 ctl_isc_announce_mode(struct ctl_lun *lun, uint32_t initidx,
915 uint8_t page, uint8_t subpage)
917 struct ctl_softc *softc = lun->ctl_softc;
918 union ctl_ha_msg msg;
921 if (softc->ha_link != CTL_HA_LINK_ONLINE)
923 for (i = 0; i < CTL_NUM_MODE_PAGES; i++) {
924 if ((lun->mode_pages.index[i].page_code & SMPH_PC_MASK) ==
925 page && lun->mode_pages.index[i].subpage == subpage)
928 if (i == CTL_NUM_MODE_PAGES)
931 /* Don't try to replicate pages not present on this device. */
932 if (lun->mode_pages.index[i].page_data == NULL)
935 bzero(&msg.mode, sizeof(msg.mode));
936 msg.hdr.msg_type = CTL_MSG_MODE_SYNC;
937 msg.hdr.nexus.targ_port = initidx / CTL_MAX_INIT_PER_PORT;
938 msg.hdr.nexus.initid = initidx % CTL_MAX_INIT_PER_PORT;
939 msg.hdr.nexus.targ_lun = lun->lun;
940 msg.hdr.nexus.targ_mapped_lun = lun->lun;
941 msg.mode.page_code = page;
942 msg.mode.subpage = subpage;
943 msg.mode.page_len = lun->mode_pages.index[i].page_len;
944 memcpy(msg.mode.data, lun->mode_pages.index[i].page_data,
946 ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg.mode, sizeof(msg.mode),
951 ctl_isc_ha_link_up(struct ctl_softc *softc)
953 struct ctl_port *port;
955 union ctl_ha_msg msg;
958 /* Announce this node parameters to peer for validation. */
959 msg.login.msg_type = CTL_MSG_LOGIN;
960 msg.login.version = CTL_HA_VERSION;
961 msg.login.ha_mode = softc->ha_mode;
962 msg.login.ha_id = softc->ha_id;
963 msg.login.max_luns = CTL_MAX_LUNS;
964 msg.login.max_ports = CTL_MAX_PORTS;
965 msg.login.max_init_per_port = CTL_MAX_INIT_PER_PORT;
966 ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg.login, sizeof(msg.login),
969 STAILQ_FOREACH(port, &softc->port_list, links) {
970 ctl_isc_announce_port(port);
971 for (i = 0; i < CTL_MAX_INIT_PER_PORT; i++) {
972 if (port->wwpn_iid[i].in_use)
973 ctl_isc_announce_iid(port, i);
976 STAILQ_FOREACH(lun, &softc->lun_list, links)
977 ctl_isc_announce_lun(lun);
981 ctl_isc_ha_link_down(struct ctl_softc *softc)
983 struct ctl_port *port;
988 mtx_lock(&softc->ctl_lock);
989 STAILQ_FOREACH(lun, &softc->lun_list, links) {
990 mtx_lock(&lun->lun_lock);
991 if (lun->flags & CTL_LUN_PEER_SC_PRIMARY) {
992 lun->flags &= ~CTL_LUN_PEER_SC_PRIMARY;
993 ctl_est_ua_all(lun, -1, CTL_UA_ASYM_ACC_CHANGE);
995 mtx_unlock(&lun->lun_lock);
997 mtx_unlock(&softc->ctl_lock);
998 io = ctl_alloc_io(softc->othersc_pool);
999 mtx_lock(&softc->ctl_lock);
1001 io->io_hdr.msg_type = CTL_MSG_FAILOVER;
1002 io->io_hdr.nexus.targ_mapped_lun = lun->lun;
1003 ctl_enqueue_isc(io);
1006 STAILQ_FOREACH(port, &softc->port_list, links) {
1007 if (port->targ_port >= softc->port_min &&
1008 port->targ_port < softc->port_max)
1010 port->status &= ~CTL_PORT_STATUS_ONLINE;
1011 for (i = 0; i < CTL_MAX_INIT_PER_PORT; i++) {
1012 port->wwpn_iid[i].in_use = 0;
1013 free(port->wwpn_iid[i].name, M_CTL);
1014 port->wwpn_iid[i].name = NULL;
1017 mtx_unlock(&softc->ctl_lock);
1021 ctl_isc_ua(struct ctl_softc *softc, union ctl_ha_msg *msg, int len)
1023 struct ctl_lun *lun;
1024 uint32_t iid = ctl_get_initindex(&msg->hdr.nexus);
1026 mtx_lock(&softc->ctl_lock);
1027 if (msg->hdr.nexus.targ_lun < CTL_MAX_LUNS &&
1028 (lun = softc->ctl_luns[msg->hdr.nexus.targ_mapped_lun]) != NULL) {
1029 mtx_lock(&lun->lun_lock);
1030 mtx_unlock(&softc->ctl_lock);
1031 if (msg->ua.ua_type == CTL_UA_THIN_PROV_THRES &&
1033 memcpy(lun->ua_tpt_info, msg->ua.ua_info, 8);
1034 if (msg->ua.ua_all) {
1036 ctl_est_ua_all(lun, iid, msg->ua.ua_type);
1038 ctl_clr_ua_all(lun, iid, msg->ua.ua_type);
1041 ctl_est_ua(lun, iid, msg->ua.ua_type);
1043 ctl_clr_ua(lun, iid, msg->ua.ua_type);
1045 mtx_unlock(&lun->lun_lock);
1047 mtx_unlock(&softc->ctl_lock);
1051 ctl_isc_lun_sync(struct ctl_softc *softc, union ctl_ha_msg *msg, int len)
1053 struct ctl_lun *lun;
1054 struct ctl_ha_msg_lun_pr_key pr_key;
1056 ctl_lun_flags oflags;
1059 targ_lun = msg->hdr.nexus.targ_mapped_lun;
1060 mtx_lock(&softc->ctl_lock);
1061 if ((targ_lun >= CTL_MAX_LUNS) ||
1062 ((lun = softc->ctl_luns[targ_lun]) == NULL)) {
1063 mtx_unlock(&softc->ctl_lock);
1066 mtx_lock(&lun->lun_lock);
1067 mtx_unlock(&softc->ctl_lock);
1068 if (lun->flags & CTL_LUN_DISABLED) {
1069 mtx_unlock(&lun->lun_lock);
1072 i = (lun->lun_devid != NULL) ? lun->lun_devid->len : 0;
1073 if (msg->lun.lun_devid_len != i || (i > 0 &&
1074 memcmp(&msg->lun.data[0], lun->lun_devid->data, i) != 0)) {
1075 mtx_unlock(&lun->lun_lock);
1076 printf("%s: Received conflicting HA LUN %d\n",
1077 __func__, msg->hdr.nexus.targ_lun);
1080 /* Record whether peer is primary. */
1081 oflags = lun->flags;
1082 if ((msg->lun.flags & CTL_LUN_PRIMARY_SC) &&
1083 (msg->lun.flags & CTL_LUN_DISABLED) == 0)
1084 lun->flags |= CTL_LUN_PEER_SC_PRIMARY;
1086 lun->flags &= ~CTL_LUN_PEER_SC_PRIMARY;
1087 if (oflags != lun->flags)
1088 ctl_est_ua_all(lun, -1, CTL_UA_ASYM_ACC_CHANGE);
1090 /* If peer is primary and we are not -- use data */
1091 if ((lun->flags & CTL_LUN_PRIMARY_SC) == 0 &&
1092 (lun->flags & CTL_LUN_PEER_SC_PRIMARY)) {
1093 lun->pr_generation = msg->lun.pr_generation;
1094 lun->pr_res_idx = msg->lun.pr_res_idx;
1095 lun->pr_res_type = msg->lun.pr_res_type;
1096 lun->pr_key_count = msg->lun.pr_key_count;
1097 for (k = 0; k < CTL_MAX_INITIATORS; k++)
1098 ctl_clr_prkey(lun, k);
1099 for (k = 0; k < msg->lun.pr_key_count; k++) {
1100 memcpy(&pr_key, &msg->lun.data[i],
1102 ctl_alloc_prkey(lun, pr_key.pr_iid);
1103 ctl_set_prkey(lun, pr_key.pr_iid,
1105 i += sizeof(pr_key);
1109 mtx_unlock(&lun->lun_lock);
1110 CTL_DEBUG_PRINT(("%s: Known LUN %d, peer is %s\n",
1111 __func__, msg->hdr.nexus.targ_lun,
1112 (msg->lun.flags & CTL_LUN_PRIMARY_SC) ?
1113 "primary" : "secondary"));
1115 /* If we are primary but peer doesn't know -- notify */
1116 if ((lun->flags & CTL_LUN_PRIMARY_SC) &&
1117 (msg->lun.flags & CTL_LUN_PEER_SC_PRIMARY) == 0)
1118 ctl_isc_announce_lun(lun);
1123 ctl_isc_port_sync(struct ctl_softc *softc, union ctl_ha_msg *msg, int len)
1125 struct ctl_port *port;
1126 struct ctl_lun *lun;
1129 port = softc->ctl_ports[msg->hdr.nexus.targ_port];
1131 CTL_DEBUG_PRINT(("%s: New port %d\n", __func__,
1132 msg->hdr.nexus.targ_port));
1134 port = malloc(sizeof(*port), M_CTL, M_WAITOK | M_ZERO);
1135 port->frontend = &ha_frontend;
1136 port->targ_port = msg->hdr.nexus.targ_port;
1137 port->fe_datamove = ctl_ha_datamove;
1138 port->fe_done = ctl_ha_done;
1139 } else if (port->frontend == &ha_frontend) {
1140 CTL_DEBUG_PRINT(("%s: Updated port %d\n", __func__,
1141 msg->hdr.nexus.targ_port));
1144 printf("%s: Received conflicting HA port %d\n",
1145 __func__, msg->hdr.nexus.targ_port);
1148 port->port_type = msg->port.port_type;
1149 port->physical_port = msg->port.physical_port;
1150 port->virtual_port = msg->port.virtual_port;
1151 port->status = msg->port.status;
1153 free(port->port_name, M_CTL);
1154 port->port_name = strndup(&msg->port.data[i], msg->port.name_len,
1156 i += msg->port.name_len;
1157 if (msg->port.lun_map_len != 0) {
1158 if (port->lun_map == NULL)
1159 port->lun_map = malloc(sizeof(uint32_t) * CTL_MAX_LUNS,
1161 memcpy(port->lun_map, &msg->port.data[i],
1162 sizeof(uint32_t) * CTL_MAX_LUNS);
1163 i += msg->port.lun_map_len;
1165 free(port->lun_map, M_CTL);
1166 port->lun_map = NULL;
1168 if (msg->port.port_devid_len != 0) {
1169 if (port->port_devid == NULL ||
1170 port->port_devid->len != msg->port.port_devid_len) {
1171 free(port->port_devid, M_CTL);
1172 port->port_devid = malloc(sizeof(struct ctl_devid) +
1173 msg->port.port_devid_len, M_CTL, M_WAITOK);
1175 memcpy(port->port_devid->data, &msg->port.data[i],
1176 msg->port.port_devid_len);
1177 port->port_devid->len = msg->port.port_devid_len;
1178 i += msg->port.port_devid_len;
1180 free(port->port_devid, M_CTL);
1181 port->port_devid = NULL;
1183 if (msg->port.target_devid_len != 0) {
1184 if (port->target_devid == NULL ||
1185 port->target_devid->len != msg->port.target_devid_len) {
1186 free(port->target_devid, M_CTL);
1187 port->target_devid = malloc(sizeof(struct ctl_devid) +
1188 msg->port.target_devid_len, M_CTL, M_WAITOK);
1190 memcpy(port->target_devid->data, &msg->port.data[i],
1191 msg->port.target_devid_len);
1192 port->target_devid->len = msg->port.target_devid_len;
1193 i += msg->port.target_devid_len;
1195 free(port->target_devid, M_CTL);
1196 port->target_devid = NULL;
1198 if (msg->port.init_devid_len != 0) {
1199 if (port->init_devid == NULL ||
1200 port->init_devid->len != msg->port.init_devid_len) {
1201 free(port->init_devid, M_CTL);
1202 port->init_devid = malloc(sizeof(struct ctl_devid) +
1203 msg->port.init_devid_len, M_CTL, M_WAITOK);
1205 memcpy(port->init_devid->data, &msg->port.data[i],
1206 msg->port.init_devid_len);
1207 port->init_devid->len = msg->port.init_devid_len;
1208 i += msg->port.init_devid_len;
1210 free(port->init_devid, M_CTL);
1211 port->init_devid = NULL;
1214 if (ctl_port_register(port) != 0) {
1215 printf("%s: ctl_port_register() failed with error\n",
1219 mtx_lock(&softc->ctl_lock);
1220 STAILQ_FOREACH(lun, &softc->lun_list, links) {
1221 if (ctl_lun_map_to_port(port, lun->lun) >= CTL_MAX_LUNS)
1223 mtx_lock(&lun->lun_lock);
1224 ctl_est_ua_all(lun, -1, CTL_UA_INQ_CHANGE);
1225 mtx_unlock(&lun->lun_lock);
1227 mtx_unlock(&softc->ctl_lock);
1231 ctl_isc_iid_sync(struct ctl_softc *softc, union ctl_ha_msg *msg, int len)
1233 struct ctl_port *port;
1236 port = softc->ctl_ports[msg->hdr.nexus.targ_port];
1238 printf("%s: Received IID for unknown port %d\n",
1239 __func__, msg->hdr.nexus.targ_port);
1242 iid = msg->hdr.nexus.initid;
1243 port->wwpn_iid[iid].in_use = msg->iid.in_use;
1244 port->wwpn_iid[iid].wwpn = msg->iid.wwpn;
1245 free(port->wwpn_iid[iid].name, M_CTL);
1246 if (msg->iid.name_len) {
1247 port->wwpn_iid[iid].name = strndup(&msg->iid.data[0],
1248 msg->iid.name_len, M_CTL);
1250 port->wwpn_iid[iid].name = NULL;
1254 ctl_isc_login(struct ctl_softc *softc, union ctl_ha_msg *msg, int len)
1257 if (msg->login.version != CTL_HA_VERSION) {
1258 printf("CTL HA peers have different versions %d != %d\n",
1259 msg->login.version, CTL_HA_VERSION);
1260 ctl_ha_msg_abort(CTL_HA_CHAN_CTL);
1263 if (msg->login.ha_mode != softc->ha_mode) {
1264 printf("CTL HA peers have different ha_mode %d != %d\n",
1265 msg->login.ha_mode, softc->ha_mode);
1266 ctl_ha_msg_abort(CTL_HA_CHAN_CTL);
1269 if (msg->login.ha_id == softc->ha_id) {
1270 printf("CTL HA peers have same ha_id %d\n", msg->login.ha_id);
1271 ctl_ha_msg_abort(CTL_HA_CHAN_CTL);
1274 if (msg->login.max_luns != CTL_MAX_LUNS ||
1275 msg->login.max_ports != CTL_MAX_PORTS ||
1276 msg->login.max_init_per_port != CTL_MAX_INIT_PER_PORT) {
1277 printf("CTL HA peers have different limits\n");
1278 ctl_ha_msg_abort(CTL_HA_CHAN_CTL);
1284 ctl_isc_mode_sync(struct ctl_softc *softc, union ctl_ha_msg *msg, int len)
1286 struct ctl_lun *lun;
1288 uint32_t initidx, targ_lun;
1290 targ_lun = msg->hdr.nexus.targ_mapped_lun;
1291 mtx_lock(&softc->ctl_lock);
1292 if ((targ_lun >= CTL_MAX_LUNS) ||
1293 ((lun = softc->ctl_luns[targ_lun]) == NULL)) {
1294 mtx_unlock(&softc->ctl_lock);
1297 mtx_lock(&lun->lun_lock);
1298 mtx_unlock(&softc->ctl_lock);
1299 if (lun->flags & CTL_LUN_DISABLED) {
1300 mtx_unlock(&lun->lun_lock);
1303 for (i = 0; i < CTL_NUM_MODE_PAGES; i++) {
1304 if ((lun->mode_pages.index[i].page_code & SMPH_PC_MASK) ==
1305 msg->mode.page_code &&
1306 lun->mode_pages.index[i].subpage == msg->mode.subpage)
1309 if (i == CTL_NUM_MODE_PAGES) {
1310 mtx_unlock(&lun->lun_lock);
1313 memcpy(lun->mode_pages.index[i].page_data, msg->mode.data,
1314 lun->mode_pages.index[i].page_len);
1315 initidx = ctl_get_initindex(&msg->hdr.nexus);
1317 ctl_est_ua_all(lun, initidx, CTL_UA_MODE_CHANGE);
1318 mtx_unlock(&lun->lun_lock);
1322 * ISC (Inter Shelf Communication) event handler. Events from the HA
1323 * subsystem come in here.
1326 ctl_isc_event_handler(ctl_ha_channel channel, ctl_ha_event event, int param)
1328 struct ctl_softc *softc = control_softc;
1330 struct ctl_prio *presio;
1331 ctl_ha_status isc_status;
1333 CTL_DEBUG_PRINT(("CTL: Isc Msg event %d\n", event));
1334 if (event == CTL_HA_EVT_MSG_RECV) {
1335 union ctl_ha_msg *msg, msgbuf;
1337 if (param > sizeof(msgbuf))
1338 msg = malloc(param, M_CTL, M_WAITOK);
1341 isc_status = ctl_ha_msg_recv(CTL_HA_CHAN_CTL, msg, param,
1343 if (isc_status != CTL_HA_STATUS_SUCCESS) {
1344 printf("%s: Error receiving message: %d\n",
1345 __func__, isc_status);
1351 CTL_DEBUG_PRINT(("CTL: msg_type %d\n", msg->msg_type));
1352 switch (msg->hdr.msg_type) {
1353 case CTL_MSG_SERIALIZE:
1354 io = ctl_alloc_io(softc->othersc_pool);
1356 // populate ctsio from msg
1357 io->io_hdr.io_type = CTL_IO_SCSI;
1358 io->io_hdr.msg_type = CTL_MSG_SERIALIZE;
1359 io->io_hdr.original_sc = msg->hdr.original_sc;
1360 io->io_hdr.flags |= CTL_FLAG_FROM_OTHER_SC |
1363 * If we're in serialization-only mode, we don't
1364 * want to go through full done processing. Thus
1367 * XXX KDM add another flag that is more specific.
1369 if (softc->ha_mode != CTL_HA_MODE_XFER)
1370 io->io_hdr.flags |= CTL_FLAG_INT_COPY;
1371 io->io_hdr.nexus = msg->hdr.nexus;
1373 printf("port %u, iid %u, lun %u\n",
1374 io->io_hdr.nexus.targ_port,
1375 io->io_hdr.nexus.initid,
1376 io->io_hdr.nexus.targ_lun);
1378 io->scsiio.tag_num = msg->scsi.tag_num;
1379 io->scsiio.tag_type = msg->scsi.tag_type;
1381 io->io_hdr.start_time = time_uptime;
1382 getbinuptime(&io->io_hdr.start_bt);
1383 #endif /* CTL_TIME_IO */
1384 io->scsiio.cdb_len = msg->scsi.cdb_len;
1385 memcpy(io->scsiio.cdb, msg->scsi.cdb,
1387 if (softc->ha_mode == CTL_HA_MODE_XFER) {
1388 const struct ctl_cmd_entry *entry;
1390 entry = ctl_get_cmd_entry(&io->scsiio, NULL);
1391 io->io_hdr.flags &= ~CTL_FLAG_DATA_MASK;
1393 entry->flags & CTL_FLAG_DATA_MASK;
1395 ctl_enqueue_isc(io);
1398 /* Performed on the Originating SC, XFER mode only */
1399 case CTL_MSG_DATAMOVE: {
1400 struct ctl_sg_entry *sgl;
1403 io = msg->hdr.original_sc;
1405 printf("%s: original_sc == NULL!\n", __func__);
1406 /* XXX KDM do something here */
1409 io->io_hdr.msg_type = CTL_MSG_DATAMOVE;
1410 io->io_hdr.flags |= CTL_FLAG_IO_ACTIVE;
1412 * Keep track of this, we need to send it back over
1413 * when the datamove is complete.
1415 io->io_hdr.serializing_sc = msg->hdr.serializing_sc;
1416 if (msg->hdr.status == CTL_SUCCESS)
1417 io->io_hdr.status = msg->hdr.status;
1419 if (msg->dt.sg_sequence == 0) {
1421 getbinuptime(&io->io_hdr.dma_start_bt);
1423 i = msg->dt.kern_sg_entries +
1424 msg->dt.kern_data_len /
1425 CTL_HA_DATAMOVE_SEGMENT + 1;
1426 sgl = malloc(sizeof(*sgl) * i, M_CTL,
1428 io->io_hdr.remote_sglist = sgl;
1429 io->io_hdr.local_sglist =
1430 &sgl[msg->dt.kern_sg_entries];
1432 io->scsiio.kern_data_ptr = (uint8_t *)sgl;
1434 io->scsiio.kern_sg_entries =
1435 msg->dt.kern_sg_entries;
1436 io->scsiio.rem_sg_entries =
1437 msg->dt.kern_sg_entries;
1438 io->scsiio.kern_data_len =
1439 msg->dt.kern_data_len;
1440 io->scsiio.kern_total_len =
1441 msg->dt.kern_total_len;
1442 io->scsiio.kern_data_resid =
1443 msg->dt.kern_data_resid;
1444 io->scsiio.kern_rel_offset =
1445 msg->dt.kern_rel_offset;
1446 io->io_hdr.flags &= ~CTL_FLAG_BUS_ADDR;
1447 io->io_hdr.flags |= msg->dt.flags &
1450 sgl = (struct ctl_sg_entry *)
1451 io->scsiio.kern_data_ptr;
1453 for (i = msg->dt.sent_sg_entries, j = 0;
1454 i < (msg->dt.sent_sg_entries +
1455 msg->dt.cur_sg_entries); i++, j++) {
1456 sgl[i].addr = msg->dt.sg_list[j].addr;
1457 sgl[i].len = msg->dt.sg_list[j].len;
1460 printf("%s: DATAMOVE: %p,%lu j=%d, i=%d\n",
1461 __func__, sgl[i].addr, sgl[i].len, j, i);
1466 * If this is the last piece of the I/O, we've got
1467 * the full S/G list. Queue processing in the thread.
1468 * Otherwise wait for the next piece.
1470 if (msg->dt.sg_last != 0)
1471 ctl_enqueue_isc(io);
1474 /* Performed on the Serializing (primary) SC, XFER mode only */
1475 case CTL_MSG_DATAMOVE_DONE: {
1476 if (msg->hdr.serializing_sc == NULL) {
1477 printf("%s: serializing_sc == NULL!\n",
1479 /* XXX KDM now what? */
1483 * We grab the sense information here in case
1484 * there was a failure, so we can return status
1485 * back to the initiator.
1487 io = msg->hdr.serializing_sc;
1488 io->io_hdr.msg_type = CTL_MSG_DATAMOVE_DONE;
1489 io->io_hdr.flags &= ~CTL_FLAG_DMA_INPROG;
1490 io->io_hdr.flags |= CTL_FLAG_IO_ACTIVE;
1491 io->io_hdr.port_status = msg->scsi.fetd_status;
1492 io->scsiio.residual = msg->scsi.residual;
1493 if (msg->hdr.status != CTL_STATUS_NONE) {
1494 io->io_hdr.status = msg->hdr.status;
1495 io->scsiio.scsi_status = msg->scsi.scsi_status;
1496 io->scsiio.sense_len = msg->scsi.sense_len;
1497 io->scsiio.sense_residual =msg->scsi.sense_residual;
1498 memcpy(&io->scsiio.sense_data,
1499 &msg->scsi.sense_data,
1500 msg->scsi.sense_len);
1501 if (msg->hdr.status == CTL_SUCCESS)
1502 io->io_hdr.flags |= CTL_FLAG_STATUS_SENT;
1504 ctl_enqueue_isc(io);
1508 /* Preformed on Originating SC, SER_ONLY mode */
1510 io = msg->hdr.original_sc;
1512 printf("%s: original_sc == NULL!\n",
1516 io->io_hdr.flags |= CTL_FLAG_IO_ACTIVE;
1517 io->io_hdr.msg_type = CTL_MSG_R2R;
1518 io->io_hdr.serializing_sc = msg->hdr.serializing_sc;
1519 ctl_enqueue_isc(io);
1523 * Performed on Serializing(i.e. primary SC) SC in SER_ONLY
1525 * Performed on the Originating (i.e. secondary) SC in XFER
1528 case CTL_MSG_FINISH_IO:
1529 if (softc->ha_mode == CTL_HA_MODE_XFER)
1530 ctl_isc_handler_finish_xfer(softc, msg);
1532 ctl_isc_handler_finish_ser_only(softc, msg);
1535 /* Preformed on Originating SC */
1536 case CTL_MSG_BAD_JUJU:
1537 io = msg->hdr.original_sc;
1539 printf("%s: Bad JUJU!, original_sc is NULL!\n",
1543 ctl_copy_sense_data(msg, io);
1545 * IO should have already been cleaned up on other
1546 * SC so clear this flag so we won't send a message
1547 * back to finish the IO there.
1549 io->io_hdr.flags &= ~CTL_FLAG_SENT_2OTHER_SC;
1550 io->io_hdr.flags |= CTL_FLAG_IO_ACTIVE;
1552 /* io = msg->hdr.serializing_sc; */
1553 io->io_hdr.msg_type = CTL_MSG_BAD_JUJU;
1554 ctl_enqueue_isc(io);
1557 /* Handle resets sent from the other side */
1558 case CTL_MSG_MANAGE_TASKS: {
1559 struct ctl_taskio *taskio;
1560 taskio = (struct ctl_taskio *)ctl_alloc_io(
1561 softc->othersc_pool);
1562 ctl_zero_io((union ctl_io *)taskio);
1563 taskio->io_hdr.io_type = CTL_IO_TASK;
1564 taskio->io_hdr.flags |= CTL_FLAG_FROM_OTHER_SC;
1565 taskio->io_hdr.nexus = msg->hdr.nexus;
1566 taskio->task_action = msg->task.task_action;
1567 taskio->tag_num = msg->task.tag_num;
1568 taskio->tag_type = msg->task.tag_type;
1570 taskio->io_hdr.start_time = time_uptime;
1571 getbinuptime(&taskio->io_hdr.start_bt);
1572 #endif /* CTL_TIME_IO */
1573 ctl_run_task((union ctl_io *)taskio);
1576 /* Persistent Reserve action which needs attention */
1577 case CTL_MSG_PERS_ACTION:
1578 presio = (struct ctl_prio *)ctl_alloc_io(
1579 softc->othersc_pool);
1580 ctl_zero_io((union ctl_io *)presio);
1581 presio->io_hdr.msg_type = CTL_MSG_PERS_ACTION;
1582 presio->io_hdr.flags |= CTL_FLAG_FROM_OTHER_SC;
1583 presio->io_hdr.nexus = msg->hdr.nexus;
1584 presio->pr_msg = msg->pr;
1585 ctl_enqueue_isc((union ctl_io *)presio);
1588 ctl_isc_ua(softc, msg, param);
1590 case CTL_MSG_PORT_SYNC:
1591 ctl_isc_port_sync(softc, msg, param);
1593 case CTL_MSG_LUN_SYNC:
1594 ctl_isc_lun_sync(softc, msg, param);
1596 case CTL_MSG_IID_SYNC:
1597 ctl_isc_iid_sync(softc, msg, param);
1600 ctl_isc_login(softc, msg, param);
1602 case CTL_MSG_MODE_SYNC:
1603 ctl_isc_mode_sync(softc, msg, param);
1606 printf("Received HA message of unknown type %d\n",
1608 ctl_ha_msg_abort(CTL_HA_CHAN_CTL);
1613 } else if (event == CTL_HA_EVT_LINK_CHANGE) {
1614 printf("CTL: HA link status changed from %d to %d\n",
1615 softc->ha_link, param);
1616 if (param == softc->ha_link)
1618 if (softc->ha_link == CTL_HA_LINK_ONLINE) {
1619 softc->ha_link = param;
1620 ctl_isc_ha_link_down(softc);
1622 softc->ha_link = param;
1623 if (softc->ha_link == CTL_HA_LINK_ONLINE)
1624 ctl_isc_ha_link_up(softc);
1628 printf("ctl_isc_event_handler: Unknown event %d\n", event);
1634 ctl_copy_sense_data(union ctl_ha_msg *src, union ctl_io *dest)
1637 memcpy(&dest->scsiio.sense_data, &src->scsi.sense_data,
1638 src->scsi.sense_len);
1639 dest->scsiio.scsi_status = src->scsi.scsi_status;
1640 dest->scsiio.sense_len = src->scsi.sense_len;
1641 dest->io_hdr.status = src->hdr.status;
1645 ctl_copy_sense_data_back(union ctl_io *src, union ctl_ha_msg *dest)
1648 memcpy(&dest->scsi.sense_data, &src->scsiio.sense_data,
1649 src->scsiio.sense_len);
1650 dest->scsi.scsi_status = src->scsiio.scsi_status;
1651 dest->scsi.sense_len = src->scsiio.sense_len;
1652 dest->hdr.status = src->io_hdr.status;
1656 ctl_est_ua(struct ctl_lun *lun, uint32_t initidx, ctl_ua_type ua)
1658 struct ctl_softc *softc = lun->ctl_softc;
1661 if (initidx < softc->init_min || initidx >= softc->init_max)
1663 mtx_assert(&lun->lun_lock, MA_OWNED);
1664 pu = lun->pending_ua[initidx / CTL_MAX_INIT_PER_PORT];
1667 pu[initidx % CTL_MAX_INIT_PER_PORT] |= ua;
1671 ctl_est_ua_port(struct ctl_lun *lun, int port, uint32_t except, ctl_ua_type ua)
1675 mtx_assert(&lun->lun_lock, MA_OWNED);
1676 if (lun->pending_ua[port] == NULL)
1678 for (i = 0; i < CTL_MAX_INIT_PER_PORT; i++) {
1679 if (port * CTL_MAX_INIT_PER_PORT + i == except)
1681 lun->pending_ua[port][i] |= ua;
1686 ctl_est_ua_all(struct ctl_lun *lun, uint32_t except, ctl_ua_type ua)
1688 struct ctl_softc *softc = lun->ctl_softc;
1691 mtx_assert(&lun->lun_lock, MA_OWNED);
1692 for (i = softc->port_min; i < softc->port_max; i++)
1693 ctl_est_ua_port(lun, i, except, ua);
1697 ctl_clr_ua(struct ctl_lun *lun, uint32_t initidx, ctl_ua_type ua)
1699 struct ctl_softc *softc = lun->ctl_softc;
1702 if (initidx < softc->init_min || initidx >= softc->init_max)
1704 mtx_assert(&lun->lun_lock, MA_OWNED);
1705 pu = lun->pending_ua[initidx / CTL_MAX_INIT_PER_PORT];
1708 pu[initidx % CTL_MAX_INIT_PER_PORT] &= ~ua;
1712 ctl_clr_ua_all(struct ctl_lun *lun, uint32_t except, ctl_ua_type ua)
1714 struct ctl_softc *softc = lun->ctl_softc;
1717 mtx_assert(&lun->lun_lock, MA_OWNED);
1718 for (i = softc->port_min; i < softc->port_max; i++) {
1719 if (lun->pending_ua[i] == NULL)
1721 for (j = 0; j < CTL_MAX_INIT_PER_PORT; j++) {
1722 if (i * CTL_MAX_INIT_PER_PORT + j == except)
1724 lun->pending_ua[i][j] &= ~ua;
1730 ctl_clr_ua_allluns(struct ctl_softc *ctl_softc, uint32_t initidx,
1731 ctl_ua_type ua_type)
1733 struct ctl_lun *lun;
1735 mtx_assert(&ctl_softc->ctl_lock, MA_OWNED);
1736 STAILQ_FOREACH(lun, &ctl_softc->lun_list, links) {
1737 mtx_lock(&lun->lun_lock);
1738 ctl_clr_ua(lun, initidx, ua_type);
1739 mtx_unlock(&lun->lun_lock);
1744 ctl_ha_role_sysctl(SYSCTL_HANDLER_ARGS)
1746 struct ctl_softc *softc = (struct ctl_softc *)arg1;
1747 struct ctl_lun *lun;
1748 struct ctl_lun_req ireq;
1751 value = (softc->flags & CTL_FLAG_ACTIVE_SHELF) ? 0 : 1;
1752 error = sysctl_handle_int(oidp, &value, 0, req);
1753 if ((error != 0) || (req->newptr == NULL))
1756 mtx_lock(&softc->ctl_lock);
1758 softc->flags |= CTL_FLAG_ACTIVE_SHELF;
1760 softc->flags &= ~CTL_FLAG_ACTIVE_SHELF;
1761 STAILQ_FOREACH(lun, &softc->lun_list, links) {
1762 mtx_unlock(&softc->ctl_lock);
1763 bzero(&ireq, sizeof(ireq));
1764 ireq.reqtype = CTL_LUNREQ_MODIFY;
1765 ireq.reqdata.modify.lun_id = lun->lun;
1766 lun->backend->ioctl(NULL, CTL_LUN_REQ, (caddr_t)&ireq, 0,
1768 if (ireq.status != CTL_LUN_OK) {
1769 printf("%s: CTL_LUNREQ_MODIFY returned %d '%s'\n",
1770 __func__, ireq.status, ireq.error_str);
1772 mtx_lock(&softc->ctl_lock);
1774 mtx_unlock(&softc->ctl_lock);
1781 struct make_dev_args args;
1782 struct ctl_softc *softc;
1786 softc = control_softc = malloc(sizeof(*control_softc), M_DEVBUF,
1789 make_dev_args_init(&args);
1790 args.mda_devsw = &ctl_cdevsw;
1791 args.mda_uid = UID_ROOT;
1792 args.mda_gid = GID_OPERATOR;
1793 args.mda_mode = 0600;
1794 args.mda_si_drv1 = softc;
1795 error = make_dev_s(&args, &softc->dev, "cam/ctl");
1797 free(control_softc, M_DEVBUF);
1801 sysctl_ctx_init(&softc->sysctl_ctx);
1802 softc->sysctl_tree = SYSCTL_ADD_NODE(&softc->sysctl_ctx,
1803 SYSCTL_STATIC_CHILDREN(_kern_cam), OID_AUTO, "ctl",
1804 CTLFLAG_RD, 0, "CAM Target Layer");
1806 if (softc->sysctl_tree == NULL) {
1807 printf("%s: unable to allocate sysctl tree\n", __func__);
1808 destroy_dev(softc->dev);
1809 free(control_softc, M_DEVBUF);
1810 control_softc = NULL;
1814 mtx_init(&softc->ctl_lock, "CTL mutex", NULL, MTX_DEF);
1815 softc->io_zone = uma_zcreate("CTL IO", sizeof(union ctl_io),
1816 NULL, NULL, NULL, NULL, UMA_ALIGN_PTR, 0);
1819 SYSCTL_ADD_INT(&softc->sysctl_ctx, SYSCTL_CHILDREN(softc->sysctl_tree),
1820 OID_AUTO, "ha_mode", CTLFLAG_RDTUN, (int *)&softc->ha_mode, 0,
1821 "HA mode (0 - act/stby, 1 - serialize only, 2 - xfer)");
1824 * In Copan's HA scheme, the "master" and "slave" roles are
1825 * figured out through the slot the controller is in. Although it
1826 * is an active/active system, someone has to be in charge.
1828 SYSCTL_ADD_INT(&softc->sysctl_ctx, SYSCTL_CHILDREN(softc->sysctl_tree),
1829 OID_AUTO, "ha_id", CTLFLAG_RDTUN, &softc->ha_id, 0,
1830 "HA head ID (0 - no HA)");
1831 if (softc->ha_id == 0 || softc->ha_id > NUM_HA_SHELVES) {
1832 softc->flags |= CTL_FLAG_ACTIVE_SHELF;
1833 softc->is_single = 1;
1834 softc->port_cnt = CTL_MAX_PORTS;
1835 softc->port_min = 0;
1837 softc->port_cnt = CTL_MAX_PORTS / NUM_HA_SHELVES;
1838 softc->port_min = (softc->ha_id - 1) * softc->port_cnt;
1840 softc->port_max = softc->port_min + softc->port_cnt;
1841 softc->init_min = softc->port_min * CTL_MAX_INIT_PER_PORT;
1842 softc->init_max = softc->port_max * CTL_MAX_INIT_PER_PORT;
1844 SYSCTL_ADD_INT(&softc->sysctl_ctx, SYSCTL_CHILDREN(softc->sysctl_tree),
1845 OID_AUTO, "ha_link", CTLFLAG_RD, (int *)&softc->ha_link, 0,
1846 "HA link state (0 - offline, 1 - unknown, 2 - online)");
1848 STAILQ_INIT(&softc->lun_list);
1849 STAILQ_INIT(&softc->pending_lun_queue);
1850 STAILQ_INIT(&softc->fe_list);
1851 STAILQ_INIT(&softc->port_list);
1852 STAILQ_INIT(&softc->be_list);
1853 ctl_tpc_init(softc);
1855 if (ctl_pool_create(softc, "othersc", CTL_POOL_ENTRIES_OTHER_SC,
1858 printf("ctl: can't allocate %d entry other SC pool, "
1859 "exiting\n", CTL_POOL_ENTRIES_OTHER_SC);
1862 softc->othersc_pool = other_pool;
1864 if (worker_threads <= 0)
1865 worker_threads = max(1, mp_ncpus / 4);
1866 if (worker_threads > CTL_MAX_THREADS)
1867 worker_threads = CTL_MAX_THREADS;
1869 for (i = 0; i < worker_threads; i++) {
1870 struct ctl_thread *thr = &softc->threads[i];
1872 mtx_init(&thr->queue_lock, "CTL queue mutex", NULL, MTX_DEF);
1873 thr->ctl_softc = softc;
1874 STAILQ_INIT(&thr->incoming_queue);
1875 STAILQ_INIT(&thr->rtr_queue);
1876 STAILQ_INIT(&thr->done_queue);
1877 STAILQ_INIT(&thr->isc_queue);
1879 error = kproc_kthread_add(ctl_work_thread, thr,
1880 &softc->ctl_proc, &thr->thread, 0, 0, "ctl", "work%d", i);
1882 printf("error creating CTL work thread!\n");
1883 ctl_pool_free(other_pool);
1887 error = kproc_kthread_add(ctl_lun_thread, softc,
1888 &softc->ctl_proc, NULL, 0, 0, "ctl", "lun");
1890 printf("error creating CTL lun thread!\n");
1891 ctl_pool_free(other_pool);
1894 error = kproc_kthread_add(ctl_thresh_thread, softc,
1895 &softc->ctl_proc, NULL, 0, 0, "ctl", "thresh");
1897 printf("error creating CTL threshold thread!\n");
1898 ctl_pool_free(other_pool);
1902 SYSCTL_ADD_PROC(&softc->sysctl_ctx,SYSCTL_CHILDREN(softc->sysctl_tree),
1903 OID_AUTO, "ha_role", CTLTYPE_INT | CTLFLAG_RWTUN,
1904 softc, 0, ctl_ha_role_sysctl, "I", "HA role for this head");
1906 if (softc->is_single == 0) {
1907 ctl_frontend_register(&ha_frontend);
1908 if (ctl_ha_msg_init(softc) != CTL_HA_STATUS_SUCCESS) {
1909 printf("ctl_init: ctl_ha_msg_init failed.\n");
1910 softc->is_single = 1;
1912 if (ctl_ha_msg_register(CTL_HA_CHAN_CTL, ctl_isc_event_handler)
1913 != CTL_HA_STATUS_SUCCESS) {
1914 printf("ctl_init: ctl_ha_msg_register failed.\n");
1915 softc->is_single = 1;
1924 struct ctl_softc *softc = control_softc;
1925 struct ctl_lun *lun, *next_lun;
1927 if (softc->is_single == 0) {
1928 ctl_ha_msg_shutdown(softc);
1929 if (ctl_ha_msg_deregister(CTL_HA_CHAN_CTL)
1930 != CTL_HA_STATUS_SUCCESS)
1931 printf("%s: ctl_ha_msg_deregister failed.\n", __func__);
1932 if (ctl_ha_msg_destroy(softc) != CTL_HA_STATUS_SUCCESS)
1933 printf("%s: ctl_ha_msg_destroy failed.\n", __func__);
1934 ctl_frontend_deregister(&ha_frontend);
1937 mtx_lock(&softc->ctl_lock);
1939 STAILQ_FOREACH_SAFE(lun, &softc->lun_list, links, next_lun)
1942 mtx_unlock(&softc->ctl_lock);
1945 ctl_shutdown_thread(softc->work_thread);
1946 mtx_destroy(&softc->queue_lock);
1949 ctl_tpc_shutdown(softc);
1950 uma_zdestroy(softc->io_zone);
1951 mtx_destroy(&softc->ctl_lock);
1953 destroy_dev(softc->dev);
1955 sysctl_ctx_free(&softc->sysctl_ctx);
1957 free(control_softc, M_DEVBUF);
1958 control_softc = NULL;
1962 ctl_module_event_handler(module_t mod, int what, void *arg)
1967 return (ctl_init());
1971 return (EOPNOTSUPP);
1976 * XXX KDM should we do some access checks here? Bump a reference count to
1977 * prevent a CTL module from being unloaded while someone has it open?
1980 ctl_open(struct cdev *dev, int flags, int fmt, struct thread *td)
1986 ctl_close(struct cdev *dev, int flags, int fmt, struct thread *td)
1992 * Remove an initiator by port number and initiator ID.
1993 * Returns 0 for success, -1 for failure.
1996 ctl_remove_initiator(struct ctl_port *port, int iid)
1998 struct ctl_softc *softc = port->ctl_softc;
2000 mtx_assert(&softc->ctl_lock, MA_NOTOWNED);
2002 if (iid > CTL_MAX_INIT_PER_PORT) {
2003 printf("%s: initiator ID %u > maximun %u!\n",
2004 __func__, iid, CTL_MAX_INIT_PER_PORT);
2008 mtx_lock(&softc->ctl_lock);
2009 port->wwpn_iid[iid].in_use--;
2010 port->wwpn_iid[iid].last_use = time_uptime;
2011 mtx_unlock(&softc->ctl_lock);
2012 ctl_isc_announce_iid(port, iid);
2018 * Add an initiator to the initiator map.
2019 * Returns iid for success, < 0 for failure.
2022 ctl_add_initiator(struct ctl_port *port, int iid, uint64_t wwpn, char *name)
2024 struct ctl_softc *softc = port->ctl_softc;
2028 mtx_assert(&softc->ctl_lock, MA_NOTOWNED);
2030 if (iid >= CTL_MAX_INIT_PER_PORT) {
2031 printf("%s: WWPN %#jx initiator ID %u > maximum %u!\n",
2032 __func__, wwpn, iid, CTL_MAX_INIT_PER_PORT);
2037 mtx_lock(&softc->ctl_lock);
2039 if (iid < 0 && (wwpn != 0 || name != NULL)) {
2040 for (i = 0; i < CTL_MAX_INIT_PER_PORT; i++) {
2041 if (wwpn != 0 && wwpn == port->wwpn_iid[i].wwpn) {
2045 if (name != NULL && port->wwpn_iid[i].name != NULL &&
2046 strcmp(name, port->wwpn_iid[i].name) == 0) {
2054 for (i = 0; i < CTL_MAX_INIT_PER_PORT; i++) {
2055 if (port->wwpn_iid[i].in_use == 0 &&
2056 port->wwpn_iid[i].wwpn == 0 &&
2057 port->wwpn_iid[i].name == NULL) {
2066 best_time = INT32_MAX;
2067 for (i = 0; i < CTL_MAX_INIT_PER_PORT; i++) {
2068 if (port->wwpn_iid[i].in_use == 0) {
2069 if (port->wwpn_iid[i].last_use < best_time) {
2071 best_time = port->wwpn_iid[i].last_use;
2079 mtx_unlock(&softc->ctl_lock);
2084 if (port->wwpn_iid[iid].in_use > 0 && (wwpn != 0 || name != NULL)) {
2086 * This is not an error yet.
2088 if (wwpn != 0 && wwpn == port->wwpn_iid[iid].wwpn) {
2090 printf("%s: port %d iid %u WWPN %#jx arrived"
2091 " again\n", __func__, port->targ_port,
2092 iid, (uintmax_t)wwpn);
2096 if (name != NULL && port->wwpn_iid[iid].name != NULL &&
2097 strcmp(name, port->wwpn_iid[iid].name) == 0) {
2099 printf("%s: port %d iid %u name '%s' arrived"
2100 " again\n", __func__, port->targ_port,
2107 * This is an error, but what do we do about it? The
2108 * driver is telling us we have a new WWPN for this
2109 * initiator ID, so we pretty much need to use it.
2111 printf("%s: port %d iid %u WWPN %#jx '%s' arrived,"
2112 " but WWPN %#jx '%s' is still at that address\n",
2113 __func__, port->targ_port, iid, wwpn, name,
2114 (uintmax_t)port->wwpn_iid[iid].wwpn,
2115 port->wwpn_iid[iid].name);
2118 * XXX KDM clear have_ca and ua_pending on each LUN for
2123 free(port->wwpn_iid[iid].name, M_CTL);
2124 port->wwpn_iid[iid].name = name;
2125 port->wwpn_iid[iid].wwpn = wwpn;
2126 port->wwpn_iid[iid].in_use++;
2127 mtx_unlock(&softc->ctl_lock);
2128 ctl_isc_announce_iid(port, iid);
2134 ctl_create_iid(struct ctl_port *port, int iid, uint8_t *buf)
2138 switch (port->port_type) {
2141 struct scsi_transportid_fcp *id =
2142 (struct scsi_transportid_fcp *)buf;
2143 if (port->wwpn_iid[iid].wwpn == 0)
2145 memset(id, 0, sizeof(*id));
2146 id->format_protocol = SCSI_PROTO_FC;
2147 scsi_u64to8b(port->wwpn_iid[iid].wwpn, id->n_port_name);
2148 return (sizeof(*id));
2150 case CTL_PORT_ISCSI:
2152 struct scsi_transportid_iscsi_port *id =
2153 (struct scsi_transportid_iscsi_port *)buf;
2154 if (port->wwpn_iid[iid].name == NULL)
2157 id->format_protocol = SCSI_TRN_ISCSI_FORMAT_PORT |
2159 len = strlcpy(id->iscsi_name, port->wwpn_iid[iid].name, 252) + 1;
2160 len = roundup2(min(len, 252), 4);
2161 scsi_ulto2b(len, id->additional_length);
2162 return (sizeof(*id) + len);
2166 struct scsi_transportid_sas *id =
2167 (struct scsi_transportid_sas *)buf;
2168 if (port->wwpn_iid[iid].wwpn == 0)
2170 memset(id, 0, sizeof(*id));
2171 id->format_protocol = SCSI_PROTO_SAS;
2172 scsi_u64to8b(port->wwpn_iid[iid].wwpn, id->sas_address);
2173 return (sizeof(*id));
2177 struct scsi_transportid_spi *id =
2178 (struct scsi_transportid_spi *)buf;
2179 memset(id, 0, sizeof(*id));
2180 id->format_protocol = SCSI_PROTO_SPI;
2181 scsi_ulto2b(iid, id->scsi_addr);
2182 scsi_ulto2b(port->targ_port, id->rel_trgt_port_id);
2183 return (sizeof(*id));
2189 * Serialize a command that went down the "wrong" side, and so was sent to
2190 * this controller for execution. The logic is a little different than the
2191 * standard case in ctl_scsiio_precheck(). Errors in this case need to get
2192 * sent back to the other side, but in the success case, we execute the
2193 * command on this side (XFER mode) or tell the other side to execute it
2197 ctl_serialize_other_sc_cmd(struct ctl_scsiio *ctsio)
2199 struct ctl_softc *softc = control_softc;
2200 union ctl_ha_msg msg_info;
2201 struct ctl_port *port;
2202 struct ctl_lun *lun;
2203 const struct ctl_cmd_entry *entry;
2207 targ_lun = ctsio->io_hdr.nexus.targ_mapped_lun;
2208 mtx_lock(&softc->ctl_lock);
2210 /* Make sure that we know about this port. */
2211 port = ctl_io_port(&ctsio->io_hdr);
2212 if (port == NULL || (port->status & CTL_PORT_STATUS_ONLINE) == 0) {
2213 ctl_set_internal_failure(ctsio, /*sks_valid*/ 0,
2218 /* Make sure that we know about this LUN. */
2219 if ((targ_lun < CTL_MAX_LUNS) &&
2220 ((lun = softc->ctl_luns[targ_lun]) != NULL)) {
2221 mtx_lock(&lun->lun_lock);
2222 mtx_unlock(&softc->ctl_lock);
2224 * If the LUN is invalid, pretend that it doesn't exist.
2225 * It will go away as soon as all pending I/O has been
2228 if (lun->flags & CTL_LUN_DISABLED) {
2229 mtx_unlock(&lun->lun_lock);
2233 mtx_unlock(&softc->ctl_lock);
2238 * The other node would not send this request to us unless
2239 * received announce that we are primary node for this LUN.
2240 * If this LUN does not exist now, it is probably result of
2241 * a race, so respond to initiator in the most opaque way.
2243 ctl_set_busy(ctsio);
2247 entry = ctl_get_cmd_entry(ctsio, NULL);
2248 if (ctl_scsiio_lun_check(lun, entry, ctsio) != 0) {
2249 mtx_unlock(&lun->lun_lock);
2253 ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr = lun;
2254 ctsio->io_hdr.ctl_private[CTL_PRIV_BACKEND_LUN].ptr = lun->be_lun;
2257 * Every I/O goes into the OOA queue for a
2258 * particular LUN, and stays there until completion.
2261 if (TAILQ_EMPTY(&lun->ooa_queue))
2262 lun->idle_time += getsbinuptime() - lun->last_busy;
2264 TAILQ_INSERT_TAIL(&lun->ooa_queue, &ctsio->io_hdr, ooa_links);
2266 switch (ctl_check_ooa(lun, (union ctl_io *)ctsio,
2267 (union ctl_io *)TAILQ_PREV(&ctsio->io_hdr, ctl_ooaq,
2269 case CTL_ACTION_BLOCK:
2270 ctsio->io_hdr.flags |= CTL_FLAG_BLOCKED;
2271 TAILQ_INSERT_TAIL(&lun->blocked_queue, &ctsio->io_hdr,
2273 mtx_unlock(&lun->lun_lock);
2275 case CTL_ACTION_PASS:
2276 case CTL_ACTION_SKIP:
2277 if (softc->ha_mode == CTL_HA_MODE_XFER) {
2278 ctsio->io_hdr.flags |= CTL_FLAG_IS_WAS_ON_RTR;
2279 ctl_enqueue_rtr((union ctl_io *)ctsio);
2280 mtx_unlock(&lun->lun_lock);
2282 ctsio->io_hdr.flags &= ~CTL_FLAG_IO_ACTIVE;
2283 mtx_unlock(&lun->lun_lock);
2285 /* send msg back to other side */
2286 msg_info.hdr.original_sc = ctsio->io_hdr.original_sc;
2287 msg_info.hdr.serializing_sc = (union ctl_io *)ctsio;
2288 msg_info.hdr.msg_type = CTL_MSG_R2R;
2289 ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg_info,
2290 sizeof(msg_info.hdr), M_WAITOK);
2293 case CTL_ACTION_OVERLAP:
2294 TAILQ_REMOVE(&lun->ooa_queue, &ctsio->io_hdr, ooa_links);
2295 mtx_unlock(&lun->lun_lock);
2296 ctl_set_overlapped_cmd(ctsio);
2298 case CTL_ACTION_OVERLAP_TAG:
2299 TAILQ_REMOVE(&lun->ooa_queue, &ctsio->io_hdr, ooa_links);
2300 mtx_unlock(&lun->lun_lock);
2301 ctl_set_overlapped_tag(ctsio, ctsio->tag_num);
2303 case CTL_ACTION_ERROR:
2305 TAILQ_REMOVE(&lun->ooa_queue, &ctsio->io_hdr, ooa_links);
2306 mtx_unlock(&lun->lun_lock);
2308 ctl_set_internal_failure(ctsio, /*sks_valid*/ 0,
2311 ctl_copy_sense_data_back((union ctl_io *)ctsio, &msg_info);
2312 msg_info.hdr.original_sc = ctsio->io_hdr.original_sc;
2313 msg_info.hdr.serializing_sc = NULL;
2314 msg_info.hdr.msg_type = CTL_MSG_BAD_JUJU;
2315 ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg_info,
2316 sizeof(msg_info.scsi), M_WAITOK);
2324 * Returns 0 for success, errno for failure.
2327 ctl_ioctl_fill_ooa(struct ctl_lun *lun, uint32_t *cur_fill_num,
2328 struct ctl_ooa *ooa_hdr, struct ctl_ooa_entry *kern_entries)
2332 mtx_lock(&lun->lun_lock);
2333 for (io = (union ctl_io *)TAILQ_FIRST(&lun->ooa_queue); (io != NULL);
2334 (*cur_fill_num)++, io = (union ctl_io *)TAILQ_NEXT(&io->io_hdr,
2336 struct ctl_ooa_entry *entry;
2339 * If we've got more than we can fit, just count the
2340 * remaining entries.
2342 if (*cur_fill_num >= ooa_hdr->alloc_num)
2345 entry = &kern_entries[*cur_fill_num];
2347 entry->tag_num = io->scsiio.tag_num;
2348 entry->lun_num = lun->lun;
2350 entry->start_bt = io->io_hdr.start_bt;
2352 bcopy(io->scsiio.cdb, entry->cdb, io->scsiio.cdb_len);
2353 entry->cdb_len = io->scsiio.cdb_len;
2354 if (io->io_hdr.flags & CTL_FLAG_BLOCKED)
2355 entry->cmd_flags |= CTL_OOACMD_FLAG_BLOCKED;
2357 if (io->io_hdr.flags & CTL_FLAG_DMA_INPROG)
2358 entry->cmd_flags |= CTL_OOACMD_FLAG_DMA;
2360 if (io->io_hdr.flags & CTL_FLAG_ABORT)
2361 entry->cmd_flags |= CTL_OOACMD_FLAG_ABORT;
2363 if (io->io_hdr.flags & CTL_FLAG_IS_WAS_ON_RTR)
2364 entry->cmd_flags |= CTL_OOACMD_FLAG_RTR;
2366 if (io->io_hdr.flags & CTL_FLAG_DMA_QUEUED)
2367 entry->cmd_flags |= CTL_OOACMD_FLAG_DMA_QUEUED;
2369 mtx_unlock(&lun->lun_lock);
2373 ctl_copyin_alloc(void *user_addr, unsigned int len, char *error_str,
2374 size_t error_str_len)
2378 kptr = malloc(len, M_CTL, M_WAITOK | M_ZERO);
2380 if (copyin(user_addr, kptr, len) != 0) {
2381 snprintf(error_str, error_str_len, "Error copying %d bytes "
2382 "from user address %p to kernel address %p", len,
2392 ctl_free_args(int num_args, struct ctl_be_arg *args)
2399 for (i = 0; i < num_args; i++) {
2400 free(args[i].kname, M_CTL);
2401 free(args[i].kvalue, M_CTL);
2407 static struct ctl_be_arg *
2408 ctl_copyin_args(int num_args, struct ctl_be_arg *uargs,
2409 char *error_str, size_t error_str_len)
2411 struct ctl_be_arg *args;
2414 args = ctl_copyin_alloc(uargs, num_args * sizeof(*args),
2415 error_str, error_str_len);
2420 for (i = 0; i < num_args; i++) {
2421 args[i].kname = NULL;
2422 args[i].kvalue = NULL;
2425 for (i = 0; i < num_args; i++) {
2428 if (args[i].namelen == 0) {
2429 snprintf(error_str, error_str_len, "Argument %d "
2430 "name length is zero", i);
2434 args[i].kname = ctl_copyin_alloc(args[i].name,
2435 args[i].namelen, error_str, error_str_len);
2436 if (args[i].kname == NULL)
2439 if (args[i].kname[args[i].namelen - 1] != '\0') {
2440 snprintf(error_str, error_str_len, "Argument %d "
2441 "name is not NUL-terminated", i);
2445 if (args[i].flags & CTL_BEARG_RD) {
2446 if (args[i].vallen == 0) {
2447 snprintf(error_str, error_str_len, "Argument %d "
2448 "value length is zero", i);
2452 tmpptr = ctl_copyin_alloc(args[i].value,
2453 args[i].vallen, error_str, error_str_len);
2457 if ((args[i].flags & CTL_BEARG_ASCII)
2458 && (tmpptr[args[i].vallen - 1] != '\0')) {
2459 snprintf(error_str, error_str_len, "Argument "
2460 "%d value is not NUL-terminated", i);
2461 free(tmpptr, M_CTL);
2464 args[i].kvalue = tmpptr;
2466 args[i].kvalue = malloc(args[i].vallen,
2467 M_CTL, M_WAITOK | M_ZERO);
2474 ctl_free_args(num_args, args);
2480 ctl_copyout_args(int num_args, struct ctl_be_arg *args)
2484 for (i = 0; i < num_args; i++) {
2485 if (args[i].flags & CTL_BEARG_WR)
2486 copyout(args[i].kvalue, args[i].value, args[i].vallen);
2491 * Escape characters that are illegal or not recommended in XML.
2494 ctl_sbuf_printf_esc(struct sbuf *sb, char *str, int size)
2496 char *end = str + size;
2501 for (; *str && str < end; str++) {
2504 retval = sbuf_printf(sb, "&");
2507 retval = sbuf_printf(sb, ">");
2510 retval = sbuf_printf(sb, "<");
2513 retval = sbuf_putc(sb, *str);
2526 ctl_id_sbuf(struct ctl_devid *id, struct sbuf *sb)
2528 struct scsi_vpd_id_descriptor *desc;
2531 if (id == NULL || id->len < 4)
2533 desc = (struct scsi_vpd_id_descriptor *)id->data;
2534 switch (desc->id_type & SVPD_ID_TYPE_MASK) {
2535 case SVPD_ID_TYPE_T10:
2536 sbuf_printf(sb, "t10.");
2538 case SVPD_ID_TYPE_EUI64:
2539 sbuf_printf(sb, "eui.");
2541 case SVPD_ID_TYPE_NAA:
2542 sbuf_printf(sb, "naa.");
2544 case SVPD_ID_TYPE_SCSI_NAME:
2547 switch (desc->proto_codeset & SVPD_ID_CODESET_MASK) {
2548 case SVPD_ID_CODESET_BINARY:
2549 for (i = 0; i < desc->length; i++)
2550 sbuf_printf(sb, "%02x", desc->identifier[i]);
2552 case SVPD_ID_CODESET_ASCII:
2553 sbuf_printf(sb, "%.*s", (int)desc->length,
2554 (char *)desc->identifier);
2556 case SVPD_ID_CODESET_UTF8:
2557 sbuf_printf(sb, "%s", (char *)desc->identifier);
2563 ctl_ioctl(struct cdev *dev, u_long cmd, caddr_t addr, int flag,
2566 struct ctl_softc *softc = dev->si_drv1;
2567 struct ctl_lun *lun;
2574 retval = ctl_ioctl_io(dev, cmd, addr, flag, td);
2576 case CTL_ENABLE_PORT:
2577 case CTL_DISABLE_PORT:
2578 case CTL_SET_PORT_WWNS: {
2579 struct ctl_port *port;
2580 struct ctl_port_entry *entry;
2582 entry = (struct ctl_port_entry *)addr;
2584 mtx_lock(&softc->ctl_lock);
2585 STAILQ_FOREACH(port, &softc->port_list, links) {
2588 if (port->targ_port < softc->port_min ||
2589 port->targ_port >= softc->port_max)
2594 if ((entry->port_type == CTL_PORT_NONE)
2595 && (entry->targ_port == port->targ_port)) {
2597 * If the user only wants to enable or
2598 * disable or set WWNs on a specific port,
2599 * do the operation and we're done.
2603 } else if (entry->port_type & port->port_type) {
2605 * Compare the user's type mask with the
2606 * particular frontend type to see if we
2613 * Make sure the user isn't trying to set
2614 * WWNs on multiple ports at the same time.
2616 if (cmd == CTL_SET_PORT_WWNS) {
2617 printf("%s: Can't set WWNs on "
2618 "multiple ports\n", __func__);
2627 * XXX KDM we have to drop the lock here, because
2628 * the online/offline operations can potentially
2629 * block. We need to reference count the frontends
2630 * so they can't go away,
2632 if (cmd == CTL_ENABLE_PORT) {
2633 mtx_unlock(&softc->ctl_lock);
2634 ctl_port_online(port);
2635 mtx_lock(&softc->ctl_lock);
2636 } else if (cmd == CTL_DISABLE_PORT) {
2637 mtx_unlock(&softc->ctl_lock);
2638 ctl_port_offline(port);
2639 mtx_lock(&softc->ctl_lock);
2640 } else if (cmd == CTL_SET_PORT_WWNS) {
2641 ctl_port_set_wwns(port,
2642 (entry->flags & CTL_PORT_WWNN_VALID) ?
2644 (entry->flags & CTL_PORT_WWPN_VALID) ?
2645 1 : 0, entry->wwpn);
2650 mtx_unlock(&softc->ctl_lock);
2654 struct ctl_ooa *ooa_hdr;
2655 struct ctl_ooa_entry *entries;
2656 uint32_t cur_fill_num;
2658 ooa_hdr = (struct ctl_ooa *)addr;
2660 if ((ooa_hdr->alloc_len == 0)
2661 || (ooa_hdr->alloc_num == 0)) {
2662 printf("%s: CTL_GET_OOA: alloc len %u and alloc num %u "
2663 "must be non-zero\n", __func__,
2664 ooa_hdr->alloc_len, ooa_hdr->alloc_num);
2669 if (ooa_hdr->alloc_len != (ooa_hdr->alloc_num *
2670 sizeof(struct ctl_ooa_entry))) {
2671 printf("%s: CTL_GET_OOA: alloc len %u must be alloc "
2672 "num %d * sizeof(struct ctl_ooa_entry) %zd\n",
2673 __func__, ooa_hdr->alloc_len,
2674 ooa_hdr->alloc_num,sizeof(struct ctl_ooa_entry));
2679 entries = malloc(ooa_hdr->alloc_len, M_CTL, M_WAITOK | M_ZERO);
2680 if (entries == NULL) {
2681 printf("%s: could not allocate %d bytes for OOA "
2682 "dump\n", __func__, ooa_hdr->alloc_len);
2687 mtx_lock(&softc->ctl_lock);
2688 if (((ooa_hdr->flags & CTL_OOA_FLAG_ALL_LUNS) == 0)
2689 && ((ooa_hdr->lun_num >= CTL_MAX_LUNS)
2690 || (softc->ctl_luns[ooa_hdr->lun_num] == NULL))) {
2691 mtx_unlock(&softc->ctl_lock);
2692 free(entries, M_CTL);
2693 printf("%s: CTL_GET_OOA: invalid LUN %ju\n",
2694 __func__, (uintmax_t)ooa_hdr->lun_num);
2701 if (ooa_hdr->flags & CTL_OOA_FLAG_ALL_LUNS) {
2702 STAILQ_FOREACH(lun, &softc->lun_list, links) {
2703 ctl_ioctl_fill_ooa(lun, &cur_fill_num,
2707 lun = softc->ctl_luns[ooa_hdr->lun_num];
2708 ctl_ioctl_fill_ooa(lun, &cur_fill_num, ooa_hdr,
2711 mtx_unlock(&softc->ctl_lock);
2713 ooa_hdr->fill_num = min(cur_fill_num, ooa_hdr->alloc_num);
2714 ooa_hdr->fill_len = ooa_hdr->fill_num *
2715 sizeof(struct ctl_ooa_entry);
2716 retval = copyout(entries, ooa_hdr->entries, ooa_hdr->fill_len);
2718 printf("%s: error copying out %d bytes for OOA dump\n",
2719 __func__, ooa_hdr->fill_len);
2722 getbinuptime(&ooa_hdr->cur_bt);
2724 if (cur_fill_num > ooa_hdr->alloc_num) {
2725 ooa_hdr->dropped_num = cur_fill_num -ooa_hdr->alloc_num;
2726 ooa_hdr->status = CTL_OOA_NEED_MORE_SPACE;
2728 ooa_hdr->dropped_num = 0;
2729 ooa_hdr->status = CTL_OOA_OK;
2732 free(entries, M_CTL);
2735 case CTL_DELAY_IO: {
2736 struct ctl_io_delay_info *delay_info;
2738 delay_info = (struct ctl_io_delay_info *)addr;
2741 mtx_lock(&softc->ctl_lock);
2743 if ((delay_info->lun_id >= CTL_MAX_LUNS)
2744 || (softc->ctl_luns[delay_info->lun_id] == NULL)) {
2745 delay_info->status = CTL_DELAY_STATUS_INVALID_LUN;
2747 lun = softc->ctl_luns[delay_info->lun_id];
2748 mtx_lock(&lun->lun_lock);
2750 delay_info->status = CTL_DELAY_STATUS_OK;
2752 switch (delay_info->delay_type) {
2753 case CTL_DELAY_TYPE_CONT:
2755 case CTL_DELAY_TYPE_ONESHOT:
2758 delay_info->status =
2759 CTL_DELAY_STATUS_INVALID_TYPE;
2763 switch (delay_info->delay_loc) {
2764 case CTL_DELAY_LOC_DATAMOVE:
2765 lun->delay_info.datamove_type =
2766 delay_info->delay_type;
2767 lun->delay_info.datamove_delay =
2768 delay_info->delay_secs;
2770 case CTL_DELAY_LOC_DONE:
2771 lun->delay_info.done_type =
2772 delay_info->delay_type;
2773 lun->delay_info.done_delay =
2774 delay_info->delay_secs;
2777 delay_info->status =
2778 CTL_DELAY_STATUS_INVALID_LOC;
2781 mtx_unlock(&lun->lun_lock);
2784 mtx_unlock(&softc->ctl_lock);
2786 delay_info->status = CTL_DELAY_STATUS_NOT_IMPLEMENTED;
2787 #endif /* CTL_IO_DELAY */
2790 case CTL_GETSTATS: {
2791 struct ctl_stats *stats;
2794 stats = (struct ctl_stats *)addr;
2796 if ((sizeof(struct ctl_lun_io_stats) * softc->num_luns) >
2798 stats->status = CTL_SS_NEED_MORE_SPACE;
2799 stats->num_luns = softc->num_luns;
2803 * XXX KDM no locking here. If the LUN list changes,
2804 * things can blow up.
2807 STAILQ_FOREACH(lun, &softc->lun_list, links) {
2808 retval = copyout(&lun->stats, &stats->lun_stats[i++],
2809 sizeof(lun->stats));
2813 stats->num_luns = softc->num_luns;
2814 stats->fill_len = sizeof(struct ctl_lun_io_stats) *
2816 stats->status = CTL_SS_OK;
2818 stats->flags = CTL_STATS_FLAG_TIME_VALID;
2820 stats->flags = CTL_STATS_FLAG_NONE;
2822 getnanouptime(&stats->timestamp);
2825 case CTL_ERROR_INJECT: {
2826 struct ctl_error_desc *err_desc, *new_err_desc;
2828 err_desc = (struct ctl_error_desc *)addr;
2830 new_err_desc = malloc(sizeof(*new_err_desc), M_CTL,
2832 bcopy(err_desc, new_err_desc, sizeof(*new_err_desc));
2834 mtx_lock(&softc->ctl_lock);
2835 lun = softc->ctl_luns[err_desc->lun_id];
2837 mtx_unlock(&softc->ctl_lock);
2838 free(new_err_desc, M_CTL);
2839 printf("%s: CTL_ERROR_INJECT: invalid LUN %ju\n",
2840 __func__, (uintmax_t)err_desc->lun_id);
2844 mtx_lock(&lun->lun_lock);
2845 mtx_unlock(&softc->ctl_lock);
2848 * We could do some checking here to verify the validity
2849 * of the request, but given the complexity of error
2850 * injection requests, the checking logic would be fairly
2853 * For now, if the request is invalid, it just won't get
2854 * executed and might get deleted.
2856 STAILQ_INSERT_TAIL(&lun->error_list, new_err_desc, links);
2859 * XXX KDM check to make sure the serial number is unique,
2860 * in case we somehow manage to wrap. That shouldn't
2861 * happen for a very long time, but it's the right thing to
2864 new_err_desc->serial = lun->error_serial;
2865 err_desc->serial = lun->error_serial;
2866 lun->error_serial++;
2868 mtx_unlock(&lun->lun_lock);
2871 case CTL_ERROR_INJECT_DELETE: {
2872 struct ctl_error_desc *delete_desc, *desc, *desc2;
2875 delete_desc = (struct ctl_error_desc *)addr;
2878 mtx_lock(&softc->ctl_lock);
2879 lun = softc->ctl_luns[delete_desc->lun_id];
2881 mtx_unlock(&softc->ctl_lock);
2882 printf("%s: CTL_ERROR_INJECT_DELETE: invalid LUN %ju\n",
2883 __func__, (uintmax_t)delete_desc->lun_id);
2887 mtx_lock(&lun->lun_lock);
2888 mtx_unlock(&softc->ctl_lock);
2889 STAILQ_FOREACH_SAFE(desc, &lun->error_list, links, desc2) {
2890 if (desc->serial != delete_desc->serial)
2893 STAILQ_REMOVE(&lun->error_list, desc, ctl_error_desc,
2898 mtx_unlock(&lun->lun_lock);
2899 if (delete_done == 0) {
2900 printf("%s: CTL_ERROR_INJECT_DELETE: can't find "
2901 "error serial %ju on LUN %u\n", __func__,
2902 delete_desc->serial, delete_desc->lun_id);
2908 case CTL_DUMP_STRUCTS: {
2910 struct ctl_port *port;
2911 struct ctl_frontend *fe;
2913 mtx_lock(&softc->ctl_lock);
2914 printf("CTL Persistent Reservation information start:\n");
2915 for (i = 0; i < CTL_MAX_LUNS; i++) {
2916 lun = softc->ctl_luns[i];
2919 || ((lun->flags & CTL_LUN_DISABLED) != 0))
2922 for (j = 0; j < CTL_MAX_PORTS; j++) {
2923 if (lun->pr_keys[j] == NULL)
2925 for (k = 0; k < CTL_MAX_INIT_PER_PORT; k++){
2926 if (lun->pr_keys[j][k] == 0)
2928 printf(" LUN %d port %d iid %d key "
2930 (uintmax_t)lun->pr_keys[j][k]);
2934 printf("CTL Persistent Reservation information end\n");
2935 printf("CTL Ports:\n");
2936 STAILQ_FOREACH(port, &softc->port_list, links) {
2937 printf(" Port %d '%s' Frontend '%s' Type %u pp %d vp %d WWNN "
2938 "%#jx WWPN %#jx\n", port->targ_port, port->port_name,
2939 port->frontend->name, port->port_type,
2940 port->physical_port, port->virtual_port,
2941 (uintmax_t)port->wwnn, (uintmax_t)port->wwpn);
2942 for (j = 0; j < CTL_MAX_INIT_PER_PORT; j++) {
2943 if (port->wwpn_iid[j].in_use == 0 &&
2944 port->wwpn_iid[j].wwpn == 0 &&
2945 port->wwpn_iid[j].name == NULL)
2948 printf(" iid %u use %d WWPN %#jx '%s'\n",
2949 j, port->wwpn_iid[j].in_use,
2950 (uintmax_t)port->wwpn_iid[j].wwpn,
2951 port->wwpn_iid[j].name);
2954 printf("CTL Port information end\n");
2955 mtx_unlock(&softc->ctl_lock);
2957 * XXX KDM calling this without a lock. We'd likely want
2958 * to drop the lock before calling the frontend's dump
2961 printf("CTL Frontends:\n");
2962 STAILQ_FOREACH(fe, &softc->fe_list, links) {
2963 printf(" Frontend '%s'\n", fe->name);
2964 if (fe->fe_dump != NULL)
2967 printf("CTL Frontend information end\n");
2971 struct ctl_lun_req *lun_req;
2972 struct ctl_backend_driver *backend;
2974 lun_req = (struct ctl_lun_req *)addr;
2976 backend = ctl_backend_find(lun_req->backend);
2977 if (backend == NULL) {
2978 lun_req->status = CTL_LUN_ERROR;
2979 snprintf(lun_req->error_str,
2980 sizeof(lun_req->error_str),
2981 "Backend \"%s\" not found.",
2985 if (lun_req->num_be_args > 0) {
2986 lun_req->kern_be_args = ctl_copyin_args(
2987 lun_req->num_be_args,
2990 sizeof(lun_req->error_str));
2991 if (lun_req->kern_be_args == NULL) {
2992 lun_req->status = CTL_LUN_ERROR;
2997 retval = backend->ioctl(dev, cmd, addr, flag, td);
2999 if (lun_req->num_be_args > 0) {
3000 ctl_copyout_args(lun_req->num_be_args,
3001 lun_req->kern_be_args);
3002 ctl_free_args(lun_req->num_be_args,
3003 lun_req->kern_be_args);
3007 case CTL_LUN_LIST: {
3009 struct ctl_lun_list *list;
3010 struct ctl_option *opt;
3012 list = (struct ctl_lun_list *)addr;
3015 * Allocate a fixed length sbuf here, based on the length
3016 * of the user's buffer. We could allocate an auto-extending
3017 * buffer, and then tell the user how much larger our
3018 * amount of data is than his buffer, but that presents
3021 * 1. The sbuf(9) routines use a blocking malloc, and so
3022 * we can't hold a lock while calling them with an
3023 * auto-extending buffer.
3025 * 2. There is not currently a LUN reference counting
3026 * mechanism, outside of outstanding transactions on
3027 * the LUN's OOA queue. So a LUN could go away on us
3028 * while we're getting the LUN number, backend-specific
3029 * information, etc. Thus, given the way things
3030 * currently work, we need to hold the CTL lock while
3031 * grabbing LUN information.
3033 * So, from the user's standpoint, the best thing to do is
3034 * allocate what he thinks is a reasonable buffer length,
3035 * and then if he gets a CTL_LUN_LIST_NEED_MORE_SPACE error,
3036 * double the buffer length and try again. (And repeat
3037 * that until he succeeds.)
3039 sb = sbuf_new(NULL, NULL, list->alloc_len, SBUF_FIXEDLEN);
3041 list->status = CTL_LUN_LIST_ERROR;
3042 snprintf(list->error_str, sizeof(list->error_str),
3043 "Unable to allocate %d bytes for LUN list",
3048 sbuf_printf(sb, "<ctllunlist>\n");
3050 mtx_lock(&softc->ctl_lock);
3051 STAILQ_FOREACH(lun, &softc->lun_list, links) {
3052 mtx_lock(&lun->lun_lock);
3053 retval = sbuf_printf(sb, "<lun id=\"%ju\">\n",
3054 (uintmax_t)lun->lun);
3057 * Bail out as soon as we see that we've overfilled
3063 retval = sbuf_printf(sb, "\t<backend_type>%s"
3064 "</backend_type>\n",
3065 (lun->backend == NULL) ? "none" :
3066 lun->backend->name);
3071 retval = sbuf_printf(sb, "\t<lun_type>%d</lun_type>\n",
3072 lun->be_lun->lun_type);
3077 if (lun->backend == NULL) {
3078 retval = sbuf_printf(sb, "</lun>\n");
3084 retval = sbuf_printf(sb, "\t<size>%ju</size>\n",
3085 (lun->be_lun->maxlba > 0) ?
3086 lun->be_lun->maxlba + 1 : 0);
3091 retval = sbuf_printf(sb, "\t<blocksize>%u</blocksize>\n",
3092 lun->be_lun->blocksize);
3097 retval = sbuf_printf(sb, "\t<serial_number>");
3102 retval = ctl_sbuf_printf_esc(sb,
3103 lun->be_lun->serial_num,
3104 sizeof(lun->be_lun->serial_num));
3109 retval = sbuf_printf(sb, "</serial_number>\n");
3114 retval = sbuf_printf(sb, "\t<device_id>");
3119 retval = ctl_sbuf_printf_esc(sb,
3120 lun->be_lun->device_id,
3121 sizeof(lun->be_lun->device_id));
3126 retval = sbuf_printf(sb, "</device_id>\n");
3131 if (lun->backend->lun_info != NULL) {
3132 retval = lun->backend->lun_info(lun->be_lun->be_lun, sb);
3136 STAILQ_FOREACH(opt, &lun->be_lun->options, links) {
3137 retval = sbuf_printf(sb, "\t<%s>%s</%s>\n",
3138 opt->name, opt->value, opt->name);
3143 retval = sbuf_printf(sb, "</lun>\n");
3147 mtx_unlock(&lun->lun_lock);
3150 mtx_unlock(&lun->lun_lock);
3151 mtx_unlock(&softc->ctl_lock);
3154 || ((retval = sbuf_printf(sb, "</ctllunlist>\n")) != 0)) {
3157 list->status = CTL_LUN_LIST_NEED_MORE_SPACE;
3158 snprintf(list->error_str, sizeof(list->error_str),
3159 "Out of space, %d bytes is too small",
3166 retval = copyout(sbuf_data(sb), list->lun_xml,
3169 list->fill_len = sbuf_len(sb) + 1;
3170 list->status = CTL_LUN_LIST_OK;
3175 struct ctl_iscsi *ci;
3176 struct ctl_frontend *fe;
3178 ci = (struct ctl_iscsi *)addr;
3180 fe = ctl_frontend_find("iscsi");
3182 ci->status = CTL_ISCSI_ERROR;
3183 snprintf(ci->error_str, sizeof(ci->error_str),
3184 "Frontend \"iscsi\" not found.");
3188 retval = fe->ioctl(dev, cmd, addr, flag, td);
3191 case CTL_PORT_REQ: {
3192 struct ctl_req *req;
3193 struct ctl_frontend *fe;
3195 req = (struct ctl_req *)addr;
3197 fe = ctl_frontend_find(req->driver);
3199 req->status = CTL_LUN_ERROR;
3200 snprintf(req->error_str, sizeof(req->error_str),
3201 "Frontend \"%s\" not found.", req->driver);
3204 if (req->num_args > 0) {
3205 req->kern_args = ctl_copyin_args(req->num_args,
3206 req->args, req->error_str, sizeof(req->error_str));
3207 if (req->kern_args == NULL) {
3208 req->status = CTL_LUN_ERROR;
3214 retval = fe->ioctl(dev, cmd, addr, flag, td);
3218 if (req->num_args > 0) {
3219 ctl_copyout_args(req->num_args, req->kern_args);
3220 ctl_free_args(req->num_args, req->kern_args);
3224 case CTL_PORT_LIST: {
3226 struct ctl_port *port;
3227 struct ctl_lun_list *list;
3228 struct ctl_option *opt;
3232 list = (struct ctl_lun_list *)addr;
3234 sb = sbuf_new(NULL, NULL, list->alloc_len, SBUF_FIXEDLEN);
3236 list->status = CTL_LUN_LIST_ERROR;
3237 snprintf(list->error_str, sizeof(list->error_str),
3238 "Unable to allocate %d bytes for LUN list",
3243 sbuf_printf(sb, "<ctlportlist>\n");
3245 mtx_lock(&softc->ctl_lock);
3246 STAILQ_FOREACH(port, &softc->port_list, links) {
3247 retval = sbuf_printf(sb, "<targ_port id=\"%ju\">\n",
3248 (uintmax_t)port->targ_port);
3251 * Bail out as soon as we see that we've overfilled
3257 retval = sbuf_printf(sb, "\t<frontend_type>%s"
3258 "</frontend_type>\n", port->frontend->name);
3262 retval = sbuf_printf(sb, "\t<port_type>%d</port_type>\n",
3267 retval = sbuf_printf(sb, "\t<online>%s</online>\n",
3268 (port->status & CTL_PORT_STATUS_ONLINE) ? "YES" : "NO");
3272 retval = sbuf_printf(sb, "\t<port_name>%s</port_name>\n",
3277 retval = sbuf_printf(sb, "\t<physical_port>%d</physical_port>\n",
3278 port->physical_port);
3282 retval = sbuf_printf(sb, "\t<virtual_port>%d</virtual_port>\n",
3283 port->virtual_port);
3287 if (port->target_devid != NULL) {
3288 sbuf_printf(sb, "\t<target>");
3289 ctl_id_sbuf(port->target_devid, sb);
3290 sbuf_printf(sb, "</target>\n");
3293 if (port->port_devid != NULL) {
3294 sbuf_printf(sb, "\t<port>");
3295 ctl_id_sbuf(port->port_devid, sb);
3296 sbuf_printf(sb, "</port>\n");
3299 if (port->port_info != NULL) {
3300 retval = port->port_info(port->onoff_arg, sb);
3304 STAILQ_FOREACH(opt, &port->options, links) {
3305 retval = sbuf_printf(sb, "\t<%s>%s</%s>\n",
3306 opt->name, opt->value, opt->name);
3311 if (port->lun_map != NULL) {
3312 sbuf_printf(sb, "\t<lun_map>on</lun_map>\n");
3313 for (j = 0; j < CTL_MAX_LUNS; j++) {
3314 plun = ctl_lun_map_from_port(port, j);
3315 if (plun >= CTL_MAX_LUNS)
3318 "\t<lun id=\"%u\">%u</lun>\n",
3323 for (j = 0; j < CTL_MAX_INIT_PER_PORT; j++) {
3324 if (port->wwpn_iid[j].in_use == 0 ||
3325 (port->wwpn_iid[j].wwpn == 0 &&
3326 port->wwpn_iid[j].name == NULL))
3329 if (port->wwpn_iid[j].name != NULL)
3330 retval = sbuf_printf(sb,
3331 "\t<initiator id=\"%u\">%s</initiator>\n",
3332 j, port->wwpn_iid[j].name);
3334 retval = sbuf_printf(sb,
3335 "\t<initiator id=\"%u\">naa.%08jx</initiator>\n",
3336 j, port->wwpn_iid[j].wwpn);
3343 retval = sbuf_printf(sb, "</targ_port>\n");
3347 mtx_unlock(&softc->ctl_lock);
3350 || ((retval = sbuf_printf(sb, "</ctlportlist>\n")) != 0)) {
3353 list->status = CTL_LUN_LIST_NEED_MORE_SPACE;
3354 snprintf(list->error_str, sizeof(list->error_str),
3355 "Out of space, %d bytes is too small",
3362 retval = copyout(sbuf_data(sb), list->lun_xml,
3365 list->fill_len = sbuf_len(sb) + 1;
3366 list->status = CTL_LUN_LIST_OK;
3371 struct ctl_lun_map *lm = (struct ctl_lun_map *)addr;
3372 struct ctl_port *port;
3374 mtx_lock(&softc->ctl_lock);
3375 if (lm->port < softc->port_min ||
3376 lm->port >= softc->port_max ||
3377 (port = softc->ctl_ports[lm->port]) == NULL) {
3378 mtx_unlock(&softc->ctl_lock);
3381 if (port->status & CTL_PORT_STATUS_ONLINE) {
3382 STAILQ_FOREACH(lun, &softc->lun_list, links) {
3383 if (ctl_lun_map_to_port(port, lun->lun) >=
3386 mtx_lock(&lun->lun_lock);
3387 ctl_est_ua_port(lun, lm->port, -1,
3389 mtx_unlock(&lun->lun_lock);
3392 mtx_unlock(&softc->ctl_lock); // XXX: port_enable sleeps
3393 if (lm->plun < CTL_MAX_LUNS) {
3394 if (lm->lun == UINT32_MAX)
3395 retval = ctl_lun_map_unset(port, lm->plun);
3396 else if (lm->lun < CTL_MAX_LUNS &&
3397 softc->ctl_luns[lm->lun] != NULL)
3398 retval = ctl_lun_map_set(port, lm->plun, lm->lun);
3401 } else if (lm->plun == UINT32_MAX) {
3402 if (lm->lun == UINT32_MAX)
3403 retval = ctl_lun_map_deinit(port);
3405 retval = ctl_lun_map_init(port);
3408 if (port->status & CTL_PORT_STATUS_ONLINE)
3409 ctl_isc_announce_port(port);
3413 /* XXX KDM should we fix this? */
3415 struct ctl_backend_driver *backend;
3422 * We encode the backend type as the ioctl type for backend
3423 * ioctls. So parse it out here, and then search for a
3424 * backend of this type.
3426 type = _IOC_TYPE(cmd);
3428 STAILQ_FOREACH(backend, &softc->be_list, links) {
3429 if (backend->type == type) {
3435 printf("ctl: unknown ioctl command %#lx or backend "
3440 retval = backend->ioctl(dev, cmd, addr, flag, td);
3450 ctl_get_initindex(struct ctl_nexus *nexus)
3452 return (nexus->initid + (nexus->targ_port * CTL_MAX_INIT_PER_PORT));
3456 ctl_lun_map_init(struct ctl_port *port)
3458 struct ctl_softc *softc = port->ctl_softc;
3459 struct ctl_lun *lun;
3462 if (port->lun_map == NULL)
3463 port->lun_map = malloc(sizeof(uint32_t) * CTL_MAX_LUNS,
3465 if (port->lun_map == NULL)
3467 for (i = 0; i < CTL_MAX_LUNS; i++)
3468 port->lun_map[i] = UINT32_MAX;
3469 if (port->status & CTL_PORT_STATUS_ONLINE) {
3470 if (port->lun_disable != NULL) {
3471 STAILQ_FOREACH(lun, &softc->lun_list, links)
3472 port->lun_disable(port->targ_lun_arg, lun->lun);
3474 ctl_isc_announce_port(port);
3480 ctl_lun_map_deinit(struct ctl_port *port)
3482 struct ctl_softc *softc = port->ctl_softc;
3483 struct ctl_lun *lun;
3485 if (port->lun_map == NULL)
3487 free(port->lun_map, M_CTL);
3488 port->lun_map = NULL;
3489 if (port->status & CTL_PORT_STATUS_ONLINE) {
3490 if (port->lun_enable != NULL) {
3491 STAILQ_FOREACH(lun, &softc->lun_list, links)
3492 port->lun_enable(port->targ_lun_arg, lun->lun);
3494 ctl_isc_announce_port(port);
3500 ctl_lun_map_set(struct ctl_port *port, uint32_t plun, uint32_t glun)
3505 if (port->lun_map == NULL) {
3506 status = ctl_lun_map_init(port);
3510 old = port->lun_map[plun];
3511 port->lun_map[plun] = glun;
3512 if ((port->status & CTL_PORT_STATUS_ONLINE) && old >= CTL_MAX_LUNS) {
3513 if (port->lun_enable != NULL)
3514 port->lun_enable(port->targ_lun_arg, plun);
3515 ctl_isc_announce_port(port);
3521 ctl_lun_map_unset(struct ctl_port *port, uint32_t plun)
3525 if (port->lun_map == NULL)
3527 old = port->lun_map[plun];
3528 port->lun_map[plun] = UINT32_MAX;
3529 if ((port->status & CTL_PORT_STATUS_ONLINE) && old < CTL_MAX_LUNS) {
3530 if (port->lun_disable != NULL)
3531 port->lun_disable(port->targ_lun_arg, plun);
3532 ctl_isc_announce_port(port);
3538 ctl_lun_map_from_port(struct ctl_port *port, uint32_t lun_id)
3542 return (UINT32_MAX);
3543 if (port->lun_map == NULL || lun_id >= CTL_MAX_LUNS)
3545 return (port->lun_map[lun_id]);
3549 ctl_lun_map_to_port(struct ctl_port *port, uint32_t lun_id)
3554 return (UINT32_MAX);
3555 if (port->lun_map == NULL)
3557 for (i = 0; i < CTL_MAX_LUNS; i++) {
3558 if (port->lun_map[i] == lun_id)
3561 return (UINT32_MAX);
3565 ctl_decode_lun(uint64_t encoded)
3568 uint32_t result = 0xffffffff;
3570 be64enc(lun, encoded);
3571 switch (lun[0] & RPL_LUNDATA_ATYP_MASK) {
3572 case RPL_LUNDATA_ATYP_PERIPH:
3573 if ((lun[0] & 0x3f) == 0 && lun[2] == 0 && lun[3] == 0 &&
3574 lun[4] == 0 && lun[5] == 0 && lun[6] == 0 && lun[7] == 0)
3577 case RPL_LUNDATA_ATYP_FLAT:
3578 if (lun[2] == 0 && lun[3] == 0 && lun[4] == 0 && lun[5] == 0 &&
3579 lun[6] == 0 && lun[7] == 0)
3580 result = ((lun[0] & 0x3f) << 8) + lun[1];
3582 case RPL_LUNDATA_ATYP_EXTLUN:
3583 switch (lun[0] & RPL_LUNDATA_EXT_EAM_MASK) {
3585 switch (lun[0] & RPL_LUNDATA_EXT_LEN_MASK) {
3590 result = (lun[1] << 16) + (lun[2] << 8) +
3594 if (lun[1] == 0 && lun[6] == 0 && lun[7] == 0)
3595 result = (lun[2] << 24) +
3596 (lun[3] << 16) + (lun[4] << 8) +
3601 case RPL_LUNDATA_EXT_EAM_NOT_SPEC:
3602 result = 0xffffffff;
3611 ctl_encode_lun(uint32_t decoded)
3613 uint64_t l = decoded;
3616 return (((uint64_t)RPL_LUNDATA_ATYP_PERIPH << 56) | (l << 48));
3618 return (((uint64_t)RPL_LUNDATA_ATYP_FLAT << 56) | (l << 48));
3620 return (((uint64_t)(RPL_LUNDATA_ATYP_EXTLUN | 0x12) << 56) |
3622 return ((((uint64_t)RPL_LUNDATA_ATYP_EXTLUN | 0x22) << 56) | (l << 16));
3625 static struct ctl_port *
3626 ctl_io_port(struct ctl_io_hdr *io_hdr)
3629 return (control_softc->ctl_ports[io_hdr->nexus.targ_port]);
3633 ctl_ffz(uint32_t *mask, uint32_t first, uint32_t last)
3637 for (i = first; i < last; i++) {
3638 if ((mask[i / 32] & (1 << (i % 32))) == 0)
3645 ctl_set_mask(uint32_t *mask, uint32_t bit)
3647 uint32_t chunk, piece;
3650 piece = bit % (sizeof(uint32_t) * 8);
3652 if ((mask[chunk] & (1 << piece)) != 0)
3655 mask[chunk] |= (1 << piece);
3661 ctl_clear_mask(uint32_t *mask, uint32_t bit)
3663 uint32_t chunk, piece;
3666 piece = bit % (sizeof(uint32_t) * 8);
3668 if ((mask[chunk] & (1 << piece)) == 0)
3671 mask[chunk] &= ~(1 << piece);
3677 ctl_is_set(uint32_t *mask, uint32_t bit)
3679 uint32_t chunk, piece;
3682 piece = bit % (sizeof(uint32_t) * 8);
3684 if ((mask[chunk] & (1 << piece)) == 0)
3691 ctl_get_prkey(struct ctl_lun *lun, uint32_t residx)
3695 t = lun->pr_keys[residx/CTL_MAX_INIT_PER_PORT];
3698 return (t[residx % CTL_MAX_INIT_PER_PORT]);
3702 ctl_clr_prkey(struct ctl_lun *lun, uint32_t residx)
3706 t = lun->pr_keys[residx/CTL_MAX_INIT_PER_PORT];
3709 t[residx % CTL_MAX_INIT_PER_PORT] = 0;
3713 ctl_alloc_prkey(struct ctl_lun *lun, uint32_t residx)
3718 i = residx/CTL_MAX_INIT_PER_PORT;
3719 if (lun->pr_keys[i] != NULL)
3721 mtx_unlock(&lun->lun_lock);
3722 p = malloc(sizeof(uint64_t) * CTL_MAX_INIT_PER_PORT, M_CTL,
3724 mtx_lock(&lun->lun_lock);
3725 if (lun->pr_keys[i] == NULL)
3726 lun->pr_keys[i] = p;
3732 ctl_set_prkey(struct ctl_lun *lun, uint32_t residx, uint64_t key)
3736 t = lun->pr_keys[residx/CTL_MAX_INIT_PER_PORT];
3737 KASSERT(t != NULL, ("prkey %d is not allocated", residx));
3738 t[residx % CTL_MAX_INIT_PER_PORT] = key;
3742 * ctl_softc, pool_name, total_ctl_io are passed in.
3743 * npool is passed out.
3746 ctl_pool_create(struct ctl_softc *ctl_softc, const char *pool_name,
3747 uint32_t total_ctl_io, void **npool)
3750 struct ctl_io_pool *pool;
3752 pool = (struct ctl_io_pool *)malloc(sizeof(*pool), M_CTL,
3757 snprintf(pool->name, sizeof(pool->name), "CTL IO %s", pool_name);
3758 pool->ctl_softc = ctl_softc;
3759 pool->zone = uma_zsecond_create(pool->name, NULL,
3760 NULL, NULL, NULL, ctl_softc->io_zone);
3761 /* uma_prealloc(pool->zone, total_ctl_io); */
3765 *npool = ctl_softc->io_zone;
3771 ctl_pool_free(struct ctl_io_pool *pool)
3778 uma_zdestroy(pool->zone);
3784 ctl_alloc_io(void *pool_ref)
3788 struct ctl_io_pool *pool = (struct ctl_io_pool *)pool_ref;
3790 io = uma_zalloc(pool->zone, M_WAITOK);
3792 io = uma_zalloc((uma_zone_t)pool_ref, M_WAITOK);
3795 io->io_hdr.pool = pool_ref;
3800 ctl_alloc_io_nowait(void *pool_ref)
3804 struct ctl_io_pool *pool = (struct ctl_io_pool *)pool_ref;
3806 io = uma_zalloc(pool->zone, M_NOWAIT);
3808 io = uma_zalloc((uma_zone_t)pool_ref, M_NOWAIT);
3811 io->io_hdr.pool = pool_ref;
3816 ctl_free_io(union ctl_io *io)
3819 struct ctl_io_pool *pool;
3826 pool = (struct ctl_io_pool *)io->io_hdr.pool;
3827 uma_zfree(pool->zone, io);
3829 uma_zfree((uma_zone_t)io->io_hdr.pool, io);
3834 ctl_zero_io(union ctl_io *io)
3842 * May need to preserve linked list pointers at some point too.
3844 pool_ref = io->io_hdr.pool;
3845 memset(io, 0, sizeof(*io));
3846 io->io_hdr.pool = pool_ref;
3850 ctl_expand_number(const char *buf, uint64_t *num)
3856 number = strtoq(buf, &endptr, 0);
3858 switch (tolower((unsigned char)*endptr)) {
3878 case '\0': /* No unit. */
3882 /* Unrecognized unit. */
3886 if ((number << shift) >> shift != number) {
3890 *num = number << shift;
3896 * This routine could be used in the future to load default and/or saved
3897 * mode page parameters for a particuar lun.
3900 ctl_init_page_index(struct ctl_lun *lun)
3903 struct ctl_page_index *page_index;
3907 memcpy(&lun->mode_pages.index, page_index_template,
3908 sizeof(page_index_template));
3910 for (i = 0; i < CTL_NUM_MODE_PAGES; i++) {
3912 page_index = &lun->mode_pages.index[i];
3913 if (lun->be_lun->lun_type == T_DIRECT &&
3914 (page_index->page_flags & CTL_PAGE_FLAG_DIRECT) == 0)
3916 if (lun->be_lun->lun_type == T_PROCESSOR &&
3917 (page_index->page_flags & CTL_PAGE_FLAG_PROC) == 0)
3919 if (lun->be_lun->lun_type == T_CDROM &&
3920 (page_index->page_flags & CTL_PAGE_FLAG_CDROM) == 0)
3923 page_code = page_index->page_code & SMPH_PC_MASK;
3924 switch (page_code) {
3925 case SMS_RW_ERROR_RECOVERY_PAGE: {
3926 KASSERT(page_index->subpage == SMS_SUBPAGE_PAGE_0,
3927 ("subpage %#x for page %#x is incorrect!",
3928 page_index->subpage, page_code));
3929 memcpy(&lun->mode_pages.rw_er_page[CTL_PAGE_CURRENT],
3930 &rw_er_page_default,
3931 sizeof(rw_er_page_default));
3932 memcpy(&lun->mode_pages.rw_er_page[CTL_PAGE_CHANGEABLE],
3933 &rw_er_page_changeable,
3934 sizeof(rw_er_page_changeable));
3935 memcpy(&lun->mode_pages.rw_er_page[CTL_PAGE_DEFAULT],
3936 &rw_er_page_default,
3937 sizeof(rw_er_page_default));
3938 memcpy(&lun->mode_pages.rw_er_page[CTL_PAGE_SAVED],
3939 &rw_er_page_default,
3940 sizeof(rw_er_page_default));
3941 page_index->page_data =
3942 (uint8_t *)lun->mode_pages.rw_er_page;
3945 case SMS_FORMAT_DEVICE_PAGE: {
3946 struct scsi_format_page *format_page;
3948 KASSERT(page_index->subpage == SMS_SUBPAGE_PAGE_0,
3949 ("subpage %#x for page %#x is incorrect!",
3950 page_index->subpage, page_code));
3953 * Sectors per track are set above. Bytes per
3954 * sector need to be set here on a per-LUN basis.
3956 memcpy(&lun->mode_pages.format_page[CTL_PAGE_CURRENT],
3957 &format_page_default,
3958 sizeof(format_page_default));
3959 memcpy(&lun->mode_pages.format_page[
3960 CTL_PAGE_CHANGEABLE], &format_page_changeable,
3961 sizeof(format_page_changeable));
3962 memcpy(&lun->mode_pages.format_page[CTL_PAGE_DEFAULT],
3963 &format_page_default,
3964 sizeof(format_page_default));
3965 memcpy(&lun->mode_pages.format_page[CTL_PAGE_SAVED],
3966 &format_page_default,
3967 sizeof(format_page_default));
3969 format_page = &lun->mode_pages.format_page[
3971 scsi_ulto2b(lun->be_lun->blocksize,
3972 format_page->bytes_per_sector);
3974 format_page = &lun->mode_pages.format_page[
3976 scsi_ulto2b(lun->be_lun->blocksize,
3977 format_page->bytes_per_sector);
3979 format_page = &lun->mode_pages.format_page[
3981 scsi_ulto2b(lun->be_lun->blocksize,
3982 format_page->bytes_per_sector);
3984 page_index->page_data =
3985 (uint8_t *)lun->mode_pages.format_page;
3988 case SMS_RIGID_DISK_PAGE: {
3989 struct scsi_rigid_disk_page *rigid_disk_page;
3990 uint32_t sectors_per_cylinder;
3994 #endif /* !__XSCALE__ */
3996 KASSERT(page_index->subpage == SMS_SUBPAGE_PAGE_0,
3997 ("subpage %#x for page %#x is incorrect!",
3998 page_index->subpage, page_code));
4001 * Rotation rate and sectors per track are set
4002 * above. We calculate the cylinders here based on
4003 * capacity. Due to the number of heads and
4004 * sectors per track we're using, smaller arrays
4005 * may turn out to have 0 cylinders. Linux and
4006 * FreeBSD don't pay attention to these mode pages
4007 * to figure out capacity, but Solaris does. It
4008 * seems to deal with 0 cylinders just fine, and
4009 * works out a fake geometry based on the capacity.
4011 memcpy(&lun->mode_pages.rigid_disk_page[
4012 CTL_PAGE_DEFAULT], &rigid_disk_page_default,
4013 sizeof(rigid_disk_page_default));
4014 memcpy(&lun->mode_pages.rigid_disk_page[
4015 CTL_PAGE_CHANGEABLE],&rigid_disk_page_changeable,
4016 sizeof(rigid_disk_page_changeable));
4018 sectors_per_cylinder = CTL_DEFAULT_SECTORS_PER_TRACK *
4022 * The divide method here will be more accurate,
4023 * probably, but results in floating point being
4024 * used in the kernel on i386 (__udivdi3()). On the
4025 * XScale, though, __udivdi3() is implemented in
4028 * The shift method for cylinder calculation is
4029 * accurate if sectors_per_cylinder is a power of
4030 * 2. Otherwise it might be slightly off -- you
4031 * might have a bit of a truncation problem.
4034 cylinders = (lun->be_lun->maxlba + 1) /
4035 sectors_per_cylinder;
4037 for (shift = 31; shift > 0; shift--) {
4038 if (sectors_per_cylinder & (1 << shift))
4041 cylinders = (lun->be_lun->maxlba + 1) >> shift;
4045 * We've basically got 3 bytes, or 24 bits for the
4046 * cylinder size in the mode page. If we're over,
4047 * just round down to 2^24.
4049 if (cylinders > 0xffffff)
4050 cylinders = 0xffffff;
4052 rigid_disk_page = &lun->mode_pages.rigid_disk_page[
4054 scsi_ulto3b(cylinders, rigid_disk_page->cylinders);
4056 if ((value = ctl_get_opt(&lun->be_lun->options,
4058 scsi_ulto2b(strtol(value, NULL, 0),
4059 rigid_disk_page->rotation_rate);
4062 memcpy(&lun->mode_pages.rigid_disk_page[CTL_PAGE_CURRENT],
4063 &lun->mode_pages.rigid_disk_page[CTL_PAGE_DEFAULT],
4064 sizeof(rigid_disk_page_default));
4065 memcpy(&lun->mode_pages.rigid_disk_page[CTL_PAGE_SAVED],
4066 &lun->mode_pages.rigid_disk_page[CTL_PAGE_DEFAULT],
4067 sizeof(rigid_disk_page_default));
4069 page_index->page_data =
4070 (uint8_t *)lun->mode_pages.rigid_disk_page;
4073 case SMS_CACHING_PAGE: {
4074 struct scsi_caching_page *caching_page;
4076 KASSERT(page_index->subpage == SMS_SUBPAGE_PAGE_0,
4077 ("subpage %#x for page %#x is incorrect!",
4078 page_index->subpage, page_code));
4079 memcpy(&lun->mode_pages.caching_page[CTL_PAGE_DEFAULT],
4080 &caching_page_default,
4081 sizeof(caching_page_default));
4082 memcpy(&lun->mode_pages.caching_page[
4083 CTL_PAGE_CHANGEABLE], &caching_page_changeable,
4084 sizeof(caching_page_changeable));
4085 memcpy(&lun->mode_pages.caching_page[CTL_PAGE_SAVED],
4086 &caching_page_default,
4087 sizeof(caching_page_default));
4088 caching_page = &lun->mode_pages.caching_page[
4090 value = ctl_get_opt(&lun->be_lun->options, "writecache");
4091 if (value != NULL && strcmp(value, "off") == 0)
4092 caching_page->flags1 &= ~SCP_WCE;
4093 value = ctl_get_opt(&lun->be_lun->options, "readcache");
4094 if (value != NULL && strcmp(value, "off") == 0)
4095 caching_page->flags1 |= SCP_RCD;
4096 memcpy(&lun->mode_pages.caching_page[CTL_PAGE_CURRENT],
4097 &lun->mode_pages.caching_page[CTL_PAGE_SAVED],
4098 sizeof(caching_page_default));
4099 page_index->page_data =
4100 (uint8_t *)lun->mode_pages.caching_page;
4103 case SMS_CONTROL_MODE_PAGE: {
4104 switch (page_index->subpage) {
4105 case SMS_SUBPAGE_PAGE_0: {
4106 struct scsi_control_page *control_page;
4108 memcpy(&lun->mode_pages.control_page[
4110 &control_page_default,
4111 sizeof(control_page_default));
4112 memcpy(&lun->mode_pages.control_page[
4113 CTL_PAGE_CHANGEABLE],
4114 &control_page_changeable,
4115 sizeof(control_page_changeable));
4116 memcpy(&lun->mode_pages.control_page[
4118 &control_page_default,
4119 sizeof(control_page_default));
4120 control_page = &lun->mode_pages.control_page[
4122 value = ctl_get_opt(&lun->be_lun->options,
4124 if (value != NULL &&
4125 strcmp(value, "unrestricted") == 0) {
4126 control_page->queue_flags &=
4127 ~SCP_QUEUE_ALG_MASK;
4128 control_page->queue_flags |=
4129 SCP_QUEUE_ALG_UNRESTRICTED;
4131 memcpy(&lun->mode_pages.control_page[
4133 &lun->mode_pages.control_page[
4135 sizeof(control_page_default));
4136 page_index->page_data =
4137 (uint8_t *)lun->mode_pages.control_page;
4141 memcpy(&lun->mode_pages.control_ext_page[
4143 &control_ext_page_default,
4144 sizeof(control_ext_page_default));
4145 memcpy(&lun->mode_pages.control_ext_page[
4146 CTL_PAGE_CHANGEABLE],
4147 &control_ext_page_changeable,
4148 sizeof(control_ext_page_changeable));
4149 memcpy(&lun->mode_pages.control_ext_page[
4151 &control_ext_page_default,
4152 sizeof(control_ext_page_default));
4153 memcpy(&lun->mode_pages.control_ext_page[
4155 &lun->mode_pages.control_ext_page[
4157 sizeof(control_ext_page_default));
4158 page_index->page_data =
4159 (uint8_t *)lun->mode_pages.control_ext_page;
4162 panic("subpage %#x for page %#x is incorrect!",
4163 page_index->subpage, page_code);
4167 case SMS_INFO_EXCEPTIONS_PAGE: {
4168 switch (page_index->subpage) {
4169 case SMS_SUBPAGE_PAGE_0:
4170 memcpy(&lun->mode_pages.ie_page[CTL_PAGE_CURRENT],
4172 sizeof(ie_page_default));
4173 memcpy(&lun->mode_pages.ie_page[
4174 CTL_PAGE_CHANGEABLE], &ie_page_changeable,
4175 sizeof(ie_page_changeable));
4176 memcpy(&lun->mode_pages.ie_page[CTL_PAGE_DEFAULT],
4178 sizeof(ie_page_default));
4179 memcpy(&lun->mode_pages.ie_page[CTL_PAGE_SAVED],
4181 sizeof(ie_page_default));
4182 page_index->page_data =
4183 (uint8_t *)lun->mode_pages.ie_page;
4186 struct ctl_logical_block_provisioning_page *page;
4188 memcpy(&lun->mode_pages.lbp_page[CTL_PAGE_DEFAULT],
4190 sizeof(lbp_page_default));
4191 memcpy(&lun->mode_pages.lbp_page[
4192 CTL_PAGE_CHANGEABLE], &lbp_page_changeable,
4193 sizeof(lbp_page_changeable));
4194 memcpy(&lun->mode_pages.lbp_page[CTL_PAGE_SAVED],
4196 sizeof(lbp_page_default));
4197 page = &lun->mode_pages.lbp_page[CTL_PAGE_SAVED];
4198 value = ctl_get_opt(&lun->be_lun->options,
4200 if (value != NULL &&
4201 ctl_expand_number(value, &ival) == 0) {
4202 page->descr[0].flags |= SLBPPD_ENABLED |
4204 if (lun->be_lun->blocksize)
4205 ival /= lun->be_lun->blocksize;
4208 scsi_ulto4b(ival >> CTL_LBP_EXPONENT,
4209 page->descr[0].count);
4211 value = ctl_get_opt(&lun->be_lun->options,
4213 if (value != NULL &&
4214 ctl_expand_number(value, &ival) == 0) {
4215 page->descr[1].flags |= SLBPPD_ENABLED |
4217 if (lun->be_lun->blocksize)
4218 ival /= lun->be_lun->blocksize;
4221 scsi_ulto4b(ival >> CTL_LBP_EXPONENT,
4222 page->descr[1].count);
4224 value = ctl_get_opt(&lun->be_lun->options,
4225 "pool-avail-threshold");
4226 if (value != NULL &&
4227 ctl_expand_number(value, &ival) == 0) {
4228 page->descr[2].flags |= SLBPPD_ENABLED |
4230 if (lun->be_lun->blocksize)
4231 ival /= lun->be_lun->blocksize;
4234 scsi_ulto4b(ival >> CTL_LBP_EXPONENT,
4235 page->descr[2].count);
4237 value = ctl_get_opt(&lun->be_lun->options,
4238 "pool-used-threshold");
4239 if (value != NULL &&
4240 ctl_expand_number(value, &ival) == 0) {
4241 page->descr[3].flags |= SLBPPD_ENABLED |
4243 if (lun->be_lun->blocksize)
4244 ival /= lun->be_lun->blocksize;
4247 scsi_ulto4b(ival >> CTL_LBP_EXPONENT,
4248 page->descr[3].count);
4250 memcpy(&lun->mode_pages.lbp_page[CTL_PAGE_CURRENT],
4251 &lun->mode_pages.lbp_page[CTL_PAGE_SAVED],
4252 sizeof(lbp_page_default));
4253 page_index->page_data =
4254 (uint8_t *)lun->mode_pages.lbp_page;
4258 panic("subpage %#x for page %#x is incorrect!",
4259 page_index->subpage, page_code);
4263 case SMS_CDDVD_CAPS_PAGE:{
4264 KASSERT(page_index->subpage == SMS_SUBPAGE_PAGE_0,
4265 ("subpage %#x for page %#x is incorrect!",
4266 page_index->subpage, page_code));
4267 memcpy(&lun->mode_pages.cddvd_page[CTL_PAGE_DEFAULT],
4268 &cddvd_page_default,
4269 sizeof(cddvd_page_default));
4270 memcpy(&lun->mode_pages.cddvd_page[
4271 CTL_PAGE_CHANGEABLE], &cddvd_page_changeable,
4272 sizeof(cddvd_page_changeable));
4273 memcpy(&lun->mode_pages.cddvd_page[CTL_PAGE_SAVED],
4274 &cddvd_page_default,
4275 sizeof(cddvd_page_default));
4276 memcpy(&lun->mode_pages.cddvd_page[CTL_PAGE_CURRENT],
4277 &lun->mode_pages.cddvd_page[CTL_PAGE_SAVED],
4278 sizeof(cddvd_page_default));
4279 page_index->page_data =
4280 (uint8_t *)lun->mode_pages.cddvd_page;
4283 case SMS_VENDOR_SPECIFIC_PAGE:{
4284 switch (page_index->subpage) {
4285 case DBGCNF_SUBPAGE_CODE: {
4286 memcpy(&lun->mode_pages.debugconf_subpage[
4288 &debugconf_page_default,
4289 sizeof(debugconf_page_default));
4290 memcpy(&lun->mode_pages.debugconf_subpage[
4291 CTL_PAGE_CHANGEABLE],
4292 &debugconf_page_changeable,
4293 sizeof(debugconf_page_changeable));
4294 memcpy(&lun->mode_pages.debugconf_subpage[
4296 &debugconf_page_default,
4297 sizeof(debugconf_page_default));
4298 memcpy(&lun->mode_pages.debugconf_subpage[
4300 &debugconf_page_default,
4301 sizeof(debugconf_page_default));
4302 page_index->page_data =
4303 (uint8_t *)lun->mode_pages.debugconf_subpage;
4307 panic("subpage %#x for page %#x is incorrect!",
4308 page_index->subpage, page_code);
4313 panic("invalid page code value %#x", page_code);
4317 return (CTL_RETVAL_COMPLETE);
4321 ctl_init_log_page_index(struct ctl_lun *lun)
4323 struct ctl_page_index *page_index;
4326 memcpy(&lun->log_pages.index, log_page_index_template,
4327 sizeof(log_page_index_template));
4330 for (i = 0, j = 0, k = 0; i < CTL_NUM_LOG_PAGES; i++) {
4332 page_index = &lun->log_pages.index[i];
4333 if (lun->be_lun->lun_type == T_DIRECT &&
4334 (page_index->page_flags & CTL_PAGE_FLAG_DIRECT) == 0)
4336 if (lun->be_lun->lun_type == T_PROCESSOR &&
4337 (page_index->page_flags & CTL_PAGE_FLAG_PROC) == 0)
4339 if (lun->be_lun->lun_type == T_CDROM &&
4340 (page_index->page_flags & CTL_PAGE_FLAG_CDROM) == 0)
4343 if (page_index->page_code == SLS_LOGICAL_BLOCK_PROVISIONING &&
4344 lun->backend->lun_attr == NULL)
4347 if (page_index->page_code != prev) {
4348 lun->log_pages.pages_page[j] = page_index->page_code;
4349 prev = page_index->page_code;
4352 lun->log_pages.subpages_page[k*2] = page_index->page_code;
4353 lun->log_pages.subpages_page[k*2+1] = page_index->subpage;
4356 lun->log_pages.index[0].page_data = &lun->log_pages.pages_page[0];
4357 lun->log_pages.index[0].page_len = j;
4358 lun->log_pages.index[1].page_data = &lun->log_pages.subpages_page[0];
4359 lun->log_pages.index[1].page_len = k * 2;
4360 lun->log_pages.index[2].page_data = &lun->log_pages.lbp_page[0];
4361 lun->log_pages.index[2].page_len = 12*CTL_NUM_LBP_PARAMS;
4362 lun->log_pages.index[3].page_data = (uint8_t *)&lun->log_pages.stat_page;
4363 lun->log_pages.index[3].page_len = sizeof(lun->log_pages.stat_page);
4365 return (CTL_RETVAL_COMPLETE);
4369 hex2bin(const char *str, uint8_t *buf, int buf_size)
4374 memset(buf, 0, buf_size);
4375 while (isspace(str[0]))
4377 if (str[0] == '0' && (str[1] == 'x' || str[1] == 'X'))
4380 for (i = 0; str[i] != 0 && i < buf_size; i++) {
4384 else if (isalpha(c))
4385 c -= isupper(c) ? 'A' - 10 : 'a' - 10;
4391 buf[i / 2] |= (c << 4);
4395 return ((i + 1) / 2);
4402 * - caller allocates and zeros LUN storage, or passes in a NULL LUN if he
4403 * wants us to allocate the LUN and he can block.
4404 * - ctl_softc is always set
4405 * - be_lun is set if the LUN has a backend (needed for disk LUNs)
4407 * Returns 0 for success, non-zero (errno) for failure.
4410 ctl_alloc_lun(struct ctl_softc *ctl_softc, struct ctl_lun *ctl_lun,
4411 struct ctl_be_lun *const be_lun)
4413 struct ctl_lun *nlun, *lun;
4414 struct scsi_vpd_id_descriptor *desc;
4415 struct scsi_vpd_id_t10 *t10id;
4416 const char *eui, *naa, *scsiname, *vendor, *value;
4417 int lun_number, i, lun_malloced;
4418 int devidlen, idlen1, idlen2 = 0, len;
4424 * We currently only support Direct Access or Processor LUN types.
4426 switch (be_lun->lun_type) {
4434 be_lun->lun_config_status(be_lun->be_lun,
4435 CTL_LUN_CONFIG_FAILURE);
4438 if (ctl_lun == NULL) {
4439 lun = malloc(sizeof(*lun), M_CTL, M_WAITOK);
4446 memset(lun, 0, sizeof(*lun));
4448 lun->flags = CTL_LUN_MALLOCED;
4450 /* Generate LUN ID. */
4451 devidlen = max(CTL_DEVID_MIN_LEN,
4452 strnlen(be_lun->device_id, CTL_DEVID_LEN));
4453 idlen1 = sizeof(*t10id) + devidlen;
4454 len = sizeof(struct scsi_vpd_id_descriptor) + idlen1;
4455 scsiname = ctl_get_opt(&be_lun->options, "scsiname");
4456 if (scsiname != NULL) {
4457 idlen2 = roundup2(strlen(scsiname) + 1, 4);
4458 len += sizeof(struct scsi_vpd_id_descriptor) + idlen2;
4460 eui = ctl_get_opt(&be_lun->options, "eui");
4462 len += sizeof(struct scsi_vpd_id_descriptor) + 16;
4464 naa = ctl_get_opt(&be_lun->options, "naa");
4466 len += sizeof(struct scsi_vpd_id_descriptor) + 16;
4468 lun->lun_devid = malloc(sizeof(struct ctl_devid) + len,
4469 M_CTL, M_WAITOK | M_ZERO);
4470 desc = (struct scsi_vpd_id_descriptor *)lun->lun_devid->data;
4471 desc->proto_codeset = SVPD_ID_CODESET_ASCII;
4472 desc->id_type = SVPD_ID_PIV | SVPD_ID_ASSOC_LUN | SVPD_ID_TYPE_T10;
4473 desc->length = idlen1;
4474 t10id = (struct scsi_vpd_id_t10 *)&desc->identifier[0];
4475 memset(t10id->vendor, ' ', sizeof(t10id->vendor));
4476 if ((vendor = ctl_get_opt(&be_lun->options, "vendor")) == NULL) {
4477 strncpy((char *)t10id->vendor, CTL_VENDOR, sizeof(t10id->vendor));
4479 strncpy(t10id->vendor, vendor,
4480 min(sizeof(t10id->vendor), strlen(vendor)));
4482 strncpy((char *)t10id->vendor_spec_id,
4483 (char *)be_lun->device_id, devidlen);
4484 if (scsiname != NULL) {
4485 desc = (struct scsi_vpd_id_descriptor *)(&desc->identifier[0] +
4487 desc->proto_codeset = SVPD_ID_CODESET_UTF8;
4488 desc->id_type = SVPD_ID_PIV | SVPD_ID_ASSOC_LUN |
4489 SVPD_ID_TYPE_SCSI_NAME;
4490 desc->length = idlen2;
4491 strlcpy(desc->identifier, scsiname, idlen2);
4494 desc = (struct scsi_vpd_id_descriptor *)(&desc->identifier[0] +
4496 desc->proto_codeset = SVPD_ID_CODESET_BINARY;
4497 desc->id_type = SVPD_ID_PIV | SVPD_ID_ASSOC_LUN |
4499 desc->length = hex2bin(eui, desc->identifier, 16);
4500 desc->length = desc->length > 12 ? 16 :
4501 (desc->length > 8 ? 12 : 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->length = hex2bin(naa, desc->identifier, 16);
4511 desc->length = desc->length > 8 ? 16 : 8;
4512 len -= 16 - desc->length;
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 ctl_tpc_lun_init(lun);
4597 * Initialize the mode and log page index.
4599 ctl_init_page_index(lun);
4600 ctl_init_log_page_index(lun);
4603 * Now, before we insert this lun on the lun list, set the lun
4604 * inventory changed UA for all other luns.
4606 STAILQ_FOREACH(nlun, &ctl_softc->lun_list, links) {
4607 mtx_lock(&nlun->lun_lock);
4608 ctl_est_ua_all(nlun, -1, CTL_UA_LUN_CHANGE);
4609 mtx_unlock(&nlun->lun_lock);
4612 STAILQ_INSERT_TAIL(&ctl_softc->lun_list, lun, links);
4614 ctl_softc->ctl_luns[lun_number] = lun;
4616 ctl_softc->num_luns++;
4618 /* Setup statistics gathering */
4619 lun->stats.device_type = be_lun->lun_type;
4620 lun->stats.lun_number = lun_number;
4621 lun->stats.blocksize = be_lun->blocksize;
4622 if (be_lun->blocksize == 0)
4623 lun->stats.flags = CTL_LUN_STATS_NO_BLOCKSIZE;
4624 for (i = 0;i < CTL_MAX_PORTS;i++)
4625 lun->stats.ports[i].targ_port = i;
4627 mtx_unlock(&ctl_softc->ctl_lock);
4629 lun->be_lun->lun_config_status(lun->be_lun->be_lun, CTL_LUN_CONFIG_OK);
4636 * - LUN has already been marked invalid and any pending I/O has been taken
4640 ctl_free_lun(struct ctl_lun *lun)
4642 struct ctl_softc *softc;
4643 struct ctl_lun *nlun;
4646 softc = lun->ctl_softc;
4648 mtx_assert(&softc->ctl_lock, MA_OWNED);
4650 STAILQ_REMOVE(&softc->lun_list, lun, ctl_lun, links);
4652 ctl_clear_mask(softc->ctl_lun_mask, lun->lun);
4654 softc->ctl_luns[lun->lun] = NULL;
4656 if (!TAILQ_EMPTY(&lun->ooa_queue))
4657 panic("Freeing a LUN %p with outstanding I/O!!\n", lun);
4662 * Tell the backend to free resources, if this LUN has a backend.
4664 atomic_subtract_int(&lun->be_lun->be->num_luns, 1);
4665 lun->be_lun->lun_shutdown(lun->be_lun->be_lun);
4667 ctl_tpc_lun_shutdown(lun);
4668 mtx_destroy(&lun->lun_lock);
4669 free(lun->lun_devid, M_CTL);
4670 for (i = 0; i < CTL_MAX_PORTS; i++)
4671 free(lun->pending_ua[i], M_CTL);
4672 for (i = 0; i < CTL_MAX_PORTS; i++)
4673 free(lun->pr_keys[i], M_CTL);
4674 free(lun->write_buffer, M_CTL);
4675 if (lun->flags & CTL_LUN_MALLOCED)
4678 STAILQ_FOREACH(nlun, &softc->lun_list, links) {
4679 mtx_lock(&nlun->lun_lock);
4680 ctl_est_ua_all(nlun, -1, CTL_UA_LUN_CHANGE);
4681 mtx_unlock(&nlun->lun_lock);
4688 ctl_create_lun(struct ctl_be_lun *be_lun)
4692 * ctl_alloc_lun() should handle all potential failure cases.
4694 ctl_alloc_lun(control_softc, NULL, be_lun);
4698 ctl_add_lun(struct ctl_be_lun *be_lun)
4700 struct ctl_softc *softc = control_softc;
4702 mtx_lock(&softc->ctl_lock);
4703 STAILQ_INSERT_TAIL(&softc->pending_lun_queue, be_lun, links);
4704 mtx_unlock(&softc->ctl_lock);
4705 wakeup(&softc->pending_lun_queue);
4711 ctl_enable_lun(struct ctl_be_lun *be_lun)
4713 struct ctl_softc *softc;
4714 struct ctl_port *port, *nport;
4715 struct ctl_lun *lun;
4718 lun = (struct ctl_lun *)be_lun->ctl_lun;
4719 softc = lun->ctl_softc;
4721 mtx_lock(&softc->ctl_lock);
4722 mtx_lock(&lun->lun_lock);
4723 if ((lun->flags & CTL_LUN_DISABLED) == 0) {
4725 * eh? Why did we get called if the LUN is already
4728 mtx_unlock(&lun->lun_lock);
4729 mtx_unlock(&softc->ctl_lock);
4732 lun->flags &= ~CTL_LUN_DISABLED;
4733 mtx_unlock(&lun->lun_lock);
4735 STAILQ_FOREACH_SAFE(port, &softc->port_list, links, nport) {
4736 if ((port->status & CTL_PORT_STATUS_ONLINE) == 0 ||
4737 port->lun_map != NULL || port->lun_enable == NULL)
4741 * Drop the lock while we call the FETD's enable routine.
4742 * This can lead to a callback into CTL (at least in the
4743 * case of the internal initiator frontend.
4745 mtx_unlock(&softc->ctl_lock);
4746 retval = port->lun_enable(port->targ_lun_arg, lun->lun);
4747 mtx_lock(&softc->ctl_lock);
4749 printf("%s: FETD %s port %d returned error "
4750 "%d for lun_enable on lun %jd\n",
4751 __func__, port->port_name, port->targ_port,
4752 retval, (intmax_t)lun->lun);
4756 mtx_unlock(&softc->ctl_lock);
4757 ctl_isc_announce_lun(lun);
4763 ctl_disable_lun(struct ctl_be_lun *be_lun)
4765 struct ctl_softc *softc;
4766 struct ctl_port *port;
4767 struct ctl_lun *lun;
4770 lun = (struct ctl_lun *)be_lun->ctl_lun;
4771 softc = lun->ctl_softc;
4773 mtx_lock(&softc->ctl_lock);
4774 mtx_lock(&lun->lun_lock);
4775 if (lun->flags & CTL_LUN_DISABLED) {
4776 mtx_unlock(&lun->lun_lock);
4777 mtx_unlock(&softc->ctl_lock);
4780 lun->flags |= CTL_LUN_DISABLED;
4781 mtx_unlock(&lun->lun_lock);
4783 STAILQ_FOREACH(port, &softc->port_list, links) {
4784 if ((port->status & CTL_PORT_STATUS_ONLINE) == 0 ||
4785 port->lun_map != NULL || port->lun_disable == NULL)
4789 * Drop the lock before we call the frontend's disable
4790 * routine, to avoid lock order reversals.
4792 * XXX KDM what happens if the frontend list changes while
4793 * we're traversing it? It's unlikely, but should be handled.
4795 mtx_unlock(&softc->ctl_lock);
4796 retval = port->lun_disable(port->targ_lun_arg, lun->lun);
4797 mtx_lock(&softc->ctl_lock);
4799 printf("%s: FETD %s port %d returned error "
4800 "%d for lun_disable on lun %jd\n",
4801 __func__, port->port_name, port->targ_port,
4802 retval, (intmax_t)lun->lun);
4806 mtx_unlock(&softc->ctl_lock);
4807 ctl_isc_announce_lun(lun);
4813 ctl_start_lun(struct ctl_be_lun *be_lun)
4815 struct ctl_lun *lun = (struct ctl_lun *)be_lun->ctl_lun;
4817 mtx_lock(&lun->lun_lock);
4818 lun->flags &= ~CTL_LUN_STOPPED;
4819 mtx_unlock(&lun->lun_lock);
4824 ctl_stop_lun(struct ctl_be_lun *be_lun)
4826 struct ctl_lun *lun = (struct ctl_lun *)be_lun->ctl_lun;
4828 mtx_lock(&lun->lun_lock);
4829 lun->flags |= CTL_LUN_STOPPED;
4830 mtx_unlock(&lun->lun_lock);
4835 ctl_lun_no_media(struct ctl_be_lun *be_lun)
4837 struct ctl_lun *lun = (struct ctl_lun *)be_lun->ctl_lun;
4839 mtx_lock(&lun->lun_lock);
4840 lun->flags |= CTL_LUN_NO_MEDIA;
4841 mtx_unlock(&lun->lun_lock);
4846 ctl_lun_has_media(struct ctl_be_lun *be_lun)
4848 struct ctl_lun *lun = (struct ctl_lun *)be_lun->ctl_lun;
4849 union ctl_ha_msg msg;
4851 mtx_lock(&lun->lun_lock);
4852 lun->flags &= ~(CTL_LUN_NO_MEDIA | CTL_LUN_EJECTED);
4853 if (lun->flags & CTL_LUN_REMOVABLE)
4854 ctl_est_ua_all(lun, -1, CTL_UA_MEDIUM_CHANGE);
4855 mtx_unlock(&lun->lun_lock);
4856 if ((lun->flags & CTL_LUN_REMOVABLE) &&
4857 lun->ctl_softc->ha_mode == CTL_HA_MODE_XFER) {
4858 bzero(&msg.ua, sizeof(msg.ua));
4859 msg.hdr.msg_type = CTL_MSG_UA;
4860 msg.hdr.nexus.initid = -1;
4861 msg.hdr.nexus.targ_port = -1;
4862 msg.hdr.nexus.targ_lun = lun->lun;
4863 msg.hdr.nexus.targ_mapped_lun = lun->lun;
4866 msg.ua.ua_type = CTL_UA_MEDIUM_CHANGE;
4867 ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg, sizeof(msg.ua),
4874 ctl_lun_ejected(struct ctl_be_lun *be_lun)
4876 struct ctl_lun *lun = (struct ctl_lun *)be_lun->ctl_lun;
4878 mtx_lock(&lun->lun_lock);
4879 lun->flags |= CTL_LUN_EJECTED;
4880 mtx_unlock(&lun->lun_lock);
4885 ctl_lun_primary(struct ctl_be_lun *be_lun)
4887 struct ctl_lun *lun = (struct ctl_lun *)be_lun->ctl_lun;
4889 mtx_lock(&lun->lun_lock);
4890 lun->flags |= CTL_LUN_PRIMARY_SC;
4891 ctl_est_ua_all(lun, -1, CTL_UA_ASYM_ACC_CHANGE);
4892 mtx_unlock(&lun->lun_lock);
4893 ctl_isc_announce_lun(lun);
4898 ctl_lun_secondary(struct ctl_be_lun *be_lun)
4900 struct ctl_lun *lun = (struct ctl_lun *)be_lun->ctl_lun;
4902 mtx_lock(&lun->lun_lock);
4903 lun->flags &= ~CTL_LUN_PRIMARY_SC;
4904 ctl_est_ua_all(lun, -1, CTL_UA_ASYM_ACC_CHANGE);
4905 mtx_unlock(&lun->lun_lock);
4906 ctl_isc_announce_lun(lun);
4911 ctl_invalidate_lun(struct ctl_be_lun *be_lun)
4913 struct ctl_softc *softc;
4914 struct ctl_lun *lun;
4916 lun = (struct ctl_lun *)be_lun->ctl_lun;
4917 softc = lun->ctl_softc;
4919 mtx_lock(&lun->lun_lock);
4922 * The LUN needs to be disabled before it can be marked invalid.
4924 if ((lun->flags & CTL_LUN_DISABLED) == 0) {
4925 mtx_unlock(&lun->lun_lock);
4929 * Mark the LUN invalid.
4931 lun->flags |= CTL_LUN_INVALID;
4934 * If there is nothing in the OOA queue, go ahead and free the LUN.
4935 * If we have something in the OOA queue, we'll free it when the
4936 * last I/O completes.
4938 if (TAILQ_EMPTY(&lun->ooa_queue)) {
4939 mtx_unlock(&lun->lun_lock);
4940 mtx_lock(&softc->ctl_lock);
4942 mtx_unlock(&softc->ctl_lock);
4944 mtx_unlock(&lun->lun_lock);
4950 ctl_lun_capacity_changed(struct ctl_be_lun *be_lun)
4952 struct ctl_lun *lun = (struct ctl_lun *)be_lun->ctl_lun;
4953 union ctl_ha_msg msg;
4955 mtx_lock(&lun->lun_lock);
4956 ctl_est_ua_all(lun, -1, CTL_UA_CAPACITY_CHANGE);
4957 mtx_unlock(&lun->lun_lock);
4958 if (lun->ctl_softc->ha_mode == CTL_HA_MODE_XFER) {
4959 /* Send msg to other side. */
4960 bzero(&msg.ua, sizeof(msg.ua));
4961 msg.hdr.msg_type = CTL_MSG_UA;
4962 msg.hdr.nexus.initid = -1;
4963 msg.hdr.nexus.targ_port = -1;
4964 msg.hdr.nexus.targ_lun = lun->lun;
4965 msg.hdr.nexus.targ_mapped_lun = lun->lun;
4968 msg.ua.ua_type = CTL_UA_CAPACITY_CHANGE;
4969 ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg, sizeof(msg.ua),
4975 * Backend "memory move is complete" callback for requests that never
4976 * make it down to say RAIDCore's configuration code.
4979 ctl_config_move_done(union ctl_io *io)
4983 CTL_DEBUG_PRINT(("ctl_config_move_done\n"));
4984 KASSERT(io->io_hdr.io_type == CTL_IO_SCSI,
4985 ("Config I/O type isn't CTL_IO_SCSI (%d)!", io->io_hdr.io_type));
4987 if ((io->io_hdr.port_status != 0) &&
4988 ((io->io_hdr.status & CTL_STATUS_MASK) == CTL_STATUS_NONE ||
4989 (io->io_hdr.status & CTL_STATUS_MASK) == CTL_SUCCESS)) {
4991 * For hardware error sense keys, the sense key
4992 * specific value is defined to be a retry count,
4993 * but we use it to pass back an internal FETD
4994 * error code. XXX KDM Hopefully the FETD is only
4995 * using 16 bits for an error code, since that's
4996 * all the space we have in the sks field.
4998 ctl_set_internal_failure(&io->scsiio,
5001 io->io_hdr.port_status);
5004 if (ctl_debug & CTL_DEBUG_CDB_DATA)
5006 if (((io->io_hdr.flags & CTL_FLAG_DATA_MASK) == CTL_FLAG_DATA_IN) ||
5007 ((io->io_hdr.status & CTL_STATUS_MASK) != CTL_STATUS_NONE &&
5008 (io->io_hdr.status & CTL_STATUS_MASK) != CTL_SUCCESS) ||
5009 ((io->io_hdr.flags & CTL_FLAG_ABORT) != 0)) {
5011 * XXX KDM just assuming a single pointer here, and not a
5012 * S/G list. If we start using S/G lists for config data,
5013 * we'll need to know how to clean them up here as well.
5015 if (io->io_hdr.flags & CTL_FLAG_ALLOCATED)
5016 free(io->scsiio.kern_data_ptr, M_CTL);
5018 retval = CTL_RETVAL_COMPLETE;
5021 * XXX KDM now we need to continue data movement. Some
5023 * - call ctl_scsiio() again? We don't do this for data
5024 * writes, because for those at least we know ahead of
5025 * time where the write will go and how long it is. For
5026 * config writes, though, that information is largely
5027 * contained within the write itself, thus we need to
5028 * parse out the data again.
5030 * - Call some other function once the data is in?
5034 * XXX KDM call ctl_scsiio() again for now, and check flag
5035 * bits to see whether we're allocated or not.
5037 retval = ctl_scsiio(&io->scsiio);
5043 * This gets called by a backend driver when it is done with a
5044 * data_submit method.
5047 ctl_data_submit_done(union ctl_io *io)
5050 * If the IO_CONT flag is set, we need to call the supplied
5051 * function to continue processing the I/O, instead of completing
5054 * If there is an error, though, we don't want to keep processing.
5055 * Instead, just send status back to the initiator.
5057 if ((io->io_hdr.flags & CTL_FLAG_IO_CONT) &&
5058 (io->io_hdr.flags & CTL_FLAG_ABORT) == 0 &&
5059 ((io->io_hdr.status & CTL_STATUS_MASK) == CTL_STATUS_NONE ||
5060 (io->io_hdr.status & CTL_STATUS_MASK) == CTL_SUCCESS)) {
5061 io->scsiio.io_cont(io);
5068 * This gets called by a backend driver when it is done with a
5069 * configuration write.
5072 ctl_config_write_done(union ctl_io *io)
5077 * If the IO_CONT flag is set, we need to call the supplied
5078 * function to continue processing the I/O, instead of completing
5081 * If there is an error, though, we don't want to keep processing.
5082 * Instead, just send status back to the initiator.
5084 if ((io->io_hdr.flags & CTL_FLAG_IO_CONT) &&
5085 (io->io_hdr.flags & CTL_FLAG_ABORT) == 0 &&
5086 ((io->io_hdr.status & CTL_STATUS_MASK) == CTL_STATUS_NONE ||
5087 (io->io_hdr.status & CTL_STATUS_MASK) == CTL_SUCCESS)) {
5088 io->scsiio.io_cont(io);
5092 * Since a configuration write can be done for commands that actually
5093 * have data allocated, like write buffer, and commands that have
5094 * no data, like start/stop unit, we need to check here.
5096 if (io->io_hdr.flags & CTL_FLAG_ALLOCATED)
5097 buf = io->scsiio.kern_data_ptr;
5106 ctl_config_read_done(union ctl_io *io)
5111 * If there is some error -- we are done, skip data transfer.
5113 if ((io->io_hdr.flags & CTL_FLAG_ABORT) != 0 ||
5114 ((io->io_hdr.status & CTL_STATUS_MASK) != CTL_STATUS_NONE &&
5115 (io->io_hdr.status & CTL_STATUS_MASK) != CTL_SUCCESS)) {
5116 if (io->io_hdr.flags & CTL_FLAG_ALLOCATED)
5117 buf = io->scsiio.kern_data_ptr;
5127 * If the IO_CONT flag is set, we need to call the supplied
5128 * function to continue processing the I/O, instead of completing
5131 if (io->io_hdr.flags & CTL_FLAG_IO_CONT) {
5132 io->scsiio.io_cont(io);
5140 * SCSI release command.
5143 ctl_scsi_release(struct ctl_scsiio *ctsio)
5145 struct ctl_lun *lun;
5148 CTL_DEBUG_PRINT(("ctl_scsi_release\n"));
5150 residx = ctl_get_initindex(&ctsio->io_hdr.nexus);
5151 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5154 * XXX KDM right now, we only support LUN reservation. We don't
5155 * support 3rd party reservations, or extent reservations, which
5156 * might actually need the parameter list. If we've gotten this
5157 * far, we've got a LUN reservation. Anything else got kicked out
5158 * above. So, according to SPC, ignore the length.
5161 mtx_lock(&lun->lun_lock);
5164 * According to SPC, it is not an error for an intiator to attempt
5165 * to release a reservation on a LUN that isn't reserved, or that
5166 * is reserved by another initiator. The reservation can only be
5167 * released, though, by the initiator who made it or by one of
5168 * several reset type events.
5170 if ((lun->flags & CTL_LUN_RESERVED) && (lun->res_idx == residx))
5171 lun->flags &= ~CTL_LUN_RESERVED;
5173 mtx_unlock(&lun->lun_lock);
5175 ctl_set_success(ctsio);
5176 ctl_done((union ctl_io *)ctsio);
5177 return (CTL_RETVAL_COMPLETE);
5181 ctl_scsi_reserve(struct ctl_scsiio *ctsio)
5183 struct ctl_lun *lun;
5186 CTL_DEBUG_PRINT(("ctl_reserve\n"));
5188 residx = ctl_get_initindex(&ctsio->io_hdr.nexus);
5189 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5192 * XXX KDM right now, we only support LUN reservation. We don't
5193 * support 3rd party reservations, or extent reservations, which
5194 * might actually need the parameter list. If we've gotten this
5195 * far, we've got a LUN reservation. Anything else got kicked out
5196 * above. So, according to SPC, ignore the length.
5199 mtx_lock(&lun->lun_lock);
5200 if ((lun->flags & CTL_LUN_RESERVED) && (lun->res_idx != residx)) {
5201 ctl_set_reservation_conflict(ctsio);
5205 /* SPC-3 exceptions to SPC-2 RESERVE and RELEASE behavior. */
5206 if (lun->flags & CTL_LUN_PR_RESERVED) {
5207 ctl_set_success(ctsio);
5211 lun->flags |= CTL_LUN_RESERVED;
5212 lun->res_idx = residx;
5213 ctl_set_success(ctsio);
5216 mtx_unlock(&lun->lun_lock);
5217 ctl_done((union ctl_io *)ctsio);
5218 return (CTL_RETVAL_COMPLETE);
5222 ctl_start_stop(struct ctl_scsiio *ctsio)
5224 struct scsi_start_stop_unit *cdb;
5225 struct ctl_lun *lun;
5228 CTL_DEBUG_PRINT(("ctl_start_stop\n"));
5230 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5231 cdb = (struct scsi_start_stop_unit *)ctsio->cdb;
5233 if ((cdb->how & SSS_PC_MASK) == 0) {
5234 if ((lun->flags & CTL_LUN_PR_RESERVED) &&
5235 (cdb->how & SSS_START) == 0) {
5238 residx = ctl_get_initindex(&ctsio->io_hdr.nexus);
5239 if (ctl_get_prkey(lun, residx) == 0 ||
5240 (lun->pr_res_idx != residx && lun->pr_res_type < 4)) {
5242 ctl_set_reservation_conflict(ctsio);
5243 ctl_done((union ctl_io *)ctsio);
5244 return (CTL_RETVAL_COMPLETE);
5248 if ((cdb->how & SSS_LOEJ) &&
5249 (lun->flags & CTL_LUN_REMOVABLE) == 0) {
5250 ctl_set_invalid_field(ctsio,
5256 ctl_done((union ctl_io *)ctsio);
5257 return (CTL_RETVAL_COMPLETE);
5260 if ((cdb->how & SSS_START) == 0 && (cdb->how & SSS_LOEJ) &&
5261 lun->prevent_count > 0) {
5262 /* "Medium removal prevented" */
5263 ctl_set_sense(ctsio, /*current_error*/ 1,
5264 /*sense_key*/(lun->flags & CTL_LUN_NO_MEDIA) ?
5265 SSD_KEY_NOT_READY : SSD_KEY_ILLEGAL_REQUEST,
5266 /*asc*/ 0x53, /*ascq*/ 0x02, SSD_ELEM_NONE);
5267 ctl_done((union ctl_io *)ctsio);
5268 return (CTL_RETVAL_COMPLETE);
5272 retval = lun->backend->config_write((union ctl_io *)ctsio);
5277 ctl_prevent_allow(struct ctl_scsiio *ctsio)
5279 struct ctl_lun *lun;
5280 struct scsi_prevent *cdb;
5284 CTL_DEBUG_PRINT(("ctl_prevent_allow\n"));
5286 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5287 cdb = (struct scsi_prevent *)ctsio->cdb;
5289 if ((lun->flags & CTL_LUN_REMOVABLE) == 0) {
5290 ctl_set_invalid_opcode(ctsio);
5291 ctl_done((union ctl_io *)ctsio);
5292 return (CTL_RETVAL_COMPLETE);
5295 initidx = ctl_get_initindex(&ctsio->io_hdr.nexus);
5296 mtx_lock(&lun->lun_lock);
5297 if ((cdb->how & PR_PREVENT) &&
5298 ctl_is_set(lun->prevent, initidx) == 0) {
5299 ctl_set_mask(lun->prevent, initidx);
5300 lun->prevent_count++;
5301 } else if ((cdb->how & PR_PREVENT) == 0 &&
5302 ctl_is_set(lun->prevent, initidx)) {
5303 ctl_clear_mask(lun->prevent, initidx);
5304 lun->prevent_count--;
5306 mtx_unlock(&lun->lun_lock);
5307 retval = lun->backend->config_write((union ctl_io *)ctsio);
5312 * We support the SYNCHRONIZE CACHE command (10 and 16 byte versions), but
5313 * we don't really do anything with the LBA and length fields if the user
5314 * passes them in. Instead we'll just flush out the cache for the entire
5318 ctl_sync_cache(struct ctl_scsiio *ctsio)
5320 struct ctl_lun *lun;
5321 struct ctl_softc *softc;
5322 struct ctl_lba_len_flags *lbalen;
5323 uint64_t starting_lba;
5324 uint32_t block_count;
5328 CTL_DEBUG_PRINT(("ctl_sync_cache\n"));
5330 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5331 softc = lun->ctl_softc;
5334 switch (ctsio->cdb[0]) {
5335 case SYNCHRONIZE_CACHE: {
5336 struct scsi_sync_cache *cdb;
5337 cdb = (struct scsi_sync_cache *)ctsio->cdb;
5339 starting_lba = scsi_4btoul(cdb->begin_lba);
5340 block_count = scsi_2btoul(cdb->lb_count);
5344 case SYNCHRONIZE_CACHE_16: {
5345 struct scsi_sync_cache_16 *cdb;
5346 cdb = (struct scsi_sync_cache_16 *)ctsio->cdb;
5348 starting_lba = scsi_8btou64(cdb->begin_lba);
5349 block_count = scsi_4btoul(cdb->lb_count);
5354 ctl_set_invalid_opcode(ctsio);
5355 ctl_done((union ctl_io *)ctsio);
5357 break; /* NOTREACHED */
5361 * We check the LBA and length, but don't do anything with them.
5362 * A SYNCHRONIZE CACHE will cause the entire cache for this lun to
5363 * get flushed. This check will just help satisfy anyone who wants
5364 * to see an error for an out of range LBA.
5366 if ((starting_lba + block_count) > (lun->be_lun->maxlba + 1)) {
5367 ctl_set_lba_out_of_range(ctsio);
5368 ctl_done((union ctl_io *)ctsio);
5372 lbalen = (struct ctl_lba_len_flags *)&ctsio->io_hdr.ctl_private[CTL_PRIV_LBA_LEN];
5373 lbalen->lba = starting_lba;
5374 lbalen->len = block_count;
5375 lbalen->flags = byte2;
5376 retval = lun->backend->config_write((union ctl_io *)ctsio);
5383 ctl_format(struct ctl_scsiio *ctsio)
5385 struct scsi_format *cdb;
5386 struct ctl_lun *lun;
5387 int length, defect_list_len;
5389 CTL_DEBUG_PRINT(("ctl_format\n"));
5391 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5393 cdb = (struct scsi_format *)ctsio->cdb;
5396 if (cdb->byte2 & SF_FMTDATA) {
5397 if (cdb->byte2 & SF_LONGLIST)
5398 length = sizeof(struct scsi_format_header_long);
5400 length = sizeof(struct scsi_format_header_short);
5403 if (((ctsio->io_hdr.flags & CTL_FLAG_ALLOCATED) == 0)
5405 ctsio->kern_data_ptr = malloc(length, M_CTL, M_WAITOK);
5406 ctsio->kern_data_len = length;
5407 ctsio->kern_total_len = length;
5408 ctsio->kern_data_resid = 0;
5409 ctsio->kern_rel_offset = 0;
5410 ctsio->kern_sg_entries = 0;
5411 ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
5412 ctsio->be_move_done = ctl_config_move_done;
5413 ctl_datamove((union ctl_io *)ctsio);
5415 return (CTL_RETVAL_COMPLETE);
5418 defect_list_len = 0;
5420 if (cdb->byte2 & SF_FMTDATA) {
5421 if (cdb->byte2 & SF_LONGLIST) {
5422 struct scsi_format_header_long *header;
5424 header = (struct scsi_format_header_long *)
5425 ctsio->kern_data_ptr;
5427 defect_list_len = scsi_4btoul(header->defect_list_len);
5428 if (defect_list_len != 0) {
5429 ctl_set_invalid_field(ctsio,
5438 struct scsi_format_header_short *header;
5440 header = (struct scsi_format_header_short *)
5441 ctsio->kern_data_ptr;
5443 defect_list_len = scsi_2btoul(header->defect_list_len);
5444 if (defect_list_len != 0) {
5445 ctl_set_invalid_field(ctsio,
5456 ctl_set_success(ctsio);
5459 if (ctsio->io_hdr.flags & CTL_FLAG_ALLOCATED) {
5460 free(ctsio->kern_data_ptr, M_CTL);
5461 ctsio->io_hdr.flags &= ~CTL_FLAG_ALLOCATED;
5464 ctl_done((union ctl_io *)ctsio);
5465 return (CTL_RETVAL_COMPLETE);
5469 ctl_read_buffer(struct ctl_scsiio *ctsio)
5471 struct ctl_lun *lun;
5472 uint64_t buffer_offset;
5475 static uint8_t descr[4];
5476 static uint8_t echo_descr[4] = { 0 };
5478 CTL_DEBUG_PRINT(("ctl_read_buffer\n"));
5479 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5480 switch (ctsio->cdb[0]) {
5482 struct scsi_read_buffer *cdb;
5484 cdb = (struct scsi_read_buffer *)ctsio->cdb;
5485 buffer_offset = scsi_3btoul(cdb->offset);
5486 len = scsi_3btoul(cdb->length);
5490 case READ_BUFFER_16: {
5491 struct scsi_read_buffer_16 *cdb;
5493 cdb = (struct scsi_read_buffer_16 *)ctsio->cdb;
5494 buffer_offset = scsi_8btou64(cdb->offset);
5495 len = scsi_4btoul(cdb->length);
5499 default: /* This shouldn't happen. */
5500 ctl_set_invalid_opcode(ctsio);
5501 ctl_done((union ctl_io *)ctsio);
5502 return (CTL_RETVAL_COMPLETE);
5505 if ((byte2 & RWB_MODE) != RWB_MODE_DATA &&
5506 (byte2 & RWB_MODE) != RWB_MODE_ECHO_DESCR &&
5507 (byte2 & RWB_MODE) != RWB_MODE_DESCR) {
5508 ctl_set_invalid_field(ctsio,
5514 ctl_done((union ctl_io *)ctsio);
5515 return (CTL_RETVAL_COMPLETE);
5518 if (buffer_offset > CTL_WRITE_BUFFER_SIZE ||
5519 buffer_offset + len > CTL_WRITE_BUFFER_SIZE) {
5520 ctl_set_invalid_field(ctsio,
5526 ctl_done((union ctl_io *)ctsio);
5527 return (CTL_RETVAL_COMPLETE);
5530 if ((byte2 & RWB_MODE) == RWB_MODE_DESCR) {
5532 scsi_ulto3b(CTL_WRITE_BUFFER_SIZE, &descr[1]);
5533 ctsio->kern_data_ptr = descr;
5534 len = min(len, sizeof(descr));
5535 } else if ((byte2 & RWB_MODE) == RWB_MODE_ECHO_DESCR) {
5536 ctsio->kern_data_ptr = echo_descr;
5537 len = min(len, sizeof(echo_descr));
5539 if (lun->write_buffer == NULL) {
5540 lun->write_buffer = malloc(CTL_WRITE_BUFFER_SIZE,
5543 ctsio->kern_data_ptr = lun->write_buffer + buffer_offset;
5545 ctsio->kern_data_len = len;
5546 ctsio->kern_total_len = len;
5547 ctsio->kern_data_resid = 0;
5548 ctsio->kern_rel_offset = 0;
5549 ctsio->kern_sg_entries = 0;
5550 ctl_set_success(ctsio);
5551 ctsio->be_move_done = ctl_config_move_done;
5552 ctl_datamove((union ctl_io *)ctsio);
5553 return (CTL_RETVAL_COMPLETE);
5557 ctl_write_buffer(struct ctl_scsiio *ctsio)
5559 struct scsi_write_buffer *cdb;
5560 struct ctl_lun *lun;
5561 int buffer_offset, len;
5563 CTL_DEBUG_PRINT(("ctl_write_buffer\n"));
5565 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5566 cdb = (struct scsi_write_buffer *)ctsio->cdb;
5568 if ((cdb->byte2 & RWB_MODE) != RWB_MODE_DATA) {
5569 ctl_set_invalid_field(ctsio,
5575 ctl_done((union ctl_io *)ctsio);
5576 return (CTL_RETVAL_COMPLETE);
5579 len = scsi_3btoul(cdb->length);
5580 buffer_offset = scsi_3btoul(cdb->offset);
5582 if (buffer_offset + len > CTL_WRITE_BUFFER_SIZE) {
5583 ctl_set_invalid_field(ctsio,
5589 ctl_done((union ctl_io *)ctsio);
5590 return (CTL_RETVAL_COMPLETE);
5594 * If we've got a kernel request that hasn't been malloced yet,
5595 * malloc it and tell the caller the data buffer is here.
5597 if ((ctsio->io_hdr.flags & CTL_FLAG_ALLOCATED) == 0) {
5598 if (lun->write_buffer == NULL) {
5599 lun->write_buffer = malloc(CTL_WRITE_BUFFER_SIZE,
5602 ctsio->kern_data_ptr = lun->write_buffer + buffer_offset;
5603 ctsio->kern_data_len = len;
5604 ctsio->kern_total_len = len;
5605 ctsio->kern_data_resid = 0;
5606 ctsio->kern_rel_offset = 0;
5607 ctsio->kern_sg_entries = 0;
5608 ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
5609 ctsio->be_move_done = ctl_config_move_done;
5610 ctl_datamove((union ctl_io *)ctsio);
5612 return (CTL_RETVAL_COMPLETE);
5615 ctl_set_success(ctsio);
5616 ctl_done((union ctl_io *)ctsio);
5617 return (CTL_RETVAL_COMPLETE);
5621 ctl_write_same(struct ctl_scsiio *ctsio)
5623 struct ctl_lun *lun;
5624 struct ctl_lba_len_flags *lbalen;
5626 uint32_t num_blocks;
5630 CTL_DEBUG_PRINT(("ctl_write_same\n"));
5632 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5634 switch (ctsio->cdb[0]) {
5635 case WRITE_SAME_10: {
5636 struct scsi_write_same_10 *cdb;
5638 cdb = (struct scsi_write_same_10 *)ctsio->cdb;
5640 lba = scsi_4btoul(cdb->addr);
5641 num_blocks = scsi_2btoul(cdb->length);
5645 case WRITE_SAME_16: {
5646 struct scsi_write_same_16 *cdb;
5648 cdb = (struct scsi_write_same_16 *)ctsio->cdb;
5650 lba = scsi_8btou64(cdb->addr);
5651 num_blocks = scsi_4btoul(cdb->length);
5657 * We got a command we don't support. This shouldn't
5658 * happen, commands should be filtered out above us.
5660 ctl_set_invalid_opcode(ctsio);
5661 ctl_done((union ctl_io *)ctsio);
5663 return (CTL_RETVAL_COMPLETE);
5664 break; /* NOTREACHED */
5667 /* ANCHOR flag can be used only together with UNMAP */
5668 if ((byte2 & SWS_UNMAP) == 0 && (byte2 & SWS_ANCHOR) != 0) {
5669 ctl_set_invalid_field(ctsio, /*sks_valid*/ 1,
5670 /*command*/ 1, /*field*/ 1, /*bit_valid*/ 1, /*bit*/ 0);
5671 ctl_done((union ctl_io *)ctsio);
5672 return (CTL_RETVAL_COMPLETE);
5676 * The first check is to make sure we're in bounds, the second
5677 * check is to catch wrap-around problems. If the lba + num blocks
5678 * is less than the lba, then we've wrapped around and the block
5679 * range is invalid anyway.
5681 if (((lba + num_blocks) > (lun->be_lun->maxlba + 1))
5682 || ((lba + num_blocks) < lba)) {
5683 ctl_set_lba_out_of_range(ctsio);
5684 ctl_done((union ctl_io *)ctsio);
5685 return (CTL_RETVAL_COMPLETE);
5688 /* Zero number of blocks means "to the last logical block" */
5689 if (num_blocks == 0) {
5690 if ((lun->be_lun->maxlba + 1) - lba > UINT32_MAX) {
5691 ctl_set_invalid_field(ctsio,
5697 ctl_done((union ctl_io *)ctsio);
5698 return (CTL_RETVAL_COMPLETE);
5700 num_blocks = (lun->be_lun->maxlba + 1) - lba;
5703 len = lun->be_lun->blocksize;
5706 * If we've got a kernel request that hasn't been malloced yet,
5707 * malloc it and tell the caller the data buffer is here.
5709 if ((byte2 & SWS_NDOB) == 0 &&
5710 (ctsio->io_hdr.flags & CTL_FLAG_ALLOCATED) == 0) {
5711 ctsio->kern_data_ptr = malloc(len, M_CTL, M_WAITOK);
5712 ctsio->kern_data_len = len;
5713 ctsio->kern_total_len = len;
5714 ctsio->kern_data_resid = 0;
5715 ctsio->kern_rel_offset = 0;
5716 ctsio->kern_sg_entries = 0;
5717 ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
5718 ctsio->be_move_done = ctl_config_move_done;
5719 ctl_datamove((union ctl_io *)ctsio);
5721 return (CTL_RETVAL_COMPLETE);
5724 lbalen = (struct ctl_lba_len_flags *)&ctsio->io_hdr.ctl_private[CTL_PRIV_LBA_LEN];
5726 lbalen->len = num_blocks;
5727 lbalen->flags = byte2;
5728 retval = lun->backend->config_write((union ctl_io *)ctsio);
5734 ctl_unmap(struct ctl_scsiio *ctsio)
5736 struct ctl_lun *lun;
5737 struct scsi_unmap *cdb;
5738 struct ctl_ptr_len_flags *ptrlen;
5739 struct scsi_unmap_header *hdr;
5740 struct scsi_unmap_desc *buf, *end, *endnz, *range;
5742 uint32_t num_blocks;
5746 CTL_DEBUG_PRINT(("ctl_unmap\n"));
5748 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5749 cdb = (struct scsi_unmap *)ctsio->cdb;
5751 len = scsi_2btoul(cdb->length);
5755 * If we've got a kernel request that hasn't been malloced yet,
5756 * malloc it and tell the caller the data buffer is here.
5758 if ((ctsio->io_hdr.flags & CTL_FLAG_ALLOCATED) == 0) {
5759 ctsio->kern_data_ptr = malloc(len, M_CTL, M_WAITOK);
5760 ctsio->kern_data_len = len;
5761 ctsio->kern_total_len = len;
5762 ctsio->kern_data_resid = 0;
5763 ctsio->kern_rel_offset = 0;
5764 ctsio->kern_sg_entries = 0;
5765 ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
5766 ctsio->be_move_done = ctl_config_move_done;
5767 ctl_datamove((union ctl_io *)ctsio);
5769 return (CTL_RETVAL_COMPLETE);
5772 len = ctsio->kern_total_len - ctsio->kern_data_resid;
5773 hdr = (struct scsi_unmap_header *)ctsio->kern_data_ptr;
5774 if (len < sizeof (*hdr) ||
5775 len < (scsi_2btoul(hdr->length) + sizeof(hdr->length)) ||
5776 len < (scsi_2btoul(hdr->desc_length) + sizeof (*hdr)) ||
5777 scsi_2btoul(hdr->desc_length) % sizeof(*buf) != 0) {
5778 ctl_set_invalid_field(ctsio,
5786 len = scsi_2btoul(hdr->desc_length);
5787 buf = (struct scsi_unmap_desc *)(hdr + 1);
5788 end = buf + len / sizeof(*buf);
5791 for (range = buf; range < end; range++) {
5792 lba = scsi_8btou64(range->lba);
5793 num_blocks = scsi_4btoul(range->length);
5794 if (((lba + num_blocks) > (lun->be_lun->maxlba + 1))
5795 || ((lba + num_blocks) < lba)) {
5796 ctl_set_lba_out_of_range(ctsio);
5797 ctl_done((union ctl_io *)ctsio);
5798 return (CTL_RETVAL_COMPLETE);
5800 if (num_blocks != 0)
5805 * Block backend can not handle zero last range.
5806 * Filter it out and return if there is nothing left.
5808 len = (uint8_t *)endnz - (uint8_t *)buf;
5810 ctl_set_success(ctsio);
5814 mtx_lock(&lun->lun_lock);
5815 ptrlen = (struct ctl_ptr_len_flags *)
5816 &ctsio->io_hdr.ctl_private[CTL_PRIV_LBA_LEN];
5817 ptrlen->ptr = (void *)buf;
5819 ptrlen->flags = byte2;
5820 ctl_check_blocked(lun);
5821 mtx_unlock(&lun->lun_lock);
5823 retval = lun->backend->config_write((union ctl_io *)ctsio);
5827 if (ctsio->io_hdr.flags & CTL_FLAG_ALLOCATED) {
5828 free(ctsio->kern_data_ptr, M_CTL);
5829 ctsio->io_hdr.flags &= ~CTL_FLAG_ALLOCATED;
5831 ctl_done((union ctl_io *)ctsio);
5832 return (CTL_RETVAL_COMPLETE);
5836 * Note that this function currently doesn't actually do anything inside
5837 * CTL to enforce things if the DQue bit is turned on.
5839 * Also note that this function can't be used in the default case, because
5840 * the DQue bit isn't set in the changeable mask for the control mode page
5841 * anyway. This is just here as an example for how to implement a page
5842 * handler, and a placeholder in case we want to allow the user to turn
5843 * tagged queueing on and off.
5845 * The D_SENSE bit handling is functional, however, and will turn
5846 * descriptor sense on and off for a given LUN.
5849 ctl_control_page_handler(struct ctl_scsiio *ctsio,
5850 struct ctl_page_index *page_index, uint8_t *page_ptr)
5852 struct scsi_control_page *current_cp, *saved_cp, *user_cp;
5853 struct ctl_lun *lun;
5857 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5858 initidx = ctl_get_initindex(&ctsio->io_hdr.nexus);
5861 user_cp = (struct scsi_control_page *)page_ptr;
5862 current_cp = (struct scsi_control_page *)
5863 (page_index->page_data + (page_index->page_len *
5865 saved_cp = (struct scsi_control_page *)
5866 (page_index->page_data + (page_index->page_len *
5869 mtx_lock(&lun->lun_lock);
5870 if (((current_cp->rlec & SCP_DSENSE) == 0)
5871 && ((user_cp->rlec & SCP_DSENSE) != 0)) {
5873 * Descriptor sense is currently turned off and the user
5874 * wants to turn it on.
5876 current_cp->rlec |= SCP_DSENSE;
5877 saved_cp->rlec |= SCP_DSENSE;
5878 lun->flags |= CTL_LUN_SENSE_DESC;
5880 } else if (((current_cp->rlec & SCP_DSENSE) != 0)
5881 && ((user_cp->rlec & SCP_DSENSE) == 0)) {
5883 * Descriptor sense is currently turned on, and the user
5884 * wants to turn it off.
5886 current_cp->rlec &= ~SCP_DSENSE;
5887 saved_cp->rlec &= ~SCP_DSENSE;
5888 lun->flags &= ~CTL_LUN_SENSE_DESC;
5891 if ((current_cp->queue_flags & SCP_QUEUE_ALG_MASK) !=
5892 (user_cp->queue_flags & SCP_QUEUE_ALG_MASK)) {
5893 current_cp->queue_flags &= ~SCP_QUEUE_ALG_MASK;
5894 current_cp->queue_flags |= user_cp->queue_flags & SCP_QUEUE_ALG_MASK;
5895 saved_cp->queue_flags &= ~SCP_QUEUE_ALG_MASK;
5896 saved_cp->queue_flags |= user_cp->queue_flags & SCP_QUEUE_ALG_MASK;
5899 if ((current_cp->eca_and_aen & SCP_SWP) !=
5900 (user_cp->eca_and_aen & SCP_SWP)) {
5901 current_cp->eca_and_aen &= ~SCP_SWP;
5902 current_cp->eca_and_aen |= user_cp->eca_and_aen & SCP_SWP;
5903 saved_cp->eca_and_aen &= ~SCP_SWP;
5904 saved_cp->eca_and_aen |= user_cp->eca_and_aen & SCP_SWP;
5908 ctl_est_ua_all(lun, initidx, CTL_UA_MODE_CHANGE);
5909 mtx_unlock(&lun->lun_lock);
5911 ctl_isc_announce_mode(lun,
5912 ctl_get_initindex(&ctsio->io_hdr.nexus),
5913 page_index->page_code, page_index->subpage);
5919 ctl_caching_sp_handler(struct ctl_scsiio *ctsio,
5920 struct ctl_page_index *page_index, uint8_t *page_ptr)
5922 struct scsi_caching_page *current_cp, *saved_cp, *user_cp;
5923 struct ctl_lun *lun;
5927 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
5928 initidx = ctl_get_initindex(&ctsio->io_hdr.nexus);
5931 user_cp = (struct scsi_caching_page *)page_ptr;
5932 current_cp = (struct scsi_caching_page *)
5933 (page_index->page_data + (page_index->page_len *
5935 saved_cp = (struct scsi_caching_page *)
5936 (page_index->page_data + (page_index->page_len *
5939 mtx_lock(&lun->lun_lock);
5940 if ((current_cp->flags1 & (SCP_WCE | SCP_RCD)) !=
5941 (user_cp->flags1 & (SCP_WCE | SCP_RCD))) {
5942 current_cp->flags1 &= ~(SCP_WCE | SCP_RCD);
5943 current_cp->flags1 |= user_cp->flags1 & (SCP_WCE | SCP_RCD);
5944 saved_cp->flags1 &= ~(SCP_WCE | SCP_RCD);
5945 saved_cp->flags1 |= user_cp->flags1 & (SCP_WCE | SCP_RCD);
5949 ctl_est_ua_all(lun, initidx, CTL_UA_MODE_CHANGE);
5950 mtx_unlock(&lun->lun_lock);
5952 ctl_isc_announce_mode(lun,
5953 ctl_get_initindex(&ctsio->io_hdr.nexus),
5954 page_index->page_code, page_index->subpage);
5960 ctl_debugconf_sp_select_handler(struct ctl_scsiio *ctsio,
5961 struct ctl_page_index *page_index,
5967 c = ((struct copan_debugconf_subpage *)page_ptr)->ctl_time_io_secs;
5972 CTL_DEBUG_PRINT(("set ctl_time_io_secs to %d\n", ctl_time_io_secs));
5973 printf("set ctl_time_io_secs to %d\n", ctl_time_io_secs);
5974 printf("page data:");
5976 printf(" %.2x",page_ptr[i]);
5982 ctl_debugconf_sp_sense_handler(struct ctl_scsiio *ctsio,
5983 struct ctl_page_index *page_index,
5986 struct copan_debugconf_subpage *page;
5988 page = (struct copan_debugconf_subpage *)page_index->page_data +
5989 (page_index->page_len * pc);
5992 case SMS_PAGE_CTRL_CHANGEABLE >> 6:
5993 case SMS_PAGE_CTRL_DEFAULT >> 6:
5994 case SMS_PAGE_CTRL_SAVED >> 6:
5996 * We don't update the changeable or default bits for this page.
5999 case SMS_PAGE_CTRL_CURRENT >> 6:
6000 page->ctl_time_io_secs[0] = ctl_time_io_secs >> 8;
6001 page->ctl_time_io_secs[1] = ctl_time_io_secs >> 0;
6011 ctl_do_mode_select(union ctl_io *io)
6013 struct scsi_mode_page_header *page_header;
6014 struct ctl_page_index *page_index;
6015 struct ctl_scsiio *ctsio;
6016 int page_len, page_len_offset, page_len_size;
6017 union ctl_modepage_info *modepage_info;
6018 struct ctl_lun *lun;
6019 int *len_left, *len_used;
6022 ctsio = &io->scsiio;
6025 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
6027 modepage_info = (union ctl_modepage_info *)
6028 ctsio->io_hdr.ctl_private[CTL_PRIV_MODEPAGE].bytes;
6029 len_left = &modepage_info->header.len_left;
6030 len_used = &modepage_info->header.len_used;
6034 page_header = (struct scsi_mode_page_header *)
6035 (ctsio->kern_data_ptr + *len_used);
6037 if (*len_left == 0) {
6038 free(ctsio->kern_data_ptr, M_CTL);
6039 ctl_set_success(ctsio);
6040 ctl_done((union ctl_io *)ctsio);
6041 return (CTL_RETVAL_COMPLETE);
6042 } else if (*len_left < sizeof(struct scsi_mode_page_header)) {
6044 free(ctsio->kern_data_ptr, M_CTL);
6045 ctl_set_param_len_error(ctsio);
6046 ctl_done((union ctl_io *)ctsio);
6047 return (CTL_RETVAL_COMPLETE);
6049 } else if ((page_header->page_code & SMPH_SPF)
6050 && (*len_left < sizeof(struct scsi_mode_page_header_sp))) {
6052 free(ctsio->kern_data_ptr, M_CTL);
6053 ctl_set_param_len_error(ctsio);
6054 ctl_done((union ctl_io *)ctsio);
6055 return (CTL_RETVAL_COMPLETE);
6060 * XXX KDM should we do something with the block descriptor?
6062 for (i = 0; i < CTL_NUM_MODE_PAGES; i++) {
6063 page_index = &lun->mode_pages.index[i];
6064 if (lun->be_lun->lun_type == T_DIRECT &&
6065 (page_index->page_flags & CTL_PAGE_FLAG_DIRECT) == 0)
6067 if (lun->be_lun->lun_type == T_PROCESSOR &&
6068 (page_index->page_flags & CTL_PAGE_FLAG_PROC) == 0)
6070 if (lun->be_lun->lun_type == T_CDROM &&
6071 (page_index->page_flags & CTL_PAGE_FLAG_CDROM) == 0)
6074 if ((page_index->page_code & SMPH_PC_MASK) !=
6075 (page_header->page_code & SMPH_PC_MASK))
6079 * If neither page has a subpage code, then we've got a
6082 if (((page_index->page_code & SMPH_SPF) == 0)
6083 && ((page_header->page_code & SMPH_SPF) == 0)) {
6084 page_len = page_header->page_length;
6089 * If both pages have subpages, then the subpage numbers
6092 if ((page_index->page_code & SMPH_SPF)
6093 && (page_header->page_code & SMPH_SPF)) {
6094 struct scsi_mode_page_header_sp *sph;
6096 sph = (struct scsi_mode_page_header_sp *)page_header;
6097 if (page_index->subpage == sph->subpage) {
6098 page_len = scsi_2btoul(sph->page_length);
6105 * If we couldn't find the page, or if we don't have a mode select
6106 * handler for it, send back an error to the user.
6108 if ((i >= CTL_NUM_MODE_PAGES)
6109 || (page_index->select_handler == NULL)) {
6110 ctl_set_invalid_field(ctsio,
6113 /*field*/ *len_used,
6116 free(ctsio->kern_data_ptr, M_CTL);
6117 ctl_done((union ctl_io *)ctsio);
6118 return (CTL_RETVAL_COMPLETE);
6121 if (page_index->page_code & SMPH_SPF) {
6122 page_len_offset = 2;
6126 page_len_offset = 1;
6130 * If the length the initiator gives us isn't the one we specify in
6131 * the mode page header, or if they didn't specify enough data in
6132 * the CDB to avoid truncating this page, kick out the request.
6134 if ((page_len != (page_index->page_len - page_len_offset -
6136 || (*len_left < page_index->page_len)) {
6139 ctl_set_invalid_field(ctsio,
6142 /*field*/ *len_used + page_len_offset,
6145 free(ctsio->kern_data_ptr, M_CTL);
6146 ctl_done((union ctl_io *)ctsio);
6147 return (CTL_RETVAL_COMPLETE);
6151 * Run through the mode page, checking to make sure that the bits
6152 * the user changed are actually legal for him to change.
6154 for (i = 0; i < page_index->page_len; i++) {
6155 uint8_t *user_byte, *change_mask, *current_byte;
6159 user_byte = (uint8_t *)page_header + i;
6160 change_mask = page_index->page_data +
6161 (page_index->page_len * CTL_PAGE_CHANGEABLE) + i;
6162 current_byte = page_index->page_data +
6163 (page_index->page_len * CTL_PAGE_CURRENT) + i;
6166 * Check to see whether the user set any bits in this byte
6167 * that he is not allowed to set.
6169 if ((*user_byte & ~(*change_mask)) ==
6170 (*current_byte & ~(*change_mask)))
6174 * Go through bit by bit to determine which one is illegal.
6177 for (j = 7; j >= 0; j--) {
6178 if ((((1 << i) & ~(*change_mask)) & *user_byte) !=
6179 (((1 << i) & ~(*change_mask)) & *current_byte)) {
6184 ctl_set_invalid_field(ctsio,
6187 /*field*/ *len_used + i,
6190 free(ctsio->kern_data_ptr, M_CTL);
6191 ctl_done((union ctl_io *)ctsio);
6192 return (CTL_RETVAL_COMPLETE);
6196 * Decrement these before we call the page handler, since we may
6197 * end up getting called back one way or another before the handler
6198 * returns to this context.
6200 *len_left -= page_index->page_len;
6201 *len_used += page_index->page_len;
6203 retval = page_index->select_handler(ctsio, page_index,
6204 (uint8_t *)page_header);
6207 * If the page handler returns CTL_RETVAL_QUEUED, then we need to
6208 * wait until this queued command completes to finish processing
6209 * the mode page. If it returns anything other than
6210 * CTL_RETVAL_COMPLETE (e.g. CTL_RETVAL_ERROR), then it should have
6211 * already set the sense information, freed the data pointer, and
6212 * completed the io for us.
6214 if (retval != CTL_RETVAL_COMPLETE)
6215 goto bailout_no_done;
6218 * If the initiator sent us more than one page, parse the next one.
6223 ctl_set_success(ctsio);
6224 free(ctsio->kern_data_ptr, M_CTL);
6225 ctl_done((union ctl_io *)ctsio);
6229 return (CTL_RETVAL_COMPLETE);
6234 ctl_mode_select(struct ctl_scsiio *ctsio)
6236 int param_len, pf, sp;
6237 int header_size, bd_len;
6238 union ctl_modepage_info *modepage_info;
6240 switch (ctsio->cdb[0]) {
6241 case MODE_SELECT_6: {
6242 struct scsi_mode_select_6 *cdb;
6244 cdb = (struct scsi_mode_select_6 *)ctsio->cdb;
6246 pf = (cdb->byte2 & SMS_PF) ? 1 : 0;
6247 sp = (cdb->byte2 & SMS_SP) ? 1 : 0;
6248 param_len = cdb->length;
6249 header_size = sizeof(struct scsi_mode_header_6);
6252 case MODE_SELECT_10: {
6253 struct scsi_mode_select_10 *cdb;
6255 cdb = (struct scsi_mode_select_10 *)ctsio->cdb;
6257 pf = (cdb->byte2 & SMS_PF) ? 1 : 0;
6258 sp = (cdb->byte2 & SMS_SP) ? 1 : 0;
6259 param_len = scsi_2btoul(cdb->length);
6260 header_size = sizeof(struct scsi_mode_header_10);
6264 ctl_set_invalid_opcode(ctsio);
6265 ctl_done((union ctl_io *)ctsio);
6266 return (CTL_RETVAL_COMPLETE);
6271 * "A parameter list length of zero indicates that the Data-Out Buffer
6272 * shall be empty. This condition shall not be considered as an error."
6274 if (param_len == 0) {
6275 ctl_set_success(ctsio);
6276 ctl_done((union ctl_io *)ctsio);
6277 return (CTL_RETVAL_COMPLETE);
6281 * Since we'll hit this the first time through, prior to
6282 * allocation, we don't need to free a data buffer here.
6284 if (param_len < header_size) {
6285 ctl_set_param_len_error(ctsio);
6286 ctl_done((union ctl_io *)ctsio);
6287 return (CTL_RETVAL_COMPLETE);
6291 * Allocate the data buffer and grab the user's data. In theory,
6292 * we shouldn't have to sanity check the parameter list length here
6293 * because the maximum size is 64K. We should be able to malloc
6294 * that much without too many problems.
6296 if ((ctsio->io_hdr.flags & CTL_FLAG_ALLOCATED) == 0) {
6297 ctsio->kern_data_ptr = malloc(param_len, M_CTL, M_WAITOK);
6298 ctsio->kern_data_len = param_len;
6299 ctsio->kern_total_len = param_len;
6300 ctsio->kern_data_resid = 0;
6301 ctsio->kern_rel_offset = 0;
6302 ctsio->kern_sg_entries = 0;
6303 ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
6304 ctsio->be_move_done = ctl_config_move_done;
6305 ctl_datamove((union ctl_io *)ctsio);
6307 return (CTL_RETVAL_COMPLETE);
6310 switch (ctsio->cdb[0]) {
6311 case MODE_SELECT_6: {
6312 struct scsi_mode_header_6 *mh6;
6314 mh6 = (struct scsi_mode_header_6 *)ctsio->kern_data_ptr;
6315 bd_len = mh6->blk_desc_len;
6318 case MODE_SELECT_10: {
6319 struct scsi_mode_header_10 *mh10;
6321 mh10 = (struct scsi_mode_header_10 *)ctsio->kern_data_ptr;
6322 bd_len = scsi_2btoul(mh10->blk_desc_len);
6326 panic("%s: Invalid CDB type %#x", __func__, ctsio->cdb[0]);
6329 if (param_len < (header_size + bd_len)) {
6330 free(ctsio->kern_data_ptr, M_CTL);
6331 ctl_set_param_len_error(ctsio);
6332 ctl_done((union ctl_io *)ctsio);
6333 return (CTL_RETVAL_COMPLETE);
6337 * Set the IO_CONT flag, so that if this I/O gets passed to
6338 * ctl_config_write_done(), it'll get passed back to
6339 * ctl_do_mode_select() for further processing, or completion if
6342 ctsio->io_hdr.flags |= CTL_FLAG_IO_CONT;
6343 ctsio->io_cont = ctl_do_mode_select;
6345 modepage_info = (union ctl_modepage_info *)
6346 ctsio->io_hdr.ctl_private[CTL_PRIV_MODEPAGE].bytes;
6347 memset(modepage_info, 0, sizeof(*modepage_info));
6348 modepage_info->header.len_left = param_len - header_size - bd_len;
6349 modepage_info->header.len_used = header_size + bd_len;
6351 return (ctl_do_mode_select((union ctl_io *)ctsio));
6355 ctl_mode_sense(struct ctl_scsiio *ctsio)
6357 struct ctl_lun *lun;
6358 int pc, page_code, dbd, llba, subpage;
6359 int alloc_len, page_len, header_len, total_len;
6360 struct scsi_mode_block_descr *block_desc;
6361 struct ctl_page_index *page_index;
6367 CTL_DEBUG_PRINT(("ctl_mode_sense\n"));
6369 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
6370 switch (ctsio->cdb[0]) {
6371 case MODE_SENSE_6: {
6372 struct scsi_mode_sense_6 *cdb;
6374 cdb = (struct scsi_mode_sense_6 *)ctsio->cdb;
6376 header_len = sizeof(struct scsi_mode_hdr_6);
6377 if (cdb->byte2 & SMS_DBD)
6380 header_len += sizeof(struct scsi_mode_block_descr);
6382 pc = (cdb->page & SMS_PAGE_CTRL_MASK) >> 6;
6383 page_code = cdb->page & SMS_PAGE_CODE;
6384 subpage = cdb->subpage;
6385 alloc_len = cdb->length;
6388 case MODE_SENSE_10: {
6389 struct scsi_mode_sense_10 *cdb;
6391 cdb = (struct scsi_mode_sense_10 *)ctsio->cdb;
6393 header_len = sizeof(struct scsi_mode_hdr_10);
6395 if (cdb->byte2 & SMS_DBD)
6398 header_len += sizeof(struct scsi_mode_block_descr);
6399 if (cdb->byte2 & SMS10_LLBAA)
6401 pc = (cdb->page & SMS_PAGE_CTRL_MASK) >> 6;
6402 page_code = cdb->page & SMS_PAGE_CODE;
6403 subpage = cdb->subpage;
6404 alloc_len = scsi_2btoul(cdb->length);
6408 ctl_set_invalid_opcode(ctsio);
6409 ctl_done((union ctl_io *)ctsio);
6410 return (CTL_RETVAL_COMPLETE);
6411 break; /* NOTREACHED */
6415 * We have to make a first pass through to calculate the size of
6416 * the pages that match the user's query. Then we allocate enough
6417 * memory to hold it, and actually copy the data into the buffer.
6419 switch (page_code) {
6420 case SMS_ALL_PAGES_PAGE: {
6426 * At the moment, values other than 0 and 0xff here are
6427 * reserved according to SPC-3.
6429 if ((subpage != SMS_SUBPAGE_PAGE_0)
6430 && (subpage != SMS_SUBPAGE_ALL)) {
6431 ctl_set_invalid_field(ctsio,
6437 ctl_done((union ctl_io *)ctsio);
6438 return (CTL_RETVAL_COMPLETE);
6441 for (i = 0; i < CTL_NUM_MODE_PAGES; i++) {
6442 page_index = &lun->mode_pages.index[i];
6444 /* Make sure the page is supported for this dev type */
6445 if (lun->be_lun->lun_type == T_DIRECT &&
6446 (page_index->page_flags & CTL_PAGE_FLAG_DIRECT) == 0)
6448 if (lun->be_lun->lun_type == T_PROCESSOR &&
6449 (page_index->page_flags & CTL_PAGE_FLAG_PROC) == 0)
6451 if (lun->be_lun->lun_type == T_CDROM &&
6452 (page_index->page_flags & CTL_PAGE_FLAG_CDROM) == 0)
6456 * We don't use this subpage if the user didn't
6457 * request all subpages.
6459 if ((page_index->subpage != 0)
6460 && (subpage == SMS_SUBPAGE_PAGE_0))
6464 printf("found page %#x len %d\n",
6465 page_index->page_code & SMPH_PC_MASK,
6466 page_index->page_len);
6468 page_len += page_index->page_len;
6477 for (i = 0; i < CTL_NUM_MODE_PAGES; i++) {
6478 page_index = &lun->mode_pages.index[i];
6480 /* Make sure the page is supported for this dev type */
6481 if (lun->be_lun->lun_type == T_DIRECT &&
6482 (page_index->page_flags & CTL_PAGE_FLAG_DIRECT) == 0)
6484 if (lun->be_lun->lun_type == T_PROCESSOR &&
6485 (page_index->page_flags & CTL_PAGE_FLAG_PROC) == 0)
6487 if (lun->be_lun->lun_type == T_CDROM &&
6488 (page_index->page_flags & CTL_PAGE_FLAG_CDROM) == 0)
6491 /* Look for the right page code */
6492 if ((page_index->page_code & SMPH_PC_MASK) != page_code)
6495 /* Look for the right subpage or the subpage wildcard*/
6496 if ((page_index->subpage != subpage)
6497 && (subpage != SMS_SUBPAGE_ALL))
6501 printf("found page %#x len %d\n",
6502 page_index->page_code & SMPH_PC_MASK,
6503 page_index->page_len);
6506 page_len += page_index->page_len;
6509 if (page_len == 0) {
6510 ctl_set_invalid_field(ctsio,
6516 ctl_done((union ctl_io *)ctsio);
6517 return (CTL_RETVAL_COMPLETE);
6523 total_len = header_len + page_len;
6525 printf("header_len = %d, page_len = %d, total_len = %d\n",
6526 header_len, page_len, total_len);
6529 ctsio->kern_data_ptr = malloc(total_len, M_CTL, M_WAITOK | M_ZERO);
6530 ctsio->kern_sg_entries = 0;
6531 ctsio->kern_data_resid = 0;
6532 ctsio->kern_rel_offset = 0;
6533 if (total_len < alloc_len) {
6534 ctsio->residual = alloc_len - total_len;
6535 ctsio->kern_data_len = total_len;
6536 ctsio->kern_total_len = total_len;
6538 ctsio->residual = 0;
6539 ctsio->kern_data_len = alloc_len;
6540 ctsio->kern_total_len = alloc_len;
6543 switch (ctsio->cdb[0]) {
6544 case MODE_SENSE_6: {
6545 struct scsi_mode_hdr_6 *header;
6547 header = (struct scsi_mode_hdr_6 *)ctsio->kern_data_ptr;
6549 header->datalen = MIN(total_len - 1, 254);
6550 if (lun->be_lun->lun_type == T_DIRECT) {
6551 header->dev_specific = 0x10; /* DPOFUA */
6552 if ((lun->be_lun->flags & CTL_LUN_FLAG_READONLY) ||
6553 (lun->mode_pages.control_page[CTL_PAGE_CURRENT]
6554 .eca_and_aen & SCP_SWP) != 0)
6555 header->dev_specific |= 0x80; /* WP */
6558 header->block_descr_len = 0;
6560 header->block_descr_len =
6561 sizeof(struct scsi_mode_block_descr);
6562 block_desc = (struct scsi_mode_block_descr *)&header[1];
6565 case MODE_SENSE_10: {
6566 struct scsi_mode_hdr_10 *header;
6569 header = (struct scsi_mode_hdr_10 *)ctsio->kern_data_ptr;
6571 datalen = MIN(total_len - 2, 65533);
6572 scsi_ulto2b(datalen, header->datalen);
6573 if (lun->be_lun->lun_type == T_DIRECT) {
6574 header->dev_specific = 0x10; /* DPOFUA */
6575 if ((lun->be_lun->flags & CTL_LUN_FLAG_READONLY) ||
6576 (lun->mode_pages.control_page[CTL_PAGE_CURRENT]
6577 .eca_and_aen & SCP_SWP) != 0)
6578 header->dev_specific |= 0x80; /* WP */
6581 scsi_ulto2b(0, header->block_descr_len);
6583 scsi_ulto2b(sizeof(struct scsi_mode_block_descr),
6584 header->block_descr_len);
6585 block_desc = (struct scsi_mode_block_descr *)&header[1];
6589 panic("%s: Invalid CDB type %#x", __func__, ctsio->cdb[0]);
6593 * If we've got a disk, use its blocksize in the block
6594 * descriptor. Otherwise, just set it to 0.
6597 if (lun->be_lun->lun_type == T_DIRECT)
6598 scsi_ulto3b(lun->be_lun->blocksize,
6599 block_desc->block_len);
6601 scsi_ulto3b(0, block_desc->block_len);
6604 switch (page_code) {
6605 case SMS_ALL_PAGES_PAGE: {
6608 data_used = header_len;
6609 for (i = 0; i < CTL_NUM_MODE_PAGES; i++) {
6610 struct ctl_page_index *page_index;
6612 page_index = &lun->mode_pages.index[i];
6613 if (lun->be_lun->lun_type == T_DIRECT &&
6614 (page_index->page_flags & CTL_PAGE_FLAG_DIRECT) == 0)
6616 if (lun->be_lun->lun_type == T_PROCESSOR &&
6617 (page_index->page_flags & CTL_PAGE_FLAG_PROC) == 0)
6619 if (lun->be_lun->lun_type == T_CDROM &&
6620 (page_index->page_flags & CTL_PAGE_FLAG_CDROM) == 0)
6624 * We don't use this subpage if the user didn't
6625 * request all subpages. We already checked (above)
6626 * to make sure the user only specified a subpage
6627 * of 0 or 0xff in the SMS_ALL_PAGES_PAGE case.
6629 if ((page_index->subpage != 0)
6630 && (subpage == SMS_SUBPAGE_PAGE_0))
6634 * Call the handler, if it exists, to update the
6635 * page to the latest values.
6637 if (page_index->sense_handler != NULL)
6638 page_index->sense_handler(ctsio, page_index,pc);
6640 memcpy(ctsio->kern_data_ptr + data_used,
6641 page_index->page_data +
6642 (page_index->page_len * pc),
6643 page_index->page_len);
6644 data_used += page_index->page_len;
6651 data_used = header_len;
6653 for (i = 0; i < CTL_NUM_MODE_PAGES; i++) {
6654 struct ctl_page_index *page_index;
6656 page_index = &lun->mode_pages.index[i];
6658 /* Look for the right page code */
6659 if ((page_index->page_code & SMPH_PC_MASK) != page_code)
6662 /* Look for the right subpage or the subpage wildcard*/
6663 if ((page_index->subpage != subpage)
6664 && (subpage != SMS_SUBPAGE_ALL))
6667 /* Make sure the page is supported for this dev type */
6668 if (lun->be_lun->lun_type == T_DIRECT &&
6669 (page_index->page_flags & CTL_PAGE_FLAG_DIRECT) == 0)
6671 if (lun->be_lun->lun_type == T_PROCESSOR &&
6672 (page_index->page_flags & CTL_PAGE_FLAG_PROC) == 0)
6674 if (lun->be_lun->lun_type == T_CDROM &&
6675 (page_index->page_flags & CTL_PAGE_FLAG_CDROM) == 0)
6679 * Call the handler, if it exists, to update the
6680 * page to the latest values.
6682 if (page_index->sense_handler != NULL)
6683 page_index->sense_handler(ctsio, page_index,pc);
6685 memcpy(ctsio->kern_data_ptr + data_used,
6686 page_index->page_data +
6687 (page_index->page_len * pc),
6688 page_index->page_len);
6689 data_used += page_index->page_len;
6695 ctl_set_success(ctsio);
6696 ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
6697 ctsio->be_move_done = ctl_config_move_done;
6698 ctl_datamove((union ctl_io *)ctsio);
6699 return (CTL_RETVAL_COMPLETE);
6703 ctl_lbp_log_sense_handler(struct ctl_scsiio *ctsio,
6704 struct ctl_page_index *page_index,
6707 struct ctl_lun *lun;
6708 struct scsi_log_param_header *phdr;
6712 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
6713 data = page_index->page_data;
6715 if (lun->backend->lun_attr != NULL &&
6716 (val = lun->backend->lun_attr(lun->be_lun->be_lun, "blocksavail"))
6718 phdr = (struct scsi_log_param_header *)data;
6719 scsi_ulto2b(0x0001, phdr->param_code);
6720 phdr->param_control = SLP_LBIN | SLP_LP;
6721 phdr->param_len = 8;
6722 data = (uint8_t *)(phdr + 1);
6723 scsi_ulto4b(val >> CTL_LBP_EXPONENT, data);
6724 data[4] = 0x02; /* per-pool */
6725 data += phdr->param_len;
6728 if (lun->backend->lun_attr != NULL &&
6729 (val = lun->backend->lun_attr(lun->be_lun->be_lun, "blocksused"))
6731 phdr = (struct scsi_log_param_header *)data;
6732 scsi_ulto2b(0x0002, phdr->param_code);
6733 phdr->param_control = SLP_LBIN | SLP_LP;
6734 phdr->param_len = 8;
6735 data = (uint8_t *)(phdr + 1);
6736 scsi_ulto4b(val >> CTL_LBP_EXPONENT, data);
6737 data[4] = 0x01; /* per-LUN */
6738 data += phdr->param_len;
6741 if (lun->backend->lun_attr != NULL &&
6742 (val = lun->backend->lun_attr(lun->be_lun->be_lun, "poolblocksavail"))
6744 phdr = (struct scsi_log_param_header *)data;
6745 scsi_ulto2b(0x00f1, phdr->param_code);
6746 phdr->param_control = SLP_LBIN | SLP_LP;
6747 phdr->param_len = 8;
6748 data = (uint8_t *)(phdr + 1);
6749 scsi_ulto4b(val >> CTL_LBP_EXPONENT, data);
6750 data[4] = 0x02; /* per-pool */
6751 data += phdr->param_len;
6754 if (lun->backend->lun_attr != NULL &&
6755 (val = lun->backend->lun_attr(lun->be_lun->be_lun, "poolblocksused"))
6757 phdr = (struct scsi_log_param_header *)data;
6758 scsi_ulto2b(0x00f2, phdr->param_code);
6759 phdr->param_control = SLP_LBIN | SLP_LP;
6760 phdr->param_len = 8;
6761 data = (uint8_t *)(phdr + 1);
6762 scsi_ulto4b(val >> CTL_LBP_EXPONENT, data);
6763 data[4] = 0x02; /* per-pool */
6764 data += phdr->param_len;
6767 page_index->page_len = data - page_index->page_data;
6772 ctl_sap_log_sense_handler(struct ctl_scsiio *ctsio,
6773 struct ctl_page_index *page_index,
6776 struct ctl_lun *lun;
6777 struct stat_page *data;
6778 uint64_t rn, wn, rb, wb;
6779 struct bintime rt, wt;
6782 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
6783 data = (struct stat_page *)page_index->page_data;
6785 scsi_ulto2b(SLP_SAP, data->sap.hdr.param_code);
6786 data->sap.hdr.param_control = SLP_LBIN;
6787 data->sap.hdr.param_len = sizeof(struct scsi_log_stat_and_perf) -
6788 sizeof(struct scsi_log_param_header);
6789 rn = wn = rb = wb = 0;
6792 for (i = 0; i < CTL_MAX_PORTS; i++) {
6793 rn += lun->stats.ports[i].operations[CTL_STATS_READ];
6794 wn += lun->stats.ports[i].operations[CTL_STATS_WRITE];
6795 rb += lun->stats.ports[i].bytes[CTL_STATS_READ];
6796 wb += lun->stats.ports[i].bytes[CTL_STATS_WRITE];
6797 bintime_add(&rt, &lun->stats.ports[i].time[CTL_STATS_READ]);
6798 bintime_add(&wt, &lun->stats.ports[i].time[CTL_STATS_WRITE]);
6800 scsi_u64to8b(rn, data->sap.read_num);
6801 scsi_u64to8b(wn, data->sap.write_num);
6802 if (lun->stats.blocksize > 0) {
6803 scsi_u64to8b(wb / lun->stats.blocksize,
6804 data->sap.recvieved_lba);
6805 scsi_u64to8b(rb / lun->stats.blocksize,
6806 data->sap.transmitted_lba);
6808 scsi_u64to8b((uint64_t)rt.sec * 1000 + rt.frac / (UINT64_MAX / 1000),
6809 data->sap.read_int);
6810 scsi_u64to8b((uint64_t)wt.sec * 1000 + wt.frac / (UINT64_MAX / 1000),
6811 data->sap.write_int);
6812 scsi_u64to8b(0, data->sap.weighted_num);
6813 scsi_u64to8b(0, data->sap.weighted_int);
6814 scsi_ulto2b(SLP_IT, data->it.hdr.param_code);
6815 data->it.hdr.param_control = SLP_LBIN;
6816 data->it.hdr.param_len = sizeof(struct scsi_log_idle_time) -
6817 sizeof(struct scsi_log_param_header);
6819 scsi_u64to8b(lun->idle_time / SBT_1MS, data->it.idle_int);
6821 scsi_ulto2b(SLP_TI, data->ti.hdr.param_code);
6822 data->it.hdr.param_control = SLP_LBIN;
6823 data->ti.hdr.param_len = sizeof(struct scsi_log_time_interval) -
6824 sizeof(struct scsi_log_param_header);
6825 scsi_ulto4b(3, data->ti.exponent);
6826 scsi_ulto4b(1, data->ti.integer);
6828 page_index->page_len = sizeof(*data);
6833 ctl_log_sense(struct ctl_scsiio *ctsio)
6835 struct ctl_lun *lun;
6836 int i, pc, page_code, subpage;
6837 int alloc_len, total_len;
6838 struct ctl_page_index *page_index;
6839 struct scsi_log_sense *cdb;
6840 struct scsi_log_header *header;
6842 CTL_DEBUG_PRINT(("ctl_log_sense\n"));
6844 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
6845 cdb = (struct scsi_log_sense *)ctsio->cdb;
6846 pc = (cdb->page & SLS_PAGE_CTRL_MASK) >> 6;
6847 page_code = cdb->page & SLS_PAGE_CODE;
6848 subpage = cdb->subpage;
6849 alloc_len = scsi_2btoul(cdb->length);
6852 for (i = 0; i < CTL_NUM_LOG_PAGES; i++) {
6853 page_index = &lun->log_pages.index[i];
6855 /* Look for the right page code */
6856 if ((page_index->page_code & SL_PAGE_CODE) != page_code)
6859 /* Look for the right subpage or the subpage wildcard*/
6860 if (page_index->subpage != subpage)
6865 if (i >= CTL_NUM_LOG_PAGES) {
6866 ctl_set_invalid_field(ctsio,
6872 ctl_done((union ctl_io *)ctsio);
6873 return (CTL_RETVAL_COMPLETE);
6876 total_len = sizeof(struct scsi_log_header) + page_index->page_len;
6878 ctsio->kern_data_ptr = malloc(total_len, M_CTL, M_WAITOK | M_ZERO);
6879 ctsio->kern_sg_entries = 0;
6880 ctsio->kern_data_resid = 0;
6881 ctsio->kern_rel_offset = 0;
6882 if (total_len < alloc_len) {
6883 ctsio->residual = alloc_len - total_len;
6884 ctsio->kern_data_len = total_len;
6885 ctsio->kern_total_len = total_len;
6887 ctsio->residual = 0;
6888 ctsio->kern_data_len = alloc_len;
6889 ctsio->kern_total_len = alloc_len;
6892 header = (struct scsi_log_header *)ctsio->kern_data_ptr;
6893 header->page = page_index->page_code;
6894 if (page_index->page_code == SLS_LOGICAL_BLOCK_PROVISIONING)
6895 header->page |= SL_DS;
6896 if (page_index->subpage) {
6897 header->page |= SL_SPF;
6898 header->subpage = page_index->subpage;
6900 scsi_ulto2b(page_index->page_len, header->datalen);
6903 * Call the handler, if it exists, to update the
6904 * page to the latest values.
6906 if (page_index->sense_handler != NULL)
6907 page_index->sense_handler(ctsio, page_index, pc);
6909 memcpy(header + 1, page_index->page_data, page_index->page_len);
6911 ctl_set_success(ctsio);
6912 ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
6913 ctsio->be_move_done = ctl_config_move_done;
6914 ctl_datamove((union ctl_io *)ctsio);
6915 return (CTL_RETVAL_COMPLETE);
6919 ctl_read_capacity(struct ctl_scsiio *ctsio)
6921 struct scsi_read_capacity *cdb;
6922 struct scsi_read_capacity_data *data;
6923 struct ctl_lun *lun;
6926 CTL_DEBUG_PRINT(("ctl_read_capacity\n"));
6928 cdb = (struct scsi_read_capacity *)ctsio->cdb;
6930 lba = scsi_4btoul(cdb->addr);
6931 if (((cdb->pmi & SRC_PMI) == 0)
6933 ctl_set_invalid_field(/*ctsio*/ ctsio,
6939 ctl_done((union ctl_io *)ctsio);
6940 return (CTL_RETVAL_COMPLETE);
6943 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
6945 ctsio->kern_data_ptr = malloc(sizeof(*data), M_CTL, M_WAITOK | M_ZERO);
6946 data = (struct scsi_read_capacity_data *)ctsio->kern_data_ptr;
6947 ctsio->residual = 0;
6948 ctsio->kern_data_len = sizeof(*data);
6949 ctsio->kern_total_len = sizeof(*data);
6950 ctsio->kern_data_resid = 0;
6951 ctsio->kern_rel_offset = 0;
6952 ctsio->kern_sg_entries = 0;
6955 * If the maximum LBA is greater than 0xfffffffe, the user must
6956 * issue a SERVICE ACTION IN (16) command, with the read capacity
6957 * serivce action set.
6959 if (lun->be_lun->maxlba > 0xfffffffe)
6960 scsi_ulto4b(0xffffffff, data->addr);
6962 scsi_ulto4b(lun->be_lun->maxlba, data->addr);
6965 * XXX KDM this may not be 512 bytes...
6967 scsi_ulto4b(lun->be_lun->blocksize, data->length);
6969 ctl_set_success(ctsio);
6970 ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
6971 ctsio->be_move_done = ctl_config_move_done;
6972 ctl_datamove((union ctl_io *)ctsio);
6973 return (CTL_RETVAL_COMPLETE);
6977 ctl_read_capacity_16(struct ctl_scsiio *ctsio)
6979 struct scsi_read_capacity_16 *cdb;
6980 struct scsi_read_capacity_data_long *data;
6981 struct ctl_lun *lun;
6985 CTL_DEBUG_PRINT(("ctl_read_capacity_16\n"));
6987 cdb = (struct scsi_read_capacity_16 *)ctsio->cdb;
6989 alloc_len = scsi_4btoul(cdb->alloc_len);
6990 lba = scsi_8btou64(cdb->addr);
6992 if ((cdb->reladr & SRC16_PMI)
6994 ctl_set_invalid_field(/*ctsio*/ ctsio,
7000 ctl_done((union ctl_io *)ctsio);
7001 return (CTL_RETVAL_COMPLETE);
7004 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
7006 ctsio->kern_data_ptr = malloc(sizeof(*data), M_CTL, M_WAITOK | M_ZERO);
7007 data = (struct scsi_read_capacity_data_long *)ctsio->kern_data_ptr;
7009 if (sizeof(*data) < alloc_len) {
7010 ctsio->residual = alloc_len - sizeof(*data);
7011 ctsio->kern_data_len = sizeof(*data);
7012 ctsio->kern_total_len = sizeof(*data);
7014 ctsio->residual = 0;
7015 ctsio->kern_data_len = alloc_len;
7016 ctsio->kern_total_len = alloc_len;
7018 ctsio->kern_data_resid = 0;
7019 ctsio->kern_rel_offset = 0;
7020 ctsio->kern_sg_entries = 0;
7022 scsi_u64to8b(lun->be_lun->maxlba, data->addr);
7023 /* XXX KDM this may not be 512 bytes... */
7024 scsi_ulto4b(lun->be_lun->blocksize, data->length);
7025 data->prot_lbppbe = lun->be_lun->pblockexp & SRC16_LBPPBE;
7026 scsi_ulto2b(lun->be_lun->pblockoff & SRC16_LALBA_A, data->lalba_lbp);
7027 if (lun->be_lun->flags & CTL_LUN_FLAG_UNMAP)
7028 data->lalba_lbp[0] |= SRC16_LBPME | SRC16_LBPRZ;
7030 ctl_set_success(ctsio);
7031 ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
7032 ctsio->be_move_done = ctl_config_move_done;
7033 ctl_datamove((union ctl_io *)ctsio);
7034 return (CTL_RETVAL_COMPLETE);
7038 ctl_get_lba_status(struct ctl_scsiio *ctsio)
7040 struct scsi_get_lba_status *cdb;
7041 struct scsi_get_lba_status_data *data;
7042 struct ctl_lun *lun;
7043 struct ctl_lba_len_flags *lbalen;
7045 uint32_t alloc_len, total_len;
7048 CTL_DEBUG_PRINT(("ctl_get_lba_status\n"));
7050 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
7051 cdb = (struct scsi_get_lba_status *)ctsio->cdb;
7052 lba = scsi_8btou64(cdb->addr);
7053 alloc_len = scsi_4btoul(cdb->alloc_len);
7055 if (lba > lun->be_lun->maxlba) {
7056 ctl_set_lba_out_of_range(ctsio);
7057 ctl_done((union ctl_io *)ctsio);
7058 return (CTL_RETVAL_COMPLETE);
7061 total_len = sizeof(*data) + sizeof(data->descr[0]);
7062 ctsio->kern_data_ptr = malloc(total_len, M_CTL, M_WAITOK | M_ZERO);
7063 data = (struct scsi_get_lba_status_data *)ctsio->kern_data_ptr;
7065 if (total_len < alloc_len) {
7066 ctsio->residual = alloc_len - total_len;
7067 ctsio->kern_data_len = total_len;
7068 ctsio->kern_total_len = total_len;
7070 ctsio->residual = 0;
7071 ctsio->kern_data_len = alloc_len;
7072 ctsio->kern_total_len = alloc_len;
7074 ctsio->kern_data_resid = 0;
7075 ctsio->kern_rel_offset = 0;
7076 ctsio->kern_sg_entries = 0;
7078 /* Fill dummy data in case backend can't tell anything. */
7079 scsi_ulto4b(4 + sizeof(data->descr[0]), data->length);
7080 scsi_u64to8b(lba, data->descr[0].addr);
7081 scsi_ulto4b(MIN(UINT32_MAX, lun->be_lun->maxlba + 1 - lba),
7082 data->descr[0].length);
7083 data->descr[0].status = 0; /* Mapped or unknown. */
7085 ctl_set_success(ctsio);
7086 ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
7087 ctsio->be_move_done = ctl_config_move_done;
7089 lbalen = (struct ctl_lba_len_flags *)&ctsio->io_hdr.ctl_private[CTL_PRIV_LBA_LEN];
7091 lbalen->len = total_len;
7093 retval = lun->backend->config_read((union ctl_io *)ctsio);
7094 return (CTL_RETVAL_COMPLETE);
7098 ctl_read_defect(struct ctl_scsiio *ctsio)
7100 struct scsi_read_defect_data_10 *ccb10;
7101 struct scsi_read_defect_data_12 *ccb12;
7102 struct scsi_read_defect_data_hdr_10 *data10;
7103 struct scsi_read_defect_data_hdr_12 *data12;
7104 uint32_t alloc_len, data_len;
7107 CTL_DEBUG_PRINT(("ctl_read_defect\n"));
7109 if (ctsio->cdb[0] == READ_DEFECT_DATA_10) {
7110 ccb10 = (struct scsi_read_defect_data_10 *)&ctsio->cdb;
7111 format = ccb10->format;
7112 alloc_len = scsi_2btoul(ccb10->alloc_length);
7113 data_len = sizeof(*data10);
7115 ccb12 = (struct scsi_read_defect_data_12 *)&ctsio->cdb;
7116 format = ccb12->format;
7117 alloc_len = scsi_4btoul(ccb12->alloc_length);
7118 data_len = sizeof(*data12);
7120 if (alloc_len == 0) {
7121 ctl_set_success(ctsio);
7122 ctl_done((union ctl_io *)ctsio);
7123 return (CTL_RETVAL_COMPLETE);
7126 ctsio->kern_data_ptr = malloc(data_len, M_CTL, M_WAITOK | M_ZERO);
7127 if (data_len < alloc_len) {
7128 ctsio->residual = alloc_len - data_len;
7129 ctsio->kern_data_len = data_len;
7130 ctsio->kern_total_len = data_len;
7132 ctsio->residual = 0;
7133 ctsio->kern_data_len = alloc_len;
7134 ctsio->kern_total_len = alloc_len;
7136 ctsio->kern_data_resid = 0;
7137 ctsio->kern_rel_offset = 0;
7138 ctsio->kern_sg_entries = 0;
7140 if (ctsio->cdb[0] == READ_DEFECT_DATA_10) {
7141 data10 = (struct scsi_read_defect_data_hdr_10 *)
7142 ctsio->kern_data_ptr;
7143 data10->format = format;
7144 scsi_ulto2b(0, data10->length);
7146 data12 = (struct scsi_read_defect_data_hdr_12 *)
7147 ctsio->kern_data_ptr;
7148 data12->format = format;
7149 scsi_ulto2b(0, data12->generation);
7150 scsi_ulto4b(0, data12->length);
7153 ctl_set_success(ctsio);
7154 ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
7155 ctsio->be_move_done = ctl_config_move_done;
7156 ctl_datamove((union ctl_io *)ctsio);
7157 return (CTL_RETVAL_COMPLETE);
7161 ctl_report_tagret_port_groups(struct ctl_scsiio *ctsio)
7163 struct scsi_maintenance_in *cdb;
7165 int alloc_len, ext, total_len = 0, g, pc, pg, ts, os;
7166 int num_ha_groups, num_target_ports, shared_group;
7167 struct ctl_lun *lun;
7168 struct ctl_softc *softc;
7169 struct ctl_port *port;
7170 struct scsi_target_group_data *rtg_ptr;
7171 struct scsi_target_group_data_extended *rtg_ext_ptr;
7172 struct scsi_target_port_group_descriptor *tpg_desc;
7174 CTL_DEBUG_PRINT(("ctl_report_tagret_port_groups\n"));
7176 cdb = (struct scsi_maintenance_in *)ctsio->cdb;
7177 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
7178 softc = lun->ctl_softc;
7180 retval = CTL_RETVAL_COMPLETE;
7182 switch (cdb->byte2 & STG_PDF_MASK) {
7183 case STG_PDF_LENGTH:
7186 case STG_PDF_EXTENDED:
7190 ctl_set_invalid_field(/*ctsio*/ ctsio,
7196 ctl_done((union ctl_io *)ctsio);
7200 num_target_ports = 0;
7201 shared_group = (softc->is_single != 0);
7202 mtx_lock(&softc->ctl_lock);
7203 STAILQ_FOREACH(port, &softc->port_list, links) {
7204 if ((port->status & CTL_PORT_STATUS_ONLINE) == 0)
7206 if (ctl_lun_map_to_port(port, lun->lun) >= CTL_MAX_LUNS)
7209 if (port->status & CTL_PORT_STATUS_HA_SHARED)
7212 mtx_unlock(&softc->ctl_lock);
7213 num_ha_groups = (softc->is_single) ? 0 : NUM_HA_SHELVES;
7216 total_len = sizeof(struct scsi_target_group_data_extended);
7218 total_len = sizeof(struct scsi_target_group_data);
7219 total_len += sizeof(struct scsi_target_port_group_descriptor) *
7220 (shared_group + num_ha_groups) +
7221 sizeof(struct scsi_target_port_descriptor) * num_target_ports;
7223 alloc_len = scsi_4btoul(cdb->length);
7225 ctsio->kern_data_ptr = malloc(total_len, M_CTL, M_WAITOK | M_ZERO);
7227 ctsio->kern_sg_entries = 0;
7229 if (total_len < alloc_len) {
7230 ctsio->residual = alloc_len - total_len;
7231 ctsio->kern_data_len = total_len;
7232 ctsio->kern_total_len = total_len;
7234 ctsio->residual = 0;
7235 ctsio->kern_data_len = alloc_len;
7236 ctsio->kern_total_len = alloc_len;
7238 ctsio->kern_data_resid = 0;
7239 ctsio->kern_rel_offset = 0;
7242 rtg_ext_ptr = (struct scsi_target_group_data_extended *)
7243 ctsio->kern_data_ptr;
7244 scsi_ulto4b(total_len - 4, rtg_ext_ptr->length);
7245 rtg_ext_ptr->format_type = 0x10;
7246 rtg_ext_ptr->implicit_transition_time = 0;
7247 tpg_desc = &rtg_ext_ptr->groups[0];
7249 rtg_ptr = (struct scsi_target_group_data *)
7250 ctsio->kern_data_ptr;
7251 scsi_ulto4b(total_len - 4, rtg_ptr->length);
7252 tpg_desc = &rtg_ptr->groups[0];
7255 mtx_lock(&softc->ctl_lock);
7256 pg = softc->port_min / softc->port_cnt;
7257 if (lun->flags & (CTL_LUN_PRIMARY_SC | CTL_LUN_PEER_SC_PRIMARY)) {
7258 /* Some shelf is known to be primary. */
7259 if (softc->ha_link == CTL_HA_LINK_OFFLINE)
7260 os = TPG_ASYMMETRIC_ACCESS_UNAVAILABLE;
7261 else if (softc->ha_link == CTL_HA_LINK_UNKNOWN)
7262 os = TPG_ASYMMETRIC_ACCESS_TRANSITIONING;
7263 else if (softc->ha_mode == CTL_HA_MODE_ACT_STBY)
7264 os = TPG_ASYMMETRIC_ACCESS_STANDBY;
7266 os = TPG_ASYMMETRIC_ACCESS_NONOPTIMIZED;
7267 if (lun->flags & CTL_LUN_PRIMARY_SC) {
7268 ts = TPG_ASYMMETRIC_ACCESS_OPTIMIZED;
7271 os = TPG_ASYMMETRIC_ACCESS_OPTIMIZED;
7274 /* No known primary shelf. */
7275 if (softc->ha_link == CTL_HA_LINK_OFFLINE) {
7276 ts = TPG_ASYMMETRIC_ACCESS_UNAVAILABLE;
7277 os = TPG_ASYMMETRIC_ACCESS_OPTIMIZED;
7278 } else if (softc->ha_link == CTL_HA_LINK_UNKNOWN) {
7279 ts = TPG_ASYMMETRIC_ACCESS_TRANSITIONING;
7280 os = TPG_ASYMMETRIC_ACCESS_OPTIMIZED;
7282 ts = os = TPG_ASYMMETRIC_ACCESS_TRANSITIONING;
7286 tpg_desc->pref_state = ts;
7287 tpg_desc->support = TPG_AO_SUP | TPG_AN_SUP | TPG_S_SUP |
7288 TPG_U_SUP | TPG_T_SUP;
7289 scsi_ulto2b(1, tpg_desc->target_port_group);
7290 tpg_desc->status = TPG_IMPLICIT;
7292 STAILQ_FOREACH(port, &softc->port_list, links) {
7293 if ((port->status & CTL_PORT_STATUS_ONLINE) == 0)
7295 if (!softc->is_single &&
7296 (port->status & CTL_PORT_STATUS_HA_SHARED) == 0)
7298 if (ctl_lun_map_to_port(port, lun->lun) >= CTL_MAX_LUNS)
7300 scsi_ulto2b(port->targ_port, tpg_desc->descriptors[pc].
7301 relative_target_port_identifier);
7304 tpg_desc->target_port_count = pc;
7305 tpg_desc = (struct scsi_target_port_group_descriptor *)
7306 &tpg_desc->descriptors[pc];
7308 for (g = 0; g < num_ha_groups; g++) {
7309 tpg_desc->pref_state = (g == pg) ? ts : os;
7310 tpg_desc->support = TPG_AO_SUP | TPG_AN_SUP | TPG_S_SUP |
7311 TPG_U_SUP | TPG_T_SUP;
7312 scsi_ulto2b(2 + g, tpg_desc->target_port_group);
7313 tpg_desc->status = TPG_IMPLICIT;
7315 STAILQ_FOREACH(port, &softc->port_list, links) {
7316 if (port->targ_port < g * softc->port_cnt ||
7317 port->targ_port >= (g + 1) * softc->port_cnt)
7319 if ((port->status & CTL_PORT_STATUS_ONLINE) == 0)
7321 if (port->status & CTL_PORT_STATUS_HA_SHARED)
7323 if (ctl_lun_map_to_port(port, lun->lun) >= CTL_MAX_LUNS)
7325 scsi_ulto2b(port->targ_port, tpg_desc->descriptors[pc].
7326 relative_target_port_identifier);
7329 tpg_desc->target_port_count = pc;
7330 tpg_desc = (struct scsi_target_port_group_descriptor *)
7331 &tpg_desc->descriptors[pc];
7333 mtx_unlock(&softc->ctl_lock);
7335 ctl_set_success(ctsio);
7336 ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
7337 ctsio->be_move_done = ctl_config_move_done;
7338 ctl_datamove((union ctl_io *)ctsio);
7343 ctl_report_supported_opcodes(struct ctl_scsiio *ctsio)
7345 struct ctl_lun *lun;
7346 struct scsi_report_supported_opcodes *cdb;
7347 const struct ctl_cmd_entry *entry, *sentry;
7348 struct scsi_report_supported_opcodes_all *all;
7349 struct scsi_report_supported_opcodes_descr *descr;
7350 struct scsi_report_supported_opcodes_one *one;
7352 int alloc_len, total_len;
7353 int opcode, service_action, i, j, num;
7355 CTL_DEBUG_PRINT(("ctl_report_supported_opcodes\n"));
7357 cdb = (struct scsi_report_supported_opcodes *)ctsio->cdb;
7358 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
7360 retval = CTL_RETVAL_COMPLETE;
7362 opcode = cdb->requested_opcode;
7363 service_action = scsi_2btoul(cdb->requested_service_action);
7364 switch (cdb->options & RSO_OPTIONS_MASK) {
7365 case RSO_OPTIONS_ALL:
7367 for (i = 0; i < 256; i++) {
7368 entry = &ctl_cmd_table[i];
7369 if (entry->flags & CTL_CMD_FLAG_SA5) {
7370 for (j = 0; j < 32; j++) {
7371 sentry = &((const struct ctl_cmd_entry *)
7373 if (ctl_cmd_applicable(
7374 lun->be_lun->lun_type, sentry))
7378 if (ctl_cmd_applicable(lun->be_lun->lun_type,
7383 total_len = sizeof(struct scsi_report_supported_opcodes_all) +
7384 num * sizeof(struct scsi_report_supported_opcodes_descr);
7386 case RSO_OPTIONS_OC:
7387 if (ctl_cmd_table[opcode].flags & CTL_CMD_FLAG_SA5) {
7388 ctl_set_invalid_field(/*ctsio*/ ctsio,
7394 ctl_done((union ctl_io *)ctsio);
7395 return (CTL_RETVAL_COMPLETE);
7397 total_len = sizeof(struct scsi_report_supported_opcodes_one) + 32;
7399 case RSO_OPTIONS_OC_SA:
7400 if ((ctl_cmd_table[opcode].flags & CTL_CMD_FLAG_SA5) == 0 ||
7401 service_action >= 32) {
7402 ctl_set_invalid_field(/*ctsio*/ ctsio,
7408 ctl_done((union ctl_io *)ctsio);
7409 return (CTL_RETVAL_COMPLETE);
7411 total_len = sizeof(struct scsi_report_supported_opcodes_one) + 32;
7414 ctl_set_invalid_field(/*ctsio*/ ctsio,
7420 ctl_done((union ctl_io *)ctsio);
7421 return (CTL_RETVAL_COMPLETE);
7424 alloc_len = scsi_4btoul(cdb->length);
7426 ctsio->kern_data_ptr = malloc(total_len, M_CTL, M_WAITOK | M_ZERO);
7428 ctsio->kern_sg_entries = 0;
7430 if (total_len < alloc_len) {
7431 ctsio->residual = alloc_len - total_len;
7432 ctsio->kern_data_len = total_len;
7433 ctsio->kern_total_len = total_len;
7435 ctsio->residual = 0;
7436 ctsio->kern_data_len = alloc_len;
7437 ctsio->kern_total_len = alloc_len;
7439 ctsio->kern_data_resid = 0;
7440 ctsio->kern_rel_offset = 0;
7442 switch (cdb->options & RSO_OPTIONS_MASK) {
7443 case RSO_OPTIONS_ALL:
7444 all = (struct scsi_report_supported_opcodes_all *)
7445 ctsio->kern_data_ptr;
7447 for (i = 0; i < 256; i++) {
7448 entry = &ctl_cmd_table[i];
7449 if (entry->flags & CTL_CMD_FLAG_SA5) {
7450 for (j = 0; j < 32; j++) {
7451 sentry = &((const struct ctl_cmd_entry *)
7453 if (!ctl_cmd_applicable(
7454 lun->be_lun->lun_type, sentry))
7456 descr = &all->descr[num++];
7458 scsi_ulto2b(j, descr->service_action);
7459 descr->flags = RSO_SERVACTV;
7460 scsi_ulto2b(sentry->length,
7464 if (!ctl_cmd_applicable(lun->be_lun->lun_type,
7467 descr = &all->descr[num++];
7469 scsi_ulto2b(0, descr->service_action);
7471 scsi_ulto2b(entry->length, descr->cdb_length);
7475 num * sizeof(struct scsi_report_supported_opcodes_descr),
7478 case RSO_OPTIONS_OC:
7479 one = (struct scsi_report_supported_opcodes_one *)
7480 ctsio->kern_data_ptr;
7481 entry = &ctl_cmd_table[opcode];
7483 case RSO_OPTIONS_OC_SA:
7484 one = (struct scsi_report_supported_opcodes_one *)
7485 ctsio->kern_data_ptr;
7486 entry = &ctl_cmd_table[opcode];
7487 entry = &((const struct ctl_cmd_entry *)
7488 entry->execute)[service_action];
7490 if (ctl_cmd_applicable(lun->be_lun->lun_type, entry)) {
7492 scsi_ulto2b(entry->length, one->cdb_length);
7493 one->cdb_usage[0] = opcode;
7494 memcpy(&one->cdb_usage[1], entry->usage,
7501 ctl_set_success(ctsio);
7502 ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
7503 ctsio->be_move_done = ctl_config_move_done;
7504 ctl_datamove((union ctl_io *)ctsio);
7509 ctl_report_supported_tmf(struct ctl_scsiio *ctsio)
7511 struct scsi_report_supported_tmf *cdb;
7512 struct scsi_report_supported_tmf_data *data;
7514 int alloc_len, total_len;
7516 CTL_DEBUG_PRINT(("ctl_report_supported_tmf\n"));
7518 cdb = (struct scsi_report_supported_tmf *)ctsio->cdb;
7520 retval = CTL_RETVAL_COMPLETE;
7522 total_len = sizeof(struct scsi_report_supported_tmf_data);
7523 alloc_len = scsi_4btoul(cdb->length);
7525 ctsio->kern_data_ptr = malloc(total_len, M_CTL, M_WAITOK | M_ZERO);
7527 ctsio->kern_sg_entries = 0;
7529 if (total_len < alloc_len) {
7530 ctsio->residual = alloc_len - total_len;
7531 ctsio->kern_data_len = total_len;
7532 ctsio->kern_total_len = total_len;
7534 ctsio->residual = 0;
7535 ctsio->kern_data_len = alloc_len;
7536 ctsio->kern_total_len = alloc_len;
7538 ctsio->kern_data_resid = 0;
7539 ctsio->kern_rel_offset = 0;
7541 data = (struct scsi_report_supported_tmf_data *)ctsio->kern_data_ptr;
7542 data->byte1 |= RST_ATS | RST_ATSS | RST_CTSS | RST_LURS | RST_QTS |
7544 data->byte2 |= RST_QAES | RST_QTSS | RST_ITNRS;
7546 ctl_set_success(ctsio);
7547 ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
7548 ctsio->be_move_done = ctl_config_move_done;
7549 ctl_datamove((union ctl_io *)ctsio);
7554 ctl_report_timestamp(struct ctl_scsiio *ctsio)
7556 struct scsi_report_timestamp *cdb;
7557 struct scsi_report_timestamp_data *data;
7561 int alloc_len, total_len;
7563 CTL_DEBUG_PRINT(("ctl_report_timestamp\n"));
7565 cdb = (struct scsi_report_timestamp *)ctsio->cdb;
7567 retval = CTL_RETVAL_COMPLETE;
7569 total_len = sizeof(struct scsi_report_timestamp_data);
7570 alloc_len = scsi_4btoul(cdb->length);
7572 ctsio->kern_data_ptr = malloc(total_len, M_CTL, M_WAITOK | M_ZERO);
7574 ctsio->kern_sg_entries = 0;
7576 if (total_len < alloc_len) {
7577 ctsio->residual = alloc_len - total_len;
7578 ctsio->kern_data_len = total_len;
7579 ctsio->kern_total_len = total_len;
7581 ctsio->residual = 0;
7582 ctsio->kern_data_len = alloc_len;
7583 ctsio->kern_total_len = alloc_len;
7585 ctsio->kern_data_resid = 0;
7586 ctsio->kern_rel_offset = 0;
7588 data = (struct scsi_report_timestamp_data *)ctsio->kern_data_ptr;
7589 scsi_ulto2b(sizeof(*data) - 2, data->length);
7590 data->origin = RTS_ORIG_OUTSIDE;
7592 timestamp = (int64_t)tv.tv_sec * 1000 + tv.tv_usec / 1000;
7593 scsi_ulto4b(timestamp >> 16, data->timestamp);
7594 scsi_ulto2b(timestamp & 0xffff, &data->timestamp[4]);
7596 ctl_set_success(ctsio);
7597 ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
7598 ctsio->be_move_done = ctl_config_move_done;
7599 ctl_datamove((union ctl_io *)ctsio);
7604 ctl_persistent_reserve_in(struct ctl_scsiio *ctsio)
7606 struct scsi_per_res_in *cdb;
7607 int alloc_len, total_len = 0;
7608 /* struct scsi_per_res_in_rsrv in_data; */
7609 struct ctl_lun *lun;
7610 struct ctl_softc *softc;
7613 CTL_DEBUG_PRINT(("ctl_persistent_reserve_in\n"));
7615 cdb = (struct scsi_per_res_in *)ctsio->cdb;
7617 alloc_len = scsi_2btoul(cdb->length);
7619 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
7620 softc = lun->ctl_softc;
7623 mtx_lock(&lun->lun_lock);
7624 switch (cdb->action) {
7625 case SPRI_RK: /* read keys */
7626 total_len = sizeof(struct scsi_per_res_in_keys) +
7628 sizeof(struct scsi_per_res_key);
7630 case SPRI_RR: /* read reservation */
7631 if (lun->flags & CTL_LUN_PR_RESERVED)
7632 total_len = sizeof(struct scsi_per_res_in_rsrv);
7634 total_len = sizeof(struct scsi_per_res_in_header);
7636 case SPRI_RC: /* report capabilities */
7637 total_len = sizeof(struct scsi_per_res_cap);
7639 case SPRI_RS: /* read full status */
7640 total_len = sizeof(struct scsi_per_res_in_header) +
7641 (sizeof(struct scsi_per_res_in_full_desc) + 256) *
7645 panic("%s: Invalid PR type %#x", __func__, cdb->action);
7647 mtx_unlock(&lun->lun_lock);
7649 ctsio->kern_data_ptr = malloc(total_len, M_CTL, M_WAITOK | M_ZERO);
7651 if (total_len < alloc_len) {
7652 ctsio->residual = alloc_len - total_len;
7653 ctsio->kern_data_len = total_len;
7654 ctsio->kern_total_len = total_len;
7656 ctsio->residual = 0;
7657 ctsio->kern_data_len = alloc_len;
7658 ctsio->kern_total_len = alloc_len;
7661 ctsio->kern_data_resid = 0;
7662 ctsio->kern_rel_offset = 0;
7663 ctsio->kern_sg_entries = 0;
7665 mtx_lock(&lun->lun_lock);
7666 switch (cdb->action) {
7667 case SPRI_RK: { // read keys
7668 struct scsi_per_res_in_keys *res_keys;
7671 res_keys = (struct scsi_per_res_in_keys*)ctsio->kern_data_ptr;
7674 * We had to drop the lock to allocate our buffer, which
7675 * leaves time for someone to come in with another
7676 * persistent reservation. (That is unlikely, though,
7677 * since this should be the only persistent reservation
7678 * command active right now.)
7680 if (total_len != (sizeof(struct scsi_per_res_in_keys) +
7681 (lun->pr_key_count *
7682 sizeof(struct scsi_per_res_key)))){
7683 mtx_unlock(&lun->lun_lock);
7684 free(ctsio->kern_data_ptr, M_CTL);
7685 printf("%s: reservation length changed, retrying\n",
7690 scsi_ulto4b(lun->pr_generation, res_keys->header.generation);
7692 scsi_ulto4b(sizeof(struct scsi_per_res_key) *
7693 lun->pr_key_count, res_keys->header.length);
7695 for (i = 0, key_count = 0; i < CTL_MAX_INITIATORS; i++) {
7696 if ((key = ctl_get_prkey(lun, i)) == 0)
7700 * We used lun->pr_key_count to calculate the
7701 * size to allocate. If it turns out the number of
7702 * initiators with the registered flag set is
7703 * larger than that (i.e. they haven't been kept in
7704 * sync), we've got a problem.
7706 if (key_count >= lun->pr_key_count) {
7710 scsi_u64to8b(key, res_keys->keys[key_count].key);
7715 case SPRI_RR: { // read reservation
7716 struct scsi_per_res_in_rsrv *res;
7717 int tmp_len, header_only;
7719 res = (struct scsi_per_res_in_rsrv *)ctsio->kern_data_ptr;
7721 scsi_ulto4b(lun->pr_generation, res->header.generation);
7723 if (lun->flags & CTL_LUN_PR_RESERVED)
7725 tmp_len = sizeof(struct scsi_per_res_in_rsrv);
7726 scsi_ulto4b(sizeof(struct scsi_per_res_in_rsrv_data),
7727 res->header.length);
7730 tmp_len = sizeof(struct scsi_per_res_in_header);
7731 scsi_ulto4b(0, res->header.length);
7736 * We had to drop the lock to allocate our buffer, which
7737 * leaves time for someone to come in with another
7738 * persistent reservation. (That is unlikely, though,
7739 * since this should be the only persistent reservation
7740 * command active right now.)
7742 if (tmp_len != total_len) {
7743 mtx_unlock(&lun->lun_lock);
7744 free(ctsio->kern_data_ptr, M_CTL);
7745 printf("%s: reservation status changed, retrying\n",
7751 * No reservation held, so we're done.
7753 if (header_only != 0)
7757 * If the registration is an All Registrants type, the key
7758 * is 0, since it doesn't really matter.
7760 if (lun->pr_res_idx != CTL_PR_ALL_REGISTRANTS) {
7761 scsi_u64to8b(ctl_get_prkey(lun, lun->pr_res_idx),
7762 res->data.reservation);
7764 res->data.scopetype = lun->pr_res_type;
7767 case SPRI_RC: //report capabilities
7769 struct scsi_per_res_cap *res_cap;
7772 res_cap = (struct scsi_per_res_cap *)ctsio->kern_data_ptr;
7773 scsi_ulto2b(sizeof(*res_cap), res_cap->length);
7774 res_cap->flags1 = SPRI_CRH;
7775 res_cap->flags2 = SPRI_TMV | SPRI_ALLOW_5;
7776 type_mask = SPRI_TM_WR_EX_AR |
7782 scsi_ulto2b(type_mask, res_cap->type_mask);
7785 case SPRI_RS: { // read full status
7786 struct scsi_per_res_in_full *res_status;
7787 struct scsi_per_res_in_full_desc *res_desc;
7788 struct ctl_port *port;
7791 res_status = (struct scsi_per_res_in_full*)ctsio->kern_data_ptr;
7794 * We had to drop the lock to allocate our buffer, which
7795 * leaves time for someone to come in with another
7796 * persistent reservation. (That is unlikely, though,
7797 * since this should be the only persistent reservation
7798 * command active right now.)
7800 if (total_len < (sizeof(struct scsi_per_res_in_header) +
7801 (sizeof(struct scsi_per_res_in_full_desc) + 256) *
7802 lun->pr_key_count)){
7803 mtx_unlock(&lun->lun_lock);
7804 free(ctsio->kern_data_ptr, M_CTL);
7805 printf("%s: reservation length changed, retrying\n",
7810 scsi_ulto4b(lun->pr_generation, res_status->header.generation);
7812 res_desc = &res_status->desc[0];
7813 for (i = 0; i < CTL_MAX_INITIATORS; i++) {
7814 if ((key = ctl_get_prkey(lun, i)) == 0)
7817 scsi_u64to8b(key, res_desc->res_key.key);
7818 if ((lun->flags & CTL_LUN_PR_RESERVED) &&
7819 (lun->pr_res_idx == i ||
7820 lun->pr_res_idx == CTL_PR_ALL_REGISTRANTS)) {
7821 res_desc->flags = SPRI_FULL_R_HOLDER;
7822 res_desc->scopetype = lun->pr_res_type;
7824 scsi_ulto2b(i / CTL_MAX_INIT_PER_PORT,
7825 res_desc->rel_trgt_port_id);
7827 port = softc->ctl_ports[i / CTL_MAX_INIT_PER_PORT];
7829 len = ctl_create_iid(port,
7830 i % CTL_MAX_INIT_PER_PORT,
7831 res_desc->transport_id);
7832 scsi_ulto4b(len, res_desc->additional_length);
7833 res_desc = (struct scsi_per_res_in_full_desc *)
7834 &res_desc->transport_id[len];
7836 scsi_ulto4b((uint8_t *)res_desc - (uint8_t *)&res_status->desc[0],
7837 res_status->header.length);
7841 panic("%s: Invalid PR type %#x", __func__, cdb->action);
7843 mtx_unlock(&lun->lun_lock);
7845 ctl_set_success(ctsio);
7846 ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
7847 ctsio->be_move_done = ctl_config_move_done;
7848 ctl_datamove((union ctl_io *)ctsio);
7849 return (CTL_RETVAL_COMPLETE);
7853 * Returns 0 if ctl_persistent_reserve_out() should continue, non-zero if
7857 ctl_pro_preempt(struct ctl_softc *softc, struct ctl_lun *lun, uint64_t res_key,
7858 uint64_t sa_res_key, uint8_t type, uint32_t residx,
7859 struct ctl_scsiio *ctsio, struct scsi_per_res_out *cdb,
7860 struct scsi_per_res_out_parms* param)
7862 union ctl_ha_msg persis_io;
7865 mtx_lock(&lun->lun_lock);
7866 if (sa_res_key == 0) {
7867 if (lun->pr_res_idx == CTL_PR_ALL_REGISTRANTS) {
7868 /* validate scope and type */
7869 if ((cdb->scope_type & SPR_SCOPE_MASK) !=
7871 mtx_unlock(&lun->lun_lock);
7872 ctl_set_invalid_field(/*ctsio*/ ctsio,
7878 ctl_done((union ctl_io *)ctsio);
7882 if (type>8 || type==2 || type==4 || type==0) {
7883 mtx_unlock(&lun->lun_lock);
7884 ctl_set_invalid_field(/*ctsio*/ ctsio,
7890 ctl_done((union ctl_io *)ctsio);
7895 * Unregister everybody else and build UA for
7898 for(i = 0; i < CTL_MAX_INITIATORS; i++) {
7899 if (i == residx || ctl_get_prkey(lun, i) == 0)
7902 ctl_clr_prkey(lun, i);
7903 ctl_est_ua(lun, i, CTL_UA_REG_PREEMPT);
7905 lun->pr_key_count = 1;
7906 lun->pr_res_type = type;
7907 if (lun->pr_res_type != SPR_TYPE_WR_EX_AR &&
7908 lun->pr_res_type != SPR_TYPE_EX_AC_AR)
7909 lun->pr_res_idx = residx;
7910 lun->pr_generation++;
7911 mtx_unlock(&lun->lun_lock);
7913 /* send msg to other side */
7914 persis_io.hdr.nexus = ctsio->io_hdr.nexus;
7915 persis_io.hdr.msg_type = CTL_MSG_PERS_ACTION;
7916 persis_io.pr.pr_info.action = CTL_PR_PREEMPT;
7917 persis_io.pr.pr_info.residx = lun->pr_res_idx;
7918 persis_io.pr.pr_info.res_type = type;
7919 memcpy(persis_io.pr.pr_info.sa_res_key,
7920 param->serv_act_res_key,
7921 sizeof(param->serv_act_res_key));
7922 ctl_ha_msg_send(CTL_HA_CHAN_CTL, &persis_io,
7923 sizeof(persis_io.pr), M_WAITOK);
7925 /* not all registrants */
7926 mtx_unlock(&lun->lun_lock);
7927 free(ctsio->kern_data_ptr, M_CTL);
7928 ctl_set_invalid_field(ctsio,
7934 ctl_done((union ctl_io *)ctsio);
7937 } else if (lun->pr_res_idx == CTL_PR_ALL_REGISTRANTS
7938 || !(lun->flags & CTL_LUN_PR_RESERVED)) {
7941 if (res_key == sa_res_key) {
7944 * The spec implies this is not good but doesn't
7945 * say what to do. There are two choices either
7946 * generate a res conflict or check condition
7947 * with illegal field in parameter data. Since
7948 * that is what is done when the sa_res_key is
7949 * zero I'll take that approach since this has
7950 * to do with the sa_res_key.
7952 mtx_unlock(&lun->lun_lock);
7953 free(ctsio->kern_data_ptr, M_CTL);
7954 ctl_set_invalid_field(ctsio,
7960 ctl_done((union ctl_io *)ctsio);
7964 for (i = 0; i < CTL_MAX_INITIATORS; i++) {
7965 if (ctl_get_prkey(lun, i) != sa_res_key)
7969 ctl_clr_prkey(lun, i);
7970 lun->pr_key_count--;
7971 ctl_est_ua(lun, i, CTL_UA_REG_PREEMPT);
7974 mtx_unlock(&lun->lun_lock);
7975 free(ctsio->kern_data_ptr, M_CTL);
7976 ctl_set_reservation_conflict(ctsio);
7977 ctl_done((union ctl_io *)ctsio);
7978 return (CTL_RETVAL_COMPLETE);
7980 lun->pr_generation++;
7981 mtx_unlock(&lun->lun_lock);
7983 /* send msg to other side */
7984 persis_io.hdr.nexus = ctsio->io_hdr.nexus;
7985 persis_io.hdr.msg_type = CTL_MSG_PERS_ACTION;
7986 persis_io.pr.pr_info.action = CTL_PR_PREEMPT;
7987 persis_io.pr.pr_info.residx = lun->pr_res_idx;
7988 persis_io.pr.pr_info.res_type = type;
7989 memcpy(persis_io.pr.pr_info.sa_res_key,
7990 param->serv_act_res_key,
7991 sizeof(param->serv_act_res_key));
7992 ctl_ha_msg_send(CTL_HA_CHAN_CTL, &persis_io,
7993 sizeof(persis_io.pr), M_WAITOK);
7995 /* Reserved but not all registrants */
7996 /* sa_res_key is res holder */
7997 if (sa_res_key == ctl_get_prkey(lun, lun->pr_res_idx)) {
7998 /* validate scope and type */
7999 if ((cdb->scope_type & SPR_SCOPE_MASK) !=
8001 mtx_unlock(&lun->lun_lock);
8002 ctl_set_invalid_field(/*ctsio*/ ctsio,
8008 ctl_done((union ctl_io *)ctsio);
8012 if (type>8 || type==2 || type==4 || type==0) {
8013 mtx_unlock(&lun->lun_lock);
8014 ctl_set_invalid_field(/*ctsio*/ ctsio,
8020 ctl_done((union ctl_io *)ctsio);
8026 * if sa_res_key != res_key remove all
8027 * registrants w/sa_res_key and generate UA
8028 * for these registrants(Registrations
8029 * Preempted) if it wasn't an exclusive
8030 * reservation generate UA(Reservations
8031 * Preempted) for all other registered nexuses
8032 * if the type has changed. Establish the new
8033 * reservation and holder. If res_key and
8034 * sa_res_key are the same do the above
8035 * except don't unregister the res holder.
8038 for(i = 0; i < CTL_MAX_INITIATORS; i++) {
8039 if (i == residx || ctl_get_prkey(lun, i) == 0)
8042 if (sa_res_key == ctl_get_prkey(lun, i)) {
8043 ctl_clr_prkey(lun, i);
8044 lun->pr_key_count--;
8045 ctl_est_ua(lun, i, CTL_UA_REG_PREEMPT);
8046 } else if (type != lun->pr_res_type &&
8047 (lun->pr_res_type == SPR_TYPE_WR_EX_RO ||
8048 lun->pr_res_type == SPR_TYPE_EX_AC_RO)) {
8049 ctl_est_ua(lun, i, CTL_UA_RES_RELEASE);
8052 lun->pr_res_type = type;
8053 if (lun->pr_res_type != SPR_TYPE_WR_EX_AR &&
8054 lun->pr_res_type != SPR_TYPE_EX_AC_AR)
8055 lun->pr_res_idx = residx;
8057 lun->pr_res_idx = CTL_PR_ALL_REGISTRANTS;
8058 lun->pr_generation++;
8059 mtx_unlock(&lun->lun_lock);
8061 persis_io.hdr.nexus = ctsio->io_hdr.nexus;
8062 persis_io.hdr.msg_type = CTL_MSG_PERS_ACTION;
8063 persis_io.pr.pr_info.action = CTL_PR_PREEMPT;
8064 persis_io.pr.pr_info.residx = lun->pr_res_idx;
8065 persis_io.pr.pr_info.res_type = type;
8066 memcpy(persis_io.pr.pr_info.sa_res_key,
8067 param->serv_act_res_key,
8068 sizeof(param->serv_act_res_key));
8069 ctl_ha_msg_send(CTL_HA_CHAN_CTL, &persis_io,
8070 sizeof(persis_io.pr), M_WAITOK);
8073 * sa_res_key is not the res holder just
8074 * remove registrants
8078 for (i = 0; i < CTL_MAX_INITIATORS; i++) {
8079 if (sa_res_key != ctl_get_prkey(lun, i))
8083 ctl_clr_prkey(lun, i);
8084 lun->pr_key_count--;
8085 ctl_est_ua(lun, i, CTL_UA_REG_PREEMPT);
8089 mtx_unlock(&lun->lun_lock);
8090 free(ctsio->kern_data_ptr, M_CTL);
8091 ctl_set_reservation_conflict(ctsio);
8092 ctl_done((union ctl_io *)ctsio);
8095 lun->pr_generation++;
8096 mtx_unlock(&lun->lun_lock);
8098 persis_io.hdr.nexus = ctsio->io_hdr.nexus;
8099 persis_io.hdr.msg_type = CTL_MSG_PERS_ACTION;
8100 persis_io.pr.pr_info.action = CTL_PR_PREEMPT;
8101 persis_io.pr.pr_info.residx = lun->pr_res_idx;
8102 persis_io.pr.pr_info.res_type = type;
8103 memcpy(persis_io.pr.pr_info.sa_res_key,
8104 param->serv_act_res_key,
8105 sizeof(param->serv_act_res_key));
8106 ctl_ha_msg_send(CTL_HA_CHAN_CTL, &persis_io,
8107 sizeof(persis_io.pr), M_WAITOK);
8114 ctl_pro_preempt_other(struct ctl_lun *lun, union ctl_ha_msg *msg)
8116 uint64_t sa_res_key;
8119 sa_res_key = scsi_8btou64(msg->pr.pr_info.sa_res_key);
8121 if (lun->pr_res_idx == CTL_PR_ALL_REGISTRANTS
8122 || lun->pr_res_idx == CTL_PR_NO_RESERVATION
8123 || sa_res_key != ctl_get_prkey(lun, lun->pr_res_idx)) {
8124 if (sa_res_key == 0) {
8126 * Unregister everybody else and build UA for
8129 for(i = 0; i < CTL_MAX_INITIATORS; i++) {
8130 if (i == msg->pr.pr_info.residx ||
8131 ctl_get_prkey(lun, i) == 0)
8134 ctl_clr_prkey(lun, i);
8135 ctl_est_ua(lun, i, CTL_UA_REG_PREEMPT);
8138 lun->pr_key_count = 1;
8139 lun->pr_res_type = msg->pr.pr_info.res_type;
8140 if (lun->pr_res_type != SPR_TYPE_WR_EX_AR &&
8141 lun->pr_res_type != SPR_TYPE_EX_AC_AR)
8142 lun->pr_res_idx = msg->pr.pr_info.residx;
8144 for (i = 0; i < CTL_MAX_INITIATORS; i++) {
8145 if (sa_res_key == ctl_get_prkey(lun, i))
8148 ctl_clr_prkey(lun, i);
8149 lun->pr_key_count--;
8150 ctl_est_ua(lun, i, CTL_UA_REG_PREEMPT);
8154 for (i = 0; i < CTL_MAX_INITIATORS; i++) {
8155 if (i == msg->pr.pr_info.residx ||
8156 ctl_get_prkey(lun, i) == 0)
8159 if (sa_res_key == ctl_get_prkey(lun, i)) {
8160 ctl_clr_prkey(lun, i);
8161 lun->pr_key_count--;
8162 ctl_est_ua(lun, i, CTL_UA_REG_PREEMPT);
8163 } else if (msg->pr.pr_info.res_type != lun->pr_res_type
8164 && (lun->pr_res_type == SPR_TYPE_WR_EX_RO ||
8165 lun->pr_res_type == SPR_TYPE_EX_AC_RO)) {
8166 ctl_est_ua(lun, i, CTL_UA_RES_RELEASE);
8169 lun->pr_res_type = msg->pr.pr_info.res_type;
8170 if (lun->pr_res_type != SPR_TYPE_WR_EX_AR &&
8171 lun->pr_res_type != SPR_TYPE_EX_AC_AR)
8172 lun->pr_res_idx = msg->pr.pr_info.residx;
8174 lun->pr_res_idx = CTL_PR_ALL_REGISTRANTS;
8176 lun->pr_generation++;
8182 ctl_persistent_reserve_out(struct ctl_scsiio *ctsio)
8185 u_int32_t param_len;
8186 struct scsi_per_res_out *cdb;
8187 struct ctl_lun *lun;
8188 struct scsi_per_res_out_parms* param;
8189 struct ctl_softc *softc;
8191 uint64_t res_key, sa_res_key, key;
8193 union ctl_ha_msg persis_io;
8196 CTL_DEBUG_PRINT(("ctl_persistent_reserve_out\n"));
8198 retval = CTL_RETVAL_COMPLETE;
8200 cdb = (struct scsi_per_res_out *)ctsio->cdb;
8201 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
8202 softc = lun->ctl_softc;
8205 * We only support whole-LUN scope. The scope & type are ignored for
8206 * register, register and ignore existing key and clear.
8207 * We sometimes ignore scope and type on preempts too!!
8208 * Verify reservation type here as well.
8210 type = cdb->scope_type & SPR_TYPE_MASK;
8211 if ((cdb->action == SPRO_RESERVE)
8212 || (cdb->action == SPRO_RELEASE)) {
8213 if ((cdb->scope_type & SPR_SCOPE_MASK) != SPR_LU_SCOPE) {
8214 ctl_set_invalid_field(/*ctsio*/ ctsio,
8220 ctl_done((union ctl_io *)ctsio);
8221 return (CTL_RETVAL_COMPLETE);
8224 if (type>8 || type==2 || type==4 || type==0) {
8225 ctl_set_invalid_field(/*ctsio*/ ctsio,
8231 ctl_done((union ctl_io *)ctsio);
8232 return (CTL_RETVAL_COMPLETE);
8236 param_len = scsi_4btoul(cdb->length);
8238 if ((ctsio->io_hdr.flags & CTL_FLAG_ALLOCATED) == 0) {
8239 ctsio->kern_data_ptr = malloc(param_len, M_CTL, M_WAITOK);
8240 ctsio->kern_data_len = param_len;
8241 ctsio->kern_total_len = param_len;
8242 ctsio->kern_data_resid = 0;
8243 ctsio->kern_rel_offset = 0;
8244 ctsio->kern_sg_entries = 0;
8245 ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
8246 ctsio->be_move_done = ctl_config_move_done;
8247 ctl_datamove((union ctl_io *)ctsio);
8249 return (CTL_RETVAL_COMPLETE);
8252 param = (struct scsi_per_res_out_parms *)ctsio->kern_data_ptr;
8254 residx = ctl_get_initindex(&ctsio->io_hdr.nexus);
8255 res_key = scsi_8btou64(param->res_key.key);
8256 sa_res_key = scsi_8btou64(param->serv_act_res_key);
8259 * Validate the reservation key here except for SPRO_REG_IGNO
8260 * This must be done for all other service actions
8262 if ((cdb->action & SPRO_ACTION_MASK) != SPRO_REG_IGNO) {
8263 mtx_lock(&lun->lun_lock);
8264 if ((key = ctl_get_prkey(lun, residx)) != 0) {
8265 if (res_key != key) {
8267 * The current key passed in doesn't match
8268 * the one the initiator previously
8271 mtx_unlock(&lun->lun_lock);
8272 free(ctsio->kern_data_ptr, M_CTL);
8273 ctl_set_reservation_conflict(ctsio);
8274 ctl_done((union ctl_io *)ctsio);
8275 return (CTL_RETVAL_COMPLETE);
8277 } else if ((cdb->action & SPRO_ACTION_MASK) != SPRO_REGISTER) {
8279 * We are not registered
8281 mtx_unlock(&lun->lun_lock);
8282 free(ctsio->kern_data_ptr, M_CTL);
8283 ctl_set_reservation_conflict(ctsio);
8284 ctl_done((union ctl_io *)ctsio);
8285 return (CTL_RETVAL_COMPLETE);
8286 } else if (res_key != 0) {
8288 * We are not registered and trying to register but
8289 * the register key isn't zero.
8291 mtx_unlock(&lun->lun_lock);
8292 free(ctsio->kern_data_ptr, M_CTL);
8293 ctl_set_reservation_conflict(ctsio);
8294 ctl_done((union ctl_io *)ctsio);
8295 return (CTL_RETVAL_COMPLETE);
8297 mtx_unlock(&lun->lun_lock);
8300 switch (cdb->action & SPRO_ACTION_MASK) {
8302 case SPRO_REG_IGNO: {
8305 printf("Registration received\n");
8309 * We don't support any of these options, as we report in
8310 * the read capabilities request (see
8311 * ctl_persistent_reserve_in(), above).
8313 if ((param->flags & SPR_SPEC_I_PT)
8314 || (param->flags & SPR_ALL_TG_PT)
8315 || (param->flags & SPR_APTPL)) {
8318 if (param->flags & SPR_APTPL)
8320 else if (param->flags & SPR_ALL_TG_PT)
8322 else /* SPR_SPEC_I_PT */
8325 free(ctsio->kern_data_ptr, M_CTL);
8326 ctl_set_invalid_field(ctsio,
8332 ctl_done((union ctl_io *)ctsio);
8333 return (CTL_RETVAL_COMPLETE);
8336 mtx_lock(&lun->lun_lock);
8339 * The initiator wants to clear the
8342 if (sa_res_key == 0) {
8344 && (cdb->action & SPRO_ACTION_MASK) == SPRO_REGISTER)
8345 || ((cdb->action & SPRO_ACTION_MASK) == SPRO_REG_IGNO
8346 && ctl_get_prkey(lun, residx) == 0)) {
8347 mtx_unlock(&lun->lun_lock);
8351 ctl_clr_prkey(lun, residx);
8352 lun->pr_key_count--;
8354 if (residx == lun->pr_res_idx) {
8355 lun->flags &= ~CTL_LUN_PR_RESERVED;
8356 lun->pr_res_idx = CTL_PR_NO_RESERVATION;
8358 if ((lun->pr_res_type == SPR_TYPE_WR_EX_RO ||
8359 lun->pr_res_type == SPR_TYPE_EX_AC_RO) &&
8360 lun->pr_key_count) {
8362 * If the reservation is a registrants
8363 * only type we need to generate a UA
8364 * for other registered inits. The
8365 * sense code should be RESERVATIONS
8369 for (i = softc->init_min; i < softc->init_max; i++){
8370 if (ctl_get_prkey(lun, i) == 0)
8373 CTL_UA_RES_RELEASE);
8376 lun->pr_res_type = 0;
8377 } else if (lun->pr_res_idx == CTL_PR_ALL_REGISTRANTS) {
8378 if (lun->pr_key_count==0) {
8379 lun->flags &= ~CTL_LUN_PR_RESERVED;
8380 lun->pr_res_type = 0;
8381 lun->pr_res_idx = CTL_PR_NO_RESERVATION;
8384 lun->pr_generation++;
8385 mtx_unlock(&lun->lun_lock);
8387 persis_io.hdr.nexus = ctsio->io_hdr.nexus;
8388 persis_io.hdr.msg_type = CTL_MSG_PERS_ACTION;
8389 persis_io.pr.pr_info.action = CTL_PR_UNREG_KEY;
8390 persis_io.pr.pr_info.residx = residx;
8391 ctl_ha_msg_send(CTL_HA_CHAN_CTL, &persis_io,
8392 sizeof(persis_io.pr), M_WAITOK);
8393 } else /* sa_res_key != 0 */ {
8396 * If we aren't registered currently then increment
8397 * the key count and set the registered flag.
8399 ctl_alloc_prkey(lun, residx);
8400 if (ctl_get_prkey(lun, residx) == 0)
8401 lun->pr_key_count++;
8402 ctl_set_prkey(lun, residx, sa_res_key);
8403 lun->pr_generation++;
8404 mtx_unlock(&lun->lun_lock);
8406 persis_io.hdr.nexus = ctsio->io_hdr.nexus;
8407 persis_io.hdr.msg_type = CTL_MSG_PERS_ACTION;
8408 persis_io.pr.pr_info.action = CTL_PR_REG_KEY;
8409 persis_io.pr.pr_info.residx = residx;
8410 memcpy(persis_io.pr.pr_info.sa_res_key,
8411 param->serv_act_res_key,
8412 sizeof(param->serv_act_res_key));
8413 ctl_ha_msg_send(CTL_HA_CHAN_CTL, &persis_io,
8414 sizeof(persis_io.pr), M_WAITOK);
8421 printf("Reserve executed type %d\n", type);
8423 mtx_lock(&lun->lun_lock);
8424 if (lun->flags & CTL_LUN_PR_RESERVED) {
8426 * if this isn't the reservation holder and it's
8427 * not a "all registrants" type or if the type is
8428 * different then we have a conflict
8430 if ((lun->pr_res_idx != residx
8431 && lun->pr_res_idx != CTL_PR_ALL_REGISTRANTS)
8432 || lun->pr_res_type != type) {
8433 mtx_unlock(&lun->lun_lock);
8434 free(ctsio->kern_data_ptr, M_CTL);
8435 ctl_set_reservation_conflict(ctsio);
8436 ctl_done((union ctl_io *)ctsio);
8437 return (CTL_RETVAL_COMPLETE);
8439 mtx_unlock(&lun->lun_lock);
8440 } else /* create a reservation */ {
8442 * If it's not an "all registrants" type record
8443 * reservation holder
8445 if (type != SPR_TYPE_WR_EX_AR
8446 && type != SPR_TYPE_EX_AC_AR)
8447 lun->pr_res_idx = residx; /* Res holder */
8449 lun->pr_res_idx = CTL_PR_ALL_REGISTRANTS;
8451 lun->flags |= CTL_LUN_PR_RESERVED;
8452 lun->pr_res_type = type;
8454 mtx_unlock(&lun->lun_lock);
8456 /* send msg to other side */
8457 persis_io.hdr.nexus = ctsio->io_hdr.nexus;
8458 persis_io.hdr.msg_type = CTL_MSG_PERS_ACTION;
8459 persis_io.pr.pr_info.action = CTL_PR_RESERVE;
8460 persis_io.pr.pr_info.residx = lun->pr_res_idx;
8461 persis_io.pr.pr_info.res_type = type;
8462 ctl_ha_msg_send(CTL_HA_CHAN_CTL, &persis_io,
8463 sizeof(persis_io.pr), M_WAITOK);
8468 mtx_lock(&lun->lun_lock);
8469 if ((lun->flags & CTL_LUN_PR_RESERVED) == 0) {
8470 /* No reservation exists return good status */
8471 mtx_unlock(&lun->lun_lock);
8475 * Is this nexus a reservation holder?
8477 if (lun->pr_res_idx != residx
8478 && lun->pr_res_idx != CTL_PR_ALL_REGISTRANTS) {
8480 * not a res holder return good status but
8483 mtx_unlock(&lun->lun_lock);
8487 if (lun->pr_res_type != type) {
8488 mtx_unlock(&lun->lun_lock);
8489 free(ctsio->kern_data_ptr, M_CTL);
8490 ctl_set_illegal_pr_release(ctsio);
8491 ctl_done((union ctl_io *)ctsio);
8492 return (CTL_RETVAL_COMPLETE);
8495 /* okay to release */
8496 lun->flags &= ~CTL_LUN_PR_RESERVED;
8497 lun->pr_res_idx = CTL_PR_NO_RESERVATION;
8498 lun->pr_res_type = 0;
8501 * if this isn't an exclusive access
8502 * res generate UA for all other
8505 if (type != SPR_TYPE_EX_AC
8506 && type != SPR_TYPE_WR_EX) {
8507 for (i = softc->init_min; i < softc->init_max; i++) {
8508 if (i == residx || ctl_get_prkey(lun, i) == 0)
8510 ctl_est_ua(lun, i, CTL_UA_RES_RELEASE);
8513 mtx_unlock(&lun->lun_lock);
8515 /* Send msg to other side */
8516 persis_io.hdr.nexus = ctsio->io_hdr.nexus;
8517 persis_io.hdr.msg_type = CTL_MSG_PERS_ACTION;
8518 persis_io.pr.pr_info.action = CTL_PR_RELEASE;
8519 ctl_ha_msg_send(CTL_HA_CHAN_CTL, &persis_io,
8520 sizeof(persis_io.pr), M_WAITOK);
8524 /* send msg to other side */
8526 mtx_lock(&lun->lun_lock);
8527 lun->flags &= ~CTL_LUN_PR_RESERVED;
8528 lun->pr_res_type = 0;
8529 lun->pr_key_count = 0;
8530 lun->pr_res_idx = CTL_PR_NO_RESERVATION;
8532 ctl_clr_prkey(lun, residx);
8533 for (i = 0; i < CTL_MAX_INITIATORS; i++)
8534 if (ctl_get_prkey(lun, i) != 0) {
8535 ctl_clr_prkey(lun, i);
8536 ctl_est_ua(lun, i, CTL_UA_REG_PREEMPT);
8538 lun->pr_generation++;
8539 mtx_unlock(&lun->lun_lock);
8541 persis_io.hdr.nexus = ctsio->io_hdr.nexus;
8542 persis_io.hdr.msg_type = CTL_MSG_PERS_ACTION;
8543 persis_io.pr.pr_info.action = CTL_PR_CLEAR;
8544 ctl_ha_msg_send(CTL_HA_CHAN_CTL, &persis_io,
8545 sizeof(persis_io.pr), M_WAITOK);
8549 case SPRO_PRE_ABO: {
8552 nretval = ctl_pro_preempt(softc, lun, res_key, sa_res_key, type,
8553 residx, ctsio, cdb, param);
8555 return (CTL_RETVAL_COMPLETE);
8559 panic("%s: Invalid PR type %#x", __func__, cdb->action);
8563 free(ctsio->kern_data_ptr, M_CTL);
8564 ctl_set_success(ctsio);
8565 ctl_done((union ctl_io *)ctsio);
8571 * This routine is for handling a message from the other SC pertaining to
8572 * persistent reserve out. All the error checking will have been done
8573 * so only perorming the action need be done here to keep the two
8577 ctl_hndl_per_res_out_on_other_sc(union ctl_ha_msg *msg)
8579 struct ctl_softc *softc = control_softc;
8580 struct ctl_lun *lun;
8582 uint32_t residx, targ_lun;
8584 targ_lun = msg->hdr.nexus.targ_mapped_lun;
8585 mtx_lock(&softc->ctl_lock);
8586 if ((targ_lun >= CTL_MAX_LUNS) ||
8587 ((lun = softc->ctl_luns[targ_lun]) == NULL)) {
8588 mtx_unlock(&softc->ctl_lock);
8591 mtx_lock(&lun->lun_lock);
8592 mtx_unlock(&softc->ctl_lock);
8593 if (lun->flags & CTL_LUN_DISABLED) {
8594 mtx_unlock(&lun->lun_lock);
8597 residx = ctl_get_initindex(&msg->hdr.nexus);
8598 switch(msg->pr.pr_info.action) {
8599 case CTL_PR_REG_KEY:
8600 ctl_alloc_prkey(lun, msg->pr.pr_info.residx);
8601 if (ctl_get_prkey(lun, msg->pr.pr_info.residx) == 0)
8602 lun->pr_key_count++;
8603 ctl_set_prkey(lun, msg->pr.pr_info.residx,
8604 scsi_8btou64(msg->pr.pr_info.sa_res_key));
8605 lun->pr_generation++;
8608 case CTL_PR_UNREG_KEY:
8609 ctl_clr_prkey(lun, msg->pr.pr_info.residx);
8610 lun->pr_key_count--;
8612 /* XXX Need to see if the reservation has been released */
8613 /* if so do we need to generate UA? */
8614 if (msg->pr.pr_info.residx == lun->pr_res_idx) {
8615 lun->flags &= ~CTL_LUN_PR_RESERVED;
8616 lun->pr_res_idx = CTL_PR_NO_RESERVATION;
8618 if ((lun->pr_res_type == SPR_TYPE_WR_EX_RO ||
8619 lun->pr_res_type == SPR_TYPE_EX_AC_RO) &&
8620 lun->pr_key_count) {
8622 * If the reservation is a registrants
8623 * only type we need to generate a UA
8624 * for other registered inits. The
8625 * sense code should be RESERVATIONS
8629 for (i = softc->init_min; i < softc->init_max; i++) {
8630 if (ctl_get_prkey(lun, i) == 0)
8633 ctl_est_ua(lun, i, CTL_UA_RES_RELEASE);
8636 lun->pr_res_type = 0;
8637 } else if (lun->pr_res_idx == CTL_PR_ALL_REGISTRANTS) {
8638 if (lun->pr_key_count==0) {
8639 lun->flags &= ~CTL_LUN_PR_RESERVED;
8640 lun->pr_res_type = 0;
8641 lun->pr_res_idx = CTL_PR_NO_RESERVATION;
8644 lun->pr_generation++;
8647 case CTL_PR_RESERVE:
8648 lun->flags |= CTL_LUN_PR_RESERVED;
8649 lun->pr_res_type = msg->pr.pr_info.res_type;
8650 lun->pr_res_idx = msg->pr.pr_info.residx;
8654 case CTL_PR_RELEASE:
8656 * if this isn't an exclusive access res generate UA for all
8657 * other registrants.
8659 if (lun->pr_res_type != SPR_TYPE_EX_AC &&
8660 lun->pr_res_type != SPR_TYPE_WR_EX) {
8661 for (i = softc->init_min; i < softc->init_max; i++)
8662 if (i == residx || ctl_get_prkey(lun, i) == 0)
8664 ctl_est_ua(lun, i, CTL_UA_RES_RELEASE);
8667 lun->flags &= ~CTL_LUN_PR_RESERVED;
8668 lun->pr_res_idx = CTL_PR_NO_RESERVATION;
8669 lun->pr_res_type = 0;
8672 case CTL_PR_PREEMPT:
8673 ctl_pro_preempt_other(lun, msg);
8676 lun->flags &= ~CTL_LUN_PR_RESERVED;
8677 lun->pr_res_type = 0;
8678 lun->pr_key_count = 0;
8679 lun->pr_res_idx = CTL_PR_NO_RESERVATION;
8681 for (i=0; i < CTL_MAX_INITIATORS; i++) {
8682 if (ctl_get_prkey(lun, i) == 0)
8684 ctl_clr_prkey(lun, i);
8685 ctl_est_ua(lun, i, CTL_UA_REG_PREEMPT);
8687 lun->pr_generation++;
8691 mtx_unlock(&lun->lun_lock);
8695 ctl_read_write(struct ctl_scsiio *ctsio)
8697 struct ctl_lun *lun;
8698 struct ctl_lba_len_flags *lbalen;
8700 uint32_t num_blocks;
8704 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
8706 CTL_DEBUG_PRINT(("ctl_read_write: command: %#x\n", ctsio->cdb[0]));
8709 isread = ctsio->cdb[0] == READ_6 || ctsio->cdb[0] == READ_10
8710 || ctsio->cdb[0] == READ_12 || ctsio->cdb[0] == READ_16;
8711 switch (ctsio->cdb[0]) {
8714 struct scsi_rw_6 *cdb;
8716 cdb = (struct scsi_rw_6 *)ctsio->cdb;
8718 lba = scsi_3btoul(cdb->addr);
8719 /* only 5 bits are valid in the most significant address byte */
8721 num_blocks = cdb->length;
8723 * This is correct according to SBC-2.
8725 if (num_blocks == 0)
8731 struct scsi_rw_10 *cdb;
8733 cdb = (struct scsi_rw_10 *)ctsio->cdb;
8734 if (cdb->byte2 & SRW10_FUA)
8735 flags |= CTL_LLF_FUA;
8736 if (cdb->byte2 & SRW10_DPO)
8737 flags |= CTL_LLF_DPO;
8738 lba = scsi_4btoul(cdb->addr);
8739 num_blocks = scsi_2btoul(cdb->length);
8742 case WRITE_VERIFY_10: {
8743 struct scsi_write_verify_10 *cdb;
8745 cdb = (struct scsi_write_verify_10 *)ctsio->cdb;
8746 flags |= CTL_LLF_FUA;
8747 if (cdb->byte2 & SWV_DPO)
8748 flags |= CTL_LLF_DPO;
8749 lba = scsi_4btoul(cdb->addr);
8750 num_blocks = scsi_2btoul(cdb->length);
8755 struct scsi_rw_12 *cdb;
8757 cdb = (struct scsi_rw_12 *)ctsio->cdb;
8758 if (cdb->byte2 & SRW12_FUA)
8759 flags |= CTL_LLF_FUA;
8760 if (cdb->byte2 & SRW12_DPO)
8761 flags |= CTL_LLF_DPO;
8762 lba = scsi_4btoul(cdb->addr);
8763 num_blocks = scsi_4btoul(cdb->length);
8766 case WRITE_VERIFY_12: {
8767 struct scsi_write_verify_12 *cdb;
8769 cdb = (struct scsi_write_verify_12 *)ctsio->cdb;
8770 flags |= CTL_LLF_FUA;
8771 if (cdb->byte2 & SWV_DPO)
8772 flags |= CTL_LLF_DPO;
8773 lba = scsi_4btoul(cdb->addr);
8774 num_blocks = scsi_4btoul(cdb->length);
8779 struct scsi_rw_16 *cdb;
8781 cdb = (struct scsi_rw_16 *)ctsio->cdb;
8782 if (cdb->byte2 & SRW12_FUA)
8783 flags |= CTL_LLF_FUA;
8784 if (cdb->byte2 & SRW12_DPO)
8785 flags |= CTL_LLF_DPO;
8786 lba = scsi_8btou64(cdb->addr);
8787 num_blocks = scsi_4btoul(cdb->length);
8790 case WRITE_ATOMIC_16: {
8791 struct scsi_write_atomic_16 *cdb;
8793 if (lun->be_lun->atomicblock == 0) {
8794 ctl_set_invalid_opcode(ctsio);
8795 ctl_done((union ctl_io *)ctsio);
8796 return (CTL_RETVAL_COMPLETE);
8799 cdb = (struct scsi_write_atomic_16 *)ctsio->cdb;
8800 if (cdb->byte2 & SRW12_FUA)
8801 flags |= CTL_LLF_FUA;
8802 if (cdb->byte2 & SRW12_DPO)
8803 flags |= CTL_LLF_DPO;
8804 lba = scsi_8btou64(cdb->addr);
8805 num_blocks = scsi_2btoul(cdb->length);
8806 if (num_blocks > lun->be_lun->atomicblock) {
8807 ctl_set_invalid_field(ctsio, /*sks_valid*/ 1,
8808 /*command*/ 1, /*field*/ 12, /*bit_valid*/ 0,
8810 ctl_done((union ctl_io *)ctsio);
8811 return (CTL_RETVAL_COMPLETE);
8815 case WRITE_VERIFY_16: {
8816 struct scsi_write_verify_16 *cdb;
8818 cdb = (struct scsi_write_verify_16 *)ctsio->cdb;
8819 flags |= CTL_LLF_FUA;
8820 if (cdb->byte2 & SWV_DPO)
8821 flags |= CTL_LLF_DPO;
8822 lba = scsi_8btou64(cdb->addr);
8823 num_blocks = scsi_4btoul(cdb->length);
8828 * We got a command we don't support. This shouldn't
8829 * happen, commands should be filtered out above us.
8831 ctl_set_invalid_opcode(ctsio);
8832 ctl_done((union ctl_io *)ctsio);
8834 return (CTL_RETVAL_COMPLETE);
8835 break; /* NOTREACHED */
8839 * The first check is to make sure we're in bounds, the second
8840 * check is to catch wrap-around problems. If the lba + num blocks
8841 * is less than the lba, then we've wrapped around and the block
8842 * range is invalid anyway.
8844 if (((lba + num_blocks) > (lun->be_lun->maxlba + 1))
8845 || ((lba + num_blocks) < lba)) {
8846 ctl_set_lba_out_of_range(ctsio);
8847 ctl_done((union ctl_io *)ctsio);
8848 return (CTL_RETVAL_COMPLETE);
8852 * According to SBC-3, a transfer length of 0 is not an error.
8853 * Note that this cannot happen with WRITE(6) or READ(6), since 0
8854 * translates to 256 blocks for those commands.
8856 if (num_blocks == 0) {
8857 ctl_set_success(ctsio);
8858 ctl_done((union ctl_io *)ctsio);
8859 return (CTL_RETVAL_COMPLETE);
8862 /* Set FUA and/or DPO if caches are disabled. */
8864 if ((lun->mode_pages.caching_page[CTL_PAGE_CURRENT].flags1 &
8866 flags |= CTL_LLF_FUA | CTL_LLF_DPO;
8868 if ((lun->mode_pages.caching_page[CTL_PAGE_CURRENT].flags1 &
8870 flags |= CTL_LLF_FUA;
8873 lbalen = (struct ctl_lba_len_flags *)
8874 &ctsio->io_hdr.ctl_private[CTL_PRIV_LBA_LEN];
8876 lbalen->len = num_blocks;
8877 lbalen->flags = (isread ? CTL_LLF_READ : CTL_LLF_WRITE) | flags;
8879 ctsio->kern_total_len = num_blocks * lun->be_lun->blocksize;
8880 ctsio->kern_rel_offset = 0;
8882 CTL_DEBUG_PRINT(("ctl_read_write: calling data_submit()\n"));
8884 retval = lun->backend->data_submit((union ctl_io *)ctsio);
8889 ctl_cnw_cont(union ctl_io *io)
8891 struct ctl_scsiio *ctsio;
8892 struct ctl_lun *lun;
8893 struct ctl_lba_len_flags *lbalen;
8896 ctsio = &io->scsiio;
8897 ctsio->io_hdr.status = CTL_STATUS_NONE;
8898 ctsio->io_hdr.flags &= ~CTL_FLAG_IO_CONT;
8899 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
8900 lbalen = (struct ctl_lba_len_flags *)
8901 &ctsio->io_hdr.ctl_private[CTL_PRIV_LBA_LEN];
8902 lbalen->flags &= ~CTL_LLF_COMPARE;
8903 lbalen->flags |= CTL_LLF_WRITE;
8905 CTL_DEBUG_PRINT(("ctl_cnw_cont: calling data_submit()\n"));
8906 retval = lun->backend->data_submit((union ctl_io *)ctsio);
8911 ctl_cnw(struct ctl_scsiio *ctsio)
8913 struct ctl_lun *lun;
8914 struct ctl_lba_len_flags *lbalen;
8916 uint32_t num_blocks;
8919 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
8921 CTL_DEBUG_PRINT(("ctl_cnw: command: %#x\n", ctsio->cdb[0]));
8924 switch (ctsio->cdb[0]) {
8925 case COMPARE_AND_WRITE: {
8926 struct scsi_compare_and_write *cdb;
8928 cdb = (struct scsi_compare_and_write *)ctsio->cdb;
8929 if (cdb->byte2 & SRW10_FUA)
8930 flags |= CTL_LLF_FUA;
8931 if (cdb->byte2 & SRW10_DPO)
8932 flags |= CTL_LLF_DPO;
8933 lba = scsi_8btou64(cdb->addr);
8934 num_blocks = cdb->length;
8939 * We got a command we don't support. This shouldn't
8940 * happen, commands should be filtered out above us.
8942 ctl_set_invalid_opcode(ctsio);
8943 ctl_done((union ctl_io *)ctsio);
8945 return (CTL_RETVAL_COMPLETE);
8946 break; /* NOTREACHED */
8950 * The first check is to make sure we're in bounds, the second
8951 * check is to catch wrap-around problems. If the lba + num blocks
8952 * is less than the lba, then we've wrapped around and the block
8953 * range is invalid anyway.
8955 if (((lba + num_blocks) > (lun->be_lun->maxlba + 1))
8956 || ((lba + num_blocks) < lba)) {
8957 ctl_set_lba_out_of_range(ctsio);
8958 ctl_done((union ctl_io *)ctsio);
8959 return (CTL_RETVAL_COMPLETE);
8963 * According to SBC-3, a transfer length of 0 is not an error.
8965 if (num_blocks == 0) {
8966 ctl_set_success(ctsio);
8967 ctl_done((union ctl_io *)ctsio);
8968 return (CTL_RETVAL_COMPLETE);
8971 /* Set FUA if write cache is disabled. */
8972 if ((lun->mode_pages.caching_page[CTL_PAGE_CURRENT].flags1 &
8974 flags |= CTL_LLF_FUA;
8976 ctsio->kern_total_len = 2 * num_blocks * lun->be_lun->blocksize;
8977 ctsio->kern_rel_offset = 0;
8980 * Set the IO_CONT flag, so that if this I/O gets passed to
8981 * ctl_data_submit_done(), it'll get passed back to
8982 * ctl_ctl_cnw_cont() for further processing.
8984 ctsio->io_hdr.flags |= CTL_FLAG_IO_CONT;
8985 ctsio->io_cont = ctl_cnw_cont;
8987 lbalen = (struct ctl_lba_len_flags *)
8988 &ctsio->io_hdr.ctl_private[CTL_PRIV_LBA_LEN];
8990 lbalen->len = num_blocks;
8991 lbalen->flags = CTL_LLF_COMPARE | flags;
8993 CTL_DEBUG_PRINT(("ctl_cnw: calling data_submit()\n"));
8994 retval = lun->backend->data_submit((union ctl_io *)ctsio);
8999 ctl_verify(struct ctl_scsiio *ctsio)
9001 struct ctl_lun *lun;
9002 struct ctl_lba_len_flags *lbalen;
9004 uint32_t num_blocks;
9008 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
9010 CTL_DEBUG_PRINT(("ctl_verify: command: %#x\n", ctsio->cdb[0]));
9013 flags = CTL_LLF_FUA;
9014 switch (ctsio->cdb[0]) {
9016 struct scsi_verify_10 *cdb;
9018 cdb = (struct scsi_verify_10 *)ctsio->cdb;
9019 if (cdb->byte2 & SVFY_BYTCHK)
9021 if (cdb->byte2 & SVFY_DPO)
9022 flags |= CTL_LLF_DPO;
9023 lba = scsi_4btoul(cdb->addr);
9024 num_blocks = scsi_2btoul(cdb->length);
9028 struct scsi_verify_12 *cdb;
9030 cdb = (struct scsi_verify_12 *)ctsio->cdb;
9031 if (cdb->byte2 & SVFY_BYTCHK)
9033 if (cdb->byte2 & SVFY_DPO)
9034 flags |= CTL_LLF_DPO;
9035 lba = scsi_4btoul(cdb->addr);
9036 num_blocks = scsi_4btoul(cdb->length);
9040 struct scsi_rw_16 *cdb;
9042 cdb = (struct scsi_rw_16 *)ctsio->cdb;
9043 if (cdb->byte2 & SVFY_BYTCHK)
9045 if (cdb->byte2 & SVFY_DPO)
9046 flags |= CTL_LLF_DPO;
9047 lba = scsi_8btou64(cdb->addr);
9048 num_blocks = scsi_4btoul(cdb->length);
9053 * We got a command we don't support. This shouldn't
9054 * happen, commands should be filtered out above us.
9056 ctl_set_invalid_opcode(ctsio);
9057 ctl_done((union ctl_io *)ctsio);
9058 return (CTL_RETVAL_COMPLETE);
9062 * The first check is to make sure we're in bounds, the second
9063 * check is to catch wrap-around problems. If the lba + num blocks
9064 * is less than the lba, then we've wrapped around and the block
9065 * range is invalid anyway.
9067 if (((lba + num_blocks) > (lun->be_lun->maxlba + 1))
9068 || ((lba + num_blocks) < lba)) {
9069 ctl_set_lba_out_of_range(ctsio);
9070 ctl_done((union ctl_io *)ctsio);
9071 return (CTL_RETVAL_COMPLETE);
9075 * According to SBC-3, a transfer length of 0 is not an error.
9077 if (num_blocks == 0) {
9078 ctl_set_success(ctsio);
9079 ctl_done((union ctl_io *)ctsio);
9080 return (CTL_RETVAL_COMPLETE);
9083 lbalen = (struct ctl_lba_len_flags *)
9084 &ctsio->io_hdr.ctl_private[CTL_PRIV_LBA_LEN];
9086 lbalen->len = num_blocks;
9088 lbalen->flags = CTL_LLF_COMPARE | flags;
9089 ctsio->kern_total_len = num_blocks * lun->be_lun->blocksize;
9091 lbalen->flags = CTL_LLF_VERIFY | flags;
9092 ctsio->kern_total_len = 0;
9094 ctsio->kern_rel_offset = 0;
9096 CTL_DEBUG_PRINT(("ctl_verify: calling data_submit()\n"));
9097 retval = lun->backend->data_submit((union ctl_io *)ctsio);
9102 ctl_report_luns(struct ctl_scsiio *ctsio)
9104 struct ctl_softc *softc;
9105 struct scsi_report_luns *cdb;
9106 struct scsi_report_luns_data *lun_data;
9107 struct ctl_lun *lun, *request_lun;
9108 struct ctl_port *port;
9109 int num_luns, retval;
9110 uint32_t alloc_len, lun_datalen;
9112 uint32_t initidx, targ_lun_id, lun_id;
9114 retval = CTL_RETVAL_COMPLETE;
9115 cdb = (struct scsi_report_luns *)ctsio->cdb;
9116 port = ctl_io_port(&ctsio->io_hdr);
9117 softc = port->ctl_softc;
9119 CTL_DEBUG_PRINT(("ctl_report_luns\n"));
9121 mtx_lock(&softc->ctl_lock);
9123 for (targ_lun_id = 0; targ_lun_id < CTL_MAX_LUNS; targ_lun_id++) {
9124 if (ctl_lun_map_from_port(port, targ_lun_id) < CTL_MAX_LUNS)
9127 mtx_unlock(&softc->ctl_lock);
9129 switch (cdb->select_report) {
9130 case RPL_REPORT_DEFAULT:
9131 case RPL_REPORT_ALL:
9132 case RPL_REPORT_NONSUBSID:
9134 case RPL_REPORT_WELLKNOWN:
9135 case RPL_REPORT_ADMIN:
9136 case RPL_REPORT_CONGLOM:
9140 ctl_set_invalid_field(ctsio,
9146 ctl_done((union ctl_io *)ctsio);
9148 break; /* NOTREACHED */
9151 alloc_len = scsi_4btoul(cdb->length);
9153 * The initiator has to allocate at least 16 bytes for this request,
9154 * so he can at least get the header and the first LUN. Otherwise
9155 * we reject the request (per SPC-3 rev 14, section 6.21).
9157 if (alloc_len < (sizeof(struct scsi_report_luns_data) +
9158 sizeof(struct scsi_report_luns_lundata))) {
9159 ctl_set_invalid_field(ctsio,
9165 ctl_done((union ctl_io *)ctsio);
9169 request_lun = (struct ctl_lun *)
9170 ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
9172 lun_datalen = sizeof(*lun_data) +
9173 (num_luns * sizeof(struct scsi_report_luns_lundata));
9175 ctsio->kern_data_ptr = malloc(lun_datalen, M_CTL, M_WAITOK | M_ZERO);
9176 lun_data = (struct scsi_report_luns_data *)ctsio->kern_data_ptr;
9177 ctsio->kern_sg_entries = 0;
9179 initidx = ctl_get_initindex(&ctsio->io_hdr.nexus);
9181 mtx_lock(&softc->ctl_lock);
9182 for (targ_lun_id = 0, num_filled = 0; targ_lun_id < CTL_MAX_LUNS && num_filled < num_luns; targ_lun_id++) {
9183 lun_id = ctl_lun_map_from_port(port, targ_lun_id);
9184 if (lun_id >= CTL_MAX_LUNS)
9186 lun = softc->ctl_luns[lun_id];
9190 be64enc(lun_data->luns[num_filled++].lundata,
9191 ctl_encode_lun(targ_lun_id));
9194 * According to SPC-3, rev 14 section 6.21:
9196 * "The execution of a REPORT LUNS command to any valid and
9197 * installed logical unit shall clear the REPORTED LUNS DATA
9198 * HAS CHANGED unit attention condition for all logical
9199 * units of that target with respect to the requesting
9200 * initiator. A valid and installed logical unit is one
9201 * having a PERIPHERAL QUALIFIER of 000b in the standard
9202 * INQUIRY data (see 6.4.2)."
9204 * If request_lun is NULL, the LUN this report luns command
9205 * was issued to is either disabled or doesn't exist. In that
9206 * case, we shouldn't clear any pending lun change unit
9209 if (request_lun != NULL) {
9210 mtx_lock(&lun->lun_lock);
9211 ctl_clr_ua(lun, initidx, CTL_UA_LUN_CHANGE);
9212 mtx_unlock(&lun->lun_lock);
9215 mtx_unlock(&softc->ctl_lock);
9218 * It's quite possible that we've returned fewer LUNs than we allocated
9219 * space for. Trim it.
9221 lun_datalen = sizeof(*lun_data) +
9222 (num_filled * sizeof(struct scsi_report_luns_lundata));
9224 if (lun_datalen < alloc_len) {
9225 ctsio->residual = alloc_len - lun_datalen;
9226 ctsio->kern_data_len = lun_datalen;
9227 ctsio->kern_total_len = lun_datalen;
9229 ctsio->residual = 0;
9230 ctsio->kern_data_len = alloc_len;
9231 ctsio->kern_total_len = alloc_len;
9233 ctsio->kern_data_resid = 0;
9234 ctsio->kern_rel_offset = 0;
9235 ctsio->kern_sg_entries = 0;
9238 * We set this to the actual data length, regardless of how much
9239 * space we actually have to return results. If the user looks at
9240 * this value, he'll know whether or not he allocated enough space
9241 * and reissue the command if necessary. We don't support well
9242 * known logical units, so if the user asks for that, return none.
9244 scsi_ulto4b(lun_datalen - 8, lun_data->length);
9247 * We can only return SCSI_STATUS_CHECK_COND when we can't satisfy
9250 ctl_set_success(ctsio);
9251 ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
9252 ctsio->be_move_done = ctl_config_move_done;
9253 ctl_datamove((union ctl_io *)ctsio);
9258 ctl_request_sense(struct ctl_scsiio *ctsio)
9260 struct scsi_request_sense *cdb;
9261 struct scsi_sense_data *sense_ptr;
9262 struct ctl_softc *ctl_softc;
9263 struct ctl_lun *lun;
9266 scsi_sense_data_type sense_format;
9267 ctl_ua_type ua_type;
9269 cdb = (struct scsi_request_sense *)ctsio->cdb;
9271 ctl_softc = control_softc;
9272 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
9274 CTL_DEBUG_PRINT(("ctl_request_sense\n"));
9277 * Determine which sense format the user wants.
9279 if (cdb->byte2 & SRS_DESC)
9280 sense_format = SSD_TYPE_DESC;
9282 sense_format = SSD_TYPE_FIXED;
9284 ctsio->kern_data_ptr = malloc(sizeof(*sense_ptr), M_CTL, M_WAITOK);
9285 sense_ptr = (struct scsi_sense_data *)ctsio->kern_data_ptr;
9286 ctsio->kern_sg_entries = 0;
9289 * struct scsi_sense_data, which is currently set to 256 bytes, is
9290 * larger than the largest allowed value for the length field in the
9291 * REQUEST SENSE CDB, which is 252 bytes as of SPC-4.
9293 ctsio->residual = 0;
9294 ctsio->kern_data_len = cdb->length;
9295 ctsio->kern_total_len = cdb->length;
9297 ctsio->kern_data_resid = 0;
9298 ctsio->kern_rel_offset = 0;
9299 ctsio->kern_sg_entries = 0;
9302 * If we don't have a LUN, we don't have any pending sense.
9308 initidx = ctl_get_initindex(&ctsio->io_hdr.nexus);
9310 * Check for pending sense, and then for pending unit attentions.
9311 * Pending sense gets returned first, then pending unit attentions.
9313 mtx_lock(&lun->lun_lock);
9315 if (ctl_is_set(lun->have_ca, initidx)) {
9316 scsi_sense_data_type stored_format;
9319 * Check to see which sense format was used for the stored
9322 stored_format = scsi_sense_type(&lun->pending_sense[initidx]);
9325 * If the user requested a different sense format than the
9326 * one we stored, then we need to convert it to the other
9327 * format. If we're going from descriptor to fixed format
9328 * sense data, we may lose things in translation, depending
9329 * on what options were used.
9331 * If the stored format is SSD_TYPE_NONE (i.e. invalid),
9332 * for some reason we'll just copy it out as-is.
9334 if ((stored_format == SSD_TYPE_FIXED)
9335 && (sense_format == SSD_TYPE_DESC))
9336 ctl_sense_to_desc((struct scsi_sense_data_fixed *)
9337 &lun->pending_sense[initidx],
9338 (struct scsi_sense_data_desc *)sense_ptr);
9339 else if ((stored_format == SSD_TYPE_DESC)
9340 && (sense_format == SSD_TYPE_FIXED))
9341 ctl_sense_to_fixed((struct scsi_sense_data_desc *)
9342 &lun->pending_sense[initidx],
9343 (struct scsi_sense_data_fixed *)sense_ptr);
9345 memcpy(sense_ptr, &lun->pending_sense[initidx],
9346 MIN(sizeof(*sense_ptr),
9347 sizeof(lun->pending_sense[initidx])));
9349 ctl_clear_mask(lun->have_ca, initidx);
9354 ua_type = ctl_build_ua(lun, initidx, sense_ptr, sense_format);
9355 if (ua_type != CTL_UA_NONE)
9357 if (ua_type == CTL_UA_LUN_CHANGE) {
9358 mtx_unlock(&lun->lun_lock);
9359 mtx_lock(&ctl_softc->ctl_lock);
9360 ctl_clr_ua_allluns(ctl_softc, initidx, ua_type);
9361 mtx_unlock(&ctl_softc->ctl_lock);
9362 mtx_lock(&lun->lun_lock);
9366 mtx_unlock(&lun->lun_lock);
9369 * We already have a pending error, return it.
9371 if (have_error != 0) {
9373 * We report the SCSI status as OK, since the status of the
9374 * request sense command itself is OK.
9375 * We report 0 for the sense length, because we aren't doing
9376 * autosense in this case. We're reporting sense as
9379 ctl_set_success(ctsio);
9380 ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
9381 ctsio->be_move_done = ctl_config_move_done;
9382 ctl_datamove((union ctl_io *)ctsio);
9383 return (CTL_RETVAL_COMPLETE);
9389 * No sense information to report, so we report that everything is
9392 ctl_set_sense_data(sense_ptr,
9395 /*current_error*/ 1,
9396 /*sense_key*/ SSD_KEY_NO_SENSE,
9402 * We report 0 for the sense length, because we aren't doing
9403 * autosense in this case. We're reporting sense as parameter data.
9405 ctl_set_success(ctsio);
9406 ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
9407 ctsio->be_move_done = ctl_config_move_done;
9408 ctl_datamove((union ctl_io *)ctsio);
9409 return (CTL_RETVAL_COMPLETE);
9413 ctl_tur(struct ctl_scsiio *ctsio)
9416 CTL_DEBUG_PRINT(("ctl_tur\n"));
9418 ctl_set_success(ctsio);
9419 ctl_done((union ctl_io *)ctsio);
9421 return (CTL_RETVAL_COMPLETE);
9425 * SCSI VPD page 0x00, the Supported VPD Pages page.
9428 ctl_inquiry_evpd_supported(struct ctl_scsiio *ctsio, int alloc_len)
9430 struct scsi_vpd_supported_pages *pages;
9432 struct ctl_lun *lun;
9435 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
9437 sup_page_size = sizeof(struct scsi_vpd_supported_pages) *
9438 SCSI_EVPD_NUM_SUPPORTED_PAGES;
9439 ctsio->kern_data_ptr = malloc(sup_page_size, M_CTL, M_WAITOK | M_ZERO);
9440 pages = (struct scsi_vpd_supported_pages *)ctsio->kern_data_ptr;
9441 ctsio->kern_sg_entries = 0;
9443 if (sup_page_size < alloc_len) {
9444 ctsio->residual = alloc_len - sup_page_size;
9445 ctsio->kern_data_len = sup_page_size;
9446 ctsio->kern_total_len = sup_page_size;
9448 ctsio->residual = 0;
9449 ctsio->kern_data_len = alloc_len;
9450 ctsio->kern_total_len = alloc_len;
9452 ctsio->kern_data_resid = 0;
9453 ctsio->kern_rel_offset = 0;
9454 ctsio->kern_sg_entries = 0;
9457 * The control device is always connected. The disk device, on the
9458 * other hand, may not be online all the time. Need to change this
9459 * to figure out whether the disk device is actually online or not.
9462 pages->device = (SID_QUAL_LU_CONNECTED << 5) |
9463 lun->be_lun->lun_type;
9465 pages->device = (SID_QUAL_LU_OFFLINE << 5) | T_DIRECT;
9468 /* Supported VPD pages */
9469 pages->page_list[p++] = SVPD_SUPPORTED_PAGES;
9471 pages->page_list[p++] = SVPD_UNIT_SERIAL_NUMBER;
9472 /* Device Identification */
9473 pages->page_list[p++] = SVPD_DEVICE_ID;
9474 /* Extended INQUIRY Data */
9475 pages->page_list[p++] = SVPD_EXTENDED_INQUIRY_DATA;
9476 /* Mode Page Policy */
9477 pages->page_list[p++] = SVPD_MODE_PAGE_POLICY;
9479 pages->page_list[p++] = SVPD_SCSI_PORTS;
9480 /* Third-party Copy */
9481 pages->page_list[p++] = SVPD_SCSI_TPC;
9482 if (lun != NULL && lun->be_lun->lun_type == T_DIRECT) {
9484 pages->page_list[p++] = SVPD_BLOCK_LIMITS;
9485 /* Block Device Characteristics */
9486 pages->page_list[p++] = SVPD_BDC;
9487 /* Logical Block Provisioning */
9488 pages->page_list[p++] = SVPD_LBP;
9492 ctl_set_success(ctsio);
9493 ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
9494 ctsio->be_move_done = ctl_config_move_done;
9495 ctl_datamove((union ctl_io *)ctsio);
9496 return (CTL_RETVAL_COMPLETE);
9500 * SCSI VPD page 0x80, the Unit Serial Number page.
9503 ctl_inquiry_evpd_serial(struct ctl_scsiio *ctsio, int alloc_len)
9505 struct scsi_vpd_unit_serial_number *sn_ptr;
9506 struct ctl_lun *lun;
9509 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
9511 data_len = 4 + CTL_SN_LEN;
9512 ctsio->kern_data_ptr = malloc(data_len, M_CTL, M_WAITOK | M_ZERO);
9513 sn_ptr = (struct scsi_vpd_unit_serial_number *)ctsio->kern_data_ptr;
9514 if (data_len < alloc_len) {
9515 ctsio->residual = alloc_len - data_len;
9516 ctsio->kern_data_len = data_len;
9517 ctsio->kern_total_len = data_len;
9519 ctsio->residual = 0;
9520 ctsio->kern_data_len = alloc_len;
9521 ctsio->kern_total_len = alloc_len;
9523 ctsio->kern_data_resid = 0;
9524 ctsio->kern_rel_offset = 0;
9525 ctsio->kern_sg_entries = 0;
9528 * The control device is always connected. The disk device, on the
9529 * other hand, may not be online all the time. Need to change this
9530 * to figure out whether the disk device is actually online or not.
9533 sn_ptr->device = (SID_QUAL_LU_CONNECTED << 5) |
9534 lun->be_lun->lun_type;
9536 sn_ptr->device = (SID_QUAL_LU_OFFLINE << 5) | T_DIRECT;
9538 sn_ptr->page_code = SVPD_UNIT_SERIAL_NUMBER;
9539 sn_ptr->length = CTL_SN_LEN;
9541 * If we don't have a LUN, we just leave the serial number as
9545 strncpy((char *)sn_ptr->serial_num,
9546 (char *)lun->be_lun->serial_num, CTL_SN_LEN);
9548 memset(sn_ptr->serial_num, 0x20, CTL_SN_LEN);
9550 ctl_set_success(ctsio);
9551 ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
9552 ctsio->be_move_done = ctl_config_move_done;
9553 ctl_datamove((union ctl_io *)ctsio);
9554 return (CTL_RETVAL_COMPLETE);
9559 * SCSI VPD page 0x86, the Extended INQUIRY Data page.
9562 ctl_inquiry_evpd_eid(struct ctl_scsiio *ctsio, int alloc_len)
9564 struct scsi_vpd_extended_inquiry_data *eid_ptr;
9565 struct ctl_lun *lun;
9568 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
9570 data_len = sizeof(struct scsi_vpd_extended_inquiry_data);
9571 ctsio->kern_data_ptr = malloc(data_len, M_CTL, M_WAITOK | M_ZERO);
9572 eid_ptr = (struct scsi_vpd_extended_inquiry_data *)ctsio->kern_data_ptr;
9573 ctsio->kern_sg_entries = 0;
9575 if (data_len < alloc_len) {
9576 ctsio->residual = alloc_len - data_len;
9577 ctsio->kern_data_len = data_len;
9578 ctsio->kern_total_len = data_len;
9580 ctsio->residual = 0;
9581 ctsio->kern_data_len = alloc_len;
9582 ctsio->kern_total_len = alloc_len;
9584 ctsio->kern_data_resid = 0;
9585 ctsio->kern_rel_offset = 0;
9586 ctsio->kern_sg_entries = 0;
9589 * The control device is always connected. The disk device, on the
9590 * other hand, may not be online all the time.
9593 eid_ptr->device = (SID_QUAL_LU_CONNECTED << 5) |
9594 lun->be_lun->lun_type;
9596 eid_ptr->device = (SID_QUAL_LU_OFFLINE << 5) | T_DIRECT;
9597 eid_ptr->page_code = SVPD_EXTENDED_INQUIRY_DATA;
9598 scsi_ulto2b(data_len - 4, eid_ptr->page_length);
9600 * We support head of queue, ordered and simple tags.
9602 eid_ptr->flags2 = SVPD_EID_HEADSUP | SVPD_EID_ORDSUP | SVPD_EID_SIMPSUP;
9604 * Volatile cache supported.
9606 eid_ptr->flags3 = SVPD_EID_V_SUP;
9609 * This means that we clear the REPORTED LUNS DATA HAS CHANGED unit
9610 * attention for a particular IT nexus on all LUNs once we report
9611 * it to that nexus once. This bit is required as of SPC-4.
9613 eid_ptr->flags4 = SVPD_EID_LUICLT;
9616 * XXX KDM in order to correctly answer this, we would need
9617 * information from the SIM to determine how much sense data it
9618 * can send. So this would really be a path inquiry field, most
9619 * likely. This can be set to a maximum of 252 according to SPC-4,
9620 * but the hardware may or may not be able to support that much.
9621 * 0 just means that the maximum sense data length is not reported.
9623 eid_ptr->max_sense_length = 0;
9625 ctl_set_success(ctsio);
9626 ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
9627 ctsio->be_move_done = ctl_config_move_done;
9628 ctl_datamove((union ctl_io *)ctsio);
9629 return (CTL_RETVAL_COMPLETE);
9633 ctl_inquiry_evpd_mpp(struct ctl_scsiio *ctsio, int alloc_len)
9635 struct scsi_vpd_mode_page_policy *mpp_ptr;
9636 struct ctl_lun *lun;
9639 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
9641 data_len = sizeof(struct scsi_vpd_mode_page_policy) +
9642 sizeof(struct scsi_vpd_mode_page_policy_descr);
9644 ctsio->kern_data_ptr = malloc(data_len, M_CTL, M_WAITOK | M_ZERO);
9645 mpp_ptr = (struct scsi_vpd_mode_page_policy *)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 mpp_ptr->device = (SID_QUAL_LU_CONNECTED << 5) |
9667 lun->be_lun->lun_type;
9669 mpp_ptr->device = (SID_QUAL_LU_OFFLINE << 5) | T_DIRECT;
9670 mpp_ptr->page_code = SVPD_MODE_PAGE_POLICY;
9671 scsi_ulto2b(data_len - 4, mpp_ptr->page_length);
9672 mpp_ptr->descr[0].page_code = 0x3f;
9673 mpp_ptr->descr[0].subpage_code = 0xff;
9674 mpp_ptr->descr[0].policy = SVPD_MPP_SHARED;
9676 ctl_set_success(ctsio);
9677 ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
9678 ctsio->be_move_done = ctl_config_move_done;
9679 ctl_datamove((union ctl_io *)ctsio);
9680 return (CTL_RETVAL_COMPLETE);
9684 * SCSI VPD page 0x83, the Device Identification page.
9687 ctl_inquiry_evpd_devid(struct ctl_scsiio *ctsio, int alloc_len)
9689 struct scsi_vpd_device_id *devid_ptr;
9690 struct scsi_vpd_id_descriptor *desc;
9691 struct ctl_softc *softc;
9692 struct ctl_lun *lun;
9693 struct ctl_port *port;
9697 softc = control_softc;
9699 port = ctl_io_port(&ctsio->io_hdr);
9700 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
9702 data_len = sizeof(struct scsi_vpd_device_id) +
9703 sizeof(struct scsi_vpd_id_descriptor) +
9704 sizeof(struct scsi_vpd_id_rel_trgt_port_id) +
9705 sizeof(struct scsi_vpd_id_descriptor) +
9706 sizeof(struct scsi_vpd_id_trgt_port_grp_id);
9707 if (lun && lun->lun_devid)
9708 data_len += lun->lun_devid->len;
9709 if (port && port->port_devid)
9710 data_len += port->port_devid->len;
9711 if (port && port->target_devid)
9712 data_len += port->target_devid->len;
9714 ctsio->kern_data_ptr = malloc(data_len, M_CTL, M_WAITOK | M_ZERO);
9715 devid_ptr = (struct scsi_vpd_device_id *)ctsio->kern_data_ptr;
9716 ctsio->kern_sg_entries = 0;
9718 if (data_len < alloc_len) {
9719 ctsio->residual = alloc_len - data_len;
9720 ctsio->kern_data_len = data_len;
9721 ctsio->kern_total_len = data_len;
9723 ctsio->residual = 0;
9724 ctsio->kern_data_len = alloc_len;
9725 ctsio->kern_total_len = alloc_len;
9727 ctsio->kern_data_resid = 0;
9728 ctsio->kern_rel_offset = 0;
9729 ctsio->kern_sg_entries = 0;
9732 * The control device is always connected. The disk device, on the
9733 * other hand, may not be online all the time.
9736 devid_ptr->device = (SID_QUAL_LU_CONNECTED << 5) |
9737 lun->be_lun->lun_type;
9739 devid_ptr->device = (SID_QUAL_LU_OFFLINE << 5) | T_DIRECT;
9740 devid_ptr->page_code = SVPD_DEVICE_ID;
9741 scsi_ulto2b(data_len - 4, devid_ptr->length);
9743 if (port && port->port_type == CTL_PORT_FC)
9744 proto = SCSI_PROTO_FC << 4;
9745 else if (port && port->port_type == CTL_PORT_ISCSI)
9746 proto = SCSI_PROTO_ISCSI << 4;
9748 proto = SCSI_PROTO_SPI << 4;
9749 desc = (struct scsi_vpd_id_descriptor *)devid_ptr->desc_list;
9752 * We're using a LUN association here. i.e., this device ID is a
9753 * per-LUN identifier.
9755 if (lun && lun->lun_devid) {
9756 memcpy(desc, lun->lun_devid->data, lun->lun_devid->len);
9757 desc = (struct scsi_vpd_id_descriptor *)((uint8_t *)desc +
9758 lun->lun_devid->len);
9762 * This is for the WWPN which is a port association.
9764 if (port && port->port_devid) {
9765 memcpy(desc, port->port_devid->data, port->port_devid->len);
9766 desc = (struct scsi_vpd_id_descriptor *)((uint8_t *)desc +
9767 port->port_devid->len);
9771 * This is for the Relative Target Port(type 4h) identifier
9773 desc->proto_codeset = proto | SVPD_ID_CODESET_BINARY;
9774 desc->id_type = SVPD_ID_PIV | SVPD_ID_ASSOC_PORT |
9775 SVPD_ID_TYPE_RELTARG;
9777 scsi_ulto2b(ctsio->io_hdr.nexus.targ_port, &desc->identifier[2]);
9778 desc = (struct scsi_vpd_id_descriptor *)(&desc->identifier[0] +
9779 sizeof(struct scsi_vpd_id_rel_trgt_port_id));
9782 * This is for the Target Port Group(type 5h) identifier
9784 desc->proto_codeset = proto | SVPD_ID_CODESET_BINARY;
9785 desc->id_type = SVPD_ID_PIV | SVPD_ID_ASSOC_PORT |
9786 SVPD_ID_TYPE_TPORTGRP;
9788 if (softc->is_single ||
9789 (port && port->status & CTL_PORT_STATUS_HA_SHARED))
9792 g = 2 + ctsio->io_hdr.nexus.targ_port / softc->port_cnt;
9793 scsi_ulto2b(g, &desc->identifier[2]);
9794 desc = (struct scsi_vpd_id_descriptor *)(&desc->identifier[0] +
9795 sizeof(struct scsi_vpd_id_trgt_port_grp_id));
9798 * This is for the Target identifier
9800 if (port && port->target_devid) {
9801 memcpy(desc, port->target_devid->data, port->target_devid->len);
9804 ctl_set_success(ctsio);
9805 ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
9806 ctsio->be_move_done = ctl_config_move_done;
9807 ctl_datamove((union ctl_io *)ctsio);
9808 return (CTL_RETVAL_COMPLETE);
9812 ctl_inquiry_evpd_scsi_ports(struct ctl_scsiio *ctsio, int alloc_len)
9814 struct ctl_softc *softc = control_softc;
9815 struct scsi_vpd_scsi_ports *sp;
9816 struct scsi_vpd_port_designation *pd;
9817 struct scsi_vpd_port_designation_cont *pdc;
9818 struct ctl_lun *lun;
9819 struct ctl_port *port;
9820 int data_len, num_target_ports, iid_len, id_len;
9822 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
9824 num_target_ports = 0;
9827 mtx_lock(&softc->ctl_lock);
9828 STAILQ_FOREACH(port, &softc->port_list, links) {
9829 if ((port->status & CTL_PORT_STATUS_ONLINE) == 0)
9832 ctl_lun_map_to_port(port, lun->lun) >= CTL_MAX_LUNS)
9835 if (port->init_devid)
9836 iid_len += port->init_devid->len;
9837 if (port->port_devid)
9838 id_len += port->port_devid->len;
9840 mtx_unlock(&softc->ctl_lock);
9842 data_len = sizeof(struct scsi_vpd_scsi_ports) +
9843 num_target_ports * (sizeof(struct scsi_vpd_port_designation) +
9844 sizeof(struct scsi_vpd_port_designation_cont)) + iid_len + id_len;
9845 ctsio->kern_data_ptr = malloc(data_len, M_CTL, M_WAITOK | M_ZERO);
9846 sp = (struct scsi_vpd_scsi_ports *)ctsio->kern_data_ptr;
9847 ctsio->kern_sg_entries = 0;
9849 if (data_len < alloc_len) {
9850 ctsio->residual = alloc_len - data_len;
9851 ctsio->kern_data_len = data_len;
9852 ctsio->kern_total_len = data_len;
9854 ctsio->residual = 0;
9855 ctsio->kern_data_len = alloc_len;
9856 ctsio->kern_total_len = alloc_len;
9858 ctsio->kern_data_resid = 0;
9859 ctsio->kern_rel_offset = 0;
9860 ctsio->kern_sg_entries = 0;
9863 * The control device is always connected. The disk device, on the
9864 * other hand, may not be online all the time. Need to change this
9865 * to figure out whether the disk device is actually online or not.
9868 sp->device = (SID_QUAL_LU_CONNECTED << 5) |
9869 lun->be_lun->lun_type;
9871 sp->device = (SID_QUAL_LU_OFFLINE << 5) | T_DIRECT;
9873 sp->page_code = SVPD_SCSI_PORTS;
9874 scsi_ulto2b(data_len - sizeof(struct scsi_vpd_scsi_ports),
9876 pd = &sp->design[0];
9878 mtx_lock(&softc->ctl_lock);
9879 STAILQ_FOREACH(port, &softc->port_list, links) {
9880 if ((port->status & CTL_PORT_STATUS_ONLINE) == 0)
9883 ctl_lun_map_to_port(port, lun->lun) >= CTL_MAX_LUNS)
9885 scsi_ulto2b(port->targ_port, pd->relative_port_id);
9886 if (port->init_devid) {
9887 iid_len = port->init_devid->len;
9888 memcpy(pd->initiator_transportid,
9889 port->init_devid->data, port->init_devid->len);
9892 scsi_ulto2b(iid_len, pd->initiator_transportid_length);
9893 pdc = (struct scsi_vpd_port_designation_cont *)
9894 (&pd->initiator_transportid[iid_len]);
9895 if (port->port_devid) {
9896 id_len = port->port_devid->len;
9897 memcpy(pdc->target_port_descriptors,
9898 port->port_devid->data, port->port_devid->len);
9901 scsi_ulto2b(id_len, pdc->target_port_descriptors_length);
9902 pd = (struct scsi_vpd_port_designation *)
9903 ((uint8_t *)pdc->target_port_descriptors + id_len);
9905 mtx_unlock(&softc->ctl_lock);
9907 ctl_set_success(ctsio);
9908 ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
9909 ctsio->be_move_done = ctl_config_move_done;
9910 ctl_datamove((union ctl_io *)ctsio);
9911 return (CTL_RETVAL_COMPLETE);
9915 ctl_inquiry_evpd_block_limits(struct ctl_scsiio *ctsio, int alloc_len)
9917 struct scsi_vpd_block_limits *bl_ptr;
9918 struct ctl_lun *lun;
9921 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
9923 ctsio->kern_data_ptr = malloc(sizeof(*bl_ptr), M_CTL, M_WAITOK | M_ZERO);
9924 bl_ptr = (struct scsi_vpd_block_limits *)ctsio->kern_data_ptr;
9925 ctsio->kern_sg_entries = 0;
9927 if (sizeof(*bl_ptr) < alloc_len) {
9928 ctsio->residual = alloc_len - sizeof(*bl_ptr);
9929 ctsio->kern_data_len = sizeof(*bl_ptr);
9930 ctsio->kern_total_len = sizeof(*bl_ptr);
9932 ctsio->residual = 0;
9933 ctsio->kern_data_len = alloc_len;
9934 ctsio->kern_total_len = alloc_len;
9936 ctsio->kern_data_resid = 0;
9937 ctsio->kern_rel_offset = 0;
9938 ctsio->kern_sg_entries = 0;
9941 * The control device is always connected. The disk device, on the
9942 * other hand, may not be online all the time. Need to change this
9943 * to figure out whether the disk device is actually online or not.
9946 bl_ptr->device = (SID_QUAL_LU_CONNECTED << 5) |
9947 lun->be_lun->lun_type;
9949 bl_ptr->device = (SID_QUAL_LU_OFFLINE << 5) | T_DIRECT;
9951 bl_ptr->page_code = SVPD_BLOCK_LIMITS;
9952 scsi_ulto2b(sizeof(*bl_ptr) - 4, bl_ptr->page_length);
9953 bl_ptr->max_cmp_write_len = 0xff;
9954 scsi_ulto4b(0xffffffff, bl_ptr->max_txfer_len);
9956 scsi_ulto4b(lun->be_lun->opttxferlen, bl_ptr->opt_txfer_len);
9957 if (lun->be_lun->flags & CTL_LUN_FLAG_UNMAP) {
9959 ctl_get_opt_number(&lun->be_lun->options,
9960 "unmap_max_lba", &ival);
9961 scsi_ulto4b(ival, bl_ptr->max_unmap_lba_cnt);
9963 ctl_get_opt_number(&lun->be_lun->options,
9964 "unmap_max_descr", &ival);
9965 scsi_ulto4b(ival, bl_ptr->max_unmap_blk_cnt);
9966 if (lun->be_lun->ublockexp != 0) {
9967 scsi_ulto4b((1 << lun->be_lun->ublockexp),
9968 bl_ptr->opt_unmap_grain);
9969 scsi_ulto4b(0x80000000 | lun->be_lun->ublockoff,
9970 bl_ptr->unmap_grain_align);
9973 scsi_ulto4b(lun->be_lun->atomicblock,
9974 bl_ptr->max_atomic_transfer_length);
9975 scsi_ulto4b(0, bl_ptr->atomic_alignment);
9976 scsi_ulto4b(0, bl_ptr->atomic_transfer_length_granularity);
9977 scsi_ulto4b(0, bl_ptr->max_atomic_transfer_length_with_atomic_boundary);
9978 scsi_ulto4b(0, bl_ptr->max_atomic_boundary_size);
9980 ctl_get_opt_number(&lun->be_lun->options, "write_same_max_lba", &ival);
9981 scsi_u64to8b(ival, bl_ptr->max_write_same_length);
9984 ctl_set_success(ctsio);
9985 ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
9986 ctsio->be_move_done = ctl_config_move_done;
9987 ctl_datamove((union ctl_io *)ctsio);
9988 return (CTL_RETVAL_COMPLETE);
9992 ctl_inquiry_evpd_bdc(struct ctl_scsiio *ctsio, int alloc_len)
9994 struct scsi_vpd_block_device_characteristics *bdc_ptr;
9995 struct ctl_lun *lun;
9999 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
10001 ctsio->kern_data_ptr = malloc(sizeof(*bdc_ptr), M_CTL, M_WAITOK | M_ZERO);
10002 bdc_ptr = (struct scsi_vpd_block_device_characteristics *)ctsio->kern_data_ptr;
10003 ctsio->kern_sg_entries = 0;
10005 if (sizeof(*bdc_ptr) < alloc_len) {
10006 ctsio->residual = alloc_len - sizeof(*bdc_ptr);
10007 ctsio->kern_data_len = sizeof(*bdc_ptr);
10008 ctsio->kern_total_len = sizeof(*bdc_ptr);
10010 ctsio->residual = 0;
10011 ctsio->kern_data_len = alloc_len;
10012 ctsio->kern_total_len = alloc_len;
10014 ctsio->kern_data_resid = 0;
10015 ctsio->kern_rel_offset = 0;
10016 ctsio->kern_sg_entries = 0;
10019 * The control device is always connected. The disk device, on the
10020 * other hand, may not be online all the time. Need to change this
10021 * to figure out whether the disk device is actually online or not.
10024 bdc_ptr->device = (SID_QUAL_LU_CONNECTED << 5) |
10025 lun->be_lun->lun_type;
10027 bdc_ptr->device = (SID_QUAL_LU_OFFLINE << 5) | T_DIRECT;
10028 bdc_ptr->page_code = SVPD_BDC;
10029 scsi_ulto2b(sizeof(*bdc_ptr) - 4, bdc_ptr->page_length);
10031 (value = ctl_get_opt(&lun->be_lun->options, "rpm")) != NULL)
10032 i = strtol(value, NULL, 0);
10034 i = CTL_DEFAULT_ROTATION_RATE;
10035 scsi_ulto2b(i, bdc_ptr->medium_rotation_rate);
10037 (value = ctl_get_opt(&lun->be_lun->options, "formfactor")) != NULL)
10038 i = strtol(value, NULL, 0);
10041 bdc_ptr->wab_wac_ff = (i & 0x0f);
10042 bdc_ptr->flags = SVPD_FUAB | SVPD_VBULS;
10044 ctl_set_success(ctsio);
10045 ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
10046 ctsio->be_move_done = ctl_config_move_done;
10047 ctl_datamove((union ctl_io *)ctsio);
10048 return (CTL_RETVAL_COMPLETE);
10052 ctl_inquiry_evpd_lbp(struct ctl_scsiio *ctsio, int alloc_len)
10054 struct scsi_vpd_logical_block_prov *lbp_ptr;
10055 struct ctl_lun *lun;
10058 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
10060 ctsio->kern_data_ptr = malloc(sizeof(*lbp_ptr), M_CTL, M_WAITOK | M_ZERO);
10061 lbp_ptr = (struct scsi_vpd_logical_block_prov *)ctsio->kern_data_ptr;
10062 ctsio->kern_sg_entries = 0;
10064 if (sizeof(*lbp_ptr) < alloc_len) {
10065 ctsio->residual = alloc_len - sizeof(*lbp_ptr);
10066 ctsio->kern_data_len = sizeof(*lbp_ptr);
10067 ctsio->kern_total_len = sizeof(*lbp_ptr);
10069 ctsio->residual = 0;
10070 ctsio->kern_data_len = alloc_len;
10071 ctsio->kern_total_len = alloc_len;
10073 ctsio->kern_data_resid = 0;
10074 ctsio->kern_rel_offset = 0;
10075 ctsio->kern_sg_entries = 0;
10078 * The control device is always connected. The disk device, on the
10079 * other hand, may not be online all the time. Need to change this
10080 * to figure out whether the disk device is actually online or not.
10083 lbp_ptr->device = (SID_QUAL_LU_CONNECTED << 5) |
10084 lun->be_lun->lun_type;
10086 lbp_ptr->device = (SID_QUAL_LU_OFFLINE << 5) | T_DIRECT;
10088 lbp_ptr->page_code = SVPD_LBP;
10089 scsi_ulto2b(sizeof(*lbp_ptr) - 4, lbp_ptr->page_length);
10090 lbp_ptr->threshold_exponent = CTL_LBP_EXPONENT;
10091 if (lun != NULL && lun->be_lun->flags & CTL_LUN_FLAG_UNMAP) {
10092 lbp_ptr->flags = SVPD_LBP_UNMAP | SVPD_LBP_WS16 |
10093 SVPD_LBP_WS10 | SVPD_LBP_RZ | SVPD_LBP_ANC_SUP;
10094 value = ctl_get_opt(&lun->be_lun->options, "provisioning_type");
10095 if (value != NULL) {
10096 if (strcmp(value, "resource") == 0)
10097 lbp_ptr->prov_type = SVPD_LBP_RESOURCE;
10098 else if (strcmp(value, "thin") == 0)
10099 lbp_ptr->prov_type = SVPD_LBP_THIN;
10101 lbp_ptr->prov_type = SVPD_LBP_THIN;
10104 ctl_set_success(ctsio);
10105 ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
10106 ctsio->be_move_done = ctl_config_move_done;
10107 ctl_datamove((union ctl_io *)ctsio);
10108 return (CTL_RETVAL_COMPLETE);
10112 * INQUIRY with the EVPD bit set.
10115 ctl_inquiry_evpd(struct ctl_scsiio *ctsio)
10117 struct ctl_lun *lun;
10118 struct scsi_inquiry *cdb;
10119 int alloc_len, retval;
10121 lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
10122 cdb = (struct scsi_inquiry *)ctsio->cdb;
10123 alloc_len = scsi_2btoul(cdb->length);
10125 switch (cdb->page_code) {
10126 case SVPD_SUPPORTED_PAGES:
10127 retval = ctl_inquiry_evpd_supported(ctsio, alloc_len);
10129 case SVPD_UNIT_SERIAL_NUMBER:
10130 retval = ctl_inquiry_evpd_serial(ctsio, alloc_len);
10132 case SVPD_DEVICE_ID:
10133 retval = ctl_inquiry_evpd_devid(ctsio, alloc_len);
10135 case SVPD_EXTENDED_INQUIRY_DATA:
10136 retval = ctl_inquiry_evpd_eid(ctsio, alloc_len);
10138 case SVPD_MODE_PAGE_POLICY:
10139 retval = ctl_inquiry_evpd_mpp(ctsio, alloc_len);
10141 case SVPD_SCSI_PORTS:
10142 retval = ctl_inquiry_evpd_scsi_ports(ctsio, alloc_len);
10144 case SVPD_SCSI_TPC:
10145 retval = ctl_inquiry_evpd_tpc(ctsio, alloc_len);
10147 case SVPD_BLOCK_LIMITS:
10148 if (lun == NULL || lun->be_lun->lun_type != T_DIRECT)
10150 retval = ctl_inquiry_evpd_block_limits(ctsio, alloc_len);
10153 if (lun == NULL || lun->be_lun->lun_type != T_DIRECT)
10155 retval = ctl_inquiry_evpd_bdc(ctsio, alloc_len);
10158 if (lun == NULL || lun->be_lun->lun_type != T_DIRECT)
10160 retval = ctl_inquiry_evpd_lbp(ctsio, alloc_len);
10164 ctl_set_invalid_field(ctsio,
10170 ctl_done((union ctl_io *)ctsio);
10171 retval = CTL_RETVAL_COMPLETE;
10179 * Standard INQUIRY data.
10182 ctl_inquiry_std(struct ctl_scsiio *ctsio)
10184 struct scsi_inquiry_data *inq_ptr;
10185 struct scsi_inquiry *cdb;
10186 struct ctl_softc *softc = control_softc;
10187 struct ctl_port *port;
10188 struct ctl_lun *lun;
10190 uint32_t alloc_len, data_len;
10191 ctl_port_type port_type;
10193 port = ctl_io_port(&ctsio->io_hdr);
10194 port_type = port->port_type;
10195 if (port_type == CTL_PORT_IOCTL || port_type == CTL_PORT_INTERNAL)
10196 port_type = CTL_PORT_SCSI;
10198 lun = ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
10199 cdb = (struct scsi_inquiry *)ctsio->cdb;
10200 alloc_len = scsi_2btoul(cdb->length);
10203 * We malloc the full inquiry data size here and fill it
10204 * in. If the user only asks for less, we'll give him
10207 data_len = offsetof(struct scsi_inquiry_data, vendor_specific1);
10208 ctsio->kern_data_ptr = malloc(data_len, M_CTL, M_WAITOK | M_ZERO);
10209 inq_ptr = (struct scsi_inquiry_data *)ctsio->kern_data_ptr;
10210 ctsio->kern_sg_entries = 0;
10211 ctsio->kern_data_resid = 0;
10212 ctsio->kern_rel_offset = 0;
10214 if (data_len < alloc_len) {
10215 ctsio->residual = alloc_len - data_len;
10216 ctsio->kern_data_len = data_len;
10217 ctsio->kern_total_len = data_len;
10219 ctsio->residual = 0;
10220 ctsio->kern_data_len = alloc_len;
10221 ctsio->kern_total_len = alloc_len;
10225 if ((lun->flags & CTL_LUN_PRIMARY_SC) ||
10226 softc->ha_link >= CTL_HA_LINK_UNKNOWN) {
10227 inq_ptr->device = (SID_QUAL_LU_CONNECTED << 5) |
10228 lun->be_lun->lun_type;
10230 inq_ptr->device = (SID_QUAL_LU_OFFLINE << 5) |
10231 lun->be_lun->lun_type;
10233 if (lun->flags & CTL_LUN_REMOVABLE)
10234 inq_ptr->dev_qual2 |= SID_RMB;
10236 inq_ptr->device = (SID_QUAL_BAD_LU << 5) | T_NODEVICE;
10238 /* RMB in byte 2 is 0 */
10239 inq_ptr->version = SCSI_REV_SPC4;
10242 * According to SAM-3, even if a device only supports a single
10243 * level of LUN addressing, it should still set the HISUP bit:
10245 * 4.9.1 Logical unit numbers overview
10247 * All logical unit number formats described in this standard are
10248 * hierarchical in structure even when only a single level in that
10249 * hierarchy is used. The HISUP bit shall be set to one in the
10250 * standard INQUIRY data (see SPC-2) when any logical unit number
10251 * format described in this standard is used. Non-hierarchical
10252 * formats are outside the scope of this standard.
10254 * Therefore we set the HiSup bit here.
10256 * The response format is 2, per SPC-3.
10258 inq_ptr->response_format = SID_HiSup | 2;
10260 inq_ptr->additional_length = data_len -
10261 (offsetof(struct scsi_inquiry_data, additional_length) + 1);
10262 CTL_DEBUG_PRINT(("additional_length = %d\n",
10263 inq_ptr->additional_length));
10265 inq_ptr->spc3_flags = SPC3_SID_3PC | SPC3_SID_TPGS_IMPLICIT;
10266 if (port_type == CTL_PORT_SCSI)
10267 inq_ptr->spc2_flags = SPC2_SID_ADDR16;
10268 inq_ptr->spc2_flags |= SPC2_SID_MultiP;
10269 inq_ptr->flags = SID_CmdQue;
10270 if (port_type == CTL_PORT_SCSI)
10271 inq_ptr->flags |= SID_WBus16 | SID_Sync;
10274 * Per SPC-3, unused bytes in ASCII strings are filled with spaces.
10275 * We have 8 bytes for the vendor name, and 16 bytes for the device
10276 * name and 4 bytes for the revision.
10278 if (lun == NULL || (val = ctl_get_opt(&lun->be_lun->options,
10279 "vendor")) == NULL) {
10280 strncpy(inq_ptr->vendor, CTL_VENDOR, sizeof(inq_ptr->vendor));
10282 memset(inq_ptr->vendor, ' ', sizeof(inq_ptr->vendor));
10283 strncpy(inq_ptr->vendor, val,
10284 min(sizeof(inq_ptr->vendor), strlen(val)));
10287 strncpy(inq_ptr->product, CTL_DIRECT_PRODUCT,
10288 sizeof(inq_ptr->product));
10289 } else if ((val = ctl_get_opt(&lun->be_lun->options, "product")) == NULL) {
10290 switch (lun->be_lun->lun_type) {
10292 strncpy(inq_ptr->product, CTL_DIRECT_PRODUCT,
10293 sizeof(inq_ptr->product));
10296 strncpy(inq_ptr->product, CTL_PROCESSOR_PRODUCT,
10297 sizeof(inq_ptr->product));
10300 strncpy(inq_ptr->product, CTL_CDROM_PRODUCT,
10301 sizeof(inq_ptr->product));
10304 strncpy(inq_ptr->product, CTL_UNKNOWN_PRODUCT,
10305 sizeof(inq_ptr->product));
10309 memset(inq_ptr->product, ' ', sizeof(inq_ptr->product));
10310 strncpy(inq_ptr->product, val,
10311 min(sizeof(inq_ptr->product), strlen(val)));
10315 * XXX make this a macro somewhere so it automatically gets
10316 * incremented when we make changes.
10318 if (lun == NULL || (val = ctl_get_opt(&lun->be_lun->options,
10319 "revision")) == NULL) {
10320 strncpy(inq_ptr->revision, "0001", sizeof(inq_ptr->revision));
10322 memset(inq_ptr->revision, ' ', sizeof(inq_ptr->revision));
10323 strncpy(inq_ptr->revision, val,
10324 min(sizeof(inq_ptr->revision), strlen(val)));
10328 * For parallel SCSI, we support double transition and single
10329 * transition clocking. We also support QAS (Quick Arbitration
10330 * and Selection) and Information Unit transfers on both the
10331 * control and array devices.
10333 if (port_type == CTL_PORT_SCSI)
10334 inq_ptr->spi3data = SID_SPI_CLOCK_DT_ST | SID_SPI_QAS |
10337 /* SAM-5 (no version claimed) */
10338 scsi_ulto2b(0x00A0, inq_ptr->version1);
10339 /* SPC-4 (no version claimed) */
10340 scsi_ulto2b(0x0460, inq_ptr->version2);
10341 if (port_type == CTL_PORT_FC) {
10342 /* FCP-2 ANSI INCITS.350:2003 */
10343 scsi_ulto2b(0x0917, inq_ptr->version3);
10344 } else if (port_type == CTL_PORT_SCSI) {
10345 /* SPI-4 ANSI INCITS.362:200x */
10346 scsi_ulto2b(0x0B56, inq_ptr->version3);
10347 } else if (port_type == CTL_PORT_ISCSI) {
10348 /* iSCSI (no version claimed) */
10349 scsi_ulto2b(0x0960, inq_ptr->version3);
10350 } else if (port_type == CTL_PORT_SAS) {
10351 /* SAS (no version claimed) */
10352 scsi_ulto2b(0x0BE0, inq_ptr->version3);
10356 /* SBC-4 (no version claimed) */
10357 scsi_ulto2b(0x0600, inq_ptr->version4);
10359 switch (lun->be_lun->lun_type) {
10361 /* SBC-4 (no version claimed) */
10362 scsi_ulto2b(0x0600, inq_ptr->version4);
10367 /* MMC-6 (no version claimed) */
10368 scsi_ulto2b(0x04E0, inq_ptr->version4);
10375 ctl_set_success(ctsio);
10376 ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
10377 ctsio->be_move_done = ctl_config_move_done;
10378 ctl_datamove((union ctl_io *)ctsio);
10379 return (CTL_RETVAL_COMPLETE);
10383 ctl_inquiry(struct ctl_scsiio *ctsio)
10385 struct scsi_inquiry *cdb;
10388 CTL_DEBUG_PRINT(("ctl_inquiry\n"));
10390 cdb = (struct scsi_inquiry *)ctsio->cdb;
10391 if (cdb->byte2 & SI_EVPD)
10392 retval = ctl_inquiry_evpd(ctsio);
10393 else if (cdb->page_code == 0)
10394 retval = ctl_inquiry_std(ctsio);
10396 ctl_set_invalid_field(ctsio,
10402 ctl_done((union ctl_io *)ctsio);
10403 return (CTL_RETVAL_COMPLETE);
10410 ctl_get_config(struct ctl_scsiio *ctsio)
10412 struct scsi_get_config_header *hdr;
10413 struct scsi_get_config_feature *feature;
10414 struct scsi_get_config *cdb;
10415 struct ctl_lun *lun;
10416 uint32_t alloc_len, data_len;
10419 lun = ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
10420 cdb = (struct scsi_get_config *)ctsio->cdb;
10421 rt = (cdb->rt & SGC_RT_MASK);
10422 starting = scsi_2btoul(cdb->starting_feature);
10423 alloc_len = scsi_2btoul(cdb->length);
10425 data_len = sizeof(struct scsi_get_config_header) +
10426 sizeof(struct scsi_get_config_feature) + 8 +
10427 sizeof(struct scsi_get_config_feature) + 8 +
10428 sizeof(struct scsi_get_config_feature) + 4 +
10429 sizeof(struct scsi_get_config_feature) + 4 +
10430 sizeof(struct scsi_get_config_feature) + 8 +
10431 sizeof(struct scsi_get_config_feature) +
10432 sizeof(struct scsi_get_config_feature) + 4 +
10433 sizeof(struct scsi_get_config_feature) + 4 +
10434 sizeof(struct scsi_get_config_feature) + 4 +
10435 sizeof(struct scsi_get_config_feature) + 4 +
10436 sizeof(struct scsi_get_config_feature) + 4 +
10437 sizeof(struct scsi_get_config_feature) + 4;
10438 ctsio->kern_data_ptr = malloc(data_len, M_CTL, M_WAITOK | M_ZERO);
10439 ctsio->kern_sg_entries = 0;
10440 ctsio->kern_data_resid = 0;
10441 ctsio->kern_rel_offset = 0;
10443 hdr = (struct scsi_get_config_header *)ctsio->kern_data_ptr;
10444 if (lun->flags & CTL_LUN_NO_MEDIA)
10445 scsi_ulto2b(0x0000, hdr->current_profile);
10447 scsi_ulto2b(0x0010, hdr->current_profile);
10448 feature = (struct scsi_get_config_feature *)(hdr + 1);
10450 if (starting > 0x003b)
10452 if (starting > 0x003a)
10454 if (starting > 0x002b)
10456 if (starting > 0x002a)
10458 if (starting > 0x001f)
10460 if (starting > 0x001e)
10462 if (starting > 0x001d)
10464 if (starting > 0x0010)
10466 if (starting > 0x0003)
10468 if (starting > 0x0002)
10470 if (starting > 0x0001)
10472 if (starting > 0x0000)
10476 scsi_ulto2b(0x0000, feature->feature_code);
10477 feature->flags = SGC_F_PERSISTENT | SGC_F_CURRENT;
10478 feature->add_length = 8;
10479 scsi_ulto2b(0x0008, &feature->feature_data[0]); /* CD-ROM */
10480 feature->feature_data[2] = 0x00;
10481 scsi_ulto2b(0x0010, &feature->feature_data[4]); /* DVD-ROM */
10482 feature->feature_data[6] = 0x01;
10483 feature = (struct scsi_get_config_feature *)
10484 &feature->feature_data[feature->add_length];
10487 scsi_ulto2b(0x0001, feature->feature_code);
10488 feature->flags = 0x08 | SGC_F_PERSISTENT | SGC_F_CURRENT;
10489 feature->add_length = 8;
10490 scsi_ulto4b(0x00000000, &feature->feature_data[0]);
10491 feature->feature_data[4] = 0x03;
10492 feature = (struct scsi_get_config_feature *)
10493 &feature->feature_data[feature->add_length];
10496 scsi_ulto2b(0x0002, feature->feature_code);
10497 feature->flags = 0x04 | SGC_F_PERSISTENT | SGC_F_CURRENT;
10498 feature->add_length = 4;
10499 feature->feature_data[0] = 0x02;
10500 feature = (struct scsi_get_config_feature *)
10501 &feature->feature_data[feature->add_length];
10503 f3: /* Removable Medium */
10504 scsi_ulto2b(0x0003, feature->feature_code);
10505 feature->flags = 0x04 | SGC_F_PERSISTENT | SGC_F_CURRENT;
10506 feature->add_length = 4;
10507 feature->feature_data[0] = 0x39;
10508 feature = (struct scsi_get_config_feature *)
10509 &feature->feature_data[feature->add_length];
10511 if (rt == SGC_RT_CURRENT && (lun->flags & CTL_LUN_NO_MEDIA))
10514 f10: /* Random Read */
10515 scsi_ulto2b(0x0010, feature->feature_code);
10516 feature->flags = 0x00;
10517 if ((lun->flags & CTL_LUN_NO_MEDIA) == 0)
10518 feature->flags |= SGC_F_CURRENT;
10519 feature->add_length = 8;
10520 scsi_ulto4b(lun->be_lun->blocksize, &feature->feature_data[0]);
10521 scsi_ulto2b(1, &feature->feature_data[4]);
10522 feature->feature_data[6] = 0x00;
10523 feature = (struct scsi_get_config_feature *)
10524 &feature->feature_data[feature->add_length];
10526 f1d: /* Multi-Read */
10527 scsi_ulto2b(0x001D, feature->feature_code);
10528 feature->flags = 0x00;
10529 if ((lun->flags & CTL_LUN_NO_MEDIA) == 0)
10530 feature->flags |= SGC_F_CURRENT;
10531 feature->add_length = 0;
10532 feature = (struct scsi_get_config_feature *)
10533 &feature->feature_data[feature->add_length];
10536 scsi_ulto2b(0x001E, feature->feature_code);
10537 feature->flags = 0x00;
10538 if ((lun->flags & CTL_LUN_NO_MEDIA) == 0)
10539 feature->flags |= SGC_F_CURRENT;
10540 feature->add_length = 4;
10541 feature->feature_data[0] = 0x00;
10542 feature = (struct scsi_get_config_feature *)
10543 &feature->feature_data[feature->add_length];
10545 f1f: /* DVD Read */
10546 scsi_ulto2b(0x001F, feature->feature_code);
10547 feature->flags = 0x08;
10548 if ((lun->flags & CTL_LUN_NO_MEDIA) == 0)
10549 feature->flags |= SGC_F_CURRENT;
10550 feature->add_length = 4;
10551 feature->feature_data[0] = 0x01;
10552 feature->feature_data[2] = 0x03;
10553 feature = (struct scsi_get_config_feature *)
10554 &feature->feature_data[feature->add_length];
10557 scsi_ulto2b(0x002A, feature->feature_code);
10558 feature->flags = 0x04;
10559 if ((lun->flags & CTL_LUN_NO_MEDIA) == 0)
10560 feature->flags |= SGC_F_CURRENT;
10561 feature->add_length = 4;
10562 feature->feature_data[0] = 0x00;
10563 feature->feature_data[1] = 0x00;
10564 feature = (struct scsi_get_config_feature *)
10565 &feature->feature_data[feature->add_length];
10568 scsi_ulto2b(0x002B, feature->feature_code);
10569 feature->flags = 0x00;
10570 if ((lun->flags & CTL_LUN_NO_MEDIA) == 0)
10571 feature->flags |= SGC_F_CURRENT;
10572 feature->add_length = 4;
10573 feature->feature_data[0] = 0x00;
10574 feature = (struct scsi_get_config_feature *)
10575 &feature->feature_data[feature->add_length];
10577 f3a: /* DVD+RW Dual Layer */
10578 scsi_ulto2b(0x003A, feature->feature_code);
10579 feature->flags = 0x00;
10580 if ((lun->flags & CTL_LUN_NO_MEDIA) == 0)
10581 feature->flags |= SGC_F_CURRENT;
10582 feature->add_length = 4;
10583 feature->feature_data[0] = 0x00;
10584 feature->feature_data[1] = 0x00;
10585 feature = (struct scsi_get_config_feature *)
10586 &feature->feature_data[feature->add_length];
10588 f3b: /* DVD+R Dual Layer */
10589 scsi_ulto2b(0x003B, feature->feature_code);
10590 feature->flags = 0x00;
10591 if ((lun->flags & CTL_LUN_NO_MEDIA) == 0)
10592 feature->flags |= SGC_F_CURRENT;
10593 feature->add_length = 4;
10594 feature->feature_data[0] = 0x00;
10595 feature = (struct scsi_get_config_feature *)
10596 &feature->feature_data[feature->add_length];
10599 data_len = (uint8_t *)feature - (uint8_t *)hdr;
10600 if (rt == SGC_RT_SPECIFIC && data_len > 4) {
10601 feature = (struct scsi_get_config_feature *)(hdr + 1);
10602 if (scsi_2btoul(feature->feature_code) == starting)
10603 feature = (struct scsi_get_config_feature *)
10604 &feature->feature_data[feature->add_length];
10605 data_len = (uint8_t *)feature - (uint8_t *)hdr;
10607 scsi_ulto4b(data_len - 4, hdr->data_length);
10608 if (data_len < alloc_len) {
10609 ctsio->residual = alloc_len - data_len;
10610 ctsio->kern_data_len = data_len;
10611 ctsio->kern_total_len = data_len;
10613 ctsio->residual = 0;
10614 ctsio->kern_data_len = alloc_len;
10615 ctsio->kern_total_len = alloc_len;
10618 ctl_set_success(ctsio);
10619 ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
10620 ctsio->be_move_done = ctl_config_move_done;
10621 ctl_datamove((union ctl_io *)ctsio);
10622 return (CTL_RETVAL_COMPLETE);
10626 ctl_get_event_status(struct ctl_scsiio *ctsio)
10628 struct scsi_get_event_status_header *hdr;
10629 struct scsi_get_event_status *cdb;
10630 struct ctl_lun *lun;
10631 uint32_t alloc_len, data_len;
10634 lun = ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
10635 cdb = (struct scsi_get_event_status *)ctsio->cdb;
10636 if ((cdb->byte2 & SGESN_POLLED) == 0) {
10637 ctl_set_invalid_field(ctsio, /*sks_valid*/ 1, /*command*/ 1,
10638 /*field*/ 1, /*bit_valid*/ 1, /*bit*/ 0);
10639 ctl_done((union ctl_io *)ctsio);
10640 return (CTL_RETVAL_COMPLETE);
10642 notif_class = cdb->notif_class;
10643 alloc_len = scsi_2btoul(cdb->length);
10645 data_len = sizeof(struct scsi_get_event_status_header);
10646 ctsio->kern_data_ptr = malloc(data_len, M_CTL, M_WAITOK | M_ZERO);
10647 ctsio->kern_sg_entries = 0;
10648 ctsio->kern_data_resid = 0;
10649 ctsio->kern_rel_offset = 0;
10651 if (data_len < alloc_len) {
10652 ctsio->residual = alloc_len - data_len;
10653 ctsio->kern_data_len = data_len;
10654 ctsio->kern_total_len = data_len;
10656 ctsio->residual = 0;
10657 ctsio->kern_data_len = alloc_len;
10658 ctsio->kern_total_len = alloc_len;
10661 hdr = (struct scsi_get_event_status_header *)ctsio->kern_data_ptr;
10662 scsi_ulto2b(0, hdr->descr_length);
10663 hdr->nea_class = SGESN_NEA;
10664 hdr->supported_class = 0;
10666 ctl_set_success(ctsio);
10667 ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
10668 ctsio->be_move_done = ctl_config_move_done;
10669 ctl_datamove((union ctl_io *)ctsio);
10670 return (CTL_RETVAL_COMPLETE);
10674 ctl_mechanism_status(struct ctl_scsiio *ctsio)
10676 struct scsi_mechanism_status_header *hdr;
10677 struct scsi_mechanism_status *cdb;
10678 struct ctl_lun *lun;
10679 uint32_t alloc_len, data_len;
10681 lun = ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
10682 cdb = (struct scsi_mechanism_status *)ctsio->cdb;
10683 alloc_len = scsi_2btoul(cdb->length);
10685 data_len = sizeof(struct scsi_mechanism_status_header);
10686 ctsio->kern_data_ptr = malloc(data_len, M_CTL, M_WAITOK | M_ZERO);
10687 ctsio->kern_sg_entries = 0;
10688 ctsio->kern_data_resid = 0;
10689 ctsio->kern_rel_offset = 0;
10691 if (data_len < alloc_len) {
10692 ctsio->residual = alloc_len - data_len;
10693 ctsio->kern_data_len = data_len;
10694 ctsio->kern_total_len = data_len;
10696 ctsio->residual = 0;
10697 ctsio->kern_data_len = alloc_len;
10698 ctsio->kern_total_len = alloc_len;
10701 hdr = (struct scsi_mechanism_status_header *)ctsio->kern_data_ptr;
10702 hdr->state1 = 0x00;
10703 hdr->state2 = 0xe0;
10704 scsi_ulto3b(0, hdr->lba);
10705 hdr->slots_num = 0;
10706 scsi_ulto2b(0, hdr->slots_length);
10708 ctl_set_success(ctsio);
10709 ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
10710 ctsio->be_move_done = ctl_config_move_done;
10711 ctl_datamove((union ctl_io *)ctsio);
10712 return (CTL_RETVAL_COMPLETE);
10716 ctl_ultomsf(uint32_t lba, uint8_t *buf)
10721 buf[1] = bin2bcd((lba / 75) / 60);
10722 buf[2] = bin2bcd((lba / 75) % 60);
10723 buf[3] = bin2bcd(lba % 75);
10727 ctl_read_toc(struct ctl_scsiio *ctsio)
10729 struct scsi_read_toc_hdr *hdr;
10730 struct scsi_read_toc_type01_descr *descr;
10731 struct scsi_read_toc *cdb;
10732 struct ctl_lun *lun;
10733 uint32_t alloc_len, data_len;
10736 lun = ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
10737 cdb = (struct scsi_read_toc *)ctsio->cdb;
10738 msf = (cdb->byte2 & CD_MSF) != 0;
10739 format = cdb->format;
10740 alloc_len = scsi_2btoul(cdb->data_len);
10742 data_len = sizeof(struct scsi_read_toc_hdr);
10744 data_len += 2 * sizeof(struct scsi_read_toc_type01_descr);
10746 data_len += sizeof(struct scsi_read_toc_type01_descr);
10747 ctsio->kern_data_ptr = malloc(data_len, M_CTL, M_WAITOK | M_ZERO);
10748 ctsio->kern_sg_entries = 0;
10749 ctsio->kern_data_resid = 0;
10750 ctsio->kern_rel_offset = 0;
10752 if (data_len < alloc_len) {
10753 ctsio->residual = alloc_len - data_len;
10754 ctsio->kern_data_len = data_len;
10755 ctsio->kern_total_len = data_len;
10757 ctsio->residual = 0;
10758 ctsio->kern_data_len = alloc_len;
10759 ctsio->kern_total_len = alloc_len;
10762 hdr = (struct scsi_read_toc_hdr *)ctsio->kern_data_ptr;
10764 scsi_ulto2b(0x12, hdr->data_length);
10767 descr = (struct scsi_read_toc_type01_descr *)(hdr + 1);
10768 descr->addr_ctl = 0x14;
10769 descr->track_number = 1;
10771 ctl_ultomsf(0, descr->track_start);
10773 scsi_ulto4b(0, descr->track_start);
10775 descr->addr_ctl = 0x14;
10776 descr->track_number = 0xaa;
10778 ctl_ultomsf(lun->be_lun->maxlba+1, descr->track_start);
10780 scsi_ulto4b(lun->be_lun->maxlba+1, descr->track_start);
10782 scsi_ulto2b(0x0a, hdr->data_length);
10785 descr = (struct scsi_read_toc_type01_descr *)(hdr + 1);
10786 descr->addr_ctl = 0x14;
10787 descr->track_number = 1;
10789 ctl_ultomsf(0, descr->track_start);
10791 scsi_ulto4b(0, descr->track_start);
10794 ctl_set_success(ctsio);
10795 ctsio->io_hdr.flags |= CTL_FLAG_ALLOCATED;
10796 ctsio->be_move_done = ctl_config_move_done;
10797 ctl_datamove((union ctl_io *)ctsio);
10798 return (CTL_RETVAL_COMPLETE);
10802 * For known CDB types, parse the LBA and length.
10805 ctl_get_lba_len(union ctl_io *io, uint64_t *lba, uint64_t *len)
10807 if (io->io_hdr.io_type != CTL_IO_SCSI)
10810 switch (io->scsiio.cdb[0]) {
10811 case COMPARE_AND_WRITE: {
10812 struct scsi_compare_and_write *cdb;
10814 cdb = (struct scsi_compare_and_write *)io->scsiio.cdb;
10816 *lba = scsi_8btou64(cdb->addr);
10817 *len = cdb->length;
10822 struct scsi_rw_6 *cdb;
10824 cdb = (struct scsi_rw_6 *)io->scsiio.cdb;
10826 *lba = scsi_3btoul(cdb->addr);
10827 /* only 5 bits are valid in the most significant address byte */
10829 *len = cdb->length;
10834 struct scsi_rw_10 *cdb;
10836 cdb = (struct scsi_rw_10 *)io->scsiio.cdb;
10838 *lba = scsi_4btoul(cdb->addr);
10839 *len = scsi_2btoul(cdb->length);
10842 case WRITE_VERIFY_10: {
10843 struct scsi_write_verify_10 *cdb;
10845 cdb = (struct scsi_write_verify_10 *)io->scsiio.cdb;
10847 *lba = scsi_4btoul(cdb->addr);
10848 *len = scsi_2btoul(cdb->length);
10853 struct scsi_rw_12 *cdb;
10855 cdb = (struct scsi_rw_12 *)io->scsiio.cdb;
10857 *lba = scsi_4btoul(cdb->addr);
10858 *len = scsi_4btoul(cdb->length);
10861 case WRITE_VERIFY_12: {
10862 struct scsi_write_verify_12 *cdb;
10864 cdb = (struct scsi_write_verify_12 *)io->scsiio.cdb;
10866 *lba = scsi_4btoul(cdb->addr);
10867 *len = scsi_4btoul(cdb->length);
10872 struct scsi_rw_16 *cdb;
10874 cdb = (struct scsi_rw_16 *)io->scsiio.cdb;
10876 *lba = scsi_8btou64(cdb->addr);
10877 *len = scsi_4btoul(cdb->length);
10880 case WRITE_ATOMIC_16: {
10881 struct scsi_write_atomic_16 *cdb;
10883 cdb = (struct scsi_write_atomic_16 *)io->scsiio.cdb;
10885 *lba = scsi_8btou64(cdb->addr);
10886 *len = scsi_2btoul(cdb->length);
10889 case WRITE_VERIFY_16: {
10890 struct scsi_write_verify_16 *cdb;
10892 cdb = (struct scsi_write_verify_16 *)io->scsiio.cdb;
10894 *lba = scsi_8btou64(cdb->addr);
10895 *len = scsi_4btoul(cdb->length);
10898 case WRITE_SAME_10: {
10899 struct scsi_write_same_10 *cdb;
10901 cdb = (struct scsi_write_same_10 *)io->scsiio.cdb;
10903 *lba = scsi_4btoul(cdb->addr);
10904 *len = scsi_2btoul(cdb->length);
10907 case WRITE_SAME_16: {
10908 struct scsi_write_same_16 *cdb;
10910 cdb = (struct scsi_write_same_16 *)io->scsiio.cdb;
10912 *lba = scsi_8btou64(cdb->addr);
10913 *len = scsi_4btoul(cdb->length);
10917 struct scsi_verify_10 *cdb;
10919 cdb = (struct scsi_verify_10 *)io->scsiio.cdb;
10921 *lba = scsi_4btoul(cdb->addr);
10922 *len = scsi_2btoul(cdb->length);
10926 struct scsi_verify_12 *cdb;
10928 cdb = (struct scsi_verify_12 *)io->scsiio.cdb;
10930 *lba = scsi_4btoul(cdb->addr);
10931 *len = scsi_4btoul(cdb->length);
10935 struct scsi_verify_16 *cdb;
10937 cdb = (struct scsi_verify_16 *)io->scsiio.cdb;
10939 *lba = scsi_8btou64(cdb->addr);
10940 *len = scsi_4btoul(cdb->length);
10948 case SERVICE_ACTION_IN: { /* GET LBA STATUS */
10949 struct scsi_get_lba_status *cdb;
10951 cdb = (struct scsi_get_lba_status *)io->scsiio.cdb;
10952 *lba = scsi_8btou64(cdb->addr);
10958 break; /* NOTREACHED */
10965 ctl_extent_check_lba(uint64_t lba1, uint64_t len1, uint64_t lba2, uint64_t len2,
10968 uint64_t endlba1, endlba2;
10970 endlba1 = lba1 + len1 - (seq ? 0 : 1);
10971 endlba2 = lba2 + len2 - 1;
10973 if ((endlba1 < lba2) || (endlba2 < lba1))
10974 return (CTL_ACTION_PASS);
10976 return (CTL_ACTION_BLOCK);
10980 ctl_extent_check_unmap(union ctl_io *io, uint64_t lba2, uint64_t len2)
10982 struct ctl_ptr_len_flags *ptrlen;
10983 struct scsi_unmap_desc *buf, *end, *range;
10987 /* If not UNMAP -- go other way. */
10988 if (io->io_hdr.io_type != CTL_IO_SCSI ||
10989 io->scsiio.cdb[0] != UNMAP)
10990 return (CTL_ACTION_ERROR);
10992 /* If UNMAP without data -- block and wait for data. */
10993 ptrlen = (struct ctl_ptr_len_flags *)
10994 &io->io_hdr.ctl_private[CTL_PRIV_LBA_LEN];
10995 if ((io->io_hdr.flags & CTL_FLAG_ALLOCATED) == 0 ||
10996 ptrlen->ptr == NULL)
10997 return (CTL_ACTION_BLOCK);
10999 /* UNMAP with data -- check for collision. */
11000 buf = (struct scsi_unmap_desc *)ptrlen->ptr;
11001 end = buf + ptrlen->len / sizeof(*buf);
11002 for (range = buf; range < end; range++) {
11003 lba = scsi_8btou64(range->lba);
11004 len = scsi_4btoul(range->length);
11005 if ((lba < lba2 + len2) && (lba + len > lba2))
11006 return (CTL_ACTION_BLOCK);
11008 return (CTL_ACTION_PASS);
11012 ctl_extent_check(union ctl_io *io1, union ctl_io *io2, bool seq)
11014 uint64_t lba1, lba2;
11015 uint64_t len1, len2;
11018 if (ctl_get_lba_len(io2, &lba2, &len2) != 0)
11019 return (CTL_ACTION_ERROR);
11021 retval = ctl_extent_check_unmap(io1, lba2, len2);
11022 if (retval != CTL_ACTION_ERROR)
11025 if (ctl_get_lba_len(io1, &lba1, &len1) != 0)
11026 return (CTL_ACTION_ERROR);
11028 if (io1->io_hdr.flags & CTL_FLAG_SERSEQ_DONE)
11030 return (ctl_extent_check_lba(lba1, len1, lba2, len2, seq));
11034 ctl_extent_check_seq(union ctl_io *io1, union ctl_io *io2)
11036 uint64_t lba1, lba2;
11037 uint64_t len1, len2;
11039 if (io1->io_hdr.flags & CTL_FLAG_SERSEQ_DONE)
11040 return (CTL_ACTION_PASS);
11041 if (ctl_get_lba_len(io1, &lba1, &len1) != 0)
11042 return (CTL_ACTION_ERROR);
11043 if (ctl_get_lba_len(io2, &lba2, &len2) != 0)
11044 return (CTL_ACTION_ERROR);
11046 if (lba1 + len1 == lba2)
11047 return (CTL_ACTION_BLOCK);
11048 return (CTL_ACTION_PASS);
11052 ctl_check_for_blockage(struct ctl_lun *lun, union ctl_io *pending_io,
11053 union ctl_io *ooa_io)
11055 const struct ctl_cmd_entry *pending_entry, *ooa_entry;
11056 const ctl_serialize_action *serialize_row;
11059 * The initiator attempted multiple untagged commands at the same
11060 * time. Can't do that.
11062 if ((pending_io->scsiio.tag_type == CTL_TAG_UNTAGGED)
11063 && (ooa_io->scsiio.tag_type == CTL_TAG_UNTAGGED)
11064 && ((pending_io->io_hdr.nexus.targ_port ==
11065 ooa_io->io_hdr.nexus.targ_port)
11066 && (pending_io->io_hdr.nexus.initid ==
11067 ooa_io->io_hdr.nexus.initid))
11068 && ((ooa_io->io_hdr.flags & (CTL_FLAG_ABORT |
11069 CTL_FLAG_STATUS_SENT)) == 0))
11070 return (CTL_ACTION_OVERLAP);
11073 * The initiator attempted to send multiple tagged commands with
11074 * the same ID. (It's fine if different initiators have the same
11077 * Even if all of those conditions are true, we don't kill the I/O
11078 * if the command ahead of us has been aborted. We won't end up
11079 * sending it to the FETD, and it's perfectly legal to resend a
11080 * command with the same tag number as long as the previous
11081 * instance of this tag number has been aborted somehow.
11083 if ((pending_io->scsiio.tag_type != CTL_TAG_UNTAGGED)
11084 && (ooa_io->scsiio.tag_type != CTL_TAG_UNTAGGED)
11085 && (pending_io->scsiio.tag_num == ooa_io->scsiio.tag_num)
11086 && ((pending_io->io_hdr.nexus.targ_port ==
11087 ooa_io->io_hdr.nexus.targ_port)
11088 && (pending_io->io_hdr.nexus.initid ==
11089 ooa_io->io_hdr.nexus.initid))
11090 && ((ooa_io->io_hdr.flags & (CTL_FLAG_ABORT |
11091 CTL_FLAG_STATUS_SENT)) == 0))
11092 return (CTL_ACTION_OVERLAP_TAG);
11095 * If we get a head of queue tag, SAM-3 says that we should
11096 * immediately execute it.
11098 * What happens if this command would normally block for some other
11099 * reason? e.g. a request sense with a head of queue tag
11100 * immediately after a write. Normally that would block, but this
11101 * will result in its getting executed immediately...
11103 * We currently return "pass" instead of "skip", so we'll end up
11104 * going through the rest of the queue to check for overlapped tags.
11106 * XXX KDM check for other types of blockage first??
11108 if (pending_io->scsiio.tag_type == CTL_TAG_HEAD_OF_QUEUE)
11109 return (CTL_ACTION_PASS);
11112 * Ordered tags have to block until all items ahead of them
11113 * have completed. If we get called with an ordered tag, we always
11114 * block, if something else is ahead of us in the queue.
11116 if (pending_io->scsiio.tag_type == CTL_TAG_ORDERED)
11117 return (CTL_ACTION_BLOCK);
11120 * Simple tags get blocked until all head of queue and ordered tags
11121 * ahead of them have completed. I'm lumping untagged commands in
11122 * with simple tags here. XXX KDM is that the right thing to do?
11124 if (((pending_io->scsiio.tag_type == CTL_TAG_UNTAGGED)
11125 || (pending_io->scsiio.tag_type == CTL_TAG_SIMPLE))
11126 && ((ooa_io->scsiio.tag_type == CTL_TAG_HEAD_OF_QUEUE)
11127 || (ooa_io->scsiio.tag_type == CTL_TAG_ORDERED)))
11128 return (CTL_ACTION_BLOCK);
11130 pending_entry = ctl_get_cmd_entry(&pending_io->scsiio, NULL);
11131 KASSERT(pending_entry->seridx < CTL_SERIDX_COUNT,
11132 ("%s: Invalid seridx %d for pending CDB %02x %02x @ %p",
11133 __func__, pending_entry->seridx, pending_io->scsiio.cdb[0],
11134 pending_io->scsiio.cdb[1], pending_io));
11135 ooa_entry = ctl_get_cmd_entry(&ooa_io->scsiio, NULL);
11136 if (ooa_entry->seridx == CTL_SERIDX_INVLD)
11137 return (CTL_ACTION_PASS); /* Unsupported command in OOA queue */
11138 KASSERT(ooa_entry->seridx < CTL_SERIDX_COUNT,
11139 ("%s: Invalid seridx %d for ooa CDB %02x %02x @ %p",
11140 __func__, ooa_entry->seridx, ooa_io->scsiio.cdb[0],
11141 ooa_io->scsiio.cdb[1], ooa_io));
11143 serialize_row = ctl_serialize_table[ooa_entry->seridx];
11145 switch (serialize_row[pending_entry->seridx]) {
11146 case CTL_SER_BLOCK:
11147 return (CTL_ACTION_BLOCK);
11148 case CTL_SER_EXTENT:
11149 return (ctl_extent_check(ooa_io, pending_io,
11150 (lun->be_lun && lun->be_lun->serseq == CTL_LUN_SERSEQ_ON)));
11151 case CTL_SER_EXTENTOPT:
11152 if ((lun->mode_pages.control_page[CTL_PAGE_CURRENT].queue_flags
11153 & SCP_QUEUE_ALG_MASK) != SCP_QUEUE_ALG_UNRESTRICTED)
11154 return (ctl_extent_check(ooa_io, pending_io,
11156 lun->be_lun->serseq == CTL_LUN_SERSEQ_ON)));
11157 return (CTL_ACTION_PASS);
11158 case CTL_SER_EXTENTSEQ:
11159 if (lun->be_lun && lun->be_lun->serseq != CTL_LUN_SERSEQ_OFF)
11160 return (ctl_extent_check_seq(ooa_io, pending_io));
11161 return (CTL_ACTION_PASS);
11163 return (CTL_ACTION_PASS);
11164 case CTL_SER_BLOCKOPT:
11165 if ((lun->mode_pages.control_page[CTL_PAGE_CURRENT].queue_flags
11166 & SCP_QUEUE_ALG_MASK) != SCP_QUEUE_ALG_UNRESTRICTED)
11167 return (CTL_ACTION_BLOCK);
11168 return (CTL_ACTION_PASS);
11170 return (CTL_ACTION_SKIP);
11172 panic("%s: Invalid serialization value %d for %d => %d",
11173 __func__, serialize_row[pending_entry->seridx],
11174 pending_entry->seridx, ooa_entry->seridx);
11177 return (CTL_ACTION_ERROR);
11181 * Check for blockage or overlaps against the OOA (Order Of Arrival) queue.
11183 * - pending_io is generally either incoming, or on the blocked queue
11184 * - starting I/O is the I/O we want to start the check with.
11187 ctl_check_ooa(struct ctl_lun *lun, union ctl_io *pending_io,
11188 union ctl_io *starting_io)
11190 union ctl_io *ooa_io;
11193 mtx_assert(&lun->lun_lock, MA_OWNED);
11196 * Run back along the OOA queue, starting with the current
11197 * blocked I/O and going through every I/O before it on the
11198 * queue. If starting_io is NULL, we'll just end up returning
11201 for (ooa_io = starting_io; ooa_io != NULL;
11202 ooa_io = (union ctl_io *)TAILQ_PREV(&ooa_io->io_hdr, ctl_ooaq,
11206 * This routine just checks to see whether
11207 * cur_blocked is blocked by ooa_io, which is ahead
11208 * of it in the queue. It doesn't queue/dequeue
11211 action = ctl_check_for_blockage(lun, pending_io, ooa_io);
11213 case CTL_ACTION_BLOCK:
11214 case CTL_ACTION_OVERLAP:
11215 case CTL_ACTION_OVERLAP_TAG:
11216 case CTL_ACTION_SKIP:
11217 case CTL_ACTION_ERROR:
11219 break; /* NOTREACHED */
11220 case CTL_ACTION_PASS:
11223 panic("%s: Invalid action %d\n", __func__, action);
11227 return (CTL_ACTION_PASS);
11232 * - An I/O has just completed, and has been removed from the per-LUN OOA
11233 * queue, so some items on the blocked queue may now be unblocked.
11236 ctl_check_blocked(struct ctl_lun *lun)
11238 struct ctl_softc *softc = lun->ctl_softc;
11239 union ctl_io *cur_blocked, *next_blocked;
11241 mtx_assert(&lun->lun_lock, MA_OWNED);
11244 * Run forward from the head of the blocked queue, checking each
11245 * entry against the I/Os prior to it on the OOA queue to see if
11246 * there is still any blockage.
11248 * We cannot use the TAILQ_FOREACH() macro, because it can't deal
11249 * with our removing a variable on it while it is traversing the
11252 for (cur_blocked = (union ctl_io *)TAILQ_FIRST(&lun->blocked_queue);
11253 cur_blocked != NULL; cur_blocked = next_blocked) {
11254 union ctl_io *prev_ooa;
11257 next_blocked = (union ctl_io *)TAILQ_NEXT(&cur_blocked->io_hdr,
11260 prev_ooa = (union ctl_io *)TAILQ_PREV(&cur_blocked->io_hdr,
11261 ctl_ooaq, ooa_links);
11264 * If cur_blocked happens to be the first item in the OOA
11265 * queue now, prev_ooa will be NULL, and the action
11266 * returned will just be CTL_ACTION_PASS.
11268 action = ctl_check_ooa(lun, cur_blocked, prev_ooa);
11271 case CTL_ACTION_BLOCK:
11272 /* Nothing to do here, still blocked */
11274 case CTL_ACTION_OVERLAP:
11275 case CTL_ACTION_OVERLAP_TAG:
11277 * This shouldn't happen! In theory we've already
11278 * checked this command for overlap...
11281 case CTL_ACTION_PASS:
11282 case CTL_ACTION_SKIP: {
11283 const struct ctl_cmd_entry *entry;
11286 * The skip case shouldn't happen, this transaction
11287 * should have never made it onto the blocked queue.
11290 * This I/O is no longer blocked, we can remove it
11291 * from the blocked queue. Since this is a TAILQ
11292 * (doubly linked list), we can do O(1) removals
11293 * from any place on the list.
11295 TAILQ_REMOVE(&lun->blocked_queue, &cur_blocked->io_hdr,
11297 cur_blocked->io_hdr.flags &= ~CTL_FLAG_BLOCKED;
11299 if ((softc->ha_mode != CTL_HA_MODE_XFER) &&
11300 (cur_blocked->io_hdr.flags & CTL_FLAG_FROM_OTHER_SC)){
11302 * Need to send IO back to original side to
11305 union ctl_ha_msg msg_info;
11307 cur_blocked->io_hdr.flags &= ~CTL_FLAG_IO_ACTIVE;
11308 msg_info.hdr.original_sc =
11309 cur_blocked->io_hdr.original_sc;
11310 msg_info.hdr.serializing_sc = cur_blocked;
11311 msg_info.hdr.msg_type = CTL_MSG_R2R;
11312 ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg_info,
11313 sizeof(msg_info.hdr), M_NOWAIT);
11316 entry = ctl_get_cmd_entry(&cur_blocked->scsiio, NULL);
11319 * Check this I/O for LUN state changes that may
11320 * have happened while this command was blocked.
11321 * The LUN state may have been changed by a command
11322 * ahead of us in the queue, so we need to re-check
11323 * for any states that can be caused by SCSI
11326 if (ctl_scsiio_lun_check(lun, entry,
11327 &cur_blocked->scsiio) == 0) {
11328 cur_blocked->io_hdr.flags |=
11329 CTL_FLAG_IS_WAS_ON_RTR;
11330 ctl_enqueue_rtr(cur_blocked);
11332 ctl_done(cur_blocked);
11337 * This probably shouldn't happen -- we shouldn't
11338 * get CTL_ACTION_ERROR, or anything else.
11344 return (CTL_RETVAL_COMPLETE);
11348 * This routine (with one exception) checks LUN flags that can be set by
11349 * commands ahead of us in the OOA queue. These flags have to be checked
11350 * when a command initially comes in, and when we pull a command off the
11351 * blocked queue and are preparing to execute it. The reason we have to
11352 * check these flags for commands on the blocked queue is that the LUN
11353 * state may have been changed by a command ahead of us while we're on the
11356 * Ordering is somewhat important with these checks, so please pay
11357 * careful attention to the placement of any new checks.
11360 ctl_scsiio_lun_check(struct ctl_lun *lun,
11361 const struct ctl_cmd_entry *entry, struct ctl_scsiio *ctsio)
11363 struct ctl_softc *softc = lun->ctl_softc;
11369 mtx_assert(&lun->lun_lock, MA_OWNED);
11372 * If this shelf is a secondary shelf controller, we may have to
11373 * reject some commands disallowed by HA mode and link state.
11375 if ((lun->flags & CTL_LUN_PRIMARY_SC) == 0) {
11376 if (softc->ha_link == CTL_HA_LINK_OFFLINE &&
11377 (entry->flags & CTL_CMD_FLAG_OK_ON_UNAVAIL) == 0) {
11378 ctl_set_lun_unavail(ctsio);
11382 if ((lun->flags & CTL_LUN_PEER_SC_PRIMARY) == 0 &&
11383 (entry->flags & CTL_CMD_FLAG_OK_ON_UNAVAIL) == 0) {
11384 ctl_set_lun_transit(ctsio);
11388 if (softc->ha_mode == CTL_HA_MODE_ACT_STBY &&
11389 (entry->flags & CTL_CMD_FLAG_OK_ON_STANDBY) == 0) {
11390 ctl_set_lun_standby(ctsio);
11395 /* The rest of checks are only done on executing side */
11396 if (softc->ha_mode == CTL_HA_MODE_XFER)
11400 if (entry->pattern & CTL_LUN_PAT_WRITE) {
11402 lun->be_lun->flags & CTL_LUN_FLAG_READONLY) {
11403 ctl_set_hw_write_protected(ctsio);
11407 if ((lun->mode_pages.control_page[CTL_PAGE_CURRENT]
11408 .eca_and_aen & SCP_SWP) != 0) {
11409 ctl_set_sense(ctsio, /*current_error*/ 1,
11410 /*sense_key*/ SSD_KEY_DATA_PROTECT,
11411 /*asc*/ 0x27, /*ascq*/ 0x02, SSD_ELEM_NONE);
11418 * Check for a reservation conflict. If this command isn't allowed
11419 * even on reserved LUNs, and if this initiator isn't the one who
11420 * reserved us, reject the command with a reservation conflict.
11422 residx = ctl_get_initindex(&ctsio->io_hdr.nexus);
11423 if ((lun->flags & CTL_LUN_RESERVED)
11424 && ((entry->flags & CTL_CMD_FLAG_ALLOW_ON_RESV) == 0)) {
11425 if (lun->res_idx != residx) {
11426 ctl_set_reservation_conflict(ctsio);
11432 if ((lun->flags & CTL_LUN_PR_RESERVED) == 0 ||
11433 (entry->flags & CTL_CMD_FLAG_ALLOW_ON_PR_RESV)) {
11434 /* No reservation or command is allowed. */;
11435 } else if ((entry->flags & CTL_CMD_FLAG_ALLOW_ON_PR_WRESV) &&
11436 (lun->pr_res_type == SPR_TYPE_WR_EX ||
11437 lun->pr_res_type == SPR_TYPE_WR_EX_RO ||
11438 lun->pr_res_type == SPR_TYPE_WR_EX_AR)) {
11439 /* The command is allowed for Write Exclusive resv. */;
11442 * if we aren't registered or it's a res holder type
11443 * reservation and this isn't the res holder then set a
11446 if (ctl_get_prkey(lun, residx) == 0 ||
11447 (residx != lun->pr_res_idx && lun->pr_res_type < 4)) {
11448 ctl_set_reservation_conflict(ctsio);
11454 if ((entry->flags & CTL_CMD_FLAG_OK_ON_NO_MEDIA) == 0) {
11455 if (lun->flags & CTL_LUN_EJECTED)
11456 ctl_set_lun_ejected(ctsio);
11457 else if (lun->flags & CTL_LUN_NO_MEDIA) {
11458 if (lun->flags & CTL_LUN_REMOVABLE)
11459 ctl_set_lun_no_media(ctsio);
11461 ctl_set_lun_int_reqd(ctsio);
11462 } else if (lun->flags & CTL_LUN_STOPPED)
11463 ctl_set_lun_stopped(ctsio);
11475 ctl_failover_io(union ctl_io *io, int have_lock)
11477 ctl_set_busy(&io->scsiio);
11482 ctl_failover_lun(union ctl_io *rio)
11484 struct ctl_softc *softc = control_softc;
11485 struct ctl_lun *lun;
11486 struct ctl_io_hdr *io, *next_io;
11489 targ_lun = rio->io_hdr.nexus.targ_mapped_lun;
11490 CTL_DEBUG_PRINT(("FAILOVER for lun %ju\n", targ_lun));
11492 /* Find and lock the LUN. */
11493 mtx_lock(&softc->ctl_lock);
11494 if ((targ_lun < CTL_MAX_LUNS) &&
11495 ((lun = softc->ctl_luns[targ_lun]) != NULL)) {
11496 mtx_lock(&lun->lun_lock);
11497 mtx_unlock(&softc->ctl_lock);
11498 if (lun->flags & CTL_LUN_DISABLED) {
11499 mtx_unlock(&lun->lun_lock);
11503 mtx_unlock(&softc->ctl_lock);
11507 if (softc->ha_mode == CTL_HA_MODE_XFER) {
11508 TAILQ_FOREACH_SAFE(io, &lun->ooa_queue, ooa_links, next_io) {
11509 /* We are master */
11510 if (io->flags & CTL_FLAG_FROM_OTHER_SC) {
11511 if (io->flags & CTL_FLAG_IO_ACTIVE) {
11512 io->flags |= CTL_FLAG_ABORT;
11513 io->flags |= CTL_FLAG_FAILOVER;
11514 } else { /* This can be only due to DATAMOVE */
11515 io->msg_type = CTL_MSG_DATAMOVE_DONE;
11516 io->flags &= ~CTL_FLAG_DMA_INPROG;
11517 io->flags |= CTL_FLAG_IO_ACTIVE;
11518 io->port_status = 31340;
11519 ctl_enqueue_isc((union ctl_io *)io);
11523 if (io->flags & CTL_FLAG_SENT_2OTHER_SC) {
11524 io->flags &= ~CTL_FLAG_SENT_2OTHER_SC;
11525 if (io->flags & CTL_FLAG_IO_ACTIVE) {
11526 io->flags |= CTL_FLAG_FAILOVER;
11528 ctl_set_busy(&((union ctl_io *)io)->
11530 ctl_done((union ctl_io *)io);
11534 } else { /* SERIALIZE modes */
11535 TAILQ_FOREACH_SAFE(io, &lun->blocked_queue, blocked_links,
11537 /* We are master */
11538 if (io->flags & CTL_FLAG_FROM_OTHER_SC) {
11539 TAILQ_REMOVE(&lun->blocked_queue, io,
11541 io->flags &= ~CTL_FLAG_BLOCKED;
11542 TAILQ_REMOVE(&lun->ooa_queue, io, ooa_links);
11543 ctl_free_io((union ctl_io *)io);
11546 TAILQ_FOREACH_SAFE(io, &lun->ooa_queue, ooa_links, next_io) {
11547 /* We are master */
11548 if (io->flags & CTL_FLAG_FROM_OTHER_SC) {
11549 TAILQ_REMOVE(&lun->ooa_queue, io, ooa_links);
11550 ctl_free_io((union ctl_io *)io);
11553 if (io->flags & CTL_FLAG_SENT_2OTHER_SC) {
11554 io->flags &= ~CTL_FLAG_SENT_2OTHER_SC;
11555 if (!(io->flags & CTL_FLAG_IO_ACTIVE)) {
11556 ctl_set_busy(&((union ctl_io *)io)->
11558 ctl_done((union ctl_io *)io);
11562 ctl_check_blocked(lun);
11564 mtx_unlock(&lun->lun_lock);
11568 ctl_scsiio_precheck(struct ctl_softc *softc, struct ctl_scsiio *ctsio)
11570 struct ctl_lun *lun;
11571 const struct ctl_cmd_entry *entry;
11572 uint32_t initidx, targ_lun;
11579 targ_lun = ctsio->io_hdr.nexus.targ_mapped_lun;
11580 if ((targ_lun < CTL_MAX_LUNS)
11581 && ((lun = softc->ctl_luns[targ_lun]) != NULL)) {
11583 * If the LUN is invalid, pretend that it doesn't exist.
11584 * It will go away as soon as all pending I/O has been
11587 mtx_lock(&lun->lun_lock);
11588 if (lun->flags & CTL_LUN_DISABLED) {
11589 mtx_unlock(&lun->lun_lock);
11591 ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr = NULL;
11592 ctsio->io_hdr.ctl_private[CTL_PRIV_BACKEND_LUN].ptr = NULL;
11594 ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr = lun;
11595 ctsio->io_hdr.ctl_private[CTL_PRIV_BACKEND_LUN].ptr =
11599 * Every I/O goes into the OOA queue for a
11600 * particular LUN, and stays there until completion.
11603 if (TAILQ_EMPTY(&lun->ooa_queue)) {
11604 lun->idle_time += getsbinuptime() -
11608 TAILQ_INSERT_TAIL(&lun->ooa_queue, &ctsio->io_hdr,
11612 ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr = NULL;
11613 ctsio->io_hdr.ctl_private[CTL_PRIV_BACKEND_LUN].ptr = NULL;
11616 /* Get command entry and return error if it is unsuppotyed. */
11617 entry = ctl_validate_command(ctsio);
11618 if (entry == NULL) {
11620 mtx_unlock(&lun->lun_lock);
11624 ctsio->io_hdr.flags &= ~CTL_FLAG_DATA_MASK;
11625 ctsio->io_hdr.flags |= entry->flags & CTL_FLAG_DATA_MASK;
11628 * Check to see whether we can send this command to LUNs that don't
11629 * exist. This should pretty much only be the case for inquiry
11630 * and request sense. Further checks, below, really require having
11631 * a LUN, so we can't really check the command anymore. Just put
11632 * it on the rtr queue.
11635 if (entry->flags & CTL_CMD_FLAG_OK_ON_NO_LUN) {
11636 ctsio->io_hdr.flags |= CTL_FLAG_IS_WAS_ON_RTR;
11637 ctl_enqueue_rtr((union ctl_io *)ctsio);
11641 ctl_set_unsupported_lun(ctsio);
11642 ctl_done((union ctl_io *)ctsio);
11643 CTL_DEBUG_PRINT(("ctl_scsiio_precheck: bailing out due to invalid LUN\n"));
11647 * Make sure we support this particular command on this LUN.
11648 * e.g., we don't support writes to the control LUN.
11650 if (!ctl_cmd_applicable(lun->be_lun->lun_type, entry)) {
11651 mtx_unlock(&lun->lun_lock);
11652 ctl_set_invalid_opcode(ctsio);
11653 ctl_done((union ctl_io *)ctsio);
11658 initidx = ctl_get_initindex(&ctsio->io_hdr.nexus);
11662 * If we've got a request sense, it'll clear the contingent
11663 * allegiance condition. Otherwise, if we have a CA condition for
11664 * this initiator, clear it, because it sent down a command other
11665 * than request sense.
11667 if ((ctsio->cdb[0] != REQUEST_SENSE)
11668 && (ctl_is_set(lun->have_ca, initidx)))
11669 ctl_clear_mask(lun->have_ca, initidx);
11673 * If the command has this flag set, it handles its own unit
11674 * attention reporting, we shouldn't do anything. Otherwise we
11675 * check for any pending unit attentions, and send them back to the
11676 * initiator. We only do this when a command initially comes in,
11677 * not when we pull it off the blocked queue.
11679 * According to SAM-3, section 5.3.2, the order that things get
11680 * presented back to the host is basically unit attentions caused
11681 * by some sort of reset event, busy status, reservation conflicts
11682 * or task set full, and finally any other status.
11684 * One issue here is that some of the unit attentions we report
11685 * don't fall into the "reset" category (e.g. "reported luns data
11686 * has changed"). So reporting it here, before the reservation
11687 * check, may be technically wrong. I guess the only thing to do
11688 * would be to check for and report the reset events here, and then
11689 * check for the other unit attention types after we check for a
11690 * reservation conflict.
11692 * XXX KDM need to fix this
11694 if ((entry->flags & CTL_CMD_FLAG_NO_SENSE) == 0) {
11695 ctl_ua_type ua_type;
11697 ua_type = ctl_build_ua(lun, initidx, &ctsio->sense_data,
11699 if (ua_type != CTL_UA_NONE) {
11700 mtx_unlock(&lun->lun_lock);
11701 ctsio->scsi_status = SCSI_STATUS_CHECK_COND;
11702 ctsio->io_hdr.status = CTL_SCSI_ERROR | CTL_AUTOSENSE;
11703 ctsio->sense_len = SSD_FULL_SIZE;
11704 ctl_done((union ctl_io *)ctsio);
11710 if (ctl_scsiio_lun_check(lun, entry, ctsio) != 0) {
11711 mtx_unlock(&lun->lun_lock);
11712 ctl_done((union ctl_io *)ctsio);
11717 * XXX CHD this is where we want to send IO to other side if
11718 * this LUN is secondary on this SC. We will need to make a copy
11719 * of the IO and flag the IO on this side as SENT_2OTHER and the flag
11720 * the copy we send as FROM_OTHER.
11721 * We also need to stuff the address of the original IO so we can
11722 * find it easily. Something similar will need be done on the other
11723 * side so when we are done we can find the copy.
11725 if ((lun->flags & CTL_LUN_PRIMARY_SC) == 0 &&
11726 (lun->flags & CTL_LUN_PEER_SC_PRIMARY) != 0 &&
11727 (entry->flags & CTL_CMD_FLAG_RUN_HERE) == 0) {
11728 union ctl_ha_msg msg_info;
11731 ctsio->io_hdr.flags |= CTL_FLAG_SENT_2OTHER_SC;
11732 ctsio->io_hdr.flags &= ~CTL_FLAG_IO_ACTIVE;
11733 mtx_unlock(&lun->lun_lock);
11735 msg_info.hdr.msg_type = CTL_MSG_SERIALIZE;
11736 msg_info.hdr.original_sc = (union ctl_io *)ctsio;
11737 msg_info.hdr.serializing_sc = NULL;
11738 msg_info.hdr.nexus = ctsio->io_hdr.nexus;
11739 msg_info.scsi.tag_num = ctsio->tag_num;
11740 msg_info.scsi.tag_type = ctsio->tag_type;
11741 msg_info.scsi.cdb_len = ctsio->cdb_len;
11742 memcpy(msg_info.scsi.cdb, ctsio->cdb, CTL_MAX_CDBLEN);
11744 if ((isc_retval = ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg_info,
11745 sizeof(msg_info.scsi) - sizeof(msg_info.scsi.sense_data),
11746 M_WAITOK)) > CTL_HA_STATUS_SUCCESS) {
11747 ctl_set_busy(ctsio);
11748 ctl_done((union ctl_io *)ctsio);
11754 switch (ctl_check_ooa(lun, (union ctl_io *)ctsio,
11755 (union ctl_io *)TAILQ_PREV(&ctsio->io_hdr,
11756 ctl_ooaq, ooa_links))) {
11757 case CTL_ACTION_BLOCK:
11758 ctsio->io_hdr.flags |= CTL_FLAG_BLOCKED;
11759 TAILQ_INSERT_TAIL(&lun->blocked_queue, &ctsio->io_hdr,
11761 mtx_unlock(&lun->lun_lock);
11763 case CTL_ACTION_PASS:
11764 case CTL_ACTION_SKIP:
11765 ctsio->io_hdr.flags |= CTL_FLAG_IS_WAS_ON_RTR;
11766 mtx_unlock(&lun->lun_lock);
11767 ctl_enqueue_rtr((union ctl_io *)ctsio);
11769 case CTL_ACTION_OVERLAP:
11770 mtx_unlock(&lun->lun_lock);
11771 ctl_set_overlapped_cmd(ctsio);
11772 ctl_done((union ctl_io *)ctsio);
11774 case CTL_ACTION_OVERLAP_TAG:
11775 mtx_unlock(&lun->lun_lock);
11776 ctl_set_overlapped_tag(ctsio, ctsio->tag_num & 0xff);
11777 ctl_done((union ctl_io *)ctsio);
11779 case CTL_ACTION_ERROR:
11781 mtx_unlock(&lun->lun_lock);
11782 ctl_set_internal_failure(ctsio,
11784 /*retry_count*/ 0);
11785 ctl_done((union ctl_io *)ctsio);
11791 const struct ctl_cmd_entry *
11792 ctl_get_cmd_entry(struct ctl_scsiio *ctsio, int *sa)
11794 const struct ctl_cmd_entry *entry;
11795 int service_action;
11797 entry = &ctl_cmd_table[ctsio->cdb[0]];
11799 *sa = ((entry->flags & CTL_CMD_FLAG_SA5) != 0);
11800 if (entry->flags & CTL_CMD_FLAG_SA5) {
11801 service_action = ctsio->cdb[1] & SERVICE_ACTION_MASK;
11802 entry = &((const struct ctl_cmd_entry *)
11803 entry->execute)[service_action];
11808 const struct ctl_cmd_entry *
11809 ctl_validate_command(struct ctl_scsiio *ctsio)
11811 const struct ctl_cmd_entry *entry;
11815 entry = ctl_get_cmd_entry(ctsio, &sa);
11816 if (entry->execute == NULL) {
11818 ctl_set_invalid_field(ctsio,
11825 ctl_set_invalid_opcode(ctsio);
11826 ctl_done((union ctl_io *)ctsio);
11829 KASSERT(entry->length > 0,
11830 ("Not defined length for command 0x%02x/0x%02x",
11831 ctsio->cdb[0], ctsio->cdb[1]));
11832 for (i = 1; i < entry->length; i++) {
11833 diff = ctsio->cdb[i] & ~entry->usage[i - 1];
11836 ctl_set_invalid_field(ctsio,
11841 /*bit*/ fls(diff) - 1);
11842 ctl_done((union ctl_io *)ctsio);
11849 ctl_cmd_applicable(uint8_t lun_type, const struct ctl_cmd_entry *entry)
11852 switch (lun_type) {
11854 if ((entry->flags & CTL_CMD_FLAG_OK_ON_DIRECT) == 0)
11858 if ((entry->flags & CTL_CMD_FLAG_OK_ON_PROC) == 0)
11862 if ((entry->flags & CTL_CMD_FLAG_OK_ON_CDROM) == 0)
11872 ctl_scsiio(struct ctl_scsiio *ctsio)
11875 const struct ctl_cmd_entry *entry;
11877 retval = CTL_RETVAL_COMPLETE;
11879 CTL_DEBUG_PRINT(("ctl_scsiio cdb[0]=%02X\n", ctsio->cdb[0]));
11881 entry = ctl_get_cmd_entry(ctsio, NULL);
11884 * If this I/O has been aborted, just send it straight to
11885 * ctl_done() without executing it.
11887 if (ctsio->io_hdr.flags & CTL_FLAG_ABORT) {
11888 ctl_done((union ctl_io *)ctsio);
11893 * All the checks should have been handled by ctl_scsiio_precheck().
11894 * We should be clear now to just execute the I/O.
11896 retval = entry->execute(ctsio);
11903 * Since we only implement one target right now, a bus reset simply resets
11904 * our single target.
11907 ctl_bus_reset(struct ctl_softc *softc, union ctl_io *io)
11909 return(ctl_target_reset(softc, io, CTL_UA_BUS_RESET));
11913 ctl_target_reset(struct ctl_softc *softc, union ctl_io *io,
11914 ctl_ua_type ua_type)
11916 struct ctl_port *port;
11917 struct ctl_lun *lun;
11920 if (!(io->io_hdr.flags & CTL_FLAG_FROM_OTHER_SC)) {
11921 union ctl_ha_msg msg_info;
11923 msg_info.hdr.nexus = io->io_hdr.nexus;
11924 if (ua_type==CTL_UA_TARG_RESET)
11925 msg_info.task.task_action = CTL_TASK_TARGET_RESET;
11927 msg_info.task.task_action = CTL_TASK_BUS_RESET;
11928 msg_info.hdr.msg_type = CTL_MSG_MANAGE_TASKS;
11929 msg_info.hdr.original_sc = NULL;
11930 msg_info.hdr.serializing_sc = NULL;
11931 ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg_info,
11932 sizeof(msg_info.task), M_WAITOK);
11936 mtx_lock(&softc->ctl_lock);
11937 port = ctl_io_port(&io->io_hdr);
11938 STAILQ_FOREACH(lun, &softc->lun_list, links) {
11939 if (port != NULL &&
11940 ctl_lun_map_to_port(port, lun->lun) >= CTL_MAX_LUNS)
11942 retval += ctl_do_lun_reset(lun, io, ua_type);
11944 mtx_unlock(&softc->ctl_lock);
11945 io->taskio.task_status = CTL_TASK_FUNCTION_COMPLETE;
11950 * The LUN should always be set. The I/O is optional, and is used to
11951 * distinguish between I/Os sent by this initiator, and by other
11952 * initiators. We set unit attention for initiators other than this one.
11953 * SAM-3 is vague on this point. It does say that a unit attention should
11954 * be established for other initiators when a LUN is reset (see section
11955 * 5.7.3), but it doesn't specifically say that the unit attention should
11956 * be established for this particular initiator when a LUN is reset. Here
11957 * is the relevant text, from SAM-3 rev 8:
11959 * 5.7.2 When a SCSI initiator port aborts its own tasks
11961 * When a SCSI initiator port causes its own task(s) to be aborted, no
11962 * notification that the task(s) have been aborted shall be returned to
11963 * the SCSI initiator port other than the completion response for the
11964 * command or task management function action that caused the task(s) to
11965 * be aborted and notification(s) associated with related effects of the
11966 * action (e.g., a reset unit attention condition).
11968 * XXX KDM for now, we're setting unit attention for all initiators.
11971 ctl_do_lun_reset(struct ctl_lun *lun, union ctl_io *io, ctl_ua_type ua_type)
11979 mtx_lock(&lun->lun_lock);
11981 * Run through the OOA queue and abort each I/O.
11983 for (xio = (union ctl_io *)TAILQ_FIRST(&lun->ooa_queue); xio != NULL;
11984 xio = (union ctl_io *)TAILQ_NEXT(&xio->io_hdr, ooa_links)) {
11985 xio->io_hdr.flags |= CTL_FLAG_ABORT | CTL_FLAG_ABORT_STATUS;
11989 * This version sets unit attention for every
11992 initidx = ctl_get_initindex(&io->io_hdr.nexus);
11993 ctl_est_ua_all(lun, initidx, ua_type);
11995 ctl_est_ua_all(lun, -1, ua_type);
11999 * A reset (any kind, really) clears reservations established with
12000 * RESERVE/RELEASE. It does not clear reservations established
12001 * with PERSISTENT RESERVE OUT, but we don't support that at the
12002 * moment anyway. See SPC-2, section 5.6. SPC-3 doesn't address
12003 * reservations made with the RESERVE/RELEASE commands, because
12004 * those commands are obsolete in SPC-3.
12006 lun->flags &= ~CTL_LUN_RESERVED;
12009 for (i = 0; i < CTL_MAX_INITIATORS; i++)
12010 ctl_clear_mask(lun->have_ca, i);
12012 lun->prevent_count = 0;
12013 for (i = 0; i < CTL_MAX_INITIATORS; i++)
12014 ctl_clear_mask(lun->prevent, i);
12015 mtx_unlock(&lun->lun_lock);
12021 ctl_lun_reset(struct ctl_softc *softc, union ctl_io *io)
12023 struct ctl_lun *lun;
12027 targ_lun = io->io_hdr.nexus.targ_mapped_lun;
12028 mtx_lock(&softc->ctl_lock);
12029 if ((targ_lun >= CTL_MAX_LUNS) ||
12030 (lun = softc->ctl_luns[targ_lun]) == NULL) {
12031 mtx_unlock(&softc->ctl_lock);
12032 io->taskio.task_status = CTL_TASK_LUN_DOES_NOT_EXIST;
12035 retval = ctl_do_lun_reset(lun, io, CTL_UA_LUN_RESET);
12036 mtx_unlock(&softc->ctl_lock);
12037 io->taskio.task_status = CTL_TASK_FUNCTION_COMPLETE;
12039 if ((io->io_hdr.flags & CTL_FLAG_FROM_OTHER_SC) == 0) {
12040 union ctl_ha_msg msg_info;
12042 msg_info.hdr.msg_type = CTL_MSG_MANAGE_TASKS;
12043 msg_info.hdr.nexus = io->io_hdr.nexus;
12044 msg_info.task.task_action = CTL_TASK_LUN_RESET;
12045 msg_info.hdr.original_sc = NULL;
12046 msg_info.hdr.serializing_sc = NULL;
12047 ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg_info,
12048 sizeof(msg_info.task), M_WAITOK);
12054 ctl_abort_tasks_lun(struct ctl_lun *lun, uint32_t targ_port, uint32_t init_id,
12059 mtx_assert(&lun->lun_lock, MA_OWNED);
12062 * Run through the OOA queue and attempt to find the given I/O.
12063 * The target port, initiator ID, tag type and tag number have to
12064 * match the values that we got from the initiator. If we have an
12065 * untagged command to abort, simply abort the first untagged command
12066 * we come to. We only allow one untagged command at a time of course.
12068 for (xio = (union ctl_io *)TAILQ_FIRST(&lun->ooa_queue); xio != NULL;
12069 xio = (union ctl_io *)TAILQ_NEXT(&xio->io_hdr, ooa_links)) {
12071 if ((targ_port == UINT32_MAX ||
12072 targ_port == xio->io_hdr.nexus.targ_port) &&
12073 (init_id == UINT32_MAX ||
12074 init_id == xio->io_hdr.nexus.initid)) {
12075 if (targ_port != xio->io_hdr.nexus.targ_port ||
12076 init_id != xio->io_hdr.nexus.initid)
12077 xio->io_hdr.flags |= CTL_FLAG_ABORT_STATUS;
12078 xio->io_hdr.flags |= CTL_FLAG_ABORT;
12079 if (!other_sc && !(lun->flags & CTL_LUN_PRIMARY_SC)) {
12080 union ctl_ha_msg msg_info;
12082 msg_info.hdr.nexus = xio->io_hdr.nexus;
12083 msg_info.task.task_action = CTL_TASK_ABORT_TASK;
12084 msg_info.task.tag_num = xio->scsiio.tag_num;
12085 msg_info.task.tag_type = xio->scsiio.tag_type;
12086 msg_info.hdr.msg_type = CTL_MSG_MANAGE_TASKS;
12087 msg_info.hdr.original_sc = NULL;
12088 msg_info.hdr.serializing_sc = NULL;
12089 ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg_info,
12090 sizeof(msg_info.task), M_NOWAIT);
12097 ctl_abort_task_set(union ctl_io *io)
12099 struct ctl_softc *softc = control_softc;
12100 struct ctl_lun *lun;
12106 targ_lun = io->io_hdr.nexus.targ_mapped_lun;
12107 mtx_lock(&softc->ctl_lock);
12108 if ((targ_lun >= CTL_MAX_LUNS) ||
12109 (lun = softc->ctl_luns[targ_lun]) == NULL) {
12110 mtx_unlock(&softc->ctl_lock);
12111 io->taskio.task_status = CTL_TASK_LUN_DOES_NOT_EXIST;
12115 mtx_lock(&lun->lun_lock);
12116 mtx_unlock(&softc->ctl_lock);
12117 if (io->taskio.task_action == CTL_TASK_ABORT_TASK_SET) {
12118 ctl_abort_tasks_lun(lun, io->io_hdr.nexus.targ_port,
12119 io->io_hdr.nexus.initid,
12120 (io->io_hdr.flags & CTL_FLAG_FROM_OTHER_SC) != 0);
12121 } else { /* CTL_TASK_CLEAR_TASK_SET */
12122 ctl_abort_tasks_lun(lun, UINT32_MAX, UINT32_MAX,
12123 (io->io_hdr.flags & CTL_FLAG_FROM_OTHER_SC) != 0);
12125 mtx_unlock(&lun->lun_lock);
12126 io->taskio.task_status = CTL_TASK_FUNCTION_COMPLETE;
12131 ctl_i_t_nexus_reset(union ctl_io *io)
12133 struct ctl_softc *softc = control_softc;
12134 struct ctl_lun *lun;
12137 if (!(io->io_hdr.flags & CTL_FLAG_FROM_OTHER_SC)) {
12138 union ctl_ha_msg msg_info;
12140 msg_info.hdr.nexus = io->io_hdr.nexus;
12141 msg_info.task.task_action = CTL_TASK_I_T_NEXUS_RESET;
12142 msg_info.hdr.msg_type = CTL_MSG_MANAGE_TASKS;
12143 msg_info.hdr.original_sc = NULL;
12144 msg_info.hdr.serializing_sc = NULL;
12145 ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg_info,
12146 sizeof(msg_info.task), M_WAITOK);
12149 initidx = ctl_get_initindex(&io->io_hdr.nexus);
12150 mtx_lock(&softc->ctl_lock);
12151 STAILQ_FOREACH(lun, &softc->lun_list, links) {
12152 mtx_lock(&lun->lun_lock);
12153 ctl_abort_tasks_lun(lun, io->io_hdr.nexus.targ_port,
12154 io->io_hdr.nexus.initid, 1);
12156 ctl_clear_mask(lun->have_ca, initidx);
12158 if ((lun->flags & CTL_LUN_RESERVED) && (lun->res_idx == initidx))
12159 lun->flags &= ~CTL_LUN_RESERVED;
12160 if (ctl_is_set(lun->prevent, initidx)) {
12161 ctl_clear_mask(lun->prevent, initidx);
12162 lun->prevent_count--;
12164 ctl_est_ua(lun, initidx, CTL_UA_I_T_NEXUS_LOSS);
12165 mtx_unlock(&lun->lun_lock);
12167 mtx_unlock(&softc->ctl_lock);
12168 io->taskio.task_status = CTL_TASK_FUNCTION_COMPLETE;
12173 ctl_abort_task(union ctl_io *io)
12176 struct ctl_lun *lun;
12177 struct ctl_softc *softc;
12180 char printbuf[128];
12185 softc = control_softc;
12191 targ_lun = io->io_hdr.nexus.targ_mapped_lun;
12192 mtx_lock(&softc->ctl_lock);
12193 if ((targ_lun >= CTL_MAX_LUNS) ||
12194 (lun = softc->ctl_luns[targ_lun]) == NULL) {
12195 mtx_unlock(&softc->ctl_lock);
12196 io->taskio.task_status = CTL_TASK_LUN_DOES_NOT_EXIST;
12201 printf("ctl_abort_task: called for lun %lld, tag %d type %d\n",
12202 lun->lun, io->taskio.tag_num, io->taskio.tag_type);
12205 mtx_lock(&lun->lun_lock);
12206 mtx_unlock(&softc->ctl_lock);
12208 * Run through the OOA queue and attempt to find the given I/O.
12209 * The target port, initiator ID, tag type and tag number have to
12210 * match the values that we got from the initiator. If we have an
12211 * untagged command to abort, simply abort the first untagged command
12212 * we come to. We only allow one untagged command at a time of course.
12214 for (xio = (union ctl_io *)TAILQ_FIRST(&lun->ooa_queue); xio != NULL;
12215 xio = (union ctl_io *)TAILQ_NEXT(&xio->io_hdr, ooa_links)) {
12217 sbuf_new(&sb, printbuf, sizeof(printbuf), SBUF_FIXEDLEN);
12219 sbuf_printf(&sb, "LUN %lld tag %d type %d%s%s%s%s: ",
12220 lun->lun, xio->scsiio.tag_num,
12221 xio->scsiio.tag_type,
12222 (xio->io_hdr.blocked_links.tqe_prev
12223 == NULL) ? "" : " BLOCKED",
12224 (xio->io_hdr.flags &
12225 CTL_FLAG_DMA_INPROG) ? " DMA" : "",
12226 (xio->io_hdr.flags &
12227 CTL_FLAG_ABORT) ? " ABORT" : "",
12228 (xio->io_hdr.flags &
12229 CTL_FLAG_IS_WAS_ON_RTR ? " RTR" : ""));
12230 ctl_scsi_command_string(&xio->scsiio, NULL, &sb);
12232 printf("%s\n", sbuf_data(&sb));
12235 if ((xio->io_hdr.nexus.targ_port != io->io_hdr.nexus.targ_port)
12236 || (xio->io_hdr.nexus.initid != io->io_hdr.nexus.initid)
12237 || (xio->io_hdr.flags & CTL_FLAG_ABORT))
12241 * If the abort says that the task is untagged, the
12242 * task in the queue must be untagged. Otherwise,
12243 * we just check to see whether the tag numbers
12244 * match. This is because the QLogic firmware
12245 * doesn't pass back the tag type in an abort
12249 if (((xio->scsiio.tag_type == CTL_TAG_UNTAGGED)
12250 && (io->taskio.tag_type == CTL_TAG_UNTAGGED))
12251 || (xio->scsiio.tag_num == io->taskio.tag_num))
12254 * XXX KDM we've got problems with FC, because it
12255 * doesn't send down a tag type with aborts. So we
12256 * can only really go by the tag number...
12257 * This may cause problems with parallel SCSI.
12258 * Need to figure that out!!
12260 if (xio->scsiio.tag_num == io->taskio.tag_num) {
12261 xio->io_hdr.flags |= CTL_FLAG_ABORT;
12263 if ((io->io_hdr.flags & CTL_FLAG_FROM_OTHER_SC) == 0 &&
12264 !(lun->flags & CTL_LUN_PRIMARY_SC)) {
12265 union ctl_ha_msg msg_info;
12267 msg_info.hdr.nexus = io->io_hdr.nexus;
12268 msg_info.task.task_action = CTL_TASK_ABORT_TASK;
12269 msg_info.task.tag_num = io->taskio.tag_num;
12270 msg_info.task.tag_type = io->taskio.tag_type;
12271 msg_info.hdr.msg_type = CTL_MSG_MANAGE_TASKS;
12272 msg_info.hdr.original_sc = NULL;
12273 msg_info.hdr.serializing_sc = NULL;
12275 printf("Sent Abort to other side\n");
12277 ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg_info,
12278 sizeof(msg_info.task), M_NOWAIT);
12281 printf("ctl_abort_task: found I/O to abort\n");
12285 mtx_unlock(&lun->lun_lock);
12289 * This isn't really an error. It's entirely possible for
12290 * the abort and command completion to cross on the wire.
12291 * This is more of an informative/diagnostic error.
12294 printf("ctl_abort_task: ABORT sent for nonexistent I/O: "
12295 "%u:%u:%u tag %d type %d\n",
12296 io->io_hdr.nexus.initid,
12297 io->io_hdr.nexus.targ_port,
12298 io->io_hdr.nexus.targ_lun, io->taskio.tag_num,
12299 io->taskio.tag_type);
12302 io->taskio.task_status = CTL_TASK_FUNCTION_COMPLETE;
12307 ctl_query_task(union ctl_io *io, int task_set)
12310 struct ctl_lun *lun;
12311 struct ctl_softc *softc;
12315 softc = control_softc;
12316 targ_lun = io->io_hdr.nexus.targ_mapped_lun;
12317 mtx_lock(&softc->ctl_lock);
12318 if ((targ_lun >= CTL_MAX_LUNS) ||
12319 (lun = softc->ctl_luns[targ_lun]) == NULL) {
12320 mtx_unlock(&softc->ctl_lock);
12321 io->taskio.task_status = CTL_TASK_LUN_DOES_NOT_EXIST;
12324 mtx_lock(&lun->lun_lock);
12325 mtx_unlock(&softc->ctl_lock);
12326 for (xio = (union ctl_io *)TAILQ_FIRST(&lun->ooa_queue); xio != NULL;
12327 xio = (union ctl_io *)TAILQ_NEXT(&xio->io_hdr, ooa_links)) {
12329 if ((xio->io_hdr.nexus.targ_port != io->io_hdr.nexus.targ_port)
12330 || (xio->io_hdr.nexus.initid != io->io_hdr.nexus.initid)
12331 || (xio->io_hdr.flags & CTL_FLAG_ABORT))
12334 if (task_set || xio->scsiio.tag_num == io->taskio.tag_num) {
12339 mtx_unlock(&lun->lun_lock);
12341 io->taskio.task_status = CTL_TASK_FUNCTION_SUCCEEDED;
12343 io->taskio.task_status = CTL_TASK_FUNCTION_COMPLETE;
12348 ctl_query_async_event(union ctl_io *io)
12350 struct ctl_lun *lun;
12351 struct ctl_softc *softc;
12353 uint32_t targ_lun, initidx;
12355 softc = control_softc;
12356 targ_lun = io->io_hdr.nexus.targ_mapped_lun;
12357 mtx_lock(&softc->ctl_lock);
12358 if ((targ_lun >= CTL_MAX_LUNS) ||
12359 (lun = softc->ctl_luns[targ_lun]) == NULL) {
12360 mtx_unlock(&softc->ctl_lock);
12361 io->taskio.task_status = CTL_TASK_LUN_DOES_NOT_EXIST;
12364 mtx_lock(&lun->lun_lock);
12365 mtx_unlock(&softc->ctl_lock);
12366 initidx = ctl_get_initindex(&io->io_hdr.nexus);
12367 ua = ctl_build_qae(lun, initidx, io->taskio.task_resp);
12368 mtx_unlock(&lun->lun_lock);
12369 if (ua != CTL_UA_NONE)
12370 io->taskio.task_status = CTL_TASK_FUNCTION_SUCCEEDED;
12372 io->taskio.task_status = CTL_TASK_FUNCTION_COMPLETE;
12377 ctl_run_task(union ctl_io *io)
12379 struct ctl_softc *softc = control_softc;
12382 CTL_DEBUG_PRINT(("ctl_run_task\n"));
12383 KASSERT(io->io_hdr.io_type == CTL_IO_TASK,
12384 ("ctl_run_task: Unextected io_type %d\n", io->io_hdr.io_type));
12385 io->taskio.task_status = CTL_TASK_FUNCTION_NOT_SUPPORTED;
12386 bzero(io->taskio.task_resp, sizeof(io->taskio.task_resp));
12387 switch (io->taskio.task_action) {
12388 case CTL_TASK_ABORT_TASK:
12389 retval = ctl_abort_task(io);
12391 case CTL_TASK_ABORT_TASK_SET:
12392 case CTL_TASK_CLEAR_TASK_SET:
12393 retval = ctl_abort_task_set(io);
12395 case CTL_TASK_CLEAR_ACA:
12397 case CTL_TASK_I_T_NEXUS_RESET:
12398 retval = ctl_i_t_nexus_reset(io);
12400 case CTL_TASK_LUN_RESET:
12401 retval = ctl_lun_reset(softc, io);
12403 case CTL_TASK_TARGET_RESET:
12404 retval = ctl_target_reset(softc, io, CTL_UA_TARG_RESET);
12406 case CTL_TASK_BUS_RESET:
12407 retval = ctl_bus_reset(softc, io);
12409 case CTL_TASK_PORT_LOGIN:
12411 case CTL_TASK_PORT_LOGOUT:
12413 case CTL_TASK_QUERY_TASK:
12414 retval = ctl_query_task(io, 0);
12416 case CTL_TASK_QUERY_TASK_SET:
12417 retval = ctl_query_task(io, 1);
12419 case CTL_TASK_QUERY_ASYNC_EVENT:
12420 retval = ctl_query_async_event(io);
12423 printf("%s: got unknown task management event %d\n",
12424 __func__, io->taskio.task_action);
12428 io->io_hdr.status = CTL_SUCCESS;
12430 io->io_hdr.status = CTL_ERROR;
12435 * For HA operation. Handle commands that come in from the other
12439 ctl_handle_isc(union ctl_io *io)
12442 struct ctl_lun *lun;
12443 struct ctl_softc *softc = control_softc;
12446 targ_lun = io->io_hdr.nexus.targ_mapped_lun;
12447 lun = softc->ctl_luns[targ_lun];
12449 switch (io->io_hdr.msg_type) {
12450 case CTL_MSG_SERIALIZE:
12451 free_io = ctl_serialize_other_sc_cmd(&io->scsiio);
12453 case CTL_MSG_R2R: {
12454 const struct ctl_cmd_entry *entry;
12457 * This is only used in SER_ONLY mode.
12460 entry = ctl_get_cmd_entry(&io->scsiio, NULL);
12461 mtx_lock(&lun->lun_lock);
12462 if (ctl_scsiio_lun_check(lun,
12463 entry, (struct ctl_scsiio *)io) != 0) {
12464 mtx_unlock(&lun->lun_lock);
12468 io->io_hdr.flags |= CTL_FLAG_IS_WAS_ON_RTR;
12469 mtx_unlock(&lun->lun_lock);
12470 ctl_enqueue_rtr(io);
12473 case CTL_MSG_FINISH_IO:
12474 if (softc->ha_mode == CTL_HA_MODE_XFER) {
12479 mtx_lock(&lun->lun_lock);
12480 TAILQ_REMOVE(&lun->ooa_queue, &io->io_hdr,
12482 ctl_check_blocked(lun);
12483 mtx_unlock(&lun->lun_lock);
12486 case CTL_MSG_PERS_ACTION:
12487 ctl_hndl_per_res_out_on_other_sc(
12488 (union ctl_ha_msg *)&io->presio.pr_msg);
12491 case CTL_MSG_BAD_JUJU:
12495 case CTL_MSG_DATAMOVE:
12496 /* Only used in XFER mode */
12498 ctl_datamove_remote(io);
12500 case CTL_MSG_DATAMOVE_DONE:
12501 /* Only used in XFER mode */
12503 io->scsiio.be_move_done(io);
12505 case CTL_MSG_FAILOVER:
12506 ctl_failover_lun(io);
12511 printf("%s: Invalid message type %d\n",
12512 __func__, io->io_hdr.msg_type);
12522 * Returns the match type in the case of a match, or CTL_LUN_PAT_NONE if
12523 * there is no match.
12525 static ctl_lun_error_pattern
12526 ctl_cmd_pattern_match(struct ctl_scsiio *ctsio, struct ctl_error_desc *desc)
12528 const struct ctl_cmd_entry *entry;
12529 ctl_lun_error_pattern filtered_pattern, pattern;
12531 pattern = desc->error_pattern;
12534 * XXX KDM we need more data passed into this function to match a
12535 * custom pattern, and we actually need to implement custom pattern
12538 if (pattern & CTL_LUN_PAT_CMD)
12539 return (CTL_LUN_PAT_CMD);
12541 if ((pattern & CTL_LUN_PAT_MASK) == CTL_LUN_PAT_ANY)
12542 return (CTL_LUN_PAT_ANY);
12544 entry = ctl_get_cmd_entry(ctsio, NULL);
12546 filtered_pattern = entry->pattern & pattern;
12549 * If the user requested specific flags in the pattern (e.g.
12550 * CTL_LUN_PAT_RANGE), make sure the command supports all of those
12553 * If the user did not specify any flags, it doesn't matter whether
12554 * or not the command supports the flags.
12556 if ((filtered_pattern & ~CTL_LUN_PAT_MASK) !=
12557 (pattern & ~CTL_LUN_PAT_MASK))
12558 return (CTL_LUN_PAT_NONE);
12561 * If the user asked for a range check, see if the requested LBA
12562 * range overlaps with this command's LBA range.
12564 if (filtered_pattern & CTL_LUN_PAT_RANGE) {
12570 retval = ctl_get_lba_len((union ctl_io *)ctsio, &lba1, &len1);
12572 return (CTL_LUN_PAT_NONE);
12574 action = ctl_extent_check_lba(lba1, len1, desc->lba_range.lba,
12575 desc->lba_range.len, FALSE);
12577 * A "pass" means that the LBA ranges don't overlap, so
12578 * this doesn't match the user's range criteria.
12580 if (action == CTL_ACTION_PASS)
12581 return (CTL_LUN_PAT_NONE);
12584 return (filtered_pattern);
12588 ctl_inject_error(struct ctl_lun *lun, union ctl_io *io)
12590 struct ctl_error_desc *desc, *desc2;
12592 mtx_assert(&lun->lun_lock, MA_OWNED);
12594 STAILQ_FOREACH_SAFE(desc, &lun->error_list, links, desc2) {
12595 ctl_lun_error_pattern pattern;
12597 * Check to see whether this particular command matches
12598 * the pattern in the descriptor.
12600 pattern = ctl_cmd_pattern_match(&io->scsiio, desc);
12601 if ((pattern & CTL_LUN_PAT_MASK) == CTL_LUN_PAT_NONE)
12604 switch (desc->lun_error & CTL_LUN_INJ_TYPE) {
12605 case CTL_LUN_INJ_ABORTED:
12606 ctl_set_aborted(&io->scsiio);
12608 case CTL_LUN_INJ_MEDIUM_ERR:
12609 ctl_set_medium_error(&io->scsiio,
12610 (io->io_hdr.flags & CTL_FLAG_DATA_MASK) !=
12611 CTL_FLAG_DATA_OUT);
12613 case CTL_LUN_INJ_UA:
12614 /* 29h/00h POWER ON, RESET, OR BUS DEVICE RESET
12616 ctl_set_ua(&io->scsiio, 0x29, 0x00);
12618 case CTL_LUN_INJ_CUSTOM:
12620 * We're assuming the user knows what he is doing.
12621 * Just copy the sense information without doing
12624 bcopy(&desc->custom_sense, &io->scsiio.sense_data,
12625 MIN(sizeof(desc->custom_sense),
12626 sizeof(io->scsiio.sense_data)));
12627 io->scsiio.scsi_status = SCSI_STATUS_CHECK_COND;
12628 io->scsiio.sense_len = SSD_FULL_SIZE;
12629 io->io_hdr.status = CTL_SCSI_ERROR | CTL_AUTOSENSE;
12631 case CTL_LUN_INJ_NONE:
12634 * If this is an error injection type we don't know
12635 * about, clear the continuous flag (if it is set)
12636 * so it will get deleted below.
12638 desc->lun_error &= ~CTL_LUN_INJ_CONTINUOUS;
12642 * By default, each error injection action is a one-shot
12644 if (desc->lun_error & CTL_LUN_INJ_CONTINUOUS)
12647 STAILQ_REMOVE(&lun->error_list, desc, ctl_error_desc, links);
12653 #ifdef CTL_IO_DELAY
12655 ctl_datamove_timer_wakeup(void *arg)
12659 io = (union ctl_io *)arg;
12663 #endif /* CTL_IO_DELAY */
12666 ctl_datamove(union ctl_io *io)
12668 struct ctl_lun *lun;
12669 void (*fe_datamove)(union ctl_io *io);
12671 mtx_assert(&control_softc->ctl_lock, MA_NOTOWNED);
12673 CTL_DEBUG_PRINT(("ctl_datamove\n"));
12675 lun = (struct ctl_lun *)io->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
12677 if ((time_uptime - io->io_hdr.start_time) > ctl_time_io_secs) {
12682 ctl_scsi_path_string(io, path_str, sizeof(path_str));
12683 sbuf_new(&sb, str, sizeof(str), SBUF_FIXEDLEN);
12685 sbuf_cat(&sb, path_str);
12686 switch (io->io_hdr.io_type) {
12688 ctl_scsi_command_string(&io->scsiio, NULL, &sb);
12689 sbuf_printf(&sb, "\n");
12690 sbuf_cat(&sb, path_str);
12691 sbuf_printf(&sb, "Tag: 0x%04x, type %d\n",
12692 io->scsiio.tag_num, io->scsiio.tag_type);
12695 sbuf_printf(&sb, "Task I/O type: %d, Tag: 0x%04x, "
12696 "Tag Type: %d\n", io->taskio.task_action,
12697 io->taskio.tag_num, io->taskio.tag_type);
12700 panic("%s: Invalid CTL I/O type %d\n",
12701 __func__, io->io_hdr.io_type);
12703 sbuf_cat(&sb, path_str);
12704 sbuf_printf(&sb, "ctl_datamove: %jd seconds\n",
12705 (intmax_t)time_uptime - io->io_hdr.start_time);
12707 printf("%s", sbuf_data(&sb));
12709 #endif /* CTL_TIME_IO */
12711 #ifdef CTL_IO_DELAY
12712 if (io->io_hdr.flags & CTL_FLAG_DELAY_DONE) {
12713 io->io_hdr.flags &= ~CTL_FLAG_DELAY_DONE;
12716 && (lun->delay_info.datamove_delay > 0)) {
12718 callout_init(&io->io_hdr.delay_callout, /*mpsafe*/ 1);
12719 io->io_hdr.flags |= CTL_FLAG_DELAY_DONE;
12720 callout_reset(&io->io_hdr.delay_callout,
12721 lun->delay_info.datamove_delay * hz,
12722 ctl_datamove_timer_wakeup, io);
12723 if (lun->delay_info.datamove_type ==
12724 CTL_DELAY_TYPE_ONESHOT)
12725 lun->delay_info.datamove_delay = 0;
12732 * This command has been aborted. Set the port status, so we fail
12735 if (io->io_hdr.flags & CTL_FLAG_ABORT) {
12736 printf("ctl_datamove: tag 0x%04x on (%u:%u:%u) aborted\n",
12737 io->scsiio.tag_num, io->io_hdr.nexus.initid,
12738 io->io_hdr.nexus.targ_port,
12739 io->io_hdr.nexus.targ_lun);
12740 io->io_hdr.port_status = 31337;
12742 * Note that the backend, in this case, will get the
12743 * callback in its context. In other cases it may get
12744 * called in the frontend's interrupt thread context.
12746 io->scsiio.be_move_done(io);
12750 /* Don't confuse frontend with zero length data move. */
12751 if (io->scsiio.kern_data_len == 0) {
12752 io->scsiio.be_move_done(io);
12756 fe_datamove = ctl_io_port(&io->io_hdr)->fe_datamove;
12761 ctl_send_datamove_done(union ctl_io *io, int have_lock)
12763 union ctl_ha_msg msg;
12765 struct bintime cur_bt;
12768 memset(&msg, 0, sizeof(msg));
12769 msg.hdr.msg_type = CTL_MSG_DATAMOVE_DONE;
12770 msg.hdr.original_sc = io;
12771 msg.hdr.serializing_sc = io->io_hdr.serializing_sc;
12772 msg.hdr.nexus = io->io_hdr.nexus;
12773 msg.hdr.status = io->io_hdr.status;
12774 msg.scsi.tag_num = io->scsiio.tag_num;
12775 msg.scsi.tag_type = io->scsiio.tag_type;
12776 msg.scsi.scsi_status = io->scsiio.scsi_status;
12777 memcpy(&msg.scsi.sense_data, &io->scsiio.sense_data,
12778 io->scsiio.sense_len);
12779 msg.scsi.sense_len = io->scsiio.sense_len;
12780 msg.scsi.sense_residual = io->scsiio.sense_residual;
12781 msg.scsi.fetd_status = io->io_hdr.port_status;
12782 msg.scsi.residual = io->scsiio.residual;
12783 io->io_hdr.flags &= ~CTL_FLAG_IO_ACTIVE;
12784 if (io->io_hdr.flags & CTL_FLAG_FAILOVER) {
12785 ctl_failover_io(io, /*have_lock*/ have_lock);
12788 ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg,
12789 sizeof(msg.scsi) - sizeof(msg.scsi.sense_data) +
12790 msg.scsi.sense_len, M_WAITOK);
12793 getbinuptime(&cur_bt);
12794 bintime_sub(&cur_bt, &io->io_hdr.dma_start_bt);
12795 bintime_add(&io->io_hdr.dma_bt, &cur_bt);
12797 io->io_hdr.num_dmas++;
12801 * The DMA to the remote side is done, now we need to tell the other side
12802 * we're done so it can continue with its data movement.
12805 ctl_datamove_remote_write_cb(struct ctl_ha_dt_req *rq)
12812 if (rq->ret != CTL_HA_STATUS_SUCCESS) {
12813 printf("%s: ISC DMA write failed with error %d", __func__,
12815 ctl_set_internal_failure(&io->scsiio,
12817 /*retry_count*/ rq->ret);
12820 ctl_dt_req_free(rq);
12822 for (i = 0; i < io->scsiio.kern_sg_entries; i++)
12823 free(io->io_hdr.local_sglist[i].addr, M_CTL);
12824 free(io->io_hdr.remote_sglist, M_CTL);
12825 io->io_hdr.remote_sglist = NULL;
12826 io->io_hdr.local_sglist = NULL;
12829 * The data is in local and remote memory, so now we need to send
12830 * status (good or back) back to the other side.
12832 ctl_send_datamove_done(io, /*have_lock*/ 0);
12836 * We've moved the data from the host/controller into local memory. Now we
12837 * need to push it over to the remote controller's memory.
12840 ctl_datamove_remote_dm_write_cb(union ctl_io *io)
12844 retval = ctl_datamove_remote_xfer(io, CTL_HA_DT_CMD_WRITE,
12845 ctl_datamove_remote_write_cb);
12850 ctl_datamove_remote_write(union ctl_io *io)
12853 void (*fe_datamove)(union ctl_io *io);
12856 * - Get the data from the host/HBA into local memory.
12857 * - DMA memory from the local controller to the remote controller.
12858 * - Send status back to the remote controller.
12861 retval = ctl_datamove_remote_sgl_setup(io);
12865 /* Switch the pointer over so the FETD knows what to do */
12866 io->scsiio.kern_data_ptr = (uint8_t *)io->io_hdr.local_sglist;
12869 * Use a custom move done callback, since we need to send completion
12870 * back to the other controller, not to the backend on this side.
12872 io->scsiio.be_move_done = ctl_datamove_remote_dm_write_cb;
12874 fe_datamove = ctl_io_port(&io->io_hdr)->fe_datamove;
12879 ctl_datamove_remote_dm_read_cb(union ctl_io *io)
12888 for (i = 0; i < io->scsiio.kern_sg_entries; i++)
12889 free(io->io_hdr.local_sglist[i].addr, M_CTL);
12890 free(io->io_hdr.remote_sglist, M_CTL);
12891 io->io_hdr.remote_sglist = NULL;
12892 io->io_hdr.local_sglist = NULL;
12895 scsi_path_string(io, path_str, sizeof(path_str));
12896 sbuf_new(&sb, str, sizeof(str), SBUF_FIXEDLEN);
12897 sbuf_cat(&sb, path_str);
12898 scsi_command_string(&io->scsiio, NULL, &sb);
12899 sbuf_printf(&sb, "\n");
12900 sbuf_cat(&sb, path_str);
12901 sbuf_printf(&sb, "Tag: 0x%04x, type %d\n",
12902 io->scsiio.tag_num, io->scsiio.tag_type);
12903 sbuf_cat(&sb, path_str);
12904 sbuf_printf(&sb, "%s: flags %#x, status %#x\n", __func__,
12905 io->io_hdr.flags, io->io_hdr.status);
12907 printk("%s", sbuf_data(&sb));
12912 * The read is done, now we need to send status (good or bad) back
12913 * to the other side.
12915 ctl_send_datamove_done(io, /*have_lock*/ 0);
12921 ctl_datamove_remote_read_cb(struct ctl_ha_dt_req *rq)
12924 void (*fe_datamove)(union ctl_io *io);
12928 if (rq->ret != CTL_HA_STATUS_SUCCESS) {
12929 printf("%s: ISC DMA read failed with error %d\n", __func__,
12931 ctl_set_internal_failure(&io->scsiio,
12933 /*retry_count*/ rq->ret);
12936 ctl_dt_req_free(rq);
12938 /* Switch the pointer over so the FETD knows what to do */
12939 io->scsiio.kern_data_ptr = (uint8_t *)io->io_hdr.local_sglist;
12942 * Use a custom move done callback, since we need to send completion
12943 * back to the other controller, not to the backend on this side.
12945 io->scsiio.be_move_done = ctl_datamove_remote_dm_read_cb;
12947 /* XXX KDM add checks like the ones in ctl_datamove? */
12949 fe_datamove = ctl_io_port(&io->io_hdr)->fe_datamove;
12954 ctl_datamove_remote_sgl_setup(union ctl_io *io)
12956 struct ctl_sg_entry *local_sglist;
12957 uint32_t len_to_go;
12962 local_sglist = io->io_hdr.local_sglist;
12963 len_to_go = io->scsiio.kern_data_len;
12966 * The difficult thing here is that the size of the various
12967 * S/G segments may be different than the size from the
12968 * remote controller. That'll make it harder when DMAing
12969 * the data back to the other side.
12971 for (i = 0; len_to_go > 0; i++) {
12972 local_sglist[i].len = MIN(len_to_go, CTL_HA_DATAMOVE_SEGMENT);
12973 local_sglist[i].addr =
12974 malloc(local_sglist[i].len, M_CTL, M_WAITOK);
12976 len_to_go -= local_sglist[i].len;
12979 * Reset the number of S/G entries accordingly. The original
12980 * number of S/G entries is available in rem_sg_entries.
12982 io->scsiio.kern_sg_entries = i;
12985 printf("%s: kern_sg_entries = %d\n", __func__,
12986 io->scsiio.kern_sg_entries);
12987 for (i = 0; i < io->scsiio.kern_sg_entries; i++)
12988 printf("%s: sg[%d] = %p, %lu\n", __func__, i,
12989 local_sglist[i].addr, local_sglist[i].len);
12996 ctl_datamove_remote_xfer(union ctl_io *io, unsigned command,
12997 ctl_ha_dt_cb callback)
12999 struct ctl_ha_dt_req *rq;
13000 struct ctl_sg_entry *remote_sglist, *local_sglist;
13001 uint32_t local_used, remote_used, total_used;
13004 rq = ctl_dt_req_alloc();
13007 * If we failed to allocate the request, and if the DMA didn't fail
13008 * anyway, set busy status. This is just a resource allocation
13012 && ((io->io_hdr.status & CTL_STATUS_MASK) != CTL_STATUS_NONE &&
13013 (io->io_hdr.status & CTL_STATUS_MASK) != CTL_SUCCESS))
13014 ctl_set_busy(&io->scsiio);
13016 if ((io->io_hdr.status & CTL_STATUS_MASK) != CTL_STATUS_NONE &&
13017 (io->io_hdr.status & CTL_STATUS_MASK) != CTL_SUCCESS) {
13020 ctl_dt_req_free(rq);
13023 * The data move failed. We need to return status back
13024 * to the other controller. No point in trying to DMA
13025 * data to the remote controller.
13028 ctl_send_datamove_done(io, /*have_lock*/ 0);
13033 local_sglist = io->io_hdr.local_sglist;
13034 remote_sglist = io->io_hdr.remote_sglist;
13040 * Pull/push the data over the wire from/to the other controller.
13041 * This takes into account the possibility that the local and
13042 * remote sglists may not be identical in terms of the size of
13043 * the elements and the number of elements.
13045 * One fundamental assumption here is that the length allocated for
13046 * both the local and remote sglists is identical. Otherwise, we've
13047 * essentially got a coding error of some sort.
13049 isc_ret = CTL_HA_STATUS_SUCCESS;
13050 for (i = 0, j = 0; total_used < io->scsiio.kern_data_len; ) {
13054 rq->command = command;
13058 * Both pointers should be aligned. But it is possible
13059 * that the allocation length is not. They should both
13060 * also have enough slack left over at the end, though,
13061 * to round up to the next 8 byte boundary.
13063 cur_len = MIN(local_sglist[i].len - local_used,
13064 remote_sglist[j].len - remote_used);
13065 rq->size = cur_len;
13067 tmp_ptr = (uint8_t *)local_sglist[i].addr;
13068 tmp_ptr += local_used;
13071 /* Use physical addresses when talking to ISC hardware */
13072 if ((io->io_hdr.flags & CTL_FLAG_BUS_ADDR) == 0) {
13073 /* XXX KDM use busdma */
13074 rq->local = vtophys(tmp_ptr);
13076 rq->local = tmp_ptr;
13078 KASSERT((io->io_hdr.flags & CTL_FLAG_BUS_ADDR) == 0,
13079 ("HA does not support BUS_ADDR"));
13080 rq->local = tmp_ptr;
13083 tmp_ptr = (uint8_t *)remote_sglist[j].addr;
13084 tmp_ptr += remote_used;
13085 rq->remote = tmp_ptr;
13087 rq->callback = NULL;
13089 local_used += cur_len;
13090 if (local_used >= local_sglist[i].len) {
13095 remote_used += cur_len;
13096 if (remote_used >= remote_sglist[j].len) {
13100 total_used += cur_len;
13102 if (total_used >= io->scsiio.kern_data_len)
13103 rq->callback = callback;
13106 printf("%s: %s: local %p remote %p size %d\n", __func__,
13107 (command == CTL_HA_DT_CMD_WRITE) ? "WRITE" : "READ",
13108 rq->local, rq->remote, rq->size);
13111 isc_ret = ctl_dt_single(rq);
13112 if (isc_ret > CTL_HA_STATUS_SUCCESS)
13115 if (isc_ret != CTL_HA_STATUS_WAIT) {
13124 ctl_datamove_remote_read(union ctl_io *io)
13130 * This will send an error to the other controller in the case of a
13133 retval = ctl_datamove_remote_sgl_setup(io);
13137 retval = ctl_datamove_remote_xfer(io, CTL_HA_DT_CMD_READ,
13138 ctl_datamove_remote_read_cb);
13141 * Make sure we free memory if there was an error.. The
13142 * ctl_datamove_remote_xfer() function will send the
13143 * datamove done message, or call the callback with an
13144 * error if there is a problem.
13146 for (i = 0; i < io->scsiio.kern_sg_entries; i++)
13147 free(io->io_hdr.local_sglist[i].addr, M_CTL);
13148 free(io->io_hdr.remote_sglist, M_CTL);
13149 io->io_hdr.remote_sglist = NULL;
13150 io->io_hdr.local_sglist = NULL;
13155 * Process a datamove request from the other controller. This is used for
13156 * XFER mode only, not SER_ONLY mode. For writes, we DMA into local memory
13157 * first. Once that is complete, the data gets DMAed into the remote
13158 * controller's memory. For reads, we DMA from the remote controller's
13159 * memory into our memory first, and then move it out to the FETD.
13162 ctl_datamove_remote(union ctl_io *io)
13165 mtx_assert(&control_softc->ctl_lock, MA_NOTOWNED);
13167 if (io->io_hdr.flags & CTL_FLAG_FAILOVER) {
13168 ctl_failover_io(io, /*have_lock*/ 0);
13173 * Note that we look for an aborted I/O here, but don't do some of
13174 * the other checks that ctl_datamove() normally does.
13175 * We don't need to run the datamove delay code, since that should
13176 * have been done if need be on the other controller.
13178 if (io->io_hdr.flags & CTL_FLAG_ABORT) {
13179 printf("%s: tag 0x%04x on (%u:%u:%u) aborted\n", __func__,
13180 io->scsiio.tag_num, io->io_hdr.nexus.initid,
13181 io->io_hdr.nexus.targ_port,
13182 io->io_hdr.nexus.targ_lun);
13183 io->io_hdr.port_status = 31338;
13184 ctl_send_datamove_done(io, /*have_lock*/ 0);
13188 if ((io->io_hdr.flags & CTL_FLAG_DATA_MASK) == CTL_FLAG_DATA_OUT)
13189 ctl_datamove_remote_write(io);
13190 else if ((io->io_hdr.flags & CTL_FLAG_DATA_MASK) == CTL_FLAG_DATA_IN)
13191 ctl_datamove_remote_read(io);
13193 io->io_hdr.port_status = 31339;
13194 ctl_send_datamove_done(io, /*have_lock*/ 0);
13199 ctl_process_done(union ctl_io *io)
13201 struct ctl_lun *lun;
13202 struct ctl_softc *softc = control_softc;
13203 void (*fe_done)(union ctl_io *io);
13204 union ctl_ha_msg msg;
13205 uint32_t targ_port = io->io_hdr.nexus.targ_port;
13207 CTL_DEBUG_PRINT(("ctl_process_done\n"));
13208 fe_done = softc->ctl_ports[targ_port]->fe_done;
13211 if ((time_uptime - io->io_hdr.start_time) > ctl_time_io_secs) {
13216 ctl_scsi_path_string(io, path_str, sizeof(path_str));
13217 sbuf_new(&sb, str, sizeof(str), SBUF_FIXEDLEN);
13219 sbuf_cat(&sb, path_str);
13220 switch (io->io_hdr.io_type) {
13222 ctl_scsi_command_string(&io->scsiio, NULL, &sb);
13223 sbuf_printf(&sb, "\n");
13224 sbuf_cat(&sb, path_str);
13225 sbuf_printf(&sb, "Tag: 0x%04x, type %d\n",
13226 io->scsiio.tag_num, io->scsiio.tag_type);
13229 sbuf_printf(&sb, "Task I/O type: %d, Tag: 0x%04x, "
13230 "Tag Type: %d\n", io->taskio.task_action,
13231 io->taskio.tag_num, io->taskio.tag_type);
13234 panic("%s: Invalid CTL I/O type %d\n",
13235 __func__, io->io_hdr.io_type);
13237 sbuf_cat(&sb, path_str);
13238 sbuf_printf(&sb, "ctl_process_done: %jd seconds\n",
13239 (intmax_t)time_uptime - io->io_hdr.start_time);
13241 printf("%s", sbuf_data(&sb));
13243 #endif /* CTL_TIME_IO */
13245 switch (io->io_hdr.io_type) {
13249 if (ctl_debug & CTL_DEBUG_INFO)
13250 ctl_io_error_print(io, NULL);
13254 panic("%s: Invalid CTL I/O type %d\n",
13255 __func__, io->io_hdr.io_type);
13258 lun = (struct ctl_lun *)io->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
13260 CTL_DEBUG_PRINT(("NULL LUN for lun %d\n",
13261 io->io_hdr.nexus.targ_mapped_lun));
13265 mtx_lock(&lun->lun_lock);
13268 * Check to see if we have any errors to inject here. We only
13269 * inject errors for commands that don't already have errors set.
13271 if (!STAILQ_EMPTY(&lun->error_list) &&
13272 ((io->io_hdr.status & CTL_STATUS_MASK) == CTL_SUCCESS) &&
13273 ((io->io_hdr.flags & CTL_FLAG_STATUS_SENT) == 0))
13274 ctl_inject_error(lun, io);
13277 * XXX KDM how do we treat commands that aren't completed
13280 * XXX KDM should we also track I/O latency?
13282 if ((io->io_hdr.status & CTL_STATUS_MASK) == CTL_SUCCESS &&
13283 io->io_hdr.io_type == CTL_IO_SCSI) {
13285 struct bintime cur_bt;
13289 if ((io->io_hdr.flags & CTL_FLAG_DATA_MASK) ==
13291 type = CTL_STATS_READ;
13292 else if ((io->io_hdr.flags & CTL_FLAG_DATA_MASK) ==
13294 type = CTL_STATS_WRITE;
13296 type = CTL_STATS_NO_IO;
13298 lun->stats.ports[targ_port].bytes[type] +=
13299 io->scsiio.kern_total_len;
13300 lun->stats.ports[targ_port].operations[type]++;
13302 bintime_add(&lun->stats.ports[targ_port].dma_time[type],
13303 &io->io_hdr.dma_bt);
13304 getbinuptime(&cur_bt);
13305 bintime_sub(&cur_bt, &io->io_hdr.start_bt);
13306 bintime_add(&lun->stats.ports[targ_port].time[type], &cur_bt);
13308 lun->stats.ports[targ_port].num_dmas[type] +=
13309 io->io_hdr.num_dmas;
13313 * Remove this from the OOA queue.
13315 TAILQ_REMOVE(&lun->ooa_queue, &io->io_hdr, ooa_links);
13317 if (TAILQ_EMPTY(&lun->ooa_queue))
13318 lun->last_busy = getsbinuptime();
13322 * Run through the blocked queue on this LUN and see if anything
13323 * has become unblocked, now that this transaction is done.
13325 ctl_check_blocked(lun);
13328 * If the LUN has been invalidated, free it if there is nothing
13329 * left on its OOA queue.
13331 if ((lun->flags & CTL_LUN_INVALID)
13332 && TAILQ_EMPTY(&lun->ooa_queue)) {
13333 mtx_unlock(&lun->lun_lock);
13334 mtx_lock(&softc->ctl_lock);
13336 mtx_unlock(&softc->ctl_lock);
13338 mtx_unlock(&lun->lun_lock);
13343 * If this command has been aborted, make sure we set the status
13344 * properly. The FETD is responsible for freeing the I/O and doing
13345 * whatever it needs to do to clean up its state.
13347 if (io->io_hdr.flags & CTL_FLAG_ABORT)
13348 ctl_set_task_aborted(&io->scsiio);
13351 * If enabled, print command error status.
13353 if ((io->io_hdr.status & CTL_STATUS_MASK) != CTL_SUCCESS &&
13354 (ctl_debug & CTL_DEBUG_INFO) != 0)
13355 ctl_io_error_print(io, NULL);
13358 * Tell the FETD or the other shelf controller we're done with this
13359 * command. Note that only SCSI commands get to this point. Task
13360 * management commands are completed above.
13362 if ((softc->ha_mode != CTL_HA_MODE_XFER) &&
13363 (io->io_hdr.flags & CTL_FLAG_SENT_2OTHER_SC)) {
13364 memset(&msg, 0, sizeof(msg));
13365 msg.hdr.msg_type = CTL_MSG_FINISH_IO;
13366 msg.hdr.serializing_sc = io->io_hdr.serializing_sc;
13367 msg.hdr.nexus = io->io_hdr.nexus;
13368 ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg,
13369 sizeof(msg.scsi) - sizeof(msg.scsi.sense_data),
13378 * Front end should call this if it doesn't do autosense. When the request
13379 * sense comes back in from the initiator, we'll dequeue this and send it.
13382 ctl_queue_sense(union ctl_io *io)
13384 struct ctl_lun *lun;
13385 struct ctl_port *port;
13386 struct ctl_softc *softc;
13387 uint32_t initidx, targ_lun;
13389 softc = control_softc;
13391 CTL_DEBUG_PRINT(("ctl_queue_sense\n"));
13394 * LUN lookup will likely move to the ctl_work_thread() once we
13395 * have our new queueing infrastructure (that doesn't put things on
13396 * a per-LUN queue initially). That is so that we can handle
13397 * things like an INQUIRY to a LUN that we don't have enabled. We
13398 * can't deal with that right now.
13400 mtx_lock(&softc->ctl_lock);
13403 * If we don't have a LUN for this, just toss the sense
13406 port = ctl_io_port(&ctsio->io_hdr);
13407 targ_lun = ctl_lun_map_from_port(port, io->io_hdr.nexus.targ_lun);
13408 if ((targ_lun < CTL_MAX_LUNS)
13409 && (softc->ctl_luns[targ_lun] != NULL))
13410 lun = softc->ctl_luns[targ_lun];
13414 initidx = ctl_get_initindex(&io->io_hdr.nexus);
13416 mtx_lock(&lun->lun_lock);
13418 * Already have CA set for this LUN...toss the sense information.
13420 if (ctl_is_set(lun->have_ca, initidx)) {
13421 mtx_unlock(&lun->lun_lock);
13425 memcpy(&lun->pending_sense[initidx], &io->scsiio.sense_data,
13426 MIN(sizeof(lun->pending_sense[initidx]),
13427 sizeof(io->scsiio.sense_data)));
13428 ctl_set_mask(lun->have_ca, initidx);
13429 mtx_unlock(&lun->lun_lock);
13432 mtx_unlock(&softc->ctl_lock);
13436 return (CTL_RETVAL_COMPLETE);
13441 * Primary command inlet from frontend ports. All SCSI and task I/O
13442 * requests must go through this function.
13445 ctl_queue(union ctl_io *io)
13447 struct ctl_port *port;
13449 CTL_DEBUG_PRINT(("ctl_queue cdb[0]=%02X\n", io->scsiio.cdb[0]));
13452 io->io_hdr.start_time = time_uptime;
13453 getbinuptime(&io->io_hdr.start_bt);
13454 #endif /* CTL_TIME_IO */
13456 /* Map FE-specific LUN ID into global one. */
13457 port = ctl_io_port(&io->io_hdr);
13458 io->io_hdr.nexus.targ_mapped_lun =
13459 ctl_lun_map_from_port(port, io->io_hdr.nexus.targ_lun);
13461 switch (io->io_hdr.io_type) {
13464 if (ctl_debug & CTL_DEBUG_CDB)
13466 ctl_enqueue_incoming(io);
13469 printf("ctl_queue: unknown I/O type %d\n", io->io_hdr.io_type);
13473 return (CTL_RETVAL_COMPLETE);
13476 #ifdef CTL_IO_DELAY
13478 ctl_done_timer_wakeup(void *arg)
13482 io = (union ctl_io *)arg;
13485 #endif /* CTL_IO_DELAY */
13488 ctl_serseq_done(union ctl_io *io)
13490 struct ctl_lun *lun;
13492 lun = (struct ctl_lun *)io->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
13493 if (lun->be_lun == NULL ||
13494 lun->be_lun->serseq == CTL_LUN_SERSEQ_OFF)
13496 mtx_lock(&lun->lun_lock);
13497 io->io_hdr.flags |= CTL_FLAG_SERSEQ_DONE;
13498 ctl_check_blocked(lun);
13499 mtx_unlock(&lun->lun_lock);
13503 ctl_done(union ctl_io *io)
13507 * Enable this to catch duplicate completion issues.
13510 if (io->io_hdr.flags & CTL_FLAG_ALREADY_DONE) {
13511 printf("%s: type %d msg %d cdb %x iptl: "
13512 "%u:%u:%u tag 0x%04x "
13513 "flag %#x status %x\n",
13515 io->io_hdr.io_type,
13516 io->io_hdr.msg_type,
13518 io->io_hdr.nexus.initid,
13519 io->io_hdr.nexus.targ_port,
13520 io->io_hdr.nexus.targ_lun,
13521 (io->io_hdr.io_type ==
13523 io->taskio.tag_num :
13524 io->scsiio.tag_num,
13526 io->io_hdr.status);
13528 io->io_hdr.flags |= CTL_FLAG_ALREADY_DONE;
13532 * This is an internal copy of an I/O, and should not go through
13533 * the normal done processing logic.
13535 if (io->io_hdr.flags & CTL_FLAG_INT_COPY)
13538 #ifdef CTL_IO_DELAY
13539 if (io->io_hdr.flags & CTL_FLAG_DELAY_DONE) {
13540 struct ctl_lun *lun;
13542 lun =(struct ctl_lun *)io->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
13544 io->io_hdr.flags &= ~CTL_FLAG_DELAY_DONE;
13546 struct ctl_lun *lun;
13548 lun =(struct ctl_lun *)io->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
13551 && (lun->delay_info.done_delay > 0)) {
13553 callout_init(&io->io_hdr.delay_callout, /*mpsafe*/ 1);
13554 io->io_hdr.flags |= CTL_FLAG_DELAY_DONE;
13555 callout_reset(&io->io_hdr.delay_callout,
13556 lun->delay_info.done_delay * hz,
13557 ctl_done_timer_wakeup, io);
13558 if (lun->delay_info.done_type == CTL_DELAY_TYPE_ONESHOT)
13559 lun->delay_info.done_delay = 0;
13563 #endif /* CTL_IO_DELAY */
13565 ctl_enqueue_done(io);
13569 ctl_work_thread(void *arg)
13571 struct ctl_thread *thr = (struct ctl_thread *)arg;
13572 struct ctl_softc *softc = thr->ctl_softc;
13576 CTL_DEBUG_PRINT(("ctl_work_thread starting\n"));
13580 * We handle the queues in this order:
13582 * - done queue (to free up resources, unblock other commands)
13586 * If those queues are empty, we break out of the loop and
13589 mtx_lock(&thr->queue_lock);
13590 io = (union ctl_io *)STAILQ_FIRST(&thr->isc_queue);
13592 STAILQ_REMOVE_HEAD(&thr->isc_queue, links);
13593 mtx_unlock(&thr->queue_lock);
13594 ctl_handle_isc(io);
13597 io = (union ctl_io *)STAILQ_FIRST(&thr->done_queue);
13599 STAILQ_REMOVE_HEAD(&thr->done_queue, links);
13600 /* clear any blocked commands, call fe_done */
13601 mtx_unlock(&thr->queue_lock);
13602 ctl_process_done(io);
13605 io = (union ctl_io *)STAILQ_FIRST(&thr->incoming_queue);
13607 STAILQ_REMOVE_HEAD(&thr->incoming_queue, links);
13608 mtx_unlock(&thr->queue_lock);
13609 if (io->io_hdr.io_type == CTL_IO_TASK)
13612 ctl_scsiio_precheck(softc, &io->scsiio);
13615 io = (union ctl_io *)STAILQ_FIRST(&thr->rtr_queue);
13617 STAILQ_REMOVE_HEAD(&thr->rtr_queue, links);
13618 mtx_unlock(&thr->queue_lock);
13619 retval = ctl_scsiio(&io->scsiio);
13620 if (retval != CTL_RETVAL_COMPLETE)
13621 CTL_DEBUG_PRINT(("ctl_scsiio failed\n"));
13625 /* Sleep until we have something to do. */
13626 mtx_sleep(thr, &thr->queue_lock, PDROP | PRIBIO, "-", 0);
13631 ctl_lun_thread(void *arg)
13633 struct ctl_softc *softc = (struct ctl_softc *)arg;
13634 struct ctl_be_lun *be_lun;
13636 CTL_DEBUG_PRINT(("ctl_lun_thread starting\n"));
13639 mtx_lock(&softc->ctl_lock);
13640 be_lun = STAILQ_FIRST(&softc->pending_lun_queue);
13641 if (be_lun != NULL) {
13642 STAILQ_REMOVE_HEAD(&softc->pending_lun_queue, links);
13643 mtx_unlock(&softc->ctl_lock);
13644 ctl_create_lun(be_lun);
13648 /* Sleep until we have something to do. */
13649 mtx_sleep(&softc->pending_lun_queue, &softc->ctl_lock,
13650 PDROP | PRIBIO, "-", 0);
13655 ctl_thresh_thread(void *arg)
13657 struct ctl_softc *softc = (struct ctl_softc *)arg;
13658 struct ctl_lun *lun;
13659 struct scsi_da_rw_recovery_page *rwpage;
13660 struct ctl_logical_block_provisioning_page *page;
13662 union ctl_ha_msg msg;
13663 uint64_t thres, val;
13666 CTL_DEBUG_PRINT(("ctl_thresh_thread starting\n"));
13669 mtx_lock(&softc->ctl_lock);
13670 STAILQ_FOREACH(lun, &softc->lun_list, links) {
13671 if ((lun->flags & CTL_LUN_DISABLED) ||
13672 (lun->flags & CTL_LUN_NO_MEDIA) ||
13673 lun->backend->lun_attr == NULL)
13675 if ((lun->flags & CTL_LUN_PRIMARY_SC) == 0 &&
13676 softc->ha_mode == CTL_HA_MODE_XFER)
13678 rwpage = &lun->mode_pages.rw_er_page[CTL_PAGE_CURRENT];
13679 if ((rwpage->byte8 & SMS_RWER_LBPERE) == 0)
13682 page = &lun->mode_pages.lbp_page[CTL_PAGE_CURRENT];
13683 for (i = 0; i < CTL_NUM_LBP_THRESH; i++) {
13684 if ((page->descr[i].flags & SLBPPD_ENABLED) == 0)
13686 thres = scsi_4btoul(page->descr[i].count);
13687 thres <<= CTL_LBP_EXPONENT;
13688 switch (page->descr[i].resource) {
13690 attr = "blocksavail";
13693 attr = "blocksused";
13696 attr = "poolblocksavail";
13699 attr = "poolblocksused";
13704 mtx_unlock(&softc->ctl_lock); // XXX
13705 val = lun->backend->lun_attr(
13706 lun->be_lun->be_lun, attr);
13707 mtx_lock(&softc->ctl_lock);
13708 if (val == UINT64_MAX)
13710 if ((page->descr[i].flags & SLBPPD_ARMING_MASK)
13711 == SLBPPD_ARMING_INC)
13712 e = (val >= thres);
13714 e = (val <= thres);
13718 mtx_lock(&lun->lun_lock);
13720 scsi_u64to8b((uint8_t *)&page->descr[i] -
13721 (uint8_t *)page, lun->ua_tpt_info);
13722 if (lun->lasttpt == 0 ||
13723 time_uptime - lun->lasttpt >= CTL_LBP_UA_PERIOD) {
13724 lun->lasttpt = time_uptime;
13725 ctl_est_ua_all(lun, -1, CTL_UA_THIN_PROV_THRES);
13731 ctl_clr_ua_all(lun, -1, CTL_UA_THIN_PROV_THRES);
13734 mtx_unlock(&lun->lun_lock);
13736 lun->ctl_softc->ha_mode == CTL_HA_MODE_XFER) {
13737 /* Send msg to other side. */
13738 bzero(&msg.ua, sizeof(msg.ua));
13739 msg.hdr.msg_type = CTL_MSG_UA;
13740 msg.hdr.nexus.initid = -1;
13741 msg.hdr.nexus.targ_port = -1;
13742 msg.hdr.nexus.targ_lun = lun->lun;
13743 msg.hdr.nexus.targ_mapped_lun = lun->lun;
13745 msg.ua.ua_set = (set > 0);
13746 msg.ua.ua_type = CTL_UA_THIN_PROV_THRES;
13747 memcpy(msg.ua.ua_info, lun->ua_tpt_info, 8);
13748 mtx_unlock(&softc->ctl_lock); // XXX
13749 ctl_ha_msg_send(CTL_HA_CHAN_CTL, &msg,
13750 sizeof(msg.ua), M_WAITOK);
13751 mtx_lock(&softc->ctl_lock);
13754 mtx_unlock(&softc->ctl_lock);
13755 pause("-", CTL_LBP_PERIOD * hz);
13760 ctl_enqueue_incoming(union ctl_io *io)
13762 struct ctl_softc *softc = control_softc;
13763 struct ctl_thread *thr;
13766 idx = (io->io_hdr.nexus.targ_port * 127 +
13767 io->io_hdr.nexus.initid) % worker_threads;
13768 thr = &softc->threads[idx];
13769 mtx_lock(&thr->queue_lock);
13770 STAILQ_INSERT_TAIL(&thr->incoming_queue, &io->io_hdr, links);
13771 mtx_unlock(&thr->queue_lock);
13776 ctl_enqueue_rtr(union ctl_io *io)
13778 struct ctl_softc *softc = control_softc;
13779 struct ctl_thread *thr;
13781 thr = &softc->threads[io->io_hdr.nexus.targ_mapped_lun % worker_threads];
13782 mtx_lock(&thr->queue_lock);
13783 STAILQ_INSERT_TAIL(&thr->rtr_queue, &io->io_hdr, links);
13784 mtx_unlock(&thr->queue_lock);
13789 ctl_enqueue_done(union ctl_io *io)
13791 struct ctl_softc *softc = control_softc;
13792 struct ctl_thread *thr;
13794 thr = &softc->threads[io->io_hdr.nexus.targ_mapped_lun % worker_threads];
13795 mtx_lock(&thr->queue_lock);
13796 STAILQ_INSERT_TAIL(&thr->done_queue, &io->io_hdr, links);
13797 mtx_unlock(&thr->queue_lock);
13802 ctl_enqueue_isc(union ctl_io *io)
13804 struct ctl_softc *softc = control_softc;
13805 struct ctl_thread *thr;
13807 thr = &softc->threads[io->io_hdr.nexus.targ_mapped_lun % worker_threads];
13808 mtx_lock(&thr->queue_lock);
13809 STAILQ_INSERT_TAIL(&thr->isc_queue, &io->io_hdr, links);
13810 mtx_unlock(&thr->queue_lock);