Distcc

From Gentoo Wiki
Jump to:navigation Jump to:search
This page is a translated version of the page Distcc and the translation is 68% complete.
Outdated translations are marked like this.
Some of the information in this article may have drifted out of sync with current practices. Please help out by checking over the content (how to get started).

Distcc — это программа, предназначенная для распределения по сети задач компиляции в рамках набора хостов.

Distcc состоит из серверной части — distccd, и клиентской — distcc. Distcc может прозрачно работать с ccache, Portage и Automake (после небольшой настройки).

Если планируется использовать distcc для начальной сборки (bootstrap) установки Gentoo, обратите внимание на раздел использование distcc для bootstrap.

If using hosts to run distcc that are of a different architecture, or run a different toolchain, see Distcc/Cross-Compiling.

Заметка
Distcc can introduce compile-time issues, like bug bug #691544, so the first troubleshooting step when encountering such issues should be to disable distcc to see if it solves it.
Совет
Using a second, faster, machine to build binary packages and setting up a binary package host can advantageously replace some use cases of distcc. It may be easier to set up and will cover all compilers and build systems.

Установка

Перед настройкой distcc сперва нужно установить пакет sys-devel/distcc на все хосты.

Требования для всех хостов

Для работы с distcc все компьютеры в сети должны иметь GCC одной версии. К примеру, можно использовать на разных машинах 3.3.x (где x — разные), а смешивание 3.3.x с 3.2.x может привести к ошибкам при компиляции или выполнении.

Убедитесь, что все системы используют одну и ту же версию binutils (eselect binutils list) в противном случае многие пакеты могут выдавать различные ошибки линковки, такими как text relocation

USE-флаги

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)

Distcc поставляется с графическим монитором для отслеживания заданий, отправляемых компьютером на компиляцию. Данный монитор включается, когда установлен USE-флаг gtk.

Emerge

После настройки USE-флагов установите пакет sys-devel/distcc:

root #emerge --ask sys-devel/distcc
Важно
Убедитесь, что sys-devel/distcc установлен на все участвующие в распределённой компиляции компьютеры.

Конфигурация

Сервис

Выполните следующие инструкции для того, чтобы distccd запускался автоматически.

OpenRC

Отредактируйте /etc/conf.d/distccd и убедитесь, что с помощью директивы --allow разрешены только доверенные клиенты. Для усиления безопасности можно также добавить директиву --listen, сообщив с её помощью демону distccd, на каком IP ожидать соединений (для систем с несколькими адресами). Подробнее о безопасности в distcc можно почитать в Distcc security notes.


Предупреждение
Любой подключившийся к порту сервера distcc, может выполнять произвольные команды на этой машине от имени пользователя distccd

Следующий пример разрешает distcc клиентам, работающим на 192.168.0.4 и 192.168.0.5, подключатся к локально запущенному серверу distccd:

ФАЙЛ /etc/conf.d/distccdРазрешение некоторым клиентам подключатся к 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
Важно
Использовать --allow и --listen — важно. Обратитесь к man-странице distccd или указанному выше документу по безопасности для получения дополнительной информации.

Теперь запустите демон distccd на всех участвующих компьютерах:

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

systemd

Отредактируйте файл /etc/systemd/system/distccd.service.d/00gentoo.conf для добавления доверенных клиентов в CIDR формате. Пример ниже добавляет все IP-адреса из диапазона 192.168.1.xxx:

ФАЙЛ /etc/systemd/system/distccd.service.d/00gentoo.confНастройка ALLOWED_SERVERS
Environment="ALLOWED_SERVERS=192.168.1.0/24"

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

ФАЙЛ /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"
Заметка
Имя ALLOWED_SERVERS сильно запутывает, так как на самом деле оно относится к клиентам, которым разрешено подключаться к локальному серверу distcc. Тем не менее именно эта переменная используется в сервисе distccd как значение для --allow option. Смотрите файл /usr/lib/systemd/system/distccd.service для более подробной информации.
Важно
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:

ФАЙЛ /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"
Предупреждение
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, 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:

КОД 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, it is possible to write a shell script wrapper for /usr/bin/distccd.

