Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated support for SHIM on RISC-V #641

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

brianredbeard
Copy link

Add what is needed to build on riscv64.

Signed-off-by: Heinrich Schuchardt [email protected]

This is an update which supersedes #420 which brings it in alignment with the current upstream and fixes a minor style nit around the definition of __riscv.

Add what is needed to build on riscv64.

Signed-off-by: Heinrich Schuchardt <[email protected]>

This is an update to rhboot#420 which brings it in alignment with the current
upstream.

Signed-off-by: Brian 'redbeard' Harrington <[email protected]>
@brianredbeard
Copy link
Author

@vathpela can we get a review?

@brianredbeard
Copy link
Author

FYI, reverted the previous commit after a discussion with @xypron. Heinrich helpfully pointed out that the structure of pre-processor definitions in the form of __riscv is (tragically) required due to definitions in GCC.

@davidlt
Copy link

davidlt commented Mar 25, 2024

FYI gnu-efi ( https://github.com/rhboot/gnu-efi/tree/master ) has been rebased to 3.0.18 (released 3 days ago!). The builds are already available for F40 and F41 in Fedora too:
F40: https://koji.fedoraproject.org/koji/buildinfo?buildID=2426104
F41: https://koji.fedoraproject.org/koji/buildinfo?buildID=2426088

Make.defaults Outdated
ARCH_GNUEFI ?= riscv64
ARCH_SUFFIX ?= riscv64
ARCH_SUFFIX_UPPER ?= RISCV64
FORMAT := -O binary
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We had some discussions with Peter Jones last year. There was a strong preference not to add more "-O binary" architectures. Two patches landed in binutils 2.42:
[PATCH] Add basic support for RISC-V 64-bit EFI objects
[PATCH] Handle "efi-app-riscv64" and similar targets in objcopy. // From Peter Jones

That means we have efi-app-riscv64 support. That probably means it should look more like aarch64. I haven't looked deeper or tested it.

Copy link
Contributor

@xypron xypron Mar 26, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@davidlt Shim has an .sbat section with the contents of a CSV file for defining the security patch level. How would you create that section with binutils' efi-app-riscv64 target?

The content of the .sbat section is something like:

sbat,1,SBAT Version,sbat,1,https://github.com/rhboot/shim/blob/main/SBAT.md
shim,4,UEFI shim,shim,1,https://github.com/rhboot/shim
shim.ubuntu,1,Ubuntu,shim,15.8-0ubuntu1,https://www.ubuntu.com/

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It really seems that the lines

+     FORMAT                  := -O binary
+     SUBSYSTEM               := 0xa
+     ARCH_LDFLAGS            += --defsym=EFI_SUBSYSTEM=$(SUBSYSTEM)
+     TIMESTAMP_LOCATION      := 72

are not needed. SUBSYSTEM defaults to 0x0a in branch main of https://github.com/rhboot/gnu-efi.git:

gnu-efi/gnuefi/crt0-efi-riscv64.S:20:
#define EFI_SUBSYSTEM 10

TIMESTAMP_LOCATION is unused.

FORMAT is a flag passed to riscv64-linux-gnu-objcopy which seems unneded.

@brianredbeard Could you please drop the lines from your merge request.

@davidlt and @xypron pointed out prior changed to binutils 2.42 which
added support for RISC-V EFI objects.  This reflects the upstream
preference to avoid adding additional architectures which are emitting
flat binary files via `objcopy` (i.e. `-O binary` architectures).
@davidlt
Copy link

davidlt commented Mar 27, 2024

The last commit is missing Signed-off-by: based on the review. How sure how important that is.

@@ -128,6 +128,21 @@
#endif
#endif

#if defined(__riscv) && __riscv_xlen == 64
#ifndef DEFAULT_LOADER
#define DEFAULT_LOADER L"\\grubriscv64.efi"

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't the file name be shorter (as in 8.3 format) given a FAT filesystem?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • FAT supports long file names since Windows 95.
  • The default name for EFI binaries on RISC-V is /EFI/BOOT/BOOTRISCV64.EFI. That is not 8.3 either.
  • Distros like Fedora and Ubuntu are already using grubriscv64.efi as file name (cf. https://fedoraproject.org/wiki/Architectures/RISC-V/GRUB2)

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay, cool. I was just thinking I've seen some vendors expect/model on it being strict FAT12 in the x86 space, and seeing the longer file name started to bug me. Also interesting Ubuntu beat Debian since I checked Debian packaging yesterday when the question came up in another project of "what would the filename be?!" so we could correctly account for it.

Copy link

@gmbr3 gmbr3 Apr 13, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

UEFI requires support for FAT long filenames (LFN) in all FAT12, FAT16 and FAT32 so it's fine

@andreabolognani
Copy link

Hey, I'm wondering what's missing to get this one merged at this point? From a cursory look, it seems that all points raised during review have been addressed.

I'm really keen on seeing this make its way to Fedora. Along with the lack of an up-to-date GRUB2 (which is something that's supposedly being addressed as we speak), not having shim is, at least as far as I'm aware, the last remaining blocker to producing usable (albeit still unofficial) Fedora images for RISC-V.

@jmontleon
Copy link

It is not very clean, but I was able to build and boot shim on a VisionFive 2 and EDK2 on a qemu/libvirt VM. I forked shim and gnu-efi with some rough work

I had to pull a few things together to get builds working on riscv64.

You can basically clone https://github.com/jmontleon/shim/tree/riscv and
cd shim && make clean && make && sudo cp shimriscv64.efi /boot/efi/EFI/BOOT/BOOTRISCV64.EFI && sudo cp fbriscv64.efi /boot/efi/EFI/BOOT/ && sudo cp shimriscv64.efi /boot/efi/EFI/fedora/

With /boot/efi/EFI/fedora/BOOTRISCV64.csv containingshimriscv64.efi,Fedora,,This is the boot entry for Fedora the system boots and you get a boot entry created.

@julian-klode
Copy link
Collaborator

Hey, I'm wondering what's missing to get this one merged at this point? From a cursory look, it seems that all points raised during review have been addressed.

I'm really keen on seeing this make its way to Fedora. Along with the lack of an up-to-date GRUB2 (which is something that's supposedly being addressed as we speak), not having shim is, at least as far as I'm aware, the last remaining blocker to producing usable (albeit still unofficial) Fedora images for RISC-V.

