Distcc/de

Distcc ist ein Programm, das die einzelnen Aufgaben bei der Kompilierung eines Paketes auf verschiedene Hosts in einem Netzwerk verteilt. Es besteht aus einem Server, distccd und einem Client-Programm, distcc. Mit geringem Aufwand ist es möglich ccache, Portage und Automake zu benutzen.

Distcc ist ein Programm, das die einzelnen Aufgaben bei der Kompilierung eines Paketes auf verschiedene Hosts in einem Netzwerk verteilt. Es besteht aus einem Server, distccd und einem Client-Programm, distcc. Mit geringem Aufwand ist es möglich ccache, Portage und Automake zu benutzen.

Bevor verwendet wird um eine Gentoo bootstrap Installation durchzuführen, wird empfohlen die Anleitung unter Using distcc to bootstrap gelesen zu haben.

Installation
Das Packet sollte auf allen teilnehemenden Hosts installiert sein, bevor mit der Konfiguration von  begonnen wird.

Anforderungen an die teilnehmenden Rechner
sollte nur verwendet werden, wenn alle beteiligten Rechner die gleiche GCC-Hauptversion benutzen. Zum Beispiel ist das Verwenden von 3.3.x (x ist hier beliebig) problemlos, dagegen sollte 3.3.x nicht mit 3.2.x gemixt werden.

Emerge
Distccd beinhaltet ein graphisches Tool zur Überwachung der Aufgaben die ein Rechner an andere Hosts übertragen hat. Dieses Tool ist verfügbar, wenn das USE Flag  gesetzt wird.

Wenn die USE-Flags entsprechend angepasst sind, kann mit der Installation des Paketes begonnen werden:

Server
Im Folgenden wird beschrieben, wie vorgegangen werden muss, um automatisch zu starten.

OpenRC
Es ist sicher zu stellen, dass alle teilnehmenden Hostes in mittels   als vertrauenswürdig benannt sind. Um die sicherheit zu erhöhen, kann mit  der  auf eine bestimmte Netzwerkschnittstelle gebunden werden. Mehr Informationen zum Thema Sicherheit kann unter Distcc security notes abgerufen werden.

Im folgenden Beispiel wird den Rechnern mit den IP-Adressen  und   die Verbindung zum lokalen  server erlaubt:

Der daemon ist auf allen beteiligten Rechnern zu starten.

systemd
Um mehreren Rechnern aus einem bestimmten Adressbereich den Zugriff zu erlauben, so ist dieser Bereich im CIDR Format in einzutragen. Im folgenden Beispiel wird allen Rechnern mit der IP-Adresse 192.168.1.xxx der Zugriff erlaubt:

Mit dem folgendem Befehl wird der Dienst neu eingelesen:

Die folgenden Befehle starten während des Boot-Vorganges zu starten bzw. sofort.

Teilnehmende Rechner auflisten
Hierfür wird der Befehl verwendet.

Im Folgenden sind verschiedene Varianten der Host-Definition zu sehen. Mit dem Zeichen  wird ein Limit gesetzt, wie viele Aufgaben diesem Host gleichzeitig übergeben werden können. Die Zeilen 3 und 4 werden in der distcc manual page näher erläutert.

Es gibt noch weitere Methoden um teilnehmende Hosts anzugeben. Einzelheiten dazu enthält die Manpage.

Ohne die Angabe  wird  keinen Kompiliervorgang auf dem lokalen Rechner anstoßen. Handelt es sich bei dem lokalen Host um einen langsamen Rechner, kann dieser sich als Flaschenhals des Übersetzungsvorganges herausstellen. Die bestmöglichen Einstellungen für das eigene Setup können nur durch Experimentieren mit dem  Eintrag herausgefunden werden.

Der folgende Befehl konfiguriert so, dass die Aufgaben auf die Rechner der 1.Zeile im obigen Beispiel verteilt werden:

In ist ein "pump" Modus implementiert, dieser wird durch den Befehl  aufgerufen. Dieser Modus kann zu einer beträchtlichen Einsparung an Rechenzeit führen, wenn viele verschiedene Dateien gleichzeitg übersetzt werden müssen. Es werden übersetzte Header-Dateien auf dem Server zwischengespeichert, wadurch sich bei wiederholten Upload Zeitersparnisse ergeben.

Um für einen Host den pump-Modus zu aktivieren, werden die Flags  an dessen Definition angehängt. Der Pump-Modus benötigt  und , ungeachtet ob es sich bei den zu übersetzenden Dateien um C oder C++-Quelltext handelt.

