Distcc

From Gentoo Wiki
Jump to:navigation Jump to:search
This page is a translated version of the page Distcc and the translation is 59% complete.
Outdated translations are marked like this.
Other languages:
Deutsch • ‎English • ‎Türkçe • ‎español • ‎français • ‎italiano • ‎polski • ‎русский • ‎中文(中国大陆)‎ • ‎日本語 • ‎한국어
Resources

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 distcc verwendet wird um eine Gentoo bootstrap Installation durchzuführen, wird empfohlen die Anleitung unter Using distcc to bootstrap zu lesen.

Installation

Das Packet sys-devel/distcc sollte auf allen teilnehemenden Hosts installiert sein, bevor mit der Konfiguration von distcc begonnen wird.

Anforderungen an die teilnehmenden Rechner

distcc 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.

Stellen Sie sicher, dass alle Systeme dieselbe Version von binutils verwenden (eselect binutils list). Andernfalls können viele Pakete wegen der Verschiebung von relativen und absoluten Adressen im .elf Binary nicht übersetzt werden.

Die USE-Flags

USE flags for sys-devel/distcc Distribute compilation of C code across several machines on a network

gssapi Enable support for net-libs/libgssglue
gtk Add support for x11-libs/gtk+ (The GIMP Toolkit)
hardened Activate default security enhancements for toolchain (gcc, glibc, binutils)
ipv6 Add support for IP version 6
selinux !!internal use only!! Security Enhanced Linux support, this must be set by the selinux profile or breakage will occur
xinetd Add support for the xinetd super-server
zeroconf Support for DNS Service Discovery (DNS-SD)

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 gtk gesetzt wird.

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

root #emerge --ask sys-devel/distcc
Wichtig
An dieser Stelle wird nochmals darauf hingewiesen, erst auf allen teilnehmenden Hosts das Paket sys-devel/distcc zu installieren.

Konfiguration

Dienste

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

OpenRC

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

Jeder, der eine Verbindung zum distcc-Server-Port herstellen kann, kann als distccd-Benutzer beliebige Befehle auf diesem Computer ausführen.

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

DATEI /etc/conf.d/distccdErlaube bestimmten Rechners die Verbindung zu distccd
DISTCCD_OPTS="--port 3632 --log-level notice --log-file /var/log/distccd.log -N 15 --allow 192.168.0.4 --allow 192.168.0.5"

When logging to a file in /var/log, create the log and give appropriate permissions:

root #touch /var/log/distccd.log
root #chown distcc:root /var/log/distccd.log
Wichtig
Es ist wichtig --allow und --listen. Weitere Informationen hierzu in der distccd man page oder in der obigen Sicherheitsrichtlinie.

Der distccd daemon ist auf allen beteiligten Rechnern zu starten.

root #rc-update add distccd default
root #rc-service distccd start

systemd

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

DATEI /etc/systemd/system/distccd.service.d/00gentoo.confClients den Zugriff erlauben
Environment="ALLOWED_SERVERS=192.168.1.0/24"

Or an example with multiple clients and a manually specified log-level

