Gentoo Forums
Gentoo Forums
Gentoo Forums
Quick Search: in
how to use a custom initramfs and get a unified kernel image
View unanswered posts
View posts from last 24 hours

 
Reply to topic    Gentoo Forums Forum Index Kernel & Hardware
View previous topic :: View next topic  
Author Message
Cheesyjuggler64
n00b
n00b


Joined: 16 May 2024
Posts: 27

PostPosted: Sun Dec 22, 2024 7:51 pm    Post subject: how to use a custom initramfs and get a unified kernel image Reply with quote

I have a custom initramfs with busytbox and I want to use it and create a unified kernel image. If its possible I'd like to have it done with install kernel. I've tried to use ukify but I can't get it working. Help appreciated
Back to top
View user's profile Send private message
pietinger
Moderator
Moderator


Joined: 17 Oct 2006
Posts: 5239
Location: Bavaria

PostPosted: Sun Dec 22, 2024 8:41 pm    Post subject: Reply with quote

Although these two pages:

https://wiki.gentoo.org/wiki/Unified_kernel_image
https://wiki.archlinux.org/title/Unified_kernel_image

say that a UKI can have a UEFI boot stub like systemd-stub:
Quote:
A unified kernel image (UKI) is a single executable which can be booted directly from UEFI firmware, or automatically sourced by boot loaders with little or no configuration. It is the combination of a UEFI boot stub program like systemd-stub(7), a Linux kernel image, an initrd, and further resources in a single UEFI PE file.

our developers are of the opinion that it is only a UKI if it has the systemd-stub ... 8O ... but I don't know how to name a UKI with the kernel's own stub.

I built my “UKI” 5 years ago when the term UKI didn't even exist. Of course I used the kernel's own stub ... and to this day I boot a signed (for SecureBoot) kernel image that contains everything ... it is even a monolithic kernel (=without module support).

Now if you already have a self-made initramfs (like me) then I recommend you to do everything else manually as well, because it's easier than you think (and installkernel is more complicated than you think; I even dont know if it is possible to use an own initramfs).

If you want go the manual route you have to do:

1. Ensure you have in your kernel the CPU microcode built-in (CONFIG_EXTRA_FIRMWARE) and maybe some firmware files if you need it,
2. Option for EFI-stub is enabled in your kernel (CONFIG_EFI_STUB=y),
3. Embedd your external initramfs into the kernel with these settings:
https://wiki.gentoo.org/wiki/User:Pietinger/Tutorials/Initramfs_Overview#Special_Case:_Building_an_embedded_initramfs_with_a_CPIO_archive
_________________
https://wiki.gentoo.org/wiki/User:Pietinger
Back to top
View user's profile Send private message
Cheesyjuggler64
n00b
n00b


Joined: 16 May 2024
Posts: 27

PostPosted: Sun Dec 22, 2024 9:57 pm    Post subject: Reply with quote

okay so I've just read the article. So when you're including files they have to also exist within the initramfs file system e.g
Code:

file /sbin/mdadm                /root/initramfs/bins/sbin/mdadm         755 0 0

so the how does this line "This lets the initramfs be built dynamically, always using the latest files from the system" make sense? aren't you still copying the static binaries. Or is it suggesting that you should make a script to create this file? (https://wiki.gentoo.org/wiki/Custom_Initramfs#External_file_list)


Last edited by Cheesyjuggler64 on Sun Dec 22, 2024 10:53 pm; edited 2 times in total
Back to top
View user's profile Send private message
Hu
Administrator
Administrator


Joined: 06 Mar 2007
Posts: 22867

PostPosted: Sun Dec 22, 2024 10:49 pm    Post subject: Reply with quote

The Wiki is a bit confusing on this point. An initramfs list will always build the initramfs as part of the kernel, using the files specified as sources as they exist at build time. You can choose to specify those files as being pulled from the main filesystem (file /sbin/mdadm /sbin/mdadm 755 0 0 would pull from live), in which case they are always current to your routine updates, or you can choose to pull them from a hand-curated directory that changes only when you want to change it (as shown in the code fragment you posted). The text describes doing the former, but the shown example does the latter.
Back to top
View user's profile Send private message
Cheesyjuggler64
n00b
n00b


Joined: 16 May 2024
Posts: 27

PostPosted: Sun Dec 22, 2024 10:54 pm    Post subject: Reply with quote

