xref: /netbsd-src/sys/dev/dm/dm_target_linear.c (revision 7330f729ccf0bd976a06f95fad452fe774fc7fd1)
1 /*        $NetBSD: dm_target_linear.c,v 1.18 2019/10/15 00:13:53 chs Exp $      */
2 
3 /*
4  * Copyright (c) 2008 The NetBSD Foundation, Inc.
5  * All rights reserved.
6  *
7  * This code is derived from software contributed to The NetBSD Foundation
8  * by Adam Hamsik.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29  * POSSIBILITY OF SUCH DAMAGE.
30  */
31 #include <sys/cdefs.h>
32 __KERNEL_RCSID(0, "$NetBSD: dm_target_linear.c,v 1.18 2019/10/15 00:13:53 chs Exp $");
33 
34 /*
35  * This file implements initial version of device-mapper dklinear target.
36  */
37 
38 #include <sys/types.h>
39 #include <sys/param.h>
40 
41 #include <sys/buf.h>
42 #include <sys/kmem.h>
43 #include <sys/vnode.h>
44 #include <sys/lwp.h>
45 
46 #include <machine/int_fmtio.h>
47 
48 #include "dm.h"
49 
50 /*
51  * Allocate target specific config data, and link them to table.
52  * This function is called only when, flags is not READONLY and
53  * therefore we can add things to pdev list. This should not a
54  * problem because this routine is called only from dm_table_load_ioctl.
55  * @argv[0] is name,
56  * @argv[1] is physical data offset.
57  */
58 int
59 dm_target_linear_init(dm_dev_t * dmv, void **target_config, char *params)
60 {
61 	dm_target_linear_config_t *tlc;
62 	dm_pdev_t *dmp;
63 
64 	char **ap, *argv[3];
65 
66 	if (params == NULL)
67 		return EINVAL;
68 
69 	/*
70 	 * Parse a string, containing tokens delimited by white space,
71 	 * into an argument vector
72 	 */
73 	for (ap = argv; ap < &argv[2] &&
74 	    (*ap = strsep(&params, " \t")) != NULL;) {
75 		if (**ap != '\0')
76 			ap++;
77 	}
78 
79 	aprint_debug("Linear target init function called %s--%s!!\n",
80 	    argv[0], argv[1]);
81 
82 	/* Insert dmp to global pdev list */
83 	if ((dmp = dm_pdev_insert(argv[0])) == NULL)
84 		return ENOENT;
85 
86 	tlc = kmem_alloc(sizeof(dm_target_linear_config_t), KM_SLEEP);
87 	tlc->pdev = dmp;
88 	tlc->offset = 0;	/* default settings */
89 
90 	/* Check user input if it is not leave offset as 0. */
91 	tlc->offset = atoi(argv[1]);
92 
93 	*target_config = tlc;
94 
95 	dmv->dev_type = DM_LINEAR_DEV;
96 
97 	return 0;
98 }
99 
100 /*
101  * Status routine is called to get params string, which is target
102  * specific. When dm_table_status_ioctl is called with flag
103  * DM_STATUS_TABLE_FLAG I have to sent params string back.
104  */
105 char *
106 dm_target_linear_status(void *target_config)
107 {
108 	dm_target_linear_config_t *tlc;
109 	char *params;
110 	tlc = target_config;
111 
112 	aprint_debug("Linear target status function called\n");
113 
114 	params = kmem_alloc(DM_MAX_PARAMS_SIZE, KM_SLEEP);
115 	aprint_normal("%s %" PRIu64, tlc->pdev->name, tlc->offset);
116 	snprintf(params, DM_MAX_PARAMS_SIZE, "%s %" PRIu64,
117 	    tlc->pdev->name, tlc->offset);
118 
119 	return params;
120 }
121 
122 /*
123  * Do IO operation, called from dmstrategy routine.
124  */
125 int
126 dm_target_linear_strategy(dm_table_entry_t * table_en, struct buf * bp)
127 {
128 	dm_target_linear_config_t *tlc;
129 
130 	tlc = table_en->target_config;
131 
132 /*	printf("Linear target read function called %" PRIu64 "!!\n",
133 	tlc->offset);*/
134 
135 	bp->b_blkno += tlc->offset;
136 
137 	VOP_STRATEGY(tlc->pdev->pdev_vnode, bp);
138 
139 	return 0;
140 
141 }
142 
143 /*
144  * Sync underlying disk caches.
145  */
146 int
147 dm_target_linear_sync(dm_table_entry_t * table_en)
148 {
149 	int cmd;
150 	dm_target_linear_config_t *tlc;
151 
152 	tlc = table_en->target_config;
153 
154 	cmd = 1;
155 
156 	return VOP_IOCTL(tlc->pdev->pdev_vnode,  DIOCCACHESYNC, &cmd,
157 	    FREAD|FWRITE, kauth_cred_get());
158 }
159 
160 /*
161  * Destroy target specific data. Decrement table pdevs.
162  */
163 int
164 dm_target_linear_destroy(dm_table_entry_t * table_en)
165 {
166 
167 	/*
168 	 * Destroy function is called for every target even if it
169 	 * doesn't have target_config.
170 	 */
171 	if (table_en->target_config == NULL)
172 		goto out;
173 
174 	dm_target_linear_config_t *tlc = table_en->target_config;
175 	table_en->target_config = NULL;
176 
177 	/* Decrement pdev ref counter if 0 remove it */
178 	dm_pdev_decr(tlc->pdev);
179 
180 	kmem_free(tlc, sizeof(*tlc));
181 
182 out:
183 	/* Unbusy target so we can unload it */
184 	dm_target_unbusy(table_en->target);
185 	return 0;
186 }
187 
188 /* Add this target pdev dependencies to prop_array_t */
189 int
190 dm_target_linear_deps(dm_table_entry_t * table_en, prop_array_t prop_array)
191 {
192 	dm_target_linear_config_t *tlc;
193 
194 	if (table_en->target_config == NULL)
195 		return ENOENT;
196 
197 	tlc = table_en->target_config;
198 
199 	prop_array_add_uint64(prop_array,
200 	    (uint64_t) tlc->pdev->pdev_vnode->v_rdev);
201 
202 	return 0;
203 }
204 
205 /*
206  * Register upcall device.
207  * Linear target doesn't need any upcall devices but other targets like
208  * mirror, snapshot, multipath, stripe will use this functionality.
209  */
210 int
211 dm_target_linear_upcall(dm_table_entry_t * table_en, struct buf * bp)
212 {
213 	return 0;
214 }
215 
216 /*
217  * Query physical block size of this target
218  * For a linear target this is just the sector size of the underlying device
219  */
220 int
221 dm_target_linear_secsize(dm_table_entry_t * table_en, unsigned *secsizep)
222 {
223 	dm_target_linear_config_t *tlc;
224 	unsigned secsize;
225 
226 	secsize = 0;
227 
228 	tlc = table_en->target_config;
229 	if (tlc != NULL)
230 		secsize = tlc->pdev->pdev_secsize;
231 
232 	*secsizep = secsize;
233 
234 	return 0;
235 }
236 
237 /*
238  * Transform char s to uint64_t offset number.
239  */
240 uint64_t
241 atoi(const char *s)
242 {
243 	uint64_t n;
244 	n = 0;
245 
246 	while (*s != '\0') {
247 		if (!isdigit(*s))
248 			break;
249 
250 		n = (10 * n) + (*s - '0');
251 		s++;
252 	}
253 
254 	return n;
255 }
256