Перезагрузите unit-файлы после изменений:

root #systemctl daemon-reload

Включите автозагрузку distccd и запустите сервис:

root #systemctl enable distccd
root #systemctl start distccd

Определение участвующих хостов

Для задания списка хостов используйте команду distcc-config.

В следующем примере показан список определения хостов. Вариантов из первой и второй строки в большинстве случаев достаточно. В последнем используется (число) /limit синтаксис, чтобы сообщить distcc о максимально возможном количестве задач, которые можно запустить на этом узле. Подробнее о синтаксисе, использованном в третьей и четвертой строках, можно прочитать в man-странице distcc.

КОД Примеры задания хостов
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

Есть также несколько других методов для настройки хостов. За подробностями обратитесь к man-странице man distcc.

Если локальная машина должна участвовать в компиляции, добавьте localhost в список хостов. Наоборот, если локальная машина не должна участвовать в компиляции, не включайте её в список хостов. Использование localhost на медленной машине может, как ни странно, замедлить процесс. Всегда проверяйте влияние настроек для наилучшей производительности.

Настройте distcc для компиляции на хостах из первой строчки примера:

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

Также, distcc поддерживает режим "pump" через вызов команды pump. Такой режим может значительно сократить время сборки при компиляции нескольких файлов параллельно. Он кэширует нужные заголовочные файлы перед компиляцией на сервере, и, как следствие, не требуется повторная загрузка и обработка этих файлов.

Чтобы настроить хост для работы в режиме pump, добавьте суффикс ,cpp,lzo в определение хостов. Для режим pump необходимы оба флага cpp и lzo (независимо от того, какие файлы будут компилироваться C или C++):

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:

ФАЙЛ /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:

ФАЙЛ /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.

Использование

С Portage

Весьма легко настроить Portage для работы с distcc. Речь идет о включении функции distcc, а также о настройки подходящего количества одновременно выполняемых задач (так как distcc увеличивает доступное количество ресурсов для компиляции).

Установите переменные MAKEOPTS и FEATURES как показано ниже.

Общепринятая стратегия:

  • установите N в удвоенное значение от всех (локальных + удалённых) ядер CPU + 1,
  • установите M число равное количеству локальных ядер CPU.

Использование -lM в переменной MAKEOPTS предотвращает запуск чрезмерно большого количества заданий в случаях, когда некоторые distcc хосты кластера недоступны (увеличивая количество одновременных заданий для других систем) или когда ebuild настроен так, что устанавливаемый пакет запрещает удаленную компиляцию (например, gcc). Это достигается за счет отказа начинать новые задачи компиляции, если нагрузка на систему становится равной M или выше.

ФАЙЛ /etc/portage/make.confУстановка переменных MAKEOPTS и FEATURES
# Замените N и M на подходящие значения, как писалось ранее в статье
MAKEOPTS="-jN -lM"
FEATURES="distcc"

Например, если distccd запущен на двух четырехъядерных хостах, а локальный компьютер оснащен двухъядерным процессором, то переменная MAKEOPTS может выглядеть так:

ФАЙЛ /etc/portage/make.confПример MAKEOPTS для 1 двухъядерного (локального) и 2 четырёхъядерных (вспомогательных) компьютеров
# 2 удалённых хоста с 4 ядрами каждый = 8 удалённых ядер
# 1 локальный хост с двумя ядрами = 2 локальных ядра
# общее количество ядер — 10, N = 2*10+1 и M=2
MAKEOPTS="-j21 -l2"

CFLAGS и CXXFLAGS

Не используйте -march=native в переменных CFLAGS и CXXFLAGS файла make.conf. Если march установлен в native, то distccd не сможет распределить работу по другим машинам. Вместо этого он должен содержать конкретную платформу и несколько дополнительных флагов, необходимых для конкретного процессора, например:

ФАЙЛ /etc/portage/make.confВключенные *FLAGS
# Минимальный список флагов можно сгенерировать с помощью команды:
#   $ 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" # Не используйте -march=native!
CFLAGS="${COMMON_FLAGS}"
CXXFLAGS="${COMMON_FLAGS}"

Подробности можно найти на странице Inlining -march=native for distcc.

