Typo
[linux_from_scratch.git] / chapter05 / toolchaintechnotes.xml
blob2932b957f80d0febe470a92253e358fd724af67e
1 <?xml version="1.0" encoding="ISO-8859-1"?>
2 <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4   <!ENTITY % general-entities SYSTEM "../general.ent">
5   %general-entities;
6 ]>
8 <sect1 id="ch-tools-toolchaintechnotes">
9   <?dbhtml filename="toolchaintechnotes.html"?>
11   <title>Toolchain Technical Notes</title>
13   <para>This section explains some of the rationale and technical details
14   behind the overall build method. It is not essential to immediately
15   understand everything in this section. Most of this information will be
16   clearer after performing an actual build. This section can be referred
17   to at any time during the process.</para>
19   <para>The overall goal of <xref linkend="chapter-temporary-tools"/> is to
20   produce a temporary area that contains a known-good set of tools that can be
21   isolated from the host system. By using <command>chroot</command>, the
22   commands in the remaining chapters will be contained within that environment,
23   ensuring a clean, trouble-free build of the target LFS system. The build
24   process has been designed to minimize the risks for new readers and to provide
25   the most educational value at the same time.</para>
27   <important>
28     <para>Before continuing, be aware of the name of the working platform,
29     often referred to as the target triplet. A simple way to determine the
30     name of the target triplet is to run the <command>config.guess</command>
31     script that comes with the source for many packages. Unpack the Binutils
32     sources and run the script: <userinput>./config.guess</userinput> and note
33     the output. For example, for a modern 32-bit Intel processor the
34     output will likely be <emphasis>i686-pc-linux-gnu</emphasis>.</para>
36     <para>Also be aware of the name of the platform's dynamic linker, often
37     referred to as the dynamic loader (not to be confused with the standard
38     linker <command>ld</command> that is part of Binutils). The dynamic linker
39     provided by Glibc finds and loads the shared libraries needed by a program,
40     prepares the program to run, and then runs it. The name of the dynamic
41     linker for a 32-bit Intel machine will be
42     <filename class="libraryfile">ld-linux.so.2</filename>.
43     A sure-fire way to determine the name of the dynamic linker is to
44     inspect a random binary from the host system by running:
45     <userinput>readelf -l &lt;name of binary&gt; | grep interpreter</userinput>
46     and noting the output. The authoritative reference covering all platforms
47     is in the <filename>shlib-versions</filename> file in the root of the Glibc
48     source tree.</para>
49   </important>
51   <para>Some key technical points of how the <xref
52   linkend="chapter-temporary-tools"/> build method works:</para>
54   <itemizedlist>
55     <listitem>
56       <para>Slightly adjusting the name of the working platform, by changing the
57       &quot;vendor&quot; field target triplet by way of the
58       <envar>LFS_TGT</envar> variable, ensures that the first build of Binutils
59       and GCC produces a compatible cross-linker and cross-compiler. Instead of
60       producing binaries for another architecture, the cross-linker and
61       cross-compiler will produce binaries compatible with the current
62       hardware.</para>
63     </listitem>
64     <listitem>
65       <para> The temporary libraries are cross-compiled.  Because a
66       cross-compiler by its nature cannot rely on anything from its host
67       system, this method removes potential contamination of the target
68       system by lessening the chance of headers or libraries from the host
69       being incorporated into the new tools.  Cross-compilation also allows for
70       the possibility of building both 32-bit and 64-bit libraries on 64-bit
71       capable hardware.</para>
72     </listitem>
73     <listitem>
74       <para>Careful manipulation of <command>gcc</command>'s
75       <filename>specs</filename> file tells the compiler which target dynamic
76       linker will be used</para>
77     </listitem>
78   </itemizedlist>
80   <para>Binutils is installed first because the <command>configure</command>
81   runs of both GCC and Glibc perform various feature tests on the assembler
82   and linker to determine which software features to enable or disable. This
83   is more important than one might first realize. An incorrectly configured
84   GCC or Glibc can result in a subtly broken toolchain, where the impact of
85   such breakage might not show up until near the end of the build of an
86   entire distribution. A test suite failure will usually highlight this error
87   before too much additional work is performed.</para>
89   <para>Binutils installs its assembler and linker in two locations,
90   <filename class="directory">/tools/bin</filename> and <filename
91   class="directory">/tools/$LFS_TGT/bin</filename>. The tools in one
92   location are hard linked to the other. An important facet of the linker is
93   its library search order. Detailed information can be obtained from
94   <command>ld</command> by passing it the <parameter>--verbose</parameter>
95   flag. For example, an <userinput>ld --verbose | grep SEARCH</userinput>
96   will illustrate the current search paths and their order. It shows which
97   files are linked by <command>ld</command> by compiling a dummy program and
98   passing the <parameter>--verbose</parameter> switch to the linker. For example,
99   <userinput>gcc dummy.c -Wl,--verbose 2&gt;&amp;1 | grep succeeded</userinput>
100   will show all the files successfully opened during the linking.</para>
102   <para>The next package installed is GCC. An example of what can be
103   seen during its run of <command>configure</command> is:</para>
105 <screen><computeroutput>checking what assembler to use... /tools/i686-lfs-linux-gnu/bin/as
106 checking what linker to use... /tools/i686-lfs-linux-gnu/bin/ld</computeroutput></screen>
108   <para>This is important for the reasons mentioned above. It also demonstrates
109   that GCC's configure script does not search the PATH directories to find which
110   tools to use. However, during the actual operation of <command>gcc</command>
111   itself, the same search paths are not necessarily used. To find out which
112   standard linker <command>gcc</command> will use, run:
113   <userinput>gcc -print-prog-name=ld</userinput>.</para>
115   <para>Detailed information can be obtained from <command>gcc</command> by
116   passing it the <parameter>-v</parameter> command line option while compiling
117   a dummy program. For example, <userinput>gcc -v dummy.c</userinput> will show
118   detailed information about the preprocessor, compilation, and assembly stages,
119   including <command>gcc</command>'s included search paths and their order.</para>
121   <para>The next package installed is Glibc. The most important considerations
122   for building Glibc are the compiler, binary tools, and kernel headers. The
123   compiler is generally not an issue since Glibc will always use the compiler
124   relating to the <parameter>--host</parameter> parameter passed to its
125   configure script, e.g. in our case,
126   <command>i686-lfs-linux-gnu-gcc</command>. The binary tools and kernel
127   headers can be a bit more complicated. Therefore, take no risks and use the
128   available configure switches to enforce the correct selections. After the run
129   of <command>configure</command>, check the contents of the
130   <filename>config.make</filename> file in the <filename
131   class="directory">glibc-build</filename> directory for all important details.
132   Note the use of <parameter>CC="i686-lfs-gnu-gcc"</parameter> to control which
133   binary tools are used and the use of the <parameter>-nostdinc</parameter> and
134   <parameter>-isystem</parameter> flags to control the compiler's include
135   search path. These items highlight an important aspect of the Glibc
136   package&mdash;it is very self-sufficient in terms of its build machinery and
137   generally does not rely on toolchain defaults.</para>
139   <para>After the Glibc installation, change <command>gcc</command>'s specs file
140   to point to the new dynamic linker in <filename
141   class="directory">/tools/lib</filename>.  This last step is vital in ensuring
142   that searching and linking take place only within the <filename
143   class="directory">/tools</filename> prefix. A hard-wired
144   path to a dynamic linker is embedded into every Executable and Link Format
145   (ELF)-shared executable.  This can be inspected by running:
146   <userinput>readelf -l &lt;name of binary&gt; | grep interpreter</userinput>.
147   Amending <command>gcc</command>'s specs file ensures that every program
148   compiled from here through the end of this chapter will use the new dynamic
149   linker in <filename class="directory">/tools/lib</filename>.</para>
151   <para>For the second pass of GCC, its sources also need to be modified
152   to tell GCC to use the new dynamic linker. Failure to do
153   so will result in the GCC programs themselves having the name of the
154   dynamic linker from the host system's <filename
155   class="directory">/lib</filename> directory embedded into them, which
156   would defeat the goal of getting away from the host.</para>
158   <para>During the second pass of Binutils, we are able to utilize the
159   <parameter>--with-lib-path</parameter> configure switch to control
160   <command>ld</command>'s library search path.  From this point onwards,
161   the core toolchain is self-contained and self-hosted. The remainder of
162   the <xref linkend="chapter-temporary-tools"/> packages all build against
163   the new Glibc in <filename class="directory">/tools</filename>.</para>
165   <para>Upon entering the chroot environment in <xref
166   linkend="chapter-building-system"/>, the first major package to be
167   installed is Glibc, due to its self-sufficient nature mentioned above.
168   Once this Glibc is installed into <filename
169   class="directory">/usr</filename>, we will perform a quick changeover of the
170   toolchain defaults, and then proceed in building the rest of the target
171   LFS system.</para>
173   <!-- FIXME: Removed as part of the fix for bug 1061 - we no longer build pass1
174       packages statically, therefore this explanation isn't required
176   <sect2>
177   <title>Notes on Static Linking</title>
179   <para>Besides their specific task, most programs have to perform many
180   common and sometimes trivial operations. These include allocating
181   memory, searching directories, reading and writing files, string
182   handling, pattern matching, arithmetic, and other tasks. Instead of
183   obliging each program to reinvent the wheel, the GNU system provides
184   all these basic functions in ready-made libraries. The major library
185   on any Linux system is Glibc.</para>
187   <para>There are two primary ways of linking the functions from a
188   library to a program that uses them&mdash;statically or dynamically. When
189   a program is linked statically, the code of the used functions is
190   included in the executable, resulting in a rather bulky program. When
191   a program is dynamically linked, it includes a reference to the
192   dynamic linker, the name of the library, and the name of the function,
193   resulting in a much smaller executable. A third option is to use the
194   programming interface of the dynamic linker (see <filename>dlopen(3)</filename>
195   for more information).</para>
197   <para>Dynamic linking is the default on Linux and has three major
198   advantages over static linking. First, only one copy of the executable
199   library code is needed on the hard disk, instead of having multiple
200   copies of the same code included in several programs, thus saving
201   disk space. Second, when several programs use the same library
202   function at the same time, only one copy of the function's code is
203   required in core, thus saving memory space. Third, when a library
204   function gets a bug fixed or is otherwise improved, only the one
205   library needs to be recompiled instead of recompiling all programs
206   that make use of the improved function.</para>
208   <para>If dynamic linking has several advantages, why then do we
209   statically link the first two packages in this chapter? The reasons
210   are threefold&mdash;historical, educational, and technical. The
211   historical reason is that earlier versions of LFS statically linked
212   every program in this chapter. Educationally, knowing the difference
213   between static and dynamic linking is useful. The technical benefit is
214   a gained element of independence from the host, meaning that those
215   programs can be used independently of the host system. However, it is
216   worth noting that an overall successful LFS build can still be
217   achieved when the first two packages are built dynamically.</para>
219   </sect2>-->
221 </sect1>