für Portage
Portage für die Benutzung mit einzurichten, ist einfach. Es muss nur die  Option mit den gewünschten Modi in make.conf definiert werden. Weiterhin ist die  Variable an die gewünschte Anzahl anzupassen.

Die MAKEOPTS und FEATURES ist wie unten gezeigt zu setzen:

Es wird folgende Strategie empfohlen:
 * ist auf die Gesamtanzahl +1 (lokal und remote) an Rechnerkernen zu setzen
 * ist auf die Anzahl an lokalen Rechnerkernen zu setzen

Die Benutzung von  in der MAKEOPTS Variable, verhindert das Starten zu vieler lokaler Aufgaben, wenn entfernte Rechner nicht erreichbar sind oder die Vorgaben des Ebuild ein Übersetzen auf entfernten Rechner nicht zulassen. Es werden dann keine weiteren Jobs mehr gestartet, wenn die Systemlast auf einen Wert größer als  steigt.

Die Werte in der MAKEOPTS Varibalen können bei 2 PC mit einer QuadCore CPU auf denen und der lokale Rechner ist eine DualCore CPU folgendermaßen belegt werden:

Wenn die bearbeitet wird, ist darauf zu achten, das nicht die   in CFLAGS oder CXXFLAGS verwendet wird. wird keine Aufgaben an Remote Hosts übertragen, wenn  auf   steht. Der passende  Wert kann durch folgenden Befehl herausgefunden werden:

Der [//blogs.gentoo.org/mgorny/2014/06/23/inlining-marchnative-for-distcc/ Blog-Eintrag] Inlining  for distcc enthält hierzu Hintergrundinformationen.

Mit automake
In einigen Fällen ist dies einfacher als das Portage-Setup. Hierzu ist die Reihenfolge der Suchpfade in der PATH Variablen folgendermaßen zu setzen:


 * 1)  (wenn verwendet)
 * 2)  (enthält /usr/bin/gcc)
 * 1)  (enthält /usr/bin/gcc)

Die obige Anweisung kann in der jedes einzelnen Benutzer hinterlegt werden, so dass die PATH Variable bei jedem Login entsprechend gesetzt wird. Um dieses Verhalten für alle Benutzer zu erreichen, kann diese Anweisung in einer Datei in gespeichert werden.

Der Befehl sollte nicht ohne zusätzliche Argumente aufgerufen werden, sondern mit dem Zusatz , wie früher in diesem Artikel beschrieben.

