Remove file system support based on the simple file system protocol

as this only allows us to access file systems that EFI knows about.
With a loader that can only use EFI-supported file systems, we're
forced to put /boot on the EFI system partition. This is suboptimal
in the following ways:
1.  With /boot a symlink to /efi/boot, mergemaster complains about
    the mismatch and there's no quick solution.
2.  The EFI loader can only boot a single version of FreeBSD. There's
    no way to install multiple versions of FreeBSD and select one
    at the loader prompt.
3.  ZFS maintains /boot/zfs/zpool.cache and with /boot a symlink we
    end up with the file on a MSDOS file system. ZFS does not have
    proper handling of file systems that are under Giant.

Implement a disk device based on the block I/O protocol instead and
pull in file system code from libstand. The disk devices are really
the partitions that EFI knows about.

This change is backward compatible.

MFC after:	1 week
This commit is contained in:
Marcel Moolenaar 2010-01-09 22:54:29 +00:00
parent 829089cc6f
commit 716f79c093
Notes: svn2git 2020-12-20 02:59:44 +00:00
svn path=/head/; revision=201941
7 changed files with 276 additions and 449 deletions

View File

@ -45,6 +45,7 @@ struct devdesc
#define DEVT_CD 3
#define DEVT_ZFS 4
int d_unit;
void *d_opendata;
};
/* Commands and return values; nonzero return sets command_errmsg != NULL */

View File

@ -34,9 +34,7 @@ extern EFI_SYSTEM_TABLE *ST;
extern EFI_BOOT_SERVICES *BS;
extern EFI_RUNTIME_SERVICES *RS;
extern struct devsw efifs_dev;
extern struct fs_ops efifs_fsops;
extern struct devsw efipart_dev;
extern struct devsw efinet_dev;
extern struct netif_driver efinetif;

View File

@ -3,8 +3,8 @@
LIB= efi
INTERNALLIB=
SRCS= delay.c efi_console.c efifs.c efinet.c errno.c handles.c libefi.c \
time.c
SRCS= delay.c efi_console.c efinet.c efipart.c errno.c handles.c \
libefi.c time.c
CFLAGS+= -I${.CURDIR}/../include
CFLAGS+= -I${.CURDIR}/../include/${MACHINE_ARCH:S/amd64/i386/}

View File

