xref: /dragonfly/usr.sbin/fstyp/hammer2.c (revision 5dade8cf)
1 /*-
2  * Copyright (c) 2017-2019 The DragonFly Project
3  * Copyright (c) 2017-2019 Tomohiro Kusumi <tkusumi@netbsd.org>
4  * All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
16  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
19  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25  * SUCH DAMAGE.
26  */
27 
28 #include <stdio.h>
29 #include <stdlib.h>
30 #include <stdbool.h>
31 #include <string.h>
32 #include <err.h>
33 #include <assert.h>
34 #include <vfs/hammer2/hammer2_disk.h>
35 
36 #include "fstyp.h"
37 
38 static hammer2_volume_data_t*
39 read_voldata(FILE *fp)
40 {
41 	hammer2_volume_data_t *voldata;
42 
43 	voldata = read_buf(fp, 0, sizeof(*voldata));
44 	if (voldata == NULL)
45 		err(1, "failed to read volume data");
46 
47 	return (voldata);
48 }
49 
50 static int
51 test_voldata(const hammer2_volume_data_t *voldata)
52 {
53 	if (voldata->magic != HAMMER2_VOLUME_ID_HBO &&
54 	    voldata->magic != HAMMER2_VOLUME_ID_ABO)
55 		return (1);
56 
57 	return (0);
58 }
59 
60 static hammer2_media_data_t*
61 read_media(FILE *fp, const hammer2_blockref_t *bref, size_t *media_bytes)
62 {
63 	hammer2_media_data_t *media;
64 	hammer2_off_t io_off, io_base;
65 	size_t bytes, io_bytes, boff;
66 
67 	bytes = (bref->data_off & HAMMER2_OFF_MASK_RADIX);
68 	if (bytes)
69 		bytes = (size_t)1 << bytes;
70 	*media_bytes = bytes;
71 
72 	if (!bytes) {
73 		warnx("blockref has no data");
74 		return (NULL);
75 	}
76 
77 	io_off = bref->data_off & ~HAMMER2_OFF_MASK_RADIX;
78 	io_base = io_off & ~(hammer2_off_t)(HAMMER2_LBUFSIZE - 1);
79 	boff = io_off - io_base;
80 
81 	io_bytes = HAMMER2_LBUFSIZE;
82 	while (io_bytes + boff < bytes)
83 		io_bytes <<= 1;
84 
85 	if (io_bytes > sizeof(hammer2_media_data_t)) {
86 		warnx("invalid I/O bytes");
87 		return (NULL);
88 	}
89 
90 	if (fseek(fp, io_base, SEEK_SET) == -1) {
91 		warnx("failed to seek media");
92 		return (NULL);
93 	}
94 	media = read_buf(fp, io_base, io_bytes);
95 	if (media == NULL) {
96 		warnx("failed to read media");
97 		return (NULL);
98 	}
99 	if (boff)
100 		memcpy(media, (char *)media + boff, bytes);
101 
102 	return (media);
103 }
104 
105 static int
106 find_pfs(FILE *fp, const hammer2_blockref_t *bref, const char *pfs, bool *res)
107 {
108 	hammer2_media_data_t *media;
109 	hammer2_inode_data_t ipdata;
110 	hammer2_blockref_t *bscan;
111 	size_t bytes;
112 	int i, bcount;
113 
114 	media = read_media(fp, bref, &bytes);
115 	if (media == NULL)
116 		return (-1);
117 
118 	switch (bref->type) {
119 	case HAMMER2_BREF_TYPE_INODE:
120 		ipdata = media->ipdata;
121 		if (ipdata.meta.pfs_type == HAMMER2_PFSTYPE_SUPROOT) {
122 			bscan = &ipdata.u.blockset.blockref[0];
123 			bcount = HAMMER2_SET_COUNT;
124 		} else {
125 			bscan = NULL;
126 			bcount = 0;
127 			if (ipdata.meta.op_flags & HAMMER2_OPFLAG_PFSROOT) {
128 				if (memchr(ipdata.filename, 0,
129 				    sizeof(ipdata.filename))) {
130 					if (!strcmp(
131 					    (const char*)ipdata.filename, pfs))
132 						*res = true;
133 				} else {
134 					if (strlen(pfs) > 0 &&
135 					    !memcmp(ipdata.filename, pfs,
136 					    strlen(pfs)))
137 						*res = true;
138 				}
139 			} else
140 				assert(0);
141 		}
142 		break;
143 	case HAMMER2_BREF_TYPE_INDIRECT:
144 		bscan = &media->npdata[0];
145 		bcount = bytes / sizeof(hammer2_blockref_t);
146 		break;
147 	default:
148 		bscan = NULL;
149 		bcount = 0;
150 		break;
151 	}
152 
153 	for (i = 0; i < bcount; ++i) {
154 		if (bscan[i].type != HAMMER2_BREF_TYPE_EMPTY) {
155 			if (find_pfs(fp, &bscan[i], pfs, res) == -1) {
156 				free(media);
157 				return (-1);
158 			}
159 		}
160 	}
161 	free(media);
162 
163 	return (0);
164 }
165 
166 static char*
167 extract_device_name(const char *devpath)
168 {
169 	char *p, *head;
170 
171 	if (!devpath)
172 		return NULL;
173 
174 	p = strdup(devpath);
175 	head = p;
176 
177 	p = strchr(p, '@');
178 	if (p)
179 		*p = 0;
180 
181 	p = strrchr(head, '/');
182 	if (p) {
183 		p++;
184 		if (*p == 0) {
185 			free(head);
186 			return NULL;
187 		}
188 		p = strdup(p);
189 		free(head);
190 		return p;
191 	}
192 
193 	return head;
194 }
195 
196 static int
197 read_label(FILE *fp, char *label, size_t size, const char *devpath)
198 {
199 	hammer2_blockref_t broot, best, *bref;
200 	hammer2_media_data_t *vols[HAMMER2_NUM_VOLHDRS], *media;
201 	size_t bytes;
202 	bool res = false;
203 	int i, best_i, error = 1;
204 	const char *pfs;
205 	char *devname;
206 
207 	best_i = -1;
208 	memset(&best, 0, sizeof(best));
209 
210 	for (i = 0; i < HAMMER2_NUM_VOLHDRS; i++) {
211 		memset(&broot, 0, sizeof(broot));
212 		broot.type = HAMMER2_BREF_TYPE_VOLUME;
213 		broot.data_off = (i * HAMMER2_ZONE_BYTES64) | HAMMER2_PBUFRADIX;
214 		vols[i] = read_buf(fp, broot.data_off & ~HAMMER2_OFF_MASK_RADIX,
215 		    sizeof(*vols[i]));
216 		broot.mirror_tid = vols[i]->voldata.mirror_tid;
217 		if (best_i < 0 || best.mirror_tid < broot.mirror_tid) {
218 			best_i = i;
219 			best = broot;
220 		}
221 	}
222 
223 	bref = &vols[best_i]->voldata.sroot_blockset.blockref[0];
224 	if (bref->type != HAMMER2_BREF_TYPE_INODE) {
225 		warnx("blockref type is not inode");
226 		goto fail;
227 	}
228 
229 	media = read_media(fp, bref, &bytes);
230 	if (media == NULL) {
231 		goto fail;
232 	}
233 
234 	/*
235 	 * fstyp_function in DragonFly takes an additional devpath argument
236 	 * which doesn't exist in FreeBSD and NetBSD.
237 	 */
238 #ifdef HAS_DEVPATH
239 	pfs = strchr(devpath, '@');
240 	if (!pfs) {
241 		assert(strlen(devpath));
242 		switch (devpath[strlen(devpath) - 1]) {
243 		case 'a':
244 			pfs = "BOOT";
245 			break;
246 		case 'd':
247 			pfs = "ROOT";
248 			break;
249 		default:
250 			pfs = "DATA";
251 			break;
252 		}
253 	} else
254 		pfs++;
255 
256 	if (strlen(pfs) > HAMMER2_INODE_MAXNAME) {
257 		goto fail;
258 	}
259 	devname = extract_device_name(devpath);
260 #else
261 	pfs = "";
262 	devname = extract_device_name(NULL);
263 	assert(!devname);
264 #endif
265 
266 	/* Add device name to help support multiple autofs -media mounts. */
267 	if (find_pfs(fp, bref, pfs, &res) == 0 && res) {
268 		if (devname)
269 			snprintf(label, size, "%s_%s", pfs, devname);
270 		else
271 			strlcpy(label, pfs, size);
272 	} else {
273 		memset(label, 0, size);
274 		memcpy(label, media->ipdata.filename,
275 		    sizeof(media->ipdata.filename));
276 		if (devname) {
277 			strlcat(label, "_", size);
278 			strlcat(label, devname, size);
279 		}
280 	}
281 	if (devname)
282 		free(devname);
283 	free(media);
284 	error = 0;
285 fail:
286 	for (i = 0; i < HAMMER2_NUM_VOLHDRS; i++)
287 		free(vols[i]);
288 
289 	return (error);
290 }
291 
292 int
293 fstyp_hammer2(FILE *fp, char *label, size_t size, const char *devpath)
294 {
295 	hammer2_volume_data_t *voldata;
296 	int error = 1;
297 
298 	voldata = read_voldata(fp);
299 	if (test_voldata(voldata))
300 		goto fail;
301 
302 	error = read_label(fp, label, size, devpath);
303 fail:
304 	free(voldata);
305 	return (error);
306 }
307