Difference between revisions of "Modprobed-db"

From ArchWiki
Jump to navigation Jump to search
m (→‎Using the Official Arch kernel PKGBUILD: 'make localmodconfig' should be run after 'make olddefconfig' instead of before)
(→‎Data Recall: simplify and remove warning which seems to be invalid (tested with 5.2.9))
 
Line 40: Line 40:
  
 
=== Data Recall ===
 
=== Data Recall ===
As mentioned earlier, this script is meant to be used in concert with the '''make localmodconfig''' step of compiling a kernel.  After the database has been adequately populated, simply invoke {{ic|/usr/bin/modprobed-db recall}} (as the root user) prior to compiling a kernel to load all modules followed by the '''make localmodconfig''' to do the magic.
+
After the database has been adequately populated, it can be read directly by [https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git/tree/README?id=refs/tags/v4.3.3#n205 make localmodconfig]
 
 
{{Warning|Previous recommendation was to execute the following rather than calling {{ic|modprobed-db recall}} BUT doing so gives kernel packages missing modules. It is therefore recommended NOT to build like this: {{ic|<nowiki>make LSMOD=$HOME/.config/modprobed.db localmodconfig</nowiki>}}.}}
 
  
 
==== Using the Official Arch kernel PKGBUILD ====
 
==== Using the Official Arch kernel PKGBUILD ====
If your user has sudo rights to call {{ic|/usr/bin/modprobed-db}}, the official Arch kernel PKGBUILD can be modified as shown to do this automatically.  If not, remember to manually run the script in recall mode before starting the build:
+
The official Arch kernel PKGBUILD can be modified as shown to do this automatically:
  
 
{{bc| ...
 
{{bc| ...
Line 56: Line 54:
 
   make olddefconfig
 
   make olddefconfig
  
   <nowiki>sudo modprobed-db recall                      # <---- insert this line</nowiki>
+
   <nowiki>make LSMOD=$HOME/.config/modprobed.db localmodconfig         # <---- insert this line</nowiki>
  <nowiki>make localmodconfig                           # <---- insert this line</nowiki>
 
  
 
   make -s kernelrelease > ../version
 
   make -s kernelrelease > ../version

Latest revision as of 11:35, 24 August 2019

modprobed-dbAUR keeps a running list of ALL modules ever probed on a system and allow for easy recall. This is very useful for users wishing to build a minimal kernel via a make localmodconfig which simply takes every module currently probed and switches everything BUT them off in the .config for a kernel resulting in smaller kernel packages and reduced compilation times.

Installation and Setup

The modprobed-dbAUR package is available from the AUR.

  1. Run modprobed-db which will create $XDG_CONFIG_HOME/modprobed-db.conf if one does not already exist.
  2. Run modprobed-db store to store the current loaded modules.

Optionally: add modules in the ignore array that you do NOT want counted, for example modules that get built or that are provided by another package. Some common ones are included by default:

$ cat ~/.config/modprobed-db.conf
IGNORE=(nvidia vboxdrv vboxnetflt vboxnetadp vboxpci lirc_dev lirc_i2c
osscore oss_hdaudio oss_usb tp_smapi thinkpad_ec
zavl znvpair zunicode zcommon zpios zfs spl splat)

Usage

Once the initial database has been created, simply use the system (insert USB sticks, use hardware that requires modules, mount filesystems that require modules, etc.) and periodically update the databases by one of two automatic methods:

Cron

The most convenient method to use modprobed-db is to simply add a crontab entry invoking /usr/bin/modprobed-db store at some regular interval.

Example running the script once every hour:

$ crontab -e
0 */1 * * *   /usr/bin/modprobed-db store &> /dev/null

Systemd

Systemd users not wishing to use cron may use the included user service: modprobed-db.service. It will run modprobed-db in store mode once per hour, and at boot and on shutdown.

$ systemctl --user enable --now modprobed-db.service

Status of the service and of the timer can be queried like any service and timer:

$ systemctl --user status modprobed-db
$ systemctl --user list-timers

Data Recall

After the database has been adequately populated, it can be read directly by make localmodconfig

Using the Official Arch kernel PKGBUILD

The official Arch kernel PKGBUILD can be modified as shown to do this automatically:

 ...
    msg2 "Applying patch $src..."
    patch -Np1 < "../$src"
  done

  msg2 "Setting config..."
  cp ../config .config
  make olddefconfig

  make LSMOD=$HOME/.config/modprobed.db localmodconfig          # <---- insert this line

  make -s kernelrelease > ../version
 ...

Recommendations

It is recommended that users install the package and then "use" the system for a good amount of time to allow the database to grow based on usage and capture everything the system needs before building a kernel with a make localmodconfig. Some suggested actions to allow appropriate modules to load and get cataloged:

  • Insert every kind of removable media (USB, DVD, CD, etc.)
  • Use every device on the machine (wifi, network, USB stuff like cameras, ipods, etc.)
  • Mount every kind of filesystem one might typically use including ext2/3/4, fat, vfat, CIFS shares, NFS shares, etc.
  • Use as many applications (that one would normally use) as possible in order to capture modules on which they depend. For example, IP blocking/filtering software like pgl-cliAUR.
  • Users who plan to mount iso image file should do so (this will make sure to capture the loop and isofs modules).
  • Users requiring encryption software such as truecrypt should make sure to load it, and mount some encrypted containers to ensure that the needed crypto modules are in the db.
  • Try-out different Linux-kernels; they may include modules not enabled in the default/other kernel(s)

Suggested Modules

  • cifs
  • ext2
  • ext3
  • ext4
  • fat
  • isofs
  • loop
  • efivars
  • vfat
  • usb_storage

Benefits of modprobed-db with make localmodconfig in custom kernels

  1. Reduced kernel footprint on FS
  2. Reduced compilation time

Comparisons using version 3.8.8-1 of the Arch kernel (from ABS):

Note: The modprobed.db on the test machine contains 209 lines; YMMV based on specific usage and needs.
Machine CPU # of threads make localmodconfig # of Modules Modules' Size on HDD Compilation Time
Intel i7-3770K @ 4.50 GHz 8 No 3,025 129 MB 7 min 37 sec
Intel i7-3770K @ 4.50 GHz 8 Yes 230 18 MB 1 min 13 sec
Intel Q9550 @ 3.40 GHz 4 No 3,025 129 MB 14 min 21 sec
Intel Q9550 @ 3.40 GHz 4 Yes 230 18 MB 2 min 20 sec
Intel E5200 @ 3.33 GHz 2 No 3,025 129 MB 34 min 35 sec
Intel E5200 @ 3.33 GHz 2 Yes 230 18 MB 5 min 46 sec
  • 13x less modules built
  • 7x less space
  • 6x less compilation time

Number of modules found by:

find /scratch/linux-3.8 -name '*.ko' | wc -l

Size on HDD found by:

find /scratch/linux-3.8 -name '*.ko' -print0 | xargs -0 du -ch

Compilation time found by entering a preconfigured linux-3.8.8 (using stock Arch config):

$ time make -jx modules
Note: The Arch standard is to gzip each module; the numbers shown in the table above are not gzip'ed but the savings ratio will be unaffected by this.