ah thanks maybe the wiki could do with some clarification there. Im going to try set it up now. I'm trying to build the initramfs for an encrypted btrfs root.
Back to top
View user's profile Send private message
zen_desu
n00b
n00b


Joined: 25 Oct 2024
Posts: 61

PostPosted: Mon Dec 23, 2024 12:00 am    Post subject: Reply with quote

I'm not sure what a UKI helps with if the initramfs is built into the kernel itself.

Are you building that file list outside of the kernel build process?
_________________
µgRD dev
Wiki writer
Back to top
View user's profile Send private message
Cheesyjuggler64
n00b
n00b


Joined: 16 May 2024
Posts: 27

PostPosted: Mon Dec 23, 2024 12:46 am    Post subject: Reply with quote

Ah so if I embed my intramfs into the kernel the kernel will just be a single binary and as such I can boot it directly from uefi?
Back to top
View user's profile Send private message
zen_desu
n00b
n00b


Joined: 25 Oct 2024
Posts: 61

PostPosted: Mon Dec 23, 2024 1:03 am    Post subject: Reply with quote

Cheesyjuggler64 wrote:
what do you mean by outside the build process? So if I embed the initramfs I can just rename it to .efi and have it boot via uefi ?


I mean you can use that file list with gen_init_cpio to create an actual CPIO, or you can use CONFIG_INITRAMFS_SOURCE on a directory to have the kernel pack that initramfs into the image at build time.

The initramfs exists as a "CPIO" which may be compressed if the kernel supports it. It's not directly executable.

A UKI can pack this "external" initramfs into a single file along with your kernel and more which can be booted by an EFI system. This is mostly useful if you use some initramfs generator and the CPIO is a separate file. If you pack the initramfs into the kernel directly, the UKI may handle your microcode and possibly your kernel cmdline, but these could also be built into the kernel image itself.

I think the main advantage of a UKI is it allows you to easily reuse a kernel with a new initramfs, as embedding it into the kernel generally requires at least a partial rebuild.
_________________
µgRD dev
Wiki writer
Back to top
View user's profile Send private message
pietinger
Moderator
Moderator


Joined: 17 Oct 2006
Posts: 5239
Location: Bavaria

PostPosted: Mon Dec 23, 2024 1:10 am    Post subject: Reply with quote

@zen-desu

We dont know how PO has built his initramfs. A long time ago it was common to create your own (external) initramfs like this:
https://wiki.gentoo.org/wiki/User:Pietinger/Tutorials/Initramfs_Overview#External_CPIO_archive_with_a_directory
This is done outside the build process of the kernel.

Later there was the possibility to build an initramfs via file-list. Even if there are two ways to build an initramfs with a file-list, it was actually only intended for building within the build process. This would be that option (X):
https://wiki.gentoo.org/wiki/User:Pietinger/Tutorials/Initramfs_Overview#Embedded_with_a_file-list
But this option also works:
https://wiki.gentoo.org/wiki/User:Pietinger/Tutorials/Initramfs_Overview#External_CPIO_archive_with_a_file-list


@Cheesyjuggler64

If you have already a working "init" then I would suggest to use the most modern way to build your (embedded) initramfs. This is above (X). The advantage is - as @Hu already mentioned - that the latest binaries are always installed in every new kernel build, as they are copied directly from your system. See also an example of a file list:
https://wiki.gentoo.org/wiki/Early_Userspace_Mounting#Requirements
The last line shows source and target of the copy: FROM /usr/src/initramfs/init INTO the initramfs AS /init (because "init" must be in the root directoy)
Code:
# our init script
file    /init                   /usr/src/initramfs/init             755 0 0

You will see the same in: https://wiki.gentoo.org/wiki/User:Pietinger/Tutorials/Initramfs_Overview#Simple_Skeleton
_________________
https://wiki.gentoo.org/wiki/User:Pietinger
Back to top
View user's profile Send private message
pietinger
Moderator
Moderator


Joined: 17 Oct 2006
Posts: 5239
Location: Bavaria

PostPosted: Mon Dec 23, 2024 1:22 am    Post subject: Reply with quote

Cheesyjuggler64 wrote:
Ah so if I embed my intramfs into the kernel the kernel will just be a single binary and as such I can boot it directly from uefi?

YES 8)

(... if you add also your CPU microcode into the kernel)
_________________
https://wiki.gentoo.org/wiki/User:Pietinger
Back to top
View user's profile Send private message
zen_desu
n00b
n00b