As an alternative, install app-misc/resolve-march-native to determine what -march=native would resolve into.

С automake

Иногда это проще настройки Portage. Всё, что нужно сделать, это обновить переменную PATH, добавив /usr/lib/distcc/bin/ перед каталогом, содержащим gcc (/usr/bin/). С одной оговоркой. Если используется ccache, то нужно поместить путь к distcc после пути к ccache:

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

Поместите это в пользовательский ~/.bashrc или его эквивалент, чтобы переменная PATH устанавливалась при каждом входе пользователя в систему, либо задайте ее глобально через файл /etc/env.d/.

Вместо вызов одного make, добавьте -jN (где N — целое число). Значение N зависит от сети и используемых для компиляции компьютеров. Эвристический подход к определению правильного значения N упоминался ранее в этой статье.

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:

КОД Flow diagram
[client]                                                      [remote]
'''ccache''' <miss?> → compile it and save cache files,
<hit?>           also distribute other source code → '''distcc''' → '''ccache''' <miss?> → compile it, save cache files, return cache file to client
  ↓                                                           <hit?>
use the local cache file                                        ↓
                                                 return local cache file to client
Предупреждение
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:

ФАЙЛ /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:

Предупреждение
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.
ФАЙЛ /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

Предупреждение
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/.

Важно
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:

ФАЙЛ /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:

ФАЙЛ /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:

КОД
[...]
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:

КОД
[...]
distcc[29466] compile main.c on 192.168.0.4 completed ok
[...]

On the remote site, it will look like this:

КОД
[...]
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:

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

Для bootstrap

TODO: Todo:

  • Check this section for outdated information. Notably "USE='-*'" and "--nodeps" may no longer be advised. See Discussion page for more informaiton.


Для использования distcc для bootstrap (то есть скомпилировать рабочие toolchain перед установкой оставшейся части системы) требуются некоторые дополнительные шаги.

Шаг 1: настройка Portage

Загрузите новую машину с Gentoo Linux LiveCD и следуйте инструкциям по установке, учитывая инструкции по начальной сборке (bootstrapping) в FAQ по Gentoo. Затем настройте Portage для использования distcc:

ФАЙЛ /etc/portage/make.confНастройка Portage для использования distcc
FEATURES="distcc"
MAKEOPTS="-jN"

Также, обновите переменную PATH в установочной сессии:

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

Шаг 2: установка distcc

Установите sys-devel/distcc:

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

Шаг 3: настройка distcc

Запустите distcc-config для настройки distcc; замените в примере host# на IP-адреса или имена хостов, принимающих участие в компиляции.

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

Distcc теперь настроен для bootstrap! Продолжайте следовать соответствующим инструкциям по установке и не забудьте запустить emerge distcc после запуска emerge @system. Это нужно, чтобы убедиться, что все необходимые зависимости установлены.

Заметка
В процессе начальной установки (bootstraping’а) и выполнения emerge @system distcc может не использоваться. Это ожидаемое поведение: некоторые файлы ebuild плохо работают с distcc, поэтому distcc отключён в них преднамеренно.

Дополнительно

У программы distcc есть множество дополнительных возможностей и приложений, помогающих работать в окружении distcc.

Утилиты для мониторинга

Distcc поставляется с двумя инструментами мониторинга. Текстовая утилита для мониторинга собирается всегда и называется distccmon-text. Интерфейс поначалу может смутить, но на самом деле использовать его очень просто. Если запустить программу без параметров, она просто запустится однократно. Однако, если передать ей в качестве параметра число N, то информация будет обновляться каждые N секунд.

user $distccmon-text 10

Другая утилита для мониторинга включается с помощью USE-флага gtk. Она основана на GTK, запускается в окружении X и достаточно приятна. В Gentoo, чтобы избежать путаницы, GUI-монитор переименован в distccmon-gui (оригинальное название — distccmon-gnome).

user $distccmon-gui

Чтобы наблюдать за тем, как Portage использует distcc, запустите:

root #DISTCC_DIR="/var/tmp/portage/.distcc/" distccmon-text 10
root #DISTCC_DIR="/var/tmp/portage/.distcc/" distccmon-gui
Важно
Если каталог distcc находится где-нибудь в другом месте, измените переменную DISTCC_DIR соответствующим образом.

