/[gentoo]/xml/htdocs/doc/en/distcc.xml
Gentoo

Diff of /xml/htdocs/doc/en/distcc.xml

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

Revision 1.25 Revision 1.39
1<?xml version='1.0' encoding="UTF-8"?> 1<?xml version='1.0' encoding="UTF-8"?>
2<!DOCTYPE guide SYSTEM "/dtd/guide.dtd"> 2<!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
3<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/distcc.xml,v 1.25 2005/01/16 16:23:30 swift Exp $ --> 3<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/distcc.xml,v 1.39 2006/12/24 17:54:01 nightmorph Exp $ -->
4 4
5<guide link="/doc/en/distcc.xml"> 5<guide link="/doc/en/distcc.xml">
6 6
7<title>Gentoo Distcc Documentation</title> 7<title>Gentoo Distcc Documentation</title>
8 8
9<author title="Author"> 9<author title="Author">
10 <mail link="lisa@gentoo.org">Lisa Seelye</mail> 10 <mail link="lisa@gentoo.org">Lisa Seelye</mail>
11</author> 11</author>
12
13<author title="Editor"> 12<author title="Editor">
14 <mail link="vapier@gentoo.org">Mike Frysinger</mail> 13 <mail link="vapier@gentoo.org">Mike Frysinger</mail>
15</author> 14</author>
16
17<author title="Editor"> 15<author title="Editor">
18 <mail link="erwin@gentoo.org">Erwin</mail> 16 <mail link="erwin@gentoo.org">Erwin</mail>
19</author> 17</author>
20
21<author title="Editor"> 18<author title="Editor">
22 <mail link="swift@gentoo.org">Sven Vermeulen</mail> 19 <mail link="swift@gentoo.org">Sven Vermeulen</mail>
23</author> 20</author>
24
25<author title="Editor"> 21<author title="Editor">
26 <mail link="pylon@gentoo.org">Lars Weiler</mail> 22 <mail link="pylon@gentoo.org">Lars Weiler</mail>
27</author> 23</author>
28
29<author title="Reviewer"> 24<author title="Reviewer">
30 <mail link="blubber@gentoo.org">Tiemo Kieft</mail> 25 <mail link="blubber@gentoo.org">Tiemo Kieft</mail>
31</author> 26</author>
32 27
33<abstract> 28<abstract>
34This document serves as a HOWTO for using distcc with Gentoo. 29This document serves as a HOWTO for using distcc with Gentoo.
35</abstract> 30</abstract>
36 31
37<!-- The content of this document is licensed under the CC-BY-SA license --> 32<!-- The content of this document is licensed under the CC-BY-SA license -->
38<!-- See http://creativecommons.org/licenses/by-sa/1.0 --> 33<!-- See http://creativecommons.org/licenses/by-sa/2.5 -->
39<license/> 34<license/>
40 35
41<version>1.10</version> 36<version>1.18</version>
42<date>2005-01-16</date> 37<date>2006-12-24</date>
43 38
44<chapter> 39<chapter>
45<title>Introduction</title> 40<title>Introduction</title>
46<section> 41<section>
47<title>What is distcc?</title> 42<title>What is distcc?</title>
48<body> 43<body>
49 44
50<p> 45<p>
51Distcc is a program designed to distribute compiling tasks across a network to 46Distcc is a program designed to distribute compiling tasks across a network to
52participating hosts. It is comprised of a server, <c>distccd</c>, and a client 47participating hosts. It is comprised of a server, <c>distccd</c>, and a client
53program, <c>distcc</c>. Distcc can work transparently with <uri 48program, <c>distcc</c>. Distcc can work transparently with <uri
54link="http://ccache.samba.org">ccache</uri> and Portage with a little work. 49link="http://ccache.samba.org">ccache</uri>, Portage, and Automake with a
50little setup.
55</p> 51</p>
56 52
57</body> 53</body>
58</section> 54</section>
59<section> 55<section>
60<title>Using distcc to bootstrap</title> 56<title>Using distcc to bootstrap</title>
61<body> 57<body>
62 58
63<p> 59<p>
64If you are planning on using distcc to help you bootstrap a Gentoo installation, 60If you are planning on using distcc to help you bootstrap a Gentoo
65make sure you read the section <uri link="#bootstrapping">Using distcc to 61installation, make sure you read the section <uri link="#bootstrapping">Using
66Bootstrap</uri>, which is situated further down in this document. 62distcc to Bootstrap</uri>, which is situated further down in this document.
67</p> 63</p>
68 64
69</body> 65</body>
70</section> 66</section>
71</chapter> 67</chapter>
75<section> 71<section>
76<title>Dependencies</title> 72<title>Dependencies</title>
77<body> 73<body>
78 74
79<p> 75<p>
80In order to use Distcc, all of the computers on your network need to 76In order to use Distcc, all of the computers on your network need to have the
81have the same GCC versions. Mixing 3.3.x (where the x varies) is okay, but 77same GCC versions. For example, mixing 3.3.x (where the x varies) is okay, but
82mixing 3.3.x and 3.2.x <b>will</b> result in your programs having errors in them. 78mixing 3.3.x with 3.2.x <b>may</b> result in compilation errors or runtime
79errors.
83</p> 80</p>
84 81
85</body> 82</body>
86</section> 83</section>
87<section> 84<section>
102 99
103<pre caption="Installing distcc"> 100<pre caption="Installing distcc">
104# <i>emerge distcc</i> 101# <i>emerge distcc</i>
105</pre> 102</pre>
106 103
104<impo>
105Remember, you must be sure to install distcc on all of your participating
106machines.
107</impo>
108
107</body> 109</body>
108</section> 110</section>
109<section> 111<section>
110<title>Setting up Portage to use Distcc</title> 112<title>Setting up Portage to use Distcc</title>
111<body> 113<body>
117 119
118<pre caption="Integrating Distcc and Portage"> 120<pre caption="Integrating Distcc and Portage">
119# <i>emerge distcc</i> 121# <i>emerge distcc</i>
120# <i>nano -w /etc/make.conf</i> 122# <i>nano -w /etc/make.conf</i>
121<comment>(Set N to a suitable number for your particular setup)</comment> 123<comment>(Set N to a suitable number for your particular setup)</comment>
122<comment>(A common heuristic strategy is twice the number of total CPUs + 1)</comment> 124<comment>(A common strategy is setting N as twice the number of total CPUs + 1
125available)</comment>
123MAKEOPTS="-jN" 126MAKEOPTS="-jN"
124<comment>(Add distcc to your FEATURES variable)</comment> 127<comment>(Add distcc to your FEATURES)</comment>
125FEATURES="distcc" 128FEATURES="distcc"
126</pre> 129</pre>
127 130
128</body> 131</body>
129</section> 132</section>
130<section> 133<section>
131<title>Specifying Participating Hosts</title> 134<title>Specifying Participating Hosts</title>
132<body> 135<body>
133 136
134<p> 137<p>
135Use the <c>distcc-config</c> command to set the list of hosts. Here is an example of 138Use the <c>distcc-config</c> command to set the list of hosts. Here is an
136some hosts that might be in your list: 139example of some hosts that might be in your list:
137</p> 140</p>
138 141
139<pre caption="Examples of host definitions"> 142<pre caption="Examples of host definitions">
140192.168.0.1 192.168.0.2 192.168.0.3 143192.168.0.1 192.168.0.2 192.168.0.3
141192.168.0.1/2 192.168.0.2 192.168.0.3/10 144192.168.0.1/2 192.168.0.2 192.168.0.3/10
142192.168.0.1:4000/2 192.168.0.2/1 192.168.0.3:3632/4 145192.168.0.1:4000/2 192.168.0.2/1 192.168.0.3:3632/4
143@192.168.0.1 @192.168.0.2:/usr/bin/distccd 192.168.0.3 146@192.168.0.1 @192.168.0.2:/usr/bin/distccd 192.168.0.3
144<comment>(There are also several other methods of setting up hosts. See the 147<comment>(There are also several other methods of setting up hosts. See the
145distcc manpage for more details.)</comment> 148distcc manpage for more details.)</comment>
149<comment>If you wish to compile on the local machine you should put 'localhost'
150in the hosts list. Conversely if you do not wish to use the local machine to
151compile (which is often the case) omit it from the hosts list. On a slow
152machine using localhost may actually slow things down. Make sure to test your
153settings for performance.</comment>
146</pre> 154</pre>
147 155
148<p> 156<p>
149It may all look complicated, but in most cases a variant of line 1 or 2 will 157It may all look complicated, but in most cases a variant of line 1 or 2 will
150work. 158work.
151</p> 159</p>
152 160
153<ul>
154 <li>Line 1 is just a space-delimited list of hosts</li>
155 <li>
156 Line 2 is a list of hosts that specifies the maximum amount of jobs (by
157 defining the <c>/N</c> setting) to send that host at any given time
158 </li>
159</ul>
160
161<p> 161<p>
162Since most people won't be using lines 3 or 4, I'll <uri 162Since most people won't be using lines 3 or 4, I'll <uri
163link="http://distcc.samba.org/man/distcc_1.html">point you to</uri> the distcc 163link="http://distcc.samba.org/man/distcc_1.html">refer to</uri> the distcc
164docs for more information. 164docs (man distcc) for more information.
165</p> 165</p>
166 166
167<p> 167<p>
168For instance, to set the first line in the previous example: 168For instance, to set the first line in the previous example:
169</p> 169</p>
172# <i>/usr/bin/distcc-config --set-hosts "192.168.0.1 192.168.0.2 192.168.0.3"</i> 172# <i>/usr/bin/distcc-config --set-hosts "192.168.0.1 192.168.0.2 192.168.0.3"</i>
173</pre> 173</pre>
174 174
175<p> 175<p>
176Edit <path>/etc/conf.d/distccd</path> to your needs and be sure to set the 176Edit <path>/etc/conf.d/distccd</path> to your needs and be sure to set the
177<c>--allow</c> directive to allow only hosts you trust. For added security, you should also use the <c>--listen</c> 177<c>--allow</c> directive to allow only hosts you trust. For added security,
178directive to tell the distcc daemon what IP to listen on (for multi-homed 178you should also use the <c>--listen</c> directive to tell the distcc daemon
179systems). More information on distcc security can be found at <uri link="http://distcc.samba.org/security.html">Distcc Security 179what IP to listen on (for multi-homed systems). More information on distcc
180Design</uri>. 180security can be found at <uri
181link="http://distcc.samba.org/security.html">Distcc Security Design</uri>.
181</p> 182</p>
183
184<impo>
185It is important to use --allow and --listen. Please read the distccd manpage
186or the above security document for more information.
187</impo>
188
182 189
183<p> 190<p>
184Now start the distcc daemon on all the participating computers: 191Now start the distcc daemon on all the participating computers:
185</p> 192</p>
186 193
205the ccache part: 212the ccache part:
206</p> 213</p>
207 214
208<pre caption="Setting your path"> 215<pre caption="Setting your path">
209# <i>export PATH="/usr/lib/ccache/bin:/usr/lib/distcc/bin:${PATH}"</i> 216# <i>export PATH="/usr/lib/ccache/bin:/usr/lib/distcc/bin:${PATH}"</i>
217<comment>(You can put this in your ~/.bashrc or equivalent file to have the PATH
218set every time you log in)</comment>
210</pre> 219</pre>
211 220
212<p> 221<p>
213Then, as you would normally type <c>make</c>, you would type <c>make -jN</c> 222Then, as you would normally type <c>make</c>, you would type <c>make -jN</c>
214(where N is an integer). The value of N depends on your network and the types 223(where N is an integer). The value of N depends on your network and the types
215of computers you are using to compile. For me, I have a dual processor P3 and 224of computers you are using to compile. Test your own settings to find the
216a K6-2/400 that compiles everything for my desktop (a 1200MHz Athlon
217Thunderbird) and I use -j5. Test your own settings to find the number that
218yields the best performance. 225number that yields the best performance.
219</p> 226</p>
220 227
221</body> 228</body>
222</section> 229</section>
223</chapter> 230</chapter>
224 231
225<chapter> 232<chapter>
226<title>Cross-Compiling</title> 233<title>Cross-Compiling</title>
227<section> 234<section>
228<title>A Note on Cross-Compiling</title>
229<body> 235<body>
230 236
231<p> 237<p>
232Cross-compiling is using one architecture to build programs for another 238Cross-compiling is using one architecture to build programs for another
233architecture. This can be as simple as using an Athlon (i686) to build a 239architecture. This can be as simple as using an Athlon (i686) to build a
234program for a K6-2 (i586), or using a Sparc to build a program for a ppc. 240program for a K6-2 (i586), or using a Sparc to build a program for a ppc. This
235</p> 241is documented in our <uri link="/doc/en/cross-compiling-distcc.xml">DistCC
236 242Cross-compiling Guide</uri>.
237</body>
238</section>
239<section>
240<title>An Introduction to Cross-Compiling</title>
241<body>
242
243<p>
244If you want to give cross-compiling a try you can to follow <uri
245link="http://dev.gentoo.org/~vapier/CROSS-COMPILE-HOWTO">The Cross Compile
246HOWTO</uri>; Crossdev is deprecated.
247</p> 243</p>
248 244
249</body> 245</body>
250</section> 246</section>
251</chapter> 247</chapter>
253<chapter id="bootstrapping"> 249<chapter id="bootstrapping">
254<title>Using Distcc to Bootstrap</title> 250<title>Using Distcc to Bootstrap</title>
255<section> 251<section>
256<title>Step 1: Configure Portage</title> 252<title>Step 1: Configure Portage</title>
257<body> 253<body>
258 254<!--
255Note that this will need to become a link to the old 2005.1 networked handbooks
256once the 2006.0 handbooks are released. Until then, the link can stay.
257-->
259<p> 258<p>
260Boot your new box with a Gentoo Linux LiveCD and follow the <uri 259Boot your new box with a Gentoo Linux LiveCD and follow the <uri
261link="/doc/en/handbook/handbook-x86.xml?part=1">installation instructions</uri> 260link="/doc/en/handbook/handbook-x86.xml?part=1">installation instructions</uri>
261up until the bootstrapping part. (See the <uri
262link="/doc/en/faq.xml#stage12">Gentoo FAQ</uri> for more information about
262up until the bootstrapping part. Then configure Portage to use distcc: 263bootstrapping.) Then configure Portage to use distcc:
263</p> 264</p>
264 265
265<pre caption="Preliminary Setup"> 266<pre caption="Preliminary Setup">
266# <i>nano -w /etc/make.conf</i> 267# <i>nano -w /etc/make.conf</i>
267<comment>(Add distcc to the FEATURES variable)</comment> 268<comment>(Add distcc to the FEATURES</comment>
268FEATURES="distcc" 269FEATURES="distcc"
269<comment>(Modify MAKEOPTS to include -jN with N an appropriate integer)</comment> 270<comment>(Modify MAKEOPTS to include -jN, where N is twice the number of CPUs
271+1 available)</comment>
270MAKEOPTS="-jN" 272MAKEOPTS="-jN"
271</pre> 273</pre>
272 274
273<pre caption="Setting your path"> 275<pre caption="Setting your path">
274# <i>export PATH="/usr/lib/ccache/bin:/usr/lib/distcc/bin:${PATH}"</i> 276# <i>export PATH="/usr/lib/ccache/bin:/usr/lib/distcc/bin:${PATH}"</i>
284Before the installation of distcc, a user called distcc must be added to the 286Before the installation of distcc, a user called distcc must be added to the
285<path>/etc/passwd</path>: 287<path>/etc/passwd</path>:
286</p> 288</p>
287 289
288<pre caption="Create user distcc"> 290<pre caption="Create user distcc">
289# <i>echo "distcc:x:240:2:distccd:/dev/null:/bin/false" &gt;&gt; /etc/passwd</i> 291# <i>echo "distcc:x:240:2:distccd:/dev/null:/bin/false" &gt;&gt;/etc/passwd</i>
290</pre> 292</pre>
291 293
292<impo> 294<impo>
293It is important to note that adding users like this is very bad. We only do 295It is important to note that adding users like this is very bad. We only do
294it here because there is no <c>useradd</c> utility (which you normally use for 296it here because there is no <c>useradd</c> utility (which you normally use for
312<p> 314<p>
313Run <c>distcc-config --install</c> to setup distcc: 315Run <c>distcc-config --install</c> to setup distcc:
314</p> 316</p>
315 317
316<pre caption="Final distcc setup"> 318<pre caption="Final distcc setup">
317<comment>(Substitute host1, host2, ... with the IP number(s) of the participating hosts)</comment> 319<comment>(Substitute host1, host2, ... with the IP number(s) of the
320participating hosts)</comment>
318# <i>/usr/bin/distcc-config --set-hosts "localhost host1 host2 host3 ..."</i> 321# <i>/usr/bin/distcc-config --set-hosts "localhost host1 host2 host3 ..."</i>
319<comment>An example: <i>/usr/bin/distcc-config --set-hosts "localhost 192.168.0.4 192.168.0.6"</i></comment> 322<comment>An example: <i>/usr/bin/distcc-config --set-hosts "localhost
323192.168.0.4 192.168.0.6"</i></comment>
320</pre> 324</pre>
321 325
322<p> 326<p>
323Distcc is now set up to bootstrap! Continue with the official installation 327Distcc is now set up to bootstrap! Continue with the official installation
324instructions and <e>do not forget</e> to re-emerge distcc after <c>emerge 328instructions and <e>do not forget</e> to re-emerge distcc after <c>emerge
325system</c>. This is to make sure that all of the dependencies you want are 329system</c>. This is to make sure that all of the dependencies you want are
337</chapter> 341</chapter>
338 342
339<chapter> 343<chapter>
340<title>Troubleshooting</title> 344<title>Troubleshooting</title>
341<section> 345<section>
342<title>Mozilla and Xfree</title> 346<title>Some Packages Don't Use Distcc</title>
343<body> 347<body>
344 348
345<p> 349<p>
346As you emerge various packages, you'll notice that some of them aren't being 350As you emerge various packages, you'll notice that some of them aren't being
347distributed (and aren't being built in parallel). This is because the 351distributed (and aren't being built in parallel). This may happen because the
348developers of the Mozilla and Xfree ebuilds intentionally disable parallel 352package's Makefile doesn't support parallel operations or the maintainer of the
349building because it is known to cause problems. 353ebuild has explicitly disabled parallel operations due to a known problem.
350</p> 354</p>
351 355
352<p> 356<p>
353Sometimes distcc might cause a package to fail to compile. If this happens 357Sometimes distcc might cause a package to fail to compile. If this happens
354for you, please <uri link="http://bugs.gentoo.org">report</uri> it to us. 358for you, please <uri link="http://bugs.gentoo.org">report</uri> it to us.
355</p>
356
357</body>
358</section>
359<section>
360<title>A Mixture of hardened-gcc and non-hardened-gcc Hosts Will Be Faulty</title>
361<body>
362
363<p>
364With such a long title any explanation here is almost irrelevent. However, if
365you plan to use distcc across hosts that have the <uri
366link="/proj/en/hardened/etdyn-ssp.xml">PaX/hardened-gcc</uri> and some that do
367not, you will run into problems.
368</p>
369
370<p>
371The solution requires a little foresight on your part; you have to run
372<c>hardened-gcc -R</c> on the host that has PaX/hardened-gcc, or you have to
373enable PaX protections in your kernel and <c>emerge hardened-gcc</c>. Both of
374which are a good thing to do since for the most part the protections offered
375by both packages is a good thing and is transparent to the user.
376</p> 359</p>
377 360
378</body> 361</body>
379</section> 362</section>
380<section> 363<section>
389 372
390<p> 373<p>
391Recent Portage updates have made Portage use <c>${CHOST}-gcc</c> instead of 374Recent Portage updates have made Portage use <c>${CHOST}-gcc</c> instead of
392<c>gcc</c>. This means that if you're mixing i686 machines with other types 375<c>gcc</c>. This means that if you're mixing i686 machines with other types
393(i386, i586) you will run into problems. A workaround for this may be to 376(i386, i586) you will run into problems. A workaround for this may be to
394<c>export CC='gcc' CXX='c++'</c> or to put it in <path>/etc/make.conf</path>, 377<c>export CC='gcc' CXX='c++'</c> or to put it in <path>/etc/make.conf</path>.
395but that needs testing. If it works for you please email me,
396<mail link="lisa@gentoo.org">Lisa Seelye</mail>.
397</p> 378</p>
379
380<impo>
381Doing this explicitly redefines some behaviour of Portage and may have some
382weird results in the future. Only do this if you're mixing CHOSTs.
383</impo>
384
398 385
399</body> 386</body>
400</section> 387</section>
401</chapter> 388</chapter>
402 389
413parameter it will run once. However, if you pass it a number it will update 400parameter it will run once. However, if you pass it a number it will update
414every N seconds, where N is the argument you passed. 401every N seconds, where N is the argument you passed.
415</p> 402</p>
416 403
417<p> 404<p>
418The other monitor is only turned on if you enabled <c>gtk</c> or <c>gnome</c> 405The other monitor is only turned on if you enabled <c>gtk</c> or <c>gnome</c>
419in your <c>USE</c> flags. This one is GTK+ based, runs in an X environment 406in your <c>USE</c> flags. This one is GTK+ based, runs in an X environment
420and it is quite lovely. 407and it is quite lovely. For Gentoo the GUI monitor has been called
408<c>distccmon-gui</c> for less confusion. Elsewhere it may be referred to as
409<c>distccmon-gnome</c>.
421</p> 410</p>
422 411
423<pre caption="Starting the monitors"> 412<pre caption="Starting the monitors">
424# <i>distccmon-text N</i> 413# <i>distccmon-text N</i>
425<comment>(Or)</comment> 414<comment>(Or)</comment>
426# <i>distccmon-gnome</i> 415# <i>distccmon-gui</i>
427<comment>To monitor Portage's distcc usage you can use:</comment> 416<comment>To monitor Portage's distcc usage you can use:</comment>
428# <i>DISTCC_DIR=`portageq envvar DISTCC_DIR` distccmon-text N</i> 417# <i>DISTCC_DIR="/var/tmp/portage/.distcc/" distccmon-text N</i>
429<comment>(Or)</comment> 418<comment>(Or)</comment>
430# <i>DISTCC_DIR=`portageq envvar DISTCC_DIR` distccmon-gnome</i> 419# <i>DISTCC_DIR="/var/tmp/portage/.distcc/" distccmon-gui</i>
431</pre> 420</pre>
432 421
433<impo> 422<impo>
434Notice the backticks above. <c>portageq</c> is a part of Portage that will 423If your distcc directory is elsewhere, change the DISTCC_DIR variable
435return a piece of information (in this case what DISTCC_DIR is set to). For 424accordingly.
436simplicity, most users can use <c>DISTCC_DIR=/var/tmp/portage/.distcc
437distccmon-text N</c>
438</impo> 425</impo>
439 426
440</body> 427</body>
441</section> 428</section>
442</chapter> 429</chapter>

Legend:
Removed from v.1.25  
changed lines
  Added in v.1.39

  ViewVC Help
Powered by ViewVC 1.1.20