Genkernel/fr

genkernel est utilisé pour automatiser le processus de compilation du   noyau et du système de fichiers virtuel de démarrage (initramfs). Parmi les fonctionnalités citons :
 * la configuration des sources du noyau
 * la compilation de l'image compressée du noyau  et sa copie dans
 * la création d'un système de fichiers virtuel du démarrage (initramfs) et sa copie dans
 * la création des liens symboliques dans
 * l'ajout d'un contenu personnalisé au système de fichiers virtuel de démarrage (initramfs) comme par exemple les fichiers relatifs au chiffrage, les écrans d'attente, les modules supplémentaires et plus encore.
 * la compression de l'initramfs
 * la configuration du chargeur de démarrage

Installation
Pour installer le paquet, commencez par sélectionner les options de la variable USE appropriées.

Ensuite, vous pouvez procéder à l'installation du paquet genkernel.

Invocation de Genkernel
La forme générale de l'invocation de genkernel est la suivante :

Options
Le comportement réel de genkernel dépend d'une grande variété d'options, dont la majorité peut être activée/désactivée dans le fichier ou passer avec la commande. Les options passées en ligne de commande prévalent sur celles définies dans. Ce fichier est très bien documenté. Nous examinerons néanmoins ici quelques unes des options les plus communes. Pour une information plus complète, reportez-vous aux commentaires du fichier ou à la sortie de la commande.

Options agissant sur l'interactivité de l'utilisateur
Les options de configuration listées ci-dessous permettent de décider comment interagir avec le processus de configuration. L'utilisateur peut même décider si le fichier de configuration sera ou pas sauvegardé. Les options suivantes sont les options de configuration de premier ordre :


 * --[no-]menuconfig
 * Active [ or désactive] la commande   (qui invoque un menu interactif de configuration) avant de compiler le noyau.


 * --gconfig
 * fournit un outil de configuration du noyau qui dépend des bibliothèques GTK+. L'avantage de cette option est que la majorité des utilisateurs trouvent cette interface plus claire et facile à utiliser pour configurer le noyau, puisqu'elle utilise le système X-Window. Son inconvénient est que vous devez avoir X-Window pour l'utiliser, cela ne marchera pas dans une console en ligne de commande.


 * --xconfig
 * fournit un outil de configuration du noyau qui dépend des bibliothèques Qt. L'avantage de cette option est que la majorité des utilisateurs trouvent cette interface plus claire et facile à utiliser pour configurer le noyau, puisqu'elle utilise le système X-Window. Son inconvénient est que vous devez avoir X-Window pour l'utiliser, cela ne marchera pas dans une console en ligne de commande.


 * --[no-]save-config
 * sauvegarde [ou ne sauvegarde pas] la configuration du noyau dans un fichier situé dans le répertoire pour une future utilisation.


 * --kernname=&lt;NickName&gt;: vous permet de nommer le noyau et le disque virtuel initial (initrd).qui seront copiés dans, de sorte que les noms de fichier produits soient kernel-Nom-version et initramfs-Nom-version.