@ -1,441 +0,0 @@
/*-
* Copyright (c) 2001 Doug Rabson
* Copyright (c) 2006 Marcel Moolenaar
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*/
#include <sys/cdefs.h>
__FBSDID("$FreeBSD$");
#include <sys/param.h>
#include <sys/time.h>
#include <stddef.h>
#include <stdarg.h>
#include <bootstrap.h>
#include <efi.h>
#include <efilib.h>
#include <efiprot.h>
/* Perform I/O in blocks of size EFI_BLOCK_SIZE. */
#define EFI_BLOCK_SIZE (1024 * 1024)
union fileinfo {
EFI_FILE_INFO info;
char bytes[sizeof(EFI_FILE_INFO) + 508];
};
static EFI_GUID sfs_guid = SIMPLE_FILE_SYSTEM_PROTOCOL;
static EFI_GUID fs_guid = EFI_FILE_SYSTEM_INFO_ID;
static EFI_GUID fi_guid = EFI_FILE_INFO_ID;
static int
efifs_open(const char *upath, struct open_file *f)
{
struct devdesc *dev = f->f_devdata;
EFI_FILE_IO_INTERFACE *fsif;
EFI_FILE *file, *root;
EFI_HANDLE h;
EFI_STATUS status;
CHAR16 *cp, *path;
if (f->f_dev != &efifs_dev || dev->d_unit < 0)
return (EINVAL);
h = efi_find_handle(f->f_dev, dev->d_unit);
if (h == NULL)
return (EINVAL);
status = BS->HandleProtocol(h, &sfs_guid, (VOID **)&fsif);
if (EFI_ERROR(status))
return (efi_status_to_errno(status));
/* Get the root directory. */
status = fsif->OpenVolume(fsif, &root);
if (EFI_ERROR(status))
return (efi_status_to_errno(status));
while (*upath == '/')
upath++;
/* Special case: opening the root directory. */
if (*upath == '\0') {
f->f_fsdata = root;
return (0);
}
path = malloc((strlen(upath) + 1) * sizeof(CHAR16));
if (path == NULL) {
root->Close(root);
return (ENOMEM);
}
cp = path;
while (*upath != '\0') {
if (*upath == '/') {
*cp = '\\';
while (upath[1] == '/')
upath++;
} else
*cp = *upath;
upath++;
cp++;
}
*cp = 0;
/* Open the file. */
status = root->Open(root, &file, path,
EFI_FILE_MODE_READ | EFI_FILE_MODE_WRITE, 0);
if (status == EFI_ACCESS_DENIED || status == EFI_WRITE_PROTECTED)
status = root->Open(root, &file, path, EFI_FILE_MODE_READ, 0);
free(path);
root->Close(root);
if (EFI_ERROR(status))
return (efi_status_to_errno(status));
f->f_fsdata = file;
return (0);
}
static int
efifs_close(struct open_file *f)
{
EFI_FILE *file = f->f_fsdata;
if (file == NULL)
return (EBADF);
file->Close(file);
f->f_fsdata = NULL;
return (0);
}
static int
efifs_read(struct open_file *f, void *buf, size_t size, size_t *resid)
{
EFI_FILE *file = f->f_fsdata;
EFI_STATUS status;
UINTN sz = size;
char *bufp;
if (file == NULL)
return (EBADF);
bufp = buf;
while (size > 0) {
sz = size;
if (sz > EFI_BLOCK_SIZE)
sz = EFI_BLOCK_SIZE;
status = file->Read(file, &sz, bufp);
if (EFI_ERROR(status))
return (efi_status_to_errno(status));
if (sz == 0)
break;
size -= sz;
bufp += sz;
}
if (resid)
*resid = size;
return (0);
}
static int
efifs_write(struct open_file *f, void *buf, size_t size, size_t *resid)
{
EFI_FILE *file = f->f_fsdata;
EFI_STATUS status;
UINTN sz = size;
char *bufp;
if (file == NULL)
return (EBADF);
bufp = buf;
while (size > 0) {
sz = size;
if (sz > EFI_BLOCK_SIZE)
sz = EFI_BLOCK_SIZE;
status = file->Write(file, &sz, bufp);
if (EFI_ERROR(status))
return (efi_status_to_errno(status));
if (sz == 0)
break;
size -= sz;
bufp += sz;
}
if (resid)
*resid = size;
return (0);
}
static off_t
efifs_seek(struct open_file *f, off_t offset, int where)
{
EFI_FILE *file = f->f_fsdata;
EFI_STATUS status;
UINT64 base;
if (file == NULL)
return (EBADF);
switch (where) {
case SEEK_SET:
break;
case SEEK_END:
status = file->SetPosition(file, ~0ULL);
if (EFI_ERROR(status))
return (-1);
/* FALLTHROUGH */
case SEEK_CUR:
status = file->GetPosition(file, &base);
if (EFI_ERROR(status))
return (-1);
offset = (off_t)(base + offset);
break;
default:
return (-1);
}
if (offset < 0)
return (-1);
status = file->SetPosition(file, (UINT64)offset);
return (EFI_ERROR(status) ? -1 : offset);
}
static int
efifs_stat(struct open_file *f, struct stat *sb)
{
EFI_FILE *file = f->f_fsdata;
union fileinfo fi;
EFI_STATUS status;
UINTN sz;
if (file == NULL)
return (EBADF);
bzero(sb, sizeof(*sb));
sz = sizeof(fi);
status = file->GetInfo(file, &fi_guid, &sz, &fi);
if (EFI_ERROR(status))
return (efi_status_to_errno(status));
sb->st_mode = S_IRUSR | S_IRGRP | S_IROTH;
if ((fi.info.Attribute & EFI_FILE_READ_ONLY) == 0)
sb->st_mode |= S_IWUSR | S_IWGRP | S_IWOTH;
if (fi.info.Attribute & EFI_FILE_DIRECTORY)
sb->st_mode |= S_IFDIR;
else
sb->st_mode |= S_IFREG;
sb->st_nlink = 1;
sb->st_atime = efi_time(&fi.info.LastAccessTime);
sb->st_mtime = efi_time(&fi.info.ModificationTime);
sb->st_ctime = efi_time(&fi.info.CreateTime);
sb->st_size = fi.info.FileSize;
sb->st_blocks = fi.info.PhysicalSize / S_BLKSIZE;
sb->st_blksize = S_BLKSIZE;
sb->st_birthtime = sb->st_ctime;
return (0);
}
static int
efifs_readdir(struct open_file *f, struct dirent *d)
{
EFI_FILE *file = f->f_fsdata;
union fileinfo fi;
EFI_STATUS status;
UINTN sz;
int i;
if (file == NULL)
return (EBADF);
sz = sizeof(fi);
status = file->Read(file, &sz, &fi);
if (EFI_ERROR(status))
return (efi_status_to_errno(status));
if (sz == 0)
return (ENOENT);
d->d_fileno = 0;
d->d_reclen = sizeof(*d);
if (fi.info.Attribute & EFI_FILE_DIRECTORY)
d->d_type = DT_DIR;
else
d->d_type = DT_REG;
for (i = 0; fi.info.FileName[i] != 0; i++)
d->d_name[i] = fi.info.FileName[i];
d->d_name[i] = 0;
d->d_namlen = i;
return (0);
}
struct fs_ops efifs_fsops = {
.fs_name = "efifs",
.fo_open = efifs_open,
.fo_close = efifs_close,
.fo_read = efifs_read,
.fo_write = efifs_write,
.fo_seek = efifs_seek,
.fo_stat = efifs_stat,
.fo_readdir = efifs_readdir
};
static int
efifs_dev_init(void)
{
EFI_HANDLE *handles;
EFI_STATUS status;
UINTN sz;
int err;
sz = 0;
status = BS->LocateHandle(ByProtocol, &sfs_guid, 0, &sz, 0);
if (status == EFI_BUFFER_TOO_SMALL) {
handles = (EFI_HANDLE *)malloc(sz);
status = BS->LocateHandle(ByProtocol, &sfs_guid, 0, &sz,
handles);
if (EFI_ERROR(status))
free(handles);
}
if (EFI_ERROR(status))
return (efi_status_to_errno(status));
err = efi_register_handles(&efifs_dev, handles,
sz / sizeof(EFI_HANDLE));
free(handles);
return (err);
}
/*
* Print information about disks
*/
static void
efifs_dev_print(int verbose)
{
union {
EFI_FILE_SYSTEM_INFO info;
char buffer[1024];
} fi;
char line[80];
EFI_FILE_IO_INTERFACE *fsif;
EFI_FILE *volume;
EFI_HANDLE h;
EFI_STATUS status;
UINTN sz;
int i, unit;
for (unit = 0, h = efi_find_handle(&efifs_dev, 0);
h != NULL; h = efi_find_handle(&efifs_dev, ++unit)) {
sprintf(line, " %s%d: ", efifs_dev.dv_name, unit);
pager_output(line);
status = BS->HandleProtocol(h, &sfs_guid, (VOID **)&fsif);
if (EFI_ERROR(status))
goto err;
status = fsif->OpenVolume(fsif, &volume);
if (EFI_ERROR(status))
goto err;
sz = sizeof(fi);
status = volume->GetInfo(volume, &fs_guid, &sz, &fi);
volume->Close(volume);
if (EFI_ERROR(status))
goto err;
if (fi.info.ReadOnly)
pager_output("[RO] ");
else
pager_output(" ");
for (i = 0; fi.info.VolumeLabel[i] != 0; i++)
fi.buffer[i] = fi.info.VolumeLabel[i];
fi.buffer[i] = 0;
if (fi.buffer[0] != 0)
pager_output(fi.buffer);
else
pager_output("EFI filesystem");
pager_output("\n");
continue;
err:
sprintf(line, "[--] error %d: unable to obtain information\n",
efi_status_to_errno(status));
pager_output(line);
}
}
/*
* Attempt to open the disk described by (dev) for use by (f).
*
* Note that the philosophy here is "give them exactly what
* they ask for". This is necessary because being too "smart"
* about what the user might want leads to complications.
* (eg. given no slice or partition value, with a disk that is
* sliced - are they after the first BSD slice, or the DOS
* slice before it?)
*/
static int
efifs_dev_open(struct open_file *f, ...)
{
va_list args;
struct devdesc *dev;
va_start(args, f);
dev = va_arg(args, struct devdesc*);
va_end(args);
if (dev->d_unit < 0)
return(ENXIO);
return (0);
}
static int
efifs_dev_close(struct open_file *f)
{
return (0);
}
static int
efifs_dev_strategy(void *devdata, int rw, daddr_t dblk, size_t size, char *buf, size_t *rsize)
{
return (ENOSYS);
}
struct devsw efifs_dev = {
.dv_name = "fs",
.dv_type = DEVT_DISK,
.dv_init = efifs_dev_init,
.dv_strategy = efifs_dev_strategy,
.dv_open = efifs_dev_open,
.dv_close = efifs_dev_close,
.dv_ioctl = noioctl,
.dv_print = efifs_dev_print,
.dv_cleanup = NULL
};