DATEI /etc/systemd/system/distccd.service.d/00gentoo.confSetting ALLOWED_SERVERS
Environment="ALLOWED_SERVERS=127.0.0.1 --allow 192.168.1.0/24 --allow 10.1.1.1/24 --log-level error"
Notiz
Die Option "ALLOWED_SERVERS" ist irreführend, da nicht der Zugriff eines Servers, sondern Client-Rechnern das Verbinden mit dem lokalen distccd-Daemon erlaubt wird. Der Inhalt dieser Variablen wird dann an den distccd Service als --allow option übergeben. Weitere Informationen unter /usr/lib/systemd/system/distccd.service.
Wichtig
In contrast to OpenRC, environment variables put in /etc/env.d/* will not take effect for systemd users even after running env-update and restarting the distccd service. This is because /etc/environment.d generated by env-update is only sourced by systemd user instance. Whereas, distccd is spawned by systemd system instance.

To set the proper environment variables for distccd, place them into /etc/systemd/system/distccd.service.d/00gentoo.conf. For example,

DATEI /etc/systemd/system/distccd.service.d/00gentoo.conf
[Service]
Environment="ALLOWED_SERVERS=192.168.121.0/24"
Environment="DISTCC_VERBOSE=1"
Environment="DISTCC_SAVE_TEMPS=1"
Environment="CCACHE_DIR=/var/cache/ccache"
Warnung
The Environment= directive in /etc/systemd/system/distccd.service.d/00gentoo.conf file does not support variable expansion. Environment="PATH=/usr/lib/ccache/bin:$PATH" will be treated as is, therefore will not work as intended.

For workaround, you need to edit distccd.service by running the following command.

root #systemctl edit --full distccd.service

This will open up an editor. Change the line with ExecStart= directive to

CODE Workaround for appending to PATH
ExecStart=/bin/bash -c "PATH=/usr/lib/ccache/bin:$PATH exec /usr/bin/distccd --no-detach --daemon --port 3632 -N 15 --allow $ALLOWED_SERVERS --log-level debug"

Alternatively, you could also write a shell script wrapper for /usr/bin/distccd.

Mit dem folgendem Befehl wird der Dienst neu eingelesen:

root #systemctl daemon-reload

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

root #systemctl enable distccd
root #systemctl start distccd

Teilnehmende Rechner definieren

Hierfür wird der Befehl distcc-config 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.

CODE Beispiele für Host-Definitionen
192.168.0.1          192.168.0.2                       192.168.0.3
192.168.0.1/2        192.168.0.2                       192.168.0.3/10
192.168.0.1:4000/2   192.168.0.2/1                     192.168.0.3:3632/4
@192.168.0.1         @192.168.0.2:/usr/bin/distccd     192.168.0.3

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

Ohne die Angabe localhost wird distcc 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 localhost Eintrag herausgefunden werden.

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

root #/usr/bin/distcc-config --set-hosts "192.168.0.1 192.168.0.2 192.168.0.3"

In distcc ist ein "pump" Modus implementiert, dieser wird durch den Befehl pump 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 ,cpp,lzo an dessen Definition angehängt. Der Pump-Modus benötigt cpp und lzo, ungeachtet ob es sich bei den zu übersetzenden Dateien um C oder C++-Quelltext handelt.

root #/usr/bin/distcc-config --set-hosts "192.168.0.1,cpp,lzo 192.168.0.2,cpp,lzo 192.168.0.3,cpp,lzo"

Hosts also need to be in:

DATEI /etc/distcc/hostsShould match --set-hosts
192.168.0.1
192.168.0.2
192.168.0.3

Optionally, to set the maximum number of threads used by a host, add a forward slash "/" after each host:

DATEI /etc/distcc/hostsSpecify max number of threads
192.168.0.1/8
192.168.0.2/4
192.168.0.3/16

The same applies to the distcc-config command. If the maximum threads number is not specified, it will default to 4.

Benutzungshinweise

für Portage

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

Die MAKEOPTS und FEATURES ist wie unten gezeigt zu setzen:

Es wird folgende Strategie empfohlen:

  • N ist auf die Gesamtanzahl +1 (lokal und remote) an Rechnerkernen zu setzen
  • M ist auf die Anzahl an lokalen Rechnerkernen zu setzen

Die Benutzung von -lM 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 M steigt.

DATEI /etc/portage/make.confDefinition MAKEOPTS and FEATURES
# Für N und M sind die Werte des eigenen Setup einzusetzen
MAKEOPTS="-jN -lM"
FEATURES="distcc"

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

DATEI /etc/portage/make.confMAKEOPTS Beispiel für 2 QuadCore (remote) und einen DualCore (local) PC
# 2 * 4 Kerne remote = 8
# 1 * 2 Kerne lokal  = 2 
# Gesamtanzahl Kerne 10, also N = 2*10+1 und M=2
MAKEOPTS="-j21 -l2"

CFLAGS und CXXFLAGS

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

DATEI /etc/portage/make.confinlined *FLAGS
# Minimal list of flags is generated with:
#   $ diff -U0 <(LANG=C gcc -Q -O2 -march=sandybridge --help=target) <(LANG=C gcc -Q -O2 -march=native --help=target)
COMMON_FLAGS="-march=sandybridge -mtune=sandybridge -maes" # don't use -march=native!
CFLAGS="${COMMON_FLAGS}"
CXXFLAGS="${COMMON_FLAGS}"

Der Blog-Eintrag Inlining -march=native 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. ccache (wenn verwendet)
  2. /usr/lib/distcc/bin/
  3. ${PATH} (enthält /usr/bin/gcc)
root #export PATH="/usr/lib/ccache/bin:/usr/lib/distcc/bin:${PATH}"

Die obige Anweisung kann in der ~/.bashrc 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 /etc/env.d/ gespeichert werden.

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

With ccache

To make Ccache work with distcc, some prerequisites must be fulfilled:

  • Ccache is successfully set up locally
  • Distcc is successfully set up on the desired hosts

The following setup will work as follows:

CODE Flow diagram
[client]                                                      [remote]
ccache <miss?> → compile it and save cache files,
<hit?>           also distribute other source code → distccccache <miss?> → compile it, save cache files, return cache file to client
  ↓                                                           <hit?>
use the local cache file                                        ↓
                                                 return local cache file to client
Warnung
The following configuration must be done on all desired hosts!

Configure distccd

In order to let the daemon distccd use ccache, it must masquerade the path /usr/bin with /usr/lib/ccache/bin. Furthermore, when it uses ccache, ccache should use the prefix distcc:

DATEI /etc/conf.d/distccd
PATH="/usr/lib/ccache/bin:${PATH}"
CCACHE_PREFIX="distcc"

Additionally distccd must be aware of the environment variables DISTCC_DIR and CCACHE_DIR:

Warnung
These variables must be set somewhere in /etc/env.d/, otherwise ccache tries to put cache files in ${HOME}/.ccache/, which might result in a COMPILE_ERROR, due to insufficient permissions. To pinpoint this, use the testing example mentioned below and export DISTCC_SAVE_TEMPS="1" as mentioned here. This will provide error logs from the remote site in /tmp/ by default. The logs will look like this: distcc_server_stderr_*.txt. Be aware, that these environment variables cannot be set in /etc/conf.d/distccd, since they will not be read from distccd for some reason.
DATEI /etc/env.d/03distcc_ccache
CCACHE_DIR="/var/cache/ccache"
DISTCC_DIR="/var/tmp/portage/.distcc"

Next, update the environment variables:

root #env-update
>>> Regenerating /etc/ld.so.cache...

Finally, restart the daemon distccd to adapt all changes:

root #rc-service distccd restart

Configure ccache

Warnung
When using distcc with ccache, it is necessary to prepare the cache directories manually, since the daemon distccd only works with the user distcc for some reason and it cannot create directories within /var/cache/ccache/. It is not sufficient to add this user to the group portage. Also be aware, that the variable cache_dir_levels, defined in ccache.conf, specifies how many subdirectories have to be created. The following example uses the default, which is 2.

First, prepare the cache directories:

root #cd "/var/cache/ccache/"
root #mkdir {a..z} {0..9} tmp
root #for first_level_directory in $(find . -maxdepth 1 -type d -not -name "." -and -not -name "tmp"); do pushd "${first_level_directory}" >/dev/null; mkdir {a..z} {0..9}; popd >/dev/null; done

The second command (mkdir) will create the first level directories from a to z, 0 to 9 and tmp. The following for loop will then look for the first level directories (find . -maxdepth 1 -type d), excluding the current directory . and tmp (-not -name "." -and -not -name "tmp"). It then descends into each of them (pushd), creates the second level directories from a to z and 0 to 9 (mkdir) and goes back to the previous directory (popd), which is /var/cache/ccache/.

Wichtig
The current directory . must be excluded with -not -name ".", otherwise the first pushd command will go to the current directory . and then goes back to whatever directory is currently on the stack via popd. It will navigate through the entire stack until it is empty, creating directories, where each pushd command fails. If this happens, one can search for them using find / -type d -name "0" and remove them with rm --recursive [a-z] [0-9]. It is advised to this manually!

When the preparation is done, every directory - including the directory ccache itself - must be owned by the user distcc:

root #find /var/cache/ccache -type d -exec chown distcc:portage "{}" +

Configure portage

To use emerge with distcc and ccache, make sure, that both features are enabled and that CCACHE_DIR is set in /etc/portage/make.conf:

DATEI /etc/portage/make.conf
[...]
FEATURES="distcc ccache"
CCACHE_DIR="/var/cache/ccache"

It might be redundant to set CCACHE_DIR here, since it is already defined in /etc/env.d/03distcc_ccache, mentioned here. But to make absolutely sure, configure it like that.

Testing distcc with ccache manually

Remote

First enable verbose logging by setting --log-level to debug in /etc/conf.d/distccd:

DATEI /etc/conf.d/distccd
[...]
DISTCCD_OPTS="${DISTCCD_OPTS} --log-level debug"
[...]

After that, restart the daemon to adapt the changes:

root #rc-service distccd restart

Also check, if there are directories in /var/cache/ccache - including the directory ccache itself - which are not owned by the user distcc and correct their owner permissions:

root #chown -R distcc:portage /var/cache/ccache
Client

Make sure, that the following environment variables are present in the current shell:

root #export PATH="/usr/lib/ccache/bin:${PATH}"
root #export CCACHE_DIR="/var/cache/ccache"
root #export DISTCC_DIR="/var/tmp/portage/.distcc"
root #export DISTCC_SAVE_TEMPS="1"
root #export DISTCC_VERBOSE="1"

After that, navigate to a temporary directory within /tmp/ and compile the example mentioned below:

root #cd $(mktemp --directory)
root #distcc gcc -c main.c -o main.o

This will provide a verbose output, while also keeping temporary files receiving from the remote site in /tmp/ by default:

CODE
[...]
distcc[29466] (dcc_cleanup_tempfiles_inner) skip cleanup of /tmp/distcc_9c42f0a6.i
distcc[29466] (dcc_cleanup_tempfiles_inner) skip cleanup of /tmp/distcc_server_stderr_9cc0f0a6.txt
[...]

Any occuring error from the remote site are saved in /tmp/distcc_server_stderr_*.txt.

If the compilation was successful, the following line will be shown.

CODE
[...]
distcc[29466] compile main.c on 192.168.0.4 completed ok
[...]

On the remote site, it will look like this:

CODE
[...]
distccd[13296] (dcc_check_compiler_masq) /usr/lib/ccache/bin/gcc is a safe symlink to /usr/bin/ccache
[...]
distccd[13296] (dcc_job_summary) client: 192.168.0.4:33880 COMPILE_OK exit:0 sig:0 core:0 ret:0 time:20ms gcc main.c

The important part here, is, that any symlink of /usr/lib/ccache/bin/ is a save symlink to /usr/bin/ccache.

Also, on the remote site, there should be the cached file 2beaa22dc2a2873d6869d69411840c-17229.o in /var/cache/ccache/c/0/, assuming, the example with its filename was copied from this wiki article. Generally, one can monitor the ccache size using watch "ccache --show-stats", while compiling.

Testing distcc with ccache using emerge

Check, if necessary environment variables are present for the current shell, see here and that /etc/portage/make.conf was configured properly, see here.

To produce some cached files on the remote site, one can compile small packages like htop and bzip2 on the client:

root #emerge --ask htop bzip2

Future usage

Make sure, that the following environment variables are always set in the desired shell:

CODE
PATH="/usr/lib/ccache/bin:${PATH}"
CCACHE_DIR="/var/cache/ccache"
DISTCC_DIR="/var/tmp/portage/.distcc"

Verwendung für Bootstrapping

Wenn distcc für das 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 Bootstrapping. Danach ist Portage für die Verwendung von distcc zu konfigurieren:

DATEI /etc/portage/make.confKonfiguration von Portage zur Verwendung von distcc
FEATURES="distcc"
MAKEOPTS="-jN"

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

root #export PATH="/usr/lib/ccache/bin:/usr/lib/distcc/bin:${PATH}"

Schritt 2: Installation von distcc

Für die Installation von sys-devel/distcc ist folgendes Kommando zu verwenden:

root #USE='-*' emerge --nodeps sys-devel/distcc

Schritt 3: Konfiguration von distcc

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

root #/usr/bin/distcc-config --set-hosts "localhost host1 host2 host3 ..."

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

Notiz
Während des Bootstrapping und der Ausführung von emerge @system scheint distcc nicht verwendet zu werden. Dieses Verhalten ist gewollt, da einige grundlegende Pakete nicht gut mit distcc zusammenarbeiten, so das diese absichtlich deaktiviert sind.

Extras

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

Tools zur Überwachung

Distcc enthält zwei Überwachungs-Tools. Bei distccmon-text 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.

user $distccmon-text 10

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

user $distccmon-gui

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

root #DISTCC_DIR="/var/tmp/portage/.distcc/" distccmon-text 10
root #DISTCC_DIR="/var/tmp/portage/.distcc/" distccmon-gui
Wichtig
Wenn das distcc Verzeichnis an einem anderen Ort liegt, sind die Verzeichnisangaben entsprechend anzupassen.

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

root #echo 'DISTCC_DIR="/var/tmp/portage/.distcc/"' >> /etc/env.d/02distcc
Wichtig
Be aware that DISTCC_DIR must be set somewhere else than /etc/env.d/02distcc, as it gets overwritten everytime, when using distcc-config!. distcc-config --set-env DISTCC_DIR <some_path> does not work.

Nun ist die Umgebung neu einzulesen:

root #env-update
root #source /etc/profile

Das Starten des Programmes geschieht mit der folgenden Anweisung:

root #distccmon-gui

SSH-verschlüsselte Kommunikation

Das distcc 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 FEATURES="userpriv" nicht gesetzt ist. Das Heimat-Verzeichnis des Portage User ist /var/tmp/portage/, was zur Folge hat, dass die Schlüssel in /var/tmp/portage/.ssh/ gespeichert werden.

Warnung
Home folder of the Portage user changed in recent versions to /var/lib/portage/home, but this folder cannot be used for distcc via SSH because it is out of the accessible path during compilation. You should then update it:
root #usermod -d /var/tmp/portage portage
root #ssh-keygen -b 2048 -t rsa -f /var/tmp/portage/.ssh/id_rsa

Als Nächstes muss in der SSH Konfigurations-Datei für jeden Host ein Abschnitt angelegt werden:

DATEI /var/tmp/portage/.ssh/configHostkonfiguration
Host test1
    HostName 123.456.789.1
    Port 1234
    User UserName
 
Host test2
    HostName 123.456.789.2
    Port 1234
    User UserName

Die öffentlichen Schlüssel müssen auf die teilnehmenden Hosts übertragen werden:

root #ssh-copy-id -i /var/tmp/portage/.ssh/id_rsa.pub UserName@CompilationNode

Weiterhin ist sicherzustellen, das jeder Host in known_hosts bekannt gegeben ist.

root #ssh-keyscan -t rsa <compilation-node-1> <compilation-node-2> [...] > /var/tmp/portage/.ssh/known_hosts

Die Zugriffsrechte müssen wie folgt gesetzt werden:

root #chown -R portage:portage /var/tmp/portage/.ssh/

Jetzt ist der SSH-Teil der Konfiguration erledigt, es folgt noch der distcc Teil. Für das Beispiel mit den Hosts test1 und test2 ist folgender Aufruf notwendig:

root #/usr/bin/distcc-config --set-hosts "@test1 @test2"

Wichtig ist der Aufruf mit dem @ (at-Zeichen), welches anzeigt, dass es sich um eine SSH gestützte Kommunikation handelt.

Zuletzt muss die make.conf angepasst werden, damit ssh das passende Programm benutzt.

DATEI /etc/portage/make.conf
DISTCC_SSH="ssh"

Es ist nicht notwendig, das distccd Init-Skript auf den teilnehmenden Hosts aufzurufen, wenn distcc via SSH kommuniziert.

Reverse SSH

As an alternative to distcc's built-in SSH solution, a compiling server can connect to the distcc client via SSH, redirecting the client's distcc TCP port to the compiling server. There is no need for password-less SSH keys on the client.

user $ssh -R3632:127.0.0.1:3632 root@distcc-client

Note that distcc uses localhost as a literal keyword for special purpose so that 127.0.0.1 has to be used instead. For multiple compiling servers each needs its own port redirection on the client (e.g. 127.0.0.1:4000, 127.0.0.1:4001 etc). Assert that IP addresses and ports are listed in /etc/distcc/hosts on the client.

Testen

Um distcc zu testen, kann ein einfaches "Hallo distcc" Programm geschrieben werden und die Übersetzung im ausführlichen Modus gestartet werden um die fehlerfreie Kommunikation zu überprüfen.

DATEI main.c
#include <stdio.h>
 
int main() {
    printf("Hallo distcc!\n");
    return 0;
}

Nun ist der ausführliche Modus einzuschalten, der Quelltext zu übersetzen und schlussendlich ein ausführbares Programm mit dem Linker zu erzeugen.

user $export DISTCC_VERBOSE=1
user $distcc gcc -c main.c -o main.o # oder 'pump distcc <...>'
user $gcc main.o -o main
Notiz
Um den Pump Modus zu verwenden, ist distcc durch pump distcc zu ersetzen.

Es sollten eine Menge Ausgaben von distcc über das Auffinden der Konfiguration, Auswahl der teilnehmenden Hosts, das Starten der Übersetzung auf diesen und schlussendlich die Übersetzung von main.c zu finden sein. Wenn die gewünschten Hosts nicht in der Ausgabe zu finden sind, muss die Konfiguration überprüft werden.

Ein letzter Test stellt sicher, dass das übersetzte Programm fehlerfrei funktioniert.

user $./main
Hallo distcc!

Fehlersuche

Sollte ein Problem bei der Benutzung von distcc auftreten, sind in diesem Abschnitt Lösungsansätze zur Fehlerbehebung zu finden.

ERROR: failed to open /var/log/distccd.log

Seit dem 22.Januar 2015 kann Portage nicht das passende distccd.log File in /var/log/ erzeugen. Dieses Verhalten tritt nur bei Version distcc 3.1-r8 auf. Dieser Fehler wird gerade behoben (siehe bug #477630): Es ist möglich diesen Fehler zu umgehen, wenn das Log-File manuell erzeugt wird, mit den passenden Zugriffrechten versehen wird und der distccd Daemon neu gestartet wird.

root #mkdir -p /var/log/distcc
root #touch /var/log/distcc/distccd.log
root #chown distcc:daemon /var/log/distcc/distccd.log

In der Datei /etc/conf.d/distccd ist nun der neue Pfad der Log-Datei /var/log einzutragen.

DATEI /etc/conf.d/distccdAnpassung des Pfades
DISTCCD_OPTS="--port 3632 --log-level notice --log-file /var/log/distcc/distccd.log -N 15

Neustart des Distccd Service:

root #/etc/init.d/distccd restart

Einige Pakete benutzen nicht distcc

Bei der Übersetzung von verschiedenen Paketen kann es vorkommen, das diese nicht verteilt übersetzt werden, sondern nur lokal. Dieses Verhalten tritt auf, wenn das Makefile keine parallelen Operationen unterstützt oder der Betreuer des Ebuild parallele Operationen aufgrund bekannter Fehler deaktiviert hat.

Manchmal tritt unerwartet ein Fehler bei einem Paket auf, so das es nicht verteilt übersetzt werden kann. Sollte dies eintreten, kann hier ein Fehlerreport erstellt werden.

Rust package is known to cause excessive IO utilization as --local-load is ignored and --jobs is usually too high for local build resources. A package.env needs to be provisioned with non-distcc MAKEOPTS values to workaround this behaviour.

Unterschiedliche GCC-Versionen

Wenn auf den teilnehmenden Hosts unterschiedliche gcc-Versionen aktiv sind, kann es zu sehr seltsamen Fehlern bei der Übersetzung kommen. Um dies zu vermeiden, sind stets nur gleiche gcc-Versionen zur Übersetzung einzusetzen.

Die aktuellen Portage Aktualisierungen benutzen ${CHOST}-gcc (minus gcc) anstelle gcc. Werden i686 Rechner im Verbund mit anderen Rechner benutzt (i386, i586) treten sehr wahrscheinlich Probleme bei der Übersetzung auf. Abhilfe kann folgende Anweisung schaffen:

root #export CC='gcc' CXX='c++'

Es ist ebenfalls möglich die CC und CXX Variablen in /etc/portage/make.conf auf die oben genannten Werte zu setzen.

Wichtig
Mit diesen Modifikationen wird das Verhalten von Portage beeiflusst, was in der Zukunft zu komischen Resultaten führen kann. Diese Modifikation sollte nur benutzt werden, wenn verschiedene CHOST unvermeidbar sind.
Notiz
Den gcc Compiler nur in einem Slot als passende Version installiert zu haben, reicht nicht aus. Portage benutzt distcc als Ersatz für den Compiler auf den die Variable CHOST verweist (z.B x86_64-pc-linux-gnu) und distcc ruft genau diesen Namen auf. Die passende Version von gcc soll als voreingestellter System-Compiler auf allen teilnehmenden Hosts eingestellt sein.

-march=native

Seit der Version 4.3.0 unterstützt der gcc Compiler die -march=native Option, mit der das übersetzte Programm auf die gerade benutzte CPU optimiert wird. Dies schafft ein Problem, da hier Code erzeugt wird, der für unterschiedliche Prozessoren optimiert ist. Als Beispiel sei das Mixen von AMD-Athlon und Intel-Pentium optimierten Code genannt, wenn auf den beteiligten Rechnern jeweils die-march=native Option gesetzt ist.

Daher sollte die folgende Warnung beachtet werden:

Warnung
Wenn zur Übersetzung distcc benutzt wird, dürfen die Optionen -march=native bzw. -mtune=native in den Variablen CFLAGS und CXXFLAGS nicht benutzt werden.

Für Hintergrundinformationen sei auf den Abschnitt CFLAGS and CXXFLAGS section und den Blogeintrag Inlining -march=native for distcc verwiesen.

Network is unreachable

Notiz
When using SSH connection, you may also face the error: ssh: Could not resolve hostname: Temporary failure in name resolution.

Due to network restrictions introduced by the feature network-sandbox, you may run into this issue. Since distcc contradicts with this security feature, you have to disable it:

DATEI /etc/portage/make.confDisabling network-sandbox feature
FEATURES="${FEATURES} -network-sandbox"

Ausführlichere Ausgaben der emerge Logs

Durch das Einschalten des verbose-Modus werden mehr Logging Ausgaben angezeigt. Die wird durch Hinzufügen der Option DISTCC_VERBOSE in /etc/portage/bashrc erreicht:

DATEI /etc/portage/bashrcEinschalten des verbose-Modus
export DISTCC_VERBOSE=1

Die Ausgaben können in /var/tmp/portage/$CATEGORY/$PF/temp/build.log gefunden werden.

Der erste Aufruf von distcc der in build.log sichtbar ist, ist nicht notwendigerweise der erste distcc Aufruf während des Build-Prozesses. Zum Beispiel kann ein Build-Server eine einminütige Auszeit bekommen (BackOff), wenn während der Konfiguration (configure ...) für einige Tests ein Compiler benutzt wird (distcc sperrt einen Remote Host für eine Minute, wenn dieser nicht erreichbar ist, unabhängig davon ob die Übersetzung auf der lokalen Maschine fehlschlug oder nicht).

Solche Fehler können durch die Analyse von /var/tmp/portage/$CATEGORY/$PF/work/ gefunden werden. Alternativ kann make händisch im work-Verzeichnis aufgerufen werden.

Eine weitere Option ist DISTCC_SAVE_TEMPS. Wenn diese gesetzt ist, wird die Ausgabe auch der Remote-Rechner im /var/tmp/portage/$CATEGORY/$PF/temp/ Verzeichnis gespeichert.

DATEI /etc/portage/bashrcSpeichern der temporären Ausgaben
export DISTCC_SAVE_TEMPS=1

Failed to create directory /dev/null/.cache/ccache/tmp: Not a directory

This error can be discovered from the standard error output file in the server if you set DISTCC_SAVE_TEMPS. It only occurs when using distccd with ccache.

Likely, it is because CCACHE_DIR is not properly set, or not passed correctly to distccd. ccache will then default to $HOME/.cache/ccache as its cache folder. However, ccache is run by distccd under user distcc, which is a non-login account. See systemd section and With ccache section for setting CCACHE_DIR.

Portage build failing with errors that are apparently not connected with distcc at all

When builds are failing with errors that do not seem to be connected to distcc, but the build works with FEATURES="-distcc", it has been reported that builds sometimes fail because of DISTCC_VERBOSE=1. Try the build with DISTCC_VERBOSE=0.

Siehe auch

Weiterführendes Material


This page is based on a document formerly found on our main website gentoo.org.
The following people contributed to the original document: Lisa Seelye, Mike Gilbert (floppym) , Erwin, Sven Vermeulen (SwifT) , Lars Weiler, Tiemo Kieft, and
They are listed here because wiki history does not allow for any external attribution. If you edit the wiki article, please do not add yourself here; your contributions are recorded on each article's associated history page.