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