x86/microcode: Refactor Intel microcode loading
Subsystems (2)
PATCH 1/1 x86/microcode: Refactor Intel microcode loading
This changes generic_load_microcode() to use the iov_iter API instead of an open-coded version. This allows us to avoid explicitly casting between user and kernel pointers.
Because the iov_iter API makes it hard to read the same location twice, as a side effect, this also fixes a double-read of the microcode header (which could e.g. lead to out-of-bounds reads in microcode_sanity_check()). Not that it matters much, only root can do this anyway...
---
I have tested that with this patch applied, microcode loading still works both via "iucode-tool -k" and via /sys/devices/system/cpu/microcode/reload.
arch/x86/kernel/cpu/microcode/intel.c | 64 +++++++++++++-------------- 1 file changed, 32 insertions(+), 32 deletions(-)
arch/x86/kernel/cpu/microcode/intel.c +32 -32
@@ -31,6 +31,7 @@#include <linux/kernel.h> #include <linux/slab.h> #include <linux/cpu.h> +#include <linux/uio.h> #include <linux/mm.h> #include <asm/microcode_intel.h>
@@ -861,32 +862,33 @@ static enum ucode_state apply_microcode_intel(int cpu)return ret; } -static enum ucode_state generic_load_microcode (int cpu,void *data,size_t size, -int (*get_ucode_data)(void *,const void *,size_t )) +static enum ucode_state generic_load_microcode (int cpu,struct iov_iter *iter) {struct ucode_cpu_info *uci = ucode_cpu_info + cpu; -u8 *ucode_ptr = data, *new_mc =NULL , *mc =NULL ; +u8 *new_mc =NULL , *mc =NULL ;int new_rev = uci->cpu_sig.rev; -unsigned int leftover = size;unsigned int curr_mc_size =0 , new_mc_size =0 ;unsigned int csig, cpf;enum ucode_state ret =UCODE_OK ; -while (leftover) { +while (iov_iter_count (iter)) {struct microcode_header_intel mc_header; -unsigned int mc_size; +unsigned int mc_size, data_size; +u8 *data; -if (leftover <sizeof (mc_header)) { -pr_err ("error! Truncated header in microcode data file\n" ); +if (!copy_from_iter_full (&mc_header,sizeof (mc_header), iter)) { +pr_err ("error! Truncated or inaccessible header in microcode data\n" );break ; } -if (get_ucode_data (&mc_header, ucode_ptr,sizeof (mc_header))) -break ; - mc_size =get_totalsize (&mc_header); -if (!mc_size || mc_size > leftover) { -pr_err ("error! Bad data in microcode data file\n" ); +if (mc_size <sizeof (mc_header)) { +pr_err ("error! Bad data in microcode data file (totalsize too small)\n" ); +break ; + } + data_size = mc_size -sizeof (mc_header); +if (data_size >iov_iter_count (iter)) { +pr_err ("error! Bad data in microcode data file (truncated file?)\n" );break ; }
@@ -899,7 +901,9 @@ static enum ucode_state generic_load_microcode(int cpu, void *data, size_t size, curr_mc_size = mc_size; } -if (get_ucode_data (mc, ucode_ptr, mc_size) || +memcpy (mc, &mc_header,sizeof (mc_header)); + data = mc +sizeof (mc_header); +if (!copy_from_iter_full (data, data_size, iter) ||microcode_sanity_check (mc,1 ) <0 ) {break ; }
@@ -914,14 +918,11 @@ static enum ucode_state generic_load_microcode(int cpu, void *data, size_t size, mc =NULL ;/* trigger new vmalloc */ ret =UCODE_NEW ; } - - ucode_ptr += mc_size; - leftover -= mc_size; }vfree (mc); -if (leftover) { +if (iov_iter_count (iter)) {vfree (new_mc);return UCODE_ERROR ; }
@@ -945,12 +946,6 @@ static enum ucode_state generic_load_microcode(int cpu, void *data, size_t size,return ret; } -static int get_ucode_fw (void *to,const void *from,size_t n) -{ -memcpy (to, from, n); -return 0 ; -} -static bool is_blacklisted (unsigned int cpu) {struct cpuinfo_x86 *c = &cpu_data (cpu);
@@ -981,6 +976,8 @@ static enum ucode_state request_microcode_fw(int cpu, struct device *device,struct cpuinfo_x86 *c = &cpu_data (cpu);const struct firmware *firmware;enum ucode_state ret; +struct kvec kvec; +struct iov_iter iter;if (is_blacklisted (cpu))return UCODE_NFOUND ;
@@ -993,26 +990,29 @@ static enum ucode_state request_microcode_fw(int cpu, struct device *device,return UCODE_NFOUND ; } - ret =generic_load_microcode (cpu, (void *)firmware->data, - firmware->size, &get_ucode_fw); + kvec.iov_base = (void *)firmware->data; + kvec.iov_len = firmware->size; +iov_iter_kvec (&iter,WRITE , &kvec,1 , firmware->size); + ret =generic_load_microcode (cpu, &iter);release_firmware (firmware);return ret; } -static int get_ucode_user (void *to,const void *from,size_t n) -{ -return copy_from_user (to, from, n); -} -static enum ucode_state request_microcode_user (int cpu,const void __user *buf,size_t size) { +struct iovec iov; +struct iov_iter iter; +if (is_blacklisted (cpu))return UCODE_NFOUND ; -return generic_load_microcode (cpu, (void *)buf, size, &get_ucode_user); + iov.iov_base = (void __user *)buf; + iov.iov_len = size; +iov_iter_init (&iter,WRITE , &iov,1 , size); +return generic_load_microcode (cpu, &iter); }static struct microcode_ops microcode_intel_ops = {
Signature · 1 line
2.21.0.392.gf8f6787159e-goog
Borislav Petkov
maintainerQuoted 9 lines · Jann Horn
This changes
generic_load_microcode()to use theiov_iterAPI instead of an open-coded version. This allows us to avoid explicitly casting between user and kernel pointers.Because the
iov_iterAPI makes it hard to read the same location twice, as a side effect, this also fixes a double-read of the microcode header (which could e.g. lead to out-of-bounds reads inmicrocode_sanity_check()). Not that it matters much, only root can do this anyway...
Quoted 5 lines
Signed-off-by Jann Horn <[email protected]>---
I have tested that with this patch applied, microcode loading still works both via "iucode-tool -k" and via/sys/devices/system/cpu/microcode/reload.
Yeah, this cannot have worked because I think I broke it recently and you'd need this:
---
arch/x86/kernel/cpu/microcode/core.c +2 -1
@@ -418,8 +418,9 @@ static int do_microcode_update(const void __user *buf, size_t size)if (ustate ==UCODE_ERROR ) { error =-1 ;break ; - }else if (ustate ==UCODE_OK ) + }else if (ustate ==UCODE_NEW ) {apply_microcode_on_target (cpu); + } }return error;
---
Regardless, I'll take care of it. Thanks a lot for doing this cleanup, it looks really cool and nicely clean - exactly how I envisioned it. :-)
I'll test it more later with the above fix and apply it.
Thx.
Signature · 4 lines
Regards/Gruss,
Boris.
Good mailing practices for 400: avoid top-posting and trim the reply.Quoted 11 lines · Borislav Petkov
Quoted 9 lines · Jann Horn
This changes
generic_load_microcode()to use theiov_iterAPI instead of an open-coded version. This allows us to avoid explicitly casting between user and kernel pointers.Because the
iov_iterAPI makes it hard to read the same location twice, as a side effect, this also fixes a double-read of the microcode header (which could e.g. lead to out-of-bounds reads inmicrocode_sanity_check()). Not that it matters much, only root can do this anyway...
Quoted 8 lines
Quoted 5 lines
Signed-off-by Jann Horn <[email protected]>---
I have tested that with this patch applied, microcode loading still works both via "iucode-tool -k" and via/sys/devices/system/cpu/microcode/reload.Yeah, this cannot have worked because I think I broke it recently and you'd need this:
Uuuh. I *definitely* tested this. I ran this yesterday evening on my home machine, on top of commit 14c741de93861749dfb60b4964028541f5c506ca from Linus' tree, plus two cherry-picked fixes for drm/ttm. I specifically made sure that I had the old microcode version before reloading these ways and I had the new version after reloading. And the verbose dmesg logs also looked okay.
Quoted 30 lines
---
arch/x86/kernel/cpu/microcode/core.c +2
-2@@ -418,8 +418,9 @@ static int do_microcode_update(const void __user *buf, size_t size)if (ustate ==UCODE_ERROR ) { error =-1 ;break ; - }else if (ustate ==UCODE_OK ) + }else if (ustate ==UCODE_NEW ) {apply_microcode_on_target (cpu); + } }return error; ---Regardless, I'll take care of it. Thanks a lot for doing this cleanup, it looks really cool and nicely clean - exactly how I envisioned it. :-)
I'll test it more later with the above fix and apply it.
Thx.
--
Regards/Gruss,
Boris.Good mailing practices for 400: avoid top-posting and trim the reply.
Borislav Petkov
maintainerQuoted 7 lines · Jann Horn
Uuuh. I *definitely* tested this. I ran this yesterday evening on my home machine, on top of commit
14c741de93861749dfb60b4964028541f5c506cafrom Linus' tree, plus two cherry-picked fixes for drm/ttm. I specifically made sure that I had the old microcode version before reloading these ways and I had the new version after reloading. And the verbose dmesg logs also looked okay.
How did you check the microcode revision before and after? /proc/cpuinfo?
Because that old method doesn't say anything in dmesg if there's no debugging output, only the iucode_tool says something like the below if you enable verbose output:
# iucode-tool -v --kernel=/dev/cpu/microcode /lib/firmware/intel-ucode/06-3a-09 iucode-tool: processed 1 valid microcode(s), 1 signature(s), 1 unique signature(s) iucode-tool: selected 1 microcode(s), 1 signature(s) iucode-tool: Uploading selected microcodes to: /dev/cpu/microcode iucode-tool: /dev/cpu/microcode: 1 microcode entries uploaded, 13312 bytes
Signature · 4 lines
Regards/Gruss,
Boris.
Good mailing practices for 400: avoid top-posting and trim the reply.Quoted 15 lines · Borislav Petkov
Quoted 7 lines · Jann Horn
Uuuh. I *definitely* tested this. I ran this yesterday evening on my home machine, on top of commit
14c741de93861749dfb60b4964028541f5c506cafrom Linus' tree, plus two cherry-picked fixes for drm/ttm. I specifically made sure that I had the old microcode version before reloading these ways and I had the new version after reloading. And the verbose dmesg logs also looked okay.How did you check the microcode revision before and after?
/proc/cpuinfo?Because that old method doesn't say anything in dmesg if there's no debugging output, only the
iucode_toolsays something like the below if you enable verbose output:
Quoted 5 lines
# iucode-tool -v --kernel=/dev/cpu/microcode /lib/firmware/intel-ucode/06-3a-09 iucode-tool: processed 1 valid microcode(s), 1 signature(s), 1 unique signature(s) iucode-tool: selected 1 microcode(s), 1 signature(s) iucode-tool: Uploading selected microcodes to: /dev/cpu/microcode iucode-tool: /dev/cpu/microcode: 1 microcode entries uploaded, 13312 bytes
Ah, dammit. I'm re-testing it now, and as you said, the microcode isn't actually loading. I was testing with arch/x86/kernel/cpu/{core,intel}.c added to /sys/kernel/debug/dynamic_debug/control, I guess I must have decided that it worked when I saw this:
[ 159.485550] microcode: CPU0 found a matching microcode update with version 0x25 (current=0x19) [ 159.485588] microcode: CPU1 found a matching microcode update with version 0x25 (current=0x19) [ 159.485615] microcode: CPU2 found a matching microcode update with version 0x25 (current=0x19) [ 159.485640] microcode: CPU3 found a matching microcode update with version 0x25 (current=0x19) [ 159.485664] microcode: CPU4 found a matching microcode update with version 0x25 (current=0x19) [ 159.485689] microcode: CPU5 found a matching microcode update with version 0x25 (current=0x19) [ 159.485713] microcode: CPU6 found a matching microcode update with version 0x25 (current=0x19) [ 159.485731] microcode: CPU7 found a matching microcode update with
version 0x25 (current=0x19)
I thought I had checked /sys/devices/system/cpu/cpu0/microcode/version afterwards. But apparently I didn't. Bleh. Sorry about that.
Borislav Petkov
maintainerQuoted 2 lines · Jann Horn
[ 159.485731] microcode: CPU7 found a matching microcode update withversion
0x25(current=0x19)
Yeah, that printk can be kinda misleading :)
Quoted 2 lines
I thought I had checked
/sys/devices/system/cpu/cpu0/microcode/versionafterwards. But apparently I didn't. Bleh. Sorry about that.
No worries at all, now at least it is all clear what's happening. I was beginning to recheck what I'm seeing here too.
And I can finally deprecate this ancient method which is just as kaputtski because it is happening as late as the late loading method when you do
echo 1 > /sys/devices/system/cpu/microcode/reload
---
arch/x86/Kconfig +9 -1
@@ -1330,8 +1330,16 @@ config MICROCODE_AMD processors will be enabled. config MICROCODE_OLD_INTERFACE - def_bool y + bool "Ancient loading interface (DEPRECATED)" + default n depends on MICROCODE + ---help--- + DO NOT USE THIS! This is the ancient /dev/cpu/microcode interface + which was used by userspace tools like iucode_tool and microcode.ctl. + It is inadequate because it runs too late to be able to properly + load microcode on a machine and it needs special tools. Instead, you + should've switched to the early loading method with the initrd or + builtin microcode by now: Documentation/x86/microcode.txt config X86_MSR tristate "/dev/cpu/*/msr - Model-specific register support"
---
I'll test some more and post later.
Thx!
Signature · 4 lines
Regards/Gruss,
Boris.
Good mailing practices for 400: avoid top-posting and trim the reply.tip-bot for Jann Horn
merge bot[tip:x86/microcode] x86/microcode/intel: Refactor Intel microcode blob loading
In reply to Jann Hornx86/microcode/intel: Refactor Intel microcode blob loading
Commit-ID: 7e94a7b659eefedda82cde97229a26f319fb1182 Gitweb: https://git.kernel.org/tip/7e94a7b659eefedda82cde97229a26f319fb1182 Author: Jann Horn <[email protected]> AuthorDate: Thu, 4 Apr 2019 13:11:28 +0200 Committer: Borislav Petkov <[email protected]> CommitDate: Wed, 10 Apr 2019 22:40:25 +0200
x86/microcode/intel: Refactor Intel microcode blob loading
Change generic_load_microcode() to use the iov_iter API instead of a clumsy open-coded version which has to pay attention to __user data or kernel data, depending on the loading method. This allows to avoid explicit casting between user and kernel pointers.
Because the iov_iter API makes it hard to read the same location twice, as a side effect, also fix a double-read of the microcode header (which could e.g. lead to out-of-bounds reads in microcode_sanity_check()).
Not that it matters much, only root is allowed to load microcode anyway...
[ bp: Massage a bit, sort function-local variables. ]
--- arch/x86/kernel/cpu/microcode/intel.c | 71 ++++++++++++++++++----------------- 1 file changed, 36 insertions(+), 35 deletions(-)
arch/x86/kernel/cpu/microcode/intel.c +36 -35
@@ -31,6 +31,7 @@#include <linux/kernel.h> #include <linux/slab.h> #include <linux/cpu.h> +#include <linux/uio.h> #include <linux/mm.h> #include <asm/microcode_intel.h>
@@ -861,32 +862,33 @@ out:return ret; } -static enum ucode_state generic_load_microcode (int cpu,void *data,size_t size, -int (*get_ucode_data)(void *,const void *,size_t )) +static enum ucode_state generic_load_microcode (int cpu,struct iov_iter *iter) {struct ucode_cpu_info *uci = ucode_cpu_info + cpu; -u8 *ucode_ptr = data, *new_mc =NULL , *mc =NULL ; -int new_rev = uci->cpu_sig.rev; -unsigned int leftover = size;unsigned int curr_mc_size =0 , new_mc_size =0 ; -unsigned int csig, cpf;enum ucode_state ret =UCODE_OK ; +int new_rev = uci->cpu_sig.rev; +u8 *new_mc =NULL , *mc =NULL ; +unsigned int csig, cpf; -while (leftover) { +while (iov_iter_count (iter)) {struct microcode_header_intel mc_header; -unsigned int mc_size; +unsigned int mc_size, data_size; +u8 *data; -if (leftover <sizeof (mc_header)) { -pr_err ("error! Truncated header in microcode data file\n" ); +if (!copy_from_iter_full (&mc_header,sizeof (mc_header), iter)) { +pr_err ("error! Truncated or inaccessible header in microcode data file\n" );break ; } -if (get_ucode_data (&mc_header, ucode_ptr,sizeof (mc_header))) -break ; - mc_size =get_totalsize (&mc_header); -if (!mc_size || mc_size > leftover) { -pr_err ("error! Bad data in microcode data file\n" ); +if (mc_size <sizeof (mc_header)) { +pr_err ("error! Bad data in microcode data file (totalsize too small)\n" ); +break ; + } + data_size = mc_size -sizeof (mc_header); +if (data_size >iov_iter_count (iter)) { +pr_err ("error! Bad data in microcode data file (truncated file?)\n" );break ; }
@@ -899,7 +901,9 @@ static enum ucode_state generic_load_microcode(int cpu, void *data, size_t size, curr_mc_size = mc_size; } -if (get_ucode_data (mc, ucode_ptr, mc_size) || +memcpy (mc, &mc_header,sizeof (mc_header)); + data = mc +sizeof (mc_header); +if (!copy_from_iter_full (data, data_size, iter) ||microcode_sanity_check (mc,1 ) <0 ) {break ; }
@@ -914,14 +918,11 @@ static enum ucode_state generic_load_microcode(int cpu, void *data, size_t size, mc =NULL ;/* trigger new vmalloc */ ret =UCODE_NEW ; } - - ucode_ptr += mc_size; - leftover -= mc_size; }vfree (mc); -if (leftover) { +if (iov_iter_count (iter)) {vfree (new_mc);return UCODE_ERROR ; }
@@ -945,12 +946,6 @@ static enum ucode_state generic_load_microcode(int cpu, void *data, size_t size,return ret; } -static int get_ucode_fw (void *to,const void *from,size_t n) -{ -memcpy (to, from, n); -return 0 ; -} -static bool is_blacklisted (unsigned int cpu) {struct cpuinfo_x86 *c = &cpu_data (cpu);
@@ -977,10 +972,12 @@ static bool is_blacklisted(unsigned int cpu)static enum ucode_state request_microcode_fw (int cpu,struct device *device,bool refresh_fw) { -char name[30 ];struct cpuinfo_x86 *c = &cpu_data (cpu);const struct firmware *firmware; +struct iov_iter iter;enum ucode_state ret; +struct kvec kvec; +char name[30 ];if (is_blacklisted (cpu))return UCODE_NFOUND ;
@@ -993,26 +990,30 @@ static enum ucode_state request_microcode_fw(int cpu, struct device *device,return UCODE_NFOUND ; } - ret =generic_load_microcode (cpu, (void *)firmware->data, - firmware->size, &get_ucode_fw); + kvec.iov_base = (void *)firmware->data; + kvec.iov_len = firmware->size; +iov_iter_kvec (&iter,WRITE , &kvec,1 , firmware->size); + ret =generic_load_microcode (cpu, &iter);release_firmware (firmware);return ret; } -static int get_ucode_user (void *to,const void *from,size_t n) -{ -return copy_from_user (to, from, n); -} -static enum ucode_state request_microcode_user (int cpu,const void __user *buf,size_t size) { +struct iov_iter iter; +struct iovec iov; +if (is_blacklisted (cpu))return UCODE_NFOUND ; -return generic_load_microcode (cpu, (void *)buf, size, &get_ucode_user); + iov.iov_base = (void __user *)buf; + iov.iov_len = size; +iov_iter_init (&iter,WRITE , &iov,1 , size); + +return generic_load_microcode (cpu, &iter); }static struct microcode_ops microcode_intel_ops = {