Verwendung für Bootstrapping
Wenn für das [//de.wikipedia.org/wiki/Bootstrapping_(Informatik) Bootstrapping] verwendet werden soll, z.B. um verschiedene Tools vor dem Hauptteil des Systems zu erstellen, sind einige vorbereitende Schritte erforderlich.

Schritt 1: Konfiguration von Portage
Der neue Rechner ist mit einer Gentoo Linux LiveCD zu starten und den Installations-Anweisungen des Handbuches zu folgen, mit besonderem Augenmerk auf die Informationen aus der FAQ für [//wiki.gentoo.org/wiki/FAQ/de Bootstrapping]. Danach ist Portage für die Verwendung von zu konfigurieren:

Die  Variable ist für die Installation wie folgt zu setzen:

Schritt 2: Installation von distcc
Für die Installation von ist folgendes Kommando zu verwenden:

Schritt 3: Konfiguration von distcc
Für das Setup von ist der Befehl  aufzurufen, hierzu sind die   im folgenden Beispiel entsprechend der teilnehmenden Rechner mit ihrer IP-Adresse bzw. Host-Namen anzupassen.

ist nun bereit für das Bootstrapping! Nun kann mit den normalen Installationsanweisungen fortgefahren werden. Nachdem ausgeführt wurde, ist zwingend  erneut durchzuführen um sicherzustellen, dass die notwendigen Abhängigkeiten installiert werden.

Extras
Im Paket sind einige zusätzliche Funktionen und Tools enthalten, die die Arbeit in einer  Umgebung unterstützen.

Tools zur Überwachung
enthält zwei Überwachungs-Tools. Bei handelt es sich um eine Text basiertes Programm. Wird es das erste Mal aufgerufen, kann sich etwas Verwirrung einstellen, aber es ist sehr einfach zu benutzen. Wird das Programm ohne Parameter aufgerufen, beendet es sich nach einem Durchlauf. Wenn das Programm mit einem Parameter N aufgerufen wird, aktualisiert es die Anzeige der laufenden Aufgaben alle N Sekunden.

Das andere Tool zur Verfolgung des Build-Prozesses steht nur zur verfügung, wenn das USE-Flag   gesetzt ist. Dieses Programm basiert auf GTK+ und läuft in einer X-Window Umgebung. Für Gentoo wurde dieses Programm von nach  umbenannt, um Verwirrung zu vermeiden.

Für die Überwachung von Portage's werden die folgenden Kommandos verwendet:

Als Alternative bietet sich an dieses Verzeichnis DISTCC_DIR dauerhaft beim Login einzulesen:

Now update the environment:

Finally, start the GUI application:

SSH-verschlüsselte Kommunikation
Das Setup für SSH beinhaltet einige Fallstricke. Als Erstes wird ein SSH-Schlüsselpaar benötigt, welches die Authentifizierung ohne Passwortabfrage durchführt. Es sei darauf hingewiesen, das Portage die Progamme als Portage-User übersetzt oder als root wenn  nicht gesetzt ist. Das Heimat-Verzeichnis des Portage User ist, was zur Folge hat, dass die Schlüssel in gespeichert werden.

Second, create a section for each host in the SSH configuration file:

Send the public key to each compilation node:

Also make sure that each host is available in the file:

Fix the file ownership as follows:

To set up the hosts  and , run:

Please note the  (@ sign), which specifies ssh hosts for distcc.

Finally, tell which SSH binary to use:

It is not necessary to run the initscript on the hosts when  communicates via SSH.

Testing
To test, write a simple Hello distcc program and run in verbose mode to see if it communicates properly.

Next, turn on verbose mode, compile the program using and link the generated object file into an executable:

There should be a bunch of output about finding its configuration, selecting the host to connect to, starting to connect to it, and ultimately compile. If the output does not list the desired hosts, check the configuration.

Finally, ensure the compiled program works properly. To test each host, enumerate each compile host in the hosts file.

Troubleshooting
If a problem occurs while using, then this section might help in resolving the problem.

ERROR: failed to open
As of January 22nd, 2015 emerging fails to create the proper file in. This apparently only effects version 3.1-r8 of distcc. This bug is in the process of being corrected (see ). It is possible to work around this by manually creating the log file, giving it proper ownership, and restarting the distccd daemon:

Next update the path of the  configuration file in  to the  directory created in the step before:

Finally, restart the distccd service:

Some packages do not use distcc
As various packages are installed, users will notice that some of them aren't being distributed (and aren't being built in parallel). This may happen because the package' doesn't support parallel operations, or the maintainer of the ebuild has explicitly disabled parallel operations due to a known problem.

Sometimes might cause a package to fail to compile. If this happens, please report it.

Mixed GCC versions
If the environment hosts different GCC versions, there will likely be very weird problems. The solution is to make certain all hosts have the same GCC version.

Recent Portage updates have made Portage use  (minus gcc) instead of. This means that if i686 machines are mixed with other types (i386, i586) then the builds will run into troubles. A workaround for this may be to run:

It is also possible to set the CC and CXX variables in to the values list in the command above.

-march=native
Starting with GCC 4.3.0, the compiler supports the  option which turns on CPU auto-detection and optimizations that are worth being enabled on the processor on which GCC is running. This creates a problem when using because it allows the mixing of code optimized for different processors. For example, running with   on a system that has an AMD Athlon processor and doing the same on another system that has an Intel Pentium processor will mix code compiled on both processors together.

Heed the following warning:

To know the flags that GCC would enable when called with, execute the following:

Get more output from emerge logs
It is possible to obtain more logging by enabling verbose mode. This is accomplished by adding DISTCC_VERBOSE to :

The verbose logging can then be found in.

Keep in mind that the first invocation visible in  isn’t necessary the first  call during a build process. For example a build server can get a one-minute backoff period during the configuration stage when some checks are performed using a compiler ( sets a backoff period when compilation on a remote server failed, it doesn’t matter whether it failed on local machine or not).

Dig into the directory to investigate such situations. Find other logs, or call explicitly from within the working directory.

Another interesting variable to use is DISTCC_SAVE_TEMPS. When set, it saves the standard output/error from a remote compiler which, for Portage builds, results in files in the directory.

External resources

 * Inlining  for distcc
 * Distcc homepage