1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * vvvvvvvvvvvvvvvvvvvvvvv Original vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv
4 * Copyright (C) 1992 Eric Youngdale
5 * Simulate a host adapter with 2 disks attached. Do a lot of checking
6 * to make sure that we are not getting blocks mixed up, and PANIC if
7 * anything out of the ordinary is seen.
8 * ^^^^^^^^^^^^^^^^^^^^^^^ Original ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
10 * Copyright (C) 2001 - 2021 Douglas Gilbert
12 * For documentation see http://sg.danny.cz/sg/scsi_debug.html
16 #define pr_fmt(fmt) KBUILD_MODNAME ":%s: " fmt, __func__
18 #include <linux/module.h>
19 #include <linux/align.h>
20 #include <linux/kernel.h>
21 #include <linux/errno.h>
22 #include <linux/jiffies.h>
23 #include <linux/slab.h>
24 #include <linux/types.h>
25 #include <linux/string.h>
27 #include <linux/init.h>
28 #include <linux/proc_fs.h>
29 #include <linux/vmalloc.h>
30 #include <linux/moduleparam.h>
31 #include <linux/scatterlist.h>
32 #include <linux/blkdev.h>
33 #include <linux/crc-t10dif.h>
34 #include <linux/spinlock.h>
35 #include <linux/interrupt.h>
36 #include <linux/atomic.h>
37 #include <linux/hrtimer.h>
38 #include <linux/uuid.h>
39 #include <linux/t10-pi.h>
40 #include <linux/msdos_partition.h>
41 #include <linux/random.h>
42 #include <linux/xarray.h>
43 #include <linux/prefetch.h>
44 #include <linux/debugfs.h>
45 #include <linux/async.h>
46 #include <linux/cleanup.h>
48 #include <net/checksum.h>
50 #include <asm/unaligned.h>
52 #include <scsi/scsi.h>
53 #include <scsi/scsi_cmnd.h>
54 #include <scsi/scsi_device.h>
55 #include <scsi/scsi_host.h>
56 #include <scsi/scsicam.h>
57 #include <scsi/scsi_eh.h>
58 #include <scsi/scsi_tcq.h>
59 #include <scsi/scsi_dbg.h>
62 #include "scsi_logging.h"
64 /* make sure inq_product_rev string corresponds to this version */
65 #define SDEBUG_VERSION "0191" /* format to fit INQUIRY revision field */
66 static const char *sdebug_version_date = "20210520";
68 #define MY_NAME "scsi_debug"
70 /* Additional Sense Code (ASC) */
71 #define NO_ADDITIONAL_SENSE 0x0
72 #define OVERLAP_ATOMIC_COMMAND_ASC 0x0
73 #define OVERLAP_ATOMIC_COMMAND_ASCQ 0x23
74 #define LOGICAL_UNIT_NOT_READY 0x4
75 #define LOGICAL_UNIT_COMMUNICATION_FAILURE 0x8
76 #define UNRECOVERED_READ_ERR 0x11
77 #define PARAMETER_LIST_LENGTH_ERR 0x1a
78 #define INVALID_OPCODE 0x20
79 #define LBA_OUT_OF_RANGE 0x21
80 #define INVALID_FIELD_IN_CDB 0x24
81 #define INVALID_FIELD_IN_PARAM_LIST 0x26
82 #define WRITE_PROTECTED 0x27
83 #define UA_RESET_ASC 0x29
84 #define UA_CHANGED_ASC 0x2a
85 #define TARGET_CHANGED_ASC 0x3f
86 #define LUNS_CHANGED_ASCQ 0x0e
87 #define INSUFF_RES_ASC 0x55
88 #define INSUFF_RES_ASCQ 0x3
89 #define POWER_ON_RESET_ASCQ 0x0
90 #define POWER_ON_OCCURRED_ASCQ 0x1
91 #define BUS_RESET_ASCQ 0x2 /* scsi bus reset occurred */
92 #define MODE_CHANGED_ASCQ 0x1 /* mode parameters changed */
93 #define CAPACITY_CHANGED_ASCQ 0x9
94 #define SAVING_PARAMS_UNSUP 0x39
95 #define TRANSPORT_PROBLEM 0x4b
96 #define THRESHOLD_EXCEEDED 0x5d
97 #define LOW_POWER_COND_ON 0x5e
98 #define MISCOMPARE_VERIFY_ASC 0x1d
99 #define MICROCODE_CHANGED_ASCQ 0x1 /* with TARGET_CHANGED_ASC */
100 #define MICROCODE_CHANGED_WO_RESET_ASCQ 0x16
101 #define WRITE_ERROR_ASC 0xc
102 #define UNALIGNED_WRITE_ASCQ 0x4
103 #define WRITE_BOUNDARY_ASCQ 0x5
104 #define READ_INVDATA_ASCQ 0x6
105 #define READ_BOUNDARY_ASCQ 0x7
106 #define ATTEMPT_ACCESS_GAP 0x9
107 #define INSUFF_ZONE_ASCQ 0xe
108 /* see drivers/scsi/sense_codes.h */
110 /* Additional Sense Code Qualifier (ASCQ) */
111 #define ACK_NAK_TO 0x3
113 /* Default values for driver parameters */
114 #define DEF_NUM_HOST 1
115 #define DEF_NUM_TGTS 1
116 #define DEF_MAX_LUNS 1
117 /* With these defaults, this driver will make 1 host with 1 target
118 * (id 0) containing 1 logical unit (lun 0). That is 1 device.
121 #define DEF_CDB_LEN 10
122 #define DEF_JDELAY 1 /* if > 0 unit is a jiffy */
123 #define DEF_DEV_SIZE_PRE_INIT 0
124 #define DEF_DEV_SIZE_MB 8
125 #define DEF_ZBC_DEV_SIZE_MB 128
128 #define DEF_PER_HOST_STORE false
129 #define DEF_D_SENSE 0
130 #define DEF_EVERY_NTH 0
131 #define DEF_FAKE_RW 0
133 #define DEF_HOST_LOCK 0
136 #define DEF_LBPWS10 0
138 #define DEF_LOWEST_ALIGNED 0
139 #define DEF_NDELAY 0 /* if > 0 unit is a nanosecond */
140 #define DEF_NO_LUN_0 0
141 #define DEF_NUM_PARTS 0
143 #define DEF_OPT_BLKS 1024
144 #define DEF_PHYSBLK_EXP 0
145 #define DEF_OPT_XFERLEN_EXP 0
146 #define DEF_PTYPE TYPE_DISK
147 #define DEF_RANDOM false
148 #define DEF_REMOVABLE false
149 #define DEF_SCSI_LEVEL 7 /* INQUIRY, byte2 [6->SPC-4; 7->SPC-5] */
150 #define DEF_SECTOR_SIZE 512
151 #define DEF_UNMAP_ALIGNMENT 0
152 #define DEF_UNMAP_GRANULARITY 1
153 #define DEF_UNMAP_MAX_BLOCKS 0xFFFFFFFF
154 #define DEF_UNMAP_MAX_DESC 256
155 #define DEF_VIRTUAL_GB 0
156 #define DEF_VPD_USE_HOSTNO 1
157 #define DEF_WRITESAME_LENGTH 0xFFFF
158 #define DEF_ATOMIC_WR 0
159 #define DEF_ATOMIC_WR_MAX_LENGTH 8192
160 #define DEF_ATOMIC_WR_ALIGN 2
161 #define DEF_ATOMIC_WR_GRAN 2
162 #define DEF_ATOMIC_WR_MAX_LENGTH_BNDRY (DEF_ATOMIC_WR_MAX_LENGTH)
163 #define DEF_ATOMIC_WR_MAX_BNDRY 128
165 #define DEF_STATISTICS false
166 #define DEF_SUBMIT_QUEUES 1
167 #define DEF_TUR_MS_TO_READY 0
168 #define DEF_UUID_CTL 0
169 #define JDELAY_OVERRIDDEN -9999
171 /* Default parameters for ZBC drives */
172 #define DEF_ZBC_ZONE_SIZE_MB 128
173 #define DEF_ZBC_MAX_OPEN_ZONES 8
174 #define DEF_ZBC_NR_CONV_ZONES 1
176 #define SDEBUG_LUN_0_VAL 0
178 /* bit mask values for sdebug_opts */
179 #define SDEBUG_OPT_NOISE 1
180 #define SDEBUG_OPT_MEDIUM_ERR 2
181 #define SDEBUG_OPT_TIMEOUT 4
182 #define SDEBUG_OPT_RECOVERED_ERR 8
183 #define SDEBUG_OPT_TRANSPORT_ERR 16
184 #define SDEBUG_OPT_DIF_ERR 32
185 #define SDEBUG_OPT_DIX_ERR 64
186 #define SDEBUG_OPT_MAC_TIMEOUT 128
187 #define SDEBUG_OPT_SHORT_TRANSFER 0x100
188 #define SDEBUG_OPT_Q_NOISE 0x200
189 #define SDEBUG_OPT_ALL_TSF 0x400 /* ignore */
190 #define SDEBUG_OPT_RARE_TSF 0x800
191 #define SDEBUG_OPT_N_WCE 0x1000
192 #define SDEBUG_OPT_RESET_NOISE 0x2000
193 #define SDEBUG_OPT_NO_CDB_NOISE 0x4000
194 #define SDEBUG_OPT_HOST_BUSY 0x8000
195 #define SDEBUG_OPT_CMD_ABORT 0x10000
196 #define SDEBUG_OPT_ALL_NOISE (SDEBUG_OPT_NOISE | SDEBUG_OPT_Q_NOISE | \
197 SDEBUG_OPT_RESET_NOISE)
198 #define SDEBUG_OPT_ALL_INJECTING (SDEBUG_OPT_RECOVERED_ERR | \
199 SDEBUG_OPT_TRANSPORT_ERR | \
200 SDEBUG_OPT_DIF_ERR | SDEBUG_OPT_DIX_ERR | \
201 SDEBUG_OPT_SHORT_TRANSFER | \
202 SDEBUG_OPT_HOST_BUSY | \
203 SDEBUG_OPT_CMD_ABORT)
204 #define SDEBUG_OPT_RECOV_DIF_DIX (SDEBUG_OPT_RECOVERED_ERR | \
205 SDEBUG_OPT_DIF_ERR | SDEBUG_OPT_DIX_ERR)
207 /* As indicated in SAM-5 and SPC-4 Unit Attentions (UAs) are returned in
208 * priority order. In the subset implemented here lower numbers have higher
209 * priority. The UA numbers should be a sequence starting from 0 with
210 * SDEBUG_NUM_UAS being 1 higher than the highest numbered UA. */
211 #define SDEBUG_UA_POR 0 /* Power on, reset, or bus device reset */
212 #define SDEBUG_UA_POOCCUR 1 /* Power on occurred */
213 #define SDEBUG_UA_BUS_RESET 2
214 #define SDEBUG_UA_MODE_CHANGED 3
215 #define SDEBUG_UA_CAPACITY_CHANGED 4
216 #define SDEBUG_UA_LUNS_CHANGED 5
217 #define SDEBUG_UA_MICROCODE_CHANGED 6 /* simulate firmware change */
218 #define SDEBUG_UA_MICROCODE_CHANGED_WO_RESET 7
219 #define SDEBUG_NUM_UAS 8
221 /* when 1==SDEBUG_OPT_MEDIUM_ERR, a medium error is simulated at this
222 * sector on read commands: */
223 #define OPT_MEDIUM_ERR_ADDR 0x1234 /* that's sector 4660 in decimal */
224 #define OPT_MEDIUM_ERR_NUM 10 /* number of consecutive medium errs */
226 /* SDEBUG_CANQUEUE is the maximum number of commands that can be queued
227 * (for response) per submit queue at one time. Can be reduced by max_queue
228 * option. Command responses are not queued when jdelay=0 and ndelay=0. The
229 * per-device DEF_CMD_PER_LUN can be changed via sysfs:
230 * /sys/class/scsi_device/<h:c:t:l>/device/queue_depth
231 * but cannot exceed SDEBUG_CANQUEUE .
233 #define SDEBUG_CANQUEUE_WORDS 3 /* a WORD is bits in a long */
234 #define SDEBUG_CANQUEUE (SDEBUG_CANQUEUE_WORDS * BITS_PER_LONG)
235 #define DEF_CMD_PER_LUN SDEBUG_CANQUEUE
237 /* UA - Unit Attention; SA - Service Action; SSU - Start Stop Unit */
238 #define F_D_IN 1 /* Data-in command (e.g. READ) */
239 #define F_D_OUT 2 /* Data-out command (e.g. WRITE) */
240 #define F_D_OUT_MAYBE 4 /* WRITE SAME, NDOB bit */
242 #define F_RL_WLUN_OK 0x10 /* allowed with REPORT LUNS W-LUN */
243 #define F_SKIP_UA 0x20 /* bypass UAs (e.g. INQUIRY command) */
244 #define F_DELAY_OVERR 0x40 /* for commands like INQUIRY */
245 #define F_SA_LOW 0x80 /* SA is in cdb byte 1, bits 4 to 0 */
246 #define F_SA_HIGH 0x100 /* SA is in cdb bytes 8 and 9 */
247 #define F_INV_OP 0x200 /* invalid opcode (not supported) */
248 #define F_FAKE_RW 0x400 /* bypass resp_*() when fake_rw set */
249 #define F_M_ACCESS 0x800 /* media access, reacts to SSU state */
250 #define F_SSU_DELAY 0x1000 /* SSU command delay (long-ish) */
251 #define F_SYNC_DELAY 0x2000 /* SYNCHRONIZE CACHE delay */
253 /* Useful combinations of the above flags */
254 #define FF_RESPOND (F_RL_WLUN_OK | F_SKIP_UA | F_DELAY_OVERR)
255 #define FF_MEDIA_IO (F_M_ACCESS | F_FAKE_RW)
256 #define FF_SA (F_SA_HIGH | F_SA_LOW)
257 #define F_LONG_DELAY (F_SSU_DELAY | F_SYNC_DELAY)
259 #define SDEBUG_MAX_PARTS 4
261 #define SDEBUG_MAX_CMD_LEN 32
263 #define SDEB_XA_NOT_IN_USE XA_MARK_1
265 static struct kmem_cache *queued_cmd_cache;
267 #define TO_QUEUED_CMD(scmd) ((void *)(scmd)->host_scribble)
268 #define ASSIGN_QUEUED_CMD(scmnd, qc) { (scmnd)->host_scribble = (void *) qc; }
270 /* Zone types (zbcr05 table 25) */
275 /* ZBC_ZTYPE_SOBR = 0x4, */
279 /* enumeration names taken from table 26, zbcr05 */
281 ZBC_NOT_WRITE_POINTER = 0x0,
283 ZC2_IMPLICIT_OPEN = 0x2,
284 ZC3_EXPLICIT_OPEN = 0x3,
291 struct sdeb_zone_state { /* ZBC: per zone state */
292 enum sdebug_z_type z_type;
293 enum sdebug_z_cond z_cond;
294 bool z_non_seq_resource;
300 enum sdebug_err_type {
301 ERR_TMOUT_CMD = 0, /* make specific scsi command timeout */
302 ERR_FAIL_QUEUE_CMD = 1, /* make specific scsi command's */
303 /* queuecmd return failed */
304 ERR_FAIL_CMD = 2, /* make specific scsi command's */
305 /* queuecmd return succeed but */
306 /* with errors set in scsi_cmnd */
307 ERR_ABORT_CMD_FAILED = 3, /* control return FAILED from */
308 /* scsi_debug_abort() */
309 ERR_LUN_RESET_FAILED = 4, /* control return FAILED from */
310 /* scsi_debug_device_reseLUN_RESET_FAILEDt() */
313 struct sdebug_err_inject {
315 struct list_head list;
322 * For ERR_FAIL_QUEUE_CMD
330 unsigned char host_byte;
331 unsigned char driver_byte;
332 unsigned char status_byte;
333 unsigned char sense_key;
340 struct sdebug_dev_info {
341 struct list_head dev_list;
342 unsigned int channel;
346 struct sdebug_host_info *sdbg_host;
347 unsigned long uas_bm[1];
348 atomic_t stopped; /* 1: by SSU, 2: device start */
351 /* For ZBC devices */
355 unsigned int zsize_shift;
356 unsigned int nr_zones;
357 unsigned int nr_conv_zones;
358 unsigned int nr_seq_zones;
359 unsigned int nr_imp_open;
360 unsigned int nr_exp_open;
361 unsigned int nr_closed;
362 unsigned int max_open;
363 ktime_t create_ts; /* time since bootup that this device was created */
364 struct sdeb_zone_state *zstate;
366 struct dentry *debugfs_entry;
367 struct spinlock list_lock;
368 struct list_head inject_err_list;
371 struct sdebug_target_info {
373 struct dentry *debugfs_entry;
376 struct sdebug_host_info {
377 struct list_head host_list;
378 int si_idx; /* sdeb_store_info (per host) xarray index */
379 struct Scsi_Host *shost;
381 struct list_head dev_info_list;
384 /* There is an xarray of pointers to this struct's objects, one per host */
385 struct sdeb_store_info {
386 rwlock_t macc_data_lck; /* for media data access on this store */
387 rwlock_t macc_meta_lck; /* for atomic media meta access on this store */
388 rwlock_t macc_sector_lck; /* per-sector media data access on this store */
389 u8 *storep; /* user data storage (ram) */
390 struct t10_pi_tuple *dif_storep; /* protection info */
391 void *map_storep; /* provisioning map */
394 #define dev_to_sdebug_host(d) \
395 container_of(d, struct sdebug_host_info, dev)
397 #define shost_to_sdebug_host(shost) \
398 dev_to_sdebug_host(shost->dma_dev)
400 enum sdeb_defer_type {SDEB_DEFER_NONE = 0, SDEB_DEFER_HRT = 1,
401 SDEB_DEFER_WQ = 2, SDEB_DEFER_POLL = 3};
403 struct sdebug_defer {
405 struct execute_work ew;
406 ktime_t cmpl_ts;/* time since boot to complete this cmd */
408 bool aborted; /* true when blk_abort_request() already called */
409 enum sdeb_defer_type defer_t;
412 struct sdebug_device_access_info {
416 struct scsi_cmnd *self;
419 struct sdebug_queued_cmd {
420 /* corresponding bit set in in_use_bm[] in owning struct sdebug_queue
421 * instance indicates this slot is in use.
423 struct sdebug_defer sd_dp;
424 struct scsi_cmnd *scmd;
425 struct sdebug_device_access_info *i;
428 struct sdebug_scsi_cmd {
432 static atomic_t sdebug_cmnd_count; /* number of incoming commands */
433 static atomic_t sdebug_completions; /* count of deferred completions */
434 static atomic_t sdebug_miss_cpus; /* submission + completion cpus differ */
435 static atomic_t sdebug_a_tsf; /* 'almost task set full' counter */
436 static atomic_t sdeb_inject_pending;
437 static atomic_t sdeb_mq_poll_count; /* bumped when mq_poll returns > 0 */
439 struct opcode_info_t {
440 u8 num_attached; /* 0 if this is it (i.e. a leaf); use 0xff */
441 /* for terminating element */
442 u8 opcode; /* if num_attached > 0, preferred */
443 u16 sa; /* service action */
444 u32 flags; /* OR-ed set of SDEB_F_* */
445 int (*pfp)(struct scsi_cmnd *, struct sdebug_dev_info *);
446 const struct opcode_info_t *arrp; /* num_attached elements or NULL */
447 u8 len_mask[16]; /* len_mask[0]-->cdb_len, then mask for cdb */
448 /* 1 to min(cdb_len, 15); ignore cdb[15...] */
451 /* SCSI opcodes (first byte of cdb) of interest mapped onto these indexes */
452 enum sdeb_opcode_index {
453 SDEB_I_INVALID_OPCODE = 0,
455 SDEB_I_REPORT_LUNS = 2,
456 SDEB_I_REQUEST_SENSE = 3,
457 SDEB_I_TEST_UNIT_READY = 4,
458 SDEB_I_MODE_SENSE = 5, /* 6, 10 */
459 SDEB_I_MODE_SELECT = 6, /* 6, 10 */
460 SDEB_I_LOG_SENSE = 7,
461 SDEB_I_READ_CAPACITY = 8, /* 10; 16 is in SA_IN(16) */
462 SDEB_I_READ = 9, /* 6, 10, 12, 16 */
463 SDEB_I_WRITE = 10, /* 6, 10, 12, 16 */
464 SDEB_I_START_STOP = 11,
465 SDEB_I_SERV_ACT_IN_16 = 12, /* add ...SERV_ACT_IN_12 if needed */
466 SDEB_I_SERV_ACT_OUT_16 = 13, /* add ...SERV_ACT_OUT_12 if needed */
467 SDEB_I_MAINT_IN = 14,
468 SDEB_I_MAINT_OUT = 15,
469 SDEB_I_VERIFY = 16, /* VERIFY(10), VERIFY(16) */
470 SDEB_I_VARIABLE_LEN = 17, /* READ(32), WRITE(32), WR_SCAT(32) */
471 SDEB_I_RESERVE = 18, /* 6, 10 */
472 SDEB_I_RELEASE = 19, /* 6, 10 */
473 SDEB_I_ALLOW_REMOVAL = 20, /* PREVENT ALLOW MEDIUM REMOVAL */
474 SDEB_I_REZERO_UNIT = 21, /* REWIND in SSC */
475 SDEB_I_ATA_PT = 22, /* 12, 16 */
476 SDEB_I_SEND_DIAG = 23,
478 SDEB_I_WRITE_BUFFER = 25,
479 SDEB_I_WRITE_SAME = 26, /* 10, 16 */
480 SDEB_I_SYNC_CACHE = 27, /* 10, 16 */
481 SDEB_I_COMP_WRITE = 28,
482 SDEB_I_PRE_FETCH = 29, /* 10, 16 */
483 SDEB_I_ZONE_OUT = 30, /* 0x94+SA; includes no data xfer */
484 SDEB_I_ZONE_IN = 31, /* 0x95+SA; all have data-in */
485 SDEB_I_ATOMIC_WRITE_16 = 32,
486 SDEB_I_LAST_ELEM_P1 = 33, /* keep this last (previous + 1) */
490 static const unsigned char opcode_ind_arr[256] = {
491 /* 0x0; 0x0->0x1f: 6 byte cdbs */
492 SDEB_I_TEST_UNIT_READY, SDEB_I_REZERO_UNIT, 0, SDEB_I_REQUEST_SENSE,
494 SDEB_I_READ, 0, SDEB_I_WRITE, 0, 0, 0, 0, 0,
495 0, 0, SDEB_I_INQUIRY, 0, 0, SDEB_I_MODE_SELECT, SDEB_I_RESERVE,
497 0, 0, SDEB_I_MODE_SENSE, SDEB_I_START_STOP, 0, SDEB_I_SEND_DIAG,
498 SDEB_I_ALLOW_REMOVAL, 0,
499 /* 0x20; 0x20->0x3f: 10 byte cdbs */
500 0, 0, 0, 0, 0, SDEB_I_READ_CAPACITY, 0, 0,
501 SDEB_I_READ, 0, SDEB_I_WRITE, 0, 0, 0, 0, SDEB_I_VERIFY,
502 0, 0, 0, 0, SDEB_I_PRE_FETCH, SDEB_I_SYNC_CACHE, 0, 0,
503 0, 0, 0, SDEB_I_WRITE_BUFFER, 0, 0, 0, 0,
504 /* 0x40; 0x40->0x5f: 10 byte cdbs */
505 0, SDEB_I_WRITE_SAME, SDEB_I_UNMAP, 0, 0, 0, 0, 0,
506 0, 0, 0, 0, 0, SDEB_I_LOG_SENSE, 0, 0,
507 0, 0, 0, 0, 0, SDEB_I_MODE_SELECT, SDEB_I_RESERVE,
509 0, 0, SDEB_I_MODE_SENSE, 0, 0, 0, 0, 0,
510 /* 0x60; 0x60->0x7d are reserved, 0x7e is "extended cdb" */
511 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
512 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
513 0, SDEB_I_VARIABLE_LEN,
514 /* 0x80; 0x80->0x9f: 16 byte cdbs */
515 0, 0, 0, 0, 0, SDEB_I_ATA_PT, 0, 0,
516 SDEB_I_READ, SDEB_I_COMP_WRITE, SDEB_I_WRITE, 0,
517 0, 0, 0, SDEB_I_VERIFY,
518 SDEB_I_PRE_FETCH, SDEB_I_SYNC_CACHE, 0, SDEB_I_WRITE_SAME,
519 SDEB_I_ZONE_OUT, SDEB_I_ZONE_IN, 0, 0,
521 SDEB_I_ATOMIC_WRITE_16, 0, SDEB_I_SERV_ACT_IN_16, SDEB_I_SERV_ACT_OUT_16,
522 /* 0xa0; 0xa0->0xbf: 12 byte cdbs */
523 SDEB_I_REPORT_LUNS, SDEB_I_ATA_PT, 0, SDEB_I_MAINT_IN,
524 SDEB_I_MAINT_OUT, 0, 0, 0,
525 SDEB_I_READ, 0 /* SDEB_I_SERV_ACT_OUT_12 */, SDEB_I_WRITE,
526 0 /* SDEB_I_SERV_ACT_IN_12 */, 0, 0, 0, 0,
527 0, 0, 0, 0, 0, 0, 0, 0,
528 0, 0, 0, 0, 0, 0, 0, 0,
529 /* 0xc0; 0xc0->0xff: vendor specific */
530 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
531 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
532 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
533 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
537 * The following "response" functions return the SCSI mid-level's 4 byte
538 * tuple-in-an-int. To handle commands with an IMMED bit, for a faster
539 * command completion, they can mask their return value with
540 * SDEG_RES_IMMED_MASK .
542 #define SDEG_RES_IMMED_MASK 0x40000000
544 static int resp_inquiry(struct scsi_cmnd *, struct sdebug_dev_info *);
545 static int resp_report_luns(struct scsi_cmnd *, struct sdebug_dev_info *);
546 static int resp_requests(struct scsi_cmnd *, struct sdebug_dev_info *);
547 static int resp_mode_sense(struct scsi_cmnd *, struct sdebug_dev_info *);
548 static int resp_mode_select(struct scsi_cmnd *, struct sdebug_dev_info *);
549 static int resp_log_sense(struct scsi_cmnd *, struct sdebug_dev_info *);
550 static int resp_readcap(struct scsi_cmnd *, struct sdebug_dev_info *);
551 static int resp_read_dt0(struct scsi_cmnd *, struct sdebug_dev_info *);
552 static int resp_write_dt0(struct scsi_cmnd *, struct sdebug_dev_info *);
553 static int resp_write_scat(struct scsi_cmnd *, struct sdebug_dev_info *);
554 static int resp_start_stop(struct scsi_cmnd *, struct sdebug_dev_info *);
555 static int resp_readcap16(struct scsi_cmnd *, struct sdebug_dev_info *);
556 static int resp_get_lba_status(struct scsi_cmnd *, struct sdebug_dev_info *);
557 static int resp_get_stream_status(struct scsi_cmnd *scp,
558 struct sdebug_dev_info *devip);
559 static int resp_report_tgtpgs(struct scsi_cmnd *, struct sdebug_dev_info *);
560 static int resp_unmap(struct scsi_cmnd *, struct sdebug_dev_info *);
561 static int resp_rsup_opcodes(struct scsi_cmnd *, struct sdebug_dev_info *);
562 static int resp_rsup_tmfs(struct scsi_cmnd *, struct sdebug_dev_info *);
563 static int resp_verify(struct scsi_cmnd *, struct sdebug_dev_info *);
564 static int resp_write_same_10(struct scsi_cmnd *, struct sdebug_dev_info *);
565 static int resp_write_same_16(struct scsi_cmnd *, struct sdebug_dev_info *);
566 static int resp_comp_write(struct scsi_cmnd *, struct sdebug_dev_info *);
567 static int resp_write_buffer(struct scsi_cmnd *, struct sdebug_dev_info *);
568 static int resp_sync_cache(struct scsi_cmnd *, struct sdebug_dev_info *);
569 static int resp_pre_fetch(struct scsi_cmnd *, struct sdebug_dev_info *);
570 static int resp_report_zones(struct scsi_cmnd *, struct sdebug_dev_info *);
571 static int resp_atomic_write(struct scsi_cmnd *, struct sdebug_dev_info *);
572 static int resp_open_zone(struct scsi_cmnd *, struct sdebug_dev_info *);
573 static int resp_close_zone(struct scsi_cmnd *, struct sdebug_dev_info *);
574 static int resp_finish_zone(struct scsi_cmnd *, struct sdebug_dev_info *);
575 static int resp_rwp_zone(struct scsi_cmnd *, struct sdebug_dev_info *);
577 static int sdebug_do_add_host(bool mk_new_store);
578 static int sdebug_add_host_helper(int per_host_idx);
579 static void sdebug_do_remove_host(bool the_end);
580 static int sdebug_add_store(void);
581 static void sdebug_erase_store(int idx, struct sdeb_store_info *sip);
582 static void sdebug_erase_all_stores(bool apart_from_first);
584 static void sdebug_free_queued_cmd(struct sdebug_queued_cmd *sqcp);
587 * The following are overflow arrays for cdbs that "hit" the same index in
588 * the opcode_info_arr array. The most time sensitive (or commonly used) cdb
589 * should be placed in opcode_info_arr[], the others should be placed here.
591 static const struct opcode_info_t msense_iarr[] = {
592 {0, 0x1a, 0, F_D_IN, NULL, NULL,
593 {6, 0xe8, 0xff, 0xff, 0xff, 0xc7, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0} },
596 static const struct opcode_info_t mselect_iarr[] = {
597 {0, 0x15, 0, F_D_OUT, NULL, NULL,
598 {6, 0xf1, 0, 0, 0xff, 0xc7, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0} },
601 static const struct opcode_info_t read_iarr[] = {
602 {0, 0x28, 0, F_D_IN | FF_MEDIA_IO, resp_read_dt0, NULL,/* READ(10) */
603 {10, 0xff, 0xff, 0xff, 0xff, 0xff, 0x3f, 0xff, 0xff, 0xc7, 0, 0,
605 {0, 0x8, 0, F_D_IN | FF_MEDIA_IO, resp_read_dt0, NULL, /* READ(6) */
606 {6, 0xff, 0xff, 0xff, 0xff, 0xc7, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0} },
607 {0, 0xa8, 0, F_D_IN | FF_MEDIA_IO, resp_read_dt0, NULL,/* READ(12) */
608 {12, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xbf,
612 static const struct opcode_info_t write_iarr[] = {
613 {0, 0x2a, 0, F_D_OUT | FF_MEDIA_IO, resp_write_dt0, /* WRITE(10) */
614 NULL, {10, 0xfb, 0xff, 0xff, 0xff, 0xff, 0x3f, 0xff, 0xff, 0xc7,
616 {0, 0xa, 0, F_D_OUT | FF_MEDIA_IO, resp_write_dt0, /* WRITE(6) */
617 NULL, {6, 0xff, 0xff, 0xff, 0xff, 0xc7, 0, 0, 0, 0, 0, 0, 0,
619 {0, 0xaa, 0, F_D_OUT | FF_MEDIA_IO, resp_write_dt0, /* WRITE(12) */
620 NULL, {12, 0xfb, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
621 0xbf, 0xc7, 0, 0, 0, 0} },
624 static const struct opcode_info_t verify_iarr[] = {
625 {0, 0x2f, 0, F_D_OUT_MAYBE | FF_MEDIA_IO, resp_verify,/* VERIFY(10) */
626 NULL, {10, 0xf7, 0xff, 0xff, 0xff, 0xff, 0xbf, 0xff, 0xff, 0xc7,
630 static const struct opcode_info_t sa_in_16_iarr[] = {
631 {0, 0x9e, 0x12, F_SA_LOW | F_D_IN, resp_get_lba_status, NULL,
632 {16, 0x12, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
633 0xff, 0xff, 0xff, 0, 0xc7} }, /* GET LBA STATUS(16) */
634 {0, 0x9e, 0x16, F_SA_LOW | F_D_IN, resp_get_stream_status, NULL,
635 {16, 0x16, 0, 0, 0xff, 0xff, 0, 0, 0, 0, 0xff, 0xff, 0xff, 0xff,
636 0, 0} }, /* GET STREAM STATUS */
639 static const struct opcode_info_t vl_iarr[] = { /* VARIABLE LENGTH */
640 {0, 0x7f, 0xb, F_SA_HIGH | F_D_OUT | FF_MEDIA_IO, resp_write_dt0,
641 NULL, {32, 0xc7, 0, 0, 0, 0, 0x3f, 0x18, 0x0, 0xb, 0xfa,
642 0, 0xff, 0xff, 0xff, 0xff} }, /* WRITE(32) */
643 {0, 0x7f, 0x11, F_SA_HIGH | F_D_OUT | FF_MEDIA_IO, resp_write_scat,
644 NULL, {32, 0xc7, 0, 0, 0, 0, 0x3f, 0x18, 0x0, 0x11, 0xf8,
645 0, 0xff, 0xff, 0x0, 0x0} }, /* WRITE SCATTERED(32) */
648 static const struct opcode_info_t maint_in_iarr[] = { /* MAINT IN */
649 {0, 0xa3, 0xc, F_SA_LOW | F_D_IN, resp_rsup_opcodes, NULL,
650 {12, 0xc, 0x87, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0,
651 0xc7, 0, 0, 0, 0} }, /* REPORT SUPPORTED OPERATION CODES */
652 {0, 0xa3, 0xd, F_SA_LOW | F_D_IN, resp_rsup_tmfs, NULL,
653 {12, 0xd, 0x80, 0, 0, 0, 0xff, 0xff, 0xff, 0xff, 0, 0xc7, 0, 0,
654 0, 0} }, /* REPORTED SUPPORTED TASK MANAGEMENT FUNCTIONS */
657 static const struct opcode_info_t write_same_iarr[] = {
658 {0, 0x93, 0, F_D_OUT_MAYBE | FF_MEDIA_IO, resp_write_same_16, NULL,
659 {16, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
660 0xff, 0xff, 0xff, 0x3f, 0xc7} }, /* WRITE SAME(16) */
663 static const struct opcode_info_t reserve_iarr[] = {
664 {0, 0x16, 0, F_D_OUT, NULL, NULL, /* RESERVE(6) */
665 {6, 0x1f, 0xff, 0xff, 0xff, 0xc7, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0} },
668 static const struct opcode_info_t release_iarr[] = {
669 {0, 0x17, 0, F_D_OUT, NULL, NULL, /* RELEASE(6) */
670 {6, 0x1f, 0xff, 0, 0, 0xc7, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0} },
673 static const struct opcode_info_t sync_cache_iarr[] = {
674 {0, 0x91, 0, F_SYNC_DELAY | F_M_ACCESS, resp_sync_cache, NULL,
675 {16, 0x6, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
676 0xff, 0xff, 0xff, 0xff, 0x3f, 0xc7} }, /* SYNC_CACHE (16) */
679 static const struct opcode_info_t pre_fetch_iarr[] = {
680 {0, 0x90, 0, F_SYNC_DELAY | FF_MEDIA_IO, resp_pre_fetch, NULL,
681 {16, 0x2, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
682 0xff, 0xff, 0xff, 0xff, 0x3f, 0xc7} }, /* PRE-FETCH (16) */
685 static const struct opcode_info_t zone_out_iarr[] = { /* ZONE OUT(16) */
686 {0, 0x94, 0x1, F_SA_LOW | F_M_ACCESS, resp_close_zone, NULL,
687 {16, 0x1, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
688 0xff, 0, 0, 0xff, 0xff, 0x1, 0xc7} }, /* CLOSE ZONE */
689 {0, 0x94, 0x2, F_SA_LOW | F_M_ACCESS, resp_finish_zone, NULL,
690 {16, 0x2, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
691 0xff, 0, 0, 0xff, 0xff, 0x1, 0xc7} }, /* FINISH ZONE */
692 {0, 0x94, 0x4, F_SA_LOW | F_M_ACCESS, resp_rwp_zone, NULL,
693 {16, 0x4, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
694 0xff, 0, 0, 0xff, 0xff, 0x1, 0xc7} }, /* RESET WRITE POINTER */
697 static const struct opcode_info_t zone_in_iarr[] = { /* ZONE IN(16) */
698 {0, 0x95, 0x6, F_SA_LOW | F_D_IN | F_M_ACCESS, NULL, NULL,
699 {16, 0x6, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
700 0xff, 0xff, 0xff, 0xff, 0x3f, 0xc7} }, /* REPORT ZONES */
704 /* This array is accessed via SDEB_I_* values. Make sure all are mapped,
705 * plus the terminating elements for logic that scans this table such as
706 * REPORT SUPPORTED OPERATION CODES. */
707 static const struct opcode_info_t opcode_info_arr[SDEB_I_LAST_ELEM_P1 + 1] = {
709 {0, 0, 0, F_INV_OP | FF_RESPOND, NULL, NULL, /* unknown opcodes */
710 {0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0} },
711 {0, 0x12, 0, FF_RESPOND | F_D_IN, resp_inquiry, NULL, /* INQUIRY */
712 {6, 0xe3, 0xff, 0xff, 0xff, 0xc7, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0} },
713 {0, 0xa0, 0, FF_RESPOND | F_D_IN, resp_report_luns, NULL,
714 {12, 0xe3, 0xff, 0, 0, 0, 0xff, 0xff, 0xff, 0xff, 0, 0xc7, 0, 0,
715 0, 0} }, /* REPORT LUNS */
716 {0, 0x3, 0, FF_RESPOND | F_D_IN, resp_requests, NULL,
717 {6, 0xe1, 0, 0, 0xff, 0xc7, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0} },
718 {0, 0x0, 0, F_M_ACCESS | F_RL_WLUN_OK, NULL, NULL,/* TEST UNIT READY */
719 {6, 0, 0, 0, 0, 0xc7, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0} },
721 {ARRAY_SIZE(msense_iarr), 0x5a, 0, F_D_IN, /* MODE SENSE(10) */
722 resp_mode_sense, msense_iarr, {10, 0xf8, 0xff, 0xff, 0, 0, 0,
723 0xff, 0xff, 0xc7, 0, 0, 0, 0, 0, 0} },
724 {ARRAY_SIZE(mselect_iarr), 0x55, 0, F_D_OUT, /* MODE SELECT(10) */
725 resp_mode_select, mselect_iarr, {10, 0xf1, 0, 0, 0, 0, 0, 0xff,
726 0xff, 0xc7, 0, 0, 0, 0, 0, 0} },
727 {0, 0x4d, 0, F_D_IN, resp_log_sense, NULL, /* LOG SENSE */
728 {10, 0xe3, 0xff, 0xff, 0, 0xff, 0xff, 0xff, 0xff, 0xc7, 0, 0, 0,
730 {0, 0x25, 0, F_D_IN, resp_readcap, NULL, /* READ CAPACITY(10) */
731 {10, 0xe1, 0xff, 0xff, 0xff, 0xff, 0, 0, 0x1, 0xc7, 0, 0, 0, 0,
733 {ARRAY_SIZE(read_iarr), 0x88, 0, F_D_IN | FF_MEDIA_IO, /* READ(16) */
734 resp_read_dt0, read_iarr, {16, 0xfe, 0xff, 0xff, 0xff, 0xff,
735 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xc7} },
737 {ARRAY_SIZE(write_iarr), 0x8a, 0, F_D_OUT | FF_MEDIA_IO,
738 resp_write_dt0, write_iarr, /* WRITE(16) */
739 {16, 0xfa, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
740 0xff, 0xff, 0xff, 0xff, 0xff, 0xc7} },
741 {0, 0x1b, 0, F_SSU_DELAY, resp_start_stop, NULL,/* START STOP UNIT */
742 {6, 0x1, 0, 0xf, 0xf7, 0xc7, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0} },
743 {ARRAY_SIZE(sa_in_16_iarr), 0x9e, 0x10, F_SA_LOW | F_D_IN,
744 resp_readcap16, sa_in_16_iarr, /* SA_IN(16), READ CAPACITY(16) */
745 {16, 0x10, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
746 0xff, 0xff, 0xff, 0xff, 0x1, 0xc7} },
747 {0, 0x9f, 0x12, F_SA_LOW | F_D_OUT | FF_MEDIA_IO, resp_write_scat,
748 NULL, {16, 0x12, 0xf9, 0x0, 0xff, 0xff, 0, 0, 0xff, 0xff, 0xff,
749 0xff, 0xff, 0xff, 0xff, 0xc7} }, /* SA_OUT(16), WRITE SCAT(16) */
750 {ARRAY_SIZE(maint_in_iarr), 0xa3, 0xa, F_SA_LOW | F_D_IN,
751 resp_report_tgtpgs, /* MAINT IN, REPORT TARGET PORT GROUPS */
752 maint_in_iarr, {12, 0xea, 0, 0, 0, 0, 0xff, 0xff, 0xff,
753 0xff, 0, 0xc7, 0, 0, 0, 0} },
755 {0, 0, 0, F_INV_OP | FF_RESPOND, NULL, NULL, /* MAINT OUT */
756 {0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0} },
757 {ARRAY_SIZE(verify_iarr), 0x8f, 0,
758 F_D_OUT_MAYBE | FF_MEDIA_IO, resp_verify, /* VERIFY(16) */
759 verify_iarr, {16, 0xf6, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
760 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0x3f, 0xc7} },
761 {ARRAY_SIZE(vl_iarr), 0x7f, 0x9, F_SA_HIGH | F_D_IN | FF_MEDIA_IO,
762 resp_read_dt0, vl_iarr, /* VARIABLE LENGTH, READ(32) */
763 {32, 0xc7, 0, 0, 0, 0, 0x3f, 0x18, 0x0, 0x9, 0xfe, 0, 0xff, 0xff,
765 {ARRAY_SIZE(reserve_iarr), 0x56, 0, F_D_OUT,
766 NULL, reserve_iarr, /* RESERVE(10) <no response function> */
767 {10, 0xff, 0xff, 0xff, 0, 0, 0, 0xff, 0xff, 0xc7, 0, 0, 0, 0, 0,
769 {ARRAY_SIZE(release_iarr), 0x57, 0, F_D_OUT,
770 NULL, release_iarr, /* RELEASE(10) <no response function> */
771 {10, 0x13, 0xff, 0xff, 0, 0, 0, 0xff, 0xff, 0xc7, 0, 0, 0, 0, 0,
774 {0, 0x1e, 0, 0, NULL, NULL, /* ALLOW REMOVAL */
775 {6, 0, 0, 0, 0x3, 0xc7, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0} },
776 {0, 0x1, 0, 0, resp_start_stop, NULL, /* REWIND ?? */
777 {6, 0x1, 0, 0, 0, 0xc7, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0} },
778 {0, 0, 0, F_INV_OP | FF_RESPOND, NULL, NULL, /* ATA_PT */
779 {0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0} },
780 {0, 0x1d, F_D_OUT, 0, NULL, NULL, /* SEND DIAGNOSTIC */
781 {6, 0xf7, 0, 0xff, 0xff, 0xc7, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0} },
782 {0, 0x42, 0, F_D_OUT | FF_MEDIA_IO, resp_unmap, NULL, /* UNMAP */
783 {10, 0x1, 0, 0, 0, 0, 0x3f, 0xff, 0xff, 0xc7, 0, 0, 0, 0, 0, 0} },
785 {0, 0x3b, 0, F_D_OUT_MAYBE, resp_write_buffer, NULL,
786 {10, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xc7, 0, 0,
787 0, 0, 0, 0} }, /* WRITE_BUFFER */
788 {ARRAY_SIZE(write_same_iarr), 0x41, 0, F_D_OUT_MAYBE | FF_MEDIA_IO,
789 resp_write_same_10, write_same_iarr, /* WRITE SAME(10) */
790 {10, 0xff, 0xff, 0xff, 0xff, 0xff, 0x3f, 0xff, 0xff, 0xc7, 0,
792 {ARRAY_SIZE(sync_cache_iarr), 0x35, 0, F_SYNC_DELAY | F_M_ACCESS,
793 resp_sync_cache, sync_cache_iarr,
794 {10, 0x7, 0xff, 0xff, 0xff, 0xff, 0x3f, 0xff, 0xff, 0xc7, 0, 0,
795 0, 0, 0, 0} }, /* SYNC_CACHE (10) */
796 {0, 0x89, 0, F_D_OUT | FF_MEDIA_IO, resp_comp_write, NULL,
797 {16, 0xf8, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0, 0,
798 0, 0xff, 0x3f, 0xc7} }, /* COMPARE AND WRITE */
799 {ARRAY_SIZE(pre_fetch_iarr), 0x34, 0, F_SYNC_DELAY | FF_MEDIA_IO,
800 resp_pre_fetch, pre_fetch_iarr,
801 {10, 0x2, 0xff, 0xff, 0xff, 0xff, 0x3f, 0xff, 0xff, 0xc7, 0, 0,
802 0, 0, 0, 0} }, /* PRE-FETCH (10) */
805 {ARRAY_SIZE(zone_out_iarr), 0x94, 0x3, F_SA_LOW | F_M_ACCESS,
806 resp_open_zone, zone_out_iarr, /* ZONE_OUT(16), OPEN ZONE) */
807 {16, 0x3 /* SA */, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
808 0xff, 0xff, 0x0, 0x0, 0xff, 0xff, 0x1, 0xc7} },
809 {ARRAY_SIZE(zone_in_iarr), 0x95, 0x0, F_SA_LOW | F_M_ACCESS,
810 resp_report_zones, zone_in_iarr, /* ZONE_IN(16), REPORT ZONES) */
811 {16, 0x0 /* SA */, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
812 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xbf, 0xc7} },
814 {0, 0x0, 0x0, F_D_OUT | FF_MEDIA_IO,
815 resp_atomic_write, NULL, /* ATOMIC WRITE 16 */
816 {16, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
817 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff} },
819 {0xff, 0, 0, 0, NULL, NULL, /* terminating element */
820 {0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0} },
823 static int sdebug_num_hosts;
824 static int sdebug_add_host = DEF_NUM_HOST; /* in sysfs this is relative */
825 static int sdebug_ato = DEF_ATO;
826 static int sdebug_cdb_len = DEF_CDB_LEN;
827 static int sdebug_jdelay = DEF_JDELAY; /* if > 0 then unit is jiffies */
828 static int sdebug_dev_size_mb = DEF_DEV_SIZE_PRE_INIT;
829 static int sdebug_dif = DEF_DIF;
830 static int sdebug_dix = DEF_DIX;
831 static int sdebug_dsense = DEF_D_SENSE;
832 static int sdebug_every_nth = DEF_EVERY_NTH;
833 static int sdebug_fake_rw = DEF_FAKE_RW;
834 static unsigned int sdebug_guard = DEF_GUARD;
835 static int sdebug_host_max_queue; /* per host */
836 static int sdebug_lowest_aligned = DEF_LOWEST_ALIGNED;
837 static int sdebug_max_luns = DEF_MAX_LUNS;
838 static int sdebug_max_queue = SDEBUG_CANQUEUE; /* per submit queue */
839 static unsigned int sdebug_medium_error_start = OPT_MEDIUM_ERR_ADDR;
840 static int sdebug_medium_error_count = OPT_MEDIUM_ERR_NUM;
841 static int sdebug_ndelay = DEF_NDELAY; /* if > 0 then unit is nanoseconds */
842 static int sdebug_no_lun_0 = DEF_NO_LUN_0;
843 static int sdebug_no_uld;
844 static int sdebug_num_parts = DEF_NUM_PARTS;
845 static int sdebug_num_tgts = DEF_NUM_TGTS; /* targets per host */
846 static int sdebug_opt_blks = DEF_OPT_BLKS;
847 static int sdebug_opts = DEF_OPTS;
848 static int sdebug_physblk_exp = DEF_PHYSBLK_EXP;
849 static int sdebug_opt_xferlen_exp = DEF_OPT_XFERLEN_EXP;
850 static int sdebug_ptype = DEF_PTYPE; /* SCSI peripheral device type */
851 static int sdebug_scsi_level = DEF_SCSI_LEVEL;
852 static int sdebug_sector_size = DEF_SECTOR_SIZE;
853 static int sdeb_tur_ms_to_ready = DEF_TUR_MS_TO_READY;
854 static int sdebug_virtual_gb = DEF_VIRTUAL_GB;
855 static int sdebug_vpd_use_hostno = DEF_VPD_USE_HOSTNO;
856 static unsigned int sdebug_lbpu = DEF_LBPU;
857 static unsigned int sdebug_lbpws = DEF_LBPWS;
858 static unsigned int sdebug_lbpws10 = DEF_LBPWS10;
859 static unsigned int sdebug_lbprz = DEF_LBPRZ;
860 static unsigned int sdebug_unmap_alignment = DEF_UNMAP_ALIGNMENT;
861 static unsigned int sdebug_unmap_granularity = DEF_UNMAP_GRANULARITY;
862 static unsigned int sdebug_unmap_max_blocks = DEF_UNMAP_MAX_BLOCKS;
863 static unsigned int sdebug_unmap_max_desc = DEF_UNMAP_MAX_DESC;
864 static unsigned int sdebug_write_same_length = DEF_WRITESAME_LENGTH;
865 static unsigned int sdebug_atomic_wr = DEF_ATOMIC_WR;
866 static unsigned int sdebug_atomic_wr_max_length = DEF_ATOMIC_WR_MAX_LENGTH;
867 static unsigned int sdebug_atomic_wr_align = DEF_ATOMIC_WR_ALIGN;
868 static unsigned int sdebug_atomic_wr_gran = DEF_ATOMIC_WR_GRAN;
869 static unsigned int sdebug_atomic_wr_max_length_bndry =
870 DEF_ATOMIC_WR_MAX_LENGTH_BNDRY;
871 static unsigned int sdebug_atomic_wr_max_bndry = DEF_ATOMIC_WR_MAX_BNDRY;
872 static int sdebug_uuid_ctl = DEF_UUID_CTL;
873 static bool sdebug_random = DEF_RANDOM;
874 static bool sdebug_per_host_store = DEF_PER_HOST_STORE;
875 static bool sdebug_removable = DEF_REMOVABLE;
876 static bool sdebug_clustering;
877 static bool sdebug_host_lock = DEF_HOST_LOCK;
878 static bool sdebug_strict = DEF_STRICT;
879 static bool sdebug_any_injecting_opt;
880 static bool sdebug_no_rwlock;
881 static bool sdebug_verbose;
882 static bool have_dif_prot;
883 static bool write_since_sync;
884 static bool sdebug_statistics = DEF_STATISTICS;
885 static bool sdebug_wp;
886 static bool sdebug_allow_restart;
891 } sdeb_zbc_model = BLK_ZONED_NONE;
892 static char *sdeb_zbc_model_s;
894 enum sam_lun_addr_method {SAM_LUN_AM_PERIPHERAL = 0x0,
895 SAM_LUN_AM_FLAT = 0x1,
896 SAM_LUN_AM_LOGICAL_UNIT = 0x2,
897 SAM_LUN_AM_EXTENDED = 0x3};
898 static enum sam_lun_addr_method sdebug_lun_am = SAM_LUN_AM_PERIPHERAL;
899 static int sdebug_lun_am_i = (int)SAM_LUN_AM_PERIPHERAL;
901 static unsigned int sdebug_store_sectors;
902 static sector_t sdebug_capacity; /* in sectors */
904 /* old BIOS stuff, kernel may get rid of them but some mode sense pages
905 may still need them */
906 static int sdebug_heads; /* heads per disk */
907 static int sdebug_cylinders_per; /* cylinders per surface */
908 static int sdebug_sectors_per; /* sectors per cylinder */
910 static LIST_HEAD(sdebug_host_list);
911 static DEFINE_MUTEX(sdebug_host_list_mutex);
913 static struct xarray per_store_arr;
914 static struct xarray *per_store_ap = &per_store_arr;
915 static int sdeb_first_idx = -1; /* invalid index ==> none created */
916 static int sdeb_most_recent_idx = -1;
917 static DEFINE_RWLOCK(sdeb_fake_rw_lck); /* need a RW lock when fake_rw=1 */
919 static unsigned long map_size;
920 static int num_aborts;
921 static int num_dev_resets;
922 static int num_target_resets;
923 static int num_bus_resets;
924 static int num_host_resets;
925 static int dix_writes;
926 static int dix_reads;
927 static int dif_errors;
929 /* ZBC global data */
930 static bool sdeb_zbc_in_use; /* true for host-aware and host-managed disks */
931 static int sdeb_zbc_zone_cap_mb;
932 static int sdeb_zbc_zone_size_mb;
933 static int sdeb_zbc_max_open = DEF_ZBC_MAX_OPEN_ZONES;
934 static int sdeb_zbc_nr_conv = DEF_ZBC_NR_CONV_ZONES;
936 static int submit_queues = DEF_SUBMIT_QUEUES; /* > 1 for multi-queue (mq) */
937 static int poll_queues; /* iouring iopoll interface.*/
939 static atomic_long_t writes_by_group_number[64];
941 static char sdebug_proc_name[] = MY_NAME;
942 static const char *my_name = MY_NAME;
944 static const struct bus_type pseudo_lld_bus;
946 static struct device_driver sdebug_driverfs_driver = {
947 .name = sdebug_proc_name,
948 .bus = &pseudo_lld_bus,
951 static const int check_condition_result =
952 SAM_STAT_CHECK_CONDITION;
954 static const int illegal_condition_result =
955 (DID_ABORT << 16) | SAM_STAT_CHECK_CONDITION;
957 static const int device_qfull_result =
958 (DID_ABORT << 16) | SAM_STAT_TASK_SET_FULL;
960 static const int condition_met_result = SAM_STAT_CONDITION_MET;
962 static struct dentry *sdebug_debugfs_root;
963 static ASYNC_DOMAIN_EXCLUSIVE(sdebug_async_domain);
965 static void sdebug_err_free(struct rcu_head *head)
967 struct sdebug_err_inject *inject =
968 container_of(head, typeof(*inject), rcu);
973 static void sdebug_err_add(struct scsi_device *sdev, struct sdebug_err_inject *new)
975 struct sdebug_dev_info *devip = (struct sdebug_dev_info *)sdev->hostdata;
976 struct sdebug_err_inject *err;
978 spin_lock(&devip->list_lock);
979 list_for_each_entry_rcu(err, &devip->inject_err_list, list) {
980 if (err->type == new->type && err->cmd == new->cmd) {
981 list_del_rcu(&err->list);
982 call_rcu(&err->rcu, sdebug_err_free);
986 list_add_tail_rcu(&new->list, &devip->inject_err_list);
987 spin_unlock(&devip->list_lock);
990 static int sdebug_err_remove(struct scsi_device *sdev, const char *buf, size_t count)
992 struct sdebug_dev_info *devip = (struct sdebug_dev_info *)sdev->hostdata;
993 struct sdebug_err_inject *err;
997 if (sscanf(buf, "- %d %hhx", &type, &cmd) != 2) {
1002 spin_lock(&devip->list_lock);
1003 list_for_each_entry_rcu(err, &devip->inject_err_list, list) {
1004 if (err->type == type && err->cmd == cmd) {
1005 list_del_rcu(&err->list);
1006 call_rcu(&err->rcu, sdebug_err_free);
1007 spin_unlock(&devip->list_lock);
1012 spin_unlock(&devip->list_lock);
1018 static int sdebug_error_show(struct seq_file *m, void *p)
1020 struct scsi_device *sdev = (struct scsi_device *)m->private;
1021 struct sdebug_dev_info *devip = (struct sdebug_dev_info *)sdev->hostdata;
1022 struct sdebug_err_inject *err;
1024 seq_puts(m, "Type\tCount\tCommand\n");
1027 list_for_each_entry_rcu(err, &devip->inject_err_list, list) {
1028 switch (err->type) {
1030 case ERR_ABORT_CMD_FAILED:
1031 case ERR_LUN_RESET_FAILED:
1032 seq_printf(m, "%d\t%d\t0x%x\n", err->type, err->cnt,
1036 case ERR_FAIL_QUEUE_CMD:
1037 seq_printf(m, "%d\t%d\t0x%x\t0x%x\n", err->type,
1038 err->cnt, err->cmd, err->queuecmd_ret);
1042 seq_printf(m, "%d\t%d\t0x%x\t0x%x 0x%x 0x%x 0x%x 0x%x 0x%x\n",
1043 err->type, err->cnt, err->cmd,
1044 err->host_byte, err->driver_byte,
1045 err->status_byte, err->sense_key,
1046 err->asc, err->asq);
1055 static int sdebug_error_open(struct inode *inode, struct file *file)
1057 return single_open(file, sdebug_error_show, inode->i_private);
1060 static ssize_t sdebug_error_write(struct file *file, const char __user *ubuf,
1061 size_t count, loff_t *ppos)
1064 unsigned int inject_type;
1065 struct sdebug_err_inject *inject;
1066 struct scsi_device *sdev = (struct scsi_device *)file->f_inode->i_private;
1068 buf = kzalloc(count + 1, GFP_KERNEL);
1072 if (copy_from_user(buf, ubuf, count)) {
1078 return sdebug_err_remove(sdev, buf, count);
1080 if (sscanf(buf, "%d", &inject_type) != 1) {
1085 inject = kzalloc(sizeof(struct sdebug_err_inject), GFP_KERNEL);
1091 switch (inject_type) {
1093 case ERR_ABORT_CMD_FAILED:
1094 case ERR_LUN_RESET_FAILED:
1095 if (sscanf(buf, "%d %d %hhx", &inject->type, &inject->cnt,
1100 case ERR_FAIL_QUEUE_CMD:
1101 if (sscanf(buf, "%d %d %hhx %x", &inject->type, &inject->cnt,
1102 &inject->cmd, &inject->queuecmd_ret) != 4)
1107 if (sscanf(buf, "%d %d %hhx %hhx %hhx %hhx %hhx %hhx %hhx",
1108 &inject->type, &inject->cnt, &inject->cmd,
1109 &inject->host_byte, &inject->driver_byte,
1110 &inject->status_byte, &inject->sense_key,
1111 &inject->asc, &inject->asq) != 9)
1121 sdebug_err_add(sdev, inject);
1131 static const struct file_operations sdebug_error_fops = {
1132 .open = sdebug_error_open,
1134 .write = sdebug_error_write,
1135 .release = single_release,
1138 static int sdebug_target_reset_fail_show(struct seq_file *m, void *p)
1140 struct scsi_target *starget = (struct scsi_target *)m->private;
1141 struct sdebug_target_info *targetip =
1142 (struct sdebug_target_info *)starget->hostdata;
1145 seq_printf(m, "%c\n", targetip->reset_fail ? 'Y' : 'N');
1150 static int sdebug_target_reset_fail_open(struct inode *inode, struct file *file)
1152 return single_open(file, sdebug_target_reset_fail_show, inode->i_private);
1155 static ssize_t sdebug_target_reset_fail_write(struct file *file,
1156 const char __user *ubuf, size_t count, loff_t *ppos)
1159 struct scsi_target *starget =
1160 (struct scsi_target *)file->f_inode->i_private;
1161 struct sdebug_target_info *targetip =
1162 (struct sdebug_target_info *)starget->hostdata;
1165 ret = kstrtobool_from_user(ubuf, count, &targetip->reset_fail);
1166 return ret < 0 ? ret : count;
1171 static const struct file_operations sdebug_target_reset_fail_fops = {
1172 .open = sdebug_target_reset_fail_open,
1174 .write = sdebug_target_reset_fail_write,
1175 .release = single_release,
1178 static int sdebug_target_alloc(struct scsi_target *starget)
1180 struct sdebug_target_info *targetip;
1182 targetip = kzalloc(sizeof(struct sdebug_target_info), GFP_KERNEL);
1186 async_synchronize_full_domain(&sdebug_async_domain);
1188 targetip->debugfs_entry = debugfs_create_dir(dev_name(&starget->dev),
1189 sdebug_debugfs_root);
1191 debugfs_create_file("fail_reset", 0600, targetip->debugfs_entry, starget,
1192 &sdebug_target_reset_fail_fops);
1194 starget->hostdata = targetip;
1199 static void sdebug_tartget_cleanup_async(void *data, async_cookie_t cookie)
1201 struct sdebug_target_info *targetip = data;
1203 debugfs_remove(targetip->debugfs_entry);
1207 static void sdebug_target_destroy(struct scsi_target *starget)
1209 struct sdebug_target_info *targetip;
1211 targetip = (struct sdebug_target_info *)starget->hostdata;
1213 starget->hostdata = NULL;
1214 async_schedule_domain(sdebug_tartget_cleanup_async, targetip,
1215 &sdebug_async_domain);
1219 /* Only do the extra work involved in logical block provisioning if one or
1220 * more of the lbpu, lbpws or lbpws10 parameters are given and we are doing
1221 * real reads and writes (i.e. not skipping them for speed).
1223 static inline bool scsi_debug_lbp(void)
1225 return 0 == sdebug_fake_rw &&
1226 (sdebug_lbpu || sdebug_lbpws || sdebug_lbpws10);
1229 static inline bool scsi_debug_atomic_write(void)
1231 return sdebug_fake_rw == 0 && sdebug_atomic_wr;
1234 static void *lba2fake_store(struct sdeb_store_info *sip,
1235 unsigned long long lba)
1237 struct sdeb_store_info *lsip = sip;
1239 lba = do_div(lba, sdebug_store_sectors);
1240 if (!sip || !sip->storep) {
1242 lsip = xa_load(per_store_ap, 0); /* should never be NULL */
1244 return lsip->storep + lba * sdebug_sector_size;
1247 static struct t10_pi_tuple *dif_store(struct sdeb_store_info *sip,
1250 sector = sector_div(sector, sdebug_store_sectors);
1252 return sip->dif_storep + sector;
1255 static void sdebug_max_tgts_luns(void)
1257 struct sdebug_host_info *sdbg_host;
1258 struct Scsi_Host *hpnt;
1260 mutex_lock(&sdebug_host_list_mutex);
1261 list_for_each_entry(sdbg_host, &sdebug_host_list, host_list) {
1262 hpnt = sdbg_host->shost;
1263 if ((hpnt->this_id >= 0) &&
1264 (sdebug_num_tgts > hpnt->this_id))
1265 hpnt->max_id = sdebug_num_tgts + 1;
1267 hpnt->max_id = sdebug_num_tgts;
1268 /* sdebug_max_luns; */
1269 hpnt->max_lun = SCSI_W_LUN_REPORT_LUNS + 1;
1271 mutex_unlock(&sdebug_host_list_mutex);
1274 enum sdeb_cmd_data {SDEB_IN_DATA = 0, SDEB_IN_CDB = 1};
1276 /* Set in_bit to -1 to indicate no bit position of invalid field */
1277 static void mk_sense_invalid_fld(struct scsi_cmnd *scp,
1278 enum sdeb_cmd_data c_d,
1279 int in_byte, int in_bit)
1281 unsigned char *sbuff;
1285 sbuff = scp->sense_buffer;
1287 sdev_printk(KERN_ERR, scp->device,
1288 "%s: sense_buffer is NULL\n", __func__);
1291 asc = c_d ? INVALID_FIELD_IN_CDB : INVALID_FIELD_IN_PARAM_LIST;
1292 memset(sbuff, 0, SCSI_SENSE_BUFFERSIZE);
1293 scsi_build_sense(scp, sdebug_dsense, ILLEGAL_REQUEST, asc, 0);
1294 memset(sks, 0, sizeof(sks));
1300 sks[0] |= 0x7 & in_bit;
1302 put_unaligned_be16(in_byte, sks + 1);
1303 if (sdebug_dsense) {
1307 sbuff[sl + 1] = 0x6;
1308 memcpy(sbuff + sl + 4, sks, 3);
1310 memcpy(sbuff + 15, sks, 3);
1312 sdev_printk(KERN_INFO, scp->device, "%s: [sense_key,asc,ascq"
1313 "]: [0x5,0x%x,0x0] %c byte=%d, bit=%d\n",
1314 my_name, asc, c_d ? 'C' : 'D', in_byte, in_bit);
1317 static void mk_sense_buffer(struct scsi_cmnd *scp, int key, int asc, int asq)
1319 if (!scp->sense_buffer) {
1320 sdev_printk(KERN_ERR, scp->device,
1321 "%s: sense_buffer is NULL\n", __func__);
1324 memset(scp->sense_buffer, 0, SCSI_SENSE_BUFFERSIZE);
1326 scsi_build_sense(scp, sdebug_dsense, key, asc, asq);
1329 sdev_printk(KERN_INFO, scp->device,
1330 "%s: [sense_key,asc,ascq]: [0x%x,0x%x,0x%x]\n",
1331 my_name, key, asc, asq);
1334 static void mk_sense_invalid_opcode(struct scsi_cmnd *scp)
1336 mk_sense_buffer(scp, ILLEGAL_REQUEST, INVALID_OPCODE, 0);
1339 static int scsi_debug_ioctl(struct scsi_device *dev, unsigned int cmd,
1342 if (sdebug_verbose) {
1344 sdev_printk(KERN_INFO, dev,
1345 "%s: BLKFLSBUF [0x1261]\n", __func__);
1346 else if (0x5331 == cmd)
1347 sdev_printk(KERN_INFO, dev,
1348 "%s: CDROM_GET_CAPABILITY [0x5331]\n",
1351 sdev_printk(KERN_INFO, dev, "%s: cmd=0x%x\n",
1355 /* return -ENOTTY; // correct return but upsets fdisk */
1358 static void config_cdb_len(struct scsi_device *sdev)
1360 switch (sdebug_cdb_len) {
1361 case 6: /* suggest 6 byte READ, WRITE and MODE SENSE/SELECT */
1362 sdev->use_10_for_rw = false;
1363 sdev->use_16_for_rw = false;
1364 sdev->use_10_for_ms = false;
1366 case 10: /* suggest 10 byte RWs and 6 byte MODE SENSE/SELECT */
1367 sdev->use_10_for_rw = true;
1368 sdev->use_16_for_rw = false;
1369 sdev->use_10_for_ms = false;
1371 case 12: /* suggest 10 byte RWs and 10 byte MODE SENSE/SELECT */
1372 sdev->use_10_for_rw = true;
1373 sdev->use_16_for_rw = false;
1374 sdev->use_10_for_ms = true;
1377 sdev->use_10_for_rw = false;
1378 sdev->use_16_for_rw = true;
1379 sdev->use_10_for_ms = true;
1381 case 32: /* No knobs to suggest this so same as 16 for now */
1382 sdev->use_10_for_rw = false;
1383 sdev->use_16_for_rw = true;
1384 sdev->use_10_for_ms = true;
1387 pr_warn("unexpected cdb_len=%d, force to 10\n",
1389 sdev->use_10_for_rw = true;
1390 sdev->use_16_for_rw = false;
1391 sdev->use_10_for_ms = false;
1392 sdebug_cdb_len = 10;
1397 static void all_config_cdb_len(void)
1399 struct sdebug_host_info *sdbg_host;
1400 struct Scsi_Host *shost;
1401 struct scsi_device *sdev;
1403 mutex_lock(&sdebug_host_list_mutex);
1404 list_for_each_entry(sdbg_host, &sdebug_host_list, host_list) {
1405 shost = sdbg_host->shost;
1406 shost_for_each_device(sdev, shost) {
1407 config_cdb_len(sdev);
1410 mutex_unlock(&sdebug_host_list_mutex);
1413 static void clear_luns_changed_on_target(struct sdebug_dev_info *devip)
1415 struct sdebug_host_info *sdhp = devip->sdbg_host;
1416 struct sdebug_dev_info *dp;
1418 list_for_each_entry(dp, &sdhp->dev_info_list, dev_list) {
1419 if ((devip->sdbg_host == dp->sdbg_host) &&
1420 (devip->target == dp->target)) {
1421 clear_bit(SDEBUG_UA_LUNS_CHANGED, dp->uas_bm);
1426 static int make_ua(struct scsi_cmnd *scp, struct sdebug_dev_info *devip)
1430 k = find_first_bit(devip->uas_bm, SDEBUG_NUM_UAS);
1431 if (k != SDEBUG_NUM_UAS) {
1432 const char *cp = NULL;
1436 mk_sense_buffer(scp, UNIT_ATTENTION, UA_RESET_ASC,
1437 POWER_ON_RESET_ASCQ);
1439 cp = "power on reset";
1441 case SDEBUG_UA_POOCCUR:
1442 mk_sense_buffer(scp, UNIT_ATTENTION, UA_RESET_ASC,
1443 POWER_ON_OCCURRED_ASCQ);
1445 cp = "power on occurred";
1447 case SDEBUG_UA_BUS_RESET:
1448 mk_sense_buffer(scp, UNIT_ATTENTION, UA_RESET_ASC,
1453 case SDEBUG_UA_MODE_CHANGED:
1454 mk_sense_buffer(scp, UNIT_ATTENTION, UA_CHANGED_ASC,
1457 cp = "mode parameters changed";
1459 case SDEBUG_UA_CAPACITY_CHANGED:
1460 mk_sense_buffer(scp, UNIT_ATTENTION, UA_CHANGED_ASC,
1461 CAPACITY_CHANGED_ASCQ);
1463 cp = "capacity data changed";
1465 case SDEBUG_UA_MICROCODE_CHANGED:
1466 mk_sense_buffer(scp, UNIT_ATTENTION,
1468 MICROCODE_CHANGED_ASCQ);
1470 cp = "microcode has been changed";
1472 case SDEBUG_UA_MICROCODE_CHANGED_WO_RESET:
1473 mk_sense_buffer(scp, UNIT_ATTENTION,
1475 MICROCODE_CHANGED_WO_RESET_ASCQ);
1477 cp = "microcode has been changed without reset";
1479 case SDEBUG_UA_LUNS_CHANGED:
1481 * SPC-3 behavior is to report a UNIT ATTENTION with
1482 * ASC/ASCQ REPORTED LUNS DATA HAS CHANGED on every LUN
1483 * on the target, until a REPORT LUNS command is
1484 * received. SPC-4 behavior is to report it only once.
1485 * NOTE: sdebug_scsi_level does not use the same
1486 * values as struct scsi_device->scsi_level.
1488 if (sdebug_scsi_level >= 6) /* SPC-4 and above */
1489 clear_luns_changed_on_target(devip);
1490 mk_sense_buffer(scp, UNIT_ATTENTION,
1494 cp = "reported luns data has changed";
1497 pr_warn("unexpected unit attention code=%d\n", k);
1502 clear_bit(k, devip->uas_bm);
1504 sdev_printk(KERN_INFO, scp->device,
1505 "%s reports: Unit attention: %s\n",
1507 return check_condition_result;
1512 /* Build SCSI "data-in" buffer. Returns 0 if ok else (DID_ERROR << 16). */
1513 static int fill_from_dev_buffer(struct scsi_cmnd *scp, unsigned char *arr,
1517 struct scsi_data_buffer *sdb = &scp->sdb;
1521 if (scp->sc_data_direction != DMA_FROM_DEVICE)
1522 return DID_ERROR << 16;
1524 act_len = sg_copy_from_buffer(sdb->table.sgl, sdb->table.nents,
1526 scsi_set_resid(scp, scsi_bufflen(scp) - act_len);
1531 /* Partial build of SCSI "data-in" buffer. Returns 0 if ok else
1532 * (DID_ERROR << 16). Can write to offset in data-in buffer. If multiple
1533 * calls, not required to write in ascending offset order. Assumes resid
1534 * set to scsi_bufflen() prior to any calls.
1536 static int p_fill_from_dev_buffer(struct scsi_cmnd *scp, const void *arr,
1537 int arr_len, unsigned int off_dst)
1539 unsigned int act_len, n;
1540 struct scsi_data_buffer *sdb = &scp->sdb;
1541 off_t skip = off_dst;
1543 if (sdb->length <= off_dst)
1545 if (scp->sc_data_direction != DMA_FROM_DEVICE)
1546 return DID_ERROR << 16;
1548 act_len = sg_pcopy_from_buffer(sdb->table.sgl, sdb->table.nents,
1549 arr, arr_len, skip);
1550 pr_debug("%s: off_dst=%u, scsi_bufflen=%u, act_len=%u, resid=%d\n",
1551 __func__, off_dst, scsi_bufflen(scp), act_len,
1552 scsi_get_resid(scp));
1553 n = scsi_bufflen(scp) - (off_dst + act_len);
1554 scsi_set_resid(scp, min_t(u32, scsi_get_resid(scp), n));
1558 /* Fetches from SCSI "data-out" buffer. Returns number of bytes fetched into
1559 * 'arr' or -1 if error.
1561 static int fetch_to_dev_buffer(struct scsi_cmnd *scp, unsigned char *arr,
1564 if (!scsi_bufflen(scp))
1566 if (scp->sc_data_direction != DMA_TO_DEVICE)
1569 return scsi_sg_copy_to_buffer(scp, arr, arr_len);
1573 static char sdebug_inq_vendor_id[9] = "Linux ";
1574 static char sdebug_inq_product_id[17] = "scsi_debug ";
1575 static char sdebug_inq_product_rev[5] = SDEBUG_VERSION;
1576 /* Use some locally assigned NAAs for SAS addresses. */
1577 static const u64 naa3_comp_a = 0x3222222000000000ULL;
1578 static const u64 naa3_comp_b = 0x3333333000000000ULL;
1579 static const u64 naa3_comp_c = 0x3111111000000000ULL;
1581 /* Device identification VPD page. Returns number of bytes placed in arr */
1582 static int inquiry_vpd_83(unsigned char *arr, int port_group_id,
1583 int target_dev_id, int dev_id_num,
1584 const char *dev_id_str, int dev_id_str_len,
1585 const uuid_t *lu_name)
1590 port_a = target_dev_id + 1;
1591 /* T10 vendor identifier field format (faked) */
1592 arr[0] = 0x2; /* ASCII */
1595 memcpy(&arr[4], sdebug_inq_vendor_id, 8);
1596 memcpy(&arr[12], sdebug_inq_product_id, 16);
1597 memcpy(&arr[28], dev_id_str, dev_id_str_len);
1598 num = 8 + 16 + dev_id_str_len;
1601 if (dev_id_num >= 0) {
1602 if (sdebug_uuid_ctl) {
1603 /* Locally assigned UUID */
1604 arr[num++] = 0x1; /* binary (not necessarily sas) */
1605 arr[num++] = 0xa; /* PIV=0, lu, naa */
1608 arr[num++] = 0x10; /* uuid type=1, locally assigned */
1610 memcpy(arr + num, lu_name, 16);
1613 /* NAA-3, Logical unit identifier (binary) */
1614 arr[num++] = 0x1; /* binary (not necessarily sas) */
1615 arr[num++] = 0x3; /* PIV=0, lu, naa */
1618 put_unaligned_be64(naa3_comp_b + dev_id_num, arr + num);
1621 /* Target relative port number */
1622 arr[num++] = 0x61; /* proto=sas, binary */
1623 arr[num++] = 0x94; /* PIV=1, target port, rel port */
1624 arr[num++] = 0x0; /* reserved */
1625 arr[num++] = 0x4; /* length */
1626 arr[num++] = 0x0; /* reserved */
1627 arr[num++] = 0x0; /* reserved */
1629 arr[num++] = 0x1; /* relative port A */
1631 /* NAA-3, Target port identifier */
1632 arr[num++] = 0x61; /* proto=sas, binary */
1633 arr[num++] = 0x93; /* piv=1, target port, naa */
1636 put_unaligned_be64(naa3_comp_a + port_a, arr + num);
1638 /* NAA-3, Target port group identifier */
1639 arr[num++] = 0x61; /* proto=sas, binary */
1640 arr[num++] = 0x95; /* piv=1, target port group id */
1645 put_unaligned_be16(port_group_id, arr + num);
1647 /* NAA-3, Target device identifier */
1648 arr[num++] = 0x61; /* proto=sas, binary */
1649 arr[num++] = 0xa3; /* piv=1, target device, naa */
1652 put_unaligned_be64(naa3_comp_a + target_dev_id, arr + num);
1654 /* SCSI name string: Target device identifier */
1655 arr[num++] = 0x63; /* proto=sas, UTF-8 */
1656 arr[num++] = 0xa8; /* piv=1, target device, SCSI name string */
1659 memcpy(arr + num, "naa.32222220", 12);
1661 snprintf(b, sizeof(b), "%08X", target_dev_id);
1662 memcpy(arr + num, b, 8);
1664 memset(arr + num, 0, 4);
1669 static unsigned char vpd84_data[] = {
1670 /* from 4th byte */ 0x22,0x22,0x22,0x0,0xbb,0x0,
1671 0x22,0x22,0x22,0x0,0xbb,0x1,
1672 0x22,0x22,0x22,0x0,0xbb,0x2,
1675 /* Software interface identification VPD page */
1676 static int inquiry_vpd_84(unsigned char *arr)
1678 memcpy(arr, vpd84_data, sizeof(vpd84_data));
1679 return sizeof(vpd84_data);
1682 /* Management network addresses VPD page */
1683 static int inquiry_vpd_85(unsigned char *arr)
1686 const char *na1 = "https://www.kernel.org/config";
1687 const char *na2 = "http://www.kernel.org/log";
1690 arr[num++] = 0x1; /* lu, storage config */
1691 arr[num++] = 0x0; /* reserved */
1696 plen = ((plen / 4) + 1) * 4;
1697 arr[num++] = plen; /* length, null termianted, padded */
1698 memcpy(arr + num, na1, olen);
1699 memset(arr + num + olen, 0, plen - olen);
1702 arr[num++] = 0x4; /* lu, logging */
1703 arr[num++] = 0x0; /* reserved */
1708 plen = ((plen / 4) + 1) * 4;
1709 arr[num++] = plen; /* length, null terminated, padded */
1710 memcpy(arr + num, na2, olen);
1711 memset(arr + num + olen, 0, plen - olen);
1717 /* SCSI ports VPD page */
1718 static int inquiry_vpd_88(unsigned char *arr, int target_dev_id)
1723 port_a = target_dev_id + 1;
1724 port_b = port_a + 1;
1725 arr[num++] = 0x0; /* reserved */
1726 arr[num++] = 0x0; /* reserved */
1728 arr[num++] = 0x1; /* relative port 1 (primary) */
1729 memset(arr + num, 0, 6);
1732 arr[num++] = 12; /* length tp descriptor */
1733 /* naa-5 target port identifier (A) */
1734 arr[num++] = 0x61; /* proto=sas, binary */
1735 arr[num++] = 0x93; /* PIV=1, target port, NAA */
1736 arr[num++] = 0x0; /* reserved */
1737 arr[num++] = 0x8; /* length */
1738 put_unaligned_be64(naa3_comp_a + port_a, arr + num);
1740 arr[num++] = 0x0; /* reserved */
1741 arr[num++] = 0x0; /* reserved */
1743 arr[num++] = 0x2; /* relative port 2 (secondary) */
1744 memset(arr + num, 0, 6);
1747 arr[num++] = 12; /* length tp descriptor */
1748 /* naa-5 target port identifier (B) */
1749 arr[num++] = 0x61; /* proto=sas, binary */
1750 arr[num++] = 0x93; /* PIV=1, target port, NAA */
1751 arr[num++] = 0x0; /* reserved */
1752 arr[num++] = 0x8; /* length */
1753 put_unaligned_be64(naa3_comp_a + port_b, arr + num);
1760 static unsigned char vpd89_data[] = {
1761 /* from 4th byte */ 0,0,0,0,
1762 'l','i','n','u','x',' ',' ',' ',
1763 'S','A','T',' ','s','c','s','i','_','d','e','b','u','g',' ',' ',
1765 0x34,0,0,0,1,0,0,0,0,0,0,0,1,0,0,0,0,0,0,0,
1767 0x5a,0xc,0xff,0x3f,0x37,0xc8,0x10,0,0,0,0,0,0x3f,0,0,0,
1768 0,0,0,0,0x58,0x58,0x58,0x58,0x58,0x58,0x58,0x58,0x20,0x20,0x20,0x20,
1769 0x20,0x20,0x20,0x20,0x20,0x20,0x20,0x20,0,0,0,0x40,0x4,0,0x2e,0x33,
1770 0x38,0x31,0x20,0x20,0x20,0x20,0x54,0x53,0x38,0x33,0x30,0x30,0x33,0x31,
1772 0x20,0x20,0x20,0x20,0x20,0x20,0x20,0x20,0x20,0x20,0x20,0x20,0x20,0x20,
1774 0x20,0x20,0x20,0x20,0x20,0x20,0x20,0x20,0x20,0x20,0x20,0x20,0x20,0x20,
1776 0,0,0,0x2f,0,0,0,0x2,0,0x2,0x7,0,0xff,0xff,0x1,0,
1777 0x3f,0,0xc1,0xff,0x3e,0,0x10,0x1,0xb0,0xf8,0x50,0x9,0,0,0x7,0,
1778 0x3,0,0x78,0,0x78,0,0xf0,0,0x78,0,0,0,0,0,0,0,
1779 0,0,0,0,0,0,0,0,0x2,0,0,0,0,0,0,0,
1780 0x7e,0,0x1b,0,0x6b,0x34,0x1,0x7d,0x3,0x40,0x69,0x34,0x1,0x3c,0x3,0x40,
1781 0x7f,0x40,0,0,0,0,0xfe,0xfe,0,0,0,0,0,0xfe,0,0,
1782 0,0,0,0,0,0,0,0,0xb0,0xf8,0x50,0x9,0,0,0,0,
1783 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
1784 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
1785 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
1786 0x1,0,0xb0,0xf8,0x50,0x9,0xb0,0xf8,0x50,0x9,0x20,0x20,0x2,0,0xb6,0x42,
1787 0,0x80,0x8a,0,0x6,0x3c,0xa,0x3c,0xff,0xff,0xc6,0x7,0,0x1,0,0x8,
1788 0xf0,0xf,0,0x10,0x2,0,0x30,0,0,0,0,0,0,0,0x6,0xfe,
1789 0,0,0x2,0,0x50,0,0x8a,0,0x4f,0x95,0,0,0x21,0,0xb,0,
1790 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
1791 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
1792 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
1793 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
1794 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
1795 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
1796 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
1797 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
1798 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
1799 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
1800 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
1801 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0xa5,0x51,
1804 /* ATA Information VPD page */
1805 static int inquiry_vpd_89(unsigned char *arr)
1807 memcpy(arr, vpd89_data, sizeof(vpd89_data));
1808 return sizeof(vpd89_data);
1812 static unsigned char vpdb0_data[] = {
1813 /* from 4th byte */ 0,0,0,4, 0,0,0x4,0, 0,0,0,64,
1814 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
1815 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
1816 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
1819 /* Block limits VPD page (SBC-3) */
1820 static int inquiry_vpd_b0(unsigned char *arr)
1824 memcpy(arr, vpdb0_data, sizeof(vpdb0_data));
1826 /* Optimal transfer length granularity */
1827 if (sdebug_opt_xferlen_exp != 0 &&
1828 sdebug_physblk_exp < sdebug_opt_xferlen_exp)
1829 gran = 1 << sdebug_opt_xferlen_exp;
1831 gran = 1 << sdebug_physblk_exp;
1832 put_unaligned_be16(gran, arr + 2);
1834 /* Maximum Transfer Length */
1835 if (sdebug_store_sectors > 0x400)
1836 put_unaligned_be32(sdebug_store_sectors, arr + 4);
1838 /* Optimal Transfer Length */
1839 put_unaligned_be32(sdebug_opt_blks, &arr[8]);
1842 /* Maximum Unmap LBA Count */
1843 put_unaligned_be32(sdebug_unmap_max_blocks, &arr[16]);
1845 /* Maximum Unmap Block Descriptor Count */
1846 put_unaligned_be32(sdebug_unmap_max_desc, &arr[20]);
1849 /* Unmap Granularity Alignment */
1850 if (sdebug_unmap_alignment) {
1851 put_unaligned_be32(sdebug_unmap_alignment, &arr[28]);
1852 arr[28] |= 0x80; /* UGAVALID */
1855 /* Optimal Unmap Granularity */
1856 put_unaligned_be32(sdebug_unmap_granularity, &arr[24]);
1858 /* Maximum WRITE SAME Length */
1859 put_unaligned_be64(sdebug_write_same_length, &arr[32]);
1861 if (sdebug_atomic_wr) {
1862 put_unaligned_be32(sdebug_atomic_wr_max_length, &arr[40]);
1863 put_unaligned_be32(sdebug_atomic_wr_align, &arr[44]);
1864 put_unaligned_be32(sdebug_atomic_wr_gran, &arr[48]);
1865 put_unaligned_be32(sdebug_atomic_wr_max_length_bndry, &arr[52]);
1866 put_unaligned_be32(sdebug_atomic_wr_max_bndry, &arr[56]);
1869 return 0x3c; /* Mandatory page length for Logical Block Provisioning */
1872 /* Block device characteristics VPD page (SBC-3) */
1873 static int inquiry_vpd_b1(struct sdebug_dev_info *devip, unsigned char *arr)
1875 memset(arr, 0, 0x3c);
1877 arr[1] = 1; /* non rotating medium (e.g. solid state) */
1879 arr[3] = 5; /* less than 1.8" */
1884 /* Logical block provisioning VPD page (SBC-4) */
1885 static int inquiry_vpd_b2(unsigned char *arr)
1887 memset(arr, 0, 0x4);
1888 arr[0] = 0; /* threshold exponent */
1895 if (sdebug_lbprz && scsi_debug_lbp())
1896 arr[1] |= (sdebug_lbprz & 0x7) << 2; /* sbc4r07 and later */
1897 /* anc_sup=0; dp=0 (no provisioning group descriptor) */
1898 /* minimum_percentage=0; provisioning_type=0 (unknown) */
1899 /* threshold_percentage=0 */
1903 /* Zoned block device characteristics VPD page (ZBC mandatory) */
1904 static int inquiry_vpd_b6(struct sdebug_dev_info *devip, unsigned char *arr)
1906 memset(arr, 0, 0x3c);
1907 arr[0] = 0x1; /* set URSWRZ (unrestricted read in seq. wr req zone) */
1909 * Set Optimal number of open sequential write preferred zones and
1910 * Optimal number of non-sequentially written sequential write
1911 * preferred zones fields to 'not reported' (0xffffffff). Leave other
1912 * fields set to zero, apart from Max. number of open swrz_s field.
1914 put_unaligned_be32(0xffffffff, &arr[4]);
1915 put_unaligned_be32(0xffffffff, &arr[8]);
1916 if (sdeb_zbc_model == BLK_ZONED_HM && devip->max_open)
1917 put_unaligned_be32(devip->max_open, &arr[12]);
1919 put_unaligned_be32(0xffffffff, &arr[12]);
1920 if (devip->zcap < devip->zsize) {
1921 arr[19] = ZBC_CONSTANT_ZONE_START_OFFSET;
1922 put_unaligned_be64(devip->zsize, &arr[20]);
1929 #define SDEBUG_BLE_LEN_AFTER_B4 28 /* thus vpage 32 bytes long */
1931 enum { MAXIMUM_NUMBER_OF_STREAMS = 6, PERMANENT_STREAM_COUNT = 5 };
1933 /* Block limits extension VPD page (SBC-4) */
1934 static int inquiry_vpd_b7(unsigned char *arrb4)
1936 memset(arrb4, 0, SDEBUG_BLE_LEN_AFTER_B4);
1937 arrb4[1] = 1; /* Reduced stream control support (RSCS) */
1938 put_unaligned_be16(MAXIMUM_NUMBER_OF_STREAMS, &arrb4[2]);
1939 return SDEBUG_BLE_LEN_AFTER_B4;
1942 #define SDEBUG_LONG_INQ_SZ 96
1943 #define SDEBUG_MAX_INQ_ARR_SZ 584
1945 static int resp_inquiry(struct scsi_cmnd *scp, struct sdebug_dev_info *devip)
1947 unsigned char pq_pdt;
1949 unsigned char *cmd = scp->cmnd;
1952 bool have_wlun, is_disk, is_zbc, is_disk_zbc;
1954 alloc_len = get_unaligned_be16(cmd + 3);
1955 arr = kzalloc(SDEBUG_MAX_INQ_ARR_SZ, GFP_ATOMIC);
1957 return DID_REQUEUE << 16;
1958 is_disk = (sdebug_ptype == TYPE_DISK);
1959 is_zbc = devip->zoned;
1960 is_disk_zbc = (is_disk || is_zbc);
1961 have_wlun = scsi_is_wlun(scp->device->lun);
1963 pq_pdt = TYPE_WLUN; /* present, wlun */
1964 else if (sdebug_no_lun_0 && (devip->lun == SDEBUG_LUN_0_VAL))
1965 pq_pdt = 0x7f; /* not present, PQ=3, PDT=0x1f */
1967 pq_pdt = (sdebug_ptype & 0x1f);
1969 if (0x2 & cmd[1]) { /* CMDDT bit set */
1970 mk_sense_invalid_fld(scp, SDEB_IN_CDB, 1, 1);
1972 return check_condition_result;
1973 } else if (0x1 & cmd[1]) { /* EVPD bit set */
1974 int lu_id_num, port_group_id, target_dev_id;
1977 int host_no = devip->sdbg_host->shost->host_no;
1980 port_group_id = (((host_no + 1) & 0x7f) << 8) +
1981 (devip->channel & 0x7f);
1982 if (sdebug_vpd_use_hostno == 0)
1984 lu_id_num = have_wlun ? -1 : (((host_no + 1) * 2000) +
1985 (devip->target * 1000) + devip->lun);
1986 target_dev_id = ((host_no + 1) * 2000) +
1987 (devip->target * 1000) - 3;
1988 len = scnprintf(lu_id_str, 6, "%d", lu_id_num);
1989 if (0 == cmd[2]) { /* supported vital product data pages */
1991 arr[n++] = 0x0; /* this page */
1992 arr[n++] = 0x80; /* unit serial number */
1993 arr[n++] = 0x83; /* device identification */
1994 arr[n++] = 0x84; /* software interface ident. */
1995 arr[n++] = 0x85; /* management network addresses */
1996 arr[n++] = 0x86; /* extended inquiry */
1997 arr[n++] = 0x87; /* mode page policy */
1998 arr[n++] = 0x88; /* SCSI ports */
1999 if (is_disk_zbc) { /* SBC or ZBC */
2000 arr[n++] = 0x89; /* ATA information */
2001 arr[n++] = 0xb0; /* Block limits */
2002 arr[n++] = 0xb1; /* Block characteristics */
2004 arr[n++] = 0xb2; /* LB Provisioning */
2006 arr[n++] = 0xb6; /* ZB dev. char. */
2007 arr[n++] = 0xb7; /* Block limits extension */
2009 arr[3] = n - 4; /* number of supported VPD pages */
2010 } else if (0x80 == cmd[2]) { /* unit serial number */
2012 memcpy(&arr[4], lu_id_str, len);
2013 } else if (0x83 == cmd[2]) { /* device identification */
2014 arr[3] = inquiry_vpd_83(&arr[4], port_group_id,
2015 target_dev_id, lu_id_num,
2018 } else if (0x84 == cmd[2]) { /* Software interface ident. */
2019 arr[3] = inquiry_vpd_84(&arr[4]);
2020 } else if (0x85 == cmd[2]) { /* Management network addresses */
2021 arr[3] = inquiry_vpd_85(&arr[4]);
2022 } else if (0x86 == cmd[2]) { /* extended inquiry */
2023 arr[3] = 0x3c; /* number of following entries */
2024 if (sdebug_dif == T10_PI_TYPE3_PROTECTION)
2025 arr[4] = 0x4; /* SPT: GRD_CHK:1 */
2026 else if (have_dif_prot)
2027 arr[4] = 0x5; /* SPT: GRD_CHK:1, REF_CHK:1 */
2029 arr[4] = 0x0; /* no protection stuff */
2031 * GROUP_SUP=1; HEADSUP=1 (HEAD OF QUEUE); ORDSUP=1
2032 * (ORDERED queuing); SIMPSUP=1 (SIMPLE queuing).
2035 } else if (0x87 == cmd[2]) { /* mode page policy */
2036 arr[3] = 0x8; /* number of following entries */
2037 arr[4] = 0x2; /* disconnect-reconnect mp */
2038 arr[6] = 0x80; /* mlus, shared */
2039 arr[8] = 0x18; /* protocol specific lu */
2040 arr[10] = 0x82; /* mlus, per initiator port */
2041 } else if (0x88 == cmd[2]) { /* SCSI Ports */
2042 arr[3] = inquiry_vpd_88(&arr[4], target_dev_id);
2043 } else if (is_disk_zbc && 0x89 == cmd[2]) { /* ATA info */
2044 n = inquiry_vpd_89(&arr[4]);
2045 put_unaligned_be16(n, arr + 2);
2046 } else if (is_disk_zbc && 0xb0 == cmd[2]) { /* Block limits */
2047 arr[3] = inquiry_vpd_b0(&arr[4]);
2048 } else if (is_disk_zbc && 0xb1 == cmd[2]) { /* Block char. */
2049 arr[3] = inquiry_vpd_b1(devip, &arr[4]);
2050 } else if (is_disk && 0xb2 == cmd[2]) { /* LB Prov. */
2051 arr[3] = inquiry_vpd_b2(&arr[4]);
2052 } else if (is_zbc && cmd[2] == 0xb6) { /* ZB dev. charact. */
2053 arr[3] = inquiry_vpd_b6(devip, &arr[4]);
2054 } else if (cmd[2] == 0xb7) { /* block limits extension page */
2055 arr[3] = inquiry_vpd_b7(&arr[4]);
2057 mk_sense_invalid_fld(scp, SDEB_IN_CDB, 2, -1);
2059 return check_condition_result;
2061 len = min_t(u32, get_unaligned_be16(arr + 2) + 4, alloc_len);
2062 ret = fill_from_dev_buffer(scp, arr,
2063 min_t(u32, len, SDEBUG_MAX_INQ_ARR_SZ));
2067 /* drops through here for a standard inquiry */
2068 arr[1] = sdebug_removable ? 0x80 : 0; /* Removable disk */
2069 arr[2] = sdebug_scsi_level;
2070 arr[3] = 2; /* response_data_format==2 */
2071 arr[4] = SDEBUG_LONG_INQ_SZ - 5;
2072 arr[5] = (int)have_dif_prot; /* PROTECT bit */
2073 if (sdebug_vpd_use_hostno == 0)
2074 arr[5] |= 0x10; /* claim: implicit TPGS */
2075 arr[6] = 0x10; /* claim: MultiP */
2076 /* arr[6] |= 0x40; ... claim: EncServ (enclosure services) */
2077 arr[7] = 0xa; /* claim: LINKED + CMDQUE */
2078 memcpy(&arr[8], sdebug_inq_vendor_id, 8);
2079 memcpy(&arr[16], sdebug_inq_product_id, 16);
2080 memcpy(&arr[32], sdebug_inq_product_rev, 4);
2081 /* Use Vendor Specific area to place driver date in ASCII hex */
2082 memcpy(&arr[36], sdebug_version_date, 8);
2083 /* version descriptors (2 bytes each) follow */
2084 put_unaligned_be16(0xc0, arr + 58); /* SAM-6 no version claimed */
2085 put_unaligned_be16(0x5c0, arr + 60); /* SPC-5 no version claimed */
2087 if (is_disk) { /* SBC-4 no version claimed */
2088 put_unaligned_be16(0x600, arr + n);
2090 } else if (sdebug_ptype == TYPE_TAPE) { /* SSC-4 rev 3 */
2091 put_unaligned_be16(0x525, arr + n);
2093 } else if (is_zbc) { /* ZBC BSR INCITS 536 revision 05 */
2094 put_unaligned_be16(0x624, arr + n);
2097 put_unaligned_be16(0x2100, arr + n); /* SPL-4 no version claimed */
2098 ret = fill_from_dev_buffer(scp, arr,
2099 min_t(u32, alloc_len, SDEBUG_LONG_INQ_SZ));
2104 /* See resp_iec_m_pg() for how this data is manipulated */
2105 static unsigned char iec_m_pg[] = {0x1c, 0xa, 0x08, 0, 0, 0, 0, 0,
2108 static int resp_requests(struct scsi_cmnd *scp,
2109 struct sdebug_dev_info *devip)
2111 unsigned char *cmd = scp->cmnd;
2112 unsigned char arr[SCSI_SENSE_BUFFERSIZE]; /* assume >= 18 bytes */
2113 bool dsense = !!(cmd[1] & 1);
2114 u32 alloc_len = cmd[4];
2116 int stopped_state = atomic_read(&devip->stopped);
2118 memset(arr, 0, sizeof(arr));
2119 if (stopped_state > 0) { /* some "pollable" data [spc6r02: 5.12.2] */
2123 arr[2] = LOGICAL_UNIT_NOT_READY;
2124 arr[3] = (stopped_state == 2) ? 0x1 : 0x2;
2128 arr[2] = NOT_READY; /* NO_SENSE in sense_key */
2129 arr[7] = 0xa; /* 18 byte sense buffer */
2130 arr[12] = LOGICAL_UNIT_NOT_READY;
2131 arr[13] = (stopped_state == 2) ? 0x1 : 0x2;
2133 } else if ((iec_m_pg[2] & 0x4) && (6 == (iec_m_pg[3] & 0xf))) {
2134 /* Information exceptions control mode page: TEST=1, MRIE=6 */
2137 arr[1] = 0x0; /* NO_SENSE in sense_key */
2138 arr[2] = THRESHOLD_EXCEEDED;
2139 arr[3] = 0xff; /* Failure prediction(false) */
2143 arr[2] = 0x0; /* NO_SENSE in sense_key */
2144 arr[7] = 0xa; /* 18 byte sense buffer */
2145 arr[12] = THRESHOLD_EXCEEDED;
2146 arr[13] = 0xff; /* Failure prediction(false) */
2148 } else { /* nothing to report */
2151 memset(arr, 0, len);
2154 memset(arr, 0, len);
2159 return fill_from_dev_buffer(scp, arr, min_t(u32, len, alloc_len));
2162 static int resp_start_stop(struct scsi_cmnd *scp, struct sdebug_dev_info *devip)
2164 unsigned char *cmd = scp->cmnd;
2165 int power_cond, want_stop, stopped_state;
2168 power_cond = (cmd[4] & 0xf0) >> 4;
2170 mk_sense_invalid_fld(scp, SDEB_IN_CDB, 4, 7);
2171 return check_condition_result;
2173 want_stop = !(cmd[4] & 1);
2174 stopped_state = atomic_read(&devip->stopped);
2175 if (stopped_state == 2) {
2176 ktime_t now_ts = ktime_get_boottime();
2178 if (ktime_to_ns(now_ts) > ktime_to_ns(devip->create_ts)) {
2179 u64 diff_ns = ktime_to_ns(ktime_sub(now_ts, devip->create_ts));
2181 if (diff_ns >= ((u64)sdeb_tur_ms_to_ready * 1000000)) {
2182 /* tur_ms_to_ready timer extinguished */
2183 atomic_set(&devip->stopped, 0);
2187 if (stopped_state == 2) {
2189 stopped_state = 1; /* dummy up success */
2190 } else { /* Disallow tur_ms_to_ready delay to be overridden */
2191 mk_sense_invalid_fld(scp, SDEB_IN_CDB, 4, 0 /* START bit */);
2192 return check_condition_result;
2196 changing = (stopped_state != want_stop);
2198 atomic_xchg(&devip->stopped, want_stop);
2199 if (!changing || (cmd[1] & 0x1)) /* state unchanged or IMMED bit set in cdb */
2200 return SDEG_RES_IMMED_MASK;
2205 static sector_t get_sdebug_capacity(void)
2207 static const unsigned int gibibyte = 1073741824;
2209 if (sdebug_virtual_gb > 0)
2210 return (sector_t)sdebug_virtual_gb *
2211 (gibibyte / sdebug_sector_size);
2213 return sdebug_store_sectors;
2216 #define SDEBUG_READCAP_ARR_SZ 8
2217 static int resp_readcap(struct scsi_cmnd *scp,
2218 struct sdebug_dev_info *devip)
2220 unsigned char arr[SDEBUG_READCAP_ARR_SZ];
2223 /* following just in case virtual_gb changed */
2224 sdebug_capacity = get_sdebug_capacity();
2225 memset(arr, 0, SDEBUG_READCAP_ARR_SZ);
2226 if (sdebug_capacity < 0xffffffff) {
2227 capac = (unsigned int)sdebug_capacity - 1;
2228 put_unaligned_be32(capac, arr + 0);
2230 put_unaligned_be32(0xffffffff, arr + 0);
2231 put_unaligned_be16(sdebug_sector_size, arr + 6);
2232 return fill_from_dev_buffer(scp, arr, SDEBUG_READCAP_ARR_SZ);
2235 #define SDEBUG_READCAP16_ARR_SZ 32
2236 static int resp_readcap16(struct scsi_cmnd *scp,
2237 struct sdebug_dev_info *devip)
2239 unsigned char *cmd = scp->cmnd;
2240 unsigned char arr[SDEBUG_READCAP16_ARR_SZ];
2243 alloc_len = get_unaligned_be32(cmd + 10);
2244 /* following just in case virtual_gb changed */
2245 sdebug_capacity = get_sdebug_capacity();
2246 memset(arr, 0, SDEBUG_READCAP16_ARR_SZ);
2247 put_unaligned_be64((u64)(sdebug_capacity - 1), arr + 0);
2248 put_unaligned_be32(sdebug_sector_size, arr + 8);
2249 arr[13] = sdebug_physblk_exp & 0xf;
2250 arr[14] = (sdebug_lowest_aligned >> 8) & 0x3f;
2252 if (scsi_debug_lbp()) {
2253 arr[14] |= 0x80; /* LBPME */
2254 /* from sbc4r07, this LBPRZ field is 1 bit, but the LBPRZ in
2255 * the LB Provisioning VPD page is 3 bits. Note that lbprz=2
2256 * in the wider field maps to 0 in this field.
2258 if (sdebug_lbprz & 1) /* precisely what the draft requires */
2263 * Since the scsi_debug READ CAPACITY implementation always reports the
2264 * total disk capacity, set RC BASIS = 1 for host-managed ZBC devices.
2269 arr[15] = sdebug_lowest_aligned & 0xff;
2271 if (have_dif_prot) {
2272 arr[12] = (sdebug_dif - 1) << 1; /* P_TYPE */
2273 arr[12] |= 1; /* PROT_EN */
2276 return fill_from_dev_buffer(scp, arr,
2277 min_t(u32, alloc_len, SDEBUG_READCAP16_ARR_SZ));
2280 #define SDEBUG_MAX_TGTPGS_ARR_SZ 1412
2282 static int resp_report_tgtpgs(struct scsi_cmnd *scp,
2283 struct sdebug_dev_info *devip)
2285 unsigned char *cmd = scp->cmnd;
2287 int host_no = devip->sdbg_host->shost->host_no;
2288 int port_group_a, port_group_b, port_a, port_b;
2292 alen = get_unaligned_be32(cmd + 6);
2293 arr = kzalloc(SDEBUG_MAX_TGTPGS_ARR_SZ, GFP_ATOMIC);
2295 return DID_REQUEUE << 16;
2297 * EVPD page 0x88 states we have two ports, one
2298 * real and a fake port with no device connected.
2299 * So we create two port groups with one port each
2300 * and set the group with port B to unavailable.
2302 port_a = 0x1; /* relative port A */
2303 port_b = 0x2; /* relative port B */
2304 port_group_a = (((host_no + 1) & 0x7f) << 8) +
2305 (devip->channel & 0x7f);
2306 port_group_b = (((host_no + 1) & 0x7f) << 8) +
2307 (devip->channel & 0x7f) + 0x80;
2310 * The asymmetric access state is cycled according to the host_id.
2313 if (sdebug_vpd_use_hostno == 0) {
2314 arr[n++] = host_no % 3; /* Asymm access state */
2315 arr[n++] = 0x0F; /* claim: all states are supported */
2317 arr[n++] = 0x0; /* Active/Optimized path */
2318 arr[n++] = 0x01; /* only support active/optimized paths */
2320 put_unaligned_be16(port_group_a, arr + n);
2322 arr[n++] = 0; /* Reserved */
2323 arr[n++] = 0; /* Status code */
2324 arr[n++] = 0; /* Vendor unique */
2325 arr[n++] = 0x1; /* One port per group */
2326 arr[n++] = 0; /* Reserved */
2327 arr[n++] = 0; /* Reserved */
2328 put_unaligned_be16(port_a, arr + n);
2330 arr[n++] = 3; /* Port unavailable */
2331 arr[n++] = 0x08; /* claim: only unavailalbe paths are supported */
2332 put_unaligned_be16(port_group_b, arr + n);
2334 arr[n++] = 0; /* Reserved */
2335 arr[n++] = 0; /* Status code */
2336 arr[n++] = 0; /* Vendor unique */
2337 arr[n++] = 0x1; /* One port per group */
2338 arr[n++] = 0; /* Reserved */
2339 arr[n++] = 0; /* Reserved */
2340 put_unaligned_be16(port_b, arr + n);
2344 put_unaligned_be32(rlen, arr + 0);
2347 * Return the smallest value of either
2348 * - The allocated length
2349 * - The constructed command length
2350 * - The maximum array size
2352 rlen = min(alen, n);
2353 ret = fill_from_dev_buffer(scp, arr,
2354 min_t(u32, rlen, SDEBUG_MAX_TGTPGS_ARR_SZ));
2359 static int resp_rsup_opcodes(struct scsi_cmnd *scp,
2360 struct sdebug_dev_info *devip)
2363 u8 reporting_opts, req_opcode, sdeb_i, supp;
2365 u32 alloc_len, a_len;
2366 int k, offset, len, errsts, count, bump, na;
2367 const struct opcode_info_t *oip;
2368 const struct opcode_info_t *r_oip;
2370 u8 *cmd = scp->cmnd;
2372 rctd = !!(cmd[2] & 0x80);
2373 reporting_opts = cmd[2] & 0x7;
2374 req_opcode = cmd[3];
2375 req_sa = get_unaligned_be16(cmd + 4);
2376 alloc_len = get_unaligned_be32(cmd + 6);
2377 if (alloc_len < 4 || alloc_len > 0xffff) {
2378 mk_sense_invalid_fld(scp, SDEB_IN_CDB, 6, -1);
2379 return check_condition_result;
2381 if (alloc_len > 8192)
2385 arr = kzalloc((a_len < 256) ? 320 : a_len + 64, GFP_ATOMIC);
2387 mk_sense_buffer(scp, ILLEGAL_REQUEST, INSUFF_RES_ASC,
2389 return check_condition_result;
2391 switch (reporting_opts) {
2392 case 0: /* all commands */
2393 /* count number of commands */
2394 for (count = 0, oip = opcode_info_arr;
2395 oip->num_attached != 0xff; ++oip) {
2396 if (F_INV_OP & oip->flags)
2398 count += (oip->num_attached + 1);
2400 bump = rctd ? 20 : 8;
2401 put_unaligned_be32(count * bump, arr);
2402 for (offset = 4, oip = opcode_info_arr;
2403 oip->num_attached != 0xff && offset < a_len; ++oip) {
2404 if (F_INV_OP & oip->flags)
2406 na = oip->num_attached;
2407 arr[offset] = oip->opcode;
2408 put_unaligned_be16(oip->sa, arr + offset + 2);
2410 arr[offset + 5] |= 0x2;
2411 if (FF_SA & oip->flags)
2412 arr[offset + 5] |= 0x1;
2413 put_unaligned_be16(oip->len_mask[0], arr + offset + 6);
2415 put_unaligned_be16(0xa, arr + offset + 8);
2417 for (k = 0, oip = oip->arrp; k < na; ++k, ++oip) {
2418 if (F_INV_OP & oip->flags)
2421 arr[offset] = oip->opcode;
2422 put_unaligned_be16(oip->sa, arr + offset + 2);
2424 arr[offset + 5] |= 0x2;
2425 if (FF_SA & oip->flags)
2426 arr[offset + 5] |= 0x1;
2427 put_unaligned_be16(oip->len_mask[0],
2430 put_unaligned_be16(0xa,
2437 case 1: /* one command: opcode only */
2438 case 2: /* one command: opcode plus service action */
2439 case 3: /* one command: if sa==0 then opcode only else opcode+sa */
2440 sdeb_i = opcode_ind_arr[req_opcode];
2441 oip = &opcode_info_arr[sdeb_i];
2442 if (F_INV_OP & oip->flags) {
2446 if (1 == reporting_opts) {
2447 if (FF_SA & oip->flags) {
2448 mk_sense_invalid_fld(scp, SDEB_IN_CDB,
2451 return check_condition_result;
2454 } else if (2 == reporting_opts &&
2455 0 == (FF_SA & oip->flags)) {
2456 mk_sense_invalid_fld(scp, SDEB_IN_CDB, 4, -1);
2457 kfree(arr); /* point at requested sa */
2458 return check_condition_result;
2460 if (0 == (FF_SA & oip->flags) &&
2461 req_opcode == oip->opcode)
2463 else if (0 == (FF_SA & oip->flags)) {
2464 na = oip->num_attached;
2465 for (k = 0, oip = oip->arrp; k < na;
2467 if (req_opcode == oip->opcode)
2470 supp = (k >= na) ? 1 : 3;
2471 } else if (req_sa != oip->sa) {
2472 na = oip->num_attached;
2473 for (k = 0, oip = oip->arrp; k < na;
2475 if (req_sa == oip->sa)
2478 supp = (k >= na) ? 1 : 3;
2482 u = oip->len_mask[0];
2483 put_unaligned_be16(u, arr + 2);
2484 arr[4] = oip->opcode;
2485 for (k = 1; k < u; ++k)
2486 arr[4 + k] = (k < 16) ?
2487 oip->len_mask[k] : 0xff;
2492 arr[1] = (rctd ? 0x80 : 0) | supp;
2494 put_unaligned_be16(0xa, arr + offset);
2499 mk_sense_invalid_fld(scp, SDEB_IN_CDB, 2, 2);
2501 return check_condition_result;
2503 offset = (offset < a_len) ? offset : a_len;
2504 len = (offset < alloc_len) ? offset : alloc_len;
2505 errsts = fill_from_dev_buffer(scp, arr, len);
2510 static int resp_rsup_tmfs(struct scsi_cmnd *scp,
2511 struct sdebug_dev_info *devip)
2516 u8 *cmd = scp->cmnd;
2518 memset(arr, 0, sizeof(arr));
2519 repd = !!(cmd[2] & 0x80);
2520 alloc_len = get_unaligned_be32(cmd + 6);
2521 if (alloc_len < 4) {
2522 mk_sense_invalid_fld(scp, SDEB_IN_CDB, 6, -1);
2523 return check_condition_result;
2525 arr[0] = 0xc8; /* ATS | ATSS | LURS */
2526 arr[1] = 0x1; /* ITNRS */
2533 len = (len < alloc_len) ? len : alloc_len;
2534 return fill_from_dev_buffer(scp, arr, len);
2537 /* <<Following mode page info copied from ST318451LW>> */
2539 static int resp_err_recov_pg(unsigned char *p, int pcontrol, int target)
2540 { /* Read-Write Error Recovery page for mode_sense */
2541 unsigned char err_recov_pg[] = {0x1, 0xa, 0xc0, 11, 240, 0, 0, 0,
2544 memcpy(p, err_recov_pg, sizeof(err_recov_pg));
2546 memset(p + 2, 0, sizeof(err_recov_pg) - 2);
2547 return sizeof(err_recov_pg);
2550 static int resp_disconnect_pg(unsigned char *p, int pcontrol, int target)
2551 { /* Disconnect-Reconnect page for mode_sense */
2552 unsigned char disconnect_pg[] = {0x2, 0xe, 128, 128, 0, 10, 0, 0,
2553 0, 0, 0, 0, 0, 0, 0, 0};
2555 memcpy(p, disconnect_pg, sizeof(disconnect_pg));
2557 memset(p + 2, 0, sizeof(disconnect_pg) - 2);
2558 return sizeof(disconnect_pg);
2561 static int resp_format_pg(unsigned char *p, int pcontrol, int target)
2562 { /* Format device page for mode_sense */
2563 unsigned char format_pg[] = {0x3, 0x16, 0, 0, 0, 0, 0, 0,
2564 0, 0, 0, 0, 0, 0, 0, 0,
2565 0, 0, 0, 0, 0x40, 0, 0, 0};
2567 memcpy(p, format_pg, sizeof(format_pg));
2568 put_unaligned_be16(sdebug_sectors_per, p + 10);
2569 put_unaligned_be16(sdebug_sector_size, p + 12);
2570 if (sdebug_removable)
2571 p[20] |= 0x20; /* should agree with INQUIRY */
2573 memset(p + 2, 0, sizeof(format_pg) - 2);
2574 return sizeof(format_pg);
2577 static unsigned char caching_pg[] = {0x8, 18, 0x14, 0, 0xff, 0xff, 0, 0,
2578 0xff, 0xff, 0xff, 0xff, 0x80, 0x14, 0, 0,
2581 static int resp_caching_pg(unsigned char *p, int pcontrol, int target)
2582 { /* Caching page for mode_sense */
2583 unsigned char ch_caching_pg[] = {/* 0x8, 18, */ 0x4, 0, 0, 0, 0, 0,
2584 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0};
2585 unsigned char d_caching_pg[] = {0x8, 18, 0x14, 0, 0xff, 0xff, 0, 0,
2586 0xff, 0xff, 0xff, 0xff, 0x80, 0x14, 0, 0, 0, 0, 0, 0};
2588 if (SDEBUG_OPT_N_WCE & sdebug_opts)
2589 caching_pg[2] &= ~0x4; /* set WCE=0 (default WCE=1) */
2590 memcpy(p, caching_pg, sizeof(caching_pg));
2592 memcpy(p + 2, ch_caching_pg, sizeof(ch_caching_pg));
2593 else if (2 == pcontrol)
2594 memcpy(p, d_caching_pg, sizeof(d_caching_pg));
2595 return sizeof(caching_pg);
2598 static unsigned char ctrl_m_pg[] = {0xa, 10, 2, 0, 0, 0, 0, 0,
2601 static int resp_ctrl_m_pg(unsigned char *p, int pcontrol, int target)
2602 { /* Control mode page for mode_sense */
2603 unsigned char ch_ctrl_m_pg[] = {/* 0xa, 10, */ 0x6, 0, 0, 0, 0, 0,
2605 unsigned char d_ctrl_m_pg[] = {0xa, 10, 2, 0, 0, 0, 0, 0,
2609 ctrl_m_pg[2] |= 0x4;
2611 ctrl_m_pg[2] &= ~0x4;
2614 ctrl_m_pg[5] |= 0x80; /* ATO=1 */
2616 memcpy(p, ctrl_m_pg, sizeof(ctrl_m_pg));
2618 memcpy(p + 2, ch_ctrl_m_pg, sizeof(ch_ctrl_m_pg));
2619 else if (2 == pcontrol)
2620 memcpy(p, d_ctrl_m_pg, sizeof(d_ctrl_m_pg));
2621 return sizeof(ctrl_m_pg);
2624 /* IO Advice Hints Grouping mode page */
2625 static int resp_grouping_m_pg(unsigned char *p, int pcontrol, int target)
2627 /* IO Advice Hints Grouping mode page */
2628 struct grouping_m_pg {
2629 u8 page_code; /* OR 0x40 when subpage_code > 0 */
2633 struct scsi_io_group_descriptor descr[MAXIMUM_NUMBER_OF_STREAMS];
2635 static const struct grouping_m_pg gr_m_pg = {
2636 .page_code = 0xa | 0x40,
2638 .page_length = cpu_to_be16(sizeof(gr_m_pg) - 4),
2649 BUILD_BUG_ON(sizeof(struct grouping_m_pg) !=
2650 16 + MAXIMUM_NUMBER_OF_STREAMS * 16);
2651 memcpy(p, &gr_m_pg, sizeof(gr_m_pg));
2652 if (1 == pcontrol) {
2653 /* There are no changeable values so clear from byte 4 on. */
2654 memset(p + 4, 0, sizeof(gr_m_pg) - 4);
2656 return sizeof(gr_m_pg);
2659 static int resp_iec_m_pg(unsigned char *p, int pcontrol, int target)
2660 { /* Informational Exceptions control mode page for mode_sense */
2661 unsigned char ch_iec_m_pg[] = {/* 0x1c, 0xa, */ 0x4, 0xf, 0, 0, 0, 0,
2663 unsigned char d_iec_m_pg[] = {0x1c, 0xa, 0x08, 0, 0, 0, 0, 0,
2666 memcpy(p, iec_m_pg, sizeof(iec_m_pg));
2668 memcpy(p + 2, ch_iec_m_pg, sizeof(ch_iec_m_pg));
2669 else if (2 == pcontrol)
2670 memcpy(p, d_iec_m_pg, sizeof(d_iec_m_pg));
2671 return sizeof(iec_m_pg);
2674 static int resp_sas_sf_m_pg(unsigned char *p, int pcontrol, int target)
2675 { /* SAS SSP mode page - short format for mode_sense */
2676 unsigned char sas_sf_m_pg[] = {0x19, 0x6,
2677 0x6, 0x0, 0x7, 0xd0, 0x0, 0x0};
2679 memcpy(p, sas_sf_m_pg, sizeof(sas_sf_m_pg));
2681 memset(p + 2, 0, sizeof(sas_sf_m_pg) - 2);
2682 return sizeof(sas_sf_m_pg);
2686 static int resp_sas_pcd_m_spg(unsigned char *p, int pcontrol, int target,
2688 { /* SAS phy control and discover mode page for mode_sense */
2689 unsigned char sas_pcd_m_pg[] = {0x59, 0x1, 0, 0x64, 0, 0x6, 0, 2,
2690 0, 0, 0, 0, 0x10, 0x9, 0x8, 0x0,
2691 0, 0, 0, 0, 0, 0, 0, 0, /* insert SAS addr */
2692 0, 0, 0, 0, 0, 0, 0, 0, /* insert SAS addr */
2693 0x2, 0, 0, 0, 0, 0, 0, 0,
2694 0x88, 0x99, 0, 0, 0, 0, 0, 0,
2695 0, 0, 0, 0, 0, 0, 0, 0,
2696 0, 1, 0, 0, 0x10, 0x9, 0x8, 0x0,
2697 0, 0, 0, 0, 0, 0, 0, 0, /* insert SAS addr */
2698 0, 0, 0, 0, 0, 0, 0, 0, /* insert SAS addr */
2699 0x3, 0, 0, 0, 0, 0, 0, 0,
2700 0x88, 0x99, 0, 0, 0, 0, 0, 0,
2701 0, 0, 0, 0, 0, 0, 0, 0,
2705 put_unaligned_be64(naa3_comp_a, sas_pcd_m_pg + 16);
2706 put_unaligned_be64(naa3_comp_c + 1, sas_pcd_m_pg + 24);
2707 put_unaligned_be64(naa3_comp_a, sas_pcd_m_pg + 64);
2708 put_unaligned_be64(naa3_comp_c + 1, sas_pcd_m_pg + 72);
2709 port_a = target_dev_id + 1;
2710 port_b = port_a + 1;
2711 memcpy(p, sas_pcd_m_pg, sizeof(sas_pcd_m_pg));
2712 put_unaligned_be32(port_a, p + 20);
2713 put_unaligned_be32(port_b, p + 48 + 20);
2715 memset(p + 4, 0, sizeof(sas_pcd_m_pg) - 4);
2716 return sizeof(sas_pcd_m_pg);
2719 static int resp_sas_sha_m_spg(unsigned char *p, int pcontrol)
2720 { /* SAS SSP shared protocol specific port mode subpage */
2721 unsigned char sas_sha_m_pg[] = {0x59, 0x2, 0, 0xc, 0, 0x6, 0x10, 0,
2722 0, 0, 0, 0, 0, 0, 0, 0,
2725 memcpy(p, sas_sha_m_pg, sizeof(sas_sha_m_pg));
2727 memset(p + 4, 0, sizeof(sas_sha_m_pg) - 4);
2728 return sizeof(sas_sha_m_pg);
2731 /* PAGE_SIZE is more than necessary but provides room for future expansion. */
2732 #define SDEBUG_MAX_MSENSE_SZ PAGE_SIZE
2734 static int resp_mode_sense(struct scsi_cmnd *scp,
2735 struct sdebug_dev_info *devip)
2737 int pcontrol, pcode, subpcode, bd_len;
2738 unsigned char dev_spec;
2739 u32 alloc_len, offset, len;
2741 int target = scp->device->id;
2743 unsigned char *arr __free(kfree);
2744 unsigned char *cmd = scp->cmnd;
2745 bool dbd, llbaa, msense_6, is_disk, is_zbc;
2747 arr = kzalloc(SDEBUG_MAX_MSENSE_SZ, GFP_ATOMIC);
2750 dbd = !!(cmd[1] & 0x8); /* disable block descriptors */
2751 pcontrol = (cmd[2] & 0xc0) >> 6;
2752 pcode = cmd[2] & 0x3f;
2754 msense_6 = (MODE_SENSE == cmd[0]);
2755 llbaa = msense_6 ? false : !!(cmd[1] & 0x10);
2756 is_disk = (sdebug_ptype == TYPE_DISK);
2757 is_zbc = devip->zoned;
2758 if ((is_disk || is_zbc) && !dbd)
2759 bd_len = llbaa ? 16 : 8;
2762 alloc_len = msense_6 ? cmd[4] : get_unaligned_be16(cmd + 7);
2763 memset(arr, 0, SDEBUG_MAX_MSENSE_SZ);
2764 if (0x3 == pcontrol) { /* Saving values not supported */
2765 mk_sense_buffer(scp, ILLEGAL_REQUEST, SAVING_PARAMS_UNSUP, 0);
2766 return check_condition_result;
2768 target_dev_id = ((devip->sdbg_host->shost->host_no + 1) * 2000) +
2769 (devip->target * 1000) - 3;
2770 /* for disks+zbc set DPOFUA bit and clear write protect (WP) bit */
2771 if (is_disk || is_zbc) {
2772 dev_spec = 0x10; /* =0x90 if WP=1 implies read-only */
2784 arr[4] = 0x1; /* set LONGLBA bit */
2785 arr[7] = bd_len; /* assume 255 or less */
2789 if ((bd_len > 0) && (!sdebug_capacity))
2790 sdebug_capacity = get_sdebug_capacity();
2793 if (sdebug_capacity > 0xfffffffe)
2794 put_unaligned_be32(0xffffffff, ap + 0);
2796 put_unaligned_be32(sdebug_capacity, ap + 0);
2797 put_unaligned_be16(sdebug_sector_size, ap + 6);
2800 } else if (16 == bd_len) {
2801 put_unaligned_be64((u64)sdebug_capacity, ap + 0);
2802 put_unaligned_be32(sdebug_sector_size, ap + 12);
2808 * N.B. If len>0 before resp_*_pg() call, then form of that call should be:
2809 * len += resp_*_pg(ap + len, pcontrol, target);
2812 case 0x1: /* Read-Write error recovery page, direct access */
2813 if (subpcode > 0x0 && subpcode < 0xff)
2815 len = resp_err_recov_pg(ap, pcontrol, target);
2818 case 0x2: /* Disconnect-Reconnect page, all devices */
2819 if (subpcode > 0x0 && subpcode < 0xff)
2821 len = resp_disconnect_pg(ap, pcontrol, target);
2824 case 0x3: /* Format device page, direct access */
2825 if (subpcode > 0x0 && subpcode < 0xff)
2828 len = resp_format_pg(ap, pcontrol, target);
2834 case 0x8: /* Caching page, direct access */
2835 if (subpcode > 0x0 && subpcode < 0xff)
2837 if (is_disk || is_zbc) {
2838 len = resp_caching_pg(ap, pcontrol, target);
2844 case 0xa: /* Control Mode page, all devices */
2847 len = resp_ctrl_m_pg(ap, pcontrol, target);
2850 len = resp_grouping_m_pg(ap, pcontrol, target);
2853 len = resp_ctrl_m_pg(ap, pcontrol, target);
2854 len += resp_grouping_m_pg(ap + len, pcontrol, target);
2861 case 0x19: /* if spc==1 then sas phy, control+discover */
2862 if (subpcode > 0x2 && subpcode < 0xff)
2865 if ((0x0 == subpcode) || (0xff == subpcode))
2866 len += resp_sas_sf_m_pg(ap + len, pcontrol, target);
2867 if ((0x1 == subpcode) || (0xff == subpcode))
2868 len += resp_sas_pcd_m_spg(ap + len, pcontrol, target,
2870 if ((0x2 == subpcode) || (0xff == subpcode))
2871 len += resp_sas_sha_m_spg(ap + len, pcontrol);
2874 case 0x1c: /* Informational Exceptions Mode page, all devices */
2875 if (subpcode > 0x0 && subpcode < 0xff)
2877 len = resp_iec_m_pg(ap, pcontrol, target);
2880 case 0x3f: /* Read all Mode pages */
2881 if (subpcode > 0x0 && subpcode < 0xff)
2883 len = resp_err_recov_pg(ap, pcontrol, target);
2884 len += resp_disconnect_pg(ap + len, pcontrol, target);
2886 len += resp_format_pg(ap + len, pcontrol, target);
2887 len += resp_caching_pg(ap + len, pcontrol, target);
2888 } else if (is_zbc) {
2889 len += resp_caching_pg(ap + len, pcontrol, target);
2891 len += resp_ctrl_m_pg(ap + len, pcontrol, target);
2892 if (0xff == subpcode)
2893 len += resp_grouping_m_pg(ap + len, pcontrol, target);
2894 len += resp_sas_sf_m_pg(ap + len, pcontrol, target);
2895 if (0xff == subpcode) {
2896 len += resp_sas_pcd_m_spg(ap + len, pcontrol, target,
2898 len += resp_sas_sha_m_spg(ap + len, pcontrol);
2900 len += resp_iec_m_pg(ap + len, pcontrol, target);
2907 arr[0] = offset - 1;
2909 put_unaligned_be16((offset - 2), arr + 0);
2910 return fill_from_dev_buffer(scp, arr, min_t(u32, alloc_len, offset));
2913 mk_sense_invalid_fld(scp, SDEB_IN_CDB, 2, 5);
2914 return check_condition_result;
2917 mk_sense_invalid_fld(scp, SDEB_IN_CDB, 3, -1);
2918 return check_condition_result;
2921 #define SDEBUG_MAX_MSELECT_SZ 512
2923 static int resp_mode_select(struct scsi_cmnd *scp,
2924 struct sdebug_dev_info *devip)
2926 int pf, sp, ps, md_len, bd_len, off, spf, pg_len;
2927 int param_len, res, mpage;
2928 unsigned char arr[SDEBUG_MAX_MSELECT_SZ];
2929 unsigned char *cmd = scp->cmnd;
2930 int mselect6 = (MODE_SELECT == cmd[0]);
2932 memset(arr, 0, sizeof(arr));
2935 param_len = mselect6 ? cmd[4] : get_unaligned_be16(cmd + 7);
2936 if ((0 == pf) || sp || (param_len > SDEBUG_MAX_MSELECT_SZ)) {
2937 mk_sense_invalid_fld(scp, SDEB_IN_CDB, mselect6 ? 4 : 7, -1);
2938 return check_condition_result;
2940 res = fetch_to_dev_buffer(scp, arr, param_len);
2942 return DID_ERROR << 16;
2943 else if (sdebug_verbose && (res < param_len))
2944 sdev_printk(KERN_INFO, scp->device,
2945 "%s: cdb indicated=%d, IO sent=%d bytes\n",
2946 __func__, param_len, res);
2947 md_len = mselect6 ? (arr[0] + 1) : (get_unaligned_be16(arr + 0) + 2);
2948 bd_len = mselect6 ? arr[3] : get_unaligned_be16(arr + 6);
2949 off = bd_len + (mselect6 ? 4 : 8);
2950 if (md_len > 2 || off >= res) {
2951 mk_sense_invalid_fld(scp, SDEB_IN_DATA, 0, -1);
2952 return check_condition_result;
2954 mpage = arr[off] & 0x3f;
2955 ps = !!(arr[off] & 0x80);
2957 mk_sense_invalid_fld(scp, SDEB_IN_DATA, off, 7);
2958 return check_condition_result;
2960 spf = !!(arr[off] & 0x40);
2961 pg_len = spf ? (get_unaligned_be16(arr + off + 2) + 4) :
2963 if ((pg_len + off) > param_len) {
2964 mk_sense_buffer(scp, ILLEGAL_REQUEST,
2965 PARAMETER_LIST_LENGTH_ERR, 0);
2966 return check_condition_result;
2969 case 0x8: /* Caching Mode page */
2970 if (caching_pg[1] == arr[off + 1]) {
2971 memcpy(caching_pg + 2, arr + off + 2,
2972 sizeof(caching_pg) - 2);
2973 goto set_mode_changed_ua;
2976 case 0xa: /* Control Mode page */
2977 if (ctrl_m_pg[1] == arr[off + 1]) {
2978 memcpy(ctrl_m_pg + 2, arr + off + 2,
2979 sizeof(ctrl_m_pg) - 2);
2980 if (ctrl_m_pg[4] & 0x8)
2984 sdebug_dsense = !!(ctrl_m_pg[2] & 0x4);
2985 goto set_mode_changed_ua;
2988 case 0x1c: /* Informational Exceptions Mode page */
2989 if (iec_m_pg[1] == arr[off + 1]) {
2990 memcpy(iec_m_pg + 2, arr + off + 2,
2991 sizeof(iec_m_pg) - 2);
2992 goto set_mode_changed_ua;
2998 mk_sense_invalid_fld(scp, SDEB_IN_DATA, off, 5);
2999 return check_condition_result;
3000 set_mode_changed_ua:
3001 set_bit(SDEBUG_UA_MODE_CHANGED, devip->uas_bm);
3005 static int resp_temp_l_pg(unsigned char *arr)
3007 unsigned char temp_l_pg[] = {0x0, 0x0, 0x3, 0x2, 0x0, 38,
3008 0x0, 0x1, 0x3, 0x2, 0x0, 65,
3011 memcpy(arr, temp_l_pg, sizeof(temp_l_pg));
3012 return sizeof(temp_l_pg);
3015 static int resp_ie_l_pg(unsigned char *arr)
3017 unsigned char ie_l_pg[] = {0x0, 0x0, 0x3, 0x3, 0x0, 0x0, 38,
3020 memcpy(arr, ie_l_pg, sizeof(ie_l_pg));
3021 if (iec_m_pg[2] & 0x4) { /* TEST bit set */
3022 arr[4] = THRESHOLD_EXCEEDED;
3025 return sizeof(ie_l_pg);
3028 static int resp_env_rep_l_spg(unsigned char *arr)
3030 unsigned char env_rep_l_spg[] = {0x0, 0x0, 0x23, 0x8,
3031 0x0, 40, 72, 0xff, 45, 18, 0, 0,
3032 0x1, 0x0, 0x23, 0x8,
3033 0x0, 55, 72, 35, 55, 45, 0, 0,
3036 memcpy(arr, env_rep_l_spg, sizeof(env_rep_l_spg));
3037 return sizeof(env_rep_l_spg);
3040 #define SDEBUG_MAX_LSENSE_SZ 512
3042 static int resp_log_sense(struct scsi_cmnd *scp,
3043 struct sdebug_dev_info *devip)
3045 int ppc, sp, pcode, subpcode;
3046 u32 alloc_len, len, n;
3047 unsigned char arr[SDEBUG_MAX_LSENSE_SZ];
3048 unsigned char *cmd = scp->cmnd;
3050 memset(arr, 0, sizeof(arr));
3054 mk_sense_invalid_fld(scp, SDEB_IN_CDB, 1, ppc ? 1 : 0);
3055 return check_condition_result;
3057 pcode = cmd[2] & 0x3f;
3058 subpcode = cmd[3] & 0xff;
3059 alloc_len = get_unaligned_be16(cmd + 7);
3061 if (0 == subpcode) {
3063 case 0x0: /* Supported log pages log page */
3065 arr[n++] = 0x0; /* this page */
3066 arr[n++] = 0xd; /* Temperature */
3067 arr[n++] = 0x2f; /* Informational exceptions */
3070 case 0xd: /* Temperature log page */
3071 arr[3] = resp_temp_l_pg(arr + 4);
3073 case 0x2f: /* Informational exceptions log page */
3074 arr[3] = resp_ie_l_pg(arr + 4);
3077 mk_sense_invalid_fld(scp, SDEB_IN_CDB, 2, 5);
3078 return check_condition_result;
3080 } else if (0xff == subpcode) {
3084 case 0x0: /* Supported log pages and subpages log page */
3087 arr[n++] = 0x0; /* 0,0 page */
3089 arr[n++] = 0xff; /* this page */
3091 arr[n++] = 0x0; /* Temperature */
3093 arr[n++] = 0x1; /* Environment reporting */
3095 arr[n++] = 0xff; /* all 0xd subpages */
3097 arr[n++] = 0x0; /* Informational exceptions */
3099 arr[n++] = 0xff; /* all 0x2f subpages */
3102 case 0xd: /* Temperature subpages */
3105 arr[n++] = 0x0; /* Temperature */
3107 arr[n++] = 0x1; /* Environment reporting */
3109 arr[n++] = 0xff; /* these subpages */
3112 case 0x2f: /* Informational exceptions subpages */
3115 arr[n++] = 0x0; /* Informational exceptions */
3117 arr[n++] = 0xff; /* these subpages */
3121 mk_sense_invalid_fld(scp, SDEB_IN_CDB, 2, 5);
3122 return check_condition_result;
3124 } else if (subpcode > 0) {
3127 if (pcode == 0xd && subpcode == 1)
3128 arr[3] = resp_env_rep_l_spg(arr + 4);
3130 mk_sense_invalid_fld(scp, SDEB_IN_CDB, 2, 5);
3131 return check_condition_result;
3134 mk_sense_invalid_fld(scp, SDEB_IN_CDB, 3, -1);
3135 return check_condition_result;
3137 len = min_t(u32, get_unaligned_be16(arr + 2) + 4, alloc_len);
3138 return fill_from_dev_buffer(scp, arr,
3139 min_t(u32, len, SDEBUG_MAX_INQ_ARR_SZ));
3142 static inline bool sdebug_dev_is_zoned(struct sdebug_dev_info *devip)
3144 return devip->nr_zones != 0;
3147 static struct sdeb_zone_state *zbc_zone(struct sdebug_dev_info *devip,
3148 unsigned long long lba)
3150 u32 zno = lba >> devip->zsize_shift;
3151 struct sdeb_zone_state *zsp;
3153 if (devip->zcap == devip->zsize || zno < devip->nr_conv_zones)
3154 return &devip->zstate[zno];
3157 * If the zone capacity is less than the zone size, adjust for gap
3160 zno = 2 * zno - devip->nr_conv_zones;
3161 WARN_ONCE(zno >= devip->nr_zones, "%u > %u\n", zno, devip->nr_zones);
3162 zsp = &devip->zstate[zno];
3163 if (lba >= zsp->z_start + zsp->z_size)
3165 WARN_ON_ONCE(lba >= zsp->z_start + zsp->z_size);
3169 static inline bool zbc_zone_is_conv(struct sdeb_zone_state *zsp)
3171 return zsp->z_type == ZBC_ZTYPE_CNV;
3174 static inline bool zbc_zone_is_gap(struct sdeb_zone_state *zsp)
3176 return zsp->z_type == ZBC_ZTYPE_GAP;
3179 static inline bool zbc_zone_is_seq(struct sdeb_zone_state *zsp)
3181 return !zbc_zone_is_conv(zsp) && !zbc_zone_is_gap(zsp);
3184 static void zbc_close_zone(struct sdebug_dev_info *devip,
3185 struct sdeb_zone_state *zsp)
3187 enum sdebug_z_cond zc;
3189 if (!zbc_zone_is_seq(zsp))
3193 if (!(zc == ZC2_IMPLICIT_OPEN || zc == ZC3_EXPLICIT_OPEN))
3196 if (zc == ZC2_IMPLICIT_OPEN)
3197 devip->nr_imp_open--;
3199 devip->nr_exp_open--;
3201 if (zsp->z_wp == zsp->z_start) {
3202 zsp->z_cond = ZC1_EMPTY;
3204 zsp->z_cond = ZC4_CLOSED;
3209 static void zbc_close_imp_open_zone(struct sdebug_dev_info *devip)
3211 struct sdeb_zone_state *zsp = &devip->zstate[0];
3214 for (i = 0; i < devip->nr_zones; i++, zsp++) {
3215 if (zsp->z_cond == ZC2_IMPLICIT_OPEN) {
3216 zbc_close_zone(devip, zsp);
3222 static void zbc_open_zone(struct sdebug_dev_info *devip,
3223 struct sdeb_zone_state *zsp, bool explicit)
3225 enum sdebug_z_cond zc;
3227 if (!zbc_zone_is_seq(zsp))
3231 if ((explicit && zc == ZC3_EXPLICIT_OPEN) ||
3232 (!explicit && zc == ZC2_IMPLICIT_OPEN))
3235 /* Close an implicit open zone if necessary */
3236 if (explicit && zsp->z_cond == ZC2_IMPLICIT_OPEN)
3237 zbc_close_zone(devip, zsp);
3238 else if (devip->max_open &&
3239 devip->nr_imp_open + devip->nr_exp_open >= devip->max_open)
3240 zbc_close_imp_open_zone(devip);
3242 if (zsp->z_cond == ZC4_CLOSED)
3245 zsp->z_cond = ZC3_EXPLICIT_OPEN;
3246 devip->nr_exp_open++;
3248 zsp->z_cond = ZC2_IMPLICIT_OPEN;
3249 devip->nr_imp_open++;
3253 static inline void zbc_set_zone_full(struct sdebug_dev_info *devip,
3254 struct sdeb_zone_state *zsp)
3256 switch (zsp->z_cond) {
3257 case ZC2_IMPLICIT_OPEN:
3258 devip->nr_imp_open--;
3260 case ZC3_EXPLICIT_OPEN:
3261 devip->nr_exp_open--;
3264 WARN_ONCE(true, "Invalid zone %llu condition %x\n",
3265 zsp->z_start, zsp->z_cond);
3268 zsp->z_cond = ZC5_FULL;
3271 static void zbc_inc_wp(struct sdebug_dev_info *devip,
3272 unsigned long long lba, unsigned int num)
3274 struct sdeb_zone_state *zsp = zbc_zone(devip, lba);
3275 unsigned long long n, end, zend = zsp->z_start + zsp->z_size;
3277 if (!zbc_zone_is_seq(zsp))
3280 if (zsp->z_type == ZBC_ZTYPE_SWR) {
3282 if (zsp->z_wp >= zend)
3283 zbc_set_zone_full(devip, zsp);
3288 if (lba != zsp->z_wp)
3289 zsp->z_non_seq_resource = true;
3295 } else if (end > zsp->z_wp) {
3301 if (zsp->z_wp >= zend)
3302 zbc_set_zone_full(devip, zsp);
3308 zend = zsp->z_start + zsp->z_size;
3313 static int check_zbc_access_params(struct scsi_cmnd *scp,
3314 unsigned long long lba, unsigned int num, bool write)
3316 struct scsi_device *sdp = scp->device;
3317 struct sdebug_dev_info *devip = (struct sdebug_dev_info *)sdp->hostdata;
3318 struct sdeb_zone_state *zsp = zbc_zone(devip, lba);
3319 struct sdeb_zone_state *zsp_end = zbc_zone(devip, lba + num - 1);
3322 /* For host-managed, reads cannot cross zone types boundaries */
3323 if (zsp->z_type != zsp_end->z_type) {
3324 mk_sense_buffer(scp, ILLEGAL_REQUEST,
3327 return check_condition_result;
3332 /* Writing into a gap zone is not allowed */
3333 if (zbc_zone_is_gap(zsp)) {
3334 mk_sense_buffer(scp, ILLEGAL_REQUEST, LBA_OUT_OF_RANGE,
3335 ATTEMPT_ACCESS_GAP);
3336 return check_condition_result;
3339 /* No restrictions for writes within conventional zones */
3340 if (zbc_zone_is_conv(zsp)) {
3341 if (!zbc_zone_is_conv(zsp_end)) {
3342 mk_sense_buffer(scp, ILLEGAL_REQUEST,
3344 WRITE_BOUNDARY_ASCQ);
3345 return check_condition_result;
3350 if (zsp->z_type == ZBC_ZTYPE_SWR) {
3351 /* Writes cannot cross sequential zone boundaries */
3352 if (zsp_end != zsp) {
3353 mk_sense_buffer(scp, ILLEGAL_REQUEST,
3355 WRITE_BOUNDARY_ASCQ);
3356 return check_condition_result;
3358 /* Cannot write full zones */
3359 if (zsp->z_cond == ZC5_FULL) {
3360 mk_sense_buffer(scp, ILLEGAL_REQUEST,
3361 INVALID_FIELD_IN_CDB, 0);
3362 return check_condition_result;
3364 /* Writes must be aligned to the zone WP */
3365 if (lba != zsp->z_wp) {
3366 mk_sense_buffer(scp, ILLEGAL_REQUEST,
3368 UNALIGNED_WRITE_ASCQ);
3369 return check_condition_result;
3373 /* Handle implicit open of closed and empty zones */
3374 if (zsp->z_cond == ZC1_EMPTY || zsp->z_cond == ZC4_CLOSED) {
3375 if (devip->max_open &&
3376 devip->nr_exp_open >= devip->max_open) {
3377 mk_sense_buffer(scp, DATA_PROTECT,
3380 return check_condition_result;
3382 zbc_open_zone(devip, zsp, false);
3388 static inline int check_device_access_params
3389 (struct scsi_cmnd *scp, unsigned long long lba,
3390 unsigned int num, bool write)
3392 struct scsi_device *sdp = scp->device;
3393 struct sdebug_dev_info *devip = (struct sdebug_dev_info *)sdp->hostdata;
3395 if (lba + num > sdebug_capacity) {
3396 mk_sense_buffer(scp, ILLEGAL_REQUEST, LBA_OUT_OF_RANGE, 0);
3397 return check_condition_result;
3399 /* transfer length excessive (tie in to block limits VPD page) */
3400 if (num > sdebug_store_sectors) {
3401 /* needs work to find which cdb byte 'num' comes from */
3402 mk_sense_buffer(scp, ILLEGAL_REQUEST, INVALID_FIELD_IN_CDB, 0);
3403 return check_condition_result;
3405 if (write && unlikely(sdebug_wp)) {
3406 mk_sense_buffer(scp, DATA_PROTECT, WRITE_PROTECTED, 0x2);
3407 return check_condition_result;
3409 if (sdebug_dev_is_zoned(devip))
3410 return check_zbc_access_params(scp, lba, num, write);
3416 * Note: if BUG_ON() fires it usually indicates a problem with the parser
3417 * tables. Perhaps a missing F_FAKE_RW or FF_MEDIA_IO flag. Response functions
3418 * that access any of the "stores" in struct sdeb_store_info should call this
3419 * function with bug_if_fake_rw set to true.
3421 static inline struct sdeb_store_info *devip2sip(struct sdebug_dev_info *devip,
3422 bool bug_if_fake_rw)
3424 if (sdebug_fake_rw) {
3425 BUG_ON(bug_if_fake_rw); /* See note above */
3428 return xa_load(per_store_ap, devip->sdbg_host->si_idx);
3432 sdeb_read_lock(rwlock_t *lock)
3434 if (sdebug_no_rwlock)
3441 sdeb_read_unlock(rwlock_t *lock)
3443 if (sdebug_no_rwlock)
3450 sdeb_write_lock(rwlock_t *lock)
3452 if (sdebug_no_rwlock)
3459 sdeb_write_unlock(rwlock_t *lock)
3461 if (sdebug_no_rwlock)
3468 sdeb_data_read_lock(struct sdeb_store_info *sip)
3472 sdeb_read_lock(&sip->macc_data_lck);
3476 sdeb_data_read_unlock(struct sdeb_store_info *sip)
3480 sdeb_read_unlock(&sip->macc_data_lck);
3484 sdeb_data_write_lock(struct sdeb_store_info *sip)
3488 sdeb_write_lock(&sip->macc_data_lck);
3492 sdeb_data_write_unlock(struct sdeb_store_info *sip)
3496 sdeb_write_unlock(&sip->macc_data_lck);
3500 sdeb_data_sector_read_lock(struct sdeb_store_info *sip)
3504 sdeb_read_lock(&sip->macc_sector_lck);
3508 sdeb_data_sector_read_unlock(struct sdeb_store_info *sip)
3512 sdeb_read_unlock(&sip->macc_sector_lck);
3516 sdeb_data_sector_write_lock(struct sdeb_store_info *sip)
3520 sdeb_write_lock(&sip->macc_sector_lck);
3524 sdeb_data_sector_write_unlock(struct sdeb_store_info *sip)
3528 sdeb_write_unlock(&sip->macc_sector_lck);
3533 * We simplify the atomic model to allow only 1x atomic write and many non-
3534 * atomic reads or writes for all LBAs.
3536 * A RW lock has a similar bahaviour:
3537 * Only 1x writer and many readers.
3539 * So use a RW lock for per-device read and write locking:
3540 * An atomic access grabs the lock as a writer and non-atomic grabs the lock
3545 sdeb_data_lock(struct sdeb_store_info *sip, bool atomic)
3548 sdeb_data_write_lock(sip);
3550 sdeb_data_read_lock(sip);
3554 sdeb_data_unlock(struct sdeb_store_info *sip, bool atomic)
3557 sdeb_data_write_unlock(sip);
3559 sdeb_data_read_unlock(sip);
3562 /* Allow many reads but only 1x write per sector */
3564 sdeb_data_sector_lock(struct sdeb_store_info *sip, bool do_write)
3567 sdeb_data_sector_write_lock(sip);
3569 sdeb_data_sector_read_lock(sip);
3573 sdeb_data_sector_unlock(struct sdeb_store_info *sip, bool do_write)
3576 sdeb_data_sector_write_unlock(sip);
3578 sdeb_data_sector_read_unlock(sip);
3582 sdeb_meta_read_lock(struct sdeb_store_info *sip)
3584 if (sdebug_no_rwlock) {
3586 __acquire(&sip->macc_meta_lck);
3588 __acquire(&sdeb_fake_rw_lck);
3591 read_lock(&sip->macc_meta_lck);
3593 read_lock(&sdeb_fake_rw_lck);
3598 sdeb_meta_read_unlock(struct sdeb_store_info *sip)
3600 if (sdebug_no_rwlock) {
3602 __release(&sip->macc_meta_lck);
3604 __release(&sdeb_fake_rw_lck);
3607 read_unlock(&sip->macc_meta_lck);
3609 read_unlock(&sdeb_fake_rw_lck);
3614 sdeb_meta_write_lock(struct sdeb_store_info *sip)
3616 if (sdebug_no_rwlock) {
3618 __acquire(&sip->macc_meta_lck);
3620 __acquire(&sdeb_fake_rw_lck);
3623 write_lock(&sip->macc_meta_lck);
3625 write_lock(&sdeb_fake_rw_lck);
3630 sdeb_meta_write_unlock(struct sdeb_store_info *sip)
3632 if (sdebug_no_rwlock) {
3634 __release(&sip->macc_meta_lck);
3636 __release(&sdeb_fake_rw_lck);
3639 write_unlock(&sip->macc_meta_lck);
3641 write_unlock(&sdeb_fake_rw_lck);
3645 /* Returns number of bytes copied or -1 if error. */
3646 static int do_device_access(struct sdeb_store_info *sip, struct scsi_cmnd *scp,
3647 u32 sg_skip, u64 lba, u32 num, u8 group_number,
3648 bool do_write, bool atomic)
3652 enum dma_data_direction dir;
3653 struct scsi_data_buffer *sdb = &scp->sdb;
3658 * Even though reads are inherently atomic (in this driver), we expect
3659 * the atomic flag only for writes.
3661 if (!do_write && atomic)
3665 dir = DMA_TO_DEVICE;
3666 write_since_sync = true;
3668 dir = DMA_FROM_DEVICE;
3671 if (!sdb->length || !sip)
3673 if (scp->sc_data_direction != dir)
3676 if (do_write && group_number < ARRAY_SIZE(writes_by_group_number))
3677 atomic_long_inc(&writes_by_group_number[group_number]);
3681 block = do_div(lba, sdebug_store_sectors);
3683 /* Only allow 1x atomic write or multiple non-atomic writes at any given time */
3684 sdeb_data_lock(sip, atomic);
3685 for (i = 0; i < num; i++) {
3686 /* We shouldn't need to lock for atomic writes, but do it anyway */
3687 sdeb_data_sector_lock(sip, do_write);
3688 ret = sg_copy_buffer(sdb->table.sgl, sdb->table.nents,
3689 fsp + (block * sdebug_sector_size),
3690 sdebug_sector_size, sg_skip, do_write);
3691 sdeb_data_sector_unlock(sip, do_write);
3692 if (ret != sdebug_sector_size) {
3693 ret += (i * sdebug_sector_size);
3696 sg_skip += sdebug_sector_size;
3697 if (++block >= sdebug_store_sectors)
3700 ret = num * sdebug_sector_size;
3701 sdeb_data_unlock(sip, atomic);
3706 /* Returns number of bytes copied or -1 if error. */
3707 static int do_dout_fetch(struct scsi_cmnd *scp, u32 num, u8 *doutp)
3709 struct scsi_data_buffer *sdb = &scp->sdb;
3713 if (scp->sc_data_direction != DMA_TO_DEVICE)
3715 return sg_copy_buffer(sdb->table.sgl, sdb->table.nents, doutp,
3716 num * sdebug_sector_size, 0, true);
3719 /* If sip->storep+lba compares equal to arr(num), then copy top half of
3720 * arr into sip->storep+lba and return true. If comparison fails then
3722 static bool comp_write_worker(struct sdeb_store_info *sip, u64 lba, u32 num,
3723 const u8 *arr, bool compare_only)
3726 u64 block, rest = 0;
3727 u32 store_blks = sdebug_store_sectors;
3728 u32 lb_size = sdebug_sector_size;
3729 u8 *fsp = sip->storep;
3731 block = do_div(lba, store_blks);
3732 if (block + num > store_blks)
3733 rest = block + num - store_blks;
3735 res = !memcmp(fsp + (block * lb_size), arr, (num - rest) * lb_size);
3739 res = memcmp(fsp, arr + ((num - rest) * lb_size),
3745 arr += num * lb_size;
3746 memcpy(fsp + (block * lb_size), arr, (num - rest) * lb_size);
3748 memcpy(fsp, arr + ((num - rest) * lb_size), rest * lb_size);
3752 static __be16 dif_compute_csum(const void *buf, int len)
3757 csum = (__force __be16)ip_compute_csum(buf, len);
3759 csum = cpu_to_be16(crc_t10dif(buf, len));
3764 static int dif_verify(struct t10_pi_tuple *sdt, const void *data,
3765 sector_t sector, u32 ei_lba)
3767 __be16 csum = dif_compute_csum(data, sdebug_sector_size);
3769 if (sdt->guard_tag != csum) {
3770 pr_err("GUARD check failed on sector %lu rcvd 0x%04x, data 0x%04x\n",
3771 (unsigned long)sector,
3772 be16_to_cpu(sdt->guard_tag),
3776 if (sdebug_dif == T10_PI_TYPE1_PROTECTION &&
3777 be32_to_cpu(sdt->ref_tag) != (sector & 0xffffffff)) {
3778 pr_err("REF check failed on sector %lu\n",
3779 (unsigned long)sector);
3782 if (sdebug_dif == T10_PI_TYPE2_PROTECTION &&
3783 be32_to_cpu(sdt->ref_tag) != ei_lba) {
3784 pr_err("REF check failed on sector %lu\n",
3785 (unsigned long)sector);
3791 static void dif_copy_prot(struct scsi_cmnd *scp, sector_t sector,
3792 unsigned int sectors, bool read)
3796 struct sdeb_store_info *sip = devip2sip((struct sdebug_dev_info *)
3797 scp->device->hostdata, true);
3798 struct t10_pi_tuple *dif_storep = sip->dif_storep;
3799 const void *dif_store_end = dif_storep + sdebug_store_sectors;
3800 struct sg_mapping_iter miter;
3802 /* Bytes of protection data to copy into sgl */
3803 resid = sectors * sizeof(*dif_storep);
3805 sg_miter_start(&miter, scsi_prot_sglist(scp),
3806 scsi_prot_sg_count(scp), SG_MITER_ATOMIC |
3807 (read ? SG_MITER_TO_SG : SG_MITER_FROM_SG));
3809 while (sg_miter_next(&miter) && resid > 0) {
3810 size_t len = min_t(size_t, miter.length, resid);
3811 void *start = dif_store(sip, sector);
3814 if (dif_store_end < start + len)
3815 rest = start + len - dif_store_end;
3820 memcpy(paddr, start, len - rest);
3822 memcpy(start, paddr, len - rest);
3826 memcpy(paddr + len - rest, dif_storep, rest);
3828 memcpy(dif_storep, paddr + len - rest, rest);
3831 sector += len / sizeof(*dif_storep);
3834 sg_miter_stop(&miter);
3837 static int prot_verify_read(struct scsi_cmnd *scp, sector_t start_sec,
3838 unsigned int sectors, u32 ei_lba)
3843 struct sdeb_store_info *sip = devip2sip((struct sdebug_dev_info *)
3844 scp->device->hostdata, true);
3845 struct t10_pi_tuple *sdt;
3847 for (i = 0; i < sectors; i++, ei_lba++) {
3848 sector = start_sec + i;
3849 sdt = dif_store(sip, sector);
3851 if (sdt->app_tag == cpu_to_be16(0xffff))
3855 * Because scsi_debug acts as both initiator and
3856 * target we proceed to verify the PI even if
3857 * RDPROTECT=3. This is done so the "initiator" knows
3858 * which type of error to return. Otherwise we would
3859 * have to iterate over the PI twice.
3861 if (scp->cmnd[1] >> 5) { /* RDPROTECT */
3862 ret = dif_verify(sdt, lba2fake_store(sip, sector),
3871 dif_copy_prot(scp, start_sec, sectors, true);
3877 static int resp_read_dt0(struct scsi_cmnd *scp, struct sdebug_dev_info *devip)
3884 struct sdeb_store_info *sip = devip2sip(devip, true);
3885 u8 *cmd = scp->cmnd;
3886 bool meta_data_locked = false;
3891 lba = get_unaligned_be64(cmd + 2);
3892 num = get_unaligned_be32(cmd + 10);
3897 lba = get_unaligned_be32(cmd + 2);
3898 num = get_unaligned_be16(cmd + 7);
3903 lba = (u32)cmd[3] | (u32)cmd[2] << 8 |
3904 (u32)(cmd[1] & 0x1f) << 16;
3905 num = (0 == cmd[4]) ? 256 : cmd[4];
3910 lba = get_unaligned_be32(cmd + 2);
3911 num = get_unaligned_be32(cmd + 6);
3914 case XDWRITEREAD_10:
3916 lba = get_unaligned_be32(cmd + 2);
3917 num = get_unaligned_be16(cmd + 7);
3920 default: /* assume READ(32) */
3921 lba = get_unaligned_be64(cmd + 12);
3922 ei_lba = get_unaligned_be32(cmd + 20);
3923 num = get_unaligned_be32(cmd + 28);
3927 if (unlikely(have_dif_prot && check_prot)) {
3928 if (sdebug_dif == T10_PI_TYPE2_PROTECTION &&
3930 mk_sense_invalid_opcode(scp);
3931 return check_condition_result;
3933 if ((sdebug_dif == T10_PI_TYPE1_PROTECTION ||
3934 sdebug_dif == T10_PI_TYPE3_PROTECTION) &&
3935 (cmd[1] & 0xe0) == 0)
3936 sdev_printk(KERN_ERR, scp->device, "Unprotected RD "
3939 if (unlikely((sdebug_opts & SDEBUG_OPT_SHORT_TRANSFER) &&
3940 atomic_read(&sdeb_inject_pending))) {
3942 atomic_set(&sdeb_inject_pending, 0);
3946 * When checking device access params, for reads we only check data
3947 * versus what is set at init time, so no need to lock.
3949 ret = check_device_access_params(scp, lba, num, false);
3952 if (unlikely((SDEBUG_OPT_MEDIUM_ERR & sdebug_opts) &&
3953 (lba <= (sdebug_medium_error_start + sdebug_medium_error_count - 1)) &&
3954 ((lba + num) > sdebug_medium_error_start))) {
3955 /* claim unrecoverable read error */
3956 mk_sense_buffer(scp, MEDIUM_ERROR, UNRECOVERED_READ_ERR, 0);
3957 /* set info field and valid bit for fixed descriptor */
3958 if (0x70 == (scp->sense_buffer[0] & 0x7f)) {
3959 scp->sense_buffer[0] |= 0x80; /* Valid bit */
3960 ret = (lba < OPT_MEDIUM_ERR_ADDR)
3961 ? OPT_MEDIUM_ERR_ADDR : (int)lba;
3962 put_unaligned_be32(ret, scp->sense_buffer + 3);
3964 scsi_set_resid(scp, scsi_bufflen(scp));
3965 return check_condition_result;
3968 if (sdebug_dev_is_zoned(devip) ||
3969 (sdebug_dix && scsi_prot_sg_count(scp))) {
3970 sdeb_meta_read_lock(sip);
3971 meta_data_locked = true;
3975 if (unlikely(sdebug_dix && scsi_prot_sg_count(scp))) {
3976 switch (prot_verify_read(scp, lba, num, ei_lba)) {
3977 case 1: /* Guard tag error */
3978 if (cmd[1] >> 5 != 3) { /* RDPROTECT != 3 */
3979 sdeb_meta_read_unlock(sip);
3980 mk_sense_buffer(scp, ABORTED_COMMAND, 0x10, 1);
3981 return check_condition_result;
3982 } else if (scp->prot_flags & SCSI_PROT_GUARD_CHECK) {
3983 sdeb_meta_read_unlock(sip);
3984 mk_sense_buffer(scp, ILLEGAL_REQUEST, 0x10, 1);
3985 return illegal_condition_result;
3988 case 3: /* Reference tag error */
3989 if (cmd[1] >> 5 != 3) { /* RDPROTECT != 3 */
3990 sdeb_meta_read_unlock(sip);
3991 mk_sense_buffer(scp, ABORTED_COMMAND, 0x10, 3);
3992 return check_condition_result;
3993 } else if (scp->prot_flags & SCSI_PROT_REF_CHECK) {
3994 sdeb_meta_read_unlock(sip);
3995 mk_sense_buffer(scp, ILLEGAL_REQUEST, 0x10, 3);
3996 return illegal_condition_result;
4002 ret = do_device_access(sip, scp, 0, lba, num, 0, false, false);
4003 if (meta_data_locked)
4004 sdeb_meta_read_unlock(sip);
4005 if (unlikely(ret == -1))
4006 return DID_ERROR << 16;
4008 scsi_set_resid(scp, scsi_bufflen(scp) - ret);
4010 if (unlikely((sdebug_opts & SDEBUG_OPT_RECOV_DIF_DIX) &&
4011 atomic_read(&sdeb_inject_pending))) {
4012 if (sdebug_opts & SDEBUG_OPT_RECOVERED_ERR) {
4013 mk_sense_buffer(scp, RECOVERED_ERROR, THRESHOLD_EXCEEDED, 0);
4014 atomic_set(&sdeb_inject_pending, 0);
4015 return check_condition_result;
4016 } else if (sdebug_opts & SDEBUG_OPT_DIF_ERR) {
4017 /* Logical block guard check failed */
4018 mk_sense_buffer(scp, ABORTED_COMMAND, 0x10, 1);
4019 atomic_set(&sdeb_inject_pending, 0);
4020 return illegal_condition_result;
4021 } else if (SDEBUG_OPT_DIX_ERR & sdebug_opts) {
4022 mk_sense_buffer(scp, ILLEGAL_REQUEST, 0x10, 1);
4023 atomic_set(&sdeb_inject_pending, 0);
4024 return illegal_condition_result;
4030 static int prot_verify_write(struct scsi_cmnd *SCpnt, sector_t start_sec,
4031 unsigned int sectors, u32 ei_lba)
4034 struct t10_pi_tuple *sdt;
4036 sector_t sector = start_sec;
4039 struct sg_mapping_iter diter;
4040 struct sg_mapping_iter piter;
4042 BUG_ON(scsi_sg_count(SCpnt) == 0);
4043 BUG_ON(scsi_prot_sg_count(SCpnt) == 0);
4045 sg_miter_start(&piter, scsi_prot_sglist(SCpnt),
4046 scsi_prot_sg_count(SCpnt),
4047 SG_MITER_ATOMIC | SG_MITER_FROM_SG);
4048 sg_miter_start(&diter, scsi_sglist(SCpnt), scsi_sg_count(SCpnt),
4049 SG_MITER_ATOMIC | SG_MITER_FROM_SG);
4051 /* For each protection page */
4052 while (sg_miter_next(&piter)) {
4054 if (WARN_ON(!sg_miter_next(&diter))) {
4059 for (ppage_offset = 0; ppage_offset < piter.length;
4060 ppage_offset += sizeof(struct t10_pi_tuple)) {
4061 /* If we're at the end of the current
4062 * data page advance to the next one
4064 if (dpage_offset >= diter.length) {
4065 if (WARN_ON(!sg_miter_next(&diter))) {
4072 sdt = piter.addr + ppage_offset;
4073 daddr = diter.addr + dpage_offset;
4075 if (SCpnt->cmnd[1] >> 5 != 3) { /* WRPROTECT */
4076 ret = dif_verify(sdt, daddr, sector, ei_lba);
4083 dpage_offset += sdebug_sector_size;
4085 diter.consumed = dpage_offset;
4086 sg_miter_stop(&diter);
4088 sg_miter_stop(&piter);
4090 dif_copy_prot(SCpnt, start_sec, sectors, false);
4097 sg_miter_stop(&diter);
4098 sg_miter_stop(&piter);
4102 static unsigned long lba_to_map_index(sector_t lba)
4104 if (sdebug_unmap_alignment)
4105 lba += sdebug_unmap_granularity - sdebug_unmap_alignment;
4106 sector_div(lba, sdebug_unmap_granularity);
4110 static sector_t map_index_to_lba(unsigned long index)
4112 sector_t lba = index * sdebug_unmap_granularity;
4114 if (sdebug_unmap_alignment)
4115 lba -= sdebug_unmap_granularity - sdebug_unmap_alignment;
4119 static unsigned int map_state(struct sdeb_store_info *sip, sector_t lba,
4123 unsigned int mapped;
4124 unsigned long index;
4127 index = lba_to_map_index(lba);
4128 mapped = test_bit(index, sip->map_storep);
4131 next = find_next_zero_bit(sip->map_storep, map_size, index);
4133 next = find_next_bit(sip->map_storep, map_size, index);
4135 end = min_t(sector_t, sdebug_store_sectors, map_index_to_lba(next));
4140 static void map_region(struct sdeb_store_info *sip, sector_t lba,
4143 sector_t end = lba + len;
4146 unsigned long index = lba_to_map_index(lba);
4148 if (index < map_size)
4149 set_bit(index, sip->map_storep);
4151 lba = map_index_to_lba(index + 1);
4155 static void unmap_region(struct sdeb_store_info *sip, sector_t lba,
4158 sector_t end = lba + len;
4159 u8 *fsp = sip->storep;
4162 unsigned long index = lba_to_map_index(lba);
4164 if (lba == map_index_to_lba(index) &&
4165 lba + sdebug_unmap_granularity <= end &&
4167 clear_bit(index, sip->map_storep);
4168 if (sdebug_lbprz) { /* for LBPRZ=2 return 0xff_s */
4169 memset(fsp + lba * sdebug_sector_size,
4170 (sdebug_lbprz & 1) ? 0 : 0xff,
4171 sdebug_sector_size *
4172 sdebug_unmap_granularity);
4174 if (sip->dif_storep) {
4175 memset(sip->dif_storep + lba, 0xff,
4176 sizeof(*sip->dif_storep) *
4177 sdebug_unmap_granularity);
4180 lba = map_index_to_lba(index + 1);
4184 static int resp_write_dt0(struct scsi_cmnd *scp, struct sdebug_dev_info *devip)
4192 struct sdeb_store_info *sip = devip2sip(devip, true);
4193 u8 *cmd = scp->cmnd;
4194 bool meta_data_locked = false;
4199 lba = get_unaligned_be64(cmd + 2);
4200 num = get_unaligned_be32(cmd + 10);
4201 group = cmd[14] & 0x3f;
4206 lba = get_unaligned_be32(cmd + 2);
4207 group = cmd[6] & 0x3f;
4208 num = get_unaligned_be16(cmd + 7);
4213 lba = (u32)cmd[3] | (u32)cmd[2] << 8 |
4214 (u32)(cmd[1] & 0x1f) << 16;
4215 num = (0 == cmd[4]) ? 256 : cmd[4];
4220 lba = get_unaligned_be32(cmd + 2);
4221 num = get_unaligned_be32(cmd + 6);
4222 group = cmd[6] & 0x3f;
4225 case 0x53: /* XDWRITEREAD(10) */
4227 lba = get_unaligned_be32(cmd + 2);
4228 group = cmd[6] & 0x1f;
4229 num = get_unaligned_be16(cmd + 7);
4232 default: /* assume WRITE(32) */
4233 group = cmd[6] & 0x3f;
4234 lba = get_unaligned_be64(cmd + 12);
4235 ei_lba = get_unaligned_be32(cmd + 20);
4236 num = get_unaligned_be32(cmd + 28);
4240 if (unlikely(have_dif_prot && check_prot)) {
4241 if (sdebug_dif == T10_PI_TYPE2_PROTECTION &&
4243 mk_sense_invalid_opcode(scp);
4244 return check_condition_result;
4246 if ((sdebug_dif == T10_PI_TYPE1_PROTECTION ||
4247 sdebug_dif == T10_PI_TYPE3_PROTECTION) &&
4248 (cmd[1] & 0xe0) == 0)
4249 sdev_printk(KERN_ERR, scp->device, "Unprotected WR "
4253 if (sdebug_dev_is_zoned(devip) ||
4254 (sdebug_dix && scsi_prot_sg_count(scp)) ||
4256 sdeb_meta_write_lock(sip);
4257 meta_data_locked = true;
4260 ret = check_device_access_params(scp, lba, num, true);
4262 if (meta_data_locked)
4263 sdeb_meta_write_unlock(sip);
4268 if (unlikely(sdebug_dix && scsi_prot_sg_count(scp))) {
4269 switch (prot_verify_write(scp, lba, num, ei_lba)) {
4270 case 1: /* Guard tag error */
4271 if (scp->prot_flags & SCSI_PROT_GUARD_CHECK) {
4272 sdeb_meta_write_unlock(sip);
4273 mk_sense_buffer(scp, ILLEGAL_REQUEST, 0x10, 1);
4274 return illegal_condition_result;
4275 } else if (scp->cmnd[1] >> 5 != 3) { /* WRPROTECT != 3 */
4276 sdeb_meta_write_unlock(sip);
4277 mk_sense_buffer(scp, ABORTED_COMMAND, 0x10, 1);
4278 return check_condition_result;
4281 case 3: /* Reference tag error */
4282 if (scp->prot_flags & SCSI_PROT_REF_CHECK) {
4283 sdeb_meta_write_unlock(sip);
4284 mk_sense_buffer(scp, ILLEGAL_REQUEST, 0x10, 3);
4285 return illegal_condition_result;
4286 } else if (scp->cmnd[1] >> 5 != 3) { /* WRPROTECT != 3 */
4287 sdeb_meta_write_unlock(sip);
4288 mk_sense_buffer(scp, ABORTED_COMMAND, 0x10, 3);
4289 return check_condition_result;
4295 ret = do_device_access(sip, scp, 0, lba, num, group, true, false);
4296 if (unlikely(scsi_debug_lbp()))
4297 map_region(sip, lba, num);
4299 /* If ZBC zone then bump its write pointer */
4300 if (sdebug_dev_is_zoned(devip))
4301 zbc_inc_wp(devip, lba, num);
4302 if (meta_data_locked)
4303 sdeb_meta_write_unlock(sip);
4305 if (unlikely(-1 == ret))
4306 return DID_ERROR << 16;
4307 else if (unlikely(sdebug_verbose &&
4308 (ret < (num * sdebug_sector_size))))
4309 sdev_printk(KERN_INFO, scp->device,
4310 "%s: write: cdb indicated=%u, IO sent=%d bytes\n",
4311 my_name, num * sdebug_sector_size, ret);
4313 if (unlikely((sdebug_opts & SDEBUG_OPT_RECOV_DIF_DIX) &&
4314 atomic_read(&sdeb_inject_pending))) {
4315 if (sdebug_opts & SDEBUG_OPT_RECOVERED_ERR) {
4316 mk_sense_buffer(scp, RECOVERED_ERROR, THRESHOLD_EXCEEDED, 0);
4317 atomic_set(&sdeb_inject_pending, 0);
4318 return check_condition_result;
4319 } else if (sdebug_opts & SDEBUG_OPT_DIF_ERR) {
4320 /* Logical block guard check failed */
4321 mk_sense_buffer(scp, ABORTED_COMMAND, 0x10, 1);
4322 atomic_set(&sdeb_inject_pending, 0);
4323 return illegal_condition_result;
4324 } else if (sdebug_opts & SDEBUG_OPT_DIX_ERR) {
4325 mk_sense_buffer(scp, ILLEGAL_REQUEST, 0x10, 1);
4326 atomic_set(&sdeb_inject_pending, 0);
4327 return illegal_condition_result;
4334 * T10 has only specified WRITE SCATTERED(16) and WRITE SCATTERED(32).
4335 * No READ GATHERED yet (requires bidi or long cdb holding gather list).
4337 static int resp_write_scat(struct scsi_cmnd *scp,
4338 struct sdebug_dev_info *devip)
4340 u8 *cmd = scp->cmnd;
4343 struct sdeb_store_info *sip = devip2sip(devip, true);
4345 u16 lbdof, num_lrd, k;
4346 u32 num, num_by, bt_len, lbdof_blen, sg_off, cum_lb;
4347 u32 lb_size = sdebug_sector_size;
4353 static const u32 lrd_size = 32; /* + parameter list header size */
4355 if (cmd[0] == VARIABLE_LENGTH_CMD) {
4357 group = cmd[6] & 0x3f;
4358 wrprotect = (cmd[10] >> 5) & 0x7;
4359 lbdof = get_unaligned_be16(cmd + 12);
4360 num_lrd = get_unaligned_be16(cmd + 16);
4361 bt_len = get_unaligned_be32(cmd + 28);
4362 } else { /* that leaves WRITE SCATTERED(16) */
4364 wrprotect = (cmd[2] >> 5) & 0x7;
4365 lbdof = get_unaligned_be16(cmd + 4);
4366 num_lrd = get_unaligned_be16(cmd + 8);
4367 bt_len = get_unaligned_be32(cmd + 10);
4368 group = cmd[14] & 0x3f;
4369 if (unlikely(have_dif_prot)) {
4370 if (sdebug_dif == T10_PI_TYPE2_PROTECTION &&
4372 mk_sense_invalid_opcode(scp);
4373 return illegal_condition_result;
4375 if ((sdebug_dif == T10_PI_TYPE1_PROTECTION ||
4376 sdebug_dif == T10_PI_TYPE3_PROTECTION) &&
4378 sdev_printk(KERN_ERR, scp->device,
4379 "Unprotected WR to DIF device\n");
4382 if ((num_lrd == 0) || (bt_len == 0))
4383 return 0; /* T10 says these do-nothings are not errors */
4386 sdev_printk(KERN_INFO, scp->device,
4387 "%s: %s: LB Data Offset field bad\n",
4389 mk_sense_buffer(scp, ILLEGAL_REQUEST, INVALID_FIELD_IN_CDB, 0);
4390 return illegal_condition_result;
4392 lbdof_blen = lbdof * lb_size;
4393 if ((lrd_size + (num_lrd * lrd_size)) > lbdof_blen) {
4395 sdev_printk(KERN_INFO, scp->device,
4396 "%s: %s: LBA range descriptors don't fit\n",
4398 mk_sense_buffer(scp, ILLEGAL_REQUEST, INVALID_FIELD_IN_CDB, 0);
4399 return illegal_condition_result;
4401 lrdp = kzalloc(lbdof_blen, GFP_ATOMIC | __GFP_NOWARN);
4403 return SCSI_MLQUEUE_HOST_BUSY;
4405 sdev_printk(KERN_INFO, scp->device,
4406 "%s: %s: Fetch header+scatter_list, lbdof_blen=%u\n",
4407 my_name, __func__, lbdof_blen);
4408 res = fetch_to_dev_buffer(scp, lrdp, lbdof_blen);
4410 ret = DID_ERROR << 16;
4414 /* Just keep it simple and always lock for now */
4415 sdeb_meta_write_lock(sip);
4416 sg_off = lbdof_blen;
4417 /* Spec says Buffer xfer Length field in number of LBs in dout */
4419 for (k = 0, up = lrdp + lrd_size; k < num_lrd; ++k, up += lrd_size) {
4420 lba = get_unaligned_be64(up + 0);
4421 num = get_unaligned_be32(up + 8);
4423 sdev_printk(KERN_INFO, scp->device,
4424 "%s: %s: k=%d LBA=0x%llx num=%u sg_off=%u\n",
4425 my_name, __func__, k, lba, num, sg_off);
4428 ret = check_device_access_params(scp, lba, num, true);
4430 goto err_out_unlock;
4431 num_by = num * lb_size;
4432 ei_lba = is_16 ? 0 : get_unaligned_be32(up + 12);
4434 if ((cum_lb + num) > bt_len) {
4436 sdev_printk(KERN_INFO, scp->device,
4437 "%s: %s: sum of blocks > data provided\n",
4439 mk_sense_buffer(scp, ILLEGAL_REQUEST, WRITE_ERROR_ASC,
4441 ret = illegal_condition_result;
4442 goto err_out_unlock;
4446 if (unlikely(sdebug_dix && scsi_prot_sg_count(scp))) {
4447 int prot_ret = prot_verify_write(scp, lba, num,
4451 mk_sense_buffer(scp, ILLEGAL_REQUEST, 0x10,
4453 ret = illegal_condition_result;
4454 goto err_out_unlock;
4459 * Write ranges atomically to keep as close to pre-atomic
4460 * writes behaviour as possible.
4462 ret = do_device_access(sip, scp, sg_off, lba, num, group, true, true);
4463 /* If ZBC zone then bump its write pointer */
4464 if (sdebug_dev_is_zoned(devip))
4465 zbc_inc_wp(devip, lba, num);
4466 if (unlikely(scsi_debug_lbp()))
4467 map_region(sip, lba, num);
4468 if (unlikely(-1 == ret)) {
4469 ret = DID_ERROR << 16;
4470 goto err_out_unlock;
4471 } else if (unlikely(sdebug_verbose && (ret < num_by)))
4472 sdev_printk(KERN_INFO, scp->device,
4473 "%s: write: cdb indicated=%u, IO sent=%d bytes\n",
4474 my_name, num_by, ret);
4476 if (unlikely((sdebug_opts & SDEBUG_OPT_RECOV_DIF_DIX) &&
4477 atomic_read(&sdeb_inject_pending))) {
4478 if (sdebug_opts & SDEBUG_OPT_RECOVERED_ERR) {
4479 mk_sense_buffer(scp, RECOVERED_ERROR, THRESHOLD_EXCEEDED, 0);
4480 atomic_set(&sdeb_inject_pending, 0);
4481 ret = check_condition_result;
4482 goto err_out_unlock;
4483 } else if (sdebug_opts & SDEBUG_OPT_DIF_ERR) {
4484 /* Logical block guard check failed */
4485 mk_sense_buffer(scp, ABORTED_COMMAND, 0x10, 1);
4486 atomic_set(&sdeb_inject_pending, 0);
4487 ret = illegal_condition_result;
4488 goto err_out_unlock;
4489 } else if (sdebug_opts & SDEBUG_OPT_DIX_ERR) {
4490 mk_sense_buffer(scp, ILLEGAL_REQUEST, 0x10, 1);
4491 atomic_set(&sdeb_inject_pending, 0);
4492 ret = illegal_condition_result;
4493 goto err_out_unlock;
4501 sdeb_meta_write_unlock(sip);
4507 static int resp_write_same(struct scsi_cmnd *scp, u64 lba, u32 num,
4508 u32 ei_lba, bool unmap, bool ndob)
4510 struct scsi_device *sdp = scp->device;
4511 struct sdebug_dev_info *devip = (struct sdebug_dev_info *)sdp->hostdata;
4512 unsigned long long i;
4514 u32 lb_size = sdebug_sector_size;
4516 struct sdeb_store_info *sip = devip2sip((struct sdebug_dev_info *)
4517 scp->device->hostdata, true);
4520 bool meta_data_locked = false;
4522 if (sdebug_dev_is_zoned(devip) || scsi_debug_lbp()) {
4523 sdeb_meta_write_lock(sip);
4524 meta_data_locked = true;
4527 ret = check_device_access_params(scp, lba, num, true);
4531 if (unmap && scsi_debug_lbp()) {
4532 unmap_region(sip, lba, num);
4536 block = do_div(lbaa, sdebug_store_sectors);
4537 /* if ndob then zero 1 logical block, else fetch 1 logical block */
4539 fs1p = fsp + (block * lb_size);
4540 sdeb_data_write_lock(sip);
4542 memset(fs1p, 0, lb_size);
4545 ret = fetch_to_dev_buffer(scp, fs1p, lb_size);
4548 ret = DID_ERROR << 16;
4550 } else if (sdebug_verbose && !ndob && (ret < lb_size))
4551 sdev_printk(KERN_INFO, scp->device,
4552 "%s: %s: lb size=%u, IO sent=%d bytes\n",
4553 my_name, "write same", lb_size, ret);
4555 /* Copy first sector to remaining blocks */
4556 for (i = 1 ; i < num ; i++) {
4558 block = do_div(lbaa, sdebug_store_sectors);
4559 memmove(fsp + (block * lb_size), fs1p, lb_size);
4561 if (scsi_debug_lbp())
4562 map_region(sip, lba, num);
4563 /* If ZBC zone then bump its write pointer */
4564 if (sdebug_dev_is_zoned(devip))
4565 zbc_inc_wp(devip, lba, num);
4566 sdeb_data_write_unlock(sip);
4569 if (meta_data_locked)
4570 sdeb_meta_write_unlock(sip);
4574 static int resp_write_same_10(struct scsi_cmnd *scp,
4575 struct sdebug_dev_info *devip)
4577 u8 *cmd = scp->cmnd;
4584 if (sdebug_lbpws10 == 0) {
4585 mk_sense_invalid_fld(scp, SDEB_IN_CDB, 1, 3);
4586 return check_condition_result;
4590 lba = get_unaligned_be32(cmd + 2);
4591 num = get_unaligned_be16(cmd + 7);
4592 if (num > sdebug_write_same_length) {
4593 mk_sense_invalid_fld(scp, SDEB_IN_CDB, 7, -1);
4594 return check_condition_result;
4596 return resp_write_same(scp, lba, num, ei_lba, unmap, false);
4599 static int resp_write_same_16(struct scsi_cmnd *scp,
4600 struct sdebug_dev_info *devip)
4602 u8 *cmd = scp->cmnd;
4609 if (cmd[1] & 0x8) { /* UNMAP */
4610 if (sdebug_lbpws == 0) {
4611 mk_sense_invalid_fld(scp, SDEB_IN_CDB, 1, 3);
4612 return check_condition_result;
4616 if (cmd[1] & 0x1) /* NDOB (no data-out buffer, assumes zeroes) */
4618 lba = get_unaligned_be64(cmd + 2);
4619 num = get_unaligned_be32(cmd + 10);
4620 if (num > sdebug_write_same_length) {
4621 mk_sense_invalid_fld(scp, SDEB_IN_CDB, 10, -1);
4622 return check_condition_result;
4624 return resp_write_same(scp, lba, num, ei_lba, unmap, ndob);
4627 /* Note the mode field is in the same position as the (lower) service action
4628 * field. For the Report supported operation codes command, SPC-4 suggests
4629 * each mode of this command should be reported separately; for future. */
4630 static int resp_write_buffer(struct scsi_cmnd *scp,
4631 struct sdebug_dev_info *devip)
4633 u8 *cmd = scp->cmnd;
4634 struct scsi_device *sdp = scp->device;
4635 struct sdebug_dev_info *dp;
4638 mode = cmd[1] & 0x1f;
4640 case 0x4: /* download microcode (MC) and activate (ACT) */
4641 /* set UAs on this device only */
4642 set_bit(SDEBUG_UA_BUS_RESET, devip->uas_bm);
4643 set_bit(SDEBUG_UA_MICROCODE_CHANGED, devip->uas_bm);
4645 case 0x5: /* download MC, save and ACT */
4646 set_bit(SDEBUG_UA_MICROCODE_CHANGED_WO_RESET, devip->uas_bm);
4648 case 0x6: /* download MC with offsets and ACT */
4649 /* set UAs on most devices (LUs) in this target */
4650 list_for_each_entry(dp,
4651 &devip->sdbg_host->dev_info_list,
4653 if (dp->target == sdp->id) {
4654 set_bit(SDEBUG_UA_BUS_RESET, dp->uas_bm);
4656 set_bit(SDEBUG_UA_MICROCODE_CHANGED,
4660 case 0x7: /* download MC with offsets, save, and ACT */
4661 /* set UA on all devices (LUs) in this target */
4662 list_for_each_entry(dp,
4663 &devip->sdbg_host->dev_info_list,
4665 if (dp->target == sdp->id)
4666 set_bit(SDEBUG_UA_MICROCODE_CHANGED_WO_RESET,
4670 /* do nothing for this command for other mode values */
4676 static int resp_comp_write(struct scsi_cmnd *scp,
4677 struct sdebug_dev_info *devip)
4679 u8 *cmd = scp->cmnd;
4681 struct sdeb_store_info *sip = devip2sip(devip, true);
4684 u32 lb_size = sdebug_sector_size;
4689 lba = get_unaligned_be64(cmd + 2);
4690 num = cmd[13]; /* 1 to a maximum of 255 logical blocks */
4692 return 0; /* degenerate case, not an error */
4693 if (sdebug_dif == T10_PI_TYPE2_PROTECTION &&
4695 mk_sense_invalid_opcode(scp);
4696 return check_condition_result;
4698 if ((sdebug_dif == T10_PI_TYPE1_PROTECTION ||
4699 sdebug_dif == T10_PI_TYPE3_PROTECTION) &&
4700 (cmd[1] & 0xe0) == 0)
4701 sdev_printk(KERN_ERR, scp->device, "Unprotected WR "
4703 ret = check_device_access_params(scp, lba, num, false);
4707 arr = kcalloc(lb_size, dnum, GFP_ATOMIC);
4709 mk_sense_buffer(scp, ILLEGAL_REQUEST, INSUFF_RES_ASC,
4711 return check_condition_result;
4714 ret = do_dout_fetch(scp, dnum, arr);
4716 retval = DID_ERROR << 16;
4718 } else if (sdebug_verbose && (ret < (dnum * lb_size)))
4719 sdev_printk(KERN_INFO, scp->device, "%s: compare_write: cdb "
4720 "indicated=%u, IO sent=%d bytes\n", my_name,
4721 dnum * lb_size, ret);
4723 sdeb_data_write_lock(sip);
4724 sdeb_meta_write_lock(sip);
4725 if (!comp_write_worker(sip, lba, num, arr, false)) {
4726 mk_sense_buffer(scp, MISCOMPARE, MISCOMPARE_VERIFY_ASC, 0);
4727 retval = check_condition_result;
4728 goto cleanup_unlock;
4731 /* Cover sip->map_storep (which map_region()) sets with data lock */
4732 if (scsi_debug_lbp())
4733 map_region(sip, lba, num);
4735 sdeb_meta_write_unlock(sip);
4736 sdeb_data_write_unlock(sip);
4742 struct unmap_block_desc {
4748 static int resp_unmap(struct scsi_cmnd *scp, struct sdebug_dev_info *devip)
4751 struct unmap_block_desc *desc;
4752 struct sdeb_store_info *sip = devip2sip(devip, true);
4753 unsigned int i, payload_len, descriptors;
4756 if (!scsi_debug_lbp())
4757 return 0; /* fib and say its done */
4758 payload_len = get_unaligned_be16(scp->cmnd + 7);
4759 BUG_ON(scsi_bufflen(scp) != payload_len);
4761 descriptors = (payload_len - 8) / 16;
4762 if (descriptors > sdebug_unmap_max_desc) {
4763 mk_sense_invalid_fld(scp, SDEB_IN_CDB, 7, -1);
4764 return check_condition_result;
4767 buf = kzalloc(scsi_bufflen(scp), GFP_ATOMIC);
4769 mk_sense_buffer(scp, ILLEGAL_REQUEST, INSUFF_RES_ASC,
4771 return check_condition_result;
4774 scsi_sg_copy_to_buffer(scp, buf, scsi_bufflen(scp));
4776 BUG_ON(get_unaligned_be16(&buf[0]) != payload_len - 2);
4777 BUG_ON(get_unaligned_be16(&buf[2]) != descriptors * 16);
4779 desc = (void *)&buf[8];
4781 sdeb_meta_write_lock(sip);
4783 for (i = 0 ; i < descriptors ; i++) {
4784 unsigned long long lba = get_unaligned_be64(&desc[i].lba);
4785 unsigned int num = get_unaligned_be32(&desc[i].blocks);
4787 ret = check_device_access_params(scp, lba, num, true);
4791 unmap_region(sip, lba, num);
4797 sdeb_meta_write_unlock(sip);
4803 #define SDEBUG_GET_LBA_STATUS_LEN 32
4805 static int resp_get_lba_status(struct scsi_cmnd *scp,
4806 struct sdebug_dev_info *devip)
4808 u8 *cmd = scp->cmnd;
4810 u32 alloc_len, mapped, num;
4812 u8 arr[SDEBUG_GET_LBA_STATUS_LEN];
4814 lba = get_unaligned_be64(cmd + 2);
4815 alloc_len = get_unaligned_be32(cmd + 10);
4820 ret = check_device_access_params(scp, lba, 1, false);
4824 if (scsi_debug_lbp()) {
4825 struct sdeb_store_info *sip = devip2sip(devip, true);
4827 mapped = map_state(sip, lba, &num);
4830 /* following just in case virtual_gb changed */
4831 sdebug_capacity = get_sdebug_capacity();
4832 if (sdebug_capacity - lba <= 0xffffffff)
4833 num = sdebug_capacity - lba;
4838 memset(arr, 0, SDEBUG_GET_LBA_STATUS_LEN);
4839 put_unaligned_be32(20, arr); /* Parameter Data Length */
4840 put_unaligned_be64(lba, arr + 8); /* LBA */
4841 put_unaligned_be32(num, arr + 16); /* Number of blocks */
4842 arr[20] = !mapped; /* prov_stat=0: mapped; 1: dealloc */
4844 return fill_from_dev_buffer(scp, arr, SDEBUG_GET_LBA_STATUS_LEN);
4847 static int resp_get_stream_status(struct scsi_cmnd *scp,
4848 struct sdebug_dev_info *devip)
4850 u16 starting_stream_id, stream_id;
4851 const u8 *cmd = scp->cmnd;
4852 u32 alloc_len, offset;
4854 struct scsi_stream_status_header *h = (void *)arr;
4856 starting_stream_id = get_unaligned_be16(cmd + 4);
4857 alloc_len = get_unaligned_be32(cmd + 10);
4859 if (alloc_len < 8) {
4860 mk_sense_invalid_fld(scp, SDEB_IN_CDB, 10, -1);
4861 return check_condition_result;
4864 if (starting_stream_id >= MAXIMUM_NUMBER_OF_STREAMS) {
4865 mk_sense_invalid_fld(scp, SDEB_IN_CDB, 4, -1);
4866 return check_condition_result;
4870 * The GET STREAM STATUS command only reports status information
4871 * about open streams. Treat the non-permanent stream as open.
4873 put_unaligned_be16(MAXIMUM_NUMBER_OF_STREAMS,
4874 &h->number_of_open_streams);
4876 for (offset = 8, stream_id = starting_stream_id;
4877 offset + 8 <= min_t(u32, alloc_len, sizeof(arr)) &&
4878 stream_id < MAXIMUM_NUMBER_OF_STREAMS;
4879 offset += 8, stream_id++) {
4880 struct scsi_stream_status *stream_status = (void *)arr + offset;
4882 stream_status->perm = stream_id < PERMANENT_STREAM_COUNT;
4883 put_unaligned_be16(stream_id,
4884 &stream_status->stream_identifier);
4885 stream_status->rel_lifetime = stream_id + 1;
4887 put_unaligned_be32(offset - 8, &h->len); /* PARAMETER DATA LENGTH */
4889 return fill_from_dev_buffer(scp, arr, min(offset, alloc_len));
4892 static int resp_sync_cache(struct scsi_cmnd *scp,
4893 struct sdebug_dev_info *devip)
4898 u8 *cmd = scp->cmnd;
4900 if (cmd[0] == SYNCHRONIZE_CACHE) { /* 10 byte cdb */
4901 lba = get_unaligned_be32(cmd + 2);
4902 num_blocks = get_unaligned_be16(cmd + 7);
4903 } else { /* SYNCHRONIZE_CACHE(16) */
4904 lba = get_unaligned_be64(cmd + 2);
4905 num_blocks = get_unaligned_be32(cmd + 10);
4907 if (lba + num_blocks > sdebug_capacity) {
4908 mk_sense_buffer(scp, ILLEGAL_REQUEST, LBA_OUT_OF_RANGE, 0);
4909 return check_condition_result;
4911 if (!write_since_sync || (cmd[1] & 0x2))
4912 res = SDEG_RES_IMMED_MASK;
4913 else /* delay if write_since_sync and IMMED clear */
4914 write_since_sync = false;
4919 * Assuming the LBA+num_blocks is not out-of-range, this function will return
4920 * CONDITION MET if the specified blocks will/have fitted in the cache, and
4921 * a GOOD status otherwise. Model a disk with a big cache and yield
4922 * CONDITION MET. Actually tries to bring range in main memory into the
4923 * cache associated with the CPU(s).
4925 static int resp_pre_fetch(struct scsi_cmnd *scp,
4926 struct sdebug_dev_info *devip)
4930 u64 block, rest = 0;
4932 u8 *cmd = scp->cmnd;
4933 struct sdeb_store_info *sip = devip2sip(devip, true);
4934 u8 *fsp = sip->storep;
4936 if (cmd[0] == PRE_FETCH) { /* 10 byte cdb */
4937 lba = get_unaligned_be32(cmd + 2);
4938 nblks = get_unaligned_be16(cmd + 7);
4939 } else { /* PRE-FETCH(16) */
4940 lba = get_unaligned_be64(cmd + 2);
4941 nblks = get_unaligned_be32(cmd + 10);
4943 if (lba + nblks > sdebug_capacity) {
4944 mk_sense_buffer(scp, ILLEGAL_REQUEST, LBA_OUT_OF_RANGE, 0);
4945 return check_condition_result;
4949 /* PRE-FETCH spec says nothing about LBP or PI so skip them */
4950 block = do_div(lba, sdebug_store_sectors);
4951 if (block + nblks > sdebug_store_sectors)
4952 rest = block + nblks - sdebug_store_sectors;
4954 /* Try to bring the PRE-FETCH range into CPU's cache */
4955 sdeb_data_read_lock(sip);
4956 prefetch_range(fsp + (sdebug_sector_size * block),
4957 (nblks - rest) * sdebug_sector_size);
4959 prefetch_range(fsp, rest * sdebug_sector_size);
4961 sdeb_data_read_unlock(sip);
4964 res = SDEG_RES_IMMED_MASK;
4965 return res | condition_met_result;
4968 #define RL_BUCKET_ELEMS 8
4970 /* Even though each pseudo target has a REPORT LUNS "well known logical unit"
4971 * (W-LUN), the normal Linux scanning logic does not associate it with a
4972 * device (e.g. /dev/sg7). The following magic will make that association:
4973 * "cd /sys/class/scsi_host/host<n> ; echo '- - 49409' > scan"
4974 * where <n> is a host number. If there are multiple targets in a host then
4975 * the above will associate a W-LUN to each target. To only get a W-LUN
4976 * for target 2, then use "echo '- 2 49409' > scan" .
4978 static int resp_report_luns(struct scsi_cmnd *scp,
4979 struct sdebug_dev_info *devip)
4981 unsigned char *cmd = scp->cmnd;
4982 unsigned int alloc_len;
4983 unsigned char select_report;
4985 struct scsi_lun *lun_p;
4986 u8 arr[RL_BUCKET_ELEMS * sizeof(struct scsi_lun)];
4987 unsigned int lun_cnt; /* normal LUN count (max: 256) */
4988 unsigned int wlun_cnt; /* report luns W-LUN count */
4989 unsigned int tlun_cnt; /* total LUN count */
4990 unsigned int rlen; /* response length (in bytes) */
4992 unsigned int off_rsp = 0;
4993 const int sz_lun = sizeof(struct scsi_lun);
4995 clear_luns_changed_on_target(devip);
4997 select_report = cmd[2];
4998 alloc_len = get_unaligned_be32(cmd + 6);
5000 if (alloc_len < 4) {
5001 pr_err("alloc len too small %d\n", alloc_len);
5002 mk_sense_invalid_fld(scp, SDEB_IN_CDB, 6, -1);
5003 return check_condition_result;
5006 switch (select_report) {
5007 case 0: /* all LUNs apart from W-LUNs */
5008 lun_cnt = sdebug_max_luns;
5011 case 1: /* only W-LUNs */
5015 case 2: /* all LUNs */
5016 lun_cnt = sdebug_max_luns;
5019 case 0x10: /* only administrative LUs */
5020 case 0x11: /* see SPC-5 */
5021 case 0x12: /* only subsiduary LUs owned by referenced LU */
5023 pr_debug("select report invalid %d\n", select_report);
5024 mk_sense_invalid_fld(scp, SDEB_IN_CDB, 2, -1);
5025 return check_condition_result;
5028 if (sdebug_no_lun_0 && (lun_cnt > 0))
5031 tlun_cnt = lun_cnt + wlun_cnt;
5032 rlen = tlun_cnt * sz_lun; /* excluding 8 byte header */
5033 scsi_set_resid(scp, scsi_bufflen(scp));
5034 pr_debug("select_report %d luns = %d wluns = %d no_lun0 %d\n",
5035 select_report, lun_cnt, wlun_cnt, sdebug_no_lun_0);
5037 /* loops rely on sizeof response header same as sizeof lun (both 8) */
5038 lun = sdebug_no_lun_0 ? 1 : 0;
5039 for (k = 0, j = 0, res = 0; true; ++k, j = 0) {
5040 memset(arr, 0, sizeof(arr));
5041 lun_p = (struct scsi_lun *)&arr[0];
5043 put_unaligned_be32(rlen, &arr[0]);
5047 for ( ; j < RL_BUCKET_ELEMS; ++j, ++lun_p) {
5048 if ((k * RL_BUCKET_ELEMS) + j > lun_cnt)
5050 int_to_scsilun(lun++, lun_p);
5051 if (lun > 1 && sdebug_lun_am == SAM_LUN_AM_FLAT)
5052 lun_p->scsi_lun[0] |= 0x40;
5054 if (j < RL_BUCKET_ELEMS)
5057 res = p_fill_from_dev_buffer(scp, arr, n, off_rsp);
5063 int_to_scsilun(SCSI_W_LUN_REPORT_LUNS, lun_p);
5067 res = p_fill_from_dev_buffer(scp, arr, j * sz_lun, off_rsp);
5071 static int resp_verify(struct scsi_cmnd *scp, struct sdebug_dev_info *devip)
5073 bool is_bytchk3 = false;
5076 u32 vnum, a_num, off;
5077 const u32 lb_size = sdebug_sector_size;
5080 u8 *cmd = scp->cmnd;
5081 struct sdeb_store_info *sip = devip2sip(devip, true);
5083 bytchk = (cmd[1] >> 1) & 0x3;
5085 return 0; /* always claim internal verify okay */
5086 } else if (bytchk == 2) {
5087 mk_sense_invalid_fld(scp, SDEB_IN_CDB, 2, 2);
5088 return check_condition_result;
5089 } else if (bytchk == 3) {
5090 is_bytchk3 = true; /* 1 block sent, compared repeatedly */
5094 lba = get_unaligned_be64(cmd + 2);
5095 vnum = get_unaligned_be32(cmd + 10);
5097 case VERIFY: /* is VERIFY(10) */
5098 lba = get_unaligned_be32(cmd + 2);
5099 vnum = get_unaligned_be16(cmd + 7);
5102 mk_sense_invalid_opcode(scp);
5103 return check_condition_result;
5106 return 0; /* not an error */
5107 a_num = is_bytchk3 ? 1 : vnum;
5108 /* Treat following check like one for read (i.e. no write) access */
5109 ret = check_device_access_params(scp, lba, a_num, false);
5113 arr = kcalloc(lb_size, vnum, GFP_ATOMIC | __GFP_NOWARN);
5115 mk_sense_buffer(scp, ILLEGAL_REQUEST, INSUFF_RES_ASC,
5117 return check_condition_result;
5119 /* Not changing store, so only need read access */
5120 sdeb_data_read_lock(sip);
5122 ret = do_dout_fetch(scp, a_num, arr);
5124 ret = DID_ERROR << 16;
5126 } else if (sdebug_verbose && (ret < (a_num * lb_size))) {
5127 sdev_printk(KERN_INFO, scp->device,
5128 "%s: %s: cdb indicated=%u, IO sent=%d bytes\n",
5129 my_name, __func__, a_num * lb_size, ret);
5132 for (j = 1, off = lb_size; j < vnum; ++j, off += lb_size)
5133 memcpy(arr + off, arr, lb_size);
5136 if (!comp_write_worker(sip, lba, vnum, arr, true)) {
5137 mk_sense_buffer(scp, MISCOMPARE, MISCOMPARE_VERIFY_ASC, 0);
5138 ret = check_condition_result;
5142 sdeb_data_read_unlock(sip);
5147 #define RZONES_DESC_HD 64
5149 /* Report zones depending on start LBA and reporting options */
5150 static int resp_report_zones(struct scsi_cmnd *scp,
5151 struct sdebug_dev_info *devip)
5153 unsigned int rep_max_zones, nrz = 0;
5155 u32 alloc_len, rep_opts, rep_len;
5158 u8 *arr = NULL, *desc;
5159 u8 *cmd = scp->cmnd;
5160 struct sdeb_zone_state *zsp = NULL;
5161 struct sdeb_store_info *sip = devip2sip(devip, false);
5163 if (!sdebug_dev_is_zoned(devip)) {
5164 mk_sense_invalid_opcode(scp);
5165 return check_condition_result;
5167 zs_lba = get_unaligned_be64(cmd + 2);
5168 alloc_len = get_unaligned_be32(cmd + 10);
5170 return 0; /* not an error */
5171 rep_opts = cmd[14] & 0x3f;
5172 partial = cmd[14] & 0x80;
5174 if (zs_lba >= sdebug_capacity) {
5175 mk_sense_buffer(scp, ILLEGAL_REQUEST, LBA_OUT_OF_RANGE, 0);
5176 return check_condition_result;
5179 rep_max_zones = (alloc_len - 64) >> ilog2(RZONES_DESC_HD);
5181 arr = kzalloc(alloc_len, GFP_ATOMIC | __GFP_NOWARN);
5183 mk_sense_buffer(scp, ILLEGAL_REQUEST, INSUFF_RES_ASC,
5185 return check_condition_result;
5188 sdeb_meta_read_lock(sip);
5191 for (lba = zs_lba; lba < sdebug_capacity;
5192 lba = zsp->z_start + zsp->z_size) {
5193 if (WARN_ONCE(zbc_zone(devip, lba) == zsp, "lba = %llu\n", lba))
5195 zsp = zbc_zone(devip, lba);
5202 if (zsp->z_cond != ZC1_EMPTY)
5206 /* Implicit open zones */
5207 if (zsp->z_cond != ZC2_IMPLICIT_OPEN)
5211 /* Explicit open zones */
5212 if (zsp->z_cond != ZC3_EXPLICIT_OPEN)
5217 if (zsp->z_cond != ZC4_CLOSED)
5222 if (zsp->z_cond != ZC5_FULL)
5229 * Read-only, offline, reset WP recommended are
5230 * not emulated: no zones to report;
5234 /* non-seq-resource set */
5235 if (!zsp->z_non_seq_resource)
5239 /* All zones except gap zones. */
5240 if (zbc_zone_is_gap(zsp))
5244 /* Not write pointer (conventional) zones */
5245 if (zbc_zone_is_seq(zsp))
5249 mk_sense_buffer(scp, ILLEGAL_REQUEST,
5250 INVALID_FIELD_IN_CDB, 0);
5251 ret = check_condition_result;
5255 if (nrz < rep_max_zones) {
5256 /* Fill zone descriptor */
5257 desc[0] = zsp->z_type;
5258 desc[1] = zsp->z_cond << 4;
5259 if (zsp->z_non_seq_resource)
5261 put_unaligned_be64((u64)zsp->z_size, desc + 8);
5262 put_unaligned_be64((u64)zsp->z_start, desc + 16);
5263 put_unaligned_be64((u64)zsp->z_wp, desc + 24);
5267 if (partial && nrz >= rep_max_zones)
5274 /* Zone list length. */
5275 put_unaligned_be32(nrz * RZONES_DESC_HD, arr + 0);
5277 put_unaligned_be64(sdebug_capacity - 1, arr + 8);
5278 /* Zone starting LBA granularity. */
5279 if (devip->zcap < devip->zsize)
5280 put_unaligned_be64(devip->zsize, arr + 16);
5282 rep_len = (unsigned long)desc - (unsigned long)arr;
5283 ret = fill_from_dev_buffer(scp, arr, min_t(u32, alloc_len, rep_len));
5286 sdeb_meta_read_unlock(sip);
5291 static int resp_atomic_write(struct scsi_cmnd *scp,
5292 struct sdebug_dev_info *devip)
5294 struct sdeb_store_info *sip;
5295 u8 *cmd = scp->cmnd;
5300 if (!scsi_debug_atomic_write()) {
5301 mk_sense_invalid_opcode(scp);
5302 return check_condition_result;
5305 sip = devip2sip(devip, true);
5307 lba = get_unaligned_be64(cmd + 2);
5308 boundary = get_unaligned_be16(cmd + 10);
5309 len = get_unaligned_be16(cmd + 12);
5312 if (sdebug_atomic_wr_align &&
5313 do_div(lba_tmp, sdebug_atomic_wr_align)) {
5314 /* Does not meet alignment requirement */
5315 mk_sense_buffer(scp, ILLEGAL_REQUEST, INVALID_FIELD_IN_CDB, 0);
5316 return check_condition_result;
5319 if (sdebug_atomic_wr_gran && len % sdebug_atomic_wr_gran) {
5320 /* Does not meet alignment requirement */
5321 mk_sense_buffer(scp, ILLEGAL_REQUEST, INVALID_FIELD_IN_CDB, 0);
5322 return check_condition_result;
5326 if (boundary > sdebug_atomic_wr_max_bndry) {
5327 mk_sense_invalid_fld(scp, SDEB_IN_CDB, 12, -1);
5328 return check_condition_result;
5331 if (len > sdebug_atomic_wr_max_length_bndry) {
5332 mk_sense_invalid_fld(scp, SDEB_IN_CDB, 12, -1);
5333 return check_condition_result;
5336 if (len > sdebug_atomic_wr_max_length) {
5337 mk_sense_invalid_fld(scp, SDEB_IN_CDB, 12, -1);
5338 return check_condition_result;
5342 ret = do_device_access(sip, scp, 0, lba, len, 0, true, true);
5343 if (unlikely(ret == -1))
5344 return DID_ERROR << 16;
5345 if (unlikely(ret != len * sdebug_sector_size))
5346 return DID_ERROR << 16;
5350 /* Logic transplanted from tcmu-runner, file_zbc.c */
5351 static void zbc_open_all(struct sdebug_dev_info *devip)
5353 struct sdeb_zone_state *zsp = &devip->zstate[0];
5356 for (i = 0; i < devip->nr_zones; i++, zsp++) {
5357 if (zsp->z_cond == ZC4_CLOSED)
5358 zbc_open_zone(devip, &devip->zstate[i], true);
5362 static int resp_open_zone(struct scsi_cmnd *scp, struct sdebug_dev_info *devip)
5366 enum sdebug_z_cond zc;
5367 u8 *cmd = scp->cmnd;
5368 struct sdeb_zone_state *zsp;
5369 bool all = cmd[14] & 0x01;
5370 struct sdeb_store_info *sip = devip2sip(devip, false);
5372 if (!sdebug_dev_is_zoned(devip)) {
5373 mk_sense_invalid_opcode(scp);
5374 return check_condition_result;
5376 sdeb_meta_write_lock(sip);
5379 /* Check if all closed zones can be open */
5380 if (devip->max_open &&
5381 devip->nr_exp_open + devip->nr_closed > devip->max_open) {
5382 mk_sense_buffer(scp, DATA_PROTECT, INSUFF_RES_ASC,
5384 res = check_condition_result;
5387 /* Open all closed zones */
5388 zbc_open_all(devip);
5392 /* Open the specified zone */
5393 z_id = get_unaligned_be64(cmd + 2);
5394 if (z_id >= sdebug_capacity) {
5395 mk_sense_buffer(scp, ILLEGAL_REQUEST, LBA_OUT_OF_RANGE, 0);
5396 res = check_condition_result;
5400 zsp = zbc_zone(devip, z_id);
5401 if (z_id != zsp->z_start) {
5402 mk_sense_buffer(scp, ILLEGAL_REQUEST, INVALID_FIELD_IN_CDB, 0);
5403 res = check_condition_result;
5406 if (zbc_zone_is_conv(zsp)) {
5407 mk_sense_buffer(scp, ILLEGAL_REQUEST, INVALID_FIELD_IN_CDB, 0);
5408 res = check_condition_result;
5413 if (zc == ZC3_EXPLICIT_OPEN || zc == ZC5_FULL)
5416 if (devip->max_open && devip->nr_exp_open >= devip->max_open) {
5417 mk_sense_buffer(scp, DATA_PROTECT, INSUFF_RES_ASC,
5419 res = check_condition_result;
5423 zbc_open_zone(devip, zsp, true);
5425 sdeb_meta_write_unlock(sip);
5429 static void zbc_close_all(struct sdebug_dev_info *devip)
5433 for (i = 0; i < devip->nr_zones; i++)
5434 zbc_close_zone(devip, &devip->zstate[i]);
5437 static int resp_close_zone(struct scsi_cmnd *scp,
5438 struct sdebug_dev_info *devip)
5442 u8 *cmd = scp->cmnd;
5443 struct sdeb_zone_state *zsp;
5444 bool all = cmd[14] & 0x01;
5445 struct sdeb_store_info *sip = devip2sip(devip, false);
5447 if (!sdebug_dev_is_zoned(devip)) {
5448 mk_sense_invalid_opcode(scp);
5449 return check_condition_result;
5452 sdeb_meta_write_lock(sip);
5455 zbc_close_all(devip);
5459 /* Close specified zone */
5460 z_id = get_unaligned_be64(cmd + 2);
5461 if (z_id >= sdebug_capacity) {
5462 mk_sense_buffer(scp, ILLEGAL_REQUEST, LBA_OUT_OF_RANGE, 0);
5463 res = check_condition_result;
5467 zsp = zbc_zone(devip, z_id);
5468 if (z_id != zsp->z_start) {
5469 mk_sense_buffer(scp, ILLEGAL_REQUEST, INVALID_FIELD_IN_CDB, 0);
5470 res = check_condition_result;
5473 if (zbc_zone_is_conv(zsp)) {
5474 mk_sense_buffer(scp, ILLEGAL_REQUEST, INVALID_FIELD_IN_CDB, 0);
5475 res = check_condition_result;
5479 zbc_close_zone(devip, zsp);
5481 sdeb_meta_write_unlock(sip);
5485 static void zbc_finish_zone(struct sdebug_dev_info *devip,
5486 struct sdeb_zone_state *zsp, bool empty)
5488 enum sdebug_z_cond zc = zsp->z_cond;
5490 if (zc == ZC4_CLOSED || zc == ZC2_IMPLICIT_OPEN ||
5491 zc == ZC3_EXPLICIT_OPEN || (empty && zc == ZC1_EMPTY)) {
5492 if (zc == ZC2_IMPLICIT_OPEN || zc == ZC3_EXPLICIT_OPEN)
5493 zbc_close_zone(devip, zsp);
5494 if (zsp->z_cond == ZC4_CLOSED)
5496 zsp->z_wp = zsp->z_start + zsp->z_size;
5497 zsp->z_cond = ZC5_FULL;
5501 static void zbc_finish_all(struct sdebug_dev_info *devip)
5505 for (i = 0; i < devip->nr_zones; i++)
5506 zbc_finish_zone(devip, &devip->zstate[i], false);
5509 static int resp_finish_zone(struct scsi_cmnd *scp,
5510 struct sdebug_dev_info *devip)
5512 struct sdeb_zone_state *zsp;
5515 u8 *cmd = scp->cmnd;
5516 bool all = cmd[14] & 0x01;
5517 struct sdeb_store_info *sip = devip2sip(devip, false);
5519 if (!sdebug_dev_is_zoned(devip)) {
5520 mk_sense_invalid_opcode(scp);
5521 return check_condition_result;
5524 sdeb_meta_write_lock(sip);
5527 zbc_finish_all(devip);
5531 /* Finish the specified zone */
5532 z_id = get_unaligned_be64(cmd + 2);
5533 if (z_id >= sdebug_capacity) {
5534 mk_sense_buffer(scp, ILLEGAL_REQUEST, LBA_OUT_OF_RANGE, 0);
5535 res = check_condition_result;
5539 zsp = zbc_zone(devip, z_id);
5540 if (z_id != zsp->z_start) {
5541 mk_sense_buffer(scp, ILLEGAL_REQUEST, INVALID_FIELD_IN_CDB, 0);
5542 res = check_condition_result;
5545 if (zbc_zone_is_conv(zsp)) {
5546 mk_sense_buffer(scp, ILLEGAL_REQUEST, INVALID_FIELD_IN_CDB, 0);
5547 res = check_condition_result;
5551 zbc_finish_zone(devip, zsp, true);
5553 sdeb_meta_write_unlock(sip);
5557 static void zbc_rwp_zone(struct sdebug_dev_info *devip,
5558 struct sdeb_zone_state *zsp)
5560 enum sdebug_z_cond zc;
5561 struct sdeb_store_info *sip = devip2sip(devip, false);
5563 if (!zbc_zone_is_seq(zsp))
5567 if (zc == ZC2_IMPLICIT_OPEN || zc == ZC3_EXPLICIT_OPEN)
5568 zbc_close_zone(devip, zsp);
5570 if (zsp->z_cond == ZC4_CLOSED)
5573 if (zsp->z_wp > zsp->z_start)
5574 memset(sip->storep + zsp->z_start * sdebug_sector_size, 0,
5575 (zsp->z_wp - zsp->z_start) * sdebug_sector_size);
5577 zsp->z_non_seq_resource = false;
5578 zsp->z_wp = zsp->z_start;
5579 zsp->z_cond = ZC1_EMPTY;
5582 static void zbc_rwp_all(struct sdebug_dev_info *devip)
5586 for (i = 0; i < devip->nr_zones; i++)
5587 zbc_rwp_zone(devip, &devip->zstate[i]);
5590 static int resp_rwp_zone(struct scsi_cmnd *scp, struct sdebug_dev_info *devip)
5592 struct sdeb_zone_state *zsp;
5595 u8 *cmd = scp->cmnd;
5596 bool all = cmd[14] & 0x01;
5597 struct sdeb_store_info *sip = devip2sip(devip, false);
5599 if (!sdebug_dev_is_zoned(devip)) {
5600 mk_sense_invalid_opcode(scp);
5601 return check_condition_result;
5604 sdeb_meta_write_lock(sip);
5611 z_id = get_unaligned_be64(cmd + 2);
5612 if (z_id >= sdebug_capacity) {
5613 mk_sense_buffer(scp, ILLEGAL_REQUEST, LBA_OUT_OF_RANGE, 0);
5614 res = check_condition_result;
5618 zsp = zbc_zone(devip, z_id);
5619 if (z_id != zsp->z_start) {
5620 mk_sense_buffer(scp, ILLEGAL_REQUEST, INVALID_FIELD_IN_CDB, 0);
5621 res = check_condition_result;
5624 if (zbc_zone_is_conv(zsp)) {
5625 mk_sense_buffer(scp, ILLEGAL_REQUEST, INVALID_FIELD_IN_CDB, 0);
5626 res = check_condition_result;
5630 zbc_rwp_zone(devip, zsp);
5632 sdeb_meta_write_unlock(sip);
5636 static u32 get_tag(struct scsi_cmnd *cmnd)
5638 return blk_mq_unique_tag(scsi_cmd_to_rq(cmnd));
5641 /* Queued (deferred) command completions converge here. */
5642 static void sdebug_q_cmd_complete(struct sdebug_defer *sd_dp)
5644 struct sdebug_queued_cmd *sqcp = container_of(sd_dp, struct sdebug_queued_cmd, sd_dp);
5645 unsigned long flags;
5646 struct scsi_cmnd *scp = sqcp->scmd;
5647 struct sdebug_scsi_cmd *sdsc;
5650 if (sdebug_statistics) {
5651 atomic_inc(&sdebug_completions);
5652 if (raw_smp_processor_id() != sd_dp->issuing_cpu)
5653 atomic_inc(&sdebug_miss_cpus);
5657 pr_err("scmd=NULL\n");
5661 sdsc = scsi_cmd_priv(scp);
5662 spin_lock_irqsave(&sdsc->lock, flags);
5663 aborted = sd_dp->aborted;
5664 if (unlikely(aborted))
5665 sd_dp->aborted = false;
5666 ASSIGN_QUEUED_CMD(scp, NULL);
5668 spin_unlock_irqrestore(&sdsc->lock, flags);
5671 pr_info("bypassing scsi_done() due to aborted cmd, kicking-off EH\n");
5672 blk_abort_request(scsi_cmd_to_rq(scp));
5676 scsi_done(scp); /* callback to mid level */
5678 sdebug_free_queued_cmd(sqcp);
5681 /* When high resolution timer goes off this function is called. */
5682 static enum hrtimer_restart sdebug_q_cmd_hrt_complete(struct hrtimer *timer)
5684 struct sdebug_defer *sd_dp = container_of(timer, struct sdebug_defer,
5686 sdebug_q_cmd_complete(sd_dp);
5687 return HRTIMER_NORESTART;
5690 /* When work queue schedules work, it calls this function. */
5691 static void sdebug_q_cmd_wq_complete(struct work_struct *work)
5693 struct sdebug_defer *sd_dp = container_of(work, struct sdebug_defer,
5695 sdebug_q_cmd_complete(sd_dp);
5698 static bool got_shared_uuid;
5699 static uuid_t shared_uuid;
5701 static int sdebug_device_create_zones(struct sdebug_dev_info *devip)
5703 struct sdeb_zone_state *zsp;
5704 sector_t capacity = get_sdebug_capacity();
5705 sector_t conv_capacity;
5706 sector_t zstart = 0;
5710 * Set the zone size: if sdeb_zbc_zone_size_mb is not set, figure out
5711 * a zone size allowing for at least 4 zones on the device. Otherwise,
5712 * use the specified zone size checking that at least 2 zones can be
5713 * created for the device.
5715 if (!sdeb_zbc_zone_size_mb) {
5716 devip->zsize = (DEF_ZBC_ZONE_SIZE_MB * SZ_1M)
5717 >> ilog2(sdebug_sector_size);
5718 while (capacity < devip->zsize << 2 && devip->zsize >= 2)
5720 if (devip->zsize < 2) {
5721 pr_err("Device capacity too small\n");
5725 if (!is_power_of_2(sdeb_zbc_zone_size_mb)) {
5726 pr_err("Zone size is not a power of 2\n");
5729 devip->zsize = (sdeb_zbc_zone_size_mb * SZ_1M)
5730 >> ilog2(sdebug_sector_size);
5731 if (devip->zsize >= capacity) {
5732 pr_err("Zone size too large for device capacity\n");
5737 devip->zsize_shift = ilog2(devip->zsize);
5738 devip->nr_zones = (capacity + devip->zsize - 1) >> devip->zsize_shift;
5740 if (sdeb_zbc_zone_cap_mb == 0) {
5741 devip->zcap = devip->zsize;
5743 devip->zcap = (sdeb_zbc_zone_cap_mb * SZ_1M) >>
5744 ilog2(sdebug_sector_size);
5745 if (devip->zcap > devip->zsize) {
5746 pr_err("Zone capacity too large\n");
5751 conv_capacity = (sector_t)sdeb_zbc_nr_conv << devip->zsize_shift;
5752 if (conv_capacity >= capacity) {
5753 pr_err("Number of conventional zones too large\n");
5756 devip->nr_conv_zones = sdeb_zbc_nr_conv;
5757 devip->nr_seq_zones = ALIGN(capacity - conv_capacity, devip->zsize) >>
5759 devip->nr_zones = devip->nr_conv_zones + devip->nr_seq_zones;
5761 /* Add gap zones if zone capacity is smaller than the zone size */
5762 if (devip->zcap < devip->zsize)
5763 devip->nr_zones += devip->nr_seq_zones;
5766 /* zbc_max_open_zones can be 0, meaning "not reported" */
5767 if (sdeb_zbc_max_open >= devip->nr_zones - 1)
5768 devip->max_open = (devip->nr_zones - 1) / 2;
5770 devip->max_open = sdeb_zbc_max_open;
5773 devip->zstate = kcalloc(devip->nr_zones,
5774 sizeof(struct sdeb_zone_state), GFP_KERNEL);
5778 for (i = 0; i < devip->nr_zones; i++) {
5779 zsp = &devip->zstate[i];
5781 zsp->z_start = zstart;
5783 if (i < devip->nr_conv_zones) {
5784 zsp->z_type = ZBC_ZTYPE_CNV;
5785 zsp->z_cond = ZBC_NOT_WRITE_POINTER;
5786 zsp->z_wp = (sector_t)-1;
5788 min_t(u64, devip->zsize, capacity - zstart);
5789 } else if ((zstart & (devip->zsize - 1)) == 0) {
5791 zsp->z_type = ZBC_ZTYPE_SWR;
5793 zsp->z_type = ZBC_ZTYPE_SWP;
5794 zsp->z_cond = ZC1_EMPTY;
5795 zsp->z_wp = zsp->z_start;
5797 min_t(u64, devip->zcap, capacity - zstart);
5799 zsp->z_type = ZBC_ZTYPE_GAP;
5800 zsp->z_cond = ZBC_NOT_WRITE_POINTER;
5801 zsp->z_wp = (sector_t)-1;
5802 zsp->z_size = min_t(u64, devip->zsize - devip->zcap,
5806 WARN_ON_ONCE((int)zsp->z_size <= 0);
5807 zstart += zsp->z_size;
5813 static struct sdebug_dev_info *sdebug_device_create(
5814 struct sdebug_host_info *sdbg_host, gfp_t flags)
5816 struct sdebug_dev_info *devip;
5818 devip = kzalloc(sizeof(*devip), flags);
5820 if (sdebug_uuid_ctl == 1)
5821 uuid_gen(&devip->lu_name);
5822 else if (sdebug_uuid_ctl == 2) {
5823 if (got_shared_uuid)
5824 devip->lu_name = shared_uuid;
5826 uuid_gen(&shared_uuid);
5827 got_shared_uuid = true;
5828 devip->lu_name = shared_uuid;
5831 devip->sdbg_host = sdbg_host;
5832 if (sdeb_zbc_in_use) {
5833 devip->zoned = sdeb_zbc_model == BLK_ZONED_HM;
5834 if (sdebug_device_create_zones(devip)) {
5839 devip->zoned = false;
5841 devip->create_ts = ktime_get_boottime();
5842 atomic_set(&devip->stopped, (sdeb_tur_ms_to_ready > 0 ? 2 : 0));
5843 spin_lock_init(&devip->list_lock);
5844 INIT_LIST_HEAD(&devip->inject_err_list);
5845 list_add_tail(&devip->dev_list, &sdbg_host->dev_info_list);
5850 static struct sdebug_dev_info *find_build_dev_info(struct scsi_device *sdev)
5852 struct sdebug_host_info *sdbg_host;
5853 struct sdebug_dev_info *open_devip = NULL;
5854 struct sdebug_dev_info *devip;
5856 sdbg_host = shost_to_sdebug_host(sdev->host);
5858 list_for_each_entry(devip, &sdbg_host->dev_info_list, dev_list) {
5859 if ((devip->used) && (devip->channel == sdev->channel) &&
5860 (devip->target == sdev->id) &&
5861 (devip->lun == sdev->lun))
5864 if ((!devip->used) && (!open_devip))
5868 if (!open_devip) { /* try and make a new one */
5869 open_devip = sdebug_device_create(sdbg_host, GFP_ATOMIC);
5871 pr_err("out of memory at line %d\n", __LINE__);
5876 open_devip->channel = sdev->channel;
5877 open_devip->target = sdev->id;
5878 open_devip->lun = sdev->lun;
5879 open_devip->sdbg_host = sdbg_host;
5880 set_bit(SDEBUG_UA_POOCCUR, open_devip->uas_bm);
5881 open_devip->used = true;
5885 static int scsi_debug_slave_alloc(struct scsi_device *sdp)
5888 pr_info("slave_alloc <%u %u %u %llu>\n",
5889 sdp->host->host_no, sdp->channel, sdp->id, sdp->lun);
5894 static int scsi_debug_slave_configure(struct scsi_device *sdp)
5896 struct sdebug_dev_info *devip =
5897 (struct sdebug_dev_info *)sdp->hostdata;
5898 struct dentry *dentry;
5901 pr_info("slave_configure <%u %u %u %llu>\n",
5902 sdp->host->host_no, sdp->channel, sdp->id, sdp->lun);
5903 if (sdp->host->max_cmd_len != SDEBUG_MAX_CMD_LEN)
5904 sdp->host->max_cmd_len = SDEBUG_MAX_CMD_LEN;
5905 if (devip == NULL) {
5906 devip = find_build_dev_info(sdp);
5908 return 1; /* no resources, will be marked offline */
5910 sdp->hostdata = devip;
5912 sdp->no_uld_attach = 1;
5913 config_cdb_len(sdp);
5915 if (sdebug_allow_restart)
5916 sdp->allow_restart = 1;
5918 devip->debugfs_entry = debugfs_create_dir(dev_name(&sdp->sdev_dev),
5919 sdebug_debugfs_root);
5920 if (IS_ERR_OR_NULL(devip->debugfs_entry))
5921 pr_info("%s: failed to create debugfs directory for device %s\n",
5922 __func__, dev_name(&sdp->sdev_gendev));
5924 dentry = debugfs_create_file("error", 0600, devip->debugfs_entry, sdp,
5925 &sdebug_error_fops);
5926 if (IS_ERR_OR_NULL(dentry))
5927 pr_info("%s: failed to create error file for device %s\n",
5928 __func__, dev_name(&sdp->sdev_gendev));
5933 static void scsi_debug_slave_destroy(struct scsi_device *sdp)
5935 struct sdebug_dev_info *devip =
5936 (struct sdebug_dev_info *)sdp->hostdata;
5937 struct sdebug_err_inject *err;
5940 pr_info("slave_destroy <%u %u %u %llu>\n",
5941 sdp->host->host_no, sdp->channel, sdp->id, sdp->lun);
5946 spin_lock(&devip->list_lock);
5947 list_for_each_entry_rcu(err, &devip->inject_err_list, list) {
5948 list_del_rcu(&err->list);
5949 call_rcu(&err->rcu, sdebug_err_free);
5951 spin_unlock(&devip->list_lock);
5953 debugfs_remove(devip->debugfs_entry);
5955 /* make this slot available for re-use */
5956 devip->used = false;
5957 sdp->hostdata = NULL;
5960 /* Returns true if we require the queued memory to be freed by the caller. */
5961 static bool stop_qc_helper(struct sdebug_defer *sd_dp,
5962 enum sdeb_defer_type defer_t)
5964 if (defer_t == SDEB_DEFER_HRT) {
5965 int res = hrtimer_try_to_cancel(&sd_dp->hrt);
5968 case 0: /* Not active, it must have already run */
5969 case -1: /* -1 It's executing the CB */
5971 case 1: /* Was active, we've now cancelled */
5975 } else if (defer_t == SDEB_DEFER_WQ) {
5976 /* Cancel if pending */
5977 if (cancel_work_sync(&sd_dp->ew.work))
5979 /* Was not pending, so it must have run */
5981 } else if (defer_t == SDEB_DEFER_POLL) {
5989 static bool scsi_debug_stop_cmnd(struct scsi_cmnd *cmnd)
5991 enum sdeb_defer_type l_defer_t;
5992 struct sdebug_defer *sd_dp;
5993 struct sdebug_scsi_cmd *sdsc = scsi_cmd_priv(cmnd);
5994 struct sdebug_queued_cmd *sqcp = TO_QUEUED_CMD(cmnd);
5996 lockdep_assert_held(&sdsc->lock);
6000 sd_dp = &sqcp->sd_dp;
6001 l_defer_t = READ_ONCE(sd_dp->defer_t);
6002 ASSIGN_QUEUED_CMD(cmnd, NULL);
6004 if (stop_qc_helper(sd_dp, l_defer_t))
6005 sdebug_free_queued_cmd(sqcp);
6011 * Called from scsi_debug_abort() only, which is for timed-out cmd.
6013 static bool scsi_debug_abort_cmnd(struct scsi_cmnd *cmnd)
6015 struct sdebug_scsi_cmd *sdsc = scsi_cmd_priv(cmnd);
6016 unsigned long flags;
6019 spin_lock_irqsave(&sdsc->lock, flags);
6020 res = scsi_debug_stop_cmnd(cmnd);
6021 spin_unlock_irqrestore(&sdsc->lock, flags);
6027 * All we can do is set the cmnd as internally aborted and wait for it to
6028 * finish. We cannot call scsi_done() as normal completion path may do that.
6030 static bool sdebug_stop_cmnd(struct request *rq, void *data)
6032 scsi_debug_abort_cmnd(blk_mq_rq_to_pdu(rq));
6037 /* Deletes (stops) timers or work queues of all queued commands */
6038 static void stop_all_queued(void)
6040 struct sdebug_host_info *sdhp;
6042 mutex_lock(&sdebug_host_list_mutex);
6043 list_for_each_entry(sdhp, &sdebug_host_list, host_list) {
6044 struct Scsi_Host *shost = sdhp->shost;
6046 blk_mq_tagset_busy_iter(&shost->tag_set, sdebug_stop_cmnd, NULL);
6048 mutex_unlock(&sdebug_host_list_mutex);
6051 static int sdebug_fail_abort(struct scsi_cmnd *cmnd)
6053 struct scsi_device *sdp = cmnd->device;
6054 struct sdebug_dev_info *devip = (struct sdebug_dev_info *)sdp->hostdata;
6055 struct sdebug_err_inject *err;
6056 unsigned char *cmd = cmnd->cmnd;
6063 list_for_each_entry_rcu(err, &devip->inject_err_list, list) {
6064 if (err->type == ERR_ABORT_CMD_FAILED &&
6065 (err->cmd == cmd[0] || err->cmd == 0xff)) {
6079 static int scsi_debug_abort(struct scsi_cmnd *SCpnt)
6081 bool ok = scsi_debug_abort_cmnd(SCpnt);
6082 u8 *cmd = SCpnt->cmnd;
6087 if (SDEBUG_OPT_ALL_NOISE & sdebug_opts)
6088 sdev_printk(KERN_INFO, SCpnt->device,
6089 "%s: command%s found\n", __func__,
6092 if (sdebug_fail_abort(SCpnt)) {
6093 scmd_printk(KERN_INFO, SCpnt, "fail abort command 0x%x\n",
6101 static bool scsi_debug_stop_all_queued_iter(struct request *rq, void *data)
6103 struct scsi_device *sdp = data;
6104 struct scsi_cmnd *scmd = blk_mq_rq_to_pdu(rq);
6106 if (scmd->device == sdp)
6107 scsi_debug_abort_cmnd(scmd);
6112 /* Deletes (stops) timers or work queues of all queued commands per sdev */
6113 static void scsi_debug_stop_all_queued(struct scsi_device *sdp)
6115 struct Scsi_Host *shost = sdp->host;
6117 blk_mq_tagset_busy_iter(&shost->tag_set,
6118 scsi_debug_stop_all_queued_iter, sdp);
6121 static int sdebug_fail_lun_reset(struct scsi_cmnd *cmnd)
6123 struct scsi_device *sdp = cmnd->device;
6124 struct sdebug_dev_info *devip = (struct sdebug_dev_info *)sdp->hostdata;
6125 struct sdebug_err_inject *err;
6126 unsigned char *cmd = cmnd->cmnd;
6133 list_for_each_entry_rcu(err, &devip->inject_err_list, list) {
6134 if (err->type == ERR_LUN_RESET_FAILED &&
6135 (err->cmd == cmd[0] || err->cmd == 0xff)) {
6149 static int scsi_debug_device_reset(struct scsi_cmnd *SCpnt)
6151 struct scsi_device *sdp = SCpnt->device;
6152 struct sdebug_dev_info *devip = sdp->hostdata;
6153 u8 *cmd = SCpnt->cmnd;
6158 if (SDEBUG_OPT_ALL_NOISE & sdebug_opts)
6159 sdev_printk(KERN_INFO, sdp, "%s\n", __func__);
6161 scsi_debug_stop_all_queued(sdp);
6163 set_bit(SDEBUG_UA_POR, devip->uas_bm);
6165 if (sdebug_fail_lun_reset(SCpnt)) {
6166 scmd_printk(KERN_INFO, SCpnt, "fail lun reset 0x%x\n", opcode);
6173 static int sdebug_fail_target_reset(struct scsi_cmnd *cmnd)
6175 struct scsi_target *starget = scsi_target(cmnd->device);
6176 struct sdebug_target_info *targetip =
6177 (struct sdebug_target_info *)starget->hostdata;
6180 return targetip->reset_fail;
6185 static int scsi_debug_target_reset(struct scsi_cmnd *SCpnt)
6187 struct scsi_device *sdp = SCpnt->device;
6188 struct sdebug_host_info *sdbg_host = shost_to_sdebug_host(sdp->host);
6189 struct sdebug_dev_info *devip;
6190 u8 *cmd = SCpnt->cmnd;
6194 ++num_target_resets;
6195 if (SDEBUG_OPT_ALL_NOISE & sdebug_opts)
6196 sdev_printk(KERN_INFO, sdp, "%s\n", __func__);
6198 list_for_each_entry(devip, &sdbg_host->dev_info_list, dev_list) {
6199 if (devip->target == sdp->id) {
6200 set_bit(SDEBUG_UA_BUS_RESET, devip->uas_bm);
6205 if (SDEBUG_OPT_RESET_NOISE & sdebug_opts)
6206 sdev_printk(KERN_INFO, sdp,
6207 "%s: %d device(s) found in target\n", __func__, k);
6209 if (sdebug_fail_target_reset(SCpnt)) {
6210 scmd_printk(KERN_INFO, SCpnt, "fail target reset 0x%x\n",
6218 static int scsi_debug_bus_reset(struct scsi_cmnd *SCpnt)
6220 struct scsi_device *sdp = SCpnt->device;
6221 struct sdebug_host_info *sdbg_host = shost_to_sdebug_host(sdp->host);
6222 struct sdebug_dev_info *devip;
6227 if (SDEBUG_OPT_ALL_NOISE & sdebug_opts)
6228 sdev_printk(KERN_INFO, sdp, "%s\n", __func__);
6230 list_for_each_entry(devip, &sdbg_host->dev_info_list, dev_list) {
6231 set_bit(SDEBUG_UA_BUS_RESET, devip->uas_bm);
6235 if (SDEBUG_OPT_RESET_NOISE & sdebug_opts)
6236 sdev_printk(KERN_INFO, sdp,
6237 "%s: %d device(s) found in host\n", __func__, k);
6241 static int scsi_debug_host_reset(struct scsi_cmnd *SCpnt)
6243 struct sdebug_host_info *sdbg_host;
6244 struct sdebug_dev_info *devip;
6248 if (SDEBUG_OPT_ALL_NOISE & sdebug_opts)
6249 sdev_printk(KERN_INFO, SCpnt->device, "%s\n", __func__);
6250 mutex_lock(&sdebug_host_list_mutex);
6251 list_for_each_entry(sdbg_host, &sdebug_host_list, host_list) {
6252 list_for_each_entry(devip, &sdbg_host->dev_info_list,
6254 set_bit(SDEBUG_UA_BUS_RESET, devip->uas_bm);
6258 mutex_unlock(&sdebug_host_list_mutex);
6260 if (SDEBUG_OPT_RESET_NOISE & sdebug_opts)
6261 sdev_printk(KERN_INFO, SCpnt->device,
6262 "%s: %d device(s) found\n", __func__, k);
6266 static void sdebug_build_parts(unsigned char *ramp, unsigned long store_size)
6268 struct msdos_partition *pp;
6269 int starts[SDEBUG_MAX_PARTS + 2], max_part_secs;
6270 int sectors_per_part, num_sectors, k;
6271 int heads_by_sects, start_sec, end_sec;
6273 /* assume partition table already zeroed */
6274 if ((sdebug_num_parts < 1) || (store_size < 1048576))
6276 if (sdebug_num_parts > SDEBUG_MAX_PARTS) {
6277 sdebug_num_parts = SDEBUG_MAX_PARTS;
6278 pr_warn("reducing partitions to %d\n", SDEBUG_MAX_PARTS);
6280 num_sectors = (int)get_sdebug_capacity();
6281 sectors_per_part = (num_sectors - sdebug_sectors_per)
6283 heads_by_sects = sdebug_heads * sdebug_sectors_per;
6284 starts[0] = sdebug_sectors_per;
6285 max_part_secs = sectors_per_part;
6286 for (k = 1; k < sdebug_num_parts; ++k) {
6287 starts[k] = ((k * sectors_per_part) / heads_by_sects)
6289 if (starts[k] - starts[k - 1] < max_part_secs)
6290 max_part_secs = starts[k] - starts[k - 1];
6292 starts[sdebug_num_parts] = num_sectors;
6293 starts[sdebug_num_parts + 1] = 0;
6295 ramp[510] = 0x55; /* magic partition markings */
6297 pp = (struct msdos_partition *)(ramp + 0x1be);
6298 for (k = 0; starts[k + 1]; ++k, ++pp) {
6299 start_sec = starts[k];
6300 end_sec = starts[k] + max_part_secs - 1;
6303 pp->cyl = start_sec / heads_by_sects;
6304 pp->head = (start_sec - (pp->cyl * heads_by_sects))
6305 / sdebug_sectors_per;
6306 pp->sector = (start_sec % sdebug_sectors_per) + 1;
6308 pp->end_cyl = end_sec / heads_by_sects;
6309 pp->end_head = (end_sec - (pp->end_cyl * heads_by_sects))
6310 / sdebug_sectors_per;
6311 pp->end_sector = (end_sec % sdebug_sectors_per) + 1;
6313 pp->start_sect = cpu_to_le32(start_sec);
6314 pp->nr_sects = cpu_to_le32(end_sec - start_sec + 1);
6315 pp->sys_ind = 0x83; /* plain Linux partition */
6319 static void block_unblock_all_queues(bool block)
6321 struct sdebug_host_info *sdhp;
6323 lockdep_assert_held(&sdebug_host_list_mutex);
6325 list_for_each_entry(sdhp, &sdebug_host_list, host_list) {
6326 struct Scsi_Host *shost = sdhp->shost;
6329 scsi_block_requests(shost);
6331 scsi_unblock_requests(shost);
6335 /* Adjust (by rounding down) the sdebug_cmnd_count so abs(every_nth)-1
6336 * commands will be processed normally before triggers occur.
6338 static void tweak_cmnd_count(void)
6342 modulo = abs(sdebug_every_nth);
6346 mutex_lock(&sdebug_host_list_mutex);
6347 block_unblock_all_queues(true);
6348 count = atomic_read(&sdebug_cmnd_count);
6349 atomic_set(&sdebug_cmnd_count, (count / modulo) * modulo);
6350 block_unblock_all_queues(false);
6351 mutex_unlock(&sdebug_host_list_mutex);
6354 static void clear_queue_stats(void)
6356 atomic_set(&sdebug_cmnd_count, 0);
6357 atomic_set(&sdebug_completions, 0);
6358 atomic_set(&sdebug_miss_cpus, 0);
6359 atomic_set(&sdebug_a_tsf, 0);
6362 static bool inject_on_this_cmd(void)
6364 if (sdebug_every_nth == 0)
6366 return (atomic_read(&sdebug_cmnd_count) % abs(sdebug_every_nth)) == 0;
6369 #define INCLUSIVE_TIMING_MAX_NS 1000000 /* 1 millisecond */
6372 void sdebug_free_queued_cmd(struct sdebug_queued_cmd *sqcp)
6375 kmem_cache_free(queued_cmd_cache, sqcp);
6378 static struct sdebug_queued_cmd *sdebug_alloc_queued_cmd(struct scsi_cmnd *scmd)
6380 struct sdebug_queued_cmd *sqcp;
6381 struct sdebug_defer *sd_dp;
6383 sqcp = kmem_cache_zalloc(queued_cmd_cache, GFP_ATOMIC);
6387 sd_dp = &sqcp->sd_dp;
6389 hrtimer_init(&sd_dp->hrt, CLOCK_MONOTONIC, HRTIMER_MODE_REL_PINNED);
6390 sd_dp->hrt.function = sdebug_q_cmd_hrt_complete;
6391 INIT_WORK(&sd_dp->ew.work, sdebug_q_cmd_wq_complete);
6398 /* Complete the processing of the thread that queued a SCSI command to this
6399 * driver. It either completes the command by calling cmnd_done() or
6400 * schedules a hr timer or work queue then returns 0. Returns
6401 * SCSI_MLQUEUE_HOST_BUSY if temporarily out of resources.
6403 static int schedule_resp(struct scsi_cmnd *cmnd, struct sdebug_dev_info *devip,
6405 int (*pfp)(struct scsi_cmnd *,
6406 struct sdebug_dev_info *),
6407 int delta_jiff, int ndelay)
6409 struct request *rq = scsi_cmd_to_rq(cmnd);
6410 bool polled = rq->cmd_flags & REQ_POLLED;
6411 struct sdebug_scsi_cmd *sdsc = scsi_cmd_priv(cmnd);
6412 unsigned long flags;
6413 u64 ns_from_boot = 0;
6414 struct sdebug_queued_cmd *sqcp;
6415 struct scsi_device *sdp;
6416 struct sdebug_defer *sd_dp;
6418 if (unlikely(devip == NULL)) {
6419 if (scsi_result == 0)
6420 scsi_result = DID_NO_CONNECT << 16;
6421 goto respond_in_thread;
6425 if (delta_jiff == 0)
6426 goto respond_in_thread;
6429 if (unlikely(sdebug_every_nth && (SDEBUG_OPT_RARE_TSF & sdebug_opts) &&
6430 (scsi_result == 0))) {
6431 int num_in_q = scsi_device_busy(sdp);
6432 int qdepth = cmnd->device->queue_depth;
6434 if ((num_in_q == qdepth) &&
6435 (atomic_inc_return(&sdebug_a_tsf) >=
6436 abs(sdebug_every_nth))) {
6437 atomic_set(&sdebug_a_tsf, 0);
6438 scsi_result = device_qfull_result;
6440 if (unlikely(SDEBUG_OPT_Q_NOISE & sdebug_opts))
6441 sdev_printk(KERN_INFO, sdp, "%s: num_in_q=%d +1, <inject> status: TASK SET FULL\n",
6442 __func__, num_in_q);
6446 sqcp = sdebug_alloc_queued_cmd(cmnd);
6448 pr_err("%s no alloc\n", __func__);
6449 return SCSI_MLQUEUE_HOST_BUSY;
6451 sd_dp = &sqcp->sd_dp;
6454 ns_from_boot = ktime_get_boottime_ns();
6456 /* one of the resp_*() response functions is called here */
6457 cmnd->result = pfp ? pfp(cmnd, devip) : 0;
6458 if (cmnd->result & SDEG_RES_IMMED_MASK) {
6459 cmnd->result &= ~SDEG_RES_IMMED_MASK;
6460 delta_jiff = ndelay = 0;
6462 if (cmnd->result == 0 && scsi_result != 0)
6463 cmnd->result = scsi_result;
6464 if (cmnd->result == 0 && unlikely(sdebug_opts & SDEBUG_OPT_TRANSPORT_ERR)) {
6465 if (atomic_read(&sdeb_inject_pending)) {
6466 mk_sense_buffer(cmnd, ABORTED_COMMAND, TRANSPORT_PROBLEM, ACK_NAK_TO);
6467 atomic_set(&sdeb_inject_pending, 0);
6468 cmnd->result = check_condition_result;
6472 if (unlikely(sdebug_verbose && cmnd->result))
6473 sdev_printk(KERN_INFO, sdp, "%s: non-zero result=0x%x\n",
6474 __func__, cmnd->result);
6476 if (delta_jiff > 0 || ndelay > 0) {
6479 if (delta_jiff > 0) {
6480 u64 ns = jiffies_to_nsecs(delta_jiff);
6482 if (sdebug_random && ns < U32_MAX) {
6483 ns = get_random_u32_below((u32)ns);
6484 } else if (sdebug_random) {
6485 ns >>= 12; /* scale to 4 usec precision */
6486 if (ns < U32_MAX) /* over 4 hours max */
6487 ns = get_random_u32_below((u32)ns);
6490 kt = ns_to_ktime(ns);
6491 } else { /* ndelay has a 4.2 second max */
6492 kt = sdebug_random ? get_random_u32_below((u32)ndelay) :
6494 if (ndelay < INCLUSIVE_TIMING_MAX_NS) {
6495 u64 d = ktime_get_boottime_ns() - ns_from_boot;
6497 if (kt <= d) { /* elapsed duration >= kt */
6498 /* call scsi_done() from this thread */
6499 sdebug_free_queued_cmd(sqcp);
6503 /* otherwise reduce kt by elapsed time */
6507 if (sdebug_statistics)
6508 sd_dp->issuing_cpu = raw_smp_processor_id();
6510 spin_lock_irqsave(&sdsc->lock, flags);
6511 sd_dp->cmpl_ts = ktime_add(ns_to_ktime(ns_from_boot), kt);
6512 ASSIGN_QUEUED_CMD(cmnd, sqcp);
6513 WRITE_ONCE(sd_dp->defer_t, SDEB_DEFER_POLL);
6514 spin_unlock_irqrestore(&sdsc->lock, flags);
6516 /* schedule the invocation of scsi_done() for a later time */
6517 spin_lock_irqsave(&sdsc->lock, flags);
6518 ASSIGN_QUEUED_CMD(cmnd, sqcp);
6519 WRITE_ONCE(sd_dp->defer_t, SDEB_DEFER_HRT);
6520 hrtimer_start(&sd_dp->hrt, kt, HRTIMER_MODE_REL_PINNED);
6522 * The completion handler will try to grab sqcp->lock,
6523 * so there is no chance that the completion handler
6524 * will call scsi_done() until we release the lock
6525 * here (so ok to keep referencing sdsc).
6527 spin_unlock_irqrestore(&sdsc->lock, flags);
6529 } else { /* jdelay < 0, use work queue */
6530 if (unlikely((sdebug_opts & SDEBUG_OPT_CMD_ABORT) &&
6531 atomic_read(&sdeb_inject_pending))) {
6532 sd_dp->aborted = true;
6533 atomic_set(&sdeb_inject_pending, 0);
6534 sdev_printk(KERN_INFO, sdp, "abort request tag=%#x\n",
6535 blk_mq_unique_tag_to_tag(get_tag(cmnd)));
6538 if (sdebug_statistics)
6539 sd_dp->issuing_cpu = raw_smp_processor_id();
6541 spin_lock_irqsave(&sdsc->lock, flags);
6542 ASSIGN_QUEUED_CMD(cmnd, sqcp);
6543 sd_dp->cmpl_ts = ns_to_ktime(ns_from_boot);
6544 WRITE_ONCE(sd_dp->defer_t, SDEB_DEFER_POLL);
6545 spin_unlock_irqrestore(&sdsc->lock, flags);
6547 spin_lock_irqsave(&sdsc->lock, flags);
6548 ASSIGN_QUEUED_CMD(cmnd, sqcp);
6549 WRITE_ONCE(sd_dp->defer_t, SDEB_DEFER_WQ);
6550 schedule_work(&sd_dp->ew.work);
6551 spin_unlock_irqrestore(&sdsc->lock, flags);
6557 respond_in_thread: /* call back to mid-layer using invocation thread */
6558 cmnd->result = pfp != NULL ? pfp(cmnd, devip) : 0;
6559 cmnd->result &= ~SDEG_RES_IMMED_MASK;
6560 if (cmnd->result == 0 && scsi_result != 0)
6561 cmnd->result = scsi_result;
6566 /* Note: The following macros create attribute files in the
6567 /sys/module/scsi_debug/parameters directory. Unfortunately this
6568 driver is unaware of a change and cannot trigger auxiliary actions
6569 as it can when the corresponding attribute in the
6570 /sys/bus/pseudo/drivers/scsi_debug directory is changed.
6572 module_param_named(add_host, sdebug_add_host, int, S_IRUGO | S_IWUSR);
6573 module_param_named(ato, sdebug_ato, int, S_IRUGO);
6574 module_param_named(cdb_len, sdebug_cdb_len, int, 0644);
6575 module_param_named(clustering, sdebug_clustering, bool, S_IRUGO | S_IWUSR);
6576 module_param_named(delay, sdebug_jdelay, int, S_IRUGO | S_IWUSR);
6577 module_param_named(dev_size_mb, sdebug_dev_size_mb, int, S_IRUGO);
6578 module_param_named(dif, sdebug_dif, int, S_IRUGO);
6579 module_param_named(dix, sdebug_dix, int, S_IRUGO);
6580 module_param_named(dsense, sdebug_dsense, int, S_IRUGO | S_IWUSR);
6581 module_param_named(every_nth, sdebug_every_nth, int, S_IRUGO | S_IWUSR);
6582 module_param_named(fake_rw, sdebug_fake_rw, int, S_IRUGO | S_IWUSR);
6583 module_param_named(guard, sdebug_guard, uint, S_IRUGO);
6584 module_param_named(host_lock, sdebug_host_lock, bool, S_IRUGO | S_IWUSR);
6585 module_param_named(host_max_queue, sdebug_host_max_queue, int, S_IRUGO);
6586 module_param_string(inq_product, sdebug_inq_product_id,
6587 sizeof(sdebug_inq_product_id), S_IRUGO | S_IWUSR);
6588 module_param_string(inq_rev, sdebug_inq_product_rev,
6589 sizeof(sdebug_inq_product_rev), S_IRUGO | S_IWUSR);
6590 module_param_string(inq_vendor, sdebug_inq_vendor_id,
6591 sizeof(sdebug_inq_vendor_id), S_IRUGO | S_IWUSR);
6592 module_param_named(lbprz, sdebug_lbprz, int, S_IRUGO);
6593 module_param_named(lbpu, sdebug_lbpu, int, S_IRUGO);
6594 module_param_named(lbpws, sdebug_lbpws, int, S_IRUGO);
6595 module_param_named(lbpws10, sdebug_lbpws10, int, S_IRUGO);
6596 module_param_named(atomic_wr, sdebug_atomic_wr, int, S_IRUGO);
6597 module_param_named(lowest_aligned, sdebug_lowest_aligned, int, S_IRUGO);
6598 module_param_named(lun_format, sdebug_lun_am_i, int, S_IRUGO | S_IWUSR);
6599 module_param_named(max_luns, sdebug_max_luns, int, S_IRUGO | S_IWUSR);
6600 module_param_named(max_queue, sdebug_max_queue, int, S_IRUGO | S_IWUSR);
6601 module_param_named(medium_error_count, sdebug_medium_error_count, int,
6603 module_param_named(medium_error_start, sdebug_medium_error_start, int,
6605 module_param_named(ndelay, sdebug_ndelay, int, S_IRUGO | S_IWUSR);
6606 module_param_named(no_lun_0, sdebug_no_lun_0, int, S_IRUGO | S_IWUSR);
6607 module_param_named(no_rwlock, sdebug_no_rwlock, bool, S_IRUGO | S_IWUSR);
6608 module_param_named(no_uld, sdebug_no_uld, int, S_IRUGO);
6609 module_param_named(num_parts, sdebug_num_parts, int, S_IRUGO);
6610 module_param_named(num_tgts, sdebug_num_tgts, int, S_IRUGO | S_IWUSR);
6611 module_param_named(opt_blks, sdebug_opt_blks, int, S_IRUGO);
6612 module_param_named(opt_xferlen_exp, sdebug_opt_xferlen_exp, int, S_IRUGO);
6613 module_param_named(opts, sdebug_opts, int, S_IRUGO | S_IWUSR);
6614 module_param_named(per_host_store, sdebug_per_host_store, bool,
6616 module_param_named(physblk_exp, sdebug_physblk_exp, int, S_IRUGO);
6617 module_param_named(ptype, sdebug_ptype, int, S_IRUGO | S_IWUSR);
6618 module_param_named(random, sdebug_random, bool, S_IRUGO | S_IWUSR);
6619 module_param_named(removable, sdebug_removable, bool, S_IRUGO | S_IWUSR);
6620 module_param_named(scsi_level, sdebug_scsi_level, int, S_IRUGO);
6621 module_param_named(sector_size, sdebug_sector_size, int, S_IRUGO);
6622 module_param_named(statistics, sdebug_statistics, bool, S_IRUGO | S_IWUSR);
6623 module_param_named(strict, sdebug_strict, bool, S_IRUGO | S_IWUSR);
6624 module_param_named(submit_queues, submit_queues, int, S_IRUGO);
6625 module_param_named(poll_queues, poll_queues, int, S_IRUGO);
6626 module_param_named(tur_ms_to_ready, sdeb_tur_ms_to_ready, int, S_IRUGO);
6627 module_param_named(unmap_alignment, sdebug_unmap_alignment, int, S_IRUGO);
6628 module_param_named(unmap_granularity, sdebug_unmap_granularity, int, S_IRUGO);
6629 module_param_named(unmap_max_blocks, sdebug_unmap_max_blocks, int, S_IRUGO);
6630 module_param_named(unmap_max_desc, sdebug_unmap_max_desc, int, S_IRUGO);
6631 module_param_named(atomic_wr_max_length, sdebug_atomic_wr_max_length, int, S_IRUGO);
6632 module_param_named(atomic_wr_align, sdebug_atomic_wr_align, int, S_IRUGO);
6633 module_param_named(atomic_wr_gran, sdebug_atomic_wr_gran, int, S_IRUGO);
6634 module_param_named(atomic_wr_max_length_bndry, sdebug_atomic_wr_max_length_bndry, int, S_IRUGO);
6635 module_param_named(atomic_wr_max_bndry, sdebug_atomic_wr_max_bndry, int, S_IRUGO);
6636 module_param_named(uuid_ctl, sdebug_uuid_ctl, int, S_IRUGO);
6637 module_param_named(virtual_gb, sdebug_virtual_gb, int, S_IRUGO | S_IWUSR);
6638 module_param_named(vpd_use_hostno, sdebug_vpd_use_hostno, int,
6640 module_param_named(wp, sdebug_wp, bool, S_IRUGO | S_IWUSR);
6641 module_param_named(write_same_length, sdebug_write_same_length, int,
6643 module_param_named(zbc, sdeb_zbc_model_s, charp, S_IRUGO);
6644 module_param_named(zone_cap_mb, sdeb_zbc_zone_cap_mb, int, S_IRUGO);
6645 module_param_named(zone_max_open, sdeb_zbc_max_open, int, S_IRUGO);
6646 module_param_named(zone_nr_conv, sdeb_zbc_nr_conv, int, S_IRUGO);
6647 module_param_named(zone_size_mb, sdeb_zbc_zone_size_mb, int, S_IRUGO);
6648 module_param_named(allow_restart, sdebug_allow_restart, bool, S_IRUGO | S_IWUSR);
6650 MODULE_AUTHOR("Eric Youngdale + Douglas Gilbert");
6651 MODULE_DESCRIPTION("SCSI debug adapter driver");
6652 MODULE_LICENSE("GPL");
6653 MODULE_VERSION(SDEBUG_VERSION);
6655 MODULE_PARM_DESC(add_host, "add n hosts, in sysfs if negative remove host(s) (def=1)");
6656 MODULE_PARM_DESC(ato, "application tag ownership: 0=disk 1=host (def=1)");
6657 MODULE_PARM_DESC(cdb_len, "suggest CDB lengths to drivers (def=10)");
6658 MODULE_PARM_DESC(clustering, "when set enables larger transfers (def=0)");
6659 MODULE_PARM_DESC(delay, "response delay (def=1 jiffy); 0:imm, -1,-2:tiny");
6660 MODULE_PARM_DESC(dev_size_mb, "size in MiB of ram shared by devs(def=8)");
6661 MODULE_PARM_DESC(dif, "data integrity field type: 0-3 (def=0)");
6662 MODULE_PARM_DESC(dix, "data integrity extensions mask (def=0)");
6663 MODULE_PARM_DESC(dsense, "use descriptor sense format(def=0 -> fixed)");
6664 MODULE_PARM_DESC(every_nth, "timeout every nth command(def=0)");
6665 MODULE_PARM_DESC(fake_rw, "fake reads/writes instead of copying (def=0)");
6666 MODULE_PARM_DESC(guard, "protection checksum: 0=crc, 1=ip (def=0)");
6667 MODULE_PARM_DESC(host_lock, "host_lock is ignored (def=0)");
6668 MODULE_PARM_DESC(host_max_queue,
6669 "host max # of queued cmds (0 to max(def) [max_queue fixed equal for !0])");
6670 MODULE_PARM_DESC(inq_product, "SCSI INQUIRY product string (def=\"scsi_debug\")");
6671 MODULE_PARM_DESC(inq_rev, "SCSI INQUIRY revision string (def=\""
6672 SDEBUG_VERSION "\")");
6673 MODULE_PARM_DESC(inq_vendor, "SCSI INQUIRY vendor string (def=\"Linux\")");
6674 MODULE_PARM_DESC(lbprz,
6675 "on read unmapped LBs return 0 when 1 (def), return 0xff when 2");
6676 MODULE_PARM_DESC(lbpu, "enable LBP, support UNMAP command (def=0)");
6677 MODULE_PARM_DESC(lbpws, "enable LBP, support WRITE SAME(16) with UNMAP bit (def=0)");
6678 MODULE_PARM_DESC(lbpws10, "enable LBP, support WRITE SAME(10) with UNMAP bit (def=0)");
6679 MODULE_PARM_DESC(atomic_write, "enable ATOMIC WRITE support, support WRITE ATOMIC(16) (def=0)");
6680 MODULE_PARM_DESC(lowest_aligned, "lowest aligned lba (def=0)");
6681 MODULE_PARM_DESC(lun_format, "LUN format: 0->peripheral (def); 1 --> flat address method");
6682 MODULE_PARM_DESC(max_luns, "number of LUNs per target to simulate(def=1)");
6683 MODULE_PARM_DESC(max_queue, "max number of queued commands (1 to max(def))");
6684 MODULE_PARM_DESC(medium_error_count, "count of sectors to return follow on MEDIUM error");
6685 MODULE_PARM_DESC(medium_error_start, "starting sector number to return MEDIUM error");
6686 MODULE_PARM_DESC(ndelay, "response delay in nanoseconds (def=0 -> ignore)");
6687 MODULE_PARM_DESC(no_lun_0, "no LU number 0 (def=0 -> have lun 0)");
6688 MODULE_PARM_DESC(no_rwlock, "don't protect user data reads+writes (def=0)");
6689 MODULE_PARM_DESC(no_uld, "stop ULD (e.g. sd driver) attaching (def=0))");
6690 MODULE_PARM_DESC(num_parts, "number of partitions(def=0)");
6691 MODULE_PARM_DESC(num_tgts, "number of targets per host to simulate(def=1)");
6692 MODULE_PARM_DESC(opt_blks, "optimal transfer length in blocks (def=1024)");
6693 MODULE_PARM_DESC(opt_xferlen_exp, "optimal transfer length granularity exponent (def=physblk_exp)");
6694 MODULE_PARM_DESC(opts, "1->noise, 2->medium_err, 4->timeout, 8->recovered_err... (def=0)");
6695 MODULE_PARM_DESC(per_host_store, "If set, next positive add_host will get new store (def=0)");
6696 MODULE_PARM_DESC(physblk_exp, "physical block exponent (def=0)");
6697 MODULE_PARM_DESC(poll_queues, "support for iouring iopoll queues (1 to max(submit_queues - 1))");
6698 MODULE_PARM_DESC(ptype, "SCSI peripheral type(def=0[disk])");
6699 MODULE_PARM_DESC(random, "If set, uniformly randomize command duration between 0 and delay_in_ns");
6700 MODULE_PARM_DESC(removable, "claim to have removable media (def=0)");
6701 MODULE_PARM_DESC(scsi_level, "SCSI level to simulate(def=7[SPC-5])");
6702 MODULE_PARM_DESC(sector_size, "logical block size in bytes (def=512)");
6703 MODULE_PARM_DESC(statistics, "collect statistics on commands, queues (def=0)");
6704 MODULE_PARM_DESC(strict, "stricter checks: reserved field in cdb (def=0)");
6705 MODULE_PARM_DESC(submit_queues, "support for block multi-queue (def=1)");
6706 MODULE_PARM_DESC(tur_ms_to_ready, "TEST UNIT READY millisecs before initial good status (def=0)");
6707 MODULE_PARM_DESC(unmap_alignment, "lowest aligned thin provisioning lba (def=0)");
6708 MODULE_PARM_DESC(unmap_granularity, "thin provisioning granularity in blocks (def=1)");
6709 MODULE_PARM_DESC(unmap_max_blocks, "max # of blocks can be unmapped in one cmd (def=0xffffffff)");
6710 MODULE_PARM_DESC(unmap_max_desc, "max # of ranges that can be unmapped in one cmd (def=256)");
6711 MODULE_PARM_DESC(atomic_wr_max_length, "max # of blocks can be atomically written in one cmd (def=8192)");
6712 MODULE_PARM_DESC(atomic_wr_align, "minimum alignment of atomic write in blocks (def=2)");
6713 MODULE_PARM_DESC(atomic_wr_gran, "minimum granularity of atomic write in blocks (def=2)");
6714 MODULE_PARM_DESC(atomic_wr_max_length_bndry, "max # of blocks can be atomically written in one cmd with boundary set (def=8192)");
6715 MODULE_PARM_DESC(atomic_wr_max_bndry, "max # boundaries per atomic write (def=128)");
6716 MODULE_PARM_DESC(uuid_ctl,
6717 "1->use uuid for lu name, 0->don't, 2->all use same (def=0)");
6718 MODULE_PARM_DESC(virtual_gb, "virtual gigabyte (GiB) size (def=0 -> use dev_size_mb)");
6719 MODULE_PARM_DESC(vpd_use_hostno, "0 -> dev ids ignore hostno (def=1 -> unique dev ids)");
6720 MODULE_PARM_DESC(wp, "Write Protect (def=0)");
6721 MODULE_PARM_DESC(write_same_length, "Maximum blocks per WRITE SAME cmd (def=0xffff)");
6722 MODULE_PARM_DESC(zbc, "'none' [0]; 'aware' [1]; 'managed' [2] (def=0). Can have 'host-' prefix");
6723 MODULE_PARM_DESC(zone_cap_mb, "Zone capacity in MiB (def=zone size)");
6724 MODULE_PARM_DESC(zone_max_open, "Maximum number of open zones; [0] for no limit (def=auto)");
6725 MODULE_PARM_DESC(zone_nr_conv, "Number of conventional zones (def=1)");
6726 MODULE_PARM_DESC(zone_size_mb, "Zone size in MiB (def=auto)");
6727 MODULE_PARM_DESC(allow_restart, "Set scsi_device's allow_restart flag(def=0)");
6729 #define SDEBUG_INFO_LEN 256
6730 static char sdebug_info[SDEBUG_INFO_LEN];
6732 static const char *scsi_debug_info(struct Scsi_Host *shp)
6736 k = scnprintf(sdebug_info, SDEBUG_INFO_LEN, "%s: version %s [%s]\n",
6737 my_name, SDEBUG_VERSION, sdebug_version_date);
6738 if (k >= (SDEBUG_INFO_LEN - 1))
6740 scnprintf(sdebug_info + k, SDEBUG_INFO_LEN - k,
6741 " dev_size_mb=%d, opts=0x%x, submit_queues=%d, %s=%d",
6742 sdebug_dev_size_mb, sdebug_opts, submit_queues,
6743 "statistics", (int)sdebug_statistics);
6747 /* 'echo <val> > /proc/scsi/scsi_debug/<host_id>' writes to opts */
6748 static int scsi_debug_write_info(struct Scsi_Host *host, char *buffer,
6753 int minLen = length > 15 ? 15 : length;
6755 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
6757 memcpy(arr, buffer, minLen);
6759 if (1 != sscanf(arr, "%d", &opts))
6762 sdebug_verbose = !!(SDEBUG_OPT_NOISE & opts);
6763 sdebug_any_injecting_opt = !!(SDEBUG_OPT_ALL_INJECTING & opts);
6764 if (sdebug_every_nth != 0)
6769 struct sdebug_submit_queue_data {
6775 static bool sdebug_submit_queue_iter(struct request *rq, void *opaque)
6777 struct sdebug_submit_queue_data *data = opaque;
6778 u32 unique_tag = blk_mq_unique_tag(rq);
6779 u16 hwq = blk_mq_unique_tag_to_hwq(unique_tag);
6780 u16 tag = blk_mq_unique_tag_to_tag(unique_tag);
6781 int queue_num = data->queue_num;
6783 if (hwq != queue_num)
6786 /* Rely on iter'ing in ascending tag order */
6787 if (*data->first == -1)
6788 *data->first = *data->last = tag;
6795 /* Output seen with 'cat /proc/scsi/scsi_debug/<host_id>'. It will be the
6796 * same for each scsi_debug host (if more than one). Some of the counters
6797 * output are not atomics so might be inaccurate in a busy system. */
6798 static int scsi_debug_show_info(struct seq_file *m, struct Scsi_Host *host)
6800 struct sdebug_host_info *sdhp;
6803 seq_printf(m, "scsi_debug adapter driver, version %s [%s]\n",
6804 SDEBUG_VERSION, sdebug_version_date);
6805 seq_printf(m, "num_tgts=%d, %ssize=%d MB, opts=0x%x, every_nth=%d\n",
6806 sdebug_num_tgts, "shared (ram) ", sdebug_dev_size_mb,
6807 sdebug_opts, sdebug_every_nth);
6808 seq_printf(m, "delay=%d, ndelay=%d, max_luns=%d, sector_size=%d %s\n",
6809 sdebug_jdelay, sdebug_ndelay, sdebug_max_luns,
6810 sdebug_sector_size, "bytes");
6811 seq_printf(m, "cylinders=%d, heads=%d, sectors=%d, command aborts=%d\n",
6812 sdebug_cylinders_per, sdebug_heads, sdebug_sectors_per,
6814 seq_printf(m, "RESETs: device=%d, target=%d, bus=%d, host=%d\n",
6815 num_dev_resets, num_target_resets, num_bus_resets,
6817 seq_printf(m, "dix_reads=%d, dix_writes=%d, dif_errors=%d\n",
6818 dix_reads, dix_writes, dif_errors);
6819 seq_printf(m, "usec_in_jiffy=%lu, statistics=%d\n", TICK_NSEC / 1000,
6821 seq_printf(m, "cmnd_count=%d, completions=%d, %s=%d, a_tsf=%d, mq_polls=%d\n",
6822 atomic_read(&sdebug_cmnd_count),
6823 atomic_read(&sdebug_completions),
6824 "miss_cpus", atomic_read(&sdebug_miss_cpus),
6825 atomic_read(&sdebug_a_tsf),
6826 atomic_read(&sdeb_mq_poll_count));
6828 seq_printf(m, "submit_queues=%d\n", submit_queues);
6829 for (j = 0; j < submit_queues; ++j) {
6831 struct sdebug_submit_queue_data data = {
6836 seq_printf(m, " queue %d:\n", j);
6837 blk_mq_tagset_busy_iter(&host->tag_set, sdebug_submit_queue_iter,
6840 seq_printf(m, " in_use_bm BUSY: %s: %d,%d\n",
6841 "first,last bits", f, l);
6845 seq_printf(m, "this host_no=%d\n", host->host_no);
6846 if (!xa_empty(per_store_ap)) {
6849 unsigned long l_idx;
6850 struct sdeb_store_info *sip;
6852 seq_puts(m, "\nhost list:\n");
6854 list_for_each_entry(sdhp, &sdebug_host_list, host_list) {
6856 seq_printf(m, " %d: host_no=%d, si_idx=%d\n", j,
6857 sdhp->shost->host_no, idx);
6860 seq_printf(m, "\nper_store array [most_recent_idx=%d]:\n",
6861 sdeb_most_recent_idx);
6863 xa_for_each(per_store_ap, l_idx, sip) {
6864 niu = xa_get_mark(per_store_ap, l_idx,
6865 SDEB_XA_NOT_IN_USE);
6867 seq_printf(m, " %d: idx=%d%s\n", j, idx,
6868 (niu ? " not_in_use" : ""));
6875 static ssize_t delay_show(struct device_driver *ddp, char *buf)
6877 return scnprintf(buf, PAGE_SIZE, "%d\n", sdebug_jdelay);
6879 /* Returns -EBUSY if jdelay is being changed and commands are queued. The unit
6880 * of delay is jiffies.
6882 static ssize_t delay_store(struct device_driver *ddp, const char *buf,
6887 if (count > 0 && sscanf(buf, "%d", &jdelay) == 1) {
6889 if (sdebug_jdelay != jdelay) {
6890 struct sdebug_host_info *sdhp;
6892 mutex_lock(&sdebug_host_list_mutex);
6893 block_unblock_all_queues(true);
6895 list_for_each_entry(sdhp, &sdebug_host_list, host_list) {
6896 struct Scsi_Host *shost = sdhp->shost;
6898 if (scsi_host_busy(shost)) {
6899 res = -EBUSY; /* queued commands */
6904 sdebug_jdelay = jdelay;
6907 block_unblock_all_queues(false);
6908 mutex_unlock(&sdebug_host_list_mutex);
6914 static DRIVER_ATTR_RW(delay);
6916 static ssize_t ndelay_show(struct device_driver *ddp, char *buf)
6918 return scnprintf(buf, PAGE_SIZE, "%d\n", sdebug_ndelay);
6920 /* Returns -EBUSY if ndelay is being changed and commands are queued */
6921 /* If > 0 and accepted then sdebug_jdelay is set to JDELAY_OVERRIDDEN */
6922 static ssize_t ndelay_store(struct device_driver *ddp, const char *buf,
6927 if ((count > 0) && (1 == sscanf(buf, "%d", &ndelay)) &&
6928 (ndelay >= 0) && (ndelay < (1000 * 1000 * 1000))) {
6930 if (sdebug_ndelay != ndelay) {
6931 struct sdebug_host_info *sdhp;
6933 mutex_lock(&sdebug_host_list_mutex);
6934 block_unblock_all_queues(true);
6936 list_for_each_entry(sdhp, &sdebug_host_list, host_list) {
6937 struct Scsi_Host *shost = sdhp->shost;
6939 if (scsi_host_busy(shost)) {
6940 res = -EBUSY; /* queued commands */
6946 sdebug_ndelay = ndelay;
6947 sdebug_jdelay = ndelay ? JDELAY_OVERRIDDEN
6950 block_unblock_all_queues(false);
6951 mutex_unlock(&sdebug_host_list_mutex);
6957 static DRIVER_ATTR_RW(ndelay);
6959 static ssize_t opts_show(struct device_driver *ddp, char *buf)
6961 return scnprintf(buf, PAGE_SIZE, "0x%x\n", sdebug_opts);
6964 static ssize_t opts_store(struct device_driver *ddp, const char *buf,
6970 if (sscanf(buf, "%10s", work) == 1) {
6971 if (strncasecmp(work, "0x", 2) == 0) {
6972 if (kstrtoint(work + 2, 16, &opts) == 0)
6975 if (kstrtoint(work, 10, &opts) == 0)
6982 sdebug_verbose = !!(SDEBUG_OPT_NOISE & opts);
6983 sdebug_any_injecting_opt = !!(SDEBUG_OPT_ALL_INJECTING & opts);
6987 static DRIVER_ATTR_RW(opts);
6989 static ssize_t ptype_show(struct device_driver *ddp, char *buf)
6991 return scnprintf(buf, PAGE_SIZE, "%d\n", sdebug_ptype);
6993 static ssize_t ptype_store(struct device_driver *ddp, const char *buf,
6998 /* Cannot change from or to TYPE_ZBC with sysfs */
6999 if (sdebug_ptype == TYPE_ZBC)
7002 if ((count > 0) && (1 == sscanf(buf, "%d", &n)) && (n >= 0)) {
7010 static DRIVER_ATTR_RW(ptype);
7012 static ssize_t dsense_show(struct device_driver *ddp, char *buf)
7014 return scnprintf(buf, PAGE_SIZE, "%d\n", sdebug_dsense);
7016 static ssize_t dsense_store(struct device_driver *ddp, const char *buf,
7021 if ((count > 0) && (1 == sscanf(buf, "%d", &n)) && (n >= 0)) {
7027 static DRIVER_ATTR_RW(dsense);
7029 static ssize_t fake_rw_show(struct device_driver *ddp, char *buf)
7031 return scnprintf(buf, PAGE_SIZE, "%d\n", sdebug_fake_rw);
7033 static ssize_t fake_rw_store(struct device_driver *ddp, const char *buf,
7038 if ((count > 0) && (1 == sscanf(buf, "%d", &n)) && (n >= 0)) {
7039 bool want_store = (n == 0);
7040 struct sdebug_host_info *sdhp;
7043 sdebug_fake_rw = (sdebug_fake_rw > 0);
7044 if (sdebug_fake_rw == n)
7045 return count; /* not transitioning so do nothing */
7047 if (want_store) { /* 1 --> 0 transition, set up store */
7048 if (sdeb_first_idx < 0) {
7049 idx = sdebug_add_store();
7053 idx = sdeb_first_idx;
7054 xa_clear_mark(per_store_ap, idx,
7055 SDEB_XA_NOT_IN_USE);
7057 /* make all hosts use same store */
7058 list_for_each_entry(sdhp, &sdebug_host_list,
7060 if (sdhp->si_idx != idx) {
7061 xa_set_mark(per_store_ap, sdhp->si_idx,
7062 SDEB_XA_NOT_IN_USE);
7066 sdeb_most_recent_idx = idx;
7067 } else { /* 0 --> 1 transition is trigger for shrink */
7068 sdebug_erase_all_stores(true /* apart from first */);
7075 static DRIVER_ATTR_RW(fake_rw);
7077 static ssize_t no_lun_0_show(struct device_driver *ddp, char *buf)
7079 return scnprintf(buf, PAGE_SIZE, "%d\n", sdebug_no_lun_0);
7081 static ssize_t no_lun_0_store(struct device_driver *ddp, const char *buf,
7086 if ((count > 0) && (1 == sscanf(buf, "%d", &n)) && (n >= 0)) {
7087 sdebug_no_lun_0 = n;
7092 static DRIVER_ATTR_RW(no_lun_0);
7094 static ssize_t num_tgts_show(struct device_driver *ddp, char *buf)
7096 return scnprintf(buf, PAGE_SIZE, "%d\n", sdebug_num_tgts);
7098 static ssize_t num_tgts_store(struct device_driver *ddp, const char *buf,
7103 if ((count > 0) && (1 == sscanf(buf, "%d", &n)) && (n >= 0)) {
7104 sdebug_num_tgts = n;
7105 sdebug_max_tgts_luns();
7110 static DRIVER_ATTR_RW(num_tgts);
7112 static ssize_t dev_size_mb_show(struct device_driver *ddp, char *buf)
7114 return scnprintf(buf, PAGE_SIZE, "%d\n", sdebug_dev_size_mb);
7116 static DRIVER_ATTR_RO(dev_size_mb);
7118 static ssize_t per_host_store_show(struct device_driver *ddp, char *buf)
7120 return scnprintf(buf, PAGE_SIZE, "%d\n", sdebug_per_host_store);
7123 static ssize_t per_host_store_store(struct device_driver *ddp, const char *buf,
7128 if (kstrtobool(buf, &v))
7131 sdebug_per_host_store = v;
7134 static DRIVER_ATTR_RW(per_host_store);
7136 static ssize_t num_parts_show(struct device_driver *ddp, char *buf)
7138 return scnprintf(buf, PAGE_SIZE, "%d\n", sdebug_num_parts);
7140 static DRIVER_ATTR_RO(num_parts);
7142 static ssize_t every_nth_show(struct device_driver *ddp, char *buf)
7144 return scnprintf(buf, PAGE_SIZE, "%d\n", sdebug_every_nth);
7146 static ssize_t every_nth_store(struct device_driver *ddp, const char *buf,
7152 if (sscanf(buf, "%10s", work) == 1) {
7153 if (strncasecmp(work, "0x", 2) == 0) {
7154 if (kstrtoint(work + 2, 16, &nth) == 0)
7155 goto every_nth_done;
7157 if (kstrtoint(work, 10, &nth) == 0)
7158 goto every_nth_done;
7164 sdebug_every_nth = nth;
7165 if (nth && !sdebug_statistics) {
7166 pr_info("every_nth needs statistics=1, set it\n");
7167 sdebug_statistics = true;
7172 static DRIVER_ATTR_RW(every_nth);
7174 static ssize_t lun_format_show(struct device_driver *ddp, char *buf)
7176 return scnprintf(buf, PAGE_SIZE, "%d\n", (int)sdebug_lun_am);
7178 static ssize_t lun_format_store(struct device_driver *ddp, const char *buf,
7184 if (kstrtoint(buf, 0, &n))
7187 if (n > (int)SAM_LUN_AM_FLAT) {
7188 pr_warn("only LUN address methods 0 and 1 are supported\n");
7191 changed = ((int)sdebug_lun_am != n);
7193 if (changed && sdebug_scsi_level >= 5) { /* >= SPC-3 */
7194 struct sdebug_host_info *sdhp;
7195 struct sdebug_dev_info *dp;
7197 mutex_lock(&sdebug_host_list_mutex);
7198 list_for_each_entry(sdhp, &sdebug_host_list, host_list) {
7199 list_for_each_entry(dp, &sdhp->dev_info_list, dev_list) {
7200 set_bit(SDEBUG_UA_LUNS_CHANGED, dp->uas_bm);
7203 mutex_unlock(&sdebug_host_list_mutex);
7209 static DRIVER_ATTR_RW(lun_format);
7211 static ssize_t max_luns_show(struct device_driver *ddp, char *buf)
7213 return scnprintf(buf, PAGE_SIZE, "%d\n", sdebug_max_luns);
7215 static ssize_t max_luns_store(struct device_driver *ddp, const char *buf,
7221 if ((count > 0) && (1 == sscanf(buf, "%d", &n)) && (n >= 0)) {
7223 pr_warn("max_luns can be no more than 256\n");
7226 changed = (sdebug_max_luns != n);
7227 sdebug_max_luns = n;
7228 sdebug_max_tgts_luns();
7229 if (changed && (sdebug_scsi_level >= 5)) { /* >= SPC-3 */
7230 struct sdebug_host_info *sdhp;
7231 struct sdebug_dev_info *dp;
7233 mutex_lock(&sdebug_host_list_mutex);
7234 list_for_each_entry(sdhp, &sdebug_host_list,
7236 list_for_each_entry(dp, &sdhp->dev_info_list,
7238 set_bit(SDEBUG_UA_LUNS_CHANGED,
7242 mutex_unlock(&sdebug_host_list_mutex);
7248 static DRIVER_ATTR_RW(max_luns);
7250 static ssize_t max_queue_show(struct device_driver *ddp, char *buf)
7252 return scnprintf(buf, PAGE_SIZE, "%d\n", sdebug_max_queue);
7254 /* N.B. max_queue can be changed while there are queued commands. In flight
7255 * commands beyond the new max_queue will be completed. */
7256 static ssize_t max_queue_store(struct device_driver *ddp, const char *buf,
7261 if ((count > 0) && (1 == sscanf(buf, "%d", &n)) && (n > 0) &&
7262 (n <= SDEBUG_CANQUEUE) &&
7263 (sdebug_host_max_queue == 0)) {
7264 mutex_lock(&sdebug_host_list_mutex);
7266 /* We may only change sdebug_max_queue when we have no shosts */
7267 if (list_empty(&sdebug_host_list))
7268 sdebug_max_queue = n;
7271 mutex_unlock(&sdebug_host_list_mutex);
7276 static DRIVER_ATTR_RW(max_queue);
7278 static ssize_t host_max_queue_show(struct device_driver *ddp, char *buf)
7280 return scnprintf(buf, PAGE_SIZE, "%d\n", sdebug_host_max_queue);
7283 static ssize_t no_rwlock_show(struct device_driver *ddp, char *buf)
7285 return scnprintf(buf, PAGE_SIZE, "%d\n", sdebug_no_rwlock);
7288 static ssize_t no_rwlock_store(struct device_driver *ddp, const char *buf, size_t count)
7292 if (kstrtobool(buf, &v))
7295 sdebug_no_rwlock = v;
7298 static DRIVER_ATTR_RW(no_rwlock);
7301 * Since this is used for .can_queue, and we get the hc_idx tag from the bitmap
7302 * in range [0, sdebug_host_max_queue), we can't change it.
7304 static DRIVER_ATTR_RO(host_max_queue);
7306 static ssize_t no_uld_show(struct device_driver *ddp, char *buf)
7308 return scnprintf(buf, PAGE_SIZE, "%d\n", sdebug_no_uld);
7310 static DRIVER_ATTR_RO(no_uld);
7312 static ssize_t scsi_level_show(struct device_driver *ddp, char *buf)
7314 return scnprintf(buf, PAGE_SIZE, "%d\n", sdebug_scsi_level);
7316 static DRIVER_ATTR_RO(scsi_level);
7318 static ssize_t virtual_gb_show(struct device_driver *ddp, char *buf)
7320 return scnprintf(buf, PAGE_SIZE, "%d\n", sdebug_virtual_gb);
7322 static ssize_t virtual_gb_store(struct device_driver *ddp, const char *buf,
7328 /* Ignore capacity change for ZBC drives for now */
7329 if (sdeb_zbc_in_use)
7332 if ((count > 0) && (1 == sscanf(buf, "%d", &n)) && (n >= 0)) {
7333 changed = (sdebug_virtual_gb != n);
7334 sdebug_virtual_gb = n;
7335 sdebug_capacity = get_sdebug_capacity();
7337 struct sdebug_host_info *sdhp;
7338 struct sdebug_dev_info *dp;
7340 mutex_lock(&sdebug_host_list_mutex);
7341 list_for_each_entry(sdhp, &sdebug_host_list,
7343 list_for_each_entry(dp, &sdhp->dev_info_list,
7345 set_bit(SDEBUG_UA_CAPACITY_CHANGED,
7349 mutex_unlock(&sdebug_host_list_mutex);
7355 static DRIVER_ATTR_RW(virtual_gb);
7357 static ssize_t add_host_show(struct device_driver *ddp, char *buf)
7359 /* absolute number of hosts currently active is what is shown */
7360 return scnprintf(buf, PAGE_SIZE, "%d\n", sdebug_num_hosts);
7363 static ssize_t add_host_store(struct device_driver *ddp, const char *buf,
7368 struct sdeb_store_info *sip;
7369 bool want_phs = (sdebug_fake_rw == 0) && sdebug_per_host_store;
7372 if (sscanf(buf, "%d", &delta_hosts) != 1)
7374 if (delta_hosts > 0) {
7378 xa_for_each_marked(per_store_ap, idx, sip,
7379 SDEB_XA_NOT_IN_USE) {
7380 sdeb_most_recent_idx = (int)idx;
7384 if (found) /* re-use case */
7385 sdebug_add_host_helper((int)idx);
7387 sdebug_do_add_host(true);
7389 sdebug_do_add_host(false);
7391 } while (--delta_hosts);
7392 } else if (delta_hosts < 0) {
7394 sdebug_do_remove_host(false);
7395 } while (++delta_hosts);
7399 static DRIVER_ATTR_RW(add_host);
7401 static ssize_t vpd_use_hostno_show(struct device_driver *ddp, char *buf)
7403 return scnprintf(buf, PAGE_SIZE, "%d\n", sdebug_vpd_use_hostno);
7405 static ssize_t vpd_use_hostno_store(struct device_driver *ddp, const char *buf,
7410 if ((count > 0) && (1 == sscanf(buf, "%d", &n)) && (n >= 0)) {
7411 sdebug_vpd_use_hostno = n;
7416 static DRIVER_ATTR_RW(vpd_use_hostno);
7418 static ssize_t statistics_show(struct device_driver *ddp, char *buf)
7420 return scnprintf(buf, PAGE_SIZE, "%d\n", (int)sdebug_statistics);
7422 static ssize_t statistics_store(struct device_driver *ddp, const char *buf,
7427 if ((count > 0) && (sscanf(buf, "%d", &n) == 1) && (n >= 0)) {
7429 sdebug_statistics = true;
7431 clear_queue_stats();
7432 sdebug_statistics = false;
7438 static DRIVER_ATTR_RW(statistics);
7440 static ssize_t sector_size_show(struct device_driver *ddp, char *buf)
7442 return scnprintf(buf, PAGE_SIZE, "%u\n", sdebug_sector_size);
7444 static DRIVER_ATTR_RO(sector_size);
7446 static ssize_t submit_queues_show(struct device_driver *ddp, char *buf)
7448 return scnprintf(buf, PAGE_SIZE, "%d\n", submit_queues);
7450 static DRIVER_ATTR_RO(submit_queues);
7452 static ssize_t dix_show(struct device_driver *ddp, char *buf)
7454 return scnprintf(buf, PAGE_SIZE, "%d\n", sdebug_dix);
7456 static DRIVER_ATTR_RO(dix);
7458 static ssize_t dif_show(struct device_driver *ddp, char *buf)
7460 return scnprintf(buf, PAGE_SIZE, "%d\n", sdebug_dif);
7462 static DRIVER_ATTR_RO(dif);
7464 static ssize_t guard_show(struct device_driver *ddp, char *buf)
7466 return scnprintf(buf, PAGE_SIZE, "%u\n", sdebug_guard);
7468 static DRIVER_ATTR_RO(guard);
7470 static ssize_t ato_show(struct device_driver *ddp, char *buf)
7472 return scnprintf(buf, PAGE_SIZE, "%d\n", sdebug_ato);
7474 static DRIVER_ATTR_RO(ato);
7476 static ssize_t map_show(struct device_driver *ddp, char *buf)
7480 if (!scsi_debug_lbp())
7481 return scnprintf(buf, PAGE_SIZE, "0-%u\n",
7482 sdebug_store_sectors);
7484 if (sdebug_fake_rw == 0 && !xa_empty(per_store_ap)) {
7485 struct sdeb_store_info *sip = xa_load(per_store_ap, 0);
7488 count = scnprintf(buf, PAGE_SIZE - 1, "%*pbl",
7489 (int)map_size, sip->map_storep);
7491 buf[count++] = '\n';
7496 static DRIVER_ATTR_RO(map);
7498 static ssize_t random_show(struct device_driver *ddp, char *buf)
7500 return scnprintf(buf, PAGE_SIZE, "%d\n", sdebug_random);
7503 static ssize_t random_store(struct device_driver *ddp, const char *buf,
7508 if (kstrtobool(buf, &v))
7514 static DRIVER_ATTR_RW(random);
7516 static ssize_t removable_show(struct device_driver *ddp, char *buf)
7518 return scnprintf(buf, PAGE_SIZE, "%d\n", sdebug_removable ? 1 : 0);
7520 static ssize_t removable_store(struct device_driver *ddp, const char *buf,
7525 if ((count > 0) && (1 == sscanf(buf, "%d", &n)) && (n >= 0)) {
7526 sdebug_removable = (n > 0);
7531 static DRIVER_ATTR_RW(removable);
7533 static ssize_t host_lock_show(struct device_driver *ddp, char *buf)
7535 return scnprintf(buf, PAGE_SIZE, "%d\n", !!sdebug_host_lock);
7537 /* N.B. sdebug_host_lock does nothing, kept for backward compatibility */
7538 static ssize_t host_lock_store(struct device_driver *ddp, const char *buf,
7543 if ((count > 0) && (1 == sscanf(buf, "%d", &n)) && (n >= 0)) {
7544 sdebug_host_lock = (n > 0);
7549 static DRIVER_ATTR_RW(host_lock);
7551 static ssize_t strict_show(struct device_driver *ddp, char *buf)
7553 return scnprintf(buf, PAGE_SIZE, "%d\n", !!sdebug_strict);
7555 static ssize_t strict_store(struct device_driver *ddp, const char *buf,
7560 if ((count > 0) && (1 == sscanf(buf, "%d", &n)) && (n >= 0)) {
7561 sdebug_strict = (n > 0);
7566 static DRIVER_ATTR_RW(strict);
7568 static ssize_t uuid_ctl_show(struct device_driver *ddp, char *buf)
7570 return scnprintf(buf, PAGE_SIZE, "%d\n", !!sdebug_uuid_ctl);
7572 static DRIVER_ATTR_RO(uuid_ctl);
7574 static ssize_t cdb_len_show(struct device_driver *ddp, char *buf)
7576 return scnprintf(buf, PAGE_SIZE, "%d\n", sdebug_cdb_len);
7578 static ssize_t cdb_len_store(struct device_driver *ddp, const char *buf,
7583 ret = kstrtoint(buf, 0, &n);
7587 all_config_cdb_len();
7590 static DRIVER_ATTR_RW(cdb_len);
7592 static const char * const zbc_model_strs_a[] = {
7593 [BLK_ZONED_NONE] = "none",
7594 [BLK_ZONED_HA] = "host-aware",
7595 [BLK_ZONED_HM] = "host-managed",
7598 static const char * const zbc_model_strs_b[] = {
7599 [BLK_ZONED_NONE] = "no",
7600 [BLK_ZONED_HA] = "aware",
7601 [BLK_ZONED_HM] = "managed",
7604 static const char * const zbc_model_strs_c[] = {
7605 [BLK_ZONED_NONE] = "0",
7606 [BLK_ZONED_HA] = "1",
7607 [BLK_ZONED_HM] = "2",
7610 static int sdeb_zbc_model_str(const char *cp)
7612 int res = sysfs_match_string(zbc_model_strs_a, cp);
7615 res = sysfs_match_string(zbc_model_strs_b, cp);
7617 res = sysfs_match_string(zbc_model_strs_c, cp);
7625 static ssize_t zbc_show(struct device_driver *ddp, char *buf)
7627 return scnprintf(buf, PAGE_SIZE, "%s\n",
7628 zbc_model_strs_a[sdeb_zbc_model]);
7630 static DRIVER_ATTR_RO(zbc);
7632 static ssize_t tur_ms_to_ready_show(struct device_driver *ddp, char *buf)
7634 return scnprintf(buf, PAGE_SIZE, "%d\n", sdeb_tur_ms_to_ready);
7636 static DRIVER_ATTR_RO(tur_ms_to_ready);
7638 static ssize_t group_number_stats_show(struct device_driver *ddp, char *buf)
7640 char *p = buf, *end = buf + PAGE_SIZE;
7643 for (i = 0; i < ARRAY_SIZE(writes_by_group_number); i++)
7644 p += scnprintf(p, end - p, "%d %ld\n", i,
7645 atomic_long_read(&writes_by_group_number[i]));
7650 static ssize_t group_number_stats_store(struct device_driver *ddp,
7651 const char *buf, size_t count)
7655 for (i = 0; i < ARRAY_SIZE(writes_by_group_number); i++)
7656 atomic_long_set(&writes_by_group_number[i], 0);
7660 static DRIVER_ATTR_RW(group_number_stats);
7662 /* Note: The following array creates attribute files in the
7663 /sys/bus/pseudo/drivers/scsi_debug directory. The advantage of these
7664 files (over those found in the /sys/module/scsi_debug/parameters
7665 directory) is that auxiliary actions can be triggered when an attribute
7666 is changed. For example see: add_host_store() above.
7669 static struct attribute *sdebug_drv_attrs[] = {
7670 &driver_attr_delay.attr,
7671 &driver_attr_opts.attr,
7672 &driver_attr_ptype.attr,
7673 &driver_attr_dsense.attr,
7674 &driver_attr_fake_rw.attr,
7675 &driver_attr_host_max_queue.attr,
7676 &driver_attr_no_lun_0.attr,
7677 &driver_attr_num_tgts.attr,
7678 &driver_attr_dev_size_mb.attr,
7679 &driver_attr_num_parts.attr,
7680 &driver_attr_every_nth.attr,
7681 &driver_attr_lun_format.attr,
7682 &driver_attr_max_luns.attr,
7683 &driver_attr_max_queue.attr,
7684 &driver_attr_no_rwlock.attr,
7685 &driver_attr_no_uld.attr,
7686 &driver_attr_scsi_level.attr,
7687 &driver_attr_virtual_gb.attr,
7688 &driver_attr_add_host.attr,
7689 &driver_attr_per_host_store.attr,
7690 &driver_attr_vpd_use_hostno.attr,
7691 &driver_attr_sector_size.attr,
7692 &driver_attr_statistics.attr,
7693 &driver_attr_submit_queues.attr,
7694 &driver_attr_dix.attr,
7695 &driver_attr_dif.attr,
7696 &driver_attr_guard.attr,
7697 &driver_attr_ato.attr,
7698 &driver_attr_map.attr,
7699 &driver_attr_random.attr,
7700 &driver_attr_removable.attr,
7701 &driver_attr_host_lock.attr,
7702 &driver_attr_ndelay.attr,
7703 &driver_attr_strict.attr,
7704 &driver_attr_uuid_ctl.attr,
7705 &driver_attr_cdb_len.attr,
7706 &driver_attr_tur_ms_to_ready.attr,
7707 &driver_attr_zbc.attr,
7708 &driver_attr_group_number_stats.attr,
7711 ATTRIBUTE_GROUPS(sdebug_drv);
7713 static struct device *pseudo_primary;
7715 static int __init scsi_debug_init(void)
7717 bool want_store = (sdebug_fake_rw == 0);
7719 int k, ret, hosts_to_add;
7722 if (sdebug_ndelay >= 1000 * 1000 * 1000) {
7723 pr_warn("ndelay must be less than 1 second, ignored\n");
7725 } else if (sdebug_ndelay > 0)
7726 sdebug_jdelay = JDELAY_OVERRIDDEN;
7728 switch (sdebug_sector_size) {
7735 pr_err("invalid sector_size %d\n", sdebug_sector_size);
7739 switch (sdebug_dif) {
7740 case T10_PI_TYPE0_PROTECTION:
7742 case T10_PI_TYPE1_PROTECTION:
7743 case T10_PI_TYPE2_PROTECTION:
7744 case T10_PI_TYPE3_PROTECTION:
7745 have_dif_prot = true;
7749 pr_err("dif must be 0, 1, 2 or 3\n");
7753 if (sdebug_num_tgts < 0) {
7754 pr_err("num_tgts must be >= 0\n");
7758 if (sdebug_guard > 1) {
7759 pr_err("guard must be 0 or 1\n");
7763 if (sdebug_ato > 1) {
7764 pr_err("ato must be 0 or 1\n");
7768 if (sdebug_physblk_exp > 15) {
7769 pr_err("invalid physblk_exp %u\n", sdebug_physblk_exp);
7773 sdebug_lun_am = sdebug_lun_am_i;
7774 if (sdebug_lun_am > SAM_LUN_AM_FLAT) {
7775 pr_warn("Invalid LUN format %u, using default\n", (int)sdebug_lun_am);
7776 sdebug_lun_am = SAM_LUN_AM_PERIPHERAL;
7779 if (sdebug_max_luns > 256) {
7780 if (sdebug_max_luns > 16384) {
7781 pr_warn("max_luns can be no more than 16384, use default\n");
7782 sdebug_max_luns = DEF_MAX_LUNS;
7784 sdebug_lun_am = SAM_LUN_AM_FLAT;
7787 if (sdebug_lowest_aligned > 0x3fff) {
7788 pr_err("lowest_aligned too big: %u\n", sdebug_lowest_aligned);
7792 if (submit_queues < 1) {
7793 pr_err("submit_queues must be 1 or more\n");
7797 if ((sdebug_max_queue > SDEBUG_CANQUEUE) || (sdebug_max_queue < 1)) {
7798 pr_err("max_queue must be in range [1, %d]\n", SDEBUG_CANQUEUE);
7802 if ((sdebug_host_max_queue > SDEBUG_CANQUEUE) ||
7803 (sdebug_host_max_queue < 0)) {
7804 pr_err("host_max_queue must be in range [0 %d]\n",
7809 if (sdebug_host_max_queue &&
7810 (sdebug_max_queue != sdebug_host_max_queue)) {
7811 sdebug_max_queue = sdebug_host_max_queue;
7812 pr_warn("fixing max submit queue depth to host max queue depth, %d\n",
7817 * check for host managed zoned block device specified with
7818 * ptype=0x14 or zbc=XXX.
7820 if (sdebug_ptype == TYPE_ZBC) {
7821 sdeb_zbc_model = BLK_ZONED_HM;
7822 } else if (sdeb_zbc_model_s && *sdeb_zbc_model_s) {
7823 k = sdeb_zbc_model_str(sdeb_zbc_model_s);
7827 switch (sdeb_zbc_model) {
7828 case BLK_ZONED_NONE:
7830 sdebug_ptype = TYPE_DISK;
7833 sdebug_ptype = TYPE_ZBC;
7836 pr_err("Invalid ZBC model\n");
7840 if (sdeb_zbc_model != BLK_ZONED_NONE) {
7841 sdeb_zbc_in_use = true;
7842 if (sdebug_dev_size_mb == DEF_DEV_SIZE_PRE_INIT)
7843 sdebug_dev_size_mb = DEF_ZBC_DEV_SIZE_MB;
7846 if (sdebug_dev_size_mb == DEF_DEV_SIZE_PRE_INIT)
7847 sdebug_dev_size_mb = DEF_DEV_SIZE_MB;
7848 if (sdebug_dev_size_mb < 1)
7849 sdebug_dev_size_mb = 1; /* force minimum 1 MB ramdisk */
7850 sz = (unsigned long)sdebug_dev_size_mb * 1048576;
7851 sdebug_store_sectors = sz / sdebug_sector_size;
7852 sdebug_capacity = get_sdebug_capacity();
7854 /* play around with geometry, don't waste too much on track 0 */
7856 sdebug_sectors_per = 32;
7857 if (sdebug_dev_size_mb >= 256)
7859 else if (sdebug_dev_size_mb >= 16)
7861 sdebug_cylinders_per = (unsigned long)sdebug_capacity /
7862 (sdebug_sectors_per * sdebug_heads);
7863 if (sdebug_cylinders_per >= 1024) {
7864 /* other LLDs do this; implies >= 1GB ram disk ... */
7866 sdebug_sectors_per = 63;
7867 sdebug_cylinders_per = (unsigned long)sdebug_capacity /
7868 (sdebug_sectors_per * sdebug_heads);
7870 if (scsi_debug_lbp()) {
7871 sdebug_unmap_max_blocks =
7872 clamp(sdebug_unmap_max_blocks, 0U, 0xffffffffU);
7874 sdebug_unmap_max_desc =
7875 clamp(sdebug_unmap_max_desc, 0U, 256U);
7877 sdebug_unmap_granularity =
7878 clamp(sdebug_unmap_granularity, 1U, 0xffffffffU);
7880 if (sdebug_unmap_alignment &&
7881 sdebug_unmap_granularity <=
7882 sdebug_unmap_alignment) {
7883 pr_err("ERR: unmap_granularity <= unmap_alignment\n");
7888 xa_init_flags(per_store_ap, XA_FLAGS_ALLOC | XA_FLAGS_LOCK_IRQ);
7890 idx = sdebug_add_store();
7895 pseudo_primary = root_device_register("pseudo_0");
7896 if (IS_ERR(pseudo_primary)) {
7897 pr_warn("root_device_register() error\n");
7898 ret = PTR_ERR(pseudo_primary);
7901 ret = bus_register(&pseudo_lld_bus);
7903 pr_warn("bus_register error: %d\n", ret);
7906 ret = driver_register(&sdebug_driverfs_driver);
7908 pr_warn("driver_register error: %d\n", ret);
7912 hosts_to_add = sdebug_add_host;
7913 sdebug_add_host = 0;
7915 queued_cmd_cache = KMEM_CACHE(sdebug_queued_cmd, SLAB_HWCACHE_ALIGN);
7916 if (!queued_cmd_cache) {
7921 sdebug_debugfs_root = debugfs_create_dir("scsi_debug", NULL);
7922 if (IS_ERR_OR_NULL(sdebug_debugfs_root))
7923 pr_info("%s: failed to create initial debugfs directory\n", __func__);
7925 for (k = 0; k < hosts_to_add; k++) {
7926 if (want_store && k == 0) {
7927 ret = sdebug_add_host_helper(idx);
7929 pr_err("add_host_helper k=%d, error=%d\n",
7934 ret = sdebug_do_add_host(want_store &&
7935 sdebug_per_host_store);
7937 pr_err("add_host k=%d error=%d\n", k, -ret);
7943 pr_info("built %d host(s)\n", sdebug_num_hosts);
7948 driver_unregister(&sdebug_driverfs_driver);
7950 bus_unregister(&pseudo_lld_bus);
7952 root_device_unregister(pseudo_primary);
7954 sdebug_erase_store(idx, NULL);
7958 static void __exit scsi_debug_exit(void)
7960 int k = sdebug_num_hosts;
7963 sdebug_do_remove_host(true);
7964 kmem_cache_destroy(queued_cmd_cache);
7965 driver_unregister(&sdebug_driverfs_driver);
7966 bus_unregister(&pseudo_lld_bus);
7967 root_device_unregister(pseudo_primary);
7969 sdebug_erase_all_stores(false);
7970 xa_destroy(per_store_ap);
7971 debugfs_remove(sdebug_debugfs_root);
7974 device_initcall(scsi_debug_init);
7975 module_exit(scsi_debug_exit);
7977 static void sdebug_release_adapter(struct device *dev)
7979 struct sdebug_host_info *sdbg_host;
7981 sdbg_host = dev_to_sdebug_host(dev);
7985 /* idx must be valid, if sip is NULL then it will be obtained using idx */
7986 static void sdebug_erase_store(int idx, struct sdeb_store_info *sip)
7991 if (xa_empty(per_store_ap))
7993 sip = xa_load(per_store_ap, idx);
7997 vfree(sip->map_storep);
7998 vfree(sip->dif_storep);
8000 xa_erase(per_store_ap, idx);
8004 /* Assume apart_from_first==false only in shutdown case. */
8005 static void sdebug_erase_all_stores(bool apart_from_first)
8008 struct sdeb_store_info *sip = NULL;
8010 xa_for_each(per_store_ap, idx, sip) {
8011 if (apart_from_first)
8012 apart_from_first = false;
8014 sdebug_erase_store(idx, sip);
8016 if (apart_from_first)
8017 sdeb_most_recent_idx = sdeb_first_idx;
8021 * Returns store xarray new element index (idx) if >=0 else negated errno.
8022 * Limit the number of stores to 65536.
8024 static int sdebug_add_store(void)
8028 unsigned long iflags;
8029 unsigned long sz = (unsigned long)sdebug_dev_size_mb * 1048576;
8030 struct sdeb_store_info *sip = NULL;
8031 struct xa_limit xal = { .max = 1 << 16, .min = 0 };
8033 sip = kzalloc(sizeof(*sip), GFP_KERNEL);
8037 xa_lock_irqsave(per_store_ap, iflags);
8038 res = __xa_alloc(per_store_ap, &n_idx, sip, xal, GFP_ATOMIC);
8039 if (unlikely(res < 0)) {
8040 xa_unlock_irqrestore(per_store_ap, iflags);
8042 pr_warn("%s: xa_alloc() errno=%d\n", __func__, -res);
8045 sdeb_most_recent_idx = n_idx;
8046 if (sdeb_first_idx < 0)
8047 sdeb_first_idx = n_idx;
8048 xa_unlock_irqrestore(per_store_ap, iflags);
8051 sip->storep = vzalloc(sz);
8053 pr_err("user data oom\n");
8056 if (sdebug_num_parts > 0)
8057 sdebug_build_parts(sip->storep, sz);
8059 /* DIF/DIX: what T10 calls Protection Information (PI) */
8063 dif_size = sdebug_store_sectors * sizeof(struct t10_pi_tuple);
8064 sip->dif_storep = vmalloc(dif_size);
8066 pr_info("dif_storep %u bytes @ %pK\n", dif_size,
8069 if (!sip->dif_storep) {
8070 pr_err("DIX oom\n");
8073 memset(sip->dif_storep, 0xff, dif_size);
8075 /* Logical Block Provisioning */
8076 if (scsi_debug_lbp()) {
8077 map_size = lba_to_map_index(sdebug_store_sectors - 1) + 1;
8078 sip->map_storep = vmalloc(array_size(sizeof(long),
8079 BITS_TO_LONGS(map_size)));
8081 pr_info("%lu provisioning blocks\n", map_size);
8083 if (!sip->map_storep) {
8084 pr_err("LBP map oom\n");
8088 bitmap_zero(sip->map_storep, map_size);
8090 /* Map first 1KB for partition table */
8091 if (sdebug_num_parts)
8092 map_region(sip, 0, 2);
8095 rwlock_init(&sip->macc_data_lck);
8096 rwlock_init(&sip->macc_meta_lck);
8097 rwlock_init(&sip->macc_sector_lck);
8100 sdebug_erase_store((int)n_idx, sip);
8101 pr_warn("%s: failed, errno=%d\n", __func__, -res);
8105 static int sdebug_add_host_helper(int per_host_idx)
8107 int k, devs_per_host, idx;
8108 int error = -ENOMEM;
8109 struct sdebug_host_info *sdbg_host;
8110 struct sdebug_dev_info *sdbg_devinfo, *tmp;
8112 sdbg_host = kzalloc(sizeof(*sdbg_host), GFP_KERNEL);
8115 idx = (per_host_idx < 0) ? sdeb_first_idx : per_host_idx;
8116 if (xa_get_mark(per_store_ap, idx, SDEB_XA_NOT_IN_USE))
8117 xa_clear_mark(per_store_ap, idx, SDEB_XA_NOT_IN_USE);
8118 sdbg_host->si_idx = idx;
8120 INIT_LIST_HEAD(&sdbg_host->dev_info_list);
8122 devs_per_host = sdebug_num_tgts * sdebug_max_luns;
8123 for (k = 0; k < devs_per_host; k++) {
8124 sdbg_devinfo = sdebug_device_create(sdbg_host, GFP_KERNEL);
8129 mutex_lock(&sdebug_host_list_mutex);
8130 list_add_tail(&sdbg_host->host_list, &sdebug_host_list);
8131 mutex_unlock(&sdebug_host_list_mutex);
8133 sdbg_host->dev.bus = &pseudo_lld_bus;
8134 sdbg_host->dev.parent = pseudo_primary;
8135 sdbg_host->dev.release = &sdebug_release_adapter;
8136 dev_set_name(&sdbg_host->dev, "adapter%d", sdebug_num_hosts);
8138 error = device_register(&sdbg_host->dev);
8140 mutex_lock(&sdebug_host_list_mutex);
8141 list_del(&sdbg_host->host_list);
8142 mutex_unlock(&sdebug_host_list_mutex);
8150 list_for_each_entry_safe(sdbg_devinfo, tmp, &sdbg_host->dev_info_list,
8152 list_del(&sdbg_devinfo->dev_list);
8153 kfree(sdbg_devinfo->zstate);
8154 kfree(sdbg_devinfo);
8156 if (sdbg_host->dev.release)
8157 put_device(&sdbg_host->dev);
8160 pr_warn("%s: failed, errno=%d\n", __func__, -error);
8164 static int sdebug_do_add_host(bool mk_new_store)
8166 int ph_idx = sdeb_most_recent_idx;
8169 ph_idx = sdebug_add_store();
8173 return sdebug_add_host_helper(ph_idx);
8176 static void sdebug_do_remove_host(bool the_end)
8179 struct sdebug_host_info *sdbg_host = NULL;
8180 struct sdebug_host_info *sdbg_host2;
8182 mutex_lock(&sdebug_host_list_mutex);
8183 if (!list_empty(&sdebug_host_list)) {
8184 sdbg_host = list_entry(sdebug_host_list.prev,
8185 struct sdebug_host_info, host_list);
8186 idx = sdbg_host->si_idx;
8188 if (!the_end && idx >= 0) {
8191 list_for_each_entry(sdbg_host2, &sdebug_host_list, host_list) {
8192 if (sdbg_host2 == sdbg_host)
8194 if (idx == sdbg_host2->si_idx) {
8200 xa_set_mark(per_store_ap, idx, SDEB_XA_NOT_IN_USE);
8201 if (idx == sdeb_most_recent_idx)
8202 --sdeb_most_recent_idx;
8206 list_del(&sdbg_host->host_list);
8207 mutex_unlock(&sdebug_host_list_mutex);
8212 device_unregister(&sdbg_host->dev);
8216 static int sdebug_change_qdepth(struct scsi_device *sdev, int qdepth)
8218 struct sdebug_dev_info *devip = sdev->hostdata;
8223 mutex_lock(&sdebug_host_list_mutex);
8224 block_unblock_all_queues(true);
8226 if (qdepth > SDEBUG_CANQUEUE) {
8227 qdepth = SDEBUG_CANQUEUE;
8228 pr_warn("%s: requested qdepth [%d] exceeds canqueue [%d], trim\n", __func__,
8229 qdepth, SDEBUG_CANQUEUE);
8233 if (qdepth != sdev->queue_depth)
8234 scsi_change_queue_depth(sdev, qdepth);
8236 block_unblock_all_queues(false);
8237 mutex_unlock(&sdebug_host_list_mutex);
8239 if (SDEBUG_OPT_Q_NOISE & sdebug_opts)
8240 sdev_printk(KERN_INFO, sdev, "%s: qdepth=%d\n", __func__, qdepth);
8242 return sdev->queue_depth;
8245 static bool fake_timeout(struct scsi_cmnd *scp)
8247 if (0 == (atomic_read(&sdebug_cmnd_count) % abs(sdebug_every_nth))) {
8248 if (sdebug_every_nth < -1)
8249 sdebug_every_nth = -1;
8250 if (SDEBUG_OPT_TIMEOUT & sdebug_opts)
8251 return true; /* ignore command causing timeout */
8252 else if (SDEBUG_OPT_MAC_TIMEOUT & sdebug_opts &&
8253 scsi_medium_access_command(scp))
8254 return true; /* time out reads and writes */
8259 /* Response to TUR or media access command when device stopped */
8260 static int resp_not_ready(struct scsi_cmnd *scp, struct sdebug_dev_info *devip)
8264 ktime_t now_ts = ktime_get_boottime();
8265 struct scsi_device *sdp = scp->device;
8267 stopped_state = atomic_read(&devip->stopped);
8268 if (stopped_state == 2) {
8269 if (ktime_to_ns(now_ts) > ktime_to_ns(devip->create_ts)) {
8270 diff_ns = ktime_to_ns(ktime_sub(now_ts, devip->create_ts));
8271 if (diff_ns >= ((u64)sdeb_tur_ms_to_ready * 1000000)) {
8272 /* tur_ms_to_ready timer extinguished */
8273 atomic_set(&devip->stopped, 0);
8277 mk_sense_buffer(scp, NOT_READY, LOGICAL_UNIT_NOT_READY, 0x1);
8279 sdev_printk(KERN_INFO, sdp,
8280 "%s: Not ready: in process of becoming ready\n", my_name);
8281 if (scp->cmnd[0] == TEST_UNIT_READY) {
8282 u64 tur_nanosecs_to_ready = (u64)sdeb_tur_ms_to_ready * 1000000;
8284 if (diff_ns <= tur_nanosecs_to_ready)
8285 diff_ns = tur_nanosecs_to_ready - diff_ns;
8287 diff_ns = tur_nanosecs_to_ready;
8288 /* As per 20-061r2 approved for spc6 by T10 on 20200716 */
8289 do_div(diff_ns, 1000000); /* diff_ns becomes milliseconds */
8290 scsi_set_sense_information(scp->sense_buffer, SCSI_SENSE_BUFFERSIZE,
8292 return check_condition_result;
8295 mk_sense_buffer(scp, NOT_READY, LOGICAL_UNIT_NOT_READY, 0x2);
8297 sdev_printk(KERN_INFO, sdp, "%s: Not ready: initializing command required\n",
8299 return check_condition_result;
8302 static void sdebug_map_queues(struct Scsi_Host *shost)
8306 if (shost->nr_hw_queues == 1)
8309 for (i = 0, qoff = 0; i < HCTX_MAX_TYPES; i++) {
8310 struct blk_mq_queue_map *map = &shost->tag_set.map[i];
8314 if (i == HCTX_TYPE_DEFAULT)
8315 map->nr_queues = submit_queues - poll_queues;
8316 else if (i == HCTX_TYPE_POLL)
8317 map->nr_queues = poll_queues;
8319 if (!map->nr_queues) {
8320 BUG_ON(i == HCTX_TYPE_DEFAULT);
8324 map->queue_offset = qoff;
8325 blk_mq_map_queues(map);
8327 qoff += map->nr_queues;
8331 struct sdebug_blk_mq_poll_data {
8332 unsigned int queue_num;
8337 * We don't handle aborted commands here, but it does not seem possible to have
8338 * aborted polled commands from schedule_resp()
8340 static bool sdebug_blk_mq_poll_iter(struct request *rq, void *opaque)
8342 struct sdebug_blk_mq_poll_data *data = opaque;
8343 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(rq);
8344 struct sdebug_scsi_cmd *sdsc = scsi_cmd_priv(cmd);
8345 struct sdebug_defer *sd_dp;
8346 u32 unique_tag = blk_mq_unique_tag(rq);
8347 u16 hwq = blk_mq_unique_tag_to_hwq(unique_tag);
8348 struct sdebug_queued_cmd *sqcp;
8349 unsigned long flags;
8350 int queue_num = data->queue_num;
8353 /* We're only interested in one queue for this iteration */
8354 if (hwq != queue_num)
8357 /* Subsequent checks would fail if this failed, but check anyway */
8358 if (!test_bit(SCMD_STATE_INFLIGHT, &cmd->state))
8361 time = ktime_get_boottime();
8363 spin_lock_irqsave(&sdsc->lock, flags);
8364 sqcp = TO_QUEUED_CMD(cmd);
8366 spin_unlock_irqrestore(&sdsc->lock, flags);
8370 sd_dp = &sqcp->sd_dp;
8371 if (READ_ONCE(sd_dp->defer_t) != SDEB_DEFER_POLL) {
8372 spin_unlock_irqrestore(&sdsc->lock, flags);
8376 if (time < sd_dp->cmpl_ts) {
8377 spin_unlock_irqrestore(&sdsc->lock, flags);
8381 ASSIGN_QUEUED_CMD(cmd, NULL);
8382 spin_unlock_irqrestore(&sdsc->lock, flags);
8384 if (sdebug_statistics) {
8385 atomic_inc(&sdebug_completions);
8386 if (raw_smp_processor_id() != sd_dp->issuing_cpu)
8387 atomic_inc(&sdebug_miss_cpus);
8390 sdebug_free_queued_cmd(sqcp);
8392 scsi_done(cmd); /* callback to mid level */
8393 (*data->num_entries)++;
8397 static int sdebug_blk_mq_poll(struct Scsi_Host *shost, unsigned int queue_num)
8399 int num_entries = 0;
8400 struct sdebug_blk_mq_poll_data data = {
8401 .queue_num = queue_num,
8402 .num_entries = &num_entries,
8405 blk_mq_tagset_busy_iter(&shost->tag_set, sdebug_blk_mq_poll_iter,
8408 if (num_entries > 0)
8409 atomic_add(num_entries, &sdeb_mq_poll_count);
8413 static int sdebug_timeout_cmd(struct scsi_cmnd *cmnd)
8415 struct scsi_device *sdp = cmnd->device;
8416 struct sdebug_dev_info *devip = (struct sdebug_dev_info *)sdp->hostdata;
8417 struct sdebug_err_inject *err;
8418 unsigned char *cmd = cmnd->cmnd;
8425 list_for_each_entry_rcu(err, &devip->inject_err_list, list) {
8426 if (err->type == ERR_TMOUT_CMD &&
8427 (err->cmd == cmd[0] || err->cmd == 0xff)) {
8441 static int sdebug_fail_queue_cmd(struct scsi_cmnd *cmnd)
8443 struct scsi_device *sdp = cmnd->device;
8444 struct sdebug_dev_info *devip = (struct sdebug_dev_info *)sdp->hostdata;
8445 struct sdebug_err_inject *err;
8446 unsigned char *cmd = cmnd->cmnd;
8453 list_for_each_entry_rcu(err, &devip->inject_err_list, list) {
8454 if (err->type == ERR_FAIL_QUEUE_CMD &&
8455 (err->cmd == cmd[0] || err->cmd == 0xff)) {
8456 ret = err->cnt ? err->queuecmd_ret : 0;
8469 static int sdebug_fail_cmd(struct scsi_cmnd *cmnd, int *retval,
8470 struct sdebug_err_inject *info)
8472 struct scsi_device *sdp = cmnd->device;
8473 struct sdebug_dev_info *devip = (struct sdebug_dev_info *)sdp->hostdata;
8474 struct sdebug_err_inject *err;
8475 unsigned char *cmd = cmnd->cmnd;
8483 list_for_each_entry_rcu(err, &devip->inject_err_list, list) {
8484 if (err->type == ERR_FAIL_CMD &&
8485 (err->cmd == cmd[0] || err->cmd == 0xff)) {
8503 mk_sense_buffer(cmnd, err->sense_key, err->asc, err->asq);
8504 result = err->status_byte | err->host_byte << 16 | err->driver_byte << 24;
8506 *retval = schedule_resp(cmnd, devip, result, NULL, 0, 0);
8511 static int scsi_debug_queuecommand(struct Scsi_Host *shost,
8512 struct scsi_cmnd *scp)
8515 struct scsi_device *sdp = scp->device;
8516 const struct opcode_info_t *oip;
8517 const struct opcode_info_t *r_oip;
8518 struct sdebug_dev_info *devip;
8519 u8 *cmd = scp->cmnd;
8520 int (*r_pfp)(struct scsi_cmnd *, struct sdebug_dev_info *);
8521 int (*pfp)(struct scsi_cmnd *, struct sdebug_dev_info *) = NULL;
8524 u64 lun_index = sdp->lun & 0x3FFF;
8531 struct sdebug_err_inject err;
8533 scsi_set_resid(scp, 0);
8534 if (sdebug_statistics) {
8535 atomic_inc(&sdebug_cmnd_count);
8536 inject_now = inject_on_this_cmd();
8540 if (unlikely(sdebug_verbose &&
8541 !(SDEBUG_OPT_NO_CDB_NOISE & sdebug_opts))) {
8546 sb = (int)sizeof(b);
8548 strcpy(b, "too long, over 32 bytes");
8550 for (k = 0, n = 0; k < len && n < sb; ++k)
8551 n += scnprintf(b + n, sb - n, "%02x ",
8554 sdev_printk(KERN_INFO, sdp, "%s: tag=%#x, cmd %s\n", my_name,
8555 blk_mq_unique_tag(scsi_cmd_to_rq(scp)), b);
8557 if (unlikely(inject_now && (sdebug_opts & SDEBUG_OPT_HOST_BUSY)))
8558 return SCSI_MLQUEUE_HOST_BUSY;
8559 has_wlun_rl = (sdp->lun == SCSI_W_LUN_REPORT_LUNS);
8560 if (unlikely(lun_index >= sdebug_max_luns && !has_wlun_rl))
8563 sdeb_i = opcode_ind_arr[opcode]; /* fully mapped */
8564 oip = &opcode_info_arr[sdeb_i]; /* safe if table consistent */
8565 devip = (struct sdebug_dev_info *)sdp->hostdata;
8566 if (unlikely(!devip)) {
8567 devip = find_build_dev_info(sdp);
8572 if (sdebug_timeout_cmd(scp)) {
8573 scmd_printk(KERN_INFO, scp, "timeout command 0x%x\n", opcode);
8577 ret = sdebug_fail_queue_cmd(scp);
8579 scmd_printk(KERN_INFO, scp, "fail queue command 0x%x with 0x%x\n",
8584 if (sdebug_fail_cmd(scp, &ret, &err)) {
8585 scmd_printk(KERN_INFO, scp,
8586 "fail command 0x%x with hostbyte=0x%x, "
8587 "driverbyte=0x%x, statusbyte=0x%x, "
8588 "sense_key=0x%x, asc=0x%x, asq=0x%x\n",
8589 opcode, err.host_byte, err.driver_byte,
8590 err.status_byte, err.sense_key, err.asc, err.asq);
8594 if (unlikely(inject_now && !atomic_read(&sdeb_inject_pending)))
8595 atomic_set(&sdeb_inject_pending, 1);
8597 na = oip->num_attached;
8599 if (na) { /* multiple commands with this opcode */
8601 if (FF_SA & r_oip->flags) {
8602 if (F_SA_LOW & oip->flags)
8605 sa = get_unaligned_be16(cmd + 8);
8606 for (k = 0; k <= na; oip = r_oip->arrp + k++) {
8607 if (opcode == oip->opcode && sa == oip->sa)
8610 } else { /* since no service action only check opcode */
8611 for (k = 0; k <= na; oip = r_oip->arrp + k++) {
8612 if (opcode == oip->opcode)
8617 if (F_SA_LOW & r_oip->flags)
8618 mk_sense_invalid_fld(scp, SDEB_IN_CDB, 1, 4);
8619 else if (F_SA_HIGH & r_oip->flags)
8620 mk_sense_invalid_fld(scp, SDEB_IN_CDB, 8, 7);
8622 mk_sense_invalid_opcode(scp);
8625 } /* else (when na==0) we assume the oip is a match */
8627 if (unlikely(F_INV_OP & flags)) {
8628 mk_sense_invalid_opcode(scp);
8631 if (unlikely(has_wlun_rl && !(F_RL_WLUN_OK & flags))) {
8633 sdev_printk(KERN_INFO, sdp, "%s: Opcode 0x%x not%s\n",
8634 my_name, opcode, " supported for wlun");
8635 mk_sense_invalid_opcode(scp);
8638 if (unlikely(sdebug_strict)) { /* check cdb against mask */
8642 for (k = 1; k < oip->len_mask[0] && k < 16; ++k) {
8643 rem = ~oip->len_mask[k] & cmd[k];
8645 for (j = 7; j >= 0; --j, rem <<= 1) {
8649 mk_sense_invalid_fld(scp, SDEB_IN_CDB, k, j);
8654 if (unlikely(!(F_SKIP_UA & flags) &&
8655 find_first_bit(devip->uas_bm,
8656 SDEBUG_NUM_UAS) != SDEBUG_NUM_UAS)) {
8657 errsts = make_ua(scp, devip);
8661 if (unlikely(((F_M_ACCESS & flags) || scp->cmnd[0] == TEST_UNIT_READY) &&
8662 atomic_read(&devip->stopped))) {
8663 errsts = resp_not_ready(scp, devip);
8667 if (sdebug_fake_rw && (F_FAKE_RW & flags))
8669 if (unlikely(sdebug_every_nth)) {
8670 if (fake_timeout(scp))
8671 return 0; /* ignore command: make trouble */
8673 if (likely(oip->pfp))
8674 pfp = oip->pfp; /* calls a resp_* function */
8676 pfp = r_pfp; /* if leaf function ptr NULL, try the root's */
8679 if (F_DELAY_OVERR & flags) /* cmds like INQUIRY respond asap */
8680 return schedule_resp(scp, devip, errsts, pfp, 0, 0);
8681 else if ((flags & F_LONG_DELAY) && (sdebug_jdelay > 0 ||
8682 sdebug_ndelay > 10000)) {
8684 * Skip long delays if ndelay <= 10 microseconds. Otherwise
8685 * for Start Stop Unit (SSU) want at least 1 second delay and
8686 * if sdebug_jdelay>1 want a long delay of that many seconds.
8687 * For Synchronize Cache want 1/20 of SSU's delay.
8689 int jdelay = (sdebug_jdelay < 2) ? 1 : sdebug_jdelay;
8690 int denom = (flags & F_SYNC_DELAY) ? 20 : 1;
8692 jdelay = mult_frac(USER_HZ * jdelay, HZ, denom * USER_HZ);
8693 return schedule_resp(scp, devip, errsts, pfp, jdelay, 0);
8695 return schedule_resp(scp, devip, errsts, pfp, sdebug_jdelay,
8698 return schedule_resp(scp, devip, check_condition_result, NULL, 0, 0);
8700 return schedule_resp(scp, NULL, DID_NO_CONNECT << 16, NULL, 0, 0);
8703 static int sdebug_init_cmd_priv(struct Scsi_Host *shost, struct scsi_cmnd *cmd)
8705 struct sdebug_scsi_cmd *sdsc = scsi_cmd_priv(cmd);
8707 spin_lock_init(&sdsc->lock);
8712 static struct scsi_host_template sdebug_driver_template = {
8713 .show_info = scsi_debug_show_info,
8714 .write_info = scsi_debug_write_info,
8715 .proc_name = sdebug_proc_name,
8716 .name = "SCSI DEBUG",
8717 .info = scsi_debug_info,
8718 .slave_alloc = scsi_debug_slave_alloc,
8719 .slave_configure = scsi_debug_slave_configure,
8720 .slave_destroy = scsi_debug_slave_destroy,
8721 .ioctl = scsi_debug_ioctl,
8722 .queuecommand = scsi_debug_queuecommand,
8723 .change_queue_depth = sdebug_change_qdepth,
8724 .map_queues = sdebug_map_queues,
8725 .mq_poll = sdebug_blk_mq_poll,
8726 .eh_abort_handler = scsi_debug_abort,
8727 .eh_device_reset_handler = scsi_debug_device_reset,
8728 .eh_target_reset_handler = scsi_debug_target_reset,
8729 .eh_bus_reset_handler = scsi_debug_bus_reset,
8730 .eh_host_reset_handler = scsi_debug_host_reset,
8731 .can_queue = SDEBUG_CANQUEUE,
8733 .sg_tablesize = SG_MAX_SEGMENTS,
8734 .cmd_per_lun = DEF_CMD_PER_LUN,
8736 .max_segment_size = -1U,
8737 .module = THIS_MODULE,
8738 .track_queue_depth = 1,
8739 .cmd_size = sizeof(struct sdebug_scsi_cmd),
8740 .init_cmd_priv = sdebug_init_cmd_priv,
8741 .target_alloc = sdebug_target_alloc,
8742 .target_destroy = sdebug_target_destroy,
8745 static int sdebug_driver_probe(struct device *dev)
8748 struct sdebug_host_info *sdbg_host;
8749 struct Scsi_Host *hpnt;
8752 sdbg_host = dev_to_sdebug_host(dev);
8754 sdebug_driver_template.can_queue = sdebug_max_queue;
8755 sdebug_driver_template.cmd_per_lun = sdebug_max_queue;
8756 if (!sdebug_clustering)
8757 sdebug_driver_template.dma_boundary = PAGE_SIZE - 1;
8759 hpnt = scsi_host_alloc(&sdebug_driver_template, 0);
8761 pr_err("scsi_host_alloc failed\n");
8765 if (submit_queues > nr_cpu_ids) {
8766 pr_warn("%s: trim submit_queues (was %d) to nr_cpu_ids=%u\n",
8767 my_name, submit_queues, nr_cpu_ids);
8768 submit_queues = nr_cpu_ids;
8771 * Decide whether to tell scsi subsystem that we want mq. The
8772 * following should give the same answer for each host.
8774 hpnt->nr_hw_queues = submit_queues;
8775 if (sdebug_host_max_queue)
8776 hpnt->host_tagset = 1;
8778 /* poll queues are possible for nr_hw_queues > 1 */
8779 if (hpnt->nr_hw_queues == 1 || (poll_queues < 1)) {
8780 pr_warn("%s: trim poll_queues to 0. poll_q/nr_hw = (%d/%d)\n",
8781 my_name, poll_queues, hpnt->nr_hw_queues);
8786 * Poll queues don't need interrupts, but we need at least one I/O queue
8787 * left over for non-polled I/O.
8788 * If condition not met, trim poll_queues to 1 (just for simplicity).
8790 if (poll_queues >= submit_queues) {
8791 if (submit_queues < 3)
8792 pr_warn("%s: trim poll_queues to 1\n", my_name);
8794 pr_warn("%s: trim poll_queues to 1. Perhaps try poll_queues=%d\n",
8795 my_name, submit_queues - 1);
8801 sdbg_host->shost = hpnt;
8802 if ((hpnt->this_id >= 0) && (sdebug_num_tgts > hpnt->this_id))
8803 hpnt->max_id = sdebug_num_tgts + 1;
8805 hpnt->max_id = sdebug_num_tgts;
8806 /* = sdebug_max_luns; */
8807 hpnt->max_lun = SCSI_W_LUN_REPORT_LUNS + 1;
8811 switch (sdebug_dif) {
8813 case T10_PI_TYPE1_PROTECTION:
8814 hprot = SHOST_DIF_TYPE1_PROTECTION;
8816 hprot |= SHOST_DIX_TYPE1_PROTECTION;
8819 case T10_PI_TYPE2_PROTECTION:
8820 hprot = SHOST_DIF_TYPE2_PROTECTION;
8822 hprot |= SHOST_DIX_TYPE2_PROTECTION;
8825 case T10_PI_TYPE3_PROTECTION:
8826 hprot = SHOST_DIF_TYPE3_PROTECTION;
8828 hprot |= SHOST_DIX_TYPE3_PROTECTION;
8833 hprot |= SHOST_DIX_TYPE0_PROTECTION;
8837 scsi_host_set_prot(hpnt, hprot);
8839 if (have_dif_prot || sdebug_dix)
8840 pr_info("host protection%s%s%s%s%s%s%s\n",
8841 (hprot & SHOST_DIF_TYPE1_PROTECTION) ? " DIF1" : "",
8842 (hprot & SHOST_DIF_TYPE2_PROTECTION) ? " DIF2" : "",
8843 (hprot & SHOST_DIF_TYPE3_PROTECTION) ? " DIF3" : "",
8844 (hprot & SHOST_DIX_TYPE0_PROTECTION) ? " DIX0" : "",
8845 (hprot & SHOST_DIX_TYPE1_PROTECTION) ? " DIX1" : "",
8846 (hprot & SHOST_DIX_TYPE2_PROTECTION) ? " DIX2" : "",
8847 (hprot & SHOST_DIX_TYPE3_PROTECTION) ? " DIX3" : "");
8849 if (sdebug_guard == 1)
8850 scsi_host_set_guard(hpnt, SHOST_DIX_GUARD_IP);
8852 scsi_host_set_guard(hpnt, SHOST_DIX_GUARD_CRC);
8854 sdebug_verbose = !!(SDEBUG_OPT_NOISE & sdebug_opts);
8855 sdebug_any_injecting_opt = !!(SDEBUG_OPT_ALL_INJECTING & sdebug_opts);
8856 if (sdebug_every_nth) /* need stats counters for every_nth */
8857 sdebug_statistics = true;
8858 error = scsi_add_host(hpnt, &sdbg_host->dev);
8860 pr_err("scsi_add_host failed\n");
8862 scsi_host_put(hpnt);
8864 scsi_scan_host(hpnt);
8870 static void sdebug_driver_remove(struct device *dev)
8872 struct sdebug_host_info *sdbg_host;
8873 struct sdebug_dev_info *sdbg_devinfo, *tmp;
8875 sdbg_host = dev_to_sdebug_host(dev);
8877 scsi_remove_host(sdbg_host->shost);
8879 list_for_each_entry_safe(sdbg_devinfo, tmp, &sdbg_host->dev_info_list,
8881 list_del(&sdbg_devinfo->dev_list);
8882 kfree(sdbg_devinfo->zstate);
8883 kfree(sdbg_devinfo);
8886 scsi_host_put(sdbg_host->shost);
8889 static const struct bus_type pseudo_lld_bus = {
8891 .probe = sdebug_driver_probe,
8892 .remove = sdebug_driver_remove,
8893 .drv_groups = sdebug_drv_groups,