Options agissant sur le système résultant
Les options définies ici définissent quelles fonctionnalités, seront, ou ne seront pas, incluses dans le noyau et le système de fichiers virtuel de démarrage résultants.


 * --[no-]splash
 * ajoute [ou n'ajoute pas] la prise en charge de l'écran d'attente en tampon de trame (splash framebuffer) au sytème de fichiers virtuel de démarrage (initrd) que construit genkernel. Pour écraser le thème par défaut utilisé par fbsplash, utilisez --splash=&lt;MonThème&gt; (où &lt;MonThème&gt; est le nom de l'un des répertoires situés dans ).


 * --splash-res=&lt;PreferredResolution&gt;</tt>
 * cette option vous permet de sélectionner les résolutions prise en charge par l'initrd au démarrage. Elle est utile pour deux raisons : d'abord, vous pouvez choisir quelles résolutions sont prises en charge spécifiquement par votre système, ensuite, vous réduisez la quantité d'espace occupée par l'initrd puisque ce dernier n'a plus à s'occuper des résolutions que vous n'utiliserez pas. Cependant, vous pouvez ignorer cette option si vous compilez un noyau pour un CD d'installation, ce qui permettra à bootsplash de prendre en charge toutes les résolutions.


 * --do-keymap-auto</tt>
 * force la sélection de l'arrangement de clavier lors du démarrage.


 * --lvm</tt>
 * inclut la prise en charge des volumes gérés par LVM2 grâce à des binaires statiques, s'ils sont disponibles. Les binaires (statiques) LVM2 en question sont compilés lorqu'ils manquent. Assurez-vous d'avoir installé le paquet lvm2 sur votre système avec emerge lvm2 avant d'activer cette option et d'avoir lu l'article LVM sur ce wiki.


 * --dmraid</tt>
 * inclut la prise en charge de DMRAID, l'outil qui crée des volumes RAID logiciels en utilisant le sous-système device-mapper du noyau. DMRAID découvre, active, désactive et affiche les propriétés des volumes RAID (ATARAID par exemple) ainsi que celles des partition DOS incluses.


 * --luks</tt>
 * inclut le support de Linux Unified Key Setup (LUKS). Cela vous permettra d'utiliser un périphérique chiffré par LUKS pour placer votre système de fichiers racine (/). Spécifiez alors au chargeur de démarrage le nom de ce périphérique via la variable   (  doit être le nom du périphérique une fois déchiffré par LUKS).


 * --disklabel</tt>
 * ajoute la prise en charge de disk label (étiquette de disque) and UUID (Identifiant Unique Universel) à votre disque virtuel initial (initrd).


 * --iscsi</tt>
 * ajoute la prise en charge de iSCSI à votre disque virtuel initial (initrd).


 * --multipath</tt>
 * ajoute la prise en charge de Multipath à votre disque virtuel initial (initrd).


 * --linuxrc=/path/to/your/linuxrc</tt>
 * spécifie un script linuxrc créé par l'utilisateur qui sera appelé lors de la phase de démarrage du noyau, avant le démarrage du système. (Un script linuxrc par défaut devrait se trouver dans .) Ce script vous permet d'amorcer sur un petit noyau modulaire et de charger les pilotes requis (sous forme de modules) par le système avant le démarrage.


 * --cachedir=/path/to/alt/dir</tt>
 * remplace le chemin par défaut du cache utilisé pendant la compilation.


 * --tempdir=/path/to/new/tempdir</tt>
 * spécifie le chemin du répertoire temporaire utilisé par genkernel lors de la compilation du noyau.


 * --unionfs</tt>
 * inclut la prise en charge de Unification File System dans votre disque virtuel initial (initrd).


 * --mountboot</tt>
 * détecte si le répertoire   a besoin d'être monté en lisant le  et en y prenant les instructions sur la manière de le monter.

Options agissant sur le choix des outils utilisés pour la compilation
Les options suivantes sont prises en charge par genkernel, et sont passées aux applications concernées lors de la compilation et de l'assemblage du noyau. Ces options influent sur le choix des outils utilisés pendant le processus de compilation, quoi qu'à un niveau assez bas.


 * --kernel-cc=&lt;unCompilateur&gt;</tt>
 * ceci spécifie quel compilateur sera utilisé pour construire votre noyau


 * --kernel-ld=&lt;unéditeurDeLiens&gt;</tt>
 * ceci spécifie quel éditeur de liens sera utilisé dans la construction de votre noyau.


 * --kernel-as=&lt;unAssembleur&gt;</tt>
 * ceci spécifie quel assembleur sera utilisé pour construire votre noyau.


 * <tt>--kernel-make=&lt;unMake&gt;</tt>
 * ceci spécifie un utilitaire GNU make alternatif qui sera utilisé pour la construction de votre noyau.


 * <tt>--utils-cc=&lt;unCompilateur&gt;</tt>
 * ceci spécifie un compilateur qui sera utilisé pour construire les outils annexes.


 * <tt>--utils-ld=&lt;unÉditeurDeLiens&gt;</tt>
 * ceci spécifie un éditeur de liens utilisé dans la construction des outils annexes.


 * <tt>--utils-as=&lt;unAssembleur&gt;</tt>
 * ceci spécifie un assembleur qui sera utilisé pour construire les outils annexes.


 * <tt>--utils-make=&lt;unMake&gt;</tt>
 * ceci spécifie un utilitaire GNU make alternatif qui sera utilisé pour la construction des outils annexes..


 * <tt>--makeopts=-jX</tt>
 * spécifie le nombre de fils d'exécution concurrents que make peut utiliser pendant la compilation du noyau et des outils. La variable  est un nombre obtenu en ajoutant un (1) au nombre de processeurs du système. Pour un système monoprocesseur, la valeur appropriée serait   . Un biprocesseur utiliserait    et ainsi de suite. Un système monoprocesseur qui prend en charge la technologie Hyper-Threading™ (ou « HT ») peut utiliser la valeur  , en supposant que le support du SMP (Symmetric Multi-Processing) soit activé dans le noyau au moment de la compilation.

