xref: /freebsd-13-stable/stand/efi/boot1/zfs_module.c (revision 17da660ad5b3b9cd90e164dd4dbb9beaa7203054)
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 #include <stddef.h>
27 #include <stdarg.h>
28 #include <stdbool.h>
29 #include <sys/cdefs.h>
30 #include <sys/param.h>
31 #include <sys/queue.h>
32 #include <efi.h>
33 
34 #include "boot_module.h"
35 
36 #include "libzfs.h"
37 #include "zfsimpl.c"
38 
39 static dev_info_t *devices;
40 
41 uint64_t
ldi_get_size(void * priv)42 ldi_get_size(void *priv)
43 {
44 	dev_info_t *devinfo = priv;
45 
46 	return (devinfo->dev->Media->BlockSize *
47 	    (devinfo->dev->Media->LastBlock + 1));
48 }
49 
50 static int
vdev_read(vdev_t * vdev,void * priv,off_t off,void * buf,size_t bytes)51 vdev_read(vdev_t *vdev, void *priv, off_t off, void *buf, size_t bytes)
52 {
53 	dev_info_t *devinfo;
54 	uint64_t lba;
55 	size_t size, remainder, rb_size, blksz;
56 	char *bouncebuf = NULL, *rb_buf;
57 	EFI_STATUS status;
58 
59 	devinfo = (dev_info_t *)priv;
60 	lba = off / devinfo->dev->Media->BlockSize;
61 	remainder = off % devinfo->dev->Media->BlockSize;
62 
63 	rb_buf = buf;
64 	rb_size = bytes;
65 
66 	/*
67 	 * If we have remainder from off, we need to add remainder part.
68 	 * Since buffer must be multiple of the BlockSize, round it all up.
69 	 */
70 	size = roundup2(bytes + remainder, devinfo->dev->Media->BlockSize);
71 	blksz = size;
72 	if (remainder != 0 || size != bytes) {
73 		rb_size = devinfo->dev->Media->BlockSize;
74 		bouncebuf = malloc(rb_size);
75 		if (bouncebuf == NULL) {
76 			printf("vdev_read: out of memory\n");
77 			return (-1);
78 		}
79 		rb_buf = bouncebuf;
80 		blksz = rb_size - remainder;
81 	}
82 
83 	while (bytes > 0) {
84 		status = devinfo->dev->ReadBlocks(devinfo->dev,
85 		    devinfo->dev->Media->MediaId, lba, rb_size, rb_buf);
86 		if (EFI_ERROR(status))
87 				goto error;
88 		if (bytes < blksz)
89 			blksz = bytes;
90 		if (bouncebuf != NULL)
91 			memcpy(buf, rb_buf + remainder, blksz);
92 		buf = (void *)((uintptr_t)buf + blksz);
93 		bytes -= blksz;
94 		lba++;
95 		remainder = 0;
96 		blksz = rb_size;
97 	}
98 
99 	free(bouncebuf);
100 	return (0);
101 
102 error:
103 	free(bouncebuf);
104 	DPRINTF("vdev_read: failed dev: %p, id: %u, lba: %ju, size: %zu,"
105 	    " rb_size: %zu, status: %lu\n", devinfo->dev,
106 	    devinfo->dev->Media->MediaId, (uintmax_t)lba, bytes, rb_size,
107 	    EFI_ERROR_CODE(status));
108 	return (-1);
109 }
110 
111 static EFI_STATUS
probe(dev_info_t * dev)112 probe(dev_info_t *dev)
113 {
114 	spa_t *spa;
115 	dev_info_t *tdev;
116 
117 	/* ZFS consumes the dev on success so we need a copy. */
118 	tdev = malloc(sizeof(*dev));
119 	if (tdev == NULL) {
120 		DPRINTF("Failed to allocate tdev\n");
121 		return (EFI_OUT_OF_RESOURCES);
122 	}
123 	memcpy(tdev, dev, sizeof(*dev));
124 
125 	if (vdev_probe(vdev_read, NULL, tdev, &spa) != 0) {
126 		free(tdev);
127 		return (EFI_UNSUPPORTED);
128 	}
129 
130 	dev->devdata = spa;
131 	add_device(&devices, dev);
132 
133 	return (EFI_SUCCESS);
134 }
135 
136 static EFI_STATUS
load(const char * filepath,dev_info_t * devinfo,void ** bufp,size_t * bufsize)137 load(const char *filepath, dev_info_t *devinfo, void **bufp, size_t *bufsize)
138 {
139 	spa_t *spa;
140 	struct zfsmount zmount;
141 	dnode_phys_t dn;
142 	struct stat st;
143 	int err;
144 	void *buf;
145 
146 	spa = devinfo->devdata;
147 
148 #ifdef EFI_DEBUG
149 	{
150 		CHAR16 *text = efi_devpath_name(devinfo->devpath);
151 		DPRINTF("load: '%s' spa: '%s', devpath: %S\n", filepath,
152 		    spa->spa_name, text);
153 		efi_free_devpath_name(text);
154 	}
155 #endif
156 	if ((err = zfs_spa_init(spa)) != 0) {
157 		DPRINTF("Failed to load pool '%s' (%d)\n", spa->spa_name, err);
158 		return (EFI_NOT_FOUND);
159 	}
160 
161 	if ((err = zfs_mount_impl(spa, 0, &zmount)) != 0) {
162 		DPRINTF("Failed to mount pool '%s' (%d)\n", spa->spa_name, err);
163 		return (EFI_NOT_FOUND);
164 	}
165 
166 	if ((err = zfs_lookup(&zmount, filepath, &dn)) != 0) {
167 		if (err == ENOENT) {
168 			DPRINTF("Failed to find '%s' on pool '%s' (%d)\n",
169 			    filepath, spa->spa_name, err);
170 			return (EFI_NOT_FOUND);
171 		}
172 		printf("Failed to lookup '%s' on pool '%s' (%d)\n", filepath,
173 		    spa->spa_name, err);
174 		return (EFI_INVALID_PARAMETER);
175 	}
176 
177 	if ((err = zfs_dnode_stat(spa, &dn, &st)) != 0) {
178 		printf("Failed to stat '%s' on pool '%s' (%d)\n", filepath,
179 		    spa->spa_name, err);
180 		return (EFI_INVALID_PARAMETER);
181 	}
182 
183 	buf = malloc(st.st_size);
184 	if (buf == NULL) {
185 		printf("Failed to allocate load buffer %jd for pool '%s' for '%s' ",
186 		    (intmax_t)st.st_size, spa->spa_name, filepath);
187 		return (EFI_INVALID_PARAMETER);
188 	}
189 
190 	if ((err = dnode_read(spa, &dn, 0, buf, st.st_size)) != 0) {
191 		printf("Failed to read node from %s (%d)\n", spa->spa_name,
192 		    err);
193 		free(buf);
194 		return (EFI_INVALID_PARAMETER);
195 	}
196 
197 	*bufsize = st.st_size;
198 	*bufp = buf;
199 
200 	return (EFI_SUCCESS);
201 }
202 
203 static void
status(void)204 status(void)
205 {
206 	spa_t *spa;
207 
208 	spa = STAILQ_FIRST(&zfs_pools);
209 	if (spa == NULL) {
210 		printf("%s found no pools\n", zfs_module.name);
211 		return;
212 	}
213 
214 	printf("%s found the following pools:", zfs_module.name);
215 	STAILQ_FOREACH(spa, &zfs_pools, spa_link)
216 		printf(" %s", spa->spa_name);
217 
218 	printf("\n");
219 }
220 
221 static void
init(void)222 init(void)
223 {
224 
225 	zfs_init();
226 }
227 
228 static dev_info_t *
_devices(void)229 _devices(void)
230 {
231 
232 	return (devices);
233 }
234 
235 const boot_module_t zfs_module =
236 {
237 	.name = "ZFS",
238 	.init = init,
239 	.probe = probe,
240 	.load = load,
241 	.status = status,
242 	.devices = _devices
243 };
244