I don't think any distro has intentions to sign anything for RISC-V yet and I don't know if Microsoft would even accept it, or what the value would be in handing Microsoft the control over the RISC-V CA too.

And unsigned you can just use grub directly and be happy, so I think there's no value merging changes like this and adding the maintenance overhead or have it potentially break each release because nobody tests it.

@xypron
Copy link
Contributor

xypron commented Jun 24, 2024 via email

@andreabolognani
Copy link

And unsigned you can just use grub directly and be happy, so I think there's no value merging changes like this and adding the maintenance overhead or have it potentially break each release because nobody tests it.

AFAIK shim doesn't just handle the Secure Boot part though, it also takes care of locating and running the GRUB binary when installed as the fallback entry (${ESP}/BOOT/BOOTRISCV64.EFI). At least that's how things seem to work in Fedora, though admittedly the Debian/Ubuntu boot path appears to be set up differently.

Anyway, that's the part I'm interested in, as it would allow us to ship disk images that can be booted right away, without the need on the user's part to create UEFI boot entries themselves,

For this to work there's no need for the shim binary to be signed, much less to determine who the signing entity would be.

@jmontleon
Copy link

ncroxon/gnu-efi#34 was merged.

Using that work and this PR I had to make a few changes to get things working properly.
main...jmontleon:shim:riscv

I also ended up having to reimplement the closed PR #410. I did see the note re: patching gnu-efi instead of shim, which would basically be undoing the CHAR8 commit (ncroxon/gnu-efi@ce1ec9d) if that approach is desired.

@gmbr3
Copy link

gmbr3 commented Jul 9, 2024

undoing the CHAR8 commit (ncroxon/gnu-efi@ce1ec9d) if that approach is desired.

