xref: /spdk/lib/scsi/scsi.c (revision b58a5d73ef70b9458ef589f5858c2a72c1f8e47c)
1 /*-
2  *   BSD LICENSE
3  *
4  *   Copyright (C) 2008-2012 Daisuke Aoyama <aoyama@peach.ne.jp>.
5  *   Copyright (c) Intel Corporation.
6  *   All rights reserved.
7  *
8  *   Redistribution and use in source and binary forms, with or without
9  *   modification, are permitted provided that the following conditions
10  *   are met:
11  *
12  *     * Redistributions of source code must retain the above copyright
13  *       notice, this list of conditions and the following disclaimer.
14  *     * Redistributions in binary form must reproduce the above copyright
15  *       notice, this list of conditions and the following disclaimer in
16  *       the documentation and/or other materials provided with the
17  *       distribution.
18  *     * Neither the name of Intel Corporation nor the names of its
19  *       contributors may be used to endorse or promote products derived
20  *       from this software without specific prior written permission.
21  *
22  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
25  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
26  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
27  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
28  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
29  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
30  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
31  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
32  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33  */
34 
35 #include "scsi_internal.h"
36 
37 #include "spdk/conf.h"
38 
39 #include "spdk_internal/event.h"
40 
41 #define DEFAULT_MAX_UNMAP_LBA_COUNT			4194304
42 #define DEFAULT_MAX_UNMAP_BLOCK_DESCRIPTOR_COUNT	1
43 #define DEFAULT_OPTIMAL_UNMAP_GRANULARITY		0
44 #define DEFAULT_UNMAP_GRANULARITY_ALIGNMENT		0
45 #define DEFAULT_UGAVALID				0
46 #define DEFAULT_MAX_WRITE_SAME_LENGTH			512
47 
48 struct spdk_scsi_globals g_spdk_scsi;
49 
50 static void
51 spdk_set_default_scsi_parameters(void)
52 {
53 	g_spdk_scsi.scsi_params.max_unmap_lba_count = DEFAULT_MAX_UNMAP_LBA_COUNT;
54 	g_spdk_scsi.scsi_params.max_unmap_block_descriptor_count =
55 		DEFAULT_MAX_UNMAP_BLOCK_DESCRIPTOR_COUNT;
56 	g_spdk_scsi.scsi_params.optimal_unmap_granularity =
57 		DEFAULT_OPTIMAL_UNMAP_GRANULARITY;
58 	g_spdk_scsi.scsi_params.unmap_granularity_alignment =
59 		DEFAULT_UNMAP_GRANULARITY_ALIGNMENT;
60 	g_spdk_scsi.scsi_params.ugavalid = DEFAULT_UGAVALID;
61 	g_spdk_scsi.scsi_params.max_write_same_length = DEFAULT_MAX_WRITE_SAME_LENGTH;
62 }
63 
64 static int
65 spdk_read_config_scsi_parameters(void)
66 {
67 	struct spdk_conf_section *sp;
68 	const char *val;
69 
70 	sp = spdk_conf_find_section(NULL, "Scsi");
71 	if (sp == NULL) {
72 		spdk_set_default_scsi_parameters();
73 		return 0;
74 	}
75 
76 	val = spdk_conf_section_get_val(sp, "MaxUnmapLbaCount");
77 	g_spdk_scsi.scsi_params.max_unmap_lba_count = (val == NULL) ?
78 			DEFAULT_MAX_UNMAP_LBA_COUNT : strtoul(val, NULL, 10);
79 
80 	val = spdk_conf_section_get_val(sp, "MaxUnmapBlockDescriptorCount");
81 	g_spdk_scsi.scsi_params.max_unmap_block_descriptor_count = (val == NULL) ?
82 			DEFAULT_MAX_UNMAP_BLOCK_DESCRIPTOR_COUNT : strtoul(val, NULL, 10);
83 	val = spdk_conf_section_get_val(sp, "OptimalUnmapGranularity");
84 	g_spdk_scsi.scsi_params.optimal_unmap_granularity = (val == NULL) ?
85 			DEFAULT_OPTIMAL_UNMAP_GRANULARITY : strtoul(val, NULL, 10);
86 
87 	val = spdk_conf_section_get_val(sp, "UnmapGranularityAlignment");
88 	g_spdk_scsi.scsi_params.unmap_granularity_alignment = (val == NULL) ?
89 			DEFAULT_UNMAP_GRANULARITY_ALIGNMENT : strtoul(val, NULL, 10);
90 
91 	val = spdk_conf_section_get_val(sp, "Ugavalid");
92 	if (val == NULL) {
93 		g_spdk_scsi.scsi_params.ugavalid = DEFAULT_UGAVALID;
94 	} else if (strcasecmp(val, "Yes") == 0) {
95 		g_spdk_scsi.scsi_params.ugavalid = 1;
96 	} else if (strcasecmp(val, "No") == 0) {
97 		g_spdk_scsi.scsi_params.ugavalid = 0;
98 	} else {
99 		SPDK_ERRLOG("unknown value %s\n", val);
100 		return -1;
101 	}
102 
103 	val = spdk_conf_section_get_val(sp, "MaxWriteSameLength");
104 	g_spdk_scsi.scsi_params.max_write_same_length = (val == NULL) ?
105 			DEFAULT_MAX_WRITE_SAME_LENGTH : strtoul(val, NULL, 10);
106 
107 	return 0;
108 }
109 
110 static int
111 spdk_scsi_subsystem_init(void)
112 {
113 	int rc;
114 
115 	rc = pthread_mutex_init(&g_spdk_scsi.mutex, NULL);
116 	if (rc != 0) {
117 		SPDK_ERRLOG("mutex_init() failed\n");
118 		return -1;
119 	}
120 
121 	rc = spdk_read_config_scsi_parameters();
122 	if (rc < 0) {
123 		SPDK_ERRLOG("spdk_scsi_parameters() failed\n");
124 		return -1;
125 	}
126 
127 	return rc;
128 }
129 
130 static int
131 spdk_scsi_subsystem_fini(void)
132 {
133 	pthread_mutex_destroy(&g_spdk_scsi.mutex);
134 	return 0;
135 }
136 
137 SPDK_TRACE_REGISTER_FN(scsi_trace)
138 {
139 	spdk_trace_register_owner(OWNER_SCSI_DEV, 'd');
140 	spdk_trace_register_object(OBJECT_SCSI_TASK, 't');
141 	spdk_trace_register_description("SCSI TASK DONE", "", TRACE_SCSI_TASK_DONE,
142 					OWNER_SCSI_DEV, OBJECT_SCSI_TASK, 0, 0, 0, "");
143 	spdk_trace_register_description("SCSI TASK START", "", TRACE_SCSI_TASK_START,
144 					OWNER_SCSI_DEV, OBJECT_SCSI_TASK, 0, 0, 0, "");
145 }
146 
147 SPDK_SUBSYSTEM_REGISTER(scsi, spdk_scsi_subsystem_init, spdk_scsi_subsystem_fini, NULL)
148 SPDK_SUBSYSTEM_DEPEND(scsi, bdev)
149 
150 SPDK_LOG_REGISTER_TRACE_FLAG("scsi", SPDK_TRACE_SCSI)
151