xref: /freebsd/stand/efi/boot1/zfs_module.c (revision 405c3050f102b8c74782f0366c8ead927bd07b68)
1 /*-
2  * Copyright (c) 2015 Eric McCorkle
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24  * SUCH DAMAGE.
25  *
26  * $FreeBSD$
27  */
28 #include <stddef.h>
29 #include <stdarg.h>
30 #include <stdbool.h>
31 #include <sys/cdefs.h>
32 #include <sys/param.h>
33 #include <sys/queue.h>
34 #include <efi.h>
35 
36 #include "boot_module.h"
37 
38 #include "libzfs.h"
39 #include "zfsimpl.c"
40 
41 static dev_info_t *devices;
42 
43 uint64_t
44 ldi_get_size(void *priv)
45 {
46 	dev_info_t *devinfo = priv;
47 
48 	return (devinfo->dev->Media->BlockSize *
49 	    (devinfo->dev->Media->LastBlock + 1));
50 }
51 
52 static int
53 vdev_read(vdev_t *vdev, void *priv, off_t off, void *buf, size_t bytes)
54 {
55 	dev_info_t *devinfo;
56 	uint64_t lba;
57 	size_t size, remainder, rb_size, blksz;
58 	char *bouncebuf = NULL, *rb_buf;
59 	EFI_STATUS status;
60 
61 	devinfo = (dev_info_t *)priv;
62 	lba = off / devinfo->dev->Media->BlockSize;
63 	remainder = off % devinfo->dev->Media->BlockSize;
64 
65 	rb_buf = buf;
66 	rb_size = bytes;
67 
68 	/*
69 	 * If we have remainder from off, we need to add remainder part.
70 	 * Since buffer must be multiple of the BlockSize, round it all up.
71 	 */
72 	size = roundup2(bytes + remainder, devinfo->dev->Media->BlockSize);
73 	blksz = size;
74 	if (remainder != 0 || size != bytes) {
75 		rb_size = devinfo->dev->Media->BlockSize;
76 		bouncebuf = malloc(rb_size);
77 		if (bouncebuf == NULL) {
78 			printf("vdev_read: out of memory\n");
79 			return (-1);
80 		}
81 		rb_buf = bouncebuf;
82 		blksz = rb_size - remainder;
83 	}
84 
85 	while (bytes > 0) {
86 		status = devinfo->dev->ReadBlocks(devinfo->dev,
87 		    devinfo->dev->Media->MediaId, lba, rb_size, rb_buf);
88 		if (EFI_ERROR(status))
89 				goto error;
90 		if (bytes < blksz)
91 			blksz = bytes;
92 		if (bouncebuf != NULL)
93 			memcpy(buf, rb_buf + remainder, blksz);
94 		buf = (void *)((uintptr_t)buf + blksz);
95 		bytes -= blksz;
96 		lba++;
97 		remainder = 0;
98 		blksz = rb_size;
99 	}
100 
101 	free(bouncebuf);
102 	return (0);
103 
104 error:
105 	free(bouncebuf);
106 	DPRINTF("vdev_read: failed dev: %p, id: %u, lba: %ju, size: %zu,"
107 	    " rb_size: %zu, status: %lu\n", devinfo->dev,
108 	    devinfo->dev->Media->MediaId, (uintmax_t)lba, bytes, rb_size,
109 	    EFI_ERROR_CODE(status));
110 	return (-1);
111 }
112 
113 static EFI_STATUS
114 probe(dev_info_t *dev)
115 {
116 	spa_t *spa;
117 	dev_info_t *tdev;
118 	EFI_STATUS status;
119 
120 	/* ZFS consumes the dev on success so we need a copy. */
121 	if ((status = BS->AllocatePool(EfiLoaderData, sizeof(*dev),
122 	    (void**)&tdev)) != EFI_SUCCESS) {
123 		DPRINTF("Failed to allocate tdev (%lu)\n",
124 		    EFI_ERROR_CODE(status));
125 		return (status);
126 	}
127 	memcpy(tdev, dev, sizeof(*dev));
128 
129 	if (vdev_probe(vdev_read, tdev, &spa) != 0) {
130 		(void)BS->FreePool(tdev);
131 		return (EFI_UNSUPPORTED);
132 	}
133 
134 	dev->devdata = spa;
135 	add_device(&devices, dev);
136 
137 	return (EFI_SUCCESS);
138 }
139 
140 static EFI_STATUS
141 load(const char *filepath, dev_info_t *devinfo, void **bufp, size_t *bufsize)
142 {
143 	spa_t *spa;
144 	struct zfsmount zfsmount;
145 	dnode_phys_t dn;
146 	struct stat st;
147 	int err;
148 	void *buf;
149 	EFI_STATUS status;
150 
151 	spa = devinfo->devdata;
152 
153 #ifdef EFI_DEBUG
154 	{
155 		CHAR16 *text = efi_devpath_name(devinfo->devpath);
156 		DPRINTF("load: '%s' spa: '%s', devpath: %S\n", filepath,
157 		    spa->spa_name, text);
158 		efi_free_devpath_name(text);
159 	}
160 #endif
161 	if ((err = zfs_spa_init(spa)) != 0) {
162 		DPRINTF("Failed to load pool '%s' (%d)\n", spa->spa_name, err);
163 		return (EFI_NOT_FOUND);
164 	}
165 
166 	if ((err = zfs_mount(spa, 0, &zfsmount)) != 0) {
167 		DPRINTF("Failed to mount pool '%s' (%d)\n", spa->spa_name, err);
168 		return (EFI_NOT_FOUND);
169 	}
170 
171 	if ((err = zfs_lookup(&zfsmount, filepath, &dn)) != 0) {
172 		if (err == ENOENT) {
173 			DPRINTF("Failed to find '%s' on pool '%s' (%d)\n",
174 			    filepath, spa->spa_name, err);
175 			return (EFI_NOT_FOUND);
176 		}
177 		printf("Failed to lookup '%s' on pool '%s' (%d)\n", filepath,
178 		    spa->spa_name, err);
179 		return (EFI_INVALID_PARAMETER);
180 	}
181 
182 	if ((err = zfs_dnode_stat(spa, &dn, &st)) != 0) {
183 		printf("Failed to stat '%s' on pool '%s' (%d)\n", filepath,
184 		    spa->spa_name, err);
185 		return (EFI_INVALID_PARAMETER);
186 	}
187 
188 	if ((status = BS->AllocatePool(EfiLoaderData, (UINTN)st.st_size, &buf))
189 	    != EFI_SUCCESS) {
190 		printf("Failed to allocate load buffer %jd for pool '%s' for '%s' "
191 		    "(%lu)\n", (intmax_t)st.st_size, spa->spa_name, filepath, EFI_ERROR_CODE(status));
192 		return (EFI_INVALID_PARAMETER);
193 	}
194 
195 	if ((err = dnode_read(spa, &dn, 0, buf, st.st_size)) != 0) {
196 		printf("Failed to read node from %s (%d)\n", spa->spa_name,
197 		    err);
198 		(void)BS->FreePool(buf);
199 		return (EFI_INVALID_PARAMETER);
200 	}
201 
202 	*bufsize = st.st_size;
203 	*bufp = buf;
204 
205 	return (EFI_SUCCESS);
206 }
207 
208 static void
209 status(void)
210 {
211 	spa_t *spa;
212 
213 	spa = STAILQ_FIRST(&zfs_pools);
214 	if (spa == NULL) {
215 		printf("%s found no pools\n", zfs_module.name);
216 		return;
217 	}
218 
219 	printf("%s found the following pools:", zfs_module.name);
220 	STAILQ_FOREACH(spa, &zfs_pools, spa_link)
221 		printf(" %s", spa->spa_name);
222 
223 	printf("\n");
224 }
225 
226 static void
227 init(void)
228 {
229 
230 	zfs_init();
231 }
232 
233 static dev_info_t *
234 _devices(void)
235 {
236 
237 	return (devices);
238 }
239 
240 const boot_module_t zfs_module =
241 {
242 	.name = "ZFS",
243 	.init = init,
244 	.probe = probe,
245 	.load = load,
246 	.status = status,
247 	.devices = _devices
248 };
249