Joined: 25 Oct 2024
Posts: 61

PostPosted: Mon Dec 23, 2024 1:24 am    Post subject: Reply with quote

^^

If you're already building everything, you may as well build it into the kernel.

I think UKIS are mostly helpful if you're packing already made kernels/initramfs/etc into a file after the fact. If you're already going the custom route and building things into your kernel, the rest may not be necessary.
_________________
µgRD dev
Wiki writer
Back to top
View user's profile Send private message
Cheesyjuggler64
n00b
n00b


Joined: 16 May 2024
Posts: 27

PostPosted: Mon Dec 23, 2024 1:48 am    Post subject: Reply with quote

How exactly would I add the mircocode and how can I test my init is working without building the intramfs. Is there some sort of kernel parameter?
Back to top
View user's profile Send private message
zen_desu
n00b
n00b


Joined: 25 Oct 2024
Posts: 61

PostPosted: Mon Dec 23, 2024 1:52 am    Post subject: Reply with quote

https://wiki.gentoo.org/wiki/AMD_microcode#Supplying_the_microcode_files_to_the_kernel

It's hard to test the init without booting it.

you can use qemu if you setup an environment and make a test rootfs image:

https://github.com/desultory/ugrd/blob/1.28.2/src/ugrd/base/test.py#L37-L61
_________________
µgRD dev
Wiki writer
Back to top
View user's profile Send private message
Cheesyjuggler64
n00b
n00b


Joined: 16 May 2024
Posts: 27

PostPosted: Mon Dec 23, 2024 3:08 am    Post subject: Reply with quote

okay so just to check I do this
Code:
mkdir --parents /usr/src/initramfs/{bin,dev,etc,lib,lib64,mnt/root,proc,root,sbin,sys}
emerge --ask --verbose sys-apps/busybox
cd /usr/src/initramfs
nano init

Quote:
Some init script

Code:

chmod +x init

Code:
nano initramfs_list

Quote:
some list file

then I go into the kernel and set CONFIG_INITRAMFS_SOURCE="/usr/src/initramfs/initramfs_list"
Code:
cd /usr/src/linux
make -j8 && make -j8 modules_install
make install

with the installkernel config being set as efistub
Code:

layout="efistub"
initrd_generator=none
uki_generator=none

then reboot and it should work
Back to top
View user's profile Send private message
Cheesyjuggler64
n00b
n00b


Joined: 16 May 2024
Posts: 27

PostPosted: Mon Dec 23, 2024 11:17 am    Post subject: Reply with quote

Also is there anyway to automate grabbing the required dependencies for something like btrfs and cryptsetup?
Back to top
View user's profile Send private message
pietinger
Moderator
Moderator


Joined: 17 Oct 2006
Posts: 5239
Location: Bavaria

PostPosted: Mon Dec 23, 2024 1:15 pm    Post subject: Reply with quote

Cheesyjuggler64 wrote:
Also is there anyway to automate grabbing the required dependencies for something like btrfs and cryptsetup?

No .. You have to find out with "ldd" or "lddtree. An example doing it is here:
https://wiki.gentoo.org/wiki/Initramfs_-_make_your_own#Example_List_of_Requirements

=====

Please let me add some comments:

1. You dont need this when working with a initramfs_list:
Code:
mkdir --parents /usr/src/initramfs/{bin,dev,etc,lib,lib64,mnt/root,proc,root,sbin,sys}

You have only two files in /usr/src/initramfs: Your "init" file and the file-list file.

2. I dont know if "installkernel" works the way you want ... I really dont know.

3. Get a static Busybox:
Code:
USE="-pam static static-libs" emerge -pvD busybox

see again: https://wiki.gentoo.org/wiki/User:Pietinger/Tutorials/Initramfs_Overview#Simple_Skeleton

4. My building of my signed UKI was:

4a. Manually configuring the kernel with
* efistub-support (CONFIG_EFI_STUB=y)
* CPU microcode (and all needed firmware files because I have disabled module-support and have all modules static in the kernel) in:
Code:
CONFIG_EXTRA_FIRMWARE="intel-ucode/06-b7-01 i915/adls_dmc_ver2_01.bin rtl_nic/rtl8125b-2.fw i915/tgl_guc_70.bin i915/tgl_huc.bin"