Options agissant sur le processus de compilation
Les options suivantes ont généralement un effet lors de la compilation réelle.


 * <tt>--kerneldir=/chemin/vers/sources/</tt>
 * pour spécifier l'endroit où se trouvent les sources du noyau et ne pas utiliser l'emplacement par défaut.


 * <tt>--kernel-config=/chemin/vers/fichier/config-file</tt>
 * pour spécifier l'endroit où se trouve le fichier de configuration et ne pas utiliser l'emplacement par défaut.


 * <tt>--module-prefix=/chemin/vers/modules prefix/</tt>
 * pour spécifier où installer les modules du noyau et ne pas utiliser l'emplacement par défaut.


 * <tt>--[no-]clean</tt>
 * lance [ou ne lance pas] make clean avant de compiler le noyau, ce qui efface toutes les dépendances et fichiers objets déjà présents.


 * <tt>--[no-]mrproper</tt>
 * lance [ou ne lance pas] make mrproper avant de compiler le noyau. Comme la commande make clean, make mrproper efface toutes les dépendances et fichiers objets de l'arborescence des sources du noyau, mais elle efface également les fichiers de configuration (tels que ou ).


 * <tt>--oldconfig</tt>
 * Lance la commande, qui essaira de collecter des informations de configuration pour votre architecture depuis un script générique situé dans . Ce processus n'est pas interactif ; aucune entrée de l'utilisateur n'est demandée. De plus, si <tt>--oldconfig</tt> est utilisé en même temps que <tt>--clean</tt>, cette dernière sera annulée, comme si on avait rajouté l'option  <tt>--no-clean</tt>.


 * <tt>--callback="echo hello"</tt>
 * cette routine effectue un appel à l'argument spécifié (ici, echo Hello) après que le noyau et les modules correspondants aient été construits, mais avant de créer l'image initrd. C'est utile lorsque vous souhaitez installer des modules externes dans l'initrd en passant la commande emerge en argument et redéfinir de ce fait un nouveau groupe de modules genkernel.


 * <tt>--[no-]install</tt>
 * lance [ou ne lance pas] la commande, ce qui installe votre nouveau noyau, le fichier de configuration, l'image initrd et le System.map sur votre partition montée de boot. Les modules compilés seront aussi installés..


 * <tt>--no-ramdisk-modules</tt>
 * empêche la copie des modules dans l'image de disque intitial (initrd) créée par genkernel.


 * <tt>--all-ramdisk-modules</tt>
 * copie tous les modules disponibles dans l'image de disque initial (initrd) créée par genkernel.


 * <tt>--genzimage</tt>
 * crée l'image initrd avant l'image du noyau (cette bidouille ne s'applique actuellement qu'aux systèmes PPC Pegasos.)

Options de débogage
L'utilisation d'options de débogage pendant la compilation du noyau contrôle le nombre d'informations reportées, ainsi que la présentation de celles-ci.


 * <tt>--loglevel=&lt;niveau de verbosité&gt;</tt>
 * contrôle le niveau de verbosité des informations fournies par genkernel. La variable NiveauVerbosité doit être un nombre entier compris entre 0 et 5. Le niveau « 0 » représentant le minimum d'information, tandis qu'une valeur de « 5 » fournira le plus d'informations possible sur le déroulement des opérations.


 * <tt>--logfile=/chemim/vers/fichier/journal</tt>
 * ignore la valeur de <tt>--loglevel</tt> et renvoie toutes les informations produites par genkernel vers le fichier spécifié, qui est  par défaut.


 * <tt>--[no-]color</tt>
 * active [ou désactive] la sortie colorée des informations de débogage (celles reportées par genkernel).

Action
Une action passée avec la commande  indique à    ce qu'il faut faire. Les actions prises en charge sont :


 * compile/construit toutes les étapes — le disque virtuel initial (initrd), l'image du noyau et les modules.
 * compile/construit toutes les étapes — le disque virtuel initial (initrd), l'image du noyau et les modules.


 * ne compile/construit que l'image du noyau.
 * ne compile/construit que l'image du noyau.


 * : ne compile/construit que l'image du noyau et les modules


 * ne compile/construit que le disque virtuel initial(initramfs)
 * ne compile/construit que le disque virtuel initial(initramfs)


 * ne compile/construit que le disque virtuel initial(initramfs)
 * ne compile/construit que le disque virtuel initial(initramfs)

Première invocation de Genkernel
Bien qu'il y ait plusieurs façons de lancer genkernel, la plus simple reste. Une configuration générique qui marche correctement pour tous les systèmes sera alors utilisée. Comme mentionné précédemment, cette méthode n'est pas sans inconvénients. La plupart des modules compilés ne seront pas utilisés et la compilation prendra beaucoup de temps. L'illustration suivante montre une approche plus efficace, en passant certains paramètres à genkernel en tant qu'utilisateur root:

