Gentoo-Fu: Optimizing the build process

This is another Gentoo post, not strictly related to KDE, but a follow-up to my previous post, building KDE branches (such as 4.9 and master). Ccache can greatly reduce the build time for these constantly updated packages, but here I’ll present some other tips & tricks. These optimizations are applied system-wide and will therefore improve the build process for all packages, not just live/KDE-specific.

These optimizations are backed up by testing data which I myself performed on my system (Intel Core i5 3570K @ 3.40 GHz, 8GB DDR3 RAM @ 1333Mhz) in a proper environment (each run was performed after a cold boot to avoid any unwanted caching by the OS). The following optimizations were tested:

  • Moving the build directory to RAM (tmpfs)
  • Quiet build (redirect build output to log files)
  • Building multiple packages at once
  • Performing debug-less builds

Another possible optimization is setting emerge’s niceness to a more appropriate level, but I didn’t get around to testing it.

Building from RAM & Quiet Builds

The first test was timing the build process for kdelibs (without ccache and after a cold boot as explained above). It includes the first two optimizations in order to create a nice comparison table (HDD/RAM building and --quiet-build=y/n). Furthermore this test was conducted both in a non-accelerated KMS console (booting in single-user mode) and in an accelerated X-console (Konsole in a KDE session).

Before dumping the results, I will explain how the used optimizations were achieved:

Moving the build directory to RAM (tmpfs):

This is easily done with the following command:

mount tmpfs /var/tmp/portage/ -t tmpfs -o uid=250,gid=250,mode=0775,size=75%

To make it permanent add the following line in /etc/fstab:

tmpfs /var/tmp/portage tmpfs uid=250,gid=250,mode=0775,size=75% 0 0

So we actually mount a tmpfs instance over /var/tmp/portage (portage’s default build path), assign proper read/write privileges to the ‘portage’ user and group (preserving the original mode bits) and set a maximum size of 75% of your RAM. As a side note, tmpfs mounts act as a stack: when you umount this tmpfs instance, the original /var/tmp/portage contents will be revealed underneath (more information in this excellent article). Setting the appropriate permissions is quite straight-forward; I have just retained the original values. Lastly, setting a size of 75% of your RAM ups the default value of 50% (useful for packages with a large code base – i.e. chromium). You really shouldn’t set ‘size=0’ (i.e. disable size restrictions): a memory-hungry build will irreversibly hog and crash your machine instead of getting killed for running out of memory (more information in the above article and in the kernel’s following file: Documentation/filesystems/tmpfs.txt). This isn’t very cool: I did this with a chromium debug build on RAM and the kernel eventually crashed!

I would also advise you to enable the “fail-clean” FEATURE in your /etc/make.conf to free valuable space in your RAM when a build fails.

Quiet build (redirect build output to log files):

You can enable quiet builds by appending --quiet-build=y to emerge’s arguments. By default it is set to ‘n’. To make it permanent, just append it to the EMERGE_DEFAULT_OPTS variable in /etc/make.conf.

Before proceeding, you should also set PORT_LOGDIR="/var/log/portage" in /etc/make.conf to redirect the build output to log files in this directory, otherwise the build output is simply lost. This way you lose no functionality, you can always monitor the build output from another virtual console.

Lastly, the “clean-logs” FEATURE will periodically delete old build logs (older than one week by default).

So, having explained the optimizations used, I will present the test data. The test was run only once in each configuration but is quite representative:

Non-accelerated console:

HDD build: 10m 3.707s

RAM build: 9m 52.246s

HDD+quiet build: 8m 35.364s

RAM+quiet build: 8m 22.819s

Accelerated console:

HDD build: 8m 47.189

RAM build: 8m 33.321s

HDD+quiet build: 8m 35.187s

RAM+quiet build: 8m 23.945s

Obviously the non-accelerated console lags considerably when printing the build output. Other than that, a RAM build saves you ~12s in this case, plus considerably less HDD spinning noises. A quiet build gives another 10s speedup. It’s really not that great a speedup, but both optimizations are easily applied, so why not have them?

Building multiple packages at once

For this test, I timed the build process for amarok, k3b, kdevelop and ktorrent in a single run. Same conditions as above, with RAM+quiet build enabled in a KMS console. This test was quite straightforward: the only thing changing was the number of parallel jobs that portage was processing (-j emerge argument):

1 parallel job (-j1): 9m 9.950s

2 parallel jobs (-j2): X 8m 9.904s

3 parallel jobs (-j3): 8m 7.315s

Unlimited(=4) parallel jobs (-j): X 8m 10.261s

X denotes a build failure due to the compiler crashing. So, although it brought some nice speed improvements, I wouldn’t recommend running multiple jobs due to instability. I guess this is more oriented towards distcc/multiprocessor-powered systems.

Performing debug-less builds