(how to decide which microcode you need: https://forums.gentoo.org/viewtopic-t-1065464.html )
* Every Kernel command line parameters inside the kernel (so no need to configure the UEFI boot entry with parameters):
Code:
CONFIG_CMDLINE="root=PARTUUID=6979eed7-ffaf-425e-8ac7-2832f6d15e0a ro loglevel=8 lsm.debug ima_appraise=enforce quiet hardened_usercopy=1 page_alloc.shuffle=1 pti=on"

(please be aware of: https://wiki.gentoo.org/wiki/User:Pietinger/Tutorials/Confusion_with_root%3DPARTUUID%3D_and_root%3DUUID%3D )
* Secured against overwriting by the UEFI boot entry:
Code:
CONFIG_CMDLINE_OVERRIDE=y

* And of course embedding the initramfs:
Code:
General setup  --->
    [*] Initial RAM filesystem and RAM disk (initramfs/initrd) support
    (/usr/src/initramfs/initramfs_list) Initramfs source file(s)
    [*]   Support initial ramdisk/ramfs compressed using gzip
    Built-in initramfs compression mode (Gzip)  --->

( see also: https://wiki.gentoo.org/wiki/User:Pietinger/Tutorials/Manual_kernel_configuration + https://wiki.gentoo.org/wiki/User:Pietinger/Experimental/Manual_Configuring_Current_Kernel )

4b. I dont use "installkernel". After building the kernel with "make -j32" I installed it with a simple copy (instead a make install):
https://wiki.gentoo.org/wiki/User:Pietinger/Tutorials/Boot_kernel_via_UEFI

(in reality between step 4a and 4b I also signed this stub-kernel (my "UKI") for SecureBoot:
https://forums.gentoo.org/viewtopic-p-8492354.html#8492354 )
_________________
https://wiki.gentoo.org/wiki/User:Pietinger
Back to top
View user's profile Send private message
pietinger
Moderator
Moderator


Joined: 17 Oct 2006
Posts: 5239
Location: Bavaria

PostPosted: Mon Dec 23, 2024 2:00 pm    Post subject: Reply with quote

P.S.: I forgot soemthing ...

pietinger wrote:
Cheesyjuggler64 wrote:
Also is there anyway to automate grabbing the required dependencies for something like btrfs and cryptsetup?

No .. You have to find out with "ldd" or "lddtree. An example doing it is here:
https://wiki.gentoo.org/wiki/Initramfs_-_make_your_own#Example_List_of_Requirements


... Because you already have a (external) CPIO file, there is also another way: You can extract your CPIO file and look what/which files is inside:
https://wiki.gentoo.org/wiki/Custom_Initramfs#Extracting_the_cpio_archive
_________________
https://wiki.gentoo.org/wiki/User:Pietinger
Back to top
View user's profile Send private message
zen_desu
n00b
n00b


Joined: 25 Oct 2024
Posts: 61

PostPosted: Mon Dec 23, 2024 4:41 pm    Post subject: Reply with quote

Cheesyjuggler64 wrote:
Also is there anyway to automate grabbing the required dependencies for something like btrfs and cryptsetup?


if you're really interested in automation, ugrd was designed using the custom initramfs wiki article as a reference. It more or less follows those steps in an automated manner.
If you don't want all the features and autodetection/checks ugrd offers, you can disable the "base" module and use it to simply add "dependencies"

If you define a "dependency" in ugrd, it finds the location of that binary, then runs lddtree on it and includes all required libraries: https://github.com/desultory/ugrd/blob/1.28.2/src/ugrd/base/core.py#L39

Some things may not say they use libgcc, but may use it anyways. Because of this, it's generally a good idea to include it regardless: https://github.com/desultory/ugrd/blob/1.28.2/src/ugrd/base/core.py#L166

At the very least, you always want to run ldd/lddtree on programs you're adding to the initramfs, unless they are statically compiled. This isn't a guarantee those programs have everything they need, but this is the best way to at least find libraries that binary is linked against.
_________________
µgRD dev
Wiki writer
Back to top
View user's profile Send private message
Display posts from previous:   
Reply to topic    Gentoo Forums Forum Index Kernel & Hardware All times are GMT
Page 1 of 1

 
Jump to:  
You cannot post new topics in this forum
You cannot reply to topics in this forum
You cannot edit your posts in this forum
You cannot delete your posts in this forum
You cannot vote in polls in this forum