Трюк: задайте DISTCC_DIR в переменном окружении:

root #echo 'DISTCC_DIR="/var/tmp/portage/.distcc/"' >> /etc/env.d/03distcc_custom
Важно
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.

Теперь, обновите окружение:

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

И наконец, запустите графическую оболочку приложения:

root #distccmon-gui

SSH для взаимодействия

В настройке distcc через SSH есть подводные камни. Во-первых, сгенерируйте ключевую пару SSH без пароля. Учтите, что Portage компилирует программы из-под пользователя portage (по умолчанию как root, если не включена FEATURES="userpriv"). Домашний каталог пользователя portage — /var/tmp/portage/, поэтому ключи должны храниться в /var/tmp/portage/.ssh/.

Предупреждение
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. It should be updated:
root #usermod -d /var/tmp/portage portage
root #ssh-keygen -b 2048 -t rsa -f /var/tmp/portage/.ssh/id_rsa

Во-вторых, сделайте для каждого хоста раздел в файле конфигурации SSH:

ФАЙЛ /var/tmp/portage/.ssh/configРазделы для хостов
Host test1
    HostName 123.456.789.1
    Port 1234
    User UserName
 
Host test2
    HostName 123.456.789.2
    Port 1234
    User UserName

Отправьте публичный ключ на все ноды, участвующие в компиляции:

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

Убедитесь также, что каждый из хостов есть в файле known_hosts:

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

Измените владельца так:

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

Чтобы настроить хосты test1 и test2, выполните:

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

Обратите внимание на знак @, с его помощью в distcc указываются ssh-хосты.

Наконец, сообщите distcc какой бинарный файл SSH нужно использовать:

ФАЙЛ /etc/portage/make.conf
DISTCC_SSH="ssh"

Если взаимосвязь distcc осуществляется через SSH, нет нужды запускать distccd init-скрипт на хостах.

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.

Тестирование

Чтобы протестировать работу distcc напишите простую Hello distcc программу и запустите distcc в подробном режиме (verbose), чтобы убедится, что взаимосвязь между хостами distcc работает хорошо.

ФАЙЛ main.c
#include <stdio.h>
 
int main() {
    printf("Hello distcc!\n");
    return 0;
}

Далее, включите подробный режим, скомпилируйте программу с помощью distcc и слинкуйте сгенерированный объектный файл в исполняемый:

user $export DISTCC_VERBOSE=1
user $distcc gcc -c main.c -o main.o # or 'pump distcc <...>'
user $gcc main.o -o main
Заметка
Замените команду distcc на команду pump distcc, чтобы использовать режим pump.

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

Наконец, проверьте, что скомпилированная программа работает хорошо. Чтобы протестировать все хосты, перечислите все хотсы компиляции в файле hosts.

user $./main
Hello distcc!

Устранение проблем

Следующий раздел может помочь в решении проблем, если такие встречаются при использовании distcc.

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