This is not really an optimization; I included it mainly for comparison to the debug builds above and to lay out the procedure of enabling per-package debug-less builds. This can be really useful for certain packages (such as chromium) which fail to build in-RAM due to memory shortage (debug builds are extremely memory-consuming).

So the only test done here was building amarok, k3b, kdevelop and ktorrent (as above), with RAM+quiet build enabled in a KMS console, one parallel job, after disabling debug symbols generation (explained below). The result is 7m 47.164s. I actually expected this to be lower, but it seems that debug builds are not that time-consuming after all.

To enable debug symbol generation (extensive article here) I have “-ggdb” in my CFLAGS variable in /etc/make.conf and “compressdebug splitdebug” in the FEATURES variable. This generates debug symbols for all installed packages (located under /usr/lib/debug).

To disable debug symbol generation you have to make a per-package configuration (a list of excluded packages from the debug configuration mentioned above). Create /etc/portage/package.env and add the following line (chromium used as an example):

www-client/chromium nodebug.conf

We inform portage that the www-client/chromium package will be installed with the configuration variables listed in /etc/portage/env/nodebug.conf. The contents of this file are the following:

CFLAGS="-march=native -O2 -pipe"
CXXFLAGS="${CFLAGS}"
FEATURES="${FEATURES} -compressdebug -splitdebug"

CFLAGS here is exactly the same as in /etc/make.conf, excluding “-ggdb”. So, you get the idea. Another good use of per-package environment variables, related to this post, is specifying a different build directory (which is not on RAM). Instructions here.

Conclusion

All in all, no optimization will yield more than a few seconds speedup. However, after running all these tests, I have permanently enabled RAM+quiet builds. Performing the build from RAM makes way more sense: you keep HDD activity at a minimum so that other I/O processes can run in parallel without considerable lagging, you get a lot less noise, plus a small boost in the build times. Same goes for quiet builds which bring only advantages (you can always monitor the build output from another virtual console as explained above).

Advertisements

Gentoo-Fu: Building KDE branches

Being a happy Gentoo user myself for about half a year, I thought I would share some tips from my personal experiences on this great distro. It’s nothing you cannot already google for; these are just some ideas/motives to further dig into for yourselves. Mayhaps I will write another post or two about Gentoo. If I ever decide to overcome my laziness 🙂 Take it easy with this post, it’s a bit lengthy, but to quote Blaise Pascal: “I haven’t had time to make it shorter yet“.