View File

@ -0,0 +1,265 @@
/*-
* Copyright (c) 2010 Marcel Moolenaar
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*/
#include <sys/cdefs.h>
__FBSDID("$FreeBSD$");
#include <sys/param.h>
#include <sys/time.h>
#include <stddef.h>
#include <stdarg.h>
#include <bootstrap.h>
#include <efi.h>
#include <efilib.h>
#include <efiprot.h>
static EFI_GUID blkio_guid = BLOCK_IO_PROTOCOL;
static int efipart_init(void);
static int efipart_strategy(void *, int, daddr_t, size_t, char *, size_t *);
static int efipart_open(struct open_file *, ...);
static int efipart_close(struct open_file *);
static void efipart_print(int);
struct devsw efipart_dev = {
.dv_name = "part",
.dv_type = DEVT_DISK,
.dv_init = efipart_init,
.dv_strategy = efipart_strategy,
.dv_open = efipart_open,
.dv_close = efipart_close,
.dv_ioctl = noioctl,
.dv_print = efipart_print,
.dv_cleanup = NULL
};
static int
efipart_init(void)
{
EFI_BLOCK_IO *blkio;
EFI_HANDLE *hin, *hout;
EFI_STATUS status;
UINTN sz;
u_int n, nin, nout;
int err;
sz = 0;
status = BS->LocateHandle(ByProtocol, &blkio_guid, 0, &sz, 0);
if (status == EFI_BUFFER_TOO_SMALL) {
hin = (EFI_HANDLE *)malloc(sz * 2);
status = BS->LocateHandle(ByProtocol, &blkio_guid, 0, &sz,
hin);
if (EFI_ERROR(status))
free(hin);
}
if (EFI_ERROR(status))
return (efi_status_to_errno(status));
/* Filter handles to only include FreeBSD partitions. */
nin = sz / sizeof(EFI_HANDLE);
hout = hin + nin;
nout = 0;
for (n = 0; n < nin; n++) {
status = BS->HandleProtocol(hin[n], &blkio_guid, &blkio);
if (EFI_ERROR(status))
continue;
if (!blkio->Media->LogicalPartition)
continue;
hout[nout] = hin[n];
nout++;
}
err = efi_register_handles(&efipart_dev, hout, nout);
free(hin);
return (err);
}
static void
efipart_print(int verbose)
{
char line[80];
EFI_BLOCK_IO *blkio;
EFI_HANDLE h;
EFI_STATUS status;
u_int unit;
for (unit = 0, h = efi_find_handle(&efipart_dev, 0);
h != NULL; h = efi_find_handle(&efipart_dev, ++unit)) {
sprintf(line, " %s%d:", efipart_dev.dv_name, unit);
pager_output(line);
status = BS->HandleProtocol(h, &blkio_guid, &blkio);
if (!EFI_ERROR(status)) {
sprintf(line, " %llu blocks",
(unsigned long long)(blkio->Media->LastBlock + 1));
pager_output(line);
if (blkio->Media->RemovableMedia)
pager_output(" (removable)");
}
pager_output("\n");
}
}
static int
efipart_open(struct open_file *f, ...)
{
va_list args;
struct devdesc *dev;
EFI_BLOCK_IO *blkio;
EFI_HANDLE h;
EFI_STATUS status;
va_start(args, f);
dev = va_arg(args, struct devdesc*);
va_end(args);
h = efi_find_handle(&efipart_dev, dev->d_unit);
if (h == NULL)
return (EINVAL);
status = BS->HandleProtocol(h, &blkio_guid, &blkio);
if (EFI_ERROR(status))
return (efi_status_to_errno(status));
if (!blkio->Media->MediaPresent)
return (EAGAIN);
dev->d_opendata = blkio;
return (0);
}
static int
efipart_close(struct open_file *f)
{
struct devdesc *dev;
dev = (struct devdesc *)(f->f_devdata);
if (dev->d_opendata == NULL)
return (EINVAL);
dev->d_opendata = NULL;
return (0);
}
/*
* efipart_readwrite()
* Internal equivalent of efipart_strategy(), which operates on the
* media-native block size. This function expects all I/O requests
* to be within the media size and returns an error if such is not
* the case.
*/
static int
efipart_readwrite(EFI_BLOCK_IO *blkio, int rw, daddr_t blk, daddr_t nblks,
char *buf)
{
EFI_STATUS status;
if (blkio == NULL)
return (ENXIO);
if (blk < 0 || blk > blkio->Media->LastBlock)
return (EIO);
if ((blk + nblks - 1) > blkio->Media->LastBlock)
return (EIO);
switch (rw) {
case F_READ:
status = blkio->ReadBlocks(blkio, blkio->Media->MediaId, blk,
nblks * blkio->Media->BlockSize, buf);
break;
case F_WRITE:
if (blkio->Media->ReadOnly)
return (EROFS);
status = blkio->WriteBlocks(blkio, blkio->Media->MediaId, blk,
nblks * blkio->Media->BlockSize, buf);
break;
default:
return (ENOSYS);
}
if (EFI_ERROR(status))
printf("%s: rw=%d, status=%lu\n", __func__, rw, status);
return (efi_status_to_errno(status));
}
static int
efipart_strategy(void *devdata, int rw, daddr_t blk, size_t size, char *buf,
size_t *rsize)
{
struct devdesc *dev = (struct devdesc *)devdata;
EFI_BLOCK_IO *blkio;
off_t off;
char *blkbuf;
size_t blkoff, blksz;
int error;
if (dev == NULL || blk < 0)
return (EINVAL);
blkio = dev->d_opendata;
if (blkio == NULL)
return (ENXIO);
if (size == 0 || (size % 512) != 0)
return (EIO);
if (rsize != NULL)
*rsize = size;
if (blkio->Media->BlockSize == 512)
return (efipart_readwrite(blkio, rw, blk, size / 512, buf));
/*
* The block size of the media is not 512B per sector.
*/
blkbuf = malloc(blkio->Media->BlockSize);
if (blkbuf == NULL)
return (ENOMEM);
error = 0;
off = blk * 512;
blk = off / blkio->Media->BlockSize;
blkoff = off % blkio->Media->BlockSize;
blksz = blkio->Media->BlockSize - blkoff;
while (size > 0) {
error = efipart_readwrite(blkio, rw, blk, 1, blkbuf);
if (error)
break;
if (size < blksz)
blksz = size;
bcopy(blkbuf + blkoff, buf, blksz);
buf += blksz;
size -= blksz;
blk++;
blkoff = 0;
blksz = blkio->Media->BlockSize;
}
free(blkbuf);
return (error);
}

View File

@ -49,15 +49,16 @@ __FBSDID("$FreeBSD$");
/* Exported for libstand */
struct devsw *devsw[] = {
&efifs_dev,
&efipart_dev,
&efinet_dev,
NULL
};
struct fs_ops *file_system[] = {
&efifs_fsops,
&nfs_fsops,
&dosfs_fsops,
&ufs_fsops,
&cd9660_fsops,
&nfs_fsops,
&gzipfs_fsops,
NULL
};

View File

@ -3,6 +3,9 @@ $FreeBSD$
NOTE ANY CHANGES YOU MAKE TO THE BOOTBLOCKS HERE. The format of this
file is important. Make sure the current version number is on line 6.
2.0: Provide devices based on the block I/O protocol, rather than the
simple file services protocol. Use the FreeBSD file system code
on top of those devices to access files.
1.2: Restructured. Has some user visible differences.
1.1: Pass the HCDP table address to the kernel via bootinfo if one
is present in the EFI system table.