Cette opération indique à genkernel de créer un noyau avec un écran de démarrage (<tt>--splash</tt>) en tampon de trames (framebuffer) qui devra être installé à la main (<tt>--no-install</tt>). Dans la phase préparatoire de compilation, genkernel n'effacera pas les objets déjà compilés (<tt>--no-clean</tt>). Enfin, un menu de configuration sera affiché, permettant à l'utilisateur de choisir quels modules seront compilés (<tt>--menuconfig</tt>).

Remplacez <tt>--no-install</tt> par <tt>--install</tt> pour qu'il installe automatiquement le nouveau noyau dans et spécifiez <tt>--symlink</tt> pour qu'il crée les liens symboliques pour vous. En utilisant le paramètre -- <tt>--mountboot</tt>, la partition sera monté par genkernel automatiquement, si nécessaire.

Utiliser Genkernel pour modifier votre noyau
La première chose que vous devriez faire, c'est autoriser le lancement de dans le fichier  :

Gestion des fichiers par genkernel
Quand il utilise genkernel, l'utilisateur doit être conscient de quelques aspects concernant la gestion des fichiers de configuration et des fichiers image du noyau, ainsi que de la façon dont les sources du noyau sont manipulées par le système.

Fichiers sources utilisés par genkernel
Après une commande, chaque fois que de nouvelles sources sont disponibles, un nouveau dossier est créé pour les sources du noyau dans   pour les héberger. Normalement, le dossier des sources actives est pointé par le lien symbolique.

Le dossier  pourrait ressembler à ceci :

Le lien symbolique  peut être changé de différentes manières.


 * Si l'option  de la variable USE est définie dans, le lien symbolique  est automatiquement mis à jour pour pointer sur les nouvelles sources installées par la commande  ..


 * Si l'option de la variable USE évoquée ci-dessus n'est pas définie, l'utilisateur peut changer la destination du lien symbolique en utilisant la commande.

Quoi qu'il en soit,  utilise toujours les sources pointées par ce lien symbolique.

Kernel Configuration file used by genkernel
If a kernel compilation has already been run with the active kernel sources, there might be a file inside the directory that contains the kernel configuration that has been applied while creating the last bzimage of the kernel. This file is named, for example where x86_64 might be substituted with your architecture,  3.7.9 might be substituted with the version of the sources you are using and r1 with the release of the sources..

It is this file that is used as a starting configuration when running   }}.

If it is the first time that  is run, or if the previous result has not been saved, this file is substituted with a default configuration file that resides at  where x86_64 is substituted with the actual architecture.

Saving the compiled configuration
If the  genkernel option  is activated, either from the command line or inside, the compiled kernel configuration is saved (with the name given above) into the  directory. At the same time, the configuration is saved in the file in  directory but this file is not reused on the next   run.

Installing the kernel and initramfs into the /boot directory
The  action specified when invoking genkernel, ask   to install the kernel image and the initramfs into the  directory. In order to do it in a convenient manner, set the following in the  file:


 * The first parameter speaks by itself.


 * The second parameter tells genkernel to save the compiled kernel configuration into.


 * The last two options tell genkernel to automatically update the grub configuration. In practice, the following happens:
 * if a previous kernel image with the same name already exist, it is renamed by appending <tt>.old</tt> to its name. A symlink is automatically created that points to it.
 * the new kernel takes the place of any kernel with the same name into . If it is the first time a kernel is compiled, a symlink kernel is automatically created that points to the new kernel.

After running, the  directory might look like this:

Configuring the bootloader
The symlinks presented above in the bootloader's configuration can be used so that, even if the new kernel is not bootable, the user can always boot on the old one.

To allow the kernel and intird provided by genkernel to run correctly, provide a minimum information in your bootloader configuration file :
 * Add  to the kernel parameters passed to the kernel image, where  points to the root partition.
 * If splash is used, add a suitable mode line such as  to the parameters passed to the kernel and also add   or   depending on the verboseness required through the boot process.
 * Add the initrd information as required by the bootloader. Consult the Bootloader Configuration Chapter of the Gentoo Handbook for details on how to make your bootloader initrd-aware.

Here is how the file might look.

