[PATCH] efi_runtime: remove efi_runtime dkms

ivanhu ivan.hu at canonical.com
Thu Jul 25 08:55:40 UTC 2019


On 7/25/19 4:11 PM, Colin Ian King wrote:
> On 25/07/2019 09:03, Ivan Hu wrote:
>> efi_runtime driver provides the runtime UEFI interfaces for fwts to test
>> the UEFI runtime service implementiation and has upstream in Linux 4.9 named
>> efi_test. All supported Ubuntu kernels have efi_test included. As a result,
>> this dkms is no longer required.
>>
>> Signed-off-by: Ivan Hu <ivan.hu at canonical.com>
>> ---
>>  debian/control                    |   9 +-
>>  debian/fwts-efi-runtime-dkms.dkms |   6 -
>>  debian/rules                      |  18 +-
>>  efi_runtime/.gitignore            |   4 -
>>  efi_runtime/Makefile              |  28 --
>>  efi_runtime/efi_runtime.c         | 801 --------------------------------------
>>  efi_runtime/efi_runtime.h         | 135 -------
>>  7 files changed, 3 insertions(+), 998 deletions(-)
>>  delete mode 100644 debian/fwts-efi-runtime-dkms.dkms
>>  delete mode 100644 efi_runtime/.gitignore
>>  delete mode 100644 efi_runtime/Makefile
>>  delete mode 100644 efi_runtime/efi_runtime.c
>>  delete mode 100644 efi_runtime/efi_runtime.h
>>
>> diff --git a/debian/control b/debian/control
>> index dcc7c19..2f88cd1 100644
>> --- a/debian/control
>> +++ b/debian/control
>> @@ -4,7 +4,7 @@ Priority: optional
>>  Maintainer: Firmware Testing Team <fwts-devel at lists.ubuntu.com>
>>  Uploaders: Colin King <colin.king at ubuntu.com>, Alex Hung <alex.hung at canonical.com>, Ivan Hu <ivan.hu at canonical.com>
>>  Standards-Version: 3.9.8
>> -Build-Depends: debhelper (>= 7.0.50~), autoconf, automake, libtool, libjson0-dev | libjson-c-dev (>= 0.9), flex, bison, dh-autoreconf, dkms, libglib2.0-dev, pkg-config, libfdt-dev, libbsd-dev
>> +Build-Depends: debhelper (>= 7.0.50~), autoconf, automake, libtool, libjson0-dev | libjson-c-dev (>= 0.9), flex, bison, dh-autoreconf, libglib2.0-dev, pkg-config, libfdt-dev, libbsd-dev
>>  
>>  Package: fwts
>>  Architecture: i386 amd64 armel armhf arm64 ppc64 ppc64el s390x
>> @@ -53,10 +53,3 @@ Description: Firmware Test Suite frontend interface
>>   to execute tests via Firmware Test Suite and is also used as the primary 
>>   interface within Firmware Test Suite live images.
>>  
>> -Package: fwts-efi-runtime-dkms
>> -Architecture: i386 amd64 armel armhf arm64 ppc64 ppc64el
>> -Priority: optional
>> -Depends: ${misc:Depends}, dkms
>> -Description: Firmware Test Suite UEFI Runtime Service kernel driver
>> - This package provides the efi_runtime kernel driver in DKMS format,
>> - which is required for accessing UEFI Runtime Services.
>> diff --git a/debian/fwts-efi-runtime-dkms.dkms b/debian/fwts-efi-runtime-dkms.dkms
>> deleted file mode 100644
>> index 94b3415..0000000
>> --- a/debian/fwts-efi-runtime-dkms.dkms
>> +++ /dev/null
>> @@ -1,6 +0,0 @@
>> -PACKAGE_NAME="fwts-efi-runtime-dkms"
>> -PACKAGE_VERSION="#MODULE_VERSION#"
>> -MAKE[0]="KVER=$kernelver make"
>> -BUILT_MODULE_NAME[0]="efi_runtime"
>> -DEST_MODULE_LOCATION[0]="/updates"
>> -AUTOINSTALL="yes"
>> diff --git a/debian/rules b/debian/rules
>> index c24df00..3ca21ad 100755
>> --- a/debian/rules
>> +++ b/debian/rules
>> @@ -2,27 +2,13 @@
>>  
>>  export DEB_BUILD_MAINT_OPTIONS=hardening=+all
>>  
>> +Package: fwts-efi-runtime-dkms
>>  DEB_BUILD_ARCH := $(shell dpkg-architecture -qDEB_BUILD_ARCH)
>>  
>> -DEBVERS := $(shell dpkg-parsechangelog | grep ^Version: | cut -d' ' -f2 \
>> -		| cut -d- -f1)
>> -
>> -VERSION := $(shell echo '$(DEBVERS)' | sed -e 's/[+-].*//' -e 's/~//g')
>> -
>> -DKMS_SRC_DIR := $(CURDIR)/debian/fwts-efi-runtime-dkms/usr/src/fwts-efi-runtime-dkms-$(VERSION)
>> -
>> -override_dh_auto_install:
>> -	install -d $(DKMS_SRC_DIR)
>> -	cp -a efi_runtime/* $(DKMS_SRC_DIR)
>> -	dh_auto_install
>> -
>> -override_dh_dkms:
>> -	dh_dkms -V $(VERSION)
>> -
>>  override_dh_auto_test:
>>  ifneq ($(DEB_BUILD_ARCH),arm64)
>>  	dh_auto_test $@
>>  endif
>>  
>>  %:
>> -	dh $@ --with autoreconf,dkms
>> +	dh $@ --with autoreconf
>> diff --git a/efi_runtime/.gitignore b/efi_runtime/.gitignore
>> deleted file mode 100644
>> index a4b501b..0000000
>> --- a/efi_runtime/.gitignore
>> +++ /dev/null
>> @@ -1,4 +0,0 @@
>> -Module.symvers
>> -efi_runtime.ko
>> -efi_runtime.mod.c
>> -modules.order
>> diff --git a/efi_runtime/Makefile b/efi_runtime/Makefile
>> deleted file mode 100644
>> index ae86867..0000000
>> --- a/efi_runtime/Makefile
>> +++ /dev/null
>> @@ -1,28 +0,0 @@
>> -#
>> -# Copyright (C) 2012-2019 Canonical, Ltd.
>> -#
>> -# This program is free software; you can redistribute it and/or
>> -# modify it under the terms of the GNU General Public License
>> -# as published by the Free Software Foundation; either version 2
>> -# of the License, or (at your option) any later version.
>> -#
>> -# This program is distributed in the hope that it will be useful,
>> -# but WITHOUT ANY WARRANTY; without even the implied warranty of
>> -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
>> -# GNU General Public License for more details.
>> -#
>> -# You should have received a copy of the GNU General Public License
>> -# along with this program; if not, write to the Free Software
>> -# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
>> -#
>> -
>> -KVER ?= `uname -r`
>> -obj-m += efi_runtime.o
>> -all:
>> -	make -C /lib/modules/$(KVER)/build M=`pwd` modules
>> -
>> -install:
>> -	make -C /lib/modules/$(KVER)/build M=`pwd` modules_install
>> -
>> -clean:
>> -	make -C /lib/modules/$(KVER)/build M=`pwd` clean
>> diff --git a/efi_runtime/efi_runtime.c b/efi_runtime/efi_runtime.c
>> deleted file mode 100644
>> index 5dfa089..0000000
>> --- a/efi_runtime/efi_runtime.c
>> +++ /dev/null
>> @@ -1,801 +0,0 @@
>> -/*
>> - * EFI Runtime driver
>> - *
>> - * Copyright(C) 2012-2019 Canonical Ltd.
>> - *
>> - *  This program is free software; you can redistribute it and/or modify
>> - *  it under the terms of the GNU General Public License as published by
>> - *  the Free Software Foundation; either version 2 of the License, or
>> - *  (at your option) any later version.
>> - *
>> - *  This program is distributed in the hope that it will be useful,
>> - *  but WITHOUT ANY WARRANTY; without even the implied warranty of
>> - *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
>> - *  GNU General Public License for more details.
>> - *
>> - *  You should have received a copy of the GNU General Public License
>> - *  along with this program; if not, write to the Free Software
>> - *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
>> - *  USA.
>> - */
>> -
>> -#include <linux/version.h>
>> -#include <linux/miscdevice.h>
>> -#include <linux/module.h>
>> -#include <linux/init.h>
>> -#include <linux/proc_fs.h>
>> -#include <linux/efi.h>
>> -#include <linux/slab.h>
>> -#include <linux/uaccess.h>
>> -
>> -#include "efi_runtime.h"
>> -
>> -MODULE_AUTHOR("Ivan Hu");
>> -MODULE_DESCRIPTION("EFI Runtime Driver");
>> -MODULE_LICENSE("GPL");
>> -
>> -/* commit 83e681897 turned efi_enabled into a function, so abstract it */
>> -#ifdef EFI_RUNTIME_SERVICES
>> -#define EFI_RUNTIME_ENABLED	efi_enabled(EFI_RUNTIME_SERVICES)
>> -#else
>> -#define EFI_RUNTIME_ENABLED	efi_enabled
>> -#endif
>> -
>> -#if LINUX_VERSION_CODE >= KERNEL_VERSION(5, 0, 0)
>> -#define ACCESS_OK(type, addr, size)	access_ok(addr, size)
>> -#else
>> -#define ACCESS_OK(type, addr, size)	access_ok(type, addr, size)
>> -#endif
>> -
>> -/*
>> - * Count the bytes in 'str', including the terminating NULL.
>> - *
>> - * Note this function returns the number of *bytes*, not the number of
>> - * ucs2 characters.
>> - */
>> -static inline size_t user_ucs2_strsize(efi_char16_t  __user *str)
>> -{
>> -	efi_char16_t *s = str, c;
>> -	size_t len;
>> -
>> -	if (!str)
>> -		return 0;
>> -
>> -	/* Include terminating NULL */
>> -	len = sizeof(efi_char16_t);
>> -
>> -	if (get_user(c, s++)) {
>> -		/* Can't read userspace memory for size */
>> -		return 0;
>> -	}
>> -
>> -	while (c != 0) {
>> -		if (get_user(c, s++)) {
>> -			/* Can't read userspace memory for size */
>> -			return 0;
>> -		}
>> -		len += sizeof(efi_char16_t);
>> -	}
>> -	return len;
>> -}
>> -
>> -/*
>> - * Allocate a buffer and copy a ucs2 string from user space into it.
>> - */
>> -static inline int
>> -copy_ucs2_from_user_len(efi_char16_t **dst, efi_char16_t __user *src,
>> -			size_t len)
>> -{
>> -	efi_char16_t *buf;
>> -
>> -	if (!src) {
>> -		*dst = NULL;
>> -		return 0;
>> -	}
>> -
>> -	if (!ACCESS_OK(VERIFY_READ, src, 1))
>> -		return -EFAULT;
>> -
>> -	buf = memdup_user(src, len);
>> -	if (IS_ERR(buf)) {
>> -		*dst = NULL;
>> -		return PTR_ERR(buf);
>> -	}
>> -	*dst = buf;
>> -
>> -	return 0;
>> -}
>> -
>> -/*
>> - * Count the bytes in 'str', including the terminating NULL.
>> - *
>> - * Just a wrap for user_ucs2_strsize
>> - */
>> -static inline int
>> -get_ucs2_strsize_from_user(efi_char16_t __user *src, size_t *len)
>> -{
>> -	if (!ACCESS_OK(VERIFY_READ, src, 1))
>> -		return -EFAULT;
>> -
>> -	*len = user_ucs2_strsize(src);
>> -	if (*len == 0)
>> -		return -EFAULT;
>> -
>> -	return 0;
>> -}
>> -
>> -/*
>> - * Calculate the required buffer allocation size and copy a ucs2 string
>> - * from user space into it.
>> - *
>> - * This function differs from copy_ucs2_from_user_len() because it
>> - * calculates the size of the buffer to allocate by taking the length of
>> - * the string 'src'.
>> - *
>> - * If a non-zero value is returned, the caller MUST NOT access 'dst'.
>> - *
>> - * It is the caller's responsibility to free 'dst'.
>> - */
>> -static inline int
>> -copy_ucs2_from_user(efi_char16_t **dst, efi_char16_t __user *src)
>> -{
>> -	size_t len;
>> -
>> -	if (!ACCESS_OK(VERIFY_READ, src, 1))
>> -		return -EFAULT;
>> -
>> -	len = user_ucs2_strsize(src);
>> -	if (len == 0)
>> -		return -EFAULT;
>> -	return copy_ucs2_from_user_len(dst, src, len);
>> -}
>> -
>> -/*
>> - * Copy a ucs2 string to a user buffer.
>> - *
>> - * This function is a simple wrapper around copy_to_user() that does
>> - * nothing if 'src' is NULL, which is useful for reducing the amount of
>> - * NULL checking the caller has to do.
>> - *
>> - * 'len' specifies the number of bytes to copy.
>> - */
>> -static inline int
>> -copy_ucs2_to_user_len(efi_char16_t __user *dst, efi_char16_t *src, size_t len)
>> -{
>> -	if (!src)
>> -		return 0;
>> -
>> -	if (!ACCESS_OK(VERIFY_WRITE, dst, 1))
>> -		return -EFAULT;
>> -
>> -	return copy_to_user(dst, src, len);
>> -}
>> -
>> -static long efi_runtime_get_variable(unsigned long arg)
>> -{
>> -	struct efi_getvariable __user *getvariable_user;
>> -	struct efi_getvariable getvariable;
>> -	unsigned long datasize = 0, prev_datasize, *dz;
>> -	efi_guid_t vendor_guid, *vd = NULL;
>> -	efi_status_t status;
>> -	efi_char16_t *name = NULL;
>> -	u32 attr, *at;
>> -	void *data = NULL;
>> -	int rv = 0;
>> -
>> -	getvariable_user = (struct efi_getvariable __user *)arg;
>> -
>> -	if (copy_from_user(&getvariable, getvariable_user,
>> -			   sizeof(getvariable)))
>> -		return -EFAULT;
>> -	if (getvariable.data_size &&
>> -	    get_user(datasize, getvariable.data_size))
>> -		return -EFAULT;
>> -	if (getvariable.vendor_guid) {
>> -		if (copy_from_user(&vendor_guid, getvariable.vendor_guid,
>> -					sizeof(vendor_guid)))
>> -			return -EFAULT;
>> -		vd = &vendor_guid;
>> -	}
>> -
>> -	if (getvariable.variable_name) {
>> -		rv = copy_ucs2_from_user(&name, getvariable.variable_name);
>> -		if (rv)
>> -			return rv;
>> -	}
>> -
>> -	at = getvariable.attributes ? &attr : NULL;
>> -	dz = getvariable.data_size ? &datasize : NULL;
>> -
>> -	if (getvariable.data_size && getvariable.data) {
>> -		data = kmalloc(datasize, GFP_KERNEL);
>> -		if (!data) {
>> -			kfree(name);
>> -			return -ENOMEM;
>> -		}
>> -	}
>> -
>> -	prev_datasize = datasize;
>> -	status = efi.get_variable(name, vd, at, dz, data);
>> -	kfree(name);
>> -
>> -	if (put_user(status, getvariable.status)) {
>> -		rv = -EFAULT;
>> -		goto out;
>> -	}
>> -
>> -	if (status != EFI_SUCCESS) {
>> -		if (status == EFI_BUFFER_TOO_SMALL) {
>> -			if (dz && put_user(datasize, getvariable.data_size)) {
>> -				rv = -EFAULT;
>> -				goto out;
>> -			}
>> -		}
>> -		rv = -EINVAL;
>> -		goto out;
>> -	}
>> -
>> -	if (prev_datasize < datasize) {
>> -		rv = -EINVAL;
>> -		goto out;
>> -	}
>> -
>> -	if (data) {
>> -		if (copy_to_user(getvariable.data, data, datasize)) {
>> -			rv = -EFAULT;
>> -			goto out;
>> -		}
>> -	}
>> -
>> -	if (at && put_user(attr, getvariable.attributes)) {
>> -		rv = -EFAULT;
>> -		goto out;
>> -	}
>> -
>> -	if (dz && put_user(datasize, getvariable.data_size))
>> -		rv = -EFAULT;
>> -
>> -out:
>> -	kfree(data);
>> -	return rv;
>> -
>> -}
>> -
>> -static long efi_runtime_set_variable(unsigned long arg)
>> -{
>> -	struct efi_setvariable __user *setvariable_user;
>> -	struct efi_setvariable setvariable;
>> -	efi_guid_t vendor_guid;
>> -	efi_status_t status;
>> -	efi_char16_t *name = NULL;
>> -	void *data;
>> -	int rv = 0;
>> -
>> -	setvariable_user = (struct efi_setvariable __user *)arg;
>> -
>> -	if (copy_from_user(&setvariable, setvariable_user, sizeof(setvariable)))
>> -		return -EFAULT;
>> -	if (copy_from_user(&vendor_guid, setvariable.vendor_guid,
>> -				sizeof(vendor_guid)))
>> -		return -EFAULT;
>> -
>> -	if (setvariable.variable_name) {
>> -		rv = copy_ucs2_from_user(&name, setvariable.variable_name);
>> -		if (rv)
>> -			return rv;
>> -	}
>> -
>> -	data = memdup_user(setvariable.data, setvariable.data_size);
>> -	if (IS_ERR(data)) {
>> -		kfree(name);
>> -		return PTR_ERR(data);
>> -	}
>> -
>> -	status = efi.set_variable(name, &vendor_guid,
>> -				setvariable.attributes,
>> -				setvariable.data_size, data);
>> -
>> -	if (put_user(status, setvariable.status)) {
>> -		rv = -EFAULT;
>> -		goto out;
>> -	}
>> -
>> -	rv = status == EFI_SUCCESS ? 0 : -EINVAL;
>> -
>> -out:
>> -	kfree(data);
>> -	kfree(name);
>> -
>> -	return rv;
>> -}
>> -
>> -static long efi_runtime_get_time(unsigned long arg)
>> -{
>> -	struct efi_gettime __user *gettime_user;
>> -	struct efi_gettime  gettime;
>> -	efi_status_t status;
>> -	efi_time_cap_t cap;
>> -	efi_time_t efi_time;
>> -
>> -	gettime_user = (struct efi_gettime __user *)arg;
>> -	if (copy_from_user(&gettime, gettime_user, sizeof(gettime)))
>> -		return -EFAULT;
>> -
>> -	status = efi.get_time(gettime.time ? &efi_time : NULL,
>> -			      gettime.capabilities ? &cap : NULL);
>> -
>> -	if (put_user(status, gettime.status))
>> -		return -EFAULT;
>> -
>> -	if (status != EFI_SUCCESS)
>> -		return -EINVAL;
>> -
>> -	if (gettime.capabilities) {
>> -		efi_time_cap_t __user *cap_local;
>> -
>> -		cap_local = (efi_time_cap_t *)gettime.capabilities;
>> -		if (put_user(cap.resolution, &(cap_local->resolution)) ||
>> -			put_user(cap.accuracy, &(cap_local->accuracy)) ||
>> -			put_user(cap.sets_to_zero, &(cap_local->sets_to_zero)))
>> -			return -EFAULT;
>> -	}
>> -	if (gettime.time) {
>> -		if (copy_to_user(gettime.time, &efi_time, sizeof(efi_time_t)))
>> -			return -EFAULT;
>> -	}
>> -
>> -	return 0;
>> -}
>> -
>> -static long efi_runtime_set_time(unsigned long arg)
>> -{
>> -	struct efi_settime __user *settime_user;
>> -	struct efi_settime settime;
>> -	efi_status_t status;
>> -	efi_time_t efi_time;
>> -
>> -	settime_user = (struct efi_settime __user *)arg;
>> -	if (copy_from_user(&settime, settime_user, sizeof(settime)))
>> -		return -EFAULT;
>> -	if (copy_from_user(&efi_time, settime.time,
>> -					sizeof(efi_time_t)))
>> -		return -EFAULT;
>> -	status = efi.set_time(&efi_time);
>> -
>> -	if (put_user(status, settime.status))
>> -		return -EFAULT;
>> -
>> -	return status == EFI_SUCCESS ? 0 : -EINVAL;
>> -}
>> -
>> -static long efi_runtime_get_waketime(unsigned long arg)
>> -{
>> -	struct efi_getwakeuptime __user *getwakeuptime_user;
>> -	struct efi_getwakeuptime getwakeuptime;
>> -	efi_bool_t enabled, pending;
>> -	efi_status_t status;
>> -	efi_time_t efi_time;
>> -
>> -	getwakeuptime_user = (struct efi_getwakeuptime __user *)arg;
>> -	if (copy_from_user(&getwakeuptime, getwakeuptime_user,
>> -				sizeof(getwakeuptime)))
>> -		return -EFAULT;
>> -
>> -	status = efi.get_wakeup_time(
>> -		getwakeuptime.enabled ? (efi_bool_t *)&enabled : NULL,
>> -		getwakeuptime.pending ? (efi_bool_t *)&pending : NULL,
>> -		getwakeuptime.time ? &efi_time : NULL);
>> -
>> -	if (put_user(status, getwakeuptime.status))
>> -		return -EFAULT;
>> -
>> -	if (status != EFI_SUCCESS)
>> -		return -EINVAL;
>> -
>> -	if (getwakeuptime.enabled && put_user(enabled,
>> -						getwakeuptime.enabled))
>> -		return -EFAULT;
>> -
>> -	if (getwakeuptime.time) {
>> -		if (copy_to_user(getwakeuptime.time, &efi_time,
>> -				sizeof(efi_time_t)))
>> -			return -EFAULT;
>> -	}
>> -
>> -	return 0;
>> -}
>> -
>> -static long efi_runtime_set_waketime(unsigned long arg)
>> -{
>> -	struct efi_setwakeuptime __user *setwakeuptime_user;
>> -	struct efi_setwakeuptime setwakeuptime;
>> -	efi_bool_t enabled;
>> -	efi_status_t status;
>> -	efi_time_t efi_time;
>> -
>> -	setwakeuptime_user = (struct efi_setwakeuptime __user *)arg;
>> -
>> -	if (copy_from_user(&setwakeuptime, setwakeuptime_user,
>> -				sizeof(setwakeuptime)))
>> -		return -EFAULT;
>> -
>> -	enabled = setwakeuptime.enabled;
>> -	if (setwakeuptime.time) {
>> -		if (copy_from_user(&efi_time, setwakeuptime.time,
>> -					sizeof(efi_time_t)))
>> -			return -EFAULT;
>> -
>> -		status = efi.set_wakeup_time(enabled, &efi_time);
>> -	} else
>> -		status = efi.set_wakeup_time(enabled, NULL);
>> -
>> -	if (put_user(status, setwakeuptime.status))
>> -		return -EFAULT;
>> -
>> -	return status == EFI_SUCCESS ? 0 : -EINVAL;
>> -}
>> -
>> -static long efi_runtime_get_nextvariablename(unsigned long arg)
>> -{
>> -	struct efi_getnextvariablename __user *getnextvariablename_user;
>> -	struct efi_getnextvariablename getnextvariablename;
>> -	unsigned long name_size, prev_name_size = 0, *ns = NULL;
>> -	efi_status_t status;
>> -	efi_guid_t *vd = NULL;
>> -	efi_guid_t vendor_guid;
>> -	efi_char16_t *name = NULL;
>> -	int rv = 0;
>> -
>> -	getnextvariablename_user = (struct efi_getnextvariablename __user *)arg;
>> -
>> -	if (copy_from_user(&getnextvariablename, getnextvariablename_user,
>> -			   sizeof(getnextvariablename)))
>> -		return -EFAULT;
>> -
>> -	if (getnextvariablename.variable_name_size) {
>> -		if (get_user(name_size, getnextvariablename.variable_name_size))
>> -			return -EFAULT;
>> -		ns = &name_size;
>> -		prev_name_size = name_size;
>> -	}
>> -
>> -	if (getnextvariablename.vendor_guid) {
>> -		if (copy_from_user(&vendor_guid,
>> -				getnextvariablename.vendor_guid,
>> -				sizeof(vendor_guid)))
>> -			return -EFAULT;
>> -		vd = &vendor_guid;
>> -	}
>> -
>> -	if (getnextvariablename.variable_name) {
>> -		size_t name_string_size = 0;
>> -
>> -		rv = get_ucs2_strsize_from_user(
>> -				getnextvariablename.variable_name,
>> -				&name_string_size);
>> -		if (rv)
>> -			return rv;
>> -		/*
>> -		 * The name_size may be smaller than the real buffer size where
>> -		 * variable name located in some use cases. The most typical
>> -		 * case is passing a 0 to get the required buffer size for the
>> -		 * 1st time call. So we need to copy the content from user
>> -		 * space for at least the string size of variable name, or else
>> -		 * the name passed to UEFI may not be terminated as we expected.
>> -		 */
>> -		rv = copy_ucs2_from_user_len(&name,
>> -				getnextvariablename.variable_name,
>> -				prev_name_size > name_string_size ?
>> -				prev_name_size : name_string_size);
>> -		if (rv)
>> -			return rv;
>> -	}
>> -
>> -	status = efi.get_next_variable(ns, name, vd);
>> -
>> -	if (put_user(status, getnextvariablename.status)) {
>> -		rv = -EFAULT;
>> -		goto out;
>> -	}
>> -
>> -	if (status != EFI_SUCCESS) {
>> -		if (status == EFI_BUFFER_TOO_SMALL) {
>> -			if (ns && put_user(*ns,
>> -				getnextvariablename.variable_name_size)) {
>> -				rv = -EFAULT;
>> -				goto out;
>> -			}
>> -		}
>> -		rv = -EINVAL;
>> -		goto out;
>> -	}
>> -
>> -	if (name) {
>> -		if (copy_ucs2_to_user_len(getnextvariablename.variable_name,
>> -						name, prev_name_size)) {
>> -			rv = -EFAULT;
>> -			goto out;
>> -		}
>> -	}
>> -
>> -	if (ns) {
>> -		if (put_user(*ns, getnextvariablename.variable_name_size)) {
>> -			rv = -EFAULT;
>> -			goto out;
>> -		}
>> -	}
>> -
>> -	if (vd) {
>> -		if (copy_to_user(getnextvariablename.vendor_guid, vd,
>> -							sizeof(efi_guid_t)))
>> -			rv = -EFAULT;
>> -	}
>> -
>> -out:
>> -	kfree(name);
>> -	return rv;
>> -}
>> -
>> -static long efi_runtime_get_nexthighmonocount(unsigned long arg)
>> -{
>> -	struct efi_getnexthighmonotoniccount __user *getnexthighmonocount_user;
>> -	struct efi_getnexthighmonotoniccount getnexthighmonocount;
>> -	efi_status_t status;
>> -	u32 count;
>> -
>> -	getnexthighmonocount_user = (struct
>> -			efi_getnexthighmonotoniccount __user *)arg;
>> -
>> -	if (copy_from_user(&getnexthighmonocount,
>> -			   getnexthighmonocount_user,
>> -			   sizeof(getnexthighmonocount)))
>> -		return -EFAULT;
>> -
>> -	status = efi.get_next_high_mono_count(
>> -		getnexthighmonocount.high_count ? &count : NULL);
>> -
>> -	if (put_user(status, getnexthighmonocount.status))
>> -		return -EFAULT;
>> -
>> -	if (status != EFI_SUCCESS)
>> -		return -EINVAL;
>> -
>> -	if (getnexthighmonocount.high_count &&
>> -	    put_user(count, getnexthighmonocount.high_count))
>> -		return -EFAULT;
>> -
>> -	return 0;
>> -}
>> -
>> -static long efi_runtime_reset_system(unsigned long arg)
>> -{
>> -	struct efi_resetsystem __user *resetsystem_user;
>> -	struct efi_resetsystem resetsystem;
>> -	void *data = NULL;
>> -
>> -	resetsystem_user = (struct efi_resetsystem __user *)arg;
>> -	if (copy_from_user(&resetsystem, resetsystem_user,
>> -						sizeof(resetsystem)))
>> -		return -EFAULT;
>> -	if (resetsystem.data_size != 0) {
>> -		data = memdup_user((void *)resetsystem.data,
>> -						resetsystem.data_size);
>> -		if (IS_ERR(data))
>> -			return PTR_ERR(data);
>> -	}
>> -
>> -	efi.reset_system(resetsystem.reset_type, resetsystem.status,
>> -				resetsystem.data_size, (efi_char16_t *)data);
>> -
>> -	kfree(data);
>> -	return 0;
>> -}
>> -
>> -#if LINUX_VERSION_CODE >= KERNEL_VERSION(3, 1, 0)
>> -static long efi_runtime_query_variableinfo(unsigned long arg)
>> -{
>> -	struct efi_queryvariableinfo __user *queryvariableinfo_user;
>> -	struct efi_queryvariableinfo queryvariableinfo;
>> -	efi_status_t status;
>> -	u64 max_storage, remaining, max_size;
>> -
>> -	queryvariableinfo_user = (struct efi_queryvariableinfo __user *)arg;
>> -
>> -	if (copy_from_user(&queryvariableinfo, queryvariableinfo_user,
>> -			   sizeof(queryvariableinfo)))
>> -		return -EFAULT;
>> -
>> -	status = efi.query_variable_info(queryvariableinfo.attributes,
>> -					 &max_storage, &remaining, &max_size);
>> -
>> -	if (put_user(status, queryvariableinfo.status))
>> -		return -EFAULT;
>> -
>> -	if (status != EFI_SUCCESS)
>> -		return -EINVAL;
>> -
>> -	if (put_user(max_storage,
>> -		     queryvariableinfo.maximum_variable_storage_size))
>> -		return -EFAULT;
>> -
>> -	if (put_user(remaining,
>> -		     queryvariableinfo.remaining_variable_storage_size))
>> -		return -EFAULT;
>> -
>> -	if (put_user(max_size, queryvariableinfo.maximum_variable_size))
>> -		return -EFAULT;
>> -
>> -	return 0;
>> -}
>> -
>> -static long efi_runtime_query_capsulecaps(unsigned long arg)
>> -{
>> -	struct efi_querycapsulecapabilities __user *qcaps_user;
>> -	struct efi_querycapsulecapabilities qcaps;
>> -	efi_capsule_header_t *capsules;
>> -	efi_status_t status;
>> -	u64 max_size;
>> -	int i, reset_type;
>> -	int rv = 0;
>> -
>> -	qcaps_user = (struct efi_querycapsulecapabilities __user *)arg;
>> -
>> -	if (copy_from_user(&qcaps, qcaps_user, sizeof(qcaps)))
>> -		return -EFAULT;
>> -
>> -	capsules = kcalloc(qcaps.capsule_count + 1,
>> -			   sizeof(efi_capsule_header_t), GFP_KERNEL);
>> -	if (!capsules)
>> -		return -ENOMEM;
>> -
>> -	for (i = 0; i < qcaps.capsule_count; i++) {
>> -		efi_capsule_header_t *c;
>> -		/*
>> -		 * We cannot dereference qcaps.capsule_header_array directly to
>> -		 * obtain the address of the capsule as it resides in the
>> -		 * user space
>> -		 */
>> -		if (get_user(c, qcaps.capsule_header_array + i)) {
>> -			rv = -EFAULT;
>> -			goto out;
>> -		}
>> -		if (copy_from_user(&capsules[i], c,
>> -				sizeof(efi_capsule_header_t))) {
>> -			rv = -EFAULT;
>> -			goto out;
>> -		}
>> -	}
>> -
>> -	qcaps.capsule_header_array = &capsules;
>> -
>> -	status = efi.query_capsule_caps((efi_capsule_header_t **)
>> -					qcaps.capsule_header_array,
>> -					qcaps.capsule_count,
>> -					&max_size, &reset_type);
>> -
>> -	if (put_user(status, qcaps.status)) {
>> -		rv = -EFAULT;
>> -		goto out;
>> -	}
>> -
>> -	if (status != EFI_SUCCESS) {
>> -		rv = -EINVAL;
>> -		goto out;
>> -	}
>> -
>> -	if (put_user(max_size, qcaps.maximum_capsule_size)) {
>> -		rv = -EFAULT;
>> -		goto out;
>> -	}
>> -
>> -	if (put_user(reset_type, qcaps.reset_type))
>> -		rv = -EFAULT;
>> -
>> -out:
>> -	kfree(capsules);
>> -	return rv;
>> -}
>> -#endif
>> -
>> -static long efi_runtime_ioctl(struct file *file, unsigned int cmd,
>> -							unsigned long arg)
>> -{
>> -	switch (cmd) {
>> -	case EFI_RUNTIME_GET_VARIABLE:
>> -		return efi_runtime_get_variable(arg);
>> -
>> -	case EFI_RUNTIME_SET_VARIABLE:
>> -		return efi_runtime_set_variable(arg);
>> -
>> -	case EFI_RUNTIME_GET_TIME:
>> -		return efi_runtime_get_time(arg);
>> -
>> -	case EFI_RUNTIME_SET_TIME:
>> -		return efi_runtime_set_time(arg);
>> -
>> -	case EFI_RUNTIME_GET_WAKETIME:
>> -		return efi_runtime_get_waketime(arg);
>> -
>> -	case EFI_RUNTIME_SET_WAKETIME:
>> -		return efi_runtime_set_waketime(arg);
>> -
>> -	case EFI_RUNTIME_GET_NEXTVARIABLENAME:
>> -		return efi_runtime_get_nextvariablename(arg);
>> -
>> -	case EFI_RUNTIME_GET_NEXTHIGHMONOTONICCOUNT:
>> -		return efi_runtime_get_nexthighmonocount(arg);
>> -
>> -	case EFI_RUNTIME_RESET_SYSTEM:
>> -		return efi_runtime_reset_system(arg);
>> -
>> -#if LINUX_VERSION_CODE >= KERNEL_VERSION(3, 1, 0)
>> -	case EFI_RUNTIME_QUERY_VARIABLEINFO:
>> -		return efi_runtime_query_variableinfo(arg);
>> -
>> -	case EFI_RUNTIME_QUERY_CAPSULECAPABILITIES:
>> -		return efi_runtime_query_capsulecaps(arg);
>> -#endif
>> -	}
>> -
>> -	return -ENOTTY;
>> -}
>> -
>> -static int efi_runtime_open(struct inode *inode, struct file *file)
>> -{
>> -	/*
>> -	 * nothing special to do here
>> -	 * We do accept multiple open files at the same time as we
>> -	 * synchronize on the per call operation.
>> -	 */
>> -	return 0;
>> -}
>> -
>> -static int efi_runtime_close(struct inode *inode, struct file *file)
>> -{
>> -	return 0;
>> -}
>> -
>> -/*
>> - *	The various file operations we support.
>> - */
>> -static const struct file_operations efi_runtime_fops = {
>> -	.owner		= THIS_MODULE,
>> -	.unlocked_ioctl	= efi_runtime_ioctl,
>> -	.open		= efi_runtime_open,
>> -	.release	= efi_runtime_close,
>> -	.llseek		= no_llseek,
>> -};
>> -
>> -static struct miscdevice efi_runtime_dev = {
>> -	MISC_DYNAMIC_MINOR,
>> -	"efi_runtime",
>> -	&efi_runtime_fops
>> -};
>> -
>> -static int __init efi_runtime_init(void)
>> -{
>> -	int ret;
>> -
>> -	if (!EFI_RUNTIME_ENABLED) {
>> -		pr_err("EFI runtime services not enabled.\n");
>> -		return -ENODEV;
>> -	}
>> -
>> -	ret = misc_register(&efi_runtime_dev);
>> -	if (ret) {
>> -		pr_err("efi_runtime: can't misc_register on minor=%d\n",
>> -			MISC_DYNAMIC_MINOR);
>> -		return ret;
>> -	}
>> -
>> -	return 0;
>> -}
>> -
>> -static void __exit efi_runtime_exit(void)
>> -{
>> -	misc_deregister(&efi_runtime_dev);
>> -}
>> -
>> -module_init(efi_runtime_init);
>> -module_exit(efi_runtime_exit);
>> -
>> diff --git a/efi_runtime/efi_runtime.h b/efi_runtime/efi_runtime.h
>> deleted file mode 100644
>> index 1d9936b..0000000
>> --- a/efi_runtime/efi_runtime.h
>> +++ /dev/null
>> @@ -1,135 +0,0 @@
>> -/*
>> - * EFI Runtime driver
>> - *
>> - * Copyright(C) 2012-2019 Canonical Ltd.
>> - *
>> - *  This program is free software; you can redistribute it and/or modify
>> - *  it under the terms of the GNU General Public License as published by
>> - *  the Free Software Foundation; either version 2 of the License, or
>> - *  (at your option) any later version.
>> - *
>> - *  This program is distributed in the hope that it will be useful,
>> - *  but WITHOUT ANY WARRANTY; without even the implied warranty of
>> - *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
>> - *  GNU General Public License for more details.
>> - *
>> - *  You should have received a copy of the GNU General Public License
>> - *  along with this program; if not, write to the Free Software
>> - *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
>> - *  USA.
>> - */
>> -
>> -#ifndef _EFI_RUNTIME_H_
>> -#define _EFI_RUNTIME_H_
>> -
>> -#include <linux/efi.h>
>> -
>> -struct efi_getvariable {
>> -	efi_char16_t	*variable_name;
>> -	efi_guid_t	*vendor_guid;
>> -	u32		*attributes;
>> -	unsigned long	*data_size;
>> -	void		*data;
>> -	efi_status_t	*status;
>> -} __packed;
>> -
>> -struct efi_setvariable {
>> -	efi_char16_t	*variable_name;
>> -	efi_guid_t	*vendor_guid;
>> -	u32		attributes;
>> -	unsigned long	data_size;
>> -	void		*data;
>> -	efi_status_t	*status;
>> -} __packed;
>> -
>> -struct efi_getnextvariablename {
>> -	unsigned long	*variable_name_size;
>> -	efi_char16_t	*variable_name;
>> -	efi_guid_t	*vendor_guid;
>> -	efi_status_t	*status;
>> -} __packed;
>> -
>> -struct efi_queryvariableinfo {
>> -	u32		attributes;
>> -	u64		*maximum_variable_storage_size;
>> -	u64		*remaining_variable_storage_size;
>> -	u64		*maximum_variable_size;
>> -	efi_status_t	*status;
>> -} __packed;
>> -
>> -struct efi_gettime {
>> -	efi_time_t	*time;
>> -	efi_time_cap_t	*capabilities;
>> -	efi_status_t	*status;
>> -} __packed;
>> -
>> -struct efi_settime {
>> -	efi_time_t	*time;
>> -	efi_status_t	*status;
>> -} __packed;
>> -
>> -struct efi_getwakeuptime {
>> -	efi_bool_t	*enabled;
>> -	efi_bool_t	*pending;
>> -	efi_time_t	*time;
>> -	efi_status_t	*status;
>> -} __packed;
>> -
>> -struct efi_setwakeuptime {
>> -	efi_bool_t	enabled;
>> -	efi_time_t	*time;
>> -	efi_status_t	*status;
>> -} __packed;
>> -
>> -struct efi_getnexthighmonotoniccount {
>> -	u32		*high_count;
>> -	efi_status_t	*status;
>> -} __packed;
>> -
>> -struct efi_querycapsulecapabilities {
>> -	efi_capsule_header_t	**capsule_header_array;
>> -	unsigned long		capsule_count;
>> -	u64			*maximum_capsule_size;
>> -	int			*reset_type;
>> -	efi_status_t		*status;
>> -} __packed;
>> -
>> -struct efi_resetsystem {
>> -	int			reset_type;
>> -	efi_status_t		status;
>> -	unsigned long		data_size;
>> -	efi_char16_t		*data;
>> -} __packed;
>> -
>> -/* ioctl calls that are permitted to the /dev/efi_runtime interface. */
>> -#define EFI_RUNTIME_GET_VARIABLE \
>> -	_IOWR('p', 0x01, struct efi_getvariable)
>> -#define EFI_RUNTIME_SET_VARIABLE \
>> -	_IOW('p', 0x02, struct efi_setvariable)
>> -
>> -#define EFI_RUNTIME_GET_TIME \
>> -	_IOR('p', 0x03, struct efi_gettime)
>> -#define EFI_RUNTIME_SET_TIME \
>> -	_IOW('p', 0x04, struct efi_settime)
>> -
>> -#define EFI_RUNTIME_GET_WAKETIME \
>> -	_IOR('p', 0x05, struct efi_getwakeuptime)
>> -#define EFI_RUNTIME_SET_WAKETIME \
>> -	_IOW('p', 0x06, struct efi_setwakeuptime)
>> -
>> -#define EFI_RUNTIME_GET_NEXTVARIABLENAME \
>> -	_IOWR('p', 0x07, struct efi_getnextvariablename)
>> -
>> -#define EFI_RUNTIME_QUERY_VARIABLEINFO \
>> -	_IOR('p', 0x08, struct efi_queryvariableinfo)
>> -
>> -#define EFI_RUNTIME_GET_NEXTHIGHMONOTONICCOUNT \
>> -	_IOR('p', 0x09, struct efi_getnexthighmonotoniccount)
>> -
>> -#define EFI_RUNTIME_QUERY_CAPSULECAPABILITIES \
>> -	_IOR('p', 0x0A, struct efi_querycapsulecapabilities)
>> -
>> -#define EFI_RUNTIME_RESET_SYSTEM \
>> -	_IOW('p', 0x0B, struct efi_resetsystem)
>> -
>> -#endif /* _EFI_RUNTIME_H_ */
>>
> It may be a better idea to just remove this from the packaging and keep
> the driver for users who build and run fwts on older systems.

Actually, I also maintain efi_runtime on my github.

But, you are right, it is good idea to keep the driver in fwts as well.

I'll send out another patch.


Ivan


>
> Colin
>



More information about the fwts-devel mailing list