bronze/mayfrost-guides
1
0
Fork 0
mirror of https://github.com/mayfrost/guides.git synced 2024-11-28 02:11:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update KERNEL.md

Browse Source
This commit is contained in:
mayfrost 2018-03-03 08:56:04 +00:00 committed by GitHub
parent f5406607a2
commit e012afee78
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 31 additions and 40 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

71
KERNEL.md
View File

@ -1,7 +1,7 @@
# KERNEL # KERNEL
Compiling a kernel has the advantage to make it as minimal and featureful as you want, you can test kernel patches and tweaks and optimize your system. Compiling a kernel has the advantage to make it as minimal and featureful as you want, you can test kernel patches and tweaks and optimize your system.
* You need the kernel source, build tools, the kernel configuration file (optional), and root or sudo privileges for the final stages of the process. * You need the kernel source, build tools, the kernel configuration file (__optional__), and root or sudo privileges for the final stages of the process.
* Back up all of your files. * Back up all of your files.
* Have a distro in a Live CD or USB at hand just in case. * Have a distro in a Live CD or USB at hand just in case.
* Give yourself a cup of tea or coffee while you wait to compile. * Give yourself a cup of tea or coffee while you wait to compile.
@ -14,7 +14,7 @@ Compiling a kernel has the advantage to make it as minimal and featureful as you
## GETTING THE KERNEL SOURCE ## GETTING THE KERNEL SOURCE
* OPTIONAL: Is standard to download Linux sources under /usr/src/, link the downloaded kernel tree to /usr/src/linux-<VERSION_NUMBER> and work there, but is not a requirement. * __OPTIONAL__: Is standard to download Linux sources under /usr/src/, link the downloaded kernel tree to /usr/src/linux-<VERSION_NUMBER> and work there, but is not a requirement.
`cd /usr/src/` `cd /usr/src/`
`ln -s linux-<VERSION_NUMBER> linux` `ln -s linux-<VERSION_NUMBER> linux`
@ -31,17 +31,17 @@ Compiling a kernel has the advantage to make it as minimal and featureful as you
## GENERATING A CONFIGURATION FILE ## GENERATING A CONFIGURATION FILE
This process makes a .config file in the kernel source directory determines which drivers are built and other support. And turn on only the minimal set of options you need. This process makes a "__.config__" file in the kernel source directory determines which drivers are built and other support. And turn on only the minimal set of options you need.
* OPTION 1: Use the config file of another kernel or the current system. * OPTION 1: Use the config file of another kernel or the current system.
`cp -v /boot/config-$(uname -r) .config` `cp -v /boot/config-$(uname -r) .config`
* Or in some distros you can take it from the running kernel * Or in some distros you can take it from the running kernel.
`zcat /proc/config.gz > .config` `zcat /proc/config.gz > .config`
* OPTION 2: Make a default config file (may or may not not have the options you are currently using). * OPTION 2: Make a default config file (may or may not not have the options you are currently using).
`make defconfig` `make defconfig`
* OPTION 3: Generate a config file disabling all options not loaded by the currently running kernel and will make questions on what kernel options to support when it finds new kernel options. Could have problems with peripherals not in use at that time unless you plug all devices like USBs. Available from kernel version 2.6.32 and up. Attach devices you use or insert modules manually with the insmod command before using this option. * OPTION 3: Generate a config file disabling all options not loaded by the currently running kernel and will make questions on what kernel options to support when it finds new kernel options. Could have problems with peripherals not in use at that time unless you plug all devices like __USBs__. Attach devices you use or insert modules manually with the insmod command before using this option. Available from kernel version 2.6.32 and up.
`make localmodconfig` `make localmodconfig`
* OPTION 4: Create a minimal kernel config file which necessarily needs to manually enable options afterwards to have a working system. Available from kernel version 3.17-rc1 and up. * OPTION 4: Create a minimal kernel config file which necessarily needs to manually enable options afterwards to have a working system. Available from kernel version 3.17-rc1 and up.
@ -50,9 +50,9 @@ This process makes a .config file in the kernel source directory determines whic
## CHANGING THE CONFIGURATION (OPTIONAL) ## CHANGING THE CONFIGURATION (OPTIONAL)
* Depending on your tastes this part can take minutes, hours, or days to enable proper options. * Depending on your tastes this part can take minutes, hours, or days to enable proper options.
* The Y (or "*" in menuconfig) flag in kernel configuration compiles options as part of vmlinuz. * The Y (or "__*__" in __menuconfig__) flag in kernel configuration compiles options as part of __vmlinuz__.
* The M flag in kernel configuration compiles options as separate modules. * The M flag in kernel configuration compiles options as separate modules.
* The N (or a blank space in menuconfig) flag in kernel configuration will not build selected option. * The N (or a blank space in __menuconfig__) flag in kernel configuration will not build selected option.
* List hardware and kernel modules in use. * List hardware and kernel modules in use.
@ -62,7 +62,7 @@ This process makes a .config file in the kernel source directory determines whic
`cat /proc/meminfo` `cat /proc/meminfo`
`lsmod` `lsmod`
* OPTION 1: Start a menu and browse options. Requires curses library but likely is already on your computer. Press "H" or "?" to see help. You can use the space bar to cycle between the available choices or press the appropriate key mentioned above. Pressing "/" to search for keywords. * OPTION 1: Start a menu and browse options. Requires curses library but likely is already on your computer. Press "__H__" or "__?__" to see help. You can use the space bar to cycle between the available choices or press the appropriate key mentioned above. Pressing "__/__" to search for keywords.
`make menuconfig` `make menuconfig`
* OPTION 2: Will make questions on what kernel options to support when it finds new kernel options not marked on an existing config file (takes time and and if you are using a striped down config file it requires you knowledge). * OPTION 2: Will make questions on what kernel options to support when it finds new kernel options not marked on an existing config file (takes time and and if you are using a striped down config file it requires you knowledge).
@ -78,61 +78,54 @@ Can take minutes to hours.
* Clean directory (wont touch the config file just remove all compiled files from the kernel tree). * Clean directory (wont touch the config file just remove all compiled files from the kernel tree).
`make clean` `make clean`
_NOTE_: The "-j<X>" flag, where <X> is the number of cores +1, is OPTIONAL and only goes if you have a processor with multiple cores. If you install ccache (OPTIONAL) you can speed up subsequent compilations by including CC="ccache gcc" after the "-j<X>" flag. __NOTE__: The __-j<X>__ flag, where __<X>__ is the number of cores +1, is __OPTIONAL__ and only goes if you have a processor with multiple cores. If you install __ccache__ (__OPTIONAL__) you can speed up subsequent compilations by including __CC="ccache gcc"__ after the __-j<X>__ flag.
`make -j<X> <OTHER_FLAGS>` `make -j<X> <OTHER_FLAGS>`
* OPTION A: Compile and move everything to its place. The "all" flag makes modules AND the bzImage at the same time (replaces "bzImage" and "modules" flags). * __OPTION A__: Compile and move everything to its place. The "__all__" flag makes modules AND the __bzImage__ at the same time (replaces "__bzImage__" and "__modules__" flags).
`make -j<X> all modules_install install` `make -j<X> all modules_install install`
* OPTION B: One by one * __OPTION B__: One by one
* If your configuration does not contain answers for all of the options, especially if they are new and not currently included in your running kernel, you will need to answer the prompts for these options. * If your configuration does not contain answers for all of the options, especially if they are new and not currently included in your running kernel, you will need to answer the prompts for these options.
`make -j<X> bzImage` `make -j<X> bzImage`
## MOVE KERNEL IMAGE ## MOVE KERNEL IMAGE
* OPTION B1: Copy the new kernel to /boot, create the initrd file and change the GRUB menu. * __OPTION B1__: Copy the new kernel to __/boot__.
`cp arch/<YOUR_ARCHITECTURE>/boot/bzImage /boot/vmlinuz` `cp arch/<YOUR_ARCHITECTURE>/boot/bzImage /boot/vmlinuz`
* Not required for booting but some processes need it. * Not required for booting but some processes need it.
`cp System.map /boot` `cp System.map /boot`
* OPTION B2: Automatically move kernel to /boot (and in certain distros, symlink the new kernel to /boot/vmlinuz and update the bootloader configuration). * __OPTION B2__: Automatically move kernel to __/boot__ (and in certain distros, symlink the new kernel to __/boot/vmlinuz__ and update the bootloader configuration).
`make install` `make install`
## BUILD MODULES ## BUILD MODULES
* Compile individual files for each question you answered M during kernel config. The object code is linked against your freshly built kernel. (For questions answered Y, these are already part of vmlinuz, and for questions answered N they are skipped). Modules end with .ko. * Compile individual files for each question you answered M during kernel config. The object code is linked against your freshly built kernel. (For questions answered __Y__, these are already part of __vmlinuz__, and for questions answered __N__ they are skipped). Modules end with __.ko__.
`make -j<X> modules` `make -j<X> modules`
## MOVE MODULES ## MOVE MODULES
* Copy generated kernel modules to /lib/modules/<KERNEL_VERSION>/. * Copy generated kernel modules to __/lib/modules/<KERNEL_VERSION>/__.
`make modules_install` `make modules_install`
_NOTE_: The vmlinuz can be any name but that exact name has to be added to the configuration file of your bootloader of choice. Usually a version number is appended to the new kernel image. This has the advantage to avoid replacing a current kernel and having a fallback as backup to boot. You can set to boot from any image in the bootloader once you configure them in the bootloader. __NOTE__: The __vmlinuz__ can be any name but that exact name has to be added to the configuration file of your bootloader of choice. Usually a version number is appended to the new kernel image. This has the advantage to avoid replacing a current kernel and having a fallback as backup to boot. You can set to boot from any image in the bootloader once you configure them in the bootloader.
## INITRD ## INITRD
* The initrd is used only while booting, unless you compile the kernel with the filesystem it resides on (initfs) * The __initrd__ is used only while booting, unless you compile the kernel with the filesystem it resides on (__initfs__)
* OPTION 1: Compile the kernel with an initfs. * OPTION 1: Compile the kernel with support for the filesystem used in the __/boot__ partition (__initfs__).
* OPTION 2: Use mkinitrd. * OPTION 2: Use __mkinitrd__.
`mkinitrd -o /boot/initrd.img` `mkinitrd -o /boot/initrd.img`
* OPTION 3: Use initramfs. * OPTION 3: Use __initramfs__.
`update-initramfs -u` `update-initramfs -u`
## COMPILE A SINGLE MODULE ## COMPILE A SINGLE MODULE
* Only compile a module. * Only compile a module.
`cd linux-<VERSION_NUMBER>/` `cd linux-<VERSION_NUMBER>/`
* Create files required for compiling external modules. * Create files required for compiling external modules.
`make modules_prepare` `make modules_prepare`
* Compile modules. * Compile modules.
`make M=<DIRECTORY_WHERE_MODULE_IS_LOCATED>` `make M=<DIRECTORY_WHERE_MODULE_IS_LOCATED>`
* Move module to <VERSION_NUMBER>. * Move module to __<VERSION_NUMBER>__.
`cp <DIRECTORY_WHERE_MODULE_IS_LOCATED>/<NAME_OF_MODULE>.ko /lib/modules/$(uname -r)/` `cp <DIRECTORY_WHERE_MODULE_IS_LOCATED>/<NAME_OF_MODULE>.ko /lib/modules/$(uname -r)/`
* Or * Or
`cp <DIRECTORY_WHERE_MODULE_IS_LOCATED>/<NAME_OF_MODULE>.ko /lib/modules/` `cp <DIRECTORY_WHERE_MODULE_IS_LOCATED>/<NAME_OF_MODULE>.ko /lib/modules/`
@ -141,36 +134,34 @@ _NOTE_: The vmlinuz can be any name but that exact name has to be added to the c
## DKMS ## DKMS
To update modules automatically when changing a kernel use DKMS. Requires the dkms package and the module source code. To update modules automatically when changing a kernel use __DKMS__. Requires the __dkms__ package and the proper module source code.
* Create a directory. * Create a directory.
`mkdir /usr/src/<MODULE>-<MODULE_VERSION>/` `mkdir /usr/src/<MODULE>-<MODULE_VERSION>/`
* Copy the source code of the module. * Copy the source code of the module.
`cp -a * <DIRECTORY_WHERE_MODULE_IS_LOCATED>` `cp -a * <DIRECTORY_WHERE_MODULE_IS_LOCATED>`
* Create a dkms.conf file in the directory. * Create a __dkms.conf__ file in the directory.
`vi /usr/src/<MODULE>-<MODULE_VERSION>/dkms.conf` `vi /usr/src/<MODULE>-<MODULE_VERSION>/dkms.conf`
* Edit. * Edit __dkms.conf__.
`PACKAGE_NAME="<MODULE>"` `PACKAGE_NAME="<MODULE>"`
`PACKAGE_VERSION="<MODULE_VERSION>"` `PACKAGE_VERSION="<MODULE_VERSION>"`
`BUILT_MODULE_NAME[0]="<MODULE>"` `BUILT_MODULE_NAME[0]="<MODULE>"`
`DEST_MODULE_LOCATION[0]="/kernel/<SECTION>/<MODULE>/"` `DEST_MODULE_LOCATION[0]="/kernel/<SECTION>/<MODULE>/"`
`AUTOINSTALL="yes"` `AUTOINSTALL="yes"`
* Add <MODULE> and <MODULE_VERSION> to DKMS. * Add __<MODULE>__ and __<MODULE_VERSION>__ to __DKMS__.
`dkms add -m <MODULE> -v <MODULE_VERSION>` `dkms add -m <MODULE> -v <MODULE_VERSION>`
* Compile the module with DKMS. * Compile the module with __DKMS__.
`dkms build -m <MODULE> -v <MODULE_VERSION>` `dkms build -m <MODULE> -v <MODULE_VERSION>`
* Install the module with DKMS. * Install the module with __DKMS__.
`dkms install -m <MODULE> -v <MODULE_VERSION>` `dkms install -m <MODULE> -v <MODULE_VERSION>`
## KERNEL PATCH ## KERNEL PATCH
You can find patch files on the Linux Kernel Mailing List https://lkml.org/. You can find patch files on the Linux Kernel Mailing List https://lkml.org/.
* Go to kernel source tree. * Go to kernel source tree.
`cd /usr/src/linux-<VERSION_NUMBER>` `cd /usr/src/linux-<VERSION_NUMBER>`
* Download the patch file there. * Download the patch file there.
* Following options assume is gzipped. * Following options assume is __gzipped__.
* OPTION 1: Git can be used to fallback from the patch and revert to the upatched source. * OPTION 1: Git can be used to fallback from the patch and revert to the upatched source.
* Uncompress patch file. * Uncompress patch file.
@ -179,7 +170,7 @@ You can find patch files on the Linux Kernel Mailing List https://lkml.org/.
`git am <PATCH_FILE>` `git am <PATCH_FILE>`
* To revert a single patch. * To revert a single patch.
`git apply -R <PATCH_FILE>` `git apply -R <PATCH_FILE>`
* To revert several patches first see the git log. * To revert several patches first see the __git log__.
`git log --pretty=oneline --abbrev-commit` `git log --pretty=oneline --abbrev-commit`
* Select the proper number from the first column. * Select the proper number from the first column.
`git reset --hard <FIRST_COLUMN_NUMBER>` `git reset --hard <FIRST_COLUMN_NUMBER>`
@ -187,10 +178,10 @@ You can find patch files on the Linux Kernel Mailing List https://lkml.org/.
* OPTION 2: Patch command * OPTION 2: Patch command
* Uncompress patch file. * Uncompress patch file.
`gunzip <PATCH_FILE>.gz` `gunzip <PATCH_FILE>.gz`
* The -p flag specifies a number of leading directories to remove, location is at the top of the patch file filename and is relative to the current directory. * The __-p__ flag specifies a number of leading directories to remove, location is at the top of the patch file filename and is relative to the current directory.
`patch -p1 < <PATCH_FILE>` `patch -p1 < <PATCH_FILE>`
* OPTION 3: Use patch with zcat to use the uncrompressed file directly. * OPTION 3: Use patch with __zcat__ to use the uncrompressed file directly.
`zcat <PATCH_FILE>.gz | patch -p1` `zcat <PATCH_FILE>.gz | patch -p1`