• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * SCSI Primary Commands (SPC) parsing and emulation.
3  *
4  * (c) Copyright 2002-2013 Datera, Inc.
5  *
6  * Nicholas A. Bellinger <nab@kernel.org>
7  *
8  * This program is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation; either version 2 of the License, or
11  * (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software
20  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
21  */
22 
23 #include <linux/kernel.h>
24 #include <linux/module.h>
25 #include <asm/unaligned.h>
26 
27 #include <scsi/scsi.h>
28 #include <scsi/scsi_tcq.h>
29 
30 #include <target/target_core_base.h>
31 #include <target/target_core_backend.h>
32 #include <target/target_core_fabric.h>
33 
34 #include "target_core_internal.h"
35 #include "target_core_alua.h"
36 #include "target_core_pr.h"
37 #include "target_core_ua.h"
38 #include "target_core_xcopy.h"
39 
spc_fill_alua_data(struct se_port * port,unsigned char * buf)40 static void spc_fill_alua_data(struct se_port *port, unsigned char *buf)
41 {
42 	struct t10_alua_tg_pt_gp *tg_pt_gp;
43 	struct t10_alua_tg_pt_gp_member *tg_pt_gp_mem;
44 
45 	/*
46 	 * Set SCCS for MAINTENANCE_IN + REPORT_TARGET_PORT_GROUPS.
47 	 */
48 	buf[5]	= 0x80;
49 
50 	/*
51 	 * Set TPGS field for explicit and/or implicit ALUA access type
52 	 * and opteration.
53 	 *
54 	 * See spc4r17 section 6.4.2 Table 135
55 	 */
56 	if (!port)
57 		return;
58 	tg_pt_gp_mem = port->sep_alua_tg_pt_gp_mem;
59 	if (!tg_pt_gp_mem)
60 		return;
61 
62 	spin_lock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
63 	tg_pt_gp = tg_pt_gp_mem->tg_pt_gp;
64 	if (tg_pt_gp)
65 		buf[5] |= tg_pt_gp->tg_pt_gp_alua_access_type;
66 	spin_unlock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
67 }
68 
69 sense_reason_t
spc_emulate_inquiry_std(struct se_cmd * cmd,unsigned char * buf)70 spc_emulate_inquiry_std(struct se_cmd *cmd, unsigned char *buf)
71 {
72 	struct se_lun *lun = cmd->se_lun;
73 	struct se_device *dev = cmd->se_dev;
74 	struct se_session *sess = cmd->se_sess;
75 
76 	/* Set RMB (removable media) for tape devices */
77 	if (dev->transport->get_device_type(dev) == TYPE_TAPE)
78 		buf[1] = 0x80;
79 
80 	buf[2] = 0x05; /* SPC-3 */
81 
82 	/*
83 	 * NORMACA and HISUP = 0, RESPONSE DATA FORMAT = 2
84 	 *
85 	 * SPC4 says:
86 	 *   A RESPONSE DATA FORMAT field set to 2h indicates that the
87 	 *   standard INQUIRY data is in the format defined in this
88 	 *   standard. Response data format values less than 2h are
89 	 *   obsolete. Response data format values greater than 2h are
90 	 *   reserved.
91 	 */
92 	buf[3] = 2;
93 
94 	/*
95 	 * Enable SCCS and TPGS fields for Emulated ALUA
96 	 */
97 	spc_fill_alua_data(lun->lun_sep, buf);
98 
99 	/*
100 	 * Set Third-Party Copy (3PC) bit to indicate support for EXTENDED_COPY
101 	 */
102 	if (dev->dev_attrib.emulate_3pc)
103 		buf[5] |= 0x8;
104 	/*
105 	 * Set Protection (PROTECT) bit when DIF has been enabled on the
106 	 * device, and the transport supports VERIFY + PASS.
107 	 */
108 	if (sess->sup_prot_ops & (TARGET_PROT_DIN_PASS | TARGET_PROT_DOUT_PASS)) {
109 		if (dev->dev_attrib.pi_prot_type)
110 			buf[5] |= 0x1;
111 	}
112 
113 	buf[7] = 0x2; /* CmdQue=1 */
114 
115 	memcpy(&buf[8], "LIO-ORG ", 8);
116 	memset(&buf[16], 0x20, 16);
117 	memcpy(&buf[16], dev->t10_wwn.model,
118 	       min_t(size_t, strlen(dev->t10_wwn.model), 16));
119 	memcpy(&buf[32], dev->t10_wwn.revision,
120 	       min_t(size_t, strlen(dev->t10_wwn.revision), 4));
121 	buf[4] = 31; /* Set additional length to 31 */
122 
123 	return 0;
124 }
125 EXPORT_SYMBOL(spc_emulate_inquiry_std);
126 
127 /* unit serial number */
128 static sense_reason_t
spc_emulate_evpd_80(struct se_cmd * cmd,unsigned char * buf)129 spc_emulate_evpd_80(struct se_cmd *cmd, unsigned char *buf)
130 {
131 	struct se_device *dev = cmd->se_dev;
132 	u16 len;
133 
134 	if (dev->dev_flags & DF_EMULATED_VPD_UNIT_SERIAL) {
135 		len = sprintf(&buf[4], "%s", dev->t10_wwn.unit_serial);
136 		len++; /* Extra Byte for NULL Terminator */
137 		buf[3] = len;
138 	}
139 	return 0;
140 }
141 
spc_parse_naa_6h_vendor_specific(struct se_device * dev,unsigned char * buf)142 void spc_parse_naa_6h_vendor_specific(struct se_device *dev,
143 				      unsigned char *buf)
144 {
145 	unsigned char *p = &dev->t10_wwn.unit_serial[0];
146 	int cnt;
147 	bool next = true;
148 
149 	/*
150 	 * Generate up to 36 bits of VENDOR SPECIFIC IDENTIFIER starting on
151 	 * byte 3 bit 3-0 for NAA IEEE Registered Extended DESIGNATOR field
152 	 * format, followed by 64 bits of VENDOR SPECIFIC IDENTIFIER EXTENSION
153 	 * to complete the payload.  These are based from VPD=0x80 PRODUCT SERIAL
154 	 * NUMBER set via vpd_unit_serial in target_core_configfs.c to ensure
155 	 * per device uniqeness.
156 	 */
157 	for (cnt = 0; *p && cnt < 13; p++) {
158 		int val = hex_to_bin(*p);
159 
160 		if (val < 0)
161 			continue;
162 
163 		if (next) {
164 			next = false;
165 			buf[cnt++] |= val;
166 		} else {
167 			next = true;
168 			buf[cnt] = val << 4;
169 		}
170 	}
171 }
172 
173 /*
174  * Device identification VPD, for a complete list of
175  * DESIGNATOR TYPEs see spc4r17 Table 459.
176  */
177 sense_reason_t
spc_emulate_evpd_83(struct se_cmd * cmd,unsigned char * buf)178 spc_emulate_evpd_83(struct se_cmd *cmd, unsigned char *buf)
179 {
180 	struct se_device *dev = cmd->se_dev;
181 	struct se_lun *lun = cmd->se_lun;
182 	struct se_port *port = NULL;
183 	struct se_portal_group *tpg = NULL;
184 	struct t10_alua_lu_gp_member *lu_gp_mem;
185 	struct t10_alua_tg_pt_gp *tg_pt_gp;
186 	struct t10_alua_tg_pt_gp_member *tg_pt_gp_mem;
187 	unsigned char *prod = &dev->t10_wwn.model[0];
188 	u32 prod_len;
189 	u32 unit_serial_len, off = 0;
190 	u16 len = 0, id_len;
191 
192 	off = 4;
193 
194 	/*
195 	 * NAA IEEE Registered Extended Assigned designator format, see
196 	 * spc4r17 section 7.7.3.6.5
197 	 *
198 	 * We depend upon a target_core_mod/ConfigFS provided
199 	 * /sys/kernel/config/target/core/$HBA/$DEV/wwn/vpd_unit_serial
200 	 * value in order to return the NAA id.
201 	 */
202 	if (!(dev->dev_flags & DF_EMULATED_VPD_UNIT_SERIAL))
203 		goto check_t10_vend_desc;
204 
205 	/* CODE SET == Binary */
206 	buf[off++] = 0x1;
207 
208 	/* Set ASSOCIATION == addressed logical unit: 0)b */
209 	buf[off] = 0x00;
210 
211 	/* Identifier/Designator type == NAA identifier */
212 	buf[off++] |= 0x3;
213 	off++;
214 
215 	/* Identifier/Designator length */
216 	buf[off++] = 0x10;
217 
218 	/*
219 	 * Start NAA IEEE Registered Extended Identifier/Designator
220 	 */
221 	buf[off++] = (0x6 << 4);
222 
223 	/*
224 	 * Use OpenFabrics IEEE Company ID: 00 14 05
225 	 */
226 	buf[off++] = 0x01;
227 	buf[off++] = 0x40;
228 	buf[off] = (0x5 << 4);
229 
230 	/*
231 	 * Return ConfigFS Unit Serial Number information for
232 	 * VENDOR_SPECIFIC_IDENTIFIER and
233 	 * VENDOR_SPECIFIC_IDENTIFIER_EXTENTION
234 	 */
235 	spc_parse_naa_6h_vendor_specific(dev, &buf[off]);
236 
237 	len = 20;
238 	off = (len + 4);
239 
240 check_t10_vend_desc:
241 	/*
242 	 * T10 Vendor Identifier Page, see spc4r17 section 7.7.3.4
243 	 */
244 	id_len = 8; /* For Vendor field */
245 	prod_len = 4; /* For VPD Header */
246 	prod_len += 8; /* For Vendor field */
247 	prod_len += strlen(prod);
248 	prod_len++; /* For : */
249 
250 	if (dev->dev_flags & DF_EMULATED_VPD_UNIT_SERIAL) {
251 		unit_serial_len = strlen(&dev->t10_wwn.unit_serial[0]);
252 		unit_serial_len++; /* For NULL Terminator */
253 
254 		id_len += sprintf(&buf[off+12], "%s:%s", prod,
255 				&dev->t10_wwn.unit_serial[0]);
256 	}
257 	buf[off] = 0x2; /* ASCII */
258 	buf[off+1] = 0x1; /* T10 Vendor ID */
259 	buf[off+2] = 0x0;
260 	memcpy(&buf[off+4], "LIO-ORG", 8);
261 	/* Extra Byte for NULL Terminator */
262 	id_len++;
263 	/* Identifier Length */
264 	buf[off+3] = id_len;
265 	/* Header size for Designation descriptor */
266 	len += (id_len + 4);
267 	off += (id_len + 4);
268 	/*
269 	 * struct se_port is only set for INQUIRY VPD=1 through $FABRIC_MOD
270 	 */
271 	port = lun->lun_sep;
272 	if (port) {
273 		struct t10_alua_lu_gp *lu_gp;
274 		u32 padding, scsi_name_len, scsi_target_len;
275 		u16 lu_gp_id = 0;
276 		u16 tg_pt_gp_id = 0;
277 		u16 tpgt;
278 
279 		tpg = port->sep_tpg;
280 		/*
281 		 * Relative target port identifer, see spc4r17
282 		 * section 7.7.3.7
283 		 *
284 		 * Get the PROTOCOL IDENTIFIER as defined by spc4r17
285 		 * section 7.5.1 Table 362
286 		 */
287 		buf[off] =
288 			(tpg->se_tpg_tfo->get_fabric_proto_ident(tpg) << 4);
289 		buf[off++] |= 0x1; /* CODE SET == Binary */
290 		buf[off] = 0x80; /* Set PIV=1 */
291 		/* Set ASSOCIATION == target port: 01b */
292 		buf[off] |= 0x10;
293 		/* DESIGNATOR TYPE == Relative target port identifer */
294 		buf[off++] |= 0x4;
295 		off++; /* Skip over Reserved */
296 		buf[off++] = 4; /* DESIGNATOR LENGTH */
297 		/* Skip over Obsolete field in RTPI payload
298 		 * in Table 472 */
299 		off += 2;
300 		buf[off++] = ((port->sep_rtpi >> 8) & 0xff);
301 		buf[off++] = (port->sep_rtpi & 0xff);
302 		len += 8; /* Header size + Designation descriptor */
303 		/*
304 		 * Target port group identifier, see spc4r17
305 		 * section 7.7.3.8
306 		 *
307 		 * Get the PROTOCOL IDENTIFIER as defined by spc4r17
308 		 * section 7.5.1 Table 362
309 		 */
310 		tg_pt_gp_mem = port->sep_alua_tg_pt_gp_mem;
311 		if (!tg_pt_gp_mem)
312 			goto check_lu_gp;
313 
314 		spin_lock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
315 		tg_pt_gp = tg_pt_gp_mem->tg_pt_gp;
316 		if (!tg_pt_gp) {
317 			spin_unlock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
318 			goto check_lu_gp;
319 		}
320 		tg_pt_gp_id = tg_pt_gp->tg_pt_gp_id;
321 		spin_unlock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
322 
323 		buf[off] =
324 			(tpg->se_tpg_tfo->get_fabric_proto_ident(tpg) << 4);
325 		buf[off++] |= 0x1; /* CODE SET == Binary */
326 		buf[off] = 0x80; /* Set PIV=1 */
327 		/* Set ASSOCIATION == target port: 01b */
328 		buf[off] |= 0x10;
329 		/* DESIGNATOR TYPE == Target port group identifier */
330 		buf[off++] |= 0x5;
331 		off++; /* Skip over Reserved */
332 		buf[off++] = 4; /* DESIGNATOR LENGTH */
333 		off += 2; /* Skip over Reserved Field */
334 		buf[off++] = ((tg_pt_gp_id >> 8) & 0xff);
335 		buf[off++] = (tg_pt_gp_id & 0xff);
336 		len += 8; /* Header size + Designation descriptor */
337 		/*
338 		 * Logical Unit Group identifier, see spc4r17
339 		 * section 7.7.3.8
340 		 */
341 check_lu_gp:
342 		lu_gp_mem = dev->dev_alua_lu_gp_mem;
343 		if (!lu_gp_mem)
344 			goto check_scsi_name;
345 
346 		spin_lock(&lu_gp_mem->lu_gp_mem_lock);
347 		lu_gp = lu_gp_mem->lu_gp;
348 		if (!lu_gp) {
349 			spin_unlock(&lu_gp_mem->lu_gp_mem_lock);
350 			goto check_scsi_name;
351 		}
352 		lu_gp_id = lu_gp->lu_gp_id;
353 		spin_unlock(&lu_gp_mem->lu_gp_mem_lock);
354 
355 		buf[off++] |= 0x1; /* CODE SET == Binary */
356 		/* DESIGNATOR TYPE == Logical Unit Group identifier */
357 		buf[off++] |= 0x6;
358 		off++; /* Skip over Reserved */
359 		buf[off++] = 4; /* DESIGNATOR LENGTH */
360 		off += 2; /* Skip over Reserved Field */
361 		buf[off++] = ((lu_gp_id >> 8) & 0xff);
362 		buf[off++] = (lu_gp_id & 0xff);
363 		len += 8; /* Header size + Designation descriptor */
364 		/*
365 		 * SCSI name string designator, see spc4r17
366 		 * section 7.7.3.11
367 		 *
368 		 * Get the PROTOCOL IDENTIFIER as defined by spc4r17
369 		 * section 7.5.1 Table 362
370 		 */
371 check_scsi_name:
372 		buf[off] =
373 			(tpg->se_tpg_tfo->get_fabric_proto_ident(tpg) << 4);
374 		buf[off++] |= 0x3; /* CODE SET == UTF-8 */
375 		buf[off] = 0x80; /* Set PIV=1 */
376 		/* Set ASSOCIATION == target port: 01b */
377 		buf[off] |= 0x10;
378 		/* DESIGNATOR TYPE == SCSI name string */
379 		buf[off++] |= 0x8;
380 		off += 2; /* Skip over Reserved and length */
381 		/*
382 		 * SCSI name string identifer containing, $FABRIC_MOD
383 		 * dependent information.  For LIO-Target and iSCSI
384 		 * Target Port, this means "<iSCSI name>,t,0x<TPGT> in
385 		 * UTF-8 encoding.
386 		 */
387 		tpgt = tpg->se_tpg_tfo->tpg_get_tag(tpg);
388 		scsi_name_len = sprintf(&buf[off], "%s,t,0x%04x",
389 					tpg->se_tpg_tfo->tpg_get_wwn(tpg), tpgt);
390 		scsi_name_len += 1 /* Include  NULL terminator */;
391 		/*
392 		 * The null-terminated, null-padded (see 4.4.2) SCSI
393 		 * NAME STRING field contains a UTF-8 format string.
394 		 * The number of bytes in the SCSI NAME STRING field
395 		 * (i.e., the value in the DESIGNATOR LENGTH field)
396 		 * shall be no larger than 256 and shall be a multiple
397 		 * of four.
398 		 */
399 		padding = ((-scsi_name_len) & 3);
400 		if (padding)
401 			scsi_name_len += padding;
402 		if (scsi_name_len > 256)
403 			scsi_name_len = 256;
404 
405 		buf[off-1] = scsi_name_len;
406 		off += scsi_name_len;
407 		/* Header size + Designation descriptor */
408 		len += (scsi_name_len + 4);
409 
410 		/*
411 		 * Target device designator
412 		 */
413 		buf[off] =
414 			(tpg->se_tpg_tfo->get_fabric_proto_ident(tpg) << 4);
415 		buf[off++] |= 0x3; /* CODE SET == UTF-8 */
416 		buf[off] = 0x80; /* Set PIV=1 */
417 		/* Set ASSOCIATION == target device: 10b */
418 		buf[off] |= 0x20;
419 		/* DESIGNATOR TYPE == SCSI name string */
420 		buf[off++] |= 0x8;
421 		off += 2; /* Skip over Reserved and length */
422 		/*
423 		 * SCSI name string identifer containing, $FABRIC_MOD
424 		 * dependent information.  For LIO-Target and iSCSI
425 		 * Target Port, this means "<iSCSI name>" in
426 		 * UTF-8 encoding.
427 		 */
428 		scsi_target_len = sprintf(&buf[off], "%s",
429 					  tpg->se_tpg_tfo->tpg_get_wwn(tpg));
430 		scsi_target_len += 1 /* Include  NULL terminator */;
431 		/*
432 		 * The null-terminated, null-padded (see 4.4.2) SCSI
433 		 * NAME STRING field contains a UTF-8 format string.
434 		 * The number of bytes in the SCSI NAME STRING field
435 		 * (i.e., the value in the DESIGNATOR LENGTH field)
436 		 * shall be no larger than 256 and shall be a multiple
437 		 * of four.
438 		 */
439 		padding = ((-scsi_target_len) & 3);
440 		if (padding)
441 			scsi_target_len += padding;
442 		if (scsi_target_len > 256)
443 			scsi_target_len = 256;
444 
445 		buf[off-1] = scsi_target_len;
446 		off += scsi_target_len;
447 
448 		/* Header size + Designation descriptor */
449 		len += (scsi_target_len + 4);
450 	}
451 	buf[2] = ((len >> 8) & 0xff);
452 	buf[3] = (len & 0xff); /* Page Length for VPD 0x83 */
453 	return 0;
454 }
455 EXPORT_SYMBOL(spc_emulate_evpd_83);
456 
457 static bool
spc_check_dev_wce(struct se_device * dev)458 spc_check_dev_wce(struct se_device *dev)
459 {
460 	bool wce = false;
461 
462 	if (dev->transport->get_write_cache)
463 		wce = dev->transport->get_write_cache(dev);
464 	else if (dev->dev_attrib.emulate_write_cache > 0)
465 		wce = true;
466 
467 	return wce;
468 }
469 
470 /* Extended INQUIRY Data VPD Page */
471 static sense_reason_t
spc_emulate_evpd_86(struct se_cmd * cmd,unsigned char * buf)472 spc_emulate_evpd_86(struct se_cmd *cmd, unsigned char *buf)
473 {
474 	struct se_device *dev = cmd->se_dev;
475 	struct se_session *sess = cmd->se_sess;
476 
477 	buf[3] = 0x3c;
478 	/*
479 	 * Set GRD_CHK + REF_CHK for TYPE1 protection, or GRD_CHK
480 	 * only for TYPE3 protection.
481 	 */
482 	if (sess->sup_prot_ops & (TARGET_PROT_DIN_PASS | TARGET_PROT_DOUT_PASS)) {
483 		if (dev->dev_attrib.pi_prot_type == TARGET_DIF_TYPE1_PROT)
484 			buf[4] = 0x5;
485 		else if (dev->dev_attrib.pi_prot_type == TARGET_DIF_TYPE3_PROT)
486 			buf[4] = 0x4;
487 	}
488 
489 	/* Set HEADSUP, ORDSUP, SIMPSUP */
490 	buf[5] = 0x07;
491 
492 	/* If WriteCache emulation is enabled, set V_SUP */
493 	if (spc_check_dev_wce(dev))
494 		buf[6] = 0x01;
495 	/* If an LBA map is present set R_SUP */
496 	spin_lock(&cmd->se_dev->t10_alua.lba_map_lock);
497 	if (!list_empty(&dev->t10_alua.lba_map_list))
498 		buf[8] = 0x10;
499 	spin_unlock(&cmd->se_dev->t10_alua.lba_map_lock);
500 	return 0;
501 }
502 
503 /* Block Limits VPD page */
504 static sense_reason_t
spc_emulate_evpd_b0(struct se_cmd * cmd,unsigned char * buf)505 spc_emulate_evpd_b0(struct se_cmd *cmd, unsigned char *buf)
506 {
507 	struct se_device *dev = cmd->se_dev;
508 	int have_tp = 0;
509 	int opt, min;
510 
511 	/*
512 	 * Following spc3r22 section 6.5.3 Block Limits VPD page, when
513 	 * emulate_tpu=1 or emulate_tpws=1 we will be expect a
514 	 * different page length for Thin Provisioning.
515 	 */
516 	if (dev->dev_attrib.emulate_tpu || dev->dev_attrib.emulate_tpws)
517 		have_tp = 1;
518 
519 	buf[0] = dev->transport->get_device_type(dev);
520 	buf[3] = have_tp ? 0x3c : 0x10;
521 
522 	/* Set WSNZ to 1 */
523 	buf[4] = 0x01;
524 	/*
525 	 * Set MAXIMUM COMPARE AND WRITE LENGTH
526 	 */
527 	if (dev->dev_attrib.emulate_caw)
528 		buf[5] = 0x01;
529 
530 	/*
531 	 * Set OPTIMAL TRANSFER LENGTH GRANULARITY
532 	 */
533 	if (dev->transport->get_io_min && (min = dev->transport->get_io_min(dev)))
534 		put_unaligned_be16(min / dev->dev_attrib.block_size, &buf[6]);
535 	else
536 		put_unaligned_be16(1, &buf[6]);
537 
538 	/*
539 	 * Set MAXIMUM TRANSFER LENGTH
540 	 */
541 	put_unaligned_be32(dev->dev_attrib.hw_max_sectors, &buf[8]);
542 
543 	/*
544 	 * Set OPTIMAL TRANSFER LENGTH
545 	 */
546 	if (dev->transport->get_io_opt && (opt = dev->transport->get_io_opt(dev)))
547 		put_unaligned_be32(opt / dev->dev_attrib.block_size, &buf[12]);
548 	else
549 		put_unaligned_be32(dev->dev_attrib.optimal_sectors, &buf[12]);
550 
551 	/*
552 	 * Exit now if we don't support TP.
553 	 */
554 	if (!have_tp)
555 		goto max_write_same;
556 
557 	/*
558 	 * Set MAXIMUM UNMAP LBA COUNT
559 	 */
560 	put_unaligned_be32(dev->dev_attrib.max_unmap_lba_count, &buf[20]);
561 
562 	/*
563 	 * Set MAXIMUM UNMAP BLOCK DESCRIPTOR COUNT
564 	 */
565 	put_unaligned_be32(dev->dev_attrib.max_unmap_block_desc_count,
566 			   &buf[24]);
567 
568 	/*
569 	 * Set OPTIMAL UNMAP GRANULARITY
570 	 */
571 	put_unaligned_be32(dev->dev_attrib.unmap_granularity, &buf[28]);
572 
573 	/*
574 	 * UNMAP GRANULARITY ALIGNMENT
575 	 */
576 	put_unaligned_be32(dev->dev_attrib.unmap_granularity_alignment,
577 			   &buf[32]);
578 	if (dev->dev_attrib.unmap_granularity_alignment != 0)
579 		buf[32] |= 0x80; /* Set the UGAVALID bit */
580 
581 	/*
582 	 * MAXIMUM WRITE SAME LENGTH
583 	 */
584 max_write_same:
585 	put_unaligned_be64(dev->dev_attrib.max_write_same_len, &buf[36]);
586 
587 	return 0;
588 }
589 
590 /* Block Device Characteristics VPD page */
591 static sense_reason_t
spc_emulate_evpd_b1(struct se_cmd * cmd,unsigned char * buf)592 spc_emulate_evpd_b1(struct se_cmd *cmd, unsigned char *buf)
593 {
594 	struct se_device *dev = cmd->se_dev;
595 
596 	buf[0] = dev->transport->get_device_type(dev);
597 	buf[3] = 0x3c;
598 	buf[5] = dev->dev_attrib.is_nonrot ? 1 : 0;
599 
600 	return 0;
601 }
602 
603 /* Thin Provisioning VPD */
604 static sense_reason_t
spc_emulate_evpd_b2(struct se_cmd * cmd,unsigned char * buf)605 spc_emulate_evpd_b2(struct se_cmd *cmd, unsigned char *buf)
606 {
607 	struct se_device *dev = cmd->se_dev;
608 
609 	/*
610 	 * From spc3r22 section 6.5.4 Thin Provisioning VPD page:
611 	 *
612 	 * The PAGE LENGTH field is defined in SPC-4. If the DP bit is set to
613 	 * zero, then the page length shall be set to 0004h.  If the DP bit
614 	 * is set to one, then the page length shall be set to the value
615 	 * defined in table 162.
616 	 */
617 	buf[0] = dev->transport->get_device_type(dev);
618 
619 	/*
620 	 * Set Hardcoded length mentioned above for DP=0
621 	 */
622 	put_unaligned_be16(0x0004, &buf[2]);
623 
624 	/*
625 	 * The THRESHOLD EXPONENT field indicates the threshold set size in
626 	 * LBAs as a power of 2 (i.e., the threshold set size is equal to
627 	 * 2(threshold exponent)).
628 	 *
629 	 * Note that this is currently set to 0x00 as mkp says it will be
630 	 * changing again.  We can enable this once it has settled in T10
631 	 * and is actually used by Linux/SCSI ML code.
632 	 */
633 	buf[4] = 0x00;
634 
635 	/*
636 	 * A TPU bit set to one indicates that the device server supports
637 	 * the UNMAP command (see 5.25). A TPU bit set to zero indicates
638 	 * that the device server does not support the UNMAP command.
639 	 */
640 	if (dev->dev_attrib.emulate_tpu != 0)
641 		buf[5] = 0x80;
642 
643 	/*
644 	 * A TPWS bit set to one indicates that the device server supports
645 	 * the use of the WRITE SAME (16) command (see 5.42) to unmap LBAs.
646 	 * A TPWS bit set to zero indicates that the device server does not
647 	 * support the use of the WRITE SAME (16) command to unmap LBAs.
648 	 */
649 	if (dev->dev_attrib.emulate_tpws != 0)
650 		buf[5] |= 0x40;
651 
652 	return 0;
653 }
654 
655 /* Referrals VPD page */
656 static sense_reason_t
spc_emulate_evpd_b3(struct se_cmd * cmd,unsigned char * buf)657 spc_emulate_evpd_b3(struct se_cmd *cmd, unsigned char *buf)
658 {
659 	struct se_device *dev = cmd->se_dev;
660 
661 	buf[0] = dev->transport->get_device_type(dev);
662 	buf[3] = 0x0c;
663 	put_unaligned_be32(dev->t10_alua.lba_map_segment_size, &buf[8]);
664 	put_unaligned_be32(dev->t10_alua.lba_map_segment_multiplier, &buf[12]);
665 
666 	return 0;
667 }
668 
669 static sense_reason_t
670 spc_emulate_evpd_00(struct se_cmd *cmd, unsigned char *buf);
671 
672 static struct {
673 	uint8_t		page;
674 	sense_reason_t	(*emulate)(struct se_cmd *, unsigned char *);
675 } evpd_handlers[] = {
676 	{ .page = 0x00, .emulate = spc_emulate_evpd_00 },
677 	{ .page = 0x80, .emulate = spc_emulate_evpd_80 },
678 	{ .page = 0x83, .emulate = spc_emulate_evpd_83 },
679 	{ .page = 0x86, .emulate = spc_emulate_evpd_86 },
680 	{ .page = 0xb0, .emulate = spc_emulate_evpd_b0 },
681 	{ .page = 0xb1, .emulate = spc_emulate_evpd_b1 },
682 	{ .page = 0xb2, .emulate = spc_emulate_evpd_b2 },
683 	{ .page = 0xb3, .emulate = spc_emulate_evpd_b3 },
684 };
685 
686 /* supported vital product data pages */
687 static sense_reason_t
spc_emulate_evpd_00(struct se_cmd * cmd,unsigned char * buf)688 spc_emulate_evpd_00(struct se_cmd *cmd, unsigned char *buf)
689 {
690 	int p;
691 
692 	/*
693 	 * Only report the INQUIRY EVPD=1 pages after a valid NAA
694 	 * Registered Extended LUN WWN has been set via ConfigFS
695 	 * during device creation/restart.
696 	 */
697 	if (cmd->se_dev->dev_flags & DF_EMULATED_VPD_UNIT_SERIAL) {
698 		buf[3] = ARRAY_SIZE(evpd_handlers);
699 		for (p = 0; p < ARRAY_SIZE(evpd_handlers); ++p)
700 			buf[p + 4] = evpd_handlers[p].page;
701 	}
702 
703 	return 0;
704 }
705 
706 static sense_reason_t
spc_emulate_inquiry(struct se_cmd * cmd)707 spc_emulate_inquiry(struct se_cmd *cmd)
708 {
709 	struct se_device *dev = cmd->se_dev;
710 	struct se_portal_group *tpg = cmd->se_lun->lun_sep->sep_tpg;
711 	unsigned char *rbuf;
712 	unsigned char *cdb = cmd->t_task_cdb;
713 	unsigned char *buf;
714 	sense_reason_t ret;
715 	int p;
716 	int len = 0;
717 
718 	buf = kzalloc(SE_INQUIRY_BUF, GFP_KERNEL);
719 	if (!buf) {
720 		pr_err("Unable to allocate response buffer for INQUIRY\n");
721 		return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
722 	}
723 
724 	if (dev == tpg->tpg_virt_lun0.lun_se_dev)
725 		buf[0] = 0x3f; /* Not connected */
726 	else
727 		buf[0] = dev->transport->get_device_type(dev);
728 
729 	if (!(cdb[1] & 0x1)) {
730 		if (cdb[2]) {
731 			pr_err("INQUIRY with EVPD==0 but PAGE CODE=%02x\n",
732 			       cdb[2]);
733 			ret = TCM_INVALID_CDB_FIELD;
734 			goto out;
735 		}
736 
737 		ret = spc_emulate_inquiry_std(cmd, buf);
738 		len = buf[4] + 5;
739 		goto out;
740 	}
741 
742 	for (p = 0; p < ARRAY_SIZE(evpd_handlers); ++p) {
743 		if (cdb[2] == evpd_handlers[p].page) {
744 			buf[1] = cdb[2];
745 			ret = evpd_handlers[p].emulate(cmd, buf);
746 			len = get_unaligned_be16(&buf[2]) + 4;
747 			goto out;
748 		}
749 	}
750 
751 	pr_err("Unknown VPD Code: 0x%02x\n", cdb[2]);
752 	ret = TCM_INVALID_CDB_FIELD;
753 
754 out:
755 	rbuf = transport_kmap_data_sg(cmd);
756 	if (rbuf) {
757 		memcpy(rbuf, buf, min_t(u32, SE_INQUIRY_BUF, cmd->data_length));
758 		transport_kunmap_data_sg(cmd);
759 	}
760 	kfree(buf);
761 
762 	if (!ret)
763 		target_complete_cmd_with_length(cmd, GOOD, len);
764 	return ret;
765 }
766 
spc_modesense_rwrecovery(struct se_cmd * cmd,u8 pc,u8 * p)767 static int spc_modesense_rwrecovery(struct se_cmd *cmd, u8 pc, u8 *p)
768 {
769 	p[0] = 0x01;
770 	p[1] = 0x0a;
771 
772 	/* No changeable values for now */
773 	if (pc == 1)
774 		goto out;
775 
776 out:
777 	return 12;
778 }
779 
spc_modesense_control(struct se_cmd * cmd,u8 pc,u8 * p)780 static int spc_modesense_control(struct se_cmd *cmd, u8 pc, u8 *p)
781 {
782 	struct se_device *dev = cmd->se_dev;
783 	struct se_session *sess = cmd->se_sess;
784 
785 	p[0] = 0x0a;
786 	p[1] = 0x0a;
787 
788 	/* No changeable values for now */
789 	if (pc == 1)
790 		goto out;
791 
792 	p[2] = 2;
793 	/*
794 	 * From spc4r23, 7.4.7 Control mode page
795 	 *
796 	 * The QUEUE ALGORITHM MODIFIER field (see table 368) specifies
797 	 * restrictions on the algorithm used for reordering commands
798 	 * having the SIMPLE task attribute (see SAM-4).
799 	 *
800 	 *                    Table 368 -- QUEUE ALGORITHM MODIFIER field
801 	 *                         Code      Description
802 	 *                          0h       Restricted reordering
803 	 *                          1h       Unrestricted reordering allowed
804 	 *                          2h to 7h    Reserved
805 	 *                          8h to Fh    Vendor specific
806 	 *
807 	 * A value of zero in the QUEUE ALGORITHM MODIFIER field specifies that
808 	 * the device server shall order the processing sequence of commands
809 	 * having the SIMPLE task attribute such that data integrity is maintained
810 	 * for that I_T nexus (i.e., if the transmission of new SCSI transport protocol
811 	 * requests is halted at any time, the final value of all data observable
812 	 * on the medium shall be the same as if all the commands had been processed
813 	 * with the ORDERED task attribute).
814 	 *
815 	 * A value of one in the QUEUE ALGORITHM MODIFIER field specifies that the
816 	 * device server may reorder the processing sequence of commands having the
817 	 * SIMPLE task attribute in any manner. Any data integrity exposures related to
818 	 * command sequence order shall be explicitly handled by the application client
819 	 * through the selection of appropriate ommands and task attributes.
820 	 */
821 	p[3] = (dev->dev_attrib.emulate_rest_reord == 1) ? 0x00 : 0x10;
822 	/*
823 	 * From spc4r17, section 7.4.6 Control mode Page
824 	 *
825 	 * Unit Attention interlocks control (UN_INTLCK_CTRL) to code 00b
826 	 *
827 	 * 00b: The logical unit shall clear any unit attention condition
828 	 * reported in the same I_T_L_Q nexus transaction as a CHECK CONDITION
829 	 * status and shall not establish a unit attention condition when a com-
830 	 * mand is completed with BUSY, TASK SET FULL, or RESERVATION CONFLICT
831 	 * status.
832 	 *
833 	 * 10b: The logical unit shall not clear any unit attention condition
834 	 * reported in the same I_T_L_Q nexus transaction as a CHECK CONDITION
835 	 * status and shall not establish a unit attention condition when
836 	 * a command is completed with BUSY, TASK SET FULL, or RESERVATION
837 	 * CONFLICT status.
838 	 *
839 	 * 11b a The logical unit shall not clear any unit attention condition
840 	 * reported in the same I_T_L_Q nexus transaction as a CHECK CONDITION
841 	 * status and shall establish a unit attention condition for the
842 	 * initiator port associated with the I_T nexus on which the BUSY,
843 	 * TASK SET FULL, or RESERVATION CONFLICT status is being returned.
844 	 * Depending on the status, the additional sense code shall be set to
845 	 * PREVIOUS BUSY STATUS, PREVIOUS TASK SET FULL STATUS, or PREVIOUS
846 	 * RESERVATION CONFLICT STATUS. Until it is cleared by a REQUEST SENSE
847 	 * command, a unit attention condition shall be established only once
848 	 * for a BUSY, TASK SET FULL, or RESERVATION CONFLICT status regardless
849 	 * to the number of commands completed with one of those status codes.
850 	 */
851 	p[4] = (dev->dev_attrib.emulate_ua_intlck_ctrl == 2) ? 0x30 :
852 	       (dev->dev_attrib.emulate_ua_intlck_ctrl == 1) ? 0x20 : 0x00;
853 	/*
854 	 * From spc4r17, section 7.4.6 Control mode Page
855 	 *
856 	 * Task Aborted Status (TAS) bit set to zero.
857 	 *
858 	 * A task aborted status (TAS) bit set to zero specifies that aborted
859 	 * tasks shall be terminated by the device server without any response
860 	 * to the application client. A TAS bit set to one specifies that tasks
861 	 * aborted by the actions of an I_T nexus other than the I_T nexus on
862 	 * which the command was received shall be completed with TASK ABORTED
863 	 * status (see SAM-4).
864 	 */
865 	p[5] = (dev->dev_attrib.emulate_tas) ? 0x40 : 0x00;
866 	/*
867 	 * From spc4r30, section 7.5.7 Control mode page
868 	 *
869 	 * Application Tag Owner (ATO) bit set to one.
870 	 *
871 	 * If the ATO bit is set to one the device server shall not modify the
872 	 * LOGICAL BLOCK APPLICATION TAG field and, depending on the protection
873 	 * type, shall not modify the contents of the LOGICAL BLOCK REFERENCE
874 	 * TAG field.
875 	 */
876 	if (sess->sup_prot_ops & (TARGET_PROT_DIN_PASS | TARGET_PROT_DOUT_PASS)) {
877 		if (dev->dev_attrib.pi_prot_type)
878 			p[5] |= 0x80;
879 	}
880 
881 	p[8] = 0xff;
882 	p[9] = 0xff;
883 	p[11] = 30;
884 
885 out:
886 	return 12;
887 }
888 
spc_modesense_caching(struct se_cmd * cmd,u8 pc,u8 * p)889 static int spc_modesense_caching(struct se_cmd *cmd, u8 pc, u8 *p)
890 {
891 	struct se_device *dev = cmd->se_dev;
892 
893 	p[0] = 0x08;
894 	p[1] = 0x12;
895 
896 	/* No changeable values for now */
897 	if (pc == 1)
898 		goto out;
899 
900 	if (spc_check_dev_wce(dev))
901 		p[2] = 0x04; /* Write Cache Enable */
902 	p[12] = 0x20; /* Disabled Read Ahead */
903 
904 out:
905 	return 20;
906 }
907 
spc_modesense_informational_exceptions(struct se_cmd * cmd,u8 pc,unsigned char * p)908 static int spc_modesense_informational_exceptions(struct se_cmd *cmd, u8 pc, unsigned char *p)
909 {
910 	p[0] = 0x1c;
911 	p[1] = 0x0a;
912 
913 	/* No changeable values for now */
914 	if (pc == 1)
915 		goto out;
916 
917 out:
918 	return 12;
919 }
920 
921 static struct {
922 	uint8_t		page;
923 	uint8_t		subpage;
924 	int		(*emulate)(struct se_cmd *, u8, unsigned char *);
925 } modesense_handlers[] = {
926 	{ .page = 0x01, .subpage = 0x00, .emulate = spc_modesense_rwrecovery },
927 	{ .page = 0x08, .subpage = 0x00, .emulate = spc_modesense_caching },
928 	{ .page = 0x0a, .subpage = 0x00, .emulate = spc_modesense_control },
929 	{ .page = 0x1c, .subpage = 0x00, .emulate = spc_modesense_informational_exceptions },
930 };
931 
spc_modesense_write_protect(unsigned char * buf,int type)932 static void spc_modesense_write_protect(unsigned char *buf, int type)
933 {
934 	/*
935 	 * I believe that the WP bit (bit 7) in the mode header is the same for
936 	 * all device types..
937 	 */
938 	switch (type) {
939 	case TYPE_DISK:
940 	case TYPE_TAPE:
941 	default:
942 		buf[0] |= 0x80; /* WP bit */
943 		break;
944 	}
945 }
946 
spc_modesense_dpofua(unsigned char * buf,int type)947 static void spc_modesense_dpofua(unsigned char *buf, int type)
948 {
949 	switch (type) {
950 	case TYPE_DISK:
951 		buf[0] |= 0x10; /* DPOFUA bit */
952 		break;
953 	default:
954 		break;
955 	}
956 }
957 
spc_modesense_blockdesc(unsigned char * buf,u64 blocks,u32 block_size)958 static int spc_modesense_blockdesc(unsigned char *buf, u64 blocks, u32 block_size)
959 {
960 	*buf++ = 8;
961 	put_unaligned_be32(min(blocks, 0xffffffffull), buf);
962 	buf += 4;
963 	put_unaligned_be32(block_size, buf);
964 	return 9;
965 }
966 
spc_modesense_long_blockdesc(unsigned char * buf,u64 blocks,u32 block_size)967 static int spc_modesense_long_blockdesc(unsigned char *buf, u64 blocks, u32 block_size)
968 {
969 	if (blocks <= 0xffffffff)
970 		return spc_modesense_blockdesc(buf + 3, blocks, block_size) + 3;
971 
972 	*buf++ = 1;		/* LONGLBA */
973 	buf += 2;
974 	*buf++ = 16;
975 	put_unaligned_be64(blocks, buf);
976 	buf += 12;
977 	put_unaligned_be32(block_size, buf);
978 
979 	return 17;
980 }
981 
spc_emulate_modesense(struct se_cmd * cmd)982 static sense_reason_t spc_emulate_modesense(struct se_cmd *cmd)
983 {
984 	struct se_device *dev = cmd->se_dev;
985 	char *cdb = cmd->t_task_cdb;
986 	unsigned char buf[SE_MODE_PAGE_BUF], *rbuf;
987 	int type = dev->transport->get_device_type(dev);
988 	int ten = (cmd->t_task_cdb[0] == MODE_SENSE_10);
989 	bool dbd = !!(cdb[1] & 0x08);
990 	bool llba = ten ? !!(cdb[1] & 0x10) : false;
991 	u8 pc = cdb[2] >> 6;
992 	u8 page = cdb[2] & 0x3f;
993 	u8 subpage = cdb[3];
994 	int length = 0;
995 	int ret;
996 	int i;
997 
998 	memset(buf, 0, SE_MODE_PAGE_BUF);
999 
1000 	/*
1001 	 * Skip over MODE DATA LENGTH + MEDIUM TYPE fields to byte 3 for
1002 	 * MODE_SENSE_10 and byte 2 for MODE_SENSE (6).
1003 	 */
1004 	length = ten ? 3 : 2;
1005 
1006 	/* DEVICE-SPECIFIC PARAMETER */
1007 	if ((cmd->se_lun->lun_access & TRANSPORT_LUNFLAGS_READ_ONLY) ||
1008 	    (cmd->se_deve &&
1009 	     (cmd->se_deve->lun_flags & TRANSPORT_LUNFLAGS_READ_ONLY)))
1010 		spc_modesense_write_protect(&buf[length], type);
1011 
1012 	if ((spc_check_dev_wce(dev)) &&
1013 	    (dev->dev_attrib.emulate_fua_write > 0))
1014 		spc_modesense_dpofua(&buf[length], type);
1015 
1016 	++length;
1017 
1018 	/* BLOCK DESCRIPTOR */
1019 
1020 	/*
1021 	 * For now we only include a block descriptor for disk (SBC)
1022 	 * devices; other command sets use a slightly different format.
1023 	 */
1024 	if (!dbd && type == TYPE_DISK) {
1025 		u64 blocks = dev->transport->get_blocks(dev);
1026 		u32 block_size = dev->dev_attrib.block_size;
1027 
1028 		if (ten) {
1029 			if (llba) {
1030 				length += spc_modesense_long_blockdesc(&buf[length],
1031 								       blocks, block_size);
1032 			} else {
1033 				length += 3;
1034 				length += spc_modesense_blockdesc(&buf[length],
1035 								  blocks, block_size);
1036 			}
1037 		} else {
1038 			length += spc_modesense_blockdesc(&buf[length], blocks,
1039 							  block_size);
1040 		}
1041 	} else {
1042 		if (ten)
1043 			length += 4;
1044 		else
1045 			length += 1;
1046 	}
1047 
1048 	if (page == 0x3f) {
1049 		if (subpage != 0x00 && subpage != 0xff) {
1050 			pr_warn("MODE_SENSE: Invalid subpage code: 0x%02x\n", subpage);
1051 			return TCM_INVALID_CDB_FIELD;
1052 		}
1053 
1054 		for (i = 0; i < ARRAY_SIZE(modesense_handlers); ++i) {
1055 			/*
1056 			 * Tricky way to say all subpage 00h for
1057 			 * subpage==0, all subpages for subpage==0xff
1058 			 * (and we just checked above that those are
1059 			 * the only two possibilities).
1060 			 */
1061 			if ((modesense_handlers[i].subpage & ~subpage) == 0) {
1062 				ret = modesense_handlers[i].emulate(cmd, pc, &buf[length]);
1063 				if (!ten && length + ret >= 255)
1064 					break;
1065 				length += ret;
1066 			}
1067 		}
1068 
1069 		goto set_length;
1070 	}
1071 
1072 	for (i = 0; i < ARRAY_SIZE(modesense_handlers); ++i)
1073 		if (modesense_handlers[i].page == page &&
1074 		    modesense_handlers[i].subpage == subpage) {
1075 			length += modesense_handlers[i].emulate(cmd, pc, &buf[length]);
1076 			goto set_length;
1077 		}
1078 
1079 	/*
1080 	 * We don't intend to implement:
1081 	 *  - obsolete page 03h "format parameters" (checked by Solaris)
1082 	 */
1083 	if (page != 0x03)
1084 		pr_err("MODE SENSE: unimplemented page/subpage: 0x%02x/0x%02x\n",
1085 		       page, subpage);
1086 
1087 	return TCM_UNKNOWN_MODE_PAGE;
1088 
1089 set_length:
1090 	if (ten)
1091 		put_unaligned_be16(length - 2, buf);
1092 	else
1093 		buf[0] = length - 1;
1094 
1095 	rbuf = transport_kmap_data_sg(cmd);
1096 	if (rbuf) {
1097 		memcpy(rbuf, buf, min_t(u32, SE_MODE_PAGE_BUF, cmd->data_length));
1098 		transport_kunmap_data_sg(cmd);
1099 	}
1100 
1101 	target_complete_cmd_with_length(cmd, GOOD, length);
1102 	return 0;
1103 }
1104 
spc_emulate_modeselect(struct se_cmd * cmd)1105 static sense_reason_t spc_emulate_modeselect(struct se_cmd *cmd)
1106 {
1107 	char *cdb = cmd->t_task_cdb;
1108 	bool ten = cdb[0] == MODE_SELECT_10;
1109 	int off = ten ? 8 : 4;
1110 	bool pf = !!(cdb[1] & 0x10);
1111 	u8 page, subpage;
1112 	unsigned char *buf;
1113 	unsigned char tbuf[SE_MODE_PAGE_BUF];
1114 	int length;
1115 	int ret = 0;
1116 	int i;
1117 
1118 	if (!cmd->data_length) {
1119 		target_complete_cmd(cmd, GOOD);
1120 		return 0;
1121 	}
1122 
1123 	if (cmd->data_length < off + 2)
1124 		return TCM_PARAMETER_LIST_LENGTH_ERROR;
1125 
1126 	buf = transport_kmap_data_sg(cmd);
1127 	if (!buf)
1128 		return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1129 
1130 	if (!pf) {
1131 		ret = TCM_INVALID_CDB_FIELD;
1132 		goto out;
1133 	}
1134 
1135 	page = buf[off] & 0x3f;
1136 	subpage = buf[off] & 0x40 ? buf[off + 1] : 0;
1137 
1138 	for (i = 0; i < ARRAY_SIZE(modesense_handlers); ++i)
1139 		if (modesense_handlers[i].page == page &&
1140 		    modesense_handlers[i].subpage == subpage) {
1141 			memset(tbuf, 0, SE_MODE_PAGE_BUF);
1142 			length = modesense_handlers[i].emulate(cmd, 0, tbuf);
1143 			goto check_contents;
1144 		}
1145 
1146 	ret = TCM_UNKNOWN_MODE_PAGE;
1147 	goto out;
1148 
1149 check_contents:
1150 	if (cmd->data_length < off + length) {
1151 		ret = TCM_PARAMETER_LIST_LENGTH_ERROR;
1152 		goto out;
1153 	}
1154 
1155 	if (memcmp(buf + off, tbuf, length))
1156 		ret = TCM_INVALID_PARAMETER_LIST;
1157 
1158 out:
1159 	transport_kunmap_data_sg(cmd);
1160 
1161 	if (!ret)
1162 		target_complete_cmd(cmd, GOOD);
1163 	return ret;
1164 }
1165 
spc_emulate_request_sense(struct se_cmd * cmd)1166 static sense_reason_t spc_emulate_request_sense(struct se_cmd *cmd)
1167 {
1168 	unsigned char *cdb = cmd->t_task_cdb;
1169 	unsigned char *rbuf;
1170 	u8 ua_asc = 0, ua_ascq = 0;
1171 	unsigned char buf[SE_SENSE_BUF];
1172 
1173 	memset(buf, 0, SE_SENSE_BUF);
1174 
1175 	if (cdb[1] & 0x01) {
1176 		pr_err("REQUEST_SENSE description emulation not"
1177 			" supported\n");
1178 		return TCM_INVALID_CDB_FIELD;
1179 	}
1180 
1181 	rbuf = transport_kmap_data_sg(cmd);
1182 	if (!rbuf)
1183 		return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1184 
1185 	if (!core_scsi3_ua_clear_for_request_sense(cmd, &ua_asc, &ua_ascq)) {
1186 		/*
1187 		 * CURRENT ERROR, UNIT ATTENTION
1188 		 */
1189 		buf[0] = 0x70;
1190 		buf[SPC_SENSE_KEY_OFFSET] = UNIT_ATTENTION;
1191 
1192 		/*
1193 		 * The Additional Sense Code (ASC) from the UNIT ATTENTION
1194 		 */
1195 		buf[SPC_ASC_KEY_OFFSET] = ua_asc;
1196 		buf[SPC_ASCQ_KEY_OFFSET] = ua_ascq;
1197 		buf[7] = 0x0A;
1198 	} else {
1199 		/*
1200 		 * CURRENT ERROR, NO SENSE
1201 		 */
1202 		buf[0] = 0x70;
1203 		buf[SPC_SENSE_KEY_OFFSET] = NO_SENSE;
1204 
1205 		/*
1206 		 * NO ADDITIONAL SENSE INFORMATION
1207 		 */
1208 		buf[SPC_ASC_KEY_OFFSET] = 0x00;
1209 		buf[7] = 0x0A;
1210 	}
1211 
1212 	memcpy(rbuf, buf, min_t(u32, sizeof(buf), cmd->data_length));
1213 	transport_kunmap_data_sg(cmd);
1214 
1215 	target_complete_cmd(cmd, GOOD);
1216 	return 0;
1217 }
1218 
spc_emulate_report_luns(struct se_cmd * cmd)1219 sense_reason_t spc_emulate_report_luns(struct se_cmd *cmd)
1220 {
1221 	struct se_dev_entry *deve;
1222 	struct se_session *sess = cmd->se_sess;
1223 	unsigned char *buf;
1224 	u32 lun_count = 0, offset = 8, i;
1225 
1226 	if (cmd->data_length < 16) {
1227 		pr_warn("REPORT LUNS allocation length %u too small\n",
1228 			cmd->data_length);
1229 		return TCM_INVALID_CDB_FIELD;
1230 	}
1231 
1232 	buf = transport_kmap_data_sg(cmd);
1233 	if (!buf)
1234 		return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1235 
1236 	/*
1237 	 * If no struct se_session pointer is present, this struct se_cmd is
1238 	 * coming via a target_core_mod PASSTHROUGH op, and not through
1239 	 * a $FABRIC_MOD.  In that case, report LUN=0 only.
1240 	 */
1241 	if (!sess) {
1242 		int_to_scsilun(0, (struct scsi_lun *)&buf[offset]);
1243 		lun_count = 1;
1244 		goto done;
1245 	}
1246 
1247 	spin_lock_irq(&sess->se_node_acl->device_list_lock);
1248 	for (i = 0; i < TRANSPORT_MAX_LUNS_PER_TPG; i++) {
1249 		deve = sess->se_node_acl->device_list[i];
1250 		if (!(deve->lun_flags & TRANSPORT_LUNFLAGS_INITIATOR_ACCESS))
1251 			continue;
1252 		/*
1253 		 * We determine the correct LUN LIST LENGTH even once we
1254 		 * have reached the initial allocation length.
1255 		 * See SPC2-R20 7.19.
1256 		 */
1257 		lun_count++;
1258 		if ((offset + 8) > cmd->data_length)
1259 			continue;
1260 
1261 		int_to_scsilun(deve->mapped_lun, (struct scsi_lun *)&buf[offset]);
1262 		offset += 8;
1263 	}
1264 	spin_unlock_irq(&sess->se_node_acl->device_list_lock);
1265 
1266 	/*
1267 	 * See SPC3 r07, page 159.
1268 	 */
1269 done:
1270 	lun_count *= 8;
1271 	buf[0] = ((lun_count >> 24) & 0xff);
1272 	buf[1] = ((lun_count >> 16) & 0xff);
1273 	buf[2] = ((lun_count >> 8) & 0xff);
1274 	buf[3] = (lun_count & 0xff);
1275 	transport_kunmap_data_sg(cmd);
1276 
1277 	target_complete_cmd_with_length(cmd, GOOD, 8 + lun_count * 8);
1278 	return 0;
1279 }
1280 EXPORT_SYMBOL(spc_emulate_report_luns);
1281 
1282 static sense_reason_t
spc_emulate_testunitready(struct se_cmd * cmd)1283 spc_emulate_testunitready(struct se_cmd *cmd)
1284 {
1285 	target_complete_cmd(cmd, GOOD);
1286 	return 0;
1287 }
1288 
1289 sense_reason_t
spc_parse_cdb(struct se_cmd * cmd,unsigned int * size)1290 spc_parse_cdb(struct se_cmd *cmd, unsigned int *size)
1291 {
1292 	struct se_device *dev = cmd->se_dev;
1293 	unsigned char *cdb = cmd->t_task_cdb;
1294 
1295 	switch (cdb[0]) {
1296 	case MODE_SELECT:
1297 		*size = cdb[4];
1298 		cmd->execute_cmd = spc_emulate_modeselect;
1299 		break;
1300 	case MODE_SELECT_10:
1301 		*size = (cdb[7] << 8) + cdb[8];
1302 		cmd->execute_cmd = spc_emulate_modeselect;
1303 		break;
1304 	case MODE_SENSE:
1305 		*size = cdb[4];
1306 		cmd->execute_cmd = spc_emulate_modesense;
1307 		break;
1308 	case MODE_SENSE_10:
1309 		*size = (cdb[7] << 8) + cdb[8];
1310 		cmd->execute_cmd = spc_emulate_modesense;
1311 		break;
1312 	case LOG_SELECT:
1313 	case LOG_SENSE:
1314 		*size = (cdb[7] << 8) + cdb[8];
1315 		break;
1316 	case PERSISTENT_RESERVE_IN:
1317 		*size = (cdb[7] << 8) + cdb[8];
1318 		cmd->execute_cmd = target_scsi3_emulate_pr_in;
1319 		break;
1320 	case PERSISTENT_RESERVE_OUT:
1321 		*size = (cdb[7] << 8) + cdb[8];
1322 		cmd->execute_cmd = target_scsi3_emulate_pr_out;
1323 		break;
1324 	case RELEASE:
1325 	case RELEASE_10:
1326 		if (cdb[0] == RELEASE_10)
1327 			*size = (cdb[7] << 8) | cdb[8];
1328 		else
1329 			*size = cmd->data_length;
1330 
1331 		cmd->execute_cmd = target_scsi2_reservation_release;
1332 		break;
1333 	case RESERVE:
1334 	case RESERVE_10:
1335 		/*
1336 		 * The SPC-2 RESERVE does not contain a size in the SCSI CDB.
1337 		 * Assume the passthrough or $FABRIC_MOD will tell us about it.
1338 		 */
1339 		if (cdb[0] == RESERVE_10)
1340 			*size = (cdb[7] << 8) | cdb[8];
1341 		else
1342 			*size = cmd->data_length;
1343 
1344 		cmd->execute_cmd = target_scsi2_reservation_reserve;
1345 		break;
1346 	case REQUEST_SENSE:
1347 		*size = cdb[4];
1348 		cmd->execute_cmd = spc_emulate_request_sense;
1349 		break;
1350 	case INQUIRY:
1351 		*size = (cdb[3] << 8) + cdb[4];
1352 
1353 		/*
1354 		 * Do implicit HEAD_OF_QUEUE processing for INQUIRY.
1355 		 * See spc4r17 section 5.3
1356 		 */
1357 		cmd->sam_task_attr = MSG_HEAD_TAG;
1358 		cmd->execute_cmd = spc_emulate_inquiry;
1359 		break;
1360 	case SECURITY_PROTOCOL_IN:
1361 	case SECURITY_PROTOCOL_OUT:
1362 		*size = (cdb[6] << 24) | (cdb[7] << 16) | (cdb[8] << 8) | cdb[9];
1363 		break;
1364 	case EXTENDED_COPY:
1365 		*size = get_unaligned_be32(&cdb[10]);
1366 		cmd->execute_cmd = target_do_xcopy;
1367 		break;
1368 	case RECEIVE_COPY_RESULTS:
1369 		*size = get_unaligned_be32(&cdb[10]);
1370 		cmd->execute_cmd = target_do_receive_copy_results;
1371 		break;
1372 	case READ_ATTRIBUTE:
1373 	case WRITE_ATTRIBUTE:
1374 		*size = (cdb[10] << 24) | (cdb[11] << 16) |
1375 		       (cdb[12] << 8) | cdb[13];
1376 		break;
1377 	case RECEIVE_DIAGNOSTIC:
1378 	case SEND_DIAGNOSTIC:
1379 		*size = (cdb[3] << 8) | cdb[4];
1380 		break;
1381 	case WRITE_BUFFER:
1382 		*size = (cdb[6] << 16) + (cdb[7] << 8) + cdb[8];
1383 		break;
1384 	case REPORT_LUNS:
1385 		cmd->execute_cmd = spc_emulate_report_luns;
1386 		*size = (cdb[6] << 24) | (cdb[7] << 16) | (cdb[8] << 8) | cdb[9];
1387 		/*
1388 		 * Do implicit HEAD_OF_QUEUE processing for REPORT_LUNS
1389 		 * See spc4r17 section 5.3
1390 		 */
1391 		cmd->sam_task_attr = MSG_HEAD_TAG;
1392 		break;
1393 	case TEST_UNIT_READY:
1394 		cmd->execute_cmd = spc_emulate_testunitready;
1395 		*size = 0;
1396 		break;
1397 	case MAINTENANCE_IN:
1398 		if (dev->transport->get_device_type(dev) != TYPE_ROM) {
1399 			/*
1400 			 * MAINTENANCE_IN from SCC-2
1401 			 * Check for emulated MI_REPORT_TARGET_PGS
1402 			 */
1403 			if ((cdb[1] & 0x1f) == MI_REPORT_TARGET_PGS) {
1404 				cmd->execute_cmd =
1405 					target_emulate_report_target_port_groups;
1406 			}
1407 			*size = get_unaligned_be32(&cdb[6]);
1408 		} else {
1409 			/*
1410 			 * GPCMD_SEND_KEY from multi media commands
1411 			 */
1412 			*size = get_unaligned_be16(&cdb[8]);
1413 		}
1414 		break;
1415 	case MAINTENANCE_OUT:
1416 		if (dev->transport->get_device_type(dev) != TYPE_ROM) {
1417 			/*
1418 			 * MAINTENANCE_OUT from SCC-2
1419 			 * Check for emulated MO_SET_TARGET_PGS.
1420 			 */
1421 			if (cdb[1] == MO_SET_TARGET_PGS) {
1422 				cmd->execute_cmd =
1423 					target_emulate_set_target_port_groups;
1424 			}
1425 			*size = get_unaligned_be32(&cdb[6]);
1426 		} else {
1427 			/*
1428 			 * GPCMD_SEND_KEY from multi media commands
1429 			 */
1430 			*size = get_unaligned_be16(&cdb[8]);
1431 		}
1432 		break;
1433 	default:
1434 		pr_warn("TARGET_CORE[%s]: Unsupported SCSI Opcode"
1435 			" 0x%02x, sending CHECK_CONDITION.\n",
1436 			cmd->se_tfo->get_fabric_name(), cdb[0]);
1437 		return TCM_UNSUPPORTED_SCSI_OPCODE;
1438 	}
1439 
1440 	return 0;
1441 }
1442 EXPORT_SYMBOL(spc_parse_cdb);
1443