I doubt it. SHIM and SHIM's gnu-efi is outdated and in a very inconsistent state. CHAR8 should be 'unsigned char' since that's how UEFI spec says it is.

@vathpela
Copy link
Contributor

On the face, the code this patch adds looks mostly okay to me, but there are still several problems here regarding the result. Even after following jmontleon's suggestions above, there are issues here, ranging from a minor problem with the PR itself to things that make this difficult to consider merging:

  • missing DCO
  • This doesn't add RISC-V to CI, and AFAICT for the reasons below, and it wouldn't pass if it did
  • CHAR8 and char don't match in signedness. I don't have a dog in the fight of which signedness CHAR8 should be on this platform (or really any others), but I don't see how they can be fully independent, and they haven't been in the past, so there's a fair amount of code depending on it. If there's a compelling reason for them not to be the same, we still need patches to fix all the errors that causes, which right now seem to be a lot.
  • This tree doesn't build with the newer upstream gnu-efi because of the API/ABI issues with realloc() and others. That looks easy to fix with a #define, but again, this won't pass CI until that's fixed.
  • the need to add va_start() (etc) macros looks wrong to me, and the comment that gnu-efi needs them is quite disturbing. gnu-efi is providing these functions (or at least their decls; it should always wind up using compiler builtins). That makes me suspect there's still an issue in the upstream gnu-efi variadics, which will bite us on x86. I haven't tried getting rid of this and seeing if it's really necessary, because this tree doesn't build.
  • in general I'm pretty hesitant to switch to newer upstream gnu-efi because that repo is an absolute mess of unnecessary merge commits and nearly empty changelogs, and stuff like the variadic function addition here makes me think we're going to get stuck holding the bag with printf() doing memory corruption again, which isn't acceptable.

@jmontleon
Copy link

jmontleon commented Nov 23, 2024

@vathpela It has been awhile since I looked but I remain able to build off the latest upstream gnu-efi with the additional changes I laid out in https://github.com/jmontleon/shim
At the time I used gnu-efi 33727c2abe8a77dca612f04abd19e10cc5e487fd

But updating gnu-efi to 5ea320f0f01c8de8f9dd4e4e38a245608f0287dd still builds:

git clone [email protected]:jmontleon/shim
cd shim/
git submodule update --init
make

I did a scratch a riscv64 scratch build (http://fedora.riscv.rocks/koji/taskinfo?taskID=1837632) and tested in a virtual machine quick. It seems to still work ok.

I did see an issue with va_list on x86_64 and added a workaround patch to the srpm there so it should build on x86_64 now as well.

I'm definitely not insisting this or all the rest is 100% correct and ready to merge, but it should at least be possible to build and perhaps we can start working down the list of other issues you raised above?

@gmbr3
Copy link

gmbr3 commented Dec 4, 2024

  • CHAR8 and char don't match in signedness. I don't have a dog in the fight of which signedness CHAR8 should be on this platform (or really any others), but I don't see how they can be fully independent, and they haven't been in the past, so there's a fair amount of code depending on it. If there's a compelling reason for them not to be the same, we still need patches to fix all the errors that causes, which right now seem to be a lot.

UEFI spec says CHAR8 is Latin-1 (0-255) so it's unsigned

  • This tree doesn't build with the newer upstream gnu-efi because of the API/ABI issues with realloc() and others. That looks easy to fix with a #define, but again, this won't pass CI until that's fixed.

Can be done by defining GNU_EFI_3_0_COMPAT

  • the need to add va_start() (etc) macros looks wrong to me, and the comment that gnu-efi needs them is quite disturbing. gnu-efi is providing these functions (or at least their decls; it should always wind up using compiler builtins). That makes me suspect there's still an issue in the upstream gnu-efi variadics, which will bite us on x86. I haven't tried getting rid of this and seeing if it's really necessary, because this tree doesn't build.

Not defining GNU_EFI_USE_EXTERNAL_STDARG??

and stuff like the variadic function addition here makes me think we're going to get stuck holding the bag with printf() doing memory corruption again, which isn't acceptable.

Totally agree - this is a bit clutching at straws though - if there's a problem that isn't fixed just send a bug report

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

9 participants