1 /*******************************************************************************
2  * Filename:  target_core_device.c (based on iscsi_target_device.c)
3  *
4  * This file contains the TCM Virtual Device and Disk Transport
5  * agnostic related functions.
6  *
7  * (c) Copyright 2003-2013 Datera, Inc.
8  *
9  * Nicholas A. Bellinger <nab@kernel.org>
10  *
11  * This program is free software; you can redistribute it and/or modify
12  * it under the terms of the GNU General Public License as published by
13  * the Free Software Foundation; either version 2 of the License, or
14  * (at your option) any later version.
15  *
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19  * GNU General Public License for more details.
20  *
21  * You should have received a copy of the GNU General Public License
22  * along with this program; if not, write to the Free Software
23  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
24  *
25  ******************************************************************************/
26 
27 #include <linux/net.h>
28 #include <linux/string.h>
29 #include <linux/delay.h>
30 #include <linux/timer.h>
31 #include <linux/slab.h>
32 #include <linux/spinlock.h>
33 #include <linux/kthread.h>
34 #include <linux/in.h>
35 #include <linux/export.h>
36 #include <linux/t10-pi.h>
37 #include <asm/unaligned.h>
38 #include <net/sock.h>
39 #include <net/tcp.h>
40 #include <scsi/scsi_common.h>
41 #include <scsi/scsi_proto.h>
42 
43 #include <target/target_core_base.h>
44 #include <target/target_core_backend.h>
45 #include <target/target_core_fabric.h>
46 
47 #include "target_core_internal.h"
48 #include "target_core_alua.h"
49 #include "target_core_pr.h"
50 #include "target_core_ua.h"
51 
52 DEFINE_MUTEX(g_device_mutex);
53 LIST_HEAD(g_device_list);
54 
55 static struct se_hba *lun0_hba;
56 /* not static, needed by tpg.c */
57 struct se_device *g_lun0_dev;
58 
59 sense_reason_t
60 transport_lookup_cmd_lun(struct se_cmd *se_cmd, u64 unpacked_lun)
61 {
62 	struct se_lun *se_lun = NULL;
63 	struct se_session *se_sess = se_cmd->se_sess;
64 	struct se_node_acl *nacl = se_sess->se_node_acl;
65 	struct se_dev_entry *deve;
66 	sense_reason_t ret = TCM_NO_SENSE;
67 
68 	rcu_read_lock();
69 	deve = target_nacl_find_deve(nacl, unpacked_lun);
70 	if (deve) {
71 		atomic_long_inc(&deve->total_cmds);
72 
73 		if (se_cmd->data_direction == DMA_TO_DEVICE)
74 			atomic_long_add(se_cmd->data_length,
75 					&deve->write_bytes);
76 		else if (se_cmd->data_direction == DMA_FROM_DEVICE)
77 			atomic_long_add(se_cmd->data_length,
78 					&deve->read_bytes);
79 
80 		se_lun = rcu_dereference(deve->se_lun);
81 		se_cmd->se_lun = rcu_dereference(deve->se_lun);
82 		se_cmd->pr_res_key = deve->pr_res_key;
83 		se_cmd->orig_fe_lun = unpacked_lun;
84 		se_cmd->se_cmd_flags |= SCF_SE_LUN_CMD;
85 
86 		percpu_ref_get(&se_lun->lun_ref);
87 		se_cmd->lun_ref_active = true;
88 
89 		if ((se_cmd->data_direction == DMA_TO_DEVICE) &&
90 		    deve->lun_access_ro) {
91 			pr_err("TARGET_CORE[%s]: Detected WRITE_PROTECTED LUN"
92 				" Access for 0x%08llx\n",
93 				se_cmd->se_tfo->get_fabric_name(),
94 				unpacked_lun);
95 			rcu_read_unlock();
96 			ret = TCM_WRITE_PROTECTED;
97 			goto ref_dev;
98 		}
99 	}
100 	rcu_read_unlock();
101 
102 	if (!se_lun) {
103 		/*
104 		 * Use the se_portal_group->tpg_virt_lun0 to allow for
105 		 * REPORT_LUNS, et al to be returned when no active
106 		 * MappedLUN=0 exists for this Initiator Port.
107 		 */
108 		if (unpacked_lun != 0) {
109 			pr_err("TARGET_CORE[%s]: Detected NON_EXISTENT_LUN"
110 				" Access for 0x%08llx\n",
111 				se_cmd->se_tfo->get_fabric_name(),
112 				unpacked_lun);
113 			return TCM_NON_EXISTENT_LUN;
114 		}
115 
116 		se_lun = se_sess->se_tpg->tpg_virt_lun0;
117 		se_cmd->se_lun = se_sess->se_tpg->tpg_virt_lun0;
118 		se_cmd->orig_fe_lun = 0;
119 		se_cmd->se_cmd_flags |= SCF_SE_LUN_CMD;
120 
121 		percpu_ref_get(&se_lun->lun_ref);
122 		se_cmd->lun_ref_active = true;
123 
124 		/*
125 		 * Force WRITE PROTECT for virtual LUN 0
126 		 */
127 		if ((se_cmd->data_direction != DMA_FROM_DEVICE) &&
128 		    (se_cmd->data_direction != DMA_NONE)) {
129 			ret = TCM_WRITE_PROTECTED;
130 			goto ref_dev;
131 		}
132 	}
133 	/*
134 	 * RCU reference protected by percpu se_lun->lun_ref taken above that
135 	 * must drop to zero (including initial reference) before this se_lun
136 	 * pointer can be kfree_rcu() by the final se_lun->lun_group put via
137 	 * target_core_fabric_configfs.c:target_fabric_port_release
138 	 */
139 ref_dev:
140 	se_cmd->se_dev = rcu_dereference_raw(se_lun->lun_se_dev);
141 	atomic_long_inc(&se_cmd->se_dev->num_cmds);
142 
143 	if (se_cmd->data_direction == DMA_TO_DEVICE)
144 		atomic_long_add(se_cmd->data_length,
145 				&se_cmd->se_dev->write_bytes);
146 	else if (se_cmd->data_direction == DMA_FROM_DEVICE)
147 		atomic_long_add(se_cmd->data_length,
148 				&se_cmd->se_dev->read_bytes);
149 
150 	return ret;
151 }
152 EXPORT_SYMBOL(transport_lookup_cmd_lun);
153 
154 int transport_lookup_tmr_lun(struct se_cmd *se_cmd, u64 unpacked_lun)
155 {
156 	struct se_dev_entry *deve;
157 	struct se_lun *se_lun = NULL;
158 	struct se_session *se_sess = se_cmd->se_sess;
159 	struct se_node_acl *nacl = se_sess->se_node_acl;
160 	struct se_tmr_req *se_tmr = se_cmd->se_tmr_req;
161 	unsigned long flags;
162 
163 	rcu_read_lock();
164 	deve = target_nacl_find_deve(nacl, unpacked_lun);
165 	if (deve) {
166 		se_tmr->tmr_lun = rcu_dereference(deve->se_lun);
167 		se_cmd->se_lun = rcu_dereference(deve->se_lun);
168 		se_lun = rcu_dereference(deve->se_lun);
169 		se_cmd->pr_res_key = deve->pr_res_key;
170 		se_cmd->orig_fe_lun = unpacked_lun;
171 	}
172 	rcu_read_unlock();
173 
174 	if (!se_lun) {
175 		pr_debug("TARGET_CORE[%s]: Detected NON_EXISTENT_LUN"
176 			" Access for 0x%08llx\n",
177 			se_cmd->se_tfo->get_fabric_name(),
178 			unpacked_lun);
179 		return -ENODEV;
180 	}
181 	/*
182 	 * XXX: Add percpu se_lun->lun_ref reference count for TMR
183 	 */
184 	se_cmd->se_dev = rcu_dereference_raw(se_lun->lun_se_dev);
185 	se_tmr->tmr_dev = rcu_dereference_raw(se_lun->lun_se_dev);
186 
187 	spin_lock_irqsave(&se_tmr->tmr_dev->se_tmr_lock, flags);
188 	list_add_tail(&se_tmr->tmr_list, &se_tmr->tmr_dev->dev_tmr_list);
189 	spin_unlock_irqrestore(&se_tmr->tmr_dev->se_tmr_lock, flags);
190 
191 	return 0;
192 }
193 EXPORT_SYMBOL(transport_lookup_tmr_lun);
194 
195 bool target_lun_is_rdonly(struct se_cmd *cmd)
196 {
197 	struct se_session *se_sess = cmd->se_sess;
198 	struct se_dev_entry *deve;
199 	bool ret;
200 
201 	rcu_read_lock();
202 	deve = target_nacl_find_deve(se_sess->se_node_acl, cmd->orig_fe_lun);
203 	ret = deve && deve->lun_access_ro;
204 	rcu_read_unlock();
205 
206 	return ret;
207 }
208 EXPORT_SYMBOL(target_lun_is_rdonly);
209 
210 /*
211  * This function is called from core_scsi3_emulate_pro_register_and_move()
212  * and core_scsi3_decode_spec_i_port(), and will increment &deve->pr_kref
213  * when a matching rtpi is found.
214  */
215 struct se_dev_entry *core_get_se_deve_from_rtpi(
216 	struct se_node_acl *nacl,
217 	u16 rtpi)
218 {
219 	struct se_dev_entry *deve;
220 	struct se_lun *lun;
221 	struct se_portal_group *tpg = nacl->se_tpg;
222 
223 	rcu_read_lock();
224 	hlist_for_each_entry_rcu(deve, &nacl->lun_entry_hlist, link) {
225 		lun = rcu_dereference(deve->se_lun);
226 		if (!lun) {
227 			pr_err("%s device entries device pointer is"
228 				" NULL, but Initiator has access.\n",
229 				tpg->se_tpg_tfo->get_fabric_name());
230 			continue;
231 		}
232 		if (lun->lun_rtpi != rtpi)
233 			continue;
234 
235 		kref_get(&deve->pr_kref);
236 		rcu_read_unlock();
237 
238 		return deve;
239 	}
240 	rcu_read_unlock();
241 
242 	return NULL;
243 }
244 
245 void core_free_device_list_for_node(
246 	struct se_node_acl *nacl,
247 	struct se_portal_group *tpg)
248 {
249 	struct se_dev_entry *deve;
250 
251 	mutex_lock(&nacl->lun_entry_mutex);
252 	hlist_for_each_entry_rcu(deve, &nacl->lun_entry_hlist, link) {
253 		struct se_lun *lun = rcu_dereference_check(deve->se_lun,
254 					lockdep_is_held(&nacl->lun_entry_mutex));
255 		core_disable_device_list_for_node(lun, deve, nacl, tpg);
256 	}
257 	mutex_unlock(&nacl->lun_entry_mutex);
258 }
259 
260 void core_update_device_list_access(
261 	u64 mapped_lun,
262 	bool lun_access_ro,
263 	struct se_node_acl *nacl)
264 {
265 	struct se_dev_entry *deve;
266 
267 	mutex_lock(&nacl->lun_entry_mutex);
268 	deve = target_nacl_find_deve(nacl, mapped_lun);
269 	if (deve)
270 		deve->lun_access_ro = lun_access_ro;
271 	mutex_unlock(&nacl->lun_entry_mutex);
272 }
273 
274 /*
275  * Called with rcu_read_lock or nacl->device_list_lock held.
276  */
277 struct se_dev_entry *target_nacl_find_deve(struct se_node_acl *nacl, u64 mapped_lun)
278 {
279 	struct se_dev_entry *deve;
280 
281 	hlist_for_each_entry_rcu(deve, &nacl->lun_entry_hlist, link)
282 		if (deve->mapped_lun == mapped_lun)
283 			return deve;
284 
285 	return NULL;
286 }
287 EXPORT_SYMBOL(target_nacl_find_deve);
288 
289 void target_pr_kref_release(struct kref *kref)
290 {
291 	struct se_dev_entry *deve = container_of(kref, struct se_dev_entry,
292 						 pr_kref);
293 	complete(&deve->pr_comp);
294 }
295 
296 static void
297 target_luns_data_has_changed(struct se_node_acl *nacl, struct se_dev_entry *new,
298 			     bool skip_new)
299 {
300 	struct se_dev_entry *tmp;
301 
302 	rcu_read_lock();
303 	hlist_for_each_entry_rcu(tmp, &nacl->lun_entry_hlist, link) {
304 		if (skip_new && tmp == new)
305 			continue;
306 		core_scsi3_ua_allocate(tmp, 0x3F,
307 				       ASCQ_3FH_REPORTED_LUNS_DATA_HAS_CHANGED);
308 	}
309 	rcu_read_unlock();
310 }
311 
312 int core_enable_device_list_for_node(
313 	struct se_lun *lun,
314 	struct se_lun_acl *lun_acl,
315 	u64 mapped_lun,
316 	bool lun_access_ro,
317 	struct se_node_acl *nacl,
318 	struct se_portal_group *tpg)
319 {
320 	struct se_dev_entry *orig, *new;
321 
322 	new = kzalloc(sizeof(*new), GFP_KERNEL);
323 	if (!new) {
324 		pr_err("Unable to allocate se_dev_entry memory\n");
325 		return -ENOMEM;
326 	}
327 
328 	atomic_set(&new->ua_count, 0);
329 	spin_lock_init(&new->ua_lock);
330 	INIT_LIST_HEAD(&new->ua_list);
331 	INIT_LIST_HEAD(&new->lun_link);
332 
333 	new->mapped_lun = mapped_lun;
334 	kref_init(&new->pr_kref);
335 	init_completion(&new->pr_comp);
336 
337 	new->lun_access_ro = lun_access_ro;
338 	new->creation_time = get_jiffies_64();
339 	new->attach_count++;
340 
341 	mutex_lock(&nacl->lun_entry_mutex);
342 	orig = target_nacl_find_deve(nacl, mapped_lun);
343 	if (orig && orig->se_lun) {
344 		struct se_lun *orig_lun = rcu_dereference_check(orig->se_lun,
345 					lockdep_is_held(&nacl->lun_entry_mutex));
346 
347 		if (orig_lun != lun) {
348 			pr_err("Existing orig->se_lun doesn't match new lun"
349 			       " for dynamic -> explicit NodeACL conversion:"
350 				" %s\n", nacl->initiatorname);
351 			mutex_unlock(&nacl->lun_entry_mutex);
352 			kfree(new);
353 			return -EINVAL;
354 		}
355 		BUG_ON(orig->se_lun_acl != NULL);
356 
357 		rcu_assign_pointer(new->se_lun, lun);
358 		rcu_assign_pointer(new->se_lun_acl, lun_acl);
359 		hlist_del_rcu(&orig->link);
360 		hlist_add_head_rcu(&new->link, &nacl->lun_entry_hlist);
361 		mutex_unlock(&nacl->lun_entry_mutex);
362 
363 		spin_lock(&lun->lun_deve_lock);
364 		list_del(&orig->lun_link);
365 		list_add_tail(&new->lun_link, &lun->lun_deve_list);
366 		spin_unlock(&lun->lun_deve_lock);
367 
368 		kref_put(&orig->pr_kref, target_pr_kref_release);
369 		wait_for_completion(&orig->pr_comp);
370 
371 		target_luns_data_has_changed(nacl, new, true);
372 		kfree_rcu(orig, rcu_head);
373 		return 0;
374 	}
375 
376 	rcu_assign_pointer(new->se_lun, lun);
377 	rcu_assign_pointer(new->se_lun_acl, lun_acl);
378 	hlist_add_head_rcu(&new->link, &nacl->lun_entry_hlist);
379 	mutex_unlock(&nacl->lun_entry_mutex);
380 
381 	spin_lock(&lun->lun_deve_lock);
382 	list_add_tail(&new->lun_link, &lun->lun_deve_list);
383 	spin_unlock(&lun->lun_deve_lock);
384 
385 	target_luns_data_has_changed(nacl, new, true);
386 	return 0;
387 }
388 
389 /*
390  *	Called with se_node_acl->lun_entry_mutex held.
391  */
392 void core_disable_device_list_for_node(
393 	struct se_lun *lun,
394 	struct se_dev_entry *orig,
395 	struct se_node_acl *nacl,
396 	struct se_portal_group *tpg)
397 {
398 	/*
399 	 * rcu_dereference_raw protected by se_lun->lun_group symlink
400 	 * reference to se_device->dev_group.
401 	 */
402 	struct se_device *dev = rcu_dereference_raw(lun->lun_se_dev);
403 	/*
404 	 * If the MappedLUN entry is being disabled, the entry in
405 	 * lun->lun_deve_list must be removed now before clearing the
406 	 * struct se_dev_entry pointers below as logic in
407 	 * core_alua_do_transition_tg_pt() depends on these being present.
408 	 *
409 	 * deve->se_lun_acl will be NULL for demo-mode created LUNs
410 	 * that have not been explicitly converted to MappedLUNs ->
411 	 * struct se_lun_acl, but we remove deve->lun_link from
412 	 * lun->lun_deve_list. This also means that active UAs and
413 	 * NodeACL context specific PR metadata for demo-mode
414 	 * MappedLUN *deve will be released below..
415 	 */
416 	spin_lock(&lun->lun_deve_lock);
417 	list_del(&orig->lun_link);
418 	spin_unlock(&lun->lun_deve_lock);
419 	/*
420 	 * Disable struct se_dev_entry LUN ACL mapping
421 	 */
422 	core_scsi3_ua_release_all(orig);
423 
424 	hlist_del_rcu(&orig->link);
425 	clear_bit(DEF_PR_REG_ACTIVE, &orig->deve_flags);
426 	orig->lun_access_ro = false;
427 	orig->creation_time = 0;
428 	orig->attach_count--;
429 	/*
430 	 * Before firing off RCU callback, wait for any in process SPEC_I_PT=1
431 	 * or REGISTER_AND_MOVE PR operation to complete.
432 	 */
433 	kref_put(&orig->pr_kref, target_pr_kref_release);
434 	wait_for_completion(&orig->pr_comp);
435 
436 	rcu_assign_pointer(orig->se_lun, NULL);
437 	rcu_assign_pointer(orig->se_lun_acl, NULL);
438 
439 	kfree_rcu(orig, rcu_head);
440 
441 	core_scsi3_free_pr_reg_from_nacl(dev, nacl);
442 	target_luns_data_has_changed(nacl, NULL, false);
443 }
444 
445 /*      core_clear_lun_from_tpg():
446  *
447  *
448  */
449 void core_clear_lun_from_tpg(struct se_lun *lun, struct se_portal_group *tpg)
450 {
451 	struct se_node_acl *nacl;
452 	struct se_dev_entry *deve;
453 
454 	mutex_lock(&tpg->acl_node_mutex);
455 	list_for_each_entry(nacl, &tpg->acl_node_list, acl_list) {
456 
457 		mutex_lock(&nacl->lun_entry_mutex);
458 		hlist_for_each_entry_rcu(deve, &nacl->lun_entry_hlist, link) {
459 			struct se_lun *tmp_lun = rcu_dereference_check(deve->se_lun,
460 					lockdep_is_held(&nacl->lun_entry_mutex));
461 
462 			if (lun != tmp_lun)
463 				continue;
464 
465 			core_disable_device_list_for_node(lun, deve, nacl, tpg);
466 		}
467 		mutex_unlock(&nacl->lun_entry_mutex);
468 	}
469 	mutex_unlock(&tpg->acl_node_mutex);
470 }
471 
472 int core_alloc_rtpi(struct se_lun *lun, struct se_device *dev)
473 {
474 	struct se_lun *tmp;
475 
476 	spin_lock(&dev->se_port_lock);
477 	if (dev->export_count == 0x0000ffff) {
478 		pr_warn("Reached dev->dev_port_count =="
479 				" 0x0000ffff\n");
480 		spin_unlock(&dev->se_port_lock);
481 		return -ENOSPC;
482 	}
483 again:
484 	/*
485 	 * Allocate the next RELATIVE TARGET PORT IDENTIFIER for this struct se_device
486 	 * Here is the table from spc4r17 section 7.7.3.8.
487 	 *
488 	 *    Table 473 -- RELATIVE TARGET PORT IDENTIFIER field
489 	 *
490 	 * Code      Description
491 	 * 0h        Reserved
492 	 * 1h        Relative port 1, historically known as port A
493 	 * 2h        Relative port 2, historically known as port B
494 	 * 3h to FFFFh    Relative port 3 through 65 535
495 	 */
496 	lun->lun_rtpi = dev->dev_rpti_counter++;
497 	if (!lun->lun_rtpi)
498 		goto again;
499 
500 	list_for_each_entry(tmp, &dev->dev_sep_list, lun_dev_link) {
501 		/*
502 		 * Make sure RELATIVE TARGET PORT IDENTIFIER is unique
503 		 * for 16-bit wrap..
504 		 */
505 		if (lun->lun_rtpi == tmp->lun_rtpi)
506 			goto again;
507 	}
508 	spin_unlock(&dev->se_port_lock);
509 
510 	return 0;
511 }
512 
513 static void se_release_vpd_for_dev(struct se_device *dev)
514 {
515 	struct t10_vpd *vpd, *vpd_tmp;
516 
517 	spin_lock(&dev->t10_wwn.t10_vpd_lock);
518 	list_for_each_entry_safe(vpd, vpd_tmp,
519 			&dev->t10_wwn.t10_vpd_list, vpd_list) {
520 		list_del(&vpd->vpd_list);
521 		kfree(vpd);
522 	}
523 	spin_unlock(&dev->t10_wwn.t10_vpd_lock);
524 }
525 
526 static u32 se_dev_align_max_sectors(u32 max_sectors, u32 block_size)
527 {
528 	u32 aligned_max_sectors;
529 	u32 alignment;
530 	/*
531 	 * Limit max_sectors to a PAGE_SIZE aligned value for modern
532 	 * transport_allocate_data_tasks() operation.
533 	 */
534 	alignment = max(1ul, PAGE_SIZE / block_size);
535 	aligned_max_sectors = rounddown(max_sectors, alignment);
536 
537 	if (max_sectors != aligned_max_sectors)
538 		pr_info("Rounding down aligned max_sectors from %u to %u\n",
539 			max_sectors, aligned_max_sectors);
540 
541 	return aligned_max_sectors;
542 }
543 
544 int core_dev_add_lun(
545 	struct se_portal_group *tpg,
546 	struct se_device *dev,
547 	struct se_lun *lun)
548 {
549 	int rc;
550 
551 	rc = core_tpg_add_lun(tpg, lun, false, dev);
552 	if (rc < 0)
553 		return rc;
554 
555 	pr_debug("%s_TPG[%u]_LUN[%llu] - Activated %s Logical Unit from"
556 		" CORE HBA: %u\n", tpg->se_tpg_tfo->get_fabric_name(),
557 		tpg->se_tpg_tfo->tpg_get_tag(tpg), lun->unpacked_lun,
558 		tpg->se_tpg_tfo->get_fabric_name(), dev->se_hba->hba_id);
559 	/*
560 	 * Update LUN maps for dynamically added initiators when
561 	 * generate_node_acl is enabled.
562 	 */
563 	if (tpg->se_tpg_tfo->tpg_check_demo_mode(tpg)) {
564 		struct se_node_acl *acl;
565 
566 		mutex_lock(&tpg->acl_node_mutex);
567 		list_for_each_entry(acl, &tpg->acl_node_list, acl_list) {
568 			if (acl->dynamic_node_acl &&
569 			    (!tpg->se_tpg_tfo->tpg_check_demo_mode_login_only ||
570 			     !tpg->se_tpg_tfo->tpg_check_demo_mode_login_only(tpg))) {
571 				core_tpg_add_node_to_devs(acl, tpg, lun);
572 			}
573 		}
574 		mutex_unlock(&tpg->acl_node_mutex);
575 	}
576 
577 	return 0;
578 }
579 
580 /*      core_dev_del_lun():
581  *
582  *
583  */
584 void core_dev_del_lun(
585 	struct se_portal_group *tpg,
586 	struct se_lun *lun)
587 {
588 	pr_debug("%s_TPG[%u]_LUN[%llu] - Deactivating %s Logical Unit from"
589 		" device object\n", tpg->se_tpg_tfo->get_fabric_name(),
590 		tpg->se_tpg_tfo->tpg_get_tag(tpg), lun->unpacked_lun,
591 		tpg->se_tpg_tfo->get_fabric_name());
592 
593 	core_tpg_remove_lun(tpg, lun);
594 }
595 
596 struct se_lun_acl *core_dev_init_initiator_node_lun_acl(
597 	struct se_portal_group *tpg,
598 	struct se_node_acl *nacl,
599 	u64 mapped_lun,
600 	int *ret)
601 {
602 	struct se_lun_acl *lacl;
603 
604 	if (strlen(nacl->initiatorname) >= TRANSPORT_IQN_LEN) {
605 		pr_err("%s InitiatorName exceeds maximum size.\n",
606 			tpg->se_tpg_tfo->get_fabric_name());
607 		*ret = -EOVERFLOW;
608 		return NULL;
609 	}
610 	lacl = kzalloc(sizeof(struct se_lun_acl), GFP_KERNEL);
611 	if (!lacl) {
612 		pr_err("Unable to allocate memory for struct se_lun_acl.\n");
613 		*ret = -ENOMEM;
614 		return NULL;
615 	}
616 
617 	lacl->mapped_lun = mapped_lun;
618 	lacl->se_lun_nacl = nacl;
619 
620 	return lacl;
621 }
622 
623 int core_dev_add_initiator_node_lun_acl(
624 	struct se_portal_group *tpg,
625 	struct se_lun_acl *lacl,
626 	struct se_lun *lun,
627 	bool lun_access_ro)
628 {
629 	struct se_node_acl *nacl = lacl->se_lun_nacl;
630 	/*
631 	 * rcu_dereference_raw protected by se_lun->lun_group symlink
632 	 * reference to se_device->dev_group.
633 	 */
634 	struct se_device *dev = rcu_dereference_raw(lun->lun_se_dev);
635 
636 	if (!nacl)
637 		return -EINVAL;
638 
639 	if (lun->lun_access_ro)
640 		lun_access_ro = true;
641 
642 	lacl->se_lun = lun;
643 
644 	if (core_enable_device_list_for_node(lun, lacl, lacl->mapped_lun,
645 			lun_access_ro, nacl, tpg) < 0)
646 		return -EINVAL;
647 
648 	pr_debug("%s_TPG[%hu]_LUN[%llu->%llu] - Added %s ACL for "
649 		" InitiatorNode: %s\n", tpg->se_tpg_tfo->get_fabric_name(),
650 		tpg->se_tpg_tfo->tpg_get_tag(tpg), lun->unpacked_lun, lacl->mapped_lun,
651 		lun_access_ro ? "RO" : "RW",
652 		nacl->initiatorname);
653 	/*
654 	 * Check to see if there are any existing persistent reservation APTPL
655 	 * pre-registrations that need to be enabled for this LUN ACL..
656 	 */
657 	core_scsi3_check_aptpl_registration(dev, tpg, lun, nacl,
658 					    lacl->mapped_lun);
659 	return 0;
660 }
661 
662 int core_dev_del_initiator_node_lun_acl(
663 	struct se_lun *lun,
664 	struct se_lun_acl *lacl)
665 {
666 	struct se_portal_group *tpg = lun->lun_tpg;
667 	struct se_node_acl *nacl;
668 	struct se_dev_entry *deve;
669 
670 	nacl = lacl->se_lun_nacl;
671 	if (!nacl)
672 		return -EINVAL;
673 
674 	mutex_lock(&nacl->lun_entry_mutex);
675 	deve = target_nacl_find_deve(nacl, lacl->mapped_lun);
676 	if (deve)
677 		core_disable_device_list_for_node(lun, deve, nacl, tpg);
678 	mutex_unlock(&nacl->lun_entry_mutex);
679 
680 	pr_debug("%s_TPG[%hu]_LUN[%llu] - Removed ACL for"
681 		" InitiatorNode: %s Mapped LUN: %llu\n",
682 		tpg->se_tpg_tfo->get_fabric_name(),
683 		tpg->se_tpg_tfo->tpg_get_tag(tpg), lun->unpacked_lun,
684 		nacl->initiatorname, lacl->mapped_lun);
685 
686 	return 0;
687 }
688 
689 void core_dev_free_initiator_node_lun_acl(
690 	struct se_portal_group *tpg,
691 	struct se_lun_acl *lacl)
692 {
693 	pr_debug("%s_TPG[%hu] - Freeing ACL for %s InitiatorNode: %s"
694 		" Mapped LUN: %llu\n", tpg->se_tpg_tfo->get_fabric_name(),
695 		tpg->se_tpg_tfo->tpg_get_tag(tpg),
696 		tpg->se_tpg_tfo->get_fabric_name(),
697 		lacl->se_lun_nacl->initiatorname, lacl->mapped_lun);
698 
699 	kfree(lacl);
700 }
701 
702 static void scsi_dump_inquiry(struct se_device *dev)
703 {
704 	struct t10_wwn *wwn = &dev->t10_wwn;
705 	char buf[17];
706 	int i, device_type;
707 	/*
708 	 * Print Linux/SCSI style INQUIRY formatting to the kernel ring buffer
709 	 */
710 	for (i = 0; i < 8; i++)
711 		if (wwn->vendor[i] >= 0x20)
712 			buf[i] = wwn->vendor[i];
713 		else
714 			buf[i] = ' ';
715 	buf[i] = '\0';
716 	pr_debug("  Vendor: %s\n", buf);
717 
718 	for (i = 0; i < 16; i++)
719 		if (wwn->model[i] >= 0x20)
720 			buf[i] = wwn->model[i];
721 		else
722 			buf[i] = ' ';
723 	buf[i] = '\0';
724 	pr_debug("  Model: %s\n", buf);
725 
726 	for (i = 0; i < 4; i++)
727 		if (wwn->revision[i] >= 0x20)
728 			buf[i] = wwn->revision[i];
729 		else
730 			buf[i] = ' ';
731 	buf[i] = '\0';
732 	pr_debug("  Revision: %s\n", buf);
733 
734 	device_type = dev->transport->get_device_type(dev);
735 	pr_debug("  Type:   %s ", scsi_device_type(device_type));
736 }
737 
738 struct se_device *target_alloc_device(struct se_hba *hba, const char *name)
739 {
740 	struct se_device *dev;
741 	struct se_lun *xcopy_lun;
742 
743 	dev = hba->backend->ops->alloc_device(hba, name);
744 	if (!dev)
745 		return NULL;
746 
747 	dev->dev_link_magic = SE_DEV_LINK_MAGIC;
748 	dev->se_hba = hba;
749 	dev->transport = hba->backend->ops;
750 	dev->prot_length = sizeof(struct t10_pi_tuple);
751 	dev->hba_index = hba->hba_index;
752 
753 	INIT_LIST_HEAD(&dev->dev_list);
754 	INIT_LIST_HEAD(&dev->dev_sep_list);
755 	INIT_LIST_HEAD(&dev->dev_tmr_list);
756 	INIT_LIST_HEAD(&dev->delayed_cmd_list);
757 	INIT_LIST_HEAD(&dev->state_list);
758 	INIT_LIST_HEAD(&dev->qf_cmd_list);
759 	INIT_LIST_HEAD(&dev->g_dev_node);
760 	spin_lock_init(&dev->execute_task_lock);
761 	spin_lock_init(&dev->delayed_cmd_lock);
762 	spin_lock_init(&dev->dev_reservation_lock);
763 	spin_lock_init(&dev->se_port_lock);
764 	spin_lock_init(&dev->se_tmr_lock);
765 	spin_lock_init(&dev->qf_cmd_lock);
766 	sema_init(&dev->caw_sem, 1);
767 	INIT_LIST_HEAD(&dev->t10_wwn.t10_vpd_list);
768 	spin_lock_init(&dev->t10_wwn.t10_vpd_lock);
769 	INIT_LIST_HEAD(&dev->t10_pr.registration_list);
770 	INIT_LIST_HEAD(&dev->t10_pr.aptpl_reg_list);
771 	spin_lock_init(&dev->t10_pr.registration_lock);
772 	spin_lock_init(&dev->t10_pr.aptpl_reg_lock);
773 	INIT_LIST_HEAD(&dev->t10_alua.tg_pt_gps_list);
774 	spin_lock_init(&dev->t10_alua.tg_pt_gps_lock);
775 	INIT_LIST_HEAD(&dev->t10_alua.lba_map_list);
776 	spin_lock_init(&dev->t10_alua.lba_map_lock);
777 
778 	dev->t10_wwn.t10_dev = dev;
779 	dev->t10_alua.t10_dev = dev;
780 
781 	dev->dev_attrib.da_dev = dev;
782 	dev->dev_attrib.emulate_model_alias = DA_EMULATE_MODEL_ALIAS;
783 	dev->dev_attrib.emulate_dpo = 1;
784 	dev->dev_attrib.emulate_fua_write = 1;
785 	dev->dev_attrib.emulate_fua_read = 1;
786 	dev->dev_attrib.emulate_write_cache = DA_EMULATE_WRITE_CACHE;
787 	dev->dev_attrib.emulate_ua_intlck_ctrl = DA_EMULATE_UA_INTLLCK_CTRL;
788 	dev->dev_attrib.emulate_tas = DA_EMULATE_TAS;
789 	dev->dev_attrib.emulate_tpu = DA_EMULATE_TPU;
790 	dev->dev_attrib.emulate_tpws = DA_EMULATE_TPWS;
791 	dev->dev_attrib.emulate_caw = DA_EMULATE_CAW;
792 	dev->dev_attrib.emulate_3pc = DA_EMULATE_3PC;
793 	dev->dev_attrib.pi_prot_type = TARGET_DIF_TYPE0_PROT;
794 	dev->dev_attrib.enforce_pr_isids = DA_ENFORCE_PR_ISIDS;
795 	dev->dev_attrib.force_pr_aptpl = DA_FORCE_PR_APTPL;
796 	dev->dev_attrib.is_nonrot = DA_IS_NONROT;
797 	dev->dev_attrib.emulate_rest_reord = DA_EMULATE_REST_REORD;
798 	dev->dev_attrib.max_unmap_lba_count = DA_MAX_UNMAP_LBA_COUNT;
799 	dev->dev_attrib.max_unmap_block_desc_count =
800 		DA_MAX_UNMAP_BLOCK_DESC_COUNT;
801 	dev->dev_attrib.unmap_granularity = DA_UNMAP_GRANULARITY_DEFAULT;
802 	dev->dev_attrib.unmap_granularity_alignment =
803 				DA_UNMAP_GRANULARITY_ALIGNMENT_DEFAULT;
804 	dev->dev_attrib.unmap_zeroes_data =
805 				DA_UNMAP_ZEROES_DATA_DEFAULT;
806 	dev->dev_attrib.max_write_same_len = DA_MAX_WRITE_SAME_LEN;
807 
808 	xcopy_lun = &dev->xcopy_lun;
809 	rcu_assign_pointer(xcopy_lun->lun_se_dev, dev);
810 	init_completion(&xcopy_lun->lun_ref_comp);
811 	INIT_LIST_HEAD(&xcopy_lun->lun_deve_list);
812 	INIT_LIST_HEAD(&xcopy_lun->lun_dev_link);
813 	mutex_init(&xcopy_lun->lun_tg_pt_md_mutex);
814 	xcopy_lun->lun_tpg = &xcopy_pt_tpg;
815 
816 	return dev;
817 }
818 
819 /*
820  * Check if the underlying struct block_device request_queue supports
821  * the QUEUE_FLAG_DISCARD bit for UNMAP/WRITE_SAME in SCSI + TRIM
822  * in ATA and we need to set TPE=1
823  */
824 bool target_configure_unmap_from_queue(struct se_dev_attrib *attrib,
825 				       struct request_queue *q)
826 {
827 	int block_size = queue_logical_block_size(q);
828 
829 	if (!blk_queue_discard(q))
830 		return false;
831 
832 	attrib->max_unmap_lba_count =
833 		q->limits.max_discard_sectors >> (ilog2(block_size) - 9);
834 	/*
835 	 * Currently hardcoded to 1 in Linux/SCSI code..
836 	 */
837 	attrib->max_unmap_block_desc_count = 1;
838 	attrib->unmap_granularity = q->limits.discard_granularity / block_size;
839 	attrib->unmap_granularity_alignment = q->limits.discard_alignment /
840 								block_size;
841 	attrib->unmap_zeroes_data = q->limits.discard_zeroes_data;
842 	return true;
843 }
844 EXPORT_SYMBOL(target_configure_unmap_from_queue);
845 
846 /*
847  * Convert from blocksize advertised to the initiator to the 512 byte
848  * units unconditionally used by the Linux block layer.
849  */
850 sector_t target_to_linux_sector(struct se_device *dev, sector_t lb)
851 {
852 	switch (dev->dev_attrib.block_size) {
853 	case 4096:
854 		return lb << 3;
855 	case 2048:
856 		return lb << 2;
857 	case 1024:
858 		return lb << 1;
859 	default:
860 		return lb;
861 	}
862 }
863 EXPORT_SYMBOL(target_to_linux_sector);
864 
865 int target_configure_device(struct se_device *dev)
866 {
867 	struct se_hba *hba = dev->se_hba;
868 	int ret;
869 
870 	if (dev->dev_flags & DF_CONFIGURED) {
871 		pr_err("se_dev->se_dev_ptr already set for storage"
872 				" object\n");
873 		return -EEXIST;
874 	}
875 
876 	ret = dev->transport->configure_device(dev);
877 	if (ret)
878 		goto out;
879 	/*
880 	 * XXX: there is not much point to have two different values here..
881 	 */
882 	dev->dev_attrib.block_size = dev->dev_attrib.hw_block_size;
883 	dev->dev_attrib.queue_depth = dev->dev_attrib.hw_queue_depth;
884 
885 	/*
886 	 * Align max_hw_sectors down to PAGE_SIZE I/O transfers
887 	 */
888 	dev->dev_attrib.hw_max_sectors =
889 		se_dev_align_max_sectors(dev->dev_attrib.hw_max_sectors,
890 					 dev->dev_attrib.hw_block_size);
891 	dev->dev_attrib.optimal_sectors = dev->dev_attrib.hw_max_sectors;
892 
893 	dev->dev_index = scsi_get_new_index(SCSI_DEVICE_INDEX);
894 	dev->creation_time = get_jiffies_64();
895 
896 	ret = core_setup_alua(dev);
897 	if (ret)
898 		goto out;
899 
900 	/*
901 	 * Startup the struct se_device processing thread
902 	 */
903 	dev->tmr_wq = alloc_workqueue("tmr-%s", WQ_MEM_RECLAIM | WQ_UNBOUND, 1,
904 				      dev->transport->name);
905 	if (!dev->tmr_wq) {
906 		pr_err("Unable to create tmr workqueue for %s\n",
907 			dev->transport->name);
908 		ret = -ENOMEM;
909 		goto out_free_alua;
910 	}
911 
912 	/*
913 	 * Setup work_queue for QUEUE_FULL
914 	 */
915 	INIT_WORK(&dev->qf_work_queue, target_qf_do_work);
916 
917 	/*
918 	 * Preload the initial INQUIRY const values if we are doing
919 	 * anything virtual (IBLOCK, FILEIO, RAMDISK), but not for TCM/pSCSI
920 	 * passthrough because this is being provided by the backend LLD.
921 	 */
922 	if (!(dev->transport->transport_flags & TRANSPORT_FLAG_PASSTHROUGH)) {
923 		strncpy(&dev->t10_wwn.vendor[0], "LIO-ORG", 8);
924 		strncpy(&dev->t10_wwn.model[0],
925 			dev->transport->inquiry_prod, 16);
926 		strncpy(&dev->t10_wwn.revision[0],
927 			dev->transport->inquiry_rev, 4);
928 	}
929 
930 	scsi_dump_inquiry(dev);
931 
932 	spin_lock(&hba->device_lock);
933 	hba->dev_count++;
934 	spin_unlock(&hba->device_lock);
935 
936 	mutex_lock(&g_device_mutex);
937 	list_add_tail(&dev->g_dev_node, &g_device_list);
938 	mutex_unlock(&g_device_mutex);
939 
940 	dev->dev_flags |= DF_CONFIGURED;
941 
942 	return 0;
943 
944 out_free_alua:
945 	core_alua_free_lu_gp_mem(dev);
946 out:
947 	se_release_vpd_for_dev(dev);
948 	return ret;
949 }
950 
951 void target_free_device(struct se_device *dev)
952 {
953 	struct se_hba *hba = dev->se_hba;
954 
955 	WARN_ON(!list_empty(&dev->dev_sep_list));
956 
957 	if (dev->dev_flags & DF_CONFIGURED) {
958 		destroy_workqueue(dev->tmr_wq);
959 
960 		mutex_lock(&g_device_mutex);
961 		list_del(&dev->g_dev_node);
962 		mutex_unlock(&g_device_mutex);
963 
964 		spin_lock(&hba->device_lock);
965 		hba->dev_count--;
966 		spin_unlock(&hba->device_lock);
967 	}
968 
969 	core_alua_free_lu_gp_mem(dev);
970 	core_alua_set_lba_map(dev, NULL, 0, 0);
971 	core_scsi3_free_all_registrations(dev);
972 	se_release_vpd_for_dev(dev);
973 
974 	if (dev->transport->free_prot)
975 		dev->transport->free_prot(dev);
976 
977 	dev->transport->free_device(dev);
978 }
979 
980 int core_dev_setup_virtual_lun0(void)
981 {
982 	struct se_hba *hba;
983 	struct se_device *dev;
984 	char buf[] = "rd_pages=8,rd_nullio=1";
985 	int ret;
986 
987 	hba = core_alloc_hba("rd_mcp", 0, HBA_FLAGS_INTERNAL_USE);
988 	if (IS_ERR(hba))
989 		return PTR_ERR(hba);
990 
991 	dev = target_alloc_device(hba, "virt_lun0");
992 	if (!dev) {
993 		ret = -ENOMEM;
994 		goto out_free_hba;
995 	}
996 
997 	hba->backend->ops->set_configfs_dev_params(dev, buf, sizeof(buf));
998 
999 	ret = target_configure_device(dev);
1000 	if (ret)
1001 		goto out_free_se_dev;
1002 
1003 	lun0_hba = hba;
1004 	g_lun0_dev = dev;
1005 	return 0;
1006 
1007 out_free_se_dev:
1008 	target_free_device(dev);
1009 out_free_hba:
1010 	core_delete_hba(hba);
1011 	return ret;
1012 }
1013 
1014 
1015 void core_dev_release_virtual_lun0(void)
1016 {
1017 	struct se_hba *hba = lun0_hba;
1018 
1019 	if (!hba)
1020 		return;
1021 
1022 	if (g_lun0_dev)
1023 		target_free_device(g_lun0_dev);
1024 	core_delete_hba(hba);
1025 }
1026 
1027 /*
1028  * Common CDB parsing for kernel and user passthrough.
1029  */
1030 sense_reason_t
1031 passthrough_parse_cdb(struct se_cmd *cmd,
1032 	sense_reason_t (*exec_cmd)(struct se_cmd *cmd))
1033 {
1034 	unsigned char *cdb = cmd->t_task_cdb;
1035 
1036 	/*
1037 	 * Clear a lun set in the cdb if the initiator talking to use spoke
1038 	 * and old standards version, as we can't assume the underlying device
1039 	 * won't choke up on it.
1040 	 */
1041 	switch (cdb[0]) {
1042 	case READ_10: /* SBC - RDProtect */
1043 	case READ_12: /* SBC - RDProtect */
1044 	case READ_16: /* SBC - RDProtect */
1045 	case SEND_DIAGNOSTIC: /* SPC - SELF-TEST Code */
1046 	case VERIFY: /* SBC - VRProtect */
1047 	case VERIFY_16: /* SBC - VRProtect */
1048 	case WRITE_VERIFY: /* SBC - VRProtect */
1049 	case WRITE_VERIFY_12: /* SBC - VRProtect */
1050 	case MAINTENANCE_IN: /* SPC - Parameter Data Format for SA RTPG */
1051 		break;
1052 	default:
1053 		cdb[1] &= 0x1f; /* clear logical unit number */
1054 		break;
1055 	}
1056 
1057 	/*
1058 	 * For REPORT LUNS we always need to emulate the response, for everything
1059 	 * else, pass it up.
1060 	 */
1061 	if (cdb[0] == REPORT_LUNS) {
1062 		cmd->execute_cmd = spc_emulate_report_luns;
1063 		return TCM_NO_SENSE;
1064 	}
1065 
1066 	/* Set DATA_CDB flag for ops that should have it */
1067 	switch (cdb[0]) {
1068 	case READ_6:
1069 	case READ_10:
1070 	case READ_12:
1071 	case READ_16:
1072 	case WRITE_6:
1073 	case WRITE_10:
1074 	case WRITE_12:
1075 	case WRITE_16:
1076 	case WRITE_VERIFY:
1077 	case WRITE_VERIFY_12:
1078 	case 0x8e: /* WRITE_VERIFY_16 */
1079 	case COMPARE_AND_WRITE:
1080 	case XDWRITEREAD_10:
1081 		cmd->se_cmd_flags |= SCF_SCSI_DATA_CDB;
1082 		break;
1083 	case VARIABLE_LENGTH_CMD:
1084 		switch (get_unaligned_be16(&cdb[8])) {
1085 		case READ_32:
1086 		case WRITE_32:
1087 		case 0x0c: /* WRITE_VERIFY_32 */
1088 		case XDWRITEREAD_32:
1089 			cmd->se_cmd_flags |= SCF_SCSI_DATA_CDB;
1090 			break;
1091 		}
1092 	}
1093 
1094 	cmd->execute_cmd = exec_cmd;
1095 
1096 	return TCM_NO_SENSE;
1097 }
1098 EXPORT_SYMBOL(passthrough_parse_cdb);
1099