По состоянию на 22 января 2015 года файл distccd.log в /var/log/ не правильно создается. По-видимому это затрагивает только версию 3.1-r8 distcc. Эта ошибка еще решается (смотрите bug #477630). Ее можно решить самостоятельно, создав файл журнала и назначив ему правильного владельца. После этого перезапустите демон distccd:

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

Затем, в конфигурационном файле distccd, который располагается в /etc/conf.d/distccd, измените /var/log на каталог distcc, который был создан ранее:

ФАЙЛ /etc/conf.d/distccdИзменение пути для лога
DISTCCD_OPTS="--port 3632 --log-level notice --log-file /var/log/distcc/distccd.log -N 15

Наконец, перезапустите сервис distccd:

root #/etc/init.d/distccd restart

Некоторые пакеты не используют distcc

Можно заметить, что сборка некоторых пакетов не распределяется по хостам (и не происходит параллельно, т. е. в несколько процессов). Такое может происходить, когда Makefile пакета не поддерживает параллельные операции, или мейнтейнер ebuild’а явно отключил их, чтобы избежать известных проблем.

Иногда distcc может вызывать сбой при компиляции пакета. Если такое происходит, пожалуйста, сообщите об этом.

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

ФАЙЛ /etc/portage/env/nodistcc.conf
MAKEOPTS="-jN"
FEATURES="-distcc"
ФАЙЛ /etc/portage/package.env/nodistcc
dev-lang/rust           nodistcc.conf
mail-client/thunderbird nodistcc.conf
sys-libs/libcxx         nodistcc.conf
www-client/firefox      nodistcc.conf

Смешанные версии GCC

Если на взаимодействующих хостах разные версии GCC, то велика вероятность возникновения очень странных проблем. Решение — установить на все хосты одну версию GCC.

После недавных обновлений Portage стал использовать ${CHOST}-gcc (минус gcc) вместо gcc. Это значит, что совместное использование i686-машин с машинами других типов (i386, i586) может вызвать проблемы со сборкой. Обходным решеним может быть запуск:

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

Можно задать переменные CC и CXX в /etc/portage/make.conf в списком значений из команды выше.

Важно
Так вы явно переопределите некоторую часть поведения Portage, что может привести к странным результатам в будущем. Делайте так, только если использование разных CHOST’ов неизбежно.
Заметка
Просто установленной в слот подходящей версии gcc недостаточно. Portage использует distcc как замену для компилятора, который обозначен в переменной CHOST (например x86_64-pc-linux-gnu), а distccd вызывает его точно с таким же именем. Правильная версия gcc должна быть установлена в качестве системного компилятора на всех хостах, используемых для компиляции.

-march=native

GCC, начиная с версии 4.3.0, поддерживает параметр -march=native, который включает автоматическое определение CPU, на котором запущен GCC, и оптимизаций, которые стоит включить для него. Это создает проблемы при использовании distcc, так как допускает смешивание оптимизированного для разных процессоров кода. К примеру, запуск distcc с -march=native на системе с процессором AMD Athlon и на другой системе с процессором Intel Pentium приведет к смешиванию кода, скомпилированного на обоих процессорах.

Обратите внимание на следующее предупреждение:

Предупреждение
Не используйте -march=native и -mtune=native в переменных CFLAGS и CXXFLAGS файла make.conf при компиляции с помощью distcc.

Посмотрите раздел CFLAGS и CXXFLAGS и использование -march=native в distcc для подробной информации.

Network is unreachable

Заметка
When using SSH connection, there can be an error: ssh: Could not resolve hostname: Temporary failure in name resolution.

Due to network restrictions introduced by the feature network-sandbox, this issue may be encountered. Since distcc contradicts with this security feature, it must be disabled:

ФАЙЛ /etc/portage/make.confDisabling network-sandbox feature
FEATURES="${FEATURES} -network-sandbox"

Получение более подробного вывода в логах emerge

Можно получить более подробное журналирование, если включить подробный режим. Этого можно добиться, если добавить DISTCC_VERBOSE в /etc/portage/bashrc:

ФАЙЛ /etc/portage/bashrcВключение подробного журналирования
export DISTCC_VERBOSE=1

Подробный журнал потом можно найти в /var/tmp/portage/$CATEGORY/$PF/temp/build.log.

Keep in mind that the first distcc invocation visible in build.log isn’t necessary the first distcc 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 (distcc sets a backoff period when compilation on a remote server failed, it doesn’t matter whether it failed on local machine or not).

Поищите в каталоге /var/tmp/portage/$CATEGORY/$PF/work/, что изучить такую ситуацию. Найдите другие журналы или вызовите make непосредственно из рабочего каталога.

DISTCC_SAVE_TEMPS — это еще одна интересная переменная. Когда она установлена, сохраняется стандартный поток вывода/ошибок с удаленного компилятора, который использует Portage, в файлы расположенные в каталоге /var/tmp/portage/$CATEGORY/$PF/temp/.

ФАЙЛ /etc/portage/bashrcСохранение временного вывода
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 DISTCC_SAVE_TEMPS is set. 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.

Смотрите также

  • Distcc/Cross-Compiling — покажет, как настроить distcc для кросс-компиляции между различными архитектурами процессоров.

Внешние ресурсы


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.