Preserving your working files
The genkernel application automatically saves new changes to the files. If previous changes are to be preserved, then the following actions need to be taken.


 * The first file to preserve is the kernel configuration file in . If the source isn't changed prior to the recompilation of the kernel, the previously used name for this file will be used. So renaming the previous configuration file helps in preserving the information.


 * The second important thing is to preserve the already bootable kernel and initramfs images. The way to accomplish this depends on the context:
 * If the last kernel compiled is bootable, running  will rename this kernel (and similarly initramfs) image to  and create a new . This mean that even if the new kernel is not bootable, users will always be able to boot the old one.
 * If the last kernel compiled is not bootable and sources haven't changed since the user compiled a bootable one, prior to running, first delete the new kernel image and remove the <tt>.old</tt> suffix from the last bootable one. Without this, if the newly compiled kernel is not bootable for the second time, the bootable  will be kicked out by the renaming of the non bootable , giving the user an unbootable system. Use the same reasoning for initramfs.

Using previous kernel configuration while changing the sources
The previous configuration can be used through the  option in your  as follows:

Network Booting with Genkernel from an Installation CD
The genkernel utility can build kernel and initrd images that provide support for network booting, or netbooting. With any luck, users should be able to netboot any recent computer into the environment provided by the Installation CD.

The magic lies in genkernel's linuxrc script: it will try to netmount the Installation CD using NFS. From there, the init scripts of the Installation CD can take over, as if the CD was present locally.

Building Kernel and Initrd Images with Support for Netbooting
To enable support for netbooting, include the following options while configuring the kernel:

First, the kernel image must include the drivers for your Network Interface Cards (NIC). Normally, drivers for such devices will be compiled as modules. However, it is essential (for netbooting) that such drivers are compiled directly into the kernel image and not as modules.

Be sure to select <tt>&lt;*&gt;</tt> and not <tt>&lt;M&gt;</tt>.

Secondly, it is suggested that IP: kernel level autoconfiguration is enabled as well as IP: DHCP support options. This avoids an unnecessary layer of complexity since the IP address and the NFS path to the Installation CD can be configured on a DHCP server. Of course, this means the kernel command line will remain constant for any machine — which is very important for etherbooting.

These options tell the kernel to send a DHCP request at bootup.

Additionally, enable SquashFS because most modern Gentoo Installation CDs require it. Support for SquashFS is not included with the generic kernel source tree. To enable SquashFS, apply the necessary patches to the generic kernel source or install gentoo-sources.

Once the compilation process is completed, create a compressed tarball (tar.gz) that contains the kernel's modules. This step is only necessary if the kernel version does not match the kernel image version on the Installation CD.

To create an archive containing all the modules:

Depending on the network boot mechanism, one of the following steps need to be followed:

To create an etherboot image:

To create a OpenBoot / SPARC64 TFTP image:

The file is the boot image.

Finally, copy this kernel to the TFTP server. The details are architecture-dependent and are beyond the scope of this guide. Please refer to the documentation for your platform.

NFS setup
To setup a NFS share that contains the Installation CD, use the loop device to mount the ISO image and then copy the contents of the CD into the NFS share. As a nice extra, genkernel's initrd scripts will extract all tar.gz files located in the directory. All that needs to be done here is copy the archive to the  directory.

The following assumes that is an exported NFS share:

Now copy the file into :

DHCP setup
The netboot images will ask the DHCP server on the network for an IP as well as a <tt>root-path</tt> parameter. Both can be specified per host using a MAC address to identify machines:

Netbooting Instructions
Netbooting itself is again very platform-specific. The important part is to specify the  and   parameters on the kernel command line, as this will bring up the network interface and tell the initrd scripts to mount the Installation CD via NFS. Here are some platform-specific tips.

For etherboot, insert the etherboot disk into the drive and reboot. The kernel command line was specified when the image was constructed. With Sparc64, hit - at the boot prompt and enter:

For PXE, setup pxelinux (part of syslinux), then create a along the lines of:

Introduction
If an initramfs is installed with genkernel, then take a look at the various boot options that can (or should) be defined in the bootloader configuration. The most common ones are added to this guide.

Loading LVM or software-RAID
If the system uses LVM or software-RAID, the initramfs has to be built using the <tt>--lvm</tt> and <tt>--mdadm</tt> options. Don't forget to enable support during boot as well. This can be done using the dolvm and domdadm options.

Booting in single-user mode
If for some reason boot-up fails, rescuing the system by booting in the single-user mode is still possible. This will only load the really necessary services and then drop the user to a rescue (root) shell.

Acknowledgements
We would like to thank the following authors and editors for their contributions to this guide:


 * Tim Yamin
 * Jimi Ayodele
 * Thomas Seiler
 * Joshua Saddler
 * Sebastian Pipping
 * José Fournier