Gentoo being a source-based distribution allows for some very cool stuff like building from an upstream git branch. You can find ebuilds for KDE branches 4.9 and master (as of 17.08.2012), which can vastly help you with bug triaging/fixing. Bug triaging is as easy as updating your system from this branch and trying to reproduce bugs (the procedure is fully automated thanks to Portage’s Moo Powers – “emerge --moo” – and the Gentoo Developers). Bug fixing is as easy as writing a patch and applying it using Portage’s excellent patching abilities. I actually *fixed* a bug like this recently (Bug #297209), being too lazy to manually pull and compile the source code. Sure, a manual setup is way more flexible, but doesn’t come without quite some hassles.

These ebuilds are available from overlays [1] and there is a full-blown guide on how to install KDE from these ebuilds [2]. I won’t go into much detail here, these guides are more than enough; I will simply mention what the situation is like on my system. Actually I will simply quote my system updating process (it slowly builds into a ritual the more you delve into Gentoo) and more details will pop up in time:

# layman -S; emerge --sync
# emerge -uDNavbk --with-bdeps=y @world
# FEATURES="ccache" smart-live-rebuild -E -- -av1b
# emerge -ca; emerge -Pa; revdep-rebuild -- -av1b
# eclean-dist -dn; eclean-pkg; emaint -f all

So, let’s go through this and don’t forget: man pages are your friend.

# layman -S; emerge --sync

Updates the overlays and portage’s cache. Nothing fancy here. This is your “sudo apt-get update” friend, masqueraded. Or “sudo pacman -Sy”. Whatever; all distros share some core principles.

# emerge -uDNavbk --with-bdeps=y @world

Now, this is a beast of command line options. All over the net you will find references to -uDNav (I think it has almost become Gentoo’s “sudo apt-get upgrade”), but I have spiced it with some extra options. I will go shortly through these but “man emerge” is the way to go.

-u is shorthand for --upgrade. It pulls the latest versions of the packages specified – here we specified the @world set which is laid out in your world file [3]. In other words, these are your explicitly installed packages (all the other installed packages are dependencies to these).

-D is shorthand for --deep. It takes into consideration the whole dependency tree of the packages specified, not just their immediate dependencies. Without this you would only be updating the packages specified in the @world set along with their immediate dependencies.

-N is shorthand for --newuse. It takes into consideration packages that may not have new versions but whose USE flags have changed since last compilation. After meddling with USE in /etc/make.conf or /etc/portage/package.use, I always issue this update command to rebuild packages as necessary.

-a is shorthand for --ask. Always include this option (or -p/--pretend instead), otherwise Portage will move on without confirmation. You don’t want that.

-v is shorthand for --verbose. A little verbosity is always nice 🙂

-b is shorthand for --buildpkg. Just before installing a package, this option creates a binary package out of it and stores it in /usr/portage/packages/. It may hurt a bit your compilation times and your disk’s free space, but it comes in really handy if you move back and forth KDE’s branches like me. When I was testing my patch in multiple branches (4.8, 4.9, master) recently, the effort+time to switch between them was minimal. But this requires the next option:

-k is shorthand for --usepkg. Practically it instructs Portage to use binary packages created with -b, to [greatly] shorten compilation times.

–with-bdeps=y updates the build dependecies too. These are normally not included, Portage needs to be explictly told to do so, and I use it merely because I want a fully updated system (improves my Gentoo Feng-Shui).

So practically -uDNav is the de facto update command in Gentoo and -bk allows for using binary packages (which is really great: it never hurts to have some binary packages laying around, you never know when you’ll need them – especially useful when downgrading).

# FEATURES="ccache" smart-live-rebuild -E -- -av1b

This is where the fancy stuff happen. Ebuilds from the kde overlay pull the source code straight from KDE’s Git and Subversion repositories, but have a fixed version (e.g. the ebuilds from the 4.9 branch all have a version of 4.9.49.9999). This is not really cool because their version remains the same all the time and the update command I mentioned above won’t update these ebuilds. You either have to manually re-emerge these packages (after manually monitoring the source code repositories for commits – zero coolness points) or install a tool to monitor the remote git repositories for commits since the last time you compiled and update the packages as necessary. So, you need smart-live-rebuild (available in Gentoo’s official repos).

It will record the commit from which you built last time and in the future won’t rebuild this package unless a newer commit has occured. Extra coolness points. But it wouldn’t be that cool if it wasn’t combined with the preceding FEATURES=”ccache” (there is an official tutorial about configuring ccache for your reading pleasure [4]). I have configured it with a 5GB cache over here but I only use it for live ebuilds which need frequent re-compiling. ccache will slow down the first compilation a bit but future compilations will be blazing fast, which is the key to maintaining a fully updated installation from a KDE branch.

Command line options explained:

E is shorthand for --no-erraneous-merge. Simply don’t emerge packages for which the update has failed.

terminates the smart-live-rebuild options. Any remaining options will be directly passed on to emerge.

av1b we have gone through this. -1 stands for --oneshot and it won’t append the packages emerged to your world file [3]. Since these packages are already installed, you only wish to update them. -1 is definitely not necessary here as smart-live-rebuild explicitly includes --oneshot on its own. I include it for symmetry with the next command.

On the other hand, smart-live-rebuild is not that smart. KDE’s infrastructure often contains multiple packages in a single repository and a change to one will make smart-live-rebuild rebuild all the packages from this repository. For instance a change to ksmserver (which is a package contained in the kde-workspace Git repo) will rebuild *all* packages residing in this repo. Still, better than nothing 🙂

# emerge -ca; emerge -Pa; revdep-rebuild -- -av1b

This is my post-update command. It checks for unneeded packages and removes them as necessary. -c is shorthand for --depclean. -P on the other hand stands for --prune and is of similar use to –depclean, but to be honest, it hasn’t occured to me yet that –prune detects an unneeded package that –depclean hasn’t already detected. I include it for Feng-Shui reasons (it’s a fast operation so no big deal).

revdep-rebuild is another must-have tool for any sensible Gentoo user; it detects broken references to libraries (i.e. when updating to newer versions of libraries) and rebuilds packages as needed. Its command line options are explained above. Make a habit of running revdep-rebuild after every update command in order to avoid system breakage!

# eclean-dist -dn; eclean-pkg; emaint -f all

Lastly, my system maintainance command. It removes old dist files (a.k.a. source code tarballs used for emerging) along with old binary packages. Default behavior is to keep the files from packages whose version still exists in the Portage tree (as newer versions roll out, old versions are removed from the Portage tree). This can take a hell of a time for dist files because it checks the entire Portage tree several times! -dn greatly reduces this time by only keeping installed versions. This is great for a rebuild but no good for downgrading. But since you have created binary packages for previous versions, you don’t have to recompile in order to downgrade! So, problem effectively solved 😉

emaint checks for all kinds of problems in your installation and tries to -fix them. Nifty small utility.

[1] Gentoo Overlays: Users’ Guide

[2] Gentoo KDE Guide

[3] /var/lib/portage/world

[4] Caching Compilation

Debian, Ubuntu & Arch Packages for GRUB2 Editor

Thanks to openSUSE Build Service GRUB2 Bootloader Editor got packages for:

and thanks to community contribution it also got packaged for Arch Linux.

Edit: GRUB2 Editor is now packaged for many more distributions. Please check the Downloads page.